diff --git a/API_NetFramework/Controllers/ArchivController.cs b/API_NetFramework/Controllers/ArchivController.cs index fbc24453..704042e9 100644 --- a/API_NetFramework/Controllers/ArchivController.cs +++ b/API_NetFramework/Controllers/ArchivController.cs @@ -24,6 +24,8 @@ using DOCGEN.Klassen; using CSVNET; using System.Data; using Helper; +using System.Runtime.CompilerServices; +using System.Web.UI.WebControls; namespace API_NetFramework.Controllers @@ -140,7 +142,7 @@ namespace API_NetFramework.Controllers [HttpGet] [Route("API/ArchiveDocFromDatabase")] - public IHttpActionResult ArchivDocFromDatabase(string DokumentID) + public IHttpActionResult ArchivDocFromDatabase(string DokumentID, string pdfdoc = "") { if (SecuringWebApiUsingApiKey.Middleware.ApiKeyMiddleware.Authorized((HttpRequestMessage)Request, tokenfunction) == false) { @@ -305,6 +307,10 @@ namespace API_NetFramework.Controllers onbasedoc.attributes.Add(na); } onbasedoc.dokumentDatei = dok.dokument; + + if(pdfdoc != ""){ + onbasedoc.dokumentDatum=pdfdoc; + } db = null; ILResponse ilr = new ILResponse(); string debugfilename = System.Configuration.ConfigurationManager.AppSettings["JSONDebugPath"]; @@ -539,5 +545,125 @@ namespace API_NetFramework.Controllers return Content(HttpStatusCode.InternalServerError, ilr); } } + + + [HttpPost] + [Route("API/Send_Versandstrasse")] + + public IHttpActionResult Send_Versandstrasse() + { + + string json_versandpaket = Request.Content.ReadAsStringAsync().Result; + + Versandpaket versandpaket = new Versandpaket(); + versandpaket.Dokument = new List(); + versandpaket = JsonConvert.DeserializeObject(json_versandpaket); + string inthandle = ""; + if (SecuringWebApiUsingApiKey.Middleware.ApiKeyMiddleware.Authorized((HttpRequestMessage)Request, tokenfunction) == false) + { + return Content(HttpStatusCode.Unauthorized, "Invalid Token or API-Key"); + } + string ArchivAktiv; + ArchivAktiv = System.Configuration.ConfigurationManager.AppSettings["ArchivierungAktiv"].ToString(); + if (ArchivAktiv != "True") + { + string message = "Hinweismeldung: " + System.Configuration.ConfigurationManager.AppSettings["ArchivierungNoAktivMessage"].ToString(); + return Content(HttpStatusCode.OK, message); + } + try + { + OnBase_Attributes oba = new OnBase_Attributes(); + if (!versandpaket.send_onbase_doc) + { + oba.BPNummer = versandpaket.partnernr.ToString(); + oba.DocumentHandle = ""; + oba.DistributionOption = versandpaket.Versandoption.ToString(); + oba.GASCouvert = versandpaket.GAS; + oba.Returnaddress = versandpaket.GASAdresse; + oba.O2ODochandle = ""; + oba.Status = ""; + } + else + { + foreach (Versanddokument vd in versandpaket.Dokument) + { + IHttpActionResult res = ArchivDocFromDatabase(vd.DokumentID, vd.dokument); + DB db = new DB(connectionstring); + db.clear_parameter(); + db.add_parameter("@dokumentid", vd.DokumentID); + db.Get_Tabledata("sp_get_handle", true, false); + if (db.dsdaten.Tables[0].Rows.Count > 0) + { + inthandle = db.dsdaten.Tables[0].Rows[0][0].ToString(); + oba.DocumentHandle = inthandle; + versandpaket.finaldoc = ""; + } + db = null; + } + } + + OnBaseDocUpload.OnBaseDokument onbasedoc = new OnBaseDocUpload.OnBaseDokument(); + onbasedoc.bpNummer = oba.BPNummer; + onbasedoc.personNummer = ""; + onbasedoc.dokumentDatum = DateTime.Now.ToString("dd.MM.yyyy"); + onbasedoc.dokumentDatei = versandpaket.finaldoc; + onbasedoc.dateiTyp = "PDF"; + onbasedoc.attributes = new List(); + + + onbasedoc.attributes.Add(new OnBaseDocUpload.attribute("Document Handle",oba.DocumentHandle.ToString())); + onbasedoc.attributes.Add(new OnBaseDocUpload.attribute("O2O DistributionOption",oba.DistributionOption.ToString())); + onbasedoc.attributes.Add(new OnBaseDocUpload.attribute("O2O GasCouvert", oba.GASCouvert.ToString())); + onbasedoc.attributes.Add(new OnBaseDocUpload.attribute("O2O Returnaddress", oba.Returnaddress.ToString())); + + onbasedoc.attributes.Add(new OnBaseDocUpload.attribute("O2O Dochandle", oba.O2ODochandle.ToString())); + onbasedoc.attributes.Add(new OnBaseDocUpload.attribute("O2O Status", oba.Status.ToString())); + + ILResponse ilr = new ILResponse(); + string debugfilename = System.Configuration.ConfigurationManager.AppSettings["JSONDebugPath"]; + string SendToOnBase = System.Configuration.ConfigurationManager.AppSettings["SendToOnBase"]; + string SendToFile = System.Configuration.ConfigurationManager.AppSettings["SendToFile"]; + string debugdir = System.Configuration.ConfigurationManager.AppSettings["DebugDir"]; + string jsonstring = Newtonsoft.Json.JsonConvert.SerializeObject(onbasedoc); + IHttpActionResult transferResult = null; + if (SendToOnBase != "Yes") + { + transferResult = Transfer_OnBase(uploadtype.fast, ref jsonstring, ref ilr); + if (SendToFile == "Yes") + { + if (debugfilename != "") + { + debugfilename = debugfilename + "VS_"+oba.BPNummer+"_"+DateTime.Now.ToString("yyyyMMddhhmmss")+".json"; + System.IO.File.WriteAllText(debugfilename, jsonstring); + debugfilename = debugfilename + ".pdf"; + Helper.clsFileHelper fh = new Helper.clsFileHelper(); + fh.SaveBase64ToFile(onbasedoc.dokumentDatei, debugfilename); + fh = null; + } + } + } + APILogging.Log((HttpRequestMessage)Request, "Opload Versandstrasse:" + debugfilename, LogLevelType.Debug); + + //Log nachführen + // Update_IL_Log(ref ilr, DokumentID); + if (ilr.senderror == 1) + { + return Content(HttpStatusCode.InternalServerError, ilr.response); + } + else + { + update_dokumentstatus(debugfilename); + return Content(HttpStatusCode.OK, oba.BPNummer.ToString() + " *archiviert*"); + } + } + catch (Exception e) + { + APILogging.Log((HttpRequestMessage)Request, e.Message, LogLevelType.Error); + return Content(HttpStatusCode.InternalServerError, e.Message); + } + finally + { + } + } } } \ No newline at end of file diff --git a/API_NetFramework/Web.config b/API_NetFramework/Web.config index 1a04c328..d9efd457 100644 --- a/API_NetFramework/Web.config +++ b/API_NetFramework/Web.config @@ -41,7 +41,7 @@ - + @@ -148,6 +148,11 @@ + + + + + diff --git a/API_NetFramework/bin/Model.dll b/API_NetFramework/bin/Model.dll index e9b2b2dd..c53c96d0 100644 Binary files a/API_NetFramework/bin/Model.dll and b/API_NetFramework/bin/Model.dll differ diff --git a/API_NetFramework/bin/Model.pdb b/API_NetFramework/bin/Model.pdb index db579073..ae53cf1f 100644 Binary files a/API_NetFramework/bin/Model.pdb and b/API_NetFramework/bin/Model.pdb differ diff --git a/API_NetFramework/bin/OnDoc_NetFramework.dll b/API_NetFramework/bin/OnDoc_NetFramework.dll index e3cb4329..e7f2a311 100644 Binary files a/API_NetFramework/bin/OnDoc_NetFramework.dll and b/API_NetFramework/bin/OnDoc_NetFramework.dll differ diff --git a/API_NetFramework/bin/OnDoc_NetFramework.dll.config b/API_NetFramework/bin/OnDoc_NetFramework.dll.config index 1a04c328..d9efd457 100644 --- a/API_NetFramework/bin/OnDoc_NetFramework.dll.config +++ b/API_NetFramework/bin/OnDoc_NetFramework.dll.config @@ -41,7 +41,7 @@ - + @@ -148,6 +148,11 @@ + + + + + diff --git a/API_NetFramework/bin/OnDoc_NetFramework.pdb b/API_NetFramework/bin/OnDoc_NetFramework.pdb index e1eb0d6b..5a7e7c5f 100644 Binary files a/API_NetFramework/bin/OnDoc_NetFramework.pdb and b/API_NetFramework/bin/OnDoc_NetFramework.pdb differ diff --git a/API_NetFramework/log.txt b/API_NetFramework/log.txt index a68ba4e1..ffa98cc2 100644 --- a/API_NetFramework/log.txt +++ b/API_NetFramework/log.txt @@ -5852,3 +5852,108 @@ done 2025-03-19 17:34:30.3949|DEBUG|OnDoc| 2025-03-19 17:34:30.4079|DEBUG|OnDoc| 2025-03-19 17:34:30.4244|DEBUG|OnDoc|Mail Versand NOK: Spalte 1 wurde nicht gefunden. +2025-03-23 20:30:22.2820|ERROR|OnDoc|Der Objektverweis wurde nicht auf eine Objektinstanz festgelegt. +2025-03-23 20:30:36.2531|ERROR|OnDoc|Der Objektverweis wurde nicht auf eine Objektinstanz festgelegt. +2025-03-23 20:31:25.3946|ERROR|OnDoc|Der Objektverweis wurde nicht auf eine Objektinstanz festgelegt. +2025-03-23 20:31:43.2455|ERROR|OnDoc|Der Objektverweis wurde nicht auf eine Objektinstanz festgelegt. +2025-03-23 20:33:13.7869|ERROR|OnDoc|Der Objektverweis wurde nicht auf eine Objektinstanz festgelegt. +2025-03-23 20:33:49.0744|ERROR|OnDoc|Der Objektverweis wurde nicht auf eine Objektinstanz festgelegt. +2025-03-23 20:38:19.4570|DEBUG|OnDoc|Start Transfer to OnBase +2025-03-23 20:38:19.6060|DEBUG|OnDoc|Ende Transfer to OnBase +2025-03-23 20:38:27.3017|DEBUG|OnDoc|Opload Versandstrasse:X:\\jsontemp\VS_1000208_20250323083822.json.pdf +2025-03-23 20:39:17.1137|DEBUG|OnDoc|Start Transfer to OnBase +2025-03-23 20:39:17.1271|DEBUG|OnDoc|Ende Transfer to OnBase +2025-03-23 20:39:17.1271|DEBUG|OnDoc|Opload Versandstrasse:X:\\jsontemp\VS_1000208_20250323083917.json.pdf +2025-03-23 20:39:17.1271|DEBUG|OnDoc| +2025-03-23 20:39:17.1271|DEBUG|OnDoc| +2025-03-23 20:43:19.1828|DEBUG|OnDoc|Start ArchiveDocFromDatabase: DokumentID:OFFEDK0082025002491700 +2025-03-23 20:43:19.2478|DEBUG|OnDoc| +2025-03-23 20:43:19.2781|DEBUG|OnDoc| +2025-03-23 20:43:19.2811|DEBUG|OnDoc| +2025-03-23 20:43:19.2811|DEBUG|OnDoc| +2025-03-23 20:43:19.2811|DEBUG|OnDoc| +2025-03-23 20:43:19.5365|DEBUG|OnDoc| +2025-03-23 20:43:19.5365|DEBUG|OnDoc| +2025-03-23 20:43:19.5365|DEBUG|OnDoc| +2025-03-23 20:43:20.7732|DEBUG|OnDoc|Start Transfer to OnBase +2025-03-23 20:43:20.9579|DEBUG|OnDoc|Ende Transfer to OnBase +2025-03-23 20:43:20.9579|DEBUG|OnDoc|Ende ArchiveDocFromDatabase: DokumentID:OFFEDK0082025002491700 +2025-03-23 20:43:20.9579|DEBUG|OnDoc|Start Update IL_Log: DokumentID:OFFEDK0082025002491700 +2025-03-23 20:43:20.9754|DEBUG|OnDoc|Ende Update IL_Log: DokumentID:OFFEDK0082025002491700 +2025-03-23 20:43:20.9754|DEBUG|OnDoc| +2025-03-23 20:43:20.9754|DEBUG|OnDoc| +2025-03-23 20:43:20.9754|DEBUG|OnDoc| +2025-03-23 20:43:21.0277|DEBUG|OnDoc| +2025-03-23 20:43:21.0277|DEBUG|OnDoc| +2025-03-23 20:43:21.0322|DEBUG|OnDoc| +2025-03-23 20:43:30.0448|DEBUG|OnDoc| +2025-03-23 20:43:30.1080|DEBUG|OnDoc| +2025-03-23 20:43:46.9277|DEBUG|OnDoc| +2025-03-23 20:43:46.9632|DEBUG|OnDoc| +2025-03-23 20:44:00.7693|DEBUG|OnDoc|Start ArchiveDocFromDatabase: DokumentID:OFFEDK0082025002491700 +2025-03-23 20:44:02.6271|DEBUG|OnDoc| +2025-03-23 20:44:02.6609|DEBUG|OnDoc| +2025-03-23 20:44:10.0466|DEBUG|OnDoc| +2025-03-23 20:44:10.0820|DEBUG|OnDoc| +2025-03-23 20:44:16.5448|DEBUG|OnDoc| +2025-03-23 20:44:16.5862|DEBUG|OnDoc| +2025-03-23 20:44:22.1131|DEBUG|OnDoc| +2025-03-23 20:44:22.1502|DEBUG|OnDoc| +2025-03-23 20:44:42.8538|DEBUG|OnDoc|Start Transfer to OnBase +2025-03-23 20:44:42.9284|DEBUG|OnDoc|Ende Transfer to OnBase +2025-03-23 20:44:48.6483|DEBUG|OnDoc|Ende ArchiveDocFromDatabase: DokumentID:OFFEDK0082025002491700 +2025-03-23 20:44:49.9665|DEBUG|OnDoc|Start Update IL_Log: DokumentID:OFFEDK0082025002491700 +2025-03-23 20:44:49.9823|DEBUG|OnDoc|Ende Update IL_Log: DokumentID:OFFEDK0082025002491700 +2025-03-23 20:45:29.7115|DEBUG|OnDoc| +2025-03-23 20:45:29.7467|DEBUG|OnDoc| +2025-03-23 20:45:29.7467|DEBUG|OnDoc| +2025-03-23 20:45:29.7517|DEBUG|OnDoc| +2025-03-23 20:45:29.7517|DEBUG|OnDoc| +2025-03-23 20:45:29.7517|DEBUG|OnDoc| +2025-03-23 20:45:34.9513|DEBUG|OnDoc| +2025-03-23 20:45:34.9875|DEBUG|OnDoc| +2025-03-23 20:47:10.9616|DEBUG|OnDoc|Start Transfer to OnBase +2025-03-23 20:47:11.0159|DEBUG|OnDoc|Ende Transfer to OnBase +2025-03-23 20:47:11.0159|DEBUG|OnDoc|Opload Versandstrasse:X:\\jsontemp\VS__20250323084711.json.pdf +2025-03-23 20:47:11.0159|DEBUG|OnDoc| +2025-03-23 20:47:11.0159|DEBUG|OnDoc| +2025-03-23 20:47:57.9891|DEBUG|OnDoc|Start ArchiveDocFromDatabase: DokumentID:OFFEDK0082025002491692 +2025-03-23 20:47:58.0220|DEBUG|OnDoc| +2025-03-23 20:47:58.0496|DEBUG|OnDoc| +2025-03-23 20:47:58.0496|DEBUG|OnDoc| +2025-03-23 20:47:58.0496|DEBUG|OnDoc| +2025-03-23 20:47:58.0496|DEBUG|OnDoc|OFFEDK0082025002491692 ErstellungInOffec - EDKB02DMS +2025-03-23 20:47:58.0496|DEBUG|OnDoc| +2025-03-23 20:47:58.0673|DEBUG|OnDoc| +2025-03-23 20:47:58.0673|INFO|OnDoc|Dokumentarchivierung via EDKB02_DMS ausgelöstOFFEDK0082025002491692 +2025-03-23 20:48:18.6242|DEBUG|OnDoc|Start ArchiveDocFromDatabase: DokumentID:OFFEDK0082025002491692 +2025-03-23 20:48:21.0110|DEBUG|OnDoc| +2025-03-23 20:48:21.0445|DEBUG|OnDoc| +2025-03-23 20:48:37.6183|DEBUG|OnDoc| +2025-03-23 20:48:50.3467|DEBUG|OnDoc| +2025-03-23 20:49:00.0544|DEBUG|OnDoc|OFFEDK0082025002491692 ErstellungInOffec - EDKB02DMS +2025-03-23 20:49:00.1124|DEBUG|OnDoc| +2025-03-23 20:49:00.1124|DEBUG|OnDoc| +2025-03-23 20:49:00.1124|DEBUG|OnDoc|Dokument nicht im Status in Bearbeitung - Bereits archiviert: OFFEDK0082025002491692OFFEDK0082025002491692 +2025-03-23 20:49:00.1124|DEBUG|OnDoc| +2025-03-23 20:49:00.1124|DEBUG|OnDoc| +2025-03-23 20:49:00.1124|DEBUG|OnDoc|Start Transfer to OnBase +2025-03-23 20:49:00.2337|DEBUG|OnDoc|Ende Transfer to OnBase +2025-03-23 20:49:00.2337|DEBUG|OnDoc|Opload Versandstrasse:X:\\jsontemp\VS__20250323084900.json.pdf +2025-03-23 20:49:00.2498|DEBUG|OnDoc| +2025-03-23 20:49:00.2498|DEBUG|OnDoc| +2025-03-23 20:50:41.3756|DEBUG|OnDoc|Start ArchiveDocFromDatabase: DokumentID:OFFEDK0082025002491726 +2025-03-23 20:50:41.4116|DEBUG|OnDoc| +2025-03-23 20:50:41.4366|DEBUG|OnDoc| +2025-03-23 20:50:41.4396|DEBUG|OnDoc| +2025-03-23 20:50:41.4396|DEBUG|OnDoc| +2025-03-23 20:50:41.4396|DEBUG|OnDoc| +2025-03-23 20:50:41.4396|DEBUG|OnDoc| +2025-03-23 20:50:41.4396|DEBUG|OnDoc| +2025-03-23 20:50:41.4526|DEBUG|OnDoc| +2025-03-23 20:50:49.4205|DEBUG|OnDoc|Start Transfer to OnBase +2025-03-23 20:50:57.4507|DEBUG|OnDoc|Ende ArchiveDocFromDatabase: DokumentID:OFFEDK0082025002491726 +2025-03-23 20:50:57.9901|DEBUG|OnDoc|Start Update IL_Log: DokumentID:OFFEDK0082025002491726 +2025-03-23 20:50:58.0061|DEBUG|OnDoc|Ende Update IL_Log: DokumentID:OFFEDK0082025002491726 +2025-03-23 20:51:12.6050|DEBUG|OnDoc| +2025-03-23 20:51:12.6140|DEBUG|OnDoc| diff --git a/API_NetFramework/obj/Debug/API_NetFramework.csproj.AssemblyReference.cache b/API_NetFramework/obj/Debug/API_NetFramework.csproj.AssemblyReference.cache index b7c113f0..624b65f4 100644 Binary files a/API_NetFramework/obj/Debug/API_NetFramework.csproj.AssemblyReference.cache and b/API_NetFramework/obj/Debug/API_NetFramework.csproj.AssemblyReference.cache differ diff --git a/API_NetFramework/obj/Debug/OnDoc_NetFramework.dll b/API_NetFramework/obj/Debug/OnDoc_NetFramework.dll index e3cb4329..e7f2a311 100644 Binary files a/API_NetFramework/obj/Debug/OnDoc_NetFramework.dll and b/API_NetFramework/obj/Debug/OnDoc_NetFramework.dll differ diff --git a/API_NetFramework/obj/Debug/OnDoc_NetFramework.pdb b/API_NetFramework/obj/Debug/OnDoc_NetFramework.pdb index e1eb0d6b..5a7e7c5f 100644 Binary files a/API_NetFramework/obj/Debug/OnDoc_NetFramework.pdb and b/API_NetFramework/obj/Debug/OnDoc_NetFramework.pdb differ diff --git a/BarcodeLib/bin/Debug/Model.dll b/BarcodeLib/bin/Debug/Model.dll index e9b2b2dd..c53c96d0 100644 Binary files a/BarcodeLib/bin/Debug/Model.dll and b/BarcodeLib/bin/Debug/Model.dll differ diff --git a/BarcodeLib/bin/Debug/Model.pdb b/BarcodeLib/bin/Debug/Model.pdb index db579073..ae53cf1f 100644 Binary files a/BarcodeLib/bin/Debug/Model.pdb and b/BarcodeLib/bin/Debug/Model.pdb differ diff --git a/BarcodeLib/obj/Debug/BarcodeLib.csproj.AssemblyReference.cache b/BarcodeLib/obj/Debug/BarcodeLib.csproj.AssemblyReference.cache index ee3c3e3e..f9de8535 100644 Binary files a/BarcodeLib/obj/Debug/BarcodeLib.csproj.AssemblyReference.cache and b/BarcodeLib/obj/Debug/BarcodeLib.csproj.AssemblyReference.cache differ diff --git a/BarcodeLibVBDatamatrix/bin/Debug/Model.dll b/BarcodeLibVBDatamatrix/bin/Debug/Model.dll index fed19b4e..8c8d952b 100644 Binary files a/BarcodeLibVBDatamatrix/bin/Debug/Model.dll and b/BarcodeLibVBDatamatrix/bin/Debug/Model.dll differ diff --git a/BarcodeLibVBDatamatrix/bin/Debug/Model.pdb b/BarcodeLibVBDatamatrix/bin/Debug/Model.pdb index 99bfce67..a196c3f2 100644 Binary files a/BarcodeLibVBDatamatrix/bin/Debug/Model.pdb and b/BarcodeLibVBDatamatrix/bin/Debug/Model.pdb differ diff --git a/BarcodeLibVBDatamatrix/obj/Debug/BarcodeLibVBDatamatrix.vbproj.AssemblyReference.cache b/BarcodeLibVBDatamatrix/obj/Debug/BarcodeLibVBDatamatrix.vbproj.AssemblyReference.cache index c0207da4..21fdf60e 100644 Binary files a/BarcodeLibVBDatamatrix/obj/Debug/BarcodeLibVBDatamatrix.vbproj.AssemblyReference.cache and b/BarcodeLibVBDatamatrix/obj/Debug/BarcodeLibVBDatamatrix.vbproj.AssemblyReference.cache differ diff --git a/Client/Diverses/SplashScreen.Designer.cs b/Client/Diverses/SplashScreen.Designer.cs index c8352f25..85a2d2ef 100644 --- a/Client/Diverses/SplashScreen.Designer.cs +++ b/Client/Diverses/SplashScreen.Designer.cs @@ -52,7 +52,7 @@ this.label1.Font = new System.Drawing.Font("Microsoft Sans Serif", 16F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(0))); this.label1.Location = new System.Drawing.Point(164, 304); this.label1.Name = "label1"; - this.label1.Size = new System.Drawing.Size(122, 26); + this.label1.Size = new System.Drawing.Size(151, 31); this.label1.TabIndex = 1; this.label1.Text = "Version 1.0"; // @@ -62,9 +62,9 @@ this.label2.Font = new System.Drawing.Font("Microsoft Sans Serif", 16F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(0))); this.label2.Location = new System.Drawing.Point(147, 330); this.label2.Name = "label2"; - this.label2.Size = new System.Drawing.Size(150, 26); + this.label2.Size = new System.Drawing.Size(186, 31); this.label2.TabIndex = 2; - this.label2.Text = "19. März 2025"; + this.label2.Text = "24. März 2025"; // // SplashScreen // diff --git a/Client/DocMgmt/DokTypSelect.resx b/Client/DocMgmt/DokTypSelect.resx index c4ee9aa3..78117141 100644 --- a/Client/DocMgmt/DokTypSelect.resx +++ b/Client/DocMgmt/DokTypSelect.resx @@ -283,7 +283,7 @@ AAEAAAD/////AQAAAAAAAAAMAgAAAFdTeXN0ZW0uV2luZG93cy5Gb3JtcywgVmVyc2lvbj00LjAuMC4w LCBDdWx0dXJlPW5ldXRyYWwsIFB1YmxpY0tleVRva2VuPWI3N2E1YzU2MTkzNGUwODkFAQAAACZTeXN0 ZW0uV2luZG93cy5Gb3Jtcy5JbWFnZUxpc3RTdHJlYW1lcgEAAAAERGF0YQcCAgAAAAkDAAAADwMAAACo - DQAAAk1TRnQBSQFMAgEBBwEAAVABAQFQAQEBEAEAARABAAT/AQkBAAj/AUIBTQE2AQQGAAE2AQQCAAEo + DQAAAk1TRnQBSQFMAgEBBwEAAVgBAQFYAQEBEAEAARABAAT/AQkBAAj/AUIBTQE2AQQGAAE2AQQCAAEo AwABQAMAASADAAEBAQABCAYAAQgYAAGAAgABgAMAAoABAAGAAwABgAEAAYABAAKAAgADwAEAAcAB3AHA AQAB8AHKAaYBAAEzBQABMwEAATMBAAEzAQACMwIAAxYBAAMcAQADIgEAAykBAANVAQADTQEAA0IBAAM5 AQABgAF8Af8BAAJQAf8BAAGTAQAB1gEAAf8B7AHMAQABxgHWAe8BAAHWAucBAAGQAakBrQIAAf8BMwMA diff --git a/Client/DocMgmt/Dokumentpaket.cs b/Client/DocMgmt/Dokumentpaket.cs index a082fcdc..44765c79 100644 --- a/Client/DocMgmt/Dokumentpaket.cs +++ b/Client/DocMgmt/Dokumentpaket.cs @@ -27,6 +27,8 @@ using BroadcastListener.Classes; using BroadcastListener.Interfaces; using static BroadcastListener.Classes.Factory; using Windows.Graphics.Display; +using Windows.Foundation.Metadata; +using System.Threading; namespace OnDoc.DocMgmt { @@ -475,6 +477,7 @@ namespace OnDoc.DocMgmt { progressBarAdv1.Value = progressBarAdv1.Value + 1; Application.DoEvents(); + //Thread.Sleep(1000); UCAllgemeineDokumentParam uc = (UCAllgemeineDokumentParam)tab.Controls[0]; if (((idokumentid == "" || uc.genertated_dokumentid == idokumentid) && iuc==null) || uc==iuc) @@ -552,6 +555,7 @@ namespace OnDoc.DocMgmt if (uc.docgendata.erstellungsart == Erstellungsart.ErstellungInOffice) { string filename = AppParams.tempdir + dokumentid + "." + dok.extension; + filename = AppParams.tempdir + dok.dokumentname; string filename_temp = filename + ".tmp"; System.IO.File.WriteAllBytes(filename_temp, Convert.FromBase64String(dok.dokument)); DB db = new DB(AppParams.connectionstring); @@ -559,12 +563,14 @@ namespace OnDoc.DocMgmt db.Dok_in_Bearbeitung(1,dokdata.Dokumentid, AppParams.CurrentMitarbeiter); db = null; System.IO.File.Delete(filename_temp); + Logging.Logging.Debug("Before Processwatch","DonDoc",dokumentid); clsProcessWatch.AddToList(dokdata.Dokumentid, filename, "Word"); } if (uc.docgendata.erstellungsart == Erstellungsart.DokumentBearbeiten) { string filename = AppParams.tempdir + dokumentid + "." + dok.extension; + //filename = AppParams.tempdir + dok.dokumentname; System.IO.File.WriteAllBytes(filename, Convert.FromBase64String(dok.dokument)); DB db = new DB(AppParams.connectionstring); db.Save_To_DB(dokdata.Dokumentid, filename); diff --git a/Client/DocMgmt/SerienbriefTemplateLoad.Designer.cs b/Client/DocMgmt/SerienbriefTemplateLoad.Designer.cs index 2e8ea834..91c00831 100644 --- a/Client/DocMgmt/SerienbriefTemplateLoad.Designer.cs +++ b/Client/DocMgmt/SerienbriefTemplateLoad.Designer.cs @@ -66,7 +66,7 @@ this.sfButton2.Name = "sfButton2"; this.sfButton2.Size = new System.Drawing.Size(96, 28); this.sfButton2.TabIndex = 2; - this.sfButton2.Text = "Abbruch"; + this.sfButton2.Text = "Abbrechen"; this.sfButton2.Click += new System.EventHandler(this.sfButton2_Click); // // sfButton3 diff --git a/Client/Klassen/clsProcessWatch.cs b/Client/Klassen/clsProcessWatch.cs index d040c1dd..ccfc3f2f 100644 --- a/Client/Klassen/clsProcessWatch.cs +++ b/Client/Klassen/clsProcessWatch.cs @@ -78,115 +78,124 @@ namespace OnDoc.Klassen bool excel = false; bool pdf = false; bool found = false; - //watchtimer.Enabled = false; + watchtimer.Enabled = false; found = false; Logging.Logging.Debug("Start Watch_Process:"+ DateTime.Now.ToString("yyyy-MM-dd hh:mm:ss"), "OnDoc.Processwatch","" ); - - foreach (FileToCheck fc in FilestoCheck) + try { - if (fc.filedatetime < DateTime.Now.AddSeconds(-5)) + foreach (FileToCheck fc in FilestoCheck) { - found = false; - word = false; - excel = false; - pdf = false; - - Logging.Logging.Debug(fc.application + " / FileChek " + fc.filename + " / " + fc.filedatetime.ToString("yyyy-MM-dd hh:mm:ss") + DateTime.Now.ToString("yyyy-MM-dd hh:mm:ss"), "OnDoc.Processwatch", fc.dokumentid); - if (fc.application == "Word") { word = true; } - if (fc.application == "Excel") { excel = true; } - if (fc.application == "PDF") { pdf = true; } - - if (word) + if (fc.filedatetime < DateTime.Now.AddSeconds(-5)) { - Thread.Sleep(200); - Process[] localByName = Process.GetProcessesByName("WINWORD"); + found = false; + word = false; + excel = false; + pdf = false; - foreach (Process p in localByName) + Logging.Logging.Debug(fc.application + " / FileChek " + fc.filename + " / " + fc.filedatetime.ToString("yyyy-MM-dd hh:mm:ss") + DateTime.Now.ToString("yyyy-MM-dd hh:mm:ss"), "OnDoc.Processwatch", fc.dokumentid); + if (fc.application == "Word") { word = true; } + if (fc.application == "Excel") { excel = true; } + if (fc.application == "PDF") { pdf = true; } + + if (word) { - string owner = GetProcessOwner(p.Id); - owner = owner.ToUpper(); - Logging.Logging.Debug(AppParams.systemtgnummer+"/"+AppParams.currenttgnummer+"/"+owner+"/"+fc.dokumentid + "/" + p.MainWindowTitle, "", ""); - if (p.MainWindowTitle.IndexOf(fc.dokumentid) > -1 || - (p.MainWindowTitle.Trim() == "" && owner.Contains(AppParams.systemtgnummer.ToUpper()))) + Thread.Sleep(200); + Process[] localByName = Process.GetProcessesByName("WINWORD"); + + foreach (Process p in localByName) { - if (p.MainWindowTitle.Trim() != "") { fc.Lastfound = DateTime.Now; } - found = true; - save_to_db(fc); - - } + string owner = GetProcessOwner(p.Id); + owner = owner.ToUpper(); + Logging.Logging.Debug(AppParams.systemtgnummer + "/" + AppParams.currenttgnummer + "/" + owner + "/" + fc.dokumentid + "/" + p.MainWindowTitle, "", ""); + if (p.MainWindowTitle.IndexOf(fc.dokumentid) > -1 || + (p.MainWindowTitle.Trim() == "" && owner.Contains(AppParams.systemtgnummer.ToUpper()))) + { + if (p.MainWindowTitle.Trim() != "") { fc.Lastfound = DateTime.Now; } + found = true; + save_to_db(fc); + + } - } + } - //foreach (Process p in localByName) - //{ - // Logging.Logging.Debug(fc.dokumentid + "/" + p.MainWindowTitle, "", ""); - // if (p.MainWindowTitle.IndexOf(fc.dokumentid) > -1 || p.MainWindowTitle.Trim() == "") + //foreach (Process p in localByName) + //{ + // Logging.Logging.Debug(fc.dokumentid + "/" + p.MainWindowTitle, "", ""); + // if (p.MainWindowTitle.IndexOf(fc.dokumentid) > -1 || p.MainWindowTitle.Trim() == "") - // { - // if (p.MainWindowTitle.Trim() != "") { fc.Lastfound = DateTime.Now; } - // found = true; - // save_to_db(fc); + // { + // if (p.MainWindowTitle.Trim() != "") { fc.Lastfound = DateTime.Now; } + // found = true; + // save_to_db(fc); - // break; - // } + // break; + // } - //} + //} - } - if (excel) - { - Process[] localByName = Process.GetProcessesByName("EXCEL"); - foreach (Process p in localByName) + } + if (excel) { - string owner = GetProcessOwner(p.Id); - owner = owner.ToUpper(); - if (p.MainWindowTitle.IndexOf(fc.dokumentid) > -1 || - (p.MainWindowTitle.Trim() == "" && owner.Contains(AppParams.systemtgnummer.ToUpper()))) + Process[] localByName = Process.GetProcessesByName("EXCEL"); + foreach (Process p in localByName) { - if (p.MainWindowTitle.Trim() != "") { fc.Lastfound = DateTime.Now; } - found = true; - save_to_db(fc); - } + string owner = GetProcessOwner(p.Id); + owner = owner.ToUpper(); + if (p.MainWindowTitle.IndexOf(fc.dokumentid) > -1 || + (p.MainWindowTitle.Trim() == "" && owner.Contains(AppParams.systemtgnummer.ToUpper()))) + { + if (p.MainWindowTitle.Trim() != "") { fc.Lastfound = DateTime.Now; } + found = true; + save_to_db(fc); + } + } + //Process[] localByName = Process.GetProcessesByName("EXCEL"); + //foreach (Process p in localByName) + //{ + // if (p.MainWindowTitle.IndexOf(fc.dokumentid) > -1 || p.MainWindowTitle.Trim() == "") + // { + // if (p.MainWindowTitle.Trim() != "") { fc.Lastfound = DateTime.Now; } + // found = true; + // save_to_db(fc); + // } + + //} } - //Process[] localByName = Process.GetProcessesByName("EXCEL"); - //foreach (Process p in localByName) - //{ - // if (p.MainWindowTitle.IndexOf(fc.dokumentid) > -1 || p.MainWindowTitle.Trim() == "") - // { - // if (p.MainWindowTitle.Trim() != "") { fc.Lastfound = DateTime.Now; } - // found = true; - // save_to_db(fc); - // } - - //} - } - if (!found) - { - Logging.Logging.Debug("Not Found " + fc.filename + " / " + DateTime.Now.ToString("yyyy-MM-dd hh:mm:ss"), "OnDoc.Processwatch", fc.dokumentid); - if (Check_Modified(fc) == true) + if (!found) { - Save_File(fc.dokumentid, fc.filename); - Logging.DocLog.Info("Dokument gespeichert und geschlossen", "Processwatch", fc.dokumentid, "", fc.filename); - RemoveFromList(fc.dokumentid); - Remove_Dok_in_Bearbeitung(fc.dokumentid); - Remove_Dokumentbearbeitung_Zwingend(fc.dokumentid); - Remove_Approvals(fc.dokumentid); - return; + Logging.Logging.Debug("Not Found " + fc.filename + " / " + DateTime.Now.ToString("yyyy-MM-dd hh:mm:ss"), "OnDoc.Processwatch", fc.dokumentid); + if (Check_Modified(fc) == true) + { + Save_File(fc.dokumentid, fc.filename); + Logging.DocLog.Info("Dokument gespeichert und geschlossen", "Processwatch", fc.dokumentid, "", fc.filename); + RemoveFromList(fc.dokumentid); + Remove_Dok_in_Bearbeitung(fc.dokumentid); + Remove_Dokumentbearbeitung_Zwingend(fc.dokumentid); + Remove_Approvals(fc.dokumentid); + return; + } + else + { + Logging.DocLog.Info("Dokument ohne speichern geschlossen", "Processwatch", fc.dokumentid, "", fc.filename); + RemoveFromList(fc.dokumentid); + Remove_Dok_in_Bearbeitung(fc.dokumentid); + return; + }; } - else - { - Logging.DocLog.Info("Dokument ohne speichern geschlossen", "Processwatch", fc.dokumentid, "", fc.filename); - RemoveFromList(fc.dokumentid); - Remove_Dok_in_Bearbeitung(fc.dokumentid); - return; - }; } - } + } + watchtimer.Enabled = true; + } + catch (Exception ex) + { + Logging.Logging.Debug("Error Processwatch", "OnDoc", ex.Message); + } + finally + { + watchtimer.Enabled = true ; } - //watchtimer.Enabled = true; - } private static void Remove_Dok_in_Bearbeitung(string dokumentid) { @@ -245,7 +254,13 @@ namespace OnDoc.Klassen private static bool Check_Modified(FileToCheck fc) { DateTime lwt = System.IO.File.GetLastWriteTime(fc.filename); + if (lwt.Year < DateTime.Now.Year) + { + lwt = fc.filedatetime; + lwt = fc.filedatetime.AddSeconds(+5); + } int secdiff = (int)((lwt - fc.filedatetime).TotalSeconds); + Logging.Logging.Debug("Prozesswatch - Check Modified: " + lwt.ToString() + "," + fc.filedatetime.ToString(), "OnDoc", fc.dokumentid); //Logging.DocLog.Debug("Prozesswatch - Check Modified: " + lwt.ToString() + "," + fc.filedatetime.ToString(), "Processwatch", fc.dokumentid, "", fc.filename); //if ((lwt- fc.filedatetime).Seconds > 2) diff --git a/Client/Program.cs b/Client/Program.cs index 07115bce..14c46937 100644 --- a/Client/Program.cs +++ b/Client/Program.cs @@ -16,6 +16,7 @@ using OnDoc.UIControls; using System.Linq.Expressions; + namespace OnDoc { internal static class Program @@ -28,8 +29,7 @@ namespace OnDoc /// Der Haupteinstiegspunkt für die Anwendung. /// private static Mutex mutex = null; - const string AppId = "OnDoc5094533C-A613-4889-A0E3-8C28C130C6AA)"; - + const string AppId = "OnDoc5094533C-A613-4889-A0E3-8C28C130C6AA)"; //static Start MyForm = new Start(); /// [STAThread] @@ -47,9 +47,9 @@ namespace OnDoc { string debugstring; - if (args[0].ToString().ToUpper().Substring(args[0].ToString().Length - 4, 4) == ".EDK") { + AppParams.init(); Database.DB db = new Database.DB(AppParams.connectionstring); string mitarbeiter = System.Security.Principal.WindowsIdentity.GetCurrent().Name; @@ -67,11 +67,14 @@ namespace OnDoc System.Environment.Exit(0); return; } - string destfile = AppParams.tempdir + DateTime.Now.ToString("yyyyMMddHHmmss") + "_tmpfile.edk"; + string destfile = AppParams.tempdir + RandomString(8)+ "_"+DateTime.Now.ToString("yyyyMMddHHmmss") + "_tmpfile.edk"; + System.IO.File.Copy(args[0],destfile); + Application.DoEvents(); System.IO.File.Delete(args[0]); - - //EDK_Data.Load_EDK_File(args[0]); + Application.DoEvents(); + + Thread.Sleep(1000); } else { @@ -129,6 +132,14 @@ namespace OnDoc + } + private static Random random = new Random(); + + public static string RandomString(int length) + { + const string chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"; + return new string(Enumerable.Repeat(chars, length) + .Select(s => s[random.Next(s.Length)]).ToArray()); } } } diff --git a/Client/Start.cs b/Client/Start.cs index aa5259a7..98109ee7 100644 --- a/Client/Start.cs +++ b/Client/Start.cs @@ -154,30 +154,7 @@ namespace OnDoc private void Start_Load(object sender, EventArgs e) { - //if (ExternalCall.sourceparam.Trim().ToString() !="" && ExternalCall.executed == false) - //{ - // External_Call(); - //} - //if (EDK_Data.toexecute == true) - //{ - // exec_edk(); - //} - //partnerTree1.mitarbeiternr = AppParams.CurrentMitarbeiter; - - //DataSet ds = new DataSet(); - //System.Data.DataTable dataTable = new System.Data.DataTable(); - //dataTable.Columns.Add("ID"); - //dataTable.Columns.Add("ImageName"); - //System.Data.DataRow dr = dataTable.NewRow(); - //dr[0] = "1"; - //dr[1] = "Bildname"; - //dataTable.Rows.Add(dr); - //ds.Tables.Add(dataTable); - //ds.WriteXml(@"E:\Software-Projekte\OnDoc\Images\imageids.xml"); - - - - + } diff --git a/Client/UIControls/DokList.Designer.cs b/Client/UIControls/DokList.Designer.cs index 5bb789d0..bf6d6e8f 100644 --- a/Client/UIControls/DokList.Designer.cs +++ b/Client/UIControls/DokList.Designer.cs @@ -209,14 +209,14 @@ namespace OnDoc.UICintrols this.gruppenÖffnenToolStripMenuItem, this.gruppenSchliessenToolStripMenuItem}); this.ctxMenuDokList.Name = "ctxMenuDokList"; - this.ctxMenuDokList.Size = new System.Drawing.Size(342, 522); + this.ctxMenuDokList.Size = new System.Drawing.Size(284, 522); this.ctxMenuDokList.Opening += new System.ComponentModel.CancelEventHandler(this.ctxMenuDokList_Opening); // // dokumentAnzeigenToolStripMenuItem // this.dokumentAnzeigenToolStripMenuItem.Image = global::OnDoc.Properties.Resources.ShowDoc_16x16_32; this.dokumentAnzeigenToolStripMenuItem.Name = "dokumentAnzeigenToolStripMenuItem"; - this.dokumentAnzeigenToolStripMenuItem.Size = new System.Drawing.Size(341, 26); + this.dokumentAnzeigenToolStripMenuItem.Size = new System.Drawing.Size(283, 26); this.dokumentAnzeigenToolStripMenuItem.Text = "Dokument anzeigen"; this.dokumentAnzeigenToolStripMenuItem.Click += new System.EventHandler(this.dokumentAnzeigenToolStripMenuItem_Click); // @@ -224,7 +224,7 @@ namespace OnDoc.UICintrols // this.dokumentBearbeitenToolStripMenuItem.Image = global::OnDoc.Properties.Resources.EditDoc_16x16_32; this.dokumentBearbeitenToolStripMenuItem.Name = "dokumentBearbeitenToolStripMenuItem"; - this.dokumentBearbeitenToolStripMenuItem.Size = new System.Drawing.Size(341, 26); + this.dokumentBearbeitenToolStripMenuItem.Size = new System.Drawing.Size(283, 26); this.dokumentBearbeitenToolStripMenuItem.Text = "Dokument bearbeiten"; this.dokumentBearbeitenToolStripMenuItem.Click += new System.EventHandler(this.dokumentBearbeitenToolStripMenuItem_Click); // @@ -232,27 +232,27 @@ namespace OnDoc.UICintrols // this.dokumentLöschenToolStripMenuItem.Image = global::OnDoc.Properties.Resources.DeleteDoc_16x16_32; this.dokumentLöschenToolStripMenuItem.Name = "dokumentLöschenToolStripMenuItem"; - this.dokumentLöschenToolStripMenuItem.Size = new System.Drawing.Size(341, 26); + this.dokumentLöschenToolStripMenuItem.Size = new System.Drawing.Size(283, 26); this.dokumentLöschenToolStripMenuItem.Text = "Dokument löschen"; this.dokumentLöschenToolStripMenuItem.Click += new System.EventHandler(this.dokumentLöschenToolStripMenuItem_Click); // // toolStripMenuItem2 // this.toolStripMenuItem2.Name = "toolStripMenuItem2"; - this.toolStripMenuItem2.Size = new System.Drawing.Size(338, 6); + this.toolStripMenuItem2.Size = new System.Drawing.Size(280, 6); // // zurUnterschriftenPrüfungToolStripMenuItem // this.zurUnterschriftenPrüfungToolStripMenuItem.Image = global::OnDoc.Properties.Resources.Approval_16x16_32; this.zurUnterschriftenPrüfungToolStripMenuItem.Name = "zurUnterschriftenPrüfungToolStripMenuItem"; - this.zurUnterschriftenPrüfungToolStripMenuItem.Size = new System.Drawing.Size(341, 26); + this.zurUnterschriftenPrüfungToolStripMenuItem.Size = new System.Drawing.Size(283, 26); this.zurUnterschriftenPrüfungToolStripMenuItem.Text = "Zur Unterschriften-Prüfung"; this.zurUnterschriftenPrüfungToolStripMenuItem.Click += new System.EventHandler(this.zurUnterschriftenPrüfungToolStripMenuItem_Click); // // dokumentUnterzeichnenToolStripMenuItem // this.dokumentUnterzeichnenToolStripMenuItem.Name = "dokumentUnterzeichnenToolStripMenuItem"; - this.dokumentUnterzeichnenToolStripMenuItem.Size = new System.Drawing.Size(341, 26); + this.dokumentUnterzeichnenToolStripMenuItem.Size = new System.Drawing.Size(283, 26); this.dokumentUnterzeichnenToolStripMenuItem.Text = "Dokument unterzeichnen"; this.dokumentUnterzeichnenToolStripMenuItem.Visible = false; this.dokumentUnterzeichnenToolStripMenuItem.Click += new System.EventHandler(this.dokumentUnterzeichnenToolStripMenuItem_Click); @@ -261,7 +261,7 @@ namespace OnDoc.UICintrols // this.archivierenToolStripMenuItem.Image = ((System.Drawing.Image)(resources.GetObject("archivierenToolStripMenuItem.Image"))); this.archivierenToolStripMenuItem.Name = "archivierenToolStripMenuItem"; - this.archivierenToolStripMenuItem.Size = new System.Drawing.Size(341, 26); + this.archivierenToolStripMenuItem.Size = new System.Drawing.Size(283, 26); this.archivierenToolStripMenuItem.Text = "Archivieren"; this.archivierenToolStripMenuItem.Click += new System.EventHandler(this.archivierenToolStripMenuItem_Click); // @@ -269,7 +269,7 @@ namespace OnDoc.UICintrols // this.druckenToolStripMenuItem.Image = global::OnDoc.Properties.Resources.Printer_16x16_32; this.druckenToolStripMenuItem.Name = "druckenToolStripMenuItem"; - this.druckenToolStripMenuItem.Size = new System.Drawing.Size(341, 26); + this.druckenToolStripMenuItem.Size = new System.Drawing.Size(283, 26); this.druckenToolStripMenuItem.Text = "Drucken"; this.druckenToolStripMenuItem.Visible = false; this.druckenToolStripMenuItem.Click += new System.EventHandler(this.druckenToolStripMenuItem_Click); @@ -277,13 +277,13 @@ namespace OnDoc.UICintrols // toolStripMenuItem4 // this.toolStripMenuItem4.Name = "toolStripMenuItem4"; - this.toolStripMenuItem4.Size = new System.Drawing.Size(338, 6); + this.toolStripMenuItem4.Size = new System.Drawing.Size(280, 6); // // dokumentFürPartnerErstellenToolStripMenuItem // this.dokumentFürPartnerErstellenToolStripMenuItem.Image = global::OnDoc.Properties.Resources.NewDoc_16x16_32; this.dokumentFürPartnerErstellenToolStripMenuItem.Name = "dokumentFürPartnerErstellenToolStripMenuItem"; - this.dokumentFürPartnerErstellenToolStripMenuItem.Size = new System.Drawing.Size(341, 26); + this.dokumentFürPartnerErstellenToolStripMenuItem.Size = new System.Drawing.Size(283, 26); this.dokumentFürPartnerErstellenToolStripMenuItem.Text = "Dokument für Kunde erstellen"; this.dokumentFürPartnerErstellenToolStripMenuItem.Click += new System.EventHandler(this.dokumentFürPartnerErstellenToolStripMenuItem_Click); // @@ -291,19 +291,19 @@ namespace OnDoc.UICintrols // this.dokumentKopierenToolStripMenuItem.Image = global::OnDoc.Properties.Resources.Copy_16x16_32; this.dokumentKopierenToolStripMenuItem.Name = "dokumentKopierenToolStripMenuItem"; - this.dokumentKopierenToolStripMenuItem.Size = new System.Drawing.Size(341, 26); + this.dokumentKopierenToolStripMenuItem.Size = new System.Drawing.Size(283, 26); this.dokumentKopierenToolStripMenuItem.Text = "Dokument kopieren"; this.dokumentKopierenToolStripMenuItem.Click += new System.EventHandler(this.dokumentKopierenToolStripMenuItem_Click); // // toolStripMenuItem1 // this.toolStripMenuItem1.Name = "toolStripMenuItem1"; - this.toolStripMenuItem1.Size = new System.Drawing.Size(338, 6); + this.toolStripMenuItem1.Size = new System.Drawing.Size(280, 6); // // barcodeDemoToolStripMenuItem // this.barcodeDemoToolStripMenuItem.Name = "barcodeDemoToolStripMenuItem"; - this.barcodeDemoToolStripMenuItem.Size = new System.Drawing.Size(341, 26); + this.barcodeDemoToolStripMenuItem.Size = new System.Drawing.Size(283, 26); this.barcodeDemoToolStripMenuItem.Text = "Barcode-Demo"; this.barcodeDemoToolStripMenuItem.Visible = false; this.barcodeDemoToolStripMenuItem.Click += new System.EventHandler(this.barcodeDemoToolStripMenuItem_Click); @@ -311,7 +311,7 @@ namespace OnDoc.UICintrols // vertragPDFDEMOToolStripMenuItem // this.vertragPDFDEMOToolStripMenuItem.Name = "vertragPDFDEMOToolStripMenuItem"; - this.vertragPDFDEMOToolStripMenuItem.Size = new System.Drawing.Size(341, 26); + this.vertragPDFDEMOToolStripMenuItem.Size = new System.Drawing.Size(283, 26); this.vertragPDFDEMOToolStripMenuItem.Text = "Vertrag_PDF_DEMO"; this.vertragPDFDEMOToolStripMenuItem.Visible = false; this.vertragPDFDEMOToolStripMenuItem.Click += new System.EventHandler(this.vertragPDFDEMOToolStripMenuItem_Click); @@ -319,14 +319,14 @@ namespace OnDoc.UICintrols // zellenwertInZwischenablageKopierenToolStripMenuItem // this.zellenwertInZwischenablageKopierenToolStripMenuItem.Name = "zellenwertInZwischenablageKopierenToolStripMenuItem"; - this.zellenwertInZwischenablageKopierenToolStripMenuItem.Size = new System.Drawing.Size(341, 26); + this.zellenwertInZwischenablageKopierenToolStripMenuItem.Size = new System.Drawing.Size(283, 26); this.zellenwertInZwischenablageKopierenToolStripMenuItem.Text = "Zellenwert in Zwischenablage kopieren"; this.zellenwertInZwischenablageKopierenToolStripMenuItem.Click += new System.EventHandler(this.zellenwertInZwischenablageKopierenToolStripMenuItem_Click); // // pDFGenerierenToolStripMenuItem // this.pDFGenerierenToolStripMenuItem.Name = "pDFGenerierenToolStripMenuItem"; - this.pDFGenerierenToolStripMenuItem.Size = new System.Drawing.Size(341, 26); + this.pDFGenerierenToolStripMenuItem.Size = new System.Drawing.Size(283, 26); this.pDFGenerierenToolStripMenuItem.Text = "PDF generieren"; this.pDFGenerierenToolStripMenuItem.Visible = false; this.pDFGenerierenToolStripMenuItem.Click += new System.EventHandler(this.pDFGenerierenToolStripMenuItem_Click); @@ -334,14 +334,14 @@ namespace OnDoc.UICintrols // dokumentAnVersandstrasseToolStripMenuItem // this.dokumentAnVersandstrasseToolStripMenuItem.Name = "dokumentAnVersandstrasseToolStripMenuItem"; - this.dokumentAnVersandstrasseToolStripMenuItem.Size = new System.Drawing.Size(341, 26); + this.dokumentAnVersandstrasseToolStripMenuItem.Size = new System.Drawing.Size(283, 26); this.dokumentAnVersandstrasseToolStripMenuItem.Text = "Dokument an Versandstrasse"; this.dokumentAnVersandstrasseToolStripMenuItem.Visible = false; // // wordInterOPEditToolStripMenuItem // this.wordInterOPEditToolStripMenuItem.Name = "wordInterOPEditToolStripMenuItem"; - this.wordInterOPEditToolStripMenuItem.Size = new System.Drawing.Size(341, 26); + this.wordInterOPEditToolStripMenuItem.Size = new System.Drawing.Size(283, 26); this.wordInterOPEditToolStripMenuItem.Text = "Word InterOP Edit"; this.wordInterOPEditToolStripMenuItem.Visible = false; this.wordInterOPEditToolStripMenuItem.Click += new System.EventHandler(this.wordInterOPEditToolStripMenuItem_Click); @@ -350,33 +350,33 @@ namespace OnDoc.UICintrols // this.attributeAnzeigenVersteckenToolStripMenuItem.Image = global::OnDoc.Properties.Resources.Attribut_16x16_32; this.attributeAnzeigenVersteckenToolStripMenuItem.Name = "attributeAnzeigenVersteckenToolStripMenuItem"; - this.attributeAnzeigenVersteckenToolStripMenuItem.Size = new System.Drawing.Size(341, 26); + this.attributeAnzeigenVersteckenToolStripMenuItem.Size = new System.Drawing.Size(283, 26); this.attributeAnzeigenVersteckenToolStripMenuItem.Text = "Attribute ein- / ausblenden"; this.attributeAnzeigenVersteckenToolStripMenuItem.Click += new System.EventHandler(this.attributeAnzeigenVersteckenToolStripMenuItem_Click); // // historyToolStripMenuItem // this.historyToolStripMenuItem.Name = "historyToolStripMenuItem"; - this.historyToolStripMenuItem.Size = new System.Drawing.Size(341, 26); + this.historyToolStripMenuItem.Size = new System.Drawing.Size(283, 26); this.historyToolStripMenuItem.Text = "History"; this.historyToolStripMenuItem.Click += new System.EventHandler(this.historyToolStripMenuItem_Click); // // toolStripMenuItem3 // this.toolStripMenuItem3.Name = "toolStripMenuItem3"; - this.toolStripMenuItem3.Size = new System.Drawing.Size(338, 6); + this.toolStripMenuItem3.Size = new System.Drawing.Size(280, 6); // // gruppenÖffnenToolStripMenuItem // this.gruppenÖffnenToolStripMenuItem.Name = "gruppenÖffnenToolStripMenuItem"; - this.gruppenÖffnenToolStripMenuItem.Size = new System.Drawing.Size(341, 26); + this.gruppenÖffnenToolStripMenuItem.Size = new System.Drawing.Size(283, 26); this.gruppenÖffnenToolStripMenuItem.Text = "Alle Gruppen aufklappen"; this.gruppenÖffnenToolStripMenuItem.Click += new System.EventHandler(this.gruppenÖffnenToolStripMenuItem_Click); // // gruppenSchliessenToolStripMenuItem // this.gruppenSchliessenToolStripMenuItem.Name = "gruppenSchliessenToolStripMenuItem"; - this.gruppenSchliessenToolStripMenuItem.Size = new System.Drawing.Size(341, 26); + this.gruppenSchliessenToolStripMenuItem.Size = new System.Drawing.Size(283, 26); this.gruppenSchliessenToolStripMenuItem.Text = "Alle Gruppen einklappen"; this.gruppenSchliessenToolStripMenuItem.Click += new System.EventHandler(this.gruppenSchliessenToolStripMenuItem_Click); // @@ -400,7 +400,7 @@ namespace OnDoc.UICintrols // toolStripLabel1 // this.toolStripLabel1.Name = "toolStripLabel1"; - this.toolStripLabel1.Size = new System.Drawing.Size(143, 22); + this.toolStripLabel1.Size = new System.Drawing.Size(116, 22); this.toolStripLabel1.Text = "Dokument-Vorschau"; // // tsrbvorschau @@ -427,7 +427,7 @@ namespace OnDoc.UICintrols this.tsbtnpreviewno.Image = ((System.Drawing.Image)(resources.GetObject("tsbtnpreviewno.Image"))); this.tsbtnpreviewno.ImageTransparentColor = System.Drawing.Color.Magenta; this.tsbtnpreviewno.Name = "tsbtnpreviewno"; - this.tsbtnpreviewno.Size = new System.Drawing.Size(29, 22); + this.tsbtnpreviewno.Size = new System.Drawing.Size(24, 22); this.tsbtnpreviewno.Text = "Keine Vorschau"; // // tsbtnpreviewbottom @@ -436,7 +436,7 @@ namespace OnDoc.UICintrols this.tsbtnpreviewbottom.Image = ((System.Drawing.Image)(resources.GetObject("tsbtnpreviewbottom.Image"))); this.tsbtnpreviewbottom.ImageTransparentColor = System.Drawing.Color.Magenta; this.tsbtnpreviewbottom.Name = "tsbtnpreviewbottom"; - this.tsbtnpreviewbottom.Size = new System.Drawing.Size(29, 22); + this.tsbtnpreviewbottom.Size = new System.Drawing.Size(24, 22); this.tsbtnpreviewbottom.Text = "Vorschau unten"; // // tsbtnpreviewright @@ -445,7 +445,7 @@ namespace OnDoc.UICintrols this.tsbtnpreviewright.Image = ((System.Drawing.Image)(resources.GetObject("tsbtnpreviewright.Image"))); this.tsbtnpreviewright.ImageTransparentColor = System.Drawing.Color.Magenta; this.tsbtnpreviewright.Name = "tsbtnpreviewright"; - this.tsbtnpreviewright.Size = new System.Drawing.Size(29, 22); + this.tsbtnpreviewright.Size = new System.Drawing.Size(24, 22); this.tsbtnpreviewright.Text = "Vorschau rechts"; // // splitContainer1 @@ -1384,19 +1384,19 @@ namespace OnDoc.UICintrols this.gruppenÖffnenToolStripMenuItem1, this.gruppenSchliessenToolStripMenuItem1}); this.ctxMenuGroups.Name = "ctxMenuGroups"; - this.ctxMenuGroups.Size = new System.Drawing.Size(244, 52); + this.ctxMenuGroups.Size = new System.Drawing.Size(206, 48); // // gruppenÖffnenToolStripMenuItem1 // this.gruppenÖffnenToolStripMenuItem1.Name = "gruppenÖffnenToolStripMenuItem1"; - this.gruppenÖffnenToolStripMenuItem1.Size = new System.Drawing.Size(243, 24); + this.gruppenÖffnenToolStripMenuItem1.Size = new System.Drawing.Size(205, 22); this.gruppenÖffnenToolStripMenuItem1.Text = "Alle Gruppen aufklappen"; this.gruppenÖffnenToolStripMenuItem1.Click += new System.EventHandler(this.gruppenÖffnenToolStripMenuItem1_Click); // // gruppenSchliessenToolStripMenuItem1 // this.gruppenSchliessenToolStripMenuItem1.Name = "gruppenSchliessenToolStripMenuItem1"; - this.gruppenSchliessenToolStripMenuItem1.Size = new System.Drawing.Size(243, 24); + this.gruppenSchliessenToolStripMenuItem1.Size = new System.Drawing.Size(205, 22); this.gruppenSchliessenToolStripMenuItem1.Text = "Alle Gruppen einklappen"; this.gruppenSchliessenToolStripMenuItem1.Click += new System.EventHandler(this.gruppenSchliessenToolStripMenuItem1_Click); // diff --git a/Client/UIControls/DokList.cs b/Client/UIControls/DokList.cs index 79b17280..55da9608 100644 --- a/Client/UIControls/DokList.cs +++ b/Client/UIControls/DokList.cs @@ -59,6 +59,7 @@ using Syncfusion.Windows.Forms.Chart; + namespace OnDoc.UICintrols { public partial class DokList : UserControl, IMessageListener1 @@ -113,7 +114,7 @@ namespace OnDoc.UICintrols { GridDateTimeColumn gdt = e.Column as GridDateTimeColumn; gdt.Pattern = (Syncfusion.WinForms.Input.Enums.DateTimePattern)Syncfusion.Windows.Shared.DateTimePattern.FullDateTime; - + } @@ -286,10 +287,11 @@ namespace OnDoc.UICintrols catch { } finally { db = null; } } - + public void refresh_dokumente(string layout = "") { update_currentview(); + if (datafilter != "") { refresh_dokumente_filtered(layout); @@ -299,6 +301,7 @@ namespace OnDoc.UICintrols } else { + refresh_view(currentview); } @@ -308,21 +311,24 @@ namespace OnDoc.UICintrols int selectedIndex = RibbonCBProfil.SelectedIndex; profilnr = Convert.ToInt32(RibbonCBProfil.SelectedItem.Tag.ToString()); - - + + // profilnr = Convert.ToInt32(RibbonCBProfil.SelectedItem.Tag.ToString()); System.Data.DataTable dokumente = new System.Data.DataTable(); - - dokumente = db.Get_Dokumente(partnernr, docartnr, profilnr, forMaNr, Search_Docid, false); + Logging.Logging.Debug("Get_Dokumente", "", ""); + + dokumente = db.Get_Dokumente(partnernr, docartnr, profilnr, forMaNr, Search_Docid, false); // TableHelper.SetColumnsOrder(dokumente, "trefferliste"); if (layout == "") { layout = "trefferliste_relaunch"; } TableHelper.FormatTable(ref dokumente, layout, ref this.sfDataGrid1); - //this.sfDataGrid1.DataSource = dokumente; + this.sfDataGrid1.DataSource = dokumente; sfDataGrid1.View.AutoExpandGroups = true; this.timer1.Enabled = true; + Logging.Logging.Debug("refresh_view", "", ""); + refresh_view(currentview); //foreach (GridColumn gd in sfDataGrid1.Columns) //{ @@ -512,7 +518,7 @@ namespace OnDoc.UICintrols } } - catch { } + catch { } } public void dokument_bearbeiten(string dokid, bool newdok = false) { @@ -528,8 +534,8 @@ namespace OnDoc.UICintrols case 0: break; case 1: - if (MessageBox.Show("Das Dokument wird aktuell bearbeitet."+Environment.NewLine+ Environment.NewLine + "Sperrung aufheben?" +Environment.NewLine+Environment.NewLine+"Bitte vorgängig prüfen, ob das Dokument nicht mehr in Word/Excel geöffnet ist!","Dokumentsperrung aufheben",MessageBoxButtons.YesNo, MessageBoxIcon.Question) == DialogResult.Yes) - { + if (MessageBox.Show("Das Dokument wird aktuell bearbeitet." + Environment.NewLine + Environment.NewLine + "Sperrung aufheben?" + Environment.NewLine + Environment.NewLine + "Bitte vorgängig prüfen, ob das Dokument nicht mehr in Word/Excel geöffnet ist!", "Dokumentsperrung aufheben", MessageBoxButtons.YesNo, MessageBoxIcon.Question) == DialogResult.Yes) + { clsProcessWatch.RemoveFromList(dokid); } else @@ -587,16 +593,16 @@ namespace OnDoc.UICintrols db1 = null; break; case 1: - Cursor = Cursors.WaitCursor; - System.Windows.Forms.Application.DoEvents(); - selected_dokumentid = dokbearbeitung.dokumentid; - selected_partnernr = dokbearbeitung.partnernr.ToString(); ; - interop = dokbearbeitung.interop; - runmacros = dokbearbeitung.runmacros; - dok = GetDoc(false); - OpenDoc(dok, true, interop, false); - Cursor = Cursors.Default; - System.Windows.Forms.Application.DoEvents(); + Cursor = Cursors.WaitCursor; + System.Windows.Forms.Application.DoEvents(); + selected_dokumentid = dokbearbeitung.dokumentid; + selected_partnernr = dokbearbeitung.partnernr.ToString(); ; + interop = dokbearbeitung.interop; + runmacros = dokbearbeitung.runmacros; + dok = GetDoc(false); + OpenDoc(dok, true, interop, false); + Cursor = Cursors.Default; + System.Windows.Forms.Application.DoEvents(); break; case 6: //DB db1 = new DB(AppParams.connectionstring); @@ -605,7 +611,7 @@ namespace OnDoc.UICintrols interop = dokbearbeitung.interop; //runmacros = dokbearbeitung.runmacros; string filename = dokbearbeitung.filename; - + string ext = System.IO.Path.GetExtension(filename); string apptype = ""; switch (ext.ToUpper()) @@ -627,7 +633,7 @@ namespace OnDoc.UICintrols break; } - Logging.Logging.Debug("Doklist Docfunction=6", "Doklist", ""); + Logging.Logging.Debug("Doklist Docfunction=6", "Doklist", ""); //db1.Dok_in_Bearbeitung(1, selected_dokumentid, AppParams.CurrentMitarbeiter); //db1 = null; clsProcessWatch.AddToList(selected_dokumentid, filename, apptype); @@ -733,7 +739,7 @@ namespace OnDoc.UICintrols case "D": clsFileHelper fh = new clsFileHelper(); string tempfilename = ""; - + tempfilename = fh.save_temp_file(dok.dokument, selected_dokumentid, AppParams.tempdir, dok.extension, dok.dokumentname); //System.Diagnostics.Process.Start(tempfilename); interop = true; @@ -776,7 +782,7 @@ namespace OnDoc.UICintrols break; case "P": clsFileHelper fh3 = new clsFileHelper(); - tempfilename = fh3.save_temp_file(dok.dokument, selected_dokumentid, AppParams.tempdir, dok.extension,dok.dokumentname ); + tempfilename = fh3.save_temp_file(dok.dokument, selected_dokumentid, AppParams.tempdir, dok.extension, dok.dokumentname); System.Diagnostics.Process.Start(tempfilename); if (editdoc == true) { @@ -874,13 +880,18 @@ namespace OnDoc.UICintrols private void update_currentview() { - currentview["Preview"] = tsrbvorschau.SelectedIndex; - if (RibbonButtonAttributeEinAusblenden.Checked) { currentview["Attributes"] = 1; } else { currentview["Attributes"] = 0; } - currentview["Splitterdistance"] = splitContainer1.SplitterDistance; - MemoryStream ms = new MemoryStream(); - //gaga - this.sfDataGrid1.Serialize(ms); - currentview["Gridsettings"] = Convert.ToBase64String(ms.ToArray()); + try + { + currentview["Preview"] = tsrbvorschau.SelectedIndex; + if (RibbonButtonAttributeEinAusblenden.Checked) { currentview["Attributes"] = 1; } else { currentview["Attributes"] = 0; } + currentview["Splitterdistance"] = splitContainer1.SplitterDistance; + MemoryStream ms = new MemoryStream(); + + this.sfDataGrid1.Serialize(ms); + System.Windows.Forms.Application.DoEvents(); + currentview["Gridsettings"] = Convert.ToBase64String(ms.ToArray()); + } + catch { } } private void RibbonBtnVorschauUnten_Click(object sender, EventArgs e) @@ -1116,7 +1127,7 @@ namespace OnDoc.UICintrols if (records.Count < 1) { return; } if (!row_selected()) return; - InputDialog ma = new InputDialog(true, "Verantwortlichkeit wechseln zu","Verantwortlichkeit zuweisen"); + InputDialog ma = new InputDialog(true, "Verantwortlichkeit wechseln zu", "Verantwortlichkeit zuweisen"); ma.ShowDialog(); if (ma.DialogResult == DialogResult.OK) { @@ -1135,7 +1146,7 @@ namespace OnDoc.UICintrols } dB = null; - + refresh_dokumente(); } } @@ -1162,6 +1173,7 @@ namespace OnDoc.UICintrols public void hide_panels() { refresh_ansichten(""); + set_functions(); this.RibbonButtonFavoriten.Visible = false; this.RibbonPanelSuche.Visible = false; this.RibbonPannelAproval.Visible = false; @@ -1182,6 +1194,7 @@ namespace OnDoc.UICintrols this.RibbonButtonVorschauRechts.Visible = false; this.RibbonBtnVorschauUnten.Visible = false; this.ribbonTabDokpaket_Serienbrief.Visible = false; + //this.ribbonButtonVersandstrasse.Visible = false; this.ribbonTabDokpaket_Serienbrief.Visible = false; this.ribbonTabProfil.Visible = false; @@ -1200,7 +1213,8 @@ namespace OnDoc.UICintrols { var selectedItem = e.DataRow; var dataRow = (e.DataRow.RowData as DataRowView).Row; - if (dataRow["Prüfung_Reghts"].ToString().Contains("Abgelehnt")){ + if (dataRow["Prüfung_Reghts"].ToString().Contains("Abgelehnt")) + { e.Style.BackColor = Color.Red; } @@ -1290,7 +1304,7 @@ namespace OnDoc.UICintrols } if (dataRow[0].ToString().Substring(0, 1).ToUpper() == "X") { - if (Convert.ToBoolean(dataRow["Bearbeitung_Zwingend"]) == false ) + if (Convert.ToBoolean(dataRow["Bearbeitung_Zwingend"]) == false) if (Convert.ToBoolean(dataRow["toapprove"]) == true) { if (Convert.ToBoolean(dataRow["approved"]) == true) @@ -1438,11 +1452,11 @@ namespace OnDoc.UICintrols { DOCGEN.DocGet dg = new DocGet(AppParams.connectionstring); //dg.GetDocAsPDF(selected_dokumentid); - clsdok dok = new clsdok("", "", "", "" ); + clsdok dok = new clsdok("", "", "", ""); dok = dg.GetDocAsFinalPDF(selected_dokumentid); clsFileHelper fh = new clsFileHelper(); string tempfilename = ""; - tempfilename = fh.save_temp_file(dok.dokument, selected_dokumentid, AppParams.tempdir, dok.extension,dok.dokumentname); + tempfilename = fh.save_temp_file(dok.dokument, selected_dokumentid, AppParams.tempdir, dok.extension, dok.dokumentname); } private void ribbonButtonNativ_Click(object sender, EventArgs e) @@ -1466,14 +1480,14 @@ namespace OnDoc.UICintrols { StreamReader reader = new StreamReader(response.GetResponseStream()); string responseContent = reader.ReadToEnd(); - if (responseContent.Contains("Hinweismeldung:")) + if (responseContent.Contains("Hinweismeldung:")) { - MessageBox.Show("Die Archivierung des Dokumentes " + documentid + " wurde nicht durchgeführt:" + Environment.NewLine + responseContent); + MessageBox.Show("Die Archivierung des Dokumentes " + documentid + " wurde nicht durchgeführt:" + Environment.NewLine + responseContent); return; } - Logging.DocLog.Info("Dokument archiviert", "OnDoc", documentid, "", "Dokument archiviert und abgeschlossen"); + Logging.DocLog.Info("Dokument archiviert", "OnDoc", documentid, "", "Dokument archiviert und abgeschlossen"); } else { @@ -1568,39 +1582,59 @@ namespace OnDoc.UICintrols //refresh_dokumente(); } - private void ribbonButtonVersandstrasse_Click(object sender, EventArgs e) - { - Versandpakete versandpakete = new Versandpakete(); - Versandpaket paket = new Versandpaket(); - - paket.Versandoption = "1"; - paket.Mitteilung = ""; - paket.GAS = ""; - paket.GASAdresse = ""; - paket.PaketNr = "1"; + private Boolean check_versandpaket_bp(ref List pakete,int partnernr) + { + foreach (Versandpaket vp in pakete) + { + if (vp.partnernr == partnernr) { return true; break; } + } + return false; + } + private void ribbonButtonVersandstrasse_Click(object sender, EventArgs e) + { var records = sfDataGrid1.View.GetSelectedRecords(); if (records.Count < 1) { return; } - - // string[] selectedDokument = new string[records.Count]; int i = 0; - paket.Dokument = new List(); + + List versandpakete = new List (); foreach (var record in records) { - var datarow = record as DataRowView; - paket.Dokument.Add(new Versanddokument(datarow["dokumentid"].ToString(), datarow["doktyp"].ToString(), datarow["partner-nr"].ToString())); - i++; + + if (check_versandpaket_bp(ref versandpakete, Convert.ToInt32(datarow["partner-nr"]))) + { + foreach(Versandpaket versandpaket in versandpakete) + { + if (versandpaket.partnernr== Convert.ToInt32(datarow["partner-nr"])) + { + versandpaket.Dokument.Add(new Versanddokument(datarow["dokumentid"].ToString(), datarow["doktyp"].ToString(), datarow["partner-nr"].ToString())); + } + } + } + else + { + Versandpaket vp = new Versandpaket(); + vp.Dokument = new List (); + vp.partnernr = Convert.ToInt32(datarow["partner-nr"]); + vp.Versandoption = "1"; + vp.Mitteilung = ""; + vp.GAS = ""; + vp.GASAdresse = ""; + vp.PaketNr = i.ToString(); + vp.Dokument.Add(new Versanddokument(datarow["dokumentid"].ToString(), datarow["doktyp"].ToString(), datarow["partner-nr"].ToString())); + i++; + versandpakete.Add(vp); + + } } - versandpakete.paket = new List(); - versandpakete.paket.Add(paket); OnDoc.Versandstrasse.Versandstrasse vs = new OnDoc.Versandstrasse.Versandstrasse(versandpakete); - vs.Show(); dokumentAnVersandstrasseToolStripMenuItem.Visible = true; + } private void RibbonButtonFavoriten_Click(object sender, EventArgs e) @@ -1797,7 +1831,7 @@ namespace OnDoc.UICintrols private void ribbonGroupMitarbeiter_Click(object sender, EventArgs e) { - InputDialog ma = new InputDialog(true, "Verantwortlicher Mitarbeiter wählen","Mitarbeiter wählen"); + InputDialog ma = new InputDialog(true, "Verantwortlicher Mitarbeiter wählen", "Mitarbeiter wählen"); ma.ShowDialog(); if (ma.DialogResult == DialogResult.OK) @@ -1887,64 +1921,90 @@ namespace OnDoc.UICintrols } - + //private void refresh_view(string base64string) private void refresh_view(System.Data.DataRow dataRow) { - string base64string = dataRow["gridsettings"].ToString(); + //List clist = new List(); + //clist.Clear(); + //int I = 0; + //if (sfDataGrid1.GroupColumnDescriptions.Count > 0) + //{ + // for (int i = 0; i < sfDataGrid1.GroupColumnDescriptions.Count; i++) + // { + // clist.Add(sfDataGrid1.GroupColumnDescriptions[i].ColumnName); + // } + // sfDataGrid1.GroupColumnDescriptions.Clear(); - byte[] bytes = Convert.FromBase64String(base64string); - string plaintext = Strings.Base64Decode(base64string); - string tagesdatum = DateTime.Now.ToString("yyyy-MM-ddT00:00:00"); - //tagesdatum = "2024-11-29T00:00:00"; - plaintext = plaintext.Replace("@today@", tagesdatum); - plaintext = Strings.Base64Encode(plaintext); - bytes = Convert.FromBase64String(plaintext); - if (plaintext == "") + //} + try { - if (AppParams.isSysadmin) { ribbonCBAnsicht.SelectedIndex = 1; } else { ribbonCBAnsicht.SelectedIndex = 0; } - return; - } - //currentview = plaintext; + this.sfDataGrid1.TableControl.ScrollRows.ScrollInView(this.sfDataGrid1.TableControl.ResolveToRowIndex(0)); + this.sfDataGrid1.TableControl.UpdateScrollBars(); + string base64string = dataRow["gridsettings"].ToString(); + + byte[] bytes = Convert.FromBase64String(base64string); + string plaintext = Strings.Base64Decode(base64string); + string tagesdatum = DateTime.Now.ToString("yyyy-MM-ddT00:00:00"); + //tagesdatum = "2024-11-29T00:00:00"; + plaintext = plaintext.Replace("@today@", tagesdatum); + plaintext = Strings.Base64Encode(plaintext); + bytes = Convert.FromBase64String(plaintext); + if (plaintext == "") + { + if (AppParams.isSysadmin) { ribbonCBAnsicht.SelectedIndex = 1; } else { ribbonCBAnsicht.SelectedIndex = 0; } + return; + } - currentview = dataRow; - using (MemoryStream ms = new MemoryStream(bytes)) - { - this.sfDataGrid1.Deserialize(ms); + currentview = dataRow; - } + using (MemoryStream ms = new MemoryStream(bytes)) + { + this.sfDataGrid1.Deserialize(ms); + + } - sfDataGrid1.ShowToolTip = true; - //sfDataGrid1.FilterRowPosition = RowPosition.Top; + sfDataGrid1.ShowToolTip = true; + sfDataGrid1.FilterRowPosition = RowPosition.Top; + - tsrbvorschau.SelectedIndex = Convert.ToInt32(dataRow["Preview"]); - RibbonButtonAttributeEinAusblenden.Checked = Convert.ToInt32(dataRow["Attributes"]) == 1; - if (tsrbvorschau.SelectedIndex != 0 && Convert.ToInt32(dataRow["SplitterDistance"]) != 0) - { - this.splitContainer1.SplitterDistance = Convert.ToInt32(dataRow["SplitterDistance"]); - this.docPreview1.set_zoom(); - } - else - { - // docPreview1.clear_viewer(); - } - show_hide_attribute(); + tsrbvorschau.SelectedIndex = Convert.ToInt32(dataRow["Preview"]); + RibbonButtonAttributeEinAusblenden.Checked = Convert.ToInt32(dataRow["Attributes"]) == 1; + Logging.Logging.Debug("Vorschau selectedind", "", ""); - try - { - this.sfDataGrid1.SelectedItem = this.sfDataGrid1.View.Records[0]; - sfDataGrid1.SelectedIndex = 0; + if (tsrbvorschau.SelectedIndex != 0 && Convert.ToInt32(dataRow["SplitterDistance"]) != 0) + { + this.splitContainer1.SplitterDistance = Convert.ToInt32(dataRow["SplitterDistance"]); + this.docPreview1.set_zoom(); + } + else + { + // docPreview1.clear_viewer(); + } - } - catch - { - this.selected_dokumentid = ""; - } + show_hide_attribute(); - System.Windows.Forms.Application.DoEvents(); + try + { + this.sfDataGrid1.SelectedItem = this.sfDataGrid1.View.Records[0]; + sfDataGrid1.SelectedIndex = 0; + } + catch + { + this.selected_dokumentid = ""; + } + System.Windows.Forms.Application.DoEvents(); + //if (clist.Count > 0) { + // foreach (string s in clist) + // { + // sfDataGrid1.GroupColumnDescriptions.Add(new GroupColumnDescription() { ColumnName = s }); + // } + //} + } + catch { } } public static string Decode(string text) @@ -2207,7 +2267,7 @@ namespace OnDoc.UICintrols case "prüfung_rechts": if (e.DisplayText.Contains("Abgelehnt")) { - Syncfusion.Data.RecordEntry record = sfDataGrid1.View.GetRecordAt(e.RowIndex-1); + Syncfusion.Data.RecordEntry record = sfDataGrid1.View.GetRecordAt(e.RowIndex - 1); var a = record.Data; var b = a as DataRowView; string x = b["dokumentid"].ToString(); @@ -2219,10 +2279,10 @@ namespace OnDoc.UICintrols t.Text = db.dsdaten.Tables[0].Rows[0]["mutiert_am"].ToString() + //Environment.NewLine + Environment.NewLine + db.dsdaten.Tables[0].Rows[0]["betreff"].ToString() + Environment.NewLine + Environment.NewLine + db.dsdaten.Tables[0].Rows[0]["Notizgrund"].ToString(); - System.Drawing.Font tf = new System.Drawing.Font(t.Style.Font.FontFamily, 10,FontStyle.Bold); - + System.Drawing.Font tf = new System.Drawing.Font(t.Style.Font.FontFamily, 10, FontStyle.Bold); + t.Style.TextAlignment = ContentAlignment.MiddleLeft; - t.Style.BackColor = Color.FromArgb(255,102,0); + t.Style.BackColor = Color.FromArgb(255, 102, 0); t.Style.Font = tf; e.ToolTipInfo.Items.Add(t); db = null; @@ -2266,7 +2326,7 @@ namespace OnDoc.UICintrols } //System.Drawing.Point p = new System.Drawing.Point(Location.X, Location.Y); - + //var rowColIndex = sfDataGrid1.TableControl.PointToCellRowColumnIndex(p); //var mouseDownRecordIndex = this.sfDataGrid1.TableControl.ResolveToRecordIndex(rowColIndex.RowIndex); //if (!(mouseDownRecordIndex < 0)) @@ -2344,7 +2404,12 @@ namespace OnDoc.UICintrols historyToolStripMenuItem.Enabled = true; this.sfDataGrid1.SelectedItem = this.sfDataGrid1.View.Records[0]; - sfDataGrid1.SelectedIndex = 0; + //gaga + try + { + sfDataGrid1.SelectedIndex = 0; + } + catch { } var record = sfDataGrid1.View.Records.GetItemAt(sfDataGrid1.SelectedIndex); // var changed = DrugGrid.View.GetPropertyAccessProvider().SetValue(record, "GPackSize", "Hello"); // returns true, suggesting @@ -2625,7 +2690,7 @@ namespace OnDoc.UICintrols string documentid = datarow["dokumentid"].ToString(); string aktion = datarow["aktion"].ToString(); if (aktion != "Geprüft/Unterzeichnen") { error = 1; } - // dokument_bearbeiten(documentid, false); + // dokument_bearbeiten(documentid, false); } if (error > 0) { @@ -2641,8 +2706,8 @@ namespace OnDoc.UICintrols { var datarow = record as DataRowView; string documentid = datarow["dokumentid"].ToString(); - DOCGEN.DocGen dg = new DocGen(AppParams.connectionstring,AppParams.RESTURI,AppParams.apikey); - + DOCGEN.DocGen dg = new DocGen(AppParams.connectionstring, AppParams.RESTURI, AppParams.apikey); + if (dg.signdoc(selected_dokumentid, AppParams.tempdir)) { DB db = new DB(AppParams.connectionstring); diff --git a/Client/UIControls/DokList.resx b/Client/UIControls/DokList.resx index ce35584f..f2916b69 100644 --- a/Client/UIControls/DokList.resx +++ b/Client/UIControls/DokList.resx @@ -190,7 +190,7 @@ iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8 - YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAAAIFSURBVDhPpZLtS1NhGMbPPxJmmlYSgqHiKzGU1EDxg4iK + YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAIFSURBVDhPpZLtS1NhGMbPPxJmmlYSgqHiKzGU1EDxg4iK YKyG2WBogqMYJQOtCEVRFBGdTBCJfRnkS4VaaWNT5sqx1BUxRXxDHYxAJLvkusEeBaPAB+5z4Jzn+t3X /aLhnEfjo8m+dCoa+7/C3O2Hqe0zDC+8KG+cRZHZhdzaaWTVTCLDMIY0vfM04Nfh77/G/sEhwpEDbO3t I7TxE8urEVy99fT/AL5gWDLrTB/hnF4XsW0khCu5ln8DmJliT2AXrcNBsU1gj/MH4nMeKwBrPktM28xM @@ -205,7 +205,7 @@ iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8 - YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAAAIFSURBVDhPpZLtS1NhGMbPPxJmmlYSgqHiKzGU1EDxg4iK + YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAIFSURBVDhPpZLtS1NhGMbPPxJmmlYSgqHiKzGU1EDxg4iK YKyG2WBogqMYJQOtCEVRFBGdTBCJfRnkS4VaaWNT5sqx1BUxRXxDHYxAJLvkusEeBaPAB+5z4Jzn+t3X /aLhnEfjo8m+dCoa+7/C3O2Hqe0zDC+8KG+cRZHZhdzaaWTVTCLDMIY0vfM04Nfh77/G/sEhwpEDbO3t I7TxE8urEVy99fT/AL5gWDLrTB/hnF4XsW0khCu5ln8DmJliT2AXrcNBsU1gj/MH4nMeKwBrPktM28xM @@ -220,7 +220,7 @@ iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8 - YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAAAIFSURBVDhPpZLtS1NhGMbPPxJmmlYSgqHiKzGU1EDxg4iK + YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAIFSURBVDhPpZLtS1NhGMbPPxJmmlYSgqHiKzGU1EDxg4iK YKyG2WBogqMYJQOtCEVRFBGdTBCJfRnkS4VaaWNT5sqx1BUxRXxDHYxAJLvkusEeBaPAB+5z4Jzn+t3X /aLhnEfjo8m+dCoa+7/C3O2Hqe0zDC+8KG+cRZHZhdzaaWTVTCLDMIY0vfM04Nfh77/G/sEhwpEDbO3t I7TxE8urEVy99fT/AL5gWDLrTB/hnF4XsW0khCu5ln8DmJliT2AXrcNBsU1gj/MH4nMeKwBrPktM28xM diff --git a/Client/UIControls/Serienbrief.cs b/Client/UIControls/Serienbrief.cs index aebeb309..3e1d2696 100644 --- a/Client/UIControls/Serienbrief.cs +++ b/Client/UIControls/Serienbrief.cs @@ -2085,6 +2085,7 @@ namespace OnDoc.UIControls int blcount = 0; foreach (DataRowView rowView in dv) { + System.Data.DataRow dr = rowView.Row; if (dr["blkunde"].ToString()=="1") { blcount++; } else { normalcount++; } } @@ -2110,7 +2111,6 @@ namespace OnDoc.UIControls System.Data.DataRow dr = rowView.Row; if (dr["blkunde"].ToString() != "1") { - db.Get_Tabledata("Select dbo.BinaryToBase64(dokument) from edex_sb_serienbrief_dokument where dokumentid='" + dr["Dokumentid"].ToString() + "'", false, true); var stream = new MemoryStream(Convert.FromBase64String(db.dsdaten.Tables[0].Rows[0][0].ToString())); if (stream.Length > 0) diff --git a/Client/Versandstrasse/Versandstrasse.Designer.cs b/Client/Versandstrasse/Versandstrasse.Designer.cs index 3e4cd8a7..8cb84cf8 100644 --- a/Client/Versandstrasse/Versandstrasse.Designer.cs +++ b/Client/Versandstrasse/Versandstrasse.Designer.cs @@ -28,21 +28,25 @@ /// private void InitializeComponent() { + Syncfusion.Windows.Forms.Tools.TreeNodeAdvStyleInfo treeNodeAdvStyleInfo3 = new Syncfusion.Windows.Forms.Tools.TreeNodeAdvStyleInfo(); Syncfusion.Windows.Forms.Tools.TreeNodeAdvStyleInfo treeNodeAdvStyleInfo1 = new Syncfusion.Windows.Forms.Tools.TreeNodeAdvStyleInfo(); - Syncfusion.Windows.Forms.PdfViewer.MessageBoxSettings messageBoxSettings1 = new Syncfusion.Windows.Forms.PdfViewer.MessageBoxSettings(); - Syncfusion.Windows.PdfViewer.PdfViewerPrinterSettings pdfViewerPrinterSettings1 = new Syncfusion.Windows.PdfViewer.PdfViewerPrinterSettings(); + Syncfusion.Windows.Forms.PdfViewer.MessageBoxSettings messageBoxSettings2 = new Syncfusion.Windows.Forms.PdfViewer.MessageBoxSettings(); + Syncfusion.Windows.PdfViewer.PdfViewerPrinterSettings pdfViewerPrinterSettings2 = new Syncfusion.Windows.PdfViewer.PdfViewerPrinterSettings(); System.ComponentModel.ComponentResourceManager resources = new System.ComponentModel.ComponentResourceManager(typeof(Versandstrasse)); - Syncfusion.Windows.Forms.PdfViewer.TextSearchSettings textSearchSettings1 = new Syncfusion.Windows.Forms.PdfViewer.TextSearchSettings(); + Syncfusion.Windows.Forms.PdfViewer.TextSearchSettings textSearchSettings2 = new Syncfusion.Windows.Forms.PdfViewer.TextSearchSettings(); this.treeViewAdv1 = new Syncfusion.Windows.Forms.Tools.TreeViewAdv(); this.toolStrip1 = new System.Windows.Forms.ToolStrip(); this.tsbtnDruckPaketNew = new System.Windows.Forms.ToolStripButton(); this.tsbtnVersenden = new System.Windows.Forms.ToolStripButton(); + this.tscheckboxpreview = new Syncfusion.Windows.Forms.Tools.ToolStripCheckBox(); this.GrpPaketDetails = new System.Windows.Forms.GroupBox(); + this.btnPrepare = new System.Windows.Forms.Button(); this.groupBox3 = new System.Windows.Forms.GroupBox(); + this.treeViewAdvAdresse = new Syncfusion.Windows.Forms.Tools.TreeViewAdv(); this.label1 = new System.Windows.Forms.Label(); - this.lbgasadresse = new System.Windows.Forms.ListBox(); this.chkGAS = new System.Windows.Forms.CheckBox(); this.groupBox1 = new System.Windows.Forms.GroupBox(); + this.radioButton3 = new System.Windows.Forms.RadioButton(); this.radioButton2 = new System.Windows.Forms.RadioButton(); this.rbversandoption3 = new System.Windows.Forms.RadioButton(); this.radioButton1 = new System.Windows.Forms.RadioButton(); @@ -53,17 +57,23 @@ this.panel1 = new System.Windows.Forms.Panel(); this.panel2 = new System.Windows.Forms.Panel(); this.panel3 = new System.Windows.Forms.Panel(); - this.radioButton3 = new System.Windows.Forms.RadioButton(); - this.tscheckboxpreview = new Syncfusion.Windows.Forms.Tools.ToolStripCheckBox(); - this.btnSend = new System.Windows.Forms.Button(); + this.panelPrepare = new System.Windows.Forms.Panel(); + this.label4 = new System.Windows.Forms.Label(); + this.btnSendFinal = new System.Windows.Forms.Button(); + this.panelVerify = new System.Windows.Forms.Panel(); + this.label2 = new System.Windows.Forms.Label(); + this.label3 = new System.Windows.Forms.Label(); ((System.ComponentModel.ISupportInitialize)(this.treeViewAdv1)).BeginInit(); this.toolStrip1.SuspendLayout(); this.GrpPaketDetails.SuspendLayout(); this.groupBox3.SuspendLayout(); + ((System.ComponentModel.ISupportInitialize)(this.treeViewAdvAdresse)).BeginInit(); this.groupBox1.SuspendLayout(); this.panel1.SuspendLayout(); this.panel2.SuspendLayout(); this.panel3.SuspendLayout(); + this.panelPrepare.SuspendLayout(); + this.panelVerify.SuspendLayout(); this.SuspendLayout(); // // treeViewAdv1 @@ -71,16 +81,16 @@ this.treeViewAdv1.AllowDrop = true; this.treeViewAdv1.BackColor = System.Drawing.Color.White; this.treeViewAdv1.BackgroundColor = new Syncfusion.Drawing.BrushInfo(System.Drawing.Color.FromArgb(((int)(((byte)(255)))), ((int)(((byte)(255)))), ((int)(((byte)(255)))))); - treeNodeAdvStyleInfo1.CheckBoxTickThickness = 1; - treeNodeAdvStyleInfo1.CheckColor = System.Drawing.Color.FromArgb(((int)(((byte)(109)))), ((int)(((byte)(109)))), ((int)(((byte)(109))))); - treeNodeAdvStyleInfo1.EnsureDefaultOptionedChild = true; - treeNodeAdvStyleInfo1.Font = new System.Drawing.Font("Tahoma", 9.75F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(0))); - treeNodeAdvStyleInfo1.IntermediateCheckColor = System.Drawing.Color.FromArgb(((int)(((byte)(109)))), ((int)(((byte)(109)))), ((int)(((byte)(109))))); - treeNodeAdvStyleInfo1.OptionButtonColor = System.Drawing.Color.FromArgb(((int)(((byte)(109)))), ((int)(((byte)(109)))), ((int)(((byte)(109))))); - treeNodeAdvStyleInfo1.SelectedOptionButtonColor = System.Drawing.Color.FromArgb(((int)(((byte)(210)))), ((int)(((byte)(210)))), ((int)(((byte)(210))))); - treeNodeAdvStyleInfo1.TextColor = System.Drawing.Color.FromArgb(((int)(((byte)(43)))), ((int)(((byte)(43)))), ((int)(((byte)(43))))); + treeNodeAdvStyleInfo3.CheckBoxTickThickness = 1; + treeNodeAdvStyleInfo3.CheckColor = System.Drawing.Color.FromArgb(((int)(((byte)(109)))), ((int)(((byte)(109)))), ((int)(((byte)(109))))); + treeNodeAdvStyleInfo3.EnsureDefaultOptionedChild = true; + treeNodeAdvStyleInfo3.Font = new System.Drawing.Font("Tahoma", 9.75F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(0))); + treeNodeAdvStyleInfo3.IntermediateCheckColor = System.Drawing.Color.FromArgb(((int)(((byte)(109)))), ((int)(((byte)(109)))), ((int)(((byte)(109))))); + treeNodeAdvStyleInfo3.OptionButtonColor = System.Drawing.Color.FromArgb(((int)(((byte)(109)))), ((int)(((byte)(109)))), ((int)(((byte)(109))))); + treeNodeAdvStyleInfo3.SelectedOptionButtonColor = System.Drawing.Color.FromArgb(((int)(((byte)(210)))), ((int)(((byte)(210)))), ((int)(((byte)(210))))); + treeNodeAdvStyleInfo3.TextColor = System.Drawing.Color.FromArgb(((int)(((byte)(43)))), ((int)(((byte)(43)))), ((int)(((byte)(43))))); this.treeViewAdv1.BaseStylePairs.AddRange(new Syncfusion.Windows.Forms.Tools.StyleNamePair[] { - new Syncfusion.Windows.Forms.Tools.StyleNamePair("Standard", treeNodeAdvStyleInfo1)}); + new Syncfusion.Windows.Forms.Tools.StyleNamePair("Standard", treeNodeAdvStyleInfo3)}); this.treeViewAdv1.BeforeTouchSize = new System.Drawing.Size(438, 502); this.treeViewAdv1.Border3DStyle = System.Windows.Forms.Border3DStyle.Flat; this.treeViewAdv1.BorderStyle = System.Windows.Forms.BorderStyle.FixedSingle; @@ -170,9 +180,16 @@ this.tsbtnVersenden.Size = new System.Drawing.Size(244, 34); this.tsbtnVersenden.Text = "Dokumente an Versandstrasse übergeben"; // + // tscheckboxpreview + // + this.tscheckboxpreview.Name = "tscheckboxpreview"; + this.tscheckboxpreview.Size = new System.Drawing.Size(205, 34); + this.tscheckboxpreview.Text = "Vorschau aufbereitete Dokumente"; + // // GrpPaketDetails // - this.GrpPaketDetails.Controls.Add(this.btnSend); + this.GrpPaketDetails.Controls.Add(this.panelVerify); + this.GrpPaketDetails.Controls.Add(this.btnPrepare); this.GrpPaketDetails.Controls.Add(this.groupBox3); this.GrpPaketDetails.Controls.Add(this.groupBox1); this.GrpPaketDetails.Controls.Add(this.button1); @@ -184,49 +201,90 @@ this.GrpPaketDetails.TabStop = false; this.GrpPaketDetails.Text = "Details zum Druckpaket"; // + // btnPrepare + // + this.btnPrepare.Location = new System.Drawing.Point(325, 337); + this.btnPrepare.Name = "btnPrepare"; + this.btnPrepare.Size = new System.Drawing.Size(112, 23); + this.btnPrepare.TabIndex = 4; + this.btnPrepare.Text = "Prüfen"; + this.btnPrepare.UseVisualStyleBackColor = true; + this.btnPrepare.Click += new System.EventHandler(this.btnSend_Click); + // // groupBox3 // + this.groupBox3.Controls.Add(this.treeViewAdvAdresse); this.groupBox3.Controls.Add(this.label1); - this.groupBox3.Controls.Add(this.lbgasadresse); this.groupBox3.Controls.Add(this.chkGAS); this.groupBox3.Dock = System.Windows.Forms.DockStyle.Top; - this.groupBox3.Location = new System.Drawing.Point(3, 130); + this.groupBox3.Location = new System.Drawing.Point(3, 77); this.groupBox3.Name = "groupBox3"; - this.groupBox3.Size = new System.Drawing.Size(447, 192); + this.groupBox3.Size = new System.Drawing.Size(447, 254); this.groupBox3.TabIndex = 2; this.groupBox3.TabStop = false; this.groupBox3.Text = "Rückantwort"; // + // treeViewAdvAdresse + // + this.treeViewAdvAdresse.BackgroundColor = new Syncfusion.Drawing.BrushInfo(System.Drawing.SystemColors.Window); + treeNodeAdvStyleInfo1.CheckBoxTickThickness = 1; + treeNodeAdvStyleInfo1.CheckColor = System.Drawing.Color.FromArgb(((int)(((byte)(109)))), ((int)(((byte)(109)))), ((int)(((byte)(109))))); + treeNodeAdvStyleInfo1.EnsureDefaultOptionedChild = true; + treeNodeAdvStyleInfo1.IntermediateCheckColor = System.Drawing.Color.FromArgb(((int)(((byte)(109)))), ((int)(((byte)(109)))), ((int)(((byte)(109))))); + treeNodeAdvStyleInfo1.OptionButtonColor = System.Drawing.Color.FromArgb(((int)(((byte)(109)))), ((int)(((byte)(109)))), ((int)(((byte)(109))))); + treeNodeAdvStyleInfo1.SelectedOptionButtonColor = System.Drawing.Color.FromArgb(((int)(((byte)(210)))), ((int)(((byte)(210)))), ((int)(((byte)(210))))); + treeNodeAdvStyleInfo1.TextColor = System.Drawing.Color.Black; + this.treeViewAdvAdresse.BaseStylePairs.AddRange(new Syncfusion.Windows.Forms.Tools.StyleNamePair[] { + new Syncfusion.Windows.Forms.Tools.StyleNamePair("Standard", treeNodeAdvStyleInfo1)}); + this.treeViewAdvAdresse.BeforeTouchSize = new System.Drawing.Size(417, 193); + // + // + // + this.treeViewAdvAdresse.HelpTextControl.BaseThemeName = null; + this.treeViewAdvAdresse.HelpTextControl.Location = new System.Drawing.Point(0, 0); + this.treeViewAdvAdresse.HelpTextControl.Name = ""; + this.treeViewAdvAdresse.HelpTextControl.Size = new System.Drawing.Size(392, 112); + this.treeViewAdvAdresse.HelpTextControl.TabIndex = 0; + this.treeViewAdvAdresse.HelpTextControl.Visible = true; + this.treeViewAdvAdresse.InactiveSelectedNodeForeColor = System.Drawing.SystemColors.ControlText; + this.treeViewAdvAdresse.Location = new System.Drawing.Point(17, 55); + this.treeViewAdvAdresse.MetroColor = System.Drawing.Color.FromArgb(((int)(((byte)(22)))), ((int)(((byte)(165)))), ((int)(((byte)(220))))); + this.treeViewAdvAdresse.Name = "treeViewAdvAdresse"; + this.treeViewAdvAdresse.SelectedNodeForeColor = System.Drawing.SystemColors.HighlightText; + this.treeViewAdvAdresse.Size = new System.Drawing.Size(417, 193); + this.treeViewAdvAdresse.TabIndex = 3; + this.treeViewAdvAdresse.Text = "treeViewAdv2"; + this.treeViewAdvAdresse.ThemeStyle.TreeNodeAdvStyle.CheckBoxTickThickness = 0; + this.treeViewAdvAdresse.ThemeStyle.TreeNodeAdvStyle.EnsureDefaultOptionedChild = true; + // + // + // + this.treeViewAdvAdresse.ToolTipControl.BaseThemeName = null; + this.treeViewAdvAdresse.ToolTipControl.Location = new System.Drawing.Point(0, 0); + this.treeViewAdvAdresse.ToolTipControl.Name = ""; + this.treeViewAdvAdresse.ToolTipControl.Size = new System.Drawing.Size(392, 112); + this.treeViewAdvAdresse.ToolTipControl.TabIndex = 0; + this.treeViewAdvAdresse.ToolTipControl.Visible = true; + // // label1 // this.label1.AutoSize = true; - this.label1.Location = new System.Drawing.Point(24, 63); + this.label1.Location = new System.Drawing.Point(14, 39); this.label1.Name = "label1"; this.label1.Size = new System.Drawing.Size(105, 13); this.label1.TabIndex = 2; this.label1.Text = "Rückantwortadresse"; // - // lbgasadresse - // - this.lbgasadresse.FormattingEnabled = true; - this.lbgasadresse.Items.AddRange(new object[] { - "Adresse 1", - "Adresse 2", - "Adresse 3"}); - this.lbgasadresse.Location = new System.Drawing.Point(24, 82); - this.lbgasadresse.Name = "lbgasadresse"; - this.lbgasadresse.Size = new System.Drawing.Size(332, 95); - this.lbgasadresse.TabIndex = 1; - // // chkGAS // this.chkGAS.AutoSize = true; - this.chkGAS.Location = new System.Drawing.Point(24, 34); + this.chkGAS.Location = new System.Drawing.Point(17, 19); this.chkGAS.Name = "chkGAS"; this.chkGAS.Size = new System.Drawing.Size(112, 17); this.chkGAS.TabIndex = 0; this.chkGAS.Text = "GAS-Rückantwort"; this.chkGAS.UseVisualStyleBackColor = true; + this.chkGAS.CheckedChanged += new System.EventHandler(this.chkGAS_CheckedChanged); // // groupBox1 // @@ -239,15 +297,27 @@ this.groupBox1.Dock = System.Windows.Forms.DockStyle.Top; this.groupBox1.Location = new System.Drawing.Point(3, 16); this.groupBox1.Name = "groupBox1"; - this.groupBox1.Size = new System.Drawing.Size(447, 114); + this.groupBox1.Size = new System.Drawing.Size(447, 61); this.groupBox1.TabIndex = 0; this.groupBox1.TabStop = false; this.groupBox1.Text = "Versandoptionen"; // + // radioButton3 + // + this.radioButton3.AutoSize = true; + this.radioButton3.Checked = true; + this.radioButton3.Location = new System.Drawing.Point(86, 19); + this.radioButton3.Name = "radioButton3"; + this.radioButton3.Size = new System.Drawing.Size(62, 17); + this.radioButton3.TabIndex = 5; + this.radioButton3.TabStop = true; + this.radioButton3.Text = "B1-Post"; + this.radioButton3.UseVisualStyleBackColor = true; + // // radioButton2 // this.radioButton2.AutoSize = true; - this.radioButton2.Location = new System.Drawing.Point(332, 74); + this.radioButton2.Location = new System.Drawing.Point(154, 19); this.radioButton2.Name = "radioButton2"; this.radioButton2.Size = new System.Drawing.Size(62, 17); this.radioButton2.TabIndex = 4; @@ -257,17 +327,18 @@ // rbversandoption3 // this.rbversandoption3.AutoSize = true; - this.rbversandoption3.Location = new System.Drawing.Point(24, 75); + this.rbversandoption3.Location = new System.Drawing.Point(222, 19); this.rbversandoption3.Name = "rbversandoption3"; this.rbversandoption3.Size = new System.Drawing.Size(207, 17); this.rbversandoption3.TabIndex = 2; this.rbversandoption3.Text = "Hauptadresse, Postversand erzwingen"; this.rbversandoption3.UseVisualStyleBackColor = true; + this.rbversandoption3.Visible = false; // // radioButton1 // this.radioButton1.AutoSize = true; - this.radioButton1.Location = new System.Drawing.Point(332, 29); + this.radioButton1.Location = new System.Drawing.Point(24, 19); this.radioButton1.Name = "radioButton1"; this.radioButton1.Size = new System.Drawing.Size(56, 17); this.radioButton1.TabIndex = 3; @@ -277,22 +348,24 @@ // rbversandoption2 // this.rbversandoption2.AutoSize = true; - this.rbversandoption2.Location = new System.Drawing.Point(24, 52); + this.rbversandoption2.Location = new System.Drawing.Point(222, 19); this.rbversandoption2.Name = "rbversandoption2"; this.rbversandoption2.Size = new System.Drawing.Size(197, 17); this.rbversandoption2.TabIndex = 1; this.rbversandoption2.Text = "Hauptadresse, E-Banking erzwingen"; this.rbversandoption2.UseVisualStyleBackColor = true; + this.rbversandoption2.Visible = false; // // rbversandoption1 // this.rbversandoption1.AutoSize = true; - this.rbversandoption1.Location = new System.Drawing.Point(24, 29); + this.rbversandoption1.Location = new System.Drawing.Point(222, 19); this.rbversandoption1.Name = "rbversandoption1"; this.rbversandoption1.Size = new System.Drawing.Size(166, 17); this.rbversandoption1.TabIndex = 0; this.rbversandoption1.Text = "Hauptadresse und Versandart"; this.rbversandoption1.UseVisualStyleBackColor = true; + this.rbversandoption1.Visible = false; // // button1 // @@ -315,17 +388,17 @@ this.pdfViewerControl1.IsTextSearchEnabled = true; this.pdfViewerControl1.IsTextSelectionEnabled = true; this.pdfViewerControl1.Location = new System.Drawing.Point(0, 0); - messageBoxSettings1.EnableNotification = true; - this.pdfViewerControl1.MessageBoxSettings = messageBoxSettings1; + messageBoxSettings2.EnableNotification = true; + this.pdfViewerControl1.MessageBoxSettings = messageBoxSettings2; this.pdfViewerControl1.MinimumZoomPercentage = 50; this.pdfViewerControl1.Name = "pdfViewerControl1"; this.pdfViewerControl1.PageBorderThickness = 1; - pdfViewerPrinterSettings1.Copies = 1; - pdfViewerPrinterSettings1.PageOrientation = Syncfusion.Windows.PdfViewer.PdfViewerPrintOrientation.Auto; - pdfViewerPrinterSettings1.PageSize = Syncfusion.Windows.PdfViewer.PdfViewerPrintSize.ActualSize; - pdfViewerPrinterSettings1.PrintLocation = ((System.Drawing.PointF)(resources.GetObject("pdfViewerPrinterSettings1.PrintLocation"))); - pdfViewerPrinterSettings1.ShowPrintStatusDialog = true; - this.pdfViewerControl1.PrinterSettings = pdfViewerPrinterSettings1; + pdfViewerPrinterSettings2.Copies = 1; + pdfViewerPrinterSettings2.PageOrientation = Syncfusion.Windows.PdfViewer.PdfViewerPrintOrientation.Auto; + pdfViewerPrinterSettings2.PageSize = Syncfusion.Windows.PdfViewer.PdfViewerPrintSize.ActualSize; + pdfViewerPrinterSettings2.PrintLocation = ((System.Drawing.PointF)(resources.GetObject("pdfViewerPrinterSettings2.PrintLocation"))); + pdfViewerPrinterSettings2.ShowPrintStatusDialog = true; + this.pdfViewerControl1.PrinterSettings = pdfViewerPrinterSettings2; this.pdfViewerControl1.ReferencePath = null; this.pdfViewerControl1.ScrollDisplacementValue = 0; this.pdfViewerControl1.ShowHorizontalScrollBar = true; @@ -335,10 +408,11 @@ this.pdfViewerControl1.SpaceBetweenPages = 8; this.pdfViewerControl1.TabIndex = 10; this.pdfViewerControl1.Text = "pdfViewerControl1"; - textSearchSettings1.CurrentInstanceColor = System.Drawing.Color.FromArgb(((int)(((byte)(127)))), ((int)(((byte)(255)))), ((int)(((byte)(171)))), ((int)(((byte)(64))))); - textSearchSettings1.HighlightAllInstance = true; - textSearchSettings1.OtherInstanceColor = System.Drawing.Color.FromArgb(((int)(((byte)(127)))), ((int)(((byte)(254)))), ((int)(((byte)(255)))), ((int)(((byte)(0))))); - this.pdfViewerControl1.TextSearchSettings = textSearchSettings1; + textSearchSettings2.CurrentInstanceColor = System.Drawing.Color.FromArgb(((int)(((byte)(127)))), ((int)(((byte)(255)))), ((int)(((byte)(171)))), ((int)(((byte)(64))))); + textSearchSettings2.HighlightAllInstance = true; + textSearchSettings2.OtherInstanceColor = System.Drawing.Color.FromArgb(((int)(((byte)(127)))), ((int)(((byte)(254)))), ((int)(((byte)(255)))), ((int)(((byte)(0))))); + this.pdfViewerControl1.TextSearchSettings = textSearchSettings2; + this.pdfViewerControl1.ThemeName = "Default"; this.pdfViewerControl1.VerticalScrollOffset = 0; this.pdfViewerControl1.VisualStyle = Syncfusion.Windows.Forms.PdfViewer.VisualStyle.Default; this.pdfViewerControl1.ZoomMode = Syncfusion.Windows.Forms.PdfViewer.ZoomMode.Default; @@ -370,38 +444,73 @@ this.panel3.Size = new System.Drawing.Size(660, 502); this.panel3.TabIndex = 13; // - // radioButton3 - // - this.radioButton3.AutoSize = true; - this.radioButton3.Checked = true; - this.radioButton3.Location = new System.Drawing.Point(332, 52); - this.radioButton3.Name = "radioButton3"; - this.radioButton3.Size = new System.Drawing.Size(62, 17); - this.radioButton3.TabIndex = 5; - this.radioButton3.Text = "B1-Post"; - this.radioButton3.UseVisualStyleBackColor = true; - // - // tscheckboxpreview - // - this.tscheckboxpreview.Name = "tscheckboxpreview"; - this.tscheckboxpreview.Size = new System.Drawing.Size(205, 34); - this.tscheckboxpreview.Text = "Vorschau aufbereitete Dokumente"; - // - // btnSend - // - this.btnSend.Location = new System.Drawing.Point(284, 337); - this.btnSend.Name = "btnSend"; - this.btnSend.Size = new System.Drawing.Size(75, 23); - this.btnSend.TabIndex = 4; - this.btnSend.Text = "Versenden"; - this.btnSend.UseVisualStyleBackColor = true; - this.btnSend.Click += new System.EventHandler(this.btnSend_Click); + // panelPrepare + // + this.panelPrepare.BackColor = System.Drawing.Color.Silver; + this.panelPrepare.Controls.Add(this.label4); + this.panelPrepare.Location = new System.Drawing.Point(360, 155); + this.panelPrepare.Name = "panelPrepare"; + this.panelPrepare.Size = new System.Drawing.Size(832, 94); + this.panelPrepare.TabIndex = 14; + this.panelPrepare.Visible = false; + // + // label4 + // + this.label4.AutoSize = true; + this.label4.Font = new System.Drawing.Font("Microsoft Sans Serif", 12F, System.Drawing.FontStyle.Bold, System.Drawing.GraphicsUnit.Point, ((byte)(0))); + this.label4.Location = new System.Drawing.Point(19, 34); + this.label4.Name = "label4"; + this.label4.Size = new System.Drawing.Size(437, 20); + this.label4.TabIndex = 0; + this.label4.Text = "Versand wird vorbereit - bitte einen Moment warten...."; + // + // btnSendFinal + // + this.btnSendFinal.BackColor = System.Drawing.Color.YellowGreen; + this.btnSendFinal.Font = new System.Drawing.Font("Microsoft Sans Serif", 8.25F, System.Drawing.FontStyle.Bold, System.Drawing.GraphicsUnit.Point, ((byte)(0))); + this.btnSendFinal.Location = new System.Drawing.Point(106, 62); + this.btnSendFinal.Name = "btnSendFinal"; + this.btnSendFinal.Size = new System.Drawing.Size(196, 35); + this.btnSendFinal.TabIndex = 5; + this.btnSendFinal.Text = " geprüft"; + this.btnSendFinal.UseVisualStyleBackColor = false; + this.btnSendFinal.Click += new System.EventHandler(this.btnSendFinal_Click); + // + // panelVerify + // + this.panelVerify.Controls.Add(this.label3); + this.panelVerify.Controls.Add(this.label2); + this.panelVerify.Controls.Add(this.btnSendFinal); + this.panelVerify.Location = new System.Drawing.Point(27, 386); + this.panelVerify.Name = "panelVerify"; + this.panelVerify.Size = new System.Drawing.Size(405, 100); + this.panelVerify.TabIndex = 6; + this.panelVerify.Visible = false; + // + // label2 + // + this.label2.AutoSize = true; + this.label2.Location = new System.Drawing.Point(4, 4); + this.label2.Name = "label2"; + this.label2.Size = new System.Drawing.Size(310, 13); + this.label2.TabIndex = 6; + this.label2.Text = "Das aufbereitete PDF prüfen. Sofern \"geprüft\" betätigt wird, wird"; + // + // label3 + // + this.label3.AutoSize = true; + this.label3.Location = new System.Drawing.Point(4, 17); + this.label3.Name = "label3"; + this.label3.Size = new System.Drawing.Size(141, 13); + this.label3.TabIndex = 7; + this.label3.Text = "der Druckaufgrag ausgelöst."; // // Versandstrasse // this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 13F); this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font; this.ClientSize = new System.Drawing.Size(1555, 543); + this.Controls.Add(this.panelPrepare); this.Controls.Add(this.panel3); this.Controls.Add(this.panel2); this.Controls.Add(this.panel1); @@ -419,11 +528,16 @@ this.GrpPaketDetails.ResumeLayout(false); this.groupBox3.ResumeLayout(false); this.groupBox3.PerformLayout(); + ((System.ComponentModel.ISupportInitialize)(this.treeViewAdvAdresse)).EndInit(); this.groupBox1.ResumeLayout(false); this.groupBox1.PerformLayout(); this.panel1.ResumeLayout(false); this.panel2.ResumeLayout(false); this.panel3.ResumeLayout(false); + this.panelPrepare.ResumeLayout(false); + this.panelPrepare.PerformLayout(); + this.panelVerify.ResumeLayout(false); + this.panelVerify.PerformLayout(); this.ResumeLayout(false); } @@ -440,7 +554,6 @@ private System.Windows.Forms.RadioButton rbversandoption1; private System.Windows.Forms.GroupBox groupBox3; private System.Windows.Forms.Label label1; - private System.Windows.Forms.ListBox lbgasadresse; private System.Windows.Forms.CheckBox chkGAS; private System.Windows.Forms.Button button1; private System.Windows.Forms.RadioButton radioButton2; @@ -451,6 +564,13 @@ private System.Windows.Forms.Panel panel3; private System.Windows.Forms.RadioButton radioButton3; private Syncfusion.Windows.Forms.Tools.ToolStripCheckBox tscheckboxpreview; - private System.Windows.Forms.Button btnSend; + private System.Windows.Forms.Button btnPrepare; + private Syncfusion.Windows.Forms.Tools.TreeViewAdv treeViewAdvAdresse; + private System.Windows.Forms.Panel panelPrepare; + private System.Windows.Forms.Label label4; + private System.Windows.Forms.Button btnSendFinal; + private System.Windows.Forms.Panel panelVerify; + private System.Windows.Forms.Label label3; + private System.Windows.Forms.Label label2; } } \ No newline at end of file diff --git a/Client/Versandstrasse/Versandstrasse.cs b/Client/Versandstrasse/Versandstrasse.cs index 512539db..48d93755 100644 --- a/Client/Versandstrasse/Versandstrasse.cs +++ b/Client/Versandstrasse/Versandstrasse.cs @@ -19,16 +19,18 @@ using Versandstrasse; using System.IO; using Syncfusion.Pdf; using Database; +using System.Net; +using Newtonsoft.Json; namespace OnDoc.Versandstrasse { public partial class Versandstrasse : SfForm { - private Versandpakete pakete = new Versandpakete(); + private List pakete = new List(); private TreeViewAdvDragHighlightTracker treeViewDragHighlightTracker = null; private TreeNodeAdv currentSourceNode; - - public Versandstrasse(Versandpakete pakete) + + public Versandstrasse(List pakete) { InitializeComponent(); this.treeViewAdv1.AutoScrolling = ScrollBars.Both; @@ -44,24 +46,43 @@ namespace OnDoc.Versandstrasse this.pakete = pakete; } + private void load_adressen() + { + DB db = new DB(AppParams.connectionstring); + db.Get_Tabledata("Select * from Antwortadresse order by bezeichnung", false, true); + foreach (System.Data.DataRow dr in db.dsdaten.Tables[0].Rows) + { + TreeNodeAdv node = new TreeNodeAdv(); + node.Text = dr["bezeichnung"].ToString(); + node.TagObject = dr; + treeViewAdvAdresse.Nodes.Add(node); + + } + treeViewAdvAdresse.Enabled = false; + treeViewAdvAdresse.SelectedNode = treeViewAdvAdresse.Nodes[0]; + } private void Versandstrasse_Load(object sender, EventArgs e) { + load_adressen(); Reload_Tree(); } private void Reload_Tree() { treeViewAdv1.Nodes.Clear(); TreeNodeAdv DruckJob; - for (int i = 0; i < pakete.paket.Count; i++) + DB db = new DB(AppParams.connectionstring); + for (int i = 0; i < pakete.Count; i++) { + db.Get_Tabledata("Select bkpar00 from partner where nrpar00=" + pakete[i].partnernr.ToString(), false, true); DruckJob = new TreeNodeAdv(); - DruckJob.Text = "Druckpaket " + pakete.paket[i].PaketNr; + DruckJob.Text = "Druckpaket " + pakete[i].PaketNr.ToString()+" - " + db.dsdaten.Tables[0].Rows[0][0].ToString(); DruckJob.Tag = "Druckpaket"; - DruckJob.TagObject = pakete.paket[i]; + DruckJob.TagObject = pakete[i]; treeViewAdv1.Nodes.Add(DruckJob); - PopulateDocs(pakete.paket[i], ref DruckJob); + PopulateDocs(pakete[i], ref DruckJob); } + db = null; treeViewAdv1.ExpandAll(); } @@ -241,10 +262,10 @@ namespace OnDoc.Versandstrasse break; } - if (paket.GAS.ToString() == "1"){ - chkGAS.Checked= true; - lbgasadresse.SelectedIndex = Convert.ToInt32(paket.GASAdresse.ToString()); - } else { chkGAS.Checked= false; } + //if (paket.GAS.ToString() == "1"){ + // chkGAS.Checked= true; + // lbgasadresse.SelectedIndex = Convert.ToInt32(paket.GASAdresse.ToString()); + //} else { chkGAS.Checked= false; } } else { if (tscheckboxpreview.Checked) @@ -266,7 +287,7 @@ namespace OnDoc.Versandstrasse if (rbversandoption3.Checked) { paket.Versandoption = "3"; } if (chkGAS.Checked) { paket.GAS = "1"; } else { paket.GAS = "0"; } - try { paket.GASAdresse = lbgasadresse.SelectedIndex.ToString(); } catch { paket.GASAdresse= "0"; } + //try { paket.GASAdresse = lbgasadresse.SelectedIndex.ToString(); } catch { paket.GASAdresse= "0"; } paket.verified = true; treeViewAdv1.SelectedNode.TagObject = paket; //pakete.paket.Add(paket); @@ -277,36 +298,50 @@ namespace OnDoc.Versandstrasse private void btnSend_Click(object sender, EventArgs e) { - Versandpaket paket = treeViewAdv1.SelectedNode.TagObject as Versandpaket; - foreach (Versanddokument vsdok in paket.Dokument) - { - clsVersandstrasse vs = new clsVersandstrasse(); - vsdok.dokument = vs.Prepare_PDF(vsdok.DokumentID.ToString(), AppParams.tempdir, AppParams.connectionstring); - //string dok = vs.Prepare_PDF(vsdok.DokumentID.ToString(), AppParams.tempdir, AppParams.connectionstring); - } - Stream[] streams = new Stream[paket.Dokument.Count]; - int i = 0; - foreach (Versanddokument vsdok in paket.Dokument) + panelPrepare.Visible = true; + Application.DoEvents(); + Cursor = Cursors.WaitCursor; + try { - var stream = new MemoryStream(Convert.FromBase64String(vsdok.dokument)); - streams[i] = stream; - i++; - } + Versandpaket paket = treeViewAdv1.SelectedNode.TagObject as Versandpaket; + foreach (Versanddokument vsdok in paket.Dokument) + { + clsVersandstrasse vs = new clsVersandstrasse(); + vsdok.dokument = vs.Prepare_PDF(vsdok.DokumentID.ToString(), AppParams.tempdir, AppParams.connectionstring); + //string dok = vs.Prepare_PDF(vsdok.DokumentID.ToString(), AppParams.tempdir, AppParams.connectionstring); + } + Stream[] streams = new Stream[paket.Dokument.Count]; + int i = 0; + foreach (Versanddokument vsdok in paket.Dokument) + { + var stream = new MemoryStream(Convert.FromBase64String(vsdok.dokument)); + streams[i] = stream; + i++; + } - string stapel = save_stapel(ref streams); - var finalestream = new MemoryStream(Convert.FromBase64String(stapel)); - this.pdfViewerControl1.Load(finalestream); + string stapel = save_stapel(ref streams); + var finalestream = new MemoryStream(Convert.FromBase64String(stapel)); + this.pdfViewerControl1.Load(finalestream); - for (int i1 = 0; i1 < streams.Length; i1++) - { - streams[i1].Close(); + for (int i1 = 0; i1 < streams.Length; i1++) + { + streams[i1].Close(); - streams[i1].Dispose(); - streams[i1] = null; + streams[i1].Dispose(); + streams[i1] = null; + } + streams = null; + treeViewAdv1.SelectedNode.TagObject = paket; + panelVerify.Visible = true; } - streams = null; + catch { } + panelPrepare.Visible = false; + Cursor = Cursors.Default; + Application.DoEvents(); + } + private string save_stapel(ref Stream[] streams) { try @@ -323,5 +358,88 @@ namespace OnDoc.Versandstrasse } catch { return ""; } } + + private void chkGAS_CheckedChanged(object sender, EventArgs e) + { + if (chkGAS.Checked) + { + treeViewAdvAdresse.Enabled= true; + } + else + { + treeViewAdvAdresse.Enabled = false; + } + } + + private void btnSendFinal_Click(object sender, EventArgs e) + { + panelVerify.Visible = false; + SendTo_Versandstrasse(); + + } + private void SendTo_Versandstrasse() + { + Versandpaket versandpaket = new Versandpaket(); + versandpaket = (Versandpaket)treeViewAdv1.SelectedNode.TagObject; + versandpaket.send_onbase_doc = true; + string jsonstring = JsonConvert.SerializeObject(versandpaket); + + + + string URL = AppParams.RESTURI + "api/Send_Versandstrasse"; + panelVerify.Visible = false; + + WebRequest request; + var data = Encoding.UTF8.GetBytes(jsonstring); + request = WebRequest.Create(URL); + request.ContentLength = data.Length; + request.ContentType = "application/json"; + request.Method = "POST"; + request.Headers["Authorization"] = "Bearer " + AppParams.apikey; + string response; + try + { + + using (Stream requestStream = request.GetRequestStream()) + { + requestStream.Write(data, 0, data.Length); + requestStream.Close(); + + using (Stream responseStream = request.GetResponse().GetResponseStream()) + { + using (var reader = new StreamReader(responseStream)) + { + response = reader.ReadToEnd(); + } + if (response.ToString().Contains("*archiviert")) + { + MessageBox.Show("Paket an Versandstrasse übergeben"); + } + //if (response.StatusCode == HttpStatusCode.OK) + //{ + // StreamReader reader = new StreamReader(response.GetResponseStream()); + // string responseContent = reader.ReadToEnd(); + // if (responseContent.Contains("Hinweismeldung:")) + // { + // MessageBox.Show("Das Paket wurde erfolgreich an die Versandstrasse übergeben:" + Environment.NewLine + responseContent); + // treeViewAdv1.SelectedNode.Remove(); + // return; + // } + // Logging.DocLog.Info("Dokumentpaket an Versandstrasse übergeben", "OnDoc", versandpaket.partnernr.ToString(), "", ""); + //} + //else + //{ + // MessageBox.Show("Das Paket konnte nicht an die Versandstrasse übergeben werden." + Environment.NewLine + "Fehler: " + response.StatusDescription); + // Logging.Logging.Error(URL + ": " + response.StatusCode.ToString() + " / " + response.StatusDescription, "Clinet - DokList GetDocument", ""); + //} + } + } + + + return; + } + catch { } + + } } } diff --git a/Client/Versandstrasse/Versandstrasse.resx b/Client/Versandstrasse/Versandstrasse.resx index fd03f4fd..9b223099 100644 --- a/Client/Versandstrasse/Versandstrasse.resx +++ b/Client/Versandstrasse/Versandstrasse.resx @@ -120,7 +120,7 @@ 17, 17 - + AAEAAAD/////AQAAAAAAAAAMAgAAAFFTeXN0ZW0uRHJhd2luZywgVmVyc2lvbj00LjAuMC4wLCBDdWx0 dXJlPW5ldXRyYWwsIFB1YmxpY0tleVRva2VuPWIwM2Y1ZjdmMTFkNTBhM2EFAQAAABVTeXN0ZW0uRHJh diff --git a/Client/bin/Debug/Model.dll b/Client/bin/Debug/Model.dll index e9b2b2dd..c53c96d0 100644 Binary files a/Client/bin/Debug/Model.dll and b/Client/bin/Debug/Model.dll differ diff --git a/Client/bin/Debug/Model.pdb b/Client/bin/Debug/Model.pdb index db579073..ae53cf1f 100644 Binary files a/Client/bin/Debug/Model.pdb and b/Client/bin/Debug/Model.pdb differ diff --git a/Client/bin/Debug/OnDoc.exe b/Client/bin/Debug/OnDoc.exe index 4f02fe08..99dd9ff6 100644 Binary files a/Client/bin/Debug/OnDoc.exe and b/Client/bin/Debug/OnDoc.exe differ diff --git a/Client/bin/Debug/OnDoc.pdb b/Client/bin/Debug/OnDoc.pdb index 826cbafd..7a355eb6 100644 Binary files a/Client/bin/Debug/OnDoc.pdb and b/Client/bin/Debug/OnDoc.pdb differ diff --git a/Client/bin/Debug/OnDocClient.zip b/Client/bin/Debug/OnDocClient.zip index 27f8ab22..77d66fb9 100644 Binary files a/Client/bin/Debug/OnDocClient.zip and b/Client/bin/Debug/OnDocClient.zip differ diff --git a/Client/bin/Debug/Versandstrasse.dll b/Client/bin/Debug/Versandstrasse.dll index 252d76ed..7054761e 100644 Binary files a/Client/bin/Debug/Versandstrasse.dll and b/Client/bin/Debug/Versandstrasse.dll differ diff --git a/Client/bin/Debug/Versandstrasse.pdb b/Client/bin/Debug/Versandstrasse.pdb index 2b064d22..bc8d29f6 100644 Binary files a/Client/bin/Debug/Versandstrasse.pdb and b/Client/bin/Debug/Versandstrasse.pdb differ diff --git a/Client/bin/Debug/de-DE/OnDoc.resources.dll b/Client/bin/Debug/de-DE/OnDoc.resources.dll index 2534970d..b5e0d385 100644 Binary files a/Client/bin/Debug/de-DE/OnDoc.resources.dll and b/Client/bin/Debug/de-DE/OnDoc.resources.dll differ diff --git a/Client/obj/Debug/Client.csproj.AssemblyReference.cache b/Client/obj/Debug/Client.csproj.AssemblyReference.cache index d70757c4..c3292170 100644 Binary files a/Client/obj/Debug/Client.csproj.AssemblyReference.cache and b/Client/obj/Debug/Client.csproj.AssemblyReference.cache differ diff --git a/Client/obj/Debug/DesignTimeResolveAssemblyReferences.cache b/Client/obj/Debug/DesignTimeResolveAssemblyReferences.cache index 8138952d..6d33de60 100644 Binary files a/Client/obj/Debug/DesignTimeResolveAssemblyReferences.cache and b/Client/obj/Debug/DesignTimeResolveAssemblyReferences.cache differ diff --git a/Client/obj/Debug/OnDoc.DocMgmt.DokTypSelect.resources b/Client/obj/Debug/OnDoc.DocMgmt.DokTypSelect.resources index 343f2f9c..bd7ee22f 100644 Binary files a/Client/obj/Debug/OnDoc.DocMgmt.DokTypSelect.resources and b/Client/obj/Debug/OnDoc.DocMgmt.DokTypSelect.resources differ diff --git a/Client/obj/Debug/OnDoc.UICintrols.DokList.resources b/Client/obj/Debug/OnDoc.UICintrols.DokList.resources index 7f64b695..89b7730c 100644 Binary files a/Client/obj/Debug/OnDoc.UICintrols.DokList.resources and b/Client/obj/Debug/OnDoc.UICintrols.DokList.resources differ diff --git a/Client/obj/Debug/OnDoc.Versandstrasse.Versandstrasse.resources b/Client/obj/Debug/OnDoc.Versandstrasse.Versandstrasse.resources index 59b33b14..0ea56df4 100644 Binary files a/Client/obj/Debug/OnDoc.Versandstrasse.Versandstrasse.resources and b/Client/obj/Debug/OnDoc.Versandstrasse.Versandstrasse.resources differ diff --git a/Client/obj/Debug/OnDoc.exe b/Client/obj/Debug/OnDoc.exe index 4f02fe08..99dd9ff6 100644 Binary files a/Client/obj/Debug/OnDoc.exe and b/Client/obj/Debug/OnDoc.exe differ diff --git a/Client/obj/Debug/OnDoc.pdb b/Client/obj/Debug/OnDoc.pdb index 826cbafd..7a355eb6 100644 Binary files a/Client/obj/Debug/OnDoc.pdb and b/Client/obj/Debug/OnDoc.pdb differ diff --git a/Client/obj/Debug/de-DE/OnDoc.resources.dll b/Client/obj/Debug/de-DE/OnDoc.resources.dll index 2534970d..b5e0d385 100644 Binary files a/Client/obj/Debug/de-DE/OnDoc.resources.dll and b/Client/obj/Debug/de-DE/OnDoc.resources.dll differ diff --git a/DOCGEN/bin/Debug/Model.dll b/DOCGEN/bin/Debug/Model.dll index e9b2b2dd..c53c96d0 100644 Binary files a/DOCGEN/bin/Debug/Model.dll and b/DOCGEN/bin/Debug/Model.dll differ diff --git a/DOCGEN/bin/Debug/Model.pdb b/DOCGEN/bin/Debug/Model.pdb index db579073..ae53cf1f 100644 Binary files a/DOCGEN/bin/Debug/Model.pdb and b/DOCGEN/bin/Debug/Model.pdb differ diff --git a/DOCGEN/obj/Debug/DocGen.csproj.AssemblyReference.cache b/DOCGEN/obj/Debug/DocGen.csproj.AssemblyReference.cache index fb91178a..2e1f680d 100644 Binary files a/DOCGEN/obj/Debug/DocGen.csproj.AssemblyReference.cache and b/DOCGEN/obj/Debug/DocGen.csproj.AssemblyReference.cache differ diff --git a/Database/bin/Debug/Model.dll b/Database/bin/Debug/Model.dll index e9b2b2dd..c53c96d0 100644 Binary files a/Database/bin/Debug/Model.dll and b/Database/bin/Debug/Model.dll differ diff --git a/Database/bin/Debug/Model.pdb b/Database/bin/Debug/Model.pdb index db579073..ae53cf1f 100644 Binary files a/Database/bin/Debug/Model.pdb and b/Database/bin/Debug/Model.pdb differ diff --git a/Database/obj/Debug/Database.csproj.AssemblyReference.cache b/Database/obj/Debug/Database.csproj.AssemblyReference.cache index 636c2669..9ee8fca5 100644 Binary files a/Database/obj/Debug/Database.csproj.AssemblyReference.cache and b/Database/obj/Debug/Database.csproj.AssemblyReference.cache differ diff --git a/DocIO_Demo_SHU/obj/Debug/DocIO_Demo_SHU.csproj.AssemblyReference.cache b/DocIO_Demo_SHU/obj/Debug/DocIO_Demo_SHU.csproj.AssemblyReference.cache index 1e82db9f..1b84f3d5 100644 Binary files a/DocIO_Demo_SHU/obj/Debug/DocIO_Demo_SHU.csproj.AssemblyReference.cache and b/DocIO_Demo_SHU/obj/Debug/DocIO_Demo_SHU.csproj.AssemblyReference.cache differ diff --git a/Excel_Test/obj/Debug/Excel_Test.csproj.AssemblyReference.cache b/Excel_Test/obj/Debug/Excel_Test.csproj.AssemblyReference.cache index f98ecad9..fff2397e 100644 Binary files a/Excel_Test/obj/Debug/Excel_Test.csproj.AssemblyReference.cache and b/Excel_Test/obj/Debug/Excel_Test.csproj.AssemblyReference.cache differ diff --git a/Model/VersandstrassePaket.cs b/Model/VersandstrassePaket.cs index f36045f9..7e75a1dc 100644 --- a/Model/VersandstrassePaket.cs +++ b/Model/VersandstrassePaket.cs @@ -5,11 +5,7 @@ using System.Text; using System.Threading.Tasks; namespace Model -{ - public class Versandpakete - { - public List paket { get; set; } - } +{ public class Versandpaket { public string bezeichnung { get; set; } @@ -19,7 +15,14 @@ namespace Model public string GAS { get; set; } public string GASAdresse { get; set; } public bool verified { get; set; } = false; + public int partnernr { get; set; } = 0; + public bool send_onbase_doc { get; set; } + public string handle { get; set; } = ""; + + public string finaldoc { get; set; } = ""; + public List Dokument { get; set; } + } public class Versanddokument @@ -38,5 +41,18 @@ namespace Model } } + + public class OnBase_Attributes + { + public string Dokumenttyp { get; set; } = "TECH Versandstrasse SendDoc"; + public string BPNummer { get; set; } = ""; + public string DocumentHandle { get; set; } = ""; + public string DistributionOption { get; set; } = ""; + public string GASCouvert { get; set; } = ""; + public string Returnaddress { get; set; } = ""; + public string O2ODochandle { get; set; } = ""; + public string Status { get; set; } = ""; + } + } diff --git a/Model/bin/Debug/Model.dll b/Model/bin/Debug/Model.dll index e9b2b2dd..c53c96d0 100644 Binary files a/Model/bin/Debug/Model.dll and b/Model/bin/Debug/Model.dll differ diff --git a/Model/bin/Debug/Model.pdb b/Model/bin/Debug/Model.pdb index db579073..ae53cf1f 100644 Binary files a/Model/bin/Debug/Model.pdb and b/Model/bin/Debug/Model.pdb differ diff --git a/Model/obj/Debug/Model.dll b/Model/obj/Debug/Model.dll index e9b2b2dd..c53c96d0 100644 Binary files a/Model/obj/Debug/Model.dll and b/Model/obj/Debug/Model.dll differ diff --git a/Model/obj/Debug/Model.pdb b/Model/obj/Debug/Model.pdb index db579073..ae53cf1f 100644 Binary files a/Model/obj/Debug/Model.pdb and b/Model/obj/Debug/Model.pdb differ diff --git a/NativVorlagen/obj/Debug/NativVorlagen.csproj.AssemblyReference.cache b/NativVorlagen/obj/Debug/NativVorlagen.csproj.AssemblyReference.cache index fa1d7ba8..620cf0d7 100644 Binary files a/NativVorlagen/obj/Debug/NativVorlagen.csproj.AssemblyReference.cache and b/NativVorlagen/obj/Debug/NativVorlagen.csproj.AssemblyReference.cache differ diff --git a/OnDocOffice/bin/Debug/Model.dll b/OnDocOffice/bin/Debug/Model.dll index e9b2b2dd..c53c96d0 100644 Binary files a/OnDocOffice/bin/Debug/Model.dll and b/OnDocOffice/bin/Debug/Model.dll differ diff --git a/OnDocOffice/bin/Debug/Model.pdb b/OnDocOffice/bin/Debug/Model.pdb index db579073..ae53cf1f 100644 Binary files a/OnDocOffice/bin/Debug/Model.pdb and b/OnDocOffice/bin/Debug/Model.pdb differ diff --git a/OnDocOffice/obj/Debug/OnDocOffice.csproj.AssemblyReference.cache b/OnDocOffice/obj/Debug/OnDocOffice.csproj.AssemblyReference.cache index 8c34b7cb..91469695 100644 Binary files a/OnDocOffice/obj/Debug/OnDocOffice.csproj.AssemblyReference.cache and b/OnDocOffice/obj/Debug/OnDocOffice.csproj.AssemblyReference.cache differ diff --git a/ToolsDoksImportExport/obj/Debug/ToolsDoksImportExport.csproj.AssemblyReference.cache b/ToolsDoksImportExport/obj/Debug/ToolsDoksImportExport.csproj.AssemblyReference.cache index 9a733db8..eb315754 100644 Binary files a/ToolsDoksImportExport/obj/Debug/ToolsDoksImportExport.csproj.AssemblyReference.cache and b/ToolsDoksImportExport/obj/Debug/ToolsDoksImportExport.csproj.AssemblyReference.cache differ diff --git a/Tools_Base64Decoder/obj/Debug/DesignTimeResolveAssemblyReferences.cache b/Tools_Base64Decoder/obj/Debug/DesignTimeResolveAssemblyReferences.cache index 628f547d..2f8a9d32 100644 Binary files a/Tools_Base64Decoder/obj/Debug/DesignTimeResolveAssemblyReferences.cache and b/Tools_Base64Decoder/obj/Debug/DesignTimeResolveAssemblyReferences.cache differ diff --git a/VBOffice/bin/Debug/Database.dll b/VBOffice/bin/Debug/Database.dll index e68065b2..f15f063a 100644 Binary files a/VBOffice/bin/Debug/Database.dll and b/VBOffice/bin/Debug/Database.dll differ diff --git a/VBOffice/bin/Debug/Database.pdb b/VBOffice/bin/Debug/Database.pdb index 377d6b18..ab28dfec 100644 Binary files a/VBOffice/bin/Debug/Database.pdb and b/VBOffice/bin/Debug/Database.pdb differ diff --git a/VBOffice/bin/Debug/Model.dll b/VBOffice/bin/Debug/Model.dll index fed19b4e..8c8d952b 100644 Binary files a/VBOffice/bin/Debug/Model.dll and b/VBOffice/bin/Debug/Model.dll differ diff --git a/VBOffice/bin/Debug/Model.pdb b/VBOffice/bin/Debug/Model.pdb index 99bfce67..a196c3f2 100644 Binary files a/VBOffice/bin/Debug/Model.pdb and b/VBOffice/bin/Debug/Model.pdb differ diff --git a/VBOffice/obj/Debug/VBOffice.vbproj.AssemblyReference.cache b/VBOffice/obj/Debug/VBOffice.vbproj.AssemblyReference.cache index 6e481208..b20c1358 100644 Binary files a/VBOffice/obj/Debug/VBOffice.vbproj.AssemblyReference.cache and b/VBOffice/obj/Debug/VBOffice.vbproj.AssemblyReference.cache differ diff --git a/Versandstrasse/Class1.cs b/Versandstrasse/Class1.cs index 43742202..64a6d600 100644 --- a/Versandstrasse/Class1.cs +++ b/Versandstrasse/Class1.cs @@ -1,13 +1,16 @@ using System; using System.Collections.Generic; +using System.Data.SqlTypes; using System.Drawing; using System.IO; using System.Linq; using System.Runtime.CompilerServices; using System.Runtime.InteropServices; using System.Runtime.Remoting.Messaging; +using System.Security; using System.Text; using System.Threading.Tasks; +using System.Xml.Serialization; using edoka_dms; using Model; using Syncfusion.Pdf; @@ -19,61 +22,166 @@ namespace Versandstrasse { public class clsVersandstrasse { + private List loadedDocuments = new List(); public void Lic() { string lickey = "MzYzODg2NkAzMjM4MmUzMDJlMzBTOWljRmxNelA1d1VGOHpGR0lxQzB6UTAwKzIxK2VBNEhBZFp5alcxb1NVPQ=="; Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense(lickey); } - public string Prepare_PDF(string dokumentid, string tempdir, string connectionstring) + + bool logo = false; + bool color = false; + int left = 0; + int top = 0; + int height = 0; + int width = 0; + string pages = ""; + string xml = ""; + + public string Prepare_PDF(string dokumentid, string tempdir, string connectionstring, versandscript vs = null) { Lic(); OnDocOffice.OfficeToPDF officeToPDF = new OnDocOffice.OfficeToPDF(); clsdok dok = new clsdok("", "", "", ""); dok.dokument = officeToPDF.word_to_pdf(dokumentid, connectionstring, tempdir); + //var stream = new MemoryStream(Convert.FromBase64String(dok.dokument)); - - var stream = new MemoryStream(Convert.FromBase64String(dok.dokument)); - - PdfLoadedDocument loadedDocument = new PdfLoadedDocument(stream); + ////Originalfile laden + //PdfLoadedDocument loadedDocument = new PdfLoadedDocument(stream); Database.DB db = new Database.DB(connectionstring); db.clear_parameter(); db.add_parameter("@dokumentid", dokumentid); db.Get_Tabledata("ondoc_get_versandstrasse_parameter", true, false); - int logo = 0; - int color = 0; - int left = 0; - int top = 0; - string pages = ""; - logo = Convert.ToInt32(db.dsdaten.Tables[0].Rows[0]["logo"]); - color = Convert.ToInt32(db.dsdaten.Tables[0].Rows[0]["logocolor"]); + versandscript vscript = new versandscript(); + + + + logo = Convert.ToBoolean(db.dsdaten.Tables[0].Rows[0]["logo"]); + color = Convert.ToBoolean(db.dsdaten.Tables[0].Rows[0]["logocolor"]); + top = Convert.ToInt32(db.dsdaten.Tables[0].Rows[0]["logotop"]); left = Convert.ToInt32(db.dsdaten.Tables[0].Rows[0]["logoleft"]); - top = Convert.ToInt32(db.dsdaten.Tables[0].Rows[0]["logocolor"]); + height = Convert.ToInt32(db.dsdaten.Tables[0].Rows[0]["logoheight"]); + width = Convert.ToInt32(db.dsdaten.Tables[0].Rows[0]["logowidth"]); + pages = db.dsdaten.Tables[0].Rows[0]["pages"].ToString(); + xml = db.dsdaten.Tables[0].Rows[0]["vscript"].ToString(); + if (xml != "") + { - if (logo == 1) + XmlSerializer serializer = new XmlSerializer(typeof(versandscript)); + using (StringReader reader = new StringReader(xml)) + { + vscript = (versandscript)(serializer.Deserialize(reader)); + } + if (vscript.PartCopies != "") + { + create_copies(ref vscript, dok.dokument); + } + } + else { - Add_Logo(ref loadedDocument, color, left, top, pages); + vsdokument d = new vsdokument(); + d.LogoTop = top; + d.LogoLeft = left; + d.LogoHeigth = height; + d.LogoWidth = width; + d.LogoColor = color; + d.Logo = logo; + d.LogoOnPages = "1"; + d.sourcedokument = dok.dokument; + vscript.dokuments.Add(d); } - if (loadedDocument.Pages.Count % 2 == 0) + + foreach (vsdokument vdok in vscript.dokuments) { + var stream = new MemoryStream(Convert.FromBase64String(vdok.sourcedokument)); + PdfLoadedDocument loadedDocument = new PdfLoadedDocument(stream); + if (vdok.Logo) + { + Add_Logo(ref loadedDocument, vdok.LogoColor, vdok.LogoLeft, vdok.LogoTop, vdok.LogoWidth, vdok.LogoHeigth, vdok.LogoOnPages); + } + loadedDocument.Save(@"x:\output1.pdf"); + if (vdok.TextReplaces.Count > 0) + { + foreach (TextReplace tr in vdok.TextReplaces) + { + if (tr.TextToReplace.Trim() != "") + { + Replace_Text(ref loadedDocument, tr.TextToReplace, tr.NewText); + } + } + } + if (loadedDocument.Pages.Count % 2 == 0) { } else { Add_EmptyPage(ref loadedDocument); } + MemoryStream outputStream = new MemoryStream(); + loadedDocument.Save(outputStream); + byte[] bytes; + bytes = outputStream.ToArray(); + vdok.pdfdokument = Convert.ToBase64String(bytes); + + } + if (vscript.dokuments.Count > 1) + { + int i = 0; + Stream[] streams = new Stream[vscript.dokuments.Count]; + + foreach (vsdokument vdoc in vscript.dokuments) + { + var stream = new MemoryStream(Convert.FromBase64String(vdoc.pdfdokument)); + streams[i] = stream; + i++; + + } + PdfDocument finalDoc = new PdfDocument(); + PdfDocumentBase.Merge(finalDoc, streams); + MemoryStream outputStream = new MemoryStream(); + finalDoc.Save(outputStream); + byte[] bytes; + bytes = outputStream.ToArray(); + dok.dokument = Convert.ToBase64String(bytes); + vscript.FinalDoc = Convert.ToBase64String(bytes); + finalDoc.Close(); + finalDoc.Dispose(); + streams = null; + vscript.FinalDoc = vscript.FinalDoc; } else { - Add_EmptyPage(ref loadedDocument); + vscript.FinalDoc = vscript.dokuments[0].pdfdokument.ToString(); } - MemoryStream outputStream = new MemoryStream(); - loadedDocument.Save(outputStream); - byte[] bytes; - bytes = outputStream.ToArray(); - dok.dokument = Convert.ToBase64String(bytes); - return dok.dokument; + + + + + return vscript.FinalDoc; } + private void create_copies(ref versandscript vscript, string dokument) + { + vsdokument vsd = vscript.dokuments[0]; + if (vsd.LogoTop == 0) { vsd.LogoTop = top; } + if (vsd.LogoLeft == 0) { vsd.LogoLeft = left; } + if (vsd.LogoHeigth == 0) { vsd.LogoHeigth = height; } + if (vsd.LogoWidth == 0) { vsd.LogoWidth = width; } + vsd.sourcedokument = dokument; + + int i = 1; + List copyparts = vscript.PartCopies.Split(';').ToList(); + foreach (string cp in copyparts) + { + string[] part = cp.Split(':'); + int part1 = Convert.ToInt32(part[0]); + int part2 = Convert.ToInt32(part[1]); + + vsdokument source = vscript.dokuments[part1 - 1]; + if (vscript.dokuments.Count >= part2) { vscript.dokuments[i] = source; } else { vscript.dokuments.Add(source); } + } + + } private void Replace_Text(ref PdfLoadedDocument document, string texttoreplace, string newtext) { PdfLoadedPage loadedPage = document.Pages[0] as PdfLoadedPage; @@ -84,7 +192,7 @@ namespace Versandstrasse for (int i = 0; i < matchedTextbounds.Count; i++) { - loadedPage = (PdfLoadedPage)document.Pages[i]; + loadedPage = (PdfLoadedPage)document.Pages[0]; foreach (RectangleF rectangle in matchedTextbounds[i]) { loadedPage.Graphics.DrawRectangle(PdfBrushes.White, rectangle); @@ -93,14 +201,18 @@ namespace Versandstrasse } } - private void Add_Logo(ref PdfLoadedDocument document, int color, int left, int top, string pages) + private string get_logo(bool color) + { + if (color) { return @"E:\Software-Projekte\OnDoc\Images\tkb_logo_ohne_claim_sw.jpg"; } else { return @"E:\Software-Projekte\OnDoc\Images\tkb_logo_ohne_claim_4c_c.jpg"; } + } + private void Add_Logo(ref PdfLoadedDocument document, bool color, int left, int top, int width, int height, string pages) { string imagefile = ""; - imagefile = @"E:\Software-Projekte\OnDoc\Images\tkb_logo_ohne_claim_4c_c.jpg"; - if (color == 0) { imagefile = @"E:\Software-Projekte\OnDoc\Images\tkb_logo_ohne_claim_sw.jpg"; } + + imagefile = get_logo(color); PdfBitmap image = new PdfBitmap(imagefile); - if (pages=="0") { return; } + if (pages == "0") { return; } if (pages == "All") { for (int i = 0; i < document.Pages.Count; i++) @@ -113,8 +225,6 @@ namespace Versandstrasse } else { - - int docpages = document.Pages.Count; string[] page = pages.Split(';'); @@ -136,4 +246,37 @@ namespace Versandstrasse } + public class versandscript + { + public string bezeichnung { get; set; } = "Versandstrassenparaemter"; + public int dokumenttypnr { get; set; } = 0; + public string Split_Doc { get; set; } = ""; + public string PartCopies { get; set; } = ""; + + public string FinalDoc { get; set; } = ""; + public List dokuments { get; set; } = new List(); + + } + + public class vsdokument + { + public bool Logo { get; set; } = true; + public bool LogoColor { get; set; } = false; + public int LogoTop { get; set; } = 0; + public int LogoLeft { get; set; } = 0; + public int LogoHeigth { get; set; } = 0; + public int LogoWidth { get; set; } = 0; + public string LogoOnPages { get; set; } = "1"; + + public string sourcedokument { get; set; } = ""; + public string pdfdokument { get; set; } = ""; + + public List TextReplaces { get; set; } = new List(); + } + + public class TextReplace + { + public string TextToReplace { get; set; } = ""; + public string NewText { get; set; } = ""; + } } diff --git a/Versandstrasse/bin/Debug/DOCGEN.dll b/Versandstrasse/bin/Debug/DOCGEN.dll index 284ccb81..34a325a0 100644 Binary files a/Versandstrasse/bin/Debug/DOCGEN.dll and b/Versandstrasse/bin/Debug/DOCGEN.dll differ diff --git a/Versandstrasse/bin/Debug/DOCGEN.pdb b/Versandstrasse/bin/Debug/DOCGEN.pdb index e71611d4..cb1c7d7c 100644 Binary files a/Versandstrasse/bin/Debug/DOCGEN.pdb and b/Versandstrasse/bin/Debug/DOCGEN.pdb differ diff --git a/Versandstrasse/bin/Debug/Database.dll b/Versandstrasse/bin/Debug/Database.dll index e68065b2..f15f063a 100644 Binary files a/Versandstrasse/bin/Debug/Database.dll and b/Versandstrasse/bin/Debug/Database.dll differ diff --git a/Versandstrasse/bin/Debug/Database.pdb b/Versandstrasse/bin/Debug/Database.pdb index 377d6b18..ab28dfec 100644 Binary files a/Versandstrasse/bin/Debug/Database.pdb and b/Versandstrasse/bin/Debug/Database.pdb differ diff --git a/Versandstrasse/bin/Debug/Model.dll b/Versandstrasse/bin/Debug/Model.dll index fed19b4e..c53c96d0 100644 Binary files a/Versandstrasse/bin/Debug/Model.dll and b/Versandstrasse/bin/Debug/Model.dll differ diff --git a/Versandstrasse/bin/Debug/Model.pdb b/Versandstrasse/bin/Debug/Model.pdb index 99bfce67..ae53cf1f 100644 Binary files a/Versandstrasse/bin/Debug/Model.pdb and b/Versandstrasse/bin/Debug/Model.pdb differ diff --git a/Versandstrasse/bin/Debug/OnDocOffice.dll b/Versandstrasse/bin/Debug/OnDocOffice.dll index ff515bbb..64ddb38b 100644 Binary files a/Versandstrasse/bin/Debug/OnDocOffice.dll and b/Versandstrasse/bin/Debug/OnDocOffice.dll differ diff --git a/Versandstrasse/bin/Debug/OnDocOffice.pdb b/Versandstrasse/bin/Debug/OnDocOffice.pdb index 9a8ea041..bdc13a34 100644 Binary files a/Versandstrasse/bin/Debug/OnDocOffice.pdb and b/Versandstrasse/bin/Debug/OnDocOffice.pdb differ diff --git a/Versandstrasse/bin/Debug/Versandstrasse.dll b/Versandstrasse/bin/Debug/Versandstrasse.dll index 252d76ed..7054761e 100644 Binary files a/Versandstrasse/bin/Debug/Versandstrasse.dll and b/Versandstrasse/bin/Debug/Versandstrasse.dll differ diff --git a/Versandstrasse/bin/Debug/Versandstrasse.pdb b/Versandstrasse/bin/Debug/Versandstrasse.pdb index 2b064d22..bc8d29f6 100644 Binary files a/Versandstrasse/bin/Debug/Versandstrasse.pdb and b/Versandstrasse/bin/Debug/Versandstrasse.pdb differ diff --git a/Versandstrasse/obj/Debug/Versandstrasse.csproj.AssemblyReference.cache b/Versandstrasse/obj/Debug/Versandstrasse.csproj.AssemblyReference.cache index 30a05df9..66248e2d 100644 Binary files a/Versandstrasse/obj/Debug/Versandstrasse.csproj.AssemblyReference.cache and b/Versandstrasse/obj/Debug/Versandstrasse.csproj.AssemblyReference.cache differ diff --git a/Versandstrasse/obj/Debug/Versandstrasse.dll b/Versandstrasse/obj/Debug/Versandstrasse.dll index 252d76ed..7054761e 100644 Binary files a/Versandstrasse/obj/Debug/Versandstrasse.dll and b/Versandstrasse/obj/Debug/Versandstrasse.dll differ diff --git a/Versandstrasse/obj/Debug/Versandstrasse.pdb b/Versandstrasse/obj/Debug/Versandstrasse.pdb index 2b064d22..bc8d29f6 100644 Binary files a/Versandstrasse/obj/Debug/Versandstrasse.pdb and b/Versandstrasse/obj/Debug/Versandstrasse.pdb differ diff --git a/Vorlagen_Viewer/obj/Debug/DesignTimeResolveAssemblyReferences.cache b/Vorlagen_Viewer/obj/Debug/DesignTimeResolveAssemblyReferences.cache index 63b0ba03..411ec880 100644 Binary files a/Vorlagen_Viewer/obj/Debug/DesignTimeResolveAssemblyReferences.cache and b/Vorlagen_Viewer/obj/Debug/DesignTimeResolveAssemblyReferences.cache differ diff --git a/Vorlagen_Viewer/obj/Debug/Vorlagen_Viewer.csproj.AssemblyReference.cache b/Vorlagen_Viewer/obj/Debug/Vorlagen_Viewer.csproj.AssemblyReference.cache index d2d204ad..b682f745 100644 Binary files a/Vorlagen_Viewer/obj/Debug/Vorlagen_Viewer.csproj.AssemblyReference.cache and b/Vorlagen_Viewer/obj/Debug/Vorlagen_Viewer.csproj.AssemblyReference.cache differ diff --git a/ZZPDFTest/Form1.Designer.cs b/ZZPDFTest/Form1.Designer.cs index 32148ea6..74d020eb 100644 --- a/ZZPDFTest/Form1.Designer.cs +++ b/ZZPDFTest/Form1.Designer.cs @@ -28,13 +28,20 @@ /// private void InitializeComponent() { + Syncfusion.Windows.Forms.PdfViewer.MessageBoxSettings messageBoxSettings1 = new Syncfusion.Windows.Forms.PdfViewer.MessageBoxSettings(); + Syncfusion.Windows.PdfViewer.PdfViewerPrinterSettings pdfViewerPrinterSettings1 = new Syncfusion.Windows.PdfViewer.PdfViewerPrinterSettings(); + System.ComponentModel.ComponentResourceManager resources = new System.ComponentModel.ComponentResourceManager(typeof(Form1)); + Syncfusion.Windows.Forms.PdfViewer.TextSearchSettings textSearchSettings1 = new Syncfusion.Windows.Forms.PdfViewer.TextSearchSettings(); this.button1 = new System.Windows.Forms.Button(); this.button2 = new System.Windows.Forms.Button(); + this.button3 = new System.Windows.Forms.Button(); + this.button4 = new System.Windows.Forms.Button(); + this.pdfViewerControl1 = new Syncfusion.Windows.Forms.PdfViewer.PdfViewerControl(); this.SuspendLayout(); // // button1 // - this.button1.Location = new System.Drawing.Point(158, 79); + this.button1.Location = new System.Drawing.Point(22, 746); this.button1.Name = "button1"; this.button1.Size = new System.Drawing.Size(75, 23); this.button1.TabIndex = 0; @@ -44,7 +51,7 @@ // // button2 // - this.button2.Location = new System.Drawing.Point(314, 79); + this.button2.Location = new System.Drawing.Point(22, 775); this.button2.Name = "button2"; this.button2.Size = new System.Drawing.Size(75, 23); this.button2.TabIndex = 1; @@ -52,11 +59,73 @@ this.button2.UseVisualStyleBackColor = true; this.button2.Click += new System.EventHandler(this.button2_Click); // + // button3 + // + this.button3.Location = new System.Drawing.Point(22, 804); + this.button3.Name = "button3"; + this.button3.Size = new System.Drawing.Size(75, 23); + this.button3.TabIndex = 2; + this.button3.Text = "button3"; + this.button3.UseVisualStyleBackColor = true; + this.button3.Click += new System.EventHandler(this.button3_Click); + // + // button4 + // + this.button4.Location = new System.Drawing.Point(40, 27); + this.button4.Name = "button4"; + this.button4.Size = new System.Drawing.Size(230, 23); + this.button4.TabIndex = 3; + this.button4.Text = "PDF_Aufbereiten"; + this.button4.UseVisualStyleBackColor = true; + this.button4.Click += new System.EventHandler(this.button4_Click); + // + // pdfViewerControl1 + // + this.pdfViewerControl1.CursorMode = Syncfusion.Windows.Forms.PdfViewer.PdfViewerCursorMode.SelectTool; + this.pdfViewerControl1.Dock = System.Windows.Forms.DockStyle.Right; + this.pdfViewerControl1.EnableContextMenu = true; + this.pdfViewerControl1.EnableNotificationBar = true; + this.pdfViewerControl1.HorizontalScrollOffset = 0; + this.pdfViewerControl1.IsBookmarkEnabled = true; + this.pdfViewerControl1.IsTextSearchEnabled = true; + this.pdfViewerControl1.IsTextSelectionEnabled = true; + this.pdfViewerControl1.Location = new System.Drawing.Point(288, 0); + messageBoxSettings1.EnableNotification = true; + this.pdfViewerControl1.MessageBoxSettings = messageBoxSettings1; + this.pdfViewerControl1.MinimumZoomPercentage = 50; + this.pdfViewerControl1.Name = "pdfViewerControl1"; + this.pdfViewerControl1.PageBorderThickness = 1; + pdfViewerPrinterSettings1.Copies = 1; + pdfViewerPrinterSettings1.PageOrientation = Syncfusion.Windows.PdfViewer.PdfViewerPrintOrientation.Auto; + pdfViewerPrinterSettings1.PageSize = Syncfusion.Windows.PdfViewer.PdfViewerPrintSize.ActualSize; + pdfViewerPrinterSettings1.PrintLocation = ((System.Drawing.PointF)(resources.GetObject("pdfViewerPrinterSettings1.PrintLocation"))); + pdfViewerPrinterSettings1.ShowPrintStatusDialog = true; + this.pdfViewerControl1.PrinterSettings = pdfViewerPrinterSettings1; + this.pdfViewerControl1.ReferencePath = null; + this.pdfViewerControl1.ScrollDisplacementValue = 0; + this.pdfViewerControl1.ShowHorizontalScrollBar = true; + this.pdfViewerControl1.ShowToolBar = true; + this.pdfViewerControl1.ShowVerticalScrollBar = true; + this.pdfViewerControl1.Size = new System.Drawing.Size(1177, 854); + this.pdfViewerControl1.SpaceBetweenPages = 8; + this.pdfViewerControl1.TabIndex = 4; + this.pdfViewerControl1.Text = "pdfViewerControl1"; + textSearchSettings1.CurrentInstanceColor = System.Drawing.Color.FromArgb(((int)(((byte)(127)))), ((int)(((byte)(255)))), ((int)(((byte)(171)))), ((int)(((byte)(64))))); + textSearchSettings1.HighlightAllInstance = true; + textSearchSettings1.OtherInstanceColor = System.Drawing.Color.FromArgb(((int)(((byte)(127)))), ((int)(((byte)(254)))), ((int)(((byte)(255)))), ((int)(((byte)(0))))); + this.pdfViewerControl1.TextSearchSettings = textSearchSettings1; + this.pdfViewerControl1.VerticalScrollOffset = 0; + this.pdfViewerControl1.VisualStyle = Syncfusion.Windows.Forms.PdfViewer.VisualStyle.Default; + this.pdfViewerControl1.ZoomMode = Syncfusion.Windows.Forms.PdfViewer.ZoomMode.Default; + // // Form1 // this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 13F); this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font; - this.ClientSize = new System.Drawing.Size(800, 450); + this.ClientSize = new System.Drawing.Size(1465, 854); + this.Controls.Add(this.pdfViewerControl1); + this.Controls.Add(this.button4); + this.Controls.Add(this.button3); this.Controls.Add(this.button2); this.Controls.Add(this.button1); this.Name = "Form1"; @@ -70,6 +139,9 @@ private System.Windows.Forms.Button button1; private System.Windows.Forms.Button button2; + private System.Windows.Forms.Button button3; + private System.Windows.Forms.Button button4; + private Syncfusion.Windows.Forms.PdfViewer.PdfViewerControl pdfViewerControl1; } } diff --git a/ZZPDFTest/Form1.cs b/ZZPDFTest/Form1.cs index 85e3908d..566198f3 100644 --- a/ZZPDFTest/Form1.cs +++ b/ZZPDFTest/Form1.cs @@ -7,11 +7,14 @@ using System.Linq; using System.Text; using System.Threading.Tasks; using System.Windows.Forms; +using System.Xml.Serialization; using Syncfusion.Pdf; using Syncfusion.Pdf.Graphics; using Syncfusion.Pdf.Interactive; using Syncfusion.Pdf.Parsing; using static System.Windows.Forms.VisualStyles.VisualStyleElement; +using Versandstrasse; +using System.IO; namespace ZZPDFTest { @@ -158,5 +161,66 @@ namespace ZZPDFTest newdoc.Close(true); } + + private void button3_Click(object sender, EventArgs e) + { + versandscript vscript = new versandscript(); + vsdokument dok = new vsdokument(); + + TextReplace tReplace = new TextReplace(); + tReplace.TextToReplace = ""; + tReplace.NewText = ""; + + dok.TextReplaces.Add(tReplace); + vscript.dokuments.Add(dok); + + vscript.bezeichnung = "Test"; + XmlSerializer serializer = new XmlSerializer(typeof(versandscript)); + serializer.Serialize(System.IO.File.Create(@"x:\file.xml"), vscript); + + } + + private void button4_Click(object sender, EventArgs e) + { + clsVersandstrasse vs = new clsVersandstrasse(); + string tempdir = @"h:\tssettings\edoka"; + string connectionstring = "data source=shu01\\shu00;initial catalog=edoka_dms;packet size=4096;user id=sa;password=*shu29"; + string pdfdokument = vs.Prepare_PDF("OFFEDK0082025002491692",tempdir,connectionstring); + var stream = new MemoryStream(Convert.FromBase64String(pdfdokument)); + pdfViewerControl1.Load(stream); + } + } + + public class versandscript + { + public string bezeichnung { get; set; } = "Versandstrassenparaemter"; + public int dokumenttypnr { get; set; } = 0; + public string Split_Doc { get; set; } = ""; + public string PartCopies { get; set; } = "1:0;2:1"; + + public List dokuments { get; set; } = new List(); + + } + + public class vsdokument + { + public bool Logo { get; set; } = true; + public bool LogoColor { get; set; } = false; + public int LogoTop { get; set; } = 0; + public int LogoLeft { get; set; } = 0; + public int LogoHeigth { get; set; } = 0; + public int LogoWidth { get; set; } = 0; + public string LogoOnPages { get; set; } = "1"; + + public string sourcedokument { get; set; } = ""; + public string pdfdokument { get; set; } = ""; + + public List TextReplaces { get; set; } = new List(); + } + + public class TextReplace + { + public string TextToReplace { get; set; } = ""; + public string NewText { get; set; } = ""; } -} +} \ No newline at end of file diff --git a/ZZPDFTest/Form1.resx b/ZZPDFTest/Form1.resx index 1af7de15..d9e357ef 100644 --- a/ZZPDFTest/Form1.resx +++ b/ZZPDFTest/Form1.resx @@ -117,4 +117,11 @@ System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + AAEAAAD/////AQAAAAAAAAAMAgAAAFFTeXN0ZW0uRHJhd2luZywgVmVyc2lvbj00LjAuMC4wLCBDdWx0 + dXJlPW5ldXRyYWwsIFB1YmxpY0tleVRva2VuPWIwM2Y1ZjdmMTFkNTBhM2EFAQAAABVTeXN0ZW0uRHJh + d2luZy5Qb2ludEYCAAAAAXgBeQAACwsCAAAAAAAAAAAAAAAL + + \ No newline at end of file diff --git a/ZZPDFTest/ZZPDFTest.csproj b/ZZPDFTest/ZZPDFTest.csproj index 79ef896a..e1eedbe2 100644 --- a/ZZPDFTest/ZZPDFTest.csproj +++ b/ZZPDFTest/ZZPDFTest.csproj @@ -46,8 +46,11 @@ False ..\..\Syncfusoin 462\Syncfusion.PdfToImageConverter.Base.dll + + + @@ -57,6 +60,9 @@ + + ..\Versandstrasse\bin\Debug\Versandstrasse.dll + diff --git a/ZZPDFTest/bin/Debug/BarcodeLib.dll b/ZZPDFTest/bin/Debug/BarcodeLib.dll new file mode 100644 index 00000000..9b1f1fc5 Binary files /dev/null and b/ZZPDFTest/bin/Debug/BarcodeLib.dll differ diff --git a/ZZPDFTest/bin/Debug/BarcodeLib.pdb b/ZZPDFTest/bin/Debug/BarcodeLib.pdb new file mode 100644 index 00000000..03c63844 Binary files /dev/null and b/ZZPDFTest/bin/Debug/BarcodeLib.pdb differ diff --git a/ZZPDFTest/bin/Debug/DOCGEN.dll b/ZZPDFTest/bin/Debug/DOCGEN.dll new file mode 100644 index 00000000..34a325a0 Binary files /dev/null and b/ZZPDFTest/bin/Debug/DOCGEN.dll differ diff --git a/ZZPDFTest/bin/Debug/DOCGEN.dll.config b/ZZPDFTest/bin/Debug/DOCGEN.dll.config new file mode 100644 index 00000000..3751d1f0 --- /dev/null +++ b/ZZPDFTest/bin/Debug/DOCGEN.dll.config @@ -0,0 +1,43 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/ZZPDFTest/bin/Debug/DOCGEN.pdb b/ZZPDFTest/bin/Debug/DOCGEN.pdb new file mode 100644 index 00000000..cb1c7d7c Binary files /dev/null and b/ZZPDFTest/bin/Debug/DOCGEN.pdb differ diff --git a/ZZPDFTest/bin/Debug/DOCGEN.xml b/ZZPDFTest/bin/Debug/DOCGEN.xml new file mode 100644 index 00000000..989f1867 --- /dev/null +++ b/ZZPDFTest/bin/Debug/DOCGEN.xml @@ -0,0 +1,13 @@ + + + + DOCGEN + + + + Word to PDF-Konverter + Das sind die Remarks + Base64-Dokument + + + diff --git a/ZZPDFTest/bin/Debug/Database.dll b/ZZPDFTest/bin/Debug/Database.dll new file mode 100644 index 00000000..f15f063a Binary files /dev/null and b/ZZPDFTest/bin/Debug/Database.dll differ diff --git a/ZZPDFTest/bin/Debug/Database.pdb b/ZZPDFTest/bin/Debug/Database.pdb new file mode 100644 index 00000000..ab28dfec Binary files /dev/null and b/ZZPDFTest/bin/Debug/Database.pdb differ diff --git a/ZZPDFTest/bin/Debug/FastReport.Bars.dll b/ZZPDFTest/bin/Debug/FastReport.Bars.dll new file mode 100644 index 00000000..ad8fd0ef Binary files /dev/null and b/ZZPDFTest/bin/Debug/FastReport.Bars.dll differ diff --git a/ZZPDFTest/bin/Debug/FastReport.Compat.dll b/ZZPDFTest/bin/Debug/FastReport.Compat.dll new file mode 100644 index 00000000..aabb6591 Binary files /dev/null and b/ZZPDFTest/bin/Debug/FastReport.Compat.dll differ diff --git a/ZZPDFTest/bin/Debug/FastReport.DataVisualization.dll b/ZZPDFTest/bin/Debug/FastReport.DataVisualization.dll new file mode 100644 index 00000000..cd9ea7be Binary files /dev/null and b/ZZPDFTest/bin/Debug/FastReport.DataVisualization.dll differ diff --git a/ZZPDFTest/bin/Debug/FastReport.Editor.dll b/ZZPDFTest/bin/Debug/FastReport.Editor.dll new file mode 100644 index 00000000..c7be5c7a Binary files /dev/null and b/ZZPDFTest/bin/Debug/FastReport.Editor.dll differ diff --git a/ZZPDFTest/bin/Debug/FastReport.dll b/ZZPDFTest/bin/Debug/FastReport.dll new file mode 100644 index 00000000..9d592254 Binary files /dev/null and b/ZZPDFTest/bin/Debug/FastReport.dll differ diff --git a/ZZPDFTest/bin/Debug/FastReport.xml b/ZZPDFTest/bin/Debug/FastReport.xml new file mode 100644 index 00000000..51ceea56 --- /dev/null +++ b/ZZPDFTest/bin/Debug/FastReport.xml @@ -0,0 +1,57644 @@ + + + + FastReport + + + + + Represents the pages of a prepared report. + + + Prepared page is a page that you can see in the preview window. Prepared pages can be + accessed via property. + The common scenarios of using this object are: + + + Working with prepared pages after the report is finished: load + () or save () pages + from/to a .fpx file, get a page with specified index to work with its objects + (); modify specified page (). + + + + Using the , , + methods while report is generating to produce an output. + + + + + + + + + Gets the number of pages in the prepared report. + + + + + Gets the XML for rendering the outline of the report + + + + + Specifies an action that will be performed on method call. + + + + + Gets or sets a value indicating whether the prepared pages can be uploaded to the file cache. + + + This property is used while report is generating. + Default value for this property is true. That means the prepared pages may be uploaded to + the file cache if needed. To prevent this (for example, if you need to access some objects + on previously generated pages), set the property value to false. + + + + + + + + Adds a source page to the prepared pages dictionary. + + The template page to add. + + Call this method before using AddPage and AddBand methods. This method adds + a page to the dictionary that will be used to decrease size of the prepared report. + + + + + Adds a new page. + + The original (template) page to add. + + Call the method before adding a page. This method creates + a new output page with settings based on page parameter. + + + + + Prints a band with all its child objects. + + The band to print. + true if band was printed; false if it can't be printed + on current page due to its PrintOn property value. + + Call the method before adding a band. + + + + + Gets a page with specified index. + + Zero-based index of page. + The page with specified index. + + + + Gets the size of specified page, in pixels. + + Index of page. + the size of specified page, in pixels. + + + + Replaces the prepared page with specified one. + + The index of prepared page to replace. + The new page to replace with. + + + + Modify the prepared page with new sizes. + + The name of prepared page to reSize. + + + + Removes a page with the specified index. + + The zero-based index of page to remove. + + + + Creates a copy of a page with specified index and inserts it after original one. + + The zero-based index of original page. + + + + Saves prepared pages to a stream. + + The stream to save to. + + + + Saves prepared pages to a .fpx file. + + The name of the file to save to. + + + + Loads prepared pages from a stream. + + The stream to load from. + + + + Loads prepared pages from a .fpx file. + + The name of the file to load from. + + + + Clears the prepared report's pages. + + + + + Creates the pages of a prepared report + + + + + + Gets or sets the initial directory that is displayed by a save file dialog. + + + + + Initializes a new instance of the OutlineControl class with default settings. + + + + + Represents a Windows Forms control used to preview a report. + + + To use this control, place it on a form and link it to a report using the report's + property. To show a report, call + the Report.Show method: + + report1.Preview = previewControl1; + report1.Show(); + + Use this control's methods such as , etc. to + handle the preview. Call method to clear the preview. + You can specify whether the standard toolbar is visible in the + property. The property allows you to hide/show the statusbar. + + + + + + Occurs when current page number is changed. + + + + + Occurs when Print button clicked. + + + + + Occurs when Export button clicked. + + + + + Gets a reference to the report. + + + + + Obsolete. Gets or sets the color of page border. + + + + + Gets or sets the color of active page border. + + + + + Gets or sets the first page offset from the top left corner of the control. + + + + + Gets a reference to the TabControl + + + + + Gets or sets a value indicating whether the toolbar is visible. + + + + + Gets or sets a value indicating whether the statusbar is visible. + + + + + Gets or sets a value indicating whether the outline control is visible. + + + + + Specifies the set of buttons available in the toolbar. + + + + + Specifies the set of exports that will be available in the preview's "save" menu. + + + + + Specifies the set of exports in clouds that will be available in the preview's "save" menu. + + + + + Gets or sets a value indicating whether the fast scrolling method should be used. + + + If you enable this property, the gradient background will be disabled. + + + + + Gets or sets the visual style. + + + + + Gets or sets a value indicating that the BackColor property must be used to draw the background area. + + + By default, the background area is drawn using the color defined in the current UIStyle. + + + + + Gets the preview window's toolbar. + + + + + Gets the preview window's statusbar. + + + + + Gets or sets the initial directory that is displayed by a save file dialog. + + + + + Opens Cloud form and shows selected prepared report. + + + + + Updates the control appearance and layout on dpi change. + + + + + + + + Adds a new report tab to the preview control. + + The Report object that contains the prepared report. + The title for the new tab. + + Prepare the report using its Prepare method before you pass it to the report parameter. + + + + + Adds a new report tab to the preview control. + + The Report object that contains the prepared report. + The title for the new tab. + If true, makes the new tab active. + + Prepare the report using its Prepare method before you pass it to the report parameter. + + + + + Switches to the tab with specified text. + + Text of the tab. + true if the tab with specified text exists, or false if there is no such tab. + + + + Deletes the report tab with specified text. + + The text of the tab. + + + + Checks if the tab with specified text exists. + + The text of the tab. + true if the tab exists. + + + + Displays the text in the status bar. + + Text to display. + + + + Sets the focus to the preview control. + + + + + Prints the current report. + + true if report was printed; false if user cancels the "Print" dialog. + + + + Saves the current report to a .fpx file using the "Save FIle" dialog. + + + + + Saves the current report to a specified .fpx file. + + + + + Saves the current report to a stream. + + + + + Loads the report from a .fpx file using the "Open File" dialog. + + + + + Loads the report from a specified .fpx file. + + + + + Load the report from a stream. + + The stream to load from. + + + + Sends an email. + + + + + Finds the text in the current report using the "Find Text" dialog. + + + + + Finds the specified text in the current report. + + Text to find. + A value indicating whether the search is case-sensitive. + A value indicating whether the search matches whole words only. + true if text found. + + + + Finds the next occurence of text specified in the Find method. + + true if text found. + + + + Navigates to the first page. + + + + + Navigates to the previuos page. + + + + + Navigates to the next page. + + + + + Navigates to the last page. + + + + + Gets or sets the current page number. + + + This value is 1-based. + + + + + Gets the pages count in the current report. + + + + + Gets or sets the zoom factor. + + + 1 corresponds to 100% zoom. + + + + + Zooms in. + + + + + Zooms out. + + + + + Zooms to fit the page width. + + + + + Zooms to fit the whole page. + + + + + Edits the current page in the designer. + + + + + Copies the current page in preview. + + + + + Removes the current page in preview. + + + + + Edits the current report in the designer. + + + + + Edits the watermark. + + + + + Edits the page settings. + + + + + Navigates to the specified position inside a specified page. + + The page number (1-based). + The position inside a page, in pixels. + + + + Clears the preview. + + + + + Refresh the report. + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Specifies an action that will be performed on PreparedPages.AddPage method call. + + + + + Do not add the new prepared page if possible, increment the CurPage instead. + + + + + Add the new prepared page. + + + + + Represents a report object. + + + The instance of this class contains a report. Here are some common + actions that can be performed with this object: + + + To load a report, use the + method or call static method. + + + To save a report, call the method. + + + To register application dataset for use it in a report, call one of the + RegisterData methods. + + + To pass some parameter to a report, use the + method. + + + To design a report, call the method. + + + To run a report and preview it, call the method. + Another way is to call the method, then call the + method. + + + To run a report and print it, call the method. + Another way is to call the method, then call the + method. + + + To load/save prepared report, use one of the LoadPrepared and + SavePrepared methods. + + + To set up some global properties, use the static class + or component that you can use in the Visual Studio IDE. + + + + The report consists of one or several report pages (pages of the + type) and/or dialog forms (pages of the type). + They are stored in the collection. In turn, each page may contain report + objects. See the example below how to create a simple report in code. + + This example shows how to create a report instance, load it from a file, + register the application data, run and preview. + + Report report = new Report(); + report.Load("reportfile.frx"); + report.RegisterData(application_dataset); + report.Show(); + + This example shows how to create simple report in code. + + Report report = new Report(); + // create the report page + ReportPage page = new ReportPage(); + page.Name = "ReportPage1"; + // set paper width and height. Note: these properties are measured in millimeters. + page.PaperWidth = 210; + page.PaperHeight = 297; + // add a page to the report + report.Pages.Add(page); + // create report title + page.ReportTitle = new ReportTitleBand(); + page.ReportTitle.Name = "ReportTitle1"; + page.ReportTitle.Height = Units.Millimeters * 10; + // create Text object and put it to the title + TextObject text = new TextObject(); + text.Name = "Text1"; + text.Bounds = new RectangleF(0, 0, Units.Millimeters * 100, Units.Millimeters * 5); + page.ReportTitle.Objects.Add(text); + // create data band + DataBand data = new DataBand(); + data.Name = "Data1"; + data.Height = Units.Millimeters * 10; + // add data band to a page + page.Bands.Add(data); + + + + + + Gets a reference to the report designer. + + + This property can be used when report is designing. In other cases it returns null. + + + + + Indicates whether the report is opened from Cloud or not + + + + + Cloud file info (set if report was opened from Cloud). + + + + + Runs the report designer. + + true if report was modified, otherwise false. + + + + Runs the report designer. + + A value indicates whether the designer should run modally. + true if report was modified, otherwise false. + + + + Runs the report designer. + + The main MDI form which will be a parent for the designer. + true if report was modified, otherwise false. + + + + Gets the email settings such as recipients, subject, message body. + + + + + Gets or sets the report preview control. + + + Use this property to attach a custom preview to your report. To do this, place the PreviewControl + control to your form and set the report's Preview property to this control. + + + + + Gets the print settings such as printer name, copies, pages to print etc. + + + + + + + + + + Prepares the report and prints it. + + + + + Prints the report with the "Print" dialog. + Report should be prepared using the method. + + + + + Prints the report without the "Print" dialog. + Report should be prepared using the method. + + Printer-specific settings. + + Use the following code if you want to show the "Print" dialog, then print: + + if (report.Prepare()) + { + PrinterSettings printerSettings = null; + if (report.ShowPrintDialog(out printerSettings)) + { + report.PrintPrepared(printerSettings); + } + } + + + + + + Prepares the report and shows it in the preview window. + + + + + Prepares the report and shows it in the preview window. + + A value that specifies whether the preview window should be modal. + + + + Prepares the report and shows it in the preview window. + + A value that specifies whether the preview window should be modal. + The owner of the preview window. + + + + Prepares the report and shows it in the preview window. + + The main MDI form which will be a parent for the preview window. + + + + Previews the report. The report should be prepared using the method. + + + + + Previews the prepared report. + + A value that specifies whether the preview window should be modal. + + + + Previews the prepared report. + + A value that specifies whether the preview window should be modal. + The owner of the preview window. + + + + Previews the prepared report. + + The main MDI form which will be a parent for the preview window. + + + + Shows the "Print" dialog. + + Printer-specific settings. + true if the dialog was closed by "Print" button. + + Use the following code if you want to show the "Print" dialog, then print: + + if (report.Prepare()) + { + PrinterSettings printerSettings = null; + if (report.ShowPrintDialog(out printerSettings)) + { + report.PrintPrepared(printerSettings); + } + } + + + + + + Prepares the report and shows it in the provided PreviewControl (async way). + + The preview control. + + + + Prepares the report and shows it in the preview window (async way). + + + + + Prepares the report and shows it in the preview window (async way). + + A value that specifies whether the preview window should be modal. + + + + Prepares the report and shows it in the preview window (async way). + + A value that specifies whether the preview window should be modal. + The owner of the preview window. + + + + Prepares the report and shows it in the preview window (async way). + + The main MDI form which will be a parent for the preview window. + + + + Occurs when calc execution is started. + + + + + Occurs when report is inherited and trying to load a base report. + + + Typical use of this event is to load the base report from a database instead of a file. + + + + + Occurs when report execution is started. + + + + + Occurs when report execution is finished. + + + + + Occurs before export to set custom export parameters. + + + + + Gets the pages contained in this report. + + + This property contains pages of all types (report and dialog). Use the is/as operators + if you want to work with pages of ReportPage type. + + The following code demonstrates how to access the first report page: + + ReportPage page1 = report1.Pages[0] as ReportPage; + + + + + + Gets the report's data. + + + The dictionary contains all data items such as connections, data sources, parameters, + system variables. + + + + + Gets the collection of report parameters. + + + Parameters are displayed in the "Data" window under the "Parameters" node. + Typical use of parameters is to pass some static data from the application to the report. + You can print such data, use it in the data row filter, script etc. + Another way to use parameters is to define some reusable piece of code, for example, + to define an expression that will return the concatenation of first and second employee name. + In this case, you set the parameter's Expression property to something like this: + [Employees.FirstName] + " " + [Employees.LastName]. Now this parameter may be used in the report + to print full employee name. Each time you access such parameter, it will calculate the expression + and return its value. + You can create nested parameters. To do this, add the new Parameter to the + Parameters collection of the root parameter. To access the nested parameter, you may use the + method. + To get or set the parameter's value, use the and + methods. To set the parameter's expression, use the + method that returns a Parameter object and set its + Expression property. + + + + + Gets or sets the report information such as report name, author, description etc. + + + + + Gets or sets the base report file name. + + + This property contains the name of a report file this report is inherited from. + Note: setting this property to non-empty value will clear the report and + load the base file into it. + + + + + Gets a value indicating whether Report is prepared + + + + + Gets or sets the absolute path to the parent report. + + + This property contains the absolute path to the parent report. + + + + + Gets or sets the name of a file the report was loaded from. + + + This property is used to support the FastReport.Net infrastructure; + typically you don't need to use it. + + + + + Gets or sets the report script. + + + The script contains the ReportScript class that contains all report objects' + event handlers and own items such as private fields, properties, methods etc. The script + contains only items written by you. Unlike other report generators, the script does not + contain report objects declarations, initialization code. It is added automatically when + you run the report. + By default this property contains an empty script text. You may see it in the designer + when you switch to the Code window. + If you set this property programmatically, you have to declare the FastReport + namespace and the ReportScript class in it. Do not declare report items (such as bands, + objects, etc) in the ReportScript class: the report engine does this automatically when + you run the report. + Security note: since the report script is compiled into .NET assembly, it allows + you to do ANYTHING. For example, you may create a script that will read/write files from/to a disk. + To restrict such operations, use the property. + + + + + Gets or sets the script language of this report. + + + Note: changing this property will reset the report script to default empty script. + + + + + Gets or sets a value indicating whether the null DB value must be converted to zero, false or + empty string depending on the data column type. + + + This property is true by default. If you set it to false, you should check + the DB value before you do something with it (for example, typecast it to any type, use it + in a expression etc.) + + + + + Gets or sets a value that specifies whether the report engine should perform the second pass. + + + Typically the second pass is necessary to print the number of total pages. It also + may be used to perform some calculations on the first pass and print its results on the + second pass. + Use the Engine.FirstPass, Engine.FinalPass properties to determine which + pass the engine is performing now. + + + + + Gets or sets a value that specifies whether to compress the report file. + + + The report file is compressed using the Gzip algorithm. So you can open the + compressed report in any zip-compatible archiver. + + + + + Returns a bool value depending on the .frx or .fpx report was loaded + + + + + Gets or sets a value that specifies whether to use the file cache rather than memory + to store the prepared report pages. + + + + + Gets or sets a value that specifies the quality of text rendering. + + + Note: the default property value is TextQuality.Default. That means the report + may look different depending on OS settings. This property does not affect the printout. + + + + + Gets or sets a value that specifies if the graphic objects such as bitmaps + and shapes should be displayed smoothly. + + + + + Gets or sets the report password. + + + When you try to load the password-protected report, you will be asked + for a password. You also may specify the password in this property before loading + the report. In this case the report will load silently. + Password-protected report file is crypted using Rijndael algorithm. + Do not forget your password! It will be hard or even impossible to open + the protected file in this case. + + + + + Gets or sets a value indicating whether it is necessary to automatically fill + DataSet registered with RegisterData call. + + + If this property is true (by default), FastReport will automatically fill + the DataSet with data when you trying to run a report. Set it to false if + you want to fill the DataSet by yourself. + + + + + Gets or sets the maximum number of generated pages in a prepared report. + + + Use this property to limit the number of pages in a prepared report. + + + + + Gets or sets the collection of styles used in this report. + + + + + Gets or sets an array of assembly names that will be used to compile the report script. + + + By default this property contains the following assemblies: "System.dll", "System.Drawing.dll", + "System.Windows.Forms.dll", "System.Data.dll", "System.Xml.dll". If your script uses some types + from another assemblies, you have to add them to this property. + + + + + Gets or sets a script event name that will be fired when the report starts. + + + + + Gets or sets a script event name that will be fired when the report is finished. + + + + + Gets a value indicating that report execution was aborted. + + + + + Gets or sets a value that determines whether to store the report in the application resources. + Use this property in the MS Visual Studio IDE only. + + + By default this property is true. When set to false, you should store your report + in a file. + + + + + Gets or sets the resource string that contains the report. + + + This property is used by the MS Visual Studio to store the report. Do not use it directly. + + + + + Gets a value indicating that this report contains dialog forms. + + + + + Gets or sets a set of permissions that will be restricted for the script code. + + + Since the report script is compiled into .NET assembly, it allows you to do ANYTHING. + For example, you may create a script that will read/write files from/to a disk. This property + is used to restrict such operations. + This example shows how to restrict the file IO operations in a script: + + using System.Security; + using System.Security.Permissions; + ... + PermissionSet ps = new PermissionSet(PermissionState.None); + ps.AddPermission(new FileIOPermission(PermissionState.Unrestricted)); + report1.ScriptRestrictions = ps; + report1.Prepare(); + + + + + + + Gets a reference to the graphics cache for this report. + + + This property is used to support the FastReport.Net infrastructure. Do not use it directly. + + + + + Gets a pages of the prepared report. + + + + + Gets a reference to the report engine. + + + This property can be used when report is running. In other cases it returns null. + + + + + Gets or sets the initial page number for PageN/PageNofM system variables. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + Gets the report operation that is currently performed. + + + + + Gets or sets the Tag object of the report. + + + + + Gets or sets the flag for refresh. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes the report's fields. + + + This method is for internal use only. + + + + + Generates the file (.cs or .vb) that contains the report source code. + + Name of the file. + + Use this method to generate the report source code. This code can be attached to your project. + In this case, you will need to call the following code to run a report: + + SimpleListReport report = new SimpleListReport(); + report.RegisterData(your_dataset); + report.Show(); + + + + + + Calculates an expression and returns the result. + + The expression to calculate. + If report is running, returns the result of calculation. + Otherwise returns null. + + The expression may be any valid expression such as "1 + 2". The expression + is calculated in the report script's ReportScript class instance context, + so you may refer to any objects available in this context: private fields, + methods, report objects. + + + + + Calculates an expression and returns the result. + + The expression to calculate. + The value of currently printing object. + If report is running, returns the result of calculation. + Otherwise returns null. + + Do not call this method directly. Use the Calc(string expression) method instead. + + + + + Returns an expression value. + + The expression. + The value of currently printing object. + Returns the result of calculation. + + This method is for internal use only, do not call it directly. + + + + + Invokes the script method with given name. + + The name of the script method. + The method parameters. + + + + Gets the data column's value. Automatically converts null value to 0, false or "" + depending on the column type. + + The name of the data column including the datasource name. + If report is running, returns the column value. Otherwise returns null. + + The return value of this method does not depend on the property. + + + + string employeeName = (string)report.GetColumnValue("Employees.FirstName"); + + + + + + Gets the data column's value. This method does not convert null values. + + The name of the data column including the datasource name. + If report is running, returns the column value. + Otherwise returns null. + + + + Gets the report parameter with given name. + + The name of the parameter. + The object if found, otherwise null. + + To find nested parameter, use the "." separator: "MainParameter.NestedParameter" + + + + + Gets a value of the parameter with given name. + + The name of the parameter. + The parameter's value if found, otherwise null. + + To find nested parameter, use the "." separator: "MainParameter.NestedParameter" + + + + + Sets the parameter's value. + + The name of the parameter. + Value to set. + + Use this method to pass a value to the parameter that you've created in the "Data" window. + Such parameter may be used everythere in a report; for example, you can print its value + or use it in expressions. + You should call this method after the report was loaded and before you run it. + To access a nested parameter, use the "." separator: "MainParameter.NestedParameter" + + This method will create the parameter if it does not exist. + + + This example shows how to pass a value to the parameter with "MyParam" name: + + // load the report + report1.Load("report.frx"); + // setup the parameter + report1.SetParameterValue("MyParam", 10); + // show the report + report1.Show(); + + + + + + Gets a value of the system variable with specified name. + + Name of a variable. + The variable's value if found, otherwise null. + + + + Gets a value of the total with specified name. + + Name of total. + The total's value if found, otherwise 0. + This method converts null values to 0 if the property is set to true. + Use the method if you don't want the null conversion. + + + + + Gets a value of the total with specified name. + + Name of total. + The total's value if found, otherwise null. + + + + Gets the datasource with specified name. + + Alias name of a datasource. + The datasource object if found, otherwise null. + + + + + + + Aborts the report execution. + + + + + + + + + + + Updates the report component's styles. + + + Call this method if you change the collection. + + + + + Sets prepared pages. + + + + + + This method fires the StartReport event and the script code connected + to the StartReportEvent. + + + + + This method fires the FinishReport event and the script code connected + to the FinishReportEvent. + + + + + Runs the Export event. + + ExportReportEventArgs object. + + + + Add the name of the assembly (in addition to the default) that will be used to compile the report script + + Assembly name + + For example: report.AddReferencedAssembly("Newtonsoft.Json.dll") + + + + + Add the names of the assembly (in addition to the default) that will be used to compile the report script + + Assembly's names + + + + + + + + + + Saves the report to a stream. + + The stream to save to. + + + + Saves the report to a file. + + The name of the file to save to. + + + + Saves the report to a stream with randomized values in data sources. + + The stream to save to. + + + + Saves the report to a file with randomized values in data sources. + + The name of the file to save to. + + + + Loads report from a stream. + + The stream to load from. + + When you try to load the password-protected report, you will be asked + for a password. You also may specify the password in the + property before loading the report. In this case the report will load silently. + + + + + Loads the report from a file. + + The name of the file to load from. + + When you try to load the password-protected report, you will be asked + for a password. You also may specify the password in the + property before loading the report. In this case the report will load silently. + + + + + Loads the report from a string. + + The string that contains a stream in UTF8 or Base64 encoding. + + + + Saves the report to a string. + + The string that contains a stream. + + + + Saves the report to a string using the Base64 encoding. + + The string that contains a stream. + + + + Creates the report instance and loads the report from a stream. + + The stream to load from. + The new report instance. + + + + Creates the report instance and loads the report from a file. + + The name of the file to load from. + The new report instance. + + + + Creates the report instance and loads the report from a string. + + The string that contains a stream in UTF8 encoding. + The new report instance. + + + + Registers the application dataset with all its tables and relations to use it in the report. + + The application data. + + If you register more than one dataset, use the method. + + + + report1.Load("report.frx"); + report1.RegisterData(dataSet1); + + + + + + Registers the application dataset with all its tables and relations to use it in the report and enables all its tables. + + The application data. + The boolean value indicating whether all tables should be enabled. + + If you register more than one dataset, use the method. + + + + report1.Load("report.frx"); + report1.RegisterData(dataSet1, true); + + + + + + Registers the application dataset with specified name. + + The application data. + The name of the data. + + Use this method if you register more than one dataset. You may specify any value + for the name parameter: it is not displayed anywhere in the designer and used only + to load/save a report. The name must be persistent and unique for each registered dataset. + + + + report1.Load("report.frx"); + report1.RegisterData(dataSet1, "NorthWind"); + + + + + + Registers the application dataset with specified name and enables all its tables. + + The application data. + The name of the data. + The boolean value indicating whether all tables should be enabled. + + Use this method if you register more than one dataset. You may specify any value + for the name parameter: it is not displayed anywhere in the designer and used only + to load/save a report. The name must be persistent and unique for each registered dataset. + + + + report1.Load("report.frx"); + report1.RegisterData(dataSet1, "NorthWind", true); + + + + + + Registers the application data table to use it in the report. + + The application data. + The name of the data. + + + report1.Load("report.frx"); + report1.RegisterData(dataSet1.Tables["Orders"], "Orders"); + + + + + + Registers the application data view to use it in the report. + + The application data. + The name of the data. + + + report1.Load("report.frx"); + report1.RegisterData(myDataView, "OrdersView"); + + + + + + Registers the application data relation to use it in the report. + + The application data. + The name of the data. + + You may specify any value for the name parameter: it is not displayed anywhere + in the designer and used only to load/save a report. The name must be persistent + and unique for each registered relation. + + + + report1.Load("report.frx"); + report1.RegisterData(myDataRelation, "myRelation"); + + + + + + Obsolete. Registers the application business object to use it in the report. + + Application data. + Name of the data. + Not used. + Maximum nesting level of business objects. + + This method is obsolete. Use the method instead. + + + + + Registers the application business object to use it in the report. + + Application data. + Name of the data. + + + report1.Load("report.frx"); + report1.RegisterData(myBusinessObject, "Customers"); + + + + + + Registers the application business object to use it in the report. + + Application data. + Name of the data. + Maximum nesting level of business objects. + + This method creates initial datasource with specified nesting level. It is useful if + you create a report in code. In most cases, you don't need to specify the nesting level + because it may be selected in the designer's "Choose Report Data" dialog. + + + + + Registers the application cube link to use it in the report. + + The application data. + The name of the data. + + + report1.Load("report.frx"); + report1.RegisterData(myCubeLink, "Orders"); + + + + + + Prepares the report. + + true if report was prepared succesfully. + + + + Prepares the report. + + Specifies whether the new report should be added to a + report that was prepared before. + true if report was prepared succesfully. + + Use this method to merge prepared reports. + + This example shows how to merge two reports and preview the result: + + Report report = new Report(); + report.Load("report1.frx"); + report.Prepare(); + report.Load("report2.frx"); + report.Prepare(true); + report.ShowPrepared(); + + + + + + Prepares the report with pages limit. + + Pages limit. The number of pages equal or less will be prepared. + true if report was prepared succesfully. + + + + For internal use only. + + + + + For internal use only. + + + + + Refresh the current report. + + + Call this method in the Click or MouseUp event handler of a report object to refresh + the currently previewed report. Report will be generated again, but without dialog forms. + + + + + Refresh prepared report after interactive actions. + + + + + Serialize report object from string + + Serialized report object from string + + + + Prepare page + + + + + + Exports a report. Report should be prepared using the method. + + The export filter. + Stream to save export result to. + + + + Exports a report. Report should be prepared using the method. + + The export filter. + File name to save export result to. + + + + Saves the prepared report. Report should be prepared using the method. + + File name to save to. + + + + Saves the prepared report. Report should be prepared using the method. + + Stream to save to. + + + + Loads the prepared report from a .fpx file. + + File name to load form. + + + + Loads the prepared report from a .fpx file. + + Stream to load from. + + + + Initializes a new instance of the class with default settings. + + + + + Ensure that static constructor is called. + + + + + Create name for all unnamed elements with prefix and start with number + + Prefix for name + Number from which to start + + + + Base methods for GS1 DataBar barcodes. + + + + + Routine to generate widths for GS1 elements for a given value. + + Required value. + Number of modules. + Elements in a set (GS1 omni based and Expanded = 4; GS1 Limited = 7). + Maximum module width of an element. + False will skip patterns without a one module wide element. + Element widths + + + + + + + + Returns the number of Combinations of r selected from n. + + + + Drawing lines of strokes + + Encoded data in width strokes; For separate line, these are colored strokes, any value that is not equal to zero is black. + + Scale size. + Use left of rectangle for to set start position x, top for top pos y, bottom for bottom pos y of strokes. + Flag for reversing color by default first strokes white, disabled for separate line. + Flag separete line + + + + + + + Generates the GS1 DataBar Omnidirectional barcode. + + + + + Get value for encoding. + + Data + + + + + + + + Generates the GS1 DataBar Stacked barcode. + + + + + + + + Generates the GS1 DataBar Stacked Omnidirectional barcode. + + + + + + + + Generates the GS1 DataBar Limited barcode. + + + + + Get value for encoding. + + Data + + + + + + + + Represents a class that contains all parameters of Swiss QR Code. + + + + + IBAN object + + + + + (either EUR or CHF) + + + + + Creditor (payee) information + + + + + Reference information + + + + + Can be null + + + + + Debitor (payer) information + + + + + Amount + + + + + Optional command for alternative processing mode - line 1 + + + + + Optional command for alternative processing mode - line 2 + + + + + Creates an additional information object. Both parameters are optional and must be shorter than 141 chars in combination. + + Unstructured text message + Bill information + + + + Creates a reference object which must be passed to the SwissQrCode instance + + Type of the reference (QRR, SCOR or NON) + Reference text + Type of the reference text (QR-reference or Creditor Reference) + + + + Reference type. When using a QR-IBAN you have to use either "QRR" or "SCOR" + + + + + Contact type. Can be used for payee, ultimate payee, etc. with address in structured mode (S). + + Last name or company (optional first name) + Zip-/Postcode + City name + Two-letter country code as defined in ISO 3166-1 + Streetname without house number + House number + + + + Contact type. Can be used for payee, ultimate payee, etc. with address in combined mode (K). + + Last name or company (optional first name) + Two-letter country code as defined in ISO 3166-1 + Adress line 1 + Adress line 2 + + + + IBAN object with type information + + IBAN + Type of IBAN (normal or QR-IBAN) + + + + Represents a barcode object. + Represents a barcode object. + + + The instance of this class represents a barcode. Here are some common + actions that can be performed with this object: + + + To select the type of barcode, use the property. + + + + To specify a static barcode data, use the property. + You also may use the or properties + to specify dynamic value for a barcode. + + + + To set a barcode orientation, use the property. + + + + To specify the size of barcode, set the property + to true and use the property to zoom the barcode. + If property is set to false, you need to specify the + size using the Width and + Height properties. + + + + + This example shows how to configure the BarcodeObject to display PDF417 barcode. + + BarcodeObject barcode; + ... + barcode.Barcode = new BarcodePDF417(); + (barcode.Barcode as BarcodePDF417).CompactionMode = CompactionMode.Text; + + + + + + + + + + + + + + + + + + + + + + + + Specifies the horizontal alignment of a Barcode object. Works only when autosize is on. + + + + + Specifies that the barcode is aligned to the left of the original layout. + + + + + Specifies that the barcode is aligned to the center of the original layout. + + + + + Specifies that the barcode is aligned to the right of the original layout. + + + + + Gets or sets the barcode type. + + + + + Gets or sets the horizontal alignment of a Barcode object. + + + + + Gets or sets the symbology name. + + + The following symbology names are supported: + + "2/5 Interleaved" + "2/5 Industrial" + "2/5 Matrix" + "Codabar" + "Code128" + "Code39" + "Code39 Extended" + "Code93" + "Code93 Extended" + "EAN8" + "EAN13" + "MSI" + "PostNet" + "UPC-A" + "UPC-E0" + "UPC-E1" + "Supplement 2" + "Supplement 5" + "PDF417" + "Datamatrix" + "QRCode" + + + + + barcode.SymbologyName = "PDF417"; + (barcode.Barcode as BarcodePDF417).CompactionMode = CompactionMode.Text; + + + + + + Gets or sets the angle of barcode, in degrees. + + + + + Gets or sets a value that determines whether the barcode should handle its width automatically. + + + + + Gets or sets a data column name bound to this control. + + + Value must be in the form "Datasource.Column". + + + + + Gets or sets an expression that contains the barcode data. + + + + + Enable or disable of using an expression in Text + + + + + Gets or sets brackets for using in expressions + + + + + Gets or sets a value that indicates if the barcode should display a human-readable text. + + + + + Gets or sets the barcode data. + + + + + Gets or sets padding within the BarcodeObject. + + + + + Gets or sets a zoom of the barcode. + + + + + Gets or sets a value that determines whether it is necessary to hide the object if the + barcode data is empty. + + + + + Gets or sets the text that will be displayed if the barcode data is empty. + + + + + Gets or sets values for forced use of a bitmap image instead of a vector + + + + + Gets or sets values for hiding or showing barcode markers + + + + + Initialize current BarcodeObject as Swiss QR. + + Parameters of swiss qr. + + + + Relocate BarcodeObject based on alignment + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + + + + + + + + + + + Aztec 2D code representation + + Rustam Abdullaev + + + + Compact or full symbol indicator + + + + + Size in pixels (width and height) + + + + + Number of levels + + + + + Number of data codewords + + + + + The symbol image + + + + + The class holds the available options for the AztecWriter + + + + + Representing the minimal percentage of error correction words. + Note: an Aztec symbol should have a minimum of 25% EC words. + + + + + Specifies the required number of layers for an Aztec code: + a negative number (-1, -2, -3, -4) specifies a compact Aztec code + 0 indicates to use the minimum number of layers (the default) + a positive number (1, 2, .. 32) specifies a normal (non-compact) Aztec code + + + + + A simple, fast array of bits, represented compactly by an array of ints internally. + + Sean Owen + + + Flips bit i. + + + bit to set + + + + + Gets the next set. + + first bit to check + index of first bit that is set, starting from the given index, or size if none are set + at or beyond this given index + + + + see getNextSet(int) + + index to start looking for unset bit + index of next unset bit, or if none are unset until the end + + + Sets a block of 32 bits, starting at bit i. + + + first bit to set + + the new value of the next 32 bits. Note again that the least-significant bit + corresponds to bit i, the next-least-significant to i+1, and so on. + + + + + Sets a range of bits. + + start of range, inclusive. + end of range, exclusive + + + Clears all bits (sets to false). + + + Efficient method to check if a range of bits is set, or not set. + + + start of range, inclusive. + + end of range, exclusive + + if true, checks that bits in range are set, otherwise checks that they are not set + + true iff all bits are set or not set in range, according to value argument + + IllegalArgumentException if end is less than or equal to start + + + + Appends the bit. + + The bit. + + + underlying array of ints. The first element holds the first 32 bits, and the least + significant bit is bit 0. + + + + + Appends the least-significant bits, from value, in order from most-significant to + least-significant. For example, appending 6 bits from 0x000001E will append the bits + 0, 1, 1, 1, 1, 0 in that order. + + containing bits to append + bits from value to append + + + + Toes the bytes. + + first bit to start writing + array to write into. Bytes are written most-significant byte first. This is the opposite + of the internal representation, which is exposed by BitArray + position in array to start writing + how many bytes to write + + + Reverses all bits in the array. + + + + 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. + + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Erstellt ein neues Objekt, das eine Kopie der aktuellen Instanz darstellt. + + + Ein neues Objekt, das eine Kopie dieser Instanz darstellt. + + + + +

Represents a 2D matrix of bits. In function arguments below, and throughout the common + module, x is the column position, and y is the row position. The ordering is always x, y. + The origin is at the top-left.

+

Internally the bits are represented in a 1-D array of 32-bit ints. However, each row begins + with a new int. This is done intentionally so that we can copy out a row into a BitArray very + efficiently.

+

The ordering of bits is row-major. Within each int, the least significant bits are used first, + meaning they represent lower x values. This is compatible with BitArray's implementation.

+ + Sean Owen + dswitkin@google.com (Daniel Switkin) + + + The width of the matrix + + + + The height of the matrix + + + + This method is for compatibility with older code. It's only logical to call if the matrix + is square, so I'm throwing if that's not the case. + + + row/column dimension of this matrix + + + +

Gets the requested bit, where true means black.

+ + + The horizontal component (i.e. which column) + + The vertical component (i.e. which row) + + value of given bit in matrix + + + +

Flips the given bit.

+ + + The horizontal component (i.e. which column) + + The vertical component (i.e. which row) + + + + Clears all bits (sets to false). + + +

Sets a square region of the bit matrix to true.

+ + + The horizontal position to begin at (inclusive) + + The vertical position to begin at (inclusive) + + The width of the region + + The height of the region + + + + A fast method to retrieve one row of data from the matrix as a BitArray. + + + The row to retrieve + + An optional caller-allocated BitArray, will be allocated if null or too small + + The resulting BitArray - this reference should always be used even when passing + your own row + + + + + Sets the row. + + row to set + {@link BitArray} to copy from + + + + Modifies this {@code BitMatrix} to represent the same but rotated 180 degrees + + + + + This is useful in detecting the enclosing rectangle of a 'pure' barcode. + + {left,top,width,height} enclosing rectangle of all 1 bits, or null if it is all white + + + + This is useful in detecting a corner of a 'pure' barcode. + + {x,y} coordinate of top-left-most 1 bit, or null if it is all white + + + + These are a set of hints that you may pass to Writers to specify their behavior. + + dswitkin@google.com (Daniel Switkin) + + + + Specifies the width of the barcode image + type: + + + + + Specifies the height of the barcode image + type: + + + + + Don't put the content string into the output image. + type: + + + + + Specifies what character encoding to use where applicable. + type: + + + + + Specifies margin, in pixels, to use when generating the barcode. The meaning can vary + by format; for example it controls margin before and after the barcode horizontally for + most 1D formats. + type: + + + + + Specifies whether to use compact mode for PDF417. + type: + + + + + Don't append ECI segment. + That is against the specification of QR Code but some + readers have problems if the charset is switched from + ISO-8859-1 (default) to UTF-8 with the necessary ECI segment. + If you set the property to true you can use UTF-8 encoding + and the ECI segment is omitted. + type: + + + + + if true, don't switch to codeset C for numbers + + + + + Specifies the required number of layers for an Aztec code: + a negative number (-1, -2, -3, -4) specifies a compact Aztec code + 0 indicates to use the minimum number of layers (the default) + a positive number (1, 2, .. 32) specifies a normal (non-compact) Aztec code + + + + + Generates Aztec 2D barcodes. + + Rustam Abdullaev + + + + Encodes the given binary content as an Aztec symbol + + input data string + Aztec symbol matrix with metadata + + + + Encodes the given binary content as an Aztec symbol + + input data string + minimal percentage of error check words (According to ISO/IEC 24778:2008, + a minimum of 23% + 3 words is recommended) + if non-zero, a user-specified value for the number of layers + + Aztec symbol matrix with metadata + + + + + Defines an container for encoder options + + + + + Gets the data container for all options + + + + + Specifies the height of the barcode image + + + + + Specifies the width of the barcode image + + + + + Don't put the content string into the output image. + + + + + Specifies margin, in pixels, to use when generating the barcode. The meaning can vary + by format; for example it controls margin before and after the barcode horizontally for + most 1D formats. + + + + + Initializes a new instance of the class. + + + + +

This class contains utility methods for performing mathematical operations over + the Galois Fields. Operations use a given primitive polynomial in calculations.

+

Throughout this package, elements of the GF are represented as an {@code int} + for convenience and speed (but at the cost of memory). +

+ + Sean Owen + + + + Create a representation of GF(size) using the given primitive polynomial. + + irreducible polynomial whose coefficients are represented by + * the bits of an int, where the least-significant bit represents the constant + * coefficient + the size of the field + the factor b in the generator polynomial can be 0- or 1-based + * (g(x) = (x+a^b)(x+a^(b+1))...(x+a^(b+2t-1))). + * In most cases it should be 1, but for QR code it is 0. + + + + Builds the monomial. + + The degree. + The coefficient. + the monomial representing coefficient * x^degree + + + + Implements both addition and subtraction -- they are the same in GF(size). + + sum/difference of a and b + + + + Exps the specified a. + + 2 to the power of a in GF(size) + + + + Logs the specified a. + + A. + base 2 log of a in GF(size) + + + + Inverses the specified a. + + multiplicative inverse of a + + + + Multiplies the specified a with b. + + A. + The b. + product of a and b in GF(size) + + + + Gets the size. + + + + + Gets the generator base. + + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + +

Represents a polynomial whose coefficients are elements of a GF. + Instances of this class are immutable.

+

Much credit is due to William Rucklidge since portions of this code are an indirect + port of his C++ Reed-Solomon implementation.

+ + Sean Owen + + + + Initializes a new instance of the class. + + the {@link GenericGF} instance representing the field to use + to perform computations + coefficients as ints representing elements of GF(size), arranged + from most significant (highest-power term) coefficient to least significant + if argument is null or empty, + or if leading coefficient is 0 and this is not a + constant polynomial (that is, it is not the monomial "0") + + + + degree of this polynomial + + + + + Gets a value indicating whether this is zero. + + true iff this polynomial is the monomial "0" + + + + coefficient of x^degree term in this polynomial + + The degree. + coefficient of x^degree term in this polynomial + + + + evaluation of this polynomial at a given point + + A. + evaluation of this polynomial at a given point + + + + This produces nearly optimal encodings of text into the first-level of + encoding used by Aztec code. + It uses a dynamic algorithm. For each prefix of the string, it determines + a set of encodings that could lead to this prefix. We repeatedly add a + character and generate a new set of optimal encodings until we have read + through the entire input. + @author Frank Yellin + @author Rustam Abdullaev + + + + + Convert the text represented by this High Level Encoder into a BitArray. + + text represented by this encoder encoded as a + + + + Implements Reed-Solomon encoding, as the name implies. + + Sean Owen + William Rucklidge + + + + State represents all information about a sequence necessary to generate the current output. + Note that a state is immutable. + + + + + Create a new state representing this state with a latch to a (not + necessary different) mode, and then a code. + + + + + Create a new state representing this state, with a temporary shift + to a different mode to output a single value. + + + + + Create a new state representing this state, but an additional character + output in Binary Shift mode. + + + + + Create the state identical to this one, but we are no longer in + Binary Shift mode. + + + + + Returns true if "this" state is better (or equal) to be in than "that" + state under all possible circumstances. + + + + + Contains conversion support elements such as classes, interfaces and static methods. + + + + + Copies an array of chars obtained from a String into a specified array of chars + + The String to get the chars from + Position of the String to start getting the chars + Position of the String to end getting the chars + Array to return the chars + Position of the destination array of chars to start storing the chars + An array of chars + + + + Sets the capacity for the specified List + + The List which capacity will be set + The new capacity value + + + + Converts a string-Collection to an array + + The strings. + + + + + Joins all elements to one string. + + + The separator. + The values. + + + + + Fills the specified array. + (can't use extension method because of .Net 2.0 support) + + + The array. + The value. + + + + Fills the specified array. + (can't use extension method because of .Net 2.0 support) + + + The array. + The start index. + The end index. + The value. + + + + Generates the Code128 barcode. + + + This barcode supports three code pages: A, B and C. You need to set appropriate code page + in the barcode text, or use the auto encode feature. See the property + for more details. + + This example shows how to configure the BarcodeObject to display Code128 barcode. + + BarcodeObject barcode; + ... + barcode.Barcode = new Barcode128(); + (barcode.Barcode as Barcode128).AutoEncode = false; + + + + + + Gets or sets a value that determines whether the barcode should automatically + use appropriate encoding. + + + You may use this property to encode data automatically. If you set it to false, + you must specify the code page inside the data string. The following control codes are available: + + + Sequence + Code128 control code + + + &A; + START A / CODE A + + + &B; + START B / CODE B + + + &C; + START C / CODE C + + + + &S; + SHIFT + + + &1; + FNC1 + + + &2; + FNC2 + + + &3; + FNC3 + + + &4; + FNC4 + + + The following example shows how to specify control codes: + + BarcodeObject barcode; + barcode.Barcode = new Barcode128(); + (barcode.Barcode as Barcode128).AutoEncode = false; + barcode.Text = "&C;1234&A;ABC"; + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + The base class for 2D-barcodes such as PDF417 and Datamatrix. + + + + + + + + Generates the "2/5 Interleaved" barcode. + + + + + Initializes a new instance of the class with default settings. + + + + + Generates the "Deutsche Identcode" barcode. + + + + + Gets or sets a value that indicates that CheckSum should be printed. + + + + + + + + Initializes a new instance of the class with default settings. + + + + + + + + Generates the "Deutsche Leitcode" barcode. + + + + + Gets or sets a value that indicates that CheckSum should be printed. + + + + + + + + + + + Generates the "ITF-14" barcode. + + + + + Gets or sets the value indicating that vertical bearer bars are needed to draw. + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Generates the "2/5 Industrial" barcode. + + + + + Generates the "2/5 Matrix" barcode. + + + + + Initializes a new instance of the class with default settings. + + + + + Generates the Code39 barcode. + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Generates the Code39 extended barcode. + + + + + Generates the Code93 barcode. + + + + + + + + Generates the Code93 extended barcode. + + + + + Generates the 2D Aztec barcode. + + + + + Gets or sets the error correction percent. + + + + + Initializes a new instance of the class with default settings. + + + + + + + + The base class for all barcodes. + + + + + Gets the name of barcode. + + + + + Gets or sets the color of barcode. + + + + + Gets or sets the font of barcode. + + + + + Creates the exact copy of this barcode. + + The copy of this barcode. + + + + Assigns properties from other, similar barcode. + + Barcode object to assign properties from. + + + + Draws a barcode. + + The graphic surface. + Display rectangle. + + + + Initializes a new instance of the class with default settings. + + + + + Get default value of this barcode + + + + + + Generates the Codabar barcode. + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Specifies the Datamatrix encoding. + + + + + Specifies the auto encoding. + + + + + Specifies the ASCII encoding. + + + + + Specifies the C40 encoding. + + + + + Specifies the text encoding. + + + + + Specifies the binary encoding. + + + + + Specifies the X12 encoding. + + + + + Specifies the Edifact encoding. + + + + + Specifies the Datamatrix symbol size. + + + + + Specifies the auto size. + + + + + Specifies the 10x10 size. + + + + + Specifies the 12x12 size. + + + + + Specifies the 8x8 size. + + + + + Specifies the 14x14 size. + + + + + Specifies the 8x32 size. + + + + + Specifies the 16x16 size. + + + + + Specifies the 12x26 size. + + + + + Specifies the 18x18 size. + + + + + Specifies the 20x20 size. + + + + + Specifies the 12x36 size. + + + + + Specifies the 22x22 size. + + + + + Specifies the 16x36 size. + + + + + Specifies the 24x24 size. + + + + + Specifies the 26x26 size. + + + + + Specifies the 16x48 size. + + + + + Specifies the 32x32 size. + + + + + Specifies the 36x36 size. + + + + + Specifies the 40x40 size. + + + + + Specifies the 44x44 size. + + + + + Specifies the 48x48 size. + + + + + Specifies the 52x52 size. + + + + + Specifies the 64x64 size. + + + + + Specifies the 72x72 size. + + + + + Specifies the 80x80 size. + + + + + Specifies the 88x88 size. + + + + + Specifies the 96x96 size. + + + + + Specifies the 104x104 size. + + + + + Specifies the 120x120 size. + + + + + Specifies the 132x132 size. + + + + + Specifies the 144x144 size. + + + + + Generates the 2D Data Matrix barcode. + + + + + Gets or sets the symbol size. + + + + + Gets or sets the encoding mode. + + + + + Gets or sets the code page used for text conversion. + + + Use this property to encode non-ASCII characters. For example, set this + property to 1251 to use Window CP1251. + + + + + Gets or sets the size of the pixel. + + + + + Gets or sets the value AutoEncode. + + + + + + + + Initializes a new instance of the class with default settings. + + + + + The base class for EAN barcodes. + + + + + Initializes a new instance of the class with default settings. + + + + + Generates the EAN8 barcode. + + + + + Generates the EAN13 barcode. + + + + + Initializes a new instance of the class with default settings. + + + + + Generates the GS1-128 (formerly known as UCC-128 or EAN-128) barcode. + + + + + Initializes a new instance of the class with default settings. + + + + + Generates the Intelligent Mail (USPS) barcode. + + + + + Gets or sets the value indicating that quiet zone must be shown. + + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Generates the 2D MaxiCode barcode. + + + + + Sets the MaxiCode mode to use. Only modes 2 to 6 are supported. + + + + + Initializes a new instance of the class with default settings. + + + + + + + Implements MaxiCode according to ISO 16023:2000. + + MaxiCode employs a pattern of hexagons around a central 'bulls-eye' + finder pattern. Encoding in several modes is supported, but encoding in + Mode 2 and 3 require primary messages to be set. Input characters can be + any from the ISO 8859-1 (Latin-1) character set. + + TODO: Add ECI functionality. + + @author Robin Stuart + @author Daniel Gredler + + + MaxiCode module sequence, from ISO/IEC 16023 Figure 5 (30 x 33 data grid). + + + ASCII character to Code Set mapping, from ISO/IEC 16023 Appendix A. + 1 = Set A, 2 = Set B, 3 = Set C, 4 = Set D, 5 = Set E. + 0 refers to special characters that fit into more than one set (e.g. GS). + + + ASCII character to symbol value, from ISO/IEC 16023 Appendix A. + + + Sets the MaxiCode mode to use. Only modes 2 to 6 are supported. + + @param mode the MaxiCode mode to use + + + Returns the MaxiCode mode being used. Only modes 2 to 6 are supported. + + @return the MaxiCode mode being used + + + If this MaxiCode symbol is part of a series of MaxiCode symbols appended in a structured format, this method sets the + position of this symbol in the series. Valid values are 1 through 8 inclusive. + + @param position the position of this MaxiCode symbol in the structured append series + + + Returns the position of this MaxiCode symbol in a series of symbols using structured append. If this symbol is not part of + such a series, this method will return 1. + + @return the position of this MaxiCode symbol in a series of symbols using structured append + + + If this MaxiCode symbol is part of a series of MaxiCode symbols appended in a structured format, this method sets the total + number of symbols in the series. Valid values are 1 through 8 inclusive. A value of 1 indicates that this symbol is not + part of a structured append series. + + @param total the total number of MaxiCode symbols in the structured append series + + + Returns the size of the series of MaxiCode symbols using structured append that this symbol is part of. If this symbol is + not part of a structured append series, this method will return 1. + + @return size of the series that this symbol is part of + + + Sets the primary data. Should only be used for modes 2 and 3. Must conform to the following structure: + + + + + + +
CharactersMeaning
1-9Postal code data which can consist of up to 9 digits (for mode 2) or up to 6 + alphanumeric characters (for mode 3). Remaining unused characters should be + filled with the SPACE character (ASCII 32).
10-12Three-digit country code according to ISO-3166.
13-15Three digit service code. This depends on your parcel courier.
+ + @param primary the primary data + + + Returns the primary data for this MaxiCode symbol. Should only be used for modes 2 and 3. + + @return the primary data for this MaxiCode symbol + + + {@inheritDoc} + + + Extracts the postal code, country code and service code from the primary data and returns the corresponding primary message + codewords. + + @return the primary message codewords + + + Returns the primary message codewords for mode 2. + + @param postcode the postal code + @param country the country code + @param service the service code + @return the primary message, as codewords + + + Returns the primary message codewords for mode 3. + + @param postcode the postal code + @param country the country code + @param service the service code + @return the primary message, as codewords + + + Formats text according to Appendix A, populating the {@link #set} and {@link #character} arrays. + + @return true if the content fits in this symbol and was formatted; false otherwise + + + Guesses the best set to use at the specified index by looking at the surrounding sets. In general, characters in + lower-numbered sets are more common, so we choose them if we can. If no good surrounding sets can be found, the default + value returned is the first value from the valid set. + + @param index the current index + @param Length the maximum Length to look at + @param valid the valid sets for this index + @return the best set to use at the specified index + + + Moves everything up so that the specified shift or latch character can be inserted. + + @param position the position beyond which everything needs to be shifted + @param c the latch or shift character to insert at the specified position, after everything has been shifted + + + Returns the error correction codewords for the specified data codewords. + + @param codewords the codewords that we need error correction codewords for + @param ecclen the number of error correction codewords needed + @return the error correction codewords for the specified data codewords + + + {@inheritDoc} + + + {@inheritDoc} + + + + Generates the MSI barcode. + + + + + Specifies the error correction level used for PDF417 barcode. + + + + + Indicates that correction level should be calculated automatically. + + + + + Specifies level 0. + + + + + Specifies level 1. + + + + + Specifies level 2. + + + + + Specifies level 3. + + + + + Specifies level 4. + + + + + Specifies level 5. + + + + + Specifies level 6. + + + + + Specifies level 7. + + + + + Specifies level 8. + + + + + Specifies the compaction mode used for PDF417 barcode. + + + + + Indicates that compaction mode should be calculated automatically. + + + + + Specifies the text compaction mode. + + + + + Specifies the numeric compaction mode. + + + + + Specifies the binary compaction mode. + + + + + Generates the 2D PDF417 barcode. + + This example shows how to configure the BarcodeObject to display PDF417 barcode. + + BarcodeObject barcode; + ... + barcode.Barcode = new BarcodePDF417(); + (barcode.Barcode as BarcodePDF417).CompactionMode = PDF417CompactionMode.Text; + + + + + + Gets or sets the barcode aspect ratio. + + + A ratio or 0.5 will make the barcode width twice as large as the height. + + + + + Gets or sets the number of barcode data columns. + + + To calculate the necessary number of columns and rows, set the + and properties to 0. In this case, the property + should be set to desired aspect ratio. + + + + + Gets or sets the number of barcode data rows. + + + To calculate the necessary number of columns and rows, set the + and properties to 0. In this case, the property + should be set to desired aspect ratio. + + + + + Gets or sets the error level correction used for the barcode. + + + + + Gets or sets the code page used for text conversion. + + + Use this property to encode non-ASCII characters. For example, set this + property to 1251 to use Window CP1251. + + + + + Gets or sets the compaction mode. + + + + + Gets or sets the size of the pixel. + + + + Paints the barcode. If no exception was thrown a valid barcode is available. + + + + + + + Initializes a new instance of the class with default settings. + + + + + Generates the Pharmacode barcode. + + + + + Gets or sets the value indicating that quiet zone must be shown. + + + + + + + + Initializes a new instance of the class with default settings. + + + + + + + + Generates the Plessey barcode. + + + + + Appends the given pattern to the target array starting at pos. + + encode black/white pattern into this array + position to start encoding at in target + lengths of black/white runs to encode + starting color - false for white, true for black + the number of elements added to target. + + + + Generates the PostNet barcode. + + + + + Generates the Japan Post 4 State Code barcode. + + + + + Specifies the QR code error correction level. + + + + + L = ~7% correction. + + + + + M = ~15% correction. + + + + + Q = ~25% correction. + + + + + H = ~30% correction. + + + + + Specifies the QR Code encoding. + + + + + UTF-8 encoding. + + + + + ISO 8859-1 encoding. + + + + + Shift_JIS encoding. + + + + + Windows-1251 encoding. + + + + + cp866 encoding. + + + + + Generates the 2D QR code barcode. + + + + + Gets or sets the error correction. + + + + + Gets or sets the encoding used for text conversion. + + + + + Gets or sets the value indicating that quiet zone must be shown. + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Generates the UPC E0 barcode. + + + + + Initializes a new instance of the class with default settings. + + + + + Generates the UPC E1 barcode. + + + + + Generates the UPC A barcode. + + + + + Generates the 2-digit supplement barcode. + + + + + Initializes a new instance of the class with default settings. + + + + + Generates the 5-digit supplement barcode. + + + + + The base class for linear (1D) barcodes. + + + + + Gets or sets a value that determines if the barcode object should calculate + the check digit automatically. + + + + + Gets or sets a relative width of wide bars in the barcode. + + + + + Gets the value indicating that the barcode is numeric. + + + + + Gets or sets a value indicating that leading/trailing whitespaces must be trimmed. + + + true if trim; otherwise, false. + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Storage service that replaces direct manipulations with Config.Root xml storage. + + + + + Determines if the key has a value. + + The key to check. + True if the key has a non-empty value. + + + + Determines if the storage is not empty. + + + + + Gets a string value. + + The key. + Default value. + The value associated with a key, or default value. + + + + Gets a bool value. + + The key. + Default value. + The value associated with a key, or default value. + + + + Gets an int value. + + The key. + Default value. + The value associated with a key, or default value. + + + + Gets a float value. + + The key. + Default value. + The value associated with a key, or default value. + + + + Gets an enum value. + + The key. + Default value. + The value associated with a key, or default value. + + + + Reads a serializable object. + + The object to read. + + + + Sets a string value. + + The key. + Value associated with a key. + + + + Sets a bool value as a 0/1. + + The key. + Value associated with a key. + + + + Sets a bool value as a False/True. + + The key. + Value associated with a key. + + + + Sets an int value. + + The key. + Value associated with a key. + + + + Sets a float value. + + The key. + Value associated with a key. + + + + Sets an enum value. + + The key. + Value associated with a key. + + + + Writes a serializable object. + + The object to write. + + + + Initializes a new instance of a storage. + + The comma-separated path. + + + + Storage service for form's controls. + + + + + Use device independent pixels (measured in 96dpi mode). + + + + + Gets value in device-independent pixels (dips) and converts it to pixels. Takes property into account. + + The key. + Default value. + Minimum value. + Maximum value. + Value in dips. + + + + Stores value in device-independent pixels (dips). Takes property into account. + + The key. + Value. + + + + Gets font from font storage. + + Path to font storage. + Default value. + The font object. + + + + Initializes a new instance of storage class. + + The control which dpi setting is used to save/restore dips. + The root path. + + + + Storage service for forms. + + + + + Saves the form state to the configuration file. + + + + + Restores the form state from the configuration file. + + + + + Gets font from font storage. + + Element name from font storage. + Default value. + The font object. + + + + Initializes a new instance of storage class. + + The form which state will be saved/restored. + + + + Starts Windows process correctly for CoreWin, Net, Mono + + + + + Specifies the behaviour of compiler when exception is thrown. + + + + + Default behaviour. Throw exception. + + + + + Show exception message and replace incorrect expression by Placeholder. + + + + + Replace expression with exception message. Don't show any messages. + + + + + Replace exception with Placeholder value. Don't show any messages. + + + + + Contains compiler settings. + + + + + Gets or set the string that will be used for replacing incorrect expressions. + + + + + Gets or sets the behaviour of compiler when exception is thrown. + + + + + Get or sets number of recompiles + + + Report compiler can try to fix compilation errors and recompile your report again. This property sets the number of such attempts. + + + + + Initializes a new instance of the class. + + + + + Class for handling Exports visibility in the Preview control. + + + + + Gets an instance of ExportOptions. + + An ExportOptions instance. + + + + All exports available in the Preview control. + + + + + Occurs once right before restore exports state. + + + Use this event to configure the default exports state or add your own exports. + + + + + Occurs once right after restore exports state. + + + You may use this event to disable some exports, for example: + Config.PreviewSettings.Exports &= ~PreviewExports.PDFExport; + Doing so before state is restored may not take an effect. + + + + + Sets Export category visibility. + + Export category name. + Visibility state. + + + + Sets Export visibility. + + Export type. + Visibility state. + + + + Exports menu node. + + + + + Gets or sets the name. + + + + + Gets child nodes. + + + + + Gets the parent node. + + + + + Gets the root node. + + + + + Gets or sets the type of the export. + + + + + Gets or sets the display text. + + + + + Gets or sets the image index. + + + + + Gets or sets the image. + + + + + Gets or sets the tag. + + + + + Gets or sets a value that indicates whether the node is enabled. + + + + + Adds a category. + + The category key name. + The image index. + The category node. + + + + Adds a category. + + The category key name. + The category display text. + The image. + The category node. + + + + Adds an export and registers it. + + The export type. + The display text. + The image index. + Returns this object to allow method chaining. + + + + Adds an export and registers it. + + The export type. + The display text. + The image. + Returns this object to allow method chaining. + + + + Represents a collection of nodes. + + + + + + + + + + + Returns true if the node is a category. + + + + + Returns true if the node is an export. + + + + + Returns true if the node is a cloud export. + + + + + Returns true if the node is a category. + + + + + Adds a cloud export and registers it. + + The export type. + The display text. + The image index. + Returns this object to allow method chaining. + + + + Adds a messenger and registers it. + + The export type. + The display text. + The image index. + Returns this object to allow method chaining. + + + + + + + All cloud exports available in the preview. + + + + + All messengers exports available in the preview. + + + + + Resets the export nodes to default state. + + + + + A wrapper around PrivateFontCollection. + + + A wrapper around PrivateFontCollection. + + + + + Gets the array of FontFamily objects associated with this collection. + + + + + Checks if the font name is contained in this collection. + + The name of the font. + true if the font is contained in this collection. + + + + Returns the font's stream. + + The name of the font. + Either FileStream or MemoryStream containing font data. + + + + Adds a font from the specified file to this collection. + + A System.String that contains the file name of the font to add. + true if the font is registered by application. + + + + Adds a font contained in system memory to this collection. + + The memory address of the font to add. + The memory length of the font to add. + + + + The pseudo-random generator. + + + + + Gets a random letter in same case that source character. + + The source character. + The random character. + + + + Gets random int value from 0 to 9. + + Random int value. + + + + Gets random int value from 0 to max. + + The maximum for random digit. + Random int value. + + + + Gets random int value from min to max. + + The minimum for random digit. + The maximum for random digit. + Random int value. + + + + Gets number of random digits from 0 to 9. + + The number of digits. + Number of random digits. + + + + Gets the random byte value. + + Random byte value. + + + + Gets random byte array with specified number of elements. + + The number of elements in array. + Random byte array. + + + + Gets the randomized char value. + + Random char value. + + + + Gets the random day from start to DataTime.Today. + + The starting DateTime value. + Random DateTime value. + + + + Gets the randomized TimeSpan value beetwin specified hours. + + The starting hour (0 - 24). + The ending hour (0 - 24). + Random TimeSpan value. + + + + Gets the randomized decimal value with same number of digits that in source value. + + The source decimal value. + Random decimal value based on source. + + + + Gets the randomized double value with same number of digits that in source value. + + The source double value. + Random double value based on source. + + + + Gets the randomized Int16 value with same number of digits that in source value. + + The source Int16 value. + Random Int16 value based on source. + + + + Gets the randomized Int32 value with same number of digits that in source value. + + The source Int32 value. + Random Int32 value based on source. + + + + Gets the randomized Int64 value with same number of digits that in source value. + + The source Int64 value. + Random Int64 value based on source. + + + + Gets the randomized SByte value with same number of digits that in source value. + + The source SByte value. + Random SByte value based on source. + + + + Gets the randomized Single value with same number of digits that in source value. + + The source Single value. + Random Single value based on source. + + + + Gets the randomized string with same length and same whitespaces that in source string. + + The source string. + Random string based on source string. + + + + Gets the randomized UInt16 value with same number of digits that in source value. + + The source UInt16 value. + Random UInt16 value based on source. + + + + Gets the randomized UInt32 value with same number of digits that in source value. + + The source UInt32 value. + Random UInt32 value based on source. + + + + Gets the randomized UInt64 value with same number of digits that in source value. + + The source UInt64 value. + Random UInt64 value based on source. + + + + Gets randomized object based on the source object. + + The source object. + The type of object. + Random object based on source. + + + + Randomizes datasources. + + Collection of datasources. + + + + Initializes a new instance of the class. + + + + + Represents information about column. + + + + + Gets or sets the type of column. + + + + + Gets or sets the length of column. + + + + + Initializes a new instance of the class. + + The type of column. + The lenght of column. + + + + Represents random value of field. + + + + + Gets or sets the original value of field. + + + + + Gets or sets the random value of field. + + + + + Initializes a new instance of the class. + + The original value of field. + The random value of field. + + + + Represents collection of random values of field. + + + + + Initializes a new instance of the class. + + + + + Adds an object to the end of this collection. + + Object to add. + + + + Determines whether an element with the same origin value is in the collection. + + The object to locate in the collection. + true if object is found in the collection; otherwise, false. + + + + Determines whether an element with the same random value is in the collection. + + The object to locate in the collection. + true if object is found in the collection; otherwise, false. + + + + Gets the random value for specified origin. + + The origin value. + The random value. + + + + Contains methods used for validation of report. + + + + + Validate report. + + + Need set false if enabled backlight intersecting objects and report is designing. + Token for cancelling method if it execute in thread. + List of errors. + + + + Contains some configuration properties and settings that will be applied to the FastReport.Net + environment, including Report, Designer and Preview components. + + + + + Gets an english culture information for localization purposes + + + + + Gets dictionary of shortcut key. + + + + + Gets or sets a value indicating whether hotkeys should be disabled. + + + + + Gets or sets a value indicating saving last formatting should be disabled. + + + + + Gets or sets a value indicating that UI library must use high dpi compatible rendering. + + This flag is false by default. Turn it on at the application start if you need + better appearance of custom drawn UI items in high dpi mode. This however may result in + wrong appearance on multi-monitor setup. + /// + + + + Gets or sets the settings for the report designer window. + + + + + Gets or sets the UI style. + + + This property affects both designer and preview windows. + + + + + Gets or sets a value indicating whether the Ribbon UI should be used + + + + + Gets or sets a value indicating whether the designer window should use the compact menu (Visual Studio - alike). + + + The compact menu is currently supported in WPF only. + + + + + Gets or sets a value indicating of displaying the connection string. + If false, the connection string is hidden from the interface. + + + + + Gets or set the current icon pack index. Default is 0 (classic). + + Set this property at the application start. + + + + Gets or sets a value indicating whether SplashScreen should be displayed while loading designer + + + + + Gets or sets a value indicating whether Welcome window feature enabled. + If false, interface elements associated with the Welcome window will not be visible. + + + + + Gets or sets a value indicating whether Welcome window shoud be displayed on startup + + + + + Gets the folder to store auto save files + + + + + Gets or sets the default folder for SaveFileDialog. + + + + + Gets the autosaved report + + + + + Gets the autosaved report path + + + + + Is necessary to process abort and some other events in parallel + + + + + Gets a value indicating that the ASP.NET hosting permission level is set to full trust. + + + + + Gets or sets a value that determines whether to disable some functionality to run in web mode. + + + Use this property if you use FastReport in ASP.Net. Set this property to true before + you access any FastReport .NET objects. + + + + + Gets or sets the settings for the "Send Email" window. + + + + + Restores the form state from the configuration file. + + The form to restore. + Obsolete. Use either BaseForm.Storage or . + + + + Saves the form state to the configuration file. + + The form to save. + Obsolete. Use either BaseForm.Storage or . + + + + Create a dictionary of default keyboard shortcuts. + + + + + + Save default settings and user tokens. + Is user have to consent to save data, clear the data in the config file. + + + + + Save default settings and user tokens. + By default internal use only, it is able to be a public + + + + + Gets or sets the settings for the preview window. + + + + + Gets a value indicating that the Mono runtime is used. + + + + + Gets or sets a value indicating is it impossible to specify a local data path in Xml and Csv. + + + + + Gets or sets the optimization of strings. Is experimental feature. + + + + + Enable or disable the compression in files with prepared reports (fpx). + + + + + Gets or sets the application folder. + + + + + Gets or sets the path used to load/save the configuration file. + + + By default, the configuration file is saved to the application local data folder + (C:\Documents and Settings\User_Name\Local Settings\Application Data\FastReport\). + Set this property to "" if you want to store the configuration file in the application folder. + + + + + Gets or sets the path used to font.list file. + + + By default, the font.list file is saved to the FastReport.config folder + If WebMode enabled (or config file path is null), then file is saved in the application folder. + + + + + Gets or sets the settings for the Report component. + + + + + Gets or sets a value indicating whether RTL layout should be used. + + + + + Gets the root item of config xml. + + + + + Gets or sets the path to the temporary folder used to store temporary files. + + + The default value is null, so the system temp folder will be used. + + + + + Gets the path to the system temporary folder used to store temporary files. + + + + + Gets FastReport version. + + + + + Called on script compile + + + + + Gets a PrivateFontCollection instance. + + + + + Enable report script validation. For WebMode only + + + + + Throws when property EnableScriptSecurity has been changed + + + + + Properties of report script validation + + + + + Settings of report compiler. + + + + + Warms up the Roslyn compiler asynchronously. + + + Call this method at an application start to warm up the Roslyn compiler (used in NetCore). + + + + + Properties of ScriptSecurity + + + + + Add stubs for the most dangerous classes (in System.IO, System.Reflection etc) + + + + + List of keywords that shouldn't be declared in the report script + + + + + Throws when has changed + + + + + Sets default value for + + + + + Get access to font collection + + + + + Additional check FamilyName in function FastReport.Utils.FromString(Type type, string value); + By default option is set to FALSE value and engine works in classic mode. + If option is set to TRUE value, then engine checks family name of report's font and trying to find correct font within PrivateFontCollection. + + + + + Holds the information about the registered object. + + + + + Image index. + + + + + Button index. + + + + + Flags that will be used to create an object instance in the designer. + + + + + Indicates whether this object can be inserted several times simultaneously. + + + This is applied to Line object only. + + + + + Name of object or category. + + + + + The registered object. + + + + + The registered function. + + + + + Tooltip text. + + + + + Gets or sets the enabled flag for the object. + + + + + Enumerates all objects. + + List that will contain enumerated items. + + + + + + + + + + + + + + + + + + + Contains all registered report items such as objects, export filters, wizards. + + + Use this class to register own components, wizards, export filters or another items that + need to be serialized to/from a report file. + + + + // register own wizard + RegisteredObjects.AddWizard(typeof(MyWizard), myWizBmp, "My Wizard", true); + // register own export filter + RegisteredObjects.AddExport(typeof(MyExport), "My Export"); + // register own report object + RegisteredObjects.Add(typeof(MyObject), "ReportPage", myObjBmp, "My Object"); + + + + + + Registers a new cloud storage client. + + Type of cloud storage client. + Text for cloud storage client's menu item. + + The obj must be of type. + + + + // register own cloud storage client + RegisteredObjects.AddCloud(typeof(MyCloud), "My Cloud"); + + + + + + Registers a new messenger. + + Type of messenger. + Text messenger's menu item. + + The obj must be of type. + + + + // register own messenger + RegisteredObjects.AddMessenger(typeof(MyMessenger), "My Messenger"); + + + + + + Registers a new wizard. + + Type of wizard. + Image for wizard item. + Text for wizard item. + true if this wizard creates some items in existing report. + + The obj must be of type. + + This example shows how to register own wizard that is used to create some items in the + current report. If you want to register a wizard that will be used to create a new report, + set the isReportItemWizard to false. + + // register own wizard + RegisteredObjects.AddWizard(typeof(MyWizard), myWizBmp, "My Wizard", true); + + + + + + Root object for all registered objects. + + + + + Root object for all registered exports. + + + + + Root object for all registered DataConnections + + + + + Root object for all registered functions. + + + + + Checks whether the specified type is registered already. + + Type to check. + true if such type is registered. + + + + Registers a category that may contain several report objects. + + Category name. + Image for category button. + Text for category button. + + Category is a button on the "Objects" toolbar that shows context menu with nested items + when you click it. Consider using categories if you register several report objects. It can + save space on the "Objects" toolbar. For example, FastReport registers one category called "Shapes" + that contains the LineObject and different types of ShapeObject. + The name of category must starts either with "ReportPage," or "DialogPage," depending on + what kind of controls do you need to regiter in this category: report objects or dialog controls. + After the comma, specify the category name. So the full category name that you need to specify + in the name parameter, must be something like this: "ReportPage,Shapes". + + When register an object inside a category, you must specify the full category name in the + category parameter of the Add method. + + + + + Obsolete. Use api instead. + + + + + Obsolete. Use api instead. + + + + + Obsolete. Use api instead. + + + + + Registers custom data connection. + + Type of connection. + Name of connection. + + The obj must be of type. + + + + // register data connection + RegisteredObjects.AddConnection(typeof(MyDataConnection), "My Data Connection"); + + + + + + Registers an object in the specified category. + + Type of object to register. + Name of category to register in. + Index of image for object's button. + Index of object's button in toolbar. + + + + Registers an object in the specified category with button's image, text, object's flags and multi-insert flag. + + Type of object to register. + Name of category to register in. + Image for object's button. + Text for object's button. + Integer value that will be passed to object's OnBeforeInsert method. + Specifies whether the object may be inserted several times until you + select the "arrow" button or insert another object. + + You must specify either the page type name or existing category name in the category parameter. + The report objects must be registered in the "ReportPage" category or custom category that is + registered in the "ReportPage" as well. The dialog controls must be registered in the "DialogPage" + category or custom category that is registered in the "DialogPage" as well. + If you want to register an object that needs to be serialized, but you don't want + to show it on the toolbar, pass empty string in the category parameter. + + To learn about flags, see the method. + + + + // register the report object + RegisteredObjects.Add(typeof(MyReportObject), "ReportPage", myReportObjectBmp, "My Report Object"); + // register the dialog control + RegisteredObjects.Add(typeof(MyDialogControl), "DialogPage", myDialogControlBmp, "My Dialog Control"); + // add a category and register an object inside it + RegisteredObjects.AddCategory("ReportPage,MyCategory", myCategoryBmp, "My Category"); + // register another report object in MyCategory + RegisteredObjects.Add(typeof(MyReportObject), "ReportPage,MyCategory", + anotherReportObjectBmp, "Another Report Object"); + + + + + + Adds a new function category. + + Short name of category. + Display name of category. + + Short name is used to reference the category in the subsequent + method call. It may be any value, for example, "MyFuncs". Display name of category is displayed + in the "Data" window. In may be, for example, "My Functions". + The following standard categories are registered by default: + + + "Math" + + + "Text" + + + "DateTime" + + + "Formatting" + + + "Conversion" + + + "ProgramFlow" + + + + + This example shows how to register a new category: + + RegisteredObjects.AddFunctionCategory("MyFuncs", "My Functions"); + + + + + + Adds a new function into the specified category. + + MethodInfo containing all necessary information about the function. + The name of category to register the function in. + + Your function must be a static, public method of a public class. + The following standard categories are registered by default: + + + "Math" + + + "Text" + + + "DateTime" + + + "Formatting" + + + "Conversion" + + + "ProgramFlow" + + + You may use one of the standard categories, or create a new category by the + method call. + FastReport uses XML comments to display your function's description. + To generate XML comments, enable it in your project's properties + ("Project|Properties..." menu, "Build" tab, enable the "XML documentation file" checkbox). + + + The following example shows how to register own functions: + + public static class MyFunctions + { + /// <summary> + /// Converts a specified string to uppercase. + /// </summary> + /// <param name="s">The string to convert.</param> + /// <returns>A string in uppercase.</returns> + public static string MyUpperCase(string s) + { + return s == null ? "" : s.ToUpper(); + } + + /// <summary> + /// Returns the larger of two 32-bit signed integers. + /// </summary> + /// <param name="val1">The first of two values to compare.</param> + /// <param name="val2">The second of two values to compare.</param> + /// <returns>Parameter val1 or val2, whichever is larger.</returns> + public static int MyMaximum(int val1, int val2) + { + return Math.Max(val1, val2); + } + + /// <summary> + /// Returns the larger of two 64-bit signed integers. + /// </summary> + /// <param name="val1">The first of two values to compare.</param> + /// <param name="val2">The second of two values to compare.</param> + /// <returns>Parameter val1 or val2, whichever is larger.</returns> + public static long MyMaximum(long val1, long val2) + { + return Math.Max(val1, val2); + } + } + + // register a category + RegisteredObjects.AddFunctionCategory("MyFuncs", "My Functions"); + + // obtain MethodInfo for our functions + Type myType = typeof(MyFunctions); + MethodInfo myUpperCaseFunc = myType.GetMethod("MyUpperCase"); + MethodInfo myMaximumIntFunc = myType.GetMethod("MyMaximum", new Type[] { typeof(int), typeof(int) }); + MethodInfo myMaximumLongFunc = myType.GetMethod("MyMaximum", new Type[] { typeof(long), typeof(long) }); + + // register simple function + RegisteredObjects.AddFunction(myUpperCaseFunc, "MyFuncs"); + + // register overridden functions + RegisteredObjects.AddFunction(myMaximumIntFunc, "MyFuncs,MyMaximum"); + RegisteredObjects.AddFunction(myMaximumLongFunc, "MyFuncs,MyMaximum"); + + + + + + Finds the registered object's info. + + The type of object to find. + The object's info. + This method can be used to disable some objects, for example: + RegisteredObjects.FindObject(typeof(PDFExport)).Enabled = false; + + + + + Register and override the method with method name in the type. + For property use the property name and _Get or _Set suffix. + + Type for registering method + Name of method fir registering + Method for registering + + + + Gets the method or null if method is not found + + Type for method finding + Name for method finfing + Use True value for inheritance the method from base type, use false for get the method only from the this type + + + + + Used to get localized values from the language resource file. + + + The resource file used by default is english. To load another locale, call + the method. It should be done at application start + before you use any FastReport classes. + + + + + Adds user image to 96 dpi images. + + User image (16x16 pixels). + Image index in the image list. + + + + Gets the standard images used in FastReport as an ImageList. + + ImageList object that contains standard images. + + FastReport contains about 240 truecolor images of 16x16 size that are stored in one + big image side-by-side. This image can be found in FastReport resources (the "buttons.png" resource). + + + + + Gets an image with specified index. + + Image index (zero-based). + Dpi value (96 for base dpi). + The image with specified index. + + FastReport contains about 240 truecolor images of 16x16 size that are stored in one + big image side-by-side. This image can be found in FastReport resources (the "buttons.png" resource). + + + + + Gets an image with specified name from resources. + + The name of image resource. + Dpi value (96 for base dpi). + The image. + + + + Gets an image with specified index and converts it to Icon. + + Image index (zero-based). + Dpi value (96 for base dpi). + The Icon object. + + + + Gets or set the folder that contains localization files (*.frl). + + + + + Returns the current UI locale name, for example "en". + + + + + Loads the locale from a file. + + The name of the file that contains localized strings. + + + + Loads and caches the locale from information. + Notes: *.frl the localization file is looked for in + To work correctly, it is recommended to install FastReport.Localization package + + + + + + Loads the locale from a stream. + + The stream that contains localized strings. + + + + Loads the english locale. + + + + + Gets a string with specified ID. + + The resource ID. + The localized string. + + Since the locale file is xml-based, it may contain several xml node levels. For example, + the file contains the following items: + + <Objects> + <Report Text="Report"/> + <Bands Text="Bands"> + <ReportTitle Text="Report Title"/> + </Bands> + </Objects> + + To get the localized "ReportTitle" value, you should pass the following ID + to this method: "Objects,Bands,ReportTitle". + + + + + Get builtin string. + + + + + + + Replaces the specified locale string with the new value. + + Comma-separated path to the existing locale string. + The new string. + + Use this method if you want to replace some existing locale value with the new one. + + + + Res.Set("Messages,SaveChanges", "My text that will appear when you close the designer"); + + + + + + Tries to get a string with specified ID. + + The resource ID. + The localized value, if specified ID exists; otherwise, the ID itself. + + + + Tries to get builtin string with specified ID. + + + + + + + Checks if specified ID exists. + + The resource ID. + true if specified ID exists. + + + + Resource loader class. + + + + + Gets a bitmap from specified assembly resource. + + Assembly name. + Resource name. + Bitmap object. + + + + Gets a bitmap from specified FastReport assembly resource. + + Resource name. + Bitmap object. + + + + Gets a cursor from specified assembly resource. + + Assembly name. + Resource name. + Cursor object. + + + + Gets a cursor from specified FastReport assembly resource. + + Resource name. + Cursor object. + + + + Gets an icon from specified assembly resource. + + Assembly name. + Resource name. + Icon object. + + + + Gets an icon from specified FastReport assembly resource. + + Resource name. + Icon object. + + + + Gets a stream from specified assembly resource. + + Assembly name. + Resource name. + Stream object. + + + + Gets a stream from FastReport assembly resource. + + Resource name. + Stream object. + + + + Gets a stream from specified assembly resource and unpacks it. + + Assembly name. + Resource name. + Stream object. + + + + Gets a stream from specified FastReport assembly resource and unpacks it. + + Resource name. + Stream object. + + + + A static class that contains methods to auto-convert rtl layout. + + + + + Changes control's layout to rtl. + + + + + + Draws an image and a text. + + The control which is used to determine RTL and DPI settings. + The draw event args. + The image. + The text. + This method is used to draw items in an owner-drawn listboxes and comboboxes. It respects RTL and DPI settings of a control. + + + + Draws control's border. + + The control. + The graphics. + The bounds. + + + + Gets current dpi value for the control. + + The control. + The dpi value. + + + + Gets current dpi multiplier for the control (1.0 for 96dpi). + + The control. + The dpi multiplier. + + + + Gets current font dpi multiplier for the control (1.0 for 96dpi). + + The return value depends on the base resolution of the main screen. + The control. + The font dpi multiplier. + + + + Converts logical units to device units (pixels). + + The control. + Logical units. + Device units. + + + + Converts logical units to device units (pixels). + + The control. + Logical units. + Device units. + + + + Converts logical units to device units (pixels). + + The control. + Logical units. + Device units. + + + + Converts logical units to device units (pixels). + + The control. + Logical units. + Device units. + + + + Converts logical units to device units (pixels). + + The control. + Logical units. + Device units. + + + + Converts logical font to device font. + + The control. + Logical font. + Determines whether to dispose the original font or not. + Device font. + + + + Returns an image from resources using control's dpi value. + + The control. + Image index. + An image with specified index from "buttons.png" resource. + + + + Returns an image from resources using control's dpi value. + + The control. + Image name. + An image with specified index from "buttons.png" resource. + + + + Returns an imagelist from resources using control's dpi value. + + The control. + An imagelist from "buttons.png" resource. + + + + The style of FastReport user interface. + + + + + Specifies the Microsoft Office 2003 style (blue). + + + + + Specifies the Microsoft Office 2007 style (blue). + + + + + Specifies the Microsoft Office 2007 style (silver). + + + + + Specifies the Microsoft Office 2007 style (black). + + + + + Specifies the Office 2010 (Blue) style. + + + + + Specifies the Office 2010 (Silver) style. + + + + + Specifies the Office 2010 (Black) style. + + + + + Specifies the Office 2013 style. + + + + + Specifies the Microsoft Visual Studio 2005 style. + + + + + Specifies the Visual Studio 2010 style. + + + + + Specifies the Visual Studio 2012 (Light) style. + + + + + Specifies the Microsoft Vista style (black). + + + + + Contains conversion methods between FastReport's UIStyle to various enums. + + + + + Contains visual style names. + + + + + Converts FastReport's UIStyle to eDotNetBarStyle. + + Style to convert. + Value of eDotNetBarStyle type. + + + + Converts FastReport's UIStyle to eTabStripStyle. + + Style to convert. + Value of eTabStripStyle type. + + + + Converts FastReport's UIStyle to eTabStripStyle. + + Style to convert. + Value of eTabStripStyle type. + + + + Converts FastReport's UIStyle to eOffice2007ColorScheme. + + Style to convert. + Value of eOffice2007ColorScheme type. + + + + Returns app workspace color for the given style. + + UI style. + The color. + + + + Returns control color for the given style. + + UI style. + The color. + + + + Contains methods to call common editors. + + + Use this class if you are writing a new component for FastReport. + + + + + Invokes the expression editor. + + A reference to the report. + The expression to edit. + The new expression. + + + + Invokes the border editor. + + The Border to edit. + The new border. + + + + Invokes the data band columns editor. + + The data band columns to edit. + + + + + Invokes the fill editor. + + The fill to edit. + The new fill. + + + + Invokes the outline editor. + + The outline to edit. + The new outline. + + + + Invokes the text editor. + + A reference to the report. May be null + The text to edit. + True to hide data tree part. + The new text. + + + + Contains methods that peform string to object and vice versa conversions. + + + + + Converts an object to a string. + + The object to convert. + The string that contains the converted value. + + + + Converts a value to a string using the specified converter. + + The object to convert. + The type of converter. + The string that contains the converted value. + + + + Converts a string value to the specified data type. + + The data type to convert to. + The string to convert from. + The object of type specified in the type parameter that contains + a converted value. + + + + Converts a string to an object using the specified converter. + + The string to convert. + The type of converter. + The object that contains the converted value. + + + + Converts a string containing special symbols to the xml-compatible string. + + The string to convert. + The result string. + + This method replaces some special symbols like <, > into xml-compatible + form: &lt;, &gt;. To convert such string back to original form, use the + method. + + + + + Converts a string containing special symbols to the xml-compatible string. + + The string to convert. + Determines whether it is necessary to convert cr-lf symbols to xml form. + The result string. + + + + Converts a value to xml-compatible string. + + The value to convert. + The result string. + + + + Convert the xml-compatible string to the regular one. + + The string to convert. + The result string. + + This is counterpart to the method. + + + + + Decreases the precision of floating-point value. + + The initial value. + The number of decimal digits in the fraction. + The value with lesser precision. + + + + Converts a string value to the float. + + The string value to convert. + The float value. + + Both "." or "," decimal separators are allowed. + + + + + Converts a string value to the float. + + The string value to convert. + Indicates whether to ignore non-digit symbols. + The float value. + + + + Converts a string value to the float. + + The string value to convert. + Decimal separator. + The float value. + + + + Converts a string value to the float. + + The string value to convert. + Decimal separator. + Indicates whether to ignore non-digit symbols. + The float value. + + + + Converts the string containing several text lines to a collection of strings. + + The string to convert. + The collection instance. + + + + Converts a collection of strings to a string. + + The collection to convert. + The string that contains all lines from the collection. + + + + Converts null value to 0, false, empty string, depending on type. + + The data type. + The value of the type data type. + + + + Converts string value to byte[]. + + The string to convert + The value of the byte[] data type. + + + + Converts a string to NameValueCollection. + + The string to convert. + The NameValueCollection that contains the name/value pairs. + + + + Convert &amp;&Tab;&quot; etc to symbol and return result as string + + String for processing + Position for processing + Result of processing + True if successful + + + + Convert &amp;&Tab;&quot; etc to symbol and return result as string + + String for processing + Position for processing + Append result of processing to FastString + True if successful + + + + Provides the message functions. + + + + + Shows the Message Box with error message. + + The message. + + + + Shows Message Box with confirmation. + + The message. + The dialog buttons. + The dialog result. + + + + Shows information Message Box. + + The message. + + + + The profiler. + + + + + Starts the profiler. + + + + + Finishes the profiler and displays results. + + + + + Script security event arguments. + + + + + Gets the report language. + + The report language. + + + + Gets the report. + + The report. + + + + Gets the report script. + + The report script. + + + + Gets the references of script. + + Script references + + + + Gets or sets value if script is allowed to compile + + true if is valid; otherwise, false. + + + + Initializes a new instance of the class. + + Report. + Report's script. + Report's references. + + + + Base class for plugin's assembly initializer. + + + FastReport has an open architecture. That means you can extend it with own classes + such as report objects, wizards, export filters. Usually such classes are + placed in separate dlls (plugins). FastReport has mechanism to load plugin dlls. You can specify + which plugins to load at first start, in the FastReport configuration file (by default it is located in the + C:\Documents and Settings\User_Name\Local Settings\Application Data\FastReport\FastReport.config file). + To do this, add an xml item with your plugin name inside the <Plugins> item: + + <?xml version="1.0" encoding="utf-8"?> + <Config> + <Plugins> + <Plugin Name="c:\Program Files\MyProgram\MyPlugin.dll"/> + </Plugins> + </Config> + + When you run your application and use the Report object first time, all plugins will be loaded. + To register objects contained in a plugin, FastReport searches for classes of type + AssemblyInitializerBase and instantiates them. + Use this class to register custom report objects, controls, wizards, exports that + are contained in the assembly. To do this, make your own class of the AssemblyInitializerBase + type and override its default constructor. In the constructor, call RegisteredObjects.Add + methods to register all necessary items. + + + + + Registers plugins contained in this assembly. + + + This constructor is called automatically when the assembly is loaded. + + This example show how to create own assembly initializer to register own items. + + public class MyAssemblyInitializer : AssemblyInitializerBase + { + public MyAssemblyInitializer() + { + // register own wizard + RegisteredObjects.AddWizard(typeof(MyWizard), myWizBmp, "My Wizard", true); + // register own export filter + RegisteredObjects.AddExport(typeof(MyExport), "My Export"); + // register own report object + RegisteredObjects.Add(typeof(MyObject), "ReportPage", myObjBmp, "My Object"); + } + } + + + + + + Source of image, only for inline img tag + + + + + Class for ACMYK color conversions + + + + + Alpha transparency 0..255 + + + + + Cyan 0..100 + + + + + Magenta 0..100 + + + + + Yellow 0..100 + + + + + Black 0..100 + + + + + Returns ACMYK as string. + + + + + + Gets CMYKA from string. + + + + + + Converts Color value to ACMYK + + + + + + Converts separate ARGB values in ACMYK + + + + + + + + + Returns ARGB color value + + + + + + Creates CMYKColor from ARGB values + + + + + + + + + Creates CMYKColor from ACMYK values + + + + + + + + + + Creates CMYKColor from string (comma separated values) + + + + + + Creates CMYKColor from Color value + + + + + + Color Utilities + + + + + Return true for CMYK Jpeg image + + + + + + + Calc the Crc32 checksum + + + + + Caclulate Streams checksum. + + + + + + + Calculate byte array checksum. + + + + + + + Calculate string checksum. + + + + + + + Begin the checksum + + + + + + Update the checksum + + + + + + + + + + End the checksum. + + + + + + + Contains methods used to crypt/decrypt a data. + + + + + Sets the password that is used to crypt connection strings stored in a report. + + + See the property for more details. + + + + + Crypts a stream using specified password. + + The destination stream that will receive the crypted data. + The password. + The stream that you need to write to. + + Pass the stream you need to write to, to the dest parameter. Write your data to the + stream that this method returns. When you close this stream, the dest stream will be + closed too and contains the crypted data. + + + + + Decrypts a stream using specified password. + + Stream that contains crypted data. + The password. + The stream that contains decrypted data. + + You should read from the stream that this method returns. + + + + + Checks if the stream contains a crypt signature. + + Stream to check. + true if stream is crypted. + + + + Encrypts the string using the default password. + + String to encrypt. + The encrypted string. + + The password used to encrypt a string can be set via property. + You also may use the method if you want to + specify another password. + + + + + Encrypts the string using specified password. + + String to encrypt. + The password. + The encrypted string. + + + + Decrypts the string using the default password. + + String to decrypt. + The decrypted string. + + The password used to decrypt a string can be set via property. + You also may use the method if you want to + specify another password. + + + + + Decrypts the string using specified password. + + String to decrypt. + The password. + The decrypted string. + + + + Computes hash of specified stream. Initial position in stream will be saved. + + Initial stream + + + + + Computes hash of specified array. + + Initial array + + + + + Computes hash of specified array. + + Initial array + + + + + MurmurHash is a non-cryptographic hash function suitable for general hash-based lookup. + It was created by Austin Appleby in 2008 and is currently hosted on Github along with its test suite named 'SMHasher'. + It also exists in a number of variants, all of which have been released into the public domain. + The name comes from two basic operations, multiply (MU) and rotate (R), used in its inner loop. + https://en.wikipedia.org/wiki/MurmurHash + Implementation of Murmur3 Hash by Adam Horvath + http://blog.teamleadnet.com/2012/08/murmurhash3-ultra-fast-hash-algorithm.html + + + + + READ_SIZE + + + + + ComputeHash function + + + + + + + Gets the Hash + + + + + Used to draw a text with non-standard angle or justification. + + + + + Draws a string. + + String to draw. + Graphics object to draw on. + Font that used to draw text. + Brush that determines the color and texture 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. + Horizontal alignment of the text. + Width ratio of the font used to draw a string. + Line height, in pixels. + Angle of the text, in degrees. + Indicates whther to draw string close to the printout. + Force justify for the last line. + + + + Initializes a new instance of the DrawText class with default settings. + + + + + The method adjusts the dotted line style for the in a graphical context. + + Collection of values for custom dash pattern. + Pen for lines. + Border around the report object. + + If a DashPattern pattern is specified and contains elements, the method checks each element. + If the element is less than or equal to 0, it is replaced by 1.
+ Then the resulting array of patterns is converted to the type and set as a dotted line pattern for the .
+ If the pattern is empty or not specified, + the method sets the style of the dotted line of the equal to the style of the dotted line of the object. + + + + + Draws control to a bitmap. + + Control to draw. + Determines whether to draw control's children or not. + The bitmap. + + + + The exception that is thrown when the user tried to set object's name that is already exists. + + + + + The exception that is thrown when the user tried to rename an object that is introduced in the ancestor report. + + + + + The exception that is thrown when the user tried to rename an object that is introduced in the ancestor report. + + + + + The exception that is thrown when loading bad formed xml report file. + + + + + The exception that is thrown when loading an encrypted report with wrong password. + + + + + The exception that is thrown if there is an error in the report's script code. + + + + + The exception that is thrown when trying to set an object's Parent property to + an object that not accepts children of this type. + + + + + The exception that is thrown when trying to load a report file that contains reference to an + unknown object type. + + + + + The exception that is thrown when initializing a table datasource which + TableName or Alias is not set properly. + + + + + The exception that is thrown when trying to access a row of a datasource that is not initialized yet. + + + + + The exception that is thrown if an error occurs in the TableObject.ManualBuild event. + + + + + The exception that is thrown if an error occurs in the MatrixObject.ManualBuild event. + + + + + The exception that is thrown if a report object's Name property is set to wrong value. + + + + + The exception that is thrown if an unknown value is supplied to some methods dealing with totals, variables etc. + + + + + throws this exception if an error occurs in the SaveReport method. + See inner exception for detailed information. + + + + + The exception that is thrown when the Group Header has no group condition. + + + + + The exception that is thrown when the image cannot be loaded. + + + + + The helper class used to create unique component names using the fastest method. + + + Note: you can create unique component's name using its CreateUniqueName method. + However, it is very slow and can't be used in some situations (when you create a report + layout in a code and have a lot of objects on a page). + + This example demonstrates how to use this class. + + FastNameCreator nameCreator = new FastNameCreator(Report.AllObjects); + foreach (Base c in Report.AllObjects) + { + if (c.Name == "") + nameCreator.CreateUniqueName(c); + } + + + + + + Creates the unique name for the given object. + + The object to create name for. + + + + Initializes a new instance of the FastNameCreator class with collection of + existing report objects. + + The collection of existing report objects. + + + + Fast alternative of StringBuilder. + + + + + Gets the Length of string. + + + + + Gets or sets the chars of string. + + + Char value + + + + Gets StringBuilder + + + + + Initialize the new array for chars. + + Length of initial array. + + + + Checks the empty array. + + True if string is empty. + + + + Converts the array in string. + + String value. + + + + Clears the string. + + FastString object. + + + + Appends the string by string value. + + String value. + FastString object. + + + + Appends the string by string value. + + String value. + FastString object. + + + + Append formatted string. + + + + + + + + Appends new line. + + FastString object. + + + + Appends the string by char value. + + Char value. + FastString object. + + + + Appends the another FastString object. + + FastString object. + FastString object. + + + + Appends the string by object data. + + Object value. + FastString object. + + + + Copies the substring in char array. + + Start index in source. + Destination array. + Destination index. + Count of chars + + + + Removes substring. + + Start index of removed string. + Length of removed string. + FastString object. + + + + Inserts string. + + Start index in existing string. + Value of inserting string. + FastString object. + + + + Replacing the substring on other. + + Old string value. + New string value. + FastString object. + + + + Index of substring. + + Substring for search. + Sarting position for search. + Position of substring. + + + + Compare of substring in position. + + Starting index for comparsion. + Value for compare. + True if substring is identical in position. + + + + Returns the substring. + + Starting index. + Length of substring. + Substring. + + + + Creates the new FastString object with initial capacity. + + Initial capacity. + + + + Creates the new FastString object with default capacity. + + + + + Creates the new FastString object from initial string. + + + + + + Represents a collection of float values. + + + + + Gets or sets the value at the specified index. + + Index of a value. + The value at the specified index. + + + + Adds the specified values to the end of this collection. + + + + + + Adds a value to the end of this collection. + + Value to add. + Index of the added value. + + + + Inserts a value into this collection at the specified index. + + The zero-based index at which value should be inserted. + The value to insert. + + + + Removes the specified value from the collection. + + Value to remove. + + + + Returns the zero-based index of the first occurrence of a value. + + The value to locate in the collection. + The zero-based index of the first occurrence of value within the entire collection, if found; + otherwise, -1. + + + + Determines whether a value is in the collection. + + The value to locate in the collection. + true if value is found in the collection; otherwise, false. + + + + Copies values from another collection. + + Collection to copy from. + + + + Represents a collection of FastReport base objects. + + + + + Gets an owner of this collection. + + + + + Adds the specified elements to the end of this collection. + + Range of elements. + + + + Adds the specified elements to the end of this collection. + + Collection of elements. + + + + Adds an object to the end of this collection. + + Object to add. + Index of the added object. + + + + Inserts an object into this collection at the specified index. + + The zero-based index at which value should be inserted. + The object to insert. + + + + Removes the specified object from the collection. + + Object to remove. + + + + Returns the zero-based index of the first occurrence of an object. + + The object to locate in the collection. + The zero-based index of the first occurrence of value within the entire collection, if found; + otherwise, -1. + + + + Determines whether an element is in the collection. + + The object to locate in the collection. + true if object is found in the collection; otherwise, false. + + + + Returns an array of collection items. + + + + + + Determines whether two collections are equal. + + The collection to compare with. + true if collections are equal; false otherwise. + + + + Copies the content to another collection. + + The collection to copy to. + + + + + + + + + + + + + Initializes a new instance of the FRCollectionBase class with default settings. + + + + + Initializes a new instance of the FRCollectionBase class with specified owner. + + The owner of this collection. + + + + Specifies the main mode of the designer's workspace. + + + + + Specifies selection mode. + + + + + Specifies insertion mode. + + + + + Specifies drag-drop mode. + + + + + Specifies the additional mode of the designer's workspace. + + + + + Specifies default mode. + + + + + Indicates that user moves the selected objects. + + + + + Indicates that user resizes the selected objects. + + + + + Indicates that user draw the selection rectangle. + + + + + Specifies a custom mode handled by the object. + + + + + Provides a data for mouse events. + + + + + The X mouse coordinate. + + + + + The Y mouse coordinate. + + + + + Current state of mouse buttons. + + + + + Current keyboard state. + + + + + Indicates that current object was handled the mouse message. + + + + + The delta of the mouse movement. + + + + + The mouse wheel delta. + + + + + Current cursor shape. + + + + + Additional mode of the designer's workspace. + + + + + Current sizing point if Mode is set to Size. + + + + + Current selection rectangle if mode is set to SelectionRect. + + + + + Active object that handles the mouse event. + + + + + The source object of drag-drop operation. + + + + + Multiple sources objects of drag-drop operation. + + + + + The target object of drag-drop operation. + + + + + The message to show when drag source is over the object. + + + + + Additional data supplied and handled by report objects. + + + + + Specifies the sizing point used to resize an object by mouse. + + + + + No sizing point. + + + + + Specifies left-top sizing point. + + + + + Specifies left-bottom sizing point. + + + + + Specifies right-top sizing point. + + + + + Specifies right-bottom sizing point. + + + + + Specifies top-center sizing point. + + + + + Specifies bottom-center sizing point. + + + + + Specifies left-center sizing point. + + + + + Specifies right-center sizing point. + + + + + Specifies a selection point used to resize an object. + + + + + The X coordinate of the point. + + + + + The Y coordinate of the point. + + + + + The size mode. + + + + + Initializes a new instance of the SelectionPoint class with specified location and size mode. + + The X coordinate. + The Y coordinate. + Size mode. + + + + Provides a data for paint event. + + + + + Gets a Graphics object to draw on. + + + + + Gets the X scale factor. + + + + + Gets the Y scale factor. + + + + + Gets the cache that contains graphics objects. + + + + + Initializes a new instance of the FRPaintEventArgs class with specified settings. + + IGraphicsRenderer object to draw on. + X scale factor. + Y scale factor. + Cache that contains graphics objects. + + + + Initializes a new instance of the FRPaintEventArgs class with specified settings. + + Graphics object to draw on. + X scale factor. + Y scale factor. + Cache that contains graphics objects. + + + + The reader used to deserialize object's properties from a report file. + + + + + Gets a string that contains errors occured during the load. + + + + + Gets the current item name. + + + + + Gets or sets a value indicating whther is necessary to read the object's children. + + + + + Returns Root element for this reader + + + + + Gets or sets target of serialization. + + + + + Reads the specified object. + + The object to read. + + The object must implement the interface. This method + invokes the Deserialize method of the object. + + This example demonstrates the use of ReadProperties, ReadChildren, + NextItem, Read methods. + + public void Deserialize(FRReader reader) + { + // read simple properties like "Text", complex properties like "Border.Lines" + reader.ReadProperties(this); + + // moves the current reader item + while (reader.NextItem()) + { + // read the "Styles" collection + if (String.Compare(reader.ItemName, "Styles", true) == 0) + reader.Read(Styles); + else if (reader.ReadChildren) + { + // if read of children is enabled, read them + Base obj = reader.Read(); + if (obj != null) + obj.Parent = this; + } + } + } + + + + + + Reads an object from current xml node. + + The object. + + This method creates an instance of object described by the current xml node, then invokes + its Deserialize method. + + This example demonstrates the use of ReadProperties, ReadChildren, + NextItem, Read methods. + + public void Deserialize(FRReader reader) + { + // read simple properties like "Text", complex properties like "Border.Lines" + reader.ReadProperties(this); + + // moves the current reader item + while (reader.NextItem()) + { + // read the "Styles" collection + if (String.Compare(reader.ItemName, "Styles", true) == 0) + reader.Read(Styles); + else if (reader.ReadChildren) + { + // if read of children is enabled, read them + Base obj = reader.Read(); + if (obj != null) + obj.Parent = this; + } + } + } + + + + + + Reads properties of specified object. + + The object to read. + + This method reads simple properties like "Text", "Border.Lines" etc. for specified object. + To read nested properties like collections, you should override the + method of an object. + + This example demonstrates the use of ReadProperties, ReadChildren, + NextItem, Read methods. + + public void Deserialize(FRReader reader) + { + // read simple properties like "Text", complex properties like "Border.Lines" + reader.ReadProperties(this); + + // moves the current reader item + while (reader.NextItem()) + { + // read the "Styles" collection + if (String.Compare(reader.ItemName, "Styles", true) == 0) + reader.Read(Styles); + else if (reader.ReadChildren) + { + // if read of children is enabled, read them + Base obj = reader.Read(); + if (obj != null) + obj.Parent = this; + } + } + } + + + + + + Moves the current xml item. + + false if there is no more items to move on; true otherwise. + + This method is used to read child objects. + + This example demonstrates the use of ReadProperties, ReadChildren, + NextItem, Read methods. + + public void Deserialize(FRReader reader) + { + // read simple properties like "Text", complex properties like "Border.Lines" + reader.ReadProperties(this); + + // moves the current reader item + while (reader.NextItem()) + { + // read the "Styles" collection + if (String.Compare(reader.ItemName, "Styles", true) == 0) + reader.Read(Styles); + else if (reader.ReadChildren) + { + // if read of children is enabled, read them + Base obj = reader.Read(); + if (obj != null) + obj.Parent = this; + } + } + } + + + + + + Checks if current item has specified property. + + The property name to check. + true if current item has specified property. + + + + Reads the string property. + + Name of property. + Property value. + + + + Reads the boolean property. + + Name of property. + Property value. + + + + Reads the integer property. + + Name of property. + Property value. + + + + Reads the float property. + + Name of property. + Property value. + + + + Reads the double property. + + Name of property. + Property value. + + + + Reads the enum property. + + Name of property. + Type of property. + Property value. + + + + Reads the standalone property value. + + Property value. + + + + Disposes the reader, fixups the property references. + + + + + Loads the xml items from a stream. + + The stream to load from. + + + + Initializes a new instance of the FRReader class with specified report. + + Reference to a report. + + + + Initializes a new instance of the FRReader class with specified report and xml item with + contents to read. + + Reference to a report. + Xml item with contents to read. + + + + Specifies the target for the serialize operation. + + + + + Serialize to the report file. + + + + + Serialize to the preview pages. + + + + + Serialize to the source pages of a preview. + + + + + Serialize to the designer's clipboard. + + + + + Serialize to the designer's undo/redo buffer. + + + + + The writer used to serialize object's properties to a report file. + + + + + Gets or sets current xml item name. + + + + + Gets or sets target of serialization. + + + + + Gets the ethalon object to compare with. + + + + + Gets or sets a value that determines whether is necessary to serialize child objects. + + + + + Gets or sets a value that determines whether is necessary to add xml header. + + + + + Serializes the specified object. + + The object to serialize. + + The object must implement the interface. This method + invokes the Serialize method of the object. + + This example demonstrates the use of writer. + + public void Serialize(FRWriter writer) + { + // get the etalon object. It will be used to write changed properties only. + Base c = writer.DiffObject as Base; + + // write the type name + writer.ItemName = ClassName; + + // write properties + if (Name != "") + writer.WriteStr("Name", Name); + if (Restrictions != c.Restrictions) + writer.WriteValue("Restrictions", Restrictions); + + // write child objects if allowed + if (writer.SaveChildren) + { + foreach (Base child in ChildObjects) + { + writer.Write(child); + } + } + } + + + + + + Serializes the object using specified etalon. + + The object to serialize. + The etalon object. + + + + Writes a string property. + + Property name. + Property value. + + + + Writes a boolean property. + + Property name. + Property value. + + + + Writes an integer property. + + Property name. + Property value. + + + + Writes a float property. + + Property name. + Property value. + + + + Writes a double property. + + Property name. + Property value. + + + + Writes an enumeration property. + + Property name. + Property value. + + + + Writes an object reference property. + + Property name. + Property value. + + + + Writes a standalone property value. + + Name of property. + Property value. + + This method produces the following output: + <PropertyName>PropertyValue</PropertyName> + + + + + Determines if two objects are equal. + + The first object. + The second object. + true if objects will be serialized to the same value. + + + + Disposes the writer. + + + + + Saves the writer output to a stream. + + Stream to save to. + + + + Initializes a new instance of the FRWriter class with default settings. + + + + + Initializes a new instance of the FRWriter class with specified xml item that will + receive writer's output. + + The xml item that will receive writer's output. + + + + Context of HTML rendering + It is better to put this structure instead of class' private fields. + For future optimization. Then we can avoid constructor with dozen arguments + + + + + Contexted version of HTML renderer + + + + + + Returns splited string + + text for splitting + index of first character of second string + second part of string + returns true if ends on enter + first part of string + + + + Check the line, and if last word is able to move next line, move it. + e.g. white space won't move to next line. + If word is not moved return current line. + else return new line + + the paragraph for lines + the line with extra words + the index of start last word in this line + width to place words + ref to current line width + ref to current word + + + + + Get start position of line. + + + if this parameter is true, the starting position of the line in the new paragraph will be returned + + + + + + Represents character placement. + + + + + Be care generates dictionary only one time + + + + + Return true if read char + + + + + + Represents a style used in HtmlTags mode. Color does not affect the equals function. + + + + + returns true if objects realy equals + + + + + + + Class that converts strings with Wingdings characters to Unicode strings. + + + + + Converts string with Wingdings characters to its Unicode analog. + + The string that should be converted. + + + + + Interface allows to load images with custom format or custom type + + + + + Returns true if image can be loaded + + + + + + + Returns true if image can be loaded + + + + + + + Try to load the image, must not throw exception! + + + + + + + + Try to load the image, must not throw exception! + + + + + + + + Internal calss for image processing + + + + + Register a new custom loader + + + + + + Load the image from bytes, Internal only method + + + + + + + Converts a PNG image to a icon (ico) + + The input image + The output stream + Preserve the aspect ratio + Wether or not the icon was succesfully generated + + + + Returns an Image format. + + + + + Tooltip text. + + + + + List of subitems. + + + + + Enumerates all objects. + + List that will contain enumerated items. + + + + Name of object or category. + + + + + Tooltip text. + + + + + The registered function. + + + + + Enumerates all objects. + + List that will contain enumerated items. + + + + The registered data connection. This type is subclass of + + + + + Tooltip text. + + + + + Used to access to resource IDs inside the specified branch. + + + Using the method, you have to specify the full path to your resource. + Using this class, you can shorten the path: + + // using the Res.Get method + miKeepTogether = new ToolStripMenuItem(Res.Get("ComponentMenu,HeaderBand,KeepTogether")); + miResetPageNumber = new ToolStripMenuItem(Res.Get("ComponentMenu,HeaderBand,ResetPageNumber")); + miRepeatOnEveryPage = new ToolStripMenuItem(Res.Get("ComponentMenu,HeaderBand,RepeatOnEveryPage")); + + // using MyRes.Get method + MyRes res = new MyRes("ComponentMenu,HeaderBand"); + miKeepTogether = new ToolStripMenuItem(res.Get("KeepTogether")); + miResetPageNumber = new ToolStripMenuItem(res.Get("ResetPageNumber")); + miRepeatOnEveryPage = new ToolStripMenuItem(res.Get("RepeatOnEveryPage")); + + + + + + + Gets a string with specified ID inside the main branch. + + The resource ID. + The localized value. + + + + Initializes a new instance of the class with spevified branch. + + The main resource branch. + + + + Localized CategoryAttribute class. + + + + + + + + Initializes a new instance of the SRCategory class. + + The category name. + + + + Advanced text renderer is used to perform the following tasks: + - draw justified text, text with custom line height, text containing html tags; + - calculate text height, get part of text that does not fit in the display rectangle; + - get paragraphs, lines, words and char sequence to perform accurate export to such + formats as PDF, TXT, RTF + + Here is how one may operate the renderer items: + + foreach (AdvancedTextRenderer.Paragraph paragraph in renderer.Paragraphs) + { + foreach (AdvancedTextRenderer.Line line in paragraph.Lines) + { + foreach (AdvancedTextRenderer.Word word in line.Words) + { + if (renderer.HtmlTags) + { + foreach (AdvancedTextRenderer.Run run in word.Runs) + { + using (Font f = run.GetFont()) + using (Brush b = run.GetBrush()) + { + g.DrawString(run.Text, f, b, run.Left, run.Top, renderer.Format); + } + } + } + else + { + g.DrawString(word.Text, renderer.Font, renderer.Brush, word.Left, word.Top, renderer.Format); + } + } + } + } + + + + + + The scale for font tag + + + + + Paragraph represents single paragraph. It consists of one or several . + + + + + Line represents single text line. It consists of one or several . + Simple line (that does not contain tabs, html tags, and is not justified) has + single which contains all the text. + + + + + Word represents single word. It may consist of one or several , in case + when HtmlTags are enabled in the main class. + + + + + Represents character placement. + + + + + Represents a style used in HtmlTags mode. + + + + + Represents sequence of characters that have the same . + + + + + Represents inline Image. + + + + + Standard text renderer uses standard DrawString method to draw text. It also supports: + - text rotation; + - fonts with non-standard width ratio. + In case your text is justified, or contains html tags, use the + class instead. + + + + + Cache for rendering img tags in textobject. + You can use only HTTP[s] protocol with absolute urls. + + + + + Is serialized + + + + + Get or set WebClient for downloading imgs by url + + + + + Occurs before image load + + + + + Occurs after image load + + + + + Enumerates all values + + + + + + Return CacheItem by src + + Src attribute from img tag + + + + + + + + + + + + Set CacheItem by src + + Src attribute from img tag + CacheItem + + + + + Validate src attribute from image + + Src attribute from img tag + return true if src is valid + + + + + + + + + + + + Item of image cache Dictionary + + + + + Get Base64 string + + + + + Return true if has some error with Image + + + + + Get Image + + + + + Get byte array + + + + + Return error image and set true to error property + + + + + + Set value for cache item + + Image encoded base64 string + + + + Set value for cache item + + Image + + + + Set value for cache item + + Image + + + + + + + + + + WebClientEventArgs + + + + + Gets a cache + + + + + Gets or sets a value indicating whether the event was handled. + + + + + Gets or sets a url from src attribue of img tag + + + + + + + + + + + The report page units. + + + + + Specifies the units measured in millimeters. + + + + + Specifies the units measured in centimeters. + + + + + Specifies the units measured in inches. + + + + + Specifies the units measured in hundreths of inch. + + + + + Defines the constants used to convert between report units and screen pixels. + + + To convert pixels to millimeters, use the following code: + valueInMillimeters = valueInPixels / Units.Millimeters; + To convert millimeters to pixels, use the following code: + valueInPixels = valueInMillimeters * Units.Millimeters; + + + + + The number of pixels in one millimeter. + + + + + The number of pixels in one centimeter. + + + + + The number of pixels in one inch. + + + + + The number of pixels in 1/10 of ich. + + + + + The number of pixels in 1/100 of inch. + + + + + File size units. + + + + + Bytes. + + + + + Kilobytes. + + + + + Megabytes. + + + + + Gigabytes. + + + + + Terobytes. + + + + + Convert numbers to file size (example 1 MB). + + + + + + + Represents a xml property. + + + + + Represents a property key. + + + + + Represents a property value. + + + + + Creates new property and assigns value + + Property key + Property value + + + + Represents a xml node. + + + + + Gets a number of children in this node. + + + + + Gets a list of children in this node. + + + + + Gets a child node with specified index. + + Index of node. + The node with specified index. + + + + Gets or sets the node name. + + + This property will return "Node" for a node like <Node Text="" Left="0"/> + + + + + Gets or sets a list of properties in this node. + + + + + Gets or sets the parent for this node. + + + + + Gets or sets the node value. + + + This property will return "ABC" for a node like <Node>ABC</Node> + + + + + Gets the root node which owns this node. + + + + + Clears the child nodes of this node. + + + + + Adds a new child node to this node. + + The new child node. + + + + Adds a specified node to this node. + + The node to add. + + + + Inserts a specified node to this node. + + Position to insert. + Node to insert. + + + + Finds the node with specified name. + + The name of node to find. + The node with specified name, if found; null otherwise. + + + + Finds the node with specified name. + + The name of node to find. + The node with specified name, if found; the new node otherwise. + + This method adds the node with specified name to the child nodes if it cannot find the node. + Do not dispose items, which has been created by this method + + + + + Gets the index of specified node in the child nodes list. + + The node to find. + Zero-based index of node, if found; -1 otherwise. + + + + Gets a property with specified name. + + The property name. + The value of property, if found; empty string otherwise. + + This property will return "0" when you request the "Left" property for a node + like <Node Text="" Left="0"/> + + + + + Removes all properties. + + + + + Sets the value for a specified property. + + The property name. + Value to set. + + For example, you have a node like <Node Text="" Left="0"/>. When you set the + "Text" property to "test", the node will be <Node Text="test" Left="0"/>. + If property with specified name is not exist, it will be added. + + + + + Removes a property with specified name. + + The property name. + Returns true if property is removed, false otherwise. + + + + Disposes the node and all its children. + + + + + Initializes a new instance of the XmlItem class with default settings. + + + + + Represents a xml document that contains the root xml node. + + + Use Load and Save methods to load/save the document. To access the root node + of the document, use the property. + + + + + Gets or sets a value indicating whether is necessary to indent the document + when saving it to a file/stream. + + + + + Gets or sets a value indicating whether is necessary to add xml header. + + + + + Gets or sets a value indicating whether is necessary to read xml header. + + + + + Gets the root node of the document. + + + + + Clears the document. + + + + + Saves the document to a stream. + + Stream to save to. + + + + Saves the document to a string. + + Writer to save to. + + + + Loads the document from a stream. + + Stream to load from. + + + + Saves the document to a file. + + The name of file to save to. + + + + Loads the document from a file. + + The name of file to load from. + + + + Disposes resources used by the document. + + + + + Initializes a new instance of the XmlDocument class with default settings. + + + + + + + + + + + + + Clear all files in archive. + + + + + Check for exisiting file in archive. + + + + + + + Adds the file form disk to the archive. + + + + + + Adds all files from directory (recursive) on the disk to the archive. + + + + + + Adds the stream to the archive. + + + + + + + Creates the zip and writes it to rhe Stream + + + + + + Creates the ZIP archive and writes it to the file. + + + + + + Gets or sets the Root Folder. + + + + + Gets or sets the errors. + + + + + Gets or sets the commentary to the archive. + + + + + Gets count of files in archive. + + + + + Creates the new zip archive. + + + + + Class helper for compile source code with path of assemblies + + + + + Generate a assembly in memory with some source code and several path for additional assemblies + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Service for working with auth in the Fast Report. + + + + + Instance of default Service. + + + + + Gets or sets indicator to enable or disable personalisation service + + + + + Setting of the service. + + + + + User of the service. + + + + + If FastReport.config contains information about custom server and api-key to it, + this method will reset inner instance with that data. Otherwise default server + will be set. + + + The method creates an sign in link. + + + + + + The method creates an sign out link. + + + + + + Returns true, if user has offline_access scope and refresh_token is not null + + + + + If possible, the method updates the user credentials. + + True if success + + + + The method resets auth, without sign out process. + + + + + The method shows sign in form and auth the user. + + + + + The method shows sign out form and resets the user credentials. + + + + + Do not make this method public, use refresh token for save-load.
+ You need only refresh token () to get a new token set.
+ This method is used to save time for starting a designer. + + + + + Class for store appsettings, by default appsettings is hardcoded. + + + + + Authorization Endpoint from the OAuth2 specification. + + + + + Host for callback requests. + + + + + Client identifier or client name from the OAuth2 specification. + + + + + Client secret or client name from the OAuth2 specification. + + + + + Code challenge method from the OAuth2 specification. + + + + + EndSession Endpoint from the OAuth2 specification. + + + + + Host for sign in requests + + + + + JSON Web Key Set Endpoint from the OAuth2 specification. + + + + + Error result + + + + + Redirent sign in link for this application. + + + + + Redirent sign out link for this application. + + + + + Success result + + + + + Type of the reponse from the OAuth2 specification. + + + + + Scopes for the request from the OAuth2 specification, splited by space. + + + + + Token Endpoint from the OAuth2 specification. + + + + + Avatar of the user, by default is 150x150 picture. + + + + + Returns the display avatar of the user, cannot return null + + + + + + Returns the display email of the user, cannot return null + + + + + + Returns the display name of the user, cannot return null + + + + + + Email of the user. + + + + + Local time when the token will go out. + + + + + Full name of the user. + + + + + Returns true if user is authenticated. + + + + + Returns true if token is expired and is need to referesh + + + + + Indicates that token is check by external method, see for details. + + + + + List of allowed scopes. + + + + + Identifier of the user. + + + + + Type of token for resource request header, e.g. Bearer. + + + + + Preferred username of the user. + + + + + User's api key. + + + + + Local time when the token needs to be updated. + + + + + Reset the values + + + + + Represents a combobox that allows to choose a color. + + + This control may be useful if you write own components for FastReport. + + + + + This event is raised when you select a color. + + + + + Gets or sets the selected color. + + + + + Gets or sets value indicating whether it is necessary to show a color name in a combobox. + + + + + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Represents a drop-down control that allows to choose a color. + + + This control may be useful if you write own components for FastReport. + + + + + This event is raised when you select a color. + + + + + Gets or sets the control that owns this dropdown. + + Set the Owner to onscreen control that initiates dropdown. This control will + be used to calculate dpi-dependent sizes. + + + + Gets or sets the selected color. + + + + + Sets the UI style. + + The style to set. + + + + + + + Initializes a new instance of the class with default settings. + + + + + Represents the combobox used to select a data column. + + + + + Occurs when the text portion of the combobox is changed. + + + + + + + + Gets or sets the data source. + + + + + Gets or sets the Report. + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + This is an internal enum that represents the selected datatree item type. + + + + + "None" selected. + + + + + Data column selected. + + + + + Datasource selected. + + + + + Total selected. + + + + + Parameter selected. + + + + + Function selected. + + + + + Custom item selected. + + + + + Other item selected such as root node for Parameters, Totals etc. + + + + + This is an internal control that represents the data tree. + + + This control is for internal use only. + + + + + DataSource property + + + + + SelectedItem property + + + + + SelectedItemType property + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + List of expanded nodes. + + + + + + + + + + + Creates a new instance of the DataTreeView control. + + + + + Represents the label with line. + + + + + + + + Initializes a new instance of the class. + + + + + Represents a control that may contain several pages. It is similar to the TabControl + but contains no tabs. This control is widely used in wizards. + + + + + Occurs when page is selected. + + + + + Gets or sets a value that determines whether the selector area is visible or not. + + + + + Gets or sets the height of selector tab. + + + + + This property is not relevant to this class + + + + + Gets or sets the active page. + + + + + Gets or sets the index of active page. + + + + + Gets or sets the highlighted page index. + + + + + Gets the collection of pages. + + + + + + + + + + + + + + + + + + + + Gets tab at specified mouse point. + + The mouse point. + Index of tab under mouse; -1 if mouse is outside tab area. + + + + Selects the next page. + + + + + Selects the previous page. + + + + + Initializes a new instance of the class with default settings. + + + + + This class represents a single page of the control. + + + + + Gets or sets the image associated with this page. + + + + + Gets or sets the page caption text. + + + + + + + + + + + + + + Represents the control that combines a textbox and a button. + + + + + + + + Gets or sets the button's image. + + + + + Gets or sets the button's text. + + + + + Occurs when the button is clicked. + + + + + Occurs when the text is changed. + + + + + + + + + + + + + + Set focus on text box. + + + + + + Initializes a new instance of the class. + + + + + TreeView control with multiselect support. + + + This control is for internal use only. + + + + + + + + + + + + + + + + + + + + + + + Creates a new instance of the TreeViewMultiSelect control. + + + + + Base class for all toolbars. + + + + + Gets the report designer. + + + + + Gets or sets a value that determines whether the toolbar is fixed, i.e. can't float. + + + + + Updates UI style of the toolbar. + + + + + Updates layout on dpi change. + + + + + Adds items to this toolbar. + + Items to add. + + + + Initializes a new instance of the class with default settings. + + The report designer. + + + + Not relevant to this class. + + + + + Updates dropdown images on dpi change. + + The designer. + + + + Adds items to the dropdown menu. + + Items to add. + + + + Specifies how text in a is horizontally aligned. + + + + + The text is aligned to the left. + + + + + The text is aligned to the right. + + + + + The text is aligned in the center. + + + + + The text is justified. + + + + + Gets or sets the alignment to apply to the current + selection or insertion point. + + + Replaces the SelectionAlignment from . + + + + + Convert between screen pixels and twips (1/1440 inch, used by Win32 API calls) + + Value in screen pixels + Value in twips + + + + Convert between screen pixels and twips (1/1440 inch, used by Win32 API calls) + + Value in twips + Value in screen pixels + + + + Calculate or render the contents of RichTextBox for printing + + Graphics object + Graphics object to measure richtext for + Bonding rectangle of the RichTextBox + Index of first character to be printed + Index of last character to be printed + If true, only the calculation is performed, + otherwise the text is rendered as well + (Index of last character that fitted on the page) + 1 + + + + Calculate or render the contents of RichTextBox for printing + + Graphics object + Graphics object to measure richtext for + Bonding rectangle of the RichTextBox + Index of first character to be printed + Index of last character to be printed + If true, only the calculation is performed, + otherwise the text is rendered as well + The calculated text height + (Index of last character that fitted on the page) + 1 + + + + Contener for better work FRRichTextBox + + + + + + + + + + Provides functionality required for report designer form. + + + + + Gets the designer control. + + + + + Represents the StimulSoft import plugin. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a specified designer. + + The report designer. + + + + + + + + + + Represents the JasperReports import plugin. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a specified designer. + + The report designer. + + + + + + + + + + Represents the DevExpess import plugin. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a specified designer. + + The report designer. + + + + + + + Represents the List and Label import plugin. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a specified designer. + + The report designer. + + + + + + + + + + + + + Represents the RDL import plugin. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a specified designer. + + The report designer. + + + + + + + + + + Import RichTextFile to a report + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a specified designer. + + The report designer. + + + + + + + + + + The "NewReportPage" menu item. + + + + + The "NewDialog" menu item. + + + + + Represents the report's designer control. + + + Usually you don't need to create an instance of this class. The designer can be called + using the method of + the instance. + This control represents pure designer surface + Objects toolbar. If you need + standard menu, statusbar, toolbars and tool windows, use the + control instead. Also you may + decide to use a designer's form () + instead of a control. + To run a designer, you need to attach a Report instance to it. This can be done via + the property. + To call the designer in MDI (Multi-Document Interface) mode, use the + property. + To set up some global properties, use the static class + or component that you can use in the Visual Studio IDE. + + + + + Occurs when designer's UI state changed. + + + + + Gets or sets the edited report. + + + To initialize the designer, you need to pass a Report instance to this property. + This will create the designer's surface associated with the report. + + Designer designer = new Designer(); + designer.Parent = form1; + designer.Report = report1; + + + + + + Gets active report object. + + + May be null if Start Page selected, or no reports opened. + + + + + Gets a collection of global plugins such as menu, properties window, etc. + + + + + Gets a collection of objects on the active page of the active report. + + + + + Gets a collection of selected objects on the active page of the active report. + + + + + Gets a collection of selected objects of the ComponentBase type. + + + + + Gets a collection of selected objects of the ReportComponentBase type. + + + + + Gets a collection of selected objects of the TextObject type. + + + + + Gets or sets a value indicating that the report was modified. + + + + + Gets or sets a value that determines whether to ask user to save changes when closing the designer. + + + + + Gets the designer restrictions. + + + + + Gets or sets a value indicating that designer is run in MDI mode. + + + To call the designer in MDI (Multi-Document Interface) mode, use the following code: + + DesignerControl designer = new DesignerControl(); + designer.MdiMode = true; + designer.ShowDialog(); + + + + + + Gets or sets the visual style. + + + + + Occurs when the UIStyle property is changed. + + + + + Gets a value indicating that designer is used to edit a preview page. + + + + + Gets or sets the zoom factor. + + + + + Gets the zoom factor with respect of designer's dpi value. + + + + + The "File|New" command. + + + + + The "New Page" toolbar command. + + + + + The "New Dialog" toolbar command. + + + + + The "File|Open|Open locally." command. + + + + + The "File|Open|Open page." command. + + + + + The "File|Open|Open via Cloud." command. + + + + + The "File|Save" command. + + + + + The "File|Save to Cloud" command. + + + + + The "File|Save As..." command. + + + + + The "File|Save With Random Data..." command. + + + + + The "File|Save All" command. + + + + + The "File|Close" command. + + + + + The "Window|Close All" command. + + + + + The "File|Preview..." command. + + + + + The "File|Preview on Cloud..." command. + + + + + The "File|Printer Setup..." command. + + + + + The "File|Page Setup..." command. + + + + + The "Data|Add New Data Source..." command. + + + + + The "Data|Sort Data Sources" command. + + + + + The "Data|Choose Report Data..." command. + + + + + The "Edit|Undo" command. + + + + + The "Edit|Redo" command. + + + + + The "Edit|Cut" command. + + + + + The "Edit|Copy" command. + + + + + The "Edit|Paste" command. + + + + + The "Format Painter" toolbar command. + + + + + The "Edit|Delete" command. + + + + + The "Edit|Copy Page" command. + + + + + The "Edit|Delete Page" command. + + + + + The "Edit|Select All" command. + + + + + The "Edit|Group" command. + + + + + The "Edit|Ungroup" command. + + + + + The "Edit" command. + + + + + The "Edit|Find..." command. + + + + + The "Polygon move command" command. + + + + + The "Polygon point move" command. + + + + + The "Polygon add new point" command. + + + + + The "Polygon berier" command. + + + + + The "Polygon remove point" command. + + + + + The "Edit|Replace..." command. + + + + + The "Bring To Front" command. + + + + + The "Send To Back" command. + + + + + The "Insert" command. + + + + + The "Insert Band" command. + + + + + The "Recent Files" command. + + + + + The "File|Select Language..." command. + + + + + The "View|Start Page" command. + + + + + The "Report|Options..." command. + + + + + The "View|Options..." command. + + + + + The "Report|Styles..." command. + + + + + The "Report|Validation" command. + + + + + The "Help|Help Contents..." command. + + + + + The "Help|Account" command. + + + + + The "Help|About..." command. + + + + + The "Show welcome window..." command. + + + + + Gets or sets the layout state of the designer. + + + This property is used to store layout in Visual Studio design time. You may also use + it to save and restore the designer's layout in your code. However, consider using the + and methods that use FastReport + configuration file. + + + + + Fires when the layout is changed. + + + This event is for internal use only. + + + + + Updates UI style of the designer. + + + + + Initializes designer plugins such as toolbars and toolwindows. + + + + + Zooms the report to page width. + + + + + Zooms the report to whole page. + + + + + Cancels paste mode. + + + + + AutoSave system initialization. + + + + + Stops the AutoSave system. + + + + + Call this method if you change something in the report. + + + This method adds the current report state to the undo buffer and updates all plugins. + + + + + Call this method if you change something in the report. + + The object that was modified. + The undo action name. + + This method adds the current report state to the undo buffer and updates all plugins. + + + + + Call this method if you change something in the report. + + The object that was modified. + The undo action name. + The name of modified object. + + + + Call this method to tell the designer that current selection is changed. + + The plugin that changes the selection (may be null). + + + + Locks all plugins. + + + This method is usually called when we destroy the report to prevent unexpected + errors - such as trying to draw destroyed objects. + + + + + Unlocks all plugins. + + + Call this method after the Lock. + + + + + Call this method to refresh all plugins' content. + + The plugin that we don't need to refresh. + + + + Updates localization of the designer. + + + + + Updates layout and images on dpi change. + + The sender object. + + + + Checks if parent window can be closed. + + The cancel event args. + + Use this method in the window's FormClosing event handler if you use this control. + This method checks if the embedded preview is running and cancels it. Also if there is unsaved changes, the user will be asked to save changes. + + + + + Saves config to a FastReport configuration file. + + + + + Restores config from a FastReport configuration file. + + + Call this method to restore the designer's layout. You need to do this after the + designer's control is placed on a form. + + + + + Refresh the designer's toolbars and toolwindows layout. + + + Call this method if you use + DesignerControl. To restore + the layout that you've created in VS design time, you need to call this method in the form's + Load event handler. If you don't do this, tool windows like Properties, Data, Report Tree + will not be available. + + + + + + + + + + + Initializes the workspace after the new report is loaded. + + + + + Tries to create a new empty report. + + true if report was created successfully; false if user cancels the action. + + + + Displays a message in the "Messages" window. + + Message text. + + + + Clears the "Messages" window. + + + + + Shows the selected object's information in the designer's statusbar. + + Object's location. + Object's size. + Textual information about the selected object. + The location of the lower-right corner of the object's. + + + + Close all opened reports, ask to save changes. + + true if all tabs closed succesfully. + + Use this method to close all opened documents and save changes when you closing the main form + that contains the designer control. To do this, create an event handler for your form's FormClosing + event and call this method inside the handler. If it returns false, set e.Cancel to true. + + + + + Initializes a new instance of the class with default settings. + + + + + + + + The base class for all designer commands. + + + + + Gets a value indicating that the command is enabled. + + + If you use own controls that invoke designer commands, use this property to refresh + the Enabled state of a control that is bound to this command. + + + + + Defines a custom action for this command. + + + Using custom action, you can override the standard behavior of this designer's command. + + + This example demonstrates how to override the "New..." command behavior. + + // add an event handler that will be fired when the designer is run + Config.DesignerSettings.DesignerLoaded += new EventHandler(DesignerSettings_DesignerLoaded); + + void DesignerSettings_DesignerLoaded(object sender, EventArgs e) + { + // override "New..." command behavior + (sender as Designer).cmdNew.CustomAction += new EventHandler(cmdNew_CustomAction); + } + + void cmdNew_CustomAction(object sender, EventArgs e) + { + // show the "Label" wizard instead of standard "Add New Item" dialog + Designer designer = sender as Designer; + LabelWizard wizard = new LabelWizard(); + wizard.Run(designer); + } + + + + + + Gets a value for the Enabled property. + + true if command is enabled. + + + + Invokes the command. + + + + + Invokes the command with specified sender and event args. + + Sender. + Event args. + + This method is compatible with standard and can be passed + to the event handler constructor directly. + + + + + Represents the "File|New" command. + + + + + + + + + + + Represents the "New Page" toolbar command. + + + + + + + + + + + Represents the "New Dialog" toolbar command. + + + + + + + + + + + Represents the "File|Open..." command. Also can be used for loading a file + from the recent files list. + + + + + + + + + + + Loads a specified report file. + + File to load. + true to suppress message dialog if load is failed. + + + + Represents the "File|Open page..." command. + + + + + + + + + + + Loads report file and paginating it. + + File to load. + + + + + Represents the "File|Open from Cloud..." command. Also can be used for loading a file + from the recent files list. + + + + + + + + + + + Loads file from the recent files list. + + File name. + File ID. + + + + Represents the "File|Save" command. + + + + + + + + + + + Represents the "File|Save to Cloud" command. + + + + + + + + + + + Represents the "File|Save As..." command. + + + + + + + + + + + Represents the "File|Save With Random Data..." command. + + + + + + + + + + + Represents the "File|Save All" command. + + + + + + + + + + + Represents the "File|Close" command. + + + + + + + + + + + Represents the "Window|Close All" command. + + + + + + + + Represents the "File|Preview..." command. + + + + + + + + + + + Represents the "File|Preview on Cloud..." command. + + + + + + + + + + + Represents the "File|Page Setup..." command. + + + + + + + + + + + Represents the "Report|Options..." command. + + + + + + + + + + + Represents the "File|Printer Setup..." command. + + + + + + + + + + + Represents the "Edit|Undo" command. + + + + + + + + + + + Undo several actions. + + Number of actions to undo. + + + + Represents the "Edit|Redo" command. + + + + + + + + + + + Redo several actions. + + Number of actions to redo. + + + + Represents the "Edit|Cut" command. + + + + + + + + + + + Represents the "Edit|Copy" command. + + + + + + + + Represents the "Edit|Copy Page" command. + + + + + + + + + + + Represents the "Edit|Paste" command. + + + + + + + + + + + Represents the "Format Painter" toolbar command. + + + + + + + + + + + Represents the "Edit|Delete" command. + + + + + + + + + + + Represents the "Edit|Delete Page" command. + + + + + + + + + + + Represents the "Edit|Select All" command. + + + + + + + + + + + Represents the "Edit|Group" command. + + + + + + + + + + + Represents the "Edit|Ungroup" command. + + + + + + + + Represents the "Edit" command. + + + + + + + + + + + Represents the "Edit|Find..." command. + + + + + + + + + + + Represents the "Edit|Replace..." command. + + + + + Represents the "Bring To Front" context menu command. + + + + + + + + + + + Represents the "Send To Back" context menu command. + + + + + + + + Represents the "Insert" command. + + + This command has no default action associated with it. Check the Enabled property + to see if the insert operation is enabled. + + + + + + + + Represents the "Insert Band" command. + + + This command has no default action associated with it. Check the Enabled property + to see if the insert operation is enabled. + + + + + + + + Represents the "Data|Add Data Source..." command. + + + + + + + + + + + Represents the "Data|Sort Data Sources" command. + + + + + + + + + + + Represents the "Data|Choose Report Data..." command. + + + + + + + + + + + Represents the "Recent Files" command. + + + This command has no default action associated with it. Check the Enabled property + to see if the recent files list is enabled. + + + + + + + + Returns true if the file specified is a cloud file. + + File name to check. + true if file is a cloud file. + + + + Opens a recent file with specified name either from local PC or from cloud. + + File name to open. + + + + Represents the "File|Select Language..." command. + + + + + + + + Represents the "View|Options..." command. + + + + + + + + Represents the "View|Start Page" command. + + + + + + + + + + + Represents the "Select polygon move" command. + + + + + + + + + + + Represents the "Report|Styles..." command. + + + + + + + + + + + Represents the "Report|Validation" command. + + + + + + + + + + + Represents the "Help|Account" command. + + + + + + + + + + + Represents the "Help|Help Contents..." command. + + + + + + + + + + + Represents the "Help|About..." command. + + + + + + + + Represents the "Show welcome window..." command. + + + + + + + + + + + Provides a data for the designer ReportLoaded event. + + + + + The current report. + + + + + Represents the method that will handle the designer ReportLoaded event. + + The source of the event. + The event data. + + + + Provides a data for the designer ObjectInserted event. + + + + + Gets the inserted object. + + + + + Gets the source where the object is inserted from. + + + + + Represents the method that will handle the designer ObjectInserted event. + + The source of the event. + The event data. + + + + Provides a data for the designer's custom dialog events. + + + + + Gets or sets a file name. + + + This property contains the location of a report. If you work with files (like the + standard "Open" and "Save" dialogs do), treat this property as a file name. + + + + + Gets or sets a value indicating that the dialog was cancelled. + + + This property is used to tell the designer that the user was cancelled the dialog. + + + + + Gets or sets the custom data that is shared across events. + + + You may set the Data in the OpenDialog event and use it later in the OpenReport event. + + + + + Gets a report designer. + + + + + Represents the method that will handle the designer's custom dialogs event. + + The source of the event. + The event data. + + + + Provides a data for the designer's custom dialog events. + + + + + Gets a report. + + + Use this report in the load/save operations. + + + + + Gets a file name. + + + This property contains the location of a report that was selected by the user in the + open/save dialogs. If you work with files (like the standard "Open" and "Save" dialogs do), + treat this property as a file name. + + + + + Gets the custom data that was set in the OpenDialog event. + + + + + Represents the method that will handle the designer's custom dialogs event. + + The source of the event. + The event data. + + + + Provides data for the FilterConnectionTables event. + + + + + Gets the Connection object. + + + + + Gets the table name. + + + + + Gets or sets a value that indicates whether this table should be skipped. + + + + + Represents the method that will handle the FilterConnectionTables event. + + The source of the event. + The event data. + + + + Provides data for the CustomQueryBuilder event. + + + + + Gets the Connection object. + + + + + Gets or sets the query text. + + + + + Gets or sets the query parameters. + + + + + Represents the method that will handle the CustomQueryBuilder event. + + The source of the event. + The event data. + + + + Represents list of registered design plugins. + + + + + Adds a new plugin's type. + + The type of a plugin. + + + + Represents a set of designer's restrictions. + + + + + Gets or sets a value that enables or disables the "Open" action. + + + + + Gets or sets a value that enables or disables the "Save/Save as" actions. + + + + + Gets or sets a value that enables or disables the "New..." action. + + + + + Gets or sets a value that enables or disables the "Preview" action. + + + + + Gets or sets a value that enables or disables the recent files list. + + + + + Gets or sets a value that enables or disables the "Code" tab. + + + + + Gets or sets a value that enables or disables the "Data" menu. + + + + + Gets or sets a value that enables or disables the "Data|Add New Data Source..." menu. + + + + + Gets or sets a value that enables or disables the "Data|Sort Data Sources" menu. + + + + + Gets or sets a value that enables or disables the "Report|Options..." menu. + + + + + Gets or sets a value that enables or disables insertion of objects. + + + + + Gets or sets a value that enables or disables the insertion of bands. + + + + + Gets or sets a value that enables or disables the "Delete Page" action. + + + + + Gets or sets a value that enables or disables the creation of report/dialog pages. + + + + + Gets or set a value that enables or disbles the "Copy Page" action. + + + + + Gets or sets a value that enables or disables the "Page Setup" action. + + + + + Copies the contents of another, similar object. + + Source object to copy the contents from. + + + + Creates exact copy of this object. + + The copy of this object. + + + + This class contains settings that will be applied to the report designer. + + + + + Occurs when the designer is loaded. + + + Use this event if you want to customize some aspects of the designer, for example, + to hide some menu items. + + + This example demonstrates how to hide the "File|Select Language..." menu item. + + Config.DesignerSettings.DesignerLoaded += new EventHandler(DesignerSettings_DesignerLoaded); + + void DesignerSettings_DesignerLoaded(object sender, EventArgs e) + { + (sender as DesignerControl).MainMenu.miFileSelectLanguage.Visible = false; + } + + + + + + Occurs when the designer is closed. + + + + + Occurs when the report is loaded. + + + + + Occurs when a report page or a dialog form is added to the report. + + + Use this event if you want to customize the page properties. + + + This example demonstrates how to change the default page margins. + + Config.DesignerSettings.PageAdded += new EventHandler(DesignerSettings_PageAdded); + + void DesignerSettings_PageAdded(object sender, EventArgs e) + { + if (sender is ReportPage) + (sender as ReportPage).TopMargin = 0; + } + + + + + + Occurs when object is inserted. + + + + + Occurs when the report designer is about to show the "Open" dialog. + + Use this event to attach own "Open" dialog to the designer. In the event handler, you must + display a dialog window to allow user to choose a report file. + If dialog was executed successfully, you must return e.Cancel = false and set the + e.FileName to the selected file name. + You also need to use event to provide code that + will open the report. + + + This example shows how to attach own "Open" and "Save" dialogs to the designer. + It uses the following events: , , + , . + + private void CustomOpenDialog_Handler(object sender, OpenSaveDialogEventArgs e) + { + using (OpenFileDialog dialog = new OpenFileDialog()) + { + dialog.Filter = "Report files (*.frx)|*.frx"; + + // set e.Cancel to false if dialog was succesfully executed + e.Cancel = dialog.ShowDialog() != DialogResult.OK; + // set e.FileName to the selected file name + e.FileName = dialog.FileName; + } + } + + private void CustomSaveDialog_Handler(object sender, OpenSaveDialogEventArgs e) + { + using (SaveFileDialog dialog = new SaveFileDialog()) + { + dialog.Filter = "Report files (*.frx)|*.frx"; + // get default file name from e.FileName + dialog.FileName = e.FileName; + + // set e.Cancel to false if dialog was succesfully executed + e.Cancel = dialog.ShowDialog() != DialogResult.OK; + // set e.FileName to the selected file name + e.FileName = dialog.FileName; + } + } + + private void CustomOpenReport_Handler(object sender, OpenSaveReportEventArgs e) + { + // load the report from the given e.FileName + e.Report.Load(e.FileName); + } + + private void CustomSaveReport_Handler(object sender, OpenSaveReportEventArgs e) + { + // save the report to the given e.FileName + e.Report.Save(e.FileName); + } + + + + + + Occurs when the report designer is about to show the "Save" dialog. + + Use this event to attach own "Save" dialog to the designer. In the event handler, you must + display a dialog window to allow user to choose a report file. + If dialog was executed successfully, you must return e.Cancel = false and set the + e.FileName to the selected file name. + You also need to use event to provide code that + will save the report. + + + This example shows how to attach own "Open" and "Save" dialogs to the designer. + It uses the following events: , , + , . + + private void CustomOpenDialog_Handler(object sender, OpenSaveDialogEventArgs e) + { + using (OpenFileDialog dialog = new OpenFileDialog()) + { + dialog.Filter = "Report files (*.frx)|*.frx"; + + // set e.Cancel to false if dialog was succesfully executed + e.Cancel = dialog.ShowDialog() != DialogResult.OK; + // set e.FileName to the selected file name + e.FileName = dialog.FileName; + } + } + + private void CustomSaveDialog_Handler(object sender, OpenSaveDialogEventArgs e) + { + using (SaveFileDialog dialog = new SaveFileDialog()) + { + dialog.Filter = "Report files (*.frx)|*.frx"; + // get default file name from e.FileName + dialog.FileName = e.FileName; + + // set e.Cancel to false if dialog was succesfully executed + e.Cancel = dialog.ShowDialog() != DialogResult.OK; + // set e.FileName to the selected file name + e.FileName = dialog.FileName; + } + } + + private void CustomOpenReport_Handler(object sender, OpenSaveReportEventArgs e) + { + // load the report from the given e.FileName + e.Report.Load(e.FileName); + } + + private void CustomSaveReport_Handler(object sender, OpenSaveReportEventArgs e) + { + // save the report to the given e.FileName + e.Report.Save(e.FileName); + } + + + + + + Occurs when the report designer is about to load the report. + + This event is used together with the event. + Use this event to attach own "Open" dialog to the designer. In the event handler, you must + load the e.Report from the location specified in the e.FileName property. + For example, if you work with files: e.Report.Load(e.FileName); + + + This example shows how to attach own "Open" and "Save" dialogs to the designer. + It uses the following events: , , + , . + + private void CustomOpenDialog_Handler(object sender, OpenSaveDialogEventArgs e) + { + using (OpenFileDialog dialog = new OpenFileDialog()) + { + dialog.Filter = "Report files (*.frx)|*.frx"; + + // set e.Cancel to false if dialog was succesfully executed + e.Cancel = dialog.ShowDialog() != DialogResult.OK; + // set e.FileName to the selected file name + e.FileName = dialog.FileName; + } + } + + private void CustomSaveDialog_Handler(object sender, OpenSaveDialogEventArgs e) + { + using (SaveFileDialog dialog = new SaveFileDialog()) + { + dialog.Filter = "Report files (*.frx)|*.frx"; + // get default file name from e.FileName + dialog.FileName = e.FileName; + + // set e.Cancel to false if dialog was succesfully executed + e.Cancel = dialog.ShowDialog() != DialogResult.OK; + // set e.FileName to the selected file name + e.FileName = dialog.FileName; + } + } + + private void CustomOpenReport_Handler(object sender, OpenSaveReportEventArgs e) + { + // load the report from the given e.FileName + e.Report.Load(e.FileName); + } + + private void CustomSaveReport_Handler(object sender, OpenSaveReportEventArgs e) + { + // save the report to the given e.FileName + e.Report.Save(e.FileName); + } + + + + + + Occurs when the report designer is about to save the report. + + This event is used together with the event. + Use this event to attach own "Save" dialog to the designer. In the event handler, you must + save the e.Report to the location specified in the e.FileName property. + For example, if you work with files: e.Report.Save(e.FileName); + + + This example shows how to attach own "Open" and "Save" dialogs to the designer. + It uses the following events: , , + , . + + private void CustomOpenDialog_Handler(object sender, OpenSaveDialogEventArgs e) + { + using (OpenFileDialog dialog = new OpenFileDialog()) + { + dialog.Filter = "Report files (*.frx)|*.frx"; + + // set e.Cancel to false if dialog was succesfully executed + e.Cancel = dialog.ShowDialog() != DialogResult.OK; + // set e.FileName to the selected file name + e.FileName = dialog.FileName; + } + } + + private void CustomSaveDialog_Handler(object sender, OpenSaveDialogEventArgs e) + { + using (SaveFileDialog dialog = new SaveFileDialog()) + { + dialog.Filter = "Report files (*.frx)|*.frx"; + // get default file name from e.FileName + dialog.FileName = e.FileName; + + // set e.Cancel to false if dialog was succesfully executed + e.Cancel = dialog.ShowDialog() != DialogResult.OK; + // set e.FileName to the selected file name + e.FileName = dialog.FileName; + } + } + + private void CustomOpenReport_Handler(object sender, OpenSaveReportEventArgs e) + { + // load the report from the given e.FileName + e.Report.Load(e.FileName); + } + + private void CustomSaveReport_Handler(object sender, OpenSaveReportEventArgs e) + { + // save the report to the given e.FileName + e.Report.Save(e.FileName); + } + + + + + + Occurs when previewing a report from the designer. + + + Use this event to show own preview window. + + + + Config.DesignerSettings.CustomPreviewReport += new EventHandler(MyPreviewHandler); + + private void MyPreviewHandler(object sender, EventArgs e) + { + Report report = sender as Report; + using (MyPreviewForm form = new MyPreviewForm()) + { + report.Preview = form.previewControl1; + report.ShowPreparedReport(); + form.ShowDialog(); + } + } + + + + + + Occurs when getting available table names from the connection. + + + Use this handler to filter the list of tables returned by the connection object. + + + This example demonstrates how to hide the table with "Table 1" name from the Data Wizard. + + Config.DesignerSettings.FilterConnectionTables += DesignerSettings_FilterConnectionTables; + + private void DesignerSettings_FilterConnectionTables(object sender, FilterConnectionTablesEventArgs e) + { + if (e.TableName == "Table 1") + e.Skip = true; + } + + + + + + Occurs when the query builder is called. + + + Subscribe to this event if you want to replace the embedded query builder with your own one. + + + + + Gets or sets the icon for the designer window. + + + + + Gets or sets the default font used in a report. + + + + + Gets or sets a value indicating whether the designer window is displayed in the Windows taskbar. + + + + + Gets the designer restrictions flags. + + + + + Gets or sets the title text for the designer window. + + + If no text is set, the default text "FastReport -" will be used. + + + + + Gets or sets a value indicating whether the preview window is embedded into the designer form. + + + + + Gets or sets application-defined DbConnection object that will be used in the designer + to create a new datasource. + + + The application connection object is used in the "Data Wizard" to create new datasources. + In this mode, you can't create any other connections in the wizard; only application + connection is available. You still able to choose tables or create a new queries inside + this connection. The connection information (ConnectionString) is not stored in the report file. + + + + + Gets the toolstrip renderer. + + + + + Adds a custom connection used in the "Data Wizard" window. + + + Use this method to provide own connection strings for the "Data Wizard" dialog. To do this, you need + to pass the type of connection object and connection string associated with it. You must use one of the + connection objects registered in FastReport that inherit from the + class. + To clear the custom connections, use the method. + + + This example shows how to add own connection string. + + Config.DesignerSettings.AddCustomConnection(typeof(MsAccessDataConnection), @"Data Source=c:\data.mdb"); + + + + + + Clears the custom connections added by the AddCustomConnection method. + + + + + Initializes a new instance of the class. + + + + + Base class for all export plugins. + + + + + Gets or sets the name of plugin. + + + + + Gets or sets the filter string used in the "Save File" dialog. + + + + + Gets or sets reference to the designer. + + + + + Gets or sets reference to the report. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with a specified designer. + + The report designer. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns a file filter for a save dialog. + + String that contains a file filter, for example: "Bitmap image (*.bmp)|*.bmp" + + + + Saves the specified report into specified file. + + Report object. + File name. + + + + Represents the FR3 export plugin. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a specified designer. + + The report designer. + + + + + + + + + + The FR3 units converter. + + + + + Converts Color to TColor. + + Color value. + String that contains TColor value. + + + + Converts font style. + + FontStyle value. + String that contains converted value. + + + + Converts horizontal alignment of text. + + HorzAlign value. + String that contains converted value. + + + + Converts vertical alignment of text. + + VertAlign value. + String that contains coverted value. + + + + Converts font size to delphi font height. + + Font size value. + String that contains font height value. + + + + Convert line style to frame style. + + Line style value. + String that contains converted value. + + + + Converts barcode type. + + BarcodeBase instance. + String that contains converted value. + + + + Converts BorderLines value. + + BorderLines instance. + String that contains converted value. + + + + Converts CheckedSymbol value. + + CheckeSymbol instance. + String that contains converted value. + + + + Converts ScaleDock value. + + ScaleDock instance. + String that contains converted value. + + + + Converts DashStyle value. + + DashStyle instance. + String that contains converted value. + + + + Converts TotalType value. + + TotalType instance. + String that contains converted value. + + + + Converts MapLabelKind value. + + MapLabelKind instance. + String that contains converted value. + + + + Converts MapPalette value. + + MapPalette instance. + String that contains converted value. + + + + Converts ShapeKind value. + + ShapeKind instance. + String that contains coverted value. + + + + Represents the RDL export plugin. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a specified designer. + + The report designer. + + + + + + + + + + The FR units converter. + + + + + Converts the float size in pixels to string value in millimeters. + + The float value in pixels. + The string value in millimeters. + + + + Converts the float size in millimeters to string value in millimeters. + + The float value in millimeters. + The string value in millimeters. + + + + Converts the bool value to string. + + The bool value. + The string value. + + + + Converts the int size in pixels to string value in pt. + + The int value in pixels. + The string value in pt. + + + + Converts the Color value to string. + + The Color value. + The string representation of Color value. + + + + Converts the LineStyle value to RDL BorderStyle value. + + The LineStyle value. + The string with RDL BorderStyle value. + + + + Converts the GradientStyle value to RDL GradientType value. + + The GradientStyle value. + The string with RDL GradientType value. + + + + Converts the FontStyle value to RDL FontStyle value. + + The FontStyle value. + The string with RDL FontStyle value. + + + + Converts the FontFamily value to RDL FontFamily value. + + The FontFamily value. + The string with RDL FontFamily value. + + + + Converts the HorzAlign value to RDL TextAlign value. + + The HorzAlign value. + The string with RDL TextAling value. + + + + Converts the VertAling value to RDL VerticalAling value. + + The VertAling value. + The string with RDL VerticalAlign value. + + + + Converts the Angle value to RDL WritingMode value. + + The Angle value. + The string with RDL WritingMode value. + + + + Converts the FontSize value to RDL FontSize value. + + The FontSize value. + The string with RDL FontSize value. + + + + Converts the PictureBoxSizeMode value to RDL Sizing value. + + The PictureBoxSizeMode value. + The string with RDL Sizing value. + + + + Converts the SeriesChartType value to RDL Chart.Type value. + + The SeriesChartType value. + The string with RDL Chart.Type value. + + + + Converts the ChartColorPalette value to RDL Chart.Palette value. + + The ChartColorPalette value. + The string with RDL Chart.Palette value. + + + + Converts the Legend.Docking and Legend.Alignment values to RDL Chart.Legend.Position value. + + The Legend.Docking value. + The Legend.Alignment value. + The string with RDL Chart.Legend.Position value. + + + + Converts the LegendStyle value to Chart.Legend.Layout value. + + The LegendStyle value. + The string with RDL Chart.Legend.Layout value. + + + + Converts the LightStyle value to RDL Shading value. + + The LightStyle value. + The string with RDL Shading value. + + + + Converts the ChartDashStyle value to RDL BorderStyle value. + + The ChartDashStyle value. + The string with RDL ChartDahsStyle value. + + + + Converts the ContentAlignment value to RDL TextAlign value. + + The ContentAlignment value. + The string with RDL TextAlign value. + + + + Converts the ContentAlignment value to RDL VerticalAlign value. + + The ContentAlignment value. + The string with RDL VerticalAlign value. + + + + Converts the AxisEnabled value to RDL Axis.Visible value. + + The AxisEnabled value. + The string with RDL Axis.Visible value. + + + + Converts the TickMarkStyle value to RDL TickMarkStyle value. + + The TickMarkStyle value. + The string with RDL TickMarkStyle value. + + + + Converts the StringAlignment value to RDL TextAlign value. + + The StringAlignment value. + The string with RDL TextAlign value. + + + + Provides functionality required for report designer plugins such as toolbars and toolwindows. + + + + + Gets the plugin name. + + + + + Saves the plugin state. + + This example shows how to save the state: + + public void SaveState() + { + XmlItem xi = Config.Root.FindItem("Designer").FindItem(Name); + xi.SetProp("ShowGrid", DialogWorkspace.ShowGrid ? "1" : "0"); + } + + + + + + Restores the plugin state. + + This example shows how to restore the state: + + public void RestoreState() + { + XmlItem xi = Config.Root.FindItem("Designer").FindItem(Name); + DialogWorkspace.ShowGrid = xi.GetProp("ShowGrid") != "0"; + } + + + + + + Updates plugin state when current selection was changed. + + + Typically you need to do the same work in the and + methods. + + + + + Updates plugin state when the report was modified. + + + Typically you need to do the same work in the and + methods. + + + + + Locks the plugin. + + + This method is called by the designer when report is loading. It may be needed to disable + some operations (like painting) that use the report. + + + + + Unlocks the plugin. + + This method is called by the designer when report is loaded. It follows the Lock + method call and must reset the lock. + + + + Localizes the plugin. + + + This method is called by the designer when current localization is changed. + + + + + Gets an options page that will be used in the Designer Options dialog to edit the plugin options. + + The options page, if implemented; otherwise, null. + + + + Updates UI style of the plugin. + + + The plugin should update its style according to the designer's UIStyle property. + + + + + Updates layout on dpi change. + + + + + Base class for all import plugins. + + + + + Gets or sets the name of plugin. + + + + + Gets or sets the filter string used in the "Open File" dialog. + + + + + Gets or sets reference to the designer. + + + + + Gets or sets reference to the report. + + + + + + + + Gets or sets reference to the import. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with a specified designer. + + The report designer. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns a file filter for a open dialog. + + String that contains a file filter, for example: "Bitmap image (*.bmp)|*.bmp" + + + + Loads the specified file into specified report. + + Report object. + File name. + + + + Loads the specified file into specified report from stream. + + Report object. + File stream. + + + + Gets storage service. + + + + + Represent ruler with guides for forms of editors + + + + + Get or set left indent position + + + + + Get or set right indent position + + + + + Gets or sets tab positiions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Method for drawing guides on element of form. + + + + + + + Base class for elements of RulerWithGuides + + + + + Get or set bounds of object + + + + + Get or set state of object + + + + + Draw element on graphics + + + + + + Method for moving object by means of chenging bounds + + + + + + Element of RulerWithGuides presenting position of tabs + + + + + Constructor of class TabPosition + + + + + + + + + + + + Represents collection of designer plugins. + + + This class is used in the Designer.Plugins property. + To register own plugin, add its type to the global collection: + + DesignerPlugins.Add(typeof(MyToolbar)); + + + + + + + Finds a plugin by its name. + + The plugin's name. + The plugin, if found; otherwise, null. + This example shows how to find a plugin. + + MessagesWindow window = designer.Plugins.Find("MessagesWindow") as MessagesWindow; + + + + + + Finds a plugin by its type name. + + The plugin's type name. + The plugin, if found; otherwise, null. + This example shows how to find a plugin. + + MessagesWindow window = designer.Plugins.FindType("MessagesWindow") as MessagesWindow; + + + + + + Base class for all designer toolbars. + + + Use this class to write own designer's toolbar. To do this: + - in the constructor, set the Name property and create toolbar buttons. + The Name will be used to restore toolbar's state; + - override the SelectionChanged method. This method is called when current selection + is changed. In this method, you should update buttons state to reflect the current selection. + Selected objects can be accessed via Designer.SelectedObjects property; + - override the UpdateContent method. This method is called when the report + content was changed. Typically you need to do the same actions in SelectionChanged and + UpdateContent methods; + - to register a toolbar, add its type to the global collection: + + DesignerPlugins.Add(typeof(MyToolbar)); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + The report designer. + + You don't need to call this constructor. The designer will do this automatically. + + + + + Represents the "Data Dictionary" window. + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + The report designer. + + + + Describes an item dragged from the "Data Dictionary" window. + + + + + The dragged object. + + + + + The text of dragged object. + + + + + Collection of dragged items. + + + + + Represents the "Messages" window. + + + To get this window, use the following code: + + Designer designer; + MessagesWindow window = designer.Plugins.FindType("MessagesWindow") as MessagesWindow; + + + + + + Clears the message list. + + + + + Adds a new message. + + The message text. + The name of object related to a message. + Determines whether the message is an error or a warning. + + + + Adds a new script-related message. + + The message text. + The line of the script. + The column of the script. + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + The report designer. + + + + Represents the "Properties" window. + + + + + Gets or sets a value indicating that properties are filtered. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + The report designer. + + + + Represents the "Report Tree" window. + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + The report designer. + + + + Extends the class for window with filterable TreeView. + + + + + + + + This method puts data to TreeView. + + + + + Searches for matches in + based on the text entered in the text field . + + + + + The method is needed to save focus on the selected node after performing operations; works only for WinForms.
+ + The path to the node in the DataTree tree. + + + + Initializes a new instance of the class with default settings. + + The report designer. + + + + + + + + + + + + + Base class for all tool windows such as "Properties", "Data Dictionary" etc. + + + Use this class to create own tool window. To do this: + - in the constructor, set the Name and Image properties and create necessary controls. + The Name will be used to restore window's state; + - override the SelectionChanged method. This method is called when current selection + is changed. In this method, you should update buttons state to reflect the current selection. + Selected objects can be accessed via Designer.SelectedObjects property; + - override the UpdateContent method. This method is called when the report + content was changed. Typically you need to do the same actions in SelectionChanged and + UpdateContent methods; + - to register a toolwindow, add its type to the global collection: + + DesignerPlugins.Add(typeof(MyToolWindow)); + + + + + + + Gets the report designer. + + + + + Gets a value indicating that window is locked. + + + + + + + + Gets or sets shortcut keys used to show this toolwindow. + + + + + Gets or sets a value indicating that the toolwindow can be closed by the x button. + + + + + Gets the control collection. + + + + + Shows the toolwindow. + + + + + Hides the toolwindow. + + + + + + + + + + + + + + + + + + + + + + + + + + Implements method. + + The options page, if implemented; otherwise, null. + + + + + + + + + + Initializes a new instance of the class with default settings. + + The report designer. + + You don't need to call this constructor. The designer will do this automatically. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents the standard report designer. + + + This control extends the control with + standard menu, status bar, and toolbars. + To choose toolbars and tool windows in design-time, click the "View" menu + in this control and select what you want to see. Toolbars can be reordered using the mouse. + To restore the designer layout at runtime, you need to call the + RefreshLayout method in your + form's Load event handler. + + + + + Gets the main menu. + + + + + Gets or sets a value indicating whether the main menu should be displayed or not. + + + + + Gets or sets a value indicating whether the status bar should be displayed or not. + + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Represents standard designer's form. + + + This form contains the . Use the + property to get access to this control. + Usually you don't need to create an instance of this class. The designer can be called + using the method of + the instance. + If you decided to use this class, you need: + + + create an instance of this class; + + + set the Designer.Report property to report that you need to design; + + + call either ShowModal or Show methods to display a form. + + + + + + + Gets a reference to the control which is actually a designer. + + + + + Gets a list of File menu buttons + + + + + Creates a new instance of the class with default settings. + + + + + Creates a new instance of the class with default settings. + + enables welcome window + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents the designer's main menu. + + + To get this menu, use the following code: + + Designer designer; + DesignerMenu menu = designer.Plugins.FindType("DesignerMenu") as DesignerMenu; + + + + + + The "File" menu. + + + + + The "File|New..." menu. + + + + + The "File|Open..." menu. + + + + + The "File|Open page..." menu. + + + + + The "File|Open via Cloud..." menu. + + + + + The "File|Recent Files" menu. + + + + + The "File|Close" menu. + + + + + The "File|Save" menu. + + + + + The "File|Save as..." menu. + + + + + The "File|Save with random data..." menu. + + + + + The "File|Save All" menu. + + + + + The "File|Save to Cloud..." menu. + + + + + The "File|Page Setup..." menu. + + + + + The "File|Printer Setup..." menu. + + + + + The "File|Preview..." menu. + + + + + The "File|Web preview..." menu. + + + + + The "File|Select Language" menu. + + + + + The "File|Exit" menu. + + + + + The "Edit" menu. + + + + + The "Edit|Undo" menu. + + + + + The "Edit|Redo" menu. + + + + + The "Edit|Cut" menu. + + + + + The "Edit|Copy" menu. + + + + + The "Edit|Paste" menu. + + + + + The "Edit|Delete" menu. + + + + + The "Edit|NewPage" menu. + + + + + The "Edit|Copy Page" menu. + + + + + The "Edit|Delete Page" menu. + + + + + The "Edit|Select All" menu. + + + + + The "Edit|Group" menu. + + + + + The "Edit|Ungroup" menu. + + + + + The "Edit|Find..." menu. + + + + + The "Edit|Replace..." menu. + + + + + The "View" menu. + + + + + The "View|Toolbars" menu. + + + + + The "View|Start Page" menu. + + + + + The "View|Options..." menu. + + + + + The "Insert" menu. + + + + + The "Report" menu. + + + + + The "Report|Validation" menu. + + + + + The "Report|Options..." menu. + + + + + The "Data" menu. + + + + + The "Data|Choose Report Data..." menu. + + + + + The "Data|Add Data Source..." menu. + + + + + The "Data|Show Data Dictionary" menu. + + + + + The "Window" menu. + + + + + The "Window|Close All" menu. + + + + + The "Help" menu. + + + + + The "Help|Help Contents..." menu. + + + + + The "Help|About..." menu. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates a new menu item. + + New menu item. + + + + Creates a new menu item. + + Click handler. + New menu item. + + + + Creates a new menu item. + + Item's image index. + Click handler. + New menu item. + + + + Creates a new menu item. + + Item's text. + Click handler. + New menu item. + + + + Creates a new menu item. + + Item's image index. + Item's text. + Click handler. + New menu item. + + + + Initializes a new instance of the class with default settings. + + The report designer. + + + + Represents the designer's statusbar. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Updates the information about location and size. + + The location. + The size. + + + + Updates the name and text information. + + The text. + + + + Initializes a new instance of the class with default settings. + + The report designer. + + + + Hold the list of registered aggregate functions. + + + + + Gets names of aggregates registered. + + + + + Registers the aggregate function. + + The function name. + The type of aggregate class. + + + + Returns an aggregate with specified name. + + The name of aggregate function. + The aggregate class type. + + + + Represents base class for AdvMatrixObject aggregates. + + + + + Adds a value to aggregate. + + The value. + + + + Gets aggregate value. + + Aggregate value. + + + + Merges value from another, similar aggregate. + + Aggregate to merge value from. + + + + Represents the "Sum" aggregate. + + + + + + + + + + + + + + Represents the "Avg" aggregate. + + + + + + + + + + + + + + Represents the "Min" aggregate. + + + + + + + + + + + + + + Represents the "Max" aggregate. + + + + + + + + + + + + + + Represents the "Count" aggregate. + + + + + + + + + + + + + + Represents the "CountDistinct" aggregate. + + + + + + + + + + + + + + Represents the "Var" aggregate. + + + + + + + + + + + + + + Represents the "VarP" aggregate. + + + + + + + + + + + + + + Represents the "StDev" aggregate. + + + + + + + + Represents the "StDevP" aggregate. + + + + + + + + Represents the "First" aggregate. + + + + + + + + + + + + + + Represents the "Last" aggregate. + + + + + + + + + + + + + + Represents the "ValuesList" aggregate. + + + + + Represents the "User" aggregate. + + + + + + + + + + + + + + Holds context required for aggregate functions evaluation. + + + + + Gets aggregate value. This method is for internal use only. + + Name of aggregate. + Expression. + Aggregate value. + + + + Gets value of the specific column. This method is for internal use only. + + The column value. + Dummy parameter. + The value or null. + + + + Gets value of the specific row. This method is for internal use only. + + The row value. + Dummy parameter. + The value or null. + + + + Gets value of the first column. This method is for internal use only. + + Dummy parameter. + Determines if the interactive sort must be respected. + Determines if the same level group should be used to search for item. + The value or null. + + + + Gets value of the last column. This method is for internal use only. + + Dummy parameter. + Determines if the interactive sort must be respected. + Determines if the same level group should be used to search for item. + The value or null. + + + + Gets value of the first row. This method is for internal use only. + + Dummy parameter. + Determines if the interactive sort must be respected. + Determines if the same level group should be used to search for item. + The value or null. + + + + Gets value of the last row. This method is for internal use only. + + Dummy parameter. + Determines if the interactive sort must be respected. + Determines if the same level group should be used to search for item. + The value or null. + + + + Gets value of previous column. This method is for internal use only. + + Dummy parameter. + Determines if the interactive sort must be respected. + Determines if the same level group should be used to search for item. + The value or null. + + + + Gets value of previous row. This method is for internal use only. + + Dummy parameter. + Determines if the interactive sort must be respected. + Determines if the same level group should be used to search for item. + The value or null. + + + + Gets value of next column. This method is for internal use only. + + Dummy parameter. + Determines if the interactive sort must be respected. + Determines if the same level group should be used to search for item. + The value or null. + + + + Gets value of next row. This method is for internal use only. + + Dummy parameter. + Determines if the interactive sort must be respected. + Determines if the same level group should be used to search for item. + The value or null. + + + + Gets column total value. This method is for internal use only. + + Dummy parameter. + The value or null. + + + + Gets row total value. This method is for internal use only. + + Dummy parameter. + The value or null. + + + + Gets grand total value. This method is for internal use only. + + Dummy parameter. + The value or null. + + + + Gets column group total value. This method is for internal use only. + + Dummy parameter. + The value or null. + + + + Gets row group total value. This method is for internal use only. + + Dummy parameter. + The value or null. + + + + Gets column group max value. This method is for internal use only. + + Dummy parameter. + The value or null. + + + + Gets column group min value. This method is for internal use only. + + Dummy parameter. + The value or null. + + + + Gets row group max value. This method is for internal use only. + + Dummy parameter. + The value or null. + + + + Gets row group min value. This method is for internal use only. + + Dummy parameter. + The value or null. + + + + Gets percent of column total. This method is for internal use only. + + Dummy parameter. + The value. + + + + Gets percent of row total. This method is for internal use only. + + Dummy parameter. + The value. + + + + Gets percent of grand total. This method is for internal use only. + + Dummy parameter. + The value. + + + + Gets percent of previous column. This method is for internal use only. + + Dummy parameter. + Determines if the interactive sort must be respected. + Determines if the same level group should be used to search for item. + The value or null. + + + + Gets percent of previous row. This method is for internal use only. + + Dummy parameter. + Determines if the interactive sort must be respected. + Determines if the same level group should be used to search for item. + The value or null. + + + + The descriptor that is used to describe one element of the matrix header. + + + The class is used to define one header element of the matrix + (either the column element or row element). The key properties are + and . + The collection of descriptors used to represent the matrix header is stored + in the AdvMatrixObject.Data.Columns and AdvMatrixObject.Data.Rows properties. + + + + + Gets or sets the name of this descriptor. + + + This property is used by the TopN engine to find linked items such as TopNTotal, Others, OtherTotal. + All others descriptors have empty name. + + + + + Gets the parent descriptor of this descriptor. + + + + + Gets child items of this descriptor. + + + + + Gets or sets an expression which value will be used to fill the matrix. + + + Expression may be any valid expression. Usually it's a data column: + [DataSource.Column]. + + + + + Gets or sets a text which will be displayed in this item. + + + DisplayText may contain text mixed with expressions just like in the TextObject, e.g. "Some text: [expr]". + The default property value is empty for group descriptors. + In this case the group value returned by the property will be displayed in this item. + + + + + Gets or sets the filter expression. + + + + + Gets or sets the sort order of header values. + + + This property determines how the values displayed in this element are sorted. The default sort is ascending. + + + + + Gets or sets the sort button name which toggles the sort order of this item. + + + + + Gets or sets an expression which value will be used to sort the header values. + + This expression is used to sort header by its total value. The expression must contain single aggregate, e.g. "Sum([Table1.Field1])". + The empty expression (by default) indicates that the header should be sorted by its value. + + + + + Gets or sets a value indicating that this item can be sorted interactively. + + + + + Gets or sets an expression which value will be used to sort the header values interactively. + + This expression is used to sort header values when interactive sorting is on. + The expression must contain single aggregate, e.g. "Sum([Table1.Field1])". + The empty expression (by default) indicates automatic mode. + + + + + Gets or sets the visibility of this item. + + + + + Gets or sets the expression that returns the visibility of this item. + + + + + Gets or sets the collapse button name which toggles the visibility of this item. + + + + + Gets or sets a value indicating that the page break must be printed before this element. + + + Page break is not printed before the very first element. + + + + + Determines whether the item should merge itself with single subitem. + + + + + Determines whether this item and its subitems will be displayed stepped. + + + + + Gets TopN settings for this item. + + + + + Gets or sets column span of this item. 0 means span is set automatically. + + + + + Gets or sets row span of this item. 0 means span is set automatically. + + + + + Adds new child descriptor. + + The new descriptor. + + + + Adds a child descriptor. + + The new descriptor. + The new descriptor. + + + + + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the group expression specified. + + + + + Represents a base class for matrix buttons such as expand or sort button. + + + + + Determines the symbol size, in pixels. 0 indicates the auto size. + + + + + Determines whether this buttons belongs to column header. For internal use only. + + + + + Gets or set the index of this button. For internal use only. + + + + + + + + + + + Initializes a new instance of the class. + + + + + Represents the symbol used to display the matrix expand/collapse state. + + + + + Plus/minus. + + + + + The pointer. + + + + + The arrow. + + + + + Represents the matrix button used to toggle expand/collapse state of matrix headers. + + + + + Determines whether this button has a collapsed state. For internal use only. + + + + + Determines whether to show collapse/expand menu on right click. + + + + + Determines the symbol used to display the button's state. + + + + + Determines if only one button in the group can be expanded. + + + + + + + + + + + + + + For internal use only,return action click for Advanced Matrix collapse button + + + + + Initializes a new instance of the class. + + + + + + + + Represents the symbol used to display the matrix sort order. + + + + + The arrow. + + + + + The pointer. + + + + + Represents the matrix button used to toggle sort order of matrix headers. + + + + + Determines the sort state of this button. + + + + + Determines whether "None" sort is allowed when you switch sort states. + + + + + Determines the symbol used to display the state of this button. + + + + + Determines the color used to display button with inactive sort state (Sort = None). + + + + + + + + For internal use only,return action click for Advanced Matrix sort button + + + + + + + + + + + Initializes a new instance of the class. + + + + + + + + + Contains a set of properties and methods to hold and manipulate the matrix descriptors. + + + This class contains two collections of descriptors such as and + . Use collections' methods to add/remove descriptors. + When you are done, call the method to refresh the matrix. + + + + + Gets a collection of column descriptors. + + + Note: after you add or remove items in this collection, call the + method to refresh the matrix. + + + + + Gets a collection of row descriptors. + + + Note: after you add or remove items in this collection, call the + method to refresh the matrix. + + + + + Gets context required for aggregate calculation. + + + + + Processes single data row. + + + This method is used internally to process current data row. The matrix fills the column, row and cell data. + You should use this method if you fill a matrix in code using ManualBuild event. + + + + + Resets the data from the previous report run. + + + + + Initializes a new instance of the class. + + Reference to owner matrix. + + + + Represents the storage of header descriptors and its values. + + + + + Gets the root header descriptor. + + + + + Gets the size of this header. + + + + + + + + + + + Initializes a new instance of the class. + + + + + Stores the TopN settings of the matrix header item. + + + + + Gets or sets the TopN count. 0 means no TopN grouping will be performed. + + + + + Gets the properties of TopN total item. + + + + + Gets the properties of Others item. + + + + + Gets the properties of Others total item. + + + + + Stores the properties of TopN item. + + + + + Gets or sets the Name of the header descriptor item. + + + + + Gets or set the initial visibility of this item. + + + + + Gets or set the text of this item. Applicable to "Total" items. + + + + + Represents the matrix object that is used to print cross-table. + + + The matrix consists of the following elements: columns, rows and data cells. Each element is + represented by the descriptor. The class represents + columns and rows; data cells use dynamically created descriptors. + The property holds two root descriptors - Columns.Descriptor and Rows.Descriptor. + To create the matrix in a code, you should perform the following actions: + + + create an instance of the AdvMatrixObject and add it to the report; + + + create descriptors for columns and rows and add it to the + root descriptor using the matrix.Data.Columns.Descriptor and matrix.Data.Rows.Descriptor respectively; + + + call the method to create the matrix template + that will be used to create a result; + + + set the data cells content; + + + modify the matrix template (change captions, set the visual appearance). + + + To connect the matrix to a datasource, use the property. If + this property is not set, the result matrix will be empty. In this case you may use + the event handler to fill the matrix. + + This example demonstrates how to create a matrix in a code. + + // create an instance of AdvMatrixObject + AdvMatrixObject matrix = new AdvMatrixObject(); + matrix.Name = "Matrix1"; + // add it to the report title band of the first report page + matrix.Parent = (Report.Pages[0] as ReportPage).ReportTitle; + + // create two nested column descriptors and a total + HeaderDescriptor column = new HeaderDescriptor("[MatrixDemo.Year]"); + matrix.Data.Columns.Descriptor.Add(column); + HeaderDescriptor nestedColumn = new HeaderDescriptor("[MatrixDemo.Month]"); + column.Add(nestedColumn); + HeaderDescriptor columnTotal = new HeaderDescriptor(); + columnTotal.DisplayText = "Total"; + matrix.Data.Columns.Descriptor.Add(columnTotal); + + // create one row descriptor and a total + HeaderDescriptor row = new HeaderDescriptor("[MatrixDemo.Name]"); + matrix.Data.Rows.Descriptor.Add(row); + HeaderDescriptor rowTotal = new HeaderDescriptor(); + rowTotal.DisplayText = "Total"; + matrix.Data.Rows.Descriptor.Add(rowTotal); + + // connect matrix to a datasource + matrix.DataSource = Report.GetDataSource("MatrixDemo"); + + // create the matrix template + matrix.BuildTemplate(); + + // change the style + matrix.Style = "Gray"; + + // create data cells + string cellText = "[Sum([MatrixDemo.Revenue])]"; + for (int i = matrix.Data.Rows.Size; i < matrix.ColumnCount; i++) + for (int j = matrix.Data.Columns.Size; j < matrix.RowCount; j++) + matrix[i, j].Text = cellText; + + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets a data source. + + + When you create the matrix in the designer by drag-drop data columns into it, + this property will be set automatically. However you need to set it if you create + the matrix in code. + + + + + Gets the row filter expression. + + + This property can contain any valid boolean expression. If the expression returns false, + the corresponding data row will be skipped. + + + + + Gets or sets a matrix style. + + + + + Gets or sets even style priority for matrix cells. + + + + + Gets or sets data row priority for matrix cells. + + + + + Gets or sets a value indicating that empty matrix should be printed. + + + + + Gets or sets a value indicating that the matrix should reset its data on each report run. + + + Default value is false. In this case the matrix will use already prepared data when you refresh a report. + If you set it to true the matrix data will be reset on each report refresh. This also resets all user interaction such as + interactive sort and collapse state. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + See the event for more details. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + See the event for more details. + + + + + Allows to fill the matrix in code. + + + + + Allows to modify the prepared matrix elements such as cells, rows, columns. + + + + + Gets the object that holds the collection of descriptors used to build a matrix. + + + See the class for more details. + + + + + Gets or sets array of values that describes the currently printing column. + + + Use this property when report is running. It can be used to highlight matrix elements + depending on values of the currently printing column. To do this: + + + select the cell that you need to highlight; + + + click the "Highlight" button on the "Text" toolbar; + + + add a new highlight condition. Use the Matrix.ColumnValues to + refer to the value you need to analyze. Note: these values are array of dynamic, + so you don't need to cast it to actual type before making any comparisons. Example of highlight + condition: Matrix1.ColumnValues[0] == 2000. + + + + + + + + Gets or sets array of values that describes the currently printing row. + + + Use this property when report is running. It can be used to highlight matrix elements + depending on values of the currently printing row. To do this: + + + select the cell that you need to highlight; + + + click the "Highlight" button on the "Text" toolbar; + + + add a new highlight condition. Use the Matrix.RowValues to + refer to the value you need to analyze. Note: these values are arrays of dynamic, + so you don't need to cast it to actual type before making any comparisons. Example of highlight + condition: Matrix1.RowValues[0] == "Andrew Fuller". + + + + + + + + Gets or sets the index of currently printing column. + + + This property may be used to print even columns with alternate color. To do this: + + + select the cell that you need to highlight; + + + click the "Highlight" button on the "Text" toolbar; + + + add a new highlight condition that uses the Matrix.ColumnIndex, + for example: Matrix1.ColumnIndex % 2 == 1. + + + + + + + + Gets or sets the index of currently printing row. + + + This property may be used to print even rows with alternate color. To do this: + + + select the cell that you need to highlight; + + + click the "Highlight" button on the "Text" toolbar; + + + add a new highlight condition that uses the Matrix.RowIndex, + for example: Matrix1.RowIndex % 2 == 1. + + + + + + + + Gets or sets the data row index of currently printing header. + + + Use this value if you want to display the header value with its data row number, e.g. "1. Andrew Fuller". + To do this, set the header's DisplayExpression to something like this: Matrix1.RowNo + ". " + Value + + + + + Gets or sets count of items in the currently printing header. + + + + + + + + + + + + + + Creates or updates the matrix template. + + + Call this method after you modify the matrix descriptors using the object's properties. + + + + + This method fires the ManualBuild event and the script code connected to the ManualBuildEvent. + + Event data. + + + + This method fires the ModifyResult event and the script code connected to the ModifyResultEvent. + + Event data. + + + + Toggles visible state of the column with specified index. For internal use only. + + Index of column. + If true collapse all items. + If true expand all items. + + + + Toggles visible state of the row with specified index. For internal use only. + + Index of row. + If true collapse all items. + If true expand all items. + + + + Sort columns based on values of row with specified index. For internal use only. + + Index of row. + The sort order. + + + + Sort rows based on values of column with specified index. For internal use only. + + Index of column. + The sort order. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Describes how the even style is applied to a matrix. + + + + + The even style is applied to matrix rows. + + + + + The even style is applied to matrix columns. + + + + + The class for representing visible digital signature in the report. + + + + + Variants of filling + + + + + Solid filling of hatch and solid objects + + + + + Draw only borders of hatch and solid objects + + + + + Gets or sets lines/polygons gap for barcodes object, in millimeters + + + + + Gets or sets the dxf objects fill mode + + + + + Initializes a new instance of the class. + + + + + Export all report objects + + + + + + + + + Export of Band + + + + + + Begin exporting of page + + + + + + End exporting + + + + + + + + + + + + + + + Add BandObject. + + + + + Add TextObject. + + + + + Save DXF file. + + + + + Save DXF stream. + + + + + Add Line. + + + + + + + + Double precision 3D point value + + + + + Code range: 0-9 + String (with the introduction of extended symbol names in AutoCAD 2000, the 255-character + limit has been increased to 2049 single-byte characters not including the newline at the end + of the line) + + + + + Sets Name group + + Name (attribute tag, block name, and so on) + + + + Sets Name group + + Name (attribute tag, block name, ENDSEC, and so on) + + + + AutoCAD Color Index -> RGB Color table + + + + + RGB Color table -> AutoCAD Color Index + + + + + Get AutoCAD Color Index + + + AutoCAD Color Index + + + + Specifies the export font class. + + + + + These fonts do not support Bold or Itailc styles + + + + + Return text metric structure, need to use after FillOutlineTextMetrix() + + + + + Gets or sets internal font name + + + + + Return source font used in constructor + + + + + Returns multiplier for stroke bold emulation + + + + + Gets or sets internal reference + + + + + Gets or sets internal property - save flag + + + + + True if bold style is not supported by font + + + + + True if italic style is not supported by font + + + + + Mark font as editable for InteractiveForms + + + + + Get PostScript name of font + + + + + Return font file + + + + + + Get font data and set NeedSimulateBold and NeedSimulateItalic properties. Call this method after FillOutlineTextMetrix + + + + + Returns a list of font runs from the string specified. Also adds glyphs to the used glyphs table. + + + + + + + + + Get alphabet's subset from generation of pattern. + + Regular expression with pattern generator + Use left-to-right rules + + + + Return english name of source font + + + + + + Create object of ExportTTFFont. + + + + + + Destructor + + + + + CT command + + + + + CI command + + + + + EP command + Perimeter of polygon defined as polygon buffer by PM, PA/PR, PU/PD, + AA/AR, CI, and CT command is plotted. Pen position after command and + pen up / down state will be in state before command. + + + + + EA command + Rectangle which makes diagonal coordinates (x, y) specified the present position and + here is plotted. Pen position after command and pen up / down state will be in state before command. + + + + + ER command + Rectangle which makes diagonal relative coordinate (x, y) from the present position + and the present position is plotted. Pen position after command and pen up / down state + will be in state before command. + + + + + FP command + Shading of the inside of polygon defined as polygon buffer by PM, PA/PR, + PU/PD, AA/AR, CI, and CT command is carried out. Pen position after command + and pen up / down state will be in state before command. + + + + + RA command + It is used with FT and PT command and shading of the inside of rectangle which makes + diagonal point coordinates (x, y) specified the present position and here is carried out. + Pen position after command and pen up / down state will be in state before command. + + + + + RR command + It is used with FT and PT command and shading of the inside of rectangle which makes diagonal point + relative coordinate (x, y) from the present position and there is carried out. Pen position after command + and pen up / down state will be in state before command. + + + + + Model of shading + + + + + Painting out interactive at space specified by PT command (FT command interval and angle are ignored) + + + + + It is painting out (FT command space and angle are ignored) of the single direction at space specified by PT command. + + + + + Hatching which is the single direction at space and angle which were specified by FT command + + + + + It is crossing hatching at space and angle which were specified by FT command. + + + + + None (solid) + + + + + FT command + It is used together with FP, RA, RR, and WG command, and model of shading (painting out and hatching) is specified. + + + + + IN command + Plotter is changed into initial state. + + + + + IP command + Sets origin position of system of coordinates + + + + + Line Type + + + + + Point is plotted at specifying point + + + + + Dotted line of point + + + + + Short dotted line + + + + + Long dotted line + + + + + Short dashed line + + + + + Long dashed line + + + + + Two-point phantom line + + + + + No any patterns needed + + + + + LT command + + + + + PD command + + + + + PT command + It is used together with FP, FT, RR, RA, and WG command, and space (unit mm) of painting out + is specified between 0.1 and 5.0 in accordance with thickness of pen. Initial value is 0.3mm. + + + + + PU command + + + + + PA command + + + + + PR command + + + + + Polygon Type + + + + + Polygon buffer is cleared and it is made polygon definition mode. + + + + + Polygon under definition is closed. + + + + + Polygon under definition is closed and polygon definition mode is canceled. + + + + + PM command + It is made polygon definition mode. PM command is used with + PA/PR, PU/PD, AA/AR, CI, and CT command, and can define polygon. + + + + + RO command + + + + + SC command + + + + + SP command + + + + + PT command + It is used together with FP, FT, RR, RA, and WG command, and space (unit mm) of painting out + is specified between 0.1 and 5.0 in accordance with thickness of pen. Initial value is 0.3mm. + + + + + Variants of filling + + + + + Solid filling of hatch and solid objects + + + + + Draw only borders of hatch and solid objects + + + + + Gets or sets lines/polygons gap for barcodes object + + + + + Gets or sets the hpgl objects fill mode + + + + + Initializes a new instance of the class. + + + + + Save hpgl file. + + + + + Save hpgl stream. + + + + + Add BandObject. + + + + + Add TextObject. + + + + + + + + Begin exporting of page + + + + + + Export of Band + + + + + + End exporting + + + + + + + + + + + + + + + Export all report objects + + + + + + Add Line. + + + + + + + + Represents the HTML export filter. + + + + + + + + Draw any custom controls + + + + + Draw any custom controls. + + + + + + Types of html export + + + + + Simple export + + + + + Web preview mode + + + + + Web print mode + + + + + hash:base64Image + + + + + Gets or sets images, embedded in html (hash:base64Image) + + + + + Sets a ID of report + + + + + Sets an onclick template + + + + + Enable or disable layers export mode + + + + + For internal use only. + + + + + For internal use only. + + + + + For internal use only. + + + + + For internal use only. + + + + + For internal use only. + + + + + Enable or disable showing of print dialog in browser when html document is opened + + + + + Enable or disable a picture optimization. + + + + + Enable or disable preview in Web settings + + + + + Enable or disable the breaks between pages in print preview when single page mode is enabled + + + + + Specifies the output format + + + + + Specifies the width units in HTML export + + + + + Specifies the height units in HTML export + + + + + Enable or disable the pictures in HTML export + + + + + Enable or disable embedding pictures in HTML export + + + + + Enable or disable the WEB mode in HTML export + + + + + Gets or sets html export mode + + + + + Enable or disable the single HTML page creation + + + + + Enable or disable the page navigator in html export + + + + + Enable or disable the sub-folder for files of export + + + + + Gets or sets the WYSIWYG quality of export + + + + + Gets or sets the image format. + + + + + Gets print page data + + + + + Enable or disable saving streams in GeneratedStreams collection. + + + + + Enable or disable margins for pages. Works only for Layers-mode. + + + + + Enable or disable export of vector objects such as Barcodes in SVG format. + + + + + Not rotate landscape page when print. + + + + + + + + + + + + + + + + + Process Page with number p and real page ReportPage + + + + + + + + Process Page with number p and real page ReportPage + + + + + + + + + + + + + For internal use only. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class for WebPreview mode. + + + + + + + + For developers only + + + + + Event arguments for custom drawing of report objects. + + + + + Report object + + + + + ReportObject. + + + + + Resulting successful drawing flag. + + + + + Resulting HTML string. + + + + + Resulting CSS string. + + + + + Layers mode when true or Table mode when false. + + + + + Zoom value for scale position and sizes. + + + + + Left position. + + + + + Top position. + + + + + Width of object. + + + + + Height of object. + + + + + Represents the HTML export templates. + + + + + Page Template Title + + + + + Page Template Footer + + + + + Navigator Template + + + + + OutlineTemplate + + + + + Index Template + + + + + Initializes a new instance of the class. + + + + + Represents the HTML export format enum + + + + + Represents the message-HTML type + + + + + Represents the HTML type + + + + + Specifies the image format in HTML export. + + + + + Specifies the .bmp format. + + + + + Specifies the .png format. + + + + + Specifies the .jpg format. + + + + + Specifies the .gif format. + + + + + Specifies the units of HTML sizes. + + + + + Specifies the pixel units. + + + + + Specifies the percent units. + + + + + For internal use only. + + + + + For internal use only. + + + + + For internal use only. + + + + + For internal use only. + + + + + For internal use only. + + + + + For internal use only. + + + + + For internal use only. + + + + + For internal use only. + + + + + For internal use only. + + + + + For internal use only. + + + + + Excel 2003 export class + + + + + + + + Gets or sets a value that determines whether the wysiwyg mode should be used + for better results. + + + + + Gets or sets a value that determines whether to insert page breaks in the output file or not. + + + + + Gets or sets a value that determines whether to hide gridlines. + + + + + Enables or disables optimization of images for printing. + + + + + Read and parse Excel document + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Related to DRAWING group. Used once + + + + + Provides API to binary stream + + + + + + + + + + Represents the CSV export filter. + + + + + + + + Gets or set the resulting file encoding. + + + + + Gets or set the separator character used in csv format. + + + + + Gets or sets a value that determines whether to export the databand rows only. + + + + + Gets or sets a value that disable quotation marks for text. + + + + + Gets or sets a value that disable escaping quotation marks for text. + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Represents the export to DBF. + + + + + + + + Gets or sets the encoding. + + + + + Gets or sets a value that determines whether to export the databand rows only. + + + + + Gets or sets a value that determines whether to export the types of fields. + + + + + Gets or sets the list of field names. + + + The field names must be separated by ";" symbol, for example: Column1;Column2;Column3 + + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + + + + + + + + + + + + + Represents the record. + + + + + Types of fields. + + + + + Boolean type in DBF equal Logical marked 'L'. + + + + + DataTime type in DBF equal DataTime marked 'T'. + + + + + String type in DBF equal Character marked 'C'. + + + + + Decimal type in DBF equal Numeric marked 'N'. + + + + + Currency type 'Y' + + + + + Integer type in DBF equal Integer marked 'I'. + + + + + Gets or sets the field with a specified index. + + + + + Gets the count of a fields. + + + + + Gets the size of a fields. + + + + + Initializes a new instance of the class. + + + + + Adds the new item into a list of fields. + + + + + Clears the list of fields. + + + + + Represents the field. + + + + + Gets or sets data in field + + + + + Gets or sets type of field + + + + + Represents the email export. + + + In order to use this class, you need to set up at least the following properties: + , , . Use the + property to choose the format of an attachment. If you leave it empty, the attachment will be + in the .FRP format (FastReport prepared report). When you done with settings, call the + method to send an email. + + + This example demonstrates the bare minimum required to send an email. + + EmailExport export = new EmailExport(); + export.Account.Address = "my@address.net"; + export.Account.Host = "myhost"; + export.Address = "recipient@address.net"; + export.Subject = "Re: analysis report"; + // the report1 report must be prepared at this moment + export.SendEmail(report1); + + + + + + Displays the dialog box in which you can set up all parameters. + + true if user pressed OK button in the dialog. + + + + Gets or sets the recipient's address. + + + This property must contain value in form "john@url.com". + + + + + Gets or sets the carbon copy adresses. + + + This property must contain an array of values in form "john@url.com". + + + + + Gets or sets the subject of the message. + + + + + Gets or sets the message body. + + + + + Gets or sets the name attachment file. + + + + + Gets or sets the export filter which will be used to export a report. + + + Set this property to instance of any export filter. When you send the email, the report + will be exported using that export filter. + By default, this property is set to null. In this case the report will be send + in .FRP format. + + + + + Gets the email account settings such as host, user name, password. + + + + + Gets the parent Report object + + + + + Sends an email. + + Reports that will be sent as attachments. + + Before using this method, set up the following properties (it's a bare minimum): + , , . + The report that you pass in this method must be prepared using the Prepare method. + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with default settings. + + + + + Form for . + For internal use only. + + + + + Hides attachment settings. + For internal use only. + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Allows to send message using MAPI interface. + + + + + Sends a message. + + Parent window handle. + Files to attach. + Email subject. + Email body. + Recipient names. + Recipient addresses. + Error code. 0 if operation was completed succesfully. + + + + Returns a text describing an error. + + The error code. + The text describing an error. + + + + Contains the email account settings such as host, email address, name. + + + You have to set up at least the and properties. If your + host requires authentication, provide the and + properties as well. + Set property to true if you want to use default email client + such as Outlook to send an email. In this case, all other properties will be ignored. + + + + + Gets or sets the sender's email address. + + + This property contains your email address (for example, "john@site.com"). + + + + + Gets or sets the sender's name. + + + This property contains your name (for example, "John Smith"). + + + + + Gets or sets the template that will be used to create a new message. + + + + + Gets or sets the SMTP host name or IP address. + + + + + Gets or sets the SMTP port. + + + The default value for this property is 25. + + + + + Gets or sets the user name. + + + Specify the and properties if your host requires + authentication. + + + + + Gets or sets the password. + + + Specify the and properties if your host requires + authentication. + + + + + Gets or sets a value that determines whether to enable the SSL protocol. + + + + + Gets or sets a value that determines whether the account setting page + in the "Send Email" window is enabled. + + + + + Gets or sets a value that determines whether to use MAPI instead of SMTP when sending an email. + + + + + Copies email settings from another source. + + Source to copy settings from. + + + + Initializes a new instance of the class with default settings. + + + + + The base class for all export filters. + + + + + Exports the report to a file. + + Report to export. + Pages of open tabs. + true if report was succesfully exported. + + This method displays an export options dialog, then prompts a file name using standard "Open file" + dialog. If both dialogs were closed by OK button, exports the report and returns true. + + + + + Displays a dialog with export options. + + true if dialog was closed with OK button. + + + + Gets a report page with OverlayBand if it is a Demo or Academic. + + The prepared report page + The prepared report page with OverlayBand. + + + + Gets list of generated streams. + + + + + Zoom factor for output file + + + + + File filter that can be used in the "Save file" dialog. + + + + + Range of pages to export. + + + + + Page numbers to export. + + + Use page numbers separated by comma and/or page ranges, for example: "1,3-5,12". Empty string means + that all pages need to be exported. + + + + + Current page number. + + + Page number need to be exported if user selects "Current page" radiobutton in the export options dialog. + This property is typically set to current page number in the preview window. + + + + + Open the document after export. + + + + + Allows or disables the OpenAfterExport feature. + + + + + Gets or sets a value that determines whether to show progress window during export or not. + + + + + Gets a list of files generated by this export. + + + + + Gets a value indicating that the export may produce multiple output files. + + + + + Gets or sets a value indicating that the report bands should be shifted, if page + has any non-exportable bands + + + + + Gets or sets the initial directory that is displayed by a save file dialog. + + + + + Gets or sets a value indicating that pages will exporting from all open tabs. + + + + + Stream to export to. + + + + + File name to export to. + + + + + Array of page numbers to export. + + + + + Returns a file filter for a save dialog. + + String that contains a file filter, for example: "Bitmap image (*.bmp)|*.bmp" + + + + This method is called when the export starts. + + + + + This method is called at the start of exports of each page. + + Page for export may be empty in this method. + + + + This method is called at the end of exports of each page. + + Page for export may be empty in this method. + + + + This method is called for each band on exported page. + + Band, dispose after method compite. + + + + This method is called when the export is finished. + + + + + Gets a report page with specified index. + + Zero-based index of page. + The prepared report page. + + + + + + + + + + Exports the report to a stream. + + Report to export. + Stream to export to. + + This method does not show an export options dialog. If you want to show it, call + method prior to calling this method, or use the "Export(Report report)" method instead. + + + + + Exports the report to a file. + + Report to export. + File name to export to. + + This method does not show an export options dialog. If you want to show it, call + method prior to calling this method, or use the "Export(Report report)" method instead. + + + + + Initializes a new instance of the class. + + + + + Represents the MHT export filter. + + + + + + + + Enable or disable the pictures in MHT export + + + + + Gets or sets the Wysiwyg quality of export + + + + + Gets or sets the image format. + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Represents the image export filter. + + + + + + + + Gets or sets the image format. + + + + + Gets or sets a value that determines whether to generate separate image file + for each exported page. + + + If this property is set to false, the export filter will produce one big image + containing all exported pages. Be careful using this property with a big report + because it may produce out of memory error. + And also when using Memory Stream and the value is true, an exception will be thrown. + + + + + Gets or sets image resolution, in dpi. + + + By default this property is set to 96 dpi. Use bigger values (300-600 dpi) + if you going to print the exported images. + + + + + Gets or sets horizontal image resolution, in dpi. + + + Separate horizontal and vertical resolution is used when exporting to TIFF. In other + cases, use the property instead. + + + + + Gets or sets vertical image resolution, in dpi. + + + Separate horizontal and vertical resolution is used when exporting to TIFF. In other + cases, use the property instead. + + + + + Gets or sets the jpg image quality. + + + This property is used if is set to Jpeg. By default + it is set to 100. Use lesser value to decrease the jpg file size. + + + + + Gets or sets the value determines whether to produce multi-frame tiff file. + + + + + Gets or sets a value that determines whether the Tiff export must produce monochrome image. + + + Monochrome tiff image is compressed using the compression method specified in the + property. + + + + + Gets or sets the compression method for a monochrome TIFF image. + + + This property is used only when exporting to TIFF image, and the property + is set to true. + The valid values for this property are: EncoderValue.CompressionNone, + EncoderValue.CompressionLZW, EncoderValue.CompressionRle, + EncoderValue.CompressionCCITT3, EncoderValue.CompressionCCITT4. + The default compression method is CCITT4. + + + + + Sets padding in non separate pages + + + + + Enable or disable saving streams in GeneratedStreams collection. + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Specifies the image export format. + + + + + Specifies the .bmp format. + + + + + Specifies the .png format. + + + + + Specifies the .jpg format. + + + + + Specifies the .gif format. + + + + + Specifies the .tif format. + + + + + Specifies the .emf format. + + + + + Represents the JSON export filter. + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Represents the LaTeX export filter. + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Base class for any ODF exports. + + + + + + + + Enum of OpenOffice formats. + + + + + OpenOffice Spreadsheet format. + + + + + OpenOffice Writer format. + + + + + Standard of ODF format. + + + + + ODF 1.0/1.1 + + + + + ODF 1.2 + + + + + XODF 1.0/1.1 + + + + + XODF 1.2 + + + + + Creator of the document + + + + + Is XODT format + + + + + Switch of page breaks + + + + + Wysiwyg mode, set for better results + + + + + Gets or sets locale for all document. + + + + + Gets or sets a value indicating that locale export are enabled. + + + + + Gets or sets ODF Compliance standard. + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + + + + Open Document Spreadsheet export (Open Office Calc). + + + + + Initializes a new instance of the class. + + + + + + + + Open Document Text export (Open Office Writer). + + + + + Initializes a new instance of the class. + + + + + + + + MS Word 2007 export class + + + + + + + + Types of table rows height + + + + + Exactly height + + + + + Minimum height + + + + + Enable or disable matrix view of document + + + + + Enable or disable Paragraph view of document + + + + + Disable section break in document + + + + + Gets or sets a value that determines whether the wysiwyg mode should be used + for better results. + + + Default value is true. In wysiwyg mode, the resulting Excel file will look + as close as possible to the prepared report. On the other side, it may have a lot + of small rows/columns, which will make it less editable. If you set this property + to false, the number of rows/columns in the resulting file will be decreased. + You will get less wysiwyg, but more editable file. + + + + + Gets or sets the type of height calculation. + + + + + Gets or sets the type of height calculation. + + + + + Enable or disable a resolution optimization. + + + + + Get or set a locale for all document. + + + + + Gets or sets a value indicating that locale export are enabled. + + + + + Gets or sets the value for adding bookmarks to each page. + + + + + Enable or disable DoNotExpandShiftReturn. + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the Word2007Export class. + + + + + Represents the PowerPoint 2007 export. + + + + + + + + Gets or sets the image format used when exporting. + + + + + Get or set a locale for all document. + + + + + Gets or sets a value indicating that locale export are enabled. + + + + + + + + + + + + + + + + + + + + + + + Get loacalization name. + + + + + + + + + Creates a new instance of the class with the default settings. + + + + + Excel 2007 export class + + + + + + + + Defines Print Scaling Mode. + + + + + Print sheets at thier actual size. + + + + + Shrink the printout so that it fits on one page. + + + + + Shrink the printout so that it is one page wide. + + + + + Shrink the printout so that it is one page high. + + + + + Move and modify the picture along with the cell. + + + + + Move but not resize the picture along with the cell. + + + + + Do not move or resize the picture along with the cell. + + + + + Gets or sets the Print Fit Mode. + + + + + Gets or sets the print scaling (value from 10 to 400). + + + + + Gets or sets the pinned cells in X ordinate. + + + + + Gets or sets the pinned cells in Y ordinate. + + + + + Sets or gets the flag using the preset print scale. + + + + + Gets or sets a value that determines whether the using locale data formatting. + + + + + Enable or disable show gridlines. + + + + + Gets or sets the font scale value. + Default value is 1 + + + + + Enable or disable a resolution optimization. + + + + + Each report page is placed on a new Excel page. + + + + + Each group is placed on a new Excel page. + + + + + Name of the selected group. + + + + + Gets or sets a value that determines whether the wysiwyg mode should be used + for better results. + + + Default value is true. In wysiwyg mode, the resulting Excel file will look + as close as possible to the prepared report. On the other side, it may have a lot + of small rows/columns, which will make it less editable. If you set this property + to false, the number of rows/columns in the resulting file will be decreased. + You will get less wysiwyg, but more editable file. + + + + + Gets or sets a value indicating that FileStream should be used instead of MomoryStream during export. + + + Enabling this option will reduce memory consumption, but increase the time of export. + + + + + Gets or sets a value indicating that currency should be converted to accounting format. + + + + + Gets or sets a value indicating that general should be converted to text format. + + + + + For delete temp files + + + + + Gets or sets a value that determines whether to insert page breaks in the output file or not. + + + + + Gets or sets a value that determines whether to export the databand rows only. + + + + + Enable or disable export of page footers and next page headers without table breaks. + + + + + Gets or sets a value that determines whether to export the databand rows only. + + + + + Grouping or ungrouping sheets. Grouping is enabled by default. + + + + + + + + + + + + + + + + + + + + + + + Gets the file name to export to. + + The full file name to export to. + + + + + + + Initializes a new instance of the class. + + + + + Main class of XML export + + + + + + + + PicturesCount + + + + + HumanReadable + + + + + + + + + + + + + + + + + + + + + + + Constructor of XPSExport + + + + + Destructor of XPSExport + + + + + Save + + + + + + + + + + + Padding over ridh object + + + + + This prperty keep RTF to DOC translation result, i.e. DOCX XML fragment + + + + + Base class for Microsoft Office 2007 export objects + + + + + Default XML header + + + + + Base class for export Office Open objects + + + + + Core document properties + + + + + Core document properties + + + + + Power point shape + + + + + Power Point Layout Descriptor + + + + + Power Point base class for style element + + + + + Base class for styles group + + + + + Base class for slides, masters, and layouts + + + + + Slide masters object + + + + + Ordinaty slide + + + + + Slide layout object + + + + + Presentation class + + + + + PPt Application Properties class + + + + + Ppt Table styles class + + + + + Ppt Presentation properties class + + + + + Ppt View Properties class + + + + + Specifies the image format in PowerPoint export. + + + + + Specifies the .png format. + + + + + Specifies the .jpg format. + + + + + Drawing class + + + + + Share all strings in document + + + + + Share all URL in document + + + + + Document styles + + + + + Workbook + + + + + OoXMLSheet class + + + + + Picture container + + + + + List of all document fonts + + + + + Single page export + + + + + Document structure descriptor + + + + + Font container + + + + + Font obfuscation procedure + + + + + PDF export (Adobe Acrobat) + + + + + + + + Embedded File + + + + + Name of embedded file. + + + + + Description of embedded file. + + + + + Modify Date of embedded file. + + + + + Relationship between the embedded document and the PDF part. + + + + + Valid MIME type. + + + + + Stream of embedded file. + + + + + File reference. + + + + + ZUGFeRD Conformance Level. + + + + Initializes a new instance of the class. + + + + Default preview size. + + + + + Actual size + + + + + Fit Page + + + + + Fit Width + + + + + Default + + + + + 10% + + + + + 25% + + + + + 50% + + + + + 75% + + + + + 100% + + + + + 125% + + + + + 150% + + + + + 200% + + + + + 400% + + + + + 800% + + + + + Standard of PDF format. + + + + + PDF 1.5 + + + + + PDF/A-1a + + + + + PDF/A-2a + + + + + PDF/A-2b + + + + + PDF/A-2u + + + + + PDF/A-3a + + + + + PDF/A-3b + + + + + Pdf/X-3 + + + + + Pdf/X-4 + + + + + Color Space. + + + + + RGB color space + + + + + CMYK color space + + + + + Types of pdf export. + + + + + Simple export + + + + + Web print mode + + + + + Relationship between the embedded document and the PDF part. + + + + + The embedded file contains data which is used for the visual representation. + + + + + The embedded file contains the source data for the visual representation derived therefrom in the PDF part. + + + + + This data relationship should be used if the embedded data are an alternative representation of the PDF contents. + + + + + This data relationship is used if the embedded file serves neither as the source nor as the alternative representation, but the file contains additional information. + + + + + If none of the data relationships above apply or there is an unknown data relationship, this data relationship is used. + + + + + ZUGFeRD Conformance Level. + + + + + Basic level. + + + + + Comfort level. + + + + + Extended level. + + + + + Gets or sets PDF Compliance standard. + After set, do not change other settings, it may lead to fail compliance test. + + + + + Enable or disable of embedding the TrueType fonts. + + + + + Enable or disable of exporting the background. + + + + + Enable or disable export text in curves + + + + + Gets or sets PDF color space + + + + + Enables or disables saving images in their original resolution + + + + + Enables or disables optimization of images for printing + + + + + Enable or disable image jpeg compression + + + + + Sets the quality of images in the PDF + + + + + Title of the document. + + + + + Author of the document. + + + + + Subject of the document. + + + + + Keywords of the document. + + + + + Creator of the document. + + + + + Producer of the document. + + + + + Sets the owner password. + + + + + Sets the user password. + + + + + Enable or disable printing in protected document. + + + + + Enable or disable modifying in protected document. + + + + + Enable or disable copying in protected document. + + + + + Enable or disable annotating in protected document. + + + + + Enable or disable the print dialog window after opening + + + + + Enable or disable hide the toolbar. + + + + + Enable or disable hide the menu's bar. + + + + + Enable or disable hide the Windows UI. + + + + + Enable or disable of fitting the window + + + + + Enable or disable of centering the window. + + + + + Enable or disable of scaling the page for shrink to printable area. + + + + + Enable or disable of document's Outline. + + + + + Set default zoom on open document + + + + + Sets the quality of RichText objects in the PDF + + + + + Enable or disable the compression in PDF document. + + + + + Enable or disable of images transparency. + + + + + Enable or disable of displaying document's title. + + + + + Set default page on open document + + + + + Color Profile (ICC file). + If "null" then default profile will be used + + + + + Gets or sets pdf export mode + + + + + Gets pdf AcroForms compatibility, if set then EmbeddingFonts = false and PdfCompliance = PdfStandard.None + + + + + Set pattern for selection of embedding glyphs for Interactive Forms + + + + + Enable or disable using FileStream instead of MemoryStream when exporting. + Its useful when exporting huge reports on machines with small amount of RAM. + + + + + Enable or disable digital sign for pdf document + + + Be sure to specify a valid certificate for signing using the DigitalSignCertificate property. + Or using the DigitalSignCertificatePath and DigitalSignCertificatePassword properties. + + + + + Should save and serialize password for digital sign certificate. + Do not save password unless absolutely necessary!!! + + + + + Manualy sets digital sign certificate for exported documents. + + + This property is in priority, i.e. if a certificate is specified, + the DigitalSignCertificatePath and DigitalSignCertificatePassword properties will not be used. + + + + + The path for load digital sign certificate. + + + + + Sets digital sign certificate password. + + + + + Gets or sets the cpu host name or physical location of the signing + + + + + The reason for the signing, such as (I agree ...) + + + + + The information to enable the recipient to contact the signer to verify the signature + + + + + + + + + + + Begin exporting of page + + + + + + End exporting + + + + + + Export of Band + + + + + + + + + + + + Add an embedded XML file (only for PDF/A-3 standard). + + File name + Description + Modification date + File stream + + + + Add an embedded XML file (only for PDF/A-3 standard). + + File name + Description + Modification date + File stream + ZUGFeRD Conformance Level + + + + Add an embedded file (only for PDF/A-3 standard). + + File name + Description + Modification date + Relation type + MIME type + File stream + + + + Initializes a new instance of the class. + + + + + Calculates mask for image. + + + + + Calculates image bounds according to . + + + + + Writes pixels' colors without alpha to stream according to CMYK or RGB color space. + Pixels should be in the format. + + + + + Update stream position for object number, only for int value + + int value + + + + + + The pdf export + size of place for svg + + + + The interpolation of curves (svg) + + + + + The interpolation of curves (text) + + + + + Export svg object as image, not vector + + + + + Gradient interpolation, high value will lead beautiful the gradient, + but the file size will increase and the speed of work will decrease. + + + + + The quality of gradient, export as image or export as gradient grid + + + + + Added graphics path to pdf, + + size of rect for gradient filling + path, with positions in pdf scaling + Any brush + Interpolation value + + matrix for transform to pdf scale + + + + returns true if this gradient is fillable by gradient grid + + + + + + The enum of curves interpolation + + + + + Export as curves, without interpolation + + + + + Two points + + + + + Four points + + + + + Eight points + + + + + Sixteen points + + + + + The enum of gradient interpolation points + + + + + Two points + + + + + Four points + + + + + Eight points + + + + + Sixteen points + + + + + Thirty two points + + + + + Sixty four points + + + + + One hundred and twenty eight points + + + + + Two hundred and fifty six points + + + + + The quality of gradient export + + + + + Export as image + + + + + Export as low quality gradient grid, max size of interpolation points is 32 + + + + + Export as medium quality gradient grid, max size of interpolation points is 128 + + + + + Export as high quality gradient grid, max size of interpolation points is 256 + + + + + File name without extentions, for example "MetaDataX" + + + + Represents the PPML export filter. + + + + + + + + Enable or disable the pictures in PPML export + + + + + Add TextObject. + + + + + Add BandObject. + + + + + Add Line. + + + + + Add Shape. + + + + + + + + Begin exporting of page + + + + + + Export of Band + + + + + + End exporting + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Contains Dashes enum + + + + + Specifies the Dash. + + + + + Specifies the Dot. + + + + + Specifies the DashDot. + + + + + Specifies the DashDotDot. + + + + + Specifies the Double line. + + + + + Create Window. + + + + + Add image as PPMLObject + + + + + + + + + + Save svg file. + + + + + Save svg stream. + + + + + + + + + + Represents the ps export filter. + + + + + + + + Enable or disable the pictures in PS export + + + + + Enable or disable export text in curves + + + + + Enable or disable export every page in separate file + + + + + Enable or disable saving every image in separate file + + + + + Gets or sets quality of JPEG images + + + + + Add TextObject. + + + + + Add BandObject. + + + + + Add Line. + + + + + Add Shape. + + + + + + + + Begin exporting of page + + + + + + Export of Band + + + + + + End exporting + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Contains Dashes enum + + + + + Specifies the Dash. + + + + + Specifies the Dot. + + + + + Specifies the DashDot. + + + + + Specifies the DashDotDot. + + + + + Specifies the Double line. + + + + + Create Window. + + + + Add TextLine in curves + + + + Method for add TextObject. + + + + + Method to add rectangle. + + + + + Method for add ellips. + + + + + Method for add triangle. + + + + + Method for add Diamond. + + + + + Method for add line. + + + + + Method for add line with dash. + + + + + Add image + + + + + + + + + + + Add image as hex code + + + + + + + + + + End of each page + + + + + Save file. + + + + + Save stream. + + + + + + + + + Represents the RTF export filter. + + + + + + + + Gets or sets the quality of Jpeg images in RTF file. + + + Default value is 90. This property will be used if you select Jpeg + in the property. + + + + + Gets or sets the image format that will be used to save pictures in RTF file. + + + Default value is Metafile. This format is better for exporting such objects as + MSChartObject and ShapeObject. + + + + + Gets or sets a value indicating that pictures are enabled. + + + + + Gets or sets a value indicating that page breaks are enabled. + + + + + Get or set a locale for all document. + + + + + Gets or sets a value indicating that locale export are enabled. + + + + + Gets or sets a value that determines whether the wysiwyg mode should be used + for better results. + + + Default value is true. In wysiwyg mode, the resulting rtf file will look + as close as possible to the prepared report. On the other side, it may have a lot + of small rows/columns, which will make it less editable. If you set this property + to false, the number of rows/columns in the resulting file will be decreased. + You will get less wysiwyg, but more editable file. + + + + + Gets or sets the PrintOptimized. + + + + + Gets or sets the creator of the document. + + + + + Gets or sets a value that determines whether the rows in the resulting table + should calculate its height automatically. + + + Default value for this property is false. In this mode, each row in the + resulting table has fixed height to get maximum wysiwyg. If you set it to true, + the height of resulting table will be calculated automatically by the Word processor. + The document will be more editable, but less wysiwyg. + + + + + Gets or sets a value that determines whether the repot's RichObject will be + translated as picture or joined to generated RTF. + + + Default value for this property is false. In this mode, each RichObject + will be embedded as a picture. This is default behavior. If you set it to true, + the RichObject will be incorporated as a navive part of document. This is experimetal + feature. + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Specifies the image format in RTF export. + + + + + Specifies the .png format. + + + + + Specifies the .jpg format. + + + + + Specifies the .emf format. + + + + + Represents the SVG export filter. + + + + + + + + Enable or disable the pictures in SVG export + + + + + Gets or sets the image format used when exporting. + + + + + Embed images into svg + + + + + Gets or sets value indicating whether or not should to force uniform scaling of SVG document + + + + + Gets or sets value indicating whether or not should be added 'viewBox' attribute to the svg tag + + + + + Gets or sets value indicating whether or not should be added 'width' and 'height' attributes to the svg tag + + + + + Gets or sets the prefix for style classes and object ids + + + + + + + + Begin exporting of page + + + + + + + + + End exporting + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Specifies the alignment methods + + + + + Do not force uniform scaling. Scale the graphic content of the given element non-uniformly + if necessary such that the element's bounding box exactly matches the viewport rectangle. + + + + + Force uniform scaling. Align the min-x of the element's viewBox with the smallest X value + of the viewport. Align the min-y of the element's viewBox with the smallest Y value of the viewport. + + + + + Force uniform scaling. Align the midpoint X value of the element's viewBox with the midpoint + X value of the viewport. Align the min-y of the element's viewBox with the smallest Y value + of the viewport. + + + + + Force uniform scaling. Align the min-x+width of the element's viewBox with the maximum X value + of the viewport. Align the min-y of the element's viewBox with the smallest Y value of the viewport. + + + + + Force uniform scaling. Align the min-x of the element's viewBox with the smallest X value of + the viewport. Align the midpoint Y value of the element's viewBox with the midpoint Y value + of the viewport. + + + + + The default. Force uniform scaling. Align the midpoint X value of the element's viewBox + with the midpoint X value of the viewport. Align the midpoint Y value of the element's + viewBox with the midpoint Y value of the viewport. + + + + + Force uniform scaling. Align the min-x+width of the element's viewBox with the maximum X + value of the viewport. Align the midpoint Y value of the element's viewBox with the midpoint + Y value of the viewport. + + + + + Force uniform scaling. Align the min-x of the element's viewBox with the smallest X value of + the viewport. Align the min-y+height of the element's viewBox with the maximum Y value of the viewport. + + + + + Force uniform scaling. Align the midpoint X value of the element's viewBox with the midpoint X + value of the viewport. Align the min-y+height of the element's viewBox with the maximum Y value + of the viewport. + + + + + Force uniform scaling. Align the min-x+width of the element's viewBox with the maximum X value of + the viewport. Align the min-y+height of the element's viewBox with the maximum Y value of the viewport. + + + + + Specifies the svg scale types + + + + + (the default) - Scale the graphic such that: + - aspect ratio is preserved + - the entire viewBox is visible within the viewport + - the viewBox is scaled up as much as possible, while still meeting the other criteria + + + + + Scale the graphic such that: + - aspect ratio is preserved + - the entire viewport is covered by the viewBox + - the viewBox is scaled down as much as possible, while still meeting the other criteria + + + + + Describes scaling of a svg documents + + + + + Gets the align value + + + + + Gets the meetOrSlice value + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + Align value + meetOrSlice value + + + + Represents the text export. + + + + + + + + Enable or disable the Data loss avoiding. + Auto calculation of ScaleX and ScaleY will be launched when dialogue window will be off. + + + + + Gets or sets the count of copies for printing of results. + + + + + Gets or sets the printer name for printing of results. + + + + + Enable or disable the printing results after export. + + + + + Gets or sets the active index of registered printer type. + + + + + Gets or sets the list of printer types. + + + + + Gets or sets the scale by X axis for correct text objects placement. + + + + + Gets or sets the scale by Y axis for correct text objects placement. + + + + + Gets or sets the encoding of resulting document. + + + Windows ANSI encoding + TextExport.Encoding = Encoding.Default; + Unicode UTF-8 encoding + TextExport.Encoding = Encoding.UTF8; + OEM encoding for current system locale sessings + TextExport.Encoding = Encoding.GetEncoding(CultureInfo.CurrentCulture.TextInfo.OEMCodePage); + + + + + Enable or disable the data only output without any headers. Default value is false. + + + + + Enable or disable the breaks of pages in resulting document. Default value is true. + + + + + Enable or disable frames in resulting document. Default value is true. + + + + + Enable or disable the text (non graphic) frames in resulting document. Default value is false. + + + + + Enable or disable the output of empty lines in resulting document. Default value is false. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Exports the page. + + + + + + + Calculates scale. + + + + + + Initializes a new instance of the class. + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents the printer command class + + + + + Gets or sets the active state of command. Default value is false. + + + + + Gets or sets the command name. + + + + + Gets or sets the list of "on sequence". + + + + + Gets or sets the list of "off sequence". + + + + + Initializes a new instance of the class. + + + + + Represents of the printer type class. + + + + + Gets or sets the printer name. + + + + + Gets or sets the list of printer commands. + + + + + Initializes a new instance of the class. + + + + + Represents supplement class for print of any stream directly in printer. + + + + + Prints a stream. + + Printer name on which should be print. + Document title for printer spooler. + Count of copies. + Stream that will be printed. + This example demonstrates the printing of Stream. + + TextExportPrint.PrintStream("EPSON FX-1000", "My Report", 1, txtStream) + + + + + Represents the XAML export filter. + + + + + + + + Gets or sets the class name of XAML document + + + + + Enable or disable the pictures in XAML export + + + + + Gets or sets the image format used when exporting. + + + + + Get or set scrollbar settings + + + + + Get dictionary of saved images + + + + + Add TextObject. + + + + + Add BandObject. + + + + + Add Line. + + + + + Add Shape. + + + + + + + + Begin exporting of page + + + + + + Export of Band + + + + + + End exporting + + + + + + + + + + + + Gem MemoryStream what contain image + + + + + + + + + + Initializes a new instance of the class. + + + + + Contains Dashes enum + + + + + Specifies the Dash. + + + + + Specifies the Dot. + + + + + Specifies the DashDot. + + + + + Specifies the DashDotDot. + + + + + Specifies the Double line. + + + + + XAML generator + + + + + Create Window. + + + + + Create Grid. + + + + + Create Canvas. + + + + + Create StackPanel + + + + + Create StackPanel + + + + + Create Resources tag + + + + + Add resource for TextObject + + + + + Add resource for TextObject with angle + + + + + Add resource for Line + + + + + Add resource for Rectangle + + + + + Add resource for Ellipse + + + + + Add resource for Polygon + + + + + Add TextObject. + + + + + Method for add TextObject with angle + + + + + Add line. + + + + + Add line with dash. + + + + + Add rectangle. + + + + + Add ellips. + + + + + Add triangle. + + + + + Add Diamond. + + + + + Add image + + + + + + + + + + + + Add image without name + + + + + + + + + + + Add page to StackPanel + + + + + + Save xaml file. + + + + + Save xaml stream. + + + + + + + + + + + + + Specifies the image format in XAML export. + + + + + Specifies the .png format. + + + + + Specifies the .jpg format. + + + + + Represents the Excel 2003 XML export filter. + + + + + + + + Gets or sets a value that determines whether to insert page breaks in the output file or not. + + + + + + Gets or sets a value that determines whether the wysiwyg mode should be used + for better results. + + + Default value is true. In wysiwyg mode, the resulting Excel file will look + as close as possible to the prepared report. On the other side, it may have a lot + of small rows/columns, which will make it less editable. If you set this property + to false, the number of rows/columns in the resulting file will be decreased. + You will get less wysiwyg, but more editable file. + + + + + Gets or sets the name of document creator. + + + + + Gets or sets a value that determines whether to export the databand rows only. + + + + + Each report page is placed on a new Excel page. + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Represents the Zpl export filter. + + + + + + + + Enum of ZPL format versions. + + + + + Standart ZPL + + + + + ZPL II + + + + + Enum of densty types of Zebra printers. + + + + + 6 dpmm(152 dpi) + + + + + 8 dpmm(203 dpi) + + + + + 12 dpmm(300 dpi) + + + + + 24 dpmm(600 dpi) + + + + + Sets the density of printer. + + + + + Gets or sets the version of ZPL. + + + + + Sets the init string for sending before printing the document. + + + + + Sets the code page of document. Default is UTF-8 (^CI28). + + + + + Sets the string for sending after printing the document. + + + + + Sets the string for sending before printing each page. + + + + + Sets the scale font size. + + + + + Sets the scale barcode size. + + + + + Sets the Printer Font, default value is "A". + + + + + Enable or disable export as bitmap. + + + + + Writes the string value in stream. + + + + + + + Writes the string value in stream with CRLF. + + + + + + + Gets the left position in zpl units. + + + + + + + Gets the top position in zpl units. + + + + + + + Exports the TableObject. + + + + + + Exports the LineObject. + + + + + + Exports the ShapeObject. + + + + + + Exports the TextObject. + + + + + + Gets the position of object in ZPL code. + + + + + + + + Gets the text attributes in ZPL code. + + + + + + + + + + + Gets the text with font width and height in ZPL code. + + + + + + + + + Gets the horiz align in ZPL code. + + + + + + + Gets the rectangle in ZPL code. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + This property for internal use only. + + + + + Binary tree class + + + + + Maximal value between child and parent + + + + + Nodes count + + + + + Root node + + + + + Nodes array. Accending sorting by node value. Available after close of tree. + + + + + Acceptable inaccuracy of new values. + + + + + Recursive add value to a node. + + + + + + + + Poll right child node for correct balance. + + + + + + Poll left child for correct balance. + + + + + + Recursive indexation of node and childs. + + + + + + Add new value in tree. All equals are skipped. + + + + + + Close the tree and make index array. + + + + + Seek of value index in the tree. + + + + + + + Find of value index in sub-tree of node. + + + + + + + + Borrow values form List in the tree + + + + + + Borrow values form array in the tree + + + + + + Clear tree + + + + + Tree constructor + + + + + Tree node class + + + + + Link to left child + + + + + Link to right child + + + + + Node value + + + + + Count of nodes in left sub-tree + + + + + Count of nodes in right sub-tree + + + + + Node index + + + + + Node constructor + + + + + + For internal use only. + + + + + Gets current page width. + + + + + + + Gets current page height. + + + + + + + + + + + + + + For developers only + + + + + Convert index to Excel column name. + + Index of column + Column name + + + + The components factory. + + + The components factory. + + + + + Creates a RichObject instance with specified name and parent. + + The name of the RichObject instance. + The parent of the RichObject instance. + The RichObject instance. + + + + Creates a SVGObject instance with specified name and parent. + + The name of the SVGObject instance. + The parent of the SVGObject instance. + The SVGObject instance. + + + + Creates a AdvMatrixObject instance with specified name and parent. + + The name of the AdvMatrixObject instance. + The parent of the AdvMatrixObject instance. + The AdvMatrixObject instance. + + + + Creates a MSChartObject instance with specified name and parent. + + The name of the MSChartObject instance. + The parent of the MSChartObject instance. + The MSChartObject instance. + + + + Creates a SparklineObject instance with specified name and parent. + + The name of the SparlineObject instance. + The parent of the SparlineObject instance. + + + + + Creates a MapObject instance with specified name and parent. + + The name of the MapObject instance. + The parent of the MapObject instance. + The MapObject instance. + + + + Creates a DialogPage instance in the specified Report. + + The Report instance. + The DialogPage instance. + + + + Creates a TextBoxControl instance with specified name and parent. + + The name of the TextBoxControl instance. + The parent of the TextBoxControl instance. + The TextBoxControl instance. + + + + Creates a LabelControl instance with specified name and parent. + + The name of the LabelControl instance. + The parent of the LabelControl instance. + The LabelControl instance. + + + + Creates a RadioButtonControl instance with specified name and parent. + + The name of the RadioButtonControl instance. + The parent of the RadioButtonControl instance. + The RadioButtonControl instance. + + + + Creates a DateTimePickerControl instance with specified name and parent. + + The name of the DateTimePickerControl instance. + The parent of the DateTimePickerControl instance. + The DateTimePickerControl instance. + + + + Creates a GridControl instance with specified name and parent. + + The name of the GridControl instance. + The parent of the GridControl instance. + The GridControl instance. + + + + Creates a GroupBoxControl instance with specified name and parent. + + The name of the GroupBoxControl instance. + The parent of the GroupBoxControl instance. + The GroupBoxControl instance. + + + + Creates a ButtonControl instance with specified name and parent. + + The name of the ButtonControl instance. + The parent of the ButtonControl instance. + The ButtonControl instance. + + + + Creates a CheckBoxControl instance with specified name and parent. + + The name of the CheckBoxControl instance. + The parent of the CheckBoxControl instance. + The CheckBoxControl instance. + + + + Creates a CheckedListBoxControl instance with specified name and parent. + + The name of the CheckedListBoxControl instance. + The parent of the CheckedListBoxControl instance. + The CheckedListBoxControl instance. + + + + Creates a ListBoxControl instance with specified name and parent. + + The name of the ListBoxControl instance. + The parent of the ListBoxControl instance. + The ListBoxControl instance. + + + + Creates a PanelControl instance with specified name and parent. + + The name of the PanelControl instance. + The parent of the PanelControl instance. + The PanelControl instance. + + + + Creates a ComboBoxControl instance with specified name and parent. + + The name of the ComboBoxControl instance. + The parent of the ComboBoxControl instance. + The ComboBoxControl instance. + + + + Creates a NumericUpDownControl instance with specified name and parent. + + The name of the NumericUpDownControl instance. + The parent of the NumericUpDownControl instance. + The NumericUpDownControl instance. + + + + Creates a PictureBoxControl instance with specified name and parent. + + The name of the PictureBoxControl instance. + The parent of the PictureBoxControl instance. + The PictureBoxControl instance. + + + + Creates a ListViewControl instance with specified name and parent. + + The name of the ListViewControl instance. + The parent of the ListViewControl instance. + The ListViewControl instance. + + + + Creates a RichTextBoxControl instance with specified name and parent. + + The name of the RichTextBoxControl instance. + The parent of the RichTextBoxControl instance. + The RichTextBoxControl instance. + + + + Creates a TreeViewControl instance with specified name and parent. + + The name of the TreeViewControl instance. + The parent of the TreeViewControl instance. + The TreeViewControl instance. + + + + Creates a ReportPage instance in the specified Report. + + The Report instance. + The ReportPage instance. + + + + Creates a ReportPage instance in the specified Report with the cpecified name. + + The name of page. + The Report instance. + The ReportPage instance. + + + + Creates a ReportTitleBand instance in the specified ReportPage. + + The ReportPage instance. + The ReportTitleBand instance. + + + + Creates a ReportSummaryBand instance in the specified ReportPage. + + The ReportPage instance. + The ReportSummaryBand instance. + + + + Creates a PageHeaderBand instance in the specified ReportPage. + + The ReportPage instance. + The PageHeaderBand instance. + + + + Creates a PageFooterBand instance in the specified ReportPage. + + The ReportPage instance. + The PageFooterBand instance. + + + + Creates a ColumnHeaderBand instance in the specified ReportPage. + + The ReportPage instance. + The ColumnHeaderBand instance. + + + + Creates a ColumnFooterBand instance in the specified ReportPage. + + The ReportPage instance. + The ColumnFooterBand instance. + + + + Creates a DataHeaderBand instance in the specified DataBand. + + The DataBand instance. + The DataHeaderBand instance. + + + + Creates a DataBand instance in the specified ReportPage. + + The ReportPage instance. + The DataBand instance. + + + + Creates a DataFooterBand instance in the specified DataBand. + + The DataBand instance. + The DataFooterBand instance. + + + + Creates a GroupHeaderBand instance in the specified ReportPage. + + The ReportPage instance. + The GroupHeaderBand instance. + + + + Creates a GroupFooterBand instance in the cpecified ReportPage. + + The ReportPage instance. + The GroupFooterBand instance. + + + + Creates a GroupFooterBand instance in the cpecified GroupHeaderBand. + + The GroupHeaderBand instance. + The GroupFooterBand instance. + + + + Creates a ChildBand instance in the specified BandBase. + + The BandBase instance. + The ChildBand instance. + + + + Creates an OverlayBand in the specified ReportPage. + + The ReportPage instance. + The OverlayBand instance. + + + + Creates a Style instance with specified name. + + The name of the Style instance. + The report to add style to. + The Style instance. + + + + Creates a TextObject instance with specified name and parent. + + The name of the TextObject instance. + The parent of the TextObject instance. + The TextObject instance. + + + + Creates a PictureObject instance with specified name and parent. + + The name of the PictureObject instance. + The parent of the PictureObject instance. + The PictureObject instance. + + + + Creates a LineObject instance with specified name and parent. + + The name of the LineObject instance. + The parent of the LineObject instance. + The LineObject instance. + + + + Creates a ShapeObject instance with specified name and parent. + + The name of the ShapeObject instance. + The parent of the ShapeObject instance. + The ShapeObject instance. + + + + Creates a PolyLineObject instance with specified name and parent. + + The name of the PolyLineObject instance. + The parent of the PolyLineObject instance. + The PolyLineObject instance. + + + + Creates a PolygonObject instance with specified name and parent. + + The name of the PolygonObject instance. + The parent of the PolygonObject instance. + The PolygonObject instance. + + + + Creates a SubreportObject instance with specified name and parent. + + The name of the SubreportObject instance. + The parent of the SubreportObject instance. + The SubreportObject instance. + + + + Creates a ContainerObject instance with specified name and parent. + + The name of the ContainerObject instance. + The parent of the ContainerObject instance. + The ContainerObject instance. + + + + Creates a CheckBoxObject instance with specified name and parent. + + The name of the CheckBoxObject instance. + The parent of the CheckBoxObject instance. + The CheckBoxObject instance. + + + + Creates a HtmlObject instance with specified name and parent. + + The name of the HtmlObject instance. + The parent of the HtmlObject instance. + The HtmlObject instance. + + + + Creates a TableObject instance with specified name and parent. + + The name of the TableObject instance. + The parent of the TableObject instance. + The TableObject instance. + + + + Creates a MatrixObject instance with specified name and parent. + + The name of the MatrixObject instance. + The parent of the MatrixObject instance. + The MatrixObject instance. + + + + Creates a BarcodeObject instance with specified name and parent. + + The name of the BarcodeObject instance. + The parent of the BarcodeObject instance. + The BarcodeObject instance. + + + + Creates a ZipCodeObject instance with specified name and parent. + + The name of the ZipCodeObject instance. + The parent of the ZipCodeObject instance. + The ZipCodeObject instance. + + + + Creates a CellularTextObject instance with specified name and parent. + + The name of the CellularTextObject instance. + The parent ot the CellularTextObject instance. + The CellularTextObject instance. + + + + Creates a LinearGauge instance with specified name and parent. + + The name of the LinearGauge instance. + The parent of the LinearGauge instance. + The LinearGauge instance. + + + + Creates a SimpleGauge instance with specified name and parent. + + The name of the SimpleGauge instance. + The parent of the SimpleGauge instance. + The SimpleGauge instance. + + + + Creates a RadialGauge instance with specified name and parent. + + The name of the RadialGauge instance. + The parent of the RadialGauge instance. + The RadialGauge instance. + + + + Creates a SimpleProgressGauge instance with specified name and parent. + + The name of the SimpleProgressGauge instance. + The parent of the SimpleProgressGauge instance. + The SimpleProgressGauge instance. + + + + Creates a Parameter instance with specified name and parent. + + The name of the Parameter instance. + The parent Report for the new Parameter. + The Parameter instance. + + + + Represents the DevExpess import plugin. + + + Represents the DevExpess import plugin. + + + + + Initializes a new instance of the class. + + + + + + + + + + + The DevExpress units converter. + + + + + Converts SizeF to pixels. + + SizeF value as string. + The value in pixels. + + + + Converts SizeF to pixels. + + SizeF value as string. + The value in pixels. + + Use this method for fonts, because font size is not stored as multiplied by dpi + + + + + Converts value to Boolean. + + Boolen value as string. + + + + Converts DevExpress Color. + + The DevExpress Color value as string. + The Color value. + + + + Converts DevExpress BackColor. + + The DevExpress BackColor value as string. + The Color value. + + + + Converts the DevExpress BorderDashStyle to LineStyle. + + The DevExpress BorderDashStyle value. + The LineStyle value. + + + + Converts the DevExpress LineStyle to LineStyle. + + The DevExpress LineStyle value. + The LineStyle value. + + + + Converts the DevExpress TextAlignment to HorzAlignment. + + The DevExpress TextAlignment value. + The HorzAlign value. + + + + Converts the DevExpress TextAlignment to VertAlignment. + + The DevExpress TextAlignment value. + The VertAlign value. + + + + Converts the DevExpress ImageSizeMode to PictureBoxSizeMode. + + The ImageSizeMode value as string. + The PictureBoxSizeMode value. + + + + Converts the DevExpress Shape to ShapeKind. + + The DevExpress Shape value as string. + The ShapeKind value. + + + + Converts the DevExpress Barcode.Symbology to Barcode.Barcode. + + The DevExpress Barcode.Symbology value as string. + The BarcodeObject instance. + + + + Converts the DevExpress border sides to FastReport border sides + + The DevExpress Barcode.Symbology value as string. + The BarcodeObject instance. + + + + Represents the RDL import plugin. + + + Represents the RDL import plugin. + + + + + Initializes a new instance of the class. + + + + + + + + + + + The RDL units converter. + + + The RDL units converter. + + + + + Converts the RDL GradientType to GradientStyle. + + The RDL GradientType value. + The GradientStyle value. + + + + Converts the RDL Chart.Type to SeriesChartType. + + The RDL Chart.Type value. + The SeriesChartType value. + + + + Converts the RDL Chart.Palette to ChartColorPalette. + + The RDL Chart.Palette value. + The RDL ChartColorPalette value. + + + + Converts the RDL Chart.Legend.Position to Legend.Docking and Legend.Alignment. + + The RDL Chart.Legend.Position value. + The Legend instance to convert to. + + + + Converts the RDL Chart.Legend.Layout to LegendStyle. + + The RDL Chart.Legend.Layout value. + The LegendStyle value. + + + + Converts the RDL BorderStyle to ChartDashStyle. + + The RDL BorderStyle value. + The ChartDashStyle value. + + + + Converts the RDL Axis.Visible to AxisEnabled. + + The RDL Axis.Visible value. + The AxisEnabled value. + + + + Converts the RDL TickMarkStyle to TickMarkStyle. + + The RDL TickMarkStyle value. + The TickMarkStyle value. + + + + Converts the RDL Shading to LightStyle. + + The RDL Shading value. + The LightStyle value. + + + + Converts the RDL Boolean to bool value. + + The RDL Boolean value. + The bool value. + + + + Converts the RDL Color to Color. + + The RDL Color value. + The Color value. + + + + Converts the RDL Size to float value. + + The RDL Size value. + The RDL Size units measure. + The float value of RDL Size. + + + + Converts the RDL Size to int value. + + The RDL Size value. + The RDL Size units measure. + The int value of RDL Size. + + + + Converts the RDL Size to millimeters. + + The RDL Size value. + The float value of RDL Size in millimeters. + + + + Converts the RDL Size to pixels. + + The RDL Size value. + The float value of RDL Size in pixels. + + + + Converts the RDL FontStyle to FontStyle. + + The RDL FontStyle value. + The FontStyle value. + + + + Converts the RDL FontSize to float. + + The RDL FontSize value. + The float value of RDL FontSize in points. + + + + Converts the RDL TextAlign to HorzAlign. + + The RDL TextAlign value. + The HorzAlign value. + + + + Converts the RDL TextAlign to VerticalAlign. + + The RDL VerticalAlign value. + The VertAlign value. + + + + Converts the RDL WritingMode to Angle. + + The RDL WritingMode value. + The int value of RDL WritingMode in degree. + + + + Converts the RDL TextAlign to StringAlignment. + + The RDL TextAling value. + The StringAlignment value. + + + + Converts the RDL TextAlign and VerticalAlign to ContentAlignment. + + The RDL TextAlign value. + The RDL VerticalAlign value. + The ContentAlignment value. + + + + Converts the RDL BorderStyle to LineStyle. + + The RDL BorderStyle value. + The LineStyle value. + + + + Converts the RDL Sizing to PictureBoxSizeMode. + + The RDL Sizing value. + The PictureBoxSizeMode value. + + + + The RDL Size units. + + + + + Specifies the units measured in millimeters. + + + + + Specifies the units measured in centimeters. + + + + + Specifies the units measured in inches. + + + + + Specifies the units measured in points. + + + + + Specifies the units measured in picas. + + + + + Defines the constants used to convert between RDL Size and pixels. + + + To convert pixels to inches, use the code: + inches = pixels / SizeUnitsP.Inch; + To convert inches to pixels, use the code: + pixels = inches * SizeUnitsP.Inch; + + + + + The number of pixels in one millimeter. + + + + + The number of pixels in one centimeter. + + + + + The number of pixels in one inch. + + + + + The number of pixels in one point. + + + + + The number of pixels in one pica. + + + + + Defines the constants used to convert between RDL Size and millimeters. + + + To convert millimeters to inches, use the code: + inches = millimeters / SizeUnitsM.Inch; + To convert inches to millimeters, use the code: + millimeters = inches * SizeUnitsM.Inch; + + + + + The number of millimeters in one centimeter. + + + + + The number of millimeters in one inch. + + + + + The number of millimeters in one point. + + + + + The number of millimeters in one pica. + + + + + Represents the StimulSoft import plugin. + + + Represents the StimulSoft import plugin. + + + + + Initializes a new instance of the class. + + + + + + + + + + + The StimulSoft units converter. + + + + + Converts value to Boolean. + + Boolen value as string. + + + + Converts value to PageUnits. + + + + + + + Converts value to PageUnits. + + + + + + + Converts the PaperSize to width and height values of paper size in millimeters + + The PaperSize value. + The ReportPage instance. + + + + Parse int value. + + + + + + + Parse float value + + + + + + + Converts StimulSoft Color. + + The DevExpress Color value as string. + The Color value. + + + + Converts StimulSoft Border. + + + + + + + Converts the StimulSoft BorderDashStyle to LineStyle. + + The DevExpress BorderDashStyle value. + The LineStyle value. + + + + Converts the StimulSoft BorderDashStyle to LineStyle. + + The DevExpress BorderDashStyle value. + The LineStyle value. + + + + Converts the StimulSoft LineStyle to LineStyle. + + The StimulSoft LineStyle value. + The LineStyle value. + + + + Converts the StimulSoft TextAlignment to HorzAlignment. + + The StimulSoft TextAlignment value. + The HorzAlign value. + + + + Converts the StimulSoft Brush to FillBase object. + + + + + + + Converts the StimulSoft Format to FormatBase object. + + + + + + + Converts the StimulSoft RTF string to raw RTF. + + + + + + + Converts the StimulSoft CapStyle to CapStyle. + + + + + + + Converts the StimulSoft TextAlignment to VertAlignment. + + The StimulSoft TextAlignment value. + The VertAlign value. + + + + Converts the StimulSoft CheckedSymbol to CheckedSymbol. + + + + + + + Converts the StimulSoft Barcode.Symbology to Barcode.Barcode. + + The StimulSoft Barcode.Symbology value as string. + The BarcodeObject instance. + + + + Converts the StimulSoft border sides to FastReport border sides + + + + + + Converts the StimulSoft AggregateFunction sides to FastReport MatrixAggregateFunction + + + + + + + Convert fill to color + + + + + + + Converts the StimulSoft SeriesChartType to SeriesChartType. + + + + + + + Parse string to struct f Point. + + + + + + + Parse string to struct of Size. + + + + + + + Converts the StimulSoft SeriesChartType to SeriesChartType. + + + + + + + Represents the JasperReports import plugin. + + + Represents the JasperReports import plugin. + + + + + Initializes a new instance of the class. + + + + + + + + + + + The JasperReports units converter. + + + + + Converts value to Boolean. + + Boolen value as string. + + + + Converts string to PictureBoxSizeMode. + + + + + + + Parse int value. + + + + + + + Parse float value + + + + + + + Converts JasperReports Color. + + The DevExpress Color value as string. + The Color value. + + + + Converts string to QRCodeErrorCorrection. + + + + + + + Parse BorderLine from XmlNode. + + + + + + + Converts JasperReports Border. + + + + + + + Converts the JasperReports BorderDashStyle to LineStyle. + + The DevExpress BorderDashStyle value. + The LineStyle value. + + + + Converts the JasperReports LineStyle to LineStyle. + + The JasperReports LineStyle value. + The LineStyle value. + + + + Converts the JasperReports TextAlignment to HorzAlignment. + + The JasperReports TextAlignment value. + The HorzAlign value. + + + + Converts the JasperReports rotation to int. + + + + + + + Converts the JasperReports TextAlignment to VertAlignment. + + The JasperReports TextAlignment value. + The VertAlign value. + + + + Converts the JasperReports Barcode.Symbology to Barcode.Barcode. + + The JasperReports Barcode.Symbology value as string. + The BarcodeObject instance. + + + + Convert JasperReports HyperlinkType to HyperlinkKind. + + + + + + + Converts the JasperReports SeriesChartType to SeriesChartType. + + + + + + + Base class for all import plugins. + + + + + Gets or sets the name of plugin. + + + + + Gets or sets reference to the report. + + + + + Initializes a new instance of the class with default settings. + + + + + Loads the specified file into specified report. + + Report object. + File name. + + + + Loads the specified file into specified report from stream. + + Report object + File stream + + + + Represents the List and Label import plugin. + + + + + Gets the value indicating is the report List and Label template after trying to load it. + + + + + Initializes a new instance of the class. + + + + + + + + + + + The List and Label units converter. + + + + + Converts List and Label units to millimeters. + + The List and Label unit as string. + The value in millimeters. + + + + Converts List and Label units to pixels. + + The List and Label unit as string. + The value in pixels. + + + + Converts List and Label paper orientation. + + The List and Label paper orientation value as string. + Returns true if orientation is landscape. + + + + Converts List and Label bool. + + The List and Label bool value as string. + A bool value. + + + + Converts List and Label text Align. + + The List and Label text Align value as string. + A HorzAlign value. + + + + Convert List and Label LineType to LineStyle. + + The List and Label LineType value as string. + A LineStyle value. + + + + Converts List and Label rounding to float. + + The List and Label rounding value as string. + A float value. + + + + Provider for getting a json object fron connection source + + + + + Returns JsonBase object from connection source specific by tableDataSource + + + + + + + FastReport json connection + + + + + Name of json object table + + + + + Initialize a new instance + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents the JsonDataConnection connection string builder. + + + Use this class to parse connection string returned by the JsonDataConnection class. + + + + + Gets or sets json data + + + + + Gets or sets json schema + + + + + Gets or sets json url encoding + + + + + Set or get headers of the connection string. + + + + Returns copy of dictionary. If you need to update values, set the dictionary again! + + + + + Gets or sets simple structure value + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with + specified connection string. + + The connection string. + + + + JsonTableDataSource present a json array object + + + + + Gets or sets value for force update schema on init schema + + + + + Get or sets simplify mode for array types + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The default field name. + + + + + This class represents a single data column in a . + + + + + + + + Gets or sets the business object property name which this column is bound to. + + + + + Gets or sets the business object property descriptor which this column is bound to. + + + + + Gets or sets the type of data supplied by this column. + + + + + Gets or sets a value that specifies the type of a control that will be created + when you drop this column on a report page. + + + If you need to specify the custom type, use the property instead. + + + + + Gets or sets a name of custom bindable control. + + + Use this property if you want to bind a column to custom object type. You need to + specify the type name of your object; that object must be registered in FastReport using the + RegisteredObjects.Add method. + + + + + Gets or sets the format of this column. + + + This property is used when you drag a column from the Data window to the report page. + FastReport will create a "Text" object and set its "Format" property to the corresponding format. + By default, this property is set to Auto. It means that the format will be determined + automatically depending on the property. + + + + + Gets or sets expression of the calculated column. + + + This property is used if the property is true. + + + + + Gets or sets a value that indicates whether this column is calculated. + + + You should specify the property for calculated columns. + + + + + Gets the collection of child columns. + + + + + Gets or sets the tag value. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the Column class with default settings. + + + + + + + + + + Initialize a new instance + + + + + + + + + + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + The base class for all connection editors. This control is used when you edit + the connection in the Data Wizard. + + + + + Gets or sets a connection string. + + + + + This method should construct the connection string from values entered by user. + + The connection string. + + + + This method should parse the connection string and fill the user interface elements. + + The connection string. + + + + Updates the component layout on dpi change. + + + + + Initializes a new instance of the class with default settings. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents a connection to xml file-based database. + + This example shows how to add a new connection to the report. + + Report report1; + XmlDataConnection conn = new XmlDataConnection(); + conn.XmlFile = @"c:\data.xml"; + report1.Dictionary.Connections.Add(conn); + conn.CreateAllTables(); + + + + + + + + + + + + + + + Gets or sets the path to .xsd file. + + + + + Gets or sets the path to .xml file. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Represents a total that is used to calculate aggregates such as Sum, Min, Max, Avg, Count. + + + + + + + + Gets or sets the total type. + + + + + Gets or sets the expression used to calculate the total. + + + + + Gets or sets the evaluator databand. + + + The total will be calculated for each row of this band. + + + + + This property is kept for compatibility only. + + + + + Gets or sets the band to print the total on. + + + The total will be resetted after the specified band has been printed. + + + + + Gets or sets a value that determines whether the total should be resetted after print. + + + + + Gets or sets a value that determines whether the total should be resetted if printed + on repeated band (i.e. band with "RepeatOnEveryPage" flag). + + + + + Gets or sets the condition which tells the total to evaluate. + + + + + Gets or sets a value that determines if invisible rows of the Evaluator should + be included into the total's value. + + + + + This property is not relevant to this class. + + + + + Gets the value of total. + + + + + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Represents a datasource based on DataTable class. + + This example shows how to add a new table to the existing connection: + + Report report1; + DataConnectionBase conn = report1.Dictionary.Connections.FindByName("Connection1"); + TableDataSource table = new TableDataSource(); + table.TableName = "Employees"; + table.Name = "Table1"; + conn.Tables.Add(table); + + + + + + + + + Gets or sets the underlying DataTable object. + + + + + Gets or sets the table name. + + + + + Gets or sets SQL "select" command. + + + If this command contains parameters, you should specify them in the + property. + + + + + Gets a collection of parameters used by "select" command. + + + You must set up this property if the SQL query that you've specified in the + property contains parameters. + You can pass a value to the SQL parameter in two ways. + The right way is to define a report parameter. You can do this in the + "Data" window. Once you have defined the parameter, you can use it to pass a value + to the SQL parameter. To do this, set the SQL parameter's Expression property + to the report parameter's name (so it will look like [myReportParam]). + To pass a value to the report parameter from your application, use the + method. + The other way (unrecommended) is to find a datasource object and set its parameter from a code: + + TableDataSource ds = report.GetDataSource("My DataSource Name") as TableDataSource; + ds.Parameters[0].Value = 10; + + This way is not good because you hardcode the report object's name. + + + + + Gets or sets the parent object. + + + + + Gets or sets a value that determines whether it is necessary to store table data in a report file. + + + + + Gets or sets the table data. + + + This property is for internal use only. + + + + + If set, ignores the Connection (always returns null). Needed when we replace the + existing connection-based datasource with datatable defined in an application. + + + + + Gets or sets the query builder schema. + + + This property is for internal use only. + + + + + + + + + + + + + + + + + Refresh the table schema. + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Represents a master-detail relation between two data sources. + + + To setup a relation, you must specify parent and child datasources. For a parent datasource, + you must specify set of key columns; for child datasource, you must specify set of columns that + relate to the parent key columns. + This example shows how to create relation between Customers and Orders tables: + + Report report1; + DataSourceBase customersTable = report1.Dictionary.DataSources.FindByAlias("Customers"); + DataSourceBase ordersTable = report1.Dictionary.DataSources.FindByAlias("Orders"); + Relation rel = new Relation(); + rel.Name = "customersOrders"; + rel.ParentDataSource = customersTable; + rel.ChildDataSource = ordersTable; + rel.ParentColumns = new string[] { "CustomerID" }; + rel.ChildColumns = new string[] { "CustomerID" }; + report1.Dictionary.Relations.Add(rel); + + + + + + + + + + Gets or sets the parent datasource. + + + + + Gets or sets the child datasource. + + + + + Gets or sets an array of parent datasource columns. + + + Note: both and must have the + same number of elements. + + + + + Gets or sets an array of child datasource columns. + + + Note: both and must have the + same number of elements. + + + + + + + + Compares this relation with another one. + + Another relation to compare with. + true if both relations are equal; false otherwise. + + + + Initializes a new instance of the class with default settings. + + + + + Represents a connection to any OLE DB database. + + This example shows how to add a new connection to the report. + + Report report1; + OleDbDataConnection conn = new OleDbDataConnection(); + conn.ConnectionString = "your_connection_string"; + report1.Dictionary.Connections.Add(conn); + conn.CreateAllTables(); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents a connection to any database through ODBC. + + This example shows how to add a new connection to the report. + + Report report1; + OdbcDataConnection conn = new OdbcDataConnection(); + conn.ConnectionString = "your_connection_string"; + report1.Dictionary.Connections.Add(conn); + conn.CreateAllTables(); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents a connection to MS SQL database. + + This example shows how to add a new connection to the report. + + Report report1; + MsSqlDataConnection conn = new MsSqlDataConnection(); + conn.ConnectionString = "your_connection_string"; + report1.Dictionary.Connections.Add(conn); + conn.CreateAllTables(); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents a connection to MS Access database (.mdb file). + + This example shows how to add a new connection to the report. + + Report report1; + MsAccessDataConnection conn = new MsAccessDataConnection(); + conn.DataSource = @"c:\data.mdb"; + report1.Dictionary.Connections.Add(conn); + conn.CreateAllTables(); + + + + + + + + + + + + Contains supported list of providers + + + + + Gets or sets the datasource file name. + + + + + Gets or sets the datasource file name. + + + + + Gets or sets the user name. + + + + + Gets or sets the password. + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + The base class for all data connection components such as . + + This example shows how to add a new MS Access connection to the report. + + Report report1; + MsAccessDataConnection conn = new MsAccessDataConnection(); + conn.DataSource = @"c:\data.mdb"; + report1.Dictionary.Connections.Add(conn); + conn.CreateAllTables(); + + + + + + + + + Gets a string that will identify a connection in the Data Wizard. + + The string that contains the connection type and some meaningful information. + + + + Gets the default type for a new parameter. + + The integer representation of a parameter type. + + + + Gets a control that will be used to edit the connection properties. + + The editor's control. + + + + + + + Tests the connection. + + + If test connection is not successful, this method throws an exception. Catch this exception to + show an error message. + + + + + Gets an internal DataSet object that contains all data tables. + + + + + Gets a collection of data tables in this connection. + + + To add a table to the connection, you must either create a new TableDataSource and add it + to this collection or call the method which will add + all tables available in the database. + + + + + Gets or sets a connection string that contains all connection parameters. + + + To modify some parameter of the connection, use respective + ConnectionStringBuilder class. + Security note: the connection string may contain a user name/password. + This information is stored in a report file. By default, it is crypted using the standard + FastReport's password. Since FastReport's source code is available to anyone who paid for it, + it may be insecure to use the standard password. For more security, you should use own + password. To do this, specify it in the Crypter.DefaultPassword property. + + This example demonstrates how to change a connection string: + + OleDbConnectionStringBuilder builder = new OleDbConnectionStringBuilder(oleDbConnection1.ConnectionString); + builder.PersistSecurityInfo = false; + oleDbConnection1.ConnectionString = builder.ToString(); + + + + + + Gets or sets an expression that returns a connection string. + + + Use this property to set the connection string dynamically. + The recommended way to do this is to define a report parameter. You can do this in the + "Data" window. Once you have defined the parameter, you can use it to pass a value + to the connection. Set the ConnectionStringExpression property of the + connection object to the report parameter's name (so it will look like [myReportParam]). + To pass a value to the report parameter from your application, use the + method. + + Once you set value for this property, the property will be ignored + when report is run. + + + + + + Gets or sets a value indicates if this connection is SQL-based. + + + + + Gets or sets a value indicates if this connection can contain procedures. + + + + + Gets or sets a value indicating whether a login dialog appears immediately before opening a connection. + + + Set LoginPrompt to true to provide login dialog when establishing a connection. If this + property is false (by default), you should provide login information (user name and password) + in the property. Though that property is stored in a crypted form, + this may be insecure. + Another way to pass login information to the connection is to use + property that is bound to the report parameter. In that + case you supply the entire connection string from your application. + + + + + Gets or sets the command timeout, in seconds. + + + + + + + + Initializes a DataSet instance. + + The DataSet object. + + This method is used to support FastReport infrastructure. You don't need to use it. + + + + + Disposes a DataSet. + + + This method is used to support FastReport infrastructure. You don't need to use it. + + + + + Sets the connection string. + + New connection string. + + Use this method if you need to perform some actions when the connection string is set. + + + + + Gets a connection string that contains username and password specified. + + User name. + Password. + + Override this method to pass login information to the connection. Typical implementation + must get the existing , merge specified login information into it + and return the new value. + + + + + + + + + + + + + + + + + + + + + + + + + + Fills the collection with all tables available in the database. + + + This method does not read the table data; to do this, call the + method of each table. + + + + + Fills the collection with all tables available in the database. + + Set to true to initialize each table's schema. + + + + Fills the collection with all procedures available in the database. + + + + + Create the stored procedure. + + + + + Creates the relations between tables. Applies to XmlDataConnection only. + + + + + Gets an array of table names available in the database. + + An array of strings. + + + + Gets an array of table names available in the database. + + An array of strings. + + + + Returns a type of connection. + + Type instance. + + You should override this method if you developing a new connection component. + If your connection component does not use data connection, you need to override + the and methods instead. + + Here is the example of this method implementation: + + public override Type GetConnectionType() + { + return typeof(OleDbConnection); + } + + + + + + Returns a connection object. + + The DbConnection instance. + Either creates a new DbConnection instance of type provided by the + method, or returns the application connection if set + in the Config.DesignerSettings.ApplicationConnection. + + + + Opens a specified connection object. + + Connection to open. + + Use this method to open a connection returned by the method. + This method displays a login dialog if your connection has the + property set to true. Once you have entered an user name and password in + this dialog, it will remeber the entered values and will not used anymore in this report session. + + + + + Disposes a connection. + + The connection to dispose. + + + + Returns a object that is specific to this connection. + + The SQL command used to fetch a table data rows. + The connection object. + The select command parameters. + The DbDataAdapter object. + + You should override this method if you are developing a new connection component. In this method, + you need to create the adapter and set its SelectCommand's parameters. + If your connection does not use data adapter, you need to override + the and methods instead. + + Here is the example of this method implementation: + + public override DbDataAdapter GetAdapter(string selectCommand, DbConnection connection, + CommandParameterCollection parameters) + { + OleDbDataAdapter adapter = new OleDbDataAdapter(selectCommand, connection as OleDbConnection); + foreach (CommandParameter p in parameters) + { + OleDbParameter parameter = adapter.SelectCommand.Parameters.Add(p.Name, (OleDbType)p.DataType, p.Size); + parameter.Value = p.Value; + } + return adapter; + } + + + + + + Gets the type of parameter that is specific to this connection. + + The parameter's type. + + This property is used in the report designer to display available data types when you edit the + connection parameters. For example, the type of OleDbConnection parameter is a OleDbType. + + + + + Quotes the specified DB identifier such as table name or column name. + + Identifier to quote. + The opened DB connection. + The quoted identifier. + + + + Fills the table schema. + + DataTable to fill. + The SQL select command. + SQL parameters. + + Usually you don't need to use this method. Internally it uses the and + methods to fill the table schema. If you create own connection component + that does not use nor connection or adapter, then you need to override this method. + + + + + Fills the table data. + + DataTable to fill. + The SQL select command. + SQL parameters. + + Usually you don't need to use this method. Internally it uses the and + methods to fill the table data. If you create own connection component + that does not use nor connection or adapter, then you need to override this method. + + + + + Creates table. + For internal use only. + + + + + Deletes table. + For internal use only. + + + + + Clone table. + For internal use only. + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + The base class for all data components such as data sources, columns. + + + + + + + + Gets or sets alias of this object. + + + Alias is a human-friendly name of this object. It may contain any symbols (including + spaces and national symbols). + + + + + Gets or sets a value indicates that object is enabled and thus can be used in a report. + + + This property is used to hide an object from the Data Dictionary window. Hidden + objects are still accessible in the "Data|Choose Data Source..." menu. + + + + + Gets or sets a name of the data object. + + + This property is used to support FastReport.Net infrastructure. Do not use it directly. + + + + + Gets or sets a reference to the data object. + + + This property is used to support FastReport.Net infrastructure. Do not use it directly. + + + + + Gets a value indicates that this object has an alias. + + + + + + + + + + + + + + Initializes the object before running a report. + + + This method is used by the report engine, do not call it directly. + + + + + Initializes a new instance of the class with default settings. + + + + + Represents a connection to csv file-based database. + + This example shows how to add a new connection to the report. + + Report report1; + CsvDataConnection conn = new CsvDataConnection(); + conn.CsvFile = @"c:\data.csv"; + report1.Dictionary.Connections.Add(conn); + conn.CreateAllTables(); + + + + + + + + + + + + + + + + + + Gets or sets the path to .csv file. + + + + + Gets or sets the codepage of the .csv file. + + + + + Gets or sets the separator of the .csv file. + + + + + Gets or sets the value indicating that field names should be loaded from the first string of the file. + + + + + Gets or sets the value indicating that quotation marks should be removed. + + + + + Gets or sets the value indicating that field types fhould be converted. + + + + + Gets or sets locale name used to auto-convert numeric fields, e.g. "en-US". + + + + + Gets or sets locale name used to auto-convert currency fields, e.g. "en-US". + + + + + Gets or sets locale name used to auto-convert datetime fields, e.g. "en-US". + + + + + Initializes a new instance of the class. + + + + + + + + Checking a relative path relative to a file + + + + + + + + + + + + + + + + + + + + + + + + + + Obsolete. Specifies a set of flags used to convert business objects into datasources. + + + + + Specifies no actions. + + + + + Allows using the fields of a business object. + + + + + Allows using properties of a business object with BrowsableAttribute only. + + + + + Specifies a kind of property. + + + + + Specifies the property of a simple type (such as integer). + + + + + Specifies the complex property such as class with own properties. + + + + + Specifies the property which is a list of objects (is of IEnumerable type). + + + + + Represents a datasource based on business object of IEnumerable type. + + + Do not use this class directly. To register a business object, use the + Report.RegisterData method. + + + + + Occurs when FastReport engine loads data source with data from a business object. + + + Use this event if you want to implement load-on-demand. Event handler must load the data into + your business object. + + + + + + + + + + + + + + + + + + + + Represents the method that will handle the LoadBusinessObject event. + + The source of the event. + The event data. + + + + Provides data for event. + + + + + Parent object for this data source. + + + + + Specifies the format for the column value. + + + + + The format will be determined automatically depending on the column's DataType. + + + + + Specifies the General format (no formatting). + + + + + Specifies the Number format. + + + + + Specifies the Currency format. + + + + + Specifies the Date format. + + + + + Specifies the Time format. + + + + + Specifies the Percent format. + + + + + Specifies the Boolean format. + + + + + Specifies the type of an object that will be created when you drop the + data column on a report page. + + + + + The column will create the object. + + + + + The column will create the object. + + + + + The column will create the object. + + + + + The column will create the object. + + + + + The column will create the custom object, specified in the + property. + + + + + Represents the collection of objects. + + + + + Gets or sets a column. + + The index of a column in this collection. + The column with specified index. + + + + Finds a column by its name. + + The name of a column. + The object if found; otherwise null. + + + + Finds a column by its alias. + + The alias of a column. + The object if found; otherwise null. + + + + Returns an unique column name based on given name. + + The base name. + The unique name. + + + + Returns an unique column alias based on given alias. + + The base alias. + The unique alias. + + + + Sorts the collection of columns. + + + + + Initializes a new instance of the class with default settings. + + The owner of this collection. + + + + Represents the comparer class that used for sorting the collection of columns. + + + + + + + + This class represents a single parameter to use in the "select" command. + + + + + Gets or sets the parameter's data type. + + + + + Gets or sets the size of parameter's data. + + + This property is used if the property is set to String. + + + + + Gets or set type of parameter. + + + + + Gets or sets an expression that returns the parameter's value. + + + If this property is not set, the property will be used + to obtain a parameter's value. + + + + + Gets or sets a default value for this parameter. + + + This value is used when you designing a report. Also it is used when report is running + in case if you don't provide a value for the property. + + + + + Gets or sets the parameter's value. + + + + + This property is not relevant to this class. + + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Query parameter for request to stored procedure. + + + + + + + + + + + + + + + + + Represents the collection of objects. + + + This class is used to store the list of parameters defined in the datasource. See the + property for more details. + + + + + Gets or sets a parameter. + + The index of a parameter in this collection. + The parameter with specified index. + + + + Finds a parameter by its name. + + The name of a parameter. + The object if found; otherwise null. + + + + Returns an unique parameter name based on given name. + + The base name. + The unique name. + + + + Initializes a new instance of the class with default settings. + + The owner of this collection. + + + + Represents the collection of objects. + + + + + Gets or sets a data connection. + + The index of a data connection in this collection. + The data connection with specified index. + + + + Initializes a new instance of the class with default settings. + + The owner of this collection. + + + + Represents the CsvDataConnection connection string builder. + + + Use this class to parse connection string returned by the CsvDataConnection class. + + + + + Gets or sets the path to .csv file. + + + + + Gets or sets the codepage of .csv file. + + + + + Gets or sets the separator. + + + + + Gets or sets the value indicating that field names should be loaded from the first string of the file. + + + + + Gets or sets the value indicating that quotation marks should be removed. + + + + + Gets or sets the value indicating that field types should be converted. + + + + + Gets or sets locale name used to auto-convert numeric fields, e.g. "en-US". + + + + + Gets or sets locale name used to auto-convert currency fields, e.g. "en-US". + + + + + Gets or sets locale name used to auto-convert datetime fields, e.g. "en-US". + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a specified connection string. + + The connection string. + + + + Base class for all CubeSources such as . + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Represents the collection of objects. + + + + + Gets or sets a data source. + + The index of a data source in this collection. + The data source with specified index. + + + + Finds a CubeSource by its name. + + The name of a CubeSource. + The object if found; otherwise null. + + + + Finds a CubeSource by its alias. + + The alias of a CubeSource. + The object if found; otherwise null. + + + + Initializes a new instance of the class with default settings. + + The owner of this collection. + + + + Base class for all datasources such as . + + + + + Occurs when the FastReport engine loads data source with data. + + + Use this event if you want to implement load-on-demand. Event handler must load the data + into the data object which this datasource is bound to (for example, the + TableDataSource uses data from the DataTable object bound to + the Table property). + + + + + Gets or sets alias of this object. + + + Alias is a human-friendly name of this object. It may contain any symbols (including + spaces and national symbols). + + + + + Gets a number of data rows in this datasource. + + + You should initialize the datasource by the Init method before using this property. + + + + + Gets a value indicating that datasource has more rows, that is the + is less than the . + + + You should initialize the datasource by the Init method before using this property. + Usually this property is used with the following code block: + + dataSource.Init(); + while (dataSource.HasMoreRows) + { + // do something... + dataSource.Next(); + } + + + + + + Gets the current data row. + + + This property is updated when you call the method. + + + + + Gets an index of current data row. + + + You should initialize the datasource by the Init method before using this property. + This property is updated when you call the method. + + + + + Gets data stored in a specified column. + + Alias of a column. + The column's value. + + You should initialize the datasource by the Init method before using this property. + + + + + Gets data stored in a specified column. + + The column. + The column's value. + + You should initialize the datasource by the Init method before using this property. + + + + + Forces loading of data for this datasource. + + + This property is false by default. Set it to true if you need to reload data + each time when the datasource initialized. Note that this may slow down the performance. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + Gets the additional filter settings. + + + + + Gets data stored in a specified column. + + The column alias. + An object that contains the data. + + + + Gets data stored in a specified column. + + The column. + An object that contains the data. + + + + Initializes the datasource schema. + + + This method is used to support the FastReport.Net infrastructure. Do not call it directly. + + + + + Loads the datasource with data. + + + This method is used to support the FastReport.Net infrastructure. Do not call it directly. + + Rows to fill with data. + + + + Initializes this datasource. + + + This method fills the table with data. You should always call it before using most of + datasource properties. + + + + + Initializes this datasource and applies the specified filter. + + The filter expression. + + + + Initializes this datasource, applies the specified filter and sorts the rows. + + The filter expression. + The collection of sort descriptors. + + + + Initializes this datasource and filters data rows according to the master-detail relation between + this datasource and parentData. + + Parent datasource. + + To use master-detail relation, you must define the object that describes + the relation, and add it to the Report.Dictionary.Relations collection. + + + + + Initializes this datasource and filters data rows according to the master-detail relation between + this datasource and parentData. Also applies the specified filter and sorts the rows. + + Parent datasource. + The filter expression. + The collection of sort descriptors. + + To use master-detail relation, you must define the object that describes + the relation, and add it to the Report.Dictionary.Relations collection. + + + + + Initializes this datasource and filters data rows according to the master-detail relation. + Also applies the specified filter and sorts the rows. + + The master-detail relation. + The filter expression. + The collection of sort descriptors. + + To use master-detail relation, you must define the object that describes + the relation, and add it to the Report.Dictionary.Relations collection. + + + + + Initializes the data source if it is not initialized yet. + + + + + Navigates to the first row. + + + You should initialize the datasource by the Init method before using this method. + + + + + Navigates to the next row. + + + You should initialize the datasource by the Init method before using this method. + + + + + Navigates to the prior row. + + + You should initialize the datasource by the Init method before using this method. + + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Represents the collection of objects. + + + + + Gets or sets a data source. + + The index of a data source in this collection. + The data source with specified index. + + + + Finds a datasource by its name. + + The name of a datasource. + The object if found; otherwise null. + + + + Finds a datasource by its alias. + + The alias of a datasource. + The object if found; otherwise null. + + + + Sorts data sources by their names. + + + + + Initializes a new instance of the class with default settings. + + The owner of this collection. + + + + Represents the comparer class that used for sorting the collection of data sources. + + + + + + + + Determines how to filter the data value. + + + The "Data value" is a value contained in the datasource which you filter. + The "Selected value" is a value you have entered or selected in the dialog control. + + + + + Data value is equal to selected value. + + + + + Data value is not equal to selected value. + + + + + Data value is less than selected value. + + + + + Data value is less than or equal to selected value. + + + + + Data value is greater than selected value. + + + + + Data value is greater than or equal to selected value. + + + + + Data string contains selected value. + + + + + Data string does not contain selected value. + + + + + Data string starts with selected value. + + + + + Data string does not start with selected value. + + + + + Data string ends with selected value. + + + + + Data string does not end with selected value. + + + + + This class stores all report data items such as datasources, connections, relations, parameters, + system variables. + + + You can access the report dictionary via Report.Dictionary property. + + + + + Gets a collection of connection objects available in a report. + + + + + Gets a collection of datasources available in a report. + + + Usually you don't need to use this property. It contains only datasources + registered using the RegisterData method. All other datasources are contained + in connection objects and may be accessed via property. + + + + + Gets a collection of relations. + + + + + Gets a collection of parameters. + + + Another way to access parameters is to use the Report.Parameters property + which is actually a shortcut to this property. You also may use the Report.GetParameter + and Report.GetParameterValue methods. + + + + + Gets a collection of system variables like Date, PageNofM etc. + + + Another way to access a system variable is to use the Report.GetVariableValue method. + + + + + Gets a collection of totals. + + + Another way to get a total value is to use the Report.GetTotalValue method. + + + + + Gets a collection of cubesources available in a report. + + + Usually you don't need to use this property. It contains only cubesources + registered using the RegisterData method. + + + + + Gets a list of registered items. + + + This property is for internal use only. + + + + + + + + + + + Registers a DataView. + + The DataView to register. + The name of the data object. + Determines wheter to enable the object or not. + + This method is for internal use only. + + + + + Registers a business object. + + The business object. + The name of the object. + Maximum level of data nesting. + Determines wheter to enable the object or not. + + This method is for internal use only. + + + + + Registers a CubeLink. + + The CubeLink to register. + The name of the data object. + Determines wheter to enable the object or not. + + This method is for internal use only. + + + + + Registers a data object. + + The object to register. + The name of the object. + Determines whether to enable the object or not. + + This method is for internal use only. + + + + + Unregisters the previously registered data. + + The application data. + + + + Unregisters the previously registered data. + + The application data. + The name of the data. + + You must specify the same data and name as when you call RegisterData. + + + + + Re-registers the data registered before. + + + This method is for internal use only. + + + + + Re-registers the data registered before. + + + + + + Clears all registered data. + + + + + Enables or disables relations between data tables. + + + Call this method if you create master-detail report from code. This method enables + relation between two data tables which Enabled flag is set to true. Relations + whose parent and child tables are disabled, gets disabled too. + + + + + Creates unique name for data item such as connection, datasource, relation, parameter or total. + + The base name. + The new unique name. + + Use this method to create unique name of the data item. It is necessary when you create new + items in code to avoid conflicts with existing report items. + This example show how to add a new parameter: + + Report report1; + Parameter par = new Parameter(); + par.Name = report1.Dictionary.CreateUniqueName("Parameter"); + report1.Parameters.Add(par); + + + + + + + Creates unique alias for data item such as connection, datasource or relation. + + The base alias. + The new unique alias. + + Use this method to create unique alias of the data item. It is necessary when you create new + items in code to avoid conflicts with existing report items. + This example show how to add a new table: + + Report report1; + DataConnectionBase conn = report1.Dictionary.Connections.FindByName("Connection1"); + TableDataSource table = new TableDataSource(); + table.TableName = "Employees"; + table.Name = report1.Dictionary.CreateUniqueName("EmployeesTable"); + table.Alias = report1.Dictionary.CreateUniqueAlias("Employees"); + conn.Tables.Add(table); + + + + + + + Finds a data item such as connection, datasource, relation, parameter or total by its name. + + The item's name. + The data item if found; otherwise, null. + + + + Finds a data item such as connection, datasource or relation by its alias. + + The item's alias. + The data item if found; otherwise, null. + + + + Finds a datasource that matches the specified DataTable. + + The DataTable object to check. + The DataSourceBase object if found. + + This method is for internal use only. + + + + + Finds a data component that matches the specified reference name. + + The name to check. + The DataComponentBase object if found. + + This method is for internal use only. + + + + + + + + + + + Saves the dictionary to a stream. + + Stream to save to. + + + + Saves the dictionary to a file. + + The name of a file to save to. + + + + Loads the dictionary from a stream. + + The stream to load from. + + + + Loads the dictionary from a file. + + The name of a file to load from. + + + + Merges this dictionary with another Dictionary. + + Another dictionary to merge the data from. + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Represents the item registered in a dictionary. + + + + + Gets the item data. + + + + + Gets the item name. + + + + + Represents a report parameter that is used to pass user data to a report. + + + See for details about using parameters. + + + + + Gets or sets the name of parameter. + + + + + Gets or sets the type of parameter. + + + + + Gets or sets the value of parameter. + + + You may specify the static value in this property. Note: if the + property is not empty, it will be calculated and its value will be returned. + + + + + Gets or sets value of the parameter as a string. + + + + + Gets or sets an expression of the parameter. + + + This expression will be calculated each time you access a parameter's Value. + + + + + Gets or sets the description of a parameter. + + + + + Gets a collection of nested parameters. + + + Parameters can have child (nested) parameters. To get or set a nested + parameter's value, use the method. + + + + + Gets the full name of the parameter. This is useful to get the nested parameter's full name. + + + + + This property is not relevant to this class. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with specified name. + + + + + Represents the collection of objects. + + + + + Gets or sets a parameter. + + The index of a parameter in this collection. + The parameter with specified index. + + + + Finds a parameter by its name. + + The name of a parameter. + The object if found; otherwise null. + + + + Returns an unique parameter name based on given name. + + The base name. + The unique name. + + + + Copies the parameters from other collection. + + Parameters to copy from. + + + + Initializes a new instance of the class with default settings. + + The owner of this collection. + + + + Represents the collection of objects. + + + + + Gets or sets a relation. + + The index of a relation in this collection. + The relation with specified index. + + + + Finds a relation by its name. + + The name of a relation. + The object if found; otherwise null. + + + + Finds a relation by its alias. + + The alias of a relation. + The object if found; otherwise null. + + + + Finds a relation that is equal to specified one. + + Another relation to compare with. + The object if found; otherwise null. + + + + Initializes a new instance of the class with default settings. + + The owner of this collection. + + + + Represents a datasource based on DataView class. + + + This class is used to support FastReport.Net infrastructure, do not use it directly. + If you want to use data from DataView object, call the + method of the Report. + + + + + Represents the collection of system variables. + + + + + Represents the base class for system variables. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + + + + Returns date and time of the report's start. + + + + + + + + Returns current page number. + + + + + + + + Returns total number of pages in the report. To use this variable, you need + to enable the report's double pass. + + + + + + + + Returns a string containing the current page number in a form "Page N". + + + + + + + + Returns a string containing the current page number and total pages in a form "Page N of M". + To use this variable, you need to enable the report's double pass. + + + + + + + + Returns data row number inside the group. This value is reset at the start of a new group. + + + + + + + + Returns absolute number of data row. This value is never reset at the start of a new group. + + + + + + + + Returns current page number. + This variable is actually a macro. Its value is substituted when the component is viewed in + the preview window. That means you cannot use it in an expression. + + + + + + + + Returns the number of total pages in the report. + This variable is actually a macro. Its value is substituted when the component is viewed in + the preview window. That means you cannot use it in an expression. + + + + + + + + Returns the name of the printed copy. + This variable is actually a macro. Its value is substituted when the component is viewed in + the preview window. That means you cannot use it in an expression. + + + + + + + + Returns a level of hierarchy in the hierarchical report. + + + + + + + + Returns the row number like "1.2.1" in the hierarchical report. + + + + + + + + Represents the collection of objects. + + + + + Gets or sets a data table. + + The index of a data table in this collection. + The data table with specified index. + + + + Sorts tables by their names. + + + + + Initializes a new instance of the class with default settings. + + The owner of this collection. + + + + Datasource for stored procedure. + + + + + + + + + + + Specifies the total type. + + + + + The total returns sum of values. + + + + + The total returns minimal value. + + + + + The total returns maximal value. + + + + + The total returns average value. + + + + + The total returns number of values. + + + + + The total returns number of distinct values. + + + + + Represents the collection of objects. + + + + + Gets or sets a total. + + The index of a total in this collection. + The total with specified index. + + + + Finds a total by its name. + + The name of a total. + The object if found; otherwise null. + + + + Returns an unique total name based on given name. + + The base name. + The unique name. + + + + Initializes a new instance of the class with default settings. + + The owner of this collection. + + + + Represents a datasource based on DataView class. + + + This class is used to support FastReport.Net infrastructure, do not use it directly. + If you want to use data from DataView object, call the + method of the Report. + + + + + Gets the underlying DataView object. + + + + + + + + + + + + + + + + + Represents the XmlDataConnection connection string builder. + + + Use this class to parse connection string returned by the XmlDataConnection class. + + + + + Gets or sets the path to .xml file. + + + + + Gets or sets the path to .xsd file. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with + specified connection string. + + The connection string. + + + + This class contains settings that will be applied to the Report component. + + + + + Occurs before displaying a progress window. + + + + + Occurs after closing a progress window. + + + + + Occurs after printing a report. + + + + + Occurs when progress state is changed. + + + + + Gets or sets a value that determines whether to show the progress window + when perform time-consuming operations such as run, print, export. + + + + + Gets or sets a value that determines whether to show the information about + the report performance (report generation time, memory consumed) in the + lower right corner of the preview window. + + + + + Occurs when database connection is about to open. + + Use this event to provide own connection string or user name/password to the connection + object that is about to open. + To provide own connection string, set the e.ConnectionString property. + In this case the new connection string will be used. + To provide own user name/password, set the e.UserName and e.Password properties. + You may ask these values in own login dialog. + This example shows how to provide username/password using own login dialog. + + private void report1_DatabaseLogin(object sender, DatabaseLoginEventArgs e) + { + using (MyLoginDialog dialog = new MyLoginDialog()) + { + if (dialog.ShowDialog() == DialogResult.OK) + { + e.UserName = dialog.UserName; + e.Password = dialog.Password; + } + } + } + + This example shows how to provide own connection string. + + private void report1_DatabaseLogin(object sender, DatabaseLoginEventArgs e) + { + e.ConnectionString = my_connection_string; + } + + + + + + Occurs after the database connection is established. + + + + + Occurs when discovering the business object's structure. + + + + + Occurs when determining the kind of business object's property. + + + + + Occurs when discovering the structure of business object of ICustomTypeDescriptor type + with no instance specified. + + + The event handler must return an instance of that type. + + + + + Gets or sets the default script language. + + + + + Gets or sets the default paper size used when creating a new report. + + + + + Gets or sets a value indicating that the business object engine will use property values + when possible to discover the BO structure. + + + + + Gets or sets the default path for root of PictureObject.ImageLocation path. + + + + + Initializes a new instance of the class. + + + + + Number of folder and files, that have to be skipped + + + + + Number of folder and files, that have to be returned + + + + + Indicates a field to sort by + + + + + Indicates if sorting is descending + + + + + Default search options pattern + + + + + Number of folder and files, that have to be skipped + + + + + Number of folder and files, that have to be returned + + + + + Id of subscription with data sources + + + + + Mode of opening form: opening mode or saving mode + + + + + Mode of viewing reports: .frx or .fpx + + + + + Simple Storage Service client. + + + + + Gets or sets bucket where will saved export. + + + + + Gets or sets filename. + + + + + Gets or sets host S3. + + + + + + + + Get list of buckets names. + + List of buckets names + + + + Initialize signer. + + Access key ID + Secret access key + Service region + + + + Class for request sign to S3. Doc + + + + + Calculate hash sha256 of content and convert it to hexadecimal string. This string will be returned and written to x-amz-content-sha256 header. + + Request to which header will be added + Stream with content of request + String containing the encrypted and hexadecimal stream of the request content + + + + Represents form of SkyDrive storage client. + + + + + Initializes a new instance of the class. + + The report template. + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents the Client Info diabolg form. + + + + + Initializes a new instance of the class. + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Box cloud storage client. + + + + + Gets or sets the client info. + + + + + Gets or sets the authorization code. + + + + + Gets or sets the access token. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The storage client info. + + + + Initializes a new instance of the class. + + Client ID. + Client Secret. + + + + + + + Gets the authorization URL. + + The authorization URL stirng. + + + + Gets the access token. + + The access token string. + + + + Represents form of Box storage client. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The information about Box client application. + The report template. + + + + + + + + + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents the Client Info dialog form. + + + + + Gets the client ID. + + + + + Gets the client secret. + + + + + Initializes a new instance of the class. + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents form of the web browser. + + + + + Gets obtained authorization code. + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + FastCloud storage client. + + + + + Gets or sets the access token. + + + + + Gets the report URL that can be used to download report from cloud. + + + + + Initializes a new instance of the class. + + + + + + + + Gets the access token. + + The access token string. + + + + Represents form of FastCloud storage client. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The report template. + + + + + + + + + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents form of FastCloud storage client. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The report template. + + + + Checks is the string numeric. + + The checking string. + True if string is numeric, otherwise false. + + + + Gets the proxy settings. + + The proxy settings. + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + FTP storage client. + + + + + Gets or sets the FTP server. + + + + + Gets or sets the username. + + + + + Gets or sets the password. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The FTP server. + The username. + The password. + + + + + + + Represents form of the FTP storage client. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The FTP server. + The username. + The password. + The report template. + + + + + + + + + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + The base class for all cloud storage clients. + + + + + Gets or sets the filename. + + + + + Gets or set the information is user authorized or not. + + + + + Gets or sets the proxy settings of a client. + + + + + Initializes a new instance of the class. + + + + + Prepares report before it will be saved to cloud storage. + + The report template. + The export filter. + Memory stream that contains prepared report. + + + + Creates a MemoryStream instance using a Stream instance. + + The Stream instance that should be converted. + The MemoryStream instance. + + + + Saves a memory stream to cloud. + + The memory stream that should be saved. + + + + Saves the report to cloud storage. + + The report template that should be saved. + The export filter that should export template before. + + + + + Saves the stream to cloud storage. + + The stream that contains report. + The filename in which stream will be saved in cloud. + + + + Represents form of Dropbox storage client. + + + + + Gets or sets the report template. + + + + + Gets or sets the list of exports. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The report template. + + + + Initializes the list of exports. + + + + + Gets the proxy settings. + + The proxy settings. + + + + Initializes the component. + + + + + Checks is the string numeric. + + The checking string. + True if string is numeric, otherwise false. + + + + Finishes the form work. + + Returns true if work has been successfully finished, otherwise false. + + + + + + + SelectedIndexChanged event handler for ComboBox File Type. + + Event sender. + Event args. + + + + Click event handler for Button Settings. + + Event sender. + Event args. + + + + Shows a dialog window. + + Modal result. + + + + FormClosing event handler for CloudStorageClientForm. + + Event sender. + Event args. + + + + Click event handler for button OK. + + Event sender. + Event args. + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Page File. + + + + + Page Proxy. + + + + + ComboBox File Type. + + + + + Label File Type. + + + + + Buttons Settings. + + + + + Label Colon. + + + + + Label Password. + + + + + Label Username. + + + + + Label Server. + + + + + TextBox Username. + + + + + TextBox Port. + + + + + TextBox Server. + + + + + TextBox Password. + + + + + PageControl. + + + + + Represents the Application Info diabolg form. + + + + + Gets the access token. + + + + + Initializes a new instance of the class. + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Dropbox cloud storage client. + + + + + The base URL for files_put command. + + + + + Gets or sets the application access token. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The Dropbox application access token. + + + + + + + Represents form of Dropbox storage client. + + + + + Initializes a new instance of the class. + + The Dropbox access token. + The report template. + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents the Client Info diabolg form. + + + + + Gets the client ID. + + + + + Gets the client secret. + + + + + Gets the client Auth key. + + + + + Initializes a new instance of the class. + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Google Drive cloud storage client. + + + + + Gets or sets the client info. + + + + + Gets or sets the authorization code. + + + + + Gets or sets the access token. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The storage client info. + + + + Initializes a new instance of the class. + + Client ID. + Client Secret. + + + + + + + Gets the authorization URL. + + The authorization URL stirng. + + + + Gets the access token. + + The access token string. + + + + Represents form of Google Drive storage client. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The information about Google Drive client application. + The report template. + + + + + + + + + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents form of the web browser. + + + + + Gets obtained authorization code. + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents form of the web browser. + + + + + Gets obtained authorization code. + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents the information about SkyDrive application. + + + + + Gets or sets the client name. + + + + + Gets or sets the client ID. + + + + + Gets or sets the client secret. + + + + + Initializes a new instance of the class. + + The client name. + The client ID. + The client secret. + + + + Represents the Client Info diabolg form. + + + + + Gets the client ID. + + + + + Gets the client secret. + + + + + Initializes a new instance of the class. + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents form of SkyDrive storage client. + + + + + Initializes a new instance of the class. + + The SkyDrive client info. + The report template. + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + SkyDrive cloud storage client. + + + + + Gets or sets the client info. + + + + + Gets or sets the authorization code. + + + + + Gets or sets the access token. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The client info. + + + + Initializes a new instance of the class. + + Client ID. + Client Secret. + + + + + + + Gets the authorization URL. + + The authorization URL string. + + + + Gets the access token. + + The access token value. + + + + Represents the base form for cloud storage web browsers. + + + + + Gets or sets the url string. + + + + + Initizlizes a new instance of the class. + + + + + Initializes a new instance of the class. + + The url string. + + + + Handle the web browser form shown event. + + The event sender. + The event args. + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + The web browser component. + + + + + Represents an HTTP request method. + + + + + GET request method. + + + + + POST request method. + + + + + PUT request method. + + + + + DELETE request method. + + + + + Static class that contains HTTP utilities. + + + + + Encodes the URL string. + + The URL string. + The encoded URL string. + + + + Encodes the dictionary with URL parameters. + + The dictionary with parameters. + The encoded string. + + + + Decodes the URL string. + + The URL string. + The decoded URL string. + + + + Represents the consumer. + + + + + Gets the consumer key. + + + + + Gest the consumer secret. + + + + + Gets the consumer's signature method. + + + + + Initializes a new instance of the class. + + The consumer key. + The consumer secret. + + + + Represents parser for parse OAuth responses. + + + + + Parses token information in stream. + + The stream for parse. + The OAuth token. + + + + Parses token information in stream for SkyDrive. + + The stream for parse. + The SkyDrive access token. + + + + Parses token information in stream for Google Drive. + + The stream for parse. + The Google Drive access token. + + + + Parses token information in stream for FastCloud. + + The stream for parse. + The FastCloud access token. + + + + Represents the service provider. + + + + + Gets the request token URL. + + + + + Gets the user authorization URL. + + + + + Gets the callback URL. + + + + + Gets the access token URL. + + + + + Initializes a new instance of the class with a specified parameters. + + The request token URL. + The user authorization URL. + The callback URL. + The access token URL. + + + + Represents the OAuth token credentials. + + + + + Gets the token key. + + + + + Gets the token secret. + + + + + Initializes a new instance of the class. + + The token key. + The token secret. + + + + API for OAuth protocol. + + + + + Builds signed URL. + + The base token URL. + The HTTP method. + The consumer context. + The request token. + Signed URL. + + + + Represents the signature method. + + + + + Signature method PLAINTEXT. + + + + + Signature method HMAC-SHA1. + + + + + Signature method RSA-SHA1. + + + + + Represents proxy settings of the cloud storage. + + + + + Gets or sets the type of proxy. + + + + + Gets or sets the proxy server. + + + + + Gets or sets the port number of proxy server. + + + + + Gets or sets the username. + + + + + Gets or sets the user's password. + + + + + Initializes a new instance of the class. + + The type of proxy. + The proxy server. + The port number of server. + The username. + The user's password. + + + + Represents the type of rpoxy. + + + + + The HTTP proxy type. + + + + + The SOCKS4 proxy type. + + + + + The SOCKS5 proxy type. + + + + + Provides utils for the web request. + + + + + Sets proxy settings for web request. + + The web request. + The cloud proxy settings. + + + + Represents the parameter of http request. + + + + + Gets the name of a request parameter. + + + + + Gets the value of a request parameter. + + + + + Initializes a naw instance of the class with a specified parameters. + + The name of a request parameter. + The value of a request paramter. + + + + Comparer class for comparing request parameters. + + + + + + + + Container object that may contain child objects. + + + + + Gets the collection of child objects. + + + + + This event occurs before the container layouts its child objects. + + + + + This event occurs after the child objects layout was finished. + + + + + Gets or sets a script event name that will be fired before the container layouts its child objects. + + + + + Gets or sets a script event name that will be fired after the child objects layout was finished. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This method fires the BeforeLayout event and the script code connected to the BeforeLayoutEvent. + + Event data. + + + + This method fires the AfterLayout event and the script code connected to the AfterLayoutEvent. + + Event data. + + + + + + + + + + + + + Initializes a new instance of the ContainerObject class with default settings. + + + + + + + + + + + + + + + + + Allows working with JsonObject + + + + + Returns child object for JsonArray + + + + + + + Returns child object for JsonObject + + + + + + + Returns count of child object + + + + + Returns true if this object is JsonArray + + + + + Returns true if this object is JsonObject + + + + + Returns list of JsonObject keys + + + + + Pars json text string and return a new JsonBase Object + + + + + + + returns true + + + + + + + Serialize this object to sb + + + + indent in space, 0 = without indent + + + + Based on code of Stefan Böther, xprocs@hotmail.de + + + + + Contains standard functions registered in the "Data" window. + + + + + Returns the larger of two 32-bit signed integers. + + The first of two values to compare. + The second of two values to compare. + Parameter val1 or val2, whichever is larger. + + + + Returns the larger of two 64-bit signed integers. + + The first of two values to compare. + The second of two values to compare. + Parameter val1 or val2, whichever is larger. + + + + Returns the larger of two single-precision floating-point numbers. + + The first of two values to compare. + The second of two values to compare. + Parameter val1 or val2, whichever is larger. + + + + Returns the larger of two double-precision floating-point numbers. + + The first of two values to compare. + The second of two values to compare. + Parameter val1 or val2, whichever is larger. + + + + Returns the larger of two decimal numbers. + + The first of two values to compare. + The second of two values to compare. + Parameter val1 or val2, whichever is larger. + + + + Returns the smaller of two 32-bit signed integers. + + The first of two values to compare. + The second of two values to compare. + Parameter val1 or val2, whichever is smaller. + + + + Returns the smaller of two 64-bit signed integers. + + The first of two values to compare. + The second of two values to compare. + Parameter val1 or val2, whichever is smaller. + + + + Returns the smaller of two single-precision floating-point numbers. + + The first of two values to compare. + The second of two values to compare. + Parameter val1 or val2, whichever is smaller. + + + + Returns the smaller of two double-precision floating-point numbers. + + The first of two values to compare. + The second of two values to compare. + Parameter val1 or val2, whichever is smaller. + + + + Returns the smaller of two decimal numbers. + + The first of two values to compare. + The second of two values to compare. + Parameter val1 or val2, whichever is smaller. + + + + Returns an integer value representing the character code corresponding to a character. + + Character to convert. + The character code. + + + + Returns the character associated with the specified character code. + + Character code to convert. + The character. + + + + Inserts a specified string at a specified index position in the original string. + + The original string. + The index position of the insertion. + The string to insert. + A new string. + + + + Gets the number of characters in a string. + + The original string. + The number of characters. + + + + Converts a specified string to lowercase. + + The string to convert. + A string in lowercase. + + + + Right-aligns the characters in a string, padding with spaces on the left for a specified total length. + + The original string. + The number of characters in the resulting string. + Right-aligned string, padded on the left with spaces. + + + + Right-aligns the characters in a string, padding on the left with a specified character + for a specified total length. + + The original string. + The number of characters in the resulting string. + A padding character. + Right-aligned string, padded on the left with padding characters. + + + + Left-aligns the characters in a string, padding with spaces on the right, for a specified total length. + + The original string. + The number of characters in the resulting string. + Left-aligned string, padded on the right with spaces. + + + + Left-aligns the characters in a string, padding on the right with a specified character, + for a specified total length. + + The original string. + The number of characters in the resulting string. + A padding character. + Left-aligned string, padded on the right with padding characters. + + + + Converts the specified string to titlecase. + + The string to convert. + A new string. + + + + Deletes all the characters from a string beginning at a specified position. + + The original string. + The position to begin deleting characters. + A new string. + + + + Deletes a specified number of characters from a string beginning at a specified position. + + The original string. + The position to begin deleting characters. + The number of characters to delete. + A new string. + + + + Replaces all occurrences of a specified string in the original string, with another specified string. + + The original string. + A string to be replaced. + A string to replace all occurrences of oldValue. + A new string. + + + + Retrieves a substring from the original string, starting at a specified character position. + + The original string. + The starting character position of a substring. + A new string. + + + + Retrieves a substring from the original string, starting at a specified character position, + with a specified length. + + The original string. + The starting character position of a substring. + The number of characters in the substring. + A new string. + + + + Removes all occurrences of white space characters from the beginning and end of the original string. + + The original string. + A new string. + + + + Converts a specified string to uppercase. + + The string to convert. + A string in uppercase. + + + + Adds the specified number of days to the original date. + + The original date. + A number of whole and fractional days. + A new DateTime value. + + + + Adds the specified number of hours to the original date. + + The original date. + A number of whole and fractional hours. + A new DateTime value. + + + + Adds the specified number of minutes to the original date. + + The original date. + A number of whole and fractional minutes. + A new DateTime value. + + + + Adds the specified number of months to the original date. + + The original date. + A number of months. + A new DateTime value. + + + + Adds the specified number of seconds to the original date. + + The original date. + A number of whole and fractional seconds. + A new DateTime value. + + + + Adds the specified number of years to the original date. + + The original date. + A number of years. + A new DateTime value. + + + + Subtracts the specified date and time from the original date. + + The original date. + The date and time to subtract. + A TimeSpan interval between two dates. + + + + Initializes a new instance of the DateTime. + + The year. + The month. + The day. + A new DateTime value. + + + + Gets the day of the month. + + The date value. + The day component. + + + + Gets the localized name of the day of the week. + + The date value. + The name of the day of the week. + + + + Gets the day of the year. + + The date value. + The day of the year. + + + + Returns the number of days in the specified month and year. + + The year. + The month. + The number of days in month for the specified year. + + + + Gets the hour component of the date. + + The date. + The hour component. + + + + Gets the minute component of the date. + + The date. + The minute component. + + + + Gets the month component of the date. + + The date. + The month component. + + + + Gets the localized month name. + + The month number. + The month name. + + + + Gets the seconds component of the date. + + The date. + The seconds component. + + + + Gets the week of the year. + + The date value. + The week of the year. + + + + Gets the year component of the date. + + The date. + The year component. + + + + Replaces the format item in a specified String with the text equivalent of the value of a + corresponding Object instance in a specified array. + + A String containing zero or more format items. + An Object array containing zero or more objects to format. + A copy of format in which the format items have been replaced by the String equivalent of the corresponding instances of Object in args. + + + + Returns a string formatted as a currency value. + + The value to format. + The formatted string. + + + + Returns a string formatted as a currency value with specified number of decimal digits. + + The value to format. + Number of decimal digits. + The formatted string. + + + + Returns a string formatted as a date/time value. + + The value to format. + The formatted string. + + + + Returns a string formatted as a date/time value. + + The value to format. + The format specifier, one of the + "Long Date", "Short Date", "Long Time", "Short Time" values. + The formatted string. + + + + Returns a string formatted as a numeric value. + + The value to format. + The formatted string. + + + + Returns a string formatted as a numeric value with specified number of decimal digits. + + The value to format. + Number of decimal digits. + The formatted string. + + + + Returns a string formatted as a percent value. + + The value to format. + The formatted string. + + + + Returns a string formatted as a percent value with specified number of decimal digits. + + The value to format. + Number of decimal digits. + The formatted string. + + + + Converts a numeric value to Roman string representation. + + Integer value in range 0-3998. + The string in Roman form. + + + + Converts a currency value to an english (US) string representation of that value. + + The currency value to convert. + The string representation of the specified value. + + + + Converts a currency value to an english (US) string representation of that value, + using the specified currency. + + The currency value to convert. + The 3-digit ISO name of the currency, for example "EUR". + The string representation of the specified value. + + + + Converts a numeric value to an english (US) string representation of that value. + + The numeric value to convert. + The name in singular form, for example "page". + The name in plural form, for example "pages". + The string representation of the specified value. + + + + Converts a currency value to an english (GB) string representation of that value. + + The currency value to convert. + The string representation of the specified value. + + + + Converts a currency value to an english (GB) string representation of that value, + using the specified currency. + + The currency value to convert. + The 3-digit ISO name of the currency, for example "EUR". + The string representation of the specified value. + + + + Converts a numeric value to an english (GB) string representation of that value. + + The numeric value to convert. + The name in singular form, for example "page". + The name in plural form, for example "pages". + The string representation of the specified value. + + + + Converts a currency value to a spanish string representation of that value. + + The currency value to convert. + The string representation of the specified value. + + + + Converts a currency value to a spanish string representation of that value, + using the specified currency. + + The currency value to convert. + The 3-digit ISO name of the currency, for example "EUR". + The string representation of the specified value. + + + + Converts a numeric value to a spanish string representation of that value. + + The numeric value to convert. + The name in singular form, for example "page". + The name in plural form, for example "pages". + The string representation of the specified value. + + + + Converts a currency value to a russian string representation of that value. + + The currency value to convert. + The string representation of the specified value. + + + + Converts a currency value to a russian string representation of that value, + using the specified currency. + + The currency value to convert. + The 3-digit ISO name of the currency, for example "EUR". + The string representation of the specified value. + + + + Converts a numeric value to a russian string representation of that value. + + The numeric value to convert. + True if the name is of male gender. + The name in singular form, for example "страница". + The name in plural form, for example "страницы". + The name in plural form, for example "страниц". + The string representation of the specified value. + + + + Converts a currency value to a german string representation of that value. + + The currency value to convert. + The string representation of the specified value. + + + + Converts a currency value to a german string representation of that value, + using the specified currency. + + The currency value to convert. + The 3-digit ISO name of the currency, for example "EUR". + The string representation of the specified value. + + + + Converts a numeric value to a german string representation of that value. + + The numeric value to convert. + The name in singular form, for example "page". + The name in plural form, for example "pages". + The string representation of the specified value. + + + + Converts a currency value to a french string representation of that value. + + The currency value to convert. + The string representation of the specified value. + + + + Converts a currency value to a french string representation of that value, + using the specified currency. + + The currency value to convert. + The 3-digit ISO name of the currency, for example "EUR". + The string representation of the specified value. + + + + Converts a numeric value to a french string representation of that value. + + The numeric value to convert. + The name in singular form, for example "page". + The name in plural form, for example "pages". + The string representation of the specified value. + + + + Converts a currency value to a dutch string representation of that value. + + The currency value to convert. + The string representation of the specified value. + + + + Converts a currency value to a dutch string representation of that value, + using the specified currency. + + The currency value to convert. + The 3-digit ISO name of the currency, for example "EUR". + The string representation of the specified value. + + + + Converts a numeric value to a dutch string representation of that value. + + The numeric value to convert. + The name in singular form, for example "page". + The name in plural form, for example "pages". + The string representation of the specified value. + + + + Converts a numeric value to a indian numbering system string representation of that value. + + the currency value to convert + The string representation of the specified value. + + + + Converts a numeric value to a indian numbering system string representation of that value. + + he numeric value to convert. + The 3-digit ISO name of the currency, for example "INR". + + + + + Converts a numeric value to a indian numbering system string representation of that value. + + The numeric value to convert. + The name in singular form, for example "page". + The name in plural form, for example "pages". + The string representation of the specified value. + + + + Converts a numeric value to a ukrainian string representation of that value. + + The numeric value to convert. + The string representation of the specified value. + + + + Converts a currency value to a ukrainian string representation of that value, + using the specified currency. + + The currency value to convert. + The 3-digit ISO name of the currency, for example "UAH". + The string representation of the specified value. + + + + Converts a numeric value to a ukrainian string representation of that value. + + The numeric value to convert. + True if the name is of male gender. + The name in singular form, for example "сторінка". + The name in plural form, for example "сторінки". + The name in plural form, for example "сторінок". + The string representation of the specified value. + + + + Converts a numeric value to a spanish string representation of that value. + + The numeric value to convert. + The string representation of the specified value. + + + + Converts a numeric value to a spanish representation of that value. + + he numeric value to convert. + The 3-digit ISO name of the currency, for example "EUR". + + + + + Converts a numeric value to a spanish string representation of that value. + + The numeric value to convert. + The name in singular form, for example "silla". + The name in plural form, for example "Sillas". + The string representation of the specified value. + + + + Converts a numeric value to a persian string representation of that value. + + The numeric value to convert. + The string representation of the specified value. + + + + Converts a numeric value to a persian representation of that value. + + he numeric value to convert. + The 3-digit ISO name of the currency, for example "EUR". + + + + + Converts a numeric value to a persian string representation of that value. + + The numeric value to convert. + The name in singular form, for example "silla". + The name in plural form, for example "Sillas". + The string representation of the specified value. + + + + Converts a numeric value to a polish string representation of that value. + + The numeric value to convert. + The string representation of the specified value. + + + + Converts a numeric value to a polish representation of that value. + + he numeric value to convert. + The 3-digit ISO name of the currency, for example "EUR". + + + + + Converts a numeric value to a polish string representation of that value. + + The numeric value to convert. + The name in singular form, for example "silla". + The name in plural form, for example "Sillas". + The string representation of the specified value. + + + + Converts a value to an english (US) alphabet string representation of that value. + + The value to convert. + The alphabet string representation of the specified value. + + + + Converts a value to an english (US) alphabet string representation of that value. + + The value to convert. + Bool indicating that letters should be in upper registry. + The alphabet string representation of the specified value. + + + + Converts a value to a russian alphabet string representation of that value. + + The value to convert. + The alphabet string representation of the specified value. + + + + Converts a value to a russian alphabet string representation of that value. + + The value to convert. + Bool indicating that letters should be in upper registry. + The alphabet string representation of the specified value. + + + + Selects and returns a value from a list of arguments. + + A value between 1 and the number of elements passed in the "choice" argument. + Object parameter array. + One of the values in the "choice" argument. + + + + Returns one of two objects, depending on the evaluation of an expression. + + The expression you want to evaluate. + Returned if Expression evaluates to True. + Returned if Expression evaluates to False. + Either truePart os falsePart. + + + + Evaluates a list of expressions and returns a value corresponding to the first + expression in the list that is True. + + Parameter array consists of paired expressions and values. + The value corresponding to an expression which returns true. + + + + Checks if the specified object is null. + + The report instance. + Either a name of DB column, or a parameter name, or a total name to check. + true if the object's value is null. + + + + The FastReport.dll assembly initializer. + + + + + Registers all standard objects, wizards, export filters. + + + + + Base class for all bands. + + + + + + + + + + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + + + + This property is not relevant to this class. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This event occurs before the band layouts its child objects. + + + + + This event occurs after the child objects layout was finished. + + + + + Gets or sets a value indicating that the band should be printed from a new page. + + + New page is not generated when printing very first group or data row. This is made to avoid empty + first page. + + + + + Gets or sets a value that determines the number of repetitions of the same band. + + + + + Gets or sets a value indicating that the first row can start a new report page. + + + Use this property if is set to true. Normally the new page + is not started when printing the first data row, to avoid empty first page. + + + + + Gets or sets a value indicating that the band should be printed on the page bottom. + + + + + Gets or sets a value indicating that the band should be printed together with its child band. + + + + + Gets or sets an outline expression. + + + + Outline is a tree control displayed in the preview window. It represents the prepared report structure. + Each outline node can be clicked to navigate to the item in the prepared report. + + + To create the outline, set this property to any valid expression that represents the outline node text. + This expression will be calculated when band is about to print, and its value will be added to the + outline. Thus, nodes' hierarchy in the outline is similar to the bands' hierarchy + in a report. That means there will be the main and subordinate outline nodes, corresponding + to the main and subordinate bands in a report (a report with two levels of data or with groups can + exemplify the point). + + + + + + Gets or sets a child band that will be printed right after this band. + + + Typical use of child band is to print several objects that can grow or shrink. It also can be done + using the shift feature (via property), but in some cases it's not possible. + + + + + Gets a collection of report objects belongs to this band. + + + + + Gets a value indicating that band is reprinted on a new page. + + + This property is applicable to the DataHeaderBand and GroupHeaderBand only. + It returns true if its RepeatOnAllPages property is true and band is + reprinted on a new page. + + + + + Gets or sets a script event name that will be fired before the band layouts its child objects. + + + + + Gets or sets a script event name that will be fired after the child objects layout was finished. + + + + + + + + + + + Gets or sets collection of guide lines for this band. + + + + + Gets a row number (the same value returned by the "Row#" system variable). + + + This property can be used when running a report. It may be useful to print hierarchical + row numbers in a master-detail report, like this: + 1.1 + 1.2 + 2.1 + 2.2 + To do this, put the Text object on a detail data band with the following text in it: + [Data1.RowNo].[Data2.RowNo] + + + + + Gets an absolute row number (the same value returned by the "AbsRow#" system variable). + + + + + Gets a value indicating that this is the first data row. + + + + + Gets a value indicating that this is the last data row. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This method fires the BeforeLayout event and the script code connected to the BeforeLayoutEvent. + + Event data. + + + + This method fires the AfterLayout event and the script code connected to the AfterLayoutEvent. + + Event data. + + + + Initializes a new instance of the class with default settings. + + + + + Specifies an origin where the new objects inserted from. + + + + + Specifies that a new object was inserted from the "Objects" toolbar or "Insert" menu. + + + + + Specifies that a new object was dragged from the "Dictionary" window. + + + + + Specifies that a new object was pasted from the clipboard. + + + + + Represents the root class of the FastReport object's hierarchy. + + + + + Gets a value indicating whether the object is selected in the designer. + + + + + Gets a value indicating whether one of the object's parent is selected in the designer. + + + + + Deletes the object in the designer. + + + This method is called when you delete the object in the designer. + Typically this method calls the method to delete the object and all + its children. You may override it to delete the object only, and keep children. + + + + + Called before inserting a new object in the designer. + + + Do not call this method directly. You may override it if you are developing a + new component for FastReport. + + Some objects are registered in the designer several times with the same object + type, but different flags. For example, the + represents different shapes: rectangle, roundrect, ellipse and so on. All these + shapes are registered in the designer using flags (the last parameter in this + code): + + RegisteredObjects.Add(typeof(ShapeObject), "ReportPage,Shapes", 108, "Objects,Shapes,Rectangle", 0); + RegisteredObjects.Add(typeof(ShapeObject), "ReportPage,Shapes", 109, "Objects,Shapes,RoundRectangle", 1); + RegisteredObjects.Add(typeof(ShapeObject), "ReportPage,Shapes", 110, "Objects,Shapes,Ellipse", 2); + + When we put the "Ellipse" object on a band, the designer creates the + ShapeObject instance and calls its OnBeforeInsert method with + flags value set to 2. In turn, the OnBeforeInsert method converts the + int value of the flags to the shape kind: + + public override void OnBeforeInsert(int flags) + { + FShape = (ShapeKind)flags; + } + + + + Object's flags. + + + + Called after the new object was inserted in the designer. + + + Do not call this method directly. You may override it if you are developing a new component + for FastReport. + This method is called when new object is inserted, pasted from clipboard or dragged from + "Dictionary" window. You may override this method if you need to perform some actions when object + is inserted. Typical implementation invokes the object's editor if "Edit after insert" flag is set + in the designer options. + + The insertion source. + + + + Called when the user selects another object in the designer. + + + This method is typically used by the in-place object's editor to check if selection was changed and close + the editor. + + + + + Gets the object's context menu. + + Null reference if object does not have a menu. + + Do not call this method directly. You may override it if you are developing a new component + for FastReport. + You may use base menu classes such as , + to create own context menus. + + + + + Gets an image index for this component to display it in the Report Tree. + + The image index or -1 if no image is associated with this component. + + + + Gets or sets the name of the object. + + + Name of the report object must contain alpha, digit, underscore symbols only. + Data objects such as Variable, TableDataSource + etc. can have any characters in they names. Each component must have unique + name. + + The following code demonstrates how to find an object by its name: + + TextObject text1 = report1.FindObject("Text1") as TextObject; + + + Another object with such name exists. + Rename an object that was introduced in the ancestor report. + + + + Gets or sets the flags that restrict some actions in the designer. + + + Use this property to restrict some user actions like move, resize, edit, delete. For example, if + Restriction.DontMove flag is set, user cannot move the object in the designer. + + + + + Gets the flags that allow some functionality in the designer. + + + Use this property only if you developing a new FastReport object. + + + + + Gets or sets the parent of the object. + + + Each report object must have a parent in order to appear in the report. Parent must be able to + contain objects of such type. + Another way (preferred) to set a parent is to use specific properties of the parent object. + For example, the object has the collection. + To add a new page to the report, use the following code: report1.Pages.Add(new ReportPage()); + + + + Report report1; + ReportPage page = new ReportPage(); + page.Parent = report1; + + Parent object cannot contain this object. + + + + The base part of the object's name. + + + This property is used to automatically create unique object's name. See + + + + + Gets the short type name. + + + Returns the short type name, such as "TextObject". + + + + + Gets reference to the parent object. + + + + + Gets reference to the parent object. + + + + + Gets the collection of this object's child objects. + + + This property returns child objects that belongs to this object. For example, Report.ChildObjects + will return only pages that contains in the report, but not page childs such as bands. To return all + child objects, use property. + + + + + Gets the collection of all child objects. + + + This property returns child objects that belongs to this object and to child objects of this object. + For example, Report.AllObjects will return all objects that contains in the report - such as + pages, bands, text objects. + + + + + Gets or sets the Z-order of the object. + + + The Z-order is also called "creation order". It is the index of an object in the parent's objects list. + For example, put two text objects on a band. First object will have ZOrder = 0, second = 1. Setting the + second object's ZOrder to 0 will move it to the back of the first text object. + + + + + Gets a value indicating whether the object was introduced in the ancestor report. + + + + + Gets a value indicating whether the object is in the design state. + + + + + Gets a value indicating whether the object is currently printing. + + + + + Gets a value indicating whether the object is currently processed by the report engine. + + + + + Gets a value indicating whether the object is currently processed by the report engine. + + + + + Gets an original component for this object. + + + This property is used in the preview mode. Each object in the prepared report is bound to its + original (from the report template). This technique is used to minimize the prepared report's size. + + + + + Helper method, helps to set a reference-type value to the property. + + Old property value. + New property value. + + This method is used widely to set a new value to the property that references another FastReport object. + Method deals with the property. + + This is example of the DataBand.Header property: + public DataHeaderBand Header + { + get { return FHeader; } + set + { + SetProp(FHeader, value); + FHeader = value; + } + } + + + + + Checks if two float values are different. + + First value. + Second value. + true if values are not equal. + + This method is needed to compare two float values using some precision (0.001). It is useful + to compare objects' locations and sizes for equality. + + + + + Deserializes nested object properties. + + Reader object. + + Typically the object serializes all properties to the single xml item: + + <TextObject Name="Text2" Left="18.9" Top="37.8" Width="283.5" Height="28.35"/> + + Some objects like have child objects that serialized in subitems: + + <DataBand Name="Data1" Top="163" Width="718.2" Height="18.9"> + <TextObject Name="Text3" Left="18.9" Top="37.8" Width="283.5" Height="28.35"/> + </DataBand> + + To read such subitems, the DeserializeSubItems method is used. Base + implementation reads the child objects. You may override it to read some specific subitems. + + The following code is used to read report's styles: + + protected override void DeserializeSubItems(FRReader reader) + { + if (String.Compare(reader.ItemName, "Styles", true) == 0) + reader.Read(Styles); + else + base.DeserializeSubItems(reader); + } + + + + + + Replaces the macros in the given string and returns the new string. + + The text containing macros. + The text with macros replaced with its values. + + + + + + + Set object's flags. + + Flag to set. + true to set the flag, false to reset. + + + + Sets the reference to a Report. + + Report to set. + + + + Sets the object's name. + + + This method is for internal use only. It just sets a new name without any checks + (unlike the property setter). + + Name Property + New name. + + + + Sets the object's parent. + + + This method is for internal use only. You can use it if you are developing a new + component for FastReport. Override it to perform some actions when the parent of an + object is changing. This method checks that parent can contain a child. + + Parent object cannot contain this object. + New parent. + + + + Sets the object's parent. + + New parent. + + This method is for internal use only. You can use it if you are developing a new component for FastReport. + This method does not perform any checks, it just sets the new parent. + + + + + Searches for an object with given name. + + Name of the object to find. + Returns a null reference if object is not found + The following code demonstrates how to find an object by its name: + + TextObject text1 = report1.FindObject("Text1") as TextObject; + if (text1 != null) + { + // object found + } + + + + + + Creates the unique object's name. + + + Note: you have to set object's parent before calling this method. Method uses the + property to create a name. + Note: this method may be very slow on a report that contains lots of objects. Consider + using own naming logic in this case. + + + + TextObject textObj = new TextObject(); + dataBand1.Objects.Add(textObj); + textObj.CreateUniqueName(); + + + + + + Clears the object's state. + + + This method also disposes all object's children. + + + + + Serializes the object. + + + Do not call this method directly. You should override it if you are + developing a new component for FastReport. + This method is called when the object needs to save the state. It may happen + when: + + + saving the report to the file or stream; + + + saving the report to the designer's undo buffer; + + + + assigning the object to another object using the + or AssignAll methods; + + + + saving the object to the designer's clipboard; + + + saving the object to the preview (when run a + report). + + + + Writer object. + + + + Deserializes the object. + + + Do not call this method directly. You should override it if you are + developing a new component for FastReport. + This method is called when the object needs to restore the state. It may + happen when: + + + loading the report from a file or stream; + + + loading the report from the designer's undo + buffer; + + + assigning another object to this object using the + or AssignAll methods; + + + loading the object from the designer's + clipboard; + + loading the object from the preview pages. + + + Reader object. + + + + Assigns values from another source. + + + Note: this method is relatively slow because it serializes + an object to the xml and then deserializes it. + + Source to assign from. + + + Copies the contents of another, similar object. + + Call Assign to copy the properties from another object of the same type. + The standard form of a call to Assign is + destination.Assign(source); + + which tells the destination object to copy the contents of the + source object to itself. In this method, all child objects are + ignored. If you want to copy child objects, use the + AssignAll method. + + + + Report report1; + Report report2 = new Report(); + // copy all report settings, do not copy report objects + report2.Assign(report1); + + AssignAll Method + Source object to copy the contents from. + + + Copies the contents (including children) of another, similar object. + + + This method is similar to method. It copies child + objects as well. + + + + Report report1; + Report report2 = new Report(); + // copy all report settings and objects + report2.AssignAll(report1); + + + Source object to copy the state from. + + + + Gets a value indicating whether the object has the specified parent in its parent hierarchy. + + Parent object to check. + Returns true if the object has given parent in its parent hierarchy. + + + + Gets a value indicating whether the object has a specified flag in its property. + + Flag to check. + true if Flags property contains specified flag. + + + + Gets a value indicating whether the object has a specified restriction + in its property. + + Restriction to check. + true if Restrictions property contains specified restriction. + + + + Invokes script event. + + Name of the event to invoke. + Event parameters. + + Do not call this method directly. You should use it if you are developing a new component + for FastReport. + Use this method to call an event handler that is located in the report's script. + + Example of the OnBeforePrint method: + public void OnBeforePrint(EventArgs e) + { + if (BeforePrint != null) + BeforePrint(this, e); + InvokeEvent(BeforePrintEvent, e); + } + + + + + Called after all report objects were loaded. + + + Do not call this method directly. You may override it if you are developing a new component + for FastReport. + + + + + Gets all expressions contained in the object. + + Array of expressions or null if object contains no expressions. + + Do not call this method directly. You may override it if you are developing a + new component for FastReport. + + This method is called by FastReport each time before run a report. FastReport + do this to collect all expressions and compile them. For example, + GetExpressions method of the class + parses the text and returns all expressions found in the text. + + + + + + Returns a custom code that will be added to the report script before report is run. + + A custom script text, if any. Otherwise returns null. + + This method may return any valid code that may be inserted into the report script. Currently it is + used in the TableObject to define the following script methods: Sum, Min, Max, Avg, Count. + + + Note: you must take into account the current script language - C# or VB.Net. You may check it via + Report.ScriptLanguage property. + + + + + + Used to extract macros such as "TotalPages#" in the preview mode. + + + This method is used mainly by the TextObject to extract macros and replace it with + actual values passed in the pageIndex and totalPages parameters. This method + is called automatically when the object is being previewed. + + + + + Used to get information of the need to convertation if the function returns true, then the GetConvertedObjects function is called + + The export or the object, that call this method + By default returns false + + The functions IsHaveToConvert and GetConvertedObjects allow you to convert objects from one to another, + for example the export will convert object before adding it to the file and convert recursive, + i.e. If the new object has the ability to convert, + it will be converted again but limit is 10 times. + At the time of export it is called, only on objects inside the band, + the child objects of converted object will be returned, and the child objects of old object will be ignored. + + + + + Used to get an enumeration of the objects to which this object will be converted, before calling this function, the IsHaveToConvert function will be called + + By default returns this object + + The functions IsHaveToConvert and GetConvertedObjects allow you to convert objects from one to another, + for example the export will convert object before adding it to the file and convert recursive, + i.e. If the new object has the ability to convert, + it will be converted again but limit is 10 times. + At the time of export it is called, only on objects inside the band, + the child objects of converted object will be returned, and the child objects of old object will be ignored. + + + + + Gets the collection of all child objects, converts objects if necessary + + the object or export, that call this convertation + + + + Initializes a new instance of the Base class with default settings. + + + + + This class represents the context menu of the . + + + This class adds the "Can Break" menu item to the component context menu. + + + + + The "Can Break" menu item. + + + + + Initializes a new instance of the BreakableComponentMenu class with default settings. + + + + + Represents a text object which draws each symbol of text in its own cell. + + + The text may be aligned to left or right side, or centered. Use the + property to do this. The "justify" align is not supported now, as well as vertical alignment. + The cell size is defined in the and properties. + These properties are 0 by default, in this case the size of cell is calculated automatically based + on the object's Font. + To define a spacing (gap) between cells, use the and + properties. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + + + + + + + Gets or sets the width of cell, in pixels. + + + If zero width and/or height specified, the object will calculate the cell size + automatically based on its font. + + + + + Gets or sets the height of cell, in pixels. + + + If zero width and/or height specified, the object will calculate the cell size + automatically based on its font. + + + + + Gets or sets the horizontal spacing between cells, in pixels. + + + + + Gets or sets the vertical spacing between cells, in pixels. + + + + + + + + + + + + + + + + + Initializes a new instance of the class with the default settings. + + + + + Represents a check box object. + + + + + + + + + + + + + + Gets or set a value indicating whether the check box is in the checked state. + + + + + Gets or sets a symbol that will be displayed when the check box is in the checked state. + + + + + Gets or sets a symbol that will be displayed when the check box is in the unchecked state. + + + + + Gets or sets a color of the check symbol. + + + + + Gets or sets a data column name bound to this control. + + + Value must be in the form "[Datasource.Column]". + + + + + Gets or sets an expression that determines whether to show a check. + + + + + Gets or sets the check symbol width ratio. + + + Valid values are from 0.2 to 2. + + + + + Gets or sets a value determines whether to hide the checkbox if it is in the unchecked state. + + + + + Gets or sets editable for pdf export + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the CheckBoxObject class with default settings. + + + + + This class represents a child band. + + + Typical use of child band is to print several objects that can grow or shrink. It also can be done + using the shift feature (via property), but in some cases it's not possible. + + + + + + + + + + + Gets or sets a value indicating that band will be used to fill unused space on a page. + + + If you set this property to true, the band will be printed several times to fill + unused space on a report page. + + + + + Gets or sets a value that determines the overall number of data rows printed by the data band. + + + Using this property, you may complete the data band upto N data rows. + If the data band has less number of rows, this band will be used to print empty rows. + + + + + Gets or sets a value indicating that the band will be printed if its parent databand is empty. + + + The child band with this property set to true, connected to a databand can be used to print "No data" + text if the databand has no rows. + + + + + + + + + + + Returns true, if compilation is successful + + + + + Handle compile errors + + + + + Returns true if recompilation is successful + + + + + This class is used to pass find arguments to some methods of the CodeUtils class. + + + + + The start position of the search. After the search, this property points to + the begin of an expression. + + + + + After the search, this property points to the end of an expression. + + + + + The char sequence used to find the expression's begin. + + + + + The char sequence used to find the expression's end. + + + + + The text with embedded expressions. + + + + + The last found expression. + + + + + This static class contains methods that may be used to find expressions embedded + in the object's text. + + + + + Returns expressions found in the text. + + Text that may contain expressions. + The char sequence used to find the start of expression. + The char sequence used to find the end of expression. + Array of expressions if found; otherwise return an empty array. + + + + Gets first expression found in the text. + + Object with find arguments. + Indicates whether to skip strings. + The expression if found; otherwise, returns null. + + + + Class that implements some object's properties such as location, size and visibility. + + + + + Corrects the object's size and sizing point if the size becomes negative. + + Current mouse state. + Typically you don't need to use or override this method. + This method is called by the FastReport designer to check if the object's size becomes negative + when resizing the object by the mouse. Method must correct the object's size and/or position to + make it positive, also change the sizing point if needed. + + + + Checks if the object is inside its parent. + + if true, check now independent of any conditions. + + Typically you don't need to use or override this method. + When you move an object with the mouse, it may be moved outside its parent. If so, this method + must find a new parent for the object and correct it's Left, Top and Parent + properties. If immediately parameter is false, you can optimize the method + to search for new parent only if the object's bounds are outside parent. If this parameter is + true, you must skip any optimizations and search for a parent immediately. + + + + + Draws the object. + + Paint event args. + + This method is widely used in the FastReport. It is called each time when the object needs to draw + or print itself. + In order to draw the object correctly, you should multiply the object's bounds by the scale + parameter. + cache parameter is used to optimize the drawing speed. It holds all items such as + pens, fonts, brushes, string formats that was used before. If the item with requested parameters + exists in the cache, it will be returned (instead of create new item and then dispose it). + + + + + Draw the frame around the object to indicate that it accepts the drag&drop operation. + + Paint event args. + The color of frame. + + + + Draw the selection points. + + Paint event args. + + This method draws a set of selection points returned by the method. + + + + + + + + Gets the preferred size of an object. + + Preferred size. + + This method is called by the FastReport designer when you insert a new object. + + + + + Returns a "smart tag" menu. + + + "Smart tag" is a little button that appears near the object's top-right corner when we are in the + designer and move the mouse over the object. When you click that button you will see a popup window + where you can set up some properties of the object. FastReport uses smart tags to quickly choose + the datasource (for a band) or data column (for objects). + + + + + Handles double click event in the designer. + + + This method is called when the user doubleclicks the object in the designer. Typical implementation + invokes the object's editor (calls the InvokeEditor method) and sets the designer's + Modified flag. + + + + + Handles the DragDrop event in the designer. + + Current mouse state. + + This method is called when the user drops an item from the Data Tree window into this object. + This method should copy the information from the e.DraggedObject object and set the + e.Handled flag to true to complete the drag operation. + + + + + Handles the DragOver event in the designer. + + Current mouse state. + + This method is called when the user drags an item from the Data Tree window. This method should + check that the mouse (e.X, e.Y) is inside the object, then set the e.Handled flag + to true if an item can be dragged into this object. + + + + + Handles KeyDown event in the designer. + + The designer's workspace. + Keyboard event parameters. + + This method is called when the user presses any key in the designer. Typical implementation + does nothing. + + + + + Handles MouseDown event that occurs when the user clicks the mouse in the designer. + + + This method is called when the user press the mouse button in the designer. + The standard implementation does the following: + + checks if the mouse pointer is inside the object; + add an object to the selected objects list of the designer; + sets the e.Handled flag to true. + + + Current mouse state. + + + + Handles MouseMove event that occurs when the user moves the mouse in the designer. + + + This method is called when the user moves the mouse in the designer. Typical + use of this method is to change the mouse cursor to SizeAll when it is over + an object. The standard implementation does the following: + + checks if the mouse pointer is inside the object; + changes the cursor shape (e.Cursor property); + sets the e.Handled flag to true. + + + Current mouse state. + + + + Handles MouseMove event that occurs when the user moves the mouse in the designer. + + + This method is called when the user moves the mouse in the designer. The + standard implementation does the following: + + + if mouse button is not pressed, check that mouse pointer is inside one of + the selection points returned by the + method and set the e.SizingPoint member to the corresponding sizing + point; + + if mouse button is pressed, and e.SizingPoint member is not + SizingPoint.None, resize the object. + + + Current mouse state. + + + + Handles MouseUp event that occurs when the user releases the mouse button in the designer. + + + This method is called when the user releases the mouse button in the + designer. The standard implementation does the following: + + if e.Mode is WorkspaceMode2.SelectionRect, checks if object + is inside the selection rectangle and sets e.Handled flag if so; + + checks that object is inside its parent (calls the + method). + + + + Current mouse state. + + + + Handles mouse wheel event. + + Current mouse state. + + + + Checks if given point is inside the object's bounds. + + point to check. + true if point is inside the object's bounds. + + You can override this method if your objectis not of rectangular form. + + + + + Draws the selection point. + + Paint event args. + object. + object. + Left coordinate. + Top coordinate. + + + + Gets the object's selection points. + + Array of objects. + + Selection point is a small square displayed at the object's sides when object is selected + in the designer. You can drag this square by the mouse to change the object's size. For example, + the TextObject has eight selection points to change its width and height by the mouse. + If you are developing a new component for FastReport, you may override this method + if your object has non-standard set of selection points. For example, if an object has something like + "AutoSize" property, it would be good to disable all selection points if that property is true, + to disable resizing of the object by the mouse. + + + + + Gets a value indicating that given point is inside selection point. + + point's x coordinate. + point's y coordinate. + selection point. + true if (x,y) is inside the point + + + + Gets the absolute bottom coordinate of the object. + + + + + Gets the absolute bounding rectangle of the object. + + + + + Gets the absolute left coordinate of the object. + + + + + Gets the absolute right coordinate of the object. + + + + + Gets the absolute top coordinate of the object. + + + + + Gets or sets the edges of the container to which a control is bound and determines how a control + is resized with its parent. + + + Use the Anchor property to define how a control is automatically resized as its parent control + is resized. Anchoring a control to its parent control ensures that the anchored edges remain in the + same position relative to the edges of the parent control when the parent control is resized. + You can anchor a control to one or more edges of its container. For example, if you have a band + with a TextObject whose Anchor property value is set to Top, Bottom, the TextObject is stretched to + maintain the anchored distance to the top and bottom edges of the band as the height of the band + is increased. + + + + + Gets the bottom coordinate of the object in relation to its container. + + + To change the bottom coordinate, change the and/or properties. + + + + + Gets or sets the bounding rectangle of the object. + + + Assigning a value to this property is equal to assigning values to the , + , , properties. + + + + + Gets or sets the size of client area of the object. + + + This property is used in the class. + + + + + Gets or sets which control borders are docked to its parent control and determines how a control + is resized with its parent. + + + Use the Dock property to define how a control is automatically resized as its parent control is + resized. For example, setting Dock to DockStyle.Left causes the control to align itself with the + left edges of its parent control and to resize as the parent control is resized. + A control can be docked to one edge of its parent container or can be docked to all edges and + fill the parent container. + + + + + Gets or sets a group index. + + + Group index is used to group objects in the designer (using "Group" button). When you select + any object in a group, entire group becomes selected. To reset a group, set the GroupIndex + to 0 (default value). + + + + + Gets or sets the height of the object. + + + This property value is measured in the screen pixels. Use class to + convert a value to desired units. + + The following example demonstrates how to convert between pixels and units: + TextObject text1; + // set Height to 10mm + text1.Height = Units.Millimeters * 10; + // convert a value to millimeters + MessageBox.Show("Height = " + (text1.Height / Units.Millimeters).ToString() + "mm"); + + + + + Gets or sets the left coordinate of the object in relation to its container. + + + + This property value is measured in the screen pixels. Use + class to convert a value to desired units. + + + To obtain absolute coordinate, use property. + + + The following example demonstrates how to convert between pixels and units: + TextObject text1; + // set Left to 10mm + text1.Left = Units.Millimeters * 10; + // convert a value to millimeters + MessageBox.Show("Left = " + (text1.Left / Units.Millimeters).ToString() + "mm"); + + + + + Gets the right coordinate of the object in relation to its container. + + + To change the right coordinate, change the and/or properties. + + + + + Gets or sets the Tag string for this component. + + + + + Gets or sets the top coordinate of the object in relation to its container. + + + + This property value is measured in the screen pixels. Use + class to convert a value to desired units. + + + To obtain absolute coordinate, use property. + + + The following example demonstrates how to convert between pixels and units: + TextObject text1; + // set Top to 10mm + text1.Top = Units.Millimeters * 10; + // convert a value to millimeters + MessageBox.Show("Top = " + (text1.Top / Units.Millimeters).ToString() + "mm"); + + + + + Gets or sets a value indicating whether the object is displayed in the preview window. + + + Setting this property to false will hide the object in the preview window. + + The following report script will control the Text1 visibility depending on the value of the + data column: + private void Data1_BeforePrint(object sender, EventArgs e) + { + Text1.Visible = [Orders.Shipped] == true; + } + + + + + Gets or sets a string containing expression that determines should be object displayed in the preview window. + + + + + Gets or sets a value that determines if the object can be printed on the printer. + + + Object with Printable = false is still visible in the preview window, but not on the printout. + If you want to hide an object in the preview, set the property to false. + + + + + Gets or sets a string containing expression that determines should be object printed on the printer. + + + + + Gets or sets the width of the object. + + + This property value is measured in the screen pixels. Use class to + convert a value to desired units. + + The following example demonstrates how to convert between pixels and units: + TextObject text1; + // set Width to 10mm + text1.Width = Units.Millimeters * 10; + // convert a value to millimeters + MessageBox.Show("Width = " + (text1.Width / Units.Millimeters).ToString() + "mm"); + + + + + Initializes a new instance of the class with default settings. + + + + + + + + + + + + + + Caclulates visible expression value. + + The expression to calculate. + The result of calculation. + + + + The base class for the context menu of the report component. + + + This class represents a context menu of the report component that is displayed when the object + is right-clicked in the designer. This class implements the following actions: Edit, Cut, Copy, + Paste, Delete, Bring to Front, Send to Back. + + + + + The "Name" menu item. + + + + + The "Edit" menu item. + + + + + The "Cut" menu item. + + + + + The "Copy" menu item. + + + + + The "Paste" menu item. + + + + + The "Delete" menu item. + + + + + The "BringToFront" menu item. + + + + + The "SendToBack" menu item. + + + + + Initializes a new instance of the ComponentBaseMenu class with default settings. + + The reference to a report designer. + + + + Specifies the shape of the CrossBandObject. + + + + + Specifies the vertical line shape. + + + + + Specifies the rectangle shape. + + + + + Represents an object that can be printed across several bands. + + + + + Gets or sets the object's shape. + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class with the default settings. + + + + + This class represents the Data band. + + + Use the property to connect the band to a datasource. Set the + property if you want to filter data rows. The + property can be used to sort data rows. + + + + + + + + + + + + + + + + + Invokes column editor + + + + + Gets or sets a header band. + + + + + Gets a collection of detail bands. + + + + + Gets or sets a footer band. + + + + + Gets or sets a data source. + Please note: data source have to be enabled. + + + + + Gets or sets a number of rows in the virtual data source. + + + Use this property if your data band is not connected to any data source. In this case + the virtual data source with the specified number of rows will be used. + + + + + Limits the maximum number of rows in a datasource. 0 means no limit. + + + + + Gets or sets a relation used to establish a master-detail relationship between + this band and its parent. + + + Use this property if there are several relations exist between two data sources. + If there is only one relation (in most cases it is), you can leave this property empty. + + + + + Gets the collection of sort conditions. + + + + + Gets the row filter expression. + + + This property can contain any valid boolean expression. If the expression returns false, + the corresponding data row will not be printed. + + + + + Gets the band columns. + + + + + Gets or sets a value that determines whether to print a band if all its detail rows are empty. + + + + + Gets or sets a value that determines whether to print a band if its datasource is empty. + + + + + Gets or sets a value indicating that all band rows should be printed together on one page. + + + + + Gets or sets a value indicating that the band should be printed together with all its detail rows. + + + + + Gets or sets the key column that identifies the data row. + + + This property is used when printing a hierarchic list. + To print the hierarchic list, you have to setup three properties: IdColumn, + ParentIdColumn and Indent. First two properties are used to identify the data + row and its parent; the Indent property specifies the indent that will be used to shift + the databand according to its hierarchy level. + When printing hierarchy, FastReport shifts the band to the right + (by value specified in the property), and also decreases the + width of the band by the same value. You may use the Anchor property of the + objects on a band to indicate whether the object should move with the band, or stay + on its original position, or shrink. + + + + + Gets or sets the column that identifies the parent data row. + + + This property is used when printing a hierarchic list. See description of the + property for more details. + + + + + Gets or sets the indent that will be used to shift the databand according to its hierarchy level. + + + This property is used when printing a hierarchic list. See description of the + property for more details. + + + + + Gets or sets a value indicating that the databand should collect child data rows. + + + This property determines how the master-detail report is printed. Default behavior is: + MasterData row1 + -- DetailData row1 + -- DetailData row2 + -- DetailData row3 + MasterData row2 + -- DetailData row1 + -- DetailData row2 + When you set this property to true, the master databand will collect all child data rows + under a single master data row: + MasterData row1 + -- DetailData row1 + -- DetailData row2 + -- DetailData row3 + -- DetailData row4 + -- DetailData row5 + + + + + Gets or sets a value that determines whether to reset the page numbers when this band starts print. + + + Typically you should set the property to true as well. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes the data source connected to this band. + + + + + + + + Initializes a new instance of the class. + + + + + Class represent a smart tag that is used to choose a data column. + + + + + Gets or sets the data column name. + + + + + + + + Gets a root datasource for the object currently edited. + + The DataSourceBase object if found; null otherwise. + + + + Initializes a new instance of the class with default settings. + + Report object that owns this smart tag. + + + + Represents a smart tag that is used to choose a data source. + + + + + Gets or sets a data source. + + + + + + + + Initializes a new instance of the class with default settings. + + Report object that owns this smart tag. + + + + Contains the email settings such as recipient(s) address, name, subject, message body. + + + + + + + Gets or sets the recipient(s) email addresses. + + + This property contains one or several email addresses in the following form: "john@url.com". + + + + + Gets or sets the message subject. + + + + + Gets or sets the message body. + + + + + Copies email settings from another source. + + Source to copy settings from. + + + + Resets all settings to its default values. + + + + + Initializes a new instance of the class with default settings. + + + + + This class contains some global settings that used in the FastReport.Net. + + + This component is intended for use in the Visual Studio IDE to quickly configure + FastReport global settings. To use it, drop the component on your Form and set up + its properties and events. + Here are some common actions that can be performed with this object: + + + To define own open/save dialogs that will be used in the report designer, + use the , , + , events; + + + + To pass connection string to the connection object defined in a report, + or to define own database login dialog, use the event; + + + + To adjust the connection object after it is opened, + use the event; + + + + To define own progress window, use the , + and events; + + + + To setup some common properties of the report, designer and preview, + use properties defined in this class; + + + + To set UI style of the designer and preview window, + use property. + + + + This component actually uses the static class which + contains , and + properties. You can use Config class as well. + + + + + Gets or sets the UI style of the designer and preview windows. + + + This property affects both designer and preview windows. + + + + + Indicates whether the Ribbon-style window should be used. + + + + + Occurs before displaying a progress window. + + + + + Occurs after closing a progress window. + + + + + Occurs when progress state is changed. + + + + + Occurs when database connection is about to open. + + Use this event to provide own connection string or user name/password to the connection + object that is about to open. + To provide own connection string, set the e.ConnectionString property. + In this case the new connection string will be used. + To provide own user name/password, set the e.UserName and e.Password properties. + You may ask these values in own login dialog. + This example shows how to provide username/password using own login dialog. + + private void report1_DatabaseLogin(object sender, DatabaseLoginEventArgs e) + { + using (MyLoginDialog dialog = new MyLoginDialog()) + { + if (dialog.ShowDialog() == DialogResult.OK) + { + e.UserName = dialog.UserName; + e.Password = dialog.Password; + } + } + } + + This example shows how to provide own connection string. + + private void report1_DatabaseLogin(object sender, DatabaseLoginEventArgs e) + { + e.ConnectionString = my_connection_string; + } + + + + + + Occurs after the database connection is established. + + + + + Occurs when discovering the business object's structure. + + + + + Occurs when determining the kind of business object's property. + + + + + Gets or sets the report settings. + + + + + Occurs when the designer is loaded. + + + Use this event if you want to customize some aspects of the designer, for example, + to hide some menu items. + + + This example demonstrates how to hide the "File|Select Language..." menu item. + + environmentSettings1.DesignerLoaded += new EventHandler(DesignerSettings_DesignerLoaded); + + void DesignerSettings_DesignerLoaded(object sender, EventArgs e) + { + (sender as DesignerControl).MainMenu.miFileSelectLanguage.Visible = false; + } + + + + + + Occurs when report is loaded in the designer. + + + Use this event handler to register application data in a report. + + + + + Occurs when object is inserted in the designer. + + + Use this event handler to set some object's properties when it is inserted. + + + + + Occurs when the report designer is about to show the "Open" dialog. + + Use this event to attach own "Open" dialog to the designer. In the event handler, you must + display a dialog window to allow user to choose a report file. + If dialog was executed successfully, you must return e.Cancel = false and set the + e.FileName to the selected file name. + You also need to use event to provide code that + will open the report. + + + This example shows how to attach own "Open" and "Save" dialogs to the designer. + It uses the following events: , , + , . + + private void CustomOpenDialog_Handler(object sender, OpenSaveDialogEventArgs e) + { + using (OpenFileDialog dialog = new OpenFileDialog()) + { + dialog.Filter = "Report files (*.frx)|*.frx"; + + // set e.Cancel to false if dialog was succesfully executed + e.Cancel = dialog.ShowDialog() != DialogResult.OK; + // set e.FileName to the selected file name + e.FileName = dialog.FileName; + } + } + + private void CustomSaveDialog_Handler(object sender, OpenSaveDialogEventArgs e) + { + using (SaveFileDialog dialog = new SaveFileDialog()) + { + dialog.Filter = "Report files (*.frx)|*.frx"; + // get default file name from e.FileName + dialog.FileName = e.FileName; + + // set e.Cancel to false if dialog was succesfully executed + e.Cancel = dialog.ShowDialog() != DialogResult.OK; + // set e.FileName to the selected file name + e.FileName = dialog.FileName; + } + } + + private void CustomOpenReport_Handler(object sender, OpenSaveReportEventArgs e) + { + // load the report from the given e.FileName + e.Report.Load(e.FileName); + } + + private void CustomSaveReport_Handler(object sender, OpenSaveReportEventArgs e) + { + // save the report to the given e.FileName + e.Report.Save(e.FileName); + } + + + + + + Occurs when the report designer is about to show the "Save" dialog. + + Use this event to attach own "Save" dialog to the designer. In the event handler, you must + display a dialog window to allow user to choose a report file. + If dialog was executed successfully, you must return e.Cancel = false and set the + e.FileName to the selected file name. + You also need to use event to provide code that + will save the report. + + + This example shows how to attach own "Open" and "Save" dialogs to the designer. + It uses the following events: , , + , . + + private void CustomOpenDialog_Handler(object sender, OpenSaveDialogEventArgs e) + { + using (OpenFileDialog dialog = new OpenFileDialog()) + { + dialog.Filter = "Report files (*.frx)|*.frx"; + + // set e.Cancel to false if dialog was succesfully executed + e.Cancel = dialog.ShowDialog() != DialogResult.OK; + // set e.FileName to the selected file name + e.FileName = dialog.FileName; + } + } + + private void CustomSaveDialog_Handler(object sender, OpenSaveDialogEventArgs e) + { + using (SaveFileDialog dialog = new SaveFileDialog()) + { + dialog.Filter = "Report files (*.frx)|*.frx"; + // get default file name from e.FileName + dialog.FileName = e.FileName; + + // set e.Cancel to false if dialog was succesfully executed + e.Cancel = dialog.ShowDialog() != DialogResult.OK; + // set e.FileName to the selected file name + e.FileName = dialog.FileName; + } + } + + private void CustomOpenReport_Handler(object sender, OpenSaveReportEventArgs e) + { + // load the report from the given e.FileName + e.Report.Load(e.FileName); + } + + private void CustomSaveReport_Handler(object sender, OpenSaveReportEventArgs e) + { + // save the report to the given e.FileName + e.Report.Save(e.FileName); + } + + + + + + Occurs when the report designer is about to load the report. + + This event is used together with the event. + Use this event to attach own "Open" dialog to the designer. In the event handler, you must + load the e.Report from the location specified in the e.FileName property. + For example, if you work with files: e.Report.Load(e.FileName); + + + This example shows how to attach own "Open" and "Save" dialogs to the designer. + It uses the following events: , , + , . + + private void CustomOpenDialog_Handler(object sender, OpenSaveDialogEventArgs e) + { + using (OpenFileDialog dialog = new OpenFileDialog()) + { + dialog.Filter = "Report files (*.frx)|*.frx"; + + // set e.Cancel to false if dialog was succesfully executed + e.Cancel = dialog.ShowDialog() != DialogResult.OK; + // set e.FileName to the selected file name + e.FileName = dialog.FileName; + } + } + + private void CustomSaveDialog_Handler(object sender, OpenSaveDialogEventArgs e) + { + using (SaveFileDialog dialog = new SaveFileDialog()) + { + dialog.Filter = "Report files (*.frx)|*.frx"; + // get default file name from e.FileName + dialog.FileName = e.FileName; + + // set e.Cancel to false if dialog was succesfully executed + e.Cancel = dialog.ShowDialog() != DialogResult.OK; + // set e.FileName to the selected file name + e.FileName = dialog.FileName; + } + } + + private void CustomOpenReport_Handler(object sender, OpenSaveReportEventArgs e) + { + // load the report from the given e.FileName + e.Report.Load(e.FileName); + } + + private void CustomSaveReport_Handler(object sender, OpenSaveReportEventArgs e) + { + // save the report to the given e.FileName + e.Report.Save(e.FileName); + } + + + + + + Occurs when the report designer is about to save the report. + + This event is used together with the event. + Use this event to attach own "Save" dialog to the designer. In the event handler, you must + save the e.Report to the location specified in the e.FileName property. + For example, if you work with files: e.Report.Save(e.FileName); + + + This example shows how to attach own "Open" and "Save" dialogs to the designer. + It uses the following events: , , + , . + + private void CustomOpenDialog_Handler(object sender, OpenSaveDialogEventArgs e) + { + using (OpenFileDialog dialog = new OpenFileDialog()) + { + dialog.Filter = "Report files (*.frx)|*.frx"; + + // set e.Cancel to false if dialog was succesfully executed + e.Cancel = dialog.ShowDialog() != DialogResult.OK; + // set e.FileName to the selected file name + e.FileName = dialog.FileName; + } + } + + private void CustomSaveDialog_Handler(object sender, OpenSaveDialogEventArgs e) + { + using (SaveFileDialog dialog = new SaveFileDialog()) + { + dialog.Filter = "Report files (*.frx)|*.frx"; + // get default file name from e.FileName + dialog.FileName = e.FileName; + + // set e.Cancel to false if dialog was succesfully executed + e.Cancel = dialog.ShowDialog() != DialogResult.OK; + // set e.FileName to the selected file name + e.FileName = dialog.FileName; + } + } + + private void CustomOpenReport_Handler(object sender, OpenSaveReportEventArgs e) + { + // load the report from the given e.FileName + e.Report.Load(e.FileName); + } + + private void CustomSaveReport_Handler(object sender, OpenSaveReportEventArgs e) + { + // save the report to the given e.FileName + e.Report.Save(e.FileName); + } + + + + + + Occurs when previewing a report from the designer. + + + Use this event to show own preview window. + + + + environmentSettings1.CustomPreviewReport += new EventHandler(MyPreviewHandler); + + private void MyPreviewHandler(object sender, EventArgs e) + { + Report report = sender as Report; + using (MyPreviewForm form = new MyPreviewForm()) + { + report.Preview = form.previewControl1; + report.ShowPreparedReport(); + form.ShowDialog(); + } + } + + + + + + Occurs when getting available table names from the connection. + + + Use this handler to filter the list of tables returned by the connection object. + + + This example demonstrates how to hide the table with "Table 1" name from the Data Wizard. + + environmentSettings1.FilterConnectionTables += DesignerSettings_FilterConnectionTables; + + private void DesignerSettings_FilterConnectionTables(object sender, FilterConnectionTablesEventArgs e) + { + if (e.TableName == "Table 1") + e.Skip = true; + } + + + + + + Gets or sets the designer settings. + + + + + Gets or sets the preview settings. + + + + + Gets or sets the email settings. + + + + + Represents a group header band. + + + A simple group consists of one GroupHeaderBand and the DataBand that is set + to the property. To create the nested groups, use the property. + + Only the last nested group can have data band. + + Use the property to set the group condition. The + property can be used to set the sort order for group's data rows. You can also use the Sort + property of the group's DataBand to specify additional sort. + + This example shows how to create nested groups. + + ReportPage page = report.Pages[0] as ReportPage; + + // create the main group + GroupHeaderBand mainGroup = new GroupHeaderBand(); + mainGroup.Height = Units.Millimeters * 10; + mainGroup.Name = "MainGroup"; + mainGroup.Condition = "[Orders.CustomerName]"; + // add a group to the page + page.Bands.Add(mainGroup); + + // create the nested group + GroupHeaderBand nestedGroup = new GroupHeaderBand(); + nestedGroup.Height = Units.Millimeters * 10; + nestedGroup.Name = "NestedGroup"; + nestedGroup.Condition = "[Orders.OrderDate]"; + // add it to the main group + mainGroup.NestedGroup = nestedGroup; + + // create a data band + DataBand dataBand = new DataBand(); + dataBand.Height = Units.Millimeters * 10; + dataBand.Name = "GroupData"; + dataBand.DataSource = report.GetDataSource("Orders"); + // connect the databand to the nested group + nestedGroup.Data = dataBand; + + + + + + + + + + + + + + + Gets or sets a nested group. + + + Use this property to create nested groups. + + Only the last nested group can have data band. + + + + This example demonstrates how to create a group with nested group. + + ReportPage page; + GroupHeaderBand group = new GroupHeaderBand(); + group.NestedGroup = new GroupHeaderBand(); + group.NestedGroup.Data = new DataBand(); + page.Bands.Add(group); + + + + + + Gets or sets the group data band. + + + Use this property to add a data band to a group. Note: only the last nested group can have Data band. + + + This example demonstrates how to add a data band to a group. + + ReportPage page; + GroupHeaderBand group = new GroupHeaderBand(); + group.Data = new DataBand(); + page.Bands.Add(group); + + + + + + Gets or sets a group footer. + + + + + Gets or sets a header band. + + + + + Gets or sets a footer band. + + + To access a group footer band, use the property. + + + + + Gets or sets the group condition. + + + This property can contain any valid expression. When running a report, this expression is calculated + for each data row. When the value of this condition is changed, FastReport starts a new group. + + + + + Gets or sets the sort order. + + + FastReport can sort data rows automatically using the value. + + + + + Gets or sets a value indicating that the group should be printed together on one page. + + + + + Gets or sets a value that determines whether to reset the page numbers when this group starts print. + + + Typically you should set the property to true as well. + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Base class for headers and footers which support the "Keep With Data" and "Repeat on Every Page" features. + + + + + + + + Gets or sets a value indicating that the band should be printed together with data band. + + + + + Gets or sets a value that determines whether to repeat this band on every page. + + + When band is repeated, its property is set to true. You can use + it to show any additional information on the band. To do this, + use the property which + can be set to "Rpeeated". In that case the object will be printed + only on the repeated band. + + + + + + + + + + + Represents the Text object that may display one or several text lines. + + + Specify the object's text in the Text property. + Text may contain expressions and data items, for example: "Today is [Date]". When report + is running, all expressions are calculated and replaced with actual values, so the text + would be "Today is 01.01.2008". + The symbols used to find expressions in a text are set in the + Brackets property. You also may disable expressions + using the AllowExpressions property. + To format an expression value, use the property. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets a value that indicates whether the component should draw right-to-left for RTL languages. + + + + + + + + Draws a text. + + Paint event data. + + + + + + + + + + + + + + + + + + + Calculates the object's width. + + The width, in pixels. + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + The class introduces some menu items specific to the TextObject. + + + + + Initializes a new instance of the TextObjectMenu + class with default settings. + + The reference to a report designer. + + + + Implements the object's editor. + + + + + Invokes the object's editor. + + true if object was succesfully edited. + + This method is called by FastReport when the object is doubleclicked in the designer. + + + + + Provides the "search" functionality in the preview and designer. + + + + + Finds the specified text inside the object. + + Text to find. + true to perform case-sensitive search. + true to find whole words only. + Array of character ranges that describes the occurences of text found; + null if text not found. + + + + Draws the highlight to show the text found. + + Draw event arguments. + Range of characters to highlight. + + + + Represents a line object. + + + Use the Border.Width, Border.Style and Border.Color properties to set + the line width, style and color. Set the property to true + if you want to show a diagonal line. + + + + + This property is not relevant to this class. + + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets a value indicating that the line is diagonal. + + + If this property is false, the line can be only horizontal or vertical. + + + + + Gets or sets the start cap settings. + + + + + Gets or sets the end cap settings. + + + + + Gets or sets collection of values for custom dash pattern. + + + Each element should be a non-zero positive number. + If the number is negative or zero, that number is replaced by one. + + + + + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Base class for report pages and dialog forms. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + Gets the snap size for this page. + + + + + Gets a page designer for this page type. + + The page designer. + + + + This method is called by the designer when you create a new page. + + + You may create the default page layout (add default bands, set default page size, etc). + + + + + Causes the page to refresh in the preview window. + + + Call this method when you handle object's MouseMove, MouseDown, MouseUp, MouseEnter, MouseLeave events + and want to refresh the preview window. + + If you have changed some objects on a page, the Refresh method will not save the changes. + This means when you print or export the page, you will see original (unmodified) page content. + If you want to save the changes, you have to use the method instead. + + + + + + Modifies the page content and refresh it in the preview window. + + + Call this method when you handle object's Click, MouseDown or MouseUp events + and want to modify an object and refresh the preview window. + + + + + Initializes a new instance of the class with default settings. + + + + + Represents a Picture object that can display pictures. + + + The Picture object can display the following kind of pictures: + + + picture that is embedded in the report file. Use the + property to do this; + + + picture that is stored in the database BLOb field. Use the + property to specify the name of data column you want to show; + + + picture that is stored in the local disk file. Use the + property to specify the name of the file; + + + picture that is stored in the Web. Use the + property to specify the picture's URL. + + + Use the property to specify a size mode. The + and properties can be used to restrict the image size if SizeMode + is set to AutoSize. + The property can be used to display an image with + transparent background. Use the property if you want to display + semi-transparent image. + + + + + + + + + + + Invokes the object's editor. + + true if object was edited succesfully. + + + + Gets or sets the image. + + + By default, image that you assign to this property is never disposed - you should + take care about it. If you want to dispose the image when this PictureObject is disposed, + set the property to true right after you assign an image: + + myPictureObject.Image = new Bitmap("file.bmp"); + myPictureObject.ShouldDisposeImage = true; + + + + + + Gets or sets the extension of image. + + + + + Gets or sets a value indicating that the image should be displayed in grayscale mode. + + + + + Gets or sets a hash of grayscale svg image + + + + + Gets or sets the color of the image that will be treated as transparent. + + + + + Gets or sets the transparency of the PictureObject. + + + Valid range of values is 0..1. Default value is 0. + + + + + Gets or sets a value indicating that the image should be tiled. + + + + + Gets or sets a value indicating that the image stored in the + property should be disposed when this object is disposed. + + + By default, image assigned to the property is never disposed - you should + take care about it. If you want to dispose the image when this PictureObject is disposed, + set this property to true right after you assign an image to the property. + + + + + Gets or sets a bitmap transparent image + + + + + + + + + + + + + + + + + Draws the image. + + Paint event args. + + + + Sets image data to FImageData + + + + + + + + + + + + Loads image + + + + + Disposes image + + + + + The shape of the image is set using GraphicsPath + + + + + + + + + + + + + + + + + + + Forces loading the image from a data column. + + + Call this method in the AfterData event handler to force loading an image + into the property. Normally, the image is stored internally as byte[] array + and never loaded into the Image property, to save the time. The side effect is that you + can't analyze the image properties such as width and height. If you need this, call this method + before you access the Image property. Note that this will significantly slow down the report. + + + + + Initializes a new instance of the class with default settings. + + + + + the base class for all picture objects + + + + + Draw an error image to Graphics g, when the image is designing + + + + + + + + + + + + + + + + + + + Invokes the object's editor. + + true if object was edited succesfully. + + + + Gets or sets the image rotation angle, in degrees. Possible values are 0, 90, 180, 270. + + + + + Gets or sets the data column name to get the image from. + + + + + Gets or sets a value indicating that the image should be displayed in grayscale mode. + + + + + + + + Gets or sets the path for the image to display in the PictureObject. + + + This property may contain the path to the image file as well as external URL. + + + + + Gets or sets the expression that determines the source for the image to display in the PictureObject. + + + The result of the expression should be data column name or path to the image file. + The data column name will be saved to the property. + The path will be savetd to the property. + + + + + Gets a value indicating that the image stored in the databases column + + + + + Gets a value indicating that the image stored in the separate file + + + + + Gets a value indicating that the image stored in the Web + + + + + Gets or sets the maximum height of a Picture object, in pixels. + + + Use this property to restrict the object size if the property + is set to AutoSize. + + + + + Gets or sets the maximum width of a Picture object, in pixels. + + + Use this property to restrict the object size if the property + is set to AutoSize. + + + + + Gets or sets padding within the PictureObject. + + + + + Gets or sets a value indicating whether the PictureObject should display + the error indicator if there is no image in it. + + + + + Gets or sets a value that specifies how an image is positioned within a PictureObject. + + + + + + + + Gets or sets the alignment of a image in the border. + + + + + Gets or sets a shape kind. + + + + + Return base size of image, internal use only + + + + + Return base size of image, internal use only + + + + + + + + + + + Calculates URI from ImageLocation + + + + + + + + + gets points for transform this image + + the box where to draw image + image width + image height + scale horizontal + scale vertical + offset of left + offset of top + out start of vectors + out end of frist vector + out end of second vector + + + + Loads image + + + + + Moves the point on specified angle + + + + + + + + + + + + Rotates vector on specified angle + + + + + + + + + + + Draws not tiled image + + + + + + + Reset index of image + + + + + When auto size was updated, internal use only + + + + + + + + Represents a polygon object. + + + Use the Border.Width, Border.Style and Border.Color properties to set + the line width, style and color. + + + + + + + + + Calculate GraphicsPath for draw to page + + Pen for lines + scale by width + scale by height + Always returns a non-empty path + + + + Draw polyline path to graphics + + Event arguments + + + + + + + Initializes a new instance of the class with default settings. + + + + + Represents a poly line object. + + + Use the Border.Width, Border.Style and Border.Color properties to set + the line width, style and color. + + + + + + + + + + + Add point to end of polyline and recalculate bounds after add. + Can be first point. + Deprecated, use insert point + + local x - relative to left-top point + local y - relative to left-top point + + + + Add point to start of polyline and recalculate bounds after add + Can be first point + Deprecated, use insert point + + local x - relative to left-top point + local y - relative to left-top point + + + + + + + + + + Replace points with star + + Minimum value is 3 + + + + + + + + + + + + + + + + + + + Insert point to desired place of polyline + Recalculate bounds after insert + + Index of place from zero to count + local x - relative to left-top point + local y - relative to left-top point + + + + Insert point to near line + Recalculate bounds after insert + + local x - relative to left-top point + local y - relative to left-top point + depricated + Index of inserted point + + + + + + + + + + + + + + + + Delete point from polyline by index + Recalculate bounds after remove + + Index of point in polyline + + + + + + + Delete point from polyline by index. + Recalculate bounds. + + Index of point in polyline + + + + + + + + + + Returns best new point position based on mouse + + + + + + do not set this value, internal use only + + + + + Gets or sets collection of values for custom dash pattern. + + + Each element should be a non-zero positive number. + If the number is negative or zero, that number is replaced by one. + + + + + Return points collection. + You can modify the collection for change this object. + + + + + Returns origin of coordinates relative to the top left corner + + + + + Returns origin of coordinates relative to the top left corner + + + + + Return points array of line + deprecated + + + + + Return point types array. 0 - Start of line, 1 - Keep on line + deprecated + + + + + Initializes a new instance of the class with default settings. + + + + + + + + + + + + + + Calculate GraphicsPath for draw to page + + Pen for lines + Left boundary + Top boundary + Right boundary + Bottom boundary + scale by width + scale by height + Always returns a non-empty path + + + + Recalculate position and size of element + + + + + + + + Add point to end of polyline, need to recalculate bounds after add + First point must have zero coordinate and zero type. + Recalculate bounds. + Method is slow do not use this. + + local x - relative to left-top point + local y - relative to left-top point + depreceted + + + + Delete point from polyline by index. + Recalculate bounds. + Method is slow do not use this. + + Index of point in polyline + + + + Draw polyline path to graphics + + Event arguments + + + + Insert point to desired place of polyline + recalculateBounds(); + Method is slow do not use this + + Index of place from zero to count + local x - relative to left-top point + local y - relative to left-top point + deprecated + + + + Represent a point for polygon object + + + + + Specifies the set of buttons available in the preview. + + + + + No buttons visible. + + + + + The "Print" button is visible. + + + + + The "Open" button is visible. + + + + + The "Save" button is visible. + + + + + The "Email" button is visible. + + + + + The "Find" button is visible. + + + + + The zoom buttons are visible. + + + + + The "Outline" button is visible. + + + + + The "Page setup" button is visible. + + + + + The "Edit" button is visible. + + + + + The "Watermark" button is visible. + + + + + The page navigator buttons are visible. + + + + + The "Close" button is visible. + + + + + The "Design" button is visible. + + + + + The "Copy Page" button is visible. + + + + + The "Delete Page" button is visible. + + + + + The "About" button is visible. + + + + + All buttons are visible. + + + + + Specifies the set of export buttons available in the preview. + + + + + No exports visible. + + + + + The "Prepared" button is visible. + + + + + The "PDFExport" button is visible. + + + + + The "RTFExport" button is visible. + + + + + The "HTMLExport" button is visible. + + + + + The "MHTExport" button is visible. + + + + + The "XMLExport" export button is visible. + + + + + The "Excel2007Export" button is visible. + + + + + The "Excel2003Document" button is visible. + + + + + The "Word2007Export" button is visible. + + + + + The "PowerPoint2007Export" button is visible. + + + + + The "ODSExport" button is visible. + + + + + The "ODTExport" button is visible. + + + + + The "XPSExport" export button is visible. + + + + + The "CSVExport" button is visible. + + + + + The "DBFExport" button is visible. + + + + + The "TextExport" button is visible. + + + + + The "ZplExport" button is visible. + + + + + The "ImageExport" button is visible. + + + + + The "XAMLExport" button is visible. + + + + + The "SVGExport" button is visible. + + + + + The "PPMLExport" button is visible. + + + + + The "PSExport" button is visible. + + + + + The "JsonExport" button is visible. + + + + + The "LaTeXExport" button is visible. + + + + + The "HpglExport" button is visible. + + + + + The "DxfExport" button is visible. + + + + + The All export buttons is visible. + + + + + Specifies the set of cloud exports available in the preview. + + + + + No items visible. + + + + + The "Box" button is visible. + + + + + The "Dropbox" button is visible. + + + + + The "Ftp" button is visible. + + + + + The "GoogleDrive" button is visible. + + + + + The "SkyDrive" button is visible. + + + + + The "S3" button is visible. + + + + + The All export in clouds buttons is visible. + + + + + Specifies the set of export by messenger buttons available in the preview. + + + + + No exports by messengers visible. + + + + + The "Xmpp" button is visible. + + + + + The All export by messengers buttons is visible. + + + + + Contains some settings of the preview window. + + + + + Occurs when the standard preview window opened. + + + You may use this event to change the standard preview window, for example, add an own button to it. + The sender parameter in this event is the PreviewControl. + + + + + Gets or sets a set of buttons that will be visible in the preview's toolbar. + + + Here is an example how you can disable the "Print" and "EMail" buttons: + + Config.PreviewSettings.Buttons = PreviewButtons.Open | + PreviewButtons.Save | + PreviewButtons.Find | + PreviewButtons.Zoom | + PreviewButtons.Outline | + PreviewButtons.PageSetup | + PreviewButtons.Edit | + PreviewButtons.Watermark | + PreviewButtons.Navigator | + PreviewButtons.Close; + + + + + + Specifies the set of exports that will be available in the preview's "save" menu. + + + + + Specifies the set of exports in clouds that will be available in the preview's "save" menu. + + + + + Specifies the set of exports by messengers that will be available in the preview's "save" menu. + + + + + Gets or sets the number of prepared pages that can be stored in the memory cache during preview. + + + Decrease this value if your prepared report contains a lot of pictures. This will + save the RAM memory. + + + + + Gets or sets a value indicating whether the preview window is displayed in the Windows taskbar. + + + + + Gets or sets a value indicating whether the preview window should be displayed as a topmost form. + + + + + Gets or sets the icon for the preview window. + + + + + Gets or sets the text for the preview window. + + + If no text is set, the default text "Preview" will be used. + + + + + Gets or sets a value indicating whether the fast scrolling method should be used. + + + If you enable this property, the gradient background will be disabled. + + + + + Enables or disables the "Print to file" feature in the print dialog. + + + + + Gets or sets the initial directory that is displayed by a save file dialog. + + + + + Initializes a new instance of the PreviewSettings class with default settings. + + + + + Specifies the report printing mode. + + + + + Specifies the default printing mode. One report page produces + one printed paper sheet of the same size. + + + + + Specifies the split mode. Big report page produces several smaller paper sheets. + Use this mode to print A3 report on A4 printer. + + + + + Specifies the scale mode. One or several report pages produce one bigger paper sheet. + Use this mode to print A5 report on A4 printer. + + + + + Specifies the number of report pages printed on one paper sheet. + + + + + Specifies one report page per sheet. + + + + + Specifies two report pages per sheet. + + + + + Specifies four report pages per sheet. + + + + + Specifies eight report pages per sheet. + + + + + Specifies the pages to print. + + + + + Print all report pages. + + + + + Print odd pages only. + + + + + Print even pages only. + + + + + This class contains the printer settings. + It is used in the property. + + + Typical use of this class is to setup a printer properties without using the "Print" + dialog. In this case, setup necessary properties and turn off the dialog via the + property. + + + + + Gets or sets the printer name. + + + + + Gets or sets a value indicating that the printer name should be saved in a report file. + + + If this property is set to true, the printer name will be saved in a report file. + Next time when you open the report, the printer will be automatically selected. + + + + + Gets or sets a value indicating that the printing output should be send + to a file instead of a printer. + + + Also set the property. + + + + + The name of a file to print the report to. + + + This property is used if property is true. + + + + + Gets or sets a value specifies the page range to print. + + + + + Gets or sets the page number(s) to print. + + + This property is used if property is set to PageNumbers. + You can specify the page numbers, separated by commas, or the page ranges. + For example: "1,3,5-12". + + + + + Gets or sets the number of copies to print. + + + + + Gets or sets a value indicating whether the printed document should be collated. + + + + + Gets or sets a value specifies the pages to print. + + + + + Gets or sets a value determines whether to print pages in reverse order. + + + + + Gets or sets the duplex mode. + + + + + Gets or sets the paper source. + + + This property corresponds to the RAW source number. Default value is 7 which + corresponds to DMBIN_AUTO. + + + + + Gets or sets the print mode. + + + See the enumeration for details. If you use + the mode other than Default, you must specify the sheet size in the + , properties. + + + + + Gets or sets the width of the paper sheet to print on. + + + This property is used if the property is not Default. + Specify the paper width in millimeters. + + + + + Gets or sets the height of the paper sheet to print on. + + + This property is used if the property is not Default. + Specify the paper height in millimeters. + + + + + Gets or sets the raw index of a paper size. + + + + + Gets or sets the number of pages per printed sheet. + + + This property is used if the property is set to Scale. + + + + + Gets or sets an array of printed copy names, such as "Original", "Copy", etc. + + + + + Specifies whether to display the "Print" dialog. + + + + + + + + Assigns values from another source. + + Source to assign from. + + + + Resets all settings to its default values. + + + + + Initializes a new instance of the class with default settings. + + + + + The style of the report object markers. + + + + + Rectangle marker. + + + + + Small markers at the object's corners. + + + + + Base class for all report objects. + + + + + + + + + + + + + + + + + Assigns a format from another, similar object. + + Source object to assign a format from. + + + + + + + + + + Draws the object's markers. + + Draw event arguments. + + + + Draws the object's markers. + + Draw event arguments. + Marker style + + + + Draws the intersection indicator. + + Draw event arguments. + + + + + + + + + + + + + This event occurs when the user moves the mouse over the object in the preview window. + + + + + This event occurs when the user releases the mouse button in the preview window. + + + + + This event occurs when the user clicks the mouse button in the preview window. + + + + + This event occurs when the mouse enters the object's bounds in the preview window. + + + + + This event occurs when the mouse leaves the object's bounds in the preview window. + + + + + Copies event handlers from another similar object. + + The object to copy handlers from. + + + + This method fires the MouseMove event and the script code connected to the MouseMoveEvent. + + Event data. + + + + This method fires the MouseUp event and the script code connected to the MouseUpEvent. + + Event data. + + + + This method fires the MouseDown event and the script code connected to the MouseDownEvent. + + Event data. + + + + This method fires the MouseEnter event and the script code connected to the MouseEnterEvent. + + Event data. + + + + This method fires the MouseLeave event and the script code connected to the MouseLeaveEvent. + + Event data. + + + + This method is fired when the user scrolls the mouse in the preview window. + + Event data. + + + + This event occurs before the object is added to the preview pages. + + + + + This event occurs after the object was added to the preview pages. + + + + + This event occurs after the object was filled with data. + + + + + This event occurs when the user clicks the object in the preview window. + + + + + Gets or sets a value that determines if the object can be exported. + + + + + Gets or sets a string containing expression that determines should be object exported. + + + + + Gets or sets an object's border. + + + + + Gets or sets an object's fill. + + + The fill can be one of the following types: , , + , . + To set the solid fill color, use the simpler property. + + This example shows how to set the new fill and change its properties: + + textObject1.Fill = new SolidFill(Color.Green); + (textObject1.Fill as SolidFill).Color = Color.Red; + + + + + + Gets or sets the fill color in a simple manner. + + + This property can be used in a report script to change the fill color of the object. It is + equivalent to: reportComponent1.Fill = new SolidFill(color); + + + + + Gets or sets a bookmark expression. + + + This property can contain any valid expression that returns a bookmark name. This can be, for example, + a data column. To navigate to a bookmark, you have to use the property. + + + + + Gets or sets a hyperlink. + + + The hyperlink is used to define clickable objects in the preview. + When you click such object, you may navigate to the external url, the page number, + the bookmark defined by other report object, or display the external report. + Set the Kind property of the hyperlink to select appropriate behavior. + Usually you should set the Expression property of the hyperlink to + any valid expression that will be calculated when this object is about to print. + The value of an expression will be used for navigation. + If you want to navigate to + something fixed (URL or page number, for example) you also may set the Value + property instead of Expression. + + + + + Determines if the object can grow. + + + This property is applicable to the bands or text objects that can contain several text lines. + If the property is set to true, object will grow to display all the information that it contains. + + + + + Determines if the object can shrink. + + + This property is applicable to the bands or text objects that can contain several text lines. + If the property is set to true, object can shrink to remove the unused space. + + + + + Determines if the object must grow to the band's bottom side. + + + If the property is set to true, object grows to the bottom side of its parent. This is useful if + you have several objects on a band, and some of them can grow or shrink. + + + + + Gets or sets a shift mode of the object. + + + See enumeration for details. + + + + + Gets or sets the style name. + + + Style is a set of common properties such as border, fill, font, text color. The Report + has a set of styles in the property. + + + + + Gets or sets a style name that will be applied to even band rows. + + + Style with this name must exist in the collection. + + + + + Gets or sets a style name that will be applied to this object when the mouse pointer is over it. + + + Style with this name must exist in the collection. + + + + + Gets or sets a value that determines which properties of the even style to use. + + + Usually you will need only the Fill property of the even style to be applied. If you want to + apply all style settings, set this property to StylePriority.UseAll. + + + + + Gets or sets a value that determines whether to insert the hard page break before processing this object. + + + + + Gets or sets a value that determines where to print the object. + + + See the enumeration for details. + + + + + Gets or sets a script event name that will be fired before the object will be printed in the preview page. + + + + + Gets or sets a script event name that will be fired after the object was printed in the preview page. + + + + + Gets or sets a script event name that will be fired after the object was filled with data. + + + + + Gets or sets a script event name that will be fired when the user click the object in the preview window. + + + + + Determines if the object has custom border and use only Border.Width, Border.Style and + Border.Color properties. + + + This flag is used to disable some toolbar buttons when such object is selected. Applicable to the + ShapeObject and LineObject. + + + + + Determines if the object uses the Border. + + + This flag is used to disable some toolbar buttons when such object is selected. + + + + + Determines if the object uses the fill. + + + This flag is used to disable some toolbar buttons when such object is selected. + + + + + Gets or sets a value indicates that object should not be added to the preview. + + + + + Determines if serializing the Style property is needed. + + + The Style property must be serialized last. Some ancestor classes may turn off the standard Style + serialization and serialize it by themselves. + + + + + Determines if an object can provide the hyperlink value automatically. + + + This flag is used in complex objects such as Matrix or Chart. These objects can provide + a hyperlink value automatically, depending on where you click. + + + + + Gets an object's parent band. + + + + + Gets an object's parent data band. + + + + + Gets or sets an object's cursor shape. + + + This property is used in the preview mode. + + + + + Gets or sets a script event name that will be fired when the user + moves the mouse over the object in the preview window. + + + + + Gets or sets a script event name that will be fired when the user + releases the mouse button in the preview window. + + + + + Gets or sets a script event name that will be fired when the user + clicks the mouse button in the preview window. + + + + + Gets or sets a script event name that will be fired when the + mouse enters the object's bounds in the preview window. + + + + + Gets or sets a script event name that will be fired when the + mouse leaves the object's bounds in the preview window. + + + + + + + + Applies the style settings. + + Style to apply. + + + + Saves the current style. + + + + + Restores the current style. + + + + + Draws the object's background. + + Draw event arguments. + + + + + + + Determines if the object is visible on current drawing surface. + + Draw event arguments. + + + + Validate this object. + + List of errors + + + + + + + + + + + + + This method fires the Click event and the script code connected to the ClickEvent. + + Event data. + + + + + + + Checks if there are any listeners to the Click event. + + + + + Resets the data from the previous report run. + + + + + Initializes the object before running a report. + + + This method is used by the report engine, do not call it directly. + + + + + Performs a finalization after the report is finished. + + + This method is used by the report engine, do not call it directly. + + + + + Saves the object's state before printing it. + + + This method is called by the report engine before processing the object. + Do not call it directly. You may override it if you are developing a new FastReport component. + In this method you should save any object properties that may be changed during the object printing. + The standard implementation saves the object's bounds, visibility, bookmark and hyperlink. + + + + + Restores the object's state after printing it. + + + This method is called by the report engine after processing the object. + Do not call it directly. You may override it if you are developing a new FastReport component. + In this method you should restore the object properties that were saved by the method. + + + + + Calculates the object's height. + + Actual object's height, in pixels. + + Applicable to objects that contain several text lines, such as TextObject. Returns the height needed + to display all the text lines. + + + + + Gets the data from a datasource that the object is connected to. + + + This method is called by the report engine before processing the object. + Do not call it directly. You may override it if you are developing a new FastReport component. + In this method you should get the data from a datasource that the object is connected to. + + + + + + + + This method fires the BeforePrint event and the script code connected to the BeforePrintEvent. + + Event data. + + + + This method fires the AfterPrint event and the script code connected to the AfterPrintEvent. + + Event data. + + + + This method fires the AfterData event and the script code connected to the AfterDataEvent. + + Event data. + + + + Initializes a new instance of the class with default settings. + + + + + The class introduces some menu items specific + to the ReportComponentBase. + + + + + The "Can Grow" menu item. + + + + + The "Can Shrink" menu item. + + + + + The "Grow to Bottom" menu item. + + + + + The "Hyperlink" menu item. + + + + + The "Style" menu item. + + + + + Initializes a new instance of the ReportComponentBaseMenu + class with default settings. + + The reference to a report designer. + + + + Represents a report page. + + + To get/set a paper size and orientation, use the , + and properties. Note that paper size is measured in millimeters. + Report page can contain one or several bands with report objects. Use the , + , , , + , , properties + to get/set the page bands. The property holds the list of data bands or groups. + Thus you may add several databands to this property to create master-master reports, for example. + + Report page can contain bands only. You cannot place report objects such as TextObject on a page. + + + + This example shows how to create a page with one ReportTitleBand and DataBand bands and add + it to the report. + + ReportPage page = new ReportPage(); + // set the paper in millimeters + page.PaperWidth = 210; + page.PaperHeight = 297; + // create report title + page.ReportTitle = new ReportTitleBand(); + page.ReportTitle.Name = "ReportTitle1"; + page.ReportTitle.Height = Units.Millimeters * 10; + // create data band + DataBand data = new DataBand(); + data.Name = "Data1"; + data.Height = Units.Millimeters * 10; + // add data band to the page + page.Bands.Add(data); + // add page to the report + report.Pages.Add(page); + + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + + + + Gets a value indicating that imperial units (inches, hundreths of inches) are used. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Invokes the object's editor. + + + + + This event occurs when the report engine starts this page. + + + + + This event occurs when the report engine finished this page. + + + + + This event occurs when the report engine is about to print databands in this page. + + + + + Gets or sets a width of the paper, in millimeters. + + + + + Gets or sets the page name on export + + + + + Gets or sets a height of the paper, in millimeters. + + + + + Gets or sets the raw index of a paper size. + + + This property stores the RawKind value of a selected papersize. It is used to distinguish + between several papers with the same size (for ex. "A3" and "A3 with no margins") used in some + printer drivers. + It is not obligatory to set this property. FastReport will select the + necessary paper using the PaperWidth and PaperHeight values. + + + + + Gets or sets a value indicating whether the page has unlimited height. + + + + + Gets or sets the value indicating whether the unlimited page should be printed on roll paper. + + + + + Gets or sets a value indicating whether the page has unlimited width. + + + + + Get or set the current height of unlimited page. + + + + + Get or set the current width of unlimited page. + + + + + Gets the current page height in pixels. + + + + + Gets the current page width in pixels. + + + + + Gets or sets a value indicating that page should be in landscape orientation. + + + When you change this property, it will automatically swap paper width and height, as well as paper margins. + + + + + Gets or sets the left page margin, in millimeters. + + + + + Gets or sets the top page margin, in millimeters. + + + + + Gets or sets the right page margin, in millimeters. + + + + + Gets or sets the bottom page margin, in millimeters. + + + + + Gets or sets a value indicating that even pages should swap its left and right margins when + previewed or printed. + + + + + Gets the page columns settings. + + + + + Gets or sets the page border that will be printed inside the page printing area. + + + + + Gets or sets the page background fill. + + + + + Gets or sets the page watermark. + + + To enabled watermark, set its Enabled property to true. + + + + + Gets or sets a value indicating that ReportTitle band should be printed before the + PageHeader band. + + + + + Gets or sets an outline expression. + + + For more information, see property. + + + + + Gets or sets a value indicating whether to start to print this page on a free space of the previous page. + + + This property can be used if you have two or more pages in the report template. + + + + + Gets or sets a value indicating that FastReport engine must reset page numbers before printing this page. + + + This property can be used if you have two or more pages in the report template. + + + + + Gets or sets a value indicating whether the page has extra width in the report designer. + + + This property may be useful if you work with such objects as Matrix and Table. + + + + + Gets or sets a value indicating whether this page will start on an odd page only. + + + This property is useful to print booklet-type reports. Setting this property to true + means that this page will start to print on an odd page only. If necessary, an empty page + will be added to the prepared report before this page will be printed. + + + + + Uses this page as a back page for previously printed pages. + + + + + Gets or sets a report title band. + + + + + Gets or sets a report summary band. + + + + + Gets or sets a page header band. + + + + + Gets or sets a page footer band. + + + + + Gets or sets a column header band. + + + + + Gets or sets a column footer band. + + + + + Gets or sets an overlay band. + + + + + Gets the collection of data bands or group header bands. + + + The Bands property holds the list of data bands or group headers. + Thus you may add several databands to this property to create master-master reports, for example. + + + + + Gets or sets the page guidelines. + + + This property hold all vertical guidelines. The horizontal guidelines are owned by the bands (see + property). + + + + + Gets or sets the reference to a parent SubreportObject that owns this page. + + + This property is null for regular report pages. See the for details. + + + + + Gets or sets a script event name that will be fired when the report engine starts this page. + + + + + Gets or sets a script event name that will be fired when the report engine finished this page. + + + + + Gets or sets a script event name that will be fired when the report engine is about + to print databands in this page. + + + + + Gets or sets the paper source for the first printed page. + + + + This property represents the paper source (printer tray) that will be used when printing + the first page. To set the source for other pages, use + and properties. + + + Note: This property uses the raw number of the paper source. + + + + + + Gets or sets the paper source for all printed pages except the first one. + + + + This property represents the paper source (printer tray) that will be used when printing + all pages except the first one and the last one. To set source for first and last pages, use + and properties. + + + Note: This property uses the raw number of the paper source. + + + + + + Gets or sets the paper source for the last printed page. + + + + This property represents the paper source (printer tray) that will be used when printing + the last page. To set the source for other pages, use + and properties. + + + Note: This property uses the raw number of the paper source. + + + + + + Gets or sets the printer duplex mode that will be used when printing this page. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This method fires the StartPage event and the script code connected to the StartPageEvent. + + + + + This method fires the FinishPage event and the script code connected to the FinishPageEvent. + + + + + This method fires the ManualBuild event and the script code connected to the ManualBuildEvent. + + + + + Updates width of all bands on this page according to page's paper settings. + + + + + Initializes a new instance of the class with default settings. + + + + + Represents a report summary band. + + + + + This property is not relevant to this class. + + + + + + + + Holds the list of objects currently selected in the designer. + + + This class is used by the "Alignment" toolbar. Use methods of this class to perform some + operations on the selected objects. + Note: after calling any method in this class, call the + Designer.SetModified method to reflect changes. + Note: this list contains only objects of type. If you want to access all + selected objects, use the property. + + + + + Gets the first selected object. + + + + + Gets the number of selected objects. + + + + + Aligns left edges of the selected objects. + + + + + Aligns right edges of the selected objects. + + + + + Aligns centers of the selected objects. + + + + + Aligns top edges of the selected objects. + + + + + Aligns bottom edges of the selected objects. + + + + + Aligns middles of the selected objects. + + + + + Makes the selected objects the same width as the first object. + + + + + Makes the selected objects the same height as the first object. + + + + + Makes the selected objects the same size as the first object. + + + + + Centers the selected objects horizontally. + + + + + Centers the selected objects vertically. + + + + + Aligns the selected objects to the grid. + + + + + Adjusts the size of selected objects to the grid. + + + + + Spaces the selected objects horizontally. + + + + + Increases horizontal spacing between the selected objects. + + + + + Decreases horizontal spacing between the selected objects. + + + + + Removes horizontal spacing between the selected objects. + + + + + Spaces the selected objects vertically. + + + + + Increases vertical spacing between the selected objects. + + + + + Decreases vertical spacing between the selected objects. + + + + + Removes vertical spacing between the selected objects. + + + + + Holds the list of selected objects of type. Used by the + . + + + + + Gets a value indicating that report page is selected. + + + + + Gets a value indicating that report is selected. + + + + + Holds the list of objects currently selected in the designer. + + + This class is used by the "Border and Fill" toolbar. Use methods of this class to perform some + operations on the selected objects. + Note: after calling any method in this class, call the + Designer.SetModified method to reflect changes. + Note: this list contains only objects of type. + If you want to access all selected objects, use the property. + + + + + Gets the first selected object. + + + + + Gets the number of selected objects. + + + + + Gets a value indicating whether the operations are enabled. + + + + + Gets a value indicating whether the object with simple border is selected. + + + When the object has a simple border, you cannot change individual border lines. + Example of such an object is the "Shape" and "Line" objects. + + + + + Gets a value indicating whether the border operations are enabled. + + + + + Gets a value indicating whether the fill operations are enabled. + + + + + Sets the solid fill color for the selected objects. + + Fill color. + + + + Sets the fill for the selected objects. + + Fill. + + + + Sets the style for the selected objects. + + Style name. + + + + Sets the hyperlink for the selected objects. + + Hyperlink. + Indicates whether to modify the object's appearance. + Indicates whether it is necessary to change designer's modified state. + + + + Sets the CanGrow flag for the selected objects. + + Flag value. + + + + Sets the CanShrink flag for the selected objects. + + Flag value. + + + + Sets the GrowToBottom flag for the selected objects. + + Flag value. + + + + Toggles the specified border line for the selected objects. + + Border line. + Toggle value. + + + + Sets the border color for the selected objects. + + Border color. + + + + Sets the border width for the selected objects. + + Border width. + + + + Sets the border style for the selected objects. + + Border style. + + + + Sets the border for the selected objects. + + Border. + + + + Invokes the fill editor for the selected objects. + + true if editor was closed by the OK button. + + + + Invokes the border editor for the selected objects. + + true if editor was closed by the OK button. + + + + Invokes the hyperlink editor for the selected objects. + + true if editor was closed by the OK button. + + + + Holds the list of objects currently selected in the designer. + + + This class is used by the "Text" toolbar. Use methods of this class to perform some + operations on the selected objects. + Note: after calling any method in this class, call the + Designer.SetModified method to reflect changes. + Note: this list contains only objects of type. If you want to access all + selected objects, use the property. + + + + + Gets the first selected object. + + + + + Gets the number of selected objects. + + + + + Gets a value indicating whether the operations are enabled. + + + + + Sets the font name for the selected objects. + + Font name. + + + + Sets the font size for the selected objects. + + Font size. + + + + Toggles the specified font style for the selected objects. + + Font style. + Toggle value. + + + + Sets the horizontal text alignment for tthe selected objects. + + Alignment to set. + + + + Sets the vertical text alignment for tthe selected objects. + + Alignment to set. + + + + Sets the text color for the selected objects. + + Text color. + + + + Sets the angle for the selected objects. + + Angle to set. + + + + Sets the AutoWidth property value for the selected objects. + + Value to set. + + + + Sets the WordWrap property value for the selected objects. + + Value to set. + + + + Sets the highlight conditions for the selected objects. + + Highlight conditions. + + + + Clears the text of the selected objects. + + + + + Invokes the highlight editor for the selected objects. + + true if editor was closed with the OK button. + + + + Represents a shape object. + + + Use the property to specify a shape. To set the width, style and color of the + shape's border, use the Border.Width, Border.Style and Border.Color properties. + + + + + + + + + + + + + + Gets or sets collection of values for custom dash pattern. + + + Each element should be a non-zero positive number. + If the number is negative or zero, that number is replaced by one. + + + + + Gets or sets a shape kind. + + + + + Gets or sets a shape curvature if is RoundRectangle. + + + 0 value means automatic curvature. + + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + The base class for smart tags. + + + + "Smart tag" is a little button that appears near the object's top-right corner when we are in the + designer and move the mouse over the object. When you click that button you will see a popup window + where you can set up some properties of the object. FastReport uses smart tags to quickly choose + the datasource (for a band) or data column (for objects). + + + Smart tag is internally a ContextMenuStrip. + + + + + + Gets the underlying context menu. + + + + + Gets the report object that invokes this smart tag. + + + + + Gets the report designer. + + + + + Called when the menu item is clicked. + + + Override this method to define a reaction on the menu item click. + + + + + Creates the smart tag menu items. + + + Override this method to create the smart tag menu. + + + + + Displays a smart tag at the specified location. + + + Do not call this method directly. It is called automatically when click on smart tag button. + + Control. + Location. + + + + Initializes a new instance of the class with default settings. + + Report object that owns this smart tag. + + + + Represents the base class for the report style or the highlight condition. + + + + + Gets or sets a value determines that the border must be applied. + + + + + Gets or sets a value determines that the fill must be applied. + + + + + Gets or sets a value determines that the font must be applied. + + + + + Gets or sets a value determines that the text fill must be applied. + + + + + Gets or sets a border. + + + + + Gets or sets a fill. + + + + + Gets or sets a font. + + + + + Gets or sets a text fill. + + + + + Initializes a new instance of the class with default settings. + + + + + Assigns values from another source. + + Source to assign from. + + + + Deserializes the style. + + Reader object. + + This method is for internal use only. + + + + + Serializes the style. + + Writer object. + + This method is for internal use only. + + + + + Represents a subreport object. + + + To create a subreport in code, you should create the report page first and + connect it to the subreport using the property. + + The following example shows how to create a subreport object in code. + + // create the main report page + ReportPage reportPage = new ReportPage(); + reportPage.Name = "Page1"; + report.Pages.Add(reportPage); + // create report title band + reportPage.ReportTitle = new ReportTitleBand(); + reportPage.ReportTitle.Name = "ReportTitle1"; + reportPage.ReportTitle.Height = Units.Millimeters * 10; + // add subreport on it + SubreportObject subreport = new SubreportObject(); + subreport.Name = "Subreport1"; + subreport.Bounds = new RectangleF(0, 0, Units.Millimeters * 25, Units.Millimeters * 5); + reportPage.ReportTitle.Objects.Add(subreport); + // create subreport page + ReportPage subreportPage = new ReportPage(); + subreportPage.Name = "SubreportPage1"; + report.Pages.Add(subreportPage); + // connect the subreport to the subreport page + subreport.ReportPage = subreportPage; + + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + + + + + + + + + + + + + + + + + + + Gets or sets a report page that contains the subreport bands and objects. + + + + + Gets or sets a value indicating that subreport must print its objects on a parent band to which it belongs. + + + Default behavior of the subreport is to print subreport objects they own separate bands. + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Represents the Text object that may display one or several text lines. + + + Specify the object's text in the Text property. + Text may contain expressions and data items, for example: "Today is [Date]". When report + is running, all expressions are calculated and replaced with actual values, so the text + would be "Today is 01.01.2008". + The symbols used to find expressions in a text are set in the + Brackets property. You also may disable expressions + using the AllowExpressions property. + To format an expression value, use the property. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets a paragraph format for a new html rendering type, not for others rendering + + + + + Gets or sets a value that determines if the text object should handle its width automatically. + + + + + Gets or sets a value that indicates whether the font size should shrink to + display the longest text line without word wrap. + + + To limit the minimum size, use the property. + + + + + Gets or sets the minimum size of font (or minimum width ratio) if the + mode is on. + + + This property determines the minimum font size (in case the property is set to + FontSize), or the minimum font width ratio (if AutoShrink is set to FontWidth). + The default value is 0, that means no limits. + + + + + Gets or sets the horizontal alignment of a text in the TextObject object. + + + + + Gets or sets the vertical alignment of a text in the TextObject object. + + + + + Gets or sets the text angle, in degrees. + + + + + Gets or sets a value that indicates whether the component should draw right-to-left for RTL languages. + + + + + Gets or sets a value that indicates if lines are automatically word-wrapped. + + + + + Gets or sets a value that determines if the text object will underline each text line. + + + + + Gets or sets the font settings for this object. + + + + + Gets or sets a collection of TAB symbol positions, in pixels. Negative values will not affect this property. + + Use collection methods to add or remove TAB positions. + + + + Gets or sets the fill color used to draw a text. + + + Default fill is . You may specify other fill types, for example: + + text1.TextFill = new HatchFill(Color.Black, Color.White, HatchStyle.Cross); + + Use the property to set the solid text color. + + + + + Gets or sets the text outline. + + + + + Gets or sets the text color in a simple manner. + + + This property can be used in a report script to change the text color of the object. It is + equivalent to: textObject1.TextFill = new SolidFill(color); + + + + + Gets or sets the string trimming options. + + + + + Gets or sets the width ratio of the font. + + + Default value is 1. To make a font wider, set a value grether than 1; to make a font narrower, + set a value less than 1. + + + + + Gets or sets the height of single text line, in pixels. + + + + + Gets or sets the offset of the first TAB symbol. Negative value will not affect this property. + + + + + Gets or sets the width of TAB symbol, in pixels. Negative values will not affect this property. + + + + + Gets or sets a value that indicates if text should be clipped inside the object's bounds. + + + + + Gets the collection of conditional highlight attributes. + + + Conditional highlight is used to change the visual appearance of the Text object + depending on some condition(s). For example, you may highlight negative values displayed by + the Text object with red color. To do this, add the highlight condition: + + TextObject text1; + HighlightCondition highlight = new HighlightCondition(); + highlight.Expression = "Value < 0"; + highlight.Fill = new SolidFill(Color.Red); + highlight.ApplyFill = true; + text1.Highlight.Add(highlight); + + + + + + Gets or sets a value that indicates if the text object should display its contents similar to the printout. + + + + + Forces justify for the last text line. + + + + + Allows handling html tags in the text. + + + The following html tags can be used in the object's text: <b>, <i>, <u>, + <strike>, <sub>, <sup>, </b>, </i>, </u>, + </strike>, </sub>, </sup>, + <font color=&...&>, </font>. Font size cannot + be changed due to limitations in the rendering engine. + + + + + Indicates handling html tags in the text. + + To set the value use the TextRenderer property. + + + + The type of text render + + /// + The following html tags can be used in the object's text: <b>, <i>, <u>, + <strike>, <sub>, <sup>, </b>, </i>, </u>, + </strike>, </sub>, </sup>, + <font color=&...&>, </font>. Font size cannot + be changed due to limitations in the rendering engine. + + + + + Gets or sets the paragraph offset, in pixels. For HtmlParagraph use ParagraphFormat.FirstLineIndent. + + + + + Cache for inline images + + + + + Gets or sets a value indicating whether the text should be merged with other nearby text objects. + + + + + + + + Returns StringFormat object. + + Report graphic cache. + StringFormat flags. + StringFormat object. + + + + + + + Returns an instance of html text renderer. + + Scale ratio. + Font scale ratio. + The html text renderer. + + + + Draws a text. + + Paint event data. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Calculates the object's width. + + The width, in pixels. + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + + + + + + + Base class for text objects such as and . + + + This class implements common functionality of the text objects. + + + + + + + + + + + + + + Gets or sets a value indicating that the object's text may contain expressions. + + + + + Gets or sets the symbols that will be used to find expressions in the object's text. + + + The default property value is "[,]". As you can see, the open and close symbols are + separated by the comma. You may use another symbols, for example: "<,>" or "<%,%>". + You should use different open and close symbols. + + + + + Gets or sets the object's text. + + + Text may contain expressions and data items, for example: "Today is [Date]". + When report is running, all expressions are calculated and replaced with actual + values, so the text would be "Today is 01.01.2008". + + + + + Gets or sets padding within the text object. + + + + + Gets or sets a value indicating that zero values must be hidden. + + + + + Gets or sets a value that will be hidden. + + + Use this property to specify a value that you would like to hide. For example, specify "0" + if you want to hide zero values, or use property to do this. + You also may use this property to hide default DateTime values (such as 1/1/1900). + In this case you need to specify a string containing both date and time, for example: + "1/1/1900 0:00:00". + + FastReport uses the ToString conversion to compare the expression value with this property. + This conversion depends on regional settings selected in the Control Panel, so be aware of this + if you going to distribute your report worldwide. + + + + + + Gets or sets a string that will be displayed instead of a null value. + + + + + Gets or sets the formatter that will be used to format data in the Text object. + + + The default formatter does nothing, i.e. it shows expression values with no formatting. + To set another formatting, create a new formatter and assign it to this property. + If there are several expressions in the text, use the property + to format each expression value. + + This example shows how to set currency formatter. + + TextObject text1; + text1.Format = new CurrencyFormat(); + + + + + + Gets or sets a value that specifies how the report engine processes this text object. + + + Use this property to perform such task as "print a total value in the group header". Normally, + all total values are calculated in the footers (for example, in a group footer). If you try to print + a total value in the group header, you will get 0. If you set this property to + ProcessAt.DataFinished, FastReport will do the following: + + + print the object (with wrong value); + + + print all related data rows; + + + calculate the correct object's value and replace old (wrong) value with the new one. + + + + This option will not work if you set the to true. + + + + + + Gets the collection of formatters. + + + This property is used to set format for each expression contained in the text. + For example, if the TextObject contains two expressions: + Today is [Date]; Page [PageN] + you can use the following code to format these expressions separately: + + text1.Formats.Clear(); + text1.Formats.Add(new DateFormat()); + text1.Formats.Add(new NumberFormat()); + + + + + + Gets or sets a value that determines how to display duplicate values. + + + + + Gets a value of expression contained in the object's text. + + + + + Gets or sets editable for pdf export + + + + + + + + + + + + + + + + + Returns the text to display. + + The text to display. + This method is used to display simplified DB field names in the designer. In runtime, it returns the Text property value. + + + + Initializes a new instance of the class with default settings. + + + + + The class introduces some menu items specific to the TextObjectBase. + + + + + The "Format" menu item. + + + + + The "Allow Expressions" menu item. + + + + + The "Hide Zeros" menu item. + + + + + Initializes a new instance of the TextObjectBaseMenu + class with default settings. + + The reference to a report designer. + + + + The class introduces some menu items specific to the TextObject. + + + + + The "Clear" menu item. + + + + + The "Auto Width" menu item. + + + + + The "Word Wrap" menu item. + + + + + Initializes a new instance of the TextObjectMenu + class with default settings. + + The reference to a report designer. + + + + Represents a zip code object. + + + This object is mainly used in Russia to print postal index on envelopes. It complies with the + GOST R 51506-99. + + + + + + + + + + + + + + + + + + + + Gets or sets the width of a single zipcode segment, in pixels. + + + + + Gets or sets the height of a single zipcode segment, in pixels. + + + + + Gets or sets the spacing between origins of segments, in pixels. + + + + + Gets or sets the number of segments in zipcode. + + + + + Gets or sets a value indicating whether the reference markers should be drawn. + + + Reference markers are used by postal service to automatically read the zipcode. + + + + + Gets or sets a value indicating whether the segment grid should be drawn. + + + + + Gets or sets a data column name bound to this control. + + + Value must be in the form "Datasource.Column". + + + + + Gets or sets an expression that contains the zip code. + + + + + Gets or sets the zip code. + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the with the default settings. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents a form for opening and adding pages of another report to the main report. + + + + + Designer of the main report. + + + + + Creates a new instance of the form to open the pages of another report + + Designer of the main report. + The report from which pages will be added to the main report + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Base class for all forms. + + + + + Gets the form's storage service. + + + + + Gets or sets value indicating that the form can save/restore the state such as location and size. + + + + + The event occurs on form's dpi change. + + + + + Convenience method returns an image with specified index for this form's dpi. + + Image index. + The image. + + + + Convenience method returns an image with specified name for this form's dpi. + + Image resource name. + The image. + + + + Convenience method returns an imagelist for this form's dpi. + + The imagelist. + + + + Localizes the dialog controls. + + + Use this method to set control's captions specific to the current locale. + + + + + Saves the form's state. + + + + + Restores the form's state. + + + + + + + + + + + + + + Update controls on dpi change. + + This method is called when the form's dpi is changed. Write custom logic to update + some controls (such as ListBox.ItemHeight) here. + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Editor for rearrangement Exports Menu elements + + + + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + The form for message box with text editor + + + + + Gets or sets text + + + + + Defualt constructor + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for . + For internal use only. + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Base form for all export options dialog forms. + + + + + Represents the "Open after export" button visibility. + + + + + Gets a reference to the currently editing export filter. + + + + + + + + + + + Called when editing is done. + + + Override this method to pass edited values from the dialog controls to the export filter. + + See the example of this method implementation that is used in the ImageExport. + + protected override void Done() + { + base.Done(); + ImageExport imageExport = Export as ImageExport; + imageExport.ImageFormat = (ImageExportFormat)cbxImageFormat.SelectedIndex; + imageExport.Resolution = (int)udResolution.Value; + imageExport.JpegQuality = (int)udQuality.Value; + imageExport.SeparateFiles = cbSeparateFiles.Checked; + } + + + + + + + + + Initializes controls with initial values. + + The export filter to edit. + + Override this method to pass values from the export filter to the dialog controls. + + See the example of this method implementation that is used in the ImageExport. + + public override void Init(ExportBase export) + { + base.Init(export); + ImageExport imageExport = Export as ImageExport; + cbxImageFormat.SelectedIndex = (int)imageExport.ImageFormat; + udResolution.Value = imageExport.Resolution; + udQuality.Value = imageExport.JpegQuality; + cbSeparateFiles.Checked = imageExport.SeparateFiles; + } + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + "Page Range" groupbox. + + + + + "Page Numbers" label. + + + + + "Page Numbers" textbox. + + + + + "Page Numbers" radiobutton. + + + + + "Current Page" radiobutton. + + + + + "All Pages" radiobutton. + + + + + PageControl. + + + + + Pages panel. + + + + + "Open after export" checkbox. + + + + + "Export all tabs" checkbox. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents the Splash Screen showing during loading designer + + + + + Initializes a new instance of the class. + + + + + Filters mouse events. + For internal use only. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents the Welcome window displayed on the designer startup + + + + + Initializes a new instance of the class. + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + The "Advanced Connection Properties" form. + + + + + Gets or sets the connection string builder which contains the connection properties. + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents the FastReport exception form. + + + + + + + + Creates a new instance ofthe form. + + The exception object which data to display in the form. + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + + + + + + Gets Aborted state + + + + + + + + + + Initialazes a new instance of the class. + + A reference to the report. + + + + Initialazes a new instance of the class. + + A reference to the report. + Specifies whether the form should be with Cancel button. + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Form for barcode editor + + + + + Generated text for barcode object + + + + + Initializes a new instance of the class. + + Text data for parsing + Report object for nodes + Brackets symbols + Editor for rich barcode? + + + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Base class for all dialog forms with two buttons, OK and Cancel. + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + The OK button. + + + + + The Cancel button. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + The base class for designer plugin's options page. + + + Use this class if you develop a designer plugin that may be configured in the + "View|Options..." menu. You need to implement an options page for your + plugin and return it in the IDesignerPlugin.GetOptionsPage method. + + + + + The TabControl control. + + + + + The TabPage control. + + + + + Gets or sets a value indicating that restart is required. + + + + + Event is fired whenever the RestartRequired property is changed. + + + + + Initializes controls on this options page. + + + Override this method to fill options page's controls with initial values. + + + + + Finalizes the options page. + + The dialog result. + + Override this method to pass controls' values to the plugin. Do this if result is + DialogResult.OK. + + + + + Updates images used in the control. + + + + + Initializes a new instance of the DesignerOptionsPage class with default settings. + + + Usually you need to define another contructor which takes one parameter - the plugin. + + This example shows how to define own constructor which takes a plugin: + + public DialogPageOptions(DialogPageDesigner pd) : base() + { + FPageDesigner = pd; + InitializeComponent(); + } + + + + + + The base class for the context menu item. + + + + + Gets a collection of menu items. + + + + + Gets or sets "Check on click" property. + + + + + Sets bold font. + + + + + Gets or sets a value indicating whether the item will be added to the toolbar. + + + + + The base class for the context menu of the report component. + + + This class represents a context menu of the report component that is displayed when the object + is right-clicked in the designer. + + + + + The reference to the report designer. + + + + + Gets a collection of menu items. + + + You should add new items to this collection. + + + + + Gets or sets the image list. + + + + + This method is called to reflect changes in the designer. + + + + + Creates a new menu item. + + Item's text. + New item. + + + + Creates a new menu item. + + Item's text. + Click handler. + New item. + + + + Creates a new menu item. + + Item's image index. + Item's text. + Click handler. + New item. + + + + Clears menu items. + + + + + Adds an item to this menu. + + Menu item to add. + + + + Returns true if menu is empty. + + + + + Displays context menu. + + Parent control. + Location. + + + + Updates the menu style. + + + + + Initializes a new instance of the ComponentBaseMenu class with default settings. + + The reference to a report designer. + + + + Updates HeaderWidth, HeaderHeight, BodyWidth, BodyHeight properties. + + + + + Represents the crossview object that is used to print cube slice or slicegrid. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + + + + + + + + + + + + + Allows to modify the prepared matrix elements such as cells, rows, columns. + + + + + Gets or sets a value indicating whether to show a title row. + + + + + Gets or sets a value indicating whether to show a X Axis fields Caption. + + + + + Gets or sets a value indicating whether to show a Y Axis fields Caption. + + + + + Gets or sets a matrix style. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + See the event for more details. + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets a cube source. + + + + + Gets the object that holds data of Cube + + + See the class for more details. + + + + + + + + + + + + + + Creates or updates the matrix template. + + + Call this method after you modify the matrix descriptors using the + object's properties. + + + + + + + + + + + + + + + + + + + + This method fires the ModifyResult event and the script code connected to the ModifyResultEvent. + + Event data. + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents interface of the source for object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The descriptor that is used to describe one CrossView data cell. + + + The class is used to define one data cell of the CrossView. + To set visual appearance of the data cell, use the + property. + The collection of descriptors used to represent the CrossView data cells is stored + in the CrossViewObject.Data.Cells property. + + + + + Gets a value indicating that this is the "GrandTotal" element on X axis. + + + + + Gets a value indicating that this is the "GrandTotal" element on Y axis. + + + + + Gets a value indicating that this is the "Total" element on X axis. + + + + + Gets a value indicating that this is the "Total" element on Y axis. + + + + + Gets the name of field in X axis. + + + + + Gets the name of field in Y axis. + + + + + Gets the name of measure in cube. + + + + + Gets the x coordinate. + + + + + Gets the y coordinate. + + + + + + + + + + + Initializes a new instance of the class + + The Field Name in X axis. + The Field Name in Y axis. + The Measure Name. + Indicates the "XTotal" element. + Indicates the "YTotal" element. + Indicates the "XGrandTotal" element. + Indicates the "YGrandTotal" element. + + + + Initializes a new instance of the class + + + + + Represents a collection of CrossView data descriptors used in the . + + + + + Gets or sets the element at the specified index. + + Index of an element. + The element at the specified index. + + + + Adds the specified descriptors to the end of this collection. + + Array of descriptors to add. + + + + Adds a descriptor to the end of this collection. + + Descriptor to add. + Index of the added descriptor. + + + + Inserts a descriptor into this collection at the specified index. + + The zero-based index at which value should be inserted. + The descriptor to insert. + + + + Removes the specified descriptor from the collection. + + Descriptor to remove. + + + + Returns the zero-based index of the first occurrence of a descriptor. + + The descriptor to locate in the collection. + The zero-based index of the first occurrence of descriptor within + the entire collection, if found; otherwise, -1. + + + + Determines whether a descriptor is in the collection. + + The descriptor to locate in the collection. + true if descriptor is found in the collection; otherwise, false. + + + + Copies the elements of this collection to a new array. + + An array containing copies of this collection elements. + + + + + + + + + + + + + + + Contains a set of properties and methods to hold and manipulate the CrossView descriptors. + + + This class contains three collections of descriptors such as , + and . Descriptors are filled from FastCube Slice. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets a collection of column descriptors. + + + Note: after you change something in this collection, call the + method to refresh the CrossView. + + + + + Gets a collection of row descriptors. + + + Note: after you change something in this collection, call the + method to refresh the CrossView. + + + + + Gets a collection of data cell descriptors. + + + Note: after you change something in this collection, call the + method to refresh the CrossView. + + + + + The base class for matrix element descriptors such as and + . + + + + + Gets or sets an expression which value will be used to fill the matrix. + + + Expression may be any valid expression. Usually it's a data column: + [DataSource.Column]. + + + + + Gets or sets the template column bound to this descriptor. + + + This property is for internal use; usually you don't need to use it. + + + + + Gets or sets the template row bound to this descriptor. + + + This property is for internal use; usually you don't need to use it. + + + + + Gets or sets the template cell bound to this descriptor. + + + Using this property, you may access the matrix cell which is bound to + this descriptor. It may be useful to change the cell's appearance. + + Before using this property, you must initialize the matrix descriptors by + calling the method. + + + + + CrossViewObject crossView; + // change the fill color of the first matrix cell + crossView.Data.Cells[0].TemplateCell.Fill = new SolidFill(Color.Red); + + + + + + Assigns values from another descriptor. + + Descriptor to assign values from. + + + + + + + + + + Represents a collection of CrossView header descriptors used in the . + + + + + Gets or sets the element at the specified index. + + Index of an element. + The element at the specified index. + + + + Adds the specified descriptors to the end of this collection. + + Array of descriptors to add. + + + + Adds a descriptor to the end of this collection. + + Descriptor to add. + Index of the added descriptor. + + + + Inserts a descriptor into this collection at the specified index. + + The zero-based index at which value should be inserted. + The descriptor to insert. + + + + Removes the specified descriptor from the collection. + + Descriptor to remove. + + + + Returns the zero-based index of the first occurrence of a descriptor. + + The descriptor to locate in the collection. + The zero-based index of the first occurrence of descriptor within + the entire collection, if found; otherwise, -1. + + + + Determines whether a descriptor is in the collection. + + The descriptor to locate in the collection. + true if descriptor is found in the collection; otherwise, false. + + + + Copies the elements of this collection to a new array. + + An array containing copies of this collection elements. + + + + + + + + + + + + + + + The descriptor that is used to describe one element of the CrossView header. + + + The class is used to define one header element of the CrossView + (either the column element or row element). + To set visual appearance of the element, use the + property. + The collection of descriptors used to represent the CrossView header is stored + in the CrossViewObject.Data.Columns and CrossViewObject.Data.Rows properties. + + + + + Gets a value indicating that this is the "GrandTotal" element. + + + + + Gets a value indicating that this is the "Total" element. + + + + + Gets a value indicating that this is the "Measure" element. + + + + + Gets the name of field in cube. + + + + + Gets the name of measure in cube. + + + + + Gets the cell coordinate. + + + + + Gets the size in cell coordinate. + + + + + Gets the level coordinate. + + + + + Gets the size in level coordinate. + + + + + + + + + + + Initializes a new instance of the class + + The Field Name. + The Measure Name. + Indicates the "Total" element. + Indicates the "GrandTotal" element. + Indicates the "Measure" element. + + + + Initializes a new instance of the class + + + + + Represents a Windows CheckBox. + Wraps the control. + + + + + + + + Occurs when the value of the Checked property changes. + Wraps the event. + + + + + Gets an internal CheckBox. + + + + + Gets or sets the value that determines the appearance of a CheckBox control. + Wraps the property. + + + + + Gets or sets the horizontal and vertical alignment of the check mark on a CheckBox control. + Wraps the property. + + + + + Gets or set a value indicating whether the CheckBox is in the checked state. + Wraps the property. + + + + + Gets or sets the state of the CheckBox. + Wraps the property. + + + + + Gets or sets a value indicating whether the CheckBox will allow three check states rather than two. + Wraps the property. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + + + + + + + + + + + + + This method fires the CheckedChanged event and the script code connected to the CheckedChangedEvent. + + Event data. + + + + Initializes a new instance of the CheckBoxControl class with default settings. + + + + + Represents a Windows combo box control. + Wraps the control. + + + + + + + + + + + + + + Occurs after the selection has been changed. + Wraps the event. + + + + + Occurs each time an owner-drawn ComboBox item needs to be drawn and + when the sizes of the list items are determined. + Wraps the event. + + + + + Occurs when a visual aspect of an owner-drawn ComboBox changes. + Wraps the event. + + + + + Gets an internal ComboBox. + + + + + Gets or sets a value indicating whether your code or the operating system will handle drawing of elements in the list. + Wraps the property. + + + + + Gets or sets a value specifying the style of the combo box. + Wraps the property. + + + + + Gets or sets the width of the of the drop-down portion of a combo box. + Wraps the property. + + + + + Gets or sets the height in pixels of the drop-down portion of the ComboBox. + Wraps the property. + + + + + Gets or sets the height of an item in the combo box. + Wraps the property. + + + + + Gets a collection of the items contained in this ComboBox. + Wraps the property. + + + + + Gets or sets the maximum number of items to be shown in the drop-down portion of the ComboBox. + Wraps the property. + + + + + Gets or sets a value indicating whether the items in the combo box are sorted. + Wraps the property. + + + + + Gets or sets the string that contains all items text. + + + + + Gets or sets the index specifying the currently selected item. + Wraps the property. + + + + + Gets or sets currently selected item in the ComboBox. + Wraps the property. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + + + + + + + + + + + + + + + + + + + This method fires the SelectedIndexChanged event and the script code connected to the SelectedIndexChangedEvent. + + Event data. + + + + This method fires the MeasureItem event and the script code connected to the MeasureItemEvent. + + Event data. + + + + This method fires the DrawItem event and the script code connected to the DrawItemEvent. + + Event data. + + + + Initializes a new instance of the ComboBoxControl class with default settings. + + + + + Implements base behavior of button controls. + + + + + This property is not relevant to this class. + + + + + Gets or sets a value that indicates whether the control resizes based on its contents. + Wraps the property. + + + + + Gets or sets the image that is displayed on a button control. + Wraps the property. + + + + + Gets or sets the alignment of the image on the button control. + Wraps the property. + + + + + Gets or sets the alignment of the text on the button control. + Wraps the property. + + + + + Gets or sets the position of text and image relative to each other. + Wraps the property. + + + + + + + + + + + Represents a Windows button control. + Wraps the control. + + + + + + + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + + + + Gets an internal Button. + + + + + Gets or sets a value that is returned to the parent form when the button is clicked. + Wraps the property. + + + + + + + + Initializes a new instance of the ButtonControl class with default settings. + + + + + Displays a ListBox in which a check box is displayed to the left of each item. + Wraps the control. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + Occurs after item's check state was changed. + Wraps the event. + + + + + Gets an internal CheckedListBox. + + + + + Gets or sets a value indicating whether the check box should be toggled when an item is selected. + Wraps the property. + + + + + Gets the items of the CheckedListBox. + Wraps the property. + + + + + Collection of checked indexes in this CheckedListBox. + Wraps the property. + + + + + Collection of checked items in this CheckedListBox. + Wraps the property. + + + + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + + + + + + + + + + + + + + + + + + + This method fires the ItemCheck event and the script code connected to the ItemCheckEvent. + + Event data. + + + + Initializes a new instance of the CheckedListBoxControl class with default settings. + + + + + Displays a hierarchical collection of labeled items, each represented by a TreeNode. + Wraps the control. + + + + + This property is not relevant to this class. + + + + + + + + + + + Occurs after the tree node is selected. + Wraps the event. + + + + + Gets an internal TreeView. + + + + + Gets or sets a value indicating whether check boxes are displayed next to the tree nodes in the tree view control. + Wraps the property. + + + + + Gets or sets a value indicating whether lines are drawn between tree nodes in the tree view control. + Wraps the property. + + + + + Gets or sets a value indicating whether lines are drawn between the tree nodes that are at the root of the tree view. + Wraps the property. + + + + + Gets or sets the ImageList that contains the Image objects used by the tree nodes. + Wraps the property. + + + + + Gets the collection of tree nodes that are assigned to the tree view control. + Wraps the property. + + + + + Gets or sets the tree node that is currently selected in the tree view control. + Wraps the property. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + + + + + + + + + + This method fires the AfterSelect event and the script code connected to the AfterSelectEvent. + + Event data. + + + + Initializes a new instance of the class with default settings. + + + + + Represents a Windows text box control. + Wraps the control. + + + + + + + + + + + + + + + + + Gets an internal TextBox. + + + + + Gets or sets a value indicating whether pressing ENTER in a multiline TextBox control creates a new line of text in the control or activates the default button for the form. + Wraps the property. + + + + + Gets or sets a value indicating whether pressing the TAB key in a multiline text box control types a TAB character in the control instead of moving the focus to the next control in the tab order. + Wraps the property. + + + + + Gets or sets whether the TextBox control modifies the case of characters as they are typed. + Wraps the property. + + + + + Gets or sets the maximum number of characters the user can type or paste into the text box control. + Wraps the property. + + + + + Gets or sets a value indicating whether this is a multiline TextBox control. + Wraps the property. + + + + + Gets or sets a value indicating whether text in the text box is read-only. + Wraps the property. + + + + + Gets or sets which scroll bars should appear in a multiline TextBox control. + Wraps the property. + + + + + Gets or sets how text is aligned in a TextBox control. + Wraps the property. + + + + + Gets or sets a value indicating whether the text in the TextBox control should appear as the default password character. + Wraps the property. + + + + + Indicates whether a multiline text box control automatically wraps words to the beginning of the next line when necessary. + Wraps the property. + + + + + + + + + + + + + + Initializes a new instance of the TextBoxControl class with default settings. + + + + + Enables the user to select a single option from a group of choices when paired with other RadioButton controls. + Wraps the control. + + + + + + + + Occurs when the value of the Checked property changes. + Wraps the event. + + + + + Gets an internal RadioButton. + + + + + Gets or sets the location of the check box portion of the RadioButton. + Wraps the property. + + + + + Gets or sets a value indicating whether the control is checked. + Wraps the property. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + + + + + + + + + + + + + This method fires the CheckedChanged event and the script code connected to the CheckedChangedEvent. + + Event data. + + + + Initializes a new instance of the RadioButtonControl class with default settings. + + + + + Represents a Windows picture box control for displaying an image. + Wraps the control. + + + + + This property is not relevant to this class. + + + + + + + + Gets an internal PictureBox. + + + + + Indicates the border style for the control. + Wraps the property. + + + + + Gets or sets the image that the PictureBox displays. + Wraps the property. + + + + + Indicates how the image is displayed. + Wraps the property. + + + + + + + + Initializes a new instance of the PictureBoxControl class with default settings. + + + + + Base class for controls that may contain child controls. + + + + + + + + + + + + + + + + + + + + Gets the collection of child controls. + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the ParentControl class with default settings. + + + + + Used to group collections of controls. + Wraps the control. + + + + + This property is not relevant to this class. + + + + + Gets an internal Panel. + + + + + Indicates the border style for the control. + Wraps the property. + + + + + + + + + + + Initializes a new instance of the PanelControl class with default settings. + + + + + Represents a Windows spin box (also known as an up-down control) that displays numeric values. + Wraps the control. + + + + + This property is not relevant to this class. + + + + + + + + + + + + + + Occurs when the Value property has been changed in some way. + Wraps the event. + + + + + Gets an internal NumericUpDown. + + + + + Gets or sets the number of decimal places to display in the up-down control. + Wraps the property. + + + + + Gets or sets a value indicating whether the up-down control should display the value it contains in hexadecimal format. + Wraps the property. + + + + + Gets or sets the value to increment or decrement the up-down control when the up or down buttons are clicked. + Wraps the property. + + + + + Gets or sets the maximum value for the up-down control. + Wraps the property. + + + + + Gets or sets the minimum value for the up-down control. + Wraps the property. + + + + + Gets or sets a value indicating whether a thousands separator is displayed in the up-down control when appropriate. + Wraps the property. + + + + + Gets or sets the value assigned to the up-down control. + Wraps the property. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + + + + + + + + + + + + + + + + This method fires the ValueChanged event and the script code connected to the ValueChangedEvent. + + Event data. + + + + Initializes a new instance of the NumericUpDownControl class with default settings. + + + + + Represents a Windows control that enables the user to select a date using a visual monthly calendar display. + Wraps the control. + + + + + + + + + + + + + + + + + Occurs when the date selected in the MonthCalendar changes. + Wraps the event. + + + + + Gets an internal MonthCalendar. + + + + + Gets or sets the number of columns and rows of months displayed. + Wraps the property. + + + + + Gets or sets the first day of the week as displayed in the month calendar. + Wraps the property. + + + + + Gets or sets the maximum allowable date. + Wraps the property. + + + + + Gets or sets the maximum number of days that can be selected in a month calendar control. + Wraps the property. + + + + + Gets or sets the minimum allowable date. + Wraps the property. + + + + + Gets or sets a value indicating whether the date represented by the TodayDate property is displayed at the bottom of the control. + Wraps the property. + + + + + Gets or sets a value indicating whether today's date is circled. + Wraps the property. + + + + + Gets or sets a value indicating whether the month calendar control displays week numbers (1-52) to the left of each row of days. + Wraps the property. + + + + + Gets or sets the value that is used by MonthCalendar as today's date. + Wraps the property. + + + + + Gets or sets the array of DateTime objects that determines which annual days are displayed in bold. + Wraps the property. + + + + + Gets or sets the array of DateTime objects that determines which nonrecurring dates are displayed in bold. + Wraps the property. + + + + + Gets or sets the array of DateTime objects that determine which monthly days to bold. + Wraps the property. + + + + + Gets or sets the end date of the selected range of dates. + Wraps the property. + + + + + Gets or sets the selected range of dates for a month calendar control. + Wraps the property. + + + + + Gets or sets the start date of the selected range of dates. + Wraps the property. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + + + + + + + + + + + + + This method fires the DateChanged event and the script code connected to the DateChangedEvent. + + Event data. + + + + Initializes a new instance of the MonthCalendarControl class with default settings. + + + + + Uses a mask to distinguish between proper and improper user input. + Wraps the control. + + + + + + + + + + + + + + + + + Gets an internal MaskedTextBox. + + + + + Gets or sets the input mask to use at run time. + Wraps the property. + + + + + Gets or sets a value indicating whether the user is allowed to reenter literal values. + Wraps the property. + + + + + Gets or sets how text is aligned in a masked text box control. + Wraps the property. + + + + + + + + + + + + + + Initializes a new instance of the MaskedTextBoxControl class with default settings. + + + + + Represents a Windows list view control, which displays a collection of items that can be displayed using one of four different views. + Wraps the control. + + + + + This property is not relevant to this class. + + + + + + + + + + + Occurs when the checked state of an item changes. + Wraps the event. + + + + + Occurs when the index of the selected item in the list view control changes. + Wraps the event. + + + + + Gets an internal ListView. + + + + + Gets or sets a value indicating whether a check box appears next to each item in the control. + Wraps the property. + + + + + Gets or sets a value indicating whether multiple items can be selected. + Wraps the property. + + + + + Gets or sets a value indicating whether items are displayed in groups. + Wraps the property. + + + + + Gets or sets how items are displayed in the control. + Wraps the property. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets the indexes of the currently checked items in the control. + Wraps the property. + + + + + Gets the currently checked items in the control. + Wraps the property. + + + + + Gets the collection of all column headers that appear in the control. + Wraps the property. + + + + + Gets the collection of ListViewGroup objects assigned to the control. + Wraps the property. + + + + + Gets a collection containing all items in the control. + Wraps the property. + + + + + Gets or sets the ImageList to use when displaying items as large icons in the control. + Wraps the property. + + + + + Gets the indexes of the selected items in the control. + Wraps the property. + + + + + Gets the items that are selected in the control. + Wraps the property. + + + + + Gets or sets the ImageList to use when displaying items as small icons in the control. + Wraps the property. + + + + + + + + + + + + + + This method fires the ItemChecked event and the script code connected to the ItemCheckedEvent. + + Event data. + + + + This method fires the SelectedIndexChanged event and the script code connected to the SelectedIndexChangedEvent. + + Event data. + + + + Initializes a new instance of the ListViewControl class with default settings. + + + + + Base class for list box controls such as ListBoxControl, CheckedListBoxControl. + + + + + This property is not relevant to this class. + + + + + + + + + + + Occurs when the SelectedIndex property has changed. + Wraps the event. + + + + + Occurs when an owner-drawn ListBox is created and the sizes of the list items are determined. + Wraps the event. + + + + + Occurs when a visual aspect of an owner-drawn ListBox changes. + Wraps the event. + + + + + Gets or sets the width of columns in a multicolumn ListBox. + Wraps the property. + + + + + Gets or sets the drawing mode for the control. + Wraps the property. + + + + + Gets or sets the height of an item in the ListBox. + Wraps the property. + + + + + Gets the items of the ListBox. + Wraps the property. + + + + + Gets or sets a value indicating whether the ListBox supports multiple columns. + Wraps the property. + + + + + Gets or sets the method in which items are selected in the ListBox. + Wraps the property. + + + + + Gets or sets a value indicating whether the items in the ListBox are sorted alphabetically. + Wraps the property. + + + + + Gets or sets a value indicating whether the ListBox can recognize and expand tab characters when drawing its strings. + Wraps the property. + + + + + Gets or sets the string that contains all items text. + + + + + Gets or sets the zero-based index of the currently selected item in a ListBox. + Wraps the property. + + + + + Gets a collection that contains the zero-based indexes of all currently selected items in the ListBox. + Wraps the property. + + + + + Gets or sets the currently selected item in the ListBox. + Wraps the property. + + + + + Gets a collection containing the currently selected items in the ListBox. + Wraps the property. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + + + + + + + + + + + + + This method fires the SelectedIndexChanged event and the script code connected to the SelectedIndexChangedEvent. + + Event data. + + + + This method fires the MeasureItem event and the script code connected to the MeasureItemEvent. + + Event data. + + + + This method fires the DrawItem event and the script code connected to the DrawItemEvent. + + Event data. + + + + Represents a standard Windows label. + Wraps the control. + + + + + + + + Gets an internal Label. + + + + + Gets or sets a value indicating whether the control is automatically resized to display its entire contents. + Wraps the property. + + + + + Gets or sets the alignment of text in the label. + Wraps the property. + + + + + + + + Initializes a new instance of the LabelControl class with default settings. + + + + + Displays data in a customizable grid. + Wraps the control. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + + + + Gets an internal DataGridView. + + + + + Gets or sets the data source that the DataGridView is displaying data for. + + + + + Gets or sets a value indicating whether the option to add rows is displayed to the user. + Wraps the property. + + + + + Gets or sets a value indicating whether the user is allowed to delete rows from the DataGridView. + Wraps the property. + + + + + Gets or sets the default cell style applied to odd-numbered rows of the DataGridView. + Wraps the property. + + + + + Gets or sets a value indicating how column widths are determined. + Wraps the property. + + + + + Gets or sets a value indicating how row heights are determined. + Wraps the property. + + + + + Gets or sets the background color of the DataGridView. + Wraps the property. + + + + + Gets or sets the border style for the DataGridView. + Wraps the property. + + + + + Gets the cell border style for the DataGridView. + Wraps the property. + + + + + Gets the border style applied to the column headers. + Wraps the property. + + + + + Gets or sets the default column header style. + Wraps the property. + + + + + Gets or sets the height, in pixels, of the column headers row. + Wraps the property. + + + + + Gets or sets a value indicating whether the height of the column headers is adjustable and whether it can be adjusted by the user or is automatically adjusted to fit the contents of the headers. + Wraps the property. + + + + + Gets or sets a value indicating whether the column header row is displayed. + Wraps the property. + + + + + Gets the collection of objects that represents the grid columns. + + + + + Gets or sets the default cell style to be applied to the cells in the DataGridView if no other cell style properties are set. + Wraps the property. + + + + + Gets or sets the color of the grid lines separating the cells of the DataGridView. + Wraps the property. + + + + + Gets or sets a value indicating whether the user is allowed to select more than one cell, row, or column of the DataGridView at a time. + Wraps the property. + + + + + Gets a value indicating whether the user can edit the cells of the DataGridView control. + Wraps the property. + + + + + Gets or sets the border style of the row header cells. + Wraps the property. + + + + + Gets or sets the default style applied to the row header cells. + Wraps the property. + + + + + Gets or sets a value indicating whether the column that contains row headers is displayed. + Wraps the property. + + + + + Gets or sets the width, in pixels, of the column that contains the row headers. + Wraps the property. + + + + + Gets or sets a value indicating whether the width of the row headers is adjustable and whether it can be adjusted by the user or is automatically adjusted to fit the contents of the headers. + Wraps the property. + + + + + Gets or sets the default style applied to the row cells of the DataGridView. + Wraps the property. + + + + + Gets or sets the type of scroll bars to display for the DataGridView control. + Wraps the property. + + + + + Gets or sets a value indicating how the cells of the DataGridView can be selected. + Wraps the property. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the GridControl class with default settings. + + + + + Represents the special kind of report page that wraps the + and used to display dialog forms. + + + Use the property to add/remove controls to/from a dialog form. + If you set the Visible property to false, this dialog form will be + skippen when you run a report. + + This example shows how to create a dialog form with one button in code. + + DialogPage form = new DialogPage(); + // set the width and height in pixels + form.Width = 200; + form.Height = 200; + form.Name = "Form1"; + // create a button + ButtonControl button = new ButtonControl(); + button.Location = new Point(20, 20); + button.Size = new Size(75, 25); + button.Text = "The button"; + // add the button to the form + form.Controls.Add(button); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Occurs before a form is displayed for the first time. + Wraps the event. + + + + + Occurs after the form is closed. + Wraps the event. + + + + + Occurs before the form is closed. + Wraps the event. + + + + + Occurs whenever the form is first displayed. + Wraps the event. + + + + + Occurs when the form is resized. + Wraps the event. + + + + + Occurs when the form is redrawn. + Wraps the event. + + + + + Gets an internal Form. + + + + + Gets or sets an active state in Web application. + + + + + Gets or sets the button on the form that is clicked when the user presses the ENTER key. + Wraps the property. + + + + + Gets or sets the button control that is clicked when the user presses the ESC key. + Wraps the property. + + + + + Gets the auto scale dimensions for this form. + + + + + Gets or sets the background color for the form. + Wraps the property. + + + + + Gets or sets the font of the text displayed by the control. + Wraps the property. + + + + + Gets or sets the border style of the form. + Wraps the property. + + + + + Gets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts. + Wraps the property. + + + + + Gets or sets the text associated with this form. + Wraps the property. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets the collection of controls contained within the form. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Shows the form as a modal dialog box with the currently active window set as its owner. + Wraps the method. + + One of the DialogResult values. + + + + This method fires the Load event and the script code connected to the LoadEvent. + + Event data. + + + + This method fires the FormClosed event and the script code connected to the FormClosedEvent. + + Event data. + + + + This method fires the FormClosing event and the script code connected to the FormClosingEvent. + + Event data. + + + + This method fires the Shown event and the script code connected to the ShownEvent. + + Event data. + + + + This method fires the Resize event and the script code connected to the ResizeEvent. + + Event data. + + + + This method fires the Paint event and the script code connected to the PaintEvent. + + Event data. + + + + Initializes a new instance of the DialogPage class. + + + + + Base class for all dialog controls such as ButtonControl, TextBoxControl. + + + + + Determines whether is necessary to serialize the BackColor property. + + true if serialization is necessary. + + + + Determines whether is necessary to serialize the Cursor property. + + true if serialization is necessary. + + + + Determines whether is necessary to serialize the Font property. + + true if serialization is necessary. + + + + Determines whether is necessary to serialize the ForeColor property. + + true if serialization is necessary. + + + + + + + Draws the selection point. + + Graphics object to draw on. + object. + object. + Left coordinate. + Top coordinate. + + + + + + + + + + Creates the empty event handler for the ClickEvent event in the report's script. + + true if event handler was created successfully. + + + + + + + Occurs when the control is clicked. + Wraps the event. + + + + + Occurs when the control is double-clicked. + Wraps the event. + + + + + Occurs when the control is entered. + Wraps the event. + + + + + Occurs when the input focus leaves the control. + Wraps the event. + + + + + Occurs when a key is pressed while the control has focus. + Wraps the event. + + + + + Occurs when a key is pressed while the control has focus. + Wraps the event. + + + + + Occurs when a key is released while the control has focus. + Wraps the event. + + + + + Occurs when the mouse pointer is over the control and a mouse button is pressed. + Wraps the event. + + + + + Occurs when the mouse pointer is moved over the control. + Wraps the event. + + + + + Occurs when the mouse pointer is over the control and a mouse button is released. + Wraps the event. + + + + + Occurs when the mouse pointer enters the control. + Wraps the event. + + + + + Occurs when the mouse pointer leaves the control. + Wraps the event. + + + + + Occurs when the control is resized. + Wraps the event. + + + + + Occurs when the Text property value changes. + Wraps the event. + + + + + Occurs when the control is redrawn. + Wraps the event. + + + + + Gets an internal Control. + + + + + Gets or sets the background color for the control. + Wraps the property. + + + + + Gets or sets the cursor that is displayed when the mouse pointer is over the control. + Wraps the property. + + + + + Gets or sets a value indicating whether the control can respond to user interaction. + Wraps the property. + + + + + Gets or sets the font of the text displayed by the control. + Wraps the property. + + + + + Gets or sets the foreground color of the control. + Wraps the property. + + + + + Gets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts. + Wraps the property. + + + + + Gets or sets the tab order of the control within its container. + Wraps the property. + + + + + Gets or sets a value indicating whether the user can give the focus to this control using the TAB key. + Wraps the property. + + + + + Gets or sets the text associated with this control. + Wraps the property. + + + + + Gets or sets which control borders are docked to its parent control and determines how a control is resized with its parent. + Wraps the property. + + + + + Gets or sets the edges of the container to which a control is bound and determines how a control is resized with its parent. + Wraps the property. + + + + + Gets or sets a value indicating whether the control is displayed. + Wraps the property. + + + + + Gets or sets a property that returns actual data contained in a control. This value is used + in the "Data" window. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + + + + + + + + + + + + + + + + Called when the control's Enabled state changed. + + + + + Attaches Control events to its event handlers. + + + Override this method if your custom control has own events. + + See the example of AttachEvents implementation used in the CheckBoxControl: + + protected override void AttachEvents() + { + base.AttachEvents(); + CheckBox.CheckedChanged += new EventHandler(CheckBox_CheckedChanged); + } + + private void CheckBox_CheckedChanged(object sender, EventArgs e) + { + if (CheckedChanged != null) + CheckedChanged(this, e); + InvokeEvent(CheckedChangedEvent, e); + } + + + + + + Detaches Control events from its event handlers. + + + Override this method if your custom control has own events. In this method, you should + detach control's events that were attached in the method. + + See the example of DetachEvents implementation used in the CheckBoxControl: + + protected override void DetachEvents() + { + base.DetachEvents(); + CheckBox.CheckedChanged -= new EventHandler(CheckBox_CheckedChanged); + } + + + + + + + + + + + + Initializes the control before display it in the dialog form. + + + This method is called when report is run. + + + + + Finalizes the control after its parent form is closed. + + + This method is called when report is run. + + + + + Sets input focus to the control. + + + + + Conceals the control from the user. + + + + + Displays the control to the user. + + + + + + + + This method fires the Click event and the script code connected to the ClickEvent. + + Event data. + + + + This method fires the DoubleClick event and the script code connected to the DoubleClickEvent. + + Event data. + + + + This method fires the Enter event and the script code connected to the EnterEvent. + + Event data. + + + + This method fires the Leave event and the script code connected to the LeaveEvent. + + Event data. + + + + This method fires the KeyDown event and the script code connected to the KeyDownEvent. + + Event data. + + + + This method fires the KeyPress event and the script code connected to the KeyPressEvent. + + Event data. + + + + This method fires the KeyUp event and the script code connected to the KeyUpEvent. + + Event data. + + + + This method fires the MouseDown event and the script code connected to the MouseDownEvent. + + Event data. + + + + This method fires the MouseMove event and the script code connected to the MouseMoveEvent. + + Event data. + + + + This method fires the MouseUp event and the script code connected to the MouseUpEvent. + + Event data. + + + + This method fires the MouseEnter event and the script code connected to the MouseEnterEvent. + + Event data. + + + + This method fires the MouseLeave event and the script code connected to the MouseLeaveEvent. + + Event data. + + + + This method fires the Resize event and the script code connected to the ResizeEvent. + + Event data. + + + + This method fires the TextChanged event and the script code connected to the TextChangedEvent. + + Event data. + + + + This method fires the Paint event and the script code connected to the PaintEvent. + + Event data. + + + + Base class for all dialog components. + + + + + + + + + + + + + + + + + + + + Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. + + + + + Gets or sets the height and width of the control. + + + + + + + + Initializes a new instance of the DialogComponentBase class with default settings. + + + + + Represents the control with two lists (available items and selected items). + + + The control allows to select one or several items and then filter the datasource which it is connected to. + All you need is to setup the DataColumn property. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + Gets or sets a value indicating that the items must be sorted. + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the DataSelectorControl class with default settings. + + + + + Represents a Windows control that allows the user to select a date and a time and to display the date and time with a specified format. + Wraps the control. + + + + + This property is not relevant to this class. + + + + + + + + + + + + + + Occurs after the date has been changed. + Wraps the event. + + + + + Gets an internal DateTimePicker. + + + + + Gets or sets a value indicating whether the Value property has been set with a valid date/time value and the displayed value is able to be updated. + Wraps the property. + + + + + Gets or sets the custom date/time format string. + Wraps the property. + + + + + Gets or sets the alignment of the drop-down calendar on the DateTimePicker control. + Wraps the property. + + + + + Gets or sets the format of the date and time displayed in the control. + Wraps the property. + + + + + Gets or sets the maximum date and time that can be selected in the control. + Wraps the property. + + + + + Gets or sets the minimum date and time that can be selected in the control. + Wraps the property. + + + + + Gets or sets a value indicating whether a check box is displayed to the left of the selected date. + Wraps the property. + + + + + Gets or sets a value indicating whether a spin button control (also known as an up-down control) is used to adjust the date/time value. + Wraps the property. + + + + + Gets or sets the date/time value assigned to the control. + Wraps the property. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + + + + + + + + + + + + + This method fires the ValueChanged event and the script code connected to the ValueChangedEvent. + + Event data. + + + + Initializes a new instance of the DateTimePickerControl class with default settings. + + + + + Represents the 's column. + Wraps the class. + + + + + Gets or sets the mode by which the column automatically adjusts its width. + Wraps the property. + + + + + Gets or sets the data column attached to this column. + + + + + Gets or sets the caption text on the column's header cell. + Wraps the property. + + + + + Gets or sets the column's default cell style. + Wraps the property. + + + + + Gets or sets a value that represents the width of the column when it is in fill mode relative to the widths of other fill-mode columns in the control. + Wraps the property. + + + + + Gets or sets the current width of the column. + Wraps the property. + + + + + Gets or sets a value indicating whether the column is visible. + Wraps the property. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + + + + + + + Initializes a new instance of the GridControlColumn class with default settings. + + + + + Represents the collection of GridControl columns. + + + + + Gets or sets a column. + + The index of a column in this collection. + The column with specified index. + + + + + + + + + + Serializes the collection. + + Writer object. + + This method is for internal use only. + + + + + Deserializes the collection. + + Reader object. + + This method is for internal use only. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with default settings. + + The owner of this collection. + + + + Represents a Windows rich text box control. + Wraps the control. + + + + + Gets an internal RichTextBox. + + + + + Gets or sets the text of the RichTextBox control, including all rich text format (RTF) codes. + Wraps the property. + + + + + Gets or sets the type of scroll bars to display in the RichTextBox control. + Wraps the property. + + + + + + + + Loads rtf from a file. + + File to load from. + + + + Loads rtf from a stream using specified stream type. + + Stream to load from. + Type of a stream. + + + + Loads rtf from a file using specified stream type. + + File to load from. + Type of a stream. + + + + Initializes a new instance of the RichTextBoxControl class with default settings. + + + + + Represents a Windows control that displays a frame around a group of controls with an optional caption. + Wraps the control. + + + + + Gets an internal GroupBox. + + + + + Initializes a new instance of the GroupBoxControl class with default settings. + + + + + The base class for all controls that support the data filtering feature. + + + The data filtering allows you to bind the control to a . + It will be automatically filled by data from the datasource's column. When you select/check + item(s) and close the dialog with OK button, it will filter the datasource according to your selection. + You can set the filter operation using the property. + + + + + Occurs after the control is filled with data. + + + + + Gets or sets a value that determines whether to fill the control with data automatically. + + + The default value of this property is true. If you set it to false, + you need to call the method manually. + + + + + Gets or sets a value that determines whether to filter the datasource automatically + when you close the dialog by OK button. + + + The default value of this property is true. If you set it to false, + you need to call the method manually. + + + + + Gets or sets a data column name that will be used to fill this control with data. + + + This property must contain both datasource name and column name, for example: + Orders.OrderID. You also may use relations, for example: Orders.Customers.CompanyName. + + + + + Gets or sets name of report parameter which value will be set to value contained + in this control when you close the dialog. + + + + + Gets or sets a value that specifies the filter operation. + + + + + Gets or sets the detail control used in cascaded filtering. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + + + Fills the control with data. + + The data source. + The data column. + Here is the example of FillData method implementation: + + protected override void FillData(DataSourceBase dataSource, Column column) + { + Items.Clear(); + dataSource.First(); + while (dataSource.HasMoreRows) + { + Items.Add(dataSource[column].ToString()); + dataSource.Next(); + } + } + + + + + + Returns list of values that can be used to fill control with data. + + The data source. + The data column. + List of string values. + + This method is used by the FillData method to fill list-type controls + such as ListBox with data. The result list contains distinct values. + + + + + Returns value entered in the control. + + The value of type supported by this control. + + This method must return a value entered by the user. For example, TextBox + control must return its Text property value. If this control supports multi-selection, + return selected values in an array, for example string[] array for CheckedListBox. + + + + + Handles the cascaded filter internal logic. + + + This method should be called in your custom dialog control that supports data filtering. + Call it when the value in your control is changed. + + + + + + + + + + + + + + Fills the control with data from a datasource. + + + Call this method if you set the property to false. + + + + + Fills the control with data from a datasource. + + Parent data source + + Call this method if you need to implement cascaded filter. In the parentData parameter, + pass the parent data source that will be used to set up master-detail relationship with + data source in this control. + + + + + Fills the control with data from a datasource. + + Parent control + + Call this method if you need to implement cascaded filter. In the parentControl parameter, + pass the parent control which performs filtering on a parent data source. + + + + + Applies the filter to a datasource. + + + Call this method if you set the property to false. + + + + + Resets the filter set by this control. + + + + + This method fires the DataLoaded event and the script code connected to the DataLoadedEvent. + + Event data. + + + + Initializes a new instance of the DataFilterBaseControl class with default settings. + + + + + Represents the collection of dialog components. + + + + + Gets or sets a component. + + The index of a component in this collection. + The component with specified index. + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with default settings. + + The owner of this collection. + + + + Represents a Windows control to display a list of items. + Wraps the control. + + + + + Gets an internal ListBox. + + + + + + + + + + + Initializes a new instance of the ListBoxControl class with default settings. + + + + + read current token, returns next + + + + + + + + read current token, returns next + + + + + + + + ignore current token, read from next, returns current i.e not next + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents a RFID label. + + + + + + + + + + + Specifies lock type on write\rewrite bank of data. + + + + + Unlock. + + + + + Lock. + + + + + Permanently unlock. + + + + + Permanently lock. + + + + + Specifies action on error printing of RFID label. + + + + + Skip label. + + + + + Place printer in Pause mode. + + + + + Place printer in Error mode. + + + + + + + + + + + + + + + + + + + + Gets or sets Tag ID memory bank. + + + + + Gets or sets User memory bank. + + + + + Gets or sets EPC memory bank. + + + + + Gets or sets EPC format. + + + + + Gets or sets access password. + + + + + Gets or sets kill password. + + + + + Gets or sets the name of the data column used to set the access password. + + + + + Gets or sets the name of the data column used to set the kill password. + + + + + Gets or sets the lock type for the kill password. + + + + + Gets or sets the lock type for the access password. + + + + + Gets or sets the lock type for the EPC bank. + + + + + Gets or sets the lock type for the user bank. + + + + + Gets or sets the start section for permanent lock of user bank. + + + + + Gets or sets the count of section for permanent lock of user bank. + + + + + Gets or sets the read power level for the label. + + + + + Gets or sets the write power level for the label. + + + + + Gets or sets a value that determines whether the using auto adjust of bits when write EPC bank. + + + + + Gets or sets a value that determines whether the entire EPC bank will be overwritten. + + + + + Gets or sets error handle mode. + + + + + Gets or sets a value that determines whether to use the adaptive antenna property. + + + + + + + + + + + + + + + + + Specifies the data format of a RFID label bank. + + + + + Gets or sets a data of bank. + + + + + Gets or sets a data column name to this bank. + + + + + Gets or sets a data offset of bank. Offset measured in 16-bit blocks. + + + + + Gets or sets a data format of bank. + + + + + Gets count byte of data. + + + + + Serializes the object. + + + + + Copies the contents of another, similar object. + + + + + + + + + + + Provides a user interface for choosing a data source. + + + + + + + + + + + Provides a user interface for editing a text outline. + + + + + + + + + + + Provides a user interface for choosing a relation. + + + + + Provides a user interface for selecting a component inside the report. + + + + + + + + + + + + + + Provides a user interface for selecting a component inside the same band. + + + + + + + + + + + + + + Provides an user interface for editing a flags enumeration. + + + + + + + + + + + Provides a user interface for choosing a data type. + + + + + + + + + + + Provides a user interface for choosing a data column. + + + + + + + + + + + + + + Provides a user interface for choosing a data source. + + + + + Provides a user interface for editing an expression. + + + + + + + + + + + Provides a user interface for editing an angle in degrees. + + + + + + + + + + + Provides a user interface for editing a component's border. + + + + + + + + + + + Provides a user interface for selecting a component inside the same page. + + + + + + + + + + + + + + Provides a user interface for choosing a color. + + + + + + + + + + + + + + + + + Provides a user interface for editing a fill. + + + + + + + + + + + Provides a user interface for editing a string collection. + + + + + + + + + + + Represents the report engine. + + + + + Shows band at the current position. + + Band to show. + + After the band is shown, the current position is advanced by the band's height. + + + + + Gets or sets the current X offset. + + + This property specifies the X offset where the current band will be printed. + + + + + Gets or sets the current Y offset. + + + This property specifies the Y offset where the current band will be printed. + After the band is printed, this value is incremented by the band's height. + + + + + Gets the index of currently printing column in the multi-column report. + + + This value is 0-based. + + + + + Gets or sets index of current prepared page the current band will print on. + + + Note: the page with specified index must exists. This property is used to print side-by-side + subreports and Table object. Usually you don't need to use it. + + + + + Gets the current page width, in pixels. + + + This property returns a paper width minus left and right margins. + + + + + Gets the current page height, in pixels. + + + This property returns a paper height minus top and bottom margins. + + + + + Gets the value indicating whether the page has unlimited height. + + + + + Gets the value indicating whether the page has unlimited width. + + + + + Gets or sets the current height of unlimited page. + + + + + Gets or sets the current width of unlimited page. + + + + + Gets the height of page footer (including all its child bands), in pixels. + + + + + Gets the height of column footer (including all its child bands), in pixels. + + + + + Gets the free space on the current page, in pixels. + + + This property returns the page height minus footers height minus CurY value. + + + + + Gets the current prepared page number. + + + This value is 1-based. The initial value (usually 1) is set in the Report.InitialPageNumber property. + + + + + Gets the number of total pages in a prepared report. + + + To use this property, your report must be two-pass. Set the + property to true. + + + + + Gets the string that represents the current page number. + + + This property returns a locale-based value, for example: "Page 1". + + + + + Gets the string that represents the "Page N of M" number. + + + This property returns a locale-based value, for example: "Page 1 of 10". + + + + + Gets the current row number of currently printing band. + + + This value is 1-based. It resets to 1 on each new group. + + + + + Gets the running current row number of currently printing band. + + + This value is 1-based. + + + + + Gets the date of report start. + + + + + Gets a value indicating whether the report is executing the final pass. + + + This property is true if report is one-pass, or if report is two-pass and + the second pass is executing. + + + + + Gets a value indicating whether the report is executing the first pass. + + + This property is true if report is one-pass, or if report is two-pass and + the first pass is executing. + + + + + Gets a level of hierarchy when printing hierarchical bands. + + + The first level of hierarchy has 0 index. + + + + + Gets the row number like "1.2.1" when printing hierarchical bands. + + + + + Translate RichObject to series of ReportComponentBase objects + + + + + + This code splits RichObject to report objects + + + + + + Returns true of keeping is enabled + + + + + Returns keeping position + + + + + Starts the keep mechanism. + + + Use this method along with the method if you want to keep + several bands together. Call StartKeep method before printing the first band + you want to keep, then call the EndKeep method after printing the last band you want to keep. + + + + + Ends the keep mechanism. + + + Use this method along with the method if you want to keep + several bands together. Call StartKeep method before printing the first band + you want to keep, then call the EndKeep method after printing the last band you want to keep. + + + + + Gets xml containing outline nodes. + + + + + Creates a new outline element with specified text. + + Text of element. + + After you call this method, the element will be added to the current position in the outline. + The next call to AddOutline will add new element as a child of this element. + To shift the position, use the or + OutlineUp methods. + + + + + Sets the current outline position to root. + + + + + Shifts the current outline position one level up. + + + + + Creates a new bookmark with specified name at current position. + + + + + + Gets a page number for the specified bookmark name. + + Name of bookmark. + Page number if bookmark with such name found; 0 otherwise. + + Use this method to print the table of contents in your report. Normally it can be done + using bookmarks. + + You must set your report to double pass to use this method. + + + + + + Resets the logical page numbers. + + + + + Called when the number of pages increased during DoublePass + + + + + Starts a new page. + + + + + Starts a new column. + + + + + Processes the specified text object which ProcessAt property is set to Custom. + + The text object to process. + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed. Otherwise, false. + + + + Represents a linear gauge. + + + + + Gets or sets the value that specifies inverted gauge or not. + + + + + Gets or sets gauge label. + + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents a linear pointer. + + + + + Gets o sets the height of gauge pointer. + + + + + Gets or sets the width of a pointer. + + + + + Initializes a new instance of the + + The parent gauge object. + + + + + + + + + + + + + Represents a linear scale. + + + + + Initializes a new instance of the class. + + The parent gauge object. + + + + + + + + + + + + + Represents a linear gauge. + + + + + + + + + + + + + + Returns centr of the gauge + + + + + The number of radians in one degree + + + + + Gets or sets the Radial Gauge type + + + + + Gats or sets the Radial Gauge position. Doesn't work for Full Radial Gauge. + + + + + Gets or sets the semicircles offset + + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + + + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Radial Gauge types + + + + + Full sized gauge + + + + + Half of the radial gauge + + + + + Quarter of the radial gauge + + + + + Radial Gauge position types + + + + + None + + + + + Top + + + + + Bottom + + + + + Left + + + + + Right + + + + + Represents a linear pointer. + + + + + Gets or sets the value, indicating that gradient should be rotated automatically + + + + + Initializes a new instance of the + + The parent gauge object. + The scale object. + + + + + + + Represents a linear scale. + + + + + Initializes a new instance of the class. + + The parent gauge object. + + + + + + + + + + + + + Represents a simple progress gauge. + + + + + Gets or sets gauge label. + + + + + Gets scale. Should be disabled for SimpleProgressGauge + + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + + + + Gets or sets the number of fractional digits + + + + + + + + + + + + + + SimpleProgressGauge pointer types + + + + + Full sized pointer + + + + + Small pointer + + + + + + + + Gets or sets the pointer type + + + + + Gets or sets the small pointer width ratio + + + + + + + + + + + + + + Represents a simple gauge. + + + + + Gets or sets gauge label. + + + + + Initializes a new instance of the class. + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents a simple pointer. + + + + + Gets o sets the Left offset of gauge pointer. + + + + + Gets o sets the Top offset of gauge pointer. + + + + + Gets o sets the height of gauge pointer. + + + + + Gets or sets the width of a pointer. + + + + + Gets or sets the pointer ratio. + + + + + Gets or sets the pointer horizontal offset (cm). + + + + + Initializes a new instance of the class. + + The parent gauge object. + + + + + + + + + + + + + Represents a simple scale. + + + + + Gets or sets the first subscale (top or left). + + + + + Gets or sets the second subscale (right or bottom). + + + + + Initializes a new instance of the class. + + The parent gauge object. + + + + + + + + + + + + + Represent the subscale of simple scale. + + + + + Gets or sets a value that specifies enabled subscale or not. + + + + + Gets or sets a value that specifies show caption or not. + + + + + Initializes a new instance of the class. + + + + + Copies the contents of another SimpleSubScale. + + The SimpleSubScale instance to copy the contents from. + + + + Serializes the SimpleSubScale. + + Writer object. + SimpleSubScale property name. + Another SimpleSubScale to compare with. + + This method is for internal use only. + + + + + Represents a gauge object. + + + + + + + + + + + Gets or sets the minimal value of gauge. + + + + + Gets or sets the maximal value of gauge. + + + + + Gets or sets the current value of gauge. + + + + + Gets or sets scale of gauge. + + + + + Gets or sets pointer of gauge. + + + + + Gets or sets gauge label. + + + + + Gets or sets an expression that determines the value of gauge object. + + + + + Gets a value that specifies is gauge vertical or not. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Minimum value of gauge. + Maximum value of gauge. + Current value of gauge. + + + + Initializes a new instance of the class. + + Minimum value of gauge. + Maximum value of gauge. + Current value of gauge. + Scale of gauge. + Pointer of gauge. + + + + + + + + + + + + + Draws the gauge. + + Draw event arguments. + + + + + + + Clone Gauge Object + + clone of this object + + + + Represents a label of a gauge. + + + + + Gets or sets the label text + + + + + Gets or sets the label font + + + + + Gets or sets the label color + + + + + Gets or sets the label parent + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Label text + Label font + Label color + Label parent + + + + Copies the contents of another GaugeLabel. + + The GaugeLabel instance to copy the contents from. + + + + Draws the gauge label. + + Draw event arguments. + + + + Serializes the gauge label. + + Writer object. + Gauge label property name. + Another GaugeLabel to compare with. + + This method is for internal use only. + + + + + Represents a pointer of gauge. + + + + + Gets or sets the parent gauge object. + + + + + Gets or sets the color of a pointer. + + + + + Gets or sets the border width of a pointer. + + + + + Gets or sets the border color of a pointer. + + + + + Initializes a new instance of the class. + + The parent gauge object. + + + + Copies the contents of another GaugePointer. + + The GaugePointer instance to copy the contents from. + + + + Draws the gauge pointer. + + Draw event arguments. + + + + Serializes the gauge pointer. + + Writer object. + Gauge pointer property name. + Another GaugePointer to compare with. + + This method is for internal use only. + + + + + Represents a scale of a gauge. + + + + + Gets or sets major ticks of scale. + + + + + Gets or sets minor ticks of scale. + + + + + Gets or sets the parent gauge object. + + + + + Gets or sets the font of scale. + + + + + Gets or sets the scale font color + + + + + Initializes a new instance of the class. + + The parent gauge object. + + + + Copies the contents of another GaugeScale. + + The GaugeScale instance to copy the contents from. + + + + Draws the scale of gauge. + + Draw event arguments. + + + + Serializes the gauge scale. + + Writer object. + Scale property name. + Another GaugeScale to compare with. + + This method is for internal use only. + + + + + Represents a scale ticks. + + + + + Gets or sets the length of ticks. + + + + + Gets or sets the width of ticks. + + + + + Gets or sets the color of ticks. + + + + + Gets or sets the count of ticks + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Ticks length. + Ticks width. + Ticks color. + + + + Initializes a new instance of the class. + + Ticks length. + Ticks width. + Ticks color. + Ticks count. + + + + Copies the contents of another ScaleTicks. + + The ScaleTicks instance to copy the contents from. + + + + Serializes the scale ticks. + + Writer object. + Scale ticks property name. + Another ScaleTicks to compare with. + + This method is for internal use only. + + + + + Represents a map object. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets the path to folder containing shapefiles. + + + This property is used by the map editor when selecting a shapefile. + + + + + Gets or sets the map zoom. + + + + + Gets or sets minimum zoom value. + + + + + Gets or sets maximum zoom value. + + + + + Gets or sets the X offset of the map. + + + + + Gets or sets the Y offset of the map. + + + + + Gets or sets the value indicating that mercator projection must be used to view the map. + + + + + Gets the color scale settings. + + + + + Gets or sets a collection of map layers. + + + + + Gets or sets padding within the map. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Loads a map from file. + + Name of file that contains a map. + + + + Creates unique names for all contained objects such as layers, shapes, etc. + + + + + Initializes a new instance of the class. + + + + + Represents a map point. + + + + + Gets or sets the X-coordinate of the point. + + + + + Gets or sets the Y-coordinate of the point. + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Represents a polygon shape. + + + + + Holds the largest bounding rectangle of this shape. + + + + + Gets or sets a bounding box of this shape. + + + + + Gets or sets a list of polygons in this shape. + + + + + Gets or sets the shape data in binary format. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed. Otherwise, false. + + + + Represents four coordinates that define a bounding box. + + + + + Gets or sets the minimum X-coordinate of a bounding box. + + + + + Gets or sets the minimum Y-coordinate of a bounding box. + + + + + Gets or sets the maximum X-coordinate of a bounding box. + + + + + Gets or sets the maximum Y-coordinate of a bounding box. + + + + + Copies the contents of another instance. + + Source box to copy the contents from. + + + + Defines the palette used to display map shapes. + + + + + No palette used. + + + + + Light palette. + + + + + Pastel palette. + + + + + Grayscale palette. + + + + + Earth tones palette. + + + + + Sea green palette. + + + + + Bright pastel palette. + + + + + Represents a set of color ranges used to highlight polygons based on analytical value. + + + + + Gets the list of ranges. + + + + + Gets or sets the number of ranges. + + + + + Gets or sets the start color. + + + + + Gets or sets the middle color. + + + + + Gets or sets the end color. + + + + + Gets or sets a value indicating that the map's color scale must display data from this color ranges. + + + + + Gets or sets ranges as a string. + + + + + Copies the contents of another ColorRanges. + + The ColorRanges instance to copy the contents from. + + + + Gets a color associated with given analytical value. + + The analytical value. + The color associated with this value, or Color.Transparent if no association found. + + + + Initializes a new instance of the class. + + + + + Represents a single color range. + + + + + Gets or sets color of the range. + + + + + Gets or sets start value of the range. + + + + + Gets or sets end value of the range. + + + + + Copies the contents of another ColorRange. + + The ColorRange instance to copy the contents from. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a specified parameters. + + The color of the range. + The start value of the range. + The end value of the range. + + + + Represents the color scale. + + + + + Gets or sets that must be displayed in this color scale. + + + + + Gets or sets the format string used to format data values. + + + + + Gets or sets a value indicating whether the color scale must be hidden if there is no data in it. + + + + + Gets or sets the text displayed in the color scale if there is no data in it. + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Represents a distance scale. + + + + + Initializes a new instance of the class. + + + + + Represents loading map data from dbf-file. + + + + + Gets or sets the filter string used in an open file dialog. + + + + + Initializes a new instance of the class. + + + + + Returns a file filter for an open file dialog. + + String that contains a file filter. + + + + Imports the map data from a specified file into a specfied layer. + + The MapObject for an importing map. + The name of a file that contains map. + + + + Represents the description of dBase field. + + + + + Gets the field name. + + + + + Gets the field type. + + + + + Gets the field length. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a specified parameters. + + The field name. + The field type. + The field length. + + + + Initializes a new instance of the class with a specified parameters. + + The field name. + The field type. + The field length. + + + + The type of dBase field. + + + + + Character field. + + + + + Date field. + + + + + Numeric field. + + + + + Logical field. + + + + + Memo field. + + + + + Represents a collection of objects. + + + + + Gets a layer with specified index. + + Index of a layer. + The layer with specified index. + + + + Specifies the type of objects that layer contains. + + + + + The layer contains points. + + + + + The layer contains lines. + + + + + The layer contains polygons. + + + + + Specifies the spatial source for the layer. + + + + + Source is ESRI shapefile. + + + + + Source is a latitude/longitude/name provided by an application. + + + + + Determines how map labels are displayed. + + + + + No label displayed. + + + + + The shape name is displayed. + + + + + The value is displayed. + + + + + Both name and value displayed. + + + + + Represents a map layer. + + + + + Gets or sets a type of layer. + + + + + Gets or sets the spatial source for the layer. + + + + + Gets or sets the name of ESRI shapefile. + + + + + Gets or sets the data source. + + + + + Gets or sets the datasource filter expression. + + + + + Gets or sets spatial column name. + + + This property is used if the is set to ShpFile. + + + + + Gets or sets an expression that returns spatial value. + + + This property is used if the is set to ShpFile. + + + + + Gets or sets an expression that returns latitude value. + + + This property is used if the is set to ApplicationData. + + + + + Gets or sets an expression that returns longitude value. + + + This property is used if the is set to ApplicationData. + + + + + Gets or sets an expression that returns label value. + + + This property is used if the is set to ApplicationData. + + + + + Gets or sets an expression that returns analytical value. + + + + + Gets or sets label's column name. + + + + + Gets or sets a value that determines how map labels are displayed. + + + + + Gets or sets the format of label's value. + + + + + Gets or sets the map accuracy. Lower value is better, but slower. + + + + + Gets or sets the value that determines the labels visiblity at a certain zoom value. + + + + + Gets or sets the aggregate function. + + + + + Gets or sets a value indicating that the layer is visible. + + + + + Gets or sets a bounding box of layer. + + + + + Gets a collection of map objects. + + + + + Gets the default style of shapes in this layer. + + + + + Gets or sets the palette used to highlight shapes. + + + + + Gets the color ranges used to highlight shapes based on analytical value. + + + + + Gets the size ranges used to draw points based on analytical value. + + + + + Gets or sets the expression that returns the name of polygon to zoom. + + + + + Gets or sets the bounding box as a string. + + + + + Gets a reference to the Map object. + + + + + + + + Draws the layer. + + The drawing parameters. + + + + Finds the shape under cursor. + + The cursor coordinates. + The ShapeBase object if found. + + + + + + + Creates unique names for all contained objects such as points, lines, polygons, etc. + + + + + Reduces the number of points in the shapes in this layer. + + The accuracy value. + + + + Loads the layer contents from ESRI shapefile (*.shp/*.dbf). + + The file name. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Adds application provided data. + + Latitude value. + Longitude value. + The name displayed as a label. + Analytical value. + + Use this method if the is set to ApplicationData. + + + + + Adds a spatial/analytical value pair to the list. + + The spatial value. + The analytical value. + + Use this method if the is set to ShpFile. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Represents a pair of double coordinates that defines a constituent point. + + + + + Gets or sets the X-coordinate of a point. + + + + + Gets or sets the Y-coordinate of a point. + + + + + Creates a new instance of the class with specified coordinates. + + X coordinate. + Y coordinate. + + + + Specifies the position of a scale control inside the map. + + + + + The scale is displayed at top left corner. + + + + + The scale is displayed at top center side. + + + + + The scale is displayed at top right corner. + + + + + The scale is displayed at middle left side. + + + + + The scale is displayed at middle right side. + + + + + The scale is displayed at bottom left corner. + + + + + The scale is displayed at bottom center side. + + + + + The scale is displayed at bottom right corner. + + + + + The base class for scale-type controls such as and . + + + + + Gets or sets the border. + + + + + Gets or sets the fill. + + + + + Gets or sets the title font. + + + + + Gets or sets the title text color. + + + + + Gets or sets the title text. + + + + + Gets or sets the font. + + + + + Gets or sets the text color. + + + + + Gets or sets the border color. + + + + + Gets or sets the location of the scale. + + + + + Gets or sets the visibility of a scale. + + + + + Copies the contents of another ScaleBase. + + The ScaleBase instance to copy the contents from. + + + + Serializes the scale. + + Writer object. + Scale property name. + Another ScaleBase to compare with. + + This method is for internal use only. + + + + + Gets the size of the scale, in pixels. + + The SizeF structure containing the size of the object. + + + + Draws the object. + + Draw parameters. + Parent map object. + + + + Initializes a new instance of the class. + + + + + The base class for shape objects such as , and . + + + + + Gets or sets the shape visibility. + + + + + Gets or sets a value indicating that custom shape style is used. + + + If this property is false, the layer's DefaultShapeStyle is used. + + + + + Gets a custom shape style. + + + To use this property, first set the property to true. + + + + + Gets or sets the center point X offset. + + + Use this property to adjust the label's position. + + + + + Gets or sets the center point Y offset. + + + Use this property to adjust the label's position. + + + + + Gets or sets the shape X offset. + + + Use this property to adjust the shape position. + + + + + Gets or sets the shape Y offset. + + + Use this property to adjust the shape position. + + + + + Gets or sets the scale factor for this shape. + + + Use this property to adjust the shape size. + + + + + Gets or sets the spatial data associated with this shape. + + + + + Gets or sets the value. + + + + + Gets a reference to the parent Map object. + + + + + Gets a reference to the parent Layer object. + + + + + + + + Draws the shape. + + Object that provides a data for paint event. + + + + Draws the label. + + Object that provides a data for paint event. + + + + Checks if the shape is under cursor. + + The cursor coordinates. + true if the cursor is over the shape. + + + + Reduces the number of points in the shape. + + The accuracy value. + + + + + + + Initializes a component before running a report. + + + + + Finalizes a component before running a report. + + + + + Saves the state of this component. + + + + + Restores the state of this component. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Holds the list of objects of type. + + + + + Gets or sets the element at the specified index. + + Index of an element. + The element at the specified index. + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with specified owner. + + + + + Represents a line shape. + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Represents the spatial data of a shape. + + + + + Copies contents from another spatial data object. + + The object to copy contents from. + + + + Compares two spatial data objects. + + The spatial object to compare with. + true if spatial objects are identical. + + + + Gets a value by its key. + + The key of value. + The value. + + + + Sets a value by its key. + + The key of value. + The value. + + + + Gets a list of keys. + + The list of keys. + + + + Creates a new instance of the class. + + + + + Represents the style of a shape. + + + + + Gets or sets the border color. + + + + + Gets or sets the border style. + + + + + Gets or sets the border width. + + + + + Gets or sets the fill color. + + + + + Gets or sets the font. + + + + + Gets or sets the text color. + + + + + Gets or sets the point size, in pixels. + + + + + Copies contents from another similar object. + + The object to copy the contents from. + + + + Initializes a new instance of the class. + + + + + Represents a set of size ranges used to draw points based on analytical value. + + + + + Gets the list of ranges. + + + + + Gets or sets the number of ranges. + + + + + Gets or sets the start size. + + + + + Gets or sets the end size. + + + + + Gets or sets ranges as a string. + + + + + Copies the contents of another SizeRanges. + + The SizeRanges instance to copy the contents from. + + + + Gets a size associated with given analytical value. + + The analytical value. + The size associated with this value, or 0 if no association found. + + + + Initializes a new instance of the class. + + + + + Represents a single size range. + + + + + Gets or sets size of the range. + + + + + Gets or sets start value of the range. + + + + + Gets or sets end value of the range. + + + + + Copies the contents of another SizeRange. + + The SizeRange instance to copy the contents from. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a specified parameters. + + The size of the range. + The start value of the range. + The end value of the range. + + + + Represents the matrix object that is used to print pivot table (also known as cross-tab). + + + The matrix consists of the following elements: columns, rows and data cells. Each element is + represented by the descriptor. The class is used + for columns and rows; the is used for data cells. + The property holds three collections of descriptors - Columns, + Rows and Cells. + To create the matrix in a code, you should perform the following actions: + + + create an instance of the MatrixObject and add it to the report; + + + create descriptors for columns, rows and cells and add it to the + collections inside the property; + + + call the method to create the matrix template + that will be used to create a result; + + + modify the matrix template (change captions, set the visual appearance). + + + To connect the matrix to a datasource, use the property. If + this property is not set, the result matrix will be empty. In this case you may use + the event handler to fill the matrix. + + This example demonstrates how to create a matrix in a code. + + // create an instance of MatrixObject + MatrixObject matrix = new MatrixObject(); + matrix.Name = "Matrix1"; + // add it to the report title band of the first report page + matrix.Parent = (report.Pages[0] as ReportPage).ReportTitle; + + // create two column descriptors + MatrixHeaderDescriptor column = new MatrixHeaderDescriptor("[MatrixDemo.Year]"); + matrix.Data.Columns.Add(column); + column = new MatrixHeaderDescriptor("[MatrixDemo.Month]"); + matrix.Data.Columns.Add(column); + + // create one row descriptor + MatrixHeaderDescriptor row = new MatrixHeaderDescriptor("[MatrixDemo.Name]"); + matrix.Data.Rows.Add(row); + + // create one data cell + MatrixCellDescriptor cell = new MatrixCellDescriptor("[MatrixDemo.Revenue]", MatrixAggregateFunction.Sum); + matrix.Data.Cells.Add(cell); + + // connect matrix to a datasource + matrix.DataSource = Report.GetDataSource("MatrixDemo"); + + // create the matrix template + matrix.BuildTemplate(); + + // change the style + matrix.Style = "Green"; + + // change the column and row total's text to "Grand Total" + matrix.Data.Columns[0].TemplateTotalCell.Text = "Grand Total"; + matrix.Data.Rows[0].TemplateTotalCell.Text = "Grand Total"; + + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Allows to fill the matrix in code. + + + In most cases the matrix is connected to a datasource via the + property. When you run a report, the matrix is filled with datasource values automatically. + Using this event, you can put additional values to the matrix or even completely fill it + with own values (if is set to null. To do this, call the + Data.AddValue method. See the + method for more details. + + This example shows how to fill a matrix with own values. + + // suppose we have a matrix with one column, row and data cell. + // provide 3 one-dimensional arrays with one element in each to the AddValue method + Matrix1.Data.AddValue( + new object[] { 1996 }, + new object[] { "Andrew Fuller" }, + new object[] { 123.45f }); + Matrix1.Data.AddValue( + new object[] { 1997 }, + new object[] { "Andrew Fuller" }, + new object[] { 21.35f }); + Matrix1.Data.AddValue( + new object[] { 1997 }, + new object[] { "Nancy Davolio" }, + new object[] { 421.5f }); + + // this code will produce the following matrix: + // | 1996 | 1997 | + // --------------+--------+--------+ + // Andrew Fuller | 123.45| 21.35| + // --------------+--------+--------+ + // Nancy Davolio | | 421.50| + // --------------+--------+--------+ + + + + + + Allows to modify the prepared matrix elements such as cells, rows, columns. + + + + + Allows to modify the prepared matrix elements such as cells, rows, columns. + + + + + Gets or sets a value that determines whether the matrix must calculate column/row sizes automatically. + + + + + Gets or sets a value that determines how to print multiple data cells. + + + This property can be used if matrix has two or more data cells. Default property value + is false - that means the data cells will be stacked. + + + + + Gets or sets a value indicating that the side-by-side cells must be kept together on the same page. + + + + + Gets or sets a data source. + + + When you create the matrix in the designer by drag-drop data columns into it, + this property will be set automatically. However you need to set it if you create + the matrix in code. + + + + + Gets the row filter expression. + + + This property can contain any valid boolean expression. If the expression returns false, + the corresponding data row will be skipped. + + + + + Gets or sets a value indicating whether to show a title row. + + + + + Gets or sets a matrix style. + + + + + Gets or sets even style priority for matrix cells. + + + + + Gets or sets need split rows. + + + + + Gets or sets a value indicating that empty matrix should be printed. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + See the event for more details. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + See the event for more details. + + + + + Gets or sets a script method name that will be used to handle the + event. + + + See the event for more details. + + + + + Gets the object that holds the collection of descriptors used + to build a matrix. + + + See the class for more details. + + + + + Gets or sets array of values that describes the currently printing column. + + + Use this property when report is running. It can be used to highlight matrix elements + depending on values of the currently printing column. To do this: + + + select the cell that you need to highlight; + + + click the "Highlight" button on the "Text" toolbar; + + + add a new highlight condition. Use the Matrix.ColumnValues to + refer to the value you need to analyze. Note: these values are arrays of System.Object, + so you need to cast it to actual type before making any comparisons. Example of highlight + condition: (int)Matrix1.ColumnValues[0] == 2000. + + + + + + + + Gets or sets array of values that describes the currently printing row. + + + Use this property when report is running. It can be used to highlight matrix elements + depending on values of the currently printing row. To do this: + + + select the cell that you need to highlight; + + + click the "Highlight" button on the "Text" toolbar; + + + add a new highlight condition. Use the Matrix.RowValues to + refer to the value you need to analyze. Note: these values are arrays of System.Object, + so you need to cast it to actual type before making any comparisons. Example of highlight + condition: (string)Matrix1.RowValues[0] == "Andrew Fuller". + + + + + + + + Gets or sets the index of currently printing column. + + + This property may be used to print even columns with alternate color. To do this: + + + select the cell that you need to highlight; + + + click the "Highlight" button on the "Text" toolbar; + + + add a new highlight condition that uses the Matrix.ColumnIndex, + for example: Matrix1.ColumnIndex % 2 == 1. + + + + + + + + Gets or sets the index of currently printing row. + + + This property may be used to print even rows with alternate color. To do this: + + + select the cell that you need to highlight; + + + click the "Highlight" button on the "Text" toolbar; + + + add a new highlight condition that uses the Matrix.RowIndex, + for example: Matrix1.RowIndex % 2 == 1. + + + + + + + + + + + + + + + + + Creates or updates the matrix template. + + + Call this method after you modify the matrix descriptors using the + object's properties. + + + + + + + + + + + + + + + + + + + + + + + + + + This method fires the ManualBuild event and the script code connected to the ManualBuildEvent. + + Event data. + + + + This method fires the ModifyResult event and the script code connected to the ModifyResultEvent. + + Event data. + + + + This method fires the AfterTotals event and the script code connected to the AfterTotalsEvent. + + Event data. + + + + Adds a value in the matrix. + + Array of column values. + Array of row values. + Array of data values. + + This is a shortcut method to call the matrix Data.AddValue. + See the method for more details. + + + + + Gets the value of the data cell with the specified index. + + Zero-based index of the data cell. + The cell's value. + + Use this method in the cell's expression if the cell has custom totals + (the total function is set to "Custom"). The example: + Matrix1.Value(0) / Matrix1.Value(1) + will return the result of dividing the first data cell's value by the second one. + + + + + Initializes a new instance of the class. + + + + + Specifies the aggregate function used in the . + + + + + No aggregates are used. + + + + + Specifies the sum of values. + + + + + Specifies the minimum of values. + + + + + Specifies the maximum of values. + + + + + Specifies the average of values. + + + + + Specifies the count of values. + + + + + Specifies the count of distinct values. + + + + + Specifies the custom function. + + + + + Determines how matrix percents are calculated. + + + + + Do not calculate percent value. + + + + + Calculate percent of the column total value. + + + + + Calculate percent of the row total value. + + + + + Calculate percent of the grand total value. + + + + + The descriptor that is used to describe one matrix data cell. + + + The class is used to define one data cell of the matrix. + The key properties are and . + To set visual appearance of the data cell, use the + property. + The collection of descriptors used to represent the matrix data cells is stored + in the MatrixObject.Data.Cells property. + + + + + Gets or sets an aggregate function used to calculate totals for this cell. + + + + + Gets or sets a value that determines how to calculate the percent value for this cell. + + + + + + + + + + + Initializes a new instance of the class + with default settings. + + + + + Initializes a new instance of the class + with specified expression. + + The descriptor's expression. + + + + Initializes a new instance of the class + with specified expression and aggregate function. + + The descriptor's expression. + The aggregate function. + + + + Initializes a new instance of the class + with specified expression, aggregate function, and a percent. + + The descriptor's expression. + The aggregate function. + The percent setting. + + + + Represents a collection of matrix data descriptors used in the . + + + + + Gets or sets the element at the specified index. + + Index of an element. + The element at the specified index. + + + + Adds the specified descriptors to the end of this collection. + + Array of descriptors to add. + + + + Adds a descriptor to the end of this collection. + + Descriptor to add. + Index of the added descriptor. + + + + Inserts a descriptor into this collection at the specified index. + + The zero-based index at which value should be inserted. + The descriptor to insert. + + + + Removes the specified descriptor from the collection. + + Descriptor to remove. + + + + Returns the zero-based index of the first occurrence of a descriptor. + + The descriptor to locate in the collection. + The zero-based index of the first occurrence of descriptor within + the entire collection, if found; otherwise, -1. + + + + Determines whether a descriptor is in the collection. + + The descriptor to locate in the collection. + true if descriptor is found in the collection; otherwise, false. + + + + Copies the elements of this collection to a new array. + + An array containing copies of this collection elements. + + + + + + + + + + Contains a set of properties and methods to hold and manipulate the matrix descriptors. + + + This class contains three collections of descriptors such as , + and . Use collections' methods to add/remove + descriptors. When you are done, call the + method to refresh the matrix. + To fill a matrix in code, use the AddValue method. + + + + + Gets a collection of column descriptors. + + + Note: after you change something in this collection, call the + method to refresh the matrix. + + + + + Gets a collection of row descriptors. + + + Note: after you change something in this collection, call the + method to refresh the matrix. + + + + + Gets a collection of data cell descriptors. + + + Note: after you change something in this collection, call the + method to refresh the matrix. + + + + + Clears all descriptors. + + + + + Adds a value in the matrix. + + Array of column values. + Array of row values. + Array of data values. + + The number of elements in an array passed to this method must be the same as + a number of descriptors in the appropriate collection. That is, if your matrix + has one column, two row and one cell descriptors (in Columns, Rows and + Cells collections respectively), you have to pass one-element array for the + columnValues param, two-element array for the rowValues and one-element + array for the cellValues. + + This example demonstrates how to fill a simple matrix that contains one column, + row and cell. + + MatrixObject matrix; + matrix.Data.AddValue( + new object[] { 1996 }, + new object[] { "Andrew Fuller" }, + new object[] { 123.45f }); + + // this will produce the following result: + // | 1996 | + // --------------+----------+ + // Andrew Fuller | 123.45| + // --------------+----------+ + + + + + + Adds a value in the matrix. + + Array of column values. + Array of row values. + Array of data values. + Datasource row index. + + See the method for more details. + + + + + Gets a value with specified column, row and cell indicies. + + Index of a column. + Index of a row. + Index of a cell. + The value of a cell. + + + + Sets the cell's value. + + Index of a column. + Index of a row. + The new value. + + + + The base class for matrix element descriptors such as and + . + + + + + Gets or sets an expression which value will be used to fill the matrix. + + + Expression may be any valid expression. Usually it's a data column: + [DataSource.Column]. + + + + + Gets or sets the template column bound to this descriptor. + + + This property is for internal use; usually you don't need to use it. + + + + + Gets or sets the template row bound to this descriptor. + + + This property is for internal use; usually you don't need to use it. + + + + + Gets or sets the template cell bound to this descriptor. + + + Using this property, you may access the matrix cell which is bound to + this descriptor. It may be useful to change the cell's appearance. + + Before using this property, you must initialize the matrix descriptors by + calling the method. + + + + + MatrixObject matrix; + // change the fill color of the first matrix cell + matrix.Data.Cells[0].TemplateCell.Fill = new SolidFill(Color.Red); + + + + + + Assigns values from another descriptor. + + Descriptor to assign values from. + + + + + + + + + + Represents a collection of matrix header descriptors used in the . + + + + + Gets or sets the element at the specified index. + + Index of an element. + The element at the specified index. + + + + Adds the specified descriptors to the end of this collection. + + Array of descriptors to add. + + + + Adds a descriptor to the end of this collection. + + Descriptor to add. + Index of the added descriptor. + + + + Inserts a descriptor into this collection at the specified index. + + The zero-based index at which value should be inserted. + The descriptor to insert. + + + + Removes the specified descriptor from the collection. + + Descriptor to remove. + + + + Returns the zero-based index of the first occurrence of a descriptor. + + The descriptor to locate in the collection. + The zero-based index of the first occurrence of descriptor within + the entire collection, if found; otherwise, -1. + + + + Determines whether a descriptor is in the collection. + + The descriptor to locate in the collection. + true if descriptor is found in the collection; otherwise, false. + + + + Copies the elements of this collection to a new array. + + An array containing copies of this collection elements. + + + + Gets the list of indices of terminal items of this header. + + The list of indices. + + + + Gets the list of indices of terminal items of the header with specified address. + + The address of a header. + The list of indices. + + + + Removes a header item with the address specified. + + The address of a header. + + + + Gets an index of header with the address specified. + + The address of a header. + The index of header. + + + + Gets an index of header with the address specified. If there is no such header item, it will be created. + + The address of a header. + The index of header. + + + + + + + + + + The descriptor that is used to describe one element of the matrix header. + + + The class is used to define one header element of the matrix + (either the column element or row element). The key properties are + , and . + To set visual appearance of the element, use the + property. To set visual appearance of the "total" element, use the + property. + The collection of descriptors used to represent the matrix header is stored + in the MatrixObject.Data.Columns and MatrixObject.Data.Rows properties. + + + + + Gets or sets the sort order of header values. + + + This property determines how the values displayed in this element are sorted. The default sort + is ascending. + + + + + Gets or sets a value indicating that this element has associated "total" element. + + + To access the matrix cell that is bound to the "Total" element, use the + property. It may be useful to change the + "Total" text by something else. + + This example shows how to change the "Total" text of the total element. + + MatrixObject matrix; + matrix.Data.Rows[0].TemplateTotalCell.Text = "Grand Total"; + + + + + + Gets or sets the value indicating whether the total values must be printed before the data. + + + + + Gets or sets a value indicating that the page break must be printed before this element. + + + Page break is not printed before the very first element. + + + + + Gets or sets a value that determines whether it is necessary to suppress totals + if there is only one value in a group. + + + + + Gets or sets the template column bound to the "total" element of this descriptor. + + + This property is for internal use; usually you don't need to use it. + + + + + Gets or sets the template row bound to the "total" element of this descriptor. + + + This property is for internal use; usually you don't need to use it. + + + + + Gets or sets the template cell bound to the "total" element of this descriptor. + + + This property may be useful to change the "Total" text by something else. + + Before using this property, you must initialize the matrix descriptors by + calling the method. + + + This example shows how to change the "Total" element. + + MatrixObject matrix; + matrix.Data.Rows[0].TemplateTotalCell.Text = "Grand Total"; + matrix.Data.Rows[0].TemplateTotalCell.Fill = new SolidFill(Color.Green); + + + + + + + + + + + + Initializes a new instance of the class with + default settings. + + + + + Initializes a new instance of the class with + specified expression. + + The descriptor's expression. + + + + Initializes a new instance of the class with + specified expression and totals. + + The descriptor's expression. + Indicates whether to show the "total" element. + + + + Initializes a new instance of the class with + specified expression, sort order and totals. + + The descriptor's expression. + Sort order used to sort header values. + Indicates whether to show the "total" element. + + + + Updates HeaderWidth, HeaderHeight, BodyWidth, BodyHeight properties. + + + + + Describes how the even style is applied to a matrix. + + + + + The even style is applied to matrix rows. + + + + + The even style is applied to matrix columns. + + + + + Represents the chart object based on Microsoft Chart control. + + + FastReport uses Microsoft Chart library to display charts. This library is included + in .Net Framework 4.0. For .Net 3.5 it is available as a separate download here: + http://www.microsoft.com/downloads/details.aspx?FamilyID=130f7986-bf49-4fe5-9ca8-910ae6ea442c + This library requires .Net Framework 3.5 SP1. + To access Microsoft Chart object, use the property. It allows you + to set up chart appearance. For more information on available properties, refer to the + MS Chart documentation. + Chart object may contain one or several series. Each series is represented by two objects: + + + the Series that is handled by MS Chart. It is stored in the + Chart.Series collection; + + + the object that provides data for MS Chart series. + It is stored in the collection. + + + Do not operate series objects directly. To add or remove series, use + the and methods. These methods + handle Series and MSChartSeries in sync. + If you have a chart object on your Form and want to print it in FastReport, use + the method. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + + + + + + + + + + + + + + + + + + + Gets the collection of objects. + + + + + Gets a reference to the MS Chart object. + + + + + Gets or set Force automatically created series. + + + + + Gets or sets the data source. + + + + + Gets or sets the filter expression. + + + This filter will be applied to all series in chart. You may also use the series' + property to filter each series individually. + + + + + Gets or sets a value indicating that all series' data point should be aligned by its X value. + + + Using this property is necessary to print stacked type series. These series must have + equal number of data points, and the order of data points must be the same for all series. + + + + + Gets or set the data column or expression for automatically created series. + + + In order to create auto-series, you need to define one series that will be used as a + template for new series, and set up the property. + The value of this property will be a name of new series. If there is no series + with such name yet, the new series will be added. + + + + + Gets or set the color for auto-series. + + + If no color is specified, the new series will use the palette defined in the chart. + + + + + Gets or sets sort order for auto-series. + + + + + + + + Adds a new series. + + The type of series. + The new MSChartSeries object. + + + + Deletes a series at a specified index. + + Index of series. + + + + Assigns chart appearance, series and data from the + System.Windows.Forms.DataVisualization.Charting.Chart object. + + Chart object to assign data from. + + Use this method if you have a chart in your application and want to print it in FastReport. + To do this, put an empty MSChartObject in your report and execute the following code: + + report.Load("..."); + MSChartObject reportChart = report.FindObject("MSChart1") as MSChartObject; + reportChart.AssignChart(applicationChart); + report.Show(); + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the with default settings. + + + + + Represents the small chart object (called sparkline) fully based on MSChartObject. + + + + + + + + + + + Initializes a new instance of the with default settings. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Specifies how the series points are sorted. + + + + + Points are not sorted. + + + + + Points are sorted by X value. + + + + + Points are sorted by Y value. + + + + + Specifies the direction in which the series points are sorted. + + + + + Points are sorted in ascending order. + + + + + Points are sorted in descending order. + + + + + Specifies how the series points are grouped. + + + + + Points are not grouped. + + + + + Points are grouped by X value. + + + + + Points are grouped by number specified in the . + + + + + Points are grouped by Years. + + + + + Points are grouped by Months. + + + + + Points are grouped by Weeks. + + + + + Points are grouped by Days. + + + + + Points are grouped by Hours. + + + + + Points are grouped by Minutes. + + + + + Points are grouped by Seconds. + + + + + Points are grouped by Milliseconds. + + + + + Specifies which pie value to explode. + + + + + Do not explode pie values. + + + + + Explode the biggest value. + + + + + Explode the lowest value. + + + + + Explode the value specified in the property. + + + + + Specifies which data points to collect into one point. + + + + + Do not collect points. + + + + + Show top N points (N value is specified in the + property), collect other points into one. + + + + + Show bottom N points (N value is specified in the + property), collect other points into one. + + + + + Collect points which have Y value less than specified + in the property. + + + + + Collect points which have Y value less than percent specified + in the property. + + + + + Collect points which have Y value greater than specified + in the property. + + + + + Collect points which have Y value greater than percent specified + in the property. + + + + + Represents a MS Chart series wrapper. + + + This class provides a data for MS Chart series. The series itself is stored inside the + MS Chart and is accessible via the property. + You don't need to create an instance of this class directly. Instead, use the + method. + + + + + Gets os sets the data filter expression. + + + The filter is applied for this series only. You can also use the + property to set a filter that will be applied to all + series in a chart. + + + + + Gets or set the data column or expression for automatically created series. + + + In order to create auto-series, you need to define one series that will be used as a + template for new series, and set up the property. + The value of this property will be a name of new series. If there is no series + with such name yet, the new series will be added. + + + + + Gets or sets the sort method used to sort data points. + + + You have to specify the property as well. Data points in this series + will be sorted according selected sort criteria and order. + + + + + Gets or set Force automatically created series. + + + + + Gets or sets the sort order used to sort data points. + + + You have to specify the property as well. Data points in this series + will be sorted according selected sort criteria and order. + + + + + Gets or sets the group method used to group data points. + + + This property is mainly used when series is filled with data with several identical X values. + In this case, you need to set the property to XValue. All identical data points will be + grouped into one point, their Y values will be summarized. You can choose the summary function + using the property. + + + + + Gets or sets the group interval. + + + This value is used if property is set to Number. + + + + + Gets or sets the function used to group data points. + + + + + Gets or sets the collect method used to collect several data points into one. + + + This instrument for data processing allows to collect several series points into one point. + The collected point will be displaed using the text specified in the + property and color specified in the property. + For example, to display top 5 values, set this property to TopN and specify + N value (5) in the property. + + + + + Gets or sets the collect value used to collect several data points into one. + + + This property is used if the property is set to any value other than None. + + + + + Gets or sets the text for the collected value. + + + + + Gets or sets the color for the collected value. + + + If this property is set to Transparent (by default), the default palette color + will be used to display a collected point. + + + + + Gets or sets the method used to explode values in pie-type series. + + + + + Gets or sets the value that must be exploded. + + + This property is used if property is set + to SpecificValue. + + + + + Gets or sets the data column or expression that returns the X value of data point. + + + + + Gets or sets the data column or expression that returns the first Y value of data point. + + + + + Gets or sets the data column or expression returns the second Y value of data point. + + + + + Gets or sets the data column or expression returns the third Y value of data point. + + + + + Gets or sets the data column or expression returns the fourth Y value of data point. + + + + + Gets or sets the data column or expression that returns the color of data point. + + + + + Gets or sets the data column or expression returns the label value of data point. + + + + + Gets a reference to MS Chart Series object. + + + Use this property to set many options available for the Series object. These options + include: visual appearance, labels, marks, value types. Refer to the Microsoft Chart control + documentation to learn more. + + + + + Gets a number of Y value per data point. + + + Number of Y values depends on series type. Most of series have only one Y value. Financial + series such as Stock and Candlestick, use four Y values. + + + + + This property is not relevant to this class. + + + + + + + + + + + + + + Clears all data points in this series. + + + + + Adds a data point with specified X and Y values. + + X value. + Array of Y values. + + Note: number of values in the yValues parameter must be the same as value returned + by the property. + + + + + + + + Creates a new instance of the class with default settings. + + + + + Represents a collection of objects. + + + + + Gets the element at the specified index. + + Index of an element. + The element at the specified index. + + + + Resets series data. + + + + + Processes the current data row. + + + + + Finishes the series data. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + SVG object + + + + + + + + + + + + + + Invokes the object's editor. + + true if object was edited succesfully. + + + + Gets or sets svg document + + + + + Gets or sets ViewBox value + + + + + Gets or sets AspectRatio value + + + + + + + + Gets or sets grayscale svg document + + + + + Gets or sets a value indicating that the image should be displayed in grayscale mode. + + + + + Returns SVG string + + + + + + + + + + + + + + + + + + + + + + + Returns clone of this object + + + + + + Sets svg object by SvgDocument + + SVG document + + + + Sets svg object from specified path + + path to SVG file + + + + Sets svg object from svg string + + SVG string + + + + Initializes a new instance of the class with default settings. + + + + + Represents a table row. + + + Use the property to set the height of a row. If + property is true, the row will calculate its height automatically. + You can also set the and properties + to restrict the row's height. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + + + + + + + + + + Gets or sets a height of the row, in pixels. + + + The row height cannot exceed the range defined by the + and properties. + To convert between pixels and report units, use the constants defined + in the class. + + + + + Gets or sets the minimal height for this row, in pixels. + + + + + Gets or sets the maximal height for this row, in pixels. + + + + + Gets or sets a value determines if the row should calculate its height automatically. + + + The row height cannot exceed the range defined by the + and properties. + + + + + Gets or sets a value that determines if the component can break its contents across pages. + + + + + Gets the index of this row. + + + + + + + + Gets or sets the cell with specified index. + + Column index. + The TableCell object. + + + + Gets or sets the page break flag for this row. + + + + + Gets or sets the number of rows to keep on the same page. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Represents a table object that consists of several rows and columns. + + + To add/remove columns, use the collection. To add/remove + rows, use the collection. To initialize a table with specified number of + columns and rows, use and properties. + To print a table in code, use the event. In the manual build + mode, you can use aggregate functions. The following functions available: + + + Aggregate function + Description + + + Sum(cell) + Calculates the sum of values in specified table cell. + + + Min(cell) + Calculates the minimum of values in specified table cell. + + + Max(cell) + Calculates the maximum of values in specified table cell. + + + Avg(cell) + Calculates the average of values in specified table cell. + + + Count(cell) + Calculates the number of repeats of a specified table cell. + + + To print aggregate value, place the aggregate function call in the table cell: + [Count(Cell2)]. + + + + + + + + + + + + + + + + + + + + + + + + + + Represent expanding tags for add a new row/column. + + + + + Draw expanding tag. + + + + + + Allows to print table rows/columns dynamically. + + + This event is used to handle the table print process in a code. Using special methods + like , you can print specified rows/columns. + + First way is to repeat specified row(s) to get a table that will grow downwards. + To do this, you have to call the PrintRow method followed by the PrintColumns method. + + Another way is to repeat the specified column(s) to get a table that grows sidewards. + To do this, call the PrintColumn method followed by the PrintRows method. + + Finally, the third way is to repeat rows and columns. The table will grow downwards and + sidewards. To do this, call the PrintRow method followed by the PrintColumn + method (or vice versa). + + + + When you print a table row-by-row, you must call one of the PrintColumn, + PrintColumns methods right after the PrintRow method. + In the same manner, when you print a table column-by-column, call one of the + PrintRow, PrintRows methods right after the PrintColumn method. + If you ignore this rule you will get an exception. + + + + In this example, we will consider all three ways to print a table which has 3 rows and 3 columns. + Case 1: print a table downwards. + + // print table header (the first row) + Table1.PrintRow(0); + Table1.PrintColumns(); + // print table body (the second row) + for (int i = 0; i < 10; i++) + { + Table1.PrintRow(1); + Table1.PrintColumns(); + } + // print table footer (the third row) + Table1.PrintRow(2); + Table1.PrintColumns(); + + + Case 2: print a table sidewards. + + // print table header (the first column) + Table1.PrintColumn(0); + Table1.PrintRows(); + // print table body (the second column) + for (int i = 0; i < 10; i++) + { + Table1.PrintColumn(1); + Table1.PrintRows(); + } + // print table footer (the third column) + Table1.PrintColumn(2); + Table1.PrintRows(); + + + Case 3: print a table downwards and sidewards. + + // print the first row with all its columns + Table1.PrintRow(0); + // print header column + Table1.PrintColumn(0); + // print 10 data columns + for (int i = 0; i < 10; i++) + { + Table1.PrintColumn(1); + } + // print footer column + Table1.PrintColumn(2); + + // print table body (the second row) + for (int i = 0; i < 10; i++) + { + // print data row with all its columns + Table1.PrintRow(1); + Table1.PrintColumn(0); + for (int j = 0; j < 10; j++) + { + Table1.PrintColumn(1); + } + Table1.PrintColumn(2); + } + + // print table footer (the third row) + Table1.PrintRow(2); + // again print all columns in the table footer + Table1.PrintColumn(0); + for (int i = 0; i < 10; i++) + { + Table1.PrintColumn(1); + } + Table1.PrintColumn(2); + + + + + + Gets or sets a script method name that will be used to handle the + event. + + + If you use this event, you must handle the table print process manually. + See the event for details. + + + + + Determines whether to manage cell spans automatically during manual build. + + + The default value for this property is true. If you set it to false, you need to manage + spans in your ManualBuild event handler. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This method fires the ManualBuild event and the script code connected to the ManualBuildEvent. + + Event data. + + + + Prints a row with specified index. + + Index of a row to print. + + See the event for more details. + + + + + Prints rows with specified indices. + + Indices of rows to print. + + See the event for more details. + + + + + Prints all rows. + + + See the event for more details. + + + + + Prints a column with specified index. + + Index of a column to print. + + See the event for more details. + + + + + Prints columns with specified indices. + + Indices of columns to print. + + See the event for more details. + + + + + Prints all columns. + + + See the event for more details. + + + + + Adds a page before rows or columns. + + + Call this method to insert a page break before the next row or column that you intend to print + using PrintRow(s) or PrintColumn(s) methods. + See the event for more details. + + + + + Initializes a new instance of the class. + + + + + Represents a table column. + + + Use the property to set the width of a column. If + property is true, the column will calculate its width automatically. + You can also set the and properties + to restrict the column's width. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + + + + + + + + + + Gets or sets a width of the column, in pixels. + + + The column width cannot exceed the range defined by the + and properties. + To convert between pixels and report units, use the constants defined + in the class. + + + + + Gets or sets the minimal width for this column, in pixels. + + + + + Gets or sets the maximal width for this column, in pixels. + + + + + Gets or sets a value determines if the column should calculate its width automatically. + + + The column width cannot exceed the range defined by the + and properties. + + + + + Gets the index of this column. + + + + + + + + Gets or sets the page break flag for this column. + + + + + Gets or sets the number of columns to keep on the same page. + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Represents a table cell. + + + Use , properties to set the cell's + column and row spans. To put an object inside the cell, use its property: + + TableCell cell1; + PictureObject picture1 = new PictureObject(); + picture1.Bounds = new RectangleF(0, 0, 32, 32); + picture1.Name = "Picture1"; + cell1.Objects.Add(picture1); + + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets a collection of objects contained in this cell. + + + + + Gets or sets the column span for this cell. + + + + + Gets or sets the row span for this cell. + + + + + + + + Gets or sets a value that determines how to display duplicate values in the cells of the same group. + + + + + Ges or sets data associated with this cell. For internal use only. + + + + + Gets the address of this cell. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + + + + + + + Gets the TableBase object which this cell belongs to. + + + + + + + + Creates the exact copy of this cell. + + The copy of this cell. + + + + Determines if two cells have identical settings. + + Cell to compare with. + true if cells are equal. + + + + + + + Changes the cell's style. + + The new style. + + Each cell in a dynamic table object (or in a matrix) has associated style. + Several cells may share one style. If you try to change the cell's appearance directly + (like setting cell.TextColor), it may affect other cells in the table. + To change the single cell, use this method. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + The base class for table-type controls such as and + . + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + + + + This property is not relevant to this class. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets a collection of table rows. + + + + + Gets a collection of table columns. + + + + + Gets or sets the number of fixed rows that will be repeated on each page. + + + + + Gets or sets the number of fixed columns that will be repeated on each page. + + + + + Gets or sets the value that determines whether to print the dynamic table (or matrix) on its parent band directly. + + + By default the dynamic table (matrix) is printed on its own band and is splitted on pages if necessary. + + + + + Gets or sets a value that determines whether is necessary to repeat table header on each page. + + + To define a table header, set the and + properties. + + + + + Gets or sets a value that determines whether is necessary to repeat table Row header on each page. + + + To define a table Row header, set the + properties. + + + + + Gets or sets a value that determines whether is necessary to repeat table Column header on each page. + + + To define a table Column header, set the + properties. + + + + + Gets or sets the table layout. + + + This property affects printing the big table that breaks across pages. + + + + + Gets or sets gap between parts of the table in wrapped layout mode. + + + This property is used if you set the property to Wrapped. + + + + + Gets or sets a value that determines whether to adjust the spanned cell's width when breaking the table across pages. + + + If set to true, the spanned cell's width will be adjusted to accomodate all contained text. + + + + + Gets or sets the table cell. + + Column index. + Row index. + The TableCell object that represents a cell. + + + + Gets or sets a number of columns in the table. + + + + + Gets or sets a number of rows in the table. + + + + + Gets a table which contains the result of rendering dynamic table. + + + Use this property to access the result of rendering your table in dynamic mode. + It may be useful if you want to center or right-align the result table on a page. + In this case, you need to add the following code at the end of your ManualBuild event handler: + + // right-align the table + Table1.ResultTable.Left = Engine.PageWidth - Table1.ResultTable.CalcWidth() - 1; + + + + + + + + + + + + + + + Gets data of the table cell with specified column and row numbers. + + The column number. + The row number. + TableCellData instance containing data of the table cell. + + + + Creates unique names for all table elements such as rows, columns, cells. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Calculates and returns the table width, in pixels. + + + + + + + + + + + Calculates a sum of values in a specified cell. + + The cell. + The object that contains calculated value. + + This method can be called from the ManualBuild event handler only. + + + + + Calculates a minimum of values in a specified cell. + + The cell. + The object that contains calculated value. + + This method can be called from the ManualBuild event handler only. + + + + + Calculates a maximum of values in a specified cell. + + The cell. + The object that contains calculated value. + + This method can be called from the ManualBuild event handler only. + + + + + Calculates an average of values in a specified cell. + + The cell. + The object that contains calculated value. + + This method can be called from the ManualBuild event handler only. + + + + + Calculates number of repeats of a specified cell. + + The cell. + The object that contains calculated value. + + This method can be called from the ManualBuild event handler only. + + + + + Initializes a new instance of the class. + + + + + Specifies the layout that will be used when printing a big table. + + + + + The table is printed across a pages then down. + + + + + The table is printed down then across a pages. + + + + + The table is wrapped. + + + + + Specifies how to display the duplicate values. + + + + + The TableCell can show duplicate values. + + + + + The TableCell with duplicate value will be shown but with no text. + + + + + Several TableCell objects with the same value will be merged into one object. + + + + + Several TableCell objects with the same non-empty value will be merged into one object. + + + + + Represents data of the table cell. + + + + + Gets or sets parent table of the cell. + + + + + Gets or sets objects collection of the cell. + + + + + Gets or sets text of the table cell. + + + + + Gets or sets value of the table cell. + + + + + Gets or sets hyperlink value of the table cell. + + + + + Gets or sets column span of the table cell. + + + + + Gets or sets row span of the table cell. + + + + + Gets or sets the address of the table cell. + + + + + Gets the table cell. + + + + + Gets style of table cell. + + + + + Gets original the table cell. + + + + + Gets width of the table cell. + + + + + Gets height of the table cell. + + + + + Initializes a new instance of the class. + + + + + Attaches the specified table cell. + + The table cell instance. + This method is called when we load the table. + + + + Assigns another instance. + + The table cell data that used as a source. + This method is called when we copy cells or clone columns/rows in a designer. + + + + Assigns another instance at run time. + + The table cell data that used as a source. + This flag shows should children be copied or not. + This method is called when we print a table. We should create a copy of the cell and set the style. + + + + Sets style of the table cell. + + The new style of the table cell. + + + + Disposes the instance. + + + + + Calculates width of the table cell. + + The value of the table cell width. + + + + Calculates height of the table cell. + + The width of the table cell. + The value of the table cell height. + + + + Represents a collection of objects. + + + + + Gets a column with specified index. + + Index of a column. + The column with specified index. + + + + + + + + + + Represents a result table. + + + Do not use this class directly. It is used by the and + objects to render a result. + + + + + Occurs after calculation of table bounds. + + + You may use this event to change automatically calculated rows/column sizes. It may be useful + if you need to fit dynamically printed table on a page. + + + + + + + + + + + Creates a new instance of the class. + + + + + Represents a collection of objects. + + + + + Gets a row with specified index. + + Index of a row. + The row with specified index. + + + + + + + + + + Represents the "Blank Report" wizard. + + + + + + + + Represents the "Inherited Report" wizard. + + + + + + + + Represents the "Label" wizard. + + + + + Gets a selected label manufacturer. + + + + + Gets a selected label name. + + + + + Gets the XML item containing a selected label parameters. + + + + + + + + Initializes a new instance of the class with the default settings. + + + + + Represents the "New Data Source" wizard. + + + + + + + + Represents the "Standard Report" wizard. + + + + + + + + The base class for all report wizards. + + + To create own wizard, use this class as a base. All you need is to override + the method. To register a wizard, use the + method. + + + + + Runs the wizard. + + Report designer. + true if wizard was executed succesfully. + + This method is called when you select a wizard in the "Add New Item" window and + click "Add" button. You should do the work in this method. + + + + + Represents the "New Dialog" wizard. + + + + + + + + Represents the "New Page" wizard. + + + + + + + + Represents a RichText object that can display formatted text. + + + Use the property to set the object's text. The text may include + the RTF formatting tags. + + + + + + + + + + + + + + Gets or sets the object's text. + + + This property returns the formatted text with rtf tags. + + + + + Gets or sets a name of the data column bound to this control. + + + Value must contain the datasource name, for example: "Datasource.Column". + + + + + Gets the actual text start. + + + This property is for internal use only; you should not use it in your code. + + + + + Gets the actual text length. + + + This property is for internal use only; you should not use it in your code. + + + + + Gets or sets the break style. + + + Set this property to true if you want editable rich text when you edit the prepared report page. + + + + + Experimental feature for translation of RichText into report objects + + + + + This property not described + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Called from RichObject.CalcHeight() + + + + + + The DIGEST-MD5 SASL authentication mechanism. + + + + + The mechanism name. + + + + + Initializes a new instance of the class. + + The username. + The user's password. + + + + + + + The PLAIN SASL authentication mechanism. + + + + + The mechanism name. + + + + + Initializes a new instance of the class. + + The username. + The user's password. + + + + Computes the client response for server challenge. + + The challenge from server. Usually empty for PLAIN mechanism. + The response from client. + + + + The base abstarct class for all SASL mechanisms. + + + + + Gets or sets the name of mechanism. + + + + + Gets or sets the username. + + + + + Gets or sets the user's password. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified parameters. + + The username. + The user's password. + + + + Computes client response for server challenge. + + The server challenge. + The client response. + + + + Gets the base64-encoded client response fo the server challenge. + + The base64-string containing server challenge. + The base64-string containing client response. + + + + Gets the client response for the server challenge. + + Byte array containing server challenge. + Byte array containing client response. + + + + The base class for all messengers. + + + + + Gets the filename. + + + + + Gets or sets the proxy settings. + + + + + Initializes a new instance of the class. + + + + + Authorizes the user. + + True if user has been successfully authorized. + + + + Prepares the report before it will be send. + + The report template. + The export filter. + Memory stream that contains prepared report. + + + + Sends the report. + + The report template that should be sent. + The export filter that should export template before. + True if report has been successfully sent. + + + + Represents form of messenger. + + + + + Gets or sets the report template. + + + + + Gets or sets the list of exports. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The report template. + + + + Initializes the list of exports. + + + + + Gets the proxy settings. + + The proxy settings. + + + + Initializes the component. + + + + + Checks is the string numeric. + + The checking string. + True if string is numeric, otherwise false. + + + + Finishes the form work. + + Returns true if work has been successfully finished, otherwise false. + + + + + + + SelectedIndexChanged event handler for ComboBox File Type. + + Event sender. + Event args. + + + + Click event handler for Button Settings. + + Event sender. + Event args. + + + + FormClosing event handler for CloudStorageClientForm. + + Event sender. + Event args. + + + + Click event handler for button OK. + + Event sender. + Event args. + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Page File. + + + + + Page Proxy. + + + + + ComboBox File Type. + + + + + Label File Type. + + + + + Buttons Settings. + + + + + Label Colon. + + + + + Label Password. + + + + + Label Username. + + + + + Label Server. + + + + + TextBox Username. + + + + + TextBox Port. + + + + + TextBox Server. + + + + + TextBox Password. + + + + + PageControl pageControl1. + + + + + Represents proxy settings of the messenger. + + + + + Gets or sets the proxy server. + + + + + Gets or sets the port number of proxy server. + + + + + Gets or sets the username. + + + + + Gets or sets the user's password. + + + + + Gets or sets the type of proxy. + + + + + Initializes a new instance of the class. + + The proxy server. + The port number of server. + The username. + The user's password. + The type of proxy. + + + + Represents the type of rpoxy. + + + + + The HTTP proxy type. + + + + + The SOCKS4 proxy type. + + + + + The SOCKS5 proxy type. + + + + + Represents the IQ stanza. + + + + + Gets or sets the type of iq. + + + + + Initializes a new instance of the class with specified parameters. + + The namespace of the iq. + The type of iq. + The JID of the sender. + The JID of the recipient. + The ID of the iq. + The language of the iq. + The data of the iq. + + + + Initializes a new instance of the class using specified XmlElement instance. + + The XmlElement instance using like a data. + + + + Represents the XMPP message. + + + + + Gets or sets the type of message. + + + + + Initializes a new instance of the class with specified parameters. + + The namespace of the message. + The type of message. + The JID of the sender. + The JID of the recipient. + The ID of the message. + The language of the message. + The data of the message. + + + + Initializes a new instance of the class using specified XmlElement instance. + + The XmlElement instance using like a data. + + + + Represents the XMPP Presence. + + + + + Initializes a new instance of the class with specified parameters. + + The namespace of the presence. + The JID of the sender. + The JID of the recipient. + The ID of the presence. + The language of the presence. + The data of the presence. + + + + Initializes a new instance of the class using specified XmlElement instance. + + The XmlElement instance using like a data. + + + + Represents the base class for XML stanzas used in XMPP. + + + + + Gets the data of the stanza. + + + + + Gets or sets the JID of the sender. + + + + + Gets or sets the JID of the recipient. + + + + + Gets or sets the ID of the stanza. + + + + + Gets or sets the language of the stanza. + + + + + Initializes a new instance of the class with specified parameters. + + The namespace of the stanza. + The JID of the sender. + The JID of the recipient. + The ID of the stanza. + The language of the stanza. + The data of the stanza. + + + + Initializes a new instance of the class using specified XmlElement instance. + + The XmlElement instance using like a data. + + + + Converts stanza to string. + + String containing stanza value. + + + + The parser for XMPP XML-streams. + + + + + Initializes a new instance of the class. + + The stream for parsing. + True to leave the stream opened after closing the StreamReader instance. + + + + Read the XML stream up to opening "stream:stream" tag. + + + + + Reads the next XML element from the stream. + + The list of XML elements that are expected. + The XML element. + + + + Closes the stream parser. + + + + + Releases all resources used by the current instance of the class. + + + + + Represents a static class to simplify the work with XmlElement instance. + + + + + Creates a new XmlElement instance. + + The name of the element. + The namespace of the element. + A new instance of the class. + + + + Adds the specified child to the end of child nodes of element. + + The element for add the child to. + The child node to add. + A XmlElement instance. + + + + Adds the attribute to XmlElement with spefied name and value. + + The element for add the attribute to. + The name of attribute. + The value of attribute. + A XmlElement instance. + + + + Adds the specified text to the end of child nodes of element. + + The element for add the text to. + The text for add. + A XmlElement instance. + + + + Converts the XmlElement instance to a string. + + The element to convert to. + True if needed to include XML declaration. + True if needed to leave the tag of an empty element open. + The XmlElement instance as string. + + + + Represents the XMPP messenger. + + + + + Gets or sets the username. + + + + + Gets or sets the user's password. + + + + + Gets or sets the hostname of XMPP server. + + + + + Gets or sets the port number of the XMPP service of the server. + + + + + Gets or sets the username to send file to. + + + + + Gets or sets the JID to send from. + + + + + Gets or set the JID to send to. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified parameters. + + Username. + Password. + Hostname. + Port. + Username to send file to. + Send to user's resource. + + + + Initializes a new instance of the class with specified parameters. + + User's JID without resource. + User's password. + JID to send to with resource. + + + + Sends the specified string to the server. + + The string to send. + + + + Initiates the stream to the server. + + The hostname. + The features response of the server. + + + + Validates the server certificate. + + The sender object. + X509 certificate. + The X509 chain. + The SSL policy errors. + True if successfull. + + + + Secures the stream by TLS. + + The hostname. + The features response of the server. + + + + Selects the SASL authentication mechanism. + + List of mechanisms. + The string containing mechanism name. + + + + Authenticates the user on the server using Plain mechanism. + + + + + Authenticates the user on the server using Digest-MD5 mechanism. + + + + + Authenticates the user on the server. + + The SASL mechanisms list. + + + + Setups the connection with the server. + + + + + Binds resource and gets the full JID that will be associated with current session. + + The full session JID. + + + + Opens session between client and server. + + The id of the opened session. + + + + Connects to the server. + + + + + Sends the message. + + The text of the message. + True if message has been successfully sent. + + + + Sends the presence. + + The text of the presence. + True if presence has been successfully sent. + + + + Initiates the In Band Bytestream for sending the file (XEP-0047). + + True if bytestream has been successfully initiated. + + + + Sends the chunk to the XMPP server. + + The data of the chunk. + The number of the chunk. + + + + Sends the file using In Band Bytestream. + + The memory stream containing data of the file. + True if file has been successfully sent. + + + + Sends the file using FastReport Cloud as a proxy server. + + The report template. + The export filter to export report before sending. + True if file has been successfully sent. + + + + Disconnects from the server. + + + + + + + + + + + Closes the connection. + + + + + Releases all the resources used by the XMPP messenger. + + + + + Represents the form of the XMPP messenger. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified parameters. + + User's JID without resource. + User's password. + Send to user's JID. + Report template. + + + + + + + + + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Provides a type converter for a property representing a reference to another component in a report. + + + + + + + + + + + + + + + + + Blocks keyboard editing, you need to select a value from the drop-down list for editing + + + + + Provides a type converter for a property representing a value measured in the current report units. + + + + + + + + + + + + + + + + + Provides a type converter for a property representing an expandable object. + + + + + + + + + + + + + + + + + Provides a type converter for a property representing a data type. + + + + + + + + + + + + + + + + + The FastReport.dll assembly initializer. + + + + + Registers all core objects, wizards, export filters. + + + + + The FastReport dll assembly initializer. + + + + + Registers all core objects, wizards, export filters. + + + + + Represents a collection of bands. + + + + + Gets or sets the element at the specified index. + + Index of an element. + The element at the specified index. + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with specified owner. + + Owner that owns this collection. + + + + The layout of the data band columns. + + + + + Print columns across then down. + + + + + Print columns down then across. + + + + + This class holds the band columns settings. It is used in the property. + + + + + Gets or sets the number of columns. + + + Set this property to 0 or 1 if you don't want to use columns. + + + + + The column width, in pixels. + + + + + Gets or sets the layout of the columns. + + + + + Gets or sets the minimum row count that must be printed. + + + This property is used if the Layout property is set to DownThenAcross. 0 means that + FastReport should calculate the optimal number of rows. + + + + + Assigns values from another source. + + Source to assign from. + + + + Initializes a new instance of the BandColumns class with default settings. + + + + + Specifies a set of actions that cannot be performed on the object in the design mode. + + + + + Specifies no restrictions. + + + + + Restricts moving the object. + + + + + Restricts resizing the object. + + + + + Restricts modifying the object's properties. + + + + + Restricts editing the object. + + + + + Restricts deleting the object. + + + + + Hides all properties of the object. + + + + + Specifies a set of actions that can be performed on the object in the design mode. + + + + + Specifies no actions. + + + + + Allows moving the object. + + + + + Allows resizing the object. + + + + + Allows deleting the object. + + + + + Allows editing the object. + + + + + Allows changing the Z-order of an object. + + + + + Allows moving the object to another parent. + + + + + Allows copying the object to the clipboard. + + + + + Allows drawing the object. + + + + + Allows grouping the object. + + + + + Allows write children in the preview mode by itself. + + + + + Allows write object's bounds into the report stream. + + + + + Allows the "smart tag" functionality. + + + + + Specifies that the object's name is global (this is true for all report objects + such as Text, Picture and so on). + + + + + Specifies that the object can display children in the designer's Report Tree window. + + + + + Specifies that the object supports mouse wheel in the preview window. + + + + + Specifies the style of a border line. + + + + + Specifies a solid line. + + + + + Specifies a line consisting of dashes. + + + + + Specifies a line consisting of dots. + + + + + Specifies a line consisting of a repeating pattern of dash-dot. + + + + + Specifies a line consisting of a repeating pattern of dash-dot-dot. + + + + + Specifies a double line. + + + + + Specifies a custom line. + + + + + Specifies the sides of a border. + + + + + Specifies no border lines. + + + + + Specifies the left border line. + + + + + Specifies the right border line. + + + + + Specifies the top border line. + + + + + Specifies the bottom border line. + + + + + Specifies all border lines. + + + + + Represents a single border line. + + + + + Gets or sets a color of the line. + + + + + Gets or sets a style of the line. + + + + + Gets or sets a width of the line, in pixels. + + + + + + + + + + + Represents a border around the report object. + + + Border consists of four lines. Each line has own color, style and width. Lines are accessible through + , , , properties. + + To turn on and off the lines, use the property. To set the same color, style or width + for each line, use , , properties of the Border. + + + + + Gets or sets a color of the border. + + + This property actually returns a color of the . When you assign a value + to this property, the value will be set to each border line. + + + + + Gets or sets a value determines whether to draw a shadow. + + + + + Gets or sets a shadow width, in pixels. + + + + + Gets or sets a shadow color. + + + + + Gets or sets a style of the border. + + + This property actually returns a style of the . When you assign a value + to this property, the value will be set to each border line. + + + + + Gets or sets a visible lines of a border. + + + + + Gets or sets a width of the border, in pixels. + + + This property actually returns a width of the . When you assign a value + to this property, the value will be set to each border line. + + + + + Gets or sets the left line of the border. + + + + + Gets or sets the top line of the border. + + + + + Gets or sets the right line of the border. + + + + + Gets or sets the bottom line of the border. + + + + + Gets or sets a value determines that Border must serialize only one line. + + + This property is for internal use only. + + + + + Creates the exact copy of this Border. + + A copy of this border. + + + + + + + + + + Serializes the border. + + Writer object. + Border property name. + Another Border to compare with. + + This method is for internal use only. + + + + + Draw the border using draw event arguments and specified bounding rectangle. + + Draw event arguments. + Bounding rectangle. + + This method is for internal use only. + + + + + Initializes a new instance of the class with default settings. + + + + + Base class for report components that can break across pages. + + + + + Gets or sets a value that determines if the component can break its contents across pages. + + + + + Gets or sets a reference to another similar object that will be used for displaying the + text that not fit in this object. + + + + + + + + + + + Breaks the contents of the object. + + Object to put the part of content to that does not fit in this object. These two + objects must have the same type. + true if there is enough space in this object to display at least one text line. + + + Do not call this method directly, it is used by the report engine. You should override it if + you are writing a new FastReport object. + + + This method must break the contents of the object. The part of content that fit in current object's + bounds should remain in this object, the part that does not fit should be transferred to breakTo + object. + + + + + + Initializes a new instance of the BreakableComponent class with default settings. + + + + + Specifies a line cap style. + + + + + Specifies a line without a cap. + + + + + Specifies a line with a circle cap. + + + + + Specifies a line with a square cap. + + + + + Specifies a line with a diamond cap. + + + + + Specifies a line with an arrow cap. + + + + + Specifies a start and end line caps. + + + + + Gets or sets a width of the cap. + + + + + Gets or sets a height of the cap. + + + + + Gets or sets a cap style. + + + + + Assigns values from another source. + + Source to assign from. + + + + Creates exact copy of this object. + + Copy of this object. + + + + + + + + + + Serializes the cap settings. + + Name of the cap property. + Writer object. + Another cap to compare with. + + This method is for internal use only. + + + + + Initializes a new instance of the CapSettings class with default settings. + + + + + Specifies a symbol that will be displayed when a is in the checked state. + + + + + Specifies a check symbol. + + + + + Specifies a diagonal cross symbol. + + + + + Specifies a plus symbol. + + + + + Specifies a filled rectangle. + + + + + Specifies a symbol that will be displayed when a is in the unchecked state. + + + + + Specifies no symbol. + + + + + Specifies a diagonal cross symbol. + + + + + Specifies a minus symbol. + + + + + Specifies a slash symbol. + + + + + Specifies a back slash symbol. + + + + + This class represents a column footer band. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + Initializes a new instance of the class with default settings. + + + + + This class represents a column header band. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + Initializes a new instance of the class with default settings. + + + + + Represents a collection of highlight conditions used in the property + of the . + + + + + Gets or sets the element at the specified index. + + Index of an element. + The element at the specified index. + + + + Adds the specified elements to the end of this collection. + + Array of elements to add. + + + + Adds an object to the end of this collection. + + Object to add. + Index of the added object. + + + + Inserts an object into this collection at the specified index. + + The zero-based index at which value should be inserted. + The object to insert. + + + + Removes the specified object from the collection. + + Object to remove. + + + + Returns the zero-based index of the first occurrence of an object. + + The object to locate in the collection. + The zero-based index of the first occurrence of value within the entire collection, if found; + otherwise, -1. + + + + Determines whether an element is in the collection. + + The object to locate in the collection. + true if object is found in the collection; otherwise, false. + + + + + + + + + + Copies conditions from another collection. + + Collection to copy from. + + + + + + + + + + This class represents a data band footer. + + + + + This class represents a header of the data band. + + + + + Specifies the image format in SVG export. + + + + + Specifies the .png format. + + + + + Specifies the .jpg format. + + + + + Drawing objects to a svg + + + + + For setting namespace, clear all attributes on setting, therefore use this property before setting other svg options + + + + + Initialize a new Graphics for SVG, it's rendered to xml, layer by layer, not one image, + set the Size of this graphics in Size property + + + + + Sets or gets prefix for style and object ids + + + + + Base class for all fills. + + + + + Returned true if Color = Transparent + + + + + Creates exact copy of this fill. + + Copy of this object. + + + + Creates the GDI+ Brush object. + + Drawing rectangle. + Brush object. + + + + Creates the GDI+ Brush object with scaling. + + Drawing rectangle. + X scaling coefficient. + Y scaling coefficient. + Brush object. + + + + Serializes the fill. + + Writer object. + Name of the fill property. + Fill object to compare with. + + This method is for internal use only. + + + + + Fills the specified rectangle. + + Draw event arguments. + Drawing rectangle. + + + + Class represents the solid fill. + + + + + Gets or sets the fill color. + + + + + + + + + + + + + + + + + + + + + + + Initializes the class with Transparent color. + + + + + Initializes the class with specified color. + + + + + + Class represents the linear gradient fill. + + + + + Gets or sets the start color of the gradient. + + + + + Gets or sets the end color of the gradient. + + + + + Gets or sets the angle of the gradient. + + + + + Gets or sets the focus point of the gradient. + + + Value is a floating point value from 0 to 1. + + + + + Gets or sets the gradient contrast. + + + Value is a floating point value from 0 to 1. + + + + + + + + + + + + + + + + + + + + Initializes the class with default settings. + + + + + Initializes the class with start and end colors. + + Start color. + End color. + + + + Initializes the class with start, end colors and angle. + + Start color. + End color. + Angle. + + + + Initializes the class with start and end colors, angle, focus and contrast. + + Start color. + End color. + Angle. + Focus. + Contrast. + + + + The style of the path gradient. + + + + + Elliptic gradient. + + + + + Rectangular gradient. + + + + + Class represents the path gradient fill. + + + + + Gets or sets the center color of the gradient. + + + + + Gets or sets the edge color of the gradient. + + + + + Gets or sets the style of the gradient. + + + + + + + + + + + + + + + + + + + + Initializes the class with default settings. + + + + + Initializes the class with center, edge colors and style. + + Center color. + Edge color. + Gradient style. + + + + Class represents the hatch fill. + + + + + Gets or sets the foreground color. + + + + + Gets or sets the background color. + + + + + Gets or sets the hatch style. + + + + + + + + + + + + + + + + + + + + Initializes the class with default settings. + + + + + Initializes the class with foreground, background colors and hatch style. + + Foreground color. + Background color. + Hatch style. + + + + Class represents the glass fill. + + + + + Gets or sets the fill color. + + + + + Gets or sets the blend value. + + Value must be between 0 and 1. + + + + + Gets or sets a value determines whether to draw a hatch or not. + + + + + + + + + + + + + + + + + + + + + + + Initializes the class with default settings. + + + + + Initializes the class with given color, blend ratio and hatch style. + + Color. + Blend ratio (0..1). + Display the hatch. + + + + Class represents the Texture fill. + + + + + Gets or sets value, indicating that image should preserve aspect ratio + + + + + Gets or sets the image width + + + + + Gets or sets the image height + + + + + Gets or sets the texture wrap mode + + + + + Gets or sets the image index + + + + + Gets or sets the image data + + + + + Image left offset + + + + + Image top offset + + + + + Sets image data to imageData + + input image data + + + + Set image + + input image + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes the class with default texture. + + + + + Initializes the class with specified image. + + + + + + Initializes the class with specified image. + + + + + Font header + + + + + Font name same as System.Drawing.Font.Name in modern Windows + + + + + Font name same as System.Drawing.Font.FontFamily.Name in modern Windows + + + + + This format found in Microsoft Windows Server 2016 + + + + + Adobe font name + + + + + Stream with raw font data. + + + + + Creates a new instance of the class. + + TrueType raw data stream + Keep open raw data stream after disposing FontStream + + + + FastName of font stream + + + + + TrueTypeFont object + + + + + Create outline for group of characters + + text as array of glyph's indexes + position of text + font size + text in form of outline vectors + + + + Create outline for text string + + text which will be transformed to outline + position of text + font size in px + text in form of outline vectors + + + + + + + Expected default behaviour as version 2020.3 + + + + + We use dictionary and pack "Index To Location" table (reorder glyph indexes) + + + + + Get or set current script + + + + + Get or set current Language + + + + + Get available scripts + + + + + Get available languages for script + + + + + + + Get available features for language and script + + + + + + + + Prepare tables for drawing, subsetting and so on + + always true + + + + Return raw image of the font + + Array of font bytes + + + + Return full raw image of the font + + Array of font bytes + + + + Cut some information from TTF file to reduce its size + + Alphabet subset dictionary + Describes how to pack font + + + + + Parse font supplement tables which store properties of the font + + + + + Create glyph outline assigned to specific position + + unicode character which will be drawn + size of the character + position of outline + outline of character + + + + Get glyph's outline + + unicode charter + outline image size + + + + + Constructor of TrueTypeFont object + + Strean with font + Disposition of subfont within collection file. Non-zero for font collections + + + + Description of SCRIPT_STATE structure + + + + + data + + + + + uBidiLevel + + + + + SetRtl + + + + + Description of SCRIPT_ANALYSIS structure + + + + + data + + + + + state + + + + + Description of SCRIPT_CONTROL structure + + + + + data + + + + + Description of SCRIPT_DIGITSUBSTITUTE structure + + + + + NationalDigitLanguage + + + + + TraditionalDigitLanguage + + + + + DigitSubstitute + + + + + dwReserved + + + + + Description of SCRIPT_ITEM structure + + + + + iCharPos + + + + + analysis + + + + + Description of SCRIPT_VISATTR structure + + + + + data + + + + + Description of GOFFSET structure + + + + + du + + + + + dv + + + + + Description of ABC structure + + + + + abcA + + + + + abcB + + + + + abcC + + + + + Description of FontRect structure + + + + + Description of FontPoint structure + + + + + Description of OutlineTextMetric structure + + + + + Emulation of Uniscribe GetOutlineTextMetrics + + Reference to metric structure + + + + Translate text to positions of glyphs in glyph tables and glyphs width + + + size in px + + + + + + + + + Destructor of TrueTypeFont object + + + + + Font descriptor + + + + + Indicates that the point is the start of a figure. + + + + + Indicates that the point is one of the two endpoints of a line. + + + + + Indicates that the point is an endpoint or control point of a cubic Bézier spline. + + + + + Masks all bits except for the three low-order bits, which indicate the point type. + + + + + Specifies that the point is a marker. + + + + + Specifies that the point is the last point in a closed subpath (figure). + + + + + FontHeader table + + + + + Define type of font file + + + + + Classic TrueType font + + + + + Collection of TrueType fonts + + + + + OpenType font format + + + + + + + + GlyphSubstitution table + + + + + Stream position must point to lookup record + + + + + + + Return true if was applied + + + + + + + + + Return coverageIndex for ApplyForce or if fail then return -1 + + + + + + + + Apply this Substitution with specified coverageIndex, cant be called only after IsApply + + + + + + + + + Table with encoded glyphs' outline + + + + + HorizontalMetrix table + + + + + IndexToLocation table + + + + + Kerning table + + + + + MaximumProfile table + + + + + Name table keep human friendly description about font properties, including font names, author and copyright notes + + + + + OS/2 and Windows Metrics table + + + + + Description of FontTextMetric structure + + + + + Description of FontPanose structure + + + + + Request font file + + System.Drawing.Font object + System/IO.Stream object + + + + Get full path to a font file by it's identifier + + font name with attributes + path to a font file + + + + assign full path to a font file to it's identifier + + font name with attributes + path to a font file + + + + Request font file location + + + + + Request font file location + + + + + Register font file + + + + + Will be removed soon + + + + + Different caching strategies + + + + + Progress callback type definition + + Progress information + + + + Progress callback event + + + + + Open and parse TrueType file + + + + + + + + Find all fonts files in directory and it's subdirectories + + Directory where find fond files + Defines file which collect found fonts + + + + Workaround function for avoid font duplicates + + if true then font append to collection, if false then font append to hash + Internal font structure + This parameter defines path to font file if file append to hash. Not used otherwise + + + + Parse raw image of font data and create TrueTypeFont objects from this image + + Defines font or collections + Pointer to memory of raw font data + + + + + + Build list of fonts + + Optional path to font.list folder. + + + + Enumerate available fonts + + + + + Base class which is parent of any table in TrueType font or collection + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Defines how boolean values are formatted and displayed. + + + + + Gets or sets a string that will be displayed if value is false. + + + + + Gets or sets a string that will be displayed if value is true. + + + + + + + + + + + + + + + + + Initializes a new instance of the BooleanFormat class with default settings. + + + + + Defines how currency values are formatted and displayed. + + + + + Gets or sets a value that determines whether to use system locale settings to format a value. + + + + + Gets or sets the number of decimal places to use in currency values. + + + + + Gets or sets the string to use as the decimal separator in currency values. + + + + + Gets or sets the string that separates groups of digits to the left of the decimal in currency values. + + + + + Gets or sets the string to use as the currency symbol. + + + + + Gets or sets the format pattern for positive currency values. + + This property can have one of the values in the following table. + The symbol "$" is the CurrencySymbol and n is a number. + + ValueAssociated Pattern + 0$n + 1n$ + 2$ n + 3n $ + + + + + + Gets or sets the format pattern for negative currency values. + + This property can have one of the values in the following table. + The symbol "$" is the CurrencySymbol and n is a number. + + ValueAssociated Pattern + 0 ($n) + 1 -$n + 2 $-n + 3 $n- + 4 (n$) + 5 -n$ + 6 n-$ + 7 n$- + 8 -n $ + 9 -$ n + 10n $- + 11$ n- + 12$ -n + 13n- $ + 14($ n) + 15(n $) + + + + + + + + + + + + + + + + + + Initializes a new instance of the CurrencyFormat class with default settings. + + + + + Represents a format that uses the Format string to display values. + + + + + Gets or sets a format string. + + + Default format is "G". For example, if you want to format a date, use the following + format string: "MM/dd/yyyy". See the System.String.Format method for list + of possible format strings. + + + + + + + + + + + + + + + + + Initializes a new instance of the CustomFormat class with default settings. + + + + + Defines how date values are formatted and displayed. + + + + + + + + Initializes a new instance of the DateFormat class with default settings. + + + + + Base class for all formats. + + + The format is used to format expression value in a object. + + + + + Gets the short format name (e.g. without a "Format" suffix). + + + + + Creates exact copy of this format. + + The copy of this format. + + + + Formats the specified value. + + The value to format. + The string that represents the formatted value. + + + + + + + + + + Represents a collection of formats used by the and + objects. + + + + + Gets or sets the element at the specified index. + + Index of an element. + The element at the specified index. + + + + Adds the specified elements to the end of this collection. + + Array of elements to add. + + + + Adds an object to the end of this collection. + + Object to add. + Index of the added object. + + + + Inserts an object into this collection at the specified index. + + The zero-based index at which value should be inserted. + The object to insert. + + + + Removes the specified object from the collection. + + Object to remove. + + + + Returns the zero-based index of the first occurrence of an object. + + The object to locate in the collection. + The zero-based index of the first occurrence of value within the entire collection, if found; + otherwise, -1. + + + + Determines whether an element is in the collection. + + The object to locate in the collection. + true if object is found in the collection; otherwise, false. + + + + + + + + + + Copies formats from another collection. + + Collection to copy from. + + + + + + + + + + Represents a format used to display values with no formatting. + + + + + + + + + + + + + + + + + Defines how numeric values are formatted and displayed. + + + + + Gets or sets a value that determines whether to use system locale settings to format a value. + + + + + Gets or sets the number of decimal places to use in numeric values. + + + + + Gets or sets the string to use as the decimal separator in numeric values. + + + + + Gets or sets the string that separates groups of digits to the left of the decimal in numeric values. + + + + + Gets or sets the format pattern for negative numeric values. + + This property can have one of the values in the following table. + The symbol n is a number. + + ValueAssociated Pattern + 0(n) + 1-n + 2- n + 3n- + 4n - + + + + + + + + + + + + + + + + + + Initializes a new instance of the NumberFormat class with default settings. + + + + + Defines how percent values are formatted and displayed. + + + + + Gets or sets a value that determines whether to use system locale settings to format a value. + + + + + Gets or sets the number of decimal places to use in percent values. + + + + + Gets or sets the string to use as the decimal separator in percent values. + + + + + Gets or sets the string that separates groups of digits to the left of the decimal in percent values. + + + + + Gets or sets the string to use as the percent symbol. + + + + + Gets or sets the format pattern for positive percent values. + + This property can have one of the values in the following table. + The symbol "%" is the PercentSymbol and n is a number. + + ValueAssociated Pattern + 0n % + 1n% + 2%n + 3% n + + + + + + Gets or sets the format pattern for negative percent values. + + This property can have one of the values in the following table. + The symbol "%" is the PercentSymbol and n is a number. + + ValueAssociated Pattern + 0 -n % + 1 -n% + 2 -%n + 3 %-n + 4 %n- + 5 n-% + 6 n%- + 7 -%n + 8 n %- + 9 % n- + 10% -n + 11n- % + + + + + + + + + + + + + + + + + + Initializes a new instance of the PercentFormat class with default settings. + + + + + Defines how time values are formatted and displayed. + + + + + + + + Initializes a new instance of the TimeFormat class with default settings. + + + + + Represents a group footer band. + + + + + Specifies a sort order. + + + This enumeration is used in the group header and in the "Matrix" object. + + + + + Specifies no sort (natural order). + + + + + Specifies an ascending sort order. + + + + + Specifies a descending sort order. + + + + + Represents a single highlight condition used by the property + of the . + + + + + Gets or sets a highlight expression. + + + This property can contain any valid boolean expression. If value of this expression is true, + the fill and font settings will be applied to the TextObject. + + + + + Gets or sets the visibility flag. + + + If this property is set to false, the Text object will be hidden if the + condition is met. + + + + + + + + + + + Creates exact copy of this condition. + + A copy of this condition. + + + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Specifies the hyperlink type. + + + + + Specifies the hyperlink to external URL such as "http://www.fast-report.com", "mailto:" + or any other system command. + + + + + Specifies hyperlink to a given page number. + + + + + Specifies hyperlink to a bookmark. + + + + + Specifies hyperlink to external report. This report will be run when you follow the hyperlink. + + + + + Specifies hyperlink to this report's page. The page will be run when you follow the hyperlink. + + + + + Specifies a custom hyperlink. No actions performed when you click it, you should handle it + in the object's Click event handler. + + + + + This class contains a hyperlink settings. + + + + + Gets or sets the kind of hyperlink. + + + Use the Kind property to define hyperlink's behavior. + The hyperlink may be used to navigate to the external url, the page number, + the bookmark defined by other report object, the external report, the other page of this report, + and custom hyperlink. + + + + + Gets or sets the expression which value will be used for navigation. + + + Normally you should set the Expression property to + any valid expression that will be calculated when this object is about to print. + The value of an expression will be used for navigation. + If you want to navigate to some fixed data (URL or page number, for example), + use the property instead. + + + + + Gets or sets a value that will be used for navigation. + + + Use this property to specify the fixed data (such as URL, page number etc). If you want to + navigate to some dynamically calculated value, use the property instead. + + + + + Gets or sets a value that indicate should be links open in new tab or not. + + + It works for HTML-export only! + + + + + Gets or sets an external report file name. + + + Use this property if is set to DetailReport. + When you follow the hyperlink, this report will be loaded and run. + You also may specify the report's parameter in the property. + + + + + Gets or sets the name of this report's page. + + + Use this property if is set to DetailPage. + When you follow the hyperlink, the specified page will be executed. It may contain the + detailed report. You also may specify the report's parameter in the + property. + + + + + Gets or sets a parameter's name that will be set to hyperlink's value. + + + Use this property if is set to DetailReport or DetailPage. + If you want to pass the hyperlink's value to the report's parameter, specify the + parameter name in this property. This parameter will be set to the hyperlink's value + before running a report. It may be used to display detailed information about clicked item. + It is also possible to pass multiple values to several parameters. If hyperlink's value + contains separators (the separator string can be set in the + property), it will be splitted to several values. That values will be passed to nested parameters + of the ReportParameter (you should create nested parameters by youself). For example, you have + the ReportParameter called "SelectedValue" which has two nested parameters: the first one is + "Employee" and the second is "Category". The hyperlink's value is "Andrew Fuller;Beverages". + It will be splitted to two values: "Andrew Fuller" and "Beverages". The first nested parameter + of the ReportParameter that is "Employee" in our case will be set to "Andrew Fuller"; + the second nested parameter ("Category") will be set to "Beverages". + Note: when you create a parameter in the detailed report, don't forget to set + its DataType property. It is used to convert string values to actual data type. + + + + + + Gets or sets a string that will be used as a separator to pass several values + to the external report parameters. + + + + + Assigns values from another source. + + Source to assign from. + + + + Provides the serialize/deserialize functionality. + + + + + Serializes the object. + + Writer object. + + + + Deserializes the object. + + Reader object. + + + + Implement this interface if your object can contain list of child objects. + + + + + Gets a value indicating that this object can contain the specified child object. + + Child object. + true if this object can contain the specified child object; otherwise, false. + + + + Gets a list of child objects. + + List to fill with values. + + + + Adds a child object to this object's childs. + + Object to add. + + + + Removes a specified object from this object's childs. + + + + + + Returns z-order of the specified child object. + + Child object. + Z-order of the specified object. + + This method must return the index of a specified child object in the internal child list. + + + + + Sets the z-order of the specified object. + + Child object. + New Z-order. + + This method must place the specified child object at the specified position in the internal child list. + + + + + Updates the children layout when the size of this object is changed by dx, dy values. + + X delta. + Y delta. + + This method must update positions/sizes of child objects whose Dock or Anchor properties + are set to non-default values. + + + + + Holds the list of objects of type. + + + + + Gets or sets the element at the specified index. + + Index of an element. + The element at the specified index. + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with specified owner. + + + + + Represents an overlay band. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + Initializes a new instance of the class with default settings. + + + + + Holds the list of objects of type. + + + + + Gets or sets the element at the specified index. + + Index of an element. + The element at the specified index. + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with specified owner. + + + + + This class contains the page columns settings. + It is used in the property. + + + + + Gets or sets the number of columns. + + + Set this property to 0 or 1 if you don't want to use columns. + + + + + Gets or sets the column width. + + + + + Gets or sets a list of column starting positions. + + + Each value represents a column starting position measured in the millimeters. + + + + + Assigns values from another source. + + Source to assign from. + + + + Represents a page footer band. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + + + + Initializes a new instance of the class with default settings. + + + + + Represents a page header band. + + + + + This property is not relevant to this class. + + + + + This property is not relevant to this class. + + + + + Initializes a new instance of the class with default settings. + + + + + Specifies the alignment of a image in the border. + + + + + Specifies that image is not aligned in the layout rectangle. + + + + + Specifies that image is aligned in the top-left of the layout rectangle. + + + + + Specifies that image is aligned in the top-center of the layout rectangle. + + + + + Specifies that image is aligned in the top-right of the layout rectangle. + + + + + Specifies that image is aligned in the center-left of the layout rectangle. + + + + + Specifies that image is aligned in the center-center of the layout rectangle. + + + + + Specifies that image is aligned in the center-right of the layout rectangle. + + + + + Specifies that image is aligned in the center-left of the layout rectangle. + + + + + Specifies that image is aligned in the center-center of the layout rectangle. + + + + + Specifies that image is aligned in the center-right of the layout rectangle. + + + + + Specifies the language of the report's script. + + + + + The C# language. + + + + + The VisualBasic.Net language. + + + + + Specifies the quality of text rendering. + + + + + The default text quality, depends on system settings. + + + + + The regular quality. + + + + + The "ClearType" quality. + + + + + The AntiAlias quality. This mode may be used to produce the WYSIWYG text. + + + + + The "SingleBitPerPixel" quality. + + + + + The "SingleBitPerPixelGridFit" quality. + + + + + Specifies the report operation. + + + + + Specifies no operation. + + + + + The report is running. + + + + + The report is printing. + + + + + The report is exporting. + + + + + Specifies the page range to print/export. + + + + + Print all pages. + + + + + Print current page. + + + + + Print pages specified in the PageNumbers property of the PrintSettings. + + + + + The automatic shift mode. + + + + + Do not shift the object. + + + + + Shift the object up or down if any object above it shrinks or grows. + + + + + Shift the object up or down if any object above it shrinks or grows. + Objects must have overlapped x-coordinates. + + + + + Specifies where to print an object. + + + + + Do not print the object. + + + + + Print the object on the first page. If this flag is not set, the object will not + be printed on the first page. + + + + + Print the object on the last page. If this flag is not set, the object will not + be printed on the last page. You should set the report's double pass option to make + it work correctly. + + + + + Print the object on odd pages only. + + + + + Print the object on even pages only. + + + + + Print the object on band with "Repeat on Every Page" flag when that band is repeated. + + + + + Print the object if the report has single page only. + + + + + Specifies the style properties to use when style is applied. + + + + + Use the fill property of the style. + + + + + Use all style properties. + + + + + Holds the list of objects of type. + + + + + Gets or sets the element at the specified index. + + Index of an element. + The element at the specified index. + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with specified owner. + + + + + Provides data for the event. + + + + + Gets a name of the file to load the report from. + + + + + The reference to a report. + + + + + Initializes a new instance of the class using the specified + file name and the report. + + The name of the file to load the report from. + The report. + + + + Provides data for the event. + + + + + Gets an expression. + + + + + Gets or sets a object. + + + + + The reference to a report. + + + + + Initializes a new instance of the class using the specified + file name and the report. + + The text of expression. + The name of the file to load the report from. + The report. + + + + Represents the method that will handle the event. + + The source of the event. + The event data. + + + + Represents the method that will handle the event. + + The source of the event. + The event data. + + + + Provides data for the Progress event. + + + + + Gets a progress message. + + + + + Gets the current page number. + + + + + Gets the number of total pages. + + + + + Initializes a new instance of the class using the specified + message, page number and total number of pages. + + The progress message. + Current page number. + Number of total pages. + + + + Represents the method that will handle the Progress event. + + The source of the event. + The event data. + + + + Provides data for the DatabaseLogin event. + + + + + Gets or sets the connection string. + + + + + Gets or sets an user name. + + + + + Gets or sets a password. + + + + + Initializes a new instance of the class using the specified + connection string. + + The connection string. + + + + Represents the method that will handle the DatabaseLogin event. + + The source of the event. + The event data. + + + + Provides data for the AfterDatabaseLogin event. + + + + + Gets the DbConnection object. + + + + + Initializes a new instance of the class using + the specified connection. + + The connection object. + + + + Represents the method that will handle the AfterDatabaseLogin event. + + The source of the event. + The event data. + + + + Provides data for the FilterProperties event. + + + + + Gets the property descriptor. + + + + + Gets or sets a value that indicates whether this property should be skipped. + + + + + Represents the method that will handle the FilterProperties event. + + The source of the event. + The event data. + + + + Provides data for the GetPropertyKind event. + + + + + Gets the property name. + + + + + Gets the property type. + + + + + Gets or sets the kind of property. + + + + + Represents the method that will handle the GetPropertyKind event. + + The source of the event. + The event data. + + + + Provides data for the GetTypeInstance event. + + + + + Gets the type. + + + + + Gets or sets the instance of type. + + + + + Represents the method that will handle the GetPropertyKind event. + + The source of the event. + The event data. + + + + Event arguments for custom Export parameters + + + + + Used to set custom export parameters + + + + + Specifies the Save Mode of designed report. + + + + + The saving allowed to all. + + + + + The saving in original place. + + + + + The saving allowed to current user. + + + + + The saving allowed to current role/group. + + + + + The saving allowed with other security permissions. + + + + + The saving not allowed. + + + + + Custom saving rules. + + + + + This class represents the report information such as name, author, description etc. + + + + + Gets or sets the name of a report. + + + + + Gets or sets the author of a report. + + + + + Gets or sets the report version. + + + + + Gets or sets the report description. + + + + + Gets or sets the picture associated with a report. + + + + + Gets or sets the report creation date and time. + + + + + Gets or sets a value indicating that report was modified in the designer. + + + + + Gets or sets a value that determines whether to fill the property + automatically. + + + + + Gets or sets the ratio that will be used when generating a preview picture. + + + + + Gets the version of FastReport that was created this report file. + + + + + Gets or sets the Tag string object for this report file. + + + + + Gets or sets SaveMode property. + + + + + Resets all properties to its default values. + + + + + Initializes a new instance of the class with default settings. + + + + + Specifies the default paper size used when creating a new report. + + + + + A4 paper (210 x 297 mm). + + + + + Letter paper (8.5 x 11 inches, 216 x 279 mm). + + + + + Represents a report title band. + + + + + Internal representation of RichText document + + + + + This class represents a RTF run. + + + + + Insert paragraph into list of paragraphs + + + + + Insert row into list of paragraphs + + + + + This class represents a RTF properies. + + + + + This class parses an entiry RTF document. + + + + + + + + + + + + + + + + + Get RTF structure based on range of elements + + + + + RichText document object + + + + + Save RTF document to text stream + + + + + This class represents a RTF document header. + + + Refer to RTF-1.7 spec for detail description + + + + + Parser of RTF header. + + + Return false on finish of header + + + + + This class represents a RTF text paragraph. + + + + + This class detect a RTF control sequences and text. + + + + + This class represents a RTF column description. + + + + + + Create RTF row + + + + + + + Save RTF document to plain text stream + + + + + Specifies a kind of the shape. + + + + + Specifies a rectangle shape. + + + + + Specifies a round rectangle shape. + + + + + Specifies an ellipse shape. + + + + + Specifies a triangle shape. + + + + + Specifies a diamond shape. + + + + + Represents a sort condition used in the . + + + + + Gets or sets an expression used to sort data band rows. + + + This property can contain any valid expression. + + + + + Gets or sets a value indicating that sort must be performed in descending order. + + + + + Serializes the class. + + Writer object. + + This method is for internal use only. + + + + + Deserializes the class. + + Reader object. + + This method is for internal use only. + + + + + Initializes a new instance of the class with default settings. + + + + + Initializes a new instance of the class with specified expression. + + + + + Initializes a new instance of the class with specified expression and sort order. + + + + + Represents a collection of sort conditions used in the . + + + + + Gets or sets the element at the specified index. + + Index of an element. + The element at the specified index. + + + + Adds the specified elements to the end of this collection. + + + + + + Adds an object to the end of this collection. + + Object to add. + Index of the added object. + + + + Inserts an object into this collection at the specified index. + + The zero-based index at which value should be inserted. + The object to insert. + + + + Removes the specified object from the collection. + + Object to remove. + + + + Returns the zero-based index of the first occurrence of an object. + + The object to locate in the collection. + The zero-based index of the first occurrence of value within the entire collection, if found; + otherwise, -1. + + + + Determines whether an element is in the collection. + + The object to locate in the collection. + true if object is found in the collection; otherwise, false. + + + + + + + + + + Assigns values from another collection. + + Collection to assign from. + + + + Represents a style. + + + + Style class holds border, fill, text fill and font settings. It can be applied to any report object of + type. + + + The Report object holds list of styles in its property. Each style has + unique name. To apply a style to the report component, set its + property to the style name. + + + + + + Gets or sets a name of the style. + + + The name must be unique. + + + + + + + + + + + Creates exact copy of this Style. + + Copy of this style. + + + + Initializes a new instance of the class with default settings. + + + + + Represents a collection of styles used in the . + + + + + Gets or sets the name of the style. + + + + + Gets or sets the element at the specified index. + + Index of an element. + The element at the specified index. + + + + Adds the specified elements to the end of this collection. + + + + + + Adds an object to the end of this collection. + + Object to add. + Index of the added object. + + + + Inserts an object into this collection at the specified index. + + The zero-based index at which value should be inserted. + The object to insert. + + + + Removes the specified object from the collection. + + Object to remove. + + + + Returns the zero-based index of the first occurrence of an object. + + The object to locate in the collection. + The zero-based index of the first occurrence of value within the entire collection, if found; + otherwise, -1. + + + + Returns the zero-based index of the first occurrence of a style with specified name. + + The name to locate in the collection. + The zero-based index of the first occurrence of value within the entire collection, if found; + otherwise, -1. + + + + Determines whether an element is in the collection. + + The object to locate in the collection. + true if object is found in the collection; otherwise, false. + + + + Determines whether a style with specified name is in the collection. + + The style name to locate in the collection. + true if object is found in the collection; otherwise, false. + + + + + + + + + + Saves the collection to a stream. + + Stream to save to. + + + + Saves the collection to a file. + + The name of the file. + + + + Loads the collection from a stream. + + Stream to load from. + + + + Loads the collection from a file. + + The name of the file. + + + + Creates exact copy of this collection. + + The copy of this collection. + + + + Initializes a new instance of the class with default settings. + + + + + Represents a collection of the objects. + + + + + Gets or sets the element at the specified index. + + Index of an element. + The element at the specified index. + + + + Adds the specified elements to the end of this collection. + + + + + + Adds an object to the end of this collection. + + Object to add. + Index of the added object. + + + + Inserts an object into this collection at the specified index. + + The zero-based index at which value should be inserted. + The object to insert. + + + + Removes the specified object from the collection. + + Object to remove. + + + + Returns the zero-based index of the first occurrence of an object. + + The object to locate in the collection. + The zero-based index of the first occurrence of value within the entire collection, if found; + otherwise, -1. + + + + Returns the zero-based index of the first occurrence of a style collection with specified name. + + The style collection name to locate in the collection. + The zero-based index of the first occurrence of value within the entire collection, if found; + otherwise, -1. + + + + Determines whether an element is in the collection. + + The object to locate in the collection. + true if object is found in the collection; otherwise, false. + + + + Determines whether a style collection with specified name is in the collection. + + The style collection name to locate in the collection. + true if object is found in the collection; otherwise, false. + + + + Gets an array containing all collection items. + + An array containing all collection items. + + + + Serializes the collection. + + Writer object. + + This method is for internal use only. + + + + + Deserializes the collection. + + Reader object. + + This method is for internal use only. + + + + + Saves the collection to a stream. + + Stream to save to. + + + + Saves the collection to a file with specified name. + + File name to save to. + + + + Loads the collection from a stream. + + Stream to load from. + + + + Loads the collection from a file with specified name. + + Name of a file. + + + + Specifies the horizontal alignment of a text in the TextObject object. + + + + + Specifies that text is aligned in the left of the layout rectangle. + + + + + Specifies that text is aligned in the center of the layout rectangle. + + + + + Specifies that text is aligned in the right of the layout rectangle. + + + + + Specifies that text is aligned in the left and right sides of the layout rectangle. + + + + + Specifies the vertical alignment of a text in the TextObject object. + + + + + Specifies that text is aligned in the top of the layout rectangle. + + + + + Specifies that text is aligned in the center of the layout rectangle. + + + + + Specifies that text is aligned in the bottom of the layout rectangle. + + + + + The type of text renderer + + + + + The default render + + + + + Render with some html tags and stable logic + + + + + Render with img tags, span etc. Experimental and unstable logic + + + + + Renders a text in a simplest way. For internal use only. + + + + + The format of paragraph + + + + + The first line on each paragraph. + + + + + The distance between lines, not effect if value less then 0 + + + + + The spacing type for distance between line calculation + + + + + The value for a multiplication line height for adding spacing + + + + + Skip the line indent in the first paragraph, for broken paragraphs + + + + + clone with new scale; + + + + + + + The spacing type between lines + + + + + Single spacing, not effect from LineSpacing + + + + + Minimal spacing in exactly size + + + + + The specific distance between the lines, for some exports, does not work if the distance value is too small. + + + + + The calculated distance between lines, for some exports, does not work if the distance value is too small. + + + + + Specifies the behavior of the AutoShrink feature of TextObject. + + + + + AutoShrink is disabled. + + + + + AutoShrink decreases the Font.Size property of the TextObject. + + + + + AutoShrink decreases the FontWidthRatio property of the TextObject. + + + + + Specifies the behavior of the MergeMode feature of TextObject. + + + + + Merge is disabled. + + + + + Allows horizontal merging. + + + + + Allows vertical merging. + + + + + Specifies how to display the duplicate values. + + + + + The TextObject can show duplicate values. + + + + + The TextObject with duplicate value will be hidden. + + + + + The TextObject with duplicate value will be shown but with no text. + + + + + Several TextObject objects with the same value will be merged into one TextObject object. + + + + + Specifies how the report engine processes the text objects. + + + + + Specifies the default process mode. The text object is processed just-in-time. + + + + + Specifies that the text object must be processed when the entire report is finished. This mode + can be used to print grand total value (which is normally calculated at the end of report) in the + report title band. + + + + + Specifies that the text object must be processed when the entire report page is finished. This mode + can be used if the report template consists of several report pages. + + + + + Specifies that the text object must be processed when any report page is finished. This mode + can be used to print the page total (which is normally calculated at the page footer) in the + page header band. + + + + + Specifies that the text object must be processed when the column is finished. This mode + can be used to print the column total (which is normally calculated at the column footer) in the + column header band. + + + + + Specifies that the text object must be processed when the data block is finished. This mode can be + used to print a total value in the data header (which is normally available + in the data footer only). + + + + + Specifies that the text object must be processed when the group is finished. This mode can be + used to print a total value in the group header (which is normally available + in the group footer only). + + + + + Specifies that the text object is processed manually when you call the Engine.ProcessObject + method in the report script. + + + + + Represents text outline. + + + + + Gets or sets a value indicating that outline is enabled. + + + + + Enable or disable draw the outline behind of text. + + + + + Gets or sets the outline color. + + + + + Gets or sets the outline width. + + + + + Specifies the style of an outline. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified parameters. + + True if outline enabled. + Outline color. + Outline width. + Outline style. + True if outline should be drawn behind text. + + + + Copies the content of another TextOutline. + + The TextOutline instance to copy the contents from. + + + + Creates the exact copy of this outline. + + Copy of this outline. + + + + Serializes the TextOutline. + + Writer object. + TextOutline property name. + Another TextOutline to compare with. + + + + Represents a cache of graphics objects such as pens, brushes, fonts and text formats. + + + Cache holds all used graphics objects. There is no need to dispose objects returned + by GetXXX calls. + + This example demonstrates how to use graphic cache. + + public void Draw(FRPaintEventArgs e) + { + Brush brush = e.Cache.GetBrush(BackColor); + Pen pen = e.Cache.GetPen(BorderColor, 1, BorderStyle); + e.Graphics.FillRectangle(brush, Bounds); + e.Graphics.DrawRectangle(pen, Bounds); + } + + + + + + Gets a pen with specified settings. + + Color of a pen. + Width of a pen. + Dash style of a pen. + The Pen object. + + + + Gets a pen with specified settings. + + Color of a pen. + Width of a pen. + Dash style of a pen. + Line join of a pen. + The Pen object. + + + + Gets a brush with specified color. + + Color of a brush. + The SolidBrush object. + + + + Gets a font with specified settings. + + Family of a font. + Size of a font. + Style of a font. + The Font object. + + + + Gets a string format with specified settings. + + Text alignment information on the vertical plane. + Line alignment on the horizontal plane. + StringTrimming enumeration. + StringFormatFlags enumeration that contains formatting information. + The number of spaces between the beginning of a line of text and the first tab stop. + Distance between tab stops. + The StringFormat object. + + + + Gets a string format with specified settings. + + Text alignment information on the vertical plane. + Line alignment on the horizontal plane. + StringTrimming enumeration. + StringFormatFlags enumeration that contains formatting information. + The number of spaces between the beginning of a line of text and the first tab stop. + Distance between tab stops. + Default distance between default tabs stops. + The StringFormat object. + + + + Disposes resources used by this object. + + + + + Initializes a new instance of the GraphicCache class with default settings. + + + + + A strongly typed object that readily casts an intrinsic + object to the other intrinsic types when possible. + + + The Variant class is an intrinsic object container structure + inspired by Visual Basic 6.0's Variant. The key features + of a Variant class include the ability to perform typecasts and + arithmetic between types that are not normally considered compatible. + For example, if a Variant class contains a string describing a + number, such as "1.1", then floating point arithmetic can be + performed on it. + Variants are normally considered dangerous because they + strip away the effectiveness of type safety, which is the + reason why the Visual Basic 6.0 Variant was left out of + Visual Basic .NET. However, this implementation restores the + Variant structure, both as a proof of concept and as a + restoration of the utility and positive merits of the Variant + where it can be used responsibly. + + + + + Creates a strongly typed object that readily casts a primitive + object to the other primitive types when possible. + + + + + The actual value being stored in its original , + returned as an . + + + + + The of the property. + + + + + Returns the for this instance. + + The enumerated constant that is the + of the class or value type that implements this interface. + + + + Returns the string equivalent of the property. + + + + + Attempts to convert or typecast to the specified type. + + The type to convert or cast to. + The object after typecasting. + + + + Attempts to convert or typecast to the specified type. + + The type to convert or cast to. + An + interface implementation that supplies culture-specific formatting information. + The object after typecasting. + + + + Returns true if the property implements + + + + + Returns true if the property + is a numeric intrinsic value. + + + + + Returns true if the property + is a numeric intrinsic value or else can be parsed into + a numeric intrinsic value. + + + + + Returns true if the value is a date or can be parsed into a date. + + + + + Returns true if the value is a TimeSpan. + + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance to + an equivalent value. + + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance to + an equivalent value using the specified culture-specific + formatting information. + + The culture-specific formatting information. + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance + to an equivalent 8-bit unsigned integer. + + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance + to an equivalent 8-bit unsigned integer using the specified + culture-specific formatting information. + + The culture-specific formatting information. + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance + to an equivalent 16-bit signed integer. + + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance to + an equivalent 16-bit signed integer using the specified + culture-specific formatting information. + + The culture-specific formatting information. + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance + to an equivalent 32-bit signed integer. + + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance + to an equivalent 32-bit signed integer using the specified + culture-specific formatting information. + + The culture-specific formatting information. + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance + to an equivalent 64-bit signed integer. + + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance + to an equivalent 64-bit signed integer using the specified + culture-specific formatting information. + + The culture-specific formatting information. + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance + to an equivalent double-precision floating-point number. + + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance + to an equivalent double-precision floating-point number using the + specified culture-specific formatting information. + + The culture-specific formatting information. + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance + to an equivalent single-precision floating-point number. + + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance + to an equivalent single-precision floating-point number using the + specified culture-specific formatting information. + + The culture-specific formatting information. + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance to + an equivalent Decimal number. + + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance to + an equivalent Decimal number using the specified culture-specific + formatting information. + + The culture-specific formatting information. + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance + to an equivalent 8-bit signed integer. + + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance + to an equivalent 8-bit signed integer using the specified + culture-specific formatting information. + + The culture-specific formatting information. + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance + to an equivalent 16-bit unsigned integer. + + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance + to an equivalent 16-bit unsigned integer using the specified + culture-specific formatting information. + + The culture-specific formatting information. + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance + to an equivalent 32-bit unsigned integer. + + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance + to an equivalent 32-bit unsigned integer using the specified + culture-specific formatting information. + + The culture-specific formatting information. + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance + to an equivalent 64-bit unsigned integer. + + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance + to an equivalent 64-bit unsigned integer using the specified + culture-specific formatting information. + + The culture-specific formatting information. + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance to + an equivalent DateTime. + + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance to + an equivalent DateTime using the specified culture-specific + formatting information. + + The culture-specific formatting information. + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance to + an equivalent TimeSpan. + + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance to + an equivalent TimeSpan using the specified culture-specific + formatting information. + + The culture-specific formatting information. + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance to + an equivalent DateTimeOffset. + + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance to + an equivalent DateTimeOffset using the specified culture-specific + formatting information. + + The culture-specific formatting information. + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance + to an equivalent Unicode character. + + + + + If is a , returns + as-is. Otherwise, attempts to convert the value of this instance + to an equivalent Unicode character using the specified + culture-specific formatting information. + + The culture-specific formatting information. + + + + Addition operator. + + + If the value on the right is a + or a , + the Variant is converted to a string and appended. + If the value on the right or the Variant + is a , arithmetic + is performed on the property and the + resulting value is set to the DateTime type. + Otherwise, if the value on the right is a number, both + the Variant and the value on the right are + converted to a , the arithmetic + is performed, and the resulting value is converted back to the + original type that the Variant previously represented. + If the type that the Variant previously represented + cannot contain the resulting value--such as if the type is a + and the value is -12--then the + type will be converted to a type that can contain + the value, such as . + + + + A new containing the resulting value. + + + + Subtraction operator. + + + If the value on the right or the Variant + is a , arithmetic + is performed on the property and the + resulting value is set to the DateTime type. + Otherwise, if the value on the right is a number, both + the Variant and the value on the right are + converted to a , the arithmetic + is performed, and the resulting value is converted back to the + original type that the Variant previously represented. + If the type that the Variant previously represented + cannot contain the resulting value--such as if the type is a + and the value is -12--then the + type will be converted to a type that can contain + the value, such as . + + + + A new containing the resulting value. + + + + Unary minus operator. + + + + + Greater than operator. + + + + + Greater than or equal operator. + + + + + Less than operator. + + + + + Less than or equal operator. + + + + + Multiplication operator. + + + If the value on the right or the Variant + is a , arithmetic + is performed on the property and the + resulting value is set to the DateTime type. + Otherwise, if the value on the right is a number, both + the Variant and the value on the right are + converted to a , the arithmetic + is performed, and the resulting value is converted back to the + original type that the Variant previously represented. + If the type that the Variant previously represented + cannot contain the resulting value--such as if the type is a + and the value is -12--then the + type will be converted to a type that can contain + the value, such as . + + + + A new containing the resulting value. + + + + Division operator. + + + If the value on the right or the Variant + is a , arithmetic + is performed on the property and the + resulting value is set to the DateTime type. + Otherwise, if the value on the right is a number, both + the Variant and the value on the right are + converted to a , the arithmetic + is performed, and the resulting value is converted back to the + original type that the Variant previously represented. + If the type that the Variant previously represented + cannot contain the resulting value--such as if the type is a + and the value is -12--then the + type will be converted to a type that can contain + the value, such as . + + + + A new containing the resulting value. + + + + Modulus operator. + + + If the value on the right or the Variant + is a , arithmetic + is performed on the property and the + resulting value is set to the DateTime type. + Otherwise, if the value on the right is a number, both + the Variant and the value on the right are + converted to a , the arithmetic + is performed, and the resulting value is converted back to the + original type that the Variant previously represented. + If the type that the Variant previously represented + cannot contain the resulting value--such as if the type is a + and the value is -12--then the + type will be converted to a type that can contain + the value, such as . + + + + A new containing the resulting value. + + + + Bitwise And operator. + + + If the value on the right or the Variant + is a , arithmetic + is performed on the property and the + resulting value is set to the DateTime type. + Otherwise, if the value on the right is a number, both + the Variant and the value on the right are + converted to a , the arithmetic + is performed, and the resulting value is converted back to the + original type that the Variant previously represented. + If the type that the Variant previously represented + cannot contain the resulting value--such as if the type is a + and the value is -12--then the + type will be converted to a type that can contain + the value, such as . + + + + A new containing the resulting value. + + + + Bitwise Or operator. + + + If the value on the right or the Variant + is a , arithmetic + is performed on the property and the + resulting value is set to the DateTime type. + Otherwise, if the value on the right is a number, both + the Variant and the value on the right are + converted to a , the arithmetic + is performed, and the resulting value is converted back to the + original type that the Variant previously represented. + If the type that the Variant previously represented + cannot contain the resulting value--such as if the type is a + and the value is -12--then the + type will be converted to a type that can contain + the value, such as . + + + + A new containing the resulting value. + + + + Inequality operator. + + + + + The opposite of == + + + + + Equality operator. + First attempts to compare the left value after + temporarily converting it to the type of the right value. + If the conversion cannot occur, such as if the value is not an + intrinsic value type, the comparison occurs at the + level using Object.Equals. + + + + + + + + Equality operator. + + + + + + + + Equality operator. + + + + + + + + Returns property unless the value on the right + is null. If the value on the right is null, returns "". + + + + + + Converts the value of this instance to an equivalent + using the specified culture-specific formatting information. + + + + + + + See . + + + + + + See . + + + + + + + Converts an object to a boolean. + For any type, if null, returns false. + For Boolean: true/false. + For String: "", "false", "0", etc. == false; + "1", "true", etc. == true, else true. + For numeric intrinsics: 0 == false, else true. + For any other non-null object, returns true. + + The string to be converted + The boolean value of this string. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies the watermark image size mode. + + + + + Specifies the normal (original) size. + + + + + Specifies the centered image. + + + + + Specifies the stretched image. + + + + + Specifies the stretched image that keeps its aspect ratio. + + + + + Specifies the tiled image. + + + + + Specifies the watermark text rotation. + + + + + Specifies a horizontal text. + + + + + Specifies a vertical text. + + + + + Specifies a diagonal text. + + + + + Specifies a backward diagonal text. + + + + + Represents the report page watermark. + + + Watermark can draw text and/or image behind the page objects on in front of them. To enable + watermark, set its Enabled property to true. + + + + + Gets or sets avalue indicating that watermark is enabled. + + + + + Gets or sets the watermark image. + + + + + Gets or sets the watermark image size mode. + + + + + Gets or sets an image transparency. + + + Valid values are 0..1. 1 means totally transparent image. + + + + + Gets or sets the watermark text. + + + + + Gets or sets a font of the watermark text. + + + + + Gets or sets a text fill. + + + + + Gets or sets a text rotation. + + + + + Gets or sets a value indicates that the text should be displayed on top of all page objects. + + + + + Gets or sets a value indicates that the image should be displayed on top of all page objects. + + + + + + + + + + Draws watermark image. + + + + + + + + + Draws watermark text. + + + + + + + + + Serializes the watermark. + + Writer object. + The watermark property name. + Another Watermark object to compare with. + + This method is for internal use only. + + + + + Disposes resources used by the watermark. + + + + + Assigns values from another source. + + Source to assign from. + + + + Creates exact copy of this Watermark. + + Copy of this watermark. + + + + Initializes a new instance of the class with default settings. + + + + + An SVG element to render circles to the document. + + + + + Gets the center point of the circle. + + The center. + + + + Gets the representing this element. + + + + + Renders the circle to the specified object. + + The graphics object. + + + + Initializes a new instance of the class. + + + + + Represents and SVG ellipse element. + + + + + Gets the for this element. + + + + + + Renders the and contents to the specified object. + + The object to render to. + + + + Initializes a new instance of the class. + + + + + Represents and SVG image + + + + + Initializes a new instance of the class. + + + + + Gets an representing the top left point of the rectangle. + + + + + Gets or sets the aspect of the viewport. + + + + + + Gets the bounds of the element. + + The bounds. + + + + Gets the for this element. + + + + + Renders the and contents to the specified object. + + + + + Represents and SVG line element. + + + + + Gets or sets the marker (end cap) of the path. + + + + + Gets or sets the marker (start cap) of the path. + + + + + Gets or sets the marker (start cap) of the path. + + + + + Renders the stroke of the to the specified + + The object to render to. + + + + Represents an element that is using a GraphicsPath as rendering base. + + + + + SvgPolygon defines a closed shape consisting of a set of connected straight line segments. + + + + + The points that make up the SvgPolygon + + + + + Gets or sets the marker (end cap) of the path. + + + + + Gets or sets the marker (start cap) of the path. + + + + + Gets or sets the marker (start cap) of the path. + + + + + Renders the stroke of the to the specified + + The object to render to. + + + + SvgPolyline defines a set of connected straight line segments. Typically, defines open shapes. + + + + + Gets or sets the marker (end cap) of the path. + + + + + Gets or sets the marker (start cap) of the path. + + + + + Gets or sets the marker (start cap) of the path. + + + + + Renders the stroke of the to the specified + + The object to render to. + + + + Represents an SVG rectangle that could also have rounded edges. + + + + + Initializes a new instance of the class. + + + + + Gets an representing the top left point of the rectangle. + + + + + Gets or sets the position where the left point of the rectangle should start. + + + + + Gets or sets the position where the top point of the rectangle should start. + + + + + Gets or sets the width of the rectangle. + + + + + Gets or sets the height of the rectangle. + + + + + Gets or sets the X-radius of the rounded edges of this rectangle. + + + + + Gets or sets the Y-radius of the rounded edges of this rectangle. + + + + + Gets or sets a value to determine if anti-aliasing should occur when the element is being rendered. + + + + + Gets the for this element. + + + + + Renders the and contents to the specified object. + + + + + The class that all SVG elements should derive from when they are to be rendered. + + + + + Gets the for this element. + + + + + Gets the bounds of the element. + + The bounds. + + + + Gets the associated if one has been specified. + + + + + Gets the associated if one has been specified. + + + + + Gets or sets the algorithm which is to be used to determine the clipping region. + + + + + Gets the associated if one has been specified. + + + + + Gets or sets a value to determine if anti-aliasing should occur when the element is being rendered. + + + + + Initializes a new instance of the class. + + + + + Renders the and contents to the specified object. + + The object to render to. + + + + Renders the fill of the to the specified + + The object to render to. + + + + Renders the stroke of the to the specified + + The object to render to. + + + + Sets the clipping region of the specified . + + The to have its clipping region set. + + + + Resets the clipping region of the specified back to where it was before the method was called. + + The to have its clipping region reset. + + + + Sets the clipping region of the specified . + + The to have its clipping region set. + + + + Resets the clipping region of the specified back to where it was before the method was called. + + The to have its clipping region reset. + + + + Gets or sets a value to determine whether the element will be rendered. + + + + + Gets or sets a value to determine whether the element will be rendered. + Needed to support SVG attribute display="none" + + + + + Gets or sets the fill of this element. + + + + + Defines the methods and properties that an must implement to support clipping. + + + + + Gets or sets the ID of the associated if one has been specified. + + + + + Specifies the rule used to define the clipping region when the element is within a . + + + + + Sets the clipping region of the specified . + + The to have its clipping region set. + + + + Resets the clipping region of the specified back to where it was before the method was called. + + The to have its clipping region reset. + + + + Defines a path that can be used by other elements. + + + + + Specifies the coordinate system for the clipping path. + + + + + Initializes a new instance of the class. + + + + + Gets this 's region to be used as a clipping region. + + A new containing the to be used for clipping. + + + + + + + + + + + Called by the underlying when an element has been added to the + collection. + + The that has been added. + An representing the index where the element was added to the collection. + + + + Called by the underlying when an element has been removed from the + collection. + + The that has been removed. + + + + Renders the and contents to the specified object. + + The object to render to. + + + + Indicates the algorithm which is to be used to determine the clipping region. + + + This rule determines the "insideness" of a point on the canvas by drawing a ray from + that point to infinity in any direction and then examining the places where a segment of the + shape crosses the ray. + + + + + This rule determines the "insideness" of a point on the canvas by drawing a ray from that point to infinity in any direction and then examining the places where a segment of the shape crosses the ray. Starting with a count of zero, add one each time a path segment crosses the ray from left to right and subtract one each time a path segment crosses the ray from right to left. After counting the crossings, if the result is zero then the point is outside the path. Otherwise, it is inside. + + + + + This rule determines the "insideness" of a point on the canvas by drawing a ray from that point to infinity in any direction and counting the number of path segments from the given shape that the ray crosses. If this number is odd, the point is inside; if even, the point is outside. + + + + + Provides properties and methods to be implemented by view port elements. + + + + + Gets or sets the viewport of the element. + + + + + Description of SvgAspectRatio. + + + + Specifies the color space for gradient interpolations, color animations and alpha compositing. + When a child element is blended into a background, the value of the ‘color-interpolation’ property on the child determines the type of blending, not the value of the ‘color-interpolation’ on the parent. For gradients which make use of the ‘xlink:href’ attribute to reference another gradient, the gradient uses the ‘color-interpolation’ property value from the gradient element which is directly referenced by the ‘fill’ or ‘stroke’ property. When animating colors, color interpolation is performed according to the value of the ‘color-interpolation’ property on the element being animated. + + + Indicates that the user agent can choose either the sRGB or linearRGB spaces for color interpolation. This option indicates that the author doesn't require that color interpolation occur in a particular color space. + + + Indicates that color interpolation should occur in the sRGB color space. + + + Indicates that color interpolation should occur in the linearized RGB color space as described above. + + + The value is inherited from the parent element. + + + Defines the coordinate system for attributes ‘markerWidth’, ‘markerHeight’ and the contents of the ‘marker’. + + + If markerUnits="strokeWidth", ‘markerWidth’, ‘markerHeight’ and the contents of the ‘marker’ represent values in a coordinate system which has a single unit equal the size in user units of the current stroke width (see the ‘stroke-width’ property) in place for the graphic object referencing the marker. + + + If markerUnits="userSpaceOnUse", ‘markerWidth’, ‘markerHeight’ and the contents of the ‘marker’ represent values in the current user coordinate system in place for the graphic object referencing the marker (i.e., the user coordinate system for the element referencing the ‘marker’ element via a ‘marker’, ‘marker-start’, ‘marker-mid’ or ‘marker-end’ property). + + + + Defines the various coordinate units certain SVG elements may use. + + + + + Indicates that the coordinate system of the owner element is to be used. + + + + + Indicates that the coordinate system of the entire document is to be used. + + + + This is the descriptor for the style of a font and takes the same values as the 'font-style' property, except that a comma-separated list is permitted. + + + Indicates that the font-face supplies all styles (normal, oblique and italic). + + + Specifies a font that is classified as 'normal' in the UA's font database. + + + Specifies a font that is classified as 'oblique' in the UA's font database. Fonts with Oblique, Slanted, or Incline in their names will typically be labeled 'oblique' in the font database. A font that is labeled 'oblique' in the UA's font database may actually have been generated by electronically slanting a normal font. + + + Specifies a font that is classified as 'italic' in the UA's font database, or, if that is not available, one labeled 'oblique'. Fonts with Italic, Cursive, or Kursiv in their names will typically be labeled 'italic' + + + The weight of a face relative to others in the same font family. + + + All font weights. + + + The value is inherited from the parent element. + + + Same as . + + + Same as . + + + One font weight darker than the parent element. + + + One font weight lighter than the parent element. + + + + + + + + + + + + Same as . + + + + + + + + + Same as . + + + + + + + + + + Represents an orientation in an Scalable Vector Graphics document. + + + + + Gets the value of the unit. + + + + + Gets the value of the unit. + + + + + Indicates whether this instance and a specified object are equal. + + Another object to compare to. + + true if and this instance are the same type and represent the same value; otherwise, false. + + + + + Performs an implicit conversion from to . + + The value. + The result of the conversion. + + + + Overflow is not rendered. + + + The value is inherited from the parent element. + + + The overflow is rendered - same as "visible". + + + Overflow is rendered. + + + Overflow causes a scrollbar to appear (horizontal, vertical or both). + + + + Represents a list of used with the and . + + + + + A class to convert string into instances. + + + + + Converts the given object to the type of this converter, using the specified context and culture information. + + An that provides a format context. + The to use as the current culture. + The to convert. + + An that represents the converted value. + + The conversion cannot be performed. + + + This property describes decorations that are added to the text of an element. Conforming SVG Viewers are not required to support the blink value. + + + The value is inherited from the parent element. + + + The text is not decorated + + + The text is underlined. + + + The text is overlined. + + + The text is struck through. + + + The text will blink. + + + Indicates the type of adjustments which the user agent shall make to make the rendered length of the text match the value specified on the ‘textLength’ attribute. + + The user agent is required to achieve correct start and end positions for the text strings, but the locations of intermediate glyphs are not predictable because user agents might employ advanced algorithms to stretch or compress text strings in order to balance correct start and end positioning with optimal typography. + Note that, for a text string that contains n characters, the adjustments to the advance values often occur only for n−1 characters (see description of attribute ‘textLength’), whereas stretching or compressing of the glyphs will be applied to all n characters. + + + + Indicates that only the advance values are adjusted. The glyphs themselves are not stretched or compressed. + + + Indicates that the advance values are adjusted and the glyphs themselves stretched or compressed in one axis (i.e., a direction parallel to the inline-progression-direction). + + + Indicates the method by which text should be rendered along the path. + + + Indicates that the glyphs should be rendered using simple 2x3 transformations such that there is no stretching/warping of the glyphs. Typically, supplemental rotation, scaling and translation transformations are done for each glyph to be rendered. As a result, with align, fonts where the glyphs are designed to be connected (e.g., cursive fonts), the connections may not align properly when text is rendered along a path. + + + Indicates that the glyph outlines will be converted into paths, and then all end points and control points will be adjusted to be along the perpendicular vectors from the path, thereby stretching and possibly warping the glyphs. With this approach, connected glyphs, such as in cursive scripts, will maintain their connections. + + + Indicates how the user agent should determine the spacing between glyphs that are to be rendered along a path. + + + Indicates that the glyphs should be rendered exactly according to the spacing rules as specified in Text on a path layout rules. + + + Indicates that the user agent should use text-on-a-path layout algorithms to adjust the spacing between glyphs in order to achieve visually appealing results. + + + + Represents a unit in an Scalable Vector Graphics document. + + + + + Gets and empty . + + + + + Gets an with a value of none. + + + + + Gets a value to determine whether the unit is empty. + + + + + Gets whether this unit is none. + + + + + Gets the value of the unit. + + + + + Gets the of unit. + + + + + Converts the current unit to one that can be used at render time. + + The container element used as the basis for calculations + The representation of the current unit in a device value (usually pixels). + + + + Converts the current unit to a percentage, if applicable. + + An of type . + + + + Performs an implicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The value. + The result of the conversion. + + + + Initializes a new instance of the struct. + + The type. + The value. + + + + Initializes a new instance of the struct. + + The value. + + + + Defines the various types of unit an can be. + + + + + Indicates that the unit holds no value. + + + + + Indicates that the unit is in pixels. + + + + + Indicates that the unit is equal to the pt size of the current font. + + + + + Indicates that the unit is equal to the x-height of the current font. + + + + + Indicates that the unit is a percentage. + + + + + Indicates that the unit has no unit identifier and is a value in the current user coordinate system. + + + + + Indicates the the unit is in inches. + + + + + Indicates that the unit is in centimeters. + + + + + Indicates that the unit is in millimeters. + + + + + Indicates that the unit is in picas. + + + + + Indicates that the unit is in points, the smallest unit of measure, being a subdivision of the larger . There are 12 points in the . + + + + + Represents a list of . + + + + + A class to convert string into instances. + + + + + Converts the given object to the type of this converter, using the specified context and culture information. + + An that provides a format context. + The to use as the current culture. + The to convert. + + An that represents the converted value. + + The conversion cannot be performed. + + + + It is often desirable to specify that a given set of graphics stretch to fit a particular container element. The viewBox attribute provides this capability. + + + + + Gets or sets the position where the viewport starts horizontally. + + + + + Gets or sets the position where the viewport starts vertically. + + + + + Gets or sets the width of the viewport. + + + + + Gets or sets the height of the viewport. + + + + + Performs an implicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The value. + The result of the conversion. + + + + Initializes a new instance of the struct. + + The min X. + The min Y. + The width. + The height. + + + + Converts the given object to the type of this converter, using the specified context and culture information. + + An that provides a format context. + The to use as the current culture. + The to convert. + + An that represents the converted value. + + The conversion cannot be performed. + + + + Represents a list of re-usable SVG components. + + + + + Initializes a new instance of the class. + + + + + Renders the and contents to the specified object. + + The object to render to. + + + + Represents a list of re-usable SVG components. + + + + + Initializes a new instance of the class. + + + + + Renders the and contents to the specified object. + + The object to render to. + + + + An represents an SVG fragment that can be the root element or an embedded fragment of an SVG document. + + + + + Gets the SVG namespace string. + + + + + Gets or sets the position where the left point of the svg should start. + + + + + Gets or sets the position where the top point of the svg should start. + + + + + Gets or sets the width of the fragment. + + The width. + + + + Gets or sets the height of the fragment. + + The height. + + + + Gets or sets the viewport of the element. + + + + + + Gets or sets the aspect of the viewport. + + + + + + Refers to the size of the font from baseline to baseline when multiple lines of text are set solid in a multiline layout environment. + + + + + Indicates which font family is to be used to render the text. + + + + + Applies the required transforms to . + + The to be transformed. + + + + Gets the for this element. + + + + + + Gets the bounds of the svg element. + + The bounds. + + + + Initializes a new instance of the class. + + + + + An element used to group SVG shapes. + + + + + Gets the for this element. + + + + + + Gets the bounds of the element. + + The bounds. + + + + The �switch� element evaluates the �requiredFeatures�, �requiredExtensions� and �systemLanguage� attributes on its direct child elements in order, and then processes and renders the first child for which these attributes evaluate to true + + + + + Gets the for this element. + + + + + + Gets the bounds of the element. + + The bounds. + + + + Renders the and contents to the specified object. + + The object to render to. + + + + An element used to group SVG shapes. + + + + + Gets or sets the viewport of the element. + + + + + + Gets or sets the aspect of the viewport. + + + + + + Gets the for this element. + + + + + + Gets the bounds of the element. + + The bounds. + + + + Applies the required transforms to . + + The to be transformed. + + + + Applies the required transforms to . + + The to be transformed. + + + + Initializes a new instance of the class. + + + + + The �foreignObject� element allows for inclusion of a foreign namespace which has its graphical content drawn by a different user agent + + + + + Gets the for this element. + + + + + + Gets the bounds of the element. + + The bounds. + + + + Note: this is not used in calculations to bitmap - used only to allow for svg xml output + + + + + matrix | saturate | hueRotate | luminanceToAlpha + Indicates the type of matrix operation. The keyword 'matrix' indicates that a full 5x4 matrix of values will be provided. The other keywords represent convenience shortcuts to allow commonly used color operations to be performed without specifying a complete matrix. If attribute �type� is not specified, then the effect is as if a value of matrix were specified. + Note: this is not used in calculations to bitmap - used only to allow for svg xml output + + + + + + Gets or sets the radius of the blur (only allows for one value - not the two specified in the SVG Spec) + + + + + Note: this is not used in calculations to bitmap - used only to allow for svg xml output + + + + + The amount to offset the input graphic along the x-axis. The offset amount is expressed in the coordinate system established by attribute �primitiveUnits� on the �filter� element. + If the attribute is not specified, then the effect is as if a value of 0 were specified. + Note: this is not used in calculations to bitmap - used only to allow for svg xml output + + + + + The amount to offset the input graphic along the y-axis. The offset amount is expressed in the coordinate system established by attribute �primitiveUnits� on the �filter� element. + If the attribute is not specified, then the effect is as if a value of 0 were specified. + Note: this is not used in calculations to bitmap - used only to allow for svg xml output + + + + + A filter effect consists of a series of graphics operations that are applied to a given source graphic to produce a modified graphical result. + + + + + Gets or sets the position where the left point of the filter. + + + + + Gets or sets the position where the top point of the filter. + + + + + Gets or sets the width of the resulting filter graphic. + + + + + Gets or sets the height of the resulting filter graphic. + + + + + Gets or sets the color-interpolation-filters of the resulting filter graphic. + NOT currently mapped through to bitmap + + + + + Initializes a new instance of the class. + + + + + Renders the and contents to the specified object. + + The object to render to. + + + + Creates a new object that is a copy of the current instance. + + + A new object that is a copy of this instance. + + + + + Publish the element name to be able to differentiate non-svg elements. + + + + If specified, upon conversion, the default value will result in 'null'. + + + Creates a new instance. + + + Creates a new instance. + Specified the default value of the enum. + + + Attempts to convert the provided value to . + + + Attempts to convert the value to the destination type. + + + + Defines the methods and properties required for an SVG element to be styled. + + + + + Converts string representations of colours into objects. + + + + + Converts the given object to the converter's native type. + + A that provides a format context. You can use this object to get additional information about the environment from which this converter is being invoked. + A that specifies the culture to represent the color. + The object to convert. + + An representing the converted value. + + The conversion cannot be performed. + + + + + + + Converts HSL color (with HSL specified from 0 to 1) to RGB color. + Taken from http://www.geekymonkey.com/Programming/CSharp/RGB2HSL_HSL2RGB.htm + + + + + + + + + An unspecified . + + + + + A that should inherit from its parent. + + + + + A wrapper for a paint server which isn't defined currently in the parse process, but + should be defined by the time the image needs to render. + + + + + A wrapper for a paint server has a fallback if the primary server doesn't work. + + + + + Provides the base class for all paint servers that wish to render a gradient. + + + + + Initializes a new instance of the class. + + + + + Called by the underlying when an element has been added to the + collection. + + The that has been added. + An representing the index where the element was added to the collection. + + + + Called by the underlying when an element has been removed from the + collection. + + The that has been removed. + + + + Gets the ramp of colors to use on a gradient. + + + + + Specifies what happens if the gradient starts or ends inside the bounds of the target rectangle. + + + + + Gets or sets the coordinate system of the gradient. + + + + + Gets or sets another gradient fill from which to inherit the stops from. + + + + + Gets a representing the 's gradient stops. + + The parent . + The opacity of the colour blend. + + + Indicates what happens if the gradient starts or ends inside the bounds of the target rectangle. + + Possible values are: 'pad', which says to use the terminal colors of the gradient to fill the remainder of the target region, 'reflect', which says to reflect the gradient pattern start-to-end, end-to-start, start-to-end, etc. continuously until the target rectangle is filled, and repeat, which says to repeat the gradient pattern start-to-end, start-to-end, start-to-end, etc. continuously until the target region is filled. + If the attribute is not specified, the effect is as if a value of 'pad' were specified. + + + + Use the terminal colors of the gradient to fill the remainder of the target region. + + + Reflect the gradient pattern start-to-end, end-to-start, start-to-end, etc. continuously until the target rectangle is filled. + + + Repeat the gradient pattern start-to-end, start-to-end, start-to-end, etc. continuously until the target region is filled. + + + + Represents a colour stop in a gradient. + + + + + Gets or sets the offset, i.e. where the stop begins from the beginning, of the gradient stop. + + + + + Gets or sets the colour of the gradient stop. + + + + + Gets or sets the opacity of the gradient stop (0-1). + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The offset. + The colour. + + + + + Render this marker using the slope of the given line segment + + + + + + + + + Render this marker using the average of the slopes of the two given line segments + + + + + + + + + + Common code for rendering a marker once the orientation angle has been calculated + + + + + + + + + Create a pen that can be used to render this marker + + + + + + + Get a clone of the current path, scaled for the stroke width + + + + + + Adjust the given value to account for the width of the viewbox in the viewport + + + + + + + Adjust the given value to account for the height of the viewbox in the viewport + + + + + + + Represents the base class for all paint servers that are intended to be used as a fill or stroke. + + + + + An unspecified . + + + + + Initializes a new instance of the class. + + + + + Renders the and contents to the specified object. + + The object to render to. + + + + Gets a representing the current paint server. + + The owner . + The opacity of the brush. + + + + Returns a that represents the current . + + + A that represents the current . + + + + + A pattern is used to fill or stroke an object using a pre-defined graphic object which can be replicated ("tiled") at fixed intervals in x and y to cover the areas to be painted. + + + + + Specifies a supplemental transformation which is applied on top of any + transformations necessary to create a new pattern coordinate system. + + + + + Gets or sets the aspect of the viewport. + + + + + + Gets or sets the width of the pattern. + + + + + Gets or sets the width of the pattern. + + + + + Gets or sets the width of the pattern. + + + + + Gets or sets the height of the pattern. + + + + + Gets or sets the X-axis location of the pattern. + + + + + Gets or sets the Y-axis location of the pattern. + + + + + Gets or sets another gradient fill from which to inherit the stops from. + + + + + Initializes a new instance of the class. + + + + + Gets a representing the current paint server. + + The owner . + The opacity of the brush. + + + + Determine how much (approximately) the path must be scaled to contain the rectangle + + Bounds that the path must contain + Path of the gradient + Scale factor + + This method continually transforms the rectangle (fewer points) until it is contained by the path + and returns the result of the search. The scale factor is set to a constant 95% + + + + Specifies the shape to be used at the end of open subpaths when they are stroked. + + + The value is inherited from the parent element. + + + The ends of the subpaths are square but do not extend past the end of the subpath. + + + The ends of the subpaths are rounded. + + + The ends of the subpaths are square. + + + Specifies the shape to be used at the corners of paths or basic shapes when they are stroked. + + + The value is inherited from the parent element. + + + The corners of the paths are joined sharply. + + + The corners of the paths are rounded off. + + + The corners of the paths are "flattened". + + + + Represents an SVG path element. + + + + + Gets or sets a of path data. + + + + + Gets or sets the length of the path. + + + + + Gets or sets the marker (end cap) of the path. + + + + + Gets or sets the marker (start cap) of the path. + + + + + Gets or sets the marker (start cap) of the path. + + + + + Gets the for this element. + + + + + Gets the bounds of the element. + + The bounds. + + + + Initializes a new instance of the class. + + + + + Renders the stroke of the to the specified + + The object to render to. + + + + Parses the specified string into a collection of path segments. + + A containing path data. + + + + Creates point with absolute coorindates. + + Raw X-coordinate value. + Raw Y-coordinate value. + Current path segments. + true if and contains relative coordinate values, otherwise false. + that contains absolute coordinates. + + + + Creates point with absolute coorindates. + + Raw X-coordinate value. + Raw Y-coordinate value. + Current path segments. + true if contains relative coordinate value, otherwise false. + true if contains relative coordinate value, otherwise false. + that contains absolute coordinates. + + + + Convenience wrapper around a graphics object + + + + + Initializes a new instance of the class. + + + + + Creates a new from the specified . + + from which to create the new . + + + + Creates a new from the specified . + + The to create the renderer from. + + + + + Indicates that the SVG shape rendering properties from the parent will be used. + + Based of parent. If parents are also not set, then + + + + Indicates that the user agent shall make appropriate tradeoffs to balance speed, crisp edges and geometric precision, but with geometric precision given more importance than speed and crisp edges. + + true + + + + Indicates that the user agent shall emphasize rendering speed over geometric precision and crisp edges. This option will sometimes cause the user agent to turn off shape anti-aliasing. + + false + + + + Indicates that the user agent shall attempt to emphasize the contrast between clean edges of artwork over rendering speed and geometric precision. To achieve crisp edges, the user agent might turn off anti-aliasing for all lines and curves or possibly just for straight lines which are close to vertical or horizontal. Also, the user agent might adjust line positions and line widths to align edges with device pixels. + + false + + + + Indicates that the user agent shall emphasize geometric precision over speed and crisp edges. + + false + + + + The creator of SVG content might want to provide a hint about what tradeoffs to make as the browser renders text. The text-rendering attribute provides these hints. + + https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/text-rendering + Not Implemented yet. + + + + Indicates that the SVG shape rendering properties from the parent will be used. + + + + + Indicates that the browser shall make appropriate tradeoffs to balance speed, legibility and geometric precision, but with legibility given more importance than speed and geometric precision. + + + + + Indicates that the user agent shall emphasize rendering speed over legibility and geometric precision. This option will sometimes cause some browsers to turn off text anti-aliasing. + + + + + Indicates that the browser shall emphasize legibility over rendering speed and geometric precision. The user agent will often choose whether to apply anti-aliasing techniques, built-in font hinting or both to produce the most legible text. + + + + + Indicates that the browser shall emphasize geometric precision over legibility and rendering speed. This option will usually cause the user agent to suspend the use of hinting so that glyph outlines are drawn with comparable geometric precision to the rendering of path data. + + + + + The image-rendering attribute provides a hint to the browser about how to make speed vs. quality tradeoffs as it performs image processing. + + https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/image-rendering + Not Implemented yet. + + + + Indicates that the SVG shape rendering properties from the parent will be used. + + + + + Indicates that the user agent shall make appropriate tradeoffs to balance speed and quality, but quality shall be given more importance than speed. + + + + + Indicates that the user agent shall emphasize rendering speed over quality. + + + + + Indicates that the user agent shall emphasize quality over rendering speed. + + + + + Specifies the SVG attribute name of the associated property. + + + + + Gets a containing the XLink namespace (http://www.w3.org/1999/xlink). + + + + + When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. + + An to compare with this instance of . + + true if this instance equals ; otherwise, false. + + + + + Gets the name of the SVG attribute. + + + + + Gets the name of the SVG attribute. + + + + + Gets the namespace of the SVG attribute. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified attribute name. + + The name of the SVG attribute. + + + + Initializes a new instance of the class with the specified SVG attribute name and namespace. + + The name of the SVG attribute. + The namespace of the SVG attribute (e.g. http://www.w3.org/2000/svg). + + + + A collection of Scalable Vector Attributes that can be inherited from the owner elements ancestors. + + + + + Initialises a new instance of a with the given as the owner. + + The owner of the collection. + + + + Gets the attribute with the specified name. + + The type of the attribute value. + A containing the name of the attribute. + The attribute value if available; otherwise the default value of . + + + + Gets the attribute with the specified name. + + The type of the attribute value. + A containing the name of the attribute. + The value to return if a value hasn't already been specified. + The attribute value if available; otherwise the default value of . + + + + Gets the attribute with the specified name and inherits from ancestors if there is no attribute set. + + The type of the attribute value. + A containing the name of the attribute. + The attribute value if available; otherwise the ancestors value for the same attribute; otherwise the default value of . + + + + Gets the attribute with the specified name. + + A containing the attribute name. + The attribute value associated with the specified name; If there is no attribute the parent's value will be inherited. + + + + Fired when an Atrribute has changed + + + + + A collection of Custom Attributes + + + + + Initialises a new instance of a with the given as the owner. + + The owner of the collection. + + + + Gets the attribute with the specified name. + + A containing the attribute name. + The attribute value associated with the specified name; If there is no attribute the parent's value will be inherited. + + + + Fired when an Atrribute has changed + + + + + Create a deep copy of this . + + A deep copy of this + + + + Holds a dictionary of the default values of the SVG specification + + + + + Checks whether the property value is the default value of the svg definition. + + Name of the svg attribute + .NET value of the attribute + + + + The class used to create and load SVG documents. + + + + + Initializes a new instance of the class. + + + + + Gets an for this document. + + + + + Overwrites the current IdManager with a custom implementation. + Be careful with this: If elements have been inserted into the document before, + you have to take care that the new IdManager also knows of them. + + + + + + Gets or sets the Pixels Per Inch of the rendered image. + + + + + Gets or sets an external Cascading Style Sheet (CSS) + + + + + Retrieves the with the specified ID. + + A containing the ID of the element to find. + An of one exists with the specified ID; otherwise false. + + + + Retrieves the with the specified ID. + + A containing the ID of the element to find. + An of one exists with the specified ID; otherwise false. + + + + Opens the document at the specified path and loads the SVG contents. + + A containing the path of the file to open. + An with the contents loaded. + The document at the specified cannot be found. + + + + Opens the document at the specified path and loads the SVG contents. + + A containing the path of the file to open. + An with the contents loaded. + The document at the specified cannot be found. + + + + Opens the document at the specified path and loads the SVG contents. + + A containing the path of the file to open. + A dictionary of custom entity definitions to be used when resolving XML entities within the document. + An with the contents loaded. + The document at the specified cannot be found. + + + + Attempts to open an SVG document from the specified . + + The containing the SVG document to open. + + + + Attempts to create an SVG document from the specified string data. + + The SVG data. + + + + Opens an SVG document from the specified and adds the specified entities. + + The containing the SVG document to open. + Custom entity definitions. + The parameter cannot be null. + + + + Opens an SVG document from the specified . + + The containing the SVG document XML. + The parameter cannot be null. + + + + Renders the to the specified . + + The to render the document with. + The parameter cannot be null. + + + + Renders the to the specified . + + The to be rendered to. + The parameter cannot be null. + + + + Renders the and returns the image as a . + + A containing the rendered document. + + + + Renders the into a given Bitmap . + + + + + Renders the in given size and returns the image as a . + + A containing the rendered document. + + + + If both or one of raster height and width is not given (0), calculate that missing value from original SVG size + while keeping original SVG size ratio + + + + + + + + Maps a URI to an object containing the actual resource. + + The URI returned from + The current implementation does not use this parameter when resolving URIs. This is provided for future extensibility purposes. For example, this can be mapped to the xlink:role and used as an implementation specific argument in other scenarios. + The type of object to return. The current implementation only returns System.IO.Stream objects. + + A System.IO.Stream object or null if a type other than stream is specified. + + + is neither null nor a Stream type. + The specified URI is not an absolute URI. + + is null. + There is a runtime error (for example, an interrupted server connection). + + + + The base class of which all SVG elements are derived from. + + + + + Gets the name of the element. + + + + + Gets or sets the color of this element which drives the currentColor property. + + + + + Gets or sets the content of the element. + + + + + Gets an of all events belonging to the element. + + + + + Occurs when the element is loaded. + + + + + Gets a collection of all child . + + + + + Gets a value to determine whether the element has children. + + + + + Gets the parent . + + An if one exists; otherwise null. + + + + Gets the owner . + + + + + Gets a collection of element attributes. + + + + + Gets a collection of custom attributes + + + + + Applies the required transforms to . + + The to be transformed. + + + + Removes any previously applied transforms from the specified . + + The that should have transforms removed. + + + + Applies the required transforms to . + + The to be transformed. + + + + Removes any previously applied transforms from the specified . + + The that should have transforms removed. + + + + Gets or sets the element transforms. + + The transforms. + + + + Gets or sets the ID of the element. + + The ID is already used within the . + + + + Gets or sets the space handling. + + The space handling. + + + + Only used by the ID Manager + + + + + + Called by the underlying when an element has been added to the + collection. + + The that has been added. + An representing the index where the element was added to the collection. + + + + Fired when an Element was added to the children of this Element + + + + + Calls the method with the specified parameters. + + The that has been added. + An representing the index where the element was added to the collection. + + + + Called by the underlying when an element has been removed from the + collection. + + The that has been removed. + + + + Calls the method with the specified as the parameter. + + The that has been removed. + + + + Initializes a new instance of the class. + + + + + Renders this element to the . + + The that the element should use to render itself. + + + Derrived classes may decide that the element should not be written. For example, the text element shouldn't be written if it's empty. + + + + Renders the and contents to the specified object. + + The object to render to. + + + + Renders the children of this . + + The to render the child s to. + + + + Renders the and contents to the specified object. + + The object to render to. + + + + Recursive method to add up the paths of all children + + + + + + + Recursive method to add up the paths of all children + + + + + + + Creates a new object that is a copy of the current instance. + + + A new object that is a copy of this instance. + + + + + Fired when an Atrribute of this Element has changed + + + + + Fired when an Atrribute of this Element has changed + + + + + Gets or sets a value indicating whether this element's is dirty. + + + true if the path is dirty; otherwise, false. + + + + + Force recreation of the paths for the element and it's children. + + + + + Gets or sets the fill of this element. + + + + + Gets or sets the to be used when rendering a stroke around this element. + + + + + Gets or sets the opacity of this element's . + + + + + Gets or sets the width of the stroke (if the property has a valid value specified. + + + + + Gets or sets the opacity of the stroke, if the property has been specified. 1.0 is fully opaque; 0.0 is transparent. + + + + + Gets or sets the colour of the gradient stop. + + + + + Gets or sets the opacity of the element. 1.0 is fully opaque; 0.0 is transparent. + + + + + Refers to the AnitAlias rendering of shapes. + + + + + Gets or sets the text anchor. + + + + + Specifies dominant-baseline positioning of text. + + + + + Indicates which font family is to be used to render the text. + + + + + Refers to the size of the font from baseline to baseline when multiple lines of text are set solid in a multiline layout environment. + + + + + Refers to the style of the font. + + + + + Refers to the varient of the font. + + + + + Refers to the boldness of the font. + + + + + Refers to the boldness of the font. + + + + + Set all font information. + + + + + Get the font information based on data stored with the text object or inherited from the parent. + + + + + + Describes the Attribute which was set + + + + + Content of this whas was set + + + + + Describes the Attribute which was set + + + + + Represents the state of the mouse at the moment the event occured. + + + + + 1 = left, 2 = middle, 3 = right + + + + + Amount of mouse clicks, e.g. 2 for double click + + + + + Alt modifier key pressed + + + + + Shift modifier key pressed + + + + + Control modifier key pressed + + + + + Represents a string argument + + + + + Alt modifier key pressed + + + + + Shift modifier key pressed + + + + + Control modifier key pressed + + + + + Create a deep copy of this . + + A deep copy of this + + + This interface mostly indicates that a node is not to be drawn when rendering the SVG. + + + + Specifies the SVG name of an . + + + + + Gets the name of the SVG element. + + + + + Initializes a new instance of the class with the specified element name; + + The name of the SVG element. + + + + Represents a collection of s. + + + + + Initialises a new instance of an class. + + The owner of the collection. + + + + Returns the index of the specified in the collection. + + The to search for. + The index of the element if it is present; otherwise -1. + + + + Inserts the given to the collection at the specified index. + + The index that the should be added at. + The to be added. + + + + expensive recursive search for nodes of type T + + + + + + + expensive recursive search for first node of type T + + + + + + + Provides the methods required in order to parse and create instances from XML. + + + + + Gets a list of available types that can be used when creating an . + + + + + Creates an from the current node in the specified . + + The containing the node to parse into an . + The parameter cannot be null. + The CreateDocument method can only be used to parse root <svg> elements. + + + + Creates an from the current node in the specified . + + The containing the node to parse into a subclass of . + The that the created element belongs to. + The and parameters cannot be null. + + + + Contains information about a type inheriting from . + + + + + Gets the SVG name of the . + + + + + Gets the of the subclass. + + + + + Initializes a new instance of the struct. + + Name of the element. + Type of the element. + + + + Initializes a new instance of the class. + + + + + Provides methods to ensure element ID's are valid and unique. + + + + + Retrieves the with the specified ID. + + A containing the ID of the element to find. + An of one exists with the specified ID; otherwise false. + + + + Adds the specified for ID management. + + The to be managed. + + + + Adds the specified for ID management. + And can auto fix the ID if it already exists or it starts with a number. + + The to be managed. + Pass true here, if you want the ID to be fixed + If not null, the action is called before the id is fixed + true, if ID was altered + + + + Removed the specified from ID management. + + The to be removed from ID management. + + + + Ensures that the specified ID is valid within the containing . + + A containing the ID to validate. + Creates a new unique id . + + The ID cannot start with a digit. + An element with the same ID already exists within the containing . + + + + + Initialises a new instance of an . + + The containing the s to manage. + + + + Svg helpers + + + + + Gets the text value of the current node. + + + The value returned depends on the of the node. The following table lists node types that have a value to return. All other node types return String.Empty.Node Type Value AttributeThe value of the attribute. CDATAThe content of the CDATA section. CommentThe content of the comment. DocumentTypeThe internal subset. ProcessingInstructionThe entire content, excluding the target. SignificantWhitespaceThe white space within an xml:space= 'preserve' scope. TextThe content of the text node. WhitespaceThe white space between markup. XmlDeclarationThe content of the declaration. + + + + Gets the local name of the current node. + + + The name of the current node with the prefix removed. For example, LocalName is book for the element <bk:book>.For node types that do not have a name (like Text, Comment, and so on), this property returns String.Empty. + + + + Moves to the next attribute. + + + true if there is a next attribute; false if there are no more attributes. + + + + + Reads the next node from the stream. + + + true if the next node was read successfully; false if there are no more nodes to read. + + An error occurred while parsing the XML. + + + + Resolves the entity reference for EntityReference nodes. + + + + + Gets the text value of the current node. + + + The value returned depends on the of the node. The following table lists node types that have a value to return. All other node types return String.Empty.Node Type Value AttributeThe value of the attribute. CDATAThe content of the CDATA section. CommentThe content of the comment. DocumentTypeThe internal subset. ProcessingInstructionThe entire content, excluding the target. SignificantWhitespaceThe white space within an xml:space= 'preserve' scope. TextThe content of the text node. WhitespaceThe white space between markup. XmlDeclarationThe content of the declaration. + + + + Gets the local name of the current node. + + + The name of the current node with the prefix removed. For example, LocalName is book for the element <bk:book>.For node types that do not have a name (like Text, Comment, and so on), this property returns String.Empty. + + + + Moves to the next attribute. + + + true if there is a next attribute; false if there are no more attributes. + + + + + Reads the next node from the stream. + + + true if the next node was read successfully; false if there are no more nodes to read. + + An error occurred while parsing the XML. + + + + Resolves the entity reference for EntityReference nodes. + + + + + http://stackoverflow.com/questions/3633000/net-enumerate-winforms-font-styles + + + + + Evaluates the integral of the function over the integral using the specified number of points + + + + + + + + http://en.wikipedia.org/wiki/B%C3%A9zier_curve + + + http://www.cs.mtu.edu/~shene/COURSES/cs3621/NOTES/spline/Bezier/bezier-der.html + + + + Indicates which font family is to be used to render the text. + + + + + Refers to the size of the font from baseline to baseline when multiple lines of text are set solid in a multiline layout environment. + + + + + Refers to the style of the font. + + + + + Refers to the varient of the font. + + + + + Refers to the boldness of the font. + + + + + Gets or sets a of path data. + + + + + Gets the for this element. + + + + + Initializes a new instance of the class. + + + + + The element defines a graphics element consisting of text. + + + + + Initializes the class. + + + + + Initializes a new instance of the class. + + The text. + + + + Text anchor is used to align (start-, middle- or end-alignment) a string of text relative to a given point. + + + + The value is inherited from the parent element. + + + + The rendered characters are aligned such that the start of the text string is at the initial current text position. + + + + + The rendered characters are aligned such that the middle of the text string is at the current text position. + + + + + The rendered characters are aligned such that the end of the text string is at the initial current text position. + + + + + Gets or sets the text to be rendered. + + + + + Gets or sets the X. + + The X. + + + + Gets or sets the dX. + + The dX. + + + + Gets or sets the Y. + + The Y. + + + + Gets or sets the dY. + + The dY. + + + + Gets or sets the rotate. + + The rotate. + + + + The pre-calculated length of the text + + + + + Gets or sets the text anchor. + + The text anchor. + + + + Specifies spacing behavior between text characters. + + + + + Specifies spacing behavior between words. + + + + + Gets or sets the fill. + + + Unlike other s, has a default fill of black rather than transparent. + + The fill. + + + + Returns a that represents the current . + + + A that represents the current . + + + + + Gets the bounds of the element. + + The bounds. + + + + Renders the and contents to the specified object. + + The object to render to. + Necessary to make sure that any internal tspan elements get rendered as well + + + + Gets the for this element. + + + + + + Sets the path on this element and all child elements. Uses the state + object to track the state of the drawing + + State of the drawing operation + + + + Prepare the text according to the whitespace handling rules. SVG Spec. + + Text to be prepared + Prepared text + + + Empty text elements are not legal - only write this element if it has children. + + + + The element defines a graphics element consisting of text. + + + + + Represents and element that may be transformed. + + + + + Gets or sets an of element transforms. + + + + + Applies the required transforms to . + + The to be transformed. + + + + Removes any previously applied transforms from the specified . + + The that should have transforms removed. + + + + The class which applies custom transform to this Matrix (Required for projects created by the Inkscape). + + + + + The class which applies the specified shear vector to this Matrix. + + + + + The class which applies the specified skew vector to this Matrix. + + + + + Multiplies all matrices + + The result of all transforms + + + + Fired when an SvgTransform has changed + + + + + Converts the given object to the type of this converter, using the specified context and culture information. + + An that provides a format context. + The to use as the current culture. + The to convert. + + An that represents the converted value. + + The conversion cannot be performed. + + + The maximum allowed codepoint (defined in Unicode). + + + + Return the shortest form possible + + + + + exposed enumeration for the adding of separators into term lists + + + + + An implementation that generates + human-readable description of the selector. + + + + + Initializes the text. + + + + + Gets the generated human-readable description text. + + + + + Generates human-readable for a selector in a group. + + + + + Concludes the text. + + + + + Adds to the generated human-readable text. + + + + + Generates human-readable text of this type selector. + + + + + Generates human-readable text of this universal selector. + + + + + Generates human-readable text of this ID selector. + + + + + Generates human-readable text of this class selector. + + + + + Generates human-readable text of this attribute selector. + + + + + Generates human-readable text of this attribute selector. + + + + + Generates human-readable text of this attribute selector. + + + + + Generates human-readable text of this attribute selector. + + + + + Generates human-readable text of this attribute selector. + + + + + Generates human-readable text of this attribute selector. + + + + + Generates human-readable text of this attribute selector. + + + + + Generates human-readable text of this pseudo-class selector. + + + + + Generates human-readable text of this pseudo-class selector. + + + + + Generates human-readable text of this pseudo-class selector. + + + + + Generates human-readable text of this pseudo-class selector. + + + + + Generates human-readable text of this pseudo-class selector. + + + + + Generates human-readable text of this combinator. + + + + + Generates human-readable text of this combinator. + + + + + Generates human-readable text of this combinator. + + + + + Generates a combinator, + which separates two sequences of simple selectors. The elements represented + by the two sequences share the same parent in the document tree and the + element represented by the first sequence precedes (not necessarily + immediately) the element represented by the second one. + + + + + Generates human-readable text of this combinator. + + + + + Represents a selectors implementation for an arbitrary document/node system. + + + + + Generates a type selector, + which represents an instance of the element type in the document tree. + + + + + Generates a universal selector, + any single element in the document tree in any namespace + (including those without a namespace) if no default namespace + has been specified for selectors. + + + + + Generates a ID selector, + which represents an element instance that has an identifier that + matches the identifier in the ID selector. + + + + + Generates a class selector, + which is an alternative when + representing the class attribute. + + + + + Generates an attribute selector + that represents an element with the given attribute + whatever the values of the attribute. + + + + + Generates an attribute selector + that represents an element with the given attribute + and whose value is exactly . + + + + + Generates an attribute selector + that represents an element with the given attribute + and whose value is a whitespace-separated list of words, one of + which is exactly . + + + + + Generates an attribute selector + that represents an element with the given attribute , + its value either being exactly or beginning + with immediately followed by "-" (U+002D). + + + + + Generates an attribute selector + that represents an element with the attribute + whose value begins with the prefix . + + + + + Generates an attribute selector + that represents an element with the attribute + whose value ends with the suffix . + + + + + Generates an attribute selector + that represents an element with the attribute + whose value contains at least one instance of the substring . + + + + + Generates a pseudo-class selector, + which represents an element that is the first child of some other element. + + + + + Generates a pseudo-class selector, + which represents an element that is the last child of some other element. + + + + + Generates a pseudo-class selector, + which represents an element that is the N-th child of some other element. + + + + + Generates a pseudo-class selector, + which represents an element that has a parent element and whose parent + element has no other element children. + + + + + Generates a pseudo-class selector, + which represents an element that has no children at all. + + + + + Generates a combinator, + which represents a childhood relationship between two elements. + + + + + Generates a combinator, + which represents a relationship between two elements where one element is an + arbitrary descendant of some ancestor element. + + + + + Generates a combinator, + which represents elements that share the same parent in the document tree and + where the first element immediately precedes the second element. + + + + + Generates a combinator, + which separates two sequences of simple selectors. The elements represented + by the two sequences share the same parent in the document tree and the + element represented by the first sequence precedes (not necessarily + immediately) the element represented by the second one. + + + + + Generates a pseudo-class selector, + which represents an element that is the N-th child from bottom up of some other element. + + + + + Represent an implementation that is responsible for generating + an implementation for a selector. + + + + + Delimits the initialization of a generation. + + + + + Delimits the closing/conclusion of a generation. + + + + + Delimits a selector generation in a group of selectors. + + + + + Generates a type selector, + which represents an instance of the element type in the document tree. + + + + + Generates a universal selector, + any single element in the document tree in any namespace + (including those without a namespace) if no default namespace + has been specified for selectors. + + + + + Generates a ID selector, + which represents an element instance that has an identifier that + matches the identifier in the ID selector. + + + + + Generates a class selector, + which is an alternative when + representing the class attribute. + + + + + Generates an attribute selector + that represents an element with the given attribute + whatever the values of the attribute. + + + + + Generates an attribute selector + that represents an element with the given attribute + and whose value is exactly . + + + + + Generates an attribute selector + that represents an element with the given attribute + and whose value is a whitespace-separated list of words, one of + which is exactly . + + + + + Generates an attribute selector + that represents an element with the given attribute , + its value either being exactly or beginning + with immediately followed by "-" (U+002D). + + + + + Generates an attribute selector + that represents an element with the attribute + whose value begins with the prefix . + + + + + Generates an attribute selector + that represents an element with the attribute + whose value ends with the suffix . + + + + + Generates an attribute selector + that represents an element with the attribute + whose value contains at least one instance of the substring . + + + + + Generates a pseudo-class selector, + which represents an element that is the first child of some other element. + + + + + Generates a pseudo-class selector, + which represents an element that is the last child of some other element. + + + + + Generates a pseudo-class selector, + which represents an element that is the N-th child of some other element. + + + + + Generates a pseudo-class selector, + which represents an element that has a parent element and whose parent + element has no other element children. + + + + + Generates a pseudo-class selector, + which represents an element that has no children at all. + + + + + Generates a combinator, + which represents a childhood relationship between two elements. + + + + + Generates a combinator, + which represents a relationship between two elements where one element is an + arbitrary descendant of some ancestor element. + + + + + Generates a combinator, + which represents elements that share the same parent in the document tree and + where the first element immediately precedes the second element. + + + + + Generates a combinator, + which separates two sequences of simple selectors. The elements represented + by the two sequences share the same parent in the document tree and the + element represented by the first sequence precedes (not necessarily + immediately) the element represented by the second one. + + + + + Generates a pseudo-class selector, + which represents an element that is the N-th child from bottom up of some other element. + + + + + Represent a type or attribute name. + + + + + Represents a name from either the default or any namespace + in a target document, depending on whether a default namespace is + in effect or not. + + + + + Represents an empty namespace. + + + + + Represents any namespace. + + + + + Initializes an instance with a namespace prefix specification. + + + + + Gets the raw text value of this instance. + + + + + Indicates whether this instance represents a name + from either the default or any namespace in a target + document, depending on whether a default namespace is + in effect or not. + + + + + Indicates whether this instance represents a name + from any namespace (including one without one) + in a target document. + + + + + Indicates whether this instance represents a name + without a namespace in a target document. + + + + + Indicates whether this instance represents a name from a + specific namespace or not. + + + + + Indicates whether this instance and a specified object are equal. + + + + + Indicates whether this instance and another are equal. + + + + + Returns the hash code for this instance. + + + + + Returns a string representation of this instance. + + + + + Formats this namespace together with a name. + + + + + Semantic parser for CSS selector grammar. + + + + + Parses a CSS selector group and generates its implementation. + + + + + Parses a CSS selector group and generates its implementation. + + + + + Parses a tokenized stream representing a CSS selector group and + generates its implementation. + + + + + Parses a tokenized stream representing a CSS selector group and + generates its implementation. + + + + + Adds reading semantics to a base with the + option to un-read and insert new elements while consuming the source. + + + + + Initialize a new with a base + object. + + + + + Initialize a new with a base + object. + + + + + Indicates whether there is, at least, one value waiting to be read or not. + + + + + Pushes back a new value that will be returned on the next read. + + + + + Reads and returns the next value. + + + + + Peeks the next value waiting to be read. + + + Thrown if there is no value waiting to be read. + + + + + Returns an enumerator that iterates through the remaining + values to be read. + + + + + Disposes the enumerator used to initialize this object + if that enumerator supports . + + + + + Represents a selector implementation over an arbitrary type of elements. + + + + + A selector generator implementation for an arbitrary document/element system. + + + + + Initializes a new instance of this object with an instance + of and the default equality + comparer that is used for determining if two elements are equal. + + + + + Initializes a new instance of this object with an instance + of and an equality comparer + used for determining if two elements are equal. + + + + + Gets the selector implementation. + + + If the generation is not complete, this property returns the + last generated selector. + + + + + Gets the instance that this object + was initialized with. + + + + + Returns the collection of selector implementations representing + a group. + + + If the generation is not complete, this method return the + selectors generated so far in a group. + + + + + Adds a generated selector. + + + + + Delimits the initialization of a generation. + + + + + Delimits a selector generation in a group of selectors. + + + + + Delimits the closing/conclusion of a generation. + + + + + Generates a ID selector, + which represents an element instance that has an identifier that + matches the identifier in the ID selector. + + + + + Generates a class selector, + which is an alternative when + representing the class attribute. + + + + + Generates a type selector, + which represents an instance of the element type in the document tree. + + + + + Generates a universal selector, + any single element in the document tree in any namespace + (including those without a namespace) if no default namespace + has been specified for selectors. + + + + + Generates an attribute selector + that represents an element with the given attribute + whatever the values of the attribute. + + + + + Generates an attribute selector + that represents an element with the given attribute + and whose value is exactly . + + + + + Generates an attribute selector + that represents an element with the given attribute + and whose value is a whitespace-separated list of words, one of + which is exactly . + + + + + Generates an attribute selector + that represents an element with the given attribute , + its value either being exactly or beginning + with immediately followed by "-" (U+002D). + + + + + Generates an attribute selector + that represents an element with the attribute + whose value begins with the prefix . + + + + + Generates an attribute selector + that represents an element with the attribute + whose value ends with the suffix . + + + + + Generates an attribute selector + that represents an element with the attribute + whose value contains at least one instance of the substring . + + + + + Generates a pseudo-class selector, + which represents an element that is the first child of some other element. + + + + + Generates a pseudo-class selector, + which represents an element that is the last child of some other element. + + + + + Generates a pseudo-class selector, + which represents an element that is the N-th child of some other element. + + + + + Generates a pseudo-class selector, + which represents an element that has a parent element and whose parent + element has no other element children. + + + + + Generates a pseudo-class selector, + which represents an element that has no children at all. + + + + + Generates a combinator, + which represents a childhood relationship between two elements. + + + + + Generates a combinator, + which represents a relationship between two elements where one element is an + arbitrary descendant of some ancestor element. + + + + + Generates a combinator, + which represents elements that share the same parent in the document tree and + where the first element immediately precedes the second element. + + + + + Generates a combinator, + which separates two sequences of simple selectors. The elements represented + by the two sequences share the same parent in the document tree and the + element represented by the first sequence precedes (not necessarily + immediately) the element represented by the second one. + + + + + Generates a pseudo-class selector, + which represents an element that is the N-th child from bottom up of some other element. + + + + + An implementation that delegates + to two other objects, which + can be useful for doing work in a single pass. + + + + + Gets the first generator used to initialize this generator. + + + + + Gets the second generator used to initialize this generator. + + + + + Initializes a new instance of + with the two other objects + it delegates to. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Delegates to then generator. + + + + + Implementation for a selectors compiler that supports caching. + + + This class is primarily targeted for developers of selection + over an arbitrary document model. + + + + + Creates a caching selectors compiler on top on an existing compiler. + + + + + Creates a caching selectors compiler on top on an existing compiler. + An addition parameter specified a dictionary to use as the cache. + + + If is null then this method uses a + the implementation with an + ordinally case-insensitive selectors text comparer. + + + + + Represent a token and optionally any text associated with it. + + + + + Gets the kind/type/class of the token. + + + + + Gets text, if any, associated with the token. + + + + + Creates an end-of-input token. + + + + + Creates a star token. + + + + + Creates a dot token. + + + + + Creates a colon token. + + + + + Creates a comma token. + + + + + Creates a right parenthesis token. + + + + + Creates an equals token. + + + + + Creates a left bracket token. + + + + + Creates a right bracket token. + + + + + Creates a pipe (vertical line) token. + + + + + Creates a plus token. + + + + + Creates a greater token. + + + + + Creates an includes token. + + + + + Creates a dash-match token. + + + + + Creates a prefix-match token. + + + + + Creates a suffix-match token. + + + + + Creates a substring-match token. + + + + + Creates a general sibling token. + + + + + Creates an identifier token. + + + + + Creates an integer token. + + + + + Creates a hash-name token. + + + + + Creates a white-space token. + + + + + Creates a string token. + + + + + Creates a function token. + + + + + Creates an arbitrary character token. + + + + + Indicates whether this instance and a specified object are equal. + + + + + Returns the hash code for this instance. + + + + + Indicates whether the current object is equal to another object of the same type. + + + + + Gets a string representation of the token. + + + + + Performs a logical comparison of the two tokens to determine + whether they are equal. + + + + + Performs a logical comparison of the two tokens to determine + whether they are inequal. + + + + + Lexer for tokens in CSS selector grammar. + + + + + Parses tokens from a given text source. + + + + + Parses tokens from a given string. + + + + + Represents the classification of a token. + + + + + Represents end of input/file/stream + + + + + Represents {ident} + + + + + Represents "#" {name} + + + + + Represents "~=" + + + + + Represents "|=" + + + + + Represents "^=" + + + + + Represents "$=" + + + + + Represents "*=" + + + + + Represents {string} + + + + + Represents S* "+" + + + + + Represents S* ">" + + + + + Represents [ \t\r\n\f]+ + + + + + Represents {ident} ")" + + + + + Represents [0-9]+ + + + + + Represents S* "~" + + + + + Represents an arbitrary character + + + + diff --git a/ZZPDFTest/bin/Debug/Helper.dll b/ZZPDFTest/bin/Debug/Helper.dll new file mode 100644 index 00000000..6ecdf256 Binary files /dev/null and b/ZZPDFTest/bin/Debug/Helper.dll differ diff --git a/ZZPDFTest/bin/Debug/Helper.pdb b/ZZPDFTest/bin/Debug/Helper.pdb new file mode 100644 index 00000000..066704b8 Binary files /dev/null and b/ZZPDFTest/bin/Debug/Helper.pdb differ diff --git a/ZZPDFTest/bin/Debug/Logging.dll b/ZZPDFTest/bin/Debug/Logging.dll new file mode 100644 index 00000000..6e5b17fd Binary files /dev/null and b/ZZPDFTest/bin/Debug/Logging.dll differ diff --git a/ZZPDFTest/bin/Debug/Logging.pdb b/ZZPDFTest/bin/Debug/Logging.pdb new file mode 100644 index 00000000..049e0f64 Binary files /dev/null and b/ZZPDFTest/bin/Debug/Logging.pdb differ diff --git a/ZZPDFTest/bin/Debug/MW6.SDK.dll b/ZZPDFTest/bin/Debug/MW6.SDK.dll new file mode 100644 index 00000000..bed1c51c Binary files /dev/null and b/ZZPDFTest/bin/Debug/MW6.SDK.dll differ diff --git a/ZZPDFTest/bin/Debug/Model.dll b/ZZPDFTest/bin/Debug/Model.dll new file mode 100644 index 00000000..e9b2b2dd Binary files /dev/null and b/ZZPDFTest/bin/Debug/Model.dll differ diff --git a/ZZPDFTest/bin/Debug/Model.pdb b/ZZPDFTest/bin/Debug/Model.pdb new file mode 100644 index 00000000..db579073 Binary files /dev/null and b/ZZPDFTest/bin/Debug/Model.pdb differ diff --git a/ZZPDFTest/bin/Debug/NLog.Database.dll b/ZZPDFTest/bin/Debug/NLog.Database.dll new file mode 100644 index 00000000..d5c959ec Binary files /dev/null and b/ZZPDFTest/bin/Debug/NLog.Database.dll differ diff --git a/ZZPDFTest/bin/Debug/NLog.Database.xml b/ZZPDFTest/bin/Debug/NLog.Database.xml new file mode 100644 index 00000000..2ca03c0e --- /dev/null +++ b/ZZPDFTest/bin/Debug/NLog.Database.xml @@ -0,0 +1,461 @@ + + + + NLog.Database + + + + + Information about database command + parameters. + + + + + Gets or sets the type of the command. + + The type of the command. + + + + + Gets or sets the connection string to run the command against. If not provided, connection string from the target is used. + + + + + + Gets or sets the command text. + + + + + + Gets or sets a value indicating whether to ignore failures. + + + + + + Gets the collection of parameters. Each parameter contains a mapping + between NLog layout and a database named or positional parameter. + + + + + + Information about object-property for the database-connection-object + + + + + Initializes a new instance of the class. + + + + + Gets or sets the name for the object-property + + + + + + Gets or sets the value to assign on the object-property + + + + + + Gets or sets the type of the object-property + + + + + + Gets or sets convert format of the property value + + + + + + Gets or sets the culture used for parsing property string-value for type-conversion + + + + + + Render Result Value + + Log event for rendering + Result value when available, else fallback to defaultValue + + + + Represents a parameter to a Database target. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Name of the parameter. + The parameter layout. + + + + Gets or sets the database parameter name. + + + + + + Gets or sets the layout that should be use to calculate the value for the parameter. + + + + + + Gets or sets the database parameter DbType. + + + + + + Gets or sets the database parameter size. + + + + + + Gets or sets the database parameter precision. + + + + + + Gets or sets the database parameter scale. + + + + + + Gets or sets the type of the parameter. + + + + + + Gets or sets the fallback value when result value is not available + + + + + + Gets or sets convert format of the database parameter value. + + + + + + Gets or sets the culture used for parsing parameter string-value for type-conversion + + + + + + Gets or sets whether empty value should translate into DbNull. Requires database column to allow NULL values. + + + + + + Render Result Value + + Log event for rendering + Result value when available, else fallback to defaultValue + + + + Writes log messages to the database using an ADO.NET provider. + + + + Note .NET Core application cannot load connectionstrings from app.config / web.config. Instead use ${configsetting} + + See NLog Wiki + + Documentation on NLog Wiki + + + The configuration is dependent on the database type, because + there are different methods of specifying connection string, SQL + command and command parameters. + + MS SQL Server using System.Data.SqlClient: + + Oracle using System.Data.OracleClient: + + Oracle using System.Data.OleDBClient: + + To set up the log target programmatically use code like this (an equivalent of MSSQL configuration): + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Name of the target. + + + + Gets or sets the name of the database provider. + + + + The parameter name should be a provider invariant name as registered in machine.config or app.config. Common values are: + +
    +
  • System.Data.SqlClient - SQL Sever Client
    • +
  • System.Data.SqlServerCe.3.5 - SQL Sever Compact 3.5
    • +
  • System.Data.OracleClient - Oracle Client from Microsoft (deprecated in .NET Framework 4)
    • +
  • Oracle.DataAccess.Client - ODP.NET provider from Oracle
    • +
  • System.Data.SQLite - System.Data.SQLite driver for SQLite
    • +
  • Npgsql - Npgsql driver for PostgreSQL
    • +
  • MySql.Data.MySqlClient - MySQL Connector/Net
    • +
+ (Note that provider invariant names are not supported on .NET Compact Framework). + + Alternatively the parameter value can be be a fully qualified name of the provider + connection type (class implementing ) or one of the following tokens: + +
    +
  • sqlserver, mssql, microsoft or msde - SQL Server Data Provider
    • +
  • oledb - OLEDB Data Provider
    • +
  • odbc - ODBC Data Provider
    • +
+ + + + + + Gets or sets the name of the connection string (as specified in <connectionStrings> configuration section. + + + + + + Gets or sets the connection string. When provided, it overrides the values + specified in DBHost, DBUserName, DBPassword, DBDatabase. + + + + + + Gets or sets the connection string using for installation and uninstallation. If not provided, regular ConnectionString is being used. + + + + + + Gets the installation DDL commands. + + + + + + Gets the uninstallation DDL commands. + + + + + + Gets or sets a value indicating whether to keep the + database connection open between the log events. + + + + + + Gets or sets the database host name. If the ConnectionString is not provided + this value will be used to construct the "Server=" part of the + connection string. + + + + + + Gets or sets the database user name. If the ConnectionString is not provided + this value will be used to construct the "User ID=" part of the + connection string. + + + + + + Gets or sets the database password. If the ConnectionString is not provided + this value will be used to construct the "Password=" part of the + connection string. + + + + + + Gets or sets the database name. If the ConnectionString is not provided + this value will be used to construct the "Database=" part of the + connection string. + + + + + + Gets or sets the text of the SQL command to be run on each log level. + + + Typically this is a SQL INSERT statement or a stored procedure call. + It should use the database-specific parameters (marked as @parameter + for SQL server or :parameter for Oracle, other data providers + have their own notation) and not the layout renderers, + because the latter is prone to SQL injection attacks. + The layout renderers should be specified as <parameter /> elements instead. + + + + + + Gets or sets the type of the SQL command to be run on each log level. + + + This specifies how the command text is interpreted, as "Text" (default) or as "StoredProcedure". + When using the value StoredProcedure, the commandText-property would + normally be the name of the stored procedure. TableDirect method is not supported in this context. + + + + + + Gets the collection of parameters. Each item contains a mapping + between NLog layout and a database named or positional parameter. + + + + + + Gets the collection of properties. Each item contains a mapping + between NLog layout and a property on the DbConnection instance + + + + + + Gets the collection of properties. Each item contains a mapping + between NLog layout and a property on the DbCommand instance + + + + + + Configures isolated transaction batch writing. If supported by the database, then it will improve insert performance. + + + + + + Performs installation which requires administrative permissions. + + The installation context. + + + + Performs uninstallation which requires administrative permissions. + + The installation context. + + + + Determines whether the item is installed. + + The installation context. + + Value indicating whether the item is installed or null if it is not possible to determine. + + + + + + + + Set the to use it for opening connections to the database. + + + + + + + + Writes the specified logging event to the database. It creates + a new database command, prepares parameters for it by calculating + layouts and executes the command. + + The logging event. + + + + Writes an array of logging events to the log target. By default it iterates on all + events and passes them to "Write" method. Inheriting classes can use this method to + optimize batch writes. + + Logging events to be written out. + + + + Write logEvent to database + + + + + Build the connectionstring from the properties. + + + Using at first, and falls back to the properties , + , and + + Event to render the layout inside the properties. + + + + + Escape quotes and semicolons. + See https://docs.microsoft.com/en-us/previous-versions/windows/desktop/ms722656(v=vs.85)#setting-values-that-use-reserved-characters + + + + + Create database parameter + + Current command. + Parameter configuration info. + + + + Extract parameter value from the logevent + + Current logevent. + Parameter configuration info. + + + + Reflection helpers. + + + + diff --git a/ZZPDFTest/bin/Debug/NLog.dll b/ZZPDFTest/bin/Debug/NLog.dll new file mode 100644 index 00000000..54fe6253 Binary files /dev/null and b/ZZPDFTest/bin/Debug/NLog.dll differ diff --git a/ZZPDFTest/bin/Debug/NLog.xml b/ZZPDFTest/bin/Debug/NLog.xml new file mode 100644 index 00000000..96ffa38b --- /dev/null +++ b/ZZPDFTest/bin/Debug/NLog.xml @@ -0,0 +1,29155 @@ + + + + NLog + + + + + Interface for serialization of object values into JSON format + + + + + Serialization of an object into JSON format. + + The object to serialize to JSON. + Output destination. + Serialize succeeded (true/false) + + + + Auto-generated Logger members for binary compatibility with NLog 1.0. + + + Provides logging interface and utility functions. + + + + + Writes the diagnostic message at the Trace level. + + A to be written. + + + + Writes the diagnostic message at the Trace level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + + + + Writes the diagnostic message at the Trace level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + + + + Writes the diagnostic message at the Trace level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + Third argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format.s + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level. + + A to be written. + + + + Writes the diagnostic message at the Debug level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + Third argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level. + + A to be written. + + + + Writes the diagnostic message at the Info level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + + + + Writes the diagnostic message at the Info level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + + + + Writes the diagnostic message at the Info level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + Third argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level. + + A to be written. + + + + Writes the diagnostic message at the Warn level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + + + + Writes the diagnostic message at the Warn level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + + + + Writes the diagnostic message at the Warn level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + Third argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level. + + A to be written. + + + + Writes the diagnostic message at the Error level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + + + + Writes the diagnostic message at the Error level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + + + + Writes the diagnostic message at the Error level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + Third argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level. + + A to be written. + + + + Writes the diagnostic message at the Fatal level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + + + + Writes the diagnostic message at the Fatal level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + Third argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Gets a value indicating whether logging is enabled for the Trace level. + + A value of if logging is enabled for the Trace level, otherwise it returns . + + + + Gets a value indicating whether logging is enabled for the Debug level. + + A value of if logging is enabled for the Debug level, otherwise it returns . + + + + Gets a value indicating whether logging is enabled for the Info level. + + A value of if logging is enabled for the Info level, otherwise it returns . + + + + Gets a value indicating whether logging is enabled for the Warn level. + + A value of if logging is enabled for the Warn level, otherwise it returns . + + + + Gets a value indicating whether logging is enabled for the Error level. + + A value of if logging is enabled for the Error level, otherwise it returns . + + + + Gets a value indicating whether logging is enabled for the Fatal level. + + A value of if logging is enabled for the Fatal level, otherwise it returns . + + + + Writes the diagnostic message at the Trace level using the specified format provider and format parameters. + + + Writes the diagnostic message at the Trace level. + + Type of the value. + The value to be written. + + + + Writes the diagnostic message at the Trace level. + + Type of the value. + An IFormatProvider that supplies culture-specific formatting information. + The value to be written. + + + + Writes the diagnostic message at the Trace level. + + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Obsolete and replaced by - Writes the diagnostic message and exception at the Trace level. + + A to be written. + An exception to be logged. + This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. + + + + Writes the diagnostic message and exception at the Trace level. + + A to be written. + An exception to be logged. + + + + Writes the diagnostic message and exception at the Trace level. + + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message and exception at the Trace level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message at the Trace level using the specified parameters and formatting them with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Trace level. + + Log message. + + + + Writes the diagnostic message at the Trace level using the specified parameters. + + A containing format items. + Arguments to format. + + + + Obsolete and replaced by - Writes the diagnostic message and exception at the Trace level. + + A to be written. + An exception to be logged. + This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. + + + + Writes the diagnostic message at the Trace level using the specified parameter and formatting it with the supplied format provider. + + The type of the argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified parameter. + + The type of the argument. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Trace level using the specified parameters. + + The type of the first argument. + The type of the second argument. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Trace level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Trace level using the specified parameters. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Debug level using the specified format provider and format parameters. + + + Writes the diagnostic message at the Debug level. + + Type of the value. + The value to be written. + + + + Writes the diagnostic message at the Debug level. + + Type of the value. + An IFormatProvider that supplies culture-specific formatting information. + The value to be written. + + + + Writes the diagnostic message at the Debug level. + + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message and exception at the Debug level. + + A to be written. + An exception to be logged. + + + + Writes the diagnostic message and exception at the Debug level. + + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message and exception at the Debug level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message at the Debug level using the specified parameters and formatting them with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Debug level. + + Log message. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Debug level using the specified parameter and formatting it with the supplied format provider. + + The type of the argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified parameter. + + The type of the argument. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + + The type of the first argument. + The type of the second argument. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Debug level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Obsolete and replaced by - Writes the diagnostic message and exception at the Debug level. + + A to be written. + An exception to be logged. + This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. + + + + Obsolete and replaced by - Writes the diagnostic message and exception at the Debug level. + + A to be written. + An exception to be logged. + This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. + + + + Writes the diagnostic message at the Info level using the specified format provider and format parameters. + + + Writes the diagnostic message at the Info level. + + Type of the value. + The value to be written. + + + + Writes the diagnostic message at the Info level. + + Type of the value. + An IFormatProvider that supplies culture-specific formatting information. + The value to be written. + + + + Writes the diagnostic message at the Info level. + + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message and exception at the Info level. + + A to be written. + An exception to be logged. + + + + Writes the diagnostic message and exception at the Info level. + + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message and exception at the Info level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message at the Info level using the specified parameters and formatting them with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Info level. + + Log message. + + + + Writes the diagnostic message at the Info level using the specified parameters. + + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Info level using the specified parameter and formatting it with the supplied format provider. + + The type of the argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified parameter. + + The type of the argument. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Info level using the specified parameters. + + The type of the first argument. + The type of the second argument. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Info level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Info level using the specified parameters. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Obsolete and replaced by - Writes the diagnostic message and exception at the Info level. + + A to be written. + An exception to be logged. + This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. + + + + Obsolete and replaced by - Writes the diagnostic message and exception at the Info level. + + A to be written. + An exception to be logged. + This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. + + + + Writes the diagnostic message at the Warn level using the specified format provider and format parameters. + + + Writes the diagnostic message at the Warn level. + + Type of the value. + The value to be written. + + + + Writes the diagnostic message at the Warn level. + + Type of the value. + An IFormatProvider that supplies culture-specific formatting information. + The value to be written. + + + + Writes the diagnostic message at the Warn level. + + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message and exception at the Warn level. + + A to be written. + An exception to be logged. + + + + Writes the diagnostic message and exception at the Warn level. + + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message and exception at the Warn level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message at the Warn level using the specified parameters and formatting them with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Warn level. + + Log message. + + + + Writes the diagnostic message at the Warn level using the specified parameters. + + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Warn level using the specified parameter and formatting it with the supplied format provider. + + The type of the argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified parameter. + + The type of the argument. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Warn level using the specified parameters. + + The type of the first argument. + The type of the second argument. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Warn level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Warn level using the specified parameters. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Obsolete and replaced by - Writes the diagnostic message and exception at the Warn level. + + A to be written. + An exception to be logged. + This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. + + + + Obsolete and replaced by - Writes the diagnostic message and exception at the Warn level. + + A to be written. + An exception to be logged. + This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. + + + + Writes the diagnostic message at the Error level using the specified format provider and format parameters. + + + Writes the diagnostic message at the Error level. + + Type of the value. + The value to be written. + + + + Writes the diagnostic message at the Error level. + + Type of the value. + An IFormatProvider that supplies culture-specific formatting information. + The value to be written. + + + + Writes the diagnostic message at the Error level. + + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message and exception at the Error level. + + A to be written. + An exception to be logged. + + + + Writes the diagnostic message and exception at the Error level. + + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message and exception at the Error level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message at the Error level using the specified parameters and formatting them with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Error level. + + Log message. + + + + Writes the diagnostic message at the Error level using the specified parameters. + + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Error level using the specified parameter and formatting it with the supplied format provider. + + The type of the argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified parameter. + + The type of the argument. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Error level using the specified parameters. + + The type of the first argument. + The type of the second argument. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Error level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Error level using the specified parameters. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Obsolete and replaced by - Writes the diagnostic message and exception at the Error level. + + A to be written. + An exception to be logged. + This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. + + + + Obsolete and replaced by - Writes the diagnostic message and exception at the Error level. + + A to be written. + An exception to be logged. + This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. + + + + Writes the diagnostic message at the Fatal level using the specified format provider and format parameters. + + + Writes the diagnostic message at the Fatal level. + + Type of the value. + The value to be written. + + + + Writes the diagnostic message at the Fatal level. + + Type of the value. + An IFormatProvider that supplies culture-specific formatting information. + The value to be written. + + + + Writes the diagnostic message at the Fatal level. + + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message and exception at the Fatal level. + + A to be written. + An exception to be logged. + + + + Writes the diagnostic message and exception at the Fatal level. + + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message and exception at the Fatal level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message at the Fatal level using the specified parameters and formatting them with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Fatal level. + + Log message. + + + + Writes the diagnostic message at the Fatal level using the specified parameters. + + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Fatal level using the specified parameter and formatting it with the supplied format provider. + + The type of the argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified parameter. + + The type of the argument. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified parameters. + + The type of the first argument. + The type of the second argument. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified parameters. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Obsolete and replaced by - Writes the diagnostic message and exception at the Fatal level. + + A to be written. + An exception to be logged. + This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. + + + + Obsolete and replaced by - Writes the diagnostic message and exception at the Fatal level. + + A to be written. + An exception to be logged. + This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. + + + + Auto-generated Logger members for binary compatibility with NLog 1.0. + + + Obsolete and replaced by with NLog v5.3. + + Logger with only generic methods (passing 'LogLevel' to methods) and core properties. + + + + + Writes the diagnostic message at the specified level. + + The log level. + A to be written. + + + + Writes the diagnostic message at the specified level. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + + + + Writes the diagnostic message at the specified level using the specified parameters. + + The log level. + A containing format items. + First argument to format. + Second argument to format. + + + + Writes the diagnostic message at the specified level using the specified parameters. + + The log level. + A containing format items. + First argument to format. + Second argument to format. + Third argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Obsolete on the ILogger-interface, instead use with NLog v5.3. + Occurs when logger configuration changes. + + + + + Gets the name of the logger. + + + + + Obsolete on the ILogger-interface, instead use with NLog v5.3. + Gets the factory that created this logger. + + + + + Gets a value indicating whether logging is enabled for the specified level. + + Log level to be checked. + A value of if logging is enabled for the specified level, otherwise it returns . + + + + Writes the specified diagnostic message. + + Log event. + + + + Writes the specified diagnostic message. + + Type of custom Logger wrapper. + Log event. + + + + Writes the diagnostic message at the specified level using the specified format provider and format parameters. + + + Writes the diagnostic message at the specified level. + + Type of the value. + The log level. + The value to be written. + + + + Writes the diagnostic message at the specified level. + + Type of the value. + The log level. + An IFormatProvider that supplies culture-specific formatting information. + The value to be written. + + + + Writes the diagnostic message at the specified level. + + The log level. + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message and exception at the specified level. + + The log level. + A to be written. + Arguments to format. + An exception to be logged. + + + + Writes the diagnostic message and exception at the specified level. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + Arguments to format. + An exception to be logged. + + + + Writes the diagnostic message at the specified level using the specified parameters and formatting them with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the specified level. + + The log level. + Log message. + + + + Writes the diagnostic message at the specified level using the specified parameters. + + The log level. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the specified level using the specified parameter and formatting it with the supplied format provider. + + The type of the argument. + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified parameter. + + The type of the argument. + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the specified level using the specified parameters. + + The type of the first argument. + The type of the second argument. + The log level. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the specified level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the specified level using the specified parameters. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + The log level. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Obsolete and replaced by - Writes the diagnostic message and exception at the specified level. + + The log level. + A to be written. + An exception to be logged. + This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. + + + + Obsolete and replaced by - Writes the diagnostic message and exception at the specified level. + + The log level. + A to be written. + An exception to be logged. + This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. + + + + Obsolete and replaced by with NLog v5.3. + + Provides an interface to execute System.Actions without surfacing any exceptions raised for that action. + + + + + Runs the provided action. If the action throws, the exception is logged at Error level. The exception is not propagated outside of this method. + + Action to execute. + + + + Runs the provided function and returns its result. If an exception is thrown, it is logged at Error level. + The exception is not propagated outside of this method; a default value is returned instead. + + Return type of the provided function. + Function to run. + Result returned by the provided function or the default value of type in case of exception. + + + + Runs the provided function and returns its result. If an exception is thrown, it is logged at Error level. + The exception is not propagated outside of this method; a fallback value is returned instead. + + Return type of the provided function. + Function to run. + Fallback value to return in case of exception. + Result returned by the provided function or fallback value in case of exception. + + + + Logs an exception is logged at Error level if the provided task does not run to completion. + + The task for which to log an error if it does not run to completion. + This method is useful in fire-and-forget situations, where application logic does not depend on completion of task. This method is avoids C# warning CS4014 in such situations. + + + + Returns a task that completes when a specified task to completes. If the task does not run to completion, an exception is logged at Error level. The returned task always runs to completion. + + The task for which to log an error if it does not run to completion. + A task that completes in the state when completes. + + + + Runs async action. If the action throws, the exception is logged at Error level. The exception is not propagated outside of this method. + + Async action to execute. + A task that completes in the state when completes. + + + + Runs the provided async function and returns its result. If the task does not run to completion, an exception is logged at Error level. + The exception is not propagated outside of this method; a default value is returned instead. + + Return type of the provided function. + Async function to run. + A task that represents the completion of the supplied task. If the supplied task ends in the state, the result of the new task will be the result of the supplied task; otherwise, the result of the new task will be the default value of type . + + + + Runs the provided async function and returns its result. If the task does not run to completion, an exception is logged at Error level. + The exception is not propagated outside of this method; a fallback value is returned instead. + + Return type of the provided function. + Async function to run. + Fallback value to return if the task does not end in the state. + A task that represents the completion of the supplied task. If the supplied task ends in the state, the result of the new task will be the result of the supplied task; otherwise, the result of the new task will be the fallback value. + + + + Render a message template property to a string + + + + + Serialization of an object, e.g. JSON and append to + + The object to serialize to string. + Parameter Format + Parameter CaptureType + An object that supplies culture-specific formatting information. + Output destination. + Serialize succeeded (true/false) + + + + Support implementation of + + + + + + + + + + + + + + + + + Mark a parameter of a method for message templating + + + + + Specifies which parameter of an annotated method should be treated as message-template-string + + + + + The name of the parameter that should be as treated as message-template-string + + + + + Asynchronous continuation delegate - function invoked at the end of asynchronous + processing. + + Exception during asynchronous processing or null if no exception + was thrown. + + + + Helpers for asynchronous operations. + + + + + Iterates over all items in the given collection and runs the specified action + in sequence (each action executes only after the preceding one has completed without an error). + + Type of each item. + The items to iterate. + The asynchronous continuation to invoke once all items + have been iterated. + The action to invoke for each item. + + + + Repeats the specified asynchronous action multiple times and invokes asynchronous continuation at the end. + + The repeat count. + The asynchronous continuation to invoke at the end. + The action to invoke. + + + + Modifies the continuation by pre-pending given action to execute just before it. + + The async continuation. + The action to pre-pend. + Continuation which will execute the given action before forwarding to the actual continuation. + + + + Attaches a timeout to a continuation which will invoke the continuation when the specified + timeout has elapsed. + + The asynchronous continuation. + The timeout. + Wrapped continuation. + + + + Iterates over all items in the given collection and runs the specified action + in parallel (each action executes on a thread from thread pool). + + Type of each item. + The items to iterate. + The asynchronous continuation to invoke once all items + have been iterated. + The action to invoke for each item. + + + + Runs the specified asynchronous action synchronously (blocks until the continuation has + been invoked). + + The action. + + Using this method is not recommended because it will block the calling thread. + + + + + Wraps the continuation with a guard which will only make sure that the continuation function + is invoked only once. + + The asynchronous continuation. + Wrapped asynchronous continuation. + + + + Gets the combined exception from all exceptions in the list. + + The exceptions. + Combined exception or null if no exception was thrown. + + + + Disposes the Timer, and waits for it to leave the Timer-callback-method + + The Timer object to dispose + Timeout to wait (TimeSpan.Zero means dispose without waiting) + Timer disposed within timeout (true/false) + + + + Asynchronous action. + + Continuation to be invoked at the end of action. + + + + Asynchronous action with one argument. + + Type of the argument. + Argument to the action. + Continuation to be invoked at the end of action. + + + + Represents the logging event with asynchronous continuation. + + + + + Initializes a new instance of the struct. + + The log event. + The continuation. + + + + Gets the log event. + + + + + Gets the continuation. + + + + + Implements the operator ==. + + The event info1. + The event info2. + The result of the operator. + + + + Implements the operator ==. + + The event info1. + The event info2. + The result of the operator. + + + + + + + + + + + + + String Conversion Helpers + + + + + Converts input string value into . Parsing is case-insensitive. + + Input value + Output value + Default value + Returns false if the input value could not be parsed + + + + Converts input string value into . Parsing is case-insensitive. + + Input value + The type of the enum + Output value. Null if parse failed + + + + Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. A parameter specifies whether the operation is case-sensitive. The return value indicates whether the conversion succeeded. + + The enumeration type to which to convert value. + The string representation of the enumeration name or underlying value to convert. + true to ignore case; false to consider case. + When this method returns, result contains an object of type TEnum whose value is represented by value if the parse operation succeeds. If the parse operation fails, result contains the default value of the underlying type of TEnum. Note that this value need not be a member of the TEnum enumeration. This parameter is passed uninitialized. + true if the value parameter was converted successfully; otherwise, false. + Wrapper because Enum.TryParse is not present in .net 3.5 + + + + Enum.TryParse implementation for .net 3.5 + + + Don't uses reflection + + + + Enables to extract extra context details for + + + + + Name of context + + + + + The current LogFactory next to LogManager + + + + + Handle Internal LogEvent written to the InternalLogger + + + Never use/call NLog Logger-objects when handling these internal events, as it will lead to deadlock / stackoverflow. + + + + + Internal LogEvent details from + + + + + The rendered message + + + + + The log level + + + + + The exception. Could be null. + + + + + The type that triggered this internal log event, for example the FileTarget. + This property is not always populated. + + + + + The context name that triggered this internal log event, for example the name of the Target. + This property is not always populated. + + + + + NLog internal logger. + + Writes to file, console or custom text writer (see ) + + + Don't use as that can lead to recursive calls - stackoverflow + + + + + Gets a value indicating whether internal log includes Trace messages. + + + + + Gets a value indicating whether internal log includes Debug messages. + + + + + Gets a value indicating whether internal log includes Info messages. + + + + + Gets a value indicating whether internal log includes Warn messages. + + + + + Gets a value indicating whether internal log includes Error messages. + + + + + Gets a value indicating whether internal log includes Fatal messages. + + + + + Logs the specified message without an at the Trace level. + + Message which may include positional parameters. + Arguments to the message. + + + + Logs the specified message without an at the Trace level. + + Log message. + + + + Logs the specified message without an at the Trace level. + will be only called when logging is enabled for level Trace. + + Function that returns the log message. + + + + Logs the specified message with an at the Trace level. + + Exception to be logged. + Message which may include positional parameters. + Arguments to the message. + + + + Logs the specified message without an at the Trace level. + + The type of the first argument. + Message which may include positional parameters. + Argument {0} to the message. + + + + Logs the specified message without an at the Trace level. + + The type of the first argument. + The type of the second argument. + Message which may include positional parameters. + Argument {0} to the message. + Argument {1} to the message. + + + + Logs the specified message without an at the Trace level. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + Message which may include positional parameters. + Argument {0} to the message. + Argument {1} to the message. + Argument {2} to the message. + + + + Logs the specified message with an at the Trace level. + + Exception to be logged. + Log message. + + + + Logs the specified message with an at the Trace level. + will be only called when logging is enabled for level Trace. + + Exception to be logged. + Function that returns the log message. + + + + Logs the specified message without an at the Debug level. + + Message which may include positional parameters. + Arguments to the message. + + + + Logs the specified message without an at the Debug level. + + Log message. + + + + Logs the specified message without an at the Debug level. + will be only called when logging is enabled for level Debug. + + Function that returns the log message. + + + + Logs the specified message with an at the Debug level. + + Exception to be logged. + Message which may include positional parameters. + Arguments to the message. + + + + Logs the specified message without an at the Trace level. + + The type of the first argument. + Message which may include positional parameters. + Argument {0} to the message. + + + + Logs the specified message without an at the Trace level. + + The type of the first argument. + The type of the second argument. + Message which may include positional parameters. + Argument {0} to the message. + Argument {1} to the message. + + + + Logs the specified message without an at the Trace level. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + Message which may include positional parameters. + Argument {0} to the message. + Argument {1} to the message. + Argument {2} to the message. + + + + Logs the specified message with an at the Debug level. + + Exception to be logged. + Log message. + + + + Logs the specified message with an at the Debug level. + will be only called when logging is enabled for level Debug. + + Exception to be logged. + Function that returns the log message. + + + + Logs the specified message without an at the Info level. + + Message which may include positional parameters. + Arguments to the message. + + + + Logs the specified message without an at the Info level. + + Log message. + + + + Logs the specified message without an at the Info level. + will be only called when logging is enabled for level Info. + + Function that returns the log message. + + + + Logs the specified message with an at the Info level. + + Exception to be logged. + Message which may include positional parameters. + Arguments to the message. + + + + Logs the specified message without an at the Trace level. + + The type of the first argument. + Message which may include positional parameters. + Argument {0} to the message. + + + + Logs the specified message without an at the Trace level. + + The type of the first argument. + The type of the second argument. + Message which may include positional parameters. + Argument {0} to the message. + Argument {1} to the message. + + + + Logs the specified message without an at the Trace level. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + Message which may include positional parameters. + Argument {0} to the message. + Argument {1} to the message. + Argument {2} to the message. + + + + Logs the specified message with an at the Info level. + + Exception to be logged. + Log message. + + + + Logs the specified message with an at the Info level. + will be only called when logging is enabled for level Info. + + Exception to be logged. + Function that returns the log message. + + + + Logs the specified message without an at the Warn level. + + Message which may include positional parameters. + Arguments to the message. + + + + Logs the specified message without an at the Warn level. + + Log message. + + + + Logs the specified message without an at the Warn level. + will be only called when logging is enabled for level Warn. + + Function that returns the log message. + + + + Logs the specified message with an at the Warn level. + + Exception to be logged. + Message which may include positional parameters. + Arguments to the message. + + + + Logs the specified message without an at the Trace level. + + The type of the first argument. + Message which may include positional parameters. + Argument {0} to the message. + + + + Logs the specified message without an at the Trace level. + + The type of the first argument. + The type of the second argument. + Message which may include positional parameters. + Argument {0} to the message. + Argument {1} to the message. + + + + Logs the specified message without an at the Trace level. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + Message which may include positional parameters. + Argument {0} to the message. + Argument {1} to the message. + Argument {2} to the message. + + + + Logs the specified message with an at the Warn level. + + Exception to be logged. + Log message. + + + + Logs the specified message with an at the Warn level. + will be only called when logging is enabled for level Warn. + + Exception to be logged. + Function that returns the log message. + + + + Logs the specified message without an at the Error level. + + Message which may include positional parameters. + Arguments to the message. + + + + Logs the specified message without an at the Error level. + + Log message. + + + + Logs the specified message without an at the Error level. + will be only called when logging is enabled for level Error. + + Function that returns the log message. + + + + Logs the specified message with an at the Error level. + + Exception to be logged. + Message which may include positional parameters. + Arguments to the message. + + + + Logs the specified message without an at the Trace level. + + The type of the first argument. + Message which may include positional parameters. + Argument {0} to the message. + + + + Logs the specified message without an at the Trace level. + + The type of the first argument. + The type of the second argument. + Message which may include positional parameters. + Argument {0} to the message. + Argument {1} to the message. + + + + Logs the specified message without an at the Trace level. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + Message which may include positional parameters. + Argument {0} to the message. + Argument {1} to the message. + Argument {2} to the message. + + + + Logs the specified message with an at the Error level. + + Exception to be logged. + Log message. + + + + Logs the specified message with an at the Error level. + will be only called when logging is enabled for level Error. + + Exception to be logged. + Function that returns the log message. + + + + Logs the specified message without an at the Fatal level. + + Message which may include positional parameters. + Arguments to the message. + + + + Logs the specified message without an at the Fatal level. + + Log message. + + + + Logs the specified message without an at the Fatal level. + will be only called when logging is enabled for level Fatal. + + Function that returns the log message. + + + + Logs the specified message with an at the Fatal level. + + Exception to be logged. + Message which may include positional parameters. + Arguments to the message. + + + + Logs the specified message without an at the Trace level. + + The type of the first argument. + Message which may include positional parameters. + Argument {0} to the message. + + + + Logs the specified message without an at the Trace level. + + The type of the first argument. + The type of the second argument. + Message which may include positional parameters. + Argument {0} to the message. + Argument {1} to the message. + + + + Logs the specified message without an at the Trace level. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + Message which may include positional parameters. + Argument {0} to the message. + Argument {1} to the message. + Argument {2} to the message. + + + + Logs the specified message with an at the Fatal level. + + Exception to be logged. + Log message. + + + + Logs the specified message with an at the Fatal level. + will be only called when logging is enabled for level Fatal. + + Exception to be logged. + Function that returns the log message. + + + + Set the config of the InternalLogger with defaults and config. + + + + + Gets or sets the minimal internal log level. + + If set to , then messages of the levels , and will be written. + + + + Gets or sets a value indicating whether internal messages should be written to the console output stream. + + Your application must be a console application. + + + + Gets or sets a value indicating whether internal messages should be written to the console error stream. + + Your application must be a console application. + + + + Obsolete and replaced by with NLog v5.3. + Gets or sets a value indicating whether internal messages should be written to the .Trace + + + + + Gets or sets the file path of the internal log file. + + A value of value disables internal logging to a file. + + + + Gets or sets the text writer that will receive internal logs. + + + + + Obsolete and replaced by with NLog 5.3. + Event written to the internal log. + + + EventHandler will only be triggered for events, where severity matches the configured . + + Avoid using/calling NLog Logger-objects when handling these internal events, as it will lead to deadlock / stackoverflow. + + + + + Internal LogEvent written to the InternalLogger + + + EventHandler will only be triggered for events, where severity matches the configured . + + Never use/call NLog Logger-objects when handling these internal events, as it will lead to deadlock / stackoverflow. + + + + + Gets or sets a value indicating whether timestamp should be included in internal log output. + + + + + Is there an thrown when writing the message? + + + + + Logs the specified message without an at the specified level. + + Log level. + Message which may include positional parameters. + Arguments to the message. + + + + Logs the specified message without an at the specified level. + + Log level. + Log message. + + + + Logs the specified message without an at the specified level. + will be only called when logging is enabled for level . + + Log level. + Function that returns the log message. + + + + Logs the specified message with an at the specified level. + will be only called when logging is enabled for level . + + Exception to be logged. + Log level. + Function that returns the log message. + + + + Logs the specified message with an at the specified level. + + Exception to be logged. + Log level. + Message which may include positional parameters. + Arguments to the message. + + + + Logs the specified message with an at the specified level. + + Exception to be logged. + Log level. + Log message. + + + + Write to internallogger. + + optional exception to be logged. + level + message + optional args for + + + + Create log line with timestamp, exception message etc (if configured) + + + + + Determine if logging should be avoided because of exception type. + + The exception to check. + true if logging should be avoided; otherwise, false. + + + + Determine if logging is enabled for given LogLevel + + The for the log event. + true if logging is enabled; otherwise, false. + + + + Determine if logging is enabled. + + true if logging is enabled; otherwise, false. + + + + Logs the assembly version and file version of the given Assembly. + + The assembly to log. + + + + A message has been written to the internal logger + + + + + The rendered message + + + + + The log level + + + + + The exception. Could be null. + + + + + The type that triggered this internal log event, for example the FileTarget. + This property is not always populated. + + + + + The context name that triggered this internal log event, for example the name of the Target. + This property is not always populated. + + + + + A cyclic buffer of object. + + + + + Initializes a new instance of the class. + + Buffer size. + Whether buffer should grow as it becomes full. + The maximum number of items that the buffer can grow to. + + + + Gets the capacity of the buffer + + + + + Gets the number of items in the buffer + + + + + Adds the specified log event to the buffer. + + Log event. + The number of items in the buffer. + + + + Gets the array of events accumulated in the buffer and clears the buffer as one atomic operation. + + Events in the buffer. + + + + Marks class as a log event Condition and assigns a name to it. + + + + + Initializes a new instance of the class. + + Condition method name. + + + + Marks the class as containing condition methods. + + + + + A bunch of utility methods (mostly predicates) which can be used in + condition expressions. Partially inspired by XPath 1.0. + + + + + Compares two values for equality. + + The first value. + The second value. + true when two objects are equal, false otherwise. + + + + Compares two strings for equality. + + The first string. + The second string. + Optional. If true, case is ignored; if false (default), case is significant. + true when two strings are equal, false otherwise. + + + + Gets or sets a value indicating whether the second string is a substring of the first one. + + The first string. + The second string. + Optional. If true (default), case is ignored; if false, case is significant. + true when the second string is a substring of the first string, false otherwise. + + + + Gets or sets a value indicating whether the second string is a prefix of the first one. + + The first string. + The second string. + Optional. If true (default), case is ignored; if false, case is significant. + true when the second string is a prefix of the first string, false otherwise. + + + + Gets or sets a value indicating whether the second string is a suffix of the first one. + + The first string. + The second string. + Optional. If true (default), case is ignored; if false, case is significant. + true when the second string is a prefix of the first string, false otherwise. + + + + Returns the length of a string. + + A string whose lengths is to be evaluated. + The length of the string. + + + + Indicates whether the specified regular expression finds a match in the specified input string. + + The string to search for a match. + The regular expression pattern to match. + A string consisting of the desired options for the test. The possible values are those of the separated by commas. + true if the regular expression finds a match; otherwise, false. + + + + + + + + + + + Relational operators used in conditions. + + + + + Equality (==). + + + + + Inequality (!=). + + + + + Less than (<). + + + + + Greater than (>). + + + + + Less than or equal (<=). + + + + + Greater than or equal (>=). + + + + + Exception during evaluation of condition expression. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The message. + + + + Initializes a new instance of the class. + + The message. + The inner exception. + + + + 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). + + + + + Exception during parsing of condition expression. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The message. + + + + Initializes a new instance of the class. + + The message. + The inner exception. + + + + 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). + + + + + Condition and expression. + + + + + Initializes a new instance of the class. + + Left hand side of the AND expression. + Right hand side of the AND expression. + + + + Gets the left hand side of the AND expression. + + + + + Gets the right hand side of the AND expression. + + + + + Returns a string representation of this expression. + + A concatenated '(Left) and (Right)' string. + + + + Evaluates the expression by evaluating and recursively. + + Evaluation context. + The value of the conjunction operator. + + + + Condition message expression (represented by the exception keyword). + + + + + + + + Evaluates the current . + + Evaluation context. + The object. + + + + Base class for representing nodes in condition expression trees. + + Documentation on NLog Wiki + + + + Converts condition text to a condition expression tree. + + Condition text to be converted. + Condition expression tree. + + + + Evaluates the expression. + + Evaluation context. + Expression result. + + + + Returns a string representation of the expression. + + + + + Evaluates the expression. + + Evaluation context. + Expression result. + + + + Condition layout expression (represented by a string literal + with embedded ${}). + + + + + Initializes a new instance of the class. + + The layout. + + + + Gets the layout. + + The layout. + + + + + + + Evaluates the expression by rendering the formatted output from + the + + Evaluation context. + The output rendered from the layout. + + + + Condition level expression (represented by the level keyword). + + + + + + + + Evaluates to the current log level. + + Evaluation context. + The object representing current log level. + + + + Condition literal expression (numeric, LogLevel.XXX, true or false). + + + + + Initializes a new instance of the class. + + Literal value. + + + + Gets the literal value. + + The literal value. + + + + + + + Evaluates the expression. + + Evaluation context. Ignored. + The literal value as passed in the constructor. + + + + Condition logger name expression (represented by the logger keyword). + + + + + + + + Evaluates to the logger name. + + Evaluation context. + The logger name. + + + + Condition message expression (represented by the message keyword). + + + + + + + + Evaluates to the logger message. + + Evaluation context. + The logger message. + + + + Gets the method parameters + + + + + + + + + + + Condition not expression. + + + + + Initializes a new instance of the class. + + The expression. + + + + Gets the expression to be negated. + + The expression. + + + + + + + + + + Condition or expression. + + + + + Initializes a new instance of the class. + + Left hand side of the OR expression. + Right hand side of the OR expression. + + + + Gets the left expression. + + The left expression. + + + + Gets the right expression. + + The right expression. + + + + + + + Evaluates the expression by evaluating and recursively. + + Evaluation context. + The value of the alternative operator. + + + + Condition relational (==, !=, <, <=, + > or >=) expression. + + + + + Initializes a new instance of the class. + + The left expression. + The right expression. + The relational operator. + + + + Gets the left expression. + + The left expression. + + + + Gets the right expression. + + The right expression. + + + + Gets the relational operator. + + The operator. + + + + + + + + + + Compares the specified values using specified relational operator. + + The first value. + The second value. + The relational operator. + Result of the given relational operator. + + + + Promote values to the type needed for the comparison, e.g. parse a string to int. + + + + + + + Promotes to type + + + + success? + + + + Try to promote both values. First try to promote to , + when failed, try to . + + + + + + Get the order for the type for comparison. + + + index, 0 to max int. Lower is first + + + + Dictionary from type to index. Lower index should be tested first. + + + + + Build the dictionary needed for the order of the types. + + + + + + Get the string representing the current + + + + + + Condition parser. Turns a string representation of condition expression + into an expression tree. + + + + + Initializes a new instance of the class. + + The string reader. + Instance of used to resolve references to condition methods and layout renderers. + + + + Parses the specified condition string and turns it into + tree. + + The expression to be parsed. + The root of the expression syntax tree which can be used to get the value of the condition in a specified context. + + + + Parses the specified condition string and turns it into + tree. + + The expression to be parsed. + Instance of used to resolve references to condition methods and layout renderers. + The root of the expression syntax tree which can be used to get the value of the condition in a specified context. + + + + Parses the specified condition string and turns it into + tree. + + The string reader. + Instance of used to resolve references to condition methods and layout renderers. + + The root of the expression syntax tree which can be used to get the value of the condition in a specified context. + + + + + Try stringed keyword to + + + + success? + + + + Parse number + + negative number? minus should be parsed first. + + + + + Hand-written tokenizer for conditions. + + + + + Initializes a new instance of the class. + + The string reader. + + + + Asserts current token type and advances to the next token. + + Expected token type. + If token type doesn't match, an exception is thrown. + + + + Asserts that current token is a keyword and returns its value and advances to the next token. + + Keyword value. + + + + Gets or sets a value indicating whether current keyword is equal to the specified value. + + The keyword. + + A value of true if current keyword is equal to the specified value; otherwise, false. + + + + + Gets or sets a value indicating whether the tokenizer has reached the end of the token stream. + + + A value of true if the tokenizer has reached the end of the token stream; otherwise, false. + + + + + Gets or sets a value indicating whether current token is a number. + + + A value of true if current token is a number; otherwise, false. + + + + + Gets or sets a value indicating whether the specified token is of specified type. + + The token type. + + A value of true if current token is of specified type; otherwise, false. + + + + + Gets the next token and sets and properties. + + + + + Try the comparison tokens (greater, smaller, greater-equals, smaller-equals) + + current char + is match + + + + Try the logical tokens (and, or, not, equals) + + current char + is match + + + + Mapping between characters and token types for punctuations. + + + + + Initializes a new instance of the CharToTokenType struct. + + The character. + Type of the token. + + + + Token types for condition expressions. + + + + + Marks the class or a member as advanced. Advanced classes and members are hidden by + default in generated documentation. + + + + + Initializes a new instance of the class. + + + + + Identifies that the output of layout or layout render does not change for the lifetime of the current appdomain. + + + + Implementors must have the [ThreadAgnostic] attribute + + A layout(renderer) could be converted to a literal when: + - The layout and all layout properties are SimpleLayout or [AppDomainFixedOutput] + + Recommendation: Apply this attribute to a layout or layout-renderer which have the result only changes by properties of type Layout. + + + + + Used to mark configurable parameters which are arrays. + Specifies the mapping between XML elements and .NET types. + + + + + Initializes a new instance of the class. + + The type of the array item. + The XML element name that represents the item. + + + + Gets the .NET type of the array item. + + + + + Gets the XML element name. + + + + + Load from url + + file or path, including .dll + basepath, optional + + + + + Load from url + + + + + Provides logging interface and utility functions. + + + + + Obsolete since dynamic assembly loading is not compatible with publish as trimmed application. + Event notification about trying to load assembly with NLog extensions. + + + + + Initializes a new instance of the class. + + Assembly that have been loaded + + + + The assembly that is trying to load. + + + + + Represents NLog ConfigSection for loading from app.config / web.config + + + <configSections> + <section name="NLog" type="NLog.Config.ConfigSectionHandler, NLog" /> + </configSections> + + + + + Overriding base implementation to just store + of the relevant app.config section. + + The XmlReader that reads from the configuration file. + true to serialize only the collection key properties; otherwise, false. + + + + Override base implementation to return a object + for + instead of the instance. + + + A instance, that has been deserialized from app.config. + + + + + Obsolete since dynamic tyope loading is not compatible with publish as trimmed application. + Constructs a new instance the configuration item (target, layout, layout renderer, etc.) given its type. + + Type of the item. + Created object of the specified type. + + + + Provides registration information for named items (targets, layouts, layout renderers, etc.) + + Supports creating item-instance from their type-alias, when parsing NLog configuration + + + + + Obsolete since dynamic assembly loading is not compatible with publish as trimmed application. + Called before the assembly with NLog extensions is being loaded. + + + + + Initializes a new instance of the class. + + + + + Obsolete since dynamic assembly loading is not compatible with publish as trimmed application. + Initializes a new instance of the class. + + The assemblies to scan for named items. + + + + Gets or sets default singleton instance of . + + + This property implements lazy instantiation so that the is not built before + the internal logger is configured. + + + + + Gets the factory. + + + + + Gets the factory. + + + + + Gets the factory. + + + + + Gets the ambient property factory. + + + + + Gets the factory. + + + + + Gets the factory. + + + + + Obsolete and replaced by with NLog v5.2. + Gets or sets the creator delegate used to instantiate configuration objects. + + + By overriding this property, one can enable dependency injection or interception for created objects. + + + + + Obsolete and replaced by with NLog v5.2. + Gets the factory. + + The target factory. + + + + Obsolete and replaced by with NLog v5.2. + Gets the factory. + + The layout factory. + + + + Obsolete and replaced by with NLog v5.2. + Gets the factory. + + The layout renderer factory. + + + + Obsolete and replaced by with NLog v5.2. + Gets the ambient property factory. + + The ambient property factory. + + + + Obsolete and replaced by with NLog v5.2. + Gets the factory. + + The filter factory. + + + + Obsolete and replaced by with NLog v5.2. + Gets the time source factory. + + The time source factory. + + + + Obsolete and replaced by with NLog v5.2. + Gets the condition method factory. + + The condition method factory. + + + + Obsolete and replaced by with NLog v5.2. + Gets or sets the JSON serializer to use with + + + + + Obsolete and replaced by with NLog v5.2. + Gets or sets the string serializer to use with + + + + + Obsolete and replaced by with NLog v5.2. + Gets or sets the parameter converter to use with or + + + + + Perform message template parsing and formatting of LogEvent messages (True = Always, False = Never, Null = Auto Detect) + + + - Null (Auto Detect) : NLog-parser checks for positional parameters, and will then fallback to string.Format-rendering. + - True: Always performs the parsing of and rendering of using the NLog-parser (Allows custom formatting with ) + - False: Always performs parsing and rendering using string.Format (Fastest if not using structured logging) + + + + + Obsolete since dynamic assembly loading is not compatible with publish as trimmed application. + Registers named items from the assembly. + + The assembly. + + + + Obsolete since dynamic assembly loading is not compatible with publish as trimmed application. + Registers named items from the assembly. + + The assembly. + Item name prefix. + + + + Obsolete since dynamic assembly loading is not compatible with publish as trimmed application. + Call Preload for NLogPackageLoader + + + Every package could implement a class "NLogPackageLoader" (namespace not important) with the public static method "Preload" (no arguments) + This method will be called just before registering all items in the assembly. + + + + + + Call the Preload method for . The Preload method must be static. + + + + + + Clears the contents of all factories. + + + + + Obsolete since dynamic type loading is not compatible with publish as trimmed application. + Registers the type. + + The type to register. + The item name prefix. + + + + Builds the default configuration item factory. + + Default factory. + + + + Registers items in using late-bound types, so that we don't need a reference to the dll. + + + + + Attribute used to mark the default parameters for layout renderers. + + + + + Initializes a new instance of the class. + + + + + Dynamic filtering with a positive list of enabled levels + + + + + Dynamic filtering with a minlevel and maxlevel range + + + + + Format of the exception output to the specific target. + + + + + Appends the Message of an Exception to the specified target. + + + + + Appends the type of an Exception to the specified target. + + + + + Appends the short type of an Exception to the specified target. + + + + + Appends the result of calling ToString() on an Exception to the specified target. + + + + + Appends the method name from Exception's stack trace to the specified target. + + + + + Appends the stack trace from an Exception to the specified target. + + + + + Appends the contents of an Exception's Data property to the specified target. + + + + + Destructure the exception (usually into JSON) + + + + + Appends the from the application or the object that caused the error. + + + + + Appends the from the application or the object that caused the error. + + + + + Appends any additional properties that specific type of Exception might have. + + + + + Factory for class-based items. + + The base type of each item. + The type of the attribute used to annotate items. + + + + Scans the assembly. + + The types to scan. + The assembly name for the types. + The prefix. + + + + Registers the type. + + The type to register. + The item name prefix. + + + + Registers the item based on a type name. + + Name of the item. + Name of the type. + + + + Clears the contents of the factory. + + + + + + + + + + + + + + + + + Factory specialized for s. + + + + + + + + Register a layout renderer with a callback function. + + Name of the layoutrenderer, without ${}. + the renderer that renders the value. + + + + + + + Factory of named items (such as , , , etc.). + + + + + Factory of named items (such as , , , etc.). + + + + + Registers type-creation with type-alias + + + + + Tries to create an item instance with type-alias + + True if instance was created successfully, false otherwise. + + + + Include context properties + + + + + Gets or sets the option to include all properties from the log events + + + + + + Gets or sets whether to include the contents of the properties-dictionary. + + + + + + Gets or sets whether to include the contents of the nested-state-stack. + + + + + + Did the Initialize Succeeded? true= success, false= error, null = initialize not started yet. + + + + + Implemented by objects which support installation and uninstallation. + + + + + Performs installation which requires administrative permissions. + + The installation context. + + + + Performs uninstallation which requires administrative permissions. + + The installation context. + + + + Determines whether the item is installed. + + The installation context. + + Value indicating whether the item is installed or null if it is not possible to determine. + + + + + Interface for accessing configuration details + + + + + Name of this configuration element + + + + + Configuration Key/Value Pairs + + + + + Child configuration elements + + + + + Interface for loading NLog + + + + + Finds and loads the NLog configuration + + LogFactory that owns the NLog configuration + Name of NLog.config file (optional) + NLog configuration (or null if none found) + + + + Notifies when LoggingConfiguration has been successfully applied + + LogFactory that owns the NLog configuration + NLog Config + + + + Get file paths (including filename) for the possible NLog config files. + + Name of NLog.config file (optional) + The file paths to the possible config file + + + + Level enabled flags for each LogLevel ordinal + + + + + Converts the filter into a simple + + + + + Obsolete since dynamic type loading is not compatible with publish as trimmed application. Replaced by . + Represents a factory of named items (such as targets, layouts, layout renderers, etc.). + + Base type for each item instance. + Item definition type (typically ). + + + + Registers new item definition. + + Name of the item. + Item definition. + + + + Tries to get registered item definition. + + Name of the item. + Reference to a variable which will store the item definition. + Item definition. + + + + Creates item instance. + + Name of the item. + Newly created item instance. + + + + Tries to create an item instance. + + Name of the item. + The result. + True if instance was created successfully, false otherwise. + + + + Provides context for install/uninstall operations. + + + + + Mapping between log levels and console output colors. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The log output. + + + + Gets or sets the installation log level. + + + + + Gets or sets a value indicating whether to ignore failures during installation. + + + + + Whether installation exceptions should be rethrown. If IgnoreFailures is set to true, + this property has no effect (there are no exceptions to rethrow). + + + + + Gets the installation parameters. + + + + + Gets or sets the log output. + + + + + Logs the specified trace message. + + The message. + The arguments. + + + + Logs the specified debug message. + + The message. + The arguments. + + + + Logs the specified informational message. + + The message. + The arguments. + + + + Logs the specified warning message. + + The message. + The arguments. + + + + Logs the specified error message. + + The message. + The arguments. + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Creates the log event which can be used to render layouts during install/uninstall. + + Log event info object. + + + + Convert object-value into specified type + + + + + Parses the input value and converts into the wanted type + + Input Value + Wanted Type + Format to use when parsing + Culture to use when parsing + Output value with wanted type + + + + Interface for fluent setup of LogFactory options + + + + + LogFactory under configuration + + + + + Interface for fluent setup of LoggingRules for LoggingConfiguration + + + + + LoggingRule being built + + + + + Interface for fluent setup of target for LoggingRule + + + + + LoggingConfiguration being built + + + + + LogFactory under configuration + + + + + Collection of targets that should be written to + + + + + Interface for fluent setup of LogFactory options for extension loading + + + + + LogFactory under configuration + + + + + Interface for fluent setup of LogFactory options for enabling NLog + + + + + LogFactory under configuration + + + + + Interface for fluent setup of LoggingConfiguration for LogFactory + + + + + LogFactory under configuration + + + + + LoggingConfiguration being built + + + + + Interface for fluent setup of LogFactory options + + + + + LogFactory under configuration + + + + + Interface for fluent setup of LogFactory options for logevent serialization + + + + + LogFactory under configuration + + + + + Allows components to request stack trace information to be provided in the . + + + + + Gets the level of stack trace information required by the implementing class. + + + + + Encapsulates and the logic to match the actual logger name + All subclasses defines immutable objects. + Concrete subclasses defines various matching rules through + + + + + Creates a concrete based on . + + + Rules used to select the concrete implementation returned: + + if is null => returns (never matches) + if doesn't contains any '*' nor '?' => returns (matches only on case sensitive equals) + if == '*' => returns (always matches) + if doesn't contain '?' + + if contains exactly 2 '*' one at the beginning and one at the end (i.e. "*foobar*) => returns + if contains exactly 1 '*' at the beginning (i.e. "*foobar") => returns + if contains exactly 1 '*' at the end (i.e. "foobar*") => returns + + + returns + + + + It may include one or more '*' or '?' wildcards at any position. + + '*' means zero or more occurrences of any character + '?' means exactly one occurrence of any character + + + A concrete + + + + Returns the argument passed to + + + + + Checks whether given name matches the logger name pattern. + + String to be matched. + A value of when the name matches, otherwise. + + + + Defines a that never matches. + Used when pattern is null + + + + + Defines a that always matches. + Used when pattern is '*' + + + + + Defines a that matches with a case-sensitive Equals + Used when pattern is a string without wildcards '?' '*' + + + + + Defines a that matches with a case-sensitive StartsWith + Used when pattern is a string like "*foobar" + + + + + Defines a that matches with a case-sensitive EndsWith + Used when pattern is a string like "foobar*" + + + + + Defines a that matches with a case-sensitive Contains + Used when pattern is a string like "*foobar*" + + + + + Defines a that matches with a complex wildcards combinations: + + '*' means zero or more occurrences of any character + '?' means exactly one occurrence of any character + + used when pattern is a string containing any number of '?' or '*' in any position + i.e. "*Server[*].Connection[?]" + + + + + Keeps logging configuration and provides simple API to modify it. + + This class is thread-safe..ToList() is used for that purpose. + + + + Gets the factory that will be configured + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + Gets the variables defined in the configuration or assigned from API + + Name is case insensitive. + + + + Gets a collection of named targets specified in the configuration. + + + A list of named targets. + + + Unnamed targets (such as those wrapped by other targets) are not returned. + + + + + Gets the collection of file names which should be watched for changes by NLog. + + + + + Gets the collection of logging rules. + + + + + Gets or sets the default culture info to use as . + + + Specific culture info or null to use + + + + + Gets all targets. + + + + + Inserts NLog Config Variable without overriding NLog Config Variable assigned from API + + + + + Lookup NLog Config Variable Layout + + + + + Registers the specified target object. The name of the target is read from . + + + The target object with a non + + when is + + + + Registers the specified target object under a given name. + + Name of the target. + The target object. + when is + when is + + + + Finds the target with the specified name. + + + The name of the target to be found. + + + Found target or when the target is not found. + + + + + Finds the target with the specified name and specified type. + + + The name of the target to be found. + + Type of the target + + Found target or when the target is not found of not of type + + + + + Add a rule with min- and maxLevel. + + Minimum log level needed to trigger this rule. + Maximum log level needed to trigger this rule. + Name of the target to be written when the rule matches. + Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. + + + + Add a rule with min- and maxLevel. + + Minimum log level needed to trigger this rule. + Maximum log level needed to trigger this rule. + Target to be written to when the rule matches. + Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. + + + + Add a rule with min- and maxLevel. + + Minimum log level needed to trigger this rule. + Maximum log level needed to trigger this rule. + Target to be written to when the rule matches. + Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. + Gets or sets a value indicating whether to quit processing any further rule when this one matches. + + + + Add a rule object. + + rule object to add + + + + Add a rule for one loglevel. + + log level needed to trigger this rule. + Name of the target to be written when the rule matches. + Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. + + + + Add a rule for one loglevel. + + log level needed to trigger this rule. + Target to be written to when the rule matches. + Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. + + + + Add a rule for one loglevel. + + log level needed to trigger this rule. + Target to be written to when the rule matches. + Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. + Gets or sets a value indicating whether to quit processing any further rule when this one matches. + + + + Add a rule for all loglevels. + + Name of the target to be written when the rule matches. + Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. + + + + Add a rule for all loglevels. + + Target to be written to when the rule matches. + Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. + + + + Add a rule for all loglevels. + + Target to be written to when the rule matches. + Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. + Gets or sets a value indicating whether to quit processing any further rule when this one matches. + + + + Lookup the logging rule with matching + + The name of the logging rule to be found. + Found logging rule or when not found. + + + + Removes the specified named logging rule with matching + + The name of the logging rule to be removed. + Found one or more logging rule to remove, or when not found. + + + + Called by LogManager when one of the log configuration files changes. + + + A new instance of that represents the updated configuration. + + Must assign the returned object to LogManager.Configuration to activate it + + + + Allow this new configuration to capture state from the old configuration + + Old config that is about to be replaced + Checks KeepVariablesOnReload and copies all NLog Config Variables assigned from API into the new config + + + + Removes the specified named target. + + Name of the target. + + + + Installs target-specific objects on current system. + + The installation context. + + Installation typically runs with administrative permissions. + + + + + Uninstalls target-specific objects from current system. + + The installation context. + + Uninstallation typically runs with administrative permissions. + + + + + Closes all targets and releases any unmanaged resources. + + + + + Log to the internal (NLog) logger the information about the and associated with this instance. + + + The information are only recorded in the internal logger if Debug level is enabled, otherwise nothing is + recorded. + + + + + Validates the configuration. + + + + + Replace a simple variable with a value. The original value is removed and thus we cannot redo this in a later stage. + + + + + + + Checks whether unused targets exist. If found any, just write an internal log at Warn level. + If initializing not started or failed, then checking process will be canceled + + + + + Flushes any pending log messages on all appenders. + + Config containing Targets to Flush + Flush completed notification (success / timeout) + Optional timeout that guarantees that completed notification is called. + + + + + Change this method with NLog v6 to disconnect LogFactory from Targets/Layouts + - Remove LoggingRule-List-parameter + - Return ITargetWithFilterChain[] + + + + + + + + Arguments for events. + + + + + Initializes a new instance of the class. + + The new configuration. + The old configuration. + + + + Gets the old configuration. + + The old configuration. + + + + Gets the new configuration. + + + New value can be null when unloading configuration during shutdown. + + The new configuration. + + + + Gets the optional boolean attribute value. + + + Name of the attribute. + Default value to return if the attribute is not found or if there is a parse error + Boolean attribute value or default. + + + + Remove the namespace (before :) + + + x:a, will be a + + + + + + + Enables loading of NLog configuration from a file + + + + + Get default file paths (including filename) for possible NLog config files. + + + + + Get default file paths (including filename) for possible NLog config files. + + + + + Loads NLog configuration from + + + + + Constructor + + + + + + Loads NLog configuration from provided config section + + + Directory where the NLog-config-file was loaded from + + + + Builds list with unique keys, using last value of duplicates. High priority keys placed first. + + + + + + + Parse loglevel, but don't throw if exception throwing is disabled + + Name of attribute for logging. + Value of parse. + Used if there is an exception + + + + + Parses a single config section within the NLog-config + + + Section was recognized + + + + Parse {Rules} xml element + + + Rules are added to this parameter. + + + + Parse {Logger} xml element + + + + + + Parse boolean + + Name of the property for logging. + value to parse + Default value to return if the parse failed + Boolean attribute value or default. + + + + Config element that's validated and having extra context + + + + + Explicit cast because NET35 doesn't support covariance. + + + + + Obsolete and replaced by and with NLog v5.2. + + + + + Initializes a new instance of the class. + + Whether configuration reload has succeeded. + + + + Initializes a new instance of the class. + + Whether configuration reload has succeeded. + The exception during configuration reload. + + + + Gets a value indicating whether configuration reload has succeeded. + + A value of true if succeeded; otherwise, false. + + + + Gets the exception which occurred during configuration reload. + + The exception. + + + + Enables FileWatcher for the currently loaded NLog Configuration File, + and supports automatic reload on file modification. + + + + + Represents a logging rule. An equivalent of <logger /> configuration element. + + + + + Create an empty . + + + + + Create an empty . + + + + + Create a new with a and which writes to . + + Logger name pattern used for . It may include one or more '*' or '?' wildcards at any position. + Minimum log level needed to trigger this rule. + Maximum log level needed to trigger this rule. + Target to be written to when the rule matches. + + + + Create a new with a which writes to . + + Logger name pattern used for . It may include one or more '*' or '?' wildcards at any position. + Minimum log level needed to trigger this rule. + Target to be written to when the rule matches. + + + + Create a (disabled) . You should call or to enable logging. + + Logger name pattern used for . It may include one or more '*' or '?' wildcards at any position. + Target to be written to when the rule matches. + + + + Rule identifier to allow rule lookup + + + + + Gets a collection of targets that should be written to when this rule matches. + + + + + Obsolete since too exotic feature with NLog v5.3. + + Gets a collection of child rules to be evaluated when this rule matches. + + + + + Gets a collection of filters to be checked before writing to targets. + + + + + Gets or sets a value indicating whether to quit processing any following rules when this one matches. + + + + + Gets or sets the whether to quit processing any following rules when lower severity and this one matches. + + + Loggers matching will be restricted to specified minimum level for following rules. + + + + + Gets or sets logger name pattern. + + + Logger name pattern used by to check if a logger name matches this rule. + It may include one or more '*' or '?' wildcards at any position. + + '*' means zero or more occurrences of any character + '?' means exactly one occurrence of any character + + + + + + Gets the collection of log levels enabled by this rule. + + + + + Obsolete and replaced by with NLog v5. + + Default action when filters not matching + + + NLog v4.6 introduced the setting with default value . + NLog v5 marked it as obsolete and change default value to + + + + + Default action if none of the filters match + + + NLog v5 changed default value to + + + + + Enables logging for a particular level. + + Level to be enabled. + + + + Enables logging for a particular levels between (included) and . + + Minimum log level needed to trigger this rule. + Maximum log level needed to trigger this rule. + + + + Disables logging for a particular level. + + Level to be disabled. + + + + Disables logging for particular levels between (included) and . + + Minimum log level to be disables. + Maximum log level to be disabled. + + + + Enables logging the levels between (included) and . All the other levels will be disabled. + + Minimum log level needed to trigger this rule. + Maximum log level needed to trigger this rule. + + + + Returns a string representation of . Used for debugging. + + + + + Checks whether the particular log level is enabled for this rule. + + Level to be checked. + A value of when the log level is enabled, otherwise. + + + + Checks whether given name matches the . + + String to be matched. + A value of when the name matches, otherwise. + + + + Default filtering with static level config + + + + + Factory for locating methods. + + + + + Initializes a new instance of the class. + + + + + Scans the assembly for classes marked with expected class + and methods marked with expected and adds them + to the factory. + + The types to scan. + The assembly name for the type. + The item name prefix. + + + + Registers the type. + + The type to register. + The item name prefix. + + + + Registers the type. + + The type to register. + The item name prefix. + + + + Scans a type for relevant methods with their symbolic names + + Include types that are marked with this attribute + Include methods that are marked with this attribute + Class Type to scan + Collection of methods with their symbolic names + + + + Clears contents of the factory. + + + + + Registers the definition of a single method. + + The method name. + The method info. + + + + Tries to retrieve method by name. + + The method name. + The result. + A value of true if the method was found, false otherwise. + + + + Retrieves method by name. + + Method name. + MethodInfo object. + + + + Tries to get method definition. + + The method name. + The result. + A value of true if the method was found, false otherwise. + + + + Obsolete and replaced by with NLog v5.3. + + Marks the layout or layout renderer depends on mutable objects from the LogEvent + + This can be or + + + + + Attaches a type-alias for an item (such as , + , , etc.). + + + + + Initializes a new instance of the class. + + The type-alias for use in NLog configuration. + + + + Gets the name of the type-alias + + + + + Indicates NLog should not scan this property during configuration. + + + + + Initializes a new instance of the class. + + + + + Marks the object as configuration item for NLog. + + + + + Initializes a new instance of the class. + + + + + Failed to resolve the interface of service type + + + + + Typed we tried to resolve + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + Default implementation of + + + + + Singleton instance of the serializer. + + + + + + + + Attribute used to mark the required parameters for targets, + layout targets and filters. + + + + + Interface to register available configuration objects type + + + + + Registers instance of singleton object for use in NLog + + Type of service/interface to register + Instance of service + + + + Gets the service object of the specified type. + + Avoid calling this while handling a LogEvent, since random deadlocks can occur. + + + + Registers singleton-object as implementation of specific interface. + + + If the same single-object implements multiple interfaces then it must be registered for each interface + + Type of interface + The repo + Singleton object to use for override + + + + Registers the string serializer to use with + + + + + Repository of interfaces used by NLog to allow override for dependency injection + + + + + Initializes a new instance of the class. + + + + + Registered service type in the service repository + + + + + Initializes a new instance of the class. + + Type of service that have been registered + + + + Type of service-interface that has been registered + + + + + Obsolete and replaced by with NLog v5.2. + + Provides simple programmatic configuration API used for trivial logging cases. + + Warning, these methods will overwrite the current config. + + + + + Obsolete and replaced by and with NLog v5.2. + + Configures NLog for console logging so that all messages above and including + the level are output to the console. + + + + + Obsolete and replaced by and with NLog v5.2. + + Configures NLog for console logging so that all messages above and including + the specified level are output to the console. + + The minimal logging level. + + + + Obsolete and replaced by with NLog v5.2. + + Configures NLog for to log to the specified target so that all messages + above and including the level are output. + + The target to log all messages to. + + + + Obsolete and replaced by with NLog v5.2. + + Configures NLog for to log to the specified target so that all messages + above and including the specified level are output. + + The target to log all messages to. + The minimal logging level. + + + + Obsolete and replaced by and with NLog v5.2. + + Configures NLog for file logging so that all messages above and including + the level are written to the specified file. + + Log file name. + + + + Obsolete and replaced by and with NLog v5.2. + + Configures NLog for file logging so that all messages above and including + the specified level are written to the specified file. + + Log file name. + The minimal logging level. + + + + Value indicating how stack trace should be captured when processing the log event. + + + + + No Stack trace needs to be captured. + + + + + Stack trace should be captured. This option won't add the filenames and linenumbers + + + + + Capture also filenames and linenumbers + + + + + Capture the location of the call + + + + + Capture the class name for location of the call + + + + + Stack trace should be captured. This option won't add the filenames and linenumbers. + + + + + Stack trace should be captured including filenames and linenumbers. + + + + + Capture maximum amount of the stack trace information supported on the platform. + + + + + Marks the layout or layout renderer as thread independent - it producing correct results + regardless of the thread it's running on. + + Without this attribute everything is rendered on the main thread. + + + If this attribute is set on a layout, it could be rendered on the another thread. + This could be more efficient as it's skipped when not needed. + + If context like HttpContext.Current is needed, which is only available on the main thread, this attribute should not be applied. + + See the AsyncTargetWrapper and BufferTargetWrapper with the , using + + Apply this attribute when: + - The result can we rendered in another thread. Delaying this could be more efficient. And/Or, + - The result should not be precalculated, for example the target sends some extra context information. + + + + + Marks the layout or layout renderer as thread independent - it producing correct results + regardless of the thread it's running on. + + Layout or layout-renderer depends on or , + and requires that LogEvent-state is recognized as immutable. + + + Must be used in combination with , else it will have no effect + + + + + Marks the layout or layout renderer as thread safe - it producing correct results + regardless of the number of threads it's running on. + + Without this attribute then the target concurrency will be reduced + + + + + A class for configuring NLog through an XML configuration file + (App.config style or App.nlog style). + + Parsing of the XML file is also implemented in this class. + + + - This class is thread-safe..ToList() is used for that purpose. + - Update TemplateXSD.xml for changes outside targets + + + + + Initializes a new instance of the class. + + Configuration file to be read. + + + + Initializes a new instance of the class. + + Configuration file to be read. + The to which to apply any applicable configuration values. + + + + Obsolete and replaced by with NLog v4.7. + + Initializes a new instance of the class. + + Configuration file to be read. + Ignore any errors during configuration. + + + + Obsolete and replaced by with NLog v4.7. + + Initializes a new instance of the class. + + Configuration file to be read. + Ignore any errors during configuration. + The to which to apply any applicable configuration values. + + + + Initializes a new instance of the class. + + XML reader to read from. + + + + Initializes a new instance of the class. + + containing the configuration section. + Name of the file that contains the element (to be used as a base for including other files). null is allowed. + + + + Initializes a new instance of the class. + + containing the configuration section. + Name of the file that contains the element (to be used as a base for including other files). null is allowed. + The to which to apply any applicable configuration values. + + + + Obsolete and replaced by with NLog v4.7. + + Initializes a new instance of the class. + + containing the configuration section. + Name of the file that contains the element (to be used as a base for including other files). null is allowed. + Ignore any errors during configuration. + + + + Obsolete and replaced by with NLog v4.7. + + Initializes a new instance of the class. + + containing the configuration section. + Name of the file that contains the element (to be used as a base for including other files). null is allowed. + Ignore any errors during configuration. + The to which to apply any applicable configuration values. + + + + Initializes a new instance of the class. + + NLog configuration as XML string. + Name of the XML file. + The to which to apply any applicable configuration values. + + + + Parse XML string as NLog configuration + + NLog configuration in XML to be parsed + + + + Parse XML string as NLog configuration + + NLog configuration in XML to be parsed + NLog LogFactory + + + + Gets the default object by parsing + the application configuration file (app.exe.config). + + + + + Did the Succeeded? true= success, false= error, null = initialize not started yet. + + + + + Gets or sets a value indicating whether all of the configuration files + should be watched for changes and reloaded automatically when changed. + + + + + Gets the collection of file names which should be watched for changes by NLog. + This is the list of configuration files processed. + If the autoReload attribute is not set it returns empty collection. + + + + + Re-reads the original configuration file and returns the new object. + + The newly loaded instance. + Must assign the returned object to LogManager.Configuration to activate it + + + + Obsolete and replaced by and with NLog v5.2. + + Get file paths (including filename) for the possible NLog config files. + + The file paths to the possible config file + + + + Obsolete and replaced by and with NLog v5.2. + + Overwrite the paths (including filename) for the possible NLog config files. + + The file paths to the possible config file + + + + Obsolete and replaced by and with NLog v5.2. + + Clear the candidate file paths and return to the defaults. + + + + + Create XML reader for (xml config) file. + + filepath + reader or null if filename is empty. + + + + Initializes the configuration. + + containing the configuration section. + Name of the file that contains the element (to be used as a base for including other files). null is allowed. + Ignore any errors during configuration. + + + + Add a file with configuration. Check if not already included. + + + + + + + Parse the root + + + path to config file. + The default value for the autoReload option. + + + + Parse {configuration} xml element. + + + path to config file. + The default value for the autoReload option. + + + + Parse {NLog} xml element. + + + path to config file. + The default value for the autoReload option. + + + + Parses a single config section within the NLog-config + + + Section was recognized + + + + Include (multiple) files by filemask, e.g. *.nlog + + base directory in case if is relative + relative or absolute fileMask + + + + + + + + Represents simple XML element with case-insensitive attribute semantics. + + + + + Initializes a new instance of the class. + + The reader to initialize element from. + + + + Gets the element name. + + + + + Gets the dictionary of attribute values. + + + + + Gets the collection of child elements. + + + + + Gets the value of the element. + + + + + Returns children elements with the specified element name. + + Name of the element. + Children elements with the specified element name. + + + + Asserts that the name of the element is among specified element names. + + The allowed names. + + + + Special attribute we could ignore + + + + + Global Diagnostics Context - a dictionary structure to hold per-application-instance values. + + + + + Sets the value with the specified key in the Global Diagnostics Context (GDC) dictionary + + Item name. + Item value. + + + + Sets the value with the specified key in the Global Diagnostics Context (GDC) dictionary + + Item name. + Item value. + + + + Gets the value with the specified key in the Global Diagnostics Context (GDC) dictionary + + Item name. + The value of , if defined; otherwise . + If the value isn't a already, this call locks the for reading the needed for converting to . + + + + Gets the value with the specified key in the Global Diagnostics Context (GDC) dictionary + + Item name. + to use when converting the item's value to a string. + The value of as a string, if defined; otherwise . + If is null and the value isn't a already, this call locks the for reading the needed for converting to . + + + + Gets the value with the specified key in the Global Diagnostics Context (GDC) dictionary + + Item name. + The item value, if defined; otherwise null. + + + + Gets all key-names from Global Diagnostics Context (GDC) dictionary + + A collection of the names of all items in the Global Diagnostics Context. + + + + Determines whether the Global Diagnostics Context (GDC) dictionary contains the specified key. + + Item name. + A boolean indicating whether the specified item exists in current thread GDC. + + + + Removes the value with the specified key from the Global Diagnostics Context (GDC) dictionary + + Item name. + + + + Clears the content of the Global Diagnostics Context (GDC) dictionary. + + + + + Obsolete and replaced by with NLog v5. + + Mapped Diagnostics Context (MDC) is a dictionary of keys and values. + Stores the dictionary in the thread-local static variable, and provides methods to output dictionary values in layouts. + + + + + Sets the current thread MDC item to the specified value. + + Item name. + Item value. + An that can be used to remove the item from the current thread MDC. + + + + Sets the current thread MDC item to the specified value. + + Item name. + Item value. + >An that can be used to remove the item from the current thread MDC. + + + + Sets the current thread MDC item to the specified value. + + Item name. + Item value. + + + + Sets the current thread MDC item to the specified value. + + Item name. + Item value. + + + + Gets the current thread MDC named item, as . + + Item name. + The value of , if defined; otherwise . + If the value isn't a already, this call locks the for reading the needed for converting to . + + + + Gets the current thread MDC named item, as . + + Item name. + The to use when converting a value to a . + The value of , if defined; otherwise . + If is null and the value isn't a already, this call locks the for reading the needed for converting to . + + + + Gets the current thread MDC named item, as . + + Item name. + The value of , if defined; otherwise null. + + + + Returns all item names + + A set of the names of all items in current thread-MDC. + + + + Checks whether the specified item exists in current thread MDC. + + Item name. + A boolean indicating whether the specified exists in current thread MDC. + + + + Removes the specified from current thread MDC. + + Item name. + + + + Clears the content of current thread MDC. + + + + + Obsolete and replaced by with NLog v5. + + Mapped Diagnostics Logical Context (MDLC) is a dictionary of keys and values. + Stores the dictionary in the logical thread callcontext, and provides methods to output dictionary values in layouts. + Allows for maintaining state across asynchronous tasks and call contexts. + + + Ideally, these changes should be incorporated as a new version of the MappedDiagnosticsContext class in the original + NLog library so that state can be maintained for multiple threads in asynchronous situations. + + + + + Gets the current logical context named item, as . + + Item name. + The value of , if defined; otherwise . + If the value isn't a already, this call locks the for reading the needed for converting to . + + + + Gets the current logical context named item, as . + + Item name. + The to use when converting a value to a string. + The value of , if defined; otherwise . + If is null and the value isn't a already, this call locks the for reading the needed for converting to . + + + + Gets the current logical context named item, as . + + Item name. + The value of , if defined; otherwise null. + + + + Sets the current logical context item to the specified value. + + Item name. + Item value. + >An that can be used to remove the item from the current logical context. + + + + Sets the current logical context item to the specified value. + + Item name. + Item value. + >An that can be used to remove the item from the current logical context. + + + + Sets the current logical context item to the specified value. + + Item name. + Item value. + >An that can be used to remove the item from the current logical context. + + + + Updates the current logical context with multiple items in single operation + + . + >An that can be used to remove the item from the current logical context (null if no items). + + + + Sets the current logical context item to the specified value. + + Item name. + Item value. + + + + Sets the current logical context item to the specified value. + + Item name. + Item value. + + + + Sets the current logical context item to the specified value. + + Item name. + Item value. + + + + Returns all item names + + A collection of the names of all items in current logical context. + + + + Checks whether the specified exists in current logical context. + + Item name. + A boolean indicating whether the specified exists in current logical context. + + + + Removes the specified from current logical context. + + Item name. + + + + Clears the content of current logical context. + + + + + Clears the content of current logical context. + + Free the full slot. + + + + Obsolete and replaced by with NLog v5. + + Nested Diagnostics Context (NDC) is a stack of nested values. + Stores the stack in the thread-local static variable, and provides methods to output the values in layouts. + + + + + Gets the top NDC message but doesn't remove it. + + The top message. . + + + + Gets the top NDC object but doesn't remove it. + + The object at the top of the NDC stack if defined; otherwise null. + + + + Pushes the specified text on current thread NDC. + + The text to be pushed. + An instance of the object that implements IDisposable that returns the stack to the previous level when IDisposable.Dispose() is called. To be used with C# using() statement. + + + + Pushes the specified object on current thread NDC. + + The object to be pushed. + An instance of the object that implements IDisposable that returns the stack to the previous level when IDisposable.Dispose() is called. To be used with C# using() statement. + + + + Pops the top message off the NDC stack. + + The top message which is no longer on the stack. + + + + Pops the top message from the NDC stack. + + The to use when converting the value to a string. + The top message, which is removed from the stack, as a string value. + + + + Pops the top object off the NDC stack. + + The object from the top of the NDC stack, if defined; otherwise null. + + + + Peeks the first object on the NDC stack + + The object from the top of the NDC stack, if defined; otherwise null. + + + + Clears current thread NDC stack. + + + + + Gets all messages on the stack. + + Array of strings on the stack. + + + + Gets all messages from the stack, without removing them. + + The to use when converting a value to a string. + Array of strings. + + + + Gets all objects on the stack. + + Array of objects on the stack. + + + + Obsolete and replaced by with NLog v5. + + Nested Diagnostics Logical Context (NDLC) is a stack of nested values. + Stores the stack in the logical thread callcontexte, and provides methods to output the values in layouts. + + + + + Pushes the specified value on current stack + + The value to be pushed. + An instance of the object that implements IDisposable that returns the stack to the previous level when IDisposable.Dispose() is called. To be used with C# using() statement. + + + + Pushes the specified value on current stack + + The value to be pushed. + An instance of the object that implements IDisposable that returns the stack to the previous level when IDisposable.Dispose() is called. To be used with C# using() statement. + + + + Pops the top message off the NDLC stack. + + The top message which is no longer on the stack. + this methods returns a object instead of string, this because of backwards-compatibility + + + + Pops the top message from the NDLC stack. + + The to use when converting the value to a string. + The top message, which is removed from the stack, as a string value. + + + + Pops the top message off the current NDLC stack + + The object from the top of the NDLC stack, if defined; otherwise null. + + + + Peeks the top object on the current NDLC stack + + The object from the top of the NDLC stack, if defined; otherwise null. + + + + Clears current stack. + + + + + Gets all messages on the stack. + + Array of strings on the stack. + + + + Gets all messages from the stack, without removing them. + + The to use when converting a value to a string. + Array of strings. + + + + Gets all objects on the stack. The objects are not removed from the stack. + + Array of objects on the stack. + + + + stores state in the async thread execution context. All LogEvents created + within a scope can include the scope state in the target output. The logical context scope supports + both scope-properties and scope-nested-state-stack (Similar to log4j2 ThreadContext) + + + (MDLC), (MDC), (NDLC) + and (NDC) have been deprecated and replaced by . + + .NetCore (and .Net46) uses AsyncLocal for handling the thread execution context. Older .NetFramework uses System.Runtime.Remoting.CallContext + + + + + Pushes new state on the logical context scope stack together with provided properties + + Value to added to the scope stack + Properties being added to the scope dictionary + A disposable object that pops the nested scope state on dispose (including properties). + Scope dictionary keys are case-insensitive + + + + Updates the logical scope context with provided properties + + Properties being added to the scope dictionary + A disposable object that removes the properties from logical context scope on dispose. + Scope dictionary keys are case-insensitive + + + + Updates the logical scope context with provided properties + + Properties being added to the scope dictionary + A disposable object that removes the properties from logical context scope on dispose. + Scope dictionary keys are case-insensitive + + + + Updates the logical scope context with provided property + + Name of property + Value of property + A disposable object that removes the properties from logical context scope on dispose. + Scope dictionary keys are case-insensitive + + + + Updates the logical scope context with provided property + + Name of property + Value of property + A disposable object that removes the properties from logical context scope on dispose. + Scope dictionary keys are case-insensitive + + + + Pushes new state on the logical context scope stack + + Value to added to the scope stack + A disposable object that pops the nested scope state on dispose. + Skips casting of to check for scope-properties + + + + Pushes new state on the logical context scope stack + + Value to added to the scope stack + A disposable object that pops the nested scope state on dispose. + + + + Clears all the entire logical context scope, and removes any properties and nested-states + + + + + Retrieves all properties stored within the logical context scopes + + Collection of all properties + + + + Lookup single property stored within the logical context scopes + + Name of property + When this method returns, contains the value associated with the specified key + Returns true when value is found with the specified key + Scope dictionary keys are case-insensitive + + + + Retrieves all nested states inside the logical context scope stack + + Array of nested state objects. + + + + Peeks the top value from the logical context scope stack + + Value from the top of the stack. + + + + Peeks the inner state (newest) from the logical context scope stack, and returns its running duration + + Scope Duration Time + + + + Peeks the outer state (oldest) from the logical context scope stack, and returns its running duration + + Scope Duration Time + + + + Special bookmark that can restore original parent, after scopes has been collapsed + + + + + Matches when the specified condition is met. + + + Conditions are expressed using a simple language. + + Documentation on NLog Wiki + + + + Gets or sets the condition expression. + + + + + + + + + An abstract filter class. Provides a way to eliminate log messages + based on properties other than logger name and log level. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the action to be taken when filter matches. + + + + + + Gets the result of evaluating filter against given log event. + + The log event. + Filter result. + + + + Checks whether log event should be logged or not. + + Log event. + + - if the log event should be ignored
+ - if the filter doesn't want to decide
+ - if the log event should be logged
+ . + + + + Marks class as a layout renderer and assigns a name to it. + + + + + Initializes a new instance of the class. + + Name of the filter. + + + + Filter result. + + + + + The filter doesn't want to decide whether to log or discard the message. + + + + + The message should be logged. + + + + + The message should not be logged. + + + + + The message should be logged and processing should be finished. + + + + + The message should not be logged and processing should be finished. + + + + + A base class for filters that are based on comparing a value to a layout. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the layout to be used to filter log messages. + + The layout. + + + + + Matches when the calculated layout contains the specified substring. + This filter is deprecated in favor of <when /> which is based on conditions. + + + + + Gets or sets a value indicating whether to ignore case when comparing strings. + + + + + + Gets or sets the substring to be matched. + + + + + + + + + Matches when the calculated layout is equal to the specified substring. + This filter is deprecated in favor of <when /> which is based on conditions. + + + + + Gets or sets a value indicating whether to ignore case when comparing strings. + + + + + + Gets or sets a string to compare the layout to. + + + + + + + + + Matches the provided filter-method + + + + + Initializes a new instance of the class. + + + + + + + + Matches when the calculated layout does NOT contain the specified substring. + This filter is deprecated in favor of <when /> which is based on conditions. + + + + + Gets or sets the substring to be matched. + + + + + + Gets or sets a value indicating whether to ignore case when comparing strings. + + + + + + + + + Matches when the calculated layout is NOT equal to the specified substring. + This filter is deprecated in favor of <when /> which is based on conditions. + + + + + Initializes a new instance of the class. + + + + + Gets or sets a string to compare the layout to. + + + + + + Gets or sets a value indicating whether to ignore case when comparing strings. + + + + + + + + + Matches when the result of the calculated layout has been repeated a moment ago + + + + + How long before a filter expires, and logging is accepted again + + + + + + Max length of filter values, will truncate if above limit + + + + + + Applies the configured action to the initial logevent that starts the timeout period. + Used to configure that it should ignore all events until timeout. + + + + + + Max number of unique filter values to expect simultaneously + + + + + + Default number of unique filter values to expect, will automatically increase if needed + + + + + + Insert FilterCount value into when an event is no longer filtered + + + + + + Append FilterCount to the when an event is no longer filtered + + + + + + Reuse internal buffers, and doesn't have to constantly allocate new buffers + + + + + + Default buffer size for the internal buffers + + + + + + Checks whether log event should be logged or not. In case the LogEvent has just been repeated. + + Log event. + + - if the log event should be ignored
+ - if the filter doesn't want to decide
+ - if the log event should be logged
+ . + + + + Uses object pooling, and prunes stale filter items when the pool runs dry + + + + + Remove stale filter-value from the cache, and fill them into the pool for reuse + + + + + Renders the Log Event into a filter value, that is used for checking if just repeated + + + + + Repeated LogEvent detected. Checks if it should activate filter-action + + + + + Filter Value State (mutable) + + + + + Filter Lookup Key (immutable) + + + + + A global logging class using caller info to find the logger. + + + + + Obsolete and replaced by with NLog v5. + + Starts building a log event with the specified . + + The log level. + The full path of the source file that contains the caller. This is the file path at the time of compile. + An instance of the fluent . + + + + Obsolete and replaced by with NLog v5. + + Starts building a log event at the Trace level. + + The full path of the source file that contains the caller. This is the file path at the time of compile. + An instance of the fluent . + + + + Obsolete and replaced by with NLog v5. + + Starts building a log event at the Debug level. + + The full path of the source file that contains the caller. This is the file path at the time of compile. + An instance of the fluent . + + + + Obsolete and replaced by with NLog v5. + + Starts building a log event at the Info level. + + The full path of the source file that contains the caller. This is the file path at the time of compile. + An instance of the fluent . + + + + Obsolete and replaced by with NLog v5. + + Starts building a log event at the Warn level. + + The full path of the source file that contains the caller. This is the file path at the time of compile. + An instance of the fluent . + + + + Obsolete and replaced by with NLog v5. + + Starts building a log event at the Error level. + + The full path of the source file that contains the caller. This is the file path at the time of compile. + An instance of the fluent . + + + + Obsolete and replaced by with NLog v5. + + Starts building a log event at the Fatal level. + + The full path of the source file that contains the caller. This is the file path at the time of compile. + An instance of the fluent . + + + + Obsolete and replaced by with NLog v5. + + A fluent class to build log events for NLog. + + + + + Initializes a new instance of the class. + + The to send the log event. + + + + Initializes a new instance of the class. + + The to send the log event. + The for the log event. + + + + Gets the created by the builder. + + + + + Sets the information of the logging event. + + The exception information of the logging event. + current for chaining calls. + + + + Sets the level of the logging event. + + The level of the logging event. + current for chaining calls. + + + + Sets the logger name of the logging event. + + The logger name of the logging event. + current for chaining calls. + + + + Sets the log message on the logging event. + + The log message for the logging event. + current for chaining calls. + + + + Sets the log message and parameters for formatting on the logging event. + + A composite format string. + The object to format. + current for chaining calls. + + + + Sets the log message and parameters for formatting on the logging event. + + A composite format string. + The first object to format. + The second object to format. + current for chaining calls. + + + + Sets the log message and parameters for formatting on the logging event. + + A composite format string. + The first object to format. + The second object to format. + The third object to format. + current for chaining calls. + + + + Sets the log message and parameters for formatting on the logging event. + + A composite format string. + The first object to format. + The second object to format. + The third object to format. + The fourth object to format. + current for chaining calls. + + + + Sets the log message and parameters for formatting on the logging event. + + A composite format string. + An object array that contains zero or more objects to format. + current for chaining calls. + + + + Sets the log message and parameters for formatting on the logging event. + + An object that supplies culture-specific formatting information. + A composite format string. + An object array that contains zero or more objects to format. + current for chaining calls. + + + + Sets a per-event context property on the logging event. + + The name of the context property. + The value of the context property. + current for chaining calls. + + + + Sets multiple per-event context properties on the logging event. + + The properties to set. + current for chaining calls. + + + + Sets the timestamp of the logging event. + + The timestamp of the logging event. + current for chaining calls. + + + + Sets the stack trace for the event info. + + The stack trace. + Index of the first user stack frame within the stack trace. + current for chaining calls. + + + + Writes the log event to the underlying logger. + + The method or property name of the caller to the method. This is set at by the compiler. + The full path of the source file that contains the caller. This is set at by the compiler. + The line number in the source file at which the method is called. This is set at by the compiler. + + + + Writes the log event to the underlying logger if the condition delegate is true. + + If condition is true, write log event; otherwise ignore event. + The method or property name of the caller to the method. This is set at by the compiler. + The full path of the source file that contains the caller. This is set at by the compiler. + The line number in the source file at which the method is called. This is set at by the compiler. + + + + Writes the log event to the underlying logger if the condition is true. + + If condition is true, write log event; otherwise ignore event. + The method or property name of the caller to the method. This is set at by the compiler. + The full path of the source file that contains the caller. This is set at by the compiler. + The line number in the source file at which the method is called. This is set at by the compiler. + + + + Extension methods for NLog . + + + + + Obsolete and replaced by with NLog v5. + + Starts building a log event with the specified . + + The logger to write the log event to. + The log level. + current for chaining calls. + + + + Obsolete and replaced by with NLog v5. + + Starts building a log event at the Trace level. + + The logger to write the log event to. + current for chaining calls. + + + + Obsolete and replaced by with NLog v5. + + Starts building a log event at the Debug level. + + The logger to write the log event to. + current for chaining calls. + + + + Obsolete and replaced by with NLog v5. + + Starts building a log event at the Info level. + + The logger to write the log event to. + current for chaining calls. + + + + Obsolete and replaced by with NLog v5. + + Starts building a log event at the Warn level. + + The logger to write the log event to. + current for chaining calls. + + + + Obsolete and replaced by with NLog v5. + + Starts building a log event at the Error level. + + The logger to write the log event to. + current for chaining calls. + + + + Obsolete and replaced by with NLog v5. + + Starts building a log event at the Fatal level. + + The logger to write the log event to. + current for chaining calls. + + + + Extensions for NLog . + + + + + Starts building a log event with the specified . + + The logger to write the log event to. + The log level. When not + for chaining calls. + + + + Starts building a log event at the Trace level. + + The logger to write the log event to. + for chaining calls. + + + + Starts building a log event at the Debug level. + + The logger to write the log event to. + for chaining calls. + + + + Starts building a log event at the Info level. + + The logger to write the log event to. + for chaining calls. + + + + Starts building a log event at the Warn level. + + The logger to write the log event to. + for chaining calls. + + + + Starts building a log event at the Error level. + + The logger to write the log event to. + for chaining calls. + + + + Starts building a log event at the Fatal level. + + The logger to write the log event to. + for chaining calls. + + + + Starts building a log event at the Exception level. + + The logger to write the log event to. + The exception information of the logging event. + The for the log event. Defaults to when not specified. + for chaining calls. + + + + Writes the diagnostic message at the Debug level using the specified format provider and format parameters. + + + Writes the diagnostic message at the Debug level. + Only executed when the DEBUG conditional compilation symbol is set. + Type of the value. + A logger implementation that will handle the message. + The value to be written. + + + + Writes the diagnostic message at the Debug level. + Only executed when the DEBUG conditional compilation symbol is set. + Type of the value. + A logger implementation that will handle the message. + An IFormatProvider that supplies culture-specific formatting information. + The value to be written. + + + + Writes the diagnostic message at the Debug level. + Only executed when the DEBUG conditional compilation symbol is set. + A logger implementation that will handle the message. + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message and exception at the Debug level. + Only executed when the DEBUG conditional compilation symbol is set. + A logger implementation that will handle the message. + An exception to be logged. + A to be written. + Arguments to format. + + + + Writes the diagnostic message and exception at the Debug level. + Only executed when the DEBUG conditional compilation symbol is set. + A logger implementation that will handle the message. + An exception to be logged. + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + Arguments to format. + + + + Writes the diagnostic message at the Debug level. + Only executed when the DEBUG conditional compilation symbol is set. + A logger implementation that will handle the message. + Log message. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + Only executed when the DEBUG conditional compilation symbol is set. + A logger implementation that will handle the message. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + Only executed when the DEBUG conditional compilation symbol is set. + A logger implementation that will handle the message. + An IFormatProvider that supplies culture-specific formatting information. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Debug level using the specified parameter. + Only executed when the DEBUG conditional compilation symbol is set. + The type of the argument. + A logger implementation that will handle the message. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + Only executed when the DEBUG conditional compilation symbol is set. + The type of the first argument. + The type of the second argument. + A logger implementation that will handle the message. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + Only executed when the DEBUG conditional compilation symbol is set. + The type of the first argument. + The type of the second argument. + The type of the third argument. + A logger implementation that will handle the message. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Debug level using the specified format provider and format parameters. + + + Writes the diagnostic message at the Debug level. + Only executed when the DEBUG conditional compilation symbol is set. + Type of the value. + A logger implementation that will handle the message. + The value to be written. + + + + Writes the diagnostic message at the Debug level. + Only executed when the DEBUG conditional compilation symbol is set. + Type of the value. + A logger implementation that will handle the message. + An IFormatProvider that supplies culture-specific formatting information. + The value to be written. + + + + Writes the diagnostic message at the Debug level. + Only executed when the DEBUG conditional compilation symbol is set. + A logger implementation that will handle the message. + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message and exception at the Debug level. + Only executed when the DEBUG conditional compilation symbol is set. + A logger implementation that will handle the message. + An exception to be logged. + A to be written. + Arguments to format. + + + + Writes the diagnostic message and exception at the Debug level. + Only executed when the DEBUG conditional compilation symbol is set. + A logger implementation that will handle the message. + An exception to be logged. + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + Arguments to format. + + + + Writes the diagnostic message at the Debug level. + Only executed when the DEBUG conditional compilation symbol is set. + A logger implementation that will handle the message. + Log message. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + Only executed when the DEBUG conditional compilation symbol is set. + A logger implementation that will handle the message. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + Only executed when the DEBUG conditional compilation symbol is set. + A logger implementation that will handle the message. + An IFormatProvider that supplies culture-specific formatting information. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Debug level using the specified parameter. + Only executed when the DEBUG conditional compilation symbol is set. + The type of the argument. + A logger implementation that will handle the message. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + Only executed when the DEBUG conditional compilation symbol is set. + The type of the first argument. + The type of the second argument. + A logger implementation that will handle the message. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + Only executed when the DEBUG conditional compilation symbol is set. + The type of the first argument. + The type of the second argument. + The type of the third argument. + A logger implementation that will handle the message. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message and exception at the specified level. + + A logger implementation that will handle the message. + The log level. + An exception to be logged. + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message and exception at the Trace level. + + A logger implementation that will handle the message. + An exception to be logged. + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message and exception at the Debug level. + + A logger implementation that will handle the message. + An exception to be logged. + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message and exception at the Info level. + + A logger implementation that will handle the message. + An exception to be logged. + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message and exception at the Warn level. + + A logger implementation that will handle the message. + An exception to be logged. + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message and exception at the Error level. + + A logger implementation that will handle the message. + An exception to be logged. + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message and exception at the Fatal level. + + A logger implementation that will handle the message. + An exception to be logged. + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Interface for fakeable of the current AppDomain. + + + + + Gets or sets the base directory that the assembly resolver uses to probe for assemblies. + + + + + Gets or sets the name of the configuration file for an application domain. + + + + + Gets or sets the list of directories under the application base directory that are probed for private assemblies. + + + + + Gets or set the friendly name. + + + + + Gets an integer that uniquely identifies the application domain within the process. + + + + + Gets the assemblies that have been loaded into the execution context of this application domain. + + A list of assemblies in this application domain. + + + + Process exit event. + + + + + Domain unloaded event. + + + + + Abstract calls for the application environment + + + + + Gets current process name (excluding filename extension, if any). + + + + + Process exit event. + + + + + Abstract calls to FileSystem + + + + Determines whether the specified file exists. + The file to check. + + + Returns the content of the specified file + The file to load. + + + + Adapter for to + + + + + Initializes a new instance of the class. + + The to wrap. + + + + Creates an AppDomainWrapper for the current + + + + + Gets or sets the base directory that the assembly resolver uses to probe for assemblies. + + + + + Gets or sets the name of the configuration file for an application domain. + + + + + Gets or sets the list of directories under the application base directory that are probed for private assemblies. + + + + + Gets or set the friendly name. + + + + + Gets an integer that uniquely identifies the application domain within the process. + + + + + Gets the assemblies that have been loaded into the execution context of this application domain. + + A list of assemblies in this application domain. + + + + Process exit event. + + + + + Domain unloaded event. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Interface for the wrapper around System.Configuration.ConfigurationManager. + + + + + Gets the wrapper around ConfigurationManager.AppSettings. + + + + + Format a log message + + + + + Perform message template parsing and formatting of LogEvent messages (True = Always, False = Never, Null = Auto Detect) + + + + + Format the message and return + + LogEvent with message to be formatted + formatted message + + + + Has the logevent properties? + + LogEvent with message to be formatted + False when logevent has no properties to be extracted + + + + Appends the logevent message to the provided StringBuilder + + LogEvent with message to be formatted + The to append the formatted message. + + + + Get the Raw, unformatted value without stringify + + + Implementors must has the [ThreadAgnostic] attribute + + + + + Get the raw value + + + The value + RawValue supported? + + + + Interface implemented by layouts and layout renderers. + + + + + Renders the value of layout or layout renderer in the context of the specified log event. + + The log event. + String representation of a layout. + + + + Supports rendering as string value with limited or no allocations (preferred) + + + Implementors must not have the [AppDomainFixedOutput] attribute + + + + + Renders the value of layout renderer in the context of the specified log event + + + null if not possible or unknown + + + + Supports object initialization and termination. + + + + + Initializes this instance. + + The configuration. + + + + Closes this instance. + + + + + Helpers for . + + + + + Gets all usable exported types from the given assembly. + + Assembly to scan. + Usable types from the given assembly. + Types which cannot be loaded are skipped. + + + + Forward declare of system delegate type for use by other classes + + + + + Keeps track of pending operation count, and can notify when pending operation count reaches zero + + + + + Mark operation has started + + + + + Mark operation has completed + + Exception coming from the completed operation [optional] + + + + Registers an AsyncContinuation to be called when all pending operations have completed + + Invoked on completion + AsyncContinuation operation + + + + Clear o + + + + + Adds the given assembly which will be skipped + when NLog is trying to find the calling method on stack trace. + + The assembly to skip. + + + + Sets the stack trace for the event info. + + The stack trace. + Index of the first user stack frame within the stack trace. + Type of the logger or logger wrapper. This is still Logger if it's a subclass of Logger. + + + + Sets the details retrieved from the Caller Information Attributes + + + + + + + + + Obsolete and replaced by or ${callsite} with NLog v5.3. + + Gets the stack frame of the method that did the logging. + + + + + Gets the number index of the stack frame that represents the user + code (not the NLog code). + + + + + Legacy attempt to skip async MoveNext, but caused source file line number to be lost + + + + + Gets the entire stack trace. + + + + + Finds first user stack frame in a stack trace + + The stack trace of the logging method invocation + Type of the logger or logger wrapper. This is still Logger if it's a subclass of Logger. + Index of the first user stack frame or 0 if all stack frames are non-user + + + + This is only done for legacy reason, as the correct method-name and line-number should be extracted from the MoveNext-StackFrame + + The stack trace of the logging method invocation + Starting point for skipping async MoveNext-frames + + + + Skip StackFrame when from hidden Assembly / ClassType + + + + + Skip StackFrame when type of the logger + + + + + Memory optimized filtering + + Passing state too avoid delegate capture and memory-allocations. + + + + Ensures that IDictionary.GetEnumerator returns DictionaryEntry values + + + + + Most-Recently-Used-Cache, that discards less frequently used items on overflow + + + + + Constructor + + Maximum number of items the cache will hold before discarding. + + + + Attempt to insert item into cache. + + Key of the item to be inserted in the cache. + Value of the item to be inserted in the cache. + true when the key does not already exist in the cache, false otherwise. + + + + Lookup existing item in cache. + + Key of the item to be searched in the cache. + Output value of the item found in the cache. + True when the key is found in the cache, false otherwise. + + + + Dictionary that combines the standard with the + MessageTemplate-properties extracted from the . + + The are returned as the first items + in the collection, and in positional order. + + + + + Value of the property + + + + + Has property been captured from message-template ? + + + + + The properties of the logEvent + + + + + The properties extracted from the message-template + + + + + Wraps the list of message-template-parameters as IDictionary-interface + + Message-template-parameters + + + + Transforms the list of event-properties into IDictionary-interface + + Message-template-parameters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Check if the message-template-parameters can be used directly without allocating a dictionary + + Message-template-parameters + Are all parameter names unique (true / false) + + + + Attempt to insert the message-template-parameters into an empty dictionary + + Message-template-parameters + The dictionary that initially contains no message-template-parameters + + + + + + + + + + + + + + + + + + + + + Will always throw, as collection is readonly + + + Will always throw, as collection is readonly + + + Will always throw, as collection is readonly + + + + + + + + + + + + + + + + + + + Special property-key for lookup without being case-sensitive + + + + + Property-Key equality-comparer that uses string-hashcode from OrdinalIgnoreCase + Enables case-insensitive lookup using + + + + + HashSet optimized for single item + + + + + + Insert single item on scope start, and remove on scope exit + + Item to insert in scope + Existing hashset to update + Force allocation of real hashset-container + HashSet EqualityComparer + + + + Add item to collection, if it not already exists + + Item to insert + + + + Clear hashset + + + + + Check if hashset contains item + + + Item exists in hashset (true/false) + + + + Remove item from hashset + + + Item removed from hashset (true/false) + + + + Copy items in hashset to array + + Destination array + Array offset + + + + Create hashset enumerator + + Enumerator + + + + Provides helpers to sort log events and associated continuations. + + + + + Key selector delegate. + + The type of the value. + The type of the key. + Value to extract key information from. + Key selected from log event. + + + + Performs bucket sort (group by) on an array of items and returns a dictionary for easy traversal of the result set. + + The type of the value. + The type of the key. + The inputs. + The key selector function. + + Dictionary where keys are unique input keys, and values are lists of . + + + + + Performs bucket sort (group by) on an array of items and returns a dictionary for easy traversal of the result set. + + The type of the value. + The type of the key. + The inputs. + The key selector function. + + Dictionary where keys are unique input keys, and values are lists of . + + + + + Performs bucket sort (group by) on an array of items and returns a dictionary for easy traversal of the result set. + + The type of the value. + The type of the key. + The inputs. + The key selector function. + The key comparer function. + + Dictionary where keys are unique input keys, and values are lists of . + + + + + Single-Bucket optimized readonly dictionary. Uses normal internally Dictionary if multiple buckets are needed. + + Avoids allocating a new dictionary, when all items are using the same bucket + + The type of the key. + The type of the value. + + + + + + + + + + + + + + + + Allows direct lookup of existing keys. If trying to access non-existing key exception is thrown. + Consider to use instead for better safety. + + Key value for lookup + Mapped value found + + + + Non-Allocating struct-enumerator + + + + + + + + + + + + + Will always throw, as dictionary is readonly + + + Will always throw, as dictionary is readonly + + + + + + Will always throw, as dictionary is readonly + + + Will always throw, as dictionary is readonly + + + + + + + + + Will always throw, as dictionary is readonly + + + + Internal configuration manager used to read .NET configuration files. + Just a wrapper around the BCL ConfigurationManager, but used to enable + unit testing. + + + + + UTF-8 BOM 239, 187, 191 + + + + + Safe way to get environment variables. + + + + + Helper class for dealing with exceptions. + + + + + Mark this exception as logged to the . + + + + + + + Is this exception logged to the ? + + + trueif the has been logged to the . + + + + Determines whether the exception must be rethrown and logs the error to the if is false. + + Advised to log first the error to the before calling this method. + + The exception to check. + Target Object context of the exception. + Target Method context of the exception. + trueif the must be rethrown, false otherwise. + + + + Determines whether the exception must be rethrown immediately, without logging the error to the . + + Only used this method in special cases. + + The exception to check. + trueif the must be rethrown, false otherwise. + + + + FormatProvider that renders an exception-object as $"{ex.GetType()}: {ex.Message}" + + + + + Object construction helper. + + + + + Base class for optimized file appenders. + + + + + Initializes a new instance of the class. + + Name of the file. + The create parameters. + + + + Gets the path of the file, including file extension. + + The name of the file. + + + + Gets or sets the creation time for a file associated with the appender. The time returned is in Coordinated + Universal Time [UTC] standard. + + The creation time of the file. + + + + Gets or sets the creation time for a file associated with the appender. Synchronized by + The time format is based on + + + + + Gets the last time the file associated with the appender is opened. The time returned is in Coordinated + Universal Time [UTC] standard. + + The time the file was last opened. + + + + Gets the file creation parameters. + + The file creation parameters. + + + + Writes the specified bytes. + + The bytes. + + + + Writes the specified bytes to a file. + + The bytes array. + The bytes array offset. + The number of bytes. + + + + Flushes this file-appender instance. + + + + + Closes this file-appender instance. + + + + + Gets the creation time for a file associated with the appender. The time returned is in Coordinated Universal + Time [UTC] standard. + + The file creation time. + + + + Gets the length in bytes of the file associated with the appender. + + A long value representing the length of the file in bytes. + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Releases unmanaged and - optionally - managed resources. + + True to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Creates the file stream. + + If set to true sets the file stream to allow shared writing. + If larger than 0 then it will be used instead of the default BufferSize for the FileStream. + A object which can be used to write to the file. + + + + Base class for optimized file appenders which require the usage of a mutex. + + It is possible to use this class as replacement of BaseFileAppender and the mutex functionality + is not enforced to the implementing subclasses. + + + + + Initializes a new instance of the class. + + Name of the file. + The create parameters. + + + + Gets the mutually-exclusive lock for archiving files. + + The mutex for archiving. + + + + + + + Creates a mutex that is sharable by more than one process. + + The prefix to use for the name of the mutex. + A object which is sharable by multiple processes. + + + + Implementation of which caches + file information. + + + + + Initializes a new instance of the class. + + Name of the file. + The parameters. + + + + + + + + + + + + + + + + + + + Factory class which creates objects. + + + + + + + + Maintains a collection of file appenders usually associated with file targets. + + + + + An "empty" instance of the class with zero size and empty list of appenders. + + + + + Initializes a new "empty" instance of the class with zero size and empty + list of appenders. + + + + + Initializes a new instance of the class. + + + The size of the list should be positive. No validations are performed during initialization as it is an + internal class. + + Total number of appenders allowed in list. + Factory used to create each appender. + Parameters used for creating a file. + + + + The archive file path pattern that is used to detect when archiving occurs. + + + + + Invalidates appenders for all files that were archived. + + + + + Gets the parameters which will be used for creating a file. + + + + + Gets the file appender factory used by all the appenders in this list. + + + + + Gets the number of appenders which the list can hold. + + + + + Subscribe to background monitoring of active file appenders + + + + + It allocates the first slot in the list when the file name does not already in the list and clean up any + unused slots. + + File name associated with a single appender. + The allocated appender. + + + + Close all the allocated appenders. + + + + + Close the allocated appenders initialized before the supplied time. + + The time which prior the appenders considered expired + + + + Flush all the allocated appenders. + + + + + File Archive Logic uses the File-Creation-TimeStamp to detect if time to archive, and the File-LastWrite-Timestamp to name the archive-file. + + + NLog always closes all relevant appenders during archive operation, so no need to lookup file-appender + + + + + Closes the specified appender and removes it from the list. + + File name of the appender to be closed. + File Appender that matched the filePath (null if none found) + + + + Interface that provides parameters for create file function. + + + + + Gets or sets the delay in milliseconds to wait before attempting to write to the file again. + + + + + Gets or sets the number of times the write is appended on the file before NLog + discards the log message. + + + + + Gets or sets a value indicating whether concurrent writes to the log file by multiple processes on the same host. + + + This makes multi-process logging possible. NLog uses a special technique + that lets it keep the files open for writing. + + + + + Gets or sets a value indicating whether to create directories if they do not exist. + + + Setting this to false may improve performance a bit, but you'll receive an error + when attempting to write to a directory that's not present. + + + + + Gets or sets a value indicating whether to enable log file(s) to be deleted. + + + + + Gets or sets the log file buffer size in bytes. + + + + + Gets or set a value indicating whether a managed file stream is forced, instead of using the native implementation. + + + + + Gets or sets the file attributes (Windows only). + + + + + Should archive mutex be created? + + + + + Should manual simple detection of file deletion be enabled? + + + + + Gets the parameters which will be used for creating a file. + + + + + Gets the file appender factory used by all the appenders in this list. + + + + + Gets the number of appenders which the list can hold. + + + + + Subscribe to background monitoring of active file appenders + + + + + It allocates the first slot in the list when the file name does not already in the list and clean up any + unused slots. + + File name associated with a single appender. + The allocated appender. + + + + Close all the allocated appenders. + + + + + Close the allocated appenders initialized before the supplied time. + + The time which prior the appenders considered expired + + + + Flush all the allocated appenders. + + + + + File Archive Logic uses the File-Creation-TimeStamp to detect if time to archive, and the File-LastWrite-Timestamp to name the archive-file. + + + NLog always closes all relevant appenders during archive operation, so no need to lookup file-appender + + + + + Closes the specified appender and removes it from the list. + + File name of the appender to be closed. + File Appender that matched the filePath (null if none found) + + + + The archive file path pattern that is used to detect when archiving occurs. + + + + + Invalidates appenders for all files that were archived. + + + + + Interface implemented by all factories capable of creating file appenders. + + + + + Opens the appender for given file name and parameters. + + Name of the file. + Creation parameters. + Instance of which can be used to write to the file. + + + + Provides a multi process-safe atomic file appends while + keeping the files open. + + + On Unix you can get all the appends to be atomic, even when multiple + processes are trying to write to the same file, because setting the file + pointer to the end of the file and appending can be made one operation. + On Win32 we need to maintain some synchronization between processes + (global named mutex is used for this) + + + + + Initializes a new instance of the class. + + Name of the file. + The parameters. + + + + + + + + + + + + + + + + + + + Factory class. + + + + + + + + Appender used to discard data for the FileTarget. + Used mostly for testing entire stack except the actual writing to disk. + Throws away all data. + + + + + Factory class. + + + + + + + + Multi-process and multi-host file appender which attempts + to get exclusive write access and retries if it's not available. + + + + + Initializes a new instance of the class. + + Name of the file. + The parameters. + + + + + + + + + + + + + + + + + + + Factory class. + + + + + + + + Optimized single-process file appender which keeps the file open for exclusive write. + + + + + Initializes a new instance of the class. + + Name of the file. + The parameters. + + + + + + + + + + + + + + + + + + + Factory class. + + + + + + + + Provides a multi process-safe atomic file append while + keeping the files open. + + + + + Initializes a new instance of the class. + + Name of the file. + The parameters. + + + + Creates or opens a file in a special mode, so that writes are automatically + as atomic writes at the file end. + See also "UnixMultiProcessFileAppender" which does a similar job on *nix platforms. + + File to create or open + + + + + + + + + + + + + + + + + + + Factory class. + + + + + + + + A layout that represents a filePath. + + + + + Cached directory separator char array to avoid memory allocation on each method call. + + + + + Cached invalid file names char array to avoid memory allocation every time Path.GetInvalidFileNameChars() is called. + + + + + not null when == false + + + + + non null is fixed, + + + + + is the cache-key, and when newly rendered filename matches the cache-key, + then it reuses the cleaned cache-value . + + + + + is the cache-value that is reused, when the newly rendered filename + matches the cache-key + + + + Initializes a new instance of the class. + + + + Render the raw filename from Layout + + The log event. + StringBuilder to minimize allocations [optional]. + String representation of a layout. + + + + Convert the raw filename to a correct filename + + The filename generated by Layout. + String representation of a correct filename. + + + + Is this (templated/invalid) path an absolute, relative or unknown? + + + + + Watches multiple files at the same time and raises an event whenever + a single change is detected in any of those files. + + + + + The types of changes to watch for. + + + + + Occurs when a change is detected in one of the monitored files. + + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Stops watching all files. + + + + + Stops watching the specified file. + + + + + + Watches the specified files for changes. + + The file names. + + + + Combine paths + + basepath, not null + optional dir + optional file + + + + + Cached directory separator char array to avoid memory allocation on each method call. + + + + + Trims directory separators from the path + + path, could be null + never null + + + + Convert object to string + + value + format for conversion. + + + If is null and isn't a already, then the will get a locked by + + + + + Retrieve network interfaces + + + + + Retrieve network interfaces + + + + + Supports mocking of SMTP Client code. + + + + + Specifies how outgoing email messages will be handled. + + + + + Gets or sets the name or IP address of the host used for SMTP transactions. + + + + + Gets or sets the port used for SMTP transactions. + + + + + Gets or sets a value that specifies the amount of time after which a synchronous Send call times out. + + + + + Gets or sets the credentials used to authenticate the sender. + + + + + Sends an e-mail message to an SMTP server for delivery. These methods block while the message is being transmitted. + + + System.Net.Mail.MailMessage + MailMessage + A MailMessage that contains the message to send. + + + + Gets or sets the folder where applications save mail messages to be processed by the local SMTP server. + + + + + The MessageFormatter delegate + + + + + When true: Do not fallback to StringBuilder.Format for positional templates + + + + + New formatter + + + When true: Do not fallback to StringBuilder.Format for positional templates + + + + + The MessageFormatter delegate + + + + + + + + Render a template to a string. + + The template. + Culture. + Parameters for the holes. + The String Builder destination. + Parameters for the holes. + + + + Detects the platform the NLog is running on. + + + + + Gets a value indicating whether current runtime supports use of mutex + + + + + Will creating a mutex succeed runtime? + + + + + Supports mocking of SMTP Client code. + + + Disabled Error CS0618 'SmtpClient' is obsolete: 'SmtpClient and its network of types are poorly designed, + we strongly recommend you use https://github.com/jstedfast/MailKit and https://github.com/jstedfast/MimeKit instead' + + + + + Retrieve network interfaces + + + + + Retrieve network interfaces + + + + + Network sender which uses HTTP or HTTPS POST. + + + + + Initializes a new instance of the class. + + The network URL. + + + + Creates instances of objects for given URLs. + + + + + Creates a new instance of the network sender based on a network URL. + + URL that determines the network sender to be created. + The maximum queue size. + The overflow action when reaching maximum queue size. + The maximum message size. + SSL protocols for TCP + KeepAliveTime for TCP + + A newly created network sender. + + + + + Interface for mocking socket calls. + + + + + A base class for all network senders. Supports one-way sending of messages + over various protocols. + + + + + Initializes a new instance of the class. + + The network URL. + + + + Gets the address of the network endpoint. + + + + + Gets the last send time. + + + + + Initializes this network sender. + + + + + Closes the sender and releases any unmanaged resources. + + The continuation. + + + + Flushes any pending messages and invokes the on completion. + + The continuation. + + + + Send the given text over the specified protocol. + + Bytes to be sent. + Offset in buffer. + Number of bytes to send. + The asynchronous continuation. + + + + Closes the sender and releases any unmanaged resources. + + + + + Initializes resources for the protocol specific implementation. + + + + + Closes resources for the protocol specific implementation. + + The continuation. + + + + Performs the flush and invokes the on completion. + + The continuation. + + + + Sends the payload using the protocol specific implementation. + + The bytes to be sent. + Offset in buffer. + Number of bytes to send. + The async continuation to be invoked after the buffer has been sent. + + + + Parses the URI into an IP address. + + The URI to parse. + The address family. + Parsed endpoint. + + + + Default implementation of . + + + + + + + + A base class for network senders that can block or send out-of-order + + + + + Initializes a new instance of the class. + + URL. Must start with tcp://. + + + + Socket proxy for mocking Socket code. + + + + + Initializes a new instance of the class. + + The address family. + Type of the socket. + Type of the protocol. + + + + Gets underlying socket instance. + + + + + Closes the wrapped socket. + + + + + Invokes ConnectAsync method on the wrapped socket. + + The instance containing the event data. + Result of original method. + + + + Invokes SendAsync method on the wrapped socket. + + The instance containing the event data. + Result of original method. + + + + Invokes SendToAsync method on the wrapped socket. + + The instance containing the event data. + Result of original method. + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Sends messages over a TCP network connection. + + + + + Initializes a new instance of the class. + + URL. Must start with tcp://. + The address family. + + + + Creates the socket with given parameters. + + The host address. + The address family. + Type of the socket. + Type of the protocol. + Instance of which represents the socket. + + + + Facilitates mocking of class. + + + + + Raises the Completed event. + + + + + Sends messages over the network as UDP datagrams. + + + + + Initializes a new instance of the class. + + URL. Must start with udp://. + The address family. + + + + Creates the socket. + + The IP address. + Implementation of to use. + + + + Allocates new builder and appends to the provided target builder on dispose + + + + + Access the new builder allocated + + + + + Controls a single allocated AsyncLogEventInfo-List for reuse (only one active user) + + + + + Controls a single allocated char[]-buffer for reuse (only one active user) + + + + + Controls a single allocated StringBuilder for reuse (only one active user) + + + + + Controls a single allocated object for reuse (only one active user) + + + + + Creates handle to the reusable char[]-buffer for active usage + + Handle to the reusable item, that can release it again + + + + Access the acquired reusable object + + + + + Controls a single allocated MemoryStream for reuse (only one active user) + + + + + Constructor + + Max number of items + Initial StringBuilder Size + Max StringBuilder Size + + + + Takes StringBuilder from pool + + Allow return to pool + + + + Releases StringBuilder back to pool at its right place + + + + + Keeps track of acquired pool item + + + + + Releases pool item back into pool + + + + + Detects the platform the NLog is running on. + + + + + Gets the current runtime OS. + + + + + Gets a value indicating whether current OS is Win32-based (desktop or mobile). + + + + + Gets a value indicating whether current OS is Unix-based. + + + + + Gets a value indicating whether current runtime is Mono-based + + + + + Scans (breadth-first) the object graph following all the edges whose are + instances have attached and returns + all objects implementing a specified interfaces. + + + + + Finds the objects which have attached which are reachable + from any of the given root objects when traversing the object graph over public properties. + + Type of the objects to return. + Configuration Reflection Helper + Also search the properties of the wanted objects. + The root objects. + Ordered list of objects implementing T. + + + + Object Path to check + + + + + Converts object into a List of property-names and -values using reflection + + + + + Try get value from , using , and set into + + + + + Scans properties for name (Skips string-compare and value-lookup until finding match) + + + + + Scans properties for name (Skips property value lookup until finding match) + + + + + Scans properties for name + + + + + Binder for retrieving value of + + + + + + + + Reflection helpers for accessing properties. + + + + + Get property info + + Configuration Reflection Helper + object which could have property + property name on + result when success. + success. + + + + Try parse of string to (Generic) list, comma separated. + + + If there is a comma in the value, then (single) quote the value. For single quotes, use the backslash as escape + + + + + Attempt to reuse the HashSet.Comparer from the original HashSet-object (Ex. StringComparer.OrdinalIgnoreCase) + + + + + Reflection helpers. + + + + + Is this a static class? + + + + This is a work around, as Type doesn't have this property. + From: https://stackoverflow.com/questions/1175888/determine-if-a-type-is-static + + + + + Optimized delegate for calling MethodInfo + + Object instance, use null for static methods. + Complete list of parameters that matches the method, including optional/default parameters. + + + + Optimized delegate for calling a constructor + + Complete list of parameters that matches the constructor, including optional/default parameters. Could be null for no parameters. + + + + Creates an optimized delegate for calling the MethodInfo using Expression-Trees + + Method to optimize + Optimized delegate for invoking the MethodInfo + + + + Creates an optimized delegate for calling the constructors using Expression-Trees + + Constructor to optimize + Optimized delegate for invoking the constructor + + + + Compile the ? This can improve the performance, but at the costs of more memory usage. If false, the Regex Cache is used. + + + + + Gets or sets a value indicating whether to match whole words only. + + + + + Gets or sets a value indicating whether to ignore case when comparing texts. + + + + + Supported operating systems. + + + If you add anything here, make sure to add the appropriate detection + code to + + + + + Unknown operating system. + + + + + Unix/Linux operating systems. + + + + + Desktop versions of Windows (95,98,ME). + + + + + Windows NT, 2000, 2003 and future versions based on NT technology. + + + + + Macintosh Mac OSX + + + + + Immutable state that combines ScopeContext MDLC + NDLC for + + + + + Immutable state that combines ScopeContext MDLC + NDLC for + + + + + Immutable state for ScopeContext Mapped Context (MDLC) + + + + + Immutable state for ScopeContext Nested State (NDLC) + + + + + Immutable state for ScopeContext Single Property (MDLC) + + + + + Immutable state for ScopeContext Multiple Properties (MDLC) + + + + + Immutable state for ScopeContext handling legacy MDLC + NDLC operations + + + + + + + + + + + + + + Collection of targets that should be written to + + + + + Implements a single-call guard around given continuation function. + + + + + Initializes a new instance of the class. + + The asynchronous continuation. + + + + Continuation function which implements the single-call guard. + + The exception. + + + + Utilities for dealing with values. + + + + + Gets the fully qualified name of the class invoking the calling method, including the + namespace but not the assembly. + + + + + Gets the fully qualified name of the class invoking the calling method, including the + namespace but not the assembly. + + StackFrame from the calling method + Fully qualified class name + + + + Returns the assembly from the provided StackFrame (If not internal assembly) + + Valid assembly, or null if assembly was internal + + + + Returns the classname from the provided StackFrame (If not from internal assembly) + + + Valid class name, or empty string if assembly was internal + + + + Stream helpers + + + + + Copy to output stream and skip BOM if encoding is UTF8 + + + + + + + + Copy stream input to output. Skip the first bytes + + stream to read from + stream to write to + .net35 doesn't have a .copyto + + + + Copy stream input to output. Skip the first bytes + + stream to read from + stream to write to + first bytes to skip (optional) + + + + Simple character tokenizer. + + + + + Initializes a new instance of the class. + + The text to be tokenized. + + + + Current position in + + + + + Full text to be parsed + + + + + Check current char while not changing the position. + + + + + + Read the current char and change position + + + + + + Get the substring of the + + + + + + + + Helpers for , which is used in e.g. layout renderers. + + + + + Renders the specified log event context item and appends it to the specified . + + append to this + value to be appended + format string. If @, then serialize the value with the Default JsonConverter. + provider, for example culture + NLog string.Format interface + + + + Appends int without using culture, and most importantly without garbage + + + value to append + + + + Appends uint without using culture, and most importantly without garbage + + Credits Gavin Pugh - https://www.gavpugh.com/2010/04/01/xnac-avoiding-garbage-when-working-with-stringbuilder/ + + + value to append + + + + Convert DateTime into UTC and format to yyyy-MM-ddTHH:mm:ss.fffffffZ - ISO 8601 Compliant Date Format (Round-Trip-Time) + + + + + Clears the provider StringBuilder + + + + + + Copies the contents of the StringBuilder to the MemoryStream using the specified encoding (Without BOM/Preamble) + + StringBuilder source + MemoryStream destination + Encoding used for converter string into byte-stream + Helper char-buffer to minimize memory allocations + + + + Copies the contents of the StringBuilder to the destination StringBuilder + + StringBuilder source + StringBuilder destination + + + + Scans the StringBuilder for the position of needle character + + StringBuilder source + needle character to search for + + Index of the first occurrence (Else -1) + + + + Scans the StringBuilder for the position of needle character + + StringBuilder source + needle characters to search for + + Index of the first occurrence (Else -1) + + + + Compares the contents of two StringBuilders + + + Correct implementation of that also works when is not the same + + True when content is the same + + + + Compares the contents of a StringBuilder and a String + + True when content is the same + + + + Append a number and pad with 0 to 2 digits + + append to this + the number + + + + Append a number and pad with 0 to 4 digits + + append to this + the number + + + + Append a numeric type (byte, int, double, decimal) as string + + + + + Helpers for . + + + + + IsNullOrWhiteSpace, including for .NET 3.5 + + + + + + + Replace string with + + + + + + The same reference of nothing has been replaced. + + + Concatenates all the elements of a string array, using the specified separator between each element. + The string to use as a separator. is included in the returned string only if has more than one element. + An collection that contains the elements to concatenate. + A string that consists of the elements in delimited by the string. If is an empty array, the method returns . + + is . + + + + Split a string + + + + + Split a string, optional quoted value + + Text to split + Character to split the + Quote character + + Escape for the , not escape for the + , use quotes for that. + + + + + Split a string, optional quoted value + + Text to split + Character to split the + Quote character + + Escape for the , not escape for the + , use quotes for that. + + + + + Represents target with a chain of filters which determine + whether logging should happen. + + + + + Initializes a new instance of the class. + + The target. + The filter chain. + Default action if none of the filters match. + + + + Gets the target. + + The target. + + + + Gets the filter chain. + + The filter chain. + + + + Gets or sets the next item in the chain. + + The next item in the chain. + This is for example the 'target2' logger in writeTo='target1,target2' + + + + Gets the stack trace usage. + + A value that determines stack trace handling. + + + + Default action if none of the filters match. + + + + + Serves as a hash function for a particular type. + + + + + Determines if two objects are equal in value. + + Other object to compare to. + True if objects are equal, false otherwise. + + + + Determines if two objects of the same type are equal in value. + + Other object to compare to. + True if objects are equal, false otherwise. + + + + Wraps with a timeout. + + + + + Initializes a new instance of the class. + + The asynchronous continuation. + The timeout. + + + + Continuation function which implements the timeout logic. + + The exception. + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + URL Encoding helper. + + + + Allow UnreservedMarks instead of ReservedMarks, as specified by chosen RFC + + + Use RFC2396 standard (instead of RFC3986) + + + Should use lowercase when doing HEX escaping of special characters + + + Replace space ' ' with '+' instead of '%20' + + + Skip UTF8 encoding, and prefix special characters with '%u' + + + + Escape unicode string data for use in http-requests + + unicode string-data to be encoded + target for the encoded result + s for how to perform the encoding + + + + Convert the wide-char into utf8-bytes, and then escape + + + + + Is allowed? + + + + + + + + Is a-z / A-Z / 0-9 + + + + + + + Prevents the Xamarin linker from linking the target. + + + By applying this attribute all of the members of the target will be kept as if they had been referenced by the code. + + + + + Ensures that all members of this type are preserved + + + + + Flags the method as a method to preserve during linking if the container class is pulled in. + + + + + Helper class for XML + + + + + removes any unusual unicode characters that can't be encoded into XML + + + + + Cleans string of any invalid XML chars found + + unclean string + string with only valid XML chars + + + + Pretest, small text and not escape needed + + + + + + + + Converts object value to invariant format, and strips any invalid xml-characters + + Object value + Object value converted to string + + + + Converts object value to invariant format (understood by JavaScript) + + Object value + Object value converted to string + + + + XML elements must follow these naming rules: + - Element names are case-sensitive + - Element names must start with a letter or underscore + - Element names can contain letters, digits, hyphens, underscores, and periods + - Element names cannot contain spaces + + + + + + Converts object value to invariant format (understood by JavaScript) + + Object value + Object TypeCode + Check and remove unusual unicode characters from the result string. + Object value converted to string + + + + Safe version of WriteAttributeString + + + + + + + + Safe version of WriteElementSafeString + + + + + + + + + + Safe version of WriteCData + + + + + + + Interface for handling object transformation + + + + + Takes a dangerous (or massive) object and converts into a safe (or reduced) object + + + Null if unknown object, or object cannot be handled + + + + + Used to render the application domain name. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Create a new renderer + + + + + Create a new renderer + + + + + Format string. Possible values: "Short", "Long" or custom like {0} {1}. Default "Long" + The first parameter is the AppDomain.Id, the second the second the AppDomain.FriendlyName + This string is used in + + + + + + + + + + + + + + + Render value for Application setting retrieved from App.config or Web.config file. + + + + ${appsetting:item=mysetting:default=mydefault} - produces "mydefault" if no appsetting + + See NLog Wiki + + Documentation on NLog Wiki + + + + The AppSetting item-name + + + + + + Obsolete and replaced by with NLog v4.6. + + The AppSetting item-name + + + + + The default value to render if the AppSetting value is null. + + + + + + + + + + + + Renders the assembly version information for the entry assembly or a named assembly. + + + As this layout renderer uses reflection and version information is unlikely to change during application execution, + it is recommended to use it in conjunction with the . + + + See NLog Wiki + + Documentation on NLog Wiki + + + + The (full) name of the assembly. If null, using the entry assembly. + + + + + + Gets or sets the type of assembly version to retrieve. + + + Some version type and platform combinations are not fully supported. + - UWP earlier than .NET Standard 1.5: Value for is always returned unless the parameter is specified. + + + + + + The default value to render if the Version is not available + + + + + + Gets or sets the custom format of the assembly version output. + + + Supported placeholders are 'major', 'minor', 'build' and 'revision'. + The default .NET template for version numbers is 'major.minor.build.revision'. See + https://docs.microsoft.com/en-gb/dotnet/api/system.version?view=netframework-4.7.2#remarks + for details. + + + + + + + + + + + + + + + Gets the assembly specified by , or entry assembly otherwise + + + + + Type of assembly version to retrieve. + + + + + Gets the assembly version. + + + + + Gets the file version. + + + + + Gets the product version, extracted from the additional version information. + + + + + Thread identity information (username). + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets a value indicating whether username should be included. + + + + + + Gets or sets a value indicating whether domain name should be included. + + + + + + Gets or sets the default value to be used when the User is not set. + + + + + + Gets or sets the default value to be used when the Domain is not set. + + + + + + + + + The information about the garbage collector. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the property to retrieve. + + + + + + + + + Gets or sets the property of System.GC to retrieve. + + + + + Total memory allocated. + + + + + Total memory allocated (perform full garbage collection first). + + + + + Gets the number of Gen0 collections. + + + + + Gets the number of Gen1 collections. + + + + + Gets the number of Gen2 collections. + + + + + Maximum generation number supported by GC. + + + + + The identifier of the current process. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + + + + The information about the running process. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the property to retrieve. + + + + + + Gets or sets the format-string to use if the property supports it (Ex. DateTime / TimeSpan / Enum) + + + + + + Gets or sets the culture used for rendering. + + + + + + + + + + + + + + + Property of System.Diagnostics.Process to retrieve. + + + + + Base Priority. + + + + + Exit Code. + + + + + Exit Time. + + + + + Process Handle. + + + + + Handle Count. + + + + + Whether process has exited. + + + + + Process ID. + + + + + Machine name. + + + + + Handle of the main window. + + + + + Title of the main window. + + + + + Maximum Working Set. + + + + + Minimum Working Set. + + + + + Non-paged System Memory Size. + + + + + Non-paged System Memory Size (64-bit). + + + + + Paged Memory Size. + + + + + Paged Memory Size (64-bit).. + + + + + Paged System Memory Size. + + + + + Paged System Memory Size (64-bit). + + + + + Peak Paged Memory Size. + + + + + Peak Paged Memory Size (64-bit). + + + + + Peak Virtual Memory Size. + + + + + Peak Virtual Memory Size (64-bit).. + + + + + Peak Working Set Size. + + + + + Peak Working Set Size (64-bit). + + + + + Whether priority boost is enabled. + + + + + Priority Class. + + + + + Private Memory Size. + + + + + Private Memory Size (64-bit). + + + + + Privileged Processor Time. + + + + + Process Name. + + + + + Whether process is responding. + + + + + Session ID. + + + + + Process Start Time. + + + + + Total Processor Time. + + + + + User Processor Time. + + + + + Virtual Memory Size. + + + + + Virtual Memory Size (64-bit). + + + + + Working Set Size. + + + + + Working Set Size (64-bit). + + + + + The name of the current process. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets a value indicating whether to write the full path to the process executable. + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + + + + Designates a property of the class as an ambient property. + + + non-ambient: ${uppercase:${level}} + ambient : ${level:uppercase} + + + + + Initializes a new instance of the class. + + Ambient property name. + + + + Marks class as layout-renderer and attaches a type-alias name for use in NLog configuration. + + + + + Initializes a new instance of the class. + + The layout-renderer type-alias for use in NLog configuration - without '${ }' + + + + The call site source file name. Full callsite + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets a value indicating whether to include source file path. + + + + + + Gets or sets the number of frames to skip. + + + + + + Logger should capture StackTrace, if it was not provided manually + + + + + + + + + + + + The call site (class name, method name and source information). + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets a value indicating whether to render the class name. + + + + + + Gets or sets a value indicating whether to render the include the namespace with . + + + + + + Gets or sets a value indicating whether to render the method name. + + + + + + Gets or sets a value indicating whether the method name will be cleaned up if it is detected as an anonymous delegate. + + + + + + Gets or sets a value indicating whether the method and class names will be cleaned up if it is detected as an async continuation + (everything after an await-statement inside of an async method). + + + + + + Gets or sets the number of frames to skip. + + + + + + Gets or sets a value indicating whether to render the source file name and line number. + + + + + + Gets or sets a value indicating whether to include source file path. + + + + + + Logger should capture StackTrace, if it was not provided manually + + + + + + + + + + + + The call site source line number. Full callsite + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the number of frames to skip. + + + + + + Logger should capture StackTrace, if it was not provided manually + + + + + + + + + + + + Format of the ${stacktrace} layout renderer output. + + + + + Raw format (multiline - as returned by StackFrame.ToString() method). + + + + + Flat format (class and method names displayed in a single line). + + + + + Detailed flat format (method signatures displayed in a single line). + + + + + Stack trace renderer. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the output format of the stack trace. + + + + + + Gets or sets the number of top stack frames to be rendered. + + + + + + Gets or sets the number of frames to skip. + + + + + + Gets or sets the stack frame separator string. + + + + + + Logger should capture StackTrace, if it was not provided manually + + + + + + Gets or sets whether to render StackFrames in reverse order + + + + + + + + + + + + Log event context data. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Initializes a new instance of the class. + + + + + Gets or sets string that will be used to separate key/value pairs. + + + + + + Get or set if empty values should be included. + + A value is empty when null or in case of a string, null or empty string. + + + + + + Gets or sets whether to include the contents of the properties-dictionary. + + + + + + Gets or sets the keys to exclude from the output. If omitted, none are excluded. + + + + + + Enables capture of ScopeContext-properties from active thread context + + + + + Gets or sets how key/value pairs will be formatted. + + + + + + Gets or sets the culture used for rendering. + + + + + + + + + Log event context data. See . + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the name of the item. + + + + + + Format string for conversion from object to string. + + + + + + Gets or sets the culture used for rendering. + + + + + + Gets or sets the object-property-navigation-path for lookup of nested property + + + + + + Gets or sets whether to perform case-sensitive property-name lookup + + + + + + + + Render a Global Diagnostics Context item. See + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the name of the item. + + + + + + Format string for conversion from object to string. + + + + + + Gets or sets the culture used for rendering. + + + + + + + + + Lookup parameter value from + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the name of the parameter. + + + + + + + + + Obsolete and replaced by with NLog v5. + Render Mapped Diagnostics Logical (MDC) from + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the name of the item. + + + + + + Format string for conversion from object to string. + + + + + + + + + Obsolete and replaced by with NLog v5. + Render Mapped Diagnostics Logical Context (MDLC) from + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the name of the item. + + + + + + Format string for conversion from object to string. + + + + + + + + + Obsolete and replaced by with NLog v5. + Render Nested Diagnostic Context (NDC) from + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the number of top stack frames to be rendered. + + + + + + Gets or sets the number of bottom stack frames to be rendered. + + + + + + Gets or sets the separator to be used for concatenating nested diagnostics context output. + + + + + + + + + Obsolete and replaced by with NLog v5. + Render Nested Diagnostic Context (NDLC) from + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the number of top stack frames to be rendered. + + + + + + Gets or sets the number of bottom stack frames to be rendered. + + + + + + Gets or sets the separator to be used for concatenating nested logical context output. + + + + + + + + + Obsolete and replaced by with NLog v5. + Render Nested Diagnostic Context (NDLC) timings from + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets whether to only include the duration of the last scope created + + + + + + Gets or sets whether to just display the scope creation time, and not the duration + + + + + + Gets or sets the TimeSpan format. Can be any argument accepted by TimeSpan.ToString(format). + + + + + + + + + Renders the nested states from like a callstack + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the indent token. + + + + + + + + + Renders the nested states from like a callstack + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the number of top stack frames to be rendered. + + + + + + Gets or sets the number of bottom stack frames to be rendered. + + + + + + Gets or sets the separator to be used for concatenating nested logical context output. + + + + + + Gets or sets how to format each nested state. Ex. like JSON = @ + + + + + + Gets or sets the culture used for rendering. + + + + + + + + + Renders specified property-item from + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the name of the item. + + + + + + Format string for conversion from object to string. + + + + + + Gets or sets the culture used for rendering. + + + + + + + + + Timing Renderer (Async scope) + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets whether to only include the duration of the last scope created + + + + + + Gets or sets whether to just display the scope creation time, and not the duration + + + + + + Gets or sets the TimeSpan format. Can be any argument accepted by TimeSpan.ToString(format). + + When Format has not been specified, then it will render TimeSpan.TotalMilliseconds + + + + + + Gets or sets the culture used for rendering. + + + + + + + + + A renderer that puts into log a System.Diagnostics trace correlation id. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + + + + A counter value (increases on each layout rendering). + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the initial value of the counter. + + + + + + Gets or sets the value to be added to the counter after each layout rendering. + + + + + + Gets or sets the name of the sequence. Different named sequences can have individual values. + + + + + + + + + Globally-unique identifier (GUID). + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the GUID format as accepted by Guid.ToString() method. + + + + + + Generate the Guid from the NLog LogEvent (Will be the same for all targets) + + + + + + + + + The sequence ID + + + See NLog Wiki + + Documentation on NLog Wiki + + + + + + + Current date and time. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Initializes a new instance of the class. + + + + + Gets or sets the culture used for rendering. + + + + + + Gets or sets the date format. Can be any argument accepted by DateTime.ToString(format). + + + + + + Gets or sets a value indicating whether to output UTC time instead of local time. + + + + + + + + + The date and time in a long, sortable format yyyy-MM-dd HH:mm:ss.ffff. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets a value indicating whether to output UTC time instead of local time. + + + + + + + + + The process time in format HH:mm:ss.mmm. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets a value indicating whether to output in culture invariant format + + + + + + Gets or sets the culture used for rendering. + + + + + + + + + Write timestamp to builder with format hh:mm:ss:fff + + + + + The short date in a sortable format yyyy-MM-dd. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets a value indicating whether to output UTC time instead of local time. + + + + + + + + + The Ticks value of current date and time. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + + + + The time in a 24-hour, sortable format HH:mm:ss.mmmm. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets a value indicating whether to output UTC time instead of local time. + + + + + + Gets or sets a value indicating whether to output in culture invariant format + + + + + + Gets or sets the culture used for rendering. + + + + + + + + + DB null for a database + + + See NLog Wiki + + Documentation on NLog Wiki + + + + + + + The current application domain's base directory. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + cached + + + + + Use base dir of current process. Alternative one can just use ${processdir} + + + + + + Fallback to the base dir of current process, when AppDomain.BaseDirectory is Temp-Path (.NET Core 3 - Single File Publish) + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the name of the file to be Path.Combine()'d with the base directory. + + + + + + Gets or sets the name of the directory to be Path.Combine()'d with the base directory. + + + + + + + + + The current working directory of the application. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the name of the file to be Path.Combine()'d with the current directory. + + + + + + Gets or sets the name of the directory to be Path.Combine()'d with the current directory. + + + + + + + + + The directory where NLog.dll is located. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the name of the file to be Path.Combine()'d with the directory name. + + + + + + Gets or sets the name of the directory to be Path.Combine()'d with the directory name. + + + + + + + + + + + + + + + The executable directory from the FileName, + using the current process + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the name of the file to be Path.Combine()'d with the process directory. + + + + + + Gets or sets the name of the directory to be Path.Combine()'d with the process directory. + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + + + + System special folder path from + + + + + Initializes a new instance of the class. + + + + + System special folder path from + + + + + Initializes a new instance of the class. + + + + + System special folder path (includes My Documents, My Music, Program Files, Desktop, and more). + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the system special folder to use. + + + Full list of options is available at MSDN. + The most common ones are: +
    +
  • CommonApplicationData - application data for all users.
    • +
  • ApplicationData - roaming application data for current user.
    • +
  • LocalApplicationData - non roaming application data for current user
    • +
  • UserProfile - Profile folder for current user
    • +
  • DesktopDirectory - Desktop-directory for current user
    • +
  • MyDocuments - My Documents-directory for current user
    • +
  • System - System directory
    • +
+ + + + + + Gets or sets the name of the file to be Path.Combine()'d with the directory name. + + + + + + Gets or sets the name of the directory to be Path.Combine()'d with the directory name. + + + + + + + + + System special folder path from + + + + + Initializes a new instance of the class. + + + + + A temporary directory. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the name of the file to be Path.Combine()'d with the directory name. + + + + + + Gets or sets the name of the directory to be Path.Combine()'d with the directory name. + + + + + + + + + + + + The OS dependent directory separator + + + + + + + + Render information of + for the exception passed to the logger call + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the key to search the exception Data for + + + + + + Gets or sets whether to render innermost Exception from + + + + + + Format string for conversion from object to string. + + + + + + Gets or sets the culture used for rendering. + + + + + + + + + Exception information provided through + a call to one of the Logger.*Exception() methods. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Initializes a new instance of the class. + + + + + Gets or sets the format of the output. Must be a comma-separated list of exception + properties: Message, Type, ShortType, ToString, Method, StackTrace. + This parameter value is case-insensitive. + + + + + + + + Gets or sets the format of the output of inner exceptions. Must be a comma-separated list of exception + properties: Message, Type, ShortType, ToString, Method, StackTrace. + This parameter value is case-insensitive. + + + + + + Gets or sets the separator used to concatenate parts specified in the Format. + + + + + + Gets or sets the separator used to concatenate exception data specified in the Format. + + + + + + Gets or sets the maximum number of inner exceptions to include in the output. + By default inner exceptions are not enabled for compatibility with NLog 1.0. + + + + + + Gets or sets the separator between inner exceptions. + + + + + + Gets or sets whether to render innermost Exception from + + + + + + Gets or sets whether to collapse exception tree using + + + + + + Gets the formats of the output of inner exceptions to be rendered in target. + + + + + + Gets the formats of the output to be rendered in target. + + + + + + + + + Appends the Message of an Exception to the specified . + + The to append the rendered data to. + The exception containing the Message to append. + + + + Appends the method name from Exception's stack trace to the specified . + + The to append the rendered data to. + The Exception whose method name should be appended. + + + + Appends the stack trace from an Exception to the specified . + + The to append the rendered data to. + The Exception whose stack trace should be appended. + + + + Appends the result of calling ToString() on an Exception to the specified . + + The to append the rendered data to. + The Exception whose call to ToString() should be appended. + + + + Appends the type of an Exception to the specified . + + The to append the rendered data to. + The Exception whose type should be appended. + + + + Appends the short type of an Exception to the specified . + + The to append the rendered data to. + The Exception whose short type should be appended. + + + + Appends the application source of an Exception to the specified . + + The to append the rendered data to. + The Exception whose source should be appended. + + + + Appends the HResult of an Exception to the specified . + + The to append the rendered data to. + The Exception whose HResult should be appended. + + + + Appends the contents of an Exception's Data property to the specified . + + The to append the rendered data to. + The Exception whose Data property elements should be appended. + + + + Appends all the serialized properties of an Exception into the specified . + + The to append the rendered data to. + The Exception whose properties should be appended. + + + + Appends all the additional properties of an Exception like Data key-value-pairs + + The to append the rendered data to. + The Exception whose properties should be appended. + + + + Split the string and then compile into list of Rendering formats. + + + + + Renders contents of the specified file. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Initializes a new instance of the class. + + + + + Gets or sets the name of the file. + + + + + + Gets or sets the encoding used in the file. + + The encoding. + + + + + + + + A layout renderer which could have different behavior per instance by using a . + + + + + Initializes a new instance of the class. + + Name without ${}. + + + + Initializes a new instance of the class. + + Name without ${}. + Method that renders the layout. + + + + Name used in config without ${}. E.g. "test" could be used as "${test}". + + + + + Method that renders the layout. + + This public property will be removed in NLog 5. + + + + + Format string for conversion from object to string. + + + + + + Gets or sets the culture used for rendering. + + + + + + + + + Render the value for this log event + + The logging event. + The value. + + + + A layout renderer which could have different behavior per instance by using a . + + + + + Initializes a new instance of the class. + + Name without ${}. + Method that renders the layout. + + + + Thread identity information (name and authentication information). + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the separator to be used when concatenating + parts of identity information. + + + + + + Gets or sets a value indicating whether to render Thread.CurrentPrincipal.Identity.Name. + + + + + + Gets or sets a value indicating whether to render Thread.CurrentPrincipal.Identity.AuthenticationType. + + + + + + Gets or sets a value indicating whether to render Thread.CurrentPrincipal.Identity.IsAuthenticated. + + + + + + + + + Render environmental information related to logging events. + + + + + Gets the logging configuration this target is part of. + + + + + Value formatter + + + + + + + + Renders the value of layout renderer in the context of the specified log event. + + The log event. + String representation of a layout renderer. + + + + + + + + + + Initializes this instance. + + The configuration. + + + + Closes this instance. + + + + + Renders the value of layout renderer in the context of the specified log event. + + The log event. + The layout render output is appended to builder + + + + Renders the value of layout renderer in the context of the specified log event into . + + The to append the rendered data to. + Logging event. + + + + Initializes the layout renderer. + + + + + Closes the layout renderer. + + + + + Get the for rendering the messages to a + + LogEvent with culture + Culture in on Layout level + + + + + Get the for rendering the messages to a + + LogEvent with culture + Culture in on Layout level + + + is preferred + + + + + Obsolete and replaced by with NLog v5.2. + + Register a custom layout renderer. + + Short-cut for registering to default + Type of the layout renderer. + The layout-renderer type-alias for use in NLog configuration - without '${ }' + + + + Obsolete and replaced by with NLog v5.2. + + Register a custom layout renderer. + + Short-cut for registering to default + Type of the layout renderer. + The layout-renderer type-alias for use in NLog configuration - without '${ }' + + + + Obsolete and replaced by with NLog v5.2. + + Register a custom layout renderer with a callback function . The callback receives the logEvent. + + The layout-renderer type-alias for use in NLog configuration - without '${ }' + Callback that returns the value for the layout renderer. + + + + Obsolete and replaced by with NLog v5.2. + + Register a custom layout renderer with a callback function . The callback receives the logEvent and the current configuration. + + The layout-renderer type-alias for use in NLog configuration - without '${ }' + Callback that returns the value for the layout renderer. + + + + Obsolete and replaced by with NLog v5.2. + + Register a custom layout renderer with a callback function . The callback receives the logEvent and the current configuration. + + Renderer with callback func + + + + Resolves the interface service-type from the service-repository + + + + + Format of the ${level} layout renderer output. + + + + + Render the LogLevel standard name. + + + + + Render the first character of the level. + + + + + Render the first character of the level. + + + + + Render the ordinal (aka number) for the level. + + + + + Render the LogLevel full name, expanding Warn / Info abbreviations + + + + + Render the LogLevel as 3 letter abbreviations (Trc, Dbg, Inf, Wrn, Err, Ftl) + + + + + The log level. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets a value indicating the output format of the level. + + + + + + Gets or sets a value indicating whether upper case conversion should be applied. + + A value of true if upper case conversion should be applied otherwise, false. + + + + + + + + A string literal. + + + This is used to escape '${' sequence + as ;${literal:text=${}' + + See NLog Wiki + + Documentation on NLog Wiki + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The literal text value. + This is used by the layout compiler. + + + + Gets or sets the literal text. + + + + + + + + + A string literal with a fixed raw value + + + + + Initializes a new instance of the class. + + The literal text value. + + Fixed raw value + This is used by the layout compiler. + + + + XML event description compatible with log4j, Chainsaw and NLogViewer. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + + + + Gets or sets a value indicating whether to include NLog-specific extensions to log4j schema. + + + + + + Gets or sets a value indicating whether the XML should use spaces for indentation. + + + + + + Gets or sets the log4j:event logger-xml-attribute. Default: ${logger} + + + + + + Gets or sets the log4j:event message-xml-element. Default: ${message} + + + + + + Gets or sets the log4j:event log4japp-xml-element. By default it's the friendly name of the current AppDomain. + + + + + + Gets or sets a value indicating whether to include call site (class and method name) in the information sent over the network. + + + + + + Gets or sets a value indicating whether to include source info (file name and line number) in the information sent over the network. + + + + + + Obsolete and replaced by with NLog v5. + + Gets or sets a value indicating whether to include contents of the dictionary. + + + + + + Obsolete and replaced by with NLog v5. + + Gets or sets a value indicating whether to include contents of the dictionary. + + + + + + Obsolete and replaced by with NLog v5. + + Gets or sets a value indicating whether to include contents of the stack. + + + + + + Gets or sets whether to include log4j:NDC in output from nested context. + + + + + + Gets or sets whether to include the contents of the properties-dictionary. + + + + + + Gets or sets whether to include log4j:NDC in output from nested context. + + + + + + Gets or sets the stack separator for log4j:NDC in output from nested context. + + + + + + Obsolete and replaced by with NLog v5. + + Gets or sets the stack separator for log4j:NDC in output from nested context. + + + + + + Obsolete and replaced by with NLog v5. + + Gets or sets the option to include all properties from the log events + + + + + + Gets or sets the option to include all properties from the log events + + + + + + Gets or sets the stack separator for log4j:NDC in output from nested context. + + + + + + Gets or sets whether the log4j:throwable xml-element should be written as CDATA + + + + + + + + + + + + The logger name. + + + See NLog Wiki + + Documentation on NLog Wiki/// + + + + Gets or sets a value indicating whether to render short logger name (the part after the trailing dot character). + + + + + + Gets or sets a value indicating whether to render prefix of logger name (the part before the trailing dot character). + + + + + + + + The environment variable. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the name of the environment variable. + + + + + + Gets or sets the default value to be used when the environment variable is not set. + + + + + + + + + The host name that the process is running on. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + + + + Gets the host name and falls back to computer name if not available + + + + + Tries the lookup value. + + The lookup function. + Type of the lookup. + + + + + + + + The IP address from the network interface card (NIC) on the local machine + + + Skips loopback-adapters and tunnel-interfaces. Skips devices without any MAC-address + + See NLog Wiki + + Documentation on NLog Wiki + + + + Get or set whether to prioritize IPv6 or IPv4 (default) + + + + + + + + + + + + + + + The machine name that the process is running on. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + + + + + + + The formatted log message. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Initializes a new instance of the class. + + + + + Gets or sets a value indicating whether to log exception along with message. + + + + + + Gets or sets the string that separates message from the exception. + + + + + + Gets or sets whether it should render the raw message without formatting parameters + + + + + + + + + A newline literal. + + + + + + + + The identifier of the current thread. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + + + + The name of the current thread. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + + + + Render a NLog Configuration variable assigned from API or loaded from config-file + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the name of the NLog variable. + + + + + + Gets or sets the default value to be used when the variable is not set. + + Not used if Name is null + + + + + Gets the configuration variable layout matching the configured Name + + Mostly relevant for the scanning of active NLog Layouts (Ex. CallSite capture) + + + + + + + Try lookup the configuration variable layout matching the configured Name + + + + + + + + Applies caching to another layout output. + + + The value of the inner layout will be rendered only once and reused subsequently. + + See NLog Wiki + + Documentation on NLog Wiki + + + + A value indicating when the cache is cleared. + + + + Never clear the cache. + + + Clear the cache whenever the is initialized. + + + Clear the cache whenever the is closed. + + + + Gets or sets a value indicating whether this is enabled. + + + + + + Gets or sets a value indicating when the cache is cleared. + + + + + + Cachekey. If the cachekey changes, resets the value. For example, the cachekey would be the current day.s + + + + + + Gets or sets a value indicating how many seconds the value should stay cached until it expires + + + + + + + + + + + + + + + + + + Filters characters not allowed in the file names by replacing them with safe character. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets a value indicating whether to modify the output of this renderer so it can be used as a part of file path + (illegal characters are replaced with '_'). + + + + + + + + + + + + Escapes output of another layout using JSON rules. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets whether output should be encoded with Json-string escaping. + + + + + + Gets or sets a value indicating whether to escape non-ascii characters + + + + + + Should forward slashes be escaped? If true, / will be converted to \/ + + + If not set explicitly then the value of the parent will be used as default. + + + + + + + + + + + + Left part of a text + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the length in characters. + + + + + + Same as -property, so it can be used as ambient property. + + + ${message:truncate=80} + + + + + + + + + + + + Converts the result of another layout output to lower case. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets a value indicating whether lower case conversion should be applied. + + A value of true if lower case conversion should be applied; otherwise, false. + + + + + Same as -property, so it can be used as ambient property. + + + ${level:tolower} + + + + + + Gets or sets the culture used for rendering. + + + + + + + + + + + + Render the non-raw value of an object. + + For performance and/or full (formatted) control of the output. + + + + Gets or sets a value indicating whether to disable the IRawValue-interface + + A value of true if IRawValue-interface should be ignored; otherwise, false. + + + + + + + + + + + Render a single property of a object + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the object-property-navigation-path for lookup of nested property + + Shortcut for + + + + + + Gets or sets the object-property-navigation-path for lookup of nested property + + + + + + Format string for conversion from object to string. + + + + + + Gets or sets the culture used for rendering. + + + + + + + + + + + + Lookup property-value from source object based on + + Could resolve property-value? + + + + Only outputs the inner layout when exception has been defined for log message. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + If is not found, print this layout. + + + + + + + + + + + + Outputs alternative layout when the inner layout produces empty result. + + + ${onhasproperties:, Properties\: ${all-event-properties}} + + + See NLog Wiki + + Documentation on NLog Wiki + + + + If is not found, print this layout. + + + + + + + + + + + + Horizontal alignment for padding layout renderers. + + + + + When layout text is too long, align it to the left + (remove characters from the right). + + + + + When layout text is too long, align it to the right + (remove characters from the left). + + + + + Applies padding to another layout output. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the number of characters to pad the output to. + + + Positive padding values cause left padding, negative values + cause right padding to the desired width. + + + + + + Gets or sets the padding character. + + + + + + Gets or sets a value indicating whether to trim the + rendered text to the absolute value of the padding length. + + + + + + Gets or sets a value indicating whether a value that has + been truncated (when is true) + will be left-aligned (characters removed from the right) + or right-aligned (characters removed from the left). The + default is left alignment. + + + + + + + + + + + + Replaces a string in the output of another layout with another string. + + + ${replace:searchFor=\\n+:replaceWith=-:regex=true:inner=${message}} + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the text to search for. + + The text search for. + + + + + Gets or sets a value indicating whether regular expressions should be used. + + A value of true if regular expressions should be used otherwise, false. + + + + + Gets or sets the replacement string. + + The replacement string. + + + + + Gets or sets the group name to replace when using regular expressions. + Leave null or empty to replace without using group name. + + The group name. + + + + + Gets or sets a value indicating whether to ignore case. + + A value of true if case should be ignored when searching; otherwise, false. + + + + + Gets or sets a value indicating whether to search for whole words. + + A value of true if whole words should be searched for; otherwise, false. + + + + + Compile the ? This can improve the performance, but at the costs of more memory usage. If false, the Regex Cache is used. + + + + + + + + + + + + This class was created instead of simply using a lambda expression so that the "ThreadAgnosticAttributeTest" will pass + + + + + A match evaluator for Regular Expression based replacing + + Input string. + Group name in the regex. + Replace value. + Match from regex. + Groups replaced with . + + + + Replaces newline characters from the result of another layout renderer with spaces. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets a value indicating the string that should be used for separating lines. + + + + + + + + + + + + Right part of a text + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the length in characters. + + + + + + + + + + + + Decodes text "encrypted" with ROT-13. + + + See https://en.wikipedia.org/wiki/ROT13. + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the layout to be wrapped. + + The layout to be wrapped. + This variable is for backwards compatibility + + + + + Encodes/Decodes ROT-13-encoded string. + + The string to be encoded/decoded. + Encoded/Decoded text. + + + + + + + + + + Encodes/Decodes ROT-13-encoded string. + + + + + Substring the result + + + ${substring:${level}:start=2:length=2} + ${substring:${level}:start=-2:length=2} + ${substring:Inner=${level}:start=2:length=2} + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the start index. + + Index + + + + + Gets or sets the length in characters. If null, then the whole string + + Index + + + + + + + + + + + Calculate start position + + 0 or positive number + + + + Calculate needed length + + 0 or positive number + + + + Trims the whitespace from the result of another layout renderer. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets a value indicating whether lower case conversion should be applied. + + A value of true if lower case conversion should be applied; otherwise, false. + + + + + + + + + + + Converts the result of another layout output to upper case. + + + ${uppercase:${level}} //[DefaultParameter] + ${uppercase:Inner=${level}} + ${level:uppercase} // [AmbientProperty] + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets a value indicating whether upper case conversion should be applied. + + A value of true if upper case conversion should be applied otherwise, false. + + + + + Same as -property, so it can be used as ambient property. + + + ${level:toupper} + + + + + + Gets or sets the culture used for rendering. + + + + + + + + + + + + Encodes the result of another layout output for use with URLs. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Initializes a new instance of the class. + + + + + Gets or sets a value indicating whether spaces should be translated to '+' or '%20'. + + A value of true if space should be translated to '+'; otherwise, false. + + + + + Gets or sets a value whether escaping be done according to Rfc3986 (Supports Internationalized Resource Identifiers - IRIs) + + A value of true if Rfc3986; otherwise, false for legacy Rfc2396. + + + + + Gets or sets a value whether escaping be done according to the old NLog style (Very non-standard) + + A value of true if legacy encoding; otherwise, false for standard UTF8 encoding. + + + + + + + + + + + Outputs alternative layout when the inner layout produces empty result. + + + + + Gets or sets the layout to be rendered when original layout produced empty result. + + + + + + + + + + + + + + + Only outputs the inner layout when the specified condition has been met. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets the condition that must be met for the layout to be printed. + + + + + + If is not met, print this layout. + + + + + + + + + + + + Replaces newline characters from the result of another layout renderer with spaces. + + + + + Gets or sets the line length for wrapping. + + + Only positive values are allowed + + + + + + + + + Base class for s which wrapping other s. + + This has the property (which is default) and can be used to wrap. + + + ${uppercase:${level}} //[DefaultParameter] + ${uppercase:Inner=${level}} + + + + + Gets or sets the wrapped layout. + + [DefaultParameter] so Inner: is not required if it's the first + + + + + + + + + + + + Appends the rendered output from -layout and transforms the added output (when necessary) + + Logging event. + The to append the rendered data to. + Start position for any necessary transformation of . + + + + Transforms the output of another layout. + + Logging event. + Output to be transform. + Transformed text. + + + + Transforms the output of another layout. + + Output to be transform. + Transformed text. + + + + Renders the inner layout contents. + + The log event. + Contents of inner layout. + + + + Base class for s which wrapping other s. + + This expects the transformation to work on a + + + + + + + + + + + Transforms the output of another layout. + + Output to be transform. + + + + Renders the inner layout contents. + + + for the result + + + + + + + + + + Converts the result of another layout output to be XML-compliant. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets or sets whether output should be encoded with Xml-string escaping. + + Ensures always valid XML, but gives a performance hit + + + + + Gets or sets a value indicating whether to transform newlines (\r\n) into ( ) + + + + + + + + + + + + A layout containing one or more nested layouts. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Initializes a new instance of the class. + + + + + Gets the inner layouts. + + + + + + + + + + + + + + + + + + + + + A column in the CSV. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The name of the column. + The layout of the column. + + + + Gets or sets the name of the column. + + + + + + Gets or sets the layout of the column. + + + + + + Gets or sets the override of Quoting mode + + + and are faster than the default + + + + + + Specifies allowed column delimiters. + + + + + Automatically detect from regional settings. + + + + + Comma (ASCII 44). + + + + + Semicolon (ASCII 59). + + + + + Tab character (ASCII 9). + + + + + Pipe character (ASCII 124). + + + + + Space character (ASCII 32). + + + + + Custom string, specified by the . + + + + + A specialized layout that renders CSV-formatted events. + + + + If is set, then the header generation with column names will be disabled. + + See NLog Wiki + + Documentation on NLog Wiki + + + + Initializes a new instance of the class. + + + + + Gets the array of parameters to be passed. + + + + + + Gets or sets a value indicating whether CVS should include header. + + A value of true if CVS should include header; otherwise, false. + + + + + Gets or sets the column delimiter. + + + + + + Gets or sets the quoting mode. + + + + + + Gets or sets the quote Character. + + + + + + Gets or sets the custom column delimiter value (valid when is set to ). + + + + + + + + + + + + + + + + + + Get the headers with the column names. + + + + + + Header with column names for CSV layout. + + + + + Initializes a new instance of the class. + + The parent. + + + + + + + + + + + + + + + + Specifies CSV quoting modes. + + + + + Quote Always (Fast) + + + + + Quote nothing (Very fast) + + + + + Quote only whose values contain the quote symbol or the separator (Slow) + + + + + A specialized layout that renders LogEvent as JSON-Array + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Gets the array of items to include in JSON-Array + + + + + + Gets or sets the option to suppress the extra spaces in the output json + + + + + + Gets or sets the option to render the empty object value {} + + + + + + + + + + + + + + + + + + + + + JSON attribute. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The name of the attribute. + The layout of the attribute's value. + + + + Initializes a new instance of the class. + + The name of the attribute. + The layout of the attribute's value. + Encode value with json-encode + + + + Gets or sets the name of the attribute. + + + + + + Gets or sets the layout that will be rendered as the attribute's value. + + + + + + Gets or sets the result value type, for conversion of layout rendering output + + + + + + Gets or sets the fallback value when result value is not available + + + + + + Gets or sets whether output should be encoded as Json-String-Property, or be treated as valid json. + + + + + + Gets or sets a value indicating whether to escape non-ascii characters + + + + + + Should forward slashes be escaped? If true, / will be converted to \/ + + + If not set explicitly then the value of the parent will be used as default. + + + + + + Gets or sets whether an attribute with empty value should be included in the output + + + + + + A specialized layout that renders JSON-formatted events. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Initializes a new instance of the class. + + + + + Gets the array of attributes' configurations. + + + + + + Gets or sets the option to suppress the extra spaces in the output json + + + + + + Gets or sets the option to render the empty object value {} + + + + + + Auto indent and create new lines + + + + + + Gets or sets the option to include all properties from the log event (as JSON) + + + + + + Gets or sets a value indicating whether to include contents of the dictionary. + + + + + + Gets or sets whether to include the contents of the dictionary. + + + + + + Obsolete and replaced by with NLog v5. + + Gets or sets the option to include all properties from the log event (as JSON) + + + + + + Obsolete and replaced by with NLog v5. + + Gets or sets a value indicating whether to include contents of the dictionary. + + + + + + Obsolete and replaced by with NLog v5. + + Gets or sets a value indicating whether to include contents of the dictionary. + + + + + + Gets or sets the option to exclude null/empty properties from the log event (as JSON) + + + + + + List of property names to exclude when is true + + + + + + How far should the JSON serializer follow object references before backing off + + + + + + Should forward slashes be escaped? If true, / will be converted to \/ + + + If not set explicitly then the value of the parent will be used as default. + + + + + + + + + + + + + + + + + + + + + Abstract interface that layouts must implement. + + + + + Is this layout initialized? See + + + + + Gets a value indicating whether this layout is thread-agnostic (can be rendered on any thread). + + + Layout is thread-agnostic if it has been marked with [ThreadAgnostic] attribute and all its children are + like that as well. + + Thread-agnostic layouts only use contents of for its output. + + + + + Gets the level of stack trace information required for rendering. + + + + + Gets the logging configuration this target is part of. + + + + + Converts a given text to a . + + Text to be converted. + object represented by the text. + + + + Implicitly converts the specified string to a . + + The layout string. + Instance of .' + + + + Implicitly converts the specified string to a . + + The layout string. + The NLog factories to use when resolving layout renderers. + Instance of . + + + + Implicitly converts the specified string to a . + + The layout string. + Whether should be thrown on parse errors (false = replace unrecognized tokens with a space). + Instance of . + + + + Create a from a lambda method. + + Method that renders the layout. + Tell if method is safe for concurrent threading. + Instance of . + + + + Precalculates the layout for the specified log event and stores the result + in per-log event cache. + + Only if the layout doesn't have [ThreadAgnostic] and doesn't contain layouts with [ThreadAgnostic]. + + The log event. + + Calling this method enables you to store the log event in a buffer + and/or potentially evaluate it in another thread even though the + layout may contain thread-dependent renderer. + + + + + Renders formatted output using the log event as context. + + Inside a , is preferred for performance reasons. + The logging event. + The formatted output as string. + + + + Optimized version of that works best when + override of is available. + + The logging event. + Appends the formatted output to target + + + + Optimized version of that works best when + override of is available. + + The logging event. + Appends the string representing log event to target + Should rendering result be cached on LogEventInfo + + + + Valid default implementation of , when having implemented the optimized + + The logging event. + The rendered layout. + + + + Renders formatted output using the log event as context. + + The logging event. + Appends the formatted output to target + + + + Initializes this instance. + + The configuration. + + + + Closes this instance. + + + + + Initializes this instance. + + The configuration. + + + + Closes this instance. + + + + + Initializes the layout. + + + + + Closes the layout. + + + + + Renders formatted output using the log event as context. + + The logging event. + The formatted output. + + + + Obsolete and replaced by with NLog v5.2. + + Register a custom Layout. + + Short-cut for registering to default + Type of the Layout. + Name of the Layout. + + + + Obsolete and replaced by with NLog v5.2. + + Register a custom Layout. + + Short-cut for registering to default + Type of the Layout. + Name of the Layout. + + + + Optimized version of for internal Layouts, when + override of is available. + + + + + Try get value + + + rawValue if return result is true + false if we could not determine the rawValue + + + + Resolve from DI + + Avoid calling this while handling a LogEvent, since random deadlocks can occur + + + + Marks class as Layout and attaches a type-alias name for use in NLog configuration. + + + + + Initializes a new instance of the class. + + The Layout type-alias for use in NLog configuration. + + + + Parses layout strings. + + + + + Add to + + + + + + + Options available for + + + + + Default options + + + + + Layout renderer method can handle concurrent threads + + + + + Layout renderer method is agnostic to current thread context. This means it will render the same result independent of thread-context. + + + + + A specialized layout that supports header and footer. + + + + + Gets or sets the body layout (can be repeated multiple times). + + + + + + Gets or sets the header layout. + + + + + + Gets or sets the footer layout. + + + + + + + + + + + + A specialized layout that renders Log4j-compatible XML events. + + + + This layout is not meant to be used explicitly. Instead you can use ${log4jxmlevent} layout renderer. + + See NLog Wiki + + Documentation on NLog Wiki + + + + Initializes a new instance of the class. + + + + + Gets the instance that renders log events. + + + + + Gets the collection of parameters. Each parameter contains a mapping + between NLog layout and a named parameter. + + + + + + Gets or sets the option to include all properties from the log events + + + + + + Gets or sets whether to include the contents of the properties-dictionary. + + + + + + Gets or sets whether to include log4j:NDC in output from nested context. + + + + + + Obsolete and replaced by with NLog v5. + + Gets or sets the option to include all properties from the log events + + + + + + Obsolete and replaced by with NLog v5. + + Gets or sets a value indicating whether to include contents of the dictionary. + + + + + + Gets or sets whether to include log4j:NDC in output from nested context. + + + + + + Obsolete and replaced by with NLog v5. + + Gets or sets a value indicating whether to include contents of the dictionary. + + + + + + Obsolete and replaced by with NLog v5. + + Gets or sets a value indicating whether to include contents of the stack. + + + + + + Gets or sets the log4j:event logger-xml-attribute. Default: ${logger} + + + + + + Gets or sets the log4j:event message-xml-element. Default: ${message} + + + + + + Gets or sets the log4j:event log4japp-xml-element. By default it's the friendly name of the current AppDomain. + + + + + + Gets or sets whether the log4j:throwable xml-element should be written as CDATA + + + + + + Gets or sets a value indicating whether to include call site (class and method name) in the information sent over the network. + + + + + + Gets or sets a value indicating whether to include source info (file name and line number) in the information sent over the network. + + + + + + + + + + + + Represents a string with embedded placeholders that can render contextual information. + + + + This layout is not meant to be used explicitly. Instead you can just use a string containing layout + renderers everywhere the layout is required. + + See NLog Wiki + + Documentation on NLog Wiki + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The layout string to parse. + + + + Initializes a new instance of the class. + + The layout string to parse. + The NLog factories to use when creating references to layout renderers. + + + + Initializes a new instance of the class. + + The layout string to parse. + The NLog factories to use when creating references to layout renderers. + Whether should be thrown on parse errors. + + + + Original text before compile to Layout renderes + + + + + Gets or sets the layout text. + + + + + + Is the message fixed? (no Layout renderers used) + + + + + Get the fixed text. Only set when is true + + + + + Is the message a simple formatted string? (Can skip StringBuilder) + + + + + Gets a collection of objects that make up this layout. + + + + + Gets a collection of objects that make up this layout. + + + + + Gets the level of stack trace information required for rendering. + + + + + Converts a text to a simple layout. + + Text to be converted. + A object. + + + + Escapes the passed text so that it can + be used literally in all places where + layout is normally expected without being + treated as layout. + + The text to be escaped. + The escaped text. + + Escaping is done by replacing all occurrences of + '${' with '${literal:text=${}' + + + + + Evaluates the specified text by expanding all layout renderers. + + The text to be evaluated. + Log event to be used for evaluation. + The input text with all occurrences of ${} replaced with + values provided by the appropriate layout renderers. + + + + Evaluates the specified text by expanding all layout renderers + in new context. + + The text to be evaluated. + The input text with all occurrences of ${} replaced with + values provided by the appropriate layout renderers. + + + + + + + + + + + + + + + + + + + + + + Typed Layout for easy conversion from NLog Layout logic to a simple value (ex. integer or enum) + + + + + + Is fixed value? + + + + + Fixed value + + + + + Initializes a new instance of the class. + + Dynamic NLog Layout + + + + Initializes a new instance of the class. + + Dynamic NLog Layout + Format used for parsing string-value into result value type + Culture used for parsing string-value into result value type + + + + Initializes a new instance of the class. + + Fixed value + + + + Render Value + + Log event for rendering + Fallback value when no value available + Result value when available, else fallback to defaultValue + + + + Renders the value and converts the value into string format + + + Only to implement abstract method from , and only used when calling + + + + + + + + + + + + + + + + + + + + + + + Implements Equals using + + + + + + + + Converts a given value to a . + + Text to be converted. + + + + Converts a given text to a . + + Text to be converted. + + + + Implements the operator == using + + + + + Implements the operator != using + + + + + Provides access to untyped value without knowing underlying generic type + + + + + Typed Value that is easily configured from NLog.config file + + + + + Initializes a new instance of the class. + + + + + Gets or sets the layout that will render the result value + + + + + + Gets or sets the result value type, for conversion of layout rendering output + + + + + + Gets or sets the fallback value when result value is not available + + + + + + Gets or sets the fallback value should be null (instead of default value of ) when result value is not available + + + + + + Gets or sets format used for parsing parameter string-value for type-conversion + + + + + + Gets or sets the culture used for parsing parameter string-value for type-conversion + + + + + + Render Result Value + + Log event for rendering + Result value when available, else fallback to defaultValue + + + + XML attribute. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The name of the attribute. + The layout of the attribute's value. + + + + Initializes a new instance of the class. + + The name of the attribute. + The layout of the attribute's value. + Encode value with xml-encode + + + + Gets or sets the name of the attribute. + + + + + + Gets or sets the layout that will be rendered as the attribute's value. + + + + + + Gets or sets the result value type, for conversion of layout rendering output + + + + + + Gets or sets the fallback value when result value is not available + + + + + + Gets or sets whether output should be encoded with Xml-string escaping, or be treated as valid xml-attribute-value + + + + + + Gets or sets whether an attribute with empty value should be included in the output + + + + + + A XML Element + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + Name of the element + + + Default value "item" + + + + + + Value inside the element + + + + + + Value inside the element + + + + + + Gets or sets whether output should be encoded with Xml-string escaping, or be treated as valid xml-element-value + + + + + + A specialized layout that renders XML-formatted events. + + + + + Initializes a new instance of the class. + + The name of the top XML node + The value of the top XML node + + + + Name of the XML element + + Upgrade to private protected when using C# 7.2 + + + + Value inside the XML element + + Upgrade to private protected when using C# 7.2 + + + + Auto indent and create new lines + + + + + + Gets the array of xml 'elements' configurations. + + + + + + Gets the array of 'attributes' configurations for the element + + + + + + Gets or sets whether a ElementValue with empty value should be included in the output + + + + + + Gets or sets the option to include all properties from the log event (as XML) + + + + + + Gets or sets whether to include the contents of the dictionary. + + + + + + Obsolete and replaced by with NLog v5. + + Gets or sets a value indicating whether to include contents of the dictionary. + + + + + + Obsolete and replaced by with NLog v5. + + Gets or sets a value indicating whether to include contents of the dictionary. + + + + + + Obsolete and replaced by with NLog v5. + + Gets or sets the option to include all properties from the log event (as XML) + + + + + + List of property names to exclude when is true + + + + + + XML element name to use when rendering properties + + + Support string-format where {0} means property-key-name + + Skips closing element tag when having configured + + + + + + XML attribute name to use when rendering property-key + + When null (or empty) then key-attribute is not included + + + Will replace newlines in attribute-value with + + + + + + XML attribute name to use when rendering property-value + + When null (or empty) then value-attribute is not included and + value is formatted as XML-element-value + + + Skips closing element tag when using attribute for value + + Will replace newlines in attribute-value with + + + + + + XML element name to use for rendering IList-collections items + + + + + + How far should the XML serializer follow object references before backing off + + + + + + + + + + + + + + + + + + write attribute, only if is not empty + + + + + rendered + + + + + + + A specialized layout that renders XML-formatted events. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The name of the top XML node + The value of the top XML node + + + + Name of the root XML element + + + Default value "logevent" + + + + + + Value inside the root XML element + + + + + + Determines whether or not this attribute will be Xml encoded. + + + + + + Extensions for NLog . + + + + + Renders the logevent into a result-value by using the provided layout + + Inside a , is preferred for performance reasons. + + The layout. + The logevent info. + Fallback value when no value available + Result value when available, else fallback to defaultValue + + + + A fluent builder for logging events to NLog. + + + + + Initializes a new instance of the class. + + The to send the log event. + + + + Initializes a new instance of the class. + + The to send the log event. + The log level. LogEvent is only created when is enabled for + + + + The logger to write the log event to + + + + + Logging event that will be written + + + + + Sets a per-event context property on the logging event. + + The name of the context property. + The value of the context property. + + + + Sets multiple per-event context properties on the logging event. + + The properties to set. + + + + Sets the information of the logging event. + + The exception information of the logging event. + + + + Sets the timestamp of the logging event. + + The timestamp of the logging event. + + + + Sets the log message on the logging event. + + A to be written. + + + + Sets the log message and parameters for formatting for the logging event. + + The type of the argument. + A containing one format item. + The argument to format. + + + + Sets the log message and parameters for formatting on the logging event. + + The type of the first argument. + The type of the second argument. + A containing format items. + The first argument to format. + The second argument to format. + + + + Sets the log message and parameters for formatting on the logging event. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + A containing format items. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Sets the log message and parameters for formatting on the logging event. + + A containing format items. + Arguments to format. + + + + Sets the log message and parameters for formatting on the logging event. + + An object that supplies culture-specific formatting information. + A containing format items. + Arguments to format. + + + + Writes the log event to the underlying logger. + + The class of the caller to the method. This is captured by the NLog engine when necessary + The method or property name of the caller to the method. This is set at by the compiler. + The full path of the source file that contains the caller. This is set at by the compiler. + The line number in the source file at which the method is called. This is set at by the compiler. + + + + Writes the log event to the underlying logger. + + The log level. Optional but when assigned to then it will discard the LogEvent. + The method or property name of the caller to the method. This is set at by the compiler. + The full path of the source file that contains the caller. This is set at by the compiler. + The line number in the source file at which the method is called. This is set at by the compiler. + + + + Writes the log event to the underlying logger. + + Type of custom Logger wrapper. + + + + Represents the logging event. + + + + + Gets the date of the first log event created. + + + + + The formatted log message. + + + + + The log message including any parameter placeholders + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Log level. + Override default Logger name. Default is used when null + Log message including parameter placeholders. + + + + Initializes a new instance of the class. + + Log level. + Override default Logger name. Default is used when null + Log message including parameter placeholders. + Already parsed message template parameters. + + + + Initializes a new instance of the class. + + Log level. + Override default Logger name. Default is used when null + Pre-formatted log message for ${message}. + Log message-template including parameter placeholders for ${message:raw=true}. + Already parsed message template parameters. + + + + Initializes a new instance of the class. + + Log level. + Override default Logger name. Default is used when null + Log message. + List of event-properties + + + + Initializes a new instance of the class. + + Log level. + Override default Logger name. Default is used when null + An IFormatProvider that supplies culture-specific formatting information. + Log message including parameter placeholders. + Parameter array. + + + + Initializes a new instance of the class. + + Log level. + Override default Logger name. Default is used when null + An IFormatProvider that supplies culture-specific formatting information. + Log message including parameter placeholders. + Parameter array. + Exception information. + + + + Gets the unique identifier of log event which is automatically generated + and monotonously increasing. + + + + + Gets or sets the timestamp of the logging event. + + + + + Gets or sets the level of the logging event. + + + + + Gets a value indicating whether stack trace has been set for this event. + + + + + Obsolete and replaced by or ${callsite} with NLog v5.3. + + Gets the stack frame of the method that did the logging. + + + + + Gets the number index of the stack frame that represents the user + code (not the NLog code). + + + + + Gets the entire stack trace. + + + + + Gets the callsite class name + + + + + Gets the callsite member function name + + + + + Gets the callsite source file path + + + + + Gets the callsite source file line number + + + + + Gets or sets the exception information. + + + + + Gets or sets the logger name. + + + + + Gets or sets the log message including any parameter placeholders. + + + + + Gets or sets the parameter values or null if no parameters have been specified. + + + + + Gets or sets the format provider that was provided while logging or + when no formatProvider was specified. + + + + + Gets or sets the message formatter for generating + Uses string.Format(...) when nothing else has been configured. + + + + + Gets the formatted message. + + + + + Checks if any per-event properties (Without allocation) + + + + + Gets the dictionary of per-event context properties. + + + + + Gets the dictionary of per-event context properties. + Internal helper for the PropertiesDictionary type. + + Create the event-properties dictionary, even if no initial template parameters + Provided when having parsed the message template and capture template parameters (else null) + + + + + Gets the named parameters extracted from parsing as MessageTemplate + + + + + Creates the null event. + + Null log event. + + + + Creates the log event. + + The log level. + Override default Logger name. Default is used when null + The message. + Instance of . + + + + Creates the log event. + + The log level. + Override default Logger name. Default is used when null + The format provider. + The message. + The parameters. + Instance of . + + + + Creates the log event. + + The log level. + Override default Logger name. Default is used when null + The format provider. + The message. + Instance of . + + + + Creates the log event. + + The log level. + Override default Logger name. Default is used when null + The exception. + The format provider. + The message. + Instance of . + + + + Creates the log event. + + The log level. + Override default Logger name. Default is used when null + The exception. + The format provider. + The message. + The parameters. + Instance of . + + + + Creates from this by attaching the specified asynchronous continuation. + + The asynchronous continuation. + Instance of with attached continuation. + + + + Returns a string representation of this log event. + + String representation of the log event. + + + + Sets the stack trace for the event info. + + The stack trace. + Index of the first user stack frame within the stack trace (Negative means NLog should skip stackframes from System-assemblies). + + + + Sets the details retrieved from the Caller Information Attributes + + + + + + + + + Specialized LogFactory that can return instances of custom logger types. + + Use this only when a custom Logger type is defined. + The type of the logger to be returned. Must inherit from . + + + + Gets the logger with type . + + The logger name. + An instance of . + + + + Gets a custom logger with the full name of the current class (so namespace and class name) and type . + + An instance of . + This is a slow-running method. + Make sure you're not doing this in a loop. + + + + Creates and manages instances of objects. + + + + + Internal for unit tests + + + + + Overwrite possible file paths (including filename) for possible NLog config files. + When this property is null, the default file paths ( are used. + + + + + Occurs when logging changes. Both when assigned to new config or config unloaded. + + + Note can be null when unloading configuration at shutdown. + + + + + Obsolete and replaced by with NLog v5.2. + Occurs when logging gets reloaded. + + + + + Initializes static members of the LogManager class. + + + + + Initializes a new instance of the class. + + + + + Obsolete instead use default-constructor, and assign with NLog 5.0. + + Initializes a new instance of the class. + + The config. + + + + Initializes a new instance of the class. + + The config loader + The custom AppEnvironmnet override + + + + Gets the current . + + + + + Gets or sets a value indicating whether exceptions should be thrown. See also . + + A value of true if exception should be thrown; otherwise, false. + By default exceptions are not thrown under any circumstances. + + + + Gets or sets a value indicating whether should be thrown. + + If null then is used. + + A value of true if exception should be thrown; otherwise, false. + + This option is for backwards-compatibility. + By default exceptions are not thrown under any circumstances. + + + + + Gets or sets a value indicating whether Variables should be kept on configuration reload. + + + + + Gets or sets a value indicating whether to automatically call + on AppDomain.Unload or AppDomain.ProcessExit + + + + + Gets or sets the current logging configuration. + + + Setter will re-configure all -objects, so no need to also call + + + + + Repository of interfaces used by NLog to allow override for dependency injection + + + + + Gets or sets the global log level threshold. Log events below this threshold are not logged. + + + + + Gets or sets the default culture info to use as . + + + Specific culture info or null to use + + + + + Performs application-defined tasks associated with freeing, releasing, or resetting + unmanaged resources. + + + + + Begins configuration of the LogFactory options using fluent interface + + + + + Begins configuration of the LogFactory options using fluent interface + + + + + Creates a logger that discards all log messages. + + Null logger instance. + + + + Gets the logger with the full name of the current class, so namespace and class name. + + The logger. + This method introduces performance hit, because of StackTrace capture. + Make sure you are not calling this method in a loop. + + + + Gets the logger with the full name of the current class, so namespace and class name. + Use to create instance of a custom . + If you haven't defined your own class, then use the overload without the type parameter. + + The logger with type . + Type of the logger + This method introduces performance hit, because of StackTrace capture. + Make sure you are not calling this method in a loop. + + + + Obsolete and replaced by with NLog v5.2. + Gets a custom logger with the full name of the current class, so namespace and class name. + Use to create instance of a custom . + If you haven't defined your own class, then use the overload without the loggerType. + + The type of the logger to create. The type must inherit from + The logger of type . + This method introduces performance hit, because of StackTrace capture. + Make sure you are not calling this method in a loop. + + + + Gets the specified named logger. + + Name of the logger. + The logger reference. Multiple calls to GetLogger with the same argument + are not guaranteed to return the same logger reference. + + + + Gets the specified named logger. + Use to create instance of a custom . + If you haven't defined your own class, then use the overload without the type parameter. + + Name of the logger. + Type of the logger + The logger reference with type . Multiple calls to GetLogger with the same argument + are not guaranteed to return the same logger reference. + + + + Obsolete and replaced by with NLog v5.2. + Gets the specified named logger. + Use to create instance of a custom . + If you haven't defined your own class, then use the overload without the loggerType. + + Name of the logger. + The type of the logger to create. The type must inherit from . + The logger of type . Multiple calls to GetLogger with the + same argument aren't guaranteed to return the same logger reference. + + + + Loops through all loggers previously returned by GetLogger and recalculates their + target and filter list. Useful after modifying the configuration programmatically + to ensure that all loggers have been properly configured. + + + + + Loops through all loggers previously returned by GetLogger and recalculates their + target and filter list. Useful after modifying the configuration programmatically + to ensure that all loggers have been properly configured. + + Purge garbage collected logger-items from the cache + + + + Flush any pending log messages (in case of asynchronous targets) with the default timeout of 15 seconds. + + + + + Flush any pending log messages (in case of asynchronous targets). + + Maximum time to allow for the flush. Any messages after that time + will be discarded. + + + + Flush any pending log messages (in case of asynchronous targets). + + Maximum time to allow for the flush. Any messages + after that time will be discarded. + + + + Flush any pending log messages (in case of asynchronous targets). + + The asynchronous continuation. + + + + Flush any pending log messages (in case of asynchronous targets). + + The asynchronous continuation. + Maximum time to allow for the flush. Any messages + after that time will be discarded. + + + + Flush any pending log messages (in case of asynchronous targets). + + The asynchronous continuation. + Maximum time to allow for the flush. Any messages after that time will be discarded. + + + + Suspends the logging, and returns object for using-scope so scope-exit calls + + + Logging is suspended when the number of calls are greater + than the number of calls. + + An object that implements IDisposable whose Dispose() method re-enables logging. + To be used with C# using () statement. + + + + Resumes logging if having called . + + + Logging is suspended when the number of calls are greater + than the number of calls. + + + + + Returns if logging is currently enabled. + + + Logging is suspended when the number of calls are greater + than the number of calls. + + A value of if logging is currently enabled, + otherwise. + + + + Raises the event when the configuration is reloaded. + + Event arguments. + + + + Obsolete and replaced by with NLog 5.2. + + Raises the event when the configuration is reloaded. + + Event arguments + + + + Change this method with NLog v6 to completely disconnect LogFactory from Targets/Layouts + - Remove LoggingRule-List-parameter + - Return ITargetWithFilterChain[] + + + + + Currently this is disposing? + + + + + Releases unmanaged and - optionally - managed resources. + + True to release both managed and unmanaged resources; + false to release only unmanaged resources. + + + + Dispose all targets, and shutdown logging. + + + + + Obsolete and replaced by and with NLog v5.2. + + Get file paths (including filename) for the possible NLog config files. + + The file paths to the possible config file + + + + Obsolete and replaced by and with NLog v5.2. + + Get file paths (including filename) for the possible NLog config files. + + The file paths to the possible config file + + + + Obsolete and replaced by and with NLog v5.2. + + Overwrite the candidates paths (including filename) for the possible NLog config files. + + The file paths to the possible config file + + + + Obsolete and replaced by and with NLog v5.2. + + Clear the candidate file paths and return to the defaults. + + + + + Obsolete and replaced by and with NLog v5.2. + + Loads logging configuration from file (Currently only XML configuration files supported) + + Configuration file to be read + LogFactory instance for fluent interface + + + + Logger cache key. + + + + + Serves as a hash function for a particular type. + + + + + Determines if two objects are equal in value. + + Other object to compare to. + True if objects are equal, false otherwise. + + + + Determines if two objects of the same type are equal in value. + + Other object to compare to. + True if objects are equal, false otherwise. + + + + Logger cache. + + + + + Inserts or updates. + + + + + + + Loops through all cached loggers and removes dangling loggers that have been garbage collected. + + + + + Internal for unit tests + + + + + Enables logging in implementation. + + + + + Initializes a new instance of the class. + + The factory. + + + + Enables logging. + + + + + Logging methods which only are executed when the DEBUG conditional compilation symbol is set. + + Remarks: + The DEBUG conditional compilation symbol is default enabled (only) in a debug build. + + If the DEBUG conditional compilation symbol isn't set in the calling library, the compiler will remove all the invocations to these methods. + This could lead to better performance. + + See: https://msdn.microsoft.com/en-us/library/4xssyw96%28v=vs.90%29.aspx + + + Provides logging interface and utility functions. + + + Auto-generated Logger members for binary compatibility with NLog 1.0. + + + Provides logging interface and utility functions. + + + + + Writes the diagnostic message at the Debug level using the specified format provider and format parameters. + + + Writes the diagnostic message at the Debug level. + Only executed when the DEBUG conditional compilation symbol is set. + Type of the value. + The value to be written. + + + + Writes the diagnostic message at the Debug level. + Only executed when the DEBUG conditional compilation symbol is set. + Type of the value. + An IFormatProvider that supplies culture-specific formatting information. + The value to be written. + + + + Writes the diagnostic message at the Debug level. + Only executed when the DEBUG conditional compilation symbol is set. + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message and exception at the Debug level. + Only executed when the DEBUG conditional compilation symbol is set. + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message and exception at the Debug level. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message at the Debug level using the specified parameters and formatting them with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Debug level. + Only executed when the DEBUG conditional compilation symbol is set. + Log message. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + Only executed when the DEBUG conditional compilation symbol is set. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Debug level using the specified parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + The type of the argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified parameter. + Only executed when the DEBUG conditional compilation symbol is set. + The type of the argument. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified arguments formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + The type of the first argument. + The type of the second argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + Only executed when the DEBUG conditional compilation symbol is set. + The type of the first argument. + The type of the second argument. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Debug level using the specified arguments formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + The type of the first argument. + The type of the second argument. + The type of the third argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + Only executed when the DEBUG conditional compilation symbol is set. + The type of the first argument. + The type of the second argument. + The type of the third argument. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Debug level. + Only executed when the DEBUG conditional compilation symbol is set. + A to be written. + + + + Writes the diagnostic message at the Debug level. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + Only executed when the DEBUG conditional compilation symbol is set. + A containing format items. + First argument to format. + Second argument to format. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + Only executed when the DEBUG conditional compilation symbol is set. + A containing format items. + First argument to format. + Second argument to format. + Third argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + Only executed when the DEBUG conditional compilation symbol is set. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + Only executed when the DEBUG conditional compilation symbol is set. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + Only executed when the DEBUG conditional compilation symbol is set. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + Only executed when the DEBUG conditional compilation symbol is set. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + Only executed when the DEBUG conditional compilation symbol is set. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + Only executed when the DEBUG conditional compilation symbol is set. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + Only executed when the DEBUG conditional compilation symbol is set. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + Only executed when the DEBUG conditional compilation symbol is set. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + Only executed when the DEBUG conditional compilation symbol is set. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + Only executed when the DEBUG conditional compilation symbol is set. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified format provider and format parameters. + + + Writes the diagnostic message at the Trace level. + Only executed when the DEBUG conditional compilation symbol is set. + Type of the value. + The value to be written. + + + + Writes the diagnostic message at the Trace level. + Only executed when the DEBUG conditional compilation symbol is set. + Type of the value. + An IFormatProvider that supplies culture-specific formatting information. + The value to be written. + + + + Writes the diagnostic message at the Trace level. + Only executed when the DEBUG conditional compilation symbol is set. + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message and exception at the Trace level. + Only executed when the DEBUG conditional compilation symbol is set. + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message and exception at the Trace level. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message at the Trace level using the specified parameters and formatting them with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Trace level. + Only executed when the DEBUG conditional compilation symbol is set. + Log message. + + + + Writes the diagnostic message at the Trace level using the specified parameters. + Only executed when the DEBUG conditional compilation symbol is set. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Trace level using the specified parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + The type of the argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified parameter. + Only executed when the DEBUG conditional compilation symbol is set. + The type of the argument. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified arguments formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + The type of the first argument. + The type of the second argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Trace level using the specified parameters. + Only executed when the DEBUG conditional compilation symbol is set. + The type of the first argument. + The type of the second argument. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Trace level using the specified arguments formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + The type of the first argument. + The type of the second argument. + The type of the third argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Trace level using the specified parameters. + Only executed when the DEBUG conditional compilation symbol is set. + The type of the first argument. + The type of the second argument. + The type of the third argument. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Trace level. + Only executed when the DEBUG conditional compilation symbol is set. + A to be written. + + + + Writes the diagnostic message at the Trace level. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + + + + Writes the diagnostic message at the Trace level using the specified parameters. + Only executed when the DEBUG conditional compilation symbol is set. + A containing format items. + First argument to format. + Second argument to format. + + + + Writes the diagnostic message at the Trace level using the specified parameters. + Only executed when the DEBUG conditional compilation symbol is set. + A containing format items. + First argument to format. + Second argument to format. + Third argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + Only executed when the DEBUG conditional compilation symbol is set. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + Only executed when the DEBUG conditional compilation symbol is set. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + Only executed when the DEBUG conditional compilation symbol is set. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + Only executed when the DEBUG conditional compilation symbol is set. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + Only executed when the DEBUG conditional compilation symbol is set. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + Only executed when the DEBUG conditional compilation symbol is set. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + Only executed when the DEBUG conditional compilation symbol is set. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + Only executed when the DEBUG conditional compilation symbol is set. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + Only executed when the DEBUG conditional compilation symbol is set. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + Only executed when the DEBUG conditional compilation symbol is set. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + Only executed when the DEBUG conditional compilation symbol is set. + A containing one format item. + The argument to format. + + + + Gets a value indicating whether logging is enabled for the Trace level. + + A value of if logging is enabled for the Trace level, otherwise it returns . + + + + Gets a value indicating whether logging is enabled for the Debug level. + + A value of if logging is enabled for the Debug level, otherwise it returns . + + + + Gets a value indicating whether logging is enabled for the Info level. + + A value of if logging is enabled for the Info level, otherwise it returns . + + + + Gets a value indicating whether logging is enabled for the Warn level. + + A value of if logging is enabled for the Warn level, otherwise it returns . + + + + Gets a value indicating whether logging is enabled for the Error level. + + A value of if logging is enabled for the Error level, otherwise it returns . + + + + Gets a value indicating whether logging is enabled for the Fatal level. + + A value of if logging is enabled for the Fatal level, otherwise it returns . + + + + Writes the diagnostic message at the Trace level using the specified format provider and format parameters. + + + Writes the diagnostic message at the Trace level. + + Type of the value. + The value to be written. + + + + Writes the diagnostic message at the Trace level. + + Type of the value. + An IFormatProvider that supplies culture-specific formatting information. + The value to be written. + + + + Writes the diagnostic message at the Trace level. + + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message at the Trace level using the specified parameters and formatting them with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Trace level. + + Log message. + + + + Writes the diagnostic message at the Trace level using the specified parameters. + + A containing format items. + Arguments to format. + + + + Writes the diagnostic message and exception at the Trace level. + + A to be written. + An exception to be logged. + + + + Writes the diagnostic message and exception at the Trace level. + + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message and exception at the Trace level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message at the Trace level using the specified parameter and formatting it with the supplied format provider. + + The type of the argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified parameter. + + The type of the argument. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Trace level using the specified parameters. + + The type of the first argument. + The type of the second argument. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Trace level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Trace level using the specified parameters. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Debug level using the specified format provider and format parameters. + + + Writes the diagnostic message at the Debug level. + + Type of the value. + The value to be written. + + + + Writes the diagnostic message at the Debug level. + + Type of the value. + An IFormatProvider that supplies culture-specific formatting information. + The value to be written. + + + + Writes the diagnostic message at the Debug level. + + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message at the Debug level using the specified parameters and formatting them with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Debug level. + + Log message. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + + A containing format items. + Arguments to format. + + + + Writes the diagnostic message and exception at the Debug level. + + A to be written. + An exception to be logged. + + + + Writes the diagnostic message and exception at the Debug level. + + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message and exception at the Debug level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message at the Debug level using the specified parameter and formatting it with the supplied format provider. + + The type of the argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified parameter. + + The type of the argument. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + + The type of the first argument. + The type of the second argument. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Debug level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Info level using the specified format provider and format parameters. + + + Writes the diagnostic message at the Info level. + + Type of the value. + The value to be written. + + + + Writes the diagnostic message at the Info level. + + Type of the value. + An IFormatProvider that supplies culture-specific formatting information. + The value to be written. + + + + Writes the diagnostic message at the Info level. + + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message at the Info level using the specified parameters and formatting them with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Info level. + + Log message. + + + + Writes the diagnostic message at the Info level using the specified parameters. + + A containing format items. + Arguments to format. + + + + Writes the diagnostic message and exception at the Info level. + + A to be written. + An exception to be logged. + + + + Writes the diagnostic message and exception at the Info level. + + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message and exception at the Info level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message at the Info level using the specified parameter and formatting it with the supplied format provider. + + The type of the argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified parameter. + + The type of the argument. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Info level using the specified parameters. + + The type of the first argument. + The type of the second argument. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Info level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Info level using the specified parameters. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Warn level using the specified format provider and format parameters. + + + Writes the diagnostic message at the Warn level. + + Type of the value. + The value to be written. + + + + Writes the diagnostic message at the Warn level. + + Type of the value. + An IFormatProvider that supplies culture-specific formatting information. + The value to be written. + + + + Writes the diagnostic message at the Warn level. + + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message at the Warn level using the specified parameters and formatting them with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Warn level. + + Log message. + + + + Writes the diagnostic message at the Warn level using the specified parameters. + + A containing format items. + Arguments to format. + + + + Writes the diagnostic message and exception at the Warn level. + + A to be written. + An exception to be logged. + + + + Writes the diagnostic message and exception at the Warn level. + + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message and exception at the Warn level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message at the Warn level using the specified parameter and formatting it with the supplied format provider. + + The type of the argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified parameter. + + The type of the argument. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Warn level using the specified parameters. + + The type of the first argument. + The type of the second argument. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Warn level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Warn level using the specified parameters. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Error level using the specified format provider and format parameters. + + + Writes the diagnostic message at the Error level. + + Type of the value. + The value to be written. + + + + Writes the diagnostic message at the Error level. + + Type of the value. + An IFormatProvider that supplies culture-specific formatting information. + The value to be written. + + + + Writes the diagnostic message at the Error level. + + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message at the Error level using the specified parameters and formatting them with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Error level. + + Log message. + + + + Writes the diagnostic message at the Error level using the specified parameters. + + A containing format items. + Arguments to format. + + + + Writes the diagnostic message and exception at the Error level. + + A to be written. + An exception to be logged. + + + + Writes the diagnostic message and exception at the Error level. + + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message and exception at the Error level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message at the Error level using the specified parameter and formatting it with the supplied format provider. + + The type of the argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified parameter. + + The type of the argument. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Error level using the specified parameters. + + The type of the first argument. + The type of the second argument. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Error level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Error level using the specified parameters. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified format provider and format parameters. + + + Writes the diagnostic message at the Fatal level. + + Type of the value. + The value to be written. + + + + Writes the diagnostic message at the Fatal level. + + Type of the value. + An IFormatProvider that supplies culture-specific formatting information. + The value to be written. + + + + Writes the diagnostic message at the Fatal level. + + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message at the Fatal level using the specified parameters and formatting them with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the Fatal level. + + Log message. + + + + Writes the diagnostic message at the Fatal level using the specified parameters. + + A containing format items. + Arguments to format. + + + + Writes the diagnostic message and exception at the Fatal level. + + A to be written. + An exception to be logged. + + + + Writes the diagnostic message and exception at the Fatal level. + + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message and exception at the Fatal level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + An exception to be logged. + Arguments to format. + + + + Writes the diagnostic message at the Fatal level using the specified parameter and formatting it with the supplied format provider. + + The type of the argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified parameter. + + The type of the argument. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified parameters. + + The type of the first argument. + The type of the second argument. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified parameters. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the specified level. + + The log level. + A to be written. + + + + Writes the diagnostic message at the specified level. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + + + + Writes the diagnostic message at the specified level using the specified parameters. + + The log level. + A containing format items. + First argument to format. + Second argument to format. + + + + Writes the diagnostic message at the specified level using the specified parameters. + + The log level. + A containing format items. + First argument to format. + Second argument to format. + Third argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified value as a parameter. + + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level. + + A to be written. + + + + Writes the diagnostic message at the Trace level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + + + + Writes the diagnostic message at the Trace level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + + + + Writes the diagnostic message at the Trace level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + Third argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Trace level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level. + + A to be written. + + + + Writes the diagnostic message at the Debug level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + + + + Writes the diagnostic message at the Debug level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + Third argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Debug level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level. + + A to be written. + + + + Writes the diagnostic message at the Info level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + + + + Writes the diagnostic message at the Info level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + + + + Writes the diagnostic message at the Info level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + Third argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Info level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level. + + A to be written. + + + + Writes the diagnostic message at the Warn level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + + + + Writes the diagnostic message at the Warn level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + + + + Writes the diagnostic message at the Warn level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + Third argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Warn level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level. + + A to be written. + + + + Writes the diagnostic message at the Error level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + + + + Writes the diagnostic message at the Error level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + + + + Writes the diagnostic message at the Error level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + Third argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Error level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level. + + A to be written. + + + + Writes the diagnostic message at the Fatal level. + + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + + + + Writes the diagnostic message at the Fatal level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified parameters. + + A containing format items. + First argument to format. + Second argument to format. + Third argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. + + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the Fatal level using the specified value as a parameter. + + A containing one format item. + The argument to format. + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Occurs when logger configuration changes. + + + + + Gets the name of the logger. + + + + + Gets the factory that created this logger. + + + + + Collection of context properties for the Logger. The logger will append it for all log events + + + It is recommended to use for modifying context properties + when same named logger is used at multiple locations or shared by different thread contexts. + + + + + Gets a value indicating whether logging is enabled for the specified level. + + Log level to be checked. + A value of if logging is enabled for the specified level, otherwise it returns . + + + + Creates new logger that automatically appends the specified property to all log events (without changing current logger) + + With property, all properties can be enumerated. + + Property Name + Property Value + New Logger object that automatically appends specified property + + + + Creates new logger that automatically appends the specified properties to all log events (without changing current logger) + + With property, all properties can be enumerated. + + Collection of key-value pair properties + New Logger object that automatically appends specified properties + + + + Obsolete and replaced by that prevents unexpected side-effects in Logger-state. + + Updates the specified context property for the current logger. The logger will append it for all log events. + + With property, all properties can be enumerated (or updated). + + + It is highly recommended to ONLY use for modifying context properties. + This method will affect all locations/contexts that makes use of the same named logger object. And can cause + unexpected surprises at multiple locations and other thread contexts. + + Property Name + Property Value + + + + Updates the with provided property + + Name of property + Value of property + A disposable object that removes the properties from logical context scope on dispose. + property-dictionary-keys are case-insensitive + + + + Updates the with provided property + + Name of property + Value of property + A disposable object that removes the properties from logical context scope on dispose. + property-dictionary-keys are case-insensitive + + + + Updates the with provided properties + + Properties being added to the scope dictionary + A disposable object that removes the properties from logical context scope on dispose. + property-dictionary-keys are case-insensitive + + + + Updates the with provided properties + + Properties being added to the scope dictionary + A disposable object that removes the properties from logical context scope on dispose. + property-dictionary-keys are case-insensitive + + + + Pushes new state on the logical context scope stack + + Value to added to the scope stack + A disposable object that pops the nested scope state on dispose. + + + + Pushes new state on the logical context scope stack + + Value to added to the scope stack + A disposable object that pops the nested scope state on dispose. + + + + Writes the specified diagnostic message. + + Log event. + + + + Writes the specified diagnostic message. + + Type of custom Logger wrapper. + Log event. + + + + Writes the diagnostic message at the specified level using the specified format provider and format parameters. + + + Writes the diagnostic message at the specified level. + + Type of the value. + The log level. + The value to be written. + + + + Writes the diagnostic message at the specified level. + + Type of the value. + The log level. + An IFormatProvider that supplies culture-specific formatting information. + The value to be written. + + + + Writes the diagnostic message at the specified level. + + The log level. + A function returning message to be written. Function is not evaluated if logging is not enabled. + + + + Writes the diagnostic message at the specified level using the specified parameters and formatting them with the supplied format provider. + + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message at the specified level. + + The log level. + Log message. + + + + Writes the diagnostic message at the specified level using the specified parameters. + + The log level. + A containing format items. + Arguments to format. + + + + Writes the diagnostic message and exception at the specified level. + + The log level. + An exception to be logged. + A to be written. + Arguments to format. + + + + Writes the diagnostic message and exception at the specified level. + + The log level. + An exception to be logged. + An IFormatProvider that supplies culture-specific formatting information. + A to be written. + Arguments to format. + + + + Writes the diagnostic message at the specified level using the specified parameter and formatting it with the supplied format provider. + + The type of the argument. + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified parameter. + + The type of the argument. + The log level. + A containing one format item. + The argument to format. + + + + Writes the diagnostic message at the specified level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the specified level using the specified parameters. + + The type of the first argument. + The type of the second argument. + The log level. + A containing one format item. + The first argument to format. + The second argument to format. + + + + Writes the diagnostic message at the specified level using the specified arguments formatting it with the supplied format provider. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + The log level. + An IFormatProvider that supplies culture-specific formatting information. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Writes the diagnostic message at the specified level using the specified parameters. + + The type of the first argument. + The type of the second argument. + The type of the third argument. + The log level. + A containing one format item. + The first argument to format. + The second argument to format. + The third argument to format. + + + + Runs the provided action. If the action throws, the exception is logged at Error level. The exception is not propagated outside of this method. + + Action to execute. + + + + Runs the provided function and returns its result. If an exception is thrown, it is logged at Error level. + The exception is not propagated outside of this method; a default value is returned instead. + + Return type of the provided function. + Function to run. + Result returned by the provided function or the default value of type in case of exception. + + + + Runs the provided function and returns its result. If an exception is thrown, it is logged at Error level. + The exception is not propagated outside of this method; a fallback value is returned instead. + + Return type of the provided function. + Function to run. + Fallback value to return in case of exception. + Result returned by the provided function or fallback value in case of exception. + + + + Logs an exception is logged at Error level if the provided task does not run to completion. + + The task for which to log an error if it does not run to completion. + This method is useful in fire-and-forget situations, where application logic does not depend on completion of task. This method is avoids C# warning CS4014 in such situations. + + + + Returns a task that completes when a specified task to completes. If the task does not run to completion, an exception is logged at Error level. The returned task always runs to completion. + + The task for which to log an error if it does not run to completion. + A task that completes in the state when completes. + + + + Runs async action. If the action throws, the exception is logged at Error level. The exception is not propagated outside of this method. + + Async action to execute. + + + + Runs the provided async function and returns its result. If the task does not run to completion, an exception is logged at Error level. + The exception is not propagated outside of this method; a default value is returned instead. + + Return type of the provided function. + Async function to run. + A task that represents the completion of the supplied task. If the supplied task ends in the state, the result of the new task will be the result of the supplied task; otherwise, the result of the new task will be the default value of type . + + + + Runs the provided async function and returns its result. If the task does not run to completion, an exception is logged at Error level. + The exception is not propagated outside of this method; a fallback value is returned instead. + + Return type of the provided function. + Async function to run. + Fallback value to return if the task does not end in the state. + A task that represents the completion of the supplied task. If the supplied task ends in the state, the result of the new task will be the result of the supplied task; otherwise, the result of the new task will be the fallback value. + + + + Raises the event when the logger is reconfigured. + + Event arguments + + + + Implementation of logging engine. + + + + + Gets the filter result. + + The filter chain. + The log event. + default result if there are no filters, or none of the filters decides. + The result of the filter. + + + + Defines available log levels. + + + Log levels ordered by severity:
+ - (Ordinal = 0) : Most verbose level. Used for development and seldom enabled in production.
+ - (Ordinal = 1) : Debugging the application behavior from internal events of interest.
+ - (Ordinal = 2) : Information that highlights progress or application lifetime events.
+ - (Ordinal = 3) : Warnings about validation issues or temporary failures that can be recovered.
+ - (Ordinal = 4) : Errors where functionality has failed or have been caught.
+ - (Ordinal = 5) : Most critical level. Application is about to abort.
+ + + + + Trace log level (Ordinal = 0) + + + Most verbose level. Used for development and seldom enabled in production. + + + + + Debug log level (Ordinal = 1) + + + Debugging the application behavior from internal events of interest. + + + + + Info log level (Ordinal = 2) + + + Information that highlights progress or application lifetime events. + + + + + Warn log level (Ordinal = 3) + + + Warnings about validation issues or temporary failures that can be recovered. + + + + + Error log level (Ordinal = 4) + + + Errors where functionality has failed or have been caught. + + + + + Fatal log level (Ordinal = 5) + + + Most critical level. Application is about to abort. + + + + + Off log level (Ordinal = 6) + + + + + Gets all the available log levels (Trace, Debug, Info, Warn, Error, Fatal, Off). + + + + + Gets all the log levels that can be used to log events (Trace, Debug, Info, Warn, Error, Fatal) + i.e LogLevel.Off is excluded. + + + + + Initializes a new instance of . + + The log level name. + The log level ordinal number. + + + + Gets the name of the log level. + + + + + Gets the ordinal of the log level. + + + + + Compares two objects + and returns a value indicating whether + the first one is equal to the second one. + + The first level. + The second level. + The value of level1.Ordinal == level2.Ordinal. + + + + Compares two objects + and returns a value indicating whether + the first one is not equal to the second one. + + The first level. + The second level. + The value of level1.Ordinal != level2.Ordinal. + + + + Compares two objects + and returns a value indicating whether + the first one is greater than the second one. + + The first level. + The second level. + The value of level1.Ordinal > level2.Ordinal. + + + + Compares two objects + and returns a value indicating whether + the first one is greater than or equal to the second one. + + The first level. + The second level. + The value of level1.Ordinal >= level2.Ordinal. + + + + Compares two objects + and returns a value indicating whether + the first one is less than the second one. + + The first level. + The second level. + The value of level1.Ordinal < level2.Ordinal. + + + + Compares two objects + and returns a value indicating whether + the first one is less than or equal to the second one. + + The first level. + The second level. + The value of level1.Ordinal <= level2.Ordinal. + + + + Gets the that corresponds to the specified ordinal. + + The ordinal. + The instance. For 0 it returns , 1 gives and so on. + + + + Returns the that corresponds to the supplied . + + The textual representation of the log level. + The enumeration value. + + + + Returns a string representation of the log level. + + Log level name. + + + + + + + + + + Determines whether the specified instance is equal to this instance. + + The to compare with this instance. + Value of true if the specified is equal to + this instance; otherwise, false. + + + + Compares the level to the other object. + + The other object. + + A value less than zero when this logger's is + less than the other logger's ordinal, 0 when they are equal and + greater than zero when this ordinal is greater than the + other ordinal. + + + + + Compares the level to the other object. + + The other object. + + A value less than zero when this logger's is + less than the other logger's ordinal, 0 when they are equal and + greater than zero when this ordinal is greater than the + other ordinal. + + + + + Creates and manages instances of objects. + + + LogManager wraps a singleton instance of . + + + + + Gets the instance used in the . + + Could be used to pass the to other methods + + + + Occurs when logging changes. Both when assigned to new config or config unloaded. + + + Note can be null when unloading configuration at shutdown. + + + + + Obsolete and replaced by with NLog v5.2. + Occurs when logging gets reloaded. + + + + + Gets or sets a value indicating whether NLog should throw exceptions. + By default exceptions are not thrown under any circumstances. + + + + + Gets or sets a value indicating whether should be thrown. + + A value of true if exception should be thrown; otherwise, false. + + This option is for backwards-compatibility. + By default exceptions are not thrown under any circumstances. + + + + + + Gets or sets a value indicating whether Variables should be kept on configuration reload. + + + + + Gets or sets a value indicating whether to automatically call + on AppDomain.Unload or AppDomain.ProcessExit + + + + + Gets or sets the current logging configuration. + + + Setter will re-configure all -objects, so no need to also call + + + + + Gets or sets the global log threshold. Log events below this threshold are not logged. + + + + + Begins configuration of the LogFactory options using fluent interface + + + + + Begins configuration of the LogFactory options using fluent interface + + + + + Obsolete and replaced by and with NLog v5.2. + Loads logging configuration from file (Only XML configuration files supported) + + Configuration file to be read + LogFactory instance for fluent interface + + + + Adds the given assembly which will be skipped + when NLog is trying to find the calling method on stack trace. + + The assembly to skip. + + + + Gets the logger with the full name of the current class, so namespace and class name. + + The logger. + This method introduces performance hit, because of StackTrace capture. + Make sure you are not calling this method in a loop. + + + + Obsolete and replaced by with NLog v5.2. + Gets a custom logger with the full name of the current class, so namespace and class name. + Use to create instance of a custom . + If you haven't defined your own class, then use the overload without the loggerType. + + The type of the logger to create. The type must inherit from + The logger of type . + This method introduces performance hit, because of StackTrace capture. + Make sure you are not calling this method in a loop. + + + + Creates a logger that discards all log messages. + + Null logger which discards all log messages. + + + + Gets the specified named logger. + + Name of the logger. + The logger reference. Multiple calls to GetLogger with the same argument aren't guaranteed to return the same logger reference. + + + + Obsolete and replaced by with NLog v5.2. + Gets the specified named custom using the parameter for creating instance. + If you haven't defined your own class, then use the overload without the loggerType. + + Name of the logger. + The logger class. This class must inherit from . + The logger of type . Multiple calls to GetLogger with the same argument aren't guaranteed to return the same logger reference. + The generic way for this method is + + + + Loops through all loggers previously returned by GetLogger. + and recalculates their target and filter list. Useful after modifying the configuration programmatically + to ensure that all loggers have been properly configured. + + + + + Loops through all loggers previously returned by GetLogger. + and recalculates their target and filter list. Useful after modifying the configuration programmatically + to ensure that all loggers have been properly configured. + + Purge garbage collected logger-items from the cache + + + + Flush any pending log messages (in case of asynchronous targets) with the default timeout of 15 seconds. + + + + + Flush any pending log messages (in case of asynchronous targets). + + Maximum time to allow for the flush. Any messages after that time will be discarded. + + + + Flush any pending log messages (in case of asynchronous targets). + + Maximum time to allow for the flush. Any messages after that time will be discarded. + + + + Flush any pending log messages (in case of asynchronous targets). + + The asynchronous continuation. + + + + Flush any pending log messages (in case of asynchronous targets). + + The asynchronous continuation. + Maximum time to allow for the flush. Any messages after that time will be discarded. + + + + Flush any pending log messages (in case of asynchronous targets). + + The asynchronous continuation. + Maximum time to allow for the flush. Any messages after that time will be discarded. + + + + Obsolete and replaced by by with NLog v5. + Suspends the logging, and returns object for using-scope so scope-exit calls + + + Logging is suspended when the number of calls are greater + than the number of calls. + + An object that implements IDisposable whose Dispose() method re-enables logging. + To be used with C# using () statement. + + + + Obsolete and replaced by disposing the scope returned from with NLog v5. + Resumes logging if having called . + + + Logging is suspended when the number of calls are greater + than the number of calls. + + + + + Suspends the logging, and returns object for using-scope so scope-exit calls + + + Logging is suspended when the number of calls are greater + than the number of calls. + + An object that implements IDisposable whose Dispose() method re-enables logging. + To be used with C# using () statement. + + + + Resumes logging if having called . + + + Logging is suspended when the number of calls are greater + than the number of calls. + + + + + Returns if logging is currently enabled. + + + Logging is suspended when the number of calls are greater + than the number of calls. + + A value of if logging is currently enabled, + otherwise. + + + + Dispose all targets, and shutdown logging. + + + + + Generates a formatted message from the log event + + Log event. + Formatted message + + + + Returns a log message. Used to defer calculation of + the log message until it's actually needed. + + Log message. + + + + The type of the captured hole + + + + + Not decided + + + + + normal {x} + + + + + Serialize operator {@x} (aka destructure) + + + + + stringification operator {$x} + + + + + A hole that will be replaced with a value + + + + + Constructor + + + + Parameter name sent to structured loggers. + This is everything between "{" and the first of ",:}". + Including surrounding spaces and names that are numbers. + + + Format to render the parameter. + This is everything between ":" and the first unescaped "}" + + + + Type + + + + When the template is positional, this is the parsed name of this parameter. + For named templates, the value of Index is undefined. + + + Alignment to render the parameter, by default 0. + This is the parsed value between "," and the first of ":}" + + + + A fixed value + + + + Number of characters from the original template to copy at the current position. + This can be 0 when the template starts with a hole or when there are multiple consecutive holes. + + + Number of characters to skip in the original template at the current position. + 0 is a special value that mean: 1 escaped char, no hole. It can also happen last when the template ends with a literal. + + + + Combines Literal and Hole + + + + Literal + + + Hole + Uninitialized when = 0. + + + + Description of a single parameter extracted from a MessageTemplate + + + + + Parameter Name extracted from + This is everything between "{" and the first of ",:}". + + + + + Parameter Value extracted from the -array + + + + + Format to render the parameter. + This is everything between ":" and the first unescaped "}" + + + + + Parameter method that should be used to render the parameter + See also + + + + + Returns index for , when + + + + + Constructs a single message template parameter + + Parameter Name + Parameter Value + Parameter Format + + + + Constructs a single message template parameter + + Parameter Name + Parameter Value + Parameter Format + Parameter CaptureType + + + + Parameters extracted from parsing as MessageTemplate + + + + + + + + + + + Gets the parameters at the given index + + + + + Number of parameters + + + + Indicates whether the template should be interpreted as positional + (all holes are numbers) or named. + + + + Indicates whether the template was parsed successful, and there are no unmatched parameters + + + + + Constructor for parsing the message template with parameters + + including any parameter placeholders + All + + + + Constructor for named parameters that already has been parsed + + + + + Create MessageTemplateParameter from + + + + + Parse templates. + + + + + Parse a template. + + Template to be parsed. + When is null. + Template, never null + + + + Gets the current literal/hole in the template + + + + + Clears the enumerator + + + + + Restarts the enumerator of the template + + + + + Moves to the next literal/hole in the template + + Found new element [true/false] + + + + Parse format after hole name/index. Handle the escaped { and } in the format. Don't read the last } + + + + + + Error when parsing a template. + + + + + Current index when the error occurred. + + + + + The template we were parsing + + + + + New exception + + The message to be shown. + Current index when the error occurred. + + + + + Convert, Render or serialize a value, with optionally backwards-compatible with + + + + + Serialization of an object, e.g. JSON and append to + + The object to serialize to string. + Parameter Format + Parameter CaptureType + An object that supplies culture-specific formatting information. + Output destination. + Serialize succeeded (true/false) + + + + Format an object to a readable string, or if it's an object, serialize + + The value to convert + + + + + + + + Try serializing a scalar (string, int, NULL) or simple type (IFormattable) + + + + + Serialize Dictionary as JSON like structure, without { and } + + + "FirstOrder"=true, "Previous login"=20-12-2017 14:55:32, "number of tries"=1 + + + format string of an item + + + + + + + + + Convert a value to a string with format and append to . + + The value to convert. + Format sting for the value. + Format provider for the value. + Append to this + + + + Exception thrown during NLog configuration. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The message. + + + + Obsolete and replaced by using normal string-interpolation with in NLog v5. + Initializes a new instance of the class. + + The message. + Parameters for the message + + + + Obsolete and replaced by using normal string-interpolation with in NLog v5. + Initializes a new instance of the class. + + The inner exception. + The message. + Parameters for the message + + + + Initializes a new instance of the class. + + The message. + The inner exception. + + + + 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). + + + + + Exception thrown during log event processing. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The message. + + + + Obsolete and replaced by using normal string-interpolation with in NLog v5. + Initializes a new instance of the class. + + The message. + Parameters for the message + + + + Initializes a new instance of the class. + + The message. + The inner exception. + + + + 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). + + + + + TraceListener which routes all messages through NLog. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Initializes a new instance of the class. + + + + + Gets or sets the log factory to use when outputting messages (null - use LogManager). + + + + + Gets or sets the default log level. + + + + + Gets or sets the log which should be always used regardless of source level. + + + + + Gets or sets a value indicating whether flush calls from trace sources should be ignored. + + + + + Gets a value indicating whether the trace listener is thread safe. + + + true if the trace listener is thread safe; otherwise, false. The default is false. + + + + Gets or sets a value indicating whether to use auto logger name detected from the stack trace. + + + + + When overridden in a derived class, writes the specified message to the listener you create in the derived class. + + A message to write. + + + + When overridden in a derived class, writes the specified message to the listener you create in the derived class. + + A message payload to write. + + + + When overridden in a derived class, writes a message to the listener you create in the derived class, followed by a line terminator. + + A message to write. + + + + When overridden in a derived class, writes the specified message to the listener you create in the derived class. + + A message payload to write. + + + + When overridden in a derived class, closes the output stream so it no longer receives tracing or debugging output. + + + + + Emits an error message. + + A message to emit. + + + + Emits an error message and a detailed error message. + + A message to emit. + A detailed message to emit. + + + + Flushes the output (if is not true) buffer with the default timeout of 15 seconds. + + + + + Writes trace information, a data object and event information to the listener specific output. + + A object that contains the current process ID, thread ID, and stack trace information. + A name used to identify the output, typically the name of the application that generated the trace event. + One of the values specifying the type of event that has caused the trace. + A numeric identifier for the event. + The trace data to emit. + + + + Writes trace information, an array of data objects and event information to the listener specific output. + + A object that contains the current process ID, thread ID, and stack trace information. + A name used to identify the output, typically the name of the application that generated the trace event. + One of the values specifying the type of event that has caused the trace. + A numeric identifier for the event. + An array of objects to emit as data. + + + + Writes trace and event information to the listener specific output. + + A object that contains the current process ID, thread ID, and stack trace information. + A name used to identify the output, typically the name of the application that generated the trace event. + One of the values specifying the type of event that has caused the trace. + A numeric identifier for the event. + + + + Writes trace information, a formatted array of objects and event information to the listener specific output. + + A object that contains the current process ID, thread ID, and stack trace information. + A name used to identify the output, typically the name of the application that generated the trace event. + One of the values specifying the type of event that has caused the trace. + A numeric identifier for the event. + A format string that contains zero or more format items, which correspond to objects in the array. + An object array containing zero or more objects to format. + + + + Writes trace information, a message, and event information to the listener specific output. + + A object that contains the current process ID, thread ID, and stack trace information. + A name used to identify the output, typically the name of the application that generated the trace event. + One of the values specifying the type of event that has caused the trace. + A numeric identifier for the event. + A message to write. + + + + Writes trace information, a message, a related activity identity and event information to the listener specific output. + + A object that contains the current process ID, thread ID, and stack trace information. + A name used to identify the output, typically the name of the application that generated the trace event. + A numeric identifier for the event. + A message to write. + A object identifying a related activity. + + + + Gets the custom attributes supported by the trace listener. + + + A string array naming the custom attributes supported by the trace listener, or null if there are no custom attributes. + + + + + Translates the event type to level from . + + Type of the event. + Translated log level. + + + + Process the log event + The log level. + The name of the logger. + The log message. + The log parameters. + The event id. + The event type. + The related activity id. + + + + + It works as a normal but it discards all messages which an application requests + to be logged. + + It effectively implements the "Null Object" pattern for objects. + + + + + Initializes a new instance of . + + The factory class to be used for the creation of this logger. + + + + Extension methods to setup LogFactory options + + + + + Gets the logger with the full name of the current class, so namespace and class name. + + + + + Gets the specified named logger. + + + + + Configures general options for NLog LogFactory before loading NLog config + + + + + Configures loading of NLog extensions for Targets and LayoutRenderers + + + + + Configures the output of NLog for diagnostics / troubleshooting + + + + + Configures serialization and transformation of LogEvents + + + + + Loads NLog config created by the method + + + + + Loads NLog config provided in + + + + + Loads NLog config from filename if provided, else fallback to scanning for NLog.config + + Fluent interface parameter. + Explicit configuration file to be read (Default NLog.config from candidates paths) + Whether to allow application to run when NLog config is not available + + + + Loads NLog config from file-paths if provided, else fallback to scanning for NLog.config + + Fluent interface parameter. + Candidates file paths (including filename) where to scan for NLog config files + Whether to allow application to run when NLog config is not available + + + + Loads NLog config from XML in + + + + + Loads NLog config located in embedded resource from main application assembly. + + Fluent interface parameter. + Assembly for the main Application project with embedded resource + Name of the manifest resource for NLog config XML + + + + Reloads the current logging configuration and activates it + + Logevents produced during the configuration-reload can become lost, as targets are unavailable while closing and initializing. + + + + Extension methods to setup NLog extensions, so they are known when loading NLog LoggingConfiguration + + + + + Enable/disables autoloading of NLog extensions by scanning and loading available assemblies + + + Disabled by default as it can give a huge performance hit during startup. Recommended to keep it disabled especially when running in the cloud. + + + + + Enable/disables autoloading of NLog extensions by scanning and loading available assemblies + + + Disabled by default as it can give a huge performance hit during startup. Recommended to keep it disabled especially when running in the cloud. + + + + + Registers NLog extensions from the assembly. + + + + + Registers NLog extensions from the assembly type name + + + + + Register a custom NLog Configuration Type. + + Type of the NLog configuration item + Fluent interface parameter. + + + + Register a custom NLog Target. + + Type of the Target. + Fluent interface parameter. + The target type-alias for use in NLog configuration. Will extract from class-attribute when unassigned. + + + + Register a custom NLog Target. + + Type of the Target. + Fluent interface parameter. + The factory method for creating instance of NLog Target + The target type-alias for use in NLog configuration. Will extract from class-attribute when unassigned. + + + + Register a custom NLog Target. + + Fluent interface parameter. + Type name of the Target + The target type-alias for use in NLog configuration + + + + Register a custom NLog Layout. + + Type of the layout renderer. + Fluent interface parameter. + The layout type-alias for use in NLog configuration. Will extract from class-attribute when unassigned. + + + + Register a custom NLog Layout. + + Type of the layout renderer. + Fluent interface parameter. + The factory method for creating instance of NLog Layout + The layout type-alias for use in NLog configuration. Will extract from class-attribute when unassigned. + + + + Register a custom NLog Layout. + + Fluent interface parameter. + Type of the layout. + The layout type-alias for use in NLog configuration + + + + Register a custom NLog LayoutRenderer. + + Type of the layout renderer. + Fluent interface parameter. + The layout-renderer type-alias for use in NLog configuration - without '${ }'. Will extract from class-attribute when unassigned. + + + + Register a custom NLog LayoutRenderer. + + Type of the layout renderer. + Fluent interface parameter. + The factory method for creating instance of NLog LayoutRenderer + The layout-renderer type-alias for use in NLog configuration - without '${ }'. Will extract from class-attribute when unassigned. + + + + Register a custom NLog LayoutRenderer. + + Fluent interface parameter. + Type of the layout renderer. + The layout-renderer type-alias for use in NLog configuration - without '${ }' + + + + Register a custom NLog LayoutRenderer with a callback function . The callback receives the logEvent. + + Fluent interface parameter. + The layout-renderer type-alias for use in NLog configuration - without '${ }' + Callback that returns the value for the layout renderer. + + + + Register a custom NLog LayoutRenderer with a callback function . The callback receives the logEvent and the current configuration. + + Fluent interface parameter. + The layout-renderer type-alias for use in NLog configuration - without '${ }' + Callback that returns the value for the layout renderer. + + + + Register a custom NLog LayoutRenderer with a callback function . The callback receives the logEvent. + + Fluent interface parameter. + The layout-renderer type-alias for use in NLog configuration - without '${ }' + Callback that returns the value for the layout renderer. + Options of the layout renderer. + + + + Register a custom NLog LayoutRenderer with a callback function . The callback receives the logEvent and the current configuration. + + Fluent interface parameter. + The layout-renderer type-alias for use in NLog configuration - without '${ }' + Callback that returns the value for the layout renderer. + Options of the layout renderer. + + + + Register a custom NLog LayoutRenderer with a callback function + + Fluent interface parameter. + LayoutRenderer instance with type-alias and callback-method. + + + + Register a custom condition method, that can use in condition filters + + Fluent interface parameter. + Name of the condition filter method + MethodInfo extracted by reflection - typeof(MyClass).GetMethod("MyFunc", BindingFlags.Static). + + + + Register a custom condition method, that can use in condition filters + + Fluent interface parameter. + Name of the condition filter method + Lambda method. + + + + Register a custom condition method, that can use in condition filters + + Fluent interface parameter. + Name of the condition filter method + Lambda method. + + + + Register (or replaces) singleton-object for the specified service-type + + Service interface type + Fluent interface parameter. + Implementation of interface. + + + + Register (or replaces) singleton-object for the specified service-type + + Fluent interface parameter. + Service interface type. + Implementation of interface. + + + + Register (or replaces) external service-repository for resolving dependency injection + + Fluent interface parameter. + External dependency injection repository + + + + Extension methods to setup NLog options + + + + + Configures + + + + + Configures + + + + + Configures + + + + + Configures + + + + + Configures + + + + + Configures + + + + + Configures + + + + + Configures + + + + + Configures + + + + + Configure the InternalLogger properties from Environment-variables and App.config using + + + Recognizes the following environment-variables: + + - NLOG_INTERNAL_LOG_LEVEL + - NLOG_INTERNAL_LOG_FILE + - NLOG_INTERNAL_LOG_TO_CONSOLE + - NLOG_INTERNAL_LOG_TO_CONSOLE_ERROR + - NLOG_INTERNAL_LOG_TO_TRACE + - NLOG_INTERNAL_INCLUDE_TIMESTAMP + + Legacy .NetFramework platform will also recognizes the following app.config settings: + + - nlog.internalLogLevel + - nlog.internalLogFile + - nlog.internalLogToConsole + - nlog.internalLogToConsoleError + - nlog.internalLogToTrace + - nlog.internalLogIncludeTimestamp + + + + + Extension methods to setup NLog + + + + + Configures the global time-source used for all logevents + + + Available by default: , , , + + + + + Updates the dictionary ${gdc:item=} with the name-value-pair + + + + + Defines for redirecting output from matching to wanted targets. + + Fluent interface parameter. + Logger name pattern to check which names matches this rule + Rule identifier to allow rule lookup + + + + Defines for redirecting output from matching to wanted targets. + + Fluent interface parameter. + Restrict minimum LogLevel for names that matches this rule + Logger name pattern to check which names matches this rule + Rule identifier to allow rule lookup + + + + Defines for redirecting output from matching to wanted targets. + + Fluent interface parameter. + Override the name for the target created + + + + Apply fast filtering based on . Include LogEvents with same or worse severity as . + + Fluent interface parameter. + Minimum level that this rule matches + + + + Apply fast filtering based on . Include LogEvents with same or less severity as . + + Fluent interface parameter. + Maximum level that this rule matches + + + + Apply fast filtering based on . Include LogEvents with severity that equals . + + Fluent interface parameter. + Single loglevel that this rule matches + + + + Apply fast filtering based on . Include LogEvents with severity between and . + + Fluent interface parameter. + Minimum level that this rule matches + Maximum level that this rule matches + + + + Apply dynamic filtering logic for advanced control of when to redirect output to target. + + + Slower than using Logger-name or LogLevel-severity, because of allocation. + + Fluent interface parameter. + Filter for controlling whether to write + Default action if none of the filters match + + + + Apply dynamic filtering logic for advanced control of when to redirect output to target. + + + Slower than using Logger-name or LogLevel-severity, because of allocation. + + Fluent interface parameter. + Delegate for controlling whether to write + Default action if none of the filters match + + + + Dynamic filtering of LogEvent, where it will be ignored when matching filter-method-delegate + + + Slower than using Logger-name or LogLevel-severity, because of allocation. + + Fluent interface parameter. + Delegate for controlling whether to write + LogEvent will on match also be ignored by following logging-rules + + + + Dynamic filtering of LogEvent, where it will be logged when matching filter-method-delegate + + + Slower than using Logger-name or LogLevel-severity, because of allocation. + + Fluent interface parameter. + Delegate for controlling whether to write + LogEvent will not be evaluated by following logging-rules + + + + Move the to the top, to match before any of the existing + + + + + Redirect output from matching to the provided + + Fluent interface parameter. + Target that should be written to. + Fluent interface for configuring targets for the new LoggingRule. + + + + Redirect output from matching to the provided + + Fluent interface parameter. + Target-collection that should be written to. + Fluent interface for configuring targets for the new LoggingRule. + + + + Redirect output from matching to the provided + + Fluent interface parameter. + Target-collection that should be written to. + Fluent interface for configuring targets for the new LoggingRule. + + + + Discard output from matching , so it will not reach any following . + + Fluent interface parameter. + Only discard output from matching Logger when below minimum LogLevel + + + + Returns first target registered + + + + + Returns first target registered with the specified type + + Type of target + + + + Write to + + Fluent interface parameter. + Method to call on logevent + Layouts to render object[]-args before calling + + + + Write to + + Fluent interface parameter. + Override the default Layout for output + Override the default Encoding for output (Ex. UTF8) + Write to stderr instead of standard output (stdout) + Skip overhead from writing to console, when not available (Ex. running as Windows Service) + Enable batch writing of logevents, instead of Console.WriteLine for each logevent (Requires ) + + + + Write to and color log-messages based on + + Fluent interface parameter. + Override the default Layout for output + Highlight only the Level-part + Override the default Encoding for output (Ex. UTF8) + Write to stderr instead of standard output (stdout) + Skip overhead from writing to console, when not available (Ex. running as Windows Service) + Enables output using ANSI Color Codes (Windows console does not support this by default) + + + + Write to + + + Override the default Layout for output + Force use independent of + + + + Write to + + + Override the default Layout for output + + + + Write to (when DEBUG-build) + + + Override the default Layout for output + + + + Write to + + Fluent interface parameter. + + Override the default Layout for output + Override the default Encoding for output (Default = UTF8) + Override the default line ending characters (Ex. without CR) + Keep log file open instead of opening and closing it on each logging event + Activate multi-process synchronization using global mutex on the operating system + Size in bytes where log files will be automatically archived. + Maximum number of archive files that should be kept. + Maximum days of archive files that should be kept. + + + + Applies target wrapper for existing + + Fluent interface parameter. + Factory method for creating target-wrapper + + + + Applies for existing for asynchronous background writing + + Fluent interface parameter. + Action to take when queue overflows + Queue size limit for pending logevents + Batch size when writing on the background thread + + + + Applies for existing for throttled writing + + Fluent interface parameter. + Buffer size limit for pending logevents + Timeout for when the buffer will flush automatically using background thread + Restart timeout when logevent is written + Action to take when buffer overflows + + + + Applies for existing for flushing after conditional event + + Fluent interface parameter. + Method delegate that controls whether logevent should force flush. + Only flush when triggers (Ignore config-reload and config-shutdown) + + + + Applies for existing for retrying after failure + + Fluent interface parameter. + Number of retries that should be attempted on the wrapped target in case of a failure. + Time to wait between retries + + + + Applies for existing to fallback on failure. + + Fluent interface parameter. + Target to use for fallback + Whether to return to the first target after any successful write + + + + Extension methods to setup general option before loading NLog LoggingConfiguration + + + + + Configures the global time-source used for all logevents + + + Available by default: , , , + + + + + Configures the global time-source used for all logevents to use + + + + + Configures the global time-source used for all logevents to use + + + + + Updates the dictionary ${gdc:item=} with the name-value-pair + + + + + Sets whether to automatically call on AppDomain.Unload or AppDomain.ProcessExit + + + + + Sets the default culture info to use as . + + + + + Sets the global log level threshold. Log events below this threshold are not logged. + + + + + Gets or sets a value indicating whether should be thrown on configuration errors + + + + + Mark Assembly as hidden, so Assembly methods are excluded when resolving ${callsite} from StackTrace + + + + + Mark Type as hidden, so Type methods are excluded when resolving ${callsite} from StackTrace + + + + + Extension methods to setup NLog extensions, so they are known when loading NLog LoggingConfiguration + + + + + Enable/disables the NLog Message Template Parsing: + - True = Always use NLog mesage-template-parser and formatting. + - False = Never use NLog-parser and only use string.Format (Disable support for message-template-syntax). + - Null = Auto detection of message-template-syntax, with fallback to string.Format (Default Behavior). + + + + + Overrides the active with a new custom implementation + + + + + Overrides the active with a new custom implementation + + + + + Registers object Type transformation from dangerous (massive) object to safe (reduced) object + + + + + Registers object Type transformation from dangerous (massive) object to safe (reduced) object + + + + + Specifies the way archive numbering is performed. + + + + + Sequence style numbering. The most recent archive has the highest number. + + + + + Rolling style numbering (the most recent is always #0 then #1, ..., #N. + + + + + Date style numbering. Archives will be stamped with the prior period + (Year, Month, Day, Hour, Minute) datetime. + + + + + Date and sequence style numbering. + Archives will be stamped with the prior period (Year, Month, Day) datetime. + The most recent archive has the highest number (in combination with the date). + + + + + Abstract Target with async Task support + + + See NLog Wiki + + + [Target("MyFirst")] + public sealed class MyFirstTarget : AsyncTaskTarget + { + public MyFirstTarget() + { + this.Host = "localhost"; + } + + [RequiredParameter] + public Layout Host { get; set; } + + protected override Task WriteAsyncTask(LogEventInfo logEvent, CancellationToken token) + { + string logMessage = this.RenderLogEvent(this.Layout, logEvent); + string hostName = this.RenderLogEvent(this.Host, logEvent); + return SendTheMessageToRemoteHost(hostName, logMessage); + } + + private async Task SendTheMessageToRemoteHost(string hostName, string message) + { + // To be implemented + } + } + + Documentation on NLog Wiki + + + + How many milliseconds to delay the actual write operation to optimize for batching + + + + + + How many seconds a Task is allowed to run before it is cancelled. + + + + + + How many attempts to retry the same Task, before it is aborted + + + + + + How many milliseconds to wait before next retry (will double with each retry) + + + + + + Gets or sets whether to use the locking queue, instead of a lock-free concurrent queue + The locking queue is less concurrent when many logger threads, but reduces memory allocation + + + + + + Gets or sets the action to be taken when the lazy writer thread request queue count + exceeds the set limit. + + + + + + Gets or sets the limit on the number of requests in the lazy writer thread request queue. + + + + + + Gets or sets the number of log events that should be processed in a batch + by the lazy writer thread. + + + + + + Task Scheduler used for processing async Tasks + + + + + Constructor + + + + + + + + Override this to provide async task for writing a single logevent. + + Example of how to override this method, and call custom async method + + protected override Task WriteAsyncTask(LogEventInfo logEvent, CancellationToken token) + { + return CustomWriteAsync(logEvent, token); + } + + private async Task CustomWriteAsync(LogEventInfo logEvent, CancellationToken token) + { + await MyLogMethodAsync(logEvent, token).ConfigureAwait(false); + } + + + The log event. + The cancellation token + + + + + Override this to provide async task for writing a batch of logevents. + + A batch of logevents. + The cancellation token + + + + + Handle cleanup after failed write operation + + Exception from previous failed Task + The cancellation token + Number of retries remaining + Time to sleep before retrying + Should attempt retry + + + + Block for override. Instead override + + + + + Block for override. Instead override + + + + + + + + Write to queue without locking + + + + + + Block for override. Instead override + + + + + LogEvent is written to target, but target failed to successfully initialize + + Enqueue logevent for later processing when target failed to initialize because of unresolved service dependency. + + + + + Schedules notification of when all messages has been written + + + + + + Closes Target by updating CancellationToken + + + + + Releases any managed resources + + + + + + Checks the internal queue for the next to create a new task for + + Used for race-condition validation between task-completion and timeout + Signals whether previousTask completed an almost full BatchSize + + + + Generates recursive task-chain to perform retry of writing logevents with increasing retry-delay + + + + + Creates new task to handle the writing of the input + + LogEvents to write + New Task created [true / false] + + + + Handles that scheduled task has completed (successfully or failed), and starts the next pending task + + Task just completed + AsyncContinuation to notify of success or failure + + + + Timer method, that is fired when pending task fails to complete within timeout + + + + + + Sends log messages to the remote instance of Chainsaw application from log4j. + + + See NLog Wiki + + Documentation on NLog Wiki + +

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a name. + + Name of the target. + + + + Color formatting for using ANSI Color Codes + + + + + Not using bold to get light colors, as it has to be cleared + + + + + Not using bold to get light colors, as it has to be cleared (And because it only works for text, and not background) + + + + + Resets both foreground and background color. + + + + + ANSI have 8 color-codes (30-37) by default. The "bright" (or "intense") color-codes (90-97) are extended values not supported by all terminals + + + + + Color formatting for using + and + + + + + Writes log messages to the console with customizable coloring. + + + See NLog Wiki + + Documentation on NLog Wiki + +

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ + + + + + Should logging being paused/stopped because of the race condition bug in Console.Writeline? + + + Console.Out.Writeline / Console.Error.Writeline could throw 'IndexOutOfRangeException', which is a bug. + See https://stackoverflow.com/questions/33915790/console-out-and-console-error-race-condition-error-in-a-windows-service-written + and https://connect.microsoft.com/VisualStudio/feedback/details/2057284/console-out-probable-i-o-race-condition-issue-in-multi-threaded-windows-service + + Full error: + Error during session close: System.IndexOutOfRangeException: Probable I/ O race condition detected while copying memory. + The I/ O package is not thread safe by default. In multi-threaded applications, + a stream must be accessed in a thread-safe way, such as a thread - safe wrapper returned by TextReader's or + TextWriter's Synchronized methods.This also applies to classes like StreamWriter and StreamReader. + + + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + Name of the target. + + + + Obsolete and replaced by with NLog v5. + Gets or sets a value indicating whether the error stream (stderr) should be used instead of the output stream (stdout). + + + + + + Gets or sets a value indicating whether to send the log messages to the standard error instead of the standard output. + + + + + + Gets or sets a value indicating whether to use default row highlighting rules. + + + The default rules are: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ConditionForeground ColorBackground Color
level == LogLevel.FatalRedNoChange
level == LogLevel.ErrorYellowNoChange
level == LogLevel.WarnMagentaNoChange
level == LogLevel.InfoWhiteNoChange
level == LogLevel.DebugGrayNoChange
level == LogLevel.TraceDarkGrayNoChange
+ + + + + + The encoding for writing messages to the . + + Has side effect + + + + + Gets or sets a value indicating whether to auto-check if the console is available. + - Disables console writing if Environment.UserInteractive = False (Windows Service) + - Disables console writing if Console Standard Input is not available (Non-Console-App) + + + + + + Gets or sets a value indicating whether to auto-check if the console has been redirected to file + - Disables coloring logic when System.Console.IsOutputRedirected = true + + + + + + Gets or sets a value indicating whether to auto-flush after + + + Normally not required as standard Console.Out will have = true, but not when pipe to file + + + + + + Enables output using ANSI Color Codes + + + + + + Gets the row highlighting rules. + + + + + + Gets the word highlighting rules. + + + + + + + + + + + + + + + + + + Colored console output color. + + + Note that this enumeration is defined to be binary compatible with + .NET 2.0 System.ConsoleColor + some additions + + + + + Black Color (#000000). + + + + + Dark blue Color (#000080). + + + + + Dark green Color (#008000). + + + + + Dark Cyan Color (#008080). + + + + + Dark Red Color (#800000). + + + + + Dark Magenta Color (#800080). + + + + + Dark Yellow Color (#808000). + + + + + Gray Color (#C0C0C0). + + + + + Dark Gray Color (#808080). + + + + + Blue Color (#0000FF). + + + + + Green Color (#00FF00). + + + + + Cyan Color (#00FFFF). + + + + + Red Color (#FF0000). + + + + + Magenta Color (#FF00FF). + + + + + Yellow Color (#FFFF00). + + + + + White Color (#FFFFFF). + + + + + Don't change the color. + + + + + The row-highlighting condition. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The condition. + Color of the foreground. + Color of the background. + + + + Gets the default highlighting rule. Doesn't change the color. + + + + + Gets or sets the condition that must be met in order to set the specified foreground and background color. + + + + + + Gets or sets the foreground color. + + + + + + Gets or sets the background color. + + + + + + Checks whether the specified log event matches the condition (if any). + + + Log event. + + + A value of if the condition is not defined or + if it matches, otherwise. + + + + + Writes log messages to the console. + + + See NLog Wiki + + Documentation on NLog Wiki + +

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ + + + + + Should logging being paused/stopped because of the race condition bug in Console.Writeline? + + + Console.Out.Writeline / Console.Error.Writeline could throw 'IndexOutOfRangeException', which is a bug. + See https://stackoverflow.com/questions/33915790/console-out-and-console-error-race-condition-error-in-a-windows-service-written + and https://connect.microsoft.com/VisualStudio/feedback/details/2057284/console-out-probable-i-o-race-condition-issue-in-multi-threaded-windows-service + + Full error: + Error during session close: System.IndexOutOfRangeException: Probable I/ O race condition detected while copying memory. + The I/ O package is not thread safe by default. In multi-threaded applications, + a stream must be accessed in a thread-safe way, such as a thread - safe wrapper returned by TextReader's or + TextWriter's Synchronized methods.This also applies to classes like StreamWriter and StreamReader. + + + + + + Obsolete and replaced by with NLog v5. + Gets or sets a value indicating whether to send the log messages to the standard error instead of the standard output. + + + + + + Gets or sets a value indicating whether to send the log messages to the standard error instead of the standard output. + + + + + + The encoding for writing messages to the . + + Has side effect + + + + + Gets or sets a value indicating whether to auto-check if the console is available + - Disables console writing if Environment.UserInteractive = False (Windows Service) + - Disables console writing if Console Standard Input is not available (Non-Console-App) + + + + + + Gets or sets a value indicating whether to auto-flush after + + + Normally not required as standard Console.Out will have = true, but not when pipe to file + + + + + + Gets or sets whether to activate internal buffering to allow batch writing, instead of using + + + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + Name of the target. + + + + + + + + + + + + + + + + + + + Highlighting rule for Win32 colorful console. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The text to be matched.. + Color of the foreground. + Color of the background. + + + + Gets or sets the regular expression to be matched. You must specify either text or regex. + + + + + + Gets or sets the condition that must be met before scanning the row for highlight of words + + + + + + Compile the ? This can improve the performance, but at the costs of more memory usage. If false, the Regex Cache is used. + + + + + + Gets or sets the text to be matched. You must specify either text or regex. + + + + + + Gets or sets a value indicating whether to match whole words only. + + + + + + Gets or sets a value indicating whether to ignore case when comparing texts. + + + + + + Gets or sets the foreground color. + + + + + + Gets or sets the background color. + + + + + + Gets the compiled regular expression that matches either Text or Regex property. Only used when is true. + + + + + A descriptor for an archive created with the DateAndSequence numbering mode. + + + + + The full name of the archive file. + + + + + The parsed date contained in the file name. + + + + + The parsed sequence number contained in the file name. + + + + + Determines whether produces the same string as the current instance's date once formatted with the current instance's date format. + + The date to compare the current object's date to. + True if the formatted dates are equal, otherwise False. + + + + Initializes a new instance of the class. + + + + + Writes log messages to the attached managed debugger. + + + See NLog Wiki + + Documentation on NLog Wiki + +

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ + + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + Name of the target. + + + + + + + + + + + + + Outputs log messages through + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + Name of the target. + + + + + + + + + + Outputs the rendered logging event through + + The logging event. + + + + Mock target - useful for testing. + + + See NLog Wiki + + Documentation on NLog Wiki + +

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ + + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + Name of the target. + + + + Gets the number of times this target has been called. + + + + + + Gets the last message rendered by this target. + + + + + + + + + Default class for serialization of values to JSON format. + + + + + Singleton instance of the serializer. + + + + + Private. Use + + + + + Returns a serialization of an object into JSON format. + + The object to serialize to JSON. + Serialized value. + + + + Returns a serialization of an object into JSON format. + + The object to serialize to JSON. + serialization options + Serialized value. + + + + Serialization of the object in JSON format to the destination StringBuilder + + The object to serialize to JSON. + Write the resulting JSON to this destination. + Object serialized successfully (true/false). + + + + Serialization of the object in JSON format to the destination StringBuilder + + The object to serialize to JSON. + Write the resulting JSON to this destination. + serialization options + Object serialized successfully (true/false). + + + + Serialization of the object in JSON format to the destination StringBuilder + + The object to serialize to JSON. + Write the resulting JSON to this destination. + serialization options + The objects in path (Avoid cyclic reference loop). + The current depth (level) of recursion. + Object serialized successfully (true/false). + + + + No quotes needed for this type? + + + + + Checks the object if it is numeric + + TypeCode for the object + Accept fractional types as numeric type. + + + + + Checks input string if it needs JSON escaping, and makes necessary conversion + + Destination Builder + Input string + all options + JSON escaped string + + + + Checks input string if it needs JSON escaping, and makes necessary conversion + + Destination Builder + Input string + Should non-ASCII characters be encoded + + JSON escaped string + + + + Writes log message to the Event Log. + + + See NLog Wiki + + Documentation on NLog Wiki + +

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ + + + + + Max size in characters (limitation of the EventLog API). + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Name of the target. + + + + Initializes a new instance of the class. + + + + + Gets or sets the name of the machine on which Event Log service is running. + + + + + + Gets or sets the layout that renders event ID. + + + + + + Gets or sets the layout that renders event Category. + + + + + + Optional entry type. When not set, or when not convertible to then determined by + + + + + + Gets or sets the value to be used as the event Source. + + + By default this is the friendly name of the current AppDomain. + + + + + + Gets or sets the name of the Event Log to write to. This can be System, Application or any user-defined name. + + + + + + Gets or sets the message length limit to write to the Event Log. + + MaxMessageLength cannot be zero or negative + + + + + Gets or sets the maximum Event log size in kilobytes. + + + MaxKilobytes cannot be less than 64 or greater than 4194240 or not a multiple of 64. + If null, the value will not be specified while creating the Event log. + + + + + + Gets or sets the action to take if the message is larger than the option. + + + + + + Performs installation which requires administrative permissions. + + The installation context. + + + + Performs uninstallation which requires administrative permissions. + + The installation context. + + + + Determines whether the item is installed. + + The installation context. + + Value indicating whether the item is installed or null if it is not possible to determine. + + + + + + + + + + + Get the entry type for logging the message. + + The logging event - for rendering the + + + + Get the source, if and only if the source is fixed. + + null when not + Internal for unit tests + + + + (re-)create an event source, if it isn't there. Works only with fixed source names. + + The source name. If source is not fixed (see , then pass null or . + always throw an Exception when there is an error + + + + A wrapper for Windows event log. + + + + + A wrapper for the property . + + + + + A wrapper for the property . + + + + + A wrapper for the property . + + + + + A wrapper for the property . + + + + + Indicates whether an event log instance is associated. + + + + + A wrapper for the method . + + + + + Creates a new association with an instance of the event log. + + + + + A wrapper for the static method . + + + + + A wrapper for the static method . + + + + + A wrapper for the static method . + + + + + A wrapper for the static method . + + + + + The implementation of , that uses Windows . + + + + + Creates a new association with an instance of Windows . + + + + + Action that should be taken if the message is greater than + the max message size allowed by the Event Log. + + + + + Truncate the message before writing to the Event Log. + + + + + Split the message and write multiple entries to the Event Log. + + + + + Discard of the message. It will not be written to the Event Log. + + + + + Check if cleanup should be performed on initialize new file + + Skip cleanup when initializing new file, just after having performed archive operation + + Base archive file pattern + Maximum number of archive files that should be kept + Maximum days of archive files that should be kept + True, when archive cleanup is needed + + + + Characters determining the start of the . + + + + + Characters determining the end of the . + + + + + File name which is used as template for matching and replacements. + It is expected to contain a pattern to match. + + + + + The beginning position of the + within the . -1 is returned + when no pattern can be found. + + + + + The ending position of the + within the . -1 is returned + when no pattern can be found. + + + + + Replace the pattern with the specified String. + + + + + + + Archives the log-files using a date style numbering. Archives will be stamped with the + prior period (Year, Month, Day, Hour, Minute) datetime. + + When the number of archive files exceed the obsolete archives are deleted. + When the age of archive files exceed the obsolete archives are deleted. + + + + + Archives the log-files using a date and sequence style numbering. Archives will be stamped + with the prior period (Year, Month, Day) datetime. The most recent archive has the highest number (in + combination with the date). + + When the number of archive files exceed the obsolete archives are deleted. + When the age of archive files exceed the obsolete archives are deleted. + + + + + Parse filename with date and sequence pattern + + + dateformat for archive + + the found pattern. When failed, then default + the found pattern. When failed, then default + + + + + Archives the log-files using the provided base-archive-filename. If the base-archive-filename causes + duplicate archive filenames, then sequence-style is automatically enforced. + + Example: + Base Filename trace.log + Next Filename trace.0.log + + The most recent archive has the highest number. + + When the number of archive files exceed the obsolete archives are deleted. + When the age of archive files exceed the obsolete archives are deleted. + + + + + Dynamically converts a non-template archiveFilePath into a correct archiveFilePattern. + Before called the original IFileArchiveMode, that has been wrapped by this + + + + + Determines if the file name as contains a numeric pattern i.e. {#} in it. + + Example: + trace{#}.log Contains the numeric pattern. + trace{###}.log Contains the numeric pattern. + trace{#X#}.log Contains the numeric pattern (See remarks). + trace.log Does not contain the pattern. + + Occasionally, this method can identify the existence of the {#} pattern incorrectly. + File name to be checked. + when the pattern is found; otherwise. + + + + Archives the log-files using a rolling style numbering (the most recent is always #0 then + #1, ..., #N. + + When the number of archive files exceed the obsolete archives + are deleted. + + + + + Replaces the numeric pattern i.e. {#} in a file name with the parameter value. + + File name which contains the numeric pattern. + Value which will replace the numeric pattern. + File name with the value of in the position of the numeric pattern. + + + + Archives the log-files using a sequence style numbering. The most recent archive has the highest number. + + When the number of archive files exceed the obsolete archives are deleted. + When the age of archive files exceed the obsolete archives are deleted. + + + + + Modes of archiving files based on time. + + + + + Don't archive based on time. + + + + + AddToArchive every year. + + + + + AddToArchive every month. + + + + + AddToArchive daily. + + + + + AddToArchive every hour. + + + + + AddToArchive every minute. + + + + + AddToArchive every Sunday. + + + + + AddToArchive every Monday. + + + + + AddToArchive every Tuesday. + + + + + AddToArchive every Wednesday. + + + + + AddToArchive every Thursday. + + + + + AddToArchive every Friday. + + + + + AddToArchive every Saturday. + + + + + Type of filepath + + + + + Detect of relative or absolute + + + + + Relative path + + + + + Absolute path + + Best for performance + + + + Writes log messages to one or more files. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Default clean up period of the initialized files. When a file exceeds the clean up period is removed from the list. + + Clean up period is defined in days. + + + + This value disables file archiving based on the size. + + + + + Holds the initialized files each given time by the instance. Against each file, the last write time is stored. + + Last write time is store in local time (no UTC). + + + + List of the associated file appenders with the instance. + + + + + The number of initialized files at any one time. + + + + + The maximum number of archive files that should be kept. + + + + + The maximum days of archive files that should be kept. + + + + + The filename as target + + + + + The archive file name as target + + + + + The date of the previous log event. + + + + + The file name of the previous log event. + + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + Name of the target. + + + + Gets or sets the name of the file to write to. + + + This FileName string is a layout which may include instances of layout renderers. + This lets you use a single target to write to multiple files. + + + The following value makes NLog write logging events to files based on the log level in the directory where + the application runs. + ${basedir}/${level}.log + All Debug messages will go to Debug.log, all Info messages will go to Info.log and so on. + You can combine as many of the layout renderers as you want to produce an arbitrary log file name. + + + + + + Cleanup invalid values in a filename, e.g. slashes in a filename. If set to true, this can impact the performance of massive writes. + If set to false, nothing gets written when the filename is wrong. + + + + + + Is the an absolute or relative path? + + + + + + Gets or sets a value indicating whether to create directories if they do not exist. + + + Setting this to false may improve performance a bit, but you'll receive an error + when attempting to write to a directory that's not present. + + + + + + Gets or sets a value indicating whether to delete old log file on startup. + + + This option works only when the "FileName" parameter denotes a single file. + + + + + + Gets or sets a value indicating whether to replace file contents on each write instead of appending log message at the end. + + + + + + Gets or sets a value indicating whether to keep log file open instead of opening and closing it on each logging event. + + + KeepFileOpen = true gives the best performance, and ensure the file-lock is not lost to other applications.
+ KeepFileOpen = false gives the best compability, but slow performance and lead to file-locking issues with other applications. + + + + + + Gets or sets a value indicating whether to enable log file(s) to be deleted. + + + + + + Gets or sets the file attributes (Windows only). + + + + + + Gets or sets the line ending mode. + + + + + + Gets or sets a value indicating whether to automatically flush the file buffers after each log message. + + + + + + Gets or sets the number of files to be kept open. Setting this to a higher value may improve performance + in a situation where a single File target is writing to many files + (such as splitting by level or by logger). + + + The files are managed on a LRU (least recently used) basis, which flushes + the files that have not been used for the longest period of time should the + cache become full. As a rule of thumb, you shouldn't set this parameter to + a very high value. A number like 10-15 shouldn't be exceeded, because you'd + be keeping a large number of files open which consumes system resources. + + + + + + Gets or sets the maximum number of seconds that files are kept open. Zero or negative means disabled. + + + + + + Gets or sets the maximum number of seconds before open files are flushed. Zero or negative means disabled. + + + + + + Gets or sets the log file buffer size in bytes. + + + + + + Gets or sets the file encoding. + + + + + + Gets or sets whether or not this target should just discard all data that its asked to write. + Mostly used for when testing NLog Stack except final write + + + + + + Gets or sets a value indicating whether concurrent writes to the log file by multiple processes on the same host. + + + This makes multi-process logging possible. NLog uses a special technique + that lets it keep the files open for writing. + + + + + + Obsolete and replaced by = false with NLog v5.3. + Gets or sets a value indicating whether concurrent writes to the log file by multiple processes on different network hosts. + + + This effectively prevents files from being kept open. + + + + + + Gets or sets a value indicating whether to write BOM (byte order mark) in created files. + + Defaults to true for UTF-16 and UTF-32 + + + + + + Gets or sets the number of times the write is appended on the file before NLog + discards the log message. + + + + + + Gets or sets the delay in milliseconds to wait before attempting to write to the file again. + + + The actual delay is a random value between 0 and the value specified + in this parameter. On each failed attempt the delay base is doubled + up to times. + + + Assuming that ConcurrentWriteAttemptDelay is 10 the time to wait will be:

+ a random value between 0 and 10 milliseconds - 1st attempt
+ a random value between 0 and 20 milliseconds - 2nd attempt
+ a random value between 0 and 40 milliseconds - 3rd attempt
+ a random value between 0 and 80 milliseconds - 4th attempt
+ ...

+ and so on. + + + + +

+ Gets or sets a value indicating whether to archive old log file on startup. + + + This option works only when the "FileName" parameter denotes a single file. + After archiving the old file, the current log file will be empty. + + + + + + Gets or sets whether to write the Header on initial creation of file appender, even if the file is not empty. + Default value is , which means only write header when initial file is empty (Ex. ensures valid CSV files) + + + Alternative use to ensure each application session gets individual log-file. + + + + + Gets or sets a value of the file size threshold to archive old log file on startup. + + + This option won't work if is set to false + Default value is 0 which means that the file is archived as soon as archival on + startup is enabled. + + + + + + Gets or sets a value specifying the date format to use when archiving files. + + + This option works only when the "ArchiveNumbering" parameter is set either to Date or DateAndSequence. + + + + + + Gets or sets the size in bytes above which log files will be automatically archived. + + + Notice when combined with then it will attempt to append to any existing + archive file if grown above size multiple times. New archive file will be created when using + + + + + + Gets or sets a value indicating whether to automatically archive log files every time the specified time passes. + + + Files are moved to the archive as part of the write operation if the current period of time changes. For example + if the current hour changes from 10 to 11, the first write that will occur + on or after 11:00 will trigger the archiving. + + + + + + Is the an absolute or relative path? + + + + + + Gets or sets the name of the file to be used for an archive. + + + It may contain a special placeholder {#####} + that will be replaced with a sequence of numbers depending on + the archiving strategy. The number of hash characters used determines + the number of numerical digits to be used for numbering files. + + + + + + Gets or sets the maximum number of archive files that should be kept. + + + + + + Gets or sets the maximum days of archive files that should be kept. + + + + + + Gets or sets the way file archives are numbered. + + + + + + Used to compress log files during archiving. + This may be used to provide your own implementation of a zip file compressor, + on platforms other than .Net4.5. + Defaults to ZipArchiveFileCompressor on .Net4.5 and to null otherwise. + + + + + + Gets or sets a value indicating whether to compress archive files into the zip archive format. + + + + + + Gets or set a value indicating whether a managed file stream is forced, instead of using the native implementation. + + + + + + Gets or sets a value indicating whether file creation calls should be synchronized by a system global mutex. + + + + + + Gets or sets a value indicating whether the footer should be written only when the file is archived. + + + + + + Gets the characters that are appended after each line. + + + + + Refresh the ArchiveFilePatternToWatch option of the . + The log file must be watched for archiving when multiple processes are writing to the same + open file. + + + + + Removes records of initialized files that have not been + accessed in the last two days. + + + Files are marked 'initialized' for the purpose of writing footers when the logging finishes. + + + + + Removes records of initialized files that have not been + accessed after the specified date. + + The cleanup threshold. + + Files are marked 'initialized' for the purpose of writing footers when the logging finishes. + + + + + Flushes all pending file operations. + + The asynchronous continuation. + + The timeout parameter is ignored, because file APIs don't provide + the needed functionality. + + + + + Returns the suitable appender factory ( ) to be used to generate the file + appenders associated with the instance. + + The type of the file appender factory returned depends on the values of various properties. + + suitable for this instance. + + + + Initializes file logging by creating data structures that + enable efficient multi-file logging. + + + + + Closes the file(s) opened for writing. + + + + + Writes the specified logging event to a file specified in the FileName + parameter. + + The logging event. + + + + Get full filename (=absolute) and cleaned if needed. + + + + + + + Writes the specified array of logging events to a file specified in the FileName + parameter. + + An array of objects. + + This function makes use of the fact that the events are batched by sorting + the requests by filename. This optimizes the number of open/close calls + and can help improve performance. + + + + + Obsolete and replaced by with NLog v5. + Formats the log event for write. + + The log event to be formatted. + A string representation of the log event. + + + + Obsolete and replaced by with NLog v5. + Gets the bytes to be written to the file. + + Log event. + Array of bytes that are ready to be written. + + + + Obsolete and replaced by with NLog v5. + Modifies the specified byte array before it gets sent to a file. + + The byte array. + The modified byte array. The function can do the modification in-place. + + + + Gets the bytes to be written to the file. + + The log event to be formatted. + to help format log event. + Optional temporary char-array to help format log event. + Destination for the encoded result. + + + + Formats the log event for write. + + The log event to be formatted. + for the result. + + + + Modifies the specified byte array before it gets sent to a file. + + The LogEvent being written + The byte array. + + + + Archives fileName to archiveFileName. + + File name to be archived. + Name of the archive file. + + + + Gets the correct formatting to be used based on the value of for converting values which will be inserting into file + names during archiving. + + This value will be computed only when a empty value or is passed into + + Date format to used irrespectively of value. + Formatting for dates. + + + + Calculate the DateTime of the requested day of the week. + + The DateTime of the previous log event. + The next occurring day of the week to return a DateTime for. + The DateTime of the next occurring dayOfWeek. + For example: if previousLogEventTimestamp is Thursday 2017-03-02 and dayOfWeek is Sunday, this will return + Sunday 2017-03-05. If dayOfWeek is Thursday, this will return *next* Thursday 2017-03-09. + + + + Invokes the archiving process after determining when and which type of archiving is required. + + File name to be checked and archived. + Log event that the instance is currently processing. + The DateTime of the previous log event for this file. + File has just been opened. + + + + Gets the pattern that archive files will match + + Filename of the log file + Log event that the instance is currently processing. + A string with a pattern that will match the archive filenames + + + + Archives the file if it should be archived. + + The file name to check for. + Log event that the instance is currently processing. + The size in bytes of the next chunk of data to be written in the file. + The DateTime of the previous log event for this file. + File has just been opened. + True when archive operation of the file was completed (by this target or a concurrent target) + + + + Closes any active file-appenders that matches the input filenames. + File-appender is requested to invalidate/close its filehandle, but keeping its archive-mutex alive + + + + + Indicates if the automatic archiving process should be executed. + + File name to be written. + Log event that the instance is currently processing. + The size in bytes of the next chunk of data to be written in the file. + The DateTime of the previous log event for this file. + File has just been opened. + Filename to archive. If null, then nothing to archive. + + + + Returns the correct filename to archive + + + + + Gets the file name for archiving, or null if archiving should not occur based on file size. + + File name to be written. + The size in bytes of the next chunk of data to be written in the file. + File has just been opened. + Filename to archive. If null, then nothing to archive. + + + + Check if archive operation should check previous filename, because FileAppenderCache tells us current filename no longer exists + + + + + Returns the file name for archiving, or null if archiving should not occur based on date/time. + + File name to be written. + Log event that the instance is currently processing. + The DateTime of the previous log event for this file. + File has just been opened. + Filename to archive. If null, then nothing to archive. + + + + Truncates the input-time, so comparison of low resolution times (like dates) are not affected by ticks + + High resolution Time + Time Resolution Level + Truncated Low Resolution Time + + + + Evaluates which parts of a file should be written (header, content, footer) based on various properties of + instance and writes them. + + File name to be written. + Raw sequence of to be written into the content part of the file. + File has just been opened. + + + + Initialize a file to be used by the instance. Based on the number of initialized + files and the values of various instance properties clean up and/or archiving processes can be invoked. + + File name to be written. + Log event that the instance is currently processing. + The DateTime of the previous log event for this file (DateTime.MinValue if just initialized). + + + + Writes the file footer and finalizes the file in instance internal structures. + + File name to close. + Indicates if the file is being finalized for archiving. + + + + Writes the footer information to a file. + + The file path to write to. + + + + Decision logic whether to archive logfile on startup. + and properties. + + File name to be written. + Decision whether to archive or not. + + + + Invokes the archiving and clean up of older archive file based on the values of + and + properties respectively. + + File name to be written. + Log event that the instance is currently processing. + + + + Creates the file specified in and writes the file content in each entirety i.e. + Header, Content and Footer. + + The name of the file to be written. + Sequence of to be written in the content section of the file. + First attempt to write? + This method is used when the content of the log file is re-written on every write. + + + + Writes the header information and byte order mark to a file. + + File appender associated with the file. + + + + The sequence of to be written in a file after applying any formatting and any + transformations required from the . + + The layout used to render output message. + Sequence of to be written. + Usually it is used to render the header and hooter of the files. + + + + may be configured to compress archived files in a custom way + by setting before logging your first event. + + + + + Create archiveFileName by compressing fileName. + + Absolute path to the log file to compress. + Absolute path to the compressed archive file to create. + The name of the file inside the archive. + + + + Controls the text and color formatting for + + + + + Creates a TextWriter for the console to start building a colored text message + + Active console stream + Optional StringBuilder to optimize performance + TextWriter for the console + + + + Releases the TextWriter for the console after having built a colored text message (Restores console colors) + + Colored TextWriter + Active console stream + Original foreground color for console (If changed) + Original background color for console (If changed) + Flush TextWriter + + + + Changes foreground color for the Colored TextWriter + + Colored TextWriter + New foreground color for the console + Old previous backgroundColor color for the console + Old foreground color for the console + + + + Changes backgroundColor color for the Colored TextWriter + + Colored TextWriter + New backgroundColor color for the console + Old previous backgroundColor color for the console + Old backgroundColor color for the console + + + + Restores console colors back to their original state + + Colored TextWriter + Original foregroundColor color for the console + Original backgroundColor color for the console + + + + Writes multiple characters to console in one operation (faster) + + Colored TextWriter + Output Text + Start Index + End Index + + + + Writes single character to console + + Colored TextWriter + Output Text + + + + Writes whole string and completes with newline + + Colored TextWriter + Output Text + + + + Default row highlight rules for the console printer + + + + + Check if cleanup should be performed on initialize new file + + Base archive file pattern + Maximum number of archive files that should be kept + Maximum days of archive files that should be kept + True, when archive cleanup is needed + + + + Create a wildcard file-mask that allows one to find all files belonging to the same archive. + + Base archive file pattern + Wildcard file-mask + + + + Search directory for all existing files that are part of the same archive. + + Base archive file pattern + + + + + Generate the next archive filename for the archive. + + Base archive file pattern + File date of archive + Existing files in the same archive + + + + + Return all files that should be removed from the provided archive. + + Base archive file pattern + Existing files in the same archive + Maximum number of archive files that should be kept + Maximum days of archive files that should be kept + + + + may be configured to compress archived files in a custom way + by setting before logging your first event. + + + + + Create archiveFileName by compressing fileName. + + Absolute path to the log file to compress. + Absolute path to the compressed archive file to create. + + + + Options for JSON serialization + + + + + Add quotes around object keys? + + + + + Format provider for value + + + + + Format string for value + + + + + Should non-ascii characters be encoded + + + + + Should forward slashes be escaped? If true, / will be converted to \/ + + + + + Serialize enum as string value + + + + + Should dictionary keys be sanitized. All characters must either be letters, numbers or underscore character (_). + + Any other characters will be converted to underscore character (_) + + + + + How far down the rabbit hole should the Json Serializer go with object-reflection before stopping + + + + + Line ending mode. + + + + + Insert platform-dependent end-of-line sequence after each line. + + + + + Insert CR LF sequence (ASCII 13, ASCII 10) after each line. + + + + + Insert CR character (ASCII 13) after each line. + + + + + Insert LF character (ASCII 10) after each line. + + + + + Insert null terminator (ASCII 0) after each line. + + + + + Do not insert any line ending. + + + + + Gets the name of the LineEndingMode instance. + + + + + Gets the new line characters (value) of the LineEndingMode instance. + + + + + Initializes a new instance of . + + The mode name. + The new line characters to be used. + + + + Returns the that corresponds to the supplied . + + + The textual representation of the line ending mode, such as CRLF, LF, Default etc. + Name is not case sensitive. + + The value, that corresponds to the . + There is no line ending mode with the specified name. + + + + Compares two objects and returns a + value indicating whether the first one is equal to the second one. + + The first level. + The second level. + The value of mode1.NewLineCharacters == mode2.NewLineCharacters. + + + + Compares two objects and returns a + value indicating whether the first one is not equal to the second one. + + The first mode + The second mode + The value of mode1.NewLineCharacters != mode2.NewLineCharacters. + + + + + + + + + + + + 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. + + + + Provides a type converter to convert objects to and from other representations. + + + + + + + + + + + Sends log messages by email using SMTP protocol. + + + See NLog Wiki + + Documentation on NLog Wiki + +

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ +

+ Mail target works best when used with BufferingWrapper target + which lets you send multiple log messages in single mail +

+

+ To set up the buffered mail target in the configuration file, + use the following syntax: +

+ +

+ To set up the buffered mail target programmatically use code like this: +

+ + + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + Name of the target. + + + + Gets the mailSettings/smtp configuration from app.config in cases when we need those configuration. + E.g when UseSystemNetMailSettings is enabled and we need to read the From attribute from system.net/mailSettings/smtp + + Internal for mocking + + + + Gets or sets sender's email address (e.g. joe@domain.com). + + + + + + Gets or sets recipients' email addresses separated by semicolons (e.g. john@domain.com;jane@domain.com). + + + + + + Gets or sets CC email addresses separated by semicolons (e.g. john@domain.com;jane@domain.com). + + + + + + Gets or sets BCC email addresses separated by semicolons (e.g. john@domain.com;jane@domain.com). + + + + + + Gets or sets a value indicating whether to add new lines between log entries. + + A value of true if new lines should be added; otherwise, false. + + + + + Gets or sets the mail subject. + + + + + + Gets or sets mail message body (repeated for each log message send in one mail). + + Alias for the Layout property. + + + + + Gets or sets encoding to be used for sending e-mail. + + + + + + Gets or sets a value indicating whether to send message as HTML instead of plain text. + + + + + + Gets or sets SMTP Server to be used for sending. + + + + + + Gets or sets SMTP Authentication mode. + + + + + + Gets or sets the username used to connect to SMTP server (used when SmtpAuthentication is set to "basic"). + + + + + + Gets or sets the password used to authenticate against SMTP server (used when SmtpAuthentication is set to "basic"). + + + + + + Gets or sets a value indicating whether SSL (secure sockets layer) should be used when communicating with SMTP server. + + . + + + + Gets or sets the port number that SMTP Server is listening on. + + + + + + Gets or sets a value indicating whether the default Settings from System.Net.MailSettings should be used. + + + + + + Specifies how outgoing email messages will be handled. + + + + + + Gets or sets the folder where applications save mail messages to be processed by the local SMTP server. + + + + + + Gets or sets the priority used for sending mails. + + + + + + Gets or sets a value indicating whether NewLine characters in the body should be replaced with
tags. + + Only happens when is set to true. + + + + + Gets or sets a value indicating the SMTP client timeout. + + Warning: zero is not infinite waiting + + + + + Gets the array of email headers that are transmitted with this email message + + + + + + + + + + + + + + + Create mail and send with SMTP + + event printed in the body of the event + + + + Create buffer for body + + all events + first event for header + last event for footer + + + + + Set properties of + + last event for username/password + client to set properties on + Configure not at , as the properties could have layout renderers. + + + + Handle if it is a virtual directory. + + + + + + + Create key for grouping. Needed for multiple events in one mail message + + event for rendering layouts + string to group on + + + + Create the mail message with the addresses, properties and body. + + + + + Render and add the addresses to + + Addresses appended to this list + layout with addresses, ; separated + event for rendering the + added a address? + + + + Writes log messages to in memory for programmatic retrieval. + + + See NLog Wiki + + Documentation on NLog Wiki + +

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ + + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + Name of the target. + + + + Gets the list of logs gathered in the . + + + Be careful when enumerating, as NLog target is blocked from writing during enumeration (blocks application logging) + + + + + Gets or sets the max number of items to have in memory + + + + + + + + + + + + Renders the logging event message and adds to + + The logging event. + + + + A parameter to MethodCall. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The layout to use for parameter value. + + + + Initializes a new instance of the class. + + Name of the parameter. + The layout. + + + + Initializes a new instance of the class. + + The name of the parameter. + The layout. + The type of the parameter. + + + + Gets or sets the name of the parameter. + + + + + + Gets or sets the layout that should be use to calculate the value for the parameter. + + + + + + Obsolete and replaced by with NLog v4.6. + Gets or sets the type of the parameter. Obsolete alias for + + + + + + Gets or sets the type of the parameter. + + + + + + Gets or sets the fallback value when result value is not available + + + + + + Render Result Value + + Log event for rendering + Result value when available, else fallback to defaultValue + + + + Calls the specified static method on each log message and passes contextual parameters to it. + + + See NLog Wiki + + Documentation on NLog Wiki + +

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ + + + + + Gets or sets the class name. + + + + + + Gets or sets the method name. The method must be public and static. + + Use the AssemblyQualifiedName , https://msdn.microsoft.com/en-us/library/system.type.assemblyqualifiedname(v=vs.110).aspx + e.g. + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Name of the target. + + + + Initializes a new instance of the class. + + Name of the target. + Method to call on logevent. + + + + + + + Calls the specified Method. + + Method parameters. + The logging event. + + + + Calls the specified Method. + + Method parameters. + + + + The base class for all targets which call methods (local or remote). + Manages parameters and type coercion. + + + + + Initializes a new instance of the class. + + + + + Gets the array of parameters to be passed. + + + + + + Prepares an array of parameters to be passed based on the logging event and calls DoInvoke(). + + The logging event. + + + + Calls the target DoInvoke method, and handles AsyncContinuation callback + + Method call parameters. + The logging event. + + + + Calls the target DoInvoke method, and handles AsyncContinuation callback + + Method call parameters. + The continuation. + + + + Calls the target method. Must be implemented in concrete classes. + + Method call parameters. + + + + Arguments for events. + + + + + + + + + + + + + + + + + Creates new instance of NetworkTargetLogEventDroppedEventArgs + + + + + The reason why log was dropped + + + + + The reason why log event was dropped by + + + + + Discarded LogEvent because message is bigger than + + + + + Discarded LogEvent because message queue was bigger than + + + + + Discarded LogEvent because attempted to open more than connections + + + + + Discarded LogEvent because of network communication error + + + + + Sends log messages over the network. + + + See NLog Wiki + + Documentation on NLog Wiki + +

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ +

+ To print the results, use any application that's able to receive messages over + TCP or UDP. NetCat is + a simple but very powerful command-line tool that can be used for that. This image + demonstrates the NetCat tool receiving log messages from Network target. +

+ +

+ There are two specialized versions of the Network target: Chainsaw + and NLogViewer which write to instances of Chainsaw log4j viewer + or NLogViewer application respectively. +

+ + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + Name of the target. + + + + Gets or sets the network address. + + + The network address can be: +
    +
  • tcp://host:port - TCP (auto select IPv4/IPv6)
    • +
  • tcp4://host:port - force TCP/IPv4
    • +
  • tcp6://host:port - force TCP/IPv6
    • +
  • udp://host:port - UDP (auto select IPv4/IPv6)
    • +
  • udp4://host:port - force UDP/IPv4
    • +
  • udp6://host:port - force UDP/IPv6
    • +
  • http://host:port/pageName - HTTP using POST verb
    • +
  • https://host:port/pageName - HTTPS using POST verb
    • +
+ For SOAP-based webservice support over HTTP use WebService target. + + + + + + Gets or sets a value indicating whether to keep connection open whenever possible. + + + + + + Gets or sets a value indicating whether to append newline at the end of log message. + + + + + + Gets or sets the end of line value if a newline is appended at the end of log message . + + + + + + Gets or sets the maximum message size in bytes. On limit breach then action is activated. + + + + + + Gets or sets the maximum simultaneous connections. Requires = false + + + When having reached the maximum limit, then action will apply. + + + + + + Gets or sets the action that should be taken, when more connections than . + + + + + + Gets or sets the maximum queue size for a single connection. Requires = true + + + When having reached the maximum limit, then action will apply. + + + + + + Gets or sets the action that should be taken, when more pending messages than . + + + + + + Occurs when LogEvent has been dropped. + + + - When internal queue is full and set to
+ - When connection-list is full and set to
+ - When message is too big and set to
+ + + + + Gets or sets the size of the connection cache (number of connections which are kept alive). Requires = true + + + + + + Gets or sets the action that should be taken if the message is larger than + + + For TCP sockets then means no-limit, as TCP sockets + performs splitting automatically. + + For UDP Network sender then means splitting the message + into smaller chunks. This can be useful on networks using DontFragment, which drops network packages + larger than MTU-size (1472 bytes). + + + + + + Gets or sets the encoding to be used. + + + + + + Gets or sets the SSL/TLS protocols. Default no SSL/TLS is used. Currently only implemented for TCP. + + + + + + The number of seconds a connection will remain idle before the first keep-alive probe is sent + + + + + + Type of compression for protocol payload. Useful for UDP where datagram max-size is 8192 bytes. + + + + + Skip compression when protocol payload is below limit to reduce overhead in cpu-usage and additional headers + + + + + Flush any pending log messages asynchronously (in case of asynchronous targets). + + The asynchronous continuation. + + + + + + + Sends the + rendered logging event over the network optionally concatenating it with a newline character. + + The logging event. + + + + Try to remove. + + + + + removed something? + + + + Gets the bytes to be written. + + Log event. + Byte array. + + + + Type of compression for protocol payload + + + + + No compression + + + + + GZip optimal compression + + + + + GZip fastest compression + + + + + The action to be taken when there are more connections then the max. + + + + + Allow new connections when reaching max connection limit + + + + + Obsolete and replaced by with NLog v5. + Just allow it. + + + + + Discard new messages when reaching max connection limit + + + + + Obsolete and replaced by with NLog v5. + Discard the connection item. + + + + + Block until there's more room in the queue. + + + + + Action that should be taken if the message overflows. + + + + + Report an error. + + + + + Split the message into smaller pieces. Only relevant for UDP sockets, as TCP sockets does it automatically. + + + Udp-Network-Sender will split the message into smaller chunks that matches . + This can avoid network-package-drop when network uses DontFragment and message is larger than MTU-size (1472 bytes). + + + + + Discard the entire message. + + + + + The action to be taken when the queue overflows. + + + + + Grow the queue. + + + + + Discard the overflowing item. + + + + + Block until there's more room in the queue. + + + + + Represents a parameter to a NLogViewer target. + + + + + Initializes a new instance of the class. + + + + + Gets or sets viewer parameter name. + + + + + + Gets or sets the layout that should be use to calculate the value for the parameter. + + + + + + Gets or sets whether an attribute with empty value should be included in the output + + + + + + Sends log messages to the remote instance of NLog Viewer. + + + See NLog Wiki + + Documentation on NLog Wiki + +

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ + + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + Name of the target. + + + + Gets or sets a value indicating whether to include NLog-specific extensions to log4j schema. + + + + + + Gets or sets the log4j:event logger-xml-attribute. Default: ${logger} + + + + + + Gets or sets the log4j:event message-xml-element. Default: ${message} + + + + + + Gets or sets the log4j:event log4japp-xml-element. By default it's the friendly name of the current AppDomain. + + + + + + Gets or sets a value indicating whether to include call site (class and method name) in the information sent over the network. + + + + + + Gets or sets a value indicating whether to include source info (file name and line number) in the information sent over the network. + + + + + + Obsolete and replaced by with NLog v5. + Gets or sets a value indicating whether to include dictionary contents. + + + + + + Gets or sets whether to include log4j:NDC in output from nested context. + + + + + + Gets or sets the option to include all properties from the log events + + + + + + Gets or sets whether to include the contents of the properties-dictionary. + + + + + + Gets or sets whether to include log4j:NDC in output from nested context. + + + + + + Gets or sets the separator for operation-states-stack. + + + + + + Obsolete and replaced by with NLog v5. + Gets or sets the option to include all properties from the log events + + + + + + Obsolete and replaced by with NLog v5. + Gets or sets a value indicating whether to include dictionary contents. + + + + + + Obsolete and replaced by with NLog v5. + Gets or sets a value indicating whether to include contents of the stack. + + + + + + Obsolete and replaced by with NLog v5. + Gets or sets the stack separator for log4j:NDC in output from nested context. + + + + + + Gets or sets the stack separator for log4j:NDC in output from nested context. + + + + + + Gets the collection of parameters. Each parameter contains a mapping + between NLog layout and a named parameter. + + + + + + Gets the layout renderer which produces Log4j-compatible XML events. + + + + + Gets or sets the instance of that is used to format log messages. + + + + + + Discards log messages. Used mainly for debugging and benchmarking. + + + See NLog Wiki + + Documentation on NLog Wiki + +

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ + + + + + Gets or sets a value indicating whether to perform layout calculation. + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Name of the target. + + + + Does nothing. Optionally it calculates the layout text but + discards the results. + + The logging event. + + + + SMTP authentication modes. + + + + + No authentication. + + + + + Basic - username and password. + + + + + NTLM Authentication. + + + + + Represents logging target. + + + + Are all layouts in this target thread-agnostic, if so we don't precalculate the layouts + + + + The Max StackTraceUsage of all the in this Target + + + + + Gets or sets the name of the target. + + + + + + Target supports reuse of internal buffers, and doesn't have to constantly allocate new buffers + Required for legacy NLog-targets, that expects buffers to remain stable after Write-method exit + + + + + + NLog Layout are by default threadsafe, so multiple threads can be rendering logevents at the same time. + This ensure high concurrency with no lock-congestion for the application-threads, especially when using + or AsyncTaskTarget. + + But if using custom or that are not + threadsafe, then this option can enabled to protect against thread-concurrency-issues. Allowing one + to update to NLog 5.0 without having to fix custom/external layout-dependencies. + + + + + + Gets the object which can be used to synchronize asynchronous operations that must rely on the . + + + + + Gets the logging configuration this target is part of. + + + + + Gets a value indicating whether the target has been initialized. + + + + + Initializes this instance. + + The configuration. + + + + Closes this instance. + + + + + Closes the target. + + + + + Flush any pending log messages (in case of asynchronous targets). + + The asynchronous continuation. + + + + Calls the on each volatile layout + used by this target. + This method won't prerender if all layouts in this target are thread-agnostic. + + + The log event. + + + + + + + + Writes the log to the target. + + Log event to write. + + + + Writes the array of log events. + + The log events. + + + + Writes the array of log events. + + The log events. + + + + LogEvent is written to target, but target failed to successfully initialize + + + + + Initializes this instance. + + The configuration. + + + + Closes this instance. + + + + + Releases unmanaged and - optionally - managed resources. + + True to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Initializes the target before writing starts + + + + + Closes the target to release any initialized resources + + + + + Flush any pending log messages + + The asynchronous continuation parameter must be called on flush completed + The asynchronous continuation to be called on flush completed. + + + + Writes logging event to the target destination + + Logging event to be written out. + + + + Writes async log event to the log target. + + Async Log event to be written out. + + + + Writes a log event to the log target, in a thread safe manner. + Any override of this method has to provide their own synchronization mechanism. + + !WARNING! Custom targets should only override this method if able to provide their + own synchronization mechanism. -objects are not guaranteed to be + thread-safe, so using them without a SyncRoot-object can be dangerous. + + Log event to be written out. + + + + Writes an array of logging events to the log target. By default it iterates on all + events and passes them to "Write" method. Inheriting classes can use this method to + optimize batch writes. + + Logging events to be written out. + + + + Writes an array of logging events to the log target, in a thread safe manner. + Any override of this method has to provide their own synchronization mechanism. + + !WARNING! Custom targets should only override this method if able to provide their + own synchronization mechanism. -objects are not guaranteed to be + thread-safe, so using them without a SyncRoot-object can be dangerous. + + Logging events to be written out. + + + + Merges (copies) the event context properties from any event info object stored in + parameters of the given event info object. + + The event info object to perform the merge to. + + + + Renders the logevent into a string-result using the provided layout + + The layout. + The logevent info. + String representing log event. + + + + Renders the logevent into a result-value by using the provided layout + + + The layout. + The logevent info. + Fallback value when no value available + Result value when available, else fallback to defaultValue + + + + Resolve from DI + + Avoid calling this while handling a LogEvent, since random deadlocks can occur. + + + + Should the exception be rethrown? + + Upgrade to private protected when using C# 7.2 + + + + + Obsolete and replaced by with NLog v5.2. + + Register a custom Target. + + Short-cut for registering to default + Type of the Target. + The target type-alias for use in NLog configuration + + + + Obsolete and replaced by with NLog v5.2. + + Register a custom Target. + + Short-cut for registering to default + Type of the Target. + The target type-alias for use in NLog configuration + + + + Marks class as logging target and attaches a type-alias name for use in NLog configuration. + + + + + Initializes a new instance of the class. + + The target type-alias for use in NLog configuration. + + + + Gets or sets a value indicating whether to the target is a wrapper target (used to generate the target summary documentation page). + + + + + Gets or sets a value indicating whether to the target is a compound target (used to generate the target summary documentation page). + + + + + Attribute details for + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The name of the attribute. + The layout of the attribute's value. + + + + Gets or sets the name of the attribute. + + + + + + Gets or sets the layout that will be rendered as the attribute's value. + + + + + + Gets or sets the type of the property. + + + + + + Gets or sets the fallback value when result value is not available + + + + + + Gets or sets when an empty value should cause the property to be included + + + + + + Render Result Value + + Log event for rendering + Result value when available, else fallback to defaultValue + + + + Represents target that supports context capture of Properties + Nested-states + + + See NLog Wiki + + + [Target("MyFirst")] + public sealed class MyFirstTarget : TargetWithContext + { + public MyFirstTarget() + { + this.Host = "localhost"; + } + + [RequiredParameter] + public Layout Host { get; set; } + + protected override void Write(LogEventInfo logEvent) + { + string logMessage = this.RenderLogEvent(this.Layout, logEvent); + string hostName = this.RenderLogEvent(this.Host, logEvent); + return SendTheMessageToRemoteHost(hostName, logMessage); + } + + private void SendTheMessageToRemoteHost(string hostName, string message) + { + // To be implemented + } + } + + Documentation on NLog Wiki + + + + + + + + Gets or sets the option to include all properties from the log events + + + + + + Gets or sets whether to include the contents of the properties-dictionary. + + + + + + Gets or sets whether to include the contents of the nested-state-stack. + + + + + + Obsolete and replaced by with NLog v5. + Gets or sets whether to include the contents of the -dictionary. + + + + + + Obsolete and replaced by with NLog v5. + Gets or sets whether to include the contents of the -stack. + + + + + + Obsolete and replaced by with NLog v5. + Gets or sets whether to include the contents of the -properties. + + + + + + Obsolete and replaced by with NLog v5. + Gets or sets whether to include the contents of the -stack. + + + + + + Gets or sets a value indicating whether to include contents of the dictionary + + + + + + Gets or sets a value indicating whether to include call site (class and method name) in the + + + + + + Gets or sets a value indicating whether to include source info (file name and line number) in the + + + + + + Gets the array of custom attributes to be passed into the logevent context + + + + + + List of property names to exclude when is true + + + + + + Constructor + + + + + Check if logevent has properties (or context properties) + + + True if properties should be included + + + + Checks if any context properties, and if any returns them as a single dictionary + + + Dictionary with any context properties for the logEvent (Null if none found) + + + + Checks if any context properties, and if any returns them as a single dictionary + + + Optional prefilled dictionary + Dictionary with any context properties for the logEvent (Null if none found) + + + + Creates combined dictionary of all configured properties for logEvent + + + Dictionary with all collected properties for logEvent + + + + Creates combined dictionary of all configured properties for logEvent + + + Optional prefilled dictionary + Dictionary with all collected properties for logEvent + + + + Generates a new unique name, when duplicate names are detected + + LogEvent that triggered the duplicate name + Duplicate item name + Item Value + Dictionary of context values + New (unique) value (or null to skip value). If the same value is used then the item will be overwritten + + + + Obsolete and replaced by with NLog v5. + Returns the captured snapshot of for the + + + Dictionary with MDC context if any, else null + + + + Returns the captured snapshot of dictionary for the + + + Dictionary with ScopeContext properties if any, else null + + + + Obsolete and replaced by with NLog v5. + Returns the captured snapshot of for the + + + Dictionary with MDLC context if any, else null + + + + Obsolete and replaced by with NLog v5. + Returns the captured snapshot of for the + + + Collection with NDC context if any, else null + + + + Returns the captured snapshot of nested states from for the + + + Collection of nested state objects if any, else null + + + + Obsolete and replaced by with NLog v5. + Returns the captured snapshot of for the + + + Collection with NDLC context if any, else null + + + + Takes snapshot of for the + + + Optional pre-allocated dictionary for the snapshot + Dictionary with GDC context if any, else null + + + + Obsolete and replaced by with NLog v5. + Takes snapshot of for the + + + Optional pre-allocated dictionary for the snapshot + Dictionary with MDC context if any, else null + + + + Obsolete and replaced by with NLog v5. + Take snapshot of a single object value from + + Log event + MDC key + MDC value + Snapshot of MDC value + Include object value in snapshot + + + + Obsolete and replaced by with NLog v5. + Takes snapshot of for the + + + Optional pre-allocated dictionary for the snapshot + Dictionary with MDLC context if any, else null + + + + Takes snapshot of dictionary for the + + + Optional pre-allocated dictionary for the snapshot + Dictionary with ScopeContext properties if any, else null + + + + Obsolete and replaced by with NLog v5. + Take snapshot of a single object value from + + Log event + MDLC key + MDLC value + Snapshot of MDLC value + Include object value in snapshot + + + + Take snapshot of a single object value from dictionary + + Log event + ScopeContext Dictionary key + ScopeContext Dictionary value + Snapshot of ScopeContext property-value + Include object value in snapshot + + + + Obsolete and replaced by with NLog v5. + Takes snapshot of for the + + + Collection with NDC context if any, else null + + + + Obsolete and replaced by with NLog v5. + Take snapshot of a single object value from + + Log event + NDC value + Snapshot of NDC value + Include object value in snapshot + + + + Obsolete and replaced by with NLog v5. + Takes snapshot of for the + + + Collection with NDLC context if any, else null + + + + Takes snapshot of nested states from for the + + + Collection with stack items if any, else null + + + + Obsolete and replaced by with NLog v5. + Take snapshot of a single object value from + + Log event + NDLC value + Snapshot of NDLC value + Include object value in snapshot + + + + Take snapshot of a single object value from nested states + + Log event + nested state value + Snapshot of stack item value + Include object value in snapshot + + + + Take snapshot of a single object value + + Log event + Key Name (null when NDC / NDLC) + Object Value + Snapshot of value + Include object value in snapshot + + + Internal Layout that allows capture of properties-dictionary + + + Internal Layout that allows capture of nested-states-stack + + + + Represents target that supports string formatting using layouts. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + + + + Gets or sets the layout used to format log messages. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + + + + + Represents target that supports string formatting using layouts. + + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + + + + Gets or sets the text to be rendered. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + + + + + Gets or sets the footer. + + + + + + Gets or sets the header. + + + + + + Gets or sets the layout with header and footer. + + The layout with header and footer. + + + + Sends log messages through System.Diagnostics.Trace. + + + See NLog Wiki + + Documentation on NLog Wiki + +

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ + + + + + Force use independent of + + + + + + Forward to (Instead of ) + + + Trace.Fail can have special side-effects, and give fatal exceptions, message dialogs or Environment.FailFast + + + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + + + + Initializes a new instance of the class. + + + The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true} + + Name of the target. + + + + + + + + + + Writes the specified logging event to the facility. + + Redirects the log message depending on and . + When is false: + - writes to + - writes to + - writes to + - writes to + - writes to + - writes to + + The logging event. + + + + Web service protocol. + + + + + Use SOAP 1.1 Protocol. + + + + + Use SOAP 1.2 Protocol. + + + + + Use HTTP POST Protocol. + + + + + Use HTTP GET Protocol. + + + + + Do an HTTP POST of a JSON document. + + + + + Do an HTTP POST of an XML document. + + + + + Web Service Proxy Configuration Type + + + + + Default proxy configuration from app.config (System.Net.WebRequest.DefaultWebProxy) + + + Example of how to configure default proxy using app.config + + <system.net> + <defaultProxy enabled = "true" useDefaultCredentials = "true" > + <proxy usesystemdefault = "True" /> + </defaultProxy> + </system.net> + + + + + + Automatic use of proxy with authentication (cached) + + + + + Disables use of proxy (fast) + + + + + Custom proxy address (cached) + + + + + Calls the specified web service on each log message. + + + See NLog Wiki + + Documentation on NLog Wiki + + The web service must implement a method that accepts a number of string parameters. + + +

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ +

The example web service that works with this example is shown below

+ + + + + + dictionary that maps a concrete implementation + to a specific -value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Name of the target + + + + Gets or sets the web service URL. + + + + + + Gets or sets the value of the User-agent HTTP header. + + + + + + Gets or sets the Web service method name. Only used with Soap. + + + + + + Gets or sets the Web service namespace. Only used with Soap. + + + + + + Gets or sets the protocol to be used when calling web service. + + + + + + Gets or sets the proxy configuration when calling web service + + + Changing ProxyType on Net5 (or newer) will turn off Http-connection-pooling + + + + + + Gets or sets the custom proxy address, include port separated by a colon + + + + + + Should we include the BOM (Byte-order-mark) for UTF? Influences the property. + + This will only work for UTF-8. + + + + + + Gets or sets the encoding. + + + + + + Gets or sets a value whether escaping be done according to Rfc3986 (Supports Internationalized Resource Identifiers - IRIs) + + A value of true if Rfc3986; otherwise, false for legacy Rfc2396. + + + + + Gets or sets a value whether escaping be done according to the old NLog style (Very non-standard) + + A value of true if legacy encoding; otherwise, false for standard UTF8 encoding. + + + + + Gets or sets the name of the root XML element, + if POST of XML document chosen. + If so, this property must not be null. + (see and ). + + + + + + Gets or sets the (optional) root namespace of the XML document, + if POST of XML document chosen. + (see and ). + + + + + + Gets the array of parameters to be passed. + + + + + + Indicates whether to pre-authenticate the HttpWebRequest (Requires 'Authorization' in parameters) + + + + + + Calls the target method. Must be implemented in concrete classes. + + Method call parameters. + + + + Calls the target DoInvoke method, and handles AsyncContinuation callback + + Method call parameters. + The continuation. + + + + Invokes the web service method. + + Parameters to be passed. + The logging event. + + + + + + + + + + Builds the URL to use when calling the web service for a message, depending on the WebServiceProtocol. + + + + + Write from input to output. Fix the UTF-8 bom + + + + + base class for POST formatters, that + implement former PrepareRequest() method, + that creates the content for + the requested kind of HTTP request + + + + + Win32 file attributes. + + + For more information see https://msdn.microsoft.com/library/default.asp?url=/library/en-us/fileio/fs/createfile.asp. + + + + + Read-only file. + + + + + Hidden file. + + + + + System file. + + + + + File should be archived. + + + + + Device file. + + + + + Normal file. + + + + + File is temporary (should be kept in cache and not + written to disk if possible). + + + + + Sparse file. + + + + + Reparse point. + + + + + Compress file contents. + + + + + File should not be indexed by the content indexing service. + + + + + Encrypted file. + + + + + The system writes through any intermediate cache and goes directly to disk. + + + + + The system opens a file with no system caching. + + + + + Delete file after it is closed. + + + + + A file is accessed according to POSIX rules. + + + + + Asynchronous request queue. + + + + + Initializes a new instance of the AsyncRequestQueue class. + + Request limit. + The overflow action. + + + + Gets the number of requests currently in the queue. + + + + + Enqueues another item. If the queue is overflown the appropriate + action is taken as specified by . + + The log event info. + Queue was empty before enqueue + + + + Dequeues a maximum of count items from the queue + and adds returns the list containing them. + + Maximum number of items to be dequeued + The array of log events. + + + + Dequeues into a preallocated array, instead of allocating a new one + + Maximum number of items to be dequeued + Preallocated list + + + + Clears the queue. + + + + + Gets or sets the request limit. + + + + + Gets or sets the action to be taken when there's no more room in + the queue and another request is enqueued. + + + + + Occurs when LogEvent has been dropped, because internal queue is full and set to + + + + + Occurs when internal queue size is growing, because internal queue is full and set to + + + + + Raise event when queued element was dropped because of queue overflow + + Dropped queue item + + + + Raise event when RequestCount overflow + + current requests count + + + + Provides asynchronous, buffered execution of target writes. + + + See NLog Wiki + + Documentation on NLog Wiki + +

+ Asynchronous target wrapper allows the logger code to execute more quickly, by queuing + messages and processing them in a separate thread. You should wrap targets + that spend a non-trivial amount of time in their Write() method with asynchronous + target to speed up logging. +

+

+ Because asynchronous logging is quite a common scenario, NLog supports a + shorthand notation for wrapping all targets with AsyncWrapper. Just add async="true" to + the <targets/> element in the configuration file. +

+ + + ... your targets go here ... + + ]]> + + +

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Name of the target. + The wrapped target. + + + + Initializes a new instance of the class. + + The wrapped target. + + + + Initializes a new instance of the class. + + The wrapped target. + Maximum number of requests in the queue. + The action to be taken when the queue overflows. + + + + Gets or sets the number of log events that should be processed in a batch + by the lazy writer thread. + + + + + + Gets or sets the time in milliseconds to sleep between batches. (1 or less means trigger on new activity) + + + + + + Occurs when LogEvent has been dropped, because internal queue is full and set to + + + + + Occurs when internal queue size is growing, because internal queue is full and set to + + + + + Gets or sets the action to be taken when the lazy writer thread request queue count + exceeds the set limit. + + + + + + Gets or sets the limit on the number of requests in the lazy writer thread request queue. + + + + + + Gets or sets the number of batches of to write before yielding into + + + Performance is better when writing many small batches, than writing a single large batch + + + + + + Gets or sets whether to use the locking queue, instead of a lock-free concurrent queue + + + The locking queue is less concurrent when many logger threads, but reduces memory allocation + + + + + + Gets the queue of lazy writer thread requests. + + + + + Schedules a flush of pending events in the queue (if any), followed by flushing the WrappedTarget. + + The asynchronous continuation. + + + + Initializes the target by starting the lazy writer timer. + + + + + Shuts down the lazy writer timer. + + + + + Starts the lazy writer thread which periodically writes + queued log messages. + + + + + Attempts to start an instant timer-worker-thread which can write + queued log messages. + + Returns true when scheduled a timer-worker-thread + + + + Stops the lazy writer thread. + + + + + Adds the log event to asynchronous queue to be processed by + the lazy writer thread. + + The log event. + + The is called + to ensure that the log event can be processed in another thread. + + + + + Write to queue without locking + + + + + + The action to be taken when the queue overflows. + + + + + Grow the queue. + + + + + Discard the overflowing item. + + + + + Block until there's more room in the queue. + + + + + Causes a flush on a wrapped target if LogEvent satisfies the . + If condition isn't set, flushes on each write. + + + See NLog Wiki + + Documentation on NLog Wiki + +

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ + + + + + Gets or sets the condition expression. Log events who meet this condition will cause + a flush on the wrapped target. + + + + + + Delay the flush until the LogEvent has been confirmed as written + + If not explicitly set, then disabled by default for and AsyncTaskTarget + + + + + + Only flush when LogEvent matches condition. Ignore explicit-flush, config-reload-flush and shutdown-flush + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The wrapped target. + Name of the target + + + + Initializes a new instance of the class. + + The wrapped target. + + + + + + + Forwards the call to the .Write() + and calls on it if LogEvent satisfies + the flush condition or condition is null. + + Logging event to be written out. + + + + Schedules a flush operation, that triggers when all pending flush operations are completed (in case of asynchronous targets). + + The asynchronous continuation. + + + + + + + A target that buffers log events and sends them in batches to the wrapped target. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Name of the target. + The wrapped target. + + + + Initializes a new instance of the class. + + The wrapped target. + + + + Initializes a new instance of the class. + + The wrapped target. + Size of the buffer. + + + + Initializes a new instance of the class. + + The wrapped target. + Size of the buffer. + The flush timeout. + + + + Initializes a new instance of the class. + + The wrapped target. + Size of the buffer. + The flush timeout. + The action to take when the buffer overflows. + + + + Gets or sets the number of log events to be buffered. + + + + + + Gets or sets the timeout (in milliseconds) after which the contents of buffer will be flushed + if there's no write in the specified period of time. Use -1 to disable timed flushes. + + + + + + Gets or sets a value indicating whether to use sliding timeout. + + + This value determines how the inactivity period is determined. If sliding timeout is enabled, + the inactivity timer is reset after each write, if it is disabled - inactivity timer will + count from the first event written to the buffer. + + + + + + Gets or sets the action to take if the buffer overflows. + + + Setting to will replace the + oldest event with new events without sending events down to the wrapped target, and + setting to will flush the + entire buffer to the wrapped target. + + + + + + Flushes pending events in the buffer (if any), followed by flushing the WrappedTarget. + + The asynchronous continuation. + + + + + + + Closes the target by flushing pending events in the buffer (if any). + + + + + Adds the specified log event to the buffer and flushes + the buffer in case the buffer gets full. + + The log event. + + + + The action to be taken when the buffer overflows. + + + + + Flush the content of the buffer. + + + + + Discard the oldest item. + + + + + A base class for targets which wrap other (multiple) targets + and provide various forms of target routing. + + + + + Initializes a new instance of the class. + + The targets. + + + + Gets the collection of targets managed by this compound target. + + + + + + + + + + + Flush any pending log messages for all wrapped targets. + + The asynchronous continuation. + + + + Concurrent Asynchronous request queue based on + + + + + Initializes a new instance of the AsyncRequestQueue class. + + Request limit. + The overflow action. + + + + Gets the number of requests currently in the queue. + + + Only for debugging purposes + + + + + Enqueues another item. If the queue is overflown the appropriate + action is taken as specified by . + + The log event info. + Queue was empty before enqueue + + + + Dequeues a maximum of count items from the queue + and adds returns the list containing them. + + Maximum number of items to be dequeued + The array of log events. + + + + Dequeues into a preallocated array, instead of allocating a new one + + Maximum number of items to be dequeued + Preallocated list + + + + Clears the queue. + + + + + Provides fallback-on-error. + + + See NLog Wiki + + Documentation on NLog Wiki + +

This example causes the messages to be written to server1, + and if it fails, messages go to server2.

+

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Name of the target. + The targets. + + + + Initializes a new instance of the class. + + The targets. + + + + Gets or sets a value indicating whether to return to the first target after any successful write. + + + + + + Gets or sets whether to enable batching, but fallback will be handled individually + + + + + + Forwards the log event to the sub-targets until one of them succeeds. + + The log event. + + + + + + + Forwards the log event to the sub-targets until one of them succeeds. + + + + + Filtering rule for . + + + + + Initializes a new instance of the FilteringRule class. + + + + + Initializes a new instance of the FilteringRule class. + + Condition to be tested against all events. + Filter to apply to all log events when the first condition matches any of them. + + + + Gets or sets the condition to be tested. + + + + + + Gets or sets the resulting filter to be applied when the condition matches. + + + + + + Filters log entries based on a condition. + + + See NLog Wiki + + Documentation on NLog Wiki + +

This example causes the messages not contains the string '1' to be ignored.

+

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Name of the target. + The wrapped target. + The condition. + + + + Initializes a new instance of the class. + + The wrapped target. + The condition. + + + + Gets or sets the condition expression. Log events who meet this condition will be forwarded + to the wrapped target. + + + + + + Gets or sets the filter. Log events who evaluates to will be discarded + + + + + + Checks the condition against the passed log event. + If the condition is met, the log event is forwarded to + the wrapped target. + + Log event. + + + + + + + A target that buffers log events and sends them in batches to the wrapped target. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Identifier to perform group-by + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The wrapped target. + + + + Initializes a new instance of the class. + + The name of the target. + The wrapped target. + + + + Initializes a new instance of the class. + + The name of the target. + The wrapped target. + Group by identifier. + + + + + + + + + + Limits the number of messages written per timespan to the wrapped target. + + + See NLog Wiki + + Documentation on NLog Wiki + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The name of the target. + The wrapped target. + + + + Initializes a new instance of the class. + + The wrapped target. + + + + Initializes a new instance of the class. + + The wrapped target. + Maximum number of messages written per interval. + Interval in which the maximum number of messages can be written. + + + + Gets or sets the maximum allowed number of messages written per . + + + Messages received after has been reached in the current will be discarded. + + + + + + Gets or sets the interval in which messages will be written up to the number of messages. + + + Messages received after has been reached in the current will be discarded. + + + + + + Gets the number of written in the current . + + + + + + Initializes the target and resets the current Interval and . + + + + + Writes log event to the wrapped target if the current is lower than . + If the is already reached, no log event will be written to the wrapped target. + resets when the current is expired. + + Log event to be written out. + + + + Arguments for events. + + + + + Initializes a new instance of the class. + + LogEvent that have been dropped + + + + Instance of that was dropped by + + + + + Raises by when + queue is full + and set to + By default queue doubles it size. + + + + + Initializes a new instance of the class. + + Required queue size + Current queue size + + + + New queue size + + + + + Current requests count + + + + + Filters buffered log entries based on a set of conditions that are evaluated on a group of events. + + + See NLog Wiki + + Documentation on NLog Wiki + +

+ This example works like this. If there are no Warn,Error or Fatal messages in the buffer + only Info messages are written to the file, but if there are any warnings or errors, + the output includes detailed trace (levels >= Debug). +

+

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Name of the target. + The wrapped target. + + + + Gets or sets the default filter to be applied when no specific rule matches. + + + + + + Gets the collection of filtering rules. The rules are processed top-down + and the first rule that matches determines the filtering condition to + be applied to log events. + + + + + + + + + Evaluates all filtering rules to find the first one that matches. + The matching rule determines the filtering condition to be applied + to all items in a buffer. If no condition matches, default filter + is applied to the array of log events. + + Array of log events to be post-filtered. + + + + Evaluate all the rules to get the filtering condition + + + + + + + Sends log messages to a randomly selected target. + + + See NLog Wiki + + Documentation on NLog Wiki + +

This example causes the messages to be written to either file1.txt or file2.txt + chosen randomly on a per-message basis. +

+

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Name of the target. + The targets. + + + + Initializes a new instance of the class. + + The targets. + + + + Forwards the log event to one of the sub-targets. + The sub-target is randomly chosen. + + The log event. + + + + Repeats each log event the specified number of times. + + + See NLog Wiki + + Documentation on NLog Wiki + +

This example causes each log message to be repeated 3 times.

+

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Name of the target. + The wrapped target. + The repeat count. + + + + Initializes a new instance of the class. + + The wrapped target. + The repeat count. + + + + Gets or sets the number of times to repeat each log message. + + + + + + Forwards the log message to the by calling the method times. + + The log event. + + + + Retries in case of write error. + + + See NLog Wiki + + Documentation on NLog Wiki + +

This example causes each write attempt to be repeated 3 times, + sleeping 1 second between attempts if first one fails.

+

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Name of the target. + The wrapped target. + The retry count. + The retry delay milliseconds. + + + + Initializes a new instance of the class. + + The wrapped target. + The retry count. + The retry delay milliseconds. + + + + Gets or sets the number of retries that should be attempted on the wrapped target in case of a failure. + + + + + + Gets or sets the time to wait between retries in milliseconds. + + + + + + Gets or sets whether to enable batching, and only apply single delay when a whole batch fails + + + + + + Special SyncObject to allow closing down Target while busy retrying + + + + + Writes the specified log event to the wrapped target, retrying and pausing in case of an error. + + The log event. + + + + Writes the specified log event to the wrapped target in a thread-safe manner. + + The log event. + + + + Writes the specified log event to the wrapped target, retrying and pausing in case of an error. + + The log event. + + + + Distributes log events to targets in a round-robin fashion. + + + See NLog Wiki + + Documentation on NLog Wiki + +

This example causes the messages to be written to either file1.txt or file2.txt. + Each odd message is written to file2.txt, each even message goes to file1.txt. +

+

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Name of the target. + The targets. + + + + Initializes a new instance of the class. + + The targets. + + + + Ensures forwarding happens without holding lock + + + + + + Forwards the write to one of the targets from + the collection. + + The log event. + + The writes are routed in a round-robin fashion. + The first log event goes to the first target, the second + one goes to the second target and so on looping to the + first target when there are no more targets available. + In general request N goes to Targets[N % Targets.Count]. + + + + + Writes log events to all targets. + + + See NLog Wiki + + Documentation on NLog Wiki + +

This example causes the messages to be written to both file1.txt or file2.txt +

+

+ To set up the target in the configuration file, + use the following syntax: +

+ +

+ To set up the log target programmatically use code like this: +

+ + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Name of the target. + The targets. + + + + Initializes a new instance of the class. + + The targets. + + + + Forwards the specified log event to all sub-targets. + + The log event. + + + + Writes an array of logging events to the log target. By default it iterates on all + events and passes them to "Write" method. Inheriting classes can use this method to + optimize batch writes. + + Logging events to be written out. + + + + Base class for targets wrap other (single) targets. + + + + + Gets or sets the target that is wrapped by this target. + + + + + + + + + + + + Writes logging event to the log target. Must be overridden in inheriting + classes. + + Logging event to be written out. + + + + Builtin IFileCompressor implementation utilizing the .Net4.5 specific + and is used as the default value for on .Net4.5. + So log files created via can be zipped when archived + w/o 3rd party zip library when run on .Net4.5 or higher. + + + + + Implements using the .Net4.5 specific + + + + + Current local time retrieved directly from DateTime.Now. + + + + + Gets current local time directly from DateTime.Now. + + + + + Converts the specified system time to the same form as the time value originated from this time source. + + The system originated time value to convert. + + The value of converted to local time. + + + + + Current UTC time retrieved directly from DateTime.UtcNow. + + + + + Gets current UTC time directly from DateTime.UtcNow. + + + + + Converts the specified system time to the same form as the time value originated from this time source. + + The system originated time value to convert. + + The value of converted to UTC time. + + + + + Fast time source that updates current time only once per tick (15.6 milliseconds). + + + + + Gets raw uncached time from derived time source. + + + + + Gets current time cached for one system tick (15.6 milliseconds). + + + + + Fast local time source that is updated once per tick (15.6 milliseconds). + + + + + Gets uncached local time directly from DateTime.Now. + + + + + Converts the specified system time to the same form as the time value originated from this time source. + + The system originated time value to convert. + + The value of converted to local time. + + + + + Fast UTC time source that is updated once per tick (15.6 milliseconds). + + + + + Gets uncached UTC time directly from DateTime.UtcNow. + + + + + Converts the specified system time to the same form as the time value originated from this time source. + + The system originated time value to convert. + + The value of converted to UTC time. + + + + + Defines source of current time. + + + + + Gets current time. + + + + + Gets or sets current global time source used in all log events. + + + Default time source is . + + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Converts the specified system time to the same form as the time value originated from this time source. + + The system originated time value to convert. + + The value of converted to the same form + as time values originated from this source. + + + + There are situations when NLog have to compare the time originated from TimeSource + to the time originated externally in the system. + To be able to provide meaningful result of such comparisons the system time must be expressed in + the same form as TimeSource time. + + + Examples: + - If the TimeSource provides time values of local time, it should also convert the provided + to the local time. + - If the TimeSource shifts or skews its time values, it should also apply + the same transform to the given . + + + + + + Marks class as a time source and assigns a name to it. + + + + + Initializes a new instance of the class. + + The Time type-alias for use in NLog configuration. + + + + Indicates that the value of the marked element could be null sometimes, + so checking for null is required before its usage. + + + [CanBeNull] object Test() => null; + + void UseTest() { + var p = Test(); + var s = p.ToString(); // Warning: Possible 'System.NullReferenceException' + } + + + + + Indicates that the value of the marked element can never be null. + + + [NotNull] object Foo() { + return null; // Warning: Possible 'null' assignment + } + + + + + Can be applied to symbols of types derived from IEnumerable as well as to symbols of Task + and Lazy classes to indicate that the value of a collection item, of the Task.Result property + or of the Lazy.Value property can never be null. + + + public void Foo([ItemNotNull]List<string> books) + { + foreach (var book in books) { + if (book != null) // Warning: Expression is always true + Console.WriteLine(book.ToUpper()); + } + } + + + + + Can be applied to symbols of types derived from IEnumerable as well as to symbols of Task + and Lazy classes to indicate that the value of a collection item, of the Task.Result property + or of the Lazy.Value property can be null. + + + public void Foo([ItemCanBeNull]List<string> books) + { + foreach (var book in books) + { + // Warning: Possible 'System.NullReferenceException' + Console.WriteLine(book.ToUpper()); + } + } + + + + + Indicates that the marked method builds string by the format pattern and (optional) arguments. + The parameter, which contains the format string, should be given in the constructor. The format string + should be in -like form. + + + [StringFormatMethod("message")] + void ShowError(string message, params object[] args) { /* do something */ } + + void Foo() { + ShowError("Failed: {0}"); // Warning: Non-existing argument in format string + } + + + + + Specifies which parameter of an annotated method should be treated as the format string + + + + + Indicates that the marked parameter is a message template where placeholders are to be replaced by the following arguments + in the order in which they appear + + + void LogInfo([StructuredMessageTemplate]string message, params object[] args) { /* do something */ } + + void Foo() { + LogInfo("User created: {username}"); // Warning: Non-existing argument in format string + } + + + + + Use this annotation to specify a type that contains static or const fields + with values for the annotated property/field/parameter. + The specified type will be used to improve completion suggestions. + + + namespace TestNamespace + { + public class Constants + { + public static int INT_CONST = 1; + public const string STRING_CONST = "1"; + } + + public class Class1 + { + [ValueProvider("TestNamespace.Constants")] public int myField; + public void Foo([ValueProvider("TestNamespace.Constants")] string str) { } + + public void Test() + { + Foo(/*try completion here*/);// + myField = /*try completion here*/ + } + } + } + + + + + Indicates that the integral value falls into the specified interval. + It's allowed to specify multiple non-intersecting intervals. + Values of interval boundaries are inclusive. + + + void Foo([ValueRange(0, 100)] int value) { + if (value == -1) { // Warning: Expression is always 'false' + ... + } + } + + + + + Indicates that the integral value never falls below zero. + + + void Foo([NonNegativeValue] int value) { + if (value == -1) { // Warning: Expression is always 'false' + ... + } + } + + + + + Indicates that the function argument should be a string literal and match + one of the parameters of the caller function. This annotation is used for parameters + like 'string paramName' parameter of the constructor. + + + void Foo(string param) { + if (param == null) + throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol + } + + + + + Indicates that the method is contained in a type that implements + System.ComponentModel.INotifyPropertyChanged interface and this method + is used to notify that some property value changed. + + + The method should be non-static and conform to one of the supported signatures: + + NotifyChanged(string) + NotifyChanged(params string[]) + NotifyChanged{T}(Expression{Func{T}}) + NotifyChanged{T,U}(Expression{Func{T,U}}) + SetProperty{T}(ref T, T, string) + + + + public class Foo : INotifyPropertyChanged { + public event PropertyChangedEventHandler PropertyChanged; + + [NotifyPropertyChangedInvocator] + protected virtual void NotifyChanged(string propertyName) { ... } + + string _name; + + public string Name { + get { return _name; } + set { _name = value; NotifyChanged("LastName"); /* Warning */ } + } + } + + Examples of generated notifications: + + NotifyChanged("Property") + NotifyChanged(() => Property) + NotifyChanged((VM x) => x.Property) + SetProperty(ref myField, value, "Property") + + + + + + Describes dependency between method input and output. + + +

Function Definition Table syntax:

+ + FDT ::= FDTRow [;FDTRow]* + FDTRow ::= Input => Output | Output <= Input + Input ::= ParameterName: Value [, Input]* + Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} + Value ::= true | false | null | notnull | canbenull + + If the method has a single input parameter, its name could be omitted.
+ Using halt (or void/nothing, which is the same) for the method output + means that the method doesn't return normally (throws or terminates the process).
+ Value canbenull is only applicable for output parameters.
+ You can use multiple [ContractAnnotation] for each FDT row, or use single attribute + with rows separated by the semicolon. There is no notion of order rows, all rows are checked + for applicability and applied per each program state tracked by the analysis engine.
+ + + + [ContractAnnotation("=> halt")] + public void TerminationMethod() + + + [ContractAnnotation("null <= param:null")] // reverse condition syntax + public string GetName(string surname) + + + [ContractAnnotation("s:null => true")] + public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() + + + // A method that returns null if the parameter is null, + // and not null if the parameter is not null + [ContractAnnotation("null => null; notnull => notnull")] + public object Transform(object data) + + + [ContractAnnotation("=> true, result: notnull; => false, result: null")] + public bool TryParse(string s, out Person result) + + + + + + Indicates whether the marked element should be localized. + + + [LocalizationRequiredAttribute(true)] + class Foo { + string str = "my string"; // Warning: Localizable string + } + + + + + Indicates that the value of the marked type (or its derivatives) + cannot be compared using '==' or '!=' operators and Equals() + should be used instead. However, using '==' or '!=' for comparison + with null is always permitted. + + + [CannotApplyEqualityOperator] + class NoEquality { } + + class UsesNoEquality { + void Test() { + var ca1 = new NoEquality(); + var ca2 = new NoEquality(); + if (ca1 != null) { // OK + bool condition = ca1 == ca2; // Warning + } + } + } + + + + + When applied to a target attribute, specifies a requirement for any type marked + with the target attribute to implement or inherit specific type or types. + + + [BaseTypeRequired(typeof(IComponent)] // Specify requirement + class ComponentAttribute : Attribute { } + + [Component] // ComponentAttribute requires implementing IComponent interface + class MyComponent : IComponent { } + + + + + Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library), + so this symbol will be ignored by usage-checking inspections.
+ You can use and + to configure how this attribute is applied. + + + [UsedImplicitly] + public class TypeConverter {} + + public class SummaryData + { + [UsedImplicitly(ImplicitUseKindFlags.InstantiatedWithFixedConstructorSignature)] + public SummaryData() {} + } + + [UsedImplicitly(ImplicitUseTargetFlags.WithInheritors | ImplicitUseTargetFlags.Default)] + public interface IService {} + + + + + Can be applied to attributes, type parameters, and parameters of a type assignable from . + When applied to an attribute, the decorated attribute behaves the same as . + When applied to a type parameter or to a parameter of type , + indicates that the corresponding type is used implicitly. + + + + + Specifies the details of implicitly used symbol when it is marked + with or . + + + + Only entity marked with attribute considered used. + + + Indicates implicit assignment to a member. + + + + Indicates implicit instantiation of a type with fixed constructor signature. + That means any unused constructor parameters won't be reported as such. + + + + Indicates implicit instantiation of a type. + + + + Specifies what is considered to be used implicitly when marked + with or . + + + + Members of the type marked with the attribute are considered used. + + + Inherited entities are considered used. + + + Entity marked with the attribute and all its members considered used. + + + + This attribute is intended to mark publicly available API, + which should not be removed and so is treated as used. + + + + + Tells the code analysis engine if the parameter is completely handled when the invoked method is on stack. + If the parameter is a delegate, indicates that delegate can only be invoked during method execution + (the delegate can be invoked zero or multiple times, but not stored to some field and invoked later, + when the containing method is no longer on the execution stack). + If the parameter is an enumerable, indicates that it is enumerated while the method is executed. + If is true, the attribute will only takes effect if the method invocation is located under the 'await' expression. + + + + + Require the method invocation to be used under the 'await' expression for this attribute to take effect on code analysis engine. + Can be used for delegate/enumerable parameters of 'async' methods. + + + + + Indicates that a method does not make any observable state changes. + The same as System.Diagnostics.Contracts.PureAttribute. + + + [Pure] int Multiply(int x, int y) => x * y; + + void M() { + Multiply(123, 42); // Warning: Return value of pure method is not used + } + + + + + Indicates that the return value of the method invocation must be used. + + + Methods decorated with this attribute (in contrast to pure methods) might change state, + but make no sense without using their return value.
+ Similarly to , this attribute + will help to detect usages of the method when the return value is not used. + Optionally, you can specify a message to use when showing warnings, e.g. + [MustUseReturnValue("Use the return value to...")]. + + + + + This annotation allows to enforce allocation-less usage patterns of delegates for performance-critical APIs. + When this annotation is applied to the parameter of delegate type, IDE checks the input argument of this parameter: + * When lambda expression or anonymous method is passed as an argument, IDE verifies that the passed closure + has no captures of the containing local variables and the compiler is able to cache the delegate instance + to avoid heap allocations. Otherwise the warning is produced. + * IDE warns when method name or local function name is passed as an argument as this always results + in heap allocation of the delegate instance. + + + In C# 9.0 code IDE would also suggest to annotate the anonymous function with 'static' modifier + to make use of the similar analysis provided by the language/compiler. + + + + + Indicates the type member or parameter of some type, that should be used instead of all other ways + to get the value of that type. This annotation is useful when you have some "context" value evaluated + and stored somewhere, meaning that all other ways to get this value must be consolidated with existing one. + + + class Foo { + [ProvidesContext] IBarService _barService = ...; + + void ProcessNode(INode node) { + DoSomething(node, node.GetGlobalServices().Bar); + // ^ Warning: use value of '_barService' field + } + } + + + + + Indicates that a parameter is a path to a file or a folder within a web project. + Path can be relative or absolute, starting from web root (~). + + + + + An extension method marked with this attribute is processed by code completion + as a 'Source Template'. When the extension method is completed over some expression, its source code + is automatically expanded like a template at call site. + + + Template method body can contain valid source code and/or special comments starting with '$'. + Text inside these comments is added as source code when the template is applied. Template parameters + can be used either as additional method parameters or as identifiers wrapped in two '$' signs. + Use the attribute to specify macros for parameters. + + + In this example, the 'forEach' method is a source template available over all values + of enumerable types, producing ordinary C# 'foreach' statement and placing caret inside block: + + [SourceTemplate] + public static void forEach<T>(this IEnumerable<T> xs) { + foreach (var x in xs) { + //$ $END$ + } + } + + + + + + Allows specifying a macro for a parameter of a source template. + + + You can apply the attribute on the whole method or on any of its additional parameters. The macro expression + is defined in the property. When applied on a method, the target + template parameter is defined in the property. To apply the macro silently + for the parameter, set the property value = -1. + + + Applying the attribute on a source template method: + + [SourceTemplate, Macro(Target = "item", Expression = "suggestVariableName()")] + public static void forEach<T>(this IEnumerable<T> collection) { + foreach (var item in collection) { + //$ $END$ + } + } + + Applying the attribute on a template method parameter: + + [SourceTemplate] + public static void something(this Entity x, [Macro(Expression = "guid()", Editable = -1)] string newguid) { + /*$ var $x$Id = "$newguid$" + x.ToString(); + x.DoSomething($x$Id); */ + } + + + + + + Allows specifying a macro that will be executed for a source template + parameter when the template is expanded. + + + + + Allows specifying which occurrence of the target parameter becomes editable when the template is deployed. + + + If the target parameter is used several times in the template, only one occurrence becomes editable; + other occurrences are changed synchronously. To specify the zero-based index of the editable occurrence, + use values >= 0. To make the parameter non-editable when the template is expanded, use -1. + + + + + Identifies the target parameter of a source template if the + is applied on a template method. + + + + + Indicates how method, constructor invocation, or property access + over collection type affects the contents of the collection. + When applied to a return value of a method indicates if the returned collection + is created exclusively for the caller (CollectionAccessType.UpdatedContent) or + can be read/updated from outside (CollectionAccessType.Read | CollectionAccessType.UpdatedContent) + Use to specify the access type. + + + Using this attribute only makes sense if all collection methods are marked with this attribute. + + + public class MyStringCollection : List<string> + { + [CollectionAccess(CollectionAccessType.Read)] + public string GetFirstString() + { + return this.ElementAt(0); + } + } + class Test + { + public void Foo() + { + // Warning: Contents of the collection is never updated + var col = new MyStringCollection(); + string x = col.GetFirstString(); + } + } + + + + + Provides a value for the to define + how the collection method invocation affects the contents of the collection. + + + + Method does not use or modify content of the collection. + + + Method only reads content of the collection but does not modify it. + + + Method can change content of the collection but does not add new elements. + + + Method can add new elements to the collection. + + + + Indicates that the marked method is assertion method, i.e. it halts the control flow if + one of the conditions is satisfied. To set the condition, mark one of the parameters with + attribute. + + + + + Indicates the condition parameter of the assertion method. The method itself should be + marked by attribute. The mandatory argument of + the attribute is the assertion type. + + + + + Specifies assertion type. If the assertion method argument satisfies the condition, + then the execution continues. Otherwise, execution is assumed to be halted. + + + + Marked parameter should be evaluated to true. + + + Marked parameter should be evaluated to false. + + + Marked parameter should be evaluated to null value. + + + Marked parameter should be evaluated to not null value. + + + + Indicates that the marked method unconditionally terminates control flow execution. + For example, it could unconditionally throw exception. + + + + + Indicates that the method is a pure LINQ method, with postponed enumeration (like Enumerable.Select, + .Where). This annotation allows inference of [InstantHandle] annotation for parameters + of delegate type by analyzing LINQ method chains. + + + + + Indicates that IEnumerable passed as a parameter is not enumerated. + Use this annotation to suppress the 'Possible multiple enumeration of IEnumerable' inspection. + + + static void ThrowIfNull<T>([NoEnumeration] T v, string n) where T : class + { + // custom check for null but no enumeration + } + + void Foo(IEnumerable<string> values) + { + ThrowIfNull(values, nameof(values)); + var x = values.ToList(); // No warnings about multiple enumeration + } + + + + + Indicates that the marked parameter, field, or property is a regular expression pattern. + + + + + Language of injected code fragment inside marked by string literal. + + + + + Indicates that the marked parameter, field, or property is accepting a string literal + containing code fragment in a language specified by the . + + + void Foo([LanguageInjection(InjectedLanguage.CSS, Prefix = "body{", Suffix = "}")] string cssProps) + { + // cssProps should only contains a list of CSS properties + } + + + + Specify a language of injected code fragment. + + + Specify a string that "precedes" injected string literal. + + + Specify a string that "follows" injected string literal. + + + + Prevents the Member Reordering feature from tossing members of the marked class. + + + The attribute must be mentioned in your member reordering patterns. + + + + + Initializes a new instance of the class + with the specified member types. + + The types of members dynamically accessed. + + + + Gets the which specifies the type + of members dynamically accessed. + + + + + Specifies the types of members that are dynamically accessed. + + This enumeration has a attribute that allows a + bitwise combination of its member values. + + + + + Specifies no members. + + + + + Specifies the default, parameterless public constructor. + + + + + Specifies all public constructors. + + + + + Specifies all non-public constructors. + + + + + Specifies all public methods. + + + + + Specifies all non-public methods. + + + + + Specifies all public fields. + + + + + Specifies all non-public fields. + + + + + Specifies all public nested types. + + + + + Specifies all non-public nested types. + + + + + Specifies all public properties. + + + + + Specifies all non-public properties. + + + + + Specifies all public events. + + + + + Specifies all non-public events. + + + + + Specifies all interfaces implemented by the type. + + + + + Specifies all members. + + + + + Suppresses reporting of a specific rule violation, allowing multiple suppressions on a + single code artifact. + + + is different than + in that it doesn't have a + . So it is always preserved in the compiled assembly. + + + + + Initializes a new instance of the + class, specifying the category of the tool and the identifier for an analysis rule. + + The category for the attribute. + The identifier of the analysis rule the attribute applies to. + + + + Gets the category identifying the classification of the attribute. + + + The property describes the tool or tool analysis category + for which a message suppression attribute applies. + + + + + Gets the identifier of the analysis tool rule to be suppressed. + + + Concatenated together, the and + properties form a unique check identifier. + + + + + Gets or sets the scope of the code that is relevant for the attribute. + + + The Scope property is an optional argument that specifies the metadata scope for which + the attribute is relevant. + + + + + Gets or sets a fully qualified path that represents the target of the attribute. + + + The property is an optional argument identifying the analysis target + of the attribute. An example value is "System.IO.Stream.ctor():System.Void". + Because it is fully qualified, it can be long, particularly for targets such as parameters. + The analysis tool user interface should be capable of automatically formatting the parameter. + + + + + Gets or sets an optional argument expanding on exclusion criteria. + + + The property is an optional argument that specifies additional + exclusion where the literal metadata target is not sufficiently precise. For example, + the cannot be applied within a method, + and it may be desirable to suppress a violation against a statement in the method that will + give a rule violation, but not against all statements in the method. + + + + + Gets or sets the justification for suppressing the code analysis message. + + + + diff --git a/ZZPDFTest/bin/Debug/Newtonsoft.Json.dll b/ZZPDFTest/bin/Debug/Newtonsoft.Json.dll new file mode 100644 index 00000000..341d08fc Binary files /dev/null and b/ZZPDFTest/bin/Debug/Newtonsoft.Json.dll differ diff --git a/ZZPDFTest/bin/Debug/Newtonsoft.Json.xml b/ZZPDFTest/bin/Debug/Newtonsoft.Json.xml new file mode 100644 index 00000000..2c981abf --- /dev/null +++ b/ZZPDFTest/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/ZZPDFTest/bin/Debug/OfficePrinter.dll b/ZZPDFTest/bin/Debug/OfficePrinter.dll new file mode 100644 index 00000000..f3cb9b7b Binary files /dev/null and b/ZZPDFTest/bin/Debug/OfficePrinter.dll differ diff --git a/ZZPDFTest/bin/Debug/OfficePrinter.pdb b/ZZPDFTest/bin/Debug/OfficePrinter.pdb new file mode 100644 index 00000000..19e3f197 Binary files /dev/null and b/ZZPDFTest/bin/Debug/OfficePrinter.pdb differ diff --git a/ZZPDFTest/bin/Debug/OnDocOffice.dll b/ZZPDFTest/bin/Debug/OnDocOffice.dll new file mode 100644 index 00000000..64ddb38b Binary files /dev/null and b/ZZPDFTest/bin/Debug/OnDocOffice.dll differ diff --git a/ZZPDFTest/bin/Debug/OnDocOffice.pdb b/ZZPDFTest/bin/Debug/OnDocOffice.pdb new file mode 100644 index 00000000..bdc13a34 Binary files /dev/null and b/ZZPDFTest/bin/Debug/OnDocOffice.pdb differ diff --git a/ZZPDFTest/bin/Debug/Pdfium/x86/pdfium.dll b/ZZPDFTest/bin/Debug/Pdfium/x86/pdfium.dll new file mode 100644 index 00000000..a5f92eba Binary files /dev/null and b/ZZPDFTest/bin/Debug/Pdfium/x86/pdfium.dll differ diff --git a/ZZPDFTest/bin/Debug/QRCoder.dll b/ZZPDFTest/bin/Debug/QRCoder.dll new file mode 100644 index 00000000..c33a1fa8 Binary files /dev/null and b/ZZPDFTest/bin/Debug/QRCoder.dll differ diff --git a/ZZPDFTest/bin/Debug/Syncfusion.DocIO.Base.dll b/ZZPDFTest/bin/Debug/Syncfusion.DocIO.Base.dll new file mode 100644 index 00000000..460b7eeb Binary files /dev/null and b/ZZPDFTest/bin/Debug/Syncfusion.DocIO.Base.dll differ diff --git a/ZZPDFTest/bin/Debug/Syncfusion.DocIO.Base.xml b/ZZPDFTest/bin/Debug/Syncfusion.DocIO.Base.xml new file mode 100644 index 00000000..388a1083 --- /dev/null +++ b/ZZPDFTest/bin/Debug/Syncfusion.DocIO.Base.xml @@ -0,0 +1,166873 @@ + + + + Syncfusion.DocIO.Base + + + + + + Contains utility methods for object cloning. + + + + + Clones int array. + + Array to clone + Returns cloned array. + + + + Clones ushort array. + + Array to clone. + Returns cloned array. + + + + Clones string array. + + Array to clone. + Returns cloned array. + + + + Clones object array. + + Array to clone. + Returns cloned array. + + + + Clones object that implements ICloneable interface. + + Object to clone. + A clone of the object. + + + + Clones byte array. + + Array to clone. + Return cloned array. + + + + Clone Dictionary. + + Dictionary to clone + Returns a copy of the Dictionary. + + + + Clone Dictionary. + + Dictionary to clone + Returns a copy of the Dictionary. + + + + Creates copy of the stream. + + Stream to copy. + Created stream. + + + + Summary description for DocumentPropertyImpl. + + + + + Represents single document property. + + + + + Indicates whether property is built-in. Read-only. + + + + + Returns property id for built-in properties. Read-only. + + + + + Returns property name. Read-only. + + + + + Gets / sets property value. + + + + + Gets / sets boolean value. + + + + + Gets / sets integer value. + + + + + Gets / sets 4-bytes signed integer value. + + + + + Gets / sets double value. + + + + + Gets / sets string value. + + + + + Gets / sets DateTime value. + + + + + Gets / sets TimeSpan value. + + + + + Returns or sets the source of a linked custom document property. Read/write String. + + + + + True if the value of the custom document property is linked to the content + of the container document. False if the value is static. Read/write Boolean. + + + + + Start index for Id2 PropVariant property. + + + + + Start year for FILETIME structure. + + + + + Property id. + + + + + Property name. + + + + + Property value. + + + + + Property type. + + + + + The source of a linked custom document property. Read/write String. + + + + + True if the value of the custom document property is linked to the content + of the container document. False if the value is static. Read/write Boolean. + + + + + Default constructor. + + + + + Initializes new instance of the class. + + Property name. + Property value. + + + + Initializes new instance of the class. + + Property id. + Property value. + + + + Initializes new instance of the document property. + + Variant that contains property data. + + Indicates whether property is from document summary or not (only for + built-int properties). + + + + Detects type of the string. + + String value to check. + Detected string type. + + + + Copies document property data into PropVariant. + + Destination object. + PropertyId for custom properties. + True if was able to fill variant; false otherwise. + + + + Converts propertyId into correct index. + + PropertyId to convert. + [out] Indicates whether this is document summary property of simply document property. + Correct property index. + + + + Tries to detect and set property type. + + + + + Sets value of LinkSource property. + + Variant that contains value to set. + + + + Saves property into IPropertyStorage. + + Storage to save into. + Property variant used as buffer. + Property id for custom properties. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Creates copy of the internal value. + + + + + Indicates whether property is built-in. Read-only. + + + + + Returns / sets property id for built-in properties. + + + + + Returns property name. Read-only. + + + + + Gets / sets property value. + + + + + Gets / sets boolean value. + + + + + Gets / sets integer value. + + + + + Gets / sets 4-bytes signed integer value. + + + + + Gets / sets double value. + + + + + Gets / sets string value. + + + + + Gets / sets DateTime value. + + + + + Gets / sets TimeSpan value. + + + + + Gets / sets Blob value. + + + + + Gets or sets clipboard data value. + + + + + Gets / sets array of strings. + + + + + Gets / sets array of objects. Supported object types are string and Int32. + + + + + Gets / sets document property type. + + + + + Returns or sets the source of a linked custom document property. Read/write String. + + + + + True if the value of the custom document property is linked to the content of the container document. False if the value is static. Read/write Boolean. + + + + + Internal name of the document property. + + + + + Property IDs for the SummaryInformation Property Set. + + + + + Title document property Id. + + + + + Subject document property Id. + + + + + Author document property Id. + + + + + Keywords document property Id. + + + + + Comments document property Id. + + + + + Template document property Id. + + + + + LastAuthor document property Id. + + + + + Revnumber document property Id. + + + + + EditTime document property Id. + + + + + LastPrinted document property Id. + + + + + CreationDate document property Id. + + + + + LastSaveDate document property Id. + + + + + PageCount document property Id. + + + + + WordCount document property Id. + + + + + CharCount document property Id. + + + + + Thumbnail document property Id. + + + + + ApplicationName document property Id. + + + + + Ssecurity document property Id. + + + + + Category Id. + + + + + Target format for presentation (35mm, printer, video, and so on) id. + + + + + ByteCount Id. + + + + + LineCount Id. + + + + + ParCount Id. + + + + + SlideCount Id. + + + + + NoteCount Id. + + + + + HiddenCount Id. + + + + + MmclipCount Id. + + + + + ScaleCrop property Id. + + + + + HeadingPair Id. + + + + + DocParts Id. + + + + + Manager Id. + + + + + Company Id. + + + + + LinksDirty Id. + + + + + The character count with space + + + + + Enumeration with all supported property types. + + + + + Indicates a Boolean value. + + + + + Indicates an integer value. + + + + + Indicates a 4-bytes signed integer value. + + + + + Indicates a 2-bytes signed interger value. + + + + + Indicates a 4-bytes unsigned interger value. + + + + + Indicates a wide string terminated by a null. + + + + + Indicates a string terminated by a null. + + + + + Indicates a FILETIME value. + + + + + Indicates length prefixed bytes. + + + + + Indicates a simple, counted array. + + + + + Indicates an object. + + + + + Indicates a double value. + + + + + Indicates an empty value. + + + + + Indicates null value. + + + + + Indicates clipboard data. + + + + + Indicates an array of strings. + + + + + Indicates an array of strings. + + + + + Indicates an array of objects. Supported types are string and integer values. + + + + + This interface represents stream in the compound file. + + + + + Name of the stream. + + + + + Initializes new instance of the compound stream object. + + Name of the stream. + + + + Copies stream content into another stream object. + + Stream to copy data into. + + + + Returns name of the stream. + + + + + This interface gives access to compound file functionality. + + + + + Flushes content into internal buffer. + + + + + Saves compound file into stream + + Stream to save data into. + + + + Saves compound file into file. + + Name of the file to save into. + + + + Returns root storage object for this file. + + + + + Gets the directory. + + The directory. + + + + This interface represents storage object in the compound file. + + + + + Creates new stream inside this storage. + + Name of the stream to create. + Created stream object. + + + + Opens existing stream inside this storage. + + Name of the stream to open. + + + + + Removes existing stream from this storage. + + Name of the stream to remove. + + + + Determines whether storage contains specified stream. + + Name of the stream to check. + true if storage contains specified stream. + + + + Creates new substorage inside this one. + + Name of the storage to create. + Created storage object. + + + + Opens existing substorage inside this one. + + Name of the storage to open. + Created storage object. + + + + Removes exisiting substorage from this one. + + Name of the storage to remove. + + + + Determines whether this storage contains substorage with specified name. + + Name of the storage to check. + true if storage contains substorage with specified name. + + + + Commits changes. + + + + + Inserts copy of the storage and all subitems inside current storage. + + Storage to copy. + + + + Inserts copy of the stream inside current storage. + + Stream to copy. + + + + Returns all stream names that are placed inside this stream. + + + + + Returns all storage names that are placed inside this stream. + + + + + Returns name of the storage. + + + + + This exception should be thrown when lock or share violation has occured. + Usually this happens when user tries to create storage on file opened by somebody else. + + + + + Default message. + + + + + Message for exception message with record code. + + + + + Initializes a new instance of the class with default error message. + + + + + Initializes a new instance of the class with a specified error message. + + Error message. + + + + Initializes a new instance of the Exception 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. + If the innerException parameter is not a NULL reference + (Nothing in Visual Basic), the current exception is raised + in a catch block that handles the inner exception. + + + + + Special wrapper class that allows users to control access to stream + and cache data. + + + + + Default buffer allocation size. + + + + + Underlying stream. Close sets _s to NULL. + + + + + Shared read / write buffer. Allocated on first use. + + + + + Read pointer within shared buffer. + + + + + Number of bytes read in buffer from _s. + + + + + Write pointer within shared buffer. + + + + + Length of internal buffer if it is allocated. + + + + + Stream position when the buffer is read. + + + + + Default constructor. Hidden to class users. + + + + + Initialize class by stream and DefaultBufferSize == 4096. + + Stream which our class must wrap. + + + + Initialize class by instance of stream and user defined cache size. + + Stream which our class must wrap. + User defined cache size. + Stream does not support Read and Write operations. + BufferSize is equal or less than zero. + + + + Reads data from the stream. If data is cached, the class will not call wrapped + stream and will simply return a copy of cached data. + + Output buffer. + Offset in output buffer where data from stream must be placed. + Count of bytes which class must return. + Quantity of read bytes. + + + + Reads a byte from the underlying stream. Returns an int (byte cast to an int) + or -1 if it is the end of the stream. + + Read byte. + + + + Writes portion of data into a wrapped stream. Data will be cached if it is possible. + It will then be saved to the wrapped stream on Flush. + + Array containing data. + Offset to the beginning of the portion of data. + Number of bytes in the portion of data. + + If array or stream is NULL. + + + If offset or count is less than zero. + + + If array does not contain the required element count. + + + + + Write one byte of information into stream. + + Value which must be written. + + If stream is NULL. + + + If can't write into stream. + + + + + On any Seek operation, data not written from cache will be + flushed to the wrapped stream. Using the Position property is better as + it is optimized for cache use. + + New offset of stream. + Start point of seek operation. + Current position. + + If stream is NULL. + + + If can't seek in the stream. + + + + + Saves all the data from cache and closes the stream. + + + + + Flushes data and resets the cache. + + + When stream is NULL. + + + + + The file is read in blocks, but a user could read 1 byte + from the buffer and write it. At that point, the Operating System's file + pointer is out of sync with the stream's position. Hence, all write + functions should call this function to preserve the position in the file. + + + + + Since Write is buffered, any time the buffer fills up + or the buffer switches to reading and there is dirty data + (_writePos > 0), this function must be called. + + + + + Sets length of wrapped stream. + + New length of stream. + + When value is less than zero. + + + When stream is NULL. + + + Cannot seek or cannot write into stream. + + + + + Indicates whether data can be read from the wrapped stream. + True if data can be read. + + Class instance was disposed. + + + + Indicates whether data can be written to wrapped stream. + + Class instance was disposed. + + + + Indicates whether the wrapped stream supports Seek operations. + + Class instance was disposed. + + + + Gets length of the wrapped stream. When this property is accessed, the data + that is not written to the stream is first flushed. + + Class instance was disposed. + + + + Gets the current position of stream. Position can be different from the value in wrapped + stream, because wrapped stream will point to the last byte of the + cached data. When this property is set, the data that is not written is flushed to the stream. + + Class instance was disposed. + Wrapped stream does not support seek operation. + + + + Get reference of stream wrapped by BufferStreamEx. + + + + + This is compound file implementation based on standard COM-objects. + + + + + Root storage. + + + + + Represents the locking bytes. + + + + + Default constructor. Creates native compound file in memory. + + + + + Creates new instance of the compound file based on the specified stream. + + Stream to extract data from. + + + + Creates new instance of the compound file based on the file name and open flags. + + Name of the file to parse. + Storage options. + + + + Flushes all internal buffers. + + + + + Cretes storage on ILockBytes. + + Created storage. + + + + Saves internal ILockBytes into stream. + + Stream to save into. + + + + Opens specified stream. + + Stream to open. + + + + Saves compound file into stream + + Stream to save data into. + + + + Saves compound file into file. + + Name of the file to save into. + + + + Frees all allocated resources. + + + + + Gets the directory + + + + + Returns root storage object for this file. + + + + + Summary description for ILockBytes. + + + + + The ReadAt method reads a specified number of bytes + starting at a specified offset from the beginning of the byte array object. + + Specifies the starting point from the beginning + of the byte array for reading data. + Pointer to the buffer into which the byte array is read. + The size of this buffer is contained in cb. + Specifies the number of bytes of data to attempt to read + from the byte array. + Pointer to a ULONG where this method writes the actual + number of bytes read from the byte array. You can set this pointer to NULL + to indicate that you are not interested in this value. In this case, this + method does not provide the actual number of bytes that were read. + S_OK - Indicates that the specified number of bytes were read, or the + maximum number of bytes were read to the end of the byte array. + E_FAIL - Data could not be read from the byte array. + E_PENDING - Asynchronous Storage only: Part or all of the data to be + read is currently unavailable. + STG_E_ACCESSDENIED - The caller does not have permission to access the byte array. + STG_E_READFAULT - The number of bytes to be read does not equal the number of bytes + that were actually read + + + + The WriteAt method writes the specified number of bytes starting at a specified offset + from the beginning of the byte array. + + Specifies the starting point from + the beginning of the byte array for the data to be written. + Pointer to the buffer containing the data to be written. + Specifies the number of bytes of data to attempt to write into + the byte array. + Pointer to a location where this method specifies the + actual number of bytes written to the byte array. You can set this pointer to + NULL to indicate that you are not interested in this value. In this case, this + method does not provide the actual number of bytes written. + S_OK - Indicates that the specified number of bytes were written. + E_FAIL - A general failure occurred during the write operation. + E_PENDING - Asynchronous Storage only: Part or all of the data to be + written is currently unavailable. + STG_E_ACCESSDENIED - The caller does not have enough permissions for writing + this byte array. + STG_E_WRITEFAULT - The number of bytes to be written does not equal the number + of bytes that were actually written. + STG_E_MEDIUMFULL - The write operation was not completed because there is no + space left on the storage device. The actual number of bytes written is still + returned in pcbWritten. + + + + The Flush method ensures that any internal buffers maintained by the ILockBytes + implementation are written out to the underlying physical storage. + + S_OK - The flush operation was successful. + STG_E_ACCESSDENIED - The caller does not have permission to access the byte array. + STG_E_MEDIUMFULL - The flush operation is not completed because there is no space + left on the storage device. + E_FAIL - General failure writing data. + STG_E_TOOMANYFILESOPEN - Under certain circumstances, the Flush method executes + a download-and-closeto flush, which can lead to a return value of + STG_E_TOOMANYFILESOPEN if no file handles are available. + STG_E_INVALIDHANDLE - An underlying file has been prematurely closed, or the + correct floppy disk has been replaced by an invalid one. + + + + The SetSize method changes the size of the byte array. + + Specifies the new size of the byte array as a number of bytes. + S_OK - The size of the byte array was successfully changed. + STG_E_ACCESSDENIED - The caller does not have permission to access the byte array. + STG_E_MEDIUMFULL - The byte array size is not changed because there is no + space left on the storage device. + + + + The LockRegion method restricts access to a specified range of bytes in the byte array. + + Specifies the byte offset for the beginning of the range. + Specifies, in bytes, the length of the range to be restricted. + Specifies the type of restrictions being requested on + accessing the range. This parameter uses one of the values from the LOCKTYPE enumeration. + S_OK - The specified range of bytes was locked + STG_E_INVALIDFUNCTION - Locking is not supported at all or the specific type of lock + requested is not supported. + STG_E_ACCESSDENIED - Access denied because the caller has insufficient permission, + or another caller has the file open and locked. + STG_E_LOCKVIOLATION - Access denied because another caller has the file open and locked. + STG_E_INVALIDHANDLE - An underlying file has been prematurely closed, or the + correct floppy disk has been replaced by an invalid one + + + + The UnlockRegion method removes the access restriction on a previously + locked range of bytes. + + Specifies the byte offset for the beginning of the range. + Specifies, in bytes, the length of the range that is restricted. + Specifies the type of access restrictions previously + placed on the range. This parameter uses a value from the LOCKTYPE enumeration. + S_OK - The byte range was unlocked. + STG_E_INVALIDFUNCTION - Locking is not supported at all or the specific type + of lock requested is not supported. + STG_E_LOCKVIOLATION The requested unlock cannot be granted. + + + + + The Stat method retrieves a STATSTG structure containing information for + this byte array object. + + Pointer to a STATSTG structure in which this method + places information about this byte array object. The pointer is NULL if + an error occurs. + Specifies whether this method should supply the + pwcsName member of the STATSTG structure through values taken from the + STATFLAG enumeration. If the STATFLAG_NONAME is specified, the pwcsName + member of STATSTG is not supplied, thus saving a memory-allocation operation. + The other possible value, STATFLAG_DEFAULT, indicates that all members of the + STATSTG structure be supplied. + S_OK - The STATSTG structure was successfully returned at + the specified location. + E_OUTOFMEMORY - The STATSTG structure was not returned due to a lack of memory + for the name member in the structure. + STG_E_ACCESSDENIED - The STATSTG structure was not returned because the caller + did not have access to the byte array. + STG_E_INSUFFICIENTMEMORY - The STATSTG structure was not returned, due to + insufficient memory. + STG_E_INVALIDFLAG - The value for the grfStateFlag parameter is not valid. + STG_E_INVALIDPOINTER - The value for the pStatStg parameter is not valid. + + + + + Implementation of compound stream based on standard COM object. + + + + + + + + + + Stream position. + + + + + Initializes new instance of the stream object. + + COM stream to use. + Name of the stream. + + + + Reads a sequence of bytes from the current stream and advances the position + within the stream by the number of bytes read. + + An array of bytes. When this method returns, the buffer contains + the specified byte array with the values between offset and (offset + count - 1) + replaced by the bytes read from the current source. + The zero-based byte offset in buffer at which to begin storing + the data read from the current stream. + The maximum number of bytes to be read from the current stream. + The total number of bytes read into the buffer. This can be less + than the number of bytes requested if that many bytes are not currently + available, or zero (0) if the end of the stream has been reached. + + + + Writes a sequence of bytes to the current stream and advances the current position + within this stream by the number of bytes written. + + An array of bytes. This method copies length bytes from buffer to the current stream. + The zero-based byte offset in buffer at which to begin copying bytes to the current stream. + The number of bytes to be written to the current stream. + + + + Sets the position within the current stream. + + A byte offset relative to the origin parameter. + A value of type SeekOrigin indicating the reference point used to obtain the new position. + The new position within the current stream. + + + + Sets the length of the current stream. + + The desired length of the current stream in bytes. + + + + Clears all buffers for this stream and causes any buffered data to be + written to the underlying device. + + + + + Releases the unmanaged resources used by the Stream and optionally releases the managed resources. + + true to release both managed and unmanaged resources; + false to release only unmanaged resources. + + + + Checks whether offset and length can be fit inside specified buffer. + + Buffer to check. + Offset to check. + Length to check. + + + + Gets the length in bytes of the stream. + + + + + Gets or sets the position within the current stream. + + + + + Gets a value indicating whether the current stream supports reading. + + + + + Gets a value indicating whether the current stream supports writing. + + + + + Gets a value indicating whether the current stream supports seeking. + + + + + The STGTY enumeration values are used in the type member of the STATSTG + structure to indicate the type of the storage element. + + + + + Indicates that the storage element is a storage object. + + + + + Indicates that the storage element is a stream object. + + + + + Indicates that the storage element is a byte-array object. + + + + + Indicates that the storage element is a property storage object. + + + + + The STREAM_SEEK enumeration values specify the origin from which to + calculate the new seek-pointer location. + + + + + The new seek pointer is an offset relative to the beginning of + the stream. In this case, the dlibMove parameter is the new seek + position relative to the beginning of the stream. + + + + + The new seek pointer is an offset relative to the current seek + pointer location. In this case, the dlibMove parameter is the + signed displacement from the current seek position. + + + + + The new seek pointer is an offset relative to the end of the stream. + In this case, the dlibMove parameter is the new seek position + relative to the end of the stream. + + + + + The LOCKTYPE enumeration values indicate the type of locking requested + for the specified range of bytes. + + + + + If this lock is granted, the specified range of bytes can be opened + and read any number of times, but writing to the locked range is + prohibited except for the owner who granted this lock. + + + + + If this lock is granted, writing to the specified range of bytes is + prohibited except by the owner granted this lock. + + + + + If this lock is granted, no other LOCK_ONLYONCE lock can be obtained + on the range. Usually this lock type is an alias for some other lock + type. Thus, specific implementations can have additional behavior + associated with this lock type. + + + + + The STGM enumeration values are used in the IStorage, IStream, and + IPropertySetStorage interfaces. These elements are often combined + using an OR operator. + + + + + Indicates that the object is read-only, meaning that modifications + cannot be made. + + + + + STGM_WRITE lets you save changes to the object, but does not permit + access to its data. + + + + + STGM_READWRITE allows you to both access and modify an object's data. + + + + + Specifies that subsequent openings of the object are not denied read + or write access. If no flag from the sharing group is specified, + this flag is assumed. + + + + + Prevents others from subsequently opening the object in STGM_READ mode. + It is typically used on a root storage object. + + + + + Prevents others from subsequently opening the object for STGM_WRITE + or STGM_READWRITE access. + + + + + Prevents others from subsequently opening the object in any mode. In + transacted mode, sharing of STGM_SHARE_DENY_WRITE or STGM_SHARE_EXCLUSIVE + can significantly improve performance since they don't require snapshotting. + + + + + Opens the storage object with exclusive access to the most recently + committed version. + + + + + Indicates that an existing storage object or stream should be removed + before the new one replaces it. + + + + + Creates the new object while preserving existing data in a stream + named "Contents". + + + + + Causes the create operation to fail if an existing object with the + specified name exists. + + + + + In direct mode, each change to a storage or stream element is + written as it occurs. + + + + + In transacted mode, changes are buffered and written only if an + explicit commit operation is called. + + + + + In transacted mode, a temporary scratch file is usually used to + save modifications until the Commit method is called. + + + + + This flag is used when opening a storage object with STGM_TRANSACTED + and without STGM_SHARE_EXCLUSIVE or STGM_SHARE_DENY_WRITE. + + + + + STGM_SIMPLE is a mode that provides a much faster implementation of + a compound file in a limited, but frequently used case. + + + + + The STGM_DIRECT_SWMR supports direct mode for single-writer, + multireader file operations. + + + + + Indicates that the underlying file is to be automatically destroyed + when the root storage object is released. + + + + + The STGFMT enumeration values specify the format of a storage object + and are used in the StgCreateStorageEx and StgOpenStorageEx functions + in the STGFMT parameter. + + + + + Indicates that the file must be a compound file. + + + + + Indicates that the file must not be a compound file. + + + + + Indicates that the system will determine the file type and use the + appropriate structured storage or property set implementation. + + + + + Indicates that the file must be a compound file and is similar to + the STGFMT_STORAGE flag, but indicates that the compound-file form + of the compound-file implementation must be used. + + + + + Error code which StgOpenStorage method can return after execution. + + + + + Success code. + + + + + Filed. + + + + + Access Denied. + + + + + File already exists. + + + + + File could not be found. + + + + + There is insufficient memory available to complete operation. + + + + + Invalid flag error. + + + + + Unable to perform requested operation. + + + + + Attempted an operation on an invalid object. + + + + + The name is not valid. + + + + + Invalid pointer error. + + + + + A lock violation has occurred. + + + + + The compound file was not created with the STGM_SIMPLE flag. + + + + + The compound file was produced with a newer version of storage. + + + + + The compound file was produced with an incompatible version of storage. + + + + + The path could not be found. + + + + + A share violation has occurred. + + + + + There are insufficient resources to open another file. + + + + + The STGC enumeration constants specify the conditions for performing + the commit operation in the IStorage::Commit and IStream::Commit methods. + + + + + You can specify this condition with STGC_CONSOLIDATE or some + combination of the other three flags in this list of elements. + + + + + The commit operation can overwrite existing data to reduce overall + space requirements. + + + + + Prevents multiple users of a storage object from overwriting each + other's changes. + + + + + Commits the changes to a write-behind disk cache, but does not save + the cache to the disk. + + + + + Microsoft Windows 2000/XP: Indicates that a storage should be + consolidated after it is committed, resulting in a smaller file on disk. + + + + + Property IDs for the SummaryInformation Property Set. + + + + + Title Id. + + + + + Subject Id. + + + + + Author Id. + + + + + Keywords Id. + + + + + Comments Id. + + + + + Template Id. + + + + + LastAuthor Id. + + + + + Revnumber Id. + + + + + EditTime Id. + + + + + LastPrinted Id. + + + + + Create_dtm Id. + + + + + LastSave_dtm Id. + + + + + Pagecount Id. + + + + + Wordcount Id. + + + + + Charcount Id. + + + + + Thumbnail Id. + + + + + Appname Id. + + + + + Doc_security Id. + + + + + Property IDs for the DocSummaryInformation Property Set. + + + + + Category Id. + + + + + PresFormat Id. + + + + + ByteCount Id. + + + + + LineCount Id. + + + + + ParCount Id. + + + + + SlideCount Id. + + + + + NoteCount Id. + + + + + HiddenCount Id. + + + + + MmclipCount Id. + + + + + Scale Id. + + + + + HeadingPair Id. + + + + + DocParts Id. + + + + + Manager Id. + + + + + Company Id. + + + + + LinksDirty Id. + + + + + Reserved global Property IDs. + + + + + PID_DICTIONARY Id. + + + + + PID_CODEPAGE Id. + + + + + PID_FIRST_USABLE Id. + + + + + PID_FIRST_NAME_DEFAULT Id. + + + + + PID_LOCALE Id. + + + + + PID_MODIFY_TIME Id. + + + + + PID_SECURITY Id. + + + + + PID_BEHAVIOR Id. + + + + + PID_ILLEGAL Id. + + + + + PID_MIN_READONLY Id. + + + + + PID_MAX_READONLY Id. + + + + + PRSPEC property ids. + + + + + INVALID Id. + + + + + LPWSTR Id. + + + + + PROPID Id. + + + + + The STATSTG structure contains statistical information about an open storage, + stream, or byte-array object. + + + + + Pointer to a NULL-terminated Unicode string containing the name. + Space for this string is allocated by the method called and freed by the caller + + + + + Indicates the type of storage object. This is one of the + values from the STGTY enumeration. + + + + + Specifies the size in bytes of the stream or byte array. + + + + + Indicates the last modification time for this storage, stream, or byte array. + + + + + Indicates the creation time for this storage, stream, or byte array. + + + + + Indicates the last access time for this storage, stream or byte array. + + + + + Indicates the access mode specified when the object was opened. + This member is only valid in calls to Stat methods. + + + + + Indicates the types of region locking supported by the stream or byte array. + See the LOCKTYPE enumeration for the values available. + This member is not used for storage objects. + + + + + Indicates the class identifier for the storage object; set to CLSID_NULL for new storage objects. + This member is not used for streams or byte arrays. + + + + + Indicates the current state bits of the storage object; that is, the value most + recently set by the IStorage::SetStateBits method. + This member is not valid for streams or byte arrays. + + + + + Reserved for future use. + + + + + Structure that is used by STG API. + + + + + Structure that is used by STG API. + + + + + uint parameter. + + + + + uint parameter. + + + + + OLECHAR parameter. + + + + + Macros for parsing the OS Version of the Property Set Header. + + + + + Time in UTC when this property set was last accessed. + + + + + CLSID associated with this property set, specified when the property set was initially created + and possibly modified thereafter with IPropertyStorage::SetClass. If not set, the value will be CLSID_NULL. + + + + + Time in UTC when this property set was created. + + + + + Os vorsion. + + + + + FMTID of the current property set, specified when the property set was initially created. + + + + + Flag values of the property set, as specified in IPropertySetStorage::Create. + + + + + Time in Universal Coordinated Time (UTC) when the property set was last modified. + + + + + + The STATPROPSTG structure contains data about a single property in a property set. + This data is the property ID and type tag, and the optional string name that may be associated with the property. + + + + + A wide-character null-terminated Unicode string that contains the optional string name + associated with the property. May be NULL. + + + + + A 32-bit identifier that uniquely identifies the property within the property set. + All properties within property sets must have unique property identifiers. + + + + + The property type. + + + + + The PROPSPEC structure is used by many of the methods of IPropertyStorage to specify a + property either by its property identifier (ID) or the associated string name. + + + + + Indicates the union member used. This member can be one of the following values. + + + + + Specifies the value of the property ID. Use either this value or the following lpwstr, not both. + + + + + This enumeration is used in VARIANT, TYPEDESC, OLE property sets, and safe arrays. + + + + + Variable type is not specified. + + + + + Variable type is 4-byte signed INT. + + + + + Variable type is date. + + + + + Variable type is binary string. + + + + + Variable type is Boolean; True=-1, False=0. + + + + + Variable type is VARIANT FAR*. + + + + + Variable type is int. + + + + + Variable type is LPSTR. + + + + + Variable type is LPWSTR + + + + + Variable type is FILENAME string. + + + + + Variable type is binary VECTOR. + + + + + The IEnumSTATSTG interface enumerates an array of STATSTG structures. + These structures contain statistical data about open storage, stream, or byte array objects. + IEnumSTATSTG has the same methods as all enumerator interfaces: Next, Skip, Reset, and Clone. + + + + + The Next method retrieves a specified number of STATSTG structures, + that follow subsequently in the enumeration sequence. + If there are fewer than the requested number of STATSTG structures left + in the enumeration sequence, it retrieves the remaining STATSTG structures. + + The number of STATSTG structures requested. + An array of STATSTG structures returned. + The number of STATSTG structures retrieved in the rgelt parameter. + S_OK - The number of STATSTG structures returned equals the number + specified in the celt parameter. + S_FALSE - The number of STATSTG structures returned is less than the number + specified in the celt parameter. + + + + The Skip method skips a specified number of STATSTG structures in the enumeration sequence. + + The number of STATSTG structures to skip. + S_OK - The specified number of STATSTG structures were successfully skipped. + S_FALSE - The number of STATSTG structures skipped is less than the celt parameter. + + + + The Reset method resets the enumeration sequence to the beginning of the STATSTG structure array. + + S_OK - The enumeration sequence was successfully reset to the + beginning of the enumeration. + + + + The Clone method creates a new enumerator that contains the same enumeration state as + the current STATSTG structure enumerator. Using this method, a client can record a + particular point in the enumeration sequence and then return to that point at a later time. + The new enumerator supports the same IEnumSTATSTG interface. + + A pointer to the variable that receives the IEnumSTATSTG interface pointer. + If the method is unsuccessful, the value of the ppenum parameter is undefined. + E_INVALIDARG - The ppenum parameter is NULL. + E_OUTOFMEMORY - Insufficient memory. + E_UNEXPECTED - An unexpected exception occurred. + + + + For more information, refer to documentation on MSDN for interface with the same name. + + + + + Reads a specified number of bytes from the stream object into memory starting + at the current seek pointer. + + [out] Pointer to the buffer into which the stream data is read. + [in] Specifies the number of bytes of data to attempt to read + from the stream object. + [out] Pointer to a ULONG variable that receives the actual + number of bytes read from the stream object. You can set this pointer to NULL to + indicate that you are not interested in this value. In this case, this method + does not provide the actual number of bytes read. + + S_OK + Data was successfully read from the stream object. + S_FALSE + The data could not be read from the stream object. + E_PENDING + Asynchronous storage only: Part or all of the data to be read is currently unavailable. For more information, see IFillLockBytes and Asynchronous Storage. + STG_E_ACCESSDENIED + The caller does not have enough permissions for reading this stream object. + STG_E_INVALIDPOINTER + One of the pointer values is not valid. + STG_E_REVERTED + The object has been invalidated by a revert operation above it in the transaction tree. + + + + + Writes a specified number of bytes into the stream object starting at the + current seek pointer. + + [in] Pointer to the buffer containing the data that is to be + written to the stream. A valid pointer must be provided for this parameter even + when cb is zero. + [in] The number of bytes of data to attempt to write into the + stream. Can be zero. + [out] Pointer to a ULONG variable where this method + writes the actual number of bytes written to the stream object. The caller can + set this pointer to NULL, in which case this method does not provide the actual + number of bytes written. + + S_OK + The data was successfully written to the stream object. + E_PENDING + Asynchronous Storage only: Part or all of the data to be written is currently + unavailable. For more information, see IFillLockBytes and Asynchronous Storage. + STG_E_MEDIUMFULL + The write operation was not completed because there is no space left on the storage + device. + STG_E_ACCESSDENIED + The caller does not have enough permissions for writing to this stream object. + STG_E_CANTSAVE + Data cannot be written for reasons other than improper access or insufficient space. + STG_E_INVALIDPOINTER + One of the pointer values is not valid. The pv parameter must contain a valid pointer + even if cb is zero. + STG_E_REVERTED + The object has been invalidated by a revert operation above it in the transaction tree. + STG_E_WRITEFAULT + The write operation was not completed due to a disk error. This value is also returned + when this method attempts to write to a stream that was opened in simple mode (using + the STGM_SIMPLE flag). + + + + + Changes the seek pointer to a new location relative to the beginning of + the stream, the end of the stream, or the current seek pointer. + + [in] Displacement to be added to the location indicated by + the dwOrigin parameter. If dwOrigin is STREAM_SEEK_SET, this is interpreted as an + unsigned value rather than a signed value. + [in] Specifies the origin for the displacement specified in + dlibMove. The origin can be the beginning of the file, the current seek pointer, + or the end of the file. See the STREAM_SEEK enumeration for the values. + [out] Pointer to the location where this method writes + the value of the new seek pointer from the beginning of the stream. You can set this + pointer to NULL to indicate that you are not interested in this value. In this case, + this method does not provide the new seek pointer. + + S_OK + The seek pointer has been successfully adjusted. + E_PENDING + Asynchronous Storage only: Part or all of the stream's data is currently unavailable. + For more information, see IFillLockBytes and Asynchronous Storage. + STG_E_INVALIDPOINTER + Indicates that the [out] parameter plibNewPosition points to invalid memory, because + plibNewPosition is not read. + STG_E_INVALIDFUNCTION + The dwOrigin parameter contains an invalid value or the dlibMove parameter contains + a bad offset value. For example, the result of the seek pointer is a negative offset + value. + STG_E_REVERTED + The object has been invalidated by a revert operation above it in the transaction tree. + + + + + Changes the size of the stream object. + + [in] Specifies the new size of the stream as a number + of bytes. + + + + + Copies a specified number of bytes from the current seek pointer in the stream to + the current seek pointer in another stream. + + [in] Pointer to the destination stream. The stream pointed to + by pstm can be a new stream or a clone of the source stream. + [in] Specifies the number of bytes to copy from the source + stream. + [out] Pointer to the location where this method writes the + actual number of bytes read from the source. You can set this pointer to NULL to + indicate that you are not interested in this value. In this case, this method + does not provide the actual number of bytes read. + [out] Pointer to the location where this method writes + the actual number of bytes written to the destination. You can set this pointer + to NULL to indicate that you are not interested in this value. In this case, + this method does not provide the actual number of bytes written. + + + + + Ensures that any changes made to a stream object open in transacted mode + are reflected in the parent storage. If the stream object is open in direct + mode, IStream::Commit has no effect other than flushing all memory buffers + to the next-level storage object. The COM compound file implementation of + streams does not support opening streams in transacted mode. + + [in] Controls how the changes for the stream + object are committed. See the STGC enumeration for a definition of these + values. + + + + + Discards all changes that have been made to a transacted stream since the + last call to IStream::Commit. + + + + + + Restricts access to a specified range of bytes in the stream. Supporting + this functionality is optional since some file systems do not provide it. + + + + + + + + + Removes the access restriction on a range of bytes previously restricted + with IStream::LockRegion. + + + + + + + + + Retrieves the STATSTG structure for this stream. + + + + + + + + Creates a new stream object that references the same bytes as the original + stream but provides a separate seek pointer to those bytes. + + + + + + + Call the methods of IStorage to manage substorages or streams within the current storage. + This management includes creating, opening, or destroying substorages or streams, + as well as managing aspects such as time stamps, names, and so forth. + + + + + The CreateStream method creates and opens a stream object with the specified + name contained in this storage object. All elements within a storage objects, + both streams and other storage objects, are kept in the same name space. + + A pointer to a wide character null-terminated Unicode + string that contains the name of the newly created stream. The name can be used + later to open or reopen the stream. The name must not exceed 31 characters in + length, not including the string terminator. The 000 through 01f characters, + serving as the first character of the stream/storage name, are reserved for use by OLE. + This is a compound file restriction, not a structured storage restriction. + Specifies the access mode to use when opening the newly + created stream. For more information and descriptions of the possible values, + see STGM Constants. + Reserved for future use; must be zero. + Reserved for future use; must be zero. + On return, pointer to the location of the new IStream interface pointer. + This is only valid if the operation is successful. + When an error occurs, this parameter is set to NULL. + + S_OK - The new stream was successfully created. + E_PENDING - Asynchronous Storage only: Part or all of the + necessary data is currently unavailable. For more information, + see IFillLockBytes and Asynchronous Storage. + STG_E_ACCESSDENIED - Not enough permissions to create stream. + STG_E_FILEALREADYEXISTS - The name specified for the stream already exists in the storage + object and the grfMode parameter includes the value STGM_FAILIFTHERE. + STG_E_INSUFFICIENTMEMORY - The stream was not created due to a lack of memory. + STG_E_INVALIDFLAG - The value specified for the grfMode parameter is not a valid STGM Constants value. + STG_E_INVALIDFUNCTION - The specified combination of flags in the grfMode parameter is not supported; + for example, when this method is called without the STGM_SHARE_EXCLUSIVE flag. + STG_E_INVALIDNAME - Invalid value for pwcsName. + STG_E_INVALIDPOINTER - The pointer specified for the stream object was invalid. + STG_E_INVALIDPARAMETER - One of the parameters was invalid. + STG_E_REVERTED - The storage object has been invalidated by a revert operation + above it in the transaction tree. + STG_E_TOOMANYOPENFILES - The stream was not created because there are too many open files. + + + + + The OpenStream method opens an existing stream object within this storage + object in the specified access mode. + + A pointer to a wide character null-terminated Unicode + string that contains the name of the stream to open. The 000 through 01f + characters, serving as the first character of the stream/storage name, are + reserved for use by OLE. This is a compound file restriction, not a structured + storage restriction. + Reserved for future use; must be NULL. + Specifies the access mode to be assigned to the open stream. + For more information and descriptions of possible values, see STGM Constants. + Other modes you choose must at least specify STGM_SHARE_EXCLUSIVE when calling this + method in the compound file implementation. + Reserved for future use; must be zero. + A pointer to IStream pointer variable that receives the + interface pointer to the newly opened stream object. If an error occurs, *ppstm must be set to NULL. + + S_OK - The stream was successfully opened. + E_PENDING - Asynchronous Storage only: Part or all of the stream data is currently unavailable. + STG_E_ACCESSDENIED - Not enough permissions to open stream. + STG_E_FILENOTFOUND - The stream with specified name does not exist. + STG_E_INSUFFICIENTMEMORY - The stream was not opened due to a lack of memory. + STG_E_INVALIDFLAG - The value specified for the grfMode parameter is not a valid STGM Constants value. + STG_E_INVALIDFUNCTION - The specified combination of flags in the grfMode parameter is not supported; + for example, when this method is called without the STGM_SHARE_EXCLUSIVE flag. + STG_E_INVALIDNAME - Invalid value for pwcsName. + STG_E_INVALIDPOINTER - The pointer specified for the stream object was not valid. + STG_E_INVALIDPARAMETER - One of the parameters was not valid. + STG_E_REVERTED - The storage object has been invalidated by a revert operation above it in the transaction tree. + STG_E_TOOMANYOPENFILES - The stream was not opened because there are too many open files. + + + + + The CreateStorage method creates and opens a new storage object nested within this storage + object with the specified name in the specified access mode. + + A pointer to a wide character null-terminated Unicode string that + contains the name of the newly created storage object. The name can be used later to + reopen the storage object. The name must not exceed 31 characters in length, not + including the string terminator. The 000 through 01f characters, serving as the + first character of the stream/storage name, are reserved for use by OLE. This is a + compound file restriction, not a structured storage restriction. + A value that specifies the access mode to use when opening + the newly created storage object. For more information and a description of possible values + Reserved for future use; must be zero. + Reserved for future use; must be zero. + A pointer, when successful, to the location of the IStorage pointer to + the newly created storage object. This parameter is set to NULL if an error occurs. + + S_OK - The storage object was created successfully. + E_PENDING - Asynchronous Storage only: Part or all of the necessary data is currently unavailable. + STG_E_ACCESSDENIED - Not enough permissions to create storage object. + STG_E_FILEALREADYEXISTS - The name specified for the storage object already exists in the + storage object and the grfMode parameter includes the flag STGM_FAILIFTHERE. + STG_E_INSUFFICIENTMEMORY - The storage object was not created due to a lack of memory. + STG_E_INVALIDFLAG - The value specified for the grfMode parameter is not a valid STGM Constants value. + STG_E_INVALIDFUNCTION - The specified combination of flags in the grfMode parameter is not supported. + STG_E_INVALIDNAME - Not a valid value for pwcsName. + STG_E_INVALIDPOINTER - The pointer specified for the storage object was not valid. + STG_E_INVALIDPARAMETER - One of the parameters was not valid. + STG_E_REVERTED - The storage object has been invalidated by a revert operation above it in the transaction tree. + STG_E_TOOMANYOPENFILES - The storage object was not created because there are too many open files. + STG_S_CONVERTED - The existing stream with the specified name was replaced with a new storage object + containing a single stream called CONTENTS. The new storage object will be added. + + + + + The OpenStorage method opens an existing storage object with the specified name in the specified access mode. + + A pointer to a wide character null-terminated Unicode string that + contains the name of the storage object to open. The 000 through 01f characters, + serving as the first character of the stream/storage name, are reserved for use by + OLE. This is a compound file restriction, not a structured storage restriction. + It is ignored if pstgPriority is non-NULL. + Must be NULL. A non-NULL value will return STG_E_INVALIDPARAMETER. + Specifies the access mode to use when opening the storage object. + For descriptions of the possible values, see STGM Constants. + Other modes you choose must at least specify STGM_SHARE_EXCLUSIVE when calling this method. + Must be NULL. A non-NULL value will return STG_E_INVALIDPARAMETER. + Reserved for future use; must be zero. + When successful, pointer to the location of an IStorage pointer to + the opened storage object. This parameter is set to NULL if an error occurs. + + S_OK - The storage object was opened successfully. + E_PENDING - Asynchronous Storage only: Part or all of the storage's data is currently unavailable. + STG_E_ACCESSDENIED - Not enough permissions to open storage object. + STG_E_FILENOTFOUND - The storage object with the specified name does not exist. + STG_E_INSUFFICIENTMEMORY - The storage object was not opened due to a lack of memory. + STG_E_INVALIDFLAG - The value specified for the grfMode parameter is not a valid STGM Constants value. + STG_E_INVALIDFUNCTION - The specified combination of flags in the grfMode parameter is not supported. + STG_E_INVALIDNAME - Not a valid value for pwcsName. + STG_E_INVALIDPOINTER - The pointer specified for the storage object was not valid. + STG_E_INVALIDPARAMETER - One of the parameters was not valid. + STG_E_REVERTED - The storage object has been invalidated by a revert operation above it in the transaction tree. + STG_E_TOOMANYOPENFILES - The storage object was not created because there are too many open files. + STG_S_CONVERTED - The existing stream with the specified name was replaced with a new storage + object containing a single stream called CONTENTS. In direct mode, the new storage is + immediately written to disk. In transacted mode, the new storage is written to a + temporary storage in memory and later written to disk when it is committed. + + + + + The CopyTo method copies the entire contents of an open storage object to another storage object. + + The number of elements in the array pointed to by rgiidExclude. + If rgiidExclude is NULL, then ciidExclude is ignored. + An array of interface identifiers (IIDs) that either the caller + knows about and does not want copied or that the storage object does not support but whose + state the caller will later explicitly copy. + A string name block (refer to SNB) that specifies a block of storage + or stream objects that are not to be copied to the destination. These elements are not created + at the destination. If IID_IStorage is in the rgiidExclude array, this parameter is ignored. + This parameter may be NULL. + Pointer to the open storage object into which this storage object is to be copied. + + S_OK - The storage object was successfully copied. + E_PENDING - Asynchronous Storage only: Part or all of the data to be copied is currently unavailable. + STG_E_ACCESSDENIED - The destination storage object is a child of the source storage object. + STG_E_INSUFFICIENTMEMORY - The copy was not completed due to a lack of memory. + Otherwise - Error code. + + + + + The MoveElementTo method copies or moves a substorage or stream from this storage + object to another storage object. + + Pointer to a wide character null-terminated Unicode string + that contains the name of the element in this storage object to be moved or copied. + IStorage pointer to the destination storage object. + Pointer to a wide character null-terminated unicode string + that contains the new name for the element in its new storage object. + Specifies whether the operation should be a move (STGMOVE_MOVE) + or a copy (STGMOVE_COPY). See the STGMOVE enumeration. + S_OK - The storage object was successfully copied or moved. + Otherwise error code. + + + + + The Commit method ensures that any changes made to a storage object open in transacted + mode are reflected in the parent storage. + + Controls how the changes are committed to the storage object. + + S_OK - Changes to the storage object were successfully committed to the parent level. + If STGC_CONSOLIDATE was specified, the storage was successfully consolidated, + or the storage was already too compact to consolidate further + Otherwise error code. + + + + + The Revert method discards all changes that have been made to the storage object since the last commit operation. + + + S_OK - The revert operation was successful. + Otherwise error code. + + + + + The EnumElements method retrieves a pointer to an enumerator object that can be used + to enumerate the storage and stream objects contained within this storage object. + + Reserved for future use; must be zero. + Reserved for future use; must be zero. + Reserved for future use; must be zero. + Pointer to IEnumSTATSTG* pointer variable that receives the + interface pointer to the new enumerator object. + + S_OK - The enumerator object was successfully returned. + Otherwise error code. + + + + + The DestroyElement method removes the specified storage or stream from this storage object. + + Pointer to a wide character null-terminated Unicode string that + contains the name of the storage or stream to be removed. + + S_OK - The element was successfully removed. + Otherwise error code. + + + + + The RenameElement method renames the specified substorage or stream in this storage object. + + Pointer to a wide character null-terminated Unicode string that + contains the name of the substorage or stream to be changed. + Pointer to a wide character null-terminated unicode string that + contains the new name for the specified substorage or stream. + S_OK - The element was successfully renamed. + Otherwise error code. + + + + The SetElementTimes method sets the modification, access, and creation times of the + specified storage element, if the underlying file system supports this method. + + The name of the storage object element whose times are to be modified. + If NULL, the time is set on the root storage rather than one of its elements. + Either the new creation time for the element or NULL + if the creation time is not to be modified. + Either the new access time for the element or NULL if the + access time is not to be modified. + Either the new modification time for the element or NULL + if the modification time is not to be modified. + + S_OK - The time values were successfully set. + Otherwise error code. + + + + + The SetClass method assigns the specified class identifier (CLSID) to this storage object. + + The CLSID that is to be associated with the storage object. + S_OK - The CLSID was successfully assigned. + Otherwise error code. + + + + + The SetStateBits method stores up to 32 bits of state information in this storage object. + This method is reserved for future use. + + Specifies the new values of the bits to set. No legal values are + defined for these bits; they are all reserved for future use and must not be used by applications. + A binary mask indicating which bits in grfStateBits are significant in this call. + S_OK - The state information was successfully set. + Otherwise error code. + + + + + The Stat method retrieves the STATSTG structure for this open storage object. + + On return, pointer to a STATSTG structure where this + method places information about the open storage object. This parameter is NULL if an error occurs. + Specifies that some of the members in the STATSTG structure + are not returned, thus saving a memory allocation operation. + Values are taken from the STATFLAG enumeration. + + S_OK - The STATSTG structure was successfully returned at the specified location. + Otherwise error code. + + + + + The IEnumSTATPROPSETSTG interface iterates through an array of STATPROPSETSTG structures. + + + + + The Next method retrieves a specified number of STATPROPSETSTG structures that follow + subsequently in the enumeration sequence. + + The number of STATPROPSETSTG structures requested. + An array of STATPROPSETSTG structures returned. + The number of STATPROPSETSTG structures retrieved in the rgelt parameter. + + + + The Skip method skips a specified number of STATPROPSETSTG structures in the enumeration sequence. + + The number of STATPROPSETSTG structures to skip. + + + + The Reset method resets the enumeration sequence to the beginning of the STATPROPSETSTG structure array. + + + + + The Clone method creates an enumerator that contains the same enumeration state as the current + STATPROPSETSTG structure enumerator. Using this method, a client can record a particular point + in the enumeration sequence and then return to that point later. + + A pointer to the variable that receives the IEnumSTATPROPSETSTG interface pointer. + + + + + + + + + The Next method retrieves a specified number of STATPROPSTG structures, that follow subsequently + in the enumeration sequence. + + The number of STATPROPSTG structures requested. + An array of STATPROPSTG structures returned. + The number of STATPROPSTG structures retrieved in the rgelt parameter. + + + + The Skip method skips the specified number of STATPROPSTG structures in the enumeration sequence. + + The number of STATPROPSTG structures to skip. + + + + The Reset method resets the enumeration sequence to the beginning of the STATPROPSTG structure array. + + + + + The Clone method creates an enumerator that contains the same enumeration state as the current + STATPROPSTG structure enumerator + + A pointer to the variable that receives the IEnumSTATPROPSTG interface pointer. + + + + + + + + + The vt + + + + + The int PTR + + + + + The byte value + + + + + The int value + + + + + The bool value + + + + + The file time + + + + + The double value + + + + + The short value + + + + + The int PTR2 + + + + + The IPropertyStorage interface manages the persistent properties of a single property set. + Persistent properties consist of information that can be stored persistently in a + property set, such as the summary information associated with a file. + + + + + The ReadMultiple method reads specified properties from the current property set. + + The numeric count of properties to be specified in the rgpspec array. + An array of PROPSPEC structures specifies which properties are read. + Properties can be specified either by a property ID or by an optional string name. + Caller-allocated array of a PROPVARIANT structure that, on return, + contains the values of the properties specified by the corresponding elements in the rgpspec array. + + + + The WriteMultiple method writes a specified group of properties to the current property set. + If a property with a specified name or property identifier already exists, it is replaced, + even when the old and new types for the property value are different. + + The number of properties set. The value of this parameter can be set to zero; + An array of the property IDs (PROPSPEC) to which properties are set. + An array (of size cpspec) of PROPVARIANT structures that contain the property values to be written. + The minimum value for the property IDs that the method must assign if the + rgpspec parameter specifies string-named properties for which no property IDs currently exist. + + + + The DeleteMultiple method deletes as many of the indicated properties as exist in this property set. + + The numerical count of properties to be deleted. The value of this parameter can + legally be set to zero, however that defeats the purpose of the method as no properties are thereby + deleted, regardless of the value set in rgpspec. + Properties to be deleted. A mixture of property identifiers and string-named + properties is permitted. There may be duplicates, and there is no requirement that properties be + specified in any order. + + + + The ReadPropertyNames method retrieves any existing string names for the specified property IDs. + + The number of elements on input of the array rgpropid. + The value of this parameter can be set to zero. + An array of property IDs for which names are to be retrieved. + A caller-allocated array of size cpropid of LPWSTR members. + On return, the implementation fills in this array. + + + + The WritePropertyNames method assigns string names to a specified array of property IDs in the current property set. + + The size on input of the array rgpropid. Can be zero. + However, making it zero causes this method to become non-operational. + An array of the property IDs for which names are to be set. + Array of new names to be assigned to the corresponding property + IDs in the rgpropid array. These names may not exceed 255 characters (not including the NULL terminator). + + + + The DeletePropertyNames method deletes specified string names from the current property set. + + The size on input of the array rgpropid. If 0, no property names are deleted. + Property identifiers for which string names are to be deleted. + + + + The IPropertyStorage::Commit method saves changes made to a property storage + object to the parent storage object. + + The flags that specify the conditions under which the commit is to be performed. + + + + The Revert method discards all changes to the named property set since it was last opened or + discards changes that were last committed to the property set. + + + + + The Enum method creates an enumerator object designed to enumerate data of type STATPROPSTG, + which contains information on the current property set. + + Pointer to IEnumSTATPROPSTG pointer variable that receives the interface + pointer to the new enumerator object. + + + + The SetTimes method sets the modification, access, and creation times of this property set, + if supported by the implementation. Not all implementations support all these time values. + + Pointer to the new creation time for the property set. May be NULL, + indicating that this time is not to be modified by this call. + Pointer to the new access time for the property set. May be NULL, + indicating that this time is not to be modified by this call. + Pointer to the new modification time for the property set. May be + NULL, indicating that this time is not to be modified by this call. + + + + The SetClass method assigns a new CLSID to the current property storage object, and + persistently stores the CLSID with the object. + + New CLSID to be associated with the property set. + + + + The Stat method retrieves information about the current open property set. + + Pointer to a STATPROPSETSTG structure, which contains + statistics about the current open property set. + + + + The ReadMultiple method reads specified properties from the current property set. + + The numeric count of properties to be specified in the rgpspec array. + An array of PROPSPEC structures specifies which properties are read. + Properties can be specified either by a property ID or by an optional string name. + Caller-allocated array of a PROPVARIANT structure that, on return, + contains the values of the properties specified by the corresponding elements in the rgpspec array. + + + + The WriteMultiple method writes a specified group of properties to the current property set. + If a property with a specified name or property identifier already exists, it is replaced, + even when the old and new types for the property value are different. + + The number of properties set. The value of this parameter can be set to zero; + An array of the property IDs (PROPSPEC) to which properties are set. + An array (of size cpspec) of PROPVARIANT structures that contain the property values to be written. + The minimum value for the property IDs that the method must assign if the + rgpspec parameter specifies string-named properties for which no property IDs currently exist. + + + + The IPropertyStorage::Commit method saves changes made to a property storage + object to the parent storage object. + + The flags that specify the conditions under which the commit is to be performed. + + + + The IPropertySetStorage interface creates, opens, deletes, and enumerates property set + storages that support instances of the IPropertyStorage interface. + + + + + The Create method creates and opens a new property set in the property set storage object. + + The FMTID of the property set to be created. For information about + FMTIDs that are well-known and predefined in the Platform SDK, see Predefined Property Set + Format Identifiers. + A pointer to the initial class identifier CLSID for this property set. + May be NULL, in which case it is set to all zeroes. + The values from PROPSETFLAG Constants. + An access mode in which the newly created property set is to be opened, + taken from certain values of STGM_Constants, as described in the following Remarks section. + A pointer to the output variable that receives the IPropertyStorage interface pointer. + + + + The Open method opens a property set contained in the property set storage object. + + The format identifier (FMTID) of the property set to be opened. + For more information about well-known and predefined FMTIDs in the Platform SDK + The access mode in which the newly created property set is to be + opened. These flags are taken from STGM Constants. + A pointer to the IPropertyStorage pointer variable that receives + the interface pointer to the requested property storage subobject. + + + + The Delete method deletes one of the property sets contained in the property set storage object. + + FMTID of the property set to be deleted. + + + + The Enum method creates an enumerator object which contains information on the + property sets stored in this property set storage. + + Pointer to IEnumSTATPROPSETSTG pointer variable that + receives the interface pointer to the newly created enumerator object. + + + + Class provide access to STG API functions. + + + + + To prevent user from creation of this class instances. + + + + + StgOpenStorage opens an existing root storage object in the file system. You + can use this function to open compound files but you cannot use it to open + directories, files, or summary catalogs. Nested storage objects can only be + opened using their parents' IStorage::OpenStorage method. + + [in] Pointer to the path of the NULL-terminated + Unicode string file containing the storage object to open. This parameter + is ignored if the pstgPriority parameter is not NULL. + Most often NULL. If not NULL, this parameter is + used instead of the pwcsName parameter to specify the pointer to the + IStorage interface on the storage object to open. It points to a previous + opening of a root storage object, most often one that was opened in priority + mode. After the StgOpenStorage function returns, the storage object specified + in the pstgPriority parameter on function entry is not valid and can no + longer be used. Instead, use the storage object specified in the ppStgOpen + parameter. + Specifies the access mode to use to open the + storage object. + If not NULL, pointer to a block of elements in + the storage that are to be excluded as the storage object is opened. The + exclusion occurs regardless of whether a snapshot copy happens on the open. + May be NULL. + Indicates reserved for future use; must be zero. + [out] Pointer IStorage* pointer variable that receives + the interface pointer to the opened storage. + + S_OK + Indicates that the storage object was successfully opened. + STG_E_FILENOTFOUND + Indicates that the specified file does not exist. + STG_E_ACCESSDENIED + Access denied because the caller does not have enough permissions, or another caller + has the file open and locked. + STG_E_LOCKVIOLATION + Access denied because another caller has the file open and locked. + STG_E_SHAREVIOLATION + Access denied because another caller has the file open and locked. + STG_E_FILEALREADYEXISTS + Indicates that the file exists but is not a storage object. + STG_E_TOOMANYOPENFILES + Indicates that the storage object was not opened because there are too many open files. + STG_E_INSUFFICIENTMEMORY + Indicates that the storage object was not opened due to inadequate memory. + STG_E_INVALIDNAME + Indicates a non-valid name in the pwcsName parameter. + STG_E_INVALIDPOINTER + Indicates a non-valid pointer in one of the parameters: snbExclude, pwcsName, + pstgPriority, or ppStgOpen. + STG_E_INVALIDFLAG + Indicates a non-valid flag combination in the grfMode parameter. + STG_E_INVALIDFUNCTION + Indicates STGM_DELETEONRELEASE specified in the grfMode parameter. + STG_E_OLDFORMAT + Indicates that the storage object being opened was created by the Beta 1 storage + provider. This format is no longer supported. + STG_E_NOTSIMPLEFORMAT + Indicates that the STGM_SIMPLE flag was specified in the grfMode parameter and the + storage object being opened was not written in simple mode. + STG_E_OLDDLL + The DLL being used to open this storage object is a version of the DLL that is older + than the one used to create it. + STG_E_PATHNOTFOUND + Specified path does not exist. + STG_E_SHAREVIOLATION + Access denied because another caller has the file open and locked. + + + + + Opens an existing root storage object in the file system. You can use this function + to open compound files and regular files. To create a new file, use the + StgCreateStorageEx function. + + [in] Pointer to the path of the NULL-terminated Unicode + string file containing the storage object. This string size must not exceed + MAX_PATH characters. + [in] Specifies the access mode to open the new storage object. + For more information, see the STGM enumeration. If the caller specifies transacted + mode together with STGM_CREATE or STGM_CONVERT, the overwrite or conversion takes + place when the commit operation is called for the root storage. If IStorage::Commit + is not called for the root storage object, previous contents of the file will be + restored. STGM_CREATE and STGM_CONVERT cannot be combined with the STGM_NOSNAPSHOT + flag, because a snapshot copy is required when a file is overwritten or converted + in the transacted mode. + [in] Specifies the storage file format. For more information, + see the STGFMT enumeration. + [in] Depends on the value of the stgfmt parameter. + STGFMT_DOCFILE should be zero (0) or FILE_FLAG_NO_BUFFERING. + [in, out] Pointer to a STGOPTIONS structure that contains + information about the storage object being opened. The pStgOptions parameter is + valid only if the stgfmt parameter is set to STGFMT_DOCFILE. + [in] Reserved for future use; must be zero. + [in] Specifies the Guid of the interface pointer to return. + [out] Address of an interface pointer variable that + receives a pointer for an interface on the storage object being opened; contains + NULL if operation failed. + + S_OK + Indicates that the storage object was successfully opened. + STG_E_INVALIDPOINTER + Indicates a non-valid pointer in the ppObjectOpen parameter. + STG_E_INVALIDPARAMETER + Indicates a non-valid value for the grfAttrs, reserved1, reserved2, grfMode, or + stgfmt parameters. Can occur if the FILE_FLAG_NO_BUFFERING flag is specified for + grfAttrs but the sector size of the file is not an integer multiple of the + underlying disk's sector size. + E_NOINTERFACE + Indicates that the specified interface is not supported. + STG_E_INVALIDFLAG + Indicates a non-valid flag combination in the grfMode pointer (includes both + STGM_DELETEONRELEASE and STGM_CONVERT flags). + STG_E_INVALIDNAME + Indicates a non-valid name in the pwcsName parameter. + STG_E_INVALIDFUNCTION + Indicates that the grfMode is set to STGM_DELETEONRELEASE. + STG_E_LOCKVIOLATION + Access denied because another caller has the file open and locked. + STG_E_SHAREVIOLATION + Access denied because another caller has the file open and locked. + STG_E_UNIMPLEMENTEDFUNCTION + Indicates that the StgOpenStorageEx function is not implemented by the operating + system. In this case, use the StgOpenStorage function instead. + STG_E_INCOMPLETE + Indicates that the file could not be opened because it is on a high-latency device. + This can only occur if the parameter is IID_IPropertySetStorage, and the + stgfmt parameter is STGFMT_FILE. + STG_E_ACCESSDENIED + Indicates that the file could not be opened because the underlying storage device + does not allow such access to the current user. When opening the storage object + in transacted mode (STGM_TRANSACTED), this error may also indicate that a temporary + file could not be created in the temporary directory as specified by the + GetTempPath function. The GetTempPath function retrieves the path of the directory + designated for temporary files. + + + + + StgCreateDocfile creates a new compound file storage object using the COM-provided + compound file implementation for the IStorage interface. + + [in] Pointer to a NULL-terminated Unicode string name for the + compound file being created. It is passed uninterpreted to the file system. This can + be a relative name or NULL. If NULL, a temporary compound file is allocated with a + unique name. + [in] Specifies the access mode to use when opening the new + storage object. For more information, see the STGM enumeration. If the caller + specifies transacted mode together with STGM_CREATE or STGM_CONVERT, the overwrite + or conversion takes place when the commit operation is called for the root storage. + If IStorage::Commit is not called for the root storage object, previous contents of + the file will be restored. STGM_CREATE and STGM_CONVERT cannot be combined with + the STGM_NOSNAPSHOT flag, because a snapshot copy is required when a file is + overwritten or converted in the transacted mode. + [in] Reserved for future use; must be zero. + [out] Pointer to the location of the IStorage pointer to + the new storage object. + + S_OK - Indicates that the compound file was successfully created. + STG_E_ACCESSDENIED - Access denied because the caller does not have enough permissions + or another caller has the file open and locked. + STG_E_FILEALREADYEXISTS + Indicates that the compound file already exists and grfMode is set to STGM_FAILIFTHERE. + STG_E_INSUFFICIENTMEMORY + Indicates that the compound file was not created due to inadequate memory. + STG_E_INVALIDFLAG + Indicates a non-valid flag combination in the grfMode parameter. + STG_E_INVALIDNAME + Indicates a non-valid name in the pwcsName parameter. + STG_E_INVALIDPOINTER + Indicates a non-valid pointer in the pwcsName parameter or the ppStgOpen parameter. + STG_E_LOCKVIOLATION + Access denied because another caller has the file open and locked. + STG_E_SHAREVIOLATION + Access denied because another caller has the file open and locked. + STG_E_TOOMANYOPENFILES + Indicates that the compound file was not created due to a lack of file handles. + STG_S_CONVERTED + Indicates that the specified file was successfully converted to storage format. + + + + + The StgCreatePropSetStg function creates a property set storage object from a specified storage object. + + Pointer to the storage object that contains or is to + contain one or more property sets. + Reserved for future use; must be zero. + Pointer to IPropertySetStorage* pointer variable that receives the + interface pointer to the property-set storage object. + S_OK - The property set storage object was successfully created. + + + + The StgCreatePropSetStg function creates a property set storage object from a specified storage object. + + Pointer to the storage object that contains or is to + contain one or more property sets. + Reserved for future use; must be zero. + Pointer to IPropertySetStorage* pointer variable that receives the + interface pointer to the property-set storage object. + S_OK - The property set storage object was successfully created. + + + + The CreateILockBytesOnHGlobal function creates a byte array object, using global memory + as the physical device, which is intended to be the compound file foundation. + + The memory handle allocated by the GlobalAlloc function. + A flag that specifies whether the underlying handle for + this byte array object should be automatically freed when the object is released. + The address of ILockBytes pointer variable that receives the interface + pointer to the new byte array object. + S_OK - The byte array object was created successfully. + + + + The StgCreateDocfileOnILockBytes function creates and opens a new compound file + storage object on top of a byte-array object provided by the caller. + + A pointer to the ILockBytes interface on the underlying + byte-array object on which to create a compound file. + Specifies the access mode to use when opening the new compound file. + For more information, see STGM Constants. + Reserved for future use; must be zero. + A pointer to the location of the IStorage pointer on the new storage object. + + S_OK - Indicates that the compound file was successfully created. + Otherwise error code. + + + + + The StgOpenStorageOnILockBytes function opens an existing storage object that does not reside in a + disk file, but instead has an underlying byte array provided by the caller. + + ILockBytes pointer to the underlying byte array object that contains the + storage object to be opened. + Most often NULL. If not NULL, this parameter is used instead of the + plkbyt parameter to specify the storage object to open. In this case, it points to the IStorage + interface on a previously opened root storage object, most often one that was opened in priority mode. + Specifies the access mode to use to open the storage object. + Can be NULL. If not NULL, this parameter points to a block of elements in this + storage that are to be excluded as the storage object is opened. This exclusion occurs independently of + whether a snapshot copy happens on the open. + Indicates reserved for future use; must be zero. + Points to the location of an IStorage pointer to the opened storage on successful return. + S_OK - The storage object was successfully opened. + Otherwise error code. + + + + + The GlobalAlloc function allocates the specified number of bytes from the heap. + Windows memory management does not provide a separate local heap and global heap. + + Memory allocation attributes. + Number of bytes to allocate. + + If the function succeeds, the return value is a handle to the newly + allocated memory object. If the function fails, the return value is NULL. + To get extended error information, call GetLastError. + + + + + + + + + + + + + + + + + + + + + Flags for GlobalAlloc function. + + + + + Allocates fixed memory. The return value is a pointer. + + + + + Allocates movable memory. Memory blocks are never moved in physical memory, + but they can be moved within the default heap. + + + + + Initializes memory contents to zero. + + + + + NO Discard memory. + + + + + Predefined Clipboard Formats. + + + + + Text clipboard format. + + + + + Bitmap clipboard format. + + + + + METAFILEPICT clipboard format. + + + + + Sylk clipboard format. + + + + + Dif clipboard format. + + + + + Tiff clipboard format. + + + + + Oemtext clipboard format. + + + + + Dib clipboard format. + + + + + Pallette clipboard format. + + + + + Pendata clipboard format. + + + + + Riff clipboard format. + + + + + Wave clipboard format. + + + + + Unicodetext clipboard format. + + + + + Enhmetafile clipboard format. + + + + + Hdrop clipboard format. + + + + + Locale clipboard format. + + + + + Max clipboard format. + + + + + Ownerdisplay clipboard format. + + + + + Dsptext clipboard format. + + + + + Dspbitmap clipboard format. + + + + + Dspmetafilepict clipboard format. + + + + + Dspenhmetafile clipboard format. + + + + + Privatefirst clipboard format. + + + + + Privatelast clipboard format. + + + + + Gdiobjfirst clipboard format. + + + + + Gdiobjlast clipboard format. + + + + + The DVASPECT enumeration values specify the desired data or view aspect of the object when drawing or getting data. + + + + + Provides a representation of an object so it can be displayed as an embedded object inside of a container. + + + + + Provides a thumbnail representation of an object so it can be displayed in a browsing tool. + + + + + Provides an iconic representation of an object. + + + + + Provides a representation of the object on the screen as though it were printed to a printer + using the Print command from the File menu. + + + + + The TYMED enumeration values indicate the type of storage medium being used in a data transfer. + + + + + No data is being passed. + + + + + The storage medium is a global memory handle (HGLOBAL). Allocate the global + handle with the GMEM_SHARE flag. + + + + + The storage medium is a disk file identified by a path. If the STGMEDIUM + punkForRelease member is NULL, the destination process should use OpenFile to delete the file. + + + + + The storage medium is a stream object identified by an IStream pointer. Use + ISequentialStream::Read to read the data. + + + + + The storage medium is a storage component identified by an IStorage pointer. + + + + + The storage medium is a GDI component (HBITMAP). If the STGMEDIUM punkForRelease member is + NULL, the destination process should use DeleteObject to delete the bitmap. + + + + + The storage medium is a metafile (HMETAFILE). Use the Windows or WIN32 functions to + access the metafile's data. + + + + + The storage medium is an enhanced metafile. If the STGMEDIUM punkForRelease member is NULL, + the destination process should use DeleteEnhMetaFile to delete the bitmap. + + + + + CSIDL values provide a unique system-independent way to identify special folders used frequently + by applications, but which may not have the same name or location on any given system. + + + + + The virtual folder representing the Windows desktop, the root of the namespace. + + + + + A virtual folder representing the Internet. + + + + + The file system directory that contains the user's program groups (which are themselves file system directories). + + + + + The virtual folder containing icons for the Control Panel applications. + + + + + The virtual folder containing installed printers. + + + + + The virtual folder representing the My Documents desktop item. + + + + + The file system directory that serves as a common repository for the user's favorite items. + + + + + The file system directory that corresponds to the user's Startup program group. + + + + + The file system directory that contains shortcuts to the user's most recently used documents. + + + + + The file system directory that contains Send To menu items. + + + + + The virtual folder containing the objects in the user's Recycle Bin. + + + + + The file system directory containing Start menu items. + + + + + The file system directory used to physically store file objects on the desktop. + + + + + The virtual folder representing My Computer, containing everything on the local + computer: storage devices, printers, and Control Panel. + + + + + A virtual folder representing Network Neighborhood, the root of the network namespace hierarchy. + + + + + A file system directory containing the link objects that may exist in the My Network Places virtual folder. + + + + + A virtual folder containing fonts. + + + + + The file system directory that serves as a common repository for document templates. + + + + + The file system directory that contains the programs and folders that appear on the Start menu for all users. + + + + + The file system directory that contains the directories for the common program groups that appear on the Start + menu for all users. + + + + + The file system directory that contains the programs that appear in the Startup folder for all users. + + + + + The file system directory that contains files and folders that appear on the desktop for all users. + + + + + The file system directory that serves as a common repository for application-specific data. + + + + + The file system directory that contains the link objects that + can exist in the Printers virtual folder. + + + + + The file system directory that serves as a data repository for local (nonroaming) applications. + + + + + The file system directory that corresponds to the user's nonlocalized Startup program group. + + + + + The file system directory that corresponds to the nonlocalized Startup program group for all users. + + + + + The file system directory that serves as a common repository for favorite items common to all users. + + + + + The file system directory that serves as a common repository for temporary Internet files. + + + + + The file system directory that serves as a common repository for Internet cookies. + + + + + The file system directory that serves as a common repository for Internet history items. + + + + + The file system directory containing application data for all users. + + + + + The Windows directory or SYSROOT. This corresponds to the %windir% or %SYSTEMROOT% + environment variables. + + + + + The Windows System folder. + + + + + The Program Files folder. + + + + + The file system directory that serves as a common repository for image files. + + + + + The file system directory containing user profile folders. + + + + + x86 system directory on RISC. + + + + + x86 C:\Program Files on RISC. + + + + + A folder for components that are shared across applications. + + + + + x86 Program Files\Common on RISC + + + + + The file system directory that serves as a common repository for document templates. + + + + + The file system directory that contains documents that are common to all users. + + + + + The file system directory containing administrative tools for all users of the computer. + + + + + The file system directory that is used to store administrative tools for an individual user. + + + + + Network and Dial-up Connections + + + + + Combine with CSIDL_ value to force folder creation in SHGetFolderPath(). + + + + + Combine with CSIDL_ value to return an unverified folder path. + + + + + Mask for all possible flag values. + + + + + Can be time intensive. + + + + + A platform-specific type that is used to represent a pointer to TYMED struct. + + + + + A platform-specific type that is used to represent a pointer or a handle to storage. + + + + + A platform-specific type that is used to represent a pointer or a handle to unknown. + + + + + The FORMATETC structure is a generalized Clipboard format. + + + + + Particular clipboard format of interest. + + + + + Pointer to a DVTARGETDEVICE structure containing information about the target + device for which the data is being composed. + + + + + One of the DVASPECT enumeration constants that indicate how much detail should + be contained in the rendering. + + + + + Part of the aspect when the data must be split across page boundaries. + + + + + One of the TYMED enumeration constants which indicate the type of storage medium + used to transfer the object's data. + + + + + The DATADIR enumeration values specify the direction of the data flow in the + dwDirection parameter of the IDataObject::EnumFormatEtc method. + + + + + Requests that IDataObject::EnumFormatEtc supply an enumerator for the + formats that can be specified in IDataObject::GetData. + + + + + Requests that IDataObject::EnumFormatEtc supply an enumerator for the + formats that can be specified in IDataObject::SetData. + + + + + + The IEnumFORMATETC interface is used to enumerate an array of FORMATETC structures. + + + + + This method creates another enumerator that contains the same enumeration state as the current one. + + Address of the IEnumFORMATETC* pointer variable that receives the interface + pointer to the enumeration object. + This method supports the standard return values E_INVALIDARG, E_OUTOFMEMORY, and E_UNEXPECTED. + + + + Retrieves the next celt items in the enumeration sequence. + + Number of elements being requested. + Array of size celt (or larger) of the elements of interest. + The type of this parameter depends on the item being enumerated. + Pointer to the number of elements actually supplied in rgelt. + The caller can pass in NULL if celt is 1. + S_OK is returned if the number of elements supplied is celt; S_FALSE otherwise. + + + + This method resets the enumeration sequence to the beginning. + + If the method succeeds, the return value is S_OK. + + + + This method skips over the next specified number of elements in the enumeration sequence. + + Number of elements to be skipped. + S_OK is returned if the number of elements skipped is celt; otherwise, S_FALSE. + + + + The IDataObject interface specifies methods that enable data transfer and notification of changes in data. + + + + + Called by a data consumer to obtain data from a source data object. + + Pointer to the FORMATETC structure that defines the + format, medium, and target device to use when passing the data. + Pointer to the STGMEDIUM structure that indicates the + storage medium containing the returned data through its tymed member, and the responsibility + for releasing the medium through the value of its pUnkForRelease member. + + S_OK - Data was successfully retrieved and placed in the storage medium provided. + Otherwise error code. + + + + + Called by a data consumer to obtain data from a source data object. This method differs + from the GetData method in that the caller must allocate and free the specified storage medium. + + Pointer to the FORMATETC structure that defines the format, medium, and target + device to use when passing the data. + Pointer to the STGMEDIUM structure that defines the storage medium + containing the data being transferred. + + S_OK - Data was successfully retrieved and placed in the storage medium provided. + Otherwise error code. + + + + + Determines whether the data object is capable of rendering the data described in the FORMATETC structure. + + Pointer to the FORMATETC structure defining the format, medium, and target + device to use for the query. + + S_OK - Subsequent call to IDataObject::GetData would probably be successful. + Otherwise error code. + + + + + Provides a standard FORMATETC structure that is logically equivalent to one that is more complex. + + Pointer to the FORMATETC structure that defines the format, medium, + and target device that the caller would like to use to retrieve data in a subsequent call such + as IDataObject::GetData. + Pointer to a FORMATETC structure that contains the most general information + possible for a specific rendering, making it canonically equivalent to pFormatetcIn. + + S_OK - The returned FORMATETC structure is different from the one that was passed. + Otherwise error code. + + + + + Called by an object containing a data source to transfer data to the object that implements this method. + + Pointer to the FORMATETC structure defining the format used by the data object + when interpreting the data contained in the storage medium. + Pointer to the STGMEDIUM structure defining the storage medium in which the + data is being passed. + If TRUE, the data object called, which implements IDataObject::SetData, owns + the storage medium after the call returns. This means it must free the medium after it has been used + by calling the ReleaseStgMedium function. + S_OK - Data was successfully transferred. + Otherwise error code. + + + + + Creates an object for enumerating the FORMATETC structures for a data object. + These structures are used in calls to IDataObject::GetData or IDataObject::SetData. + + Direction of the data through a value from the enumeration DATADIR. + Address of IEnumFORMATETC* pointer variable that receives + the interface pointer to the new enumerator object. + + S_OK - Enumerator object was successfully created. + E_NOTIMPL - The direction specified by dwDirection is not supported. + OLE_S_USEREG - Requests that OLE enumerate the formats from the registry. + + + + + Called by an object supporting an advise sink to create a connection between a data object and the advise sink. + + Pointer to a FORMATETC structure that defines the format, + target device, aspect, and medium that will be used for future notifications. + DWORD that specifies a group of flags for controlling the advisory connection. + Pointer to the IAdviseSink interface on the advisory sink that will + receive the change notification. + Pointer to a DWORD token that identifies this connection. + + S_OK - The advisory connection was created. + Otherwise error code. + + + + + Destroys a notification connection that had been previously set up. + + DWORD token that specifies the connection to + remove. Use the value returned by IDataObject::DAdvise when the connection was originally established. + + S_OK - The specified connection was successfully deleted. + OLE_E_NOCONNECTION - The specified dwConnection is not a valid connection. + OLE_E_ADVISENOTSUPPORTED - This IDataObject implementation does not support notification. + + + + + Creates an object that can be used to enumerate the current advisory connections. + + Address of IEnumSTATDATA* pointer variable that + receives the interface pointer to the new enumerator object. + + S_OK - The enumerator object is successfully instantiated or there are no connections. + OLE_E_ADVISENOTSUPPORTED - Advisory notifications are not supported by this object. + + + + + Error and succes codes + + + + + Success code. + + + + + Success code. + + + + + General access denied error. + + + + + Ran out of memory. + + + + + No such interface supported. + + + + + Catastrophic failure. + + + + + Invalid FORMATETC structure + + + + + This implementation doesn't take advises. + + + + + Class thet represents the data object entry. + + + + + Creates new instance of DataObjectEntry. + + Datadir object. + Parent StgMedium object. + Parent Formatec object. + + + + Class thet represents the enum formatec class. + + + + + Creates another connection point enumerator with the same state as the + current enumerator to iterate over the same list. + + Pointer to the returned IComEnumFORMATETC interface. + This method supports the standard return values + E_INVALIDARG, E_OUTOFMEMORY, and E_UNEXPECTED. + + + + The RemoteNext method retrieves a specified number of HRESULT structures. + + The number of STATSTG structures requested. + An array of STATSTG structures returned. + The number of STATSTG structures retrieved in the rgelt parameter. + S_OK - The number of STATSTG structures returned equals the number + specified in the celt parameter. + Otherwise - error code. + + + + Resets the enumeration sequence to the beginning. + + S_OK + + + + Instructs the enumerator to skip the next celt elements in the enumeration + so that the next call to IEnumConnectionPoints::Next will not return those elements. + + Number of elements to be skipped. + S_OK if the number of elements skipped is celt; otherwise, S_FALSE. + + + + + ComDataObject class. + + + + + Retrieves data. + + Point to Formatec structure. + Point to Stgmedium sturcture. + Returns error code. + + + + Similar to GetData, except the client must allocate the STGMEDIUM structure. + + Point to FORMATETC sturcture. + Point to STGMEDIUM structure. + Returns E_NOTIMPL. + + + + Determines whether the data object supports a particular + FORMATETC structure for transferring data. + + Point to FORMATETC sturcture. + Returns E_NOTIMPL. + + + + Retrieves a logically equivalent FORMATETC structure to one that is more complex. + + Pointer to the FORMATETC structure that defines the format. + Pointer to a FORMATETC structure that contains + the most general information possible for a specific rendering. + Returns E_NOTIMPL. + + + + Sets the value for a specific data point. + + Pointer to the FORMATETC structure that defines the format. + Point to STGMEDIUM structure. + Int to relise. + Returns S_OK + + + + Creates an enumerator to iterate through the FORMATETC structures + supported by the data object. + + Direction of the data through a value from the enumeration DATADIR. + Address of IEnumFORMATETC* pointer variable that + receives the interface pointer to the new enumerator object. + Returns E_NOTIMPL. + + + + Establishes a connection between the data object and an advise sink. + + Pointer to a FORMATETC structure that defines the format. + DWORD that specifies a group of flags for + controlling the advisory connection. + Pointer to the IAdviseSink interface on the advisory sink + that will receive the change notification. + Pointer to a DWORD token that identifies this connection. + Returns E_ADVISENOTSUPPORTED. + + + + Terminates a connection previously established through DAdvise. + + DWORD token that specifies the connection to remove. + Use the value returned by IDataObject::DAdvise when the connection + was originally established. + Returns E_ADVISENOTSUPPORTED. + + + + Creates an enumerator to iterate through the current advisory connections. + + Address of IEnumSTATDATA* pointer variable + that receives the interface pointer to the new enumerator object. + Returns E_ADVISENOTSUPPORTED. + + + + Storage API wrapper classes provide access to storage data from .NET code. + + + + + Open storage in read-only mode. + + + + + Open storage stream in read-only mode. + + + + + Create a new stream in storage. + + + + + Open storage or stream in ReadWrite mode. + + + + + Default buffer size for stream copying. + + + + + Options to open storage in read-only mode. Used to open already opened file. + + + + + Reference in COM interface which provides access to stream in storage. + + + + + Reference in COM interface which provide access to storage. + + + + + True if class was disposed; otherwise False. + + + + + True if stream supports read operation; otherwise False. + + + + + True stream supports write operation; otherwise False. + + + + + True if stream supports seek operation; otherwise False. + + + + + True if stream opened in Transaction mode and on Flush method call + class must commit transaction; otherwise False. + + + + + Length of stream data. + + + + + List of streams names provided by storage. + + + + + List of storage names found in current storage. + + + + + File name of storage. + + + + + Stream name. + + + + + Sub-storage name opened by class. + + + + + Storage Mode: Open or Create. + + + + + Stream Mode: Open or Create. + + + + + Current stream position, used for optimization. Allows users + to skip Seek operations if required. + + + + + Represents the locking bytes. + + + + + Closes the stream. + + + + + Commit changes. + + + + + Commit changes. + + Commit code. + + When commit operation fails. + + + + + Discards all changes that have been made to the storage object + since the last commit operation. + + + + + Seek in stream. + + New offset. + Start point for Seek operation. + Current position. + + When seek operation fails. + + + + + Set stream length. + + New stream length + + When SetLength operation fails. + + + + + Read data from stream. + + Output stream. + Offset in output buffer. + Quantity of bytes to read. + Quantity of read bytes. + + When buffer is NULL. + + + When offset or count is less than zero. + + + When there are not enough items in the buffer. + + + When Read operation fails. + + + + + Write data to stream. + + Buffer with data. + Offset in input buffer from which data started. + Quantity of bytes which must be written. + + When buffer is NULL. + + + When offset or count is less than zero. + + + When there are not enough items in the buffer + or stream is in Read-only mode. + + + When Write operation fails. + + + + + To prevent class creation by default constructor. + + + + + Open storage/compound file. + + File name of storage. + Mode which must be used for open operation. + + When fileName is NULL. + + + Couldn't open the storage + + + + + Open storage and one stream of it. + + File name of storage. + Flags that are used for storage open. + Stream name. + Flags which used for stream in storage open. + + + + Open storage and its stream in Read-only mode. + + File name. + Stream name. + + + + Open storage in Read-only mode but do not open stream. To open + special stream, use OpenStream methods. + + Storage file name. + + + + Inherit stream storage and opens its stream in Read-only mode. + + Storage of stream. + Stream name to open. + + + + Inherit stream storage and opensits streams with the user specified flags. + + Storage to inherit. + Stream name. + Stream open flags. + + + + Open or create stream specified by user name. + + Inherited storage. + Stream name. + True to create stream; otherwise open. + + + + Inherit storage and open or create in it stream with spcified user name + + Inherited storage. + Stream name. + Stream open / create flags. + True to create stream; otherwise open. + + + + Create a new instance of StgStream. + + Base stream. + Flags for create stream. + + + + Create a new instance of StgStream by defoult flag. + + Base stream. + + + + Dispose stream. Close stream, release references on COM interfaces, and + free resources. + + + + + Open stream in Read-only mode. + + Stream name. + + + + Open stream from storage with specified flags. + + Stream name. + Stream open flags. + + When streamName is NULL. + + + When the specified stream could not be found in the storage. + + + When it was not possible to open the stream. + + + + + Opens sub storage. + + Storage name to open. + Returns stream of opened storage. + + + + Opens sub storage. + + Storage name to open. + Open flags. + Returns stream of opened storage. + + + + Creates sub storage. + + Storage name to Create. + Returns stream of opened storage. + + + + Creates sub storage. + + Storage name for create. + Create flags. + Returns stream for created storage. + + + + Create stream in opened storage with specified name. + + Stream name. + + + + Create stream in storage with specified name and flags. + + Stream name. + Stream flags. + + When its not possible to create stream. + + + + + Saves internal ILockBytes into stream. + + Stream to save into. + + + + Searches for stream name in the streams array ignoring case. + + Stream name to locate. + Name of the stream in the storage. + + + + Indicates whether storage contains required stream. + + Stream to search. + True if stream was found. + + + + Indicates whether storage contains required substorage. + + Storage to search. + True if stream was found. + + + + Removes the specified storage or stream from this storage object. + + Name of the storage or stream to be removed. + + 0 - The element was successfully removed. + Otherwise error code. + + + + + Copies one storage into another. + + Source stream. + Destination stream. + + + + Method to create new storage and return StgStream class for it. + + Storage file name. + Reference on instance which knows how to work with it. + + When compound file couldn't be created. + + + + + Cretes storage on ILockBytes. + + Created storage. + + + + Check storage availability. + + + If storage is NULL. + + + + + Check stream availability. + + + When stream is NULL. + + + + + Calculate stream length. + + Returns length of currently open stream. + + + + Returns list of streams stored in storage. + + List of stream names. + + When elements of the storage couldn't be enumerated . + + + When it is possible to get IEnumSTATSTG interface reference from storage. + + + + + Return list of sub-storages found in current storage. + + List of found storages. + + + + Calculates subItems names. + + + + + Adds data. + + Item to add. + Collection to add. + + + + Adds data as stream type. + + Item to add. + Collection where adding is. + + + + Adds data as all type. + + Item to add. + Collection where adding is. + + + + Calculates subItems. + + SubItem event handler. + User data. + + + + Indicates if stream supports Read operation. Read-only. + + + + + Indicates if stream supports Seek operation. Read-only. + + + + + Indicates if stream supports Write operation. Read-only. + + + + + Indicates if stream is opened in Transaction mode. Read-only. + + + + + Length of stream. Read-only. + + + + + Gets / sets current position of stream. + + + + + Gets list of stream names found in storage. Read-only. + + + + + Gets the array of string thet is a storages. + + + + + Reference in COM interface which provide access to storage. + + + + + Reference in COM interface which provide access to stream in storage. + + + + + Get name of stream opened by the class. + + + + + Get name of sub storage opened by the class. + + + + + Gets the IlockBytes interface that represen the locked bytes. + + + + + Gets the file name. + + + + + Delegate that represents subItem name event. + + + + + Compound storage implementation based on standard COM-object. + + + + + Default storage name. Used for root storage, others should assign some other value. + + + + + + + + + + Collection with storage names. + + + + + Collection with stream names. + + + + + Name of the storage. + + + + + Calculates subItems names. + + + + + Adds data. + + Item to add. + Collection to add. + + + + Adds data as stream type. + + Item to add. + Collection where adding is. + + + + Adds data as all type. + + Item to add. + Collection where adding is. + + + + Calculates subItems. + + SubItem event handler. + User data. + + + + Initializes new instance of the class. + + Name of the file to open. + Storage options. + + + + Initializes new instance of the storage. + + Root substorage. + + + + Initializes new instance of te storage. + + Root substorage. + Name of the storage. + + + + Destructor. + + + + + Creates new stream inside this storage. + + Name of the stream to create. + Created stream object. + + + + Opens existing stream inside this storage. + + Name of the stream to open. + + + + + Removes existing stream from this storage. + + Name of the stream to remove. + + + + Determines whether storage contains specified stream. + + Name of the stream to check. + true if storage contains specified stream. + + + + Creates new substorage inside this one. + + Name of the storage to create. + Created storage object. + + + + Opens existing substorage inside this one. + + Name of the storage to open. + Created storage object. + + + + Removes exisiting substorage from this one. + + Name of the storage to remove. + + + + Determines whether this storage contains substorage with specified name. + + Name of the storage to check. + true if storage contains substorage with specified name. + + + + Commits changes. + + + + + Inserts copy of the storage and all subitems inside current storage. + + Storage to copy. + + + + Inserts copy of the stream inside current storage. + + Stream to copy. + + + + + + + + + Returns internal COM storage. This property will be removed after implementing + some document properties reading. + + + + + Returns all stream names that are placed inside this stream. + + + + + Returns all storage names that are placed inside this stream. + + + + + Returns name of the storage. + + + + + Delegate that represents subItem name event. + + + + + The PropVariant is used for defining the type tag and + the value of a property in a property set. + + + + + Represents the property data. + + + + + Sets property value. + + Value to set. + Type of the property to set. + + + + Gets property value. + + + + + Sets type of the variant. Write-only. + + + + + Name of the property. + + + + + Gets property id. + + + + + Offset to the type of the PropVariant. + + + + + Offset to the first int of the data. + + + + + Size of the integer. + + + + + Mask to get type of property or each element of the arrya (if property contains an array). + + + + + Bit mask for lower int value. + + + + + Bit mask for higher int value. + + + + + Number of bits in every integer value. + + + + + Difference in ticks of FILETIME and DateTime. + + + + + Bit mask for LinkToContent property of the DocumentProperty class. + + + + + Size of the native windows PROPVARIANT structure. + + + + + Offset to the second int of the data. + + + + + Array of IntPtr that should be freed on dispose using Marshal.FreeCoTaskMem. + + + + + Array of IntPtr that should be freed on dispose using Marshal.FreeHGlobal. + + + + + Pointer to the PropVariant. + + + + + Specifies a property by its property identifier (ID). + + + + + Array of PropVariants that will be disposed in Dispose method. + + + + + If True, then memory for the structure was allocated by + this class and should be freed on Dispose; + otherwise, memory was not allocated by this class and should not be freed. + + + + + Default constructor. + + + + + Creates PropVariant with data pointed by ptr. + + + + + + Reads data from IPropertyStorage. + + Property description. + IPropertyStorage to read data from. + Indicates whether property is built-in or not. + + + + Returns array of strings. + + + + + Converts IntPtr to the string. + + Value to convert. + Converted string. + + + + Parses not unicode string. + + Pointer to the sring to parse. + + + + + Returns an array of objects. + + + + + Fills PropVariant with array of strings. + + + + + Fills PropVariant with array of objects. + + + + + Sets Blob property value. + + Value to set. + + + + Sets property name. + + Name to set. + + + + Sets property value. + + Value to set. + Type of the property to set. + + + + Frees all allocated resources. + + + + + Frees resuources allocated for property name storage. + + + + + + + + + + + Writes variant to the property storage. + + + Property storage that will receive PropVariant value. + + + + + Reads information from the storage. + + Property information. + Storage to read from. + Indicates whether property is built-in. + + + + Reads information from the storage. + + Storage to read from. + Indicates whether property is built-in. + + + + Performs tasks associated with freeing, releasing, + or resetting unmanaged resources. + + + + + Finilizer. + + + + + Gets or sets the int16. + + The int16. + + + + Fills PropVariant with integer value. + + + + + Fills PropVariant with integer value. + + + + + Gets / sets PropVariant memory. + + + + + ID of the property that will be written into property storage. + + + + + Same as PropId. + + + + + Fills PropVariant with FILETIME value. + + + + + Fills PropVariant with bool value. + + + + + Fills PropVariant with string value. + + + + + Fills PropVariant with string value. + + + + + Fills PropVariant with FILETIME value. + + + + + Fills PropVariant with double value. + + + + + Gets / sets property name. + + + + + Returns value of the property. Read-only. + + + + + Indicates whether it is property or just link to source of some property. Read-only. + + + + + Returns id of the parent property. Read-only. + + + + + Gets property id. + + + + + Sets first integer value of the variant. Write-only. + + + + + Sets second integer value of the variant. Write-only. + + + + + Sets type of the variant. Write-only. + + + + + Represents the clipboard data. + + + + + Clipboard format. + + + + + Clipboard data. + + + + + Createas copy of the current object. + + A copy of the current object. + + + + Saves clipboard data into stream. + + Stream to write data into. + Size of the written data. + + + + Extracts data from the stream. + + Stream to get data from. + + + + .Net compound file implementation. + + + + + Name of the root entry. + + + + + Source stream. + + + + + File header. + + + + + + + + + + + + + + + + + + + + Root storage. + + + + + Short stream. + + + + + Stream containing items described by minifat. + + + + + MiniFAT. + + + + + Indicates whether substreams should maintain their own stream or should write + directly into the file's stream. + + + + + + + + + + Writes directory structure into file. + + Destination path. + Directory to write. + + + + Writes storage to specified path + + Destination path. + Storage to write. + + + + Writes stream into file + + Destination path. + Stream name. + Parent storage object. + + + + Default constructor. + + + + + Default constructor. + + + + + Default constructor. + + + + + + + + + + + Initializes internal variables. + + + + + + + + + + + + + + + + + + + + + Sets stream data for directory entry. + + Directory entry to update stream data for. + Stream to set. + + + + Sets entrie's long stream. + + Entry to update data for. + Data to set. + + + + Sets entrie's short stream. + + Entry to update data for. + Data to set. + + + + Writes stream data into compound file main stream + + Main stream to write into. + Start sector to write. + Stream to write. + Fat object. + + + + Here we have to allocate required sectors number. + + Entry to allocate sectors for. + Number of already allocated sectors. + Number of required sectors. + FAT object. + + + + Allocates sectors. + + Start sector in the chain. + Number of already allocated sectors. + Number of required sectors. + Fat object. + Start sector of the added chain. + + + + Gets offset to the sector. + + Zero-based sector index. + Sector shift (2^sectorShift = sector size). + Offset to the required sector. + + + + Gets offset to the sector. + + Zero-based sector index. + Sector shift (2^sectorShift = sector size). + Size of the header. + Offset to the required sector. + + + + Checks whether stream header belongs to compound file. + + Stream to check. + True if stream probably contains compound file data. + + + + Allocates new directory entry. + + Name of the stream. + Entry type. + Created directory entry. + + + + Marks item as free. + + Directory entry to be removed/freed. + + + + Reads data from internal stream. + + Entry to read data from. + Position inside entry stream. + Buffer that will cotain read data. + Size of the data to read. + Number of actually read bytes. + + + + Writes data into internal stream. + + Entry to write data into. + Position inside entry stream. + Buffer containing data to write. + Offset inside buffer to the data to write. + Size of the data to write. + + + + Saves compound file into stream. + + Stream to save data into. + + + + Writes internal stream into specified one. + + Destination stream to write into. + + + + Saves mini stream data. + + + + + Serializes directory entries. + + + + + Saves compound file into file. + + Name of the file to save into. + + + + Performs application-defined tasks associated with freeing, + releasing, or resetting unmanaged resources. + + + + + + + + + + + + + + + Returns root storage. + + + + + + + + + + + + + + + Returns base stream. Read-only. + + + + + Gets or sets value indicating whether substreams should maintain their own stream + or should write directly into the file's stream. + + + + + Returns root storage object for this file. + + + + + This is exception thrown when experiencing problems with compound file. + + + + + Default exception message. + + + + + Default constructor. + + + + + Initializes new instance of the exception. + + Exception message. + + + + + + + + + RBTree with child elements. + + + + + + + + + + Initializes new instance of the storage. + + Parent file. + Name of the new storage. + Index to the directory entry that stores storage information. + + + + Initializes new instance of the storage. + + Parent compound file object. + Entry that describes current storage. + + + + + + + + + + Creates new stream. + + Name of the stream to create. + Created stream. + + + + Opens stream. + + Name of the stream to open. + Opened stream or null if there is no such stream. + + + + Removes stream from the storage, if it contains stream with such name. + + Stream name to delete. + + + + Checks whether storage contains stream with specified name. + + Name of the stream to check. + True if storage has stream with such name; false otherwise. + + + + Opens existing storage. + + Name of the storage to open. + Opened storage item or null if it was impossible to open it. + + + + Removes substorage from existing storage. + + Name of the storage to remove. + + + + + + + + + Checks whether this storage contains substorage with specified name. + + Name to check. + True if there is such storage; false otherwise. + + + + + + + + + Returns directory entry id that corresponds to the specified node. + + + + + + + Returns name of the storage. + + + + + Returns directory entry for this stream. + + + + + This is wrapper over compound stream object. Simply redirects all calls to it + with one exception - it doesn't dispose underlying stream object. + + + + + Wrapped storage object. + + + + + Initializes new instance of the wrapper. + + Object to wrap. + + + + Frees all allocated resources. + + + + + Creates new stream inside this storage. + + Name of the stream to create. + Created stream object. + + + + Opens existing stream inside this storage. + + Name of the stream to open. + + + + + Removes existing stream from this storage. + + Name of the stream to remove. + + + + Determines whether storage contains specified stream. + + Name of the stream to check. + true if storage contains specified stream. + + + + Creates new substorage inside this one. + + Name of the storage to create. + Created storage object. + + + + Opens existing substorage inside this one. + + Name of the storage to open. + Created storage object. + + + + Removes exisiting substorage from this one. + + Name of the storage to remove. + + + + Determines whether this storage contains substorage with specified name. + + Name of the storage to check. + true if storage contains substorage with specified name. + + + + Commits changes. + + + + + Returns all stream names that are placed inside this stream. + + + + + Returns all storage names that are placed inside this stream. + + + + + Returns name of the storage. + + + + + Returns directory entry for this stream. + + + + + .Net implementation of the compound stream. + + + + + .Net implementation of the compound stream. + + + + + Parent file item. + + + + + Directory entry of this stream. + + + + + Stream with data. If it is null, then data hasn't been read yet or stream is closed. + + + + + Initializes new instance of the stream. + + Parent file object. + Entry that describes this stream item. + + + + + + + + + Reads a sequence of bytes from the current stream and advances the position + within the stream by the number of bytes read. + + An array of bytes. When this method returns, the buffer + contains the specified byte array with the values between offset and + (offset + count - 1) replaced by the bytes read from the current source. + The zero-based byte offset in buffer at which to begin + storing the data read from the current stream. + The maximum number of bytes to be read from the current stream. + The total number of bytes read into the buffer. This can be less than + the number of bytes requested if that many bytes are not currently available, + or zero (0) if the end of the stream has been reached. + + + + writes a sequence of bytes to the current stream and advances the current + position within this stream by the number of bytes written. + + An array of bytes. This method copies count bytes + from buffer to the current stream. + The zero-based byte offset in buffer at which to + begin copying bytes to the current stream. + The number of bytes to be written to the current stream. + + + + Sets the position within the current stream. + + A byte offset relative to the origin parameter. + A value of type SeekOrigin indicating the reference + point used to obtain the new position. + The new position within the current stream. + + + + Sets the length of the current stream. + + The desired length of the current stream in bytes. + + + + Causes any buffered data to be written to the underlying compound file. + + + + + Releases the unmanaged resources used by the Stream and optionally releases the managed resources. + + true to release both managed and unmanaged resources; + false to release only unmanaged resources. + + + + Returns directory entry for this stream. + + + + + Gets the length in bytes of the stream. Read-only. + + + + + Gets or sets the position within the current stream. + + + + + Gets a value indicating whether the current stream supports reading. + + + + + Gets a value indicating whether the current stream supports seeking. + + + + + Gets a value indicating whether the current stream supports writing. + + + + + Stream position. + + + + + Initializes new instance of the stream. + + Parent file object. + Entry that describes this stream item. + + + + + + + + + Reads a sequence of bytes from the current stream and advances the position + within the stream by the number of bytes read. + + An array of bytes. When this method returns, the buffer + contains the specified byte array with the values between offset and + (offset + count - 1) replaced by the bytes read from the current source. + The zero-based byte offset in buffer at which to begin + storing the data read from the current stream. + The maximum number of bytes to be read from the current stream. + The total number of bytes read into the buffer. This can be less than + the number of bytes requested if that many bytes are not currently available, + or zero (0) if the end of the stream has been reached. + + + + writes a sequence of bytes to the current stream and advances the current + position within this stream by the number of bytes written. + + An array of bytes. This method copies count bytes + from buffer to the current stream. + The zero-based byte offset in buffer at which to + begin copying bytes to the current stream. + The number of bytes to be written to the current stream. + + + + Sets the position within the current stream. + + A byte offset relative to the origin parameter. + A value of type SeekOrigin indicating the reference + point used to obtain the new position. + The new position within the current stream. + + + + Sets the length of the current stream. + + The desired length of the current stream in bytes. + + + + Causes any buffered data to be written to the underlying compound file. + + + + + Gets the length in bytes of the stream. Read-only. + + + + + Gets or sets the position within the current stream. + + + + + This is wrapper over compound stream object. Simply redirects all calls to it + with one exception - it doesn't dispose underlying stream object. + + + + + Wrapped stream object. + + + + + Initializes new instance of the wrapper. + + Object to wrap. + + + + Causes any buffered data to be written to the underlying compound file. + + + + + Reads a sequence of bytes from the current stream and advances the position + within the stream by the number of bytes read. + + An array of bytes. When this method returns, the buffer + contains the specified byte array with the values between offset and + (offset + count - 1) replaced by the bytes read from the current source. + The zero-based byte offset in buffer at which to begin + storing the data read from the current stream. + The maximum number of bytes to be read from the current stream. + The total number of bytes read into the buffer. This can be less than + the number of bytes requested if that many bytes are not currently available, + or zero (0) if the end of the stream has been reached. + + + + Sets the position within the current stream. + + A byte offset relative to the origin parameter. + A value of type SeekOrigin indicating the reference + point used to obtain the new position. + The new position within the current stream. + + + + Sets the length of the current stream. + + The desired length of the current stream in bytes. + + + + writes a sequence of bytes to the current stream and advances the current + position within this stream by the number of bytes written. + + An array of bytes. This method copies count bytes + from buffer to the current stream. + The zero-based byte offset in buffer at which to + begin copying bytes to the current stream. + The number of bytes to be written to the current stream. + + + + + + + + + + Gets a value indicating whether the current stream supports reading. + + + + + Gets a value indicating whether the current stream supports seeking. + + + + + Gets a value indicating whether the current stream supports writing. + + + + + Gets the length in bytes of the stream. Read-only. + + + + + Gets or sets the position within the current stream. + + + + + Number of items in the file header. + + + + + List of all fat sector ids. + + + + + List with used Dif sectors. + + + + + Default constructor. + + + + + + + + + + + + Adds required number of DIF sectors. + + Number of sectors to add. + FAT object. + + + + + + + + + This class represents directory structure in the compound file. + + + + + List of directory entries. + + + + + Default constructor. + + + + + Initializes new instance of the directory. + + Data to parse. + + + + Searches for empty entry index. + + Index of the first empty directory entry. + + + + Adds new entry to the collection or replaces existing empty entry with this one. + + Entry to add. + + + + Saves directory entries into specified stream. + + Stream to save directory into. + + + + Returns list of directory entries. + + + + + Represents single directory entry in the compound file. + + + + + Size of a single directory entry. + + + + + Size of the stream name field. + + + + + Entry name. + + + + + Entry type. + + + + + Entry "color" in red-black tree. + + + + + Id of the left-sibling. + + + + + Id of the right-sibling. + + + + + Id of the child acting as the root of all the children of thes element (if entry type if Storage). + + + + + Storage CLSID. + + + + + User flags of this storage. + + + + + Create time-stamp for a storage. + + + + + Modify time-stamp for a storage. + + + + + Starting stream sector. + + + + + Stream size. + + + + + Reserved. Must be zero. + + + + + Entry id. + + + + + Last sector id. + + + + + Initializes new instance of the entry. + + Name of the new entry. + Type of the new entry. + Id of the new entry. + + + + Initializes new instance of the entry. + + Data of the new entry. + Offset to the entry data. + Entry id. + + + + Writes directory entry data inside specified stream. + + Stream to write data into. + + + + Entry name. + + + + + Entry type. + + + + + Entry "color" in red-black tree. + + + + + Id of the left-sibling. + + + + + Id of the right-sibling. + + + + + Id of the child acting as the root of all the children of thes element (if entry type if Storage). + + + + + Storage CLSID. + + + + + User flags of this storage. + + + + + Create time-stamp for a storage. + + + + + Modify time-stamp for a storage. + + + + + Starting stream sector. + + + + + Stream size. + + + + + Reserved. Must be zero. + + + + + Returns entry id. Read-only. + + + + + Possible entry types. + + + + + Invalid entry. + + + + + Entry is storage. + + + + + Entry is stream. + + + + + Root entry. + + + + + Document properties enumerator. + + + + + Offset to the first section. + + + + + List of all sections. + + + + + Default constructor. + + + + + Initializes new instance of the enumerator. + + Stream to parse. + + + + Extracts sections data from the stream. + + + + + + Extracts header information from the stream. + + + + + + Saves all sections into stream. + + Stream to save sections into. + + + + Extracts header information from the stream. + + + + + + Saves collection into stream. + + + + + + Returns list lf all sections. + + + + + This class represents FAT object in the compound file. + + + + + + + + + + List with free sectors. + + + + + Sector size. + + + + + + + + + + Default constructor. + + + + + Default constructor. + + + + + Initializes new instance of the fat. + + Parent compound file object. + Stream to extract fat from. + DIF object to help in parsing + File header object. + + + + Gets data of the compound file substream. + + Stream with compound file data. + First sector of the stream to get. + Parent compound file object. + + + + + Gets index of the next sector in the chain. + + Index of the current sector in the chain. + Next sector in the chain. + + + + Closes sectors chain by marking all those sectors as free starting from specified one. + + + + + + Enlarges existing sectors chain. + + Last sector in the chain that requires enlargment. + Number of sectors to add. + Index of the chain start (used when chain wasn't created before). + + + + Frees specified sector. + + Sector to free. + + + + Allocates required number of new sectors. + + Start sector index. + Number of sectors to allocate. + First sector in the new part of the chain. + + + + Allocates required number of free sectors. + + Start sector index (this value points to the last used sector after this operation). + Number of sectors to allocate. + First sector in the new part of the chain + + + + Saves fat data into stream. + + Stream to write fat data into. + DIF object to update after writing. + File header. + + + + Allocates required number of fat sectors. + + Number of sectors that must be allocated. + DIF structure that contains info about fat sectors sequence. + + + + Fills single fat sector. + + Index in the fat to start writing from. + Sector to fill. + First item that wasn't saved inside sector. + + + + Allocates new sector of the specified sector type. + + Sector type to allocate. + Allocated sector index. + + + + Adds single sector to the stream. + + Index of the added sector. + + + + Writes fat data directly into a stream. + + Stream to write data into. + Size of the sector to use for writing. + + + + Evaluates sector offset. + + Zero-based sector index to evaluate offset for. + Offset to the sector start. + + + + Evaluates number of sectors in the sector chain starting from the specified sector. + + Starting sector of the entry to enumerate. + Number of sectros in the sector chain. + + + + Sector size. + + + + + This class represents compound file header. + + + + + Size of the header. + + + + + Signature size. + + + + + Default (and the only supported) signature. + + + + + File signature. + + + + + Class id. + + + + + Minor version of the format. + + + + + Major version of the dll/format. + + + + + Byte order, 0xFFFE for Intel byte-ordering. + + + + + Size of sectors in power-of-two (typically 9). + + + + + Size of mini-sectors in power-of-two (typically 6). + + + + + Reserved, must be zero. + + + + + Reserved, must be zero. + + + + + Reserved, must be zero. + + + + + Number of sectors in the FAT chain. + + + + + First sector in the directory chain. + + + + + Signature used for transactioning, must be zero. + + + + + Maximum size for mini-streams. Typically 4096 bytes. + + + + + First sector in the mini-FAT chain. + + + + + Number of sectors in the mini-FAT chain. + + + + + First sector in the DIF chain. + + + + + Number of sectors in the DIF chain. + + + + + First 109 fat sectors. + + + + + Default constructor. + + + + + Initializes new instance of the file header and extracts data from the stream. + + Stream to extract header data from. + + + + Saves header into specified stream. + + Stream to write header into. + + + + Checks whether starting bytes of the stream are the same as signature of the compound file. + + Stream to check. + True if stream contains required signature. + + + + Checks whether signature is supported. + + + + + Checks whether signature is supported. + + Data to compare with default signature. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Size of the sector. Read-only. + + + + + Minor version of the format. + + + + + Major version of the dll/format. + + + + + Byte order, 0xFFFE for Intel byte-ordering. + + + + + Size of sectors in power-of-two (typically 9). + + + + + Size of mini-sectors in power-of-two (typically 6). + + + + + Reserved, must be zero. + + + + + Reserved, must be zero. + + + + + Reserved, must be zero. + + + + + Number of sectors in the FAT chain. + + + + + First sector in the directory chain. + + + + + Signature used for transactioning, must be zero. + + + + + Maximum size for mini-streams. Typically 4096 bytes. + + + + + First sector in the mini-FAT chain. + + + + + Number of sectors in the mini-FAT chain. + + + + + First sector in the DIF chain. + + + + + Number of sectors in the DIF chain. + + + + + First 109 fat sectors. + + + + + This comparer is used to compare item names inside storage. + + + + + Compares two objects 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. + + Less than zero if x is less than y. + Zero if x equals y. + Greater than zero if x is greater than y. + + + + + Compares two objects 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. + + Less than zero if x is less than y. + Zero if x equals y. + Greater than zero if x is greater than y. + + + + + Suitable Node colors used for 2-3-4 nodes detection. + + + + + Red color of node. + + + + + Black color of node. + + + + + Node class used for proper storing of data in the Map Collection. + + + + + Reference on left branch. + + + + + Reference on right branch. + + + + + Reference on parent branch. + + + + + Color of node branch. + + + + + Is current node Nil element or not? + + + + + Key part of stored in node data. + + + + + Value part of stored in node data. + + + + + Create red colored Tree node. + + Reference on left branch. + Reference on parent branch. + Refernce on right branch. + Key value of node. + Value part of node. + + + + Main constructor of class. + + Reference on left branch. + Reference on parent branch. + Refernce on right branch. + Key value of node. + Value part of node. + Color of node. + + + + Reference on left branch. + + + + + Reference on right branch. + + + + + Reference on parent branch. + + + + + Color of node branch. + + + + + Is current node Nil element or not? + + + + + Key part of stored in node data. + + + + + Value part of stored in node data. + + + + + Is current node set to red color? + + + + + Is current node set to black color? + + + + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + Create collection with specified comparer for Key values. + + Comparer for key values. + + + + Create Empty node for collection. + + + + + Clear collection. + + + + + Add item into collection. + + Key part. + Value. + + + + Check whether collection contains specified key. + + True if node with specified key is found; otherwise False. + Key for check. + + + + Remove from collection item with specified key. + + Key to identify item. + + + + TODO: place correct comment here + + + TODO: place correct comment here + + + + + Get minimum value for specified branch. + + Branch start node. + Reference on minimum value node. + + + + Get maximum value for specified branch. + + Branch start node. + Reference on maximum value node. + + + + Go to to next item in collection. + + Start node. + Reference on next item in collection or this.Empty if nothing found. + + + + Get previous item from collection. + + Start node. + Rererence on previous item in collection. + + + + Find node in collection by key value (search in lower side). + + Key of node to find. + Reference on found node, otherwise this.Empty value. + + + + Find node in collection by key value (search in upper side). + + Key of node to find. + Reference on found node, otherwise this.Empty value. + + + + Rotate branch into left side. + + Branch start node. + + + + Rotate branch into right side. + + Branch start node. + + + + Erase node from collection. + + Item to erase. + + + + Insert item into collection. + + Add into left side of tree or right. + Node for placement. + Key part of node. + Value part of node. + + + + Returns enumerator. + + Returns enumerator of current interface. + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + Bit mask for LinkToContent property of the DocumentProperty class. + + + + + Initializes new isntance of the PropertyData. + + + + + Initializes new instance of the property data. + + Id for the new property.. + + + + Extracts property data from the stream. + + Stream to get data from. + + + + Extracts property data from the stream. + + Stream to get data from. + + + + Determines whether [is valid property]. + + + + + + Extracts vector data from the stream. + + + + + + + + Extracts vector data from the stream. + + + + + + + + Creates array of the specified type. + + Item type. + Number of elements in the array. + Created array object. + + + + Extracts single value from the stream. + + + + + + + + + Extracts single value from the stream. + + + + + + + + + Gets DateTime object data from the stream. + + Stream to get data from. + Buffer used to extract blob parts. + Extracted DateTime data. + + + + Gets blob data from the stream. + + Stream to get blob data from. + Buffer used to extract blob parts. + Blob data. + + + + Gets clipboard data from the stream. + + Stream to get data from. + Buffer that can be used to extract clipboard data parts. + Clipboard data. + + + + Gets object value from the stream. + + Stream to get data from. + Maximum size of the data to extract. + Extracted object. + + + + Gets object value from the stream. + + Stream to get data from. + Maximum size of the data to extract. + Extracted object. + + + + Writes object into the stream. + + Stream to write data into. + Object to write. + Size of the written data. + + + + Writes property data into the stream. + + Stream to write data into. + Number of written bytes. + + + + Serializes names dictionary. + + Stream to serialize into. + Dictionary to serialize. + Size of the serialized data. + + + + Serializes vector data. + + + + + + + + Serializes single value into the stream. + + Stream to serialize into. + Value to serialize. + Value type. + Size of the written data. + + + + Serializes blob data. + + Stream to write blob into. + Blob value to write. + Size of the written data. + + + + Sets property value. + + Value to set. + Type of the property to set. + + + + Indicates whether it is property or just link to source of some property. Read-only. + + + + + Returns id of the parent property. Read-only. + + + + + GEts or sets property id. + + + + + Offset to the section header. + + + + + Section id. + + + + + Section size. + + + + + Contains all section properties. + + + + + Code page of the section. + + + + + Initializes new instance of the section. + + + + + + + Extracts properties from the stream. + + Stream to get section from. + + + + Parses dictionary based on the internal variables value. + + Stream to get dictionary from. + Dictionary to fill if necessary. + + + + Parses property names. + + Stream to get property data from. + Information about dictionary placement inside stream. + Parsed dictionary. + + + + Parses special properties (they shouldn't be visible to user and they contain some information). + + + + + + + + + Parses property names based on previously stored internal information. + + Stream to get data from. + Parsed dictionary. + + + + Saves section into stream. + + Stream to save section into. + + + + Prepares property name dictionary. + + Dictionary with property names. Key - property id, value - property name. + + + + Offset to the section header. + + + + + Section id. + + + + + Section size. + + + + + Properties count. + + + + + Gets list of all properties. + + + + + Contains constants that defines all known sector types. + + + + + Represents the stream helper. + + + + + Size of the Int32 in bytes. + + + + + Size of the Int162 in bytes. + + + + + Size of the Double in bytes. + + + + + Reads Int16 value from the stream. + + Stream to get data from. + Temporary buffer to put extracted bytes into. + Extracted Int32 value. + + + + Reads Int32 value from the stream. + + Stream to get data from. + Temporary buffer to put extracted bytes into. + Extracted Int32 value. + + + + Reads Double value from the stream. + + Stream to get data from. + Temporary buffer to put extracted bytes into. + Extracted Double value. + + + + Writes Int16 value from the stream. + + Stream to get data from. + Value to write. + Size of the written data. + + + + Writes Int32 value from the stream. + + Stream to write data into. + Value to write. + Size of the written data. + + + + Reads Double value from the stream. + + Stream to get data from. + Temporary buffer to put extracted bytes into. + Extracted Double value. + + + + Gets ASCII string from the stream starting from the current position. + + Stream to get data from. + Approximate string size. + Extracted string. + + + + Gets ASCII string from the stream starting from the current position. + + Stream to get data from. + Approximate string size. + Extracted string. + + + + Get the code page name for the current codepage + + + + + + Gets encoding information for the corresponding code page. + + + + + + Extracts unicode string from the stream. + + + + + + + + Gets ASCII string from the stream starting from the current position. + + Stream to get data from. + Approximate string size. + Extracted string. + + + + Writes unicode string into steram. + + Stream to write data into. + Value to write. + Size of the written data in bytes. + + + + Writes string into stream using specified encoding. + + Stream to write data into. + Value to write. + Encoding to use. + Size of the written data in bytes. + + + + Adds padding if necessary. + + + + + + + Removes last zero character from the string if it is present. + + Value to check. + String after removal. + + + + Generate default name. + + Start string. + Collection with names. + Returns new name. + + + + Field type is not Specifies. + + + + + Specifies Addins. + + + + + Offset subsequent text within a line to the left, right, up or down. + + + + + Prompt the user for text to assign to a bookmark. + + + + + The name of the document's author from Summary Info. + + + + + Insert an automatic number. + + + + + Insert an automatic number in legal format. + + + + + Insert an automatic number in outline format. + + + + + Insert an AutoText entry. + + + + + Insert text based on style. + + + + + Insert a delivery point barcode. + + + + + The comments from Summary Info. + + + + + Compares two values. + + + + + The date the document was created. + + + + + Specifies data. + + + + + Insert data from an external database. + + + + + Specified Today`s Date. + + + + + Specified Type as FieldDDE. + + + + + Specified Type as FieldDDEAuto. + + + + + Insert the value of the property. + + + + + Insert the value of the document variable. + + + + + The total document editing time. + + + + + Specifies OLE embedded object. + + + + + Specified Empty Field. + + + + + Specifies Field Expression. + + + + + The document's name. + + + + + The size on disk of the active document. + + + + + Prompt the user for text to insert in the document. + + + + + Specifies FieldType as FootnoteRef. + + + + + Specifies Check box control. + + + + + Specifies Drop Down box control. + + + + + Specifies Text control. + + + + + Calculates the result of an expression. + + + + + Specifies FieldGlossary. + + + + + Specifies GoToButton control. + + + + + Specifies HTMLActiveX control. + + + + + Specifies Hyperlink control. + + + + + Evaluate arguments conditionally. + + + + + Specifies FieldType as Import. + + + + + Specifies FieldType as Export. + + + + + Insert a picture from a file. + + + + + Insert text from a file. + + + + + Create an index. + + + + + Mark an index entry. + + + + + Data from Summary Info. + + + + + The keywords from Summary Info. + + + + + Name of user who last saved the document. + + + + + Linked OLE2 object. + + + + + Insert an element in a list. + + + + + Run a macro. + + + + + Insert a mail merge field. + + + + + The number of the current merge record. + + + + + Merge record sequence number. + + + + + Go to the next record in a mail merge. + + + + + Conditionally go to the next record in a mail merge. + + + + + Insert the number of a footnote or endnote. + + + + + The number of characters in the document. + + + + + The number of pages in the document. + + + + + The number of words in the document. + + + + + Represents an ActiveX control such as a command button etc. + + + + + Insert the number of the current page. + + + + + Insert the number of the page containing the specified bookmark. + + + + + Download commands to a printer. + + + + + The date the document was last printed. + + + + + Stores data for documents converted from other file formats. + + + + + Insert literal text. + + + + + Insert the text marked by a bookmark. + + + + + Create an index, table of contents, table of figures, and/or table of authorities by using multiple documents. + + + + + Insert the number of times the document has been saved. + + + + + The date the document was last saved. + + + + + Insert the number of the current section. + + + + + Insert the total number of pages in the section. + + + + + Insert an automatic sequence number. + + + + + Assign new text to a bookmark. + + + + + Conditionally skip a record in a mail merge. + + + + + Insert the text from a like-style paragraph. + + + + + The document's subject from Summary Info. + + + + + The document's Subscriber from Summary Info. + + + + + Insert a special character + + + + + The name of the template attached to the document. + + + + + The current time. + + + + + The document's title from Summary Info. + + + + + Create a table of authorities. + + + + + Make a table of authorities entry. + + + + + Create a table of contents. + + + + + Make a table of contents entry. + + + + + Address from Tools Options User Info. + + + + + Initials form Tools Options User Info. + + + + + Name from Tools Options User Info. + + + + + Specifies FieldType as Shape. + + + + + Specifies FieldType as BIDIOUTLINE. + + + + + Specifies AddressBlock + + + + + Specifies FieldType as Unknown. + + + + + Tab stop leader + + + + + No leader. + + + + + Dotted leader. + + + + + Hyphenated leader. + + + + + Single line leader. + + + + + Heavy line leader. + + + + + Specifies paragraph text is aligned to the left. + + + + + Specifies paragraph text is aligned to the center. + + + + + Specifies paragraph text is aligned to the right. + + + + + Specifies paragraph text is aligned to both left and right. + + + + + Specifies paragraph characters are distributed to fill the entire width of the paragraph. + + + + + Specifies paragraph uses medium-length Kashida, if the language is Arabic. In other languages, paragraph text is justified with a medium character compression ratio. + + + + + Specifies paragraph uses longer length Kashida, if the language is Arabic. In other languages, paragraph text is justified with a high character compression ratio. + + + + + Specifies paragraph uses small length Kashida, if the language is Arabic. In other languages, paragraph text is justified with a high character compression ratio. + + + + + Specifies paragraph text is justified with Thai distributed justification, if the language is Thai. In other languages, text is justified with a low character compression ratio. + + + + + Specifies the text wrap style. + + + + + In line with text. + + + + + Top and bottom. + + + + + Wraps text around the shape. Line continuation is on the opposite side of the shape. + + + + + Places shape in front of text. + + + + + Tight. + + + + + Through. + + + + + Places shape behind text. + + + + + Represents the caption angle type. + + + + + Fixed caption angle type. + + + + + Free caption angle type. + + + + + Represents the caption escape direction. + + + + + Horizontal caption escape direction. + + + + + Vertical caption escape direction. + + + + + Auto caption escape direction. + + + + + Represents the caption type. + + + + + Straight line caption type. + + + + + Angled line caption type. + + + + + Angled connector line caption type. + + + + + Represents the color mode. + + + + + Greyscale color mode. + + + + + Mono color mode. + + + + + Watermark color mode. + + + + + Represents the draw aspect. + + + + + Content draw aspect. + + + + + Thumbnail draw aspect. + + + + + Icon draw aspect. + + + + + Print view draw aspect. + + + + + Represents drawing fill type. + + + + + No fill. + + + + + Solid fill. + + + + + Bitmap fill. + + + + + Gradient fill. + + + + + Hatch fill. + + + + + Represents reference point for image. + + + + + Top left. + + + + + Top. + + + + + Top right. + + + + + Left. + + + + + Center. + + + + + Right. + + + + + Bottom left. + + + + + Bottom. + + + + + Bottom right. + + + + + Represents measure align type. + + + + + Autmatic measure align. + + + + + Left outside measure align. + + + + + Inside measure align. + + + + + Right outside measure align. + + + + + Represents vertical measure align. + + + + + Automatic vertical measure align. + + + + + Above vertical measure align. + + + + + Below vertical measure align. + + + + + Center vertical measure align. + + + + + Represents shadow. + + + + + Visible shadow. + + + + + Hidden shadow. + + + + + Represents stroke. + + + + + No stroke. + + + + + Dash stroke. + + + + + Solid stroke. + + + + + Represents stroke line join. + + + + + Miter join. + + + + + Round join. + + + + + Bevel join. + + + + + Middle join. + + + + + No join. + + + + + Inherited join. + + + + + Represents text area horizontal alignment. + + + + + Left align. + + + + + Center align. + + + + + Right align. + + + + + Justify. + + + + + Represents text area vertical alignment. + + + + + Top align. + + + + + Middle align. + + + + + Bottom align. + + + + + Justify. + + + + + Represents measure units. + + + + + Auto. + + + + + Millimeter (mm). + + + + + Centimeter (cm). + + + + + Meter (m). + + + + + Kilometer (km). + + + + + Point (pt). + + + + + Pica (pc). + + + + + Inch (inch). + + + + + Feet (ft). + + + + + Mile (mi). + + + + + Represents how fill property paints the shape. + + + + + if the result is zero then the point is outside the path. Otherwise, it is inside. + + + + + If this number is odd, the point is inside; if even, the point is outside. + + + + + Represents the shape to be used at the end of open subpaths when they are stroked. + + + + + Butt shape. + + + + + Square shape. + + + + + Round shape. + + + + + Closing the instance + + + + + Gets/Sets the Continuous section Textbody first item + + + + + Gets/Sets the Continuous section Textbody last item + + + + + Gets/Sets the section style name for the OTextbodyItem + + + + + Gets/Sets the list level number for the Paragraph + + + + + in percent + + + + + in percent + + + + + Sets the width scale, specific for parsers. + + The width scale. + + + + Sets the height scale, specific for parsers. + + The height scale. + + + + Gets or sets the picture height in points + + The float that specifies the height. + + + + Gets or sets the picture width in points. + + The float that specifies the width. + + + + Gets or sets the picture height scale factor in percent. + + The float that specifies the height scale factor. + + + + Gets or sets the picture width scale factor in percent. + + The float that specifies the width scale factor. + + + + Gets or sets the name of the picture. + + The string that represents the name. + + + + Gets or sets absolute horizontal position of the picture in points. + + The float that specifies the horizontal position. + + The horizontal position is relative to the . + + + + + Gets or sets absolute vertical position of the picture in points. + + The float that specifies the vertical position. + + The vertical position is relative to the . + + + + + Gets or sets the index of the order. + + The index of the order. + + + + Gets or Sets the id to the picture instance + + + + + Gets the HeaderFooterContent child items + + + + + Gets or sets the name of the object. + + + + + Gets the Even page footer + + + + + Gets the First page header content + + + + + Gets the First page footer content + + + + + Collection of all the styles in the workbook. + + + + + Adds specified style into this collection. + + Style that must be added. + + + + Collection of all the styles in the workbook. + + + + + Adds specified style into this collection. + + Style that must be added. + + + + Adds specified style into this collection. + + Style that must be added. + + + + Gets/Sets the current page layout columns count + + + + + Gets/Sets the current page layout columns gap + + + + + Collection of all the styles in the workbook. + + + + + Adds specified style into this collection. + + Style that must be added. + + + + First visible character. + + + + + Chars with codes less than 0x20 which are allowed to be used inside xml strings. + + + + + Saves the document to ODS format. + + + + + + Serializes doument manifest which specifies the files in the arhive. + + + + + Serializes the mimetype value. + + + + + Serializes meta data file. + + + + + Serialize the list elements + + + + + + + + To serialize TOC source entries + + + + + Serialize OPicture instance + + + + + + Serialize Merge Field + + The Merge Field + + + + Serialize Merge Field + + The Merge Field + + + + Serialize hyperlink field + + The Field + + + + Document default Paragraph properties + + + + + Document Default Text properties + + + + + Serializes teh Odd/First Page HeaderFooter contents + + + + + + + This class holds the name of the Syncfusion.DocIO.Base assembly and provides a helper + routine that helps with resolving types when loading a serialization stream and when + the framework probes for assemblies by reflection. + + + + + The full name of this assembly without version information: "Syncfusion.DocIO.Base". + + + + + A reference to the for the DocIO assembly. + + + + + The root namespace of this assembly. Used internally for locating resources within the assembly. + + + + + + + + + + Configuration class for the DocIO library. In the current version, there are no explicit settings. + Adding this component from the toolbar allows you to easily configure your project for MS Word support. + + + + + Initializes a new instance of the class. + + + + + Copyright notice for the library. + + + + + Closes this instance. + + + + + Represents a collection of items. + + + + + Represents the child shape of group shape in the Word document. + + + + + Represents the shape common. + + + + + Provides the base implementation for all paragraph items. + + + + + The base implementation of IWidget interface + + + + + Provides the base implementation for DLS entities. + + + + + + + + + + Provides the base implementation for all the classes with holder behavior. + + + + + Specifies the Word document instance. + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified instance. + + The instance. + + + + Initializes a new instance of the class + with the specified instance and + instance. + + The doc. + The owner. + + + + Sets the owner. + + The owner. + + + + Sets the owner. + + The doc. + + + + Sets the owner. + + The doc. + The owner. + + + + "Listener" for state change. + + + + + Closes this instance. + + + + + Gets the owner document. Read-only. + + The instance. + + + + Gets the owner. + + The owner. + + + + Represents required functionality for serialization by XDLSReader/Writer. + Used for objects/items implementation + + + + + Object can writes by this method own "value" properties + + + + + + Object can writes by this method own complex/binary data. + + + + + + Object can reads by this method own "value" properties + + + + + + Object can reads by this method own complex/binary data. + + + + + + Object can use this method for restore references. + + + + + + + Gets special holder with child objects. + + + + + + + + + + Initializes a new instance of the class. + + The doc. + The entity. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Clones itself. + + Returns cloned object. + + + + Clones the relations. + + The doc. + + + + Clones itself. + + + Returns cloned object. + + + + Writes object data as xml attributes. + + + The object. + + + + Writes object data as inside xml element. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + The value indicating the presence of xml content. + + + + Registers child objects in XDSL holder. + + + + + + + + + + + + + Closes this instance. + + + + + + + + + + + + + + + Represents an entity + + + + + Creates a duplicate of the entity. + + The object which is a copy of the current entity + + + + Gets the of this entity. + + + + + Gets the owner of the entity. + + The that specifies the owner. + + + + Gets the type of the entity. + + The of the current item. + + + + Gets the next sibling of the entity. + + The that represents the next sibling. + + + + Gets the previous sibling of the entity. + + The that represents the previous sibling. + + + + Gets a value indicating whether this instance is composite. + + True if this instance is composite, otherwise false. + + + + Represents the revision collection. + + + + + Represents the revision collection if the item is cloned and not added to document. + + + + + Determine whether the paraItem is in floating item or not. + + + + + + + Checks whether current floating is fallback item or not. + + + + + Determines whether the specified built in style type is character style or not. + + built in style. + trueif the built in style type is character style, otherwisefalse + + + + Initializes a new instance of the class. + + The object. + The that is the owner. + + + + Creates a duplicate copy of the entity. + + The object which is a copy of the current entity. + + + + Returns bool indiacting whether the text is in vertical direction + + + + + + Adds the self. + + + + + Attaches to document + + + + + Removes the self. + + + + + Gets the index in parent collection. + + + + + + Determines whether is parent of the specified entity. + + The entity. + + If it is parent of the specified entity, set to true. + + + + + To initialize the layoutinfo as null + + Last TOC Entry entity + Set to True if last TOC entry is reached + + + + Gets the owner textbody + + + + + + + Gets the base entity for shape. + + + + + + + Gets the base entity + + + + + + + Gets the hierarchical index of the entity. + + The hierarchicalIndex. + + + + + Get ZOrderIndex value for the entity + + + + + + Sort the floating item based on its DOM Position + + Second floating item + Truewhen we need to sort the floating item collection based on its position + + + + sort the floating items based on its owner table and paragraph + + first floating item owner paragrpah + second floating item owner paragrpah + + + + + sort the floating items based on its owner table + + first floating item owner table cell + second floating item owner cell + + + + + Gets the owner section of given entity + + Entity + Owner section of current entity + + + + Gets the owner table of given entity + + Entity + Owner table of current entity + + + + Gets the owner cell + + The Owner cell of the given entity + + + + Compare the current document with revised document + + The original document instance + + + + Remove and unlink revision from the entity while removing. + + + + + + Remove and unlink revision from the format base while removing the entity. + + + + + + Closes this instance. + + + + + Gets the owner of the entity. + + The that specifies the owner. + + + + Gets the type of the entity. + + The of the current item. + + + + Gets the next sibling of the entity. + + The that represents the next sibling. + + + + Gets the previous sibling of the entity. + + The that represents the previous sibling. + + + + Gets a value indicating whether this instance is composite. + + True if this instance is composite, otherwise false. + + + + Gets a value indicating whether this is detached. + + if detached, set to true. + + + + Gets the revision changes marked with revision marks in a range or document. + + + + + Represents a base Widget interface + + + + + Initializing LayoutInfo value to null + + + + + Gets layout info. + + + + + + + + + + Initializes a new instance of the class. + + The doc. + The owner. + + + + Initializing layout info to null + + + + + + + + + + Gets layout info. + + + + + Represents the paragraph item + + + + + Gets the owner paragraph of the current paragraph item. Read-only + + The instance which is the owner of the current item. + + + + Gets a value indicating whether this item was inserted to the document, + when is or was set to true. Read-only. + + True if this instance was inserted; otherwise, false. + + + + + Gets a value indicating whether this item was deleted from the document, + when is or was set to true. Read-only. + + True if this instance is delete revision; otherwise, false. + + + + + Specifies the character format. + + + + + + Gets the WMath which contains the math run element + + Represents IOfficeMathRunElement which contains paragraph item + Return WMath in Word document + + + + Applies the style with the specified name to all paragraph items. + + The string that represents the style name. + The specified style must exists in collection. + + + + Applies the specified style. + + Style name + Specified style must exist in Document.Styles collection + + + + Get Owner Paragraph of the Item is in SDTInlineContent + + + + + + Sets the insert revision. + + if it specifies insert revision, set to true. + + + + Sets the delete revision. + + if it specifies delete revision, set to true. + + + + Initializes a new instance of the class with the specified instance. + + The instance. + + + + Attaches to paragraph. + + + + + Detaches from owner. + + + + + Accepts the changes. + + + + + Removes the format changes. + + + + + Determines whether has tracked changes. + + + if has tracked changes, set to true. + + + + + Gets the char format. + + + + + + //Apply the table style properties to cloned paragraph. + + Original paragraph. + Cloned paragraph. + + + + Sets the character format. + + + + + + + Checks the shape field + + + + + + + Updates track changes revision of para item while adding the entity. + + + + + + Checks the track change. + + The item. + + + + Closes this instance. + + + + + Creates a duplicate copy of . + + The reference of the newly created object. + + + + Releases all resources used by the object. + + + + + Creates a duplicate copy of the . + + + The reference of the newly created object. + + + + //Sets the move revision first and last item + + The move revision + The item + + + + Clones the relations. + + The doc. + + + + Get text wrapping style + + + + + + Determines whether is wrapping bounds added or not. + + + + + + Set the wrapping bounds added flag. + + + + + + Gets the lay out in cell. + + + + + + Get vertical origin + + + + + + Get shape vertical alignment + + + + + + + Get shape horizontal alignment + + + + + + + Get horizontal origin + + + + + + Get horizontal position + + + + + + Get vertical position + + + + + + Gets the allow overlap. + + + + + + Get the effectExtent values + + + + + + + + + + Get Left margin of the section. + + + + + + + Get the right margin of the section + + + + + + + Get the base entity + + + + + + + Get width relative to percent + + + + + + Get height relative to percent + + + + + + Gets the index of the wrap collection. + + + + + + Used to parse a VML Path points of 2007 custom shape. + + + + + Parse a VML Path and create a Path2D point collections. + + Represent a input VML path to parse. + Returns a parsed Path2d point collection. + + + + Skip a leading white spaces of input Path from specified starting index. + + Represent a input VML Path. + Represent a starting index. + + + + Gets a numeric Path point from a specified index to next Path separator. + + Represent a input VML Path. + Represent a starting index. + Returns a VML Path point. + + + + Gets a next VML Path command index from specified start index. + + Represent a input path to find. + Represent a start index to start from. + Returns a index of next VML Path command. + + + + Check whether input path has only a valid (supported) VML Path commands or not. + + At present, we do support for only limited VML Path commands and + this method used to identify whether current ChildShape Path has supported VML Path commands or not. + Represent a input path to check. + Returns true, if all the VML commands are supported; Otherwise false. + + + + Update a VML Path points with its CoordinateSize and CoordinateOrigin values. + + Represent a updated bounds of a child shape. + + + + Re-update the VML Path points with its CoordinateSize and CoordinateOrigin values. + + + + + + + + + + + Gets or sets a value indicating whether this is cloned. + + + true if cloned; otherwise, false. + + + + + Gets the owner paragraph of the current paragraph item. Read-only + + The instance which is the owner of the current item. + + + + Gets a value indicating whether this item was inserted to the document, + when is or was set to true. Read-only. + + True if this instance was inserted; otherwise, false. + + + + + Gets a value indicating whether this item was deleted from the document, + when is or was set to true. Read-only. + + True if this instance is delete revision; otherwise, false. + + + + + Gets or set a value indicating whether this instance has changed format. + + + if this instance has changed format, set to true. + + + + + Gets or sets the start pos of paragraph item. + + The start pos. + + + + Gets the end pos of paragraph item. + + The end pos. + + + + Gets a value indicating whether this is detached. + + if detached, set to true. + + + + Sets the paragraph item character format. + + The paragraph item char format. + + + + Reserved for internal use. + + + + + If the item is move revision range first item, then returns true else false. + This boolean is maintained for cloned item which is not added to document + + + + + If the item is move revision range last item, then returns true else false. + This boolean is maintained for cloned item which is not added to document + + + + + Get or set the new start position + + + + + Get or set new end position. + + + + + Sets the property key + + + + + Creates a duplicate copy of this + or object. + + + The reference to the newly created object. + + + + Gets layouting bounds for shape's text body + + + /// + + + + + + Gets or sets ID of the shape + + + + + Gets or sets the height of the shape or chart measured in points. + + The float that specifies the height of the shape or chart. + + + + Gets or sets the width of the shape or chart measured in points. + + The float that specifies the width of the shape or chart. + + + + Gets or sets the height scale factor of shape or chart or child shapes measured in percent. + + The float that specifies the height scale factor. + + + + Gets or sets the width scale factor of shape or chart or child shapes measured in percent. + + The float that specifies the width scale factor. + + + + Properties Collection + + + + + Gets or sets the value for the property with specified key. + + The key for the property. + An object with the specific key. + + + + Gets or sets the alternate text for the shape or chart. + + The string that represents the alternate text. + + + + Gets or sets the name of the shape or chart. + + The string that represents the name. + + + + Gets or sets the title for the shape or chart. + + The string that represents the title. + + + + Gets the stream the shape/chart elements + + + + + Gets or Sets the path + + + + + Gets or sets the Coordinate size of the shape or chart. + + The for the shape or chart. + + + + Gets or sets the Coordinate X Origin of the shape or chart. + + The for the shape or chart. + + + + Gets or sets the Coordinate Y Origin of the shape or chart. + + The for the shape or chart. + + + + Represent a widget that can MEASURE self. + + + + + Measures self size. + + + + + + + Sets the property key + + + + + Detaches from owner. + + + + + Executes when the entity is attached to the owner document. + + + + + Creates a duplicate copy of this object. + + + The reference of the newly created . + + + + Clones the relations. + + + + + + Gets the Guide List value of custom shape + + + + + + Gets the Av List value of custom shape + + + + + + Clones the ChildShape format + + + + + + Creates a duplicate copy of the shape format. + + The reference of the newly created . + + + + Creates a duplicate copy of this object. + + The reference of the newly created . + + + + Checks whether the fill style needs to be taken from the parent child group shape. + + Child Group Shape + + + + Apply owner group shape or childGroupshape fill + + Textbox, shape or picture + + + + Implemented alternative method to improve the performance + + + + + + + + To get the color from theme item + + + + + + + + + To get the percentage value from the given string + + + + + + + Initializing LayoutInfo value to null + + + + + + + + + + + + Creates the layout information. + + + + + + Compares the current child shape with another child shape of another document. + + + + + + + Gets the child shape text for Word comparison + + + + + + Gets the properties text for Word comparison + + + + + + Gets or Sets the Custom Shape path list value + + + + + Gets or Sets a VML Path points to draw. + + + + + Flag to ensure Effect Style applied for shape inline + + + + + Gets the shape guide + + The shape guide. + + + + Gets or Sets picture hRef string + + + + + Gets the SVG image as byte array. Read-only. + + The array that represents SVG image bytes. + + + + Gets or set the SVG external image link. + + + + + Flag to ensure Fill Style applied for shape inline + + + + + Gets or sets a value indicating whether [flip horizantal]. + + + true if [flip horizantal]; otherwise, false. + + + + + Gets or sets a value indicating whether [flip vertical]. + + + true if [flip vertical]; otherwise, false. + + + + + Flag to ensure Fill Style applied for shape inline + + + + + Gets or Sets the shape style references + + + + + Flag to ensure Fill Style applied for shape inline + + + + + Flag to ensure Line Style applied for shape inline + + + + + Gets or Sets the Font reference color + + + + + Gets or sets the X position of the child shape within the Group shape + + + + + Gets or sets the Y position of the child shape within the Group shape + + + + + Gets or sets the X position of the child shape within the Group shape + + + + + Gets or sets the Y position of the child shape within the Group shape + + + + + Gets or Sets the type of Shape + + + + + Gets or Sets the type of the ChildShape element + + + + + Gets a value indicating whether the ChildShape instance contains valid text body. + + + + + Gets or Sets the left position + + + + + Gets or Sets the top position + + + + + Properties Collection + + + + + Gets or Sets the left position + + + + + Gets or Sets the top position + + + + + Gets or Sets the left position + + + + + Gets or Sets the top position + + + + + Gets or Sets textbody content of the child shape + + + + + Gets or Sets the text body properties + + + + + Gets or Sets line format + + + + + Gets or Sets fill format + + + + + Gets or sets the chart instance. + + + + + Gets or sets the XmlParagraphItem + + + + + Gets or sets the type of the auto shape + + + + + + + + + + Gets the image as byte array + + + + + Gets the document instance + + + + + Gets/ sets Effect format of the shape + + + + + Gets or Sets the flag for Horizontal rule + + + + + Gets or sets a value indicating whether this is text box shape + + + + + Gets or Sets the adjustments + + + + + Gets or sets the child shape rotation in degree. + + The float that specifies the rotation value of the child shape. + A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. + + + + Gets or Sets the Arc size + + + + + Gets or Sets 2007 unparsed streams + + + + + Gets or Sets the flag for StandardColorHR + + + + + Gets or Sets the flag for UseNoShadeHR + + + + + Gets the relations. + + The relations. + + + + Gets the docx style properties. + + The docx style props. + + + + Gets or sets the value indicating whether the anchor is in cell + + + + + Gets or sets a value indicating whether [is2007 shape]. + + + true if [is2007 shape]; otherwise, false. + + + + + Gets the image relations. + + The image relations. + + + + Gets the Entity type + + + + + Get/Set Text content layouting bounds for shape + + + + + Gets or sets the child shape rotation in degree after calculating a proper rotation from parent group shape. + + The float that specifies the rotation value of the child shape to render in PDF. + A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. + + + + Gets or sets a value indicating whether [flip horizantal] after calculating a proper flipH from parent group shape. + + + true if [flip horizantal]; otherwise, false that specifies the flipH value of the child shape to render in PDF. + + + + + Gets or sets a value indicating whether [flip vertical] after calculating a proper flipV from parent group shape. + + + true if [flip vertical]; otherwise, false that specifies the flipV value of the child shape to render in PDF. + + + + + Gets or sets the value for the property with specified key. + + The key for the property. + An object with the specific key. + + + + To auto generate shape id + + + + + To add child shape for grouping + + The child shape + + + + Creates a duplicate copy of this object. + + The reference of the newly created . + + + + Clones the relations. + + + + + + Compares the current child groupshape with another child groupshape of another document. + + + + + + + Gets the child group shape text for Word comparison + + + + + + Gets the properties text for Word comparison + + + + + + Gets or sets the X position of the child group shape within the Group shape + + + + + Gets or sets the Y position of the child group shape within the Group shape + + + + + Gets or Sets the child extents X- value + + + + + Gets or Sets child extents Y- value + + + + + Checks the item is picture + + + + + Gets the Entity type + + + + + Represent a Path2D class to hold a VML custom Path points. + + + + + Create a object for Path2D class with specified VML PathCommandType and VML PathPoints. + + Represent a type of VML Path command. + Represent a VML Path points. + + + + Create a object for Path2D class + + + + + CLone Path2D + + + + + + Closes this instance. + + + + + Compares the current path2D with another path2D. + + + + + + + Gets the properties text for Word comparison + + + + + + Gets a VML Path command type. + + + + + Gets a custom VML Path points. + + + + + Stores the path elements + + + + + Gets or Sets the path width + + + + + Gets or Sets the path height + + + + + Gets or Sets whether path is stroke + + + + + Represents the group shape in the Word document. + + + + + Provides the base implementation for chart and shape classes. + + + + + Creates a duplicate copy of this + or object. + + + The reference to the newly created object. + + + + Gets or sets the horizontal origin values for shape or chart. + + The member that specifies the horizontal origin. + + + + Gets or sets the horizontal origin value related to relative width of shape. + + The member that specifies the horizontal origin. + + + + Gets or sets the vertical origin value related to relative height of shape. + + The member that specifies the vertical origin. + + + + Gets or sets the horizontal origin value related to relative horizontal position. + + The member that specifies the horizontal origin. + + + + Gets or sets the vertical origin value related to realtive vertical position. + + The member that specifies the vertical origin. + + + + Gets or sets the horizontal alignment for shape or chart. + + The member that specifies the horizontal alignment. + + + + Gets or sets horizontal position of shape or chart measured in points. + + The float that specifies the horizontal position of the shape or chart. + + + + Gets or sets the relative horizontal position of shape. + + + + + Gets or Sets the relative vertical position of shape. + + + + + Gets or Sets relative height of shape. + + + + + Gets or Sets relative width of shape. + + + + + Gets or Sets a value indicating whether the shape has relative vertical position. + + + + + Gets or Sets a value indicating whether the shape has relative horizontal position. + + + + + Gets or Sets a value indicating whether the shape has relative height. + + + + + Gets or Sets a value indicating whether the shape has relative width. + + + + + Gets or sets vertical origin of the shape or chart. + + The member that specifies the vertical origin. + + + + Gets or sets the vertical alignment of the shape or chart. + + The member that specifies the vertical alignment. + + + + Gets or sets the vertical position of the shape or chart measured in points. + + The float that specifies the vertical position of the shape or chart. + + + + Gets or sets the text wrap format of the shape or chart. + + The for the shape or chart. + + + + Gets or sets the relative height of the shape + + + + + Gets or sets a value indicating whether the shape or chart should be preserved + behind the text that surrounds the shape or chart. + + True if the shape or chart will be preserved behind the text; + false if the shape or chart will be preserved in front of the text. + + + + Gets or sets the value indicating whether the anchor is in cell + + + + + Gets or sets the value indicating whether the anchor position can be modified. + + True if the position of anchor should not be modified; otherwise, false. + + + + Gets or sets a value indicating whether this instance is cloned. + + + true if this instance is cloned; otherwise, false. + + + + + True if visible; otherwise, false. + + + + + Gets or sets the left edge extent value for a shape + + The float that specifies the left edge value of effect extent + + + + Gets or sets the top edge extent value for a shape + + The float that specifies the top edge value of effect extent + + + + Gets or sets the right edge extent value for a shape + + The float that specifies the right edge value of effect extent + + + + Gets or sets the bottom edge extent value for a shape + + The float that specifies the bottom edge value of effect extent + + + + Add the paragraph items to the Group shape + + The collection. + + + + Adds the specified shape (picture, shape, group shape) to the group shape. + + The instance + + + + Convet the Shape to ChildShape instance + + The Shape instance + + + + + Converts textbox to childShape instance. + + The Textbox instance + + + + + Converts Chart to childShape instance. + + The Chart instance + + + + + Convert the Picture to ChildShape instance + + The Picture instance + + + + + Convert the into child shape. + + The group shape + + + + + Detaches from owner. + + + + + Executes when the entity is attached to the owner document. + + + + + Update the group shape bounds and child shape bounds + + + + + Ungroups the child shapes in the group shape + + Returns the ungrouped items as paragraph item array. + + + + Ungroup all the child shapes in + + + + + + + Converts the child shape into shape. + + Represents a child shape. + + + + + Convert the into . + + Represents one of in the + + + + + Convert the to + + The instance + The instance + + + + Convert the into . + + Represents one of in the + + + + + Convert the into . + + Represents one of in the + + + + + Initializes a new instance of class with the specified + instance. + + The instance. + + + + Initializes a new instance of class with the specified + instance. + + The instance. + The collection within the GroupShape. + + + + Compares the current groupshape with another groupshape of another document. + + + + + + + Gets the Group shape text for Word comparison + + + + + Gets the properties text for Word comparison + + + + + + Initializes the default values for GroupShape in VML structure. + + + + + Creates a duplicate copy of this object. + + + The reference of the newly created . + + + + Clones the relations. + + + + + + Check whether group shape has child group shape or not. + + Returns true, if it has a child group shape; Otherwise false. + + + + Applies the specified character format to the shape. + + The character format to be applied. + + + + Duplicates the group shape format + + + + + Initializing LayoutInfo value to null + + + + + Sets the width depends on relative width of shape. + + + + + + Sets the height depends on relative height of shape. + + + + + + + + + + + + + Creates the layout information. + + + + + + Implemented alternative method to improve the performance + + + + + + + + Gets the Shape object as Image + + + + + + Gets or sets the child shape + + + + + Gets the relations. + + The relations. + + + + Gets the image relations. + + The image relations. + + + + Gets or sets the group shape rotation in degree. + + The float that specifies the rotation value of the group shape. + A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. + + The following code example demonstrates how to gets or sets the rotation value of group shape in degree. + + //Creates a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new paragraph to the section + WParagraph paragraph = section.AddParagraph() as WParagraph; + //Creates new group shape + GroupShape groupShape = new GroupShape(document); + //Adds group shape to the paragraph. + paragraph.ChildEntities.Add(groupShape); + //Creates new shape + Shape shape = new Shape(document, AutoShapeType.RoundedRectangle); + //Sets height and width for shape + shape.Height = 100; + shape.Width = 150; + //Sets horizontal and vertical position + shape.HorizontalPosition = 72; + shape.VerticalPosition = 72; + //Set wrapping style for shape + shape.WrapFormat.TextWrappingStyle = TextWrappingStyle.InFrontOfText; + //Sets horizontal and vertical origin + shape.HorizontalOrigin = HorizontalOrigin.Page; + shape.VerticalOrigin = VerticalOrigin.Page; + //Adds the specified shape to group shape + groupShape.Add(shape); + //Creates new picture + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + //Sets wrapping style for picture + picture.TextWrappingStyle = TextWrappingStyle.InFrontOfText; + //Sets height and width for the image + picture.Height = 100; + picture.Width = 100; + //Sets horizontal and vertical position + picture.HorizontalPosition = 400; + picture.VerticalPosition = 150; + //Sets horizontal and vertical origin + picture.HorizontalOrigin = HorizontalOrigin.Page; + picture.VerticalOrigin = VerticalOrigin.Page; + //Adds the specified picture to group shape + groupShape.Add(picture); + //Sets group shape rotation in degree + groupShape.Rotation = 90; + //Saves the Word document + document.Save("Sample.docx", FormatType.Docx); + //Closes the document + document.Close(); + + + 'Creates a new Word document + Dim document As WordDocument = New WordDocument + 'Adds new section to the document + Dim section As IWSection = document.AddSection + 'Adds new paragraph to the section + Dim paragraph As WParagraph = CType(section.AddParagraph, WParagraph) + 'Creates new group shape + Dim groupShape As GroupShape = New GroupShape(document) + 'Adds group shape to the paragraph. + paragraph.ChildEntities.Add(groupShape) + Dim shape As Shape = New Shape(document, AutoShapeType.RoundedRectangle) + 'Sets height and width for shape + shape.Height = 100 + shape.Width = 150 + 'Sets horizontal and vertical position + shape.HorizontalPosition = 72 + shape.VerticalPosition = 72 + 'Set wrapping style for shape + shape.WrapFormat.TextWrappingStyle = TextWrappingStyle.InFrontOfText + 'Sets horizontal and vertical origin + shape.HorizontalOrigin = HorizontalOrigin.Page + shape.VerticalOrigin = VerticalOrigin.Page + 'Adds the specified shape to group shape + groupShape.Add(shape) + Dim picture As WPicture = New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + 'Sets wrapping style for picture + picture.TextWrappingStyle = TextWrappingStyle.InFrontOfText + 'Sets height and width for the image + picture.Height = 100 + picture.Width = 100 + 'Sets horizontal and vertical position + picture.HorizontalPosition = 400 + picture.VerticalPosition = 150 + 'Sets horizontal and vertical origin + picture.HorizontalOrigin = HorizontalOrigin.Page + picture.VerticalOrigin = VerticalOrigin.Page + 'Adds the specified picture to group shape + groupShape.Add(picture) + 'Sets group shape rotation in degree + groupShape.Rotation = 90 + 'Saves the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Closes the document + document.Close() + + + + + + Gets or sets a Horizontal flipping of GroupShape. + + + true indicates that a groupshape has been flipped horizontally; otherwise, false. + + This property returns True if the specified groupshape is flipped around the horizontal axis, and False if not. + + The following code example demonstrates how to gets or sets the horizontal flip to group shape. + + //Creates a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new paragraph to the section + WParagraph paragraph = section.AddParagraph() as WParagraph; + //Creates new group shape + GroupShape groupShape = new GroupShape(document); + //Adds group shape to the paragraph. + paragraph.ChildEntities.Add(groupShape); + //Creates new shape + Shape shape = new Shape(document, AutoShapeType.RoundedRectangle); + //Sets height and width for shape + shape.Height = 100; + shape.Width = 150; + //Sets horizontal and vertical position + shape.HorizontalPosition = 72; + shape.VerticalPosition = 72; + //Set wrapping style for shape + shape.WrapFormat.TextWrappingStyle = TextWrappingStyle.InFrontOfText; + //Sets horizontal and vertical origin + shape.HorizontalOrigin = HorizontalOrigin.Page; + shape.VerticalOrigin = VerticalOrigin.Page; + //Adds the specified shape to group shape + groupShape.Add(shape); + //Creates new picture + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + //Sets wrapping style for picture + picture.TextWrappingStyle = TextWrappingStyle.InFrontOfText; + //Sets height and width for the image + picture.Height = 100; + picture.Width = 100; + //Sets horizontal and vertical position + picture.HorizontalPosition = 400; + picture.VerticalPosition = 150; + //Sets horizontal and vertical origin + picture.HorizontalOrigin = HorizontalOrigin.Page; + picture.VerticalOrigin = VerticalOrigin.Page; + //Adds the specified picture to group shape + groupShape.Add(picture); + //Sets horizontal flip to the group shape + groupShape.FlipHorizontal = true; + //Saves the Word document + document.Save("Sample.docx", FormatType.Docx); + //Closes the document + document.Close(); + + + 'Creates a new Word document + Dim document As WordDocument = New WordDocument + 'Adds new section to the document + Dim section As IWSection = document.AddSection + 'Adds new paragraph to the section + Dim paragraph As WParagraph = CType(section.AddParagraph, WParagraph) + 'Creates new group shape + Dim groupShape As GroupShape = New GroupShape(document) + 'Adds group shape to the paragraph. + paragraph.ChildEntities.Add(groupShape) + Dim shape As Shape = New Shape(document, AutoShapeType.RoundedRectangle) + 'Sets height and width for shape + shape.Height = 100 + shape.Width = 150 + 'Sets horizontal and vertical position + shape.HorizontalPosition = 72 + shape.VerticalPosition = 72 + 'Set wrapping style for shape + shape.WrapFormat.TextWrappingStyle = TextWrappingStyle.InFrontOfText + 'Sets horizontal and vertical origin + shape.HorizontalOrigin = HorizontalOrigin.Page + shape.VerticalOrigin = VerticalOrigin.Page + 'Adds the specified shape to group shape + groupShape.Add(shape) + Dim picture As WPicture = New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + 'Sets wrapping style for picture + picture.TextWrappingStyle = TextWrappingStyle.InFrontOfText + 'Sets height and width for the image + picture.Height = 100 + picture.Width = 100 + 'Sets horizontal and vertical position + picture.HorizontalPosition = 400 + picture.VerticalPosition = 150 + 'Sets horizontal and vertical origin + picture.HorizontalOrigin = HorizontalOrigin.Page + picture.VerticalOrigin = VerticalOrigin.Page + 'Adds the specified picture to group shape + groupShape.Add(picture) + 'Sets horizontal flip to the group shape + groupShape.FlipHorizontal = True + 'Saves the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Closes the document + document.Close() + + + + + + Gets or sets a Vertical flipping of GroupShape. + + + true indicates that a groupshape has been flipped vertically; otherwise, false. + + This property returns True if the specified groupshape is flipped around the vertical axis, and False if not. + + The following code example demonstrates how to gets or sets the vertical flip to group shape. + + //Creates a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new paragraph to the section + WParagraph paragraph = section.AddParagraph() as WParagraph; + //Creates new group shape + GroupShape groupShape = new GroupShape(document); + //Adds group shape to the paragraph. + paragraph.ChildEntities.Add(groupShape); + //Creates new shape + Shape shape = new Shape(document, AutoShapeType.RoundedRectangle); + //Sets height and width for shape + shape.Height = 100; + shape.Width = 150; + //Sets horizontal and vertical position + shape.HorizontalPosition = 72; + shape.VerticalPosition = 72; + //Set wrapping style for shape + shape.WrapFormat.TextWrappingStyle = TextWrappingStyle.InFrontOfText; + //Sets horizontal and vertical origin + shape.HorizontalOrigin = HorizontalOrigin.Page; + shape.VerticalOrigin = VerticalOrigin.Page; + //Adds the specified shape to group shape + groupShape.Add(shape); + //Creates new picture + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + //Sets wrapping style for picture + picture.TextWrappingStyle = TextWrappingStyle.InFrontOfText; + //Sets height and width for the image + picture.Height = 100; + picture.Width = 100; + //Sets horizontal and vertical position + picture.HorizontalPosition = 400; + picture.VerticalPosition = 150; + //Sets horizontal and vertical origin + picture.HorizontalOrigin = HorizontalOrigin.Page; + picture.VerticalOrigin = VerticalOrigin.Page; + //Adds the specified picture to group shape + groupShape.Add(picture); + //Sets vertical flip to the group shape + groupShape.FlipVertical = true; + //Saves the Word document + document.Save("Sample.docx", FormatType.Docx); + //Closes the document + document.Close(); + + + 'Creates a new Word document + Dim document As WordDocument = New WordDocument + 'Adds new section to the document + Dim section As IWSection = document.AddSection + 'Adds new paragraph to the section + Dim paragraph As WParagraph = CType(section.AddParagraph, WParagraph) + 'Creates new group shape + Dim groupShape As GroupShape = New GroupShape(document) + 'Adds group shape to the paragraph. + paragraph.ChildEntities.Add(groupShape) + Dim shape As Shape = New Shape(document, AutoShapeType.RoundedRectangle) + 'Sets height and width for shape + shape.Height = 100 + shape.Width = 150 + 'Sets horizontal and vertical position + shape.HorizontalPosition = 72 + shape.VerticalPosition = 72 + 'Set wrapping style for shape + shape.WrapFormat.TextWrappingStyle = TextWrappingStyle.InFrontOfText + 'Sets horizontal and vertical origin + shape.HorizontalOrigin = HorizontalOrigin.Page + shape.VerticalOrigin = VerticalOrigin.Page + 'Adds the specified shape to group shape + groupShape.Add(shape) + Dim picture As WPicture = New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + 'Sets wrapping style for picture + picture.TextWrappingStyle = TextWrappingStyle.InFrontOfText + 'Sets height and width for the image + picture.Height = 100 + picture.Width = 100 + 'Sets horizontal and vertical position + picture.HorizontalPosition = 400 + picture.VerticalPosition = 150 + 'Sets horizontal and vertical origin + picture.HorizontalOrigin = HorizontalOrigin.Page + picture.VerticalOrigin = VerticalOrigin.Page + 'Adds the specified picture to group shape + groupShape.Add(picture) + 'Sets vertical flip to the group shape + groupShape.FlipVertical = True + 'Saves the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Closes the document + document.Close() + + + + + + Gets the Entity Type + + + + + Gets or Sets the AutoShape type + + + + + Gets or Sets the line format + + + + + Flag to ensure Fill Style applied for shape inline + + + + + Flag to ensure Line Style applied for shape inline + + + + + Gets or Sets the shape style references + + + + + Flag to ensure Effect Style applied for shape inline + + + + + Gets/ sets Effect format of the shape + + + + + Gets or sets a value indicating whether [is2007 shape]. + + + true if [is2007 shape]; otherwise, false. + + + + + Flag to ensure Fill Style applied for shape inline + + + + + Gets or sets the fill effects for the shape. + + The instance. + + + + Flag to ensure Fill Style applied for shape inline + + + + + Gets or Sets the X- value + + + + + Gets or Sets 2007 unparsed streams + + + + + Gets or Sets Y- value + + + + + Gets or Sets the child extents X- value + + + + + Gets or Sets child extents Y- value + + + + + Gets or Sets the left position + + + + + Gets or Sets the top position + + + + + Gets the docx style properties. + + The docx style props. + + + + Represents the collection interface. + + + + + + + + + + Initializes a new instance of the class. + + The object. + The The object. + + + + Initializes a new instance of the class. + + + + + + + + Initializes a new instance of the class. + + + + + Returns an enumerator that iterates through a collection. + + + An object that can be used to iterate through the collection. + + + + + Closes this instance. + + + + + Gets the number of items in the collection. + + The integer that specifies the count of items. + + + + Gets the inner list. + + The inner list. + + + + Adds the specified to the collection. + + The instance. + + + + Update the group shape bounds and child shape bounds + + + + + Removes a child shape at the specified index. + + The integer that represents the position of the child shape to remove. + + + + Removes all the child shapes in the group shape. + + + + + Removes the specified child shape from the Group shape. + + The instance + + + + Gets the at the specified index + + The zero-based index of the entity to get. + Returns the at the specified index + + + + Specifies the types of auto shapes. + + + + + The unknown type + + + + + Rectangle. + + + + + Rounded rectangle. + + + + + Snip single corner rectangle. + + + + + Snip same side corner rectangle. + + + + + Snip diagonal corner rectangle. + + + + + Snip and round single corner rectangle. + + + + + Round single corner rectangle. + + + + + Round same side corner rectangle. + + + + + Round diagonal corner rectangle. + + + + + Oval. + + + + + Isosceles triangle. + + + + + Right triangle. + + + + + Parallelogram. + + + + + Trapezoid. + + + + + Diamond. + + + + + Regular pentagon. + + + + + Hexagon. + + + + + Heptagon. + + + + + Octagon. + + + + + Decagon. + + + + + Dodecagon. + + + + + Pie. + + + + + Chord. + + + + + Teardrop. + + + + + Frame. + + + + + Half frame. + + + + + L_Shape. + + + + + Diagonal stripe. + + + + + Cross. + + + + + Plaque. + + + + + Can. + + + + + Cube. + + + + + Bevel. + + + + + Donut. + + + + + "No" symbol. + + + + + Block arc. + + + + + Folded corner. + + + + + Smiley face. + + + + + Heart. + + + + + Lightning bolt. + + + + + Sun. + + + + + Moon. + + + + + Cloud. + + + + + Arc. + + + + + Double bracket. + + + + + Double brace. + + + + + Left bracket. + + + + + Right bracket. + + + + + Left brace. + + + + + Right brace. + + + + + Block arrow that points right. + + + + + Block arrow that points left. + + + + + Block arrow that points up. + + + + + Block arrow that points down. + + + + + Block arrow with arrowheads that point both left and right. + + + + + Block arrow that points up and down. + + + + + Block arrows that point up, down, left, and right. + + + + + Block arrow with arrowheads that point left, right, and up. + + + + + Block arrow that follows a curved 90-degree angle. + + + + + Block arrow forming a U shape. + + + + + Block arrow with arrowheads that point left and up. + + + + + Block arrow that follows a sharp 90-degree angle. Points up by default. + + + + + Block arrow that curves right. + + + + + Block arrow that curves left. + + + + + Block arrow that curves up. + + + + + Block arrow that curves down. + + + + + Block arrow that points right with stripes at the tail. + + + + + Notched block arrow that points right. + + + + + Pentagon. + + + + + Chevron + + + + + Callout with arrow that points right. + + + + + Callout with arrow that points down. + + + + + Callout with arrow that points left. + + + + + Callout with arrow that points up. + + + + + Callout with arrowheads that point both left and right. + + + + + Callout with arrows that point up and down. + + + + + Callout with arrows that point up, down, left, and right. + + + + + Block arrow that follows a curved 180-degree angle. + + + + + Math plus(+). + + + + + Math minus(-). + + + + + Math multiply(x). + + + + + Math division. + + + + + Math equal(=). + + + + + Math not equal. + + + + + Process flowchart symbol.. + + + + + Alternate process flowchart symbol. + + + + + Decision flowchart symbol. + + + + + Data flowchart symbol. + + + + + Predefined process flowchart symbol. + + + + + Internal storage flowchart symbol. + + + + + Document flowchart symbol. + + + + + Multi-document flowchart symbol. + + + + + Terminator flowchart symbol. + + + + + Preparation flowchart symbol. + + + + + Manual input flowchart symbol. + + + + + Manual operation flowchart symbol. + + + + + Connector flowchart symbol. + + + + + Off-page connector flowchart symbol. + + + + + Card flowchart symbol. + + + + + Punched tape flowchart symbol. + + + + + Summing junction flowchart symbol. + + + + + "Or" flowchart symbol. + + + + + Collate flowchart symbol. + + + + + Sort flowchart symbol. + + + + + Extract flowchart symbol. + + + + + Merge flowchart symbol. + + + + + Stored data flowchart symbol. + + + + + Delay flowchart symbol. + + + + + Sequential access storage flowchart symbol. + + + + + Magnetic disk flowchart symbol. + + + + + Direct access storage flowchart symbol. + + + + + Display flowchart symbol. + + + + + Explosion. + + + + + Explosion. + + + + + 4-point star. + + + + + 5-point star. + + + + + 6-point star. + + + + + 7-point star. + + + + + 8-point star. + + + + + 10-point star. + + + + + 12-point star. + + + + + 16-point star. + + + + + 24-point star. + + + + + 32-point star. + + + + + Ribbon banner with center area above ribbon ends. + + + + + Ribbon banner with center area below ribbon ends. + + + + + Ribbon banner that curves up. + + + + + Ribbon banner that curves down. + + + + + Vertical scroll. + + + + + Horizontal scroll. + + + + + Wave. + + + + + Double wave. + + + + + Rectangular callout. + + + + + Rounded rectangle-shaped callout. + + + + + Oval-shaped callout. + + + + + Cloud callout. + + + + + Callout with border and horizontal callout line. + + + + + Callout with diagonal straight line. + + + + + Callout with angled line. + + + + + Callout with horizontal accent bar. + + + + + Callout with diagonal callout line and accent bar. + + + + + Callout with angled callout line and accent bar. + + + + + Callout with horizontal line. + + + + + Callout with no border and diagonal callout line. + + + + + Callout with no border and angled callout line. + + + + + Callout with border and horizontal accent bar. + + + + + Callout with border, diagonal straight line, and accent bar. + + + + + Callout with border, angled callout line, and accent bar. + + + + + Line. + + + + + Elbow connector. + + + + + Curved connector. + + + + + Straight line connector. + + + + + Bent connector. + + + + + Bent connector. + + + + + Curved connector. + + + + + Curved connector. + + + + + Curved connector. + + + + + Curved connector. + + + + + Specifies the fill type. + + + + + Fill is the same as the background. + + + + + Gradient fill. + + + + + Mixed fill. + + + + + Patterned fill. + + + + + Picture fill. + + + + + Solid fill. + + + + + Textured fill. + + + + + No Fill. + + + + + Specifies the blip transparency + + + + + Specifies the type of line formats. + + + + + Gradient format. + + + + + None format. + + + + + patterned format. + + + + + Solid format. + + + + + Specifies the fill pattern type used. + + + + + 10% of the foreground color. + + + + + 20% of the foreground color. + + + + + 25% of the foreground color. + + + + + 30% of the foreground color. + + + + + 40% of the foreground color. + + + + + 50% of the foreground color. + + + + + 5% of the foreground color. + + + + + 60% of the foreground color. + + + + + 70% of the foreground color. + + + + + 75% of the foreground color. + + + + + 80% of the foreground color. + + + + + 90% of the foreground color. + + + + + Cross. + + + + + Thick lines in the foreground color running from the top to the right-hand side of the shape. + + + + + Thick horizontal lines in the foreground color. + + + + + Thick lines in the foreground color running from the top to the left-hand side of the shape. + + + + + Thick vertical lines in the foreground color. + + + + + Dashed lines in the foreground color running from the top to the right-hand side of the shape. + + + + + Dashed horizontal lines in the foreground color. + + + + + Dashed lines in the foreground color running from the top to the left-hand side of the shape. + + + + + Dashed vertical lines in the foreground color. + + + + + Rectangular brick pattern running diagonally across the shape. + + + + + Diagonal Cross + + + + + Small angled shapes in the foreground color running in alternating rows down the shape. + + + + + Dotted perpendicular lines in the foreground color running diagonally to form diamonds across the shape. + + + + + Dotted perpendicular lines in the foreground color running horizontally and vertically to form grid lines across the shape. + + + + + Downward Diagonal + + + + + Horizontal + + + + + Rectangular brick pattern running horizontally across the shape. + + + + + Squares in alternating foreground/background colors. + + + + + Large dots in the foreground color scattered across the shape. + + + + + Solid, widely spaced perpendicular lines in the foreground color running horizontally and vertically to form grid lines across the shape. + + + + + Thin lines in the foreground color running from the top to the right-hand side of the shape. + + + + + Thin horizontal lines in the foreground color. + + + + + Thin lines in the foreground color running from the top to the left-hand side of the shape. + + + + + Thin vertical lines in the foreground color. + + + + + Not supported. + + + + + Narrowly spaced horizontal lines in the foreground color. + + + + + Narrowly spaced vertical lines in the foreground color. + + + + + Solid perpendicular lines in the foreground color running diagonally to form diamonds across the shape. + + + + + Very thick solid lines in the foreground color running vertically, coupled with very thick lines and 40% of the foreground color running horizontally. + + + + + Overlapping curved rectangles running diagonally across the shape. + + + + + Small squares in alternating foreground/background colors. + + + + + Small dots in the foreground color scattered across the shape. + + + + + Solid, closely spaced perpendicular lines in the foreground color running horizontally and vertically to form grid lines across the shape. + + + + + Diamond shapes in alternating foreground/background colors. + + + + + Circles that use foreground and background colors to make them appear three-dimensional, oriented in rows across the shape. + + + + + Trellis pattern in the foreground color. + + + + + Upward Diagonal + + + + + Vertical + + + + + Wavy lines in the foreground color. + + + + + Weave pattern in the foreground color running diagonally across the shape. + + + + + Widely spaced lines in the foreground color running from the top to the right-hand side of the shape. + + + + + Widely spaced lines in the foreground color running from the top to the left-hand side of the shape. + + + + + Zigzag lines running horizontally across the shape. + + + + + Specifies the texture alignment. + + + + + Not Supported. + + + + + Aligned at bottom. + + + + + Aligned at bottom left. + + + + + Aligned at bottom right. + + + + + Aligned at center. + + + + + Aligned at left. + + + + + Aligned at right. + + + + + Aligned at top. + + + + + Aligned at top left. + + + + + Aligned at top right. + + + + + Specifies the style for a line. + + + + + Single line. + + + + + Not supported. + + + + + Thick line with a thin line on each side. + + + + + Thick line next to thin line. For horizontal lines, thick line is above thin line. For vertical lines, thick line is to the left of the thin line. + + + + + Thick line next to thin line. For horizontal lines, thick line is below thin line. For vertical lines, thick line is to the right of the thin line. + + + + + Two thin lines. + + + + + Represents the fill format options for the in the Word document. + + + The following code example demonstrates how to set the fill format to the shape in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add the section into Word document + WSection section = document.AddSection() as WSection; + //Add a paragraph to created section + WParagraph paragraph = section.AddParagraph() as WParagraph; + string paraText = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"; + //Append the text to the created paragraph + paragraph.AppendText(paraText); + //Add a paragraph to created section + paragraph = section.AddParagraph() as WParagraph; + //Add the rectangle shape to the document + Syncfusion.DocIO.DLS.Shape shape = paragraph.AppendShape(AutoShapeType.Rectangle, 200, 75); + //Set wrapping type as inline + shape.WrapFormat.TextWrappingStyle = TextWrappingStyle.Inline; + //Set the fillformat for the shape + shape.FillFormat.Color = Color.AliceBlue; + shape.FillFormat.Fill = true; + shape.FillFormat.Transparency = 60; + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add the section into Word document + Dim section As WSection = TryCast(document.AddSection(), WSection) + 'Add a paragraph to created section + Dim paragraph As WParagraph = TryCast(section.AddParagraph(), WParagraph) + Dim paraText As String = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula" + 'Append the text to the created paragraph + paragraph.AppendText(paraText) + 'Add a paragraph to created section + paragraph = TryCast(section.AddParagraph(), WParagraph) + 'Add the rectangle shape to the document + Dim shape As Syncfusion.DocIO.DLS.Shape = paragraph.AppendShape(AutoShapeType.Rectangle, 200, 75) + 'Set wrapping type as inline + shape.WrapFormat.TextWrappingStyle = TextWrappingStyle.Inline + 'Set the fillformat for the shape + shape.FillFormat.Color = Color.AliceBlue + shape.FillFormat.Fill = True + shape.FillFormat.Transparency = 60 + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + Initializes a new instance of class. + + The to which the fill effects should be added. + + + + Initializes a new instance of class. + + The to which the fill effects should be added. + + + + Initializes a new instance of class. + + The to which the fill effects should be added. + + + + Initializes a new instance of class. + + The to which the fill effects should be added. + + + + Initializes a new instance of class. + + The to which the fill effects should be added. + To maintain a FillFormat for picture + + + + Closes this instance. + + + + + Closes this instance. + + + + + Compare the properties of Fill Format + + + True, if all the properties matches, else false + + + + Gets the fill format text for Word comparison + + + + + + Check the textfill present or not + + + + + Gets or sets the value indicates whether the filled attribute is default + + + + + Gets or Sets the value indicates whether the fill color is default + + + + + Gets or sets a value indicating whether to fill with color. + + True if need to fill with color; otherwise, false. + + + + Gets or sets the color to fill + + The specifies the fill color. + + + + Gets or sets the transparency value measured in percentage(%). + + The float that represents the transparency value. + + + + Gets or sets the contrast + + + + + Gets or sets a value indicating whether fill use from group shape or not + + + + + Initializes a new instance of the class. + + The shape base. + + + + Close the instances. + + + + + Clones the blip format. + + + + + + + + + + + + Compares the proerties of blip formats + + + True, if all the properties matches, else false + + + + Gets the blip format text for Word comparison + + + + + + Blip Threshold + + + + + Blip inverse color + + + + + Blip inverse opacity + + + + + Alpha replacement amount + + + + + Bevel Threshold value + + + + + Flag to make the glow effect grow + + + + + value for blur radius + + + + + Flag to denote the alpha + + + + + Denotes whether the preset color need to serialize first or not + As per MS word behavior, if input document has DuotonePresetColor as first + Then, the DuotonePresetColor should serialize first. + Default value is false + + + + + Color from value + + + + + color to value + + + + + color from opacity + + + + + Color to opacity + + + + + Hue value of blip + + + + + Luminance value of blip + + + + + Saturation value of blip + + + + + Brightness value + + + + + Contrast value of blip + + + + + Tint Amount + + + + + Tint Hue + + + + + Duotone color + + + + + Duotone Preset color + + + + + Duotone opacity + + + + + Collection of extension URI + + + + + Image Effect of the blip picture + + + + + Has to apply compression + + + + + Blip has image properties + + + + + Gets/Sets the blip rotation with shape object + + + + + Image Record + + + + + Stream for blip extensions + + + + + Gets or sets the transparency value measured in percentage(%). + + The float that represents the transparency value. + + + + Gets or sets a value indicating whether the image color is Grayscale. + + + true if image color is Grayscale; otherwise, false. + + + This property is supported for VML picture alone. + + + + + Gets or sets a value indicating whether the image color is Bilevel. + + + true if image color is Bilevel; otherwise, false. + + + This property is supported for VML picture alone. + + + + + Sets the property key + + + + + Get the PropertiesHash value. + + + + + Disposes the instances used. + + + + + Clones the instance. + + + + + Compare properties of Image effect + + + True, if all the properties matches, else false + + + + Gets the image effect text for Word comparison + + + + + + Sharpen Amount + + + + + Color Temprature + + + + + Saturation + + + + + Brightness Value + + + + + Contrast value + + + + + Blur radius + + + + + Cement Trasparency amount + + + + + Cement cracking amount + + + + + Chalk transparency amount + + + + + Chalk Pressure + + + + + criss cross transparency + + + + + criss cross pressure + + + + + cutout opacity amount + + + + + Cutout shades + + + + + Grain transparency + + + + + Grain Size + + + + + Glass opacity amount + + + + + Glass Scaling amount + + + + + Glow diffusity opacity + + + + + Glow diffusity intensity + + + + + Glow Edges opacity + + + + + Glow edges smoothness + + + + + Light screen opacity + + + + + Light screen Grid + + + + + Line drwaing opacity + + + + + Drawing Pensil size + + + + + Marker Transparency + + + + + Marker Size + + + + + Mosiaic Bubble Transparency + + + + + Mosiaic Bubble Pressure + + + + + Stroke Transparency + + + + + stroke intensity + + + + + Brush Transparency + + + + + Brush Size + + + + + Pastel Transparency + + + + + Pastel Size + + + + + Gray Scale Transparency + + + + + Gray scale size + + + + + Pencil Sketch Transparency + + + + + Pencil Sketch Size + + + + + Photocopy Transparency + + + + + Photocopy size + + + + + Plastic Wrap Transparency + + + + + Plastic Wrap Smoothness + + + + + Texturizer Transparency + + + + + Texturizer Size + + + + + Sponge Transparency + + + + + Sponge brush size + + + + + Collection of Foreground vertices + + + + + Collection of background vertices + + + + + Background removal rectangle + + + + + Has the background removal effect + + + + + Properties Collection + + + + + Represents the line format options for the in the Word document. + + + The following code example demonstrates how to set the line format to the shape in the document + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add the section into Word document + WSection section = document.AddSection() as WSection; + //Add a paragraph to created section + WParagraph paragraph = section.AddParagraph() as WParagraph; + string paraText = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"; + //Append the text to the created paragraph + paragraph.AppendText(paraText); + //Add a paragraph to created section + paragraph = section.AddParagraph() as WParagraph; + //Add the rectangle shape to the document + Syncfusion.DocIO.DLS.Shape shape = paragraph.AppendShape(AutoShapeType.Rectangle, 200, 75); + //Set wrapping type as inline + shape.WrapFormat.TextWrappingStyle = TextWrappingStyle.Inline; + //Set the line format for the shape + shape.LineFormat.Line = true; + shape.LineFormat.Color = Color.Red; + shape.LineFormat.DashStyle = LineDashing.DashDot; + shape.LineFormat.Style = Syncfusion.DocIO.DLS.LineStyle.ThickThin; + shape.LineFormat.Weight = 3; + shape.LineFormat.Transparency = 30; + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add the section into Word document + Dim section As WSection = TryCast(document.AddSection(), WSection) + 'Add a paragraph to created section + Dim paragraph As WParagraph = TryCast(section.AddParagraph(), WParagraph) + Dim paraText As String = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula" + 'Append the text to the created paragraph + paragraph.AppendText(paraText) + 'Add a paragraph to created section + paragraph = TryCast(section.AddParagraph(), WParagraph) + 'Add the rectangle shape to the document + Dim shape As Syncfusion.DocIO.DLS.Shape = paragraph.AppendShape(AutoShapeType.Rectangle, 200, 75) + 'Set wrapping type as inline + shape.WrapFormat.TextWrappingStyle = TextWrappingStyle.Inline + 'Set the line format for the shape + shape.LineFormat.Line = True + shape.LineFormat.Color = Color.Red + shape.LineFormat.DashStyle = LineDashing.DashDot + shape.LineFormat.Style = Syncfusion.DocIO.DLS.LineStyle.ThickThin + shape.LineFormat.Weight = 3 + shape.LineFormat.Transparency = 30 + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + Initializes a new instance of class for the specified . + + The object. + + + + Initializes a new instance of class for the specified . + + The object. + + + + Initializes a new instance of class for the specified . + + The object. + + + + Returns the value indicating whether the key exists in the properties collection. + + The integer that specifies the key. + True if the specified key is present, otherwise false. + + + + Sets the property value. + + The prop key. + The value. + + + + Closes this instance. + + + + + Check for the property key from the property collection + + + + + Clones this instance. + + + + + Compares the properies of line format. + + + + + + + Gets the properties text for Word comparison + + + + + Check the textoutline present or not + + + + + Gets or sets the value indicating whether the outline of the shape should be drawn. The default is false. + + True if the outline should be drawn; otherwise, false. + + + + Properties Collection + + + + + Gets or sets the value for the property with specified key. + + The key for the property. + An object with the specific key. + + + + Gets or sets a for the outer line of the shape. + + The object that specifies line color. + + + + Gets or sets the style of the arrowhead at the beginning of the specified line. + + + + + Gets or sets the for the outline of the shape. + + The member that specifies the line dashing style. + + + + Gets or sets the style of the arrowhead at the end of the specified line. + + + + + Gets or sets the outline style for the shapes. + + The member that specifies the line style. + + + + Gets or sets the transparency value measured in percentage(%). + + The float that specifies the transparency value. + + + + Gets or sets a value for the line weight measured in points. + + The float that represents the line weight. + + + + Gets or Sets the value indicates whether the 2007 stroked property is defined or not + + + + + Gets or sets the value indicates whether the "w" attribute in the "ln" tag is null in DOCX parsing. + + + + + Gets or sets the miter join limit. + + + The miter join limit. + + + + + Represents the shapes and it manipulations in the Word document. + + + The following code example demonstrates how to add new shape to document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument("Template.docx"); + //Add the section into Word document + WSection section = document.AddSection() as WSection; + //Add a paragraph to created section + WParagraph paragraph = document.Sections[0].Paragraphs[0]; + //Create a new shape + Syncfusion.DocIO.DLS.Shape shape = new Syncfusion.DocIO.DLS.Shape(document, AutoShapeType.Rectangle); + //Specify the shape formatting options + shape.AlternativeText = "demo shape"; + shape.FillFormat.Color = Color.LightBlue; + shape.Height = 75; + shape.Width = 100; + shape.HorizontalAlignment = ShapeHorizontalAlignment.Left; + shape.HorizontalOrigin = HorizontalOrigin.Margin; + shape.LineFormat.Line = true; + shape.LineFormat.Style = Syncfusion.DocIO.DLS.LineStyle.Single; + shape.Name = "Rectangle"; + shape.Title = "Rectangle shape demo"; + shape.VerticalAlignment = ShapeVerticalAlignment.Center; + shape.VerticalOrigin = VerticalOrigin.Page; + shape.WrapFormat.TextWrappingStyle = TextWrappingStyle.Square; + string paraText = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"; + //Add the new paragraph to shape with some text + shape.TextBody.AddParagraph().AppendText(paraText); + //Add the shape to paragraph + paragraph.ChildEntities.Add(shape); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument("Template.docx") + 'Add the section into Word document + Dim section As WSection = TryCast(document.AddSection(), WSection) + 'Add a paragraph to created section + Dim paragraph As WParagraph = document.Sections(0).Paragraphs(0) + 'Create a new shape + Dim shape As New Syncfusion.DocIO.DLS.Shape(document, AutoShapeType.Rectangle) + 'Specify the shape formatting options + shape.AlternativeText = "demo shape" + shape.FillFormat.Color = Color.LightBlue + shape.Height = 75 + shape.Width = 100 + shape.HorizontalAlignment = ShapeHorizontalAlignment.Left + shape.HorizontalOrigin = HorizontalOrigin.Margin + shape.LineFormat.Line = True + shape.LineFormat.Style = Syncfusion.DocIO.DLS.LineStyle.[Single] + shape.Name = "Rectangle" + shape.Title = "Rectangle shape demo" + shape.VerticalAlignment = ShapeVerticalAlignment.Center + shape.VerticalOrigin = VerticalOrigin.Page + shape.WrapFormat.TextWrappingStyle = TextWrappingStyle.Square + Dim paraText As String = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula" + 'Add the new paragraph to shape with some text + shape.TextBody.AddParagraph().AppendText(paraText) + 'Add the shape to paragraph + paragraph.ChildEntities.Add(shape) + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Variable that specifies the shape type ID. + + + + + Compares the current textbox with another textbox of another document. + + + + + + + Gets the text box text for Word comparison + + + + + Gets the properties text for Word comparison + + + + + + + Initializes a new instance of class with the specified + instance and the shape type. + + The instance. + The type of the shape. + + + + Initializes the default values for Shape in VML structure. + + + + + Detaches from owner. + + + + + Executes when the entity is attached to the owner document. + + + + + Creates a duplicate copy of this object. + + + The reference of the newly created . + + + + Creates a duplicate copy of this object. + + The reference of the newly created . + + + + To get the color from theme item + + + + + + + + + To get the percentage value from the given string + + + + + + + Clones the relations. + + + + + + Applies the specified character format to the shape. + + The character format to be applied. + + + + Initializing LayoutInfo value to null + + + + + Sets the width depends on relative width of shape. + + + + + + Sets the height depends on relative height of shape. + + + + + + + + + + + + + Creates the layout information. + + + + + + Gets clipping bounds for shape's text body + + + /// + + + + + Checks whether shape's line width need to consider for shape client area calcualtion + + + + + Gets the Guide List value of custom shape + + + + + + Gets the Av List value of custom shape + + + + + + Sets the Guide List value of custom shape + + + + + Sets the Av List value of custom shape + + + + + Implemented alternative method to improve the performance + + + + + + + + Gets the Shape object as Image + + + + + + Gets a VML Path points to draw. + + + + + Gets or sets a value indicating whether [is2007 shape]. + + + true if [is2007 shape]; otherwise, false. + + + + + Get/Set Text content layouting bounds for shape + + + + + Gets or sets the shape rotation in degree. + + The float that specifies the rotation value of the shape. + A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. + + The following code example demonstrates how to gets or sets the rotation value of rectangle shape in degree. + + //Creates a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new paragraph to the section + WParagraph paragraph = section.AddParagraph() as WParagraph; + //Adds new shape to the document + Shape rectangle = paragraph.AppendShape(AutoShapeType.RoundedRectangle, 150, 100); + //Adds textbody contents to the shape + paragraph = rectangle.TextBody.AddParagraph() as WParagraph; + IWTextRange text = paragraph.AppendText("This text is in rounded rectangle shape"); + //Sets rectangle shape rotation in degree + rectangle.Rotation = 90; + //Saves the Word document + document.Save("Sample.docx", FormatType.Docx); + //Closes the document + document.Close(); + + + 'Creates a new Word document + Dim document As WordDocument = New WordDocument + 'Adds new section to the document + Dim section As IWSection = document.AddSection + 'Adds new paragraph to the section + Dim paragraph As WParagraph = CType(section.AddParagraph, WParagraph) + 'Adds new shape to the document + Dim rectangle As Shape = paragraph.AppendShape(AutoShapeType.RoundedRectangle, 150, 100) + 'Adds textbody contents to the shape + paragraph = CType(rectangle.TextBody.AddParagraph, WParagraph) + Dim text As IWTextRange = paragraph.AppendText("This text is in rounded rectangle shape") + 'Sets rectangle shape rotation in degree + rectangle.Rotation = 90 + 'Saves the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Closes the document + document.Close() + + + + + + Gets or sets the for the shape. + + The instance that specifies the formatting options for text. + + + + Gets the docx style properties. + + The docx style props. + + + + Gets the image relations. + + The image relations. + + + + Gets the shape guide + + The shape guide. + + + + Gets the shape type of the current shape object. Read-only. + + The member that specifies the type of the shape. + The shape type must represent an AutoShape other than a line or free form drawing. + + + + Gets or sets the text body for the shape. + + The that specifies the shape body contents. + + + + Gets or sets the line formatting options for outline of the shape. + + The instance. + + + + Gets or sets the fill effects for the shape. + + The instance. + + + + Gets/ sets Effect format of the shape + + + + + Gets the type of the entity. + + The of the current item. + + + + Gets or sets a Horizontal flipping of Shape. + + + true indicates that a shape has been flipped horizontally; otherwise, false. + + This property returns True if the specified shape is flipped around the horizontal axis, and False if not. + + The following code example demonstrates how to gets or sets the horizontal flip to rectangle shape. + + //Creates a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new paragraph to the section + WParagraph paragraph = section.AddParagraph() as WParagraph; + //Adds new shape to the document + Shape rectangle = paragraph.AppendShape(AutoShapeType.RoundedRectangle, 150, 100); + //Adds textbody contents to the shape + paragraph = rectangle.TextBody.AddParagraph() as WParagraph; + IWTextRange text = paragraph.AppendText("This text is in rounded rectangle shape"); + //Sets horizontal flip to the rectangle shape + rectangle.FlipHorizontal = true; + //Saves the Word document + document.Save("Sample.docx", FormatType.Docx); + //Closes the document + document.Close(); + + + 'Creates a new Word document + Dim document As WordDocument = New WordDocument + 'Adds new section to the document + Dim section As IWSection = document.AddSection + 'Adds new paragraph to the section + Dim paragraph As WParagraph = CType(section.AddParagraph, WParagraph) + 'Adds new shape to the document + Dim rectangle As Shape = paragraph.AppendShape(AutoShapeType.RoundedRectangle, 150, 100) + 'Adds textbody contents to the shape + paragraph = CType(rectangle.TextBody.AddParagraph, WParagraph) + Dim text As IWTextRange = paragraph.AppendText("This text is in rounded rectangle shape") + 'Sets horizontal flip to the rectangle shape + rectangle.FlipHorizontal = True + 'Saves the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Closes the document + document.Close() + + + + + + Gets or sets a Vertical flipping of Shape. + + + true indicates that a shape has been flipped vertically; otherwise, false. + + This property returns True if the specified shape is flipped around the vertical axis, and False if not. + + The following code example demonstrates how to gets or sets the vertical flip to rectangle shape. + + //Creates a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new paragraph to the section + WParagraph paragraph = section.AddParagraph() as WParagraph; + //Adds new shape to the document + Shape rectangle = paragraph.AppendShape(AutoShapeType.RoundedRectangle, 150, 100); + //Adds textbody contents to the shape + paragraph = rectangle.TextBody.AddParagraph() as WParagraph; + IWTextRange text = paragraph.AppendText("This text is in rounded rectangle shape"); + //Sets vertical flip to the rectangle shape + rectangle.FlipVertical = true; + //Saves the Word document + document.Save("Sample.docx", FormatType.Docx); + //Closes the document + document.Close(); + + + 'Creates a new Word document + Dim document As WordDocument = New WordDocument + 'Adds new section to the document + Dim section As IWSection = document.AddSection + 'Adds new paragraph to the section + Dim paragraph As WParagraph = CType(section.AddParagraph, WParagraph) + 'Adds new shape to the document + Dim rectangle As Shape = paragraph.AppendShape(AutoShapeType.RoundedRectangle, 150, 100) + 'Adds textbody contents to the shape + paragraph = CType(rectangle.TextBody.AddParagraph, WParagraph) + Dim text As IWTextRange = paragraph.AppendText("This text is in rounded rectangle shape") + 'Sets vertical flip to the rectangle shape + rectangle.FlipVertical = True + 'Saves the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Closes the document + document.Close() + + + + + + Flag to ensure Effect Style applied for shape inline + + + + + Flag to ensure Line Style applied for shape inline + + + + + Flag to ensure Fill Style applied for shape inline + + + + + Flag to ensure Fill Style applied for shape inline + + + + + Flag to ensure Fill Style applied for shape inline + + + + + Gets the relations. + + The relations. + + + + Property to store the fallback picture of shape + + + + + Gets or Sets the Custom Shape path list value + + + + + + + + + + Compares the properties of ShapeStyleReference. + + + + + + + Gets the properties text for Word comparison + + + + + Represents the text frame in the Shape. + + + + + + Member to hold the collection of properties values and its keys. + + + + + Returns the value indicating whether the key exists in the properties collection. + + The integer that specifies the key. + True if the specified key is present, otherwise false. + + + + Sets the property value. + + The prop key. + The value. + + + + Initializes a new instance of class for the specified . + + The object. + + + + Compares the properties of text frame. + + + + + + + Gets the properties text for Word comparison + + + + + Gets or sets the flag for text frame. + + The member that specifies internal margin of text frame. + + + + Holds the ThreeD properties of the shape + + + + + Gets or sets the direction of the text in the Shape. + + The member that specifies the direction of text. + + + + Gets or sets the vertical alignment of the text. + + The member that specifies the text vertical alignment. + + + + Gets or sets the shape relative width percentage. + + + + + Gets or sets the shape relative height percentage. + + + + + Gets or sets the horizontal width origin value. + + The member that specifies the width origin value. + + + + Gets or sets the vertical height origin value. + + The member that specifies the height origin value. + + + + Gets the internal margin. + + The internal margin. + + + + Properties Collection + + + + + Gets or sets the textshapevalues of the text in shape. + + + + + Gets or sets the TextWrapAdjustList of the shape + + + + + Gets or sets the value for the property with specified key. + + The key for the property. + An object with the specific key. + + + + Represents the functions that specify how text wraps around the object in the Word document. + + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + WParagraph paragraph = section.AddParagraph() as WParagraph; + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet"); + //Add new shape to the document + Shape rectangle = paragraph.AppendShape(AutoShapeType.RoundedRectangle, 150, 100); + //Set position for shape + rectangle.VerticalPosition = 72; + rectangle.HorizontalPosition = 72; + //Set text wrapping style + rectangle.WrapFormat.TextWrappingStyle = TextWrappingStyle.TopAndBottom; + rectangle.WrapFormat.DistanceBottom = 10; + rectangle.WrapFormat.DistanceLeft = 10; + rectangle.WrapFormat.DistanceRight = 10; + rectangle.WrapFormat.DistanceTop = 20; + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet"); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(section.AddParagraph(), WParagraph) + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet") + 'Add new shape to the document + Dim rectangle As Shape = paragraph.AppendShape(AutoShapeType.RoundedRectangle, 150, 100) + 'Set position for shape + rectangle.VerticalPosition = 72 + rectangle.HorizontalPosition = 72 + 'Set text wrapping style + rectangle.WrapFormat.TextWrappingStyle = TextWrappingStyle.TopAndBottom + rectangle.WrapFormat.DistanceBottom = 10 + rectangle.WrapFormat.DistanceLeft = 10 + rectangle.WrapFormat.DistanceRight = 10 + rectangle.WrapFormat.DistanceTop = 20 + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet") + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Sets the TextWrappingStyle,specific for parsers. + + TextWrapStyle + + + + Closes this instance. + + + + + Compares the properties of wrap format. + + + + + Gets the fill format text for Word comparison + + + + + Gets or sets a value indicating whether a given shape can overlap other shapes. + + + + + Gets or sets the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. + + The float that specifies the distance between text and bottom edge of the shape. + + + + Gets or sets the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + + The float that specifies the distance between text and left edge of the shape. + + + + Gets or sets the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + + The float that specifies the distance between text and right edge of the shape. + + + + Gets or sets the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + + The float that specifies the distance between text and top edge of the shape. + + + + Gets or sets a value indicating whether the shape or chart should be preserved + behind the text that surrounds the shape or chart. + + True if the shape or chart will be preserved behind the text; + false if the shape or chart will be preserved in front of the text. + + + + Gets or sets the text wrapping type for the specified shape. + + The member that specifies the wrapping type. + + + + Gets or sets the text wrapping style for the specified shape. + + The member that specifies the text wrapping style. + + + + Gets or sets the wrap polygon. + + + The wrap polygon. + + + + + Helps to navigate between bookmarks in the Word document and manipulate its contents. + + + + + + + + + + + + + + Initializes a new instance of the class with the specified + . + + The object. + + + //Loads an existing Word document into DocIO instance + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Creates the bookmark navigator instance to access the bookmark + BookmarksNavigator bookmarkNavigator = new BookmarksNavigator(document); + //Moves the virtual cursor to the location before the end of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind"); + //Gets the bookmark content as WordDocumentPart + WordDocumentPart wordDocumentPart = bookmarkNavigator.GetContent(); + //Saves the WordDocumentPart as separate Word document + WordDocument newDocument = wordDocumentPart.GetAsWordDocument(); + newDocument.Save("Result.docx", FormatType.Docx); + //Releases the resources hold by WordDocument instance + newDocument.Close(); + document.Close(); + + + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Creates the bookmark navigator instance to access the bookmark + Dim bookmarkNavigator As New BookmarksNavigator(document) + 'Moves the virtual cursor to the location before the end of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind") + 'Gets the bookmark content as WordDocumentPart + Dim wordDocumentPart As WordDocumentPart = bookmarkNavigator.GetContent() + 'Saves the WordDocumentPart as separate Word document + Dim newDocument As WordDocument = wordDocumentPart.GetAsWordDocument() + newDocument.Save("Result.docx", FormatType.Docx) + 'Releases the resources hold by WordDocument instance + newDocument.Close() + document.Close() + + + + + + Moves to the specified bookmark in the document. + + The specified bookmark name is not present in the Word document. + The string that specifies the bookmark name. + + The following code example demonstrates how to move to specific bookmark in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Create the bookmark navigator instance to access the bookmark + BookmarksNavigator bookmarkNavigator = new BookmarksNavigator(document); + //Move the virtual cursor to the before the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind"); + //Get the bookmark content + TextBodyPart part = bookmarkNavigator.GetBookmarkContent(); + //Add the retrieved content into another new section + document.AddSection(); + foreach(TextBodyItem item in part.BodyItems) + document.LastSection.Body.ChildEntities.Add(item); + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Create the bookmark navigator instance to access the bookmark + Dim bookmarkNavigator As New BookmarksNavigator(document) + 'Move the virtual cursor to the before the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind") + 'Get the bookmark content + Dim part As TextBodyPart = bookmarkNavigator.GetBookmarkContent() + 'Add the retrieved content into another new section + document.AddSection() + For Each item As TextBodyItem In part.BodyItems + document.LastSection.Body.ChildEntities.Add(item) + Next + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Moves to the start or end position of the specified bookmark in the document. + + The string that specifies the bookmark name. + Set to true to move the navigator at the beginning of the bookmark; Set to false to move the navigator at the end of the bookmark. + Set to true to move the navigator after the specified bookmark start or end position; Set to false to move the navigator before the specified bookmark start or end position. + The specified bookmark name is not present in the Word document. + + The following code example demonstrates how to move to specific bookmark in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Create the bookmark navigator instance to access the bookmark + BookmarksNavigator bookmarkNavigator = new BookmarksNavigator(document); + //Move the virtual cursor to the before the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind", true, false); + //Get the bookmark content + TextBodyPart part = bookmarkNavigator.GetBookmarkContent(); + //Add the retrieved content into another new section + document.AddSection(); + foreach(TextBodyItem item in part.BodyItems) + document.LastSection.Body.ChildEntities.Add(item); + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Create the bookmark navigator instance to access the bookmark + Dim bookmarkNavigator As New BookmarksNavigator(document) + 'Move the virtual cursor to the before the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind", True, False) + 'Get the bookmark content + Dim part As TextBodyPart = bookmarkNavigator.GetBookmarkContent() + 'Add the retrieved content into another new section + document.AddSection() + For Each item As TextBodyItem In part.BodyItems + document.LastSection.Body.ChildEntities.Add(item) + Next + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Inserts the specified text to current bookmark. + + The string that represents the text to be inserted. + The object that represents the inserted text. + This example shows how to insert a simple text using BookmarkNavigator. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Create the bookmark navigator instance to access the bookmark + BookmarksNavigator bookmarkNavigator = new BookmarksNavigator(document); + //Move the virtual cursor to the before the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind"); + //Insert a new text before the bookmark end of the bookmark + bookmarkNavigator.InsertText(" Northwind Database is a set of tables containing data fitted into predefined categories."); + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Create the bookmark navigator instance to access the bookmark + Dim bookmarkNavigator As New BookmarksNavigator(document) + 'Move the virtual cursor to the before the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind") + 'Insert a new text before the bookmark end of the bookmark + bookmarkNavigator.InsertText(" Northwind Database is a set of tables containing data fitted into predefined categories.") + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Inserts the specified text to current bookmark along with its formatting. + + The string that represents the text to be inserted. + True if it is save formatting, otherwise false. + The object that represents the inserted text. + This example shows how to insert a simple text along with its formatting using BookmarkNavigator. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Create the bookmark navigator instance to access the bookmark + BookmarksNavigator bookmarkNavigator = new BookmarksNavigator(document); + //Move the virtual cursor to the before the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind"); + //Insert a new text before the bookmark end of the bookmark + bookmarkNavigator.InsertText(" Northwind Database is a set of tables containing data fitted into predefined categories.", true); + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Create the bookmark navigator instance to access the bookmark + Dim bookmarkNavigator As New BookmarksNavigator(document) + 'Move the virtual cursor to the before the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind") + 'Insert a new text before the bookmark end of the bookmark + bookmarkNavigator.InsertText(" Northwind Database is a set of tables containing data fitted into predefined categories.", True) + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Inserts the specified to current bookmark. + + The to be inserted. + + The following code example demonstrates how to insert a table using BookmarkNavigator. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Create the bookmark navigator instance to access the bookmark + BookmarksNavigator bookmarkNavigator = new BookmarksNavigator(document); + //Move to the virtual cursor before the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind", false, false); + //Insert a new paragraph before the bookmark end + IWParagraph paragraph = new WParagraph(document); + paragraph.AppendText("Northwind Database Contains the following tables:"); + bookmarkNavigator.InsertParagraph(paragraph); + //Insert a new table before the bookmark end + WTable table = new WTable(document); + table.ResetCells(3, 2); + table[0, 0].AddParagraph().AppendText("Suppliers"); + table[0, 1].AddParagraph().AppendText("2"); + table[1, 0].AddParagraph().AppendText("Customers"); + table[1, 1].AddParagraph().AppendText("1"); + table[2, 0].AddParagraph().AppendText("Employees"); + table[2, 1].AddParagraph().AppendText("3"); + bookmarkNavigator.InsertTable(table); + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Create the bookmark navigator instance to access the bookmark + Dim bookmarkNavigator As New BookmarksNavigator(document) + 'Move to the virtual cursor before the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind", False, False) + 'Insert a new paragraph before the bookmark end + Dim paragraph As IWParagraph = New WParagraph(document) + paragraph.AppendText("Northwind Database Contains the following tables:") + bookmarkNavigator.InsertParagraph(paragraph) + 'Insert a new table before the bookmark end + Dim table As New WTable(document) + table.ResetCells(3, 2) + table(0, 0).AddParagraph().AppendText("Suppliers") + table(0, 1).AddParagraph().AppendText("2") + table(1, 0).AddParagraph().AppendText("Customers") + table(1, 1).AddParagraph().AppendText("1") + table(2, 0).AddParagraph().AppendText("Employees") + table(2, 1).AddParagraph().AppendText("3") + bookmarkNavigator.InsertTable(table) + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Inserts the specified to current bookmark. + + The type of the paragraph item to be inserted. + The object that represents the inserted item. + + The following code example demonstrates how to insert a paragraph item using BookmarkNavigator. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Create the bookmark navigator instance to access the bookmark + BookmarksNavigator bookmarkNavigator = new BookmarksNavigator(document); + //Move to the virtual cursor after the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind", false, true); + //Insert a new picture after the bookmark end + WPicture picture = bookmarkNavigator.InsertParagraphItem(ParagraphItemType.Picture) as WPicture; + picture.LoadImage(Image.FromFile("Northwind.png")); + picture.WidthScale = 50; + picture.HeightScale = 50; + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Create the bookmark navigator instance to access the bookmark + Dim bookmarkNavigator As New BookmarksNavigator(document) + 'Move to the virtual cursor after the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind", False, True) + 'Insert a new picture after the bookmark end + Dim picture As WPicture = TryCast(bookmarkNavigator.InsertParagraphItem(ParagraphItemType.Picture), WPicture) + picture.LoadImage(Image.FromFile("Northwind.png")) + picture.WidthScale = 50 + picture.HeightScale = 50 + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Inserts the specified to current bookmark. + + The to be inserted. + + The following code example demonstrates how to insert a paragraph using BookmarkNavigator. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Create the bookmark navigator instance to access the bookmark + BookmarksNavigator bookmarkNavigator = new BookmarksNavigator(document); + //Move to the virtual cursor after the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind", false, true); + //Insert a new paragraph before the bookmark start + IWParagraph paragraph = new WParagraph(document); + paragraph.AppendText("Northwind Database is a set of tables containing data fitted into predefined categories."); + bookmarkNavigator.InsertParagraph(paragraph); + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Create the bookmark navigator instance to access the bookmark + Dim bookmarkNavigator As New BookmarksNavigator(document) + 'Move to the virtual cursor after the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind", False, True) + 'Insert a new paragraph before the bookmark start + Dim paragraph As IWParagraph = New WParagraph(document) + paragraph.AppendText("Northwind Database is a set of tables containing data fitted into predefined categories.") + bookmarkNavigator.InsertParagraph(paragraph) + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Inserts the specified to current bookmark. + + The to be inserted. + + The following code example demonstrates how to insert a text body part using BookmarkNavigator. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Create the bookmark navigator instance to access the bookmark + BookmarksNavigator bookmarkNavigator = new BookmarksNavigator(document); + //Move to the virtual cursor before the bookmark end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind"); + //Get the bookmark content + TextBodyPart textBodyPart = bookmarkNavigator.GetBookmarkContent(); + document.AddSection(); + IWParagraph paragraph = document.LastSection.AddParagraph(); + paragraph.AppendText("Northwind Database is a set of tables containing data fitted into predefined categories."); + //Add the new bookmark into Word document + paragraph.AppendBookmarkStart("bm_empty"); + paragraph.AppendBookmarkEnd("bm_empty"); + //Move to the virtual cursor after the start location of the bookmark "bm_empty" + bookmarkNavigator.MoveToBookmark("bm_empty", true, true); + //Insert the text body part after the bookmark start + bookmarkNavigator.InsertTextBodyPart(textBodyPart); + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Create the bookmark navigator instance to access the bookmark + Dim bookmarkNavigator As New BookmarksNavigator(document) + 'Move to the virtual cursor before the bookmark end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind") + 'Get the bookmark content + Dim textBodyPart As TextBodyPart = bookmarkNavigator.GetBookmarkContent() + document.AddSection() + Dim paragraph As IWParagraph = document.LastSection.AddParagraph() + paragraph.AppendText("Northwind Database is a set of tables containing data fitted into predefined categories.") + 'Add the new bookmark into Word document + paragraph.AppendBookmarkStart("bm_empty") + paragraph.AppendBookmarkEnd("bm_empty") + 'Move to the virtual cursor after the start location of the bookmark "bm_empty" + bookmarkNavigator.MoveToBookmark("bm_empty", True, True) + 'Insert the text body part after the bookmark start + bookmarkNavigator.InsertTextBodyPart(textBodyPart) + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Returns the bookmark content as a , which represents + the collection of body items if the bookmark start and bookmark end are preserved in a single section. + + The that represents the bookmark content. + This example shows how to retrieve the specified bookmark content using GetBookmarkContent method in a Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Create the bookmark navigator instance to access the bookmark + BookmarksNavigator bookmarkNavigator = new BookmarksNavigator(document); + //Move the virtual cursor to the before the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind"); + //Get the bookmark content + TextBodyPart part = bookmarkNavigator.GetBookmarkContent(); + //Add the retrieved content into another new section + document.AddSection(); + foreach(TextBodyItem item in part.BodyItems) + document.LastSection.Body.ChildEntities.Add(item); + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Create the bookmark navigator instance to access the bookmark + Dim bookmarkNavigator As New BookmarksNavigator(document) + 'Move the virtual cursor to the before the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind") + 'Get the bookmark content + Dim part As TextBodyPart = bookmarkNavigator.GetBookmarkContent() + 'Add the retrieved content into another new section + document.AddSection() + For Each item As TextBodyItem In part.BodyItems + document.LastSection.Body.ChildEntities.Add(item) + Next + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the bookmark content as , which represents the collection of sections + if the bookmark start and bookmark end are preserved in different sections . + + The that represents the bookmark content. + This example shows how to retrieve the specified bookmark content using GetContent method in a Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document with bookmark "Northwind" whose start and end preserved in different section + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Create the bookmark navigator instance to access the bookmark + BookmarksNavigator bookmarkNavigator = new BookmarksNavigator(document); + //Move the virtual cursor to the before the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind"); + //Get the bookmark content as WordDocumentPart + WordDocumentPart wordDocumentPart = bookmarkNavigator.GetContent(); + //Save the WordDocumentPart as separate Word document + WordDocument newDocument = wordDocumentPart.GetAsWordDocument(); + newDocument.Save("Result.docx", FormatType.Docx); + //Release the resources hold by WordDocument instance + newDocument.Close(); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document with bookmark "Northwind" whose start and end preserved in different section + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Create the bookmark navigator instance to access the bookmark + Dim bookmarkNavigator As New BookmarksNavigator(document) + 'Move the virtual cursor to the before the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind") + 'Get the bookmark content as WordDocumentPart + Dim wordDocumentPart As WordDocumentPart = bookmarkNavigator.GetContent() + 'Save the WordDocumentPart as separate Word document + Dim newDocument As WordDocument = wordDocumentPart.GetAsWordDocument() + newDocument.Save("Result.docx", FormatType.Docx) + 'Release the resources hold by WordDocument instance + newDocument.Close() + document.Close() + End Sub + + + + + + Deletes the bookmark content. + + True if its save formatting, otherwise false. + This example shows how to remove the contents of a bookmark from Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Create the bookmark navigator instance to access the bookmark + BookmarksNavigator bookmarkNavigator = new BookmarksNavigator(document); + //Move the virtual cursor to the before the end location of the bookmark " Northwind " + bookmarkNavigator.MoveToBookmark("Northwind"); + //Delete bookmark content without deleting the format in the target document. + bookmarkNavigator.DeleteBookmarkContent(false); + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Create the bookmark navigator instance to access the bookmark + Dim bookmarkNavigator As New BookmarksNavigator(document) + 'Move the virtual cursor to the before the end location of the bookmark " Northwind " + bookmarkNavigator.MoveToBookmark("Northwind") + 'Delete bookmark content without deleting the format in the target document. + bookmarkNavigator.DeleteBookmarkContent(False) + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Deletes the bookmark content and removes the empty paragraph after deletion. + + True if to save formatting; otherwise, false. + True if to remove paragraph with + bookmark start and end when it is empty after deletion; otherwise, false. + This method will be removed in future version. As a work around to remove bookmarked paragraph, utilize current bookmark property of bookmark navigator to access the current bookmarked paragraph and then remove its index from its owner (Text Body) collection. + + + + Replaces the bookmark content with the specified . + + The to replace the bookmark contents. + You cannot replace the multi section contents into a bookmark within table in Word documents. + Use for loop instead of foreach loop for iterating through document elements when replacing the bookmark contents to avoid �collection modified exception�. Since there is chance for modification in document elements while replacing the bookmark contents. + + + The following code example demonstrates how to replace a specified bookmark content in the Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Create the bookmark navigator instance to access the bookmark + BookmarksNavigator bookmarkNavigator = new BookmarksNavigator(document); + //Move to the virtual cursor before the bookmark end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind"); + //Get the bookmark content + TextBodyPart textBodyPart = bookmarkNavigator.GetBookmarkContent(); + document.AddSection(); + IWParagraph paragraph = document.LastSection.AddParagraph(); + paragraph.AppendText("Northwind Database is a set of tables containing data fitted into predefined categories."); + //Add the new bookmark into Word document + paragraph.AppendBookmarkStart("bm_empty"); + paragraph.AppendBookmarkEnd("bm_empty"); + //Move to the virtual cursor before the end location of the bookmark "bm_empty" + bookmarkNavigator.MoveToBookmark("bm_empty"); + //Replace the bookmark content with text body part + bookmarkNavigator.ReplaceBookmarkContent(textBodyPart); + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Create the bookmark navigator instance to access the bookmark + Dim bookmarkNavigator As New BookmarksNavigator(document) + 'Move to the virtual cursor before the bookmark end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind") + 'Get the bookmark content + Dim textBodyPart As TextBodyPart = bookmarkNavigator.GetBookmarkContent() + document.AddSection() + Dim paragraph As IWParagraph = document.LastSection.AddParagraph() + paragraph.AppendText("Northwind Database is a set of tables containing data fitted into predefined categories.") + 'Add the new bookmark into Word document + paragraph.AppendBookmarkStart("bm_empty") + paragraph.AppendBookmarkEnd("bm_empty") + 'Move to the virtual cursor before the end location of the bookmark "bm_empty" + bookmarkNavigator.MoveToBookmark("bm_empty") + 'Replace the bookmark content with text body part + bookmarkNavigator.ReplaceBookmarkContent(textBodyPart) + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces the content of the bookmark with the specified . + + The to replace the bookmark contents. + You cannot replace the multi section contents into a bookmark within table in Word documents. + Use for loop instead of foreach loop for iterating through document elements when replacing the bookmark contents to avoid �collection modified exception�. Since there is chance for modification in document elements while replacing the bookmark contents. + + This example shows how to replace a specified bookmark content using ReplaceContent method in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document with bookmark "Northwind" whose start and end preserved in different section + WordDocument templateDocument = new WordDocument("Template.docx", FormatType.Docx); + //Create the bookmark navigator instance to access the bookmark + BookmarksNavigator bookmarkNavigator = new BookmarksNavigator(templateDocument); + //Move the virtual cursor to the before the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind"); + //Get the bookmark content as WordDocumentPart + WordDocumentPart wordDocumentPart = bookmarkNavigator.GetContent(); + //Close the template document + templateDocument.Close(); + //Load the Word document with bookmark NorthwindDB + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Create the bookmark navigator instance to access the bookmark + bookmarkNavigator = new BookmarksNavigator(document); + //Move the virtual cursor to the before the end location of the bookmark "NorthwindDB" + bookmarkNavigator.MoveToBookmark("NorthwindDB"); + //Replace the bookmark content with word body part + bookmarkNavigator.ReplaceContent(wordDocumentPart); + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document with bookmark "Northwind" whose start and end preserved in different section + Dim templateDocument As New WordDocument("Template.docx", FormatType.Docx) + 'Create the bookmark navigator instance to access the bookmark + Dim bookmarkNavigator As New BookmarksNavigator(templateDocument) + 'Move the virtual cursor to the before the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind") + 'Get the bookmark content as WordDocumentPart + Dim wordDocumentPart As WordDocumentPart = bookmarkNavigator.GetContent() + 'Close the template document + templateDocument.Close() + 'Load the Word document with bookmark NorthwindDB + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Create the bookmark navigator instance to access the bookmark + bookmarkNavigator = New BookmarksNavigator(document) + 'Move the virtual cursor to the before the end location of the bookmark "NorthwindDB" + bookmarkNavigator.MoveToBookmark("NorthwindDB") + 'Replace the bookmark content with word body part + bookmarkNavigator.ReplaceContent(wordDocumentPart) + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replace the content of the bookmark with the specified Document. + + + + + + Replaces the content of the bookmark with the specified text and formatting. + + The string that specifies the text. + True if to save formatting, otherwise false. + + The following code example demonstrates how to replace a specified bookmark content with simple text along with its formatting. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Create the bookmark navigator instance to access the bookmark + BookmarksNavigator bookmarkNavigator = new BookmarksNavigator(document); + document.AddSection(); + IWParagraph paragraph = document.LastSection.AddParagraph(); + //Add the new bookmark into Word document + paragraph.AppendBookmarkStart("bm_empty"); + paragraph.AppendBookmarkEnd("bm_empty"); + //Move to the virtual cursor before the end location of the bookmark "bm_empty" + bookmarkNavigator.MoveToBookmark("bm_empty"); + //Replace the bookmark content with text body part + bookmarkNavigator.ReplaceBookmarkContent(" Northwind Database is a set of tables containing data fitted into predefined categories.", true); + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Create the bookmark navigator instance to access the bookmark + Dim bookmarkNavigator As New BookmarksNavigator(document) + document.AddSection() + Dim paragraph As IWParagraph = document.LastSection.AddParagraph() + 'Add the new bookmark into Word document + paragraph.AppendBookmarkStart("bm_empty") + paragraph.AppendBookmarkEnd("bm_empty") + 'Move to the virtual cursor before the end location of the bookmark "bm_empty" + bookmarkNavigator.MoveToBookmark("bm_empty") + 'Replace the bookmark content with text body part + bookmarkNavigator.ReplaceBookmarkContent(" Northwind Database is a set of tables containing data fitted into predefined categories.", True) + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replace bookmark item particular index,which is before performing replace bookmark content + + Current bookmark name + Bookmark index in Document.Bookmarks collection, which is before performing replace bookmark content + + + + Replace the word document part when bookmark item inside paragraph + + The word document part + + + + Deletes the bookmark content. + + if it is save formatting, set to true. + if remove the empty paragraph, set to true. + if replace bookmark content, set to true. + thrown when the current bookmark is null + + + + Delete the in between section from bookmark start owner section to bookmark end owner section + + Bookmark start section index + Bookmark end section index + + + + Delete bookmark content inside different cell + + Bookmark start owner paragraph + Bookmark end owner paragraph + Current bookmark start + Current bookmark end + Bookmark content comes table after paragraph,if it is table bookmark content pass endcell + set to true when performing replcae operation + thrown when performing replacing operation, bookmark starts in one tabel and bookmark ends in another table partially + + + + Delete the bookmark content of different cell while executing mail merge. + + + + + + + + + + + + + Creates bookmark and maintain in same index in document collection. + + Paragraph where to insert bookmark start + Paragraph where to insert bookmark end + Index where to insert bookmark in document collection + Bookmark start + Column first value + Column last value + + + + Checks whether bookmark encloses the table. + + Bookmark start table + Bookmark end table + Bookmark start + Bookmark end + + + + + Deletes the textbody from the bookmark start in a cell and bookmark end in the nested table of same cell. + + Represents a + Represents a cell of bookmark start. + Represents a table of bookmark end. + Represents a row index of bookmark end in the nested table. + + + + Delete the bookmark content inside two different table rows + + Bookmark start owner table + Bookmark end owner table + Bookmark start owner row index + Bookmark end owner row index + + + + Checks tehe two different table position properties are same + + Bookmark start owner table + Bookmars end table owner table + + trueIf the two table properties are same. else false + + + + Delete the bookmark content inside table after paragraph. + + Bookmark start owner paragraph + Bookmark end owner paragraph + Current bookmark start + Current bookmark end + + + + Delete the table rows inside bookmark start and bookmark end + + Bookmark start owner row index + Bookmark end owner row index + BookmarkTable + + + + When the table contains bookmark start/end and its corresponding bookmark start/end is outside the table, + then remove the bookmark start/end and place it in previous paragraph. + + + + + + + Delete the table rows inside bookmark start and bookmark end + + Bookmark start owner row index + Bookmark end owner row index + BookmarkTable + + + + When the bookmark end is the last item in the last cell of the row, then remove the entire row. + Else remove only the items upto the bookmark end. + + + + + + + + + To check whether the nested bookmark end is outside of the current bookmark + + Nested bookmark start paragraph + Nested bookmark end paragraph + Nested bookmark + Current bookmark end index + Returns true if the nested bookmark end is within the current bookmark + + + + Delete bookmark content inside paragraph after table. + + Bookmark start owner paragraph + Bookmark end owner paragraph + Current bookmark start + Current bookmark end + Is replcae bookmark content, set to true + thrown when performing replace operation, bookmark starts before the table and bookmark ends in table partially + + + + Get the paragraph to insert the bookmark start and bookmark end + + Bookmark start owner textbody + Bookmark end owner textbody + Bookmark owner paragraph + Bookmark owner paragraph index + Bookmark start + Bookmark end + Set to truewhen the bookmark content inside same section + Set to true when the bookmark content inside different section + + + + + Delete the bookmark content inside table + + Table which is having bookmark content + Bookmark strat owner row index + Bookmark end owner row index + Bookmark start cell index + Bookmark end cell index + + + + Deletes the cell paragraph child items from its owner paragraph + + Tabel cell last paragraph + + + + Delete bookmark content inside different section paragraph items/single section paragraph items. + + if it is save formatting, set to true. + If replace operation set to true. + + + + Removes the field in the bookmark for following cases + Field start or field end is out of the bookmark + Entire field is within the bookmark + + The paragraph which contains the current bookmark + The index next to the bookmark start + + + + Merge start section text body items to end textbody + + Start text body + + + + + Deletes the bodyitems after the bookmark start owner item. + Bookmark start owner index + Bookmark end owner index + Bookmark start owner textbody + Bookmark start next item index + If the bookmark content preserved in single section set to true + + + + + Ensures whether the items present in between the specified bookmark start and current bookmark start. + + + + + + + + + + + + + + + + + Delete the Bookmarks inside the current bookmark region from the paragraph.. + + + + + + + + + If the bookmark content inside different section, combine bookmark end owner section to Sections collection + + Bookmark end owner paragraph index + Bookmark end owner text body + When true ,if the bookmark end entity is first item of it's owner paragraph + + + + Gets the owner section + + Entity + + + + + To check the bookmark end entity is first item of it's owner paragraph + + Bookmark end owner paragraph + Current bookmark end + Bookmark end previous item index + + + + + To check the bookmark end entity is first item of it's owner table + + Bookmark end row index + Bookmark end table index + bookmark end paragraph index + Bookmark end entity + Returns true, if the bookmark end is the first item of table + + + + Set the current bookmark position when the bookmark content inside paragraph + + Bookmark start owner paragraph + Bookmark end owner paragraph + Start text body + Current bookmark start + Current bookmark end + Bookmark start owner paragraph next index + Set to true when bookmark end in next section first paragraph first item + Set to ,true when perform replcae operation + Current bookmark index in document bookmarks collection + + + + Set Bookmark position when bookmark content inside different table rows + + Bookmark start owner table + Bookmark end owner table + Bookmark start owner textbody + Bookmark end owner textbody + Current bookmark index in document bookmarks collection + + + + Delete the paragraph items which are present before bookmark end entity + + Bookmark end owner paragraph + Current bookmark end + + + + Moves the source paragraph child items to the destination paragraph child items + + + + + + + Replaces the current bookmark start and end into necessary paragraph + + Paragraph + Current bookmark index in document bookmarks collection + + + + Replace all the worddocument content into single table + + WordDocumentPart content + TextBodyPart content + thrown when performing replacing operation bookmark starts and ends in a single table and the document part is having more than one section + + + + Checks the current state of navigator. + + + + + Inserts the text range to current position + + The text. + if it is save formatting, set to true. + if it is Replaced content, set to true. + TextRange + + + + Applies character formatting of the paragraph on text range. + + + + + + Inserts the body item. + + The item. + + + + Gets or sets the Word document of this object. + + The object. + + + + Gets the current bookmark. + + The current object. + + + + Gets/Sets the cursor position + + + truemoves the cursor to the beginning of the bookmark. + falsemoves the cursor to the end of the bookmark + + + + + Gets/Sets the cursor position + + + truemoves the cursor to be after the bookmark start or end position. + falsemoves the cursor to be before the bookmark start or end position. + + + + Gets or sets a value indicating whether [remove empty paragraph]. + + + true if [remove empty paragraph]; otherwise, false. + + + + + Gets the current bookmark item which can be a + or . Read-only. + + The that specifies whether + it is or . + + + + + Return the index to insert the item into the paragraph + + + + + Represents a collection of items. + + + + + Represents a collection of DLS entities. + + + + + + + + + + Represents required functionality for serialization by XDLSReader/Writer. + Used for collections/lists implementation + + + + + Collection must creates and adds new empty item. + + + + + + Gets the name of the tag item. + + The name of the tag item. + + + + Gets the count. + + The count. + + + + Initializes a new instance of the class. + + + + + Collection must creates and adds new empty item. + + + + + + + Clones to other collection. + + The coll. + + + + Gets name of xml tag + + + + + + Creates the item. + + + The reader. + + + + + Gets name of xml tag + + + + + Represents the entities collections. + + + + + Represents base interface for DLS collections. + + + + + Gets the number of items in collection. + + The integer represents the count of the items. + + + + Gets the at the specified index. + + The zero-based index of the entity to get + The at the specified index + The index is not valid index in the + + + + Initializes a new instance of the class. + + The doc. + + + + Initializes a new instance of the class. + + The doc. + The owner. + + + + Adds the specified entity to the collection. + + The to be added to the collection. + The zero-based index of the . + Thrown when paragraph is added to CheckBox and Picture content control. + + + + Clears the existing maximum preferred width information for a table row or cell if it exists. + + The entity to check for maximum preferred width information. + + + + Checks whether the content control supports bookmarks to add in it. + + Represernts or instance. + Returns true, if it is valid type of content control to add bookmark; otherwise retuens false. + + + + Checks whether the entity can have paragraph. + + True if the owner of this entity is CheckBox,ComboBox,Drop-down and Picture content control. + + + + Get the bookmarkend index if it preserve after the the Paragraph/Table/Cell/Row end mark + + + + + + Removes all items from the collection. + + + + + Determines whether an entity is in the collection. + + The to be found in the collection. + True if it contains the specified entity, otherwise false. + + + + Returns the zero-based index of the specified entity. + + The to which the index to be found. + The zero-based index of the specified entity. + + + + Inserts a entity into the collection at the specified index. + + The integer that specifies the index to insert the entity. + The to be inserted. + + + + Update the index of the entity. + + Update start from next of these index entity + Decide whether is it add or remove operation. + + + + Update the index of the entity. + + Update start from next of these index entity + Decide whether is it add or remove operation. + + + + Removes the entity from the collection. + + The to be removed. + + + + Removes the entity at the specified index from the collection. + + The index of the entity to be removed. + The index is not valid in the . + + + + Updates the document collections while removing the text body items from the document. + + Entity to be removed from the document. + + + + Checks whether the entity is a renderable item or not. + + Entity to check remderable or not + True,if the entity is renderable else false. + + + + Updates the document collections while removing the text body items from the shape. + + Entity to be removed from the document. + + + + Remove and unlink revision from the entity while removing. + + + + + + Remove and unlink revision from the format base while removing the entity. + + + + + + Updates track changes revision while adding the entity. + + + + + + Updates track changes revision by iterating the section while adding the entity. + + + + + + Updates track changes revision by iterating the body item while adding the entity. + + + + + + Updates track changes revision by iterating the paragraph item while adding the entity. + + + + + + Updates track changes revision by iterating the para items while adding the entity. + + + + + + Updates track changes revision by iterating the body while adding the entity. + + + + + + Updates track changes revision by iterating the table while adding the entity. + + + + + + Updates track changes revision of para item while adding the entity. + + + + + + Checks the track change. + + The item. + + + + Updates track changes revision of paragraph while adding the entity. + + + + + + Gets Next sibling entity. + + The entity. + + + + + Gets Previous sibling entity. + + The entity. + + + + + Gets the index of the next or previous element. + + The index. + The type. + if it specifies next element, set to true. + + + + + Removes items of specified type + + The type. + + + + Clones all items to destination collection. + + The destination collection. + + + + Occurs when all items are removed. + + + + + + Occurs when entity is inserted. + + + The zero-based index to insert the entity. + The to insert. + + + + Update the field range before it is removed + + + + + + Update the field separator and end to the field + + + + + + Add the field range to collection + + + + + + + + + Occurs when entity is inserted. + + + The zero-based index to insert the entity. + The to insert. + + + + occurs when entity is removed. + + + The zero-based index to remove the entity. + + + + Determines whether specified element type is correct. + + The entity. + + If the element type is correct, set to true. + + + + + Called when [insert field]. + + The index. + The entity. + + + + + Called when [insert field complete]. + + The index. + The entity. + + + + Determine whether the merge field need to be updated with field marks + + + + + + Update field marks for the Merge fields when add/insert into the paragraph + + + + + + + Called when form field inserts - Performs insertion of bookmark start for the corresponding form field. + + Index + Entity + Updated index + + + + Checks the name of the form field. + + Name of the form field. + + + + Called after form field inserted - Inserts bookmark end for the corresponding form fields. + + Index + Entity + + + + Updates the text from inline content control to the paragraph text. + + Paragraph to update the text. + An to retrive text ranges. + + + + Gets the at the specified index. + + The zero-based index of the entity to get. + The at the specified index. + The index is not valid index in the . + + + + Gets the first item from the collection. + + The at the first index. + + + + Gets the last item from the collection. + + The at the last index. + + + + Gets a value indicating whether this is joined. + + If it is joined, set to true. + + + + Gets or sets a value indicating that the collection has wfield entity + + + + + + + + + + Gets the type of the elements present in the collection. + + + The collection that contains the types of the elements. + + + + Specifies the item change entity type. + + + + + Add entity type. + + + + + Remove Entity type. + + + + + Clear Entity type. + + + + + Represents the method that will handle the collection changes. + + The type of action to be performed. + The . + + + + + + + + + Adds the specified handler. + + The handler. + + + + Removes the specified handler. + + The handler. + + + + Returns an enumerator that iterates through a collection. + + + An object that can be used to iterate through the collection. + + + + + Sends the specified type. + + The type. + The entity. + + + + Initializes a new instance of the class with the specified + instance. + + The . + + + + Initializes a new instance of the class. + + The doc. + + + + Gets the name of xml tag + + + The string that represents the xml tag name. + + + + Creates the item. + + + The object. + The . + + + + Gets the at the specified index. + + + + + + + Gets the type of the elements present in the collection. Read-only. + + + The collection that contains the types of the elements. + + + + Represents the collection of in the Word document. + + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Get the bookmark instance with bookmark name + Syncfusion.DocIO.DLS.Bookmark bookmark = document.Bookmarks["Northwind"]; + //Access the bookmark start�s owner paragraph using bookmark and change its back color + bookmark.BookmarkStart.OwnerParagraph.ParagraphFormat.BackColor = Color.AliceBlue; + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Get the bookmark instance with bookmark name + Dim bookmark As Syncfusion.DocIO.DLS.Bookmark = document.Bookmarks("Northwind") + 'Access the bookmark start�s owner paragraph using bookmark and change its back color + bookmark.BookmarkStart.OwnerParagraph.ParagraphFormat.BackColor = Color.AliceBlue + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + + Initializes a new instance of the class. + + The document. + + + + Finds with specific name in the document. + + The string that represents the name of the bookmark to find. + The with the specified name. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Get the bookmark instance using FindByName method of BookmarkCollection with bookmark name + Bookmark bookmark = document.Bookmarks.FindByName("Northwind"); + //Access the bookmark start�s owner paragraph using bookmark and change its back color + bookmark.BookmarkStart.OwnerParagraph.ParagraphFormat.BackColor = Color.AliceBlue; + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Get the bookmark instance using FindByName method of BookmarkCollection with bookmark name + Dim bookmark As Bookmark = document.Bookmarks.FindByName("Northwind") + 'Access the bookmark start�s owner paragraph using bookmark and change its back color + bookmark.BookmarkStart.OwnerParagraph.ParagraphFormat.BackColor = Color.AliceBlue + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Removes a bookmark at the specified index. + + The integer that represents the position of the bookmark to remove. + The index is not valid in the . + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Remove the bookmark at the second index from Word document. + document.Bookmarks.RemoveAt(1); + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Remove the bookmark at the second index from Word document. + document.Bookmarks.RemoveAt(1) + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Removes the specified bookmark from the document. + + The to be removed. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Get the bookmark instance using FindByName method of BookmarkCollection with bookmark name + Bookmark bookmark = document.Bookmarks.FindByName("Northwind"); + //Remove the bookmark named "Northwind" from Word document. + document.Bookmarks.Remove(bookmark); + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Get the bookmark instance using FindByName method of BookmarkCollection with bookmark name + Dim bookmark As Bookmark = document.Bookmarks.FindByName("Northwind") + 'Remove the bookmark named "Northwind" from Word document. + document.Bookmarks.Remove(bookmark) + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Removes all the bookmarks in the document. + + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Remove all the bookmarks from Word document + document.Bookmarks.Clear(); + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Remove all the bookmarks from Word document + document.Bookmarks.Clear() + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Adds Bookmark object to the collection. + + + + + + Attaches the bookmark start. + + The bookmark start. + + + + Sets BookmarkEnd for the bookmark specified by Name + + + + + + + Gets the with the specified name. + + The string that represents the name of the bookmark in the document to get. + The with the specified name. + The specified bookmark name is not present in the document. + + + + Gets the at the specified index. + + The integer that represents the position of the bookmark in the document to get. + The at the specified index. + The index is not valid in the + + + + Represents the collection of in the Word document. + + + + + Initializes a new instance of the class. + + The document. + + + + Finds with specific id in the document. + + The string that represents the id of the editable range to find. + The with the specified id. + + + + Removes a editable range at the specified index. + + The integer that represents the position of the editable range to remove. + + + + Removes the specified editable range from the document. + + The to be removed. + + + + Adds editable range object to the collection. + + Represents a editable range to add in collection. + + + + Attaches the editable range start. + + Represents a editable range start. + + + + Sets editable raange end for the editabler range specified by id. + + Represents a editable range end. + + + + Gets the with the specified name. + + The string that represents the id of the editable range in the document to get. + The with the specified id. + + + + Represents the collection of in the section of a Word document. + + + The following code example demonstrates how to + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + foreach (WSection section in document.Sections) + { + //Populates the specified number of columns with specified spacing. + if (section.Columns.Count > 0) + section.Columns.Populate(2, 10); + } + //Add the section into Word document + IWSection newSection = document.AddSection(); + //Add the column into the section + newSection.AddColumn(150, 20); + //Add the column into the section + newSection.AddColumn(150, 20); + //Add a paragraph to created section + IWParagraph paragraph = newSection.AddParagraph(); + //Add a paragraph to created section + paragraph = newSection.AddParagraph(); + string paraText = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"; + //Append the text to the created paragraph + paragraph.AppendText(paraText); + //Add the column breaks + paragraph.AppendBreak(BreakType.ColumnBreak); + //Add a paragraph to created section + paragraph = newSection.AddParagraph(); + //Append the text to the created paragraph + paragraph.AppendText(paraText); + //Add the column breaks + paragraph.AppendBreak(BreakType.ColumnBreak); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + For Each section As WSection In document.Sections + 'Populates the specified number of columns with specified spacing. + If section.Columns.Count > 0 Then + section.Columns.Populate(2, 10) + End If + Next + 'Add the section into Word document + Dim newSection As IWSection = document.AddSection() + 'Add the column into the section + newSection.AddColumn(150, 20) + 'Add the column into the section + newSection.AddColumn(150, 20) + 'Add a paragraph to created section + Dim paragraph As IWParagraph = newSection.AddParagraph() + 'Add a paragraph to created section + paragraph = newSection.AddParagraph() + Dim paraText As String = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula" + 'Append the text to the created paragraph + paragraph.AppendText(paraText) + 'Add the column breaks + paragraph.AppendBreak(BreakType.ColumnBreak) + 'Add a paragraph to created section + paragraph = newSection.AddParagraph() + 'Append the text to the created paragraph + paragraph.AppendText(paraText) + 'Add the column breaks + paragraph.AppendBreak(BreakType.ColumnBreak) + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Initializes a new instance of the class. + + The section. + + + + Adds object to the collection. + + The to be added. + The zero-based index of the column. + + + + Populates the specified number of columns with specified spacing. + + The integer specifying the columns count. + The float that specifies the spacing between columns. + + + + Adds object to the collection. + + The to be added. + The bool that specifies whether the document is opened. + The zero-based index of the column. + + + + Clones items to specified collection. + + The collection. + + + + Creates the item. + + + The reader. + The object. + + + + Gets name of xml tag + + + The string that specifies the tag name. + + + + Gets the at the specified index. + + The zero-based index of the column in the collection. + The at the specified index. + + + + + Gets the owner section. + + The owner section. + + + + Represents the collection of in the Word document. + + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Comment.docx"); + //Iterate the comments in the Word document + foreach (WComment comment in document.Comments) + { + //Modify the last paragraph text of an existing comment if it is added by "Peter" + if (comment.Format.User == "Peter") + comment.TextBody.LastParagraph.Text = "Modified Comment Content"; + } + document.Save("ModifiedComment.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Comment.docx") + 'Iterate the comments in the Word document + For Each comment As WComment In document.Comments + 'Modify the last paragraph text of an existing comment if it is added by "Peter" + If comment.Format.User = "Peter" Then + comment.TextBody.LastParagraph.Text = "Modified Comment Content" + End If + Next + document.Save("ModifiedComment.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + Initializes a new instance of the class. + + The object. + + + + Returns the total number of comments in the document. Read-only. + + The integer that specifies the total number of in this . + + + + Removes the at specified index. + + The zero-based index of the comment to be removed. + + The following code example demonstrates how to remove the comment at specified index in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Comment.docx"); + //Remove the second comment from a document + document.Comments.RemoveAt(1); + //Save and close the Word document + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Comment.docx") + 'Remove the second comment from a document + document.Comments.RemoveAt(1) + 'Save and close the Word document + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Removes all the comments from the document. + + + The following code example demonstrates how to remove all the comments from the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Comment.docx"); + //Remove all the comments in a Word document + document.Comments.Clear(); + //Save and close the Word document + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Comment.docx") + 'Remove all the comments in a Word document + document.Comments.Clear() + 'Save and close the Word document + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Adds the specified comment. + + + + + + Removes the specified Comment. + + The to be removed. + + The following code example demonstrates how to remove particular comment from the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Comment.docx"); + //Get the second comment from a document. + WComment comment = document.Comments[1]; + //Remove comment from a document. + document.Comments.Remove(comment); + //Save and close the Word document + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Comment.docx") + 'Get the second comment from a document. + Dim comment As WComment = document.Comments(1) + 'Remove comment from a document. + document.Comments.Remove(comment) + 'Save and close the Word document + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Sets the ParentParaId of the comment + + + + + Gets the comment at specified index. Read-only. + + The zero-based index of the comment in the collection. + The at the specified index. + The index is not valid in the + + + + Initializes a new instance of the class. + + The object. + + + + Add the specified comment + + + + + + Gets the comment at specified index. Read-only. + + The zero-based index of the comment in the collection. + The at the specified index. + The index is not valid in the + + + + Represents the sort options for list. + + The type of the key. + The type of the value. + + + + Represents the sort options for the list. + + + + + + + Default capacity of internal buffers. + + + + + Array which store keys in sorted order. + + + + + Collection stores values. + + + + + Size of collection. + + + + + Version of collection data. + + + + + Default comparer for keys. + + + + + List of keys. + + + + + List of values. + + + + + Default constructor. + + + + + Creates an empty list with the specified initial capacity. + + Initial capacity. + + When initialCapacity is less than zero. + + + + + Creates an empty SortedList with the default initial capacity + and specified comparer. + + + The IComparer is used to determine whether two keys are equal. + + + + + Creates an empty SortedList with the specified initial capacity + and specified comparer. + + Initial capacity. + + The IComparer is used to determine whether two keys are equal. + + + + + Copies the elements from the specified dictionary to a new list + with the same initial capacity as the number of elements copied. + + The IDictionary to copy. + + + + Copies the elements from the specified dictionary to a new list with the same + initial capacity as the number of elements copied and with the specified comparer. + + The IDictionary to copy. + + The IComparer to use to determine whether two keys are equal. + + + When argument d is null. + + + + + Returns a synchronized (thread-safe) wrapper for the SortedList. + + The SortedList to synchronize. + A synchronized (thread-safe) wrapper for the SortedList. + + When list is null. + + + + + Adds an element with the provided key and value to the list. + + The Object to use as the key of the element to add. + The Object to use as the value of the element to add. + + When key is null. + + + When list already contains specified key. + + + + + Removes all elements from the collection. + + + + + Creates a new object that is a copy of the current instance. + + Copy of the current instance. + + + + Clone current instance. + + Returns clone of current object. + + + + Determines whether the list contains an element with the specified key. + + Key of the element to search. + True if list contains specified key. + + + + Determines whether the list contains an element with the specified key. + + Key of the element to search. + True if list contains specified key. + + + + Determines whether the list contains the specified value. + + Value of the element to search. + True if list contains specified value. + + + + Copies all the elements of the SortedListEx to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + If specified array is null. + + + If rank of the array is not 1 or there are not enough elements. + + + If specified arrayIndex is less than zero. + + + + + Gets the value at the specified index of the SortedListEx. + + The zero-based index of the value to get. + The value at the specified index of the SortedListEx. + + When index is less than zero or greater than size of the list. + + + + + Gets the key at the specified index of the SortedListEx. + + The zero-based index of the key to get. + The key at the specified index of the SortedListEx. + + When index is less than zero or greater than size of the list. + + + + + Gets the keys in the SortedListEx. + + An IList containing the keys in the SortedListEx. + + + + Gets the values in the SortedListEx. + + An IList containing the values in the SortedListEx. + + + + Returns the zero-based index of the specified key. + + The key to locate. + The zero-based index of key, if key is found; otherwise, -1. + + If specified key is null. + + + + + Returns the zero-based index of the first occurrence of the specified value. + + The value to locate (can be NULL). + + The zero-based index of the first occurrence of value, if value is found; + otherwise, -1. + + + + + Removes the element at the specified index. + + The zero-based index of the element to remove. + + When index is less than zero or greater than size of the list. + + + + + Removes the element with the specified key from SortedListEx. + + The key of the element to remove. + + + + Replaces the value at the specific index. + + The zero-based index at which to save value. + The Object to save into. Can be NULL. + + When index is less than zero or greater than size of the list. + + + + + Sets the capacity to the actual number of elements. + + + + + Returns an IEnumerator that can iterate through the SortedListEx. + + An IEnumerator for the SortedListEx. + + + + Returns an IEnumerator that can iterate through the SortedListEx. + + An IEnumerator for the SortedListEx. + + + + Inserts element with specified key and value at specified index. + + The zero-based index to insert element at. + The key of the element to insert. + The value of the element to insert. + + + + Ensures that the capacity of this instance is at least the specified value. + + The minimum capacity to ensure. + + + + Adds an element with the provided key and value to the object. + + The to use as the key of the element to add. + The to use as the value of the element to add. + + + + Determines whether the object contains an element with the specified key. + + The key to locate in the object. + if the contains an element with the key; otherwise, . + + + + Removes the element with the specified key from the object. + + The key of the element to remove. + + + + Returns the value associated with the specified key. + + + + + Adds an item to the . + + The object to add to the . + + + + Determines whether the contains a specific value. + + The object to locate in the . + if is found in the ; otherwise, . + + + + Copies the elements of the to an , starting at a particular index. + + The one-dimensional that is the destination of the elements copied from . + The must have zero-based indexing. + The zero-based index in at which copying begins. + + + + Removes the first occurrence of a specific object from the . + + The object to remove from the . + if was successfully removed from the ; otherwise, . + This method also returns if is not found in the original . + + + + Capacity of internal buffers. + + + + + Size of the collection. Read-only. + + + + + List of keys. Read-only. + + + + + List of values. Read-only. + + + + + Returns True if list is readonly, False otherwise. Read-only. + + + + + Returns True if collection has fixed size, False otherwise. + + + + + Returns True if the collection is synchronized, False otherwise. + + + + + Returns the object that can be used to synchronize access to the collection. + Read-only. + + + + + Gets or sets the value associated with the specified key. + + + + + Gets or sets the value for the property with specified key. + + The key for the property. + An object with the specific key. + + + + + + + + + Supports cloning, which creates a new instance of a class with the same value + as an existing instance. + + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + List for which is this enumerator. + + + + + Key of the current element. + + + + + Values of the current element. + + + + + Index of current element. + + + + + Starting index for the enumerator. + + + + + Ending index for this enumerator. + + + + + Version of collection data. + + + + + True if current element is correct, False otherwise + (before beginning or after end). + + + + + Creates enumerator for specified list, starting from specified index + and with specified count. + + List for which enumerator is being created. + Starting index. + Number of elements to enumerate. + + + + Performs application-defined tasks associated with freeing, releasing, or + resetting unmanaged resources. + + + + + Creates a new object that is a copy of the current instance. + + Copy of the current instance. + + + + Advances the enumerator to the next element of the collection. + + + True if the enumerator was successfully advanced to the next element; + False if the enumerator has passed the end of the collection. + + + When the current version is not equal to the SortedListEx version. + + + + + Sets the enumerator to its initial position, which is before + the first element in the collection. + + + When the current version is not equal to the SortedListEx version. + + + + + Returns key of the current element. Read-only. + + + When the current version is not equal to the SortedListEx version + or if current is false. + + + + + Return DictionaryEntry for the current element. + + + When the current version is not equal to the SortedListEx version + or if current is false. + + + + + The current element in the collection. Read-only. + + + If current is false. + + + + + The current element in the collection. Read-only. + + + If current is false. + + + + + Returns value for the current element. + + + When the current version is not equal to the SortedListEx version + or if current is false. + + + + + + + + + + + + + + + Index of current element. + + + + + Version of collection data. + + + + + + + + + + + + + + + + + + + + + List for which this collection was created. + + + + + Creates KeyList for specified SortedListEx. + + TypedSortedListEx for which KeyList must be created. + + + + Adds an element with the provided key to the list. + + The Object to use as the key of the element to add. + + + + Removes all elements from the collection. + + + + + Determines whether the list contains an element with the specified key. + + Key of the element to search. + True if list contains specified key. + + + + Copies all the elements of the list to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + If array is null or rank of the array is not 1. + + + + + Copies all the elements of the list to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + If array is null or rank of the array is not 1. + + + + + Insert the value at the specific index. + + The zero-based index at which to save value. + The Object to save into. Can be NULL. + + + + Returns an IEnumerator that can iterate through the list. + + An IEnumerator for the list. + + + + Returns an IEnumerator that can iterate through the list. + + An IEnumerator for the list. + + + + Returns the zero-based index of the specified key. + + The key to locate. + The zero-based index of the key, if the key is found; otherwise, -1. + + + + Removes the element with the specified key from list. + + The key of the element to remove. + + + + Removes the element at the specified index from the list. + + The zero-based index of the element to remove. + + + + Size of the collection. Read-only. + + + + + Returns True if list is readonly, False otherwise. Read-only. + + + + + Returns True if collection has fixed size, False otherwise. + + + + + Returns True if the collection is synchronized, False otherwise. + + + + + Returns the object that can be used to synchronize access to the collection. + Read-only. + + + + + Gets or sets the key at the specified index. + + + + + + + + + + List for which this collection was created. + + + + + Array that contain values. + + + + + Creates ValueList for specified SortedListEx. + + List for which ValueList must be created. + + + + Re-read values from the list. + + + + + Adds an element with the provided key to the list. + + Value to add. + + + + Removes all elements from the collection. + + + + + Determines whether the list contains an element with the specified value. + + Value to search. + True if list contains specified value. + + + + Copies all the elements of the list to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + + + Copies all the elements of the list to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + + + Insert the value at the specific index. + + The zero-based index at which to save value. + The Object to save into. Can be NULL. + + + + Returns an IEnumerator that can iterate through the list. + + An IEnumerator for the list. + + + + Returns an IEnumerator that can iterate through the list. + + An IEnumerator for the list. + + + + Returns the zero-based index of the specified value. + + The value to locate. + The zero-based index of the value, if the value is found, otherwise -1. + + + + Removes the specified value from list. + + The value to remove. + + + + Removes the element at the specified index from the list. + + The zero-based index of the element to remove. + + + + Size of the collection. Read-only. + + + + + Returns True if list is readonly, False otherwise. Read-only. + + + + + Returns True if collection has fixed size, False otherwise. + + + + + Returns True if the collection is synchronized, False otherwise. + + + + + Returns the object that can be used to synchronize access to the collection. + Read-only. + + + + + Gets or sets the value at the specified index. + + + + + Initialiazes a new instance of class. + + + + + Initializes a new instance of class with the specified comparer. + + The implementation to use when comparing elements. + + + + Initializes a new instance of class with the specified length. + + The length of the range to sort. + + + + Initializes a new instance of class from the existing dictionary collection. + + The to copy. + + + + Represents the sorting of dictionary collection. + + The type of the key. + The type of the value. + + + + Represents a subset from the collection of specified type entities. + + + + + + + + + + Initializes a new instance of the class. + + The collection. + The type. + + + + Removes all the entities from the collection. + + + + + Closes this instance. + + + + + Returns an enumerator that iterates through a collection. + + + An object that can be used to iterate through the collection. + + + + + Adds the entity to the end of collection. + + The entity. + + + + + Determines whether a entity is in the collection. + + The entity. + + + + + Returns the zero-based index of the specified entity. + + The entity. + + + + + Inserts a entity into the collection at the specified index. + + + + + + + + Removes the entity from the collection. + + + + + + Removes the entity at the specified index from the collection. + + The index. + + + + Gets the entity by its index. + + + The zero-based index of the entity. + The at the specified index. + The index is not valid in the . + + + + Gets the base index. + + The index. + + + + + Updates the count. + + + + + Checks the type. + + + + + Calls when in base collection changed items. + + The type. + The entity. + + + + Clears the indexes. + + + + + Gets the current document. Read-only. + + The object. + + + + Gets the owner of this . Ready-only. + + The which is the owner element. + + + + Gets the number of items in collection. + + The integer that represents the count of the items. + + + + Gets the at the specified index. + + The zero-based index of the entity to get. + The at the specified index. + The index is not valid index in the . + + + + Represents a internal enumerator for EntitySubSetCollection. + + + + + Initializes a new instance of the class. + + The entities collection. + + + The collection was modified after the enumerator was created. + + + + Sets the enumerator to its initial position, which is before the first element in the collection. + + The collection was modified after the enumerator was created. + + + The enumerator is positioned before the first element of the collection or after the last element. + + + + A collection of objects that + represent the fields in the document. + + + + + Initializes a new instance of the class. + + The document. + + + + Finds object by specified name + + The Field value + + + + + Removes a Field at the specified index. + + The index. + + + + Removes the specified field. + + The field. + + + + Removes all Fields from the document. + + + + + Adds field objects to the collection. + + + + + + Inserts AutoNum Field in a collection in ascending order as per in the Word document. + The both auto num and auto num legal field result is same. + If the document has multiple auto num and auto num legal field then the result preserves continuously. + So maintain the field in same collection to get the result as in the Word document. + + The WField + + + + Checks hierarchical index of current field with other hierarchical indexes + + The oldHierarchicalIndex + The newHierarchicalIndex + + + + Gets the AutoNum FieldResult + + The field + + + + Checks whether the current field and previous field is in same paragraphitem. + + The Previous Field Index + The current Field Index + Returns True when both Field are inside the same paragaraphitem otherwise returns false + + + + Gets the number from roman (Convertion of roman to arabic) + + The Roman letter + Number value + + + + Gets the Seperator code from the FieldCode in a Field using index of the field in the + SortedAutoNumFields List array + + The Index of Field in the list + Splited Seperator charactor + + + + Gets the NUmber Format from FieldCode using index of the field in the + SortedAutoNumFields List array + + The Index of the Field + Number Format + + + + Gets the number from alphabet (Convertion of alphabet to arabic) + + + + + + + Gets the with the specified name. + + + + + + Gets the at the specified index. + + + + + + Gets or sets the AutoNum Fields. + + The Sorted AutoNum Fields. + + + + Gets or sets the AutoNum Fields Indexes. + + The Sorted AutoNum Fields indexes. + + + + Represents a collection of form fields. + + + + + Initializes a new instance of the class. + + The text body. + + + + Returns value indicating whether the specified collection contains item with specified name. + + The string that specifies the name of the item to be found. + True if the collection has the specified form field, otherwise false. + + + + Corrects the name. + + The old name. + The new name. + + + + Adds the specified formField. + + The formField. + + + + Removes the specified formField. + + The formField. + + + + Populates this coollection of form fields from parent WTextBody. + + + + + Populates from paragraph. + + The paragraph. + + + + Populates from table. + + The table. + + + + Gets form field by name. + + Name of the form field. + + + + + Closes this instance. + + + + + Gets the at the specified index. Read-only. + + The zero-based index of the form field to get. + The at the specified index. + The index is not valid in the . + + + + Gets the with specified name. Read-only. + + The string that specifies the form field name. + The with the specified name. + + + + Gets dictionary with form field items. + + + + + Initializes a new instance of the class. + + The doc. + + + + Adds the specified image. + + The image. + + + + Removes the specified image id. + + The image id. + + + + + Clears this instance. + + + + + Loads the image. + + The image bytes. + + + + Loads the meta file image. + + The image bytes. + if set to true [is compressed]. + + + + + Loads the image. + + The image bytes. + + + + Compresses the image bytes. + + The image bytes. + + + + + Decompresses the image bytes. + + The compressed image. + + + + + Gets the with the specified image id. + + + + + + Gets the owner document. + + The document. + + + + Represents a collections of list formatting for each levels in a list. + + + + + + Initializes a new instance of the class. + + The owner. + + + + Adds List level to collection. + + The level. + + + + + Gets index of in the collection. + + The level. + + + + + Removes all levels. + + + + + Creates a new item. + + + The object. + The object. + + + + Returns the name of xml tag. + + + The string that represents the tag name. + + + + Compares list levels with current list levels. + + + + + Gets the at the specified index. Read-only. + + The zero-based index of the list level to get. + The at the specified index. + + + + Represents the list levels of ListOverrideStyle. + + + + + Initializes a new instance of the class. + + The doc. + + + + Adds List level into collection. + + + + + + + Gets the level number. + + The level format. + + + + + Determines whether the current list override style has specified level. + + The level number. + + true if the current list override style has specified level; otherwise, false. + + + + + Clones itself. + + The collection. + + + + + + + + + + + Gets name of xml tag + + + + + + Closes this instance. + + + + + Compares the list override level formats with the current list override level formats + + The list override levels + + + + Gets the at the specified index. + + + + + + Gets the owner style. + + The owner style. + + + + Gets or sets the level index. + + The . + + + + Summary description for ListOverridesCollection. + + + + + Represents a collection of objects. + + + + + Represents a collection of objects. + + + + + Adds the specified to collection. + + The to be added to the styles collection. + The zero-based index of the added . + + The following code example demonstrates how to add style to the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open an input Word template + WordDocument document = new WordDocument(inputFileName); + //Access the styles collection which contains paragraph and character styles in Word document + WParagraphStyle style = new WParagraphStyle(document); + //Specify the style name. + style.Name = "User_Defined_style"; + //Specify the character properties for the style + style.CharacterFormat.Bold = true; + style.CharacterFormat.FontName = "Arial"; + style.CharacterFormat.FontSize = 14; + //Specify the paragraph properties for the style + style.ParagraphFormat.BackColor = Color.LightGray; + style.ParagraphFormat.AfterSpacing = 18f; + style.ParagraphFormat.BeforeSpacing = 18f; + StyleCollection styleCollection = document.Styles as StyleCollection; + //Add the style to the document styles collection. + styleCollection.Add(style); + //Save and close the document + document.Save(outputFileName, FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open an input Word template + Dim document As New WordDocument(inputFileName) + 'Access the styles collection which contains paragraph and character styles in Word document + Dim style As New WParagraphStyle(document) + 'Specify the style name. + style.Name = "User_Defined_style" + 'Specify the character properties for the style + style.CharacterFormat.Bold = True + style.CharacterFormat.FontName = "Arial" + style.CharacterFormat.FontSize = 14 + 'Specify the paragraph properties for the style + style.ParagraphFormat.BackColor = Color.LightGray + style.ParagraphFormat.AfterSpacing = 18F + style.ParagraphFormat.BeforeSpacing = 18F + Dim styleCollection As StyleCollection = TryCast(document.Styles, StyleCollection) + 'Add the style to the document styles collection. + styleCollection.Add(style) + 'Save and close the document + document.Save(outputFileName, FormatType.Docx) + document.Close() + End Sub + + + + + + Finds a first style in the collection with specified style name. + + The string value that represents the name of the style to be found. + The object of specified name + The style name is not valid in the + The following example illustrates how to find a style by its name and modify its character and paragraph formats. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open an input Word template + WordDocument document = new WordDocument(inputFileName); + //Access the styles collection which contains paragraph and character styles in Word document + IStyleCollection styleCollection = document.Styles; + //Find the style with the name "Heading 1" + WParagraphStyle heading1ParagraphStyle = styleCollection.FindByName("Heading 1") as WParagraphStyle; + //Change the text color of style "Heading 1" as DarkBlue + heading1ParagraphStyle.CharacterFormat.TextColor = Color.DarkBlue; + //Change the first line indent of Paragraph as 36 points + heading1ParagraphStyle.ParagraphFormat.FirstLineIndent = 36; + document.Save(outputFileName, FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open an input Word template + Dim document As New WordDocument(inputFileName) + 'Access the styles collection which contains paragraph and character styles in Word document + Dim styleCollection As IStyleCollection = document.Styles + 'Find the style with the name "Heading 1" + Dim heading1ParagraphStyle As WParagraphStyle = TryCast(styleCollection.FindByName("Heading 1"), WParagraphStyle) + 'Change the text color of style "Heading 1" as DarkBlue + heading1ParagraphStyle.CharacterFormat.TextColor = Color.DarkBlue + 'Change the first line indent of paragraph as 36 points + heading1ParagraphStyle.ParagraphFormat.FirstLineIndent = 36 + document.Save(outputFileName, FormatType.Docx) + document.Close() + End Sub + + + + + + Finds a style in the collection specified by the style name and style type. + + The string value that represents the name of the style to be found. + The of the specified style. + The object with the specified name. + The style name is not valid in the + The following example illustrates how to find a style by its name and its type. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open an input Word template + WordDocument document = new WordDocument(inputFileName); + //Access the styles collection which contains paragraph and character styles in Word document + IStyleCollection styleCollection = document.Styles; + //Find the style with the name "Heading 1" + WParagraphStyle heading1ParagraphStyle = styleCollection.FindByName("Heading 1", StyleType.ParagraphStyle) as WParagraphStyle; + //Change the text color of style "Heading 1" as DarkBlue + heading1ParagraphStyle.CharacterFormat.TextColor = Color.DarkBlue; + //Change the first line indent of Paragraph as 36 points + heading1ParagraphStyle.ParagraphFormat.FirstLineIndent = 36; + document.Save(outputFileName, FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open an input Word template + Dim document As New WordDocument(inputFileName) + 'Access the styles collection which contains paragraph and character styles in Word document + Dim styleCollection As IStyleCollection = document.Styles + 'Find the style with the name "Heading 1" + Dim heading1ParagraphStyle As WParagraphStyle = TryCast(styleCollection.FindByName("Heading 1", StyleType.ParagraphStyle), WParagraphStyle) + 'Change the text color of style "Heading 1" as DarkBlue + heading1ParagraphStyle.CharacterFormat.TextColor = Color.DarkBlue + 'Change the first line indent of Paragraph as 36 points + heading1ParagraphStyle.ParagraphFormat.FirstLineIndent = 36 + document.Save(outputFileName, FormatType.Docx) + document.Close() + End Sub + + + + + + Finds a style specified by its style Id. + + The integer that represents the Id of the style. + The object of specified Id + The style Id is not valid in the + + + + Gets the at the specified index. + + The zero-based index of the style to get + The at the specified index + The index is not valid index in the + + + + Gets or sets a value indicating whether the stylesheet has style at 13th index + + True, if the stylesheet has style at 13th index(other than empty style), otherwise false + Reserved styles are applicable only for *.doc format + + + + Gets or sets a value indicating whether the stylesheet has style at 14th index + + True, if the stylesheet has style at 14th index(other than empty style), otherwise false + Reserved styles are applicable only for *.doc format + + + + Gets or sets the name of the style at 13th index in the stylesheet + + The string that represents the name of the style. + Reserved styles are applicable only for *.doc format + + + + Gets or sets the name of the style at 14th index in the stylesheet + + The string that represents the name of the style. + Reserved styles are applicable only for *.doc format + + + + Represents the style name of the style present at the fixed index 13 in the stylesheet + + Reserved styles are applicable only for *.doc format + + + + Represents the style name of the style present at the fixed index 14 in the stylesheet + + Reserved styles are applicable only for *.doc format + + + + Initializes a new instance of the class. + + The doc. + + + + Adds the specified to collection. + + The to be added to the styles collection. + The zero-based index of the added . + + The following code example demonstrates how to add style to the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open an input Word template + WordDocument document = new WordDocument("Template.docx"); + //Access the styles collection which contains paragraph and character styles in Word document + WParagraphStyle style = new WParagraphStyle(document); + //Specify the style name. + style.Name = "User_Defined_style"; + //Specify the character properties for the style + style.CharacterFormat.Bold = true; + style.CharacterFormat.FontName = "Arial"; + style.CharacterFormat.FontSize = 14; + //Specify the paragraph properties for the style + style.ParagraphFormat.BackColor = Color.LightGray; + style.ParagraphFormat.AfterSpacing = 18f; + style.ParagraphFormat.BeforeSpacing = 18f; + StyleCollection styleCollection = document.Styles as StyleCollection; + //Add the style to the document styles collection. + styleCollection.Add(style); + //Save and close the document + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open an input Word template + Dim document As New WordDocument(inputFileName) + 'Access the styles collection which contains paragraph and character styles in Word document + Dim style As New WParagraphStyle(document) + 'Specify the style name. + style.Name = "User_Defined_style" + 'Specify the character properties for the style + style.CharacterFormat.Bold = True + style.CharacterFormat.FontName = "Arial" + style.CharacterFormat.FontSize = 14 + 'Specify the paragraph properties for the style + style.ParagraphFormat.BackColor = Color.LightGray + style.ParagraphFormat.AfterSpacing = 18F + style.ParagraphFormat.BeforeSpacing = 18F + Dim styleCollection As StyleCollection = TryCast(document.Styles, StyleCollection) + 'Add the style to the document styles collection. + styleCollection.Add(style) + 'Save and close the document + document.Save(outputFileName, FormatType.Docx) + document.Close() + End Sub + + + + + + Finds a first style in the collection with specified style name. + + The string value that represents the name of the style to be found. + The object of specified name + The style name is not valid in the + The following example illustrates how to find a style by its name and modify its character and paragraph formats. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open an input Word template + WordDocument document = new WordDocument("Template.docx"); + //Access the styles collection which contains paragraph and character styles in Word document + IStyleCollection styleCollection = document.Styles; + //Find the style with the name "Heading 1" + WParagraphStyle heading1ParagraphStyle = styleCollection.FindByName("Heading 1") as WParagraphStyle; + //Change the text color of style "Heading 1" as DarkBlue + heading1ParagraphStyle.CharacterFormat.TextColor = Color.DarkBlue; + //Change the first line indent of Paragraph as 36 points + heading1ParagraphStyle.ParagraphFormat.FirstLineIndent = 36; + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open an input Word template + Dim document As New WordDocument(inputFileName) + 'Access the styles collection which contains paragraph and character styles in Word document + Dim styleCollection As IStyleCollection = document.Styles + 'Find the style with the name "Heading 1" + Dim heading1ParagraphStyle As WParagraphStyle = TryCast(styleCollection.FindByName("Heading 1"), WParagraphStyle) + 'Change the text color of style "Heading 1" as DarkBlue + heading1ParagraphStyle.CharacterFormat.TextColor = Color.DarkBlue + 'Change the first line indent of paragraph as 36 points + heading1ParagraphStyle.ParagraphFormat.FirstLineIndent = 36 + document.Save(outputFileName, FormatType.Docx) + document.Close() + End Sub + + + + + + Finds a style in the collection specified by the style name and style type. + + The string value that represents the name of the style to be found. + The of the specified style. + The object with the specified name. + The style name is not valid in the + The following example illustrates how to find a style by its name and its type. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open an input Word template + WordDocument document = new WordDocument("Template.docx"); + //Access the styles collection which contains paragraph and character styles in Word document + IStyleCollection styleCollection = document.Styles; + //Find the style with the name "Heading 1" + WParagraphStyle heading1ParagraphStyle = styleCollection.FindByName("Heading 1", StyleType.ParagraphStyle) as WParagraphStyle; + //Change the text color of style "Heading 1" as DarkBlue + heading1ParagraphStyle.CharacterFormat.TextColor = Color.DarkBlue; + //Change the first line indent of Paragraph as 36 points + heading1ParagraphStyle.ParagraphFormat.FirstLineIndent = 36; + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open an input Word template + Dim document As New WordDocument(inputFileName) + 'Access the styles collection which contains paragraph and character styles in Word document + Dim styleCollection As IStyleCollection = document.Styles + 'Find the style with the name "Heading 1" + Dim heading1ParagraphStyle As WParagraphStyle = TryCast(styleCollection.FindByName("Heading 1", StyleType.ParagraphStyle), WParagraphStyle) + 'Change the text color of style "Heading 1" as DarkBlue + heading1ParagraphStyle.CharacterFormat.TextColor = Color.DarkBlue + 'Change the first line indent of Paragraph as 36 points + heading1ParagraphStyle.ParagraphFormat.FirstLineIndent = 36 + document.Save(outputFileName, FormatType.Docx) + document.Close() + End Sub + + + + + + Finds a built-in style in the collection specified by the style name and style type. + + The string value that represents the name of the style to be found. + The of the specified style. + The object with the specified name and style type. + + + + Finds a style in the collection specified by the style name and style type. + + The string value that represents the name of the style to be found. + The of the specified style. + The collection to hold the styles starts with the specified style name. + The object with the specified name and style type. + The style name is not valid in the + + + + Finds a style specified by its style Id. + + The integer that represents the Id of the style. + The object of specified Id + The style Id is not valid in the + + + + Clones to other collection. + + The collection. + + + + Remove this style from the Word document. + + + + + + Updates the style name when it is empty. + + Current style + + + + Check whether the same name exist in document or not. + + Current style name + + + + + Finds the style with specified style name. + + The styles. + The name. + + + + + Finds the style with specified style name. + + The styles. + The name. + + + + + Finds the style with specified style id. + + The styles. + The name. + + + + + Finds the style with specified style id and type + + + + + Finds the style with specified style name. + + The styles. + The name. + Type of the style. + + + + + Finds the default style with specified style name. + + The styles. + The name. + Type of the style. + + + + + Finds a style in the collection specified by the style name and style type. + + The . + The string value that represents the name of the style to be found. + The of the specified style. + The collection to hold the styles starts with the specified style name. + The object with the specified name and style type. + The style name is not valid in the + + + + Finds the style with specified style name. + + The styles. + The name. + Type of the style. + + + + + Creates the item. + + + The object. + The object. + + + + Returns the name of xml tag. + + + The string that specifies the tag name. + + + + Gets the at the specified index. + + The zero-based index of the style to get + The at the specified index + The index is not valid index in the + + + + Gets or sets a value indicating whether the stylesheet has style at 13th index + + True, if the stylesheet has style at 13th index(other than empty style), otherwise false + Reserved styles are applicable only for *.doc format + + + + Gets or sets a value indicating whether the stylesheet has style at 14th index + + True, if the stylesheet has style at 14th index(other than empty style), otherwise false + Reserved styles are applicable only for *.doc format + + + + Gets or sets the name of the style at 13th index in the stylesheet + + The string that represents the name of the style. + Reserved styles are applicable only for *.doc format + + + + Gets or sets the name of the style at 14th index in the stylesheet + + The string that represents the name of the style. + Reserved styles are applicable only for *.doc format + + + + Initializes a new instance of the class. + + The doc. + + + + Adds the List Override Style to collection. + + + + + + + Finds Style by name + + + + + + + + + + + + + Gets name of xml tag + + + + + Compares the current list override style with the list override style collection + + The list override style to compare + + + + Gets the equivalent list override style from the list override style collection + + The list override style to compare + + + + Gets List level by index. + + + + + Represents the collection of list styles. + + + + + Initializes a new instance of the class. + + The doc. + + + + Adds the specified list style to the collection. + + The to be added to the collection. + The zero-based index of the added style. + + + + Finds the list style with the specified name from the collection. + + The string that specifies the name of the list style to get from the collection. + The with the specified name. + + + + Creates the item. + + + The reader. + + + + + Gets name of xml tag + + + + + + Remove this style from the Word document. + + + + + + Insert the style to the collection in a particular index. + + Index to insert style + Style to insert + + + + Compares current list style with list style collection + + + + + Gets the equivalent list style from list style collection + + + + + Compares current list style ListID with list style collection ListID + + + True if the listStyle and the liststyles in the document collection has same ListID + + + + Gets the at the specified index. Read-only. + + The zero-based index of the list style to get from the collection. + The at the specified index. + + + + Represents the collection of . + + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + Initializes a new instance of the class with + the owner instance. + + The owner. + + + + Initializes a new instance of the class with + the instance. + + The owner. + + + + Moves paragraph items from the source collection to the destination collection. + + The destination collection where the items will be moved. + A flag indicating whether the last inline content control should be removed. + + + + Clones the items to new collection. + + The items. + + + + Unsafe method for removes item at index. + + The index. + + + + Unsafe method for adds the item. + + The item. + + + + Occurs when entity is inserted. + + + The zero-based index to insert the entity. + The to insert. + + + + Occurs when entity is removed. + + + The zero-based index to remove the entity. + + + + Occurs when all items are removed. + + + + + + Closes this instance. + + + + + Creates new item. + + + The object. + The instance. + + + + Returns the name of xml tag. + + + The string that represents the xml tag name. + + + + Get Current widget + + + + + + + Gets the minimum and maximum word width of current paragraph + + Represents minimum word width in paragraph + Represents maximum word width in paragraph + + + + Measure the minimum and maximum word width + + + + + + + + + + + + + Checks whether if all characters in a text contains combination of japanese and cjk text + + + True if text contains other than japanese and cjk characters. Else False + + + + Updates the maximum and minimum word width of paragraph based on calculated width + + >Existing minimum word width in paragraph + Existing maximum word width in paragraph + Calculated width + + + + Gets the length of the text till the delimeter + + Represents the matches of position of delimeter + Represents the current searching word in paragraph + Represents whole paragraph text + Represents start index from where to read to get the next word + + + + Gets the at the specified index from the collection. Read-only. + + The zero-based index of the paragraph item to get from the collection. + The at the specified index. + + + + Gets the owner paragraph of this paragraph item. Read-only. + + + The owner paragraph. + + + + Gets the type of the elements present in the collection. + + + The collection that contains the types of the elements. + + + + Represents a collection of entities. + + + + + Initializes a new instance of the class. + + The doc. + The owner. + + + + Initializes a new instance of the class. + + + + + Clones the items to new collection. + + The items. + + + + Contains the text body items. + + + + + + Lasts the index of the paragraph item. + + + + + + Gets the items. + + The items. + + + + Represents the collection of in the Word document. + + + + + Accepts all the tracked changes in a document or range. The revision marks are removed, and the changes are incorporated into the document. + + + + //Load an existing Word document into DocIO instance. + WordDocument document = new WordDocument("Template.docx"); + //get all the revisions from the revision collection and accepts all. + document.Revisions.AcceptAll(); + //Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Load an existing Word document into DocIO instance. + Dim document As WordDocument = New WordDocument("Template.docx") + 'Get all the revision from the revision collection and accepts all. + document.Revisions.AcceptAll() + 'Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Rejects all the tracked changes in a range. The revision marks are removed, leaving the original text intact. + + + + //Load an existing Word document into DocIO instance. + WordDocument document = new WordDocument("Template.docx"); + //get all the revisions from the revision collection and reject all. + document.Revisions.RejectAll(); + //Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Load an existing Word document into DocIO instance. + Dim document As WordDocument = New WordDocument("Template.docx") + 'Get all the revisions from the revision collection and reject all. + document.Revisions.RejectAll() + 'Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Adds the specified revision into the collection. + + The revision. + + + + Removes the specified revision from the collection. + + The revision. + + + + Clones the revisions to new collection. + + The new revision collection + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + Clears the object. + + + + + Gets the at the specified index. + + The integer that represents the position of the revision in the document to get. + The at the specified index. + The index is not valid in the + + + //Loads an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Gets the revision from the revision collections + Revision revision = document.Revisions[0]; + //If the revision is formatting type of revision, then accept it + if (revision.RevisionType == RevisionType.Formatting) + revision.Accept(); + //Saves and closes the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Loads an existing Word document + Dim document As WordDocument = New WordDocument("Template.docx") + 'Gets the revision from the revision collections + Dim rev As Revision = document.Revisions(0) + 'If the revision is formatting type of revision, then accept it + If rev.RevisionType Is RevisionType.Formatting Then rev.Accept() + 'Saves and closes the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Represents the collection of text for each shape object (textbox, rectangle, etc.). + + + + + + + + + + Initializes a new instance of the class. + + + + + Add the specified text box to text collection of shape object with the specified shape Id. + + The integer that specifie the shape Id. + The text box to be added to the collection. + + + + Returns the textbox with the specified shape Id. + + The integer that specifies the shape Id. + + + + + Closes this instance. + + + + + Represents a collection of in the paragraph. + + + The following code illustrates the how to add and remove tabs from the . + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add tab at position 0; + paragraph.ParagraphFormat.Tabs.AddTab(); + //Add tab stop at position 11 + Tab firstTab = paragraph.ParagraphFormat.Tabs.AddTab(11); + //Add tab stop at position 62, with tab justification and tab leader. + paragraph.ParagraphFormat.Tabs.AddTab(62, TabJustification.Left, TabLeader.Single); + paragraph.AppendText("This sample\t illustrates the use of tabs in the paragraph. Tabs\t can be inserted or removed from the paragraph."); + //Remove tab stop from the collection + paragraph.ParagraphFormat.Tabs.RemoveByTabPosition(11); + //Remove tab at index 0; + paragraph.ParagraphFormat.Tabs.RemoveAt(0); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add tab at position 0; + paragraph.ParagraphFormat.Tabs.AddTab() + 'Add tab stop at position 11 + Dim firstTab As Tab = paragraph.ParagraphFormat.Tabs.AddTab(11) + 'Add tab stop at position 62, with tab justification and tab leader. + paragraph.ParagraphFormat.Tabs.AddTab(62, TabJustification.Left, TabLeader.[Single]) + paragraph.AppendText("This sample" & vbTab & " illustrates the use of tabs in the paragraph. Tabs" & vbTab & " can be inserted or removed from the paragraph.") + 'Remove tab stop from the collection + paragraph.ParagraphFormat.Tabs.RemoveByTabPosition(11) + 'Remove tab at index 0; + paragraph.ParagraphFormat.Tabs.RemoveAt(0) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Initializes a new instance of the class. + + + + + + + + + + + + Adds a new tab at the position 0. + + The newly added object. + + + + Adds the tab at the specified position with the tab justification and tab leader. + + The position of the tab. + The type of tab justification. + The type of tab leader. + The newly added object. + + + + Adds the tab at the specified position. + + The position of the tab. + The newly added object. + + + + Removes all the tabs from the tab collection. + + + + + Removes the tab at the specified index from the tab collection. + + The zero-based index of the tab to be removed. + The index is not valid in the . + + + + Removes the tab present at the specified position from the tab collection. + + The position of the tab to be removed. + + + + Adds the tab. + + The tab. + + + + Creates the item. + + + The object. + The object. + + + + Returns the name of xml tag. + + + The string that specifies the tag name. + + + + + + + + + Clones Tab Collection. + + + + + Compare Tabs + + + + + Updates the tabs in source formatting + + + + + Updates the tabs in source formatting + + + + + Gets the given tab position is available in the current Tabs collection + + + + + + + Sorts the tab position of the current Tabs collection + + + + + + + Gets the at the specified index. Read-only. + + The zero-based index of the tab. + The instance. + The index is not valid in the . + + + + Gets or sets a value indicating whether to cancel OnChange event. + + + If it specifies to cancel on change event, set to true. + + + + + Represents the collection of in the Word document. + + + + + + + + + + Removes a at the specified index. + + The zero-based index of the to remove. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //open a template document + WordDocument document = new WordDocument("Textbox.docx"); + //Remove the textbox at index one. + document.TextBoxes.RemoveAt(1); + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'open a template document + Dim document As New WordDocument("Textbox.docx") + 'Remove the textbox at index one. + document.TextBoxes.RemoveAt(1) + 'Save and close the document + document.Save("Sample.docx") + document.Close() + End Sub + + + + + + Removes all the textboxes from the document. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //open a template document + WordDocument document = new WordDocument("Textbox.docx"); + //Removes the textboxes from the document + document.TextBoxes.Clear(); + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'open a template document + Dim document As New WordDocument("Textbox.docx") + 'Removes the textboxes from the document + document.TextBoxes.Clear() + 'Save and close the document + document.Save("Sample.docx") + document.Close() + End Sub + + + + + + Adds the specified textbox. + + The textbox. + + + + Removes the specified textbox. + + The textbox. + + + + Gets the at the specified index from the . + + The zero-based index to get the . + The at the specified index. + The index is not valid in the . + + + + Represents a collection of in the . + + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section + IWSection section = document.AddSection(); + //Add new paragraph + section.AddParagraph().AppendText("Price Details"); + section.AddParagraph(); + //Add a new table into Word document + IWTable table = section.AddTable(); + //Add the first row into table + WTableRow row = table.AddRow(); + //Create a new cell + WTableCell cell = new WTableCell(document); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("Item"); + //Add the cell to the cells collection. + row.Cells.Add(cell); + int index = row.Cells.IndexOf(cell); + //Create a new cell + cell = new WTableCell(document); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("Price($)"); + //Add the cell to the cells collection. + row.Cells.Insert(index + 1, cell); + //Add the second row into table + row = table.AddRow(true, false); + //Add the first cell into second row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("Apple"); + //Add the second cell into second row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("50"); + //Add the third row into table + row = table.AddRow(true, false); + //Add the first cell into third row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("Orange"); + //Add the second cell into third row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("30"); + //Add the third cell into third row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("Banana"); + //Removes the specified cell. + row.Cells.Remove(cell); + //Save and close the document + document.Save("Table.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section + Dim section As IWSection = document.AddSection() + 'Add new paragraph + section.AddParagraph().AppendText("Price Details") + section.AddParagraph() + 'Add a new table into Word document + Dim table As IWTable = section.AddTable() + 'Add the first row into table + Dim row As WTableRow = table.AddRow() + 'Create a new cell + Dim cell As New WTableCell(document) + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("Item") + 'Add the cell to the cells collection. + row.Cells.Add(cell) + Dim index As Integer = row.Cells.IndexOf(cell) + 'Create a new cell + cell = New WTableCell(document) + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("Price($)") + 'Add the cell to the cells collection. + row.Cells.Insert(index + 1, cell) + 'Add the second row into table + row = table.AddRow(True, False) + 'Add the first cell into second row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("Apple") + 'Add the second cell into second row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("50") + 'Add the third row into table + row = table.AddRow(True, False) + 'Add the first cell into third row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("Orange") + 'Add the second cell into third row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("30") + 'Add the third cell into third row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("Banana") + 'Removes the specified cell. + row.Cells.Remove(cell) + 'Save and close the document + document.Save("Table.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Initializes a new instance of the class with the specified + instance. + + The to has this cell collection. + + + + Adds the specified to the . + + The to be added. + The zero-based index of the cell. + The number of cells must be between 1 and 63. + + + + Removes all the items from the collection. + + + + + + Inserts a specified at the specified index in collection. + + The zero-based index to insert the cell. + The to be inserted. + + + + Returns the index of a specified in the collection. + + The to find the index. + The zero-based index of the specified cell. + + + + Removes the specified from the collection. + + The to be removed from the collection. + + + + Removes the at the specified index from the collection. + + The zero-based index of the cell. + + + + Removes the cell bookmark. + + The cell. + + + + Moves the bookmark start from the current cell to next cell. + + + + + + Moves the bookmark end from the current cell to previous cell. + + + + + + Returns the name of the xml tag. + + + The string that specifies the tag name. + + + + Creates a new cell. + + + The instance. + The instance. + + + + Clones all cells to destination collection. + + The destination collection. + + + + Called when cell inserted to cell collection. + + The index. + The cell format. + + + + Called when cell removed from cell collection. + + The index. + + + + Reduce the GridColumnStartIndex for cells present after the removed cell. + + Index of inserted cell + + + + Increase the GridColumnStartIndex for cells present after the new inserted cell. + + + + + + Gets the at the specified index. + + The zero-based index of the to get. + The at the specified index. + The index is not valid in the . + + + + Gets the type of the elements present in the collection. + + + The collection that contains the types of the elements. + + + + Represent a collection of objects. + + + + + Initializes a new instance of the class. + + The doc. + + + + Adds the item. + + The text. + + + + + Removes DropDownItems by index. + + The index. + + + + Clears this instance. + + + + + Adds the item. + + + + + + Clones items to. + + The destination collection. + + + + Creates the item. + + + The reader. + + + + + Gets name of xml tag + + + + + + + Closes this instance. + + + + + Gets the at the specified index. + + + + + + Represents a collection of objects. + + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument("Template.docx"); + //Find the specified text from the document + TextSelection selection = document.Find("paragraph", false, false); + WTextRange range = selection.GetAsOneRange(); + //Get its owner paragraph + WParagraph paragraph = range.OwnerParagraph; + WTextBody textbody = paragraph.OwnerTextBody; + //Get the collection of paragraphs in the section + WParagraphCollection collection = (WParagraphCollection)textbody.Paragraphs; + //Get the index of the paragraph + int index = collection.IndexOf(range.OwnerParagraph); + paragraph = new WParagraph(document); + paragraph.AppendText("hello world"); + //Insert new item + collection.Insert(index + 1, paragraph); + //Removes paragraph at index zero + collection.RemoveAt(0); + //Save and close the paragraph. + document.Save("Result.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument("Template.docx") + 'Find the specified text from the document + Dim selection As TextSelection = document.Find("paragraph", False, False) + Dim range As WTextRange = selection.GetAsOneRange() + 'Get its owner paragraph + Dim paragraph As WParagraph = range.OwnerParagraph + Dim textbody As WTextBody = paragraph.OwnerTextBody + 'Get the collection of paragraphs in the section + Dim collection As WParagraphCollection = DirectCast(textbody.Paragraphs, WParagraphCollection) + 'Get the index of the paragraph + Dim index As Integer = collection.IndexOf(range.OwnerParagraph) + paragraph = New WParagraph(document) + paragraph.AppendText("hello world") + 'Insert new item + collection.Insert(index - 1, paragraph) + 'Removes paragraph at index zero + collection.RemoveAt(0) + 'Save and close the paragraph. + document.Save("Result.docx") + document.Close() + End Sub + + + + + + Represents a collection of . + + + + + Adds a paragraph to the end of collection. + + The paragraph. + + + + + Inserts a paragraph into collection at the specified index. + + The index. + The paragraph. + + + + Returns the zero-based index of the specified paragraph. + + The paragraph. + + + + + Removes the paragraph at the specified index from the collection. + + The index. + + + + Gets the at the specified index. + + + + + + Initializes a new instance of the class with the specified + collection of text body items. + + The collection of text body items. + + + + Adds a paragraph to the collection. + + The paragraph to be added. + The zero-based index of the added paragraph. + + + + Determines whether the contains a specified paragraph. + + The paragraph to be found. + True if paragraph is found; otherwise, false. + + + + Inserts the specified paragraph into collection at the specified index. + + The integer that specifies the index. + The paragraph to be inserted. + + + + Returns the zero-based index of the specified paragraph. + + The paragraph to which the index to be found. + The zero-based index of the paragraph. + + + + Removes the specified paragraph from the collection. + + The paragraph to be removed from the collection. + + + + Removes the paragraph at the specified index from the collection. + + The index of the paragraph to be removed. + + + + Gets the at the specified index. + + The zero-based index of the paragraph to get from the collection. + The instance. + The index is not valid in the . + + + + Gets the owner of the collection. + + The owner text body. + + + + Represents a collection of objects. + + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + section.AddParagraph().AppendText("Price Details"); + section.AddParagraph(); + //Add a new table into Word document + IWTable table = section.AddTable(); + //Get the rows collection from table + WRowCollection rowCollection = table.Rows; + //Add the first row into table + WTableRow row = new WTableRow(document); + //Add the first cell into first row + WTableCell cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("Item"); + //Add the second cell into first row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("Price($)"); + //Add row to the collection + rowCollection.Add(row); + //Add the second row into table + row = new WTableRow(document); + //Add the first cell into second row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("Apple"); + //Add the second cell into second row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("50"); + //Insert row at index 1 + rowCollection.Insert(1, row); + //Add the third row into table + row = new WTableRow(document); + //Add the first cell into third row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("Orange"); + //Add the second cell into third row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("30"); + //Insert row + rowCollection.Insert(2, row); + //Remove row at index 0. + rowCollection.RemoveAt(0); + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + section.AddParagraph().AppendText("Price Details") + section.AddParagraph() + 'Add a new table into Word document + Dim table As IWTable = section.AddTable() + 'Get the rows collection from table + Dim rowCollection As WRowCollection = table.Rows + 'Add the first row into table + Dim row As New WTableRow(document) + 'Add the first cell into first row + Dim cell As WTableCell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("Item") + 'Add the second cell into first row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("Price($)") + 'Add row to the collection + rowCollection.Add(row) + 'Add the second row into table + row = New WTableRow(document) + 'Add the first cell into second row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("Apple") + 'Add the second cell into second row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("50") + 'Insert row at index 1 + rowCollection.Insert(1, row) + 'Add the third row into table + row = New WTableRow(document) + 'Add the first cell into third row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("Orange") + 'Add the second cell into third row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("30") + 'Insert row + rowCollection.Insert(2, row) + 'Remove row at index 0. + rowCollection.RemoveAt(0) + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + Adds the specified table row to the collection. + + The row. + + + + + Inserts the specified table row at the specified index in the collection. + + The index. + The row. + + + + Returns the index of the specified row in the collection. + + The row. + + + + + Removes the specified row from the collection. + + The row. + + + + Gets the name of xml tag. + + + The string that specifies the tag name. + + + + Creates new item. + + + The instance. + The instance. + + + + Gets the table row at the specified index. + + The zero-based index of the row to get from the collection. + The at the specified index. + The index is not valid in the . + + + + Gets the type of the elements present in the collection. + + + The collection that contains the types of the elements. + + + + Represents a collection of . + + + + + Represents a collection of . + + + + + Adds a new to end of document. + + The to be added to the collection. + The zero-based index of the + + + + Returns the zero-based index of the specified section. + + The object. + The zero-based index of the first occurrence of item + + + + Gets the at the specified index. + + The zero-based index of the section to get + The at the specified index + The index is not valid index in the + + + + Initializes a new instance of the class. + + The instance. + + + + Initializes a new instance of the class. + + + + + Adds a new to end of document. + + The to be added to the collection. + The zero-based index of the + + + + Returns the zero-based index of the specified section. + + The object. + The zero-based index of the first occurrence of item + + + + Gets the text. + + + + + + Creates the item. + + + The object. + The object which can be casted as . + + + + Gets name of xml tag + + + The string that represents the section tag name. + + + + Gets the at the specified index. + + The zero-based index of the section to get + The at the specified index + The index is not valid index in the + + + + Gets the type of the elements present in the collection. + + + The collection that contains the types of the elements. + + + + Represents a collection of objects. + + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx"); + //Get the tables collection + WTableCollection tablecollection = document.Sections[0].Tables as WTableCollection; + //Create new table + WTable table = new WTable(document); + table.ResetCells(2,2); + //Add table to the collection + tablecollection.Add(table); + //Get the index of the added table + int index = tablecollection.IndexOf(table); + //Insert another table at next index + table = new WTable(document); + table.ResetCells(3, 3); + tablecollection.Insert(index + 1, table); + //Remove the table at index 0 + tablecollection.RemoveAt(0); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx") + 'Get the tables collection + Dim tablecollection As WTableCollection = TryCast(document.Sections(0).Tables, WTableCollection) + 'Create new table + Dim table As New WTable(document) + table.ResetCells(2, 2) + 'Add table to the collection + tablecollection.Add(table) + 'Get the index of the added table + Dim index As Integer = tablecollection.IndexOf(table) + 'Insert another table at next index + table = New WTable(document) + table.ResetCells(3, 3) + tablecollection.Insert(index + 1, table) + 'Remove the table at index 0 + tablecollection.RemoveAt(0) + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Represents a collection of . + + + + + Adds a table to end of text body. + + The object to be added. + The zero-based index of the table. + + + + Returns the index of a table in the collection. + + The to which the index to be find. + The zero-based index of the table. + + + + Determines whether the contains a specific table. + + The object to be found. + True if table is found, otherwise false. + + + + Gets the at the specified index. + + + + + + Initializes a new instance of the class with the specified + instance. + + The collection of body items. + + + + Adds the specified table to the end of text body. + + The to be added. + The zero-based index of the table. + + + + Determines whether the contains the specified table. + + The object to be found. + True if table is found, otherwise false. + + + + Returns the index of the specified table in the collection. + + The to which the index to be found. + The zero-based index of the table. + + + + Inserts the specified table into collection at the specified index. + + The zero-based index for the table to insert. + The to be inserted. + The zero-based index of the item inserted. + The index is not valid within the . + + + + Removes the specified table from the collection. + + The to be removed from the collection. + + + + Removes the table at the specified index from the collection. + + The zero-based index of the table to be removed. + The index is not valid within the + + + + Gets the at the specified index. + + The zero-based index to get the table. + The at the specified index. + The index is not valid in the . + + + + Gets the owner of the collection. + + + + + Initializes a new instance of the class. + + + + + + Adds the columns in the collection + + + + + + Adds the columns in the collection + + + + + + + True if the GridAfter value is greater than 0; else false + + + + Updates the preferred width for each columns in a table grid. + + + + + + Gets the previous column width. + + + + + + + + Returns the index of the specified column. + + + + + + + Returns the index of the specified offset value. + + + + + + + Determines whether an coulmn is in the collection. + + + + + + + Inserts a coulmn into the collection at the specified index. + + + + + + + Removes the coulmn from the collection. + + + + + + Resets the table columns. + + + + + Creates a duplicate copy of the table column. + + + + + + Auto Fits the columns. + + + + + + + + Gets the total width. + + The width type to sum. + + + + + Returns a value that indicates whether the specified value is not a number () or it evaluates to negative or positive infinity. + + A float-precision floating-point number. + true if evaluates to or d evaluates to or . + + + + Update grid column widths based for fixed layout. + + + + + + + + Checks whether to resize the column based on the cell maximum preferred width and maximum word width. + + The table. + The table columns. + The table owner width. + The column width list. + True if the column resize based on maximum word width else False. + + + + Checks whether table exceeds table width and resizes columns based on preferred width and maximum word width. + + The Nested table. + Nested Tablegrid columns. + The maximum cell count + The Owner Width. + The total Column width. + The list containing calculated column width. + True when column width is calculated on basis of preferred width and maximum word width. Else False. + + + + Calculate the width for each columns based on the cell maximum preferred width and maximum word width. + + Total column width. + The table columns. + The maximum cell preferred width list. + + + + + Recalculate percentage table column widths. + + Current table + Current table columns + Sum of maximum word width of table + Current table width + + + + Checks whether grid corrupted point width type table exceeds the table width. + + + + + + + + + + + + + Checks whether Preferred width is lesser than Maximum Word Width and calculates cell width based on cell maximum word width + + Current Table + Table columns(grid) + Table Width + List containing calculated column width + + + + + Gets columns based on preferred width and maximum word width + + Tablegrid columns + Sum of maximum word width greater than preferred width + Sum of preferred width used cells + List containing index of preferred width based columns + List containing calculated column width + + + + Checks whether any cell has disabled TextWrap and calculates cell width based on cell maximum para width + + Current table + Table columns(grid) + Table width + List containing calculated column width + + + + + Resize the point width table to its table width based in maximum word width and maximum cell preferred width of columns. + + The table columns + Maximum cell preferred width of columns + Sum of maximum word width + Table width + Sum of maximum cell preferred width of columns + + + + Checks the whether the table width is point and is need to resize columns based on maximum word width and cell preferred width + + Current table + Current table columns + Client width of table + Maximum cell count of a table + True, if the table width is point and is need to resize columns based on maximum word width and cell preferred width, else false + + + + Resize the table columns based on table cell preferred width and maximum word width which exceed client width + + + + + + + + + Checks whether the table with percentage width type uses the maximum word width as column width. + + Current table + Table columns(grid) + Table client width + + + + + Check whether the point width table need to be resized according to the cell preferred width + + Current table + Maximum cell count in the table + Table columns + List containing calculated column width + Total cell preferred width + Table width + True, if the point width table is need to resized according to the calculated column width + + + + Check whether the calculated column width is enough to fit the table width. + + + + + + + + + + + + Checks whether the table needs to resize as per maximum word width + of the table even though if table exceeds the table width + + Current table + Table columns + Table client width + True, if the table needs to resize as per maximum word width + of the table even though if table exceeds the table width else false + + + + Check whether the auto table need to resize as per percentage cell preferred width + + Current Table + Row index containing the preferred cell width as percentage + Table columns + Table owner width + True, if the table needs to resize as per percentage cell preferred width; else, false + + + + Check whether the table has any row containing all cell preferred width type as percentage + + Current table + Table columns + Table owner width + List of rows containing all cell preferred width type as percentage + + + + Resize the column based on the percentage cell preferred width + + Table columns + Row index containing percentage preferred width for all cells + Current table + Table owner width + + + + Check whether the table need to be resized according to the cell preferred width + + Current table + Table columns + Table owner width + Total cell preferred width + List containing calculated column width + Maximum cell count in the table + True, if table is need to resized according to the calculated column width + + + + Check whether the max word width is greater than the cell preferred width in the list + + Table columns + List containing max cell preferred width of each column + Total cell preferred width + Table owner width + True, if the max word width less than calculated column width; else, false + + + + Resize the table according to the calculated column width + + Table columns + List containing calculated column width + + + + Check whether the auto width type table need to resize based on maximum para width + + Current table + Table columns + Table owner width + Total table column width + True, if the auto width table columns need to resize based on maximum para width else false + + + + Set the column preferred width with maximum para width + + Table columns + + + + + Checks whether the column maximum para width exceeds preferred width + + Table owner width + Table columns + True if the column preferred width is lesser than MaximumParaWidth else false + + + + Checks whether the column maximum para width is zero + + + + + Change the column preferred width based on maximum para width + + table columns + Total max para width + Table owner width + + + + + Changes the column preferred width with maximum word width + + table columns + + + + Checks whether the nested table need to recalculate or not + + The nested table + Then nested table columns + The nested table client width + The total column width of the nested table. + The nested table width. + + + + Checks whether the nested table is shrink to fit the client's width. + + The nested table to be checked. + The owner table of the nested table. + The total column width of the nested table. + The width of the owner cell. + True if the nested table is shrink to fit the client's width; otherwise, false. + + + + Checks whether the nested table uses the maximum word width as column width. + + Current table + Current table columns + Current table client width + Owner table of current table + True, if nested percentage table uses maximum word width else false. + + + + Checks whether the columns has enough width to store maximum word width + + Current table columns + True, if column not has enough width to store maximum word width else false. + + + + Check the whether table width is auto and it uses the cell preferred width. + + + + + + + + + + + + Checks whether calculatedWidth list value enough to store maximum word width. + + + + + + + + Get a list containing maximum preferred width or cell format cell width + + Current table + Maximum cell count + Total maximum cell preferred width + List of maximum preferred width for each column + + + + Check whether the auto table uses its nested table width + + Current table + Table columns + Maximum cell count + True, if the auto table uses its nested table width; else, false + + + + Check whether the table should use the cell preferred width + + Outermost table + Table columns + Maximum cell count + True, if the table should use the cell preferred width; else, false + + + + Check whether the nested table should use owner width + + Current table + Table columns + Maximum cell count + True, if the nested table should use owner width; else, false + + + + Check whether the owner table contains left or right paddings + + Owner cell + True, if the owner table has left or right paddings greater than 0; else false + + + + Check whether the rows in the list have same preferred width for all cells + + List containing row index + Current table + True, if all the rows in the list contains same preferred width values for all cells; else, false + + + + + Expand the columns based on maximum para width + + Table columns + + + + + + + Checks whether all column preferred width is equal. + + The table columns + True if all column preferred width equal else false + + + + + Checks whether the table created through HTML document need to resize the column size + + Table + Table columns + Table owner width + Sum of columns maximum word width + Remaining space to expand + + + + + Checks whether setting spacings, paddings and border line width inside column, doesn't exceed the preferred table width + + + + + Expand the columns based on factor of maximum Word width + + + + + Gets the cell width. + + + + + + + + Updates the end offset of the each column based on the calculated width. + + + + + Validate and update the preferredwidth of the cells for column spanned cells. + + + + + Checks whether to resize the column based on the cell maximum para width + + + + + Updated the column prefered width based on maximum para width and remaining table width + + + + + Gets the Document instance + + + + + Gets the WTableColumn based on its index value + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Clones the current column. + + + + + + Releases all managed and unmanaged resources. + + + + + Gets or Sets the preferred width of the column. + + + + + Gets or Sets the end offset of the column. + + + + + Gets or Sets the minimum word width of the column. + + + + + Gets or Sets the minimum word width of the column. + + + + + Gets or Sets the minimum width of the column. + + + + + A flag which denotes whether column have maximum word width from any cell. + + + + + Gets or Sets the Maximum Paragraph width of the column. + + + + + Gets or Sets the TextWrapDisAbledCell Maximum Paragraph width of the column. + + + + + Gets or sets the column has minimum width or not + + + + + Gets or sets the column has minimum or maximum word width or not + + + + + Gets or sets the column has maximum word width or not + + + + + Gets or Sets the minimum word width of the column. + + + + + Gets or Sets the minimum word width of the column. + + + + + Gets or Sets the minimum width of the column. + + + + + Gets or Sets the Maximum Paragraph width of the column. + + + + + Gets or Sets the Maximum Paragraph width of the textWrap disabled cell. + + + + + Represents a collection of objects. + + + + + Represents a collection of . + + + + + Adds a textbox to the collection. + + The text box. + + + + + Gets the at the specified index. + + + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + Adds the specified textbox to the collection. + + The text box to be added. + The zero-based index of the text box. + + + + Creates a new item. + + + The object. + The object. + + + + Gets the name of xml tag. + + + The string that specifies the tag name. + + + + Gets the at the specified index. Read-only. + + The zero-based index of the text box to get from the collection. + The text box at the specified index. + The index is not valid in the . + + + + Gets the type of the elements present in the collection. + + + The collection that contains the types of the elements. + + + + + + + + + + + + + + + + + + + + + + + + Collection of main textboxes + + + + + Collection of header/footer textboxes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Field stack. + + + + + Stores bookmark offsets for each comment + + + + + + + + + + + + + + + By means of WordWriter writes WordDocument to doc + + The writer. + The document. + + + + Must be called before doc building + + + + + + + + + + + + + + + + + + + + Writes the Footnote/Endnote separator stories. + + + + + Writes the separator story body items + + The section. + + + + Inserts the watermark. + + The paragraphs. + Type of the header. + + + + Returns First Paragraph in the given text body + + + + + + + Gets the first TBL paragraph. + + The table. + + + + + Write textbox body to document + + Collection of document's textboxes + Textbox type ( main or header/footer) + + + + + + + + + + + Writes the footnotes body. + + + + + Writes the annotations body. + + + + + Writes the endnotes body. + + + + + Write textbody for header/footer and main textboxes + + + + + Writes header/footer to wordwriter + + + + + + + + Writes the sub document text. + + The writer. + The body. + + + + + + + + + + + Writes the SDT block. + + The SDT block. + if set to true [is table body]. + + + + + Checks the next item in table. + + if it is table body, set to true. + The paragraphs. + Index of the item. + + + + + + + + + + + Serialize special characters for bidirectional override. + + + + + + + Writes the list pictures. + + The paragraph. + The item. + + + + Writes the paragraph item. + + The paragraph item. + The paragraph. + + + + + + + + + Write Absolute tab + + + + + Write empty paragraphs (needed for watermark). + + + + + Writes the text. + + The text. + + + + Writes the text chunks. + + The text. + if it is a safe text, set to true. + + + + Begin the field writting. + + + + + + + + + + + Writes the form field. + + The field. + + + + Builds WordWriter doc from WordDocument + + + + + Update the table borders for HTML input document table. + + The current table + + + + Update the table borders for HTML input document table. + + The table border + + + + Sets the table cell mark + + + + + + + Writes the table props. + + The writer. + The row. + The table. + + + + Builds WordWriter doc from WordDocument + + + + + + + + + + + + + + Writes the embed body. + + The text. + The shape id. + + + + + + + + + + + + Checks whether the picture is in shape field. + + The picture. + + + + + Convert the Picture into InLineShape + + + + + + + + + + + + + + + + + + + Builds WordWriter doc from WordDocument + + + + + Builds WordWriter doc from WordDocument + + + + + Builds WordWriter doc from WordDocument + + + + + Writes the break. + + The doc break. + The paragraph. + + + + + + + + + + Write textbox item to document; + + + + + + Prepares the text box collection. + + The text box item. + + + + Checks the shape for cloning. Clones shape container if escher doesn't + have container for current shape item. + + The shape item. + + + + Writes the field mark and field text. + + The field mark. + + + + Writes the field separator. + + + + + Writes the field end. + + + + + Writes the comment. + + The comment. + + + + Writes the footnote. + + The footnote. + + + + + + + + + + + + + + + + Writes the Field Without Field separator for TC Entry,TOA entry,Private,Index Entry and RefDoc + + The field code. + + + + Writes the comment mark. + + The comment mark. + + + + Writes the OLE object. + + The OLE object. + + + + Adds the list pictures. + + + + + Addings the pictures to ListPictures. + + The list format. + + + + + + + + + + Writes style of paragraph to WordWriter + + + + + + + + + + + + + Updates the default format. + + + + + Writes the document properties. + + + + + Writes the document default fonts. + + + + + Write background effect to document. + + + + + Writes the picture background. + + The back container. + The old back container. + The background. + The escher. + + + + Noes the background. + + + + + + Writes the commented items. + + The comment. + + + + Counts the comment offset. + + The comment. + + + + + + + + + Gets character style index by character style name. + + Name of the char style. + + + + + Writes the page break after. + + The current paragraph. + The break type. + + + + Determines whether the page break need to be skipped based on given entity owner. + + Entity + true, if present inside TextBox/FootNote/EndNote/Header/Footer + + + + Writes the list properties. + + The list format. + The writer. + + + + Processes the empty list. + + The list format. + The writer. + + + + Processes the list. + + The list format. + The writer. + + + + Removes the list Single Property Modifier Record Array. + + + + + Writes the empty list. + + + + + + + + + + + + + + + + + + + + + Set sprmPIlfo value in collection of word styles + + Index of the list format. + The list level number. + The writer. + + + + Get list format from ListStyleCollection by lisStyleName. + + ListStyleName + StyleSheet + List format + + + + Updates the list in style. + + The writer. + The style. + + + + Resets the lists. + + + + + + + + + + + + + + + Gets the list picture. + + The list picture. + + + + Gets the last paragraph of the document + + The last paragraph. + + + + Gets the comment collection. + + The comment collection. + + + + Gets the footnote collection. + + The footnote collection. + + + + Gets the endnote collection. + + The endnote collection. + + + + Gets the header/footer text box collection. + + The HF text box collection. + + + + Gets the text box collection. + + The text box collection. + + + + Gets the comment offsets. + + The comment offsets. + + + + Represents a utility class for comparing two Word documents. + + + + + Initializes a new instance of the class. + + The doc. + + + + Convert the image bytes as hash string + + + + + + + Convert image bytes as Hash + + + + + Compare images between two documents and maintain matched and umatched information + + + + + Converts stream to bytes + + + + + + + Compare streams and return true if they are same. + + + + + + + + Compare two bytes and return true if they are same. + + + + + Gets the string of the Word document + + word document + + + + + Add all items in the Word document to respective collections + + Word document + + + + Add all items in the text body to respective collections + + text body + + As per MS Word behavior, items in paragraph not compare with items inside table. + So, when maintain collection of items (like chart, field etc.,), it doesn't traverse into nested body (table, textbox, shape, comment and other) + + + + + Iterates the paragraph and adds the Inline content control in the InlineContentControl collection + + + + + + Travese till the field end + + + + + + + After comparing the document, remove the items from the collection. + + + + + + Insert the unmatched items from the revised document to the original document + + + + + + + + + + + + + + Check whether there is no renderable items before bookmark end in the paragraph + + + + + + True if there is no renderable items before the bookmark end, else false + + + + Check whether the items before the index are renderable item + + + + + + + + Add BlockContentControl to the document part start and end + + + + + + + + Insert a section to the original document. + + + + + + + + + + Apply insertion revision for the body item between the start index to the end index + + + + + + + + Apply delete revision for unmatched items before the matched index + + + + + + + + Checks whether all the paragraph items in a paragraph before the specified position are deleted or not. + + The original document paragraph. + The index of the current paragraph item in the original document paragraph. + Returns true if any paragraph item before the specified position is not deleted; otherwise, returns false. + + + + Apply delete revision for the first section + + + + + + + + + + + + + + Apply delete revision for the body item between the start index to the end index + + + + + + + + Move the current position to the next body item + + + + + + + + + + Delete the unmatched items in the original document. + The items before the matched table. + + Original document instance + Matched table + + + + Dispose the collection + + + + + Gets the images. + + The images. + + + + Gets the images. + + The images. + + + + Maintain collection of Block content controls in body. + When iterating section, it maintain items of section.body alone and not nested body + + + + + Maintain collection of Inline content controls in body. + When iterating section, it maintain items of section.body alone and not nested body + + + + + Maintain collection of Shapes in body. + When iterating section, it maintain items of section.body alone and not nested body + + + + + Maintain collection of group shapes in body. + When iterating section, it maintain items of section.body alone and not nested body + + + + + Maintain collection of pictures in body. + When iterating section, it maintain items of section.body alone and not nested body + + + + + Maintain collection of text box in body. + When iterating section, it maintain items of section.body alone and not nested body + + + + + Maintain collection of chart in body. + When iterating section, it maintain items of section.body alone and not nested body + + + + + Maintain collection of fields in body. + When iterating section, it maintain items of section.body alone and not nested body + + + + + Maintain collection of mathML in body. + When iterating section, it maintain items of section.body alone and not nested body + + + + + Maintain collection of OLE object in body. + When iterating section, it maintain items of section.body alone and not nested body + + + + + Maintain collection of table of contents in body. + When iterating section, it maintain items of section.body alone and not nested body + + + + + Flag to indicate whether the image bytes of both documents are compared or not. + + + + + Maintain collection of chart in body. + When iterating section, it maintain items of section.body alone and not nested body + + + + + Maintain collection of revised document list styles. + + + + + Constants used for comparison. + + + + + Ascii character assigned for table + + + + + Ascii character assigned for row + + + + + Ascii character assigned for cell + + + + + Ascii character assigned for block content control + + + + + Ascii character assigned for inline content control + + + + + Ascii character assigned for picture + + + + + Ascii character assigned for shape + + + + + Ascii character assigned for picture + + + + + Ascii character assigned for Chart + + + + + Ascii character assigned for Symbol + + + + + Ascii character assigned for Break + + + + + Ascii character assigned for mathml + + + + + + + Represents the implementation for converting Word document to Word XML file. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Converts DLS XML to Word ML file. + + The to be converted to DLS XML file. + The string that specifies the path to Word ML. + + + + + + + + + + Corrects the defect in dls-xml. + + + + + Clones the sections. + + + + + Clones the section. + + The node. + The count. + The index. + + + + + Clones the paragraph. + + The node. + + + + + + + + + + + Clones the items. + + The node. + + + + + Clones the built-in properties. + + + + + Modifies the picture. + + The node. + + + + Reads the binary element. + + The node. + + + + + Reads the image. + + The node. + + + + + + + + + + + + + + + + + + + + + Gets or sets the name of the bookmark. + + A String that represents the name of the bookmark. + + + + Gets or sets the bookmark ID. + + A String that represents the ID of the bookmark. + + + + + + + + + + + + + + Adds new bookmark to the end of the . + + The to be added to the end of the . + + The index at which the has + been added. + + + + + Adds the new bookmark. + + A String that represents the name of the bookmark. + The integer that specifies the zero-based index of the newly added bookmark. + + + + Gets the ID of the specified bookmark by name. Read-only. + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The width. + + + + Gets or sets the width. + + The width. + + + + + + + + + Adds the specified grid. + + The grid. + + + + + Adds the specified width. + + The width. + + + + + Gets the min. + + The end. + + + + + Gets the collection count. + + The start. + The end. + + + + + + + + + + Adds the specified gridlist. + + The gridlist. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Parces the specified table. + + The table. + + + + Saves this instance. + + + + + Parces the table grid. + + + + + Adds the row. + + The row. + + + + + + + + + Instance members + + + + + + + + + + Defines if current collection contains style. + + The name. + + if it is a list name, set to true. + + + + + Closes this instance. + + + + + Gets AdapterListHelper object. + + + + + Get the collection of list styles and their id's. + + + + + Get the collection of list format override indexes and appropriate list format override styles. + + + + + Default key value for placeable header + + + + + Initialize the specified doc. + + The doc. + + + + Reads the text body. + + The reader. + The text body. + + + + Ends the of text body. + + The reader. + Type of the chunk. + + + + + Reads the chunk before. + + The reader. + + + + Reads the chunk. + + The reader. + The headerFooter. + + + + Read the custom footnote marker + + Current word reader + Splitted text length + Startting position of splitted text + + + + + + + + + + + + + + + + + + + + + + Reads the table before. + + The reader. + The prepare table info. + + + + Ensures the lower table. + + The level. + Type of the chunk. + + + + Ensures the upper table. + + The level. + Type of the chunk. + + + + Updates the GridAfter value for the each row in a table + + + + + + + Appends the table row. + + + + + Appends the table cell. + + + + + + Finalize current part of read process + + The reader. + + + + + + + + + + + + + + + + + + + + + Appends bookmark. + + Name of the bookmark. + if it is a bookmark start, set to true. + if it is a cell group BKMK, set to true. + + + + Reads the text. + + The reader. + + + + Add the required text to in its owner paragraph + + Current word reader + Text need to be added + If the text need to be added from foot note splitted text, set to true otherwisefalse + + + + Adds the text range. + + The reader. + The text. + + + + Reads the paragraph end. + + The reader. + + + + Reads the symbol. + + The reader. + + + + Reads the current page number. + + The reader. + + + + + + + + + + Reads the table cell. + + The reader. + + + + Reads the table row. + + The reader. + + + + Updates the paddings value as Zero when the Paddings releated sprm not in the PAPX sprm list + + + + + + Determines whether to split adjacent table rows. + + The previous row SPRMS. + The current row SPRMS. + + true if split adjacent table rows; otherwise, false. + + + + + Compares the array. + + The buffer1. + The buffer2. + + + + + Reads the annotation. + + The reader. + + + + Reads the footnote. + + The reader. + + + + Reads the break. + + The reader. + Type of the break. + + + + Reads the document end. + + The reader. + + + + Reads the shape. + + The reader. + The headerFooter. + + + + + + + + + + Determines whether currently reading shape field result item. + + Field separator. + + + + + Read textbox. + + The reader. + The File Shape Address. + + + + Reads picture shape. + + + + + + + Read the image cropping positions + + + + + + + Get the picture crop values + + + + + + + Checks the text embed. + + The shape. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Implemented alternative method to improve the performance + + + + + + + + Reads inline images. + + + + + + Adds the Metafile header wherthe image is Wmf image + + + + + + Calculates the checksum value + + + + + + + + + + + + + + Adds the item. + + The item. + The para. + + + + + + + + + + Reads field separator. + + + + + + Reads field end. + + + + + + Updates the valid field type. + + + + + + + Inserts the start field. + + The reader. + + + + Read + + + + + + Reads list format. + + + + + + + + + + + + Reads the character format. + + The reader. + The character format. + + + + Reads the paragraph format. + + The reader. + The paragraph. + + + + Updates the paragraph style. + + The paragraph. + The reader. + + + + Reads the table row format. + + The reader. + The table. + + + + Check and update the revision details of the paragraph item. + + The paragraph item. + + + + Check and update the revision details at the end of each paragraph. + + The paragraph. + + + + Processes the commented text. + + The reader. + The paragraph. + + + + Closes this instance. + + + + + Gets the current paragraph. + + The current paragraph. + + + + Gets current field. + + + + + + + + + + + + + + + Updates the specified reader. + + The reader. + The prev level. + + + + + + + + + Sets the null. + + + + + Appends the one row to table. + + + + + + + + + + Reads the specified reader. + + The reader. + The word doc. + + + + Reads the style sheet. + + The reader. + + + + Get Style name based on Built-in style id + + + + + + + + + + + + + Reads the background. + + + + + + + + + + + + Reads the section format. + + The reader. + The sec. + + + + + + + + + + Reads Built in Document Properties + + reader + + + + Reads DOPDescriptor data. + + The reader. + + + + Defines if specified subdocument exists in the documnt. + + The reader. + Type of the ws. + + + + + Closes this instance. + + + + + Ends the of text body. + + The reader. + Type of the chunk. + + + + + Reads the annotation. + + + + + + Reads the footnote. + + The reader. + + + + Implemented alternative method to improve the performance + + + + + + + + Determines whether the footnote / endnote marker refers multiple footnotes / end notes + + + + + + + + + + + + + + + Reads shape objects + + The reader. + The File Shape Address. + + + + Checks the text embed. + + The shape. + + + + + Reads text body for autoshape. + + + + + + + Processes the commented text. + + The reader. + The paragraph. + + + + Splits the comm text. + + The paragraph. + The start text pos. + The split pos. + + + + Updates the comment marks. + + The comment. + + + + Parses the list picture. + + + + + Checks the watermark. + + The section. + + + + + + + + + Reads subdocument. + + + + + + + + + + + + + + + + + + Current type of header/footer. + + + + + + + + + + Header/footer textbox adapter + + + + + + + + + + + Sets the separator body. + + The text body. + The index. + WTextBody. + + + + Closes this instance. + + + + + + + + + + + + + Read textbox. + + The reader. + The file shape address structure + + + + Read + + + + + + + Reads text body for autoshape. + + + + + + + Checks the text embed. + + The shape. + + + + + + + + + + + + Removes the last paragraphs in headers / footers. + + The section. + + + + Removes Last paragraph in separator stories + + + + + + Gets the text box adapter. + + The text box adapter. + + + + + + + + + Reads the specified reader. + + The reader. + + + + Gets the next comment. + + + + + + Adds the comment. + + The reader. + + + + Defines end of text body for annotations. + + + + + + + + Closes this instance. + + + + + Reads the comment format. + + The reader. + The comment format. + + + + Gets the current comment. + + The current comment. + + + + Gets the comments. + + The comments. + + + + + + + + + Array of footnotes + + + + + Current footnote + + + + + Index of current footnote/endnote in collection of footnotes. + + + + + Number of footnotes/endnotes in document + + + + + + + + + + + + + + + + + Initialize FootnoteAdapter + + + + + + + + + + + + + Closes this instance. + + + + + + + + + + + + + + + + + + + + + + + + Initialize EndnoteAdapter. + + + + + + + + + + + + + + + + + + Currently used textbox. + + + + + Number of textboxes in document. + + + + + Type of textbox + + + + + Index of textbox in sequence of textboxes. + + + + + Collection of textboxes + + + + + Reads textboxes + + + + + + Closes this instance. + + + + + Defines end of textbox + + + + + + + + + + + + + + + Add textbox to internal textbox collection. + + + + + Reads the text box shape. + + The File Shape Address. + The skip position origins. + + + + + Gets textbox for autoshape by spid. + + + + + + + + + + + + + + + + + + + + + + + + + + + String constants + + + + + Zip archive used to compress the EPub file + + + + + Word document to be converted + + + + + Holds the files to add their names in package file and stream in archive + + + + + Holds the navigation point and reference for EPub TOC + + + + + Name of the XHTML file + + + + + Holds the unique identifier (GUID) + + + + + Refers to the title of the document + + + + + Refers to the author of the document + + + + + Holds the last navigation level + + + + + Refers to the playOrder in the NCX file. + + + + + Refers to the cover image + + + + + Constructor + + + + + Converts Word to EPub and saves it in disk + + Name of the file to save + Input word document + + + + Converts Word to EPub and saves it as stream + + File stream to save + Input word document + + + + Converts word document. + + Input word document + + + + Saves the EPub in disk + + File name to save + + + + Saves the EPub as stream + + File stream to save + + + + Writes Container.xml + + + + + Writes EPub document organization as navigation file + + + + + Generates TOC (Table of Contents) HTML file for navigation in Kindle + + + + + Writes bookmark to .NCX (navigation file) to enable TOC in EPub + + Heading level and id + Navigation text + XmlWriter + + + + Writes EPub document information as package file + + + + Name of the embedded file + + + + Generates XHTML and adds it to archive + + + + + Generates Cover page html if any cover page image is provided. + + + + + Saves the used fonts in the document + + + + + Gets the title of the document + + + + + Writes MIME type of EPub + + + + + Returns the MIMETYPE for embedded files + + File extenstion + MIMETYPE of the file + + + + Gets or sets the cover image + + + + + Gets or sets the file name + + + + + WinAPi functions. + + + + + To prevent construction of a class, we make a private constructor. + + + + + The GetDC function retrieves a handle to a display device context (DC) + for the client area of a specified window or for the entire screen. + + Handle to the window whose DC is to be retrieved + If the function succeeds, the return value is a handle to the DC + for the specified window's client area. + + + + Selects an object into the specified device context (DC). + The new object replaces the previous object of the same type. + + Handle to the DC. + Handle to the object to be selected. + If the selected object is not a region and the function succeeds, + the return value is a handle to the object being replaced. + + + + Deletes a logical pen, brush, font, bitmap, region, or palette, + freeing all system resources associated with the object. + After the object is deleted, the specified handle is no longer valid. + + Handle to a logical pen, brush, font, + bitmap, region, or palette. + If the function succeeds, the return value is nonzero. + + + + Retrieves font metric data for a TrueType font. + + Handle to the device context. + Specifies the name of a font metric table + from which the font data is to be retrieved + Specifies the offset from the beginning of the font metric table + to the location where the function should begin retrieving information. + Pointer to a buffer that receives the font information. + Specifies the length in bytes of the information to be retrieved + If the function succeeds, the return value is the number of bytes returned. + + + + The CreateDC function creates a device context (DC) for a device using the specified name. + + Driver name. + Device name. + Not used; should be NULL. + Optional printer data. + If the function succeeds, the return value is the handle to a DC for the specified device. + + + + The DeleteDC function deletes the specified device context (DC). + + Handle to the device context. + If the function succeeds, the return value is nonzero. + + + + Initializes a new instance of the CssPropertiesAttribute class. + + + + + + Initializes a new instance of the CssPropertiesAttribute class. + + + + + + + Defines the property name + + + + + It specifies that the attribute te be not inheritable in Html. + + + + + + Initializes a new instance of the HTMLNotInheritable class. + + + + + + It specifies that the property to be inheritable. + + + + + Initializes a new instance of the CssPropertyInherited class. + + + + + + Initializes a new instance of the CssPropertiesBox class. + + + + + + Initializes a new instance of the CssPropertiesBox class. + + + + + + + Assign the Style tag properties to the Box + + + + + + Property value from the Style Tag + + + + + Initializes a new instance of the HtmlAsciiCodesInfo class. + + + + + + Adds the Html Ascii symbols + + + + + + Adds the Html names. + + + + + + Gets or sets the Html AsciiCode table. + + + + + + + Gets or sets the Html Name table. + + + + + + + Determines whether the tag is supported or not. + + + + + + + + Determines whether the tag is in self ended tag list or not. + + + + + + + Determines whether the tag is table tag or not. + + + + + + + Determines whether the tag is paragraph tag or not. + + + + + + + + Check whether the tags are HeadingTags + + + + + + + Determines whether the tag is paragraph item tag or not. + + + + + + + + Determines whether the specified tag is a list tag. + + + + + + + Converts the font tag size attribute. + + The size. + The pixel value of the font tag size. + + + + Determines whether the tag is list item tag or not. + + + + + + + + Determines whether the tag is head item tag or not. + + + + + + + + Determines whether the space needs to be preserved for the specific tag. + + + + + + + Converts the incoming font size in pixels + + input sting value ex: 23em or 10in or 20pc + The converted pixel values in double. + + + + Converts the incoming table width in respective units + + + + + + + Get the number before to the units + + + + + Gets the number of string + + + + + + + + Gets the number of string + + + + + + + + Converts the width or height. + + + + + + + Gets whether the given string is valid hexadecimal string. + + + + + + + Initilize the colors table. + + + + + Fils the color tabel. + + + + + + + Gets the color table. + + + + + Centimeters + + + + + Milimeters + + + + + Pixels + + + + + Inches + + + + + Em - The font size of the relevant font + + + + + Points + + + + + Picas + + + + + Specifies the DisplayType of the HTML element. + + + + + Displayed as if the elements is not there + + + + + Displays the elements + + + + + Specifies the highlight color of the HTML element. + + + + + No highlight color will be applied. + + + + + Highlights the content with yellow (#ffffff00) color. + + + + + Highlights the content with bright green (#ff00ff00) color. + + + + + Highlights the content with turquoise (#ff00ffff) color. + + + + + Highlights the content with pink (#ffff00ff) color. + + + + + Highlights the content with blue (#ff0000ff) color. + + + + + Highlights the content with red (#ffff0000) color. + + + + + Highlights the content with dark blue (#ff000080) color. + + + + + Highlights the content with teal (#ff008080) color. + + + + + Highlights the content with green (#ff008000) color. + + + + + Highlights the content with violet (#ff800080) color. + + + + + Highlights the content with dark red (#ff800000) color. + + + + + Highlights the content with dark yellow (#ff808000) color. + + + + + Highlights the content with gray 50 (#ff808080) color. + + + + + Highlights the content with gray 25 (#ffc0c0c0) color. + + + + + Highlights the content with black (#ff000000) color. + + + + + Specifes the baseline alignment style of the HTML element. + + + + + Specifies the text to be rendered normally. + + + + + Specifies the text to appear above the baseline of text. + + + + + Specifies the text to appear below the baseline of text. + + + + + Specifies the strike through style of the HTML element. + + + + + No strike will be drawn. + + + + + Draws single strike. + + + + + Draws double strike. + + + + + Specifies the width type of the HTML element. + + + + + Specifies the width to be determined automatically. + + + + + Specifies the width in percentage. + + + + + Specifies the width in pixels. + + + + + Specifies the vertical alignment of the HTML element. + + + + + Aligns the content to the top. + + + + + Aligns the content to the center. + + + + + Aligns the content ot the bottom. + + + + + Specifies the border style of the HTML element. + + + + + No border. + + + + + A single solid line. + + + + + Dots. + + + + + A dash followed by a small gap. + + + + + A dash followed by a large gap. + + + + + A dash followed by a dot. + + + + + A dash followed by two dots. + + + + + Double solid lines. + + + + + Three solid thin lines. + + + + + An internal single thin solid line surrounded by a single thick solid line with + a small gap between them. + + + + + An internal single thick solid line surrounded by a single thin solid line with + a small gap between them. + + + + + An internal single thin solid line surrounded by a single thick solid line surrounded + by a single thin solid line with a small gap between all lines. + + + + + An internal single thin solid line surrounded by a single thick solid line with + a medium gap between them. + + + + + An internal single thick solid line surrounded by a single thin solid line with + a medium gap between them. + + + + + An internal single thin solid line surrounded by a single thick solid line surrounded + by a single thin solid line with a medium gap between all lines. + + + + + An internal single thin solid line surrounded by a single thick solid line with + a large gap between them. + + + + + An internal single thick solid line surrounded by a single thin solid line with + a large gap between them. + + + + + An internal single thin solid line surrounded by a single thick solid line surrounded + by a single thin solid line with a large gap between all lines. + + + + + A single wavy solid line. + + + + + Double wavy solid lines. + + + + + A dash followed by a dot stroke, thus rendering a border similar to a barber + pole. + + + + + The border appears to have a 3-D embossed look. + + + + + The border appears to have a 3-D engraved look. + + + + + The border appears to be outset. + + + + + The border appears to be inset. + + + + + Additional enums supported in Microsoft word in the XML level as well as by DocIO. + + + + + Cleared border. + + + + + Specifies the table alignment of the HTML element. + + + + + Aligns the table to the left. + + + + + Aligns the table to the center. + + + + + Aligns the table to the right. + + + + + Specifies the text alignment of the HTML element. + + + + + Default. Text is Aligned to the Left + + + + + Text is Aligned to the Right + + + + + Text is Aligned to the Center + + + + + Text is Aligned to the Justify + + + + + Replace the break charcaters. + + The string. + + + + Gets or sets the navigation URL of the HTML hyperlink. + + + + + Initializes a new instance of the HtmlNode class. + + + + + + Initializes a new instance of the HtmlNode class. + + + + + + + initializes a new instance of the HtmlNode class. + + + + + + Initializes a new instance of the HtmlNode class at the specified index. + + + + + + + + Collect the CssProperties from the ParagrpahBox + + + + + Gets the font family string. + + The string value. + The string representation of font family. + + + + Gets the color value. + + + + + + Get the Actual HighlightColor for the color string + + + + + Get the Actual HighlightColor for the Hexcode string + + + + + Get the Actual color for the color string + + String value ex" #89234 or rgb(23,32,100) or Gray + + + + + Get the Actual FontWeight for the FontWeight string + + The fontweight + + + + + Checks if the HTML tag is either a 'div' element or a list item element. + + True if the tag is a 'div' element or a list item element, otherwise false. + + + + Checks if the given font weight is valid. + + The font weight to check. + True if the font weight is valid, otherwise false. + + + + Get the Actual TextAlignment for the TextAlignment string + + The textalign + + + + + Converts the Percentage value to the correct float value + + + + + Set the properties value from the ParentBox + + + + + + + Converts a text decoration value to underline. + + The text decoration value to convert. + True if the text decoration is 'underline', otherwise false. + + + + Get the Actual StrikeThrough for the StrikeThrough string + + The textdecoration + + + + + Get the Actual BaselineAlignment for the BaselineAlignment string + + The verticalalign + + + + + Get actual vertical alignment for the vertical align string. + + + + + + String to line style. + + The value. + + + + + String to line width. + + The value. + + + + + String to table alignment. + + The value. + + + + + Updated the width and type. + + + + + + Update the height. + + + + + + Inherit value from the ParentBox + + + + + Inherits value from the Div element. + + + + + + Retrieves a list of PropertyInfo objects corresponding to CSS properties for a given HTML tag. + + The HTML tag name. + A boolean indicating whether the div inherits properties. + A list of PropertyInfo objects representing CSS properties. + + + + Check whether the tags are Block tags + + + + + + + Converts the string font-style in FontStyle + + + + + + + Override metohd for string + + + + + Return the root node of the table + + + + + copy the given node attributes + + + + + + Checks if the given key exists in the properties hash. + + The key to check. + True if the key exists, otherwise false. + + + + Set the values for the properties + + + + + + + Gets the index of the current node in the child node list of its parent. + + + + + + Assign the padding values. + + + + + + Assigns the border values. + + + + + + Checks whether the value is border color. + + + + + + + Checks whether the value is border style. + + + + + + + Assigns the border styles. + + + + + + Assigns the borders width. + + + + + + Assigns the borders color. + + + + + + Assigns the border top values. + + + + + + Assigns the border right values. + + + + + + Assigns the border bottom values. + + + + + + Assigns the border left values. + + + + + + Gets the inner text within the tag + + + + + + + Dictionary containing not inheritable HTML properties. + + + + + Whether it is a empty tag + + + + + Whether it is a Div tag end + + + + + Determines whether this is a manually created HTMLNode during HTMLNode creation + that is not present in file level. + + + + + Contains the actual text that is at the file level before trimming. + + + + + Describes the TextAlignment of the Paragraph + + + + + Describes the CSS 'white-space' property + + + + + Describes the display type for an HTML element + + + + + Target frame of the Hyperlink + + + + + Title of the HTML node. + + + + + Text of the HTML node. + + + + + ParagraphBoxes collection for every instance + + + + + List of the HTML node. + + + + + List level of the HTML node. + + + + + All the properties of ParagraphBox + + + + + Only CssPropertiesAttribute + + + + + It collects the properties which are inheritable in the HTML architecture + + + + + Parent for the ParagraphBox + + + + + Gets the Previous node of the HTML node + + + + + Gets Next node of the HTML node + + + + + It decides whether ParagraphBox is HyperlinkAdv + + + + + It paints the forground color for the Text which inside the ParagraphBox + + + + + Background color of the HTML node + + + + + Left indent of the HTML node + + + + + Right indent of the HTML node + + + + + First line indent of the HTML node + + + + + After spacing of the HTML node + + + + + Before spacing of the HTML node + + + + + Describes the Line height + + + + + It paints the background color for the ParagraphBox + + + + + Describes the font [ Fontweight,FontStyle,FontVariant] for the ParagraphBox + + + + + Actual background color of the HTML node + + + + + Highlightcolor of the HTML node + + + + + Describes the margins of the tablecell + + + + + Describes the margins of the tablecell + + + + + Left margin of the table cell + + + + + Right margin of the table cell + + + + + Top margin of the table cell + + + + + Bottom margin of the table cell + + + + + String color determines the Foreground color for the Text + + + + + Represents the image source. + + + + + It stores the corresponding HTML tag information + + + + + It decides the Text's FontFamily + + + + + It decides the FontSize of the Text + + + + + Describes the text decoration of the text. + + + + + It decides the FontStyle of the Text. + + + + + It decides the FontVariant of the Text. + + + + + It defines the SubScript and SuperScript for the Text + + + + + FontWeight for the Text + + + + + List style type of the list. + + + + + List pattern of the list. + + + + + List start of the list. + + + + + Whether the Text should be underlined. + + + + + SingleStroke and DoubleStroke for the Text + + + + + It decides the Height of the Image + + + + + It decides the Width of the Image + + + + + It decides the columns group span. + + + + + Width of the HTML node. + + + + + Height of the HTML node + + + + + Preferred width of the HTML node. + + + + + Preferred width type of the HTML node. + + + + + Preferred iamge width type of the HTML node. + + + + + It decides the row span. + + + + + It decides the column span. + + + + + Border thickness of the HTML node. + + + + + Gets or sets the row height. + + + + + Gets or sets the valign. + + + + + Gets or sets the vertical-align. + + + + + Gets or sets the header row. + + + + + Gets or sets the page-break-before. + + + + + Gets or sets the border collapse. + + + + + Gets or sets the borders. + + + + + Gets or sets the borders-style + + + + + Gets or sets border-width. + + + + + Gets or sets teh border-color. + + + + + Gets or sets the border-top. + + + + + Gets or sets the border-top-width. + + + + + Gets or sets the border-top-style. + + + + + Gets or sets the border-top-color. + + + + + Gets or sets the border-right. + + + + + Gets or sets the border-right-width. + + + + + Gets or sets the border-right-style. + + + + + Gets or sets the border-right-color. + + + + + gets or sets the border-bottom. + + + + + Gets or sets the border-bottom-width. + + + + + Gets or sets the border-bottom-style. + + + + + Gets or sets the border-bottom-color. + + + + + Gets or sets the border-left. + + + + + Gets or sets the border-left-width. + + + + + gets or sets the border-left-width, + + + + + gets or sets the border-left-color. + + + + + Gets or sets the Table alignment. + + + + + Gets or sets the cell spacing. + + + + + Initializes a new instance of the HTMLTagInfo class. + + + + + + + Initializes a new instance of the HTMLTagInfo class. + + + + + + Initializes a new instance of the HTMLTagInfo class. + + + + + + Set attributes for the ParagaraphBox + + + + + + Calculates the border line width for an HTML node based on the provided value. + + The HTML node to calculate border width for. + The string representation of the border width. + The calculated border width. + + + + Assign the TagName information + + + + + + Collect attributes from the htmlstring + + + + + + Check whether Tag has Attributes + + + + + Name of the HTML tag. + + + + + Attributes for the particular tag + + + + + Whether it is a closing tag + + + + + Whether it is a self closing tag + + + + + Whether it is a single tag + + + + + Returns the matched collection + + + + + Searches the specified regex on the source + + + + + Searches the specified regex on the source + + + + + No-Width Optional Break. (char)8203. + + + + + It has the Text of the HTML Tag + + + + + Initializes a new instance of the HtmlTextNode class. + + + + + + + + Initializes a new instance of the HtmlTextNode class. + + + + + + + Loads the Html string. + + + True, if loaded. Otherwise False. + + + + + Parses the Html tags + + + True, if valid Html string. Otherwise False. + + + + + Checks whether the current node or parent node is Pre tag. + + The HTML node. + Returns true if current node or parent node is Pre tag; otherwise, false. + + + + Determines whether the specified HTML node contains the 'white-space' property with a value of 'pre' or 'pre-wrap' in its style attribute. + + The HTML node to check. + True if the 'white-space' property with value 'pre' or 'pre-wrap' is found; otherwise, false. + + + + Retrieves the value of a specified style attribute from a style string. + + The complete style attribute value. + The name of the style attribute to retrieve. + The value of the specified style attribute, or an empty string if not found. + + + + Adds the Html node. + + + + + + + + + Appends text to Html node. + + + + + + + + + Checks whether to trim the text or not. + + + + + + + + Adds the Html text node. + + + + + + + + Finds the base node. + + + + + + + + + Finds the Parent html node. + + + + + + + + Finds the Parent body node. + + + + + + + + Creates the HTMLNode with the specified tag name. + + + + + + + Finds the paragraph node + + + + + + + Find the end node of the Div. + + current html node + + + + + Finds the Parent table node. + + + + + + + + Finds the parent body table node. + + + + + + + + Finds the parent of table row + + + + + + + Finds the parent of the table cell + + + + + + + Determine whether the node is body node. + + + + + + + Apply the Inline style , External styles and Inherit the styles from the ParentBoxes + + + + + + check the given color in empty + + + + + + It corrects the boxes based upon the Tag information + + + + + + Insert the Ascii symbol based on the HtmlCodeTable + + + + + + + Encodes the Html names. + + + + + + + + Generate CssPropertiesBox from the Style Tag's string. + + + + + + Stores the Properties in the CssPropertiesBoxes + + + + + + Determines whether the tag is unsupported + + + + + + + + Determines whether the node has font size value. + + + + + + + + Finds the body tag. + + The root node. + The body tag. + + + + Determines whether the space needs to be preserved or not. + + + + + + + + It stores the CssProperties boxes from the Style tag + + + + + Specifies a "Thin" font weight + + + + + Specifies an "Extra-Light" font weight + + + + + Specifies an "Light" font weight + + + + + Specifies a "Normal" font weight + + + + + Specifies a "Medium" font weight + + + + + Specifies a "SemiBold" font weight + + + + + Specifies a "Bold" font weight + + + + + Specifies a "ExtraBold" font weight + + + + + Specifies a "Black" font weight + + + + + Initializes an object of HtmlFontWeight with specified weight of the font + + The weight is applied to the font + + + + Initializes an instance of HtmlThickness structure with specified length on each side + + The length is applied to all four sides of the bounding rectangle + + + + INitializes a new instance of HtmlThickness structure with specified lengths applied to each side of the bounding rectangle + + The thickness of the left side of the bounding rectangle + The thickness of the upper side of the bounding rectangle + The thickness of the right side of the bounding rectangle + The thickness of the lower side of the bounding rectangle + + + + Gets or Sets the width in pixels of the left side of the bounding rectangle + + + + + Gets or Sets the width in pixels of the upper side of the bounding rectangle + + + + + Gets or Sets the width in pixels of the right side of the bounding rectangle + + + + + Gets or Sets the width in pixels of the lower side of the bounding rectangle + + + + + Defines methods to add the Html string to document . + + + + + Appends the html string to without style at specified index + + The to which the string is to be added. + The HTML string. + The zero-based index of the paragraph to insert the html string. + The zero-based index of the paragraph item to insert the html string. + + + + Appends the Html string to with style at specified index + + The to which the Html string is to be added. + The Html string. + The zero-based index of the paragraph to insert the html string. + The zero-based index of the paragraph item to insert the html string. + The object that specifies the style for the Html string + The object that specifies the list style for the Html string + + + + Determines whether the specified Html string is valid. + + The Html string. + The member specifies the type to validate the Html string. + True if the specified Html string is valid, otherwise false. + + + + Determines whether the specified Html string is valid. + + The Html string. + The member specifies the type to validate the Html string. + The string that specifies the exception message. + True if the specified Html string is valid, otherwise false. + + + + + + + + + Inits this convertor. + + + + + Appends the Html string to with style at specified index + + The to which the Html string is to be added. + The Html string. + The zero-based index of the paragraph to insert the html string. + The zero-based index of the paragraph item to insert the html string. + The object that specifies the style for the Html string + The object that specifies the list style for the Html string + + + + Appends the html string to without style at specified index + + The to which the string is to be added. + The HTML string. + The zero-based index of the paragraph to insert the html string. + The zero-based index of the paragraph item to insert the html string. + + + + Parses the HTML nodes + + HTML root node + text body + + + + Parses the paragraph + + Paragraph node + text body + + + + Checks whether this is a first sibling of the parent node + + + + + + + Parses the paragraph items. + + + + + + + + Parses the span nodes (Child nodes of paragraph) + + Child node of paragraph + current paragraph + is hyperlink + + + + + Adds the Text range. + + + + + + + + Creates new text range for the span node + + span node + text + is hyperlink + + + + + Checks whether the text is RTL by checking the unicode of the string characters. + + The text. + True, If the text is RTL text. Otherwise, false. + + + + Insert the Ascii symbol based on the HtmlCodeTable + + + + + + + Encodes the Html names. + + + + + + + + Adds the new paragraph. + + + + + Parses the character format. + + + + + + + + Parses the paragraph format. + + + + + + + + Determine whether the Node is in Div + + + + + + + Check whether the tag is empty tag + + + + + + + Determines whether the specified Html string is valid. + + The Html string. + The member specifies the type to validate the Html string. + True if the specified Html string is valid, otherwise false. + + + + Called when [validation]. + + The sender. + The instance containing the event data. + + + + Determines whether the specified Html string is valid. + + The Html string. + The member specifies the type to validate the Html string. + The string that specifies the exception message. + True if the specified Html string is valid, otherwise false. + + + + Prepares the HTML string. + + The HTML string. + The schema. + + + + Insert DocType elemnet and html start element based on XHTMLValidationType + + + + + + + + + Gets the document title + + Document title value + + + + Remove Xml and DocType element from html start + + + + + + + + + Replace constants by Unicode + + + + + + + Replace HtmlSpecialCharacter's EntityNames by EntityNumbers + + + + + + + Replace HtmlSymbol's EntityNames by EntityNumbers + + + + + + + Replace HtmlCharacter's EntityNames by EntityNumbers + + + + + + + Replace HtmlMathSymbol's EntityNames by EntityNumbers + + + + + + + Replace HtmlGreekLetter's EntityNames by EntityNumbers + + + + + + + Replace Html Other EntityNames by EntityNumbers + + + + + + + Replace ampersand by Unicode Character. + + The HTML. + + + + + Get the positions of ampersand. + + The HTML. + Ampersand. + + + + + + + + + + Specifies the text style. + + + + + Specifies the Borders + + + + + Initialize the formatting properties + + + + + Clones this instance. + + + + + + + + + + + + + + + + + + + + Determines whether the specified property key has value. + + + + + + + Set the values for the properties + + + + + + + Gets or sets a value indicating whether to break lines on word or character level. By default line breaks on word level. + + + true if line breaks on word level; otherwise, false. + + + + + Gets/ Sets whether white space need to be preserved + + + + + Gets or sets the LocalIdASCII values. + + + + + Gets/ Sets Hidden property of text + + + + + Gets/ Sets All Caps + + + + + Gets or sets a value indicating whether the text has small caps formatting + + + + + Gets/Sets visited Link color + + + + + Gets/Sets PageBreakBefore + + + + + Gets/Sets PageBreakAfter + + + + + Gets/Set Linespacing rule + + + + + Get or set a value to represents custom tab stop postion + + + + + Get or set a value to represents custom tab leader + + + + + Get or set a value to represents custom tab alignment + + + + + Get or set a value to represents current tab width + + + + + Get or set a value to represents whether the element has line of block text + + + + + Get or set a value indicating whether the element contains Non breaking white space characters + + + + + Get or set a boolean indicating whether the current span element is list tab + + + + + Get or set a value that represents the list number width + + + + + Get or set a value that represents the list padding left value + + + + + Specifies Bold format. + + + + + Specifies Italic format. + + + + + Specifies Underline format. + + + + + Specifies Strike format. + + + + + Specifies font color of the text. + + + + + Specifies back color of the text. + + + + + Specifies the font family. + + + + + Specifies the font size. + + + + + Specifies the line height. + + + + + Specifies whether the line height is Normal or not + + + + + Specifies the text alignment. + + + + + Specifies the left margin. + + + + + Specifies the Text indent. + + + + + Specifies the Right margin + + + + + Specifies the Top margin + + + + + Specifies the Bottom margin + + + + + Specifies Superscript/SubScript + + + + + Gets/Sets scaling + + + + + + + + + + Variable specifies the color value. + + + + + Variable specifies the width value. + + + + + Variable specifies the style value. + + + + + Variable specifies the Top color value. + + + + + Variable specifies the bottom color. + + + + + Variable specifies the left color value. + + + + + Variable specifies the right color value. + + + + + Variable specifies the TopStyle. + + + + + Variable specifies the BottomStyle. + + + + + Variable specifies the LeftStyle. + + + + + Variable specifies the RightStyle. + + + + + Variable specifies the TopWidth. + + + + + Variable specifies BottomWidth. + + + + + Variable specifies LeftWidth. + + + + + Variable specifies RightWidth. + + + + + Variable specifies BottomSpace. + + + + + Variable specifies TopSpace. + + + + + Variable specifies LeftSpace. + + + + + Variable specifies RightSpace. + + + + + Initializes a new instance of the class. + + The parent. + + + + The default implementation of IHtmlConverter. + + + + + Appends the Html string to with style at specified index + + The to which the Html string is to be added. + The Html string. + The zero-based index of the paragraph to insert the html string. + The zero-based index of the paragraph item to insert the html string. + The object that specifies the style for the Html string + The object that specifies the list style for the Html string + + + + Appends the html string to without style at specified index + + The to which the string is to be added. + The HTML string. + The zero-based index of the paragraph to insert the html string. + The zero-based index of the paragraph item to insert the html string. + + + + Parses the Body style. + + The node. + + + + Apply Page margins and background color + + + + + + Apply Page border + + + + + + + Set Next style for the pararaph style + + + + + + Parse body attributes + + + + + + Parse child entities of text body and removes last line break from the paragraph + + + + + + Determines whether the specified Html string is valid. + + The Html string. + The member specifies the type to validate the Html string. + True if the specified Html string is valid, otherwise false. + + + + Determines whether the specified Html string is valid. + + The Html string. + The member specifies the type to validate the Html string. + The string that specifies the exception message. + True if the specified Html string is valid, otherwise false. + + + + Replace constants by Unicode + + + + + + + Replace HtmlSpecialCharacter's EntityNames by EntityNumbers + + + + + + + Replace HtmlSymbol's EntityNames by EntityNumbers + + + + + + + Replace HtmlCharacter's EntityNames by EntityNumbers + + + + + + + Replace HtmlMathSymbol's EntityNames by EntityNumbers + + + + + + + Replace HtmlGreekLetter's EntityNames by EntityNumbers + + + + + + + Replace Html Other EntityNames by EntityNumbers + + + + + + + Replace ampersand by Unicode Character. + + The HTML. + + + + + Get the positions of ampersand. + + The HTML. + Ampersand. + + + + + Loads the XHTML. + + The HTML. + + + + Load XHTML + + + + + + + + Prepares the HTML string. + + The HTML string. + The schema. + + + + Remove Xml and DocType element from html start + + + + + + + + + Insert DocType elemnet and html start element based on XHTMLValidationType + + + + + + + + + Moves head elements found inside the body tag to the head tag of the given HTML string. + + The HTML string to modify. + The modified HTML string with head elements moved from the body tag to the head tag. + + + + Gets the document title + + Document title value + + + + Traverses the child nodes. + + The nodes. + + + + Traverse text within the tag + + + + + + + Check wether the text is tab or not + + + + + + + Add the new paragraph to textBody + + + + + + Applies the paragraph format. + + + + + Checks whether the paragraph need to be added + + + + + + + Remove white spaces at the begining of paragraph + + + + + + + + Adds the new paragraph. + + + + + Determine whether the Node is in Div + + + + + + + Parses paragraph tags + + + + + Checks whether this is a first sibling of the parent node + + + + + + + Parses the tags. + + The node. + + + + Parse the FormFields to the Paragraph + + + + + + + Removes the duplicate bookmark of form field. + + + + + + parses the checkbox size. + + + + + + + Insert the form field to the Current Paragraph + + + + + + + + Called when form field inserts - Performs insertion of bookmark start for the corresponding form field. + + Index + Entity + Updated index + + + + Parse the child Entities for the DropDownItems + + + + + + + Gets the attribute value. + + The node. + Name of the attr. + + + + + + Determines whether the split character should be treated as RTL based on the BiDi property + of the paragraph format in the given text range. + + The text range containing the Word split character. + + Returns true if the split character's text range is RTL; otherwise, returns false. + + + + + Splits the textranges by consecutive LTR and RTL texts. + + + + + To check whether the specified language is arabic language or not. + + Specify the language local id + Return true if the language id is represent the arabic + + + + Splits the text ranges in the paragraph by text and numbers. + + The paragraph item collection. + + + + Splits the text ranges in the paragraph by text and Arabic word split characters. + + The paragraph item collection. + + + + To check whether the specified character is an arabic word split character (،؛) or not. + + Specify the character. + Return true if the specified character is an arabic word split character; otherwise, false. + + + + To check whether the specified character is word split character ([/;) or not. + + Specify the character + Return true if the specified character is word split character + + + + + Combine the text range by consecutive LTR and RTL texts. + + + + + Checks whether the node is considered empty based on its child nodes. + + + + + + + Parse heading tag + + + + + + + + + + + Specifies the process when a blockquote tag starts + + + + + Specifies the process when a blockquote tag ends + + + + + Specifies the process when a div tag starts + + Div node + + + + Specifies the process when a div tag ends + + + + + Specifies the process when a table tag ends + + + + + Specifies the process when a table tag starts + + + + + Calculates cell width of nested table based on preferred width + + Nested Table + Client Width of owner cell + + + + COnverting Hyperlink in html to Doc + + Hyperlink node + + + + Traverse child nodes of the Hyperlink Field + + + + + + + Apply Hyperlink style + + + + + + Parses image attribute + + + + + Parses the Image style. + + The attr. + The Picture. + + + + Writes the image. + + The node. + + + + Gets the image for partial trust mode. + + The source. + The pic. + + + + Reads the fully. + + The input. + + + + + Reads the image file. + + The image location. + + + + + Get Image + + + + + + + Try downloading the image again with the given credentials + + + + + + + + Appends the HTML text. + + The para. + The text node. + + + + Update List left indent stack + + + + + + + Apply Font size specified in font tag + + + + + + + Sets the list mode. + + if set to true is bulleted. + The node. + + + + Writes the paragraph. + + + + + Checks whether the current format is heading style. + + + + + Applies the paragraph style. + + + + + Applies the paragraph format. + + + + + Adjust left indent value for list + + + + + + + + Check whether the bottom margin need to be preserved + + + + + + + + Check whether the Top margin need to be preserved + + + + + + + + Checks whether the node is last node within division + + + + + + + Check whether the specified attribute defined inline + + + + + + + + Apply list formatting + + + + + + + + Get List Pattrn type + + + + + + + Apply Paragraph border + + + + + + + Apply the current div formt to the paragraph. + + + + + Applies the formatting. + + The tr. + + + + Apply the current div format to the character format of the textrange + + + + + + Ensures the style. + + The node. + + + + + Extract the value alone without units + + The Value + + + + + Parses the style. + + The node. + + + + Checks whether the Border format is default or not. + + + Returns True, if the border is detault (has default values), other wise returen false. + + + + Get foramt + + + + + + + + Parses the tab justification. + + The justification value. + + + + Parses the tab leader. + + The leader value. + + + + Get text format. + + Text format + The attribute. + The value. + + + + Parse line height + + + + + + + + Get the color value + + The values of the specified style attribute. + Index of the RGB string + The color. + + + + Get Color value + + + + + + + Get Font Name + + + + + + + Gets the Font attribute values + + The values of font attribute. + Text format + + + + Separates and Orders the value of font + + + + + + + + Calculate the font size + + Value specifying font size + The font size + + + + Checks whether the value is font size + + Value to check + True if the value specifies font size, otherwise false. + + + + Parse Border + + + + + + + + + Parse Border + + + + + + + + + Checks whether the value is a border width + + + + + + + Calculate border width + + + + + + + Three-digit RGB notation (#rgb) is converted into six-digit form (#rrggbb) by repeating each digit twice. + + RGB hexadecimal characters. + + + + + Seperate param value with its unit + + + + + + + + + + + + + + Leaves the style. + + if the style is present, set to true. + + + + Updates the paragraph's format. + + The node. + + + + Adds the style. + + + + + + Updates the height or width of the image if height or width is not specified in file level. + + The picture. + + + + Gets the attribute value. + + The node. + Name of the attr. + + + + + Gets the style attribute value + + + + + + + + Convert the paramValue to bool value + + + + + + + Converts the size. + + The param value. + + + + + Gets the number before. + + The val. + The end. + + + + + Called when [validation]. + + The sender. + The instance containing the event data. + + + + Builds the list style. + + Name of the style. + The xml node. + + + + Creates a list level + + + + + + + Gets the type of the list style. + + The node. + + + + + Gets the list style type from container. + + The node. + + + + + Update bullet char for list level + + The list level no. + The node. + The list level. + + + + Creates the list style. + + + + + + create the list Override style. + + + + + + + + Prepares the list start. + + The start. + + + + + Determines whether is start of level. + + The node. + + true if [is start of level] [the specified node]; otherwise, false. + + + + + Parses the table. + + supported + - table\tr\td construction + - table or cell must have a width in pixel + + The node. + + + + Apply the current div formt to the Table + + + + + Parses the table rows. + + The xml node. + + + + Parses the cell attrs. + + The node. + The cell. + The span helper. + The borders. + + + + Parses the cell style. + + The attr. + The cell. + The borders. + + + + Apply borders + + + + + + + Apply border type and line width + + + + + + + Apply table border + + + + + + Apply cell border + + + + + + + Parse border line width + + + + + + + Parse border style + + + + + + + Parse border color + + + + + + + Parses the row attrs. + + The row node. + The row. + + + + Update Hidden property of the row based on parent node + + + + + + + Parses the table format. + + The node. + The borders. + + + + Parses the table style. + + The attr. + The span helper. + + + + Set table width from table style attributes + + Value from width attribute + Value from max-width attribute + + + + + Parse table properties + + + + Text format. + + + + Parse table border + + + + + + + Parses the Row style. + + The attr. + The row. + + + + Apply table border + + + + + + + + Toes the points. + + The param value. + + + + + Gets the vertical alignment + + The param value. + + + + + Get HorizontalAlignment + + + + + + + Roman number to arabic number. + + The number. + + + + + Inits this convertor. + + + + + Parses the CSS style. + + The node. + + + + Parses the CSS style. + + The node. + + + + Finds the CSS style Item. + + + + + + Finds the ID selector from CSS style. + + + + + + Finds the Class selector form CSS style + + + + + + Assign CSS style for cell + + + + + + + + Finds the descendant selector from CSS style. + + + + + + Finds the element selector from CSS style. + + + + + + Finds the Child selector from CSS style. + + + + + + Applies the CSS style. + + + + + + Parse the CSS textformat values + + + + + + + Insert the field begin + + + + + Parse the field separator + + + + + Parse the FieldEnd + + + + + Parse the field code if span style is mso-field-code + + + + + + + Parse the field text + + + + + + Need to replace newline character + + + + + + Implemented alternative method to improve the performance + + + + + + + + Determines whether the bookmark needs to be preserved for the given node. + + + + + + + Checks whether the current node has a specified parent node that exists at the file level. + + + + + + + + Gets or sets a value indicating whether previous item is field start + + + true if the instance is field start ; otherwise, false. + + + + + Gets or sets a value indicating whether it is from mso-field-code style + + + true if it is ; otherwise, false. + + + + + Gets or sets a value indicating whether the table has style. + + + true if table has style; otherwise, false. + + + + + Gets or sets a value indicating whether the row has style. + + + true if row has style; otherwise, false. + + + + + Gets or sets a value indicating whether the cell has style. + + + true if cell has style; otherwise, false. + + + + + Gets the CSS style property + + + + + Get client width of the html textbody + + + + + Get and set the base path + + + + + Gets the field stack. + + The field stack. + + + + Gets the current field. + + The current field. + + + + Gets the current format. + + The current format. + + + + Gets the current para. + + The current para. + + + + Gets the lfo stack. + + lfoName . + + + + Gets the list stack. + + The list stack. + + + + Gets the current list style. + + The current list style. + + + + Collection holds the existing bookmark start names. + + + + + Collection holds the existing bookmark end names. + + + + + + + + + + Resets the curr column. + + + + + Updates the table grid. + + The cell. + + + + Nexts the column. + + + + + Gets the table grid from table grid collection + + + + + + + Updates the table. + + The table. + + + + Calculates the cell width by summing the width of spanned columns + + + + + Update Row span + + + + + + Gets/Sets the collection of row grid for a table + + + + + + + + + + Specifies the text style. + + + + + Specifies the Borders + + + + + Initialize the formatting properties + + + + + Clones this instance. + + + + + + + + + + + + + + + + + + + + Determines whether the specified property key has value. + + + + + + + Set the values for the properties + + + + + + + Gets or sets a value indicating whether to break lines on word or character level. By default line breaks on word level. + + + true if line breaks on word level; otherwise, false. + + + + + Gets/ Sets whether white space need to be preserved + + + + + Gets or sets the LocalIdASCII values. + + + + + Gets/ Sets Hidden property of text + + + + + Gets/ Sets All Caps + + + + + Gets or sets a value indicating whether the text has small caps formatting + + + + + Gets/Sets visited Link color + + + + + Gets/Sets PageBreakBefore + + + + + Gets/Sets PageBreakAfter + + + + + Gets/Set Linespacing rule + + + + + Get or set a value to represents custom tab stop postion + + + + + Get or set a value to represents custom tab leader + + + + + Get or set a value to represents custom tab alignment + + + + + Get or set a value to represents current tab width + + + + + Get or set a value to represents whether the element has line of block text + + + + + Get or set a value indicating whether the element contains Non breaking white space characters + + + + + Get or set a boolean indicating whether the current span element is list tab + + + + + Get or set a value that represents the list number width + + + + + Get or set a value that represents the list padding left value + + + + + Specifies Bold format. + + + + + Specifies Italic format. + + + + + Specifies Underline format. + + + + + Specifies Strike format. + + + + + Specifies font color of the text. + + + + + Specifies back color of the text. + + + + + Specifies the font family. + + + + + Specifies the font size. + + + + + Specifies the line height. + + + + + Specifies whether the line height is Normal or not + + + + + Specifies the text alignment. + + + + + Specifies the left margin. + + + + + Specifies the Text indent. + + + + + Specifies the Right margin + + + + + Specifies the Top margin + + + + + Specifies the Bottom margin + + + + + Specifies Superscript/SubScript + + + + + Gets/Sets scaling + + + + + Checks whether the bidi is present or not + + + + + + + + + + Variable specifies the color value. + + + + + Variable specifies the width value. + + + + + Variable specifies the style value. + + + + + Variable specifies the Top color value. + + + + + Variable specifies the bottom color. + + + + + Variable specifies the left color value. + + + + + Variable specifies the right color value. + + + + + Variable specifies the TopStyle. + + + + + Variable specifies the BottomStyle. + + + + + Variable specifies the LeftStyle. + + + + + Variable specifies the RightStyle. + + + + + Variable specifies the TopWidth. + + + + + Variable specifies BottomWidth. + + + + + Variable specifies LeftWidth. + + + + + Variable specifies RightWidth. + + + + + Variable specifies BottomSpace. + + + + + Variable specifies TopSpace. + + + + + Variable specifies LeftSpace. + + + + + Variable specifies RightSpace. + + + + + Initializes a new instance of the class. + + The parent. + + + + + + + + + Gets the CSS style item + + + + + + + dispose the CSS style + + + + + Get and set the CSS style collection + + The list style collection. + + + + Closes this instance. + + + + + Get and set the CSS style name. + + The style name. + + + + Get and set the CSS style type + + The style type. + + + + Gets the properties hash value. + + The properties hash. + + + + Gets the important properties hash value. + + The important properties hash. + + + + Get and set the properties hash value. + + The properties hash. + + + + Get and set the important properties hash value. + + The important properties hash. + + + + Defines CSS selector style type. + + + + + Defines style type as none. + + + + + Defines style type as element selector. + + + + + Defines style type as id selector. + + + + + Defines style type as class selector. + + + + + Defines style type as grouping selector. + + + + + Defines style type as descendant selector. + + + + + Defines style type as child selector. + + + + + Defines style type as adjacent sibling selector. + + + + + Defines style type as general sibling selector. + + + + + Defines text format. + + + + + Defines important text format. + + + + + Represents the conversion implementation of Word document as HTML file. + + This class, its properties and methods are not supported in Silverlight, Windows Phone, Universal, Universal Windows Platform and Xamarin applications. + + The following code example demonstrates how to convert Word to HTML file. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Loads an existing document + WordDocument document = new WordDocument("Template.docx"); + HTMLExport export = new HTMLExport(); + //The images in the input document will be copied to this folder + document.SaveOptions.HtmlExportImagesFolder = @"D:\Data\"; + //The headers and footers in the input will be exported + document.SaveOptions.HtmlExportHeadersFooters = true; + //Export the text form fields as editable + document.SaveOptions.HtmlExportTextInputFormFieldAsText = false; + //Set the style sheet type + document.SaveOptions.HtmlExportCssStyleSheetType = CssStyleSheetType.External; + //Set name for style sheet + document.SaveOptions.HtmlExportCssStyleSheetFileName = "UserDefinedFileName.css"; + //Set the use absolute path as true + export.UseAbsolutePath = true; + //Save the document as html file + export.SaveAsXhtml(document, "WordtoHtml.html"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Loads an existing document + Dim document As New WordDocument("Template.docx") + Dim export As New HTMLExport() + 'The images in the input document will be copied to this folder + document.SaveOptions.HtmlExportImagesFolder = "D:\Data\" + 'The headers and footers in the input will be exported + document.SaveOptions.HtmlExportHeadersFooters = True + 'Export the text form fields as editable + document.SaveOptions.HtmlExportTextInputFormFieldAsText = False + 'Set the style sheet type + document.SaveOptions.HtmlExportCssStyleSheetType = CssStyleSheetType.External + 'Set name for style sheet + document.SaveOptions.HtmlExportCssStyleSheetFileName = "UserDefinedFileName.css" + 'Set the use absolute path as true + export.UseAbsolutePath = True; + 'Save the document as html file + export.SaveAsXhtml(document, "WordtoHtml.html") + document.Close() + End Sub + + + + + + + Cache files as stream + + + + + Has navigation id + + + + + OEB header and footer + + + + + Auto incrementing pointer for navigation point + + + + + Holds heading styles + + + + + Holds the name and data of stylesheets + + + + + Bookmark collection for TOC + + + + + Footnote Reference Attribute string + + + + + Holds the name and data of image files + + + + + Saves the Word document as XHTML file. + + The to be saved as html. + The string that specifies the name to save the html file. + + The following code example demonstrates how to convert Word to XHTML file. + + //Loads an existing document + WordDocument document = new WordDocument("Template.docx"); + HTMLExport export = new HTMLExport(); + //Save the document as Xhtml file + export.SaveAsXhtml(document, "WordtoXHtml.html"); + document.Close(); + + + 'Loads an existing document + Dim document As New WordDocument("Template.docx") + Dim export As New HTMLExport() + 'Save the document as Xhtml file + export.SaveAsXhtml(document, "WordtoXHtml.html") + document.Close() + + + + + + Saves the Word document as XHTML file with specified encoding. + + The to be saved as html. + The string that specifies the name to save the html file. + The character encoding to use. + + The following code example demonstrates how to convert Word to XHTML file with specified encoding. + + //Loads an existing document + WordDocument document = new WordDocument("Template.docx"); + HTMLExport export = new HTMLExport(); + //Save the document as Xhtml file + export.SaveAsXhtml(document, "WordtoXHtml.html", Encoding.Unicode); + document.Close(); + + + 'Loads an existing document + Dim document As New WordDocument("Template.docx") + Dim export As New HTMLExport() + 'Save the document as Xhtml file + export.SaveAsXhtml(document, "WordtoXHtml.html", Encoding.Unicode) + document.Close() + + + + + + Saves as XHTML. + + Word document to convert + Stream to save + True if XHTML is created for EPub format + + + + Saves the Word document as XHTML file in a stream. + + The to be saved as html. + The to save the html file. + + The following code example demonstrates how to convert Word to XHTML file in a stream. + + //Creates a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Adds new text to the paragraph + paragraph.AppendText("Hello World!"); + HTMLExport export = new HTMLExport(); + MemoryStream stream = new MemoryStream(); + //Save the document as Xhtml file + export.SaveAsXhtml(document, stream); + document.Close(); + + + 'Creates a new Word document + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + 'Adds new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Adds new text to the paragraph + paragraph.AppendText("Hello World!") + Dim export As New HTMLExport() + Dim stream As New MemoryStream() + 'Save the document as Xhtml file + export.SaveAsXhtml(document, stream) + document.Close() + + + + + + Saves the Word document as XHTML file in a stream with specified encoding. + + The to be saved as html. + The to save the html file. + The character encoding to use. + + The following code example demonstrates how to convert Word to XHTML file in a stream with specified encoding. + + //Creates a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Adds new text to the paragraph + paragraph.AppendText("Hello World!"); + HTMLExport export = new HTMLExport(); + MemoryStream stream = new MemoryStream(); + //Save the document as Xhtml file + export.SaveAsXhtml(document, stream, Encoding.Unicode); + document.Close(); + + + 'Creates a new Word document + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + 'Adds new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Adds new text to the paragraph + paragraph.AppendText("Hello World!") + Dim export As New HTMLExport() + Dim stream As New MemoryStream() + 'Save the document as Xhtml file + export.SaveAsXhtml(document, stream, Encoding.Unicode) + document.Close() + + + + + + Writes the XHTML. + + The doc. + Name of the CSS file. + + + + Closes this instance. + + + + + Writes body + + + + + + Writes the background image. + + The pic. + + + + Writes the style sheet. + + The doc. + Name of the CSS file. + + + + Append style sheet + + + + + + + Appends the line. + + The sb. + The textline. + + + + Writes page break before in a span. + + + + + Writes the section. + + The sec. + + + + Writes the footnotes. + + The sec. + + + + Write text body + + + + + + Writes the body item. + + The body item. + + + + Writes the paragraph. + + The paragraph. + + + + Decides whether current field items should be skipped or not. + + Current paragraph item. + + + + + Decides whether the currently writing hyperlink field results. + + Returns true if field stack contains Hyperlinke field. + + + + Writes the paragraph items. + + The para items. + + + + To combine the text in the subsequent textranges whether it has same character format + + + + + + + + Write break + + + + + + As per MS word behavior, to preserve line break properly + Checks whether the break is last renderable items + + + True if break is last renderable item else false + + + + Writes the text box. + + The text box. + + + + Writes the footnote. + + The w footnote. + + + + Write footnote span + + + + + + Writes the footnote attributes. + + + + + Writes the form field. + + The field. + + + + Writes the paragraph or list. + + The paragraph. + + + + Checks whether the list value should write as paragrapgh or not + If m_document.SaveOptions.HTMLExportWithWordCompatiblity is enabled and + listformat pattern type is bullet, then list should written as simple paragraph + + ListFormat + True if the list value should written as paragraph else False + + + + Ensure within Division + + + + + + Write style attribute for paragraph + + + + + + + Adds the decoration style of the text range to inline style of the paragraph + + + + + + + + Check whether the style is heading style + + + + + + + Write List + + + + + + + + + Gets the CharacterFormat of the list + + + + + Copys Character formatting + + + + + + + Ensure whether the style is already defined and appends the style accordingly + + + + + + + + Removes duplicate style attribute entry + + Name of the style + Current style + validated style + + + + Write list start tag + + + + + + + Gets StartAt Value for current list level + + + + + + + Preserve List as paragraph tag + + + + + + + + Write prefix value for List + + + + + + Write tab space for list + + + + + + Get list character for Epub + + + + + + + + Convert Arabic to Roman + + + + + + + Get Prefix value + + + + + + + + Writes the bookmark. + + The bookmark start. + + + + Checks whether the bookmark is form field bookmark + + The bookmark to check + True, if the bookmark belongs to form field else false. + + + + Checks whether the para has only bookmarks + and the current writing bookmark start is last bookmark start of para child entites + + The current writing bookmark start + True if the para has only bookmarks and current writing bookmark start + is last bookmark start of paragrapgh else false + + + + Writes the field. + + The w field. + + + + Pushes the field to FieldStack. + + + + + + Insert Field Begin + + + + + + Write the field mark + + + + + + Writes the hyperlink. + + The hyperlink. + + + + Writes the image. + + The pic. + + + + Writes the text range. + + The w text range. + + + + Get the current layouted custom tab + + + + + + Get the current tab style + + + + + + + + + Get the current tab leader text + + + + + + + + + Get the current tab width + + + + + + + Write the string which contains tab in between letter + + + + + + + + split the text whether it contains control character tab + + + + + + + Write the tab text instead of "\t" with tab leader based on it width + + + + + + + Write the list follow text + + + + + + Write the prefix list tab text + + + + + + + Writes the table. + + The w table. + + + + Check whether the table has misaligned cells + + + + + + + + Write grid before cell + + + + + + Apply default table grid style for the table + + + + + + + Get the bottom border for the Vertically merged cell + + + + + + Get the right border for horizontally merged cell + + + + + + Writes the row of offsets. + + The offsets. + + + + Writes the span attributes. + + The col offsets. + The row offset. + The cell. + + + + Gets the rowspan. + + The cell. + + + + + Gets the cell by offset. + + The w table row. + The row offset. + + + + + Calculates the columns. + + The table. + + + + + Gets the colspan. + + The col offsets. + The row offset. + The p. + + + + + Gets the colspan. + + The cell. + + + + + Writes the cell attributes. + + The cell. + + + + Writes the table attributes. + + The table. + + + + Check whether the border attribute need to preserve + + + + + + + Write table border + + + + + + + Get table border style + + + + + + + + Write table cell spacing + + + + + + Write table width + + + + + + + Write table alignment + + + + + + Gets the table alignment + + + + + + + Writes the row attributes. + + The row. + + + + Check whether all cells in a row is hidden + + Table Row + True if all cells in a row is hidden. Else False + + + + Gets the paddings. + + The paddings. + + + + + Gets the paddings. + + The paddings. + + + + + Get cell padding from table + + + + + + Gets the style. + + The format. + + + + + Checks with Texture and returns the Background color of the cell + + + + + + + Gets the cell background. + + The format. + + + + + Gets the color value. + + The fore color value. + The back color value. + The percent. + + + + + Gets the borders style. + + The cell borders. + The row borders. + The string builder. + The owner cell. + + + + Gets the row border. + + The borders. + The cell. + The side. + + + + + Gets the border style. + + The cell border. + The row border. + The string builder. + The side. + + + + Get table border style based on table border + + + + + + + + Get Cell border color based on table border + + + + + + + s + Get border color + + + + + + + + Get Cell border width based on table border + + + + + + + + Get line width based on border style + + + + + + + Gets the style. + + The format. + + + + + check whether the paragraph contains contextualspacing property or not. + + + + + + Get the paragraph from table. + + + + + + + Get character format style + + + + + + + Get character format style + + + + + + + Gets the HTML equivalent colors for highlight colors in Word document + + + + + Sets the size of the checkBox. + + The style. + The checkBox. + Size of the checkBox. + + + + Gets the color in Hex format + + Color + Hex value + + + + Gets the borders style. + + The borders. + + + + + Gets the border style. + + The prefix. + The border. + The sb. + + + + Converts border style to html border style. + + The style. + + + + + Converts border style to html border style.(For Paragraph border similar to MS Word) + + The style. + + + + + Encodes the name. + + The name. + + + + + Checks the valid symbols. + + The name. + + + + + converting metafile image to bitmap + + + + + + + Processes the image. + + The picture. + The image path. + + + + Writes the empty paragraph. + + The characterformat format. + + + + Writes the text. + + The text. + + + + Get tab Text of which contains 15 non breaking white space and single normal white space + + + + + Replace empty space with non-breaking space + + + + + + + Returns the string with style names (according to their hierarchy) + which are applied on paragraph. + + + + + + + + + + + + + + + + + + + + Close the list + + Paragraph level Number + /// Paragraph + + + + Write the End element + + Difference + + + + Writes the type of the list. + + The type. + + + + Gets the level numer. + + The list format. + + + + + Gets the list start value. + + The format. + + + + + Gets the List start at value + + + + + + + + Ensures the level restart. + + The format. + if set to true full restart is performed. + + + + Returns the Percentage of Color for the TextureStyle + + + + + + + Gets the list format for paragraph. + + The paragraph. + + + + + Gets the outline level + + + + + + + Sort the document Behind Wrap Style floating items based on its Z-Index and swap the z-index values. + + + + + Creates Navigation point + + The paragraph + + + + Checks if heading style is present in the document + + Style name + True if the style is heading style; false otherwise + + + + Replaces special character + + Input text + Replaced text + + + + Returns the heading level of the style + + Style Name + Heading level + + + + Gets new navigation point id + + Id + + + + Gets or sets the value indicating whether to use the absolute path. + + True if absolute path is specified, otherwise false. + + + + Gets the lists. + + The lists. + + + + Gets the Behind wrap style floating items. + + The lists. + + + + Gets the current field. + + The current field. + + + + Gets the previous field. + + The previous field. + + + + Gets the footnotes. + + The footnotes. + + + + Gets the field stack. + + The field stack. + + + + Gets the endnotes. + + The endnotes. + + + + Gets or sets whether to cache files as stream. + + + + + Gets or sets whether to create navigation point + + + + + Gets or sets if the OEB header / footer is created + + + + + Gets the stylesheets to be embedded in document + + + + + Gets the images to be embedded in document + + + + + Returns the bookmarks used to create TOC + + + + + Get or set the value indicating the paragraph has tab + + + + + Get or set the current line width + + + + + Get or set the default tab width + + + + + Get the drawing context + + + + + Get or set the layouted tab list + + + + + Get or set the value indicating the paragraph has tab + + + + + Compares two objects 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. + + Value Condition Less than zero is less than . Zero equals . Greater than zero is greater than . + + Neither nor implements the interface.-or- and are of different types and neither one can handle comparisons with the other. + + + + Converts markdown DOM to DocIO DOM + + + + + Convert markdown to Word DOM. + + Word document + Markdown document + + + + Convert markdown to Word DOM. + + + + + + Apply the paragraph style for code block + + + + + Applies Md paragraph list style to the Wparagraph as list. + + + + + Current block element + + + + Convert the mark down inline items to corresponding word element. + + + + + + + Convert md hyperlink to word hyperlink element and append it to the given word paragraph. + + + + + + + Convert md picture to word picture and append it to the given word paragraph. + + + + + + + Convert md table to word table element. + + + + + + + Convert Mark down text range to Word text range with text range character styles applied. + + + + word paragraph + + + + Replaces the '\\' character with given character from the text. + + + processed text + + + + Gets the table column text alignment based on markdown table column Alignment. + + + Horizontal Alignment type + + + + Add Fenced code style in the Word document. + + + + + Apply Md paragraph style to the WParagraph. + + + + + + + Get list pattern type based on the list level. + + + List pattern type + + + + Closes this instance. + + + + + Represents the Rtf lexer. + + + + + Initializes a new instance of the class. + + The instance. + + + + Reads the Next token from the stream + + + + + + Reads the Next token from the stream + + + + + + Reads control word + + + + + + Reads Document element + + + + + + + Closes this instance. + + + + + Implemented alternative method to improve the performance + + + + + + + + Gets and Sets the imagebytes + + + + + Gets and Sets CommentRange start id + + + + + Gets/Sets Rtf table type + + + + + Gets/Sets Rtf token type + + + + + + + + + + + + + + + Specifies the flags/options for the unmanaged call to the GDI+ method + Metafile.EmfToWmfBits(). + + + + + Parse each token from the rtf + + + + + Remove the text formats from stack which were added due to nested RTF document. + + + + + + Check whether this current group contains pn list related tokens + retrun the bool value + + current object of group class + + + + + Check whether this current group contains "ls" or "ilvl" or "pnlvlbody" token + retrun the bool value + + current object of group class + + + + + Initializes the default compatibility options. + + + + + Closes this instance. + + + + + Add font to the font table collection + + + + + Add color to the color table + + + + + Add styles to the style table collection + + + + + Check whether the style is present in the document + + + + + + + Parse Control start + + + + + Gets whether the group is a nested group + + + + + + Parse group start + + + + + Parse Group End + + + + + Parses the drawing tokens after detecting the shape type. + + + + + Parses the drawing tokens after detecting the picture. + + + + + Moves the body items into the shape. + + + + + + Parse group end within field group + + + + + Ensure whether the end of field sub group(field instruction and field end) + + + + + + + Ensure field group end + + + + + Write Form field properties + + + + + Remove Delimiter space from the document text + + + + + + + Identify whether the token is a picture token + + + + + + Parse document element + + + + + Check whether the current text format is default text format or not. + + + + + + + Encode the string with its code page. + + + + + + + Gets encoding information for the corresponding code page. + + + + + + Gets encoding information for the corresponding code page. + + + + + + Reset the text range fill color to empty. + + Character format + + + + Set field code and formatting to text range. + + + + + + + + Parse field group + + + + + + Parse TOC field + + + + + + + Parse unknown field + + + + + + + Append Textrange + + + + + + Replace Wfield object with WMergeField object + + + + + Apply field properties + + + + + + + + Parse the form fields destination control words + + + + + + Parse Image bytes + + + + + Parse custom document properties + + + + + Parse built-in document properties + + + + + Gets the field type + + + + + + + Get the formatting string + + + + + + + Apply the drop down field specific properties + + + + + + Apply the textform field specific properties + + + + + + Apply the checkbox specific properties + + + + + + Apply the common formfield properties + + + + + + Check whether the current picture/shape need to be skipped or added + + + + + + Append Picture to the current paragraph + + + + + Get the rotation angle for picture. + + Represents the angle of rotation + + + + + Get the buffer size for initialize the rtf reader position for read the upcoming contents. + + Represent the size of the buffer + return the position which needs to be readed by a reader + + + + Get Image bytes from the token + + + + + + + Apply picture Formatting + + + + + Sets AutoShapeType based on rtf because the value of rtf and our AutoShapeType enum values or different. + + + + + + + Apply Shape Formatting + + + + + Apply TextBox Formatting + + + + + + + + Apply the text box formats to shape + + + + + Copy paragraph formatting + + + + + + + Parse control word from the rtf file + + + + + + Skip the group. + + + + + Read the corresponding bulletin character. + + + + + + + Parse list table + + + + + + + + Parse list level start + + + + + Copy Character formatting + + + + + + + Copy base list style to overrided list style + + + + + + + Parse pagenumbering of the section + + + + + + + + Parse line numbering of the section + + + + + + + + Parse font table + + + + + + + + Reset the list font to default font. + + + + + + Checks whether the paragraph exist in shape result or not. + + + + + + + Parse Formatting controls + + + + + + + + Parse the Frame X and Y positions for the paragraph + + The value of the property + True if negative value, else false. + True if X value, else false. + The position value + + + + Reset the paragraph formatting + + + + + Reset Borders + + + + + + Reset Border + + + + + + Reset the character format + + + + + Get equal column width of the section + + + + + + + Parse special characters + + + + + + Check whether the accent character need to be omitted + + + + + + Get Texture style + + + + + + + Parse listtext start + + + + + Parse paragraph end + + + + + Parse paragraph start + + + + + Parse section start + + + + + Copy Section formatting + + + + + + + Parse row Start + + + + + Parse Row End + + + + + Parse Cell boundary + + + + + + + + Gets the text wrap around. + + The positioning. + + + + + Parses Accented character + + + + + + + + Get the code page for the current Font character set + + + + + + Determines whether current code page is single byte encoding. + + + true if [is single byte]; otherwise, false. + + + + + Get Font Character Set + + + + + + Determine Whether the code page is supported for Encoding + + + + + + + Get the code page is supported for Encoding + + + + + + + Set the default value of the paragraph format + + + + + + Process the table information based on the levels + + + + + Ensure the lower level tables + + Current paragraph level + + + + Ensure the upper level tables + + Currentl paragraph level + + + + Apply list formatting + + + + + Apply Section formatting + + + + + Parse the shape and textbox related tokens + + + + + + + Set the Default values for Shape in Text Box + If the shape is True in text Box then textbox need to set this value + + + + + Get the TextBox LineStyle to TextBox shape Line Style + + + + + + Sets the rotation value of a shape + + + + + + Adds the shadow distance and direction + + + + + Add the Adjust Values for each shape + + + + + Adds the required values into the stack before reading the another shape + + + + + Adds the required values into the stack before reading the shape textbody. + + + + + Clears the values in previous textbody. + + + + + Resets the m_pictureOrShapeStack after reading the shape textbody. + + + + + Resets the required values after reading the shape textbody. + + + + + Parse picture token + + + + + + + + Get Int Value + + + + + + + Parse Vertical alignment of the page + + + + + + + + Parse outline levels + + + + + + + + Parse Borders + + + + + + + + Appply cell formatting + + + + + + + Apply Row formatting + + + + + + + Apply cell border + + + + + + + Adds the new paragraph to the current section + + + + + Update Paragraph Tabs collection + + + + + + Update tabs with type as clear from BaseFormat to direct paragraph formatting + + + + + + + Add new section to the current document + + + + + Extract the Twips value from the token + + + + + + Extract the Quater point value from the token + + + + + + + Sort Tab Collection based on Tab position + + + + + Seperate Token keyword from the token Value + + + + + + + Checks and get the alternate or default font index + + Current Textformat + Current Character format + Returns the font index value + + + + Check whether the property value is same as in its paragraph style + + Para style character format + Property key + Property value in text format + True, if the para style and text format value of the current property is same + + + + Copy Textformating to the character format + + + + + + + Apply font for the current paragraph + + + + + Apply font color for the current text + + + + + + Implemented alternative method to improve the performance + + + + + + + + Sets the parsed element flag. + + The token. + + + + Sets the shape elements flag. + + The shape type value. + + + + Gets/Sets the value indicating whether the stylesheet group is started. + + + + + Gets/Sets the value indicating whether need to create new list style for PN list style numbering. + + + + + Gets/Sets the value indicating when the current section contains sectd tag. + + + + + Get's or set's the Default code page of the document + + + + + Get's or set's the Default font index value + + + + + Checks whether the control word is destination control word + + + + + Gets whether the group is form field group + + + + + Gets whether the group is field group + + + + + Gets the current paragraph level + + + + + Gets the previous paragraph level + + + + + Gets the current TextBody + + + + + Gets the current para. + + The current para. + + + + Gets and Sets the current column + + + + + Gets the current section + + + + + Gets and sets the current list style + + + + + Gets and sets the current list override style + + + + + Gets the current comment. + + The current comment. + + + + Gets the comments id list. + + The comments id list. + + + + Holds the text which enclosed by the comment tags + + The comments id list. + + + + Holds the collection of Comment along with its ID + + The comments id list. + + + + Gets and Sets the current list level + + + + + Gets and Sets the current Rtf font + + + + + Gets and sets the current color table + + + + + Gets and Sets the current table + + + + + Gets and Sets the current row + + + + + Gets and Sets the current cell + + + + + Gets and Sets the current cell format + + + + + Gets/Sets the current row format + + + + + Gets/Sets the current tab format + + + + + Hold the shape property value temporarily until find the shapeType token + + + + + Initialize the Values + + + + + + + Text format class + + + + + Specifies Vertical position of the Character + + + + + Specifies scaling percentage of the Character. + + + + + Specifies the character spacing of the text + + + + + Specifies Bold format. + + + + + Specifies Italic format. + + + + + Specifies Underline format. + + + + + Specifies Strike format. + + + + + Specifies DoubleStrike format. + + + + + Specifies Emboss format. + + + + + Specifies Engrave format. + + + + + Specifies SubSuperscript Format + + + + + Specifies font color of the text. + + + + + Specifies back color of the text. + + + + + Specifies fore color of the text. + + + + + Specifies Hightlight color of the text. + + + + + Specifies the font family. + + + + + Specifies the font size. + + + + + Specifies the text alignment. + + + + + Specifies the text style. + + + + + Clones this instance. + + + + + + Gets or sets the ASCII locale id . + + The ASCII locale id . + + + + Gets or sets the far east locale id . + + The far east locale id . + + + + character spacing of the text + + + + + Gets or sets the complex script locale id . + + The far east locale id . + + + + Specifies Vertical position of the Character + + + + + Specifies scaling percentage of the Character + + + + + Specifies Highlight color of the Text + + + + + Specifies whether the text is bidirectional + + + + + Specifies the text direction is right-to-left + + + + + Section Format class + + + + + Gets/sets the bin in which the first page of the section will be printed + + + + + Gets/sets the bin in which the other pages of the section will be printed + + + + + Picture format class + + + + + Shape Format Class + + + + + Returns the Size of shape + + + + + Gets the Size of Shape + + + + + Represents the group for RTF document. + + + + + Get Groups's object from the childElements collection + Set Groups's object into collection + + + + + Represents token for RTF document + + + + + Gets/Sets the value of token + + + + + Gets/Sets the value of token + + + + + Represents the form fields information + + + + + represents the value of ffname token + + + + + Represents the value of ffhelptext + + + + + Represents the value of ffstattext + + + + + Represents the field type w.r.t the value of the fftypeN + + + + + Represents the value of ffrecalcN + + + + + Represents the value of ffentrymcr + + + + + Represents the value of ffexitmcr + + + + + Represents the value of ffprotN + + + + + Represents the value of ffhpsN + + + + + Represents the checkbox type specified by the token ffsizeN + + + + + Represents the value of ffdeftext + + + + + Represents the value of ffformat + + + + + Represents the value of ffmaxlenN + + + + + Represents the collection of values of ffl control word + + + + + Represents the value of ffhaslistboxN + + + + + Represents the value of ffres + + + + + Respresents the value of ffdefres + + + + + Respresents the value of ffdefres for check box + + + + + Gets/Sets the checked status of the check box + + + + + Gets or sets + + + + + Gets or sets the maximum number of character allowed in text form field. + + + + + Gets or sets the string format + + + + + Gets or sets the default text for the textform field + + + + + Gets or sets the checkbox size type (Auto/Exactly) + + + + + Gets or sets the checkbox size. This size will be reflected only when the checkbox size is of Exactly type + + + + + Gets or sets the value which protects this form field + + + + + Gets or sets the Macro name to execute upon exit into this form fie + + + + + Gets or sets the Macro name to execute upon entry into this form fie + + + + + Gets or ets the form field name. + + + + + Gets or sets the help text string. + + + + + Gets or sets the boolean value which represents whether the field should be calculated on exit or not + + + + + Gets or sets the status line text + + + + + Gets or sets the formfield type. + + + + + Clones this instance. + + + + + + Get/Set the alternate font name to use if the font specified in the font table is not available. + + + + + Gets and Sets the tab position + + + + + Gets and Sets the justification for the tab + + + + + Gets and sets the tab leader + + + + + Gets and Sets the Red component value + + + + + Gets and Sets the green component value + + + + + Gets and Sets the blue component value + + + + + Represents the details for the table representation based on the paragraph level. + + + + + Updates the specified reader. + + The reader. + The prev level. + + + + Represents the Rtf reader. + + + + + Initializes a new instance of the class. + + The instance. + + + + Read a single character + + + + + + Reads the image bytes from the stream + + + + + + Closes this instance. + + + + + Gets the Rtf data + + + + + Gets the encoding. + + + + + Gets and Sets the current position in data buffer. + + + + + Gets and Sets the data buffer length + + + + + Converts dls document into rtf format + + + + + Collection of font table entries - to avoid serialization of duplicate font entries in fonttbl + + + + + Writes document to the file specified by filename + + Name of the file. + The document. + + + + Writers WordDocument to the specified stream. + + The stream. + The document. + + + + Gets the RTF text. + + The document. + + + + + Writes the body of document. + + + + + Build the document page informations. + + + + + Builds the default styles. + + + + + + Builds the sections. + + + + + Builds the background. + + + + + Builds the section. + + The section. + + + + Builds the section body items. + + The section body item collection. + + + + Builds the body items. + + The body item collection. + + + + Builds the headers and footers. + + The headers footers. + + + + Gets the watermark for each headers. + + + + + + + Builds the header footer. + + The name. + The body item collection. + + + + Builds the paragraph. + + The paragraph. + + + + Compare the list format of paragraph + + + + + + + Check whether the previous paragraph has fieldend + + + + + + + Builds the paragraph end. + + The paragraph. + + + + Write sect token. + + The Memory Stream. + + + + Builds the character format. + + The character format. + + + + + Gets the RTF control word for paragraph alignment. + + + + + + + + Builds the paragraph format. + + The p format. + if it is append style, set to true. + + + + + Builds the paragraph format. + + The p format. + if it is append style, set to true. + + + + + Builds the paragraph spacing. + + The paragraph format. + The style paragraph format. + + + + + Builds the spacing. + + The attribute. + The value. + + + + + Builds the auto spacing. + + The value. + if it has spacing, set to true. + + + + + Builds the line spacing. + + The paragraph format. + + + + + Builds the texture style. + + The texture style. + + + + + Builds the section properties. + + The section. + + + + Builds the page setup. + + The page setup. + + + + + Builds the page number style. + + The page number style. + + + + + Builds the columns. + + The column collection. + + + + + Builds the underline style. + + The under line style. + The string builder. + + + + Builds all tab from tab collection. + + The tab collection. + + + + + Builds the paragraph borders. + + The paragraph format. + + + + + Builds the page borders. + + The borders. + + + + + Builds the border. + + The border. + + + + + Builds the border style. + + The border style. + + + + + Builds the style sheet. + + + + + Builds the style. + + The style. + + + + Builds the style. + + Name of the style. + + + + Builds the text border. + + The border. + + + + Builds the frame property. + + The paragraph format. + + + + + Builds the paragraph list id. + + The paragraph. + The paragraph format. + + + + + Builds the table. + + The table. + + + + Builds the table row. + + The table row. + + + + Builds the Table row property. + + The table row. + + + + Builds the Table cell property. + + The table cell format. + + + + + Builds the Table row borders. + + The borders. + + + + + Builds the Table cell borders. + + The cell. + The cell borders. + The row borders. + + + + + Builds the table cell. + + The table cell. + + + + Builds the padding. + + The paddings. + if set to true [is row]. + + + + + Builds the vertical alignment. + + The alignment. + + + + + Checks the cell borders. + + The table cell. + Type of the border. + + + + + Builds the paragraph item. + + The paragraph item. + + + + Builds the symbol. + + The symbol. + + + + Builds the footnote/endnote. + + The footnote. + + + + Builds the footnote property. + + The footnote. + + + + Builds the endnote property. + + + + + Builds the field mark. + + The field mark. + + + + Builds the field. + + The field. + + + + Inserts the line break. + + The Break. + + + + Builds the text range. + + The text range. + + + + Inserts the Bookmark end. + + The bookmark end. + + + + Inserts the Bookmark start. + + The bookmark start. + + + + Builds the toc field. + + The toc. + + + + Builds the picture. + + The picture. + + + + Builds the shape image. + + The picture. + + + + Builds the Inline Image. + + The picture. + + + + Builds the shape image. + + The shape. + + + + Write the Basic Shape Tokens + + + + + + + Write the Shape Position tokens + + + + + + + Write Shape Object Type tokens + + + + + + + Write Shape Horizontal Line tokens + + + + + + + Write Shape Line tokens + + + + + + + Write Shape Fill tokens + + + + + + + Gets the RTF AutoShape Color + + + + + + + Write Shape Adjust Values tokens + + + + + + + Write Shape Shadow tokens + + + + + + + Gets Offset X and Y if the parsing done in docx + + + + + + + Write Shape 3D tokens + + + + + + + If the document parsed from docx then the adjust value format is different + So convert the docx adjust values to rtf adjust values for each shape. + + + + + + + Builds the extrusion from plane. + + + + + Builds the extrusion from plane. + + + + + Determine whether the image is WMF format + + + + + + + Builds the picture property. + + The picture. + + + + + Builds the metafile properties. + + The picture. + + + + + Gets the RTF image. + + The image. + + + + + Use the EmfToWmfBits function in the GDI+ specification to convert a + Enhanced Metafile to a Windows Metafile + + + A handle to the Enhanced Metafile to be converted + + + The size of the buffer used to store the Windows Metafile bits returned + + + An array of bytes used to hold the Windows Metafile bits returned + + + The mapping mode of the image. This control uses MM_ANISOTROPIC. + + + Flags used to specify the format of the Windows Metafile returned + + + + + Deletes an enhanced-format metafile or an enhanced-format metafile handle. + + A handle to an enhanced metafile. + If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. + + + + Builds the wrapping style. + + The wrapping style. + The wrapping type. + + + + + Builds the wrapping type. + + The text wrapping type. + + + + + Builds the shape property. + + Name of the property. + The property value. + + + + + Sets AutoShapeType based on rtf because the value of rtf and our AutoShapeType enum values or different. + + + + + + + Sets Linestyle based on rtf because the value of rtf and our Linestyle enum values or different. + + + + + + + Builds the layout in cell token. + + The value that represents whether a picture in a table is displayed inside or outside the table. + + + + + Builds the horizontal alignment. + + The shape horizontal alignm. + + + + + Builds the vertical alignment. + + The shape vertical alignm. + + + + + Build textbox visible or not + + + + + + + Builds the horizontal position. + + The horizontal position. + + + + + Builds the vertical position. + + The vertical position. + + + + + Builds the shape position. + + The horizontal position. + The vertical position. + The shape width * shape horizontal scale. + The shape height * shape vertical scale. + + + + + Builds the text box. + + The text box. + + + + Build textbox position related tokens. + + + + + + + + Build textbox fill related tokens. + + + + + + + + Build TextBox Line Related Tokens + + + + + + + + Builds the text flow in text box + + + + + Builds the text box wrapping style + + The text wrapping style + + + + + Builds the text box line style. + + The line style. + + + + + Builds the shape lines. + + The line color. + The line dashing. + Width of the line. + + + + + Builds the shape fill. + + The color. + + + + + Builds the gradient variant. + + The gradient variant. + + + + + Appends the list styles to list table. + + The list styles. + + + + Builds the list level. + + The list level. + + + + + Updates the list numbering prefix. + + The prefix. + + + + + Builds the level text. + + The list level. + + + + + Builds the level numbers. + + The list level. + + + + + Gets the level text length. + + The level text. + + + + + Gets the level text. + + The list level. + whether numberSuffix need to be added or not based on level numbers + + + + + Builds the level formatting. + + The type of number. + + + + + Appends the override list style. + + + + + Builds the list text for paragraph. + + The para. + + + + + Builds the list text for paragraph. + + The list level. + + + + + Gets the List start value. + + The list format. + + + + + Builds the List letter symbol. + + The list format. + + + + + Determines whether the specified text is changed. + + The text. + + true if the specified text is changed; otherwise, false. + + + + + Checks the number prefix. + + The number prefix. + + true if [is complex list] [the specified prefix]; otherwise, false. + + + + + Builds the picture watermark body. + + The pic watermark. + + + + + Builds the text watermark body ( property ). + + The text watermark. + + + + + Builds the default watermark property. + + + + + + Builds the text form field. + + The text field. + + + + + Builds the check box. + + The check box. + + + + + Builds the drop down field. + + The drop down field. + + + + + Builds the form fields. + + The form field. + + + + + Builds the comment mark. + + The c mark. + + + + + Builds the comment. + + The comment. + + + + + Builds the Commnet items. + + The comment. + + + + Checks whether there are no or empty items between the comment range + + Comment to check + True, if the comment has non empty string between comment range start and end, Otherwise return False + + + + Sets the color value. + + The character format. + Color + The base character format. + Color + The option key. + The value. + + + + + Builds Highlight color with name + + The color. + The value. + + + + + Builds color with name + + The color. + The value. + + + + + Checks the section for footnotes/endnotes. + + + + + Builds field type. + + The type. + + + + + Gets the color of the RTF format shape. + + The color. + + + + + Gets the color of the RTF format shape. + + The color. + + + + + Writes the elements. + + The param. + + + + Generate next font id. + + if set to true [is bidi]. + + + + + Gets the next id. + + + + + + Gets the next color id. + + + + + + Check whether the font entries exists in the font table + + + + + + + Appends the font to the FonrString. + + The font id. + The format. + + + + Appends the color to the ColorString. + + The color. + The attribute string. + + + + + Writes the font names. + + The character format. + + + + + Writes the font name bidi. + + The character format. + + + + + Writes the paragraph end. + + The para. + + + + + Prepares the text. + + The text. + + + + + Replace unicode characters. + + The text. + + + + + Builds the text range. + + The character format. + The text. + + + + + Writes the field end. + + The field mark. + + + + + Gets the owner section. + + The entity. + + + + + Inits the cell end pos. + + + + + Gets the document lists ids. + + The lists ids. + + + + Gets a dictionary that maps document list IDs to their equivalent long values. + Initializes the dictionary if it is null. + + + A Dictionary<int,long> where the key is the document list ID and the value is the equivalent long ID. + + + + + Gets the list override array. + + The list override ar. + + + + Gets the styles. + + The styles. + + + + Gets the style numb. + + The style numb. + + + + Gets the lists. + + The lists. + + + + Gets the comment ids. + + The comment ids. + + + + + + + + + Gets the color table. + + The color table. + + + + Row borders + + + + + Right border + + + + + Left border + + + + + Top border + + + + + Bottom border + + + + + Represents the parser for MS Word 2010 generated document. + + + + + Reads the specified document path. + + The document path. + The Word document. + + + + + Reads the Word ML from filename + + The file name. + Instance of Word document. + + + + + Read the Word 2003Xml document + + The document stream. + Instance of Word document. + + + + + Read and skip white spaces. + + + + + + Reads FlatOPC document from the stream. + + Stream to read data from. + + + + Reads the specified data stream. + + The document stream. + Instance of Word document. + + + + + Reads the Word ML stream + + The document stream. + Instance of Word document. + + + + + Gets the decrypted document stream. + + The stream. + The doc. + + + + + Reads the word document + + The Word Document + + + + Update the main document path + + + + + Get the path by its content type + + The extension. + + + + Get the content type of extension + + The extension. + + + + Get Format Type based AppVersion. + + The document. + + + + Updates the document format type. + + The document. + + + + Parse the document and its relations + + + + + + Check and Filters the Xml parts. + + partcontainer having customXml + The custom xml partcontainer after removing the XML which doesn't has relationship + + + + Check and sort the xml parts as per Rid + + partcontainer having customXml + + + + Binds the custom XML data into Content controls. + + PartContainer. + + + + Parse the meta data properties in custom xml part. + + + + + + Sets the xPath from the list of content control + + The custom xml part container + The inline content control + The block content control + The cell content control + + + + Checks whether the custom XML parts contain a "Props" part. + + The container of custom xml parts. + True if a "Props" part is found; otherwise false. + + + + Maps the content to the content control + + + + + + + + Reset the resultant text to the cell content control + + The xml part container + The cell content control + + + + Resets the cell content controls. + + Cell controls. + Root element. + + + + Reset the resultant text to the block content control + + The xml part container + The block content control for which the text to be mapped + + + + Resets the block content controls. + + Block controls. + Root element. + + + + Sets the resultant builtin property value to the content control + + + + + Reset the resultant text to the inline content control + + The xml part container + The inline content control for which the text to be mapped + + + + Resets the inline content controls. + + Inline controls. + Root element. + + + + + Gets the list path from params + + + + + Gets the list path + + + + + Gets the index from the node path + + + + + Gets the resultant child node from the child nodes + + + + + Check whether the current node is from a valid parent. + + + + + Checks whether the current node has expected attributes as mentioned in Xpath + + + + + Returns the result text for the cell content control + + + + + Returns the result text for the block content control + + + + + Get the attributes of the xpath + + + + + Extract the correct date format. + + + + + Checks and converted the binded xml text into proper date time format. + + Binded xml text. + True if the binded xml text is in specified date time format; otherwise false. + + + + If the content from WordML is empty, then set 5 spaces as default + + + + + Determines whether the paragraph items in paragraph is empty + + paragraph + returns true if paragraph is empty + + + + Determines whether the paragraph is empty + + paragraph + returns true if paragraph is empty + + + + Get the 5 empty spaces from WordML + + + + + Converts the WordML format into text. + + The inline content control. + Mapped text of the content control. + + + + Maps the WordML to block content control + + The block content control. + The text body that contains the items need to be added to the content control. + + + + Converts the WordML format into text. + + The block content control. + Mapped text of the content control. + + + + Converts the WordML format into text. + + The cell content control. + Mapped text of the content control. + + + + Checks whether the text is WordML format document. + + Mapped text of the content control. + True if text is WordML format, otherwise false. + + + + Sets the mapped cell to the cell content control + + The table cell + The resultant mapped text + + + + Sets the mapped picture to the block content control + + + + + + + Sets the mapped picture to the inline content control + + + + + + + Sets the mapped text to the cell content control + + + + + + + Set the default picture and check if the picture is default or not. + + + + + + + + Set the default height and width and default picture to the content control. + + + + + + + + Check whether the picture is default redX picture. + + + + + + + Updates the base64 image in the picture content control. + + + + + + + Sets the mapped paragraph to the block content control + + The block content control + The resultant mapped text + + + + Checks whether the document has glossary document + + + + + + Checks whether need to map placeholder from glossary document to content control + + + + + + + + Checks whether need to map Databinding Value from glossary document to content control + + + + + + + + Parse glossary document and map the place holder text + + + + + + Clear the items in block content control except the last paragraph + + + + + Mapped the paragraphs in docpart to content control + + + + + Parse docpart in glossary document + + + + + + + + Check whether content control need to preserve five non breaking space as place holder text + + + + + + + Copy the formattings from content control to text range. + + + + + + + Sets the mapped text to the inline content control + + The inline content control + The resultant mapped text + + + + Replaces the break chars from text. + + Text to replace with break chars. + The text. + + + + Replaces the break chars as soft breaks. + + Text to replace with break chars. + The text. + + + + Clears the parsed image from package. + + Name of the image. + Name of the container. + + + + Parse the theme xml part + + Theme part stream + + + + Parse the theme elements + + XmlReader + + + + Parse the Format Scheme + + + + + Parse the Effect style Scheme + + + + + Parse the Effect style list of themes scheme + + + + + Gets the shape property value + + + + + Parse the Shape ThreeD properties(sp3d). + + + + + Parse the Effect list items + + + + + Parse the fill style list + + + + + Parses the color transform. + + The reader. + The parent element. + Color of the theme. + The opacity. + + + + Parses the theme element gradient fill of the Fill Style List. + + The reader. + The gradient fill. + + + + Parses the theme elements gradient stop. + + The reader. + The gradient fill. + + + + Parse the Line Style Scheme + + + + + Parse the Line Style + + Theme part stream + + + + Parse the Font Scheme + + Theme part stream + + + + Parse the Scheme Color + + Theme part stream + + + + Gets the name of the base font. + + The reader. + if it is major, set to true. + + + + + Extract the DocProperties part + + Docx package + + + + Parses the vba project. + + The stream. + + + + Parses the vba project signature. + + The stream. + + + + Parses the vba project signature agile. + + The stream. + + + + Parses the vba data. + + The stream. + + + + Parses the macro data. + + The reader. + + + + Parses the doc events. + + The reader. + + + + Parses the font table. + + The stream. + + + + Parses the fonts of Word 2003 XML document. + + The reader. + + + + Update Font Table + + + + + Parse the Word 2003 Xml font details + + The reader + The fontName + + + + Parses the font details. + + The reader. + The fontName. + + + + Get Bytes from string + + + + + + Parse the document + + The document.xml stream + + + + Check whether the current table could merge with its previous table or not. + + + + + + + check whether the previous table row's IsHeader property true of false. + + + True if IsHeader property is true, otherwise false. + + + + Parse the document body + + The Xml reader + The entity + A flag represents true if the body to parse is nested body element, + false if it is normal body element. + + + + Parses a block content control. + + The XML reader containing the block content control. + The entity to add block content control. + + + + Performs post-processing tasks for a block content control. + + The block content control to post-process. + + + + Check the postParaItemsCollection has other than Bookmark And Editables Ranges + + True, if postParaItemsCollection has other than Bookmark And Editables Ranges otherwise False + + + + Update the nested paragraph child entities to the previous paragraph. + + Nested paragraph instance + + + + Modify the object model of StructureDocumentTagBlock whether the paragraph in the SDTContent has section break + + + + + + Add the paragraph to the corresponding textbody + + + + + + + Add the post paraItems to the paragraph + + The paragraph + + + + Adds the bookmarks to the alternate chunk bookmark collection. + + The alternate chunk. + + + + Parse the pargraph element + + Xml reader + The paragraph object + + + + Parse the nested paragraphs + + Xml reader + Outer paragraph items collection + + + + Parses a nested table inside a paragraph. + + The xml reader. + The outer paragraph items collection. + + + + Moves the paragraph items before the nested table to the first paragraph inside the table. + + The collection of paragraph items to be moved. + The first paragraph inside the table where the items will be moved. + A boolean indicating whether the nested table is inside an inline content control. + + + + Apply the directional override to the character format + + + + + + Update insert/delete content control revision. + + The revision type. + ParagraphItem Collection. + + + + Parses the comment. + + The reader. + + + + Parses the 2003 format comment. + + The reader. + + + + Parse the comments part (comments.xml) + + + + + Parses the comment start. + + The reader. + The paragraph. + + + + Parses the comment end. + + The reader. + The paragraph. + + + + Update comments stack + + The id of the specific comment + + + + Updates the commented items. + + The item. + + + + Parses the comments extended + + The reader + + + + Parse the comment extended + + The reader + + + + Parse the table + + The XmlReader + The Table + + + + Parse the table + + The XmlReader + The Table + + + + Check the grid span of the table and update the grid span if it is same for all columns + + Current table + + + + Checks whether the gridafter need to consider for update table grid + + + + + + + Update the table cell width if width was not specified and type was none or auto. + + The Table + + + + Parse the table row + + The Xml reader + The table row + + + + Add the AlternateChunk to textbody. + + tablecell + + + + Parse Structure document tag cell + + + + + + + + Parse structure document tag cell content + + + + + + + + Parses Structure document tag row content + + Reader + StructureDocumentTagRow + WTable + + + + + Parse the table cell + + The xml reader + The table cell + + + + Parse the table cell properties (CellFormat) + + The Xml reader + The table cell + + + + return true if row's first cell width was not defined and type was none or auto. + + + + + return true if cells width types are none or auto and width 0. + + + + + Parses the change cell format + + + + + + + Parse the cell shadings + + The xmlreader + The table cell + + + + Parse the cell vertical Merge + + + + + + + Parse the cell horizontal Merge + + + + + + + Parse the cell vertical alignment + + The Xmlreader + + + + + Parse the text direction of the cell from Word2003. + + The xmlreader + The CellFormat + + + + Parse the text direction of the cell. + + The xmlreader + The CellFormat + + + + Parse the cell Width + + + + + + + Updates the width of the cell. + + The cell. + + + + Updates the width of the cell. + + The cell. + The grid span. + + + + Update the cell width based on revision value grid span + + The current cell + The revision value of grid span + + + + Parse the Table row properties + + The xml reader + The table row. + + + + Parses the change row format + + + + + + + Gets the attribute value. + + The reader. + Name of the attribute. + The attribute namespace. + + + + + Parse the table row height + + The xmlreader + The table row + + + + Applies table properties on table row. + + The table row + The table + + + + Updates the table borders. + + The XML table format. + + + + Parse the table properties + + The xmlreader + The entity + + + + Parses the change table properties + + The xmlreader + The table + + + + Converts the string to its corresponding Integer value + + + + + + + Converts the string to its corresponding Integer value + + + + + + + Parses the table title. + + The reader. + The table. + + + + Parses the table description. + + The reader. + The table. + + + + Parses the table look. + + The reader. + The table. + + + + Gets the bool value. + + The value. + + + + + Get th + + + + + + + + Gets the table look value. + + The reader. + The name. + + + + Parse the table margins + + + + + + + Parse the table margins + + + + + + + Get the corresponding paddings wrt the entity + + The entity + The paddings + + + + Parse the table justification + + + + + + + Parses the table absolute positioning. + + The reader. + The table. + + + + Parses the tables' vertical relation. + + The positioning. + The position. + + + + Parses the table vertical relation. + + The positioning. + The position. + + + + Parses the table absolute horizontal positioning. + + The positioning. + The position. + + + + Parses the tables' absolute horizontal positioning. + + The positioning. + The position. + + + + Parse the table shadings + + The xml reader + The row format + + + + Parse the table layout element + + The xmlreader + The rowformat + + + + Parse the table style element + + The xmlreader + The table + + + + Get the corresponding row format based on the entity + + The entity + + + + + Parse the table grid element + + The xml reader + The table + + + + + Add a table to the corresponding the textbody + + + + + + + Parse the Hyperlink + + The xml reader + The paragraph element + Returns true if it is called from picture hyperlink. + + + + Get the relation + + The relation id + + + + + Parses the hyperlink text. + + The reader. + The paragraph + + + + Parse the Field Simple + + The xml reader + The paragraph + + + + + Get the particular bookmark name by its ID from BookmarkInfo collection + + The bookmark id. + The bookmark name + + + + Removes the particular bookmark name by its ID from BookmarkInfo collection + + The bookmark id. + + + + Parses the bookmark end. + + The reader. + The para items. + + + + Checks whether the paraItems has renderable items or not + + + + True If para items has no renderable item else False + + + + Parse the bookmark end element + + The xml reader + The entity + + + + Checks whether the bookmark end is added to the collection if previous element is alternate chunk. + + The bookmark end. + Then bookmark name. + The entity. + The attribute value. + + true if bookmark end is added; otherwise, false. + + + + + Gets the paragraph which contains end. + + The cell. + + + + + Gets the paragraph which contains end. + + The cell. + + + + + Parse the bookmark start element + + The xml reader + The paragraph + + + + Parse the move range end when it exists between paragraph,table,table row, cell. + + + + + + + Parses the editable range end. + + The reader. + The para items. + + + + Parse the editable range end element + + The xml reader + The entity + + + + Gets a based on the bookmark or editable range specified in text body. + + Represents a textbody item contains reference mark. + Returns a contains bookmark or editable range. + + + + Gets the paragraph based on the bookmark or editablerange specified in the text body + + Represents a textbody item contains reference mark. + A flag which denotes whether reference mark is after a table. + Returns a where the bookmark or editable range is specified. + + + + Gets the owner paragraph of mathametical eqautions. + + + + + + + Parse the editable range start element + + The xml reader + The paragraph + + + + Create the character format for the current text range. + + + + + + Parse the run element + + The xml reader + The paragraph + Bool to ensure whether the parsing call from text body parsing + + + + Parse the run element + + The xml reader + The paragraph + Returns whether isEmptyElement condition is checked or not + + + + Checks whether choice item added into paragraph items. + + + + + + + Gets the Shape line fill type + + The shape + + + + + + + + + + + + + + + + + + + + Parses the Absolute tabs + + The xml reader + + + + Parse the field mark element + + The xml reader + The entity + + + + Check whether ffData element is present as field mark child elements + + + + + + + Check whether Oleobject is present for skipping in Word 2003 XML + + + + + + + Process the Field mark seperator + + The paragraph + + + + Process the field mark end + + + + + + Insert the begin - field mark + + + + + Update the type of unknow field. + + Current field. + Current field mark. + + + + Appends PAGE field for "pgNum" element into paragraph items. + + Paragraph item collection + + + + Parse the form field's data + + The xml reader + The entity + + + + Parse the form fields + + The xml reader + The Form field. + + + + Parses the drop down form field. + + The xml reader. + The dropdown Form field + + + + Parses the textform field. + + The xml reader. + The textForm field + + + + Parses the text format. + + The format. + + + + Parses the type of the text formfield. + + The type. + + + + + Parses the check box. + + The xml reader. + The Checkbox. + + + + Gets the form field object. + + The node. + + + + Parse the Footnote/Endnote part from Word2003. + + the reader + is Footnote + + + + + Parse the Footnote.xml / Endnote.xml part + + Bool flag to denote footnote or endnote + The table row. + + + + Parses the footnote endnote. + + The reader. + + + + + Gets the footnote by ID. + + if it is footnote, set to true. + The id. + + + + + Parses the footnote entnote symbol. + + The reader. + The footnote. + + + + Moves to next line. + + The reader. + + + + + + + + + + Parse the objects + + + + + + + Check whether the field result is from link field or not + + + + + Parse the ole object + + + + + + + Parse the ole objects picture wrapping style. + + + + + + + Parse the ole data + + + + + + + Gets the OLE part. + + The OLE id. + + + + + Gets the OLE link path. + + The id. + + + + + Determines whether the container is the native data. + + The type. + + true if the container is the native data; otherwise, false. + + + + + Check whether the mentioned node exists or not + + + + + + + + Parses the shape + + The xml reader + The Paragraph Items + The Drawing stream. + Memory Stream + The choice shape + + + + Check whether the shape is VML custom shape or not + + The Shapetype + The shape stream + + + + + Parses the Extrusion Effect(TheeD effect in 2007 format document) + + + + + Gets the Extrusion value + + The value + + + + Gets the Extrusion Axis + + The Effect Format + The attribute value + Attribute name + + + + Parse shape 2007 shadow effect + + The Shape + The Shadow Stream + + + + Gets the shadow offsets + + + + + Parse the Fill offsets + + + + + Gets the point value. + + + + + + + Gets the shadow type. + + Shadow Type + + + + + Parses the Xml Relations. + + The Shape + The shape stream + + + + + Parses the Xml Relations. + + The Shape + The shape stream + + + + + Prases the Group shape + + Group shape stream + + + + + Parse the shape + + Shape Stream + The drawing stream. + + + + Parses 2007 Shapes + + The xml reader + The Shape + + + + Parse 2007 Group Shape + + + + + + + Parse 2007 Group shape items + + The xml reader + The Shape + + + + Updates the AutoShapeType for child shapes. + + + + + Parse 2007 Group shape items + + The xml reader + + + + + Parses Textbox Wrap Style + + The xml reader + The Shape. + + + + Parse the TextBox + + The xml reader + The Shape + + + + Parse the TextBox + + The xml reader + The Shape + + + + Parses 2007 shape Fill effect + + The reader. + The Shape + + + + Parses 2007 shape Fill effect + + The reader. + The Shape + + + + Parses 2007 shape Fill effect + + The reader. + The Shape + + + + Parses the 2007 shape fill transparency + + The opacity value. + + + + Gets the angle + + The angle value. + + + + Parses the 2007 gradient fill + + The reader. + The Gradient Fill. + + + + Parses the focus position for the gradient fill of the shape the Table row properties + + The xml reader + The Gradient Fill. + + + + To parse 2007 shape textbody content + + + + + + + To Get the textbox's style + + + + + To Get the shape/textbox's text direction + + + + + To parse stroke effect of 2007 shape + + The reader + The shape + + + + To parse stroke effect of 2007 shape + + The reader + The shape + + + + Parse 2007 shape properties + + The reader + Group shape + + + + Parse 2007 shape properties + + The reader + Child shape + + + + To parser line shape properties + + The xml reader + Group shape + + + + To parser line shape properties + + The xml reader + Child shape + + + + To parse Horizontal rule + + The xml reader + The group shape + + + + To parse 2007 shave effects + + The reader + The group shape + + + + To parse 2007 shave effects + + The xml reader + The child shape + + + + To Apply 2007 shape properties + + Group shape + The property name + The property value + + + + To Apply 2007 shape properties + + Child shape + The property name + The value + + + + Parse drawing properties of the shape + + + + + + + Get the base entity + + + + + + + Parses the text watermark. + + The node. + The ent. + + + + Read the text watermark properties. + + + + + + + Parses the text watermark position. + + The reader. + The water. + + + + Parse text watermark positions. + + + + + + + + Parses the size of the font name and. + + The reader. + The ent. + The shape H. + The shape W. + + + + Reads the specified attribute value from the stream. + + The stream. + The element name. + The attribute name. + The namespace. + The flag to read empty string. + Returns the specified attribute value. + + + + To find the element by its value + + + + + + + + + Parses the picture shape from stream. + + The shape stream. + + + + + Parses the picture shape from reader. + + The reader. + The entity. + + + + Read the binData element string which contain Image in base 64 fomrat + + + + + + + Sets the brightness value for the image from float value ranges. + + The picture. + The float value. + + + + Sets the brightness value for the image. + + The picture. + The decimal value. + + + + Sets the contrast value for the image from float value ranges. + + The picture. + The float value. + + + + Sets the contrast value for the image. + + The picture. + The decimal value. + + + + Gets the crop value + + + + + + + Parses the stroke props. + + The reader. + The shape. + + + + Gets the line join style. + + The line join style. + + + + + Parses the shape border. + + The reader. + The border. + + + + Gets the shape border style. + + The boder style. + + + + + Parses the pic shape props. + + The reader. + The ent. + + + + Parses the pic shape style + + + + + Sort the shape style attributes as per Microsoft Word order + + + + + Parses the pic shape props. + + The pic. + Name of the prop. + The prop val. + + + + Parse Text Box Properties + + + + + + + Parse the Text Box Wrapping Style + + + + + + + Parses the fill effect. + + The reader. + The Textbox. + + + + + Parses the gradient fill. + + The reader. + The background. + + + + Parses the color of the gradient. + + The reader. + The background. + + + + Parses the gradient style. + + The reader. + The gradient. + + + + + + + + + + + Parses the shading variant. + + The focus. + + + + + Parses the pattern fill. + + The reader. + The background. + + + + Parses the picture fill. + + The reader. + The textbox. + Type of the fill. + + + + Parses the wrap Type. + + The Wrap type + + + + + Parses the wrap style. + + The reader. + The textbox. + + + + Parses the type of the wrap. + + Type of the wrap. + + + + + Parses the content of the textbox. + + The reader. + The entity. + + + + Parses the text box style. + + The reader. + The textbox. + + + + Parses the internal margins of textbox. + + The reader. + The textbox. + + + + Parses the internal margins of textbox. + + The reader. + The textbox. + + + + Gets the textbox margin. + + The margin. + + + + + Gets the textbox margin. + + The margin. + + + + + + + + + + + + Parses the dash style. + + The dash style. + + + + + Parses the line style. + + The line style. + + + + + Gets the point value. + + + + + + + Gets the point value. + + + + + + + Parse the text box wrapping mode + + Current text box + wrapping type + + + + Parse TextBox Graphics data + + + + + + + Parse the drawing object + + + + + + + Parse Shape + + + + + + + + + Parse the custGeom of custom shape + + + + + + + Sets the reader position to custGeom + + + + + + + Parse the path list of custom shape + + + + + + + + Parse the custom shape pathLst elements + + + + + + + + Parse the path2D point of custom shape + + + + + + + + + + Parse common properties of chart and shpae + + + + + + + + + + Parse the horizontal position properties + + + + + + + parse the vertical position element (positionV) + + + + + + + Parse the wrapping type + + + + + + + Parses the wrap polygon. + + The reader. + The entity. + Unexpected xml tag + reader.LocalName + + + + Parse chart + + + + + + + + Parse Chart relations + + + + + + + Parses chart data and relations + + + + + + + Checks whether external file is Excel sheet. + + + + + Gets the extension string + + + + + + + Parse themes collection of document to workbook themes collection for parsing colors of chart + + + + + + Sets the category range of chart + + + + + + + + Parses the graphic data of shape. + + The reader. + The picture. + + + + Parse graphic data of group shape + + + + + + + Parse the preset material type. + + + + + Parse the Graphic Frame in Group shape + + Node as stream + Group shape + Child group shape + + + + Parse nested group shape + + The xml reader + The Child group shape + + + + Generate child shape id + + + + + + Parse child group shape properties + + The xml reader + The child group shape + + + + Parses the Effect format of the auto shape. + + + + + Parses the Effect format of the auto shape. + + + + + Parses the Effect format of the auto shape. + + + + + Parse the text outline of the textrange. + + The XmlReader to read attributes and child elements of textoutline. + The lineFormat object to store parse values. + + + + Parse the text outline properties of the textrange. + + The XmlReader to read attributes and child elements of textoutline. + The lineFormat object to store parse values. + + + + Parse the text fill of the textrange. + + The XmlReader to read attributes and child elements of textfill. + The local name of the XML element. + The fillFormat object to store parse values.. + + + + Parse the Shape TextValues + + The XmlReader to read attributes and child elements of body pr + The shape object to store parse values + + + + Parses the styles of graphic data. + + The reader. + The shape. + + + + Parse child shape style items + + The xml reader + The child shape + + + + Parses the graphic data. + + The reader. + The picture. + + + + Parses the Blip image + + The reader. + Fill Format. + + + + Gets the Blip image values + + + + + Parses the Duotone colors. + + The reader. + The parent element. + The opacity. + + + + + Parse the Blip Extension List + + + + + Parse blip image properties + + + + + Read the SVG image data. + + + + + + + Parse the Image layer + + + + + Parse the Image Effect + + + + + Parse the Image Effect items + + + + + Gets the Image Effect Value + + + + + Parse the Background removal rectange of blip picture + + + + + Parse the Color change child element of the blip + + + + + To Get the shape/textbox's text direction + + + + + To Parse the line format of the shape + + + + + To Parse the line format of the shape + + + + + Parse the Image Hyperlink + + Reader + Paragraph + + + + Download image from url + + Url + Image + + + + Get the Svg Image data from the particular location. + + + + + + + Parse Xml paragraph item + + + + + + + Parse Image relation of the group shape + + The group shape + The ID + + + + Parse image relation of the child shape + + The child shape + The ID + + + + Parses the image relation. + + The XML para item. + The id. + + + + + Get the relationship ids present within the XmlparaItem stream + + + + + + + Find the Z-Index value in xml paragraph item + + Xml paragraph item stream + Xml paragraph item + + + + Parses the shape hyperlinks id. + + + + + Parse the picture + + + + + + + + Parse the picture properties + + + + + + + Parses the graphic data. + + The reader. + The picture. + + + + Parses the picture data. + + The reader. + The picture. + + + + Parses the picture data. + + The reader. + The picture. + + + + Parses the visual shape props. + + The reader. + The picture. + Unexpected xml tag + reader.LocalName + + + + Parses the visual shape props. + + The reader. + The picture. + + + + Parses the visual shape props. + + The reader. + The picture. + + + + Gets the Border Width + + Border Width + + + + + Method to process effect extent element. + + the xml reader + shape base + + + + Gets the line cap style. + + The line cap. + + + + + Parses the line props. + + The reader. + The shape. + + + + Gets the line end. + + The line end. + + + + + Gets the end width of the line. + + End width of the line. + + + + + Gets the end length of the line. + + End length of the line. + + + + + Sets the language value + + + + + + + Gets the flip orientation. + + The flip. + + + + + Gets the flip orientation. + + The flip. + + + + + Gets the type of the gradient shade. + + The shade. + + + + + Parses the gradient fill. + + The reader. + The gradient fill. + + + + Parses the gradient stop. + + The reader. + The gradient fill. + + + + Parses the path gradient. + + The reader. + The path gradient. + + + + Parses the color. + + The reader. + The parent element. + The opacity. + + + + + Gets the color of the system. + + The reader. + + + + + Gets the color of the scheme. + + The reader. + + + + + Parses the color transform. + + The reader. + The parent element. + Color of the theme. + The opacity. + + + + Parses the color transform. + + The reader. + Color of the theme. + + + + + Gets the percentage. + + The value. + + + + + Parse the wrapping type + + + + + + + Parse the horizontal position properties + + + + + + + Gets the horizontal alignment. + + The align. + + + + + Gets the horizontal origin. + + The origin. + + + + + parse the vertical position element (positionV) + + + + + + + Get the vertical alignment. + + The alignment. + + + + + Get the vertical alignment of the Text in TextBox. + + The alignment. + + + + + Get the vertical Origin of the height in TextBox. + + + + + + + Get the horizontal Origin of the width in TextBox. + + + + + + + Get the vertical origin. + + The origin. + + + + + Check whether the element is Picture or unsupported element + + + + + + + Check whether the chart is valid chart + + Current stream + If the chart is 2016 and is not waterfall then returns false else returns true + + + + Parse the break item + + + + + + + + Parse the symbol + + The xml reader + The paragraph + + + + Create a text range object + + + + + + + + Parse the run text + + + + + + + + Parsing the nested table. + + The XmlReader instance used to read XML. + The entity representing the owner text body to insert the table into. + The local name of the table. + Indicates whether the isEmptyElement condition has already been checked. + + + + Move the text before the nested table to the first paragraph inside the table. + + + + + Parsing the nested body inside running text. + + Reader to read xml. + Trueif body is first nested body, otherwise false + + + + Gets the nested text. + + The reader. + Represents flag, if there is another body inside running text. + The paragraph items. + True, if nested run properties otherwise false. + True, if isEmptyElement is already checked otherwise false. + The reader local name. + + + + + Gets the nested text. + + The reader. + Represents flag, if there is another body inside running text. + The paragraph items. + True, if nested run properties otherwise false. + The reader local name. + + + + + Skip the current element in reading + + + + + + + Rotates the text. + + The text. + + + + + Modify the text + + + + + + + Parse document background + + + + + + Add the AlternateChunk to textbody. + + The entity. + + + + Parses the Alternate chunk. + + The entity. + The AlternateChunk. + + + + Parse structure document tag block + + + + + + + Parse SDT content + + + + + + + Parse structure document tag block + + + + + + + Maps the databinding value for picture content control + + + + + Parse SDT end character format + + + + + + + Parse SDT content + + + + + + + Parse SDT properties + + + + + + + + Parse Doc Part Obj + + + + + + + Parse Doc part obj and Doc part List child entities. + + + + + + + Parse SDT Dropdown list + + + + + + + Parse SDT combo box + + + + + + + Parse SDT Date + + + + + + + Get calender type + + + + + + + Get storage format type. + + + + + + + Parses MathML element. + + XML reader + Paragraph items + + + + Parse the control properties of MathML elements. + + + + + Parse math run element + + + + + Parse Document Relations + + + + + + Parse FontTable Relations + + + + + + Parses the relations. + + The xml reader. + The relations collection. + + + + Parse the custom document properties + + XmlReader for custom.xml + + + + + + + + + + + Updates the text, that cannot be represented in Xml as defined by XML 1.0 specification. + + + + + + + Parse the core properties + + XmlReader for core.xml + + + + Parse the extended properties + + XmlReader for app.xml + + + + Parses the list. + + The format. + + + + Parse the document properties from Word 2003 XML document + + XmlReader for DocumentProperties + + + + Parse the custom document properties from Word 2003 XML document + + XmlReader for CustomDocumentProperties + + + + Parses the list. + + The format. + The reader. + + + + Finds the list style. + + The style. + + + + + Parses the list format. + + The reader. + The format. + + + + Update list style for numId which is not having specific abstract numbering definition + + NumID value + Current listformat + + + + Get Base style name of the list format + + + + + + Parse the numberings + + The xml reader + + + + + Updates the list styles which has numStyleLink attribute. + + + + + Updates the AbstractListStyleNames value with newly added list. + + + + + Finds the list style with when the parameter match with style StyleLink property. + + + + + Parse Word 2003 xml numberings + + reader + + + + Parse Word 2003 xml numberings + + reader + + + + Parse the Num element of the numberings + + The xml reader + + + + Get the abstract number id based nsid. + + + + + + + + + Parse the level override attrbutes + + + + + + + Parse the level override + + + + + + + Parse the abstract numbering element + + + + + + Parse the abstrat list styles + + The xml reader + list style + + + + Parse the list level + + The xml reader + The list level + + + + Parses the legacy properties. + + The reader. + The level. + + + + Get the corresponding the follow char + + follow character as string + returns the level follow character + + + + Get the justification value + + Justification value of type string + returns the justification value + + + + Parse the list level text + + + + + + + Gets the corresponding list pattern for the string value + + The list pattern value + returns the corresponding list pattern + + + + Updates the type of the list style. + + The list style. + + + + Updates the name of the list style. + + The list style. + + + + Parses the picture bullet + + The reader + + + + Process the picture style + + The picture + Picture size + + + + Parses the size. + + The part string. + + + + + Parse/Get the picture relationship id + + + + + + + parse and return the pitcure bullet style. + + + + + + + Parse the style part + + + + + + Parse the styles of Word 2003 XML document + + xml reader + + + + Updates the base styles. + + + + + Updates the list in styles. + + + + + Updates the name of the link style. + + + + + Counts the occurrences of value. + + The dictionary. + + + + + Parse the document style + + + + + + Parse the style properties + + The reader + The style object + + + + Add StyleNameID into the StyleNameId collection + + + + + + + Creates the style. + + Type of the style. + + + + + Parse the latent styles + + + + + + Parse the document defaults formattings + + + + + + Gets the character format of style. + + The style + + + + + Gets the paragraph format of style. + + The style + + + + + Parses the conditional formatting style properties. + + The reader + The style + + + + Gets conditional formatting code. + + The styleType + + + + + Parses the table style table properties. + + The reader + The props + + + + Parses the table style row properties. + + The reader + The props + + + + Parses the table style cell properties. + + The reader + The props + + + + Parses the shading of table style table properties. + + The reader + The props + + + + Parses the shading of table style cell properties. + + The reader + The props + + + + Parse the run properties/Character formattings + + + + + + Updates the author name and time information for the inserted or deleted revision text + + + + + + + Update the revision author information. + + + + + + + To get the font size + + + + + To validate for the Numeric values alone in font size + + + + + Parses the ligatures. + + The reader. + The char format. + + + + Parses the number form. + + The reader. + The char format. + + + + Parses the number spacing. + + The reader. + The char format. + + + + Parses the stylistic set. + + The reader. + The char format. + + + + Parses the cfe layout. + + The reader. + + + + + Gets the stylistic set. + + The value. + + + + + + + + + + + + + + + + + + Parse the border + + + + + + + Get the border style for the corresponding string value + + String value that represents the border style + The border + + + + + Get the multiplier to find the border line width + + + + + + + Parse the shading elements of run properties + + + + + + + Returns the textureStyle for the corresponding string value + + textureStyle + + + + + Returns the textureStyle for the corresponding string value + + + + + + + Parse the vertAlign property of run properties (superscript or subscript) + + + + + + + Parse the emphasis of run properties. + + xml reader + character format + + + + Parse the animation text effect + + Xml reader + Character format + + + + Parse the underline format of run properties. + + xml reader + character format + + + + Parse the underline format of run properties. + + + + + + + Parse thr fonts specified on the run properties. + + + + + + + Check whether langauage has been defined or not. + + + + + + + Change first letter of string to uppercase. + + + + + + + Parse the highlight of the character format + + + + + + + Parse the default paragraph properties + + + + + + Parses the size of the frame. + + The reader. + The para format. + + + + Parses the frame anchor. + + The reader. + The paragraph format. + + + + Parses the frame position. + + The reader. + The paragraph format. + + + + Parse the Frame X and Y positions for the paragraph + + Position value + True if X value, else false. + Paragraph format instance + + + + + + + + + + + Parses the tab justification. + + The alignment. + + + + + Parses the tab leader. + + The leader. + + + + + + + + + + + + Checks the track change. + + The item. + + + + Create move range revision. + + + + + + Gets and updates the insert or delete revision. + + + + + + + + + + + + + + + Parses the border. + + The reader. + The borders. + + + + Parses the border. + + The reader. + The borders. + + + + Parse the paragraph spacings + + + + + + + Parse the line spacing of paragraph format + + + + + + + Parse the paragraph indentation. + + The xml reader + The paragraph format + + + + Parse the justification + + + + + + + Parse the justification + + + + + + + Parse the text alignment of the paragraph + + XML reader + Paragraph format + + + + Parse the textbox tight wrap option of the paragraph. + + XML reader + Paragraph format + + + + Parse the shading. + + + + + + + Gets theme color + + + + + + + Parse the section properties + + The XmlReader + The section + + + + Parse the section formatting change. + + + + + + + Parse the Header/Footer. + + reader + + + + To Parse Header/Footer + + headerfooter + reader + type + isHeader + + + + Parses the header footer. + + The hf. + The part. + The type. + if it is header, set to true. + + + + Parses the footnote and endnote property. + + The reader. + Boolean value specifies whether the element is Footnote or Endnote. + + + + Parses the footnote endnote number start. + + The reader. + if it is footnote, set to true. + + + + Parses the2003 footnote endnote number format. + + The reader. + if it is footnote, set to true. + + + + Parses the footnote endnote number format. + + The reader. + if it is footnote, set to true. + + + + Parses the footnote endnote number restart. + + The reader. + if it is footnote, set to true. + + + + Parses the footnote and endnote property. + + The reader. + Boolean value specifies whether the element is Footnote or Endnote. + + + + Parses the footnote endnote number start. + + The reader. + if it is footnote, set to true. + + + + Parses the 2003 footnote endnote number format. + + The reader. + if it is footnote, set to true. + + + + Parses the footnote endnote number format. + + The reader. + if it is footnote, set to true. + + + + Parses the footnote endnote number restart. + + The reader. + if it is footnote, set to true. + + + + Parse 2003 Page Number Style + + + + + + + Parse 2003 Chapter Number separator + + + + + + + Parse Chapter Number separator + + + + + + + Parse Page Number Style + + + + + + + Parses the type and number start of the page. + + The sec. + The reader. + + + + Parse 2003 Text flow direction + + The reader + The ent + + + + Parses the text direction. + + The reader. + The ent. + + + + Parses the line numbering. + + The reader. + The sec. + + + + Parse the vertical alignment of the page. + + The reader + The section + + + + Parses the grid. + + The reader. + The section. + + + + Parses the page borders. + + The reader. + The section. + + + + Parses the columns. + + The reader. + The sec. + + + + Parses the equal column. + + The sec. + The reader. + + + + Parses the column. + + The reader. + The entity. + + + + Parses the page margins. + + The reader. + The section. + + + + Gets the margin value. + + The reader. + Name of the attribute. + + + + + Parses the size of the page. + + The reader. + The section. + + + + Parses the size of the page. + + + + + Parses the type of the section. + + The sec. + The type. + + + + Parses the type of the section. + + The sec. + The type. + + + + Parses the settings relations. + + The stream. + + + + Initialize word 2010 specific Compatiblity Settings + + + + + Parse the Mailmerge setting. + + + + + + Parse CheckErrors from MailMerge settings. + + + + + + Parse Destination from MailMerge settings. + + + + + + Parse Mailmerge Datatype from MailMerge settings. + + + + + + Parse main document type from MailMerge settings. + + + + + + Parses the webSettings.xml file. + + Represents a to read websettings.xml file. + + + + Parses the Compatibilty Option. + + The reader. + + + + Parses the compat Node. + + The reader. + + + + Parses the compat Node of Word 2003 XML. + + The reader. + + + + Parses the CompatSetting Node. + + The reader. + + + + Parses the document variables. + + The reader. + + + + replaces hexadecimal values with equivalent string + + Text + + + + + Parses the type of the protect. + + The reader. + + + + Parses the view type. + + The reader. + + + + Adds the item. + + The item. + The para. + + + + Adds to paragraph. + + The item. + The para. + + + + Adds the OLE object. + + The OLE object. + The para. + + + + Gets the image id. + + The image id. + if set to true [is header footer]. + if set to true [is pic bullet]. + + + + + Loads the image data. + + The picture. + The image relation id. + if set to true [is header footer]. + if set to true [is picture bullet]. + + + + Gets the image bytes. + + Name of the image. + + + + + Gets the image. + + The image id. + if it is a header/footer, set to true. + + + + + Gets the bytes from. + + The part. + + + + + Gets part name from the file name. + + File name + Part name + + + + Finds the part. + + The part container. + Name of the part. + + + + + Gets the HF relation. + + The name. + + + + + Gets the diagram stream HF relation. + + + + + + + Parses the float val. + + The value. + + + + + Returns the boolean value from the current node + + + + + + + Returns the boolean value from the current node + + + + + + + Gets the boolean value from the current node. + + The reader. + The name space. + + + + + Returns xml element value. + + XmlReader to get value from. + Xml element value. + + + + Parses the color. + + The color. + + + + + Gets the color of the gradient. + + The color. + + + + + Gets the hexadecimal color. + + The color. + + + + + Gets the HTML color. + + The color. + + + + + Gets the float value from element attribute. + + The reader. + Name of the attr. + The attr NS. + + + + + + + + + + + + Skip whitespaces and moves the reader to the next node. + + The xml reader + + + + Closes this instance. + + + + + Implemented alternative method to improve the performance + + + + + + + + Gets the chart relations + + + + + Gets/sets the value indicating whether the chart is in footnote + + + + + Gets/sets the value indicating whether the chart is in endnote + + + + + Gets/sets the value indicating whether the chart is in comments + + + + + Gets/Sets the value indicating whether the document is Word 2003 ML. + + + + + Gets/Sets the value indicating whether the document is Strict. + + + + + Gets the image ids. + + The image ids. + + + + Gets the image data of the Svg Images. + + + + + Gets the block content control collection. + + + + + Gets the inline content control collection. + + + + + Gets the cell content control collection. + + + + + Gets the comment collection. + + The comment stack. + + + + Gets the Alternate Chunk if it preserve Table Row + + + + + Gets the Post paraItems and preserve after the Paragraph/Table/Cell/Row end mark + + + + + Gets the comments stack. + + The comments stack. + + + + Gets the current comment. + + The current comment. + + + + Gets the field stack. + + The field stack. + + + + Gets the current field. + + The current field. + + + + Gets the footnote by id. + + The footnote. + + + + Gets the endnote by id. + + The endnote. + + + + Gets the collection of override list style names. + + The over list style names. + + + + Gets the abstract list styles. + + The abstract list styles. + + + + Gets the collection of picture bullet. + + The picture bullet. + + + + Gets the collection of document relations. + + The document relations. + + + + Gets the collection of font table relations. + + The font table relations. + + + + Gets the settings relations. + + The settings relations. + + + + Represents the external hyperlink + + + + + + Gets the bookmark names collection. + + The name of the bookmark. + + + + Represents the HeaderFooter relations. + + The headers footers rel. + + + + Gets the collection of base style names. + + The base style names. + + + + Gets the collection of style name and id. + + The style name id. + + + + Gets the link style names. + + The link style names. + + + + Gets the AppVersion. + + The AppVersion. + + + + Gets the auto shape helper. + + + The auto shape helper. + + + + + Gets/sets the value indicates whether the SDTContent has section break + + + + + Gets/sets the value indicates whether is row change format + + + trueif it is row change format, elsefalse + + + + + Gets/sets the value indicates whether is cell change format + + + trueif it is cell change format, elsefalse + + + + + Gets/sets the value indicates whether is cell change format + + + trueif it is cell change format, elsefalse + + + + + Gets/sets the value indicates whether it is hyperlink field + + + trueif it is hyperlink field, elsefalse + + + + + Gets/Sets the value indicates whether it is first invalid numID + + + trueif it is first invalid numId in the document, else false + + + + + Gets/Sets the value indicates whether the paragraph property lies between the paragraph tag. + + + trueif paragraph property not lies b/w the paragraph tag, else false + + + + + Gets or sets the value xml:space in the document element + + + + + Used to parse various office effects. + + + + + Bookmark Id + + + + + Bookmark name + + + + + This class has few utility methods + + + + + Converts number into DateTime. + + Number to convert. + Converted value. + + + + Copies one stream into another. + + Source stream to copy from. + Destination stream to copy into. + + + + Creates copy of the MemoryStream. + + Source stream to copy. + A copy of the original MemoryStream. + + + + Creates xml reader to read data from the stream. + + Data to read. + Created xml reader. + + + + Creates xml reader to read data from the stream. + + Data to read. + Created xml reader. + + + + Creates xml writer to read data from the stream. + + Data to read. + Created xml writer. + + + + Creates xml writer to read data from the stream. + + Data to read. + Created xml writer. + + + + Creates xml writer to read data from the stream. + + Data to read. + Created xml writer. + + + + Represents the ShapeType + + + + + Represents the document serializator specific for Word 2010 format + + + + + Specifies boolean value indicating whether to Serialize "cnfStyle" element for paragraph or not. + + + + + Initializes a new instance of the class. + + + + + Saves the word document + + Name of the file/document + Instance of WordDocument + + + + Serialize Word 2007 XML document + + Name of the file/document + Instance of WordDocument + + + + Serialize Word 2007 XML document + + stream to save + Instance of WordDocument + + + + Saves the word document in the stream + + Instance of WordDocument + + + + Saves the Word 2007 XML format document + + + + + Serialize WordML ActiveX part + + The package + + + + Serialize WordML ActiveX part + + The package + + + + Serialize Word ML Custom xml part + + The customXMLContainer + + + + Serialize Word ML charts + + The Charts + + + + To Serialize chart elements + + The Chart + string id + + + + Serialize relations of chart + + The relations + The OccurenceOfChart + + + + Serialize Word ML OleObjects binary data + + The oleContainers + + + + Serialize Word ML Images binary data + + The imageCollection + + + + Serialize Word XML .rels + + + + + Serialize Word document XML .rels + + + + + Serialize Word document XML theme1.xml + + + + + Serialize Word document XML settings.xml + + + + + Serialize Word document XML _rels/numberings.xml.rels + + + + + Serialize Word document XML _rels/settings.xml.rels + + + + + Serialize Word document XML _rels/settings.xml.rels + + + + + Serialize Word document XML settings.xml + + + + + Serialize Word XML custom.xml + + + + + Serialize Word document XML settings.xml + + + + + Serialize Word document XML fontTable.xml + + + + + Serialize Word document XML app.xml + + + + + Serialize Word document XML app.xml + + + + + Saves the word document in the stream + + Stream to save the document + Instance of WordDocument + + + + Serializes the glossary document elements (glossary/document.xml) + + + + + Add Part Container to Archive + + The partContainer + + + + Add Part Container from XMLPartContainers to Archive + + The item name + Xml part containers + + + + Serialize the Font table + + + + + Get the font file name from the file path. + + The file path. + Returns the font file name extracted from the file path. + + + + Get the font signature + + + + + + Serializes the document elements (document.xml) + + + + + Serializes the vba project relations. + + + + + Serializes the vba project. + + + + + Serializes the vba project signatures. + + + + + Serializes the vba data. + + + + + Serialize Headers and Footers + + + + + Serializes the Header/Footer + + Type of the HeaderFooter + Instance of WordDocument + + + + Serialize the header part + + The header + The header relationship ID + The header path + The header's relation path + + + + Serailize the footer and its relations + + The Footer + The Footer relationship ID + Path of the Header Footer part + Path of the HeaderFooter relations + + + + Serializes the HeaderFooter relations + + The headerfooter id. + Path of the HeaderFooter relations + + + + Serializes the Header/Footer common relations. + + Stream to write the relations. + The XML items relations. + + + + Checks whether the TextBodyItem (paragraph) contains only a page field + + The TextBodyItem + return true, if the textBodyItem has a single page field. + + + + Adds the charts to zip. + + The package. + + + + Adds the controls to zip. + + The package. + + + + Adds the part container to zip. + + The package. + + + + Serialize the related for part container items. + + The package. + The chart container. + + + + Adds the parts to zip. + + The package. + The relations. + + + + Parses the relations. + + The rel reader. + The relations collection. + + + + Adds the xml items to zip. + + The package. + + + + Adds the container to zip. + + The cont. + The data path. + + + + + + + + + + + Serializes the Endnote relations + + + + + Serializes the Footnote relations + + + + + Serializes the Comment relations + + + + + Serializes the document relations. + + + + + Serializes the numbering relations. + + + + + Serializes the Alternate chunk relations + + The memory stream + Collection of alternate chunk relation + + + + Serializes the Hyperlink relations + + The memory stream + Collection of Hyperlink relation + + + + Serialize Svg Image relations. + + + + + Serialize Svg Image relations for header/footer. + + + + + Serializes the image relations + + The memory stream + Collection of images and its relationship id + + + + Serialize the image collection in the XML paragraph item stream. + + The memory stream + Collection of images and its relationship id + XML Paragraph item + + + + Serializes the HeaderFooters relations to the document relations stream + + Document relation stream (Word/.rels/document.xml.rels) + + + + Serializes the headers footers relations. + + Type of the HeaderFooter. + The stream. + + + + Serializes the IncludePicture field relations + + The memory Stream + Collection of URL that represents the picture mapped through the IncludePicture Field + + + + Serializes the XML Item relations + + + + + + + Adds the OleObject (*.Bin) into the package + + Collection of OLE Containers + + + + Adds the OLE objects to zip. + + The package. + + + + Serialize the document background + + The document background + + + + Checks whether the image is need to skip or not to add in relations + + + If the image is default image returns true, else return false. + + + + Serialize the background gradient + + The backgroundGradient + + + + Serialize the gradient shadings + + The background gradients + + + + Serialize the gradient color + + The background gradient + + + + Ensure the presence of metafiles and image presence in the document + + + + + + Serializes the document body + + + + + Serializes the Section. + + The WSection + + + + Serializes the bodyItems + + Collection of Body items + True, if the body items present in the last section of the document. + + + + Serialize the TextBody item + + The textBody item (paragraph or table) + True, if the body items present in the last section of the document. + + + + Serialize SDT content inline + + + + + + Update the Alternate chunk relation for Comment/HeaderFooter/EndNote/FootNode/Document + + + + + + + Seralize Alternate content + + + + + + Serialize bookmarks before the alternate chunk. + + The alternate chunk. + + + + Serialize bookmarks after the alternate chunk. + + + + + Seralize structure document tag block + + + + + + Serialize structure document tag properties + + + + + + Serialize Doc Part obj and Doc part list Child elements + + + + + + Serialize SDT data binding + + + + + + Serialize SDT lock settings + + + + + + Serialize SDT type + + + + + + Serialize SDT Check box + + check box + + + + Serialize SDTDropDownList + + + + + + Serialize SDT date + + + + + + Get Calender type + + + + + + + Serialize SDT content + + + + + + Serialize the table + + The table + + + + Serialize the table rows + + The table row collection + + + + Serialize the table row + + The table row + + + + + + serialize the table cells + + The table cell collection + + + + Serialize the table cell + + The table cell + + + + Merge the characterFormats + + The paragraph's break character format + The cell character format + + + + Serialize the cell formatting + + The cell format + + + + Serialize the cell vertical alignment + + + + + + Serialize the table cell direction + + + + + + Serialize the cell shading + + The table cell + The parent table format + The parent row format + + + + Serialize cell merge + + The cell format + + + + Serialize the grid span element of cell. + + + + + + Serialize the cell width + + + + + + Serialize the row format + + The table row + + + + Serialize the conditional formatting style element for table row + + The row + + + + Serialize the conditional formatting style element for table cell + + The cell + + + + Serialize the conditional formatting style element for paragraph in table + + The paragraph + + + + Checks whether the paragraph has cnf style or not. + + style + row Index + table + + + + + Serialize the row formattings. + Table parameter is passed for serializing table format and null for serializing row format. + + the row format + The table + + + + Serializes the table title. + Word 2010 specific property. + + The table. + + + + Serializes the table description. + Word 2010 specific property. + + The table. + + + + Serialize the table cell margins (paddings) + + The row formattings + + + + Serialize the paddings + + + + + + Serialize the table layout element + + The row format + + + + Serialize the table shading + + The row format + + + + Serialize the table borders + + + + + + To ensure none border + + + + + + + Serialize the table indentation. + + + + + + Serialize the cell spacing. + + The row format + + + + Serialize the table width + + + + + + Serialize the table alignment + + + + + + Serialize the table absolute positioning formattings. + + + + + + Serialize the table's horizontal positionings. + + + + + + Serialize the table's vertical position. + + The position. + + + + Serialize the table's vertical relation. + + The relation. + + + + Serialize the table's horizontal relation. + + The relation. + + + + Serialize the table style element + + + + + + Serialize the table look element + + + + + + Serialize the table grid + + The table + + + + Serialize the table grid columns. + + The grid values. + + + + Serialize grid column. + + The column width + + + + Serialize the paragraph + + The paragraph + + + + + Serialize watermark if paragraph is the first item of Header or Footer document + + + + + + Serialize the paragraph items + + The paragraph + + + + Serilize the bookmark end is BookMarkCollection which enables IsToAddInNextPara + + + + + Decides whether current item is OLE Object field item. + + Current item. + + + + + Serialize the paragraph item + + The paragraph item + + + + Serializes the Math element. + + + + + Serializes the character format of MathML item. + + + + + Serializes control properties of MathML elements + + + + + Serializes Character format. + + + + + Serialize chart + + + + + + Serialize chart graphic data + + + + + + Serialize chart relations into document relations + + Document relation stream (Word/.rels/document.xml.rels) + + + + To Serialize the default chart styles + + + + + To Serialize the default chart colors + + + + + Serialize Chart elements + + + + + + + Serialize the default styles for the chart + + input XML writer + input chart object + input application object + + + + Serialize the default Chart Color Styles + + input of XmlWriter + input of Application Object + + + + Initializes default colors for the chart + + + + + Initializes style elements for the chart + + + + + Get Next Chart elements relation Id + + + + + + Serialize relations of chart + + + + + + + + Serialize worksheet row + + + + + + + + + Serialize worksheet cells + + + + + + + + + Serialize worksheet cell + + + + + + + + + + Serialize worksheet shared settings + + + + + + + Serialize group shape + + The group shape + + + + Serialize fall back content of the group shape + + The group shape + + + + Serialize fallback nested group shape + + The Child group shape + + + + Serialize 2007 shadow effect of child shape + + + + + + Serialize horizontal rule of the child shape + + The child shape + The collection of properties + + + + Serialize horizontal rule of the child shape + + The child shape + + + + Serialize shape type of the child shape + + + + + Serialize 2007 shape fall back content text box format + + The shape + 2007 format unparsed streams + + + + Serialize textbox format of the child shape + + The shape + 2007 format unparsed streams + + + + Serialize textbox format of the child group shape + + The shape + 2007 format unparsed streams + + + + Serialize textbox format of the shape + + The shape + 2007 format unparsed streams + + + + Serializes the flip for shape. + + Shape. + Textbox style. + + + + Serialize pattern fill of the child shape + + + + + + Serialize Docx stream of the child shape + + + + + + + + Serialize fill effects of the child group + + + + + + + Serialize 2007 solid fill + + + + + + Serialize 2007 grid fill of child shape + + + + + + To get focus position of the child shape + + The child shape + + + + Serialize 2007 blip fill of child shape + + The child shape + + + + Gets the specified resource file as stream. + + The resource file name + Stream of the specified resource file + + + + Gets the emu from point. + + The point value. + + + + + Serializze the absolutely positioned picture. + + + + + + Get Shape Horizontal orgin + + + + + + + Get Shape Horizontal orgin of Fall back + + + + + + + Serialize the inline picture. + + + + + + Serialize the child group shape elements. + + + + + + + Serialize the child shape elements. + + + + + + + Serialize chart graphic data + + + + + + Serialize Child Group picture + + + + + Serialize nested child group shape + + The child group shape + + + + Serialize the custom Geometry of a shape + + + + + + Serialize the custom Geometry Path elements + + + + + + Serialize avlst of Custom Geometry + + + + + + Serialize gdlst of Custom Geometry + + + + + + Serialize pathLst points + + + + + + + Serailize Child shape + + + + + + + Serialize Effect List. + + + + + Serialize ThreeD Scene Effects. + + + + + Serialize Backdrop Settings + + + + + Serialize Camera Settings + + + + + Serialize Light Rid Effect + + + + + Serialize ThreeD Shape Effects. + + + + + Serialize the preset material type. + + + + + Serialize Reflection Effect. + + + + + Serialize the textoutline of the textrange. + + The lineFormat object to serialize values + + + + Serialize the reflection effect of the textrange. + + The reflectionFormat object to serialize values + + + + Gets the string value based on the texturealignment. + + The texturealignment enum value representing reflection alignment. + The textureallignment of the string representation. + + + + Serialize the glow effect of the textrange. + + The glowFormat object to serialize values + + + + Serialize the threeD effect of the textrange. + + The threeDFormat object to serialize values + + + + Serialize the preset material type for text. + + + + + Serialize Shadow Effect. + + + + + Serialize the shadow effect of the textrange. + + The shadowformat object to serialize values + + + + Gets the string value based on the ShadowAlignment. + + The ShadowAlignment enum value representing Shadow alignment. + The ShadowAllignment of the string representation. + + + + + Serializes the solid fill attributes. + + The color of the solid fill. + The transparency level of the solid fill. + + + + Serializes the gradient fill attributes. + + The gradientfill object to serialize values. + + + + Serializes the gradientstop attributes of textrange. + + The gradientStop object to serialize values. + + + + To Serialize blip fill + + + + + + To Serialize blip extensions + + + + + + To Serialize blip fill + + Fill Format of the shape + Entity + + + + Serialize child shape textbox content + + The textbody + The text frame + + + + Serialize textbox style attributes for shape or child shape. + + + + + + Serialize body properties of the child shape + + The child shape + + + + Serialize style ref of the child shape + + The child shape + + + + Serialize style ref of the group shape + + + + + + Serialize the watermark. + + The watermark. + + + + Serialize the text watremark. + + The text watermark. + + + + Serialize the picture watermark + + The picture watermark. + + + + Prepares the text watermark "style" attribute string. + + The text watermark. + + + + Serialize field code + + text + bool to indicate deleted text + + + + Get the image from the url + + Th url + + + + + Update the include picture field url + + + + + + + + Inser the field mark begin + + + + + Decides whether current field is picture hyper link or not. + + Current field + True;if field is hyper link. + + + + Serialize the hyperlink attributes + + + + + + Writes the Local reference attribute + + + + + + Serialize the footnote and endnote. + + + + + + Serialize the endnotes/footnotes + + Is Endnotes + + + + Serialize start foot/endnotes elements. + + + + + + + Serialize footnote/endnote. + + The footnote. + if it is end note, set to true. + The id. + + + + Serialize the drop down field. + + + + + + Serialize the check box field. + + + + + + Serialize the text form field. + + The textform field. + + + + Serialize the form field data + + + + + + Serialize the textboxes + + The textbox collection + + + + Serialize the textbox + + The textbox + + + + To Serialize the shape/textbox's text direction + + + + + Serialize the fill effects + + + + + + Serialize the gradient effects. + + + + + + Serialize the fill effects. + + + + + + Serialize the pattern fill. + + + + + + + Set Relationship ID for Stream data + + + + + + + + Set Relationship ID Attribute + + + + + + + + Decides whether currently writing shape field result or not. + + + + + + Serialize the textbox format. + + + + + + Get the string which is equivalent to particular wrap type + + Text box format + return wrap type as string + + + + Get the vertical Origin of the height in TextBox. + + + + + + + Get the horizontal Origin of the width in TextBox. + + + + + + + Get the textWrapping Type + + + + + + + Get the textWrapping style + + + + + + + Serialize the stroke value. + + + + + + Get the line dashing style. + + + + + + + Get the line style + + + + + + + Serialize the inset attribute. + + + + + + Serialize inset attribute of the text frame + + The text frame + + + + Serialize the Xml paragraph item. + + + + + + Update XML Relations of the child shape + + The shape + The shape stream + + + + + Change item relations of the child shape + + + + + Change picture relations of the child shape + + + + + Change the relation ids in the XmlParagraph Item. + + + + + + Changes the picture relations. + + The item. + The old ID. + The new ID. + + + + Get the Xml paragraph item owner. + + The item. + + + + + Updates the relations for header/footer. + + The new id. + The hf. + The item rel. + + + + Changes the ID attribute in XmlNode. + + The node. + The array. + XML Paragraph item + + + + + Changes Relationship ID's + + XML Reader + XML Writer + Relation IDs + XML Paragraph item + + + + Change Num Id + + + + + + + Get List Id + + + + + + + Changes Relationship ID + + + + + + + + Changes Relationship ID for Blip + + + + + + + + Changes Relationship ID for Relation + + + + + + + + Changes Doc Property ID attribute + + + + + + + Changes Shape ID + + XML Reader + XML Writer + XML Paragraph item + + + + Updates the ZOrder position + + Current xml reader + XML Paragraph item + XML Writer + + + + Changes the ID attribute in diagram. + + The reader. + The array. + + + + Adds the type of the XML item cont. + + Type of the rel. + The rel target. + + + + Updates the chart inner relation. + + Name of the container. + + + + Serialize the ole object. + + + + + + Serialize the ole data. + + + + + + + Serialize the ole picture. + + + + + + Serialize the picture crop positions + + + + + + Serialize the link options. + + + + + Gets the name of the file. + + Type of the object. + + + + + Gets the type of the OLE relation. + + Type of the object. + + + + + Gets the ole picture style. + + + + + + + Update the ole content type + + + + + + Updates the content type of OLE object. + + The type. + + + + Serialize the symbol. + + + + + + Serialize the field mark. + + + + + + Serialize the picture. + + + + + + Check whether the picture is picturebullet + + The picture. + + + + + Serialize the drawing element. + + The Picture. + + + + Serialize the inline picture. + + + + + + Calculates the bounding box for picture based on rotation angle. + + Represents bounding box for picture. + Represents rotation anlge of picture. + + + + + Get the roation angle for picture. + + Represents the angle of rotation + + + + + Serializze the absolutely positioned picture. + + + + + + Serialize the picture properties + + + + + + Serialize the graphics element for pictures. + + + + + + + Gets the offset value of fill rectangle + + + + + Serializes the inline shape line. + + The shape. + + + + Sets the language value + + + + + + + Gets the line cap style. + + The line cap. + + + + + Gets the line join style. + + The linejoin. + + + + + Gets the line end. + + The line end. + + + + + Gets the end width of the line. + + End width of the line. + + + + + Gets the end length of the line. + + End length of the line. + + + + + Serializes the shape line. + + The shape. + + + + Serializes the gradient fill. + + The gradient fill. + + + + Serializes the gradient stop. + + The gradient stop. + + + + Gets the flip orientation. + + The flip. + + + + + Gets the type of the gradient shade. + + The shade. + + + + + Serialize the picture hyperlink. + + + + + + Update the shape id. + + + + + + + Update the shape id. + + + + + + + Adds the image relation. + + The image collection. + The image record. + + + + + Update the HeaderFooter image relations. + + + + + + + + Updates the header/footer SVG image relations + + Relationship Id + Header/footer + SVG image stream + + + + Update the HeaderFooter image relations. + + + + + + + Update the HeaderFooter image relations. + + + + + + + + Get the header footer id. + + + + + + + Get the picture owner. + + + + + + + + + + + + + + Serialize the shape. + + + + + + Gets the string of the gain value (contrast) for a given picture. + + The picture. + The string of the gain value, or null if not found. + + + + Gets the string of the black level value (brightness) for a given picture. + + The picture. + The string of the black level value, or null if not found. + + + + Set the crop value + + + + + + + Serializes the color of the shape border. + + The shape. + + + + Write the start element of stroke. + + Enable true once start element was written. + + + + Serializes the stroke props. + + The shape. + + + + Gets the stroke line style. + + The line style. + + + + + Gets the stroke dash style. + + The line dashing. + + + + + Serialize the text wrapping style. + + + + + + + Serializes the wrap polygon. + + The entity. + The wrap polygon. + + + + Adjusts the polygon points. + + The wrap polygon. + + + + + Get the text wrapping style. + + + + + + + Gets the vertical orgin as string. + + The vertical origin. + + + + + Get the text wrapping type + + + + + + + Get the picture's wrapping type. + + + + + + + Serialize the shape borders. + + + + + + Serialize the shape border + + + + + + + Get the shape border style. + + + + + + + Serialize the shape picture style. + + + + + + + Serializes the wrap polygons. + + The picture. + + + + + Serialize the bookmark end. + + + + + + Serialize the bookmark start. + + + + + + Serialize the editable range end. + + Represents a editable range end to serialize. + + + + Serialize the editable range start. + + Represents a editable range end. + + + + Serialize the break element. + + + + + + Serialize the comment reference. + + + + + + Serialize the commented items. + + The comment. + The comment id. + + + + Serialize the comment range start. + + + + + Serialize the comment range end. + + + + + Serialize the comments. + + + + + Serialize the comment. + + The comment. + The id. + + + + Serialize the comment mark. + + The comm mark. + + + + Check for the string content in Comment ID. + + The item. + + + + Serialize the Comments Extended + + + + + Serialize the comment Extended + + + + + + Serialize the text range. + + + + + + Determine whether current entity is field code item or not. + + + + + + Serialize the text. + + text + bool to indicate deleted text + bool to indicate instr text + + + + Serialize the text. + + text + bool to indicate deleted text + + + + Serialize FieldCode text + + Text + bool to indicate deleted text + + + + Serialize the table of contents. + + + + + + Get the field type as string. + + + + + + + Serialize the section properties. + + + + + + Serialize the heeader/footer reference. + + The HeaderFooters + + + + Serialize the docGrid element + + + + + + Serialize section protection. + + + + + + Serialize the text direction. + + + + + + Serialize the column properties of section. + + + + + + Serialize the page setup properties. + + The page setup. + + + + Serializes the page borders. + + The borders. + + + + Serialize the table borders + + + + + + Checks for none border + + + + + + Serialize the borders. + + + + + + + Serialize the border. + + + + + + serialize the page size + + + + + + Serialize the page number type. + + + + + + Serialize the line number type. + + + + + + Serialize the section type. + + + + + + Serialize the section break code. + + + + + + + Serialize the endnote properties. + + + + + + Serialize the footnote properties. + + + + + + Determines whether to serialize the section foot note properties or not. + + + + + + Determines whether to serialize the section end note properties or not. + + + + + + Determines whether to serialize the document foot note properties or not. + + + + + Determines whether to serialize the document end note properties or not. + + + + + Serialize the endnote/footnote element properties + + + + + + + Serializes the endnote footnote number format. + + The section. + if set to true [is footnote]. + + + + Serializes the endnote footnote number format. + + The section. + if set to true [is footnote]. + + + + Adds the header footer details to the collection. + + + + + + + + Serialize the document themes. (theme.xml) + + + + + Serialize Fill Styles (Both Fill and Background Fill effects of Themes) + + + + + Serialize Theme Pattern + + + + + Serialize Theme Pattern + + + + + Serialize Theme Pattern + + + + + Serialize Theme Pattern + + + + + Serializes the gradient stop. + + The gradient stop. + + + + Serialize Effect Styles of themes + + + + + Serializes Line Style List + + The gradient stop. + + + + Serializes the default themes. + + + + + Serializes the default color scheme. + + if set to true [is word2013]. + + + + Serializes the RGB color + + color value + Alpha color value + + + + Serializes the default font scheme. + + if set to true [is word2013]. + + + + Serializes the default format scheme. + + if set to true [is word2013]. + + + + Serializes the default fill style list. + + if set to true [is word2013]. + + + + Serializes the default line style list. + + if set to true [is word2013]. + + + + Serializes the default line style. + + The width. + The line cap. + Type of the line. + The alignment. + if set to true [is miter]. + + + + Serializes the default effect style list. + + if set to true [is word2013]. + + + + Serializes the effect style. + + The blur radius. + The distance. + The alpha. + if set to true [is align]. + + + + Serializes the default background fill style list. + + if set to true [is word2013]. + + + + Serializes the default background fill style list for Word version 2007 and 2010. + + + + + Serializes the color of the scheme. + + The value. + + + + Serializes the default gradient relative position attributes + + Luminance modulation value + Saturation modulation value + Tint value + Shading value + + + + Serializes the default theme font. + + Type of the font. + if set to true [is word2013]. + + + + Serialize the document settings. (settings.xml) + + + + + Serialize the Mailmerge Settings. + + + + + + Serializes the MainDocumentType for mailmerge settings. + + + + + Serializes the DataType for mailmerge settings. + + + + + Serializes the DataSource for mailmerge settings. + + + + + Serializes the HeaderSource for mailmerge settings. + + + + + Serializes the Destination type for mailmerge settings. + + + + + Serializes the CheckErrors type for mailmerge settings. + + + + + Serializes the setting relations + + + + + Parses the settings relations. + + + + + Serializes the Docx unhandled properties + + + + + Serializes the Docx unhandled properties + + + + + Serializes the compatibility properties to maintain backward compatibility similar to input document, + when file is opened in lower version applications. + + + + + Serializes the Docx Common compatibility Layout options for all version. + + + + + Serializes the compatibility settings + + + + + Serializes the document protection type. + + + + + + Serialize the document variables. + + + + + + Serializes the Footnote/Endnote settings + + + + + Serializes the Footnote position + + + + + Serialize the Endnote position + + + + + Serializes the Footnote position + + + + + Serializes the Footnote/Endnote ID + + + + + + + Serialize the list styles and numberings (numberings.xml) + + + + + Serializes the Override styles + + Collection of ListOverride style + + + + Serializes the Override styles + + List Override style + + + + Serializes the level overrides + + The level Index + Override level + + + + Serializes the list styles + + Collection of list styles + + + + Serializes the abstract list styles + + Collecgtion of list styles + + + + Serialize the list level + + The List level + The level index + + + + Serialize the list level legacy properties. + + The list level. + + + + Serialize the level follow character + + The list level + + + + To Remove xml ilegal character Ascii 0-29 from text. + + The text. + + + + Serializes the level text + + The list level + The level index + + + + Serializes the picture bullets. + + Collection of list styles + + + + Serializes the picture bullet. + + The list level + + + + Serialize the styles (styles.xml) + + + + + Serializes the document styles + + + + + Gets the style id from StyleNameIds collection. + + + + + + + Serialize the document style + + The Style + Instance of the word document + + + + Serialize the table style + + The Style + + + + Serialize the table conditional formatting style + + The Code + The Style + + + + Gets conditional formatting style type + + The Code + + + + Serialize the table style cell properties + + The Props + + + + Serialize the table style row properties + + The Props + + + + Serialize the table style table properties + + The Props + + + + Serialize the shading element in cell properties. + + The table cell + + + + Serialize the shading element in table properties. + + The props + + + + Serializes the latent styles + + + + + Serializes the default styles (document default paragraph and character format) + + + + + Serializes the TableGrid style. + + + + + Serializes "NoList" style + + + + + Serializes the "TableNormal" style + + + + + Serializes the default paragraph style + + + + + Serializes the Character format + + + + + + Serializes the ligatures. + + The character format. + + + + Serializes the number form. + + The character format. + + + + Serializes the number spacing. + + The character format. + + + + Serializes the stylistic set. + + The character format. + + + + Serializes the contextual alternates. + + The character format. + + + + Serialize character shading + + + + + Serialize character shading of formatting changes(old formatting) + + + + + Serializes the paragraph format + + + + + + + Serializes the mirror indents. + + The paragraph format. + + + + Serializes the suppress automatic hyphens. + + The paragraph format. + + + + Gets the next track change id. + + + + + + Serialize directional override + + + + + + + Serializes the track changes revision start tag. + + The item. + + + + Checks need to write start or end of revision. + + The item. + The item revision + True for writing revision start tag + + + + Serializes the track changes revision end tag. + + The item. + + + + Writes the move range end tag. + + + + + + + Serilaize the move range end when it exists between paragraph,table,table row, cell. + + + + + Serializes the revisions in formatting. + + + + + + Serializes the track changes properties. + + + + + + + + Serializes the track changes properties. + + + + + + + + Serializes the paragraph text alignment + + The paragraph format + + + + Serializes the paragraph textbox tight wrap. + + The paragraph format + + + + Serializes the paragraph indentation + + The paragraph format + + + + Serializes the paragraph spacings + + + + + + Serializes the tabs + + The paragraph format + + + + Serializes the tab + + The tab + + + + Serializes the paragraph shadings + + The paragraph format + + + + Serializes the paragraph borders + + The Paragraph format + + + + + Seraializes the pargraph list format + + The paragraph + + + + Serializes the style list format + + The paragraph + + + + Serialize the list format + + The list format + + + + Serializes the paragraph frame. + + + + + + Writes the frame's wrapping mode. + + The relation. + + + + Serializes the Border + + The Border + The tag name + + + + + Serializes the language formats + + + + + + Serializes the language formats for formatting changes + + + + + + Serializes the bool character format property + + Tag name + if set to true [value]. + + + + Get the base format of paragraph format when base format have frame property keys. + + + + + + + Serializes the content types [Content-Types].xml + + + + + Serialize the glossary docuemnt xml parts in content type + + Content type stream + Current xml part to serialize + + + + Add the Alternate chunks if it exists more than one items in same name + + + + + + Writes the type of the diagrams. + + + + + Gets the type of the content. + + Name of the part. + + + + + Serializes the HeaderFooter content types + + + + + + Serializes the HeaderFooter content types. + + Type of the HeaderFooter. + The stream. + + + + Serialize chart content types + + + + + + Serialize the Xml type contents. + + + + + + Serializes the default content type + + Content type stream + The extenstion + The content type + + + + Serializes the Override content type. + + The content type stream + The name of the part + Content type + + + + Serialize the general relations + + + + + Serializes the relationship + + The memory stream + The relationship id + The relationship type + The part of the target item + + + + Serializes the relationship + + The relationship id + The relationship type + The part of the target item + + + + Serializes the core properties + + + + + Serializes the custom properties. + + + + + Determines whether [is valid type] [the specified type]. + + The type. + + + + + Updates the text, that cannot be represented in Xml as defined by XML 1.0 specification. + + + + + + + Checks for the valid xml character. + + + + + Serializes the app properties (app.xml) + + + + + Checks if text have invalid surrogate charecters + + String + Return the text which doesn't have invalid surrogate charecter. + + + + Checks whether the style is + + + + + + + Get the tab leader type as string + + The tab leader + returns the tab leader type as string + + + + Gets the tab justication type as string + + The tab justification + returns the tab justication type as string + + + + Get the list ID + + The list format + returns the list id + + + + Add the list override to ListStyleReferences collection + + The list id + The LFO Style name + returns the list id from the list style reference collection + + + + Serializes the numbering properties to the paragraph + + + + + + + Check whether the properties hash has font property + + + + + + + Check whether the character format has font property + + + + + + + Create xml writer + + The stream + returns the xml writer + + + + Create xml reader + + The stream + returns xml reader + + + + Reset the relationship id counter + + + + + Get the next relationship ID + + returns the next relationship ID + + + + Get the next ID + + + + + + Get the TextureStyle as string + + + + + + + Get the border style as string + + + + + + + Get the underline style as string + + + + + + + Gets the text effect as string + + Text effect type + Text effect type as string + + + + Get the emphasis type as string + + The emphasis type + The type as string + + + + Get the highlight color as string + + + + + + + Convert the float value to string. + + float value + + + + + Get the RGB color code + + The color + + + + + Get the default font size + + + + + + + + Get the list pattern type as string. + + + + + + + Get the list symbol + + + + + + + + + + + + + + Get the page number type as string + + The page number style + + + + + Get the next bookmark ID + + + + + + Get the docPr id (used for pictues) + + + + + + Get the next shape ID + + + + + + Update the text + + + + + + + Get the base entity + + + + + + + Gets chart base entity + + + + + + + Determines whether the page break need to be skipped based on given entity owner. + + Entity + true, if present inside TextBox/FootNote/EndNote/Header/Footer + + + + Update item relations + + + + + + + + + + + + + + + Determines whether document style collection has Default Table style + + + + + + Closes this instance. + + + + + Implemented alternative method to improve the performance + + + + + + + + Gets a value indicating whether save as macro enabled format. + + + true if save as macro enabled; otherwise, false. + + + + + Determines whether currenly serializing Ole object field elements or not. + + + + + Gets/Sets the value indicating whether the document is Word 2003 ML. + + + + + Denotes whether currently serailizing the choice content for shaoe. + + + + + Gets a value indicating whether save as Word 2007 format. + + + true if save as Word 2007 format; otherwise, false. + + + + + Gets a value indicating whether save as Word 2010 format. + + + true if save as Word 2010 format; otherwise, false. + + + + + Gets a value indicating whether save as Word 2013 format. + + + true if save as Word 2013 format; otherwise, false. + + + + + Gets a value indicating whether save as latest Word format. + + + true if save as latest Word format; otherwise, false. + + + + + Gets the settings relations. + + The settings relations. + + + + Gets the bookmark end if it preserve after the Paragraph/Table/Cell/Row end mark + + + + + Gets the editable range end if it preserve after the Paragraph/Table/Cell/Row end mark + + + + + Gets the HeaderFooter Collection + + + + + Gets the Control path names + + + + + Gets the chart path names + + + + + Gets the HeaderFooter relations + + + + + Collection of Include Picture targets with ids inside headers or footers. + + + + + Gets the Urls of the include picture fields + + + + + Contains key and include picture fields link present in HeaderFooters + + + + + Collection of relationship ids and its corresponding external link + + + + + Gets the chart relation Id's + + + + + Collection of Chart in Header Footers + + + + + collection of chart in Footnote + + + + + Collection of chart in Endnote + + + + + Collection of chart in Comments + + + + + Collection of chart in Document + + + + + Collection for chart elements relations + + + + + Collection of images path in Document + + + + + Gets the Hyperlink details present in the comments + + + + + Gets the Alternate chunks details present in the comments + + + + + Collection of hyperlink targets with ids. + + + + + Collection of altChunk targets with ids. + + + + + Collection of altChunk targets with ids. + + + + + Collection of hyperlink targets with ids inside footnotes. + + + + + Gets the collection of Alternate chunks with ids inside footnotes. + + + + + Collection of hyperlink targets with ids inside endnotes. + + + + + Gets the collection of Alternate chunks with ids inside endnotes. + + + + + Collection of hyperlink targets with ids inside headers or footers. + + + + + Gets the collection of alternateChunks with ids inside headers or footers. + + + + + Gets the comment collections + + + + + Gets the comment ids + + + + + Gets the ole containers + + + + + Get the Svg Image datas. + + + + + Gets the image data of the Svg Images. + + + + + Gets the ole containers present in the HeaderFooters + + + + + Gets the ole object ids + + + + + Gets the collection of OleObject content types + + + + + Gets the collection of Xml items relations + + + + + Gets the list style references. + + The list style references. + + + + Gets the collection of picture bullets + + + + + Represents the presence of font table + + + + + Represents the presence of footnote + + + + + Represents the presence of endnote + + + + + Represents the presents the list styles + + + + + Gets the collection of images present in the document body + + + + + Gets the collection of images present in the footnote images + + + + + Gets the colection of images in the endnote images + + + + + Gets the collection of images in the comments + + + + + Gets the footnote collection + + + + + Gets the endnote collection + + + + + Gets the collections of images present in the HeaderFooters + + + + + Gets the collections of Svg images present in the HeaderFooters + + + + + Gets the field stack. + + The field stack. + + + + Gets the field mark stack. + + + + + Gets the current field. + + The current field. + + + + Gets the auto shape helper. + + + The auto shape helper. + + + + + Holds the moving revision details. + + + + + Gets the revision if it preserve after the Paragraph/Table/Cell/Row end mark + + + + + Gets the comment range end if it preserve after the Paragraph/Table/Cell/Row end mark + + + + + Converts DocIO DOM to markdown DOM + + + + + Converts word document DOM to Markdown DOM. + + + + + Iterate body and convert into Markdown DOM + + + + + Check and create new code block or paragraph. + + + + + + + Defines method to iterate through document Paragraph and create an instance of MdParagraph for every Paragraph in the document. + + + + + Iterates Paragraph Items for CodeBlock + + + + + Iterates through the TableRow. + + + + + Iterate items in cell and convert to Markdown DOM + + + + + Iterates through the nested table inside TableCell. + + + + + Iterates through the FieldHyperLink. + + + + + Add empty cells for spanned cells + + + + + Adds a space between outer cell content and the nested cell contents. + + MdTableRow cell + + + + Iterates through the TableCell. + + + + + Sets the table row alignment. + + + + + Checks for text formatting of the previous MdTextrange and compares to the current text + + Represents the current textrange in the paragraph + Represents the previous textrange in the paragraph + + + + + Execute the event for image + + + + + Applies list format for the paragraph + + Word document paragraph + The list format for that paragraph in Markdown + + + + Applies Text format to text. + + + + + Convert the picture in the word document to Markdown image + + + + + + + + Convert Word to Markdown and write as md file. + + + + + + + + Gets or sets the file path where the output will be saved. + + + + + LaTeXParser in DocIO supports compression LaTeXParser. + + + + + Set the text range as math run element item. + + Math run element + Text for text range + + + + Append the text in math run element text range. + + Math run element + Text to append in text range + + + + Get the text from a math run element text range. + + The math run element to retrieve text from. + The text content of the math run element, or null if the provided element is not a text range. + + + + Specifies the field group type + + + + + Specifies field instruction group + + + + + Specifies field result group + + + + + Specifies field group other than the field instruction and field result group + + + + + Summary description for Package. + + + + + Summary description for PartContainer. + + + + + + + + + + Adds the part. + + The item. + + + + Adds the part. + + The XML part. + + + + Adds the part container. + + The container. + + + + Removes the Part. + + The XML part. + + + + Gets the container. + + The name parts. + Start index of the name. + + + + + Loads the relations. + + The item. + + + + Get xml part name + + The full path. + + + + + Clones this instance. + + + + + + Copies the XML part container. + + The new container. + The SRC package. + The parts. + The index. + + + + + Copies the XML part items. + + The new container. + The SRC package. + Name of the part. + + + + Gets the XML part relation key. + + Name of the part. + + + + + Updates the inner relation target. + + The relation. + The inner relation target. + + + + Copies the inner related XML parts. + + The new container. + The SRC package. + The relation. + Name of the cur part. + + + + + Gets the part container by name. + + Name of the container. + + + + + Gets the XML part container path. + + The container. + The target. + + + + + Gets the parent part path. + + The SRC container. + + + + + Closes this instance. + + + + + Gets the XML parts. + + The XML parts. + + + + Gets the XML part containers. + + The XML part containers. + + + + Gets the XML relations collection. + + The XML relations. + + + + Gets or sets the name. + + The name. + + + + Gets the part container by name. + + Name of the container. + + + + + + + + + + + + Loads the specified zip archive. + + The zip archive. + + + + Loads the part. + + The item. + + + + + + + + + + Closes this instance. + + + + + Summary description for Part. + + + + + + + + + + Initializes a new instance of the class. + + The data stream. + + + + Clones this instance. + + + + + + Sets the data stream. + + The stream. + + + + Closes this instance. + + + + + Get the attribute stream using attribute name + + + The XML attribute of stream + + + + Gets data stream. + + + + + Gets/sets part name. + + + + + Summary description for Relation. + + + + + Initializes a new instance of the class. + + The zip item. + + + + + + + + + + + Clones this instance. + + + + + + Closes this instance. + + + + + Represents the background effects. + + + + + Class fields. + + + + + Initializes a new instance of the class. + + The doc. + The type. + + + + Internal constructor. + + + + + + Initializes a new instance of the class. + + The doc. + The container. + + + + Clones background object. + + Exact copy of background object + + + + Updates the image record. + + The doc. + + + + Reads object data from xml attributes. + + + The object. + + + + Writes object data as xml attributes. + + + The object. + + + + Writes object data as inside xml element. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + The value indicating the presence of xml content. + + + + Registers child objects in XDSL holder. + + + + + + Sets the Background fill color + + + + + + Sets the Background pattern fill + + + + + + Gets the background data. + + + + + Gets the image. + + + + + + Gets the image. + + The image bytes. + + + + + Loads the image. + + The image. + + + + Compares the current background with another background of another document. + + + + + + + Gets the properties text for Word comparison + + + + + + + Gets or sets the type of background effect. + + The member that specifies the type of background. + + + + Gets or sets the background picture. + + The that represents the background for the document. + + The following code example demonstrates how to set the background for the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an instance of WordDocument class + WordDocument document = new WordDocument(); + //Set the background type of the document + document.Background.Type = BackgroundType.Picture; + //Set the background image of the document + document.Background.Picture = Image.FromFile("Image.png"); + //Add one section with one paragraph to the document + document.EnsureMinimal(); + //Add the text range to the last paragraph of the section + document.LastParagraph.AppendText("Hello World!"); + //Save the document in the given name and format + document.Save("Sample.docx", FormatType.Docx); + //Release the resources occupied by WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an instance of WordDocument class + Dim document As New WordDocument() + 'Set the background type of the document + document.Background.Type = BackgroundType.Picture + 'Set the background image of the document + document.Background.Picture = Image.FromFile("Image.png") + 'Add one section with one paragraph to the document + document.EnsureMinimal() + 'Add the text range to the last paragraph of the section + document.LastParagraph.AppendText("Hello World!") + 'Save the document in the given name and format + document.Save("Sample.docx", FormatType.Docx) + 'Release the resources occupied by WordDocument instance + document.Close() + End Sub + + + + + + Gets the image. + + The image. + + + + Gets or sets the background color of the document. + + The specifies the background color for this document. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into WordDocument instance + WordDocument document = new WordDocument("Sample.docx"); + //Set the background type of the document + document.Background.Type = BackgroundType.Color; + //Set the background color of the document + document.Background.Color = Color.AliceBlue; + //Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx); + //Release the resources occupied by WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into WordDocument instance + Dim document As New WordDocument("Sample.docx") + 'Set the background type of the document + document.Background.Type = BackgroundType.Color + 'Set the background color of the document + document.Background.Color = Color.AliceBlue + 'Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx) + 'Release the resources occupied by WordDocument instance + document.Close() + End Sub + + + + + + Gets or sets the background gradient. + + The object that specifies the gradient effect. + + + + + Gets the image record. + + The image record. + + + + Get/set background image as byte array. + + + + + Get/set background fill type. + + + + + Get background color for picture background. + + + + + Gets or sets a pattern fill string. + + true if pattern fill string; otherwise, false. + + + + Gets or sets the pattern image. + + The pattern image. + + + + Represents the background gradient effect. + + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an instance of WordDocument class + WordDocument document = new WordDocument(); + //Set the background type of the document + document.Background.Type = BackgroundType.Gradient; + //Set the first color of the background gradient of the document + document.Background.Gradient.Color1 = Color.AliceBlue; + //Set the second color of the background gradient of the document + document.Background.Gradient.Color2 = Color.Purple; + //Set the first shading style of the background gradient of the document + document.Background.Gradient.ShadingStyle = GradientShadingStyle.DiagonalDown; + //Set the first shading variant of the background gradient of the document + document.Background.Gradient.ShadingVariant = GradientShadingVariant.ShadingMiddle; + //Add one section with one paragraph to the document + document.EnsureMinimal(); + //Add the text range to the last paragraph of the section + document.LastParagraph.AppendText("Hello World!"); + //Save the document in the given name and format + document.Save("Sample.docx", FormatType.Docx); + //Release the resources occupied by WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an instance of WordDocument class + Dim document As New WordDocument() + 'Set the background type of the document + document.Background.Type = BackgroundType.Gradient + 'Set the first color of the background gradient of the document + document.Background.Gradient.Color1 = Color.AliceBlue + 'Set the second color of the background gradient of the document + document.Background.Gradient.Color2 = Color.Purple + 'Set the first shading style of the background gradient of the document + document.Background.Gradient.ShadingStyle = GradientShadingStyle.DiagonalDown + 'Set the first shading variant of the background gradient of the document + document.Background.Gradient.ShadingVariant = GradientShadingVariant.ShadingMiddle + 'Add one section with one paragraph to the document + document.EnsureMinimal() + 'Add the text range to the last paragraph of the section + document.LastParagraph.AppendText("Hello World!") + 'Save the document in the given name and format + document.Save("Sample.docx", FormatType.Docx) + 'Release the resources occupied by WordDocument instance + document.Close() + End Sub + + + + + + Class constants. + + + + + Class fields. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The object. + The object. + + + + Creates the duplicate copy of the background gradient. + + The which is a copy of current gradient. + + + + Clones the relations. + + The doc. + + + + + Gets the gradient data. + + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Closes this instance. + + + + + Gets the properties text for Word comparison + + + + + + + Gets or sets the first color for gradient effect. + + The first for the gradient effect. + + + + Gets or sets the second color for gradient effect. + + The second for the gradient effect. + + + + Gets or sets the shading style for gradient effect. + + The member that represents the shading style for gradient effect. + + + + Gets or sets the shading variants for gradient effect. + + The member that represents the shading variants for gradient effect. + + + + Represents the bookmark in the Word document which enclosed with + and . + + + + + + + + + Initializes a new instance of the class with the specified + . + + The that represents the start of the bookmark. + + + + Initializes a new instance of the class with the specified + and . + + The that represents the start of the bookmark. + The that represents the end of the bookmark. + + + + Sets the bookmark start. + + The bookmark start. + + + + Sets the bookmark end. + + The end. + + + + Checks whether bookmark is in valid position, when bookmark end is in content control + + + + + + Gets the bookmark name. Read-only. + + The string that represents the bookmark name. + + + + Gets the bookmark start. Read-only. + + The that represents the start of the bookmark. + + + + Gets the bookmark end. Read-only. + + The that represents the end of the bookmark. + + + + + + Represents the editable range in the Word document which enclosed with + and . + + + + + Initializes a new instance of the class with the specified + . + + The that represents the start of the editable range. + + + + Initializes a new instance of the class with the specified + and . + + The that represents the start of the editable range. + The that represents the end of the editable range. + + + + Sets the editable range start. + + The editable range start. + + + + Sets the editable range end. + + The editable range end. + + + + Gets the editable range id. Read-only. + + The string that represents the editable range id. + + + + Gets the editable range start. Read-only. + + The that represents the start of the editable range. + + + + Gets the editable range end. Read-only. + + The that represents the end of the editable range. + + + + Represents the built-in document properties of Word document. + + + The following list contains the names of all the available built-in document properties: + + Category + Number of Bytes + Number of Lines + Number of Paragraphs + Number of Slides + Number of Notes + Number of Hidden Slides + Manager + Company + + + + The following code example demonstrates how to modify the built-in document properties of Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Set the value for Company property of the document + document.BuiltinDocumentProperties.Company = "Northwind Traders"; + //Set the value for Manager property of the document + document.BuiltinDocumentProperties.Manager = "Paul Anderson"; + //Set the value for Author property of the document + document.BuiltinDocumentProperties.Author = "Peter"; + //Set the value for Comments property of the document + document.BuiltinDocumentProperties.Comments = "This document provide the sales information of the year 2015"; + //Set the value for LastAuthor property of the document + document.BuiltinDocumentProperties.LastAuthor = "Johnson"; + //Set the value for Title property of the document + document.BuiltinDocumentProperties.Title = "Sales Information"; + //Set the value for Category property of the document + document.BuiltinDocumentProperties.Category = "Sales"; + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Set the value for Company property of the document + document.BuiltinDocumentProperties.Company = "Northwind Traders" + 'Set the value for Manager property of the document + document.BuiltinDocumentProperties.Manager = "Paul Anderson" + 'Set the value for Author property of the document + document.BuiltinDocumentProperties.Author = "Peter" + 'Set the value for Comments property of the document + document.BuiltinDocumentProperties.Comments = "This document provide the sales information of the year 2015" + 'Set the value for LastAuthor property of the document + document.BuiltinDocumentProperties.LastAuthor = "Johnson" + 'Set the value for Title property of the document + document.BuiltinDocumentProperties.Title = "Sales Information" + 'Set the value for Category property of the document + document.BuiltinDocumentProperties.Category = "Sales" + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + Represents the summary information of the document. + + + The following list contains the names of all the available summary document properties: + + Title + Subject + Author + Keywords + Comments + Template + Last Author + Revision Number + Application Name + Last Print Date + Creation Date + Last Save Time + Total Editing Time + Number of Pages + Number of Words + Number of Characters + Security + Category + + + + + + + Sorted list of properties + + + + + + + + + + + + + + + + + + + + + isSummary = true - summary property + isSummary = false - document summary property + + + + + + + Adds the specified name. + + The name. + The value. + + + + + + + + + + + Returns the value indicating whether the key exists in the properties collection. + + The integer that specifies the key. + True if the specified key is present, otherwise false. + + + + Sets the property value. + + The prop key. + The value. + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Closes this instance. + + + + + Gets or sets author name of the document. + + The string that specifies the author property. + + + + Gets or sets application name of the document. + + The string that specifies the application name property. + + + + Gets or sets the title of the document. + + The string that specifies the title property. + + + + Gets or sets the subject of the document. + + The string that specifies the subject property. + + + + Gets or sets the document keywords. + + The string that specifies the keywords in the document. + + + + Gets or sets the comments that provide additional information about the document. + + The string that specifies the additional information about the document. + + + + Gets or sets the template name of the document. + + The string that specifies the template document name. + + + + Gets or sets the last author name of the document. + + The string that specifies the last author name. + + + + Gets or sets the document revision number. + + /// The string that specifies the revision number. + + + + Gets or sets the document total editing time. + + The TimeSpan that specifies the total document editing time. + + + + Gets or sets the last print date of the document. + + The DateTime that specifies the time when the document is last printed. + + + + Gets or sets the creation date of the document. + + The DateTime that specifies the time when the document is created. + + + + Gets or sets the last save date of the document. + + The DateTime that specifies the time when the document is last saved. + + + + Gets total number of pages in the document + + The integer that represents the total number of pages. + + + + Gets total number of words in the document + + The integer that represents the total number of words. + + + + Gets the total number of characters in the document + + /// The integer that represents the total number of characters. + + + + Gets or sets thumbnail picture for document preview + + + + + Gets or sets document security level + + + + + Gets or Sets the ContentStatus of the document + + + + + + + + + + Gets summary count of document properties + + + + + + + + + + + + + + + + Initialize + + + + + Initialize + + + + + Initialize + + + + + isSummary = true - summary property + isSummary = false - document summary property + + + + + + + Creates a duplicate copy of the current built-in properties. + + The new that is created. + + + + + + + + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Closes this instance. + + + + + Gets or sets the category of the document. + + The string that represents the document category. + + + + Gets the number of bytes in the document. + + The integer that represents the number of bytes. + + + + Gets the number of lines in the document. + + The integer that represents the lines count in the document. + + + + Gets the number of paragraphs in the document. + + The integer that represents the paragraphs count in the document. + + + + Gets slide count in the document. + + The integer that specifies the slide count in the document. + + + + Gets Note count in the document. + + The integer that specifies the note count in the document. + + + + Gets hidden count in the document. + + The integer that specifies the hidden count in the document. + + + + Gets or sets Company property in the document. + + The string that specifies the company property. + + + + Gets or sets Manager property in the document. + + The string that specifies the manager property. + + + + Gets document hash + + + + + + + + + + Represents the page column in the Word document. + + + The following code example demonstrates how to display contents in multiple columns. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add the section into Word document + WSection section = document.AddSection() as WSection; + //Add the column into the section + Column column1 = new Column(document); + column1.Width = 150; + column1.Space = 20; + section.Columns.Add(column1); + //Add the column into the section + Column column2 = new Column(document); + column2.Width = 150; + column2.Space = 20; + section.Columns.Add(column2); + //Add the column into the section + Column column3 = new Column(document); + column3.Width = 150; + column3.Space = 20; + section.Columns.Add(column3); + //Add a paragraph to created section + IWParagraph paragraph = section.AddParagraph(); + //Add a paragraph to created section + paragraph = section.AddParagraph(); + string paraText = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"; + //Append the text to the created paragraph + paragraph.AppendText(paraText); + //Add the column breaks + paragraph.AppendBreak(BreakType.ColumnBreak); + //Add a paragraph to created section + paragraph = section.AddParagraph(); + //Append the text to the created paragraph + paragraph.AppendText(paraText); + //Add the column breaks + paragraph.AppendBreak(BreakType.ColumnBreak); + //Add a paragraph to created section + paragraph = section.AddParagraph(); + //Append the text to the created paragraph + paragraph.AppendText(paraText); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add the section into Word document + Dim section As WSection = TryCast(document.AddSection(), WSection) + 'Add the column into the section + Dim column1 As New Column(document) + column1.Width = 150 + column1.Space = 20 + section.Columns.Add(column1) + 'Add the column into the section + Dim column2 As New Column(document) + column2.Width = 150 + column2.Space = 20 + section.Columns.Add(column2) + 'Add the column into the section + Dim column3 As New Column(document) + column3.Width = 150 + column3.Space = 20 + section.Columns.Add(column3) + 'Add a paragraph to created section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add a paragraph to created section + paragraph = section.AddParagraph() + Dim paraText As String = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula" + 'Append the text to the created paragraph + paragraph.AppendText(paraText) + 'Add the column breaks + paragraph.AppendBreak(BreakType.ColumnBreak) + 'Add a paragraph to created section + paragraph = section.AddParagraph() + 'Append the text to the created paragraph + paragraph.AppendText(paraText) + 'Add the column breaks + paragraph.AppendBreak(BreakType.ColumnBreak) + 'Add a paragraph to created section + paragraph = section.AddParagraph() + 'Append the text to the created paragraph + paragraph.AppendText(paraText) + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Represents the base formatting. + + + + + + + + + + + + + + + Member to hold the collection of properties values and its keys. + + + + + + Member to hold the collection of old properties values and its keys. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents the revision collection. + + + + + Check whether the key is present in any of the base formats + + The key for the property + True, if the base format contains that property in its properties hash; else, false + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The object. + To represent textbox instance + + + + Initializes a new instance of the class. + + The object. + + + + Initializes a new instance of the class. + + The object. + The that is the owner of the current item. + + + + Initializes a new instance of the class. + + The that represents the parent format. + The integer that represents the parent key. + + + + Initializes a new instance of the class. + + The that represents the parent format. + The integer that represents the parent key. + The integer that represents the parent offset. + + + + Imports the container. + + The format. + + + + Imports the members. + + + The object. + + + + + + + + + + Returns the value indicating whether the key exists in the properties collection. + + The integer that specifies the key. + + True if the specified key is present, otherwise false. + + + + + Returns a value indicating whether the key exists and its corresponding boolean value. + + The integer that specifies the key. + + True if the specified key is present with its boolean value, otherwise false. + + + + + Clears the formatting. + + + + + Returns the default values. + + + The integer that specifies the key. + An object that specifies the default value. + + + + Gets the composite values. + + + The integer that specifies the key. + The object. + + + + Occurs on format change. + + + The object. + The integer that represents the property key. + + + + + + + + + + + Gets the Single Property Modifier Record option value for the specified property. + + + The integer that represents the property key. + The integer that represents the SPRM value. + + + + Closes this instance. + + + + + Ensures the composites. + + + + + Ensures the composites. + + The keys of the properties. + + + + Returns the key of the base format. + + + The integer which specifies the key. + The key of the parent format. + + + + Returns the whole key. + + + The integer that specifies the key. + The entire key. + + + + Returns the default composite value. + + + The integer that specifies the key. + The object. + The element. + + + + + + + + + Removes the format changes. + + + + + Accepts the changes. + + + + + Gets the style change option. + + + + + + Gets the change option. + + + + + + Removes the positioning. + + + + + Compare the properties hash count of two formats + + The format to be compared + True if the count is equal, else false + + + + Compare the properties hash collection between two formats. + + The format to be compared + + + + Checks whether the key is need to be considered or not. + + + + + + + Compares the particular property value with the formatbase property value + + The property key. + The format. + + + + Compares the proprerty value of one format with another format. + + The value. + The current value. + + + + Gets the ARGB color code + + The color + + + + Copies property hash. + + The format. + + + + Gets the composite parent key. + + The key. + The parent level. + + + + + Updates the properties. + + The format. + + + + Copies the format. + + The format. + + + + Checks the char style. + + The key. + + + + + Gets the base format value. + + The key. + + + + + Parses the DTTM. + + The value. + + + + + Gets the DTTM int value. + + The dt. + + + + + Compares the array. + + The buffer1. + The buffer2. + + + + + Gets / sets whether format is default. + + + + + Gets or sets a value indicating whether there is a formatting change. + + + + + + + + + + + + + + + Gets or sets the value for the property with specified key. + + + The key for the property. + An object with the specific key. + + + + Gets parent format. + + + + + Gets the revision changes marked with revision marks in a range or document. + + + + + Initialize a new instance of the class. + + The object. + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Clones itself. + + + + + + Gets the default values for the key. + + + + + + + Comapre the section values with previous section. + + + + + + + Sets the property value. + + The property key. + The value. + + + + Gets the property value. + + The prop key. + + + + + Gets or sets column width measured in points. + + The float that represents the width of the column. + + + + Gets or sets spacing between current and next column measured in points. + + The float that represents the space between the columns. + + + + Represents the custom document properties for the specified document. + + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Add the new custom property Typist with value + document.CustomDocumentProperties.Add("Typist", "Andrew"); + //Add the new custom property Publisher with value + document.CustomDocumentProperties.Add("Publisher", "Stephen"); + //Add the new custom property Recorded by with value + document.CustomDocumentProperties.Add("Recorded by", "Harry"); + //Add the new custom property Recorded date with value + document.CustomDocumentProperties.Add("Recorded date", new DateTime(2015, 2, 23)); + //Save and close the Word document + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Add the new custom property Typist with value + document.CustomDocumentProperties.Add("Typist", "Andrew") + 'Add the new custom property Publisher with value + document.CustomDocumentProperties.Add("Publisher", "Stephen") + 'Add the new custom property Recorded by with value + document.CustomDocumentProperties.Add("Recorded by", "Harry") + 'Add the new custom property Recorded date with value + document.CustomDocumentProperties.Add("Recorded date", New DateTime(2015, 2, 23)) + 'Save and close the Word document + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Sorted list of properties + + + + + + Initialize + + + + + Initialize + + + + + Adds the new custom document property with specified name and its value. + + A String that represents the name of the property to add. + The value for the property. + The new this method creates. + + + + Removes the specified custom property from the document. + + A String that represents the name of the property. + The specified property is not present in the document. + + + + Creates a duplicate copy of this + + The newly created duplicate copy of the current CustomDocumentProperties instance + + + + Writes object data as inside xml element. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + The value indicating the presence of xml content. + + + + Reads point and it's type from XML. + + Reader object. + + + + Closes this instance. + + + + + + + + + + Gets the custom property by specified name. Read-only. + + + + + Gets the custom property by specified index. Read-only. + + + + + Gets the total number of custom properties in the document. Read-only. + + + + + Represents document property. + + + + + Start index for Id2 PropVariant property. + + + + + Start year for FILETIME structure. + + + + + Property id. + + + + + Property name. + + + + + Property value. + + + + + Property type. + + + + + The source of a linked custom document property. Read/write String. + + + + + True if the value of the custom document property is linked to the content + of the container document. False if the value is static. Read/write Boolean. + + + + + Default constructor. + + + + + Initializes new instance of the class. + + Property name. + Property value. + + + + Initializes new instance of the class. + + Property name. + Property value. + Property type + + + + Initializes new instance of the class. + + Property id. + Property value. + + + + Initializes new instance of the document property. + + Variant that contains property data. + + Indicates whether property is from document summary or not (only for + built-int properties). + + + + Detects type of the string. + + String value to check. + Detected string type. + + + + Returns the boolean value for the property. + + True if the value exists, otherwise false. + + + + Convert the object in DateTime. + + The converted value. + + + + Convert the object in float value. + + The converted float value of the property. + + + + Convert the object in double. + + The converted double value of the property. + + + + Convert the object in Int value. + + The converted integer value of the property. + + + + Returns a that represents the current . + + + A that represents the current . + + + + + Convert the object as byte array. + + The array. + + + + Gets the clip data. + + + + + + Copies document property data into PropVariant. + + Destination object. + PropertyId for custom properties. + True if was able to fill variant; false otherwise. + + + + Converts propertyId into correct index. + + PropertyId to convert. + [out] Indicates whether this is document summary property of simply document property. + Correct property index. + + + + Tries to detect and set property type. + + + + + Sets value of LinkSource property. + + Variant that contains value to set. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Creates copy of the internal value. + + + + + Closes this instance. + + + + + Indicates whether property is built-in. Read-only. + + + + + Returns / sets property id for built-in properties. + + + + + Gets the property name. Read-only. + + The string that represents the property name. + + + + Gets or sets the property value. + + An object that specifies the property value. + + + + Gets the type of the value. Read-only. + + The member that specifies the type of the value. + + + + Gets / sets boolean value. + + + + + Gets / sets integer value. + + + + + Gets / sets 4-bytes signed integer value. + + + + + Gets / sets double value. + + + + + Gets / sets string value. + + + + + Gets / sets DateTime value. + + + + + Gets / sets TimeSpan value. + + + + + Gets / sets Blob value. + + + + + Gets or sets clipboard data value. + + The that specifies the clipboard data. + + + + Gets / sets array of strings. + + + + + Gets / sets array of objects. Supported object types are string and Int32. + + + + + Gets / sets document property type. + + + + + Returns or sets the source of a linked custom document property. Read/write String. + + + + + True if the value of the custom document property is linked to the content of the container document. False if the value is static. Read/write Boolean. + + + + + Internal name of the document property. + + + + + Represents the Hyperlink. + + + The following code example demonstrates how to insert a web link. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("Web Hyperlink: "); + paragraph = section.AddParagraph(); + //Append web hyperlink to the paragraph + IWField field = paragraph.AppendHyperlink("http://www.syncfusion.com", "Syncfusion", HyperlinkType.WebLink); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("Web Hyperlink: ") + paragraph = section.AddParagraph() + 'Append web hyperlink to the paragraph + Dim field As IWField = paragraph.AppendHyperlink("http://www.syncfusion.com", "Syncfusion", HyperlinkType.WebLink) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + The following code example demonstrates how to add an email link. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("Email hyperlink: "); + paragraph = section.AddParagraph(); + //Append Email hyperlink to the paragraph + paragraph.AppendHyperlink("mailto:john@gmail.com","John" , HyperlinkType.EMailLink); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("Email hyperlink: ") + paragraph = section.AddParagraph() + 'Append Email hyperlink to the paragraph + paragraph.AppendHyperlink("mailto:john@gmail.com", "John", HyperlinkType.EMailLink) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + The following code example demonstrates how to add a file hyperlink. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("File Hyperlinks: "); + paragraph = section.AddParagraph(); + //Append hyperlink field to the paragraph + paragraph.AppendHyperlink(@"D:\Template.docx","File", HyperlinkType.FileLink); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("File Hyperlinks: ") + paragraph = section.AddParagraph() + 'Append hyperlink field to the paragraph + paragraph.AppendHyperlink("D:\Template.docx", "File", HyperlinkType.FileLink) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + The following code example demonstrates how to add a bookmark hyperlink. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Create new Bookmark + paragraph.AppendBookmarkStart("Introduction"); + paragraph.AppendText("Hyperlink"); + paragraph.AppendBookmarkEnd("Introduction"); + paragraph.AppendText("\nA hyperlink is a reference or navigation element in a document to another section of the same document or to another document that may be on or part of a (different) domain."); + paragraph = section.AddParagraph(); + paragraph.AppendText("Bookmark Hyperlink: "); + paragraph = section.AddParagraph(); + //Append Bookmark hyperlink to the paragraph + paragraph.AppendHyperlink("Introduction", "Bookmark", HyperlinkType.Bookmark); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Create new Bookmark + paragraph.AppendBookmarkStart("Introduction") + paragraph.AppendText("Hyperlink") + paragraph.AppendBookmarkEnd("Introduction") + paragraph.AppendText(vbLf & "A hyperlink is a reference or navigation element in a document to another section of the same document or to another document that may be on or part of a (different) domain.") + paragraph = section.AddParagraph() + paragraph.AppendText("Bookmark Hyperlink: ") + paragraph = section.AddParagraph() + 'Append Bookmark hyperlink to the paragraph + paragraph.AppendHyperlink("Introduction", "Bookmark", HyperlinkType.Bookmark) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + The following code example demonstrates how to add image hyperlink. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("Image Hyperlink"); + paragraph = section.AddParagraph(); + //Create a new image instance and load image + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + //Append new image hyperlink to the paragraph + paragraph.AppendHyperlink("http://www.syncfusion.com", picture, HyperlinkType.WebLink); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("Image Hyperlink") + paragraph = section.AddParagraph() + 'Create a new image instance and load image + Dim picture As New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + 'Append new image hyperlink to the paragraph + paragraph.AppendHyperlink("http://www.syncfusion.com", picture, HyperlinkType.WebLink) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Hyperlink field + + + + + Type of the hyperlink + + + + + File path. + + + + + URL link. + + + + + Bookmark. + + + + + Text which will be displayed on the place of hyperlink + + + + + Hyperlink image + + + + + Local Reference + + + + + Initializes a new instance of the class. + + The hyperlink. + + + + Performs hyperlink field validation. + + The field. + + + + Parses the hyperlink + + + + + Updates the text to display. + + + + + Sets the image to display. + + + + + Finds the first item of hyperlink text range. + + + + + + Updates the hyperlink type. + + + + + Sets the URI. + + The URI. + + + + Sets the name of the bookmark. + + The name. + + + + sets the local reference + + + + + + Sets the file path. + + The file path. + + + + Checks the value. + + The value. + + + + + Checks the path. + + The path. + + + + + Checks the URI. + + The URI. + + + + + Set the field code of hyperlink field. + + + + + Implemented alternative method to improve the performance + + + + + + + + Gets or sets the file path for file link. + + The string that specifies the path of the file. + + + + Gets or sets URL link for web link. + + The string that specifies URL. + + + + Gets or sets the bookmark name for Bookmark hyperlink. + + + + + Gets or sets the hyperlink type. + + + + + Gets or sets the text which will be displayed on the place of hyperlink. + + The string that specifies the text to display. + + + + Gets or sets the image which will be displayed on the place of hyperlink. + + The to display. + + + + Gets the field. + + The field. + + + + Gets or sets the Local Reference for the hyperlink + + The string that specifies the local reference. + + + + Represents the image class. + + + + + Initializes a new instance of the class. + + The stream. + + + + + + + + + Initializes this instance. + + + + + Checks if tiff. + + + + + + Checks if image is Bitmap. + + + + + + Parses the BMP image. + + + + + Checks if icon. + + + + + + Checks if PNG. + + + + + + Checks if JPEG. + + + + + + Checks if GIF. + + + + + + Checks if EMF or WMF. + + + + + + Parses the PNG image. + + + + + Gets the specified resource file as stream. + + The resource file name + Stream of the specified resource file + + + + Parses the JPEG image. + + + + + Generate higth wnd width of the JPEG image from byte array. + + + + + + + + + Generate higth wnd width of the JPEG image from byte array when the byte array has JFIF information. + + + + + + + + + generate higth wnd width of the JPEG image from byte array when the byte array has EXIF information. + + + + + + + + + (index+11) specifies the the unit.the next 4 bytes specifies the resolution of image. + first two bytes horizontal resolutin and the next two bytes vertical resolution + + + The end index of JFIF in image data + + + + 26 denotes hexadecimal value of 1A and 1 denotes the hexadecimal value of 01 and both specifies directory tag value. + 5 ,0 (intel) or 0,5 (motorola) specifies the Data type . + 1,0,0,0(intel) or 0,0,0,1(motorola) are specifies the component/byte count in the directory + the next following 4 index values denotes offset value of Image resolution from Tiff header.Added +12 value because of we left 12 bytes before TIFF header. + From the i index first height bytes for horizontal resolution and next 8 bytes for vertical Resolution. + + + + + + Parses the GIF image. + + + + + Parses the icon image. + + + + + Parses the EMF or WMF image. + + + + + Parses tif image + + + + + Reads the Uint32. + + + + + + Reads the int32. + + + + + + Reads the Uint16. + + + + + + Reads the int16. + + + + + + Reads the word. + + + + + + Reads the short LE. + + + + + + Reads the string. + + The len. + + + + + Resets this instance. + + + + + + + + + + + + + + + + + + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Gets the width. + + The width. + + + + Gets the height. + + The height. + + + + Gets the image format. + + The image format. + + + + Gets the size. + + The size. + + + + Gets the image data. + + The image data. + + + + + + + + + Gets the Horizontal resolution + + + + + gets and sets the vertical Resolution + + + + + Gets a value indicating whether this instance is metafile. + + + true if this instance is metafile; otherwise, false. + + + + + Specifies the image format. + + + + + Initializes a new instance of the class. + + The word document. + The image bytes. + + + + Detaches from document image collection + + + + + Compare the byte array + + + + + + + Closes this instance. + + + + + Updates the image size for partial trust mode. + + The image. + + + + Updates the size of the image. + + The image. + + + + Gets the image internal for partial trust mode. + + The image bytes. + + + + + Gets the image. + + The image bytes. + + + + + Gets the image. + + The image bytes. + + + + + Gets image byte array. + + + + + Gets image byte array. + + + + + Gets hash of the image. + + + + + Gets or sets the occurence count. + + The occurence count. + + + + Gets or sets a value indicating whether this instance is metafile. + + + true if this instance is metafile; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is added to collection or not. + + + true if this instance is added to collection; otherwise, false. + + + + + Gets or sets the size. + + The size. + + + + Gets or sets the image format for partial trust mode. + + + The image format for partial trust mode. + + + + + Gets or sets the image format. + + The image format. + + + + Gets or sets the image format. + + The image format. + + + + Represents the base implementation for paragraphs and tables. + + + + + Represents text range functions + + + + + Replaces all entries of given regular expression with replace string. + + The used to find the text. + The string specifies the text to replace. + The integer that represents the count of the replacements made. + + + + Replaces all entries of given string with replace string, taking into + consideration case sensitive and whole word options. + + The string represents the text to be found. + The string specifies the text to replace. + True to consider the case, otherwise false. + True to consider the text as whole word, otherwise false. + The integer that represents the count of the replacements made. + + + + Replaces the regular expression with a text selection. + + The used to find the text. + The which specifies the text to replace. + The integer that represents the count of the replacements made. + + + + Initializes a new instance of the class with the + specified . + + The instance. + + + + Finds the text based on the specified regular expression. + + The used to find the text. + The selection of text inside a paragraph along with formattings. + + + + Replaces all entries of given regular expression with the specified string. + + The used to find the text. + The string specifies the text to replace. + The integer that represents the count of the replacements made. + + + + Replaces all entries of given string with replace string, taking into + consideration case sensitive and whole word options. + + The string represents the text to be found. + The string specifies the text to replace. + True to consider the case; otherwise, false. + True to consider the text as whole word; otherwise, false. + The integer that represents the count of the replacements made. + + + + Replaces the specified regular expression with a . + + The used to find the text. + The which specifies the text to replace. + The integer that represents the count of the replacements made. + + + + Replaces the specified regular expression with a along with its formatting. + + The used to find the text. + The which specifies the text to replace. + True if save with source formatting; otherwise, false. + The integer that represents the count of the replacements made. + + + + Returns all the entries of given regular expression. + + The used to find the text. + + + + + Gets the next TextBodyItem in the document. + + + + + + Accepts or rejects changes tracked from the moment of last change acceptance. + + if it accepts changes, set to true. + + + + Checks a value indicating whether this item was inserted to the document, + when "Track Changes" is or was set to "true". + + + + + + Checks a value indicating whether this item was deleted from the document, + when "Track Changes" is or was set to "true". + + + + + + Defines whether format was changed. + + + + + + Defines whether paragraph/table format is changed. + + + + + + Removes the changes from character format. + + + + + Accept changes from paragraph/table. + + + + + Removes the character format changes. + + + + + Removes the paragraph format changes. + + + + + Determines whether item has tracked changes. + + + If it has tracked changes, set to true. + + + + + Sets the changed Character format. + + if it is check, set to true. + + + + Sets the changed Paragraph format. + + if it sets the Format, set to true. + + + + Sets the delete revision. + + if it sets delete revision, set to true. + + + + Sets the insert revision. + + if it sets insert revision, set to true. + + + + Apply insert revision for the item. + + + + + Apply delete revision for the item. + + + + + Gets the next text body item. + + + The instance from which the next item to be found. + The next object. + + + + Gets the owner text body of the current . + + The instance that is the owner of the current item. + + + + Gets a value indicating whether this item was inserted to the document, + when "Track Changes" is or was set to "true". + + True if this instance was inserted; otherwise, false. + + + + Gets a value indicating whether this item was deleted from the document, + when "Track Changes" is or was set to "true". + + True if this instance is delete revision; otherwise, false. + + + + Defines whether format was changed. + + The is changed format. + + + + Gets a value indicating whether paragraph/table format is changed. + + + If paragraph/table format is changed, set to true. + + + + + + + + + + + + + + + Initializes a new instance of the class. + + The doc. + + + + Creates a duplicate of the entity. + + + + + + Gets Next the text body item in the document. + + + + + + Returns the bool value based on the file extension of the given file name for updating teh alternate chunk. + + + + + + + Update the current Alternate chunk element in the Word document + + + + + Check the Textwrapping style of Picture + + + + + + + + Merge the owner paragraph of altchunk with the altchunk first + + + + + Merge the altchunk first paragraph with the owner text body last paragraph. + + Index of the AltChunk + Owner text body + Altchunk text body + + + + Updates the bookmarks into the AltChunk. + + The textbody. + Textbody child count before update AltChunk. + + + + Inserts the bookmark start to the body's first item. + + Textbody last item. + Bookmark start. + True if bookmark start is inserted, otherwise false. + + + + Adds the bookmark end to the body's last item. + + Textbody last item. + Bookmark end. + True if bookmark end is added, otherwise false. + + + + Clears the existing headers footers. + + The section. + + + + Update the HeaderFooter to the main document if the parent element is body/docPartBody/tableCell + + + + + + + + Checks a value indicating whether this item was deleted from the document, + when "Track Changes" is or was set to "true". + + + + if this instance is delete revision, set to true. + + + + + Sets the changed Paragraph format for table. + + if it specifies the format to be changed, set to true. + + + + Sets the changed C format. + + if it specifies formatting, set to true. + + + + Sets the delete rev. + + if specifies delete revision, set to true. + + + + Sets the insert rev. + + if it specifies insert revision, set to true. + + + + Determines whether item has tracked changes. + + + if has tracked changes, set to true. + + + + + Replaces all entries of given regular expression with replace string. + + The used to find the text. + The string specifies the text to replace. + The integer that represents the count of the replacements made. + + + + Replaces all entries of given string with replace string, taking into + consideration case sensitive and whole word options. + + The string represents the text to be found. + The string specifies the text to replace. + True to consider the case, otherwise false. + True to consider the text as whole word, otherwise false. + The integer that represents the count of the replacements made. + + + + Replaces the regular expression with a text selection. + + The used to find the text. + The which specifies the text to replace. + The integer that represents the count of the replacements made. + + + + Replaces all entries of given regular expression with TextRangesHolder. + + The pattern. + The text selection. + if it specifies save source formatting, set to true. + + + + + Replaces all entries of given string with TextRangesHolder, taking into + consideration caseSensitive and wholeWord options. + + The given. + The text selection. + if it specifies case sensitive, set to true. + if it specifies to check whole word, set to true . + + + + Replaces all entries of given string with TextRangesHolder, taking into + consideration caseSensitive and wholeWord options. + + The given. + The text selection. + if it specifies case sensitive, set to true . + if it specifies to search a whole word, set to true . + if it specifies save source formatting, set to true. + + + + + Replaces first entry of given string with replace string, taking into + consideration caseSensitive and wholeWord options. + + The string to replace + Replace string + Is case sensitive replace? + Search for whole word? + + + + + Replaces all entries of given regular expression with replace string. + + + + + + + Removes the character format changes. + + + + + Removes the paragraph/table format changes. + + + + + Accepts the changes for character format. + + + + + Accepts changes in paragraph/table format. + + + + + Defines whether format was changed. + + + + + + Checks a value indicating whether this item was inserted to the document, + when "Track Changes" is or was set to "true". + + + + if this instance was inserted, set to true. + + + + + Returns first entry of given regex. + + The pattern. + + + + + Returns first entry of given string, taking into consideration caseSensitive + and wholeWord options. + + The given. + if it is case sensitive, set to true. + if it specifies to search a whole word, set to true. + + + + + Accepts or rejects changes tracked from the moment of last change acceptance. + + if it accepts changes, set to true. + + + + Returns all entries of given regex. + + The pattern. + + + + + Closes the item. + + + + + Defines whether paragraph format is changed. + + + + + + Clones the relations. + + The doc. + + + + Updates the XML parts. + + The destination. + + + + Updates the XML part container. + + The SRC container. + The dest container. + The parts. + The index. + + + + + Updates the XML part. + + The SRC container. + The dest container. + The XML part. + + + + + Gets / sets the targer Id. + + The Targer id. + + + + Gets / sets the Content extension. + + The Content extension. + + + + Gets or sets the import option. + + The import option. + + + + Gets / sets the Content Type. + + The Content Type. + + + + Gets / sets the Content Path. + + The Content Path. + + + + Gets the alternate chunk stream. + + The alternate chunk stream. + + + + Gets the bookmark start and end which present before and after the alternate chunk. + + + + + Gets or sets the value indicates whether the owner document having one section only. + + + + + Gets or sets the value indicates whether the chunk is first chunk. + + + + + Gets or sets the value indicates whether the chunk is last chunk. + + + + + Gets or sets the value indicates the first chunk last section. + + + + + Gets the type of the entity. + + The of the current item. + + + + Gets the child entities. + + The child entities. + + + + + + + + + + + + + + + + Represents the Metafile header. + + + + + Gets a that bounds the associated . + + A that bounds the associated . + + + + Contains types that support which is used to create and manipulate Word document. + + + + + + Represents the picture that appears behind the document. + + + The following code snippet illustrates how to add a picture watermark to the Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add a section and a paragraph in the document + document.EnsureMinimal(); + IWParagraph paragraph = document.LastParagraph; + paragraph.AppendText("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua"); + //Create a new picture watermark + PictureWatermark picWatermark = new PictureWatermark(); + //Set the scaling to picture + picWatermark.Scaling = 120f; + picWatermark.Washout = true; + //Set the picture watermark to document + document.Watermark = picWatermark; + //Set the image to the picture watermark + picWatermark.Picture = Image.FromFile("ImagesPath" + "Water lilies.jpg"); + document.Save("PictureWatermark.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add a section and a paragraph in the document + document.EnsureMinimal() + Dim paragraph As IWParagraph = document.LastParagraph + paragraph.AppendText("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua") + 'Create a new picture watermark + Dim picWatermark As New PictureWatermark() + 'Set the scaling to picture + picWatermark.Scaling = 120.0F + picWatermark.Washout = True + Set the picture watermark to document + document.Watermark = picWatermark + Set the image to the picture watermark + picWatermark.Picture = Image.FromFile(ImagesPath + "Water lilies.jpg") + document.Save("PictureWatermark.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + Represents the text or picture that appears behind the document. + + + + + + + + + + + + Initializes a new instance of the class. + + The type. + + + + Initializes a new instance of the class. + + The doc. + The type. + + + + Removes the self. + + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + + + + + + Gets the type of the entity. + + The of the current item. + + + + Gets the watermark type. Read-Only. + + A represents the type of watermark in this + + + + Gets or sets the index of the order. + + The index of the order. + + + + Gets or sets the shape id. + + + + + Picture watermark members. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified + and effect. + + Image that appear behind the document + Washout property to set light shading effect to picture. + This constructor is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin application. + + The following code snippet illustrates how to add a picture watermark to the Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Create a new picture watermark + PictureWatermark picWatermark = new PictureWatermark(Image.FromFile("ImagesPath" + "Water lilies.jpg"), false); + //Set the picture watermark to document + document.Watermark = picWatermark; + document.Save("PictureWatermark.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Create a new picture watermark + Dim picWatermark As New PictureWatermark(Image.FromFile(ImagesPath + "Water lilies.jpg"), False) + 'Set the picture watermark to document + document.Watermark = picWatermark + document.Save("PictureWatermark.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Initializes a new instance of the class. + + The doc. + + + + Closes the instance + + + + + Updates the image. + + + + + Gets the image. + + The image bytes. + + + + + Registers child objects in XDSL holder. + + + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Clones itself. + + + Returns cloned object. + + + + Gets or sets the picture scaling value in percents. + + The float that specifies the picture scaling value. + + + + Gets or sets a value indicating whether the washout property is enabled for the picture watermark. The default value is true. + + True if to have light shading effect to picture; otherwise, false. + + + + Gets or sets the picture for picture watermark. + + The that represents the picture. + This property is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin application. + + + + Gets or sets the WPicture. + + + + + Gets/sets index in BStoreContainer which contains + picture watermark data (image). + + + + + Represents the tabs in the document. + + + The following code example demonstrates how to modify the existing tab values in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument("Template.docx"); + //Add the section into Word document + WSection section = document.AddSection() as WSection; + //Access the first paragraph of the document + WParagraph paragraph = document.Sections[0].Paragraphs[0]; + //Get the first tab from the paragraph + Tab tab = paragraph.ParagraphFormat.Tabs[0]; + //Adjust the tab values + tab.Justification = TabJustification.Centered; + tab.Position = 200; + tab.TabLeader = Syncfusion.DocIO.DLS.TabLeader.Dotted; + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument("Template.docx") + 'Add the section into Word document + Dim section As WSection = TryCast(document.AddSection(), WSection) + 'Access the first paragraph of the document + Dim paragraph As WParagraph = document.Sections(0).Paragraphs(0) + 'Get the first tab from the paragraph + Dim tab As Tab = paragraph.ParagraphFormat.Tabs(0) + 'Adjust the tab values + tab.Justification = TabJustification.Centered + tab.Position = 200 + tab.TabLeader = Syncfusion.DocIO.DLS.TabLeader.Dotted + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The doc. + The position. + The justification. + The leader. + + + + Initializes a new instance of the class. + + The doc. + The position. + The delete position. + The justification. + The leader. + + + + Returns the value indicating whether the key exists in the properties collection. + + The integer that specifies the key. + True if the specified key is present, otherwise false. + + + + Sets the property value. + + The prop key. + The value. + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + + + + + + + Called when tab was changed. + + + + + Compares the tabs + + + + + Gets or sets the . + + The member that specifies the tab justification + of this . + + + + Gets or sets the . + + The member that specifies the tab leader. + + + + Gets or sets the position of the tab measured in points. + + The float that specifies the position of tab. + + + + Gets or sets the delete position for the tab measured in points. + + The float that specifies the delete position. + + + + Properties Collection. + + + + + Gets or sets the key in property collection. + + The integer that specifies the key. + An object that specifies the key. + + + + Represents the text that appears behind the document. + + + The following code snippet illustrates how to add a text watermark to the Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add a section and a paragraph in the document + document.EnsureMinimal(); + IWParagraph paragraph = document.LastParagraph; + paragraph.AppendText("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua"); + //Create a new text watermark + TextWatermark textWatermark = new TextWatermark(); + //Set the created watermark to document + document.Watermark = textWatermark; + //Set the text watermark font size + textWatermark.Size = 72; + //Set the text watermark layout to Horizontal + textWatermark.Layout = WatermarkLayout.Horizontal; + textWatermark.Semitransparent = false; + //Set the text watermark text color + textWatermark.Color = Color.Black; + //Set the text to text watermark text + textWatermark.Text = "TextWatermark"; + document.Save("TextWatermark.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add a section and a paragraph in the document + document.EnsureMinimal() + Dim paragraph As IWParagraph = document.LastParagraph + paragraph.AppendText("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua") + 'Create a new text watermark + Dim textWatermark As New TextWatermark() + 'Set the text watermark to document + document.Watermark = textWatermark + 'Set the text watermark font size + textWatermark.Size = 72 + 'Set the text watermark layout to Horizontal + textWatermark.Layout = WatermarkLayout.Horizontal + textWatermark.Semitransparent = False + 'Set the text watermark text color + textWatermark.Color = Color.Black + 'Set the text to the text watermark + textWatermark.Text = "TextWatermark" + document.Save("TextWatermark.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + Text watermark members. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with watermark text. + + A String that appears behind the document + + The following code snippet illustrates how to add a text watermark to the Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template,docx"); + //Create a new text watermark + TextWatermark textWatermark = new TextWatermark("Demo Text"); + //Set the created watermark to document + document.Watermark = textWatermark; + document.Save("TextWatermark.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template,docx") + 'Create a new text watermark + Dim textWatermark As New TextWatermark("Demo Text") + 'Set the created watermark to document + document.Watermark = textWatermark + document.Save("TextWatermark.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Initializes a new instance of the class with the specified watermark text, font name, font size and layout options. + + A String that represents which appears behind the document + A String that represents the font name for the + A float value that represents the visual appearance size for the + A represents the appearance position of the watermark text in this + + The following code snippet illustrates how to add a text watermark to the Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template,docx"); + //Create a new text watermark + TextWatermark textWatermark = new TextWatermark("Demo Text", "Arial", 48, WatermarkLayout.Diagonal); + //Set the created watermark to document + document.Watermark = textWatermark; + document.Save("TextWatermark.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template,docx") + 'Create a new text watermark + Dim textWatermark As New TextWatermark("Demo Text", "Arial", 48, WatermarkLayout.Diagonal) + 'Set the created watermark to document + document.Watermark = textWatermark + document.Save("TextWatermark.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Initializes a new instance of the class. + + The doc. + + + + Reads object data from xml attributes. + + + The object. + + + + Writes object data as xml attributes. + + + The object. + + + + Sets the default values for text Watermark properties. + + + + + Set the default size of watermark. + + + + + Gets the size of the shape + + + + + + Returns the value indicating whether the key exists in the properties collection. + + The integer that specifies the key. + True if the specified key is present, otherwise false. + + + + Sets the property value. + + The prop key. + The value. + + + + Gets or sets a value indicating whether this is visible. + + + True if visible; otherwise, false. + + + + + Gets or sets watermark text. + + A String that appear behind the document. + + + + Gets or sets watermark text's font name. + + A String that represents the font name for the + Setting new value to this will not auto update the width and height of the TextWatermark. Have to specify the and explicitly in ASP.NET Core and Xamarin platforms + + + + Gets or sets watermark text's size. + + A float value that represents the visual appearance size for the + Setting new value to this will not auto update the width and height of the TextWatermark. Have to specify the and explicitly in ASP.NET Core and Xamarin platforms + + + + Gets or sets watermark text display color. + + A Color value represents the visual appearance color for the + + + + Gets or sets semitransparent property for Text watermark. The default is false. + + True if the watermark text appear as semitransparent; otherwise, false + + + + Gets or sets layout for watermark text. + + A represents the appearance position of the watermark text in this . + + + + Gets or sets watermark text's height. + + A float value represents the visual appearance height for . + is only applicable for ASP.NET Core and Xamarin platforms. + + + + Gets or sets watermark text's width. + + A float value represents the visual appearance width for . + is only applicable for ASP.NET Core and Xamarin platforms. + + + + Gets shape size. + + The size of the shape. + + + + Gets or sets the wrapping style of text watermark. + + + + + Gets or sets the horizontal origin of text watermark. + + + + + Gets or sets the vertical origin of text watermark. + + + + + Gets or sets the text watermark horizontal alignment. + + + + + Gets or sets the text watermark vertical alignment. + + + + + Gets or sets the horizontal absolute position. + + + + + Gets or sets the vertical absolute position. + + + + + Gets or sets the the rotation angle. + + + + + Gets or sets the position type of text watermark. + + + + + Properties Collection. + + + + + Gets or sets the key in property collection. + + The integer that specifies the key. + An object that specifies the key. + + + + Represents the Word document variables. + + + The following code snippet illustrate how to add a DocVariable field in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("First Name of the customer: "); + //Add the DocVariable field with Variable name and its type + paragraph.AppendField("FirstName", FieldType.FieldDocVariable); + paragraph = section.AddParagraph(); + paragraph.AppendText("Last Name of the customer: "); + //Add the DocVariable field with Variable name and its type + paragraph.AppendField("LastName", FieldType.FieldDocVariable); + //Add the value for variable in WordDocument.Variable collection + document.Variables.Add("FirstName", "Jeff"); + document.Variables.Add("LastName", "Smith"); + //Update the document fields + document.UpdateDocumentFields(); + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("First Name of the customer: ") + 'Add the DocVariable field with Variable name and its type + paragraph.AppendField("FirstName", FieldType.FieldDocVariable) + paragraph = section.AddParagraph() + paragraph.AppendText("Last Name of the customer: ") + 'Add the DocVariable field with Variable name and its type + paragraph.AppendField("LastName", FieldType.FieldDocVariable) + 'Add the value for variable in WordDocument.Variable collection + document.Variables.Add("FirstName", "Jeff") + document.Variables.Add("LastName", "Smith") + 'Update the document fields + document.UpdateDocumentFields() + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Document variables + + + + + Initializes a new instance of the class. + + + + + Adds new document variable to document. + + The string that specifies the varaible name. + The string that specifies the varaible value. + + + + Gets variable's key by its index. + + The integer that specifies the index of the variable. + The string that represents the key of the variable. + + + + Gets variable's value by the index. + + The integer that specifies the index of the variable. + The string that represents the value of the variable. + + + + Removes document variable with specified name from the document. + + The string that represents the name of the variable. + + + + Closes this instance. + + + + + Updates the variables. + + The variables. + + + + Converts collection of variables to byte array. + + + + + + Finds the item. + + The index. + if returns name, set to true. + + + + + Checks the index. + + The index. + + + + Gets or sets the variable with the specified name. + + The string that specifies the name of the variable. + The string that represents the variable name. + + + + Gets the count of variables. + + The integer that specifies the variables count. + + + + Gets the collection of name/value items. + + The items. + + + + Represents the item of drop down formfield. + + + + + + + + + + Initializes a new instance of the class. + + The document + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Clones this instance. + + + + + + Gets / sets current DropDownItem text + + + + + Represents page headers and footers + + + The following code example demonstrates how to add text to different types of headers and footers. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Creates a new document. + WordDocument document = new WordDocument(); + //Adds the first section to the document. + IWSection section = document.AddSection(); + //Adds a paragraph to the section. + IWParagraph paragraph = section.AddParagraph(); + //Sets DifferentFirstPage and DifferentOddEvenPages to true for inserting Header and Footer text. + section.PageSetup.DifferentFirstPage = true; + section.PageSetup.DifferentOddAndEvenPages = true; + //Appends some text to the first page in document. + paragraph.AppendText("\r\r[ First Page ] \r\rText Body_Text Body_Text Body_Text Body_Text Body_Text Body"); + paragraph.ParagraphFormat.PageBreakAfter = true; + //Appends some text to the second page in document. + paragraph = section.AddParagraph(); + paragraph.AppendText("\r\r[ Second Page ] \r\rText Body_Text Body_Text Body_Text Body_Text Body_Text Body"); + paragraph.ParagraphFormat.PageBreakAfter = true; + //Appends some text to the third page in document. + paragraph = section.AddParagraph(); + paragraph.AppendText("\r\r[ Third Page ] \r\rText Body_Text Body_Text Body_Text Body_Text Body_Text Body"); + //Inserts First Page Header. + paragraph = new WParagraph(document); + paragraph.AppendText("[ FIRST PAGE Header ]"); + section.HeadersFooters.FirstPageHeader.Paragraphs.Add(paragraph); + //Inserts First Page Footer. + paragraph = new WParagraph(document); + paragraph.AppendText("[ FIRST PAGE Footer ]"); + section.HeadersFooters.FirstPageFooter.Paragraphs.Add(paragraph); + //Inserts Odd Pages Header. + paragraph = new WParagraph(document); + paragraph.AppendText("[ ODD Page Header Text goes here ]"); + section.HeadersFooters.OddHeader.Paragraphs.Add(paragraph); + //Inserts Odd Pages Footer. + paragraph = new WParagraph(document); + paragraph.AppendText("[ ODD Page Footer Text goes here ]"); + section.HeadersFooters.OddFooter.Paragraphs.Add(paragraph); + //Inserts Even Pages Header. + paragraph = new WParagraph(document); + paragraph.AppendText("[ EVEN Page Header Text goes here ]"); + section.HeadersFooters.EvenHeader.Paragraphs.Add(paragraph); + //Inserts Even Pages Footer. + paragraph = new WParagraph(document); + paragraph.AppendText("[ EVEN Page Footer Text goes here ]"); + section.HeadersFooters.EvenFooter.Paragraphs.Add(paragraph); + //Adds the second section to the document. + section = document.AddSection(); + section.PageSetup.DifferentFirstPage = true; + //Appends some text to the Second Sections's first page in the document. + paragraph = section.AddParagraph(); + paragraph.AppendText("\r\r[ First Page for SECOND SECTION ]\r[ ON DIFFERENT FIRTS PAGE ]\r\rText Body_Text Body_Text Body_Text Body_Text Body_Text Body"); + paragraph.ParagraphFormat.PageBreakAfter = true; + //Appends some text to the Second Sections's second page in the document. + paragraph = section.AddParagraph(); + paragraph.AppendText("\r\r[ Second Page for SECOND SECTION ]\rText Body_Text Body_Text Body_Text Body_Text Body_Text Body"); + //Inserts Second Sections's First Header. + paragraph = new WParagraph(document); + paragraph.AppendText("[ SECOND SECTION FIRST PAGE Header ]"); + section.HeadersFooters.FirstPageHeader.Paragraphs.Add(paragraph); + //Inserts Second Sections's First Footer. + paragraph = new WParagraph(document); + paragraph.AppendText("[ SECOND SECTION FIRST PAGE Footer ]"); + section.HeadersFooters.FirstPageFooter.Paragraphs.Add(paragraph); + //Inserts Second Sections's Header. + paragraph = new WParagraph(document); + paragraph.AppendText("SECOND SECTION Header Text goes here"); + section.HeadersFooters.OddHeader.Paragraphs.Add(paragraph); + //Inserts Second Sections's Footer. + paragraph = new WParagraph(document); + paragraph.AppendText("SECOND SECTION Footer Text goes here"); + section.HeadersFooters.OddFooter.Paragraphs.Add(paragraph); + //Saves the document to disk. + document.Save("Sample.docx", FormatType.Docx); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Creates a new document. + Dim document As WordDocument = New WordDocument() + 'Adds the first section to the document. + Dim section As IWSection = document.AddSection() + 'Adds a paragraph to the section. + Dim paragraph As IWParagraph = section.AddParagraph() + 'Sets DifferentFirstPage and DifferentOddEvenPages as true for inserting Header and Footer text. + section.PageSetup.DifferentFirstPage = True + section.PageSetup.DifferentOddAndEvenPages = True + 'Appends some text to the first page in document. + paragraph.AppendText(Constants.VB.NETCr + Constants.VB.NETCr and "[ First Page ] " and Constants.VB.NETCr + Constants.VB.NETCr and "Text Body_Text Body_Text Body_Text Body_Text Body_Text Body") + paragraph.ParagraphFormat.PageBreakAfter = True + 'Appends some text to the second page in document. + paragraph = section.AddParagraph() + paragraph.AppendText(Constants.VB.NETCr + Constants.VB.NETCr and "[ Second Page ] " and Constants.VB.NETCr + Constants.VB.NETCr and "Text Body_Text Body_Text Body_Text Body_Text Body_Text Body") + paragraph.ParagraphFormat.PageBreakAfter = True + 'Appends some text to the third page in document. + paragraph = section.AddParagraph() + paragraph.AppendText(Constants.VB.NETCr + Constants.VB.NETCr and "[ Third Page ] " and Constants.VB.NETCr + Constants.VB.NETCr and "Text Body_Text Body_Text Body_Text Body_Text Body_Text Body") + 'Inserts First Page Header. + paragraph = New WParagraph(document) + paragraph.AppendText("[ FIRST PAGE Header ]") + section.HeadersFooters.FirstPageHeader.Paragraphs.Add(paragraph) + 'Inserts First Page Footer. + paragraph = New WParagraph(document) + paragraph.AppendText("[ FIRST PAGE Footer ]") + section.HeadersFooters.FirstPageFooter.Paragraphs.Add(paragraph) + 'Inserts Odd Pages Header. + paragraph = New WParagraph(document) + paragraph.AppendText("[ ODD Page Header Text goes here ]") + section.HeadersFooters.OddHeader.Paragraphs.Add(paragraph) + 'Inserts Odd Pages Footer. + paragraph = New WParagraph(document) + paragraph.AppendText("[ ODD Page Footer Text goes here ]") + section.HeadersFooters.OddFooter.Paragraphs.Add(paragraph) + 'Inserts Even Pages Header. + paragraph = New WParagraph(document) + paragraph.AppendText("[ EVEN Page Header Text goes here ]") + section.HeadersFooters.EvenHeader.Paragraphs.Add(paragraph) + 'Inserts Even Pages Footer. + paragraph = New WParagraph(document) + paragraph.AppendText("[ EVEN Page Footer Text goes here ]") + section.HeadersFooters.EvenFooter.Paragraphs.Add(paragraph) + 'Adds the second section to the document. + section = document.AddSection() + section.PageSetup.DifferentFirstPage = True + 'Appends some text to the Second Sections's first page in the document. + paragraph = section.AddParagraph() + paragraph.AppendText(Constants.VB.NETCr + Constants.VB.NETCr and "[ First Page for SECOND SECTION ]" and Constants.VB.NETCr and "[ ON DIFFERENT FIRTS PAGE ]" and Constants.VB.NETCr + Constants.VB.NETCr and "Text Body_Text Body_Text Body_Text Body_Text Body_Text Body") + paragraph.ParagraphFormat.PageBreakAfter = True + 'Appends some text to the Second Sections's second page in the document. + paragraph = section.AddParagraph() + paragraph.AppendText(Constants.VB.NETCr + Constants.VB.NETCr and "[ Second Page for SECOND SECTION ]" and Constants.VB.NETCr and "Text Body_Text Body_Text Body_Text Body_Text Body_Text Body") + 'Inserts Second Sections's First Header. + paragraph = New WParagraph(document) + paragraph.AppendText("[ SECOND SECTION FIRST PAGE Header ]") + section.HeadersFooters.FirstPageHeader.Paragraphs.Add(paragraph) + 'Inserts Second Sections's First Footer. + paragraph = New WParagraph(document) + paragraph.AppendText("[ SECOND SECTION FIRST PAGE Footer ]") + section.HeadersFooters.FirstPageFooter.Paragraphs.Add(paragraph) + 'Inserts Second Sections's Header. + paragraph = New WParagraph(document) + paragraph.AppendText("SECOND SECTION Header Text goes here") + section.HeadersFooters.OddHeader.Paragraphs.Add(paragraph) + 'Inserts Second Sections's Footer. + paragraph = New WParagraph(document) + paragraph.AppendText("SECOND SECTION Footer Text goes here") + section.HeadersFooters.OddFooter.Paragraphs.Add(paragraph) + 'Saves the document to disk. + document.Save("Sample.docx", FormatType.Docx) + End Sub + + + + + + + + + + + Creates HeadersFooters object for specified document. + + + + + Registers child objects in XDSL holder. + + + + + + Clones this instance. + + + + + + Clones itself. + + + Returns cloned object. + + + + Closes this instance. + + + + + Returns an enumerator that iterates through a collection. + + + An object that can be used to iterate through the collection. + + + + + Gets the link to previous. + + + + + + Updates the link to previous. + + if it links to previous header/footer, set to true. + + + + Gets default header of the document. Read-only. + + The instance that represents the default header for the document. + + + + Gets default footer of the document. Read-only. + + the instance that represents the default footer for the document. + + + + Gets even pages header of the document. Read-only. + + The instance that represents the even pages header for the document. + + + + Gets odd pages header of the document. Read-only. + + The instance that represents the odd pages header for the document. + This is also the default header for the document + + + + Gets even pages footer of the document. Read-only. + + The instance that represents the even pages footer for the document. + + + + Gets odd pages footer of the document. Read-only. + + The instance that represents the odd pages footer for the document. + This is also the default footer for the document. + + + + Gets first page header of the document. Read-only. + + The instance that represents the first page header for the document. + + + + Gets first page footer of the document. Read-only. + + The instance that represents the first page footer for the document. + + + + Gets a value indicating whether all the headers/footers are empty. + + + True if the document has empty headers/footers; otherwise, false. + + + + + Gets TextBody of the header/footer of the document at specified index. + + The integer that represents the + + The HeaderFooterType has 6 values which is used as index for this property. + Index 0 - EvenHeader + Index 1 - OddHeader + Index 2 - EvenFooter + Index 3 - OddFooter + Index 4 - FirstPageHeader + Index 5 - FirstPageFooter + + + + + Gets TextBody of the header/footer of the document by specified HeaderFooter type. + + + + + Gets or sets a value indicating whether the current header or footer is linked to the header or footer in the previous section. + + True if the current header or footer is linked to the header or footer in the previous section, otherwise false. + This property always returns false for the first section, since there is no previous section for the first section. + + The following code example demonstrates how to link the previous section header and footer for the current section. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new document + WordDocument document = new WordDocument(); + //Add the first section to the document + IWSection section = document.AddSection(); + //Insert the first section header + section.HeadersFooters.Header.AddParagraph().AppendText("[ First Section Header ]"); + //Insert the first section footer + section.HeadersFooters.Footer.AddParagraph().AppendText("[ First Section Footer ]"); + //Add a paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + string paraText = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"; + //Append some text to the first page in document + paragraph.AppendText("\r\r[ First Page ] \r\r" + paraText); + //Add the second section to the document + section = document.AddSection(); + //Insert the second section header + section.HeadersFooters.Header.AddParagraph().AppendText("[ Second Section Header ]"); + //Insert the second section footer. + section.HeadersFooters.Footer.AddParagraph().AppendText("[ Second Section Footer ]"); + //Set LinkToPrevious as true for retrieve the header and footer from previous section + section.HeadersFooters.LinkToPrevious = true; + //Append some text to the second page in document + paragraph = section.AddParagraph(); + paragraph.AppendText("\r\r[ Second Page ] \r\r" + paraText); + //Add the third section to the document + section = document.AddSection(); + //Insert the third section header + section.HeadersFooters.Header.AddParagraph().AppendText("[ Third Section Header ]"); + //Insert the third section footer + section.HeadersFooters.Footer.AddParagraph().AppendText("[ Third Section Footer ]"); + //Append some text to the third page in document + paragraph = section.AddParagraph(); + paragraph.AppendText("\r\r[ Third Page ] \r\r" + paraText); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new document + Dim document As New WordDocument() + 'Add the first section to the document + Dim section As IWSection = document.AddSection() + 'Insert the first section header + section.HeadersFooters.Header.AddParagraph().AppendText("[ First Section Header ]") + 'Insert the first section footer + section.HeadersFooters.Footer.AddParagraph().AppendText("[ First Section Footer ]") + 'Add a paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + Dim paraText As String = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula" + 'Append some text to the first page in document + paragraph.AppendText(Convert.ToString(vbCr & vbCr & "[ First Page ] " & vbCr & vbCr) & paraText) + 'Add the second section to the document + section = document.AddSection() + 'Insert the second section header + section.HeadersFooters.Header.AddParagraph().AppendText("[ Second Section Header ]") + 'Insert the second section footer + section.HeadersFooters.Footer.AddParagraph().AppendText("[ Second Section Footer ]") + 'Set LinkToPrevious as true for retrieve the header and footer from previous section + section.HeadersFooters.LinkToPrevious = True + 'Append some text to the second page in document + paragraph = section.AddParagraph() + paragraph.AppendText(Convert.ToString(vbCr & vbCr & "[ Second Page ] " & vbCr & vbCr) & paraText) + 'Add the third section to the document + section = document.AddSection() + 'Insert the third section header + section.HeadersFooters.Header.AddParagraph().AppendText("[ Third Section Header ]") + 'Insert the third section footer + section.HeadersFooters.Footer.AddParagraph().AppendText("[ Third Section Footer ]") + 'Append some text to the third page in document + paragraph = section.AddParagraph() + paragraph.AppendText(Convert.ToString(vbCr & vbCr & "[ Third Page ] " & vbCr & vbCr) & paraText) + �Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + + + + Initializes a new instance of the class. + + The HFS. + + + + Advances the enumerator to the next element of the collection. + + + true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. + + The collection was modified after the enumerator was created. + + + + Sets the enumerator to its initial position, which is before the first element in the collection. + + The collection was modified after the enumerator was created. + + + + Gets the current element in the collection. + + + The current element in the collection. + The enumerator is positioned before the first element of the collection or after the last element. + + + + Represents the page header or footer. + + + + + Represent a text body of the Word document. + + + + + The base implementation of IWidgetContainer interface + + + + + Represents a collection of Widget objects. + + + + + Gets count of child widgets. + + + + + Gets child widget by index. + + + + + Gets ChildWidgets collection. + + + + + Initializes a new instance of the class. + + The document. + The owner. + + + + Closes this instance. + + + + + Gets count of child widgets. + + + + + + Gets child widget by index. + + + + + + + + + + Gets Childwidgets. Read-only. + + + + + Represents the text body + + + + + Represents the entity collection + + + + + Gets the child entities. + + The child entities. + + + + Adds a new paragraph at the end of section. + + The reference to the newly added object. + The following example illustrates how to add a paragraph to the text body. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create new Word document + WordDocument document = new WordDocument(); + //Add new section + IWSection section = document.AddSection(); + WTextBody textbody = section.Body; + //Add a paragraph to the text body + WParagraph paragraph = textbody.AddParagraph() as WParagraph; + //Add text + paragraph.AppendText("A new paragraph is added"); + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create new Word document + Dim document As New WordDocument() + 'Add new section + Dim section As IWSection = document.AddSection() + Dim textbody As WTextBody = section.Body + 'Add a paragraph to the text body + Dim paragraph As WParagraph = TryCast(textbody.AddParagraph(), WParagraph) + 'Add text + paragraph.AppendText("A new paragraph is added") + 'Save and close the document + document.Save("Sample.docx") + document.Close() + End Sub + + + + + + Adds a new table at the end of the section. + + The reference to the newly added object. + The following example illustrates how to add a table to the text body. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create new Word document + WordDocument document = new WordDocument(); + //Add new section + IWSection section = document.AddSection(); + WTextBody textbody = section.Body; + //Add a table to the text body + IWTable table = textbody.AddTable(); + table.ResetCells(2, 2); + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create new Word document + Dim document As New WordDocument() + 'Add new section + Dim section As IWSection = document.AddSection() + Dim textbody As WTextBody = section.Body + 'Add a table to the text body + Dim table As IWTable = textbody.AddTable() + table.ResetCells(2, 2) + 'Save and close the document + document.Save("Sample.docx") + document.Close() + End Sub + + + + + The following example illustrates how to add a block content control to the text body. + + //Create new Word document + WordDocument document = new WordDocument(); + //Add new section + IWSection section = document.AddSection(); + WTextBody textbody = section.Body; + //Add a block content control to the text body + BlockContentControl blockControl = textbody.AddBlockContentControl(ContentControlType.RichText) as BlockContentControl; + //Add text to the control added + blockControl.TextBody.AddParagraph().AppendText("A new block control is added"); + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + + + 'Create new Word document + Dim document As New WordDocument() + 'Add new section + Dim section As IWSection = document.AddSection() + Dim textbody As WTextBody = section.Body + 'Add a block content control to the text body + Dim blockControl As BlockContentControl = TryCast(textbody.AddBlockContentControl(ContentControlType.RichText), BlockContentControl) + 'Add text to the control added + blockControl.TextBody.AddParagraph().AppendText("A new block control is added") + 'Save and close the document + document.Save("Sample.docx") + document.Close() + + + + + The following example illustrates how to insert a html string to the text body. + + //Load the template document + WordDocument document = new WordDocument("Template.docx"); + //Html string to be inserted + string htmlstring = "

This text is inserted as HTML string.

"; + //Append Html string as first item of the second paragraph in the document + document.Sections[0].Body.InsertXHTML(htmlstring); + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx") + 'Html string to be inserted + Dim htmlstring As String = "

This text is inserted as HTML string.

" + 'Append Html string as first item of the second paragraph in the document + document.Sections(0).Body.InsertXHTML(htmlstring) + 'Save and close the document + document.Save("Sample.docx") + document.Close() + End Sub + + + + + The following example illustrates how to insert a html string at the specified paragraph in the text body. + + //Load the template document + WordDocument document = new WordDocument("Template.docx"); + //Html string to be inserted + string htmlstring = "

This text is inserted as HTML string.

"; + //Append Html string as first item of the second paragraph in the document + document.Sections[0].Body.InsertXHTML(htmlstring, 2); + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + + + 'Load the template document + Dim document As New WordDocument("Template.docx") + 'Html string to be inserted + Dim htmlstring As String = "

This text is inserted as HTML string.

" + 'Append Html string as first item of the second paragraph in the document + document.Sections(0).Body.InsertXHTML(htmlstring, 2) + 'Save and close the document + document.Save("Sample.docx") + document.Close() + + + + + + + Validates the specified html string with the specified XHTML validation type. + + The html string to validate. + The member that specifies the validation type. + True if it is valid XHTML; otherwise, false. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + //Load the template document + WordDocument document = new WordDocument("Template.docx"); + //Html string to be inserted + string htmlstring = "

This text is inserted as HTML string.

"; + //Validating the Html string + bool isValidHtml = document.LastSection.Body.IsValidXHTML(htmlstring, XHTMLValidationType.Transitional); + //If the Html string passes validation, it is inserted to document + if (isValidHtml) + { + //Append Html string as first item of the second paragraph in the document + document.Sections[0].Body.InsertXHTML(htmlstring, 2, 0); + } + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + + + 'Load the template document + Dim document As New WordDocument("Template.docx") + 'Html string to be inserted + Dim htmlstring As String = "

This text is inserted as HTML string.

" + 'Validating the Html string + Dim isValidHtmlAs Boolean = document.LastSection.Body.IsValidXHTML(htmlstring, XHTMLValidationType.Transitional) + 'If the Html string passes validation, it is inserted to document + If isValidHtmlThen + 'Append Html string as first item of the second paragraph in the document + document.Sections(0).Body.InsertXHTML(htmlstring, 2, 0) + End If + 'Save and close the document + document.Save("Sample.docx") + document.Close() + + + + + + Validates the specified html string with the specified XHTML validation type and exception message. + + The html string to validate. + The member that specifies the validation type. + The string that specifies the exception message. + True if it is valid XHTML, otherwise false. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + //Load the template document + WordDocument document = new WordDocument("Template.docx"); + //Html string to be inserted + string htmlstring = "

This text is inserted as HTML string.

"; + string exception = "The string is not valid"; + //Validating the Html string + bool isValidHtml = document.LastSection.Body.IsValidXHTML(htmlstring, XHTMLValidationType.Transitional, out exception); + //If the Html string passes validation, it is inserted to document + if (isValidHtml) + { + //Append Html string as first item of the second paragraph in the document + document.Sections[0].Body.InsertXHTML(htmlstring, 2, 0); + } + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + + + 'Load the template document + Dim document As New WordDocument("Template.docx") + 'Html string to be inserted + Dim htmlstring As String = "

This text is inserted as HTML string.

" + Dim exception As String = "The string is not valid" + 'Validating the Html string + Dim isValidHtmlAs Boolean = document.LastSection.Body.IsValidXHTML(htmlstring, XHTMLValidationType.Transitional, exception) + 'If the Html string passes validation, it is inserted to document + If isValidHtmlThen + 'Append Html string as first item of the second paragraph in the document + document.Sections(0).Body.InsertXHTML(htmlstring, 2, 0) + End If + 'Save and close the document + document.Save("Sample.docx") + document.Close() + + + + + + If the text body has no paragraphs, creates and add one paragraph to the text body. + + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create new Word document + WordDocument document = new WordDocument(); + //Add new section + IWSection section = document.AddSection(); + WTextBody textbody = section.Body; + //Add one paragraph to the section body + textbody.EnsureMinimum(); + textbody.LastParagraph.AppendText("Last paragraph"); + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create new Word document + Dim document As New WordDocument() + 'Add new section + Dim section As IWSection = document.AddSection() + Dim textbody As WTextBody = section.Body + 'Add one paragraph to the section body + textbody.EnsureMinimum() + textbody.LastParagraph.AppendText("Last paragraph") + 'Save and close the document + document.Save("Sample.docx") + document.Close() + End Sub + + + + + + Gets the collection of tables in the . Read-only. + + The collection that represents the tables in the text body. + + + + + + Gets the collection of paragraphs in the . Read-only. + + The collection that represents the paragraphs in the text body. + + + + + + Gets the collection of form fields in the . Read-only. + + The collection that represents the form fields in the text body. + + + + + + Gets the last paragraph in the section. Read-only. + + The object. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template Word document + WordDocument document = new WordDocument("Template.docx"); + //Get the textbody of first section + WTextBody textbody = document.Sections[0].Body; + //Get the last paragraph + IWParagraph paragraph = textbody.LastParagraph; + //Set horizontal alignment + paragraph.ParagraphFormat.HorizontalAlignment = HorizontalAlignment.Right; + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template Word document + Dim document As New WordDocument("Template.docx") + 'Get the textbody of first section + Dim textbody As WTextBody = document.Sections(0).Body + 'Get the last paragraph + Dim paragraph As IWParagraph = textbody.LastParagraph + 'Set horizontal alignment + paragraph.ParagraphFormat.HorizontalAlignment = HorizontalAlignment.Right + 'Save and close the document + document.Save("Sample.docx") + document.Close() + End Sub + + + + + + Gets the child elements of the . + + The collection of the child elements. + + + + The section paragraphs + + + + + + Initializes a new instance of the class. + + The document. + The owner. + + + + Initializes a new instance of the class. + + The sec. + + + + Adds a new paragraph at the end of section. + + The reference to the newly added object. + The following example illustrates how to add a paragraph to the text body. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create new Word document + WordDocument document = new WordDocument(); + //Add new section + IWSection section = document.AddSection(); + WTextBody textbody = section.Body; + //Add a paragraph to the text body + WParagraph paragraph = textbody.AddParagraph() as WParagraph; + //Add text + paragraph.AppendText("A new paragraph is added"); + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create new Word document + Dim document As New WordDocument() + 'Add new section + Dim section As IWSection = document.AddSection() + Dim textbody As WTextBody = section.Body + 'Add a paragraph to the text body + Dim paragraph As WParagraph = TryCast(textbody.AddParagraph(), WParagraph) + 'Add text + paragraph.AppendText("A new paragraph is added") + 'Save and close the document + document.Save("Sample.docx") + document.Close() + End Sub + + + + + + Adds a new table at the end of the section. + + The reference to the newly added object. + The following example illustrates how to add a table to the text body. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create new Word document + WordDocument document = new WordDocument(); + //Add new section + IWSection section = document.AddSection(); + WTextBody textbody = section.Body; + //Add a table to the text body + IWTable table = textbody.AddTable(); + table.ResetCells(2, 2); + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create new Word document + Dim document As New WordDocument() + 'Add new section + Dim section As IWSection = document.AddSection() + Dim textbody As WTextBody = section.Body + 'Add a table to the text body + Dim table As IWTable = textbody.AddTable() + table.ResetCells(2, 2) + 'Save and close the document + document.Save("Sample.docx") + document.Close() + End Sub + + + + + + Adds a new block content control at the end of section. + + The reference to the newly added object. + Thrown when is + , or + The following example illustrates how to add a block content control to the text body. + + //Create new Word document + WordDocument document = new WordDocument(); + //Add new section + IWSection section = document.AddSection(); + WTextBody textbody = section.Body; + //Add a block content control to the text body + BlockContentControl blockControl = textbody.AddBlockContentControl(ContentControlType.RichText) as BlockContentControl; + //Add text to the control added + blockControl.TextBody.AddParagraph().AppendText("A new block control is added"); + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + + + 'Create new Word document + Dim document As New WordDocument() + 'Add new section + Dim section As IWSection = document.AddSection() + Dim textbody As WTextBody = section.Body + 'Add a block content control to the text body + Dim blockControl As BlockContentControl = TryCast(textbody.AddBlockContentControl(ContentControlType.RichText), BlockContentControl) + 'Add text to the control added + blockControl.TextBody.AddParagraph().AppendText("A new block control is added") + 'Save and close the document + document.Save("Sample.docx") + document.Close() + + + + + + Add Structure document tag block + + + + + + Add Altername Chunk + + + + + + Add Altername Chunk + + + + + The following example illustrates how to insert a html string to the text body. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document + WordDocument document = new WordDocument("Template.docx"); + //Html string to be inserted + string htmlstring = "

This text is inserted as HTML string.

"; + //Append Html string as first item of the second paragraph in the document + document.Sections[0].Body.InsertXHTML(htmlstring); + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx") + 'Html string to be inserted + Dim htmlstring As String = "

This text is inserted as HTML string.

" + 'Append Html string as first item of the second paragraph in the document + document.Sections(0).Body.InsertXHTML(htmlstring) + 'Save and close the document + document.Save("Sample.docx") + document.Close() + End Sub + + + + + The following example illustrates how to insert a html string at the specified paragraph in the text body. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document + WordDocument document = new WordDocument("Template.docx"); + //Html string to be inserted + string htmlstring = "

This text is inserted as HTML string.

"; + //Append Html string as first item of the second paragraph in the document + document.Sections[0].Body.InsertXHTML(htmlstring, 2); + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx") + 'Html string to be inserted + Dim htmlstring As String = "

This text is inserted as HTML string.

" + 'Append Html string as first item of the second paragraph in the document + document.Sections(0).Body.InsertXHTML(htmlstring, 2) + 'Save and close the document + document.Save("Sample.docx") + document.Close() + End Sub + + + + + + + Validates the specified html string with the specified XHTML validation type. + + The html string to validate. + The member that specifies the validation type. + True if it is valid XHTML; otherwise, false. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document + WordDocument document = new WordDocument("Template.docx"); + //Html string to be inserted + string htmlstring = "

This text is inserted as HTML string.

"; + //Validating the Html string + bool isValidHtml = document.LastSection.Body.IsValidXHTML(htmlstring, XHTMLValidationType.Transitional); + //If the Html string passes validation, it is inserted to document + if (isValidHtml) + { + //Append Html string as first item of the second paragraph in the document + document.Sections[0].Body.InsertXHTML(htmlstring, 2, 0); + } + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx") + 'Html string to be inserted + Dim htmlstring As String = "

This text is inserted as HTML string.

" + 'Validating the Html string + Dim isValidHtmlAs Boolean = document.LastSection.Body.IsValidXHTML(htmlstring, XHTMLValidationType.Transitional) + 'If the Html string passes validation, it is inserted to document + If isValidHtmlThen + 'Append Html string as first item of the second paragraph in the document + document.Sections(0).Body.InsertXHTML(htmlstring, 2, 0) + End If + 'Save and close the document + document.Save("Sample.docx") + document.Close() + End Sub + + + + + + Validates the specified html string with the specified XHTML validation type and exception message. + + The html string to validate. + The member that specifies the validation type. + The string that specifies the exception message. + True if it is valid XHTML, otherwise false. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document + WordDocument document = new WordDocument("Template.docx"); + //Html string to be inserted + string htmlstring = "

This text is inserted as HTML string.

"; + string exception = "The string is not valid"; + //Validating the Html string + bool isValidHtml = document.LastSection.Body.IsValidXHTML(htmlstring, XHTMLValidationType.Transitional, out exception); + //If the Html string passes validation, it is inserted to document + if (isValidHtml) + { + //Append Html string as first item of the second paragraph in the document + document.Sections[0].Body.InsertXHTML(htmlstring, 2, 0); + } + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx") + 'Html string to be inserted + Dim htmlstring As String = "

This text is inserted as HTML string.

" + Dim exception As String = "The string is not valid" + 'Validating the Html string + Dim isValidHtmlAs Boolean = document.LastSection.Body.IsValidXHTML(htmlstring, XHTMLValidationType.Transitional, exception) + 'If the Html string passes validation, it is inserted to document + If isValidHtmlThen + 'Append Html string as first item of the second paragraph in the document + document.Sections(0).Body.InsertXHTML(htmlstring, 2, 0) + End If + 'Save and close the document + document.Save("Sample.docx") + document.Close() + End Sub + + + + + + If the text body has no paragraphs, creates and add one paragraph to the text body. + + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create new Word document + WordDocument document = new WordDocument(); + //Add new section + IWSection section = document.AddSection(); + WTextBody textbody = section.Body; + //Add one paragraph to the section body + textbody.EnsureMinimum(); + textbody.LastParagraph.AppendText("Last paragraph"); + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create new Word document + Dim document As New WordDocument() + 'Add new section + Dim section As IWSection = document.AddSection() + Dim textbody As WTextBody = section.Body + 'Add one paragraph to the section body + textbody.EnsureMinimum() + textbody.LastParagraph.AppendText("Last paragraph") + 'Save and close the document + document.Save("Sample.docx") + document.Close() + End Sub + + + + + + Finds the specified pattern. + + The pattern. + + + + + Finds the specified pattern. + + The pattern. + + + + + Replaces the specified pattern. + + The pattern. + The replace. + + + + + Replaces the specified pattern. + + The pattern. + The text selection. + if it specifies the save source formatting, set to true. + + + + + Replaces the specified pattern. + + The pattern. + The text part. + if it specifies save source formatting, set to true . + + + + + Replaces the specified pattern. + + The pattern. + The replace doc. + + + + + Retrieves the first paragraph within the specified text body. + + The text body to search for the first paragraph. + A flag indicating whether to add a new paragraph if none is found. + The first paragraph found within the text body, or null if no paragraph is found and isAddNewParagraph is false. + + + + Adds the self. + + + + + Creates a duplicate copy of the entity. + + + An that is newly created. + + + + Get the base entity + + + + + + + Clones the relations. + + + + + + Closes this instance. + + + + + Checks whether the textbody contains any block content control in it. + + + + + Accepts or rejects changes tracked from the moment of last change acceptance. + + if it is accept the changes, set to true + + + + Removes the changed item. + + The item. + if it accepts the changes, set to true. + Index of the item. + + + + + Determines whether text body has tracked changes. + + + If has tracked changes, set to true. + + + + + Removes the changed formatting. + + The item. + + + + Move srcTextBody items to next textBody + + The srcTextBody + + + + Checks the whether item's content has to be moved to next paragraph. + + The item. + if it is accept the changes, set to true . + + + + + Moves item's content to the next paragraph. + + The item. + + + + Checks whether the index should remove or not. + + Current paragraph + Current index + True, if index should reduce else false. + + + + Registers child objects in XDSL holder. + + + + + + Creates layout information. + + + + + + Decide whether current shape or text box has auto fit properties or not. + + true when wrap type is none + current text box + shape with rectangle type + return true when shape or text box has auto fit properties + + + + Update the matched index + + + + + Compare the text body items between the documents. + + The original document instance. + + + + Update the index + + + + + + + + + + + Compare the body items between two text bodies + + The original text body to compare + + + + Back up the document collections. + + + + + Clear the document collections. + + + + + Reset the document collections. + + + + + Delete or insert the unmatched items at the end of the textbodies + + + + + + Delete the unmatched item after the last matched item to end of the textbody + + + + + + Insert the unmatched after the last matched item to the end of the revised textbody to the original textbody + + + + + + Gets the string of the text body for word comaprison + + + + + + Gets the type of the entity. Read-only. + + The of the current item. + + + + Gets the collection of paragraphs in the . Read-only. + + The collection that represents the paragraphs in the text body. + + + + + + Gets the collection of tables in the . Read-only. + + The collection that represents the tables in the text body. + + + + + + Gets the collection of form fields in the . Read-only. + + The collection that represents the form fields in the text body. + + + + + + Alternate chunk collection from the current section + + + + + Checks whether currently performing find and replace or not + + + + + Gets the last paragraph in the section. Read-only. + + The object. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template Word document + WordDocument document = new WordDocument("Template.docx"); + //Get the textbody of first section + WTextBody textbody = document.Sections[0].Body; + //Get the last paragraph + IWParagraph paragraph = textbody.LastParagraph; + //Set horizontal alignment + paragraph.ParagraphFormat.HorizontalAlignment = HorizontalAlignment.Right; + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template Word document + Dim document As New WordDocument("Template.docx") + 'Get the textbody of first section + Dim textbody As WTextBody = document.Sections(0).Body + 'Get the last paragraph + Dim paragraph As IWParagraph = textbody.LastParagraph + 'Set horizontal alignment + paragraph.ParagraphFormat.HorizontalAlignment = HorizontalAlignment.Right + 'Save and close the document + document.Save("Sample.docx") + document.Close() + End Sub + + + + + + Gets a value indicating whether [form fields created]. + + if the form fields created, set to true. + + + + Gets the body items. + + The body items. + + + + Gets the child elements of the . + + The collection of the child elements. + + + + Gets the entity collection. Read-only. + + + The collection of entities. + + + + Inserts the watermark + + + + + + Checks the m_writeWatermark variable. + + + + + + Initializes a new instance of the class. + + The in which the current header or footer is present. + The member that specifies the type of header or footer. + + + + Gets the link to previous. + + + + + + + + + + + + Finds the source header/footer. + + + + + + Checks the shapes in header/footer. + + The hf. + + + + Gets the type of the entity. + + The of the current item. + + + + Gets or sets the type of current header or footer. + + The member that specifies the type of header or footer. + + + + Gets or sets a value indicating whether need write watermark. + + true if write watermark; otherwise, false. + + + + Gets or sets a value indicating watermark for each header. + + + + + Gets or sets a value indicating whether the current header or footer is linked to the header or footer in the previous section. + + True if the current header or footer is linked to the header or footer in the previous section, otherwise false. + + + + Represents a Word document and can be used to create a new Word document from the scratch. + + + + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + //Add a new section into the Word document + IWSection section = document.AddSection(); + //Specify the page margins + section.PageSetup.Margins.All = 50f; + //Add a new simple paragraph into the section + IWParagraph paragraph = section.AddParagraph(); + //Add a text range into the paragraph + paragraph.AppendText("Hello World!"); + //Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx); + //Release the resources occupied by WordDocument instance + document.Close(); + + + 'Create an instance of WordDocument class + Dim document As New WordDocument() + 'Add a new section into the Word document + Dim section As IWSection = document.AddSection() + 'Specify the page margins + section.PageSetup.Margins.All = 50F + 'Add a new simple paragraph into the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add a text range into the paragraph + paragraph.AppendText("Hello World!") + 'Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx) + 'Release the resources occupied by WordDocument instance + document.Close() + + + + + + + + + Represents a Word document and can be used to create a new Word document from the scratch. + + + + + Creates a new paragraph. + + The this method created. + + + + Adds a single with one , when the document contains no sections. + + + The following code example demonstrates how to add new section with one paragraph to the empty Word document + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Creates a new Word document. + WordDocument document = new WordDocument(); + //Add a section and a paragraph in the empty document + document.EnsureMinimal(); + IWParagraph paragraph = document.LastParagraph; + //Append text to the last paragraph of the document + paragraph.AppendText("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua"); + //Save and close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Creates a new Word document. + Dim document As New WordDocument() + 'Add a section and a paragraph in the empty document + document.EnsureMinimal() + Dim paragraph As IWParagraph = document.LastParagraph + 'Append text to the last paragraph of the document + paragraph.AppendText("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua") + 'Save and close the Word document + document.Save("Comment.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Adds a new section to document. + + The this method creates. + + The following code example demonstrates how to add a new section to document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Append the text to the created paragraph + paragraph.AppendText("A new section is added to the document."); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Append the text to the created paragraph + paragraph.AppendText("A new section is added to the document.") + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Adds a new paragraph style to the document. + + A String that contains the name of the newly created + The this method creates. + + The following code example demonstrates how to create a custom paragraph style and apply it to a paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + + //Create user defined style + IWParagraphStyle style = document.AddParagraphStyle("User_defined_style"); + style.ParagraphFormat.BackColor = Color.LightGray; + style.ParagraphFormat.AfterSpacing = 18f; + style.ParagraphFormat.BeforeSpacing = 18f; + style.ParagraphFormat.Borders.BorderType = Syncfusion.DocIO.DLS.BorderStyle.DotDash; + style.ParagraphFormat.Borders.LineWidth = 0.5f; + style.ParagraphFormat.LineSpacing = 15f; + style.CharacterFormat.FontName = "Calibri"; + style.CharacterFormat.Italic = true; + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + IWTextRange text = paragraph.AppendText("A new paragraph style is created and is applied to this paragraph."); + //Apply the new style to paragraph + paragraph.ApplyStyle("User_defined_style"); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Create user defined style + Dim style As IWParagraphStyle = document.AddParagraphStyle("User_defined_style") + style.ParagraphFormat.BackColor = Color.LightGray + style.ParagraphFormat.AfterSpacing = 18.0F + style.ParagraphFormat.BeforeSpacing = 18.0F + style.ParagraphFormat.Borders.BorderType = Syncfusion.DocIO.DLS.BorderStyle.DotDash + style.ParagraphFormat.Borders.LineWidth = 0.5F + style.ParagraphFormat.LineSpacing = 15.0F + style.CharacterFormat.FontName = "Calibri" + style.CharacterFormat.Italic = True + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + Dim text As IWTextRange = paragraph.AppendText("A new paragraph style is created and is applied to this paragraph.") + 'Apply the new style to paragraph + paragraph.ApplyStyle("User_defined_style") + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + + + + + Adds new list style to document. + + The of the new created. + A String that contains the name of the newly added list style. + The this method creates. + + The following code example demonstrates how to how to create user defined list styles. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new list style to the document + ListStyle listStyle = document.AddListStyle(ListType.Numbered, "UserdefinedList"); + WListLevel levelOne = listStyle.Levels[0]; + //Define the follow character, prefix, suffix, start index for level 0 + levelOne.FollowCharacter = FollowCharacterType.Tab; + levelOne.NumberPrefix = "("; + levelOne.NumberSufix = ")"; + levelOne.PatternType = ListPatternType.LowRoman; + levelOne.StartAt = 1; + levelOne.TabSpaceAfter = 5; + levelOne.NumberAlignment = ListNumberAlignment.Center; + WListLevel levelTwo = listStyle.Levels[1]; + //Define the follow character, suffix, pattern, start index for level 1 + levelTwo.FollowCharacter = FollowCharacterType.Tab; + levelTwo.NumberSufix = "}"; + levelTwo.PatternType = ListPatternType.LowLetter; + levelTwo.StartAt = 2; + + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add text to the paragraph + paragraph.AppendText("User defined list - Level 0"); + //Apply default numbered list style + paragraph.ListFormat.ApplyStyle("UserdefinedList"); + //Add second paragraph + paragraph = section.AddParagraph(); + paragraph.AppendText("User defined list - Level 1"); + //Continue last defined list + paragraph.ListFormat.ContinueListNumbering(); + //Increase the level indent + paragraph.ListFormat.IncreaseIndentLevel(); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new list style to the document + Dim listStyle As ListStyle = document.AddListStyle(ListType.Numbered, "UserdefinedList") + Dim levelOne As WListLevel = listStyle.Levels(0) + 'Define the follow character, prefix, suffix, start index for level 0 + levelOne.FollowCharacter = FollowCharacterType.Tab + levelOne.NumberPrefix = "(" + levelOne.NumberSufix = ")" + levelOne.PatternType = ListPatternType.LowRoman + levelOne.StartAt = 1 + levelOne.TabSpaceAfter = 5 + levelOne.NumberAlignment = ListNumberAlignment.Center + Dim levelTwo As WListLevel = listStyle.Levels(1) + 'Define the follow character, suffix, pattern, start index for level 1 + levelTwo.FollowCharacter = FollowCharacterType.Tab + levelTwo.NumberSufix = "}" + levelTwo.PatternType = ListPatternType.LowLetter + levelTwo.StartAt = 2 + + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add text to the paragraph + paragraph.AppendText("User defined list - Level 0") + 'Apply default numbered list style + paragraph.ListFormat.ApplyStyle("UserdefinedList") + 'Add second paragraph + paragraph = section.AddParagraph() + paragraph.AppendText("User defined list - Level 1") + 'Continue last defined list + paragraph.ListFormat.ContinueListNumbering() + 'Increase the level indent + paragraph.ListFormat.IncreaseIndentLevel() + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + + + + + + Returns a string that contains whole document content as text. + + The text this document contains. + This method is not supported in Silverlight, Windows Phone and Xamarin platforms. + + The following code example demonstrates how to retrieve the Word document contents as a plain text. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx"); + //Get the document text and close the document + string text = document.GetText(); + document.Close(); + //Create new Word document + WordDocument newdocument = new WordDocument(); + //Add new section + IWSection section = newdocument.AddSection(); + //Add new paragraph + IWParagraph paragraph = section.AddParagraph(); + //Append the text to the paragraph + paragraph.AppendText(text); + //Save and close the document + newdocument.Save("Sample.docx"); + newdocument.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx") + 'Get the document text and close the document + Dim text As String = document.GetText() + document.Close() + 'Create new Word document + Dim newdocument As New WordDocument() + 'Add new section + Dim section As IWSection = newdocument.AddSection() + 'Add new paragraph + Dim paragraph As IWParagraph = section.AddParagraph() + 'Append the text to the paragraph + paragraph.AppendText(text) + 'Save and close the document + newdocument.Save("Sample.docx") + newdocument.Close() + End Sub + + + + + + Creates the duplicate copy of this instance. + + The this method duplicated. + + The following code example demonstrates how to clone the Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open an existing document + WordDocument inputTemplateDoc = new WordDocument("Template.docx"); + //Create a clone of Input Template + WordDocument clonedDocument = inputTemplateDoc.Clone(); + //Close the input template document instance + inputTemplateDoc.Close(); + //Save and Close the cloned document instance + clonedDocument.Save("ClonedDocument.docx"); + clonedDocument.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open an existing document + Dim inputTemplateDoc As New WordDocument(fileName) + 'Create a clone of Input Template + Dim clonedDocument As WordDocument = inputTemplateDoc.Clone() + 'Close the input template document instance + inputTemplateDoc.Close() + 'Save and Close the cloned document instance + clonedDocument.Save("ClonedDocument.docx") + clonedDocument.Close() + End Sub + + + + + + Imports the specified section into the current document. + + The source whose contents are appended at the end of the current instance. + + The following code example demonstrates how to import the section into the Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open the source document + WordDocument sourceDocument = new WordDocument(sourceFileName); + //Open the destination document + WordDocument destinationDocument = new WordDocument(targetFileName); + //Import the last section of source document at the end of destination document + destinationDocument.ImportSection(sourceDocument.LastSection); + //Close the document instance + sourceDocument.Close(); + //Save the destination document + destinationDocument.Save(outputFileName, FormatType.Docx); + //Close the document instance + destinationDocument.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open the source document + Dim sourceDocument As New WordDocument("sourceFileName.docx") + 'Open the destination document + Dim destinationDocument As New WordDocument("targetFileName.docx") + 'Import the last section of source document at the end of destination document + destinationDocument.ImportSection(sourceDocument.LastSection) + 'Close the document instance + sourceDocument.Close() + 'Save the destination document + destinationDocument.Save("outputFileName.docx", FormatType.Docx) + 'Close the document instance + destinationDocument.Close() + End Sub + + + + + + Import contents and styles from the source document to the destination document. + + The source whose contents are appended at the end of the current instance. + When source and destination documents have styles with the same names, then Guid is added as a suffix to the name of the imported styles in the destination document. Due to the above duplication of the same style will increase the file size of the document and also it may lead to Out of memory exception if the machine has some limited amount memory. + To resolve the duplication of the same style from source to destination document, use ImportContent(IWordDocument doc, bool importStyles) methods with false value for "importStyle" parameter. + + The following code example demonstrates how to import the contents from source document into destination document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open the source document + WordDocument sourceDocument = new WordDocument("sourceFileName.docx"); + //Open the destination document + WordDocument destinationDocument = new WordDocument("targetFileName.docx"); + //Import the contents of source document at the end of destination document + destinationDocument.ImportContent(sourceDocument); + //Close the document instance + sourceDocument.Close() + //Save the destination document + destinationDocument.Save("outputFileName.docx", FormatType.Docx); + //Close the document instance + destinationDocument.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open the source document + Dim sourceDocument As New WordDocument(sourceFileName) + 'Open the destination document + Dim destinationDocument As New WordDocument(targetFileName) + 'Import the contents of source document at the end of destination document + destinationDocument.ImportContent(sourceDocument) + 'Close the document instance + sourceDocument.Close() + 'Save the destination document + destinationDocument.Save(outputFileName, FormatType.Docx) + 'Close the document instance + destinationDocument.Close() + End Sub + + + + + + Import contents from the source document to the destination document with various import options. + + The source whose contents are appended at the end of the current instance. + The that represents the options to import the source document contents to the destination document. + + Essential DocIO supports the importing contents from the source document to the destination document with various import options similar to Microsoft Word copy and paste options. Following are the import options supported by Essential DocIO. + + KeepSourceFormatting�Imports the contents from the source document, applies the default style (Normal), and preserves all other formatting as direct formatting in order to preserve the contents as in source document. Header and footer contents will be imported similar to the UseDestinationStyles option. + MergeFormatting�Imports the contents of the source document to the destination document, and applies the formatting of surrounding content to the destination document. Merges formatting of the contents surrounding it by preserving some of the source formatting (such as bold, italic, underline, and so on). Header and footer contents are imported similar to the UseDestinationStyles option. + KeepTextOnly�Imports only the text from the source document to the destination document (tables, textboxes, pictures, headers, footers, and so on, are removed), similar to content copied from a text file (.txt). + UseDestinationStyles�Imports the contents of the source document to the destination document, and applies the styles present in the destination document, or imports the source style to the destination document when there is no style with the same name in the destination document. + + + + The following code example demonstrates how to import the contents from source document into destination document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open the source document + WordDocument sourceDocument = new WordDocument("sourceFileName.docx"); + //Open the destination document + WordDocument destinationDocument = new WordDocument("targetFileName.docx"); + //Import the contents of source document at the end of destination document + destinationDocument.ImportContent(sourceDocument, ImportOptions.UseDestinationStyles); + //Close the document instance + sourceDocument.Close(); + //Save the destination document + destinationDocument.Save("outputFileName.docx", FormatType.Docx); + //Close the document instance + destinationDocument.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open the source document + Dim sourceDocument As New WordDocument(sourceFileName) + 'Open the destination document + Dim destinationDocument As New WordDocument(targetFileName) + 'Import the contents of source document at the end of destination document + destinationDocument.ImportContent(sourceDocument, ImportOptions.UseDestinationStyles) + 'Close the document instance + sourceDocument.Close() + 'Save the destination document + destinationDocument.Save(outputFileName, FormatType.Docx) + 'Close the document instance + destinationDocument.Close() + End Sub + + + + + + Import contents from the source document to the destination document by specifying whether to import styles that have the same name between the source and destination document. + + The source whose contents are appended at the end of the current instance. + Set to true to import all the styles from the source document to destination document; otherwise, false. + + When importStyles is set to false, all the contents are imported; but, the styles of the source document with style names that do not match with the styles in the destination document are not imported. When the style names match the destination style names, then the same name is applied to the imported contents. This behavior is similar to the Microsoft Word paste option � UseDestinationStyles. + When importStyles is set to true, all the contents and styles of the source document are imported to the destination document. In cases where a style in the source document has the same name as a style in the destination document, �Guid� is added as a suffix to the name of the imported style in order to preserve unique style name. Due to the above duplication of the same style will increase the file size of the document and also it may lead to Out of memory exception if the machine has some limited amount memory. + + + The following code example demonstrates how to import the contents from source document into destination document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open the source document + WordDocument sourceDocument = new WordDocument("sourceFileName.docx"); + //Open the destination document + WordDocument destinationDocument = new WordDocument("targetFileName.docx"); + //Import the contents of source document at the end of destination document + destinationDocument.ImportContent(sourceDocument, true); + //Close the document instance + sourceDocument.Close(); + //Save the destination document + destinationDocument.Save("outputFileName.docx", FormatType.Docx); + //Close the document instance + destinationDocument.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open the source document + Dim sourceDocument As New WordDocument(sourceFileName) + 'Open the destination document + Dim destinationDocument As New WordDocument(targetFileName) + 'Import the contents of source document at the end of destination document + destinationDocument.ImportContent(sourceDocument, true) + 'Close the document instance + sourceDocument.Close() + 'Save the destination document + destinationDocument.Save(outputFileName, FormatType.Docx) + 'Close the document instance + destinationDocument.Close() + End Sub + + + + + + Adds the built-in style to the collection. + + The that represents the added built-in style of the document. + The this method added to collection. + + The following code example demonstrates how to add the built-in style to the document + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Add the built-in style to the document style collection + IStyle style = document.AddStyle(BuiltinStyle.Heading5); + //Apply the added built-in style to the last paragraph of the document + document.LastParagraph.ApplyStyle(style.Name); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Add the built-in style to the document style collection + Dim style As IStyle = document.AddStyle(BuiltinStyle.Heading5) + 'Apply the added built-in style to the last paragraph of the document + document.LastParagraph.ApplyStyle(style.Name) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Accepts changes tracked from the moment of last change acceptance. + + + The following code example demonstrates how to accept the tracked changes in the document + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Check whether document has tracked changes + if (document.HasChanges) + //Accept the changes made to the document + document.AcceptChanges(); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Check whether document has tracked changes + If document.HasChanges Then + 'Accept the changes made to the document + document.AcceptChanges() + End If + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Rejects changes tracked from the moment of last change acceptance. + + + The following code example demonstrates how to reject the tracked changes in the document + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Check whether document has tracked changes + if (document.HasChanges) + //Reject the changes made to the document + document.RejectChanges(); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Check whether document has tracked changes + If document.HasChanges Then + 'Reject the changes made to the document + document.RejectChanges() + End If + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Protects the document from unintentional editing. + + The type of protection to be applied. + + The following code example demonstrates how to protect the document from unintentional editing. + This method is not supported in MVC6 and Xamarin platforms. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Apply the protection to the document + document.Protect(ProtectionType.AllowOnlyComments); + //Save and close the document instances + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Apply the protection to the document + document.Protect(ProtectionType.AllowOnlyComments) + 'Save and close the document instances + document.Save("Sample.docx") + document.Close() + End Sub + + + + + + Protects the document from unintentional editing with secure password. + + The type of protection to be applied. + The password used for protection. + This method is not supported in MVC6 and Xamarin platforms. + + The following code example demonstrates how to protect the document from unintentional editing. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx", "password"); + //Apply the protection to the document + document.Protect(ProtectionType.AllowOnlyComments); + //Save and close the document instances + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Apply the protection to the document + document.Protect(ProtectionType.AllowOnlyComments, "password") + 'Save and close the document instances + document.Save("Sample.docx") + document.Close() + End Sub + + + + + + Protects the document with password from unauthorized access. + + A String used to encrypt the document. + This API is supported from .NET Framework 2.0 and .NET Standard 2.0 onwards. + + The following code example demonstrates how to encrypt the Word document with password. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open an input Word document + WordDocument document = new WordDocument("Template.docx"); + //Encrypt the Word document with a password + document.EncryptDocument("password"); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open an input Word document + Dim document As New WordDocument("Template.docx") + 'Encrypt the Word document with a password + document.EncryptDocument("password") + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Removes the encryption from the document. + + This API is supported from .NET Framework 2.0 and .NET Standard 2.0 onwards. + + The following code example demonstrates how to remove encrypt from the Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open an input Word document + WordDocument document = new WordDocument("Template.docx"); + //Remove the encryption from document + document.RemoveEncryption(); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open an input Word document + Dim document As New WordDocument("Template.docx") + 'Remove the encryption from document + document.RemoveEncryption(); + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the list/array of items that can be cross-referenced based on the specified reference type. + + + Specifies the type of item you want to insert a cross-reference to. + + The collection that represents the cross reference items in the document. + + + This method returns the cross reference of Bookmarks items only. + + + For bookmarks, it returns the entity collections of BookmarkStart only if the bookmark contains proper start and end. + + + + The following code example demonstrates how to append cross reference for bookmark in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Get the collection of bookmark start in the word document + List<Entity> items = document.GetCrossReferenceItems(ReferenceType.Bookmark); + if (items.Count > 0) + //Change the first cross reference items owner paragraph back color as YelloGreen + (items[0] as BookmarkStart).OwnerParagraph.ParagraphFormat.BackColor = Color.YellowGreen; + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Get the collection of bookmark start in the word document + Dim items As List(Of Entity) = document.GetCrossReferenceItems(ReferenceType.Bookmark) + If items.Count > 0 Then + 'Change the first cross reference items owner paragraph back color as YelloGreen + TryCast(items(0), BookmarkStart).OwnerParagraph.ParagraphFormat.BackColor = Color.YellowGreen + End If + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Saves this as text file(.txt) with specified encoding. + + A string that contains the name of the file to save. + The character encoding to use. + This method is not supported in Silverlight, WinRt, Windows Phone, Universal, UNiversal Windows Platform and Xamarin platforms. + + The following code example demonstrates how to convert the Word document into text file. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Save the document as Text file + document.SaveTxt("sample.txt", Encoding.ASCII); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Save the document as Text file + document.SaveTxt("sample.txt", Encoding.ASCII) + 'Close the document + document.Close() + End Sub + + + + + + Opens an existing document. + + A string that contains the name of the file to open + + The following code example demonstrates how to open an existing document from file system. + This method is not supported in Silverlight, WinRt, Windows Phone, Universal, UNiversal Windows Platform and Xamarin platforms. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.Open("Template.docx"); + //Saves the specified document + document.Save("Sample.docx"); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.Open("Template.docx") + 'Saves the specified document + document.Save("Sample.docx") + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Opens an existing document of the specified file format type. + + A string that contains the name of the file to open. + The file format type of the document to open. + This method is not supported in Silverlight, WinRt, Windows Phone, Universal, UNiversal Windows Platform and Xamarin platforms. + + The following code example demonstrates how to open an existing document of the specified type from file system. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.Open("Template.docx", FormatType.Docx); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.Open("Template.docx", FormatType.Docx) + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Opens an existing document of the specified file format type with HTML file validation options and base path for relative path to absolute path conversion. + + A string that contains the name of the file to open. + The file format type of the document to open. + The XHTML validation type used to validate the HTML file, if the is . + Base path which is used to convert the relative path in the HTML file to absolute path. + This method is not supported in Silverlight, WinRt, Windows Phone, Universal, UNiversal Windows Platform, MVC6 and Xamarin platforms. + + The following code example demonstrates how to open a protected document of the specified type from file system. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.Open("Template.docx", FormatType.Docx, XHTMLValidationType.Strict, "basePath"); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.Open("Template.docx", FormatType.Docx, "password", XHTMLValidationType.Strict, basePath) + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Opens an existing document of the specified file format type with HTML file validation options. + + A string that contains the name of the file to open. + The file format type of the document to open. + The XHTML validation type used to validate the HTML file, if the is . + This method is not supported in Silverlight, WinRt, Windows Phone, Universal, UNiversal Windows Platform, MVC6 and Xamarin platforms. + + The following code example demonstrates how to open a protected document of the specified type from file system. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.Open("Template.docx", FormatType.Docx, XHTMLValidationType.Strict); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.Open("Template.docx", FormatType.Docx, "password", XHTMLValidationType.Strict) + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Opens an existing document of the specified file format type, which is protected with password. + + A string that contains the name of the file to open. + The file format type of the document to open. + The password used to decrypt the protected file. + This method is not supported in Silverlight, WinRt, Windows Phone, Universal, UNiversal Windows Platform, MVC6 and Xamarin platforms. + + The following code example demonstrates how to open a protected document of the specified type from file system. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.Open("Template.docx", FormatType.Docx, "password"); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.Open("Template.docx", FormatType.Docx, "password") + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Opens an existing document of the specified file format type in read-only mode. + + A string that contains the name of the file to open. + The file format type of the document to open. + This method is not supported in Silverlight, WinRt, Windows Phone, Universal, UNiversal Windows Platform and Xamarin platforms. + + + + Opens an existing document of the specified file format type, which is protected with password in read-only mode. + + A string that contains the name of the file to open. + The file format type of the document to open. + The password used to decrypt the protected file. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + fileName is null. + password is null. + + The following code example demonstrates how to open a protected document of the specified type from file system in read-only mode. + + //Create a new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.OpenReadOnly("Template.docx", FormatType.Docx, "password"); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + + + 'Create a new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.OpenReadOnly("Template.docx", FormatType.Docx, "password") + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + + + + + + Opens an existing document of the specified file format type with HTML file validation options in read-only mode. + + A string that contains the name of the file to open. + The file format type of the document to open. + The XHTML validation type used to validate the HTML file, if the is . + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + fileName is null. + + The following code example demonstrates how to open an existing document of the specified type from file system with XHTML validation options in read-only mode. + + //Create a new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.OpenReadOnly("Template.docx", FormatType.Docx, XHTMLValidationType.Strict); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + + + 'Create a new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.OpenReadOnly("Template.docx", FormatType.Docx, XHTMLValidationType.Strict) + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + + + + + + Opens an existing document of the specified file format type with HTML file validation options and base path for relative path to absolute path conversion in read-only mode. + + A string that contains the name of the file to open. + The file format type of the document to open. + The XHTML validation type used to validate the HTML file, if the is . + Base path which is used to convert the relative path in the HTML file to absolute path. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + fileName is null. + baseUrl is null. + + The following code example demonstrates how to open an existing document of the specified type from file system with XHTML validation options in read-only mode. + + //Create a new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.OpenReadOnly("Template.docx", FormatType.Docx, XHTMLValidationType.Strict, "basePath"); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + + + 'Create a new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.OpenReadOnly("Template.docx", FormatType.Docx, XHTMLValidationType.Strict, basePath) + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + + + + + + Saves this to the specified file. + + A string that contains the name of the document to save. + This method is not supported in Silverlight, WinRt, Windows Phone, Universal, UNiversal Windows Platform and Xamarin platforms. + + The following code example demonstrates how to open an existing document from file system. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.Open("Template.docx"); + //Saves the specified document + document.Save("Sample.docx"); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.Open("Template.docx") + 'Saves the specified document + document.Save("Sample.docx") + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Saves this to the specified file in the specified format. + + A string that contains the name of the document to save. + The format in which the document is saved. + This method is not supported in Silverlight, WinRt, Windows Phone, Universal, UNiversal Windows Platform and Xamarin platforms. + + The following code example demonstrates how to open an existing document from file system. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.Open("Template.docx"); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.Open("Template.docx") + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Saves this as EPUB. + + A string that contains the name of the file to save. + The cover page image of the EPUB. + This method is not supported in Silverlight, WinRt, Windows Phone, Universal, UNiversal Windows Platform, MVC6 and Xamarin platforms. + + The following code example demonstrates how to convert the Word document to EPub file. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + MemoryStream stream = new MemoryStream(); + //Create the new WPicture for cover page image + WPicture coverImage = new WPicture(document); + coverImage.LoadImage(Image.FromFile("CoverImage.png")); + //Save the document as EPUB + document.SaveAsEpub("sample.epub", coverImage); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + Dim stream As New MemoryStream() + 'Create the new WPicture for cover page image + Dim coverImage As New WPicture(document) + coverImage.LoadImage(Image.FromFile("CoverImage.png")) + 'Save the document as EPUB + document.SaveAsEpub("sample.epub", coverImage) + 'Close the document + document.Close() + End Sub + + + + + + Saves this to the specified file in the specified format. + + A string that contains the name of the document to save. + The format in which the document is saved. + The HTTP response information. + Specifies options to stream content to browser. + This method is not supported in Silverlight, WinRt, Windows Phone, Universal, UNiversal Windows Platform, MVC6 and Xamarin platforms. + + The following code example demonstrates how to open an existing document from file system. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.Open("Template.docx"); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx, HttpContext.Current.Response, HttpContentDisposition.Attachment); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.Open("Template.docx") + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx, Response, HttpContentDisposition.Attachment) + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Saves this as EPUB. + + A string that contains the name of the file to save. + The cover page image of the EPUB. + The HTTP response information. + Specifies options to stream content to browser. + This method is not supported in Silverlight, WinRt, Windows Phone, Universal, UNiversal Windows Platform, MVC6 and Xamarin platforms. + + The following code example demonstrates how to + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + MemoryStream stream = new MemoryStream(); + //Create the new WPicture for cover page image + WPicture coverImage = new WPicture(document); + coverImage.LoadImage(Image.FromFile("CoverImage.png")); + //Save the document as EPUB + document.SaveAsEpub("sample.epub", coverImage, HttpContext.Current.Response, HttpContentDisposition.Attachment); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + Dim stream As New MemoryStream() + 'Create the new WPicture for cover page image + Dim coverImage As New WPicture(document) + coverImage.LoadImage(Image.FromFile("CoverImage.png")) + 'Save the document as EPUB + document.SaveAsEpub("sample.epub", coverImage, Response, HttpContentDisposition.Attachment) + 'Close the document + document.Close() + End Sub + + + + + + Opens an existing document of the specified file format type from the data stream with HTML file validation options and base path for relative path to absolute path conversion. + + A that contains the data for this . + The file format type of the document to open. + The XHTML validation type used to validate the html file, if the is . + Base path which is used to convert the relative path in the HTML file to absolute path. + This method is not supported in Silverlight, WinRt, Windows Phone, Universal, UNiversal Windows Platform, MVC6 and Xamarin platforms. + + The following code example demonstrates how to open an existing document of the specified type from data stream with XHTML validation options. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + Stream fileStream = new FileStream("Sample.html", FileMode.Open, FileAccess.Read, FileShare.Read); + //Open an existing document from file system + document.Open(fileStream, FormatType.Docx, XHTMLValidationType.Strict, "basepath"); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + Dim fileStream As Stream = New FileStream("Sample.html", FileMode.Open, FileAccess.Read, FileShare.Read) + 'Open an existing document from file system + document.Open(fileStream, FormatType.Docx, XHTMLValidationType.Strict, basepath) + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Opens an existing document of the specified file format type from the data stream with HTML validation options. + + A that contains the data for this . + The file format type of the document to open. + The XHTML validation type used to validate the HTML file, if the is . + This method is not supported in Silverlight, WinRt, Windows Phone, Universal, UNiversal Windows Platform, MVC6 and Xamarin platforms. + + The following code example demonstrates how to open an existing document of the specified type from data stream with XHTML validation options. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + Stream fileStream = new FileStream("Sample.html", FileMode.Open, FileAccess.Read, FileShare.Read); + //Open an existing document from file system + document.Open(fileStream, FormatType.Docx, XHTMLValidationType.Strict); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + Dim fileStream As Stream = New FileStream("Sample.html", FileMode.Open, FileAccess.Read, FileShare.Read) + 'Open an existing document from file system + document.Open(fileStream, FormatType.Docx, XHTMLValidationType.Strict) + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Opens an existing document of the specified file format type from the data stream. + + A that contains the data for this . + The file format type of the document to open. + + The following code example demonstrates how to open an existing document of the specified type from data stream. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + Stream fileStream = new FileStream("Sample.docx", FileMode.Open, FileAccess.Read, FileShare.Read); + //Open an existing document from file system + document.Open(fileStream, FormatType.Docx); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + Dim fileStream As Stream = New FileStream("Sample.docx", FileMode.Open, FileAccess.Read, FileShare.Read) + 'Open an existing document from file system + document.Open(fileStream, FormatType.Docx) + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Opens an existing document of the specified file format type from the data stream, which is protected with password. + + A that contains the data for this . + The file format type of the document to open. + The password used to decrypt the document. + This API is supported from .NET Framework 2.0 and .NET Standard 2.0 onwards. + + The following code example demonstrates how to open a protected document of the specified type from data stream. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + Stream fileStream = new FileStream("Sample.docx", FileMode.Open, FileAccess.Read, FileShare.Read); + //Open an existing document from file system + document.Open(fileStream, FormatType.Docx, "password"); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + Dim fileStream As Stream = New FileStream("Sample.docx", FileMode.Open, FileAccess.Read, FileShare.Read) + 'Open an existing document from file system + document.Open(fileStream, FormatType.Docx, "password") + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Saves this to the specified stream in the specified file format type. + + The Stream where the document will be saved. + The format in which the document is saved. + + The following code example demonstrates how to save the document to MemoryStream + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + MemoryStream stream = new MemoryStream(); + //Save the document to stream + document.Save(stream, FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + Dim stream As New MemoryStream() + 'Save the document to stream + document.Save(stream, FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Release the resources occupied by this instance. + + + + + Converts the whole document into an images. + + An ImageType that specifies the type of the image to render. + Return the array of images that contains the each document page as single image. + + + Layouting the contents of a Word document as pages in the Essential DocIO is not exactly the same as the layouting in Microsoft Word. So, the total number of pages and each page content may vary slightly compared to that of the Microsoft Word. + + + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + + The following code example demonstrates how to convert the Word document to image. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Initialize ChartToImageConverter for converting charts during Word to image conversion + wordDocument.ChartToImageConverter = new ChartToImageConverter(); + //Set the scaling mode for charts (Normal mode reduces the file size) + wordDocument.ChartToImageConverter.ScalingMode = ScalingMode.Normal; + //Convert word document to image + Image[] images = wordDocument.RenderAsImages(ImageType.Bitmap); + //Close the document + wordDocument.Close(); + int i = 0; + foreach (Image image in images) + { + //Save the images as jpeg + image.Save("WordToImage_" + i + ".jpeg", ImageFormat.Jpeg); + i++; + } + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim wordDocument As New WordDocument("Template.docx", FormatType.Docx) + 'Initialize ChartToImageConverter for converting charts during Word to image conversion + wordDocument.ChartToImageConverter = New ChartToImageConverter() + 'Set the scaling mode for charts (Normal mode reduces the file size) + wordDocument.ChartToImageConverter.ScalingMode = ScalingMode.Normal + 'Convert word document to image + Dim images As Image() = wordDocument.RenderAsImages(ImageType.Bitmap) + 'Close the document + wordDocument.Close() + Dim i As Integer = 0 + For Each image As Image In images + 'Save the images as jpeg + image.Save("WordToImage_" & i & ".jpeg", ImageFormat.Jpeg) + i += 1 + Next + End Sub + + + + + + + Converts the specified document page into image. + + + The zero based page index that represent which page to convert. + + + An ImageFormat that specifies the format of the saved image. + + + An that represent specified document page as image. + + + + Layouting the contents of a Word document as pages in the Essential DocIO is not exactly the same as the layouting in Microsoft Word. So, the total number of pages may vary slightly compared to that of the Microsoft Word. + + + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + + The following code example demonstrates how to convert the Word document to image. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Initialize ChartToImageConverter for converting charts during Word to image conversion + wordDocument.ChartToImageConverter = new ChartToImageConverter(); + //Set the scaling mode for charts (Normal mode reduces the file size) + wordDocument.ChartToImageConverter.ScalingMode = ScalingMode.Normal; + //Convert word document to stream + Stream imageStream = wordDocument.RenderAsImages(2, System.Drawing.Imaging.ImageFormat.Bmp); + //Close the document + wordDocument.Close(); + //Convert the stream to Image + Image image = Image.FromStream(imageStream); + //Save the image as jpeg + image.Save("WordToImage.jpeg", ImageFormat.Jpeg); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim wordDocument As New WordDocument("Template.docx", FormatType.Docx) + 'Initialize ChartToImageConverter for converting charts during Word to image conversion + wordDocument.ChartToImageConverter = New ChartToImageConverter() + 'Set the scaling mode for charts (Normal mode reduces the file size) + wordDocument.ChartToImageConverter.ScalingMode = ScalingMode.Normal + 'Convert word document to stream + Dim imageStream As Stream = wordDocument.RenderAsImages(2, System.Drawing.Imaging.ImageFormat.Bmp) + 'Close the document + wordDocument.Close() + 'Convert the stream to Image + Dim image As Image = Image.FromStream(imageStream) + 'Save the image as jpeg + image.Save("WordToImage.jpeg", ImageFormat.Jpeg) + End Sub + + + + + + + Converts the specified document page into image. + + + The zero based page index that represent which page to convert. + + + An ImageType that specifies the type of the image to render. + + + An that represent specified document page as image. + + + + Layouting the contents of a Word document as pages in the Essential DocIO is not exactly the same as the layouting in Microsoft Word. So, the total number of pages may vary slightly compared to that of the Microsoft Word. + + + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + + The following code example demonstrates how to convert the specified Word document page as image. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Initialize ChartToImageConverter for converting charts during Word to image conversion + wordDocument.ChartToImageConverter = new ChartToImageConverter(); + //Set the scaling mode for charts (Normal mode reduces the file size) + wordDocument.ChartToImageConverter.ScalingMode = ScalingMode.Normal; + //Convert word document to image + Image image = wordDocument.RenderAsImages(2, ImageType.Bitmap); + //Close the document + wordDocument.Close(); + //Save the image + image.Save("WordToImage.jpeg", ImageFormat.Jpeg); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim wordDocument As New WordDocument("Template.docx", FormatType.Docx) + 'Initialize ChartToImageConverter for converting charts during Word to image conversion + wordDocument.ChartToImageConverter = New ChartToImageConverter() + 'Set the scaling mode for charts (Normal mode reduces the file size) + wordDocument.ChartToImageConverter.ScalingMode = ScalingMode.Normal + 'Convert word document to image + Dim image As Image = wordDocument.RenderAsImages(2, ImageType.Bitmap) + 'Close the document + wordDocument.Close() + 'Save the images as jpeg + image.Save("WordToImage_" & i & ".jpeg", ImageFormat.Jpeg) + End Sub + + + + + + + Converts the specified range of document pages into images + + + The zero based page index that represents the starting document page index. + + + The total number of pages to convert. + + + An ImageType That specifies the type of the image to render. + + + An array of images that represent specified range of document pages as images. + + + + Layouting the contents of a Word document as pages in the Essential DocIO is not exactly the same as the layouting in Microsoft Word. So, the total number of pages may vary slightly compared to that of the Microsoft Word. + + + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + + The following code example demonstrates how to convert the Word document to image. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Initialize ChartToImageConverter for converting charts during Word to image conversion + wordDocument.ChartToImageConverter = new ChartToImageConverter(); + //Set the scaling mode for charts (Normal mode reduces the file size) + wordDocument.ChartToImageConverter.ScalingMode = ScalingMode.Normal; + //Convert word document to image + Image[] images = wordDocument.RenderAsImages(0, 2, ImageType.Bitmap); + //Close the document + wordDocument.Close(); + int i = 0; + foreach (Image image in images) + { + //Save the images as jpeg + image.Save("WordToImage_" + i + ".jpeg", ImageFormat.Jpeg); + i++; + } + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim wordDocument As New WordDocument("Template.docx", FormatType.Docx) + 'Initialize ChartToImageConverter for converting charts during Word to image conversion + wordDocument.ChartToImageConverter = New ChartToImageConverter() + 'Set the scaling mode for charts (Normal mode reduces the file size) + wordDocument.ChartToImageConverter.ScalingMode = ScalingMode.Normal + 'Convert word document to image + Dim images As Image() = wordDocument.RenderAsImages(0, 2, ImageType.Bitmap) + 'Close the document + wordDocument.Close() + Dim i As Integer = 0 + For Each image As Image In images + 'Save the images as jpeg + image.Save("WordToImage_" & i & ".jpeg", ImageFormat.Jpeg) + i += 1 + Next + End Sub + + + + + + + Finds the text based on specified regular expression. + + + The used to find the text. + + + The that contains the found text in the document. + + + The following code example demonstrates how to find a particular text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Find the first occurrence of a particular text in the document + TextSelection textSelection = document.Find(new Regex("panda")); + //Get the found text as single text range + WTextRange textRange = textSelection.GetAsOneRange(); + //Modify the text + textRange.Text = "Replaced text"; + //Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow; + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Find the first occurrence of a particular text in the document + Dim textSelection As TextSelection = document.Find(New Regex("panda")) + 'Get the found text as single text range + Dim textRange As WTextRange = textSelection.GetAsOneRange() + 'Modify the text + textRange.Text = "Replaced text" + 'Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + Finds the first entry of specified pattern of text in single-line mode which is extended to several paragraph in the document. + + The used to find the text. + The collection that contains the found text in the document. + + The following code example demonstrates how to + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Find the first occurrence of a particular text extended to several paragraphs in the document + TextSelection[] textSelections = document.FindSingleLine(new Regex("First paragraph Second paragraph")); + WParagraph paragraph = null; + foreach (TextSelection textSelection in textSelections) + { + //Get the found text as single text range and set highlight color + WTextRange textRange = textSelection.GetAsOneRange(); + textRange.CharacterFormat.HighlightColor = Color.YellowGreen; + paragraph = textRange.OwnerParagraph; + } + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Find the first occurrence of a particular text extended to several paragraphs in the document + Dim textSelections As TextSelection() = document.FindSingleLine(new Regex("First paragraph Second paragraph")) + Dim paragraph As WParagraph = Nothing + For Each textSelection As TextSelection In textSelections + 'Get the found text as single text range and set highlight color + Dim textRange As WTextRange = textSelection.GetAsOneRange() + textRange.CharacterFormat.HighlightColor = Color.YellowGreen + paragraph = textRange.OwnerParagraph + Next + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + Finds the text based on specified string, taking into the consideration of caseSensitive and wholeWord options. + + + A string used to find the text. + + + Set to true to match the similar case text which specified in the parameter; otherwise false. + + + Set to true to match the whole word text which specified in the parameter; otherwise false. + + + The that contains the found text in the document. + + + The following code example demonstrates how to find a particular text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Find the first occurrence of a particular text in the document + TextSelection textSelection = document.Find("panda", true, true); + //Get the found text as single text range + WTextRange textRange = textSelection.GetAsOneRange(); + //Modify the text + textRange.Text = "Replaced text"; + //Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow; + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Find the first occurrence of a particular text in the document + Dim textSelection As TextSelection = document.Find("panda", true, true) + 'Get the found text as single text range + Dim textRange As WTextRange = textSelection.GetAsOneRange() + 'Modify the text + textRange.Text = "Replaced text" + 'Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + Finds the first entry of specified pattern of text in single-line mode which is extended to several paragraph in the document, taking into the consideration of caseSensitive and wholeWord options. + + + A string used to find the text. + + + Set to true to match the similar case text which specified in the parameter; otherwise false. + + + Set to true to match the whole word text which specified in the parameter; otherwise false. + + The collection that contains the found text in the document. + + The following code example demonstrates how to + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Find the first occurrence of a particular text extended to several paragraphs in the document + TextSelection[] textSelections = document.FindSingleLine("First paragraph Second paragraph", true, false); + WParagraph paragraph = null; + foreach (TextSelection textSelection in textSelections) + { + //Get the found text as single text range and set highlight color + WTextRange textRange = textSelection.GetAsOneRange(); + textRange.CharacterFormat.HighlightColor = Color.YellowGreen; + paragraph = textRange.OwnerParagraph; + } + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Find the first occurrence of a particular text extended to several paragraphs in the document + Dim textSelections As TextSelection() = document.FindSingleLine("First paragraph Second paragraph", True, False) + Dim paragraph As WParagraph = Nothing + For Each textSelection As TextSelection In textSelections + 'Get the found text as single text range and set highlight color + Dim textRange As WTextRange = textSelection.GetAsOneRange() + textRange.CharacterFormat.HighlightColor = Color.YellowGreen + paragraph = textRange.OwnerParagraph + Next + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + Finds and returns all entries of the specified regular expression. + + + The used to find the text. + + + The collection that contains all the entries of the found text in the document. + + + The following code example demonstrates how to search a particular text and highlight it. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Find the occurrence of the Word "panda" in the document + TextSelection[] textSelection = document.FindAll(new Regex("panda")); + //Iterate through each occurrence and highlight it + foreach (TextSelection selection in textSelection) + { + IWTextRange textRange = selection.GetAsOneRange(); + textRange.CharacterFormat.HighlightColor = Color.Yellow; + } + //Save and Close the document + document.Save("Result.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Find the occurrence of the word "panda" in the document + Dim textSelection As TextSelection() = document.FindAll(new Regex("panda")) + 'Iterate through each occurrence and highlight it + For Each selection As TextSelection In textSelection + Dim textRange As IWTextRange = selection.GetAsOneRange() + textRange.CharacterFormat.HighlightColor = Color.Yellow + Next + document.Save("Result.docx") + document.Close() + End Sub + + + + + + + Finds and returns all entries of the specified string, taking into the consideration of caseSensitive and wholeWord options. + + + A string used to find the text. + + + Set to true to match the similar case text which specified in the parameter; otherwise false. + + + Set to true to match the whole word text which specified in the parameter; otherwise false. + + + The collection that contains all the entries of the found text in the document. + + + The following code example demonstrates how to search a particular text and highlight it. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Find the occurrence of the Word "panda" in the document + TextSelection[] textSelection = document.FindAll("panda", false, true); + //Iterate through each occurrence and highlight it + foreach (TextSelection selection in textSelection) + { + IWTextRange textRange = selection.GetAsOneRange(); + textRange.CharacterFormat.HighlightColor = Color.Yellow; + } + //Save and Close the document + document.Save("Result.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Find the occurrence of the word "panda" in the document + Dim textSelection As TextSelection() = document.FindAll("panda", false, true) + 'Iterate through each occurrence and highlight it + For Each selection As TextSelection In textSelection + Dim textRange As IWTextRange = selection.GetAsOneRange() + textRange.CharacterFormat.HighlightColor = Color.Yellow + Next + document.Save("Result.docx") + document.Close() + End Sub + + + + + + + Replaces all entries of the given with the replace string. + + The used to find the text. + The string specifies the text to replace. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Replace all occurrence of a particular text in the document + document.Replace(new Regex("Paragraph"),"paragraph"); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Replace all occurrence of a particular text in the document + document.Replace(New Regex("Paragraph"), "paragraph") + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given string in the document with replace string, taking into + consideration of case sensitive and whole word options. + + The string represents the text to be found. + The string specifies the text to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Replace all occurrence of a particular text in the document + document.Replace("Paragraph","paragraph", false, true); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Replace all occurrence of a particular text in the document + document.Replace("Paragraph", "paragraph", False, True) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given string in the document with , taking into + consideration case sensitive and whole word options. + + The string represents the text to be found. + The specifies the text to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Find the first occurrence of the regular expression + TextSelection selection = document.Find(new Regex("Panda")); + //Replace all occurrence of a particular regular expression with the text selection in the document + document.Replace("Giant panda", selection, true, false); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = document.Find(New Regex("Panda")) + 'Replace all occurrence of a particular regular expression with the text selection in the document + document.Replace("Giant panda", selection, True, False) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given string in the document with , taking into + consideration case sensitive, whole word and formatting options. + + The string represents the text to be found. + The specifies the text to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + Set to true if to save source formatting; otherwise, false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Find the first occurrence of the regular expression + TextSelection selection = document.Find(new Regex("Panda")); + //Replace all occurrence of a particular regular expression with the text selection in the document + document.Replace("Giant panda", selection, true, false, true); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = document.Find(New Regex("Panda")) + 'Replace all occurrence of a particular regular expression with the text selection in the document + document.Replace("Giant panda", selection, True, False, False) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces the specified regular expression with a in the document. + + The used to find the text. + The specifies the text to replace. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Find the first occurrence of the regular expression + TextSelection selection = document.Find(new Regex("Panda")); + //Replace all occurrence of a particular regular expression with the text selection in the document + document.Replace(new Regex("Giant panda"), selection); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = document.Find(New Regex("Panda")) + 'Replace all occurrence of a particular regular expression with the text selection in the document + document.Replace(New Regex("Giant panda"), selection) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given regular expression in the document with the + along with its formatting. + + The used to find the text. + The specifies the text to replace. + Set to true to save source formatting; otherwise, false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Find the first occurrence of the regular expression + TextSelection selection = document.Find(new Regex("Panda")); + //Replace all occurrence of a particular regular expression with the text selection in the document + document.Replace(new Regex("Giant panda"), selection, true); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = document.Find(New Regex("Panda")) + 'Replace all occurrence of a particular regular expression with the text selection in the document + document.Replace(New Regex("Giant panda"), selection, True) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given string in the document with , taking into + consideration case sensitive, whole word options. + + The string represents the text to be found. + The text body part to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + if it specifies whole word, set to true. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Find the first occurrence of the regular expression + TextSelection selection = document.Find(new Regex("Panda")); + //Initialize text body part + TextBodyPart bodyPart = new TextBodyPart(selection); + //Replace a particular text with the text body part + document.Replace("Giant panda", bodyPart, true, false); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = document.Find(New Regex("Panda")) + 'Initialize text body part + Dim bodyPart As New TextBodyPart(selection) + 'Replace a particular text with the text body part + document.Replace("Giant panda", bodyPart, True, False) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given string in the document with , taking into + consideration case sensitive, whole word and formatting options. + + The string represents the text to be found. + The text body part to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false.. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + Set to true to save source formatting; otherwise, false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Find the first occurrence of the regular expression + TextSelection selection = document.Find(new Regex("Panda")); + //Initialize text body part + TextBodyPart bodyPart = new TextBodyPart(selection); + //Replace a particular text with the text body part + document.Replace("Giant panda", bodyPart, true, false, true); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = document.Find(New Regex("Panda")) + 'Initialize text body part + Dim bodyPart As New TextBodyPart(selection) + 'Replace a particular text with the text body part + document.Replace("Giant panda", bodyPart, True, False, True) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given regular expression in the document with the + . + + The used to find the text. + The text body part to replace. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Find the first occurrence of the regular expression + TextSelection selection = document.Find(new Regex("Panda")); + //Initialize text body part + TextBodyPart bodyPart = new TextBodyPart(selection); + //Replace a particular text with the text body part + document.Replace(new Regex("Giant panda"), bodyPart); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = document.Find(New Regex("Panda")) + 'Initialize text body part + Dim bodyPart As New TextBodyPart(selection) + 'Replace a particular text with the text body part + document.Replace(New Regex("Giant panda"), bodyPart) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given regular expression in the document with the + along with its formatting. + + The used to find the text. + The text body part to replace. + Set to true to save source formatting; otherwise, false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Find the first occurrence of the regular expression + TextSelection selection = document.Find(new Regex("Panda")); + //Initialize text body part + TextBodyPart bodyPart = new TextBodyPart(selection); + //Replace a particular text with the text body part + document.Replace(new Regex("Giant panda"), bodyPart, true); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = document.Find(New Regex("Panda")) + 'Initialize text body part + Dim bodyPart As New TextBodyPart(selection) + 'Replace a particular text with the text body part + document.Replace(New Regex("Giant panda"), bodyPart, True) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given string in the document with another Word document, taking into + consideration case sensitive, whole word options. + + The string represents the text to be found. + The Word document to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Load the another existing Word document to replace + WordDocument replaceDocument = new WordDocument("Replace.docx"); + //Replace all occurrence of a particular regular expression with the another document and close the document + document.Replace("Giant panda", replaceDocument, true, false); + replaceDocument.Close(); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Load the another existing Word document to replace + Dim replaceDocument As New WordDocument("Replace.docx") + 'Replace all occurrence of a particular regular expression with the another document and close the document + document.Replace("Giant panda", replaceDocument, True, False) + replaceDocument.Close(); + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given string in the document with another Word document, taking into + consideration case sensitive, whole word and formatting options. + + The string represents the text to be found. + The Word document to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + Set to true to save source formatting; otherwise, false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Load the another existing Word document to replace + WordDocument replaceDocument = new WordDocument("Replace.docx"); + //Replace all occurrence of a particular regular expression with the another document and close the document + document.Replace("Giant panda", replaceDocument, true, false, true); + replaceDocument.Close(); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Load the another existing Word document to replace + Dim replaceDocument As New WordDocument("Replace.docx") + 'Replace all occurrence of a particular regular expression with the another document and close the document + document.Replace("Giant panda", replaceDocument, True, False, True) + replaceDocument.Close(); + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given regular expression in the document with the + another word document along with its formatting. + + The used to find the text. + The Word document to replace. + Set to true to save source formatting; otherwise, false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Load the another existing Word document to replace + WordDocument replaceDocument = new WordDocument("Replace.docx"); + //Replace all occurrence of a particular regular expression with the another document and close the document + document.Replace(new Regex("Giant panda"), replaceDocument, true); + replaceDocument.Close(); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Load the another existing Word document to replace + Dim replaceDocument As New WordDocument("Replace.docx") + 'Replace all occurrence of a particular regular expression with the another document and close the document + document.Replace(New Regex("Giant panda"), replaceDocument, True) + replaceDocument.Close(); + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Updates Paragraphs count, Word count and Character count in the document + + + The following code example demonstrates how to update Paragraphs count, Word count and Character count in the document. + + //Open an input word template + IWordDocument document = new WordDocument(@"Template.docx"); + //Update the Paragraphs count, Word count and Character count in the document + document.UpdateWordCount(); + //Save and close the Word document instance. + document.Save("Output.docx", FormatType.Docx); + document.Close(); + } + + + 'Open an input word template + Dim document As New IWordDocument("Template.docx") + 'Update the Paragraphs count, Word count and Character count in the document. + document.UpdateWordCount() + �Save and close the Word document instance. + document.Save("Output.docx", FormatType.Docx) + document.Close() + + + + + + Updates Paragraphs count, Word count and Character count. Updates page count if performLayout set to true using Doc to PDF layouting engine. + + Set to true to update the page count of the document using Word to PDF layouting engine; otherwise, false. The default is false. + + This method is not supported in Silverlight, WinRT, Universal, Universal Windows Platform, MVC6, Xamarin and windows phone platforms. + + + The following code example demonstrates how to update Page count, Paragraphs count, Word count and Character count in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open an input word template + WordDocument document = new WordDocument(@"Template.docx"); + //Update the Page count, Paragraphs count, Word count and Character count in the document + document.UpdateWordCount(true); + //Save and close the Word document instance. + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open an input word template + Dim document As New WordDocument("Template.docx") + 'Update the Page count, Paragraphs count, Word count and Character count in the document. + document.UpdateWordCount(True) + �Save and close the Word document instance. + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Updates fields present in the document. + + + Updating of NUMPAGES field and Cross Reference field with Page number and Paragraph number options are not supported in Silverlight, WinRT, Universal and Windows Phone platforms. + Currently group shapes, drawing canvas, and table auto resizing are not supported in Word to PDF lay outing, and this may lead to update incorrect page number and total number of pages. + While updating NUMPAGES field and Cross Reference field with Page number and Paragraph number options uses makes use of our Word to PDF layouting engine which may lead to take some considerable amount of performance to update the above mentioned fields. + + + The following code example demonstrates how to update the fields present in Word document. + + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Input.docx", FormatType.Docx); + //Updates the fields present in a document. + document.UpdateDocumentFields(); + document.Save("Result.docx", FormatType.Docx); + document.Close(); + + + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Input.docx", FormatType.Docx) + 'Updates the fields present in a document. + document.UpdateDocumentFields() + document.Save("Result.docx", FormatType.Docx) + document.Close() + + + + + + Updates the Alternate chunks present in the Word document + + + The following code example demonstrates how to update the Alternate chunks present in Word document + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Input.docx", FormatType.Docx); + //Updates the Alternate chunks present in a document. + document.UpdateAlternateChunks(); + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Input.docx", FormatType.Docx) + 'Updates the Alternate chunks present in a document. + document.UpdateAlternateChunks() + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Update Table of contents in the document. + + + Updating TOC makes use of our Word to PDF layouting engine which may lead to the updation of incorrect page number due to its limitations. Also use of WOrd to PDF layout engine may lead to take some considerable amount of performance to update the page numbers. + + + The following code example demonstrates how to update a TOC in an existing word document. + + //Open an input word template + WordDocument document = new WordDocument(@"Template.docx"); + //Update the table of contents. + document.UpdateTableOfContents(); + //Save and close the Word document instance. + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Open an input word template + Dim document As New WordDocument("Template.docx") + 'Update the table of contents. + document.UpdateTableOfContents() + 'Save and close the Word document instance. + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Replaces all entries of given string which is extended to several paragraphs in the document with replace string, taking into + consideration of case sensitive and whole word options. + + The string represents the text to be found. + The string specifies the text to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace the text extended to several paragraphs with simple text. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Replace the text extended to two paragraphs with simple text + document.ReplaceSingleLine("First paragraph Second paragraph", "Replaced paragraph", true, false); + //Save and close the document + document.Save("Replace.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Replace the text extended to two paragraphs with simple text + document.ReplaceSingleLine("First paragraph Second paragraph", "Replaced paragraph", True, False) + 'Save and close the document + document.Save("Replace.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of the specified pattern text, which is extended to several paragraph, with replace text. + + The used to find the text. + The string specifies the text to replace. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace the text extended to several paragraphs with simple text. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Replace the text extended to two paragraphs with simple text + document.ReplaceSingleLine(new Regex("First paragraph Second paragraph"), "Replaced paragraph"); + //Save and close the document + document.Save("Replace.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Replace the text extended to two paragraphs with simple text + document.ReplaceSingleLine(New Regex("First paragraph Second paragraph"), "Replaced paragraph") + 'Save and close the document + document.Save("Replace.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given string which is extended to several paragraph in the document with , taking into + consideration case sensitive and whole word options. + + The string represents the text to be found. + The specifies the text to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace the text extended to several paragraphs with another text. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Find the first occurrence of a particular text in the document + TextSelection selection = document.Find("contents", false, false); + //Replace the text extended to two paragraphs with text selection + document.ReplaceSingleLine("First paragraph Second paragraph", selection, true, false); + //Save and close the document + document.Save("Replace.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Find the first occurrence of a particular text in the document + Dim selection As TextSelection = document.Find("contents", False, False) + 'Replace the text extended to two paragraphs with text selection + document.ReplaceSingleLine("First paragraph Second paragraph", selection, True, False) + 'Save and close the document + document.Save("Replace.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given regular expression text which is extended to several paragraph in the document with the + . + + The used to find the text. + The text selection to replace. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace the text extended to several paragraphs with another text. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Find the first occurrence of a particular text in the document + TextSelection selection = document.Find("contents", false, false); + //Replace the text extended to two paragraphs with text selection + document.ReplaceSingleLine(new Regex("First paragraph Second paragraph"), selection); + //Save and close the document + document.Save("Replace.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Find the first occurrence of a particular text in the document + Dim selection As TextSelection = document.Find("contents", False, False) + 'Replace the text extended to two paragraphs with text selection + document.ReplaceSingleLine(New Regex("First paragraph Second paragraph"), selection) + 'Save and close the document + document.Save("Replace.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given string which is extended to several paragraphs in the document with , taking into + consideration case sensitive, whole word options. + + The string represents the text to be found. + The text body part to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + if it specifies whole word, set to true. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace the text extended to several paragraphs with . + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Find the first occurrence of a particular text in the document + TextSelection selection = document.Find("contents", false, false); + //Initialize text body part + TextBodyPart bodyPart = new TextBodyPart(selection); + //Replace a particular text with the text body part + document.ReplaceSingleLine("First paragraph Second paragraph", bodyPart, true, false); + //Save and close the document + document.Save("Replace.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Find the first occurrence of a particular text in the document + Dim selection As TextSelection = document.Find("contents", False, False) + 'Initialize text body part + Dim bodyPart As New TextBodyPart(selection) + 'Replace a particular text with the text body part + document.ReplaceSingleLine("First paragraph Second paragraph", bodyPart, True, False) + 'Save and close the document + document.Save("Replace.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given regular expression text which is extended to several paragraph in the document with the + . + + The used to find the text. + The text body part to replace. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace the text extended to several paragraphs with . + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Find the first occurrence of a particular text in the document + TextSelection selection = document.Find("contents", false, false); + //Initialize text body part + TextBodyPart bodyPart = new TextBodyPart(selection); + //Replace a particular text with the text body part + document.ReplaceSingleLine(new Regex("First paragraph Second paragraph"), bodyPart); + //Save and close the document + document.Save("Replace.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Find the first occurrence of a particular text in the document + Dim selection As TextSelection = document.Find("contents", False, False) + 'Initialize text body part + Dim bodyPart As New TextBodyPart(selection) + 'Replace a particular text with the text body part + document.ReplaceSingleLine(New Regex("First paragraph Second paragraph"), bodyPart) + 'Save and close the document + document.Save("Replace.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Finds the next entry of the specified text from the specified text body item, taking into the consideration of caseSensitive + and wholeWord options. + + The that represents the start body item at which search starts (paragraph or table). + + A string used to find the text. + + + Set to true to match the similar case text which specified in the parameter; otherwise false. + + + Set to true to match the whole word text which specified in the parameter; otherwise false. + + + The that contains the found text in the document. + + + The following code example demonstrates how to find a particular text and its next occurrence in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Find the first occurrence of a particular text in the document + TextSelection textSelection = document.Find("as graphical contents", false, true); + //Get the found text as single text range + WTextRange textRange = textSelection.GetAsOneRange(); + //Modify the text + textRange.Text = "Replaced text"; + //Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow; + //Find the next occurrence of a particular text from the previous paragraph + textSelection = document.FindNext(textRange.OwnerParagraph, "paragraph", true, false); + //Get the found text as single text range + WTextRange range = textSelection.GetAsOneRange(); + //Set bold formatting + range.CharacterFormat.Bold = true; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Find the first occurrence of a particular text in the document + Dim textSelection As TextSelection = document.Find("as graphical contents", false, true) + 'Get the found text as single text range + Dim textRange As WTextRange = textSelection.GetAsOneRange() + 'Modify the text + textRange.Text = "Replaced text" + 'Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow + 'Find the next occurrence of a particular text from the previous paragraph + textSelection = document.FindNext(textRange.OwnerParagraph, "paragraph", true, false) + 'Get the found text as single text range + Dim range As WTextRange = textSelection.GetAsOneRange() + 'Set bold formatting + range.CharacterFormat.Bold = True + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + Finds the next entry of the specified regular expression from the specified text body item. + + The that represents the start body item at which search starts (paragraph or table). + The used to find the text. + The that contains the found text in the document. + + The following code example demonstrates how to find a particular text and its next occurrence in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Find the first occurrence of a particular text in the document + TextSelection textSelection = document.Find(new Regex("as graphical contents")); + //Get the found text as single text range + WTextRange textRange = textSelection.GetAsOneRange(); + //Modify the text + textRange.Text = "Replaced text"; + //Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow; + //Find the next occurrence of a particular text from the previous paragraph + textSelection = document.FindNext(textRange.OwnerParagraph, new Regex("paragraph")); + //Get the found text as single text range + WTextRange range = textSelection.GetAsOneRange(); + //Set bold formatting + range.CharacterFormat.Bold = true; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Find the first occurrence of a particular text in the document + Dim textSelection As TextSelection = document.Find("as graphical contents") + 'Get the found text as single text range + Dim textRange As WTextRange = textSelection.GetAsOneRange() + 'Modify the text + textRange.Text = "Replaced text" + 'Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow + 'Find the next occurrence of a particular text from the previous paragraph + textSelection = document.FindNext(textRange.OwnerParagraph, "paragraph") + 'Get the found text as single text range + Dim range As WTextRange = textSelection.GetAsOneRange() + 'Set bold formatting + range.CharacterFormat.Bold = True + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + Finds the next entry of the specified text from the specified text body item in single-line mode which is extended to several paragraph in the document, taking into the consideration of caseSensitive + and wholeWord options. + + The that represents the start body item at which search starts (paragraph or table). + + A string used to find the text. + + + Set to true to match the similar case text which specified in the parameter; otherwise false. + + + Set to true to match the whole word text which specified in the parameter; otherwise false. + + + The that contains the found text in the document. + + + The following code example demonstrates how to find a particular text and its next occurrence which is extended to several paragraphs in the Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Find the first occurrence of a particular text extended to several paragraphs in the document + TextSelection[] textSelections = document.FindSingleLine("First paragraph Second paragraph", true, false); + WParagraph paragraph = null; + foreach (TextSelection textSelection in textSelections) + { + //Get the found text as single text range and set highlight color + WTextRange textRange = textSelection.GetAsOneRange(); + textRange.CharacterFormat.HighlightColor = Color.YellowGreen; + paragraph = textRange.OwnerParagraph; + } + //Find the next occurrence of a particular text extended to several paragraphs in the document + textSelections = document.FindNextSingleLine(paragraph, "First paragraph Second paragraph", true, false); + foreach (TextSelection textSelection in textSelections) + { + //Get the found text as single text range and set italic formatting + WTextRange text = textSelection.GetAsOneRange(); + text.CharacterFormat.Italic = true; + } + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Find the first occurrence of a particular text extended to several paragraphs in the document + Dim textSelections As TextSelection() = document.FindSingleLine("First paragraph Second paragraph", True, False) + Dim paragraph As WParagraph = Nothing + For Each textSelection As TextSelection In textSelections + 'Get the found text as single text range and set highlight color + Dim textRange As WTextRange = textSelection.GetAsOneRange() + textRange.CharacterFormat.HighlightColor = Color.YellowGreen + paragraph = textRange.OwnerParagraph + Next + 'Find the next occurrence of a particular text extended to several paragraphs in the document + textSelections = document.FindNextSingleLine(paragraph, "First paragraph Second paragraph", True, False) + For Each textSelection As TextSelection In textSelections + 'Get the found text as single text range and set italic formatting + Dim text As WTextRange = textSelection.GetAsOneRange() + text.CharacterFormat.Italic = True + Next + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + Finds the next entry of the specified pattern of text in single-line mode which is extended to several paragraph in the document. + + The that represents the start body item at which search starts (paragraph or table). + The used to find the text. + The that contains the found text in the document. + + The following code example demonstrates how to find a particular text and its next occurrence which is extended to several paragraphs in the Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Find the first occurrence of a particular text extended to several paragraphs in the document + TextSelection[] textSelections = document.FindSingleLine("First paragraph Second paragraph", true, false); + WParagraph paragraph = null; + foreach (TextSelection textSelection in textSelections) + { + //Get the found text as single text range and set highlight color + WTextRange textRange = textSelection.GetAsOneRange(); + textRange.CharacterFormat.HighlightColor = Color.YellowGreen; + paragraph = textRange.OwnerParagraph; + } + //Find the next occurrence of a particular text extended to several paragraphs in the document + textSelections = document.FindNextSingleLine(paragraph, new Regex("First paragraph Second paragraph")); + foreach (TextSelection textSelection in textSelections) + { + //Get the found text as single text range and set italic formatting + WTextRange text = textSelection.GetAsOneRange(); + text.CharacterFormat.Italic = true; + } + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Find the first occurrence of a particular text extended to several paragraphs in the document + Dim textSelections As TextSelection() = document.FindSingleLine("First paragraph Second paragraph", True, False) + Dim paragraph As WParagraph = Nothing + For Each textSelection As TextSelection In textSelections + 'Get the found text as single text range and set highlight color + Dim textRange As WTextRange = textSelection.GetAsOneRange() + textRange.CharacterFormat.HighlightColor = Color.YellowGreen + paragraph = textRange.OwnerParagraph + Next + 'Find the next occurrence of a particular text extended to several paragraphs in the document + textSelections = document.FindNextSingleLine(paragraph, new Regex("First paragraph Second paragraph")) + For Each textSelection As TextSelection In textSelections + 'Get the found text as single text range and set italic formatting + Dim text As WTextRange = textSelection.GetAsOneRange() + text.CharacterFormat.Italic = True + Next + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + Resets the find next of . + + + + + Creates a new paragraph item instance. + + A represents the type of paragraph item to create. + The this method created. + + + + Removes the macros in the document. + + The following code example demonstrates how to remove macros from the Word document. + This method removes the macros from DOCM and DOTM format files. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the document with macros + WordDocument document = new WordDocument("Sample.docm"); + //Check whether the document has macros and remove them + if (document.HasMacros) + document.RemoveMacros(); + //Save the document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the document with macros + Dim document As New WordDocument("Sample.docm") + 'Check whether the document has macros and remove them + If document.HasMacros Then + document.RemoveMacros() + End If + 'Save the document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Gets or sets the object for converting chart to image + + + In Word to PDF conversion, to preserve the charts as images in the generated PDF document, this must be initialized. Otherwise the charts will not be exported to the converted PDF + ChartToImageConverter is supported from .NET Framework 4.0 onwards. + + + The following code example demonstrates how to initialize the to preserve the charts as images in the generated PDF document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Initialize ChartToImageConverter for converting charts during Word to pdf conversion + wordDocument.ChartToImageConverter = new ChartToImageConverter(); + //Create an instance of DocToPDFConverter + DocToPDFConverter converter = new DocToPDFConverter(); + //Convert Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Close the instance of Word document object + wordDocument.Close(); + //Save the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Close the instance of PDF document object + pdfDocument.Close(true); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim wordDocument As New WordDocument("Template.docx", FormatType.Docx) + 'Initialize ChartToImageConverter for converting charts during Word to pdf conversion + /// wordDocument.ChartToImageConverter = New ChartToImageConverter() + 'Create an instance of DocToPDFConverter + Dim converter As New DocToPDFConverter() + 'Convert Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Close the instance of document object + wordDocument.Close() + 'Save the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Close the instance of document object + pdfDocument.Close(True) + End Sub + + + + + + Gets a instance that represents the font settings of the Word document. Read-only. + + The instance that represents the font settings of the Word document. + + + The following code example demonstrates how to initialize the to perform font substitution when a specified font is not installed in the production environment. + + // Loads an existing Word document. + WordDocument wordDocument = new WordDocument("template.docx", FormatType.Docx); + // Initializes the SubstituteFont event to perform font substitution during Word to PDF conversion. + wordDocument.FontSettings.SubstituteFont += new SubstituteFontEventHandler(SubstituteFont); + // Creates an instance of DocToPDFConverter. + DocToPDFConverter converter = new DocToPDFConverter(); + // Converts the Word document into PDF document. + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + // Closes the instance of Word document object. + wordDocument.Close(); + // Saves the PDF file. + pdfDocument.Save("WordtoPDF.pdf"); + // Closes the instance of PDF document object. + pdfDocument.Close(true); + + private void SubstituteFont(object sender, SubstituteFontEventArgs args) + { + // Sets the alternate font when a specified font is not installed in the production environment. + if (args.OrignalFontName == "Arial Unicode MS") + args.AlternateFontName = "Arial"; + else + args.AlternateFontName = "Times New Roman"; + } + + + ' Loads an existing Word document. + Dim wordDocument As New WordDocument("template.docx", FormatType.Docx) + ' Initializes the SubstituteFont event to perform font substitution during Word to PDF conversion. + AddHandler wordDocument.FontSettings.SubstituteFont, AddressOf SubstituteFont + ' Creates an instance of DocToPDFConverter. + Dim converter As New DocToPDFConverter() + ' Converts the Word document into PDF document. + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + ' Closes the instance of document object. + wordDocument.Close() + ' Saves the PDF file . + pdfDocument.Save("WordtoPDF.pdf") + ' Closes the instance of document object. + pdfDocument.Close(True) + + Private Sub SubstituteFont(ByVal sender As Object, ByVal args As SubstituteFontEventArgs) + ' Sets the alternate font when a specified font is not installed in the production environment. + If args.OrignalFontName = "Arial Unicode MS" Then + args.AlternateFontName = "Arial" + Else + args.AlternateFontName = "Times New Roman" + End If + End Sub + + + + + + Gets or sets the footnote separators of the document. + + The instance used to specify the footnote separator of this . + + + + + Gets or sets the endnote separators of the document. + + The instance used to specify the endnote separator of this . + + + + + Gets or sets the default tab stop position value measured in points. + + The width of the default tab. + + + + + Gets a collection that represents all the built-in document properties for the specified document. Read-only. + + + + + + + Gets a object that represents the attached template of the document. Read-only. + + Attached template of the document + + + + + Gets or sets a value indicating whether to automatically update styles of the document from the attached template each time the document is opened. Default value is false. + + True if the styles of the document are updated to from the attached template;otherwise, false. + + + + Gets a collection that represents all the custom document properties for the specified document. Read-only. + + + + + Gets a collection that represents all the sections in the document. Read-Only. + + A Sections collection represents all the in this + + + + + + Gets a collection that represents all the styles in the document. Read-Only. + + A collection represents all the in this + + + + + + + + Gets a collection that represents all the list styles in the document. Read-Only. + + All the in this . + + + + + + Gets a collection that represents all the bookmarks in the document. Read-Only. + + + + + + + + + Gets a collection that represents all the textboxes in the document. Read-Only. + + A collection represents all the in this . + + + + + + Gets a collection that represents all the comments in the document. Read-Only. + + + + + + + Gets the last of the document. Read-Only. + + The represents the last section of this + + The following code example demonstrates how to retrieve the last section of the document + + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Retrieve the last section of the document and add new paragraph + document.LastSection.AddParagraph().AppendText("Adding new paragraph to the document"); + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Retrieve the last section of the document and add new paragraph + document.LastSection.AddParagraph().AppendText("Adding new paragraph to the document") + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + + Gets the last of the document. Read-only. + + The represents the last paragraph of this + + The following code example demonstrates how to retrieve the last paragraph of the document + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Set the last paragraph back color as Blue + document.LastParagraph.ParagraphFormat.BackColor = Color.Blue; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Set the last paragraph back color as Blue + document.LastParagraph.ParagraphFormat.BackColor = Color.Blue + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + Gets or sets the numbering format for the endnotes in the document. + + The for the endnotes in the Word document + + The following code example demonstrates how to specify the endnote number format in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Set the endnote format + document.EndnoteNumberFormat = FootEndNoteNumberFormat.Arabic; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Set the endnote format + document.EndnoteNumberFormat = FootEndNoteNumberFormat.Arabic + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets the numbering format for the footnotes in the document. + + The for the footnotes in the Word document + + The following code example demonstrates how to specify the footnote number format in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Set the footnote number format + document.FootnoteNumberFormat = FootEndNoteNumberFormat.UpperCaseRoman; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Set the footnote number format + document.FootnoteNumberFormat = FootEndNoteNumberFormat.UpperCaseRoman + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets the restart index for the endnotes in the document. + + + The following code example demonstrates how to specify the endnote restart index number in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Set the endnote restart index number + document.RestartIndexForEndnote = EndnoteRestartIndex.RestartForEachSection; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Set the endnote restart index number + document.RestartIndexForEndnote = EndnoteRestartIndex.RestartForEachSection + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets endnotes position in the document. + + The for the endnotes in the document + + The following code example demonstrates how to specify the endnote position in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Set the endnote position at end of each section + document.EndnotePosition = EndnotePosition.DisplayEndOfSection; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Set the endnote position at end of each section + document.EndnotePosition = EndnotePosition.DisplayEndOfSection + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets the restart index for the footnotes in the document. + + + The following code example demonstrates how to specify the footnote restart index number in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Set the footnote restart index number + document.RestartIndexForFootnotes = FootnoteRestartIndex.RestartForEachPage; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Set the footnote restart index number + document.RestartIndexForFootnotes = FootnoteRestartIndex.RestartForEachPage + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets footnotes position in the document. + + The for the footnote in the document + + The following code example demonstrates how to specify the footnote position in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Set the footnote position at immediately beneath text + document.FootnotePosition = FootnotePosition.PrintImmediatelyBeneathText; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Set the footnote position at immediately beneath text + document.FootnotePosition = FootnotePosition.PrintImmediatelyBeneathText + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets a watermark for the document. + + A text/picture that appears behind the document + + + + + + + Gets the object that represents the background effects of the document. Read-only. + + The background effects of the document + + + + + Gets a object that represents the mail merge functionality of the document. Read-only. + + The instance used to replace the with value in the document + + + + + + Gets or sets the document protection type. + + The will prevent the document from unintentional editing. + + The following code example demonstrates how to protect the changing of document content. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //protect the document from editing + document.ProtectionType = Syncfusion.DocIO.ProtectionType.AllowOnlyReading; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'protect the document from editing + document.ProtectionType = Syncfusion.DocIO.ProtectionType.AllowOnlyReading + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets the document view type. + + A represents the display options of this in MS Word application + + + + Gets or sets a value indicating whether to throw exceptions for unsupported elements. The default is false. + + True then throw the exception for unsupported elements; otherwise, false. + + + + Gets or sets the initial footnote number of the document. + + + The following code example demonstrates how to specify the endnote number format in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Set the footnote initial number + document.InitialFootnoteNumber = 3; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Set the footnote initial number + document.InitialFootnoteNumber = 3 + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets the initial endnote number of the document. + + + The following code example demonstrates how to specify the endnote initial number in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Set the endnote initial number + document.InitialEndnoteNumber = 5; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Set the endnote initial number + document.InitialEndnoteNumber = 5 + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the collection that represents the child entities of this . Read-only. + + The child entities. + + + + Gets or sets the HTML validate option. + + + This property is not supported in Silverlight, Universal, Windows Phone, MVC6 and Xamarin application. + + + + + Gets or sets the background image of a document. + + + + + + Gets a collection that represents the variables stored in the document. Read-only. + + + Variables collection contains a Key-Value pair of variable name and its value + + + The following code snippet illustrate how to add a DocVariable field in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("First Name of the customer: "); + //Add the DocVariable field with Variable name and its type + paragraph.AppendField("FirstName", FieldType.FieldDocVariable); + paragraph = section.AddParagraph(); + paragraph.AppendText("Last Name of the customer: "); + //Add the DocVariable field with Variable name and its type + paragraph.AppendField("LastName", FieldType.FieldDocVariable); + //Add the value for variable in WordDocument.Variable collection + document.Variables.Add("FirstName", "Jeff"); + document.Variables.Add("LastName", "Smith"); + //Update the document fields + document.UpdateDocumentFields(); + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("First Name of the customer: ") + 'Add the DocVariable field with Variable name and its type + paragraph.AppendField("FirstName", FieldType.FieldDocVariable) + paragraph = section.AddParagraph() + paragraph.AppendText("Last Name of the customer: ") + 'Add the DocVariable field with Variable name and its type + paragraph.AppendField("LastName", FieldType.FieldDocVariable) + 'Add the value for variable in WordDocument.Variable collection + document.Variables.Add("FirstName", "Jeff") + document.Variables.Add("LastName", "Smith") + 'Update the document fields + document.UpdateDocumentFields() + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the document properties. Read-only. + + The instance used to specify the document version, form field shading and hyphenation properties of the document + + + + Gets a value indicating whether the document has tracked changes. Read-only. + + + True if the document has tracked changes; otherwise, false. + + + + + Gets or sets a value indicating whether edits are tracked as revision. The default is false. + + True if track changes in on; otherwise, false. + + The following code snippet shows how to track the edits as revisions in the document + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Enable the TrackChanges to track the edits as revision + document.TrackChanges = true; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Enable the TrackChanges to track the edits as revision + document.TrackChanges = True + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets a value indicating whether replace only the first occurrence. The default is false. + + True replace only the first occurrence in the document; false replace all the occurrence. + + The following code snippet illustrates how to replace the first occurrence of a particular text. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Set to replace only the first occurrence of a particular text + document.ReplaceFirst = true; + //Find the first occurrence of a particular text in the document + TextSelection selection = document.Find("contents", false, false); + //Initialize text body part + TextBodyPart bodyPart = new TextBodyPart(selection); + //Replace a particular text with the text body part + document.Replace("paragraph", bodyPart, false, true, true); + //Save and close the document + document.Save("Replace.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Set to replace only the first occurrence of a particular text + document.ReplaceFirst = True + 'Find the first occurrence of a particular text in the document + Dim selection As TextSelection = document.Find("contents", False, False) + 'Initialize text body part + Dim bodyPart As New TextBodyPart(selection) + 'Replace a particular text with the text body part + document.Replace("paragraph", bodyPart, False, True, True) + 'Save and close the document + document.Save("Replace.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets the HTML import settings for HTML to Word conversion. + + This property is not supported in MVC6. + + + + + + Gets the document save options. Read-only. + + A that represents the save options for this + + + + + Gets or sets a that represents the options to import the source document contents to the destination document. + Default value is UseDestinationStyles. + + This property will not be considered while executing ImportContent method and its overloads in class. + If invalid combination applied, then it will be skipped or auto corrected based on priority. + + + //Creates an new instance of WordDocument class. + WordDocument srcDocument = new WordDocument("SourceTemplate.docx"); + // Creates an new instance of WordDocument class. + WordDocument destDocument = new WordDocument("DestinationTemplate.docx"); + //Import the contents of source document at the end of destination document with destination styles. + destDocument.ImportOptions = ImportOptions.UseDestinationStyles; + destDocument.Sections.Add(srcDocument.LastSection.Clone()); + // Releases the resources occupied by WordDocument instance. + srcDocument.Close(); + // Saves the document in the given name and format. + destDocument.Save("Document.docx", FormatType.Docx); + // Releases the resources occupied by WordDocument instance. + destDocument.Close(); + + + 'Creates an new instance of WordDocument class. + Dim srcDocument As New WordDocument("SourceTemplate.docx") + ' Creates an new instance of WordDocument class. + Dim destDocument As New WordDocument("DestinationTemplate.docx") + 'Import the contents of source document at the end of destination document with destination styles. + destDocument.ImportOptions = ImportOptions.UseDestinationStyles + destDocument.Sections.Add(srcDocument.LastSection.Clone()) + ' Releases the resources occupied by WordDocument instance. + srcDocument.Close() + ' Saves the document in the given name and format. + destDocument.Save("Document.docx", FormatType.Docx) + ' Releases the resources occupied by WordDocument instance. + destDocument.Close() + + + + + This flag will be useful for importing styles behavior switching in the scenario of style exist in destination document with same name and type, but different formatting. + + Gets or sets a value indicating whether to import styles with new unique name, if style exist in destination document with same name, type and different formatting. Default value is true + + True: if import styles with same name, type and different formatting into destination document by renaming uniquely; otherwise, false. + + This property is used for defining styles import behavior in the scenario of style exist in destination document with same name and type, but different formatting. + Setting this property to true, styles with same name, type and different formatting will be imported into destination document from source document with new unique name. + Setting it to false, styles with same name, type and different formatting will not be imported and instead the document contents will use the existing matched (same name and type) style. + + + + // Creates an new instance of WordDocument class. + WordDocument srcDocument = new WordDocument(); + // Adds a section and a paragraph in the empty document. + srcDocument.EnsureMinimal(); + // Sets bold to character format of "Normal" style to differentiate source and destination document. + (srcDocument.Styles.FindByName("Normal") as WParagraphStyle).CharacterFormat.Bold = true; + // Creates an new instance of WordDocument class. + WordDocument destDocument = new WordDocument(); + // Adds a section and a paragraph in the empty document. + destDocument.EnsureMinimal(); + // Sets false value to exclude importing duplicate styles to destination document. + destDocument.ImportStyles = false; + destDocument.Sections.Add(srcDocument.LastSection.Clone()); + // Releases the resources occupied by WordDocument instance. + srcDocument.Close(); + // Saves the document in the given name and format. + destDocument.Save("Document.docx", FormatType.Docx); + // Releases the resources occupied by WordDocument instance. + destDocument.Close(); + + + ' Creates an new instance of WordDocument class. + Dim srcDocument As New WordDocument() + ' Adds a section and a paragraph in the empty document. + srcDocument.EnsureMinimal() + ' Sets bold to character format of "Normal" style to differentiate source and destination document. + TryCast(srcDocument.Styles.FindByName("Normal"), WParagraphStyle).CharacterFormat.Bold = True + ' Creates an new instance of WordDocument class. + Dim destDocument As New WordDocument() + ' Adds a section and a paragraph in the empty document. + destDocument.EnsureMinimal() + ' Sets false value to exclude importing duplicate styles to destination document. + destDocument.ImportStyles = False + destDocument.Sections.Add(srcDocument.LastSection.Clone()) + ' Releases the resources occupied by WordDocument instance. + srcDocument.Close() + ' Saves the document in the given name and format. + destDocument.Save("Document.docx", FormatType.Docx) + ' Releases the resources occupied by WordDocument instance. + destDocument.Close() + + + + + + Gets or sets a value indicating whether to import styles with new unique name, if style exist in destination document with same name and different type. Default value is false + + True: if import styles with same name and different type into destination document by renaming uniquely; otherwise, false. + + This property is used for defining styles import behavior in the scenario of style exist in destination document with same name, but different type. + Setting this property to true, styles with same name and different type will be imported into destination document from source document with new unique name. + Setting it to false, styles with same name and different typewill not be imported and instead the document contents will use default style. + + + + // Creates an new instance of WordDocument class. + WordDocument srcDocument = new WordDocument(); + // Adds a section and a paragraph in the empty document. + srcDocument.EnsureMinimal(); + // Creates a paragraph style (with name "Test") and adds into source document. + WParagraphStyle paragraphStyle = new WParagraphStyle(srcDocument); + paragraphStyle.Name = "Test"; + srcDocument.Styles.Add(paragraphStyle); + // Creates an new instance of WordDocument class. + WordDocument destDocument = new WordDocument(); + // Adds a section and a paragraph in the empty document. + destDocument.EnsureMinimal(); + // Creates a character style (with same paragraph styel name in source) and adds into destination document. + WCharacterStyle characterStyle = new WCharacterStyle(destDocument); + characterStyle.Name = "Test"; + destDocument.Styles.Add(characterStyle); + // Sets true value to include importing duplicate styles (mismatched with types) to destination document. + destDocument.ImportStylesOnTypeMismatch = true; + destDocument.Sections.Add(srcDocument.LastSection.Clone()); + // Releases the resources occupied by WordDocument instance. + srcDocument.Close(); + // Saves the document in the given name and format. + destDocument.Save("Document.docx", FormatType.Docx); + // Releases the resources occupied by WordDocument instance. + destDocument.Close(); + + + ' Creates an new instance of WordDocument class. + Dim srcDocument As New WordDocument() + ' Adds a section and a paragraph in the empty document. + srcDocument.EnsureMinimal() + ' Creates a paragraph style (with name "Test") and adds into source document. + Dim paragraphStyle As New WParagraphStyle(srcDocument) + paragraphStyle.Name = "Test" + srcDocument.Styles.Add(paragraphStyle) + ' Creates an new instance of WordDocument class. + Dim destDocument As New WordDocument() + ' Adds a section and a paragraph in the empty document. + destDocument.EnsureMinimal() + ' Creates a character style (with same paragraph styel name in source) and adds into destination document. + Dim characterStyle As New WCharacterStyle(destDocument) + characterStyle.Name = "Test" + destDocument.Styles.Add(characterStyle) + ' Sets true value to include importing duplicate styles (mismatched with types) to destination document. + destDocument.ImportStylesOnTypeMismatch = True + destDocument.Sections.Add(srcDocument.LastSection.Clone()) + ' Releases the resources occupied by WordDocument instance. + srcDocument.Close() + ' Saves the document in the given name and format. + destDocument.Save("Document.docx", FormatType.Docx) + ' Releases the resources occupied by WordDocument instance. + destDocument.Close() + + + + + + Gets or sets a value indicating whether to update fields in the document. + + if update fields, set to true. + + + + Gets the actual format type of the document which was loaded. While creating new document, it returns FormatType.Doc value. Read-only. + + The file format type of this + + + + Gets or sets a dictionary collections which represents the font substitution table. The key should be the font name and the value should be the alternate font name. + + The font substitution table contains an alternative font information for missing fonts in the document. + + The following code example demonstrates how to specify the alternative font information for missing fonts in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Apply the Arial font instead of the Arabic font, if the system does not contains Arabic font + document.FontSubstitutionTable.Add("Arabic", "Arial"); + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Apply the Arial font instead of the Arabic font, if the system does not contains Arabic font + document.FontSubstitutionTable.Add("Arabic", "Arial"); + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets a value indicating whether the document has macros. Read-only. + + + True if the document has macros; otherwise, false. + + + + + + Gets the revision options for the track changes in Word to PDF conversion. + + A that represents the save options for this + + The following code example demonstrates how to set the to preserve track changes in Word to PDF Conversion. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Sets revision types to preserve track changes in PDF conversion. + wordDocument.RevisionOptions.ShowMarkup = RevisionType.Insertions | RevisionType.Formatting | RevisionType.Deletions; + //Instantiation of DocToPDFConverter for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases all resources used by the object + converter.Dispose(); + //Closes the instance of document objects + wordDocument.Close(); + pdfDocument.Close(true); + + + 'Loads an existing Word document + Dim wordDocument As WordDocument = New WordDocument("Template.docx", FormatType.Docx) + 'Sets revision types to preserve track changes in PDF conversion. + wordDocument.RevisionOptions.ShowMarkup = RevisionType.Insertions Or RevisionType.Formatting Or RevisionType.Deletions + 'Instantiation of DocToPDFConverter for Word to PDF conversion + Dim converter As DocToPDFConverter = New DocToPDFConverter + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Releases all resources used by the object + converter.Dispose() + 'Closes the instance of document objects + wordDocument.Close() + pdfDocument.Close(True) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Collection of document sections + + + + + + Collection of document styles + + + + + + Collection of list styles + + + + + + Stores the sequence fields last values. + + + + + Collection of comments para id + + + + + + + + + + Collection of bookmarks + + + + + Collection of editable ranges. + + + + + Collection of fields + + + + + Collection of textboxes + + + + + Collection of revisions + + + + + Collection of meta properties + + + + + Collection of Comments. + + + + + Collection of Comments Extended + + + + + default value for DefaultTabWidth + + + + + default value for CharacterSpacingControl + + + + + + + + + + + + + + + Document's watermark; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Object which holds structured docx format objects with data stream. + + + + + + + + + + + + + + + + + + + + Field is used for FindNext functionality to define next + paragraph item. + + + + + + + + + + + + + + + Non parsed properties read from docx file. + + + + + + + + + + + + + + + paragraphs count in document + + + + + words count in document + + + + + characters count in document + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + To hold the font settings for the document. + + + + + To hold the hyphentation object for the document. + + + + + To hold the all floating items inside the document + + + + + This flag is used for identify what are all the supported elements triggered in the Document + + + + + Holds the Owner document of the alternate chunk document. + + + + + Holds the track changes balloon count value. + + + + + Index of the current section + + + + + Index of current body item in a section + + + + + Index of current paragraph item in a paragraph + + + + + Index of textrange where the text starts + + + Maintain para item index. Either it is textrange or any other paragraph items. If moving to next paragraph, then rest to 0 + + + + + Index of textrange where the text ends + + + Maintain para item index or matched end textrange index. Either it is textrange or any other paragraph items. If moving to next paragraph, then rest to 0 + + + + + Index where the current text starts i.e., start position in a textrange + + + Set as 0 if moving to next new para. For textrange only, set the value which denotes the start cut position in textrange index. + + + + + Index where the current text ends i.e., end position in a textrange + + + If the current item is matched textrange and it has match in half of the textrange means, then maintain that text end index. Otherwise always maintain as -1. + + + + + Sets the default values for the section formatting. + + + + + + Initializes a new instance of the class from the existing file. + + A string that contains the name of the file from which to create the . + This constructor is not supported in Silverlight, WinRT, Windows Phone, Universal, UNiversal Windows Platform and Xamarin platforms. + + + //Load an existing Word document into WordDocument instance + WordDocument document = new WordDocument("Sample.docx"); + //Add a new simple paragraph into the last section of the document + IWParagraph paragraph = document.LastSection.AddParagraph(); + //Add a text range into the paragraph + paragraph.AppendText("Hello World!"); + //Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx); + //Release the resources occupied by WordDocument instance + document.Close(); + + + 'Load an existing Word document into WordDocument instance + Dim document As New WordDocument("Sample.docx") + 'Add a new simple paragraph into the last section of the document + Dim paragraph As IWParagraph = document.LastSection.AddParagraph() + 'Add a text range into the paragraph + paragraph.AppendText("Hello World!") + 'Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx) + 'Release the resources occupied by WordDocument instance + document.Close() + + + + + + + + + Initializes a new instance of the class from the existing file, + which is protected with password. + + A string that contains the name of the file from which to create the . + The password used to decrypt the protected file. + This constructor is not supported in Silverlight, WinRT, Windows Phone, Universal, UNiversal Windows Platform, MVC6 and Xamarin platforms. + + + //Load an existing Word document into WordDocument instance + WordDocument document = new WordDocument("Sample.docx", "password"); + //Add a new simple paragraph into the last section of the document + IWParagraph paragraph = document.LastSection.AddParagraph(); + //Add a text range into the paragraph + paragraph.AppendText("Hello World!"); + //Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx); + //Release the resources occupied by WordDocument instance + document.Close(); + + + 'Load an existing Word document into WordDocument instance + Dim document As New WordDocument("Sample.docx", "password") + 'Add a new simple paragraph into the last section of the document + Dim paragraph As IWParagraph = document.LastSection.AddParagraph() + 'Add a text range into the paragraph + paragraph.AppendText("Hello World!") + 'Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx) + 'Release the resources occupied by WordDocument instance + document.Close() + + + + + + + + + Initializes a new instance of the class from the existing file of the specified file format type. + + A string that contains the name of the file from which to create the . + The file format type of this . + This constructor is not supported in Silverlight, WinRT, Windows Phone, Universal, UNiversal Windows Platform and Xamarin platforms. + + + //Load an existing Word document into WordDocument instance + WordDocument document = new WordDocument("Sample.docx", FormatType.Docx); + //Add a new simple paragraph into the last section of the document + IWParagraph paragraph = document.LastSection.AddParagraph(); + //Add a text range into the paragraph + paragraph.AppendText("Hello World!"); + //Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx); + //Release the resources occupied by WordDocument instance + document.Close(); + + + 'Load an existing Word document into WordDocument instance + Dim document As New WordDocument("Sample.docx", FormatType.Docx) + 'Add a new simple paragraph into the last section of the document + Dim paragraph As IWParagraph = document.LastSection.AddParagraph() + 'Add a text range into the paragraph + paragraph.AppendText("Hello World!") + 'Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx) + 'Release the resources occupied by WordDocument instance + document.Close() + + + + + + + + + Initializes a new instance of the class from the existing file of the specified file format type with XHTML validation type. + + A string that contains the name of the file from which to create the . + The file format type of this . + The XHTML validation type used to validate the HTML file, if the is . + This constructor is not supported in Silverlight, WinRT, Windows Phone, Universal, UNiversal Windows Platform, MVC6 and Xamarin platforms. + + + //Load an existing HTML file into WordDocument instance with Strict validation type + WordDocument document = new WordDocument("Sample.html", FormatType.Html, XHTMLValidationType.Strict); + //Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx); + //Release the resources occupied by WordDocument instance + document.Close(); + + + 'Load an existing HTML file into WordDocument instance with Strict validation type + Dim document As New WordDocument("Sample.html", FormatType.Html, XHTMLValidationType.[Strict]) + 'Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx) + 'Release the resources occupied by WordDocument instance + document.Close() + + + + + + + Initializes a new instance of the class from the + existing file of the specified file format type, which is protected with password. + + A string that contains the name of the file from which to create the . + The file format type of this . + The password used to decrypt the protected file. + This constructor is not supported in Silverlight, WinRT, Windows Phone, Universal, UNiversal Windows Platform, MVC6 and Xamarin platforms. + + + //Load an existing Word document into WordDocument instance + WordDocument document = new WordDocument("Sample.docx", FormatType.Docx, "password"); + //Add a new simple paragraph into the last section of the document + IWParagraph paragraph = document.LastSection.AddParagraph(); + //Add a text range into the paragraph + paragraph.AppendText("Hello World!"); + //Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx); + //Release the resources occupied by WordDocument instance + document.Close(); + + + 'Load an existing Word document into WordDocument instance + Dim document As New WordDocument("Sample.docx", FormatType.Docx, "password") + 'Add a new simple paragraph into the last section of the document + Dim paragraph As IWParagraph = document.LastSection.AddParagraph() + 'Add a text range into the paragraph + paragraph.AppendText("Hello World!") + 'Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx) + 'Release the resources occupied by WordDocument instance + document.Close() + + + + + + + + + Gets the File Type for the Given fileName. + + + + + + + Initializes a new instance of the class from the existing data stream of the specified file format type with XHTML validation type. + + A that contains the data for this . + The file format type of this . + The XHTML validation type used to validate the HTML file, if the is . + This constructor is not supported in Silverlight, WinRT, Windows Phone, Universal, UNiversal Windows Platform, MVC6 and Xamarin platforms. + + + Stream htmlFile = new FileStream("Sample.html", FileMode.Open, FileAccess.Read, FileShare.Read); + //Load an existing Stream into WordDocument instance with Strict validation type + WordDocument document = new WordDocument(htmlFile, FormatType.Html, XHTMLValidationType.Strict); + //Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx); + //Release the resources occupied by WordDocument instance + document.Close(); + + + Dim htmlFile As Stream = New FileStream("Sample.html", FileMode.Open, FileAccess.Read, FileShare.Read) + 'Load an existing Stream into WordDocument instance with Strict validation type + Dim document As New WordDocument(htmlFile, FormatType.Html, XHTMLValidationType.[Strict]) + 'Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx) + 'Release the resources occupied by WordDocument instance + document.Close() + + + + + + + Initializes a new instance of the class. + + + + //Create an instance of WordDocument class + WordDocument document = new WordDocument(); + //Add a new section into the Word document + IWSection section = document.AddSection(); + //Specify the page margins + section.PageSetup.Margins.All = 50f; + //Add a new simple paragraph into the section + IWParagraph paragraph = section.AddParagraph(); + //Add a text range into the paragraph + paragraph.AppendText("Hello World!"); + //Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx); + //Release the resources occupied by WordDocument instance + document.Close(); + + + 'Create an instance of WordDocument class + Dim document As New WordDocument() + 'Add a new section into the Word document + Dim section As IWSection = document.AddSection() + 'Specify the page margins + section.PageSetup.Margins.All = 50F + 'Add a new simple paragraph into the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add a text range into the paragraph + paragraph.AppendText("Hello World!") + 'Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx) + 'Release the resources occupied by WordDocument instance + document.Close() + + + + + + + + + + + Initializes a new instance of the class from the existing data stream. + + A that contains the data for this . + + + Stream fileStream = new FileStream("Sample.docx", FileMode.Open, FileAccess.Read, FileShare.Read); + //Load an existing Stream into WordDocument instance + WordDocument document = new WordDocument(fileStream); + //Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx); + //Release the resources occupied by WordDocument instance + document.Close(); + + + Dim fileStream As Stream = New FileStream("Sample.docx", FileMode.Open, FileAccess.Read, FileShare.Read) + 'Load an existing Stream into WordDocument instance + Dim document As New WordDocument(fileStream) + 'Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx) + 'Release the resources occupied by WordDocument instance + document.Close() + + + + + + Initializes a new instance of the class from the existing data stream of the specified file format type. + + A that contains the data for this . + The file format type of this . + + + Stream fileStream = new FileStream("Sample.docx", FileMode.Open, FileAccess.Read, FileShare.Read); + //Load an existing Stream into WordDocument instance + WordDocument document = new WordDocument(fileStream, FormatType.Docx); + //Add a new simple paragraph into the last section of the document + IWParagraph paragraph = document.LastSection.AddParagraph(); + //Add a text range into the paragraph + paragraph.AppendText("Hello World!"); + //Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx); + //Release the resources occupied by WordDocument instance + document.Close(); + + + Dim fileStream As Stream = New FileStream("Sample.docx", FileMode.Open, FileAccess.Read, FileShare.Read) + 'Load an existing Stream into WordDocument instance + Dim document As New WordDocument(fileStream, FormatType.Docx) + 'Add a new simple paragraph into the last section of the document + Dim paragraph As IWParagraph = document.LastSection.AddParagraph() + 'Add a text range into the paragraph + paragraph.AppendText("Hello World!") + 'Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx) + 'Release the resources occupied by WordDocument instance + document.Close() + + + + + + Initializes a new instance of the class from the existing data stream, + which is protected with password. + + A that contains the data for this . + The password used to decrypt the protected file. + This API is supported from .NET Framework 2.0 and .NET Standard 2.0 onwards. + + + Stream fileStream = new FileStream("Sample.docx", FileMode.Open, FileAccess.Read, FileShare.Read); + //Load an existing Stream into WordDocument instance + WordDocument document = new WordDocument(fileStream, "password"); + //Add a new simple paragraph into the last section of the document + IWParagraph paragraph = document.LastSection.AddParagraph(); + //Add a text range into the paragraph + paragraph.AppendText("Hello World!"); + //Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx); + //Release the resources occupied by WordDocument instance + document.Close(); + + + Dim fileStream As Stream = New FileStream("Sample.docx", FileMode.Open, FileAccess.Read, FileShare.Read) + 'Load an existing Stream into WordDocument instance + Dim document As New WordDocument(fileStream, "password") + 'Add a new simple paragraph into the last section of the document + Dim paragraph As IWParagraph = document.LastSection.AddParagraph() + 'Add a text range into the paragraph + paragraph.AppendText("Hello World!") + 'Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx) + 'Release the resources occupied by WordDocument instance + document.Close() + + + + + + Initializes a new instance of the class + from the existing data stream of the specified file format type, which is protected with password. + + A that contains the data for this . + The file format type of this . + The password used to decrypt the protected file. + This API is supported from .NET Framework 2.0 and .NET Standard 2.0 onwards. + + + Stream fileStream = new FileStream("Sample.docx", FileMode.Open, FileAccess.Read, FileShare.Read); + //Load an existing Stream into WordDocument instance + WordDocument document = new WordDocument(fileStream, FormatType.Docx, "password"); + //Add a new simple paragraph into the last section of the document + IWParagraph paragraph = document.LastSection.AddParagraph(); + //Add a text range into the paragraph + paragraph.AppendText("Hello World!"); + //Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx); + //Release the resources occupied by WordDocument instance + document.Close(); + + + Dim fileStream As Stream = New FileStream("Sample.docx", FileMode.Open, FileAccess.Read, FileShare.Read) + 'Load an existing Stream into WordDocument instance + Dim document As New WordDocument(fileStream, FormatType.Docx, "password") + 'Add a new simple paragraph into the last section of the document + Dim paragraph As IWParagraph = document.LastSection.AddParagraph() + 'Add a text range into the paragraph + paragraph.AppendText("Hello World!") + 'Save the document in the given name and format + document.Save("Document.docx", FormatType.Docx) + 'Release the resources occupied by WordDocument instance + document.Close() + + + + + + Initializes a new instance of the class from the existing WordDocument instance. + + The instance used to create this . + + + + Returns the format type based on the file extension of the given file name. + + + + + + + Creates a new paragraph. + + The this method created. + + + + Adds a single with one , when the document contains no sections. + + + The following code example demonstrates how to add new section with one paragraph to the empty Word document + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Creates a new Word document. + WordDocument document = new WordDocument(); + //Add a section and a paragraph in the empty document + document.EnsureMinimal(); + IWParagraph paragraph = document.LastParagraph; + //Append text to the last paragraph of the document + paragraph.AppendText("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua"); + //Save and close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Creates a new Word document. + Dim document As New WordDocument() + 'Add a section and a paragraph in the empty document + document.EnsureMinimal() + Dim paragraph As IWParagraph = document.LastParagraph + 'Append text to the last paragraph of the document + paragraph.AppendText("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua") + 'Save and close the Word document + document.Save("Comment.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Adds a new section to document. + + The this method creates. + + The following code example demonstrates how to add a new section to document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Append the text to the created paragraph + paragraph.AppendText("A new section is added to the document."); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Append the text to the created paragraph + paragraph.AppendText("A new section is added to the document.") + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Adds a new paragraph style to the document. + + A String that contains the name of the newly created + The this method creates. + + The following code example demonstrates how to create a custom paragraph style and apply it to a paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + + //Create user defined style + IWParagraphStyle style = document.AddParagraphStyle("User_defined_style"); + style.ParagraphFormat.BackColor = Color.LightGray; + style.ParagraphFormat.AfterSpacing = 18f; + style.ParagraphFormat.BeforeSpacing = 18f; + style.ParagraphFormat.Borders.BorderType = Syncfusion.DocIO.DLS.BorderStyle.DotDash; + style.ParagraphFormat.Borders.LineWidth = 0.5f; + style.ParagraphFormat.LineSpacing = 15f; + style.CharacterFormat.FontName = "Calibri"; + style.CharacterFormat.Italic = true; + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + IWTextRange text = paragraph.AppendText("A new paragraph style is created and is applied to this paragraph."); + //Apply the new style to paragraph + paragraph.ApplyStyle("User_defined_style"); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Create user defined style + Dim style As IWParagraphStyle = document.AddParagraphStyle("User_defined_style") + style.ParagraphFormat.BackColor = Color.LightGray + style.ParagraphFormat.AfterSpacing = 18.0F + style.ParagraphFormat.BeforeSpacing = 18.0F + style.ParagraphFormat.Borders.BorderType = Syncfusion.DocIO.DLS.BorderStyle.DotDash + style.ParagraphFormat.Borders.LineWidth = 0.5F + style.ParagraphFormat.LineSpacing = 15.0F + style.CharacterFormat.FontName = "Calibri" + style.CharacterFormat.Italic = True + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + Dim text As IWTextRange = paragraph.AppendText("A new paragraph style is created and is applied to this paragraph.") + 'Apply the new style to paragraph + paragraph.ApplyStyle("User_defined_style") + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + + + + + Adds new character style to document. + + A String that contains the name of the newly created + The newly created + + + + Adds new list style to document. + + The of the new created. + A String that contains the name of the newly added list style. + The this method creates. + + The following code example demonstrates how to how to create user defined list styles. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new list style to the document + ListStyle listStyle = document.AddListStyle(ListType.Numbered, "UserdefinedList"); + WListLevel levelOne = listStyle.Levels[0]; + //Define the follow character, prefix, suffix, start index for level 0 + levelOne.FollowCharacter = FollowCharacterType.Tab; + levelOne.NumberPrefix = "("; + levelOne.NumberSufix = ")"; + levelOne.PatternType = ListPatternType.LowRoman; + levelOne.StartAt = 1; + levelOne.TabSpaceAfter = 5; + levelOne.NumberAlignment = ListNumberAlignment.Center; + WListLevel levelTwo = listStyle.Levels[1]; + //Define the follow character, suffix, pattern, start index for level 1 + levelTwo.FollowCharacter = FollowCharacterType.Tab; + levelTwo.NumberSufix = "}"; + levelTwo.PatternType = ListPatternType.LowLetter; + levelTwo.StartAt = 2; + + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add text to the paragraph + paragraph.AppendText("User defined list - Level 0"); + //Apply default numbered list style + paragraph.ListFormat.ApplyStyle("UserdefinedList"); + //Add second paragraph + paragraph = section.AddParagraph(); + paragraph.AppendText("User defined list - Level 1"); + //Continue last defined list + paragraph.ListFormat.ContinueListNumbering(); + //Increase the level indent + paragraph.ListFormat.IncreaseIndentLevel(); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new list style to the document + Dim listStyle As ListStyle = document.AddListStyle(ListType.Numbered, "UserdefinedList") + Dim levelOne As WListLevel = listStyle.Levels(0) + 'Define the follow character, prefix, suffix, start index for level 0 + levelOne.FollowCharacter = FollowCharacterType.Tab + levelOne.NumberPrefix = "(" + levelOne.NumberSufix = ")" + levelOne.PatternType = ListPatternType.LowRoman + levelOne.StartAt = 1 + levelOne.TabSpaceAfter = 5 + levelOne.NumberAlignment = ListNumberAlignment.Center + Dim levelTwo As WListLevel = listStyle.Levels(1) + 'Define the follow character, suffix, pattern, start index for level 1 + levelTwo.FollowCharacter = FollowCharacterType.Tab + levelTwo.NumberSufix = "}" + levelTwo.PatternType = ListPatternType.LowLetter + levelTwo.StartAt = 2 + + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add text to the paragraph + paragraph.AppendText("User defined list - Level 0") + 'Apply default numbered list style + paragraph.ListFormat.ApplyStyle("UserdefinedList") + 'Add second paragraph + paragraph = section.AddParagraph() + paragraph.AppendText("User defined list - Level 1") + 'Continue last defined list + paragraph.ListFormat.ContinueListNumbering() + 'Increase the level indent + paragraph.ListFormat.IncreaseIndentLevel() + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + + + + + + Returns a string that contains whole document content as text. + + The text this document contains. + This method is not supported in Silverlight, Windows Phone and Xamarin platforms. + + The following code example demonstrates how to retrieve the Word document contents as a plain text. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx"); + //Get the document text and close the document + string text = document.GetText(); + document.Close(); + //Create new Word document + WordDocument newdocument = new WordDocument(); + //Add new section + IWSection section = newdocument.AddSection(); + //Add new paragraph + IWParagraph paragraph = section.AddParagraph(); + //Append the text to the paragraph + paragraph.AppendText(text); + //Save and close the document + newdocument.Save("Sample.docx"); + newdocument.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx") + 'Get the document text and close the document + Dim text As String = document.GetText() + document.Close() + 'Create new Word document + Dim newdocument As New WordDocument() + 'Add new section + Dim section As IWSection = newdocument.AddSection() + 'Add new paragraph + Dim paragraph As IWParagraph = section.AddParagraph() + 'Append the text to the paragraph + paragraph.AppendText(text) + 'Save and close the document + newdocument.Save("Sample.docx") + newdocument.Close() + End Sub + + + + + + Creates the duplicate copy of this instance. + + The this method duplicated. + + The following code example demonstrates how to clone the Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open an existing document + WordDocument inputTemplateDoc = new WordDocument("Template.docx"); + //Create a clone of Input Template + WordDocument clonedDocument = inputTemplateDoc.Clone(); + //Close the input template document instance + inputTemplateDoc.Close(); + //Save and Close the cloned document instance + clonedDocument.Save("ClonedDocument.docx"); + clonedDocument.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open an existing document + Dim inputTemplateDoc As New WordDocument(fileName) + 'Create a clone of Input Template + Dim clonedDocument As WordDocument = inputTemplateDoc.Clone() + 'Close the input template document instance + inputTemplateDoc.Close() + 'Save and Close the cloned document instance + clonedDocument.Save("ClonedDocument.docx") + clonedDocument.Close() + End Sub + + + + + + Imports the specified section into the current document. + + The source whose contents are appended at the end of the current instance. + + The following code example demonstrates how to import the section into the Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open the source document + WordDocument sourceDocument = new WordDocument("sourceFileName.docx"); + //Open the destination document + WordDocument destinationDocument = new WordDocument("targetFileName.docx"); + //Import the last section of source document at the end of destination document + destinationDocument.ImportSection(sourceDocument.LastSection); + //Close the document instance + sourceDocument.Close(); + //Save the destination document + destinationDocument.Save("outputFileName.docx", FormatType.Docx); + //Close the document instance + destinationDocument.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open the source document + Dim sourceDocument As New WordDocument(sourceFileName) + 'Open the destination document + Dim destinationDocument As New WordDocument(targetFileName) + 'Import the last section of source document at the end of destination document + destinationDocument.ImportSection(sourceDocument.LastSection) + 'Close the document instance + sourceDocument.Close() + 'Save the destination document + destinationDocument.Save(outputFileName, FormatType.Docx) + 'Close the document instance + destinationDocument.Close() + End Sub + + + + + + Import contents and styles from the source document to the destination document. + + The source whose contents are appended at the end of the current instance. + When source and destination documents have styles with the same names, then Guid is added as a suffix to the name of the imported styles in the destination document. Due to the above duplication of the same style will increase the file size of the document and also it may lead to Out of memory exception if the machine has some limited amount memory. + To resolve the duplication of the same style from source to destination document, use ImportContent(IWordDocument doc, bool importStyles) methods with false value for "importStyle" parameter. + + The following code example demonstrates how to import the contents from source document into destination document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open the source document + WordDocument sourceDocument = new WordDocument("sourceFileName.docx"); + //Open the destination document + WordDocument destinationDocument = new WordDocument("targetFileName.docx"); + //Import the contents of source document at the end of destination document + destinationDocument.ImportContent(sourceDocument); + //Close the document instance + sourceDocument.Close(); + //Save the destination document + destinationDocument.Save("outputFileName.docx", FormatType.Docx); + //Close the document instance + destinationDocument.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open the source document + Dim sourceDocument As New WordDocument(sourceFileName) + 'Open the destination document + Dim destinationDocument As New WordDocument(targetFileName) + 'Import the contents of source document at the end of destination document + destinationDocument.ImportContent(sourceDocument) + 'Close the document instance + sourceDocument.Close() + 'Save the destination document + destinationDocument.Save(outputFileName, FormatType.Docx) + 'Close the document instance + destinationDocument.Close() + End Sub + + + + + + Import contents from the source document to the destination document with various import options. + + The source whose contents are appended at the end of the current instance. + The that represents the options to import the source document contents to the destination document. + + Essential DocIO supports the importing contents from the source document to the destination document with various import options similar to Microsoft Word copy and paste options. Following are the import options supported by Essential DocIO. + + KeepSourceFormatting - Imports the contents from the source document, applies the default style (Normal), and preserves all other formatting as direct formatting in order to preserve the contents as in source document. Header and footer contents will be imported similar to the UseDestinationStyles option. + MergeFormatting - Imports the contents of the source document to the destination document, and applies the formatting of surrounding content to the destination document. Merges formatting of the contents surrounding it by preserving some of the source formatting (such as bold, italic, underline, and so on). Header and footer contents are imported similar to the UseDestinationStyles option. + KeepTextOnly - Imports only the text from the source document to the destination document (tables, textboxes, pictures, headers, footers, and so on, are removed), similar to content copied from a text file (.txt). + UseDestinationStyles - Imports the contents of the source document to the destination document, and applies the styles present in the destination document, or imports the source style to the destination document when there is no style with the same name in the destination document. + + + + The following code example demonstrates how to import the contents from source document into destination document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open the source document + WordDocument sourceDocument = new WordDocument("sourceFileName.docx"); + //Open the destination document + WordDocument destinationDocument = new WordDocument("targetFileName.docx"); + //Import the contents of source document at the end of destination document + destinationDocument.ImportContent(sourceDocument, ImportOptions.UseDestinationStyles); + //Close the document instance + sourceDocument.Close(); + //Save the destination document + destinationDocument.Save("outputFileName.docx", FormatType.Docx); + //Close the document instance + destinationDocument.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open the source document + Dim sourceDocument As New WordDocument(sourceFileName) + 'Open the destination document + Dim destinationDocument As New WordDocument(targetFileName) + 'Import the contents of source document at the end of destination document + destinationDocument.ImportContent(sourceDocument, ImportOptions.UseDestinationStyles) + 'Close the document instance + sourceDocument.Close() + 'Save the destination document + destinationDocument.Save(outputFileName, FormatType.Docx) + 'Close the document instance + destinationDocument.Close() + End Sub + + + + + + Imports the document text. + + The doc. + + + + Import contents from the source document to the destination document by specifying whether to import styles that have the same name between the source and destination document. + + The source whose contents are appended at the end of the current instance. + Set to true to import all the styles from the source document to destination document; otherwise, false. + + When importStyles is set to false, all the contents are imported; but, the styles of the source document with style names that do not match with the styles in the destination document are not imported. When the style names match the destination style names, then the same name is applied to the imported contents. This behavior is similar to the Microsoft Word paste option - UseDestinationStyles. + When importStyles is set to true, all the contents and styles of the source document are imported to the destination document. In cases where a style in the source document has the same name as a style in the destination document, "Guid" is added as a suffix to the name of the imported style in order to preserve unique style name. Due to the above duplication of the same style will increase the file size of the document and also it may lead to Out of memory exception if the machine has some limited amount memory. + + + The following code example demonstrates how to import the contents from source document into destination document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open the source document + WordDocument sourceDocument = new WordDocument("sourceFileName.docx"); + //Open the destination document + WordDocument destinationDocument = new WordDocument("targetFileName.docx"); + //Import the contents of source document at the end of destination document + destinationDocument.ImportContent(sourceDocument, true); + //Close the document instance + sourceDocument.Close(); + //Save the destination document + destinationDocument.Save("outputFileName.docx", FormatType.Docx); + //Close the document instance + destinationDocument.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open the source document + Dim sourceDocument As New WordDocument(sourceFileName) + 'Open the destination document + Dim destinationDocument As New WordDocument(targetFileName) + 'Import the contents of source document at the end of destination document + destinationDocument.ImportContent(sourceDocument, true) + 'Close the document instance + sourceDocument.Close() + 'Save the destination document + destinationDocument.Save(outputFileName, FormatType.Docx) + 'Close the document instance + destinationDocument.Close() + End Sub + + + + + + Adds the built-in style to the collection. + + The that represents the added built-in style of the document. + The this method added to collection. + + The following code example demonstrates how to add the built-in style to the document + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Add the built-in style to the document style collection + IStyle style = document.AddStyle(BuiltinStyle.Heading5); + //Apply the added built-in style to the last paragraph of the document + document.LastParagraph.ApplyStyle(style.Name); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Add the built-in style to the document style collection + Dim style As IStyle = document.AddStyle(BuiltinStyle.Heading5) + 'Apply the added built-in style to the last paragraph of the document + document.LastParagraph.ApplyStyle(style.Name) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Get the built in table style. + + + + + + + Checks the table normal style. + + + + + Updates the next style for paragraph build-in style. + + The paragraph build-in style. + + + + Accepts changes tracked from the moment of last change acceptance. + + + The following code example demonstrates how to accept the tracked changes in the document + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Check whether document has tracked changes + if (document.HasChanges) + //Accept the changes made to the document + document.AcceptChanges(); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Check whether document has tracked changes + If document.HasChanges Then + 'Accept the changes made to the document + document.AcceptChanges() + End If + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Rejects changes tracked from the moment of last change acceptance. + + + The following code example demonstrates how to reject the tracked changes in the document + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Check whether document has tracked changes + if (document.HasChanges) + //Reject the changes made to the document + document.RejectChanges(); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Check whether document has tracked changes + If document.HasChanges Then + 'Reject the changes made to the document + document.RejectChanges() + End If + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Protects the document from unintentional editing. + + The type of protection to be applied. + + The following code example demonstrates how to protect the document from unintentional editing. + This method is not supported in MVC6 and Xamarin platforms. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Apply the protection to the document + document.Protect(ProtectionType.AllowOnlyComments); + //Save and close the document instances + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Apply the protection to the document + document.Protect(ProtectionType.AllowOnlyComments) + 'Save and close the document instances + document.Save("Sample.docx") + document.Close() + End Sub + + + + + + Protects the document from unintentional editing with secure password. + + The type of protection to be applied. + The password used for protection. + This method is not supported in MVC6 and Xamarin platforms. + + The following code example demonstrates how to protect the document from unintentional editing. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx", "password"); + //Apply the protection to the document + document.Protect(ProtectionType.AllowOnlyComments); + //Save and close the document instances + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Apply the protection to the document + document.Protect(ProtectionType.AllowOnlyComments, "password") + 'Save and close the document instances + document.Save("Sample.docx") + document.Close() + End Sub + + + + + + Resets the attributes of documentProtection to default values + + + + + Protects the document with password from unauthorized access. + + A String used to encrypt the document. + This API is supported from .NET Framework 2.0 and .NET Standard 2.0 onwards. + + The following code example demonstrates how to encrypt the Word document with password. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open an input Word document + WordDocument document = new WordDocument("Template.docx"); + //Encrypt the Word document with a password + document.EncryptDocument("password"); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open an input Word document + Dim document As New WordDocument("Template.docx") + 'Encrypt the Word document with a password + document.EncryptDocument("password") + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Removes the encryption from the document. + + This API is supported from .NET Framework 2.0 and .NET Standard 2.0 onwards. + + The following code example demonstrates how to remove encrypt from the Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open an input Word document + WordDocument document = new WordDocument("Template.docx"); + //Remove the encryption from document + document.RemoveEncryption(); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open an input Word document + Dim document As New WordDocument("Template.docx") + 'Remove the encryption from document + document.RemoveEncryption(); + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Adds new style to document. + + Style type + Style name + + + + + Checks the normal style. + + + + + Gets the list/array of items that can be cross-referenced based on the specified reference type. + + + Specifies the type of item you want to insert a cross-reference to. + + The collection that represents the cross reference items in the document. + + + This method returns the cross reference of Bookmarks items only. + + + For bookmarks, it returns the entity collections of BookmarkStart only if the bookmark contains proper start and end. + + + + The following code example demonstrates how to append cross reference for bookmark in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Get the collection of bookmark start in the word document + List< Entity > items = document.GetCrossReferenceItems(ReferenceType.Bookmark); + if (items.Count > 0) + //Change the first cross reference items owner paragraph back color as YelloGreen + (items[0] as BookmarkStart).OwnerParagraph.ParagraphFormat.BackColor = Color.YellowGreen; + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Get the collection of bookmark start in the word document + Dim items As List(Of Entity) = document.GetCrossReferenceItems(ReferenceType.Bookmark) + If items.Count > 0 Then + 'Change the first cross reference items owner paragraph back color as YelloGreen + TryCast(items(0), BookmarkStart).OwnerParagraph.ParagraphFormat.BackColor = Color.YellowGreen + End If + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the bookmarks. + + + + + + Opens the Word Docx document + + The stream contains the document content + + + + Opens the Word XML document + + Name of the file + + + + Opens the Word XML document + + The stream contains the document content + + + + Opens the document from XML format file. + + The name of file + + + + Opens the XML document from stream. + + The stream object + + + + Display any warnings or errors. + + + + + + + Saves the document in XML format. + + The name of target file + + + + Saves the document in XML format. + + The target stream + + + + Saves the document in text format. + + The name of target file + + + + Saves this as text file(.txt) with specified encoding. + + A string that contains the name of the file to save. + The character encoding to use. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, UNiversal Windows Platform and Xamarin platforms. + + The following code example demonstrates how to convert the Word document into text file. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Save the document as Text file + document.SaveTxt("sample.txt", Encoding.ASCII); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Save the document as Text file + document.SaveTxt("sample.txt", Encoding.ASCII) + 'Close the document + document.Close() + End Sub + + + + + + Saves the document in EPub format. + + + + + + Saves the document as EPub stream + + + + + + Saves the document in open XML format (Docx). + + + + + + Saves the document in Word ML format (WordML). + + file name to save + + + + Saves the document in open XML format (Odt). + + + + + + Saves the document in open XML format (Docx). + + + + + + Saves the document in open XML format (Odt). + + + + + + Saves the document in Word ML format (WordML). + + stream to save + + + + Saves the RTF. + + The stream. + + + + Gets the RTF text. + + + + + + Saves the document in text format. + + The name of target file + + + + Saves the document in markdown text format. + + The name of target file + + + + Saves this as text (.txt) in Stream with specified encoding. + + A to save this . + The character encoding to use. + + The following code example demonstrates how to convert the Word document into text file. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + MemoryStream stream = new MemoryStream(); + //Save the document as Text file + document.SaveTxt(stream, Encoding.ASCII); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + Dim stream As New MemoryStream() + 'Save the document as Text file + document.SaveTxt(stream, Encoding.ASCII) + 'Close the document + document.Close() + End Sub + + + + + + Opens the document in text format. + + The name of target file + + + + Opens the document in markdown format. + + The name of target file + + + + Opens the text. + + The text. + + + + Opens the document in HTML format + + The file stream + XHTML validation type. + + + + Opens doc file. + + + + + + Opens an existing document. + + A string that contains the name of the file to open + + The following code example demonstrates how to open an existing document from file system. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, UNiversal Windows Platform and Xamarin platforms. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.Open("Template.docx"); + //Saves the specified document + document.Save("Sample.docx"); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.Open("Template.docx") + 'Saves the specified document + document.Save("Sample.docx") + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Opens an existing document of the specified file format type. + + A string that contains the name of the file to open. + The file format type of the document to open. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, UNiversal Windows Platform and Xamarin platforms. + + The following code example demonstrates how to open an existing document of the specified type from file system. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.Open("Template.docx", FormatType.Docx); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.Open("Template.docx", FormatType.Docx) + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Opens an existing document of the specified file format type with HTML file validation options and base path for relative path to absolute path conversion. + + A string that contains the name of the file to open. + The file format type of the document to open. + The XHTML validation type used to validate the HTML file, if the is . + Base path which is used to convert the relative path in the HTML file to absolute path. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, UNiversal Windows Platform, MVC6 and Xamarin platforms. + + The following code example demonstrates how to open a protected document of the specified type from file system. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.Open("Template.docx", FormatType.Docx, XHTMLValidationType.Strict, "basePath"); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.Open("Template.docx", FormatType.Docx, "password", XHTMLValidationType.Strict, basePath) + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Opens an existing document of the specified file format type with HTML file validation options. + + A string that contains the name of the file to open. + The file format type of the document to open. + The XHTML validation type used to validate the HTML file, if the is . + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, UNiversal Windows Platform, MVC6 and Xamarin platforms. + + The following code example demonstrates how to open a protected document of the specified type from file system. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.Open("Template.docx", FormatType.Docx, XHTMLValidationType.Strict); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.Open("Template.docx", FormatType.Docx, "password", XHTMLValidationType.Strict) + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Opens the HTML document from file. + + Name of the file. + Type of the format. + Type of the validation. + + + + Opens an existing document of the specified file format type, which is protected with password. + + A string that contains the name of the file to open. + The file format type of the document to open. + The password used to decrypt the protected file. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, UNiversal Windows Platform, MVC6 and Xamarin platforms. + + The following code example demonstrates how to open a protected document of the specified type from file system. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.Open("Template.docx", FormatType.Docx, "password"); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.Open("Template.docx", FormatType.Docx, "password") + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Opens the document from file in XML or Microsoft Word format. + + Name of the file. + Type of the format. + The password. + + + + Updates the type of the format. + + Name of the file. + Type of the format. + + + + Opens an existing document of the specified file format type in read-only mode. + + A string that contains the name of the file to open. + The file format type of the document to open. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, UNiversal Windows Platform and Xamarin platforms. + + + + Opens an existing document of the specified file format type, which is protected with password in read-only mode. + + A string that contains the name of the file to open. + The file format type of the document to open. + The password used to decrypt the protected file. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + fileName is null. + password is null. + + The following code example demonstrates how to open a protected document of the specified type from file system in read-only mode. + + //Create a new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.OpenReadOnly("Template.docx", FormatType.Docx, "password"); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + + + 'Create a new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.OpenReadOnly("Template.docx", FormatType.Docx, "password") + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + + + + + + Opens an existing document of the specified file format type with HTML file validation options in read-only mode. + + A string that contains the name of the file to open. + The file format type of the document to open. + The XHTML validation type used to validate the HTML file, if the is . + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + fileName is null. + + The following code example demonstrates how to open an existing document of the specified type from file system with XHTML validation options in read-only mode. + + //Create a new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.OpenReadOnly("Template.docx", FormatType.Docx, XHTMLValidationType.Strict); + //Saves the specified document + document.Save("Sample.Docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + + + 'Create a new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.OpenReadOnly("Template.docx", FormatType.Docx, XHTMLValidationType.Strict) + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + + + + + + Opens an existing document of the specified file format type with HTML file validation options and base path for relative path to absolute path conversion in read-only mode. + + A string that contains the name of the file to open. + The file format type of the document to open. + The XHTML validation type used to validate the HTML file, if the is . + Base path which is used to convert the relative path in the HTML file to absolute path. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + fileName is null. + baseUrl is null. + + The following code example demonstrates how to open an existing document of the specified type from file system with XHTML validation options in read-only mode. + + //Create a new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.OpenReadOnly("Template.docx", FormatType.Docx, XHTMLValidationType.Strict, "basePath"); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + + + 'Create a new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.OpenReadOnly("Template.docx", FormatType.Docx, XHTMLValidationType.Strict, basePath) + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + + + + + + Saves this to the specified file. + + A string that contains the name of the document to save. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, UNiversal Windows Platform and Xamarin platforms. + + The following code example demonstrates how to open an existing document from file system. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.Open("Template.docx"); + //Saves the specified document + document.Save("Sample.docx"); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.Open("Template.docx") + 'Saves the specified document + document.Save("Sample.docx") + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Saves this to the specified file in the specified format. + + A string that contains the name of the document to save. + The format in which the document is saved. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, UNiversal Windows Platform and Xamarin platforms. + + The following code example demonstrates how to open an existing document from file system. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.Open("Template.docx"); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.Open("Template.docx") + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + End Sub + + + If the file name extension mismatches the FormatType parameter specified for saving the document, + then the file will be saved in the format specified by FormatType parameter and wrong extension as specified by file name parameter. + If the FormatType is specified as Automatic, then the document will be saved in the format specified by file name extension + + + + Saves the document into file in specified format type. + + The FileName. + The FormatType. + + + + Saves the document in markdown format. + + + + + + Saves document in Markdown format. + + A string that contains the name of the file to save. + The character encoding to use. + + + + Saves this as EPUB. + + A string that contains the name of the file to save. + The cover page image of the EPUB. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, UNiversal Windows Platform, MVC6 and Xamarin platforms. + + The following code example demonstrates how to convert the Word document to EPub file. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + MemoryStream stream = new MemoryStream(); + //Create the new WPicture for cover page image + WPicture coverImage = new WPicture(document); + coverImage.LoadImage(Image.FromFile("CoverImage.png")); + //Save the document as EPUB + document.SaveAsEpub("sample.epub", coverImage); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + Dim stream As New MemoryStream() + 'Create the new WPicture for cover page image + Dim coverImage As New WPicture(document) + coverImage.LoadImage(Image.FromFile("CoverImage.png")) + 'Save the document as EPUB + document.SaveAsEpub("sample.epub", coverImage) + 'Close the document + document.Close() + End Sub + + + + + + Saves the document as Doc format. + + Name of the file. + + + + Saves this to the specified file in the specified format. + + A string that contains the name of the document to save. + The format in which the document is saved. + The HTTP response information. + Specifies options to stream content to browser. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, UNiversal Windows Platform, MVC6 and Xamarin platforms. + + The following code example demonstrates how to open an existing document from file system. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + //Open an existing document from file system + document.Open("Template.docx"); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx,HttpContext.Current.Response, HttpContentDisposition.Attachment); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + 'Open an existing document from file system + document.Open("Template.docx") + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx, Response, HttpContentDisposition.Attachment) + 'Close the WordDocument instance + document.Close() + End Sub + + + If the file name extension mismatches the FormatType parameter specified for saving the document, + then the file will be saved in the format specified by FormatType parameter and wrong extension as specified by file name parameter. + If the FormatType is specified as Automatic, then the document will be saved in the format specified by file name extension + + + + Saves the specified file name. + + The FileName. + The FormatType. + The response. + The content disposition. + + + + Saves this as EPUB. + + A string that contains the name of the file to save. + The cover page image of the EPUB. + The HTTP response information. + Specifies options to stream content to browser. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, UNiversal Windows Platform, MVC6 and Xamarin platforms. + + The following code example demonstrates how to + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + MemoryStream stream = new MemoryStream(); + //Create the new WPicture for cover page image + WPicture coverImage = new WPicture(document); + coverImage.LoadImage(Image.FromFile("CoverImage.png")); + //Save the document as EPUB + document.SaveAsEpub("sample.epub", coverImage, HttpContext.Current.Response, HttpContentDisposition.Attachment); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + Dim stream As New MemoryStream() + 'Create the new WPicture for cover page image + Dim coverImage As New WPicture(document) + coverImage.LoadImage(Image.FromFile("CoverImage.png")) + 'Save the document as EPUB + document.SaveAsEpub("sample.epub", coverImage, Response, HttpContentDisposition.Attachment) + 'Close the document + document.Close() + End Sub + + + + + + Saves the dot. + + Name of the file. + + + + Saves the document in RTF format. + + Name of the file. + + + + Opens an existing document of the specified file format type from the data stream with HTML file validation options and base path for relative path to absolute path conversion. + + A that contains the data for this . + The file format type of the document to open. + The XHTML validation type used to validate the html file, if the is . + Base path which is used to convert the relative path in the HTML file to absolute path. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, UNiversal Windows Platform, MVC6 and Xamarin platforms. + + The following code example demonstrates how to open an existing document of the specified type from data stream with XHTML validation options. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + Stream fileStream = new FileStream("Sample.html", FileMode.Open, FileAccess.Read, FileShare.Read); + //Open an existing document from file system + document.Open(fileStream, FormatType.Docx, XHTMLValidationType.Strict, "basepath"); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + Dim fileStream As Stream = New FileStream("Sample.html", FileMode.Open, FileAccess.Read, FileShare.Read) + 'Open an existing document from file system + document.Open(fileStream, FormatType.Docx, XHTMLValidationType.Strict, basepath) + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Opens an existing document of the specified file format type from the data stream with HTML validation options. + + A that contains the data for this . + The file format type of the document to open. + The XHTML validation type used to validate the HTML file, if the is . + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, UNiversal Windows Platform, MVC6 and Xamarin platforms. + + The following code example demonstrates how to open an existing document of the specified type from data stream with XHTML validation options. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + Stream fileStream = new FileStream("Sample.html", FileMode.Open, FileAccess.Read, FileShare.Read); + //Open an existing document from file system + document.Open(fileStream, FormatType.Docx, XHTMLValidationType.Strict); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + Dim fileStream As Stream = New FileStream("Sample.html", FileMode.Open, FileAccess.Read, FileShare.Read) + 'Open an existing document from file system + document.Open(fileStream, FormatType.Docx, XHTMLValidationType.Strict) + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Opens the HTML document from stream. + + The stream. + Type of the format. + Type of the validation. + + + + Opens an existing document of the specified file format type from the data stream. + + A that contains the data for this . + The file format type of the document to open. + + The following code example demonstrates how to open an existing document of the specified type from data stream. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + Stream fileStream = new FileStream("Sample.docx", FileMode.Open, FileAccess.Read, FileShare.Read); + //Open an existing document from file system + document.Open(fileStream, FormatType.Docx); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + Dim fileStream As Stream = New FileStream("Sample.docx", FileMode.Open, FileAccess.Read, FileShare.Read) + 'Open an existing document from file system + document.Open(fileStream, FormatType.Docx) + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Opens an existing document of the specified file format type from the data stream, which is protected with password. + + A that contains the data for this . + The file format type of the document to open. + The password used to decrypt the document. + This API is supported from .NET Framework 2.0 and .NET Standard 2.0 onwards. + + The following code example demonstrates how to open a protected document of the specified type from data stream. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an new instance of WordDocument class + WordDocument document = new WordDocument(); + Stream fileStream = new FileStream("Sample.docx", FileMode.Open, FileAccess.Read, FileShare.Read); + //Open an existing document from file system + document.Open(fileStream, FormatType.Docx, "password"); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an new instance of WordDocument class + Dim document As New WordDocument() + Dim fileStream As Stream = New FileStream("Sample.docx", FileMode.Open, FileAccess.Read, FileShare.Read) + 'Open an existing document from file system + document.Open(fileStream, FormatType.Docx, "password") + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + End Sub + + + + + + Opens the document from stream. + + The Stream. + The FormatType. + The Password. + + + + Open an Rtf file + + + + + Opens the RTF. + + The RTF text. + + + + Updates the type of the format. + + The stream. + Type of the format. + + + + Saves this to the specified stream in the specified file format type. + + The Stream where the document will be saved. + The format in which the document is saved. + + The following code example demonstrates how to save the document to MemoryStream + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + MemoryStream stream = new MemoryStream(); + //Save the document to stream + document.Save(stream, FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + Dim stream As New MemoryStream() + 'Save the document to stream + document.Save(stream, FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Get the roman value for the number + + + + + + + Gets the chinese expression for a number within ten thousand + + + + + + + Gets the chinese expression of a number + + + + + + + To Get alphabet letter + + + + + + + Gets the Spanish cardinal text string. + + if set to true [cardinal string]. + The text. + + + + + Gets the card text string. + + if set to true [cardinal string]. + The text. + + + + + Gets the ord text string. + + if set to true [ordinal string]. + The text. + + + + + Gets the Spanish ordinal text string. + + if set to true [ordinal string]. + The text. + + + + + Numbers to Spanish words. + + The number. + if set to true [is card text]. + + + + + Numbers to words. + + The number. + if set to true [is card text]. + + + + + Saves the document into stream in specified format type. + + The Stream. + The FormatType. + + + + Get's Ordinal List Value + + + + + + + Get's Ordinal in Swedish + + + + + + + Get's Ordinal in Catalan + + + + + + + Get's Ordinal in Danish + + + + + + + Get's Ordinal in English (Default) + + + + + + + Release the resources occupied by this instance. + + + + + Releases all resources used by the object. + + + + + Compares the array. + + The buffer1. + The buffer2. + + + + + + + + + + Closes the content of the sections. + + + + + Closes the styles. + + + + + Converts the whole document into an images. + + An ImageType that specifies the type of the image to render. + Return the array of images that contains the each document page as single image. + + + Layouting the contents of a Word document as pages in the Essential DocIO is not exactly the same as the layouting in Microsoft Word. So, the total number of pages and each page content may vary slightly compared to that of the Microsoft Word. + + + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + is not supported when running in Azure environment, only is available. So, is used instead of automatically when rendering in Azure environment. + + + + The following code example demonstrates how to convert the Word document to image. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Initialize ChartToImageConverter for converting charts during Word to image conversion + wordDocument.ChartToImageConverter = new ChartToImageConverter(); + //Set the scaling mode for charts (Normal mode reduces the file size) + wordDocument.ChartToImageConverter.ScalingMode = ScalingMode.Normal; + //Convert word document to image + Image[] images = wordDocument.RenderAsImages(ImageType.Bitmap); + //Close the document + wordDocument.Close(); + int i = 0; + foreach (Image image in images) + { + //Save the images as jpeg + image.Save("WordToImage_" + i + ".jpeg", ImageFormat.Jpeg); + i++; + } + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim wordDocument As New WordDocument("Template.docx", FormatType.Docx) + 'Initialize ChartToImageConverter for converting charts during Word to image conversion + wordDocument.ChartToImageConverter = New ChartToImageConverter() + 'Set the scaling mode for charts (Normal mode reduces the file size) + wordDocument.ChartToImageConverter.ScalingMode = ScalingMode.Normal + 'Convert word document to image + Dim images As Image() = wordDocument.RenderAsImages(ImageType.Bitmap) + 'Close the document + wordDocument.Close() + Dim i As Integer = 0 + For Each image As Image In images + 'Save the images as jpeg + image.Save("WordToImage_" & i & ".jpeg", ImageFormat.Jpeg) + i += 1 + Next + End Sub + + + + + + + Converts the specified document page into image. + + + The zero based page index that represent which page to convert. + + + An ImageFormat that specifies the format of the saved image. + + + An that represent specified document page as image. + + + + Layouting the contents of a Word document as pages in the Essential DocIO is not exactly the same as the layouting in Microsoft Word. So, the total number of pages may vary slightly compared to that of the Microsoft Word. + + + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + is not supported when running in Azure environment, only is available. So, is used instead of automatically when rendering in Azure environment. + + + + The following code example demonstrates how to convert the Word document to image. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Initialize ChartToImageConverter for converting charts during Word to image conversion + wordDocument.ChartToImageConverter = new ChartToImageConverter(); + //Set the scaling mode for charts (Normal mode reduces the file size) + wordDocument.ChartToImageConverter.ScalingMode = ScalingMode.Normal; + //Convert word document to stream + Stream imageStream = wordDocument.RenderAsImages(2, System.Drawing.Imaging.ImageFormat.Bmp); + //Close the document + wordDocument.Close(); + //Convert the stream to Image + Image image = Image.FromStream(imageStream); + //Save the image as jpeg + image.Save("WordToImage.jpeg", ImageFormat.Jpeg); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim wordDocument As New WordDocument("Template.docx", FormatType.Docx) + 'Initialize ChartToImageConverter for converting charts during Word to image conversion + wordDocument.ChartToImageConverter = New ChartToImageConverter() + 'Set the scaling mode for charts (Normal mode reduces the file size) + wordDocument.ChartToImageConverter.ScalingMode = ScalingMode.Normal + 'Convert word document to stream + Dim imageStream As Stream = wordDocument.RenderAsImages(2, System.Drawing.Imaging.ImageFormat.Bmp) + 'Close the document + wordDocument.Close() + 'Convert the stream to Image + Dim image As Image = Image.FromStream(imageStream) + 'Save the image as jpeg + image.Save("WordToImage.jpeg", ImageFormat.Jpeg) + End Sub + + + + + + + Converts the specified document page into image. + + + The zero based page index that represent which page to convert. + + + An ImageType that specifies the type of the image to render. + + + An that represent specified document page as image. + + + + Layouting the contents of a Word document as pages in the Essential DocIO is not exactly the same as the layouting in Microsoft Word. So, the total number of pages may vary slightly compared to that of the Microsoft Word. + + + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + is not supported when running in Azure environment, only is available. So, is used instead of automatically when rendering in Azure environment. + + + + The following code example demonstrates how to convert the specified Word document page as image. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Initialize ChartToImageConverter for converting charts during Word to image conversion + wordDocument.ChartToImageConverter = new ChartToImageConverter(); + //Set the scaling mode for charts (Normal mode reduces the file size) + wordDocument.ChartToImageConverter.ScalingMode = ScalingMode.Normal; + //Convert word document to image + Image image = wordDocument.RenderAsImages(2, ImageType.Bitmap); + //Close the document + wordDocument.Close(); + //Save the image + image.Save("WordToImage.jpeg", ImageFormat.Jpeg); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim wordDocument As New WordDocument("Template.docx", FormatType.Docx) + 'Initialize ChartToImageConverter for converting charts during Word to image conversion + wordDocument.ChartToImageConverter = New ChartToImageConverter() + 'Set the scaling mode for charts (Normal mode reduces the file size) + wordDocument.ChartToImageConverter.ScalingMode = ScalingMode.Normal + 'Convert word document to image + Dim image As Image = wordDocument.RenderAsImages(2, ImageType.Bitmap) + 'Close the document + wordDocument.Close() + 'Save the images as jpeg + image.Save("WordToImage_" & i & ".jpeg", ImageFormat.Jpeg) + End Sub + + + + + + + Converts the specified range of document pages into images + + + The zero based page index that represents the starting document page index. + + + The total number of pages to convert. + + + An ImageType That specifies the type of the image to render. + + + An array of images that represent specified range of document pages as images. + + + + Layouting the contents of a Word document as pages in the Essential DocIO is not exactly the same as the layouting in Microsoft Word. So, the total number of pages may vary slightly compared to that of the Microsoft Word. + + + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + is not supported when running in Azure environment, only is available. So, is used instead of automatically when rendering in Azure environment. + + + + The following code example demonstrates how to convert the Word document to image. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Initialize ChartToImageConverter for converting charts during Word to image conversion + wordDocument.ChartToImageConverter = new ChartToImageConverter(); + //Set the scaling mode for charts (Normal mode reduces the file size) + wordDocument.ChartToImageConverter.ScalingMode = ScalingMode.Normal; + //Convert word document to image + Image[] images = wordDocument.RenderAsImages(0, 2, ImageType.Bitmap); + //Close the document + wordDocument.Close(); + int i = 0; + foreach (Image image in images) + { + //Save the images as jpeg + image.Save("WordToImage_" + i + ".jpeg", ImageFormat.Jpeg); + i++; + } + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim wordDocument As New WordDocument("Template.docx", FormatType.Docx) + 'Initialize ChartToImageConverter for converting charts during Word to image conversion + wordDocument.ChartToImageConverter = New ChartToImageConverter() + 'Set the scaling mode for charts (Normal mode reduces the file size) + wordDocument.ChartToImageConverter.ScalingMode = ScalingMode.Normal + 'Convert word document to image + Dim images As Image() = wordDocument.RenderAsImages(0, 2, ImageType.Bitmap) + 'Close the document + wordDocument.Close() + Dim i As Integer = 0 + For Each image As Image In images + 'Save the images as jpeg + image.Save("WordToImage_" & i & ".jpeg", ImageFormat.Jpeg) + i += 1 + Next + End Sub + + + + + + + Finds the text based on specified regular expression. + + + The used to find the text. + + + The that contains the found text in the document. + + + The following code example demonstrates how to find a particular text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Find the first occurrence of a particular text in the document + TextSelection textSelection = document.Find(new Regex("panda")); + //Get the found text as single text range + WTextRange textRange = textSelection.GetAsOneRange(); + //Modify the text + textRange.Text = "Replaced text"; + //Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow; + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Find the first occurrence of a particular text in the document + Dim textSelection As TextSelection = document.Find(New Regex("panda")) + 'Get the found text as single text range + Dim textRange As WTextRange = textSelection.GetAsOneRange() + 'Modify the text + textRange.Text = "Replaced text" + 'Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + Finds the first entry of specified pattern of text in single-line mode which is extended to several paragraph in the document. + + The used to find the text. + The collection that contains the found text in the document. + + The following code example demonstrates how to + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Find the first occurrence of a particular text extended to several paragraphs in the document + TextSelection[] textSelections = document.FindSingleLine(new Regex("First paragraph Second paragraph")); + WParagraph paragraph = null; + foreach (TextSelection textSelection in textSelections) + { + //Get the found text as single text range and set highlight color + WTextRange textRange = textSelection.GetAsOneRange(); + textRange.CharacterFormat.HighlightColor = Color.YellowGreen; + paragraph = textRange.OwnerParagraph; + } + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Find the first occurrence of a particular text extended to several paragraphs in the document + Dim textSelections As TextSelection() = document.FindSingleLine(new Regex("First paragraph Second paragraph")) + Dim paragraph As WParagraph = Nothing + For Each textSelection As TextSelection In textSelections + 'Get the found text as single text range and set highlight color + Dim textRange As WTextRange = textSelection.GetAsOneRange() + textRange.CharacterFormat.HighlightColor = Color.YellowGreen + paragraph = textRange.OwnerParagraph + Next + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + This API not works for the text inside an. + + + + Finds the text based on specified string, taking into the consideration of caseSensitive and wholeWord options. + + + A string used to find the text. + + + Set to true to match the similar case text which specified in the parameter; otherwise false. + + + Set to true to match the whole word text which specified in the parameter; otherwise false. + + + The that contains the found text in the document. + + + The following code example demonstrates how to find a particular text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Find the first occurrence of a particular text in the document + TextSelection textSelection = document.Find("panda", true, true); + //Get the found text as single text range + WTextRange textRange = textSelection.GetAsOneRange(); + //Modify the text + textRange.Text = "Replaced text"; + //Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow; + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Find the first occurrence of a particular text in the document + Dim textSelection As TextSelection = document.Find("panda", true, true) + 'Get the found text as single text range + Dim textRange As WTextRange = textSelection.GetAsOneRange() + 'Modify the text + textRange.Text = "Replaced text" + 'Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + Finds the first entry of specified pattern of text in single-line mode which is extended to several paragraph in the document, taking into the consideration of caseSensitive and wholeWord options. + + + A string used to find the text. + + + Set to true to match the similar case text which specified in the parameter; otherwise false. + + + Set to true to match the whole word text which specified in the parameter; otherwise false. + + The collection that contains the found text in the document. + + The following code example demonstrates how to + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Find the first occurrence of a particular text extended to several paragraphs in the document + TextSelection[] textSelections = document.FindSingleLine("First paragraph Second paragraph", true, false); + WParagraph paragraph = null; + foreach (TextSelection textSelection in textSelections) + { + //Get the found text as single text range and set highlight color + WTextRange textRange = textSelection.GetAsOneRange(); + textRange.CharacterFormat.HighlightColor = Color.YellowGreen; + paragraph = textRange.OwnerParagraph; + } + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Find the first occurrence of a particular text extended to several paragraphs in the document + Dim textSelections As TextSelection() = document.FindSingleLine("First paragraph Second paragraph", True, False) + Dim paragraph As WParagraph = Nothing + For Each textSelection As TextSelection In textSelections + 'Get the found text as single text range and set highlight color + Dim textRange As WTextRange = textSelection.GetAsOneRange() + textRange.CharacterFormat.HighlightColor = Color.YellowGreen + paragraph = textRange.OwnerParagraph + Next + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + This API not works for the text inside an. + + + + Finds and returns all entries of the specified regular expression. + + + The used to find the text. + + + The collection that contains all the entries of the found text in the document. + + + The following code example demonstrates how to search a particular text and highlight it. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Find the occurrence of the Word "panda" in the document + TextSelection[] textSelection = document.FindAll(new Regex("panda")); + //Iterate through each occurrence and highlight it + foreach (TextSelection selection in textSelection) + { + IWTextRange textRange = selection.GetAsOneRange(); + textRange.CharacterFormat.HighlightColor = Color.Yellow; + } + //Save and Close the document + document.Save("Result.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Find the occurrence of the word "panda" in the document + Dim textSelection As TextSelection() = document.FindAll(new Regex("panda")) + 'Iterate through each occurrence and highlight it + For Each selection As TextSelection In textSelection + Dim textRange As IWTextRange = selection.GetAsOneRange() + textRange.CharacterFormat.HighlightColor = Color.Yellow + Next + document.Save("Result.docx") + document.Close() + End Sub + + + + + + + Find the text in main body while comparing Word documents. + We handled find for textbody to check headers and footers. + + Represents the Regex for finding item + /// Represents the Document Comparison or not + + + + Finds and returns all entries of the specified string, taking into the consideration of caseSensitive and wholeWord options. + + + A string used to find the text. + + + Set to true to match the similar case text which specified in the parameter; otherwise false. + + + Set to true to match the whole word text which specified in the parameter; otherwise false. + + + The collection that contains all the entries of the found text in the document. + + + The following code example demonstrates how to search a particular text and highlight it. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Find the occurrence of the Word "panda" in the document + TextSelection[] textSelection = document.FindAll("panda", false, true); + //Iterate through each occurrence and highlight it + foreach (TextSelection selection in textSelection) + { + IWTextRange textRange = selection.GetAsOneRange(); + textRange.CharacterFormat.HighlightColor = Color.Yellow; + } + //Save and Close the document + document.Save("Result.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Find the occurrence of the word "panda" in the document + Dim textSelection As TextSelection() = document.FindAll("panda", false, true) + 'Iterate through each occurrence and highlight it + For Each selection As TextSelection In textSelection + Dim textRange As IWTextRange = selection.GetAsOneRange() + textRange.CharacterFormat.HighlightColor = Color.Yellow + Next + document.Save("Result.docx") + document.Close() + End Sub + + + + + + + Replaces all entries of the given with the replace string. + + The used to find the text. + The string specifies the text to replace. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Replace all occurrence of a particular text in the document + document.Replace(new Regex("Paragraph"),"paragraph"); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Replace all occurrence of a particular text in the document + document.Replace(New Regex("Paragraph"), "paragraph") + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given string in the document with replace string, taking into + consideration of case sensitive and whole word options. + + The string represents the text to be found. + The string specifies the text to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Replace all occurrence of a particular text in the document + document.Replace("Paragraph","paragraph", false, true); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Replace all occurrence of a particular text in the document + document.Replace("Paragraph", "paragraph", False, True) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given string in the document with , taking into + consideration case sensitive and whole word options. + + The string represents the text to be found. + The specifies the text to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Find the first occurrence of the regular expression + TextSelection selection = document.Find(new Regex("Panda")); + //Replace all occurrence of a particular regular expression with the text selection in the document + document.Replace("Giant panda", selection, true, false); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = document.Find(New Regex("Panda")) + 'Replace all occurrence of a particular regular expression with the text selection in the document + document.Replace("Giant panda", selection, True, False) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given string in the document with , taking into + consideration case sensitive, whole word and formatting options. + + The string represents the text to be found. + The specifies the text to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + Set to true if to save source formatting; otherwise, false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Find the first occurrence of the regular expression + TextSelection selection = document.Find(new Regex("Panda")); + //Replace all occurrence of a particular regular expression with the text selection in the document + document.Replace("Giant panda", selection, true, false, true); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = document.Find(New Regex("Panda")) + 'Replace all occurrence of a particular regular expression with the text selection in the document + document.Replace("Giant panda", selection, True, False, False) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces the specified regular expression with a in the document. + + The used to find the text. + The specifies the text to replace. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Find the first occurrence of the regular expression + TextSelection selection = document.Find(new Regex("Panda")); + //Replace all occurrence of a particular regular expression with the text selection in the document + document.Replace(new Regex("Giant panda"), selection); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = document.Find(New Regex("Panda")) + 'Replace all occurrence of a particular regular expression with the text selection in the document + document.Replace(New Regex("Giant panda"), selection) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given regular expression in the document with the + along with its formatting. + + The used to find the text. + The specifies the text to replace. + Set to true to save source formatting; otherwise, false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Find the first occurrence of the regular expression + TextSelection selection = document.Find(new Regex("Panda")); + //Replace all occurrence of a particular regular expression with the text selection in the document + document.Replace(new Regex("Giant panda"), selection, true); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = document.Find(New Regex("Panda")) + 'Replace all occurrence of a particular regular expression with the text selection in the document + document.Replace(New Regex("Giant panda"), selection, True) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given string in the document with , taking into + consideration case sensitive, whole word options. + + The string represents the text to be found. + The text body part to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + if it specifies whole word, set to true. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Find the first occurrence of the regular expression + TextSelection selection = document.Find(new Regex("Panda")); + //Initialize text body part + TextBodyPart bodyPart = new TextBodyPart(selection); + //Replace a particular text with the text body part + document.Replace("Giant panda", bodyPart, true, false); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = document.Find(New Regex("Panda")) + 'Initialize text body part + Dim bodyPart As New TextBodyPart(selection) + 'Replace a particular text with the text body part + document.Replace("Giant panda", bodyPart, True, False) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given string in the document with , taking into + consideration case sensitive, whole word and formatting options. + + The string represents the text to be found. + The text body part to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false.. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + Set to true to save source formatting; otherwise, false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Find the first occurrence of the regular expression + TextSelection selection = document.Find(new Regex("Panda")); + //Initialize text body part + TextBodyPart bodyPart = new TextBodyPart(selection); + //Replace a particular text with the text body part + document.Replace("Giant panda", bodyPart, true, false, true); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = document.Find(New Regex("Panda")) + 'Initialize text body part + Dim bodyPart As New TextBodyPart(selection) + 'Replace a particular text with the text body part + document.Replace("Giant panda", bodyPart, True, False, True) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given regular expression in the document with the + . + + The used to find the text. + The text body part to replace. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Find the first occurrence of the regular expression + TextSelection selection = document.Find(new Regex("Panda")); + //Initialize text body part + TextBodyPart bodyPart = new TextBodyPart(selection); + //Replace a particular text with the text body part + document.Replace(new Regex("Giant panda"), bodyPart); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = document.Find(New Regex("Panda")) + 'Initialize text body part + Dim bodyPart As New TextBodyPart(selection) + 'Replace a particular text with the text body part + document.Replace(New Regex("Giant panda"), bodyPart) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given regular expression in the document with the + along with its formatting. + + The used to find the text. + The text body part to replace. + Set to true to save source formatting; otherwise, false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Find the first occurrence of the regular expression + TextSelection selection = document.Find(new Regex("Panda")); + //Initialize text body part + TextBodyPart bodyPart = new TextBodyPart(selection); + //Replace a particular text with the text body part + document.Replace(new Regex("Giant panda"), bodyPart, true); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = document.Find(New Regex("Panda")) + 'Initialize text body part + Dim bodyPart As New TextBodyPart(selection) + 'Replace a particular text with the text body part + document.Replace(New Regex("Giant panda"), bodyPart, True) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given string in the document with another Word document, taking into + consideration case sensitive, whole word options. + + The string represents the text to be found. + The Word document to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Load the another existing Word document to replace + WordDocument replaceDocument = new WordDocument("Replace.docx"); + //Replace all occurrence of a particular regular expression with the another document and close the document + document.Replace("Giant panda", replaceDocument, true, false); + replaceDocument.Close(); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Load the another existing Word document to replace + Dim replaceDocument As New WordDocument("Replace.docx") + 'Replace all occurrence of a particular regular expression with the another document and close the document + document.Replace("Giant panda", replaceDocument, True, False) + replaceDocument.Close(); + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given string in the document with another Word document, taking into + consideration case sensitive, whole word and formatting options. + + The string represents the text to be found. + The Word document to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + Set to true to save source formatting; otherwise, false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Load the another existing Word document to replace + WordDocument replaceDocument = new WordDocument("Replace.docx"); + //Replace all occurrence of a particular regular expression with the another document and close the document + document.Replace("Giant panda", replaceDocument, true, false, true); + replaceDocument.Close(); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Load the another existing Word document to replace + Dim replaceDocument As New WordDocument("Replace.docx") + 'Replace all occurrence of a particular regular expression with the another document and close the document + document.Replace("Giant panda", replaceDocument, True, False, True) + replaceDocument.Close(); + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given regular expression in the document with the + another word document along with its formatting. + + The used to find the text. + The Word document to replace. + Set to true to save source formatting; otherwise, false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //Load the another existing Word document to replace + WordDocument replaceDocument = new WordDocument("Replace.docx"); + //Replace all occurrence of a particular regular expression with the another document and close the document + document.Replace(new Regex("Giant panda"), replaceDocument, true); + replaceDocument.Close(); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + 'Load the another existing Word document to replace + Dim replaceDocument As New WordDocument("Replace.docx") + 'Replace all occurrence of a particular regular expression with the another document and close the document + document.Replace(New Regex("Giant panda"), replaceDocument, True) + replaceDocument.Close(); + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Updates Paragraphs count, Word count and Character count in the document. + + + The following code example demonstrates how to update Paragraphs count, Word count and Character count in the document. + + //Open an input word template + WordDocument document = new WordDocument(@"Template.docx", FormatType.Automatic); + //Update the Paragraphs count, Word count and Character count in the document + document.UpdateWordCount(); + //Save and close the Word document instance. + document.Save("Output.docx", FormatType.Docx); + document.Close(); + } + + + 'Open an input word template + Dim document As New WordDocument("Template.docx", FormatType.Automatic) + 'Update the Paragraphs count, Word count and Character count in the document. + document.UpdateWordCount() + 'Save and close the Word document instance. + document.Save("Output.docx", FormatType.Docx) + document.Close() + + + + + + Updates the word count and character count for Fields in the document + + + + + Splits the text into words by replacing the characters that are not considered for word and char count + + The string represents the text to be split + Arrays of words split + + + + Updates Paragraphs count, Word count and Character count. Updates page count if performLayout set to true using Doc to PDF layouting engine. + + Set to true to update the page count of the document using Word to PDF layouting engine; otherwise, false. + + This method is not supported in Silverlight, WinRT, Universal, Universal Windows Platform, MVC6, Xamarin and windows phone platforms. + + + The following code example demonstrates how to update Page count, Paragraphs count, Word count and Character count in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open an input word template + WordDocument document = new WordDocument(@"Template.docx"); + //Update the Page count, Paragraphs count, Word count and Character count in the document + document.UpdateWordCount(true); + //Save and close the Word document instance. + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open an input word template + Dim document As New WordDocument("Template.docx") + 'Update the Page count, Paragraphs count, Word count and Character count in the document. + document.UpdateWordCount(True) + 'Save and close the Word document instance. + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Updates Paragraphs count, Word count and Character count. Updates page count if performLayout set to true using Word to PDF layout engine. + + Set to true to update the page count of the document using Word to PDF layout engine; otherwise, false. + + + + Updates fields present in the document. + + + Updating of NUMPAGES field and Cross Reference field with Page number and Paragraph number options are not supported in Silverlight, WinRT, Universal and Windows Phone platforms. + Currently group shapes, drawing canvas, and table auto resizing are not supported in Word to PDF lay outing, and this may lead to update incorrect page number and total number of pages. + While updating NUMPAGES field and Cross Reference field with Page number and Paragraph number options uses makes use of our Word to PDF layouting engine which may lead to take some considerable amount of performance to update the above mentioned fields. + + + The following code example demonstrates how to update the fields present in Word document. + + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Input.docx", FormatType.Docx); + //Updates the fields present in a document. + document.UpdateDocumentFields(); + document.Save("Result.docx", FormatType.Docx); + document.Close(); + + + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Input.docx", FormatType.Docx) + 'Updates the fields present in a document. + document.UpdateDocumentFields() + document.Save("Result.docx", FormatType.Docx) + document.Close() + + + + + + Updates fields present in the document. Updates page field if performLayout set to true using Doc to PDF layouting engine. + + Set to true to update the page field in the document using Word to PDF layout engine; otherwise, false. + + + + Update sequence field values for sequence field which refer the bookmark. + + + + + + Gets the bookmark sequence field result. + + + + + + + Updates fields present in the document in optimal way. + + + Updating of NUMPAGES field and Cross Reference field with Page number and Paragraph number options are not supported in Silverlight, WinRT, Universal, Windows Phone and Xamarin platforms. + Currently group shapes, drawing canvas, and table auto resizing are not supported in Word to PDF lay outing, and this may lead to update incorrect page number and total number of pages. + While updating NUMPAGES field and Cross Reference field with Page number and Paragraph number options uses makes use of our Word to PDF layouting engine which may lead to take some considerable amount of performance to update the above mentioned fields. + + + + + Updates the Alternate chunks present in the Word document + + + The following code example demonstrates how to update the Alternate chunks present in Word document + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Input.docx", FormatType.Docx); + //Updates the Alternate chunks present in a document. + document.UpdateAlternateChunks(); + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Input.docx", FormatType.Docx) + 'Updates the Alternate chunks present in a document. + document.UpdateAlternateChunks() + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Get the first Alternate chunk of the section. + + The first AlternateChunk of the section, or null if none is found. + + + + Get the last Alternate chunk of the section. + + The last AlternateChunk of the section, or null if none is found. + + + + Updates the bookmark page cross reference fields. + + The pageref fields. + The layouter. + + + + Updates the bookmark cross reference fields. + + The reference fields. + + + + Updates the list value. + + The textbody. + The index. + The list value collections. + The level number collections. + + + + Updates the header footer list values. + + The list value collections. + The level number collections. + + + + Updates the shape list values. + + The list value collections. + The level number collections. + + + + Updates the end note list values. + + The list value collections. + The level number collections. + + + + Updates the foot note list values. + + The list value collections. + The level number collections. + + + + Updates the comment list values. + + The list value collections. + The level number collections. + + + + Updates the section list values. + + The list value collections. + The level number collections. + + + + Gets the paragraph number. + + The reference fields. + The bk start. + The owner para. + The level. + The separator. + The referencekind. + The paragraph list value. + The paragraph level numbers. + + + + + Gets the entity owner text body. + + The para. + + + + + Checking for NumPages/PageRef/Ref field present in the document + + + + + check all text body items + + + + + + Gets the text from paragraph item collection present in the owner paragraph + + Para items in owner paragraph + + + + + Check all cell in table + + + + + + Calculate paragraphs count, word count and character count + + + + + + Update Table of contents in the document. + + + Updating TOC makes use of our Word to PDF layouting engine which may lead to the updation of incorrect page number due to its limitations. Also use of WOrd to PDF layout engine may lead to take some considerable amount of performance to update the page numbers. + + + The following code example demonstrates how to update a TOC in an existing word document. + + //Open an input word template + WordDocument document = new WordDocument(@"Template.docx"); + //Update the table of contents. + document.UpdateTableOfContents(); + //Save and close the Word document instance. + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Open an input word template + Dim document As New WordDocument("Template.docx") + 'Update the table of contents. + document.UpdateTableOfContents() + 'Save and close the Word document instance. + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Update Table of contents in the document. + + + + + Updates the list. + + The paragraph. + + + + Update the suffix equivalent to list level + + The list format. + Name of the style. + The level. + Index of the list item. + + + + Updates the number prefix. + + The level number prefix. + The list format. + Returns the updated number prefix. + + + + Gets the display level text. (String literal) + + Level text which specified in file level. + + + + + Clears the list collection. + + + + + + Ensures the level restart. + + The format. + Name of the style. + if set to true full restart is performed. + + + + Gets the list item index value. + + The List format + Name of the style. + + + + + Gets the list start value. + + The format. + Name of the style. + + + + + We have to reset the startat value in "lstStyle" dictionary for the levels which + exists inbetween current and previous paragraph referred levels when leveltext of + current paragrah is more than one time increased While compare with leveltext of + previous paragraph. + + + + + + + + + Gets the list value. + + The list format. + Name of the style. + The level. + The start at. + Index of the list item. + + + + + Gets the ordered prefix value of level number. + + The level number prefix. + The ordered level number prefix. + + + + Gets the list prefix string, based on list level number + + Current list level number + List format entire prefix string + currentListLevelPrefix value + + + + Gets the list start value. + + The level. + list value. + value. + Index of the list item. + List prefix text value + + + + + Sort the Keys + + keys + returns keys value + + + + Replaces all entries of given string which is extended to several paragraphs in the document with replace string, taking into + consideration of case sensitive and whole word options. + + The string represents the text to be found. + The string specifies the text to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace the text extended to several paragraphs with simple text. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Replace the text extended to two paragraphs with simple text + document.ReplaceSingleLine("First paragraph Second paragraph", "Replaced paragraph", true, false); + //Save and close the document + document.Save("Replace.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Replace the text extended to two paragraphs with simple text + document.ReplaceSingleLine("First paragraph Second paragraph", "Replaced paragraph", True, False) + 'Save and close the document + document.Save("Replace.docx", FormatType.Docx) + document.Close() + End Sub + + + This API not works for the text inside an. + + + + Replaces all entries of the specified pattern text, which is extended to several paragraph, with replace text. + + The used to find the text. + The string specifies the text to replace. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace the text extended to several paragraphs with simple text. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Replace the text extended to two paragraphs with simple text + document.ReplaceSingleLine(new Regex("First paragraph Second paragraph"), "Replaced paragraph"); + //Save and close the document + document.Save("Replace.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Replace the text extended to two paragraphs with simple text + document.ReplaceSingleLine(New Regex("First paragraph Second paragraph"), "Replaced paragraph") + 'Save and close the document + document.Save("Replace.docx", FormatType.Docx) + document.Close() + End Sub + + + This API not works for the text inside an. + + + + Replaces all entries of given string which is extended to several paragraph in the document with , taking into + consideration case sensitive and whole word options. + + The string represents the text to be found. + The specifies the text to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace the text extended to several paragraphs with another text. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Find the first occurrence of a particular text in the document + TextSelection selection = document.Find("contents", false, false); + //Replace the text extended to two paragraphs with text selection + document.ReplaceSingleLine("First paragraph Second paragraph", selection, true, false); + //Save and close the document + document.Save("Replace.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Find the first occurrence of a particular text in the document + Dim selection As TextSelection = document.Find("contents", False, False) + 'Replace the text extended to two paragraphs with text selection + document.ReplaceSingleLine("First paragraph Second paragraph", selection, True, False) + 'Save and close the document + document.Save("Replace.docx", FormatType.Docx) + document.Close() + End Sub + + + This API not works for the text inside an. + + + + Replaces all entries of given regular expression text which is extended to several paragraph in the document with the + . + + The used to find the text. + The text selection to replace. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace the text extended to several paragraphs with another text. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Find the first occurrence of a particular text in the document + TextSelection selection = document.Find("contents", false, false); + //Replace the text extended to two paragraphs with text selection + document.ReplaceSingleLine(new Regex("First paragraph Second paragraph"), selection); + //Save and close the document + document.Save("Replace.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Find the first occurrence of a particular text in the document + Dim selection As TextSelection = document.Find("contents", False, False) + 'Replace the text extended to two paragraphs with text selection + document.ReplaceSingleLine(New Regex("First paragraph Second paragraph"), selection) + 'Save and close the document + document.Save("Replace.docx", FormatType.Docx) + document.Close() + End Sub + + + This API not works for the text inside an. + + + + Replaces all entries of given string which is extended to several paragraphs in the document with , taking into + consideration case sensitive, whole word options. + + The string represents the text to be found. + The text body part to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + if it specifies whole word, set to true. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace the text extended to several paragraphs with . + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Find the first occurrence of a particular text in the document + TextSelection selection = document.Find("contents", false, false); + //Initialize text body part + TextBodyPart bodyPart = new TextBodyPart(selection); + //Replace a particular text with the text body part + document.ReplaceSingleLine("First paragraph Second paragraph", bodyPart, true, false); + //Save and close the document + document.Save("Replace.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Find the first occurrence of a particular text in the document + Dim selection As TextSelection = document.Find("contents", False, False) + 'Initialize text body part + Dim bodyPart As New TextBodyPart(selection) + 'Replace a particular text with the text body part + document.ReplaceSingleLine("First paragraph Second paragraph", bodyPart, True, False) + 'Save and close the document + document.Save("Replace.docx", FormatType.Docx) + document.Close() + End Sub + + + This API not works for the text inside an. + + + + Replaces all entries of given regular expression text which is extended to several paragraph in the document with the + . + + The used to find the text. + The text body part to replace. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace the text extended to several paragraphs with . + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Find the first occurrence of a particular text in the document + TextSelection selection = document.Find("contents", false, false); + //Initialize text body part + TextBodyPart bodyPart = new TextBodyPart(selection); + //Replace a particular text with the text body part + document.ReplaceSingleLine(new Regex("First paragraph Second paragraph"), bodyPart); + //Save and close the document + document.Save("Replace.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Find the first occurrence of a particular text in the document + Dim selection As TextSelection = document.Find("contents", False, False) + 'Initialize text body part + Dim bodyPart As New TextBodyPart(selection) + 'Replace a particular text with the text body part + document.ReplaceSingleLine(New Regex("First paragraph Second paragraph"), bodyPart) + 'Save and close the document + document.Save("Replace.docx", FormatType.Docx) + document.Close() + End Sub + + + This API not works for the text inside an. + + + + Replaces the HF single line. + + The pattern. + The replace. + + + + + Resets the single line replace. + + + + + Replaces the single line. + + The pattern. + The replace. + The start item. + + + + + Check whether any of floating items contain same Z Order or not. + + + + + + Sort the document floating items based on its Z-Index by ascending order + + + + + Assign the new ZIndex values for all floating items in the document + + + + + Finds the next entry of the specified text from the specified text body item, taking into the consideration of caseSensitive + and wholeWord options. + + The that represents the start body item at which search starts (paragraph or table). + + A string used to find the text. + + + Set to true to match the similar case text which specified in the parameter; otherwise false. + + + Set to true to match the whole word text which specified in the parameter; otherwise false. + + + The that contains the found text in the document. + + + The following code example demonstrates how to find a particular text and its next occurrence in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Find the first occurrence of a particular text in the document + TextSelection textSelection = document.Find("as graphical contents", false, true); + //Get the found text as single text range + WTextRange textRange = textSelection.GetAsOneRange(); + //Modify the text + textRange.Text = "Replaced text"; + //Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow; + //Find the next occurrence of a particular text from the previous paragraph + textSelection = document.FindNext(textRange.OwnerParagraph, "paragraph", true, false); + //Get the found text as single text range + WTextRange range = textSelection.GetAsOneRange(); + //Set bold formatting + range.CharacterFormat.Bold = true; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Find the first occurrence of a particular text in the document + Dim textSelection As TextSelection = document.Find("as graphical contents", false, true) + 'Get the found text as single text range + Dim textRange As WTextRange = textSelection.GetAsOneRange() + 'Modify the text + textRange.Text = "Replaced text" + 'Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow + 'Find the next occurrence of a particular text from the previous paragraph + textSelection = document.FindNext(textRange.OwnerParagraph, "paragraph", true, false) + 'Get the found text as single text range + Dim range As WTextRange = textSelection.GetAsOneRange() + 'Set bold formatting + range.CharacterFormat.Bold = True + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + Finds the next entry of the specified regular expression from the specified text body item. + + The that represents the start body item at which search starts (paragraph or table). + The used to find the text. + The that contains the found text in the document. + + The following code example demonstrates how to find a particular text and its next occurrence in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Find the first occurrence of a particular text in the document + TextSelection textSelection = document.Find(new Regex("as graphical contents")); + //Get the found text as single text range + WTextRange textRange = textSelection.GetAsOneRange(); + //Modify the text + textRange.Text = "Replaced text"; + //Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow; + //Find the next occurrence of a particular text from the previous paragraph + textSelection = document.FindNext(textRange.OwnerParagraph, new Regex("paragraph")); + //Get the found text as single text range + WTextRange range = textSelection.GetAsOneRange(); + //Set bold formatting + range.CharacterFormat.Bold = true; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Find the first occurrence of a particular text in the document + Dim textSelection As TextSelection = document.Find("as graphical contents") + 'Get the found text as single text range + Dim textRange As WTextRange = textSelection.GetAsOneRange() + 'Modify the text + textRange.Text = "Replaced text" + 'Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow + 'Find the next occurrence of a particular text from the previous paragraph + textSelection = document.FindNext(textRange.OwnerParagraph, "paragraph") + 'Get the found text as single text range + Dim range As WTextRange = textSelection.GetAsOneRange() + 'Set bold formatting + range.CharacterFormat.Bold = True + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + Finds the next selection. + + The pattern. + + + + + Updates the next item at which next find will start. + + The selection. + + + + Gets the next paragraph item in textbody item. + + The textbody item. + + + + + Gets the next paragraph item in text body. + + The text body. + + + + + Checks the selection. + + The text selection. + + + + Finds the next entry of the specified text from the specified text body item in single-line mode which is extended to several paragraph in the document, taking into the consideration of caseSensitive + and wholeWord options. + + The that represents the start body item at which search starts (paragraph or table). + + A string used to find the text. + + + Set to true to match the similar case text which specified in the parameter; otherwise false. + + + Set to true to match the whole word text which specified in the parameter; otherwise false. + + + The that contains the found text in the document. + + + The following code example demonstrates how to find a particular text and its next occurrence which is extended to several paragraphs in the Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Find the first occurrence of a particular text extended to several paragraphs in the document + TextSelection[] textSelections = document.FindSingleLine("First paragraph Second paragraph", true, false); + WParagraph paragraph = null; + foreach (TextSelection textSelection in textSelections) + { + //Get the found text as single text range and set highlight color + WTextRange textRange = textSelection.GetAsOneRange(); + textRange.CharacterFormat.HighlightColor = Color.YellowGreen; + paragraph = textRange.OwnerParagraph; + } + //Find the next occurrence of a particular text extended to several paragraphs in the document + textSelections = document.FindNextSingleLine(paragraph, "First paragraph Second paragraph", true, false); + foreach (TextSelection textSelection in textSelections) + { + //Get the found text as single text range and set italic formatting + WTextRange text = textSelection.GetAsOneRange(); + text.CharacterFormat.Italic = true; + } + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Find the first occurrence of a particular text extended to several paragraphs in the document + Dim textSelections As TextSelection() = document.FindSingleLine("First paragraph Second paragraph", True, False) + Dim paragraph As WParagraph = Nothing + For Each textSelection As TextSelection In textSelections + 'Get the found text as single text range and set highlight color + Dim textRange As WTextRange = textSelection.GetAsOneRange() + textRange.CharacterFormat.HighlightColor = Color.YellowGreen + paragraph = textRange.OwnerParagraph + Next + 'Find the next occurrence of a particular text extended to several paragraphs in the document + textSelections = document.FindNextSingleLine(paragraph, "First paragraph Second paragraph", True, False) + For Each textSelection As TextSelection In textSelections + 'Get the found text as single text range and set italic formatting + Dim text As WTextRange = textSelection.GetAsOneRange() + text.CharacterFormat.Italic = True + Next + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + This API not works for the text inside an. + + + + Finds the next entry of the specified pattern of text in single-line mode which is extended to several paragraph in the document. + + The that represents the start body item at which search starts (paragraph or table). + The used to find the text. + The that contains the found text in the document. + + The following code example demonstrates how to find a particular text and its next occurrence which is extended to several paragraphs in the Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Find the first occurrence of a particular text extended to several paragraphs in the document + TextSelection[] textSelections = document.FindSingleLine("First paragraph Second paragraph", true, false); + WParagraph paragraph = null; + foreach (TextSelection textSelection in textSelections) + { + //Get the found text as single text range and set highlight color + WTextRange textRange = textSelection.GetAsOneRange(); + textRange.CharacterFormat.HighlightColor = Color.YellowGreen; + paragraph = textRange.OwnerParagraph; + } + //Find the next occurrence of a particular text extended to several paragraphs in the document + textSelections = document.FindNextSingleLine(paragraph, new Regex("First paragraph Second paragraph")); + foreach (TextSelection textSelection in textSelections) + { + //Get the found text as single text range and set italic formatting + WTextRange text = textSelection.GetAsOneRange(); + text.CharacterFormat.Italic = true; + } + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Find the first occurrence of a particular text extended to several paragraphs in the document + Dim textSelections As TextSelection() = document.FindSingleLine("First paragraph Second paragraph", True, False) + Dim paragraph As WParagraph = Nothing + For Each textSelection As TextSelection In textSelections + 'Get the found text as single text range and set highlight color + Dim textRange As WTextRange = textSelection.GetAsOneRange() + textRange.CharacterFormat.HighlightColor = Color.YellowGreen + paragraph = textRange.OwnerParagraph + Next + 'Find the next occurrence of a particular text extended to several paragraphs in the document + textSelections = document.FindNextSingleLine(paragraph, new Regex("First paragraph Second paragraph")) + For Each textSelection As TextSelection In textSelections + 'Get the found text as single text range and set italic formatting + Dim text As WTextRange = textSelection.GetAsOneRange() + text.CharacterFormat.Italic = True + Next + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + This API not works for the text inside an. + + + + Finds the next text which fit the specified pattern using single-line mode. + + The pattern. + + + + + Resets the find next of . + + + + + Creates a new paragraph item instance. + + A represents the type of paragraph item to create. + The this method created. + + + + + + + + + + Implementation of character format creating + + Character format object. + + + + + + + + + + + + + + + + Implementation of paragraph format creating + + Paragraph format object. + + + + Implementation of table format creating + + Table format instance + + + + Implementation of cell format creating + + + + + + Implementation of textbox format creating + + textbox format object. + + + + Text + + + + + + + + + + + + + Creates the compound file. + + + + + + Creates the compound file. + + The stream. + + + + + Checks for encryption. + + The stream. + + + + + Ensures the paragraph style. + + The paragraph. + + + + Check whether last entity is WTable then add empty paragraph. + + + + + Clones the shape escher. + + The destination doc. + The shape item. + + + + Clones the DocxProps. + + + + + Clones the dictionary of string values. + + + + + Clones the list of stream values. + + + + + Clones the stream. + + + + + Gets the password. + + + + + + Checkes whether any one of the section has valid numbering properties. + + + + + Inserts the watermark. + + The type. + + + + Reads document's background fill effects. + + + + + Saves the document to the detailed XML stream. + + The stream. + + + + Determines whether list has style + + + + + Updates the start position of next items from the inputed paragraph item. + + An item where to start updating start position in the paragraph. + A value to add with start position of next items. + + + + Update the start position of inputed item using its offset value. + + Item to update the position. + A value to add with start position of + + + + Updates the start position of items inside inline content control. + + Represents inline content control to update position values of inner items. + Index of the item to update. + A value added to the existing position value. + + + + Checks whether the Word document is of DOCX type in any word versions + + + + + Inits the default paragraph format. + + + + + + + + + + Determines whether current process is DocIO internal manipulation or end user maipulation. + + + + + + Updates the ImportOption property value based on its priority. + + + + + Copies the binary data. + + The SRC data. + The destination data. + + + + + + + + + + + Clones the textbox container. + + The destination doc. + The textbox. + + + + Clones the auto shape container. + + The destination doc. + The shape obj. + + + + Checks the container. + + The type. + The spid. + + + + + + + + + + + + + + + + Determines whether document has tracked changes. + + + It has tracked changes, set to true. + + + + + Checks whether security permission can be granted. + + + + + Checks the extension with respect to formatType + + The filename + The FormatType + + + + + Checks the name of the file. + + Name of the file. + + + + Resets the watermark. + + + + + update the write watermark for each header. + + + + + Sets the protection. + + + + + Create default liststyles and add them to ListStyleCollection + + + + + + + + + + + + + + + Gets xml schema + + + + + + Reads document using XmlReader + + + + + + Writes document using XmlWriter + + + + + + + + + + + + Registers child objects in XDSL holder. + + + + + + Writes object data as inside xml element. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + The value indicating the presence of xml content. + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Creates and initializes layout data + + + + + + Removes the macros in the document. + + The following code example demonstrates how to remove macros from the Word document. + This method removes the macros from DOCM and DOTM format files. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the document with macros + WordDocument document = new WordDocument("Sample.docm"); + //Check whether the document has macros and remove them + if (document.HasMacros) + document.RemoveMacros(); + //Save the document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the document with macros + Dim document As New WordDocument("Sample.docm") + 'Check whether the document has macros and remove them + If document.HasMacros Then + document.RemoveMacros() + End If + 'Save the document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Sets the trigger element. + + The flag. + The bit position. + + + + Determines whether the specified flag has element. + + The flag. + The bit position. + + + + + Checks whether document has different page setup + + Returns true if document has different page setup; else returns false + + + + Updates the revision information for the paragraph item. + + + + + + + + + + + + + + Gets the existing revision for the remaining paragraph items (except first item) if exists otherwise create new revision. + + + + + + + + + + Stack that stores the prevision revision of the item + + + + + Gets the existing revision for the first paragraph item if exists otherwise create new revision. + + + + + + + + + + + + + + Gets the existing row revision when paragraph exists inside the table cell. + + + + + + + + + + + Gets the existing revision based on the revision type and author. + + + + + + + + + Gets the existing revision based on revision type, author and sibiling revisions + + Previous sibiling revisions + Current revision type + Current author + Stack that stores sibiling revisions of current revision + Current item + + + + + Creates revision when revision not exist in revision collection. + + + + + + + + + + + + + + Update insert/delete revision for table row. + + The revision type. + The table row. + + + + Links the nested table row into the owner table row revision if same author name and type. + Otherwise create child revision and liked to the owner table row revision. + + + + + + + + + Creates a new revision. + + The revision type. + + + + + Creates a new child revision. + Child revisions are not added into the document revision collection. + + The revision type. + + + + + Update the insert/delete revisions in Character format. + + The revision type. + The character format. + + + + We should get author name based on the revision type since this is DOC format document. + + + + + + + + We should get date name based on the revision type since this is DOC format document. + + + + + + + + + Links the table revision for the break character format. + + + + + + + + + + + Links the move revision for the break character format. + + + + + + + + + + + Moves the source revision ranges into destination revision ranges. + + + + + + + Updates the paragraph format revision changes. + + The paragraph format. + + + + Gets the last updated revision in section . + + The page section . + Returns the last updated revision in section. + + + + Compare two formats and gets the same revision. + + The current format. + The previous format to compare + Returns the revision by compare the two formats have same revision. Otherwise null + + + + Updates the character format revision changes. + + The character format. + The paragraph item. + + + + Gets the character format change revision for the style. + + + + + + + + + Gets the character format change revision for the first paragraph item. + + + + + + + + Gets the previous break character format inside the table. + + + + + + + + Gets the paragraph format of style. + + The style + + + + + Checks whether any renderable item before the current item in Owner paragraph + + The paragraph item. + Returns true, if contains renderable item before the current item. Otherwise false + + + + Updates the table format revision changes at the end of each row. + + The table row. + + + + Updates the table row revision changes. + + The table cell. + + + + Updates the table cell revision changes. + + The table cell. + + + + Gets the last updated revision in table row. + + The table row. + Returns the last updated revision in table row. + + + + Updates the revisions inside the field range. + + The field. + + + + Removes the revision by iterating the text body. + + + + + + + + + Removes the revision by iterating the paragraph items. + + + + + + + + Removes the revision by iterating the textbody. + + + + + + + + + Removes the revision by iterating the paragraph items. + + + + + + + + Removes the revision by iterating the table. + + + + + + + + Removes the revisions from the collection and add as a child revision of parent field. + + + + + + + + + + Update the table revisions for the DOC format Word document. + + + + + + Removes the revision from the collection by iterating the text body. + + + + + + + Removes the revision from the collection by iterating the paragraph items. + + + + + + + Removes the revision from the collection by iterating the table. + + + + + + + Removes the revision from the collection and add as child revision of table row. + + + + + + + + + Removes bookmarks which has no BookmarkEnd + + + + + Update the paragraph last item revision. + + The paragraph. + The paragraph items. + + + + Links the content control with the break character format when it has same revision details. + + + + + + + Links the last paragraph item or field with the break character format when it has same revision details. + + + + + + + + Links the break character format revision for empty paragraph. + + The paragraph. + The paragraph items. + + + + Removes the revision from the collection by iterating the textbody items. + + The textbody. + + + + Removes the revision from the collection by iterating the paragraph items. + + The paragraph item. + + + + Removes the revision from the collection by iterating the table. + + The table. + + + + Removes all the revisions from the collection. + + The revision collection. + + + + Updates the character format change revision. + + + + + + + Updates the paragraph format change revision. + + + + + + Updates the section format change revision. + + + + + + + + + + + + Get encoding for the specific code page + + The code page name + Returns the derived encoding for Windows Phone and Xamarin + + + + + Find an item in a Word document based on the specified property and value. + + to find in a Word document. + The property of an item + The property value of an item. + Returns the first occurrence of an item that matches the specified property and value. + + + //Open an existing Word document. + using(WordDocument document = new WordDocument("Template.docx")) + { + //Find picture by alternative text. + WPicture picture = document.FindItemByProperty(EntityType.Picture, "AlternativeText", "Logo") as WPicture; + //Resize the picture. + if (picture != null) + { + picture.Height = 50; + picture.Width = 75; + } + //Save and close the Word document. + document.Save("Sample.docx"); + } + + + 'Open an existing Word document. + Dim document As WordDocument = New WordDocument("Template.docx") + 'Find picture by alternative text. + Dim picture As WPicture = TryCast(document.FindItemByProperty(EntityType.Picture, "AlternativeText", "Logo"), WPicture) + 'Resize the picture. + If picture IsNot Nothing Then + picture.Height = 50 + picture.Width = 75 + End If + 'Save and close the Word document. + document.Save("Sample.docx") + document.Close() + + + + + + Find an item in a Word document based on the specified property and value. + + to find in a Word document. + An array of property names of an item + An array of property values of an item. + Returns the first occurrence of an item that matches the specified property names and values. + + + //Open an existing Word document. + using(WordDocument document = new WordDocument("Template.docx")) + { + //Find picture by height and width. + WPicture picture = document.FindItemByProperties(EntityType.Picture, new string[] { "Height", "Width" }, new string[] { "100", "50" }) as WPicture; + //Resize the picture. + if (picture != null) + { + picture.Height = 50; + picture.Width = 75; + } + //Save and close the Word document. + document.Save("Sample.docx"); + } + + + 'Open an existing Word document. + Dim document As WordDocument = New WordDocument("Template.docx") + 'Find pictures by height and width. + Dim picture As WPicture = TryCast(document.FindItemByProperties(EntityType.Picture, New String() {"Height", "Width"}, New String() {"100", "50"}), WPicture) + 'Resize the pictures. + If picture IsNot Nothing Then + picture.Height = 50 + picture.Width = 75 + End If + 'Save and close the Word document. + document.Save("Sample.docx") + document.Close() + + + + + + + + Find an item in a Section based on the specified property and value. + + to find in a Word document. + An array of property names of an item + An array of property values of an item. + A Boolean value for entityType from the Method + Returns the first occurrence of an item that matches the specified property names and values. + + + + Find an item in a Textbody based on the specified property and value. + + Textbody + to find in a Word document. + An array of property names to map an item + An array of property values to map an item. + A Boolean value for entityType should return only first item or all item in document + Returns the first occurrence or all item that matches the specified property names and values. + + + + Find an item in a Paragraph based on the specified property and value. + + Paraitems in ParagraphItemCollection + to find in a Word document. + An array of property names of an item + An array of property values of an item. + A Boolean value for entityType from the Method + Returns the first occurrence of an item that matches the specified property names and values. + + + + Find an item in a Table based on the specified property and value. + + Table in Textbody + to find in a Word document. + An array of property names of an item + An array of property values of an item. + A Boolean value for entityType from the Method + Returns the first occurrence of an item that matches the specified property names and values. + + + + Checks whether the item satisfies the entityType, propertyNames and propertValues. + + The current entity + to find in a Word document. + An array of property names of an item + An array of property values of an item. + True, if the item satisfies the entityType, propertyNames and propertValues else false + + + + Check whether the EnityType is supported or not. + + to find in a Word document. + True, if entitytype is not supported or internal else false + + + + Check whether the current object property value equal to propertyValues array. + + + An array of property names of an item + An array of property values of an item. + True, if propertyvalue are equal to item else false + + + + Find Watermark in a Word Document based on the specified property and value. + + An array of property names of an item + An array of property values of an item. + A Boolean value for entityType from the Method + Returns the list of Watermark matches the specified property names and values else return empty list. + + + + Add the source list value to the destination list + + Destination List + + + + + + Update the matched index + + + + + Check and Mark Nested field + + + + + + Update the index + + + + + + + + + + + Skip the text between field begin and field end + + + + + Set the new start position from the begin to end index in a given section + + + + + + + + + + Iterate through the body item and set the new StartPos for all childentities. + + Body item + + + + Set the new StartPos for the items in the paragraph + + + + + + + + Compares the specified Word document with the current instance of the and marks the difference as tracked changes (revisions). + + The to compare. + The name of the author to use for revisions. If unspecified, it uses the last modified author of the Word document as default. Otherwise, uses the string “Author” if last modified author information not present. + The date and time to use for revisions. If unspecified, it uses current date and time as default. + Options to use while comparing two Word documents. + + The following code example demonstrates how to compares the original document with revised document + + //Load an existing Word document into DocIO instance + WordDocument originalDocument = new WordDocument("OriginalDocument.docx", FormatType.Docx); + WordDocument revisedDocument = new WordDocument("RevisedDocument.docx", FormatType.Docx); + //Compares the original document with revised document + originalDocument.Compare(revisedDocument, "Nancy Davolio", DateTime.Now.AddDays(-1)); + originalDocument.Save("Result.docx", FormatType.Docx); + revisedDocument.Close(); + originalDocument.Close(); + + + 'Load an existing Word document into DocIO instance + Dim originalDocument As New WordDocument("OriginalDocument.docx", FormatType.Docx) + Dim revisedDocument As New WordDocument("RevisedDocument.docx", FormatType.Docx) + 'Compares the original document with revised document + originalDocument.Compare(revisedDocument, "Nancy Davolio", DateTime.Now.AddDays(-1)); + originalDocument.Save("Result.docx", FormatType.Docx) + revisedDocument.Close(); + originalDocument.Close() + + + + + + Aplly section format revision to the original document. + + + + + + + Initilize the properties and compare options for Word comparison + + + + + Compare the styles collection between two documents + + The revised document instance + + + + Modify the default format as revised format in original document + + + + + + Copy the document default styles from revised document and paste it in given original style + + + + + + + Compare the empty paragraphs at the end of the document + + The revised document instance + + + + Insert or delete the unmatched items at the end of the documents. + + + + + + Delete the unmatched items at the end of the document. + + Author name + Data and time + + + + Insert the items from the revised document to the original document + + + + + + Mark insert revision for the Word document part + + + + + + Insert the items of the field to the paragraph. + + Current paragraph in original document + Current paragraph in revised document + Index of current para item in revised document + + + + Gets the Paragraph to insert bookmark + + + + + + + + Removes the deletion mark of the paragraph item + + The paragraph item instance + + + + Removes the insertion mark of the paragraph item + + The paragraph item instance + + + + Checks whether need to create balloons for deletions markup in the Word document. + + + + + + + Checks whether need to create balloons for formatting markup in the Word document. + + + + + + + Checks whether need to create balloons for comment in the Word document. + + + + + + + Gets or sets the object for converting chart to image + + + In Word to PDF conversion, to preserve the charts as images in the generated PDF document, this must be initialized. Otherwise the charts will not be exported to the converted PDF + ChartToImageConverter is supported from .NET Framework 4.0 onwards. + + + The following code example demonstrates how to initialize the to preserve the charts as images in the generated PDF document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Initialize ChartToImageConverter for converting charts during Word to pdf conversion + wordDocument.ChartToImageConverter = new ChartToImageConverter(); + //Create an instance of DocToPDFConverter + DocToPDFConverter converter = new DocToPDFConverter(); + //Convert Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Close the instance of Word document object + wordDocument.Close(); + //Save the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Close the instance of PDF document object + pdfDocument.Close(true); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim wordDocument As New WordDocument("Template.docx", FormatType.Docx) + 'Initialize ChartToImageConverter for converting charts during Word to pdf conversion + /// wordDocument.ChartToImageConverter = New ChartToImageConverter() + 'Create an instance of DocToPDFConverter + Dim converter As New DocToPDFConverter() + 'Convert Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Close the instance of Word document object + wordDocument.Close(); + 'Save the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Close the instance of document object + pdfDocument.Close(True) + End Sub + + + + + + Gets a instance that represents the font settings of the Word document. Read-only. + + The instance that represents the font settings of the Word document. + + + The following code example demonstrates how to initialize the to perform font substitution when a specified font is not installed in the production environment. + + // Loads an existing Word document. + WordDocument wordDocument = new WordDocument("template.docx", FormatType.Docx); + // Initializes the SubstituteFont event to perform font substitution during Word to PDF conversion. + wordDocument.FontSettings.SubstituteFont += new SubstituteFontEventHandler(SubstituteFont); + // Creates an instance of DocToPDFConverter. + DocToPDFConverter converter = new DocToPDFConverter(); + // Converts the Word document into PDF document. + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + // Closes the instance of Word document object. + wordDocument.Close(); + // Saves the PDF file. + pdfDocument.Save("WordtoPDF.pdf"); + // Closes the instance of PDF document object. + pdfDocument.Close(true); + + private void SubstituteFont(object sender, SubstituteFontEventArgs args) + { + // Sets the alternate font when a specified font is not installed in the production environment. + if (args.OrignalFontName == "Arial Unicode MS") + args.AlternateFontName = "Arial"; + else + args.AlternateFontName = "Times New Roman"; + } + + + ' Loads an existing Word document. + Dim wordDocument As New WordDocument("template.docx", FormatType.Docx) + ' Initializes the SubstituteFont event to perform font substitution during Word to PDF conversion. + AddHandler wordDocument.FontSettings.SubstituteFont, AddressOf SubstituteFont + ' Creates an instance of DocToPDFConverter. + Dim converter As New DocToPDFConverter() + ' Converts the Word document into PDF document. + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + ' Closes the instance of document object. + wordDocument.Close() + ' Saves the PDF file . + pdfDocument.Save("WordtoPDF.pdf") + ' Closes the instance of document object. + pdfDocument.Close(True) + + Private Sub SubstituteFont(ByVal sender As Object, ByVal args As SubstituteFontEventArgs) + ' Sets the alternate font when a specified font is not installed in the production environment. + If args.OrignalFontName = "Arial Unicode MS" Then + args.AlternateFontName = "Arial" + Else + args.AlternateFontName = "Times New Roman" + End If + End Sub + + + + + + + Gets or sets the footnote separators of the document. + + The instance used to specify the footnote separator of this . + + + + + Gets or sets the endnote separators of the document. + + The instance used to specify the endnote separator of this . + + + + + Gets or sets the default tab stop position value measured in points. + + The width of the default tab. + + + + + Gets or sets the value for Character Spacing Control + + + + + Gets or sets the word version based on the nFib and nFibNew. + Value of nFib Word version + 0x00C0 97 create new document in OS + 0x00C1 97 + 0x00C2 97 BIDI build + 0x00D9 2000 + 0x0101 2002 + 0x010C 2003 + 0x0112 2007 + + The FIB version. + + + + Gets the type of the entity. + + The of the current item. + + + + Gets a collection that represents all the built-in document properties for the specified document. Read-only. + + + + + + + Gets a object that represents the attached template of the document. Read-only. + + Attached template of the document + + + + + Gets or sets a value indicating whether to automatically update styles of the document from the attached template each time the document is opened. Default value is false. + + True if the styles of the document are updated to from the attached template;otherwise, false. + + + + Gets a collection that represents all the custom document properties for the specified document. Read-only. + + + + + Gets a collection that represents all the sections in the document. Read-only. + + A Sections collection represents all the in this + + + + + + Gets a collection that represents all the styles in the document. Read-only. + + A collection represents all the in this + + + + + + + + Gets a collection that represents all the list styles in the document. Read-only. + + All the in this . + + + + + + Gets or sets a that represents the options to import the source document contents to the destination document. + Default value is UseDestinationStyles. + + This property will not be considered while executing ImportContent method and its overloads in class. + If invalid combination applied, then it will be skipped or auto corrected based on priority. + + + //Creates an new instance of WordDocument class. + WordDocument srcDocument = new WordDocument("SourceTemplate.docx"); + // Creates an new instance of WordDocument class. + WordDocument destDocument = new WordDocument("DestinationTemplate.docx"); + //Import the contents of source document at the end of destination document with destination styles. + destDocument.ImportOptions = ImportOptions.UseDestinationStyles; + destDocument.Sections.Add(srcDocument.LastSection.Clone()); + // Releases the resources occupied by WordDocument instance. + srcDocument.Close(); + // Saves the document in the given name and format. + destDocument.Save("Document.docx", FormatType.Docx); + // Releases the resources occupied by WordDocument instance. + destDocument.Close(); + + + 'Creates an new instance of WordDocument class. + Dim srcDocument As New WordDocument("SourceTemplate.docx") + ' Creates an new instance of WordDocument class. + Dim destDocument As New WordDocument("DestinationTemplate.docx") + 'Import the contents of source document at the end of destination document with destination styles. + destDocument.ImportOptions = ImportOptions.UseDestinationStyles + destDocument.Sections.Add(srcDocument.LastSection.Clone()) + ' Releases the resources occupied by WordDocument instance. + srcDocument.Close() + ' Saves the document in the given name and format. + destDocument.Save("Document.docx", FormatType.Docx) + ' Releases the resources occupied by WordDocument instance. + destDocument.Close() + + + + + + Gets a collection that represents all the bookmarks in the document. Read-only. + + + + + + + + + Gets a collection that represents all the editable ranges in the document. Read-only. + + + + + + + + + Gets a collection that represents all the comments in the document. Read-only. + + + + + + + Gets a collection that represents all the comments extended in the document. Read-only. + + + + + + Gets a collection that represents all the textboxes in the document. Read-only. + + A collection represents all the in this . + + + + + + Gets a collection that represents all the revisions in the document. Read-only. + + A collection represents all the in this + + + + + Gets a the metadata stored in a document, such as author name, subject, and company. Read-only. + + A collection represents all the in this + + + + + Gets the last of the document. Read-only. + + The represents the last section of this + + The following code example demonstrates how to retrieve the last section of the document + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Retrieve the last section of the document and add new paragraph + document.LastSection.AddParagraph().AppendText("Adding new paragraph to the document"); + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Retrieve the last section of the document and add new paragraph + document.LastSection.AddParagraph().AppendText("Adding new paragraph to the document") + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + Gets the last of the document. Read-only. + + The represents the last paragraph of this + + The following code example demonstrates how to retrieve the last paragraph of the document + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Set the last paragraph back color as Blue + document.LastParagraph.ParagraphFormat.BackColor = Color.Blue; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Set the last paragraph back color as Blue + document.LastParagraph.ParagraphFormat.BackColor = Color.Blue + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + Gets or sets the numbering format for the endnotes in the document. + + The for the endnotes in the Word document + + The following code example demonstrates how to specify the endnote number format in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Set the endnote format + document.EndnoteNumberFormat = FootEndNoteNumberFormat.Arabic; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Set the endnote format + document.EndnoteNumberFormat = FootEndNoteNumberFormat.Arabic + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets the numbering format for the footnotes in the document. + + The for the footnotes in the Word document + + The following code example demonstrates how to specify the footnote number format in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Set the footnote number format + document.FootnoteNumberFormat = FootEndNoteNumberFormat.UpperCaseRoman; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Set the footnote number format + document.FootnoteNumberFormat = FootEndNoteNumberFormat.UpperCaseRoman + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets the restart index for the endnotes in the document. + + + The following code example demonstrates how to specify the endnote restart index number in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Set the endnote restart index number + document.RestartIndexForEndnote = EndnoteRestartIndex.RestartForEachSection; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Set the endnote restart index number + document.RestartIndexForEndnote = EndnoteRestartIndex.RestartForEachSection + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets endnotes position in the document. + + The for the endnotes in the document + + The following code example demonstrates how to specify the endnote position in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Set the endnote position at end of each section + document.EndnotePosition = EndnotePosition.DisplayEndOfSection; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Set the endnote position at end of each section + document.EndnotePosition = EndnotePosition.DisplayEndOfSection + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets the restart index for the footnotes in the document. + + + The following code example demonstrates how to specify the footnote restart index number in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Set the footnote restart index number + document.RestartIndexForFootnotes = FootnoteRestartIndex.RestartForEachPage; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Set the footnote restart index number + document.RestartIndexForFootnotes = FootnoteRestartIndex.RestartForEachPage + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets footnotes position in the document. + + The for the footnote in the document + + The following code example demonstrates how to specify the footnote position in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Set the footnote position at immediately beneath text + document.FootnotePosition = FootnotePosition.PrintImmediatelyBeneathText; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Set the footnote position at immediately beneath text + document.FootnotePosition = FootnotePosition.PrintImmediatelyBeneathText + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets a watermark for the document. + + A text/picture that appears behind the document + + + + + + + Gets the object that represents the background effects of the document. Read-only. + + The background effects of the document + + + + + Gets a object that represents the mail merge functionality of the document. Read-only. + + The instance used to replace the with value in the document + + + + + + Gets or sets the document protection type. + + The will prevent the document from unintentional editing. + + The following code example demonstrates how to protect the changing of document content. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //protect the document from editing + document.ProtectionType = Syncfusion.DocIO.ProtectionType.AllowOnlyReading; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'protect the document from editing + document.ProtectionType = Syncfusion.DocIO.ProtectionType.AllowOnlyReading + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets the document view type. + + A represents the display options of this in MS Word application + + + + Gets or sets a value indicating whether to throw exceptions for unsupported elements. The default is false. + + True then throw the exception for unsupported elements; otherwise, false. + + + + Gets or sets the initial footnote number of the document. + + + The following code example demonstrates how to specify the endnote number format in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Set the footnote initial number + document.InitialFootnoteNumber = 3; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Set the footnote initial number + document.InitialFootnoteNumber = 3 + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets the initial endnote number of the document. + + + The following code example demonstrates how to specify the endnote initial number in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Set the endnote initial number + document.InitialEndnoteNumber = 5; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Set the endnote initial number + document.InitialEndnoteNumber = 5 + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the collection that represents the child entities of this . Read-only. + + The child entities. + + + + Gets or sets the XHTML validation type to validate the HTML content while opening a HTML file. The Default value is + + + Currently, it is not supported in Silverlight, Universal and Windows Phone. + + + + + Gets or sets the background image of a document. + + + + + + Gets a collection that represents the variables stored in the document. Read-only. + + + Variables collection contains a Key-Value pair of variable name and its value + + + The following code snippet illustrate how to add a DocVariable field in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("First Name of the customer: "); + //Add the DocVariable field with Variable name and its type + paragraph.AppendField("FirstName", FieldType.FieldDocVariable); + paragraph = section.AddParagraph(); + paragraph.AppendText("Last Name of the customer: "); + //Add the DocVariable field with Variable name and its type + paragraph.AppendField("LastName", FieldType.FieldDocVariable); + //Add the value for variable in WordDocument.Variable collection + document.Variables.Add("FirstName", "Jeff"); + document.Variables.Add("LastName", "Smith"); + //Update the document fields + document.UpdateDocumentFields(); + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("First Name of the customer: ") + 'Add the DocVariable field with Variable name and its type + paragraph.AppendField("FirstName", FieldType.FieldDocVariable) + paragraph = section.AddParagraph() + paragraph.AppendText("Last Name of the customer: ") + 'Add the DocVariable field with Variable name and its type + paragraph.AppendField("LastName", FieldType.FieldDocVariable) + 'Add the value for variable in WordDocument.Variable collection + document.Variables.Add("FirstName", "Jeff") + document.Variables.Add("LastName", "Smith") + 'Update the document fields + document.UpdateDocumentFields() + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the document properties. Read-only. + + The instance used to specify the document version, form field shading and hyphenation properties of the document + + + + Gets a value indicating whether the document has tracked changes. Read-only. + + + True if the document has tracked changes; otherwise, false. + + + + + Gets or sets a value indicating whether edits are tracked as revision. The default is false. + + True if track changes in on; otherwise, false. + + The following code snippet shows how to track the edits as revisions in the document + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Enable the TrackChanges to track the edits as revision + document.TrackChanges = true; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Enable the TrackChanges to track the edits as revision + document.TrackChanges = True + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets a value indicating whether replace only the first occurrence. The default is false. + + True replace only the first occurrence in the document; false replace all the occurrence. + + The following code snippet illustrates how to replace the first occurrence of a particular text. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Set to replace only the first occurrence of a particular text + document.ReplaceFirst = true; + //Find the first occurrence of a particular text in the document + TextSelection selection = document.Find("contents", false, false); + //Initialize text body part + TextBodyPart bodyPart = new TextBodyPart(selection); + //Replace a particular text with the text body part + document.Replace("paragraph", bodyPart, false, true, true); + //Save and close the document + document.Save("Replace.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Set to replace only the first occurrence of a particular text + document.ReplaceFirst = True + 'Find the first occurrence of a particular text in the document + Dim selection As TextSelection = document.Find("contents", False, False) + 'Initialize text body part + Dim bodyPart As New TextBodyPart(selection) + 'Replace a particular text with the text body part + document.Replace("paragraph", bodyPart, False, True, True) + 'Save and close the document + document.Save("Replace.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets the HTML import settings for HTML to Word conversion. + + This property is not supported in MVC6. + + + + + + Gets the document save options. Read-only. + + A that represents the save options for this + + + + + Gets the revision options for the track changes in Word to PDF conversion. + + A that represents the save options for this + + The following code example demonstrates how to set the to preserve track changes in Word to PDF Conversion. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Sets revision types to preserve track changes in PDF conversion. + wordDocument.RevisionOptions.ShowMarkup = RevisionType.Insertions | RevisionType.Formatting | RevisionType.Deletions; + //Instantiation of DocToPDFConverter for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases all resources used by the object + converter.Dispose(); + //Closes the instance of document objects + wordDocument.Close(); + pdfDocument.Close(true); + + + 'Loads an existing Word document + Dim wordDocument As WordDocument = New WordDocument("Template.docx", FormatType.Docx) + 'Sets revision types to preserve track changes in PDF conversion. + wordDocument.RevisionOptions.ShowMarkup = RevisionType.Insertions Or RevisionType.Formatting Or RevisionType.Deletions + 'Instantiation of DocToPDFConverter for Word to PDF conversion + Dim converter As DocToPDFConverter = New DocToPDFConverter + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Releases all resources used by the object + converter.Dispose() + 'Closes the instance of document objects + wordDocument.Close() + pdfDocument.Close(True) + + + + + + + Gets or sets a value indicating whether to update fields in the document. + + if update fields, set to true. + + + + Gets the actual format type of the document which was loaded. While creating new document, it returns FormatType.Doc value. Read-only. + + The file format type of this + + + + Gets or sets a dictionary collections which represents the font substitution table. The key should be the font name and the value should be the alternate font name. + + The font substitution table contains an alternative font information for missing fonts in the document. + + The following code example demonstrates how to specify the alternative font information for missing fonts in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Apply the Arial font instead of the Arabic font, if the system does not contains Arabic font + document.FontSubstitutionTable.Add("Arabic", "Arial"); + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Apply the Arial font instead of the Arabic font, if the system does not contains Arabic font + document.FontSubstitutionTable.Add("Arabic", "Arial"); + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets a value indicating whether the document has macros. Read-only. + + + True if the document has macros; otherwise, false. + + + + + Gets or sets a value indicating whether to run the partial trust code. + + + True if to run partial trust code; otherwise, false. + + + + + Gets or sets a value indicating whether to disable the DateTime field updating with current date time, while opening document. + + + True to update the Date time field with DateTime.MaxValue (23:59:59.9999999 UTC, December 31, 9999 in the Gregorian calendar); otherwise, false. + + This property is added specifically to avoid DateTime difference in testing automation. + + + + Gets or sets a value indicating whether formatting is restricted or not. + + + + + Gets or sets a value indicating whether password protection is enforced or not. + + + + + Gets or sets the multiple page type. + + + + + Gets or set the number of sheets per booklet. + + + + + Gets/sets FontFamilyNameStringTable + + + + + Check whether document is comparing + + + + + Get the instance of Comparison + + + + + Check whether Field is Updating + + + + + Denotes whether the revisions should be update or not while adding or inserting a entity + + + + + Get the instance of DocxLaTeXConverter. + + + + + Gets or sets the value indicating whether the document has styles + + + + + Gets the images. + + The images. + + + + Gets the field stack. + + The field stack. + + + + Gets an instance of the class. + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets the type of the save format. + + The type of the save format. + + + + Gets a value indicating whether this instance is macro enabled. + + + true if this instance is macro enabled; otherwise, false. + + + + + Gets or sets the vba project. + + The vba project. + + + + Gets or sets the vba project signature. + + The vba project. + + + + Gets or sets the vba project signature agile. + + The vba project. + + + + Gets or sets the custom UI part container. + + The custom UI part container. + + + + Gets or sets the User customization part container. + + The custom UI part container. + + + + Gets or sets the custom XML container. + + The custom XML container. + + + + Gets or sets the vba data. + + The vba data. + + + + Gets or sets the doc events. + + The doc events. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets or Sets the password. + + The password. + + + + Gets or sets document latent styles. + + The latent styles. + + + + Gets or sets document latent styles. + + The latent styles. + + + + Gets or sets the docx package. + + The docx package. + + + This flag will be useful for importing styles behavior switching in the scenario of style exist in destination document with same name and type, but different formatting. + + Gets or sets a value indicating whether to import styles with new unique name, if style exist in destination document with same name, type and different formatting. Default value is true + + True: if import styles with same name, type and different formatting into destination document by renaming uniquely; otherwise, false. + + This property is used for defining styles import behavior in the scenario of style exist in destination document with same name and type, but different formatting. + Setting this property to true, styles with same name, type and different formatting will be imported into destination document from source document with new unique name. + Setting it to false, styles with same name, type and different formatting will not be imported and instead the document contents will use the existing matched (same name and type) style. + + + + // Creates an new instance of WordDocument class. + WordDocument srcDocument = new WordDocument(); + // Adds a section and a paragraph in the empty document. + srcDocument.EnsureMinimal(); + // Sets bold to character format of "Normal" style to differentiate source and destination document. + (srcDocument.Styles.FindByName("Normal") as WParagraphStyle).CharacterFormat.Bold = true; + // Creates an new instance of WordDocument class. + WordDocument destDocument = new WordDocument(); + // Adds a section and a paragraph in the empty document. + destDocument.EnsureMinimal(); + // Sets false value to exclude importing duplicate styles to destination document. + destDocument.ImportStyles = false; + destDocument.Sections.Add(srcDocument.LastSection.Clone()); + // Releases the resources occupied by WordDocument instance. + srcDocument.Close(); + // Saves the document in the given name and format. + destDocument.Save("Document.docx", FormatType.Docx); + // Releases the resources occupied by WordDocument instance. + destDocument.Close(); + + + ' Creates an new instance of WordDocument class. + Dim srcDocument As New WordDocument() + ' Adds a section and a paragraph in the empty document. + srcDocument.EnsureMinimal() + ' Sets bold to character format of "Normal" style to differentiate source and destination document. + TryCast(srcDocument.Styles.FindByName("Normal"), WParagraphStyle).CharacterFormat.Bold = True + ' Creates an new instance of WordDocument class. + Dim destDocument As New WordDocument() + ' Adds a section and a paragraph in the empty document. + destDocument.EnsureMinimal() + ' Sets false value to exclude importing duplicate styles to destination document. + destDocument.ImportStyles = False + destDocument.Sections.Add(srcDocument.LastSection.Clone()) + ' Releases the resources occupied by WordDocument instance. + srcDocument.Close() + ' Saves the document in the given name and format. + destDocument.Save("Document.docx", FormatType.Docx) + ' Releases the resources occupied by WordDocument instance. + destDocument.Close() + + + + + + Gets or sets a value indicating whether to import styles with new unique name, if style exist in destination document with same name and different type. Default value is false + + True: if import styles with same name and different type into destination document by renaming uniquely; otherwise, false. + + This property is used for defining styles import behavior in the scenario of style exist in destination document with same name, but different type. + Setting this property to true, styles with same name and different type will be imported into destination document from source document with new unique name. + Setting it to false, styles with same name and different typewill not be imported and instead the document contents will use default style. + + + + // Creates an new instance of WordDocument class. + WordDocument srcDocument = new WordDocument(); + // Adds a section and a paragraph in the empty document. + srcDocument.EnsureMinimal(); + // Creates a paragraph style (with name "Test") and adds into source document. + WParagraphStyle paragraphStyle = new WParagraphStyle(srcDocument); + paragraphStyle.Name = "Test"; + srcDocument.Styles.Add(paragraphStyle); + // Creates an new instance of WordDocument class. + WordDocument destDocument = new WordDocument(); + // Adds a section and a paragraph in the empty document. + destDocument.EnsureMinimal(); + // Creates a character style (with same paragraph styel name in source) and adds into destination document. + WCharacterStyle characterStyle = new WCharacterStyle(destDocument); + characterStyle.Name = "Test"; + destDocument.Styles.Add(characterStyle); + // Sets true value to include importing duplicate styles (mismatched with types) to destination document. + destDocument.ImportStylesOnTypeMismatch = true; + destDocument.Sections.Add(srcDocument.LastSection.Clone()); + // Releases the resources occupied by WordDocument instance. + srcDocument.Close(); + // Saves the document in the given name and format. + destDocument.Save("Document.docx", FormatType.Docx); + // Releases the resources occupied by WordDocument instance. + destDocument.Close(); + + + ' Creates an new instance of WordDocument class. + Dim srcDocument As New WordDocument() + ' Adds a section and a paragraph in the empty document. + srcDocument.EnsureMinimal() + ' Creates a paragraph style (with name "Test") and adds into source document. + Dim paragraphStyle As New WParagraphStyle(srcDocument) + paragraphStyle.Name = "Test" + srcDocument.Styles.Add(paragraphStyle) + ' Creates an new instance of WordDocument class. + Dim destDocument As New WordDocument() + ' Adds a section and a paragraph in the empty document. + destDocument.EnsureMinimal() + ' Creates a character style (with same paragraph styel name in source) and adds into destination document. + Dim characterStyle As New WCharacterStyle(destDocument) + characterStyle.Name = "Test" + destDocument.Styles.Add(characterStyle) + ' Sets true value to include importing duplicate styles (mismatched with types) to destination document. + destDocument.ImportStylesOnTypeMismatch = True + destDocument.Sections.Add(srcDocument.LastSection.Clone()) + ' Releases the resources occupied by WordDocument instance. + srcDocument.Close() + ' Saves the document in the given name and format. + destDocument.Save("Document.docx", FormatType.Docx) + ' Releases the resources occupied by WordDocument instance. + destDocument.Close() + + + + + + Gets or sets the default character format. + + The default char format. + + + + Gets or sets the default paragraph format. + + The default paragraph format. + + + + Gets the associated strings. + + The def para format. + + + + Gets a value indicating whether this instance is encrypted. + + + if this instance is encrypted, set to true. + + + + + Gets a value indicating whether this instance has pictures. + + + if this instance contains picture, set to true. + + + + + Gets or sets a value indicating whether [write protected]. + + true if [write protected]; otherwise, false. + + + + Gets or sets a value indicating whether to update Alternate chunk + + true update Alternate chunk ; otherwise, false. + + + + Gets/Sets the value indicates the Bookmakrk content delete operation is in progress + + true When deleting the bookmark contents ; otherwise, false. + + + + Gets the list names. + + The list names. + + + + Gets the list and its level number. + + The lists. + + + + Specifies the previous list level of a list style. + + The lists. + + + + Specifies the override style name of all the previous lists + + The lists. + + + + Specifies whether to use hanging indent as tab stop for lists in Doc to PDF lay outing. + + true if use hanging indent as tab stop for lists; otherwise, false. + + + + Specifies whether to use hanging indent as tab position in Word to PDF lay outing. + + true if use hanging indent as tab position; otherwise, false. + + + + Gets the themes settings of the document. + + The themes. + + + + Gets the compatibility settings of the Word document + + The compatibility settings. + + + + Gets/ Set the total number of alternate chunk in the document. + + The alternate chunk count. + + + + Determines whether to create base paragraph style - Normal. + Handled to avoid repeated looping, while creating base paragraph style - Normal (Recursive call). + + + + + Determines whether the Normal style is defined or not. + + + + + + Check Whether document is HTML Import to skip cloning of formFields + + + + + Skip the removing process for child items from field start to field end + + + + + Gets or sets a value indicating that the field range is adding to the collection + + + + + + + + + + Gets or sets the value indicating whether to include header in page border + + + + + Gets or sets the value indicating whether to include footer in page border + + + + + True if the document has different headers and footers + for odd-numbered and even-numbered pages. + + + + + Gets or sets the word version based on the nFib and nFibNew. + Value of nFib Word version + 0x00C0 97 create new document in OS + 0x00C1 97 + 0x00C2 97 BIDI build + 0x00D9 2000 + 0x0101 2002 + 0x010C 2003 + 0x0112 2007 + + The word version. + + + + Returns Whether the document has Table of Contents or not. + + + + + Returns the TOC element of the word document. + + + + + Gets or sets the Base path which is used to convert the relative path to absolute path. + + + + + Gets document fields. + + + + + To hold the all floating items inside the document + + + + + Gets not parsed docx properties. + + + + + Gets the list style Names in Docx and RTF parser alone + + The list styles. + + + + Gets the comment's old and new para ID + + + + + Gets a value indicating whether this instance has docx props. + + + if this instance has docx prop, set to true. + + + + + Indicates whether the document is currently closing. + + + + + + + + + + Determines whether the document contains cover page. + + + + + Gets or sets the track changes balloon count + + + + + Stores the sequence fields last values. + + + + + Comparision options for the document + + + + + Gets sub widgets + + + + + + Gets or sets the STTBF r mark. + + + The STTBF r mark. + + + + + Represents document properties + + + + + + + + + + Initializes a new instance of the class. + + The document. + + + + Sets the version. + + The version. + + + + Closes this instance. + + + + + Gets or sets a value indicating whether to apply shading on form fields. + + True if form field shading is applied, otherwise false. + + + + Gets the document version. Read-only. + + The member that specifies the document version. + + + + Gets the hyphenation settings of the document. Read-only. + + The that specifies the document hyphenation settings. + + + + Represents Hyphenation settings of the document. + + + + + Initializes a new instance of the class. + + The document. + + + + Closes this instance. + + + + + Gets or sets a value indicating whether to hyphenate the document contents automatically. The default is false. + + True if to automatically hyphenate the document contents, otherwise false. + + + + Gets or sets a value indicating whether to hyphenate words in all capital letters. The default is true. + + True if to hyphenate words in all capital letters, otherwise false. + + + + Gets or sets the amount of whitespace which can be left at the end of a line (or added to justified lines) before hyphenation measured in point. + + A float that specifies the amount of whitespace. + Hyphenation zone must be between 0.05 pt and 1584 pt. + + + + Gets or sets the maximum number of consecutive lines of text that can end with a hyphen. + + An integer that specifies the number of consecutive lines. + Consecutive hyphens limit must be between 0 and 32767. + + + + Represents the template document that is attached to the Word document. + + + The following code example demonstrates how to specify the path for the attached template document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument("Template.docx"); + //Set the path for the attached template document + document.AttachedTemplate.Path = "../Data/Attachedtemplate.dotm"; + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument("Template.docx") + 'Set the path for the attached template document + document.AttachedTemplate.Path = "../Data/Attachedtemplate.dotm" + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Initializes a new instance of the class. + + The SttbfAssoc. + + + + Gets or sets the path of the attached template document. + + The string that specifies the path to attached template document. + + + + + + + + + Gets Scheme Color + + + + + Gets format scheme + + + + + Gets Font Scheme + + + + + + + + + + Closes this instance. + + + + + + + + + + + + + + + + + + + + + + + + + Internal class font scheme theme elements + + + + + Closes this instance. + + + + + + + + + + + + + + + + + + + + Closes this instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Class represents settings of the document. + + + + + Initializes a new instance of the class. + + The document. + + + + Closes this instance. + + + + + Sets the compatibility mode for the document + + + + + + Gets the compatibility settings of the document. + + The compatibility settings. + + + + Gets or sets the compatibility mode for the document. + + The compatibility mode. + + + + Gets or sets the value indicate whether the compatibility Mode enabled while opening the Word document + + + + + Gets or sets the value indicates whether to maintain the formatting of the field result during field update. Default value is false. + + + + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Sets the maintain formatting option to the fields of the Word document + document.Settings.MaintainFormattingOnFieldUpdate = true; + //Updates the document fields + document.UpdateDocumentFields(); + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Sets the maintain formatting option to the fields of the Word document + document.Settings.MaintainFormattingOnFieldUpdate = True + 'Updates the document fields + document.UpdateDocumentFields() + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets or sets the value indicates whether to update the merge field result when field code is modified. Default value is true. + + /// + + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + //Sets whether result code must be updated when field code is modified. + document.Settings.UpdateResultOnFieldCodeChange = true; + //Modifies the merge field code. + (document.LastParagraph.ChildEntities[0] as WMergeField).FieldCode = "MERGEFIELD Employee_ID \\*MERGEFORMAT"; + //Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + 'Sets whether result code must be updated when field code is modified. + document.Settings.UpdateResultOnFieldCodeChange = True + 'Modifies the merge field code. + (document.LastParagraph.ChildEntities[0] as WMergeField).FieldCode = "MERGEFIELD Employee_ID \\*MERGEFORMAT" + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets or sets whether the entire field entities or only WField instance should be added. The default is false. + + True, if add only WField instance; Otherwise false. + + + + Gets or sets a value indicating whether to shown the background colors and images in print layout view. Default value is false. + + The DisplayBackgrounds property corresponds to the Background colors and images (Print view only) option located on the View tab of the Options dialog box. + This property is enabled automatically while setting the document background property. + + + //Load an existing Word document into DocIO instance. + WordDocument document = new WordDocument("Template.docx"); + //Set the background type of the document. + document.Background.Type = BackgroundType.Color; + //Set the background color of the document. + document.Background.Color = Color.Red; + //Sets whether background colors and images are shown when a document is displayed in print layout view. + document.Settings.DisplayBackgrounds = false; + //Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Load an existing Word document into DocIO instance. + Dim document As New WordDocument("Template.docx") + 'Set the background type of the document. + document.Background.Type = BackgroundType.Color + 'Set the background color of the document. + document.Background.Color = Color.Red + 'Sets whether background colors and images are shown when a document is displayed in print layout view. + document.Settings.DisplayBackgrounds = False + 'Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets or sets the value for hash value in document protection. + + + + + Gets or sets the value for salt value in document protection. + + + + + + + + + + Determines whether the Word document is optimized for browser. + + Default it is true. + + + + Gets or sets the destination duplicate list style names while merging two different documents. + + + + + Gets or sets the theme font languages of the current document. + + + + + Gets or sets a value indicating whether to maintain information about imported list styles in this document. Default value is false + + True: if the information about imported list styles are preserved in this document; otherwise, false. + + This property is used for defining list restart behavior and avoid importing of duplicate list styles in the scenario of cloning and merging independent elements to this document. + Setting it to true, the document preserves information about imported list styles. + Setting it to false, the document doesn't preserve any information about imported list styles. + + + The following code example demonstrates how to preserve information about imported list styles in this document. + + //Opens the source document + WordDocument sourceDocument = new WordDocument("sourceFileName.docx"); + //Opens the destination document + WordDocument destinationDocument = new WordDocument("targetFileName.docx"); + //Sets true value to maintain imported list style cache to destination document + destinationDocument.Settings.MaintainImportedListCache = true; + //Processes the body contents for each section in the Word document + foreach (WSection section in sourceDocument.Sections) + { + //Accesses the body of section where all the contents in document are apart + foreach (TextBodyItem bodyItem in section.Body.ChildEntities) + { + destinationDocument.LastSection.Body.ChildEntities.Add(bodyItem.Clone()); + } + } + //Closes the source document + sourceDocument.Close(); + //Sets false value to exclude imported list style cache to destination document + destinationDocument.Settings.MaintainImportedListCache = false; + //Saves the destination document + destinationDocument.Save("outputFileName.docx", FormatType.Docx); + //Closes the destination document + destinationDocument.Close(); + + + 'Opens the source document + Dim sourceDocument As New WordDocument(sourceFileName) + 'Opens the destination document + Dim destinationDocument As New WordDocument(targetFileName) + 'Sets true value to maintain imported list style cache to destination document + destinationDocument.Settings.MaintainImportedListCache = True + 'Processes the body contents for each section in the Word document + For Each section As WSection In sourceDocument.Sections + 'Accesses the body of section where all the contents in document are apart + For Each bodyItem As TextBodyItem In section.Body.ChildEntities + destinationDocument.LastSection.Body.ChildEntities.Add(bodyItem.Clone()) + Next + Next + 'Closes the source document + sourceDocument.Close() + 'Sets false value to exclude imported list style cache to destination document + destinationDocument.Settings.MaintainImportedListCache = False + 'Saves the destination document + destinationDocument.Save(outputFileName, FormatType.Docx) + 'Closes the destination document + destinationDocument.Close() + + + + + + Gets or sets the value indicates whether to skip the Complex format is not supported exception while opening an incrementally saved (*.doc) Word document. Default value is false + + + True: if need to skip the exception when a Word document have incremental save information while opening; otherwise, False. + + Setting the SkipIncrementalSaveValidation property as true, + skips the Complex format is not supported exception and reads the document content present in the last complete save operation alone. + The recently edited content saved as incremental save using older Microsoft Word application can't be retained. + + + //Creates new instance of WordDocument class. + WordDocument document = new WordDocument(); + //Sets flag to skip old file format exception while opening document. + document.Settings.SkipIncrementalSaveValidation = true; + //Opens an existing document from file system through. + document.Open("Template.docx", FormatType.Automatic); + //Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Creates new instance of WordDocument class. + Dim document As New WordDocument() + 'Sets flag to skip old file format exception while opening document. + document.Settings.SkipIncrementalSaveValidation = True + 'Opens an existing document from file system through. + document.Open(fileName, FormatType.Automatic) + 'Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets or sets the value of math properties. + + + + + Gets or sets a value that indicates whether to preserve embedded OLE images as normal images. Default value is false. + + + + //Creates an empty Word document instance + WordDocument document = new WordDocument(); + //Sets flag to preserve embedded Ole images as normal image while opening document + document.Settings.PreserveOleImageAsImage = true; + //Loads or opens an existing Word document + document.Open(fileName, FormatType.Automatic); + //Saves the resultant Word document + document.Save("Sample.docx", FormatType.Docx); + //Closes the Word document + document.Close(); + + + 'Creates an empty Word document instance + Dim document As New WordDocument() + 'Sets flag to preserve embedded Ole images as normal image while opening document + document.Settings.PreserveOleImageAsImage = True + 'Loads or opens an existing Word document + document.Open("Template.docx", FormatType.Automatic) + 'Saves the resultant Word document + document.Save("Sample.docx", FormatType.Docx) + 'Closes the Word document + document.Close() + + + + + + Class represents compatibility options of the document. + + + + + + + + + + + + + + + Initializes a new instance of the class. + + The document. + + + + Sets the CompatibilityOptions based on key. + + The CompatibilityOptions key. + The value. + + + + Gets the CompatibilityOptions value based on key. + + The CompatibilityOptions key. + + + + Closes this instance. + + + + + Gets or sets the with the specified key. + + + + + + Gets the properties hash. + + The properties hash. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + Parses the specified associated strings. + + The associated strings. + + + + Gets the associated strings as byte array. + + + + + + Gets or sets the attached template. + + The attached template. + + + + Gets or sets the title. + + The title. + + + + Gets or sets the subject. + + The subject. + + + + Gets or sets the key words. + + The key words. + + + + Gets or sets the author. + + The author. + + + + Gets or sets the last modified by. + + The last modified by. + + + + Gets or sets the mail merge data source. + + The mail merge data source. + + + + Gets or sets the mail merge header document. + + The mail merge header document. + + + + Gets or sets the write password. + + The write password. + + + + Represents the footnote in the word document. + + + The following code example demonstrates how to to change the default footnote separator. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Create a section + IWSection section = document.AddSection(); + //Add a paragraph to a section + IWParagraph paragraph = section.AddParagraph(); + //Append the text to paragraph + paragraph.AppendText("Working with footnotes"); + //Formatting the text + paragraph.ApplyStyle(BuiltinStyle.Heading1); + //Add a paragraph to a section + paragraph = section.AddParagraph(); + //Append the footnotes + WFootnote footnote = (WFootnote)paragraph.AppendFootnote(Syncfusion.DocIO.FootnoteType.Footnote); + WTextBody separator = document.Footnotes.Separator; + //Replace the default foot note separate by text + separator.Paragraphs[0].Text = "Footnote separator"; + //Set the footnote character format + footnote.MarkerCharacterFormat.SubSuperScript = SubSuperScript.SuperScript; + //Inserts the text into the paragraph + paragraph.AppendText("Sample content for footnotes").CharacterFormat.Bold = true; + //Add footnote text + paragraph = footnote.TextBody.AddParagraph(); + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + + End Sub + + + + + + Footnote separator. + + + + + Footnote continuation Separator. + + + + + Footnote continuation notice. + + + + + The owner Word document. + + + + + Initializes a new instance of the class. + + The object. + + + + Initializes a new instance of the class. + + The footnote. + + + + Creates a duplicate copy of the current footnote. + + The cloned object. + + + + Sets the owner. + + The document. + + + + Closes this instance. + + + + + Gets or sets the footnote separator of the document. + + The that represents the separator. + + + + Gets or sets the footnote continuation separator of the document. + + The that represents the continuation separator. + + + + Gets or sets the footnote continuation notice of the document. + + The that represents the continuation notice. + + + + Represents an endnote in the Word document. + + + The following code example demonstrates how to + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Create a section + IWSection section = document.AddSection(); + //Add a paragraph to a section + IWParagraph paragraph = section.AddParagraph(); + //Append the text to paragraph + paragraph.AppendText("Working with footnotes"); + //Formatting the text + paragraph.ApplyStyle(BuiltinStyle.Heading1); + //Add a paragraph to section + paragraph = section.AddParagraph(); + //Append the endnote + WFootnote endnote = (WFootnote)paragraph.AppendFootnote(Syncfusion.DocIO.FootnoteType.Endnote); + WTextBody separator = document.Endnotes.Separator; + //Replace the default foot note separate by text + separator.Paragraphs[0].Text = "Endnote separator"; + //Set the endnote character format + endnote.MarkerCharacterFormat.SubSuperScript = SubSuperScript.SuperScript; + //Insert the text into the paragraph + paragraph.AppendText("Sample content for endnotes").CharacterFormat.Bold = true; + //Add the footnote text + paragraph = endnote.TextBody.AddParagraph(); + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Create a section + Dim section As IWSection = document.AddSection() + 'Add a paragraph to a section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Append the text to paragraph + paragraph.AppendText("Working with footnotes") + 'Formatting the text + paragraph.ApplyStyle(BuiltinStyle.Heading1) + 'Add a paragraph to section + paragraph = section.AddParagraph() + 'Append the endnote + Dim endnote As WFootnote = DirectCast(paragraph.AppendFootnote(Syncfusion.DocIO.FootnoteType.Endnote), WFootnote) + Dim separator As WTextBody = document.Endnotes.Separator + 'Replace the default foot note separate by text + separator.Paragraphs(0).Text = "Endnote separator" + 'Set the endnote character format + endnote.MarkerCharacterFormat.SubSuperScript = SubSuperScript.SuperScript + 'Insert the text into the paragraph + paragraph.AppendText("Sample content for endnotes").CharacterFormat.Bold = True + 'Add the footnote text + paragraph = endnote.TextBody.AddParagraph() + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula") + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Endnote separator + + + + + Endnote continuation Separator + + + + + Endnote continuation notice + + + + + The owner Word document. + + + + + Initializes a new instance of the class. + + The object. + + + + Initializes a new instance of the class. + + The endnote. + + + + Creates the duplicate copy of the current endnote. + + The cloned object. + + + + Sets the owner. + + The document. + + + + Closes this instance. + + + + + Gets or sets the endnote separator of the document. + + The that represents the separator. + + + + Gets or sets the endnote continuation separator of the document. + + The that represents the continuation separator. + + + + Gets or sets the endnote continuation notice of the document. + + The that represents the continuation notice. + + + + Image downloading failed event handler + + + + This delegate is not supported in MVC6 and Xamarin platforms. + + + + Represents Image downloading failed event arguments. + + This class is not supported in MVC6 and Xamarin platforms. + + + + + Initialize ImageDownloadingFailedEventArgs + + + + + + Gets the image URI present in the input HTML. Read-only. + + The string that specifies the URI to get image. + This property is not supported in MVC6 and Xamarin platforms. + + + + Gets or sets the user name to access the protected site. + + The string that specifies the user name to get the image from protected site. + This property is not supported in MVC6 and Xamarin platforms. + + + + Gets or sets the password to access the protected site. + + The string that specifies the password to get the image from protected site. + This property is not supported in MVC6 and Xamarin platforms. + + + + Represents the method that handles ImageNodeVisited event + + + + + + + Represents the ImageNodeVisited event that occurs during importing and exporting the HTML file and also exporting as a Markdown file. + + + + + Initialize ImageNodeVisitedEventArgs + + + + + + + + Gets or sets the image URI. + + + While importing HTML, this property denotes the image URI in the input HTML file. + While exporting HTML and Markdown files, this property denotes the image URI to be saved in the output file. + + + + + + + + Execute Image downloading failed event + + + + + + + Execute Image node visited event + + + + + + + + Gets or sets a value indicating whether to consider the list style type for the corresponding list . Default value is false. + + True then considers the list style type; otherwise, false + This property will be considered only for list style type None in HTML importing + + The following code example demonstrates how to set value for IsConsiderListStyleAttribute property + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Creates instance for HTML import settings. + HTMLImportSettings hTMLImport = new HTMLImportSettings(); + //Enable the IsConsiderListStyleAttribute to consider the list style type. + hTMLImport.IsConsiderListStyleAttribute = true; + //Creates instance for Word document. + WordDocument wordDocument = new WordDocument(); + //Sets the HTML import settings for HTML to Word conversion. + wordDocument.HTMLImportSettings = hTMLImport; + //Opens the existing HTML document. + wordDocument.Open(@"InputHTML.html"); + //Save the document as Word document. + wordDocument.Save("sample.docx"); + //Close the document. + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Creates instance for HTML import settings. + Dim hTMLImport As New HTMLImportSettings() + 'Enable the IsConsiderNoneListStyle to consider the list style type. + hTMLImport.IsConsiderListStyleAttribute = True + 'Creates instance for Word document. + Dim wordDocument As New WordDocument() + 'Sets the HTML import settings for HTML to Word conversion. + WordDocument.HTMLImportSettings = hTMLImport + 'Opens the existing HTML document. + WordDocument.Open("InputHTML.html") + 'Save the document as Word document. + WordDocument.Save("sample.docx") + 'Close the document. + WordDocument.Close() + End Sub + + + + + + Some CSS properties are not considered by MS Word during HTML conversions. + At our side we maintain boolean to ensure whether to parse unsupported CSS properties or not, + for Document Editor clipboard functionality. + + + + + Gets a value indicating whether Image node visited event has been subscribed or not.. + + + True if the Image node visited event has been subscribed; otherwise, false. + + + + + Throws event when downloading of HTTP or FTP image fails from secured sites. + + This event is not supported in MVC6 and Xamarin platforms. + + + + + Represents the page setup description. + + + The following code example demonstrates how to set the page setup properties. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + //Set page setup options + section.PageSetup.Orientation = PageOrientation.Landscape; + section.PageSetup.Margins.All = 72; + section.PageSetup.Borders.LineWidth = 2; + section.PageSetup.DifferentFirstPage = true; + section.PageSetup.DifferentOddAndEvenPages = true; + section.PageSetup.FooterDistance = 42; + section.PageSetup.HeaderDistance = 52; + section.PageSetup.LineNumberingDistanceFromText = 10; + section.PageSetup.LineNumberingMode = LineNumberingMode.Continuous; + section.PageSetup.LineNumberingStartValue = 5; + section.PageSetup.LineNumberingStep = 2; + section.PageSetup.PageBorderOffsetFrom = PageBorderOffsetFrom.Text; + section.PageSetup.PageBordersApplyType = PageBordersApplyType.AllPages; + section.PageSetup.PageNumberStyle = PageNumberStyle.RomanUpper; + section.PageSetup.PageSize = new SizeF(612, 792); + section.PageSetup.PageStartingNumber = 1; + section.PageSetup.VerticalAlignment = PageAlignment.Top; + //Add the page number field to even footer of the document + IWParagraph paragraph = section.HeadersFooters.EvenFooter.AddParagraph(); + paragraph.AppendText("PageNumber_EvenPageFooter "); + paragraph.AppendField("Page", FieldType.FieldPage); + //Add the page number field to odd footer of the document + paragraph = section.HeadersFooters.OddFooter.AddParagraph(); + paragraph.AppendText("PageNumber_OddPageFooter "); + paragraph.AppendField("Page", FieldType.FieldPage); + //Add the page number field to first footer of the document + paragraph = section.HeadersFooters.FirstPageFooter.AddParagraph(); + //Add page number field to the document + paragraph.AppendText("PageNumber_FirstPageFooter "); + paragraph.AppendField("Page", FieldType.FieldPage); + //Add a paragraph to section + paragraph = section.AddParagraph(); + //Append the text to the created paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"); + paragraph = section.AddParagraph(); + //Append the text to the created paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"); + paragraph.AppendBreak(Syncfusion.DocIO.DLS.BreakType.PageBreak); + paragraph = section.AddParagraph(); + //Append the text to the created paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"); + paragraph = section.AddParagraph(); + //Append the text to the created paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"); + paragraph.AppendBreak(Syncfusion.DocIO.DLS.BreakType.PageBreak); + paragraph = section.AddParagraph(); + //Append the text to the created paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"); + paragraph = section.AddParagraph(); + //Append the text to the created paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + 'Set page setup options + section.PageSetup.Orientation = PageOrientation.Landscape + section.PageSetup.Margins.All = 72 + section.PageSetup.Borders.LineWidth = 2 + section.PageSetup.DifferentFirstPage = True + section.PageSetup.DifferentOddAndEvenPages = True + section.PageSetup.FooterDistance = 42 + section.PageSetup.HeaderDistance = 52 + section.PageSetup.LineNumberingDistanceFromText = 10 + section.PageSetup.LineNumberingMode = LineNumberingMode.Continuous + section.PageSetup.LineNumberingStartValue = 5 + section.PageSetup.LineNumberingStep = 2 + section.PageSetup.PageBorderOffsetFrom = PageBorderOffsetFrom.Text + section.PageSetup.PageBordersApplyType = PageBordersApplyType.AllPages + section.PageSetup.PageNumberStyle = PageNumberStyle.RomanUpper + section.PageSetup.PageSize = New SizeF(612, 792) + section.PageSetup.PageStartingNumber = 1 + section.PageSetup.VerticalAlignment = PageAlignment.Top + 'Add the page number field to even footer of the document + Dim paragraph As IWParagraph = section.HeadersFooters.EvenFooter.AddParagraph() + paragraph.AppendText("PageNumber_EvenPageFooter ") + paragraph.AppendField("Page", FieldType.FieldPage) + 'Add the page number field to odd footer of the document + paragraph = section.HeadersFooters.OddFooter.AddParagraph() + paragraph.AppendText("PageNumber_OddPageFooter ") + paragraph.AppendField("Page", FieldType.FieldPage) + 'Add the page number field to first footer of the document + paragraph = section.HeadersFooters.FirstPageFooter.AddParagraph() + 'Add page number field to the document + paragraph.AppendText("PageNumber_FirstPageFooter ") + paragraph.AppendField("Page", FieldType.FieldPage) + 'Add a paragraph to section + paragraph = section.AddParagraph() + 'Append the text to the created paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula") + paragraph = section.AddParagraph() + 'Append the text to the created paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula") + paragraph.AppendBreak(Syncfusion.DocIO.DLS.BreakType.PageBreak) + paragraph = section.AddParagraph() + 'Append the text to the created paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula") + paragraph = section.AddParagraph() + 'Append the text to the created paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula") + paragraph.AppendBreak(Syncfusion.DocIO.DLS.BreakType.PageBreak) + paragraph = section.AddParagraph() + 'Append the text to the created paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula") + paragraph = section.AddParagraph() + 'Append the text to the created paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula") + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Limit number of converting arabic to \"A\" format. + + + + + Index of A char in the ASCII table. + + + + + Properties key + + + + + Initializes a new instance of the class. + + The sec. + + + + Sets the property value for page setup property. + + Name of the property. + Value of the property. + + + + Initializes page setup for .docx format + + + + + Compares the current section properties with another section properties + + The paragraph format + + + + Inserts the page numbers. + + True to insert the page number at the top of the page; False to insert the page number at the bottom of the page. + The horizontal alignment of the page number. + + The following code example demonstrates how to insert page number. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add the section into Word document + IWSection section = document.AddSection(); + section.PageSetup.PageStartingNumber = 1; + section.PageSetup.RestartPageNumbering = true; + section.PageSetup.PageNumberStyle = PageNumberStyle.Arabic; + section.PageSetup.InsertPageNumbers(false, PageNumberAlignment.Center); + //Add the paragraph + IWParagraph paragraph = section.AddParagraph(); + //Append the text to the created paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add the section into Word document + Dim section As IWSection = document.AddSection() + section.PageSetup.PageStartingNumber = 1 + section.PageSetup.RestartPageNumbering = True + section.PageSetup.PageNumberStyle = PageNumberStyle.Arabic + section.PageSetup.InsertPageNumbers(False, PageNumberAlignment.Center) + 'Add the paragraph + Dim paragraph As IWParagraph = section.AddParagraph() + 'Append the text to the created paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula") + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + + + + + + + + + + + + + Adds letter instead of number. + + String builder object. + Number to be converted to letter. + + + + Utility metnod. Helps to convert arabic number to \"A\" format. + + Arabic number. + Sequence of number. + + + + + + + + + + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Registers child objects in XDSL holder. + + + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + Clones itself. + + + + + + Closes the item. + + + + + Clone page size + + PageSize + + + + Sets the property value. + + The property key. + The value. + + + + Gets the property value. + + The prop key. + + + + + Ensures the composites. + + + + + Get the DefValues for the key. + + + + + + + Returns the default values. + + + The integer that specifies the key. + An object that specifies the default value. + + + + Gets / sets endnote numbering format + + + + + Gets / sets footnote numbering format + + + + + Gets / sets the restart index for endnote + + + + + Gets / sets the restart index for footnotes + + + + + Gets / sets footnote position in the document + + + + + Gets / sets endnote position in the document + + + + + Gets / sets the initial footnote number + + + + + Gets / sets the initial endnote number + + + + + Gets or sets the length of the auto tab. + + The length of the auto tab. + "This property has been deprecated. Use the DefaultTabWidth property of WordDocument class to set default tab width for the document. + + + + Gets or sets page size in points. + + + + + Gets or sets the orientation of the page. + + + + + Gets sets the vertical alignment of text on each page in a document or section. + + + + + Gets or sets the distance (in points) between the all four edge of the page and the all four boundary of the body text. + + + + + Gets or sets the distance (in points) between the header and the top of the page. + + + + + Gets or sets the distance (in points) between the footer and the bottom of the page. + + + + + Gets width of client area. Read-only. + + float value represents the text rendering area width. + + + + Gets or sets a value indicating whether a different header or footer is used on the first page. The default is false + + True if a different header or footer is used on the first page; otherwise, false + + + + Gets or sets a value indicating whether a different header or footer is used on the odd and even pages. The default is false + + True if a different header or footer is used on the odd and even pages; otherwise, false + + + + Gets or sets the way line numbering runs� that is, whether it starts over at the beginning of a new page or section or runs continuously. + + + The following code example illustrates how to add a line number for a section. + + //Open existing Word document. + WordDocument document = new WordDocument("Sample.docx"); + //Iterate each section + foreach (WSection section in document.Sections) + { + //Set the Line numbering mode for the Particular Section. + section.PageSetup.LineNumberingMode = LineNumberingMode.Continuous; + } + //Save the resultant Word document. + document.Save("Sample.docx"); + //Close the document instance. + document.Close(); + + + //Open existing Word document. + Dim document As New WordDocument("Sample.docx") + //Iterate each section + For Each section As WSection In document.Sections + //Set the Line Numbering Mode for the Particular Section. + section.PageSetup.LineNumberingMode = LineNumberingMode.Continuous + Next + //Save the resultant Word document. + document.Save("Sample.docx") + //Close the document instance. + document.Close() + + + + + + Gets or sets the numeric increment for line numbers. For example, if the CountBy property is set to 5, every fifth line will display the line number. + + + The following code example illustrates how to add a line number with step value for a section. + + //Open existing Word document. + WordDocument document = new WordDocument("Sample.docx"); + //Iterate each section + foreach (WSection section in document.Sections) + { + //Set the line numbering mode for the Particular section. + section.PageSetup.LineNumberingMode = LineNumberingMode.Continuous; + //Set the Step value for the LineNumberingMode. + section.PageSetup.LineNumberingStep=2; + } + //Save the resultant Word document. + document.Save("Sample.docx"); + //Close the document instance. + document.Close(); + + + //Open existing Word document. + Dim document As New WordDocument("Sample.docx") + //Iterate each section + For Each section As WSection In document.Sections + //Set the line numbering mode for the Particular section. + section.PageSetup.LineNumberingMode = LineNumberingMode.Continuous + //Set the Step value for the LineNumberingMode. + section.PageSetup.LineNumberingStep = 2 + Next + //Save the resultant Word document. + document.Save("Sample.docx") + //Close the document instance. + document.Close() + + + + + + Gets or sets the starting line number. + + + The following code example illustrates how to add a line number with start value for a section. + + //Open existing Word document. + WordDocument document = new WordDocument("Sample.docx"); + //Iterate each section + foreach (WSection section in document.Sections) + { + //Set the line numbering mode for the Particular Section. + section.PageSetup.LineNumberingMode = LineNumberingMode.Continuous; + //Set the Starting value for the LineNumberingMode. + section.PageSetup.LineNumberingStartValue = 100; + } + //Save the resultant Word document. + document.Save("Sample.docx"); + //Close the document instance. + document.Close(); + + + //Open existing Word document. + Dim document As New WordDocument("Sample.docx") + //Iterate each section + For Each section As WSection In document.Sections + //Set the line numbering mode for the Particular Section. + section.PageSetup.LineNumberingMode = LineNumberingMode.Continuous + //Set the Starting Value for the LineNumbering Mode. + section.PageSetup.LineNumberingStartValue = 100 + Next + //Save the resultant Word document. + document.Save("Sample.docx") + //Close the document instance. + document.Close() + + + + + + Gets or sets the distance (in points) between the right edge of line numbers and the left edge of the document text. + + + The following code example illustrates how to add a line number and its distance from margins of the document for a section. + + //Open existing Word document. + WordDocument document = new WordDocument("Sample.docx"); + //Iterate each section + foreach (WSection section in document.Sections) + { + //Set the line numbering mode for the particular section. + section.PageSetup.LineNumberingMode = LineNumberingMode.Continuous; + //Set the Distance value for the LineNumbering Mode. + section.PageSetup.LineNumberingDistanceFromText = 55.7f; + } + //Save the resultant Word document. + document.Save("Sample.docx"); + //Close the document instance. + document.Close(); + + + //Open existing Word document. + Dim document As New WordDocument("Sample.docx") + //Iterate each section + For Each section As WSection In document.Sections + //Set the line numbering mode for the particular section. + section.PageSetup.LineNumberingMode = LineNumberingMode.Continuous + //Set the Distance value for the LineNumbering Mode. + section.PageSetup.LineNumberingDistanceFromText = 55.7F + Next + //Save the resultant Word document. + document.Save("Sample.docx") + //Close the document instance. + document.Close() + + + + + + Gets or sets the value that determine on which pages border is applied. + + + + + Gets or sets the position of page border. + + + + + Gets or sets a value indicating whether the current page border is the front page border. The default is true. + + True if the current page border is front page; otherwise, false. + + + + Gets the page border. Read-only. + + The collection represents the left, right, top and bottom borders of the page + + + + Gets or sets a value indication whether section contains right-to-left text. The default is false. + + True if the section contains right-to-left text; otherwise, false + + + + Get/set Equal column width property. + + + + + + Gets or sets the page number style. + + + + + Gets or sets the starting page number. + + The page starting number. + + + + Gets or sets a value indicating whether to restart page numbering. + + + True if restart page numbering; otherwise, false. + + + + + Gets or sets the page line pitch. + + The line pitch. + + + + Gets or sets the type of the pitch. + + The type of the pitch. + + + + Gets or sets a value indicating whether to draw lines between columns. + + + if draw lines between columns, set to true. + + + + + + Gets the page number setup. Read-only. + + + + + + Gets or sets value for first paper source of the current section in paper settings + + + The following code example illustrates how to add a line number with start value for a section. + + //Creates an instance of WordDocument. + WordDocument document = new WordDocument(); + //Adds a new section into the Word document. + IWSection section= document.AddSection(); + //Sets the PrinterPaperTray value for FirstPageTray in pagesetup options. + section.PageSetup.FirstPageTray = PrinterPaperTray.EnvelopeFeed; + //Adds a new simple paragraph into the section. + IWParagraph paragraph = section.AddParagraph(); + //Adds new text to the paragraph. + paragraph.AppendText("Added paper source"); + //Saves the resultant Word document. + document.Save("Sample.docx"); + //Closes the document. + document.Close(); + + + //Creates an instance of WordDocument. + Dim document As WordDocument = New WordDocument() + //Adds a new section into the Word document. + Dim section As IWSection = document.AddSection() + //Sets the PrinterPaperTray value for FirstPageTray in pagesetup options. + section.PageSetup.FirstPageTray = PrinterPaperTray.EnvelopeFeed + //Adds a new simple paragraph into the section. + Dim paragraph As IWParagraph = section.AddParagraph() + //Adds new text to the paragraph. + paragraph.AppendText("Added paper source") + //Saves the resultant Word document. + document.Save("Sample.docx") + //Closes the document. + document.Close() + + + + + + Gets or sets value for other paper source of the current section in paper settings + + + The following code example illustrates how to add a line number with start value for a section. + + //Creates an instance of WordDocument. + WordDocument document = new WordDocument(); + //Adds a new section into the Word document. + IWSection section= document.AddSection(); + //Sets the PrinterPaperTray value for OtherPagesTray in pagesetup options. + section.PageSetup.OtherPagesTray = PrinterPaperTray.MiddleBin; + //Adds a new simple paragraph into the section. + IWParagraph paragraph = section.AddParagraph(); + //Adds new text to the paragraph. + paragraph.AppendText("Added paper source"); + //Saves the resultant Word document. + document.Save("Sample.docx"); + //Closes the document. + document.Close(); + + + //Creates an instance of WordDocument. + Dim document As WordDocument = New WordDocument() + //Adds a new section into the Word document. + Dim section As IWSection = document.AddSection() + //Sets the PrinterPaperTray value for OtherPagesTray in pagesetup options. + section.PageSetup.OtherPagesTray = PrinterPaperTray.MiddleBin + //Adds a new simple paragraph into the section. + Dim paragraph As IWParagraph = section.AddParagraph() + //Adds new text to the paragraph. + paragraph.AppendText("Added paper source") + //Saves the resultant Word document. + document.Save("Sample.docx") + //Closes the document. + document.Close() + + + + + + Gets or sets value for Number of columns. + + + + + + Gets or sets value for Columnspace. + + + + + Represents the page numbers in the Word document. + + + The following code example demonstrates how to chapter numbering in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add the section into Word document + IWSection section = document.AddSection(); + //Add the page number to document + section.PageSetup.PageStartingNumber = 1; + section.PageSetup.RestartPageNumbering = true; + section.PageSetup.PageNumberStyle = PageNumberStyle.Arabic; + //Specify the chapter number for heading 1 + section.PageSetup.PageNumbers.HeadingLevelForChapter = HeadingLevel.Heading1; + //SPecify t he chapter number and page number separator + section.PageSetup.PageNumbers.ChapterPageSeparator = ChapterPageSeparatorType.Colon; + //Add a footer paragraph text to the document + IWParagraph paragraph = section.HeadersFooters.Footer.AddParagraph(); + paragraph.ParagraphFormat.Tabs.AddTab(523f, TabJustification.Right, Syncfusion.DocIO.DLS.TabLeader.NoLeader); + //Add text for the footer paragraph + paragraph.AppendText("Copyright Northwind Inc. 2001 - 2024"); + //Add page number field to the document + paragraph.AppendText("\tPage "); + paragraph.AppendField("Page", FieldType.FieldPage); + //Add the paragraph to the text body of the section + paragraph = section.AddParagraph(); + paragraph.AppendText("First Title with Heading 1 Style"); + //Apply Heading 1 built-in style + paragraph.ApplyStyle(BuiltinStyle.Heading1); + WParagraphStyle paraStyle = document.Styles.FindByName("Heading 1") as WParagraphStyle; + //Add the number format list for the Heading 1 style + paraStyle.ListFormat.ApplyDefNumberedStyle(); + paraStyle.ListFormat.CurrentListLevel.PatternType = ListPatternType.UpLetter; + //Add the paragraph + paragraph = section.AddParagraph(); + //Append the text to the created paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"); + //Add the page break + paragraph.AppendBreak(Syncfusion.DocIO.DLS.BreakType.PageBreak); + //Add the another paragraph to section + paragraph = section.AddParagraph(); + paragraph.AppendText("Second Title with Heading 1 Style"); + //Apply Heading 1 built-in style + paragraph.ApplyStyle(BuiltinStyle.Heading1); + //Add the paragraph + paragraph = section.AddParagraph(); + //Append the text to the created paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add the section into Word document + Dim section As IWSection = document.AddSection() + 'Add the page number to document + section.PageSetup.PageStartingNumber = 1 + section.PageSetup.RestartPageNumbering = True + section.PageSetup.PageNumberStyle = PageNumberStyle.Arabic + 'Specify the chapter number for heading 1 + section.PageSetup.PageNumbers.HeadingLevelForChapter = HeadingLevel.Heading1 + 'SPecify t he chapter number and page number separator + section.PageSetup.PageNumbers.ChapterPageSeparator = ChapterPageSeparatorType.Colon + 'Add a footer paragraph text to the document + Dim paragraph As IWParagraph = section.HeadersFooters.Footer.AddParagraph() + paragraph.ParagraphFormat.Tabs.AddTab(523F, TabJustification.Right, Syncfusion.DocIO.DLS.TabLeader.NoLeader) + 'Add text for the footer paragraph + paragraph.AppendText("Copyright Northwind Inc. 2001 - 2024") + 'Add page number field to the document + paragraph.AppendText(vbTab & "Page ") + paragraph.AppendField("Page", FieldType.FieldPage) + 'Add the paragraph to the text body of the section + paragraph = section.AddParagraph() + paragraph.AppendText("First Title with Heading 1 Style") + 'Apply Heading 1 built-in style + paragraph.ApplyStyle(BuiltinStyle.Heading1) + Dim paraStyle As WParagraphStyle = TryCast(document.Styles.FindByName("Heading 1"), WParagraphStyle) + 'Add the number format list for the Heading 1 style + paraStyle.ListFormat.ApplyDefNumberedStyle() + paraStyle.ListFormat.CurrentListLevel.PatternType = ListPatternType.UpLetter + 'Add the paragraph + paragraph = section.AddParagraph() + 'Append the text to the created paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula") + 'Add the page break + paragraph.AppendBreak(Syncfusion.DocIO.DLS.BreakType.PageBreak) + 'Add the another paragraph to section + paragraph = section.AddParagraph() + paragraph.AppendText("Second Title with Heading 1 Style") + 'Apply Heading 1 built-in style + paragraph.ApplyStyle(BuiltinStyle.Heading1) + 'Add the paragraph + paragraph = section.AddParagraph() + 'Append the text to the created paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula") + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Initialize key for the properties. + + + + + Creates duplicate copy of the page number. + + The reference to the newly created . + + + + Sets the property value. + + The property key. + The value. + + + + Compares the current section properties with another section properties + + The paragraph format + + + + Gets the property value. + + The prop key. + + + + + Initializes a new instance of class. + + + + + Return the default values for the property. + + + + + + + Gets or sets the separator between chapter number and page number. + + + The member that specifies the numbering separator. + + + + + Gets or sets the heading level to include chapter number along with page number. + + + The member that specifies the heading level of the chapter. + + + + + Represents the paragraph of text in the Word document. + + + + + Represents a paragraph inside a Section. + + + + + Represents style holders + + + + + Applies a new style. + + The string that represents the style name. + Specified style must exists in Document.Styles collection + + + + Applies the built-in style. + + The member that specifies the built-in style. + + + + Gets the style name. + + The string that represents the style name. + + + + Applies the style with the specified name to the paragraph. + + The string that represents the style name. + The specified style must exists in collection. + + + + Applies the specified built-in style to the paragraph. + + The member that specifies the style. + + + + Appends the specified text to the end of the paragraph. + + The string that specifies the text to be appended. + The instance that represents the newly added text. + The following example illustrates how to append text to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new text to the paragraph + IWTextRange text = paragraph.AppendText("A new text is added to the paragraph."); + text.CharacterFormat.FontSize = 14; + text.CharacterFormat.Bold = true; + text.CharacterFormat.TextColor = Color.Green; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new text to the paragraph + Dim text As IWTextRange = paragraph.AppendText("A new text is added to the paragraph.") + text.CharacterFormat.FontSize = 14 + text.CharacterFormat.Bold = True + text.CharacterFormat.TextColor = Color.Green + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + The following example illustrates how to append inline content control to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new inline control to the paragraph + IInlineContentControl inlineControl = paragraph.AppendInlineContentControl(ContentControlType.RichText); + WTextRange controlText = new WTextRange(document); + controlText.CharacterFormat.Bold = true; + controlText.CharacterFormat.TextColor = Color.Green; + controlText.Text = "Inline content control inserted."; + //Add text range to the control added + inlineControl.ParagraphItems.Add(controlText); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new inline control to the paragraph + Dim inlineControl As IInlineContentControl = paragraph.AppendInlineContentControl(ContentControlType.RichText) + Dim textRange As New WTextRange(document) + textRange.CharacterFormat.Bold = True + textRange.CharacterFormat.TextColor = Color.Green + textRange.Text = "Inline content control inserted." + 'Add text range to the control added + inlineControl.ParagraphItems.Add(textRange) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends the specified image to the end of paragraph. + + The to be added. + The instance that represents the newly added image. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin applications. + The following example illustrates how to append image to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add image to the paragraph + IWPicture picture = paragraph.AppendPicture(Image.FromFile("Image.png")); + //Set height and width for the image + picture.Height = 100; + picture.Width = 100; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add image to the paragraph + Dim picture As IWPicture = paragraph.AppendPicture(Image.FromFile("Image.png")) + 'Set height and width for the image + picture.Height = 100 + picture.Width = 100 + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends the image specified by the array to the end of paragraph. + + The array of the image to be added. + The instance that represents the newly added image. + The following example illustrates how to append image to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph firstParagraph = section.AddParagraph(); + //Get the image and convert to byte array. + Image image = Image.FromFile("Image.png"); + MemoryStream stream = new MemoryStream(); + image.Save(stream, System.Drawing.Imaging.ImageFormat.Png); + byte[] imageBytes = stream.ToArray(); + //Add image to the paragraph + IWPicture picture = firstParagraph.AppendPicture(imageBytes); + //Set height and width for the image + picture.Height = 100; + picture.Width = 100; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim firstParagraph As IWParagraph = section.AddParagraph() + 'Get the image and convert to byte array. + Dim image__1 As Image = Image.FromFile("Image.png") + Dim stream As New MemoryStream() + image__1.Save(stream, System.Drawing.Imaging.ImageFormat.Png) + Dim imageBytes As Byte() = stream.ToArray() + 'Add image to the paragraph + Dim picture As IWPicture = firstParagraph.AppendPicture(imageBytes) + 'Set height and width for the image + picture.Height = 100 + picture.Width = 100 + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + The following example illustrates how to append image to the paragraph. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph firstParagraph = section.AddParagraph(); + //Get the image as byte array. + byte[] imageBytes = File.ReadAllBytes("Image.png"); + //Get the SVG image as byte array. + byte[] svgData = File.ReadAllBytes("Image.svg"); + //Add SVG image to the paragraph + IWPicture picture = firstParagraph.AppendPicture(svgData, imageBytes); + //Set height and width for the image + picture.Height = 100; + picture.Width = 100; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim firstParagraph As IWParagraph = section.AddParagraph() + 'Get the png image as byte array. + Dim imageBytes As Byte() = File.ReadAllBytes("Image.png") + 'Get the SVG image as byte array. + Dim svgData As Byte() = File.ReadAllBytes("Image.svg") + 'Add SVG image to the paragraph + Dim picture As IWPicture = firstParagraph.AppendPicture(svgData, imageBytes); + 'Set height and width for the image + picture.Height = 100 + picture.Width = 100 + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Appends a chart to the end of the paragraph with the specified data, width and height. + + The two-dimensional array that specifies the data for chart. + The float that represents the width for chart. + The float that represents the height for chart. + The instance that represents the newly added chart. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform and Xamarin applications. + The following example illustrates how to append new chart to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Input data for chart + object[][] data = new object[6][]; + for (int i = 0; i < 6; i++) + data[i] = new object[3]; + data[0][0] = ""; + data[1][0] = "Gravad lax"; + data[2][0] = "Louisiana Hot spiced Okara"; + data[3][0] = "Mascarpone Fabioli"; + data[4][0] = "Wimmers gute SemmelKnodel"; + data[5][0] = "Maxilaku"; + data[0][1] = "Sum of Purchases"; + data[1][1] = 286; + data[2][1] = 680; + data[3][1] = 288; + data[4][1] = 200; + data[5][1] = 731; + data[0][2] = "Sum of Future Expenses"; + data[1][2] = 1300; + data[2][2] = 700; + data[3][2] = 1280; + data[4][2] = 1200; + data[5][2] = 2660; /// + //Create and Append chart to the paragraph + WChart chart = paragraph.AppendChart(data, 470, 300); + //Set chart type and title + chart.ChartTitle = "Purchase Details"; + chart.ChartTitleArea.FontName = "Calibri"; + chart.ChartTitleArea.Size = 14; + chart.ChartArea.Border.LinePattern = OfficeChartLinePattern.None; + //Set series type + chart.Series[0].SerieType = OfficeChartType.Line_Markers; + chart.Series[1].SerieType = OfficeChartType.Bar_Clustered; + chart.PrimaryCategoryAxis.Title = "Products"; + chart.PrimaryValueAxis.Title = "In Dollars"; + //Set position of legend + chart.Legend.Position = OfficeLegendPosition.Bottom; + //Save the document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Input data for chart + Dim data As Object()() = New Object(5)() {} + For i As Integer = 0 To 5 + data(i) = New Object(2) {} + Next + data(0)(0) = "" + data(1)(0) = "Gravad lax" + data(2)(0) = "Louisiana Hot spiced Okara" + data(3)(0) = "Mascarpone Fabioli" + data(4)(0) = "Wimmers gute SemmelKnodel" + data(5)(0) = "Maxilaku" + data(0)(1) = "Sum of Purchases" + data(1)(1) = 286 + data(2)(1) = 680 + data(3)(1) = 288 + data(4)(1) = 200 + data(5)(1) = 731 + data(0)(2) = "Sum of Future Expenses" + data(1)(2) = 1300 + data(2)(2) = 700 + data(3)(2) = 1280 + data(4)(2) = 1200 + data(5)(2) = 2660 + 'Create and Append chart to the paragraph + Dim chart As WChart = paragraph.AppendChart(data, 470, 300) + 'Set chart type and title + chart.ChartTitle = "Purchase Details" + chart.ChartTitleArea.FontName = "Calibri" + chart.ChartTitleArea.Size = 14 + chart.ChartArea.Border.LinePattern = OfficeChartLinePattern.None + 'Set series type + chart.Series(0).SerieType = OfficeChartType.Line_Markers + chart.Series(1).SerieType = OfficeChartType.Bar_Clustered + chart.PrimaryCategoryAxis.Title = "Products" + chart.PrimaryValueAxis.Title = "In Dollars" + 'Set position of legend + chart.Legend.Position = OfficeLegendPosition.Bottom + 'Save the document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends chart to the end of the paragraph with the specified width and height. + + The float that represents the width for chart. + The float that represents the height for chart. + The instance that represents the newly added chart. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform and Xamarin applications. + The following example illustrates how to append new chart to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Create and Append chart to the paragraph + WChart chart = paragraph.AppendChart(446, 270); + //Set chart type + chart.ChartType = OfficeChartType.Pie; + //Set chart title + chart.ChartTitle = "Best Selling Products"; + chart.ChartTitleArea.FontName = "Calibri"; + chart.ChartTitleArea.Size = 14; + //Set data for chart + chart.ChartData.SetValue(1, 1, ""); + chart.ChartData.SetValue(1, 2, "Sales"); + chart.ChartData.SetValue(2, 1, "Cote de Blaye"); + chart.ChartData.SetValue(2, 2, 141.396); + chart.ChartData.SetValue(3, 1, "Thuringer Rostbratwurst"); + chart.ChartData.SetValue(3, 2, 80.368); + chart.ChartData.SetValue(4, 1, "Raclette Courdavault"); + chart.ChartData.SetValue(4, 2, 71.155); + chart.ChartData.SetValue(5, 1, "Tarte au sucre"); + chart.ChartData.SetValue(5, 2, 47.234); + chart.ChartData.SetValue(6, 1, "Camembert Pierrot"); + chart.ChartData.SetValue(6, 2, 46.825); + chart.ChartData.SetValue(7, 1, "Gnocchi di nonna Alice"); + chart.ChartData.SetValue(7, 2, 42.593); + chart.ChartData.SetValue(8, 1, "Manjimup Dried Apples"); + chart.ChartData.SetValue(8, 2, 41.819); + chart.ChartData.SetValue(9, 1, "Alice Mutton"); + chart.ChartData.SetValue(9, 2, 32.698); + chart.ChartData.SetValue(10, 1, "Carnarvon Tigers"); + chart.ChartData.SetValue(10, 2, 29.171); + chart.ChartData.SetValue(11, 1, "R�ssle Sauerkraut."); + chart.ChartData.SetValue(11, 2, 25.696); + //Create a new chart series with the name �Sales� + IOfficeChartSerie pieSeries = chart.Series.Add("Sales"); + pieSeries.Values = chart.ChartData[2, 2, 11, 2]; + //Set data label + pieSeries.DataPoints.DefaultDataPoint.DataLabels.IsValue = true; + pieSeries.DataPoints.DefaultDataPoint.DataLabels.Position = OfficeDataLabelPosition.Outside; + //Set background color + chart.ChartArea.Fill.ForeColor = Color.FromArgb(242, 242, 242); + chart.PlotArea.Fill.ForeColor = Color.FromArgb(242, 242, 242); + chart.ChartArea.Border.LinePattern = OfficeChartLinePattern.None; + //Set category labels + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 11, 1]; + //Save the document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Create and Append chart to the paragraph + Dim chart As WChart = paragraph.AppendChart(446, 270) + 'Set chart type + chart.ChartType = OfficeChartType.Pie + 'Set chart title + chart.ChartTitle = "Best Selling Products" + chart.ChartTitleArea.FontName = "Calibri" + chart.ChartTitleArea.Size = 14 + 'Set data for chart + chart.ChartData.SetValue(1, 1, "") + chart.ChartData.SetValue(1, 2, "Sales") + chart.ChartData.SetValue(2, 1, "Cote de Blaye") + chart.ChartData.SetValue(2, 2, 141.396) + chart.ChartData.SetValue(3, 1, "Thuringer Rostbratwurst") + chart.ChartData.SetValue(3, 2, 80.368) + chart.ChartData.SetValue(4, 1, "Raclette Courdavault") + chart.ChartData.SetValue(4, 2, 71.155) + chart.ChartData.SetValue(5, 1, "Tarte au sucre") + chart.ChartData.SetValue(5, 2, 47.234) + chart.ChartData.SetValue(6, 1, "Camembert Pierrot") + chart.ChartData.SetValue(6, 2, 46.825) + chart.ChartData.SetValue(7, 1, "Gnocchi di nonna Alice") + chart.ChartData.SetValue(7, 2, 42.593) + chart.ChartData.SetValue(8, 1, "Manjimup Dried Apples") + chart.ChartData.SetValue(8, 2, 41.819) + chart.ChartData.SetValue(9, 1, "Alice Mutton") + chart.ChartData.SetValue(9, 2, 32.698) + chart.ChartData.SetValue(10, 1, "Carnarvon Tigers") + chart.ChartData.SetValue(10, 2, 29.171) + chart.ChartData.SetValue(11, 1, "R�ssle Sauerkraut.") + 'Create a new chart series with the name �Sales� + Dim pieSeries As IOfficeChartSerie = chart.Series.Add("Sales") + pieSeries.Values = chart.ChartData(2, 2, 11, 2) + 'Set data label + pieSeries.DataPoints.DefaultDataPoint.DataLabels.IsValue = True + pieSeries.DataPoints.DefaultDataPoint.DataLabels.Position = OfficeDataLabelPosition.Outside + 'Set background color + chart.ChartArea.Fill.ForeColor = Color.FromArgb(242, 242, 242) + chart.PlotArea.Fill.ForeColor = Color.FromArgb(242, 242, 242) + chart.ChartArea.Border.LinePattern = OfficeChartLinePattern.None + 'Set category labels + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData(2, 1, 11, 1) + 'Save the document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends chart to the end of the paragraph from the excel file with specified sheet number, range of data, width, and height. + + The excel stream that has data for chart [Excel stream should be "*.xlsx" format]. + The integer represents the worksheet number that has data for chart. + The string represents the data range in the worksheet from which the chart is to be created. + The float that represents the width for chart. + The float that represents the height for chart. + The instance that represents the newly added chart. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform and Xamarin applications. + The following example illustrates how to append new chart to the paragraph using the excel stream. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Load the excel file as stream + Stream excelStream = File.OpenRead("Excel_Template.xlsx"); + //Create and Append chart to the paragraph with excel stream as parameter + WChart chart = paragraph.AppendChart(excelStream, 1, "B2:C6", 470, 300); + //Set chart type and title + chart.ChartType = OfficeChartType.Column_Clustered; + chart.ChartTitle = "Purchase Details"; + chart.ChartTitleArea.FontName = "Calibri"; + chart.ChartTitleArea.Size = 14; + chart.ChartArea.Border.LinePattern = OfficeChartLinePattern.None; + //Set name to chart series + chart.Series[0].Name = "Sum of Purchases"; + chart.Series[1].Name = "Sum of Future Expenses"; + chart.PrimaryCategoryAxis.Title = "Products"; + chart.PrimaryValueAxis.Title = "In Dollars"; + //Set position of legend + chart.Legend.Position = OfficeLegendPosition.Bottom; + //Save the document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Load the excel file as stream + Dim excelStream As Stream = File.OpenRead("Excel_Template.xlsx") + 'Create and Append chart to the paragraph with excel stream as parameter + Dim chart As WChart = paragraph.AppendChart(excelStream, 1, "B2:C6", 470, 300) + 'Set chart type and title + chart.ChartType = OfficeChartType.Column_Clustered + chart.ChartTitle = "Purchase Details" + chart.ChartTitleArea.FontName = "Calibri" + chart.ChartTitleArea.Size = 14 + chart.ChartArea.Border.LinePattern = OfficeChartLinePattern.None + 'Set name to chart series + chart.Series(0).Name = "Sum of Purchases" + chart.Series(1).Name = "Sum of Future Expenses" + chart.PrimaryCategoryAxis.Title = "Products" + chart.PrimaryValueAxis.Title = "In Dollars" + 'Set position of legend + chart.Legend.Position = OfficeLegendPosition.Bottom + 'Save the document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends field to end of the paragraph with the specified field name and field type. + + The string that specifies the field name. + The member that specifies the type of the field. + The instance of the newly added field. + The following example illustrates how to append field to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an instance of WordDocument class (Empty Word Document) + WordDocument document = new WordDocument(); + //Add a new section into the Word Document + IWSection section = document.AddSection(); + //Add a new paragraph into Word document and append text into paragraph + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("Today's Date: "); + //Add the new Date field in Word document with field name and its type. + WField field = paragraph.AppendField("Date", FieldType.FieldDate) as WField; + //Field code used to describe how to display the date + field.FieldCode = @"DATE \@" + "\"MMMM d, yyyy\""; + //Save the document in the given name and format + document.Save("Sample.docx", FormatType.Docx); + //Release the resources occupied by WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an instance of WordDocument class (Empty Word Document) + Dim document As New WordDocument() + 'Add a new section into the Word Document + Dim section As IWSection = document.AddSection() + 'Add a new paragraph into Word document and append text into paragraph + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("Today's Date: ") + 'Add the new Date field in Word document with field name and its type. + Dim field As WField = TryCast(paragraph.AppendField("Date", FieldType.FieldDate), WField) + 'Field code used to describe how to display the date + field.FieldCode = "DATE \@" + """MMMM d, yyyy""" + 'Save the document in the given name and format + document.Save("Sample.docx", FormatType.Docx) + 'Release the resources occupied by WordDocument instance + document.Close() + End Sub + + + + + + Appends start of the bookmark with specified name to the paragraph. + + The string specifying the bookmark name. + The instance that represents the newly added bookmark start. + The following example illustrates how to add a bookmark to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an instance of WordDocument class (Empty Word Document) + WordDocument document = new WordDocument(); + //Add a new section into the Word Document + IWSection section = document.AddSection(); + //Add a new paragraph into Word document and append text into paragraph + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("Northwind Database"); + paragraph.ParagraphFormat.HorizontalAlignment = Syncfusion.DocIO.DLS.HorizontalAlignment.Center; + //Add a paragraph into section + paragraph = section.AddParagraph(); + //Add a new bookmark start into paragraph with name "Northwind" + paragraph.AppendBookmarkStart("Northwind"); + //Add a text between the bookmark start and end into paragraph + paragraph.AppendText("The Northwind sample database (Northwind.mdb) is included with all versions of Access. It provides data you can experiment with and database objects that demonstrate features you might want to implement in your own databases."); + //Add a new bookmark end into paragraph with name " Northwind " + paragraph.AppendBookmarkEnd("Northwind"); + //Add a text after the bookmark end + paragraph.AppendText(" Using Northwind, you can become familiar with how a relational database is structured and how the database objects work together to help you enter, store, manipulate, and print your data."); + //Save the document in the given name and format + document.Save("Bookmarks.docx", FormatType.Docx); + //Release the resources occupied by WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an instance of WordDocument class (Empty Word Document) + Dim document As New WordDocument() + 'Add a new section into the Word Document + Dim section As IWSection = document.AddSection() + 'Add a new paragraph into Word document and append text into paragraph + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("Northwind Database") + paragraph.ParagraphFormat.HorizontalAlignment = Syncfusion.DocIO.DLS.HorizontalAlignment.Center + 'Add a paragraph into section + paragraph = section.AddParagraph() + 'Add a new bookmark start into paragraph with name "Northwind" + paragraph.AppendBookmarkStart("Northwind") + 'Add a text between the bookmark start and end into paragraph + paragraph.AppendText("The Northwind sample database (Northwind.mdb) is included with all versions of Access. It provides data you can experiment with and database objects that demonstrate features you might want to implement in your own databases.") + 'Add a new bookmark end into paragraph with name " Northwind " + paragraph.AppendBookmarkEnd("Northwind") + 'Add a text after the bookmark end + paragraph.AppendText(" Using Northwind, you can become familiar with how a relational database is structured and how the database objects work together to help you enter, store, manipulate, and print your data.") + 'Save the document in the given name and format + document.Save("Bookmarks.docx", FormatType.Docx) + 'Release the resources occupied by WordDocument instance + document.Close() + End Sub + + + + + + Appends end of the bookmark with specified name to the paragraph. + + The string specifying the bookmark name. + The instance that represents the newly added bookmark end. + The following example illustrates how to add a bookmark to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an instance of WordDocument class (Empty Word Document) + WordDocument document = new WordDocument(); + //Add a new section into the Word Document + IWSection section = document.AddSection(); + //Add a new paragraph into Word document and append text into paragraph + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("Northwind Database"); + paragraph.ParagraphFormat.HorizontalAlignment = Syncfusion.DocIO.DLS.HorizontalAlignment.Center; + //Add a paragraph into section + paragraph = section.AddParagraph(); + //Add a new bookmark start into paragraph with name "Northwind" + paragraph.AppendBookmarkStart("Northwind"); + //Add a text between the bookmark start and end into paragraph + paragraph.AppendText("The Northwind sample database (Northwind.mdb) is included with all versions of Access. It provides data you can experiment with and database objects that demonstrate features you might want to implement in your own databases."); + //Add a new bookmark end into paragraph with name " Northwind " + paragraph.AppendBookmarkEnd("Northwind"); + //Add a text after the bookmark end + paragraph.AppendText(" Using Northwind, you can become familiar with how a relational database is structured and how the database objects work together to help you enter, store, manipulate, and print your data."); + //Save the document in the given name and format + document.Save("Bookmarks.docx", FormatType.Docx); + //Release the resources occupied by WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an instance of WordDocument class (Empty Word Document) + Dim document As New WordDocument() + 'Add a new section into the Word Document + Dim section As IWSection = document.AddSection() + 'Add a new paragraph into Word document and append text into paragraph + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("Northwind Database") + paragraph.ParagraphFormat.HorizontalAlignment = Syncfusion.DocIO.DLS.HorizontalAlignment.Center + 'Add a paragraph into section + paragraph = section.AddParagraph() + 'Add a new bookmark start into paragraph with name "Northwind" + paragraph.AppendBookmarkStart("Northwind") + 'Add a text between the bookmark start and end into paragraph + paragraph.AppendText("The Northwind sample database (Northwind.mdb) is included with all versions of Access. It provides data you can experiment with and database objects that demonstrate features you might want to implement in your own databases.") + 'Add a new bookmark end into paragraph with name " Northwind " + paragraph.AppendBookmarkEnd("Northwind") + 'Add a text after the bookmark end + paragraph.AppendText(" Using Northwind, you can become familiar with how a relational database is structured and how the database objects work together to help you enter, store, manipulate, and print your data.") + 'Save the document in the given name and format + document.Save("Bookmarks.docx", FormatType.Docx) + 'Release the resources occupied by WordDocument instance + document.Close() + End Sub + + + + + + Appends the comment to the paragraph. + + The string that specifies the comment. + The instance that represents the newly added comment. + The following example illustrates how to add a comment to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Creates a new Word document. + WordDocument document = new WordDocument(); + //Add a section and a paragraph in the document + document.EnsureMinimal(); + IWParagraph paragraph = document.LastParagraph; + //Append text to the paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua"); + //Add comment to a paragraph + WComment comment = paragraph.AppendComment("comment test"); + //Specify the author of the comment + comment.Format.User = "Peter"; + //Specify the initial of the author + comment.Format.UserInitials = "St"; + //Save and close the Word document + document.Save("Comment.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Creates a new Word document. + Dim document As New WordDocument() + 'Add a section and a paragraph in the document + document.EnsureMinimal() + Dim paragraph As IWParagraph = document.LastParagraph + 'Append text to the paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua") + 'Add comment to a paragraph + Dim comment As WComment = paragraph.AppendComment("comment test") + 'Specify the author of the comment + comment.Format.User = "Peter" + 'Specify the initial of the author + comment.Format.UserInitials = "St" + 'Save and close the Word document + document.Save("Comment.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Appends footnote or endnotes specified by the type to the paragraph. + + The member that specifies the type of footnote. + The instance that represents the newly added footnote. + The footnotes and endnotes are differentiated by the type of the footnote. + The following example illustrates how to add a footnote to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Create a section + IWSection section = document.AddSection(); + //Add a paragraph to a section + IWParagraph paragraph = section.AddParagraph(); + //Append the text to paragraph + paragraph.AppendText("Working with footnotes"); + //Formatting the text + paragraph.ApplyStyle(BuiltinStyle.Heading1); + //Add a paragraph to a section + paragraph = section.AddParagraph(); + //Append the footnotes + WFootnote footnote = (WFootnote) paragraph.AppendFootnote(Syncfusion.DocIO.FootnoteType.Footnote); + //Set the footnote character format + footnote.MarkerCharacterFormat.SubSuperScript = SubSuperScript.SuperScript; + //Inserts the text into the paragraph + paragraph.AppendText("Sample content for footnotes").CharacterFormat.Bold = true; + //Add footnote text + paragraph = footnote.TextBody.AddParagraph(); + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Create a section + Dim section As IWSection = document.AddSection() + 'Add a paragraph to a section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Append the text to paragraph + paragraph.AppendText("Working with footnotes") + 'Formatting the text + paragraph.ApplyStyle(BuiltinStyle.Heading1) + 'Add a paragraph to a section + paragraph = section.AddParagraph() + 'Append the footnotes + Dim footnote As WFootnote = DirectCast(paragraph.AppendFootnote(Syncfusion.DocIO.FootnoteType.Footnote), WFootnote) + 'Set the footnote character format + footnote.MarkerCharacterFormat.SubSuperScript = SubSuperScript.SuperScript + 'Inserts the text into the paragraph + paragraph.AppendText("Sample content for footnotes").CharacterFormat.Bold = True + 'Add footnote text + paragraph = footnote.TextBody.AddParagraph() + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula") + �Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + The following example illustrates how to add a endnote to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new document + WordDocument document = new WordDocument(); + //Create a section + IWSection section = document.AddSection(); + //Add a paragraph to a section + IWParagraph paragraph = section.AddParagraph(); + //Append the text to paragraph + paragraph.AppendText("Working with endnotes"); + //Formatting the text + paragraph.ApplyStyle(BuiltinStyle.Heading1); + //Add a paragraph to a section + paragraph = section.AddParagraph(); + //Append the endnote + WFootnote endnote = (WFootnote) paragraph.AppendFootnote(Syncfusion.DocIO.FootnoteType.Endnote); + //Set the endnote character format + endnote.MarkerCharacterFormat.SubSuperScript = SubSuperScript.SuperScript; + //Insert the text into the paragraph + paragraph.AppendText("Sample content for endnotes").CharacterFormat.Bold = true; + //Add footnote text + paragraph = endnote.TextBody.AddParagraph(); + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new document + Dim document As New WordDocument() + 'Create a section + Dim section As IWSection = document.AddSection() + 'Add a paragraph to a section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Append the text to paragraph + paragraph.AppendText("Working with endnotes") + 'Formatting the text + paragraph.ApplyStyle(BuiltinStyle.Heading1) + 'Add a paragraph to a section + paragraph = section.AddParagraph() + 'Append the endnote + Dim endnote As WFootnote = DirectCast(paragraph.AppendFootnote(Syncfusion.DocIO.FootnoteType.Endnote), WFootnote) + 'Set the endnote character format + endnote.MarkerCharacterFormat.SubSuperScript = SubSuperScript.SuperScript + 'Insert the text into the paragraph + paragraph.AppendText("Sample content for endnotes").CharacterFormat.Bold = True + 'Add footnote text + paragraph = endnote.TextBody.AddParagraph() + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula") + �Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Append textbox to the end of the paragraph with the specified width and height. + + The float specifies the width of the textbox. + The float specifies the height of the textbox. + The instance that represents the newly added textbox. + The following example illustrates how to add a endnote to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Append new textbox to the paragraph + IWTextBox textbox = paragraph.AppendTextBox(150, 75); + //Add new text to the textbox body + IWParagraph textboxParagraph = textbox.TextBoxBody.AddParagraph(); + textboxParagraph.AppendText("Text inside text box"); + //Save and close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Append new textbox to the paragraph + Dim textbox As IWTextBox = paragraph.AppendTextBox(150, 75) + 'Add new text to the textbox body + Dim textboxParagraph As IWParagraph = textbox.TextBoxBody.AddParagraph() + textboxParagraph.AppendText("Text inside text box") + 'Save and close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Appends special symbol specified by the character code to end of the paragraph. + + The byte represents the character code of the symbol. + The instance that represents the newly added symbol. + The following example illustrates how to add a symbol to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("Example of adding symbols to the paragraph: "); + //Insert symbol with character code 100 + paragraph.AppendSymbol(100); + //Save and close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("Example of adding symbols to the paragraph: ") + 'Insert symbol with character code 100 + paragraph.AppendSymbol(100) + 'Save and close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Appends break of the specified type to end of the paragraph. + + The member that specifies the type of break. + The instance that represents the newly added break. + The following example illustrates how to add a break to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("Before line break"); + //Add line break to the paragraph + paragraph.AppendBreak(BreakType.LineBreak); + paragraph.AppendText("After line break"); + IWParagraph pageBreakPara = section.AddParagraph(); + pageBreakPara.AppendText("Before page break"); + //Add page break to the paragraph + pageBreakPara.AppendBreak(BreakType.PageBreak); + pageBreakPara.AppendText("After page break"); + IWSection secondSection = document.AddSection(); + //Add columns to the section + secondSection.AddColumn(100, 2); + secondSection.AddColumn(100, 2); + IWParagraph columnBreakPara = secondSection.AddParagraph(); + columnBreakPara.AppendText("Before column break"); + //Add column break to the paragraph + columnBreakPara.AppendBreak(BreakType.ColumnBreak); + columnBreakPara.AppendText("After column break"); + //Save and Close the document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("Before line break") + 'Add line break to the paragraph + paragraph.AppendBreak(BreakType.LineBreak) + paragraph.AppendText("After line break") + Dim pageBreakPara As IWParagraph = section.AddParagraph() + pageBreakPara.AppendText("Before page break") + 'Add page break to the paragraph + pageBreakPara.AppendBreak(BreakType.PageBreak) + pageBreakPara.AppendText("After page break") + Dim secondSection As IWSection = document.AddSection() + 'Add columns to the section + secondSection.AddColumn(100, 2) + secondSection.AddColumn(100, 2) + Dim columnBreakPara As IWParagraph = secondSection.AddParagraph() + columnBreakPara.AppendText("Before column break") + 'Add column break to the paragraph + columnBreakPara.AppendBreak(BreakType.ColumnBreak) + columnBreakPara.AppendText("After column break") + 'Save and Close the document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Appends of specified type, width and height to the end of paragraph. + + The member that specifies the shape type. + The float that specifies the width of the shape. + The float that specifies the height of the shape. + The instance that represents the newly added shape. + The following example illustrates how to add a shape to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + WParagraph paragraph = section.AddParagraph() as WParagraph; + //Add new shape to the document + Shape rectangle = paragraph.AppendShape(AutoShapeType.RoundedRectangle, 150, 100); + //Set position for shape + rectangle.VerticalPosition = 72; + rectangle.HorizontalPosition = 72; + paragraph = section.AddParagraph() as WParagraph; + //Add text body contents to the shape + paragraph = rectangle.TextBody.AddParagraph() as WParagraph; + IWTextRange text = paragraph.AppendText("This text is in rounded rectangle shape"); + text.CharacterFormat.TextColor = Color.Green; + text.CharacterFormat.Bold = true; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(section.AddParagraph(), WParagraph) + 'Add new shape to the document + Dim rectangle As Shape = paragraph.AppendShape(AutoShapeType.RoundedRectangle, 150, 100) + 'Set position for shape + rectangle.VerticalPosition = 72 + rectangle.HorizontalPosition = 72 + paragraph = TryCast(section.AddParagraph(), WParagraph) + 'Add text body contents to the shape + paragraph = TryCast(rectangle.TextBody.AddParagraph(), WParagraph) + Dim text As IWTextRange = paragraph.AppendText("This text is in rounded rectangle shape") + text.CharacterFormat.TextColor = Color.Green + text.CharacterFormat.Bold = True + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + The following example illustrates how to append html text to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document + WordDocument document = new WordDocument("Template.docx"); + //Html string to be inserted + string htmlstring = "

This text is inserted as HTML string.

"; + IWParagraph paragraph = document.Sections[0].Body.Paragraphs[0]; + //Append the Html string to first paragraph in the document + paragraph.AppendHTML(htmlstring); + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx") + 'Html string to be inserted + Dim htmlstring As String = "

This text is inserted as HTML string.

" + Dim paragraph As IWParagraph = document.Sections(0).Body.Paragraphs(0) + 'Append the Html string to first paragraph in the document + paragraph.AppendHTML(htmlstring) + 'Save and close the document + document.Save("Sample.docx") + document.Close() + End Sub + + + + + + Returns the applied to the paragraph. + + The of the current paragraph. + + + + Returns first entry of given string in the paragraph, taking into consideration case sensitive and whole word options. + + The string that specifies the text to find. + + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + + The that contains the found text in the paragraph. + + + The following code example demonstrates how to find a particular text in the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + WParagraph paragraph = document.Sections[0].Paragraphs[1]; + //Find the first occurrence of a particular text in the paragraph + TextSelection textSelection = paragraph.Find("panda", true, true); + //Get the found text as single text range + WTextRange textRange = textSelection.GetAsOneRange(); + //Modify the text + textRange.Text = "Replaced text"; + //Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow; + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + Dim paragraph As WParagraph = document.Sections(0).Paragraphs(1) + 'Find the first occurrence of a particular text in the paragraph + Dim textSelection As TextSelection = paragraph.Find("panda", true, true) + 'Get the found text as single text range + Dim textRange As WTextRange = textSelection.GetAsOneRange() + 'Modify the text + textRange.Text = "Replaced text" + 'Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + Replaces all entries of given string in the paragraph with , taking into + consideration case sensitive and whole word options. + + The string represents the text to be found. + The specifies the text to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + WParagraph paragraph = document.Sections[0].Paragraphs[1]; + //Find the first occurrence of the regular expression + TextSelection selection = paragraph.Find(new Regex("Panda")); + //Replace all occurrence of a particular regular expression with the text selection in the paragraph + paragraph.Replace("Giant panda", selection, true, false); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + Dim paragraph As WParagraph = document.Sections(0).Paragraphs(1) + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = paragraph.Find(New Regex("Panda")) + 'Replace all occurrence of a particular regular expression with the text selection in the paragraph + paragraph.Replace("Giant panda", selection, True, False) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given string in the paragraph with , taking into + consideration case sensitive, whole word and formatting options. + + The string represents the text to be found. + The specifies the text to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + Set to true if to save source formatting; otherwise, false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + WParagraph paragraph = document.Sections[0].Paragraphs[1]; + //Find the first occurrence of the regular expression + TextSelection selection = paragraph.Find(new Regex("Panda")); + //Replace all occurrence of a particular regular expression with the text selection in the paragraph + paragraph.Replace("Giant panda", selection, true, false, true); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + Dim paragraph As WParagraph = document.Sections(0).Paragraphs(1) + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = paragraph.Find(New Regex("Panda")) + 'Replace all occurrence of a particular regular expression with the text selection in the paragraph + paragraph.Replace("Giant panda", selection, True, False, False) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Appends the check box to the paragraph. + + The instance that represents the newly added checkbox. + The following example illustrates how to add a checkbox to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + WParagraph paragraph = section.AddParagraph() as WParagraph; + paragraph.AppendText("Gender\t"); + //Append new Checkbox + WCheckBox checkbox = paragraph.AppendCheckBox(); + checkbox.Checked = false; + //Set Checkbox size + checkbox.CheckBoxSize = 10; + checkbox.CalculateOnExit = true; + //Set help text + checkbox.Help = "Help text"; + paragraph.AppendText("Male\t"); + checkbox = paragraph.AppendCheckBox(); + checkbox.Checked = false; + checkbox.CheckBoxSize = 10; + checkbox.CalculateOnExit = true; + paragraph.AppendText("Female"); + //Save the Word document + document.Save("Checkbox.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(section.AddParagraph(), WParagraph) + paragraph.AppendText("Gender" & vbTab) + 'Append new Checkbox + Dim checkbox As WCheckBox = paragraph.AppendCheckBox() + checkbox.Checked = False + 'Set Checkbox size + checkbox.CheckBoxSize = 10 + checkbox.CalculateOnExit = True + 'Set help text + checkbox.Help = "Help text" + paragraph.AppendText("Male" & vbTab) + checkbox = paragraph.AppendCheckBox() + checkbox.Checked = False + checkbox.CheckBoxSize = 10 + checkbox.CalculateOnExit = True + paragraph.AppendText("Female") + 'Save the Word document + document.Save("Checkbox.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends the text form field to the paragraph with the specified default text. + + The string specifying the default text. + To insert default Word text, "null" can be passed as parameter. + The instance that represents the newly added text form field. + The following example illustrates how to add a text form field to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + WParagraph paragraph = section.AddParagraph() as WParagraph; + paragraph.AppendText("General Information"); + section.AddParagraph(); + paragraph = section.AddParagraph() as WParagraph; + IWTextRange text = paragraph.AppendText("Name\t"); + text.CharacterFormat.Bold = true; + //Append Text form field + WTextFormField textfield = paragraph.AppendTextFormField(null); + //Set type of Text form field + textfield.Type = TextFormFieldType.RegularText; + textfield.CharacterFormat.FontName = "Calibri"; + textfield.CalculateOnExit = true; + //Save the Word document + document.Save("Textfield.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(section.AddParagraph(), WParagraph) + paragraph.AppendText("General Information") + section.AddParagraph() + paragraph = TryCast(section.AddParagraph(), WParagraph) + Dim text As IWTextRange = paragraph.AppendText("Name" & vbTab) + text.CharacterFormat.Bold = True + 'Append Text form field + Dim textfield As WTextFormField = paragraph.AppendTextFormField(Nothing) + 'Set type of Text form field + textfield.Type = TextFormFieldType.RegularText + textfield.CharacterFormat.FontName = "Calibri" + textfield.CalculateOnExit = True + 'Save the Word document + document.Save("Textfield.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends the drop down form field to the paragraph. + + The instance that represents the newly added drop down form field. + + + + Appends the check box to the paragraph with specified name and default value. + + The string that specifies the name of the check box. + A Boolean indicating the default value of the checkbox. + True if the checkbox should be checked by default; otherwise, false. + The instance that represents the newly added checkbox. + The following example illustrates how to add a checkbox to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + WParagraph paragraph = section.AddParagraph() as WParagraph; + paragraph.AppendText("Gender\t"); + //Append new Checkbox + WCheckBox checkbox = paragraph.AppendCheckBox("CheckBox1", true); + //checkbox.Checked = false; + //Set Checkbox size + checkbox.CheckBoxSize = 10; + checkbox.CalculateOnExit = true; + //Set help text + checkbox.Help = "Help text"; + paragraph.AppendText("Male\t"); + checkbox = paragraph.AppendCheckBox("CheckBox2",false); + //checkbox.Checked = false; + checkbox.CheckBoxSize = 10; + checkbox.CalculateOnExit = true; + paragraph.AppendText("Female"); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(section.AddParagraph(), WParagraph) + paragraph.AppendText("Gender" & vbTab) + 'Append new Checkbox + Dim checkbox As WCheckBox = paragraph.AppendCheckBox("CheckBox1", True) + 'checkbox.Checked = false; + 'Set Checkbox size + checkbox.CheckBoxSize = 10 + checkbox.CalculateOnExit = True + 'Set help text + checkbox.Help = "Help text" + paragraph.AppendText("Male" & vbTab) + checkbox = paragraph.AppendCheckBox("CheckBox2", False) + 'checkbox.Checked = false; + checkbox.CheckBoxSize = 10 + checkbox.CalculateOnExit = True + paragraph.AppendText("Female") + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends the text form field to the paragraph with the specified field name and default text. + + The string that specifies the name of the form field. + The string specifying the default text. + To insert default Word text, "null" can be passed as parameter. + The instance that represents the newly added text form field. + The following example illustrates how to add a text form field to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + WParagraph paragraph = section.AddParagraph() as WParagraph; + paragraph.AppendText("General Information"); + section.AddParagraph(); + paragraph = section.AddParagraph() as WParagraph; + IWTextRange text = paragraph.AppendText("Date of Birth\t"); + text.CharacterFormat.Bold = true; + //Append Text form field + WTextFormField textfield = paragraph.AppendTextFormField("Date field", DateTime.Now.ToString("MM/DD/YY")); + textfield.StringFormat = "MM/DD/YY"; + //Set Text form field type + textfield.Type = TextFormFieldType.DateText; + textfield.CalculateOnExit = true; + //Save the Word document + document.Save("Textfield.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(section.AddParagraph(), WParagraph) + paragraph.AppendText("General Information") + section.AddParagraph() + paragraph = TryCast(section.AddParagraph(), WParagraph) + Dim text As IWTextRange = paragraph.AppendText("Date of Birth" & vbTab) + text.CharacterFormat.Bold = True + 'Append Text form field + Dim textfield As WTextFormField = paragraph.AppendTextFormField("Date field", DateTime.Now.ToString("MM/DD/YY")) + textfield.StringFormat = "MM/DD/YY" + 'Set Text form field type + textfield.Type = TextFormFieldType.DateText + textfield.CalculateOnExit = True + 'Save the Word document + document.Save("Textfield.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends the drop down form field to the paragraph. + + The string that specifies the name of the drop drop down field. + The instance that represents the newly added drop down form field. + The following example illustrates how to add a checkbox to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + WParagraph paragraph = section.AddParagraph() as WParagraph; + paragraph.AppendText("Educational Qualification\t"); + //Append Dropdown field + WDropDownFormField dropdownfield = paragraph.AppendDropDownFormField("FieldName"); + //Add items to the dropdown items collection + dropdownfield.DropDownItems.Add("Higher"); + dropdownfield.DropDownItems.Add("Vocational"); + dropdownfield.DropDownItems.Add("Universal"); + dropdownfield.Enabled = true; + //Set the item index for default value + dropdownfield.DropDownSelectedIndex = 1; + dropdownfield.CalculateOnExit = true; + //Save the Word document + document.Save("Dropdown.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(section.AddParagraph(), WParagraph) + paragraph.AppendText("Educational Qualification" & vbTab) + 'Append Dropdown field + Dim dropdownfield As WDropDownFormField = paragraph.AppendDropDownFormField("FieldName") + 'Add items to the dropdown items collection + dropdownfield.DropDownItems.Add("Higher") + dropdownfield.DropDownItems.Add("Vocational") + dropdownfield.DropDownItems.Add("Universal") + dropdownfield.Enabled = True + 'Set the item index for default value + dropdownfield.DropDownSelectedIndex = 1 + dropdownfield.CalculateOnExit = True + 'Save the Word document + document.Save("Dropdown.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends the hyperlink to the paragraph with the specified link, display text and type of link. + + The string that specifies the link. + The string that specifies the text to display. + The member that specifies the link type. + The instance that represents the newly added hyperlink. + The following example illustrates how to append field to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("Web Hyperlink: "); + paragraph = section.AddParagraph(); + //Append web hyperlink to the paragraph + IWField field = paragraph.AppendHyperlink("http://www.syncfusion.com", "Syncfusion", HyperlinkType.WebLink); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("Web Hyperlink: ") + paragraph = section.AddParagraph() + 'Append web hyperlink to the paragraph + Dim field As IWField = paragraph.AppendHyperlink("http://www.syncfusion.com", "Syncfusion", HyperlinkType.WebLink) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends the hyperlink to the paragraph with the specified link, picture and type of link. + + The string that specifies the link. + The picture to display. + The member that specifies the link type. + The instance that represents the newly added hyperlink. + The following example illustrates how to append field to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("Image Hyperlink"); + paragraph = section.AddParagraph(); + //Create a new image instance and load image + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + //Append new image hyperlink to the paragraph + paragraph.AppendHyperlink("http://www.syncfusion.com", picture, HyperlinkType.WebLink); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("Image Hyperlink") + paragraph = section.AddParagraph() + 'Create a new image instance and load image + Dim picture As New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + 'Append new image hyperlink to the paragraph + paragraph.AppendHyperlink("http://www.syncfusion.com", picture, HyperlinkType.WebLink) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Removes the absolute position data, if paragraph has absolute position in the document. + + + + + Appends the table of content to the end of the paragraph with the specified lower and upper heading levels. + + The integer specifying the starting heading level of the table of content. + The integer specifying the ending heading level of the table of content. + The instance that represents the newly added table of content. + The following example illustrates how to add a table of contents to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add the section into the Word document + IWSection section = document.AddSection(); + string paraText = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"; + //Add the paragraph into the created section + IWParagraph paragraph = section.AddParagraph(); + //Append the TOC field with LowerHeadingLevel and UpperHeadingLevel to determines the TOC entries + paragraph.AppendTOC(1, 3); + //Add the section into the Word document + section = document.AddSection(); + //Add the paragraph into the created section + paragraph = section.AddParagraph(); + //Add the text for the headings + paragraph.AppendText("First Chapter"); + //Set a build in heading style. + paragraph.ApplyStyle(BuiltinStyle.Heading1); + //Add the text into the paragraph + section.AddParagraph().AppendText(paraText); + //Add the section into the Word document + section = document.AddSection(); + //Add the paragraph into the created section + paragraph = section.AddParagraph(); + //Add the text for the headings + paragraph.AppendText("Second Chapter"); + //Set a build in heading style. + paragraph.ApplyStyle(BuiltinStyle.Heading2); + //Add the text into the paragraph + section.AddParagraph().AppendText(paraText); + //Add the section into the Word document + section = document.AddSection(); + //Add the paragraph into the created section + paragraph = section.AddParagraph(); + //Add the text into the headings + paragraph.AppendText("Third Chapter"); + //Set a build in heading style + paragraph.ApplyStyle(BuiltinStyle.Heading3); + //Add the text into the paragraph. + section.AddParagraph().AppendText(paraText); + //Update the table of contents + document.UpdateTableOfContents(); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add the section into the Word document + Dim section As IWSection = document.AddSection() + Dim paraText As String = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula" + 'Add the paragraph into the created section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Append the TOC field with LowerHeadingLevel and UpperHeadingLevel to determines the TOC entries + paragraph.AppendTOC(1, 3) + 'Add the section into the Word document + section = document.AddSection() + 'Add the paragraph into the created section + paragraph = section.AddParagraph() + 'Add the text for the headings + paragraph.AppendText("First Chapter") + 'Set a build in heading style + paragraph.ApplyStyle(BuiltinStyle.Heading1) + 'Add the text into the paragraph. + section.AddParagraph().AppendText(paraText) + 'Add the section into the Word document + section = document.AddSection() + 'Add the paragraph into the created section + paragraph = section.AddParagraph() + 'Add the text for the headings + paragraph.AppendText("Second Chapter") + 'Set a build in heading style + paragraph.ApplyStyle(BuiltinStyle.Heading2) + 'Add the text into the paragraph + section.AddParagraph().AppendText(paraText) + 'Add the section into the Word document + section = document.AddSection() + 'Add the paragraph into the created section + paragraph = section.AddParagraph() + 'Add the text into the headings + paragraph.AppendText("Third Chapter") + 'Set a build in heading style + paragraph.ApplyStyle(BuiltinStyle.Heading3) + 'Add the text into the paragraph + section.AddParagraph().AppendText(paraText) + 'Update the table of contents + document.UpdateTableOfContents() + �Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Appends a Cross-Reference of specified reference type, reference kind, entity, hyperlink, separators at the end of the paragraph. + + The member that specifies the + type of item for which a cross-reference is to be inserted. + The member that specifies the + information to be included in the cross-reference. + The for which a cross-reference is to be inserted. + True if to insert the cross-reference as a hyperlink to the referenced item; otherwise, false. + True if to insert "above" or "below," depending on the location of the reference item in relation to the cross-reference. + True if to use a separator to separate the numbers from the associated text; otherwise, false.(Used only if the ReferenceKind parameter is set to ParagraphNumberFullContext). + The string that specifies a separator if the separateNumber parameter is set to true. + + The cross reference fields can be created and updated only for the in a document. + Use the method to get a list of items that can have cross-reference. + + + + The following example illustrates how to append a cross-reference for bookmark to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + IWParagraph paragraph = section.AddParagraph(); + //Add text, bookmark start and end in the paragraph + paragraph.AppendBookmarkStart("Title"); + paragraph.AppendText("Northwind Database"); + paragraph.AppendBookmarkEnd("Title"); + paragraph = section.AddParagraph(); + paragraph.AppendText("The Northwind sample database (Northwind.mdb) is included with all versions of Access. It provides data you can experiment with and database objects that demonstrate features you might want to implement in your own databases."); + section = document.AddSection(); + section.AddParagraph(); + paragraph = section.AddParagraph() as WParagraph; + //Get the collection of bookmark start in the word document + List<Entity> items = document.GetCrossReferenceItems(ReferenceType.Bookmark); + paragraph.AppendText("Bookmark Cross Reference starts here "); + //Append the cross reference for bookmark �Title� with ContentText as reference kind + paragraph.AppendCrossReference(ReferenceType.Bookmark, ReferenceKind.ContentText, items[0], true, false, false, string.Empty); + //Update the document Fields + document.UpdateDocumentFields(); + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add text, bookmark start and end in the paragraph + paragraph.AppendBookmarkStart("Title") + paragraph.AppendText("Northwind Database") + paragraph.AppendBookmarkEnd("Title") + paragraph = section.AddParagraph() + paragraph.AppendText("The Northwind sample database (Northwind.mdb) is included with all versions of Access. It provides data you can experiment with and database objects that demonstrate features you might want to implement in your own databases.") + section = document.AddSection() + section.AddParagraph() + paragraph = TryCast(section.AddParagraph(), WParagraph) + 'Get the collection of bookmark start in the word document + Dim items As List(Of Entity) = document.GetCrossReferenceItems(ReferenceType.Bookmark) + paragraph.AppendText("Bookmark Cross Reference starts here ") + 'Append the cross reference for bookmark �Title� with ContentText as reference kind + paragraph.AppendCrossReference(ReferenceType.Bookmark, ReferenceKind.ContentText, items(0), True, False, False, String.Empty) + 'Update the document Fields + document.UpdateDocumentFields() + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Appends the OLE object to the paragraph with the specified stream, picture and object type. + + The represents the file stream. + The instance for the OLE picture. + The member that specifies the type of OLE object. + The instance that represents the newly created OLE object. + The following example illustrates how to append OLE object to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Open the file to be embedded + FileStream stream = new FileStream("Book1.xlsx", FileMode.Open); + //Load the picture instance with the image need to be displayed + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + //Append the Ole object to the paragraph + WOleObject ole = paragraph.AppendOleObject(stream, picture, OleObjectType.ExcelWorksheet); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Open the file to be embedded + Dim stream As New FileStream("Book1.xlsx", FileMode.Open) + 'Load the picture instance with the image need to be displayed + Dim picture As New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + 'Append the Ole object to the paragraph + Dim ole As WOleObject = paragraph.AppendOleObject(stream, picture, OleObjectType.ExcelWorksheet) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends the OLE object to the paragraph with the specified byte array, picture and object type. + + The byte array of the file. + The instance for the OLE picture. + The member that specifies the type of OLE object. + The instance that represents the newly created OLE object. + The following example illustrates how to append OLE object to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Load the picture instance with the image need to be displayed + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + //Get the file as byte array + byte[] olebytes = File.ReadAllBytes("Excel_Template.xlsx"); + paragraph = sec.AddParagraph(); + //Append OLE object + paragraph.AppendOleObject(olebytes, picture, OleObjectType.ExcelWorksheet); + //Save the Word document + document.Save("Sample.docx", FormatType.Word2010); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Load the picture instance with the image need to be displayed + Dim picture As New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + 'Get the file as byte array + Dim olebytes As Byte() = File.ReadAllBytes("Excel_Template.xlsx") + paragraph = sec.AddParagraph() + 'Append OLE object + paragraph.AppendOleObject(olebytes, picture, OleObjectType.ExcelWorksheet) + 'Save the Word document + document.Save("Sample.docx", FormatType.Word2010) + 'Close the document + document.Close() + End Sub + + + + + + Appends the OLE object to the paragraph with the specified stream, picture and file link type. + + The represents the file stream. + The instance for the OLE picture. + The member that specifies the link type of OLE object. + The instance that represents the newly created OLE object. + The OLE object type must be explicitly specified when appending OLE objects using this method. + The following example illustrates how to append OLE object to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Load the picture instance with the image need to be displayed + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + FileStream stream = new FileStream("Excel_Template.xlsx", FileMode.Open); + WOleObject ole = paragraph.AppendOleObject(stream, picture, OleLinkType.Embed); + ole.ObjectType = "Excel Worksheet"; + //Save the Word document + document.Save("Sample.docx", FormatType.Word2010); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Load the picture instance with the image need to be displayed + Dim picture As New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + Dim stream As New FileStream("Excel_Template.xlsx", FileMode.Open) + Dim ole As WOleObject = paragraph.AppendOleObject(stream, picture, OleLinkType.Embed) + ole.ObjectType = "Excel Worksheet" + 'Save the Word document + document.Save("Sample.docx", FormatType.Word2010) + 'Close the document + document.Close() + End Sub + + + + + + Appends the OLE object to the paragraph with the specified byte array of the file, picture and link type. + + The byte array of the file. + The instance for the OLE picture. + The member that specifies the link type of OLE object. + The instance that represents the newly created OLE object. + The OLE object type must be explicitly specified when appending OLE objects using this method. + The following example illustrates how to append OLE object to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Load the picture instance with the image need to be displayed + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + //Get the file as byte array + byte[] olebytes = File.ReadAllBytes("Excel_Template.xlsx"); + WOleObject ole = paragraph.AppendOleObject(olebytes, picture, OleLinkType.Embed); + ole.ObjectType = "Excel Worksheet"; + //Save the Word document + document.Save("Sample.docx", FormatType.Word2010); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Load the picture instance with the image need to be displayed + Dim picture As New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + 'Get the file as byte array + Dim olebytes As Byte() = File.ReadAllBytes("Excel_Template.xlsx") + Dim ole As WOleObject = paragraph.AppendOleObject(olebytes, picture, OleLinkType.Embed) + ole.ObjectType = "Excel Worksheet" + 'Save the Word document + document.Save("Sample.docx", FormatType.Word2010) + 'Close the document + document.Close() + End Sub + + + + + + Appends the OLE object to the paragraph with the specified byte array of the file, picture and file extension. + + The byte array of the file. + The instance for the OLE picture. + The string that specifies the file extension. + The instance that represents the newly created OLE object. + The following example illustrates how to append OLE object to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Load the picture instance with the image need to be displayed + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + //Get the file as byte array + byte[] olebytes = File.ReadAllBytes("Excel_Template.xlsx"); + paragraph = sec.AddParagraph(); + //Append OLE object + paragraph.AppendOleObject(olebytes, picture, ".xlsx"); + //Save the Word document + document.Save("Sample.docx", FormatType.Word2010); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Load the picture instance with the image need to be displayed + Dim picture As New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + 'Get the file as byte array + Dim olebytes As Byte() = File.ReadAllBytes("Excel_Template.xlsx") + paragraph = sec.AddParagraph() + 'Append OLE object + paragraph.AppendOleObject(olebytes, picture, ".xlsx") + 'Save the Word document + document.Save("Sample.docx", FormatType.Word2010) + 'Close the document + document.Close() + End Sub + + + + + + Appends the OLE object to the paragraph with the specified file stream, picture and file extension. + + The represents the file stream. + The instance for the OLE picture. + The string that specifies the file extension. + The instance that represents the newly created OLE object. + The following example illustrates how to append OLE object to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Open the file to be embedded + FileStream stream = new FileStream("Excel_Template.xlsx", FileMode.Open); + //Load the picture instance with the image need to be displayed + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + //Append the Ole object to the paragraph + WOleObject ole = paragraph.AppendOleObject(stream, picture, "xlsx"); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Open the file to be embedded + Dim stream As New FileStream("Excel_Template.xlsx", FileMode.Open) + 'Load the picture instance with the image need to be displayed + Dim picture As New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + 'Append the Ole object to the paragraph + Dim ole As WOleObject = paragraph.AppendOleObject(stream, picture, "xlsx") + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends the OLE object to the paragraph with the specified path, picture and object type. + + The string specifying the path to file. + The instance for the OLE picture. + The member that specifies the type of OLE object. + The instance that represents the newly created OLE object. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform and Xamarin applications. + The following example illustrates how to append a OLE object to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Load the picture instance with the image need to be displayed + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + paragraph = sec.AddParagraph(); + paragraph.AppendOleObject(@"..\..\Data\Excel_Template.xlsx", picture, OleObjectType.ExcelWorksheet); + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Load the picture instance with the image need to be displayed + Dim picture As New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + paragraph = sec.AddParagraph() + paragraph.AppendOleObject("..\..\Data\Excel_Template.xlsx", picture, OleObjectType.ExcelWorksheet) + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Appends the OLE object to the paragraph with the specified path and picture. + + The string specifying the path to file. + The instance for the OLE picture. + The instance that represents the newly created OLE object. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform and Xamarin applications. + The following example illustrates how to append a OLE object to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Load the picture instance with the image need to be displayed + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + WOleObject ole = paragraph.AppendOleObject(@"..\..\Data\Excel_Template.xlsx", picture); + //Set how to display the Ole object + ole.DisplayAsIcon = false; + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Load the picture instance with the image need to be displayed + Dim picture As New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + Dim ole As WOleObject = paragraph.AppendOleObject("..\..\Data\Excel_Template.xlsx", picture) + 'Set how to display the Ole object + ole.DisplayAsIcon = False + 'Save and close the document + document.Save("Sample.docx") + document.Close() + End Sub + + + + + + Appends the mathematical equation to the paragraph. + + The instance that represents the newly added mathematical equation. + + + + Appends a mathematical equation to the paragraph using LaTeX syntax. + + The LaTeX syntax representing the mathematical equation. + The instance that represents the newly added mathematical equation. + The following example illustrates how to append math using LaTeX to the paragraph. + + //Create a new Word document + using(WordDocument wordDocument = new WordDocument()) + { + //Adds one section and one paragraph to the document + wordDocument.EnsureMinimal(); + //Appends a new mathematical equation to the paragraph using LaTeX syntax. + wordDocument.LastParagraph.AppendMath(@"\dot{a}"); + //Saves the Word document + wordDocument.Save("Result.docx", FormatType.Docx); + } + + + 'Create a new Word document + Dim wordDocument As New WordDocument() + 'Adds one section and one paragraph to the document + wordDocument.EnsureMinimal() + 'Appends a new mathematical equation to the paragraph using LaTeX syntax. + wordDocument.LastParagraph.AppendMath("\dot{a}") + 'Saves the Word document + wordDocument.Save("Result.docx", FormatType.Docx) + 'Close the document + wordDocument.Close() + + + + + + Inserts a section break. Creates new section with the break type new page. + + A reference to the newly created section. + + The following code example illustrates how to insert a section break. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + document.EnsureMinimal(); + //Add text to the first section + document.LastParagraph.AppendText("First section"); + //Insert section break + WSection newsection = document.LastParagraph.InsertSectionBreak(); + //Add new paragraph to the second section + IWParagraph paragraph = newsection.AddParagraph(); + paragraph.AppendText("Second section"); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + document.EnsureMinimal() + 'Add text to the first section + document.LastParagraph.AppendText("First section") + 'Insert section break + Dim newsection As WSection = document.LastParagraph.InsertSectionBreak() + 'Add new paragraph to the second section + Dim paragraph As IWParagraph = newsection.AddParagraph() + paragraph.AppendText("Second section") + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Inserts the section break. Creates new section with the specified break type. + + The member that specifies the break type. + A reference to the newly created section. + + The following code example illustrates how to insert a section break. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + document.EnsureMinimal(); + //Add text to the first section + document.LastParagraph.AppendText("First section"); + //Insert section break + WSection newsection = document.LastParagraph.InsertSectionBreak(SectionBreakCode.Oddpage); + //Add new paragraph to the second section + IWParagraph paragraph = newsection.AddParagraph(); + paragraph.AppendText("Second section"); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + document.EnsureMinimal() + 'Add text to the first section + document.LastParagraph.AppendText("First section") + 'Insert section break + Dim newsection As WSection = document.LastParagraph.InsertSectionBreak(SectionBreakCode.Oddpage) + 'Add new paragraph to the second section + Dim paragraph As IWParagraph = newsection.AddParagraph() + paragraph.AppendText("Second section") + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the name of the style applied to the current paragraph. Read-only. + + The string that represents the style name. + + + + Gets or sets text of the paragraph. + + The string that represents the text. + All the internal formatting will be cleared when new text is set. + + + + Gets or sets a value indicating whether the paragraph mark is treated as special hidden and it allows Microsoft Word to join paragraphs formatted using different paragraph styles. + + True if the paragraph mark is treated as special hidden; otherwise, false. + + + + Gets the paragraph item at the specified index. Read-only. + + The zero-based index of the item to get from the collection. + The at the specified index. + + + + Gets the paragraph format of the current paragraph. Read-only. + + The of the paragraph. + + + + Gets the paragraph format. + + + + + Gets the format for the list in the paragraph. Read-only. + + The of the list in the paragraph. + + + + Gets the character format for the break symbol. Read-only. + + The of the paragraph. + + + + Gets a value indicating whether the current paragraph is in cell. Read-only. + + True if this paragraph is in cell; otherwise, false. + + + + Gets a value indicating whether the current paragraph is end of the section. Read-only. + + True if this paragraph is end of section; otherwise false. + + + + + Gets a value indicating whether the current paragraph is end of document. Read-only. + + True if this paragraph is end of document; otherwise, false. + + + + + Gets a string that represent the appearance of the list value of the paragraph. + + The string that represents a string value of the list of the paragraph. Default value is string.Empty + The following example illustrates how to get a numeric string value of the list paragraph. + + // Loads an existing Word document into DocIO instance. + WordDocument document = new WordDocument("Template.docx"); + //Gets the document text + document.GetText(); + // Gets a numeric string value of the numbering list paragraph. + String listString = document.LastParagraph.ListString; + // Saves the document in the given name and format. + document.Save("Document.docx", FormatType.Docx); + // Releases the resources occupied by WordDocument instance. + document.Close(); + + + ' Loads an existing Word document into DocIO instance. + Dim document As WordDocument = New WordDocument("Template.docx") + ' Gets the document text. + document.GetText() + ' Gets a numeric string value of the numbering list paragraph + Dim listString As String = document.LastParagraph.ListString + ' Saves the document in the given name and format. + document.Save("Document.docx", FormatType.Docx) + ' Releases the resources occupied by WordDocument instance. + document.Close() + + + This property holds the static string of the list value recently calculated while saving the document as Text. It is not updated automatically for each modification done in the document. + Hence, you should either invoke WordDocument.GetText() method or save the document as Text, to get the actual list value from this property. + For a picture bulleted list, this property is not valid and will return string.Empty. + + + + + + + + + Member that represents the paragraph style. + + + + + + The paragraph text + + + + + Returns a numeric string of the of the list paragraph. + + + + + Member that represents the paragraph format. + + + + + + Member that represents the list format. + + + + + + Member that represents the collection of paragraph items. + + + + + + The paragraph items with one empty item. + + + + + The paragraph items. + + + + + + + + + + Specifies the owner textbody item. + Denotes the owner table, if the current body item is in table cell. + + + + + Determines whether the empty text range is need to added or not for break item. + + + + + + Determine whether the paragraph contains DIN Offc font text. + + + + + + If we can create excat Din font, we need to return true or else need to return false. + + + + + + + + Creates font based on given font details. + + Name of the font. + Size of the font. + Style of the font. + The created font. + + + + Determine whether the paragraph contains floating items alone + + + + + + Determine whether the last item of the paragraph is a break or not. + + + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + Get Outline Level of the Heading. + + The member that specifies the outline level. + + + + Move the paragraph items to another paragraph. + + + + + + + + Checks whether we need to fit the symbol inside the shape or not. + + + returns true if need to fit symbol. otherwise false + + + + Change style when style is "Normal",custom type and not default. + + + + + Checks whether paragraph has inline item + + + returns true if item is inline item. otherwise false + + + + Splits the textrange into new paragraphs if new line character exsists in the text + + + + + + + Insert the page/column break after formattings. + + + + + + Applies the style with the specified name to the paragraph. + + The string that represents the style name. + The specified style must exists in collection. + + + + Applies the style with the specified name to the paragraph. + + The string that represents the style name. + The specified style must exists in collection. + + + + Applies the specified built-in style to the paragraph. + + The member that specifies the style. + + + + Applies the specified built-in style to the paragraph. + + The member that specifies the style. + + + + Returns the applied to the paragraph. + + The of the current paragraph. + + + + Removes the absolute position data, if paragraph has absolute position in the document. + + + + + /// Find the verticalmerge end cell has the Exactly height property. + + Owner cell of the paragraph + Height of end merge cell row + + + + + Finds whether the paragraph preserved inside row and which height type is exactly. + + True; if paragraph preserved inside exactly table row otherwise false. + + + + Appends the specified text to the end of the paragraph. + + The string that specifies the text to be appended. + The instance that represents the newly added text. + The following example illustrates how to append text to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new text to the paragraph + IWTextRange text = paragraph.AppendText("A new text is added to the paragraph."); + text.CharacterFormat.FontSize = 14; + text.CharacterFormat.Bold = true; + text.CharacterFormat.TextColor = Color.Green; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new text to the paragraph + Dim text As IWTextRange = paragraph.AppendText("A new text is added to the paragraph.") + text.CharacterFormat.FontSize = 14 + text.CharacterFormat.Bold = True + text.CharacterFormat.TextColor = Color.Green + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends the inline content control to the paragraph. + + The control type that specifies the type of the content control to be appended. + The instance that represents the newly added text. + Thrown when is + , or + The following example illustrates how to append inline content control to the paragraph. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new inline control to the paragraph + IInlineContentControl inlineControl = paragraph.AppendInlineContentControl(ContentControlType.RichText); + WTextRange controlText = new WTextRange(document); + controlText.CharacterFormat.Bold = true; + controlText.CharacterFormat.TextColor = Color.Green; + controlText.Text = "Inline content control inserted."; + //Add text range to the control added + inlineControl.ParagraphItems.Add(controlText); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new inline control to the paragraph + Dim inlineControl As IInlineContentControl = paragraph.AppendInlineContentControl(ContentControlType.RichText) + Dim textRange As New WTextRange(document) + textRange.CharacterFormat.Bold = True + textRange.CharacterFormat.TextColor = Color.Green + textRange.Text = "Inline content control inserted." + 'Add text range to the control added + inlineControl.ParagraphItems.Add(textRange) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Appends the image specified by the array to the end of paragraph. + + The array of the image to be added. + The instance that represents the newly added image. + The following example illustrates how to append image to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph firstParagraph = section.AddParagraph(); + //Get the image and convert to byte array. + Image image = Image.FromFile("Image.png"); + MemoryStream stream = new MemoryStream(); + image.Save(stream, System.Drawing.Imaging.ImageFormat.Png); + byte[] imageBytes = stream.ToArray(); + //Add image to the paragraph + IWPicture picture = firstParagraph.AppendPicture(imageBytes); + //Set height and width for the image + picture.Height = 100; + picture.Width = 100; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim firstParagraph As IWParagraph = section.AddParagraph() + 'Get the image and convert to byte array. + Dim image__1 As Image = Image.FromFile("Image.png") + Dim stream As New MemoryStream() + image__1.Save(stream, System.Drawing.Imaging.ImageFormat.Png) + Dim imageBytes As Byte() = stream.ToArray() + 'Add image to the paragraph + Dim picture As IWPicture = firstParagraph.AppendPicture(imageBytes) + 'Set height and width for the image + picture.Height = 100 + picture.Width = 100 + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends the SVG image specified by the array to the end of paragraph. + + The array of the SVG image to be added. + The array of the image to be added. + The instance that represents the newly added image. + Thrown when is null + Thrown when is not a *svg format + The following example illustrates how to append image to the paragraph. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph firstParagraph = section.AddParagraph(); + //Get the image as byte array. + byte[] imageBytes = File.ReadAllBytes("Image.png"); + //Get the SVG image as byte array. + byte[] svgData = File.ReadAllBytes("Image.svg"); + //Add SVG image to the paragraph + IWPicture picture = firstParagraph.AppendPicture(svgData, imageBytes); + //Set height and width for the image + picture.Height = 100; + picture.Width = 100; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim firstParagraph As IWParagraph = section.AddParagraph() + 'Get the png image as byte array. + Dim imageBytes As Byte() = File.ReadAllBytes("Image.png") + 'Get the SVG image as byte array. + Dim svgData As Byte() = File.ReadAllBytes("Image.svg") + 'Add SVG image to the paragraph + Dim picture As IWPicture = firstParagraph.AppendPicture(svgData, imageBytes); + 'Set height and width for the image + picture.Height = 100 + picture.Width = 100 + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Appends a chart to the end of the paragraph with the specified data, width and height. + + The two-dimensional array that specifies the data for chart. + The float that represents the width for chart. + The float that represents the height for chart. + The instance that represents the newly added chart. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform and Xamarin platforms. + The following example illustrates how to append new chart to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Input data for chart + object[][] data = new object[6][]; + for (int i = 0; i < 6; i++) + data[i] = new object[3]; + data[0][0] = ""; + data[1][0] = "Gravad lax"; + data[2][0] = "Louisiana Hot spiced Okara"; + data[3][0] = "Mascarpone Fabioli"; + data[4][0] = "Wimmers gute SemmelKnodel"; + data[5][0] = "Maxilaku"; + data[0][1] = "Sum of Purchases"; + data[1][1] = 286; + data[2][1] = 680; + data[3][1] = 288; + data[4][1] = 200; + data[5][1] = 731; + data[0][2] = "Sum of Future Expenses"; + data[1][2] = 1300; + data[2][2] = 700; + data[3][2] = 1280; + data[4][2] = 1200; + data[5][2] = 2660; /// + //Create and Append chart to the paragraph + WChart chart = paragraph.AppendChart(data, 470, 300); + //Set chart type and title + chart.ChartTitle = "Purchase Details"; + chart.ChartTitleArea.FontName = "Calibri"; + chart.ChartTitleArea.Size = 14; + chart.ChartArea.Border.LinePattern = OfficeChartLinePattern.None; + //Set series type + chart.Series[0].SerieType = OfficeChartType.Line_Markers; + chart.Series[1].SerieType = OfficeChartType.Bar_Clustered; + chart.PrimaryCategoryAxis.Title = "Products"; + chart.PrimaryValueAxis.Title = "In Dollars"; + //Set position of legend + chart.Legend.Position = OfficeLegendPosition.Bottom; + //Save the document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Input data for chart + Dim data As Object()() = New Object(5)() {} + For i As Integer = 0 To 5 + data(i) = New Object(2) {} + Next + data(0)(0) = "" + data(1)(0) = "Gravad lax" + data(2)(0) = "Louisiana Hot spiced Okara" + data(3)(0) = "Mascarpone Fabioli" + data(4)(0) = "Wimmers gute SemmelKnodel" + data(5)(0) = "Maxilaku" + data(0)(1) = "Sum of Purchases" + data(1)(1) = 286 + data(2)(1) = 680 + data(3)(1) = 288 + data(4)(1) = 200 + data(5)(1) = 731 + data(0)(2) = "Sum of Future Expenses" + data(1)(2) = 1300 + data(2)(2) = 700 + data(3)(2) = 1280 + data(4)(2) = 1200 + data(5)(2) = 2660 + 'Create and Append chart to the paragraph + Dim chart As WChart = paragraph.AppendChart(data, 470, 300) + 'Set chart type and title + chart.ChartTitle = "Purchase Details" + chart.ChartTitleArea.FontName = "Calibri" + chart.ChartTitleArea.Size = 14 + chart.ChartArea.Border.LinePattern = OfficeChartLinePattern.None + 'Set series type + chart.Series(0).SerieType = OfficeChartType.Line_Markers + chart.Series(1).SerieType = OfficeChartType.Bar_Clustered + chart.PrimaryCategoryAxis.Title = "Products" + chart.PrimaryValueAxis.Title = "In Dollars" + 'Set position of legend + chart.Legend.Position = OfficeLegendPosition.Bottom + 'Save the document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends chart to the end of the paragraph with the specified width and height. + + The float that represents the width for chart. + The float that represents the height for chart. + The instance that represents the newly added chart. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform and Xamarin platforms. + The following example illustrates how to append new chart to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Create and Append chart to the paragraph + WChart chart = paragraph.AppendChart(446, 270); + //Set chart type + chart.ChartType = OfficeChartType.Pie; + //Set chart title + chart.ChartTitle = "Best Selling Products"; + chart.ChartTitleArea.FontName = "Calibri"; + chart.ChartTitleArea.Size = 14; + //Set data for chart + chart.ChartData.SetValue(1, 1, ""); + chart.ChartData.SetValue(1, 2, "Sales"); + chart.ChartData.SetValue(2, 1, "Cote de Blaye"); + chart.ChartData.SetValue(2, 2, 141.396); + chart.ChartData.SetValue(3, 1, "Thuringer Rostbratwurst"); + chart.ChartData.SetValue(3, 2, 80.368); + chart.ChartData.SetValue(4, 1, "Raclette Courdavault"); + chart.ChartData.SetValue(4, 2, 71.155); + chart.ChartData.SetValue(5, 1, "Tarte au sucre"); + chart.ChartData.SetValue(5, 2, 47.234); + chart.ChartData.SetValue(6, 1, "Camembert Pierrot"); + chart.ChartData.SetValue(6, 2, 46.825); + chart.ChartData.SetValue(7, 1, "Gnocchi di nonna Alice"); + chart.ChartData.SetValue(7, 2, 42.593); + chart.ChartData.SetValue(8, 1, "Manjimup Dried Apples"); + chart.ChartData.SetValue(8, 2, 41.819); + chart.ChartData.SetValue(9, 1, "Alice Mutton"); + chart.ChartData.SetValue(9, 2, 32.698); + chart.ChartData.SetValue(10, 1, "Carnarvon Tigers"); + chart.ChartData.SetValue(10, 2, 29.171); + chart.ChartData.SetValue(11, 1, "Rössle Sauerkraut."); + chart.ChartData.SetValue(11, 2, 25.696); + //Create a new chart series with the name “Sales” + IOfficeChartSerie pieSeries = chart.Series.Add("Sales"); + pieSeries.Values = chart.ChartData[2, 2, 11, 2]; + //Set data label + pieSeries.DataPoints.DefaultDataPoint.DataLabels.IsValue = true; + pieSeries.DataPoints.DefaultDataPoint.DataLabels.Position = OfficeDataLabelPosition.Outside; + //Set background color + chart.ChartArea.Fill.ForeColor = Color.FromArgb(242, 242, 242); + chart.PlotArea.Fill.ForeColor = Color.FromArgb(242, 242, 242); + chart.ChartArea.Border.LinePattern = OfficeChartLinePattern.None; + //Set category labels + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 11, 1]; + //Save the document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Create and Append chart to the paragraph + Dim chart As WChart = paragraph.AppendChart(446, 270) + 'Set chart type + chart.ChartType = OfficeChartType.Pie + 'Set chart title + chart.ChartTitle = "Best Selling Products" + chart.ChartTitleArea.FontName = "Calibri" + chart.ChartTitleArea.Size = 14 + 'Set data for chart + chart.ChartData.SetValue(1, 1, "") + chart.ChartData.SetValue(1, 2, "Sales") + chart.ChartData.SetValue(2, 1, "Cote de Blaye") + chart.ChartData.SetValue(2, 2, 141.396) + chart.ChartData.SetValue(3, 1, "Thuringer Rostbratwurst") + chart.ChartData.SetValue(3, 2, 80.368) + chart.ChartData.SetValue(4, 1, "Raclette Courdavault") + chart.ChartData.SetValue(4, 2, 71.155) + chart.ChartData.SetValue(5, 1, "Tarte au sucre") + chart.ChartData.SetValue(5, 2, 47.234) + chart.ChartData.SetValue(6, 1, "Camembert Pierrot") + chart.ChartData.SetValue(6, 2, 46.825) + chart.ChartData.SetValue(7, 1, "Gnocchi di nonna Alice") + chart.ChartData.SetValue(7, 2, 42.593) + chart.ChartData.SetValue(8, 1, "Manjimup Dried Apples") + chart.ChartData.SetValue(8, 2, 41.819) + chart.ChartData.SetValue(9, 1, "Alice Mutton") + chart.ChartData.SetValue(9, 2, 32.698) + chart.ChartData.SetValue(10, 1, "Carnarvon Tigers") + chart.ChartData.SetValue(10, 2, 29.171) + chart.ChartData.SetValue(11, 1, "Rössle Sauerkraut.") + 'Create a new chart series with the name “Sales” + Dim pieSeries As IOfficeChartSerie = chart.Series.Add("Sales") + pieSeries.Values = chart.ChartData(2, 2, 11, 2) + 'Set data label + pieSeries.DataPoints.DefaultDataPoint.DataLabels.IsValue = True + pieSeries.DataPoints.DefaultDataPoint.DataLabels.Position = OfficeDataLabelPosition.Outside + 'Set background color + chart.ChartArea.Fill.ForeColor = Color.FromArgb(242, 242, 242) + chart.PlotArea.Fill.ForeColor = Color.FromArgb(242, 242, 242) + chart.ChartArea.Border.LinePattern = OfficeChartLinePattern.None + 'Set category labels + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData(2, 1, 11, 1) + 'Save the document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends chart to the end of the paragraph from the excel file with specified sheet number, range of data, width, and height. + + The excel stream that has data for chart [Excel stream should be "*.xlsx" format]. + The integer represents the worksheet number that has data for chart. + The string represents the data range in the worksheet from which the chart is to be created. + The float that represents the width for chart. + The float that represents the height for chart. + The instance that represents the newly added chart. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform and Xamarin platforms. + The following example illustrates how to append new chart to the paragraph using the excel stream. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Load the excel file as stream + Stream excelStream = File.OpenRead("Excel_Template.xlsx"); + //Create and Append chart to the paragraph with excel stream as parameter + WChart chart = paragraph.AppendChart(excelStream, 1, "B2:C6", 470, 300); + //Set chart type and title + chart.ChartType = OfficeChartType.Column_Clustered; + chart.ChartTitle = "Purchase Details"; + chart.ChartTitleArea.FontName = "Calibri"; + chart.ChartTitleArea.Size = 14; + chart.ChartArea.Border.LinePattern = OfficeChartLinePattern.None; + //Set name to chart series + chart.Series[0].Name = "Sum of Purchases"; + chart.Series[1].Name = "Sum of Future Expenses"; + chart.PrimaryCategoryAxis.Title = "Products"; + chart.PrimaryValueAxis.Title = "In Dollars"; + //Set position of legend + chart.Legend.Position = OfficeLegendPosition.Bottom; + //Save the document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Load the excel file as stream + Dim excelStream As Stream = File.OpenRead("Excel_Template.xlsx") + 'Create and Append chart to the paragraph with excel stream as parameter + Dim chart As WChart = paragraph.AppendChart(excelStream, 1, "B2:C6", 470, 300) + 'Set chart type and title + chart.ChartType = OfficeChartType.Column_Clustered + chart.ChartTitle = "Purchase Details" + chart.ChartTitleArea.FontName = "Calibri" + chart.ChartTitleArea.Size = 14 + chart.ChartArea.Border.LinePattern = OfficeChartLinePattern.None + 'Set name to chart series + chart.Series(0).Name = "Sum of Purchases" + chart.Series(1).Name = "Sum of Future Expenses" + chart.PrimaryCategoryAxis.Title = "Products" + chart.PrimaryValueAxis.Title = "In Dollars" + 'Set position of legend + chart.Legend.Position = OfficeLegendPosition.Bottom + 'Save the document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Method to identify the Excel file format + + Excel file stream + + + + + Appends field to end of the paragraph with the specified field name and field type. + + The string that specifies the field name. + The member that specifies the type of the field. + The instance of the newly added field. + The following example illustrates how to append field to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an instance of WordDocument class (Empty Word Document) + WordDocument document = new WordDocument(); + //Add a new section into the Word Document + IWSection section = document.AddSection(); + //Add a new paragraph into Word document and append text into paragraph + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("Today's Date: "); + //Add the new Date field in Word document with field name and its type. + WField field = paragraph.AppendField("Date", FieldType.FieldDate) as WField; + //Field code used to describe how to display the date + field.FieldCode = @"DATE \@" + "\"MMMM d, yyyy\""; + //Save the document in the given name and format + document.Save("Sample.docx", FormatType.Docx); + //Release the resources occupied by WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an instance of WordDocument class (Empty Word Document) + Dim document As New WordDocument() + 'Add a new section into the Word Document + Dim section As IWSection = document.AddSection() + 'Add a new paragraph into Word document and append text into paragraph + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("Today's Date: ") + 'Add the new Date field in Word document with field name and its type. + Dim field As WField = TryCast(paragraph.AppendField("Date", FieldType.FieldDate), WField) + 'Field code used to describe how to display the date + field.FieldCode = "DATE \@" + """MMMM d, yyyy""" + 'Save the document in the given name and format + document.Save("Sample.docx", FormatType.Docx) + 'Release the resources occupied by WordDocument instance + document.Close() + End Sub + + + + + + Appends the hyperlink to the paragraph with the specified link, display text and type of link. + + The string that specifies the link. + The string that specifies the text to display. + The member that specifies the link type. + The instance that represents the newly added hyperlink. + The following example illustrates how to append field to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("Web Hyperlink: "); + paragraph = section.AddParagraph(); + //Append web hyperlink to the paragraph + IWField field = paragraph.AppendHyperlink("http://www.syncfusion.com", "Syncfusion", HyperlinkType.WebLink); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("Web Hyperlink: ") + paragraph = section.AddParagraph() + 'Append web hyperlink to the paragraph + Dim field As IWField = paragraph.AppendHyperlink("http://www.syncfusion.com", "Syncfusion", HyperlinkType.WebLink) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends the hyperlink to the paragraph with the specified link, picture and type of link. + + The string that specifies the link. + The picture to display. + The member that specifies the link type. + The instance that represents the newly added hyperlink. + The following example illustrates how to append field to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("Image Hyperlink"); + paragraph = section.AddParagraph(); + //Create a new image instance and load image + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + //Append new image hyperlink to the paragraph + paragraph.AppendHyperlink("http://www.syncfusion.com", picture, HyperlinkType.WebLink); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("Image Hyperlink") + paragraph = section.AddParagraph() + 'Create a new image instance and load image + Dim picture As New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + 'Append new image hyperlink to the paragraph + paragraph.AppendHyperlink("http://www.syncfusion.com", picture, HyperlinkType.WebLink) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends start of the bookmark with specified name to the paragraph. + + The string specifying the bookmark name. + The instance that represents the newly added bookmark start. + The following example illustrates how to add a bookmark to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an instance of WordDocument class (Empty Word Document) + WordDocument document = new WordDocument(); + //Add a new section into the Word Document + IWSection section = document.AddSection(); + //Add a new paragraph into Word document and append text into paragraph + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("Northwind Database"); + paragraph.ParagraphFormat.HorizontalAlignment = Syncfusion.DocIO.DLS.HorizontalAlignment.Center; + //Add a paragraph into section + paragraph = section.AddParagraph(); + //Add a new bookmark start into paragraph with name "Northwind" + paragraph.AppendBookmarkStart("Northwind"); + //Add a text between the bookmark start and end into paragraph + paragraph.AppendText("The Northwind sample database (Northwind.mdb) is included with all versions of Access. It provides data you can experiment with and database objects that demonstrate features you might want to implement in your own databases."); + //Add a new bookmark end into paragraph with name " Northwind " + paragraph.AppendBookmarkEnd("Northwind"); + //Add a text after the bookmark end + paragraph.AppendText(" Using Northwind, you can become familiar with how a relational database is structured and how the database objects work together to help you enter, store, manipulate, and print your data."); + //Save the document in the given name and format + document.Save("Bookmarks.docx", FormatType.Docx); + //Release the resources occupied by WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an instance of WordDocument class (Empty Word Document) + Dim document As New WordDocument() + 'Add a new section into the Word Document + Dim section As IWSection = document.AddSection() + 'Add a new paragraph into Word document and append text into paragraph + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("Northwind Database") + paragraph.ParagraphFormat.HorizontalAlignment = Syncfusion.DocIO.DLS.HorizontalAlignment.Center + 'Add a paragraph into section + paragraph = section.AddParagraph() + 'Add a new bookmark start into paragraph with name "Northwind" + paragraph.AppendBookmarkStart("Northwind") + 'Add a text between the bookmark start and end into paragraph + paragraph.AppendText("The Northwind sample database (Northwind.mdb) is included with all versions of Access. It provides data you can experiment with and database objects that demonstrate features you might want to implement in your own databases.") + 'Add a new bookmark end into paragraph with name " Northwind " + paragraph.AppendBookmarkEnd("Northwind") + 'Add a text after the bookmark end + paragraph.AppendText(" Using Northwind, you can become familiar with how a relational database is structured and how the database objects work together to help you enter, store, manipulate, and print your data.") + 'Save the document in the given name and format + document.Save("Bookmarks.docx", FormatType.Docx) + 'Release the resources occupied by WordDocument instance + document.Close() + End Sub + + + + + + Appends end of the bookmark with specified name to the paragraph. + + The string specifying the bookmark name. + The instance that represents the newly added bookmark end. + The following example illustrates how to add a bookmark to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an instance of WordDocument class (Empty Word Document) + WordDocument document = new WordDocument(); + //Add a new section into the Word Document + IWSection section = document.AddSection(); + //Add a new paragraph into Word document and append text into paragraph + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("Northwind Database"); + paragraph.ParagraphFormat.HorizontalAlignment = Syncfusion.DocIO.DLS.HorizontalAlignment.Center; + //Add a paragraph into section + paragraph = section.AddParagraph(); + //Add a new bookmark start into paragraph with name "Northwind" + paragraph.AppendBookmarkStart("Northwind"); + //Add a text between the bookmark start and end into paragraph + paragraph.AppendText("The Northwind sample database (Northwind.mdb) is included with all versions of Access. It provides data you can experiment with and database objects that demonstrate features you might want to implement in your own databases."); + //Add a new bookmark end into paragraph with name " Northwind " + paragraph.AppendBookmarkEnd("Northwind"); + //Add a text after the bookmark end + paragraph.AppendText(" Using Northwind, you can become familiar with how a relational database is structured and how the database objects work together to help you enter, store, manipulate, and print your data."); + //Save the document in the given name and format + document.Save("Bookmarks.docx", FormatType.Docx); + //Release the resources occupied by WordDocument instance + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an instance of WordDocument class (Empty Word Document) + Dim document As New WordDocument() + 'Add a new section into the Word Document + Dim section As IWSection = document.AddSection() + 'Add a new paragraph into Word document and append text into paragraph + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("Northwind Database") + paragraph.ParagraphFormat.HorizontalAlignment = Syncfusion.DocIO.DLS.HorizontalAlignment.Center + 'Add a paragraph into section + paragraph = section.AddParagraph() + 'Add a new bookmark start into paragraph with name "Northwind" + paragraph.AppendBookmarkStart("Northwind") + 'Add a text between the bookmark start and end into paragraph + paragraph.AppendText("The Northwind sample database (Northwind.mdb) is included with all versions of Access. It provides data you can experiment with and database objects that demonstrate features you might want to implement in your own databases.") + 'Add a new bookmark end into paragraph with name " Northwind " + paragraph.AppendBookmarkEnd("Northwind") + 'Add a text after the bookmark end + paragraph.AppendText(" Using Northwind, you can become familiar with how a relational database is structured and how the database objects work together to help you enter, store, manipulate, and print your data.") + 'Save the document in the given name and format + document.Save("Bookmarks.docx", FormatType.Docx) + 'Release the resources occupied by WordDocument instance + document.Close() + End Sub + + + + + + Appends end of the editable range with specified id to the paragraph. + + The string specifying the editable range id. + The instance that represents the newly added editable range end. + + + + Appends the comment to the paragraph. + + The string that specifies the comment. + The instance that represents the newly added comment. + The following example illustrates how to add a comment to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Creates a new Word document. + WordDocument document = new WordDocument(); + //Add a section and a paragraph in the document + document.EnsureMinimal(); + IWParagraph paragraph = document.LastParagraph; + //Append text to the paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua"); + //Add comment to a paragraph + WComment comment = paragraph.AppendComment("comment test"); + //Specify the author of the comment + comment.Format.User = "Peter"; + //Specify the initial of the author + comment.Format.UserInitials = "St"; + //Save and close the Word document + document.Save("Comment.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Creates a new Word document. + Dim document As New WordDocument() + 'Add a section and a paragraph in the document + document.EnsureMinimal() + Dim paragraph As IWParagraph = document.LastParagraph + 'Append text to the paragraph + paragraph.AppendText("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua") + 'Add comment to a paragraph + Dim comment As WComment = paragraph.AppendComment("comment test") + 'Specify the author of the comment + comment.Format.User = "Peter" + 'Specify the initial of the author + comment.Format.UserInitials = "St" + 'Save and close the Word document + document.Save("Comment.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Appends footnote or endnotes specified by the type to the paragraph. + + The member that specifies the type of footnote. + The instance that represents the newly added footnote. + The footnotes and endnotes are differentiated by the type of the footnote. + The following example illustrates how to add a footnote to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Create a section + IWSection section = document.AddSection(); + //Add a paragraph to a section + IWParagraph paragraph = section.AddParagraph(); + //Append the text to paragraph + paragraph.AppendText("Working with footnotes"); + //Formatting the text + paragraph.ApplyStyle(BuiltinStyle.Heading1); + //Add a paragraph to a section + paragraph = section.AddParagraph(); + //Append the footnotes + WFootnote footnote = (WFootnote) paragraph.AppendFootnote(Syncfusion.DocIO.FootnoteType.Footnote); + //Set the footnote character format + footnote.MarkerCharacterFormat.SubSuperScript = SubSuperScript.SuperScript; + //Inserts the text into the paragraph + paragraph.AppendText("Sample content for footnotes").CharacterFormat.Bold = true; + //Add footnote text + paragraph = footnote.TextBody.AddParagraph(); + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Create a section + Dim section As IWSection = document.AddSection() + 'Add a paragraph to a section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Append the text to paragraph + paragraph.AppendText("Working with footnotes") + 'Formatting the text + paragraph.ApplyStyle(BuiltinStyle.Heading1) + 'Add a paragraph to a section + paragraph = section.AddParagraph() + 'Append the footnotes + Dim footnote As WFootnote = DirectCast(paragraph.AppendFootnote(Syncfusion.DocIO.FootnoteType.Footnote), WFootnote) + 'Set the footnote character format + footnote.MarkerCharacterFormat.SubSuperScript = SubSuperScript.SuperScript + 'Inserts the text into the paragraph + paragraph.AppendText("Sample content for footnotes").CharacterFormat.Bold = True + 'Add footnote text + paragraph = footnote.TextBody.AddParagraph() + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula") + ‘Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + The following example illustrates how to add a endnote to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new document + WordDocument document = new WordDocument(); + //Create a section + IWSection section = document.AddSection(); + //Add a paragraph to a section + IWParagraph paragraph = section.AddParagraph(); + //Append the text to paragraph + paragraph.AppendText("Working with endnotes"); + //Formatting the text + paragraph.ApplyStyle(BuiltinStyle.Heading1); + //Add a paragraph to a section + paragraph = section.AddParagraph(); + //Append the endnote + WFootnote endnote = (WFootnote) paragraph.AppendFootnote(Syncfusion.DocIO.FootnoteType.Endnote); + //Set the endnote character format + endnote.MarkerCharacterFormat.SubSuperScript = SubSuperScript.SuperScript; + //Insert the text into the paragraph + paragraph.AppendText("Sample content for endnotes").CharacterFormat.Bold = true; + //Add footnote text + paragraph = endnote.TextBody.AddParagraph(); + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new document + Dim document As New WordDocument() + 'Create a section + Dim section As IWSection = document.AddSection() + 'Add a paragraph to a section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Append the text to paragraph + paragraph.AppendText("Working with endnotes") + 'Formatting the text + paragraph.ApplyStyle(BuiltinStyle.Heading1) + 'Add a paragraph to a section + paragraph = section.AddParagraph() + 'Append the endnote + Dim endnote As WFootnote = DirectCast(paragraph.AppendFootnote(Syncfusion.DocIO.FootnoteType.Endnote), WFootnote) + 'Set the endnote character format + endnote.MarkerCharacterFormat.SubSuperScript = SubSuperScript.SuperScript + 'Insert the text into the paragraph + paragraph.AppendText("Sample content for endnotes").CharacterFormat.Bold = True + 'Add footnote text + paragraph = endnote.TextBody.AddParagraph() + paragraph.AppendText("Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula") + ‘Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Append textbox to the end of the paragraph with the specified width and height. + + The float specifies the width of the textbox. + The float specifies the height of the textbox. + The instance that represents the newly added textbox. + The following example illustrates how to add a endnote to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Append new textbox to the paragraph + IWTextBox textbox = paragraph.AppendTextBox(150, 75); + //Add new text to the textbox body + IWParagraph textboxParagraph = textbox.TextBoxBody.AddParagraph(); + textboxParagraph.AppendText("Text inside text box"); + //Save and close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Append new textbox to the paragraph + Dim textbox As IWTextBox = paragraph.AppendTextBox(150, 75) + 'Add new text to the textbox body + Dim textboxParagraph As IWParagraph = textbox.TextBoxBody.AddParagraph() + textboxParagraph.AppendText("Text inside text box") + 'Save and close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Appends the check box to the paragraph. + + The instance that represents the newly added checkbox. + The following example illustrates how to add a checkbox to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + WParagraph paragraph = section.AddParagraph() as WParagraph; + paragraph.AppendText("Gender\t"); + //Append new Checkbox + WCheckBox checkbox = paragraph.AppendCheckBox(); + checkbox.Checked = false; + //Set Checkbox size + checkbox.CheckBoxSize = 10; + checkbox.CalculateOnExit = true; + //Set help text + checkbox.Help = "Help text"; + paragraph.AppendText("Male\t"); + checkbox = paragraph.AppendCheckBox(); + checkbox.Checked = false; + checkbox.CheckBoxSize = 10; + checkbox.CalculateOnExit = true; + paragraph.AppendText("Female"); + //Save the Word document + document.Save("Checkbox.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(section.AddParagraph(), WParagraph) + paragraph.AppendText("Gender" & vbTab) + 'Append new Checkbox + Dim checkbox As WCheckBox = paragraph.AppendCheckBox() + checkbox.Checked = False + 'Set Checkbox size + checkbox.CheckBoxSize = 10 + checkbox.CalculateOnExit = True + 'Set help text + checkbox.Help = "Help text" + paragraph.AppendText("Male" & vbTab) + checkbox = paragraph.AppendCheckBox() + checkbox.Checked = False + checkbox.CheckBoxSize = 10 + checkbox.CalculateOnExit = True + paragraph.AppendText("Female") + 'Save the Word document + document.Save("Checkbox.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends the check box to the paragraph with specified name and default value. + + The string that specifies the name of the check box. + A Boolean indicating the default value of the checkbox. + True if the checkbox should be checked by default; otherwise, false. + The instance that represents the newly added checkbox. + The following example illustrates how to add a checkbox to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + WParagraph paragraph = section.AddParagraph() as WParagraph; + paragraph.AppendText("Gender\t"); + //Append new Checkbox + WCheckBox checkbox = paragraph.AppendCheckBox("CheckBox1", true); + //checkbox.Checked = false; + //Set Checkbox size + checkbox.CheckBoxSize = 10; + checkbox.CalculateOnExit = true; + //Set help text + checkbox.Help = "Help text"; + paragraph.AppendText("Male\t"); + checkbox = paragraph.AppendCheckBox("CheckBox2",false); + //checkbox.Checked = false; + checkbox.CheckBoxSize = 10; + checkbox.CalculateOnExit = true; + paragraph.AppendText("Female"); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(section.AddParagraph(), WParagraph) + paragraph.AppendText("Gender" & vbTab) + 'Append new Checkbox + Dim checkbox As WCheckBox = paragraph.AppendCheckBox("CheckBox1", True) + 'checkbox.Checked = false; + 'Set Checkbox size + checkbox.CheckBoxSize = 10 + checkbox.CalculateOnExit = True + 'Set help text + checkbox.Help = "Help text" + paragraph.AppendText("Male" & vbTab) + checkbox = paragraph.AppendCheckBox("CheckBox2", False) + 'checkbox.Checked = false; + checkbox.CheckBoxSize = 10 + checkbox.CalculateOnExit = True + paragraph.AppendText("Female") + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends the text form field to the paragraph with the specified default text. + + The string specifying the default text. + To insert default Word text, "null" can be passed as parameter. + The instance that represents the newly added text form field. + The following example illustrates how to add a text form field to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + WParagraph paragraph = section.AddParagraph() as WParagraph; + paragraph.AppendText("General Information"); + section.AddParagraph(); + paragraph = section.AddParagraph() as WParagraph; + IWTextRange text = paragraph.AppendText("Name\t"); + text.CharacterFormat.Bold = true; + //Append Text form field + WTextFormField textfield = paragraph.AppendTextFormField(null); + //Set type of Text form field + textfield.Type = TextFormFieldType.RegularText; + textfield.CharacterFormat.FontName = "Calibri"; + textfield.CalculateOnExit = true; + //Save the Word document + document.Save("Textfield.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(section.AddParagraph(), WParagraph) + paragraph.AppendText("General Information") + section.AddParagraph() + paragraph = TryCast(section.AddParagraph(), WParagraph) + Dim text As IWTextRange = paragraph.AppendText("Name" & vbTab) + text.CharacterFormat.Bold = True + 'Append Text form field + Dim textfield As WTextFormField = paragraph.AppendTextFormField(Nothing) + 'Set type of Text form field + textfield.Type = TextFormFieldType.RegularText + textfield.CharacterFormat.FontName = "Calibri" + textfield.CalculateOnExit = True + 'Save the Word document + document.Save("Textfield.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends the text form field to the paragraph with the specified field name and default text. + + The string that specifies the name of the form field. + The string specifying the default text. + To insert default Word text, "null" can be passed as parameter. + The instance that represents the newly added text form field. + The following example illustrates how to add a text form field to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + WParagraph paragraph = section.AddParagraph() as WParagraph; + paragraph.AppendText("General Information"); + section.AddParagraph(); + paragraph = section.AddParagraph() as WParagraph; + IWTextRange text = paragraph.AppendText("Date of Birth\t"); + text.CharacterFormat.Bold = true; + //Append Text form field + WTextFormField textfield = paragraph.AppendTextFormField("Date field", DateTime.Now.ToString("MM/DD/YY")); + textfield.StringFormat = "MM/DD/YY"; + //Set Text form field type + textfield.Type = TextFormFieldType.DateText; + textfield.CalculateOnExit = true; + //Save the Word document + document.Save("Textfield.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(section.AddParagraph(), WParagraph) + paragraph.AppendText("General Information") + section.AddParagraph() + paragraph = TryCast(section.AddParagraph(), WParagraph) + Dim text As IWTextRange = paragraph.AppendText("Date of Birth" & vbTab) + text.CharacterFormat.Bold = True + 'Append Text form field + Dim textfield As WTextFormField = paragraph.AppendTextFormField("Date field", DateTime.Now.ToString("MM/DD/YY")) + textfield.StringFormat = "MM/DD/YY" + 'Set Text form field type + textfield.Type = TextFormFieldType.DateText + textfield.CalculateOnExit = True + 'Save the Word document + document.Save("Textfield.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends the drop down form field to the paragraph. + + The instance that represents the newly added drop down form field. + + + + Appends the drop down form field to the paragraph. + + The string that specifies the name of the drop drop down field. + The instance that represents the newly added drop down form field. + The following example illustrates how to add a checkbox to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + WParagraph paragraph = section.AddParagraph() as WParagraph; + paragraph.AppendText("Educational Qualification\t"); + //Append Dropdown field + WDropDownFormField dropdownfield = paragraph.AppendDropDownFormField("FieldName"); + //Add items to the dropdown items collection + dropdownfield.DropDownItems.Add("Higher"); + dropdownfield.DropDownItems.Add("Vocational"); + dropdownfield.DropDownItems.Add("Universal"); + dropdownfield.Enabled = true; + //Set the item index for default value + dropdownfield.DropDownSelectedIndex = 1; + dropdownfield.CalculateOnExit = true; + //Save the Word document + document.Save("Dropdown.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(section.AddParagraph(), WParagraph) + paragraph.AppendText("Educational Qualification" & vbTab) + 'Append Dropdown field + Dim dropdownfield As WDropDownFormField = paragraph.AppendDropDownFormField("FieldName") + 'Add items to the dropdown items collection + dropdownfield.DropDownItems.Add("Higher") + dropdownfield.DropDownItems.Add("Vocational") + dropdownfield.DropDownItems.Add("Universal") + dropdownfield.Enabled = True + 'Set the item index for default value + dropdownfield.DropDownSelectedIndex = 1 + dropdownfield.CalculateOnExit = True + 'Save the Word document + document.Save("Dropdown.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends special symbol specified by the character code to end of the paragraph. + + The byte represents the character code of the symbol. + The instance that represents the newly added symbol. + The following example illustrates how to add a symbol to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("Example of adding symbols to the paragraph: "); + //Insert symbol with character code 100 + paragraph.AppendSymbol(100); + //Save and close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("Example of adding symbols to the paragraph: ") + 'Insert symbol with character code 100 + paragraph.AppendSymbol(100) + 'Save and close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Appends break of the specified type to end of the paragraph. + + The member that specifies the type of break. + The instance that represents the newly added break. + The following example illustrates how to add a break to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("Before line break"); + //Add line break to the paragraph + paragraph.AppendBreak(BreakType.LineBreak); + paragraph.AppendText("After line break"); + IWParagraph pageBreakPara = section.AddParagraph(); + pageBreakPara.AppendText("Before page break"); + //Add page break to the paragraph + pageBreakPara.AppendBreak(BreakType.PageBreak); + pageBreakPara.AppendText("After page break"); + IWSection secondSection = document.AddSection(); + //Add columns to the section + secondSection.AddColumn(100, 2); + secondSection.AddColumn(100, 2); + IWParagraph columnBreakPara = secondSection.AddParagraph(); + columnBreakPara.AppendText("Before column break"); + //Add column break to the paragraph + columnBreakPara.AppendBreak(BreakType.ColumnBreak); + columnBreakPara.AppendText("After column break"); + //Save and Close the document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("Before line break") + 'Add line break to the paragraph + paragraph.AppendBreak(BreakType.LineBreak) + paragraph.AppendText("After line break") + Dim pageBreakPara As IWParagraph = section.AddParagraph() + pageBreakPara.AppendText("Before page break") + 'Add page break to the paragraph + pageBreakPara.AppendBreak(BreakType.PageBreak) + pageBreakPara.AppendText("After page break") + Dim secondSection As IWSection = document.AddSection() + 'Add columns to the section + secondSection.AddColumn(100, 2) + secondSection.AddColumn(100, 2) + Dim columnBreakPara As IWParagraph = secondSection.AddParagraph() + columnBreakPara.AppendText("Before column break") + 'Add column break to the paragraph + columnBreakPara.AppendBreak(BreakType.ColumnBreak) + columnBreakPara.AppendText("After column break") + 'Save and Close the document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Appends of specified type, width and height to the end of paragraph. + + The member that specifies the shape type. + The float that specifies the width of the shape. + The float that specifies the height of the shape. + The instance that represents the newly added shape. + The following example illustrates how to add a shape to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + WParagraph paragraph = section.AddParagraph() as WParagraph; + //Add new shape to the document + Shape rectangle = paragraph.AppendShape(AutoShapeType.RoundedRectangle, 150, 100); + //Set position for shape + rectangle.VerticalPosition = 72; + rectangle.HorizontalPosition = 72; + paragraph = section.AddParagraph() as WParagraph; + //Add text body contents to the shape + paragraph = rectangle.TextBody.AddParagraph() as WParagraph; + IWTextRange text = paragraph.AppendText("This text is in rounded rectangle shape"); + text.CharacterFormat.TextColor = Color.Green; + text.CharacterFormat.Bold = true; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(section.AddParagraph(), WParagraph) + 'Add new shape to the document + Dim rectangle As Shape = paragraph.AppendShape(AutoShapeType.RoundedRectangle, 150, 100) + 'Set position for shape + rectangle.VerticalPosition = 72 + rectangle.HorizontalPosition = 72 + paragraph = TryCast(section.AddParagraph(), WParagraph) + 'Add text body contents to the shape + paragraph = TryCast(rectangle.TextBody.AddParagraph(), WParagraph) + Dim text As IWTextRange = paragraph.AppendText("This text is in rounded rectangle shape") + text.CharacterFormat.TextColor = Color.Green + text.CharacterFormat.Bold = True + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends the table of content to the end of the paragraph with the specified lower and upper heading levels. + + The integer specifying the starting heading level of the table of content. + The integer specifying the ending heading level of the table of content. + The instance that represents the newly added table of content. + The following example illustrates how to add a table of contents to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add the section into the Word document + IWSection section = document.AddSection(); + string paraText = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"; + //Add the paragraph into the created section + IWParagraph paragraph = section.AddParagraph(); + //Append the TOC field with LowerHeadingLevel and UpperHeadingLevel to determines the TOC entries + paragraph.AppendTOC(1, 3); + //Add the section into the Word document + section = document.AddSection(); + //Add the paragraph into the created section + paragraph = section.AddParagraph(); + //Add the text for the headings + paragraph.AppendText("First Chapter"); + //Set a build in heading style. + paragraph.ApplyStyle(BuiltinStyle.Heading1); + //Add the text into the paragraph + section.AddParagraph().AppendText(paraText); + //Add the section into the Word document + section = document.AddSection(); + //Add the paragraph into the created section + paragraph = section.AddParagraph(); + //Add the text for the headings + paragraph.AppendText("Second Chapter"); + //Set a build in heading style. + paragraph.ApplyStyle(BuiltinStyle.Heading2); + //Add the text into the paragraph + section.AddParagraph().AppendText(paraText); + //Add the section into the Word document + section = document.AddSection(); + //Add the paragraph into the created section + paragraph = section.AddParagraph(); + //Add the text into the headings + paragraph.AppendText("Third Chapter"); + //Set a build in heading style + paragraph.ApplyStyle(BuiltinStyle.Heading3); + //Add the text into the paragraph. + section.AddParagraph().AppendText(paraText); + //Update the table of contents + document.UpdateTableOfContents(); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add the section into the Word document + Dim section As IWSection = document.AddSection() + Dim paraText As String = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula" + 'Add the paragraph into the created section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Append the TOC field with LowerHeadingLevel and UpperHeadingLevel to determines the TOC entries + paragraph.AppendTOC(1, 3) + 'Add the section into the Word document + section = document.AddSection() + 'Add the paragraph into the created section + paragraph = section.AddParagraph() + 'Add the text for the headings + paragraph.AppendText("First Chapter") + 'Set a build in heading style + paragraph.ApplyStyle(BuiltinStyle.Heading1) + 'Add the text into the paragraph. + section.AddParagraph().AppendText(paraText) + 'Add the section into the Word document + section = document.AddSection() + 'Add the paragraph into the created section + paragraph = section.AddParagraph() + 'Add the text for the headings + paragraph.AppendText("Second Chapter") + 'Set a build in heading style + paragraph.ApplyStyle(BuiltinStyle.Heading2) + 'Add the text into the paragraph + section.AddParagraph().AppendText(paraText) + 'Add the section into the Word document + section = document.AddSection() + 'Add the paragraph into the created section + paragraph = section.AddParagraph() + 'Add the text into the headings + paragraph.AppendText("Third Chapter") + 'Set a build in heading style + paragraph.ApplyStyle(BuiltinStyle.Heading3) + 'Add the text into the paragraph + section.AddParagraph().AppendText(paraText) + 'Update the table of contents + document.UpdateTableOfContents() + ‘Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Appends a Cross-Reference of specified reference type, reference kind, entity, hyperlink, separators at the end of the paragraph. + + The member that specifies the + type of item for which a cross-reference is to be inserted. + The member that specifies the + information to be included in the cross-reference. + The for which a cross-reference is to be inserted. + True if to insert the cross-reference as a hyperlink to the referenced item; otherwise, false. + True if to insert "above" or "below," depending on the location of the reference item in relation to the cross-reference. + True if to use a separator to separate the numbers from the associated text; otherwise, false.(Used only if the ReferenceKind parameter is set to ParagraphNumberFullContext). + The string that specifies a separator if the separateNumber parameter is set to true. + + The cross reference fields can be created and updated only for the in a document. + Use the method to get a list of items that can have cross-reference. + + + + The following example illustrates how to append a cross-reference for bookmark to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + IWParagraph paragraph = section.AddParagraph(); + //Add text, bookmark start and end in the paragraph + paragraph.AppendBookmarkStart("Title"); + paragraph.AppendText("Northwind Database"); + paragraph.AppendBookmarkEnd("Title"); + paragraph = section.AddParagraph(); + paragraph.AppendText("The Northwind sample database (Northwind.mdb) is included with all versions of Access. It provides data you can experiment with and database objects that demonstrate features you might want to implement in your own databases."); + section = document.AddSection(); + section.AddParagraph(); + paragraph = section.AddParagraph() as WParagraph; + //Get the collection of bookmark start in the word document + List<Entity> items = document.GetCrossReferenceItems(ReferenceType.Bookmark); + paragraph.AppendText("Bookmark Cross Reference starts here "); + //Append the cross reference for bookmark “Title” with ContentText as reference kind + paragraph.AppendCrossReference(ReferenceType.Bookmark, ReferenceKind.ContentText, items[0], true, false, false, string.Empty); + //Update the document Fields + document.UpdateDocumentFields(); + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add text, bookmark start and end in the paragraph + paragraph.AppendBookmarkStart("Title") + paragraph.AppendText("Northwind Database") + paragraph.AppendBookmarkEnd("Title") + paragraph = section.AddParagraph() + paragraph.AppendText("The Northwind sample database (Northwind.mdb) is included with all versions of Access. It provides data you can experiment with and database objects that demonstrate features you might want to implement in your own databases.") + section = document.AddSection() + section.AddParagraph() + paragraph = TryCast(section.AddParagraph(), WParagraph) + 'Get the collection of bookmark start in the word document + Dim items As List(Of Entity) = document.GetCrossReferenceItems(ReferenceType.Bookmark) + paragraph.AppendText("Bookmark Cross Reference starts here ") + 'Append the cross reference for bookmark “Title” with ContentText as reference kind + paragraph.AppendCrossReference(ReferenceType.Bookmark, ReferenceKind.ContentText, items(0), True, False, False, String.Empty) + 'Update the document Fields + document.UpdateDocumentFields() + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Appends the specified image to the end of paragraph. + + The to be added. + The instance that represents the newly added image. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + The following example illustrates how to append image to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add image to the paragraph + IWPicture picture = paragraph.AppendPicture(Image.FromFile("Image.png")); + //Set height and width for the image + picture.Height = 100; + picture.Width = 100; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add image to the paragraph + Dim picture As IWPicture = paragraph.AppendPicture(Image.FromFile("Image.png")) + 'Set height and width for the image + picture.Height = 100 + picture.Width = 100 + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + The following example illustrates how to append html text to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document + WordDocument document = new WordDocument("Template.docx"); + //Html string to be inserted + string htmlstring = "

This text is inserted as HTML string.

"; + IWParagraph paragraph = document.Sections[0].Body.Paragraphs[0]; + //Append the Html string to first paragraph in the document + paragraph.AppendHTML(htmlstring); + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx") + 'Html string to be inserted + Dim htmlstring As String = "

This text is inserted as HTML string.

" + Dim paragraph As IWParagraph = document.Sections(0).Body.Paragraphs(0) + 'Append the Html string to first paragraph in the document + paragraph.AppendHTML(htmlstring) + 'Save and close the document + document.Save("Sample.docx") + document.Close() + End Sub + + + + + + Appends the OLE object to the paragraph with the specified path, picture and object type. + + The string specifying the path to file. + The instance for the OLE picture. + The member that specifies the type of OLE object. + The instance that represents the newly created OLE object. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform and Xamarin platforms. + The following example illustrates how to append a OLE object to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Load the picture instance with the image need to be displayed + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + paragraph = sec.AddParagraph(); + paragraph.AppendOleObject(@"..\..\Data\Excel_Template.xlsx", picture, OleObjectType.ExcelWorksheet); + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Load the picture instance with the image need to be displayed + Dim picture As New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + paragraph = sec.AddParagraph() + paragraph.AppendOleObject("..\..\Data\Excel_Template.xlsx", picture, OleObjectType.ExcelWorksheet) + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Appends the OLE object to the paragraph with the specified path and picture. + + The string specifying the path to file. + The instance for the OLE picture. + The instance that represents the newly created OLE object. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform and Xamarin platforms. + The following example illustrates how to append a OLE object to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Load the picture instance with the image need to be displayed + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + WOleObject ole = paragraph.AppendOleObject(@"..\..\Data\Excel_Template.xlsx", picture); + //Set how to display the Ole object + ole.DisplayAsIcon = false; + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Load the picture instance with the image need to be displayed + Dim picture As New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + Dim ole As WOleObject = paragraph.AppendOleObject("..\..\Data\Excel_Template.xlsx", picture) + 'Set how to display the Ole object + ole.DisplayAsIcon = False + 'Save and close the document + document.Save("Sample.docx") + document.Close() + End Sub + + + + + + Appends the OLE object to the paragraph with the specified stream, picture and object type. + + The represents the file stream. + The instance for the OLE picture. + The member that specifies the type of OLE object. + The instance that represents the newly created OLE object. + The following example illustrates how to append OLE object to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Open the file to be embedded + FileStream stream = new FileStream("Book1.xlsx", FileMode.Open); + //Load the picture instance with the image need to be displayed + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + //Append the Ole object to the paragraph + WOleObject ole = paragraph.AppendOleObject(stream, picture, OleObjectType.ExcelWorksheet); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Open the file to be embedded + Dim stream As New FileStream("Book1.xlsx", FileMode.Open) + 'Load the picture instance with the image need to be displayed + Dim picture As New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + 'Append the Ole object to the paragraph + Dim ole As WOleObject = paragraph.AppendOleObject(stream, picture, OleObjectType.ExcelWorksheet) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends the OLE object to the paragraph with the specified byte array, picture and object type. + + The byte array of the file. + The instance for the OLE picture. + The member that specifies the type of OLE object. + The instance that represents the newly created OLE object. + The following example illustrates how to append OLE object to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Load the picture instance with the image need to be displayed + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + //Get the file as byte array + byte[] olebytes = File.ReadAllBytes("Excel_Template.xlsx"); + paragraph = sec.AddParagraph(); + //Append OLE object + paragraph.AppendOleObject(olebytes, picture, OleObjectType.ExcelWorksheet); + //Save the Word document + document.Save("Sample.docx", FormatType.Word2010); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Load the picture instance with the image need to be displayed + Dim picture As New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + 'Get the file as byte array + Dim olebytes As Byte() = File.ReadAllBytes("Excel_Template.xlsx") + paragraph = sec.AddParagraph() + 'Append OLE object + paragraph.AppendOleObject(olebytes, picture, OleObjectType.ExcelWorksheet) + 'Save the Word document + document.Save("Sample.docx", FormatType.Word2010) + 'Close the document + document.Close() + End Sub + + + + + + Appends the OLE object to the paragraph with the specified stream, picture and file link type. + + The represents the file stream. + The instance for the OLE picture. + The member that specifies the link type of OLE object. + The instance that represents the newly created OLE object. + The OLE object type must be explicitly specified when appending OLE objects using this method. + The following example illustrates how to append OLE object to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Load the picture instance with the image need to be displayed + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + FileStream stream = new FileStream("Excel_Template.xlsx", FileMode.Open); + WOleObject ole = paragraph.AppendOleObject(stream, picture, OleLinkType.Embed); + ole.ObjectType = "Excel Worksheet"; + //Save the Word document + document.Save("Sample.docx", FormatType.Word2010); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Load the picture instance with the image need to be displayed + Dim picture As New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + Dim stream As New FileStream("Excel_Template.xlsx", FileMode.Open) + Dim ole As WOleObject = paragraph.AppendOleObject(stream, picture, OleLinkType.Embed) + ole.ObjectType = "Excel Worksheet" + 'Save the Word document + document.Save("Sample.docx", FormatType.Word2010) + 'Close the document + document.Close() + End Sub + + + + + + Appends the OLE object to the paragraph with the specified byte array of the file, picture and link type. + + The byte array of the file. + The instance for the OLE picture. + The member that specifies the link type of OLE object. + The instance that represents the newly created OLE object. + The OLE object type must be explicitly specified when appending OLE objects using this method. + The following example illustrates how to append OLE object to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Load the picture instance with the image need to be displayed + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + //Get the file as byte array + byte[] olebytes = File.ReadAllBytes("Excel_Template.xlsx"); + WOleObject ole = paragraph.AppendOleObject(olebytes, picture, OleLinkType.Embed); + ole.ObjectType = "Excel Worksheet"; + //Save the Word document + document.Save("Sample.docx", FormatType.Word2010); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Load the picture instance with the image need to be displayed + Dim picture As New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + 'Get the file as byte array + Dim olebytes As Byte() = File.ReadAllBytes("Excel_Template.xlsx") + Dim ole As WOleObject = paragraph.AppendOleObject(olebytes, picture, OleLinkType.Embed) + ole.ObjectType = "Excel Worksheet" + 'Save the Word document + document.Save("Sample.docx", FormatType.Word2010) + 'Close the document + document.Close() + End Sub + + + + + + Appends the OLE object to the paragraph with the specified byte array of the file, picture and file extension. + + The byte array of the file. + The instance for the OLE picture. + The string that specifies the file extension. + The instance that represents the newly created OLE object. + The following example illustrates how to append OLE object to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Load the picture instance with the image need to be displayed + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + //Get the file as byte array + byte[] olebytes = File.ReadAllBytes("Excel_Template.xlsx"); + paragraph = sec.AddParagraph(); + //Append OLE object + paragraph.AppendOleObject(olebytes, picture, ".xlsx"); + //Save the Word document + document.Save("Sample.docx", FormatType.Word2010); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Load the picture instance with the image need to be displayed + Dim picture As New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + 'Get the file as byte array + Dim olebytes As Byte() = File.ReadAllBytes("Excel_Template.xlsx") + paragraph = sec.AddParagraph() + 'Append OLE object + paragraph.AppendOleObject(olebytes, picture, ".xlsx") + 'Save the Word document + document.Save("Sample.docx", FormatType.Word2010) + 'Close the document + document.Close() + End Sub + + + + + + Appends the OLE object to the paragraph with the specified file stream, picture and file extension. + + The represents the file stream. + The instance for the OLE picture. + The string that specifies the file extension. + The instance that represents the newly created OLE object. + The following example illustrates how to append OLE object to the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Open the file to be embedded + FileStream stream = new FileStream("Excel_Template.xlsx", FileMode.Open); + //Load the picture instance with the image need to be displayed + WPicture picture = new WPicture(document); + picture.LoadImage(Image.FromFile("Image.png")); + //Append the Ole object to the paragraph + WOleObject ole = paragraph.AppendOleObject(stream, picture, "xlsx"); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Open the file to be embedded + Dim stream As New FileStream("Excel_Template.xlsx", FileMode.Open) + 'Load the picture instance with the image need to be displayed + Dim picture As New WPicture(document) + picture.LoadImage(Image.FromFile("Image.png")) + 'Append the Ole object to the paragraph + Dim ole As WOleObject = paragraph.AppendOleObject(stream, picture, "xlsx") + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Appends the mathematical equation to the paragraph. + + The instance that represents the newly added mathematical equation. + + + + Appends a mathematical equation to the paragraph using LaTeX syntax. + + The LaTeX syntax representing the mathematical equation. + The instance that represents the newly added mathematical equation. + The following example illustrates how to append math using LaTeX to the paragraph. + + //Create a new Word document + using(WordDocument wordDocument = new WordDocument()) + { + //Adds one section and one paragraph to the document + wordDocument.EnsureMinimal(); + //Appends a new mathematical equation to the paragraph using LaTeX syntax. + wordDocument.LastParagraph.AppendMath(@"\dot{a}"); + //Saves the Word document + wordDocument.Save("Result.docx", FormatType.Docx); + } + + + 'Create a new Word document + Dim wordDocument As New WordDocument() + 'Adds one section and one paragraph to the document + wordDocument.EnsureMinimal() + 'Appends a new mathematical equation to the paragraph using LaTeX syntax. + wordDocument.LastParagraph.AppendMath("\dot{a}") + 'Saves the Word document + wordDocument.Save("Result.docx", FormatType.Docx) + 'Close the document + wordDocument.Close() + + + + + + Get the owner entity of the paragraph. + + + + + + + Heading Styles must be omitted in Header,Footer,Footnote and Endnote while converting the Word document headings into PDF bookmarks. + + + + + + Checks wheather the paragraph is in HeadFooter or not. + + Return true, If this paragraph is in HeadFooter, else Fasle. + + + + Gets the first paragraph in the owner textbody + + + + + + + Appends the field mark. + + The type. + + + + Appends lineBreak + + The line break text. + + + + + Appends the hyperlink. + + The link. + The text. + The picture. + The type. + + + + + Loads the picture. + + The picture. + The image record. + + + + Appends the index entry. + + The entry to mark. + + + + + Append merge field + + + + + + + Gets the list format. + + + + + + Gets the list format, list level, tab level index and indents. + + + + + + Gets the list level. + + The list format. + The list style hierarchy index. + + + + + Gets the list text. + + + + + + Gets the list level. + + The list format. + + + + + Get the paragraph margin left and first line indent based on heirarchy + + + + + + + + Check whether current paragraph have zero line spacing value + + + + + + + Checks whether the paragraph has line numbers. + + + + + + Determines whether the paragraph contains an item, which need to updated in TOC. + + Represents a paragraph need to check its items. + Returns true, if paragraph contains any item which need to updated in TOC; otherwise returns false. + Currently, we implemented the behaviour of updating images from heading to the table of contents. + In future, need to remove this method based on feature implementation for updating images in TOC. + + + + Returns first entry of the specified in the paragraph. + + The used to find the text. + + The that contains the found text in the paragraph. + + + The following code example demonstrates how to find a particular text in the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + WParagraph paragraph = document.Sections[0].Paragraphs[1]; + //Find the first occurrence of a particular text in the paragraph + TextSelection textSelection = paragraph.Find(new Regex("Panda")); + //Get the found text as single text range + WTextRange textRange = textSelection.GetAsOneRange(); + //Modify the text + textRange.Text = "Replaced text"; + //Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow; + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + Dim paragraph As WParagraph = document.Sections(0).Paragraphs(1) + 'Find the first occurrence of a particular text in the paragraph + Dim textSelection As TextSelection = paragraph.Find(New Regex("Panda")) + 'Get the found text as single text range + Dim textRange As WTextRange = textSelection.GetAsOneRange() + 'Modify the text + textRange.Text = "Replaced text" + 'Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + Returns first entry of given string in the paragraph, taking into consideration case sensitive and whole word options. + + The string that specifies the text to find. + + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + + The that contains the found text in the paragraph. + + + The following code example demonstrates how to find a particular text in the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + WParagraph paragraph = document.Sections[0].Paragraphs[1]; + //Find the first occurrence of a particular text in the paragraph + TextSelection textSelection = paragraph.Find("panda", true, true); + //Get the found text as single text range + WTextRange textRange = textSelection.GetAsOneRange(); + //Modify the text + textRange.Text = "Replaced text"; + //Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow; + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + Dim paragraph As WParagraph = document.Sections(0).Paragraphs(1) + 'Find the first occurrence of a particular text in the paragraph + Dim textSelection As TextSelection = paragraph.Find("panda", true, true) + 'Get the found text as single text range + Dim textRange As WTextRange = textSelection.GetAsOneRange() + 'Modify the text + textRange.Text = "Replaced text" + 'Set highlight color + textRange.CharacterFormat.HighlightColor = Color.Yellow + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + Replaces all entries of the given with the replace string. + + The used to find the text. + The string specifies the text to replace. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + WParagraph paragraph = document.Sections[0].Paragraphs[1]; + //Replace all occurrence of a particular text in the paragraph + paragraph.Replace(new Regex("Paragraph"),"paragraph"); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + Dim paragraph As WParagraph = document.Sections(0).Paragraphs(1) + 'Replace all occurrence of a particular text in the paragraph + paragraph.Replace(New Regex("Paragraph"), "paragraph") + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given string in the paragraph with replace string, taking into + consideration case sensitive and whole word options. + + The string represents the text to be found. + The string specifies the text to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + WParagraph paragraph = document.Sections[0].Paragraphs[1]; + //Replace all occurrence of a particular text in the paragraph + paragraph.Replace("Paragraph","paragraph", false, true); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + Dim paragraph As WParagraph = document.Sections(0).Paragraphs(1) + 'Replace all occurrence of a particular text in the paragraph + paragraph.Replace("Paragraph", "paragraph", False, True) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces the specified regular expression with a in the paragraph. + + The used to find the text. + The specifies the text to replace. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + WParagraph paragraph = document.Sections[0].Paragraphs[1]; + //Find the first occurrence of the regular expression + TextSelection selection = paragraph.Find(new Regex("Panda")); + //Replace all occurrence of a particular regular expression with the text selection in the paragraph + paragraph.Replace(new Regex("Giant panda"), selection); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + Dim paragraph As WParagraph = document.Sections(0).Paragraphs(1) + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = paragraph.Find(New Regex("Panda")) + 'Replace all occurrence of a particular regular expression with the text selection in the paragraph + paragraph.Replace(New Regex("Giant panda"), selection) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given regular expression in the paragraph with the + along with its formatting. + + The used to find the text. + The specifies the text to replace. + Set to true to save source formatting; otherwise, false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + WParagraph paragraph = document.Sections[0].Paragraphs[1]; + //Find the first occurrence of the regular expression + TextSelection selection = paragraph.Find(new Regex("Panda")); + //Replace all occurrence of a particular regular expression with the text selection in the paragraph + paragraph.Replace(new Regex("Giant panda"), selection, true); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + Dim paragraph As WParagraph = document.Sections(0).Paragraphs(1) + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = paragraph.Find(New Regex("Panda")) + 'Replace all occurrence of a particular regular expression with the text selection in the paragraph + paragraph.Replace(New Regex("Giant panda"), selection, True) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given string in the paragraph with , taking into + consideration case sensitive and whole word options. + + The string represents the text to be found. + The specifies the text to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + WParagraph paragraph = document.Sections[0].Paragraphs[1]; + //Find the first occurrence of the regular expression + TextSelection selection = paragraph.Find(new Regex("Panda")); + //Replace all occurrence of a particular regular expression with the text selection in the paragraph + paragraph.Replace("Giant panda", selection, true, false); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + Dim paragraph As WParagraph = document.Sections(0).Paragraphs(1) + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = paragraph.Find(New Regex("Panda")) + 'Replace all occurrence of a particular regular expression with the text selection in the paragraph + paragraph.Replace("Giant panda", selection, True, False) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given string in the paragraph with , taking into + consideration case sensitive, whole word and formatting options. + + The string represents the text to be found. + The specifies the text to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + Set to true if to save source formatting; otherwise, false. + The integer that represents the count of the replacements made. + + The following code example demonstrates how to replace all the entries of a text in the paragraph. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Template.docx"); + WParagraph paragraph = document.Sections[0].Paragraphs[1]; + //Find the first occurrence of the regular expression + TextSelection selection = paragraph.Find(new Regex("Panda")); + //Replace all occurrence of a particular regular expression with the text selection in the paragraph + paragraph.Replace("Giant panda", selection, true, false, true); + //Save and Close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Template.docx") + Dim paragraph As WParagraph = document.Sections(0).Paragraphs(1) + 'Find the first occurrence of the regular expression + Dim selection As TextSelection = paragraph.Find(New Regex("Panda")) + 'Replace all occurrence of a particular regular expression with the text selection in the paragraph + paragraph.Replace("Giant panda", selection, True, False, False) + 'Save and Close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces first entry of given string with replace string, taking into + consideration caseSensitive and wholeWord options. + + The string to replace + Replace string + Is case sensitive replace? + Search for whole word? + + + + + Replaces all entries of given regular expression with replace string. + + + + + + + Inserts a section break. Creates new section with the break type new page. + + A reference to the newly created section. + + The following code example illustrates how to insert a section break. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + document.EnsureMinimal(); + //Add text to the first section + document.LastParagraph.AppendText("First section"); + //Insert section break + WSection newsection = document.LastParagraph.InsertSectionBreak(); + //Add new paragraph to the second section + IWParagraph paragraph = newsection.AddParagraph(); + paragraph.AppendText("Second section"); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + document.EnsureMinimal() + 'Add text to the first section + document.LastParagraph.AppendText("First section") + 'Insert section break + Dim newsection As WSection = document.LastParagraph.InsertSectionBreak() + 'Add new paragraph to the second section + Dim paragraph As IWParagraph = newsection.AddParagraph() + paragraph.AppendText("Second section") + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Inserts the section break. Creates new section with the specified break type. + + The member that specifies the break type. + A reference to the newly created section. + + The following code example illustrates how to insert a section break. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + document.EnsureMinimal(); + //Add text to the first section + document.LastParagraph.AppendText("First section"); + //Insert section break + WSection newsection = document.LastParagraph.InsertSectionBreak(SectionBreakCode.Oddpage); + //Add new paragraph to the second section + IWParagraph paragraph = newsection.AddParagraph(); + paragraph.AppendText("Second section"); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + document.EnsureMinimal() + 'Add text to the first section + document.LastParagraph.AppendText("First section") + 'Insert section break + Dim newsection As WSection = document.LastParagraph.InsertSectionBreak(SectionBreakCode.Oddpage) + 'Add new paragraph to the second section + Dim paragraph As IWParagraph = newsection.AddParagraph() + paragraph.AppendText("Second section") + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the owner section. + + + + + + Gets the paragraph items. + + + + + + Clears the items. + + + + + Returns all entries of given regex. + + The pattern. + + + + + Returns first entry of given regex. + + The pattern. + + + + + Removes the items range. + + The start index. + if it speicifes the end, set to true. + + + + Clones without paragraph items. + + + + + + Appends paragraph item to the end of paragraph. + + + + + + + Updates the text. + + The p item. + The new text. + Flag to check update the text by removing existing or by inserting in between. + + + + Updates the text. + + The paragraph item. + Length of the text to remove. + The new text. + Flag to check update text by removing existing or by inserting inbetween. + + + + Updates the start position of next items from the inputed paragraph item. + + An item where to start updating start position in the paragraph. + A value to add with start position of next items. + + + + Applies the specified style. + + Style name + Specified style must exist in Document.Styles collection + + + + Checks whether text contains non-breaking space character or not and Word version is 2010 or 2013. + + + + + + Checks whether space combined with non breaking space character or not. + + Text which contains non-breaking space character. + Position of the empty space character. + + + + Find the index of the space to split the Word. + + + It space not combined with non-breaking space character, returns the index of the space character. + Otherwise returns index of the last character in the Word. + + Text which contains non-breaking space character. + Position of the empty space character. + + + + Applies the specified style. + + Style name + Specified style must exist in Document.Styles collection + + + + Replaces the substring. + + The start. + The length. + The replacement. + + + + Adds the self. + + + + + Apply the based on style to formattings. + + Destination Word document. + + + + Gets the current list level paragraph format properties and which is not available in paragrph inline. + + + + + + Clones the relations. + + + + + + While cloning the paragraph need to remove adding the Footnotes/Comments if the owner textBody is Wcomment/WFootnote for the Alternate chunk document + + + + + + + + To identify whether the current item need to be add current item into floating item collection + + Current entity + trueif the current item is floating item, otherwisefalse + + + + Updates the merge formatting. + + The doc. + + + + Updates the source formatting. + + The doc. + + + + Clones the style relations. + + The doc. + + + + Imports the style to destination document. + + + + + + + Creates a duplicate copy of the paragraph. + + + The reference of the newly created paragraph. + + + + Clones itself without paragraph items. + + + + + + Clones the paragraph as text only. + + + + + + Determines whether next sibling item is non hidden paragraph or other textbody item. + + + + + + Determines whether the previous paragraph mark is hidden. + + + + + + Determines whether the previous paragraph mark is hidden. + + + + + + + Determines whether the previous paragraph mark is in deletion revision. + + First previous deleted paragraph + returns true if any previous deleted paragraphs has content in it. Otherwise returns false + + + + Determines whether the previous paragraph mark is in deletion revision. + + + + + + + Determine whether the next entity is a non-delete revision list paragraph or not. + If the next entity is a delete revision paragraph, then continue getting the next entity until a non-delete revision item occurs and retrieve the list entity. + + Store non delete revision list paragraph + True if next entity is a non delete revision list paragraph, otherwise return False if is not a non delete revision list paragraph + + + + Determine whether the paragraph mark is deleted or not. + + + + + Retrieves the previous or next non-delete revision entity based on the specified flag. + + Flag indicating whether to retrieve the previous entity (true) or the next entity (false). + The previous or next non-delete revision entity. + + + + Checks wheather the previous paragraph has contents + + + + + + Gets the text. + + The start index. + The end index. + + + + + + + + + + Determine whether the paragraph having only the empty spaces and bookmarks + + + + + + + Determines whether the page break need to be skipped based on given entity owner. + + Entity + true, if present inside TextBox/FootNote/EndNote/Header/Footer + + + + Applies the list style. + + The built-in style. + + + + Checks the normal style. + + + + + Closes the item. + + + + + Applies the list paragraph style. + + + + + + + + + + + + + + + + + Gets the Owner table cell for paragraph. + + Owner textbody + + + + + + + + + + Determine whether the paragraph has section break + + + + + + Determines whether the paragraph is section end mark. + + + true if the paragraph is section end mark; otherwise, false. + Whether the paragraph's having childentites and checked the IsEmptyParagraph method. + + + + + Modifies the text. + + The text. + + + + + Update the bookmark end while moving the bookmark start from one paragraph to another paragraph + + + + + + + + Checks whether the frame height type is atleast or not + + + + + + Accepts or rejects changes tracked from the moment of last change acceptance. + + if it accepts changes, set to true. + + + + Removes the character format changes. + + + + + Removes the paragraph/table format changes. + + + + + Accepts the changes for character format. + + + + + Accepts changes in paragraph/table format. + + + + + Defines whether paragraph format is changed. + + + + + + Checks a value indicating whether this item was inserted to the document, + when "Track Changes" is or was set to "true". + + + + if this instance was inserted, set to true. + + + + + Checks a value indicating whether this item was deleted from the document, + when "Track Changes" is or was set to "true". + + + + if this instance is delete revision, set to true. + + + + + Defines whether format was changed. + + + + + + Checks whether full paragraph can be removed. + + + + + + Determines whether item has tracked changes. + + + if has tracked changes, set to true. + + + + + Sets the delete rev. + + if specifies delete revision, set to true. + + + + Sets the insert rev. + + if it specifies insert revision, set to true. + + + + Sets the changed C format. + + if it specifies formatting, set to true. + + + + Sets the changed P format. + + if it specifies changed format, set to true. + + + + Check that paragraph only has spaces or Not + + Return a Suitable bool value + + + + Check whether paragraph contains only textrange. + + + + + + Gets Next the text body item in the document. + + + + + + Writes object data as xml attributes. + + + The object. + + + + Registers paragraph elements for xml serialization. + + + + + + Restores object references after deserialization. + + + The string that specifies the name. + The zero-based index. + + + + Determines the paragraph has no items. + + + + + + Checks whether any renderable items from the particular Index in Paragraph. + + The paragraph Index value. + True, If any renderable items present from index else false. + + + + Gets the owner base entity. + + The entity + returns the baseEntity + + + + Determines whether the specified layouted widget is first line of the paragrph. + + The lt widget. + + + + + Gets the previous sibling. + + + + + + Gets the next sibling. + + + + + + Retrieves the bottom margin of the previous non-deleted paragraph in the document. + + The previous sibling entity in the document. This reference will be updated to the previous sibling if the current paragraph is marked as deleted. + + + + + Retrieves the before spacing of the next non-deleted paragraph in the document. + + The next sibling entity in the document. This reference will be updated to the next sibling if the current paragraph is marked as deleted. + + + + + Determines whether the specified child entity is the first non-skipped item in the section's text body. + + The entity to check if it is the first non skipped item in the section's text body. + + + + + Determines whether the height of the paragraph mark needs to be considered. + + + + + Remove split string widgets from the widget collection + + + + + Gets previous widget + + + + + + + Gets the previous inline items for the specified widget. + + The widget to get the previous inline items. + The previous inline items for the specified widget, or null if there are no previous inline items. + + + + Determines whether the specified layouted widget is last line of the paragrph. + + The lt widget. + + + + + Gets Next widget + + + + + + + Initializing LayoutInfo to null + + + + + Creates layout information. + + + + + + Updates the character spacing for the paragraph if it is in a table cell and the table cell is set to fit text. + + + + + Updates the character spacing or scaling value for each text range in the paragraph. + + The width of the cell content. + Specifies the total text length in a paragraph. + Specifies the owner of the current paragraph. + + + + Splits the last character of a paragraph text into two text ranges. + + Specifies the last textrange in a paragraph. + + + + Determine whether the current paragraph is need to be hidden + + + + + + Determine whether the previous paragraph mark is in delete revision or not. + If the previous paragraph including its items also in delete revison means, then continue getting the previous entity until a delete revision paragraph occurs. + + True if the previous paragraph is in a delete revision; otherwise false if it is a non delete revision paragraph + + + + Combine the widget by consicutive LTR and RTL texts. + + + + + Determines the paragraph has no items. + + + + + + Splits the textranges by script types. + + + + + Splits the textranges by consicutive LTR and RTL texts. + + + + + To check whether the specified language is arabic language or not. + + Specify the language local id + Return true if the language id is represent the arabic + + + + Gets the valid text from the paragraph. + + + + + + + Determine whether the current paragraph is vertically aligned + + + + + + Determine whether the current paragraph is need to be hidden + + + + + + Splits the widget by line break character. + + Paragraph items + + + + Determine the whether the paragraph is the firstparagraph of the owner text body. + + returns the IsFirstParagraphOfOwnerTextBody + + + + Checks whether the childEntity is the first child of ownerBaseEntity or not. + + The owner Base Entity + The child entity + returns the isFirstParagraph + + + + Determines whether to skip cell mark layouting. + For the cell mark present after a table in nested tables. + + + true if is skip cell mark; otherwise, false. + + + + + Returns the first inline item height of the current paragraph. + + The paragraph to which the height of first item to be found. + The that specifies the first item in the paragraph. + The float represents the height of the first item in the paragraph. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + + Returns the height of the specified paragraph item. + + The paragraph item to get the height. + The float that specifies the height of the break character in the paragraph. + The float represents the height of the paragraph item. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform and Xamarin platforms. + + + + Determine whether the current paragraph is having the same border values of Adjacent paragraphs + + Adjacent paragraph + + + + + Determine whether the border properties are equivalent to Adjacent border + + + + + + + + To ensure wether current paragraph and adjacent paragraph is having same left indent value + + Adjacent paragraph + Current paragraph left indent position + truewhen the two paragraphs are having same left indent value, otherwisefalse + + + + Is paragraph before spacing need to be skip + + + + + + + Get the default tab width + + Paragraph + Default tab width value + + + + Implemented alternative method to improve the performance + + + + + + + + Gets the minimum and maximum and pargraph word width. + + + + + Boolean to decide whether the ParagraphWidth calculation should do or not + + + + Gets the Paragraph Content Width + + The total content length of paragraph + + + + The total content length of paragraph + + Paragraph Items + Sum of the paraitems width + + + + String builder to store the text of the paragraph + + + + + Compare the two paragraphs formatting to mark the formatting differences. + + Original paragraph + + + + Compare the character format for matched text + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Compare the character format and apply format revision + + The original entity character format + The revised entity character format + + + + Compare paragraph formats and character format for the current matched text + + A value indicating whether the character formats are equal. + A value indicating whether current match is the first match in the paragraph + The original document instance + The matched text range index in the paragraph + The matched text as TextSelection + + + + Compare paragraph formats for the current matched delimiter. + + A value indicating whether current match is the first match in the paragraph. + The original document paragraph. + + + + Compare Two ParagraphFormat and return true if Equal else false. + + + + + Apply paragraph format changes + + The original document paragraph + + + + Gets style name Id using the document. + + Style Name + Document to get style name id + + + + Update the body item index when the end of the section is reached + + Start index of the last matched word + End index of the last matched word + Index of the matched item in paragraph + + + + Compare the revised document paragraph with the original document. + + The original document instance + + + + Check whether is there any item need to delete or insert before the matched word + + + + + + + + + + + + Add the skipped bookmarks while getting the match word + + Original document + Skipped bookmark collection + Matched word + + + + Compare the non renderable items + + Original document + Original Textbody + Para item index of revised + Start range index of the current item in revised + + + + Check and remove the current bookmark if it is present in original document or textbody + + Original document + Original textbody + Current bookmark name + + + + Reset the para item index after removing the non renderable items + + Original document + Original Textbody + Start owner para index + End owner para index + Start item index + End item index + + + + Split the matched text and unmatched text from the current textrange from both original document and revised document. + + + + + + + + + + + + Split the current textrange + + + + + + + + + + + + + + Mark insertion and deletion for the document items + + A value indicating whether to mark insert revisions + A value indicating whether to mark delete revisions + The original document instance + The current matched test range as TextSelection + Start text range index + + + + Compare empty paragraphs between documents + + The original document instance + + + + Compare the empty paragraphs before the current matched paragraph between documents + + The original document instance + + + + Compare the current item with current item in orginal document only. Not traverse to find next similar item in orginal document. + + + + + + + + + + + + Get the current paragraph item from document or textbody + + + + + + Update the next para item index for the revised document. + + + + + + + + + + Get the field code as string based on the field type + + + + + + + Compare fields between the original and revised document + + The original document + Index of the field + Character index + Character index + Index of the word to match + True if the last item is matched, else false + Index of the current paragraph item + + + + Find the field from the collection + + + + + + + + + Get the result part of the field + + Current document + Current matched field + Return a document containing the field result alone + + + + Clears headers and footers of Word document + + + + + + Compare the field result part of matched field in both revised and original document + + Original document + Matched field from original document + Matched field from revised document + + + + Compares the content of inline content controls between original and revised documents and applies track changes. + + The original document containing the inline content control. + The revised document containing the inline content control. + The text body of the original document. + The text body of the revised document. + The inline content control in the original document. + The inline content control in the revised document. + + + + Retrieves the content of the inline content control as a separate document. + + The document containing the inline content control, or null if not provided. + The text body of the document. + The inline content control whose content is to be retrieved. + The content of the inline content control as a separate document + + + + Move the field items from field begin to field separator from revised document to original document + + Original field + Revised field + Original document + Revised document + + + + Remove the items between the field begin and field separator + + + + + + Compare pictures between the original and revised document + + The original document + Index of the picture + Character index + Character index + Index of the word to match + True if the last item is matched, else false + Index of the current paragraph item + + + + Mark revisions for the drawing elements + + + + + + + + + + + + Compare ole object from both original and revised document + + + + + + + + + + + + Insert or delete the unmatched items before the current matched item + + + + + + + + + + Move the current position to the next item in the document + + + + + + + + + + + Splits the revised document text range + + Character index + Start text range index + Index of the current matched item + Index of the word + Character index + The current matched word + + + + Splits the text range in the original document + + The original document instance + + + + Copy indexes from Document to textbody. + + + + + + + Copy indexes from textbody to Document. + + + + + + + Splits the text range in the original text body + + The original text body instance + + + + Splits the specified text range in the current paragraph + + Character index + Character index + Index of the text range to split + Text range index + The matched word + Word index in the text range + + + + Find the exact match from the list of possible matches. + + Matches found in the original document + Index of the current section + Index of the owner paragraph + Index of the current text range + Index of the last matched word's last character + + + + + Insert the paragraph items from the revised document to the original document + + The matched text range as TextSelection + The original document instance + The matched paragraph item index in the revised document + + + + Insert the missed items from revised to original. + + Original document + Para item index in revised document + Start textrange index of matched paragraph in original document + Matched Body item index of original document + Matched section index of original document + + + + Append the remaining para items from the revised to the paragraph end of the original. + + + + + + + + + Set insertion mark to the paragraph and its items + + + + + Add deletion mark to the paragraph and its items + + + + + Remove the deletion mark for the paragraph and its items + + + + + Remove the insertion mark of the paragraph and its items + + + + + Mark deletion for the items in original document + + + + + + + + + + Updates track changes revision of paragraph while adding the entity. + + + Boolean, to decide whether paragrapgh child revision should update or not + + + + Apply insertion revision + + + + + + + + Mark insert revision for the paragraph item + + The paragraph item instance + + + + Mark delete revision for the unmatched items + + The current matched text range index + + + + Apply delete revision for the unmatched items in the original document. + + + + + + + + + + + Add delete revision mark in textbody from start to end + + + + + + + + Apply delete revisions for the items from start index to end index from the paragraph + + + + + + + + Mark delete revision for the paragraph item + + The paragraph item index + + + + Check the para item + + + + + + + Gets the word to find in the original document + + The current item index in the paragraph + The index of the text in the text range + The start index of the (text range)word in the paragraph + The word to find the match. + + + + Skip the previous non-renderable items and split the full text based on the delimiters + + + + + + + + + Check whether paragraph item is non-renderable item + + + + + + + Check whether the character is a special delimiter. + + The character to check + True, if it is delimiter else false + + + + Compare the delimiter before the matched word with the previous text range. + + + + + + + + Check for spaces in the previous ranges + + Original text + Revised text + Character index + + + + Compare the delimiters in the text ranges + + Original text range + Revised text range + + + + Get the special characters in the text range + + Text range instance + + + + + Compare the paragraphs between two text body + + Text body instance. + + + + Compare the textranges + + + + + + + + + + + + + + + + + + Checks if a paragraph contains only comments or comment marks. + + + + + Split the unmatched text as separate text range in the paragraph items. + + The paragraph instance + The matched text range index + Start character index + End character index + + + + Compare the special delimiters and split as separate textrange if the formatting are different + + + + + + + + + + + + + Split the delimiter from the given text range to separate text range. + + + + + + + Return the separate delimiter text range + + + + Split the textrange of both original and revised document based on delimiter + + + + + + + + + + + + + + Skip the bookmarks + + + + + + + Gets the paragraph text for word comparison + + + + + + + Handled for preservation of inline SDT items in Doc to PDF conversion. + Defines whether the paragraph has SDT inline items or not. + + + + + Gets or sets a value indicating whether the splitwidget is drawn or not + + + true if the splitwidget is drawn; otherwise, false. + + + + + Gets or sets a value indicating whether the style is applied + + + true if the style is applied; otherwise, false. + + + + + Gets the boolean value to indicate whether need to measure size of the BookMarks + + + + + Gets the type of the entity. Read-only. + + The of the current item. + + + + Gets the child elements of the paragraph. Read-only. + + The . + + + + Gets the name of the style applied to the current paragraph. Read-only. + + The string that represents the style name. + + + + Gets a string that represent the appearance of the list value of the paragraph. + + The string that represents a string value of the list of the paragraph. Default value is string.Empty + The following example illustrates how to get a numeric string value of the list paragraph. + + // Loads an existing Word document into DocIO instance. + WordDocument document = new WordDocument("Template.docx"); + //Gets the document text + document.GetText(); + // Gets a numeric string value of the numbering list paragraph. + String listString = document.LastParagraph.ListString; + // Saves the document in the given name and format. + document.Save("Document.docx", FormatType.Docx); + // Releases the resources occupied by WordDocument instance. + document.Close(); + + + ' Loads an existing Word document into DocIO instance. + Dim document As WordDocument = New WordDocument("Template.docx") + ' Gets the document text. + document.GetText() + ' Gets a numeric string value of the numbering list paragraph + Dim listString As String = document.LastParagraph.ListString + ' Saves the document in the given name and format. + document.Save("Document.docx", FormatType.Docx) + ' Releases the resources occupied by WordDocument instance. + document.Close() + + + This property holds the static string of the list value recently calculated while saving the document as Text. It is not updated automatically for each modification done in the document. + Hence, you should either invoke WordDocument.GetText() method or save the document as Text, to get the actual list value from this property. + For a picture bulleted list, this property is not valid and will return string.Empty. + + + + Gets or sets ID to the paragraph + + The string that represents the id. + + + + Gets or sets text of the paragraph. + + The string that represents the text. + All the internal formatting will be cleared when new text is set. + + + + Gets or sets a value indicating whether the paragraph mark is treated as special hidden and it allows Microsoft Word to join paragraphs formatted using different paragraph styles. + + True if the paragraph mark is treated as special hidden; otherwise, false. + + + + Gets the paragraph item at the specified index. Read-only. + + The zero-based index of the item to get from the collection. + The at the specified index. + + + + Gets the collection of in the current paragraph. Read-only. + + The of the paragraph. + + + + Gets the paragraph format of the current paragraph. Read-only. + + The of the paragraph. + + + + Gets the character format for the break symbol. Read-only. + + The of the paragraph. + + + + Gets the format for the list in the paragraph. Read-only. + + The of the list in the paragraph. + + + + Gets a value indicating whether the current paragraph is in cell. Read-only. + + True if this paragraph is in cell; otherwise, false. + + + + Gets or sets a value indicating whether this paragraph contains "\par" RTF tag. + + if this paragraph contains "\par" RTF tag, set to true. + + It's presence in last paragraph of the RTF from clipboard means that the copied content includes the last paragraph mark and its formatting should be copied in the pasted document. Also, the last paragraph should be preserved as separate paragraph and should not be merged in cursor position. + + + + + Gets a value indicating whether the current paragraph is end of the section. Read-only. + + True if this paragraph is end of section; otherwise false. + + + + + Gets a value indicating whether the current paragraph is end of document. Read-only. + + True if this paragraph is end of document; otherwise, false. + + + + + Gets or sets a value indicating whether the Paragraph is last item in the Word document for Alternate chunk updated. + + + true if the paragraph is the last item in Alternate chunk document; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is need to skip. + + + true if this instance is need to skip; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is top margin value updated. + + + true if this instance is top margin value updated; otherwise, false. + + + + + Gets count of child items. + + + + + Gets child widgets. + + + + + Gets child item by index. + + + + + Gets the paragraph items collection. + + + The instance. + + + + Gets or sets a value indicating whether to remove empty paragraph. + + if its specifies to remove empty paragraph, set to true. + + + + Gets the last item. + + The last item. + + + + Gets the paragraph style. + + The style. + + + + Gets a value indicating whether the paragraph is section end mark. + + true if the paragraph is section end mark; otherwise, false. + + + + Gets or sets a value indicating whether this instance is text replaced. + + + true if this instance is text replaced; otherwise, false. + + + + + Gets or sets a value indicating whether HTML is appending in this paragraph. + + + true if HTML is appending in this paragraph; otherwise, false. + + + + + Gets or sets a value indicating whether the Paragraph created using span tag in HTML. + + + true if the paragraph is created using span tag in HTML; otherwise, false. + + This property is implemented for document editor internal use only. + + + + Get or set the internal text property + + + + + The class specifies the Layout paragraph information. + + + + + Summary description for ParagraphLayoutInfo. + + + + + Summary description for LayoutInfo. + + + + + Summary description for ILayoutInfo. + + + + + Gets or sets a value indicating whether this instance is clipped. + + + true if this instance is clipped; otherwise, false. + + + + + Gets a value indicating whether this instance is skip. + + true if this instance is skip; otherwise, false. + + + + Gets or sets a value indicating whether this instance is skip bottom align. + + + true if this instance is skip bottom align; otherwise, false. + + + + + Gets a value indicating whether this instance is line container. + + + true if this instance is line container; otherwise, false. + + + + + Gets the children layout direction. + + The children layout direction. + + + + Gets or sets a value indicating whether this instance is line break. + + + true if this instance is line break; otherwise, false. + + + + + Gets or sets a value indicating whether [text wrap]. + + true if [text wrap]; otherwise, false. + + + + Gets or sets a value indicating whether this instance is page break item. + + + true if this instance is page break item; otherwise, false. + + + + + Gets a value indicating whether this instance is first Text Body Item of current page. + + + true if this instance is first Text Body Item of current page; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is keep with next. + + + true if this instance is keep with next; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is hidden. + + + true if this instance is hidden; otherwise, false. + + + + + Gets/Sets the Size of the widget + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The child layout direction. + + + + Gets or sets a value indicating whether this instance is clipped. + + + true if this instance is clipped; otherwise, false. + + + + + Gets/Sets the Size of the Widget + Currently We have handled the Size property as specifically to get the text size of the TextRange and Empty textrange size of the paragraph. + In Feature, We need to use this property to get the size of the all widgets + + + + + Gets a value indicating whether this instance is skip. + + true if this instance is skip; otherwise, false. + + + + Gets or sets a value indicating whether this instance is skip bottom align. + + + true if this instance is skip bottom align; otherwise, false. + + + + + Gets or sets a value indicating whether the owner table cell is having text direction as vertical + + + true if this instance is having the text direction as vertical; otherwise, false. + + + + + Gets a value indicating whether this instance is line container. + + + true if this instance is line container; otherwise, false. + + + + + Gets the children layout direction. + + The children layout direction. + + + + Gets or sets a value indicating whether this instance is line break. + + + true if this instance is line break; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is line Number Item. + + true if this instance is line Number Item.; otherwise, false. + + + + Gets or sets a value indicating whether [text wrap]. + + true if [text wrap]; otherwise, false. + + + + Gets or sets a value indicating whether this instance is page break item. + + + true if this instance is page break item; otherwise, false. + + + + + Gets a value indicating whether this instance is first Text Body Item of current page. + + + true if this instance is first Text Body Item of current page; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is keep with next. + + + true if this instance is keep with next; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is hidden. + + + true if this instance is hidden; otherwise, false. + + + + + Summary description for ILayoutSpacingsInfo. + + + + + Gets the paddings. + + The paddings. + + + + Gets the margins. + + The margins. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Holds the Y position for List value. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + The child layout direction. + + + + Initializes a new instance of the class. + + The child layout direction. + Is page break. + + + + Initializes a new instance of the class. + + + + + Initializes the layout info values as null. + + + + + Gets or sets a value indicating whether this instance is page break. + + + true if this instance is page break; otherwise, false. + + True, if we can break the pragraph for page break, column break, section break. Based on this, we setting state for layouting to split page. + + + + Gets or sets the level number. + + The level number. + + + + Gets or sets the justification. + + The justification. + + + + Gets or sets the first line indent. + + The first line indent. + + + + Gets or sets a value indicating whether this instance is keep together. + + + true if this instance is keep together; otherwise, false. + + + + + Gets or sets the list tab. + + The list tab. + + + + Get the list tab width + + + + + Gets or sets the Y position. + + The Y position. + + + + Holds the current paragraph original Y position. + This property value won't change when paragraph wrapped by floating item. + + + At now handled to hold the value for negative vertical position + Need to handled for all cases + + The Y position. + + + + Gets the Y positions for List value. + + The Y positions of List. + + + + Gets or sets the list value. + + The list value. + + + + Gets or sets the Current list Type. + + The list value. + + + + Gets or sets the character format for the list. + + The character format. + + + + Gets or sets alignment of the list number (left, right, or centered). + + + + + Gets or sets the current list tab stop. + + + + + Gets or sets a value indicating whether the line is the first line of the paragraph. + + + true if this line is first line of the paragraph; otherwise, false. + + + + + Gets or sets Top Padding of the paragraph. + + + + + Gets or sets Bottom padding of the paragraph. + + + + + Gets or sets TopMargin of the paragraph. + + + + + Gets or sets BottomMargin of the paragraph. + + + + + Gets or sets a value indicating whether the paragraph is last paragraph of the page. + + + true if this paragraph paragraph is last paragraph of the page; otherwise, false. + + + + + Gets or sets a value indicating whether [x position re update]. + + + true if [x position re update]; otherwise, false. + + + + + Gets or sets the X position. + + The Y position. + + + + Gets or sets a value indicating whether this instance is section end mark. + + + true if this instance is section end mark; otherwise, false. + + + + + Gets the paddings. + + The paddings. + + + + Gets the margins. + + The margins. + + + + + + + + + Initializes a new instance of the class. + + The paragraph. + + + + Get the Empty size of the empty TextRange + + + + + + Updates IsClipped Property for the Paragraph. + + + + + Get Base Entity. + + The entity. + + + + + Determines the list format. + + + + + Update List Paragraph After/Before spacing + + + + + + Get the size of the list value + + List level + Size + + + + Updates the width of the list value, if the follow character is space or nothing. + + The level. + + + + Updates the list tab. + + + + + + + Updates the width of the tab, based on the list text. + + The tabs. + The width. + + + + Copys Character formatting + + + + + + + Determines the borders. + + + Determines the borders. + + + + + Determines the page breaks. + + + + + Retrieves the first paragraph from the given entity, which can be a WParagraph, WTable, or BlockContentControl. + + The entity from which to retrieve the first paragraph. This can be a WParagraph, WTable, or BlockContentControl. + The first WParagraph found within the given entity, or null if no paragraph is found. + + + + To identify if the current paragraph is the last paragraph of its owner text body. + + True if the current paragraph is the last paragraph of its owner text body; otherwise, false. + + + + Determines the format. + + + + + + + + + + + + Check next and previous cell's paragraph and adjust its top and bottom margin of current paragraph. + + + + + Check next and previous cell's paragraph and adjust its top and bottom margin of current paragraph. + + + + + Returs true if para have bullets or numbering. + + + + + + Adjust the para top and bottom margin when next item or prev item is table and current para is not first or last para. + + + + + Get the next table first paragraph. + + + + + + + Check owner table previos item is table then its nested table continously iterates to get previous paragraph of base table. + + + + + + Update Paragraph After/Before Spacing + + + + + check whethere current para and next or previous para have same style. + + + + if same style means return true else return false. + + + + Updates the after spacing value for the paragraph. + + + + + Updates the top margin value based on previous section last paragraph after spacing. + + + + + Gets the last item of previous section. + + Index of the current section. + + + + + Determine whether the paragraph contains list type. + + + + + + + Gets the document. + + The document. + + + + + + + + + Summary description for TabsLayoutInfo. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + if set to true [b top subtract area]. + + + + Gets the next tab position. + + The position. + + + + + Adds the tab. + + The position. + The justification. + The leader. + + + + + + + + + + + Updates the tabs. + + The paragraph format. + + + + Remove the clear tab from the tabs collection + + + + + + + Update tabs collection + + + + + + + + + Gets the width of the default tab. + + The width of the default tab. + + + + Gets the Page MarginLeft. + + The Page MarginLeft. + + + + Gets the Page MarginRight. + + The Page MarginRight. + + + + Determine whether the tab preserved inbetween the indent + + + + + Gets/sets the width of the tab + + The width of the tab. + + + + Gets the current tab leader. + + The current tab leader. + + + + Gets the current tab justification. + + The current tab justification. + + + + Gets the layouted tab collections + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The position. + The justification. + The leader. + + + + Gets or sets the justification. + + The justification. + + + + Gets or sets the tab leader. + + The tab leader. + + + + Gets or sets the position. + + The position. + + + + Initializes a new instance of the class. + + The paragrath. + + + + Skipped bookmarks while getting the match word + + + + + Bookmark end or not + + + + + Bookmark Name + + + + + Represents the section of a Word document which contains header, footer, text body, etc. + + + + + Represents a section. + + + + + Adds a new to the section. + + The float that specifies the width of the column. + The float that specifies the spacing between the columns. + The reference to the newly added object. + The following example illustrates how to have multiple columns in a section. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add the section into Word document + IWSection section = document.AddSection(); + //Add the column into the section + section.AddColumn(150, 20); + //Add the column into the section + section.AddColumn(150, 20); + //Add the column into the section + section.AddColumn(150, 20); + //Add a paragraph to created section + IWParagraph paragraph = section.AddParagraph(); + //Add a paragraph to created section + paragraph = section.AddParagraph(); + paragraph.Text = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"; + //Append the text to the created paragraph + paragraph.AppendText(paragraph.Text); + //Add the column breaks + paragraph.AppendBreak(BreakType.ColumnBreak); + //Add a paragraph to created section + paragraph = section.AddParagraph(); + //Append the text to the created paragraph + paragraph.AppendText(paragraph.Text); + //Add the column breaks + paragraph.AppendBreak(BreakType.ColumnBreak); + //Add a paragraph to created section + paragraph = section.AddParagraph(); + //Append the text to the created paragraph + paragraph.AppendText(paragraph.Text); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add the section into Word document + Dim section As IWSection = document.AddSection() + 'Add the column into the section + section.AddColumn(150, 20) + 'Add the column into the section + section.AddColumn(150, 20) + 'Add the column into the section + section.AddColumn(150, 20) + 'Add a paragraph to created section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add a paragraph to created section + paragraph = section.AddParagraph() + Dim paraText As String = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula" + 'Append the text to the created paragraph + paragraph.AppendText(paraText) + 'Add the column breaks + paragraph.AppendBreak(BreakType.ColumnBreak) + 'Add a paragraph to created section + paragraph = section.AddParagraph() + 'Append the text to the created paragraph + paragraph.AppendText(paraText) + 'Add the column breaks + paragraph.AppendBreak(BreakType.ColumnBreak) + 'Add a paragraph to created section + paragraph = section.AddParagraph() + 'Append the text to the created paragraph + paragraph.AppendText(paraText) + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Adds the to the section body. + + The reference to the newly created paragraph. + The following example illustrates how to add a paragraph to the section. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Gets the first section in the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("First paragraph in section"); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Gets the first section in the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("First paragraph in section") + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Adds the to the section body. + + The reference to the newly created table. + The following example illustrates how to add a table to the section. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Gets the first section in the document + IWSection section = document.AddSection(); + //Add new table to the section + IWTable table = section.AddTable(); + //Set rows and columns count + table.ResetCells(2, 2); + //Add contents to the table + IWParagraph paragraph = table[0, 0].AddParagraph(); + paragraph.AppendText("Apple"); + paragraph = table[0, 1].AddParagraph(); + paragraph.AppendText("Red"); + paragraph = table[1, 0].AddParagraph(); + paragraph.AppendText("Banana"); + paragraph = table[1, 1].AddParagraph(); + paragraph.AppendText("Yellow"); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Gets the first section in the document + Dim section As IWSection = document.AddSection() + 'Add new table to the section + Dim table As IWTable = section.AddTable() + 'Set rows and columns count + table.ResetCells(2, 2) + 'Add contents to the table + Dim paragraph As IWParagraph = table(0, 0).AddParagraph() + paragraph.AppendText("Apple") + paragraph = table(0, 1).AddParagraph() + paragraph.AppendText("Red") + paragraph = table(1, 0).AddParagraph() + paragraph.AppendText("Banana") + paragraph = table(1, 1).AddParagraph() + paragraph.AppendText("Yellow") + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Clones the , creates a duplicate copy. + + The cloned object. + + + + Makes all columns in the current section to be of equal width. + + The following example illustrates how to have make the columns to be of equal width in a section. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument("Sample.docx"); + //Gets the first section in the document + IWSection section = document.Sections[0]; + //Make the columns to be of equal width + section.MakeColumnsEqual(); + //Save and close the document + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument("Sample.docx") + 'Gets the first section in the document + Dim section As IWSection = document.Sections(0) + 'Make the columns to be of equal width + section.MakeColumnsEqual() + 'Save and close the document + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the paragraphs in the current section. Read-only. + + The that represents the collection of + in the section. + + + + Gets the tables in the current section. Read-only. + + The that represents the collection of + in the section. + + + + Gets the section body. Read-only. + + The of the current section. + + + + Gets the page setup of the current section. Read-only. + + The of the current section. + + + + Gets the collection of columns which logically divide page on many printing or publishing areas. Read-only. + + The collection of columns in the section. + + + + Gets or sets section break code of the current section. + + The member that specifies the break code. + + + + Gets or sets a value indicating whether to allow editing of form fields in the section. + + True if to allow editing of form fields; otherwise, false. + + + + Gets headers and footers of the current section. Read-only. + + The instance that specifies current section header, footer. + + + + + + + + + Specifies the Section format. + + + + + + The headers / footers, related with current section. + + + + + + + + + + + PreviousHeaderCount for Alternate chunk + + + + + PreviousFooteCount for Alternate chunk + + + + + Gets the section body. Read-only. + + + + + + + + Initializes a new instance of the class + with the instance. + + The instance. + + + + Adds a new to the section. + + The float that specifies the width of the column. + The float that specifies the spacing between the columns. + The reference to the newly added object. + The following example illustrates how to have multiple columns in a section. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add the section into Word document + IWSection section = document.AddSection(); + //Add the column into the section + section.AddColumn(150, 20); + //Add the column into the section + section.AddColumn(150, 20); + //Add the column into the section + section.AddColumn(150, 20); + //Add a paragraph to created section + IWParagraph paragraph = section.AddParagraph(); + //Add a paragraph to created section + paragraph = section.AddParagraph(); + paragraph.Text = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"; + //Append the text to the created paragraph + paragraph.AppendText(paragraph.Text); + //Add the column breaks + paragraph.AppendBreak(BreakType.ColumnBreak); + //Add a paragraph to created section + paragraph = section.AddParagraph(); + //Append the text to the created paragraph + paragraph.AppendText(paragraph.Text); + //Add the column breaks + paragraph.AppendBreak(BreakType.ColumnBreak); + //Add a paragraph to created section + paragraph = section.AddParagraph(); + //Append the text to the created paragraph + paragraph.AppendText(paragraph.Text); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add the section into Word document + Dim section As IWSection = document.AddSection() + 'Add the column into the section + section.AddColumn(150, 20) + 'Add the column into the section + section.AddColumn(150, 20) + 'Add the column into the section + section.AddColumn(150, 20) + 'Add a paragraph to created section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add a paragraph to created section + paragraph = section.AddParagraph() + Dim paraText As String = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula" + 'Append the text to the created paragraph + paragraph.AppendText(paraText) + 'Add the column breaks + paragraph.AppendBreak(BreakType.ColumnBreak) + 'Add a paragraph to created section + paragraph = section.AddParagraph() + 'Append the text to the created paragraph + paragraph.AppendText(paraText) + 'Add the column breaks + paragraph.AppendBreak(BreakType.ColumnBreak) + 'Add a paragraph to created section + paragraph = section.AddParagraph() + 'Append the text to the created paragraph + paragraph.AppendText(paraText) + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Adds a new to the section. + + The float that specifies the width of the column. + The float that specifies the spacing between the columns. + The bool that specifies whether the document is opened. + The reference to the newly added object. + + + + Makes all columns in the current section to be of equal width. + + The following example illustrates how to have make the columns to be of equal width in a section. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument("Sample.docx"); + //Gets the first section in the document + IWSection section = document.Sections[0]; + //Make the columns to be of equal width + section.MakeColumnsEqual(); + //Save and close the document + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument("Sample.docx") + 'Gets the first section in the document + Dim section As IWSection = document.Sections(0) + 'Make the columns to be of equal width + section.MakeColumnsEqual() + 'Save and close the document + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Creates a duplicate copy of the current section. + + The reference to the newly created section. + + + + Adds the to the section body. + + The reference to the newly created paragraph. + The following example illustrates how to add a paragraph to the section. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Gets the first section in the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("First paragraph in section"); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Gets the first section in the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("First paragraph in section") + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Adds the to the section body. + + The reference to the newly created table. + The following example illustrates how to add a table to the section. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Gets the first section in the document + IWSection section = document.AddSection(); + //Add new table to the section + IWTable table = section.AddTable(); + //Set rows and columns count + table.ResetCells(2, 2); + //Add contents to the table + IWParagraph paragraph = table[0, 0].AddParagraph(); + paragraph.AppendText("Apple"); + paragraph = table[0, 1].AddParagraph(); + paragraph.AppendText("Red"); + paragraph = table[1, 0].AddParagraph(); + paragraph.AppendText("Banana"); + paragraph = table[1, 1].AddParagraph(); + paragraph.AppendText("Yellow"); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Gets the first section in the document + Dim section As IWSection = document.AddSection() + 'Add new table to the section + Dim table As IWTable = section.AddTable() + 'Set rows and columns count + table.ResetCells(2, 2) + 'Add contents to the table + Dim paragraph As IWParagraph = table(0, 0).AddParagraph() + paragraph.AppendText("Apple") + paragraph = table(0, 1).AddParagraph() + paragraph.AppendText("Red") + paragraph = table(1, 0).AddParagraph() + paragraph.AppendText("Banana") + paragraph = table(1, 1).AddParagraph() + paragraph.AppendText("Yellow") + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Adds the alternate chunk. + + + + + + Adds the self. + + + + + Gets the text. + + + + + + Add Empty paragraph to the section when the section doesn't have any items in the body collection or else it's last item is table in order to preserve section break + + + + + Checks whether the section has valid line numberings. + + + + + + Clones the without body items. + Creates new section by cloning the page setup, column and header footers of the current section. + + + + + + Clones the relations. + + + + + + Creates a duplicate copy of the section. + + + An object that can be casted as . + + + + Accepts or rejects changes tracked from the moment of last change acceptance. + + + + + Determines whether section has tracked changes. + + + if has tracked changes, set to true. + + + + + Compare header and footer of two sections and mark the revisions. + + + + + + Clear the object from the allocated memory. + + + + + Get the first paragraph in section. + + + + + + Registers child objects in XDSL holder. + + + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Writes object data as inside xml element. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + The value indicating the presence of xml content. + + + + Create layout information. + + + + + + + + + + + + + Gets or sets the PreviousHeaderCount for Alternate chunk + + + + + Gets or sets the PreviousFooteCount for Alternate chunk + + + + + Gets the section body. Read-only. + + The of the current section. + + + + Gets headers and footers of the current section. Read-only. + + The instance that specifies current section header, footer. + + + + Gets the page setup of the current section. Read-only. + + The of the current section. + + + + Gets the section formatting. + + + + + Gets the collection of columns which logically divide page on many printing or publishing areas. Read-only. + + The collection of columns in the section. + + + + Gets or sets section break code of the current section. + + The member that specifies the break code. + + + + + + + + + Gets the type of the entity. Read-only. + + The of the current item. + + + + Gets the child elements of the section. Read-only. + + The collection of child elements. + + + + Gets the paragraphs in the current section. Read-only. + + The that represents the collection of + in the section. + + + + Gets the tables in the current section. Read-only. + + The that represents the collection of + in the section. + + + + Gets or sets the text direction. + + The text direction. + + + + Gets or sets a value indicating whether to allow editing of form fields in the section. + + True if to allow editing of form fields; otherwise, false. + + + + Gets or sets a value indicating whether to the continuous section fit in same page or not. + + True if no need to create new page for continous section break; otherwise, false. + + + + Returns the entity collection. + + + The collection of entities in the text body. + + + + Gets the type of the elements present in the collection. + + The collection that contains the types of the elements. + + + + Represents a table in the Word document. + + + + + Represents a table in a document. + + + + + Adds a new row to the table. + + The reference to the newly added . + The following example illustrates how to add new row to the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + section.AddParagraph().AppendText("Price Details"); + section.AddParagraph(); + //Add a new table into Word document + IWTable table = section.AddTable(); + //Add the first row to table + WTableRow row = table.AddRow(); + //Add the first cell into first row + WTableCell cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("Apple"); + //Add the second cell into first row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("$40"); + //Add second row to table + row = table.AddRow(false); + //Add the first cell into first row + cell = row.Cells[0]; + cell.AddParagraph().AppendText("Orange"); + //Add the second cell into first row + cell = row.Cells[1]; + cell.AddParagraph().AppendText("$30"); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + section.AddParagraph().AppendText("Price Details") + section.AddParagraph() + 'Add a new table into Word document + Dim table As IWTable = section.AddTable() + 'Add the first row to table + Dim row As WTableRow = table.AddRow() + 'Add the first cell into first row + Dim cell As WTableCell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("Apple") + 'Add the second cell into first row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("$40") + 'Add second row to table + row = table.AddRow(False) + 'Add the first cell into first row + cell = row.Cells(0) + cell.AddParagraph().AppendText("Orange") + 'Add the second cell into first row + cell = row.Cells(1) + cell.AddParagraph().AppendText("$30") + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Adds a new row to table specifying whether to have the same format as the previous row. + + True if to have the same format as previous row; otherwise, false. + The reference to the newly added . + The following example illustrates how to add new row to the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + section.AddParagraph().AppendText("Price Details"); + section.AddParagraph(); + //Add a new table into Word document + IWTable table = section.AddTable(); + //Add the first row to table + WTableRow row = table.AddRow(); + //Add the first cell into first row + WTableCell cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("Apple"); + //Add the second cell into first row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("$40"); + //Add second row to table + row = table.AddRow(false); + //Add the first cell into first row + cell = row.Cells[0]; + cell.AddParagraph().AppendText("Orange"); + //Add the second cell into first row + cell = row.Cells[1]; + cell.AddParagraph().AppendText("$30"); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + section.AddParagraph().AppendText("Price Details") + section.AddParagraph() + 'Add a new table into Word document + Dim table As IWTable = section.AddTable() + 'Add the first row to table + Dim row As WTableRow = table.AddRow() + 'Add the first cell into first row + Dim cell As WTableCell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("Apple") + 'Add the second cell into first row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("$40") + 'Add second row to table + row = table.AddRow(False) + 'Add the first cell into first row + cell = row.Cells(0) + cell.AddParagraph().AppendText("Orange") + 'Add the second cell into first row + cell = row.Cells(1) + cell.AddParagraph().AppendText("$30") + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Adds a new row to table specifying whether to have the same format and cells count similar to the previous row. + + True if to have the same format as previous row; otherwise, false. + True if need to auto populate cells; otherwise, false. + The reference to the newly added . + The following example illustrates how to add a row with formatting similar to the previous row. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + section.AddParagraph().AppendText("Price Details"); + section.AddParagraph(); + //Add a new table into Word document + IWTable table = section.AddTable(); + //Add the first row into table + WTableRow row = table.AddRow(); + //Add the first cell into first row + WTableCell cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("Item"); + //Add the second cell into first row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("Price($)"); + //Add the second row into table + row = table.AddRow(true, false); + //Add the first cell into second row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("Apple"); + //Add the second cell into second row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("50"); + //Add the third row into table + row = table.AddRow(true, false); + //Add the first cell into third row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("Orange"); + //Add the second cell into third row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("30"); + document.Save("Table.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + section.AddParagraph().AppendText("Price Details") + section.AddParagraph() + 'Add a new table into Word document + Dim table As IWTable = section.AddTable() + 'Add the first row into table + Dim row As WTableRow = table.AddRow() + 'Add the first cell into first row + Dim cell As WTableCell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("Item") + 'Add the second cell into first row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("Price($)") + 'Add the second row into table + row = table.AddRow(True, False) + 'Add the first cell into second row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("Apple") + 'Add the second cell into second row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("50") + 'Add the third row into table + row = table.AddRow(True, False) + 'Add the first cell into third row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("Orange") + 'Add the second cell into third row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("30") + document.Save("Table.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Resets the table with the specified number of rows and columns. + + The integer specifies the number of rows. + The integer specifies the number of columns. + The following example illustrates how to add a table to the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Gets the first section in the document + IWSection section = document.AddSection(); + //Add new table to the section + IWTable table = section.AddTable(); + //Set rows and columns count + table.ResetCells(2, 2); + //Add contents to the table + IWParagraph paragraph = table[0, 0].AddParagraph(); + paragraph.AppendText("Apple"); + paragraph = table[0, 1].AddParagraph(); + paragraph.AppendText("Red"); + paragraph = table[1, 0].AddParagraph(); + paragraph.AppendText("Banana"); + paragraph = table[1, 1].AddParagraph(); + paragraph.AppendText("Yellow"); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Gets the first section in the document + Dim section As IWSection = document.AddSection() + 'Add new table to the section + Dim table As IWTable = section.AddTable() + 'Set rows and columns count + table.ResetCells(2, 2) + 'Add contents to the table + Dim paragraph As IWParagraph = table(0, 0).AddParagraph() + paragraph.AppendText("Apple") + paragraph = table(0, 1).AddParagraph() + paragraph.AppendText("Red") + paragraph = table(1, 0).AddParagraph() + paragraph.AppendText("Banana") + paragraph = table(1, 1).AddParagraph() + paragraph.AppendText("Yellow") + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Resets the table with the specified number of rows and columns, table format and cell width. + + The integer specifies the number of rows. + The integer specifies the number of columns. + The specifies the format for the table. + The float specifies the width of the cells. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + //Add a new table into Word document + IWTable table = section.AddTable(); + RowFormat format = new RowFormat(); + format.BackColor = Color.LightGray; + format.CellSpacing = 2; + format.Paddings.All = 2; + //Set number of rows and columns + table.ResetCells(2, 2, format, 200); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + 'Add a new table into Word document + Dim table As IWTable = section.AddTable() + Dim format As New RowFormat() + format.BackColor = Color.LightGray + format.CellSpacing = 2 + format.Paddings.All = 2 + 'Set number of rows and columns + table.ResetCells(2, 2, format, 200) + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Applies the vertical merge for table cells specified by the column index, start row index and end row index. + + The integer specifies index of the column. + The integer specifies start index of the row. + The integer specifies end index of the row. + The following example illustrates how to apply vertical merge for the table cells. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + section.AddParagraph().AppendText("Vertical merging of Table cells"); + IWTable table = section.AddTable(); + table.ResetCells(5, 5); + //Specify the vertical merge to the third cell, from second row to fifth row + table.ApplyVerticalMerge(2, 1, 4); + document.Save("VerticalMerge.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + section.AddParagraph().AppendText("Vertical merging of Table cells") + Dim table As IWTable = section.AddTable() + table.ResetCells(5, 5) + 'Specify the vertical merge to the third cell, from second row to fifth row + table.ApplyVerticalMerge(2, 1, 4) + document.Save("VerticalMerge.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Applies horizontal merge for table cells specified by the row index, start cell index and end cell index. + + The integer specifies index of the row. + The integer specifies start index of the cell. + The integer specifies end index of the cell. + The following example illustrates how to apply horizontal merge for the table cells. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + section.AddParagraph().AppendText("Vertical merging of Table cells"); + IWTable table = section.AddTable(); + table.ResetCells(5, 5); + //Specify the horizontal merge from second cell to fifth cell in third row + table.ApplyHorizontalMerge(2, 1, 4); + document.Save("HorizontalMerge.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + section.AddParagraph().AppendText("Vertical merging of Table cells") + Dim table As IWTable = section.AddTable() + table.ResetCells(5, 5) + 'Specify the horizontal merge from second cell to fifth cell in third row + table.ApplyHorizontalMerge(2, 1, 4) + document.Save("HorizontalMerge.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Removes the absolute position data, if the table has absolute position in the document. + + + + + Applies the built-in table style to the table. + + The to be applied for the table. + The following example illustrates how to apply built-in style for the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Table.docx", FormatType.Docx); + WSection section = document.Sections[0]; + //Get the table + WTable table = section.Tables[0] as WTable; + //Apply "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading); + document.Save("TableStyle.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Table.docx", FormatType.Docx) + Dim section As WSection = document.Sections(0) + 'Get the table + Dim table As WTable = TryCast(section.Tables(0), WTable) + 'Apply "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading) + document.Save("TableStyle.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the style applied for the table. + + The of the current table. + + + + Gets the rows collection that represent all the rows in the table. Read-only. + + The collection of rows in the table. + + + + + + Gets the table format. Read-only. + + The object that specifies the table format. + + + + Gets the last cell in last row. Read-only. + + The object that represents the last cell. + The following example illustrates how to get the last cell of the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx"); + //Get the table + WTable table = document.Sections[0].Tables[0] as WTable; + //Get the last cell + WTableCell cell = table.LastCell; + //Apply text direction to the last cell + cell.CellFormat.TextDirection = Syncfusion.DocIO.DLS.TextDirection.Vertical; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx") + 'Get the table + Dim table As WTable = TryCast(document.Sections(0).Tables(0), WTable) + 'Get the last cell + Dim cell As WTableCell = table.LastCell + 'Apply text direction to the last cell + cell.CellFormat.TextDirection = Syncfusion.DocIO.DLS.TextDirection.Vertical + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the first row in table. Read-only. + + The object that represents the first row in the table. + The following example illustrates how to get the first row of the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx"); + //Get the table + WTable table = document.Sections[0].Tables[0] as WTable; + //Get the last cell + WTableRow row = table.FirstRow; + //Apply text direction to the last cell + row.RowFormat.BackColor = Color.LightGray; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx") + 'Get the table + Dim table As WTable = TryCast(document.Sections(0).Tables(0), WTable) + 'Get the last cell + Dim row As WTableRow = table.FirstRow + 'Apply text direction to the last cell + row.RowFormat.BackColor = Color.LightGray + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the last row in table. Read-only. + + The object that represents the last row in the table. + The following example illustrates how to get the last row of the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx"); + //Get the table + WTable table = document.Sections[0].Tables[0] as WTable; + //Get the last cell + WTableRow row = table.LastRow; + //Apply text direction to the last cell + row.RowFormat.BackColor = Color.LightGray; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx") + 'Get the table + Dim table As WTable = TryCast(document.Sections(0).Tables(0), WTable) + 'Get the last cell + Dim row As WTableRow = table.LastRow + 'Apply text direction to the last cell + row.RowFormat.BackColor = Color.LightGray + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the table cell at the specified row and column index. Read-only. + + The integer that specifies the row index. + The integer that specifies the column index. + The object at the specified index. + The index is not valid in the table. + The following example illustrates how to get the cell in the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a Word document + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + //Add new table. + IWTable table = section.AddTable(); + table.ResetCells(2, 2); + //Add content to table cell + table[0, 0].AddParagraph().AppendText("First row, First cell"); + table[0, 1].AddParagraph().AppendText("First row, Second cell"); + table[1, 0].AddParagraph().AppendText("Second row, First cell"); + table[1, 1].AddParagraph().AppendText("Second row, Second cell"); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a Word document + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + section.AddParagraph().AppendText("Horizontal merging of Table cells") + 'Add new table. + Dim table As IWTable = section.AddTable() + table.ResetCells(2, 2) + 'Add content to table cell + table(0, 0).AddParagraph().AppendText("First row, First cell") + table(0, 1).AddParagraph().AppendText("First row, Second cell") + table(1, 0).AddParagraph().AppendText("Second row, First cell") + table(1, 1).AddParagraph().AppendText("Second row, Second cell") + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the width of the table(in points). + + The float that specifies the width of the table. + + + + Gets or sets the table title. + + The string that specifies the title of the table. + + + + Gets or sets the table description. + + The string that specifies the description of the table. + + + + Gets or sets a value indicating whether to apply heading-row formatting to the first row of the table. + The default value is true. + + True if need to apply style for first row; otherwise, false. + The following example illustrates how to apply style for header row of the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Table.docx", FormatType.Docx); + WSection section = document.Sections[0]; + WTable table = section.Tables[0] as WTable; + //Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading); + //Disable special formatting for header row of the table + table.ApplyStyleForHeaderRow = false; + //Save and close the document + document.Save("TableStyle.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Table.docx", FormatType.Docx) + Dim section As WSection = document.Sections(0) + Dim table As WTable = TryCast(section.Tables(0), WTable) + 'Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading) + 'Disable special formatting for header row of the table + table.ApplyStyleForHeaderRow = False + 'Save and close the document + document.Save("TableStyle.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets a value indicating whether to apply last-row formatting to the last row of the specified table. + + True if need to apply style for last row; otherwise, false. + The following example illustrates how to apply style for last row of the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Table.docx", FormatType.Docx); + WSection section = document.Sections[0]; + WTable table = section.Tables[0] as WTable; + //Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading); + //Enable special formatting for last row of the table + table.ApplyStyleForLastRow = false; + //Save and close the document + document.Save("TableStyle.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Table.docx", FormatType.Docx) + Dim section As WSection = document.Sections(0) + Dim table As WTable = TryCast(section.Tables(0), WTable) + 'Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading) + 'Enable special formatting for last row of the table + table.ApplyStyleForLastRow = True + 'Save and close the document + document.Save("TableStyle.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets a value indicating whether to apply first-column formatting to the first column of the specified table. + The default value is true. + + True if need to apply style for first column; otherwise, false. + The following example illustrates how to apply style for first column of the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Table.docx", FormatType.Docx); + WSection section = document.Sections[0]; + WTable table = section.Tables[0] as WTable; + //Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading); + //Disable special formatting for first column of the table + table.ApplyStyleForFirstColumn = false; + //Save and close the document + document.Save("TableStyle.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Table.docx", FormatType.Docx) + Dim section As WSection = document.Sections(0) + Dim table As WTable = TryCast(section.Tables(0), WTable) + 'Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading) + 'Disable special formatting for first column of the table + table.ApplyStyleForFirstColumn = False + 'Save and close the document + document.Save("TableStyle.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets a value indicating whether to apply last-column formatting to the last column of the specified table.. + + True if need to apply style for last column; otherwise, false. + The following example illustrates how to apply style for last column of the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Table.docx", FormatType.Docx); + WSection section = document.Sections[0]; + WTable table = section.Tables[0] as WTable; + //Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading); + //Enable special formatting for last column of the table + table.ApplyStyleForLastColumn = true; + //Save and close the document + document.Save("TableStyle.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Table.docx", FormatType.Docx) + Dim section As WSection = document.Sections(0) + Dim table As WTable = TryCast(section.Tables(0), WTable) + 'Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading) + 'Enable special formatting for last column of the table + table.ApplyStyleForLastColumn = True + 'Save and close the document + document.Save("TableStyle.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets a value indicating whether to apply style bands to the rows in a table, + if an applied preset table style provides style banding for rows. The default value is True. + + True if need to apply style for banded rows; otherwise, false. + The following example illustrates how to apply style for banded rows of the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Table.docx", FormatType.Docx); + WSection section = document.Sections[0]; + WTable table = section.Tables[0] as WTable; + //Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading); + //Disable special formatting for banded rows of the table + table.ApplyStyleForBandedRows = false; + //Save and close the document + document.Save("TableStyle.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Table.docx", FormatType.Docx) + Dim section As WSection = document.Sections(0) + Dim table As WTable = TryCast(section.Tables(0), WTable) + 'Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading) + 'Enable special formatting for banded rows of the table + table.ApplyStyleForBandedRows = False + 'Save and close the document + document.Save("TableStyle.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets a value indicating whether to apply style bands to the columns in a table, + if an applied preset table style provides style banding for columns. + + True if need to apply style for banded columns; otherwise, false. + The following example illustrates how to apply style for banded columns of the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Table.docx", FormatType.Docx); + WSection section = document.Sections[0]; + WTable table = section.Tables[0] as WTable; + //Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading); + //Enable special formatting for banded columns of the table + table.ApplyStyleForBandedColumns = true; + //Save and close the document + document.Save("TableStyle.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Table.docx", FormatType.Docx) + Dim section As WSection = document.Sections(0) + Dim table As WTable = TryCast(section.Tables(0), WTable) + 'Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading) + 'Enable special formatting for banded columns of the table + table.ApplyStyleForBandedColumns = True + 'Save and close the document + document.Save("TableStyle.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets the indent from left for the table. + + The float value that indicates the indent from left. + The following example illustrates how to set the left indent for the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + //Add a new table into Word document + IWTable table = section.AddTable(); + //Set number of rows and columns + table.ResetCells(2, 2); + //Set left indent for table. + table.IndentFromLeft = 10; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + 'Add a new table into Word document + Dim table As IWTable = section.AddTable() + 'Set number of rows and columns + table.ResetCells(2, 2) + 'Set left indent for table. + table.IndentFromLeft = 10 + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Represents a Widget with table layout. + + + + + Gets cell widget by row/column indexes. + + + + + + + + Gets row widget by row index. + + + + + + + Gets the row index which contains max no of cells or columns + + + + + Gets rows count. + + + + + + + + + + The table style + + + + + Change the trackchanges table grid into current table grid + + + + + Initializes a new instance of the class with the + specified instance. + + The instance. + + + + Change the name of the style. + + + + + + + Creates the default table grid style. + + + + + + Creates the default Normal table style. + + + + + + Initializes a new instance of the class with the + specified instance and show border option. + + The instance. + True if to show the table border; otherwise, false. + + + + Creates a duplicate copy of the table. + + The reference to the newly created object. + + + + Resets the table with the specified number of rows and columns. + + The integer specifies the number of rows. + The integer specifies the number of columns. + The following example illustrates how to add a table to the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Gets the first section in the document + IWSection section = document.AddSection(); + //Add new table to the section + IWTable table = section.AddTable(); + //Set rows and columns count + table.ResetCells(2, 2); + //Add contents to the table + IWParagraph paragraph = table[0, 0].AddParagraph(); + paragraph.AppendText("Apple"); + paragraph = table[0, 1].AddParagraph(); + paragraph.AppendText("Red"); + paragraph = table[1, 0].AddParagraph(); + paragraph.AppendText("Banana"); + paragraph = table[1, 1].AddParagraph(); + paragraph.AppendText("Yellow"); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Gets the first section in the document + Dim section As IWSection = document.AddSection() + 'Add new table to the section + Dim table As IWTable = section.AddTable() + 'Set rows and columns count + table.ResetCells(2, 2) + 'Add contents to the table + Dim paragraph As IWParagraph = table(0, 0).AddParagraph() + paragraph.AppendText("Apple") + paragraph = table(0, 1).AddParagraph() + paragraph.AppendText("Red") + paragraph = table(1, 0).AddParagraph() + paragraph.AppendText("Banana") + paragraph = table(1, 1).AddParagraph() + paragraph.AppendText("Yellow") + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + The number of cells must be between 1 and 63. + + + + Resets the table with the specified number of rows and columns, table format and cell width. + + The integer specifies the number of rows. + The integer specifies the number of columns. + The specifies the format for the table. + The float specifies the width of the cells. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + //Add a new table into Word document + IWTable table = section.AddTable(); + RowFormat format = new RowFormat(); + format.BackColor = Color.LightGray; + format.CellSpacing = 2; + format.Paddings.All = 2; + //Set number of rows and columns + table.ResetCells(2, 2, format, 200); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + 'Add a new table into Word document + Dim table As IWTable = section.AddTable() + Dim format As New RowFormat() + format.BackColor = Color.LightGray + format.CellSpacing = 2 + format.Paddings.All = 2 + 'Set number of rows and columns + table.ResetCells(2, 2, format, 200) + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Applies the built-in table style to the table. + + The to be applied for the table. + The following example illustrates how to apply built-in style for the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document + WordDocument document = new WordDocument("Table.docx", FormatType.Docx); + WSection section = document.Sections[0]; + //Get the table + WTable table = section.Tables[0] as WTable; + //Apply "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading); + document.Save("TableStyle.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document + Dim document As New WordDocument("Table.docx", FormatType.Docx) + Dim section As WSection = document.Sections(0) + 'Get the table + Dim table As WTable = TryCast(section.Tables(0), WTable) + 'Apply "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading) + document.Save("TableStyle.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Applies the builtin style for the table + + Builtin style name + true if the table cell shading information need to be cleared; otherwise false. + + + + Adds a new row to the table. + + The reference to the newly added . + The following example illustrates how to add new row to the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + section.AddParagraph().AppendText("Price Details"); + section.AddParagraph(); + //Add a new table into Word document + IWTable table = section.AddTable(); + //Add the first row to table + WTableRow row = table.AddRow(); + //Add the first cell into first row + WTableCell cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("Apple"); + //Add the second cell into first row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("$40"); + //Add second row to table + row = table.AddRow(false); + //Add the first cell into first row + cell = row.Cells[0]; + cell.AddParagraph().AppendText("Orange"); + //Add the second cell into first row + cell = row.Cells[1]; + cell.AddParagraph().AppendText("$30"); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + section.AddParagraph().AppendText("Price Details") + section.AddParagraph() + 'Add a new table into Word document + Dim table As IWTable = section.AddTable() + 'Add the first row to table + Dim row As WTableRow = table.AddRow() + 'Add the first cell into first row + Dim cell As WTableCell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("Apple") + 'Add the second cell into first row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("$40") + 'Add second row to table + row = table.AddRow(False) + 'Add the first cell into first row + cell = row.Cells(0) + cell.AddParagraph().AppendText("Orange") + 'Add the second cell into first row + cell = row.Cells(1) + cell.AddParagraph().AppendText("$30") + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Adds a new row to table specifying whether to have the same format as the previous row. + + True if to have the same format as previous row; otherwise, false. + The reference to the newly added . + The following example illustrates how to add new row to the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + section.AddParagraph().AppendText("Price Details"); + section.AddParagraph(); + //Add a new table into Word document + IWTable table = section.AddTable(); + //Add the first row to table + WTableRow row = table.AddRow(); + //Add the first cell into first row + WTableCell cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("Apple"); + //Add the second cell into first row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("$40"); + //Add second row to table + row = table.AddRow(false); + //Add the first cell into first row + cell = row.Cells[0]; + cell.AddParagraph().AppendText("Orange"); + //Add the second cell into first row + cell = row.Cells[1]; + cell.AddParagraph().AppendText("$30"); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + section.AddParagraph().AppendText("Price Details") + section.AddParagraph() + 'Add a new table into Word document + Dim table As IWTable = section.AddTable() + 'Add the first row to table + Dim row As WTableRow = table.AddRow() + 'Add the first cell into first row + Dim cell As WTableCell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("Apple") + 'Add the second cell into first row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("$40") + 'Add second row to table + row = table.AddRow(False) + 'Add the first cell into first row + cell = row.Cells(0) + cell.AddParagraph().AppendText("Orange") + 'Add the second cell into first row + cell = row.Cells(1) + cell.AddParagraph().AppendText("$30") + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Adds a new row to table specifying whether to have the same format and cells count similar to the previous row. + + True if to have the same format as previous row; otherwise, false. + True if need to auto populate cells; otherwise, false. + The reference to the newly added . + The following example illustrates how to add a row with formatting similar to the previous row. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + section.AddParagraph().AppendText("Price Details"); + section.AddParagraph(); + //Add a new table into Word document + IWTable table = section.AddTable(); + //Add the first row into table + WTableRow row = table.AddRow(); + //Add the first cell into first row + WTableCell cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("Item"); + //Add the second cell into first row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("Price($)"); + //Add the second row into table + row = table.AddRow(true, false); + //Add the first cell into second row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("Apple"); + //Add the second cell into second row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("50"); + //Add the third row into table + row = table.AddRow(true, false); + //Add the first cell into third row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("Orange"); + //Add the second cell into third row + cell = row.AddCell(); + //Specify the cell width + cell.Width = 200; + cell.AddParagraph().AppendText("30"); + document.Save("Table.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + section.AddParagraph().AppendText("Price Details") + section.AddParagraph() + 'Add a new table into Word document + Dim table As IWTable = section.AddTable() + 'Add the first row into table + Dim row As WTableRow = table.AddRow() + 'Add the first cell into first row + Dim cell As WTableCell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("Item") + 'Add the second cell into first row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("Price($)") + 'Add the second row into table + row = table.AddRow(True, False) + 'Add the first cell into second row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("Apple") + 'Add the second cell into second row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("50") + 'Add the third row into table + row = table.AddRow(True, False) + 'Add the first cell into third row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("Orange") + 'Add the second cell into third row + cell = row.AddCell() + 'Specify the cell width + cell.Width = 200 + cell.AddParagraph().AppendText("30") + document.Save("Table.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given regular expression in the table with the replace string. + + The used to find the text. + The string specifies the text to replace. + The integer that represents the count of the replacements made. + The following example illustrates how to replace a text in the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx"); + //Get the table + WTable table = document.Sections[0].Tables[0] as WTable; + //Replace the text + table.Replace(new Regex("illustrates"), "describes"); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx") + 'Get the table + Dim table As WTable = TryCast(document.Sections(0).Tables(0), WTable) + 'Replace the text + table.Replace(New Regex("illustrates"), "describes") + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given string in the table with replace string, taking into + consideration case sensitive and whole word options. + + The string represents the text to be found. + The string specifies the text to replace. + Set to true to match the case of the text similar to specified in the parameter; otherwise false. + Set to true to match the whole word of the text similar to specified in the parameter; otherwise false. + The integer that represents the count of the replacements made. + The following example illustrates how to replace a text in the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx"); + //Get the table + WTable table = document.Sections[0].Tables[0] as WTable; + //Replace the text + table.Replace("illustrates", "describes", true, true); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx") + 'Get the table + Dim table As WTable = TryCast(document.Sections(0).Tables(0), WTable) + 'Replace the text + table.Replace("illustrates", "describes", True, True) + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces the specified regular expression with a in the table. + + The used to find the text. + The which specifies the text to replace. + The integer that represents the count of the replacements made. + The following example illustrates how to replace a text in the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx"); + //Get the table + WTable table = document.Sections[0].Tables[0] as WTable; + //Get first paragraph + WParagraph paragraph = document.Sections[0].Paragraphs[0]; + //Get the text using text selection + TextSelection selection = new TextSelection(paragraph, 0, 20); + //Replace the text + table.Replace(new Regex("illustrates"), selection); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx") + 'Get the table + Dim table As WTable = TryCast(document.Sections(0).Tables(0), WTable) + 'Get first paragraph + Dim paragraph As WParagraph = document.Sections(0).Paragraphs(0) + 'Get the text using text selection + Dim selection As New TextSelection(paragraph, 0, 20) + 'Replace the text + table.Replace(New Regex("illustrates"), selection) + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Replaces all entries of given regular expression in the table with the + along with its formatting. + + The used to find the text. + The which specifies the text to replace. + Set to true if to save source formatting; otherwise, false. + The integer that represents the count of the replacements made. + The following example illustrates how to replace a text in the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx"); + //Get the table + WTable table = document.Sections[0].Tables[0] as WTable; + //Get first paragraph + WParagraph paragraph = document.Sections[0].Paragraphs[0]; + //Get the text using text selection + TextSelection selection = new TextSelection(paragraph, 0, 20); + //Replace the text + table.Replace(new Regex("illustrates"), selection, true); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx") + 'Get the table + Dim table As WTable = TryCast(document.Sections(0).Tables(0), WTable) + 'Get first paragraph + Dim paragraph As WParagraph = document.Sections(0).Paragraphs(0) + 'Get the text using text selection + Dim selection As New TextSelection(paragraph, 0, 20) + 'Replace the text + table.Replace(New Regex("illustrates"), selection, True) + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Returns first entry of the specified in the table. + + The that specifies the text to be found. + The object which represents the text found. + The following example illustrates how to find a text in the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx"); + //Get the table + WTable table = document.Sections[0].Tables[0] as WTable; + //Find the text in the table + TextSelection selection = table.Find(new Regex("content")); + WTextRange text = selection.GetAsOneRange(); + //Set the character format of the text found + text.CharacterFormat.AllCaps = true; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx") + 'Get the table + Dim table As WTable = TryCast(document.Sections(0).Tables(0), WTable) + 'Find the text in the table + Dim selection As TextSelection = table.Find(New Regex("content")) + Dim text As WTextRange = selection.GetAsOneRange() + 'Set the character format of the text found + text.CharacterFormat.AllCaps = True + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Applies the vertical merge for table cells specified by the column index, start row index and end row index. + + The integer specifies index of the column. + The integer specifies start index of the row. + The integer specifies end index of the row. + The following example illustrates how to apply vertical merge for the table cells. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + section.AddParagraph().AppendText("Vertical merging of Table cells"); + IWTable table = section.AddTable(); + table.ResetCells(5, 5); + //Specify the vertical merge to the third cell, from second row to fifth row + table.ApplyVerticalMerge(2, 1, 4); + document.Save("VerticalMerge.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + section.AddParagraph().AppendText("Vertical merging of Table cells") + Dim table As IWTable = section.AddTable() + table.ResetCells(5, 5) + 'Specify the vertical merge to the third cell, from second row to fifth row + table.ApplyVerticalMerge(2, 1, 4) + document.Save("VerticalMerge.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Removes the last empty paragraph in merge start cell. + + The integer specifies index of the column. + The integer specifies start index of the row. + The integer specifies end index of the row. + + + + Removes the last empty paragraph in merge continue/end cell. + + The integer specifies index of the column. + The integer specifies continue index of the row. + The integer specifies end index of the row. + + + + Checks whether the following cells have renderable items. + + The integer specifies index of the column. + The integer specifies start index of the row. + The integer specifies end index of the row. + True if following cells have renderable items; Otherwise false. + + + + Checks whether any renderable items present in the paragraph. + + The paragraph. + + + + + Applies horizontal merge for table cells specified by the row index, start cell index and end cell index. + + The integer specifies index of the row. + The integer specifies start index of the cell. + The integer specifies end index of the cell. + The following example illustrates how to apply horizontal merge for the table cells. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + section.AddParagraph().AppendText("Vertical merging of Table cells"); + IWTable table = section.AddTable(); + table.ResetCells(5, 5); + //Specify the horizontal merge from second cell to fifth cell in third row + table.ApplyHorizontalMerge(2, 1, 4); + document.Save("HorizontalMerge.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + section.AddParagraph().AppendText("Vertical merging of Table cells") + Dim table As IWTable = section.AddTable() + table.ResetCells(5, 5) + 'Specify the horizontal merge from second cell to fifth cell in third row + table.ApplyHorizontalMerge(2, 1, 4) + document.Save("HorizontalMerge.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Updates the textbody items in the merge start cell. + + The cell collection. + The integer specifies start index of the cell. + The integer specifies end index of the cell. + + + + Updates the textbody items in the merge continue cells. + + The cell collection. + The integer specifies start index of the cell. + The integer specifies end index of the cell. + + + + Updates and removes the last paragraph only if bookmark is present inside the last paragraph of the cell. + + The cell collection. + The integer specifies the current cell index. + The integer specifies the previous cell index. + + + + Updates and removes the last paragraph only if paragraph items other than bookmark present inside the cell. + + + + + + + + Checks whether the last paragraph contains bookmark and other items. + + The textbody item collection. + The paragraph is empty. + The paragraph item is not consider. + + + + + Removes the absolute position data, if the table has absolute position in the document. + + + + + Resizes the table based on the specified . + + The member that specifies the type of auto fit layout of table. + DocIO can resize the table based on the content of the table cells or the width of the document window. + You can also use this method to turn off AutoFit so that the table size is fixed, regardless of cell contents or window width. + Setting the AutoFit behavior to FitToContent or FitToWindow sets the property to True if it's currently False. + Likewise, setting the AutoFit behavior to FixedColumnWidth sets the property to False if it's currently True. + The following example illustrates how to append html text to the paragraph. + + //Loads the template document + WordDocument document = new WordDocument("Sample.docx"); + //Accesses the instance of the first section in the Word document + WSection section = document.Sections[0]; + //Accesses the instance of the first table in the section + WTable table = section.Tables[0] as WTable; + //Auto fits the table with respect to window. + table.AutoFit(AutoFitType.FitToWindow); + //Saves and closes the document instance + document.Save("TableAutoFit.docx"); + document.Close(); + + + Private Sub SurroundingSub() + Dim document As WordDocument = New WordDocument("Sample.docx") + Dim section As WSection = document.Sections(0) + Dim table As WTable = TryCast(section.Tables(0), WTable) + table.AutoFit(AutoFitType.FitToWindow) + document.Save("TableAutoFit.docx") + document.Close() + End Sub + + + + + + Gets the minimum and maximum word width of the table. + + + + + + + Checks whether the outertable cell width need to recalculate or not + + + + + Checks whether need to skip resizing the nested table in cell + + Represents the width of nested table + + + + Check whether both table have different padding value. + + Previous sibiling of current table. + Current table those need to merge on previous table. + Padding key. + + + + + Check whether both tables have same padding value + + Previous sibiling of current table. + Current table those need to merge on previous table. + + + + + Check whther is same padding as table for current cell. + + Current cell of row. + + + + Set the padding value for cells. + + + + + + Merge the two individual tables as single table. + + + + + + Sets borders for merged table rows + + The current table + The previous table + The current appended row + + + + Get the border for the corresponding string value + + String value that represents the border + The borders + Border for the corresponding string value from borders + + + + Checks whether the table has border + + + + True if table border has border else false + + + + Resizes the table based on the specified . + + + + + + Check whether table present inside the cell or not. + + + + + + + + Get the owner table cell for the table + + + + + + + Gets the table text. + + + + + + Gets the style applied for the table. + + The of the current table. + + + + Applies the specified style. + + Style name + Specified style must exist in Document.Styles collection + + + + Removes the shading information from all the cells in the table + + + + + + Applies the specified style. + + + + + + + Applies the base style formats. + + + + + Checks whether the table style or its base style contains the respective ConditionalFormattingType + + ConditionalFormattingType + True, if the table style or its base style contains the respective ConditionalFormattingType else false + + + + Gets the combination of table style and its base style row conditional formatting. + + Current table style + Row index + + + + + The combination of table style and its base style row conditional formatting + + + + Get the row conditional formatting style for current row index + + Current table index + Row index + + + + + + + + + Gets the combination of table style and its base style cell conditional formatting. + + Current table style + Conditional formatting type + Row index + Cell index + + + + + + + Get the cell conditional formatting style for current row and cell index + + Current table style + Conditional formatting type + Row index + Cell index + + + + + + + Copy the souce key and paste in destination, if destination doesn't contains the same key + + Destination keys + Source keys + + + + Copy the base paragraph format and character format + + + + + + + + Get the current cell format from its table style + + + + + + + + Updates the row borders. + + The dest. + The src. + The table borders. + The index. + The count. + Whether the left and right width applicable + + + + Updates the column borders. + + The dest. + The src. + The table borders. + The index. + The count. + + + + Returns all entries of given regex. + + The pattern. + + + + + Adds the self. + + + + + Creates a duplicate copy of the table. + + + The object that can be casted as . + + + + Clones the relations. + + + + + + Clones the style. + + The doc. + + + + Checks the table grid, after parsing Docx format documents. + + + + + Determines whether the width and preferred width of a cell is zero. + + True if cell width and preferred width is zero; Otherwise false. + + + + Updates the cell width by equally partitioning the available width among all the cells in a row. + + The available width for table. + + + + Checks whether need to partition the width equally to all cells or not + + + + + + Updates the preferred cell width to undefined table cells. + + + + + + Updates the table grid. + + + + + Checks whether the table grid should update based on maximum cell preferred width in percentage. + + Table Preferred Width. + Checks whether the table grid is matched with cells or not. + The sum of maximum cell preferred width. + The maximum cell preferred width list. + True if the the table grid update based on maximum cell preferred width in percentage else False. + + + + Checks whether the table grid should update based on maximum cell preferred width in point. + + Checks whether the table grid is matched with cells or not. + True if the the table grid update based on maximum cell preferred width in point else False. + + + + Checks whether the table grid for autofit table should update based on maximum cell preferred width. + + The sum of maximum cell preferred width. + The maximum cell preferred width list. + True if the table grid should be updated based on the maximum cell preferred width; otherwise, False. + + + + Checks if the maximum preferred width of cells needs to be updated for columns. + + The list of maximum cell preferred width. + True if the maximum preferred widths are updated, otherwise false. + + + + Update the table grid based on calculated maximum cell preferred width in percentage. + + The table width. + The sum of maximum cell preferred width. + The list of maximum cell preferred width. + + + + Update the table grid based on calculated maximum cell preferred width in point. + + The table width. + Checks whether the table grid is matched with cells or not. + + + + Update the maximum cell preferred width based on table width in percentage. + + The table width. + The sum of maximum cell preferred width. + The list of maximum cell preferred width. + The updated list of maximum preferred widths of cells. + + + + Update the cell width and table grid based on calculated maximum cell preferred width. + + The list of maximum cell preferred width. + + + + Checks whether the table grid should update based on maximum cell preferred width. + + The table width. + The sum of maximum cell preferred width. + The maximum cell preferred width list. + True if the the table grid update based on maximum cell preferred width else False. + + + + Checks whether the table grid should update based on maximum cell preferred width in point. + + The table width. + The sum of maximum cell preferred width. + The maximum cell preferred width list. + True if the the table grid update based on maximum cell preferred width in point, else False. + + + + Update the maximum cell preferred width based on table width. + + The table width. + The sum of maximum cell preferred width. + The maximum cell preferred width list. + + + + Gets the maximum cell preferred width of each columns. + + The column index. + The column span. + The maximum cell preferred width list. + + + + + Update the maximum cell preferred width based on spanned cells. + + The maximum cell preferred width list. + + + + Update the table grid based on calculated maximum cell preferred width. + + The table width. + The sum of maximum cell preferred width. + The maximum cell preferred width list. + + + + Checks whether the grid corrupted table should update based on cell preferred width. + + + + + + Checks whether any row in table has GridBeforeWidth or GridAfterWidth. + + True, any row in table has GridBeforeWidth or GridAfterWidth else false + + + + Updated the corrupted grid table based on cell preferred width. + + + + + Update the mismatch grid based on maximum cell preferred width. + + + + + Checks if there is any row in the table that does not contain any spanned cells. + + True if there is at least one row without any spanned cells, otherwise returns False. + + + + Checks wheather all the cells have the defined cell width. + + + + + + Check whether the neighbour tables need to merge + + True, if the table has only one neighbour table and both the table's have same style; else, false + + + + Create grid columns. + + + + + Updates cell width of a table in DOC format document + + + + + Check whether allrows in a table contains same row width + + Row width of first row + True if all rows contain same row width. Else false + + + + Checks whether the table is need to autofit to content or not. + + True, If the preferred width of the column is not defined. Else returns false + + + + Checks whether we need to skip the grid value or not based on cell preferred width and maximumWordWidth. + + True, If the cell preferred width greater than maximum word width and no cell merge is there. Else returns false + + + + Checks whether the table contains misalligned cells. + + True, if the verical merge is need to consider; else false + True, If the table have merge columns either vertically or horizontally or having cellspan. Else returns false + + + + Checks whether the auto table is need to skip the table grid. + + True, If condition satisfies . Else returns false + + + + Resize the columns width of each cell. + + + + + Updates the grid span value of the each cells. + + + + + Updates the grid span value of the each cells. + + + + + Checks whether the table preferred width type auto or not. + + + + + + + + Gets the row span value. + + + + + + + Get cell width + + + + + + + + + + Gets the minimum preferred width of the table. + + The cell. + + + + + Set the column to each cells. + + + + + Gets the maximum nested table width from last column + + Maximum nested table width from last column + + + + Sets the width to nested table cells + + + + + Sets the cell width as column preferred width + + + + + + + Update the table row before and after width + + + + + + Check whether the column has enough width + + + True If the column preferred width doesn't enough to store MaximumWordWidth else False + + + + Check whether table contains textWrap disabled cell + + + List containing columns which has textWrap disabled cell + + + + Check whether table contains textWrap disabled cell and textWrapEnabled cell has maximum para width equal to 0. + + + True when textWrap Enabled columns have maxParaWidth equal to 0. Otherwise False. + + + + Checks whether column has enough width to store Maximum word width word in a column + + Table columns + Table Width + True if columns doesn't have enough width to store max word width. Otherwise False + + + + Checks whether the cell width need to assign base on content + + + + + + Sets the cell width of the table using Content + + + + + Checks whether all cell in a table preferred width is 0 and the width type is auto + + True if all cell in a table preferred width is 0 and the width type is auto Otherwise False + + + + Gets the maximum cell count by comparing all rows in table + + + + + + Update the preferred width properites based on autofit type. + + + + + + + Clears the Preferred width properties. + + + + + Check whether all the cells in any of the row has defined cell width + + current table + True, if all the cells in any of the rows have defined cell width; else false + + + + Gets the width of the max row. + + Width of the client. + + + + + Gets the width of the max row. + + + + + + Updates the width of the cell. + + The row. + Width of the client. + Width of the table. + Width of the max row. + Checks whether need to do width calculation or not + + + + Recalculates the cell width of the row containing vMerge + + Vertical merge start cell + Current cell + Current row + Table width + List of cell width that is recalculated for a vertical merge row + + + + Checks whether the first cell in all row upto cell count has same preferred width + + True if first cell in all row upto cell count has same preferred width else false + + + + Returns the maximum sum of all cell preferred width conatins row index + + The Tablewidth + Returns the maximum sum of all cell preferred width conatins row index + + + + Calculate cell width based on preferred cell width for fixed layout table + + Cell to calculate width + Total row width + Default preferred cell width, if cell width not mentioned in file level + Total width to shrink the row + Total width to expand the row + + + + Checks whether auto layout table have preferred width which exceeds the client width of page + + + + + + Checks whether need to do width calculation or not + + + + + + Gets the grid before after. + + The row. + Width of the client. + if set to true [is after width]. + Width of the table. + The curr offset. + Maximum width of the row. + if set to true [is table grid miss match]. + + + + + Gets the grid before after. + + The width info. + Width of the table. + + + + + Gets the width of the cell. + + The cell. + Width of the client. + Width of the table. + The curr offset. + Width of the max row. + if set to true [is table grid miss match]. + True if the table has any one row having all cells have defined cell widths; else false + + + + + Get the maximum cell preferred width from each columns + + Current table + Total cell preferred width + Maximum cell count + A list of maximum preferred cell width for each columns + + + + Get the maximum cell preferred width of a column for columnIndex columns + + Return Maximum cell preferred width of column if column not present return -1 + + + + + Gets the width of the table owner. + + + + + + Gets the width of the table client. + + Width of the client. + + + + + Calcualte the left and right padding considerd for table width + + + + + Updates the table grid. + + The current offset. + + + + Gets the next TextBodyItem in the document. + + + + + + Updates the table format. + + The prop key. + + + + Closes the items in the table + + + + + Updates the width. + + + + + + Get the section in which table is present + + + + + + Get the HeaderFooter that contains the current table. + + The HeaderFooter containing the table, or null if the table is not within a HeaderFooter. + + + + Get owner table of item + + + + + Remove the unwanted continue horizontal merge cells + + + + + + Get the maximum cell count by comparing all rows + + + Maximum cell count by comparing all rows and the row should not contains spanned cells + + + + Accepts or rejects changes tracked from the moment of last change acceptance. + + if it accepts the changes, set to true. + + + + Removes the character format changes. + + + + + Removes the table format changes. + + + + + Accepts the changes for character format. + + + + + Accept changes in table format. + + + + + Defines whether table format is changed. + + + + + + Checks a value indicating whether this item was deleted from the document, + when "Track Changes" is or was set to "true". + + + + + + Checks a value indicating whether this item was inserted to the document, + when "Track Changes" is or was set to "true". + + + + + + Defines whether table format was changed. + + + + + + Determines whether item has tracked changes. + + + if has tracked changes, set to true. + + + + + Remove added/deleted table rows, while number of rows > 1. + + Value indicating whether to completely remove table + + + + Sets the delete revision for table. + + if it specifies the revision to delete, set to true. + + + + Sets the insert revision for table. + + if it specifies the revision for insertion, set to true. + + + + Sets the changed Character format for table. + + if it specifies format to be change, set to true. + + + + Sets the changed Paragraph format for table. + + if it specifies the format to be changed, set to true. + + + + Registers child objects in XDSL holder. + + + + + + Writes object data as xml attributes. + + + The object. + + + + Creates layout information. + + + + + + Determine whether the current row is need to be hidden + + + + + + Determine whether the paragraph is Hidden + + + + + + + Determine whether the table is hidden + + + + + + + + + + + + + + + + + + + + + + Initializing LayoutInfo value to null + + + + + Compare the revised document table with original document table + + The original document instance + + + + Compare the revised text body table with original text body table + + The original text body instance + + + + Compare one table format with another and return true if Equal else false. + + + + + Get the matched table and indexes. + + The original document table + The matched table + Return, the longest matched table from orgDocTables + + + + Get the longest matched row index + + + + + + + + Get all matched row index + + + + + + + + Apply the formatting change for matched table by comparing current table + + Original document matched table + + + + Compare the cell format for matched cells + + + + + + + + Compare the row formats for the matched row + + + + + + + + Gets the complete text of table for word comparison + + + + + + Gets the type of the entity. Read-only. + + The of the current item. + + + + Gets the rows collection that represent all the rows in the table. Read-only. + + The collection of rows in the table. + + + + + + Gets the table format. Read-only. + + The object that specifies the table format. + + + + Gets the preferred width of the table. + + The width of the preferred table. + + + + Gets the name of the table style. Read-only. + + The string that specifies the style name. + + + + Gets the last cell in last row. Read-only. + + The object that represents the last cell. + The following example illustrates how to get the last cell of the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx"); + //Get the table + WTable table = document.Sections[0].Tables[0] as WTable; + //Get the last cell + WTableCell cell = table.LastCell; + //Apply text direction to the last cell + cell.CellFormat.TextDirection = Syncfusion.DocIO.DLS.TextDirection.Vertical; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx") + 'Get the table + Dim table As WTable = TryCast(document.Sections(0).Tables(0), WTable) + 'Get the last cell + Dim cell As WTableCell = table.LastCell + 'Apply text direction to the last cell + cell.CellFormat.TextDirection = Syncfusion.DocIO.DLS.TextDirection.Vertical + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the first row in table. Read-only. + + The object that represents the first row in the table. + The following example illustrates how to get the first row of the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx"); + //Get the table + WTable table = document.Sections[0].Tables[0] as WTable; + //Get the last cell + WTableRow row = table.FirstRow; + //Apply text direction to the last cell + row.RowFormat.BackColor = Color.LightGray; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx") + 'Get the table + Dim table As WTable = TryCast(document.Sections(0).Tables(0), WTable) + 'Get the last cell + Dim row As WTableRow = table.FirstRow + 'Apply text direction to the last cell + row.RowFormat.BackColor = Color.LightGray + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the last row in table. Read-only. + + The object that represents the last row in the table. + The following example illustrates how to get the last row of the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx"); + //Get the table + WTable table = document.Sections[0].Tables[0] as WTable; + //Get the last cell + WTableRow row = table.LastRow; + //Apply text direction to the last cell + row.RowFormat.BackColor = Color.LightGray; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx") + 'Get the table + Dim table As WTable = TryCast(document.Sections(0).Tables(0), WTable) + 'Get the last cell + Dim row As WTableRow = table.LastRow + 'Apply text direction to the last cell + row.RowFormat.BackColor = Color.LightGray + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the table cell at the specified row and column index. Read-only. + + The integer that specifies the row index. + The integer that specifies the column index. + The object at the specified index. + The index is not valid in the table. + The following example illustrates how to get the cell in the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a Word document + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + //Add new table. + IWTable table = section.AddTable(); + table.ResetCells(2, 2); + //Add content to table cell + table[0, 0].AddParagraph().AppendText("First row, First cell"); + table[0, 1].AddParagraph().AppendText("First row, Second cell"); + table[1, 0].AddParagraph().AppendText("Second row, First cell"); + table[1, 1].AddParagraph().AppendText("Second row, Second cell"); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a Word document + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + section.AddParagraph().AppendText("Horizontal merging of Table cells") + 'Add new table. + Dim table As IWTable = section.AddTable() + table.ResetCells(2, 2) + 'Add content to table cell + table(0, 0).AddParagraph().AppendText("First row, First cell") + table(0, 1).AddParagraph().AppendText("First row, Second cell") + table(1, 0).AddParagraph().AppendText("Second row, First cell") + table(1, 1).AddParagraph().AppendText("Second row, Second cell") + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the width of the table(in points). + + The float that specifies the width of the table. + + + + Gets the child elements of the table. + + The collection of child elements. + + + + Gets the table grid. + + + + + Gets or sets the indent from left for the table. + + The float value that indicates the indent from left. + The following example illustrates how to set the left indent for the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + //Add a new table into Word document + IWTable table = section.AddTable(); + //Set number of rows and columns + table.ResetCells(2, 2); + //Set left indent for table. + table.IndentFromLeft = 10; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + 'Add a new table into Word document + Dim table As IWTable = section.AddTable() + 'Set number of rows and columns + table.ResetCells(2, 2) + 'Set left indent for table. + table.IndentFromLeft = 10 + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets the docx table format. + + The docx table format. + + + + Gets the old row format. + + The old row format. + + + + Gets the track table grid. + + The track table grid. + + + + Gets or sets a value indicating whether to apply heading-row formatting to the first row of the table. + The default value is true. + + True if need to apply style for first row; otherwise, false. + The following example illustrates how to apply style for header row of the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Table.docx", FormatType.Docx); + WSection section = document.Sections[0]; + WTable table = section.Tables[0] as WTable; + //Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading); + //Disable special formatting for header row of the table + table.ApplyStyleForHeaderRow = false; + //Save and close the document + document.Save("TableStyle.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Table.docx", FormatType.Docx) + Dim section As WSection = document.Sections(0) + Dim table As WTable = TryCast(section.Tables(0), WTable) + 'Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading) + 'Disable special formatting for header row of the table + table.ApplyStyleForHeaderRow = False + 'Save and close the document + document.Save("TableStyle.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets a value indicating whether to apply last-row formatting to the last row of the specified table. + + True if need to apply style for last row; otherwise, false. + The following example illustrates how to apply style for last row of the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Table.docx", FormatType.Docx); + WSection section = document.Sections[0]; + WTable table = section.Tables[0] as WTable; + //Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading); + //Enable special formatting for last row of the table + table.ApplyStyleForLastRow = false; + //Save and close the document + document.Save("TableStyle.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Table.docx", FormatType.Docx) + Dim section As WSection = document.Sections(0) + Dim table As WTable = TryCast(section.Tables(0), WTable) + 'Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading) + 'Enable special formatting for last row of the table + table.ApplyStyleForLastRow = True + 'Save and close the document + document.Save("TableStyle.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets a value indicating whether to apply first-column formatting to the first column of the specified table. + The default value is true. + + True if need to apply style for first column; otherwise, false. + The following example illustrates how to apply style for first column of the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Table.docx", FormatType.Docx); + WSection section = document.Sections[0]; + WTable table = section.Tables[0] as WTable; + //Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading); + //Disable special formatting for first column of the table + table.ApplyStyleForFirstColumn = false; + //Save and close the document + document.Save("TableStyle.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Table.docx", FormatType.Docx) + Dim section As WSection = document.Sections(0) + Dim table As WTable = TryCast(section.Tables(0), WTable) + 'Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading) + 'Disable special formatting for first column of the table + table.ApplyStyleForFirstColumn = False + 'Save and close the document + document.Save("TableStyle.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets a value indicating whether to apply last-column formatting to the last column of the specified table.. + + True if need to apply style for last column; otherwise, false. + The following example illustrates how to apply style for last column of the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Table.docx", FormatType.Docx); + WSection section = document.Sections[0]; + WTable table = section.Tables[0] as WTable; + //Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading); + //Enable special formatting for last column of the table + table.ApplyStyleForLastColumn = true; + //Save and close the document + document.Save("TableStyle.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Table.docx", FormatType.Docx) + Dim section As WSection = document.Sections(0) + Dim table As WTable = TryCast(section.Tables(0), WTable) + 'Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading) + 'Enable special formatting for last column of the table + table.ApplyStyleForLastColumn = True + 'Save and close the document + document.Save("TableStyle.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets a value indicating whether to apply style bands to the rows in a table, + if an applied preset table style provides style banding for rows. The default value is True. + + True if need to apply style for banded rows; otherwise, false. + The following example illustrates how to apply style for banded rows of the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Table.docx", FormatType.Docx); + WSection section = document.Sections[0]; + WTable table = section.Tables[0] as WTable; + //Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading); + //Disable special formatting for banded rows of the table + table.ApplyStyleForBandedRows = false; + //Save and close the document + document.Save("TableStyle.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Table.docx", FormatType.Docx) + Dim section As WSection = document.Sections(0) + Dim table As WTable = TryCast(section.Tables(0), WTable) + 'Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading) + 'Enable special formatting for banded rows of the table + table.ApplyStyleForBandedRows = False + 'Save and close the document + document.Save("TableStyle.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets a value indicating whether to apply style bands to the columns in a table, + if an applied preset table style provides style banding for columns. + + True if need to apply style for banded columns; otherwise, false. + The following example illustrates how to apply style for banded columns of the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Table.docx", FormatType.Docx); + WSection section = document.Sections[0]; + WTable table = section.Tables[0] as WTable; + //Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading); + //Enable special formatting for banded columns of the table + table.ApplyStyleForBandedColumns = true; + //Save and close the document + document.Save("TableStyle.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Table.docx", FormatType.Docx) + Dim section As WSection = document.Sections(0) + Dim table As WTable = TryCast(section.Tables(0), WTable) + 'Applies "LightShading" built-in style to table + table.ApplyStyle(BuiltinTableStyle.LightShading) + 'Enable special formatting for banded columns of the table + table.ApplyStyleForBandedColumns = True + 'Save and close the document + document.Save("TableStyle.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets the table title. + + The string that specifies the title of the table. + + + + Gets or sets the table description. + + The string that specifies the description of the table. + + + + Gets a value indicating whether this instance is frame. + + true if this instance is frame; otherwise, false. + + + + Gets a value indicating whether this instance is complete frame. + + true if this instance is frame; otherwise, false. + + + + Gets or sets the a value indicating whether the table grid is updated in parsing. + + + + + Gets or sets the a value indicating whether the table grid is updated when the width is not as expected. + + + + + Gets or sets a value indicating whether the cell width is defined when the table width type is None. + + + + + Gets or sets a value indicating whether to update cell width by equally partitioning the available width among all the cells in a row. + + + + + Gets or sets a value indicating whether the cell width is defined when the table width type is None. + + + + + Gets a value indicating whether the current table is in cell. Read-only. + + + True if this paragraph is in cell; otherwise, false. + + + + Gets or sets a value whether all cells in the table have fixed width in points. + + + This property is supported for DOCX format alone. + + + + + Gets or sets a value whether all cells child entity is only paragraph. + + + This property is supported for DOCX format alone. + + + + + Gets or set whether the table cell width need to recalculate or not, based on last column + + + + + Gets or sets a value indicating whether all cells only have horizontal text. + + + true if all cells only have horizontal text; otherwise, false. + + + This property is supported for DOCX format alone. + + + + + Denotes any one of the cells have percentage type of preferred cell width. + + + + + Denotes any one of the cells have auto type of preferred cell width. + + + + + Denotes any one of the cells have none type of preferred cell width. + + + + + Denotes any one of the cells have Point type of preferred cell width. + + + + + Denotes any one of the cells have zero preferred cell width. + + + + + Gets or Sets whether need to recalculate the nested and outer table + + + + + Gets the recalculate nested table + + + + + Gets or Sets whether need to recalculate the nested and outer table + + + + + Gets or sets whether the table is appended from HTML + + + + + Gets or setd whether the table have same cell count for all rows in the table + + + + + Get's or sets whether the table is merged with previous table or not while parsing + + + + + + + + + + + + + + + Represents a table cell. + + + + + + + + + + Initializes a new instance of the class with the + specified instance. + + The instance. + + + + Creates a duplicate copy of the entity. + + The reference to the newly created cell. + + + + Returns the index of the cell in the table row. + + The zero-based index of the cell. + The following example illustrates how set get the index of the cell. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx"); + //Get the table + WTable table = document.Sections[0].Tables[0] as WTable; + //Find the text in the table + TextSelection selection = table.Find(new Regex("Cell")); + WTextRange text = selection.GetAsOneRange(); + //Get the owner paragraph + WParagraph paragraph = text.OwnerParagraph; + //Get the owner cell + WTableCell cell = paragraph.OwnerTextBody as WTableCell; + //Get the index of the cell + int index = cell.GetCellIndex(); + //Apply text direction to the next cell + cell = cell.OwnerRow.Cells[index + 1]; + cell.CellFormat.TextDirection = Syncfusion.DocIO.DLS.TextDirection.Vertical; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx") + 'Get the table + Dim table As WTable = TryCast(document.Sections(0).Tables(0), WTable) + 'Find the text in the table + Dim selection As TextSelection = table.Find(New Regex("Cell")) + Dim text As WTextRange = selection.GetAsOneRange() + 'Get the owner paragraph + Dim paragraph As WParagraph = text.OwnerParagraph + 'Get the owner cell + Dim cell As WTableCell = TryCast(paragraph.OwnerTextBody, WTableCell) + 'Get the index of the cell + Dim index As Integer = cell.GetCellIndex() + 'Apply text direction to the next cell + cell = cell.OwnerRow.Cells(index + 1) + cell.CellFormat.TextDirection = Syncfusion.DocIO.DLS.TextDirection.Vertical + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Creates a duplicate copy of the entity. + + + An that can be casted as table cell. + + + + Registers child objects in XDSL holder. + + + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Determines whether the width and preferred width of a cell is zero. + + True if cell width and preferred width is zero; Otherwise false. + + + + Updates the width of the table preferred. + + Width of the prev. + The new value. + + + + Applies the table style base formats. + + The cell format. + The para format. + The char format. + + + + Applies the table style base formats for inline content control. + + + + + + + + + Checks whether table style has paragraph formatting. + + + + + + Checks whether paragraph format defined or not. + + Paragraph style format. + + + + + Decides whether style hierarchy rule should override or not. + + Current paragraph. + + + + + Checks whether font size defined in any of paragraph styles. + + Current paragraph style + + + + + Checks whether the Normal Style font size is defined as per specification. + + Normal Style character format. + + + + + Sets the document default font size to current formatting. + + Current inline formatting. + + + + Sets font size from table style as per overrideTableStyleFontSizeAndJustification behavior + + The owner paragraph of current item in cell + The character format of paragraph item + Character format from table style + Boolean denotes overrideTableStyleFontSizeAndJustification tag + A boolean which represents whether character format of an item has font size key or not + A boolean which represents whether character format of an item has font bidi size key or not + + + + Sets font size from table style as per overrideTableStyleFontSizeAndJustification behavior + + The owner paragraph of current item in cell + The character format of paragraph item + Character format from table style + Boolean denotes overrideTableStyleFontSizeAndJustification tag + Character Format key denotes FontSizekey or FontSizeBidiKey + A boolean which represents whether character format of an item has font size key or not + + + + Checks font size not defined in inline, Character style, paragraph style, Linked Character style, Linked Para Style, basedOn Para Style and basedOn Char Style + + The character format of paragraph item + The owner paragraph of current item in cell + Character Format key denotes FontSizekey or FontSizeBidiKey + A boolean which represents whether character format of an item has font size key or not + + + + + Checks whether FontSize key exists in default formatting and + doesn't exists in current inline formatting. + + Current inline formatting. + Font size key + + + + + Clones the cell. + + + + + + Gets the next TextBodyItem in the document + + + + + + Gets the V merge cell. + + The cellindex. + The rowindex. + The curr row. + + + + + Closes this instance. + + + + + Gets the width of the cell. + + + + + + Gets the width. + + + + + + Gets the cell start position. + + + + + + Gets the cell end position. + + Index of the row. + Index of the cell. + + + + + Gets the index of the horizontal merge end cell. + + + + + + Gets the previous cell by excluding the horizontal merge continue cells. + + + + + + Returns Left Padding + + + + + + Returns Right Padding + + + + + + Returns Top Padding + + + + + + Returns Bottom Padding + + + + + + Gets the size info of of cell. + + + + Boolean to decide whether the ParagraphWidth calculation should do or not + + + + + Gets the minimum and maximum word width. + + + + + + + + Gets the minimum and maximum word width. + + + + + + + + Gets the minimun preferred width. + + + + + + Get Maximum word width of vertical direction cell. + + Calculated Maximum word width. + + + + + Check the cell width type and enable the property according to the preferred width type + + + + + Gets the complete text of table cell for word comparison + + + + + + Create layout information. + + + + + + Creates the table cell layoutinfo. + + Returns the cell layout info. + This method is used for RTF writer. + + + + Reset the cell layoutinfo. + + This method is used for RTF writer. + + + + Find the owner row of the vertical merged end cell + + owner cell of the paragraph + if merged end cell is true;return Owner row of the merged end cell,otherwise return owner row of the table cell + + + + Checks the foot note in text body. + + The text body. + + + + Checks the foot note in paragraph. + + The paragraph. + + + + Initializing LayoutInfo value to null + + + + + Add previous paragraph to current cell for paragraph property not lies between paragraph tag. + + + + + + Gets the number of grid columns spanned by the current cell. Read-only. + + The short specifies the number of grid columns in the parent table's table grid which shall be spanned by the current cell + GridSpan allows cells to have the appearance of being merged, as they span vertical boundaries of other cells in the table. + + + + Gets/Sets the cell grid start index + + Cell grid start index + + + + Gets/Sets the cell content control in this cell. + + The following code illustrates how to set a cell content control to the table. + + WordDocument document = new WordDocument(); + //Adds new section to the document. + IWSection section = document.AddSection(); + //Adds new table to the section. + IWTable table = section.AddTable(); + //Adds new row to the table. + WTableRow tableRow = table.AddRow(); + //Adds new cell to the row. + WTableCell tableCell = tableRow.AddCell(); + tableCell.Width = 100; + //Adds new paragraph to the cell. + IWParagraph paragraph = tableCell.AddParagraph(); + //Adds new text to the paragraph. + paragraph.AppendText("Content Control"); + //Create the Cell Content Control for the document. + CellContentControl control = new CellContentControl(document); + //Change the color value in Content Control properties. + control.ContentControlProperties.Color = System.Drawing.Color.Green; + //Set it to the row content control. + tableCell.ContentControl = control; + //Save the Word document. + document.Save("Sample.docx", FormatType.Docx); + //Close the document. + document.Close(); + + + Dim document As New WordDocument() + 'Adds new section to the document. + Dim section As IWSection = document.AddSection() + 'Adds new table to the section. + Dim table As IWTable = section.AddTable() + 'Adds new row to the table. + Dim tableRow As WTableRow = table.AddRow() + 'Adds new cell to the row. + Dim tableCell As WTableCell = tableRow.AddCell() + tableCell.Width = 100 + 'Adds new paragraph to the cell. + Dim paragraph As IWParagraph = tableCell.AddParagraph() + 'Adds new text to the paragraph. + paragraph.AppendText("Content Control") + 'Create the Cell Content Control for the document. + Dim control As New CellContentControl(document) + 'Change the color value in Content Control properties. + control.ContentControlProperties.Color = System.Drawing.Color.Green + ' Set it to the row content control. + tableCell.ContentControl = control + 'Save the Word document. + document.Save("Sample.docx", FormatType.Docx) + 'Close the document. + document.Close() + + + + + + Gets the type of the entity. + + The of the current item. + + + + Gets the owner row of the cell. Read-only. + + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx"); + //Get the table + WTable table = document.Sections[0].Tables[0] as WTable; + //Find the text in the table + TextSelection selection = table.Find(new Regex("Cell")); + WTextRange text = selection.GetAsOneRange(); + //Get the owner paragraph + WParagraph paragraph = text.OwnerParagraph; + //Get the owner cell + WTableCell cell = paragraph.OwnerTextBody as WTableCell; + //Get the index of the cell + int index = cell.GetCellIndex(); + //Apply text direction to the next cell + WTableRow row = cell.OwnerRow; + row.RowFormat.BackColor = Color.LightGray; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx") + 'Get the table + Dim table As WTable = TryCast(document.Sections(0).Tables(0), WTable) + 'Find the text in the table + Dim selection As TextSelection = table.Find(New Regex("Cell")) + Dim text As WTextRange = selection.GetAsOneRange() + 'Get the owner paragraph + Dim paragraph As WParagraph = text.OwnerParagraph + 'Get the owner cell + Dim cell As WTableCell = TryCast(paragraph.OwnerTextBody, WTableCell) + 'Get the index of the cell + Dim index As Integer = cell.GetCellIndex() + 'Apply text direction to the next cell + Dim row As WTableRow = cell.OwnerRow + row.RowFormat.BackColor = Color.LightGray + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the cell format. Read-only. + + + + + Gets or sets the width(in points) of the cell. + + The float that specifies the cell width. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx"); + //Get the table + WTable table = document.Sections[0].Tables[0] as WTable; + foreach (WTableRow row in table.Rows) + { + foreach (WTableCell cell in row.Cells) + { + cell.Width = 100; + } + } + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx") + 'Get the table + Dim table As WTable = TryCast(document.Sections(0).Tables(0), WTable) + For Each row As WTableRow In table.Rows + For Each cell As WTableCell In row.Cells + cell.Width = 100 + Next + Next + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets the color of the fore. + + The color of the fore. + + + + Gets or sets the texture style. + + The texture style. + + + + + + + + + Gets if size of cell is fixed. + + + + + Gets the old cell format. + + The old cell format. + + + + Gets the preferred width of the cell. + + The preferred cell width. + + + + Gets the cell start position. + + + The cell start position. + + + + + Gets the cell end position. + + + The cell end position. + + + + + Gets the size infor of the cell. + + + + + Gets the body items of the cell. + + + + + + Represents a table row. + + + + + + + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + Creates a duplicate copy of the entity. + + The reference to the newly created row. + + + + Adds a new cell to the row. + + The reference to the newly added cell. + The following example illustrates how to add a cell to the row. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + section.AddParagraph().AppendText("Price Details"); + section.AddParagraph(); + //Add a new table into Word document + IWTable table = section.AddTable(); + //Add the first row into table + WTableRow row = table.AddRow(); + //Add the first cell into first row + WTableCell cell = row.AddCell(); + cell.Width = 100; + cell.AddParagraph().AppendText("Orange"); + //Add the second cell into first row + cell = row.AddCell(); + cell.Width = 100; + cell.AddParagraph().AppendText("$30"); + //Add the second row into table + row = table.AddRow(true, false); + //Add the first cell into second row + cell = row.AddCell(); + cell.Width = 100; + cell.AddParagraph().AppendText("Apple"); + //Add the second cell into second row + cell = row.AddCell(); + cell.Width = 100; + cell.AddParagraph().AppendText("$50"); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + section.AddParagraph().AppendText("Price Details") + section.AddParagraph() + 'Add a new table into Word document + Dim table As IWTable = section.AddTable() + 'Add the first row into table + Dim row As WTableRow = table.AddRow() + 'Add the first cell into first row + Dim cell As WTableCell = row.AddCell() + cell.Width = 100 + cell.AddParagraph().AppendText("Orange") + 'Add the second cell into first row + cell = row.AddCell() + cell.Width = 100 + cell.AddParagraph().AppendText("$30") + 'Add the second row into table + row = table.AddRow(True, False) + 'Add the first cell into second row + cell = row.AddCell() + cell.Width = 100 + cell.AddParagraph().AppendText("Apple") + 'Add the second cell into second row + cell = row.AddCell() + cell.Width = 100 + cell.AddParagraph().AppendText("$50") + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Adds a new cell to the row. + + True if to have format of the previous row; otherwise, false. + The reference to the newly added cell. + The following example illustrates how to add a cell to the row by specifying the copy format option. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + section.AddParagraph().AppendText("Price Details"); + section.AddParagraph(); + //Add a new table into Word document + IWTable table = section.AddTable(); + //Add the first row into table + WTableRow row = table.AddRow(); + //Add the first cell into first row + WTableCell cell = row.AddCell(); + cell.Width = 100; + cell.AddParagraph().AppendText("Orange"); + //Add the second cell into first row + cell = row.AddCell(); + cell.Width = 100; + cell.AddParagraph().AppendText("$30"); + //Add the second row into table + row = table.AddRow(true, false); + //Add the first cell into second row + cell = row.AddCell(); + cell.Width = 50; + cell.AddParagraph().AppendText("Apple"); + //Add the second cell into second row + cell = row.AddCell(true); + cell.AddParagraph().AppendText("$50"); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + section.AddParagraph().AppendText("Price Details") + section.AddParagraph() + 'Add a new table into Word document + Dim table As IWTable = section.AddTable() + 'Add the first row into table + Dim row As WTableRow = table.AddRow() + 'Add the first cell into first row + Dim cell As WTableCell = row.AddCell() + cell.Width = 100 + cell.AddParagraph().AppendText("Orange") + 'Add the second cell into first row + cell = row.AddCell() + cell.Width = 100 + cell.AddParagraph().AppendText("$30") + 'Add the second row into table + row = table.AddRow(True, False) + 'Add the first cell into second row + cell = row.AddCell() + cell.Width = 50 + cell.AddParagraph().AppendText("Apple") + 'Add the second cell into second row + cell = row.AddCell(True) + cell.AddParagraph().AppendText("$50") + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + The number of cells must be between 1 and 63. + + + + Returns the index of the row in the table. + + The zero-based index of the row. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load a template document + WordDocument document = new WordDocument("Template.docx"); + //Get the table + WTable table = document.Sections[0].Tables[0] as WTable; + //Find the text in the table + TextSelection selection = table.Find(new Regex("Cell")); + WTextRange text = selection.GetAsOneRange(); + //Get the owner paragraph + WParagraph paragraph = text.OwnerParagraph; + //Get the owner cell + WTableCell cell = paragraph.OwnerTextBody as WTableCell; + //Get the row index. + int index = cell.OwnerRow.GetRowIndex(); + //Set height for next row + table.Rows[index + 1].Height = 20; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load a template document + Dim document As New WordDocument("Template.docx") + 'Get the table + Dim table As WTable = TryCast(document.Sections(0).Tables(0), WTable) + 'Find the text in the table + Dim selection As TextSelection = table.Find(New Regex("Cell")) + Dim text As WTextRange = selection.GetAsOneRange() + 'Get the owner paragraph + Dim paragraph As WParagraph = text.OwnerParagraph + 'Get the owner cell + Dim cell As WTableCell = TryCast(paragraph.OwnerTextBody, WTableCell) + 'Get the row index. + Dim index As Integer = cell.OwnerRow.GetRowIndex() + 'Set height for next row + table.Rows(index + 1).Height = 20 + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Determines whether the width and preferred width of a cell is zero. + + True if cell width and preferred width is zero; Otherwise false. + + + + Updates the cell width by equally partitioning available width among all the cells in a row. + + The available width for table. + + + + Updates the preferred cell width to undefined table cells. + + + + + + Adds the self. + + + + + Creates a duplicate copy of the entity. + + + An that can be casted as . + + + + Clones the relations for TableRow. + + + + + + Checks the format owner. + + + + + Called when cells are inserted. + + The index. + The cell format. + + + + Called when cells are removed. + + The index. + + + + Gets the width to resize cells. + + The row. + Width of the client. + + + + + Gets the grid before after. + + The width info. + Width of the client. + + + + + Gets the width of the row. + + + + + + Gets the preferred width of the cells in the row. + + + + + + Gets the preferred width of the row. + + Width of the table. + + + + + Check whether all cell in the row has only point or percent as preferred width type + + True if all cell in the row has only point or percent as preferred width type + else False + + + + Gets the preferred width of the row. + + Width of the table. + + + + + Updates track changes revision of table row while adding the entity. + + + + + + Closes this instance. + + + + + Gets the complete text of table row for word comparison + + + + + + To get the matched rows from the given table collection + + + + + + + + + + Registers child objects in XDSL holder. + + + + + + Writes object data as inside xml element. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + The value indicating the presence of xml content. + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Creates layout information. + + + + + + Determines whether need to skip ParaMark from cell height calculation + + The paragraph. + + + + + Get First Paragraph of the Row + + + + + + Initializing LayoutInfo value to null + + + + + Gets the child elements of the row. Read-only + + The collection of child elements. + + + + Gets the type of the entity. + + The of the current item. + + + + Gets or sets the collection of cells in the row. + + The that represents the cells in the row. + + + + + + Gets or sets the type of the table row height. + + The member that specifies the type of row height. + + + + + Gets the row format. Read-only. + + + + + + Gets or sets height of the row(in points). + + The float that specifies the row height. + The following example illustrates how to set the height of the row in the table. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + //Add a new table into Word document + IWTable table = section.AddTable(); + //Set number of rows and columns + table.ResetCells(2, 2); + //Set row height and type. + table.Rows[1].Height = 20; + table.Rows[1].HeightType = TableRowHeightType.AtLeast; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + 'Add a new table into Word document + Dim table As IWTable = section.AddTable() + 'Set number of rows and columns + table.ResetCells(2, 2) + 'Set row height and type. + table.Rows(1).Height = 20 + table.Rows(1).HeightType = TableRowHeightType.AtLeast + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets a value indicating whether the row is a table header. + + True if the row is header row; otherwise, false. + + + + Gets the owner table. + + The owner table. + + + + Gets or sets the data array. + + The data array. + + + + Gets the character format. + + The character format. + + + + Gets the old row format. + + The old row format. + + + + Gets or sets a value indicating whether this instance is delete revision. + + + if this instance is delete revision, set to true. + + + + + Gets or sets a value indicating whether this instance is insert revision. + + + if this instance is insert revision, set to true. + + + + + Gets or sets a value indicating whether this instance has TblPrEx. + + + + + Gets/Sets the row content control in this row. + + The following code illustrates how to set a Row content control to table. + + WordDocument document = new WordDocument(); + //Adds new section to the document. + IWSection section = document.AddSection(); + //Adds new table to the section. + IWTable table = section.AddTable(); + //Adds new row to the table. + WTableRow tableRow = table.AddRow(); + //Adds new cell to the row. + WTableCell tableCell = tableRow.AddCell(); + tableCell.Width = 100; + //Adds new paragraph to the cell. + IWParagraph paragraph = tableCell.AddParagraph(); + //Adds new text to the paragraph. + paragraph.AppendText("Content Control"); + //Create the Row Content Control for the document. + RowContentControl control = new RowContentControl(document); + //Change the color value in Content Control properties. + control.ContentControlProperties.Color = System.Drawing.Color.Blue; + // Sets it to the row content control. + tableRow.ContentControl = control; + //Save the Word document. + document.Save("Sample.docx", FormatType.Docx); + //Close the document. + document.Close(); + + + Dim document As New WordDocument() + 'Adds new section to the document. + Dim section As IWSection = document.AddSection() + 'Adds new table to the section. + Dim table As IWTable = section.AddTable() + 'Adds new row to the table. + Dim tableRow As WTableRow = table.AddRow() + 'Adds new cell to the row. + Dim tableCell As WTableCell = tableRow.AddCell() + tableCell.Width = 100 + 'Adds new paragraph to the cell. + Dim paragraph As IWParagraph = tableCell.AddParagraph() + 'Adds new text to the paragraph. + paragraph.AppendText("Content Control") + 'Create the Row Content Control for the document. + Dim control As New RowContentControl(document) + 'Change the color value in Content Control properties. + control.ContentControlProperties.Color = System.Drawing.Color.Blue + ' Sets it to the row content control. + tableRow.ContentControl = control + 'Save the Word document. + document.Save("Sample.docx", FormatType.Docx) + 'Close the document. + document.Close() + + + + + + Get's whether the first paragraph of the row is having KeepWithNext property set + + + + + Represents the document saving options. + + + The following code snippet shows how to customize Word to HTML conversion using . + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Loads an existing document + WordDocument document = new WordDocument("Template.docx"); + HTMLExport export = new HTMLExport(); + //The images in the input document will be copied to this folder + document.SaveOptions.HtmlExportImagesFolder = @"D:\Data\"; + //The headers and footers in the input will be exported + document.SaveOptions.HtmlExportHeadersFooters = true; + //Export the text form fields as editable + document.SaveOptions.HtmlExportTextInputFormFieldAsText = false; + //Set the style sheet type + document.SaveOptions.HtmlExportCssStyleSheetType = CssStyleSheetType.External; + //Set name for style sheet + document.SaveOptions.HtmlExportCssStyleSheetFileName = "UserDefinedFileName.css"; + //Save the document as html file + export.SaveAsXhtml(document, "WordtoHtml.html"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Loads an existing document + Dim document As New WordDocument("Template.docx") + Dim export As New HTMLExport() + 'The images in the input document will be copied to this folder + document.SaveOptions.HtmlExportImagesFolder = "D:\Data\" + 'The headers and footers in the input will be exported + document.SaveOptions.HtmlExportHeadersFooters = True + 'Export the text form fields as editable + document.SaveOptions.HtmlExportTextInputFormFieldAsText = False + 'Set the style sheet type + document.SaveOptions.HtmlExportCssStyleSheetType = CssStyleSheetType.External + 'Set name for style sheet + document.SaveOptions.HtmlExportCssStyleSheetFileName = "UserDefinedFileName.css" + 'Save the document as html file + export.SaveAsXhtml(document, "WordtoHtml.html") + document.Close() + End Sub + + + The following code snippet shows how to customize Word to EPub file conversion using . + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Export the fonts used in the document + document.SaveOptions.EPubExportFont = true; + //Export header and footer + document.SaveOptions.HtmlExportHeadersFooters = true; + //Save the document as EPub file + document.Save("WordToEPub.epub", FormatType.EPub); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Export the fonts used in the document + document.SaveOptions.EPubExportFont = True + 'Export header and footer + document.SaveOptions.HtmlExportHeadersFooters = True + 'Save the document as EPub file + document.Save("WordToEPub.epub", FormatType.EPub) + 'Close the document + document.Close() + End Sub + + + The following code snippet shows how to preserve compatibility mode as in the input Word document using . + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing document + WordDocument document = new WordDocument("Template.doc", FormatType.Doc); + //Preserve compatibility mode as in the input Word document + document.SaveOptions.MaintainCompatibilityMode = true; + //Save the document as Docx file + document.Save("Result.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing document + Dim document As New WordDocument("Template.doc", FormatType.Doc) + 'Export the fonts used in the document + document.SaveOptions.EPubExportFont = True + 'Preserve compatibility mode as in the input Word document + document.SaveOptions.MaintainCompatibilityMode = True + 'Save the document as Docx file + document.Save("Result.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Execute Image node visited event + + + + + + + + Closes this instance. + + + + + Ensures the images folder. + + + + + Processes the image using . + + The img path. + The image bytes. + + + + Gets the name of the image file. + + + + + + Gets image format + + + + + + + Gets of sets the font file references + + + + + Gets or sets the physical folder to save the images when exporting a Word document to Markdown format. By default, it is empty. + + The string that specifies the physical folder to save the image. + + This property is only applicable while exporting the Word document as Markdown file. + This property is not applicable for .NET MAUI, Xamarin and UWP. + + + Given physical folder not accessible to export the images. Enable permission if access is denied. + + + Open the document + WordDocument document = new WordDocument("Sample.docx"); + Set the folder location to export the images + document.SaveOptions.MarkdownExportImagesFolder = @"D:/WordToMarkdownConversion/"; + Save as Markdown document + document.Save("Result.md", FormatType.Markdown); + Close the document + document.Close(); + + + //'Opens the document. + Dim document As WordDocument = New WordDocument("Sample.docx"); + Set the folder location to export the images + document.SaveOptions.MarkdownExportImagesFolder = @"D:/WordToMarkdownConversion/"; + Save as Markdown document + document.Save("Result.md", FormatType.Markdown); + Close the document + document.Close(); + + + + + Gets or sets a value indicating whether the font should be embedded in EPub. + + True if the font should be embedded in EPub; otherwise, false. + This property is not supported in UWP, MVC6 and Xamarin application. + + + + Gets or sets number of heading levels for EPub format + + + + + Gets or sets the type of the HTML export CSS style sheet. + + The member that specifies + the type of the HTML export CSS style sheet. + This property is only applicable while exporting the Word document as HTML file. + + + + Gets or sets the name of the HTML export CSS style sheet file. + + The string that specifies the HTML export CSS style sheet file name. + This property is not supported in MVC6 and Xamarin application. + This property is only applicable while exporting the Word document as HTML file. + + + + Gets or sets the HTML export images folder for extracing the images in the document. + + The string that specifies the name of the images folder. + This property will be considered in HTML exporting if HTMLExportImageAsBase64 property is false.This property is not supported in MVC6 and Xamarin application. + This property is only applicable while exporting the Word document as HTML file. + + + + Gets or sets a value indicating whether to include headers and footers while exporting HTML file. + + True if to include headers and footers; otherwise false. + + The header and footer contents in the first page of the document will + be exported as first and last content of the exported HTML file. + + + + Gets or sets a value indicating whether to reduce the resultant RTF file size by removing the tags with default values. + + True The resultant rtf file size is reduced false. + The default value is false + The following code snippet shows how to enable the OptimisedRtfFileSize property. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing document + WordDocument document = new WordDocument("Template.rtf", FormatType.Rtf); + //Sets the OptmizedRtfFileSize property as true + document.SaveOptions.OptimizeRtfFileSize = true; + //Save the document as Docx file + document.Save("Result.rtf", FormatType.Rtf); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing document + Dim document As New WordDocument("Template.rtf", FormatType.Rtf) + 'Sets the OptmizedRtfFileSize property as true + document.SaveOptions.OptimizeRtfFileSize = True + 'Save the document as Docx file + document.Save("Result.rtf", FormatType.Rtf) + 'Close the document + document.Close() + End Sub + + + + + + Gets or sets value indicating whether the paragraph contextual spacing should be consider in HTML export. + + This property is not supported in UNIVERSAL,UWP,WP and Xamarin application. + + + + Gets or sets a value indicating whether to export text input form field as text. + + True if HTML export text input form field as text; otherwise, false. + + By default, the text form fields are preserved as editable fields while exporting the HTML file. + This property is only applicable while exporting the Word document as HTML file. + + + + + Gets or sets value indicating whether to omit XML declaration in the exported HTML file. + + + True if Omit XML declaration in the exported HTML file; + false otherwise. Default value is false. + + + + + Gets or sets a value indicating whether to preserve compatibility mode as in the input Word document. + + + True if to have the compatibility mode as preserved in the input document; + false if to have the compatibility mode based on the save format type. + + + + + Gets or sets a value indicating whether the HTML document should be exported with the same rendering as the Word document. + Default value is True. + + + True to preserve the HTML contents equivalent to the Word document; + false otherwise. + + This property is only applicable while exporting the Word document as a HTML file. + + + //Opens an existing Word document + WordDocument document = new WordDocument("Input.docx"); + //Disables a flag to export HTML without WordCompatiblity + document.SaveOptions.HTMLExportWithWordCompatiblity = false; + //Saves the document + document.Save("Output.html", FormatType.Html); + //Closes the document + document.Close(); + + + 'Opens an existing Word document + Dim document As WordDocument = New WordDocument("Input.docx") + 'Disables a flag to export HTML without WordCompatiblity + document.SaveOptions.HTMLExportWithWordCompatiblity = False + 'Saves the document + document.Save("Output.html", FormatType.Html) + 'Close the document + document.Close() + + + + + + + Gets a value indicating whether Image node visited event has been subscribed or not. + + + True if the Image node visited event has been subscribed; otherwise, false. + + + + + + Specifies the Css style sheet type. + + + + + CSS styles are specified in a separate file with .css extension. + + + + + CSS styles are specified inline. + + + + + CSS styles are specified in the style tag. + + + + + Specifies the track changes revision options for Word to PDF conversion + + + + + Sets the balloons and other options based on revision type. + + + + + Gets or sets a value that indicates whether to preserve Word document Comments in converted PDF document or not.Default value isCommentDisplayMode.Hide. + + + The following code example demonstrates how to set the to preserve Comments in Word to PDF Conversion. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Sets ShowInBalloons to render a document comments in converted PDF document. + wordDocument.RevisionOptions.CommentDisplayMode = CommentDisplayMode.ShowInBalloons; + //Instantiation of DocToPDFConverter for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases all resources used by the object + converter.Dispose(); + //Closes the instance of document objects + wordDocument.Close(); + pdfDocument.Close(true); + + + 'Loads an existing Word document + Dim wordDocument As WordDocument = New WordDocument("Template.docx", FormatType.Docx) + 'Sets ShowInBalloons to render a document comments in converted PDF document. + wordDocument.RevisionOptions.CommentDisplayMode = CommentDisplayMode.ShowInBalloons + 'Instantiation of DocToPDFConverter for Word to PDF conversion + Dim converter As DocToPDFConverter = New DocToPDFConverter + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Releases all resources used by the object + converter.Dispose() + 'Closes the instance of document objects + wordDocument.Close() + pdfDocument.Close(True) + + + + + + Gets or sets the color to be used for Comment. Default value is RevisionColor.Red. + + For now, Red color will be used if this property values specified as ByAuthor or Auto. + + The following code example demonstrates how to set the to preserve Comments color in Word to PDF Conversion. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Sets ShowInBalloons to render a document comments in converted PDF document. + wordDocument.RevisionOptions.CommentDisplayMode = CommentDisplayMode.ShowInBalloons; + //Sets the color to be used for Comment Balloon. + wordDocument.RevisionOptions.CommentColor = RevisionColor.Pink; + //Instantiation of DocToPDFConverter for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases all resources used by the object + converter.Dispose(); + //Closes the instance of document objects + wordDocument.Close(); + pdfDocument.Close(true); + + + 'Loads an existing Word document + Dim wordDocument As WordDocument = New WordDocument("Template.docx", FormatType.Docx) + 'Sets ShowInBalloons to render a document comments in converted PDF document. + wordDocument.RevisionOptions.CommentDisplayMode = CommentDisplayMode.ShowInBalloons + 'Sets the color to be used for Comment Balloon. + wordDocument.RevisionOptions.CommentColor = RevisionColor.Pink + 'Instantiation of DocToPDFConverter for Word to PDF conversion + Dim converter As DocToPDFConverter = New DocToPDFConverter + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Releases all resources used by the object + converter.Dispose() + 'Closes the instance of document objects + wordDocument.Close() + pdfDocument.Close(True) + + + + + + Gets or sets a value indicating whether to show the revision lines for the changes made in the document. + + + + + Gets or sets a value indicating whether to show the revisions (content changes) made. + + + + + Gets or sets the color to be used for revision bars that identify document lines containing revised information. Default value is RevisionColor.Red. + + For now, Red color will be used if this property values specified as ByAuthor or Auto. + + The following code example demonstrates how to set the to preserve Revision mark color in Word to PDF Conversion. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Sets revision types to preserve track changes in PDF conversion. + wordDocument.RevisionOptions.ShowMarkup = RevisionType.Insertions | RevisionType.Formatting | RevisionType.Deletions; + //Sets the color for Revision mark color. + wordDocument.RevisionOptions.RevisionBarsColor = RevisionColor.Pink; + //Instantiation of DocToPDFConverter for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases all resources used by the object + converter.Dispose(); + //Closes the instance of document objects + wordDocument.Close(); + pdfDocument.Close(true); + + + 'Loads an existing Word document + Dim wordDocument As WordDocument = New WordDocument("Template.docx", FormatType.Docx) + 'Sets revision types to preserve track changes in PDF conversion. + wordDocument.RevisionOptions.ShowMarkup = RevisionType.Insertions Or RevisionType.Formatting Or RevisionType.Deletions + 'Sets the color for Revision mark color. + wordDocument.RevisionOptions.RevisionBarsColor = RevisionColor.Pink + 'Instantiation of DocToPDFConverter for Word to PDF conversion + Dim converter As DocToPDFConverter = New DocToPDFConverter + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Releases all resources used by the object + converter.Dispose() + 'Closes the instance of document objects + wordDocument.Close() + pdfDocument.Close(True) + + + + + + Gets or sets the color to be used for inserted content . Default value is RevisionColor.ByAuthor. + + For now, Blue color will be used if this property values specified as ByAuthor or Auto. + + The following code example demonstrates how to set the to preserve inserted text color in Word to PDF Conversion. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Sets revision types to preserve track changes in PDF conversion. + wordDocument.RevisionOptions.ShowMarkup = RevisionType.Insertions | RevisionType.Formatting | RevisionType.Deletions; + //Sets the color for inserted text color. + wordDocument.RevisionOptions.InsertedTextColor = RevisionColor.ClassicRed; + //Instantiation of DocToPDFConverter for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases all resources used by the object + converter.Dispose(); + //Closes the instance of document objects + wordDocument.Close(); + pdfDocument.Close(true); + + + 'Loads an existing Word document + Dim wordDocument As WordDocument = New WordDocument("Template.docx", FormatType.Docx) + 'Sets revision types to preserve track changes in PDF conversion. + wordDocument.RevisionOptions.ShowMarkup = RevisionType.Insertions Or RevisionType.Formatting Or RevisionType.Deletions + 'Sets the color for inserted text color. + wordDocument.RevisionOptions.InsertedTextColor = RevisionColor.ClassicRed + 'Instantiation of DocToPDFConverter for Word to PDF conversion + Dim converter As DocToPDFConverter = New DocToPDFConverter + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Releases all resources used by the object + converter.Dispose() + 'Closes the instance of document objects + wordDocument.Close() + pdfDocument.Close(True) + + + + + + Gets or sets the width of the revised lines in the document + + + + + Gets or sets the text effect for the inserted text. + + + + + Gets or sets the color to be used for deleted content . Default value is RevisionColor.ByAuthor. + + For now, Red color will be used if this property values specified as ByAuthor or Auto. + + The following code example demonstrates how to set the to preserve Deleted content color in Word to PDF Conversion. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Sets revision types to preserve track changes in PDF conversion. + wordDocument.RevisionOptions.ShowMarkup = RevisionType.Insertions | RevisionType.Formatting | RevisionType.Deletions; + //Sets the color for Deleted content color. + wordDocument.RevisionOptions.DeletedTextColor = RevisionColor.ClassicBlue; + //Instantiation of DocToPDFConverter for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases all resources used by the object + converter.Dispose(); + //Closes the instance of document objects + wordDocument.Close(); + pdfDocument.Close(true); + + + 'Loads an existing Word document + Dim wordDocument As WordDocument = New WordDocument("Template.docx", FormatType.Docx) + 'Sets revision types to preserve track changes in PDF conversion. + wordDocument.RevisionOptions.ShowMarkup = RevisionType.Insertions Or RevisionType.Formatting Or RevisionType.Deletions + 'Sets the color for Deleted content color. + wordDocument.RevisionOptions.DeletedTextColor = RevisionColor.ClassicBlue + 'Instantiation of DocToPDFConverter for Word to PDF conversion + Dim converter As DocToPDFConverter = New DocToPDFConverter + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Releases all resources used by the object + converter.Dispose() + 'Closes the instance of document objects + wordDocument.Close() + pdfDocument.Close(True) + + + + + + Gets or sets the text effect for the deleted content + + + + + Gets or sets the color to be used for content with changes of formatting properties . Default value is RevisionColor.ByAuthor. + + For now, Red color will be used if this property values specified as ByAuthor or Auto. + + The following code example demonstrates how to set the to preserve track changes color in Word to PDF Conversion. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Sets revision types to preserve track changes in PDF conversion. + wordDocument.RevisionOptions.ShowMarkup = RevisionType.Insertions | RevisionType.Formatting | RevisionType.Deletions; + //Sets the color for Revised property color. + wordDocument.RevisionOptions.RevisedPropertiesColor = RevisionColor.Turquoise; + //Instantiation of DocToPDFConverter for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases all resources used by the object + converter.Dispose(); + //Closes the instance of document objects + wordDocument.Close(); + pdfDocument.Close(true); + + + 'Loads an existing Word document + Dim wordDocument As WordDocument = New WordDocument("Template.docx", FormatType.Docx) + 'Sets revision types to preserve track changes in PDF conversion. + wordDocument.RevisionOptions.ShowMarkup = RevisionType.Insertions Or RevisionType.Formatting Or RevisionType.Deletions + 'Sets the color for Revised property color. + wordDocument.RevisionOptions.RevisedPropertiesColor = RevisionColor.Turquoise + 'Instantiation of DocToPDFConverter for Word to PDF conversion + Dim converter As DocToPDFConverter = New DocToPDFConverter + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Releases all resources used by the object + converter.Dispose() + 'Closes the instance of document objects + wordDocument.Close() + pdfDocument.Close(True) + + + + + + Gets or sets the text effect for the formatting changes in the document. + + + + + Gets or sets the value indicating whether to show the deleted text. + + + + + Gets or sets the revision type to render in PDF. + + + The following code example demonstrates how to set the to preserve track changes in Word to PDF Conversion. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Sets revision types to preserve track changes in PDF conversion. + wordDocument.RevisionOptions.ShowMarkup = RevisionType.Insertions | RevisionType.Formatting | RevisionType.Deletions; + //Instantiation of DocToPDFConverter for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases all resources used by the object + converter.Dispose(); + //Closes the instance of document objects + wordDocument.Close(); + pdfDocument.Close(true); + + + 'Loads an existing Word document + Dim wordDocument As WordDocument = New WordDocument("Template.docx", FormatType.Docx) + 'Sets revision types to preserve track changes in PDF conversion. + wordDocument.RevisionOptions.ShowMarkup = RevisionType.Insertions Or RevisionType.Formatting Or RevisionType.Deletions + 'Instantiation of DocToPDFConverter for Word to PDF conversion + Dim converter As DocToPDFConverter = New DocToPDFConverter + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Releases all resources used by the object + converter.Dispose() + 'Closes the instance of document objects + wordDocument.Close() + pdfDocument.Close(True) + + + + + + Gets or sets the revision types to be displayed in balloons when converting Word documents to PDF. Default value is RevisionType.Deletions | RevisionType.Formatting. + + For now, only RevisionType.None and RevisionType.Deletions | RevisionType.Formatting are supported. + + The following code example demonstrates how to set the to hide balloons in Word to PDF Conversion. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Sets revision types to preserve track changes in PDF conversion. + wordDocument.RevisionOptions.ShowMarkup = RevisionType.Insertions | RevisionType.Formatting | RevisionType.Deletions; + //Hides showing revisions in balloons when converting Word documents to PDF + wordDocument.RevisionOptions.ShowInBalloons = RevisionType.None; + //Instantiation of DocToPDFConverter for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases all resources used by the object + converter.Dispose(); + //Closes the instance of document objects + wordDocument.Close(); + pdfDocument.Close(true); + + + 'Loads an existing Word document + Dim wordDocument As WordDocument = New WordDocument("Template.docx", FormatType.Docx) + 'Sets revision types to preserve track changes in PDF conversion. + wordDocument.RevisionOptions.ShowMarkup = RevisionType.Insertions Or RevisionType.Formatting Or RevisionType.Deletions + 'Hides showing revisions in balloons when converting Word documents to PDF + wordDocument.RevisionOptions.ShowInBalloons = RevisionType.None + 'Instantiation of DocToPDFConverter for Word to PDF conversion + Dim converter As DocToPDFConverter = New DocToPDFConverter + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Releases all resources used by the object + converter.Dispose() + 'Closes the instance of document objects + wordDocument.Close() + pdfDocument.Close(True) + + + + + + Gets or sets the options in track changes balloons to render in PDF. + + + + + Represents general exception in DLS library. + + + + + Default exception message. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with specified inner exception. + + The inner exception that occurs during execution. + + + + Initializes a new instance of the class. + + The string that represents the exception message. + + + + Initializes a new instance of the class with specified exception message and inner exception. + + The string that represents the exception message. + The inner exception that occurs during execution. + + + + Represents the Html Converter Register Exception. + + + + + Default exception message. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The inner exc. + + + + Initializes a new instance of the class. + + The message. + + + + Initializes a new instance of the class. + + The message. + The inner exc. + + + + Represents exception during xml serialization. + + + + + Default exception message. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The inner exc. + + + + Initializes a new instance of the class. + + The message. + + + + Initializes a new instance of the class. + + The message. + The inner exc. + + + + Represents the font settings in the Word document. + + + + + Gets the font based on given font details. + + Name of the font. + Size of the font. + Style of the font. + The created font, or substituted font by event. + + + + Gets a font style value to generate a fontStream collection key. + + Font style + Returns the font style + + + + Creates font based on given font details. + + Name of the font. + Size of the font. + Style of the font. + The created font. + + + + Close the FontSettings field instances. + + + + + Occurs during Word to PDF/Image conversion to substitute the alternate fonts when a specified font is not installed in the production environment. + + This event is supported for Word to PDF/Image conversion alone. + + + + Gets a fallback font collection of Word document. + + + + + Represents the method that handles substitute font event. + + + + + Represents the substitute font event that occurs during Word to PDF/Image conversion to substitute the alternate fonts when a specified font is not installed in the production environment. + + + + + Represents the original font name. + + + + + Represents the substitute font name. + + + + + Represents the substitute font name. + + + + + Represents the original fontstyle. + + + + + Initializes a new instance of class for the specified document + with original (missing) font name, and alternate font name. + + Name of the original (missing) font name. + Name of the alternate font name. + Style of the original font. + + + + Gets the original font name. Read Only. + + The string that specifies the original font name. + + + + Gets the original font name. Read Only. + + The string that specifies the original font name. + + + + Gets or sets the alternate font name. + + The string that specifies the alternate font name. + + + + + + Represents the border formatting options for Word document contents. + + + + + Variable used to hold the ColorKey. + + + + + Variable used to hold the BorderTypeKey. + + + + + Variable used to hold the LineWidthKey. + + + + + Variable used to hold the SpaceKey. + + + + + + Variable used to hold the ShadowKey. + + + + + + Variable used to hold the HasNoneStyleKey. + + + + + + Indicate border position + + + + + Document is presently read + + + + + Initializes a new instance of the class with the specified + and key. + + The object that represents the base formatting options. + The integer that specifies the base key. + + + + Determines whether [is skip border] [the specified value1]. + + The value1. + The value2. + if set to true [is first read]. + + + + + Clones the Border formatting. + + + + + + Update table calls border + + + + + Gets the line weight. + + + + + + Gets the line number. + + + + + + Gets the style priority. + + + + + + Gets the border line array. + + Type of the border. + Width of the line. + + + + + Update table cell borders + + Table + Row index + Cell index + + + + Update table row borders + + Table + Row index + + + + Set the style of the border + + + + + + Sets the default properties. + + + + + Compares the border properties. + + + + + Gets the border text for Word comparison + + + + + + Initializes the Border style. + + The for the border. + The float that specifies width of the line. + The member that specifies the style for border. + True if shadow should be drawn, otherwise false. + + + + Returns the default values. + + + The integer that specifies the key. + An object that specifies the default value. + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Registers child objects in XDSL holder. + + + + + + Occurs on format change. + + + The object. + The integer that represents the property key. + + + + Apply base style + + + + + + Updates the source formatting. + + The border. + + + + Document is presently read + + + + + Gets or sets a value indicating the opening of HTML + + + + + Get/set border position value + + + + + Gets or sets the color for border. + + The for border. + + + + Gets or sets the width of the border measured in points. + + The float that represents the width of the border. + + + + Gets or sets style of the border. + + The member that specifies the style for border. + + + + Gets or sets the width(in points) of space to maintain between border and text within border. + + The float that specifies the width of the space measured in points. + + + + Gets or sets a value indicating whether the border should be drawn with shadow. + + True if shadow should be drawn; otherwise, false. + + + + + + + + + Gets a value indicating whether border is defined. + + + true if border is defined; otherwise, false. + + + + + Specifies the border position. + + + + + Left border + + + + + Top border + + + + + Right border + + + + + Bottom border + + + + + Vertical border + + + + + Horizontal border + + + + + Diagonal Down border + + + + + Diagonal Up border + + + + + Represents the collection of that includes top, bottom, right and left borders. + + + + + Constant value for left key. + + + + + Constant value for top key. + + + + + Constant value for bottom key. + + + + + Constant value for right key. + + + + + constant value for vertical key. + + + + + constant value for horizontal key. + + + + + constant value for diagonal down key. + + + + + constant value for diagonal up key. + + + + + Current table cell + + + + + Current table row + + + + + Initializing constructor. + + The parent. + The base key. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The . + + + + Ensures the composites. + + + + + Returns the default values. + + + The integer that specifies the key. + An object that specifies the default value. + The key is invalid. + + + + Gets the composite values. + + + The integer that specifies the key. + The object. + + + + Registers child objects in XDSL holder. + + + + + + Creates duplicate copy of the entity. + + The reference to the newly created . + + + + Creates duplicate copy of the entity. + + + An object that can be casted as . + + + + Occurs on format change. + + + The object. + The integer that represents the property key. + + + + Apply base style + + + + + + Sets the default properties. + + + + + Sets spacing for all + + + + + + Check if adjacent paragraph bottom borders are same + + Currentaragraph + The bounds. + + + + + Init borders owner + + + + + Closes this instance. + + + + + Updates the source formatting. + + The borders. + + + + Compare Borders + + + + + Gets a value indicating whether the border exists. Read-only. + + True if there is no border; otherwise, false. + + + + Gets a value indicating whether the tablecell border exists. Read-only. + + + + + Gets the left border. Read-only. + + The for left. + + + + Gets the top border. Read-only. + + The for top. + + + + Gets the right border. Read-only. + + The for right. + + + + Gets the bottom border. Read-only. + + The for bottom. + + + + Gets the vertical border. Read-only. + + The vertical . + + + + Gets horizontal border. Read-only. + + The horizontal . + + + + Gets diagonal border from top left corner to bottom right corner. + + + + + Gets diagonal border from bottom left corner to top right corner. + + + + + Sets color of the borders. Write-only. + + The for left, right, top and bottom borders. + + + + Sets width of the borders. Write-only. + + The float value specifies the line width for left, right, top and bottom borders. + + + + Sets style of the borders. Write-only. + + The member that specifies the style for left, right, top, bottom, vertical and horizontal borders. + + + + Sets width of space to maintain between borders and text within borders. Write-only. + + The float that specifies the width of the space. + + + + Sets whether borders should be drawn with shadow. Write-only. + + True if shadow should be drawn; otherwise, false. + + + + Gets owner borders cell + + + + + Gets owner borders row + + + + + Gets or sets a value indicating the opening of HTML + + + + + Document is presently read + + + + + Represents the cell formatting options for table cell. + + + The following code example demonstrates how to apply cell formatting options to a + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument(); + document.Open("Table.docx", FormatType.Docx); + WSection section = document.Sections[0]; + WTable table = section.Tables[0] as WTable; + //Access the instance of the first row in the table + WTableRow row = table.Rows[0]; + //Specify the row height + row.Height = 20; + //Specify the row height type + row.HeightType = TableRowHeightType.AtLeast; + //Access the instance of the first cell in the row + WTableCell cell = row.Cells[0]; + //Specify the cell back ground color + cell.CellFormat.BackColor = Color.FromArgb(192, 192, 192); + //Specify the same padding as table option as false to preserve current cell padding + cell.CellFormat.SamePaddingsAsTable = false; + //Specify the left, right, top and bottom padding of the cell + cell.CellFormat.Paddings.Left = 5; + cell.CellFormat.Paddings.Right = 5; + cell.CellFormat.Paddings.Top = 5; + cell.CellFormat.Paddings.Bottom = 5; + //Specify the vertical alignment of content of text + cell.CellFormat.VerticalAlignment = VerticalAlignment.Middle; + //Access the instance of the second cell in the row + cell = row.Cells[1]; + cell.CellFormat.BackColor = Color.FromArgb(192, 192, 192); + cell.CellFormat.SamePaddingsAsTable = false; + //Specify the left, right, top and bottom padding of the cell + cell.CellFormat.Paddings.All = 5; + cell.CellFormat.VerticalAlignment = VerticalAlignment.Middle; + document.Save("TableCellFormatting.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument() + document.Open("Table.docx", FormatType.Docx) + Dim section As WSection = document.Sections(0) + Dim table As WTable = TryCast(section.Tables(0), WTable) + 'Access the instance of the first row in the table + Dim row As WTableRow = table.Rows(0) + 'Specify the row height + row.Height = 20 + 'Specify the row height type + row.HeightType = TableRowHeightType.AtLeast + 'Access the instance of the first cell in the row + Dim cell As WTableCell = row.Cells(0) + 'Specify the cell back ground color + cell.CellFormat.BackColor = Color.FromArgb(192, 192, 192) + 'Specify the same padding as table option as false to preserve current cell padding + cell.CellFormat.SamePaddingsAsTable = False + 'Specify the left, right, top and bottom padding of the cell + cell.CellFormat.Paddings.Left = 5 + cell.CellFormat.Paddings.Right = 5 + cell.CellFormat.Paddings.Top = 5 + cell.CellFormat.Paddings.Bottom = 5 + 'Specify the vertical alignment of content of text + cell.CellFormat.VerticalAlignment = VerticalAlignment.Middle + 'Access the instance of the second cell in the row + cell = row.Cells(1) + cell.CellFormat.BackColor = Color.FromArgb(192, 192, 192) + cell.CellFormat.SamePaddingsAsTable = False + 'Specify the left, right, top and bottom padding of the cell + cell.CellFormat.Paddings.All = 5 + cell.CellFormat.VerticalAlignment = VerticalAlignment.Middle + document.Save("TableCellFormatting.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Gets the property value. + + The property key. + + + + + Sets the property value. + + The property key. + The value. + + + + Gets the owner row format. + + + + + + Gets the index of the owner cell. + + + + + + Determines whether cell has same paddings as table. + + + if it has same paddings as table, set to true. + + + + + Update horizontal merge based on the previous adjacent cells. + + + + + Clears the preferred width properties for Autofit. + + + + + + Closes this instance. + + + + + Determines whether the specified property key has value. + + The property key. + + if the specified property key has value, set to true. + + + + + Apply base style + + + + + + Ensures the composites. + + + + + Returns the default values. + + + The integer specifying the key value of the property. + An object that specifies the default value. + + + + Gets the composite values. + + + The integer that specifies the key. + The object. + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Registers child objects in XDSL holder. + + + + + + Imports the container. + + The object. + + + + Imports the XML properties. + + The object. + + + + Imports the members. + + + The object. + + + + Occurs on format change. + + + The object. + The integer that represents the property key. + + + + Updates the cell format. + + The cell properties. + + + + Applies the parent row format. + + The row format. + + + + Updates the border settings. + + The borders. + + + + Compare one cell format with another and return true if equal else false. + + + + + Gets or sets a value indicating whether [cancel on change]. + + + true if [cancel on change]; otherwise, false. + + + + + Get's / Set's the Hidden property of the cell + + + + + Gets or sets a value indicating whether the cell's format track has changed. + + + + + Gets or sets the preferred width of the cell. + + The preferred width of the cell. + + + + Gets the borders for the cell. + + The that specifies the borders of the cell. + + + + Gets the cell paddings. Read-only. + + The for the cell. + + + + Gets or sets the vertical alignment of the cell content. + + The member that specifies the vertical alignment of cell content. + + + + Gets or sets the background color for cell. + + The for cell background. + + + + Gets or sets the way of combining of the cell vertically. + + The member that specifies the way of vertical merging. + + + + Gets or sets the way of combining of the cell horizontally. + + The member that specifies the way of horizontal merging. + + + + Gets or sets a value indicating whether the text wrapping is set. + + True if it has text wrapping properties; otherwise, false. + + + + Gets or sets fit text option of the cell. + + True if the fit text option is enabled; otherwise, false. + + + + Gets or sets cell text direction. + + The member that specifies the type of text direction. + + + + Gets or sets value indicating whether to use same paddings as the table. + + True if it has same padding values as table; otherwise, false. + + + + + + + + + Gets the index of the current cell in the row. + + The index of the current cell. + + + + Gets or sets the width of the cell. + + The width of the cell. + + + + Gets or sets number of grid columns spanned by the current cell. + + The GridSpan of the cell. + + + + Gets or sets the color of the fore. + + The color of the fore. + + + + Gets or sets the texture style. + + The texture style. + + + + + + + + + Hides the current row + + + + + Represents the overrides for list style. + + + + + Represents the paragraph and character styles. + + + + + Represents the style. + + + + + Remove this style from the Word document. + + + + + Clones the , creating duplicate style. + + The object. + + + + Closes this instance. + + + + + Gets or sets the style name. + + The string that represents the style name. + + + + Gets the type of the style. Read-only. + + The member that specifies the type of the style. + + + + Represents the constant style Id. + + + + + + Represents the object. + + + + + + Represents the object. + + + + + + Represents the string to identify style names + + + + + + Represents the string to identify style names + + + + + + Represents the string to identify styleID names + + + + + + Represents the + + + + + + Represents the byte array. + + + + + + Initializes a new instance of the class with the + specified instance. + + The instance. + + + + Applies the base style for current style. + + The string that represents the style name. + + + + Applies the base style for the current style. + + The member that specifies the built-in style. + + + + Check whether the current style is not present in builtin styles + + True, if the style is not present in Builtin style; else, false + + + + Remove this style from the Word document. + + + + + Clones the , creating duplicate style. + + + + + Set the link style to the current style + + The link style name + + + + Applies base style for current style. + + The base style + + + + + Removes the base style. + + + + + Set the name of the style. + + + + + + Update the m_uniqueNameCollection or m_uniqueIdCollection based on style new name. + + + + + Remove the style from m_uniqueNameCollection in document styles. + + True if style removed from m_uniqueNameCollection in document styles else false + + + + Update the m_uniqueNameCollection or m_uniqueIdCollection based on style new name. + + + + + Remove the style from m_uniqueNameCollection in document styles. + + True if style removed from m_uniqueNameCollection in document styles else false + + + + Clones style, creates duplicate copy of the style. + + + The cloned element + + + + Clones the relations. + + The doc. + + + + Determines whether the style has Guid + + Style + guid + + Returns true, if style name contains Guid. + + + + + Compares the properties of current style with specified style. + + + + + Imports the style to destination document. + + The doc. + + + + Compare style with document style collection + + + + + Creates a cloned copy of the style and adds to the destination document. + + The document + The cloned Styles Holder + + + + + + Copy the base style formattings to current paragraph style. + + Destination Word document. + Cloned paragraph style + + + + Gets the unique style name. + + Current style name. + Collection of existing style names. + Unique style name. + + + + Gets style name Id. + + + + + + Creates the built-in paragraph style. + + The member that specifies the built-in style. + The object. + The object. + + + + Creates the built-in character style. + + The member that specifies the built-in style. + The object. + The object. + + + + Creates the built-in table style. + + The built in style. + The document. + + + + + Creates the built-in style. + + The member that specifies the built-in style. + The member that specifies the type of the style. + The object. + The object. + + + + Built into name. + + The built in style. + + + + + Built into name. + + The built in style. + + + + + Converts the style names to BuiltinStyle. + + The string represents the name of the style. + The member that represents built-in style. + + + + Determines whether is list style the specified built in style. + + The built in style. + + true if it specifies list style, set to true. + + + + + Closes this instance. + + + + + Loads Builtin styles to dictionary + + + + + Loads the builtin style ids. + + + + + Compares the properties of current style with the specified one for document comparison + + + + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Registers child objects in XDSL holder. + + + + + + Restores object references after deserialization + + + The string that represents the name. + The zero-based integer that represents the index. + + + + Represents the table style data (.doc format) + + This property is specific for .doc format + + + + Gets or sets the type code of the style. + + + This property is specific for .doc format + + + + Gets the character format. Read-only. + + The object that specifies the character format for the current style. + + + + Gets or sets the style name. + + The string that represents the style name. + + + + Gets the base style. + + The base style. + + + + Gets or sets the style id. + + The style id. + + + + Gets the type of the style. Read-only. + + The member that specifies the type of the style. + + + + Gets the style as built-in Word style. + + The member that specifies built-in style. + + + + Gets or sets the next style. + + The next style. + + + + Gets or sets the link style name. + Reserved for editor controls (Document Editor, SfRichTextBoxAdv) + + The link style. + + + + Gets or sets the name of the style that is linked to this style. + The default value is null. + + The string that represents the style name. + Character styles can be linked to paragraph and table styles and vice versa. However, you cannot link paragraph style with the table style. + + + Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + Gets the style from document styles collection + Style style = document.Styles.FindByName("ParaStyle") as Style; + Link the styles + style.LinkedStyleName = "CharStyle"; + Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Load an existing Word document into DocIO instance + Dim document As WordDocument = New WordDocument("Template.docx") + 'Gets the style from document styles collection + Dim style As Style = TryCast(document.Styles.FindByName("ParaStyle"), Style) + 'Link the styles + style.LinkedStyleName = "CharStyle" + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets or sets the styleID Name. + + The styleID Name. + + + + Gets or sets a value indicating whether the current instance is primary style. + + True if the instance is primary style, otherwise false. + + + + Gets or sets a value indicating whether this instance is semi hidden. + + + if this instance is semi hidden, set to true. + + + + + Gets or sets a value indicating whether to unhide when used. + + if unhide when used, set to true. + + + + Gets or sets a value indicating whether this instance is custom. + + if this instance is custom, set to true. + + + + Gets or sets a value indicating whether this instance is default. + + if this instance is default, set to true. + + + + Gets or sets a value indicating whether this instance is ui priority. + Default value is int.minValue. + + + + + Collection of elemments(paragraph or paragraph items) which is linked with this style. + + + + + Represents the built-in styles. + + + + + + + + + + Contains the built-in style names. + + + + + Built-in table style names. + + + + + Loads the style. + + The style. + The b style. + + + + Loads the style. + + The style. + The b style. + + + + Loads the table style Normal Table. + + The style. + + + + Loads the table style Table Grid. + + The style. + + + + Loads the table style Light Shading. + + The style. + The text Color. + The border Color. + The back Color. + + + + Loads the table style Light List. + + The style. + The border Color. + The back Color. + + + + Loads the table style Light Grid. + + The style. + The border Color. + The back Color. + + + + Loads the table style Medium Shading 1. + + The style. + The border Color. + The first Row Back Color. + The back Color. + + + + Loads the table style Medium Shading 2. + + The style. + The back Color. + + + + Loads the table style Medium List 1. + + The style. + The border Color. + The back Color. + + + + Loads the table style Medium List 2. + + The style. + The border Color. + The back Color. + + + + Loads the table style Medium Grid 1. + + The style. + The border Color. + The back Color. + The band Cell Color. + + + + Loads the table style Medium Grid 2. + + The style. + The border Color. + The back Color. + The first Row Color. + The last Column Color. + The band Cell Color. + + + + Loads the table style Medium Grid 3. + + The style. + The back Color. + The first Row Color. + The band Cell Color. + + + + Loads the table style Dark List. + + The style. + The back Color. + The last Row Color. + The band Cell Color. + + + + Loads the table style Colorful Shading. + + The style. + The top Border Color. + The border Color. + The back Color. + The last Row Color. + The band Column Color. + The band Row Color. + + + + Loads the table style Colorful List. + + The style. + The back Color. + The row Color. + The band Column Color. + The band Row Color. + + + + Loads the table style Colorful Grid. + + The style. + The back Color. + The row Color. + The column Color. + The band Color. + + + + Loads the table style Table 3D effects 1. + + The style. + + + + Loads the table style Table 3D effects 2. + + The style. + + + + Loads the table style Table 3D effects 3. + + The style. + + + + Loads the table style Table Classic 1. + + The style. + + + + Loads the table style Table Classic 2. + + The style. + + + + Loads the table style Table Classic 3. + + The style. + + + + Loads the table style Table Classic 4. + + The style. + + + + Loads the table style Table Colorful 1. + + The style. + + + + Loads the table style Table Colorful 2. + + The style. + + + + Loads the table style Table Colorful 3. + + The style. + + + + Loads the table style Table Columns 1. + + The style. + + + + Loads the table style Table Columns 2. + + The style. + + + + Loads the table style Table Columns 3. + + The style. + + + + Loads the table style Table Columns 4. + + The style. + + + + Loads the table style Table Columns 5. + + The style. + + + + Loads the table style Table Contemporary. + + The style. + + + + Loads the table style Table Elegant. + + The style. + + + + Loads the table style Table Grid 1. + + The style. + + + + Loads the table style Table Grid 2. + + The style. + + + + Loads the table style Table Grid 3. + + The style. + + + + Loads the table style Table Grid 4. + + The style. + + + + Loads the table style Table Grid 5. + + The style. + + + + Loads the table style Table Grid 6. + + The style. + + + + Loads the table style Table Grid 7. + + The style. + + + + Loads the table style Table Grid 8. + + The style. + + + + Loads the table style Table List 1. + + The style. + + + + Loads the table style Table List 2. + + The style. + + + + Loads the table style Table List 3. + + The style. + + + + Loads the table style Table List 4. + + The style. + + + + Loads the table style Table List 5. + + The style. + + + + Loads the table style Table List 6. + + The style. + + + + Loads the table style Table List 7. + + The style. + + + + Loads the table style Table List 8. + + The style. + + + + Loads the table style Table Professional. + + The style. + + + + Loads the table style Table Simple 1. + + The style. + + + + Loads the table style Table Simple 2. + + The style. + + + + Loads the table style Table Simple 3. + + The style. + + + + Loads the table style Table Subtle 1. + + The style. + + + + Loads the table style Table Subtle 2. + + The style. + + + + Loads the table style Table Theme. + + The style. + + + + Loads the table style Table Web 1. + + The style. + + + + Loads the table style Table Web 2. + + The style. + + + + Loads the table style Table Web 3. + + The style. + + + + Updates the XML resource and reader. + + + + + Gets the specified resource file as stream. + + The resource file name + Stream of the specified resource file + + + + Determines whether is list style the specified BuiltinStyle. + + The built in style. + + if the list style specified in BuiltinStyle, set to true. + + + + + Initializes a new instance of the class. + + The doc. + + + + Clones the , creating duplicate style. + + The object. + + + + Clones itself. + + Returns cloned object. + + + + Clones the relations. + + The doc. + + + + + Closes this instance. + + + + + Registers child objects in XDSL holder. + + + + + Writes object data as xml attributes. + + The object. + + + + Reads object data from xml attributes. + + The object. + + + + Compares the current list override style with another list override style + + The ListOverrideStyle + + + + Compares the source base list with the destination base list style for the override style. + + Name of the source list style. + Name of the dest list style. + + + + + Gets the type of the style. + + The member that specifies the type of the style. + + + + Gets the override levels. + + The override levels. + + + + Gets or sets the list identifier. + + The list identifier. + + + + Represents the list level override formats. + + + + + + + + + + Initializes a new instance of the class. + + The doc. + + + + Serialize paragraph and character properties. + + + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Clones itself. + + + Returns cloned object. + + + + Closes this instance. + + + + + Compares current list override format with another list override format + + The override level format + + + + Gets or sets a value indicating whether [override start at value]. + + + if it override start at value, set to true. + + + + + Gets or sets a value indicating whether [override formatting]. + + if it override formatting, set to true. + + + + Gets or sets the start at. + + The start at. + + + + Gets the override list level. + + The override list level. + + + + Represents the cell paddings. + + + + + + Specifies the constant value for left key. + + + + + Specifies the constant value for top key. + + + + + Specifies the constant value for bottom key. + + + + + Specifies the constant value for right key. + + + + + + + + + + + + Initializes a new instance of the Paddings class. + + + + + Updates the paddings. + + The padding. + + + + Imports the paddings. + + The base paddings. + + + + Compare the padding properties + + The paddings instance + A value indicating whether the properties are equal. + + + + Returns the default values. + + + The integer that specifies the key. + An object that specifies the default value. + + + + Registers child objects in XDSL holder. + + + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Occurs on format change. + + + The object. + The integer that represents the property key. + + + + Gets or sets the left padding value for the cell in points. + + The float that specifies left padding value. + + + + Gets or sets the top padding value for the cell in points. + + The float that specifies top padding value. + + + + Gets or sets the right padding value for the cell in points. + + The float that specifies right padding value. + + + + Gets or sets the bottom padding value for the cell in points. + + The float that specifies bottom padding value. + + + + Sets the padding values for all sides of the cell. + + The float that specifies the padding value for left, right, top and bottom. + + + + TableStyleCellProperties is used for representing formatting properties of the table. + + + + + Initializes a new instance of the TableStyleCellProperties class. + + The doc. + + + + Gets the property value. + + The property key. + + + + + Sets the property value. + + The property key. + The value. + + + + Determines whether the specified property key has value. + + The property key. + + if the specified property key has value, set to true. + + + + + Apply base style + + + + + + Ensures the composites. + + + + + Returns the default values. + + The integer that specifies the key. + An object that specifies the default value. + + + + Gets the composite values. + + The integer that specifies the key. + The object. + + + + Compare the Table style cell properties of two objects and return true if Equal else false. + + + + + Gets/sets the background color. + + + + + Gets/sets the foreground color. + + + + + Gets or sets the texture style. + + The texture style. + + + + Gets the borders. + + + + + Gets the paddings. + + + + + Gets/sets vertical alignment of the cell. + + + + + Gets or sets a boolean value indicating whether to wrap text in cell or not. + + true if it specifies text wrap, set to true. + + + + TableStyleRowProperties is used for representing formatting properties of the table. + + + + + Initializes a new instance of the TableStyleRowProperties class. + + The doc. + + + + Gets as row format. + + + + + + Gets the property value. + + The property key. + + + + + Sets the property value. + + The property key. + The value. + + + + Determines whether the specified property key has value. + + The property key. + + if the specified property key has value, set to true. + + + + + Returns the default values. + + The integer that specifies the key. + An object that specifies the default value. + + + + Compare the Table style row properties of two objects and return true if Equal else false. + + + + + Gets / sets a boolean value indicating if row is hidden + + + + + Gets / sets a boolean value indicating if row is table header + + + + + Gets / sets a boolean value indicating if there is a break across pages + + + + + Gets / sets the spacing between cells. + + + + + Gets / sets horizontal alignment of the row. + + + + + TableStyleTableProperties is used for representing formatting properties of the table. + + + + + Initializes a new instance of the TableStyleTableProperties class. + + The doc. + + + + Gets as table format. + + + + + + Gets the property value. + + The property key. + + + + + Sets the property value. + + The property key. + The value. + + + + Determines whether the specified property key has value. + + The property key. + + if the specified property key has value, set to true. + + + + + Apply base style + + + + + + Ensures the composites. + + + + + Returns the default values. + + The integer that specifies the key. + An object that specifies the default value. + + + + Gets the composite values. + + The integer that specifies the key. + The object. + + + + Compare the Table style table properties of two objects and return true if Equal else false. + + + + + Gets/sets the background color. + + + + + Gets/sets the foreground color. + + + + + Gets or sets the texture style. + + The texture style. + + + + Gets the borders. + + + + + Gets the paddings. + + + + + Gets / sets the spacing between cells. + + + + + Gets / sets the table indent. + + + + + Gets / sets the boolean value indicating if table allow page breaks + + + + + Gets / sets horizontal alignment of the table. + + + + + Gets / sets number of columns in column band. + + + + + Gets / sets number of rows in row band. + + + + + Represents the view setup options for the Word document. + + + + + Constant value for Zoom. + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + Clones the specified doc. + + The doc. + + + + + Sets the zoom percent. + Validates the Zoom percentage value while parsing the document. + + The value. + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Gets or sets the zoom value in percents. + + The integer specifying the zoom percent. + + + + Gets or sets the zoom type + + The member that specifies the type of the zoom. + + + + Gets or sets the document view mode. + + The member that specifies the type of the document view. + + + + Represents the font or character properties of the text in the Word document. + + The following examples illustrates how to apply various character formats for the text. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new text to the paragraph + IWTextRange text = paragraph.AppendText("Text with All caps."); + //All Caps + text.CharacterFormat.AllCaps = true; + paragraph = section.AddParagraph(); + text = paragraph.AppendText("Right to left text."); + //Right to left text with bold and italic styles. + text.CharacterFormat.Bidi = true; + text.CharacterFormat.FontNameBidi = "Times New Roman"; + text.CharacterFormat.FontSizeBidi = 14; + text.CharacterFormat.BoldBidi = true; + text.CharacterFormat.ItalicBidi = true; + paragraph = section.AddParagraph(); + //Bold + text = paragraph.AppendText("Bold text."); + text.CharacterFormat.Bold = true; + paragraph = section.AddParagraph(); + text = paragraph.AppendText("Text with border."); + //Borders + text.CharacterFormat.Border.BorderType = BorderStyle.DotDash; + text.CharacterFormat.Border.LineWidth = 0.5f; + text.CharacterFormat.Border.Color = Color.Blue; + paragraph = section.AddParagraph(); + text = paragraph.AppendText("Character spacing."); + text.CharacterFormat.CharacterSpacing = 1; + paragraph = section.AddParagraph(); + text = paragraph.AppendText("Double strike."); + //Double strike + text.CharacterFormat.DoubleStrike = true; + paragraph = section.AddParagraph(); + text = paragraph.AppendText("Emboss."); + //Emboss + text.CharacterFormat.Emboss = true; + paragraph = section.AddParagraph(); + text = paragraph.AppendText("Engrave."); + //Engrave + text.CharacterFormat.Engrave = true; + paragraph = section.AddParagraph(); + text = paragraph.AppendText("Font name."); + //Font name + text.CharacterFormat.FontName = "Algerian"; + paragraph = section.AddParagraph(); + text = paragraph.AppendText("Font size."); + //Font size + text.CharacterFormat.FontSize = 10; + paragraph = section.AddParagraph(); + text = paragraph.AppendText("Highlight color."); + //Highlight color + text.CharacterFormat.HighlightColor = Color.Gray; + paragraph = section.AddParagraph(); + text = paragraph.AppendText("Italic."); + //Italic + text.CharacterFormat.Italic = true; + paragraph = section.AddParagraph(); + text = paragraph.AppendText("Outline."); + //Outline + text.CharacterFormat.OutLine = true; + paragraph = section.AddParagraph(); + paragraph.AppendText("Position Property with text"); + text = paragraph.AppendText("raised by 10 points."); + //Position + text.CharacterFormat.Position = 10; + paragraph = section.AddParagraph(); + text = paragraph.AppendText("Shadow."); + //Shadow + text.CharacterFormat.Shadow = true; + paragraph = section.AddParagraph(); + text = paragraph.AppendText("SmallCaps."); + //SmallCaps + text.CharacterFormat.SmallCaps = true; + paragraph = section.AddParagraph(); + text = paragraph.AppendText("Strikeout."); + //Strikeout + text.CharacterFormat.Strikeout = true; + paragraph = section.AddParagraph(); + paragraph.AppendText("Text"); + text = paragraph.AppendText("Subscript."); + //Subscript + text.CharacterFormat.SubSuperScript = SubSuperScript.SubScript; + paragraph = section.AddParagraph(); + paragraph.AppendText("Text"); + text = paragraph.AppendText("Superscript."); + //Superscript + text.CharacterFormat.SubSuperScript = SubSuperScript.SuperScript; + paragraph = section.AddParagraph(); + text = paragraph.AppendText("TextBackgroundColor."); + //TextBackgroundColor + text.CharacterFormat.TextBackgroundColor = Color.LightSkyBlue; + paragraph = section.AddParagraph(); + text = paragraph.AppendText("TextColor."); + //TextColor + text.CharacterFormat.TextColor = Color.Green; + paragraph = section.AddParagraph(); + text = paragraph.AppendText("UnderlineStyle."); + //UnderlineStyle + text.CharacterFormat.UnderlineStyle = UnderlineStyle.Dash; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new text to the paragraph + Dim text As IWTextRange = paragraph.AppendText("Text with All caps.") + 'All Caps + text.CharacterFormat.AllCaps = True + paragraph = section.AddParagraph() + text = paragraph.AppendText("Right to left text.") + 'Right to left text with bold and italic styles. + text.CharacterFormat.Bidi = True + text.CharacterFormat.FontNameBidi = "Times New Roman" + text.CharacterFormat.FontSizeBidi = 14 + text.CharacterFormat.BoldBidi = True + text.CharacterFormat.ItalicBidi = True + paragraph = section.AddParagraph() + 'Bold + text = paragraph.AppendText("Bold text.") + text.CharacterFormat.Bold = True + paragraph = section.AddParagraph() + text = paragraph.AppendText("Text with border.") + 'Borders + text.CharacterFormat.Border.BorderType = BorderStyle.DotDash + text.CharacterFormat.Border.LineWidth = 0.5F + text.CharacterFormat.Border.Color = Color.Blue + paragraph = section.AddParagraph() + text = paragraph.AppendText("Character spacing.") + text.CharacterFormat.CharacterSpacing = 1 + paragraph = section.AddParagraph() + text = paragraph.AppendText("Double strike.") + 'Double strike + text.CharacterFormat.DoubleStrike = True + paragraph = section.AddParagraph() + text = paragraph.AppendText("Emboss.") + 'Emboss + text.CharacterFormat.Emboss = True + paragraph = section.AddParagraph() + text = paragraph.AppendText("Engrave.") + 'Engrave + text.CharacterFormat.Engrave = True + paragraph = section.AddParagraph() + text = paragraph.AppendText("Font name.") + 'Font name + text.CharacterFormat.FontName = "Algerian" + paragraph = section.AddParagraph() + text = paragraph.AppendText("Font size.") + 'Font size + text.CharacterFormat.FontSize = 10 + paragraph = section.AddParagraph() + text = paragraph.AppendText("Highlight color.") + 'Highlight color + text.CharacterFormat.HighlightColor = Color.Gray + paragraph = section.AddParagraph() + text = paragraph.AppendText("Italic.") + 'Italic + text.CharacterFormat.Italic = True + paragraph = section.AddParagraph() + text = paragraph.AppendText("Outline.") + 'Outline + text.CharacterFormat.OutLine = True + paragraph = section.AddParagraph() + paragraph.AppendText("Position Property with text") + text = paragraph.AppendText("raised by 10 points.") + 'Position + text.CharacterFormat.Position = 10 + paragraph = section.AddParagraph() + text = paragraph.AppendText("Shadow.") + 'Shadow + text.CharacterFormat.Shadow = True + paragraph = section.AddParagraph() + text = paragraph.AppendText("SmallCaps.") + 'SmallCaps + text.CharacterFormat.SmallCaps = True + paragraph = section.AddParagraph() + text = paragraph.AppendText("Strikeout.") + 'Strikeout + text.CharacterFormat.Strikeout = True + paragraph = section.AddParagraph() + paragraph.AppendText("Text") + text = paragraph.AppendText("Subscript.") + 'Subscript + text.CharacterFormat.SubSuperScript = SubSuperScript.SubScript + paragraph = section.AddParagraph() + paragraph.AppendText("Text") + text = paragraph.AppendText("Superscript.") + 'Superscript + text.CharacterFormat.SubSuperScript = SubSuperScript.SuperScript + paragraph = section.AddParagraph() + text = paragraph.AppendText("TextBackgroundColor.") + 'TextBackgroundColor + text.CharacterFormat.TextBackgroundColor = Color.LightSkyBlue + paragraph = section.AddParagraph() + text = paragraph.AppendText("TextColor.") + 'TextColor + text.CharacterFormat.TextColor = Color.Green + paragraph = section.AddParagraph() + text = paragraph.AppendText("UnderlineStyle.") + 'UnderlineStyle + text.CharacterFormat.UnderlineStyle = UnderlineStyle.Dash + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + + + + Keys. + + + + + Member that specifies the character style name. + + + + + + + + + + + + + + + + Default constructor + + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + Initializes a new instance of the WCharacterFormat class. + + + + + + + + Removes the initialized font names. + + + + + Determines whether the specified property is available. Search includes base formats. + + The property key. + + true if has value; otherwise, false. + + + + + Reserved for internal use. This method is implemented for document editor internal use only. + + + + + Determines whether the specified property is available. Search includes base formats. + This method is implemented for document editor internal use only. + + The property key. + + true if has value; otherwise, false. + + + + + Gets the font style. + + + + + + Specifies the font styles for the revised text. + + + + + + + Checks whether need to preserve insertion markups in the PDF. + + + + + + + Checks whether need to preserve deleted markups in the PDF. + + + + + + + Determines whether line break is next to this paragraph item. + + + if it specifies next element is line break, set to true. + + + + + Sets the line break next. + + + + + + Gets the property value. + + The prop key. + + + + + Gets the boolean property value. + + The prop key. + + + + + Sets the property value. + + The property key. + The value. + + + + Determines whether the specified key is boolean property. + + The key. + + true if the specified key is boolean property; otherwise, false. + + + + + Defines whether to serialize all data. + + + + + + Gets the complex bool value. + + The option key. + + + + + Gets the base format. + + The format. + + + + + Removes the format changes. + + + + + + + + + + Checks whether character format sprms have cross reference + + + + + + Gets the char style. + + The name. + + + + + Gets the name of the font. + + The font key. + + + + + Get the font name bidi to render + + + + + + + Get the font name East Asia to render + + Represent a CharacterRangeType. + Returns a eastAsia font name to draw the text. + + + + Get the font name of Complex script to render + + Represent a CharacterRangeType. + Returns a Complex script font name to draw the text. + + + + Gets a valid font name from theme with theme font name. + + Represent the theme font name. + Represent a CharacterRangeType. + + + + + Update a font name from theme, based on FontHintType. + + + + + + + + + Gets the font name from a theme part for the specified font script. + + + + + Determines whether the specified key contains value. + + The key. + + true if the specified key contains value; otherwise, false. + + + + + Sets the default properties. + + + + + Registers child objects in XDSL holder. + + + + + + Returns the default values. + + + The integer that specifies the key. + An object that specifies the default value. + + + + Gets the composite values. + + + The integer that specifies the key. + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Writes object data as xml attributes. + + + The object. + + + + Writes object data as inside xml element. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + The value indicating the presence of xml content. + + + + Imports the container. + + The object. + + + + Imports the XML properties. + + The format. + + + + Imports the members. + + + The object. + + + + Clears the character formats applied + + + + + Occurs on format change. + + + The object. + The integer that represents the property key. + + + + Apply base style + + + + + + Releases all resources used by the object. + + This API is used for internal purpose to dispose the resources used by . + + + + Closes this instance. + + + + + + + + + + Determines whether the specified property key has value. + + The property key. + + if the specified property key has value, set to true. + + + + + Gets the Single Property Modifier Record option value for the specified property. + + + The integer that represents the property key. + The integer that represents the SPRM value. + + + + Writes the complex attribute. + + The writer. + The property key. + The XDLS constant string. + + + + Gets the font hint. + + + + + + Returns font from Hint + + + + + Merges the format. + + The destination format. + + + + Updates the formattings. + + The properties. + + + + Clones the relations. + + + + + Creates a duplicate copy of character format + + The reference of the newly created object. + This API is used for internal purpose to clone . + + + + Clones the relations for referred character style. + + + + + Updates the formatting. + + The doc. + + + + Updates the source format. + + The dest base format. + + + + Updates the source formatting. + + The format. + + + + To check whether the font name is theme font or not. + + Specify the font name. + Returns true if the font name is represent a theme font. + + + + Update the document defaults values to property hash. + + + + + + + Gets the BaseCharacter Format has FontInfor related keys or not + + + + + + + Compares current character format with another character format + + The character format + + + + Gets the character format text for Word comparison + + + + + + + Sets the Kern font size + + Kern font size + + + + Sets the character position + + The character position. + + + + Sets the scaling value + + The scaling value. + + + + Sets the Character spacing + + The character spacing. + + + + Gets or sets a value indicating whether [m_cancel on change]. + + + true if [m_cancel on change]; otherwise, false. + + + + + Flag which defines whether character format passed test on cross + reference. + + + + + Represent the reduced font size + + + + + Represent the font name used for emoji + + + + + Gets or sets the value indicates whether this format is created in DOC Reading + + + + + Gets or sets the for the text. + + + + + Gets or sets font name of the text. + + The string that specifies the font name. + + + + + Gets and set the clear value + get the type of the BreakClear and set the Type for BreakClear + Clear. + + + + Gets or sets the font size of the text measured in points. + + The float that specifies the font size. + + + + Holds the shadow properties of the characterformat + + + + + Holds the reflection properties of the characterformat + + + + + Holds the GlowFormat properties of the characterformat + + + + + Holds the threeDeffect properties of the characterformat + + + + + Holds the lineFormat properties of the characterformat + + + + + Gets or sets the scaling. + + + The scaling. + + + + + Gets or sets a value indicating whether the contents of the text shall be + treated as complex script text regardless of their Unicode character values when determining + the formatting for the text. + + True if to consider as complex script; otherwise, false. + + + + Gets or sets a value indicating whether the text is formatted as bold. + + True if to format the text with bold style; otherwise, false. + + + + Gets or sets a value indicating whether the text is formatted as italic. + + True if to format the text with italic style; otherwise, false. + + + + Gets or sets a value indicating whether the text is formatted with strikethrough. + + True if to format the text with strike through; otherwise, false. + + + + Gets or sets a value indicating whether the text is formatted with double strikethrough effect. + + True if to format the text with double strike through; otherwise, false. + The double strike effect is not supported by Essential PDF. + + + + Gets or sets the underline style for the text. + + The member that specifies the underline style. + Essential PDF supports only single underline style. + + + + Holds the fillformat properties of the characterformat + + + + + Gets or sets the for the text. + + + + + Gets or sets the text background color. + + The text background color is not supported by Essential PDF. + + + + Gets or sets the subscript or superscript for the text. + + The member that specifies the type of SubSuperScript. + + + + Gets or sets space width between the characters measured in points. + + The float that specifies the width. + + + + Gets or sets the vertical position of text measured in points. + + The float that specifies the vertical position. + + + + Gets or sets line break after. + + + + + Gets or sets a value indicating whether the text is formatted with a shadow. + + True if the text has shadow; otherwise, false. + + + + Gets or sets a value indicating whether the text is embossed. + + True if the text is embossed; otherwise, false. + + + + Gets or sets a value indicating whether the text is engraved. + + True if the text is engraved; otherwise, false. + + + + Gets or sets a value indicating whether the text is formatted as hidden. + + True if the text is hidden; otherwise, false. + + + + Gets or sets a value indicating whether the text characters are displayed as their capital letter equivalents. + + True if the text to be displayed as capital letters; otherwise, false. + + + + Gets or sets a value indicating whether the text characters are displayed as their capital letter equivalents, + in a font size that is smaller than the actual font size that is specified for this text. + + True if the text to be displayed as capital letters with smaller font size; otherwise, false. + + + + Gets or sets the value for SpecVanish property + + + + + Gets or sets the value indicating directional override of the text. + + + + + Gets or sets a value indicating whether the text is formatted with right-to-left layout. + + True if the text is right-to-left; otherwise, false. + + + + Gets or sets a value indicating whether the text is formatted bold when displayed right-to-left or determined to be complex script. + + True if to format the right-to-left text with bold style; otherwise, false. + + + + Gets or sets a value indicating whether the text is italicized when displayed right-to-left or determined to be complex script. + + True if to format the right-to-left text with italic style; otherwise, false. + + + + Gets or sets the size of the text(in points), for text that is displayed right-to-left or text that is a complex script. + + + + + Gets or sets the font name for text that is displayed right-to-left or text that is a complex script. + + + + + Gets or sets highlight of the text. + + + Microsoft Word application supports only 15 valid colors for highlighting the text. + To highlight text with Microsoft Word compatible color in the generated Word document, use the known color object or new color object with same ARGB value based on the following highlight color mapping. + Yellow Color.Yellow (#FFFFFF00) + BrightGreen Color.Green (#FF008000) + Turquoise Color.Cyan (#FF00FFFF) + Pink Color.Magenta (#FFFF00FF) + Blue Color.Blue (#FF0000FF) + Red Color.Red (#FFFF0000) + DarkBlue Color.DarkBlue (#FF00008B) + Teal Color.DarkCyan (#FF008B8B) + Green Color.DarkGreen (#FF006400) + Violet Color.DarkMagenta (#FF8B008B) + DarkRed Color.DarkRed (#FF8B0000) + DarkYellow Color.Gold (#FFFFD700) + Gray50 Color.DarkGray (#FFA9A9A9) + Gray25 Color.LightGray (#FFD3D3D3) + Black Color.Black (#FF000000) + No Color Color.Empty + + + + + Gets the for the text. + + + + + Gets or sets the emphasis style for the text + + + + + Gets or sets the animated text effect + + + + + Gets or sets a value indicating whether the text is displayed based on docGrid character settings + + + + + Gets or sets a value indicating whether the text is hidden in Web layout view of the document + + + + + Gets or sets the font used for Latin text (characters with character codes + from 0 through 127). + + + + + Gets or sets East Asian font name. + + + + + Gets or sets font used for characters with character codes from 128 through 255. + + + + + Get/set IdctHint property. + + + + + Gets or sets the locale identifier(language) of the formatted characters. + + The short value that specifies the ASCII locale id. + + + + Gets or sets the the locale identifier (language) of the formatted Asian characters. + + The short value that specifies the far east locale id. + + + + Gets or sets the locale identifier(language) of the formatted right-to-left or complex script characters. + + The short value that specifies the Bidi locale id. + + The following example illustrates how to set right-to-left or complex script characters for text. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new text + IWTextRange text = paragraph.AppendText("Text to describe LocaleIdBidi text"); + //Set right to left layout for text + text.CharacterFormat.Bidi = true; + //Set language identifier for right to left or complex script characters + text.CharacterFormat.LocaleIdBidi = (short)LocaleIDs.he_IL; + paragraph = section.AddParagraph(); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new text + Dim text As IWTextRange = paragraph.AppendText("Text to describe LocaleIdBidi text") + 'Set right to left layout for text + text.CharacterFormat.Bidi = True + 'Set language identifier for right to left or complex script characters + text.CharacterFormat.LocaleIdBidi = CType(LocaleIDs.he_IL, Short) + paragraph = section.AddParagraph() + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + + + + + + + + + + + + + + + + Gets or sets a value indicating whether only the outline contour of the characters in the text is rendered, + with the inside of each character left empty. + + True if to have the outline effect; otherwise, false. + + + + Gets or sets special style. + + + + + Gets the character style name that is used to format the contents of the paragraph. + + The string that specifies the character style name. + + + + Gets the character style name that is used to format the contents of the paragraph. + + The string that specifies the character style name. + + + + Gets a value indicating whether this instance is inserted change. + + + if this instance is inserted change, set to true. + + + + + Gets a value indicating whether this instance is deleted change. + + + if this instance is deleted change, set to true. + + + + + Gets a value indicating whether this instance has changed format. + + + if this instance has changed format, set to true. + + + + + Gets or sets the SPRMS. + + The SPRMS. + + Gets or sets the index of the list picture. + + The index of the list picture. + + + + + + + + + Gets the character style. + + The character style. + + + + Gets or sets a value indicating whether field should be vanished. + + true if field vanish; otherwise, false. + + + + + Gets or sets the table style character format. + + The table style character format. + + + + Gets or sets the name of the move revision. + + + + + Gets or sets a value indicating whether to use contextual alternates. + + + True if to use contextual alternates; otherwise, false. + + + The following example illustrates how to set contextual alternates for text. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new text + IWTextRange text = paragraph.AppendText("Text to describe contextual alternates"); + text.CharacterFormat.FontName = "Segoe Script"; + //Set contextual alternates + text.CharacterFormat.UseContextualAlternates = true; + paragraph = section.AddParagraph(); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new text + Dim text As IWTextRange = paragraph.AppendText("Text to describe contextual alternates") + text.CharacterFormat.FontName = "Segoe Script" + 'Set contextual alternates + text.CharacterFormat.UseContextualAlternates = True + paragraph = section.AddParagraph() + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets the ligatures type for the text. + + The member that specifies the type of ligatures. + + The following example illustrates how to set ligature types for text. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new text + IWTextRange text = paragraph.AppendText("Text to describe discretional ligatures"); + //Set ligature type + text.CharacterFormat.Ligatures = LigatureType.Discretional; + text.CharacterFormat.FontName = "Arial"; + paragraph = section.AddParagraph(); + text = paragraph.AppendText("Text to describe contextual ligatures"); + text.CharacterFormat.Ligatures = LigatureType.Contextual; + text.CharacterFormat.FontName = "Arial"; + paragraph = section.AddParagraph(); + text = paragraph.AppendText("Text to describe historical ligatures"); + text.CharacterFormat.Ligatures = LigatureType.Historical; + text.CharacterFormat.FontName = "Arial"; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new text + Dim text As IWTextRange = paragraph.AppendText("Text to describe discretional ligatures") + 'Set ligature type as Discretional + text.CharacterFormat.Ligatures = LigatureType.Discretional + text.CharacterFormat.FontName = "Arial" + paragraph = section.AddParagraph() + text = paragraph.AppendText("Text to describe contextual ligatures") + 'Set ligature type as Contextual + text.CharacterFormat.Ligatures = LigatureType.Contextual + text.CharacterFormat.FontName = "Arial" + paragraph = section.AddParagraph() + text = paragraph.AppendText("Text to describe historical ligatures") + 'Set ligature type as Historical + text.CharacterFormat.Ligatures = LigatureType.Historical + text.CharacterFormat.FontName = "Arial" + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets type of number form(height of the numbers present in the text) for the text. + + The member that specifies the type of number form. + + The following example illustrates how to set number form type for text. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new text + IWTextRange text = paragraph.AppendText("Numbers to describe oldstyle number form 0123456789"); + text.CharacterFormat.FontName = "Calibri"; + //Set number style + text.CharacterFormat.NumberForm = NumberFormType.OldStyle; + paragraph = section.AddParagraph(); + text = paragraph.AppendText("Numbers to describe lining number form 0123456789"); + text.CharacterFormat.FontName = "Calibri"; + //Set number style + text.CharacterFormat.NumberForm = NumberFormType.Lining; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new text + Dim text As IWTextRange = paragraph.AppendText("Numbers to describe oldstyle number form 0123456789") + text.CharacterFormat.FontName = "Calibri" + 'Set number style + text.CharacterFormat.NumberForm = NumberFormType.OldStyle + paragraph = section.AddParagraph() + text = paragraph.AppendText("Numbers to describe lining number form 0123456789") + text.CharacterFormat.FontName = "Calibri" + 'Set number style + text.CharacterFormat.NumberForm = NumberFormType.Lining + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets the type of number spacing(spacing between numbers in text) for the text. + + The member that specifies the type of number spacing. + + The following example illustrates how to set number spacing for text. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new text + IWTextRange text = paragraph.AppendText("Numbers to describe tabular number spacing 0123456789"); + text.CharacterFormat.FontName = "Calibri"; + //Set number spacing + text.CharacterFormat.NumberSpacing = NumberSpacingType.Tabular; + paragraph = section.AddParagraph(); + text = paragraph.AppendText("Numbers to describe proportional number spacing 0123456789"); + text.CharacterFormat.FontName = "Calibri"; + //Set number spacing + text.CharacterFormat.NumberSpacing = NumberSpacingType.Proportional; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new text + Dim text As IWTextRange = paragraph.AppendText("Numbers to describe tabular number spacing 0123456789") + text.CharacterFormat.FontName = "Calibri" + 'Set number spacing + text.CharacterFormat.NumberSpacing = NumberSpacingType.Tabular + paragraph = section.AddParagraph() + text = paragraph.AppendText("Numbers to describe proportional number spacing 0123456789") + text.CharacterFormat.FontName = "Calibri" + 'Set number spacing + text.CharacterFormat.NumberSpacing = NumberSpacingType.Proportional + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets the stylistic set type(defines the look of the text, based on the font used) for the text. + + The member that specifies the type of stylistic set. + + The following example illustrates how to set number spacing for text. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new text + IWTextRange text = paragraph.AppendText("Text to describe stylistic sets"); + text.CharacterFormat.FontName = "Gabriola"; + //Set stylistic set + text.CharacterFormat.StylisticSet = StylisticSetType.StylisticSet06; + paragraph = section.AddParagraph(); + //Add new text + text = paragraph.AppendText("Text to describe stylistic sets"); + text.CharacterFormat.FontName = "Gabriola"; + //Set stylistic set + text.CharacterFormat.StylisticSet = StylisticSetType.StylisticSet15; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new text + Dim text As IWTextRange = paragraph.AppendText("Text to describe stylistic sets") + text.CharacterFormat.FontName = "Gabriola" + 'Set stylistic set + text.CharacterFormat.StylisticSet = StylisticSetType.StylisticSet06 + paragraph = section.AddParagraph() + 'Add new text + text = paragraph.AppendText("Text to describe stylistic sets") + text.CharacterFormat.FontName = "Gabriola" + 'Set stylistic set + text.CharacterFormat.StylisticSet = StylisticSetType.StylisticSet15 + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + + + + Returns the list of keys used for revisions + + + + + East asian layout structure + + + + + Determines whether [has combine brackets type]. + + + + + + Updates the cfe layout. + + The ufel. + The iFElayout identifier. + + + + Represent a comment properties. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Text position of the comment. + + + + + Initializes a new instance of the class. + + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Creates a new object that is a copy of the current instance. + + + A new object that is a copy of this instance. + + + + + + + + + + + + + Determines whether the comment exists or not. + + + + + + + + + + + + + + + Gets or sets the user initials. + + The user initials. + + + + Gets or sets the user. + + The user. + + + + + + + + + + + + + + + + + + + Gets/sets the text position of the comment. + + The position. + + + + + + + + + Class which provides WCommentFormat class with random tag bookmark id. + + + + + Contains changed IDs and values they where change on. + + + + + Contains the comment ids, which can't be changed + + + + + Contains the old id(s) and the new id(s) + + + + + Gets the id for comment marker. + + The current id. + if set to true create new id. + + + + + Determines whether the new id is valid. + + The new id. + + if it specifies a valid id, set to true. + + + + + Gets the marker id. + + The current id. + if it creates new id, set to true. + + + + + Gets the instance of Random class. + + The instance. + + + + Gets the collection of ids and new ids they were changed on. + + + + + Gets the collection of ids and new ids they were changed on. + + + + + Gets the collection of ids and new ids they were changed on. + + + + + Represents the list formatting options. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Currently used list style + + + + + Current level number + + + + + Initializes a new instance of the class with the specified + instance. + + The owner entity of the current list format. + + + + Initializes a new instance of the class with the specified + instance along with paragraph style. + + instance. + The owner paragraph style for the current list format. + + + + + + + + + + + Initializes a new instance of the class. + + The doc. + The owner. + + + + Returns the default values. + + + The integer that specifies the key. + An object that specifies the default value. + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Update the style and type key to current list format. + + List style + + + + Checks whether the same list style already added to destination document. + + Destination Word document + Current list style + New list style + + + + + Adds the List Style to destination Word document. + + Destination docuement + New Style + + + + Clones the list relations. + + The doc. + + + + Imports list format from source to destination. + + + + + + + Increase the current level indent. + + List level must be less 8 and greater then 0 + + + + Decrease the current level indent. + + List level must be less 8 and greater then 0 + + + + Continues the list numbering from the previous list. + + + + + Applies the specified style. + + A String that represents the name of the style to apply. + + + + Apply default bullet style for current list's owner paragraph. + + + + + Apply default numbered style for current list's owner paragraph. + + + + + Removes the list from current paragraph. + + + + + Set the ListType for the Current ListFormat + + + + + + To Clears the list format applied + + + + + Creates the default list styles based on its type. + + + + + Compares the list format with current list format + + The List format + + + + Gets or sets current list nesting level. + + List level must be less 8 and greater then 0 + + + + Gets type of the list format. Read-only. + + + + + Gets or sets a value indicating whether numbering of the list must restart from previous list. + + True, if the list number must restart from previous list; otherwise, false. + + + + Gets the name of custom style. Read-only. + + + + + Gets current custom list style. Read-only. + + + + + Gets the current custom list level. + + + + + Gets or sets the name of the LFO style. + + The name of the LFO style. + + + + Gets the owner paragraph. + + The owner paragraph. + + + + Gets/sets IsListRemoved flag. + + + + + Gets/sets the value which specifies whether this is empty list. + Such situation occurs when style (which doesn't have) + list format inherits style which have list. + + The is empty list. + + + + Represents the formatting options of the paragraph in the Word document. + + The following example illustrates how to apply various paragraph formatting options. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new text to the paragraph + paragraph.AppendText("Paragraphs are the basic elements of the Word document. It can contain text and images. " + + "Paragraphs are the basic elements of the Word document. It can contain text and images. Paragraphs are the basic elements of the Word document. It can contain text and images."); + //After spacing, back color, borders, contextual spacing + paragraph.ParagraphFormat.AfterSpacing = 18f; + paragraph.ParagraphFormat.BackColor = Color.LightGray; + paragraph.ParagraphFormat.Bidi = true; + paragraph.ParagraphFormat.Borders.BorderType = BorderStyle.Dot; + paragraph.ParagraphFormat.Borders.Color = Color.Maroon; + paragraph.ParagraphFormat.Borders.LineWidth = 0.5f; + paragraph.ParagraphFormat.ContextualSpacing = true; + paragraph = section.AddParagraph(); + paragraph.AppendText("Paragraphs are the basic elements of the Word document. It can contain text and images. " + + "Paragraphs are the basic elements of the Word document. It can contain text and images. Paragraphs are the basic elements of the Word document. It can contain text and images."); + //column break, firstline indent, alignment + paragraph.ParagraphFormat.ColumnBreakAfter = true; + paragraph.ParagraphFormat.FirstLineIndent = 12; + paragraph.ParagraphFormat.HorizontalAlignment = HorizontalAlignment.JustifyHigh; + paragraph = section.AddParagraph(); + paragraph.AppendText("Paragraphs are the basic elements of the Word document. It can contain text and images. " + + "Paragraphs are the basic elements of the Word document. It can contain text and images. Paragraphs are the basic elements of the Word document. It can contain text and images."); + //Hanging indent, keep, left indent, line spacing, keep follow + paragraph.ParagraphFormat.FirstLineIndent = -12; + paragraph.ParagraphFormat.Keep = true; + paragraph.ParagraphFormat.LeftIndent = 10; + paragraph.ParagraphFormat.LineSpacing = 2; + paragraph.ParagraphFormat.LineSpacingRule = LineSpacingRule.AtLeast; + paragraph.ParagraphFormat.KeepFollow = true; + paragraph = section.AddParagraph(); + paragraph.AppendText("Paragraphs are the basic elements of the Word document. It can contain text and images. " + + "Paragraphs are the basic elements of the Word document. It can contain text and images. Paragraphs are the basic elements of the Word document. It can contain text and images."); + //Mirror indent, outline level, page break + paragraph.ParagraphFormat.MirrorIndents = true; + paragraph.ParagraphFormat.OutlineLevel = OutlineLevel.Level2; + paragraph.ParagraphFormat.PageBreakAfter = true; + paragraph = section.AddParagraph(); + paragraph.AppendText("Paragraphs are the basic elements of the Word document. It can contain text and images. " + + "Paragraphs are the basic elements of the Word document. It can contain text and images. Paragraphs are the basic elements of the Word document. It can contain text and images."); + //Right indent, auto spacing + paragraph.ParagraphFormat.RightIndent = 10; + paragraph.ParagraphFormat.SpaceAfterAuto = true; + paragraph.ParagraphFormat.SpaceBeforeAuto = true; + paragraph = section.AddParagraph(); + paragraph.AppendText("Paragraphs are the basic elements of the Word document. It can contain text and images. " + + "Paragraphs are the basic elements of the Word document. It can contain text and images. Paragraphs are the basic elements of the Word document. It can contain text and images."); + //Auto hyphens, window control, before spacing, page break + paragraph.ParagraphFormat.SuppressAutoHyphens = true; + paragraph.ParagraphFormat.WidowControl = true; + paragraph.ParagraphFormat.BeforeSpacing = 18f; + paragraph.ParagraphFormat.PageBreakBefore = true; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new text to the paragraph + paragraph.AppendText("Paragraphs are the basic elements of the Word document. It can contain text and images. " & "Paragraphs are the basic elements of the Word document. It can contain text and images. Paragraphs are the basic elements of the Word document. It can contain text and images.") + 'After spacing, back color, borders, contextual spacing + paragraph.ParagraphFormat.AfterSpacing = 18.0F + paragraph.ParagraphFormat.BackColor = Color.LightGray + paragraph.ParagraphFormat.Bidi = True + paragraph.ParagraphFormat.Borders.BorderType = BorderStyle.Dot + paragraph.ParagraphFormat.Borders.Color = Color.Maroon + paragraph.ParagraphFormat.Borders.LineWidth = 0.5F + paragraph.ParagraphFormat.ContextualSpacing = True + paragraph = section.AddParagraph() + paragraph.AppendText("Paragraphs are the basic elements of the Word document. It can contain text and images. " & "Paragraphs are the basic elements of the Word document. It can contain text and images. Paragraphs are the basic elements of the Word document. It can contain text and images.") + 'column break, firstline indent, alignment + paragraph.ParagraphFormat.ColumnBreakAfter = True + paragraph.ParagraphFormat.FirstLineIndent = 12 + paragraph.ParagraphFormat.HorizontalAlignment = HorizontalAlignment.JustifyHigh + paragraph = section.AddParagraph() + paragraph.AppendText("Paragraphs are the basic elements of the Word document. It can contain text and images. " & "Paragraphs are the basic elements of the Word document. It can contain text and images. Paragraphs are the basic elements of the Word document. It can contain text and images.") + 'Hanging indent, keep, left indent, line spacing, keep follow + paragraph.ParagraphFormat.FirstLineIndent = -12 + paragraph.ParagraphFormat.Keep = True + paragraph.ParagraphFormat.LeftIndent = 10 + paragraph.ParagraphFormat.LineSpacing = 2 + paragraph.ParagraphFormat.LineSpacingRule = LineSpacingRule.AtLeast + paragraph.ParagraphFormat.KeepFollow = True + paragraph = section.AddParagraph() + paragraph.AppendText("Paragraphs are the basic elements of the Word document. It can contain text and images. " & "Paragraphs are the basic elements of the Word document. It can contain text and images. Paragraphs are the basic elements of the Word document. It can contain text and images.") + 'Mirror indent, outline level, page break + paragraph.ParagraphFormat.MirrorIndents = True + paragraph.ParagraphFormat.OutlineLevel = OutlineLevel.Level2 + paragraph.ParagraphFormat.PageBreakAfter = True + paragraph = section.AddParagraph() + paragraph.AppendText("Paragraphs are the basic elements of the Word document. It can contain text and images. " & "Paragraphs are the basic elements of the Word document. It can contain text and images. Paragraphs are the basic elements of the Word document. It can contain text and images.") + 'Right indent, auto spacing + paragraph.ParagraphFormat.RightIndent = 10 + paragraph.ParagraphFormat.SpaceAfterAuto = True + paragraph.ParagraphFormat.SpaceBeforeAuto = True + paragraph = section.AddParagraph() + paragraph.AppendText("Paragraphs are the basic elements of the Word document. It can contain text and images. " & "Paragraphs are the basic elements of the Word document. It can contain text and images. Paragraphs are the basic elements of the Word document. It can contain text and images.") + 'Auto hyphens, window control, before spacing, page break + paragraph.ParagraphFormat.SuppressAutoHyphens = True + paragraph.ParagraphFormat.WidowControl = True + paragraph.ParagraphFormat.BeforeSpacing = 18.0F + paragraph.ParagraphFormat.PageBreakBefore = True + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + + Determine whether the paragraph format is have frame properties + + + + + + Determine whether the frame is have Horizontal alignment + + + + + + Determine whether the frame is have Vertical alignment + + + + + + Gets the property value. + + The prop key. + + + + + Determines whether the specified option key contains SPRM. + + The option key. + + true if the specified option key contains SPRM; otherwise, false. + + + + + Gets the spacing values of paragraph format from the MS Word specific inheritance hierarchy. + + The key to get the value. + The float that specifies the spacing value. + + + + Gets the Paragraph format from the MS Word specific inheritance hierarchy. + + + + + + + Sets the property value. + + The prop key. + The value. + + + + Changes the tabs. + + The tabs. + + + + Creates the new collection of tabs. + + + + + Determines whether the specified key contains value. + + The key. + + true if the specified key contains value; otherwise, false. + + + + + Determine whether the Current paragraph is in Same Frame of the previous paragraph + + + + + + + Determine whether the Next paragraph is in Same Frame of the current paragraph + + + + + + + Determine whether the current paragraph is having a same frame properties + + + + + + + Sets the default properties. + + + + + Checks whether the style is built-in heading style. + + The style name. + True if the style is built-in heading style; otherwise, false. + + + + Gests the corresponding outlinelevel value for built-in heading style. + + The style name. + The outlinelevel value for built-in heading style. + + + + Ensures the composites. + + + + + Returns the default values. + + + The integer that specifies the key. + An object that specifies the default value. + + + + Gets the composite values. + + + The integer that specifies the key. + The object. + + + + Imports the container. + + The object. + + + + Imports the XML properties. + + The format. + + + + Imports the members. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Writes object data as xml attributes. + + + The object. + + + + Writes object data as inside xml element. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + The value indicating the presence of xml content. + + + + Registers child objects in XDSL holder. + + + + + + + + + + + Removes the positioning. + + + + + Apply base style + + + + + + Closes this instance. + + + + + Determines whether the specified property key has value. + + The property key. + + if the specified property key has value, set to true. + + + + + Determines whether the specified property is available. Search includes base formats. + + The property key. + + true if has value; otherwise, false. + + + + + Identify the paragraph contain any side of border + + true if ParagraphFormat contains the any type of border, else flase + + + + Gets the alignment for document rendering. + + + + + + + Determines whether this instance has shading. + + + if this instance has shading, set to true. + + + + + Gets the Single Property Modifier Record option value for the specified property. + + + The integer that represents the property key. + The integer that represents the SPRM value. + + + + Updates the justification. + + + + + Updates the BiDi value + + + + + + Updates the tabs. + + + + + Updates the source format. + + The dest base format. + + + + Updates the source formatting. + + The format. + + + + Compares the list format. + + The format. + + + + Updates the nested paragraph formatting. + + The format. + + + + Determines whether [is value defined] [the specified key]. + + The key. + + true if [is value defined] [the specified key]; otherwise, false. + + + + + Removes the value. + + The key. + + + + Clears the paragraph formatting applied + + + + + Sets the Frame Horizontal Distance From Text + + Horizontal distance from text + + + + Sets the Frame Vertical Distance From Text + + The vertical distance from text. + + + + Sets the Frame postion 'Y' value + + The frame y position value. + + + + Sets the Frame postion 'X' value + + The frame x position value. + + + + Sets the Frame width + + The frame width. + + + + Compares the current paragraph format with another paragraph format + + The paragraph format + + + + Gets or sets a value indicating whether [m_cancel on change]. + + + true if [m_cancel on change]; otherwise, false. + + + + + Gets or sets a value indicating whether to break lines on word or character level. By default line breaks on word level. + + + true if line breaks on word level; otherwise, false. + + + + + Gets or sets the value that represents the Absolute Tab of paragraph. + + + + + Gets or sets the value that represents the paragraph first line indent in character units. + + + + + Gets or sets the value that represents the paragraph left indent in character units. + + + + + Gets or sets the value that represents the paragraph right indent in character units. + + + + + Gets or sets a value indicating whether the paragraph is right-to-left. + + True if the paragraph is right to left; otherwise, false. + + + + Gets the that represents the tabs for the specified paragraph. Read-only. + + + + + Gets or sets a value indicating whether all lines in the paragraph are to remain on the same page. + + True if all lines of the paragraph to remain on the same page; otherwise, false. + + + + Gets or sets a value indicating whether the paragraph remains on the same page as the paragraph that follows it. + + True if the current paragraph to remain on the same page as the paragraph that follows it; otherwise, false. + + + + Gets or sets a value indicating whether there is a page break before the paragraph. + + True if a page break is forced before the paragraph; otherwise, false. + + + + Gets or sets a value indicating whether there is page break after the paragraph. + + True if a page break is forced after the paragraph; otherwise, false. + + + + Gets or sets a value indicating whether the first and last lines of the paragraph are to remain on the + same page as the rest of the paragraph when Word repaginates the document. + + True if the first and last lines of the paragraph are to remain on the same page; otherwise, false. + + + + True, if space is automatically inserted between East Asian text and numbers. + + + + + True, if space is automatically inserted between East Asian text and Latin text. + + + + + True, if the paragraph is set to automatically adjust the right indent + when a document grid for East Asian characters is defined. + + + + + Gets or sets the horizontal alignment for the paragraph. + + The member that specifies the type of alignment. + + + + Gets or sets horizontal alignment for the paragraph as in the input file, while opening files that support logical justification (Docx). + + + + + Gets or sets a float that represents the left indent(in points) for paragraph. + + + + + Gets or sets the float that represents the right indent for paragraph. + + + + + Gets or sets a float that represents the first line or hanging indent of the paragraph. + + The positive value is set to first line indent and negative value is set to hanging indent. + + + + Gets or sets the spacing (in points) before the paragraph. + + The float that specifies the spacing value. + + + + Gets or sets the before lines + + + + + Gets or sets the after lines + + + + + Gets or sets the spacing (in points) after the paragraph. + + The float that specifies the spacing value. + + + + Gets the collection that represents all the borders for the paragraph. + + + + + Gets or sets the background color of the paragraph. + + The for background. + + + + Gets or sets the back ground theme color of the paragraph + + + + + Gets or sets a value indicating whether there is column break after the paragraph. + + True if the column break is forced after the paragraph; otherwise, false. + + + + Gets or sets the line spacing(in points) for the paragraph. + + + + + Gets or sets line spacing rule of the paragraph. + + The member that specifies the line spacing rule. + + + + + + + + + + + + + + Gets or sets a value indicating whether Word automatically sets the amount of spacing before the paragraph. + + True if spacing before is automatic; otherwise, false. + + + + Gets or sets a value indicating whether Word automatically sets the amount of spacing after the paragraph. + + True if spacing after is automatic; otherwise, false. + + + + Gets or sets the outline level for the paragraph. + + The member that specifies the outline level. + + + + Gets or sets a value indicating whether this instance is frame. + + if this instance is frame, set to true. + + + + Gets or sets the frame vertical pos. + + The frame vertical pos. + + + + + Gets or sets the frame horizontal pos. + + The frame horizontal pos. + + + + Gets or sets the frame X. + + The frame X. + + + + Gets or sets the frame Y. + + The frame Y. + + + + Gets or sets the frame width + + The frame Width. + + + + Gets or sets the frame Height + + The frame Height. + + + + Gets or sets the frame horizontal distance from text. + + The frame horizontal distance from text. + + + + Gets or sets the frame vertical distance from text. + + The frame vertical distance from text. + + + + Gets or sets a value indicating whether to wrap frame around. + + The frame wrap mode + + + + + + + + + Gets or sets a value indicating whether to add space between the paragraphs of same style. + + True if not to have spacing; otherwise, false. + + + + Gets or sets the table style paragraph format. + + The table style paragraph format. + + + + Gets or sets a value indicating whether the left and right indents are of same width. + + True if to have mirror indents; otherwise, false. + + + + Gets or sets a value that indicates whether automatic hyphenation of words is enabled or disabled. + + True if automatic hyphenation of words is enabled; otherwise, false. + + + + Gets or sets the vertical alignment of all text on each line. + + + + + Gets or sets a value indicating whether the paragraph should use the document grid lines per page settings + + + + + Gets or sets a value indicating the frame of this paragraph can overlap with other frames. + + + + + Gets or sets the value indicating the text wrapping options for a text box when tight wrapping is set for the text box + + + + + Gets or sets a value indicating whether the line numbers shall be calculated for lines in the paragraph. + + + + + Gets or sets a value indicating whether the anchor of the frame which contains this paragraph is locked to its current location. + + + + + Gets or sets a value indicating whether the paragraph uses East Asian typography and line-breaking rules to determine + the valid characters that are allowed to begin and end each line of East Asian text. + + + + + Gets or set a value indicating whether the punctuation character at the end of the line can extend beyond the end. + + + + + Gets or set a value indicating that specifies a preference to render punctuation characters at the beginning of a line. + + + + + Gets or sets the drop cap type. + + + + + Gets or sets a value for the number of lines to drop. + + + + + Gets or sets a value indicating the text direction in the frame. + + + + + + + + + + To hold the paragraph style name for the old format(To preserve the track changes information properly) + Do not use this property for retrieving paragraph style related information. + + + + + Represents the section formatting. + + + + + + + + + + The columns collection. + + + + + Holds the column collections which exist in SectPrChange. + + + + + Creates a duplicate copy of the section format. + + + + + + Gets the property value. + + The property key. + The value. + + + + sets the property value. + + The prop key. + + + + + Returns the default values. + + + The integer that specifies the key. + An object that specifies the default value. + + + + Gets the default values for composite objects. + + + + + + + Compares the current section properties with another section properties + + The paragraph format + + + + Clear the object from the allocated memory. + + + + + Holds the column collections which exist in SectPrChange. + + + + + Gets the page setup of the current section. Read-only. + + The of the current section. + + + + Gets or sets section break code of the current section. + + The member that specifies the break code. + + + + Gets the collection of columns which logically divide page on many printing or publishing areas. Read-only. + + The collection of columns in the section. + + + + Gets or sets the text direction. + + The text direction. + + + + Gets a value indicating whether this instance has changed format. + + + if this instance has changed format, set to true. + + + + + Gets or sets the author name for section formatting. + + + + + Gets or sets the datetime for section formatting. + + + + + Represents the formatting properties for the table and row in a Word document. + + The following example illustrates how to apply table formatting options such as Borders, LeftIndent, Paddings, IsAutoResize, etc. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an instance of WordDocument class (Empty Word Document) + WordDocument document = new WordDocument(); + //Open an existing Word document into DocIO instance + document.Open("Table.docx", FormatType.Docx); + //Access the instance of the first section in the Word document + WSection section = document.Sections[0]; + //Access the instance of the first table in the section + WTable table = section.Tables[0] as WTable; + //Specify the title for the table + table.Title ="PriceDetails"; + //Specify the description of the table + table.Description = "This table shows the price details of various fruits"; + //Specify the left indent of the table + table.IndentFromLeft = 50; + //Specify the background color of the table + table.TableFormat.BackColor = Color.FromArgb(192, 192, 192); + //Specify the horizontal alignment of the table + table.TableFormat.HorizontalAlignment = RowAlignment.Left; + //Specify the left, right, top and bottom padding of all the cells in the table + table.TableFormat.Paddings.All = 10; + //Specify the auto resize of table to automatically resize all cell width based on its content + table.TableFormat.IsAutoResized = true; + //Specify the table top, bottom, left and right border line width + table.TableFormat.Borders.LineWidth = 2f; + //Specify the table horizontal border line width + table.TableFormat.Borders.Horizontal.LineWidth = 2f; + //Specify the table vertical border line width + table.TableFormat.Borders.Vertical.LineWidth = 2f; + //Specify the tables top, bottom, left and right border color + table.TableFormat.Borders.Color = Color.Red; + //Specify the table Horizontal border color + table.TableFormat.Borders.Horizontal.Color = Color.Red; + //Specify the table vertical border color + table.TableFormat.Borders.Vertical.Color = Color.Red; + //Specify the table borders border type + table.TableFormat.Borders.BorderType = BorderStyle.Double; + //Access the instance of the first row in the table + WTableRow row = table.Rows[0]; + //Specify the row height + row.Height = 20; + //Specify the row height type + row.HeightType = TableRowHeightType.AtLeast; + document.Save("TableFormatting.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an instance of WordDocument class (Empty Word Document) + Dim document As New WordDocument() + 'Open an existing Word document into DocIO instance + document.Open("Table.docx", FormatType.Docx) + 'Access the instance of the first section in the Word document + Dim section As WSection = document.Sections(0) + 'Access the instance of the first table in the section + Dim table As WTable = TryCast(section.Tables(0), WTable) + 'Specify the title for the table + table.Title = "PriceDetails" + 'Specify the description of the table + table.Description = "This table shows the price details of various fruits" + 'Specify the left indent of the table + table.IndentFromLeft = 50 + 'Specify the background color of the table + table.TableFormat.BackColor = Color.FromArgb(192, 192, 192) + 'Specify the horizontal alignment of the table + table.TableFormat.HorizontalAlignment = RowAlignment.Left + 'Specify the left, right, top and bottom padding of all the cells in the table + table.TableFormat.Paddings.All = 10 + 'Specify the auto resize of table to automatically resize all cell width based on its content + table.TableFormat.IsAutoResized = True + 'Specify the table top, bottom, left and right border line width + table.TableFormat.Borders.LineWidth = 2.0F + 'Specify the table horizontal border line width + table.TableFormat.Borders.Horizontal.LineWidth = 2.0F + 'Specify the table vertical border line width + table.TableFormat.Borders.Vertical.LineWidth = 2.0F + 'Specify the tables top, bottom, left and right border color + table.TableFormat.Borders.Color = Color.Red + 'Specify the table Horizontal border color + table.TableFormat.Borders.Horizontal.Color = Color.Red + 'Specify the table vertical border color + table.TableFormat.Borders.Vertical.Color = Color.Red + 'Specify the table borders border type + table.TableFormat.Borders.BorderType = BorderStyle.[Double] + 'Access the instance of the first row in the table + Dim row As WTableRow = table.Rows(0) + 'Specify the row height + row.Height = 20 + 'Specify the row height type + row.HeightType = TableRowHeightType.AtLeast + document.Save("TableFormatting.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with + the specified instance. + + The doc. + + + + Gets the cell spacing value + + + + + + Gets the grid count. + + The index. + + + + + Gets the index of the offset. + + The table grid. + The offset. + + + + + Gets the cell offset. + + The index. + + + + + Gets the text wrap around. + + + + + + Sets the text wrap around. + + if set to true [value]. + + + + Clears the absolute position. + + + + + Gets the property value. + + The property key. + + + + + Sets the property value. + + The property key. + The value. + + + + Determines whether this instance has SPRMS. + + + if this instance has SPRMS, set to true. + + + + + Gets table indent. + + + + + Determines whether the specified property key has value. + + The property key. + + if the specified property key has value, set to true. + + + + + Returns the Single Property Modifier Record option value for the specified property. + + + The integer that represents the property key. + The integer that represents the SPRM value. + + + + Removes the changes. + + + + + Updates the row grid before/after width. + + The row. + The grid span. + if set to true [is after width]. + + + + Clears the preferred width properties for Autofit. + + + + + + To Compare RowFormats of two objects and return true if equal else false. + + + + + Apply base style + + + + + + Ensures the composites. + + + + + Returns the composite values. + + + The integer that specifies the key. + The object. + + + + Returns the default values. + + + The integer that specifies the key. + An object that specifies the default value. + + + + Reads object data from xml attributes. + + + The object. + + + + Writes object data as xml attributes. + + + The object. + + + + Registers child objects in XDSL holder. + + + + + + Writes object data as inside xml element. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + The value indicating the presence of xml content. + + + + Occurs on format change. + + + The object. + The integer that represents the property key. + + + + Removes the sprms specific to first row. + + + + + Imports the container. + + The object. + + + + Imports the XML properties. + + The format. + + + + Imports the members. + + + The object. + + + + Removes the positioning. + + + + + Closes this instance. + + + + + Checks the default padding. + + + + + Gets or sets the preferred width of the table. + + The preferred width of the table. + + + + Get grid before width + + + + + Get grid after width + + + + + Gets or sets Grid Before + + + + + Gets or sets GridAfter + + + + + Gets or sets Hidden property of the row + + + + + Gets or sets background color for the table or table row. + + The for the background of table or row. + When the table has no background color, the background color of the first row will be applied to the entire table. + + + + Gets or sets foreground color for the table or table row. + + + + + Gets or sets the texture style. + + The texture style. + + + + Gets the borders for the table or table row. Read-only + + The for the table or row. + The borders specified for the first row in the table will be applied to the entire table when the table has no borders. + + + + Gets the for the table. Read-only. + + The instance that specifies the cell padding values for the entire table. + + + + Gets or sets spacing value between the cells in the table or table row. + + The float that specifies the spacing value. + + + + Gets or sets the value for table left indent. + + The float that specifies the left indent value. + + + + Gets or sets the value indicating whether the table is auto resized based on contents. + + True if automatically resize to fit contents; otherwise false. + + + + Gets or sets the value indicating whether the row can break across pages. + + True if the row can break across pages; otherwise, false. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument("Template.docx"); + WSection section = document.Sections[0]; + WTable table = section.Tables[0] as WTable; + //Disable breaking across pages for all rows in the table. + foreach (WTableRow row in table.Rows) + row.RowFormat.IsBreakAcrossPages = false; + document.Save("Result.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument("Template.docx") + Dim section As WSection = document.Sections(0) + Dim table As WTable = TryCast(section.Tables(0), WTable) + 'Disable breaking across pages for all rows in the table. + For Each row As WTableRow In table.Rows + row.RowFormat.IsBreakAcrossPages = False + Next + document.Save("Result.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets whether the row is a table header. + + + + + Gets or sets a value indicating whether the table is a right to left table. + + True if the table is right to left table; otherwise, false. + + + + Gets or sets horizontal alignment for the table. + + The member that specifies the horizontal alignment for table. + + + + Gets or sets the value determines whether the Default padding values need to be skipped from Writing in DOC format. + + + + + + + + + + Gets the owner table. + + The owner table. + + + + Gets or sets the row height. + + The height. + + + + Gets a value indicating whether cancel on change event. + + true if cancel on change event; otherwise, false. + + + + Gets or sets a value indicating whether to use Around text wrapping. + + True if wrap table around text; otherwise, false. + + + + Gets the positioning values of the table when the text wrapping type is around. Read-only. + + The object that specifies the absolute position of the table. + + + + + + + + + Gets or sets the flag when left indent defined + + + + + To hold the table style name for the old format(To preserve the track changes information properly) + Do not use this property for retrieving table style related information. + + + + + Represents the functionalities to absolute position a table when it has text wrap type as around. + + + The following code example demonstrates how to set the absolute position to a table in the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create an instance of WordDocument class (Empty Word Document) + WordDocument document = new WordDocument(); + //Open an existing Word document into DocIO instance + document.Open("Table.docx", FormatType.Docx); + //Access the instance of the first section in the Word document + WSection section = document.Sections[0]; + //Access the instance of the first table in the section + WTable table = section.Tables[0] as WTable; + //Specify the table positioning options + table.TableFormat.Positioning.HorizPositionAbs = HorizontalPosition.Right; + table.TableFormat.Positioning.HorizRelationTo = HorizontalRelation.Margin; + table.TableFormat.Positioning.VertPositionAbs = VerticalPosition.Center; + table.TableFormat.Positioning.VertRelationTo = VerticalRelation.Page; + table.TableFormat.Positioning.DistanceFromBottom = 10; + table.TableFormat.Positioning.DistanceFromLeft = 10; + table.TableFormat.Positioning.DistanceFromRight = 10; + table.TableFormat.Positioning.DistanceFromTop = 10; + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create an instance of WordDocument class (Empty Word Document) + Dim document As New WordDocument() + 'Open an existing Word document into DocIO instance + document.Open("Table.docx", FormatType.Docx) + 'Access the instance of the first section in the Word document + Dim section As WSection = document.Sections(0) + 'Access the instance of the first table in the section + Dim table As WTable = TryCast(section.Tables(0), WTable) + 'Specify the table positioning options + table.TableFormat.Positioning.HorizPositionAbs = HorizontalPosition.Right + table.TableFormat.Positioning.HorizRelationTo = HorizontalRelation.Margin + table.TableFormat.Positioning.VertPositionAbs = VerticalPosition.Center + table.TableFormat.Positioning.VertRelationTo = VerticalRelation.Page + table.TableFormat.Positioning.DistanceFromBottom = 10 + table.TableFormat.Positioning.DistanceFromLeft = 10 + table.TableFormat.Positioning.DistanceFromRight = 10 + table.TableFormat.Positioning.DistanceFromTop = 10 + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + + + + Initializes a new instance of the class. + + The owner row format. + + + + + + + + + + + Gets the property value. + + The property key. + + + + + Sets the property value. + + The property key. + The value. + + + + Returns the default values. + + + The integer that specifies the key. + An object that specifies the default value. + + + + Comparing the table postioning properties of two objects + + + + + Gets or sets a value indicating whether allow table to overlap]. + + true if allow table to overlap; otherwise, false. + + + + Gets or sets the absolute horizontal position for the table. + + The member that specifies the position. + + + + Gets or sets the absolute vertical position for the table. + + The member that specifies the position. + + + + Gets or sets the horizontal position for the table. + + The float that specifies the vertical position. + + + + Gets or sets the vertical position for the table. + + The float that specifies the vertical position. + + + + Gets or sets the horizontal relation of the table. + + + + + Gets or sets the vertical relation of the table. + + + + + Gets or sets the distance between the table and the text above the table . + + The float that specifies the distance from the top. + + + + Gets or sets the distance between the table and the text below the table. + + The float that specifies the distance from the bottom. + + + + Gets or sets the distance between the table and the text to the left of table. + + The float that specifies the distance from the left. + + + + Gets or sets the distance between the table and the text to the right of table. + + The float that specifies the distance from the right. + + + + Specifies the preferred width information + + + + + Closes the item. + + + + + Initializes a new instance of the class. + + The owner format. + The key. + + + + Gets or sets Preferred width value + + + + + Gets or sets Preferred width type + + + + + Represents the formatting options of the text box such as colors and lines, size, etc. + + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Append new textbox to the paragraph + IWTextBox textbox = paragraph.AppendTextBox(150, 75); + //Add new text to the textbox body + IWParagraph textboxParagraph = textbox.TextBoxBody.AddParagraph(); + textboxParagraph.AppendText("Text inside text box"); + //Set fill color, line width, line dashing and line style for textbox + textbox.TextBoxFormat.FillColor = Color.LightGreen; + textbox.TextBoxFormat.LineWidth = 2; + textbox.TextBoxFormat.LineDashing = LineDashing.Dash; + textbox.TextBoxFormat.LineStyle = TextBoxLineStyle.Double; + //Apply textbox text direction + textbox.TextBoxFormat.TextDirection = Syncfusion.DocIO.DLS.TextDirection.VerticalTopToBottom; + //Set text wrapping style and type + textbox.TextBoxFormat.TextWrappingStyle = TextWrappingStyle.InFrontOfText; + textbox.TextBoxFormat.TextWrappingType = TextWrappingType.Right; + //Set horizontal and vertical position + textbox.TextBoxFormat.HorizontalPosition = 200; + textbox.TextBoxFormat.VerticalPosition = 200; + //Set horizontal and vertical origin + textbox.TextBoxFormat.VerticalOrigin = VerticalOrigin.Margin; + textbox.TextBoxFormat.HorizontalOrigin = HorizontalOrigin.Page; + //Set top and bottom margin values + textbox.TextBoxFormat.InternalMargin.Bottom = 5f; + textbox.TextBoxFormat.InternalMargin.Top = 5f; + //Set horizontal and vertical alignment + textbox.TextBoxFormat.VerticalAlignment = ShapeVerticalAlignment.Bottom; + textbox.TextBoxFormat.HorizontalAlignment = ShapeHorizontalAlignment.Center; + //Save and close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Append new textbox to the paragraph + Dim textbox As IWTextBox = paragraph.AppendTextBox(150, 75) + 'Add new text to the textbox body + Dim textboxParagraph As IWParagraph = textbox.TextBoxBody.AddParagraph() + textboxParagraph.AppendText("Text inside text box") + 'Set fill color, line width, line dashing and line style for textbox + textbox.TextBoxFormat.FillColor = Color.LightGreen + textbox.TextBoxFormat.LineWidth = 2 + textbox.TextBoxFormat.LineDashing = LineDashing.Dash + textbox.TextBoxFormat.LineStyle = TextBoxLineStyle.[Double] + 'Apply textbox text direction + textbox.TextBoxFormat.TextDirection = Syncfusion.DocIO.DLS.TextDirection.VerticalTopToBottom + 'Set text wrapping style and type + textbox.TextBoxFormat.TextWrappingStyle = TextWrappingStyle.InFrontOfText + textbox.TextBoxFormat.TextWrappingType = TextWrappingType.Right + 'Set horizontal and vertical position + textbox.TextBoxFormat.HorizontalPosition = 200 + textbox.TextBoxFormat.VerticalPosition = 200 + 'Set horizontal and vertical origin + textbox.TextBoxFormat.VerticalOrigin = VerticalOrigin.Margin + textbox.TextBoxFormat.HorizontalOrigin = HorizontalOrigin.Page + 'Set top and bottom margin values + textbox.TextBoxFormat.InternalMargin.Bottom = 5.0F + textbox.TextBoxFormat.InternalMargin.Top = 5.0F + 'Set horizontal and vertical alignment + textbox.TextBoxFormat.VerticalAlignment = ShapeVerticalAlignment.Bottom + textbox.TextBoxFormat.HorizontalAlignment = ShapeHorizontalAlignment.Center + 'Save and close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + + + + TextBoxFormat class members + + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + Clears the textbox format applied + + + + + Returns the default text box values. + + + The integer that specifies the key. + Null (don't use keys ). + + + + Reads object data from xml attributes. + + + The object. + + + + Writes object data as xml attributes. + + + The object. + + + + Returns the value indicating whether the key exists in the properties collection. + + The integer that specifies the key. + True if the specified key is present, otherwise false. + + + + Sets the property value. + + The prop key. + The value. + + + + Closes this instance. + + + + + Creates a duplicate copy of the text box format object. + + The reference to the newly created object. + + + + Clones the relations. + + The doc. + + + + + Compares the current text box format with another text box format. + + + + + + + Gets the properties text for Word comparison + + + + + + + Updates the fill effects. + + The container. + The doc. + + + + Sets the TextWrappingStyle,specific for parsers. + + TextWrapStyle + + + + Gets or sets a value indicate whether current wrapping bounds points added to the list or not. + + + true if this instance is wrapping bounds added; otherwise, false. + + + + + Gets or sets the horizontal width origin value. + + The member that specifies the width origin value. + + + + Gets or sets the vertical height origin value. + + The member that specifies the height origin value. + + + + Gets or sets the horizontal origin of the text box. + + The member that specifies the horizontal origin value. + + + + Gets or sets the vertical origin of the text box. + + The member that specifies the vertical origin value. + + + + Gets or sets the text Wrapping style of the text box. + + The member that specifies the text wrapping style. + + + + DistanceBottom Returns or sets the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. Read/write Single. + + + + + DistanceLeft Returns or sets the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. Read/write Single. + + + + + DistanceRight Returns or sets the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. Read/write Single. + + + + + DistanceTop Returns or sets the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. Read/write Single. + + + + + Gets or sets the fill color for the text box. + + The that specifies the fill color. + + + + Gets or sets the line style for the text box. + + The member that specifies the line style. + + + + Gets or sets the width(in points) of the text box. + + The float that specifies the width. + + + + Gets or sets the height(in points) of the text box. + + The float that specifies the height. + + + + Gets or sets the line color of the text box. + + The that specifies the line color. + + + + Gets or sets a value indicating whether the textbox has no line around its shape. + + True if the textbox has no line; otherwise, false. + + + + Gets or sets textbox wrapping mode + + + + + Gets or sets the horizontal position of the text box. + + The float specifies the horizontal position. + + + + Gets or sets true/false value of IsBelowText property + + + + + Gets or sets the vertical position of the text box. + + The float specifies the vertical position. + + + + Gets or sets the text wrapping type for the text box. + + The member that specifies the wrapping type. + + + + Gets or sets texbox's shape identifier + + + + + Gets or sets the line width of the text box. + + The float that specifies the line width. + + + + Gets or sets the line dashing style for the text box. + + The member that specifies the line dashing style. + + + + Gets or sets the horizontal alignment of the text box. + + member that specifies the horizontal alignment. + + If the alignment is set as None, then the text box is explicitly positioned using position properties. + Otherwise it is positioned according to the alignment specified. The position of the object is relative to . + + + + + Gets or sets the vertical alignment of the text box. + + member that specifies the vertical alignment. + + If the alignment is set as None, then the text box is explicitly positioned using position properties. + Otherwise it is positioned according to the alignment specified. The position of the object is relative to . + + + + + Gets or sets vertical alignment of the text in textbox. + + The member that specifies the text vertical alignment. + + Vertical text alignment for textbox is applicable for DOCX format only. + + + + //Creates a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Appends new textbox to the paragraph + IWTextBox textbox = paragraph.AppendTextBox(150, 50); + //Adds new text to the textbox body + IWParagraph textboxParagraph = textbox.TextBoxBody.AddParagraph(); + textboxParagraph.AppendText("Text inside text box"); + //Sets vertical alignment of the text + textbox.TextBoxFormat.TextVerticalAlignment = VerticalAlignment.Bottom; + //Save and close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Creates a new Word document + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + 'Adds new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Appends new textbox to the paragraph + Dim textbox As IWTextBox = paragraph.AppendTextBox(150, 50) + 'Adds new text to the textbox body + Dim textboxParagraph As IWParagraph = textbox.TextBoxBody.AddParagraph() + textboxParagraph.AppendText("Text inside text box") + 'Sets vertical alignment of the text + textbox.TextBoxFormat.TextVerticalAlignment = VerticalAlignment.Bottom + 'Save and close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets or sets textbox identifier; + + + + + + + + + + Gets the internal margin for the text box. + + The instance that specifies the margin values. + + + + Gets or sets the textbox rotation in degree. + + The float that specifies the rotation value of the textbox. + A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. + + The following code example demonstrates how to gets or sets the rotation value of textbox in degree. + + //Creates a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Appends new textbox to the paragraph + IWTextBox textbox = paragraph.AppendTextBox(150, 75); + //Adds new text to the textbox body + IWParagraph textboxParagraph = textbox.TextBoxBody.AddParagraph(); + textboxParagraph.AppendText("Text inside text box"); + //Sets textbox rotation in degree + textbox.TextBoxFormat.Rotation = 90; + //Saves and closes the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Creates a new Word document + Dim document As WordDocument = New WordDocument + 'Adds new section to the document + Dim section As IWSection = document.AddSection + 'Adds new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph + 'Appends new textbox to the paragraph + Dim textbox As IWTextBox = paragraph.AppendTextBox(150, 75) + 'Adds new text to the textbox body + Dim textboxParagraph As IWParagraph = textbox.TextBoxBody.AddParagraph + textboxParagraph.AppendText("Text inside text box") + 'Sets textbox rotation in degree + textbox.TextBoxFormat.Rotation = 90 + 'Saves and closes the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets or sets a Horizontal flipping of TextBox. + + + true indicates that a textbox has been flipped horizontally; otherwise, false. + + This property returns True if the specified textbox is flipped around the horizontal axis, and False if not. + + The following code example demonstrates how to gets or sets the horizontal flip to textbox. + + //Creates a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Appends new textbox to the paragraph + IWTextBox textbox = paragraph.AppendTextBox(150, 75); + //Adds new text to the textbox body + IWParagraph textboxParagraph = textbox.TextBoxBody.AddParagraph(); + textboxParagraph.AppendText("Text inside text box"); + //Sets horizontal flip to the textbox + textbox.TextBoxFormat.FlipHorizontal = true; + //Saves and closes the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Creates a new Word document + Dim document As WordDocument = New WordDocument + 'Adds new section to the document + Dim section As IWSection = document.AddSection + 'Adds new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph + 'Appends new textbox to the paragraph + Dim textbox As IWTextBox = paragraph.AppendTextBox(150, 75) + 'Adds new text to the textbox body + Dim textboxParagraph As IWParagraph = textbox.TextBoxBody.AddParagraph + textboxParagraph.AppendText("Text inside text box") + 'Sets horizontal flip to the textbox + textbox.TextBoxFormat.FlipHorizontal = True + 'Saves and closes the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets or sets a Vertical flipping of TextBox. + + + true indicates that a textbox has been flipped vertically; otherwise, false. + + This property returns True if the specified textbox is flipped around the vertical axis, and False if not. + + The following code example demonstrates how to gets or sets the vertical flip to textbox. + + //Creates a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Appends new textbox to the paragraph + IWTextBox textbox = paragraph.AppendTextBox(150, 75); + //Adds new text to the textbox body + IWParagraph textboxParagraph = textbox.TextBoxBody.AddParagraph(); + textboxParagraph.AppendText("Text inside text box"); + //Sets vertical flip to the textbox + textbox.TextBoxFormat.FlipVertical = true; + //Saves and closes the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Creates a new Word document + Dim document As WordDocument = New WordDocument + 'Adds new section to the document + Dim section As IWSection = document.AddSection + 'Adds new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph + 'Appends new textbox to the paragraph + Dim textbox As IWTextBox = paragraph.AppendTextBox(150, 75) + 'Adds new text to the textbox body + Dim textboxParagraph As IWParagraph = textbox.TextBoxBody.AddParagraph + textboxParagraph.AppendText("Text inside text box") + 'Sets vertical flip to the textbox + textbox.TextBoxFormat.FlipVertical = True + 'Saves and closes the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets the background fill effects of the text box. + + The instance that specifies the fill effects. + + + + Gets or sets a value indicating whether allow textbox in cell. + + if allow in cell, set to true. + + + + Gets or sets the index of the order. + + The index of the order. + + + + Gets the docx style properties. + + The docx style props. + + + + Gets a value indicating whether this instance has docx props. + + + if this instance has docx props, set to true. + + + + + Gets or set a value indicating whether the TextBox is sized automatically based on the contents. + + + True, if resize text box to fit the contents; otherwise false. + + The default value is false. + + + + //Creates a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Appends new textbox to the paragraph + IWTextBox textbox = paragraph.AppendTextBox(150, 50); + //Adds new text to the textbox body + IWParagraph textboxParagraph = textbox.TextBoxBody.AddParagraph(); + textboxParagraph.AppendText("Text inside text box text inside text box text inside text box."); + //Resize the textbox based on its contents + textbox.TextBoxFormat.AutoFit = true; + //Save and close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Creates a new Word document + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + 'Adds new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Appends new textbox to the paragraph + Dim textbox As IWTextBox = paragraph.AppendTextBox(150, 50) + 'Adds new text to the textbox body + Dim textboxParagraph As IWParagraph = textbox.TextBoxBody.AddParagraph() + textboxParagraph.AppendText("Text inside text box text inside text box text inside text box.") + 'Resize the textbox based on its contents + textbox.TextBoxFormat.AutoFit = True + 'Save and close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets or sets the width relative percent. + + The width relative percent. + + + + Gets or sets the height relative percent. + + The height relative percent. + + + + Gets or sets the horizontal relative percent. + + The horizontal relative percent. + + + + Gets or sets the vertical relative percent. + + The vertical relative percent. + + + + Gets or sets the text direction for the text box. + + The member that specifies the text direction type. + + + + Gets/sets Text Theme color. + + + + + Gets or sets a value indicating whether this textbox can overlap other textboxes. + + + True, if allow textbox to overlap other textboxes; otherwise false. + + + The default value is true. + + + + //Creates a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Appends new textbox to the paragraph + IWTextBox textbox = paragraph.AppendTextBox(150, 50); + //Adds new text to the textbox body + IWParagraph textboxParagraph = textbox.TextBoxBody.AddParagraph(); + textboxParagraph.AppendText("Text inside text box text inside text box text inside text box."); + //Allow the textbox to overlap other textboxes + textbox.TextBoxFormat.AllowOverlap = true; + //Save and close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Creates a new Word document + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + 'Adds new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Appends new textbox to the paragraph + Dim textbox As IWTextBox = paragraph.AppendTextBox(150, 50) + 'Adds new text to the textbox body + Dim textboxParagraph As IWParagraph = textbox.TextBoxBody.AddParagraph() + textboxParagraph.AppendText("Text inside text box text inside text box text inside text box.") + 'Allow the textbox to overlap other textboxes + textbox.TextBoxFormat.AllowOverlap = True + 'Save and close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets or sets the wrap polygon. + + + The wrap polygon. + + + + + Gets the additional docx properties. + + The docx props. + + + + Gets or Sets the path + + + + + Gets or sets the Coordinate size of the shape or chart. + + The for the shape or chart. + + + + Gets or sets the Coordinate X Origin of the shape or chart. + + The for the shape or chart. + + + + Gets or sets the Coordinate Y Origin of the shape or chart. + + The for the shape or chart. + + + + Gets a VML Path points to draw. + + + + + Represents the internal margin for the text box. + + + + + + + + + + + Member to hold the collection of properties values and its keys. + + + + + Initializes a new instance of the class. + + + + + Returns the value indicating whether the key exists in the properties collection. + + The integer that specifies the key. + True if the specified key is present, otherwise false. + + + + Sets the property value. + + The prop key. + The value. + + + + Set the default internal margins for shape and textbox when creating using DocIO in scratch. + + + + + Clones this instance. + + + + + + Compares the current internal margin with another internal margin of another document. + + + + + + + Gets the properties text for Word comparison + + + + + + + Gets or sets the internal left margin (in points). + + The float that specifies the internal left margin. + + + + Gets or sets the internal right margin (in points). + + The float that specifies the internal right margin. + + + + Gets or sets the internal top margin (in points). + + The float that specifies the internal top margin. + + + + Gets or sets the internal bottom margin (in points). + + The float that specifies the internal bottom margin. + + + + Gets or sets the value for the property with specified key. + + The key for the property. + An object with the specific key. + + + + Properties Collection + + + + + Initializes a new instance of the class. + + + + + Copy source wrapformat to destination wrapformat + + + + + + + Compare the properties of source wrapformat with destination wrapformat + + + True, if the list matches, else false + + + + Gets the WrapPolygon text for Word comparison + + + + + + Gets or sets a value indicating whether this is edited. + + + true if edited; otherwise, false. + + + + + Gets or sets the vertices. + + + The vertices. + + + + + Represents the implementation to get the instance. + + + + + + + + + + Initializes the object. + + The object. + + + + Registers the specified converter. + + The object. + + + + Summary description for XmlTableFormat. + + + + + Initializes a new instance of the class. + + The owner. + + + + Clones the specified owner table. + + The owner table. + + + + + Closes this instance. + + + + + Gets the node array with unparsed table properties. + + The node array. + + + + Gets or sets the name of the table style. + + The name of the style. + + + + Gets the format. + + The format. + + + + Gets a value indicating whether this instance has format. + + + if this instance has format, set to true. + + + + + Gets the owner. + + The owner. + + + + Represents a collection of objects. + + + + + Gets the at the specified index. + + The zero-based index of the Word document to get + The at the specified index + The index is not valid index in the + + + + Represents a block content control in the Word document. + + + + + Gets the content control properties. Read-only. + + The object that specifies the content control properties. + The following example illustrates how to set the properties for content control. + + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + IBlockContentControl control = section.Body.AddBlockContentControl(ContentControlType.RichText); + //Adds new paragraph to the section. + WParagraph paragraph = new WParagraph(control.Document); + //Adds new text to the content control. + paragraph.AppendText("Block content control"); + //Adds pagagraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph); + //Sets title of the block content control. + control.ContentControlProperties.Title = "Rich text content control"; + //Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + Dim control As New BlockContentControl(document, ContentControlType.RichText) + 'Adds new paragraph to the section. + Dim paragraph As New WParagraph(control.Document) + 'Adds new text to the content control. + paragraph.AppendText("Block content control") + 'Adds pagagraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph) + 'Sets title of the block content control. + control.ContentControlProperties.Title = "Rich text content control" + 'Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Gets the character format of the content control. Read-only. + + The object that specifies the character format. + + + + Gets the block control text body. Read-only. + + The following example illustrates how to get the text body of the content control. + + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + IBlockContentControl control = section.Body.AddBlockContentControl(ContentControlType.RichText); + //Adds new paragraph to the section. + WParagraph paragraph = new WParagraph(control.Document); + //Adds new text to the content control. + paragraph.AppendText("Block content control"); + //Adds pagagraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph); + //Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + Dim control As New BlockContentControl(document, ContentControlType.RichText) + 'Adds new paragraph to the section. + Dim paragraph As New WParagraph(control.Document) + 'Adds new text to the content control. + paragraph.AppendText("Block content control") + 'Adds pagagraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph) + 'Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Represents a inline content control in the Word document. + + + + + Gets the content control properties. Read-only. + + The object that specifies the content control properties. + The following example illustrates how to set the properties for content control. + + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Adds new rich text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText); + //Adds new text to the content control + WTextRange textRange = new WTextRange(document); + textRange.Text = "Rich Text Content Control"; + (paragraph.Items.LastItem as IInlineContentControl).ParagraphItems.Add(textRange); + IInlineContentControl richTextControl = paragraph.Items.LastItem as IInlineContentControl; + richTextControl.ParagraphItems.Add(textRange); + // Sets Title property of the content control. + richTextControl.ContentControlProperties.Title = "Rich text content control"; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + 'Adds new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Adds new rich text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText) + 'Adds new text to the content control + Dim textRange As New WTextRange(document) + textRange.Text = "Rich Text Content Control" + TryCast(paragraph.Items.LastItem, IInlineContentControl).ParagraphItems.Add(textRange) + Dim richTextControl As IInlineContentControl = TryCast(paragraph.Items.LastItem, IInlineContentControl) + richTextControl.ParagraphItems.Add(textRange) + ' Sets Title property of the content control. + richTextControl.ContentControlProperties.Title = "Rich text content control" + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Gets the character format of the content control. Read-only. + + The object that specifies the character format. + + + + Gets the content control items. Read-only. + + The of the current control. + The following example illustrates how to get the paragraph items of the current inline content control. + + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Adds new rich text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText); + //Adds new text to the content control + WTextRange textRange = new WTextRange(document); + textRange.Text = "Rich Text Content Control"; + (paragraph.Items.LastItem as IInlineContentControl).ParagraphItems.Add(textRange); + IInlineContentControl richTextControl = paragraph.Items.LastItem as IInlineContentControl; + richTextControl.ParagraphItems.Add(textRange); + // Sets Title property of the content control. + richTextControl.ContentControlProperties.Title = "Rich text content control"; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + 'Adds new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Adds new rich text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText) + 'Adds new text to the content control + Dim textRange As New WTextRange(document) + textRange.Text = "Rich Text Content Control" + TryCast(paragraph.Items.LastItem, IInlineContentControl).ParagraphItems.Add(textRange) + Dim richTextControl As IInlineContentControl = TryCast(paragraph.Items.LastItem, IInlineContentControl) + richTextControl.ParagraphItems.Add(textRange) + ' Sets Title property of the content control. + richTextControl.ContentControlProperties.Title = "Rich text content control" + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Represents a field. + + + + + Represents the text in the Word document. + + + + + Applies the specified character format to the text. + + The to be applied to the text. + The following example illustrates how to add a text to the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + document.EnsureMinimal(); + //Add new text + IWTextRange text = document.LastParagraph.AppendText("Hello world"); + //Initialize character format + WCharacterFormat characterformat = new WCharacterFormat(document); + characterformat.Bold = true; + characterformat.Italic = true; + characterformat.TextColor = Color.Blue; + //Apply character format + text.ApplyCharacterFormat(characterformat); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + document.EnsureMinimal() + 'Add new text + Dim text As IWTextRange = document.LastParagraph.AppendText("Hello world") + 'Initialize character format + Dim characterformat As New WCharacterFormat(document) + characterformat.Bold = True + characterformat.Italic = True + characterformat.TextColor = Color.Blue + 'Apply character format + text.ApplyCharacterFormat(characterformat) + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets the text. + + + + + Gets the character format(font properties) of the text. Read-only. + + + + + Updates the field result for this . + + + Essential DocIO currently support the updating of field result for the following field types only: + + = (formula field) + DATE + TIME + DOCVARIABLE + DOCPROPERTY + COMPARE + IF + NEXTIF + MERGEREC + MERGESEQ + SECTION + NUMPAGES + TITLE + Cross-Reference + + Also while updating of NUMPAGES field and Cross Reference field with Page number and Paragraph number options are not supported in Silverlight, WinRT, Universal, Windows Phone and Xamarin applications. + Currently group shapes, drawing canvas, and table auto resizing are not supported in Word to PDF lay outing, and this may lead to update incorrect page number and total number of pages. + + + + + Replaces the field with its most recent result. + + + When you unlink a field, its current result is converted to text or a graphic and can no longer be updated automatically. + Note that the fields such as XE (Index Entry) fields and SEQ (Sequence) fields cannot be unlinked. + + + + + Gets or sets the text format field switch that defines how to display field results. + + + + + Gets or sets field type. + + the represents the type of the field. + + + + Gets or sets the field code. + + The field code information used to evaluate the resultant value of the field. + + + + Represents a mail merge field. + + + + + Gets or sets mail merge field name. + + + + + Gets or sets the text that is displayed before the merge field. + + + + + Gets or sets the text that is displayed after the merge field. + + + + + Gets the prefix of merge field. Read-only. + + + + + Gets the number format of the merge field. Read-only. + + + + + Gets the date format of the merge field. Read-only. + + + + + Represents a picture in a word document. + + + + + Loads the image from the specified instance. + + The instance. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform and Xamarin platforms. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Initialize new picture + WPicture picture = new WPicture(document); + //Load image from the file + picture.LoadImage(Image.FromFile("Image.png")); + //Set width and height + picture.Height = 100; + picture.Width = 150; + //Add picture to the paragraph + paragraph.Items.Add(picture); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Initialize new picture + Dim picture As New WPicture(document) + 'Load image from the file + picture.LoadImage(Image.FromFile("Image.png")) + 'Set width and height + picture.Height = 100 + picture.Width = 150 + 'Add picture to the paragraph + paragraph.Items.Add(picture) + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Loads the image from the specified byte array. + + The byte array that specifies the image as bytes. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Get the image and convert to byte array + Image image = Image.FromFile("Image.png"); + MemoryStream imageStream = new MemoryStream(); + image.Save(imageStream, System.Drawing.Imaging.ImageFormat.Png); + byte[] imageBytes = imageStream.ToArray(); + //Initialize new picture + WPicture picture = new WPicture(document); + //Load image from the byte array + picture.LoadImage(imageBytes); + //Set width and height + picture.Height = 100; + picture.Width = 150; + //Add picture to the paragraph + paragraph.Items.Add(picture); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Get the image and convert to byte array + Dim image__1 As Image = Image.FromFile("Image.png") + Dim imageStream As New MemoryStream() + image__1.Save(imageStream, System.Drawing.Imaging.ImageFormat.Png) + Dim imageBytes As Byte() = imageStream.ToArray() + 'Initialize new picture + Dim picture As New WPicture(document) + 'Load image from the byte array + picture.LoadImage(imageBytes) + 'Set width and height + picture.Height = 100 + picture.Width = 150 + 'Add picture to the paragraph + paragraph.Items.Add(picture) + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Get the SVG image as byte array. + byte[] imageBytes = File.ReadAllBytes("Image.png"); + //Get the SVG image as byte array. + byte[] svgData = File.ReadAllBytes("Image.svg"); + //Initialize new picture + WPicture picture = new WPicture(document); + //Load both fallback and SVG image from the byte array + picture.LoadImage(svgData, imageBytes); + //Set width and height + picture.Height = 100; + picture.Width = 150; + //Add picture to the paragraph + paragraph.Items.Add(picture); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Get the image byte array + Dim imageBytes As Byte() = File.ReadAllBytes("Image.png") + 'Get the SVG image as byte array. + Dim svgData As Byte() = File.ReadAllBytes("Image.svg") + 'Initialize new picture + Dim picture As New WPicture(document) + 'Load both fallback and SVG image from the byte array + picture.LoadImage(svgData, imageBytes) + 'Set width and height + picture.Height = 100 + picture.Width = 150 + 'Add picture to the paragraph + paragraph.Items.Add(picture) + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Adds caption for the current picture with specified name, caption format and caption position. + + The string that specifies the name. + The member that specifies the format for caption numbering. + The member that specifies the position of caption. + The paragraph instance with the specified caption. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("This paragraph has picture. "); + //Append new picture to the paragraph + IWPicture picture = paragraph.AppendPicture(Image.FromFile("Image.png")); + //Set width and height for the paragraph + picture.Width = 150; + picture.Height = 100; + //Set caption for picture + picture.AddCaption("Figure 1.1", CaptionNumberingFormat.Number, CaptionPosition.AboveImage); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("This paragraph has picture. ") + 'Append new picture to the paragraph + Dim picture As IWPicture = paragraph.AppendPicture(Image.FromFile("Image.png")) + 'Set width and height for the paragraph + picture.Width = 150 + picture.Height = 100 + 'Set caption for picture + picture.AddCaption("Figure 1.1", CaptionNumberingFormat.Number, CaptionPosition.AboveImage) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Gets or sets the picture height in points + + The float that specifies the height. + + + + Gets or sets the picture width in points. + + The float that specifies the width. + + + + Gets or sets the picture height scale factor in percent. + + The float that specifies the height scale factor. + + + + Gets or sets the picture width scale factor in percent. + + The float that specifies the width scale factor. + + + + Gets or sets the picture rotation in degree. + + The float that specifies the rotation value of the picture. + A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. + + + + Gets or sets a Horizontal flipping of Picture. + + + true indicates that a picture has been flipped horizontally; otherwise, false. + + This property returns True if the specified picture is flipped around the horizontal axis, and False if not. + + The following code example demonstrates how to gets or sets the horizontal flip to picture. + + //Creates a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new text to the paragraph + IWParagraph paragraph = section.AddParagraph(); + //Gets the image and convert to byte array + Image image = Image.FromFile("Image.png"); + MemoryStream imageStream = new MemoryStream(); + image.Save(imageStream, System.Drawing.Imaging.ImageFormat.Png); + byte[] imageBytes = imageStream.ToArray(); + //Initializes new picture + WPicture picture = new WPicture(document); + //Loads an image from the byte array + picture.LoadImage(imageBytes); + //Sets height and width for the image + picture.Height = 100; + picture.Width = 150; + //Sets horizontal flip to the picture + picture.FlipHorizontal = true; + //Adds image to the paragraph + paragraph.Items.Add(picture); + //Saves the Word document + document.Save("Sample.docx", FormatType.Docx); + //Closes the document + document.Close(); + + + 'Creates a New Word document + Dim document As WordDocument = New WordDocument + 'Adds new section to the document + Dim section As IWSection = document.AddSection + 'Adds new text to the paragraph + Dim paragraph As IWParagraph = section.AddParagraph + 'Gets the image and convert to byte array + Dim image As Image = Image.FromFile("Image.png") + Dim imageStream As MemoryStream = New MemoryStream + image.Save(imageStream, System.Drawing.Imaging.ImageFormat.Png) + Dim imageBytes() As Byte = imageStream.ToArray + 'Initializes new picture + Dim picture As WPicture = New WPicture(document) + 'Loads an image from the byte array + picture.LoadImage(imageBytes) + 'Sets height and width for the image + picture.Height = 100 + picture.Width = 150 + 'Sets horizontal flip to the picture + picture.FlipHorizontal = True + 'Adds image to the paragraph + paragraph.Items.Add(picture) + 'Saves the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Closes the document + document.Close() + + + + + + Gets or sets a Vertical flipping of Picture. + + + true indicates that a picture has been flipped vertically; otherwise, false. + + This property returns True if the specified picture is flipped around the vertical axis, and False if not. + + The following code example demonstrates how to gets or sets the vertical flip to picture. + + //Creates a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new text to the paragraph + IWParagraph paragraph = section.AddParagraph(); + //Gets the image and convert to byte array + Image image = Image.FromFile("Image.png"); + MemoryStream imageStream = new MemoryStream(); + image.Save(imageStream, System.Drawing.Imaging.ImageFormat.Png); + byte[] imageBytes = imageStream.ToArray(); + //Initializes new picture + WPicture picture = new WPicture(document); + //Loads an image from the byte array + picture.LoadImage(imageBytes); + //Sets height and width for the image + picture.Height = 100; + picture.Width = 150; + //Sets vertical flip to the picture + picture.FlipVertical = true; + //Adds image to the paragraph + paragraph.Items.Add(picture); + //Saves the Word document + document.Save("Sample.docx", FormatType.Docx); + //Closes the document + document.Close(); + + + 'Creates a New Word document + Dim document As WordDocument = New WordDocument + 'Adds new section to the document + Dim section As IWSection = document.AddSection + 'Adds new text to the paragraph + Dim paragraph As IWParagraph = section.AddParagraph + 'Gets the image and convert to byte array + Dim image As Image = Image.FromFile("Image.png") + Dim imageStream As MemoryStream = New MemoryStream + image.Save(imageStream, System.Drawing.Imaging.ImageFormat.Png) + Dim imageBytes() As Byte = imageStream.ToArray + 'Initializes new picture + Dim picture As WPicture = New WPicture(document) + 'Loads an image from the byte array + picture.LoadImage(imageBytes) + 'Sets height and width for the image + picture.Height = 100 + picture.Width = 150 + 'Sets vertical flip to the picture + picture.FlipVertical = True + 'Adds image to the paragraph + paragraph.Items.Add(picture) + 'Saves the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Closes the document + document.Close() + + + + + + Gets the instance that represents the picture. Read-only. + + The instance. + This property is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + + Gets the SVG image as byte array. Read-only. + + The array that represents SVG image bytes. + + + + Gets the image as byte array. Read-only. + + The array that represents image bytes. + + + + Gets or sets the horizontal origin of the picture. + + The member that specifies the horizontal origin. + + + + Gets or sets the vertical origin of the picture. + + The member that specifies the vertical origin. + + + + Gets or sets absolute horizontal position of the picture in points. + + The float that specifies the horizontal position. + + The horizontal position is relative to the . + + + + + Gets or sets absolute vertical position of the picture in points. + + The float that specifies the vertical position. + + The vertical position is relative to the . + + + + + Gets or sets the text wrapping style of the picture. + + The member that specifies the text wrapping style. + + + + Gets or sets the text wrapping type of the picture. + + The member that specifies the text wrapping type. + + + + Gets or sets a value indicating whether the picture is below the text. + + True if the picture is below text; otherwise, false. + + + + Gets or sets the horizontal alignment of the picture. + + The member that specifies the horizontal alignment. + + If the alignment is set as None, then the picture is explicitly positioned using position properties. + Otherwise it is positioned according to the alignment specified. The position of the object is relative to . + + + + + Gets or sets the vertical alignment of the picture. + + + If the alignment is set as None, then the picture is explicitly positioned using position properties. + Otherwise it is positioned according to the alignment specified. The position of the object is relative to . + + + + + Gets or sets the alternate text for the picture. + + The string that represents the alternate text. + + + + Gets or sets the name of the picture. + + The string that represents the name. + + + + Gets or sets the picture title. + + The string that represents the title. + + + + Gets or sets a value indicating whether the picture is visible. + + + True if the picture is visible; otherwise, false. + + + + + Gets the character format(font properties) of the picture. Read-only. + + + + + Represents the text box. + + + + + Gets or sets the name of the text box. + + + The string that represents the name. + + + + + Gets or sets a value indicating whether this is visible. + + + True if visible; otherwise, false. + + + + + Gets the child elements of the text box. Read-only. + + The collection of child elements. + + + + Gets the text body of the text box. Read-only. + + + + + Gets or sets the text box format. + + + + + Represents the style that can be used to format a characters inside the paragraph. + + + + + Gets or sets a value indicating whether this instance is primary style. + + + if this instance is primary style, set to true. + + + + + Gets formatting of characters inside paragraph. + + + + + Represents the style that can be used to format a Paragraph. + + + + + Closes this instance. + + + + + Gets or sets a value indicating whether this instance is primary style. + + + if this instance is primary style, set to true. + + + + + Gets formatting of paragraph. + + + + + Gets formatting of characters inside paragraph. + + + + + Represents the style of the . + + + + + Gets the paragraph format. + + The object. + + + + Represent a Absolute Tab. + + + + + Initializes a new instance of the class. + + Document + + + + Get the tab position. + + + + + Get the tab position relative to margin. + + + + + Get the tab position relative to indent. + + + + + Get Base Entity + + + + + + + Get cell width + + + the cell width + + + + Get left padding of table cell + + + the left padding + + + + Get right padding of table cell + + + the right padding + + + + Attaches to paragraph. + + The paragraph. + The item pos. + + + + Detaches from owner. + + + + + Writes object data as xml attributes. + + The object. + + + + Reads object data from xml attributes. + + The object. + + + + Registers child objects in XDSL holder. + + + + + Closes this instance. + + + + + Create LayoutInfo + + + + + Measures self size. + + + + + + + Get Absolute Tab position to layout in Doc to PDF conversion + + + + + + Gets absolute position for the absolut tab. + + + + + + + + Initializing LayoutInfo value to null + + + + + Gets/sets Character format. + + + + + Gets the Absolute Tab position. + + The Absolute Tab position. + + + + Gets the type of the entity. + + The of the current item. + + + + Gets or Sets the Absolute Tab alignment. + + The Absolute Tab alignment. + + + + Gets or Sets the Absolute Tab relation. + + The Absolute Tab relation. + + + + Gets or Sets the Absolute Tab Leader. + + The Absolute Tab Leader. + + + + Gets/sets Character format. + + + + + Represents the end position of the + in the document. + + + + + + + + + Initializes a new instance of the class. + + The doc. + + + + Initializes a new instance of the class with the specified + and name. + + The object. + The string that represents the name. + + + + Closes the item. + + + + + Sets the name. + + The name. + + + + Attaches to paragraph. + + + + + + + Detaches from owner. + + + + + + + + + + Creates a duplicate copy of the entity. + + + An object that is newly created. + + + + Checks whether any renderable item before the bookmark end in Owner paragraph + + Returns true, if contains renderable item before bookmark end. Otherwise false + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Creates layout information. + + + + + + Measures the specified Custom Graphics. + + The Custom Graphics. + + + + + Gets the type of the entity. + + The of the current item. + + + + Gets the bookmark name. + + The string that represents the bookmark end name in the document. + + + + Gets/sets IsCellGroupBkmk value. + + + + + Specifies whether the Bookmark is detached (For both cases either cloned or removed from collection) from the Bookmarks collection. + + + + + Get/Set if the bookmark end is preserved after the Paragraph mark + + + + + Get/Set if the bookmark end is preserved after the TableCell mark + + + + + Get/Set if the bookmark end is preserved after the TableRow mark + + + + + Get/Set if the bookmark end is preserved after the Table mark + + + + + Gets or sets whether the bookmark end need to serialize in next paragraph. + + + + + Gets or sets the displacedByCustomXml value for bookmarks end. + + The DisplacedByCustomXml. + + This element only has an effect when the custom XML element is block-level(i.e.surrounds an entire paragraph), + as in this scenario the logical and physical placement of the annotation and custom XML element can differ. + + + + + Represents the end position of the + in the document. + + + + + + + + Initializes a new instance of the class. + + The doc. + + + + Initializes a new instance of the class with the specified + and name. + + The object. + The string that represents the id. + + + + Sets the id. + + Represents the id. + + + + Attaches to paragraph. + + + + + + + Detaches from owner. + + + + + Attach the editable range to the document. + + + + + Creates a duplicate copy of the entity. + + + An object that is newly created. + + + + Closes the item. + + + + + Creates layout information for + + + + + Gets the type of the entity. + + The of the current item. + + + + Gets the editable range id. + + The string that represents the editable range end id in the document. + + + + Get/Set if the editable range end is preserved after the Paragraph mark + + + + + Get/Set if the editabler range end is preserved after the TableCell mark + + + + + Get/Set if the editable range end is preserved after the TableRow mark + + + + + Get/Set if the editable range end is preserved after the Table mark + + + + + Denotes whether it is detached editable range end. + + + + + Represents the start position of the + in the document. + + + + + + + + + + + + + + Initializes a new instance of the class. + + The doc. + + + + Initializes a new instance of the class with the specified + and name. + + The object. + The string that represents the name. + + + + Sets the bookmark name. + + The name. + + + + Attaches to paragraph. + + + + + + + Detaches from owner. + + + + + Clones the relations. + + + + + Creates a duplicate copy of the entity. + + + An object that is newly created. + + + + Closes the item. + + + + + Get the bookmark content in different cells in a single table + + Bookmark start or bookmark end owner table + Bookmark start owner table row index + Bookmark end owner table row index + Bookmark start owner cell index + Bookmark end owner cell index + Temporary textbody to store the textbody items + + + + Gets the maximum cell count of row in the table + + + + + + + + + Remove bookmark start and end from its owner cell when getting bookmatk content + + Current table cell to check + The WTableCell + + + + Get the exact bookmark start and bookmark end cell + + Current bookmark start owner cell + Current bookmark end owner cell + Temporary bookmark end cell + Bookmark start owner table + Bookmark end owner table + Current bookmark start + Current bookmark end + Bookmark start owner row index + Bookmark end owner row index + Bookmark start owner cell index + Bookmark end owner cell index + + + + Extends the cell range to get complete merged cell for horizontal merge cells + + Current bookmark start owner cell + Current bookmark end owner cell + Bookmark start owner table + Bookmark end owner table + Bookmark start owner row index + Bookmark end owner row index + Bookmark start owner cell index + Bookmark end owner cell index + + + + Determines whether bookmark end is in nested table at the same cell of bookmark start. + + Represents of + Represents of + Represents of + Represents an index of contains + + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Creates layout information. + + + + + + + + + + + + + Initializing LayoutInfo value to null + + + + + Gets the type of the entity. + + The of the current item. + + + + Gets the name of bookmark start. + + The string that represents the name of bookmark start. + + + + Gets or sets IsCellGroupBkmk value. + + + + + Specifies whether the Bookmark is detached (For both cases either cloned or removed from collection) from the Bookmarks collection. + + + + + Gets or sets the index of the column where bookmark starts. + + The column first. + + + + Gets or sets the index of the column where bookmarks ends. + + The column last. + + + + Gets or sets the displacedByCustomXml value for bookmarks start. + + The DisplacedByCustomXml. + + This element only has an effect when the custom XML element is block-level(i.e.surrounds an entire paragraph), + as in this scenario the logical and physical placement of the annotation and custom XML element can differ. + + + + + Represents the start position of the + in the document. + + + + + + + + + + + + + Initializes a new instance of the class. + + The doc. + + + + Sets the editable range id. + + Represents the id of editable range. + + + + Attaches to paragraph. + + + + + + + Detaches from owner. + + + + + Clones the relations. + + + + + Creates a duplicate copy of the entity. + + + An object that is newly created. + + + + Closes the item. + + + + + Creates layout information for + + + + + Gets the type of the entity. + + The of the current item. + + + + Gets the id of editable range start. + + The string that represents the id of editable range start. + + + + Gets or sets the index of the column where editable range starts. + + The column first. + + + + Gets or sets the index of the column where editable range ends. + + The column last. + + + + Gets or sets the single user for editable range permission. + + + + + Gets or sets the editor group for editable range permission. + + + + + Specifies whether the editable range is detached + (For both cases either cloned or removed from collection) from the editable ranges collection. + + + + + Represents breaks in the paragraph, can be a page break, column break or line break. + + + + + Type of break. + + + + + Line break text. + + + + + Initializes a new instance of the class. + + The object. + + + + Initializes a new instance of the class. + + The object. + The member that specifies the break type. + + + + Closes the item. + + + + + Clones itself. + + + An object that represents the cloned copy. + + + + Clones the relations. + + The doc. + + + + Attaches to paragraph. + + The paragraph. + The item pos. + + + + Detaches from owner. + + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Registers child objects in XDSL holder. + + + + + + Creates layout information. + + + + + + Determines whether the page break need to be skipped based on given entity owner. + + Entity + true, if present inside TextBox/FootNote/EndNote/Header/Footer + + + + Denotes whether break is carraige return + + + + + + Measures self size. + + + + + + + Gets the Break text for Word comparison + + + + + + Gets the properties text for Word comparison + + + + + + Compares the current Break with another Break. + + + + + + + Gets Html to Doc layout info + + + + + Gets the type of the entity. + + The of the current item. + + + + Gets the type of the break. + + The member that specifies the break type. + + + + Gets/sets text range of line break. + + + + + Gets the end pos. + + The end pos. + + + + Represents the Inline Shape Object. + + + + + Represents the shape object in the Word document. + + + + + + + + + + + + + + + + + + + + + + + + + Adds the self. + + + + + Attaches to paragraph. + + + + + + + + + + + + + Creates a duplicate copy of this . + + + The reference of the newly created object. + + + + Creates the layout information. + + + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Registers child objects in XDSL holder. + + + + + + Closes this instance. + + + + + Gets the type of the entity. + + The of the current item. + + + + Get/set FSPA for ShapeObject. + + + + + Gets/sets ShapeObject's main autoshape collection. + + + + + Get/set value which defines whenever current autoshape + is in header/footer subdocument. + + + + + Gets or sets a value indicating whether the LayoutInCell property is set for the Shape in the Table cell. + + + + + Gets shape object's character format. + + + + + + + + + + + + + + + + + + + + Defines id of OLE container in obeject pool. + + + + + Unparsed data stream + + + + + Initializes a new instance of the class with the specified instance. + + + + + + Clones the current item. + + + An object that is cloned copy of current item. + + + + Gets the dash style. + + The border style. + The line style. + + + + + Gets the border style. + + The dash style. + The line style. + + + + + Converts to inline shape. + + + + + Converts to shape. + + + + + Gets the effect extent. + + Width of the border. + The left top. + The right bottom. + + + + Writes object data as inside xml element. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + The value indicating the presence of xml content. + + + + Reads object data from xml attributes. + + + The object. + + + + Writes object data as xml attributes. + + + The object. + + + + + + + + + Closes this instance. + + + + + Compare the properties of Picture shape + + + True, if all the properties matches, else false + + + + Gets the inline shape object text for Word comparison + + + + + + Gets the line gradient. + + The line gradient. + + + + Gets/sets inline shape object's format. + + + + + + + + + + Gets/sets IsOLE property + + + + + Get/set id for OLE container which has image data. + + + + + Get unparsed data stream + + + + + Gets or sets the fill effects for the InlineShapeObject. + + The instance. + To maintain a fill for picture + + + + Summary description for GradientFill. + + + + + Initializes a new instance of the class. + + + + + Clones this instance. + + + + + Closes this instance. + + + + + Compares the properties of gradient fill. + + + True, if all the properties matches, else false + + + + Gets the gradient fill text for Word comparison + + + + + + Gets or sets a value indicating whether [rotate with shape]. + + true if [rotate with shape]; otherwise, false. + + + + Gets or sets the flip. + + The flip. + + + + Gets the gradient stops. + + The gradient stops. + + + + Gets or sets the linear gradient. + + The linear gradient. + + + + Gets or sets the path gradient. + + The path gradient. + + + + Gets the tile rectangle. + + The tile rectangle. + + + + Gets/Sets the boolean flag when it is empty element + + The tile rectangle. + + + + Summary description for GradientFill. + + + + + Initializes a new instance of the class. + + + + + Clones the Tile Rectangle + + + + + Compare GradientStop + + + + + Gets the gradient stop text for Word comparison + + + + + + Gets or sets the position. + + The position. + + + + Gets or sets the color. + + The color. + + + + Gets or sets the opacity. + + The opacity. + + + + Summary description for LinearGradient. + + + + + Initializes a new instance of the class. + + + + + Clones the Tile Rectangle + + + + + Compare the properties of linear gradient + + + True, if all the properties matches, else false + + + + Gets the linear gradient text for Word comparison + + + + + + Gets or sets the angle. + + The angle. + + + + Gets or sets the flag for 2007 format angle + + + + + Gets or sets a value indicating whether this is scaled. + + true if scaled; otherwise, false. + + + + Summary description for PathGradient. + + + + + Initializes a new instance of the class. + + + + + Clones the Tile Rectangle + + + + + Compare the properties of path gradient + + + True, if all the properties matches, else false + + + + Gets the path gradient text for Word comparison + + + + + + Gets or sets the path shade. + + The path shade. + + + + Gets or sets the bottom offset. + + The bottom offset. + + + + Gets or sets the left offset. + + The left offset. + + + + Gets or sets the right offset. + + The right offset. + + + + Gets or sets the top offset. + + The top offset. + + + + Summary description for TileRectangle. + + + + + Initializes a new instance of the class. + + + + + Clones the Tile Rectangle + + + + + Compare the properties of TileRectange + + + True, if all the properties matches, else false + + + + Gets the tile rectangle text for Word comparison + + + + + + Gets or sets the bottom offset. + + The bottom offset. + + + + Gets or sets the left offset. + + The left offset. + + + + Gets or sets the right offset. + + The right offset. + + + + Gets or sets the top offset. + + The top offset. + + + + Gets or sets value when the + + The top offset. + + + + Represents the OLE object in the Word document. + + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + Add the field code as text range. + + + + + Sets the value for LinkPath property. + + Path of the file. + + + + Parses the object pool. + + The object pool stream. + + + + Update OleObject storage name + + + + + Parses the OLE part stream. + + The stream. + + + + Parses the streams. + + The storage. + + + + Parses the OLE stream. + + The stream. + + + + Checks the object info stream exists. Add new object info stream if not exists. + + + + + Creates the OLE obj container. + + The native data. + The data path. + + + + Gets the OLE part stream. + + Is from NativeData + Stream + + + + Get byte array from a ICompoundStorage. + + Represent the ICompoundStorage + Represent the stream name to extract. + Returns the byte array + + + + Determines whether [is native item]. + + + true if [is native item]; otherwise, false. + + + + + Writes to storage. + + The storage. + + + + Updates the GUID. + + The CMP file. + The index. + + + + Gets the OLE container stream. + + + + + + Updates the ole object properties. + + + + + Sets the OLE picture. + + The picture. + + + + Sets the type of the OLE. + + The type. + + + + Sets the type of the field. + + + + + Update Ole object ObjInfo stream with Display as icon data + + + + + Update Object info + + + + + + Compares the current ole object with the specified ole object. + + + + + + + Gets the ole object text for Word comparison + + + + + + Creates layout information. + + + + + + Creates a duplicate copy of the entity. + + + An reference to the newly created object. + + + + Adds the self. + + + + + Attaches to paragraph. + + The paragraph. + The item pos. + + + + Detaches itself + + + + + Clones the relations. + + The doc. + + + + Updates the cloned WOleObject helper entity references. + + + + + Decides whether current index is valid or not. + + Index of an item + + + + + Closes this instance. + + + + + Initializing LayoutInfo value to null + + + + + + + + Gets the OLE picture. Read-only. + + The instance that represents the OLE picture. + + + + Gets the type of the entity. Read-only. + + The of the current item. + + + The that represents the storage container of OLE object. + + + + Gets or sets the field. + + The field. + + + + Gets or sets the name of the OLE Object storage. + + The string that specifies the name of the OLE storage. + + + + Gets or sets the link path of the OLE object. + + The string that specifies the link address. + + + + Gets the type of the OLE object. Read-only. + + The member that specifies the type of the OLE object. + + + + Gets or sets the not parsed from docx ole object. + + The XmlParagraphItem. + + + + Gets the type of the OLE object. + + The type of the OLE object. + + + + Gets or sets Ole Stream + + + + + Gets the type of "Update Method" of the linked OLE object. + + Type of update method. + + + + Gets or sets the type of the OLE object. + + The string that specifies the type of the OLE object. + + + + Gets the native data of embedded OLE object. Read-only. + + The byte array that specifies the native data. + + + + Gets the OLE object. + + The OLE object. + + + + Gets the next OLE object id. + + The next OLE obj id. + + + + Gets the name of file embedded in the package(only if OleType is "Package"). Read-only. + + The string that represents the file name. + + + + Gets a value indicating whether this instance is empty. + + true if this instance is empty; otherwise, false. + + + + Gets the GUID. + + The GUID. + + + + Create a object of the Ole10NativeParser + + + + + + Read a string until the empty byte comes. + + Specifies the byte array to read + Specifies a start position of a array to read + Returns the builded string + + + + Gets the native data from the OLE native stream + + + + + Gets the file name of the OLE native stream. + + + + + Represent a table of contents in the Word document. + + The following example illustrates how to add table of contents to a Word document. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add the section into the Word document + IWSection section = document.AddSection(); + string paraText = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"; + //Add the paragraph into the created section + IWParagraph paragraph = section.AddParagraph(); + //Append the TOC field with LowerHeadingLevel and UpperHeadingLevel to determines the TOC entries + paragraph.AppendTOC(1, 3); + //Add the section into the Word document + section = document.AddSection(); + //Add the paragraph into the created section + paragraph = section.AddParagraph(); + //Add the text for the headings + paragraph.AppendText("First Chapter"); + //Set a build in heading style. + paragraph.ApplyStyle(BuiltinStyle.Heading1); + //Add the text into the paragraph + section.AddParagraph().AppendText(paraText); + //Add the section into the Word document + section = document.AddSection(); + //Add the paragraph into the created section + paragraph = section.AddParagraph(); + //Add the text for the headings + paragraph.AppendText("Second Chapter"); + //Set a build in heading style. + paragraph.ApplyStyle(BuiltinStyle.Heading2); + //Add the text into the paragraph + section.AddParagraph().AppendText(paraText); + //Add the section into the Word document + section = document.AddSection(); + //Add the paragraph into the created section + paragraph = section.AddParagraph(); + //Add the text into the headings + paragraph.AppendText("Third Chapter"); + //Set a build in heading style + paragraph.ApplyStyle(BuiltinStyle.Heading3); + //Add the text into the paragraph. + section.AddParagraph().AppendText(paraText); + //Update the table of contents + document.UpdateTableOfContents(); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add the section into the Word document + Dim section As IWSection = document.AddSection() + Dim paraText As String = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula" + 'Add the paragraph into the created section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Append the TOC field with LowerHeadingLevel and UpperHeadingLevel to determines the TOC entries + paragraph.AppendTOC(1, 3) + 'Add the section into the Word document + section = document.AddSection() + 'Add the paragraph into the created section + paragraph = section.AddParagraph() + 'Add the text for the headings + paragraph.AppendText("First Chapter") + 'Set a build in heading style + paragraph.ApplyStyle(BuiltinStyle.Heading1) + 'Add the text into the paragraph. + section.AddParagraph().AppendText(paraText) + 'Add the section into the Word document + section = document.AddSection() + 'Add the paragraph into the created section + paragraph = section.AddParagraph() + 'Add the text for the headings + paragraph.AppendText("Second Chapter") + 'Set a build in heading style + paragraph.ApplyStyle(BuiltinStyle.Heading2) + 'Add the text into the paragraph + section.AddParagraph().AppendText(paraText) + 'Add the section into the Word document + section = document.AddSection() + 'Add the paragraph into the created section + paragraph = section.AddParagraph() + 'Add the text into the headings + paragraph.AppendText("Third Chapter") + 'Set a build in heading style + paragraph.ApplyStyle(BuiltinStyle.Heading3) + 'Add the text into the paragraph + section.AddParagraph().AppendText(paraText) + 'Update the table of contents + document.UpdateTableOfContents() + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + Initializes a new instance of the class with the specified + instance and switches. + + The instance. + The string that specifies the formatting string of the TOC field. + + + + Sets the style for the TOC level. + + The level number of the table of contents. + The name of the style to apply. + + The following code illustrates how to set the style for the TOC level. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Create a new custom styles + Style style = (WParagraphStyle)document.AddParagraphStyle("Mystyle"); + style.CharacterFormat.Bold = true; + style.CharacterFormat.FontName = "Verdana"; + style.CharacterFormat.FontSize = 25; + //Add the section into the Word document + IWSection section = document.AddSection(); + string paraText = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula"; + //Add the paragraph into the created section + IWParagraph paragraph = section.AddParagraph(); + //Append the TOC field with LowerHeadingLevel and UpperHeadingLevel to determines the TOC entries + TableOfContent toc = paragraph.AppendTOC(1, 3); + toc.UseHeadingStyles = false; + //Set the TOC level style based on which the TOC should be created + toc.SetTOCLevelStyle(2, "Mystyle"); + //Add the section into the Word document + section = document.AddSection(); + //Add the paragraph into the created section + paragraph = section.AddParagraph(); + //Add the text for the headings + paragraph.AppendText("First Chapter"); + //Set the build in heading style + paragraph.ApplyStyle("Mystyle"); + //Add the text into the paragraph + section.AddParagraph().AppendText(paraText); + //Add the section into the Word document + section = document.AddSection(); + //Add the paragraph into the created section + paragraph = section.AddParagraph(); + //Add the text for the headings + paragraph.AppendText("Second Chapter"); + //Set the build in heading style + paragraph.ApplyStyle(BuiltinStyle.Heading1); + //Add the text to the paragraph + section.AddParagraph().AppendText(paraText); + //Add the section into Word document + section = document.AddSection(); + //Add a paragraph to created section + paragraph = section.AddParagraph(); + //Add the text for the headings + paragraph.AppendText("Third Chapter"); + //Set the build in heading style + paragraph.ApplyStyle("Mystyle"); + //Add the text to the paragraph + section.AddParagraph().AppendText(paraText); + //Update the table of contents + document.UpdateTableOfContents(); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Create a new custom styles + Dim style As Style = DirectCast(document.AddParagraphStyle("Mystyle"), WParagraphStyle) + style.CharacterFormat.Bold = True + style.CharacterFormat.FontName = "Verdana" + style.CharacterFormat.FontSize = 25 + 'Add the section into the Word document + Dim section As IWSection = document.AddSection() + Dim paraText As String = "Lorem ipsum dolor sit amet, lacus amet amet ultricies. Quisque mi venenatis morbi libero, orci dis, mi ut et class porta, massa ligula magna enim, aliquam orci vestibulum Turpis facilisis vitae consequat, cum a a,turpis dui consequat massa in dolor per, felis non amet.Auctor eleifend in omnis elit vestibulum, donec non elementum tellus est mauris, id aliquam, at lacus, arcu pretium proin lacus dolor et. Eu tortor, vel ultrices amet dignissim mauris vehicula" + 'Add the paragraph into the created section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Append the TOC field with LowerHeadingLevel and UpperHeadingLevel to determine the TOC entries + Dim toc As TableOfContent = paragraph.AppendTOC(1, 3) + toc.UseHeadingStyles = False + 'Set the TOC level style based on which the TOC should be created + toc.SetTOCLevelStyle(2, "Mystyle") + 'Add the section into the Word document + section = document.AddSection() + 'Add the paragraph into the created section + paragraph = section.AddParagraph() + 'Add the text for the headings + paragraph.AppendText("First Chapter") + 'Set the build in heading style + paragraph.ApplyStyle("Mystyle") + 'Add the text into the paragraph + section.AddParagraph().AppendText(paraText) + 'Add the section into the Word document + section = document.AddSection() + 'Add the paragraph into the created section + paragraph = section.AddParagraph() + 'Add the text for the headings + paragraph.AppendText("Second Chapter") + 'Set the build in heading style + paragraph.ApplyStyle(BuiltinStyle.Heading1) + 'Add the text to the paragraph + section.AddParagraph().AppendText(paraText) + 'Add the section into Word document + section = document.AddSection() + 'Add a paragraph to created section + paragraph = section.AddParagraph() + 'Add the text for the headings + paragraph.AppendText("Third Chapter") + 'Set the build in heading style + paragraph.ApplyStyle("Mystyle") + 'Add the text to the paragraph + section.AddParagraph().AppendText(paraText) + 'Update the table of contents + document.UpdateTableOfContents() + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Returns the name of the style applied to the specified TOC level. + + The level number of the table of contents. + The name of the style. + + The following example illustrates how to get the name of the style applied to the TOC level. + + //Load a Word document + WordDocument document = new WordDocument("Template.docx"); + WTextBody textBody = document.Sections[0].Body; + WParagraph paragraph = textBody.Paragraphs[0]; + //Get the TOC item from the paragraph + TableOfContent toc = paragraph.ChildEntities[0] as TableOfContent; + //Gets the style name for the specified level + string styleName = toc.GetTOCLevelStyle(1); + WParagraphStyle style = document.Styles.FindByName(styleName) as WParagraphStyle; + //Modify the character format of the style + style.CharacterFormat.HighlightColor = Color.LightGray; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Load a Word document + Dim document As New WordDocument("Template.docx") + Dim textBody As WTextBody = document.Sections(0).Body + Dim paragraph As WParagraph = textBody.Paragraphs(0) + 'Get the TOC item from the paragraph + Dim toc As TableOfContent = TryCast(paragraph.ChildEntities(0), TableOfContent) + 'Gets the style name for the specified level + Dim styleName As String = toc.GetTOCLevelStyle(1) + Dim style As WParagraphStyle = TryCast(document.Styles.FindByName(styleName), WParagraphStyle) + 'Modify the character format of the style + style.CharacterFormat.HighlightColor = Color.LightGray + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Returns the list of styles defined for the specified TOC level. + + The level number of the table of contents. + The collection of styles defined for the specified TOC level. + + + + Gets the corresponding key value. + + + + + + Parses the switches. + + + + + Gets the built-in style. + + The built-in style. + + + + + Creates the default styles collection. + + + + + Updates the formatting string of TOC field. + + + + + Updates the field code text range with formatting switches. + + + + + Remove existing field code items. + + + + + Updates TOC heigher and lower levels. + + + + + Updates the hyperlinks. + + + + + Updates the manual line break. + + + + + Updates the formatting string with UsePageNumbers value. + + + + + Updates the page number alignment. + + + + + Updates the use outline levels property in formatting string. + + + + + Updates the use table entry field property. + + + + + Updates the header styles. + + + + + Updates the table of figure Label. + + + + + Updates the caption label and numbers. + + + + + Parses the label name. + + The option string. + + + + Parses the heading levels. + + The option string. + + + + Parses the number alignment. + + The option string. + + + + Parses the use field. + + The option string. + + + + Parses the header styles and update the header style level if the level is not specified + + + + + + + check whether string contains number + + + + + + + Called when [set value]. + + + + + Called when [get value]. + + + + + Sets the style for TOC level. + + The level number. + Name of the style. + if it is on set property, set to true. + + + + Checks the level number. + + Name of the parameter. + The level number. + + + + Parses the document. + + + + + Parses the text body. + + The text body. + + + + Parses the table. + + The table. + + + + Checks whether the paragraph contains with sequence field with caption name. + + The paragraph. + + + + Parses the paragraph. + + The paragraph. + + + + Checks whether the paragraph has outline level + + The paragraph. + True if outline level are present in paragraph; else False + + + + Checks and splits the paragraph. + + The paragraph. + + + + Updates the tab characters. + + The text range. + + + + Updates the new line characters. + + The text range. + The split text. + + + + Creates the paragraph. + + The paragraph. + The index. + + + + Create new paragraph when TOC paragraph has other paragraph items before the TOC field. + + + + + + + Check wheteher TOC previous sibling contains only book marks or any other valid items. + + + + + + + Removes the updated toc entries. + + + + + Checks the paragraph style. + + Name of the style. + + + + + Return the Toc link style. + + The paragraph. + + + + + Gets the TOC level. + + Name of the style. + The paragraph + TOC level of the paragarph + + + + Inserts the bookmark. + + The paragraph. + The field. + The start index. + The end index. + + + + Inserts the bookmark hyperlink. + + The paragraph. + The field. + The bookmark. + + + + Creates the hyperlink. + + The paragraph. + The toc paragraph. + The text. + The bookmark. + + + + Creates the hyperlink for field value null + + Current paragraph + TOC paragraph + true when is to reference link style, elsefalse + List of TOC link styles + + + + Append text into toc paragraph + + Paragraph textrange + Paragraph textrange value + Paragraph style + Toc paragraph + + + + To identify the whether text range formatting applied to toc text range or not + + Current formatting key + Current paragraph style + Current text range + Current text range character style + trueif character style or inline character formatting have value + and customer paragraph style doesn't have key else false + + + + To identify the tab is first or last item in its owner paragraph + + Current heding paragraph + Current tab index + trueif the tab is first item or after tab item, thers is + no text in its owner paragraph, else false + + + + To identify the tab is first or last item in its owner paragraph + + Start tab index + End tab index + Owner paragraph + trueif the tab is first item or after tab item, thers is + no text in its owner paragraph, else false + + + + Get the tab stop position for the first occurrence tab in current toc paragraph + + Current Toc paragraph + + + + + Get the tab stop position from the paragraph style + + Tab collection in paragraph style + truewhen the tab stop position from style + Previous text length + Tab stop position + Tab stop position + + + + Creates the hyper link for link style. + + The paragraph. + The toc paragraph. + The toc link styles. + + + + Checks whether the font name need to apply for linked character style TOC items. + + Textrange of the paragraph + Textrange character style + + + + Gets the index of the toc valid item. + + The paragraph. + + + + + Updates the tabs. + + The paragraph. + + + + Checks whether all the tab justification is clear + + The paragraph style. + True if all the tab justification value is clear; else false + + + + Gets the tab position. + + The entity. + + + + + Creates the TOC paragraph. + + The level. + + + + + Generates the name of the bookmark. + + + + + + Updates the page numbers. + + + + + Updates the list. + + The paragraph. + The toc paragraph. + Set to Truewhen the list tab added into the toc paragraph + + + + Adds the list value and tab. + + The paragraph. + The toc paragraph. + The list value. + Set to Truewhen the list tab added into the toc paragraph + + + + Creates layout information. + + + + + + Registers child objects in XDSL holder. + + + + + + Writes object data as xml attributes. + + + The object. + + + + Creates a duplicate copy of the . + + + The reference of the newly created object. + + + + Closes this instance. + + + + + Compare the table of content with another table of content of another document. + + + + + + + Gets the TableOfContent string for Word Comparison. + + + + + + Gets or sets the name of the sequence identifier to be used when building a table of figures. The default value is null. + + The specifying the identifier. + + 1. This property corresponds to the \c switch of the TOC field. + 2. Apart from caption fields of tables, figures, and shapes, it also considers any valid identifier used by a SEQ field. + + + + //Create a new Word document. + using (WordDocument document = new WordDocument()) + { + //Add a new section to the document. + IWSection section = document.AddSection(); + //Add a paragraph to the section. + IWParagraph paragraph = section.AddParagraph(); + //Append the TOC field with LowerHeadingLevel and UpperHeadingLevel to determine the TOC entries. + TableOfContent tableOfContent = paragraph.AppendTOC(1, 3); + //Set the name of SEQ field identifier for table of figures. + tableOfContent.TableOfFiguresLabel = "Figure"; + //Add a paragraph to the section. + paragraph = section.AddParagraph(); + //Add image to the paragraph. + FileStream imageStream = new FileStream(@"Image.png", FileMode.Open, FileAccess.ReadWrite); + IWPicture picture = paragraph.AppendPicture(imageStream); + //Add Image caption. + IWParagraph paragraph1 = picture.AddCaption("Figure", CaptionNumberingFormat.Number, CaptionPosition.AfterImage); + //Add text to the paragraph. + paragraph1.AppendText(" Icon."); + //Update the fields in Word document. + document.UpdateDocumentFields(); + //Update the table of contents. + document.UpdateTableOfContents(); + //Saves the Word document to MemoryStream. + MemoryStream stream = new MemoryStream(); + document.Save(stream, FormatType.Docx); + } + + + 'Create a new Word document. + Dim document As WordDocument = New WordDocument() + 'Add a new section to the document. + Dim section As IWSection = document.AddSection() + 'Add a paragraph to the section. + Dim paragraph As IWParagraph = section.AddParagraph() + 'Append the TOC field with LowerHeadingLevel and UpperHeadingLevel to determine the TOC entries. + Dim tableOfContent As TableOfContent = paragraph.AppendTOC(1, 3) + 'Set the name of SEQ field identifier for table of figures. + tableOfContent.TableOfFiguresLabel = "Figure" + 'Add a paragraph to the section. + paragraph = section.AddParagraph() + 'Add image to the paragraph. + Dim imageStream As FileStream = New FileStream("Image.png", FileMode.Open, FileAccess.ReadWrite) + Dim picture As IWPicture = paragraph.AppendPicture(imageStream) + 'Add Image caption. + Dim paragraph1 As IWParagraph = picture.AddCaption("Figure", CaptionNumberingFormat.Number, CaptionPosition.AfterImage) + 'Add text to the paragraph. + paragraph1.AppendText(" Icon.") + 'Update the fields in Word document. + document.UpdateDocumentFields() + 'Update the table of contents. + document.UpdateTableOfContents() + 'Save the document. + document.Save("Result.docx") + document.Close() + + + + + + Gets or sets a value indicating whether to include caption's labels and numbers while building a table of figures based on identifier . + The default value is true. + + true if need to include caption's labels and numbers; otherwise, false. + + This property corresponds to the \a switch of the TOC field. + + + + //Create a new Word document. + using (WordDocument document = new WordDocument()) + { + //Add a new section to the document. + IWSection section = document.AddSection(); + //Add a paragraph to the section. + IWParagraph paragraph = section.AddParagraph(); + //Append the TOC field with LowerHeadingLevel and UpperHeadingLevel to determine the TOC entries. + TableOfContent tableOfContent = paragraph.AppendTOC(1, 3); + //Set the name of SEQ field identifier for table of figures. + tableOfContent.TableOfFiguresLabel = "Figure"; + //Disable the flag, to exclude caption's label and number in TOC entries. + tableOfContent.IncludeCaptionLabelsAndNumbers = false; + //Add a paragraph to the section. + paragraph = section.AddParagraph(); + //Add image to the paragraph. + FileStream imageStream = new FileStream(@"Image.png", FileMode.Open, FileAccess.ReadWrite); + IWPicture picture = paragraph.AppendPicture(imageStream); + //Add Image caption. + IWParagraph paragraph1 = picture.AddCaption("Figure", CaptionNumberingFormat.Number, CaptionPosition.AfterImage); + //Add text to the paragraph. + paragraph1.AppendText(" Icon."); + //Update the fields in Word document. + document.UpdateDocumentFields(); + //Update the table of contents. + document.UpdateTableOfContents(); + //Saves the Word document to MemoryStream. + MemoryStream stream = new MemoryStream(); + document.Save(stream, FormatType.Docx); + } + + + 'Create a new Word document. + Dim document As WordDocument = New WordDocument() + 'Add a new section to the document. + Dim section As IWSection = document.AddSection() + 'Add a paragraph to the section. + Dim paragraph As IWParagraph = section.AddParagraph() + 'Append the TOC field with LowerHeadingLevel and UpperHeadingLevel to determine the TOC entries. + Dim tableOfContent As TableOfContent = paragraph.AppendTOC(1, 3) + 'Set the name of SEQ field identifier for table of figures. + tableOfContent.TableOfFiguresLabel = "Figure" + 'Disable the flag, to exclude caption's label and number in TOC entries. + tableOfContent.IncludeCaptionLabelsAndNumbers = False + 'Add a paragraph to the section. + paragraph = section.AddParagraph() + 'Add image to the paragraph. + Dim imageStream As FileStream = New FileStream("Image.png", FileMode.Open, FileAccess.ReadWrite) + Dim picture As IWPicture = paragraph.AppendPicture(imageStream) + 'Add Image caption. + Dim paragraph1 As IWParagraph = picture.AddCaption("Figure", CaptionNumberingFormat.Number, CaptionPosition.AfterImage) + 'Add text to the paragraph. + paragraph1.AppendText(" Icon.") + 'Update the fields in Word document. + document.UpdateDocumentFields() + 'Update the table of contents. + document.UpdateTableOfContents() + 'Save the document. + document.Save("Result.docx") + document.Close() + + + + + + Gets or sets a value indicating whether to use default heading styles. + + True if it uses heading styles; otherwise false. + + + + Gets or sets the ending heading level of the table of contents. The default value is 3. + + The integer specifying the upper heading level. + + + + Gets or sets the starting heading level of the table of contents. The default value is 1. + + The integer specifying the starting heading level. + + + + Gets or sets a value indicating whether to use table entry fields. The default value is false. + + True if it uses table entry fields; otherwise, false. + + + + + Gets or sets the table ID. + + The table ID. + + + + Gets or sets a value indicating whether to show page numbers as right aligned. The default value is true. + + True if to right align page numbers; otherwise, false. + + + + + Gets or sets a value indicating whether to show page numbers in table of contents. The default value is true. + + True if to includes page numbers; otherwise, false. + + + + Gets or sets a value indicating whether to use hyperlinks for the levels. The default value is true. + + True if it uses hyperlinks for levels; otherwise false. + + + + Gets or sets a value indicating whether to use outline levels. The default value is false. + + True if it uses outline levels; otherwise false. + + + + Gets the type of the entity. + + The of the current + . + + + + Gets or sets the formatting string. + + The formatting string. + + + + Gets TOC field + + + + + Gets the TOC styles. + + The TOC styles. + + + + Gets the list of TOC entry with its corresponding entity. + + The TOC entry and its corresponding entity. + + + + Gets the TOC levels. + + The TOC levels. + + + + Gets the last TOC paragraph. + + The last TOC paragraph. + + + + Gets or sets a value indicating whether [invalid format string]. + + + true if [invalid format string]; otherwise, false. + + + + + Gets or sets a value indicating whether [formatting parsed]. + + + true if [formatting parsed]; otherwise, false. + + + + + Gets or sets a value indicating whether to include newline characters in TOC entries. Default value is false. + + True if it includes newline characters in TOC entries; otherwise, false. + + + //Create a Word document. + WordDocument document = new WordDocument(); + //Adds the section into the Word document. + IWSection section = document.AddSection(); + //Adds the paragraph into the created section. + IWParagraph tocParagraph = section.AddParagraph(); + //Append the TOC field with LowerHeadingLevel and UpperHeadingLevel to determine the TOC entries. + TableOfContent tableOfContent = tocParagraph.AppendTOC(1, 3); + //Enables the property IncludeNewLineCharacters to preserve newline characters in the TableOfContent. + tableOfContent.IncludeNewLineCharacters = true; + //Adds the paragraph into the section. + WParagraph paragraph = section.AddParagraph() as WParagraph; + //Adds the text and breaks the headings. + paragraph.AppendText("First "); + paragraph.AppendBreak(BreakType.LineBreak); + paragraph.AppendText("Chapter"); + //Sets a built-in heading style. + paragraph.ApplyStyle(BuiltinStyle.Heading1); + //Adds the text into the new paragraph of the section. + section.AddParagraph().AppendText("AdventureWorks Cycles, the fictitious company on which the AdventureWorks sample databases are based, is a large, multinational manufacturing company."); + //Updated the table of content. + document.UpdateTableOfContents(); + //Saves the document. + document.Save("Result.docx"); + document.Close(); + + + 'Create a Word document. + Dim document As WordDocument = New WordDocument() + 'Add the section into the Word document. + Dim section As IWSection = document.AddSection() + 'Add the paragraph into the created section. + Dim tocParagraph As IWParagraph = section.AddParagraph() + 'Append the TOC field with LowerHeadingLevel and UpperHeadingLevel to determine the TOC entries. + Dim tableOfContent As TableOfContent = tocParagraph.AppendTOC(1, 3) + 'Enable the property IncludeNewLineCharacters to preserve newline characters in TableOfContent. + tableOfContent.IncludeNewLineCharacters = True + 'Add the paragraph into the section. + Dim paragraph As WParagraph = TryCast(section.AddParagraph(), WParagraph) + 'Add the text and break the headings. + paragraph.AppendText("First ") + paragraph.AppendBreak(BreakType.LineBreak) + paragraph.AppendText("Chapter") + 'Set a built-in heading style. + paragraph.ApplyStyle(BuiltinStyle.Heading1) + 'Add the text into the new paragraph of the section. + section.AddParagraph().AppendText("AdventureWorks Cycles, the fictitious company on which the AdventureWorks sample databases are based, is a large, multinational manufacturing company.") + 'Updated the table of content. + document.UpdateTableOfContents() + 'Save the document. + document.Save("Result.docx") + document.Close() + + + + + + Gets/Sets the Text Size of the TextRange + + + + + Represents the check box in the Word document. + + The following code illustrates how to add a new checkbox. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + WParagraph paragraph = section.AddParagraph() as WParagraph; + paragraph.AppendText("Gender\t"); + //Append new Checkbox + WCheckBox checkbox = paragraph.AppendCheckBox(); + checkbox.Checked = false; + //Set Checkbox size + checkbox.CheckBoxSize = 10; + checkbox.CalculateOnExit = true; + //Set help text + checkbox.Help = "Help text"; + paragraph.AppendText("Male\t"); + checkbox = paragraph.AppendCheckBox(); + checkbox.Checked = false; + checkbox.CheckBoxSize = 10; + checkbox.CalculateOnExit = true; + paragraph.AppendText("Female"); + //Save the Word document + document.Save("Checkbox.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + + + + Summary description for WFormField. + + + + + Represents the field in the document. + + + + + Represents the text in the Word document. Each part of text can have separate formatting. + + The following example illustrates how to add a text to the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Initialize new text range instance + IWTextRange textrange = new WTextRange(document); + //Add text and its formatting + textrange.Text = "A new text is added"; + textrange.CharacterFormat.FontSize = 14; + textrange.CharacterFormat.Bold = true; + textrange.CharacterFormat.TextColor = Color.Green; + //Add text range to the paragraph + paragraph.Items.Add(textrange); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Initialize new text range instance + Dim textrange As IWTextRange = New WTextRange(document) + 'Add text and its formatting + textrange.Text = "A new text is added" + text.CharacterFormat.FontSize = 14 + text.CharacterFormat.Bold = True + text.CharacterFormat.TextColor = Color.Green + 'Add text range to the paragraph + paragraph.Items.Add(textrange) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Represents a Widget with string-like layout. + + + + + Represents a LEAF Widget that can SPLIT self. + + + + + Splits the size of the by. + + The dc. + The size. + The clientWidth. + + + + + Represnts an widget which can be measure itself. + + + + + Measures size of specified string. + + + + + + + + Measures size of specified string. + + + + + + + + Offsets to index. + + The graphics. + The offset. + The text. + The clientWidth. + + + + + Gets text ascent. + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies the character range type of text range. + + + + + Specifies the font script type of text range. + + + + + To update XML values mapped to Content control + + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + Attaches to paragraph. + + The paragraph. + The item pos. + + + + Attaches to paragraph. + + The paragraph. + The item pos. + + + + Inserts the text in existing , without removing exisitng. + + A to insert the text + This will insert the text when inserting inline content control in between pragraph, + there we need to update the text content to paragraph. + + + + Detaches from owner. + + + + + Creates a duplicate copy of the text. + + + The reference to the newly created instance. + + + + Applies the specified character format to the text. + + The to be applied to the text. + The following example illustrates how to add a text to the document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + document.EnsureMinimal(); + //Add new text + IWTextRange text = document.LastParagraph.AppendText("Hello world"); + //Initialize character format + WCharacterFormat characterformat = new WCharacterFormat(document); + characterformat.Bold = true; + characterformat.Italic = true; + characterformat.TextColor = Color.Blue; + //Apply character format + text.ApplyCharacterFormat(characterformat); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + document.EnsureMinimal() + 'Add new text + Dim text As IWTextRange = document.LastParagraph.AppendText("Hello world") + 'Initialize character format + Dim characterformat As New WCharacterFormat(document) + characterformat.Bold = True + characterformat.Italic = True + characterformat.TextColor = Color.Blue + 'Apply character format + text.ApplyCharacterFormat(characterformat) + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Split the widgets based on the control characters tab ("\t") and carriage return ("\r") + + + + + Splits the widget by tab. + + + + + Check whether current text range is present inside the hyperlink field and return the field. + + + + + + + + Closes the item. + + + + + Splits the widget by paragraph break. + + + + + Registers child objects in XDSL holder. + + + + + + Writes object data as inside xml element. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + The value indicating the presence of xml content. + + + + Creates layout information. + + + + + + Measure Size of the TextRange + + + + + + Initializing LayoutInfo value to null + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get Font of the TextRange or Field + + + + + + Offsets to index. + + + The offset. + The text. + The clientWidth. + + + + + Determines current section client width. + + The clientWidth. + Client Width + + + + + + + + The clientWidth. + + + + + Determine whether the text range is last item of the paragraph and which have text with empty space + + + + + + Determine whether the space width consider or not. + + + + + + Gets the type of the entity. + + The of the current item. + + + + Gets or sets the text. + + + + + Get or set the initial Text value. + + + + + Gets the character format(font properties) of the text. Read-only. + + + + + Gets or Sets the length of the text. + + + + + Gets or sets Character Range Type in the widget + + + + + Gets or sets Font Script Type of the text. + + + Used to represent the FontScriptType of a text, which is exist in WTextRange.Text property. + + + + + Gets the end pos. + + The end pos. + + + + Defines if text of current text range is safe. + + + + + Gets a boolean value indicating whether this text range is paragraph mark. + + + true if paragraph mark; otherwise, false. + + + + + Get or set new textlength. + + + + + Get or set new end position. + + + + + Get or set new start position. + + + + + / + + + + + Initializes a new instance of the class. + + The text range. + + + + Beginning of Field Mark character: 0x0013. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Local reference string for the hyperlink + + + + + The source field type value (used in case field type is unknown) + + + + + Preserves the character formatting of field's previous result. + + + + + Maintain original field for AutoNum fields. + + + + + Screen tip text for hyperlink + + + + + Creates a new instance of the class with specified instance. + + The Word document instance + + + + Reads object data from xml attributes. + + + The object. + + + + Writes object data as xml attributes. + + + The object. + + + + + + + + + + + Decides whether field code start with Invalid Character. + + + + + + Sets IsSkip as true for field code items which is for TOC and WOleObject. + + + + + Set Field Type + + + + + + + + + + + + Updates Field code + + + + + + TCEntry,TOA entry,Index Entry ,Ref Doc,FieldPrivate + + + + + + Decides whether the formatting string to be set. + + + + + + Gets the field type from field code. + + Field code. + + + + + Set the TextFormat Switch String + + + + + + Set the Local Switch String + + + + + + Sets the screen tip and position switch. + + The field code. + Start index of the switch. + The formatting switch. + + + + Converts the switches to string. + + + + + + Attaches to paragraph. + + The paragraph. + The item pos. + + + + Detaches from owner. + + + + + Removes items upto Field end in inline content control. + + Owner paragraph of the field, if it is also in inline content control. + Owner paragraph of Field end, if it is also in inline content control. + + + + Removes the paragraph child items upto field end + + Owner paragraph + Start item index + Flag to check whether Field end is found or not, to remove further items. + + + + Removes item from the inline content control. + + An to remove its inner items. + Index value to start removing of items. + Flag to check whether Field end is found or not, to remove further items. + + + + Clones the relations. + + + + + Gets the owner textbody. + + The entity. + + + + + Clones itself. + + + Returns cloned object. + + + + Closes this instance. + + + + + Gets the field as WSymbol or WTextRange item. + + + A which can be either a if the character code is within the + ASCII range (0-255) or a for Unicode characters. + + + + + Gets the field code of the field. + + + + + + Gets the field code. + + The field code. + + + + + Determines whether the field is form field. + + + + + Removes the field code items. (Begin to Separator or End) + + + + + Convert the field result to static text during docuent reading. + + + + + + Insert TOC field. + + + + + + Remove the TOC fields when it prserved inside another TOC field. + + + + + Replace the WField instance with corresponding field type instance. + + + + + + Sets the field type by getting its field code. + + + + + Ensures IF field expression before converting merge field to static text as a part of mail merge. + + The merge field to be converted as static text. + + + + Finds the field code from text body items. + + Owner text body. + Field separator or end mark owner paragraph. + + + + Decide whether the field code is valid or not. + + Current field code. + + + + + Get owner section + + + + + + + To ensure for the BookmarkStart has been added to the owner document + + The Bookmark Start used to start removing the merge field collection + + + + To ensure for the BookmarkEnd has been added to the owner document + + The Bookmark end used to stop removing the merge field collection + + + + Gets the result character formatting. + + + + + + Updates the list of character formats from Range Items of merge field. + + + + + + Gets result of character format from text range. + + Text range. + Index + Count + + + + + Gets the content of the field. + + The field. + ParagraphItem. + + + + Updates the field result for this . + + + Essential DocIO currently support the updating of field result for the following field types only: + + = (formula field) + DATE + TIME + DOCVARIABLE + DOCPROPERTY + COMPARE + IF + NEXTIF + MERGEREC + MERGESEQ + SECTION + NUMPAGES + TITLE + Cross-Reference + + Also while updating of NUMPAGES field and Cross Reference field with Page number and Paragraph number options are not supported in Silverlight, WinRT, Universal, Windows Phone and Xamarin platforms. + Currently group shapes, drawing canvas, and table auto resizing are not supported in Word to PDF lay outing, and this may lead to update incorrect page number and total number of pages. + + + + + Checks whether the bookmark sequence field update. + + + + + + + Clears the internal collection when invoke the field.Update() method from the sample level + for seqence field. + + + + + Update the field result value for sequence field. + + + + + + Gets the sequence field result value. + + + + + + Wheather we need to reset this sequence field based on heading style behavior. + + + + + + Gets the previous paragraph. + + The paragrph. + + + + + Gets the previous paragraph is in table. + + The table. + + + + + Gets the previous pragraph is in the table cell. + + + + + + + Gets the previous paragraph is in the section. + + + + + + Gets the content of the previous paragraph is in SDT. + + Content of the SDT. + + + + + Gets the previous sequence field value. + + + + + + + Returns the heading level of the style + + Style Name + Heading level + + + + Converts the string to its corresponding Integer value + + + + + + + updates the unknown or custom fields + + + + + Gets the AutoNum Field Value. + + resultText + + + + Gets the Seperator code from the FieldCode + + The Field. + + + + Checks wheather the field present inside the Text Body or not. + + + Return true, if field exsists in valid text body, else return false. + + + + Updates the SET field. + + + + + Updates the BookMark for SET fields. + + BookMark Name. + + + + Remove the previous BookMark for SET fields. + + BookMark Name. + + + + Updates the document built in properties. + + Name of the property. + + + + Removes the string format. + + The field code. + if set to true [is having string format]. + + + + + Update Datefield + + + + + Get ordinal string for numeric value + + Ordinal string + text + + + + + Updates the next if field. + + + + + + Updates the section field. + + + + + Determines whether [is picture switch is in second place]. + + + + + + Updates the number format result. + + The result. + + + + Updates the number format result. + + The result. + True whether to update result text only without updating the field result part. Otherwise False + + + + Updates the doc property field. + + + + + Updates the DocVariable field or MergeField value with text formats applied + + The text + + + + + Updates the text format of the field + + The text + The formatting string + + + + + Updates the text format of the field + + The text + The formatting string + Page field has formatting string or not + + + + + Gets the Caps string + + The text which need to convert + + + + + Convert the first letter of each word, splitted based on special character, into Caps + + The text which need to convert + The separator + + + + + Gets Number format based on invariant culture + + + + + + + Changes current culture number format to invariant culture format. + + + + + + + Updates the reference field. + + + + + Checks whether the current field is present inside the bookmark. + + The bookmark name. + True if the current field is present inside the bookmark; otherwise false. + + + + Checks whether the current field is present inside the bookmark in the paragraph. + + + + + + Checks whether the current field is present inside the bookmark in the textbody. + + + + + + Checks whether the current field is present inside the bookmark in the table and block content control. + + + + + + Checks whether the current field is present inside the bookmark inside the table. + + + + + Checks whether the current field is present inside the bookmark after the bookmark start next paragraph in textbody. + + + + + + Checks the text body owner. + + The bookmark. + + + + + Updates the Unknown field result. + + The field result. + + + + Updates the reference field result. + + The field result. + + + + Insert and update revisions of textbody items. + + + + + Moves the Field end paragraph items to Field result last paragraph. + + The para. + + + + Gets the index of the hierarchical. + + The entity. + + + + + Gets the position value. + + The bookmark. + + + + + Compares the index of the hierarchical. + + The value1. + The value2. + + + + + Get the date value + + + + + + + + Updating custom day value + + + + + + + + + Updating the custom month value + + + + + + + + + Update the custom year value + + + + + + + + + To Get Number from text + + + + + + + To Get the number from alphabet string + + + + + + + Removes the unwanted text in the begining of the field code + + + + + + + Removes the unwanted text in the end of the field code + + + + + + + Removes the text. + + + The text. + The text to revome. + + + + + Splits if arguments. + + + + + + + + + + Splits the field code. + + The table start. + The text. + The condition. + + + + Splits the field code. + + The operators. + The arguments. + Index of the operator. + if set to true [is operator]. + The text. + The condition. + + + + Checks whether there is index found for operator + + + + + + + + Updates the operators index with modified text. + + + + + + + //Updates the operators index as per the modified text + + + + + + + Determines whether the specified operators is operator. + + The operators. + The text. + The condition. + + true if the specified operators is operator; otherwise, false. + + + + + Gets the index of the operator. + + The collection of Operators + The Fieldcode of the field + + + + + Gets the text in table. + + The text. + The text from table start mark to table end mark + + + + Updates the condition. + + + The Text which is the fieldcode after removing the true and false part + The index of operator in text + The value of operator + + + + + Checks whether the two operands are equal if operand1 contains wildcard characters. + + The first operand. + The second operand. + True if the operands are equal, otherwise false. + + + + Checks whether the text has the expected operator + + + + + + + + + + Checks operator index are in valid position of text length + + + + + + + + + Updates the compare field. + + + + + Compares the expression. + + The operand1. + The operand2. + The operation. + + + + + Updates the formula field. + + + + + Remove the currency symbol from Field code + + The Field code + Checks whether the fieldcode starts with currency symbol + + + + + Updates the number format. + + The text. + The number format. + + + + + Check whether number field has valid format. + + + + + + + Update the Merge field value based on Number format. + + Current Number format + Field value + + + + + If switch contains ";" symbol then need to split based on the input value. For positive values first part, for negative values second part. + + Number format + Feild value + + + + Format the field value based on the given number format string. + + + + + + + + + + + Insert the text which preserved before the field number format code. + + + + + + + + Format the fractional part of the field value based on the number format switch. + + + + + + + + + + Format the integral part of the field value based on the number format switch. + + + + + + + + + Remove thousand separator and add the values, when it has invalid structure. + + + + + + + + + Add the list of integer values. + + + + + + + Split the field value based on the separator. + + + + + + + + Split the field value by the group separator. + + + + + + + + + + + + Clear the String builder text. + + + + + + Convert the given string as integer + + + + + + + Return true if switch start with double quotes + + + + + + + Check whether Number format has valid structure or not. + + + + + + + + + Split the number format by decimal separator. + + + + + + + + + Removes the merge format. + + + The text. + + + + + Removes the merge format. + + + The field code. + The number format + + + + + Updates the formula. + + The field code. + + + + + Updates the function. + + The field code. + + + + + Calulates the product of specified operands. + + The operands. + + + + + Calulates the sum of specified operands. + + The operands. + + + + + Calulates the average of specified operands. + + The operands. + + + + + Rounds of the operand to specified decimal point. + + The operand. + The decimal point. + + + + + Checks whether the specified operand is numeric value. + + The operand. + + + + + Determines whether the specified text is function. + + The text. + + true if the specified text is function; otherwise, false. + + + + + Determines whether the specified text is expression. + + The text. + + true if the specified text is expression; otherwise, false. + + + + + Updates the expression. + + The text. + + + + + Evaluates the expression. + + The expression. + The operation. + + + + Splits the expression. + + The text. + The operators. + + + + + Splits the operands. + + The text. + + + + + Replaces the field with its most recent result. + + The following example illustrates how to unlink the specified field. + + //Creates an instance of WordDocument class + WordDocument document = new WordDocument(); + //Adds a new section into the Word Document + IWSection section = document.AddSection(); + //Adds a new paragraph into Word document and appends text into paragraph + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("Today's Date: "); + //Adds the new Date field in Word document with field name and its type + WField field = paragraph.AppendField("Date", FieldType.FieldDate) as WField; + //Updates the field + field.Update(); + //Unlink the field + field.Unlink(); + //Saves the document in the given name and format + document.Save("Sample.docx", FormatType.Docx); + //Releases the resources occupied by WordDocument instance + document.Close(); + + + 'Creates an instance of WordDocument class + Dim document As WordDocument = New WordDocument() + 'Adds a new section into the Word Document + Dim section As IWSection = document.AddSection() + 'Adds a new paragraph into Word document and appends text into paragraph + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("Today's Date: ") + 'Adds the new Date field in Word document with field name and its type + Dim field As WField = CType(paragraph.AppendField("Date", FieldType.FieldDate), WField) + 'Updates the field + field.Update() + 'Unlink the field + field.Unlink() + 'Saves the document in the given name and format + document.Save("Sample.docx", FormatType.Docx) + 'Releases the resources occupied by WordDocument instance + document.Close() + + + + When you unlink a field, its current result is converted to text or a graphic and can no longer be updated automatically. + Note that the fields such as XE (Index Entry) fields and SEQ (Sequence) fields cannot be unlinked. + + + + + Removes the field items except the field result. + + + + + Removes the paragraph items in between the field range. + + The paragraph item. + + + + Removes the textbody items in between the field range. + + The textbody item. + + + + Iterates into body items. + + + + + Iterates into paragraph items. + + The paragraph. + + + + Iterates into table. + + The table. + + + + Removes the nested field after unlinking. + + + + + Adds the required values into the stack while reading the nested fields in field result. + + + + + + + Resets the required values after reading the nested fields in field result. + + + + + + + Updates the nested field code. + + + + + Updates the paragraph items of the field range. + + The paragraph items collection. + The start index of item. + + + + Updates the nested field code. + + + + + Updates the text for text body item. + + + The entity. + + + + + Updates the text for text body item. + + + The entity. + + + + + Updates the text for table. + + The entity. + + + + + Updates the text for paragraph item. + + + The entity. + + + + + Gets the field result. + + + + + + + + + + + + + + + + + + + Remove the field separator for the TOC entry,TOA entry,Index entry,Ref Doc and Private + + + + + + Parses the field. + + + The field code. + + + + Parses the field format. + + + The field values. + + + + Parses the local reference string for the hyperlink. + + The field code. + The start pos. + + + + Parse the switches + + Text + Index + + + + + Checks whether the text start with valid character + + + + + + + + Checks whether the text start end valid character + + + + + + + + Removes the Meridiem if present + + Text + Is Meridiem defined + + + + + Updates the Meridiem + + Text + Current date time + + + + + Updates the date value + + Text + Current date Time + Updated date value + + + + Updates Day + + Date value + Current date time + Count + + + + + Gets the culture. + + The local ID. + + + + + Updates Month + + Date value + Current date time + Count + + + + + Gets the culture from the character format. + + The CultureInfo obtained from the character format. + + + + Gets the haskey from the character format. + + The character format from which to retrieve the culture. + The CultureInfo obtained from the character format if the culture is present. + Return true if the format contains the culture value; otherwise, return false. + + + + Gets the haskey from the base format. + + The character format from which to retrieve the culture. + The CultureInfo obtained from the character format if the culture is present. + Return true if the format contains the culture value; otherwise, return false. + + + + Retrieves the first valid text range within the field. If none of the text ranges are valid, returns the current field. + + The first valid text range within the field, or the current field if none are valid. + + + + Retrieves the first field code entity for a text body item. + + The text body entity to search for a field code. + The first field code entity found within the specified entity, or null if no field code is found. + + + + Retrieves the first field code entity for a table. + + The table entity to search for a field code. + The first field code entity found within the specified entity, or null if no field code is found. + + + + Retrieves the first field code entity for a paragraph item. + + The paragraph item entity to search for a field code. + The first field code entity found within the specified entity, or null if no field code is found. + + + + Updates year + + Date value + Current date time + Count + + + + + Updates hour + + Date value + Current date time + Count + + + + + Updates Minute + + Date value + Current date time + Count + + + + + Updates Seconds + + Date value + Current date time + Count + + + + + Checks the field separator. + + + + + + Gets the formatting for hyper link. + + + + + Gets the cloned table. + + + The entity. + + + + + Gets the cloned content control + + The entity to be cloned + + + + + Updates the cloned text body item. + + The source. + The destination. + + + + Gets the cloned paragraph. + + The entity. + The TXT. + The next item. + + + + + Updates the field items. + + The item. + The entity. + The paragraph. + The items to update. + + + + + Checks whether empty para is considered as result for field + + + + + Gets the index of the paragraph item. + + The entity. + The TXT. + + + + + Gets the start index of the item. + + The index. + The text. + + + + + Merges the field mark paragraphs. + + + + + Removes the previous result. + + + + + Removes the previous result. + + + + + + Checks the pragragh. + + The paragraph. + + + + Updates the paragraph text. + + The paragraph. + if set to true [is last item]. + The result. + + + + Gets the paragraph item text. + + The item. + + + + + Updates the field result. + + The text. + + + + Updates the field result. + + The text. + if set to true [is from hyper link]. + + + + Gets the text range. + + + The text. + + + + + Skips the layouting of field code. + + + + + Splits text range by paragraph break(\r\n). + + + + + Splits the text range into new paragraph. + + The entity to split text range. + + + + Skips the layouting of macro button field code. + + + + + Splits the character by white space and extracts the valid test. + + + + + + + + + Skips the layouting of paragraph item. + + The entity. + + + + Skips the layouting of text body item. + + The entity. + + + + Skips the layouting of table. + + The entity. + + + + Set skip for items to avoid Doc to PDF layouting. + + The start index. + Item collection paragraph items or text body items + True;if field end reached, Otherwise;false + + + + Gets the next sibling if current item is perserved inside InlineContentControl. + + + + + + Iterate Field Range Items and skip field result entity. + + + + + Skip the table child entities. + + Field End table. + Field End table cell. + Return true; if the Field is in table;Else false. + + + + Skip the other item in the paragraph except Field end + + ParagraphItemCollection. + + + + Gets the layouted EQ field size. + + Graphics object for EQ field. + Charcter format for EQ field. + + + + + Used to split, validate, and layout the inputed . + + Represents a inputed fieldcode of equation field. + Represents as object which act as drawing context. + Represents a which set for equation field. + Represents a which set for equation field. + Represents a X position of equation field. + Represents a Y position of equation field. + Returns a complete for the inputed + + + + Determine whether the given EQ field code valid or not. + + Field code to validate. + Returns true if it is valid field code, else false. + + + + Determine whether the given EQ switch valid or not. + + Represents a field code to find and perform validation on corresponding EQ switch. + Returns true, if it is valid field code, else return false. + + + + Used to create corresponding eqution field for the . + + Represent a field code of the equation field. + Represents a object which act as drawing context. + Represents a which set for equation field. + Represents a X position of equation field. + Represents a Y position of equation field. + Return an equation field for the inpute field code. + + + + Generetes a equation field switch. + + Represents a EQ switch to save layouted elements. + Represents a field code of equation field switch. + Font for equation field. + Represents as object which act as drawing context. + Represents a of equation field switch. + Represents a X position of equation field. + Represents a Y position of equation field. + + + + Generetes nested equation field switch. + + Represents a EQ switch to save layouted elements. + Represents a field code of equation field switch. + Represents as object which act as drawing context. + Represents a of equation field switch. + Represents a X position of equation field. + Represents a Y position of equation field. + + + + Generetes normal text in equation field switch. + + Represents a EQ switch to save layouted element. + Represents a field code of equation field switch. + Font for equation field. + Represents as object which act as drawing context. + Represents a of equation field switch. + Represents a X position of equation field. + Represents a Y position of equation field. + + + + Layout the radical equation field switch. + + Represents the field codes of radical equation field switch. + Represents as object which act as drawing context. + Represents a which set for radical equation field switch. + Represents a X position of radical equation field switch. + Represents a Y position of radical equation field switch. + Returns layouted radical switch. + + + + Generates the radical equation field switch using their field code. + + Represents the radical equation field switch containing elements. + Represents the elements to be added into the radical switch. + Represents as object which act as drawing context. + Represents a which set for radical equation field switch. + Represents a X position of radical equation field switch. + Represents a Y position of radical equation field switch. + Returns the radical equation field switch, including their elements. + + + + Generates outer element of radical switch and shift the position. + + Represents the radical equation field switch containing elements. + Outer element of radical EQ switch. + Represents as object which act as drawing context. + Represents a which set for radical equation field switch. + Represents a X position of radical equation field switch. + Represents a Y position of radical equation field switch. + Y position for outer element. + Right most X for outer element. + + + + Shift the Radical lines Y position. + + Layouted radical symbol of radical EQ field. + Position to shift the radical symbol. + + + + Update radical switch bounds. + + Layouted radical EQ field. + + + + Generates a radical symbol as per outer and inner elements. + + Represents a radical switch, to maintain all its elements. + Represents an element inside the radical symbol. + Represents a X position of radical equation field switch. + Right most position of outer element. + Baseline Y position of outer element of radical EQ switch. + Returns a radical equation field switch including symbol and elements. + + + + Update the bounds of radical switch after generating symbol. + + Radical EQ switch to set bounds. + Inner element of the radical switch. + Hook part of the radical symbol. + Upward line of the radical symbol. + Top line of the radical symbol. + Thickness of the lines. + X position of the radical switch. + + + + Generates upward line of radical symbol. + + Inner elment of the radical EQ switch. + Upward line of the radical symbol to generate. + Thickness of the line to generate + + + + Generates downward line of radical symbol. + + Inner elmenet of the radical EQ switch. + Upward line of the radical symbol, which already generated. + Downward line of the radical symbol, to generate. + Thickness of the line to generate + Point values for generating hook portion of radical symbol. + + + + Generates top horizontal line of radical symbol. + + Inner elmenet of the radical EQ switch. + Upward line of the radical symbol, which already generated. + Top horizontal line of the radical symbol. + Thickness of the line to generate + + + + Generate hook portion of radical symbol. + + Inner elmenet of the radical EQ switch. + Hook portion of root symbol to generate. + Thickness of the line to generate + Height of the hook to generate. + One of the point of hook symbol. + + + + Get the position for outer element of radical EQ switch. + + Hook part of the radical symbol. + Upward line of the radical symbol. + Top line of the radical symbol. + Thickness of the lines. + Right x position of the outer elmeent. + Y of the outer element of radical switch. + + + + Get the another length from the known angles. + + Opposite side of angle1. + One of the angle, whose opposite side is known value. + Another angle, whose opposite side need to calculate + Returns calculated width from height and angles. + + + + Converts degrees into radian. + + Represents an angle in degree + Returns radian value of inputed degree value. + + + + Determines whether the inputed radical field code is valid or not. + + Represents a field code of radical equation field switch. + Return true if valid, otherwise return false. + + + + Determines whether an inputed field code of list equation field switch is valid or not. + + Represents the field code of list equation field switch. + Returns true if it is valid field code, otherwise returns false. + + + + Layout the list equation field switch using their elements. + + Represents a fieldcode of list equation switch. + Represents as object which act as drawing context. + Represents a of list equation field switch. + Represents a X position of list equation field. + Represents a Y position of list equation field. + Returns a layouted list equation field switch. + + + + Generetes a list equation field switch. + + Represents a list switch to save layouted elements. + Represents a field code of list equation field switch. + Represents as object which act as drawing context. + Represents a of list equation field switch. + Represents a X position of list equation field. + Represents a Y position of list equation field. + + + + Determines whether inputed supercript or subscript field code is valid or not. + + Represents a field code of superscript EQ switch. + Returns true if validation success, else return false. + + + + Checks whether the inputed code is correct sequence of superscript or subscript EQ switch. + + Field code of superscript or subscript EQ switch. + Returns true, if it is correct sequence, else returns false. + + + + Checks the value in string is whether positive or negative. + + Input string to check value. + Returns true for positive value, else return false. + + + + Layout the superscript or subscript EQ switch. + + Represents a field code of superscript or subscript EQ switch. + Represents as object which act as drawing context. + Represents a of superscript or subscript equation field switch. + Represents a X position of superscript or subscript equation field. + Represents a Y position of superscript or subscript equation field. + Returns layouted superscript or subscript EQ switch. + + + + Genrates a superscript or subscript EQ switch. + + Represents a superscript or subscript switch to layout. + Represents the elements of superscript or subscript switch. + Represents as object which act as drawing context. + Represents a of superscript or subscript EQ switch. + Represents a X position of superscript or subscript EQ switch. + Represents a Y position of superscript or subscript EQ switch. + Returns generated superscipt or subscript EQ switch. + + + + Adds space to below EQ switch. + + Represents a EQ switch to add space. + Represents a value of space to add. + + + + Add space to above of EQ switch. + + Represents a EQ switch to add space. + Represents a value of space to add. + + + + Gets space value to add below superscript or subscript EQ switch. + + Represents a fieldcode of superscript or subscript EQ switch. + Returns a value to add below superscript or subscript EQ switch. + + + + Gets space value to add above superscript or subscript EQ switch. + + Represents a fieldcode of superscript or subscript EQ switch. + Returns a value to add above superscript or subscript EQ switch. + + + + Aligns the items in like single column array. + + Represents a EQ switch to align. + + + + Set property values from super or subscript switch field code. + + Represent a switch with elements. + Represents a super or subscript field code. + Represents as object which act as drawing context. + + + + Align the script switch as superscipt switch using property value. + + Represents as + object which act as drawing context. + Represents superscript or subscript switch. + Value to shift the superscript or subscript EQ switch, + to make it a superscript switch. + + + + Align the script switch as subscript switch using property value. + + Represents as object which act as drawing context. + Represents superscript or subscript switch. + Value to shift the superscript or subscript EQ switch, to make it a subscript switch. + + + + Gets the super/sub script properties values. + + Up value property for superscript switch. + Down value for superscript switch. + Determines whether switch has up or down value + + + + Extract the digit value from the given string. + + Represents a input to extract digit from it. + Returns a digit from string. + + + + Gets the maximum height of layouted EQ fields. + + Layouted EQ field + Maximum height of layouted EQ fields + Return maximum bottom of the layouted EQ fields. + + + + Used to layout the fraction equation field switch. + + Represents a fieldcode of the fraction equation field switch. + Represents a object which act as drawing context. + Represents a of fraction equation field switch. + Represents a X position of fraction equation field switch. + Represents a Y position of fraction equation field switch. + Return an fraction equation field for the inpute field code. + + + + Generates the EQ fraction switches. + + Layouted fraction switches + Numerator and denominator values + Represents a object which act as drawing context. + Represents a of fraction equation field switch. + Represents a X position of fraction equation field switch. + Represents a Y position of fraction equation field switch. + + + + Inserts the fraction line between the numarator and denominator. + + Fraction switch to save all its elements + Numerator of fraction switch. + Denominator of fraction switch. + Represents a object which act as drawing context. + Represents a of fraction equation field switch. + Represents a X position of fraction equation field switch. + Represents a Y position of fraction equation field switch. + + + + Set x position for fraction elements. + + Fraction line between two elements. + Numerator of fraction switch. + Denominator of fraction switch. + Represents a X position of fraction equation field switch. + Represents a Y position of fraction equation field switch. + + + + Set y for numerator and denominator. + + /// Numerator of fraction switch. + Denominator of fraction switch. + Represents a object which act as drawing context. + Represents a X position of fraction equation field switch. + Represents a Y position of fraction equation field switch. + + + + Find the value to center align the EQ switch. + + Switch to consider for alignment. + Maximum width consider to center the alignment. + Returns value to set for center alignment of inputed switch. + + + + Determine whether the given fraction switch is valid or not. + + Represents a Fraction switch field code to perform validation. + Returns true if validation success , else return false. + + + + Used to layout the each in X and Y co-ordinates. + + Represent an equation field to maintain all layouted equation fields. + Represent a splitted from the inputed field code. + Represents a object which act as drawing context. + Represents a which set for equation field. + Represents a X position of equation field. + Represents a Y position of equation field. + Return a layouted equation field for the inputed field code. + + + + Layout the bracket EQ switch. + + Represents a field code of bracket EQ switch. + Represents a object which act as drawing context. + Represents a for bracket EQ switch. + Represents a X position of bracket EQ switch. + Represents a Y position of bracket EQ switch. + Returns a layouted bracket switch. + + + + Extract the opening and closing character from the bracket switch field code. + + Represents a field code of bracket switch. + Represents a opening character for bracket EQ switch. + Represents a closing character for bracket EQ switch. + + + + Gets corresponding closing character for inputed character. + + Opening character of bracket. + Returns corresponding closing character for opening character. + + + + Generates a bracket switch using their elements. + + Represents a bracket switch to maintain its elements. + Represents the element of bracket EQ switch. + Represents an open bracket for bracket EQ switch. + Represents a closing bracket of bracket EQ switch. + Represents a object which act as drawing context. + Represents a for bracket EQ switch. + Represents a X position of bracket EQ switch. + Represents a Y position of bracket EQ switch. + + + + Generates opening bracket of bracket EQ switch. + + Represents a bracket switch to maintain its elements. + Represents an open bracket for bracket EQ switch. + Represents a object which act as drawing context. + Represents a for bracket EQ switch. + Represents a X position of bracket EQ switch. + Represents a Y position of bracket EQ switch. + Denotes the height of character is minimum to increase by font size. + Height to generate opening bracket. + Extra width to add with normal width. + Value to adjust the bracket to enclosing the bracket switch. + + + + Generates closing bracket of bracket EQ switch. + + Represents a bracket switch to maintain its elements. + Represents a closing bracket of bracket EQ switch. + Represents a object which act as drawing context. + Represents a for bracket EQ switch. + Represents a X position of bracket EQ switch. + Represents a Y position of bracket EQ switch. + Denotes the height of character is minimum to increase by font size. + Height to generate opening bracket. + Extra width to add with normal width. + Extra position to preserve correct closing bracket. + + + + Determines whether the brackets contains the minimum height or not + + Character to compare the height. + Represents a object + which act as drawing context. + Represents a for bracket EQ switch. + Maximum height of the character to generate. + Returns true, if height of the character to generate + is greater than maximum height of normal character , else false. + Each character has certain limit to generate by increasing font size. + If height is greater than that limit, then the character is generated using parts of unicodes. + + + + Generates a character as per bracket switch height from inputed character. + + Representsa to save generated character. + Input character to genreate corresponding character in size. + Represents a object which act as drawing context. + Represents a to set for input character. + Represents a X position where to generate character. + Represents a Y position where to generate character. + Represents a maximum height for the character to generate. + + + + Changes the font size of the character, instead of generating character from parts of Unicodes. + + Representsa to save generated character. + Input character to genreate corresponding character in size. + Represents a object which act as drawing context. + Represents a to set for input character. + Represents a X position where to generate character. + Represents a maximum height for the character to generate. + + + + Generates a parenthesis using its parts of Unicodes and layouted as single element. + + A to save all parts of layouted charaacters. + Unicode of upper hook of parenthesis. + Unicode of Parenthesis extenion. + Unicode of lower hook of parenthesis. + Represents a object which act as drawing context. + Represents a to set for parenthesis. + Represents a X position where to generate parenthesis. + Represents a Y position where to generate parenthesis. + Represents a maximum height of the parenthesis to generate. + + + + Generates middle part of the paranthesis using Unicode. + + A to save all parts of layouted charaacters. + Unicode of middle part of parenthesis. + Represents a middle part of layouted Unicode. + Represents a lower part of layouted Unicode. + Represents a object which act as drawing context. + Represents a to set for parenthesis. + Represents a X position where to generate parenthesis. + Represents a Y position where to generate parenthesis. + Maximum height to generate middle part of parenthesis. + + + + Generates a square bracket from parts of unicodes and save it as one + + A to save all parts of layouted charaacters. + Unicode of upper corner of square bracket. + Unicode of square bracket extenion. + Unicode of lower corner of square bracket. + Represents a object which act as drawing context. + Represents a to set for square bracket. + Represents a X position where to generate square bracket. + Represents a Y position where to generate square bracket. + Represents a maximum height of the square bracket to generate. + + + + Generates a curly brace from parts of unicodes and save it as one , + + A to save all parts of layouted charaacters. + Unicode of upper hook of curly brace. + Unicode of middle peice of curly brace. + Unicode of lower hook of curly brace. + Unicode of curly bracket extension. + Represents a object which act as drawing context. + Represents a to set for curly brace. + Represents a X position where to generate curly brace. + Represents a Y position where to generate curly brace. + Represents a maximum height of the curly brace to generate. + + + + Generates upper extension part of curly brace. + + A to save all parts of layouted charaacters. + Unicode of extension part of bracket. + Represents a middle part of layouted Unicode. + Represents a object which act as drawing context. + Represents a to set for bracket. + Represents a X position where to generate bracket. + Represents a Y position where to generate bracket. + Maximum height to generate extension part. + + + + Generates lower part extension of curly brace. + + /// A to save all parts of layouted charaacters. + Unicode of extension part of bracket. + Represents a lower part of layouted Unicode. + Represents a object which act as drawing context. + Represents a to set for bracket. + Represents a X position where to generate bracket. + Represents a Y position where to generate bracket. + Maximum height to generate extension part. + + + + Generates upper part of bracket. + + A to save all parts of layouted charaacters. + Unicode of upper part of bracket. + Represents a upper part of layouted Unicode. + Represents a object which act as drawing context. + Represents a to set for bracket. + Represents a X position where to generate bracket. + Represents a Y position where to generate bracket. + + + + Generates lower part of bracket. + + A to save all parts of layouted charaacters. + Unicode of lower part of bracket. + Represents a lower part of layouted Unicode. + Represents a object which act as drawing context. + Represents a to set for bracket. + Represents a X position where to generate bracket. + Represents a Y position where to generate bracket. + + + + Generates repeated character from inputed unicode untill it reaches maximum height + + Represents a to save multiple layouted character. + Unicode for character to generate repeatedly. + Represents a object which act as drawing context. + Represents a to set for character. + Represents a X position where to generate character. + Represents a Y position where to generate character. + Maximum height to generate characters. + Font size for the character to generate. + + + + Checks whether the inputed field code is valid bracket EQ switch field code or not. + + Represents a field code of bracket EQ switch. + Returns true if it is valid field code, else returns false. + + + + Checks whether bracket EQ switch is in correct pattern or not. + + Represents a properties of bracket EQ switch. + Returns true if it is correct pattern, else return false. + + + + Validate whether the inputed field code of box equation field switch is valid or not. + + Represents a field code of box switch. + Returns true, if it is valid field code, else returns false. + + + + Checks whether the inputed code is correct sequence of box EQ switch. + + Field code of box EQ switch. + Returns true, if it is correct sequence , else returns false. + + + + Create layout for EQ box switch. + + Represents a field code of box equation field switch. + Represents as object which act as drawing context. + Represents a of box equation field switch. + Represents a X position of box equation field. + Represents a Y position of box equation field. + Returns a layouted box EQ switch. + + + + Retrives the properties from the box switch field code. + + Field code of box EQ switch. + Represents whether left side line is need to generate or not. + Represents whether top side line is need to generate or not. + Represents whether right line is need to generate or not. + Represents whether bottom line is need to generate or not. + + + + Inserts a box to the boundary of box EQ switch. + + Represents a box EQ switch consider to generate a box. + Represents whether left side line is need to generate or not. + Represents whether top side line is need to generate or not. + Represents whether right line is need to generate or not. + Represents whether bottom line is need to generate or not. + Extra width to add if it has any line. + + + + Adds the line EQ child into the layouted equation fields. + + Layouted box EQ field. + Point x1 + Point x2 + Point y1 + Point y2 + + + + Generates a box EQ switch using thier elements. + + Represent a box EQ switch to save layouted elements.. + Represent an element of box EQ switch. + Represents as object which act as drawing context. + Represents a of box equation field switch. + Represents a X position of box equation field. + Represents a Y position of box equation field. + Retruns generated box switch. + + + + Layout a integral EQ switch. + + Represents a field code of integral EQ switch. + Represents as object which act as drawing context. + Represents a which set for integral equation field switch. + Represents a X position of integral equation field switch. + Represents a Y position of integral equation field switch. + Returns layouted integral EQ switch. + + + + Gets the symbol and position of limits whether inline or normal from the integral EQ switch field code. + + Represents a field code of integral switch. + Sets whether limits are inline or normal limits. + Sets the symbol for integral switch. + Denotes whether symbol is need to layout as varible in size or not, as per size of integrand. + + + + Generates a integral EQ switch using their elements. + + Represents a integral Eq switch to save layouted elements. + Represents an element of integral EQ switch. + Represents whether the limits are inline or not. + Represents whether the symbol vary as per integrand size or not, if it is other than preferred symbols. + Represents a symbol to used in integral EQ switch. + Represents as object which act as drawing context. + Represents a which set for integral equation field switch. + Represents a X position of integral equation field switch. + Represents a Y position of integral equation field switch. + + + + Generates elements of integral EQ switch. + + Upper limit of the integral EQ switch. + Lower limit of the integral EQ switch. + Integrand of the integral EQ switch. + Maximum width among limits. + Elements to layout for integral EQ switch. + Represents as object which act as drawing context. + Represents a which set for integral equation field switch. + Represents a X position of integral equation field switch. + Represents a Y position of integral equation field switch. + + + + Calculates the height of the symbol from elements. + + Upper limit of the integral EQ switch. + Lower limit of the integral EQ switch. + Integrand of the integral EQ switch. + Denotes the position of limits. + Height of the symbol to generate. + + + + Set position for integral elments. + + Denotes the position for limits. + Upper limit of the integral EQ switch. + Lower limit of the integral EQ switch. + Integrand of the integral EQ switch + Symbol of the integral EQ switch. + Integral siwthc to hold all layouted elements. + Represents as object which act as drawing context. + Represents a which set for integral equation field switch. + Represents a X position of integral equation field switch. + Represents a X position of integral equation field switch. + Maximum width among limits. + Symbol in the integral EQ switch. + + + + Aligns the elements and symbol of integral EQ switch, when limits are inline. + + Upper limit of the integral EQ switch. + Lower limit of the integral EQ switch. + Integrand of the integral EQ switch + Symbol of the integral EQ switch. + Represents as object which act as drawing context. + Represents a X position of integral equation field switch. + Represents a which set for integral equation field switch. + Represents a X position of integral equation field switch. + Integral switch to hold all layouted elements. + Symbol to generate for integral switch. + + + + Align the elements and symbol of integral EQ switch, when limits are not inline. + + Upper limit of the integral EQ switch. + Lower limit of the integral EQ switch. + Integrand of the integral EQ switch + Symbol of the integral EQ switch. + Represents as object which act as drawing context. + Represents a which set for integral equation field switch. + Maximum width among limits. + Integral switch to hold all layouted elements. + + + + Aligns the elements and Pi or Summation symbol of integral EQ switch. + + Upper limit of the integral EQ switch. + Lower limit of the integral EQ switch. + Integrand of the integral EQ switch + Symbol of the integral EQ switch. + Represents as object which act as drawing context. + + + + Align the elements and integral symbol of integral switch. + + Upper limit of the integral EQ switch. + Lower limit of the integral EQ switch. + Integrand of the integral EQ switch + Symbol of the integral EQ switch. + Represents as object which act as drawing context. + Represents a which set for integral equation field switch. + + + + Get the extra value to shift lower limit. + + Height of the layouted integrand of integral EQ switch. + Represents as object which act as drawing context. + Represents a which set for integral equation field switch. + Retruns a value to add with the lower limit shifting value. + + + + Gets the extra height which is need to add before and after of integral symbol. + + + + + + + + Calculate the space to add to center align the element, for both vertical and horizontal + + Maximum size which consider for center align + Size of element to layout in center. + + + + Generates symbol for integral EQ switch as per inputed height. + + Layouted integrand of integral EQ switch. + Represents a to save generated symbol. + A character or Unicode to generate as a symbol. + Denotes whether symbol is vary in size as per maximum height. + Represents as object which act as drawing context. + Represents a for symbol. + Represents a X position of symbol. + Represents a Y position of symbol. + Represents a maximum height to layout a symbol. + + + + Gets the font size for integral symbol to generate. + + Layouted integrand of integral EQ switch. + Returns the font size used for integral symbol. + + + + Generates intergal symbol from two parts. + + Represents a to save generated symbol. + Represents as object which act as drawing context. + Represents a for symbol. + Represents a X position of symbol. + Represents a Y position of symbol. + Font size for the each part of integral symbol. + + + + Generates the integral symbol by using its parts of unicode. + + Represents a to save generated symbol. + Represents as object which act as drawing context. + Represents a for symbol. + Represents a X position of symbol. + Represents a Y position of symbol. + Represents a maximum height need to generate symbol. + Font size for the each part of integral symbol. + + + + Generates the upper part of integral symbol using its unicode. + + Represents a to save generated symbol. + Represents as object which act as drawing context. + Represents a for symbol. + Represents a X position of symbol. + Represents a Y position of symbol. + Represents a layouted upper part of integral symbol. + Font size for the upper part o integral symbol. + + + + Generates the lower part of integral symbol using its unicode. + + Represents a to save generated symbol. + Represents as object which act as drawing context. + Represents a for symbol. + Represents a X position of symbol. + Represents a Y position of symbol. + Represents a layouted lower part of integral symbol. + Font size for the lower part of integral symbol. + + + + Generates the middle part of integral symbol using its unicode. + + Represents a to save generated symbol. + Represents as object which act as drawing context. + Represents a for symbol. + Represents a X position of symbol. + Represents a Y position of symbol. + Represents a layouted lower part of integral symbol. + Represents a middle part of integral symbol. + Represents a maximum height to generate middle extension part. + Font size for the middle part of integral symbol. + + + + Determines whether the inputed fied code if valid integral EQ switch field code. + + Represents a field code of integral EQ switch. + Returns true if it is valid field code, else returns false. + + + + Checks whether the inputed field code has correct sequence for integral EQ switch or not. + + Represents a field code of integral EQ switch to check. + Returns true if input has correct sequence, else returns false. + + + + Validate whether the inputed field code of overstrike EQ switch is valid or not. + + Represents a field code of overstrike EQ switch. + Returns true, if it is valid field code, else returns false. + + + + Checks whether the inputed field code is correct format of overstrike EQ switch. + + Field code of overstrike EQ switch. + Returns true, if it is correct sequence, else return false. + + + + Layout a overstrike EQ switch. + + Represents a field code of oversrike EQ switch. + Represents as object which act as drawing context. + Represents a which set for overstrike EQ switch. + Represents a X position of overstrike EQ switch. + Represents a Y position of overstrike EQ switch. + Returns layouted overstrike EQ switch. + + + + Generates an overstrike EQ switch. + + An overstrike switch to save all its layouted elements. + Element of overstrike switch to layout. + Alignment property to set for overstrike EQ switch. + Represents as object which act as drawing context. + Represents a which set for overstrike EQ switch. + Represents a X position of overstrike EQ switch. + Represents a Y position of overstrike EQ switch. + + + + Align the layouted overstrike EQ switch elements as per alignment property. + + Represents an overstrike switch, need to align. + Represents a type of alignment which will set for overstrike elements. + + + + By iterating to each property of overstrike EQ switch, get the alignment propery. + + Field code of overstrike EQ switch. + Represents an alignment property retrieved from field code. + + + + Determines whether inputed field code of array EQ switch is valid or not. + + Represents a field code of array EQ switch. + Returns true if validation success, else return false. + + + + Check whether the inputed code is correct sequence of array EQ switch. + + Field code of array EQ switch. + Returns true, if input code is correct format, else returns false. + + + + Layout an array EQ switch. + + Represents a field code of array EQ switch. + Represents as object which act as drawing context. + Represents a which set for array EQ switch. + Represents a X position of array EQ switch. + Represents a Y position of array EQ switch. + Returns layouted array EQ switch. + + + + Gets the array switch properties from array EQ switch fieldcode. + + Field code of array EQ switch. + Number cof columns value, to layout the array switch. + Vertical space value, to add in between each row. + Horizontal space value, to add in between each column. + Represents an alignment of array switch. + + + + Gets an alignment property from the field code of array EQ switch. + + Field code of array EQ switch, which is one of the alignment property. + Represents an alignment of array EQ switch. + + + + Generates an array EQ switch. + + Layouted array switch to save all its layouted elements. + Element to layout in array switch. + Space value to add between each column in array switch. + Space value to add between each row in array switch. + Number of columns to layout the array elements in columnwise manner. + Represents as object which act as drawing context. + Represents a which set for array EQ switch. + Represents a X position of array EQ switch. + Represents a Y position of array EQ switch. + + + + Layout each elements of array EQ switch. + + Layouted array switch to save all its layouted elements. + Element to layout in array switch. + Space value to add between each column in array switch. + Space value to add between each row in array switch. + Number of columns to layout the array elements in columnwise manner. + Represents as object which act as drawing context. + Represents a which set for array EQ switch. + Represents a X position of array EQ switch. + Represents a Y position of array EQ switch. + + + + Align the generated array EQ switch to the normal line of text. + + Represents an array switch to align. + Represents as object which act as drawing context. + Represents a which set for array EQ switch. + + + + Checks whether an element is available in the index of array EQ switch. + + An array EQ switch to check the element. + Row of array EQ switch to search for element. + Column of array EQ switch to search for element. + Return true if element is available at the position, elese returns false. + + + + Calculates the maximum number of rows and columns in array EQ switch. + + An array EQ switch to count the rows and columns. + Represents the number of rows in array EQ switch. + Represents the number of columns in array EQ switch. + + + + Set Y position for each element in array EQ switch. + + An array EQ switch to layout the elements. + Represents as object which act as drawing context. + Maximum number of rows in array switch. + Maximum number of columns in array switch. + + + + Set width for columns from the maximum width of element in the column. + + Represents an array switch to layout columns. + Maximum number of rows in array switch. + Maximum number of columns in array switch. + + + + Set X for each elements in column. + + /// Represents an array switch to set x value.. + Maximum number of rows in array switch. + Denotes the column index to set X values for all elements. + X position for elements in column. + + + + Get the maximum width of the particular column, by comparing width of each element. + + An array switch need to layout. + Index of column to find the maximum width. + Return maximum width of the column. + + + + Determines whether inputed field code of Displace EQ switch is valid or not. + + Represents a field code of Displace EQ switch. + Returns true if validation success, else return false. + + + + Layout a displace EQ switch. + + Represents a field code of displace EQ switch. + Represents as object which act as drawing context. + Represents a which set for displace EQ switch. + Represents a X position of displace EQ switch. + Represents a Y position of displace EQ switch. + Returns layouted displace EQ switch. + + + + Generates an displace EQ switch. + + Represents a displace EQ switch to save its layouted elements. + Element of displace EQ switch to layout. + Represents n values used for shifting in displace EQ switch. + Represents whether line is to be drawn or not in displace EQ switch. + Represents as object which act as drawing context. + Represents a which set for displace EQ switch. + Represents a X position of displace EQ switch. + Represents a Y position of displace EQ switch. + + + + Shift the displace EQ switch as per shiftvalue, which is forward or backward. + + Represents a displace switch to perform shifting. + Represents n values used for shifting in displace EQ switch. + Represents whether line is drawn or not. + Represents as object which act as drawing context. + Represents a which set for displace EQ switch. + Represents a X position of displace EQ switch. + Represents a Y position of displace EQ switch. + + + + Generates line for "li" property in displace EQ switch. + + Represents a displace switch to save generate line. + Represents as object which act as drawing context. + Represents a which set for displace EQ switch. + Represents a X position of displace EQ switch. + Represents a Y position of displace EQ switch. + Represents the length of line to generate. + + + + Set width as zero including its inner elementsof switch, to make field overlap with following text. + + Represents a to set width as zero + + + + Generates space to fill the specified width of EQ switch. + + A to save the layouted space. + Represents a width of switch of layouted EQ switch, consists of spaces. + Represents as object which act as drawing context. + Represents a which set for displace EQ switch. + Represents a X position of displace EQ switch. + Represents a Y position of displace EQ switch. + + + + Gets the properties of displace EQ switch from fielcode. + + Field code of displace EQ switch. + Represents n values used for shifting in displace EQ switch. + Represents whether line is to be drawn or not in displace EQ switch. + + + + Checks the given code in correct format. + + Input code, it is one of the properties of EQ switch. + Represent whether the inputed may contain negative values or not. + Returns true if inputed is in correct format, else returns false. + + + + Split the input as text part and start of integer part. + + Input text to perform splitting + Reference to store splitted integer part. + + It splits the as text part untill it reacher first occcurence of integer. + And the remaining string is considered as integer part. + + + + + Calculate the font size with respect to the desired height. + + Text to increase the font size. + Desired height of the inputed text. + Represents as object which act as drawing context. + Represents a character format to used for measuring. + Returns the size of font, to make the text in desired height. + + + + Layout the EQ field in vertical center alignment. + + EQ field need to shift to set in vertical center. + EQ field to consider for height and position to be layout, which is stable. + Represents a object which act as drawing context. + + + + Gets the list separator from the current culture. + + Returns a list separator of the current culture. + + + + Split the inputed string by comma, ignoring the comma with slash as prefix. + + Represents a text to split. + Returns a collection of splitted strings. + + + + Updates the layouted EQ fields bounds. + + layouted EQ fields. + + + + Shift the x position of the layuted EQ fields. + + layouted EQ field + Value of X to shift. + + + + This method indicate whether the provide EQ field code + contains any switch or not. + + EQ field code + Returns true if input code has any switch, else false. + + + + Extract the particular from the EQ field codes + + field code + Return the field code by ignoring elements and other text. + + + + Split the EQ field code based on the switches. + + Collection to hold the splited switches. + EQ field code + + + + Gets the top most Y position of layouted EQ fields. + + Layouted EQ field. + Minimum value of y position. + Returns minimum value of y position. + + + + Gets the letf most x position of layouted EQ fields. + + Layouted EQ fields + X position + Returns left most X value of EQ fields. + + + + Gets the maximum right position of the layouted EQ field. + + Represents a layouted EQ field, to find maximum right position. + Represents a maximum width of the inputed layouted EQ field. + Returns maximum right position of the layouted EQ field. + + + + Check the inputed text has many characters. + + Text to check. + Return true if has many characters, else return false. + + + + Gets the substring till the first occurence of delimeter,skip if delimeter has backslash as prefix. + + Represents a original string to create a substring. + Delimeter consider for create substring + Returns substring from the inputed string. + + + + Validate character follwed by backslash is whether valid character of Equation field or not. + + Represents a text to check backslash validation. + Returns true if it has improper slash, else false. + + + + Collects the indexes of backslash, but ignore the slash with another slash as prefix. + + Represents a text to find the indexes of slash. + Return collection of indexes of backslashes in the inputed + + + + Determine whether the given switch contains the miss matched + parenthesis or not. + + Represents a to check balancing parenthesis. + Return true if it has mismatch parenthesis else, false. + + + + Checks the inputed text only has alphabets. + + Represents a text to check each charcater. + Return true if inputed text has only alphabets, else returns false. + + + + Gets the text from the before switch in the field code. + + EQ field code + Returns text before an EQ switch. + + + + Gets the first occurence of the EQ switches. + + EQ field code + Returns the EQ switch field code of beginning of first occured switch. + + + + Remove the EQ text and return field code of the equation field. + + Represents an inputed equation fieldcode. + Returns a field code, after removed unneccessary EQ text. + + + + Replaces backslash before comma, slash, and parenthesis into normal symbols. + + Represents a to perform replacement. + Returns a replaced text. + + + + Checks whether a character is exist in given arraay. + + Array to find the input character. + Character to search in array. /// + Returns true if it contains inputed character, else false. + + + + Get CharacterFormat of the PAGE and NUMPAGES field based on TextRanges preserved inside the field + + + + + + Get the character format from the existing field result (Before update) in the REF field. + + + + + + + Get FontScriptType of the PAGE and NUMPAGES field based on TextRanges preserved inside the field + + + + + + Gets the first field code entity formats. + + + + + + Determine whether the current Reference field as Bookmark cross reference field + + + + + + Initializing LayoutInfo value to null + + + + + Get Text Range preserved inside the PAGE and NUMPAGES field + + + + + + Determine whether the current Reference field as Bookmark cross reference field + + + + + + Implemented alternative method to improve the performance + + + + + + + + Check whether the current field ranges contains nested field in it + + + + + Check whether there is any nested field + + + + + + Get the current field as string + + Boolean to represent whether the string need till current field separator or not + Returns the string that represent the current field + + + + Gets or sets the text format field switch that defines how to display field results. + + + + + Gets the type of the entity. Read-only. + + The of the current item. + + + + Gets or sets field pattern. + + + + + Gets the field value. Read-only. + + The field value. + + + + Gets or sets field type. + + the represents the type of the field. + + + + Decides whether field should be updated automatically or not. + + + + + Decides whether the field should not be updated untill field code changed. + + + + + Is Local Hyperlink + + + + + Decides whether the field has a page field inside. + + + Boolean is used for Word to PDF layouting purpose. + + + + + Decides whether the field is inside of another field. + + + Boolean is used for Word to PDF layouting purpose. + + + + + Gets the formatting string. + + The formatting string. + + + + Gets the local reference for the hyperlink. + + The local reference. + + + + Gets or sets the screen tip text for hyperlink + + The string that specifies the screen tip. + + + + Gets or sets the field code. + + The field code information used to evaluate the resultant value of the field. + + + + Gets the field code of the current field. + + + + + Gets or sets the type of the source field. + + The type of the source field. + + + + Gets or sets the field result. + + The field result. + + + + Gets the range. + + The range. + + + + Gets or sets the field separator. + + The field separator. + + + + Gets or sets the field end. + + The field end. + + + + Gets or sets a value indicating whether the instance is cloned. + + + true if the instance is cloned; otherwise, false. + + + + + Gets or sets a value indicating whether the instance is added. + + + true if the instance is added; otherwise, false. + + + + + Gets or sets a value indicating whether field range updated. + + + true if field range updated; otherwise, false. + + + + + Gets or sets a value indicating whether is field separator. + + + true if is field separator; otherwise, false. + + + + + Gets or sets a value indicating whether skip the instance. + + + true if skip the instance; otherwise, false. + + + + + Gets or sets a value indicating whether the instance is updated. + + + true if the instance is updated; otherwise, false. + + + + + Check whether field is nested field and Inside the field separator + + + if the field is inside the field separator, set to true. + + + + + Gets or sets a value indicating whether the field is created while parsing "pgNum" element. + + True if the field is created while parsing "pgNum" element; otherwise, false. + + + + Gets or sets a value indicating whether this instance is number pages inside expression field. + + + true if this instance is number pages inside expression field; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is number page used for evaluation. + + + true if this instance is number page used for evaluation; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is field inside unknown field. + + + true if this instance is field inside unknown field; otherwise, false. + + + + + Gets the result format. + + + The result format. + + + + + Gets or sets the text. + + The string that specifies the text. + + + + Check Whether the current field contain field separator or not + + + + + Gets or Sets the OriginalField for AutoNum Fields + + + + + Returns the list of functions + + + + + Get or set the start position. + + + + + Month + + + + + + + + + + + + + + + Specifies whether the field has Form field data. + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + The form field. + The doc. + + + + Clones itself. + + + Returns cloned object. + + + + + + + + + Attaches to paragraph. + + The paragraph. + + + + + Detaches from owner. + + + + + Attaches for text body. + + + + + Detaches for text body. + + + + + Reads object data from xml attributes. + + + The object. + + + + Writes object data as xml attributes. + + + The object. + + + + Applies the new name of the bookmark. + + The old name. + The new name. + + + + Applies new bookmark name in bookmark collection of document. + + The old name. + The new name. + + + + + Applies the in owner para collection. + + The old name. + The new name. + + + + Checks if collection of bookmarks in document contains bookmark with specified name. + + The new name. + + + + Gets the form field text for Word Comparison + + + + + + Gets type of this form field. + + + + + Gets/sets form field title name (bookmark name). + + + + + Gets/sets form field help. + + + + + Gets or sets the status bar help. + + The status bar help. + + + + Gets / sets the name of macros on start + + + + + Gets / sets the name of macros on end + + + + + + + + + + + + + + + Gets or sets Enabled property (true if form field enabled). + + + + + Gets/sets calculate on exit property. + + + + + Gets or sets a value indicating whether this instance has form field data. + + + true if this instance has form field data; otherwise, false. + + + + + + + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + Creates a duplicate copy of the entity. + + + A reference to the newly created instance. + + + + Reads object data from xml attributes. + + + The object. + + + + Writes object data as xml attributes. + + + The object. + + + + Sets the size of the CheckBox. + + Size of the check box. + + + + Creates layout information. + + + + + + Gets the size of the CheckBox. + + The dc. + + + + + Initializing LayoutInfo value to null + + + + + Gets the Checkbox text for Word Comparison + + + + + + Gets the type of the entity. + + The of the current item. + + + + Gets or sets the size of the checkbox. + + The integer that specifies the size of checkbox. + + + + Gets or sets value indicating whether by default the checkbox is checked or not. + + True if the checked box is checked by default; otherwise, false. + + + + Gets or sets a value indicating whether the the checkbox is checked. + + True if the checked box is checked; otherwise, false. + + + + Gets or sets the type of the checkbox size. + + The member that specifies the checkbox size type. + + + + Represents the chart in the Word document. + + This class, its properties and methods are not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform and Xamarin applications. + The following code illustrates how to create a new chart. + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Input data for chart + Dim data As Object()() = New Object(5)() {} + For i As Integer = 0 To 5 + data(i) = New Object(2) {} + Next + data(0)(0) = "" + data(1)(0) = "Gravad lax" + data(2)(0) = "Louisiana Hot spiced Okara" + data(3)(0) = "Mascarpone Fabioli" + data(4)(0) = "Wimmers gute SemmelKnodel" + data(5)(0) = "Maxilaku" + data(0)(1) = "Sum of Purchases" + data(1)(1) = 286 + data(2)(1) = 680 + data(3)(1) = 288 + data(4)(1) = 200 + data(5)(1) = 731 + data(0)(2) = "Sum of Future Expenses" + data(1)(2) = 1300 + data(2)(2) = 700 + data(3)(2) = 1280 + data(4)(2) = 1200 + data(5)(2) = 2660 + 'Create and Append chart to the paragraph + Dim chart As WChart = paragraph.AppendChart(data, 470, 300) + 'Set chart type and title + chart.ChartType = OfficeChartType.Column_Clustered + chart.ChartTitle = "Purchase Details" + chart.ChartTitleArea.FontName = "Calibri" + chart.ChartTitleArea.Size = 14 + chart.ChartArea.Border.LinePattern = OfficeChartLinePattern.None + chart.PrimaryCategoryAxis.Title = "Products" + chart.PrimaryValueAxis.Title = "In Dollars" + 'Set position of legend + chart.Legend.Position = OfficeLegendPosition.Bottom + 'Save the document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + OfficeChart object to hold chart elements + + + + + Attaches to paragraph. + + The paragraph. + The item pos. + + + + Detaches from owner. + + + + + Creates a duplicate copy of the entity. + + + A reference to the newly created object. + + + + + + + + + + + Clears the object + + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + + + + + + Set chart data from excel file + + Worksheet number that has data for chart + Data ranga in the worksheet that has chart data + + + + Initialize the CharToImageConverter + + Current chart + + + + Sets the data for the chart from the specified collection. + + An that represents the two dimensional array. + + + + Sets the data for the chart from the specified collection with the row index and column index. + + An that represents the two dimensional array. + The integer that specifies the row of the first cell where array should be imported. + The integer that specifies the column of the first cell where array should be imported. + + + + Sets the data for the chart from the specified collection with the row index and column index. + + An object with desired data. + The integer that specifies the row of the first cell where array should be imported. + The integer that specifies the column of the first cell where array should be imported. + + + + + Replaces the chart data with the worksheet data. + + + Optional Boolean. Set to true to update all the formulas in the Excel sheet. The default value is false. + + + + //Open the template document. + WordDocument document = new WordDocument("Template.docx"); + //Get the paragraph. + WParagraph paragraph = document.LastParagraph; + //Get the chart entity. + WChart chart = paragraph.ChildEntities[0] as WChart; + //Replaces the chart data with the worksheet data. + chart.Refresh(true); + //Save and close the document + document.Save("Sample.docx"); + document.Close(); + + + 'Open the template document. + Dim document As WordDocument = New WordDocument("Template.docx") + 'Get the paragraph. + Dim paragraph As WParagraph = document.LastParagraph + 'Get the chart entity. + Dim chart As WChart = TryCast(paragraph.ChildEntities(0), WChart) + 'Replaces the chart data with the worksheet data.. + chart.Refresh(True) + 'Save and close the document + document.Save("Sample.docx") + document.Close() + + + + + + Creates layout information. + + + + + + Measures the size of chart + + + + + + + Gets the Chart as string for Word Comparison. + + + + + + Gets the chart properties for Word comparison + + + + + + Gets the chart properties for Word comparison + + + + + + To Compare two charts returns true if equal else returns false. + + + + + + Checks that the chart is of 2016 charts type + + + + + Gets or sets workbook data + + + + + Gets or sets the internal data file path of . + + + + + Decides whether chart item relation is external. + + + + + Gets or sets the type of the chart + + The member that specifies the type of chart. + + + + Gets or sets the external data file path of . + + + The following code illustrates how to sets the external data file path of . + + //Loads the template document + WordDocument document = new WordDocument("Template.docx"); + //Gets the last paragraph + WParagraph paragraph = document.LastParagraph; + //Gets the chart entity from the paragraph items + WChart chart = paragraph.ChildEntities[0] as WChart; + //Modifies the external data file path of chart + chart.ExternalDataPath = @"Data\Excel_Template.xlsx"; + //Saves and closes the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Loads the template document + Dim document As New WordDocument("Template.docx") + 'Gets the last paragraph + Dim paragraph As WParagraph = document.LastParagraph + 'Gets the chart entity from the paragraph items + Dim chart As WChart = TryCast(paragraph.ChildEntities(0), WChart) + 'Modifies the external data file path of chart + chart.ExternalDataPath = "Data\Excel_Template.xlsx" + 'Saves and closes the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets or sets IOfficeDataRange of the chart data. + + + + + Gets or sets value indicating whether chart series are represented as rows. + + True if the series are represented as rows; otherwise, false. + + + + Gets or sets the title of the chart. + + The string that specifies the chart title. + + + + Gets the IOfficeChartTextArea of the chart. Read-only. + + + + + Gets collection of IOfficeChartSeries present in the chart. Read-only. + + + + + Gets the primary category axis of the chart. Read-only. + + The IOfficeChartCategoryAxis instance that specifies the primary category axis. + + + + Gets the primary value axis of the chart. Read-only. + + The IOfficeChartValueAxis instance that specifies the primary value axis. + + + + Gets the primary series axis of the chart. Read-only. + + The IOfficeChartSeriesAxis instance that specifies the primary series axis. + + + + Gets the secondary category axis of the chart. Read-only. + + The IOfficeChartCategoryAxis instance that specifies the secondary category axis. + + + + Gets the secondary value axis of the chart. Read-only. + + The IOfficeChartValueAxis instance that specifies the secondary value axis. + + + + Gets the chart area. Read-only. + + The following code illustrates how to apply the formatting for chart area. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Get the paragraph + WParagraph paragraph = document.LastParagraph; + //Get the chart entity + WChart chart = paragraph.ChildEntities[1] as WChart; + //Format chart area. + IOfficeChartFrameFormat chartArea = chart.ChartArea; + //Set border line pattern, color, line weight + chartArea.Border.LinePattern = OfficeChartLinePattern.Solid; + chartArea.Border.LineColor = Color.Blue; + chartArea.Border.LineWeight = OfficeChartLineWeight.Hairline; + //Set fill type and fill colors + chartArea.Fill.FillType = OfficeFillType.Gradient; + chartArea.Fill.GradientColorType = OfficeGradientColor.TwoColor; + chartArea.Fill.BackColor = Color.FromArgb(205, 217, 234); + chartArea.Fill.ForeColor = Color.White; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Get the paragraph + Dim paragraph As WParagraph = document.LastParagraph + 'Get the chart entity + Dim chart As WChart = TryCast(paragraph.ChildEntities(1), WChart) + 'Format chart area. + Dim chartArea As IOfficeChartFrameFormat = chart.ChartArea + 'Set border line pattern, color, line weight + chartArea.Border.LinePattern = OfficeChartLinePattern.Solid + chartArea.Border.LineColor = Color.Blue + chartArea.Border.LineWeight = OfficeChartLineWeight.Hairline + 'Set fill type and fill colors + chartArea.Fill.FillType = OfficeFillType.Gradient + chartArea.Fill.GradientColorType = OfficeGradientColor.TwoColor + chartArea.Fill.BackColor = Color.FromArgb(205, 217, 234) + chartArea.Fill.ForeColor = Color.White + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the plot area of the chart. Read-only. + + The following code illustrates how to apply the formatting for plot area. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + WParagraph paragraph = document.LastParagraph; + //Get the chart entity + WChart chart = paragraph.ChildEntities[0] as WChart; + //Set border settings - line color, pattern, weight, transparency + chart.PlotArea.Border.AutoFormat = false; + chart.PlotArea.Border.IsAutoLineColor = false; + chart.PlotArea.Border.LineColor = Color.Blue; + chart.PlotArea.Border.LinePattern = OfficeChartLinePattern.DashDot; + chart.PlotArea.Border.LineWeight = OfficeChartLineWeight.Wide; + chart.PlotArea.Border.Transparency = 0.6; + //Set the plot area’s fill type, color + chart.PlotArea.Fill.FillType = OfficeFillType.SolidColor; + chart.PlotArea.Fill.ForeColor = Color.LightPink; + //Set the plot area shadow presence + chart.PlotArea.Shadow.ShadowInnerPresets = Office2007ChartPresetsInner.InsideDiagonalTopLeft; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + Dim paragraph As WParagraph = document.LastParagraph + 'Get the chart entity + Dim chart As WChart = TryCast(paragraph.ChildEntities(0), WChart) + 'Set border settings - line color, pattern, weight, transparency + chart.PlotArea.Border.AutoFormat = False + chart.PlotArea.Border.IsAutoLineColor = False + chart.PlotArea.Border.LineColor = Color.Blue + chart.PlotArea.Border.LinePattern = OfficeChartLinePattern.DashDot + chart.PlotArea.Border.LineWeight = OfficeChartLineWeight.Wide + chart.PlotArea.Border.Transparency = 0.6 + 'Set the plot area’s fill type, color + chart.PlotArea.Fill.FillType = OfficeFillType.SolidColor + chart.PlotArea.Fill.ForeColor = Color.LightPink + 'Set the plot area shadow presence + chart.PlotArea.Shadow.ShadowInnerPresets = Office2007ChartPresetsInner.InsideDiagonalTopLeft + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets the walls of the chart. Read-only. + + The 3D charts, stacked charts and clustered charts only can have walls. + + + + Gets the side wall of the chart. Read-only. + + The following code illustrates how to specify side wall formatting. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Load the excel file as stream + Stream excelStream = File.OpenRead("Excel_Template.xlsx"); + //Create and Append chart to the paragraph with excel stream as parameter + WChart chart = paragraph.AppendChart(excelStream, 1, "B2:C6", 470, 300); + //Set chart type and title + chart.ChartType = OfficeChartType.Column_Clustered_3D; + chart.ChartTitle = "Purchase Details"; + chart.ChartTitleArea.FontName = "Calibri"; + chart.ChartTitleArea.Size = 14; + chart.ChartArea.Border.LinePattern = OfficeChartLinePattern.None; + //Set name to chart series + chart.Series[0].Name = "Sum of Purchases"; + chart.Series[1].Name = "Sum of Future Expenses"; + chart.PrimaryCategoryAxis.Title = "Products"; + chart.PrimaryValueAxis.Title = "In Dollars"; + //Set position of legend + chart.Legend.Position = OfficeLegendPosition.Bottom; + //Set roatation and elevation values + chart.Rotation = 20; + chart.Elevation = 15; + //Set side wall properties + chart.SideWall.Fill.FillType = OfficeFillType.SolidColor; + chart.SideWall.Fill.ForeColor = Color.White; + chart.SideWall.Fill.BackColor = Color.White; + chart.SideWall.Border.LineColor = System.Drawing.Color.Beige; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Load the excel file as stream + Dim excelStream As Stream = File.OpenRead("Excel_Template.xlsx") + 'Create and Append chart to the paragraph with excel stream as parameter + Dim chart As WChart = paragraph.AppendChart(excelStream, 1, "B2:C6", 470, 300) + 'Set chart type and title + chart.ChartType = OfficeChartType.Column_Clustered_3D + chart.ChartTitle = "Purchase Details" + chart.ChartTitleArea.FontName = "Calibri" + chart.ChartTitleArea.Size = 14 + chart.ChartArea.Border.LinePattern = OfficeChartLinePattern.None + 'Set name to chart series + chart.Series(0).Name = "Sum of Purchases" + chart.Series(1).Name = "Sum of Future Expenses" + chart.PrimaryCategoryAxis.Title = "Products" + chart.PrimaryValueAxis.Title = "In Dollars" + 'Set position of legend + chart.Legend.Position = OfficeLegendPosition.Bottom + 'Set rotation and elevation values + chart.Rotation = 20 + chart.Elevation = 15 + 'Set side wall properties + chart.SideWall.Fill.FillType = OfficeFillType.SolidColor + chart.SideWall.Fill.ForeColor = Color.White + chart.SideWall.Fill.BackColor = Color.White + chart.SideWall.Border.LineColor = System.Drawing.Color.Beige + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + The 3D charts, stacked charts and clustered charts only can have side walls. + + + + Gets the back wall of the chart. Read-only. + + The following code illustrates how to specify back wall formatting. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Load the excel file as stream + Stream excelStream = File.OpenRead("Excel_Template.xlsx"); + //Create and Append chart to the paragraph with excel stream as parameter + WChart chart = paragraph.AppendChart(excelStream, 1, "B2:C6", 470, 300); + //Set chart type and title + chart.ChartType = OfficeChartType.Column_Clustered_3D; + chart.ChartTitle = "Purchase Details"; + chart.ChartTitleArea.FontName = "Calibri"; + chart.ChartTitleArea.Size = 14; + chart.ChartArea.Border.LinePattern = OfficeChartLinePattern.None; + //Set name to chart series + chart.Series[0].Name = "Sum of Purchases"; + chart.Series[1].Name = "Sum of Future Expenses"; + chart.PrimaryCategoryAxis.Title = "Products"; + chart.PrimaryValueAxis.Title = "In Dollars"; + //Set position of legend + chart.Legend.Position = OfficeLegendPosition.Bottom; + //Set roatation and elevation values + chart.Rotation = 20; + chart.Elevation = 15; + //Set the Backwall fill option. + chart.BackWall.Fill.FillType = OfficeFillType.Gradient; + //Set the Texture Type. + chart.BackWall.Fill.GradientColorType = OfficeGradientColor.TwoColor; + chart.BackWall.Fill.GradientStyle = OfficeGradientStyle.Diagonl_Down; + chart.BackWall.Fill.ForeColor = Color.WhiteSmoke; + chart.BackWall.Fill.BackColor = Color.LightBlue; + //Set the Border Linecolor. + chart.BackWall.Border.LineColor = System.Drawing.Color.Wheat; + //Set the Picture Type. + chart.BackWall.PictureUnit = OfficeChartPictureType.stretch; + //Set the Backwall thickness. + chart.BackWall.Thickness = 10; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Load the excel file as stream + Dim excelStream As Stream = File.OpenRead("Excel_Template.xlsx") + 'Create and Append chart to the paragraph with excel stream as parameter + Dim chart As WChart = paragraph.AppendChart(excelStream, 1, "B2:C6", 470, 300) + 'Set chart type and title + chart.ChartType = OfficeChartType.Column_Clustered_3D + chart.ChartTitle = "Purchase Details" + chart.ChartTitleArea.FontName = "Calibri" + chart.ChartTitleArea.Size = 14 + chart.ChartArea.Border.LinePattern = OfficeChartLinePattern.None + 'Set name to chart series + chart.Series(0).Name = "Sum of Purchases" + chart.Series(1).Name = "Sum of Future Expenses" + chart.PrimaryCategoryAxis.Title = "Products" + chart.PrimaryValueAxis.Title = "In Dollars" + 'Set position of legend + chart.Legend.Position = OfficeLegendPosition.Bottom + 'Set rotation and elevation values + chart.Rotation = 20 + chart.Elevation = 15 + 'Set the Backwall fill option. + chart.BackWall.Fill.FillType = OfficeFillType.Gradient + 'Set the Texture Type. + chart.BackWall.Fill.GradientColorType = OfficeGradientColor.TwoColor + chart.BackWall.Fill.GradientStyle = OfficeGradientStyle.Diagonl_Down + chart.BackWall.Fill.ForeColor = Color.WhiteSmoke + chart.BackWall.Fill.BackColor = Color.LightBlue + 'Set the Border Linecolor. + chart.BackWall.Border.LineColor = System.Drawing.Color.Wheat + 'Set the Picture Type. + chart.BackWall.PictureUnit = OfficeChartPictureType.stretch + 'Set the Backwall thickness. + chart.BackWall.Thickness = 10 + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + The 3D charts, stacked charts and clustered charts only can have back walls. + + + + Gets the floor of the chart. Read-only. + + The 3D charts, stacked charts and clustered charts only can have floor. + + + + Gets the data table of the chart. Read-only. + + The IOfficeChartDataTable instance that specifies the data table of chart. + + + + Gets or sets value indicating whether the chart has a data table. + + True if the chart has data table; otherwise, false. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Load the excel file as stream + Stream excelStream = File.OpenRead("Excel_Template.xlsx"); + //Create and Append chart to the paragraph with excel stream as parameter + WChart chart = paragraph.AppendChart(excelStream, 1, "B2:C6", 470, 300); + //Set chart type and title + chart.ChartType = OfficeChartType.Column_Clustered; + chart.ChartTitle = "Purchase Details"; + chart.ChartTitleArea.FontName = "Calibri"; + chart.ChartTitleArea.Size = 14; + chart.ChartArea.Border.LinePattern = OfficeChartLinePattern.None; + //Set name to chart series + chart.Series[0].Name = "Sum of Purchases"; + chart.Series[1].Name = "Sum of Future Expenses"; + //Display data table + chart.HasDataTable = true; + chart.PrimaryCategoryAxis.Title = "Products"; + chart.PrimaryValueAxis.Title = "In Dollars"; + //Set position of legend + chart.Legend.Position = OfficeLegendPosition.Bottom; + //Save the document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Load the excel file as stream + Dim excelStream As Stream = File.OpenRead("Excel_Template.xlsx") + 'Create and Append chart to the paragraph with excel stream as parameter + Dim chart As WChart = paragraph.AppendChart(excelStream, 1, "B2:C6", 470, 300) + 'Set chart type and title + chart.ChartType = OfficeChartType.Column_Clustered + chart.ChartTitle = "Purchase Details" + chart.ChartTitleArea.FontName = "Calibri" + chart.ChartTitleArea.Size = 14 + chart.ChartArea.Border.LinePattern = OfficeChartLinePattern.None + 'Set name to chart series + chart.Series(0).Name = "Sum of Purchases" + chart.Series(1).Name = "Sum of Future Expenses" + chart.PrimaryCategoryAxis.Title = "Products" + chart.PrimaryValueAxis.Title = "In Dollars" + 'Set position of legend + chart.Legend.Position = OfficeLegendPosition.Bottom + 'Display data table + chart.HasDataTable = True + 'Save the document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Gets the chart legend. Read-only. + + The following code illustrates how to apply the formatting for legend. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load the template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + WParagraph paragraph = document.LastParagraph; + //Get the chart entity + WChart chart = paragraph.ChildEntities[0] as WChart; + //Set the legend position + chart.Legend.Position = OfficeLegendPosition.Left; + //Set the layout inclusion + chart.Legend.IncludeInLayout = true; + //Set the legend border format - color, pattern, weight + chart.Legend.FrameFormat.Border.AutoFormat = false; + chart.Legend.FrameFormat.Border.IsAutoLineColor = false; + chart.Legend.FrameFormat.Border.LineColor = Color.Blue; + chart.Legend.FrameFormat.Border.LinePattern = OfficeChartLinePattern.DashDot; + chart.Legend.FrameFormat.Border.LineWeight = OfficeChartLineWeight.Wide; + //Set the legend's text area formatting - font name, weight, color, size + chart.Legend.TextArea.Bold = true; + chart.Legend.TextArea.Color = OfficeKnownColors.Bright_green; + chart.Legend.TextArea.FontName = "Times New Roman"; + chart.Legend.TextArea.Size = 20; + chart.Legend.TextArea.Strikethrough = true; + //Modify the legend entry + chart.Legend.LegendEntries[0].IsDeleted = true; + //Modify the legend layout - height, left, top, width + chart.Legend.Layout.Height = 50; + chart.Legend.Layout.HeightMode = LayoutModes.factor; + chart.Legend.Layout.Left = 10; + chart.Legend.Layout.LeftMode = LayoutModes.factor; + chart.Legend.Layout.Top = 30; + chart.Legend.Layout.TopMode = LayoutModes.factor; + chart.Legend.Layout.Width = 100; + chart.Legend.Layout.WidthMode = LayoutModes.factor; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load the template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + Dim paragraph As WParagraph = document.LastParagraph + 'Get the chart entity + Dim chart As WChart = TryCast(paragraph.ChildEntities(0), WChart) + 'Set the legend position + chart.Legend.Position = OfficeLegendPosition.Left + 'Set the layout inclusion + chart.Legend.IncludeInLayout = True + 'Set the legend border format - color, pattern, weight + chart.Legend.FrameFormat.Border.AutoFormat = False + chart.Legend.FrameFormat.Border.IsAutoLineColor = False + chart.Legend.FrameFormat.Border.LineColor = Color.Blue + chart.Legend.FrameFormat.Border.LinePattern = OfficeChartLinePattern.DashDot + chart.Legend.FrameFormat.Border.LineWeight = OfficeChartLineWeight.Wide + 'Set the legend's text area formatting - font name, weight, color, size + chart.Legend.TextArea.Bold = True + chart.Legend.TextArea.Color = OfficeKnownColors.Bright_green + chart.Legend.TextArea.FontName = "Times New Roman" + chart.Legend.TextArea.Size = 20 + chart.Legend.TextArea.Strikethrough = True + 'Modify the legend entry + chart.Legend.LegendEntries(0).IsDeleted = True + 'Modify the legend layout - height, left, top, width + chart.Legend.Layout.Height = 50 + chart.Legend.Layout.HeightMode = LayoutModes.factor + chart.Legend.Layout.Left = 10 + chart.Legend.Layout.LeftMode = LayoutModes.factor + chart.Legend.Layout.Top = 30 + chart.Legend.Layout.TopMode = LayoutModes.factor + chart.Legend.Layout.Width = 100 + chart.Legend.Layout.WidthMode = LayoutModes.factor + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets value indicating whether the chart has a legend. + + True if the chart has legend; otherwise, false. + + + + Gets or sets the rotation value for x-axis of the 3-D chart, measured in degrees. + + The integer that specifies the value for rotation. + The following code illustrates how to rotation for 3D chart. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add section to the document + IWSection sec = document.AddSection(); + //Add paragraph to the section + IWParagraph paragraph = sec.AddParagraph(); + //Load the excel file as stream + Stream excelStream = File.OpenRead("Excel_Template.xlsx"); + //Create and Append chart to the paragraph with excel stream as parameter + WChart chart = paragraph.AppendChart(excelStream, 1, "B2:C6", 470, 300); + //Set chart type and title + chart.ChartType = OfficeChartType.Column_Clustered_3D; + chart.ChartTitle = "Purchase Details"; + chart.ChartTitleArea.FontName = "Calibri"; + chart.ChartTitleArea.Size = 14; + chart.ChartArea.Border.LinePattern = OfficeChartLinePattern.None; + //Set name to chart series + chart.Series[0].Name = "Sum of Purchases"; + chart.Series[1].Name = "Sum of Future Expenses"; + chart.PrimaryCategoryAxis.Title = "Products"; + chart.PrimaryValueAxis.Title = "In Dollars"; + //Set position of legend + chart.Legend.Position = OfficeLegendPosition.Bottom; + //Set roatation and elevation values + chart.Rotation = 20; + chart.Elevation = 15; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add section to the document + Dim sec As IWSection = document.AddSection() + 'Add paragraph to the section + Dim paragraph As IWParagraph = sec.AddParagraph() + 'Load the excel file as stream + Dim excelStream As Stream = File.OpenRead("Excel_Template.xlsx") + 'Create and Append chart to the paragraph with excel stream as parameter + Dim chart As WChart = paragraph.AppendChart(excelStream, 1, "B2:C6", 470, 300) + 'Set chart type and title + chart.ChartType = OfficeChartType.Column_Clustered_3D + chart.ChartTitle = "Purchase Details" + chart.ChartTitleArea.FontName = "Calibri" + chart.ChartTitleArea.Size = 14 + chart.ChartArea.Border.LinePattern = OfficeChartLinePattern.None + 'Set name to chart series + chart.Series(0).Name = "Sum of Purchases" + chart.Series(1).Name = "Sum of Future Expenses" + chart.PrimaryCategoryAxis.Title = "Products" + chart.PrimaryValueAxis.Title = "In Dollars" + 'Set position of legend + chart.Legend.Position = OfficeLegendPosition.Bottom + 'Set rotation and elevation values + chart.Rotation = 20 + chart.Elevation = 15 + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Gets or sets the rotation value for y-axis of the 3-D chart, measured in degrees. + + The integer that specifies the value for elevation. + + + + + Gets or sets the perspective value for the 3-D chart, measured in degrees. + + + + + Gets or sets the height of a 3-D chart as a percentage of the chart width(between 5 and 500 percent). + + + + + Gets or sets the depth of a 3-D chart as a percentage of the chart width(between 20 and 2000 percent). + + + + + Gets or sets the distance between the data series in a 3-D chart, as a percentage of the marker width. + + + + + Gets or sets value indicating whether the chart axes are at right angles. + + True if the chart axis are at right angles; otherwise, false. + + + + Gets or sets a value indicating whether to scale a 3-D chart size. + + True if to scale the 3-D chart; otherwise, false. + + + + Gets or sets a value indicating whether the chart has plot area. + + True if the chart has plot area; otherwise, false. + + + + Gets or sets a value indicating how that blank cells are plotted on a chart. + + The OfficeChartPlotEmpty member that specifies how to plot empty cells. + + + + Gets or sets a value indicating whether to plot only the visible cells of the data table. + + True if to plot only visible cells; false if both visible and hidden cells are plotted. + + + + Gets the collection of IOfficeChartCategories of the chart. Read-only. + + + + + Gets or sets the series name filter option for the chart. + + The OfficeSeriesNameLevel member that specifies the filter option. + + + + Gets or sets the category name filter option for the chart. + + The OfficeCategoriesLabelLevel member that specifies the filter option. + + + + Gets the chart data. Read-only. + + + + + Gets the type of the entity. Read-only. + + The of the current item. + + + + Represents a comment in the Word document. + + + + + Represents the text body of comment. + + + + + + Represents the formatting options for the comment. + + + + + + Represents the comment range start of the comment + + + + + Represents the comment range end of the comment + + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + Creates a duplicate copy of the entity. + + + An reference to the newly created instance. + + + + Removes the items in the comment. + + + + + Removes the items between. + + The first item. + The last item. + + + + Replace the contents of the comment with the specified text. + + The string that specifies the text to replace. + + + + Replaces the commented items with specified TextBodyPart. + + The text body part. + + + + Adds the self. + + + + + Attach the comment items into the CommentsCollection + + + + + + + Clones the relations. + + + + + Generate and set new para id to the comment + + Destination document + Comment + + + + + Closes this instance. + + + + + Clones the relations. + + The doc. + + + + Adds the paragraph item to the commented items. + + The paragraph item. + + + + Initialize the XDLS holder. + + + + + + Writes object data as xml attributes. + + + The object. + + + + Creates the layout info. + + + + + + Inserts the commented item. + + The paragraph. + The index. + The item to insert. + + + + Finds the comment start. + + The index. + The start id. + The item collection. + + + + + Checks the text body on the existing of WComment objects. + + The item. + + + + + Checks the paragraph on the existing of WComment objects. + + The paragraph. + + + + + Checks the table on the existing of WComment objects. + + The table. + + + + + Removes the first item. + + The first item. + The last item. + + + + Fills the commented items from TextBodyPart. + + + + + Fills the commented items from the paragraph. + + The paragraph. + + + + Fills the commented item from the table. + + The table. + + + + Modifies the text. + + The text. + + + + + Sets the ParentParaId of the comment + + The List of paraid of all comments + The parentparaid of the comment + + + + Gets the ancestor comment + + Ancestor Comment + + + + + + Gets the child elements of the comment. Read-only. + + The collection of child elements. + + + + Gets the type of the entity. Read-only. + + The of the current item. + + + + Gets the text body of the comment. Read-only. + + The instance that represents the text body. + + + + Gets the format options for the comment. + + The instance that represents format options of comment. + + + + Gets the collection of items in the paragraph of the comment. + + The paragraph items collection of the comment. + + + + Gets a value indicating whether to append commented items to the document . + + true if append items; otherwise, false. + + + + + + + + + Gets or Sets the ParentParaId of the comment + + + + + Returns the parent comment for the specific comment. Read-only + + The parent of the specific . + + Returns null for top-level comments. + + + + Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + Get the Ancestor comment + WComment ancestorComment = document.Comments[1].Ancestor; + Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Load an existing Word document into DocIO instance + Dim document As WordDocument = New WordDocument("Template.docx") + 'Get the Ancestor comment + Dim ancestorComment As WComment = document.Comments(1).Ancestor + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Specifies whether the Comment is detached (For both cases either cloned or removed from collection) from the Comments collection. + + + + + Gets a value indicating whether the comment is resolved or not. The default value is false. + + + True if the comment is resolved; otherwise, false. + + This property is only applicable for DOCX format documents. + + + // Load an existing Word document into DocIO instance + using (WordDocument document = new WordDocument("Template.docx")) + { + // Checks whether the comment is resolved or not + bool done = document.Comments[0].Done; + // Saves the Word document + document.Save("Sample.docx", FormatType.Docx); + } + + + 'Load an existing Word document into DocIO instance + Dim document As WordDocument = New WordDocument("Template.docx") + 'Checks whether the comment is resolved or not + Dim done As Boolean = document.Comments(0).Done + 'Save and Close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Represents comment start marker + + + + + Id of the comment current mark refers to + + + + + + + + + + Represents the owner comment of the comment mark + + + + + Initializes a new instance of the class. + + The document. + The comment id. + + + + Initializes a new instance of the class. + + The document. + The comment id. + + + + Clones itself. + + + Returns cloned object. + + + + + + + + + + + + + + + + + Gets or sets the id of the comment this mark refers to. + + The comment id. + + + + Gets the type of the entity. + + The of the current item. + + + + Gets or sets the type of the CommentMark. + + The type. + + + + Get/Set if the Comment Range end is preserved after the TableCell mark + + + + + Represents the comment extended in Word Document + + + + + Represents the last paragraph id of comment + + + + + Represents the last paragraph id of the comment to which the associated comment is reply + + + + + Represents whether comment is resolved or not + + + + + Gets or sets the last paragraph id of the associated comment + + + + + Gets or sets the last paragraph id of the comment to which the associated comment is reply. + + + + + Gets or sets the value indicating that whether comment is resolved or not. + + + + + Summary description for WDropDownFormField. + + + + + + + + + + Initializes a new instance of the class. + + + + + + + + + + + + Closes this instance. + + + + + Reads object data from xml attributes. + + + The object. + + + + Writes object data as xml attributes. + + + The object. + + + + Registers child objects in XDSL holder. + + + + + + + + + + + Initializing LayoutInfo value to null + + + + + Gets the Drop down field text for Word comparison. + + + + + + Gets the type of the entity. + + The of the current item. + + + + Gets/sets selected drop down index. + + + + + Gets drop down items. + + + + + + + + + + + + + + + Represents an embeded field. + + + + + + + + + + + Registers child objects in XDSL holder. + + + + + Reads object data from xml attributes. + + The object. + + + + Writes object data as xml attributes. + + The object. + + + + Clone values of all fields of current embedded field + + + new WEmbedField, containing the same info as in current + + + + + Gets the type of the entity. + + The of the current item. + + + + + + + + + + + + + + Represents form control field. + + + + + + + + + + Initializes a new instance of the class. + + + + + + Clone values of all fields of current embedded field + + + + new WEmbedField, containing the same info as in current + + + + + Clones the relations + + Document + Owner of the entity + + + + Closes this instance. + + + + + Gets the type of the entity. + + The of the current item. + + + + Gets or sets the storage location. + + The storage pic location. + + + + Gets the OLE object. + + The OLE object. + + + + Represents the field mark in the document. + + + + + + + + + + Initializes a new instance of the class. + + The doc. + + + + Initializes a new instance of the class. + + The field mark. + The doc. + + + + Initializes a new instance of the class. + + The doc. + The type. + + + + Reads object data from xml attributes. + + + The object. + + + + Writes object data as xml attributes. + + + The object. + + + + Registers child objects in XDSL holder. + + + + + + + + + + + Gets the type of the entity. + + The of the current item. + + + + Gets character format of the field mark. + + + + + Gets or sets type of field mark. + + + + + Gets or sets the parent field. + + + The parent field. + + + + + Represents a document footnote or endnote. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + The doc. + + + + + + + + + + + Adds the self. + + + + + Creates the layout info. + + + + + + Clones the specified paragraph. + + + Returns cloned object. + + + + Clones the relations. + + The doc. + + + + "Listener" for state change. + + + + + + Closes this instance. + + + + + Initialize the XDLS holder. + + + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + + + + + + + Updates the custom marker. + + The destination marker. + + + + + + + + + + Clearing the previous + + + + + Getting the CustomMarker string + + + + + Compare CharacterFormat + + + + + Checks the character style. + + + + + Updates the footnote marker. + + + + + Ensures the footnote/endnote marker. + + + + + Appends the footnote symbol. + + + + + Generates the symbol. + + The symbol code. + + + + + Replaces the selection. + + The symbol. + The paragraph. + + + + Ensures the footnote/endnote style. + + + + + Updates the change flag. + + + + + Replaces the marker. + + The selection. + The replace text. + + + + Appends the marker. + + The marker. + The destination paragraph. + + + + Generates the text. + + + + + + Measures self size. + + + + + + + Gets the type of the entity. + + The of the current item. + + + + Gets / sets footnote type: footnote or endnote + + + + + Gets the value indicating if the footnote is auto numbered + + + + + Gets the text body of the footnote. + + The text body. + + + + Gets the marker character format + + + + + Gets or sets the marker symbol code. + + The symbol code. + + + + Gets or sets the name of the marker symbol font. + + The name of the symbol font. + + + + Gets or sets the custom footnote marker. + + The custom marker. + + + + + + + + + indicate whether the endnote instance layouted or not. + + + + + The class specifies the Layout Footnote information. + + + + + + + + + + + + + + + + + + + + Holds the height of the footnote + + + + + Initializes a new instance of the class. + + The child layout direction. + + + + Get Footnote ID based on number format + + + + + + + + Get Base Entity. + + The entity. + + + + + Get/Set Footnote/Endnote TextBody height + + + + + Get/Set Endnote TextBody height + + + + + Get/Set Footnote/Endnote ID. + + + + + Get/Set the TextRange + + + + + Represents the IF field in the document. + + + The following code example demonstrates how to add an If field in Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + WordDocument document = new WordDocument(); + IWSection section = document.AddSection(); + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("If field which uses string of characters in expression"); + paragraph = section.AddParagraph(); + //Create the new instance of IF field + WIfField field = paragraph.AppendField("If", FieldType.FieldIf) as WIfField; + //Specify the expression, true and false statement in field code + field.FieldCode = "IF \"True\" = \"True\" \"The given statement is Correct\" \"The given statement is Wrong\""; + paragraph = section.AddParagraph(); + paragraph.AppendText("If field which uses numbers in expression"); + paragraph = section.AddParagraph(); + //Create the new instance of IF field + field = paragraph.AppendField("If", FieldType.FieldIf) as WIfField; + //Specify the expression, true and false statement in field code + field.FieldCode = "IF 100 >= 1000 \"The given statement is Correct\" \"The given statement is Wrong\""; + //Update the document fields + document.UpdateDocumentFields(); + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + Dim document As New WordDocument() + Dim section As IWSection = document.AddSection() + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("If field which uses string of characters in expression") + paragraph = section.AddParagraph() + 'Create the new instance of IF field + Dim field As WIfField = TryCast(paragraph.AppendField("If", FieldType.FieldIf), WIfField) + 'Specify the expression, true and false statement in field code + field.FieldCode = "IF ""True"" = ""True"" ""The given statement is Correct"" ""The given statement is Wrong""" + paragraph = section.AddParagraph() + paragraph.AppendText("If field which uses numbers in expression") + paragraph = section.AddParagraph() + 'Create the new instance of IF field + field = TryCast(paragraph.AppendField("If", FieldType.FieldIf), WIfField) + 'Specify the expression, true and false statement in field code + field.FieldCode = "IF 100 >= 1000 ""The given statement is Correct"" ""The given statement is Wrong""" + 'Update the document fields + document.UpdateDocumentFields() + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + Updates if field. + + + + + When AutoNum field is inside the IF field Result part, then skip the update of field result and also + remove the previous result with Field separator. + + The FieldMark. + + + + Check wheather the if field contains any AutoNum field in the result part. + + The FieldResult + returns True if If Field have AutoNum field itself otherwise return false. + + + + Gets the text in the entity + + The entity. + Entity text + + + + Gets the Field Result as String + + List of entity. + Field Result as string + + + + Updates the field result entities between FieldSeparator and FieldEnd. + + The result. + + + + Checks whether all the item in field result is TextRange + + + + + + + Removes the text range from result except first textrange + + + + + + After update the SET field inside the IF field, removed from the field result collection + + + + + + Initializes the layout information of text body item. + + The entity. + + + + Updates the field result entities between FieldSeparator and FieldEnd. + + List of field result entities. + + + + Merges the field separator and field end paragraph. + + + + + Moves the Field end paragraph items to Field result last paragraph. + + The para. + + + + Parse the Field range to get expression and Results + + expression text + + + + Gets the updated cloned field Range + + List of cloned Entity + + + + Gets the cloned Field entiy + + The entity. + The entity list. + + + + Gets the cloned paragraph item + + The entity. + The entity list. + + + + Splits Entity + + The entity. + The remaining text. + + + + Reads the expression from range + + The entity. + Reference to readTrueText flag. + Reference to expressionFound flag + + + + Checks the text reached end of expression. + + The text.Text after the expression remains in the text if expression found + "true" if the text reached end of expression otherwise false + + + + Check whether the text need to aplit or not + + + + True if the text need to split else returns false + + + + Checks the text contains operator or not. + + The text.Text after the operator remains in the text if operator found + "true" if the text conatins operator otherwise false + + + + Gets the index of operator. + + The text after the double quote remains in the text if double quote found. + Returns the index of the operator. + + + + Reads the True result entity + + The text. + The entity. + Reference to readTrueText flag. + Reference to expressionFound flag + + + + Reads the False result entity + + The entity. + + + + Checks whether the last item is not a textrange, but other renderable item` + + Field result + True, if the last item is not textrange, but other renderable item else False + + + + Removes the unwanted text/entity in the Result + + The field result. + + + + Check whether the paragraph has paragraph mark as a child entity + + Paragraph added in field result + False, if the last item of the paragraph is paragraph mark; else true + + + + Removes the ParagraphMark from field range + + The field result + + + + Removes the empty text and paragraph + + + + + + Trim Double Quotes + + + + + Remove the FieldTextStart character and FieldTextEnd character in the text range. + + + + + + + + Remove the FieldTextStart character and FieldTextEnd character in the text range. + + + + + + + + Trims the double quotesin text range. + + The text range. + if set to true [is start]. + if set to true [is end]. + + + + Get Index of Double quote character + + + + + + + Checks if field. + + The para. + The text. + if set to true [is if field result]. + + + + Checks if field end. + + The para. + if set to true [is if field result]. + + + + + + + + + + Updates field code + + + + + + Checks the expression strings. + + + + + Parses the field value. + + + + + Updates the expression string. + + + + + Updates the merge fields. + + + + + Clones itself. + + + Returns cloned object. + + + + Closes this instance. + + + + + Gets the Expression1 of IF field. + + The expression1. + + + + Gets the Expression2 of IF field. + + The expression1. + + + + Gets the TrueText field. + + The true text field. + + + + + + + + + Gets the merge fields. + + The merge fields. + + + + Class represents pseudo merge field inside IF field + + + + + + + + + + Initializes a new instance of the class. + + The field text. + + + + Gets the name. + + The name. + + + + Gets or sets the value. + + The value. + + + + Gets a value indicating whether fit mail merge. + + if it fits the mail merge, set to true. + + + + Represents a mathMl element in a word document. + + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + Creates a duplicate copy of the entity. + + + A reference to the newly created object. + + + + Clears the object. + + + + + Changes the math element to display position + + + + + Gets a WMath instance as drawing image by using Word to PDF layouting engine. + + Returns a PNG format image byte array. + As Word to Image conversion not supported in Portable platform, this method won't works in Portable. + Once we provided Word to Image conversion support, we can provide support for GetAsImage API too. + Note - We need to change only rendering(Drawig to Image) logics. Layouting will works in Portable too. + + + + Changes the math element to inline with text. + + + + + Removes the previous break + + + + + Inserts an empty text range + + + + + Removes the break following math element + + + + + Applies base format for the paragraph items inside Mathematical equation + + + + + Iterates into officemath. + + + + + + Iterates into each function to get their run element + + Represents a function to iterate + + + + Checks whether the math element is inline or display type. + + + + + Checks whether the item after math is break + + + + + Check whether item before math is break + + + + + Creates layout information for + + + + + Initializing LayoutInfo to null + + + + + + + Initializing LayoutInfo to null + + + + + Initializing LayoutInfo to null + + + + + Measure the width and height of WMath + + Represent the + Return the size of WMath + + + + Compare two math along with the formatting + + The math to be compared + True if the math is same, else false. + + + + Compare the properties of source OfficeMathParagraph with destination OfficeMathParagraph + + The OfficeMathParagraph to be compared + True, if all the properties matches, else false + + + + Compare the properties of source OfficeMathLimit with destination OfficeMathLimit + + The OfficeMathLimit to be compared + True, if all the properties matches, else false + + + + + Compare the properties of source OfficeMathBox with destination OfficeMathBox + + The OfficeMathBox to be compared + True, if all the properties matches, else false + + + + + Compare the properties of source OfficeMathBar with destination OfficeMathBar + + The OfficeMathBar to be compared + True, if all the properties matches, else false + + + + + Compare the properties of source OfficeMathRightScript with destination OfficeMathRightScript + + The OfficeMathRightScript to be compared + True, if all the properties matches, else false + + + + + Compare the properties of source OfficeMathPhantom with destination OfficeMathPhantom + + The OfficeMathPhantom to be compared + True, if all the properties matches, else false + + + + + Compare the properties of source OfficeMathAccent with destination OfficeMathAccent + + The OfficeMathAccent to be compared + True, if all the properties matches, else false + + + + + Compare the properties of source OfficeMathScript with destination OfficeMathScript + + The OfficeMathScript to be compared + True, if all the properties matches, else false + + + + + Compare the properties of source OfficeMathRadical with destination OfficeMathRadical + + The OfficeMathRadical to be compared + True, if all the properties matches, else false + + + + + Compare the properties of source OfficeMathNArray with destination OfficeMathNArray + + The OfficeMathNArray to be compared + True, if all the properties matches, else false + + + + + Compare the properties of source OfficeMathMatrix with destination OfficeMathMatrix + + The OfficeMathMatrix to be compared + True, if all the properties matches, else false + + + + + Compare the properties of source OfficeMathsBorderBox with destination OfficeMathsBorderBox + + The OfficeMathsBorderBox to be compared + True, if all the properties matches, else false + + + + + Compare the properties of source OfficeMathMatrix with destination OfficeMathMatrix + + The OfficeMathMatrix to be compared + True, if all the properties matches, else false + + + Compare the properties of source OfficeMathEquationArray with destination OfficeMathEquationArray + + The OfficeMathEquationArray to be compared + True, if all the properties matches, else false + + + + + Compare the properties of source OfficeMathFraction with destination OfficeMathFraction + + The OfficeMathFraction to be compared + True, if all the properties matches, else false + + + + + Compare the properties of source OfficeMathFunction with destination OfficeMathFunction + + The OfficeMathFunction to be compared + True, if all the properties matches, else false + + + + + Compare the properties of source OfficeMathLeftScript with destination OfficeMathLeftScript + + The OfficeMathLeftScript to be compared + True, if all the properties matches, else false + + + + + Compare the properties of source OfficeMathGroupCharacter with destination OfficeMathGroupCharacter + + The OfficeMathGroupCharacter to be compared + True, if all the properties matches, else false + + + + + Compare the properties of source OfficeMathDelimiter with destination OfficeMathDelimiter + + The OfficeMathDelimiter to be compared + True, if all the properties matches, else false + + + + + Compare the properties of source OfficeMathLimit with destination OfficeMathLimit + + The OfficeMathLimit to be compared + True, if all the properties matches, else false + + + + + Compare the properties of source OfficeMathLimit with destination OfficeMathLimit + + The OfficeMathLimit to be compared + True, if all the properties matches, else false + + + + + Compare the properties of source OfficeMathFormat with destination OfficeMathFormat + + The OfficeMathLimit to be compared + True, if all the properties matches, else false + + + + + Compare the properties of source OfficeMath with destination OfficeMath + + The OfficeMath to be compared + True, if all the properties matches, else false + + + + Compare the properties of source OfficeMathMatrixColumn with destination OfficeMathMatrixColumn + + The OfficeMathMatrixColumn to be compared + True, if all the properties matches, else false + + + + Compare the properties of source OfficeMathMatrixRow with destination OfficeMathMatrixRow + + The OfficeMathMatrixRow to be compared + True, if all the properties matches, else false + + + + Compare the properties of source OfficeMathBreak with destination OfficeMathBreak + + The picture to be compared + True if the picture is same, else false. + + + + Gets the math text for Word comparison + + + + + + Gets the properties text for Word comparison + + + + + + + Gets the MathLeftScript text for Word comparison + + + + + + Gets the MathGroupCharacter text for Word comparison + + + + + + Gets the MathRightScript text for Word comparison + + + + + + Gets the MathRightScript text for Word comparison + + + + + + Gets the OfficeMath text for Word comparison + + + + + + Gets the MathPhantom text for Word comparison + + + + + + Gets the MathFraction text for Word comparison + + + + + + Gets the MathFunction text for Word comparison + + + + + + Gets the MathEquationArray text for Word comparison + + + + + + Gets the MathMatrix text for Word comparison + + + + + + Gets the MathDelimiter text for Word comparison + + + + + + Gets the MathAccent text for Word comparison + + + + + + Gets the MathScript text for Word comparison + + + + + + Gets the MathRadical text for Word comparison + + + + + + Gets the office mathmatrix column text for Word comparison + + + + + + Gets the office mathmatrix Row text for Word comparison + + + + + + Gets the MathBar text for Word comparison + + + + + + Gets the MathNArray text for Word comparison + + + + + + Gets the MathLimit text for Word comparison + + + + + + Gets the OfficeMathsBorderBox text for Word comparison + + + + + + Gets the MathBox text for Word comparison + + + + + + Gets the office mathbreak text for Word comparison + + + + + + Gets the Office mathParagraph text for Word comparison + + + + + + Gets or sets the officemathpara that can be used to format a top level mathml element. + + + + + Gets the type of the entity. Read-only. + + The of the current item. + + + + + + + + + Represents the mail merge field in the document. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The collection of text ranges which form field value + + + + + Initializes a new instance of the class with specified instance. + + The word document instance. + + + + Clones itself. + + + Returns cloned object. + + + + Clones the relations. + + The doc. + + + + Reads object data from xml attributes. + + + The object. + + + + Writes object data as xml attributes. + + + The object. + + + + + + + + + Get Field Values - Parse for Field name and field switches + + + + + + updates field code + + + + + + Applies the base format. + + + + + Closes this instance. + + + + + Update field marks when its a cloned field and it field mark refers the other field + + + + + Parses the name of the field. + + + + + + Parses the name of the field. + + Name of the field. + + + + Parse Field Name using regular expression + + field name + + + + Parses field name having group ":" and backslash "\" expression + + field name + + + + Serialize the merge field codes. + + + + + + Gets the text format. + + The format. + + + + + Clears the string from other characters. + + The value. + + + + + Updates field value and format string (merge formats) by parsing through field code + + + + + + Parse switches (Text format, Number format and Date format) + + merge format + + + + Updates field Value by removing parsed switches using format index collection + + field value + format index + + + + + Updates format Index and Field value + + Field Value + Format Index (list) + Merge Switch + + + + + Updates Switches index in Field Codes by removing the extra characters ('\\') present in field codes. + + Field value + + + + + Upates the merge field result. + + + + + Gets the type of the entity. + + The of the current item. + + + + Gets or sets mail merge field name. + + + + + Gets or sets the text that is displayed before the merge field. + + + + + Gets or sets the text that is displayed after the merge field. + + + + + Gets the prefix of merge field. Read-only. + + + + + Gets the number format of the merge field. Read-only. + + + + + Gets the date format of the merge field. Read-only. + + + + + Gets the result text items in the merge field. Read-only. + + The text item collection that represents the merge field result value. + + + + Represents the picture in the Word document. + + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("This paragraph has picture. "); + //Append new picture to the paragraph + IWPicture picture = paragraph.AppendPicture(Image.FromFile("Image.png")); + //Set width and height for the paragraph + picture.Width = 150; + picture.Height = 100; + //Set text wrapping style – When the wrapping style is inline the images will not be absolutely positioned. It will be added next to the textrange. + picture.TextWrappingStyle = TextWrappingStyle.Square; + picture.TextWrappingType = TextWrappingType.Largest; + //Set horizontal and vertical origin + picture.HorizontalOrigin = HorizontalOrigin.Page; + picture.VerticalOrigin = VerticalOrigin.Paragraph; + //Set horizontal and vertical position for the picture + picture.HorizontalPosition = 200; + picture.VerticalPosition = 150; + //Set horizontal and vertical alignments + picture.HorizontalAlignment = ShapeHorizontalAlignment.Center; + picture.VerticalAlignment = ShapeVerticalAlignment.Bottom; + //Set name, title, alternate text. + picture.Title = "PictureTitle"; + picture.Name = "PictureName"; + picture.IsBelowText = true; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("This paragraph has picture. ") + 'Append new picture to the paragraph + Dim picture As IWPicture = paragraph.AppendPicture(Image.FromFile("Image.png")) + 'Set width and height for the paragraph + picture.Width = 150 + picture.Height = 100 + 'Set text wrapping style – When the wrapping style is inline the images will not be absolutely positioned. It will be added next to the textrange. + picture.TextWrappingStyle = TextWrappingStyle.Square + picture.TextWrappingType = TextWrappingType.Largest + 'Set horizontal and vertical origin + picture.HorizontalOrigin = HorizontalOrigin.Page + picture.VerticalOrigin = VerticalOrigin.Paragraph + 'Set horizontal and vertical position for the picture + picture.HorizontalPosition = 200 + picture.VerticalPosition = 150 + 'Set horizontal and vertical alignments + picture.HorizontalAlignment = ShapeHorizontalAlignment.Center + picture.VerticalAlignment = ShapeVerticalAlignment.Bottom + 'Set name, title, alternate text. + picture.Title = "PictureTitle" + picture.Name = "PictureName" + picture.IsBelowText = True + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Size of the picture. + + + + + in percent + + + + + in percent + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + DistanceBottom Returns or sets the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. Read/write Single. + + + + + DistanceLeft Returns or sets the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. Read/write Single. + + + + + DistanceRight Returns or sets the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. Read/write Single. + + + + + DistanceTop Returns or sets the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. Read/write Single. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Holds additional docx picture props + + + + + Holds additional docx picture props for visual shapes + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + Loads the image from the specified byte array. + + The byte array that specifies the image as bytes. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Get the image and convert to byte array + Image image = Image.FromFile("Image.png"); + MemoryStream imageStream = new MemoryStream(); + image.Save(imageStream, System.Drawing.Imaging.ImageFormat.Png); + byte[] imageBytes = imageStream.ToArray(); + //Initialize new picture + WPicture picture = new WPicture(document); + //Load image from the byte array + picture.LoadImage(imageBytes); + //Set width and height + picture.Height = 100; + picture.Width = 150; + //Add picture to the paragraph + paragraph.Items.Add(picture); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Get the image and convert to byte array + Dim image__1 As Image = Image.FromFile("Image.png") + Dim imageStream As New MemoryStream() + image__1.Save(imageStream, System.Drawing.Imaging.ImageFormat.Png) + Dim imageBytes As Byte() = imageStream.ToArray() + 'Initialize new picture + Dim picture As New WPicture(document) + 'Load image from the byte array + picture.LoadImage(imageBytes) + 'Set width and height + picture.Height = 100 + picture.Width = 150 + 'Add picture to the paragraph + paragraph.Items.Add(picture) + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Loads the SVG image from the specified byte array. + + The byte array that specifies the SVG image as bytes. + The byte array that specifies the image as bytes. + Thrown when is null + Thrown when is not a *svg format + + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Get the SVG image as byte array. + byte[] imageBytes = File.ReadAllBytes("Image.png"); + //Get the SVG image as byte array. + byte[] svgData = File.ReadAllBytes("Image.svg"); + //Initialize new picture + WPicture picture = new WPicture(document); + //Load both fallback and SVG image from the byte array + picture.LoadImage(svgData, imageBytes); + //Set width and height + picture.Height = 100; + picture.Width = 150; + //Add picture to the paragraph + paragraph.Items.Add(picture); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Get the image byte array + Dim imageBytes As Byte() = File.ReadAllBytes("Image.png") + 'Get the SVG image as byte array. + Dim svgData As Byte() = File.ReadAllBytes("Image.svg") + 'Initialize new picture + Dim picture As New WPicture(document) + 'Load both fallback and SVG image from the byte array + picture.LoadImage(svgData, imageBytes) + 'Set width and height + picture.Height = 100 + picture.Width = 150 + 'Add picture to the paragraph + paragraph.Items.Add(picture) + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Check whether the given SVG image data is valid or not. + + + + + + Loads the image from the specified instance. + + The instance. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform and Xamarin platforms. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Initialize new picture + WPicture picture = new WPicture(document); + //Load image from the file + picture.LoadImage(Image.FromFile("Image.png")); + //Set width and height + picture.Height = 100; + picture.Width = 150; + //Add picture to the paragraph + paragraph.Items.Add(picture); + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Initialize new picture + Dim picture As New WPicture(document) + 'Load image from the file + picture.LoadImage(Image.FromFile("Image.png")) + 'Set width and height + picture.Height = 100 + picture.Width = 150 + 'Add picture to the paragraph + paragraph.Items.Add(picture) + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Update Blip ImageRecord + + + + + Adds caption for the current picture with specified name, caption format and caption position. + + The string that specifies the name. + The member that specifies the format for caption numbering. + The member that specifies the position of caption. + The paragraph instance with the specified caption. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("This paragraph has picture. "); + //Append new picture to the paragraph + IWPicture picture = paragraph.AppendPicture(Image.FromFile("Image.png")); + //Set width and height for the paragraph + picture.Width = 150; + picture.Height = 100; + //Set caption for picture + picture.AddCaption("Figure 1.1", CaptionNumberingFormat.Number, CaptionPosition.AboveImage); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("This paragraph has picture. ") + 'Append new picture to the paragraph + Dim picture As IWPicture = paragraph.AppendPicture(Image.FromFile("Image.png")) + 'Set width and height for the paragraph + picture.Width = 150 + picture.Height = 100 + 'Set caption for picture + picture.AddCaption("Figure 1.1", CaptionNumberingFormat.Number, CaptionPosition.AboveImage) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Adds the self. + + + + + Creates a duplicate copy of the entity. + + + An reference to the newly created instance. + + + + + + + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Writes object data as inside xml element. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + The value indicating the presence of xml content. + + + + Registers child objects in XDSL holder. + + + + + + + + + + + Compare two pictures along with the formatting + + The picture to be compared + True if the picture is same, else false. + + + + Gets the picture text for Word comparison + + + + + + Gets the properties text for Word comparison + + + + + + + Retrieves a dictionary containing mappings between brightness levels and their corresponding value ranges. + + A dictionary where keys represent brightness levels and values are lists of float ranges. + + + + Retrieves a dictionary containing mappings between contrast levels and their corresponding value ranges. + + A dictionary where keys represent contrast levels and values are lists of float ranges. + + + + Sets the width scale, specific for parsers. + + The width scale. + + + + Sets the height scale, specific for parsers. + + The height scale. + + + + Sets the TextWrappingStyle,specific for parsers. + + TextWrapStyle + + + + Detaches from owner. + + + + + Remove the image from document's escher collection. + + + + + Added picture into document floating items + + + + + To identify current picture previous sibling's previous sibling is OleObject + + trueif the current picture previous sibling's previous sibling is OleObject;Otherwisefalse + + + + Loads the image. + + The image bytes. + if it specifies a metafile, set to true. + + + + Loads the image. + + The image record. + + + + Check the TextWrapping style + + + + + Gets the image for partial trust mode. + + The image bytes. + + Argument is not image byte array + + + + Converts the size for partial trust mode. + + The image. + + image + + + + Gets the Default image. + + image + + + + Gets the image. + + The image bytes. + + + + + Gets the specified resource file as stream. + + The resource file name + Stream of the specified resource file + + + + Retrieves the contents of the specified enhanced-format metafile and copies them into a buffer. + + A handle to the enhanced metafile. + The size, in bytes, of the buffer to receive the data. + A pointer to a buffer that receives the metafile data. The buffer must be sufficiently large to contain the data. + If lpbBuffer is NULL, the function returns the size necessary to hold the data. + If the function succeeds and the buffer pointer is NULL, the return value is the size of the enhanced metafile, in bytes. + If the function succeeds and the buffer pointer is a valid pointer, the return value is the number of bytes copied to the buffer. + If the function fails, the return value is zero. + + The does not invalidate the enhanced-metafile handle. + The application must call the function to delete the handle when it is no longer needed. + + + + Deletes an enhanced-format metafile or an enhanced-format metafile handle. + + A handle to an enhanced metafile. + If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. + + + + + + + + + + Converts the .tiff format to .png. Tiff format is not supported by Word 2000. + + The image. + + + + Resets the data. + + + + + Initializing LayoutInfo value to null + + + + + + + + + + + + Creates layout information. + + + + + + Converts size of the image to point units. + + Image object. + Size of the image int points. + + + + Checks the pic size for partial trust mode. + + The image. + + + + Checks the size of the picture. + + + + + it hold the picture rectangle value + + + + + Gets a value indicating whether this instance has borders. + + + true if this instance has borders; otherwise, false. + + + + + Gets the type of the entity. Read-only. + + The of the current item. + + + + Gets or sets the picture height in points + + The float that specifies the height. + + + + Gets or sets the picture rotation in degree. + + The float that specifies the rotation value of the picture. + A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. + + The following code example demonstrates how to gets or sets the rotation value of picture in degree. + + //Creates a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new text to the paragraph + IWParagraph paragraph = section.AddParagraph(); + //Gets the image and convert to byte array + Image image = Image.FromFile("Image.png"); + MemoryStream imageStream = new MemoryStream(); + image.Save(imageStream, System.Drawing.Imaging.ImageFormat.Png); + byte[] imageBytes = imageStream.ToArray(); + //Initializes new picture + WPicture picture = new WPicture(document); + //Loads an image from the byte array + picture.LoadImage(imageBytes); + //Sets height and width for the image + picture.Height = 100; + picture.Width = 150; + //Sets picture rotation in degree + picture.Rotation = 90; + //Adds image to the paragraph + paragraph.Items.Add(picture); + //Saves the Word document + document.Save("Sample.docx", FormatType.Docx); + //Closes the document + document.Close(); + + + 'Creates a New Word document + Dim document As WordDocument = New WordDocument + 'Adds new section to the document + Dim section As IWSection = document.AddSection + 'Adds new text to the paragraph + Dim paragraph As IWParagraph = section.AddParagraph + 'Gets the image and convert to byte array + Dim image As Image = Image.FromFile("Image.png") + Dim imageStream As MemoryStream = New MemoryStream + image.Save(imageStream, System.Drawing.Imaging.ImageFormat.Png) + Dim imageBytes() As Byte = imageStream.ToArray + 'Initializes new picture + Dim picture As WPicture = New WPicture(document) + 'Loads an image from the byte array + picture.LoadImage(imageBytes) + 'Sets height and width for the image + picture.Height = 100 + picture.Width = 150 + 'Sets picture rotation in degree + picture.Rotation = 90 + 'Adds image to the paragraph + paragraph.Items.Add(picture) + 'Saves the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Closes the document + document.Close() + + + + + + Gets or sets the picture width in points. + + The float that specifies the width. + + + + Gets or sets the picture height scale factor in percent. + + The float that specifies the height scale factor. + + + + Gets or sets the picture width scale factor in percent. + + The float that specifies the width scale factor. + + + + Gets or sets a value indicating whether the pictute has Lock aspect ratio. The default is false. + + + true if this instance has lock aspect ratio; otherwise, false. + + + + + Gets the image for partial trust mode. + + + The image for partial trust mode. + + + + + Gets the instance that represents the picture. Read-only. + + The instance. + This property is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + + Gets the image as byte array. Read-only. + + The array that represents image bytes. + + + + Gets the SVG image as byte array. Read-only. + + The array that represents SVG image bytes. + + + + Gets the image record. + + The image record. + + + + Get/Set Shapeposition + + + + + Gets or sets the horizontal origin of the picture. + + The member that specifies the horizontal origin. + + + + Gets or sets the vertical origin of the picture. + + The member that specifies the vertical origin. + + + + Gets or sets absolute horizontal position of the picture in points. + + The float that specifies the horizontal position. + + The horizontal position is relative to the . + + + + + Gets or sets absolute vertical position of the picture in points. + + The float that specifies the vertical position. + + The vertical position is relative to the . + + + + + DistanceBottom Returns or sets the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. Read/write Single. + + + + + DistanceLeft Returns or sets the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. Read/write Single. + + + + + DistanceRight Returns or sets the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. Read/write Single. + + + + + DistanceTop Returns or sets the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. Read/write Single. + + + + + Gets or sets the text wrapping style of the picture. + + The member that specifies the text wrapping style. + + + + Gets or sets the text wrapping type of the picture. + + The member that specifies the text wrapping type. + + + + Gets or sets the horizontal alignment of the picture. + + The member that specifies the horizontal alignment. + + If the alignment is set as None, then the picture is explicitly positioned using position properties. + Otherwise it is positioned according to the alignment specified. The position of the object is relative to . + + + + + Gets or sets the vertical alignment of the picture. + + + If the alignment is set as None, then the picture is explicitly positioned using position properties. + Otherwise it is positioned according to the alignment specified. The position of the object is relative to . + + + + + Gets or sets a value indicating whether the picture is below the text. + + True if the picture is below text; otherwise, false. + + + + Gets the character format(font properties) of the picture. Read-only. + + + + + + + + + + Gets or Sets picture hRef string + + + + + + + + + + + + + + + Gets/sets the size of picture object. + + + + + Gets a value indicating whether this instance is metafile. + + + if this instance is metafile, set to true. + + + + + Gets the additional docx properties. + + The docx props. + + + + Gets the additional docx visual shape properties. + + The docx props. + + + + Gets the Signature Line elements of docx. + + The docx props. + + + + Gets or sets the alternate text for the picture. + + The string that represents the alternate text. + + + + Gets or sets the name of the picture. + + The string that represents the name. + + + + Gets or sets the chromakey color (picture transparency). + + + + + Gets or sets the picture title. + + The string that represents the title. + + + + Embedded text body + + + + + Gets or sets a value indicating whether this instance is shape. + + + if this instance is shape, set to true. + + + + + Gets or sets the index of the order. + + The index of the order. + + + + Returns the boolean value that represents whether a picture in a table is displayed inside or outside the table. + + + + + Gets or sets a value indicating whether [allow overlap]. + + + true if [allow overlap]; otherwise, false. + + + + + Gets or set the SVG external image link. + + + + + Gets or sets the wrap polygon. + + + The wrap polygon. + + + + + Gets or sets a value indicating whether the picture is visible. + + + True if the picture is visible; otherwise, false. + + + + + Gets or sets a value indicate whether current wrapping bounds points added to the list or not. + + + true if this instance is wrapping bounds added; otherwise, false. + + + + + Gets or sets fill format. + + + + + Gets or sets a Horizontal flipping of Picture. + + + true indicates that a picture has been flipped horizontally; otherwise, false. + + This property returns True if the specified picture is flipped around the horizontal axis, and False if not. + + The following code example demonstrates how to gets or sets the horizontal flip to picture. + + //Creates a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new text to the paragraph + IWParagraph paragraph = section.AddParagraph(); + //Gets the image and convert to byte array + Image image = Image.FromFile("Image.png"); + MemoryStream imageStream = new MemoryStream(); + image.Save(imageStream, System.Drawing.Imaging.ImageFormat.Png); + byte[] imageBytes = imageStream.ToArray(); + //Initializes new picture + WPicture picture = new WPicture(document); + //Loads an image from the byte array + picture.LoadImage(imageBytes); + //Sets height and width for the image + picture.Height = 100; + picture.Width = 150; + //Sets horizontal flip to the picture + picture.FlipHorizontal = true; + //Adds image to the paragraph + paragraph.Items.Add(picture); + //Saves the Word document + document.Save("Sample.docx", FormatType.Docx); + //Closes the document + document.Close(); + + + 'Creates a New Word document + Dim document As WordDocument = New WordDocument + 'Adds new section to the document + Dim section As IWSection = document.AddSection + 'Adds new text to the paragraph + Dim paragraph As IWParagraph = section.AddParagraph + 'Gets the image and convert to byte array + Dim image As Image = Image.FromFile("Image.png") + Dim imageStream As MemoryStream = New MemoryStream + image.Save(imageStream, System.Drawing.Imaging.ImageFormat.Png) + Dim imageBytes() As Byte = imageStream.ToArray + 'Initializes new picture + Dim picture As WPicture = New WPicture(document) + 'Loads an image from the byte array + picture.LoadImage(imageBytes) + 'Sets height and width for the image + picture.Height = 100 + picture.Width = 150 + 'Sets horizontal flip to the picture + picture.FlipHorizontal = True + 'Adds image to the paragraph + paragraph.Items.Add(picture) + 'Saves the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Closes the document + document.Close() + + + + + + Gets or sets a Vertical flipping of Picture. + + + true indicates that a picture has been flipped vertically; otherwise, false. + + This property returns True if the specified picture is flipped around the vertical axis, and False if not. + + The following code example demonstrates how to gets or sets the vertical flip to picture. + + //Creates a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new text to the paragraph + IWParagraph paragraph = section.AddParagraph(); + //Gets the image and convert to byte array + Image image = Image.FromFile("Image.png"); + MemoryStream imageStream = new MemoryStream(); + image.Save(imageStream, System.Drawing.Imaging.ImageFormat.Png); + byte[] imageBytes = imageStream.ToArray(); + //Initializes new picture + WPicture picture = new WPicture(document); + //Loads an image from the byte array + picture.LoadImage(imageBytes); + //Sets height and width for the image + picture.Height = 100; + picture.Width = 150; + //Sets vertical flip to the picture + picture.FlipVertical = true; + //Adds image to the paragraph + paragraph.Items.Add(picture); + //Saves the Word document + document.Save("Sample.docx", FormatType.Docx); + //Closes the document + document.Close(); + + + 'Creates a New Word document + Dim document As WordDocument = New WordDocument + 'Adds new section to the document + Dim section As IWSection = document.AddSection + 'Adds new text to the paragraph + Dim paragraph As IWParagraph = section.AddParagraph + 'Gets the image and convert to byte array + Dim image As Image = Image.FromFile("Image.png") + Dim imageStream As MemoryStream = New MemoryStream + image.Save(imageStream, System.Drawing.Imaging.ImageFormat.Png) + Dim imageBytes() As Byte = imageStream.ToArray + 'Initializes new picture + Dim picture As WPicture = New WPicture(document) + 'Loads an image from the byte array + picture.LoadImage(imageBytes) + 'Sets height and width for the image + picture.Height = 100 + picture.Width = 150 + 'Sets vertical flip to the picture + picture.FlipVertical = True + 'Adds image to the paragraph + paragraph.Items.Add(picture) + 'Saves the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Closes the document + document.Close() + + + + + + Gets or sets the value indicate whether the image is redEX image or not,if the image is redX image then serializing the embed tag in the WPicture is skipped. + + + + + Represents the sequence field in the Word document. + + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument("Bookmarks.docx"); + //Add new paragraph to the section + WParagraph paragraph = document.Sections[0].AddParagraph() as WParagraph; + //Append sequence field to the paragraph + WSeqField field = (WSeqField)paragraph.AppendField("Sequence field", FieldType.FieldSequence); + //Set the bookmark name as caption and number format + field.CaptionName = "Northwind"; + field.NumberFormat = CaptionNumberingFormat.Roman; + //Save and close the document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument("Bookmarks.docx") + 'Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(document.Sections(0).AddParagraph(), WParagraph) + 'Append sequence field to the paragraph + Dim field As WSeqField = DirectCast(paragraph.AppendField("Sequence field", FieldType.FieldSequence), WSeqField) + 'Set the bookmark name as caption and number format + field.CaptionName = "Northwind" + field.NumberFormat = CaptionNumberingFormat.Roman + 'Save and close the document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + + + + + + Get the caption name. + + + + + updates field code + + + + + + Updates field value and format string (sequence formats) by parsing through field code + + + + + + Updates Switches index in Field Codes by removing the extra characters ('\\') present in field codes. + + Field value + + + + + Updates format Index and Field value + + Field Value + Format Index (list) + Sequence Switch + + + + + Updates field Value by removing parsed switches using format index collection + + field value + format index + + + + + Parse switches (Formatting String, Number format) + + + + + + Get Field Values - Parse for Field name and field switches + + + + + + Clears the string from other characters. + + The value. + + + + + Add new values to Boolean switches(\n,\c,\h) + + + + + + + Add new values to Integer switches(\r,\s) + + + + + + + + Removes the Switch before apply new switch + + + + + + + Removes the oldvalue before apply new value + + + + + + + + Removes the Switch String before apply new switch + + + + + + + Converts the switches to string. + + The string that specifies the switches. + + + + Update field marks when its a cloned field and it field mark refers the other field + + + + + Updates the Sequence field result. + + + + + Gets the type of the entity. Read-only + + The of the current item. + + + + Gets the formatting string of the sequence field. Read-only. + + The string that specifies the formatting text. + + + + Gets or sets the type of caption numbering. + + The member that specifies the format for caption numbering. + + + //Load an existing Word document into DocIO instance. + WordDocument document = new WordDocument("Template.docx"); + //Add new paragraph to the section + WParagraph paragraph = document.Sections[0].AddParagraph() as WParagraph; + //Append sequence field to the paragraph + WSeqField field = (WSeqField)paragraph.AppendField("Sequence field", FieldType.FieldSequence); + //Set the NumberFormat of the SeqField. + field.NumberFormat = CaptionNumberingFormat.Number; + //Updates the document fields + document.UpdateDocumentFields(); + //Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Load an existing Word document into DocIO instance. + Dim document As WordDocument = New WordDocument("Template.docx") + 'Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(document.Sections(0).AddParagraph(), WParagraph) + 'Append sequence field to the paragraph + Dim field As WSeqField = CType(paragraph.AppendField("Sequence field", FieldType.FieldSequence), WSeqField) + 'Set the NumberFormat of the SeqField. + field.NumberFormat = CaptionNumberingFormat.Number + 'Updates the document fields + document.UpdateDocumentFields() + 'Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets or sets caption name. + + The string that specifies the caption name. + + + //Load an existing Word document into DocIO instance. + WordDocument document = new WordDocument("Template.docx"); + //Add new paragraph to the section + WParagraph paragraph = document.Sections[0].AddParagraph() as WParagraph; + //Append sequence field to the paragraph + WSeqField field = (WSeqField)paragraph.AppendField("Sequence field", FieldType.FieldSequence); + //Set the CaptionName of the SeqField. + field.CaptionName = "Test"; + //Updates the document fields + document.UpdateDocumentFields(); + //Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Load an existing Word document into DocIO instance. + Dim document As WordDocument = New WordDocument("Template.docx") + 'Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(document.Sections(0).AddParagraph(), WParagraph) + 'Append sequence field to the paragraph + Dim field As WSeqField = CType(paragraph.AppendField("Sequence field", FieldType.FieldSequence), WSeqField) + 'Set the CaptionName of the SeqField. + field.CaptionName = "Test"; + //Updates the document fields + document.UpdateDocumentFields() + 'Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets or sets a bookmark name that refers to an item elsewhere in the document rather than in the current location. + + The string that specifies the bookmark name. + + + //Load an existing Word document into DocIO instance. + WordDocument document = new WordDocument("Template.docx"); + //Add new paragraph to the section + WParagraph paragraph = document.Sections[0].AddParagraph() as WParagraph; + //Append sequence field to the paragraph + WSeqField field = (WSeqField)paragraph.AppendField("Sequence field", FieldType.FieldSequence); + //Set the BookmarkName of the SeqField. + field.BookmarkName = "Bookmark1"; + //Updates the document fields + document.UpdateDocumentFields(); + //Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Load an existing Word document into DocIO instance. + Dim document As WordDocument = New WordDocument("Template.docx") + 'Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(document.Sections(0).AddParagraph(), WParagraph) + 'Append sequence field to the paragraph + Dim field As WSeqField = CType(paragraph.AppendField("Sequence field", FieldType.FieldSequence), WSeqField) + 'Set the BookmarkName of the SeqField. + field.BookmarkName = "Bookmark1" + 'Updates the document fields + document.UpdateDocumentFields() + 'Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets or sets whether to insert the next sequence number for the specified item. Default value is true. + + + + //Load an existing Word document into DocIO instance. + WordDocument document = new WordDocument("Template.docx"); + //Add new paragraph to the section + WParagraph paragraph = document.Sections[0].AddParagraph() as WParagraph; + //Append sequence field to the paragraph + WSeqField field = (WSeqField)paragraph.AppendField("Sequence field", FieldType.FieldSequence); + //Set the InsertNextNumber of the SeqField. + field.InsertNextNumber = true; + //Updates the document fields + document.UpdateDocumentFields(); + //Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + Load an existing Word document into DocIO instance. + Dim document As WordDocument = New WordDocument("Template.docx") + 'Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(document.Sections(0).AddParagraph(), WParagraph) + 'Append sequence field to the paragraph + Dim field As WSeqField = CType(paragraph.AppendField("Sequence field", FieldType.FieldSequence), WSeqField) + 'Set the InsertNextNumber of the SeqField. + field.InsertNextNumber = True + 'Updates the document fields + document.UpdateDocumentFields() + 'Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets or sets whether to repeats the closest preceding sequence number. Default value is false. + + + + //Load an existing Word document into DocIO instance. + WordDocument document = new WordDocument("Template.docx"); + //Add new paragraph to the section + WParagraph paragraph = document.Sections[0].AddParagraph() as WParagraph; + //Append sequence field to the paragraph + WSeqField field = (WSeqField)paragraph.AppendField("Sequence field", FieldType.FieldSequence); + //Set the RepeatNearestNumber of the SeqField. + field.RepeatNearestNumber = true; + //Updates the document fields + document.UpdateDocumentFields(); + //Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Load an existing Word document into DocIO instance. + Dim document As WordDocument = New WordDocument("Template.docx") + 'Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(document.Sections(0).AddParagraph(), WParagraph) + 'Append sequence field to the paragraph + Dim field As WSeqField = CType(paragraph.AppendField("Sequence field", FieldType.FieldSequence), WSeqField) + 'Set the RepeatNearestNumber of the SeqField. + field.RepeatNearestNumber = True + 'Updates the document fields + document.UpdateDocumentFields() + 'Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets or sets whether to hides the field result unless a general-formatting-switch is also present. Default value is false. + + + + //Load an existing Word document into DocIO instance. + WordDocument document = new WordDocument("Template.docx"); + //Add new paragraph to the section + WParagraph paragraph = document.Sections[0].AddParagraph() as WParagraph; + //Append sequence field to the paragraph + WSeqField field = (WSeqField)paragraph.AppendField("Sequence field", FieldType.FieldSequence); + //Set the HideResult of the SeqField. + field.HideResult = true; + //Updates the document fields + document.UpdateDocumentFields(); + //Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + Load an existing Word document into DocIO instance. + Dim document As WordDocument = New WordDocument("Template.docx") + //Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(document.Sections(0).AddParagraph(), WParagraph) + //Append sequence field to the paragraph + Dim field As WSeqField = CType(paragraph.AppendField("Sequence field", FieldType.FieldSequence), WSeqField) + //Set the HideResult of the SeqField. + field.HideResult = True + //Updates the document fields + document.UpdateDocumentFields() + //Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets or sets an integer number to reset the sequence number to. Returns -1 if the number is absent. + + + + //Load an existing Word document into DocIO instance. + WordDocument document = new WordDocument("Template.docx"); + //Add new paragraph to the section + WParagraph paragraph = document.Sections[0].AddParagraph() as WParagraph; + //Append sequence field to the paragraph + WSeqField field = (WSeqField)paragraph.AppendField("Sequence field", FieldType.FieldSequence); + //Set the ResetNumber of the SeqField. + field.ResetNumber = 7; + //Updates the document fields + document.UpdateDocumentFields(); + //Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + Load an existing Word document into DocIO instance. + Dim document As WordDocument = New WordDocument("Template.docx") + //Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(document.Sections(0).AddParagraph(), WParagraph) + //Append sequence field to the paragraph + Dim field As WSeqField = CType(paragraph.AppendField("Sequence field", FieldType.FieldSequence), WSeqField) + //Set the ResetNumber of the SeqField. + field.ResetNumber = 7 + //Updates the document fields + document.UpdateDocumentFields() + //Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets or sets an integer number representing a heading level to reset the sequence number to. Returns -1 if the number is absent. + + + + //Load an existing Word document into DocIO instance. + WordDocument document = new WordDocument("Template.docx"); + //Add new paragraph to the section + WParagraph paragraph = document.Sections[0].AddParagraph() as WParagraph; + //Append sequence field to the paragraph + WSeqField field = (WSeqField)paragraph.AppendField("Sequence field", FieldType.FieldSequence); + //Set the ResetHeadingLevel of the SeqField. + field.ResetHeadingLevel = 1; + //Updates the document fields + document.UpdateDocumentFields(); + //Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + Load an existing Word document into DocIO instance. + Dim document As WordDocument = New WordDocument("Template.docx") + //Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(document.Sections(0).AddParagraph(), WParagraph) + //Append sequence field to the paragraph + Dim field As WSeqField = CType(paragraph.AppendField("Sequence field", FieldType.FieldSequence), WSeqField) + //Set the ResetHeadingLevel of the SeqField. + field.ResetHeadingLevel = 1; + //Updates the document fields + document.UpdateDocumentFields() + //Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Represents a symbol in the Word document. + + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("Example of adding symbols to the paragraph: "); + //Insert symbol with character code 100 + WSymbol symbol = paragraph.AppendSymbol(100); + symbol.FontName = "Windings"; + //Save and close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("Example of adding symbols to the paragraph: ") + 'Insert symbol with character code 100 + Dim symbol As WSymbol = paragraph.AppendSymbol(100) + symbol.FontName = "Windings" + 'Save and close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + + + + Initialize a new instance of the class with the specified + instance. + + The instance. + + + + Creates layout information. + + + + + + Creates a duplicate copy of the entity. + + + The reference to the newly created object. + + + + Registers child objects in XDSL holder. + + + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + Gets the size of the symbol for lay outing. + + + + + + + Get Symbol font + + + + + + Initializing LayoutInfo value to null + + + + + Gets the Symbol text for Word comparison + + + + + + Gets the properties text for Word comparison + + + + + + Compares the current Symbol with another Symbol of another document. + + + + + + + Gets the type of the entity. Read-only. + + The of the current item. + + + + Gets the character format for the symbol. Read-only. + + + + + Gets or sets font name for the symbol. + + + + + Gets or sets symbol's character code. + + + + + Get/set character code extension. + + + + + Get the character code value + + + + + Represents the textbox in the Word document. + + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Append new textbox to the paragraph + IWTextBox textbox = paragraph.AppendTextBox(150, 75); + //Add new text to the textbox body + IWParagraph textboxParagraph = textbox.TextBoxBody.AddParagraph(); + textboxParagraph.AppendText("Text inside text box"); + textboxParagraph = textbox.TextBoxBody.AddParagraph(); + //Add new picture to textbox body + IWPicture picture = textboxParagraph.AppendPicture(Image.FromFile(@"Image.png")); + picture.Height = 75; + picture.Width = 50; + //Save and close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Append new textbox to the paragraph + Dim textbox As IWTextBox = paragraph.AppendTextBox(150, 75) + 'Add new text to the textbox body + Dim textboxParagraph As IWParagraph = textbox.TextBoxBody.AddParagraph() + textboxParagraph.AppendText("Text inside text box") + textboxParagraph = textbox.TextBoxBody.AddParagraph() + 'Add new picture to textbox body + Dim picture As IWPicture = textboxParagraph.AppendPicture(Image.FromFile("Image.png")) + picture.Height = 75 + picture.Width = 50 + 'Save and close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + + + + + + + + + Initialize a new instance of the class with the specified + instance. + + The instance. + + + + Adds the self. + + + + + Executes when the entity is attached to the owner document. + + + + + Clones the relations. + + The doc. + + + + + Creates a duplicate copy of the entity. + + + A reference to the newly created object. + + + + Creates layout information. + + + + + + Checks whether text box's line width need to consider for text box client area calcualtion + + + + + Calculate the textbox bounds based on the Line Width and Margin + + The bounds + Text box format + + + + Detaches from owner. + + + + + Gets the next text body item. + + + + + + Closes this instance. + + + + + Sets the text body. + + The text body. + + + + Gets as table. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the horizontal alignment. + + The shape align. + + + + + Gets the border style. + + The line style. + + + + + Initializes the default values for TextBox in VML structure. + + + + + Applies the specified character format to the WTextbox. + + The character format to be applied. + + + + Compares the current textbox with another textbox of another document. + + + + + + + Gets the text box text for Word comparison + + + + + + Gets the properties text for Word comparison + + + + + + + Gets the properties that needs to be ignored for Word comparison + + + + + + Registers child objects in XDSL holder. + + + + + + Writes object data as xml attributes. + + + The object. + + + + + + + + + + + Initializing LayoutInfo value to null + + + + + Gets the Textbox object as Image + + + + + + Gets or sets the name of the text box. + + + The string that represents the name. + + + + + Gets or sets a value indicating whether this is visible. + + + True if visible; otherwise, false. + + + + + Gets the child elements of the text box. Read-only. + + The collection of child elements. + + + + Gets the type of the entity. Read-only. + + The of the current item. + + + + Gets or sets Text content layouting bounds for textbox + + + + + Determine whether the textbox as shape + + + + + Gets or sets the text box format. + + + + + Gets the text body of the text box. Read-only. + + + + + + + + + + Gets the character format. + + The character format. + + + + Gets or sets the shape.Added to preserve the choice item porperties of rectangular shape + + + The shape. + + + + + Represents the text form field in the Word document. + + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + WParagraph paragraph = section.AddParagraph() as WParagraph; + paragraph.AppendText("General Information"); + section.AddParagraph(); + paragraph = section.AddParagraph() as WParagraph; + IWTextRange text = paragraph.AppendText("Name\t"); + text.CharacterFormat.Bold = true; + //Append Text form field + WTextFormField textfield = paragraph.AppendTextFormField(null); + //Set type of Text form field + textfield.Type = TextFormFieldType.RegularText; + textfield.CharacterFormat.FontName = "Calibri"; + textfield.CalculateOnExit = true; + section.AddParagraph(); + paragraph = section.AddParagraph() as WParagraph; + text = paragraph.AppendText("Date of Birth\t"); + text.CharacterFormat.Bold = true; + //Append Text form field + textfield = paragraph.AppendTextFormField("Date field", DateTime.Now.ToString("MM/DD/YY")); + textfield.StringFormat = "MM/DD/YY"; + //Set Text form field type + textfield.Type = TextFormFieldType.DateText; + textfield.CalculateOnExit = true; + //Save the Word document + document.Save("Textfield.docx", FormatType.Docx); + //Close the document + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As WParagraph = TryCast(section.AddParagraph(), WParagraph) + paragraph.AppendText("General Information") + section.AddParagraph() + paragraph = TryCast(section.AddParagraph(), WParagraph) + Dim text As IWTextRange = paragraph.AppendText("Name" & vbTab) + text.CharacterFormat.Bold = True + 'Append Text form field + Dim textfield As WTextFormField = paragraph.AppendTextFormField(Nothing) + 'Set type of Text form field + textfield.Type = TextFormFieldType.RegularText + textfield.CharacterFormat.FontName = "Calibri" + textfield.CalculateOnExit = True + section.AddParagraph() + paragraph = TryCast(section.AddParagraph(), WParagraph) + text = paragraph.AppendText("Date of Birth" & vbTab) + text.CharacterFormat.Bold = True + 'Append Text form field + textfield = paragraph.AppendTextFormField("Date field", DateTime.Now.ToString("MM/DD/YY")) + textfield.StringFormat = "MM/DD/YY" + 'Set Text form field type + textfield.Type = TextFormFieldType.DateText + textfield.CalculateOnExit = True + 'Save the Word document + document.Save("Textfield.docx", FormatType.Docx) + 'Close the document + document.Close() + End Sub + + + + + + Default text of form field. + + + + + + + + + + Initializes a new instance of the class. + + + + + + Closes this instance. + + + + + Creates a duplicate copy of the entity. + + + The reference to the newly created object. + + + + Gets the first text range. + + + + + + Gets the text range. + + + + + + Updates the text for text body item. + + The entity. + + + + + Updates the text for table. + + The entity. + + + + + Updates the text for paragraph item. + + The entity. + + + + + Sets the text range. + + The text range. + + + + Removes the previous text. + + + + + Removes the text body item. + + The entity. + + + + Inserts the paragraph items. + + The paragraph. + + + + Removes the paragraph item. + + The entity. + + + + Appends the date field. + + Type of the field. + + + + Sets the type of the text form field. + + Type of the text form field. + + + + Reads object data from xml attributes. + + + The object. + + + + Writes object data as xml attributes. + + + The object. + + + + Registers child objects in XDSL holder. + + + + + + Gets the text form field text for Word comparison + + + + + + Creates layout information. + + + + + + Initializing LayoutInfo value to null + + + + + Gets the type of the entity. Read-only. + + The of the current item. + + + + Gets or sets text form field type. + + The member that specifies the type of text form field. + + + + Gets or sets the string text format (text, date/time, number) directly. + + The string that specifies the text format. + + + + Gets or sets the default text for text form field. + + The string that specifies the default text. + + + + Gets or sets the maximum text length of the text form field. + + The integer that specifies the maximum length of the text. + + + + Gets or sets the form field text range. + + The instance that specifies the form field text. + + + + Gets or sets the text of text form field. + + The string that specifies the text. + + + + The CHPX converter. + + + + + CHPs to format. + + The reader. + The format. + + + + SPRMSs to property. + + The style. + The character format. + + + + Checks whether the byte array length is proper to read value from startIndex + + The sprm byte array + The start index + True if startIndex value is proper to read byte array else False + + + + Get Byte Value + + + + + + + Updates the Font information sprms by property keys order + + + + + + + + + Updates the font information sprms + + + + + + + + + + Closes this instance. + + + + + Summary description for class ParagraphPropertiesConverter + + + + + + + + + + + + updates the border properties from destination to source + + + + + + + + + + + + + + + + + + + + + Apply Direct formatting after applying style + + + + + + + Copies the border information + + + + + + + Imports the tabs. + + The tab collection. + The destination. + + + + Imports the shading. + + The source. + The destination. + + + + Imports the borders. + + The borders. + The destination. + + + + Summary description for class SectionPropertiesConverter + + + + + Exports formatting from SectionProperties to ISection's PageSettings + + Source properties + Destination. + Prase All. + + + + Import the section properties from section sprms. + + + + + + + + + Update the page orientation to portrait if the corresponding sprm is not found. + + + + + + + Imports formatting from WParagraphFormat to SectionProperties + + + + + Imports section properties for Oldpropertyhash. + + + + + + + Import the section properties (formattosprms). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Converts the Sprms to Row/Cell format PropertyHash + + Word reader + Current table row format + + + + + + + + + + + + + + Apply the border style for the inputed border, using its line and color information. + + Represents a border to set style./> + Represents a value which consider as enumeration value of border style. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Updates the table cell defintion + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Exports the borders. + + The source borders. + The destination borders. + + + + + + + + + + + + Converts the cell format property hash into sprms + + Property hash key + Corresponding value + Single property modifier array + Cell's format + is old format + Current cell index + TCGRF + + + + Updates the each cell shading information + + Property hash collection + Current cell index + To denotes this is row format or not + + + + + + + + + + + Set border information for cell. + + Represents the borders of particular cell. + Represents the index of the cell, in a row. + Represents a cell format of particular cell. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Determines whether the specified BRC is empty. + + The BRC. + + If the specified BRC is empty, set to true. + + + + + Imports the paddings. + + The destination. + The source. + + + + Exports the paddings. + + The source. + The destination. + + + + Updates the paddings value as Zero when the Paddings releated sprm not in the PAPX sprm list + + + + + + Property convertor for textboxes + + + + + Export properties from TextBoxProps to TextBoxFormat. + + TextBoxProps item. + TextBoxFormat item. + + + + Import properties from TetxBoxFormat to TextBoxProps. + + The TXBX format. + The TXBX props. + + + + Exports data from textbox container to the specified WTextboxFormat object. + + The textbox container. + The fspa. + The textbox format. + The skip position origins. + + + + Imports data from WTextboxFormat to FileShapeAddress. + + The fspa. + The textbox format. + + + + Exports the shape position. + + The textbox container. + The textbox format. + + + + Exports the internal margin. + + The textbox container. + The textbox format. + + + + Summary description for class ListPropertiesConverter + + + + + Export paragraphs's list data to ListStyle + + WListFormat item + Current reader + + + + Export paragraphs's list data to ListStyle + + Index of the format. + Index of the level. + WListFormat item + Current reader + + + + Updates the new list format information + + Current reader + Current list format + + + + Update list format for invalid list Id + + The list format + List id + Level Index + + + + Updates the type of the list style. + + The list style. + + + + Updates the name of the list style. + + The list style. + + + + Import ListStyle to ListData. + + Source ListStyle + Destination ListData + Stylesheet + + + + Exports the list format. + + The list format. + The reader. + The list id. + The list data. + Index of the level. + + + + Exports the new list format. + + The list format. + The reader. + + + + Exports the list style to the document. + + The list format. + The reader. + The id. + The list data. + + + + + Export ListLevels to ListLevelCollection. + + + + + + + + Convert DocIO listlevel to DLS listlevel. + + + + + + + + + Import data from DLS ListLevel format to + DocIO ListLevel format. + + Source DLS ListLevel + Destination DocIO ListLevel + Stylesheet + Stylesheet + + + + Create list level character offsets + + + + + + + + + + + + + + + + + + + + + + Does current list uses base style? + + + + + + + Export list format overrides. + + + + + Exports the list override. + + The source lfo. + The list override style. + The reader. + The doc. + + + + + + + + + + + + Summary description for class FormFieldPropertiesConverter + + + + + Reads the form field properties. + + The form field. + The FRM field. + + + + Writes the form field properties. + + The FRM field. + The form field. + + + + Gets the text format. + + The form field format. + + + + + Gets the string text format. + + The form field. + + + + + Gets the number format. + + The form field format. + + + + + Gets the string number format. + + The number format. + + + + + Gets the default number values. + + The number format. + + + + + Formats the text. + + The text format. + The text. + + + + + Formats the number text. + + The format. + The number format. + The input data. + + + + + Convert input value to a formatted string . + + The format. + Input value. + + + + + Summary description for XmlParagraphItem. + + + + + Gets or sets to indicate whether ParagraphItemCollection for Math element. + + + + + Initializes a new instance of the class. + + The XML node. + The word document. + + + + Sets the character format. + + The character format. + + + + Clones itself. + + Returns cloned object. + + + + + + + + + Clones the relations. + + The doc. + + + + Attaches to paragraph. + + The paragraph. + The item pos. + + + + Detaches itself + + + + + Updates the XML parts. + + The destination. + + + + Updates the XML part container. + + The SRC package. + The SRC container. + The dest container. + The parts. + The index. + + + + + Closes this instance. + + + + + Gets the image relations. + + The image relations. + + + + Gets the relations. + + The relations. + + + + Gets the data node. + + The data node. + + + + Gets the character format. + + The character format. + + + + Gets or sets the ZorderIndex + + + + + Gets the type of the entity. + + The of the current item. + + + + Represents a flag whether image relations are directly for main document or nested reference for other items. + + + + + + + + + + + + + + + + + + + + + + Get Curved Connector path + + + formulaColl.Add("x2","*/ w adj1 100000"); + formulaColl.Add("x1","+/ l x2 2"); + formulaColl.Add("x3","+/ r x2 2"); + formulaColl.Add("y3","*/ h 3 4"); + + + + + + This method is used to get the Curved connector 2 path. + + + + + + This method is used to call the Get Curved Connector 4 path. + + + + + + This method is used to get the curved connector5 path. + + + + + + Get Bent Connector path + + + formulaColl.Add("x1","*/ w adj1 100000"); + + + + + + This method is used to get the bend connector 2 path. + + + + + + This method is used to get the bend connector 4 path. + + + + + + This method is used to get the bend connector 5 path. + + + + + + Gets Rounded Rectangle Path + + + + + + Gets Snip Single Corner Rectangle Path + + + + + + Gets Snip Same Side Corner Rectangle Path + + + + + + Gets Snip Diagonal Corner Rectangle Path + + + + + + Gets Snip And Round Single Corner Rectangle Path + + + + + + Gets Round Single Corner Rectangle Path + + + + + + Gets Round Same Side Corner Rectangle Path + + + + + + Gets Round Diagonal Corner Rectangle Path + + + + + + Get Triangle path + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the right arrow path. + + + + + + Gets the left arrow path. + + + + + + Gets down arrow path. + + + + + + Gets the left right arrow path. + + + + + + Gets the curved right arrow path. + + + + + + Gets the curved left arrow path. + + + + + + Gets the curved up arrow path. + + + + + + Gets the curved down arrow path. + + + + + + Gets up down arrow path. + + + + + + Gets the quad arrow path. + + + + + + Gets the left right up arrow path. + + + + + + Gets the bent arrow path. + + + + + + Gets the U trun arrow path. + + + + + + Gets the left up arrow path. + + + + + + Gets the bent up arrow path. + + + + + + Gets the striped right arrow path. + + + + + + Gets the notched right arrow path. + + + + + + Gets the pentagon path. + + + + + + Gets the chevron path. + + + + + + Gets the right arrow callout path. + + + + + + Gets down arrow callout path. + + + + + + Gets the left arrow callout path. + + + + + + Gets up arrow callout path. + + + + + + Gets the left right arrow callout path. + + + + + + Gets the quad arrow callout path. + + + + + + Gets the circular arrow path. + + + + + + Gets the math plus path. + + + + + + Gets the math minus path. + + + + + + Gets the math multiply path. + + + + + + Gets the math division path. + + + + + + Gets the math equal path. + + + + + + Gets the math not equal path. + + + + + + Gets the flow chart alternate process path. + + + + + + Gets the flow chart predefined process path. + + + + + + Gets the flow chart internal storage path. + + + + + + Gets the flow chart document path. + + + + + + Gets the flow chart multi document path. + + + + + + Gets the flow chart terminator path. + + + + + + Gets the flow chart preparation path. + + + + + + Gets the flow chart manual input path. + + + + + + Gets the flow chart manual operation path. + + + + + + Gets the flow chart connector path. + + + + + + Gets the flow chart off page connector path. + + + + + + Gets the flow chart card path. + + + + + + Gets the flow chart punched tape path. + + + + + + Gets the flow chart summing junction path. + + + + + + Gets the flow chart or path. + + + + + + Gets the flow chart collate path. + + + + + + Gets the flow chart sort path. + + + + + + Gets the flow chart extract path. + + + + + + Gets the flow chart merge path. + + + + + + Gets the flow chart online storage path. + + + + + + Gets the flow chart delay path. + + + + + + Gets the flow chart sequential access storage path. + + + + + + Gets the flow chart magnetic disk path. + + + + + + Gets the flow chart direct access storage path. + + + + + + Gets the flow chart display path. + + + + + + Gets the rectangular callout path. + + + + + + Gets the rounded rectangular callout path. + + + + + + Gets the oval callout path. + + + + + + Gets the cloud callout path. + + + + + + Gets the line callout1 path. + + + + + + Gets the line callout2 path. + + + + + + Gets the line callout3 path. + + + + + + Gets the line callout1 accent bar path. + + + + + + Gets the line callout2 accent bar path. + + + + + + Gets the line callout3 accent bar path. + + + + + + Gets the line callout1 no border path. + + + + + + Gets the line callout2 no border path. + + + + + + Gets the line callout3 no border path. + + + + + + Gets the line callout1 border and accent bar path. + + + + + + Gets the line callout2 border and accent bar path. + + + + + + Gets the line callout3 border and accent bar path. + + + + + + Gets the VML custom shape path path. + + + + + + Gets a custom shape (DrawingML) GraphicPath. + + Represent a bounds of custom shape. + Represent a GraphicPath/PdfPath object. + Represent a custom shape object. + Returns a GraphicPath/PdfPath with custom shape drawing points. + + + + Gets a geometry path of Path2D. + + Represent a GraphicPath. + Represent a input path elements. + Represent a width of Path. + Represent a height of Path. + Represent a bounds of Path. + + + + Gets a X value of Path. + + Represent a width of Path. + Represent a X value. + Represent a bounds of Path. + Returns a X value. + + + + Gets a Y value of Path. + + Represent a height of Path. + Represent a Y value. + Represent a bounds of Path. + Returns a Y value. + + + + Convert the path element of custom shape + + Represent a path element to convert. + Represent a converted path elements. + Represent a formula collection. + Represent a path object. + Represent formula with its values. + + + + Gets a new GraphicsPath object. + + Returns a new GraphicsPath object. + + + + + + + + + + + + + + + + + + + Get Path adjust value + + + + + + + Parse Shape Formula + + + + + + + Gets Formula Values + + + + + + + + + Gets Operand Values + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the next free area. + + The rectangle of allowed area. + The isContinuousSection. + True if area allowed, else False + + + + Pushes the LayoutedWidget to external holder. + + The LayoutedWidget. + + + + Handles the splitted widget. + + The splitted widget container. + The current state of layout context. + The LayoutedWidget. + The isLayoutedWidgetNeedToPushed. + True for continue layout process, False - for stopping + + + + Handle the LayoutedWidget to external holder. + + The LayoutedWidget. + + + + Specifies whether the footnote need to be restart for each page + + + + + Specifies whether the endnote need to be restart for each section + + + + + Specifies the footnote count in each columns + + + + + Specifies the Endnote count in each columns + + + + + Height used in current page + + + + + Page Client height + + + + + Total height layouted by the section + + + + + Fixed height for the continuous section + + + + + Current page top + + + + + Current section index + + + + + + Line count for the section. + + + + + Paragraph first three lines height. + + + + + Holds the height of the first line of the first paragraph in the column. + + + + + Holds the height of the line which exceeds the section fixed height. + + + + + Foot note height. + + + + + Is first page of the document. + + + + + Is new page created for current section + + + + + Need to create new page + + + + + Is Continuous Section Layouted + + + + + Is Continuous Section Layouted at once or not. + + + + + Line height of the section + + + + + Column height of the section + + + + + Column has break items like (Page break or Column break) + + + + + Previous columns width + + + + + Footnote ID when the footnote restart with each page + + + + + Footnote ID when the footnote restart with each section + + + + + Footnote id for the numbering + + + + + Endnote id for the numbering + + + + + Specifies whether azure compatiblity method has been invoked + + + + + Specifies whether azure compatible with Metafile creation + + + + + Initializes a new instance of the class. + + + + + Layouts the specified doc. + + The doc. + The cg. + + + + + Reset the info of the layouted footnote and endnotes. + + Footnote collection. + Endnote collection + + + + Add the line number widget to each line of the section. + + + + + + Layout the line number + + + + + + + + Updates the X position of the line number based on intersecting floating items. + + + + + + + Gets the first inline item X position from a line widget. + + + + + + + Calculate the maximum accent of the text. + + + + + + + Returns the page setup of current section. + + + + + + + Intialize the Graphics instance. + + + + + Get font for line numbering from document styles. + + + + + + + Initializing LayoutInfo value to null + + + + + Closes this instance. + + + + + Draws to image. + + Start index of the page. + The no of pages. + Type of the image. + The stream. + + This method is used specifically for Image conversion. + + + + Draw the image and return Stream + + Start index of the page. + The no of pages. + Type of the image. + The stream. + + This method is used specifically for Image conversion. + + + + Draws to image. + + Start index of the page. + The no of pages. + Type of the image. + + This method is used specifically for PDF conversion, using intermediate EMF approach. + + + + Layouts the pages. + + + + + + Converts the Shape/GroupShape/TextBox/Math object as Image. + + + + + Draws the Shape/GroupShape/TextBox/Math into an image. + + + + + Converts an Image into PNG format byte array. + + + + + Creates an image with specified size. + + + + + + + + + + Recreate the layoutInfo for the last line widgets. + + + + + Resets the floating entity properties. + + + + + Resets the not added floating entity property. + + + + + Creates the new section in the current page. + + + + + Checks the section break. + + + + + + Checks whether all the rows in the last table on the previous page's column have "Keep with Next". + + + + + + Checks whether all the rows in the table has keep with next. + + layouted widget + + + + + Handles the page break. + + + + + + + + + + + Determines whether a header and footer relayout is necessary, specifically for Word 2013 compatibility mode. + + True if a relayout is required, false otherwise. + + + + Retrieves the header/footer height specifically for compatibility with Word 2013. + + The calculated header/footer height for Word 2013 compatibility. + + This method assumes a specific header/footer height calculation based on Word 2013 behavior. + + + + + Retrieves the type of a header or footer widget. + + + + + Shift the floating items based on the vertical alignment relative to Margin. + + + + + + + + + + + + + + + + + Gets the header footer. + + The section. + The header footer. + + + + + + + + + + Gets the TOC entry page numbers. + + The doc. + + + + + Gets the last layouted paragraph. + + + + + + Updates page fields. + + The doc. + + + + + Determine to check whether Azure compatible with EMF creation + + + + + + Creates the image. + + + + + + Creates the image. + + The width. + The height. + Type of the image. + The stream. + + + + + Determines whether the layouted widget is TOC paragraph. + + The widget. + + true if the specified widget is TOC paragraph; otherwise, false. + + + + + Layouter_s the leaf layout after. + + The sender. + The lt widget. + + + + Gets the next area. + + The area. + The isContinuousSection. + + + + + Checks to create new page based on dynamic table. + + Flag, denotes whether now layouting dynamic relayout process + + + + Calculates the height of intersected items with the floating item. + + Represents a Layouted section + Represents a intersected item. + Represents whether the intersecting item intersected with the floating item or not. + Retruns height of all the intersected items. + + + + Checks whether interesecting item is intersected with floating item. + + Represents a interesecting item. + Represents a floating item. + + + + + Get Section Client Area + + + + + + Checks the first item in the paragraph is inline item or not. + + + Returns true, if the first item is inline ; otherwise returns false. + + + + Determines whether the first item is break items in the specified paragraph. + + The paragraph. + + + + + Gets column client area. + + + + + + Clear Fields on new page. + + + + + Get Required Height for Continuous Section. + + + + + Get the floating item height. + + Floating Item collection. + Return the Floating item height. + + + + Get first line height of the section + + + + + + Check whether the current section have multiple columns with equal column width + + + + + + Checks Next Section BreakType. + + The isContinuousSection. + + + + + + + + + + + + Finds the intersect point and removlt widget. + + + + + Check whether current widget is floating item or not. + + + + + + + + + + + + + + + + Checks whether to continue layouting with next section. + + If true; Then continue layouting with the next section. If false; Then continue with current section + + + + Resets properties related to continuous section layout. + + + + + Resets the IsNotFitted boolean in the Paragraph layout info. + + Layouted widget + + + + Handle Column Break and Page Break in the Continuous section. + + If true; Then push all the layouted widgets. If false; Then not push the layouted widgets + + + + Update Section Height. + + + + + Handle Layouted Widget. + + + + + + Get Lines Height. + + + + + + Gets the maximum height of the first line in the first row of a table. + + The LayoutedWidget representing the table. + The maximum height of the first line across all cells in the first row. + + + + Gets the height of the first line in a table cell, considering nested tables and block content controls. + + The LayoutedWidget representing the table cell. + The maximum height of the first line in the cell, or 0 if not found. + + + + Recursively calculates the maximum height of the first line encountered in a layout widget and its children. + + The LayoutedWidget to analyze. + + The maximum height of the first line found in the widget or its children. + Returns 0 if no suitable line is found. + + + + + + Recursively searches for the last paragraph widget in the LayoutedWidget hierarchy. + + The LayoutedWidget to search through. + The last LayoutedWidget representing a paragraph, or null if not found. + + + + Get Column index which have minimum column width + + + + + + Get Column index which have maximum column width + + + + + + + + + + + + + + + + + + + Push Footnote layouted widgets into current page + + + + + + + Push Endnote layouted widgets. + + + + + + + + + + + + + + + + + + + + Specifies whether azure compatible with Metafile creation + + + + + Gets the DrawingContext + + + + + Gets and set IsFirstLayouting + + + + + Gets and set IsUpdatingTOC + + + + + Gets or sets a value indicating whether this instance is layouting header footer. + + + true if this instance is layouting header footer; otherwise, false. + + + + + Gets the bookmark hyperlinks. + + + + + Gets the bookmarks. + + + + + Decides whether to force fit the widgets during layouting process. + While creating new page this property will be enabled. + + + + + Decides whether multi column with continue section content layouting. + + + + + Gets or sets a value indicating whether to preserve the ole equation as bitmap in Word to PDF conversion. + + + + + Gets pages collection + + + + + Gets the Last TOC Entry entity + + + + + Gets or sets value indicates whether to export Word document heading as PDF bookmarks. + + + + + Gets the current page. + + The current page. + + + + Gets the current section. + + The current section. + + + + Gets the current page client height. + + + + + Gets the current column. + + The current column. + + + + Gets the result. + + The result. + + + + Gets a value indicating whether this instance is even page. + + + true if this instance is even page; otherwise, false. + + + + + Gets or sets a value indicating whether create image using transparancy or not + + + + + Holds the widgets height which is removed from column by Keepwithnext behavior. This is used only for multi column with continous section break. + + + + + Gets or sets the TOC link style instance. + + The TOC link styles instance + + + + Gets or sets the floating items. + + + The floating items. + + + + + Gets the floating items. + + + The floating items. + + + + + Gets or sets the layoutted Equation field switches. + + + The equation field. + + + + + Gets or sets the maintainlt widget. + + + The maintainlt widget. + + + + + Gets or sets the inter secting point. + + + The inter secting point. + + + + + Gets the TOC entry page numbers. + + The TOC entry page numbers. + + + + Indicates whether a header and footer of a specific type needs relayout within the current page. + + A dictionary with keys representing header/footer types and values indicating relayout necessity (true or false). + + The dictionary is initialized or reset when the current section changes. + + + + + It is hold the total number of pages in the section. + + + + + Gets or sets a value indicating whether to use TC fields. + + true if use TC fields; otherwise, false. + + + + + + + + + Initializes a new instance of the class. + + The dl. + if set to true [b footer]. + + + + Gets the next area. + + The area. + The isContinuousSection. + + + + + Modifies the area of a header or footer widget. + + The current header or footer widget container. + The original area of the widget. + The modified area of the widget, potentially with adjusted height. + + + + Pushes the LayoutedWidget to external holder. + + The LayoutedWidget. + + + + Handles the splitted widget. + + The splitted widget container. + The current state of layout context. + The LayoutedWidget. + isLayoutedWidgetNeedToPushed + + True for continue layout process, False - for stopping + + + + + Handles the LayoutedWidget to external holder. + + The LayoutedWidget. + + + + Represents a hyperlink annotation with a URL, display screenTip, and area in the document. + + + + + Initializes a new instance of the class + + The url + The screenTip + Bounds area + + + + Gets or sets the Bounds. + + The Bounds. + + + + Gets or sets the Uri. + + The Uri. + + + + Gets or sets the screenTip. + + The screenTip. + + + + Represents the class which acts as an drawing context. + + + + + The default script factor for sub/super script. + + + + + The default factor values to fit the DinOffc font text into the corresponding font grid. + /// + + + + The default font size. + + + + + The default minimum font size for picture bullet. + + + + + The default scale factor for picture bullet. + + + + + Drawing Graphics. + + + + + Holds the list of hyperlinks and its corrsponding bounds. + + + + + Used to skip a text highlighter between the comment ranges. + + + + + Auto tag index + + + + + Skips the bookmark add for all the textrange of paragraph. + + + + + We have hold the underline style properties and bounds to draw a line. + using this dictionary, we have draw the line after the text drawn. + + + + + We have hold the Strike-Through properties and bounds to draw a line. + using this dictionary, we have draw the line after the text drawn. + + + + + Initializes a new instance of the PDFDrawingContext class. + + + + + Initializes a new instance of the PDFDrawingContext class. + + The graphics. + The page unit. + The page unit. + The page unit. + + + + Draws the Overlapping shape widgets. + Currently handled only for Docx format documents + + + + + Paragraph has a color which is mismatched from the next sibling paragraph color + + + + + Draws the paragraph. + + The paragraph. + The lt widget. + + + + Draws the text box. + + The text box. + The lt widget. + + + + We have handle for rotated childshapes. + + clipbounds value + return the clipbounds value + + + + Draw Bar Tab Stop of the paragraph + + + + + + + Get bounds to draw a paragraph back ground color and texture styles + + + + + + + + + + + Check whether Paragraph Containing list has break. + + ltWidget + + + + + Get the base entity + + + + + + + Get the text top position + + Represent the text + Represent the font + Represent the size + Return the Text drawing y position + + + + Decides whether, we should update the tab position or not. + + The widget. + Index of the entity. + + + + Updates the tab position. + + The widget. + The client area. + + + + Updates the decimal tab position. + + The lt widget. + The client area. + + + + Updates the decimal tab position in cell. + + The lt widget. + The client area. + + + + Determine whether is Decimal Tab Start + + + + + + + + + + + + Get Width To Shift the xposition of childwidget + + + + + + + + + + Get the paragraph format for current tab + + The Paragraph + Paragrph format + + + + Get Column Width + + The Paragraph + + + + + Get Left width of the Decimal seperator + + + + + + + + + Get Left width of the Decimal seperator + + The lt widget. + The decimal tab start. + The decimal tab end. + + + + + Get Index of Decimal Separator + Index denotes the TextRange which have a decimal separator + + + + + + + + + + + + Get Index of Decimal Separator + Index denotes the TextRange which have a decimal separator + + The lt widget. + The decimal tab start. + The decimal tab end. + Width of the left. + The decimal separator. + if set to true [is separator]. + + + + + Determine whether is Decimal Separator + + + + + + + + + Get Owner paragraph of the LayoutedWidget + + + + + + + Gets the tab end index. + Index denotes the item, previous of next subsequent tab. + + The lt widget. + The start index. + + + + + Get the current list size. + + + + + + + + + Draws the list. + + Paragraph + Layouted Widget + List Format + + + + Draws the list tab leader. + + The paragraph. + The paragraph info. + Width of the list. + The x position. + The y position. + + + + Gets the tab leader. + + The paragraph info. + + + + + Gets the ascet value for Equation field. + + Equation field + + + + + Check whether the current lines contains the equation field and it + contains the height of the corresponding line. + + + + + + + Determines whether the paragraph is empty + + paragraph + returns true if paragraph is empty + + + + Calculate a line points for the WCommentMark. + + + + + + + Draw the WCommentMark. + + + + + Draw AbsoluteTab + + + + + + + Update AbsoluteTab leader + + + + + + + + Draws the Footnote separator + + The TXT range. + The lt widget. + + + + Draws the text range. + + The TXT range. + The lt widget. + The text. + + + + Trim the space characters in the text. + + + + + + Check whether the widget is in field result or not. + + Hyper link field + Widget. + If the widget is in field result, return True;else false. + + + + Update Target position to the bookmark hyperlink + + + + + + + Create Bookmark reference link + + + + + + + Determine whether the tab stop is preserved after the text range in the current line + + + + + + + Update Tab Width. + + + + + Fill with dots for tab leader + + Font + Current layouted widget + Character format of layouted widget + String format + text + + + + Fill with sigle for tab leader + + Font + Current layouted widget + Character format of layouted widget + String format + text + + + + Fill with hyphens for tab leader + + Font + Current layouted widget + Character format of layouted widget + String format + text + + + + Fills with space + + + + + + + + + Draws the Symbol + + + + + + + Draws the image. + + The image. + The bounds. + + + + Creates color matrix. + + brightness + contrast + saturation + + + + Convert the image to specified color using ImageAttributes. + + Original Image + ImageAttributes used to change the color. + Return the recolored image. + + + + Decides whether table is preserved inside text box or not. + + Table cell + Indicates whether to check textbox only. + + + + + Gets the bounding box of the rectangular bounds after rotation. + + Bounds + Degree of rotation + Bounding box of the rectangular bounds + + + + Calculates the minX, minY, maxX and maxY of the rotated bounds. + + + Bounding box of a rectangular bounds + + + + Gets the rotation transformation matrix + + Bounds of the picture + Rotation angle + Transformation matrix + + + + Get matrix values of skia's matrix. + + SKia's matrix to get values from. + Image matrix. + + + + Converts the ole object into bitmap when the image and object is of WMF and equation type respectively. + + + + + + + + Draw the InlineShapePicture + + + + + + + + + Create the Pen to draw the picture border + + + + + + + Get the color for the picture border + + + + + + + Get the line cap for picture border + + + + + + + Get LineJoin for picture border + + + + + + + Get the Dash and line style for the picture shape + + + + + + + + + Get the dash and line style for picture border + + + + + + + + Get the Dash style for the border + + + + + + + + Set the CropImageBounds if the image offset is negative + + + + + + + + + Gets the position to crop the image + + + + + + + Draws the equation field swtiches. + + + + + Draws an Array EQ switch using their properties. + + Represents a script type + A layouted array EQ switch. + Represents a charFormat for array switch. + Represents a for array EQ switch. + + + + Draws a radical switch and the radical symbol as a graphic path. + + Represents a script type. + A layouted radical EQ switch. + Represents a charFormat for radical switch elements. + + + + Enable the EnableComplexScript if the CharacterFormat.ComplexScript property is true. + + Current widget character format. + + + + Determines the destination points for drawing an original image within a parallelogram. + + Represents the bounds where the image will be drawn. + Represents the size of the image. + Represents the width of the left border of the image + Represents the width of the top border of the image + + + + Align the layouted equation field switch based on the current y position. + + Layouted EQ field switches + x position of layouted equation field switch + Y position of layouted equation field switch + + + + Shift the eqaution field's x, y position based on the given x,y value. + + Layouted EQ field switches + x position of layouted equation field switch + Y position of layouted equation field switch + + + + Generates the error text for the equation field. + + Represents a equation field to generate. + Represents a which set for equation field. + Represents a X position of equation field. + Represents a Y position of equation field. + + + + Shift the equation field's y position based on the given y value. + + Layouted EQ field switches + Y position of layouted equation field switch + + + + Gets the top most Y position of layouted EQ fields. + + Layouted EQ field + Minimum value of y position + + + + + Draws the string. + + Represents a script type. + The text. + The char format. + The para format. + The bounds. + The clipwidth. + The layouted widget. + + + + Rotate a Graphics based on Shape Rotation. + + Specified the rotation angle. + Specifies whether text needs to vertically flip. + Specifies whether text needs to horizontally flip. + Specifies whether the text need to rotate. + Specifies the text wrapping style. + Indicates whether the text need to scale or not. + Indicates whether the line rotate transform is applied or not. + Specifies the modified rotation angle. + + + + Check that previous or next sibling is tab in that line paragraph + + CharacterFormat + textBounds + LayoutedWidget + isSameLine + + + + Calculate the Text Bounds + + + + + + + + + + Add the line to the Dictionary collection + + + + + + + + + + + + Check that can we extend the previous Underline to the next text. + + Previous boundsRight + Current boundsX + Current CharacterFormat + Previous CharacterFormat + + + + + Compare the two float values. + + Value 1 + value 2 + Round off value + + + + + Check that text having underline or strike through. + + TextRange + Charformat + + + + + + Check that the Inline content control having the text range. + + + Return true, if the InlineContentControl have text range; Else false. + + + + Checks whether the current widget is tab + + + + + + + Get the text box widget of current widget. + + + + + + + Reverse the string + + + + + + Draws the small cap string. + + scriptType + characterRangeType. + The text. + The character format. + The bounds. + The font. + The format. + The text brush. + if set to true [is character spacing]. + + + + Determine whether the text is need to clip when the text range y position is greater than the owner row bottom position + + + + + + Determine whether the text is need to clip when the text range x position is beyond the cell bounds or crossing the cell bounds + + + + + + Gets the index of the column. + + The section. + The section bounds. + + + + + Get Y position to clip paragraph items + + + + + + + + Get Default font to render non east characters + + + + + + + + + Draw String based on CharacterSpacing + + Script Type + Character Range Type + Font style of current Layouted widget + Text brush + Layouted widget bounds + Text + string format + character Format + + + + Transform the graphics rendering positions based on rotation angle + + Current ltWidget + set to true when the widget need to scale + set to true when the widget rotate transform is applied + Translation points + Rotation angle + OwnerParagraph + + + + Update the X and Y position + + X posiiton + Y position + Owner entity + Layouted Widget + Update the X and Y position when document has different page setup. + + + + Gets the height of the layouted text box content. + + The lt widget. + + + + + Get Width to shift vertical text + + + + + + + + + Get Bounds to clip the text + + + + + + + + + Update clip bounds based on vertical cell + + + + + + + + Update clipping bounds based on owner clipping + + + + + + + + Get Height of the cell with text direction as vertical + + + + + + + Draw Chinese Text + + + + + + + + + + + + + Checks whether the text is valid. (applicable for Arial text) + + + + + + Draw Unicode Text + + + + + + + + + + + + + Draw unicode string + + + + + + + + + + + + + Determines whether the owner paragraph is empty + + text + + true if owner paragraph is empty, set to true. + + + + + Rotate and scale the graphics transform matrix + + Layoted widget bounds + Clip bounds + Scaling factor value + Translation points + Rotation angle + + + + Scale the graphics transform matrix. + + Scaling factor value + Translation points + Rotation angle + + + + Draws the paragraph borders. + + the paragraph + The paragraph format. + The lt widget. + isParagraphMarkIsHidden + + + + Draws the paragraph borders + + Collection of borders, contains the each border rendering order + Border bounds + Current paragraph borders + Previous paragraph borders + Paragraph + Layouted widget + + + + Draws the horizontal border. + + The border rendering order. + The bounds. + The borders. + The border. + if set to true [is multi line left border]. + if set to true [is multi line right border]. + if set to true [is multi line horizontal border]. + Width of the between border line. + Width of the left border line. + Width of the right border line. + Paragraph + Layouted widget + + + + Draws the left border. + + The border rendering order. + The bounds. + The borders. + The border. + The previous border. + if set to true [is multi line top border]. + if set to true [is multi line bottom border]. + if set to true [is multi line left border]. + if set to true [is multi line horizontal border]. + Width of the left border line. + Width of the top border line. + Width of the between border line. + Width of the bottom border line. + Paragraph + Layouted widget + + + + Draws the right border. + + The border rendering order. + The bounds. + The borders. + The border. + The previous border. + if set to true [is multi line top border]. + if set to true [is multi line horizontal border]. + if set to true [is multi line right border]. + if set to true [is multi line bottom border]. + Width of the right border line. + Width of the top border line. + Width of the between border line. + Width of the bottom border line. + Paragraph + Layouted widget + + + + Draws the top border. + + The border rendering order. + The bounds. + The borders. + The border. + if set to true [is multi line top border]. + Width of the top border line. + Width of the left border line. + Width of the right border line. + + + + Draws the bottom border. + + The border rendering order. + The bounds. + The borders. + The border. + if set to true [is multi line bottom border]. + Width of the left border line. + Width of the bottom border line. + Width of the right border line. + Paragraph + Layouted widget + + + + If paragraph inside Text box or shape have bottom border and that paragraph is the last element of textbox means + Microsoft word will preserve the bottom border at the top of the bottom margin of text box or shape by subtracting the internal bottom margin spacing and the text box or shape line width. + + + The spacing between the paragraph bottom border and textbox's or shape's bottom border + + + + Sort the borders based on brightness + + Border rendering order list + Horizontal border + Either left border/right border + Current paragraph borders + To ensure wether we need to remove left or right border + + + + Adds the next paragraph bounds. + + The layouted widget. + The bounds. + + + + + Draw the revision bars in the specified color and width + + Start point of the revision bar + End point of the revision bar + Color of the revision bar + Width of the revision bar + + + + Draws the border. + + The border. + The start. + The end. + + + + Draws the border. + + The border. + The start. + The end. + + + + Draws the border. + + The border. + The start. + The end. + + + + Draws the table. + + The table. + The lt widget. + + + + Draws the table row. + + The row. + The lt widget. + + + + Draws the table cell. + + The cell. + The lt widget. + + + + Fill the Cell Color + + The Layouted widget + + + + Checks the TextBox for Background picture. + + + + + + + Draws the texture style. + + + + + + + + + Gets the fore color. + + + + + + + + + Gets the color value. + + The fore color value. + The back color value. + The percent. + isForeColorEmpty + isBackColorEmpty + + + + + Fill Texture within the bounds + + Texture Style + Fore Color + Back Color + Bounds + + + + Draws the cell borders. + + The cell. + The lt widget. + The previous cells top border width + + + + Draws the multi line left border. + + The cell layout information. + The left border. + The start. + The end. + if set to true [is first row]. + if set to true [is last row]. + if set to true [is first cell]. + if set to true [is last cell]. + + + + Draws the double line left border. + + The cell layout information. + The left border. + The start. + The end. + if set to true [is first row]. + if set to true [is last row]. + if set to true [is first cell]. + if set to true [is last cell]. + + + + Draws the multi line right border. + + The cell layout information. + The right border. + The start. + The end. + if set to true [is first row]. + if set to true [is last row]. + if set to true [is first cell]. + if set to true [is last cell]. + + + + Draws the right double line border. + + The cell layout information. + The right border. + The start. + The end. + if set to true [is first row]. + if set to true [is last row]. + if set to true [is first cell]. + if set to true [is last cell]. + + + + Draws the multi line bottom border. + + The cell layout information. + The start. + The end. + isBiDiTable + + + + Draws the double line bottom border. + + The cell layout information. + The start. + The end. + isBiDiTable + + + + Draws the multi line top border. + + The cell layout information. + The top border. + The start. + The end. + if set to true [is start]. + if set to true [is end]. + + + + Draws the top double line border. + + The cell layout information. + The top border. + The start. + The end. + if set to true [is start]. + if set to true [is end]. + + + + Determines whether the specified border is multiline border + + Type of the border. + + + + + Determines whether [is multi line paragraph border] [the specified border type]. + + Type of the border. + + + + + Gets the border line array. + + Type of the border. + Width of the line. + + + + + To identify whether current border is double line border or triple line border + + Current border which is need to be check + Trueid the current border type is double border + + + + Draws the multi line left border. + + The left border. + The start. + The end. + if set to true [is top border same]. + if set to true [is between border same]. + if set to true [is bottom border same]. + + + + Draws the double line left border. + + The left border. + The start. + The end. + if set to true [is top border same]. + if set to true [is between border same]. + if set to true [is bottom border same]. + + + + Draws the triple line left border. + + The left border. + The start. + The end. + if set to true [is top border same]. + if set to true [is between border same]. + if set to true [is bottom border same]. + + + + Draws the multi line right border. + + The right border. + The start. + The end. + if set to true [is top border same]. + if set to true [is between border same]. + if set to true [is bottom border same]. + + + + Draws the double line right border. + + The right border. + The start. + The end. + if set to true [is top border same]. + if set to true [is between border same]. + if set to true [is bottom border same]. + + + + Draws the triple line right border. + + The right border. + The start. + The end. + if set to true [is top border same]. + if set to true [is between border same]. + if set to true [is bottom border same]. + + + + Draws the multi line top border. + + The top border. + The start. + The end. + if set to true [is left border same]. + if set to true [is right border same]. + + + + Draws the double line top border. + + The top border. + The start. + The end. + if set to true [is left border same]. + if set to true [is right border same]. + + + + Draws the triple line top border. + + The top border. + The start. + The end. + if set to true [is left border same]. + if set to true [is right border same]. + + + + Draws the multi line bottom border. + + The bottom border. + The start. + The end. + if set to true [is left border same]. + if set to true [is right border same]. + + + + Draws the double line bottom border. + + The bottom border. + The start. + The end. + if set to true [is left border same]. + if set to true [is right border same]. + + + + Draw the double line for the text. + + charFormat + borderType + lineWidth + start point + end point + + + + Draws the triple line bottom border. + + The bottom border. + The start. + The end. + if set to true [is left border same]. + if set to true [is right border same]. + + + + Draws the multi line between border. + + The between border. + The start. + The end. + if set to true [is left border same]. + if set to true [is right border same]. + The left border. + The right border. + if set to true [is overlap left]. + if set to true [is overlap right]. + + + + Draws the double line between border. + + The between border. + The start. + The end. + if set to true [is left border same]. + if set to true [is right border same]. + The left border. + The right border. + if set to true [is overlap left]. + if set to true [is overlap right]. + + + + Draws the triple line between border. + + The between border. + The start. + The end. + if set to true [is left border same]. + if set to true [is right border same]. + The left border. + The right border. + if set to true [is overlap left]. + if set to true [is overlap right]. + + + + Gets the adjacent border line width + + Left or right border line array + true if we passing left border line array; otherwise false + + + + + Draws the color of the background. + + Color of the bg. + The width. + The height. + + + + Draws the back ground image. + + The image. + The page setup. + + + + Draws the Watermark + + Watermark + Page setup + Bounds + + + + Imlementation of Draw method of page. + + Currentl drawing page + autoTagsCount + + + + Retrieves the list of previous line comment start marks and clears the current marks. + + + + + Draws balloons for the track changes. + + Pen to draw the balloon outline + Track changes balloon rect + + + + Draws Markup triangles. + + Position to draw the triangle. + Revision Color + + + + Checks the current watermark is empty watermark or not. + + + + + + Checks the HeaderFooter Paragraph and Table Weather WaterMark has to draw first + + + + + + Checks the paragraph weather watermark in Paragraph + + + + + + + + Checks the paragraph weather watermark in Table + + + + + + + + Checks which One has to draw first watermark or picture,shape,textbox + + + + + + + + + Draw the splitWidgetContainer to PDF document or Image. + + Currentl split widget container + Layouted widget + + + + Align the child widgets. + + The layouted widget. + The paragraph. + + + + Imlementation of Draw method of IWidget interface . + + + + + + + Draw widget to graphics. + + + + + Draws the specified dc. + + + + + + + Check whether the widget is need to drwa or not + + + + + + + Draw the page border + + Page number + + + + + Imlementation of Draw method of BookMark interface . + + + + + + + Decides whether Clipping is necessary or not. + + + + + + + Get text highlight color + + + + + + + Check whether the paragrah contains Text range + + + + + + + Imlementation of Draw method of LayoutedWidget interface . + + The Layouted widget. + Is need to initialize layout info + + + + Iterate every child elements of the table and add the floating items into the OverLappedShapeWidgets collection + + Table layouted widget + + + + Iterate the child elements of the paragraph + + Paragraph layouted widget + + + + Checks whether the child widget is floating item and add into the collection + + Child layouted widget + + + + Get space width at end of the line widget. + + + + + Checks whether the paragraph line is RTL. + + + + + + + Checks whether the paragraph line has text bidi. + + + + + + + Check that Line item are drawn. + + LayoutedWidget + Return true, if line items are drawn. + + + + Draw the Line Based in the collection. + + Contains the underline values + Contains the strike through values + + + + Transform the graphics based on the rotation and scaling. + + The character format. + Indicates whether the line need to scale or not. + Indicates whether the line rotate transform is applied or not. + Indicates whether the line need to set clip or not. + Line widget. + + + + Gets the rotation values from the textbox, shapes(ChildShapes/GroupShapes). + + Specified the rotation angle. + Specifies whether it is vertical flip. + Specifies whether it is horizontally flip. + Specifies whether the text need to rotate. + Specifies the text wrapping style. + Specifies the current textrange. + + + + Checks whether the underline width is need to change or not. + + + + + Draw the underline style. + + + + + + + Draw a wavy line using curved points + + represents the character properties of the text + represents the bounds of the text + represents the font of the text + returns the GraphicsPath object to draw the wavy line + + + + + Create the Pen to draw the Line for Underline and Strike through. + + charFormat + lineWidth + Return the Pen to draw the line. + + + + Checks whether clip bounds need to remove from container. + + + + + + + Increase the bounds with the table paddings. + + + + + + + Updates the clip bounds based on its owner clip bounds. + + + + + + + + Sets clipping for the particular region. + + + + + + Resets Graphics Transform positions. + + + + + Scale the graphics with input X and Y scaling values. + + Specify the scaling factor of X. + Specify the scaling factor of Y. + + + + Get the bounds based on the frame content. + + + + + + + Draw the paragraph + + + + + + + Draw a Comment highlighter for the line. + + Represents a layouted widget of line. + Represents a WordDocument. + + + + Gets a KeyValuePair for the specified key from specified collection. + + Represents a input key to find. + Represents a KVP colection. + Returns a KeyValuePair for the specified key from specified collection. + + + + Check whether a KeyValuePair is available in specified collection for the specified key. + + Represents a input key to find. + Represents a KVP colection. + Returns a true, if KeyValuePair available in specified collection; Otherwise false. + + + + Draw a comment highlighter. + + + + + + + Gets maximum height widget of line. + + Represent a layouted widget of line. + Returns a LayoutedWidget, which has maximum height in line. + + + + Check whether any of line for current paragraph intersect with floating items. + + Current widget + Whether this is line or line container + + + + + Draw the back ground colour for current line. + + Current paragraph + Current line widget + + + + Find the Back ground color rendering bounds. + + + + + + + + Check whether line preserved left or right or between floating items. + + + + + + + + + + Get the current child widget total bounds. + + + + + + + Draw the split table widget + + + + + + + Draw method for BlockContentControl + + + + + + + Draw method for InlineContentControl + + + + + + + Draw WCommentMark + + + + + + + Draw AbsoluteTab + + + + + + + Draw chart as image + + + + + + + Draws chart + + + + + + + Draw the Check box. + + + + + + + Draw the Drop Down Form Field. + + + + + + + Draw the Fields. + + + + + + + Draw Ole Object. + + + + + + + Draw the Picture. + + + + + + + Draw the symbol. + + + + + + + Draw the table. + + + + + + + Gets the frames first item. + + + + + + + + + Draw the table cell. + + + + + + + Draw the table row. + + + + + + + Draw the textbox. + + + + + + + Draw the text form field. + + + + + + + Imlementation of Draw method of LayoutedWidget interface + + + + + + + Draw the shape to PDF document or Image. + + Current shape entity + Current shale layouted widget + + + + Draw the shape to PDF document or Image. + + Current shape entity + Current shale layouted widget + + + + Draw the splitStringWidget + + SplitStringWidget + Layouted split string widget + + + + Draw the text ranges. + + + + + + + Draw widget to graphics. + + + + + + + + Draw widget to graphics. + + + + + Get Cell Widget + + + + + + + Gets the owner widget of the paragraph + + + + + + + Get owner widget of the cell + + + + + + + Determines whether the layouted widget is Overlapping Widget + + The lt widget. + + true if the layouted widget is Overlapping shape widget; otherwise, false. + + + + + Update the positions of text watermark. + + TextWatermark + + + + + + + Draw the text watermark. + + + + + + + + Convert the Watermark text as Bitmap Image. + + + + + + + + Change the given color brightness + + + + + + + + Draw border for the page + + Page setup object + Header bounds + Footer bounds + Page bounds + + + + + Gets the bounds to draw left border + + Page setup object + Header bounds + Footer bounds + Page bounds + + + + + Gets the bounds to draw right border + + Page setup object + Header bounds + Footer bounds + Page bounds + + + + + Gets the bounds to draw bottom border + + Page setup object + Header bounds + Footer bounds + Page bounds + + + + + Gets the bounds to draw top border + + Page setup object + Header bounds + Footer bounds + Page bounds + + + + + Gets the font size for Text Watermark + + Text Watermark + + + + Adjust the brightness and contrast of the picture. + + Represents a image that we need to gets a graphics. + The image. + Represents image Attributes + if set to true [is picture watermark]. + + + + + Draws the Picture Watermark + + Picture Watermark + Bounds + Page Setup + + + + Draws the check box. + + The checkbox. + The lt widget. + + + + Draw picture fill + + Imagebytes + Shapes path + Layouted widget bounds + + + + Apply transparency for image + + Represents image Attributes + Represents image transparency + + + + Draw child shape + + + + + + + + + + + + + + Rotate the shape based on Flip positions + + + + + + + + + + + + + + + + + + + + + + Measures the image. + + The image. + + + + + Measures the picture bullet size + + Picture + Font + The size of picture bullet + + + + Measures the string. + + The text. + The font. + The format. + + + + + Measures the string. + + The text. + The font. + The format. + The character format. + isMeasureFromTabList + + + + + Gets the exact bounds of a string without an line spacing and top/bottom spacing values of font. + + Specify the input string. + Specify the font to measure. + + + + + Measures the string. + + The text. + The font. + The format. + The character format. + if set to true [is measure from tab list]. + if set to true [is measure from small cap string]. + + + + + Get the factor. + + Represents a font name. + + + + Calculates the font size for subscript and superscript font. + + Represets a normal font to change as subscript and superscript size. + Returns font size of subscript and superscript for corresponding inputed font. + + + + Get the Exceeded line height of the Arial unicode MS font. + + The font. + isAscent. + + + + + Measures the string. + + The text. + The font. + The default font + The format. + The Character format + + + + + Measures the small cap string. + + The text. + The size. + The font. + The format. + The character format. + + + + Draw Unicode Text + + + + + + + + + + + + + + + + + + Gets the ascent + + The Font. + + + + + Gets the descent + + The Font. + + + + + Translate the specified matrix with offsetX and offsetY + + Represent the matrix to translate + Represent the offsetX + Represent the offsetY + Represent the MatrixOrder to traslate + + + + Multiply the specified matrix with target matrix + + Represent the matrix to translate + Represent the target matrix + Represent the MatrixOrder to traslate + + + + Rotate the specified matrix with specified angle. + + + Represent the angle to rotate the matrix + Represent the center point to rotate a matrix + Represent the MatrixOrder to traslate + + + + Gets a new GraphicsPath object. + + Returns a new GraphicsPath object. + + + + Gets a new Bitmap object with specified width and height. + + Represents a width of Bitmap. + Represents a height of Bitmap. + Returns a new Bitmap object with specified width and height. + + + + Gets a Graphics of with specified image. + + Represents a image that we need to gets a graphics. + Returns a Graphics of with specified image. + + + + Draw a unicode text with specified font properties. + + Represents a text. + Represents a font. + Represents a brush. + Represents a bounds. + Represents a StringFormat. + + + + Gets a image to be drawn. + + Represents a input image. + Returns a image to be drawn. + + + + Gets a image to be drawn. + + Represents a input image bytes. + Returns a image to be drawn. + + + + Create a Image from specified image stream. + + Represent a image stream. + Returns a Image from specified image stream. + + + + Gets a new HatchBrush object with specified HatchStyle and color. + + Represents a HatchStyle of HatchBrush. + Represents a fore color of HatchBrush. + Represents a back color of HatchBrush. + Returns a new HatchBrush object with specified HatchStyle and color. + + + + Gets a new Pen object with specified color. + + Represents a color of Pen. + Returns a new Pen object with specified color. + + + + Gets a new Pen object with specified color and width. + + Represents a color of Pen. + Represents a width of Pen. + Returns a new Pen object with specified color and width. + + + + Gets a new SolidBrush object with specified color. + + Represents a color of SolidBrush. + Returns a new SolidBrush object with specified color. + + + + Gets a new ColorMatrix object. + + Returns new ColorMatrix object. + + + + Gets a new ColorMatrix object with specified color matrix. + + Represents a color of matrix. + Returns new ColorMatrix object with specified color matrix. + + + + Gets a new ImageAttributes object. + + Returns a new ImageAttributes object. + + + + Draws the arrow head. + + The shape. + The pen. + The bounds. + if set to true [is arrow head exist]. + The path. + The line points1. + + + + Draws the arrow head. + + The shape. + The pen. + The bounds. + if set to true [is arrow head exist]. + The path. + The line points1. + + + + Draws the open end arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Draws the close end arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Draws the stealth end arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Draws the close end arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Draws the stealth end arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Draws the open begin arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Draws the open begin arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Draws the close begin arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Draws the close begin arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Draws the stealth begin arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Draws the stealth begin arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Adds the close arrow head points. + + The points. + The pen. + + + + Adds the stealth arrow head points. + + The points. + The pen. + + + + Adds the open arrow head points. + + The points. + The path. + + + + Gets the open arrow default values. + + The lineFormat. + Width of the line. + Length of the arrow. + The arrow angle. + The adjust value. + if set to true [is from begin arrow]. + + + + Gets the close arrow default values. + + The shape lineFormat. + Width of the line. + Length of the arrow. + The arrow angle. + The adjust value. + if set to true [is from begin arrow]. + + + + Gets the length of the arrow head. + + + + + + Gets the close narrow arrow default values. + + Length of the arrow head. + Width of the line. + Length of the arrow. + The arrow angle. + The adjust value. + + + + Gets the close medium arrow default values. + + Length of the arrow head. + Width of the line. + Length of the arrow. + The arrow angle. + The adjust value. + + + + Gets the close wide arrow default values. + + Length of the arrow head. + Width of the line. + Length of the arrow. + The arrow angle. + The adjust value. + + + + Gets the open narrow arrow default values. + + Length of the arrow head. + Width of the line. + Length of the arrow. + The arrow angle. + The adjust value. + + + + Gets the open medium arrow default values. + + Length of the arrow head. + Width of the line. + Length of the arrow. + The arrow angle. + The adjust value. + + + + Gets the open wide arrow default values. + + Length of the arrow head. + Width of the line. + Length of the arrow. + The arrow angle. + The adjust value. + + + + Finds the angle to left and right head point. + + + + + The point1. + The point2. + + + + + + Finds the angle to left and right head point. + + The shape. + The point1. + The point2. + + + + + + Finds the arrow head angle radians. + + The point1. + The point2. + if set to true [is from separate orientation]. + + + + + Finds the base line end point. + + + + + + The line points. + The adjust value. + + + + + + Gets the end point. + + if set to true [is from begin arrow]. + The degree. + The length. + The adjust value. + The line points. + The x. + The y. + + + + Finds the angle radians. + + The line points. + if set to true [is from bottom to top]. + + + + + Finds the end cap arrow head points. + + The shape. + The pen. + The bounds. + The line points. + if set to true [is from open arrow]. + + + + + + Finds the end cap arrow head points. + + The shape. + The pen. + The bounds. + The line points. + if set to true [is from open arrow]. + + + + + + Finds the left right head points. + + + + + The line points. + The points. + The arrow angle. + Length of the arrow. + if set to true [is from begin arrow]. + + + + Construcs the baset line. + + if set to true [is from begin arrow]. + The points. + The line points. + + + + + + Gets the arrow default values. + + The line Format. + The pen. + Length of the arrow. + The arrow angle. + The adjust value. + + if set to true [is from begin arrow]. + + + + Radians to degree. + + The angle. + + + + + Degree2s the radian. + + A. + + + + + Gets the end point. + + The angle. + The length. + The start_x. + The start_y. + The end_x. + The end_y. + + + + Gets the line points based on flip. + + + + The bounds. + + + + + Determines whether the text range is soft hyphen and that need to be drawn. + + The lt widget. + + + + + Gets the string format. + + The char format. + + + + + Gets the brush. + + The color. + + + + + Gets the color of the text. + + The char format. + + + + + Get the RevisionColor + + Revision color + + + + + Get the RevisionColor + + Revision color + Is revision type insert type + + + + + Get the RevisionColor + + Revision color + Is revision type insert type + + + + + Get the RevisionColor to fill a comment balloon. + + Revision color + Is revision type insert type + + + + + Updates the alternate font for the font not installed in the system. + + The char format. + Name of the font. + The font. + + + + Checks the owner paragraph of the textrange is a TOC + + Text Range + + + + + Determins whether the paragraph is TOC. + + + + + + + Determines the the paragraph contians hyperlink field. + + + + + + + To check the current text range is present inside the HyperLink. + + + + + + + Check whether current text range is present inside the hyperlink field. + + + + + + + + Gets the font. + + + The char format. + + + + + + Updates the font name and size based on the Bidi property. + + + Character format of the current text range. + Font applied to the current text. + Font size applied to the current text. + Font style applied to the current text. + Returns current text range Bidi font. + + + + Gets the string alignment. + + The para format. + + + + + Gets the pen. + + The border. + + + + + + Gets the pen. + + Type of the border. + Width of the border line. + Color of the border. + + + + + Gets the pen. + + Type of the underline. + Width of the underline. + Color of the underline. + + + + + Scales the image. + + The image. + The width. + The height. + + + + + Adds link to the bookmark. + + The bounds. + The bookmark name. + The target is nothing. + + + + Creates bookmark hyperlink and add into list. + + + + + + + + Adds the hyper link to collection. + + The hyperlink. + The bounds. + + + + Adds the hyper link to collection. + + The picture. + The bounds. + + + + Updates the target bounds and page number for current bookmark. + + Bookmark hyperlink. + Bookmark hyperlink value. + + + + Updates the TOC level. + + The paragraph. + The bookmark. + + + + Updates Result index + + text + the measurer + res index + bSplitByChar + bIsInCell + offset + Client Width + + + res Index + + + + Determine whether the character is CJK leading character + A line of text cannot end with any leading characters, which are listed below + + + + + + + Determine whether the character is Begin CJK character + A line of text cannot begin with any following characters + + + + + + + Determine whether the character is CJK overflow character + Overflow characters are allowed to render in the same line when it doesn't have required client width to fit the character + + + + + + + + + + + + + + Get previous text range + + + + + + Get cell Width + + The paragraph item + + + + + Concatenates the font name, style, font size and Unicode text and returns the key for PDFFontCollection. + + Font object to extract font name, font size and font style from. + check whether it's unicode or not. + Key for the PdfFontCollection dictionary to store and retreive the created PdfFont. + + + + Determines whether the text is unicode + + text + + true if text is unicode, set to true. + + + + + Gets length of WORD. + NOTE: + - WORD: text run that finished by last space letter + (sample: "text " or " "; wrong sample: " text" or "text text" ) + EXCLUSION: + - If text working part have zero symbols return (-1) + - If text working part don't consist SPACE letters return legth of + text working part + + + Index of word first letter + Length of found word + + + + Closes this instance. + + + + + Draws the behind shape widgets. + + + + + Get Order index of the floating item + + + + + + Get the line width of the picture border for Inline picture shape + + + + + + + Get the line width of the picture border + + + + + + + + + + + + Gets or sets a value that indicates whether to regenerate the nested EMF images present in the Word document during PDF conversion. Default value isfalse. + + True if it is necessary to regenerate the nested EMF images present in the Word document during PDF conversion; otherwise false. + + + + Get the Current Bookmark name + + + + + Gets or sets the value indicates whether to export Word document heading as PDF bookmarks. + + + + + Decides whether, we should enable PdfMetafile.ComplexScript property for current page. + + + + + Gets or sets the custom font collection. + + + + + Gets or sets the custom font name collection. + + fontName + + + + Gets a Fallback font collection of Word document. + + + + + Gets or set the embedded fonts. + + + + + Gets or sets the graphics. + + The graphics. + + + + Gets the bitmap graphics. + + The graphics. + + + + Gets the hyperlinks. + + The hyperlinks. + + + + Gets the bookmark hyperlinks list. + + + + + Gets the bookmarks. + + + + + Gets the overlapping shape widgets. + + The overlapping shape widgets. + + + + Gets the font metric. + + + The font metric. + + + + + Gets the string formt. + + + The string formt. + + + + + Gets or sets a value indicating whether to embed fonts to converted PDF in Word to PDF conversion. + + + + + Gets or sets a value indicating whether to preserve the ole equation as bitmap in Word to PDF conversion. + + + + + Gets or sets a value indicating whether to embed the complete font information in the resultant PDF document. + + + + + Gets or sets a value indicates whether the converted PDF document is tagged or not. + + Remarks: Set this property as true, to preserve the accessible structure tags from Word document to the converted PDF. Using this property Word documents can be converted to PDF with 508 compliance. + Setting this property as true will automatically enable EnableFastRendering property. + + + + + + + + + + + + + + + + + Gets the vertical border + + + + + Gets / sets the horizontal border + + + + + Initializes a new instance of the class. + + Name of the bookmark. + The page number. + The bounds. + + + + Gets or sets the bookmarkStyle. + + The bookmarkStyle. + + + + Gets or sets the bounds. + + The bounds. + + + + Gets or sets the page number. + + The page number. + + + + Gets or sets the name of the bookmark. + + The name of the bookmark. + + + + Sort the border rendering order based on its color brightness order + + + + + Represents the class which drawing a Math Equations. + + + + + Creates a class instance to render the WMath entity. + + Represent the + + + + Draw the WMath instance. + + Represent the WMath instance to draw + Represent the layouted widget of WMath instance + + + + Draw the IOfficeMath instance. + + Represent the layouted widget of OfficeMath instance + + + + Draw the delimiter character with required stretching. + + Specify the delimiter widget. + Specify the required height to stretch. + Specify the character format. + + + + Draw the Line used in MathML. + + Represent the layouted widget of a line. + + + + Draw the layouted string widget. + + Represent the string widget + Represent the characterFormat + Represent the scalingFactor + + + + Dispose a MathRenderer object. + + + + + Gets a class object for drawing. + + + + + Represents a page. + + + + + Initializes a new instance of the class. + + The section. + The i number. + + + + Initializing LayoutInfo value to null + + + + + + + + + + + + + + + + + Gets the header area. + + + + + + Gets the footer area. + + + + + + Updates the gutter value of inside (left for odd page and right for even page) margin. + + + + + + + Change the Left and Right margin. + + + + + + + Gets the column area. + + The column. + Width of the prev. + + + + + Gets the column area. + + Index of the column. + Width of the prev columns. + + + + + Gets the section area. + + The column. + Width of the prev. + + + + + Gets the section area. + + Index of the column. + Width of the prev columns. + isNextSection. + + + + + Collection of lay outed widget. + + The page widgets. + + + + Gets the page document sections. + + + + + Gets the back ground images of the page. + + + + + Gets the document back ground color. + + + + + Collection of Footnote lay outed widget. + + The Footnote widgets. + + + + Collection of Endnote layouted widget. + + The Endnote widgets. + + + + Gets the collection of the trackchanges markups + + + + + Gets the Collection of BehindWidgets in the page + + + + + Collection for section id's of End note Widgets. + + The Section's ID's. + + + + Collection for section id's of Foot note Widgets. + + The Section's ID's. + + + + Gets page Setup info. + + + + + Gets page number. + + + + + Get the number of Behind widgets in header + + + + + Get the number of Behind widgets in footer + + + + + Need to swap left right margin values, when mirror margin property enabled + And the current page is even page. + + + + + Represents a collection of pages + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + Gets the pages. + + The pages. + + + + Initializes a new instance of the class. + + + + + Gets or sets the rendered image. + + The rendered image. + + + + Gets or sets the hyperlinks. + + The hyperlinks. + + + + Represents a interface class to get fallback fonts during Direct PDF conversion. + + + + + Summary description for DataReaderEnumerator. + + + + + Represents the Rows Enumerator. + + + + + Resets the row index. + + + + + Returns a value indicating whether the end of row is reached. + + True if it is end of row, otherwise false + + + + Returns the cell value for a specified column name. + + The string represents the column name. + The element at the specified cell. + + + + Gets the column names of the table. + + The string array that has the column names of the table. + + + + Gets the total rows count. + + The integer that represents the total number of rows. + + + + Gets the current row index. + + The integer that represents the index of the current row. + + + + Gets the table name. + + The string that represents the name of the table. + + + + Gets a value indicating whether the end of the row is reached. + + True if it is the end of the row, otherwise false. + + + + Gets a value indicating whether the current row is last row. + + True if its last row, otherwise, false. + + + + Initializes a new instance of the class. + + The data reader. + + + + Resets the row index. + + + + + Returns a Boolean indicating whether the end of row is reached. + + True if it is end of row, otherwise false + + + + Returns the cell value for a specified column name. + + The string represents the column name. + The element at the specified cell. + + + + Closes this instance. + + + + + Gets the current row index. + + The integer that represents the index of the current row. + + + + Gets the total rows count. + + The integer that represents the total number of rows. + + + + Gets the table name. + + The string that represents the name of the table. + + + + Gets a value indicating whether the end of the row is reached. + + True if it is the end of the row, otherwise false. + + + + Gets a value indicating whether the current row is last row. + + True if its last row, otherwise, false. + + + + + + + + + Gets the column names of the table. + + The string array that has the column names of the table. + + + + Summary description for DataTableEnumerator. + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + The table. + + + + Initializes a new instance of the class. + + The row. + + + + Resets the row index. + + + + + Returns a Boolean indicating whether the end of row is reached. + + True if it is end of row, otherwise false + + + + Returns the cell value for a specified column name. + + The string represents the column name. + The element at the specified cell. + + + + Closes this instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + The table. + + + + Read the column names from mail merge data table of type IDictionary<string,object> ie collection of ExpandoObject + + + + + Read the column names of data table using data rows. + + The table + + + + + + + + + + + + + + Gets the current row index. + + The integer that represents the index of the current row. + + + + Gets the total rows count. + + The integer that represents the total number of rows. + + + + Gets the table name. + + The string that represents the name of the table. + + + + Gets a value indicating whether the end of the row is reached. + + True if it is the end of the row, otherwise false. + + + + Gets a value indicating whether the current row is last row. + + True if its last row, otherwise, false. + + + + + + + + + Gets the column names of the table. + + The string array that has the column names of the table. + + + + Summary description for DataViewEnumerator. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Resets the row index. + + + + + Returns a Boolean indicating whether the end of row is reached. + + True if it is end of row, otherwise false + + + + Returns the cell value for a specified column name. + + The string represents the column name. + The element at the specified cell. + + + + Closes this instance. + + + + + + + + + + Gets the current row index. + + The integer that represents the index of the current row. + + + + Gets the total rows count. + + The integer that represents the total number of rows. + + + + Gets the table name. + + The string that represents the name of the table. + + + + Gets a value indicating whether the end of the row is reached. + + True if it is the end of the row, otherwise false. + + + + Gets a value indicating whether the current row is last row. + + True if its last row, otherwise, false. + + + + + + + + + Gets the column names of the table. + + The string array that has the column names of the table. + + + + Represents the mail merge functionality in the Word document. + + + + + Fields used for nested mail merge. + + + + + Initializes a new instance of the class. + + The document. + + + + Performs the mail merge operation using an array of field names with its values as data source. + + The array of merge field names. + The array of merge field values. + + + + Performs the mail merge operation using a IEnumerable as data source. + + IEnumerable data source that contains the mail merge field names with corresponding values. + + + + Performs the mail merge operation for a specified region. + + The MailMergeDataTable contains the data source for performing mail merge operation. + + + + Performs the mail merge operation using a DataRow as data source. + + The DataRow contains the data for performing mail merge operation. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + + Performs the mail merge operation using a DataTable as data source. + + The DataTable contains the data for performing mail merge operation. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + + Performs the mail merge operation using a DataView as data source. + + The DataView contains the data for performing mail merge operation. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + + Performs the mail merge operation using a OleDbDataReader as data source. + + The OleDbDataReader contains the data for performing mail merge operation. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + + Performs the mail merge operation using a IDataReader as data source. + + The IDataReader contains the data for performing mail merge operation. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + + Performs the mail merge operation for a specified region using DataTable as data source. + + The DataTable contains the data for performing mail merge operation. + + ExecuteGroup mail merge functionality performs the replacements of merge fields, in which field names match the table column names with the ///corresponding values of table cell. These replacements are performed for every row contained in the table of the specified region. + The region where the mail merge operations are to be performed must be marked by two MergeFields with the following names: + + TableStart:TableName: For the entry point of the region. + TableEnd:TableName: For the end point of the region. + + For Example, You have to insert three MergeFields in the document with the following field names: + + TableStart:Geography: Marks the beginning of mail merge region. + FieldNames: Will be replaced by values from the table. + TableEnd:Geography: Marks the end of mail merge region. + + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + + + Performs the mail merge operation for a specified region using DataView as data source. + + The DataView contains the data for performing mail merge operation. + + ExecuteGroup mail merge functionality performs the replacements of merge fields, in which field names match the table column names with the ///corresponding values of table cell. These replacements are performed for every row contained in the table of the specified region. + The region where the mail merge operations are to be performed must be marked by two MergeFields with the following names: + + TableStart:TableName: For the entry point of the region. + TableEnd:TableName: For the end point of the region. + + For Example, You have to insert three MergeFields in the document with the following field names: + + TableStart:Geography: Marks the beginning of mail merge region. + FieldNames: Will be replaced by values from the table. + TableEnd:Geography: Marks the end of mail merge region. + + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + + + Performs the mail merge operation for a specified region using IDataReader as data source. + + The IDataReader contains the data for performing mail merge operation. + + ExecuteGroup mail merge functionality performs the replacements of merge fields, in which field names match the table column names with the ///corresponding values of table cell. These replacements are performed for every row contained in the table of the specified region. + The region where the mail merge operations are to be performed must be marked by two MergeFields with the following names: + + TableStart:TableName: For the entry point of the region. + TableEnd:TableName: For the end point of the region. + + For Example, You have to insert three MergeFields in the document with the following field names: + + TableStart:Geography: Marks the beginning of mail merge region. + FieldNames: Will be replaced by values from the table. + TableEnd:Geography: Marks the end of mail merge region. + + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + + + Performs the nested mail merge operation for a specified region using DataBase as data source. + + The DbConnection represents the database connection which contains data for mail merge. + The array of commands contains the sql queries to get the data from DB. + + Nested mail merge for a region works when the group start and end is BeginGroup and EndGroup respectively. + Nested mail merge for a table works when the group start and end is TableStart and TableEnd respectively. + The commands list to retrieve the DataTable from the data source must be in the same order of Group which is preserved in the input WordDocument. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + + + Performs the nested mail merge operation for a specified region using DataBase as data source. + + The DbConnection represents the database connection which contains data for mail merge. + The array of commands contains the sql queries to get the data from DB. + Set to true to indicate the is a SQLConnection; otherwise, false. + + Nested mail merge for a region works when the group start and end is BeginGroup and EndGroup respectively. + Nested mail merge for a table works when the group start and end is TableStart and TableEnd respectively. + The commands list to retrieve the DataTable from the data source must be in the same order of Group which is preserved in the input WordDocument. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + + + Performs the nested mail merge operation for a specified region using DataSet as data source. + + The DataSet contains data for mail merge. + The array of commands contains the queries to get the data from dataset. + + Nested mail merge for a region works when the group start and end is BeginGroup and EndGroup respectively. + Nested mail merge for a table works when the group start and end is TableStart and TableEnd respectively. + The commands list to retrieve the DataTable from the data source must be in the same order of Group which is preserved in the input WordDocument. + This method is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamarin platforms. + + + + + Performs the nested mail merge operation for a specified region using the MailMergeDataTable as data source. + + The MailMergeDataTable contains the data source for performing mail merge operation. + + + + Performs the nested mail merge operation for a specified region using the MailMergeDataSet as data source. + + The MailMergeDataSet contains the data source for performing mail merge operation. + Commands list + + + + Returns a collection of merge field names found in the document. + + The string array which contains the name of all the merge fields name in the document. + + + + Gets a collections of merge field names in the specified group. + + A String that represents the name of the group. + The string array which contains the name of all the merge fields name in the specified group. + + + + Gets a collections of the merge field group names in the document. + + The string array which contains the name of all the merge fields group names in the document. + + + + Gets the merge field names. + + The fields array. + Name of the group. + + + + Closes this instance. + + + + + Called when group found by GroupSelector. + + + + + Check the count of the matching records + + Rows + + + + + Remove items between Empty Group + + The group selector + + + + Remove items between Empty group present in Text body. + + The group selector + + + + Removes items present between empty group present in Table. + + The group selector + + + + Removes GoBack bookmark from selected group + + + + + + Removes items present in Group after Table Start field + + The group selector + Table + Start index + Start para index + Start cell index + End cell index + Start row index + End row index + + + + Removes Items present in group at table end + + The group selector + Table + End index + End para index + Start cell index + End cell index + Start row index + End row index + + + + Remove items between empty group present in table cell. + + The group selector + + + + Removes items from start index to end index. + + Entity + Start index + End index + + + + Called when body group found. + + The rows enum. + + + + Insert page break to start next record of group in new page + + + + + + Removes the bookmark from the TextbodyPart + + + + + + Delete bookmarks + + + + + + Called when row group found. + + The rows enum. + + + + + + + + + + + + + + + + + Executes the group for selection. + + The text body. + The item start. + The item end. + The p item start. + The p item end. + The rows enum. + + + + Checks wheather the Group end need to remove or not when the BeforeClearGroup event is triggered. + + + True, When Group start is not present in the collection,then remove the Group end + False, When Group start is present in the collection, then no need to remove the group end + + + + Updates the FieldEnd index of EndGroup + + + + + + + + + Get Table object if the given entity is available within the table + + + + + + + Executes the group for row selection. + + The table. + Start index of the row. + The count. + The rows enum. + The number of rows that took part in mail merge + + + + Executes the nested group. + + Name of the table. + + + + Gets the enumerator for nested mail merge. + + Name of the table. + + + + + Updates the enum. + + Name of the table. + The rows enum. + + + + Gets the data table. + + Name of the table. + The commands. + + + + + Gets the data table. + + Name of the table. + The commands. + + + + + Gets the command. + + Name of the table. + The commands. + + + + + Updates the variable part of the command. + + The command. + + + + + Checks the table nested groups. + + The start row. + The end row. + The table. + + + + Finds the table groups. + + The start row. + The end row. + The table. + The founded nested group name. + + + + Gets the data table using connent. + + Name of the table. + + + + + Gets the data table using data set. + + Name of the table. + + + + + Sends MergeField event. + + + The field. + The value. + The rows enum. + + + + + + + + + + Triggers the before clear field event + + + + + + + + send arugments to BeforeClearGroup event + + + + + + + + Gets the owner group of the current unmerged field + + Table name of the Current RowEnumerator + + + + + + + + + + + Check the next matching record + + Rows enumerator + A boolean value indicating the next matching record + + + + + + + + + + + Executes for text body. + + The body items. + The rows enum. + + + + Executes for text body item. + + The body items. + The rows enum. + + + + Executes for paragraph. + + The paragraph. + The rows enum. + + + + Checks whether all the paragraphs in the table cell has RemoveEmpty property. + + + + + + + Executes for paragraph items. + + The paragraph. + The rows enum. + The Paragraph item. + The indicate whether the paragraph item collection changed or not. + + + + Executes for table. + + The table. + The rows enum. + + + + Converts to text. + + The field. + The text. + + + + Updates the field value. + + The field. + The rows enum. + + + + Trigger the Befor clear field event + + + + + + + + + Updates the merge field result as text range. + + The merge field. + The value. + The rows enum. + Index of the value. + + + + Ensures double quotes for result text when merge field is nested within an IF field. + + IF field + Megre field + true if previous items has double quote, else false. + + + + Checks double quotes count within specified range of the paragraph. + + Paragraph + Start index + End index + Double quotes count + + + + Check whether the field owner paragraph is detached from document. + + + + + + + Removes the field from its owner paragraph + + The field. + + + + Insert text range in the place of merge field with result value + + The merge field. + + + + Gets the field value. + + The field. + The rows enum. + + + + + Gets the field value. + + Name of the field. + The rows enum. + + + + + Updates if field value. + + The field. + The rows enum. + + + + + + + + + + + + Updates the merged picture. + + The field. + The paragraph. + The instance containing the event data. + + + + + + + + + + Copies all document sections to clipboard. + + + + + + Appends copied sections to end of document. + + + + + + Gets the bitmap. + + The data. + + + + + Gets the field names for paragraph. + + The fields array. + The paragraph. + Name of the group. + + + + Gets the field names from paragraph item. + + The fields array. + Paragraph item + Name of the group. + + + + Iterate StructureDocumentTagBlock items to get the fields name. + + The fields array. + StructureDocumentTagBlocklockContent + Name of the group. + + + + Determines whether [is start prefix] [the specified field]. + + The field. + + true if it specifies a begining of the group field, set to true. + + + + + Determines whether [is end group] [the specified field]. + + The field. + + If it is a end of the group, set to true. + + + + + Checks the selection. + + The rows enum. + + + + + Hides the fields. + + The sections. + + + + Hides the fields. + + The row. + + + + Removes the empty merge fields in body items. + + The selection. + + + + Hides the fields. + + The body items. + + + + Hides the fields. + + The paragraph. + + + + Hides the field. + + The field. + + + + Gets the name of the mapped column name. + + Name of the merge field. + + + + + Removes the spell checking. + + + + + Gets or sets a value indicating whether to remove empty mail merge fields from a document. The default is true. + + Set true to remove empty mail merge fields from a document; otherwise, false. + + + + Gets or sets a value that indicates whether to start a new page for each group of records. The default value is false. + + + Set True to start a new page for each group of records during mail merge execution; otherwise, false. + + This property is valid for group mail merge and also that the corresponding group start and group end should be present in the text body of the Word document. + This property is not valid when the group start, and group end are present in the table, headers and footers. + + + + //Load the template Word document. + WordDocument document = new WordDocument("Template.docx"); + //Data source. + DataSet ds = new DataSet(); + ds.Tables.Add(); + //Define the columns + ds.Tables[0].TableName = "Employee"; + ds.Tables[0].Columns.Add("NAME"); + ds.Tables[0].Columns.Add("DESC"); + //Set the values. + DataRow row; + row = ds.Tables["Employee"].NewRow(); + row["NAME"] = "AAA"; + row["DESC"] = null; + ds.Tables["Employee"].Rows.Add(row); + row = ds.Tables["Employee"].NewRow(); + row["NAME"] = "BBB"; + row["DESC"] = ""; + ds.Tables["Employee"].Rows.Add(row); + row = ds.Tables["Employee"].NewRow(); + row["NAME"] = "CCC"; + row["DESC"] = "ccc"; + ds.Tables["Employee"].Rows.Add(row); + //Enable a flag to start a new page for each group of records. + document.MailMerge.StartAtNewPage= true; + //Execute mail merge. + document.MailMerge.ExecuteGroup(ds.Tables["Employee"]); + //Save the Word document. + document.Save("Result.docx", FormatType.Docx); + //Close the Word document. + document.Close(); + + + 'Load the template Word document. + Dim document As WordDocument = New WordDocument("Template.docx") + 'Data source. + Dim ds As DataSet = New DataSet + ds.Tables.Add + 'Define the columns. + ds.Tables(0).TableName = "Employee" + ds.Tables(0).Columns.Add("NAME") + ds.Tables(0).Columns.Add("DESC") + 'Set values. + Dim row As DataRow + row = ds.Tables("Employee").NewRow + row("NAME") = "AAA" + row("DESC") = Nothing + ds.Tables("Employee").Rows.Add(row) + row = ds.Tables("Employee").NewRow + row("NAME") = "BBB" + row("DESC") = "" + ds.Tables("Employee").Rows.Add(row) + row = ds.Tables("Employee").NewRow + row("NAME") = "CCC" + row("DESC") = "ccc" + ds.Tables("Employee").Rows.Add(row) + 'Enable a flag to start a new page for each group of records. + document.MailMerge.StartAtNewPage= true + 'Execute mail merge. + document.MailMerge.ExecuteGroup(ds.Tables("Employee")) + 'Save the Word document. + document.Save("Result.docx", FormatType.Docx) + 'Close the Word document. + document.Close + + + + + + Gets the document. + + + The document. + + + + Gets or sets a value indicating whether to remove paragraphs which contain empty merge fields. + + + Set to True to remove empty paragraphs; otherwise, false. + + + + + Gets or sets a value indicating whether to remove groups which contain empty merge fields. + + + Set to True to remove empty groups; otherwise, false. + + + + + Gets or sets a value indicating whether to insert a new row for every group in a table while performing mail merge. + Default value is false. + + + Set True to insert a new row for every group in a table; otherwise, false. + + This property is valid only if the group start and group end fields present in the table row with single cell. (i.e., rows containing single cell) + + + //Opens the template document. + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Set "InsertAsNew" as true to insert a new row for every group when group start and end present in the same table cell. + document.MailMerge.InsertAsNewRow = true; + //Performs the mail merge. + document.MailMerge.ExecuteGroup(DataTable); + //Saves and closes the WordDocument instance. + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Opens the template document. + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Set "InsertAsNew" as true to insert a new row for every group when group start and end present in the same table cell. + document.MailMerge.InsertAsNewRow = True + 'Performs the mail merge. + document.MailMerge.ExecuteGroup(DataTable) + 'Saves and closes the WordDocument instance. + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets the enumerators which are used during mailmerge. + + The nested enums. + + + + Gets the current data set for nested mail merge. + + The current data set. + + + + Gets the variable command regulat expression. + + The variable command regex. + + + + Gets the group selectors. + + The group selectors. + + + + Gets the collection of mapped fields. + + The mapped fields represent mapping between + fields names in the data source and mail merge fields in the document. The keys of + the collection are merge field names and the values are field names in the data source. + + + + + + + + + Gets the previous state of the clear fields. + + The previous state of the clear fields. + + + + Gets the MailMerge settings + + + The following code example demonstrates change the datasource path in the mail merge setting in the document. + + //Load an existing Word document into WordDocument instance. + WordDocument document = new WordDocument("Sample.docx", FormatType.Docx); + //Change the datasource property of the mail merge settings in the word document. + document.MailMerge.Settings.DataSource = "NewDataSource.txt"; + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + + + 'Load an existing Word document into WordDocument instance + Dim document As New WordDocument("Sample.docx", FormatType.Docx) + 'Change the datasource property of the mail merge settings in the word document + document.MailMerge.Settings.DataSource = "NewDataSource.txt" + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + + + + + + Occurs during mail merge when a text merge field is encountered in the document. + + + + + Occurs during mail merge when an image merge field is encountered in the document. + + + + + Occurs during mail merge when an unmerged field is encountered in the document. + + + + + Occurs during mail merge when an unmerged group is encountered in the document. + + + + + + + + + + The internal fields. + + + + + Initializes a new instance of the class. + + The on group found. + + + + Initialize the process. + + + + + Processes the groups. + + The body. + The rows enum. + + + + Processes the groups. + + The table. + The start row. + The end row. + The rows enumerator. + + + + Finds inside body items. + + The body items. + + + + Finds the group in the table. + + The table. + The start row. + The end row. + + + + Clears the selection. + + + + + Checks the item. + + The item. + + + + Starts the selection. + + + + + Check whether each data should populate to new row or not. + + Merge field owner textbody + + + + + Check whether current row contains single table cell. + + Owner table cell of merge field. + Owner table row of the merge field. + + + + + Ends the selection. + + + + + Updates end of row selection in case cell has vertical merge. + + The cell. + + + + Gets or sets a value indicating whether to insert a new row for every group in a table while performing mail merge. + Default value is false. + + + Set True to insert a new row for every group in a table; otherwise, false. + + This property is valid only if the group start and group end fields present in the table row with single cell. (i.e., rows containing single cell) + + + + Gets the group selection. + + The group selection. + + + + Gets the row selection. + + The row selection. + + + + Gets the begin group field. + + The begin group field. + + + + Gets or sets the end group field. + + The end group field. + + + + Gets or sets the index of the body item. + + The index of the body item. + + + + Gets a value indicating whether group is found. + + + If group is found, set to true. + + + + + Gets the name of the group. + + The name of the group. + + + + + + + + + Gets the Name of Fields which is inside the group - Read-only + + + + + + + + + + + Represents a row selection. + + + + + Initializes a new instance of the class. + + The table. + Start index of the row. + End index of the row. + + + + Validates the indexes. + + + + + Represents the method that handles MergeField event + + + + + Represents the method that handles MergeImageField event + + + + + Represents the method that handles BeforeClearField event + + + + + Represents the method that handles BeforeClearGroupField Event + + + + + + Represents the document. + + + + + Represents the current merge field. + + + + + Represents the Group name. + + + + + Represents the field value. + + + + + Represents the current Row index. + + + + + Represents the clear Field. + + + + + Represnts the row enumerator + + + + + Initialize the new instance of class for the specified document + with table name, row index, field and its value. + + IWordDcoument instance + The groupName of table + The row index of the table + The current Merge Field + The current Row enumerator + The current Field value + + + + Gets the document instance - read only + + + + + Gets the merge field Name. Read-only. + + The string that specifies the merge field name. + + + + Gets or sets the merge field value. + + An that specifies the field value. + + + + Gets the owner group name of the merge field. + + + + + Gets a Boolean value whether the merge field has mapped field in data source or not. + + True, if the merge field has mapped field in data source. Otherwise false. + + + + Gets the row index. Read-only. + + The integer that specifies the row index. + + + + Gets or sets a Boolean value whether the unmerged merge field can be clear or not. + + True, Remove the unmerged fields, otherwise False + + + + Gets the current merge field. Read-only. + + + + + Represents the MergeField event that occurs during mail merge operation. + + + + + Represents the document. + + + + + Represents the Merge field. + + + + + Represents the Field Value + + + + + Represents the Row Index. + + + + + Represents the Table Name + + + + + Represents the group name + + + + + Represents the Text Range + + + + + Initializes a new instance of class for the specified document + with table name, row index, field and its value. + + The instance. + The name of the table to perform merge. + The row index in the table. + The instance. + An that specifies field value. + + + + Initializes a new instance of class for the specified document + with table name, row index, field and its value. + + The instance. + The name of the table to perform merge. + The row index in the table. + The instance. + An that specifies field value. + The owner group name of the merge field + + + + Gets the document instance. Read-only. + + The object. + + + + Gets the merge field Name. Read-only. + + The string that specifies the merge field name. + + + + Gets the merge field value. Read-only. + + An that specifies the field value. + + + + Gets the table name. Read-only. + + The string that specifies the table name. + + + + Gets the owner group name of the merge field. + + + + + Gets the row index. Read-only. + + The integer that specifies the row index. + + + + Gets the character format of the field. Read-only. + + The instance that specifies the character format. + + + + Gets or sets the field value. + + The string that specifies the field value. + + + + Gets the current merge field. Read-only. + + The current instance. + + + + Gets the TextRange. Read-only + + + + + Represents the MergeImageField event that occurs during Mail merge. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents the Picture. + + + + + Initializes a new instance of class for the specified Word document with + table name, row index, field instance and the image. + + The instance. + The name of the table to perform merge. + The row index in the table. + The instance. + The instance. + + + + Initializes a new instance of class for the specified Word document with + table name, row index, field instance and the image. + + The instance. + The name of the table to perform merge. + The row index in the table. + The instance. + An that specifies image. + + + + + + + + + + + + + + + + Gets a value indicating whether to use text. Read-only. + + True if to use the text; otherwise, false. + + + + Gets or sets the image file name. + + The string that specifies the image file name. + + + + Gets or sets the image stream. + + The that represents the image stream. + + + + Gets or sets the image. + + that specifies the image. + + + + Gets or sets a value indicating whether this is skip. + + True if skip; otherwise, false. + + + + Gets the Current Picture. Read-only + + + + + + Represents the document. + + + + + Represents the current merge field. + + + + + Represents the Group name. + + + + + Represents the clear Field. + + + + + Represnts the Field Has Mapped In DataSource + + + + + Represents the Fields Name + + + + + Represents the Alternate value for unmerged fields + + + + + Initialize the new instance of class for the specified document + with table name, row index, field and its value. + + IWordDcoument instance + The groupName of table + The current Merge Field + Is field mapped in Data source + The Current Field Vlue + + + + Gets the document instance - read only + + + + + Gets the owner group name of the merge field - read only. + + + + + Gets a Boolean value whether the merge field has mapped field in data source or not. + + True, if the merge field has mapped field in data source. Otherwise false. + + + + Gets or sets a Boolean value whether the unmerged groups can be clear or not. + + True, Remove the unmerged fields, otherwise False + + + + Gets the Fields Name inside the unmerged group + + + + + Performs the mail merge operation for a specified region using the IEnumerable as data source. + + + + + Represents the entries of entity class. + + + + + Specifies the current entity. + + + + + Specifies the index value. + + + + + Initializes a new instance of class with the specified entity. + + The object. + + + + Fetches the entries element. + + True if contains entry; otherwise, false. + + + + Represents the data sets to perform mail merge operation. + + + + + Create new instance of . + + + + + Appends a new mail merge data set object to collection. + + MailMergeDataTable + + + + Removes all the mail merge dataset objects from the collection. + + + + + Gets MailMergeDataTable with necessary table name + + MailMergeDataTable + Name of table + + + + + Remove MailMergeDataTable with necessary table name + + Name of table + + + + Gets list of data set objects. Read-only. + + + + + Represents the data tables to perform mail merge operation. + + + + + + + + + + + + + + + Create new instance of class. + + A string that represents the group Name. + A collection of source data used as data source for mail merge operation. + + + + Create new instance of object + + Group Name + Sourse data Dictionary + + + + + + Commands of formulation of new tablet + Return new instance of MailMergeDataTable from the chosen rows of current MailMergeDataTable + + + + Gets a group name. Read-only. + + + + + Gets a source data. Read-only. + + A collection of data used as data source for mail merge operation. + + + + Represents the mail merge exception. + + + + + Default exception message. + + + + + Default constructor. + + + + + Initializes a new instance of the class with specified exception. + + The inner exception. + + + + Initializes a new instance of the class with specified exception message. + + A String that represents exception message. + + + + Initializes a new instance of the class with specified exception and message. + + A String that represents exception message. + The inner exception. + + + + Represents the mail merge settings + + + + + Checks whether the Key present in the collection or not. + + + + + + + Sets the property key + + + + + Disposes the instances used. + + + + + Removes the mail merge settings. + + + Removes the mail merge settings, to convert a Word mail merge main document to a normal Word document. + Hence the Microsoft Word application won't prompt to mail merge while opening this document. + + + The following code example demonstrates removes the mail merge setting in the document. + + //Load an existing Word document into WordDocument instance. + WordDocument document = new WordDocument("Sample.docx", FormatType.Docx); + //Removes the mail merge settings in the word document. + if (document.MailMerge.Settings.HasData) + document.MailMerge.Settings.RemoveData(); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + + + 'Load an existing Word document into WordDocument instance + Dim document As New WordDocument("Sample.docx", FormatType.Docx) + 'Removes the mail merge settings in the word document. + If document.MailMerge.Settings.HasData Then + document.MailMerge.Settings.RemoveData() + End If + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + + + + + + Gets or Sets the record currently displayed in merged document. + + + + + Gets or Sets the column containing E-mail address. + + + + + Gets or Sets mail merge error reporting setting. + + + + + Gets or sets the data source connection string. + + + + + Gets or sets the data source file path. + + + The following code example demonstrates change the datasource path in the mail merge setting in the document. + + //Load an existing Word document into WordDocument instance. + WordDocument document = new WordDocument("Sample.docx", FormatType.Docx); + //Change the datasource property of the mail merge settings in the word document. + document.MailMerge.Settings.DataSource = "NewDataSource.txt"; + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + + + 'Load an existing Word document into WordDocument instance + Dim document As New WordDocument("Sample.docx", FormatType.Docx) + 'Change the datasource property of the mail merge settings in the word document + document.MailMerge.Settings.DataSource = "NewDataSource.txt" + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + + + + + + Gets or sets the data source type. + + + + + Gets or sets the merged document destination. + + + + + Gets or sets the remove blank lines from merged documents. + + + + + Gets or sets the header definition file path. + + + + + Gets or sets the query contains link to external query file. + + + + + Gets or sets the merged document to E-Mail attachment. + + + + + Gets or sets the merged E-mail or Fax subject line. + + + + + Gets or sets the source document type. + + + + + Gets or sets the query for data source records to merge. + + + + + Gets or sets the view merged data within document. + + + + + Gets or sets the office data source object settings. + + + + + Gets or sets the properties collection + + + + + Gets a value indicating whether the document has mail merge settings or not. + + True, if the document has mail merge settings. Otherwise false. + + The following code example demonstrates whether the document has mail merge settings or not. + + //Load an existing Word document into WordDocument instance. + WordDocument document = new WordDocument("Sample.docx", FormatType.Docx); + //Removes the mail merge settings in the word document. + if (document.MailMerge.Settings.HasData) + document.MailMerge.Settings.RemoveData(); + //Saves the specified document + document.Save("Sample.docx", FormatType.Docx); + //Close the WordDocument instance + document.Close(); + + + 'Load an existing Word document into WordDocument instance + Dim document As New WordDocument("Sample.docx", FormatType.Docx) + 'Removes the mail merge settings in the word document. + If document.MailMerge.Settings.HasData Then + document.MailMerge.Settings.RemoveData() + End If + 'Saves the specified document + document.Save("Sample.docx", FormatType.Docx) + 'Close the WordDocument instance + document.Close() + + + + + + Represents a revision (tracked change) in a Word document. + + + + + Accepts the specified tracked change. The revision marks are removed, and the changes are incorporated into the document. + + + + //Load an existing Word document into DocIO instance. + WordDocument document = new WordDocument("Template.docx"); + //Get the revision from the revision collection and accepts. + document.Revisions[0].Accept(); + //Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Load an existing Word document into DocIO instance. + Dim document As WordDocument = New WordDocument("Template.docx") + 'Get the revision from the revision collection and accepts. + document.Revisions(0).Accept() + 'Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Clear the dependent moving revision + + + + + + + Gets the revision by given name. + + + + + Remove the revision from the entity and remove the entity from the revision + If the revision has child revision, add the items in the main revision + + Entity to be removed from the revision + The revision to be removed from the entity and the document + + + + If we accept the delete revision or reject the insert revision, remove this item from all the + corresponding revisions. + + + + + + + + If we accept the delete revision or reject the insert revision, remove this item from all the + corresponding revisions. + + + + + + + + Accepts or rejects changes tracked from the moment of last change acceptance. + + The paragraph item. + if it accepts changes, set to true. + + + + Make changes for the format. + + + + + + + Make changes for the section format. + + + + + + + Make changes in properties hash. + + + + + + + Make changes for character format. + + + + + + + Make changes for the break character format. + + + + + + + Make changes for paragraph format. + + + + + + + Make changes for the table. + + + + + + + Make changes for the particular row. + + + + + + + Make changes for the table cell. + + + + + + + Removes the changed item. + + The item. + if it accepts the changes, set to true. + + + + + Checks whether the paragraph item need to remove while accept or reject changes + + Current Revision + boolean to ensure accept or reject changes + + + + + Move currentSection items to nextSection. + + Current Section + + + + Checks the whether item's content has to be moved to next paragraph. + + The item. + if it is accept the changes, set to true . + + + + + Moves item's content to the next paragraph. + + The item. + + + + Removes the changed formatting. + + The item. + + + + Remove the revision from the formatBase and remove the formatBase from the revision + If the revision has child revision, add the items in the main revision + + FormatBase to be removed from the revision + The revision to be removed from the formatBase and the document + + + + Moved the child revisions to document collection and process + the dependent moving related revisions. + + + + + + + + Rejects the specified tracked change. The revision marks are removed, leaving the original text intact. + + + + //Load an existing Word document into DocIO instance. + WordDocument document = new WordDocument("Template.docx"); + //Get the revision from the revision collection and rejects. + document.Revisions[0].Reject(); + //Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Load an existing Word document into DocIO instance. + Dim document As WordDocument = New WordDocument("Template.docx") + 'Get the revision from the revision collection and rejects. + document.Revisions(0).Reject() + 'Save and Close the Word document. + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Removes the revision from the owner collection. + + + + + Clone the revision + + The cloned revision + + + + Initializes a new instance of the class with the + specified . + + The instance. + + + + Clears the object. + + + + + Gets the name of the user who made the specified tracked change. + + + + //Loads an existing Word document + WordDocument document = new WordDocument(@"Template.docx"); + //If the author of current revision is same as expected author name, then accept it + if (document.Revisions[0].Author == "Syncfusion") + document.Revisions[0].Accept(); + //Saves and closes the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Loads an existing Word document + Dim document As WordDocument = New WordDocument("Template.docx") + 'If the author of current revision is same as expected author name, then accept it + If document.Revisions(0).Author Is "Syncfusion" Then worddocument.Revisions(0).Accept() + 'Saves and closes the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets the date and time that the tracked change was made. + + + + //Loads an existing Word document + WordDocument document = new WordDocument(@"Template.docx"); + DateTime dateTime = DateTime.Parse("2020 - 05 - 28T20: 26:00"); + //If the date of current revision same as expected date, then accepts it + if (document.Revisions[0].Date == dateTime) + document.Revisions[0].Accept(); + //Saves and closes the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Loads an existing Word document + Dim document As WordDocument = New WordDocument("Template.docx") + Dim dateTime As Date = Date.Parse("2020 - 05 - 28T20: 26:00") + 'If the date of current revision same as expected date, then accepts it + If document.Revisions(0).[Date] Is dateTime Then wordDocument.Revisions(0).Accept() + 'Saves and closes the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets the range of the specified revision. + + This property will work for any revision type other than IsStyleDefinition. + + + + Gets the type of the track change revision. + + + + //Loads an existing Word document + WordDocument document = new WordDocument("Template.docx"); + //If the revision is insertion type of revision, then accept it + if (document.Revisions[0].RevisionType == RevisionType.Insertions) + document.Revisions[0].Accept(); + //Saves and closes the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + 'Loads an existing Word document + Dim document As WordDocument = New WordDocument("C:\Users\TamilselvanMuralisun\Desktop\style formatting.docx") + 'If the revision is insertion type of revision, then accept it + If document.Revisions(0).RevisionType Is RevisionType.Insertions Then word.Revisions(0).Accept() + 'Saves and closes the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Gets the name values of moveto or movefrom revisions types, for remaining tags it holds string.Empty value. + + + + + Gets the child revision which are not directly linked with main revision. + + + + + Gets the owner of the revision. + + The that specifies the owner. + + + + Get/Set if the moverange end is preserved after the Paragraph mark + + + + + Get/Set if the moverange end is preserved after the TableCell mark + + + + + Get/Set if the moverange end is preserved after the TableRow mark + + + + + Get/Set if the moverange end is preserved after the Table mark + + + + + Represents a block content control in the Word document. + + + + + Initializes a new instance of the class. + + The Word document. + By default, .RichText content control will be created + The following example illustrates how to initializes a new instance of the . + + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + BlockContentControl control = new BlockContentControl(document); + //Adds new paragraph to the section. + WParagraph paragraph = new WParagraph(control.Document); + //Adds new text to the content control. + paragraph.AppendText("Block content control"); + //Adds pagagraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph); + //Sets title of the block content control. + control.ContentControlProperties.Title = "Rich text content control"; + //Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + Dim control As New BlockContentControl(document) + 'Adds new paragraph to the section. + Dim paragraph As New WParagraph(control.Document) + 'Adds new text to the content control. + paragraph.AppendText("Block content control") + 'Adds paragraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph) + 'Sets title of the block content control. + control.ContentControlProperties.Title = "Rich text content control" + 'Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Initializes a new instance of the class. + + The Word document. + The content control type. + + + + Adds the self. + + + + + Creates a duplicate of the entity. + + + + + + Clones the relations. + + The doc. + + + + + Gets Next the text body item in the document. + + + + + + Determines whether is hidden paragraph mark is in last item of SDT content. + + The SDT blog. + The layoutinfo. + + + + + Determines whether the deletion revision paragraph mark is in last item of SDT content. + + The SDT blog. + The layoutinfo. + + + + + Check whether Block Content Control has paragraph or not + + Return true if Block Content Control has paragraph; otherwise false + + + + Gets the first paragraph of the SDTBlockContent. + + + + + + Gets the Last paragraph of the SDTBlockContent. + + + + + + Checks a value indicating whether this item was deleted from the document, + when "Track Changes" is or was set to "true". + + + + if this instance is delete revision, set to true. + + + + + Sets the changed Paragraph format for table. + + if it specifies the format to be changed, set to true. + + + + Sets the changed C format. + + if it specifies formatting, set to true. + + + + Sets the delete rev. + + if specifies delete revision, set to true. + + + + Sets the insert rev. + + if it specifies insert revision, set to true. + + + + Determines whether item has tracked changes. + + + if has tracked changes, set to true. + + + + + Replaces all entries of given regular expression with replace string. + + The used to find the text. + The string specifies the text to replace. + The integer that represents the count of the replacements made. + The following example illustrates how to replace the text based on the given regex pattern. + + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + BlockContentControl control = new BlockContentControl(document, ContentControlType.RichText); + //Adds new paragraph to the section. + WParagraph paragraph = new WParagraph(control.Document); + //Adds new text to the content control. + paragraph.AppendText(@"the security requirements are met, the CLR performs just in time (JIT) compilation to convert the IL code to native machine instructions."); + //Adds pagagraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph); + //Find the text based on regex. + TextSelection text = control.Find(new Regex("instructions")); + //Replaces all entries of given string with replace string. + control.Replace(new Regex(@"requirements"), text); + //Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + Dim control As New BlockContentControl(document, ContentControlType.RichText) + 'Adds new paragraph to the section. + Dim paragraph As New WParagraph(control.Document) + 'Adds new text to the content control. + paragraph.AppendText("the security requirements are met, the CLR performs just in time (JIT) compilation to convert the IL code to native machine instructions.") + 'Adds pagagraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph) + 'Find the text based on regex. + Dim text As TextSelection = control.Find(New Regex("instructions")) + 'Replaces all entries of given string with replace string. + control.Replace(New Regex("requirements"), text) + 'Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + + Replaces the regular expression with a text selection. + + The used to find the text. + The which specifies the text to replace. + The integer that represents the count of the replacements made. + The following example illustrates how to replace the text based on the given regex pattern. + + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + BlockContentControl control = new BlockContentControl(document, ContentControlType.RichText); + //Adds new paragraph to the section. + WParagraph paragraph = new WParagraph(control.Document); + //Adds new text to the content control. + paragraph.AppendText(@"the security requirements are met, the CLR performs just in time (JIT) compilation to convert the IL code to native machine instructions."); + //Adds pagagraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph); + //Find the text based on regex. + TextSelection text = control.Find(new Regex("instructions")); + //Replaces all entries of given string with replace string. + control.Replace(new Regex(@"requirements"), text); + //Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + Dim control As New BlockContentControl(document, ContentControlType.RichText) + 'Adds new paragraph to the section. + Dim paragraph As New WParagraph(control.Document) + 'Adds new text to the content control. + paragraph.AppendText("the security requirements are met, the CLR performs just in time (JIT) compilation to convert the IL code to native machine instructions.") + 'Adds pagagraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph) + 'Find the text based on regex. + Dim text As TextSelection = control.Find(New Regex("instructions")) + 'Replaces all entries of given string with replace string. + control.Replace(New Regex("requirements"), text) + 'Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Replaces all entries of given regular expression with TextRangesHolder. + + The pattern. + The text selection. + if it specifies save source formatting, set to true. + + The following example illustrates how to replace all entries of given regular expression with TextRangesHolder. + + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + BlockContentControl control = new BlockContentControl(document, ContentControlType.RichText); + //Adds new paragraph to the section. + WParagraph paragraph = new WParagraph(control.Document); + //Adds new text to the content control. + paragraph.AppendText(@"the security requirements are met, the CLR performs just in time (JIT) compilation to convert the IL code to native machine instructions."); + //Adds pagagraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph); + //Find the text based on regex. + TextSelection text = control.Find(new Regex("instructions")); + //Replaces all entries of given string with replace string. + control.Replace(new Regex(@"requirements"), text, true); + //Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + Dim control As New BlockContentControl(document, ContentControlType.RichText) + 'Adds new paragraph to the section. + Dim paragraph As New WParagraph(control.Document) + 'Adds new text to the content control. + paragraph.AppendText("the security requirements are met, the CLR performs just in time (JIT) compilation to convert the IL code to native machine instructions.") + 'Adds pagagraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph) + 'Find the text based on regex. + Dim text As TextSelection = control.Find(New Regex("instructions")) + 'Replaces all entries of given string with replace string. + control.Replace(New Regex("requirements"), text, true) + 'Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + + Replaces all entries of given string with TextRangesHolder, taking into + consideration caseSensitive and wholeWord options. + + The given. + The text selection. + if it specifies case sensitive, set to true . + if it specifies to search a whole word, set to true . + if it specifies save source formatting, set to true. + The integer that represents the count of the replacements made. + The following example illustrates how to replaces all entries of given string with TextRangesHolder, + taking into consideration caseSensitive and wholeWord options. + + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + BlockContentControl control = new BlockContentControl(document, ContentControlType.RichText); + //Adds new paragraph to the section. + WParagraph paragraph = new WParagraph(control.Document); + //Adds new text to the content control. + paragraph.AppendText(@"the security requirements are met, the CLR performs just in time (JIT) compilation to convert the IL code to native machine instructions."); + //Adds pagagraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph); + //Find the text based on regex. + TextSelection text = control.Find(new Regex("instructions")); + //Replaces all entries of given string with replace string. + control.Replace("requirements", text, false, true, true); + //Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + Dim control As New BlockContentControl(document, ContentControlType.RichText) + 'Adds new paragraph to the section. + Dim paragraph As New WParagraph(control.Document) + 'Adds new text to the content control. + paragraph.AppendText("the security requirements are met, the CLR performs just in time (JIT) compilation to convert the IL code to native machine instructions.") + 'Adds pagagraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph) + 'Find the text based on regex. + Dim text As TextSelection = control.Find(New Regex("instructions")) + 'Replaces all entries of given string with replace string. + control.Replace(New Regex("requirements"), text, false, true, true) + 'Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Replaces first entry of given string with replace string, taking into + consideration caseSensitive and wholeWord options. + + The string to replace + Replace string + Is case sensitive replace? + Search for whole word? + + + + + Replaces all entries of given regular expression with replace string. + + + + + + + Creates the layout information. + + + + + + Removes the character format changes. + + + + + Removes the paragraph/table format changes. + + + + + Accepts the changes for character format. + + + + + Accepts changes in paragraph/table format. + + + + + Defines whether format was changed. + + + + + + Checks a value indicating whether this item was inserted to the document, + when "Track Changes" is or was set to "true". + + + + if this instance was inserted, set to true. + + + + + Gets the first entry of given regex in the content control. + + The pattern. + Text selection with this pattern. + The following example illustrates how to find the text based on given regex pattern. + + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + BlockContentControl control = new BlockContentControl(document, ContentControlType.RichText); + //Adds new paragraph to the section. + WParagraph paragraph = new WParagraph(control.Document); + //Adds new text to the content control. + paragraph.AppendText(@"the security requirements are met, the CLR performs just in time (JIT) compilation to convert the IL code to native machine instructions."); + //Adds pagagraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph); + //Find the text based on regex. + TextSelection text = control.Find(new Regex("instructions")); + //Replaces all entries of given string with replace string. + control.Replace(new Regex(@"requirements"), text); + //Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + Dim control As New BlockContentControl(document, ContentControlType.RichText) + 'Adds new paragraph to the section. + Dim paragraph As New WParagraph(control.Document) + 'Adds new text to the content control. + paragraph.AppendText("the security requirements are met, the CLR performs just in time (JIT) compilation to convert the IL code to native machine instructions.") + 'Adds pagagraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph) + 'Find the text based on regex. + Dim text As TextSelection = control.Find(New Regex("instructions")) + 'Replaces all entries of given string with replace string. + control.Replace(New Regex("requirements"), text) + 'Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + + Accepts or rejects changes tracked from the moment of last change acceptance. + + if it accepts changes, set to true. + + + + Returns all entries of given regex. + + The pattern. + + + + + Closes the item. + + + + + Defines whether paragraph format is changed. + + + + + + Gets the string of the Block Content Control for word comparison + + + + + + Compare the block content control between original and revised document + + + + + + Compare block content control from original and revised textbody + + + + + + Compare the block content control + + + + + + + Apply delete revision for the whole block content control + + + + + Apply insert revision for the whole block content control + + + + + Gets or sets the mapped paragraph to the block content control + + + + + Gets the block control text body. Read-only. + + The following example illustrates how to get the text body of the content control. + + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + BlockContentControl control = new BlockContentControl(document, ContentControlType.RichText); + //Adds new paragraph to the section. + WParagraph paragraph = new WParagraph(control.Document); + //Adds new text to the content control. + paragraph.AppendText("Block content control"); + //Adds pagagraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph); + //Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + Dim control As New BlockContentControl(document, ContentControlType.RichText) + 'Adds new paragraph to the section. + Dim paragraph As New WParagraph(control.Document) + 'Adds new text to the content control. + paragraph.AppendText("Block content control") + 'Adds pagagraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph) + 'Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Gets the content control properties. Read-only. + + The object that specifies the content control properties. + The following example illustrates how to set the properties for content control. + + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + BlockContentControl control = new BlockContentControl(document, ContentControlType.RichText); + //Adds new paragraph to the section. + WParagraph paragraph = new WParagraph(control.Document); + //Adds new text to the content control. + paragraph.AppendText("Block content control"); + //Adds pagagraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph); + //Sets title of the block content control. + control.ContentControlProperties.Title = "Rich text content control"; + //Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + Dim control As New BlockContentControl(document, ContentControlType.RichText) + 'Adds new paragraph to the section. + Dim paragraph As New WParagraph(control.Document) + 'Adds new text to the content control. + paragraph.AppendText("Block content control") + 'Adds paragraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph) + 'Sets title of the block content control. + control.ContentControlProperties.Title = "Rich text content control" + 'Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Gets the content control child entities. + + The child entities of the + The following example illustrates how to get the child entities of the content control. + /// + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + BlockContentControl control = new BlockContentControl(document, ContentControlType.RichText); + //Adds new paragraph to the section. + WParagraph paragraph = new WParagraph(control.Document); + //Adds new text to the content control. + paragraph.AppendText("Block content control"); + //Adds pagagraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph); + //Sets title of the block content control. + control.ContentControlProperties.Title = "Rich text content control"; + //Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + Dim control As New BlockContentControl(document, ContentControlType.RichText) + 'Adds new paragraph to the section. + Dim paragraph As New WParagraph(control.Document) + 'Adds new text to the content control. + paragraph.AppendText("Block content control") + 'Adds paragraph into the Block content control. + control.TextBody.ChildEntities.Add(paragraph) + 'Sets title of the block content control. + control.ContentControlProperties.Title = "Rich text content control" + 'Adds content control into the document. + document.LastSection.Body.ChildEntities.Add(control) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Gets the last child in the Content control's textbody. + + + + + Gets the character format of the content control. Read-only. + + The object that specifies the character format. + + + + Gets the type of the entity. + + The of the current item. + + + + Get the string of the Block Content Control for word comparison + + + + + Gets count of child items. + + + + + Gets child item by index. + + + + + Gets the child items + + + + + Gets the child entity collection. + + + + + Represents a row content control in the Word document. + + + + + Initializes a new instance of . + + The Word document. + In Microsoft Word, .RichText only be inserted as a + The following example illustrates how to initializes a new instance of . + + WordDocument document = new WordDocument(); + //Adds new section to the document. + IWSection section = document.AddSection(); + //Adds new table to the section. + IWTable table = section.AddTable(); + //Adds new row to the table. + WTableRow tableRow = table.AddRow(); + //Adds new cell to the row. + WTableCell tableCell = tableRow.AddCell(); + tableCell.Width = 100; + //Adds new paragraph to the cell. + IWParagraph paragraph = tableCell.AddParagraph(); + //Adds new text to the paragraph. + paragraph.AppendText("Content Control"); + //Create the Row Content Control for the document. + RowContentControl control = new RowContentControl(document); + //Change the color value in Content Control properties. + control.ContentControlProperties.Color = System.Drawing.Color.Blue; + // Sets it to the row content control. + tableRow.ContentControl = control; + //Save the Word document. + document.Save("Sample.docx", FormatType.Docx); + //Close the document. + document.Close(); + + + Dim document As New WordDocument() + 'Adds new section to the document. + Dim section As IWSection = document.AddSection() + 'Adds new table to the section. + Dim table As IWTable = section.AddTable() + 'Adds new row to the table. + Dim tableRow As WTableRow = table.AddRow() + 'Adds new cell to the row. + Dim tableCell As WTableCell = tableRow.AddCell() + tableCell.Width = 100 + 'Adds new paragraph to the cell. + Dim paragraph As IWParagraph = tableCell.AddParagraph() + 'Adds new text to the paragraph. + paragraph.AppendText("Content Control") + 'Create the Row Content Control for the document. + Dim control As New RowContentControl(document) + 'Change the color value in Content Control properties. + control.ContentControlProperties.Color = System.Drawing.Color.Blue + ' Sets it to the row content control. + tableRow.ContentControl = control + 'Save the Word document. + document.Save("Sample.docx", FormatType.Docx) + 'Close the document. + document.Close() + + + + + + Closes this instance. + + + + + Gets the content control properties. Read-only. + + The object that specifies the content control properties. + The following example illustrates how to set the properties for content control. + + WordDocument document = new WordDocument(); + //Adds new section to the document. + IWSection section = document.AddSection(); + //Adds new table to the section. + IWTable table = section.AddTable(); + //Adds new row to the table. + WTableRow tableRow = table.AddRow(); + //Adds new cell to the row. + WTableCell tableCell = tableRow.AddCell(); + tableCell.Width = 100; + //Adds new paragraph to the cell. + IWParagraph paragraph = tableCell.AddParagraph(); + //Adds new text to the paragraph. + paragraph.AppendText("Content Control"); + //Create the Row Content Control for the document. + RowContentControl control = new RowContentControl(document); + //Change the color value in Content Control properties. + control.ContentControlProperties.Color = System.Drawing.Color.Blue; + // Sets it to the row content control. + tableRow.ContentControl = control; + //Save the Word document. + document.Save("Sample.docx", FormatType.Docx); + //Close the document. + document.Close(); + + + Dim document As New WordDocument() + 'Adds new section to the document. + Dim section As IWSection = document.AddSection() + 'Adds new table to the section. + Dim table As IWTable = section.AddTable() + 'Adds new row to the table. + Dim tableRow As WTableRow = table.AddRow() + 'Adds new cell to the row. + Dim tableCell As WTableCell = tableRow.AddCell() + tableCell.Width = 100 + 'Adds new paragraph to the cell. + Dim paragraph As IWParagraph = tableCell.AddParagraph() + 'Adds new text to the paragraph. + paragraph.AppendText("Content Control") + 'Create the Row Content Control for the document. + Dim control As New RowContentControl(document) + 'Change the color value in Content Control properties. + control.ContentControlProperties.Color = System.Drawing.Color.Blue + ' Sets it to the row content control. + tableRow.ContentControl = control + 'Save the Word document. + document.Save("Sample.docx", FormatType.Docx) + 'Close the document. + document.Close() + + + + + + Gets the character format of the content control. Read-only. + + The object that specifies the character format. + + + + Represents a cell content control in the Word document. + + + + + Closes this instance. + + + + + Gets the content control properties. Read-only. + + The object that specifies the content control properties. + The following example illustrates how to set the properties for content control. + + WordDocument document = new WordDocument(); + //Adds new section to the document. + IWSection section = document.AddSection(); + //Adds new table to the section. + IWTable table = section.AddTable(); + //Adds new row to the table. + WTableRow tableRow = table.AddRow(); + //Adds new cell to the row. + WTableCell tableCell = tableRow.AddCell(); + tableCell.Width = 100; + //Adds new paragraph to the cell. + IWParagraph paragraph = tableCell.AddParagraph(); + //Adds new text to the paragraph. + paragraph.AppendText("Content Control"); + //Create the Cell Content Control for the document. + CellContentControl control = new CellContentControl(document); + //Change the color value in Content Control properties. + control.ContentControlProperties.Color = System.Drawing.Color.Green; + //Set it to the row content control. + tableCell.ContentControl = control; + //Save the Word document. + document.Save("Sample.docx", FormatType.Docx); + //Close the document. + document.Close(); + + + Dim document As New WordDocument() + 'Adds new section to the document. + Dim section As IWSection = document.AddSection() + 'Adds new table to the section. + Dim table As IWTable = section.AddTable() + 'Adds new row to the table. + Dim tableRow As WTableRow = table.AddRow() + 'Adds new cell to the row. + Dim tableCell As WTableCell = tableRow.AddCell() + tableCell.Width = 100 + 'Adds new paragraph to the cell. + Dim paragraph As IWParagraph = tableCell.AddParagraph() + 'Adds new text to the paragraph. + paragraph.AppendText("Content Control") + 'Create the Cell Content Control for the document. + Dim control As New CellContentControl(document) + 'Change the color value in Content Control properties. + control.ContentControlProperties.Color = System.Drawing.Color.Green + ' Set it to the row content control. + tableCell.ContentControl = control + 'Save the Word document. + document.Save("Sample.docx", FormatType.Docx) + 'Close the document. + document.Close() + + + + + + Gets the character format of the content control. Read-only. + + The object that specifies the character format. + + + + Represents a inline content control in the Word document. + + + + + Initializes a new instance of the class. + + The doc. + + + + Initializes a new instance of the class. + + The Word document. + The content control type. + The following example illustrates how to initializes a new instance of the . + + //Create a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Adds new rich text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText); + //Adds new text to the content control + WTextRange textRange = new WTextRange(document); + textRange.Text = "Rich Text Content Control"; + (paragraph.Items.LastItem as InlineContentControl).ParagraphItems.Add(textRange); + InlineContentControl richTextControl = paragraph.Items.LastItem as InlineContentControl; + richTextControl.ParagraphItems.Add(textRange); + // Sets Title property of the content control. + richTextControl.ContentControlProperties.Title = "Rich text content control"; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + 'Adds new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Adds new rich text content control to the last paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText) + Dim textRange As New WTextRange(document) + textRange.Text = "Rich Text Content Control" + Dim richTextControl As InlineContentControl = section.LastParagraph.LastItem + richTextControl.ParagraphItems.Add(textRange) + 'Sets Title property of the content control. + richTextControl.ContentControlProperties.Title = "Rich text content control" + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + + + + + + Determine whether InlineContentControl Items are hidden. + + + + + + Determine whether InlineContentControl Items are in deletion revision. + + + + + + Checks all item inside the content control are same revision or not. + + True, if all item inside the content control are same revision else false + + + + + + + + + + Adds the self. + + + + + Creates a duplicate of the entity. + + + + + + Clones the relations. + + The doc. + + + + Applies the base format. + + + + + Applies the base format for character format. + + + + + Closes this instance. + + + + + Gets the string of the Inline Content Control for word comparison + + + + + + Copies the items to. + + The para items. + + + + Gets or sets the mapped item to the inline content control + + + + + Gets the content control paragraphitems. Read-only. + + The of the current control. + The following example illustrates how to set the properties for content control. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Adds new rich text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText); + //Adds new text to the content control + WTextRange textRange = new WTextRange(document); + textRange.Text = "Rich Text Content Control"; + (paragraph.Items.LastItem as InlineContentControl).ParagraphItems.Add(textRange); + InlineContentControl richTextControl = paragraph.Items.LastItem as InlineContentControl; + richTextControl.ParagraphItems.Add(textRange); + // Sets Title property of the content control. + richTextControl.ContentControlProperties.Title = "Rich text content control"; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + 'Adds new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Adds new rich text content control to the last paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText) + Dim textRange As New WTextRange(document) + textRange.Text = "Rich Text Content Control" + Dim richTextControl As InlineContentControl = section.LastParagraph.LastItem + richTextControl.ParagraphItems.Add(textRange) + 'Sets Title property of the content control. + richTextControl.ContentControlProperties.Title = "Rich text content control" + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Gets the content control properties. Read-only. + + The object that specifies the content control properties. + The following example illustrates how to set the properties for content control. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Adds new rich text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText); + //Adds new text to the content control + WTextRange textRange = new WTextRange(document); + textRange.Text = "Rich Text Content Control"; + (paragraph.Items.LastItem as InlineContentControl).ParagraphItems.Add(textRange); + InlineContentControl richTextControl = paragraph.Items.LastItem as InlineContentControl; + richTextControl.ParagraphItems.Add(textRange); + // Sets Title property of the content control. + richTextControl.ContentControlProperties.Title = "Rich text content control"; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + 'Adds new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Adds new rich text content control to the last paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText) + Dim textRange As New WTextRange(document) + textRange.Text = "Rich Text Content Control" + Dim richTextControl As InlineContentControl = section.LastParagraph.LastItem + richTextControl.ParagraphItems.Add(textRange) + 'Sets Title property of the content control. + richTextControl.ContentControlProperties.Title = "Rich text content control" + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Gets the character format of the content control. Read-only. + + The object that specifies the character format. + + + + Gets the type of the entity. + + The of the current item. + + + + Gets the end pos from the last item of. + + If there is any item inside inline content control, returns end pos from its last item. + Else, returns their start pos as end pos. + + + + Gets or Sets whether the first nested para inside inline content control parsed or not + + + + + Get the string of the Inline Content Control for word comparison + + + + + Represents the collection of ContentControlListItem for drop-down and combo box content control. + + The following example illustrates how to apply various content control properties. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new drop down list content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.DropDownList); + //Add new text to the content control + WTextRange textRange = new WTextRange(document); + textRange.Text = "Drop down Content Control"; + InlineContentControl dropDownList = paragraph.Items.LastItem as InlineContentControl; + dropDownList.ParagraphItems.Add(textRange); + ContentControlListItem item = new ContentControlListItem(); + item.Value = "1"; + item.DisplayText = "Ice cream"; + dropDownList.ContentControlProperties.ContentControlListItems.Add(item); + item = new ContentControlListItem(); + item.Value = "2"; + item.DisplayText = "Cool drinks"; + dropDownList.ContentControlProperties.ContentControlListItems.Add(item); + dropDownList.ContentControlProperties.Tag = "Drop down"; + dropDownList.ContentControlProperties.Title = "Drop down list items"; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new drop down list content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.DropDownList) + 'Add new text to the content control + Dim textRange As New WTextRange(document) + textRange.Text = "Drop down Content Control" + Dim dropDownList As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + Dim item As New ContentControlListItem() + dropDownList.ParagraphItems.Add(textRange); + item.Value = "1" + item.DisplayText = "Ice cream" + dropDownList.ContentControlProperties.ContentControlListItems.Add(item) + item = New ContentControlListItem() + item.Value = "2" + item.DisplayText = "Cool drinks" + dropDownList.ContentControlProperties.ContentControlListItems.Add(item) + dropDownList.ContentControlProperties.Tag = "Drop down" + dropDownList.ContentControlProperties.Title = "Drop down list items" + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Adds ContentControlListItem to the collection. + + ListItem to be added + The following code illustrates how to add ContentControlListItem to the collection. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new drop down list content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.DropDownList); + //Add new text to the content control + WTextRange textRange = new WTextRange(document); + textRange.Text = "Drop down Content Control"; + InlineContentControl dropDownList = paragraph.Items.LastItem as InlineContentControl; + dropDownList.ParagraphItems.Add(textRange); + ContentControlListItem item = new ContentControlListItem(); + item.Value = "1"; + item.DisplayText = "Ice cream"; + dropDownList.ContentControlProperties.ContentControlListItems.Add(item); + item = new ContentControlListItem(); + item.Value = "2"; + item.DisplayText = "Cool drinks"; + dropDownList.ContentControlProperties.ContentControlListItems.Add(item); + dropDownList.ContentControlProperties.Tag = "Drop down"; + dropDownList.ContentControlProperties.Title = "Drop down list items"; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new drop down list content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.DropDownList) + 'Add new text to the content control + Dim textRange As New WTextRange(document) + textRange.Text = "Drop down Content Control" + Dim dropDownList As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + dropDownList.ParagraphItems.Add(textRange) + Dim item As New ContentControlListItem() + item.Value = "1" + item.DisplayText = "Ice cream" + dropDownList.ContentControlProperties.ContentControlListItems.Add(item) + item = New ContentControlListItem() + item.Value = "2" + item.DisplayText = "Cool drinks" + dropDownList.ContentControlProperties.ContentControlListItems.Add(item) + dropDownList.ContentControlProperties.Tag = "Drop down" + dropDownList.ContentControlProperties.Title = "Drop down list items" + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Inserts the ContentControlListItem at the specified index. + + Index in which ContentControlListItem to be inserted. + ContentControlListItem to be inserted + The following code illustrates how to insert ContentControlListItem to the collection + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + WSection section = document.AddSection() as WSection; + //Add new combo box content control + BlockContentControl block = section.Body.AddBlockContentControl(ContentControlType.ComboBox) as BlockContentControl; + block.TextBody.AddParagraph(); + block.TextBody.LastParagraph.AppendText("Block Content control"); + ContentControlListItem item1 = new ContentControlListItem(); + item1.DisplayText = "Animals"; + item1.Value = "Animals"; + ContentControlListItem item2 = new ContentControlListItem(); + item2.DisplayText = "Fruits"; + item2.Value = "Fruits"; + block.ContentControlProperties.ContentControlListItems.Add(item1); + //Insert specific item to collection using index + block.ContentControlProperties.ContentControlListItems.Insert(1, item2); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As WSection = TryCast(document.AddSection(), WSection) + 'Add new combo box content control + Dim block As BlockContentControl = TryCast(section.Body.AddBlockContentControl(ContentControlType.ComboBox), BlockContentControl) + block.TextBody.AddParagraph(); + block.TextBody.LastParagraph.AppendText("Block Content control") + Dim item1 As New ContentControlListItem() + item1.DisplayText = "Animals" + item1.Value = "Animals" + Dim item2 As New ContentControlListItem() + item2.DisplayText = "Fruits" + item2.Value = "Fruits" + block.ContentControlProperties.ContentControlListItems.Add(item1) + 'Insert specific item to collection using index + block.ContentControlProperties.ContentControlListItems.Insert(1, item2) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Removes the specified ContentControlListItems from the collection. + + ContentControlListItem to be removed. + The following code illustrates how to remove the specified from the collection. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + WSection section = document.AddSection() as WSection; + //Add new combo box content control + BlockContentControl block = section.Body.AddBlockContentControl(ContentControlType.ComboBox) as BlockContentControl; + block.TextBody.AddParagraph(); + block.TextBody.LastParagraph.AppendText("Block Content control"); + ContentControlListItem item1 = new ContentControlListItem(); + item1.DisplayText = "Animals"; + item1.Value = "Animals"; + ContentControlListItem item2 = new ContentControlListItem(); + item2.DisplayText = "Fruits"; + item2.Value = "Fruits"; + block.ContentControlProperties.ContentControlListItems.Add(item1); + block.ContentControlProperties.ContentControlListItems.Add(item2); + //Remove specific item from collection + block.ContentControlProperties.ContentControlListItems.Remove(item1); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As WSection = TryCast(document.AddSection(), WSection) + 'Add new combo box content control + Dim block As BlockContentControl = TryCast(section.Body.AddBlockContentControl(ContentControlType.ComboBox), BlockContentControl) + block.TextBody.AddParagraph() + block.TextBody.LastParagraph.AppendText("Block Content control") + Dim item1 As New ContentControlListItem() + item1.DisplayText = "Animals" + item1.Value = "Animals" + Dim item2 As New ContentControlListItem() + item2.DisplayText = "Fruits" + item2.Value = "Fruits" + block.ContentControlProperties.ContentControlListItems.Add(item1) + block.ContentControlProperties.ContentControlListItems.Add(item2) + 'Remove specific item from collection + block.ContentControlProperties.ContentControlListItems.Remove(item1) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Removes ContentControlListItems from the collection at specified collection. + + ContentControlListItem's index to be removed. + The following code illustrates how to remove ContentControlListItem from the collection at specified index. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + WSection section = document.AddSection() as WSection; + //Add new combo box content control + BlockContentControl block = section.Body.AddBlockContentControl(ContentControlType.ComboBox) as BlockContentControl; + block.TextBody.AddParagraph(); + block.TextBody.LastParagraph.AppendText("Block Content control"); + ContentControlListItem item1 = new ContentControlListItem(); + item1.DisplayText = "Animals"; + item1.Value = "Animals"; + ContentControlListItem item2 = new ContentControlListItem(); + item2.DisplayText = "Fruits"; + item2.Value = "Fruits"; + block.ContentControlProperties.ContentControlListItems.Add(item1); + block.ContentControlProperties.ContentControlListItems.Add(item2); + //Remove specific item from collection + block.ContentControlProperties.ContentControlListItems.RemoveAt(0); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As WSection = TryCast(document.AddSection(), WSection) + 'Add new combo box content control + Dim block As BlockContentControl = TryCast(section.Body.AddBlockContentControl(ContentControlType.ComboBox), BlockContentControl) + block.TextBody.AddParagraph() + block.TextBody.LastParagraph.AppendText("Block Content control"); + Dim item1 As New ContentControlListItem() + item1.DisplayText = "Animals" + item1.Value = "Animals" + Dim item2 As New ContentControlListItem() + item2.DisplayText = "Fruits" + item2.Value = "Fruits" + block.ContentControlProperties.ContentControlListItems.Add(item1) + block.ContentControlProperties.ContentControlListItems.Add(item2) + 'Remove specific item from collection + block.ContentControlProperties.ContentControlListItems.RemoveAt(0) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Returns ContentControlListItems as a collection. + + + An object that can be used to iterate through the collection. + + + + + Closes this instance. + + + + + Creates a duplicate of the entity. + + + + + + Gets the last value + + + + + �Gets the list items of the drop-down list or combo-box content control.. + + The following code illustrates how to get from collection based on specified index. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + WSection section = document.AddSection() as WSection; + //Add new combo box content control + BlockContentControl block = section.Body.AddBlockContentControl(ContentControlType.ComboBox) as BlockContentControl; + block.TextBody.AddParagraph(); + block.TextBody.LastParagraph.AppendText("Block Content control"); + ContentControlListItem item1 = new ContentControlListItem(); + item1.DisplayText = "Animals"; + item1.Value = "Animals"; + ContentControlListItem item2 = new ContentControlListItem(); + block.ContentControlProperties.ContentControlListItems.Add(item1); + //Insert specific item to collection using index + block.ContentControlProperties.ContentControlListItems.Insert(1, item2); + //Get the ContentControlListItem from the collection + block.ContentControlProperties.ContentControlListItems[1].DisplayText = "Fruits"; + block.ContentControlProperties.ContentControlListItems[1].Value = "Fruits"; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As WSection = TryCast(document.AddSection(), WSection) + 'Add new combo box content control + Dim block As BlockContentControl = TryCast(section.Body.AddBlockContentControl(ContentControlType.ComboBox), BlockContentControl) + block.TextBody.AddParagraph() + block.TextBody.LastParagraph.AppendText("Block Content control") + Dim item1 As New ContentControlListItem() + item1.DisplayText = "Animals" + item1.Value = "Animals" + Dim item2 As New ContentControlListItem() + block.ContentControlProperties.ContentControlListItems.Add(item1) + 'Insert specific item to collection using index + block.ContentControlProperties.ContentControlListItems.Insert(1, item2); + 'Get the ContentControlListItem from the collection + block.ContentControlProperties.ContentControlListItems(1).DisplayText = "Fruits" + block.ContentControlProperties.ContentControlListItems(1).Value = "Fruits" + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + �Returns the count of ContentControlListItem's collection. + + The following code illustrates how to get the count of in the collection. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + WSection section = document.AddSection() as WSection; + //Add new combo box content control + BlockContentControl block = section.Body.AddBlockContentControl(ContentControlType.ComboBox) as BlockContentControl; + block.TextBody.AddParagraph(); + block.TextBody.LastParagraph.AppendText("Block Content control"); + ContentControlListItem item1 = new ContentControlListItem(); + item1.DisplayText = "Animals"; + item1.Value = "Animals"; + ContentControlListItem item2 = new ContentControlListItem(); + item2.DisplayText = "Fruits"; + item2.Value = "Fruits"; + block.ContentControlProperties.ContentControlListItems.Add(item1); + block.ContentControlProperties.ContentControlListItems.Add(item2); + //Get the count of content control list items + int count = block.ContentControlProperties.ContentControlListItems.Count; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As WSection = TryCast(document.AddSection(), WSection) + 'Add new combo box content control + Dim block As BlockContentControl = TryCast(section.Body.AddBlockContentControl(ContentControlType.ComboBox), BlockContentControl) + block.TextBody.AddParagraph() + block.TextBody.LastParagraph.AppendText("Block Content control") + Dim item1 As New ContentControlListItem() + item1.DisplayText = "Animals" + item1.Value = "Animals" + Dim item2 As New ContentControlListItem() + item2.DisplayText = "Fruits" + item2.Value = "Fruits" + block.ContentControlProperties.ContentControlListItems.Add(item1) + block.ContentControlProperties.ContentControlListItems.Add(item2) + 'Get the count of content control list items + Dim count As Integer = block.ContentControlProperties.ContentControlListItems.Count + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Represents the list item in a drop-down list content control or in a combo box content control. + + The following example illustrates how to create and manipulate list item in a drop-down list content control or in a combo box content control. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new drop down list content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.DropDownList); + //Add new text to the content control + WTextRange textRange = new WTextRange(document); + textRange.Text = "Drop down Content Control"; + InlineContentControl dropDownList = paragraph.Items.LastItem as InlineContentControl; + dropDownList.ParagraphItems.Add(textRange); + ContentControlListItem item = new ContentControlListItem(); + item.Value = "1"; + item.DisplayText = "Ice cream"; + dropDownList.ContentControlProperties.ContentControlListItems.Add(item); + item = new ContentControlListItem(); + item.Value = "2"; + item.DisplayText = "Cool drinks"; + dropDownList.ContentControlProperties.ContentControlListItems.Add(item); + dropDownList.ContentControlProperties.Tag = "Drop down"; + dropDownList.ContentControlProperties.Title = "Drop down list items"; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new drop down list content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.DropDownList) + 'Add new text to the content control + Dim textRange As New WTextRange(document) + textRange.Text = "Drop down Content Control" + Dim dropDownList As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + Dim item As New ContentControlListItem() + dropDownList.ParagraphItems.Add(textRange) + item.Value = "1" + item.DisplayText = "Ice cream" + dropDownList.ContentControlProperties.ContentControlListItems.Add(item) + item = New ContentControlListItem() + item.Value = "2" + item.DisplayText = "Cool drinks" + dropDownList.ContentControlProperties.ContentControlListItems.Add(item) + dropDownList.ContentControlProperties.Tag = "Drop down" + dropDownList.ContentControlProperties.Title = "Drop down list items" + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Gets/Sets the text to be displayed as list item. + + The following code illustrates how to access DisplayText property of the list item. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new drop down list content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.DropDownList); + //Add new text to the content control + WTextRange textRange = new WTextRange(document); + textRange.Text = "Drop down Content Control"; + InlineContentControl dropDownList = paragraph.Items.LastItem as InlineContentControl; + //richTextControl.ParagraphItems.Add(textRange); + ContentControlListItem item = new ContentControlListItem(); + item.Value = "1"; + item.DisplayText = "Ice cream"; + dropDownList.ContentControlProperties.ContentControlListItems.Add(item); + item = new ContentControlListItem(); + item.Value = "2"; + item.DisplayText = "Cool drinks"; + dropDownList.ContentControlProperties.ContentControlListItems.Add(item); + dropDownList.ContentControlProperties.Tag = "Drop down"; + dropDownList.ContentControlProperties.Title = "Drop down list items"; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new drop down list content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.DropDownList) + 'Add new text to the content control + Dim textRange As New WTextRange(document) + textRange.Text = "Drop down Content Control" + Dim dropDownList As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + 'richTextControl.ParagraphItems.Add(textRange); + Dim item As New ContentControlListItem() + item.Value = "1" + item.DisplayText = "Ice cream" + dropDownList.ContentControlProperties.ContentControlListItems.Add(item) + item = New ContentControlListItem() + item.Value = "2" + item.DisplayText = "Cool drinks" + dropDownList.ContentControlProperties.ContentControlListItems.Add(item) + dropDownList.ContentControlProperties.Tag = "Drop down" + dropDownList.ContentControlProperties.Title = "Drop down list items" + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Gets/Sets the value of the list item. + + The following code illustrates how to set the value of the list item. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new drop down list content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.DropDownList); + //Add new text to the content control + WTextRange textRange = new WTextRange(document); + textRange.Text = "Drop down Content Control"; + InlineContentControl dropDownList = paragraph.Items.LastItem as InlineContentControl; + ContentControlListItem item = new ContentControlListItem(); + item.Value = "1"; + item.DisplayText = "Ice cream"; + dropDownList.ContentControlProperties.ContentControlListItems.Add(item); + item = new ContentControlListItem(); + item.Value = "2"; + item.DisplayText = "Cool drinks"; + dropDownList.ContentControlProperties.ContentControlListItems.Add(item); + dropDownList.ContentControlProperties.Tag = "Drop down"; + dropDownList.ContentControlProperties.Title = "Drop down list items"; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new drop down list content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.DropDownList) + 'Add new text to the content control + Dim textRange As New WTextRange(document) + textRange.Text = "Drop down Content Control" + Dim dropDownList As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + Dim item As New ContentControlListItem() + item.Value = "1" + item.DisplayText = "Ice cream" + dropDownList.ContentControlProperties.ContentControlListItems.Add(item) + item = New ContentControlListItem() + item.Value = "2" + item.DisplayText = "Cool drinks" + dropDownList.ContentControlProperties.ContentControlListItems.Add(item) + dropDownList.ContentControlProperties.Tag = "Drop down" + dropDownList.ContentControlProperties.Title = "Drop down list items" + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Represents the formatting options of the content control in the Word document. + + The following example illustrates how to apply various content control properties. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new rich text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText); + //Add new text to the content control + WTextRange textRange = new WTextRange(document); + textRange.Text = "Rich Text Content Control"; + (paragraph.Items.LastItem as InlineContentControl).ParagraphItems.Add(textRange); + InlineContentControl richTextControl = paragraph.Items.LastItem as InlineContentControl; + richTextControl.ParagraphItems.Add(textRange); + richTextControl.ContentControlProperties.Appearance = ContentControlAppearance.Tags; + richTextControl.ContentControlProperties.Color = Color.Gray; + richTextControl.ContentControlProperties.LockContentControl = true; + richTextControl.ContentControlProperties.Tag = "RichText"; + richTextControl.ContentControlProperties.Title = "Rich text content control"; + //Add new text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.Text); + //Add new text to the content control + WTextRange textRange1 = new WTextRange(document); + textRange1.Text = "Text Content Control"; + (paragraph.Items.LastItem as InlineContentControl).ParagraphItems.Add(textRange1); + InlineContentControl textControl = paragraph.Items.LastItem as InlineContentControl; + textControl.ParagraphItems.Add(textRange1); + textControl.ContentControlProperties.Appearance = ContentControlAppearance.Tags; + textControl.ContentControlProperties.Color = Color.Gray; + textControl.ContentControlProperties.LockContentControl = true; + textControl.ContentControlProperties.LockContents = true; + textControl.ContentControlProperties.Multiline = true; + textControl.ContentControlProperties.Tag = "Text"; + textControl.ContentControlProperties.Title = "Text content control"; + //Add new date content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.Date); + //Add new text to the content control + WTextRange textRange2 = new WTextRange(document); + textRange2.Text = "Date Content Control"; + (paragraph.Items.LastItem as InlineContentControl).ParagraphItems.Add(textRange2); + InlineContentControl dateControl = paragraph.Items.LastItem as InlineContentControl; + dateControl.ParagraphItems.Add(textRange2); + dateControl.ContentControlProperties.Appearance = ContentControlAppearance.Tags; + dateControl.ContentControlProperties.DateCalendarType = CalendarType.GregorianArabic; + dateControl.ContentControlProperties.DateDisplayFormat = "dd yy MMMM"; + dateControl.ContentControlProperties.DateDisplayLocale = LocaleIDs.en_US; + dateControl.ContentControlProperties.DateStorageFormat = ContentControlDateStorageFormat.DateStorageDate; + dateControl.ContentControlProperties.Tag = "Date control"; + dateControl.ContentControlProperties.Title = "Date content control"; + //Add new drop down list content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.DropDownList); + //Add new text to the content control + WTextRange textRange3 = new WTextRange(document); + textRange3.Text = "Drop down Content Control"; + InlineContentControl dropDownList = paragraph.Items.LastItem as InlineContentControl; + //richTextControl.ParagraphItems.Add(textRange); + ContentControlListItem item = new ContentControlListItem(); + item.Value = "1"; + item.DisplayText = "Ice cream"; + dropDownList.ContentControlProperties.ContentControlListItems.Add(item); + item = new ContentControlListItem(); + item.Value = "2"; + item.DisplayText = "Cool drinks"; + dropDownList.ContentControlProperties.ContentControlListItems.Add(item); + dropDownList.ContentControlProperties.Tag = "Drop down"; + dropDownList.ContentControlProperties.Title = "Drop down list items"; + //Add new picture content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.Picture); + Image image = Image.FromFile("Image.png"); + IWPicture picture = new WPicture(document); + picture.LoadImage(image); + picture.Height = 100; + picture.Width = 100; + InlineContentControl pictureControl = paragraph.Items.LastItem as InlineContentControl; + pictureControl.ParagraphItems.Add(picture); + pictureControl.ContentControlProperties.Tag = "Picture control"; + pictureControl.ContentControlProperties.Title = "picture control"; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new rich text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText) + 'Add new text to the content control + Dim textRange As New WTextRange(document) + textRange.Text = "Rich Text Content Control" + TryCast(paragraph.Items.LastItem, InlineContentControl).ParagraphItems.Add(textRange) + Dim richTextControl As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + richTextControl.ParagraphItems.Add(textRange) + richTextControl.ContentControlProperties.Appearance = ContentControlAppearance.Tags + richTextControl.ContentControlProperties.Color = Color.Gray + richTextControl.ContentControlProperties.LockContentControl = True + richTextControl.ContentControlProperties.Tag = "RichText" + richTextControl.ContentControlProperties.Title = "Rich text content control" + 'Add new text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.Text) + 'Add new text to the content control + Dim textRange1 As New WTextRange(document) + textRange1.Text = "Text Content Control" + TryCast(paragraph.Items.LastItem, InlineContentControl).ParagraphItems.Add(textRange1) + Dim textControl As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + textControl.ParagraphItems.Add(textRange1) + textControl.ContentControlProperties.Appearance = ContentControlAppearance.Tags + textControl.ContentControlProperties.Color = Color.Gray + textControl.ContentControlProperties.LockContentControl = True + textControl.ContentControlProperties.LockContents = True + textControl.ContentControlProperties.Multiline = True + textControl.ContentControlProperties.Tag = "Text" + textControl.ContentControlProperties.Title = "Text content control" + 'Add new date content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.[Date]) + 'Add new text to the content control + Dim textRange2 As New WTextRange(document) + textRange2.Text = "Date Content Control" + TryCast(paragraph.Items.LastItem, InlineContentControl).ParagraphItems.Add(textRange2) + Dim dateControl As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + dateControl.ParagraphItems.Add(textRange2) + dateControl.ContentControlProperties.Appearance = ContentControlAppearance.Tags + dateControl.ContentControlProperties.DateCalendarType = CalendarType.GregorianArabic + dateControl.ContentControlProperties.DateDisplayFormat = "dd yy MMMM" + dateControl.ContentControlProperties.DateDisplayLocale = LocaleIDs.en_US + dateControl.ContentControlProperties.DateStorageFormat = ContentControlDateStorageFormat.DateStorageDate + dateControl.ContentControlProperties.Tag = "Date control" + dateControl.ContentControlProperties.Title = "Date content control" + 'Add new drop down list content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.DropDownList) + 'Add new text to the content control + Dim textRange3 As New WTextRange(document) + textRange3.Text = "Drop down Content Control" + Dim dropDownList As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + 'richTextControl.ParagraphItems.Add(textRange); + Dim item As New ContentControlListItem() + item.Value = "1" + item.DisplayText = "Ice cream" + dropDownList.ContentControlProperties.ContentControlListItems.Add(item) + item = New ContentControlListItem() + item.Value = "2" + item.DisplayText = "Cool drinks" + dropDownList.ContentControlProperties.ContentControlListItems.Add(item) + dropDownList.ContentControlProperties.Tag = "Drop down" + dropDownList.ContentControlProperties.Title = "Drop down list items" + 'Add new picture content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.Picture) + Dim image As Image = image.FromFile("Image.png") + Dim picture As IWPicture = New WPicture(document) + picture.LoadImage(image) + picture.Height = 100 + picture.Width = 100 + Dim pictureControl As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + pictureControl.ParagraphItems.Add(picture) + pictureControl.ContentControlProperties.Tag = "Picture control" + pictureControl.ContentControlProperties.Title = "picture control" + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Creates a duplicate of the entity. + + + + + + Clones the relations. + + The doc. + + + + Sets the owner for content control properties. + + The owner content control. + + + + Closes this instance. + + + + + Get the string value of the content control properties. + + + + + + Compare the properties of content control + + + + + + + + + Gets or sets a value indicating the identification for the content control + + + + + Gets or sets a value indicating the format in which dates are displayed in Date picker content control. + + The following example illustrates how to set date display format for the Date picker content control. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new date picker content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.Date); + InlineContentControl datePicker = paragraph.Items.LastItem as InlineContentControl; + WTextRange textRange = new WTextRange(document); + //Sets today's date to display. + textRange.Text = DateTime.Now.ToShortDateString(); + datePicker.ParagraphItems.Add(textRange); + //Sets format for date to display. + datePicker.ContentControlProperties.DateDisplayFormat = "M/d/yyyy"; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new date picker content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.[Date]) + Dim datePicker As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + Dim textRange As New WTextRange(document) + 'Sets today's date to display. + textRange.Text = DateTime.Now.ToShortDateString() + datePicker.ParagraphItems.Add(textRange) + datePicker.ContentControlProperties.DateDisplayFormat = "M/d/yyyy" + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Gets or sets a value indicating the language format for the date displayed in a Date picker content control. + + The following example illustrates how to set date display locale for the Date picker content control. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new date picker content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.Date); + InlineContentControl datePicker = paragraph.Items.LastItem as InlineContentControl; + WTextRange textRange = new WTextRange(document); + //Sets today's date to display. + textRange.Text = DateTime.Now.ToShortDateString(); + datePicker.ParagraphItems.Add(textRange); + //Sets the language format for the date. + datePicker.ContentControlProperties.DateDisplayLocale = LocaleIDs.en_US; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new date picker content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.[Date]) + Dim datePicker As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + Dim textRange As New WTextRange(document) + 'Sets today's date to display. + textRange.Text = DateTime.Now.ToShortDateString() + datePicker.ParagraphItems.Add(textRange) + 'Sets the language format for the date. + datePicker.ContentControlProperties.DateDisplayLocale = LocaleIDs.en_US + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Gets or sets a value indicating the full date of the date content control + + + + + Gets or sets a value indicating docpart of placeholder + + + + + Gets or sets a value indicating the storage and retrieval of dates when a date content control is bound to the XML data storage. + + The following example illustrates how to set format for date display locale for the Date picker content control. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new date picker content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.Date); + InlineContentControl datePicker = paragraph.Items.LastItem as InlineContentControl; + WTextRange textRange = new WTextRange(document); + //Sets today's date to display. + textRange.Text = DateTime.Now.ToShortDateString(); + datePicker.ParagraphItems.Add(textRange); + //Sets the storage and retrieval format for the date. + datePicker.ContentControlProperties.DateStorageFormat = ContentControlDateStorageFormat.DateStorageDate; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new date picker content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.[Date]) + Dim datePicker As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + Dim textRange As New WTextRange(document) + 'Sets today's date to display. + textRange.Text = DateTime.Now.ToShortDateString() + datePicker.ParagraphItems.Add(textRange) + 'Sets the storage and retrieval format for the date. + datePicker.ContentControlProperties.DateStorageFormat = ContentControlDateStorageFormat.DateStorageDate; + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Gets or sets a value indicating the calendar type for a Date picker content control. + + The following example illustrates how to set calendar type for the Date picker content control. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new date picker content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.Date); + InlineContentControl datePicker = paragraph.Items.LastItem as InlineContentControl; + WTextRange textRange = new WTextRange(document); + //Sets today's date to display. + textRange.Text = DateTime.Now.ToShortDateString(); + datePicker.ParagraphItems.Add(textRange); + //Sets calendar type for the date picker control. + datePicker.ContentControlProperties.DateCalendarType = CalendarType.Gregorian; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new date picker content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.[Date]) + Dim datePicker As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + Dim textRange As New WTextRange(document) + 'Sets today's date to display. + textRange.Text = DateTime.Now.ToShortDateString() + datePicker.ParagraphItems.Add(textRange) + 'Sets calendar type for the date picker control. + datePicker.ContentControlProperties.DateCalendarType = CalendarType.Gregorian + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Gets or sets the current state of the Check box content control. + + + true if check box current state is checked; otherwise, false. + + + + + Gets or sets a value indicating whether the user can delete a content control from the active Word document + + + true if the control cannot be deleted; otherwise, false. + + The following example illustrates how to lock the content control. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new rich text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText); + //Add new text to the content control + WTextRange textRange = new WTextRange(document); + textRange.Text = "Rich Text Content Control"; + (paragraph.Items.LastItem as InlineContentControl).ParagraphItems.Add(textRange); + InlineContentControl richTextControl = paragraph.Items.LastItem as InlineContentControl; + richTextControl.ParagraphItems.Add(textRange); + // Enables content control lock. + richTextControl.ContentControlProperties.LockContentControl = true; + //Add new text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.Text); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new rich text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText) + 'Add new text to the content control + Dim textRange As New WTextRange(document) + textRange.Text = "Rich Text Content Control" + TryCast(paragraph.Items.LastItem, InlineContentControl).ParagraphItems.Add(textRange) + Dim richTextControl As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + richTextControl.ParagraphItems.Add(textRange) + 'Enables content control lock. + richTextControl.ContentControlProperties.LockContentControl = True + 'Add new text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.Text) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Gets or sets a value indicating whether the user can edit the contents of a content control. + + + true if the content of the control cannot be deleted; otherwise, false. + + The following example illustrates how to set Temporary property of the content control. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new rich text content control to the paragraph. + paragraph.AppendInlineContentControl(ContentControlType.RichText); + InlineContentControl richTextControl = paragraph.Items.LastItem as InlineContentControl; + //Add new text to the content control + WTextRange textRange = new WTextRange(document); + textRange.Text = "Rich Text Content Control"; + richTextControl.ParagraphItems.Add(textRange); + //Protects the content control. + richTextControl.ContentControlProperties.LockContents = true; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new rich text content control to the paragraph. + paragraph.AppendInlineContentControl(ContentControlType.RichText) + Dim richTextControl As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + 'Add new text to the content control + Dim textRange As New WTextRange(document) + textRange.Text = "Rich Text Content Control" + richTextControl.ParagraphItems.Add(textRange) + 'Protects the content control. + richTextControl.ContentControlProperties.LockContents = True + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Gets or sets a value indicating whether a text content control allows multiple lines of text. + This property is applicable only for Plain text content control. + + + true if the control allows multiple lines of text; otherwise, false. + + The following example illustrates how to set Multiline property of Plain text content control. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new plain text content control to the paragraph. + paragraph.AppendInlineContentControl(ContentControlType.Text); + InlineContentControl plainTextControl = paragraph.Items.LastItem as InlineContentControl; + //Enables multiline for plain text control. + plainTextControl.ContentControlProperties.Multiline = true; + //Add new text to the content control + WTextRange textRange = new WTextRange(document); + textRange.Text = "Plain Text Content Control"; + plainTextControl.ParagraphItems.Add(textRange); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new plain text content control to the paragraph. + paragraph.AppendInlineContentControl(ContentControlType.Text) + Dim plainTextControl As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + 'Enables multiline for plain text control. + plainTextControl.ContentControlProperties.Multiline = True + 'Add new text to the content control + Dim textRange As New WTextRange(document) + textRange.Text = "Plain Text Content Control" + plainTextControl.ParagraphItems.Add(textRange) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Gets or sets a value indicating the appearance of the content control. The default value is .BoundingBox. + + The following example illustrates how to change the appearance of content control. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new rich text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText); + //Add new text to the content control + WTextRange textRange = new WTextRange(document); + textRange.Text = "Rich Text Content Control"; + (paragraph.Items.LastItem as InlineContentControl).ParagraphItems.Add(textRange); + InlineContentControl richTextControl = paragraph.Items.LastItem as InlineContentControl; + richTextControl.ParagraphItems.Add(textRange); + //Sets Tag appearance for the content control. + richTextControl.ContentControlProperties.Appearance = ContentControlAppearance.Tags; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new rich text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText) + 'Add new text to the content control + Dim textRange As New WTextRange(document) + textRange.Text = "Rich Text Content Control" + TryCast(paragraph.Items.LastItem, InlineContentControl).ParagraphItems.Add(textRange) + Dim richTextControl As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + richTextControl.ParagraphItems.Add(textRange) + 'Sets Tag appearance for the content control. + richTextControl.ContentControlProperties.Appearance = ContentControlAppearance.Tags + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + Use BoundingBox type to display the contents of content control within a box. + Use Tags type to display the contents of content control within tags. + Use Hidden type to display the contents of content control without any box or tags. + + + + + Gets or sets a value indicating the color of the content control. + + The following example illustrates how to change the color of content control. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new rich text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText); + //Add new text to the content control + WTextRange textRange = new WTextRange(document); + textRange.Text = "Rich Text Content Control"; + (paragraph.Items.LastItem as InlineContentControl).ParagraphItems.Add(textRange); + InlineContentControl richTextControl = paragraph.Items.LastItem as InlineContentControl; + richTextControl.ParagraphItems.Add(textRange); + // Sets the Color property of content control. + richTextControl.ContentControlProperties.Color = Color.Blue; + //Add new text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.Text); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new rich text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText) + 'Add new text to the content control + Dim textRange As New WTextRange(document) + textRange.Text = "Rich Text Content Control" + TryCast(paragraph.Items.LastItem, InlineContentControl).ParagraphItems.Add(textRange) + Dim richTextControl As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + richTextControl.ParagraphItems.Add(textRange) + 'Sets the Color property of content control. + richTextControl.ContentControlProperties.Color = Color.Blue + 'Add new text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.Text) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Gets or sets a value indicating the title of the content control + + The following example illustrates how to set the title property for the content control. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new rich text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText); + //Add new text to the content control + WTextRange textRange = new WTextRange(document); + textRange.Text = "Rich Text Content Control"; + (paragraph.Items.LastItem as InlineContentControl).ParagraphItems.Add(textRange); + InlineContentControl richTextControl = paragraph.Items.LastItem as InlineContentControl; + richTextControl.ParagraphItems.Add(textRange); + // Sets Title property of the content control. + richTextControl.ContentControlProperties.Title = "Rich text content control"; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new rich text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText) + 'Add new text to the content control + Dim textRange As New WTextRange(document) + textRange.Text = "Rich Text Content Control" + TryCast(paragraph.Items.LastItem, InlineContentControl).ParagraphItems.Add(textRange) + Dim richTextControl As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + richTextControl.ParagraphItems.Add(textRange) + 'Sets Title property of the content control. + richTextControl.ContentControlProperties.Title = "Rich text content control" + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Gets or sets a value indicating the content control has bibliograph + + + + + Gets or sets a value indicating whether the content control has reference + + + + + Gets or sets the value indicating that the content control can be unlocked + + + + + Gets or sets values indicating the items in a drop-down list content control or in a combo box content control + + The following example illustrates how to set the ContentControlListItems for Combo-box and Drop-down content control. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new drop down list content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.DropDownList); + InlineContentControl dropDownList = paragraph.Items.LastItem as InlineContentControl; + //Set default option in drop down list. + WTextRange textRange = new WTextRange(document); + textRange.Text = "Choose an item"; + dropDownList.ParagraphItems.Add(textRange); + //Add item into drop down list. + ContentControlListItem item = new ContentControlListItem(); + item.Value = "1"; + item.DisplayText = "DocIO"; + //Add item into collection of drop down list items. + dropDownList.ContentControlProperties.ContentControlListItems.Add(item); + //Add item into drop down list. + item = new ContentControlListItem(); + item.Value = "2"; + item.DisplayText = "PDF"; + //Add item into collection of drop down list items. + dropDownList.ContentControlProperties.ContentControlListItems.Add(item); + //Add combo box control. + IInlineContentControl comboboxControl = paragraph.AppendInlineContentControl(ContentControlType.ComboBox); + //Set default option in Combo box. + textRange = new WTextRange(document); + textRange.Text = "Choose an item"; + comboboxControl.ParagraphItems.Add(textRange); + //Add item into combo box list. + item = new ContentControlListItem(); + item.Value = "1"; + item.DisplayText = "Windows"; + //Add item into collection of combo box list items. + comboboxControl.ContentControlProperties.ContentControlListItems.Add(item); + //Add another item into combo box list. + item = new ContentControlListItem(); + item.Value = "2"; + item.DisplayText = "Xamarin"; + //Add item into collection of combo box list items. + comboboxControl.ContentControlProperties.ContentControlListItems.Add(item); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new drop down list content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.DropDownList) + Dim dropDownList As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + 'Set default option in drop down list. + Dim textRange As New WTextRange(document) + textRange.Text = "Choose an item" + dropDownList.ParagraphItems.Add(textRange) + 'Add item into drop down list. + Dim item As New ContentControlListItem() + item.Value = "1" + item.DisplayText = "DocIO" + 'Add item into collection of drop down list items. + dropDownList.ContentControlProperties.ContentControlListItems.Add(item) + 'Add item into drop down list. + item = New ContentControlListItem() + item.Value = "2" + item.DisplayText = "PDF" + 'Add item into collection of drop down list items. + dropDownList.ContentControlProperties.ContentControlListItems.Add(item) + 'Add combo box control. + Dim comboboxControl As IInlineContentControl = paragraph.AppendInlineContentControl(ContentControlType.ComboBox) + 'Set default option in Combo box. + textRange = New WTextRange(document) + textRange.Text = "Choose an item" + comboboxControl.ParagraphItems.Add(textRange) + 'Add item into combo box list. + item = New ContentControlListItem() + item.Value = "1" + item.DisplayText = "Windows" + 'Add item into collection of combo box list items. + comboboxControl.ContentControlProperties.ContentControlListItems.Add(item) + 'Add another item into combo box list. + item = New ContentControlListItem() + item.Value = "2" + item.DisplayText = "Xamarin" + 'Add item into collection of combo box list items. + comboboxControl.ContentControlProperties.ContentControlListItems.Add(item) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + + Gets or sets the document part list to the content control + + + + + Gets or sets the document part object to the content control + + + + + Gets the type of the content control. + + The following example illustrates how to get type of content control. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + paragraph.AppendText("Plain Text"); + //Add new plain text content control to the paragraph. + paragraph.AppendInlineContentControl(ContentControlType.Text); + InlineContentControl inlineContentControl = paragraph.Items.LastItem as InlineContentControl; + //Gets the type of content control. + ContentControlType controlType = inlineContentControl.ContentControlProperties.Type; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + paragraph.AppendText("Plain Text") + 'Add new plain text content control to the paragraph. + paragraph.AppendInlineContentControl(ContentControlType.Text) + Dim inlineContentControl As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + 'Gets the type of content control. + Dim controlType As ContentControlType = inlineContentControl.ContentControlProperties.Type + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Gets or sets the appearance of the content control + + + + + Gets character format of the content control + + + + + Gets a value indicating whether the placeholder text for the content control is displayed or not. + + + + + Gets or sets a value indicating the tab index of the content control + + + + + Gets or sets a value to identify the content control + + The following example illustrates how to set the tag property for the content control. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new rich text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText); + //Add new text to the content control + WTextRange textRange = new WTextRange(document); + textRange.Text = "Rich Text Content Control"; + (paragraph.Items.LastItem as InlineContentControl).ParagraphItems.Add(textRange); + InlineContentControl richTextControl = paragraph.Items.LastItem as InlineContentControl; + richTextControl.ParagraphItems.Add(textRange); + // Sets Tag property of the content control. + richTextControl.ContentControlProperties.Tag = "RichText"; + //Add new text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.Text); + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new rich text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.RichText) + 'Add new text to the content control + Dim textRange As New WTextRange(document) + textRange.Text = "Rich Text Content Control" + TryCast(paragraph.Items.LastItem, InlineContentControl).ParagraphItems.Add(textRange) + Dim richTextControl As InlineContentControl = TryCast(paragraph.Items.LastItem, InlineContentControl) + richTextControl.ParagraphItems.Add(textRange) + 'Sets Tag property of the content control. + richTextControl.ContentControlProperties.Tag = "RichText" + 'Add new text content control to the paragraph + paragraph.AppendInlineContentControl(ContentControlType.Text) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Gets or sets a value indicating whether to remove a content control from the Word document when the user edits the contents of the control + + + + + Gets or sets a content repeating type value to the content control + + + + + Property to maintain values of content control properties from existing document. + + + + + Represents a checked state or unchecked state in the checkbox content control. + + The following example illustrates how to apply checkbox state properties. + + //Create a new Word document + WordDocument document = new WordDocument(); + //Add one section and one paragraph to the document + document.EnsureMinimal(); + //Get the last paragraph. + WParagraph paragraph = document.LastParagraph; + //Add text to the paragraph + paragraph.AppendText("A new text is added to the paragraph. "); + //Append checkbox content control to the paragraph + InlineContentControl checkBox = paragraph.AppendInlineContentControl(ContentControlType.CheckBox) as InlineContentControl; + //Get checked state of checkbox + CheckBoxState checkBoxCheckedState = checkBox.ContentControlProperties.CheckedState; + //Set font for checked state value + checkBoxCheckedState.Font = "Calibri"; + //Set symbol for checked state value + checkBoxCheckedState.Value = "C"; + //Get unchecked state of checkbox + CheckBoxState checkBoxUncheckedState = checkBox.ContentControlProperties.UncheckedState; + //Set font for unchecked state value + checkBoxUncheckedState.Font = "Calibri"; + //Set symbol for unchecked state value + checkBoxUncheckedState.Value = "U"; + //Set the state for checkbox + checkBox.ContentControlProperties.IsChecked = true; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + 'Create a new Word document + Dim document As WordDocument = New WordDocument + 'Add one section and one paragraph to the document + document.EnsureMinimal + 'Get the last paragraph. + Dim paragraph As WParagraph = document.LastParagraph + 'Add text to the paragraph + paragraph.AppendText("A new text is added to the paragraph. ") + 'Append checkbox content control to the paragraph + Dim checkBox As InlineContentControl = CType(paragraph.AppendInlineContentControl(ContentControlType.CheckBox), InlineContentControl) + 'Get checked state of checkbox + Dim checkBoxCheckedState As CheckBoxState = checkBox.ContentControlProperties.CheckedState + 'Set font for checked state value + checkBoxCheckedState.Font = "Calibri" + 'Set symbol for checked state value + checkBoxCheckedState.Value = "C" + 'Get unchecked state of checkbox + Dim checkBoxUncheckedState As CheckBoxState = checkBox.ContentControlProperties.UncheckedState + 'Set font for unchecked state value + checkBoxUncheckedState.Font = "Calibri" + 'Set symbol for unchecked state value + checkBoxUncheckedState.Value = "U" + 'Set the state for checkbox + checkBox.ContentControlProperties.IsChecked = true + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close + + + + + + Compare the properties of content control + + + + + + + Gets or sets a font name for the checked state or unchecked state of the checkbox content control. + + + + + Gets or sets a value represents symbol for the checked state or unchecked state of the checkbox content control. + + + + + Represents the data binding for Content controls. + + + + + + Deletes the XML mapping from the parent content control. + + + + + + Replace the XML value with replacementText + + The document + The inlne content control + The inline content control + The text need to modify or not + To ensure whether the value for content control gets from custom xml or not + To ensure whether the value for content control gets by processing root element + To ensure whether the value for content control gets by processing core property + To ensure whether mapped custom xml has value + + + + + Replace the XML value with replacementText + + The document + The block content control + The root element of block content control + The text need to modify or not + To ensure whether the value for content control gets by processing root element + To ensure whether the value for content control gets by processing core property + To ensure whether mapped custom xml has value + + + + + Get the XmlNamespaceManager using the prefix mapping or xml document. + + Current XML document + Content control prefix mapping value + Returns, the XmlNamespaceManager + + + + Add the namespace to the XmlNamespaceManager by processing each node. + + Node to process + The XmlNameSpaceManager + Index value for namespace + + + + Checks whether the namespace uri exists in the namespace manager + + The XmlNamespaceManager + URI value + True, if the namespacemanager has uri value else false. + + + + Gets the list path + + + + + Sets the resultant builtin property value to the content control + + + + + Gets the index from the node path + + + + + Update the XML value with replacementText + + + + + + + + Update the XML value with replacementText + + + + + + + + Replace the XML value with replacementText + + The document + The inline content control + The documeny custom XML container + The mapped XML part in custom xml + The replacement text + + + + Replace the XML value with replacementText + + The document + The block content control + The documeny custom XML container + The mapped XML part in custom xml + The replacement text + + + + + Save the text replaced document and replace the custom XML stream + + + + + + + + Returns a Boolean that represents whether the content control in the document is mapped to an XML node in the document�s XML data. Read-only. + + + + + �Returns a string that represents the prefix mappings used to evaluate the XPath for the current XML mapping. Read-only. + + + + + + Gets or sets a value indicating the color of the content control + + + + + Returns a object that represents the custom XML part to which the content control in the document maps. + + + + + Returns a object that represents the custom XML node in the data store to which the content control in the document maps. + + + + + Returns a Boolean that represents whether the mapped content is WordML format or not. + + You can map WordML format or simple text, if data binding of content control supports WordML ("w:14:databinding" or "w:15:databinding" in file level). + If true, then mapped content is WordML and preserved as text body item. + If false, then mapped contents in not WordML and it is normal string or other + In future, if changing this API behavior need to ensure Document Editor side cases also. + + + + Returns a Boolean that represents whether the mapped content control supports WordML format to map or not. + + You can map WordML format or simple text, if data binding of content control supports WordML ("w:14:databinding" or "w:15:databinding" in file level). + If true, then content control preserves WordML content as text body item. + If false, then content control preserves WordML content as normal string. + + + + Represents the custom XML part in the Word document. + + + + + Initializes the Custom XML Part. + + A Word document. + + + + + Loads the from the given XML file path. + + Specifies XML file path. + The following code illustrates how to load XML file to CustomXMLPart. + + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add new XmlPart to the section + CustomXMLPart xmlPart = new CustomXMLPart(document); + //Load the xml code. + xmlPart.Load(@"F:\XmlFile.xml"); + //Add new content control to the paragraph. + InlineContentControl control = paragraph.AppendInlineContentControl(ContentControlType.Text) as InlineContentControl; + control.ContentControlProperties.XmlMapping.SetMapping("/books/book/author", "", xmlPart); + //Select the single node. + CustomXMLNode node = xmlPart.SelectSingleNode(control.ContentControlProperties.XmlMapping.XPath); + //Append text to second paragraph. + control = paragraph.AppendInlineContentControl(ContentControlType.Text) as InlineContentControl; + //Save the Word document + document.Save("Sample.docx", FormatType.Docx); + //Close the document + document.Close(); + + + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add new XmlPart to the section + Dim xmlPart As New CustomXMLPart(document) + 'Load the xml code. + xmlPart.Load(@"F:\XmlFile.xml"); + 'Append text to second paragraph. + control = TryCast(paragraph.AppendInlineContentControl(ContentControlType.Text), InlineContentControl) + 'Save the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Close the document + document.Close() + + + + + + Loads the from the XML string. + + Specifies XML stream. + + + + Adds a new node to the CustomXMLPart under the mentioned parent node. + + Represents the node under which this node should be added. If adding an attribute, the parameter denotes the element that the attribute should be added to. + Represents the base name of the node to be added. + Specifies the type of node to append. + Used to set the value of the appended node for those nodes that allow text. + + + + + + Represents the custom XML node in the custom XML part. + + + + + Deletes the current node from the tree (including all of its children, if any exist). + + The following code illustrates how to delete from its parent. + + + + Selects a single node from a collection matching an XPath expression. + + Xpath of to be selected. + Returns the node from a collection matching an XPath expression. + The following code illustrates how to select single node from based on XPath + + + + + + Removes the specified child node (and its subtree) from the main tree. + + to be removed. + The following code illustrates how to remove child nodes of the + + + + + + + + + + + Gets the parent element node of the current node.Read-only. + + + + + Represents the appearance of the content control. + + + + + Represents BoundingBox appearance. + + + + + Represents Tags appearance. + + + + + �Represents Hidden appearance. + + + + + Represents the date storage format for the selected date in Date Picker content control. + + + + + Represents the date as a date storage format. + + + + + Represents the date and time as a date storage format. + + + + + Represents the Text as a date storage format. + + + + + Specifies the type of content control. + + + + + Specifies a rich-text content control + + + + + Specifies a text content control + + + + + Specifies a picture content control + + + + + Specifies a combo box content control + + + + + Specifies a drop-down list content control + + + + + Specifies a building block gallery content control + + + + + Specifies a date content control + + + + + Specifies a group content control + + + + + Specifies a checkbox content control + + + + + Specifies a repeating section content control + + + + + Represents the calendar type of Date picker content control. + + + + + Represents the Gregorian calendar + + + + + Represents the GregorianArabic calendar + + + + + Represents the GregorianMiddleEastFrench calendar + + + + + Represents the GregorianEnglish calendar + + + + + Represents the GregorianTransliteratedEnglish calendar + + + + + Represents the GregorianTransliteratedFrench calendar + + + + + Represents the Hebrew calendar + + + + + Represents the Hijri calendar + + + + + Represents the Japan calendar + + + + + Represents the Korean calendar + + + + + Represents the Taiwan calendar + + + + + Represents the Thai calendar + + + + + Represents the Saka calendar + + + + + + + + + + Represent a style of paragraph items. + + + + + Initializes a new instance of the class. + + The object. + + + + Clones the , creating duplicate style. + + The object. + + + + Gets the base style. + + + + + Gets the type of the style. + + The specifies the type of the style. + + + + Represents a conditional style of table. + + + + + Initializes a new instance of the ConditionalFormattingStyle class. + + The conditionCode. + The doc. + + + + Clones the , creating duplicate style. + + The object. + + + + Clones itself. + + Returns cloned object. + + + + Closes this instance. + + + + + Gets paragraph format. + + + + + + Gets cell properties. + + + + + + Gets row properties. + + + + + + Gets table properties. + + + + + + Gets conditional formatting code. + + + + + + Gets the type of the style. + + The member that specifies the type of the style. + + + + Represents a collection of . + + + + + + + + + + + + + Gets the at the specified index. + + + + + + Represents a list style in the Word document. + + + The following code example demonstrates how to + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Create a new list numbered list style + ListStyle listStyle = new ListStyle(document, ListType.Numbered); + //Set the name for the new list style + listStyle.Name = "UserdefinedList"; + WListLevel levelOne = listStyle.Levels[0]; + //Define the follow character, prefix, suffix, start index for level 0 + levelOne.FollowCharacter = FollowCharacterType.Tab; + levelOne.NumberPrefix = "("; + levelOne.NumberSufix = ")"; + levelOne.PatternType = ListPatternType.LowRoman; + levelOne.StartAt = 1; + levelOne.TabSpaceAfter = 5; + levelOne.NumberAlignment = ListNumberAlignment.Center; + document.ListStyles.Add(listStyle); + //Add new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Add text to the paragraph + paragraph.AppendText("The list of pets available:"); + //Add other paragraphs and apply the created new list style + paragraph = section.AddParagraph(); + //Apply default numbered list style + paragraph.ListFormat.ApplyStyle("UserdefinedList"); + paragraph.AppendText("Dog"); + paragraph = section.AddParagraph(); + + paragraph.ListFormat.ApplyStyle("UserdefinedList"); + paragraph.AppendText("Cat"); + //Continue last defined list + paragraph.ListFormat.ContinueListNumbering(); + paragraph = section.AddParagraph(); + + paragraph.ListFormat.ApplyStyle("UserdefinedList"); + paragraph.AppendText("Hamsters"); + paragraph.ListFormat.ContinueListNumbering(); + + paragraph.ListFormat.ApplyStyle("UserdefinedList"); + paragraph.AppendText("Turtles"); + paragraph.ListFormat.ContinueListNumbering(); + paragraph = section.AddParagraph(); + + paragraph.ListFormat.ApplyStyle("UserdefinedList"); + paragraph.AppendText("Guinea Pigs"); + paragraph.ListFormat.ContinueListNumbering(); + paragraph = section.AddParagraph(); + + paragraph.ListFormat.ApplyStyle("UserdefinedList"); + paragraph.AppendText("Ferrets"); + paragraph.ListFormat.ContinueListNumbering(); + paragraph = section.AddParagraph(); + + paragraph.ListFormat.ApplyStyle("UserdefinedList"); + paragraph.AppendText("Fish"); + paragraph.ListFormat.ContinueListNumbering(); + + //Save and close the Word document + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Create a new list numbered list style + Dim listStyle As New ListStyle(document, ListType.Numbered) + 'Set the name for the new list style + listStyle.Name = "UserdefinedList" + Dim levelOne As WListLevel = listStyle.Levels(0) + 'Define the follow character, prefix, suffix, start index for level 0 + levelOne.FollowCharacter = FollowCharacterType.Tab + levelOne.NumberPrefix = "(" + levelOne.NumberSufix = ")" + levelOne.PatternType = ListPatternType.LowRoman + levelOne.StartAt = 1 + levelOne.TabSpaceAfter = 5 + levelOne.NumberAlignment = ListNumberAlignment.Center + document.ListStyles.Add(listStyle) + 'Add new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Add text to the paragraph + paragraph.AppendText("The list of pets available:") + 'Add other paragraphs and apply the created new list style + paragraph = section.AddParagraph() + 'Apply default numbered list style + paragraph.ListFormat.ApplyStyle("UserdefinedList") + paragraph.AppendText("Dog") + paragraph = section.AddParagraph() + + paragraph.ListFormat.ApplyStyle("UserdefinedList") + paragraph.AppendText("Cat") + 'Continue last defined list + paragraph.ListFormat.ContinueListNumbering() + paragraph = section.AddParagraph() + + paragraph.ListFormat.ApplyStyle("UserdefinedList") + paragraph.AppendText("Hamsters") + paragraph.ListFormat.ContinueListNumbering() + paragraph = section.AddParagraph() + + paragraph.ListFormat.ApplyStyle("UserdefinedList") + paragraph.AppendText("Turtles") + paragraph.ListFormat.ContinueListNumbering() + paragraph = section.AddParagraph() + + paragraph.ListFormat.ApplyStyle("UserdefinedList") + paragraph.AppendText("Guinea Pigs") + paragraph.ListFormat.ContinueListNumbering() + paragraph = section.AddParagraph() + + paragraph.ListFormat.ApplyStyle("UserdefinedList") + paragraph.AppendText("Ferrets") + paragraph.ListFormat.ContinueListNumbering() + paragraph = section.AddParagraph() + + paragraph.ListFormat.ApplyStyle("UserdefinedList") + paragraph.AppendText("Fish") + paragraph.ListFormat.ContinueListNumbering() + + 'Save and close the Word document + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + + + + + + List bullets type + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class with the specified + instance and the . + + The object. + The type of the list. + + + + Initializes a new instance of the class. + + The doc. + Type of the list. + if it specifies one level list, set to true. + + + + Initializes a new instance of the class. + + The doc. + + + + Creates a new empty list style for the specified document, with the list type and single level option. + + The object. + The for the new list style. + The boolean value specifying whether this list should have only one level. + The newly created instance. + + + + Creates a duplicate copy of this object. + + The reference of the newly created object. + + + + Closes this instance. + + + + + Creates a duplicate copy of this instance. + + + The reference of the new instance. + + + + Registers child objects in XDSL holder. + + + + + + Writes object data as xml attributes. + + + The object. + + + + Reads object data from xml attributes. + + + The object. + + + + + + + + + Returns the with the specified level number. + + The integer that specifies the level number. + The instance at the specified level number. + The level number cannot be less than zero. + When the specified level number is greater than the number of levels in the list, + then the last level in the list will be returned. + + + + + + + + + + + Clones the relations. + + The doc. + + + + + Remove the style from m_uniqueNameCollection in document ListStyles. + + True if style removed from m_uniqueNameCollection in document ListStyles else false + + + + Update the m_uniqueNameCollection based on style new name. + + + + + Compares list style with current list style. + + The list style. + + + + Check whether the genreated list ID or name already contains or not. + + Destination document list styles + Current list ID + Current list name + + + + + Sets new unique name for list style. + + + + + + Sets the new unique list id for the List style. + + + + + Gets or sets the unique id for the list style. + + + + + Gets or sets the value for styleLink attribute of abstractNum definitions. + + + + + Gets or sets the name for the list style. + + The string that represents the style name. + + + + Gets or sets the list type. + + The member that specifies the list type. + + + + Gets the collection of the levels in the list. Read-only. + + The collection of list levels. + + + + Gets the type of the list style. Read-only. + + The member that specifies the type of the style. + + + + Gets or sets a value indicating whether this list style is hybrid multilevel/simple. + + + if this instance is hybrid multilevel, set to true. + + + + + Gets or sets a value indicating whether the list style is simple. + + if this instance is simple, set to true. + + + + Gets or sets a value indicating whether this instance is built in style. + + + if this instance is built in style, set to true. + + + + + Gets or Sets the base list style identifier. + + The base list style id. + + + + Represents a list level. + + + + + List numbering strings + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Used to maintain the list level text. + + + + + + + + + + + + + + + + + Create level layout data + + + + + + + + Gets list symbol for specified item index + + + + + + + Gets list symbol for specified item index + + + + + + + Clones this instance. + + + + + + Create default bullet level. + + + + + + + + + Create default numbered level. + + + + + Clones itself. + + + Returns cloned object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Closes this instance. + + + + + Compares List Level + + + + + Removes the GUID appended with the style name + + The found style name + + + + Checks the number prefix and suffix. + + The prefix or suffix of level. + + + + + Reads object data from xml attributes. + + + The object. + + + + Writes object data as xml attributes. + + + The object. + + + + Serialize paragraph and character properties. + + + + + + Gets or sets a constant that represents the alignment for the list level of the list template. + + + + + Gets or sets the starting number for the specified list level. + + + + + Gets or or sets the character inserted after the number for the specified list level. + + + + + Gets or sets the position (in points) for the second line of wrapping text for the specified list level. + + + + + Gets or sets the string inserted before the number for the specified list level. + + + + + Gets or sets the string inserted after the number for the specified list level. + + + + + Gets or sets the string inserted after the number for the specified list level. + + + The following code snippet illustrates how to set the suffix after the number for the specified list level. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Creates a new Word document + WordDocument document = new WordDocument(); + //Adds new section to the document + IWSection section = document.AddSection(); + //Adds new list style to the document + ListStyle listStyle = document.AddListStyle(ListType.Numbered, "UserDefinedList"); + WListLevel levelOne = listStyle.Levels[0]; + //Defines the follow character, prefix, suffix, start index for level 0 + levelOne.FollowCharacter = FollowCharacterType.Tab; + levelOne.NumberPrefix = "("; + levelOne.NumberSuffix = ")"; + //Adds new paragraph to the section + IWParagraph paragraph = section.AddParagraph(); + //Adds text to the paragraph + paragraph.AppendText("User defined list - Level 0"); + //Applies default numbered list style + paragraph.ListFormat.ApplyStyle("UserDefinedList"); + //Saves the Word document + document.Save("Sample.docx", FormatType.Docx); + //Closes the document + document.Close(); + } + + + Private Sub Button1_Click(sender As System.Object, e As System.EventArgs) + 'Creates a new Word document + Dim document As New WordDocument() + 'Adds new section to the document + Dim section As IWSection = document.AddSection() + 'Adds new list style to the document + Dim listStyle As ListStyle = document.AddListStyle(ListType.Numbered, "UserDefinedList") + Dim levelOne As WListLevel = listStyle.Levels(0) + 'Defines the follow character, prefix, suffix, start index for level 0 + levelOne.FollowCharacter = FollowCharacterType.Tab + levelOne.NumberPrefix = "(" + levelOne.NumberSuffix = ")" + 'Adds new paragraph to the section + Dim paragraph As IWParagraph = section.AddParagraph() + 'Adds text to the paragraph + paragraph.AppendText("User defined list - Level 0") + 'Applies default numbered list style + paragraph.ListFormat.ApplyStyle("UserDefinedList") + 'Saves the Word document + document.Save("Sample.docx", FormatType.Docx) + 'Closes the document + document.Close() + End Sub + + + + + + Gets or sets bullet character pattern for the specified list level. + + + + + Gets or sets a constant that represents the list pattern type for the specified list level. + + + + + Gets or sets a value indicating whether to restart the level's number sequence based on higher (more significant) levels in the list. + + True then restart the level's number sequence based on higher (more significant) levels in the list; otherwise, false. + + + + Gets the character formats of list symbol for the specified list level. + + + + + Gets or sets the paragraph format of the specified list level. + + + + + Gets the owner list style. + + + The owner list style. + + + + Gets previous list. + + + + + + Gets or sets a constant that represents the type of character following the number text for the specified list. + + + + + Gets or sets a value indicating whether to turns all inherited numbers to ArabaicNumberFormat property. The default is false. + + True then the level turns all inherited numbers to arabic; otherwise, false. + + + + Gets or sets the position (in points) of the number or bullet for the specified list level. + + + + + Gets or sets a value indicating whether to include previous levels for generated number. The default is false. + + True number generated will include previous levels; otherwise, false. + + + + Gets or sets a value indicating whether to use Word6 compatibility mode. The default is false. + + /// True to use Word6 compatibility mode; otherwise, false. + + + + Get/set level space value for Word6 compatibility mode. + + + + + Get/set level indent value for Word6 compatibility mode. + + + + + Gets or sets the name of the paragraph style. + + The name of the paragraph style. + + + + Gets or sets a value indicating whether level has level text in list level formatting string. + + if it has no level text, set to true. + + + + Gets the number of the level. + + The index of the level. + + + + Gets or sets a value indicating whether this instance has pic bullet. + + + + + Gets or sets the pic bullet id. + + The pic bullet id. + + + + + + + + + Gets or sets the level text (lvlText) of current list level. + As per the specification, level text(lvlText) is an string literal. + If string contains % symbol and level index matched with string (%1 is match for level 0), + then it will be incremented in list paragraphs. That means considered as list number. + If level text and index mismatched then Micrsoft Word will display level text as string in paragraph. + This scenario has more worst case combination behaviors. + Now we handled only the case level text value is greater than level index, if it contains % symbol + we reduce it's next number by one in Doc to PDF module as per Microsoft Word behavior. + TODO: Need to analyze all worst cases and handle the same in all required modules. + + + + + Represents a style of Numbering + + + + + Initializes a new instance of the class. + + The doc. + + + + Clones the , creating duplicate style. + + The object. + + + + Clones itself. + + Returns cloned object. + + + + Closes this instance. + + + + + Registers child objects in XDSL holder. + + + + + Compares the properties of current style with the specified one for document comparison + + + + + + + Gets paragraph format. + + + + + + Gets a base style of paragraph. + + + + + Gets the type of the style. + + The member that specifies the type of the style. + + + + Gets format of the list for the paragraph. + + + + + Gets or sets the index of the list. + + The index of the list. + + + + Gets or sets the list level. + + The list level. + + + + Represents a style of paragraph. + + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Create a new Word document + WordDocument document = new WordDocument(); + //Add new section to the document + IWSection section = document.AddSection(); + //Creates Paragraph styles. + WParagraphStyle style = document.AddParagraphStyle("Heading 1") as WParagraphStyle; + //Applies the base style. + style.ApplyBaseStyle("Normal"); + //Applies character formats. + style.CharacterFormat.FontName = "Calibri Light"; + style.CharacterFormat.FontSize = 16f; + style.CharacterFormat.TextColor = System.Drawing.Color.FromArgb(46, 116, 181); + //Applies paragraph formats. + style.ParagraphFormat.BeforeSpacing = 12; + style.ParagraphFormat.AfterSpacing = 0; + style.ParagraphFormat.Keep = true; + style.ParagraphFormat.KeepFollow = true; + style.ParagraphFormat.OutlineLevel = OutlineLevel.Level1; + //Add new paragraph + WParagraph paragraph = section.AddParagraph() as WParagraph; + //Apply style + paragraph.ApplyStyle("Heading 1"); + paragraph.AppendText("Applying paragraph style"); + //Save and close the Word document + document.Save("Sample1.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Create a new Word document + Dim document As New WordDocument() + 'Add new section to the document + Dim section As IWSection = document.AddSection() + 'Creates Paragraph styles. + Dim style As WParagraphStyle = TryCast(document.AddParagraphStyle("Heading 1"), WParagraphStyle) + 'Applies the base style. + style.ApplyBaseStyle("Normal") + 'Applies character formats. + style.CharacterFormat.FontName = "Calibri Light" + style.CharacterFormat.FontSize = 16.0F + style.CharacterFormat.TextColor = System.Drawing.Color.FromArgb(46, 116, 181) + 'Applies paragraph formats. + style.ParagraphFormat.BeforeSpacing = 12 + style.ParagraphFormat.AfterSpacing = 0 + style.ParagraphFormat.Keep = True + style.ParagraphFormat.KeepFollow = True + style.ParagraphFormat.OutlineLevel = OutlineLevel.Level1 + 'Add new paragraph + Dim paragraph As WParagraph = TryCast(section.AddParagraph(), WParagraph) + 'Apply style + paragraph.ApplyStyle("Heading 1") + paragraph.AppendText("Applying paragraph style") + 'Save and close the Word document + document.Save("Sample1.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Member that specifies the paragraph format. + + + + + + Member that specifies the list format. + + + + + + Initializes a new instance of the class with the specified + instance. + + The instance. + + + + Applies the base style for the current paragraph style. + + The name of the style to be applied. + + + + Creates a duplicate copy of the style. + + The reference to the newly created object. + + + + Compares the properties of current paragraph style with specified style. + + + + + Applies base style for current style. + + The base style + + + + + Gets the list format associated with the paragraph style. + If the current style or any of its base styles has a list format with a ListType other than NoList + or if it has an empty list, the list format is returned. + + + The object representing the list format associated with the paragraph style, + or null if no list format is found in the current style or any of its base styles. + + + + + Retrieves the list level number associated with the paragraph style. + Traverses the paragraph style hierarchy, starting from the current style, to find the first style + that has a list level number defined, and returns the list level number along with the corresponding style. + + + When this method returns, contains the object representing the style + that has the list level number defined, if found; otherwise, it will be set to null. + + + The list level number associated with the paragraph style, + or 0 if no list level number is found in the current style or any of its base styles. + + + + + Creates a duplicate copy of the entity. + + + An reference to the newly created object. + + + + Closes this instance. + + + + + Compares the properties of current style with the specified one for document comparison + + + + + + + Add the default format to the character and paragraph format in original document + + + + + + + + Registers child objects in XDSL holder. + + + + + + Gets the formatting of paragraph. Read-only. + + The instance that specifies the paragraph format. + + + + Gets the base style of the paragraph. Read-only. + + The instance that specifies the base style. + + + + Gets the type of the style. Read-only. + + The member that specifies the type of the style. + + + + Gets the format of the list for the paragraph. Read-only. + + The instance that specifies the list format. + + + + Gets or sets the index of the list. + + The index of the list. + + + + Gets or sets the list level. + + The list level. + + + + Represents a style of . + + + + + Initializes a new instance of the WTableStyle class. + + The doc. + + + + Create conditional formatting style for current style. + + + + + + + Apply base style for current style. + + The string that specifies the style name. + + + + Applies the base style for the current table style. + + The member that specifies the built-in table style. + + + using (WordDocument document = new WordDocument()) + { + document.EnsureMinimal(); + WTable table = document.LastSection.AddTable() as WTable; + table.ResetCells(3, 2); + table[0, 0].AddParagraph().AppendText("Hi"); + table[0, 1].AddParagraph().AppendText("Hi"); + //Adds a new custom table style + WTableStyle tableStyle = document.AddTableStyle("CustomStyle1") as WTableStyle; + //Applies conditional formatting for first row + ConditionalFormattingStyle firstRowStyle = tableStyle.ConditionalFormattingStyles.Add(ConditionalFormattingType.FirstRow); + firstRowStyle.CharacterFormat.Bold = true; + firstRowStyle.CharacterFormat.TextColor = Color.FromArgb(255, 255, 255, 255); + firstRowStyle.CellProperties.BackColor = Color.Blue; + //Applies conditional formatting for first column + ConditionalFormattingStyle firstColumnStyle = tableStyle.ConditionalFormattingStyles.Add(ConditionalFormattingType.FirstColumn); + firstColumnStyle.CharacterFormat.Bold = true; + //Applies conditional formatting for odd row + ConditionalFormattingStyle oddRowBandingStyle = tableStyle.ConditionalFormattingStyles.Add(ConditionalFormattingType.OddRowBanding); + oddRowBandingStyle.CellProperties.BackColor = Color.Red; + //Apply built in table style as base style for CustomStyle2 + tableStyle.ApplyBaseStyle(BuiltinTableStyle.TableContemporary); + //Applies the custom table style to the table + table.ApplyStyle("CustomStyle1"); + //Saves and closes the document instance + document.Save("TableStyle.docx", FormatType.Docx); + } + + + Dim document As WordDocument = New WordDocument() + document.EnsureMinimal() + Dim table As WTable = TryCast(document.LastSection.AddTable(), WTable) + table.ResetCells(3, 2) + table(0, 0).AddParagraph().AppendText("Hi") + table(0, 1).AddParagraph().AppendText("Hi") + 'Adds a new custom table style + Dim tableStyle As WTableStyle = TryCast(document.AddTableStyle("CustomStyle1"), WTableStyle) + 'Applies conditional formatting for first row + Dim firstRowStyle As ConditionalFormattingStyle = tableStyle.ConditionalFormattingStyles.Add(ConditionalFormattingType.FirstRow) + firstRowStyle.CharacterFormat.Bold = True + firstRowStyle.CharacterFormat.TextColor = Color.FromArgb(255, 255, 255, 255) + firstRowStyle.CellProperties.BackColor = Color.Blue + 'Applies conditional formatting for first column + Dim firstColumnStyle As ConditionalFormattingStyle = tableStyle.ConditionalFormattingStyles.Add(ConditionalFormattingType.FirstColumn) + firstColumnStyle.CharacterFormat.Bold = True + 'Applies conditional formatting for odd row + Dim oddRowBandingStyle As ConditionalFormattingStyle = tableStyle.ConditionalFormattingStyles.Add(ConditionalFormattingType.OddRowBanding) + oddRowBandingStyle.CellProperties.BackColor = Color.Red + 'Apply built in table style as base style for CustomStyle2 + tableStyle.ApplyBaseStyle(BuiltinTableStyle.TableContemporary) + 'Applies the custom table style to the table + table.ApplyStyle("CustomStyle1") + 'Saves and closes the document instance + document.Save("TableStyle.docx", FormatType.Docx) + document.Close() + + + + + + Checks the normal style. + + + + + Creates a duplicate copy of the style. + + The reference to the newly created style. + + + + Applies base style for current style. + + The base style + + + + + Creates a duplicate copy of the entity. + + + An object that can be casted as . + + + + Closes this instance. + + + + + To compare the table sytle of this object with another object. + + + + + Gets the paragraph format. + + The object. + + + + Gets the list format. + + + + + Gets cell properties. + + + + + + Gets row properties. + + + + + + Gets table properties. + + + + + + Gets base style of the current style. + + + + + Gets the type of the style. + + The member that specifies the type of the style. + + + + Gets conditional formatting styles collection of the table style. + + + + + Represents the part of the text body items. + + + + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Create the bookmark navigator instance to access the bookmark + BookmarksNavigator bookmarkNavigator = new BookmarksNavigator(document); + //Move the virtual cursor to the before the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind"); + //Get the bookmark content as a text body part. + TextBodyPart part = bookmarkNavigator.GetBookmarkContent(); + //Convert the textbody part as a separate Word document. + WordDocument new_document = part.GetAsWordDocument(); + //Save and close the document + new_document.Save("Sample.docx", FormatType.Docx); + document.Close(); + + + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Create the bookmark navigator instance to access the bookmark + Dim bookmarkNavigator As New BookmarksNavigator(document) + 'Move the virtual cursor to the before the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind") + 'Get the bookmark content as a text body part. + Dim part As TextBodyPart = bookmarkNavigator.GetBookmarkContent() + 'Convert the textbody part as a separate Word document. + Dim new_document As WordDocument = part.GetAsWordDocument() + 'Save and close the document + new_document.Save("Sample.docx", FormatType.Docx) + document.Close() + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the + specified . + + The instance. + + + + Initializes a new instance of the class with the specified + . + + The instance. + + + + Initializes a new instance of the class with the specified + . + + The instance. + + + + Clears the text body items. + + + + + Copies the text from the specified + and adds the text as new paragraph in the document. + + The to copy the text. + + + + Copies the text from the specified + and adds the text to the current . + + Find the field + + + + Copies the text from the specified + and adds the text to the current . + + The to copy the text. + + + + Copies the specified and + adds it to the current . + + The to copy the contents. + True if to clone and add the item; otherwise, false. + + + + Copies the specified and adds the item in a new paragraph + to the current . + + The to be copied. + True if to clone and add the item; otherwise, false. + + + + Returns the content of the text body part as a new Word document. + + The newly created instance. + + + + Clears all the contents of the text body part. + + + + + Copies the specified text body. + + The text body. + if it is to clone, set to true. + + + + Pastes the at the index next to it. + + The which is to be pasted. + + + + Pastes the after specified paragraph item index. + + The to be pasted. + + + + Pastes at specified at the specified index. + + The to be pasted. + The zero-based index to paste the text body. + + + + Pastes at specified position with character formatting. + + >The text body. + Index of the item. + Index of the p item. + Replace character format + if it specifies to apply the format, set to true. + + + + Pastes at specified position. + + The text body. + Index of the item. + Index of the p item. + + + //Open the template document + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Create the bookmark navigator instance to access the bookmark + BookmarksNavigator bookmarkNavigator = new BookmarksNavigator(document); + //Move the virtual cursor to the before the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind"); + //Get the bookmark content as a text body part. + TextBodyPart part = bookmarkNavigator.GetBookmarkContent(); + //Paste the content as first item in the second paragraph. + part.PasteAt(document.Sections[0].Body, 1, 0); + //Save and close the document + document.Save("Result.docx", FormatType.Docx); + document.Close(); + + + 'Open the template document + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Create the bookmark navigator instance to access the bookmark + Dim bookmarkNavigator As New BookmarksNavigator(document) + 'Move the virtual cursor to the before the end location of the bookmark "Northwind" + bookmarkNavigator.MoveToBookmark("Northwind") + 'Get the bookmark content as a text body part. + Dim part As TextBodyPart = bookmarkNavigator.GetBookmarkContent() + 'Paste the content as first item in the second paragraph. + part.PasteAt(document.Sections(0).Body, 1, 0) + 'Save and close the document + document.Save("Result.docx", FormatType.Docx) + document.Close() + + + + + + Pastes at end of textbody. + + The text body. + + + + Pastes at specified position. + + The text body. + Index of the item. + Index of the p item. + Set to true when performing bookmark replace functionality + + + + Paste the contents inside an inline content control. + + Represents an where to paste. + Index of in to paste the content. + + + + Paste the in + + Represents a which is destination to paste the contents. + Represents a to copy all its content and paste into the + + + + Paste the items from into an + + Represents an which is destination to paste. + Represents a which is source to copy its items + + + + Paste items from content control as normal text in the text type inline content control. + + Represents an to paste the items. + Represents to copy the items. + + + + Paste paragraph items from table into inline content control. + + to paste the text ranges from table. + to copy all its paragraph items. + + + + Paste a text range in inline content control and update the formattings. + + as desination to paste text range. + to paste. + + + + Copies the paragraph items. + + The source paragraph. + The dest paragraph. + + + + Splits the paragraph. + + The paragraph. + Index of the next paragraph item. + The paragraph to insert. + + + + Validates the args. + + + + + Splits the paragraph. + + The TRG first paragraph. + The SRC last paragraph. + + + + + Updates fromatting from source to destination. + + + + + + + + Ensures the text body. + + The doc. + + + + Applies the source format. + + The paragraph. + + + + Applies the source format. + + The Table. + + + + Gets the bookmark content in between various section/cell in the Word document + + Current bookmark start + Current bookamrk end + + + + Gets the owner section index + + The entity + + + + + Gets the bookmark content inside table after paragraph in same/multiple section. + + Bookmark start owner paragraph + Bookmark end owner paragraph + Current bookamark start + Current bookmark end + + + + Gets the bookmark content inside paragraph after table in single/multiple section + + Bookmark start owner paragraph + Bookmark end owner paragraph + Current bookmark start + Curretn bookmark end + + + + Gets the bookmark content inside table in single/multiple section + + Bookmark start owner paragraph + Bookmark end owner paragraph + Current bookmark start + Current bookmark end + Bookmark end cell is null,if bookmark end entity placed inside table next paragraph means set bookmark end cell + + + + Adds the textbody item from the cell, when bookmark end is at the nested table of same cell. + + Represents a + Represents a of + Represents an index of contains + Represents a of + + + + Copy the textbody items + + Start textbody index + End textbody index + The textbody + + + + Gets the bookmark content inside paragraph in single/multiple section. + + Bookmark start owner paragraph + Bookmark end owner paragraph + Current bookmark start + Current bookmark end + + + + Inserts the bookmark start textbody items into single text body + + Bookmark start owner paragraph owner index + Bookmark end owner paragraph owner index + Bookmark start owner textbody + Bookmark start next item index + Bookmark end previous item index + When bookmark start and end in paragraph set to true + When bookmark start owner section and bookmark end owner section index same, set to true + + + + Inserts the bookmark end owner textbody item into single textbody + + Bookmark end owner paragraph index + Bookmark end previous item index + Bookmark end owner text body + When true ,if the bookmark end entity is first item of it's owner paragraph + + + + To check the bookmark end entity is first item of it's owner paragraph + + Bookmark end owner paragraph + Current bookmark end + Bookmark end previous item index + + + + + Insert the in between section bodyitem into single textbody + + Bookmarkstart owner next section index + Bookmark end owner section index + Owner document + + + + Gets the collection text body items. Read-only. + + The instance. + + + + Represents a collections of sections. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the WordDocumentPart class and loads the content of the Word document to this instance + + The Word document to load into this + + + + Loads the content of the Word document to this instance. + + The document to load into the current word document part. + WordDocumentPart contains the copy of sections from the documents. When you modify the content of the WordDocumentPart, it does not affect the objects inside the document. + + + + Gets the content of document part as new Word document. + + The contains the content of this + + + + Closes all the contents of the document part. + + + + + Get the bookmark content in beween different text body + + Current bookmark start + Current bookmark end + + + + Gets the owner section + + Entity + + + + + Get the bookmark content in between paragraph after table + + Bookmark start owner paragraph + Bookmark end owner paragraph + Current bookmark start + Current bookmark end + + + + Get bookmark content in between table after paragraph in same/different section + + Bookmark start owner paragraph + Bookmark end owner paragraph + Current bookmark start + Current bookmark end + + + + Get the bookamrk content in between same/multiple table + + Bookmark start owner paragraph + Bookmark end owner paragraph + Current bookmark start + Current bookmark end + Bookmark end cell is null,if bookmark end entity placed inside table next paragraph means set bookmark end cell + //The previous sibling of bookmarkendparagraph is WTable,then get the bookmarkendcell from previous sibling of bookmarkend paragraph and get the last cell of the Table. + + + + Copy textbody items + + Textbodyitem start index + Textbodyitem end index + The textbody + The section + + + + Get the bookmark content inbetween same/different section paragraph. + + Bookmark start owner paragraph + Bookmark end owner paragraph + Current bookmark start + Current bookmark end + + + + If the bookmark content inside different section, combine bookmark end owner section to Sections collection + + Bookmark end owner paragraph index + Bookmark end previous item index + Bookmark end owner text body + When true ,if the bookmark end entity is first item of it's owner paragraph + + + + Insert the in between sections to section collection + + Bookmark start's next section index + Bookmark end section index + Owner document + + + + If the bookmark content inside different section, combine bookmark start owner section to Sections collection + + BookmarkStart owner paragraph index + Bookmark end owner paragraph index + Bookmark start owner textbody + Bookmark start next item index + Bookmark end previous item index + If the bookmark content preserved in single section set to true + + + + To check the bookmark end entity is first item of it's owner paragraph + + Bookmark end owner paragraph + Current bookmark end + Bookmark end previous item index + + + + + Gets the sections in the Word document part. Read-only. + + + + + Provides the functionalities to convert the Word document as text file. + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Returns the text contents of the specified as string. + + The instance. + The string that represents the text contents of the Word document. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open a new Word document + WordDocument document = new WordDocument("Template.docx"); + //Initialize a new instance of TextConverter class + TextConverter converter = new TextConverter(); + //Get the text contents from the template document + string text = converter.GetText(document); + //Create new Word document + WordDocument textDocument = new WordDocument(); + textDocument.EnsureMinimal(); + //Add the text to the newly created document + textDocument.LastParagraph.AppendText(text); + //Save and close the document. + textDocument.Save("Sample.txt", FormatType.Txt); + document.Close(); + textDocument.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open a new Word document + Dim document As New WordDocument("Template.docx") + 'Initialize a new instance of TextConverter class + Dim converter As New TextConverter() + 'Get the text contents from the template document + Dim text As String = converter.GetText(document) + 'Create new Word document + Dim textDocument As New WordDocument() + textDocument.EnsureMinimal() + 'Add the text to the newly created document + textDocument.LastParagraph.AppendText(text) + 'Save and close the document. + textDocument.Save("Sample.txt", FormatType.Txt) + document.Close() + textDocument.Close() + End Sub + + + + + + Writes the specified text contents as text file(.txt format). + + The instance to write the text file. + The to be converted as text file. + + + + Reads the text file and convert it to the specified . + + The instance to read the text file. + The instance to represent the text file. + + The following code example demonstrates how to write the text file content to Word document. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + FileStream fs = new FileStream("Result.txt", FileMode.Open, FileAccess.Read); + StreamReader reader = new StreamReader(fs); + reader.BaseStream.Position = 0; + //Create the new TextConverter + TextConverter txtConverter = new TextConverter(); + //Write the text file to document + txtConverter.Read(reader, document); + reader.Dispose(); + fs.Dispose(); + //Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + Dim fs As New FileStream("Result.txt", FileMode.Open, FileAccess.Read) + Dim reader As New StreamReader(fs) + reader.BaseStream.Position = 0 + 'Create the new TextConverter + Dim txtConverter As New TextConverter() + 'Write the text file to document + txtConverter.Read(reader, document) + reader.Dispose() + fs.Dispose() + 'Save and close the Word document instance + document.Save("Sample.docx", FormatType.Docx) + document.Close() + End Sub + + + + + + Reads the specified text. + + The text. + The document. + + + + + + + + + + Writes the specified header and footer body contents. + + + The instance. + + + + Writes the specified document content to the text file. + + + The instance content to write into text file. + + + + Writes the specified content to the text file. + + + The instance to write into the text file. + True if it is the last paragraph; otherwise, false. + + + + Writes the specified text content to the text file. + + + The instance to write into the text file. + + + + Writes the end of the section. + + + The instance. + True if it is the last section; otherwise, false. + + + + Writes the text contents to the text file. + + + The string that specifies the text to write into the text file. + + The following code example demonstrates how to write the document content to text file. + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Load an existing Word document into DocIO instance + WordDocument document = new WordDocument("Template.docx"); + FileStream fs = new FileStream("Result.txt", FileMode.OpenOrCreate, FileAccess.ReadWrite); + StreamWriter writer = new StreamWriter(fs); + //Create the new TextConverter + TextConverter txtConverter = new TextConverter(); + //Write the document to text file + txtConverter.Write(writer, document); + writer.Flush(); + writer.Dispose(); + fs.Dispose(); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Load an existing Word document into DocIO instance + Dim document As New WordDocument("Template.docx") + Dim fs As New FileStream("Result.txt", FileMode.OpenOrCreate, FileAccess.ReadWrite) + Dim writer As New StreamWriter(fs) + 'Create the new TextConverter + Dim txtConverter As New TextConverter() + 'Write the document to text file + txtConverter.Write(writer, document) + writer.Flush() + writer.Dispose() + fs.Dispose() + document.Close() + End Sub + + + + + + Writes the list to the text file. + + + The instance to get the list format. + + + + Writes new line in the text file. + + + + + + Updates the last paragraph. + + The document. + + + + Writes the content of the document to the text file. + + + + + Returns the footers referred by the current section + + Current section + Current section index + returns the footer referred by the current section by comparing the current and preceeding section + + + + Returns the header referred by the current section + + Current section + Current section index + returns the header referred by the current section by comparing the current and preceeding section + + + + Check if stream is utf8 encoded. + Notice: stream is read completely in memory! + + Stream to read from. + True if the whole stream is utf8 encoded. + + + + Determines whether the specified stream has extended ASCII character. + + The stream. + + true if the specified stream has extended ASCII character; otherwise, false. + + + + + Represents the IWarning and can be used to notify the warnings occurred in Word document to PDF conversion. + + + + + Shows the warning messages that describes the unsupported elements found while converting the specified Word document to PDF. + + The warnings. + + + + Represents the WarningInfo and it contains the Warning type and its description for the unsupported elements in Word document to PDF conversion. + + + + + The m_description of the warning + + + + + The m_warning type + + + + + Initializes a new instance of the class. + + The description. + Type of the warning. + + + + Gets the description about specified warning + + + The description. + + + + + Gets the warning type + + + The type of the warning. + + + + + Represents the page margins of the Word document. + + + + + storage of Left margin + + + + + storage of Right margin + + + + + storage of Top margin + + + + + storage of Bottom margin + + + + + Initializes a new instance of class. + + + + + Initializes a new instance of class with the specified left, top, right and bottom margin values in points. + + The value for left margin in points. + The value for top margin in points. + The value for right margin in points. + The value for bottom margin in points. + + + + Gets or sets the value of all the four on one call measured in points. + + The integer that specifies the margin values in points. + + + + Gets or sets the left margin value in points. + + The integer that specifies the left margin value in points. + + + + Gets or sets the right margin value in points. + + The integer that specifies the right margin value in points. + + + + Gets or sets the top margin value in points. + + The integer that specifies the right margin value in points. + + + + Gets or sets the bottom margin value in points. + + The integer that specifies the bottom margin value in points. + + + + Allow to check is all settings has the same value or not + + + + + Represents the page margins of the Word document. + + + + + Initialize the keys for the properties. + + + + + Initializes a new instance of class. + + + + + Initializes a new instance of class with the specified left, top, right and bottom margin values in points. + + The value for left margin in points. + The value for top margin in points. + The value for right margin in points. + The value for bottom margin in points. + + + + Creates a duplicate copy of the instance. + + The reference of the newly created instance. + + + + Returns the default values. + + + The integer that specifies the key. + An object that specifies the default value. + + + + Sets the margin values in oldpropertyhash. + + The value for left margin in points. + The value for top margin in points. + The value for right margin in points. + The value for bottom margin in points. + The value for gutter margin in points. + + + + Gets the property value. + + The property key. + The value. + + + + sets the property value. + + The prop key. + + + + + Compares the current section properties with another section properties + + The paragraph format + + + + Gets or sets the value of all the four on one call measured in points. + + The float that specifies the margin values in points. + + + + Gets or sets the left margin value in points. + + The float that specifies the left margin value in points. + + + + Gets or sets the right margin value in points. + + The float that specifies the right margin value in points. + + + + Gets or sets the top margin value in points. + + The float that specifies the top margin value in points. + + + + Gets or sets the bottom margin value in points. + + The float that specifies the bottom margin value in points. + + + + Allow to check is all settings has the same value or not + + + + + Gets/sets section gutter. + + + + + Represents the information about page size. + + + + + Specifies A3 format page size. + + The structure that represent the size of the page. + + + + Specifies A4 format page size. + + The structure that represent the size of the page. + + + + Specifies A5 format page size. + + The structure that represent the size of the page. + + + + Specifies A6 format page size. + + The structure that represent the size of the page. + + + + Specifies B4 format page size. + + The structure that represent the size of the page. + + + + Specifies B5 format page size. + + The structure that represent the size of the page. + + + + Specifies B5 format. page size. + + The structure that represent the size of the page. + + + + Specifies Letter format page size. + + The structure that represent the size of the page. + + + + Specifies HalfLetter format page size. + + The structure that represent the size of the page. + + + + Specifies 11x17 format page size. + + The structure that represent the size of the page. + + + + Specifies EnvelopeDL format page size. + + The structure that represent the size of the page. + + + + Specifies Quarto format page size. + + The structure that represent the size of the page. + + + + Specifies Statement format page size. + + The structure that represent the size of the page. + + + + Specifies Ledger format page size. + + The structure that represent the size of the page. + + + + Specifies Tabloid format page size. + + The structure that represent the size of the page. + + + + Specifies Note format page size. + + The structure that represent the size of the page. + + + + Specifies Legal format page size. + + The structure that represent the size of the page. + + + + Specifies Flsa format page size. + + The structure that represent the size of the page. + + + + Specifies Executive format page size. + + The structure that represent the size of the page. + + + + Private constructor. + + + + + Provides functions for unit conversions. + + + + + Converts centimeter to points. + + The float that represents the value in centimeter. + The float that specifies the value in points. + + + + Converts inch to points. + + The float that represents the value in inch. + The float that specifies the value in points. + + + + Converts pixel to points. + + The float that represents the value in pixel. + The float that specifies the value in points. + + + + Summary description for WordMLtoDocIOConverter. + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Converts the specified word as ml. + + The path to word ML. + + + + + Corrects the XML. + + + + + Modifies the paragraph. + + + + + Modifies the bookmark. + + The bookmark. + + + + Modifies the picture. + + The picture. + + + + Initialize the namespace manager. + + + + + Gets the XSLT reader. + + + + + + Reads the binary element. + + The node. + + + + + Reads the image. + + The node. + if it is meta file, set to true. + + + + + + + + + + + + + + + + + + + + Gets or sets the name. + + The name. + + + + Gets or sets the ID. + + The ID. + + + + + + + + + + + + + + Adds an object to the end of the . + + The to be added to the end of the . The value can be . + + The index at which the has + been added. + + + The is read-only. + -or- + The has a fixed size. + + + + + Adds the bookmark. + + The name. + + + + + Gets the with the specified name. + + + + + + Summary description for IXDLSAttributeWriter. + + + + + Writes the value. + + The name. + The value. + + + + Writes the value. + + The name. + The value. + + + + Writes the value. + + The name. + The value. + + + + Writes the value. + + The name. + The value. + + + + Writes the value. + + The name. + The value. + + + + Writes the value. + + The name. + if it specifies value, set to true. + + + + Writes color as string to XML. + + Name of attribute. + Color structure. + + + + Writes DateTime as string to XML. + + Name of attribute. + Color structure. + + + + Summary description for IXDLSAttributeReader. + + + + + Determines whether the current node has attribute with specified name. + + The name. + + if has attribute with specified name, set to true. + + + + + Reads the string. + + The name. + + + + + Reads the int. + + The name. + + + + + Reads the short. + + The name. + + + + + Reads the float. + + The name. + + + + + Reads the boolean. + + The name. + + + + + Reads the byte. + + The name. + + + + + Reads the enum. + + The name. + Type of the enum. + + + + + Reads color from XML. + + Name of attribute. + + + + + Reads the date time. + + The s. + + + + + Summary description for IXDLSContentWriter. + + + + + Writes the child binary element. + + The name. + The value. + + + + Writes the child string element. + + The name. + The value. + + + + Writes the child element. + + The name. + The value. + + + + Writes the child ref element. + + The name. + The ref to element. + + + + Gets the inner writer. + + The inner writer. + + + + Summary description for IXDLSContentReader. + + + + + Gets the attribute value. + + The name. + + + + + Parses the type of the element. + + Type of the enum. + Type of the element. + + + + + Reads the child element. + + The value. + + + + + Reads the child element. + + The type. + + + + + Reads the content of the child string. + + + + + + Reads the child binary element. + + + + + + Gets the name of the tag. + + The name of the tag. + + + + Gets the type of the node. + + The type of the node. + + + + Gets the inner reader. + + The inner reader. + + + + Gets the attribute reader. + + The attribute reader. + + + + Summary description for IXDLSFactory. + + + + + Creates the specified reader. + + The reader. + + + + + Utility class. Holds string names of the properties, used for serialization. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + Name of the property. + + + + + This constructor is bever used. + + + + + Constants used in DLS for serialization to XML format + + + + + Document tag names + + + + + The styles tag + + + + + The list styles tag + + + + + Section tag names + + + + + The page setup tag + + + + + The page setup first page attribute + + + + + The page setup difference odd even pages attribute + + + + + The columns tag + + + + + The column tag + + + + + The paragraphs tag + + + + + The headers footers tag + + + + + The text body tag + + + + + The toc field tag + + + + + Section attribute names + + + + + Style tag names + + + + + The character format tag + + + + + The paragraph format tag + + + + + The table format tag + + + + + The cell format tag + + + + + The list format tag + + + + + The style base tag + + + + + The shape format tag + + + + + List tag and attribute names + + + + + The list levels tag + + + + + The list level internal data tag + + + + + The list level preference pattern attribute + + + + + The list level suf pattern attribute + + + + + The list level bullet pattern attribute + + + + + The list level indent attribute + + + + + The list level previous pattern attribute + + + + + The list level pattern type attribute + + + + + The list level start at attribute + + + + + The list level number align attribute + + + + + The list level follow character attribute + + + + + The list level is legal attribute + + + + + The list level no restart number + + + + + List style attributes names + + + + + The list format level number attribute + + + + + The list format style name attribute + + + + + Style attribute names + + + + + The style base name attribute + + + + + Pen attribute names + + + + + The pen brush attribute + + + + + PageSettings attribute names + + + + + The page settings page width attribute + + + + + The page settings alignment attribute + + + + + The page settings footer distance attribute + + + + + The page settings header distance attribute + + + + + The page settings orientation attribute + + + + + The page settings bottom margin attribute + + + + + The page settings top margin attribute + + + + + The page settings left margin attribute + + + + + The page settings right margin attribute + + + + + The page settings spacing before columns attribute + + + + + HeadersFooters attribute names + + + + + The odd header tag + + + + + The even footer tag + + + + + The odd footer tag + + + + + The first page header tag + + + + + The first page footer tag + + + + + Tables tag names + + + + + The columns item tag + + + + + The cell item tag + + + + + The cells item tag + + + + + The row item tag + + + + + The rows item tag + + + + + Tables attribute names + + + + + The table horizontal alignment attribute + + + + + The table vertical merge attribute + + + + + The table horizontal merge attribute + + + + + The table width attribute + + + + + The table cell width attribute + + + + + The table cell shading color attribute + + + + + The table row heigth attribute + + + + + The table row header attribute + + + + + The table row heigh type attribute + + + + + The table left indent attribute + + + + + The table cell paddings attribute + + + + + The cell spacing + + + + + The left offset + + + + + The cell text wrap attribute + + + + + The cell same paddings as table attribute + + + + + The table cell texture attribute + + + + + The table cell fore color attribute + + + + + The table cell fit text attribute + + + + + The table cell text dir attribute + + + + + Paragraph tag names + + + + + The items tag + + + + + The item tag + + + + + The item type paragraph value + + + + + The item type table value + + + + + ParagraphFormat attribute names + + + + + The paragraph horizontal alignment attribute + + + + + The paragraph vertical alignment attribute + + + + + The paragraph left indent attribute + + + + + The paragraph right indent attribute + + + + + The paragraph first line indent attribute + + + + + The paragraph keep attribute + + + + + The paragraph before spacing attribute + + + + + The paragraph after spacing attribute + + + + + The paragraph keep follow attribute + + + + + The paragraph widow control attribute + + + + + The paragraph page break before attribute + + + + + The paragraph page break after attribute + + + + + The paragraph column break after attribute + + + + + The paragraph back color attribute + + + + + The paragraph bidi attribute + + + + + Tab attribute name + + + + + The tab justification attribute + + + + + The tab leader attribute + + + + + The tab tag + + + + + The automatic tab width attribute + + + + + The tab delete attribute + + + + + Shape tag names + + + + + Column attribute names + + + + + The column spacing attribute + + + + + Image tag names + + + + + Image attribute names + + + + + Width scale attributes. + + + + + Name of the property. + + + + + Image quality attributes names. + + + + + The picture contrast attribute + + + + + The picture color attribute + + + + + The crop from left + + + + + The crop from right + + + + + The crop from top + + + + + The crop from bottom + + + + + TextRange tag name + + + + + TextRange child tag names + + + + + Type tag + + + + + Paddings tag names + + + + + The padding top tag + + + + + The padding left tag + + + + + The padding right tag + + + + + Borders tag names + + + + + The border top tag + + + + + The border left tag + + + + + The border right tag + + + + + The border horizontal tag + + + + + The border vertical tag + + + + + The borders item tag + + + + + Borders attribute names + + + + + The border width attribute + + + + + The border type attribute + + + + + The border space attribute + + + + + The border shadow attribute + + + + + CharacterFormat attribute names + + + + + The text font name attribute + + + + + The text font size attribute + + + + + The text bold attribute + + + + + The text italic attribute + + + + + The text strike attribute + + + + + The text double strike attribute + + + + + The text underline attribute + + + + + The text sub super script attribute + + + + + The text line spacing attribute + + + + + The text position attribute + + + + + The text background color attribute + + + + + The text line break attribute + + + + + TextBox tag name + + + + + TextBoxFormat attribute names + + + + + The shape height attribute + + + + + The shape line style attribute + + + + + The shape text wrapping style attribute + + + + + The shape fill color attribute + + + + + The shape line color attribute + + + + + TextBoxes tag + + + + + The text boxes tag + + + + + Bookmark attributes name + + + + + The bookmark + + + + + The cell group bookmark attribute + + + + + Hyperlink attribute names + + + + + The URI + + + + + The hyperlink type + + + + + The hyperlink + + + + + Picture formatting tag. + + + + + Break atrribute names. + + + + + The protection type attribute + + + + + The shade form data attribute + + + + + The macros tag + + + + + The escher containers tag + + + + + The escher data conatiners tag + + + + + The macro commands tag + + + + + DOP internal data + + + + + The DOP dxa hot z attribute + + + + + The DOP consec attribute + + + + + The DOP internal data + + + + + Standard font names + + + + + The standard far east font + + + + + The standard non far east font + + + + + Merge field attribute names. + + + + + The field converted attribute + + + + + The merge field text before attribute + + + + + The merge field text after attribute + + + + + The merge field number format attribute + + + + + The merge field date format attribute + + + + + The merge field prefix attribute + + + + + The field upper case attribute + + + + + The field lower case attribute + + + + + The field title case attribute + + + + + The field first capital attribute + + + + + The field is local attribute + + + + + The field type attribute + + + + + The field name attribute + + + + + The field value attribute + + + + + The field mark type attribute + + + + + The field formatting attribute + + + + + Attribute name for embedded object storage name containing + + + + + FormField attribute names. + + + + + The form field maximum length attribute + + + + + The form field CheckBox size attribute + + + + + The form field CheckBox size type + + + + + The form field title attribute + + + + + The form field definition text attribute + + + + + The form field default CheckBox value attribute + + + + + The form field default drop down value attribute + + + + + The form field text format attribute + + + + + The form field string text format attribute + + + + + The form field help attribute + + + + + The form field tooltip attribute + + + + + The form field macro on start attribute + + + + + The form field macro on end attribute + + + + + The form field is special attribute + + + + + The form field text type attribute + + + + + FormField attribute names. + + + + + The form field drop down item text attribute + + + + + Document properties tag names. + + + + + The custom properties tag + + + + + The property tag + + + + + The character styles tag + + + + + The text character style name + + + + + The list overrides tag + + + + + Styles attributes. + + + + + Document properties attribute names. + + + + + The properties manager attribute + + + + + The properties category attribute + + + + + The properties bytes count attribute + + + + + The properties lines count attribute + + + + + The properties paragraph count attribute + + + + + The properties slide count attribute + + + + + The properties note count attribute + + + + + The properties hidden count attribute + + + + + The properties author attribute + + + + + The properties application name attribute + + + + + The properties title attribute + + + + + The properties subject attribute + + + + + The properties keywords attribute + + + + + The properties comments attribute + + + + + The properties template attribute + + + + + The properties last author attribute + + + + + The properties revision number attribute + + + + + The properties edit time attribute + + + + + The properties last printed attribute + + + + + The properties create date attribute + + + + + The properties last save date attribute + + + + + The properties page count attribute + + + + + The properties word count attribute + + + + + The properties character count attribute + + + + + The properties thumbnail attribute + + + + + The properties document security attribute + + + + + Property attribute names. + + + + + The properties name attribute + + + + + The properties value attribute + + + + + Attributes for ListFormatting. + + + + + The list format use base style attribute + + + + + The list format lfo style name attribute + + + + + The list format hybrid attribute + + + + + The list format simple attribute + + + + + The list level legacy attribute + + + + + The list level legacy space attribute + + + + + The list level legacy indent attribute + + + + + The level override tag + + + + + The level override start at attribute + + + + + The level override format attribute + + + + + The level override start attribute + + + + + The level override reserved1 attribute + + + + + The level override reserved2 attribute + + + + + The level override reserved3 attribute + + + + + The override list levels tag + + + + + The override list level tag + + + + + The override list style tag + + + + + The override list style name attribute + + + + + The override list res1 attribute + + + + + The override list res2 attribute + + + + + The override list unused1 attribute + + + + + The override list unused2 attribute + + + + + Table`s attributes names. + + + + + The table is break across pages attribute + + + + + The table bidi attribute + + + + + Internal Data. + + + + + ShapeObject tags. + + + + + The shape blip tag + + + + + The shape fbse tag + + + + + The picture descriptor tag + + + + + ShapeObjject attribute names + + + + + The shape object OLE cont identifier + + + + + WCharacterFormat attribute names. + + + + + The text emboss attribute + + + + + The text engrave attribute + + + + + The text hidden attribute + + + + + The text hidden complex attribute + + + + + The text d strike complex attribute + + + + + The text small caps complex attribute + + + + + The text strike complex attribute + + + + + The text all caps attribute + + + + + The text small caps attribute + + + + + The text bidi attribute + + + + + The text bold bidi attribute + + + + + The text italic bidi attribute + + + + + The text font size bidi attribute + + + + + The text font name bidi attribute + + + + + The text font name ASCII attribute + + + + + The text font name far east attribute + + + + + The text font name non far east attribute + + + + + The text highlight color key + + + + + The text italic complex key + + + + + The text shadow complex attribute + + + + + The text bold complex key + + + + + The text rg lid0 attribute + + + + + The text rg lid1 attribute + + + + + The text rg lid3 attribute + + + + + The text rg lid3 2 attribute + + + + + The text lid attribute + + + + + The text lid bi attribute + + + + + The text no proof attribute + + + + + The text idct hint attribute + + + + + The text all caps complex key + + + + + The text texture attribute + + + + + The text fore color attribute + + + + + The text out line attribute + + + + + The text emboss complex + + + + + The text engrave complex + + + + + WCharacterFormat tag names. + + + + + ParagraphFormat attribute names. + + + + + The paragraph line spacing rule attribute + + + + + ViewSetup tag names. + + + + + ViewSetup attribute names. + + + + + The view setup zoom type attribute + + + + + The view setup view type attribute + + + + + WPageSetup attribute names. + + + + + The page setup line number distance attribute + + + + + The page setup line number mode attribute + + + + + The page setup line number start value attribute + + + + + The page setup border apply attribute + + + + + The page setup border offset from attribute + + + + + The page setup border is in front attribute + + + + + The page setup column equal attribute + + + + + Attributes names for characters. + + + + + The symbol character code ext attribute + + + + + Textbox tag name + + + + + Shape attribute names + + + + + The shape vert origin attribute + + + + + The shape horiz position attribute + + + + + The shape vert position attribute + + + + + The shape line width attribute + + + + + The shape line dashing attribute + + + + + The shape wrapping type attribute + + + + + The shape wrapping style attribute + + + + + The shape wrapping mode attribute + + + + + The shape is below text attribute + + + + + The shape no line attribute + + + + + The shape no fill attribute + + + + + The shape horiz align attribute + + + + + The shape vert align attribute + + + + + The shape front order attribute + + + + + The shape ident attribute + + + + + The shape text box count attribute + + + + + The shape is header attribute + + + + + Comment tags. + + + + + The comment format tag + + + + + The comment format user initials attribute + + + + + The comment format user attribute + + + + + The comment bookmark start attribute + + + + + The comment bookmark end attribute + + + + + The comment tag BKMK attribute + + + + + Footnote tags. + + + + + The footnote marker cp tag + + + + + The footnote is automatic numbered attribute + + + + + The footnote custom marker attribute + + + + + The footnote type attribute + + + + + The footnote symbol code attribute + + + + + The footnote symbol font name attribute + + + + + The initial footnote number attribute + + + + + The footnote position attribute + + + + + The restart index for footnotes attribute + + + + + The endnote number format attribute + + + + + The footnote number format attribute + + + + + The restart index for endnote attribute + + + + + The endnote position attribute + + + + + The initial endnote number attribute + + + + + Watermark. + + + + + The watermark type attribute + + + + + The watermark text attribute + + + + + The watermark text font name attribute + + + + + The watermark text font size attribute + + + + + The watermark text font color attribute + + + + + The watermark text layout attribute + + + + + The watermark text semitrans attribute + + + + + The watermark shape height attribute + + + + + The watermark shape width attribute + + + + + The watermark picture washout attribute + + + + + The watermark picture scale attribute + + + + + The watermark picture is meta attribute + + + + + The watermark picture pib attribute + + + + + Background effects. + + + + + The background gradient tag + + + + + The background type attribute + + + + + The back image is meta attribute + + + + + The background color attribute + + + + + The background back color attribute + + + + + The background gradient style + + + + + The background gradient variant + + + + + Embedded object storage tags + + + + + The embed object is ole2 attribute + + + + + The object pool tag + + + + + Grammar and spelling data tags + + + + + The spelling data tag + + + + + Summary description for XDLSCustomRW. + + + + + + + + + + Initializes a new instance of the class. + + + + + Writes the specified writer. + + The writer. + Name of the tag. + The value. + + + + + Reads the specified reader. + + The reader. + The type. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for DLSXmlHolder. + + + + + Initializes a new instance of the class. + + + + + Adds the element. + + Name of the tag. + The value. + + + + Adds the ref element. + + Name of the tag. + The value. + + + + Writes the holder. + + The writer. + + + + Reads the holder. + + The reader. + + + + + After the deserialization. + + The owner. + + + + Before the serialization. + + + + + + + + + + + + + + + Gets or sets the ID. + + The ID. + + + + Gets or sets a value indicating whether this is cleared. + + if it cleared, set to true. + + + + Gets or sets a value indicating whether [enable ID]. + + If it is enable ID, set to true. + + + + Gets or sets a value indicating whether [skip me]. + + If it specifies to skip, set to true. + + + + Summary description for XDLSReader. + + + + + + + + + + Initializes a new instance of the class. + + The reader. + + + + Deserializes the specified value. + + The value. + + + + Determines whether the current node has attribute with specified name. + + The name. + + if has attribute with specified name, set to true. + + + + + Reads the string. + + The name. + + + + + Reads the int. + + The name. + + + + + Reads the short. + + The name. + + + + + Reads the double. + + The name. + + + + + Reads the float. + + The name. + + + + + Reads the boolean. + + The name. + + + + + Reads the byte. + + The name. + + + + + Reads the enum. + + The name. + Type of the enum. + + + + + Reads color from XML. + + Name of attribute. + Color structure. + + + + Gets the hexadecimal color. + + The color. + + + + + Reads color from XML. + + Name of attribute. + Color structure. + + + + Gets the attribute value. + + The name. + + + + + Parses the type of the element. + + Type of the enum. + Type of the element. + + + + + Reads the child element. + + The value. + + + + + Reads the child element. + + The type. + + + + + Reads the content of the child string. + + + + + + Reads binary value. + + + + + + Reads the image. + + + + + + Reads the image. + + if it is a metafile, set to true. + + + + + + + + + + + + + + + + + Gets the name of the tag. + + The name of the tag. + + + + Gets the type of the node. + + The type of the node. + + + + Gets the inner reader. + + The inner reader. + + + + Gets the attribute reader. + + The attribute reader. + + + + Summary description for DLSXmlWriter. + + + + + Symbol, used during color saving to XML. + + + + + format for color convertion to string. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Writes the value. + + The name. + The value. + + + + Writes the value. + + The name. + The value. + + + + Writes the value. + + The name. + The value. + + + + Writes the value. + + The name. + The value. + + + + Writes the value. + + The name. + The value. + + + + Writes the value. + + The name. + if it is specifies value, set to true. + + + + Writes color as string to XML. + + Name of attribute. + Color structure. + + + + Writes DateTime as string to XML. + + Name of attribute. + Color structure. + + + + Writes the child string element. + + The name. + The value. + + + + Writes binary value. + + The name. + The value. + + + + Writes the child element. + + The name. + The value. + + + + Writes the child ref element. + + The name. + The ref to element. + + + + Writes the image. + + The image. + + + + + + + + + + + + + + + + + + + + + + Gets the inner writer. + + The inner writer. + + + + Specifies the type of a DLS entity. + + + + + Main Word document. + + + + + Section in the Word document. + + + + + Text body in the Word document. + + + + + Header and Footer in the Word document + + + + + Paragraph in the Word document + + + + + AlternateChunk in the Word document + + + + + Block Content control in the Word document + + + + + Structure Document Tag Inline in the Word document + + + + + Structure Document Tag Row in the Word document + + + + + Structure Document Tag Cell in the Word document + + + + + Structure Document Tag in the Word document + + + + + Structure Document Tag Inline in the Word document + + + + + Structure Document Tag Row in the Word document + + + + + Structure Document Tag Cell in the Word document + + + + + Structure Document Tag Block Content in the Word document + + + + + Structure Document Tag Inline Content in the Word document + + + + + Structure Document Tag Row Content in the Word document + + + + + Structure Document Tag Cell Content in the Word document + + + + + Table in the Word document + + + + + Table row in the Word document + + + + + Table Cell in the Word document + + + + + Text run in the Word document + + + + + Picture in the Word document + + + + + Field in the Word document + + + + + Field mark in the Word document + + + + + Merge field in the Word document + + + + + Sequence Field Tag in the Word document + + + + + Embeded in the Word document + + + + + Control field in the Word document + + + + + Text form field in the Word document + + + + + Drop down form field in the Word document + + + + + Check box in the Word document + + + + + Bookmark start in the Word document + + + + + Bookmark end in the Word document + + + + + Shape in the Word document + + + + + Comment in the Word document + + + + + Footnote in the Word document + + + + + TextBox in the Word document + + + + + Break in the Word document + + + + + Symbol in the Word document + + + + + Table of content in the Word document + + + + + Xml Paragraph Item in the Word document + + + + + Undefiened element + + + + + Chart in the Word document + + This enum is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform and Xamarin platforms. + + + + Comment mark in the Word document + + + + + Comment End in the Word document + + + + + OLE Object in the Word document + + + + + Absolute Tab in the Word document + + + + + Auto shape in the Word document + + + + + Editable range start in the Word document + + + + + Editable range end in the Word document + + + + + Group shape in the Word document + + + + + Child shape in the Word document + + + + + Child group shape in the Word document + + + + + Mathematical equation in the Word document + + + + + Specifies type of the Header or Footer. + + + + + Header for even numbered pages. + + + + + Header for odd numbered pages. + + + + + Footer for even numbered pages. + + + + + Footer for odd numbered pages. + + + + + Header for the first page of the section. + + + + + Footer for the first page of the section. + + + + + Specifies type of the Shape. + + + + + Specifies text shape. + + + + + Specifies rectangle shape. + + + + + Specifies image shape. + + + + + Specifies arc shape. + + + + + Specifies ellipse shape. + + + + + Specifies line shape. + + + + + Specifies path shape. + + + + + Specifies bezier shape. + + + + + Specifies pie shape. + + + + + Specifies polygon shape. + + + + + Specifies type of the style. + + + + + Paragraph style. + + + + + Character style. + + + + + Table style. + + + + + Numbering style. + + + + + Other kind of style. + + + + + Specifies type of the paragraph item. + + + + + Text. + + + + + Picture. + + + + + Field. + + + + + Field mark. + + + + + Merge field. + + + + + Form field. + + + + + Check box. + + + + + Text form field. + + + + + Drop down form field. + + + + + Sequence field. + + + + + Embedded field. + + + + + Control field. + + + + + Start of bookmark. + + + + + End of bookmark. + + + + + Shape object. + + + + + Inline shape object. + + + + + Comment. + + + + + Footnote. + + + + + Textbox. + + + + + Break. + + + + + Symbol. + + + + + Table of contents. + + + + + Chart. + + This enum is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform and Xamarin platforms. + + + + OLE object. + + + + + Inline Content Control. + + + + + Mathematical equation + + + + + Specifies orientation of the page. + + + + + Portrait page orientation. + + + + + Landscape page orientation. + + + + + Specifies multiple pages property. + + + + + Normal in multiple pages. + + + + + Mirror Margin in multiple pages. + + + + + Two pages per sheets in multiple pages. + + + + + Book Fold in multiple pages. + + + + + Reverse Book Fold in multiple pages. + + + + + Specifies alignment of the text on a page. + + + + + Text is aligned at the top of the page. + + + + + Text is aligned at the middle of the page. + + + + + Text is spanned to fill the page. + + + + + Text is aligned at the bottom of the page. + + + + + Specifies type of the vertical alignment. + + + + + Specifies top alignment. + + + + + Specifies middle alignment. + + + + + Specifies bottom alignment. + + + + + Specifies type of the Text Shape Values. + + + + + Specifies No Text Shape. + + + + + Specifies Plain Text Shape. + + + + + SpecifiesStop Sign Text Shape. + + + + + Specifies Triangle Text Shape. + + + + + Specifies Inverted Triangle Text Shape. + + + + + Specifies Chevron Text Shape. + + + + + Specifies Inverted Chevron Text Shape. + + + + + Specifies Inside Ring Text Shape. + + + + + Specifies Outside Ring Text Shape. + + + + + Specifies Upward Arch Text Shape. + + + + + Specifies Downward Arch Text Shape. + + + + + Specifies Circle Text Shape. + + + + + Specifies Button Text Shape. + + + + + Specifies Upward Pour Arch Text Shape. + + + + + Specifies Downward Pour Arch Text Shape. + + + + + Specifies Circle Pour Text Shape. + + + + + Specifies Button Pour Text Shape. + + + + + Specifies Upward Curve Text Shape. + + + + + Specifies Downward Curve Text Shape. + + + + + Specifies Upward Can Text Shape. + + + + + Specifies Downward Can Text Shape. + + + + + Specifies Wave 1 Text Shape. + + + + + Specifies Wave 2 Text Shape. + + + + + Specifies Double Wave 1 Text Shape. + + + + + Specifies Wave 4 Text Shape. + + + + + Specifies Inflate Text Shape. + + + + + Specifies Deflate Text Shape. + + + + + Specifies Bottom Inflate Text Shape. + + + + + Specifies Bottom Deflate Text Shape. + + + + + Specifies Top Inflate Text Shape. + + + + + Specifies Top Deflate Text Shape. + + + + + Specifies Deflate-Inflate Text Shape. + + + + + Specifies Deflate-Inflate-Deflate Text Shape. + + + + + Specifies Right Fade Text Shape. + + + + + Specifies Left Fade Text Shape. + + + + + Specifies Upward Fade Text Shape. + + + + + Specifies Downward Fade Text Shape. + + + + + Specifies Upward Slant Text Shape. + + + + + Specifies Downward Slant Text Shape. + + + + + Specifies Upward Cascade Text Shape. + + + + + Specifies Downward Cascade Text Shape. + + + + + Specifies type of the Tile Filp Type. + + + + + Specifies No Plane + + + + + Specifies XY Plane + + + + + Specifies Y plane + + + + + Specifies X plane + + + + + Specifies type of the Fill Aspects. + + + + + Specifies Atleast. + + + + + Specifies Atmost. + + + + + Specifies Ignore. + + + + + Specifies type of the Blip Compression Type. + + + + + Specifies No compression mode. + + + + + Specifies Email mode + + + + + Specifies Print mode. + + + + + Specifies Screen mode. + + + + + Specifies High Quality Printing mode. + + + + + Specifies type of the horizontal alignment. + + + + + Specifies paragraph text is aligned to the left. + + + + + Specifies paragraph text is aligned to the center. + + + + + Specifies paragraph text is aligned to the right. + + + + + Specifies paragraph text is aligned to both left and right. + + + + + Specifies paragraph characters are distributed to fill the entire width of the paragraph. + + + + + Specifies paragraph uses medium-length Kashida, if the language is Arabic. In other languages, paragraph text is justified with a medium character compression ratio. + + + + + Specifies paragraph uses longer length Kashida, if the language is Arabic. In other languages, paragraph text is justified with a high character compression ratio. + + + + + Specifies paragraph uses small length Kashida, if the language is Arabic. In other languages, paragraph text is justified with a high character compression ratio. + + + + + Specifies paragraph text is justified with Thai distributed justification, if the language is Thai. In other languages, text is justified with a low character compression ratio. + + + + + Specifies type of the horizontal row alignment. + + + + + Specifies row alignment to the left. + + + + + Specifies row alignment to the center. + + + + + Specifies row alignment to the right. + + + + + Specifies style of the underline. + + This enum is not supported in MVC6 and Xamarin platforms. + + + + No underline. + + + + + A single line. default. + + + + + Underline individual words only. + + + + + A double line. + + + + + Dots. + + + + + + + + + + A single thick line. + + + + + Dashes. + + + + + Long dashes. + + + + + Alternating dots and dashes. + + + + + An alternating dot-dot-dash pattern. + + + + + A single wavy line. + + + + + Heavy dots. + + + + + Heavy dashes. + + + + + Long heavy dashes. + + + + + Alternating heavy dots and heavy dashes. + + + + + An alternating heavy dot-dot-dash pattern. + + + + + A heavy wavy line. + + + + + A double wavy line. + + + + + Specifies type of the sub and super script. + + + + + No sub- or superscript. + + + + + Specified superscript format. + + + + + Specified subscript format. + + + + + + + + + + + + + + + + + + + + + + + + + Specifies the line style of the border. + + + + + No border. + + + + + A single solid line. + + + + + Thick solid lines. + + + + + Double solid lines. + + + + + Hairline border. + + + + + Dots. + + + + + A dash followed by a large gap. + + + + + A dash followed by a dot. + + + + + A dash followed by two dots. + + + + + Three solid thin lines. + + + + + An internal single thin solid line surrounded by a single thick solid line with a small gap between them. + + + + + An internal single thick solid line surrounded by a single thin solid line with a small gap between them. + + + + + An internal single thin solid line surrounded by a single thick solid line surrounded by a single thin solid line with a small gap between all lines. + + + + + An internal single thin solid line surrounded by a single thick solid line with a medium gap between them. + + + + + An internal single thick solid line surrounded by a single thin solid line with a medium gap between them. + + + + + An internal single thin solid line surrounded by a single thick solid line surrounded by a single thin solid line with a medium gap between all lines. + + + + + An internal single thin solid line surrounded by a single thick solid line with a large gap between them. + + + + + An internal single thick solid line surrounded by a single thin solid line with a large gap between them. + + + + + An internal single thin solid line surrounded by a single thick solid line surrounded by a single thin solid line with a large gap between all lines. + + + + + A single wavy solid line. + + + + + Double wavy solid lines. + + + + + A dash followed by a small gap. + + + + + A dash followed by a dot stroke, thus rendering a border similar to a barber pole. + + + + + The border appears to have a 3-D embossed look. + + + + + The border appears to have a 3-D engraved look. + + + + + The border appears to be outset. + + + + + The border appears to be inset. + + + + + Twisted Lines Art Border. + + + + + Cleared border. + + + + + Specifies the graphical page border settings + + + + + Specifies type of the section break code. + + + + + No break with the new section beginning on the next paragraph of the same page. + + + + + Column break with the new section beginning on the next column on the page. + + + + + Section break with the new section beginning on the next page. + + + + + Section break with the new section beginning on the next even-numbered page. + + + + + Section break with the new section beginning on the next odd-numbered page. + + + + + Specifies type of the link. + + + + + No links. + + + + + Links to another file. + + + + + Links to a web page. + + + + + Link to e-mail. + + + + + Bookmark link. + + + + + Specifies type of the list format. + + + + + Specifies numbered list. + + + + + Specifies bulleted list. + + + + + No numbering. + + + + + Specifies type of the list numbering format. + + + + + Arabic format. + + + + + Upper roman numbering format. + + + + + Lower roman numbering format. + + + + + Upper case letter numbering format. + + + + + Lower case letter numbering format. + + + + + Ordinal numbering format. + + + + + Number numbering format. + + + + + Ordinal text numbering format. + + + + + Leading zero numbering format. + + + + + Bullet numbering format. + + + + + Far east numbering format. + + + + + Special numbering format. + + + + + Specifies chinese counting thousand format. + + + + + Specifies Japanese counting format. + + + + + Specifies None numbering format. + + + + + Specifies the way of cell merging. + + + + + No merge. + + + + + Merge starts from this cell. + + + + + Merge is continued. + + + + + Specifies shape position + + + + + + + + + + + + + + + + + + + + Specifies the horizontal origin of the object. + + + + + Origin to margin. + + + + + Origin to page. + + + + + Origin to column. + + + + + Origin to character. + + + + + Origin to left margin. + + + + + Origin to right margin. + + + + + Origin to inner margin area. + + + + + Origin to outer margin area. + + + + + Specifies the vertical origin of the object. + + + + + Origin to margin. + + + + + Origin to page. + + + + + Origin to paragraph. + + + + + Origin to line. + + + + + Origin to top margin. + + + + + Origin to bottom margin. + + + + + Origin to inner margin area. + + + + + Origin to outer margin area. + + + + + Specifies the vertical origin of the object height. + + + + + Origin to margin. + + + + + Origin to page. + + + + + Origin to top margin. + + + + + Origin to bottom margin. + + + + + Origin to inner margin area. + + + + + Origin to outer margin area. + + + + + Specifies the horizontal origin of the object width + + + + + Origin to margin. + + + + + Origin to page. + + + + + Origin to left margin. + + + + + Origin to right margin. + + + + + Origin to inner margin area. + + + + + Origin to outer margin area. + + + + + Specifies the text box border line style. + + + + + A single solid line. + + + + + Double solid lines. + + + + + Thick line next to thin line. For horizontal lines, thick line is below thin line. For vertical lines, thick line is to the right of the thin line. + + + + + Thick line next to thin line. For horizontal lines, thick line is above thin line. For vertical lines, thick line is to the left of the thin line. + + + + + Three solid lines. + + + + + Specifies the text wrap style. + + + + + In line with text. + + + + + Top and bottom. + + + + + Wraps text around the shape. Line continuation is on the opposite side of the shape. + + + + + Places shape in front of text. + + + + + Tight. + + + + + Through. + + + + + Places shape behind text. + + + + + Specifies the text wrapping type. + + + + + Wrap text both sides. + + + + + Wrap text left side only. + + + + + Wrap text right side only. + + + + + Side that is farthest from the page margin. + + + + + Specifies the tab justification. + + + + + Left tab. + + + + + Centered tab. + + + + + Right tab. + + + + + Decimal tab. + + + + + Bar. + + + + + List. + + + + + Specifies the tab leader. + + + + + No leader. + + + + + Dotted leader. + + + + + Hyphenated leader. + + + + + Single line leader. + + + + + Heavy line leader. + + + + + Specifies the table row height type. + + + + + "At least" table row height type + + + + + " Exactly" table row height type + + + + + Specifies the list number alignment. + + + + + Left align. + + + + + Center align. + + + + + Right align. + + + + + Specifies the type of character following the list level number text for the paragraph. + + + + + List levels number or bullet is followed by tab. + + + + + List levels number or bullet is followed by space. + + + + + Follow character isn't used. + + + + + specifies the picture color. + + + + + Picture automatic color. + + + + + Picture gray-scale color. + + + + + Picture black and white color. + + + + + Picture washout color. + + + + + Specifies the type of separator to chapter pages. + + + + + A hyphen. + + + + + A period. + + + + + A colon. + + + + + An emphasized dash. + + + + + A standard dash. + + + + + Specifies the level of the heading. + + + + + No heading level. + + + + + Heading level 1. + + + + + Heading level 2. + + + + + Heading level 3. + + + + + Heading level 4. + + + + + Heading level 5. + + + + + Heading level 6. + + + + + Heading level 7. + + + + + Heading level 8. + + + + + Heading level 9. + + + + + Specifies the type of the break. + + + + + Page break type. + + + + + Column break type. + + + + + Line break type. + + + + + Text wrapping break type. + + + + + Specifies the watermark type. + + + + + No watermark. + + + + + Picture watermark. + + + + + Text watermark. + + + + + Specifies the watermark layout. + + + + + Diagonal watermark layout. + + + + + Horizontal watermark layout. + + + + + Specifies the type of the background. + + + + + No background fill effect. + + + + + Gradient fill effect. + + + + + Picture fill effect. + + + + + Texture fill effect. + + + + + Color fill effect. + + + + + Specifies the shading styles for Gradient background effect. + + + + + Horizontal shading style. + + + + + Vertical shading style. + + + + + Diagonal Up shading style. + + + + + Diagonal Down shading style. + + + + + From Corner shading style. + + + + + From Center shading style. + + + + + Speecifies the shading variants for background gradient. + + + + + Shading in the upper part. + + + + + Shading in the lower part. + + + + + Shading in upper and lower parts. + + + + + Shading in the middle. + + + + + Specifies the type of a form field. + + + + + Text form field. + + + + + Check box form field. + + + + + Drop-down form field. + + + + + Specifies the checkBox size type. + + + + + Auto check box size. + + + + + Exact check box size. + + + + + Specifies the format of the text. + + + + + No text formatting + + + + + Uppercase text formatting. + + + + + Lowercase text formatting. + + + + + First capital text formatting. + + + + + Title case text formatting. + + + + + Specifies the format of the number. + + + + + No formatting + + + + + Format with whole number. + + + + + Format with floating point number. + + + + + Whole number in percents. + + + + + Floating point number in percents. + + + + + Format which suits to "# ##0" Word format. + + + + + Format which suites to "# ##0,00" Word format. + + + + + Format which suites to "# ##0,00 $;(# ##0,00 $)" Word format. + + + + + Specifies the direction of text. + + + + + Text flows horizontally. default. + + + + + Text flows vertically and reads from top to bottom, right to left in order to read Far East Languages. + + + + + Text flows vertically and reads from bottom to top. + + + + + Text flows vertically and reads from top to bottom. + + + + + Text flows horizontally and reads from right to left in order to read Far East Languages. + + + + + Text flows vertically and reads from top to bottom, left to right. + + + + + Specifies the direction of text. + + + + + Text flows in left to right order. + + + + + Text flows in Top to bottom order. + + + + + Text flows in Top to bottom order and rotated. + + + + + Text flows in left to right order and rotated. + + + + + Text flows in right to left order. + + + + + Text flows in right to left order and rotated. + + + + + Specifies the type of field mark. + + + + + Field separator type + + + + + Field end type. + + + + + Specifies the built-in styles. + + + + + Normal style. + + + + + Heading level 1 style. + + + + + Heading level 2 style. + + + + + Heading level 3 style. + + + + + Heading level 4 style. + + + + + Heading level 5 style. + + + + + Heading level 6 style. + + + + + Heading level 7 style. + + + + + Heading level 8 style. + + + + + Heading level 9 style. + + + + + Index 1 style. + + + + + Index 2 style. + + + + + Index 3 style. + + + + + Index 4 style. + + + + + Index 5 style. + + + + + Index 6 style. + + + + + Index 7 style. + + + + + Index 8 style. + + + + + Index 9 style. + + + + + Table of content 1 style. + + + + + Table of content 2 style. + + + + + Table of content 3 style. + + + + + Table of content 4 style. + + + + + Table of content 5 style. + + + + + Table of content 6 style. + + + + + Table of content 7 style. + + + + + Table of content 8 style. + + + + + Table of content 9 style. + + + + + Normal indent style. + + + + + Footnote text style. + + + + + Comment text style. + + + + + Header style. + + + + + Footer style. + + + + + Index heading style. + + + + + Caption style. + + + + + Table of figures style. + + + + + Footnote reference style. + + + + + Comment reference style. + + + + + Line number style. + + + + + Page number style. + + + + + Endnote reference style. + + + + + Endnote text style. + + + + + Table of authorities style. + + + + + Macro text style. + + + + + TOA heading style. + + + + + List style. + + + + + List bullet style. + + + + + List number style. + + + + + List 2 style. + + + + + List 3 style. + + + + + List 4 style. + + + + + List 5 style. + + + + + List bullet 2 style. + + + + + List bullet 3 style. + + + + + List bullet 4 style. + + + + + List bullet 5 style. + + + + + List number 2 style. + + + + + List number 3 style. + + + + + List number 4 style. + + + + + List number 5 style. + + + + + Title style. + + + + + Closing style. + + + + + Signature style. + + + + + Default paragraph font style. + + + + + Body text stye. + + + + + Body text indent style. + + + + + List continue style. + + + + + List continue 2 style. + + + + + List continue 3 style. + + + + + List continue 4 style. + + + + + List continue 5 style. + + + + + Message header style. + + + + + Bub title style. + + + + + Salutation style. + + + + + Date style. + + + + + Body Text 1 style. + + + + + Body Text 2 style. + + + + + Note heading style. + + + + + Body text 2 style. + + + + + Body text 3 style. + + + + + Body text indent 2 style. + + + + + Body text indent 3 style. + + + + + Block text style. + + + + + Hyperlink style. + + + + + Followed hyperlink style. + + + + + Strong style. + + + + + Emphasis style. + + + + + Document map style. + + + + + Plain text style. + + + + + Email signature style. + + + + + Normal web style. + + + + + Html acronym style. + + + + + Html address style. + + + + + Html cite style. + + + + + Html code style. + + + + + Html definition style. + + + + + Html keyboard style. + + + + + Html pre-formatted style. + + + + + Html sample style. + + + + + Html type writer style. + + + + + Html variable style. + + + + + Comment subject style. + + + + + No list style. + + + + + Balloon text style. + + + + + User style. + + + + + No style. + + + + + Specifies the built-in list styles. + + + + + List bullet style. + + + + + List number style. + + + + + List bullet 2 style. + + + + + List bullet 3 style. + + + + + List bullet 4 style. + + + + + List bullet 5 style. + + + + + List number 2 style. + + + + + List number 3 style. + + + + + List number 4 style. + + + + + List number 5 style. + + + + + Specifies the built-in table styles. + + + + + Table normal style. + + + + + Table grid style. + + + + + Light shading style. + + + + + Light shading accent 1 style. + + + + + Light shading accent 2 style. + + + + + Light shading accent 3 style. + + + + + Light shading accent 4 style. + + + + + Light shading accent 5 style. + + + + + Light shading accent 6 style. + + + + + Light List style. + + + + + Light list accent 1 style. + + + + + Light list accent 2 style. + + + + + Light list accent 3 style. + + + + + Light list accent 4 style. + + + + + Light list accent 5 style. + + + + + Light list accent 6 style. + + + + + Light grid style. + + + + + Light grid accent 1 style. + + + + + Light grid accent 2 style. + + + + + Light grid accent 3 style. + + + + + Light grid accent 4 style. + + + + + Light grid accent 5 style. + + + + + Light grid accent 6 style. + + + + + Medium shading 1 style. + + + + + Medium shading 1 accent 1 style. + + + + + Medium shading 1 accent 2 style. + + + + + Medium shading 1 accent 3 style. + + + + + Medium shading 1 accent 4 style. + + + + + Medium shading 1 accent 5 style. + + + + + Medium shading 1 accent 6 style. + + + + + Medium shading 2 style. + + + + + Medium shading 2 accent 1 style. + + + + + Medium shading 2 accent 2 style. + + + + + Medium shading 2 accent 3 style. + + + + + Medium shading 2 accent 4 style. + + + + + Medium shading 2 accent 5 style. + + + + + Medium shading 2 accent 6 style. + + + + + Medium list 1 style. + + + + + Medium list 1 accent 1 style. + + + + + Medium list 1 accent 2 style. + + + + + Medium list 1 accent 3 style. + + + + + Medium list 1 accent 4 style. + + + + + Medium list 1 accent 5 style. + + + + + Medium list 1 accent 6 style. + + + + + Medium list 2 style. + + + + + Medium list 2 accent 1 style. + + + + + Medium list 2 accent 2 style. + + + + + Medium list 2 accent 3 style. + + + + + Medium list 2 accent 4 style. + + + + + Medium list 2 accent 5 style. + + + + + Medium list 2 accent 6 style. + + + + + Medium grid 1 style. + + + + + Medium grid 1 accent 1 style. + + + + + Medium grid 1 accent 2 style. + + + + + Medium grid 1 accent 3 style. + + + + + Medium grid 1 accent 4 style. + + + + + Medium grid 1 accent 5 style. + + + + + Medium grid 1 accent 6 style. + + + + + Medium grid 2 style. + + + + + Medium grid 2 accent 1 style. + + + + + Medium grid 2 accent 2 style. + + + + + Medium grid 2 accent 3 style. + + + + + Medium grid 2 accent 4 style. + + + + + Medium grid 2 accent 5 style. + + + + + Medium grid 2 accent 6 style. + + + + + Medium grid 3 style. + + + + + Medium grid 3 accent 1 style. + + + + + Medium grid 3 accent 2 style. + + + + + Medium grid 3 accent 3 style. + + + + + Medium grid 3 accent 4 style. + + + + + Medium grid 3 accent 5 style. + + + + + Medium grid 3 accent 6 style. + + + + + Dark list style. + + + + + Dark list accent 1 style. + + + + + Dark list accent 2 style. + + + + + Dark list accent 3 style. + + + + + Dark list accent 4 style. + + + + + Dark list accent 5 style. + + + + + Dark list accent 6 style. + + + + + Colorful shading style. + + + + + Colorful shading accent 1 style. + + + + + Colorful shading accent 2 style. + + + + + Colorful shading accent 3 style. + + + + + Colorful shading accent 4 style. + + + + + Colorful shading accent 5 style. + + + + + Colorful shading accent 6 style. + + + + + Colorful list style. + + + + + Colorful list accent 1 style. + + + + + Colorful list accent 2 style. + + + + + Colorful list accent 3 style. + + + + + Colorful list accent 4 style. + + + + + Colorful list accent 5 style. + + + + + Colorful list accent 6 style. + + + + + Colorful grid style. + + + + + Colorful grid accent 1 style. + + + + + Colorful grid accent 2 style. + + + + + Colorful grid accent 3 style. + + + + + Colorful grid accent 4 style. + + + + + Colorful grid accent 5 style. + + + + + Colorful grid accent 6 style. + + + + + Table 3 deffects 1 style. + + + + + Table 3 deffects 2 style. + + + + + Table 3 deffects 3 style. + + + + + Table classic 1 style. + + + + + Table classic 2 style. + + + + + Table classic 3 style. + + + + + Table classic 4 style. + + + + + Table colorful 1 style. + + + + + Table colorful 2 style. + + + + + Table colorful 3 style. + + + + + Table columns 1 style. + + + + + Table columns 2 style. + + + + + Table columns 3 style. + + + + + Table columns 4 style. + + + + + Table columns 5 style. + + + + + Table contemporary style. + + + + + Table elegant style. + + + + + Table grid 1 style. + + + + + Table grid 2 style. + + + + + Table grid 3 style. + + + + + Table grid 4 style. + + + + + Table grid 5 style. + + + + + Table grid 6 style. + + + + + Table grid 7 style. + + + + + Table grid 8 style. + + + + + Table list 1 style. + + + + + Table list 2 style. + + + + + Table list 3 style. + + + + + Table list 4 style. + + + + + Table list 5 style. + + + + + Table list 6 style. + + + + + Table list 7 style. + + + + + Table list 8 style. + + + + + Table professional style. + + + + + Table simple 1 style. + + + + + Table simple 2 style. + + + + + Table simple 3 style. + + + + + Table subtle 1 style. + + + + + Table subtle 2 style. + + + + + Table theme style. + + + + + Table web 1 style. + + + + + Table web 2 style. + + + + + Table web 3 style. + + + + + Defines conditional formatting styles type. + + + + + The first row + + + + + The last row + + + + + The odd row banding + + + + + The even row banding + + + + + The first column + + + + + The last column + + + + + The odd column banding + + + + + The even column banding + + + + + The first row last cell + + + + + The first row first cell + + + + + The last row last cell + + + + + The last row first cell + + + + + + + + + + Specifies the number style for a page. + + + + + Arabic. + + + + + Upper case roman. + + + + + Lower case roman. + + + + + Upper case letter. + + + + + Lower case letter. + + + + + Specifies the page number alignment. + + + + + Left alignment. + + + + + Center alignment. + + + + + Right alignment. + + + + + Inside alignment. + + + + + Outside alignment. + + + + + Specifies the horizontal frame anchor. + + + + + Specifies the vertical frame anchor. + + + + + Specifies the vertical frame position. + + + + + Specifies the XHTML validation type. + + + + + XHTML 1.0 validation. It does not allows the attributes inside the tag. + + + + + XHTML 1.1 validation. It allows several attributes within the tags. + + + + + No validation. It does not perform any schema validation, but the given HTML content should have proper open and close tags. + + + + + Specifies the type of grid pitch. + + + + + The no grid + + + + + The chars and line + + + + + The lines only + + + + + The snap to chars + + + + + Specifies the document creation version. + + + + + Document created using Word 97 + + + + + Document created using Word 2000 + + + + + Document created using Word 2002 + + + + + Document created using Word 2003 + + + + + Document created using Word 2007 + + + + + Specifies the type of comment mark. + + + + + Comment start mark type. + + + + + Comment end mark type + + + + + Specifies the type of the ole object field. + + + + + Ole object field type is EMBED. + + + + + Ole object field type is LINK. + + + + + Specifies the type of OLE object. + + + + + Type is not defined. + + + + + Adobe Acrobat Document. File has ".pdf" extension. + + + + + Bitmap Image. File has ".png" extension. + + + + + Media Clip. + + + + + Equation. + + + + + Graph Chart. + + + + + Excel 97-2003 Worksheet. File has ".xls" extension. + + + + + Excel Binary Worksheet. File has ".xlsb" extension. + + + + + Excel chart. File has ".xls" extension. + + + + + Excel Macro-Enabled Worksheet. File has ".xlsm" extension. + + + + + Excel Worksheet. File has ".xlsx" extension. + + + + + PowerPoint 97-2003 Presentation. File has ".ppt" extension. + + + + + PowerPoint 97-2003 Slide. File has ".sld" extension. + + + + + PowerPoint Macro-Enabled Presentation. File has ".pptm" extension. + + + + + PowerPoint Macro-Enabled Slide. File has ".sldm" extension. + + + + + PowerPoint Presentation. File has ".pptx" extension. + + + + + PowerPoint Slide. File has ".sldx" extension. + + + + + Word 97-2003 Document. File has ".doc" extension. + + + + + Word Document. File has ".docx" extension. + + + + + Word Macro-Enabled Document. File has ".docm" extension. + + + + + Visio Deawing. + + + + + MIDI Sequence. + + + + + OpenDocument Presentation. + + + + + OpenDocument Spreadsheet. + + + + + OpenDocument Text. + + + + + OpenOffice.org 1.1 Spreadsheet. + + + + + OpenOffice.org 1.1 Text. + + + + + Package. + + + + + Video Clip. + + + + + Wave Sound. + + + + + WordPad Document. + + + + + OpenOffice spreadsheet. + + + + + OpenOffice Text. + + + + + Specifies the type of the ole object update mode. + + + + + The object is updated when the object's application indicates there is new data available. + + + + + The object is updated when the user chooses to update it. + + + + + Specifies the image type. + + + + + Meta file. + + + + + Bitmap. + + + + + Specifies the Rtf table type. + + + + + Font table collection + + + + + List table collection + + + + + Color table collection + + + + + List override collection + + + + + Style sheet collection + + + + + No table collection + + + + + Specifies the Rtf token type. + + + + + Group start. + + + + + Group end. + + + + + Control word. + + + + + Text. + + + + + Table entry. + + + + + Unknown. + + + + + Specifies the type of the field character. + + + + + Field begin. + + + + + Field separator. + + + + + Field end. + + + + + Field unknown. + + + + + simple field. + + + + + Specifies the ligature type. + + + + + Does not apply any ligatures to the font. + + + + + Applies standard ligatures to the font. Standard ligatures are designed to enhance readability. Standard ligatures in Latin languages include "fi", "fl", and "ff", for example. + + + + + Applies contextual ligatures to the font. Contextual ligatures are often designed to enhance readability, but may also be solely ornamental. Contextual ligatures may also be contextual alternates. + + + + + Applies standard and contextual ligatures to the font. + + + + + Applies historical ligatures to the font. Historical ligatures are similar to standard ligatures in that they were originally intended to improve the readability of the font, but may look archaic to the modern reader. + + + + + Applies standard and historical ligatures to the font. + + + + + Applies contextual and historical ligatures to the font. + + + + + Applies standard, contextual, and historical ligatures to the font. + + + + + Applies discretional ligatures to the font. Discretional ligatures are most often designed to be ornamental at the discretion of the type developer. + + + + + Applies standard and discretional ligatures to the font. + + + + + Applies contextual and discretional ligatures to the font. + + + + + Applies standard, contextual and discretional ligatures to the font. + + + + + Applies historical and discretional ligatures to the font. + + + + + Applies standard historical and discretional ligatures to the font. + + + + + Applies contextual, historical, and discretional ligatures to a font. + + + + + Applies all types of ligatures to the font. + + + + + Specifies the number form type. + + + + + The default + + + + + The lining + + + + + The old style + + + + + Specifies the number spacing type. + + + + + The default + + + + + The proportional + + + + + The tabular + + + + + Specifies the stylistic set type. + + + + + The stylistic set default + + + + + The stylistic set01 + + + + + The stylistic set02 + + + + + The stylistic set03 + + + + + The stylistic set04 + + + + + The stylistic set05 + + + + + The stylistic set06 + + + + + The stylistic set07 + + + + + The stylistic set08 + + + + + The stylistic set09 + + + + + The stylistic set10 + + + + + The stylistic set11 + + + + + The stylistic set12 + + + + + The stylistic set13 + + + + + The stylistic set14 + + + + + The stylistic set15 + + + + + The stylistic set16 + + + + + The stylistic set17 + + + + + The stylistic set18 + + + + + The stylistic set19 + + + + + The stylistic set20 + + + + + Specifies the compatibility types. + + + + + Don't add automatic tab stop for hanging indent. + + + + + Don't add extra space for raised/lowered characters. + + + + + Print colors as black on noncolor printers. + + + + + Wrap trailing spaces to next line. + + + + + Don't balance columns for continuous section starts. + + + + + Treat \" as "" in mail merge data sources. + + + + + Suppress Space Before after a hard page or column break. + + + + + Suppress extra line spacing at top of page. + + + + + Combine table borders like Word 5.x for the Macintosh. + + + + + Truncate font height. + + + + + Show hard page or column breaks in frames. + + + + + Swap left and right borders on odd facing pages. + + + + + Convert backslash characters into yen signs. + + + + + Don't expand character spaces on the line ending Shift+Return. + + + + + Draw underline on trailing spaces. + + + + + Balance SBCS characters and DBCS characters. + + + + + Suppress extra line spacing at top of page like Word 5.x for the Macintosh. + + + + + Specifies whether line spacing emulates WordPerfect 5.x line spacing + + + + + Print body text before header/footer. + + + + + Don't add leading (extra space) between rows of text. + + + + + Add space for underline. + + + + + Use larger small caps like Word 5.x for the Macintosh. + + + + + Suppress extra line spacing like WordPerfect 5.x. + + + + + Truncate font height. + + + + + Substitute fonts based on font size. + + + + + Use printer metrics to lay out document. + + + + + Use Word 6.x/95 border rules. + + + + + Don't center "exact line height" lines. + + + + + Set the width of a space like WordPerfect 5.x. + + + + + Do full justification like WordPerfect 6.x for Windows. + + + + + Line wrap like Word 6.0. + + + + + Lay out autoshapes like Word 97. + + + + + Lay out footnotes like Word 6.x/95/97. + + + + + Don't use HTML paragraph auto spacing. + + + + + Adjust line height to grid height in the table. + + + + + Forget last tab alignment. + + + + + Specifies whether to emulate Word for Windows 95 full-width character spacing + + + + + Slign table rows independently. + + + + + Lay out tables with raw width. + + + + + Allow table rows to lay out apart. + + + + + Use Word 97 line breaking rules for Asian text. + + + + + Don't break wrapped tables across pages. + + + + + Don't snap text to grid inside table with inline objects. + + + + + Select entire field with first or last character. + + + + + Use line-breaking rules. + + + + + Don't allow hanging punctuation with character grid. + + + + + Don't use Asian rules for line breaks with character grid. + + + + + Use Word 2002 table style rules. + + + + + Allow tables to extend into margins. + + + + + Use the Normal style instead of the List Paragraph style for bulleted or + numbered lists. + + + + + Do not use hanging indent as tab stop for bullets and numbering. + + + + + Use Word 2003 hanging-punctuation rules in Asian langauges. + + + + + Allow space between paragraphs of the same style in a table. + + + + + Use Word 2003 indent rules for text next to wrapped objects. + + + + + Do not autofit tables next to wrapped objects. + + + + + Use Microsoft Office Word 2003 table autofit rules. + + + + + Underline the tab character between the number and the text in numbered lists. + + + + + Do not use proportional width for Korean characters. + + + + + Split apart page break and paragraph mark. + + + + + Specifies whether to not vertically align cells containing floating objects + + + + + Specifies whether to not break table rows around floating tables + + + + + Specifies whether to ignore vertical alignment in text boxes + + + + + Specifies whether to use ANSI kerning pairs from fonts instead of the Unicode kerning pair info + + + + + Specifies whether to use cached paragraph information for column balancing + + + + + specifies whether to apply the additional preceding rules when determining the font size and justification of text within tables. + + + + + specifies whether the preceding features are to be used when displaying the font. + + + + + specifies whether to swap indentation values when displaying paragraphs. + + + + + conditional formatting of table row headers does apply separately to multi-row table headers + + + + + Specifies the compatibility mode that uses when opening a document. + + + + + Features new to Word 2007 and later are disabled in this mode. + + + + + Features new to Word 2010 and later are disabled in this mode. + + + + + All Word 2010 features are enabled. + + + + + Default. All Word 2013 features are enabled. Also Word 2016 have similar features of Word 2013 and it doesn't have any difference. + + + + + Specifies the text effect for the revised text + + + + + Specifies that the revised text has no special effects + + + + + Applies bold for the revised text + + + + + Applies italic for the revised text + + + + + Applies underline style for the revised text + + + + + Applies strike through for the revised text + + + + + Specifies the track changes revision color. + + + + + Represents 2e97d3 for insert text, else 1b9cab color. + + + + + Represents 000000 color. + + + + + Represents 2e97d3 color. + + + + + Represents 84a35b color. + + + + + Represents 376e96 color. + + + + + Represents 881824 color. + + + + + Represents e09a2b color. + + + + + Represents a0a3a9 color. + + + + + Represents 50565e color. + + + + + Represents 2c6234 color. + + + + + Represents ce338f color. + + + + + Represents b5082e color. + + + + + Represents 1b9cab color. + + + + + Represents 3eafc2 color. + + + + + Represents 633277 color. + + + + + Represents ffffff color. + + + + + Represents fad272 color. + + + + + Represents 2e97d3 for insert text, else 1b9cab color. + + + + + Represents ff0000 color. + + + + + Represents 0000ff color. + + + + + Specifies the rendering options for document comments. + + + + + No document comments are rendered. + + + + + Renders document comments in balloons. + + + + + Specifies the track changes revision markup. + + + + + No revision + + + + + Insertion revision type + + + + + Deletion revision type + + + + + Formatting revision type + + + + + StyleDefinition revision type + + + + + MoveFrom revision type + + + + + MoveTo revision type + + + + + Revisions to preserve in track changes ballloons + + + + + Renders revisions in inline in the PDF. + + + + + Renders deleted markup balloon in PDF. + CaptionEscapeDirectionCaptionEscapeDirection + + + + Renders formatting markup balloon in PDF. + + + + + Specifies the Import options. + + + + + Imports the contents from the source document, applies the default style (Normal), and preserves all other formatting as direct formatting in order to preserve the contents as in source document. + + + + + Imports the contents of the source document to the destination document, and applies the formatting of surrounding content to the destination document. + + + + + Imports only the text from the source document to the destination document. + + + + + Imports the contents of the source document to the destination document, and applies the styles present in the destination document, or imports the source style to the destination document when there is no style with the same name in the destination document. + + + + + Imports the contents of the source document to the destination document, and continues the list numbering. + + + + + Imports the contents of the source document to the destination document, and restarts the list numbering. + + + + + Represents the node types of CustomXMLNode. + + + + + Represents Element node type. + + + + + Represents Attribute node type. + + + + + Represents Text node type. + + + + + Represents Document node type. + + + + + Specifies the warning type element names + + + + + Date and Time + + + + + Annotation reference + + + + + Comment + + + + + Current section number + + + + + Custom shape + + + + + Group shape + + + + + Line number + + + + + Mathematical text + + + + + OLE object + + + + + Page number + + + + + Shape + + + + + Print merge helper field + + + + + SmartArt diagram + + + + + Track changes + + + + + Text box + + + + + WordArt + + + + + Watermark + + + + + Specifies the types of emphasis marks which can be displayed for each non-space character. + + + + + No Emphasis Mark + + + + + Dot Emphasis Mark Above Characters + + + + + Comma Emphasis Mark Above Characters + + + + + Circle Emphasis Mark Above Characters + + + + + Dot Emphasis Mark Below Characters + + + + + Specifies the text rendering direction + + + + + Left to Right + + + + + Right to left + + + + + Document's AbsoluteTab Relation. + + + + + Relative to margin. + + + + + Relative to indent. + + + + + Document's AbsoluteTab Relation. + + + + + left alignment. + + + + + center alignment. + + + + + right alignment. + + + + + The none + + + + + The round + + + + + The square + + + + + The angle + + + + + The curly + + + + + Specifies the data type of external data source. + + + + + Specifies the possible results which may be generated when a mail merge is carried out on a document. + + + + + Specifies the possible types for a mail merge source document. + + + + + Specifies how Microsoft Word will report errors detected during mail merge. + + + + + Specifies the AutoFitType + + + + + Fit the contents respect to contents. + + + + + Fit the contents respect to window/pagewidth. + + + + + Fit the contents respect to fixed column width. + + + + + Specifies the printer paper tray. + + + + + The default bin + + + + + The only bin + + + + + The lower bin + + + + + The middle bin + + + + + The manual feed + + + + + The envelope feed + + + + + The manual envelope feed + + + + + The automatic sheet feed + + + + + The tractor feed + + + + + The small format bin + + + + + The large format bin + + + + + The large capacity bin + + + + + The paper cassette + + + + + The form source + + + + + + + + + + + + + + + Determines whether [is pattern empty] [the specified pattern]. + + The pattern. + + true if it is the specified pattern empty, set to true. + + + + + Strings to regex. + + The given. + if it is case sensitive, set to true. + if it is specified to search a whole word, set to true. + + + + + Gets the start index of the range. + + The paragraph. + The start. + The Text Range. + + + + + Ensures both and have same owner information. + + Starting text range of the text to find. + Ending text range of the text to find. + Returns true if start and end text ranges are from same owner, else returns false + Ensures the start and end text ranges are in same paragraph or same inline content control, + and also ensures there is no inline content control in between them. + + + + Get the start index of the range, inside inline content control. + + of that need to check. + Position value to find the text range. + Object to hold the found . + Returns start index and also that text range element, which has position value. + + + + + + + + + TextFinder variable. + + + + + Finds the text by specified pattern. + + The paragraph. + The pattern. + if it is only first match, set to true. + + + + + Finds the text by specified pattern. + + The paragraph. + The pattern. + if it is only first match, set to true. + + + + + Constructs a text representation of the provided paragraph with spaces added at specified positions + + + + + Finds the in items. + + The paragraph item collection to find inside the items. + The pattern. + if it is only first match, set to true. + The selections. + + + + Gets the text body of paragraph item. + + The item. + + + + + Finds the text by specified pattern in single-line mode. + + The text body. + The pattern. + + + + + Finds the text by specified pattern in single-line mode. + + The text body. + The pattern. + The start index. + The end index. + + + + + Finds the in items. + + The paragraph. + The pattern. + The start index. + The end index. + + + + + Finds the single-line text by pattern. + + The pattern. + + + + + Finds the text by specified pattern in table using single-line mode. + + The tables. + The pattern. + + + + + Forms the list of text selections. + + The paragraphs. + The match. + + + + + Close this instance. + + + + + Gets the instance of TextReplacer. + + The instance. + + + + + + + + + Class provides replacing method for the specified paragraph + + + + + TextReplacer variable. + + + + + Replaces the specified paragraph. + + The paragraph. + The pattern. + The replace. + + + + + Ensures whether start and end text range are from same owner. + + Represents a paragraph to find the text ranges. + Starting character position from matched text. + Ending character position from matched text. + Starting text range, to perform further operations. + Index of starting text range, to perform further operations. + + + + + Replaces the in items. + + A to perform replacement in its items. + The pattern. + The replacement. + + + + + Replaces the single line. + + The find text. + The replacement. + + + + Replaces the single=line selection with TextSelection. + + Single-line selection to replace. + The replacement. + + + + Replaces the single-line selection with TextBodypart. + + Single-line selection to replace. + The replacement. + + + + Removes the owner paragraph from selection in case paragraph is empty. + + The selection. + + + + Removes the internal items. + + A to remove internal items from the start index + + Start index of the range. + + + + + Corrects the next items. + + Item which position value is changed recently. + The start index. + The offset. + + + + Gets the instance of TextReplacer. + + The instance. + + + + The exception that is thrown when a layouting error occurs. + + + + + Default exception message. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The inner exc. + + + + Initializes a new instance of the class. + + The message. + + + + Initializes a new instance of the class. + + The message. + The inner exc. + + + + Initializes a new instance of the class. + + The object that holds the serialized object data. + The contextual information about the source or destination. + + + + The exception that is thrown when a layouting error occurs. + + + + + Default exception message. + + + + + Default constructor. + + + + + Initializes a new instance of the class. + + The inner exc. + + + + Initializes a new instance of the class. + + The message. + + + + Initializes a new instance of the class. + + The message. + The inner exc. + + + + Summary description for TableLayoutInfo. + + + + + Gets or sets the width. + + The width. + + + + Gets the height. + + The height. + + + + Gets or sets the width of the cells. + + The width of the cells. + + + + Gets the headers row count. + + The headers row count. + + + + Gets the is default cells. + + The is default cells. + + + + Gets or sets if the table is splitted + + + + + Gets the cell spacings. + + The cell spacings. + + + + Gets the cell paddings. + + The cell paddings. + + + + Class representing the layout area. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The area. + + + + Initializes a new instance of the class. + + The area. + The spacings. + + + + Cuts from left. + + The x. + + + + Cuts from left. + + The x. + + + + Updates the dynamic relayout bounds. + + The x. + The y. + if set to true [is need to update width]. + The width. + + + + Cuts from top. + + The y. + + + + Cuts from top. + + The y. + + + + Cuts from top. + + The y. + The footnote height. + Is skip to update the Y position. + + + + Cuts from top. + + + + + When second layouting occurs the clientactivearea has assigned a new value. + + + + + Updates the client area. + + + + + + + + + + Update Bounds based on Text Wrap + + + + + + + Updates the Width + + + + + + Updates the left position + + + + + + Gets the width. + + The width. + + + + Gets the height. + + The height. + + + + Gets or sets a value indicating whether [skips subtract when invalid parameter]. + + + true if [skips subtract when invalid parameter]; otherwise, false. + + + + + Gets the margins. + + The margins. + + + + Gets the paddings. + + The paddings. + + + + Gets the outer area. + + The outer area. + + + + Gets the client area. + + The client area. + + + + Gets the client active area. + + The client active area. + + + + Summary description for ILayoutedRange. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies the footnote textbody height of the current line + + + + + Specifies the endnote textbody height of the current line + + + + + Specifies the any of floating item intersects in current line. + + + + + Specifies the document has track changes. + + + + + Specifies the text range has RTL text. + + + + + Initializes a new instance of the class. + + The widget. + + + + Initializes a new instance of the class. + + The widget. + + + + Initializes a new instance of the class. + + The widget. + The location. + + + + Get the footnote textbody height + + + + + + + Get the footnote textbody height + + + + + + + Retreive pagragraphs present in the cells. + + paragraph widget of cells + + + + Determines whether the given widget is Table widget or not. + + The widget. + + + + + Gets the frame clip bounds + + Current paragraph widget bounds + Current paragraph paragraph format + Paragrph layoutinfo + + + + + Checks the type of the widget. + + The widget. + + + + + Initializing LayoutInfo value to null + + + + + Initializing LayoutInfo value to null for textwrap elements + + + + + Initializes the layout information all. + + + + + + + + + + + + + + Shifts the location. + + The x offset. + The y offset. + + + + Determines whether the floating items need to be align or not. + + + + + + Determines whether the floatting item need to be align or not based on the compatibility mode. + + The compatibility mode. + if set to true [dont vert align cell with sp]. + if set to true [layout in cell]. + + + + + Shifts the location. + + The X offset + The y offset.s + Height of the footer. + Height of the page. + + + + Shifts the location. + + The x offset. + The y offset. + if set to true [is picture need to be shifted]. + Height of the footer. + Height of the page. + + + + Updates the text wrapping bounds for a layouted floating items. + + The layouted widget. + The document layouter containing the floating items. + + + + Retrieves the distance values for wrapping around a widget. + + The widget for which to retrieve distance values. + Reference to the distance from the left side. + Reference to the distance from the right side. + Reference to the distance from the top side. + Reference to the distance from the bottom side. + + + + The absolute table shifted based on bottom if absolute table bottom exceeded the page bottom. + + The widget + The x offset. + + + + The absolute table shifted based on bottom if absolute table bottom exceeded the page bottom. + + The widget + The x offset. + + + + Shifts the location of CommentsMarkUp. + + The x offset. + The y offset. + Collection of markups. + + + + Get the groupShape width before shrink + + + + + + + Get the groupShape width before shrink + + + + + + + Get the extension width and height of group shape + + + + + + + + + Get the base entity + + + + + + + Update Layouted Widget Bounds for the Nested Table + + + + Owner cell Width + Owner cell Height + + + + Get owner textbody bounds + + Returns owner textbody bounds + + + + Determine Whether the layouted Widget Bounds is need to be update or not. + + + + + + + Aligns the bottom. + + The g. + + + + Checks whether the paragraph is list paragraph. + + Return True,if the paragraph is list paragraph; Else false. + + + + Check we need to update the List Y Position. + + Return True,if the paragraph have child entities; Else false. + + + + Check whether the line contains picture + + + + + + Determines whether the paragraph has no valid items. + + + + + + Shifts the line child widgets based on top Ascent value + + Drawing context + Maximum Ascent + Top line space + Maximum height + Extra line ascent + Refers the inline floating item is inside the line when the paragraph line spcing rule is exactly + + + + Get the text ascent value for the math widget. + + Indicates the layouted MathWidget. + Drawing Context to get decent value. + + + + + Shifts the Y for the list value based on top Ascent value. + + Drawing context + Maximum Ascent + Top line space + Maximum height + Extra line ascent + + + + Shifts the Y position. + + Drawing context + Text ascent + Maximum ascent + Top line space + Maximum height + Exceeded line ascent + Extra line ascent + Character format + Layoute widget (shifts Y position based on layouted widget) + Size (shifts Y position based on List value) + + + + Detetmines whether the line contains the raised position. + + + + + Determines whether it is maximum height in line or not. + + Drawing context + Height + Returns true if height is maximum + + + + Determines whether the MathML item exist in line or not. + + Returns true if contains Math in a line. + + + + Gets the paragraph. + + The widget. + + + + + Calculates the max child widget. + + The g. + Height of the max. + The max ascent. + + + + Checks whether paragraph has only tabs. + + + + + + Gets field for current widget. + + + + + + Determines whether the field code paragraph height is need to skip or not. + + + + + + Determines whether [is inline floating item] [the specified item]. + + The item. + + + + + Aligns the Center + + The Custom graphics. + Width of the sub + is for center align + + + + Aligns the Right + + The Custom graphics. + Width of the sub + is for center align + + + + Aligns the Right + + The Custom graphics. + Width of the sub + + + + Consider valuable right positon in layputed widget collection for right alignment + + + + + + + Aligns the justify. + + The custom graphics. + Width of the sub. + + + + Check wether the next layouted widget's has renderable content whose width is greater than zero + + + + + + + + Get index of the tab from the current line + + + + + + Get the Text Range + + + + + + + Decides whether document is not Word 2013 compatible. + + + + + + Get Space Delta + + + + + + + + + + Updates the para first line horizontal positions. + + The paragraph information. + The widget. + The x. + The width. + + + + Determines whether it includes the specified widget in line height. + + The widget. + + + + + Determines whether it includes the specified text widget in line height. + + The widget. + + + + + Gets or sets the prev tab justification. + + The prev tab justification. + + + + Gets or sets the no. of spaces + + + + + True, if it is last line of the paragraph + + + + + Gets or Sets the SubWidth + + + + + Gets or sets the HorizontalAlignment + + + + + Gets or sets the Extra Wordspace, needs to be added while justifying + + + + + Gets or sets the text tag. + + The text tag. + + + + + + + + + + + + + + + + + + + Gets or sets Character Range Type in the widget + + + + + Gets or sets Owner Layouted Widget + + + + + + + Indicate the word which contains trimmed empty spaces charcters at end + + + + + It holdes the floating item bounds which are instersecting current line. + + + + + Represents the collection of layouted widget. + + + + + Represent the layouted widget of WMath instance. + + + + + Initializes a new instance of the class with the + specified instance. + + Represent the WMath instance + + + + Initializes a new instance of the class by cloning the + specified instance. + + Represent the source widget to get clone + + + + Disposes the instances. + + + + + Shifts the X,Y position of LayoutedMathWidget. + + Represents the X position to Shift. + Represents the Y position to Shift. + Decides to update owner containder bounds or not. + + + + Shifts the X,Y position of LayoutedMathWidget. + + Represents the X position to Shift. + Represents the Y position to Shift. + + + + Gets the Ascent or center point of the layouted math widget. + + + + + + Gets the child elements of the LayoutedMathWidget. Read-only + + The layouted widget collection of WMath child elements. + + + + Represent the layouted widget of OfficeMath instance. + + + + + Initializes a new instance of the class with the + specified instance. + + Represent the IOfficeMath instance + + + + Initializes a new instance of the class by cloning the + specified instance. + + Represent the source widget to get clone + + + + Disposes the instances. + + + + + Shifts the X,Y position of Layouted OfficeMath Widget. + + Represents the X position to Shift. + Represents the Y position to Shift. + Decides to update owner containder bounds or not. + + + + Shifts the X,Y position of Layouted OfficeMath Widget. + + Represents the X position to Shift. + Represents the Y position to Shift. + + + + Gets the vertical center point of a layouted office math widget. + + Represent the layouted office math widget to find. + Returns the vertical center point of an LayoutedOMathWidget. + + + + Gets the vertical center point of a layouted office math widget. + + Represent the layouted office math widget to find. + Represent the maximum height widget index in LayoutedOMathWidget collection. + Returns the vertical center point of an LayoutedOMathWidget. + + + + Gets the center point of a specified math function. + + Represent the layouted widget of an function to find the center point. + Returns the center point of an function. + + + + Gets the child elements of the LayoutedOMathWidget. Read-only + + The layouted widget collection of OfficeMath child elements. + + + + Gets or Sets the bounds of a LayoutedOMathWidget + + The rectangle bounds of LayoutedOMathWidget. + + + + Gets the widget (IOfficeMath Entity) of the corresponding LayoutedOMathWidget. Read-only + + The of the layouted widget. + + + + Gets or Sets the Owner layouted widget. + + + + + Represent the layouted widget of OfficeMathFunctionBase instance. + + + + + Represent the interface of LayoutedFuntionWidget instance. + + + + + Shift the corresponding layouted funtion widget's X,Y positions. + + Represent the X position value to shift. + Represent the Y position value to shift. + + + + Disposes the instances. + + + + + Gets the widget (IOfficeMathFunctionBase Entity) of the corresponding LayoutedFuntionWidget. Read-only + + The of the layouted widget. + + + + Gets or Sets the bounds of a LayoutedFuntionWidget + + The rectangle bounds of LayoutedFuntionWidget. + + + + Gets or Sets the Owner layouted widget. + + + + + Initializes a new instance of the class with the + specified instance. + + Represent the IOfficeMathFunctionBase instance + + + + Initializes a new instance of the class by cloning the + specified instance. + + Represent the source widget to get clone + + + + Shift the layouted widget X,Y positions. + + Represent the X position value to shift. + Represent the Y position value to shift. + + + + Disposes the instances. + + + + + Gets the widget (IOfficeMathFunctionBase Entity) of the corresponding LayoutedFuntionWidget. Read-only + + The of the layouted widget. + + + + Gets or Sets the bounds of a LayoutedFuntionWidget + + The rectangle bounds of LayoutedFuntionWidget. + + + + Gets or Sets the Owner layouted widget. + + + + + Represent the layouted widget of OfficeMathRunElement instance. + + + + + Initializes a new instance of the class with the + specified instance. + + Represent the IOfficeMathFunctionBase instance + + + + Initializes a new instance of the class by cloning the + specified instance. + + Represent the source widget to get clone + + + + Shift the layouted widget X,Y positions. + + Represent the X position value to shift. + Represent the Y position value to shift. + + + + Disposes the instances. + + + + + Gets the widget (IOfficeMathFunctionBase Entity) of the corresponding LayoutedFuntionWidget. Read-only + + The of the layouted widget. + + + + Gets or Sets the of corrsponding run element. + + The represents a layouted widget of a run element. + + + + Gets or Sets the Owner layouted widget. + + + + + Represent the layouted widget of OfficeMathFraction instance. + + + + + Initializes a new instance of the class with the + specified instance. + + Represent the IOfficeMathFunctionBase instance + + + + Initializes a new instance of the class by cloning the + specified instance. + + Represent the source widget to get clone + + + + Shift the layouted widget X,Y positions. + + Represent the X position value to shift. + Represent the Y position value to shift. + + + + Disposes the instances. + + + + + Represent the layouted widget of a Numerator. + + + + + Represent the layouted widget of a Denominator. + + + + + Represent the layouted widget of a FractionLine. + + + + + Represent the layouted widget of OfficeMathDelimiter instance. + + + + + Initializes a new instance of the class with the + specified instance. + + Represent the IOfficeMathFunctionBase instance + + + + Initializes a new instance of the class by cloning the + specified instance. + + Represent the source widget to get clone + + + + Shift the layouted widget X,Y positions. + + Represent the X position value to shift. + Represent the Y position value to shift. + + + + Disposes the instances. + + + + + Represent the layouted widget of a BeginCharacter. + + + + + Represent the layouted widget of a EndCharacter. + + + + + Represent the layouted widget of a Seperator. + + + + + Represent the layouted widget of a Equation. + + + + + Represent the layouted widget of OfficeMathDelimiter instance. + + + + + Initializes a new instance of the class with the + specified instance. + + Represent the IOfficeMathFunctionBase instance + + + + Initializes a new instance of the class by cloning the + specified instance. + + Represent the source widget to get clone + + + + Shift the layouted widget X,Y positions. + + Represent the X position value to shift. + Represent the Y position value to shift. + + + + Disposes the instances. + + + + + Gets/Sets whether to show the equation or not. + + + + + Represent the layouted widget of a Equation. + + + + + Represent the layouted widget of OfficeMathRadical instance. + + + + + Initializes a new instance of the class with the + specified instance. + + Represent the IOfficeMathFunctionBase instance + + + + Initializes a new instance of the class by cloning the + specified instance. + + Represent the source widget to get clone + + + + Shift the layouted widget X,Y positions. + + Represent the X position value to shift. + Represent the Y position value to shift. + + + + Disposes the instances. + + + + + Represent the layouted widget of a Degree. + + + + + Represent the layouted widget of a Equation. + + + + + Represent the layouted widget of a RadicalLines. + + + + + Represent the layouted widget of OfficeMathLimit instance. + + + + + Initializes a new instance of the class with the + specified instance. + + + + + + Initializes a new instance of the class by cloning the + specified instance. + + + + + + Shift the layouted widget X,Y positions. + + Represent the X position value to shift. + Represent the Y position value to shift. + + + + Disposes the instances. + + + + + Represent the layouted widget of the Limit. + + + + + Represent the layouted widget of the Equation widget. + + + + + Represent the layouted widget of OfficeMathBox instance. + + + + + Initializes a new instance of the class with the + specified instance. + + + + + + Initializes a new instance of the class by cloning the + specified instance. + + + + + + Shift the layouted widget X,Y positions. + + Represent the X position value to shift. + Represent the Y position value to shift. + + + + Disposes the instances. + + + + + Represent the layouted widget of the Equation widget. + + + + + Represent the layouted widget of OfficeMathScript instance. + + + + + Initializes a new instance of the class with the + specified instance. + + Represent the IOfficeMathFunctionBase instance + + + + Initializes a new instance of the class by cloning the + specified instance. + + Represent the source widget to get clone + + + + Shift the layouted widget X,Y positions. + + Represent the X position value to shift. + Represent the Y position value to shift. + + + + Disposes the instances. + + + + + Represent the layouted widget of a Superscript. + + + + + Represent the layouted widget of a Subscript. + + + + + Represent the layouted widget of a Equation. + + + + + Represent the layouted widget of OfficeMathNArray instance. + + + + + Initializes a new instance of the class with the + specified instance. + + Represent the IOfficeMathFunctionBase instance + + + + Initializes a new instance of the class by cloning the + specified instance. + + Represent the source widget to get clone + + + + Shift the layouted widget X,Y positions. + + Represent the X position value to shift. + Represent the Y position value to shift. + + + + Disposes the instances. + + + + + Represent the layouted widget of a Superscript. + + + + + Represent the layouted widget of a Subscript. + + + + + Represent the layouted widget of a Equation. + + + + + Represent the layouted widget of a NArrayCharacter. + + + + + Represent the layouted widget of OfficeMathFunction instance. + + + + + Initializes a new instance of the class with the + specified instance. + + + + + + Initializes a new instance of the class by cloning the + specified instance. + + + + + + Shift the layouted widget X,Y positions. + + Represent the X position value to shift. + Represent the Y position value to shift. + + + + Disposes the instances. + + + + + Represent the layouted widget of the Function name widget. + + + + + Represent the layouted widget of the Equation widget. + + + + + Represent the scaling factor of the accent character. + + + + + Represent the layouted widget of OfficeMathFunction instance. + + + + + Initializes a new instance of the class with the + specified instance. + + + + + + Initializes a new instance of the class by cloning the + specified instance. + + + + + + Shift the layouted widget X,Y positions. + + Represent the X position value to shift. + Represent the Y position value to shift. + + + + Disposes the instances. + + + + + Represent the layouted widget of the Function name widget. + + + + + Represent the layouted widget of the Equation widget. + + + + + Represent the scaling factor of the accent character. + + + + + Represent the layouted widget of Line, thats used in MathML. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class by cloning the + specified instance. + + Represent the source widget to get clone + + + + Shift the layouted widget X,Y positions. + + Represent the X position value to shift. + Represent the Y position value to shift. + + + + Disposes the instances. + + + + + Represent the bounds of a layouted string. + + + + + Represent the Text of a layouted string. + + + + + Represent the Font of a layouted string. + + + + + Represent whether current layouted string widget is stretchable or not. + + + + + Represent the layouted widget of OfficeMathFunction instance. + + + + + Initializes a new instance of the class with the + specified instance. + + + + + + Initializes a new instance of the class by cloning the + specified instance. + + + + + + Shift the layouted widget X,Y positions. + + Represent the X position value to shift. + Represent the Y position value to shift. + + + + Disposes the instances. + + + + + Represent the layouted widget of the Function name widget. + + + + + Represent the layouted widget of the Equation widget. + + + + + Represent the layouted widget of OfficeMathBorderBox instance. + + + + + Initializes a new instance of the class with the + specified instance. + + + + + + Initializes a new instance of the class by cloning the + specified instance. + + + + + + Shift the layouted widget X,Y positions. + + Represent the X position value to shift. + Represent the Y position value to shift. + + + + Disposes the instances. + + + + + Gets or sets a value that represents a BorderPoints + + + + + Specifies a object that represents the base of the specified equation object. + + + + + Represent the layouted widget of OfficeMathEquationArray instance. + + + + + Initializes a new instance of the class with the + specified instance. + + Represent the IOfficeMathFunctionBase instance + + + + Initializes a new instance of the class by cloning the + specified instance. + + Represent the source widget to get clone + + + + Shift the layouted widget X,Y positions. + + Represent the X position value to shift. + Represent the Y position value to shift. + + + + Disposes the instances. + + + + + Represent the layouted widget of a Equation. + + + + + Represent the layouted widget of OfficeMathBar instance. + + + + + Initializes a new instance of the class with the + specified instance. + + + + + + Initializes a new instance of the class by cloning the + specified instance. + + + + + + Shift the layouted widget X,Y positions. + + Represent the X position value to shift. + Represent the Y position value to shift. + + + + Disposes the instances. + + + + + Gets or sets a value that represents a BorderPoints + + + + + Specifies a object that represents the base of the specified equation object. + + + + + Represent the layouted widget of OfficeMathMatrix instance. + + + + + Initializes a new instance of the class with the + specified instance. + + + + + + Initializes a new instance of the class by cloning the + specified instance. + + + + + + Shift the layouted widget X,Y positions. + + Represent the X position value to shift. + Represent the Y position value to shift. + + + + Disposes the instances. + + + + + Represent the layouted widget of Line, thats used in MathML. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class by cloning the + specified instance. + + Represent the source widget to get clone + + + + Shift the layouted widget X,Y positions. + + Represent the X position value to shift. + Represent the Y position value to shift. + + + + Disposes the instances. + + + + + Represent the starting point of a layouted line. + + + + + Represent the ending point of a layouted line. + + + + + Represent the color of a layouted line. + + + + + Represent the width of a layouted line. + + + + + Represent whether to skip the line or not. + + + + + Class represents the layouter. + + + + + Represents an layouting operator. + + + + + Sends the event that current leaf widget lay outed complete. + + The widget. + + + + Gets or sets the custom graphics. + + The custom graphics. + + + + + + + + + Client LayoutArea + + + + + Page Top margin of the client area + + + + + + + + Holds the table of content + + + + + Layout specified widget container. + Method use ILayoutProcessHandler for control layout process + + The widget. + The handler. + The dc. + + + + Removes the layouted footnote widget from the page once dynamic relayout starts at the intersection points. + + + + + Remove split string widgets from the first paragraph of current page. + + ltwidget of current page. + Here, we removed the skipped widgets of LCLineContainer.ChangeChildsAlignment method. + + + + Layout a content in the track changes balloon. + + + + + Gets the balloon layoutted widget + + + + + + + + Gets the balloon y position. + + + + + + Adjust the balloon position for the multiple balloons in same line of track changes. + + + + + + check whether the current widget is need to be layout + + + + + + + + + Sends the event that current leaf widget lay outed complete. + + The widget. + + + + Resets the flags which are all used for word layouting funtionality + + + + + + + + Gets the left margin of section based on mirror margin property. + + + + + + + Gets the Right margin of section based on mirror margin property. + + + + + + + Gets the height of the header on the current page. + + + + + + Gets the current page right position value. + + Right Margin position value. + + + + + + + + + Gets or set the previous layouted widget + + + + + Gets or Sets the frame bounds. + + Holds the overall floating frame bounds and it will reset once frame bounds added to floatingItems collection + + + + Gets or sets that the value indicating whether currently layouting Vertical Merge Start cell or not. + + + + + Gets and set the IsNeedToRestartFootnote + + + + + Gets and set the m_canSplitbyCharacter + + + + + Gets and set the m_canSplitByTab + + + + + Gets and set the IsNeedToRestartEndnote + + + + + Gets and set the IsNeedToRestartFootnoteID + + + + + Gets and set the IsNeedToRestartEndnoteID + + + + + Gets the current page index + + + + + Get or Set the re-layout flag. + + + + + Determines whether current layout process is to fit Word 2013 Justification extra words. + + + + + Gets or sets a value indicating whether to relayout the table. + + true if relayout the table; otherwise, false. + + + + Gets the current page number + + + + + Holds the widgets height which is removed from column by Keepwithnext behavior. This is used only for multi column with continous section break. + + + + + Gets or sets the IsRowFitInSamePage. + + + + + Gets or sets the IsLayoutingHeaderRow. + + + + + Represent whether current layouting process is for TrackChanges or not. + + + + + Represent whether at least one item fitted in a line or not. + + + + + Gets or sets the field entity. + + The custom graphics. + + + + Gets or sets the custom graphics. + + The custom graphics. + + + + Get or set the Unknown field. + + + + + Gets the Client LayoutArea. + + The ClientLayoutArea. + + + + + Gets the frame layout area. + + The frame layout area. + + + + Gets the frame Height with Height type as Atleast + + The frame height + + + + A boolean denotes whether skip to consider bottom or not for Frame with atleast height. + For atleast frame height, if there is space available to consider bottom values along with content height means, then skip to consider bottom(spacing+ line width) after the alteast frame height. + + + + + Gets the IsLayoutingHeaderFooter. + + The IsLayoutingHeaderFooter. + + + + Gets the IsLayoutingHeader + + The IsLayoutingHeader + + + + Gets the First Item in the line + + + + + Checks whether currently we are layouting the table to find its height. + + + + + Check if currently layouting the footnote content + + + + + Get or set the wrapping difference. + + The widget container. + + + + Gets or sets the maximum right position of tab stop inter secting floatting items. + + + The maximum right position of tab stop inter secting floatting items. + + + + + Gets or sets the right position of tab stop interSect floatting items. + + + The right position of tab stop inter floatting items. + + + + + Gets the toc entry page numbers. + + + The toc entry page numbers. + + + + + Gets the TOC link styles instance + + The TOC link style instance + + + + Gets the hidden paragraphs in a document. + + Hidden paragraphs collection + + + + Get last TOC pargraph + + + + + Gets a value indicating whether updating Page fields. + + true if updating Page fields; otherwise, false. + + + + Gets or sets a value indicating whether footer area needs to adjust or not. + + true if updating Page fields; otherwise, false. + + + + Gets the Footnote widgets. + + + + + Gets the Footnote count. + + + + + Gets the line number widgets. + + + + + Gets the Endnote widgets. + + + + + Gets the TrackChangesMarkups widgets. + + + + + Gets the Endnote widgets. + + + + + Gets the number of behind widgets in header. + + + + + Gets the number of behind widgets in footer. + + + + + Gets the Endnote section index. + + + + + Gets the current section. + + + The current section. + + + + + Gets the page client height. + + + + + Gets the Footnote section index. + + + + + Get the Splitted Footnote widgets + + + + + Get or set the Splitted Endnote widgets + + + + + Get or set the Endnote instances + + + + + Gets the wrapping entity collection. + + + + + Get the floating item, when the wrapping style have InFrontOfText or Behind + + + + + Gets or sets the dynamic paragraph. + + + The dynamic paragraph. + + + + + Gets or sets the dynamic table. + + + The dynamic table. + + + + + Gets or sets the not fitted floating item. + + + The Not fitted floating item. + + + + + Gets the wrapping entity collection. + + + + + Gets the wrapping entity collection. + + + + + Gets the page end widget. + + + The page end widget. + + + + + Decides whether to force fit the widgets during layouting process. + While creating new page this property will be enabled. + + + + + Decides whether multi column with continue section content layouting. + + + + + Gets or sets the previous tab. + + The previous tab. + + + + Gets or sets the width of the previous tab. + + The width of the previous tab. + + + + Gets or sets a value indicating whether the tab preserved in-between the indent. + + true if tab preserved in-between the indent; otherwise, false. + + + + Gets or sets the table of content. + + + + + Gets or sets the current column index + + + + + Gets or sets the consecutive hyphenate line count. + + + + + Holds the current paragraph Original Y position. + This property value won't change when paragraph wrapped by floating item. + + + + + Determines whether two lines are layouted for paragraph with Widow/Orphan control. + + when the paragraph has Widow/OrphanControl and the footnote position for current section is bottom of the page, + this flag denotes whether minimum two lines of the paragraph are layouted. + + + + Determines whether the footnote's textbody is adjusted to fit two lines of corresponding paragraph. + + The corresponding paragraph of footnote has Widow/Orphan control and the footnote position is bottom of the page. + Then only adjust the footnote to fit two lines of paragraph + + + + It holds the current line's white space widths. + + + + + + + + + + It is used to find the deleted and formatted text along with its coordinates while track changes is on. + + + + + Gets the balloon value for the markup type. + + + + + + + Display balloon value for the formatted text. + + + + + + + + + Display balloon value for removed existing character format in track changes. + + + s + + + + + + Get the display name based on the locale. + + + + + + + Returns formatting text for the text style applied in shadding. + + + + + + + Generate formatting text for shading formattings in track changes. + + + + + + + + + Returns a color name equivalent to Word 2013 behavior for the formatting changes. + + + + + + + Generate balloon value for the paragraph formattings in track changes. + + + + + + + + Mehtod to get formatted paragraph alignment string + + + + + + + Generate balloon value for the removed paragraph formattings from existing in track changes. + + + + + + + + Generate formatting text for paragraph texture style formatting in track changes + + + + + + + + + Generate formatting text for paragraph background color formatting in track changes + + + + + + + + + Generate formatting text for paragraph fore color formatting in track changes + + + + + + + + + Returns a balloon vaue for formattings in borders in track changes. + + paragraph format to get modified properties values from + + + + + Returns a balloon vaue for formattings in paragraph spacing in track changes. + + new property hash to check whether keys are present + paragraph format to get modified properties values from + + + + + Returns a balloon vaue for formattings in frame in track changes. + + + + + + + + Returns balloon value for formattings in Frame wrapping. + + + + + + + Returns the balloon value for formattings in Frame Y position. + + + + + + + Returns the balloon value for formatting in Frame X position. + + + + + + + Returns balloon value for indents formattings in paragraph. + + + + + + + + Get the balloon value for the tab alignments. + + + + + + + Displays balloon value for list format changes in paragraph. + + + + + + + + Returns the balloon value for list pattern formattings. + + + + + + + Appends the textrange in deletions balloon. + + + + + + + Concat string values in the dictionary to a single string value. + + dictionary that contains string values + single string value + + + + Gets a WordDocument object. + + + + + Represents a Y position of Track Chaneges Ballon. + + + + + Get or Set the Markup Type + + + + + + Get or Set the text from the revision. + + + + + + Get or Set the position of the track changes markups + + + + + + LayoutWidget for balloon + + + + + Holds the empty space value + + + + + Checks whether the track changes markup position is aligned or not. + + + + + It is used to find the comment text along with its coordinates while CommentDisplayMode is ShowInBalloons. + + + + + Gets the balloon value for the comments. + + Returns the balloon value for the comments. + + + + Appends a paragraph into Comments balloon. + + + + + Apply the Comments properties to Comments Body. + + + + + Gets a Comment of the MarkUp. + + + + + Gets a Comment ID of the MarkUp. + + + + + Gets or Sets a extra spacing (Line/After/Before spacing) of line. + + + + + Class to hold the floating items. + + + + + Sorts the specified floating items. + + The floating items. + The sort list based on. + + + + Check whether Y position intersect or not + + + + + + + + Sorts the same y position floating items based on x position. + + The floating items. + The sort list based on. + + + + Sorts the intersected y position floating items based on x position. + + The floating items. + The sort list based on. + + + + Updates the wrap collection index after sorting. + + The floating items. + Current sort item index + Index in which the floating item to be inserted + + + + Sorts the X position floating items based on Y position. + + + + + + Check whether Y position intersect or not + + + + + + + + + Determines whether the sorted item need to be changed or not. + + The sort list based on. + The first item. + The secon item. + + + + + Get the floating item bounds,which preserved left side of current floating item. + + + + + + + + Get the list of floating item, which preserved left side of current floating item. + + + + + + + + Get the floating item which has minimum bottom. + + + + + + + Get or Set the wrapping bounds. + + + + + + Get or Set the wrapping element instances. + + While considering the Frame object as floating item, first entity of frame is maintained in this property. + And remaining items are maintained in FrameEntities property. + + + + + + Gets or Sets the frame entities. + + Contains frame entites, if current floating item is frame; Otherwise null. + + + + Gets wrapping style. + + + + + + Gets wrapping type + + + + + + + + Gets the boolean value that represents whether a floating entity in a table is displayed inside or outside the table. + + + + + Gets or sets the index of the wrap collection. + + + The index of the wrap collection. + + + + + Gets or sets a value indicating whether this instance is floating item fit. + + + true if this instance is floating item fit; otherwise, false. + + + + + Gets or sets a value indicating whether the instance is added. + + + true if the instance is added; otherwise, false. + + + + + Class to hold the layouted equation field switches. + + + + + Entity for the equation field. + + + + + Represents a layouted equation field switch. + + + + + Class to hold the layouted equation field. + + + + + Holds the bounds points of the layouted EQ fields. + + + + + Child widgets, to hold collection of layouted EQ fields. + + + + + Denotes the types of the EQ field switch. + + + + + Holds the alignment of the layouted EQ fields. + + + + + Types of EQ field switch + + + + + Class to hold the line related EQ field + + + + + Class to hold the text related EQ field + + + + + Summary description for FieldLayoutInfo. + + + + + Initializes a new instance of the class. + + if set to true [b top subtract area]. + + + + Gets/Sets boolean value to indicate whether line break need to be removed if it is last item in a paragraph + + + + + Summary description for TableLayoutInfo. + + + + + + + + + + + + + + + + + + + + + + + + + + Checks whether the table is need to autofit to content or not. + + True, If the preferred width of the column is not defined. Else returns false + + + + Add empty paragraph to empty cell in the sepcified table + + Specify the table + + + + + + + + + + Gets the Table height using row height + + + + + + + Gets the table row height + + + + + + + Gets / sets table width + + + + + Gets table height + + + + + Gets / sets cells width array + + + + + Gets / sets count of headers rows + + + + + Gets the bool values array determining if cells are default + + + + + Gets or sets a value indicating whether this table is splitted table + + + true If this table is splitted into next page; otherwise, false> + + + + + Gets or sets the height of the header row. + + + The height of the header row. + + + + + Gets or sets a value indicating whether this instance is header row height updated. + + + true if this instance is header row height updated; otherwise, false. + + + + + Gets the paddings. + + The paddings. + + + + Gets the margins. + + The margins. + + + + Gets owner table cell spacings. + + + + + Gets owner cell paddings. + + + + + Summary description for RowLayoutInfo. + + + + + Initializes a new instance of the class. + + if set to true [is exactly row]. + Height of the row. + + + + Gets and sets IsFootnoteReduced + + + + + Gets and sets IsFootnoteSplitted + + + + + Gets or sets a value indicating whether this instance is exactly row height. + + + true if this instance is exactly row height; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is row splitted. + + + true if this instance is row splitted; otherwise, false. + + + + + Gets or sets the height of the row. + + The height of the row. + + + + Gets or sets a value indicating whether this instance is row has vertically merge continue cell. + + + true if this instance is row has vertically merge continue cell; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is row has vertically merge continue end cell. + + + true if this instance is row has vertically merge continue end cell; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is row has vertically merge start cell. + + + true if this instance is row has vertically merge start cell; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is row has vertical text cell. + + + true if this instance is row has vertical text cell; otherwise, false. + + + + + Gets or Sets a value inidcating whether this row is splitted by pagebreak before property inside the first item of cell + + + true if this row is splitted by page break before property ; otherwise,false. + + + + + Gets or sets a value indicating whether header row repeat or not + + + true If header row not repeat by floating items present in table; otherwise, false> + + + + + Gets or sets a value indicating whether the table cell padding is already updated for a row + + + + + Gets or sets a value indicating whether this instance is row splitted by floating item. + + + true if this instance is row splitted by floating item; otherwise, false. + + + + + Gets the paddings. + + The paddings. + + + + Gets the margins. + + The margins. + + + + Summary description for CellLayoutInfo. + + + + + Initializes a new instance of the class. + + The child layout direction. + + + + Determines the formats. + + + + + Checks the cell is vertically merged. + + The cell start position. + Width of the cell. + Index of the adj row. + + + + + Update the cell's border, padding, margins + + + + + Table style having padding value + + + Is Table Have Padding value,return true; else false + + + + Gets the Left HalfWidth. + + The cellIndex. + + + + + Gets the Right HalfWidth. + + The cellIndex. + The cellLast. + + + + + Gets the Bottom HalfWidth. + + The cellIndex. + The cellLast. + The rowIndex. + The rowLast. + + + + + Gets the Top HalfWidth. + + The cellIndex. + The rowIndex. + The Cell widget + Previous row index depends on splitted table + + + + + Gets the adjacent row cell. + Returns the horizontal merge start cell for merged cells. + + Index of the row. + Returns the adjacent row cell, ie., top and bottom cell + + + + Initilizes the layoutinfo values as null + + + + + Gets a value indicating whether this instance is column merge start. + + + true if this instance is column merge start; otherwise, false. + + + + + Gets a value indicating whether this instance is column merge continue. + + + true if this instance is column merge continue; otherwise, false. + + + + + Gets a value indicating whether this instance is row merge start. + + + true if this instance is row merge start; otherwise, false. + + + + + Gets a value indicating whether this instance is row merge continue. + + + true if this instance is row merge continue; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is row merge end. + + + true if this instance is row merge end; otherwise, false. + + + + + Gets the vertical alignment. + + The vertical alignment. + + + + Gets or sets the width of the cell content layouting. + + + The width of the cell content layouting. + + + + + Gets or sets a value indicating whether to skip top border. + + true if skip top border; otherwise, false. + + + + Gets or sets a value indicating whether to skip bottom border. + + true if skip bottom border; otherwise, false. + + + + Gets or sets a value indicating whether to skip left border. + + true if skip left border; otherwise, false. + + + + Gets or sets a value indicating whether to skip right border. + + true if skip right border; otherwise, false. + + + + Gets or sets the top padding. + + + The top padding. + + + + + Gets or sets the new top padding. + + + The new top padding. + + + + + Gets or sets the bottom padding. + + + The bottom padding. + + + + + Gets or sets the top border. + + + The top border. + + + + + Gets or sets the bottom border. + + + The bottom border. + + + + + Gets or sets the left border. + + + The left border. + + + + + Gets or sets the right border. + + + The right border. + + + + + Gets the updated top borders. + + + The updated top borders. + + + + + Gets the previous cell top border. + + + The previous cell top border. + + + + + Gets the next cell top border. + + + The next cell top border. + + + + + Gets or sets the previous cell bottom border. + + + The previous cell bottom border. + + + + + Gets or sets the next cell bottom border. + + + The next cell bottom border. + + + + + Gets or sets a value indicating whether this instance is cell has end note. + + + true if this instance is cell has end note; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is cell has foot note. + + + true if this instance is cell has foot note; otherwise, false. + + + + + Gets the paddings. + + The paddings. + + + + Gets the margins. + + The margins. + + + + Gets the type of the border. + + + The type of the border. + + + + + Gets the color of the border. + + + The color of the border. + + + + + Gets the width of the border line. + + + The width of the border line. + + + + + Gets the width of the border line. + + + The width of the border line. + + + + + Gets or sets the adj cell left border. + + + The adj cell left border. + + + + + Summary description for LayoutContext. + + + + + The minimum width for required for text to fit before the square type floating item. + + + + + The minimum width for required for text to fit before the Tight and throw type floating item in Word 2013. + + + + + The minimum width for required for text to fit before the Tight and Throw type floating item. + + + + + The minimum width for required for text to fit after the square type floating item. + + + + + The minimum width for required for text to fit after the Tight and throw type floating item in Word 2013. + + + + + The minimum width for required for text to fit after the Tight and Throw type floating item. + + + + + The maximum width. + + + + + The bottom overlap difference for tight and through wrapping style. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Right margin of client layout area + + + + + Initializes a new instance of the class. + + The widget. + The lc operator. + + + + Layouts the specified widget. + + The rect. + + + + + Determines whether ensure splitted. + + + true if ensure splitted; otherwise, false. + + + + + Does the layout after. + + + + + Layout Footnote + + + + + + + Retrun whether needs to consider Adjusting value for text wrapping. + + + + + + + + + + Get the minimum value Ms Word preserves for a text wrapping to occur. + + + + + + + + + Gets the footnote layouting client area. + + + + + + Denotes whether current cell is vertical merge start cell and owner row height type is exactly. + + + + + + + Check whether the owner entity is textbox or not + + + + + Checks whether Word document is 2013 format or not. + + + + + + + Returns true, if this paragraph is Word 2013 Justification. + + + + + + + Calculates the total padding and margin values for nested table. + + The current table. + + + + + Removes layouted behind wrapping style items from BehindWidgets collection. + + Layouted Widget. + + + + Removes layouted behind wrapping style items from BehindWidgets collection. + + Layouted table widget (WTable). + + + + Removes layouted behind wrapping style items from BehindWidgets collection. + + Layouted table row widget (WTableRow). + + + + Removes layouted behind wrapping style items from BehindWidgets collection. + + Layouted line container widget (WParagraph). + + + + Removes layouted behind wrapping style items from BehindWidgets collection. + + Layouted line widget (WParagraph). + + + + Layout Endnote + + + + + + Check Weather footnote is splitted and return the boolean value. + Layout Footnote TextBody + + Represents text body of Footnote. + Represents height of footnote. + Represents client height availble for layouting footnote. + Represents a flag, which denotes line continaing footnote refrence is already layouted, + without layouting footnote textbody. + + + + Check Weather footnote is splitted and return the boolean value. + + + + + Layout Endnote TextBody + + + + + + + + Adds the layout widget in before insecting point. + + The inter sect widget. + The index. + + + + Need to update the wrapping difference value. + + + + + + Update footnote widgets + + + + + Determines whether we need to remove the layouted footnote separator. + + Represent the layouted line. + Returns true, if it need to remove separator; otherwise returns false. + + + + Update footnote widgets + + + + + Creates the layout area. + + The Rectangle. + + + + layout the bounds for wrapping element in paragraph collection + + + + + Add the layoutwidget to the floating item collection. + + LayoutedWidget + Leafwiget + + + + To check whether leaf element is drawing element or not. + + Leaf element. + Return true if it is drawing element; else false. + + + + Check whether doNotSuppressIndentation property is set and skip the indent for the paragraph and its not applicable for Word 2013 + + + + + + + + + + Return the owner of the StructureDocumentTagBlock. + + + + + + + Resets the floating entity property. + + The paragraph. + + + + Get paragraph top margin + + + + + + + Get the Text Range + + + + + + + Adjust bounds the based on wrap polygon. + + The rect. + The vertices. + + + + Lines the intersection point. + + The PS1. + The pe1. + The PS2. + The pe2. + + + + + Determines whether [is wrap polygon denotes rectangle] [the specified vertices]. + + The vertices. + + + + + Update X position of the paragraph based on TextWrap + + + + + + Checkes whether the paragraph is in cell and the owner table of that cell is present in frame. + + Paragraph to check + Returns true if the paragraph is inside a table cell which is present in a frame else returns false. + + + + Set the floating item bounds with the mirror image bounds of the floating item. + + Index of the floating item + Text wrapping bounds to be modified + Layout area to shift the floating item. + + + + Reset the floating item bounds to original position + + FLoating item index + Text wrapping bounds to be modified + Original x position of floating item + + + + Determines whether the paragraph mark position need to update to the bottom. + + The y position. + The text wrapping style. + The paragraph. + The size. + The bottom position. + + + + + Determines whether the floating item is intersect the paragraph mark or not. + + The start value. + The end value. + + + + + Adjusts the tight and through bounds. + + The curr text range. + The size. + The rect. + + + + + Determines whether [is line slope is left to right] [the specified first point]. + + The first point. + The second point. + + + + + Pnpolies the specified poly. + + The poly. + The PNT. + + + + + Check whether paragraph Y position should update by floating item or not. + + + + + + + Update Paragraph Y position based on TextWrap + + + + + Gets the previous sibling of paragraph + + + + + + + + Update the X and Y positions based on the floating items present in the same Y region. + + Y position sorted floating item collections + Current layouting area + size of the widget + current pargraph + Determine whether this is called from leaf layout context class or not + + + + Update the client area Y position with minimum bottom position of the floating items + + + + + + + + + + Get the minimum width. + + + + + + + Return the document Word version in the format of string. + + current paragraph. + + + + + Return the minimum size required between two floating items based on Word version and floating item wrapping type. + + Left side floating item wrapping style + Right side floating item wrapping style + current paragraph + + + + + Check whether floating item wrapping style is square or tight and throw + + + + + + + Check whether Y position intersect or not + + + + + + + + + Gets the bottom position for tight and through. + + The floatting item bottom position. + The text wrapping bounds. + The paragraph. + The y postion. + The leaf widget. + Height of the leaf widget. + + + + + Gets the height of the floatting item. + + The entity. + + + + + Gets the height of the floatting item. + + The entity. + + + + + Gets the exceeded bottom value for tight and through. + + The height. + Height of the break character. + The para. + + + + + Gets the exceeded bottom value for tight and through. + + The para. + + + + + Gets the previous paragraph. + + The paragrph. + + + + + Gets the content of the previous paragraph is in SDT. + + Content of the SDT. + + + + + Gets the previous paragraph is in table. + + The table. + + + + + Determine whether the paragraph is in textbox and wrapping added to the collection or not + + + + + + + Determine whether the paragraph is in footnote + + + + + + + Determine whether the paragraph is in footnote + + + + + + + Get Left Margin of the Page + + + + + + Update Top Margin of the paragraph + + + + + + Checks whether the paragraph is a TOC + + Text Range + + + + + Check whether the current widget is have page break + + + + + + + Determine the whether the paragraph is have Page or Column break. + + + + + + + Determine the whether the paragraph is have section break + + + + + Creates the layout area. + + The rect. + The cell padding. + + + + Creates the layouted widget. + + The location. + + + + Updates the width of client area and client active area + + width. + + + + + Implemented alternative method to improve the performance + + + + + + + + Disable IsForceFitLayout prperty once the minimum widgets fitted in current page. + + + + + + Creates the specified widget. + + The widget. + The lc operator. + The layout option. + + + + + Determines whether the specified paragraph is in frame. + + The paragraph. + + true if [is in frame] [the specified paragraph]; otherwise, false. + + + + + Determines the frame intersects with the client area. + + + + + + + Gets the Location of frame and draw the frame content. + + dc. + ltWidget. + + + + + Checks whether current frame already started to layout. + + + + + + + + Get Base Entity. + + The entity. + + + + + Get Base Entity. + + The entity. + + + + + Determines whether it's base from section for the specified entity. + + The entity. + + + + + Determines whether given entity is in table or not. + + The entity. + + + + + Positions the X. + + The para format. + The section. + The bounds. + Width of the frame. + + + + + Gets the Y Position of frame. + + paraformat. + section. + The bounds. + Height of the frame. + + /// + + + + Gets the splitted widget. + + The splitted widget. + + + + Gets the layouted state. + + The state. + + + + Gets the layout info. + + The layout info. + + + + Gets the layout area. + + The layout area. + + + + Gets the drawing context. + + The drawing context. + + + + Gets the bounds padding right. + + The bounds padding right. + + + + Gets the bounds padding bottom. + + The bounds padding bottom. + + + + Gets the widget. + + The widget. + + + + Gets or sets a value indicating whether this instance is vertical not fitted. + + + true if this instance is vertical not fitted; otherwise, false. + + + + + Gets or sets a value indicating whether to skip splitted Paragraph + + + true if the splitted Paragraph to skip; otherwise, false. + + + + + Gets or sets a value indicating whether the Area is Updated + + + true if the Area is Updated; otherwise, false. + + + + + Gets or sets a value indicating whether the tab with stop position beyond right margin exists or not + + + true if the Tab with stop position beyond right margin exists; otherwise, false. + + + + + Gets or sets a value indicating whether this instance need to wrap + + + true if this instance need wrap + + + + + Decides whether the widget must fit in current page. Microsoft Word fits atleast a single line in a page. + Similarly, we have to fit the single line in a page, even there is no client area available. + If first item is table then we need to fit single row for exactly row. + We can use this property wherever we need to decide the widget is first item. + + + + + Gets or sets the client layout area right. + + + The client active layout right. + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + The widget. + The lc operator. + + + + Layouts the specified widget. + + The rect. + + + + + Need to add it to the floating item collection and relayout the paragraph + + Current child context + + + + Check whether current widget is floating item or not. + + + + + + + Find the next paragraph's x position + + + + + + + Decides whether text range (creaed for preserved para mark height) should be skipped or not. + + Current widget. + + + + + Check whether keep with next property is applicable or not + + + + + + + Check whether floating entity size exceeds the client height. + + + + + + + Get the previous deleted paragraph item + + + + + + + Creates the next child context. + + + + + + We have remove the Line layouted widget from the table cell layouted wiget + + + + + Determines the paragraphs are in same textbody. + + + + + + + Updates the position value for absolute tab. + + + + + + Create balloon for deleted paragraph text. + + + + + Denotes whether need to create new balloon for character format changes or use the balloon of previous item. + + + + + + + + Create balloon for deleted paragraph text. + + + + + Appends the content in the track changes balloon for deleted text range + + track changes markup collection + child widget + + + + Appends the content in the track changes balloon for deleted image + + track changes markup collection + child widget + + + + Create balloon for deleted paragraph text. + + + + + Appends the content in the track changes balloon for deleted paragraph + + track changes markup collection + child widget + + + + Creates balloon for character format. + + + + + + Compare properties hash and remove the same value from PropertiesHash + + + + + Creates the content for track changes balloon for the paragraph formatting changes. + + + + + + Creates the content for track changes balloon for the List formatting changes. + + + + + + Creates the content for track changes balloon for the table formatting changes. + + + + + + Check whether last row of table have dynamic paragraph. + + + + + + + Check whether last item of nested table have dynamic paragraph. + + + + + + + Determine whether the page break is need to move last item of para or not. + + + + + + Updates the expression field. + + The child widget. + + + + Checks the null condition and returnltwidget. + + + + + + Finds the intersect point and removlt widget. + + + + + Get the intersecting item for the dynamic relayout occurred table cell. + + The layouted widget. + The y position. + The index. + The intersecting widget index. + + + + Layout splitted footnote textbody + + + + + + Layout splitted endtnote textbody + + + + + + Check whether pararagph splitted by Page break or not. + + + + + + Check whether previous paragraph have section break or not. + + + + + + + Need to skip updating top margin as zero when its header contents exceeds page top margin height + + + + + + Update the text body items positio + + + + + + Getting the footnote height + + + + + + Check whether the specified paragraph is already updated or not + + Represent the current paragraph LayoutInfo + Returns whether the paragraph is updated or not + This method is used to skip the padding reset of same paragraph, + Which is already updated on first page HeaderFooter layoutting + and now comes for second page HeaderFooter layoutting + + + + Update paragraph Top and Bottom Margins + + + + + + Marks as not fitted. + + The child context. + + + + This method decide whether to Set the layout state to Not fitted or not. + + + + + + + Get pevious sibling + + + + + + + Check whether content control is not fittted based on on previous sibling behavior + + + + + + + Removes the hyphenated word in last line of the page, if it is hyphenated based on auto hyphenation. + + + + + + + Updates the layouted widget bounds. + + layouted widget. + + + + Gets maximum right position of the layouted widget. + + + + + + + Gets maximum bottom of the layouted widget. + + + + + + + Read a word from the last position of hyphenated line. + + + + + + + Checks whether page break is present inside the table + + + If it is present inside the table, it will not be considered during Doc to PDF conversion. + bool + + + + Gets the paragraph. + + The widget. + + + + + Remove Xml Math Paragraph items from paragraph if it exists. + + Current paragraph. + + + + Marks as fitted. + + The child context. + + + + Checks whether item is Horizontal rule or not + + + returns true if item is horizontal rule. otherwise false + + + + Returns true if need to create separate balloon for character format changes in break character format. + + + + + + + + Generate balloon value for character format. + + + + + + + Get the balloon value of last formatting Mark Ups. + + + + + + Check whether current line widget having corresponding comment end mark or not. + + Returns true, if it has a comment end mark. Otherwise flase. + + + + Shift the track changes balloons to the bottom of line. + + + + + Determines whether to layout textbody of footnote. + + Represents a footnote layouting context. + Retruns true, if footnote need to be layout; otherwise false. + + + + Marks as Wrap Text. + + The child context. + + + + Marks as splitted. + + The child context. + + + + Upddate index of split string widget to perform text wrap + + + + + Marks as breaked. + + The child context. + + + + Updates the client area. + + + + + Updates the spacing information. + + The bounds. + + + + + Determines whether the next text body item is paragraph or not. + + The para. + + + + + Determines whether the specified table is in frame. + + The table. + + true if the specified table is in frame; otherwise, false. + + + + + Updates the frame bounds. + + + + + Changes the childs alignment. + + + + + Nexts the child widget. + + + + + + Spliteds up widget. + + The split widget. + + + + Spliteds up widget. + + The split widget. + + Whether the splitted widget is in frame + + + + Commits the child context. + + The child context. + + + + Gets the table height by adding the row's height. + + + + + Layouted current child + + The child context. + + + + Gets the horizontal position of the floating item when it is relative to character + + Current widget that is going to be layouted + Returns the distance that needs to be shifted + + + + Determines whether textrange is layout in next line + + The client area + Owner paragraph of child entity + TextRange contains text or space + Return true, if textrange is layout in next line otherwise false + + + + Determines whether range contains text or not by trimming spaces at the end. + + Child context. + Returns true, if range contains text other than only space; otherwise false. + + + + Return true if entity wrapping style is tight or throw + + + + + + + Return the floating item from its floating item collection. + + + + + + + Adds the child LW. + + The child context. + + + + Layout the skipped footnotes' textbody from the layouted lines. + + Represents a layouted lines. + + + + Determines whether the footnotes' text body has started to layout in the same page. + + Represents a layouted lines. + Returns true, if last footnote of layuoted line is not found in same page; otherwise false. + + + + update paragraph y position when the frame vertical postion exceeds page height + + + + + + + Shifts the paragraph y position when the frame vertical postion exceeds page height + + + + + + + + Calculates the frame height by adding the paragraphs height in the frame + + + + + + + + + update the textwrapping bounds of floating item + + + + + + Resets the bounds from adjusted bounds based on wrap polygon + + Floating item + Current child layouted widget bounds + Returns resetted bounds based on wrap polygon + + + + //if the split widget container have the Endnote item set the empty section in split widget container and change the state to the splitted for layout the Endnote textbody at the second page. + + + + + Add Behind widgets to the collection + + + + + + Checks the type of the widget. + + The widget. + + + + + Checks the widget wrapping type and horizontal origin. + + The widget. + + + + + Checks the wrapping type and horizontal origin. + + The text wrapping style. + The horizontal origin. + + + + + Check whether Frame content intersect with previous items,if it intersect then enable Dynamic relayout. + + + + + + Get the Frame Y position. + + + + + + + + Get the bottom position of the previous item. + + + + + + + Return the previous line bottom, by skipping lines which preserved below to the floating item. + + + + + + + + Checks whether the para is last item of the frame. + + + + + + + checs whether the para and table is in same frame. + + + + + + + + Updates the LW bounds. + + The child context. + + + + Checks whether need to consider the right pad. + + Owner paragraph + + + + GEt the previous text body item index. + + + + + + + Check whether current paragraph is frame or not. + + + + + + + Determine whether the layouted widget bottom position is need to be updated or not + + + + + + Checks whether widget is renderable item or non renderable item + + + + + + + Check whether the element owner is Section or not + + + + + + + Add Frame Bounds into the text box bounds collection + + + + + Update the paragraph bounds into frame bounds. + + + + + Get the first frame item. + + + + + + + + Check whether floating item already added to floating item collection or not. + + + + + + + Updates the frame bounds. + + The paragraph. + + + + Finds whether the Atleast frame height should be used to frame paragraph. + + Paragrapg Layouted Widget + Last Line Layouted Widget + + + + + Updates the frame bounds. + + The table. + + + + Updates the horizontal alignment. + + The x alginment. + + + + Updates the vertical alignment. + + The y alginment. + + + + Commits the keep with next. + + + + + Gets the section of the given widget + + + + + + + Remove the layouted widgets from the collection based upon keep with next. + + + + + + + + + Decide whether Is last TOC paragraph layouted or not. + + + + + Check whether the last Toc paragraph layouted or not. + + + + + + Check whether removed item has last TOC paragraph or not. + + + + + + + Commits the with keep with nex for word2013 format. + + The splitted widget. + The section. + + + + This method return whether to remove the widget or not. + + + + + + + + Removes the items from layouted widgets. + + The splitted widget. + + + + Determines the start row index. + + + + + + + Gets the owner section. + + The entity. + + + + + Determine whether current widget is need to commit Keep with next property. + + + + + + This Method Sets the Keep with Next property for Block content control and Checks if the entire block content control is true, else it returns false. + + + + + + Gets the widget container. + + The widget container. + + + + Gets the current child widget. + + The current child widget. + + + + + + + + + Initializes a new instance of the class. + + The container. + The lc operator. + + + + Layouted current child + + + + + + Updates X position of floating item (Behind or InfrontOf) for the case first inline widget not wraps based on floating item + but wrapps if we consider the line height as content height. + + + + + + Decides whether we need to update floating item X position based on entire line wrap position. + + + + + Decides whether current line intersecting bounds should be calculate or not. + + + + + + + Update the intersecting floating item bounds to current line. + + + + + Creates the next child context. + + + + + + Commits for not fitted. + + The child context. + + + + Removes floating items from the collection when a paragraph is not fitted. + + + + + Moved the layouted line to next page when widowControl property is true. + + + + + + + + Remove a CommentsMarkups of not fitted line. + + Represents a current line widget. + + + + Check whether the previous item of splitted item to next page or not + + + + + + + + We have check that Wrapping floating item is fitted in that page. + + Layouter. + Child context. + + + + Remove track changes balloons from the given Y position. + + + + + + Removes the hyphenated word in last line of the page, if it is hyphenated based on auto hyphenation. + + + + + + + Updates the layouted widget bounds. + + layouted widget. + + + + Read a word from the last position of hyphenated line. + + + + + + + check whether line have only non drawing items or not + + + + + + + Check whether the line contains only mathematical items or not. + + The line widget. + True if the line contains only mathematical items, otherwise false. + + + + To check this paragraph is end of page, when page layout contains more than one column + + + + + + Determine whether the splitted widget need to be reset based on WindowControl + + + + + + + + + Update footnote widgets + + + + + Determine whether is KeepLineTogether + + + + + + + Determine whether the last paragraph is need to be layout in Next page + + + + + + Is need to layput the paragraph in this page + + + returns true to move the paragraph to the next page, else false + + + + Determine whether the paragraph contains only bookmarks alone. + + + + + + + Determine whether the item is splitted or not fitted item + + + + + + + Commits for fitted. + + The child context. + + + + Commits for splitted. + + The child context. + + + + Updates the client area. + + + + + + Changes the childs alignment. + + + + + Updates X position of track changes balloon. + + + + + Update a X position of Comment balloon. + + + + + Decides whether line contains only display type WMath. + + + + + Gets a next valid widget. + + Represents a start index. + Represents a layouted widget list. + Retruns a next valid widget. + + + + Shift the layouted widgets in right to left direction + + Floating items collection + + + + Checks whether the text range is Zero Width Joiner. + + Layouted widget + + + + Shift the layouted widgets in right to left direction (Old implementation) + + Floating items collection + + + + Updates the widgets x position. + + + + + Reorders the child widgets of a line for RTL text. + + + + + + Check whether input WTextRange is having only one number non reversing character or not. + + Represent a LayoutedWidget of a WTextRange. + Returns true, if input WTextRange is having only one NumberNonReversingCharacter; Otherwise false. + + + + To check whether the specified language reverse the number or not for slash character. + + Specify the language local id. + Return true if the language id reverse the number for slash character. + + + + To check whether the specified language reverse the number or not for (‘#’,‘$’,‘%’,‘+’,‘-’) characters. + + Specify the language local id. + Return true if the language id reverse the number for (‘#’,‘$’,‘%’,‘+’,‘-’) characters. + + + + Shift the widgets x position based on the list. + + + + + Shift the RTL and Normal text in right to left direction + + Index of last RTL text + Index of normal text + True, if the line conatins normal text + + + + Shift the normal text in left to right direction + + Normal text index + + + + Shift the RTL text in left to right paragraph + + Index of RTL text + True, if the line contains RTL text + True, if the line contains normal text + + + + Shifts the X position of the widgets from start to end index + + start index + end index + + + + Gets the last tab width. + + Paragraph format + Tabs count + Tab width + + + + Splits the line based on inter secting floting entity. + + The m_backup widget. + The inter secting floatting item. + The m_resultted widgt. + + + + Gets the first index of the inline item. + + + + + + Inters the secting floatting item. + + The rect. + + + + + Updates sub width based on the Text wrap + + + + + + Updates the horizontal alignment. + + The x alginment. + + + + Checks the paragraph for TOC + + paragraph + + + + + Does the layout after. + + + + + Check whether need to update page number for TOC + + + + + + + If paragraph doesn't have valid items before the page break then skip updating page number + + + + + + + + Decides whether text is empty or contains only white spaces. + + + + + + + Determines whether the toc need not to be updated or not. + + The paragraph. + The SWC. + + + + + Gets the index of the valid para item. + + The paragraph. + + + + + Updates the TOC page number. + + The para. + + + + Updates the TOC Heading stylecpage number. + + The para. + + + + Updates the TOC \c switch page number. + + The para. + + + + Gets or sets a value indicating whether this instance is first Text Body Item of current page. + + + + + Represents the layout context for layouting text. + + + + + Initializes a new instance of the class. + + The STR widget. + The lc operator. + + + + While the paragraph inside the cell that contains the decimal tab, then it returns true otherwise false + + + + + + Whether determine decimal point is decimal tab point or not + + + + + + While the paragraph inside the cell that contains the decimal tab, + we have to change and update the client area as same as that of the MS behavior + + + + + + + Update the shifting distance of X and Y according the the horizontal and vertical alignment + + bounds of the leaf layouted widget that needs shifting + paragraph item + + + + + Layouts the specified widget. + + The rect. + + + + + Checks whether the tab stop position needs to fit in the same line + + Current leaf widget's tab layout info + Current tab position + Owner paragraph + Client area + + False if the tab stop positions before the current tab stop are greater than 0 and the current tab stop position is greater than the client active area. + Else true. + + + + + Finds whether the layouted widget is a floating item and its horizontal origin and vertical origin are page and margin. + Finds the shift distance according to the horizontal or vertical origin + Shifts the X or Y position according to the found shift distance + + paragraph item + bounds of the leaf layouted widget that needs shifting + + + + + Check the Floating item have horizontal origin as character + + Owner of the Leafwiget + + + + Finds the wrapped bounds. + + + + + Checks whether widget should be fitted in current page due to line spacing values. + + Owner paragraph. + Current widget height. + + + + + Update the picture width and height based on the picture border lineWidth + + + + + + + Determines whether the current floating item already layouted or not. + + The paragraph. + + + + + Checks whether need to reset the client area + + The paragraph. + + + + + Determines whether the dynamic relayouting occur or not. + + The paragraph. + + + + Determines whether the floating item exist in the floating item collections. + + i. + + + + + Creates the layouted widget. + + The i. + + + + Sets the bounds for layouted widget. + + The text wrapping bounds. + The distance from left. + The distance from top. + The distance from right. + The distance from bottom. + + + + Layout the GroupShape container + + + + + Layout a custom child shape. + + Represent a logical DOM entity. + Represent a owner entity layoutedwidget. + + + + Layout the child shape + + + + + + Layout the child group shape + + + + + + + + + Calculates the rotation of child shape. + + Shape's rotation + Shape's width + Shape's height + Shape's left + Shape's top + Shape's width scale. + Shape's height scale. + + + + Calculates the sum of rotation angle for the nested child shape. + + Shape's rotation + Layouted Widget + List of the group shape's bounds + List of the group shape's rotations + List of the group shape's horizontal flips + List of the group shape's vertical flips + + + + Set horizontal and vertical flips to render the child shapes. + + Shape's rotation + child shape Widget + + + + Get Horizontal flip count. + + Group Shape. + Flip count. + Flip count. + + + + Get Vertical flip count. + + Group Shape. + Flip count. + Flip count. + + + + Checked whether any of the parent group shape contains Horizontal flip. + + Group Shape. + True if the group shape contains flipH. + + + + Checked whether any of the parent group shape contains Vertical flip. + + Group Shape. + True if the group shape contains flipV. + + + + Creates the from points array. + + The points. + The rectangle. + + + + + + + + + + + + + + Updates the textbox bounds based on the rotation value. + + + + + + Update the text box rendering/Drawing bounds based on the auto fit properties + + Text box + Shape with rectangle type + Text body layouted widtet + Text body owner Widget + Text direction + + + + Update horizontal text bounds based on auto fit properties. + + Decides height should resized or not + Decides width should resized or not + text body + internal margin + layouted bounds + + + + Update vertical text bounds based on auto fit properties. + + Decides height should resized or not + Decides width should resized or not + text body + internal margin + layouted bounds + + + + Update the text box X and Y positions based on modified width and height + + Width Adjusted by Auto fit + Height Adjusted by Auto fit + Text body layouted widget + + + + Update text box content layouting bounds based on the auto fit properties. + + Text box + Shape with rectangle type + Text body Layouting bounds + Text direction + + + + + Check any of paragraph in text body has more than one line. + + Text box text body items + return true when paragraph have more than one line otherwise false. + + + + Update the Text box items bounds based on paragraph alignment + + Text body + text box drawing width + Width which used for layouting + + + + Shift the X position based on paragraph alignment + + Paragraph layouted widget + Difference between layouting width and current text box drawing width + + + + Get current line maximum width + + Paragraph layouted widget + + + + + + + + + + + + + + + + + + + + + + + + + Get Current TextRange of the leafWidget + + + + + + Update Tab Width. + + The rect. + The size. + + + + Update the client area width if exceeds tab position exceeds the client area width + + + + + Clients the area right. + + The paragraph. + The rect right. + + + + + Get Left Margin of the Page + + + + + + Get Right Margin of the Page + + + + + + Update xPosition of the LeafWidget which have Previous Tab justification is Decimal + + + + + + + + Determines whether leaf widget is need to be splitted + + size + rect + + true if leaf widget need to be splitted, set to true. + + + + + + + + + + + + Checks whether the paragraph item should fit in the same page based on atlease and exactly line spacing. + + owner paragraph + Size of the paragraph item + + + + + Determine whether the section break paragraph contains only floating items. + + The paragraph to check. + The leaf widget to check. + + True if the paragraph contains only floating items. False otherwise. + + + + + Determine whether need to fit item of the last paragraph + + + + + + Determine whether need to fit the last paragraph of the page in same page. + + + + trueif the last paragraph of the page is not fitted in same page;Otherwisefalse + + + + To identify current picture is OleObject. + + trueif the current picture is OleObject;Otherwisefalse + + + + Determines whether text contains line break characters. + + + true if text contains line break characters; otherwise, false. + + + + + Determines whether the specified leaf widget is to be clipped or not. + + The size. + + true if the specified leaf widget is to be clipped; otherwise, false. + + + + + Determine whether the paragraph Item is need to Fit + + + + + + + Get's Left Indent of the paragraph + + + + + + + Determines whether Picture Fit + + size + + true if Picture Fit, set to true. + + + + + Handled a behavior for floating item fitted logic, which is depends on a next sibling + + Vertical Origin + Horizontal Origin + ParagraphItem + Return True, if the next siblings width is higher than client area;Else false. + + + + Gets the line spacing value. + + The line spacing rule. + + + + + Determines whether the picture is fit picture in section. + + Width of the column. + Height of the pic. + Height of the page. + The top margin. + The size. + Width of the client active area. + + + + + Determines whether the picture is fit picture in Textbox. + + The top margin. + The size. + Height of the pic. + + + + + Determines whether the picture is fit picture in table. + + Width of the cell. + The cell top margin. + The top margin. + Height of the pic. + The size. + + + + + Determines whether the picture is fit picture in headerfooter. + + Height of the pic. + Height of the page. + The top margin. + The size. + Width of the column. + Width of the client active area. + + + + + Determines whether [is floating item fit] [the specified ent]. + + The ent. + The size. + The owner paragraph. + The para item. + Height of the page. + The top margin. + if set to true [is picture fit]. + + + + Determines whether the shape placed on the bottom of the paragraph. + + Owner paragraph of the floating item + Size of the floating item + Paragraph's layoutinfo + + + + Get the Rotation angle of floating item. + + + + + + + Get the empty TextRange height + + + + + + Get Base Entity. + + The entity. + + + + + Determines whether TextRange Fit in ClientActiveArea + + size + + true if TextRange Fit in ClientActiveArea, set to true. + + + + + Determine whether the text range is need to fit + + + true if previous tab position is greater than the ClientActiveArea, set to true. + + + + + Try to fits the word by using extra width obtained for Word 2013 Justification alignment. + + + + + Fits the next word and change the state accordingly. + + + + + Fits the widget even the size exceeds. + + + + + Do Word 2013 Justification inter word spacing sclaing and try to fit the next word. + + + + + + Gets the next widget text. + + + + + Check whether text contains white space to find the single Word width. + + + + + Find the next complete word width by checking the split widgets and its next siblings. + + It contains the values leading space of text. + + + + Adds the leading spaces into LineSpaceWidths collection and measure its width. + + + + + Updates the space widths of current widget into LineSpaceWidths collection. + + + + + + Layout for Word + + The rect + size + + + + + Determines whether to skip splitting the text by character based on the script type. + + Specifies the current text range + Specifies the owner of the current text range + True if the text should not be split by character, false otherwise. + + + + We have calculate the previous space width in that TextRange. + + Text having space. + Spacing width + + + + Get table border spacing value + + + + + Word by word layouting for Unicode text + + + + + Check whether the text need to splitted by word + + + + + + + + + + Get Text Whether the LeafWidget is WTextRange or SplitStringWidget + + + + + + Check whether the text need to splitted by word + + + + + + + + + + Get width to fit text in current line + + + + + + + Get Next TextRanges width + + + + + + + + + Get Next TextRanges width + + + + + + + + + Determine Whether the Nextsibling Textrange size is need to measure + + + + + + + + + + Determine Whether the Nextsibling Textrange size is need to measure + + + + + + + + + + Determine whether the text contain CJK begin characters + + + + + + + Get the valid inline next sibling for a Vertical Orgin Below Line behavior + + Represent the current paragraph item + Return a widget of valid next sibling + + + + Get Next text range + + + + + + Determines whether leaf widget is in cell + + + true if leaf widget is in cell, set to true. + + + + + + Determines whether next sibling of leaf widget is text range. + + + true if next sibling of leaf widget is text range, set to true. + + + + + Split by Word + + SplitLeafWidget + Size + + + + Determines whether text is need to be splitted + + size + rect + + true if text need to be splitted, set to true. + + + + + Determines whether text is need to be splitted + + + true if text need to be splitted, set to true. + + + + + Get OwnerParagraph of the LeafWidget + + + + + + Checks the wrapping style for wrapping. + + The text wrapping style. + + + + + Determines whether the leafWidget based on the wrapping element. + + The owner para. + The layouter. + + + + + Determines whether the paragraph mark move to right side of the intersecting of floating item. + + The owner para. + The text wrapping bounds. + + + + + Determines whether the leafWidget based on the wrapping element for square, tight and through. + + The layouter. + Index of the wrap owner. + Index of the wrap item. + The text wrapping style. + The text wrapping bounds. + + + + + check wherther the paragraph line spacing is exceed the text height. + + TextRange Height. + TextWrapping Y position. + Client area. + True for Wrap the text; false for skip the wrapping. + + + + Determines whether the leafWidget based on the wrapping element for top and bottom wrapping type. + + The layouter. + Index of the wrap owner. + Index of the wrap item. + The text wrapping style. + The text wrapping bounds. + + + + + Determines whether the floating entity is layout in cell based on the top and bottom wrapping type and Word compatibility. + + + + + Determines whether the floating entity is layout in cell except the behind and infront wrapping style. + + + + + Determines whether the floating item owner paragraph is not fitted in the same page. + + The text wrapping style. + The floating entity. + The layouter. + The floating widget. + The paragraph layout info. + returns true if floating item owner paragraph is not fitted in the same page. otherwise false + + + + Is need to intermediate the leaf widget based on the floating item. + + Width of the remaining client. + The text wrapping style. + The layouter. + Type of the text wrapping. + The rect. + The size. + The paragraph layout information. + + + + + Check whether there is a floating item at the left + + Current layout area + Minimum width to fit text + Text wrapping bounds of the floating item + + + + + Check whether line break is intersect on floating item. + + Current leafwidget + Wrapping style of floating item + Bounds of floating item + Bounds of current leafwidget + Size of line break + Owner paragraph of line break + + + + + Remove the distance from text value from the floating item text wrapping bounds. + + + + + + + + Adjust Client Area for Text Wrapping + + leaf widget + Size + The rect + + + + Checks whether current floating item layout on exiting floating item's top or not. + + + + + Checks whether current floating item layout on exiting floating item's top based on line or not. + + + + + Checks whether current floating item layout on exiting floating item's top based on bottom edge extent or not. + + + + + Checks whether the break element need to wrap or not. + + + + + + + + To get the minimum width required to fit a widget to side of table. + + + + + + + + + + + Get the Maximum width of a Right side cell border. + + + + + + + Need To Wrap the InFrontOfText or Behind wrapping style FloatingItems + + Leaf widget + Return True, if we need to wrap the floating item; else false. + + + + Check if the current text range is the first text range in the paragraph. + + + + + + + Skips the empty textrange wrapping. + + Returns true, if the empty text range is valid for layouting. Otherwise returns false. + + + + Updates the para first line horizontal positions. + + The paragraph information. + The widget. + The x. + The width. + + + + Denotes bookmark have size. + + Represents size of bookmark. + Returns true, if bookmark start or bookmark end have width or height. Otherwise returns false. + + + + To identify the text fit below or above the textbox/shape + + Floating item wrapping bounds + Current leafwidget Y position + Floating entity + truewhen text fit below, otherwise false + + + + Gets the top margin value for floating table. + + The paragraph. + The floating entity. + The y position. + + + + + Adjusts the client area based on exceeded tab. + + The leaf widget. + The size. + The rect. + The left indent. + The paragraph. + + + + Get Minium width of the word + + + + + + Check whether the leafwidget owner is textbox or not + + + + + Getting PageField size + + + + + + + Does the layout after. + + + + + Update the EQ field code size when it's widht exceeds the client area width. + + Graphic object for EQ field. + Character format of EQ field. + Retruns updated size of the EQ field. + + + + Fits the widget. + + The size. + The widget. + + + + Gets the floatting item position. + + The indent x. + The indent y. + The size. + + + + + Get the cell layout info + + Owner paragraph. + Return the owner cell layout info. + + + + Gets the considered line spacing value while calculating the paragraph Y position. + + Represents the owner paragraph of the floating item. + Retruns a spacing value, considered line spacing value while calculating the paragraph Y position. + + + + Get the bounding box position of the rotated image. + + + + + + + + + + + + + + + + + + + + + + Determines whether [is paragraph containing line break] [the specified paragraph]. + + The paragraph. + + + + + + + + + + + + + + + + + Checks whether layout in cell property is true and object should be fit within the container height. + + + If set to , then ; otherwise, . + If set to , then ; otherwise, . + + + + + + Checks whether layout in cell property is true and object should be fit within the container height. + + The para item. + if set to true [is word2013]. + + + + + Get vertical position of the picture + + + + + + + Get Horizontal position of the picture + + + + + + + Update Width of the LeafWidget + + + + + + + + Determines whether the cell bounds need to add the left area bounds. + + The text wrapping style. + + + + + Splits up widget. + + The split leaf widget. + + + + Gets the leaf widget. + + The leaf widget. + + + + + Represents the layout context for tables. + + + + + The minimum width. + + + + + Initializes a new instance of the class. + + The split widget. + The lc operator. + + + + Initializes a new instance of the class. + + The table. + The lc operator. + + + + Get the base entity + + + + + + + Determine whether the entity is in section or headerfooter + + The entity to check. + The parent base entity, which is either a section or headerfooter. + + + + Layouts the specified widget. + + The rect. + + + + + Checks whether the document has balloons in it. + + + + + Clears the layouted vertical merge start widget from m_verticallyMergeStartLW collection. + + + + + Determines whether the layouted floating table in text body items. + + + + + + Determines whether the layouted floating table in Block content control. + + Indicates the layouted widget of block content control. + + + + + Determines whether the table is needed to relayout. + + Table original client area before wrapping. + + + + + Determines Whether the row need to be move to the floating item bottom position. + + + + + + + Determines whether the table in TextBox or Shape + + Represents table entity + + + + + Determines whether the layouted floating table in tablacell. + + + + + + Check whether current floating item of frame contains a table or not. + + Represent a floating item object of frame. + Returns true, if it contains a table; Otherwise false. + + + + Gets the layouted floatting table. + + + + + + If footnote preserved in the the adjacent cell this layouting will perform + + + + + Checks After zero cell has Footnote and returns the bool Value + + + + + Removes the Footnote already layouted for the current table + + + + + Checks whether the floating table need to move to next page or not. + + + + + + Updates the table LW bounds. + + + + + gets the owner tbale fot the flaoting entity. + + The entity. + + + + + Determines whether to skip splitting table or not. + + True if splitting table need to skip. + + + + Split the row when it exceeds the page margin bottom for Word 2013 + + + + + Update KeepWithNext property set for the Table + + + + + Update absolute table position + + + + + Adjust Client Area for Text Wrapping + + Size + The rect + + + + Measures the height of the table when its height based on the content. + + Height of the table + + + + Adjusts the text wrapping bounds based on distance from text values when floating table intersects with another floating item. + + + + + + Adjusts the text wrapping bounds based on distance from text values. + + + + + + Checks whether the table intersects with floating item. + + + + + + Determine whether the table needs to move to the bottom of the floating item or not. + + + + + Checks whether the table intersects with floating item of top and bottom wrapping style. + + + + + + Checks whether to adjusts the tight and through bounds. + + + + + + Check table move to next page or not + + + + + + + Get the First row width + + + + + + Checks whether the current row is not fitted based on floating items. + + + + + Get the First row maximum cell width + + + + + + Creates the row layouted widget. + + + + + + Update the cell's border, padding, margins. + + The row. + + + + Layouts the row. + + The row widget. + + + + Layouts the row. + + The row widget. + + + + Gets the exactly type row of current table. + + + + + + + The row need to layout in that page + + If true, try to not fit in that page, else fit the row in that page. + + + + To ensure the first pargraph inside the cell is having page break before property + + + + + + + Checks the footnote in row is splitted. + + The child context. + + + + + Creates the row layout area. + + The row. + The bottom pad. + + + + + Gets the cells maximum top and bottom padding. + + The row. + The maximum top pading. + The maximum bottom padding. + The maximum top margin. + The maximum bottom margin. + + + + Updates the cells maximum top and bottom padding. + + The row. + The maximum top pading. + The maximum bottom pading. + + + + Updates the cells bottom padding and margin. + + The row. + The maximum bottom pading. + The maximum bottom margin. + + + + + Commits the row. + + + + + Checks whether there is a nested table in a row and that table has wrapping bounds bottom. + + True if the nested table has wrapping bounds bottom; else return false + + + + Check whether current row vertical merged cell layouted or not + + + + + + Updates the vertically merged cell. + + The row lw. + if set to true [is next row not fitted]. + + + + To check the row height type is exactly or not + + Entity has a exactly row height type + If the row has exactly height type, return True; else return false + + + + Update the FootNote Widgets bounds and its order based on footnote ID. + + Count of footnote widgets added by vertical merge cells. + + + + Gets the foot note Id of current foot note. + + Text body + + + + + Checks whether current text body is WFootNote text body or not. + + + + + + + Updates the splitted vertical merge cell. + + The lc. + The merge start lw. + The row information. + The child lw. + The row lw. + Index of the current. + if set to true [is next row not fitted]. + + + + + + + + + + + Gets the vertical merge start lw. + + The vertical merge end lw. + + + + + Updates the vertical text cell lw. + + + + + Updates the splitted cells. + + + + + Retreive first pagragraph present in the first cell of the current row + + paragraph widget of first cell + + + + Retreive pagragraphs present in the cells. + + paragraph widget of cells + + + + Determines whether the given widget is Table widget or not. + + The widget. + + + + + Determine whether the splitted cells are not empty + + + + + + Determine Whether the row need to be splitted across pages. + + + + + + Checks whether all the layouted rows having Keep with Next property or not. + + + + + + Checks whether the current cell horizontally merged with next cells till last column of the row. + + + + + + Calculate the right pad value + + + + Right pad value + + + + Updates the row layouted widget bounds. + + + + + + + + + + Check whether we need to layout the header row or not. + + Current table. + Row index + Return False; If we need to layout the header row; Else true. + + + + Check whether header row should layout or not. + + + + + + Check whether current page first item is inline picture or not. + + + + + + + Is splitted widget container has picture or not. + + + + + + + + + Decides whether current row any of cell has picture as first item or not. + If multiple cell has pictures then consider the large picture. + + + + + + + Get the cell's first paragraph first item if it picture. + + + + + + Get the picture from paragraph. + + + + + + + Layouts the header rows + + header row + + + + Update Header Row Widget + + + + + Determines whether [is in frame] [the specified table]. + + The table. + + + + + Updates the height of the cell. + + The column. + + + + Updates the Y position of cell widget child items based on cell vertical alignment + + Current layouted cell widget + Cell widget layout info + + + + Updates the Y position of cell widget child items based on cell vertical alignment + + The cell lw. + + + + Calculate the displacement value based on cell vertical alignment + + Current cell textbody widget + Current cell height + Set to true when the cell child items bottom greter than cell bottom + Remaining space value + displacement value + + + + To identify whether cell is having shape related items or not. + + Current cell widget + + + + + Finds the maximum bottom of floatting item. + + The child. + + + + + + Creates the table client area. + + The rect. + + + + Does the layout cell. + + The child context. + The cell area. + + + + Check whether the owner row of current cell is same as owner row of floating item + + + + + + + + Checks the foot note in text body. + + The text body. + + + + Checks the foot note in paragraph. + + The paragraph. + + + + Creates the next cell context. + + + + + + Commits the cell context. + + The child context. + + + + Marks as splitted. + + The child context. + + + + Marks as breaked. + + The child context. + + + + Marks as not fitted. + + The child context. + + + + Commits the keep with next. + + + + + Determine whether current row widget is need to commit with keeepWithNext property + + + + + + Retrun true if a layouted rows first table paragraph contains keeplines together property true, otherwise returns false. + + + + + + Retrun true if previous row has vertical merge continue cell, otherwise returns false. + + + + + + Marks as fitted. + + The child context. + + + + Updates the client area. + + + + + Checks whether table is clipped or not, based on their owner. + + + + + + Get the footnote textbody height + + + + + + + Gets the width of the row. + + Current table cell owner row. + + + + + Gets the cell client area. + + if set to true [hor merge start]. + + + + + Gets the maximum left indent of the row. + + + + + Gets the width of the cell. + + Row index + Column index + + + + + Gets the Height of the cell. + + Row index + Column index + + + + + Gets the width of the merged cell. + + + + + + Updates the LW bounds. + + + + + Corrects the table client area. + + The rect. + + + + Checks whether the need to update the inline RTL table X position. + + The table layout info. + Left indent of the table. + The rect. + + + + Gets the Horizontal alignment from table hierarchy + + + + + + + Get Minimum right padding of the table. + + + + + + Get Right padding of the cell + + + + + + + Gets or sets a value indicating whether this instance is first Text Body Item of current page. + + + + + Gets the table layout info. + + The table layout info. + + + + Gets the table widget. + + The table widget. + + + + Gets the index of the curr row. + + The index of the curr row. + + + + Gets the left pad for table. + + The left pad. + + + + Represents the layout context for layouting Math equations. + + + + + Initializes a new instance of the class. + + Represent the instance as + Represents the + Represents the isForceFitLayout + + + + Layouts the WMath widget. + + Represent the bounds of client active area + Return the of instance + + + + Create layoutarea based on margin values. + + + + + + + Do alignement for Math Layouted. + + + + + + + + Layouts the OfficeMathFunctions collection + + Represent the clientArea for layouting + Represent the layouted widget of owner OfficeMath + Represent the IOfficeMathBaseCollection to layout + Represent whether current layouting is nested layouting or not. + + + + Find the text difference based on the base character. + + Represent the Equation Text. + Represent the base character. + Represent the characterFormat. + Represent the equation bounds. + Represent the difference position. + + + + Layouts the + + Represent the bounds for layouting + Represent the layouted widget of owner OfficeMath + Represent the IOfficeMathBaseCollection to layout + Return the layouted widget of OfficeMathLimit + + + + Layouts the + + Represent the bounds for layouting + Represent the layouted widget of owner OfficeMath + Represent the IOfficeMathBaseCollection to layout + Return the layouted widget of OfficeMathBox + + + + Layouts the + + Represent the bounds for layouting + Represent the layouted widget of owner OfficeMath + Represent the IOfficeMathBaseCollection to layout + Return the layouted widget of OfficeMathFraction + + + + Layouts the + + Represent the bounds for layouting + Represent the layouted widget of owner OfficeMath + Represent the IOfficeMathBaseCollection to layout + Return the layouted widget of OfficeMathNArray + + + + Layouts the + + Represent the bounds for layouting + Represent the layouted widget of owner OfficeMath + Represent the IOfficeMathBaseCollection to layout + Return the layouted widget of OfficeMathAcccent + + + + Get the equation text. + + Represent the equation. + Return the equation text. + + + + Get the layouted widget for the character + + Represent the characterFormat + Represent the character + Represent the clientActiveArea + Represent it is N-array character + Return the layoutedStringWidget of the given string. + + + + Get the Updated bound for N-Array equation. + + Represent the N-Array layouted widget. + Represent the N-Array. + Represent the N-array bounds. + + + + + Get the updated bounds. + + Represent the Subsuperscript + Represent the Leftscript widget + Represent the Rightscript widget + Represent the layouted script. + return the updated bounds of the script childwidget. + + + + Gets the control character property from a IOfficeMathFunction. + + Represent the IOfficeMathFunction to retrive. + Retruns the ControlProperties of IOfficeMathFunction + + + + Update a current bounds with modified bounds + + Represent a current bounds + Represent a modified bounds + + + + + Get the Next characters from next math elements. + + + + + + + + + Replace the normal text with Mathematical alphanumeric symbol unicode based on Math style type. + + + + + + Determines whether spacing should be skipped after an operator. + + The character preceding the operator. + The operator character. + The character following the operator. + True if spacing should be skipped after the operator; otherwise, false. + + + + Determines if it is necessary to skip the space character based on the next character's value. + + Reference to the next character. + Index of the character whose next character is to be retrieved. + The text containing the character. + Current index in the text. + The text range associated with the character. + True if it is necessary to skip the space character, false otherwise. + + + + Retrieves the next character relative to the specified character index in the given text. + + Reference to the next character. + Index of the character whose next character is to be retrieved. + The text containing the character. + Current index in the text. + The text range associated with the character. + + + + Retrieves the previous character relative to the specified character index in the given text. + + Reference to the previous character. + Index of the character whose previous character is to be retrieved. + The text containing the character. + Current index in the text. + The text range associated with the character. + + + + Adjusts the base value to get the character with style properly. + + The character value. + The base value to adjust. + The adjusted base value. + + + + Find the given character value is operator or not. + + + + + + + Find the Given character is Greek character or not. + + + + + + + Layouts the + + Represent the bounds for layouting + Represent the layouted widget of owner OfficeMath + Represent the IOfficeMathBaseCollection to layout + Return the layouted widget of OfficeMathRunElement + + + + Checks whether current math function layouting is nested or not. + + Return true, if its nested math function layouting. + + + + Checks whether current math function is nested function of specified function type. + + Represent the function type, which is nested parent. + Returns true, if current math function have nested parent. + + + + Layouts the + + Represent the bounds for layouting + Represent the layouted widget of owner OfficeMath + Represent the IOfficeMathBaseCollection to layout + Return the layouted widget of OfficeMathRadical + + + + Shifts the X and Y position of LayoutedLineWidget array. + + Represent the LayoutedLineWidget array to shift. + Represent the X position value to shift. + Represent the Y position value to shift. + + + + Generate a radical lines. + + Represent the radical switch. + Represent the bounds of the radical equation. + Hold the radical symbol width. + + + + + Generate hook portion of radical symbol. + + Inner elmenet bounds of the radical equation. + Represent the points of radical downward line. + Thickness of the line to generate + Height of the hook to generate. + Represent the radical symbol font. + + + + Generates top horizontal line of radical symbol. + + Inner elmenet bounds of the radical equation. + Represent the points of radical upward line. + Thickness of the line to generate + + + + Generates downward line of radical symbol. + + Inner elmenet bounds of the radical equation. + Represent the points of radical upward line. + Thickness of the line to generate + Height of the hook to generate. + Represent the radical symbol font. + + + + Generates upward line of radical symbol. + + Inner elmenet bounds of the radical equation. + Represent the radical symbol font. + Thickness of the line to generate + + + + Get the another length from the known angles. + + Opposite side of angle1. + One of the angle, whose opposite side is known value. + Another angle, whose opposite side need to calculate + Returns calculated width from height and angles. + + + + Converts degrees into radian. + + Represents an angle in degree + Returns radian value of inputed degree value. + + + + Layouts the + + Represent the bounds for layouting + Represent the layouted widget of owner OfficeMath + Represent the IOfficeMathBaseCollection to layout + Return the layouted widget of IOfficeMathPhantom + + + + Layouts the + + Represent the bounds for layouting + Represent the layouted widget of owner OfficeMath + Represent the IOfficeMathBaseCollection to layout + Return the layouted widget of OfficeMathFraction + + + + Layouts the + + Represent the bounds for layouting + Represent the layouted widget of owner OfficeMath + Represent the IOfficeMathBaseCollection to layout + Return the layouted widget of OfficeMathDelimiter + + + + Check whether current character is stretchable or not. + + Specify the character to check. + Returns true if input character is stretchable. + + + + Layouts the + + Represent the bounds for layouting + Represent the layouted widget of owner OfficeMath + Represent the IOfficeMathBaseCollection to layout + Represent whether current layouting is nested layouting or not. + + + + + Layouts the + + Represent the bounds for layouting + Represent the layouted widget of owner OfficeMath + Represent the IOfficeMathBaseCollection to layout + Represent whether current layouting is nested layouting or not. + + + + Layouts the + + Represent the bounds for layouting + Represent the layouted widget of owner OfficeMath + Represent the IOfficeMathBaseCollection to layout + Represent whether current layouting is nested layouting or not. + + + + Layouts the + + + + + + + + + Shift the Cell widget vertically. + + + + + + + + + + + + Shift the cell widget Horizontally. + + + + + + + + + + + + + + Layout the bar line. + + + + + + + + + + + + Layout the border box lines with respect to Math equation. + + + + + + + + + + + + Layouts the + + Represent the bounds for layouting + Represent the layouted widget of owner OfficeMath + Represent the IOfficeMathEquationArray to layout + Represent whether current layouting is nested layouting or not. + Represent whether equation array has fraction as parent or not. + Return the layouted widget of IOfficeMathEquationArray + + + + + Gets the exact row spacing value for the specified spacing rule with input row spacing value. + + Represent the input spacing value. + Specify the control character font. + Specify the spacing rule to find the row spacing. + + + + + + + + + + + + + + Reduces the font size of an OfficeMath. + + Represent the OfficeMath entity to reduce the font size. + Represent the font size ratio to multiply. + + + + Align the LayoutedMathWidget vertically. + + Represent the layoutedMathWidget to align vertically. + + + + Align the OfficeMathWidget vertically. + + Represent the officeMathWidget to align vertically. + + + + Gets the maximum bottom value of layouted OfficeMathWidget. + + Represent the officeMathWidget. + + + + + Gets the maximum bottom value of layouted MathWidget. + + Represent the MathWidget. + + + + + Gets the vertical center point of a layouted office math widget. + + Represent the layouted office math widget to find. + Returns the vertical center point of an LayoutedOMathWidget. + + + + Layouts the collection + + Represent the bounds for layouting + Represent the layouted widget of owner WMath + Represent the IOfficeMaths to layout + + + + Layouts the entity. + + Represent the bounds for layouting + Represent the IOfficeMath to layout + Represent whether current layouting is nested layouting or not. + + + + + Create layouted widget for the + + Represent the location of widget + Represent the IOfficeMath instance + Return the layouted widget of OfficeMath + + + + Create layouted widget for the + + Represent the location of widget + Return the of instance + + + + Transform the input point to given angle with specified length. + + Represent the input point to transform. + Represent the length. + Represent the angle to transform. + + + + + Gets the WMath widget of . Read-only + + The instance of the current MathLayoutContext. + + + + Gets the current Word Document instance. + + + + + Gets the original size of a WMath container. + + + + + Gets the call stack of math layouting context. + + + + + Summary description for LeafEmtyWidget. + + + + + Initializes a new instance of the class. + + The size. + + + + Measures the specified graphics. + + The graphics. + + + + + Draw range to graphics. + + + + + Initializing LayoutInfo value to null + + + + + Initializing LayoutInfo value to null + + + + + Gets layout info. + + + + + Summary description for SplitTableWidget. + + + + + Initializes a new instance of the class. + + The table widget. + The row number. + + + + Initializes a new instance of the class. + + The table widget. + The row number. + The row number. + + + + Initializes a new instance of the class. + + The table widget. + The row number. + The column number. + + + + Draw range to graphics. + + + + + Initializing LayoutInfo value to null + + + + + Gets the table widget. + + The table widget. + + + + Gets the start row number. + + The start row number. + + + + Gets the start column number. + + The start column number. + + + + Gets the splitted cells. + + The splitted cells. + + + + Gets layout info. + + + + + + Summary description for SplitWidgetContainer. + + + + + Initializes a new instance of the class. + + The container. + + + + Initializes a new instance of the class. + + The container. + The current child. + Index of the first. + + + + Initializing LayoutInfo value to null + + + + + Initializing LayoutInfo value to null + + + + + Gets the real widget container. + + The real widget container. + + + + Gets layout info. + + + + + + Gets count of child widgets. + + + + + + Gets child widget by index. + + + + + + Get child widgets + + + + + + + + + + Initializes a new instance of the class. + + The STR widget. + The text. + + + + Gets the text. + + + + + + Initializing LayoutInfo value to null + + + + + Splits the size of the by. + + The graphics. + The offset. + The clientWidth. + + + + + Measures the specified graphics. + + The graphics. + + + + + Splits the by offset. + + The graphics. + The offset. + The STR widget. + The splitted text. + + + + + Implemented alternative method to improve the performance + + + + + + + + Gets or sets a value indicating whether the trail spaces wrapped or not. + + + true if this instance is trail spaces wrapped; otherwise, false. + + + + + Gets and sets the Splitted Text + + + + + Gets the real string widget. + + The real string widget. + + + + Gets layout info. + + + + + Utility class for working with strings. + + + + + Whitespace symbol. + + + + + Whitespace symbol. + + + + + Hyphen symbol. + + + + + Default RegEx checks object's options. + + + + + Pattern for WhiteSpace. + + + + + Array of spaces. + + + + + Whitespace regex. + + + + + Text data. + + + + + Current position. + + + + + Initializes a new instance of the class. + + The text. + + + + + + Returns number of symbols occurred in the text. + + Text data. + Symbol to be searched. + + Number of symbols occurred in the text. + + + + + + + Returns number of symbols occurred in the text. + + Text data. + Array of symbols to be searched. + + Number of symbols occurred in the text. + + + + + Reads line of the text. + + Text line. + + + + Reads line of the text. + + Text line. + + + + reads a word from the text. + + A word from the data. + + + + Peeks a word from the text. + + A word from the data. + + + + Reads char form the data. + + Char symbol. + + + + Reads count of the symbols. + + Number of symbols. + String text. + + + + Reads data till the symbol. + + Specified symbol. + If true - to read the symbol. + The data read. + + + + Peeks char form the data. + + Char symbol. + + + + Closes a reader. + + + + + Reads text to the end. + + Reads text to the end. + + + + Indicates whether user specified token is whitespace symbols or not. + + Token to check. + True if token is whitespace; False otherwise. + + + + Indicates whether user specified token is whitespace symbols or not. + + Token to check. + True if token is whitespace; False otherwise. + + + + Indicates whether user specified token is tab symbols or not. + + Token to check. + True if token is whitespace; False otherwise. + + + + Calculates number of the whitespace symbols at the start or at the end of the line. + + String line. + If true - check start of the line, end of the line otherwise. + Number of the whitespace symbols at the start or at the end of the line. + + + + To check the text is Chinese unicode character + + + + + + + Checks whether array contains a symbol. + + Array of symbols. + Char symbol. + True - if comtains, False otherwise. + + + + Gets value indicating whether there is and of the data. + + + + + Gets text length. + + + + + Gets current position. + + + + + Class for splitting text. + + + + + Initializes a new instance of the class. + + + + + Splits the specified text. + + The text. + The graphics. + The font. + The format. + The size. + + + + + Does the split. + + + + + + Copies to result. + + The result. + The line result. + The lines. + The num inserted. + + + + + Finalizes final result. + + Final result. + Lines array. + + + + Calculates height of the line. + + Height of the line. + + + + Splits line. + + Text line. + Line indent. + + + + Gets dictionary for the corresponding language code from the hyphenator class. + + + + + + + + Splits a Word based on auto hyphenation of particular language. + + Maximaum available width to fit the text. + Possible hyphenated Words in the particular language + + + + + + + + + Adds line to line result. + + Line resut. + Array of the lines. + Text line. + Line width. + Line break type. + + + + Trims whitespaces at the line. + + Line info. + Indicates whether the line is the first in the text. + Trimed line info. + + + + Calculates width of the line. + + String line. + Width of the line. + + + + Returns line indent for the line. + + If true - the line is the first in the text. + Line indent for the line. + + + + Returns wrap type. + + Returns wrap type. + + + + Represents the result. + + + + + Layouted lines. + + + + + The text wasn't lay outed. + + + + + Actual layouted text bounds. + + + + + Height of the line. + + + + + Gets value that indicates whether any text was layouted. + + + + + Gets number of the lines layouted. + + + + + Contains information about the line. + + + + + Line text. + + + + + Width of the text. + + + + + Breaking type of the line. + + + + + + + + + + The position of first symbol + + + + + The position of last symbol + + + + + Disabled default constructor. + + + + + Initializes a new instance of the class. + + The first pos. + The last pos. + + + + Checks the specified length. + + The length. + + + + Extends the specified STR split info. + + The STR split info. + + + + Gets the split first part. + + The position. + + + + + Gets the split second part. + + The position. + + + + + Gets the substring. + + The text. + + + + + Gets the first position. + + The first position. + + + + Gets the last position. + + The last position. + + + + Gets the length. + + The length. + + + + Represents the methods and properties that can be working with hyphenation dictionaries. + + + + + Initializing the hyphenator for event handling. + + + + + Initializing the hyphenator to load the dictionary file. + + + + + + + Loads the dictionary file. + + + + + + Returns maximum value in the list. + + + + + + + Hyphenate the text based on the patterns + + + + + + + Gets the postion of the each pattern + + + + + + + Creates the hyphenated mask levels + + + + + + + Hypenates the masked string. + + + + + + + + Gets the alternate dictionary for the missed language code in the dictionary. + + + + + + + Occurs during Word to PDF/Image conversion to adds the alternate dictionary when a specified dictionary doesn�t exist in the collection. + + This event is supported for Word to PDF/Image conversion alone. + + + + Gets or sets patterns for the language dictionary + + + + + + Gets or sets hyphenation object using dictionary. + + + + + Represents the method that handles Adding of dictionary event. + + + + + Occurs during Word to PDF/Image conversion to add dictionary when a specified language dictionary doesn�t exist in the collection. + + + + + Represents the language code. + + + + + Represents the dictionary stream. + + + + + Initializes a new instance of class for the specified document + with original (missing) language code, and alternate language code. + + Name of the original (missing) language code. + Name of the alternate language code. + + + + Gets the original language code. Read Only. + + The string that specifies the original language code. + + + + + Helper class, used for getting font ascent/descent + + + + + Initializes a new instance of the class. + + + + + Gets the ascent. + + The ascent. + + + + Gets the descent. + + The descent. + + + + Implements a Rectangle like behavior. + + + + + Gets or sets the left. + + The left. + + + + Gets or sets the top. + + The top. + + + + Gets or sets the right. + + The right. + + + + Gets or sets the bottom. + + The bottom. + + + + Known to us measure units. + + + + + Specifies 1/75 inch as the unit of measure. + + + + + Specifies the document unit (1/300 inch) as the unit of measure. + + + + + Specifies the inch as the unit of measure. + + + + + Specifies the millimeter as the unit of measure. + + + + + Specifies the centimeter as the unit of measure. + + + + + Specifies a device pixel as the unit of measure. + + + + + Specifies a printers point (1/72 inch) as the unit of measure. + + + + + Specifies the English Metric Units as the unit of measure + + + + + Class allow to convert differ metrics units. Convert is + based on Graphics object DPI settings that is why for differ + graphics settings must be created new instance. For example: + printers often has 300 and greater dpi resolution, for compare + default display screen dpi is 96. + + + + + Standart picture DPI. + + + + + Matrix for conversations between different numeric systems + + + + + Prevent class creation + + + + + Create Units convert class based on specified Graphics units + + Graphics for measuring + + + + Converts value, stored in "from" units, to value in "to" units + + Value to convert + Indicates units to convert from + Indicates units to convert to + Value stored in "to" units + + + + Converts value, stored in "from" units, to pixels + + Value to convert + Indicates units to convert from + Value stored in pixels + + + + Converts value, stored in "from" units, to pixels + + Value to convert + Indicates units to convert from + Value stored in pixels + + + + Convert rectangle location and size to Pixels from specified + measure units + + source rectangle + source rectangle measure units + Rectangle with Pixels + + + + Convert point from specified measure units to pixels + + source point for convert + measure units + point in pixels coordinates + + + + Convert size from specified measure units to pixels + + source size + measure units + size in pixels + + + + Converts value, stored in pixels, to value in "to" units + + Value to convert + Indicates units to convert to + Value stored in "to" units + + + + Converts value, stored in pixels, to value in "to" units + + Value to convert + Indicates units to convert to + Value stored in "to" units + + + + Convert rectangle in Pixels into rectangle with specified + measure units + + source rectangle in pixels units + convert to units + output Rectangle in specified units + + + + Convert rectangle from pixels to specified units + + point in pixels units + convert to units + output Point in specified units + + + + Convert Size in pixels to size in specified measure units + + source size + convert to units + output size in specified measure units + + + + Convert Size in pixels to size in specified measure units + + source size + convert to units + output size in specified measure units + + + + Converts to pixels. + + The value. + From. + The dpi. + + + + + Converts to pixels. + + The value. + From. + The dpi. + + + + + Converts from pixels. + + The value. + To. + The dpi. + + + + + Converts from pixels. + + The value. + To. + The dpi. + + + + + Convert Size in pixels to size in specified measure units + + source size + convert to units + The dpi. + output size in specified measure units + + + + Gets the proporsion. + + The dpi. + + + + + + + + + + Close this instance. + + + + + Update proportions matrix according to Graphics settings + + reference to graphics + + + + Get Empty graphics created on Bitmap + + + + + Gets an instance of units converter. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents state information of LayoutContext object + + + + + Unknown state, set by itialization of LayoutContext + Cann't returned to parent context + + + + + Current context contains at last one child. Layouting process on + current level not finished. + Cann't returned to parent context + + + + + Current context contains at last one child. Last widget + ( or child context ) was splitted. + + + + + Wrap string based on TextWrapBounds + + + + + Current context contains at last one child. Layouting process + finished. + + + + + Current context contains at last one child. Layouting process + breaked. + + + + + Layoutted content need to relayout. Layouting process. + DynamicRelayout. + + + + + + + + + + Left tab. + + + + + Centered tab. + + + + + Right tab. + + + + + Decimal tab. + + + + + Bar. + + + + + + + + + + No leader. + + + + + Dotted leader. + + + + + Hyphenated leader. + + + + + Single line leader. + + + + + Heavy line leader. + + + + + + + + + + + + + + + + + + + + Break type of the line. + + + + + Unknown type line. + + + + + The line has new line symbol. + + + + + layout break. + + + + + The line is the first in the paragraph. + + + + + The line is the last in the paragraph. + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for StreamReadError. + + + + + Default exception message. + + + + + Default constructor. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for StreamReadError. + + + + + Default exception message. + + + + + Default constructor. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for StreamReadError. + + + + + Default exception message. + + + + + Default constructor. + + + + + Initializes a new instance of the class. + + The inner exc. + + + + Throws Exception when document appears to be corrupted and impossible. + + + + + + Throws Exception when document appears to be corrupted and impossible. + + + + + + + Throws Exception when document appears to be corrupted and impossible. + + + + + + + Converts the WordDocument Section properties into ODF Section properties + + + + + + + Updates the text, that cannot be represented in Xml as defined by XML 1.0 specification. + + + + + + + Checks for the valid xml character. + + + + + + Update the shape id. + + + + + + + Adds the image relation. + + The image collection. + The image record. + + + + + Get the next relationship ID + + returns the next relationship ID + + + + Reset the relationship id counter + + + + + Get the picture owner. + + + + + + + + + + + + + + Get the base entity + + + + + + + Loads the header footer contents + + + + + + + Gets the HeaderFooter content + + + + + + + + Gets the list level text alignment + + + + + + + Converts the WPageSetup to PageLayout properties + + The Page setup + The Page layout + The Master page + + + + Implemented alternative method to improve the performance + + + + + + + + Gets/Sets the value to denote the writer is writing header footer contents + + + + + Summary description for AnnotationReferenceDescriptor. + + + + + + + + + + Index into GrpXstAtnOwners + + + + + Unused + + + + + Unused + + + + + when not -1, this tag identifies the annotation bookmark that + locates the range of CPs in the main document which this annotation references. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for BinaryTable. + + + + + Base class for all records in Word document. + + + + + Number of bits in byte. + + + + + Number of bits in short. + + + + + Number of bits in int. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The data. + + + + Initializes a new instance of the class. + + The arr data. + The i offset. + + + + Initializes a new instance of the class. + + The arr data. + The i offset. + The i count. + + + + Initializes a new instance of the class. + + The stream. + The i count. + + + + Returns value of the single bit from byte. + + Byte to get bit value from. + Bit index. + Value of the single bit from byte. + + + + Returns value of the single bit from byte. + + Int16 to get bit value from. + Bit index. + Value of the single bit from byte. + + + + Returns value of the single bit from byte. + + Byte to get bit value from. + Bit index. + Value of the single bit from byte. + + + + Gets the bits by mask. + + The value. + The bit mask. + The i start bit. + + + + + Gets the bits by mask. + + The value. + The bit mask. + The i start bit. + + + + + Sets the bit. + + The i value. + The bit pos. + if set to true [value]. + + + + + Sets value with all bits that correspond to the specified + mask to zero to the same values as in value. + + Variable that bits of which will be set. + Bit mask. + Value from which bit values will be taken. + Value after set operation. + + + + Sets the bits by mask. + + The destination. + The bit mask. + The i start bit. + The value. + + + + + Sets value with all bits that correspond to the specified + mask to zero to the same values as in value. + + Variable that bits of which will be set. + Bit mask. + Value from which bit values will be taken. + Value after set operation. + + + + Gets the bit. + + The UI options. + The bit pos. + + + + + Sets one bit in specified Int32. + + Int32 to set bit. + Bit position in the byte + Value of bit + + If bitPos is less than zero or more than 7 + + Value after + + + + Reads UInt16 value from the stream. + + Stream to read value from. + Read value. + + + + Reads UInt32 value from the stream. + + Stream to read value from. + Read value. + + + + Reads UInt16 value from the stream. + + Stream to read value from. + Read value. + + + + Reads UInt32 value from the stream. + + Stream to read value from. + Read value. + + + + Gets UInt16 value from the array. + + Array of bytes to get value from. + Offset of the UInt16 value. + UInt16 value read from array. + + + + Gets UInt16 value from the array and moves position. + + Array of bytes to get value from. + Offset of the UInt16 value. + UInt16 value read from array. + + + + Reads the string. + + The stream. + + + + + Writes the string. + + The stream. + The STR. + + + + Gets string from array of bytes. + + Array with string data. + Offset to the string data. + String that was extracted from the array. + + + + Reads the string. + + The arr data. + The i offset. + The us count. + + + + + Gets the zero terminated string. + + The arr data. + The i offset. + The i end pos. + + + + + Toes the zero terminated array. + + The sting. + + + + + Writes the U int16. + + The arr data. + The us value. + The i offset. + + + + Writes the U int32. + + The arr data. + The uint value. + The i offset. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Copy array of bytes to target array + and changes iOffset parameter. + + + + + + + + + Reads the bytes. + + The stream. + The i. + + + + + Parses record. + + Data to parse. + + + + Parses record. + + Data to parse. + Offset in the data array to the records data. + + + + Parses the specified arr data. + + The arr data. + The i offset. + The i count. + + + + Parses the specified stream. + + The stream. + The i count. + + + + Saves the specified arr data. + + The arr data. + The i offset. + + + + + Saves the specified stream. + + The stream. + + + + + Closes this instance. + + + + + Gets the length. + + The length. + + + + Gets the underlying structure. + + The underlying structure. + + + + Array of file positions (n+1). + + + + + Array of talbe entries (n). + + + + + Default constructor. + + + + + + + + + + + + + + + + + + + + Closes this instance. + + + + + Parses the specified data. + + The data. + The offset. + Length. + + + + Saves record into array of bytes. + + Array of bytes to save record into. + Offset in the array. + Number of bytes in the written data. + + + + Returns array of character positions. Read-only. + + + + + Returns array of binary table entries. Read-only. + + + + + + + + + + Returns number of bytes needed to store record in a stream or in an array. + Read-only. + + + + + Summary description for BookmarkFirstDescriptor. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Default constructor. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Saves the specified stream. + + The stream. + The fib. + The end character. + + + + + + + + + + Determines whether specified bookmark covers a group of table cells. + + Index of the bookmark. + + true if [is column group] returns true; otherwise, false. + + + + + Sets specified bookmark covers a group of table cells. + + Index of the bookmark. + + + + Gets the start index of the cell which is covered by the bookmark. + + Index of the bookmark. + + + + + Sets the start index of the cell bookmark. + + Index of the bookmark. + The position. + + + + Gets the end index of the cell which is covered by the bookmark. + + Index of the bookmark. + + + + + Sets the end index of the cell bookmark. + + Index of the bookmark. + The position. + + + + Closes this instance. + + + + + + + + + + + + + + + + + + + + + Writes the BKF. + + The stream. + The fib. + The end character. + + + + Writes the BKL. + + The stream. + The fib. + The end character. + + + + + + + + + + + + + + Summary description for Bookmark. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + The name. + The start pos. + The end pos. + if set to true [is cell group]. + Start index of the cell. + End index of the cell. + + + + Clones current BookmarkInfo object. + + + + + + + + + + + + + + + + + + + + + Determines whether specified bookmark covers a group of table cells . + + + + + Gets the start index of the cell which is covered by the bookmark. + + + + + Gets the end index of the cell which is covered by the bookmark. + + + + + Bookmark index in the collection of bookmarks. + + + + + Summary description for BookmarkNameRecord. + + + + + + + + + + + + + + + Default constructor. + + + + + Initializes a new instance of the class. + + + + + Closes this instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the length of the bookmark names. + + The length of the bookmark names. + + + + Summary description for BRC. + + + + + + + + + + width of a single line in 1/8 pt, max of 32 pt. + + + + + border type code: + + + + + color code + + + + + + + + + + :5 1F00 width of space to maintain between border and text within border. + Must be 0 when BRC is a substructure of TC. Stored in points. + :1 2000 when 1, border is drawn with shadow. Must be 0 when BRC is a substructure of the TC + + + + + + + + + + + + + + + + + Parse byte array to brc structure + + + + + + + Parse byte array to brc structure + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Compares the border properties + + The BorderCode instance to compare + True if properties are same, else false + + + + Gets the border code text for Word comparison + + + + + + Gets the ignorable properties + + + + + + Width of a Line + + + + + Border type code + + + + + Width of space to maintain between border and text within border + + + + + when true, border is drawn with shadow + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for BreakDescriptor. + + + + + except in textbox BKD, index to PGD in plfpgd that describes the page this break is on. + + + + + number of cp's considered for this break; note that the CP's described by cpDepend in this break reside in the next BKD + + + + + + + + + + Option flags. + + + + + Default constructor + + + + + Constructor with table stream parametr + + table stream + + + + Fill class fields + + + + + + Write break descriptor structure to stream + + + + + + Index to PGD in plfpgd. + + + + + Number of cp's considered for this break. + + + + + Options + + + + + Get/set table break option. + + + + + Get/set column brake option. + + + + + Get/set Marked option. + + + + + Get/set fUnk option + in textbox BKD, when == 1 indicates cpLim of this textbox is not valid. + + + + + Get/set text overflows the end of this textbox option + + + + + + + + + + Bit index for IsTableBreak flag. + + + + + Bit index for IsColumnBreak flag. + + + + + Bit index for IsMarked flag. + + + + + Bit index for IsLimitValid flag. + + + + + Size of the record in bytes. + + + + + Underlying structure. + + + + + Default constructor. + + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + MemoryConverter to convert array of bytes into structure. + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + Offset to the class data. + MemoryConverter to convert array of bytes into structure. + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + Offset to the class data. + Number of bytes for the new record. + MemoryConverter to convert array of bytes into structure. + + + + Creates new record from stream. + + Stream with record's data. + Number of bytes to parse. + MemoryConverter to convert array of bytes into structure. + + + + Except in textbox BKD, index to PGD in plfpgd that describes + the page this break is on (ipgd). + + + + + in textbox BKD, + + + + + Number of cp's considered for this break; + note that the CP's described by cpDepend + in this break reside in the next BKD. + + + + + Option flags. Read-only. + + + + + ??? + + + + + Indicates whether this is table break. + + + + + Indicates whether this is a table break. + + + + + Used temporarily while word is running. + + + + + In textbox BKD, when == True indicates cpLim of this textbox is not valid. + + + + + In textbox BKD, when == True indicates that text overflows the end of this textbox. + + + + + Returns underlying structure. Read-only. + + + + + Returns number of bytes needed to store record in a stream or in an array. + Read-only. + + + + + Summary description for BinaryTable. + + + + + Array of file positions (n+1). + + + + + Array of talbe entries (n). + + + + + Default constructor. + + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + Offset to the class data. + MemoryConverter to convert array of bytes into structure. + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + Offset to the class data. + Number of bytes for the new record. + MemoryConverter to convert array of bytes into structure. + + + + Creates new record from stream. + + Stream with record's data. + Number of bytes to parse. + MemoryConverter to convert array of bytes into structure. + + + + Parses record. + + Data to parse. + Offset in the data array to the records data. + Number of bytes to parse. + + + + Parses record. + + Stream with record's data. + Number of bytes to parse. + + + + Returns array of character positions. Read-only. + + + + + Returns array of binary table entries. Read-only. + + + + + + + + + + Summary description for CharacterProperty. + + + + + + + + + + + + + + + + + + + + + + + + + Initializing constructor + + + + + Determines whether the specified option has options. + + The option. + + if the specified option has options, set to true. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Sets the name of the font. + + Name of the font. + The option. + + + + Adds the SPRM. + + The option. + if set to true [value]. + + + + Adds the SPRM. + + The option. + The value. + + + + Adds the SPRM. + + The option. + The value. + + + + Adds the SPRM. + + The option. + The value. + + + + Adds the SPRM. + + The option. + The value. + + + + Clones internal chpx. + + + + + Removes the SPRM. + + The option. + + + + Determines whether this instance has Single Property Modifier Record Array. + + + if this instance has Single Property Modifier Record Array, set to true. + + + + + Gets the new (added when track changes property is on) Single Property Modifier Record. + + The option. + + + + + Gets the index of the new (changed) character properties. + + + + + Converts color to word color format + + + + + + + + + + + + + + + Returns a that represents the current . + + + A that represents the current . + + + + + Closes this instance. + + + + + Gets Sprm array + + + + + Gets CharacterPropertyException. + + + + + Gets/Sets the Complex script property + + + + + Gets/sets Bold property + + + + + Gets/sets Italic property + + + + + Gets/sets Italic property + + + + + Gets/sets Italic property + + + + + Gets/sets Strike property + + + + + + + + + + + + + + + Gets/sets DoubleStrtike property + + + + + Gets/sets Underline property + + + + + Gets/sets Font name property + + + + + Gets/sets Font name property + + + + + Gets/sets Font name property + + + + + Gets/sets Font name property + + + + + Gets/sets Font name property + + + + + Gets/sets FontAscii property + + + + + Gets/sets FontFarEast property + + + + + Gets/sets Non FontFarEast property + + + + + Gets/sets Non FontFarEast property + + + + + Gets/sets FontSize property + + + + + Gets/sets FontSizeHP property + + + + + Gets/sets FontColor property + + + + + Gets/sets Extended FontColor property + + + + + Gets/sets Extended FontColor property + + + + + Gets/sets BackGround color property + + + + + Gets/sets Sub/Super/Non script property + + + + + Gets/sets Clear property + Gets the sprm byte value and set sprm byte value to the corresponding sprm + + + + Gets/sets Picture Location + + + + + Gets/sets Outline property + + + + + Gets/sets Shadow property + + + + + Gets/sets Emboss property + + + + + Gets/sets Emboss property (Complex). + + + + + Gets/sets Engrave property + + + + + Gets/sets Engrave property ( Complex ) + + + + + Gets/sets Hidden property + + + + + Gets/sets SpecVanish property + + + + + Gets/sets SmallCaps property + + + + + Gets/sets AllCapitalized property + + + + + Gets/sets AllCapitalized property ( Complex ). + + + + + Gets/sets Font Position( raised/lowered ) property + + + + + Gets/sets Font Spacing property + + + + + Gets/sets Font Scaling property + + + + + Gets/sets Font Kern property + + + + + Gets/sets Font Shading property + + + + + Gets/sets Font Shading property + + + + + Gets/sets Border property + + + + + Gets/sets coping of sprms or not + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets/sets Bold property + + + + + Gets/sets Bold property + + + + + Gets or sets a value indicating whether no proof. + + if it is no proof, set to true. + + + + + + + + + Gets a value indicating whether this instance is inserted change. + + + true if this instance is inserted change; otherwise, false. + + + + + Gets a value indicating whether this instance is deleted change. + + + true if this instance is deleted change; otherwise, false. + + + + + Defines whether formatting was changed. + + + + + Gets or sets the index of the list pictture. + + The index of the list pictture. + + + + Gets or sets a value indicating whether [list has image]. + + true if [list has image]; otherwise, false. + + + + Gets/sets Bold property + + + + + Gets/sets Italic property + + + + + Gets/sets Bold property + + + + + Gets/sets FontSizeHP property + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets the language\locale identifier ASCII for older Word version. + + + The language\locale identifier ASCII. + + + + + Gets or sets the language\locale identifier for ASCII characters in later Word version. + + + The language\locale identifier for ASCII characters. + + + + + Gets or sets the language\locale identifier for far east characters in older Word version. + + + The language\locale identifier for far east characters. + + + + + Gets or sets the language\locale identifier for far east characters in later Word version. + + + The language\locale identifier for far east characters. + + + + + Gets or sets the language\locale identifier for bi-directional characters. + + + The language\locale identifier for bi-directional characters. + + + + + Summary description for FKPForCharacterProperties = CharPropertiesPage. + + + + + Size of the FC (File Character position). + + + + + Each FC is the limit FC of a run of exception text. + + + + + Consists of all of the CHPXs stored in FKP concatenated end to end. + Each CHPX is prefixed with a count of bytes which records its length. + + + + + Default constructor. + + + + + + + + + + + + Closes this instance. + + + + + + + + + + + + + + + + + + + Saves record into array of bytes. + + Array of bytes to save record into. + Offset in the array. + Number of bytes in the written data. + + + + + + + + + + + + checks whether the Chpx at the current index is already parsed. (already added to offset array) + + Current Index + + + + + Each FC is the limit FC of a run of exception text. + + + + + + + + + + Count of runs. + + + + + + + + + + Summary description for CharPropertyException (CHPX). + + + + + Count of bytes of following data in CHPX. + + + + + A list of the sprms (Single PRoperty modifier) that encode + the differences between CHP (CHaracter property) for a run + of text and the CHP generated by the paragraph and character + styles that tag the run. + + + + + Default constructor. + + + + + Default constructor. + + + + + + + + + + + + + + + + + + + Parses the specified data. + + The data. + The offset. + The count. + + + + Saves record into array of bytes. + + Array of bytes to save record into. + Offset in the array. + Number of bytes in the written data. + + + + + + + + + + + + + Determines whether this instance has SPRMS. + + + true if this instance has SPRMS; otherwise, false. + + + + + Closes this instance. + + + + + Returns a value indicating whether this instance is equal to the character property exception passed as argument. + + chpx + + + + + Check whether the sprm passed in the arguments are equal. + + sprm + prevSprm + sprm Compare type + + + + + A list of the sprms (Single PRoperty modifier) that encode + the differences between CHP (CHaracter property) for a run + of text and the CHP generated by the paragraph and character + styles that tag the run. + + + + + Returns number of property modifiers. Read-only. + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for CharPosTable. + + + + + + + + + + Default constructor. + + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + Offset to the class data. + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + Offset to the class data. + Number of bytes for the new record. + MemoryConverter to convert array of bytes into structure. + + + + Creates new record from stream. + + Stream with record's data. + Number of bytes to parse. + MemoryConverter to convert array of bytes into structure. + + + + + + + + + + + + Closes this instance. + + + + + Parses record. + + Data to parse. + Offset in the data array to the records data. + Number of bytes to parse. + MemoryConverter to convert array of bytes into structure. + + + + + + + + + + + + + Gets text positions. Read-only. + + + + + + + + + + Summary description for ColumnArray. + + + + + Default distance between coumns in twips + + + + + + + + + + + + + + + + + + + + + + + + + + + + Closes this instance. + + + + + + + + + + Reads the column from the sprms. + + + + + + + + + + + + + + + Summary description for ColumnDescriptor. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Interface which represents data structures. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Gets the size of the structure. + + The length. + + + + Reads the int16. + + The data array. + The offset. + + + + + Reads the int32. + + The data array. + The offset. + + + + + Reads the int64. + + The data array. + The offset. + + + + + Reads the int16. + + The data array. + The offset. + + + + + Reads the int32. + + The data array. + The offset. + + + + + Reads the array of bytes. + + The data array. + The length. + The offset. + + + + + Saves the specified int16 value in the data array. + + The arr data. + The offset. + + + + Saves the specified uint16 value in the data array. + + The arr data. + The offset. + + + + Saves the specified int32 value in the data array. + + The arr data. + The offset. + + + + Saves the specified int64 value in the data array. + + The destination. + The offset. + The value. + + + + Saves the specified uint32 value in the data array. + + The arr data. + The offset. + + + + Saves the bytes byte array. + + The destination array. + The offset. + The bytes. + + + + Copies the memory. + + The destination. + The source. + The length. + + + + Summary description for DOPStructure. + + + + + + + + + + Maximum length of the password. + + + + + Default password hash value. + + + + + + + + + + Initializes a new instance of the class. + + The stream. + The DOPDescriptor start. + Length of the dop. + if set to true document is template. + + + + Update date time values with reference to built in document properties. + + Built in document properties + + + + + + + + + + + + + + + + + Sets the document protection. + + The type. + The password. + + + + Parses the date time. + Date and Time (internal date format) (DTTM) + field | type | size | bitfield | comment + mint | U16 | :6 | 003F | minutes (0-59) + hr | U16 | :5 | 07C0 | hours (0-23) + dom | U16 | :5 | F800 | days of month (1-31) + mon | U16 | :4 | 000F | months (1-12) + yr | U16 | :9 | 1FF0 | years (1900-2411)-1900 + wdy | U16 | :3 | E000 | weekday + Weekday: Sunday=0, Monday=1, Tuesday=2, Wednesday=3, Thursday=4, Friday=5, Saturday=6 + + The date time. + + + + + Sets the date time. + + The dt. + + + + + Converts the day of week to integer. + + The DayOfWeek member. + + + + + Returns hash value for the password string. + + Password to hash. + Hash value for the password string. + + + + Converts character to 15 bits sequence + + Character to convert. + + + + Converts bits array to UInt16 value. + + Array to convert. + Converted UInt16 value. + + + + Rotates (cyclic shift) bits in the array specified number of times + + Array to rotate + Number of times to rotate + Rotated array. + + + + + + + + + + + + Gets the dop95. + + The dop95. + + + + Gets the dop97. + + The dop97. + + + + Gets the dop2000. + + The dop2000. + + + + Gets the dop2002. + + The dop2002. + + + + Gets the dop2003. + + The dop2003. + + + + Gets the dop2007. + + The dop2007. + + + + Gets the copts60. + + The copts60. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the protection key. + + The protection key. + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets the width of the default tab. + + The width of the default tab. + + + + Specifies the maximum amount of white space, in twips, allowed at the end of the line before attempting to hyphenate the next word. + + + + + Specifies the maximum number of consecutive lines that can end in a hyphenated word before ignoring automatic hyphenation rules for a line. + + + + + Gets or sets a value indicating whether [spell all done]. + + + true if [spell all done]; otherwise, false. + + + + + Gets or sets a value indicating whether [spell clean]. + + + true if [spell clean]; otherwise, false. + + + + + Gets or sets a value indicating whether [spell hide errors]. + + + true if [spell hide errors]; otherwise, false. + + + + + Gets or sets a value indicating whether [grammar hide errors]. + + + true if [gram hide errors]; otherwise, false. + + + + + Gets or sets a value indicating whether [label document]. + + + true if [label document]; otherwise, false. + + + + + Specifies the capital letters are hyphenated in a given document + + + true if [hyph capitals]; otherwise, false. + + + + + When 1, Word will hyphenate newly typed text as a background task + + + true if [automatic hyphen]; otherwise, false. + + + + + Gets or sets a value indicating whether [form no fields]. + + + true if [form no fields]; otherwise, false. + + This property MUST be false, if ProtEnabled is false. + + + + when 1, Word will merge styles from its template + + + true if [link styles]; otherwise, false. + + + + + Gets or sets a value indicating whether [revision marking]. + + + true if [rev marking]; otherwise, false. + + + + + Gets or sets a value indicating whether [exact c words]. + + + true if [exact c words]; otherwise, false. + + + + + Gets or sets a value indicating whether [page hidden]. + + + true if [pag hidden]; otherwise, false. + + + + + Gets or sets a value indicating whether [page results]. + + + true if [pag results]; otherwise, false. + + + + + Gets or sets a value indicating whether [lock atn]. + + + true if [lock atn]; otherwise, false. + + + + + Gets a value indicating whether to mirror page margins. + + + true if than mirror margins; otherwise, false. + + + + + Gets or sets a value indicating whether [word97 compat]. + + + true if [word97 compat]; otherwise, false. + + + + + Gets or sets a value indicating whether [prot enabled]. + + + true if [prot enabled]; otherwise, false. + + + + + Gets or sets a value indicating whether the selection was within a display form field, when the document was saved last time. + + + true if the selection was within a display form field (check box or list box), when the document was saved last time; otherwise, false. + + This property MUST be false, if protection type is other than AllowOnlyFormFields. + + + + Gets or sets a value indicating whether [rm view]. + + + true if [rm view]; otherwise, false. + + + + + Gets or sets a value indicating whether [rm print]. + + + true if [rm print]; otherwise, false. + + + + + Gets or sets a value indicating whether [lock vba proj]. + + + true if [lock vba proj]; otherwise, false. + + + + + Gets or sets a value indicating whether [lock rev]. + + + true if [lock rev]; otherwise, false. + + + + + Gets or sets a value indicating whether [embed fonts]. + + + true if [embed fonts]; otherwise, false. + + + + + + + + + + Specifies whether to apply shading on form fields. + + true if form field shading is applied; otherwise, false. + + + + Gets or sets the a value indicating whether the gutter is at top of the document. + + True if the gutter is at top; otherwise, false. + + + + Specifies the structure of Dop95. + + + + + Initializes a new instance of the class. + + The dop base. + + + + Parses the specified stream. + + The stream. + + + + Writes the specified stream. + + The stream. + + + + Gets the copts80. + + The copts80. + + + + Specifies the structure of Dop97. + + + + + Initializes a new instance of the class. + + The dop base. + + + + Parses the specified stream. + + The stream. + + + + Writes the specified stream. + + The stream. + + + + Gets or sets the adt. + + The adt. + + + + Gets the dop typography. + + The dop typography. + + + + Gets the dogrid. + + The dogrid. + + + + Gets or sets the LVL dop. + + The LVL dop. + + + + Gets or sets a value indicating whether [gram all done]. + + true if [gram all done]; otherwise, false. + + + + Gets or sets a value indicating whether [gram all clean]. + + true if [gram all clean]; otherwise, false. + + + + Gets or sets a value indicating whether [subset fonts]. + + true if [subset fonts]; otherwise, false. + + + + Gets or sets a value indicating whether [HTML doc]. + + true if [HTML doc]; otherwise, false. + + + + Gets or sets a value indicating whether [disk LVC invalid]. + + true if [disk LVC invalid]; otherwise, false. + + + + Gets or sets a value indicating whether [snap border]. + + true if [snap border]; otherwise, false. + + + + Gets or sets a value indicating whether [include header]. + + true if [include header]; otherwise, false. + + + + Gets or sets a value indicating whether [include footer]. + + true if [include footer]; otherwise, false. + + + + Gets the asumyi. + + The asumyi. + + + + Gets or sets the C ch WS. + + The C ch WS. + + + + Gets or sets the C ch WS with subdocs. + + The C ch WS with subdocs. + + + + Gets or sets the GRF doc events. + + The GRF doc events. + + + + Gets or sets a value indicating whether [virus prompted]. + + true if [virus prompted]; otherwise, false. + + + + Gets or sets a value indicating whether [virus load safe]. + + true if [virus load safe]; otherwise, false. + + + + Gets or sets the key virus session30. + + The key virus session30. + + + + Gets or sets the cp max list cache main doc. + + The cp max list cache main doc. + + + + Gets or sets the ilfo last bullet main. + + The ilfo last bullet main. + + + + Gets or sets the ilfo last number main. + + The ilfo last number main. + + + + Gets or sets the CDBC. + + The CDBC. + + + + Gets or sets the CDBC with subdocs. + + The CDBC with subdocs. + + + + Gets or sets the NFC FTN ref. + + The NFC FTN ref. + + + + Gets or sets the NFC edn ref. + + The NFC edn ref. + + + + Gets or sets the HPS zoom font pag. + + The HPS zoom font pag. + + + + Gets or sets the dyw disp pag. + + The dyw disp pag. + + + + Specifies the structure of Dop2000. + + + + + Initializes a new instance of the class. + + The dop base. + + + + Parses the specified stream. + + The stream. + + + + Writes the specified stream. + + The stream. + + + + Gets or sets the ilvl last bullet main. + + The ilvl last bullet main. + + + + Gets or sets the ilvl last number main. + + The ilvl last number main. + + + + Gets or sets the type of the istd click para. + + The type of the istd click para. + + + + Gets or sets a value indicating whether [LAD all done]. + + true if [LAD all done]; otherwise, false. + + + + Gets or sets a value indicating whether [envelope vis]. + + true if [envelope vis]; otherwise, false. + + + + Gets or sets a value indicating whether [maybe tentative list in doc]. + + + true if [maybe tentative list in doc]; otherwise, false. + + + + + Gets or sets a value indicating whether [maybe fit text]. + + true if [maybe fit text]; otherwise, false. + + + + Gets or sets a value indicating whether [FCC all done]. + + true if [FCC all done]; otherwise, false. + + + + Gets or sets a value indicating whether [rely on CS s_ web opt]. + + true if [rely on CS s_ web opt]; otherwise, false. + + + + Gets or sets a value indicating whether [rely on VM l_ web opt]. + + true if [rely on VM l_ web opt]; otherwise, false. + + + + Gets or sets a value indicating whether [allow PN g_ web opt]. + + true if [allow PN g_ web opt]; otherwise, false. + + + + Gets or sets the screen size_ web opt. + + The screen size_ web opt. + + + + Gets or sets a value indicating whether [organize in folder_ web opt]. + + + true if [organize in folder_ web opt]; otherwise, false. + + + + + Gets or sets a value indicating whether [use long file names_ web opt]. + + + true if [use long file names_ web opt]; otherwise, false. + + + + + Gets or sets the pixels per inch_ web opt. + + The pixels per inch_ web opt. + + + + Gets or sets a value indicating whether [web options init]. + + true if [web options init]; otherwise, false. + + + + Gets or sets a value indicating whether [maybe FEL]. + + true if [maybe FEL]; otherwise, false. + + + + Gets or sets a value indicating whether [char line units]. + + true if [char line units]; otherwise, false. + + + + Gets the copts. + + The copts. + + + + Gets or sets the ver compat pre10. + + The ver compat pre10. + + + + Gets or sets a value indicating whether not to display page boundaries (doNotDisplayPageBoundaries - Open xml format property). + + true if [no marg PGVW saved]; otherwise, false. + + + + Gets or sets a value indicating whether [bullet proofed]. + + true if [bullet proofed]; otherwise, false. + + + + Gets or sets a value indicating whether [save uim]. + + true if [save uim]; otherwise, false. + + + + Gets or sets a value indicating whether [filter privacy]. + + true if [filter privacy]; otherwise, false. + + + + Gets or sets a value indicating whether [seen repairs]. + + true if [seen repairs]; otherwise, false. + + + + Gets or sets a value indicating whether this instance has XML. + + true if this instance has XML; otherwise, false. + + + + Gets or sets a value indicating whether [validate XML]. + + true if [validate XML]; otherwise, false. + + + + Gets or sets a value indicating whether [save invalid XML]. + + true if [save invalid XML]; otherwise, false. + + + + Gets or sets a value indicating whether [show XML errors]. + + true if [show XML errors]; otherwise, false. + + + + Gets or sets a value indicating whether [always merge empty namespace]. + + + true if [always merge empty namespace]; otherwise, false. + + + + + Specifies the structure of Dop2002. + + + + + Initializes a new instance of the class. + + The dop base. + + + + Parses the specified stream. + + The stream. + + + + Writes the specified stream. + + The stream. + + + + Gets or sets a value indicating whether [do not embed system font]. + + + true if [do not embed system font]; otherwise, false. + + + + + Gets or sets a value indicating whether [word compat]. + + true if [word compat]; otherwise, false. + + + + Gets or sets a value indicating whether [live recover]. + + true if [live recover]; otherwise, false. + + + + Gets or sets a value indicating whether [embed factoids]. + + true if [embed factoids]; otherwise, false. + + + + Gets or sets a value indicating whether [factoid XML]. + + true if [factoid XML]; otherwise, false. + + + + Gets or sets a value indicating whether [factoid all done]. + + true if [factoid all done]; otherwise, false. + + + + Gets or sets a value indicating whether [folio print]. + + true if [folio print]; otherwise, false. + + + + Gets or sets a value indicating whether [reverse folio]. + + true if [reverse folio]; otherwise, false. + + + + Gets or sets the text line ending. + + The text line ending. + + + + Gets or sets a value indicating whether [hide FCC]. + + true if [hide FCC]; otherwise, false. + + + + Gets or sets a value indicating whether [acetate show markup]. + + true if [acetate show markup]; otherwise, false. + + + + Gets or sets a value indicating whether [acetate show atn]. + + true if [acetate show atn]; otherwise, false. + + + + Gets or sets a value indicating whether [acetate show ins del]. + + true if [acetate show ins del]; otherwise, false. + + + + Gets or sets a value indicating whether [acetate show props]. + + true if [acetate show props]; otherwise, false. + + + + Gets or sets the istd table DFLT. + + The istd table DFLT. + + + + Gets or sets the ver compat. + + The ver compat. + + + + Gets or sets the GRF FMT filter. + + The GRF FMT filter. + + + + Gets or sets the I folio pages. + + The I folio pages. + + + + Gets or sets the CPG text. + + The CPG text. + + + + Gets or sets the cp min RM text. + + The cp min RM text. + + + + Gets or sets the cp min RM FTN. + + The cp min RM FTN. + + + + Gets or sets the cp min RM HDD. + + The cp min RM HDD. + + + + Gets or sets the cp min RM atn. + + The cp min RM atn. + + + + Gets or sets the cp min RM edn. + + The cp min RM edn. + + + + Gets or sets the cp min rm TXBX. + + The cp min rm TXBX. + + + + Gets or sets the cp min rm HDR TXBX. + + The cp min rm HDR TXBX. + + + + Specifies the structure of Dop2003. + + + + + Initializes a new instance of the class. + + The dop base. + + + + Parses the specified stream. + + The stream. + + + + Writes the specified stream. + + The stream. + + + + Gets or sets a value indicating whether [treat lock atn as read only]. + + + true if [treat lock atn as read only]; otherwise, false. + + + + + Gets or sets a value indicating whether [style lock]. + + true if [style lock]; otherwise, false. + + + + Gets or sets a value indicating whether [auto FMT override]. + + true if [auto FMT override]; otherwise, false. + + + + Gets or sets a value indicating whether [remove word ML]. + + true if [remove word ML]; otherwise, false. + + + + Gets or sets a value indicating whether [apply custom X form]. + + true if [apply custom X form]; otherwise, false. + + + + Gets or sets a value indicating whether [style lock enforced]. + + true if [style lock enforced]; otherwise, false. + + + + Gets or sets a value indicating whether [fake lock atn]. + + true if [fake lock atn]; otherwise, false. + + + + Gets or sets a value indicating whether [ignore mixed content]. + + true if [ignore mixed content]; otherwise, false. + + + + Gets or sets a value indicating whether [show placeholder text]. + + true if [show placeholder text]; otherwise, false. + + + + Gets or sets a value indicating whether [word97 doc]. + + true if [word97 doc]; otherwise, false. + + + + Gets or sets a value indicating whether [style lock theme]. + + true if [style lock theme]; otherwise, false. + + + + Gets or sets a value indicating whether [style lock QF set]. + + true if [style lock QF set]; otherwise, false. + + + + Gets or sets a value indicating whether [reading mode ink lock down]. + + + true if [reading mode ink lock down]; otherwise, false. + + + + + Gets or sets a value indicating whether [acetate show ink atn]. + + true if [acetate show ink atn]; otherwise, false. + + + + Gets or sets a value indicating whether [filter DTTM]. + + true if [filter DTTM]; otherwise, false. + + + + Gets or sets a value indicating whether [enforce doc prot]. + + true if [enforce doc prot]; otherwise, false. + + + + Gets or sets the doc prot cur. + + The doc prot cur. + + + + Gets or sets a value indicating whether to display background objects (displayBackgroundShape - Open xml property). + + true if display background objects; otherwise, false. + + + + Gets or sets the dxa page lock. + + The dxa page lock. + + + + Gets or sets the dya page lock. + + The dya page lock. + + + + Gets or sets the PCT font lock. + + The PCT font lock. + + + + Gets or sets the grfitbid. + + The grfitbid. + + + + Gets or sets the ilfo mac at cleanup. + + The ilfo mac at cleanup. + + + + Specifies the structure of Dop2007. + + + + + Initializes a new instance of the class. + + The dop base. + + + + Parses the specified stream. + + The stream. + + + + Writes the specified stream. + + The stream. + + + + Gets or sets a value indicating whether [RM track formatting]. + + true if [RM track formatting]; otherwise, false. + + + + Gets or sets a value indicating whether [RM track moves]. + + true if [RM track moves]; otherwise, false. + + + + Gets or sets the SSM. + + The SSM. + + + + Gets or sets a value indicating whether [reading mode ink lock down actual page]. + + + true if [reading mode ink lock down actual page]; otherwise, false. + + + + + Gets or sets a value indicating whether [auto compress pictures]. + + + true if [auto compress pictures]; otherwise, false. + + + + + Gets the dop math. + + The dop math. + + + + Specifies the structure of Asumyi. + + + + + Initializes a new instance of the class. + + + + + Parses the specified stream. + + The stream. + + + + Writes the specified stream. + + The stream. + + + + Gets or sets a value indicating whether this is valid. + + true if valid; otherwise, false. + + + + Gets or sets a value indicating whether this is view. + + true if view; otherwise, false. + + + + Gets or sets the view by. + + The view by. + + + + Gets or sets a value indicating whether [update props]. + + true if [update props]; otherwise, false. + + + + Gets or sets the W DLG level. + + The W DLG level. + + + + Gets or sets the L highest level. + + The L highest level. + + + + Gets or sets the L current level. + + The L current level. + + + + Specifies the structure of Dogrid. + + + + + Initializes a new instance of the class. + + + + + Parses the specified stream. + + The stream. + + + + Writes the specified stream. + + The stream. + + + + Gets or sets the xa grid. + + The xa grid. + + + + Gets or sets the ya grid. + + The ya grid. + + + + Gets or sets the dxa grid. + + The dxa grid. + + + + Gets or sets the dya grid. + + The dya grid. + + + + Gets or sets the dy grid display. + + The dy grid display. + + + + Gets or sets the dx grid display. + + The dx grid display. + + + + Gets or sets a value indicating whether [follow margins]. + + true if [follow margins]; otherwise, false. + + + + Specifies the structure of DopTypography. + + + + + Initializes a new instance of the class. + + + + + Parses the specified stream. + + The stream. + + + + Writes the specified stream. + + The stream. + + + + Gets or sets a value indicating whether [kerning punct]. + + true if [kerning punct]; otherwise, false. + + + + Gets or sets the justification. + + The justification. + + + + Gets or sets the level of kinsoku. + + The level of kinsoku. + + + + Gets or sets a value indicating whether this is print2on1. + + true if print2on1; otherwise, false. + + + + Gets or sets the custom ksu. + + The custom ksu. + + + + Gets or sets a value indicating whether [japanese use level2]. + + true if [japanese use level2]; otherwise, false. + + + + Gets or sets the CCH following punct. + + The CCH following punct. + + + + Gets or sets the CCH leading punct. + + The CCH leading punct. + + + + Gets or sets the RGXCH F punct. + + The RGXCH F punct. + + + + Gets or sets the RGXCH L punct. + + The RGXCH L punct. + + + + Specifies the structure of DopMth. + + + + + Initializes a new instance of the class. + + + + + Parses the specified stream. + + The stream. + + + + Writes the specified stream. + + The stream. + + + + Gets or sets the MTHBRK. + + The MTHBRK. + + + + Gets or sets the MTHBRK sub. + + The MTHBRK sub. + + + + Gets or sets the MTHBPJC. + + The MTHBPJC. + + + + Gets or sets a value indicating whether [math small frac]. + + true if [math small frac]; otherwise, false. + + + + Gets or sets a value indicating whether [math int lim und ovr]. + + true if [math int lim und ovr]; otherwise, false. + + + + Gets or sets a value indicating whether [math nary lim und ovr]. + + true if [math nary lim und ovr]; otherwise, false. + + + + Gets or sets a value indicating whether [math wrap align left]. + + true if [math wrap align left]; otherwise, false. + + + + Gets or sets a value indicating whether [math use disp defaults]. + + + true if [math use disp defaults]; otherwise, false. + + + + + Gets or sets the FTC math. + + The FTC math. + + + + Gets or sets the dxa left margin. + + The dxa left margin. + + + + Gets or sets the dxa right margin. + + The dxa right margin. + + + + Gets or sets the dxa indent wrapped. + + The dxa indent wrapped. + + + + Specifies the structure of Copts. + + + + + Initializes a new instance of the class. + + The dop base. + + + + Parses the specified stream. + + The stream. + + + + Writes the specified stream. + + The stream. + + + + Gets the copts80. + + The copts80. + + + + Gets or sets a value indicating whether [sp layout like W w8]. + + true if [sp layout like W w8]; otherwise, false. + + + + Gets or sets a value indicating whether [FTN layout like W w8]. + + true if [FTN layout like W w8]; otherwise, false. + + + + Gets or sets a value indicating whether [dont use HTML paragraph auto spacing]. + + + true if [dont use HTML paragraph auto spacing]; otherwise, false. + + + + + Gets or sets a value indicating whether [dont adjust line height in table]. + + + true if [dont adjust line height in table]; otherwise, false. + + + + + Gets or sets a value indicating whether [forget last tab align]. + + true if [forget last tab align]; otherwise, false. + + + + Gets or sets a value indicating whether [use autospace for full width alpha]. + + + true if [use autospace for full width alpha]; otherwise, false. + + + + + Gets or sets a value indicating whether [align tables row by row]. + + + true if [align tables row by row]; otherwise, false. + + + + + Gets or sets a value indicating whether [layout raw table width]. + + + true if [layout raw table width]; otherwise, false. + + + + + Gets or sets a value indicating whether [layout table rows apart]. + + + true if [layout table rows apart]; otherwise, false. + + + + + Gets or sets a value indicating whether [use word97 line breaking rules]. + + + true if [use word97 line breaking rules]; otherwise, false. + + + + + Gets or sets a value indicating whether [dont break wrapped tables]. + + + true if [dont break wrapped tables]; otherwise, false. + + + + + Gets or sets a value indicating whether [dont snap to grid in cell]. + + + true if [dont snap to grid in cell]; otherwise, false. + + + + + Gets or sets a value indicating whether [dont allow field end select]. + + + true if [dont allow field end select]; otherwise, false. + + + + + Gets or sets a value indicating whether [apply breaking rules]. + + true if [apply breaking rules]; otherwise, false. + + + + Gets or sets a value indicating whether [dont wrap text with punct]. + + + true if [dont wrap text with punct]; otherwise, false. + + + + + Gets or sets a value indicating whether [dont use asian break rules]. + + + true if [dont use asian break rules]; otherwise, false. + + + + + Gets or sets a value indicating whether [use word2002 table style rules]. + + + true if [use word2002 table style rules]; otherwise, false. + + + + + Gets or sets a value indicating whether [grow auto fit]. + + true if [grow auto fit]; otherwise, false. + + + + Gets or sets a value indicating whether [use normal style for list].Consider only in word 2007 and later versions + + + true if [use normal style for list]; otherwise, false. + + + + + Gets or sets a value indicating whether [dont use indent as numbering tab stop].Consider only in word 2007 and later versions + + + true if [dont use indent as numbering tab stop]; otherwise, false. + + + + + Gets or sets a value indicating whether [FE line break11].Consider only in word 2007 and later versions + + true if [FE line break11]; otherwise, false. + + + + Gets or sets a value indicating whether [allow space of same style in table].Consider only in word 2007 and later versions + + + true if [allow space of same style in table]; otherwise, false. + + + + + Gets or sets a value indicating whether [W W11 indent rules].Consider only in word 2007 and later versions + + true if [W W11 indent rules]; otherwise, false. + + + + Gets or sets a value indicating whether [dont autofit constrained tables].Consider only in word 2007 and later versions + + + true if [dont autofit constrained tables]; otherwise, false. + + + + + Gets or sets a value indicating whether [autofit like W W11].Consider only in word 2007 and later versions + + true if [autofit like W W11]; otherwise, false. + + + + Gets or sets a value indicating whether [underline tab in num list].Consider only in word 2007 and later versions + + + true if [underline tab in num list]; otherwise, false. + + + + + Gets or sets a value indicating whether [hangul width like W W11].Consider only in word 2007 and later versions + + + true if [hangul width like W W11]; otherwise, false. + + + + + Gets or sets a value indicating whether [split pg break and para mark].Consider only in word 2007 and later versions + + + true if [split pg break and para mark]; otherwise, false. + + + + + Gets or sets a value indicating whether [dont vert align cell with sp].Consider only in word 2007 and later versions + + + true if [dont vert align cell with sp]; otherwise, false. + + + + + Gets or sets a value indicating whether [dont break constrained forced tables].Consider only in word 2007 and later versions + + + true if [dont break constrained forced tables]; otherwise, false. + + + + + Gets or sets a value indicating whether [dont vert align in TXBX].Consider only in word 2007 and later versions + + + true if [dont vert align in TXBX]; otherwise, false. + + + + + Gets or sets a value indicating whether [word11 kerning pairs].Consider only in word 2007 and later versions + + true if [word11 kerning pairs]; otherwise, false. + + + + Gets or sets a value indicating whether [cached col balance].Consider only in word 2007 and later versions + + true if [cached col balance]; otherwise, false. + + + + Specifies the structure of Copts80. + + + + + Initializes a new instance of the class. + + The dop base. + + + + Parses the specified stream. + + The stream. + + + + Writes the specified stream. + + The stream. + + + + Gets the copts60. + + The copts60. + + + + Gets or sets a value indicating whether [suppress top spacing mac5]. + + + true if [suppress top spacing mac5]; otherwise, false. + + + + + Gets or sets a value indicating whether [trunc dxa expand]. + + true if [trunc dxa expand]; otherwise, false. + + + + Gets or sets a value indicating whether [print body before HDR]. + + true if [print body before HDR]; otherwise, false. + + + + Gets or sets a value indicating whether [no ext leading]. + + true if [no ext leading]; otherwise, false. + + + + Gets or sets a value indicating whether [dont make space for UL]. + + + true if [dont make space for UL]; otherwise, false. + + + + + Gets or sets a value indicating whether [MW small caps]. + + true if [MW small caps]; otherwise, false. + + + + Gets or sets a value indicating whether [F2PT ext leading only]. + + true if [F2PT ext leading only]; otherwise, false. + + + + Gets or sets a value indicating whether [trunc font height]. + + true if [trunc font height]; otherwise, false. + + + + Gets or sets a value indicating whether [sub on size]. + + true if [sub on size]; otherwise, false. + + + + Gets or sets a value indicating whether [line wrap like word6]. + + true if [line wrap like word6]; otherwise, false. + + + + Gets or sets a value indicating whether [W w6 border rules]. + + true if [W w6 border rules]; otherwise, false. + + + + Gets or sets a value indicating whether [exact on top]. + + true if [exact on top]; otherwise, false. + + + + Gets or sets a value indicating whether [extra after]. + + true if [extra after]; otherwise, false. + + + + Gets or sets a value indicating whether [WP space]. + + true if [WP space]; otherwise, false. + + + + Gets or sets a value indicating whether [WP just]. + + true if [WP just]; otherwise, false. + + + + Gets or sets a value indicating whether [print met]. + + true if [print met]; otherwise, false. + + + + Specifies the structure of Copts60. + + + + + Initializes a new instance of the class. + + The dop base. + + + + Parses the specified stream. + + The stream. + + + + Writes the specified stream. + + The stream. + + + + Gets or sets a value indicating whether [no tab for ind]. + + true if [no tab for ind]; otherwise, false. + + + + Gets or sets a value indicating whether [no space raise lower]. + + true if [no space raise lower]; otherwise, false. + + + + Gets or sets a value indicating whether [suppress sp bf after pg BRK]. + + + true if [suppress sp bf after pg BRK]; otherwise, false. + + + + + Gets or sets a value indicating whether [wrap trail spaces]. + + true if [wrap trail spaces]; otherwise, false. + + + + Gets or sets a value indicating whether [map print text color]. + + true if [map print text color]; otherwise, false. + + + + Gets or sets a value indicating whether [no column balance]. + + true if [no column balance]; otherwise, false. + + + + Gets or sets a value indicating whether [conv mail merge esc]. + + true if [conv mail merge esc]; otherwise, false. + + + + Gets or sets a value indicating whether [suppress top spacing]. + + true if [suppress top spacing]; otherwise, false. + + + + Gets or sets a value indicating whether [orig word table rules]. + + true if [orig word table rules]; otherwise, false. + + + + Gets or sets a value indicating whether [show breaks in frames]. + + true if [show breaks in frames]; otherwise, false. + + + + Gets or sets a value indicating whether [swap borders facing PGS]. + + + true if [swap borders facing PGS]; otherwise, false. + + + + + Gets or sets a value indicating whether [leave backslash alone]. + + true if [leave backslash alone]; otherwise, false. + + + + Gets or sets a value indicating whether [exp sh RTN]. + + true if [exp sh RTN]; otherwise, false. + + + + Gets or sets a value indicating whether [DNT UL TRL SPC]. + + true if [DNT UL TRL SPC]; otherwise, false. + + + + Gets or sets a value indicating whether [DNT BLN sb db wid]. + + true if [DNT BLN sb db wid]; otherwise, false. + + + + Summary description for FieldDescriptor. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Clone field + + + + + + + + + + + + Write FieldDescriptor to stream + + + + + + + + + + + + + + + + + + + + + Gets or sets a value indicating whether field result is locked or not. + + + True if the field result should not be recalculated; otherwise, false. + + + + + + + + + + + + + + + + + + + + Summary description for Fields. + + + + + + + + + + + + + + + + + + + + + + Default constructor + + + + + + + + + + + + + Gets fields for subdocument. + + + + + + + Writes the specified stream. + + The stream. + The end position. + The sub document. + + + + Closes this instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Writes the fields for sub document. + + The st list. + The stream. + The end position. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for FieldTypeDefiner. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the type STR table. + + The type STR table. + + + + Font family name record. + Note that just as for a pascal-style string, the first byte in the + FFN records the total number of bytes not counting the count byte + itself. + The names of the fonts correspond to the ftc codes in the + CHP structure. For example, the first font name listed corresponds + is the name for ftc = 0 + + + + + Maximal length of string that represent font names. + + + + + Bits masks and offsets for FFNBaseStructure.Options property. + + + + + FFN base structure. + + + + + The font name. + + + + + The alternative font name. + + + + + Default constructor. + + + + + Exstract record data from specified byte array. + + Data to parse. + Offset in the data array to the records data. + Number of bytes to parse. + + + + Save record data in array of bytes. + + Array of bytes to save record into. + Offset in the array. + Number of bytes in the written data. + + + + Closes this instance. + + + + + Underlying structure ( used in BaseWordRecord for fast copy data + to special structure ) + + + + + Length of ffn minus 1. + + + + + Length of record. + + + + + Gets or sets pitch request. + + + + + Check whether the subsetted attribute is present + + + + + Gets or sets TrueType flag for font. + + + + + Gets or sets font family id. + + + + + Gets or sets base weight of font. + + + + + Get/set font signature of Unicode Subset Bitfields 0 + + + + + Get/set font signature of Unicode Subset Bitfields 1 + + + + + Get/set font signature of Unicode Subset Bitfields 2 + + + + + Get/set font signature of Unicode Subset Bitfields 3 + + + + + Get/set font signature of Code Page Bitfields 0 + + + + + Get/set font signature of Code Page Bitfields 1 + + + + + Gets or sets character set identifier. + + + + + Gets or sets font name. + Summary font name and alternate font name length can not be large 65 bytes. + + + + + Gets/Sets alternative font name. + + + + + Gets/Sets Embed fonts stream (.odttf files) + + + + + Summary description for FontFamilyNameTable. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Parses record. + + Data to parse. + Offset in the data array to the records data. + Number of bytes to parse. + + + + Saves record into array of bytes. + + Array of bytes to save record into. + Offset in the array. + Number of bytes in the written data. + + + + Closes this instance. + + + + + + + + + + + + + + + Array of FontFamilyRecord objects. + + + + + Summary description for FormField. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets field type. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for LineSpacingDescriptor. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + The lsid. + if it is hybrid, set to true. + if it is simple list, set to true. + + + + + + + + + + Closes this instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets ListLevels object + + + + + Gets/sets list name + + + + + True if restart heading + + + + + True if it is simplelist + + + + + Gets a value indicating whether this instance is hybrid multilevel. + + + if this instance is hybrid multilevel, set to true. + + + + + Gets/sets list identifier. + + + + + + + + + + + + + + + + + + + + + + + + + + Closes this instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets arraylist of ListFormatOverrride levels + + + + + Gets/sets list identifier. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Default list id + + + + + Strings for bulleted lists + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Reads lists' names + + + + + + + + + + + + + + + + + + + + + + + Writes lists' names + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Closes this instance. + + + + + + + + + + + + + + + + + + + + + Gets ListFormatOverrides object + + + + + Gets ListFormats object + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Reads list's character or paragraph properties. + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + + + + + + Summary description for ListFormat. + + + + + + + + + + Key = override list style name, value = override list index. + + + + + Key = list style name, value = list index. + + + + + + + + + + + + Closes this instance. + + + + + Update the ParagraphPropertyException for current Writer ListProperties + + + + + + Continue current list + + + + + Applies the list. + + The list data. + The list format. + The style sheet. + if it is apply to pap, set to true. + + + + + + + + + + + + + + + + + + + + + + + + Summary description for ParagraphPropertyException. + + + + + Style id. + + + + + + + + + Default constructor. + + + + + Creates new record from stream. + + Stream with record's data. + Number of bytes to parse. + if set to true [is huge papx]. + + + + + + + + + + + Closes this instance. + + + + + Parses record. + + Data to parse. + Offset in the data array to the records data. + Number of bytes to parse. + + + + Saves the specified stream. + + The stream. + Number of bytes in the written data. + + + + + + + + + + + + Returns object with cloned members + + + + + Gets or sets a value indicating whether [m_is huge papx]. + + + true if [m_is huge papx]; otherwise, false. + + + + + Gets / sets StyleId. + + + + + A list of the sprms (Single PRoperty modifier) that encode + the differences between CHP (CHaracter property) for a run + of text and the CHP generated by the paragraph and character + styles that tag the run. + + + + + Returns number of property modifiers. Read-only. + + + + + + + + + + + + + + + Default constructor. + + + + + Default constructor. + + + + + Extracts structure from the array of bytes. + + Array of bytes with structure's data. + Offset to the structure's data start. + + Offset after structure's data end. + + + + Saves record into array of bytes. + + Array of bytes to save record into. + Offset in the array. + Number of bytes in the written data. + + + + + + + + + + + + + + + + + + + + + + The PHE is a substructure of the PAP and the PAPX FKP + and is also stored in the PLCFPHE. + + + + + Index of the bit of spare flag. + + + + + Index of the bit of validness bit. + + + + + Index of the bit for IsDifferentLines property. + + + + + Index of byte for lines count property. + + + + + Mask for NextRowHint property. + + + + + Start bit for NextRowHint property. + + + + + Size of the record in bytes. + + + + + Underlying structure. + + + + + Default constructor. + + + + + Initializes a new instance of the class. + + The arr data. + + + + Initializes a new instance of the class. + + The stream. + + + + Parses the specified data array. + + The data array. + The offset. + + + + Saves the structure. + + The destination data array. + The offset. + + + + + Reserved (fSpare). + + + + + Indicates whether this structure is valid (fUnk). + + + + + If this property is set to True then total height of paragraph is known + but lines in paragraph have different heights (fDiffLines). + + + + + When fDiffLines is 0 is number of lines in paragraph (clMac). + + + + + Width of lines in paragraph (dxaCol). + + + + + when IsDiffLines is 0, is height of every line in paragraph in pixels + when IsDiffLines is 1, is the total height in pixels of the paragraph + + If the PHE is stored in a PAP whose fTtp field is set (non-zero), + height of table row (dymLine / dymHeight / dymTableHeight). + + + + + If not == 0, used as a hint when finding the next row (dcpTtpNext). + + + + + Gets underlying structure. Read-only. + + + + + + + + + + Summary description for FKPForCharacterProperties = ParagraphPropertiesPage. + + + + + Size of the FC (File Character position). + + + + + Each FC is the limit FC of a run of exception text. + + + + + An array of the BX data structure. The ith BX entry in the array describes + the paragraph beginneing at fkp.rgfc[ i ]. + + + + + Consists of all of the CHPXs stored in FKP concatenated end to end. + Each CHPX is prefixed with a count of bytes which records its length. + + + + + + + + + + + + + + + + + Closes this instance. + + + + + + + + + + + + + + + + + + Saves record into array of bytes. + + Array of bytes to save record into. + Offset in the array. + Number of bytes in the written data. + + + + Each FC is the limit FC of a run of exception text. + + + + + An array of the BX data structure. The ith BX entry in the array describes + the paragraph beginneing at fkp.rgfc[ i ]. + + + + + + + + + + Count of runs. + + + + + + + + + + Summary description for PICF. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Clones current PictureDescriptor. + + + + + + + + + + + + + + + Compare the properties of PICF + + + True, if all the properties matches, else false + + + + Gets the PICF text for Word comparison + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the border top. + + The border top. + + + + Gets the border left. + + The border left. + + + + Gets the border right. + + The border right. + + + + Gets the border bottom. + + The border bottom. + + + + + + + + + Size of the record in bytes. + + + + + Underlying structure. + + + + + Default constructor. + + + + + Parses record. + + Data to parse. + + + + Parses record. + + Data to parse. + Offset in the data array to the records data. + + + + when 1, means that piece contains no end of paragraph marks. + + + + + used internally by Word + + + + + used internally by Word + + + + + file offset of beginning of piece. The size of the ith piece can be determined by subtracting rgcp[i] of the containing plcfpcd from its rgcp[i+1]. + + + + + contains either a single sprm or else an index number of the grpprl which contains the sprms that modify the properties of the piece. + + + + + Returns underlying structure. Read-only. + + + + + + + + + + Summary description for BinaryTable. + + + + + Array of file positions (n+1). + + + + + Array of talbe entries (n). + + + + + Default constructor. + + + + + + + + + + + + Closes this instance. + + + + + + + + + + + + + + + + + + + + + Returns array of character positions. Read-only. + + + + + Returns array of binary table entries. Read-only. + + + + + + + + + + + + + + + Summary description for PosStructReader. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for ReferencePositionTable. + + + + + Locations of footnote references within the main text address space. + + + + + Reference numbers. + + + + + Default constructor. + + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + MemoryConverter to convert array of bytes into structure. + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + Offset to the class data. + MemoryConverter to convert array of bytes into structure. + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + Offset to the class data. + Number of bytes for the new record. + + + + Creates new record from stream. + + Stream with record's data. + Number of bytes to parse. + + + + Parses record. + + Data to parse. + Offset in the data array to the records data. + Number of bytes to parse. + MemoryConverter to convert array of bytes into structure. + + + + Gets locations of footnote references within the main text + address space. Read-only. + + + + + Gets reference numbers. Read-only. + + + + + + + + + + Summary description for SectionDescriptor. + + + + + Size of the record. + + + + + Underlying structure. + + + + + Default constructor. + + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + MemoryConverter to convert array of bytes into structure. + + + + + + + + + + + + Parses record. + + Data to parse. + Offset in the data array to the records data. + Number of bytes to parse. + + + + used internally by Word (fn). + + + + + used internally by Word (fnMpr). + + + + + File offset in main stream to beginning of SEPX stored for section. + If sed.fcSepx == 0xFFFFFFFF, the section properties for the section are equal + to the standard SEP (see SEP definition). + + + + + Points to offset in FC space of main stream where the Macintosh Print Record + for a document created on a Mac will be stored. + + + + + Returns underlying class or structure. + + + + + + + + + + Summary description for SectionExceptionsTable. + + + + + The boundaries (character positions) of sections in the Word document. + + + + + 1-to-1 correspondence to the array of CPs. + Each SED stores the beginning FC of the SEPX that records the properties + for a section. If the FC stored in a SED is -1, the section properties of + the section are exactly equal to the standard section properties. + + + + + Default constructor. + + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + MemoryConverter to convert array of bytes into structure. + + + + + + + + + Closes this instance. + + + + + Parses the specified data. + + The data. + The offset. + The count. + + + + Saves record into array of bytes. + + Array of bytes to save record into. + Offset in the array. + Number of bytes in the written data. + + + + The boundaries (character positions) of sections in the Word document. + + + + + 1-to-1 correspondence to the array of CPs. + Each SED stores the beginning FC of the SEPX that records the properties + for a section. If the FC stored in a SED is -1, the section properties of + the section are exactly equal to the standard section properties. + + + + + + + + + + Number of elements in the collection. + + + + + Summary description for SectionProperties. + + + + + + + + + + + + + + + Default constructor + + + + + Initializing constructor + + + + + Returns object with cloned members + + + + + + + + + + + + + + + + + + + + + + + + + + Copy paragraph properties or not + + + + + + + + + + Gets/sets the space between the header and the top of the page. + + + + + Gets/sets the space between the footer and the bottom of the page. + + + + + Gets/sets whether a title page is to be displayed + + + + + Gets / sets break code + + + + + Gets / sets text direction + + + + + + + + + + + + + + + Gets/sets the distance between the bottom edge of the page and + the bottom boundary of the text. + + + + + Gets/sets the distance between the top edge of the page and + the top boundary of the text. + + + + + Gets/sets the distance between the left edge of the page and + the left boundary of the text. + + + + + Gets/sets the distance between the right edge of the page and + the right boundary of the text. + + + + + Orientation of pages in that section. Set page size firstly! + Set to 0 - when portrait, 2 - when landscape + + + + + Gets/sets the height of the page in twips. + + + + + Gets/sets the width of the page in twips. + + + + + Gets/sets the bin in which the first page of the section will be printed + + + + + Gets/sets the bin in which the other pages of the section will be printed + + + + + Vertical justification code + 0 top justified + 1 centered + 2 fully justified vertically + 3 bottom justified + + + + + Gets/sets the size of the page gutter. + + + + + Gets / sets whether section contains right-to-left text. + + + + + + + + + + Gets or sets the value page start at. + + The page start at. + + + + Gets or sets a value indicating whether to restart page. + + if page restart, set to true. + + + + Gets or sets the line pitch. + + The line pitch. + + + + Gets or sets the type of the pitch. + + The type of the pitch. + + + + Gets or sets a value indicating whether to draw lines between columns. + + + if draw lines between columns, set to true. + + + + + Gets or sets a value indicating whether [form protect]. + + true if [form protect]; otherwise, false. + + + + Gets or sets a value indicating sprmSWall + + + if draw lines between columns, set to true. + + + + + Gets or sets a value indicating [Chapter numbering seprator in page number]. + + + Chapter Page Separator + + + + + Gets or sets a value indicating [Chapter numbering level in page number]. + + + Chapter Heading Level + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets / sets endnote numbering format + + + + + Gets / sets footnote numbering format + + + + + Gets / sets the restart index for endnote + + + + + Gets / sets the restart index for footnotes + + + + + Gets / sets footnote position in the document + + + + + Gets / sets the initial footnote number + + + + + Gets / sets the initial endnote number + + + + + Summary description for SectionPropertyException. + + + + + List of sprms that encodes the differences between the properties of + a section and Word's default section properties. + + + + + Default constructor. + + + + + Creates instance and sets the default section properties + + If true, loads the default section properties. + + + + Creates instance and gets data from the stream. + + Stream with new instance data. + MemoryConverter for structures convertions. + + + + Closes this instance. + + + + + Extracts instance from the stream. + + Stream with data. + MemoryConverter for structures convertions. + + + + Saves record into array of bytes. + + Array of bytes to save record into. + Offset in the array. + Number of bytes in the written data. + + + + + + + + + Number of property modifiers. + + + + + + + + + + + + + + + + + + + + + + + + + Gets / sets break code + + + + + Gets / sets columns count + + + + + Summary description for ShadingDescriptor. + + + + + + + + + + Initializing constructor + + + + + + Default constructor + + + + + Clones the ShadingDescriptor instance. + + + + + + + + + + + + Returns non-parsed structure as short value + + + + + + + + + + + + + Returns non-parsed structure as short value + + + + + + Gets/sets foreground color + + + + + Gets/sets background color + + + + + Gets/sets pattern + + + + + + + + + + Summary description for SinglePropertyModifierArray. + + + + + List of single property modifiers. + + + + + Default constructor. + + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + MemoryConverter to convert array of bytes into structure. + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + Offset to the class data. + MemoryConverter to convert array of bytes into structure. + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + Offset to the class data. + Number of bytes for the new record. + MemoryConverter to convert array of bytes into structure. + + + + Creates new record from stream. + + Stream with record's data. + Number of bytes to parse. + MemoryConverter to convert array of bytes into structure. + + + + Remove modifier from collection + + + + + + Parses record. + + Data to parse. + Offset in the data array to the records data. + Number of bytes to parse. + + + + Check the duplicate sprm in single propety modifier array collection + + Current single property modifier array record + + + + Determines whether sprm is correct. + + The Single Property Modifier Record. + + true if sprm is correct; otherwise, false. + + + + + Checks for valid Character Property sprm + + + + true if sprm is correct; otherwise, false. + + + + + Checks for valid paragraph Property sprm + + + + true if sprm is correct; otherwise, false. + + + + + Checks for valid Table Property sprm + + + + true if sprm is correct; otherwise, false. + + + + + Checks for valid Section Property sprm + + + + true if sprm is correct; otherwise, false. + + + + + Checks for valid Picture Property sprm + + + + true if sprm is correct; otherwise, false. + + + + + Saves record into array of bytes. + + Array of bytes to save record into. + Offset in the array. + Number of bytes in the written data. + + + + + + + + + + + + + + + + + + + + + Removes all modifiers from the collection. + + + + + Adds new modifier to the collection. + + Modifier to add. + + + + Sort Sprms based on Unique ID + + + + + Check whether the Sprms contain TrackChanges SPRMs + + + + + + Adds new modifier to the collection. + + Modifier to add. + + + + + Adds new modifier to the collection. + + Modifier to add. + + + + + + + + + + + + + + + + + + + + + Returns true if sprm present + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Clones this instance. + + + + + + Closes this instance. + + + + + + + + + + + + + + + + + + + + + + + + + Gets the sprm by index. + + Index of the SPRM. + + + + + Contains the specified option. + + The option. + + + + + Returns corresponding sprm if it + + Options + + + + + Gets the new (added when track changes property is on) Single Property Modifier Record. + + The option. + + + + + Gets the index of the new (changed) paragraph properties. + + + + + Gets the old sprm from the sprms collection + + + + + + + + List of single property modifiers. Read-only. + + + + + Indexer by sprm options. + + + + + Returns number of elements in the array. Read-only. + + + + + + + + + + + + + + + + + + + + + + + + + Parent collection. + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for SprmRecord. + + + + + 0-8 bits. + + + + + Start bit for unique id bit mask. + + + + + Bit index for special handling value. + + + + + Mask for type of sprm. + + + + + + + + + + Mask for operand size. + + + + + Start non-zero bit in operand size mask. + + + + + Mask for ushort value. + + + + + Header options of the sprm. + + + + + Length of the operand. + + + + + + + + + + Sprm length. + + + + + + + + + + + + + + + + + + + + + + + Extracts SPRM structure from array of bytes. + + Array of bytes that contains SPRM. + Offset of SPRM in the array of bytes. + Offset in arrBuffer after SPRM. + + + + Extracts SPRM structure from stream. + + Stream with sprm data. + MemoryConverter to convert memory block into structure. + + + + Saves record into array of bytes. + + Array of bytes to save record into. + Offset in the array. + Number of bytes in the written data. + + + + + + + + + + + + + + + + + + Converts WordSprmOperandSize to number of bytes needed to be read from stream. + + Size of the operand. + Number of bytes needed to be read from stream. + + + + + + + + + + + + + + + + + + + + + + + Unique identifier within sgc group. + + + + + Indicates whether sprm needs special handling. + + + + + Type of sprm. + + + + + Size of the operand. + + + + + Size of the operand in bytes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Header options of the sprm. + + + + + Header options of the sprm. + + + + + + + + + + + + + + + Summary description for Spacings. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Clone cell spacing + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for StringTableRecord. + + + + + Default constructor. + + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + MemoryConverter to convert array of bytes into structure. + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + Offset to the class data. + MemoryConverter to convert array of bytes into structure. + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + Offset to the class data. + Number of bytes for the new record. + + + + Creates new record from stream. + + Stream with record's data. + Number of bytes to parse. + + + + Parses record. + + Data to parse. + Offset in the data array to the records data. + Number of bytes to parse. + + + + Summary description for BinTableEntry. + + + + + Record size in bytes. + + + + + Binary table entry value. + + + + + Parses the specified data array. + + The arr data. + The i offset. + + + + + Saves the structure to data array. + + The arr data. + The i offset. + + + + Binary table entry value. + + + + + Summary description for BookmarkFirstStructure. + + + + + + + + + + + + + + + + + + + + Saves bookmark positions. + + + + + + Saves bookmark properties. + + + + + + + + + + + + + + + + + + + + + Summary description for Border Structure. + + + + + width of a single line in 1/8 pt, max of 32 pt. + + + + + border type code: + + + + + color code + + + + + :5 1F00 width of space to maintain between border and text within border. + Must be 0 when BRC is a substructure of TC. Stored in points. + :1 2000 when 1, border is drawn with shadow. Must be 0 when BRC is a substructure of the TC + + + + + Initializes a new instance of the class. + + The arr. + The i offset. + + + + Initializes a new instance of the class. + + + + + Clones the BorderStructure instance. + + + + + + Parse byte array to BorderCode structure + + + + + + + Saves the specified arr. + + The arr. + The i offset. + + + + Width of a Line + + + + + Border type code + + + + + Width of space to maintain between border and text within border + + + + + when true, border is drawn with shadow + + + + + Gets or sets the color of the line. + + The color of the line. + + + + Gets a value indicating whether this instance is clear. + + if this instance is clear, set to true. + + + + + + + + + Gets the size of the structure. + + The length. + + + + BreaK Descriptor (BKD). + + + + + except in textbox BKD, index to PGD in plfpgd that describes the page this break is on. + + + + + in textbox BKD, + + + + + number of cp's considered for this break; note that the CP's described by cpDepend in this break reside in the next BKD + + + + + + + + + + Option flags. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the specified arr. + + The arr. + The offset. + + + + + Gets the size of the structure. + + The length. + + + + Summary description for BXStructure. + + + + + Size of the record. + + + + + Word offset of the PAPX (PAragraph Property eXception ) recorded + for the paragraph corresponding to the BX. + + + + + PHE structure which stores the current paragraph height for + the paragraph corresponding to the BX. + + + + + Default constructor. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Saves the specified writer. + + The writer. + + + + Word offset of the PAPX (PAragraph Property eXception ) recorded + for the paragraph corresponding to the BX. + + + + + + + + + + Gets the size of the structure. + + The length. + + + + Base structure for FontFamilyNameRecord. + + + + + + + + + + Total length of FFN - 1. + + [ FieldOffset( 0 ) ] + + + + Option flags. + + 2bits - pitch request + 1bit - when 1, font is a TrueType font + 1bit - reserved + 3bits - font family id + 1bit - reserved + + + [ FieldOffset( 1 ) ] + + + + Base weight of font. + + [ FieldOffset( 2 ) ] + + + + Character set identifier. + + [ FieldOffset( 4 ) ] + + + + Index into ffn.szFfn to the name of the alternate font. + + [ FieldOffset( 5 ) ] + + + + "Magic" data. + + { 0x2, 0x2, 0x6, 0x3, 0x5, 0x4, 0x5, 0x2, 0x3, 0x4 } + + + + + + "Magic" data. + + m_FONTSIGNATURE[ 0 ] = 0x87; + m_FONTSIGNATURE[ 1 ] = 0x7a; + ... + m_FONTSIGNATURE[ 3 ] = 0x20; + ... + m_FONTSIGNATURE[ 7 ] = 0x80; + m_FONTSIGNATURE[ 8 ] = 0x8; + ... + m_FONTSIGNATURE[ 16 ] = 0xff; + m_FONTSIGNATURE[ 17 ] = 0x1; + + + + + + Closes this instance. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + + + + Total length of FFN - 1. + + + + + Option flags. + + 2bits - pitch request + 1bit - when 1, font is a TrueType font + 1bit - reserved + 3bits - font family id + 1bit - reserved + + + + + + Base weight of font. + + + + + Character set identifier. + + + + + Index into ffn.szFfn to the name of the alternate font. + + + + + Length of record. + + The length. + + + + Formatted disK Page - 512 bytes + + + + + Size of the record. + + + + + Page data. + + + + + Count of elements in the array. + + + + + Default constructor. + + + + + + + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + + + + + + + + Closes this instance. + + + + + Page data. + + + + + Count of elements. + + + + + Gets the size of the structure. + + The length. + + + + Summary description for ParagraphHeightStructure. + + + + + Options. + + + + + Width of lines in paragraph. + + + + + when IsDiffLines is 0, is height of every line in paragraph in pixels + when IsDiffLines is 1, is the total height in pixels of the paragraph + + If the PHE is stored in a PAP whose fTtp field is set (non-zero), + height of table row + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + + + + + + + + + + + + + + + + + + + Options + + + + + file offset of beginning of piece. The size of the ith piece can be determined by subtracting rgcp[i] of the containing plcfpcd from its rgcp[i+1]. + + + + + contains either a single Single Property Modifier Record or else an index number of the grpprl which contains the sprms that modify the properties of the piece. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + Destination data array + The offset. + + + + Options. + + + + + File offset of beginning of piece.The size of the ith piece can be determined + by subtracting rgcp[i] of the containing plcfpcd from its rgcp[i+1]. + + + + + Contains either a single Single Property Modifier Record or else an index number of the grpprl + which contains the sprms that modify the properties of the piece. + + + + + + + + + + Summary description for PropertyModifierStructure. + + + + + Bit index for IsComplex value. + + + + + Size of the record in bytes; + + + + + Options. + + + + + + + + + + + + Saves structure to specified data array. + + The array with data. + The offset. + + + + + + + + + + + + + + Summary description for SectionDescriptorStructure. + + + + + used internally by Word (fn). + + + + + file offset in main stream to beginning of SEPX stored for section. + If sed.fcSepx == 0xFFFFFFFF, the section properties for the section are equal + to the standard SEP (see SEP definition). + + + + + used internally by Word (fnMpr). + + + + + Points to offset in FC space of main stream where the Macintosh Print Record + for a document created on a Mac will be stored. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + + + + used internally by Word (fn). + + + + + used internally by Word (fnMpr). + + + + + file offset in main stream to beginning of SEPX stored for section. + If sed.fcSepx == 0xFFFFFFFF, the section properties for the section are equal + to the standard SEP (see SEP definition). + + + + + Points to offset in FC space of main stream where the Macintosh Print Record + for a document created on a Mac will be stored. + + + + + Gets the size of the structure. + + The length. + + + + Base part of StyleDefinition. + + + + + Number of bytes in the record. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Option flags. + + + + + Option flags. + + + + + Option flags. + + + + + Offset to end of upx's, start of upe's (bchUpe). + + + + + Option flags. + + + + + Option flags (contain info about links) + + + + + Resets all fields. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + + + + Invariant style identifier. + + + + + Spare field for any temporary use, always reset back to zero! + + + + + PHEs of all text with this style are wrong. + + + + + Indicates whether UPEs have been generated. + + + + + std has been mass-copied; if unused at save time, style should be deleted. + + + + + Style type code. + + + + + Base style. + + + + + + + + + + Number of UPXs (and UPEs). + + + + + Next style. + + + + + Auto redefine style when appropriate + + + + + Indicates whether style is hidden from UI. + + + + + + + + + + Gets or sets the link style id. + + The link style id. + + + + Indicates whether style is hidden from UI. + + + + + Indicates whether style is hidden from UI. + + + + + Indicates whether style is hidden from UI. + + + + + STSHI: STyleSHeet Information, as stored in a file + Note that new fields can be added to the STSHI without invalidating + the file format, because it is stored preceded by it's length. + When reading a STSHI from an older version, new fields will be zero. + + + + + Bit index for StdStyleNamesWritten property. + + + + + + + + + + Count of styles in stylesheet (cstd). + + + + + Length of STD Base as stored in a file. + + + + + Option flags. + + + + + Max sti known when this file was written (StiMaxWhenSaved). + This indicates the last built-in style known to the version of Word + that saved this file. + + + + + How many fixed-index istds are there? + + + + + Current version of built-in stylenames (nVerBuiltInNamesWhenSaved). + + + + + ftc used by StandardChpStsh for this document (rgftcStandardChpStsh). + + + + + Represents the sprmCFtcBi for default document formatting + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the specifies structure. + + The arr data. + The offset. + + + + Count of styles in stylesheet (cstd). + + + + + Length of STD Base as stored in a file (cbSTDBaseInFile). + + + + + Indicates whether built-in stylenames are stored. + + + + + Max sti known when this file was written. + + + + + How many fixed-index istds are there? + + + + + Current version of built-in stylenames (nVerBuiltInNamesWhenSaved). + + + + + ftc used by StandardChpStsh for this document. Read-only. + + + + + Gets and sets the default Bidi font + + + + + + + + + + Summary description for _Constants. + + + + + Size of the File Character position. + + + + + Number of bytes in single word value. + + + + + Number of bytes in single int value. + + + + + Number of bytes in formatted disk page. + + + + + Number of bytes in single long value. + + + + + To prevent creating instances of this class constructor was made private. + + + + + Base part of StyleDefinition. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Base part of the style definition. + + + + + Names of the styles + + + + + Names of the aliases styles (comma separated). + + + + + + + + + + + + + + + + + + + + Closes this instance. + + + + + Extract record's fields from stream. + + Stream with record's data. + Number of bytes that belongs the record. + MemoryConverter to convert array of bytes into structure. + Style sheet info. + + + + + + + + + Saves record into stream. + + Stream to save record into. + Number of bytes in the written data. + + + + Default constructor. + + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + Offset to the class data. + Number of bytes for the new record. + MemoryConverter to convert array of bytes into structure. + + + + + Creates new record from stream. + + Stream with record's data. + Number of bytes that belongs the record. + MemoryConverter to convert array of bytes into structure. + Style sheet info. + + + + Parses UPX part of the variable part. + + + + + + + + Returns even number based on specified number. + + + + + + + + + + + + + + + + + + + Invariant style identifier. + + + + + Spare field for any temporary use, always reset back to zero! + + + + + PHEs of all text with this style are wrong. + + + + + Indicates whether UPEs have been generated. + + + + + std has been mass-copied; if unused at save time, style should be deleted. + + + + + Style type code. + + + + + Base style. + + + + + + + + + + Number of UPXs (and UPEs). + + + + + Next style. + + + + + Auto redefine style when appropriate + + + + + Indicates whether style is hidden from UI. + + + + + Names of the style + + + + + Name of the Aliases Style Names (comma separated). + + + + + Returns array of Universal Property Exceptions. Read-only. + + + + + Returns array of Property Exceptions. Read-only. + + + + + Returns array of Property Exceptions. Read-only. + + + + + Underlying structure. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets the link style id. + + The link style id. + + + + Gets or sets a value indicating whether this instance is primary style. + + + true if this instance is primary style; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is priority. + + + true if this instance is priority; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is semi hidden. + + + true if this instance is semi hidden; otherwise, false. + + + + + + + + + + STSHI: STyleSHeet Information, as stored in a file + Note that new fields can be added to the STSHI without invalidating + the file format, because it is stored preceded by it's length. + When reading a STSHI from an older version, new fields will be zero. + + + + + Bit index for StdStyleNamesWritten property. + + + + + Underlying structure. + + + + + Initializes a new instance of the class. + + Length of the i STD base. + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + Offset to the class data. + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + Offset to the class data. + Number of bytes for the new record. + + + + Creates new record from stream. + + Stream with record's data. + Number of bytes to parse. + + + + Parses record. + + Data to parse. + Offset in the data array to the records data. + Number of bytes to parse. + + + + Closes this instance. + + + + + Count of styles in stylesheet (cstd). + + + + + Length of STD Base as stored in a file (cbSTDBaseInFile). + + + + + Indicates whether built-in stylenames are stored. + + + + + Max sti known when this file was written. + + + + + How many fixed-index istds are there? + + + + + Current version of built-in stylenames (nVerBuiltInNamesWhenSaved). + + + + + ftc used by StandardChpStsh for this document. Read-only. + + + + + Underlying structure. + + + + + + + + + + Gets and sets the default bidi font name + + + + + Summary description for SymbolDescriptor. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for TabDescriptor. + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + The justification. + The leader. + + + + Saves this instance. + + + + + + Gets or sets the justification. + + The justification. + + + + Gets or sets the tab leader. + + The tab leader. + + + + Summary description for TableBorders. + + + + + + + + + + + + + + + Initializes this instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for TabsDescriptor. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + + + + + Saves the specified SPRMS. + + The SPRMS. + The SPRM option. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets the tab count. + + The tab count. + + + + Gets or sets the tab positions. + + The tab positions. + + + + Gets or sets the tab delete positions. + + The tab delete positions. + + + + Gets or sets the descriptors. + + The descriptors. + + + + Summary description for TextBoxDescriptor. + + + + + when not fReusable count of textboxes in story chain. + + + + + if fReusable, counts the number of reusable textboxes follow + this one in the linked list. + + + + + this textbox is not currently in use. + + + + + Reserved + + + + + Shape Identifier for first Office Shape in textbox chain. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Count of textboxes in story chain + + + + + The number of reusable + textboxes follow this one + + + + + Is current textbox reusable + + + + + Shape Identifier for first Office Shape + + + + + Summary description for UniversalPropertyException. + + + + + Internal data. + + + + + Default constructor. + + + + + Creates new record from array of bytes, using specified memory provider. + + Data to parse. + Offset to the class data. + Number of bytes for the new record. + MemoryConverter to convert array of bytes into structure. + + + + Closes this instance. + + + + + Parses record. + + Data to parse. + Offset in the data array to the records data. + Number of bytes to parse. + + + + Returns internal data array. Read-only. + + + + + + + + + + The properties types + + + + + Paragraph properties = 1, + + + + + Character Properties = 2, + + + + + Picture Properties = 3, + + + + + Section Properties = 4, + + + + + Table Properties = 5, + + + + + Size of the operand for sprm (Single PRoperty Modifier). + + + + + 1 byte, operand affects 1 bit. + + + + + Size of the operand, 1 byte. + + + + + Size of the operand, 2 bytes + + + + + Size of the operand, 4 bytes. + + + + + Size of the operand, TwoBytes2. + + + + + Size of the operand, TwoBytes3. + + + + + Variable length - following byte is size of operand. + + + + + Size of the operand, 3 bytes. + + + + + Specifies the WordSprmOptionType. + + + + + The SPRM p istd + + + + + The SPRM p istd permute + + + + + The SPRM p inc level + + + + + The SPRM p jc + + + + + The SPRM pf side by side + + + + + The SPRM pf keep + + + + + The SPRM pf keep follow + + + + + The SPRM pf page break before + + + + + The SPRM p BRCL + + + + + The SPRM p BRCP + + + + + The SPRM p ilvl + + + + + The SPRM p ilfo + + + + + The SPRM pf no line numb + + + + + The SPRM p CHG tabs papx + + + + + The SPRM p dxa right + + + + + The SPRM p dxa left + + + + + The SPRM p nest + + + + + The SPRM p dxa left1 + + + + + The SPRM p dya line + + + + + The SPRM p dya before + + + + + The SPRM p dya after + + + + + The SPRM p CHG tabs + + + + + The SPRM pf in table + + + + + The SPRM pf TTP + + + + + The SPRM p dxa abs + + + + + The SPRM p dya abs + + + + + The SPRM p dxa width + + + + + The SPRM p pc + + + + + The SPRM p BRC top10 + + + + + The SPRM p BRC left10 + + + + + The SPRM p BRC bottom10 + + + + + The SPRM p BRC right10 + + + + + The SPRM p BRC between10 + + + + + The SPRM p BRC bar10 + + + + + The SPRM p dxa from text10 + + + + + The SPRM p wr + + + + + The SPRM p BRC top + + + + + The SPRM p BRC left + + + + + The SPRM p BRC bottom + + + + + The SPRM p BRC right + + + + + The SPRM p BRC between + + + + + The SPRM p BRC bar + + + + + The SPRM p BRC top new + + + + + The SPRM p BRC left new + + + + + The SPRM p BRC bottom new + + + + + The SPRM p BRC right new + + + + + The SPRM pf no automatic hyph + + + + + The SPRM pw height abs + + + + + The SPRM p DCS + + + + + The SPRM p SHD + + + + + The SPRM p dya from text + + + + + The SPRM p dxa from text + + + + + The SPRM pf locked + + + + + The SPRM pf widow control + + + + + The SPRM p ruler + + + + + The SPRM pf kinsoku + + + + + The SPRM pf word wrap + + + + + The SPRM pf overflow punct + + + + + The SPRM pf top line punct + + + + + The SPRM pf automatic space de + + + + + The SPRM pf automatic space dn + + + + + The SPRM pw align font + + + + + The SPRM p frame text flow + + + + + The SPRM pi snap base line + + + + + The SPRM p anld + + + + + The SPRM p property r mark + + + + + The SPRM p out level + + + + + The SPRM pf bi di + + + + + The SPRM pf number rm ins + + + + + The SPRM p cr lf + + + + + The SPRM p number rm + + + + + The SPRM p huge papx + + + + + The SPRM p huge papx2 + + + + + The SPRM pf use pgsu settings + + + + + The SPRM pf adjust right + + + + + The SPRM CFR mark delete + + + + + The SPRM CFR mark + + + + + The SPRM cf field vanish + + + + + The SPRM c pic location + + + + + The SPRM c ibst r mark + + + + + The SPRM c DTTM r mark + + + + + The SPRM cf data + + + + + The SPRM c idsl r mark + + + + + The SPRM c CHS + + + + + The SPRM c symbol + + + + + The SPRM cf ole2 + + + + + The SPRM c identifier character type + + + + + The SPRM c highlight + + + + + The SPRM c object location + + + + + The SPRM cf FTC asci symb + + + + + The SPRM c istd + + + + + The SPRM c istd permute + + + + + The SPRM c default + + + + + The SPRM c plain + + + + + The SPRM c KCD + + + + + The SPRM cf bold + + + + + The SPRM cf italic + + + + + The SPRM cf strike + + + + + The SPRM cf outline + + + + + The SPRM cf shadow + + + + + The SPRM cf small caps + + + + + The SPRM cf caps + + + + + The SPRM cf vanish + + + + + The SPRM c FTC default + + + + + The SPRM c kul + + + + + The SPRM c size position + + + + + The SPRM c dxa space + + + + + The SPRM c lid + + + + + The SPRM c icon + + + + + The SPRM c icoe + + + + + The SPRM c HPS + + + + + The SPRM c HPS inc + + + + + The SPRM c HPS position + + + + + The SPRM c HPS position adj + + + + + The SPRM c majority + + + + + The SPRM c iss + + + + + The SPRM c HPS new50 + + + + + The SPRM c HPS inc1 + + + + + The SPRM c HPS kern + + + + + The SPRM c majority50 + + + + + The SPRM c HPS mul + + + + + The SPRM c ysri + + + + + The SPRM c rg FTC0 + + + + + The SPRM c rg FTC1 + + + + + The SPRM c rg FTC2 + + + + + The SPRM c character scale + + + + + The SPRM CFD strike + + + + + The SPRM cf imprint + + + + + The SPRM cf spec + + + + + The SPRM cf object + + + + + The SPRM c property r mark + + + + + The SPRM cf emboss + + + + + The SPRM c SFX text + + + + + The SPRM cf bi di + + + + + The SPRM cf diac color + + + + + The SPRM cf bold bi + + + + + The SPRM cf italic bi + + + + + The SPRM c FTC bi + + + + + The SPRM c lid bi + + + + + The SPRM c icon bi + + + + + The SPRM c HPS bi + + + + + The SPRM c disp field r mark + + + + + The SPRM c ibst r mark delete + + + + + The SPRM c DTTM r mark delete + + + + + The SPRM c BRC + + + + + The SPRM c SHD + + + + + The SPRM c idsl r mark delete + + + + + The SPRM cf use pgsu settings + + + + + The SPRM c CPG + + + + + The SPRM c rg lid0 + + + + + The SPRM c rg lid1 + + + + + The SPRM c idct hint + + + + + The SPRM pic BRCL + + + + + The SPRM pic scale + + + + + The SPRM pic BRC top + + + + + The SPRM pic BRC left + + + + + The SPRM pic BRC bottom + + + + + The SPRM pic BRC right + + + + + The SPRM SCNS PGN + + + + + The SPRM si heading PGN + + + + + The SPRM s olst anm + + + + + The SPRM s dxa col width + + + + + The SPRM s dxa col spacing + + + + + The SPRM sf evenly spaced + + + + + The SPRM sf protected + + + + + The SPRM s dm bin first + + + + + The SPRM s dm bin other + + + + + The SPRM s BKC + + + + + The SPRM sf title page + + + + + The SPRM s ccolumns + + + + Footnote/Endnotes Sprms + + + + The SPRM s NFC edn reference + + + + + The SPRM sn FTN + + + + + The SPRM sn edn + + + + + The SPRM s FPC + + + + + The SPRM s RNC FTN + + + + + The SPRM s RNC edn + + + + + The SPRM s dxa columns + + + + + The SPRM sf automatic PGN + + + + + The SPRM s NFC PGN + + + + + The SPRM s dya PGN + + + + + The SPRM s dxa PGN + + + + + The SPRM sf PGN restart + + + + + The SPRM sf endnote + + + + + The SPRM s LNC + + + + + The SPRM s GPRF ihdt + + + + + The SPRM sn LNN mod + + + + + The SPRM s dxa LNN + + + + + The SPRM s dya HDR top + + + + + The SPRM s dya HDR bottom + + + + + The SPRM sl between + + + + + The SPRM s VJC + + + + + The SPRM s LNN minimum + + + + + The SPRM s PGN start + + + + + The SPRM sb orientation + + + + + The SPRM sb customize + + + + + The SPRM s xa page + + + + + The SPRM s ya page + + + + + The SPRM s dxa left + + + + + The SPRM s dxa right + + + + + The SPRM s dya top + + + + + The SPRM s dya bottom + + + + + The SPRM s dza gutter + + + + + The SPRM s dm paper req + + + + + The SPRM s property r mark + + + + + The SPRM sf bi di + + + + + The SPRM sf facing col + + + + + The SPRM SFRTL gutter + + + + + The SPRM s BRC top + + + + + The SPRM s BRC left + + + + + The SPRM s BRC bottom + + + + + The SPRM s BRC right + + + + + The SPRM s PGB property + + + + + The SPRM s DXT character space + + + + + The SPRM s dya line pitch + + + + + The SPRM s CLM + + + + + The SPRM s text flow + + + + + The SPRM t jc + + + + + The SPRM t dxa left + + + + + The SPRM t dxa gap half + + + + + The SPRM tf cant split + + + + + The SPRM tf cant split90 + + + + + The SPRM t table header + + + + + The SPRM t table borders + + + + + The SPRM t definition table10 + + + + + The SPRM t dya row height + + + + + The SPRM t definition table + + + + + The SPRM t definition table SHD + + + + + The SPRM t TLP + + + + + The SPRM tf bi di + + + + + The SPRM THTML props + + + + + The SPRM t set BRC + + + + + The SPRM t insert + + + + + The SPRM t delete + + + + + The SPRM t dxa col + + + + + The SPRM t merge + + + + + The SPRM t split + + + + + The SPRM t set BRC10 + + + + + The SPRM t set SHD + + + + + The SPRM t set SHD odd + + + + + The SPRM t text flow + + + + + The SPRM t diag line + + + + + The SPRM t vert merge + + + + + The SPRM t vert align + + + + + The SPRM t cell f hide mark + + + + + The SPRM p time stamp + + + + + The SPRM c SHD new + + + + + The SPRM p SHD new + + + + + The SPRM t table borders new + + + + + The SPRM t cell margins + + + + + The SPRM t table cell margins + + + + + The SPRM none + + + + + The SPRM unknown1 + + + + + The SPRM unknown2 + + + + + The SPRM c rg lid3 + + + + + The SPRM c rg lid3 2 + + + + + The SPRM p sub table cell end + + + + + The SPRM p sub table row end + + + + + The SPRM t top border color + + + + + The SPRM t left border color + + + + + The SPRM t bottom border color + + + + + The SPRM t right border color + + + + + The SPRM t cell spacing + + + + + The SPRM t automatic resize cells + + + + + The SPRM s BRC bottom new + + + + + The SPRM s BRC left new + + + + + The SPRM s BRC right new + + + + + The SPRM s BRC top new + + + + + The SPRM p dxa left1 bi + + + + + The SPRM p table props + + + + + The SPRM t istd + + + + + The SPRM t nesting level + + + + + The SPRM table unknown1 + + + + + The SPRM table unknown2 + + + + + The SPRM t preferred width + + + + + The SPRM t width before + + + + + The SPRM t width after + + + + + The SPRM t width indent + + + + + The SPRM c underline color + + + + + The SPRM cf no proof + + + + + The SPRM p jc bi + + + + + The SPRM p dxa left bi + + + + + The SPRM p dxa right bi + + + + + The SPRM pf before automatic + + + + + The SPRM pf after automatic + + + + + The SPRM t property r mark + + + + + The SPRM t position code + + + + + The SPRM t frame left + + + + + The SPRM t frame top + + + + + The SPRM t from text bottom + + + + + The SPRM t from text left + + + + + The SPRM t from text right + + + + + The SPRM t from text top + + + + + The SPRM t cell SHD new + + + + + The SPRM t cell SHD new2 + + + + + The SPRM t cell SHD new2 dup + + + + + The SPRM t cell SHD new3 + + + + + The SPRM t cell SHD new3 dup + + + + + The SPRM t cell SHD new dup + + + + + The SPRM t table SHD + + + + + The SPRM pf no allow overlap + + + + + The SPRM p dyl before + + + + + The SPRM p dyl after + + + + + The SPRM p undocumented6465 + + + + + The SPRM p undocumented6654 + + + + + The SPRM p undocumented C653 + + + + + The SPRM p undocumented C66 c + + + + + The SPRM c LBC CRJ + + + + + The SPRM c undocumented2 a86 + + + + + The SPRM c pbi has image + + + + + The SPRM c undocumented6815 + + + + + The SPRM c undocumented6816 + + + + + The SPRM c undocumented6817 + + + + + The SPRM c pbi image index + + + + + The SPRM cf web hidden + + + + + newly added + + + + + The SPRM c undocumented revision problem + + + + + The SPRM c undocumented1 + + + + + The SPRM c undocumented2 + + + + + The SPRM c undocumented3 + + + + + The SPRM c undocumented4 + + + + + The SPRM c undocumented5 + + + + + The SPRM c undocumented6 + + + + + The SPRM c undocumented7 + + + + + The SPRM c undocumented8 + + + + + The SPRM t cell BRC type + + + + + The SPRM c property r mark1 + + + + + The SPRM c wall + + + + + The SPRM p wall + + + + + The SPRM p property r mark90 + + + + + The SPRM t wall + + + + + The SPRM pf cont spacing + + + + + The SPRM s wall + + + + + The SPRM p DXC left + + + + + The SPRM p DXC left1 + + + + + The SPRM p DXC right + + + + + The SPRM tf no allow overlap + + + + + Specifies word complex block type. + + + + + Specifies Type as Sprms. + + + + + Specifies Type as PieceTable. + + + + + Style type. + + + + + Specifies Paragraph style. + + + + + Specifies character style. + + + + + Specifies Table style. + + + + + Specifies List style. + + + + + Paragraph justification code. + + + + + Left justification. + + + + + Center justification. + + + + + Right justification. + + + + + LeftAndRight justification. + + + + + Word Sprm Options. + + + + Footnote/Endnotes Sprms + + + + newly added + + + + + Summary description for annotations. + + + + + Summary description for SubDocumentRW. + + + + + + + + + + Text position table. + + + + + Referense position table. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + The stream. + The fib. + + + + Initializes a new instance of the class. + + + + + Determines whether the specified reference has reference. + + The reference. + + true if the specified reference has reference; otherwise, false. + + + + + Determines whether the required reference position is in between the given start and end position + + Start position + End position + Text length + True if the Reference position of next Foonote/Endnote in between the start and end position otherwise false + + + + Determines whether the specified position has position. + + The position. + + true if the specified position has position; otherwise, false. + + + + + Reads. + + The stream. + The fib. + + + + Writes. + + The stream. + The fib. + + + + Adds the text position. + + The position. + + + + Gets the text position. + + The index. + + + + + Closes this instance. + + + + + Reads the descriptors. + + + + + Writes the descriptors. + + + + + Reads the descriptors. + + The length. + The size. + + + + Adds the reference position. + + The position. + + + + Inits this instance. + + + + + Reads the text positions. + + + + + Reads the text positions. + + The count. + + + + Writes the text positions base. + + + + + Writes the text positions. + + + + + Writes the reference positions. + + The end pos. + + + + Reads the descriptor. + + The reader. + The pos. + The pos next. + + + + Gets the count. + + The count. + + + + Annotation owners. + + + + + Initializes a new instance of the class. + + + + + + + Initializes a new instance of the class. + + + + + Reads. + + The stream. + The fib. + + + + Writes. + + The stream. + The fib. + + + + Adds the descriptor. + + The annotation descriptor. + The pos. + The bookmark start. + The bookmark end. + + + + Adds the descriptor. + + The annotation descriptor. + The pos. + + + + Adds the GXAO. + + The gxao. + + + + + Gets the descriptor. + + The index. + + + + + Gets the user. + + Index of the atn. + + + + + Gets the bookmark start. + + The index. + + + + + Gets the bookmark end. + + The index. + + + + + Gets the position. + + The index. + + + + + Reads the GXAO. + + The pos. + The length. + + + + Writes the GXAO. + + + + + Closes this instance. + + + + + Inits this instance. + + + + + Reads the text positions. + + + + + Reads the descriptors. + + + + + Reads the descriptor. + + The reader. + The position. + The next positiopn. + + + + Writes the descriptors. + + + + + Writes the text positions. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Closes this instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for BaseProps. + + + + + Summary description for FileShapeAddress. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets / sets shape horizontal alignment. + + + + + Gets / sets shape vertical alignment. + + + + + Summary description for BitmapBLIP. + + + + + Summary description for Blip. + + + + + + + + + + + + + + + + + + + + + + + + + + + + The secondary, or data, UID - should always be set + + + + + optional based on the above check + + + + + + + + + + raster bits of the blip + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for BstoreContainer. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Closes this instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for Shapes. + + + + + Table stream + + + + + Sorted list with FileShapeAddress structures + + + + + Sorted list with TexBoxStory structures + + + + + Sorted list with textbox BreakDescriptors + + + + + Last text position for textbox in Main + + + + + Last text position for textbox in Header + + + + + + + + + + + + Initializes a new instance of the class. + + + + + + + + + + + + + Initialize MainDocTxBxs and MainDocTxBxBKDs, or HfDocTxBxBKDs and HfDocTxBxs + + + + + + + + + + + + + + + + + + + + + + + + + Get textbox text positions (needed in Reader) + + + + + + + + Get ShapeObject's identificator from TextboxStoryDescriptor collection. + + Subdocument type. + ShapeObject entry. + + + + + Closes this instance. + + + + + + + + + + + + + + + + + + + + + Read TextBoxes + + + table stream position + + + + + Read TextBox breakdescriptors + + + + + Get positions for each type of artobjects + + structure type + structure length + + + + + Write FSPA + + + + + + + + Write textbox + + fib data + + + + + Write break descriptors + + + + + + Write data to stream + + + End position for FSPA + + + + Write data to stream + + + End position for FSPA + + + + Gets the index of the by. + + The col. + The index. + + + + + Gets the key. + + The col. + The index. + + + + + + + + + + Sorted list of textboxes + + + + + Sorted list of textbox descriptors + + + + + + + + + + Sorted list of header/footer's textboxes + + + + + Sorted list of header/footer's textboxe descriptors + + + + + Get count of the structures + + + + + Base class for all Container classes + + + + + Summary description for BaseContainer. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Clone current record. + + + + + + + + + + + + + + + + + + + + + + + + + Closes this instance. + + + + + + + + + + + + + + + + + + + + + + + + + + Removes the container by spid. + + The base container. + The spid. + + + + + Synchronize identificators in escher container. + + The auto shape collection. + The textbox shape id. + The pict shape id. + The text id. + Index of the text col. + + + + Gets shape container's identificator. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Clones the relations to. + + The doc. + + + + Remove Ole from BaseContainer. + + + + + Syncronize Txid in OPT container. + + The option record. + The text id. + + + + Synchronize MsofbtSp. + + The shape record. + The auto shape collection. + The textbox shape id. + The pict shape id. + Index in the text collection. + + + + Closes this instance. + + + + + + + + + + Summary description for ContainerCollection. + + + + + + + + + + Writes the specified stream. + + The stream. + + + + + Reads the specified stream. + + The stream. + The length. + + + + Summary description for Escher. + + + + + + + + + + + + + + + + + + + + Collection which is used for fast container's search. + + + + + Background container. + + + + + + + + + + Initializes a new instance of the class. + + The table stream. + The doc stream. + The DGG info offset. + Length of the DGG info. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get shape order index + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get shape type of BaseEscherRecord + + + + + + Clone container in escher. + + Destination document + Wordsubdocument( main or header/footer) + Spid of container, which will be cloned + Result container spid + + + + Remove OLE from escher. + + + + + + + + + + + + Remove container with data from BStoreContainer by PID. + + + + + + Remove container with data from BStoreContainer by PID. + + + + + + + Get background container. + + + + + + Checks the existance of container with such pib and checks if Blip != null + + The pib. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create and fill MsofbtGeneral (textboxes only) + + + + + + Initialize FIDCL for textboxes + + + + + + + + + + + + + + + Get the number of shaped in DgContainer. + + + + + + + + + + + + Fill m_containers hash table + + + + + + + + + + + + + + + + + Closes this instance. + + + + + Get all containers that have spids. + + + + + Gets background container. + + + + + File Blip Store Entry. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The ID clusters are used internally for the translation of shape ids (SPIDs) + to shape handles (MSOHSPs). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for FOPTEBase. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for FOPTEBid. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the FOPTbid text for Word comparison + + + + + + + + + + + Summary description for FOPTEComplex. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + BLIP Store Entry Record msofbtBSE + Each BLIP in the BStore is serialized to a File BLIP Store Entry (FBSE) record. The instance field + encodes the type of the blip. A fixed size header contains the rest of the common information about + the BLIP. If the cbName field in the FBSE is nonzero, a null-terminated Unicode string is written + immediately after the FBSE in the file. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Determines whether the specified image format is metafile. + + The image format. + + true if the specified image format is metafile; otherwise, false. + + + + + Determines whether the specified image format is bitmap. + + The image format. + + true if the specified image format is bitmap; otherwise, false. + + + + + Compare the properties of two bse + + + + + + + Gets the MsofbtBSE text for Word comparison + + + + + + + + + + + + + + + + + + + + + Gets or sets the value indicating whether the picture is in shape field + + + + + The BStore container is just an array of Blip Store Entry (BSE) records. Each shape stores indices + into the array for the BLIPs they use. BLIPs are used not only for inserted pictures, but also for + the textured and pictures fills of the shape. + + + + + + + + + + + + + + + + Host-specific data. + + + + + Summary description for MsofbtUnknown. + + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + + + + + + + + + + + Closes this instance. + + + + + + + + + + Summary description for MsofbtClientData. + + + + + + + + + + the text in the textbox, in a host-defined format. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Drawing Record msofbtDg + The drawing record is very simple, with just a count and MSOSPID seed. The attentive reader may + expect to find the size of the drawing recorded here, but that information is stored elsewhere + by the host application. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Drawing Container msofbtDgContainer + The drawing container contains all per-slide/sheet types of information, including the shapes + themselves. With a few exceptions, shapes are stored hierarchically according to how they've been + grouped (through use of the Draw/Group command). For normal shapes, there is a special parent + group shape called the patriarch that contains all of the top-level shapes (which in turn may + contain other shapes). The patriarch is always the first msofbtSpgrContainer in the drawing + container. A few kinds of shapes are stored separately from the patriarch. The background shape, + if there is one, is saved in its own msofbtSpContainer after the patriarch and its children. + Additionally, if undo information is being saved and there are deleted shapes that could be brought + back via Undo, the deleted shapes are saved. Note that there is no patriarch for the deleted shapes, + so the top-level deleted shapes are saved separately into the drawing container. (Deleted groups + still contain their children, though.) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The drawing group record is a variable length record consisting of a fixed part followed by an array. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for MsofbtDggContainer. + + + + + + + + + + + + + + + + + + + + Bitmap Blips + Those blips have one of the following signatures: msobiJPEG, msobiPNG, or msobiDIB. + They have the same UID header as described in the Metafile Blip case. The data after the header + is just a single BYTE "tag" value and is followed by the compressed data of the bitmap in the + relevant format (JFIF or PNG, bytes as would be stored in a file). For the msobiDIB format, + the data is in the standard DIB format as a BITMAPINFO ER, BITMAPCORE ER or BITMAPV4 ER followed + by the color map (DIB_RGB_COLORS) and the bits. This data is not compressed (the format is used + for very small DIB bitmaps only). + + + + + Summary description for _Blip. + + + + + + + + + + + + + + + + + + + + + + + + + + + Determines whether this instance has uid2. + + + true if this instance has uid2; otherwise, false. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets the uid2. + + The uid2. + + + + Gets a value indicating whether this instance is has .dib format. + + true if this instance has .dib format; otherwise, false. + + + + Number of used colors. + + + + + Size of header. + + + + + Size of each color definition in the palette. + + + + + Signature, must be 4D42 hex for .bmp header. + + + + + Reserved data. + + + + + + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + The image record. + if set to true [is bitmap]. + The doc. + + + + + + + + + + + + + + + + + + + + + + Closes this instance. + + + + + Dib file is a .BMP file without .BMP header. This function adds BMP header. + + + + + + + + + + + + + + + Metafile/PICT Blips + Those blips have one of the following signatures: msobiEMF, msobiWMF, or msobiPICT. They are normally + stored in a compressed format using the LZ compression algorithm in the format used by GNU Zip + deflate/inflate with a 32k window. The format is zlib format . The only metafile compression version + number currently defined identifies this format and is analogous to the PNG compression type value in the + PNG file format. The filter values (MSOBLIPFILTER) define pre-filtering of metafile data to give better + compression. Currently no pre-filtering is done (it is likely that filtering on a per-record basis will give + substantially better compression in the future). However, if there is an exception due to out-of-memory or + out-of-disk space when saving those blips, the compression operation is skipped and the blips are then + saved in a non-compressed format- in this case the compressed bits are simply the original metafile data.. + When the blips are loaded back in memory, a check is performed based on a "compression status" flag + (MSOBLIPCOMPRESSION) that follows the blip header encoded as follows: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Closes this instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Default Property Table Record msofbtOPT + This describes the default properties of newly created shapes. + Only the properties that differ from the per-property defaults are saved. + The format of the record is the same as that of the property table in a shape; + a discussion of that format is in the Shape Properties section . + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Closes this instance. + + + + + Get uint property value by key + + + + + + + Sets the property value. + + The key. + The value. + + + + Get complex value by key. + + + + + + + + + + + + + Compare the properties of two shape options + + + + + + + Gets the MsofbtOPT text for word comaparison + + + + + + Gets the line properties. + + The line properties. + + + + Gets the wrap polygon vertices. + + + The wrap polygon vertices. + + + + + + + + + + + + + + + + + + + + Gets or sets the layout in table cell. + + The layout in table cell. + + + + Gets/sets a value indicating whether allow in table cell. + + true if allow in table cell; otherwise, false. + + + + Gets or sets a value indicating whether this textbox can overlap other textboxes. + + + true if allow the textbox to overlap other textboxes; otherwise, false. + + + + + Gets or sets a value indicating whether this is Visible. + + + true if hidden; otherwise, false. + + + + + Gets or sets the distance from bottom. + + + The distance from bottom. + + + + + Gets or sets the distance from left. + + + The distance from left. + + + + + Gets or sets the distance from right. + + + The distance from right. + + + + + Gets or sets the distance from top. + + + The distance from top. + + + + + Gets or sets the rotation. + + + The Rotation + + + + + + + + + + The rotation + + + + + Changes the behavior of a shape by restricting direct manipulation. + + + + + The f lock rotation + + + + + The f lock aspect ratio + + + + + The f lock position + + + + + The f lock against select + + + + + The f lock cropping + + + + + The f lock vertices + + + + + The f lock text + + + + + The f lock adjust handles + + + + + The f lock against grouping + + + + + How text fits in a shape. Text is host-dependent, so some hosts may ignore + some of these properties. + + + + + The l txid + + + + + The dx text left + + + + + The dy text top + + + + + The dx text right + + + + + The dy text bottom + + + + + The wrap text + + + + + The scale text + + + + + The anchor text + + + + + The TXFL text flow + + + + + The cdir font + + + + + The HSP next + + + + + The txdir + + + + + The f select text + + + + + The f automatic text margin + + + + + The f rotate text + + + + + The f fit shape to text + + + + + The f fit text to shape + + + + + Effect text of the shape - this is what the WordArt tools use, and is separate from + the attached text present in ordinary textboxes. Theoretically, a shape could have + both (a WordArt with attached text), but this is not currently allowed by the UI. + Note that font information is provided here. The default text size is in points, + the text effect geometry interfaces require the device size of a point to interpret this. + The default point size is a 16.16 fixed-point number. A text effect is present + if the fGText boolean is set and either the gtextUNICODE (UNICODE) or gtextRTF (RTF) + is present, the UNICODE string takes precedence, however it cannot include any additional + font information (unlike the RTF). + + + + + The gtext unicode + + + + + The gtext RTF + + + + + The gtext align + + + + + The gtext size + + + + + The gtext spacing + + + + + The gtext font + + + + + The gtext f reverse rows + + + + + The f gtext + + + + + The gtext f vertical + + + + + The gtext f kern + + + + + The gtext f tight + + + + + The gtext f stretch + + + + + The gtext f shrink fit + + + + + The gtext f best fit + + + + + The gtext f normalize + + + + + The gtext f dx measure + + + + + The gtext f bold + + + + + The gtext f italic + + + + + The gtext f underline + + + + + The gtext f shadow + + + + + The gtext f smallcaps + + + + + The gtext f strikethrough + + + + + How a BLIP fits into a shape. This includes cropping information as well as + picture display modifications such as brightness and contrast. + + + + + The crop from top + + + + + The crop from bottom + + + + + The crop from left + + + + + The crop from right + + + + + The pib + + + + + The pib name + + + + + The pib flags + + + + + The picture transparent + + + + + The picture contrast + + + + + The picture brightness + + + + + The picture gamma + + + + + The picture identifier + + + + + The picture double cr mod + + + + + The picture fill cr mod + + + + + The picture line cr mod + + + + + The pib print + + + + + The pib print name + + + + + The pib print flags + + + + + The f no hit test picture + + + + + The picture gray + + + + + The picture bi level + + + + + The picture active + + + + + The geometry of the shape. Typically, these properties reside in a shape type definition, + and so are not written to the file. However, freeform shapes drawing using the polygon + tools set the pVertices and pSegmentInfo properties to define their geometries. + + + + + The geo left + + + + + The geo top + + + + + The geo right + + + + + The geo bottom + + + + + The shape path + + + + + The p vertices + + + + + The p segment information + + + + + The adjust value + + + + + The adjust2 value + + + + + The adjust3 value + + + + + The adjust4 value + + + + + The adjust5 value + + + + + The adjust6 value + + + + + The adjust7 value + + + + + The adjust8 value + + + + + The adjust9 value + + + + + The adjust10 value + + + + + The f shadow ok + + + + + The f3 dok + + + + + The f line ok + + + + + The f gtext ok + + + + + The f fill shade shape ok + + + + + The f fill ok + + + + + Two main colors are defined - a foreground color and a background color. + Different fillTypes use these values differently. In addition to the foreground + and background any number of shade colors can be defined. Each shade color + is associated with a "position" which says how far into the shade the color appears + � colors must be given in position order. + + + + + The fill type + + + + + The fill color + + + + + The fill opacity + + + + + The fill back color + + + + + The fill back opacity + + + + + The fill cr mod + + + + + The fill blip + + + + + The fill blip name + + + + + The fill blip flags + + + + + The fill width + + + + + The fill height + + + + + The fill angle + + + + + The fill focus + + + + + The fill to left + + + + + The fill to top + + + + + The fill to right + + + + + The fill to bottom + + + + + The fill rect left + + + + + The fill rect top + + + + + The fill rect right + + + + + The fill rect bottom + + + + + The fill dztype + + + + + The fill shade preset + + + + + The fill shade colors + + + + + The fill origin x + + + + + The fill origin y + + + + + The fill shape origin x + + + + + The fill shape origin y + + + + + The fill shade type + + + + + The f filled + + + + + The f hit test fill + + + + + The fill shape + + + + + The fill use rect + + + + + The f no fill hit test + + + + + Lines are centered about the infinitely thin proto-line along which they are drawn. + Complex dash effects are supported only for simple lines (e.g. changing the end cap) - + defaults should be used for other line styles. The line width is in EMUs; a line width + of zero should not be used - there is no logical interpretation on a high-resolution printer. + + + + + The line color + + + + + The line opacity + + + + + The line back color + + + + + The line cr mod + + + + + The line type + + + + + The line fill blip + + + + + The line fill blip name + + + + + The line fill blip flags + + + + + The line fill width + + + + + The line fill height + + + + + The line fill dztype + + + + + The line width + + + + + The line miter limit + + + + + The line style + + + + + The line dashing + + + + + The line dash style + + + + + The line start arrowhead + + + + + The line end arrowhead + + + + + The line start arrow width + + + + + The line start arrow length + + + + + The line end arrow width + + + + + The line end arrow length + + + + + The line join style + + + + + The line end cap style + + + + + The line color ext + + + + + The reserved474 + + + + + The line color ext mod + + + + + The reserved476 + + + + + The line back color ext + + + + + The reserved478 + + + + + The line back color ext mod + + + + + The reserved480 + + + + + The reserved481 + + + + + The reserved482 + + + + + The line style boolean properties + + + + + Specifies the FOPTELeftLineStyle + + + + + The line left color + + + + + The line left opacity + + + + + The line left back color + + + + + The line left cr mod + + + + + The line left type + + + + + The line left fill blip + + + + + The line left fill blip name + + + + + The line left fill blip flags + + + + + The line left fill width + + + + + The line left fill height + + + + + The line left fill dztype + + + + + The line left width + + + + + The line left miter limit + + + + + The line left style + + + + + The line left dashing + + + + + The line left dash style + + + + + The line left start arrowhead + + + + + The line left end arrowhead + + + + + The line left start arrow width + + + + + The line left start arrow length + + + + + The line left end arrow width + + + + + The line left end arrow length + + + + + The line left join style + + + + + The line left end cap style + + + + + The line left color ext + + + + + The reserved1370 + + + + + The line left color ext mod + + + + + The reserved1372 + + + + + The line left back color ext + + + + + The reserved1374 + + + + + The line left back color ext mod + + + + + The reserved1376 + + + + + The reserved1377 + + + + + The reserved1378 + + + + + The left line style boolean properties + + + + + Specifies the FOPTETopLineStyle + + + + + The line top color + + + + + The line top opacity + + + + + The line top back color + + + + + The line top cr mod + + + + + The line top type + + + + + The line top fill blip + + + + + The line top fill blip name + + + + + The line top fill blip flags + + + + + The line top fill width + + + + + The line top fill height + + + + + The line top fill dztype + + + + + The line top width + + + + + The line top miter limit + + + + + The line top style + + + + + The line top dashing + + + + + The line top dash style + + + + + The line top start arrowhead + + + + + The line top end arrowhead + + + + + The line top start arrow width + + + + + The line top start arrow length + + + + + The line top end arrow width + + + + + The line top end arrow length + + + + + The line top join style + + + + + The line top end cap style + + + + + The line top color ext + + + + + The reserved1434 + + + + + The line top color ext mod + + + + + The reserved1436 + + + + + The line top back color ext + + + + + The reserved1438 + + + + + The line top back color ext mod + + + + + The reserved1440 + + + + + The reserved1441 + + + + + The reserved1442 + + + + + The top line style boolean properties + + + + + Specifies the FOPTERightLineStyle + + + + + The line right color + + + + + The line right opacity + + + + + The line right back color + + + + + The line right cr mod + + + + + The line right type + + + + + The line right fill blip + + + + + The line right fill blip name + + + + + The line right fill blip flags + + + + + The line right fill width + + + + + The line right fill height + + + + + The line right fill dztype + + + + + The line right width + + + + + The line right miter limit + + + + + The line right style + + + + + The line right dashing + + + + + The line right dash style + + + + + The line right start arrowhead + + + + + The line right end arrowhead + + + + + The line right start arrow width + + + + + The line right start arrow length + + + + + The line right end arrow width + + + + + The line right end arrow length + + + + + The line right join style + + + + + The line right end cap style + + + + + The line right color ext + + + + + The reserved1498 + + + + + The line right color ext mod + + + + + The reserved1500 + + + + + The line right back color ext + + + + + The reserved1502 + + + + + The line right back color ext mod + + + + + The reserved1504 + + + + + The reserved1505 + + + + + The reserved1506 + + + + + The right line style boolean properties + + + + + Specifies the FOPTEBottomLineStyle + + + + + The line bottom color + + + + + The line bottom opacity + + + + + The line bottom back color + + + + + The line bottom cr mod + + + + + The line bottom type + + + + + The line bottom fill blip + + + + + The line bottom fill blip name + + + + + The line bottom fill blip flags + + + + + The line bottom fill width + + + + + The line bottom fill height + + + + + The line bottom fill dztype + + + + + The line bottom width + + + + + The line bottom miter limit + + + + + The line bottom style + + + + + The line bottom dashing + + + + + The line bottom dash style + + + + + The line bottom start arrowhead + + + + + The line bottom end arrowhead + + + + + The line bottom start arrow width + + + + + The line bottom start arrow length + + + + + The line bottom end arrow width + + + + + The line bottom end arrow length + + + + + The line bottom join style + + + + + The line bottom end cap style + + + + + The line bottom color ext + + + + + The reserved1562 + + + + + The line bottom color ext mod + + + + + The reserved1564 + + + + + The line bottom back color ext + + + + + The reserved1566 + + + + + The line bottom back color ext mod + + + + + The reserved1568 + + + + + The reserved1569 + + + + + The reserved1570 + + + + + The bottom line style boolean properties + + + + + The interpretation of the transform properties depends on the type of shadow: + msoshadowOffset, msoshadowDouble: + Only the offset is used. It is interpreted as an absolute offset expressed in EMUs. + The default corresponds to 1/36" in both X and Y (2 or 3 pixels on screen depending on + monitor resolution). The offset is relative to the drawing axes (as msoshadowDrawing below, + not msoshadowRich) so a shadow offset to the bottom right of the drawing is still offset + (by the same amount) to the bottom right if the shape is rotated. The "double" case causes + two shadows to be drawn, the first (lower) at the second offset and in the shadowHighlightColor. + If the second offset is 0,0 it defaults to being the inverse of the first. + msoshadowRich: + The offsets and transformation properties are in absolute units measured relative to the shape + on the drawing - the shadow moves with the shape, but anisotropic scaling of the shape + changes the proportions of the shadow, not its angles. Compare with the following where + such scaling scales the shadow in proportion too, thus changes the angle between (e.g.) + a vertical line in the shape and it's shadow. + msoshadowShape: + The offsets and transformation properties are relative to the shape; 1.0 corresponds + to the shape width/height as appropriate. The shadow is cast relative to the shape + then scaled with the shape, so it moves with the shape. The units are simple numbers + (ratios of the G unit space effectively). This transformation type is unnatural in real + world terms, but behaves nicely in geometric terms. The offset elements of the property + set are treated as fixed-point 16.16 values. + msoshadowDrawing: + A rich shadow cast onto a plane in drawing space. The transform is applied to the drawing + coordinates of the shape and is thus expressed in EMUs. This shadow type enables creation + of shadows from multiple objects, however the shadows may overlap higher (different) + objects if the shadow plane and shape drawing planes overlap on the screen. + The shadowWeight parameter is used as in the perspective property set to apply addiitonal + scaling to the perspective parameters - these are divided by the weight. + Shadow transformations are independent of the perspective transformation applied to a shape - + either hte perspective transformation or the shadow transformation is used as appropriate. + + + + + The shadow type + + + + + The shadow color + + + + + The shadow highlight + + + + + The shadow cr mod + + + + + The shadow opacity + + + + + The shadow offset x + + + + + The shadow offset y + + + + + The shadow second offset x + + + + + The shadow second offset y + + + + + The shadow scale x to x + + + + + The shadow scale y to x + + + + + The shadow scale x to y + + + + + The shadow scale y to y + + + + + The shadow perspective x + + + + + The shadow perspective y + + + + + The shadow weight + + + + + The shadow origin x + + + + + The shadow origin y + + + + + The f shadow + + + + + The fshadow obscured + + + + + Perspective Style + This is just a 2D transformation matrix (3x3). Specifying peculiar values will cause + the shape to render completely outside its geometry - normally clients will constrain + the values to get reasonable results. The transformation may be applied at various + times as the geometry is processed, this affects the behavior of the perspective + which results in the same way as the corresponding shadow perspective types. + + + + + The perspective type + + + + + The perspective offset x + + + + + The perspective offset y + + + + + The perspective scale x to x + + + + + The perspective scale y to x + + + + + The perspective scale x to y + + + + + The perspective scale y to y + + + + + The perspective perspective x + + + + + The perspective perspective y + + + + + The perspective weight + + + + + The perspective origin x + + + + + The perspective origin y + + + + + The f perspective + + + + + 3D Object + Material properties of a 3D object. A 3D effect overrides the fill and line effects + and corresponding colors. Extrusion depths are always specified in absolute units. + + + + + The c3 d specular amt + + + + + The c3 d diffuse amt + + + + + The c3 d shininess + + + + + The c3 d edge thickness + + + + + The c3 d extrude forward + + + + + The c3 d extrude backward + + + + + The c3 d extrude plane + + + + + The c3 d extrusion color + + + + + The c3 d cr mod + + + + + The f3 d + + + + + The FC3 d metallic + + + + + The FC3 d use extrusion color + + + + + The FC3 d light face + + + + + 3D Style + Properties of a 3D view; note that distances are in drawing units. + + + + + The c3 dy rotation angle + + + + + The c3 dx rotation angle + + + + + The c3 d rotation axis x + + + + + The c3 d rotation axis y + + + + + The c3 d rotation axis z + + + + + The c3 d rotation angle + + + + + The c3 d rotation center x + + + + + The c3 d rotation center y + + + + + The c3 d rotation center z + + + + + The c3 d render mode + + + + + The c3 d tolerance + + + + + The c3 dx viewpoint + + + + + The c3 dy viewpoint + + + + + The c3 dz viewpoint + + + + + The c3 d origin x + + + + + The c3 d origin y + + + + + The c3 d skew angle + + + + + The c3 d skew amount + + + + + The c3 d ambient intensity + + + + + The c3 d key x + + + + + The c3 d key y + + + + + The c3 d key z + + + + + The c3 d key intensity + + + + + The c3 d fill x + + + + + The c3 d fill y + + + + + The c3 d fill z + + + + + The c3 d fill intensity + + + + + The FC3 d constrain rotation + + + + + The FC3 d rotation center automatic + + + + + The FC3 d parallel + + + + + The FC3 d key harsh + + + + + The FC3 d fill harsh + + + + + Shape + Miscellaneous properties of a single shape which do not apply to group shapes. + + + + + The HSP master + + + + + The cxstyle + + + + + The b w mode + + + + + The b w mode pure bw + + + + + The b w mode bw + + + + + The f OLE icon + + + + + The f prefer relative resize + + + + + The f lock shape type + + + + + The f delete attached object + + + + + The f background + + + + + Callout + Properties of a callout shape. + + + + + The spcot + + + + + The dxy callout gap + + + + + The spcoa + + + + + The spcod + + + + + The dxy callout drop specified + + + + + The dxy callout length specified + + + + + The f callout + + + + + The f callout accent bar + + + + + The f callout text border + + + + + The f callout minus x + + + + + The f callout minus y + + + + + The f callout drop automatic + + + + + The f callout length specified + + + + + Group Shape + Miscellaneous shape properties that can apply to group shapes. + + + + + The wz name + + + + + The wz description + + + + + The pihl shape + + + + + The p wrap polygon vertices + + + + + The dx wrap dist left + + + + + The dy wrap dist top + + + + + The dx wrap dist right + + + + + The dy wrap dist bottom + + + + + The lid regroup + + + + + The unused906 + + + + + The wz tooltip + + + + + The wz script + + + + + The posh + + + + + The posrelh + + + + + The posv + + + + + The posrelv + + + + + The PCT hr + + + + + The align hr + + + + + The dx height hr + + + + + The dx width hr + + + + + The wz script ext attribute + + + + + The script language + + + + + The wz script language attribute + + + + + The border top color + + + + + The border left color + + + + + The border bottom color + + + + + The border right color + + + + + The table properties + + + + + The table row properties + + + + + The wz web bot + + + + + The metro BLOB + + + + + The DHGT + + + + + The f edited wrap + + + + + The f behind document + + + + + The f on double click notify + + + + + The f is button + + + + + The f one d + + + + + The f hidden + + + + + The f print + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Count of bytes written. + + + + + + + + + + + + + + + + + Summary description for MsofbtSecondaryFOPT - OfficeArtSecondaryFOPT. + + + + + + + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + + + + + + + + + + Closes this instance. + + + + + Get uint property value by key + + + + + + + Get complex value by key. + + + + + + + Counts the instance value. + + + + + + Gets or sets the properties. + + The properties. + + + + Summary description for MsofbtTertiaryFOPT - OfficeArtTertiaryFOPT. + + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + + + + Clone current record. + + + + + + Closes this instance. + + + + + Get uint property value by key + + + + + + + Sets the property value. + + The key. + The value. + + + + Get complex value by key. + + + + + + + Counts the instance value. + + + + + + Compare the properties of two shape positions + + + + + + + Gets the MsofbtTertiaryFOPT text for Word comparison + + + + + + Gets the line properties. + + The line properties. + + + + Gets the wrap polygon vertices. + + + The wrap polygon vertices. + + + + + Gets or sets the properties. + + The properties. + + + + Gets or sets the X align. + + The X align. + + + + Gets or sets the X rel to. + + The X rel to. + + + + Gets or sets the Y align. + + The Y align. + + + + Gets or sets the Y rel to. + + The Y rel to. + + + + Gets or sets the layout in table cell. + + The layout in table cell. + + + + Gets or sets the unknown1. + + The unknown1. + + + + Gets or sets the unknown2. + + The unknown2. + + + + Gets/sets a value indicating whether allow in table cell. + + true if allow in table cell; otherwise, false. + + + + Gets or sets a value indicating whether this textbox can overlap other textboxes. + + + true if allow the textbox to overlap other textboxes; otherwise, false. + + + + + Gets or sets a value indicating whether this is Visible. + + + true if hidden; otherwise, false. + + + + + Summary description for LineStyleBooleanProperties + + + + + Initializes a new instance of the class. + + The prop. + + + + Compare the properties of two lineproperties + + + + + + + Gets the LineStyleBooleanProperties for Word comparison + + + + + + Gets a value indicating whether this instance has defined. + + + true if this instance has defined; otherwise, false. + + + + + Gets or sets a value indicating whether [pen align inset]. + + true if [pen align inset]; otherwise, false. + + + + Gets or sets a value indicating whether [usef line opaque back color]. + + + true if [usef line opaque back color]; otherwise, false. + + + + + Gets or sets a value indicating whether [usef inset pen]. + + true if [usef inset pen]; otherwise, false. + + + + Gets or sets a value indicating whether [usef inset pen OK]. + + true if [usef inset pen OK]; otherwise, false. + + + + Gets or sets a value indicating whether [usef arrowheads OK]. + + true if [usef arrowheads OK]; otherwise, false. + + + + Gets or sets a value indicating whether [usef line]. + + true if [usef line]; otherwise, false. + + + + Gets or sets a value indicating whether [usef hit test line]. + + true if [usef hit test line]; otherwise, false. + + + + Gets or sets a value indicating whether [usef line fill shape]. + + true if [usef line fill shape]; otherwise, false. + + + + Gets or sets a value indicating whether [usef no line draw dash]. + + + true if [usef no line draw dash]; otherwise, false. + + + + + Gets or sets a value indicating whether [line opaque back color]. + + + true if [line opaque back color]; otherwise, false. + + + + + Gets or sets a value indicating whether [inset pen]. + + true if [inset pen]; otherwise, false. + + + + Gets or sets a value indicating whether [inset pen OK]. + + true if [inset pen OK]; otherwise, false. + + + + Gets or sets a value indicating whether [arrowheads OK]. + + true if [arrowheads OK]; otherwise, false. + + + + Gets or sets a value indicating whether this is line. + + true if line; otherwise, false. + + + + Gets or sets a value indicating whether [hit test line]. + + true if [hit test line]; otherwise, false. + + + + Gets or sets a value indicating whether [line fill shape]. + + true if [line fill shape]; otherwise, false. + + + + Gets or sets a value indicating whether [no line draw dash]. + + true if [no line draw dash]; otherwise, false. + + + + Wrap Polygon Vertices class + + + + + Initializes a new instance of the class. + + The prop. + + + + Compare the properties of two wrap polygon vertices + + + + + + + Gets the WrapPolygonVertices text for Word comparison + + + + + + Reads the array data. + + + + + Gets or sets the coords. + + + The coords. + + + + + Gets or sets the number of array elements that are contained in this record. + + + The n elems. + + + + + Gets or sets the maximum number of array elements that this record can contain. + + + The n elems alloc. + + + + + Gets or sets the size, in bytes, of each element in the data array. + + + The cb elem. + + + + + Solver Container msofbtSolverContainer + Rules give special behaviors to shapes. Rules can govern a single shape, like in the case of a + callout shape, or multiple shapes, as in the case of connectors. + Each drawing can have a list of rules associated with it. + + + + + + + + + + The instance field of the record header contains the shape type; + the record itself contains the shape ID and a group of persistent flags. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Compare the properties of two Shape + + + + + + + Gets the MsofbtSp text for Word comparison + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Shape Container msofbtSpContainer + A shape is the elemental object that composes a drawing. All graphical figures on a drawing + are shapes. Each shape has a list of properties, which is stored in an array. + + + + + Constant value. + + + + + Specifies Word Picture watermark. + + + + + Specifies Power plus water mark object. + + + + + + Specifies NotAllowInCell + + + + + + + + + + + + + + + Get uint property value by key + + + + + + + Get complex property value. + + + + + + + Defines if document has any background effects. + + + true if [is filled background] [the specified back container]; otherwise, false. + + + + + Gets the type of the background fill. + + + + + + Gets the type of the background. + + + + + + Gets the background image or image bytes. + + The escher. + + + + + Gets the background image bytes. + + The escher. + + + + + Gets the color of the background. + + if set to true [returns picture background color]. + + + + + Get shading style for gradient. + + Type of the fill. + + + + + Gets the shading variant. + + The shading style. + + + + + Create and init SpContainer of msosptRectangle shape type + + + + + + Creates the background container. + + The document. + The background. + + + + Updates the fill gradient. + + The gradient. + + + + Updates the fill picture. + + Index of the fill blip. + The background. + + + + Updates the fill color of the container. + + The color. + + + + + + + + + + + + + + + + + + Apply Picture properties to the Shape Position + + + + + + + + + + + + + + + Creates the inline image container. + + The picture. + + + + + Creates the textbox container. + + The TXBX format. + + + + + + + + + + + + Determines whether the specified image format is bitmap. + + The image format. + + true if the specified image format is bitmap; otherwise, false. + + + + + Determines whether this image format is bitmap for partial trust mode. + + The image format. + + + + + + + + + + + + + + + + + Checks the options container(fixed the problem of picture preservation for + documents generated by old version of DocIO ). + + + + + + + + + + + + + + + + + + + + + + + + + + Clones the relations to. + + The doc. + + + + Compare the properties of two Shape container + + + + + + + Gets the MsofbtSpContainer text for Word comparison + + + + + + + + + + + Writes the textbox options. + + The textbox format. + + + + + + + + + + sets the crop value + + + + + + + Sets the rotation Value + + + + + + + Set user defined textbox option. + + List of container's FOPTEs + User defined option value + Option's FOPTE key + + + + + Set user defined boolean textbox property. + + Shape options + Option's FOPTE key + Bit mask for option + Option's bit in bitfield + Options value + FopteBid's default value + + + + Gets the opacity. + + The opacity. + + + + + Noes the background. + + + + + + Get shading variant for "FromCorner" shading style. + + + + + + Add fillAngle fopte to gradient container. + + + + + + Adds focus fopte to gradient container. + + + + + + + + Add fillType fopte to gradient container. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Defines if current shape container is watermark. + + + + + Group Shape Record msofbtSpgr + This record is present only in group shapes (not shapes in groups, shapes that are groups). + The group shape record defines the coordinate system of the shape, which the anchors of the + child shape are expressed in. All other information is stored in the shape records that follow. + + typedef struct _FSPGR + { + RECT rcgBounds; + } FSPGR; + + + + + Boundary of metafile drawing commands + + + + + + + + + + + + + + + + + + + + + + + + + + + + Group Container msofbtSpgrContainer + + A group is a collection of other shapes. The contained shapes are placed in the coordinate + system of the group. The group container contains a variable number of shapes + (msofbtSpContainer) and other groups (msofbtSpgrContainer, for nested groups). + The group itself is a shape, and always appears as the first msofbtSpContainer in the group + container. + + + + + + + + + + + + + + + Summary description for PictureShape. + + + + + Summary description for ShapeBase. + + + + + + + + + + + + + + + Removes the reference of the used resources. + + + + + + + + + + + Get shape + + + + + Constructor + + + + + + + + + + + + + + + + Get PictureShape's image + + + + + Get PictureShapes properties + + + + + Summary description for TextBoxShape. + + + + + + + + + + + + + + + Get TextBoxShape's properties + + + + + Summary description for ShapeType. + + + + + Accent Callouts. + + + + + Action Buttons. + + + + + Bent Connectors. + + + + + Border Callouts. + + + + + + + + + + Callouts. + + + + + + + + + + Curved connectors. + + + + + Curved Arrows. + + + + + + + + + + Ellipse shapes. + + + + + FlowChart shapes. + + + + + + + + + + Image shape + + + + + Leftsided shapes. + + + + + + + + + + Seal shape + + + + + WordArt objects. + + + + + + + + + + Summary description for ShapeDocType. + + + + + + + + + + + + + + + Possible values for the orientation of a shape. + + + + + Possible types of background fill. + + + + + Fill with a solid color. + + + + + Fill with a pattern (bitmap). + + + + + A texture (pattern with its own color map). + + + + + Center a picture in the shape. + + + + + Shade from start to end points. + + + + + Shade from bounding rectangle to end point. + + + + + Shade from shape outline to end point. + + + + + Similar to msofillShade, but the fillAngle + is additionally scaled by the aspect ratio of + the shape. If shape is square, it is the + same as Shade. + + + + + Special type - shade to title --- for PP + + + + + Use the background fill color/pattern + + + + + MSOSHADETYPE � how to interpret the colors in a shaded fill. + + + + + Interpolate without correction between RGBs. + + + + + Apply gamma correction to colors. + + + + + Apply a sigma transfer function to position. + + + + + Add a flat band at the start of the shade. + + + + + This is a one color shade + + + + + A parameter for the band or sigma function can be stored in the top + 16 bits of the value - this is a proportion of *each* band of the + shade to make flat (or the approximate equal value for a sigma + function). NOTE: the parameter is not used for the sigma function, + instead a built in value is used. This value should not be changed + from the default! + + + + + Common Header + The common record header is an 8-byte structure defined in msodr.h as follows: + typedef struct MSOFBH + { + struct + { + ULONG ver : 4; + ULONG inst: 12; + ULONG fbt : 16; + }; + ULONG cbLength; + } MSOFBH; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for _FBSE. + + + + + Required type on Win32 + + + + + Required type on Mac + + + + + Identifier of blip + + + + + currently unused + + + + + Blip size in stream + + + + + Reference count on the blip + + + + + + + + + + How this blip is used (MSOBLIPUSAGE) + + + + + length of the blip name + + + + + for the future + + + + + for the future + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for FOPTE. + + + + + Property ID + + + + + value is a blip ID � only valid if fComplex is FALSE + + + + + complex property, value is lenght + + + + + Value + + + + + + + + + + Member initializing constructor + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for FSP. + + + + + shape ID + + + + + + + + + + + + + + + + + + + + + + + + + + + Shape ID + + + + + + + + + + This shape is a group shape + + + + + Not a top-level shape + + + + + This is the topmost group shape + + + + + The shape has been deleted + + + + + The shape is an OLE object + + + + + Shape has a hspMaster property + + + + + Shape is flipped horizontally + + + + + Shape is flipped vertically + + + + + Connector type of shape + + + + + Shape has an anchor of some kind + + + + + Background shape + + + + + Shape has a shape type property + + + + + Summary description for ImageWriter + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Sets the picture size + + + + + + + + + + + + + + + + + + + + + Closes this instance. + + + + + + + + + + Get imagewriter's data stream + + + + + + + + + + Summary description for ImageReader. + + + + + Interface for reading images from word file. + + + + + Gets image as bitmap. + + + + + + + + + + + + + + + Gets image width. + + + + + Gets image height + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Unparsed data; + + + + + Data stream position + + + + + Initialize class members and parse image from stream + + + + + + + + Update un parsed data + + + + + Gets image name + + + + + Gets/sets image width + + + + + Gets/sets image height + + + + + Gets bitmap + + + + + + + + + + + + + + + Gets inline shape's container. + + + + + + + + + + + + + + + Gets the alternative text. + + The alternative text. + + + + Gets or sets the name. + + + The name. + + + + + Get unparsed data + + + + + Summary description for MetafileBlip. + + + + + + + + + + + + + + + Cache of saved size (size of m_pvBits) + + + + + MSOBLIPCOMPRESSION + + + + + Compressed bits of metafile + + + + + Size of metafile in EMUs + + + + + Boundary of metafile drawing commands + + + + + always msofilterNone + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Closes this instance. + + + + + + + + + + Summary description for MSOFBH. + + + + + Version + + + + + Record instance + + + + + Record type + + + + + Length of record + + + + + Defoult .ctor + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Length of compObject stream + + + + + This MUST be a CompObjHeader structure. + + + + + This MUST be a LengthPrefixedAnsiString structure that contains a display + name of the linked object or embedded object + + + + + This MUST be a ClipboardFormatOrAnsiString structure that contains the + Clipboard Format of the linked object or embedded object. If the MarkerOrLength + field of the ClipboardFormatOrAnsiString structure contains a value other than + 0x00000000, 0xffffffff, or 0xfffffffe, the value MUST NOT be greater than 0x00000190. + Otherwise the CompObjStream structure is invalid + + + + + If present, this MUST be a LengthPrefixedAnsiString structure. If the Length field of + the LengthPrefixedAnsiString contains a value of 0 or a value that is greater than + 0x00000028, the remaining fields of the structure starting with the String field + of the LengthPrefixedAnsiString MUST be ignored on processing. + + + + + If this field is present and is NOT set to 0x71B239F4, + the remaining fields of the structure MUST be ignored on processing + + + + + This MUST be a LengthPrefixedUnicodeString structure that contains a display name + of the linked object or embedded object. + + + + + This MUST be a ClipboardFormatOrUnicodeString structure that contains a Clipboard + Format of the linked object or embedded object. If the MarkerOrLength field of the + ClipboardFormatOrUnicodeString structure contains a value other than 0x00000000, + 0xffffffff, or 0xfffffffe, the value MUST NOT be more than 0x00000190. Otherwise, + the CompObjStream structure is invalid + + + + + This MUST be a LengthPrefixedUnicodeString. The String field of the LengthPrefixedUnicodeString + can contain any arbitrary value and MUST be ignored on processing. + + + + + Initializes a new instance of the class. + + The stream. + + + + Initializes a default instance of the class. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Saves data to STG stream. + + The stream. + + + + Writes the zero byte array. + + The stream. + Length of the byte. + + + + Writes the length prefixed string. + + The stream. + The data. + + + + Gets the size of the structure. + + The length. + + + + Gets the type of the object. + + The type of the object. + + + + Gets the type of the object. + + The type of the object. + + + + + + + + + This can be set to any arbitrary value and MUST be ignored on processing. + + + + + This can be set to any arbitrary value and MUST be ignored on processing. + + + + + This can be set to any arbitrary value and MUST be ignored on processing. + + + + + Initializes a new instance of the class. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Saves to STG stream. + + The stream. + + + + Gets the size of the structure. + + The length. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + The stream. + + + + Initializes a new instance of the class. + + The file path. + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Saves the data to stream. + + The stream. + + + + Gets the size of the structure. + + The length. + + + + + + + + + + + + + + Initializes a new instance of the class. + + The stream. + + + + Initializes a default instance of the class. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Saves the data to stream. + + The STG stream. + + + + Gets the size of the structure. + + The length. + + + + The ole stream name + + + + + + + + + + Initializes a new instance of the class. + + + + + Parses the object pool. + + The object pool stream. + Name of the OLE storage. + + + + Saves the specified stream. + + The stream. + The OLE object. + + + + Saves the specified native data. + + The native data. + The data path. + The OLE object. + + + + Adds the oleobject to the collection + + + + + + Writes the native data. + + The native data. + The data path. + Type of the object. + + + + Writes the native data. + + The native data. + Name of the stream. + + + + Writes the embedded drawing. + + The native data. + + + + Writes the native streams. + + The stream. + + + + Writes the "CompObj" stream. + + Type of the obj. + + + + Writes the "CompObj" stream. + + Type of the obj. + The data path. + + + + Writes the "Ole" stream. + + Type of the link. + Type of the obj. + The data path. + + + + Writes the "ObjInfo" stream. + + Type of the link. + Type of the obj. + + + + Writes the package. + + The native data. + The data path. + + + + Clones this instance. + + + + + + Closes this instance. + + + + + Sets the storage of the oleobject + + + + + Gets or sets the GUID. + + The GUID. + + + + Gets the storage. + + The storage. + + + + Gets the type of the OLE object. + + The type of the OLE. + + + + Gets or sets a value indicating whether this item is cloned. + + + true if cloned; otherwise, false. + + + + + Class performs converting string to OleObjectType enum and vice versa. + + + + + Converts the string to "OleObjectType" + + The OLE type STR. + + + + + Converts the string to "OleObjectType" + + The OLE type STR. + + + + + Gets the GUID for specified type of object. + + The type. + + + + + Implemented alternative method to improve the performance + + + + + + + + Class specifies storage with sub storages and streams. + + + + + Initializes a new instance of the class. + + Name of the storage. + + + + Parses the storages. + + The storage. + + + + Parses the streams. + + The storage. + + + + Writes to storage. + + The storage. + + + + Gets the byte array of the stream + + + + + + + Compare storages + + + + + + + Updates the GUID. + + The CMP file. + The index. + The storage name + + + + Clones this instance. + + + + + + Closes this instance. + + + + + Gets or sets the name of the storage. + + The name of the storage. + + + + Gets the streams. + + The streams. + + + + Gets the storages. + + The storages. + + + + Gets/sets the occurrence of the OleObject + + + + + + + + + + + + + + + + + + + + This MUST be set to 0x00000001 or 0x00000002. If this field has a value of 1, the OLEStream + structure MUST be for a linked object. If this field has a value of 0, then the OLEStream + structure MUST be for an embedded object. + + + + + This field contains an implementation-specific hint supplied by the application or by a + higher-level protocol that creates the data structure. The hint MAY be ignored on + processing of this data structure. + + + + + This MUST be set to 0x00000000. Otherwise, the OLEStream structure is invalid. + + + + + This MUST be set to the size, in bytes, of the ReservedMonikerStream field. + If this field has a value 0x00000000, the ReservedMonikerStream field MUST NOT be present. + + + + + This MUST be a MONIKERSTREAM structure that can contain any arbitrary value + and MUST be ignored on processing. + + + + + This MUST be set to the size, in bytes, of the RelativeSourceMonikerStream field. + If this field has a value 0x00000000, the RelativeSourceMonikerStream field MUST NOT be present. + + + + + This MUST be a MONIKERSTREAM structure that specifies the relative path to the linked object. + + + + + This MUST be set to the size, in bytes, of the AbsoluteSourceMonikerStream field. + This field MUST NOT contain the value 0x00000000. + + + + + This MUST be a MONIKERSTREAM structure that specifies the full path to the linked object. + + + + + This MUST be the LONG value -1 + + + + + This MUST be the CLSID containing the object class GUID of the creating application. + + + + + This MUST be a LengthPrefixedUnicodeString that can contain + any arbitrary value and MUST be ignored on processing. + + + + + This can contain any arbitrary value and MUST be ignored on processing. + + + + + This MUST be a FILETIME that contains the time + when the container application last updated the RemoteUpdateTime field. + + + + + This MUST be a FILETIME that contains the time + when the container application last checked the update time of the linked object. + + + + + This MUST be a FILETIME that contains the time when the linked object was last updated. + + + + + The type of the link; + + + + + Path to linked file + + + + + Initializes a new instance of the class. + + The stream. + + + + Initializes a default instance of the class. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Saves to compound stream. + + The stream. + + + + Gets the size of the structure. + + The length. + + + + + + + + + + + + + + Path to file + + + + + Initializes a new instance of the class. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Gets the size of the structure. + + The length. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Gets the size of the structure. + + The length. + + + + Summary description for PictureShapeProps. + + + + + + + + + + Gets/sets picture brightness. + + + + + Get/set picture contrast. + + + + + Get/set picture color + + + + + Gets or sets the picture's alternative text. + + The alternative text. + + + + Gets or sets the name. + + + The name. + + + + + Summary description for Rect. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for SPContainer. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Default constructor + + + + + Get/set value which defines if + there is a line around textbox shape + + + + + Get/set wrap text mode + + + + + Gets or set a value indicating whether to resize the textbox based on the contents. + + + + + Get/set line style for textbox + + + + + Get/set textbox fill color + + + + + Get/set line color. + + + + + Get/set textbox line width + + + + + Get/set line dashing for textbox + + + + + Get/set TXID value; + + + + + 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. + + + + Gets or sets the bottom margin. + + The bottom margin. + + + + Summary description for MSOBlipType. + + + + + Unknow + + + + + Metafile header then compressed WMF + + + + + Metafile header then compressed EMF + + + + + Metafile header then compressed PICT + + + + + One byte tag then PNG data + + + + + One byte tag then JFIF data + + + + + One byte tag then JPEG data + + + + + One byte tag then DIB data + + + + + Clients should set this bit + + + + + GEL provided types... + + + + + An error occured during loading + + + + + An unknown blip type + + + + + Windows Enhanced Metafile + + + + + Windows Metafile + + + + + Macintosh PICT + + + + + JFIF + + + + + PNG + + + + + Windows DIB + + + + + First client defined blip type + + + + + Last client defined blip type + + + + + Blip usage + + + + + All non-texture fill blips get this. + + + + + + + + + + Since this is stored in a byte + + + + + Blip Foptes + + + + + Blip to display + + + + + Blip file name + + + + + Blip flags + + + + + transparent color (none if ~0UL) + + + + + Draw a dashed line if no line + + + + + + + + + + + + + + + DocInfo contains stream component data blocks. + + + + + Initializes a new instance of the class. + + The streams manager. + + + + Returns WordImageReader depending on the offset + + + offset in Data stream of the current image + + + + + + + + + + Gets the fib. + + + The fib. + + + + + Gets the tables data. + + The tables data. + + + + Gets the FKP data. + + The FKP data. + + + + Gets the image writer. + + The image writer. + + + + Initializes a new instance of the class. + + + + + Initializes this instance. + + + + + Initializes the before reading the document. + + + + + Reads the Fib records from the specified stream. + + The stream. + + + + Reads the Fib records from the decrypted stream. + + The stream. + + + + Reads the Fib records after 64 bytes - cslw from the specified stream. + + The stream. + + + + Validates the cbRgFcLcb. + + + + + Validates the CSW new. + + + + + + + + + + Writes the Fib records to the specified stream. + + The stream. + + + + Writes the internal. + + The stream. + + + + Writes the after encryption. + + The stream. + + + + Updates the fcMac. + + + + + Closes this instance. + + + + + Gets the fib version determined in the Word document as per file format specifications. + + + The fib version. + + + + + Gets or sets an unsigned integer that specifies that this is a Word Binary File. This value MUST be 0xA5EC. + + + The w ident. + + + + + + Gets or sets the unused value. + This value is undefined and MUST be ignored. + + + The BaseUnused. + + + + + Gets or sets a LID that specifies the install language of the application that is producing the document. + If nFib is 0x00D9 or greater, then any East Asian install lid or any install lid with a base language of Spanish, German or French MUST be recorded as lidAmerican. + If the nFib is 0x0101 or greater, then any install lid with a base language of Vietnamese, Thai, or Hindi MUST be recorded as lidAmerican. + + + The lid. + + + + + Gets or sets an unsigned integer that specifies the offset in the WordDocument stream of the FIB for the document which contains all the AutoText items. + If this value is 0, there are no AutoText items attached. Otherwise the FIB is found at file location pnNext�512. + If fGlsy is 1 or fDot is 0, this value MUST be 0. + If pnNext is not 0, each FIB MUST share the same values for FibRgFcLcb97.fcPlcBteChpx, FibRgFcLcb97.lcbPlcBteChpx, FibRgFcLcb97.fcPlcBtePapx, FibRgFcLcb97.lcbPlcBtePapx, and FibRgLw97.cbMac. + + + The pn next. + + + + + Gets or sets a value specifies whether this is a document template (1). + + + true if this is a document template; otherwise, false. + + + + + Gets or sets a value specifies whether this is a document that contains only AutoText items (see FibRgFcLcb97.fcSttbfGlsy, FibRgFcLcb97.fcPlcfGlsy and FibRgFcLcb97.fcSttbGlsyStyle). + + + true if this is a document that contains only AutoText items; otherwise, false. + + + + + Gets or sets a value specifies that the last save operation that was performed on this document was an incremental save operation. + + + true if fComplex; otherwise, false. + + + + + + Gets or sets an unsigned integer. + If nFib is less than 0x00D9, then cQuickSaves specifies the number of consecutive times this document was incrementally saved. + If nFib is 0x00D9 or greater, then cQuickSaves MUST be 0xF. + + + The c quick saves. + + + + + Gets or sets a value specifies whether the document is encrypted or obfuscated as specified in Encryption and Obfuscation. + + + true if the document is encrypted or obfuscated; otherwise, false. + + + + + Gets or sets a value specifies the Table stream to which the FIB refers. When this value is set to 1, use 1Table; when this value is set to 0, use 0Table. + + + true if the Table stream is 1Table; otherwise, false. + + + + + Gets or sets a value specifies whether the document author recommended that the document be opened in read-only mode. + + + true if the document to be opened in read-only mode; otherwise, false. + + + + + Gets or sets a value specifies whether the document has a write-reservation password. + + + true if the document has a write-reservation password; otherwise, false. + + + + + Gets or sets a value indicating ext character. + This value MUST be 1. + + + true if ext character; otherwise, false. + + + + + Gets or sets a value specifies whether to override the language information and font that are specified in the paragraph style at istd 0 (the normal style) with the defaults that are appropriate for the installation language of the application. + + + true if load override; otherwise, false. + + + + + Gets or sets a value specifies whether the installation language of the application that created the document was an East Asian language. + + + true if far east; otherwise, false. + + + + + Gets or sets a value specifies whether the document is obfuscated by using XOR obfuscation. + If fEncrypted is 1, this bit specifies whether the document is obfuscated by using XOR obfuscation (section 2.2.6.1); otherwise, this bit MUST be ignored. + + + true if the document is obfuscated by using XOR obfuscation; otherwise, false. + + + + + + Gets or sets the key. + If fEncrypted is 1 and fObfuscation is 1, this value specifies the XOR obfuscation (section 2.2.6.1) password verifier. + If fEncrypted is 1 and fObfuscation is 0, this value specifies the size of the EncryptionHeader that is stored at the beginning of the Table stream as described in Encryption and Obfuscation. + Otherwise, this value MUST be 0. + + + The l key. + + + + + Gets or sets the envr. + This value MUST be 0, and MUST be ignored. + + + The envr. + + + + + Gets or sets a value indicating whether mac. + This value MUST be 0, and MUST be ignored. + + + true if mac; otherwise, false. + + + + + + Gets or sets a value specifies whether to override the section properties for page size, orientation, and margins with the defaults that are appropriate for the installation language of the application. + + + true if load override page; otherwise, false. + + + + + Gets or sets a value indicating the reserved1. + This value is undefined and MUST be ignored. + + + true if reserved1; otherwise, false. + + + + + Gets or sets a value indicating the reserved2. + This value is undefined and MUST be ignored. + + + true if reserved2; otherwise, false. + + + + + Gets or sets the spare0. + This value is undefined and MUST be ignored. + + + The f spare0. + + + + + Gets or sets a value indicating the reserved3. + This value MUST be 0 and MUST be ignored. + + + The reserved3. + + + + + Gets or sets a value indicating the reserved4. + This value MUST be 0 and MUST be ignored. + + + The reserved4. + + + + + Gets or sets a value indicating the reserved5. + This value is undefined and MUST be ignored. + + + The reserved5. + + + + + Gets or sets a value indicating the reserved6. + This value is undefined and MUST be ignored. + + + The reserved6. + + + + + Gets or sets an unsigned integer that specifies the count of 16-bit values corresponding to fibRgW that follow. MUST be 0x000E. + + + The CSW. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg w reserved1. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg w reserved2. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg w reserved3. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fib rg w reserved4. + + + + + + + + + + + + + + A LID whose meaning depends on the nFib value. Gets or sets the lid fe. + + + The lid fe. + + + + + Gets or sets an unsigned integer that specifies the count of 32-bit values corresponding to fibRgLw that follow. MUST be 0x0016. + + + The CSLW. + + + + + Specifies the count of bytes of those written to the WordDocument stream of the file that have any meaning. Gets or sets the cb mac. + + + The cb mac. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The rg lw reserved1. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The rg lw reserved2. + + + + + Specifies the count of CPs in the main document. Gets or sets the CCP text. + + + The CCP text. + + + + + Specifies the count of CPs in the footnote subdocument. Gets or sets the CCP FTN. + + + The CCP FTN. + + + + + Specifies the count of CPs in the header subdocument. Gets or sets the CCP HDD. + + + The CCP HDD. + + + + + Gets or sets this value MUST be zero and MUST be ignored. + + + The rg lw reserved3. + + + + + Specifies the count of CPs in the comment subdocument. Gets or sets the CCP atn. + + + The CCP atn. + + + + + Specifies the count of CPs in the endnote subdocument. Gets or sets the CCP edn. + + + The CCP edn. + + + + + Specifies the count of CPs in the textbox subdocument of the main document. Gets or sets the CCP TXBX. + + + The CCP TXBX. + + + + + Specifies the count of CPs in the textbox subdocument of the header. Gets or sets the CCP HDR TXBX. + + + The CCP HDR TXBX. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The rg lw reserved4. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The rg lw reserved5. + + + + + Gets or sets the rg lw reserved6. + + + The rg lw reserved6. + + + + + Gets or sets this value is undefined and MUST be ignored + + + The rg lw reserved7. + + + + + Gets or sets this value is undefined and MUST be ignored + + + The rg lw reserved8. + + + + + Gets or sets the rg lw reserved9. + + + The rg lw reserved9. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The rg lw reserved10. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The rg lw reserved11. + + + + + + Gets or sets this value MUST be zero and MUST be ignored. + + + The rg lw reserved13. + + + + + Gets or sets this value MUST be zero and MUST be ignored. + + + The rg lw reserved14. + + + + + Gets or sets an unsigned integer that specifies the count of 64-bit values corresponding to fibRgFcLcbBlob that follow. + This MUST be one of the following values, depending on the value of nFib. + Value of nFib cbRgFcLcb + 0x00C1 0x005D + 0x00D9 0x006C + 0x0101 0x0088 + 0x010C 0x00A4 + 0x0112 0x00B7 + + + The cb rg fc LCB. + + + + the fib rg fc LCB97 fc STSHF original. + Gets or sets This value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc STSHF original. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fib rg fc LCB97 LCB STSHF original. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An STSH that specifies the + style sheet for this document begins at this offset. + + + The fc STSHF. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the STSH that begins at offset + fcStshf in the Table Stream. This MUST be a nonzero value. + + + The LCB STSHF. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcffndRef begins at this + offset and specifies the locations of footnote references in the Main Document, and whether those references + use auto-numbering or custom symbols. If lcbPlcffndRef is zero, fcPlcffndRef is undefined and MUST be + ignored. + + + The fc PLCFFND reference. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcffndRef that begins at offset + fcPlcffndRef in the Table Stream. + + + The LCB PLCFFND reference. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcffndTxt begins at this + offset and specifies the locations of each block of footnote text in the Footnote Document. If lcbPlcffndTxt + is zero, fcPlcffndTxt is undefined and MUST be ignored. + + + The fc PLCFFND text. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcffndTxt that begins at offset + fcPlcffndTxt in the Table Stream. + + + The LCB PLCFFND text. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfandRef begins at this + offset and specifies the dates, user initials, and locations of comments in the Main Document. If + lcbPlcfandRef is zero, fcPlcfandRef is undefined and MUST be ignored. + + + The fc plcfand reference. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfandRef at offset fcPlcfandRef + in the Table Stream. + + + The LCB plcfand reference. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfandTxt begins at this + offset and specifies the locations of comment text ranges in the Comment Document. If lcbPlcfandTxt is zero, + fcPlcfandTxt is undefined, and MUST be ignored. + + + The fc plcfand text. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfandTxt at offset fcPlcfandTxt + in the Table Stream. + + + The LCB plcfand text. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfSed begins at this + offset and specifies the locations of property lists for each section in the Main Document. If lcbPlcfSed is + zero, fcPlcfSed is undefined and MUST be ignored. + + + The LCB plcfand text. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfSed that begins at offset + fcPlcfSed in the Table Stream. + + + The LCB PLCF sed. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc PLC pad. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The fc PLC pad. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Plc at offset fcPlcfPhe in the + Table Stream. + + + The LCB PLCF phe. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A SttbfGlsy that contains + information about the AutoText items that are defined in this document begins at this offset. + + + The fc STTBF glsy. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbfGlsy at offset fcSttbfGlsy + in the Table Stream. If base.fGlsy of the Fib that contains this FibRgFcLcb97 is zero, this value MUST be + zero. + + + The LCB STTBF glsy. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfGlsy that contains + information about the AutoText items that are defined in this document begins at this offset. + + + The fc PLCF glsy. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfGlsy at offset fcPlcfGlsy in + the Table Stream. If base.fGlsy of the Fib that contains this FibRgFcLcb97 is zero, this value MUST be zero. + + + The LCB PLCF glsy. + + + + + Gets or sets An unsigned integer that specifies the offset in the Table Stream where a Plcfhdd begins. The + Plcfhdd specifies the locations of each block of header/footer text in the WordDocument Stream. + + + The fc PLCF HDD. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Plcfhdd at offset fcPlcfHdd in + the Table Stream. If there is no Plcfhdd, this value MUST be zero. A Plcfhdd MUST exist if FibRgLw97.ccpHdd + indicates that there are characters in the Header Document + + + The LCB PLCF HDD. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcBteChpx begins at the + offset. fcPlcfBteChpx MUST be greater than zero, and MUST be a valid offset in the Table Stream. + + + The fc PLCF bte CHPX. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcBteChpx at offset + fcPlcfBteChpx in the Table Stream. lcbPlcfBteChpx MUST be greater than zero. + + + The LCB PLCF bte CHPX. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcBtePapx begins at the + offset. fcPlcfBtePapx MUST be greater than zero, and MUST be a valid offset in the Table Stream. + + + The fc PLCF bte papx. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcBtePapx at offset + fcPlcfBtePapx in the Table Stream. lcbPlcfBteChpx MUST be greater than zero. + + + The LCB PLCF bte papx. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc PLCF sea. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB PLCF sea. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An SttbfFfn begins at this + offset. This table specifies the fonts that are used in the document. If lcbSttbfFfn is 0, fcSttbfFfn is + undefined and MUST be ignored. + + + The fc STTBF FFN. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbfFfn at offset fcSttbfFfn in + the Table Stream. + + + The LCB STTBF FFN. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcFld begins at this + offset and specifies the locations of field characters in the Main Document. All CPs in this PlcFld MUST be + greater than or equal to 0 and less than or equal to FibRgLw97.ccpText. If lcbPlcfFldMom is zero, + fcPlcfFldMom is undefined and MUST be ignored. + + + The fc PLCF field mom. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcFld at offset fcPlcfFldMom in + the Table Stream. + + + The LCB PLCF field mom. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcFld begins at this + offset and specifies the locations of field characters in the Header Document. All CPs in this PlcFld are + relative to the starting position of the Header Document. + + + The fc PLCF field HDR. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcFld at offset fcPlcfFldHdr in + the Table Stream. + + + The LCB PLCF field HDR. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcFld begins at this + offset and specifies the locations of field characters in the Footnote Document. All CPs in this PlcFld are + relative to the starting position of the Footnote Document. + + + The fc PLCF field FTN. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcFld at offset fcPlcfFldFtn in + the Table Stream. + + + The LCB PLCF field FTN. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcFld begins at this + offset and specifies the locations of field characters in the Comment Document. All CPs in this PlcFld are + relative to the starting position of the Comment Document. + + + The fc PLCF field atn. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcFld at offset fcPlcfFldAtn in + the Table Stream. + + + The LCB PLCF field atn. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc PLCF field MCR. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB PLCF field MCR. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An SttbfBkmk that contains + the names of the bookmarks (1) in the document begins at this offset. + + + The fc STTBF BKMK. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbfBkmk at offset fcSttbfBkmk. + + + The LCB STTBF BKMK. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfBkf that contains + information about the standard bookmarks (1) in the document begins at this offset. If lcbPlcfBkf is zero, + fcPlcfBkf is undefined and MUST be ignored. + + + The fc PLCF BKF. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfBkf at offset fcPlcfBkf. + + + The LCB PLCF BKF. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfBkl that contains + information about the standard bookmarks (1) in the document begins at this offset. + + + The fc PLCF BKL. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfBkl at offset fcPlcfBkl. + + + The LCB PLCF BKL. + + + + + Gets or sets An unsigned integer that specifies the offset in the Table Stream of a Tcg that specifies + command-related customizations. If lcbCmds is zero, fcCmds is undefined and MUST be ignored. + + + The fc CMDS. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Tcg at offset fcCmds. + + + The LCB CMDS. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc unused1. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB unused1. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc STTBF MCR. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB STTBF MCR. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. The PrDrvr, which contains + printer driver information (the names of drivers, port, and so on), begins at this offset. + + + The fc pr DRVR. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PrDrvr at offset fcPrDrvr. + + + The LCB pr DRVR. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. The PrEnvPort that is the + print environment in portrait mode begins at this offset. If lcbPrEnvPort is zero, fcPrEnvPort is undefined + and MUST be ignored. + + + The fc pr env port. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PrEnvPort at offset fcPrEnvPort. + + + The LCB pr env port. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. The PrEnvLand that is the + print environment in landscape mode begins at this offset. If lcbPrEnvLand is zero, fcPrEnvLand is undefined + and MUST be ignored. + + + The fc pr env land. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PrEnvLand at offset fcPrEnvLand. + + + The LCB pr env land. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A Selsf begins at this offset + and specifies the last selection that was made in the Main Document. If lcbWss is zero, fcWss is undefined + and MUST be ignored. + + + The fc WSS. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Selsf at offset fcWss. + + + The LCB WSS. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A Dop begins at this offset. + + + The fc dop. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Dopat fcDop. This value MUST NOT + be zero. + + + The LCB dop. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An SttbfAssoc that contains + strings that are associated with the document begins at this offset. + + + The fc STTBF assoc. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbfAssoc at offset fc + SttbfAssoc. This value MUST NOT be zero. + + + The LCB STTBF assoc. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A Clx begins at this offset. + + + The fc CLX. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Clx at offset fcClx in the Table + Stream. This value MUST be greater than zero. + + + The LCB CLX. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc PLCF PGD FTN. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB PLCF PGD FTN. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc autosave source. + + + + + Gets or sets This value MUST be zero and MUST be ignored. + + + The LCB autosave source. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An array of XSTs begins at + this offset. The value of cch for all XSTs in this array MUST be less than 56. The number of entries in this + array is limited to 0x7FFF. + + + The fc GRP XST atn owners. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the XST array at offset + fcGrpXstAtnOwners in the Table Stream. + + + The LCB GRP XST atn owners. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An SttbfAtnBkmk that contains + information about the annotation bookmarks in the document begins at this offset. + + + The fc STTBF atn BKMK. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbfAtnBkmk at offset + fcSttbfAtnBkmk. + + + The LCB STTBF atn BKMK. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc unused2. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB unused2. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc unused3. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB unused3. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfSpa begins at this + offset. The PlcfSpa contains shape information for the Main Document. + + + The fc PLC spa mom. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfSpa at offset fcPlcSpaMom. + + + The LCB PLC spa mom. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfSpa begins at this + offset. The PlcfSpa contains shape information for the Header Document. + + + The fc PLC spa HDR. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfSpa at the offset + fcPlcSpaHdr. + + + The LCB PLC spa HDR. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfBkf that contains + information about annotation bookmarks in the document begins at this offset. If lcbPlcfAtnBkf is zero, + fcPlcfAtnBkf is undefined and MUST be ignored. + + + The LCB PLC spa HDR. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfBkf at offset fcPlcfAtnBkf. + + + The LCB PLCF atn BKF. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfBkl that contains + information about annotation bookmarks in the document begins at this offset. If lcbPlcfAtnBkl is zero, then + fcPlcfAtnBkl is undefined and MUST be ignored. + + + The fc PLCF atn BKL. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfBkl at offset fcPlcfAtnBkl. + + + The LCB PLCF atn BKL. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A Pms, which contains the + current state of a print merge operation, begins at this offset. If lcbPms is zero, fcPms is undefined and + MUST be ignored. + + + The fc PMS. + + + + + Gets or sets An unsigned integer which specifies the size, in bytes, of the Pms at offset fcPms. + + + The LCB PMS. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc form field STTBS. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB form field STTBS. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfendRef that begins at + this offset specifies the locations of endnote references in the Main Document and whether those references + use auto-numbering or custom symbols. + + + The fc plcfend reference. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfendRef that begins at offset + fcPlcfendRef in the Table Stream. + + + The LCB plcfend reference. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfendTxt begins at this + offset and specifies the locations of each block of endnote text in the Endnote Document. If lcbPlcfendTxt + is zero, fcPlcfendTxt is undefined and MUST be ignored. + + + The fc plcfend text. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfendTxt that begins at offset + fcPlcfendTxt in the Table Stream. + + + The LCB plcfend text. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcFld begins at this + offset and specifies the locations of field characters in the Endnote Document. + + + The fc PLCF field edn. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcFld at offset fcPlcfFldEdn in + the Table Stream. + + + The LCB PLCF field edn. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc unused4. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB unused4. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An OfficeArtContent that + contains information about the drawings in the document begins at this offset. + + + The fc DGG information. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the OfficeArtContent at the offset + fcDggInfo. If lcbDggInfo is zero, there MUST NOT be any drawings in the document. + + + The LCB DGG information. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An SttbfRMark that contains + the names of authors who have added revision marks or comments to the document begins at this offset. + + + The fc STTBF r mark. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbfRMark at the offset + fcSttbfRMark. + + + The LCB STTBF r mark. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An SttbfCaption that contains + information about the captions that are defined in this document begins at this offset. + + + The fc STTBF caption. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbfCaption at offset + fcSttbfCaption in the Table Stream. If base.fDot of the Fib that contains this FibRgFcLcb97 is zero, this + value MUST be zero. + + + The LCB STTBF caption. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A SttbfAutoCaption that + contains information about the AutoCaption strings defined in this document begins at this offset. + + + The fc STTBF automatic caption. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbfAutoCaption at offset + fcSttbfAutoCaption in the Table Stream. If base.fDot of the Fib that contains this FibRgFcLcb97 is zero, + this MUST be zero. + + + The LCB STTBF automatic caption. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfWKB that contains + information about all master documents and subdocuments begins at this offset. + + + The fc PLCF WKB. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfWKB at offset fcPlcfWkb in + the Table Stream. If lcbPlcfWkb is zero, fcPlcfWkb is undefined and MUST be ignored. + + + The LCB PLCF WKB. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A Plcfspl, which specifies + the state of the spell checker for each text range, begins at this offset. If lcbPlcfSpl is zero, then + fcPlcfSpl is undefined and MUST be ignored. + + + The fc PLCF SPL. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Plcfspl that begins at offset + fcPlcfSpl in the Table Stream. + + + The LCB PLCF SPL. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcftxbxTxt begins at this + offset and specifies which ranges of text are contained in which textboxes. If lcbPlcftxbxTxt is zero, + fcPlcftxbxTxt is undefined and MUST be ignored. + + + The fc PLCFTXBX text. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcftxbxTxt that begins at offset + fcPlcftxbxTxt in the Table Stream. + + + The LCB PLCFTXBX text. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcFld begins at this + offset and specifies the locations of field characters in the Textbox Document. All CPs in this PlcFld are + relative to the starting position of the Textbox Document. + + + The fc PLCF field TXBX. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcFld at offset fcPlcfFldTxbx in + the Table Stream. + + + The LCB PLCF field TXBX. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfHdrtxbxTxt begins at + this offset and specifies which ranges of text are contained in which header textboxes. + + + The fc PLCF HDRTXBX text. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfHdrtxbxTxt that begins at + offset fcPlcfHdrtxbxTxt in the Table Stream. + + + The LCB PLCF HDRTXBX text. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcFld at offset fcPlcffldHdrTxbx + in the Table Stream. + + + The fc PLCFFLD HDR TXBX. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcFld at offset fcPlcffldHdrTxbx + in the Table Stream. + + + The LCB PLCFFLD HDR TXBX. + + + + + Gets or sets An unsigned integer that specifies an offset into the Table Stream. An StwUser that specifies + the user-defined variables and VBAdigital signature (2), as specified by [MS-OSHARED] section 2.3.2, begins + at this offset. + + + The fc STW user. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the StwUser at offset fcStwUser. + + + The LCB STW user. + + + + + Gets or sets An unsigned integer that specifies an offset into the Table Stream. A SttbTtmbd begins at this + offset and specifies information about the TrueType fonts that are embedded in the document. If lcbSttbTtmbd + is zero, fcSttbTtmbd is undefined and MUST be ignored. + + + The fc STTB TTMBD. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbTtmbd at offset fcSttbTtmbd. + + + The LCB STTB TTMBD. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the RgCdb at offset fcCookieData in + the Table Stream. + + + The LCB cookie data. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated document page layout + cache at offset fcPgdMotherOldOld in the Table Stream. + + + The LCB PGD mother old old. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated document text flow + break cache at offset fcBkdMotherOldOld in the Table Stream. + + + The LCB BKD mother old old. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated footnote layout cache + at offset fcPgdFtnOldOld in the Table Stream. + + + The LCB PGD FTN old old. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated footnote text flow + break cache at offset fcBkdFtnOldOld in the Table Stream. + + + The LCB BKD FTN old old. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated endnote layout cache + at offset fcPgdEdnOldOld in the Table Stream. + + + The LCB PGD edn old old. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated endnote text flow + break cache at offset fcBkdEdnOldOld in the Table Stream. + + + The LCB BKD edn old old. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc STTBF intl field. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB STTBF intl field. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the RouteSlip at offset fcRouteSlip + in the Table Stream. + + + The LCB route slip. + + + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An SttbFnm that contains + information about the external files that are referenced by this document begins at this offset. If + lcbSttbFnm is zero, fcSttbFnm is undefined and MUST be ignored. + + + The fc STTB FNM. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbFnm at the offset fcSttbFnm. + + + The LCB STTB FNM. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlfLst that contains list + formatting information begins at this offset. An array of LVLs is appended to the PlfLst. + + + The fc PLF LST. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlfLst at the offset fcPlfLst. + This does not include the size of the array of LVLs that are appended to the PlfLst. + + + The LCB PLF LST. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlfLfo that contains list + formatting override information begins at this offset. If lcbPlfLfo is zero, fcPlfLfo is undefined and MUST + be ignored. + + + The fc PLF lfo. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlfLfo at the offset fcPlfLfo. + + + The LCB PLF lfo. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcftxbxBkd begins at this + offset and specifies which ranges of text go inside which textboxes. + + + The fc PLCF TXBX BKD. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcftxbxBkd that begins at offset + fcPlcfTxbxBkd in the Table Stream. + + + The LCB PLCF TXBX BKD. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfTxbxHdrBkd begins at + this offset and specifies which ranges of text are contained inside which header textboxes. + + + The fc PLCF TXBX HDR BKD. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfTxbxHdrBkd that begins at + offset fcPlcfTxbxHdrBkd in the Table Stream. + + + The LCB PLCF TXBX HDR BKD. + + + + + + Gets or sets An unsigned integer. If this is nonzero, version-specific undo information exists at offset + fcDocUndoWord9 in the WordDocument Stream. + + + The LCB document undo word9. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the version-specific undo information + at offset fcRgbUse in the WordDocument Stream. + + + The LCB RGB use. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the version-specific undo + information at offset fcUsp in the WordDocument Stream. + + + The LCB usp. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the version-specific undo informatio + at offset fcUskf in the Table Stream. + + + The LCB uskf. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Plc at offset fcPlcupcRgbUse in + the Table Stream. + + + The LCB plcupc RGB use. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Plc at offset fcPlcupcUsp in the + Table Stream. + + + The LCB plcupc usp. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A SttbGlsyStyle, which + contains information about the styles that are used by the AutoText items which are defined in this + document, begins at this offset. + + + The fc STTB glsy style. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbGlsyStyle at offset + fcSttbGlsyStyle in the Table Stream. If base.fGlsy of the Fib that contains this FibRgFcLcb97 is zero, this + value MUST be zero. + + + The LCB STTB glsy style. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlfGosl begins at the + offset. If lcbPlgosl is zero, fcPlgosl is undefined and MUST be ignored. + + + The fc plgosl. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlfGosl at offset fcPlgosl in the + Table Stream. + + + The LCB plgosl. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A RgxOcxInfo that specifies + information about the OLE controls in the document begins at this offset. + + + The fc plcocx. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the RgxOcxInfo at the offset + fcPlcocx. + + + The LCB plcocx. + + + + + + + Gets or sets The low-order part of a FILETIME structure, as specified by [MS-DTYP], that specifies when the + document was last saved. + + + The dw low date time. + + + + + Gets or sets The high-order part of a FILETIME structure, as specified by [MS-DTYP], that specifies when the + document was last saved. + + + The dw high date time. + + + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfAsumy begins at the + offset. If lcbPlcfAsumy is zero, fcPlcfAsumy is undefined and MUST be ignored. + + + The fc PLCF asumy. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfAsumy at offset fcPlcfAsumy + in the Table Stream. + + + The LCB PLCF asumy. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A Plcfgram, which specifies + the state of the grammar checker for each text range, begins at this offset. If lcbPlcfGram is zero, then + fcPlcfGram is undefined and MUST be ignored. + + + The fc PLCF gram. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Plcfgram that begins at offset + fcPlcfGram in the Table Stream. + + + The LCB PLCF gram. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A SttbListNames, which + specifies the LISTNUM field names of the lists in the document, begins at this offset. + + + The fc STTB list names. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbListNames at the offset + fcSttbListNames. + + + The LCB STTB list names. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated, version-specific undo + information at offset fcSttbfUssr in the Table Stream. + + + The LCB STTBF ussr. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfTch at offset fcPlcfTch. + + + The LCB PLCF TCH. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An RmdThreading that specifies the data concerning the e-mail + messages and their authors in this document begins at this offset. + + + The fc RMD threading. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the RmdThreading at the offset fcRmdThreading. This value MUST NOT be zero. + + + The LCB RMD threading. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A double-byte character Unicode string that specifies the + message identifier of the document begins at this offset. This value MUST be ignored. + + + The fc mid. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the double-byte character Unicode string at offset fcMid. This value MUST be ignored. + + + The LCB mid. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A SttbRgtplc that specifies the styles of lists in the document + begins at this offset. If lcbSttbRgtplc is zero, fcSttbRgtplc is undefined and MUST be ignored. + + + The fc STTB RGTPLC. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbRgtplc at the offset fcSttbRgtplc. + + + The LCB STTB RGTPLC. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An MsoEnvelopeCLSID, which specifies the envelope data as + specified by [MS-OSHARED] section 2.3.8.1, begins at this offset. If lcbMsoEnvelope is zero, fcMsoEnvelope is undefined and MUST be ignored. + + + The fc mso envelope. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the MsoEnvelopeCLSID at the offset fcMsoEnvelope. + + + The LCB mso envelope. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A Plcflad begins at this offset and specifies the language + auto-detect state of each text range. If lcbPlcfLad is zero, fcPlcfLad is undefined and MUST be ignored. + + + The fc PLCF lad. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the Plcflad that begins at offset fcPlcfLad in the Table Stream. + + + The LCB PLCF lad. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A variable-length array with elements of type Dofrh begins at that offset. + The elements of this array are records that support the frame set and list style features. If lcbRgDofr is zero, fcRgDofr is undefined and MUST be ignored. + + + The fc rg dofr. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the array that begins at offset fcRgDofr in the Table Stream. + + + The LCB rg dofr. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A PlfCosl begins at the offset. If lcbPlcosl is zero, + fcPlcosl is undefined and MUST be ignored. + + + The fc plcosl. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PlfCosl at offset fcPlcosl in the Table Stream. + + + The LCB plcosl. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PlcfcookieOld at offset fcPlcfcookieOld in the Table Stream. + + + The LCB PLCF cookie old. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated document page layout cache at offset fcPgdMotherOld in the Table Stream. + + + The LCB PGD mother old. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated document text flow break cache at offset fcBkdMotherOld in the Table Stream. + + + The LCB BKD mother old. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated footnote layout cache at offset fcPgdFtnOld in the Table Stream. + + + The LCB PGD FTN old. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated footnote text flow break cache at offset fcBkdFtnOld in the Table Stream. + + + The LCB BKD FTN old. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated endnote layout cache at offset fcPgdEdnOld in the Table Stream. + + + The LCB PGD edn old. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated endnote text flow break cache at offset fcBkdEdnOld in the Table Stream. + + + The LCB BKD edn old. + + + + + Gets or sets the fc unused1. This value is undefined and MUST be ignored. + + + The fc unused1. + + + + + Gets or sets the LCB unused1.This value MUST be zero, and MUST be ignored + + + The LCB unused1. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A PGPArray begins at this offset. + If lcbPlcfPgp is 0, fcPlcfPgp is undefined and MUST be ignored. + + + The fc PLCF PGP. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PGPArray that is stored at offset fcPlcfPgp. + + + The LCB PLCF PGP. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A Plcfuim begins at this offset. + If lcbPlcfuim is zero, fcPlcfuim is undefined and MUST be ignored. + + + The fc plcfuim. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the Plcfuim at offset fcPlcfuim. + + + The LCB plcfuim. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A PlfguidUim begins at this offset. + If lcbPlfguidUim is zero, fcPlfguidUim is undefined and MUST be ignored. + + + The fc plfguid uim. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PlfguidUim at offset fcPlfguidUim. + + + The LCB plfguid uim. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. An AtrdExtra begins at this offset. + If lcbAtrdExtra is zero, fcAtrdExtra is undefined and MUST be ignored. + + + The fc atrd extra. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the AtrdExtra at offset fcAtrdExtra in the Table Stream. + + + The LCB atrd extra. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A PLRSID begins at this offset. + If lcbPlrsid is zero, fcPlrsid is undefined and MUST be ignored. + + + The fc plrsid. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PLRSID at offset fcPlrsid in the Table Stream. + + + The LCB plrsid. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An SttbfBkmkFactoid containing + information about smart tag bookmarks in the document begins at this offset. If lcbSttbfBkmkFactoid is zero, + fcSttbfBkmkFactoid is undefined and MUST be ignored. + + + The fc STTBF BKMK factoid. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the SttbfBkmkFactoid at offset fcSttbfBkmkFactoid. + + + The LCB STTBF BKMK factoid. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfBkfd that contains + information about the smart tag bookmarks in the document begins at this offset. If lcbPlcfBkfFactoid is zero, + fcPlcfBkfFactoid is undefined and MUST be ignored. + + + The fc PLCF BKF factoid. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PlcfBkfd at offset fcPlcfBkfFactoid. + + + The LCB PLCF BKF factoid. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the Plcfcookie at offset fcPlcfcookie in the Table Stream. + + + The LCB plcfcookie. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A Plcfbkld that contains + information about the smart tag bookmarks in the document begins at this offset. If lcbPlcfBklFactoid is zero, + fcPlcfBklFactoid is undefined and MUST be ignored. + + + The fc PLCF BKL factoid. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the Plcfbkld at offset fcPlcfBklFactoid. + + + The LCB PLCF BKL factoid. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A SmartTagData begins + at this offset and specifies information about the smart tag recognizers that are used in this document. + If lcbFactoidData is zero, fcFactoidData is undefined and MUST be ignored. + + + The fc factoid data. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the SmartTagData at offset fcFactoidData in the Table Stream. + + + The LCB factoid data. + + + + + + Gets or sets An unsigned integer. If this value is nonzero, version-specific undo information exists at offset fcDocUndo in the WordDocument Stream. + + + The LCB document undo. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. An SttbfBkmkFcc that contains + information about the format consistency-checker bookmarks in the document begins at this offset. + If lcbSttbfBkmkFcc is zero, fcSttbfBkmkFcc is undefined and MUST be ignored. + + + The fc STTBF BKMK FCC. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the SttbfBkmkFcc at offset fcSttbfBkmkFcc. + + + The LCB STTBF BKMK FCC. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfBkfd that contains + information about format consistency-checker bookmarks in the document begins at this offset. If lcbPlcfBkfFcc is zero, + fcPlcfBkfFcc is undefined and MUST be ignored. + + + The fc PLCF BKF FCC. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PlcfBkfd at offset fcPlcfBkfFcc. + + + The LCB PLCF BKF FCC. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A PlcfBkld that contains information + about the format consistency-checker bookmarks in the document begins at this offset. If lcbPlcfBklFcc is zero, + fcPlcfBklFcc is undefined and MUST be ignored. + + + The fc PLCF BKL FCC. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PlcfBkld at offset fcPlcfBklFcc. + + + The LCB PLCF BKL FCC. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. An SttbfBkmkBPRepairs + that contains information about the repair bookmarks in the document begins at this offset. If lcbSttbfBkmkBPRepairs + is zero, fcSttbfBkmkBPRepairs is undefined and MUST be ignored. + + + The fc STTBFBKMK bp repairs. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the SttbfBkmkBPRepairs at offset fcSttbfBkmkBPRepairs. + + + The LCB STTBFBKMK bp repairs. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A PlcfBkf that contains + information about the repair bookmarks in the document begins at this offset. If lcbPlcfBkfBPRepairs is zero, + fcPlcfBkfBPRepairs is undefined and MUST be ignored. + + + The fc PLCFBKF bp repairs. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PlcfBkf at offset fcPlcfbkfBPRepairs. + + + The LCB PLCFBKF bp repairs. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A PlcfBkl that contains + information about the repair bookmarks in the document begins at this offset. If lcbPlcfBklBPRepairs is zero, + fcPlcfBklBPRepairs is undefined and MUST be ignored. + + + The fc PLCFBKL bp repairs. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PlcfBkl at offset fcPlcfBklBPRepairs. + + + The LCB PLCFBKL bp repairs. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A new Pms, which contains + the current state of a print merge operation, begins at this offset. If lcbPmsNew is zero, fcPmsNew is + undefined and MUST be ignored. + + + The fc PMS new. + + + + + Gets or sets an unsigned integer which specifies the size, in bytes, of the Pms at offset fcPmsNew. + + + The LCB PMS new. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. Office Data Source Object + (ODSO) data that is used to perform mail merge begins at this offset. The data is stored in an array of + ODSOPropertyBase items. The ODSOPropertyBase items are of variable size and are stored contiguously. + The complete set of properties that are contained in the array is determined by reading each ODSOPropertyBase, + until a total of lcbODSO bytes of data are read. If lcbODSO is zero, fcODSO is undefined and MUST be ignored. + + + The fc odso. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the Office Data Source Object data + at offset fcODSO in the Table Stream. + + + The LCB odso. + + + + + + + + + + + Gets or sets the fc unused2.This value is undefined and MUST be ignored. + + + The fc unused2. + + + + + Gets or sets the LCB unused2.This value MUST be zero, and MUST be ignored. + + + The LCB unused2. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A Plcffactoid, which specifies + the smart tag recognizer state of each text range, begins at this offset. If lcbPlcffactoid is zero, fcPlcffactoid + is undefined and MUST be ignored. + + + The fc plcffactoid. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes of the Plcffactoid that begins at offset + fcPlcffactoid in the Table Stream. + + + The LCB plcffactoid. + + + + + + + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An Hplxsdr structure begins + at this offset. This structure specifies information about XML schema definition references. + + + The fc HPLXSDR. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Hplxsdr structure at the offset + fcHplxsdr in the Table Stream. If lcbHplxsdr is zero, then fcHplxsdr is undefined and MUST be ignored. + + + The LCB HPLXSDR. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An SttbfBkmkSdt that contains + information about the structured document tag bookmarks in the document begins at this offset. If lcbSttbfBkmkSdt is zero, then fcSttbfBkmkSdt is undefined and MUST be ignored. + + + The fc STTBF BKMK SDT. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbfBkmkSdt at offset + fcSttbfBkmkSdt. + + + The LCB STTBF BKMK SDT. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcBkfd that contains + information about the structured document tag bookmarks in the document begins at this offset. If + lcbPlcfBkfSdt is zero, fcPlcfBkfSdt is undefined and MUST be ignored. + + + The fc PLCF BKF SDT. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcBkfd at offset fcPlcfBkfSdt. + + + The LCB PLCF BKF SDT. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcBkld that contains + information about the structured document tag bookmarks in the document begins at this offset. If + lcbPlcfBklSdt is zero, fcPlcfBklSdt is undefined and MUST be ignored. + + + The fc PLCF BKL SDT. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcBkld at offset fcPlcfBklSdt. + + + The LCB PLCF BKL SDT. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An array of 16-bit Unicode + characters, which specifies the full path and file name of the XML Stylesheet to apply when saving this + document in XML format, begins at this offset. If lcbCustomXForm is zero, fcCustomXForm is undefined and MUST + be ignored. + + + The fc custom x form. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the array at offset fcCustomXForm in + the Table Stream. This value MUST be less than or equal to 4168 and MUST be evenly divisible by two. + + + The LCB custom x form. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. An SttbfBkmkProt that + contains information about range-level protection bookmarks in the document begins at this offset. If + lcbSttbfBkmkProt is zero, fcSttbfBkmkProt is undefined and MUST be ignored. + + + The fc STTBF BKMK prot. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the SttbfBkmkProt at offset + fcSttbfBkmkProt. + + + The LCB STTBF BKMK prot. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A PlcBkf that contains + information about range-level protection bookmarks in the document begins at this offset. If lcbPlcfBkfProt + is zero, then fcPlcfBkfProt is undefined and MUST be ignored. + + + The fc PLCF BKF prot. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PlcBkf at offset fcPlcfBkfProt. + + + The LCB PLCF BKF prot. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A PlcBkl containing + information about range-level protection bookmarks in the document begins at this offset. If lcbPlcfBklProt + is zero, then fcPlcfBklProt is undefined and MUST be ignored. + + + The fc PLCF BKL prot. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PlcBkl at offset fcPlcfBklProt. + + + The LCB PLCF BKL prot. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A SttbProtUser that specifies + the usernames that are used for range-level protection begins at this offset. + + + The fc STTB prot user. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the SttbProtUser at the offset + fcSttbProtUser. + + + The LCB STTB prot user. + + + + + Gets or sets this value MUST be zero, and MUST be ignored. + + + The fc unused. + + + + + Gets or sets this value MUST be zero, and MUST be ignored. + + + The LCB unused. + + + + + + + + + + + + + + + + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated document page layout + cache at offset fcPgdMother in the Table Stream. + + + The fc PGD mother. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated document text flow + break cache at offset fcBkdMother in the Table Stream. + + + The fc BKD mother. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated document text flow + break cache at offset fcBkdMother in the Table Stream. + + + The LCB BKD mother. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated document author filter + cache at offset fcAfdMother in the Table Stream. + + + The LCB afd mother. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated footnote layout cache + at offset fcPgdFtn in the Table Stream. + + + The LCB PGD FTN. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated footnote text flow + break cache at offset fcBkdFtn in the Table Stream. + + + The LCB BKD FTN. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated footnote author filter + cache at offset fcAfdFtn in the Table Stream. + + + The LCB afd FTN. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated endnote layout cache + at offset fcPgdEdn in the Table Stream. + + + The LCB PGD edn. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated endnote text flow + break cache at offset fcBkdEdn in the Table Stream. + + + The LCB BKD edn. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated endnote author filter + cache at offset fcAfdEdn in the Table Stream. + + + The LCB afd edn. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated AFD structure at + offset fcAfd in the Table Stream. + + + The LCB afd. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc PLCFMTHD. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB PLCFMTHD. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc STTBF BKMK move from. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB STTBF BKMK move from. + + + + + Gets or sets This value is undefined and MUST be ignored + + + The fc PLCF BKF move from. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB PLCF BKF move from. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc PLCF BKL move from. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB PLCF BKL move from. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc STTBF BKMK move to. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB STTBF BKMK move to. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc PLCF BKF move to. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB PLCF BKF move to. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc PLCF BKL move to. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB PLCF BKL move to. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc unused1. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB unused1. + + + + + Gets or sets This value is undefined and MUST be ignored + + + The fc unused2. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB unused2. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc unused3. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB unused3. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc STTBF BKMK arto. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB STTBF BKMK arto. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc PLCF BKF arto. + + + + + Gets or sets This value MUST be zero, and MUST be ignored + + + The LCB PLCF BKF arto. + + + + + Gets or sets Undefined and MUST be ignored. + + + The fc PLCF BKL arto. + + + + + Gets or sets MUST be zero, and MUST be ignored. + + + The LCB PLCF BKL arto. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc arto data. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB arto data. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc unused4. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB unused4. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc unused5. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB unused5. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc unused6. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB unused6. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + + The fc oss theme. + + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc color scheme mapping. + + + + + + Gets or sets an unsigned integer that specifies the count of 16-bit values corresponding to fibRgCswNew that follow. + This MUST be one of the following values, depending on the value of nFib. + Value of nFib cswNew + 0x00C1 0 + 0x00D9 0x0002 + 0x0101 0x0002 + 0x010C 0x0002 + 0x0112 0x0005 + + + The CSW new. + + + + + Gets or sets an unsigned integer that specifies the version number of the file format that is used. + This value MUST be one of the following. + 0x00D9 + 0x0101 + 0x010C + 0x0112 + + + The n fib new. + + + + + Gets or sets an unsigned integer that specifies the number of times that this document was incrementally saved since the last full save. This value MUST be between 0 and 0x000F, inclusively. + + + The c quick saves new. + + + + + Gets or sets the lid theme other. + This value is undefined and MUST be ignored. + + + The lid theme other. + + + + + Gets or sets the lid theme far east. + This value is undefined and MUST be ignored. + + + The lid theme fe. + + + + + Gets or sets the lid theme complex script. + This value is undefined and MUST be ignored. + + + The lid theme cs. + + + + + Gets the size of the encoding character. + + + The size of the encoding character. + + + + + Gets or sets the encoding. + + + The encoding. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The fib. + The stream. + The header/footer char position table. + + + + Writes the specified fib. + + The fib. + The stream. + + + + + + + + + Makes the correction. + + The header/footer char pos table. + The fib. + The stream. + + + + Makes the header correction. + + The header/footer char pos table. + The fib. + + + + + Shifts the char positions in grammar/spelling array. + + if it is grammar, set to true. + The start header CP. + The start shift CP. + The shift value. + + + + + Sets the header/footer separators pos. + + The value. + The start index. + The end index. + if it is grammar, set to true. + + + + Gets the index of position in grammar/spelling aray. + + if it is grammar array, set to true. + The char pos. + + + + + Shifts the positions. + + The start index. + The shift value. + if it is grammar array, set to true. + + + + Updates the grammar/spelling data. + + The stream. + The fib. + + + + Closes this instance. + + + + + Gets or sets the PLCFSPL data. + + The PLCFSPL data. + + + + Gets or sets the plcfgram data. + + The plcfgram data. + + + + Common interface for main IWordReader interface and + IWordSubdocumentReader interface. + + + + + Read next elementary text string*. + + + * - "elementary text string" - string, in which all symbols have the + identical character/paragraph/section properties. + + + + + + Returns interface for reading images from word file. + + + + + + Return object of ShapeClass. + + + + + + + + + + + + + + + + + + + + + + + + Gets document stylesheet. + + + + + Gets current style index. + + + + + Gets current read text chunk type. + + + + + Gets current read text chunk. + + + + + Gets character properties for current text chunk. + + + + + Gets paragraph properties for current text chunk. + + + + + Gets current text position in document + + + + + Gets bookmarks. + + + + + Collection of each row in a table maximum grid value + + + + + Collection of each table's maximum row width + + + + + Interface for forward-only reading data from word file. + + + + + Gets subdocument reader specified type. + + + + + + Reads document header. + + + + + + Reads document end. + + + + + + Returns Bookmark array from word file + + + + + + + + + + + + + + + + + + + + + Gets current section number. + + + + + Gets section properties for current text chunk. + + + + + Gets built-in Document properties + + + + + Gets custom Document properties + + + + + + + + + + Interface for reading data from subdocuments as header/footer, annotations, + footnotes, endnotes, etc. + + + + + Resets subdocument reader state, reading process restarted. + + + + + + + + + + + Gets subdocument reader type. + + + + + Gets current type of header / footer. + ( if Type != WordSubdocument.HeaderFooter returns HeaderType.InvalidValue ) + + + + + + + + + + Summary description for IWordWriter. + + + + + Writes text to word file + + + + + + Writes marker to word file + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Insert image in the document + + + + + + Insert image in the document + + + + + + + + + + + + + + + Insert textbox shape to the document + + Textbox shape's properties + + + + Inserts the form field. + + The fieldcode. + The form field. + + + + Insert start of the bookmark in the document + + + + + + Insert end of the bookmark in the document + + + + + + Inserts the watermark. + + The watermark. + The initialize converter. + Maximal width. + + + + Writes text to word file + + + + + + Inserts the field index entry. + + The field code. + + + + Gets/sets stylesheet. + + + + + Gets/sets index of current style. + + + + + Gets or sets the CHPX + + + The CHPX. + + + + + Gets or sets the break CHPX. + + + The break CHPX. + + + + + Gets or sets a value indicating whether [break CHPX stick properties]. + + + true if [break CHPX stick properties]; otherwise, false. + + + + + Gets or sets a value indicating whether [CHPX stick properties]. + + + true if [CHPX stick properties]; otherwise, false. + + + + + + + + + + Summary description for IWordWriter. + + + + + Writes document header to word file. + + + + + Writes document end to word file. + + + + + Returns interface for writing subdocument. + + + + + + Inserts PageBreak into the document. + + + + + Gets/sets document properties. + + + + + Gets/sets section properties. + + + + + Gets Built-in Document Properties. + + + + + Gets Custom Document Properties. + + + + + Summary description for IWordSubdocumentWriter. + + + + + Writes end of the document. + + + + + + + + + + + + + + + Gets/sets type of subdocument + + + + + Class that encapsulates pointer to unmanaged memory block + and used to convert managed memory block (byte array) + into managed object. + + + + + Default memory block size. + + + + + Minimum memory block size. + + + + + Maximum memory block size. + + + + + Exception message for OutOfMemoryException. + + + + + Pointer to the memory block. + + + + + Size of the memory block. + + + + + Instance of memory converter. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Size of the i memory block. + + + + Ensures that memory block will be able to accept iDesiredSize bytes. + + Bytes that memory block should be able to accept. + + If iDesiredSize is larger than maximum possible memory block size. + + + When was unable to allocate desired memory block size. + + + + + Copies data from arrData into internal memory block. + + Data to copy. + + + + Copies data from arrData into internal memory block starting + from specified index to the end of the array. + + Data to copy. + Start index of the data to copy. + + + + Copies specified number of bytes from arrData into internal memory block starting + from specified index to the end of the array. + + Data to copy. + Start index of the data to copy. + Number of bytes to copy. + + + + Copies data from internal memory block into object. + + Destination object. + + + + Copies data from byte array into specified object. + + Data to copy. + Destination object. + + + + Copies data from byte array into specified object. + + Data to copy. + Start index of the data to copy. + Destination object. + + + + Copies data from byte array into specified object. + + Data to copy. + Start index of the data to copy. + Number of bytes to copy. + Destination object. + + + + Copies data from source object into array of bytes. + + Source object to copy. + Destination array. + Start index in the destination array. + Length of the data to copy. + + + + Close this instance. + + + + + Gets the instance. + + The instance. + + + + This class used for implementing Advanced Encryption Standard algorithm. + + + + + Initializes a new instance of the Aes class. + + Key size. + Key bytes + + + + Initializes this instance. + + + + + Encipher 16 bit input + + 16 bit Input + Output value + + + + Decipher 16-bit input + + + + + + + Sets the nb nk nr. + + Size of the key. + + + + Builds the sbox. + + + + + Builds the inv sbox. + + + + + Builds the rcon. + + + + + Adds the round key. + + The round. + + + + Subs the bytes. + + + + + Invs the sub bytes. + + + + + Shifts the rows. + + + + + Invs the shift rows. + + + + + Mixes the columns. + + + + + Invs the mix columns. + + + + + Keys the expansion. + + + + + Subs the word. + + The word. + + + + + Rots the word. + + The word. + + + + + Possible key sizes. + key size, in bits, for constructor. + + + + + 128-bit. + + + + + 192-bit. + + + + + 256-bit. + + + + + This class is responsible for decryption of Agile encryption (Word 2010/2013) files. + + + + + Segment size. + + + + + Dataspace map. + + + + + Encryption info. + + + + + Compound storage that should be decrypted. + + + + + Intermediate key. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Hashing Algorithm used to compute hash. + + + + + Computes a Hash-based Message Authentication Code (HMAC) using the System.Security.Cryptography.SHA1 hash function. + + + + + Decrypts internal storage. + + Decrypted stream. + + + + Prepares decryptor for actual decryption. + + Compound storage to get required data. + + + + Checks whether password is correct. + + Password to check. + True if password verification succeeded. + + + + Checks the encrypted package. + + The encrypted package. + + + + + Decrypts the specified data. + + The data. + Size of the block. + The arr key. + The IV. + The actual length. + + + + + Parses the transform. + + The data spaces. + + + + Parses the data space map. + + The data spaces. + + + + Parses the transform info. + + The transform storage. + + + + Represents the agile encryption info for Encryption/Decryption of Word 2010/2013 documents. + + + + + A Version structure where Version.vMajor MUST be 0x0004, and Version.vMinor MUST be 0x0004. + + + + + A Reserved 4 bytes, MUST be 0x00000040. + + + + + An XmlEncryptionDescriptor structure that specifies encryption and hashing algorithm. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Default constructor. + + + + + Initializes new instance. + + Stream to get data from. + + + + Serializes object into stream. + + Stream to serialize into. + + + + Gets or sets the version info. + + The version info. + + + + Gets or sets the reserved. + + The reserved. + + + + An XmlEncryptionDescriptor structure that specifies encryption and hashing algorithm. + + + + + This class used to encrypt data using Agile encryption (Word 2010/2013). + + + + + Default version. + + + + + Reserved bytes. + + + + + Segment size. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Hashing Algorithm used to compute hash. + + + + + Computes a Hash-based Message Authentication Code (HMAC) using the System.Security.Cryptography.SHA1 hash function. + + + + + Hashing Algorithm name used to compute hash. + + + + + Encryption key bits. + + + + + Hash size. + + + + + Initializes encryptor for agile encryption. + + + + + Initializes encryptor for agile encryption. + + The hash algorithm. + The key bits. + Size of the hash. + + + + Encrypts specified stream. + + Data to encrypt. + Password to use. + Root storage to put encrypted data into. + + + + Prepares the encryption info. + + The data. + The root. + The password. + + + + Prepares the encrypted package. + + The data. + The root. + The key data. + The intermediate key. + + + + + Initializes the key data. + + The key data. + + + + Initializes the encrypted key. + + The key. + + + + Preparse data spaces structures inside specified storage. + + Storage to put DataSpaces inside. + + + + Serializes VersionInfo stream inside specified storage. + + Storage to serialize VersionInfo into. + + + + Serializes transformation info. + + Storage to serialize into. + + + + Serializes dataspace info. + + Storage to serialize into. + + + + Serializes DataSpaceMap stream. + + Storage to place stream into. + + + + Creates the salt. + + The length. + + + + + Encrypts the specified data. + + The data. + Size of the block. + The key. + The IV. + + + + + Represents the data space definition for Encryption/Decryption of Word documents. + + + + + Default header size. + + + + + Header length. + + + + + List with transform references. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Initializes new instance. + + + + + Initializes new instance of DataSpaceDefinition. + + Stream to get data from. + + + + Serializes dataspace definition into the stream. + + Stream to serialize into. + + + + List with transform references. + + + + + Represents the data space map for Encryption/Decryption of Word documents. + + + + + Size of the header. + + + + + Map entries. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Default constructor. + + + + + Initializes new instance of the DataSpaceMap. + + Stream to get data from. + + + + Serializes dataspace map into the stream. + + Stream to serialize into. + + + + Map entries. + + + + + Represents the data space map entry for Encryption/Decryption of Word documents. + + + + + List of the reference components. + + + + + DataSpace name. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Default constructor. + + + + + Initializes new instance of the map entry. + + Stream to get data from. + + + + Serializes single dataspace map entry into the stream. + + Stream to serialize into. + + + + List of the reference components. + + + + + DataSpace name. + + + + + Represents the data space reference component for Encryption/Decryption of Word documents. + + + + + Component type. + + + + + Component name. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Initializes new instance of the reference component. + + Component type. + Component name. + + + + Initializes new instance of the component reference. + + Stream to get data from. + + + + Serializes object into stream. + + Stream to serialize into. + + + + Component type. + + + + + Component name. + + + + + This class contains utility methods used by Word 2007 and Word 2010 document protection implementation. + + + + + Specifies number of iterations used for key generation. + + + + + Specifies the cryptography type. + + + + + Specifies the cryptographic algorithm class. + + + + + Specifies the cryptographic algorithm type. + + + + + Specifies the cryptographic algorithm id (SHA512). + + + + + Initializes a new instance of the class. + + + + + Computes the hash. + + The salt. + The encrypted password. + + + + + Combines the byte arrays. + + The array1. + The array2. + + + + + Creates the salt. + + The length. + + + + + Represents the encryption header for Encryption/Decryption of Word documents. + + + + + An EncryptionHeaderFlags structure that specifies properties of the encryption algorithm used. + + + + + Reserved, MUST be 0x00000000. + + + + + A signed integer that specifies the encryption algorithm. + + + + + A signed integer that specifies the hashing algorithm in concert with the Flags.fExternal bit. + + + + + An unsigned integer that specifies the number of bits in the encryption key. + MUST be a multiple of 8. + + + + + An implementation specified value which corresponds to constants accepted by + the specified CSP. MUST be compatible with the chosen CSP. + + + + + Undefined and MUST be ignored. + + + + + MUST be 0x00000000 and MUST be ignored. + + + + + A null-terminated Unicode string that specifies the CSP name. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Default constructor. + + + + + Initializes new instance of the header and extracts its data from the stream. + + Stream to get data from. + + + + Extracts item's data from the specified stream. + + Stream to get data from. + + + + Serialize item in the specified stream. + + Stream to serialize data into. + + + + An EncryptionHeaderFlags structure that specifies properties of the encryption algorithm used. + + + + + Reserved, MUST be 0x00000000. + + + + + A signed integer that specifies the encryption algorithm. + + + + + A signed integer that specifies the hashing algorithm in concert with the Flags.fExternal bit. + + + + + An unsigned integer that specifies the number of bits in the encryption key. + MUST be a multiple of 8. + + + + + An implementation specified value which corresponds to constants accepted by + the specified CSP. MUST be compatible with the chosen CSP. + + + + + Undefined and MUST be ignored. + + + + + MUST be 0x00000000 and MUST be ignored. + + + + + A null-terminated Unicode string that specifies the CSP name. + + + + + Represents the encryption transform info for Encryption/Decryption of Word documents. + + + + + Transform name. + + + + + Block size. + + + + + Cipher mode. + + + + + Reserved. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Default constructor. + + + + + Initializes new instance of the class. + + Stream to get data from. + + + + Serializes object into stream. + + Stream. + + + + Transform name. + + + + + Block size. + + + + + Cipher mode. + + + + + Reserved. + + + + + Represents the encryption verifier for Encryption/Decryption of Word documents. + + + + + An array of bytes that specifies the salt value used during password hash + generation. MUST NOT be the same data used for the verifier stored encrypted + in the EncryptedVerifier field. + + + + + MUST be the randomly generated Verifier value encrypted using the algorithm + chosen by the implementation. + + + + + An array of bytes that contains the encrypted form of the hash of the randomly + generated Verifier value. The length of the array MUST be the size of the + encryption block size multiplied by the number of blocks needed to encrypt + the hash of the Verifier. If the encryption algorithm is RC4, the length + MUST be 20 bytes. If the encryption algorithm is AES, the length MUST be 32 bytes. + + + + + Size of the verifier hash. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Default constructor. + + + + + Initializes new instance of the verifier. + + Stream to get data from. + + + + Extracts object from stream. + + Stream to get data from. + + + + Serializes object into stream. + + Stream to serialize into. + + + + An array of bytes that specifies the salt value used during password hash + generation. MUST NOT be the same data used for the verifier stored encrypted + in the EncryptedVerifier field. + + + + + MUST be the randomly generated Verifier value encrypted using the algorithm + chosen by the implementation. + + + + + An array of bytes that contains the encrypted form of the hash of the randomly + generated Verifier value. The length of the array MUST be the size of the + encryption block size multiplied by the number of blocks needed to encrypt + the hash of the Verifier. If the encryption algorithm is RC4, the length + MUST be 20 bytes. If the encryption algorithm is AES, the length MUST be 32 bytes. + + + + + Gets/sets size of the verifier hash. + + + + + Summary description for MD5_CTX. + + + + + + + + + + scratch buffer + + + + + input buffer + + + + + actual digest after MD5Final call + + + + + Updates + + The input buf. + The buffer length. + + + + Finals this instance. + + + + + Stores the digest. + + + + + F(x, y, z) + + The x. + The y. + The z. + + + + + G(x, y, z) + + The x. + The y. + The z. + + + + + H(x, y, z) + + The x. + The y. + The z. + + + + + I(x, y, z) + + The x. + The y. + The z. + + + + + ROTATE_LEFT + + The x. + The n. + + + + + FF + + A. + The b. + The c. + The d. + The x. + The s. + The ac. + + + + GG + + A. + The b. + The c. + The d. + The x. + The s. + The ac. + + + + HH + + A. + The b. + The c. + The d. + The x. + The s. + The ac. + + + + II + + A. + The b. + The c. + The d. + The x. + The s. + The ac. + + + + Transforms the specified inn. + + The inn. + + + + Gets the I. + + The I. + + + + Gets the buffer. + + The buffer. + + + + Gets the input buffer. + + The input buffer. + + + + Gets the digest. + + The digest. + + + + This class contains utility methods used by Word 2007 and Word 2010 Encryption/Decryption implementation. + + + + + Number of iterations used for key generation. + + + + + Name of encryption info stream. + + + + + Name of dataspaces storage. + + + + + Name of dataspace map stream. + + + + + Name of the transform primary stream. + + + + + Name of dataspace info storage. + + + + + Name of transform info storage. + + + + + Name of encrypted package stream. + + + + + Gets the type of the encryption. + + The storage. + + + + + Reads Int32 value from the stream. + + Stream to get data from. + Temporary buffer to put extracted bytes into. + Extracted Int32 value. + + + + Extracts padded unicode string from a stream. + + Stream to get data from. + Extracted string. + + + + Read zero-terminated string from the stream. + + Stream to get string from. + Extracted string (without trailing zero). + + + + Writes Int32 value into the stream. + + Stream to put data into. + Value to write. + + + + Writes padded unicode string from a stream. + + Stream to get data from. + Value to write. + + + + Writes zero-terminated string into the stream. + + Stream to put string into. + Value to write. + + + + Creates key object based on the salt and password. + + Password to use. + Salt to use. + Required key length. + Array with created key. + + + + Creates the agile encryption key. + + The password. + The salt. + The block key. + Length of the key. + The iteration count. + + + + + Encrypts/decrypts buffer with specified method. + + Data to process. + Method to use. + Size of the encryption block. + Modified (encrypted/decrypted) data. + + + + Combines two arrays into one. + + The first buffer to combine. + The second buffer to combine. + Combined array. + + + + Corrects the size. + + The hash buf. + The size. + The padding. + + + + + Concatenates the IV. + + The data. + The IV. + + + + + Compares the array. + + The buffer1. + The buffer2. + + + + + Represents type of the encryption. + + + + + Word 2007 encryption format. + + + + + Word 2010 encryption format. + + + + + Wrong encryption format. + + + + + This class is responsible for decryption of Standard encryption (Word 2007) files. + + + + + Size of the decryption block. + + + + + Dataspace map. + + + + + Encryption info. + + + + + Compound storage that should be decrypted. + + + + + Array containing key data. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Decrypts internal storage. + + Decrypted stream. + + + + Prepares decryptor for actual decryption. + + Compound storage to get required data from. + + + + Checks whether password is correct. + + Password to check. + True if password verification succeeded. + + + + Decrypts specified buffer. + + + + + + + + Extracts transform data from the storage. + + Storage to get data from. + + + + Extracts dataspace map from the storage. + + Storage to get data from. + + + + Extracts TransformInfo from the storage. + + Storage to get data from. + + + + Represents the standard encryption info for Encryption/Decryption of Word documents. + + + + + A Version structure where Version.vMajor MUST be 0x0003, and Version.vMinor MUST be 0x0002. + + + + + A copy of the Flags stored in the EncryptionHeader field of this structure. + + + + + An EncryptionHeader structure that specifies parameters used to encrypt data. + + + + + An EncryptionVerifier structure. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Default constructor. + + + + + Initializes new instance. + + Stream to get data from. + + + + Serializes object into stream. + + Stream to serialize into. + + + + A Version structure where Version.vMajor MUST be 0x0003, and Version.vMinor MUST be 0x0002. + + + + + A copy of the Flags stored in the EncryptionHeader field of this structure. + + + + + An EncryptionHeader structure that specifies parameters used to encrypt data. + + + + + An EncryptionVerifier structure. + + + + + This class used to encrypt data using Standard encryption (Word 2007) with AES 128 + encryption algorithm and SHA-1 hashing algorithm. + + + + + Key length. + + + + + Default version. + + + + + Default flags. + + + + + Encryption algorithm id (AES-128). + + + + + Hashing algorithm id (SHA-1). + + + + + Provider type. + + + + + Default CSP name. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Encrypts specified stream. + + Data to encrypt. + Password to use. + Root storage to put encrypted data into. + + + + Preparse data spaces structures inside specified storage. + + Storage to put DataSpaces inside. + + + + Serializes VersionInfo stream inside specified storage. + + Storage to serialize VersionInfo into. + + + + Serializes transformation info. + + Storage to serialize into. + + + + Serializes dataspace info. + + Storage to serialize into. + + + + Serializes DataSpaceMap stream. + + Storage to place stream into. + + + + Prepare EncryptionInfo record and stores it in appropriate stream. + + Root storage. + Encryption password. + Encryption key. + + + + Creates random salt. + + Desired salt length. + Array with random data. + + + + Encrypts specified buffer. + + Data to encrypt. + Encryption key. + Encrypted data. + + + + Encrypt specified stream. + + Stream to encrypt. + Encryption key. + Output stream. + + + + Represents the transform info header for Encryption/Decryption of Word documents. + + + + + An unsigned integer that specifies the type of transform to be applied. + + + + + An identifier associated with a specific transform. + + + + + The friendly name of the transform. + + + + + The reader version. + + + + + The updater version. + + + + + The writer version. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Default constructor. + + + + + Initializes new instance of the class. + + Stream to get data from. + + + + Serializes object into stream. + + Stream to serialize into. + + + + An unsigned integer that specifies the type of transform to be applied. + + + + + An identifier associated with a specific transform. + + + + + The friendly name of the transform. + + + + + The reader version. + + + + + The updater version. + + + + + The writer version. + + + + + Represents the version information for Encryption/Decryption of Word documents. + + + + + The functionality for which the DataSpaceVersionInfo structure specifies + version information. MUST be "Microsoft.Container.DataSpaces". + + + + + The reader version of the data spaces structure. + + + + + The updater version of the data spaces structure. + + + + + The writer version of the data spaces structure. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Default constructor. + + + + + Serializes object into specified stream. + + Stream to serialize into. + + + + The functionality for which the DataSpaceVersionInfo structure specifies + version information. MUST be "Microsoft.Container.DataSpaces". + + + + + The reader version of the data spaces structure. + + + + + The updater version of the data spaces structure. + + + + + The writer version of the data spaces structure. + + + + + Represents an WordDecryptor. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the [ERROR: invalid expression DeclaringTypeKind]. + + + + + Initializes a new instance of the class. + + The table stream. + The main stream. + The fib. + + + + Tests the encrypt. + + The stream. + + + + + + + + + + + + + + Checks the password. + + The password. + + + + + Decrypts our streams. + + + + + + Decrypts our streams. + + + + + + Decrypts the stream. + + The stream. + if set to true [is main stream]. + + + + + Converts the password. + + + + + Prepares the key. + + The data. + + + + + Makes the key. + + + + + + Compares memory blocks + + The block1. + The block2. + The length. + + + + + Verifies the password. + + + + + + + + + + + Decripts buffer + + The data. + The length. + + + + Gets the password hash. + + The password. + + + + + Reverts the bytes. + + The change val. + + + + + Gets the high order hash. + + The password. + + + + + Gets the low order password hash. + + Password to hash. + Hash value for the password string. + + + + + + + + + + + Converts character to 15 bits sequence + + Character to convert. + + + + Converts bits array to UInt16 value. + + Array to convert. + Converted UInt16 value. + + + + Rotates (cyclic shift) bits in the array specified number of times + + Array to rotate + Number of times to rotate + Rotated array. + + + + + + + + + + + + Gets the table stream. + + The table stream. + + + + Gets the main stream. + + The main stream. + + + + Gets the data stream + + + + + Summary description for Word_key. + + + + + + + + + + + + + + + + + + + + Gets or sets the status. + + The status. + + + + Gets or sets the x. + + The x. + + + + Gets or sets the y. + + The y. + + + + Represents the xml encryption descriptor for Encryption/Decryption of Word 2010/2013 documents. + + + + + Specifies the key data used for Encryption/Decryption. + + + + + Specifies the data integrity used for Encryption/Decryption. + + + + + Specifies the key encryptors used for Encryption/Decryption. + + + + + Default constructor. + + + + + Parses the specified stream. + + The stream. + + + + Serializes object into stream. + + Stream to serialize into. + + + + Create xml writer + + The stream + returns the xml writer + + + + Gets or sets the key data. + + The key data. + + + + Gets or sets the data integrity. + + The data integrity. + + + + Gets or sets the key encryptors. + + The key encryptors. + + + + Represents the key data for Encryption/Decryption of Word 2010 documents. + + + + + Specifies the number of bytes used by salt. + + + + + Specifies the number of bytes used to encrypt one block of data. + + + + + Specifies the number of bits used by encryption algorithm. + + + + + Specifies the number of bytes used by hash value. + + + + + Specifies the cipher algorithm. + + + + + Specifies the chaining mode used by the cipher algorithm. + + + + + Specifies the hashing algorithm. + + + + + Specifies the salt value. + + + + + Default constructor. + + + + + Parses the specified reader. + + The reader. + + + + Retrieves the attribute value from the XmlReader and parses it as an integer. + + + + + Retrieves the attribute value from the XmlReader and parses it as a byte array. + + + + + Serializes the specified writer. + + The writer. + + + + Gets or sets the size of the salt. + + The size of the salt. + + + + Gets or sets the size of the block. + + The size of the block. + + + + Gets or sets the key bits. + + The key bits. + + + + Gets or sets the size of the hash. + + The size of the hash. + + + + Gets or sets the cipher algorithm. + + The cipher algorithm. + + + + Gets or sets the cipher chaining. + + The cipher chaining. + + + + Gets or sets the hash algorithm. + + The hash algorithm. + + + + Gets or sets the salt. + + The salt. + + + + Represents the data integrity for Encryption/Decryption of Word 2010 documents. + + + + + Specifies an encrypted key used for generating the encryptedHmacValue. + + + + + Specifies an HMAC derived from the encryptedHmacKey and the encrypted data. + + + + + Default constructor. + + + + + Parses the specified reader. + + The reader. + + + + Serializes the specified writer. + + The writer. + + + + Gets or sets the encrypted hmac key. + + The encrypted hmac key. + + + + Gets or sets the encrypted hmac value. + + The encrypted hmac value. + + + + Represents the key encryptors for Encryption/Decryption of Word 2010 documents. + + + + + Specifies encrypted key used for Encryption/Decryption. + + + + + Default constructor. + + + + + Parses the specified reader. + + The reader. + + + + Serializes the specified writer. + + The writer. + + + + Gets or sets the encrypted key. + + The encrypted key. + + + + Represents the encrypted key for Encryption/Decryption of Word 2010 documents. + + + + + Specifies the spin count + + + + + Specifies the number of bytes used by salt. + + + + + Specifies the number of bytes used to encrypt one block of data. + + + + + Specifies the number of bits used by encryption algorithm. + + + + + Specifies the number of bytes used by hash value. + + + + + Specifies the cipher algorithm. + + + + + Specifies the chaining mode used by the cipher algorithm. + + + + + Specifies the hashing algorithm. + + + + + Specifies the salt value. + + + + + Specifies the encrypted verifier hash input used in password verification. + + + + + Specifies the encrypted verifier hash value used in password verification. + + + + + Specifies the encrypted form of the intermediate key. + + + + + Default constructor. + + + + + Parses the specified reader. + + The reader. + + + + Serializes the specified writer. + + The writer. + + + + Gets or sets the spin count. + + The spin count. + + + + Gets or sets the size of the salt. + + The size of the salt. + + + + Gets or sets the size of the block. + + The size of the block. + + + + Gets or sets the key bits. + + The key bits. + + + + Gets or sets the size of the hash. + + The size of the hash. + + + + Gets or sets the cipher algorithm. + + The cipher algorithm. + + + + Gets or sets the cipher chaining. + + The cipher chaining. + + + + Gets or sets the hash algorithm. + + The hash algorithm. + + + + Gets or sets the salt. + + The salt. + + + + Gets or sets the encrypted verifier hash input. + + The encrypted verifier hash input. + + + + Gets or sets the encrypted verifier hash value. + + The encrypted verifier hash value. + + + + Gets or sets the encrypted key value. + + The encrypted key value. + + + + Summary description for MainStatePositions. + + + + + Summary description for StatePositionsBase. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The position of first byte of text run. + + + + + The position of last byte of text run. + + + + + FKP data + + + + + + + + + + + + + + + Currents papx/chpx page indexs + + + + + Initializing constructor + + + + + Initialize start/end positions of text run + + + + + Move to next character properties exception + + + + + + Move to next paragraph properties exception + + + + + + Get min end pos from chpx and papx + + + + + + Update end position of chpx + + + + + + Update end position of papx + + + + + + Is it first pass in text run + + + + + + + Is it end of text + + + + + + + + + + + + + + + + + + + + + Check if current position is less then subdocument item text end. + + + + + + + Initializes chpx/papx + + + + + + + + + + + + + + + + + + + + + + + + + Gets current chpx + + + + + + Gets current papx + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets current papx page + + + + + + + + + + + Creates object and fills it's members from fkp + + + + + Move to next section properties exception + + + + + + + Update end position of section + + + + + + + + + + + Gets min end position + + + + + + + + + + + Gets current section properties exception + + + + + + Summary description for HFStatePositions + + + + + Initializing constructor + + + + + + + + + + + + + + + + + + + Summary description for HFStatePositions + + + + + Initializing constructor + + + + + + + + + + + + Move to next header/footer position + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializing constructor + + + + + + + + + + + + + + + + + + + Summary description for HFStatePositions + + + + + Initializing constructor + + + + + + + + + + + + + + + + + + + Main doc textbox state position class + + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + + + + + + + Header/footer textbox state position class + + + + + Initializes a new instance of the class. + + + + + + Moves to text box. + + Index of the Text box. + + + + + + + + + + + + + + + Initializes a new instance of the class. + + Name of the file. + True - create new storage, + false - load existing storage. + + + + Initializes a new instance of the class. + + Name of the stream. + True - create new storage, + false - load existing storage. + + + + + Loads the STG from stream + + + + + + Loads the table stream. + + Table stream name + + + + Loads the SummaryInformation stream + + + + + Loads the DocumentSummaryInformation stream + + + + + Refreshs main and table streams data + + main stream from which to refresh current main stream + table stream from which to refresh current table stream + + + + Writes the sub storage. + + The stream + Name of the storage. + + + + Saves storages data and closes streams + + + + + Closes all streams and binary readers/writers + + + + + Saves the stream. + + The stream name. + The stream. + + + + Saves the stream. + + The stream name. + The stream. + + + + Initialize the streams and writers. + + + + + Loads main, data, macros and object pool streams data + + + + + Loads the stream from compound file. + + The name. + + + + + Loads the sub storage. + + The name. + + + + + Reads some sub storage from the main storage of the document + into the memory stream + + sub storage name + + + + + + + + + + + + Loads stream from storage into memory stream + + the name of the stream + + + + + Gets the storage. + + The storage. + + + + Gets main, table and data streams. + + + + + Gets macros and object pool streams + + + + + Gets or sets the SummaryInformation stream + + + + + Gets or Sets the DocumentSummaryInformation stream + + + + + Gets or sets the SummaryInformation stream writer + + + + + Gets or sets the DocumentSummaryInformation stream writer + + + + + Gets or sets the SummaryInformation stream reader + + + + + Gets or sets the DocumentSummaryInformation stream reader + + + + + Gets the main, table and data writers. + + + + + Gets the main, table and data readers. + + + + + Summary description for WordFKPData. + + + + + + + + + + + + + + + Fills objects by write operations. + + + + + Fills objects by read operation. + + + + + Member initializing constructor + + + + + Gets SectionPropertyException + + + + + Add character properties exception + + + + + + + Add paragraph properties exception + + + + + + + + Add section properties exception + + + + + + + Reads character/paragraph/section properties from stream + + + + + + Writes character/paragraph/section properties exceptions to stream + + + + + + Gets i-th page page with paragraph properties exception. + + + + + + + Gets i-th page page with character properties exception. + + + + + + + Rewrite last Papx to the document + + + + + Rewrite last chpx to the document. + + + + + + Closes this instance. + + + + + Reads array of FKPs from stream according to BinaryTable + + + + + + + + Write all papxs to stream + + + + + + Fill papx page with sprms + + + + + + + + + Gets count of sprms per one page + + + + + + + Write all chpxs to stream + + + + + + Fill chpx page with sprms + + + + + + + + + Gets count of sprms per one page + + + + + + + Check whether Chpx repeats within the specified ranges (chpxIndex to CurrentIndex) + + Chpx Index + Current Index + + + + + Write all sepxs to stream + + + + + + Aligns position in stream to the end of the page + + + + + + + Gets FIB of word file + + + + + + + + + + Gets number of added SectionPropertyExceptions + + + + + + + + + + + + + + + Implemented of IWordReader interface. + + + IWordReader : interface for forward-only reading data from word file. + + + + + Base implementation for WordReader and WordSubdocumentReader classes. + + + + + Used to convert managed memory block (byte array) + into managed object + + + + + DocInfo contains stream component data blocks. + + + + + The index of style, applied to current text chunk. + + + + + Saves all needed positions in stream for current reader + + + + + Initializes a new instance of the class. + + The streams manager. + + + + Hide default constructor. + + + + + Read next elementary text string*. + + + * - "elementary text string" - string, in which all symbols have the + identical character/paragraph/section properties. + + + + + + Get interface for reading images from word file + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get array of Bookmarks from doc file. + + + + + + + + + + + + Closes this instance. + + + + + Saved publicy current stream position. + + + + + If stream position has been saved - restore it. + + + + + Determines whether this instance has list. + + + true if this instance has list; otherwise, false. + + + + + Restores bookmark. + + + + + Updates the bookmarks. + + + + + Class initialization. + + + + + Gets text chunk end position. + + + + + + Updates end position of current chpx/papx + + + + + + Analizing type of text chunk. + + + + + Updates character properties + + + + + Updates paragraph properties + + + + + Reads string from stream using current encoding. + + + + + + Calculates the CP depending on specified startPos and length + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Update the text watermark positions. + + + + + + + + + + + + + + + + Apply shape properties to the watermark picture + + + + + + + + Initialize base shape properties. + + + + + + + + Read textbox properties from SpContainer. + + + + + + + + + + + + + + Read and parse text chunk. + If text chunk consists special symbols - it is splitted. + + + + + + + Checks id chunk includes special characters. + + + + + + Defines if current chunk is "Zero" chunk. + + + + + + + + + + + + Checks if current body belongs to next paragraph item. + + + + + + Counts minimal chunk length with field. + + + + + + + + Checks the current text chunk. + + + + + + Get new chunk length according bookmark. + + + + + + + + Gets the bookmark chunk len. + + The cur doc stream pos. + The end doc stream pos. + + + + + Checks the table bookmark. + + + + + + + + + + + + + + + + + + Checks if current chunk is FieldBeginChunk or FieldEndChunk, + return real length of current chunk. + + + Current chunk length + + + + + + + + + Gets the document version. + + + + + + Gets the pic location. + + + + + + Gets the STTBFR names. + + The STTB. + + + + + Gets index of current style . + + + + + Gets document stylesheet. + + + + + Gets type of current text chunk. + + + + + Current read text chunk. + + + + + + + + + + + + + + + + + + + + + + + + + Gets WPTablesData object. + + + + + Gets current text position relative to document text start(2048). + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the document version. + + The version. + + + + Encoding of current read text chunk. + + + + + + + + + + Gets current style + + + + + Gets the start text position. + + The start text pos. + + + + Gets the end text position. + + The end text pos. + + + + Gets the STTBF r mark author names. + + + The STTBF r mark author names. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains current subdocument reader + + + + + + + + + + + + + + + + + + + + To holds the custom footnote splitted text length, i.e, text before the custome foot note marker + + + + + To holds the revision changes made author names list + + + + + Initializes a new instance of the class. + + The stream. + + + + Initializes a new instance of the class. + + Name of the file. + + + + Gets subdocument reader of specified type. + + + + + + Read header from the document. + + + + + + Reads the Summary information and Document Summary information + + + + + Reads the document properties + + + + + + Read the properties in the PropertySection + + + + + + + + + Read next elementary text string*. + + + * - "elementary text string" - string, in which all symbols have the + identical character/paragraph/section properties. + + + + + + Reads end of the document + + + + + + + + + + + + Closes this instance. + + + + + + + + + + + Freeze position in stream + + + + + Unfreeze position in stream + + + + + Class initialization. + + + + + Updates end positions of CHPx/PAPx/SEP + + + + + + Update section properties to current + + + + + Updates stylesheet data + + + + + Converts characters/paragraphs properties to style properties. + + + + + + + + + + + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + + + + + + + + + + + + + + + + Gets current section number. + + + + + Gets section's properties + + + + + + + + + + + + + + + Get document's Macros data + + + + + + + + + + + + + + + + + + + + + + + + + Custom Footnote splitted text length + + + + + + + + + + + + + + + + + + + + + + + + + Gets the standard/default bidi font + + + + + Gets a value indicating whether the document is encrypted. + + + true if the document is encrypted; otherwise, false. + + + + + Gets or sets the associated strings. + + The associated strings. + + + + Gets or sets the STTBF r mark. + + + The STTBF r mark. + + + + + Gets the STTBF r mark author names. + + + The STTBF r mark author names. + + + + + Summary description for WordRWAdapterBase. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Textbox reader + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Read textbox's shape data ( including FSPA ) + + + + + + + Read image's shape data ( including FSPA ) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Reads the annotation body. + + The reader. + + + + Reads the annotation. + + The reader. + + + + Reads the footnote body. + + The reader. + + + + + + + + + + + + + + + + Summary description for WordStyle. + + + + + + + + Style name + + + + + Style id + + + + + + + + + + Default constructor. + + + + + Initializing constructor + + + + + + + Initializing constructor + + + + + + + + + + + + + + Gets or sets the table style representation + + + + + Gets or sets the type code of the style. + + + + + Gets/sets style id + + + + + Gets/sets style id + + + + + + + + + + Gets style name + + + + + Indicates whether UPEs have been generated. + + + + + Gets or sets the index of the next style. + + The index of the next style. + + + + Gets or sets the index of the link style. + + The index of the link style. + + + + Gets or sets a value indicating whether this instance is primary. + + + true if this instance is primary; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is semi hidden. + + + true if this instance is semi hidden; otherwise, false. + + + + + Gets or sets a value indicating whether unhide when used. + + true if unhide when used; otherwise, false. + + + + Summary description for WordStyleSheet. + + + + + + + + + + Returns true, if the fixed index 13 in stylesheet has style. (other than empty style) + + Reserved styles are applicable only for *.doc format + + + + Returns true, if the fixed index 14 in stylesheet has style. (other than empty style) + + Reserved styles are applicable only for *.doc format + + + + Represents the style name of the style present at the fixed index 13 in the stylesheet + + Reserved styles are applicable only for *.doc format + + + + Represents the style name of the style present at the fixed index 14 in the stylesheet + + Reserved styles are applicable only for *.doc format + + + + List of font names + + + + + Default font names + + + + + List of styles. + + + + + + + + + + + + + + + + + + + + Initializing constructor + + + + + Initializing constructor + + + + + Creates the style. + + The name. + + + + + Create style with specified name + + The name. + if it is character style, set to true. + + + + + + + + + + + + + Adds style to stylesheet + + + + + + + Add empty style to stylesheet + + + + + + Gets style index by specified style name. + + The name. + if it is character, set to true. + + + + + Gets style index by specified style name. + + The name. + + + + + Gets font index by specified font name. + + + + + + + Gets style by specified index. + + + + + + + + + + + + + + + Removes the style by index. + + The index. + + + + Inserts the style. + + The index. + The style. + + + + + + + + + + Updates the name of the font. + + The name. + + + + Add specified font names to collection of font names + + + + + + Clear font name arraylist + + + + + Closes this instance. + + + + + + + + + + + + Gets the stye names. + + The stye names. + + + + Dictionary to hold the font substitution values + + + + + Gets array of font names + + + + + Gets default style index + + + + + Gets number of styles + + + + + Implemented IWordSubdocumentReader interface, used for reading + Word "subdocument parts" as header/footer, footnotes, endnotes, annotations, macros, etc. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates subdocument reader of specified type. + + Main document word reader. + + + + + + + + + + + + + + + + + + + + + Creates object of needed type and fills it with stream positions + + + + + + + + + + + + Initializes class members + + + + + Initializes start/end positioons of reader + + + + + + + + + + + Unfreeze stream position + + + + + The type of subdocument reader. + + + + + Gets/Sets current type of header / footer. + ( if Type != WordSubdocument.HeaderFooter, returns HeaderType.InvalidValue ) + + + + + Gets number of current footnote + + + + + + + + + + Gets a value indicating whether this is next item pos. + + + true if this instance is next item pos; otherwise, false. + + + + + Summary description for HeaderFooter subdocument reader + + + + + Initializes a new instance of the class. + + Main document word reader. + + + + Resets subdocument reader state, reading process restarted. + + + + + Move to specified section + + + + + + Move to specified header in currebt section + + + + + + + + + + + + + + + + + + Reset as it is HeaderFooter reader + + + + + + Creates object and fills it with stream positions. + + + + + Gets HFStatePositions object + + + + + Summary description for HeaderFooter subdocument reader. + + + + + Saves previous position of main stream. + + + + + Creates subdocument reader of specified type. + + Main document word reader. + + + + Creates object and fills it with stream positions. + + + + + Checks current cp position. + + + + + + + + + + + Initialize the state positions. + + + + + Determines the end of footnote items. + + + + + + Read next elementary text string*. + + + + * - "elementary text string" - string, in which all symbols have the + identical character/paragraph/section properties. + + + + + Gets a value indicating whether this body refers to next footnote. + + + true if this body refers to next footnote; otherwise, false. + + + + + Summary description for HeaderFooter subdocument reader. + + + + + Initializes a new instance of the class. + + Main document word reader. + + + + + + + + + + Creates object and fills it with stream positions. + + + + + Gets a value indicating whether this instance is start annotation. + + + true if this instance is start annotation; otherwise, false. + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the position of the annotation. + + The get position. + + + + Summary description for Endnote subdocument reader. + + + + + Initializes a new instance of the class. + + Main document word reader. + + + + Checks current cp position. + + + + + + Initialize reader. + + + + + Initialize the state positions. + + + + + Determines the end of footnote items. + + + + + + + + + + + Initializes a new instance of the class. + + Main document word reader. + + + + Creates object of needed type and fills it with stream positions + + + + + Initializes a new instance of the class. + + Main document word reader. + + + + Creates object of needed type and fills it with stream positions + + + + + + + + + + Summary description for WordWriterBase. + + + + + Fieldshape type value. + + + + + + + + + + Writes text chunk to word file + + + + + + + + + + + + + + + + + + + + + + + + + Writes marker to word file + + + + + + Creates instance of TableBorders + + + + + + + + + + + + + + + + + + + + + Insert field separator. + + + + + + + + + + Inserts the field index entry. + + The field code. + + + + Insert field to the document + + + + + + + + + + + + + + + + + + + + + Insert image + + Picture + Picture height + Picture width + + + + + + + + + + + Insert texbox (shape) to the document + + Textbox format + + + + + Inserts the inline text box. + + The textbox format. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Insert watermark. + + The watermark. + The units converter. + Maximak width. + + + + Initializes a new instance of the class. + + The streams manager. + + + + Default protected constructor. + + + + + Closes this instance. + + + + + + + + + + + Initialize class members with default values + + + + + Writes string to word file + + + + + + + + + + + Adds the papx properties. + + + + + Updates the shading SPRMS. + + The para property exception. + + + + + Writes the symbol. + + The symbol. + + + + Writes character to word file + + + + + + Writes the nested cell/row mark. + + + + + Gets position in text + + + + + + + + + + + + Writes the field start. + + Type of the field. + + + + + Writes the field separator. + + + + + + + + + + + + Write the NilPICFAndBinData + Writes Binary data for reference and hyperlink field + + Field + + + + Removes the formatting strings + + + + + + Write start, end, or separator field descriptor to table stream + + + + + + + Adds the textbox container. + + The textbox format. + + + + Syncronize the textbox container. + + The shape container. + The textbox format. + + + + + + + + + + + + + + + + + + + Updates the containers. + + The old id. + The new id. + The shape container. + + + + + + + + + + Inserts the text watermark. + + The watermark. + The File Shape Address. + The units converter. + + + + + Inserts the picture watermark. + + The watermark. + The File Shape Address. + The units converter. + Max width. + + + + + Fits the watermark picture to page. + + The pic watermark. + Width of the max. + The units converter. + Picture size + + + + Creates the picture watermark container. + + The picture watermark. + The picture container. + + + + + + + + + + Determines whether the image are equal + + Hash value of first image + Hash value of second image + + returns true if image hash are equal. + + + + + Gets/sets stylesheet + + + + + Gets/sets current style index + + + + + Gets or sets a value indicating whether [break CHPX stick properties]. + + + true if [break CHPX stick properties]; otherwise, false. + + + + + Gets or sets a value indicating whether [CHPX stick properties]. + + + true if [CHPX stick properties]; otherwise, false. + + + + + + + + + + + + + + + + + + + + + + + + + Gets the get next text id. + + The get next text id. + + + + Initializing constructor + + + + + + + + + + + + + + + + + + + + + + + + + + Gets/sets type of subdocumnet writer + + + + + Summary description for footnote subdocument writer + + + + + Creates subdocument writer of specified type. + + + + + + Writes the end of the document + + + + + + + + + + + + + + + + Summary description for HeaderFooter subdocument writer + + + + + + + + + + + + + + + + + + + + Creates subdocument reader of specified type. + + + + + + Writes the end of the document + + + + + Writes the end of the section + + + + + Closes the previous separator types. + + + + + + + + + + + + + + + + + Inintializes class members + + + + + + + + + + Gets/sets type of subdocumnet writer + + + + + + + + + + Initializes a new instance of the class. + + + + + + Writes the end of the document + + + + + + + + + + + + + + Summary description for footnote subdocument writer + + + + + Initializes a new instance of the class. + + + + + + + + + + Writes the end of the document + + + + + + + + + + + Textbox reserved data + + + + + + + + + + BreakDescriptor counter + + + + + + + + + + Initializes a new instance of the class. + + + + + + Writes the end of the document + + + + + + + + + + + + Spid of textbox. + + + + Increase ccp on the defined length + + + + + + + + + + + + + Creates subdocument reader of specified type. + + + + + + Write textbox "end" + + + + + Increase header/footer ccp + + + + + + Create TxbxStory and BKD and add it to artObjects + + + + + Summary description for WordWriter. + + + + + Is Last ParagraphEnd for the subdocument + + + + + + + + + + + + + + + Document summary properties members + + + + + + + + + + + + + + + + + + + + + + + + + Creates instance from specified stream + + + + + Creates instance from specified file name + + + + + Writes header of the document to word file + + + + + Gets the subdocument writer of the specified type + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Writes marker to word file + + + + + + + + + + Writes the zero block. + + The size. + + + + Writes the tables. + + + + + Create Summary information for document. + + + + + + + + + + + + + + + + + + + + Adds the sepx properties. + + + + + + + + + + + + + + + + + + + + + + + + + + Gets/sets section properties + + + + + Get/sets name of the author of the application. + + + + + Get/sets name of the author of the application. + + + + + + + + + + + + + + + Get/set document Macros + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets and sets the standard/default bidi font + + + + + + + + + + Gets or sets a value indicating whether the document is template. + + + true if this instance is template; otherwise, false. + + + + + Gets or sets the associated strings. + + The associated strings. + + + + Gets or sets a value indicating whether the document is write protected. + + true if [write protected]; otherwise, false. + + + + + + + + + Summary description for WPStylesData. + + + + + + + + + + Initializing constructor + + + + + + Gets style defintion record by the specified style id + + + + + + + Gets stylesheet information + + + + + Gets stylesheet definitions + + + + + Summary description for WPTablesData. + + + + + Default name for table stream. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents the default CS/Bidi font + + + + + + + + + + Initializes a new instance of the class. + + The fib. + + + + Read structures from stream + + + + + + Write member structures to stream + + + + + + + Converts position in text to position in file + + + + + + + Gets array of bookmarks from the document + + + + + + Add section record + + + + + + + Add papx record + + + + + + + Add chpx record + + + + + + + + + + + + + Closes this instance. + + + + + + + + + + + + + + + + + + + + + + + + + + Determines whether the document has the specified type of subdocument. + + Type of the subdocument. + + true if the specified ws type has subdocument; otherwise, false. + + + + + Determines whether this instance has list. + + + true if this instance has list; otherwise, false. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Writes the document properties. + + The stream. + The fib. + + + + + + + + + + + Writes the fields. + + The stream. + The sub document. + + + + + + + + + + + Writes the bookmarks. + + The stream. + The fib. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Writes the art objects. + + The stream. + The fib. + + + + + + + + + + + + + + + + + + Writes the endnotes. + + The fib. + The stream. + + + + / + + + + + + + + + + + + + + Writes the macro commands. + + The fib. + The stream. + + + + + + + + + + + + + + + + + + Contains the shapes. + + The fib. + + + + + Reads the variables. + + The fib. + The stream. + + + + Writes the variables. + + The fib. + The stream. + + + + Reads the table of associated strings. + + The fib. + The stream. + + + + Reads the STTBF r mark. + + The fib. + The stream. + + + + Writes the associated strings. + + The fib. + The stream. + + + + Writes the STTBF r mark. + + The fib. + The stream. + The author. + + + + Updates the STTB structure. + + + + + Writes the RMD threading. + + The stream. + + + + Get artobject's object + + + + + + + + + + + + + + + + + + + + Gets sections table. + + + + + Gets/sets FontFamilyNameStringTable + + + + + Gets/sets stylesheet information + + + + + Gets/sets array of style definition records. + + + + + Gets header footer character position table. + + + + + Gets chpx BinaryTable + + + + + Gets papx BinaryTable + + + + + Gets/sets header positions + + + + + Gets number of sections + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get/set fields property + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets and sets the standard/default bidi font + + + + + + + + + + Gets or sets the byte array of document variables. + + The variables. + + + + Gets or sets the asociated strings. + + The asociated strings. + + + + Gets or sets the STTBF r mark. + + + The STTBF r mark. + + + + + Implemented alternative method to improve the performance + + + + + + + + Represents a selection of part of text body in the Word document. + + + + + Initializes a new instance of the class with + start paragraph item and end paragraph item. + + The that specifies the start of the selection. + The that specifies the end of the selection. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open the template document + WordDocument document = new WordDocument("Bookmarks.docx", FormatType.Docx); + //Get the text body of first section + WTextBody textbody = document.Sections[0].Body; + //Gets the second paragraph + WParagraph paragraph = textbody.Paragraphs[1]; + //Get the start and end items + ParagraphItem startItem = (ParagraphItem)paragraph.ChildEntities[0]; + ParagraphItem endItem = (ParagraphItem)paragraph.ChildEntities[1]; + //Selects the items in the text body + TextBodySelection selection = new TextBodySelection(startItem, endItem); + //Create new text body part + TextBodyPart textbodyPart = new TextBodyPart(document); + //Copy the selected items + textbodyPart.Copy(selection); + //Paste the selected items. + textbodyPart.PasteAt(textbody, 2); + //Save and close the document. + document.Save("Result.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open the template document + Dim document As New WordDocument("Bookmarks.docx", FormatType.Docx) + 'Get the text body of first section + Dim textbody As WTextBody = document.Sections(0).Body + 'Gets the second paragraph + Dim paragraph As WParagraph = textbody.Paragraphs(1) + 'Get the start and end items + Dim startItem As ParagraphItem = DirectCast(paragraph.ChildEntities(0), ParagraphItem) + Dim endItem As ParagraphItem = DirectCast(paragraph.ChildEntities(1), ParagraphItem) + 'Selects the items in the text body + Dim selection As New TextBodySelection(startItem, endItem) + 'Create new text body part + Dim textbodyPart As New TextBodyPart(document) + 'Copy the selected items + textbodyPart.Copy(selection) + 'Paste the selected items. + textbodyPart.PasteAt(textbody, 2) + 'Save and close the document. + document.Save("Result.docx") + document.Close() + End Sub + + + + + + Initializes a new instance of the class with the textbody, + start paragraph index, end paragraph index, start paragraph item index, and end paragraph item index. + + The instance. + The integer specifying paragraph starting index. + The integer specifying paragraph ending index. + The integer specifying paragraph item starting index in first paragraph. + The integer specifying paragraph item ending index in last paragraph. + + + private void Button1_Click(System.Object sender, System.EventArgs e) + { + //Open the template document + WordDocument document = new WordDocument("Template.docx", FormatType.Docx); + //Get the text body of first section + WTextBody textbody = document.Sections[0].Body; + //Selects the items in the text body + TextBodySelection selection = new TextBodySelection(textbody, 0, 1, 0, 1); + //Create new text body part + TextBodyPart textbodyPart = new TextBodyPart(document); + //Copy the selected items + textbodyPart.Copy(selection); + //Paste the selected items. + textbodyPart.PasteAt(textbody, 2); + //Save and close the document. + document.Save("Sample.docx"); + document.Close(); + } + + + Private Sub button_Click(sender As Object, e As EventArgs) + 'Open the template document + Dim document As New WordDocument("Template.docx", FormatType.Docx) + 'Get the text body of first section + Dim textbody As WTextBody = document.Sections(0).Body + 'Selects the items in the text body + Dim selection As New TextBodySelection(textbody, 0, 1, 0, 1) + 'Create new text body part + Dim textbodyPart As New TextBodyPart(document) + 'Copy the selected items + textbodyPart.Copy(selection) + 'Paste the selected items. + textbodyPart.PasteAt(textbody, 2) + 'Save and close the document. + document.Save("Sample.docx") + document.Close() + End Sub + + + + + + Validates the indexes. + + + + + Gets the of the selection part. Read-only. + + The instance. + + + + Gets or sets the start index of the text body item. + + The zero-based index of the item. + + + + Gets or sets the end index of the text body item. + + The zero-based index of the item. + + + + Gets or sets the start index of the paragraph item. + + The zero-based index of the item. + + + + Gets or sets the end index of the paragraph item. + + The zero-based index of the item. + + + + Represent a selection of text inside paragraph. + + + The following are the limitations in using the class: + + Text selection must be continuous (must not be split). + The selected text should remain within a single paragraph, and will be ignored if it extends to more than one paragraph. + + + + + + + Gets the selection chain. + + The selection chain. + + + + Initializes a new instance of the class. + + The paragraph. + The start char position. + The end char position. + + + + Gets the ranges. + + + + + + Gets as one range. + + + + + + Splits and erase the content of selection. + + + + + Get the collection of text ranges from start text range to the end text range. + + Starting text range element. + + + + Caches the ranges. + + + + + Copies ranges to specified paragraph. + + The paragraph. + The start index. + + + + Copies to the specified inline content control. + + An to insert the items. + Index value to start inserting items. + Represents to save formatting or not. + Source format of the text range. + + + + Returns an enumerator that iterates through a collection. + + + An object that can be used to iterate through the collection. + + + + + Ensures the indexes. + + + + + Gets the items count from their owner of corresponding text range. + + A object, which is refrence to get total items counts in their owner paragraph. + Returns total number of items in the owner of inputed text range. + + + + Splits the ranges. + + + + + Updates the following selections. + + + + + Gets the selected text. Read-only. + + The string that represents the selected text. + + + + Gets or sets the string at the specified index from the + collection. + + The zero-based index of the string to get. + The string at the specified collection. + + + + Gets the number of text chunks in the collection. Read-only. + + The count. + + + + Gets the paragraph owner. + + The paragraph owner. + + + + Gets the start text range. + + The start text range. + + + + Gets the end text range. + + The end text range. + + + + Represents a character encoding. + + + + + Decodes all the bytes in the specified byte array into a string. + + The byte array containing the sequence of bytes to decode. + A string that contains the results of decoding the specified sequence of bytes. + + + + Summary description for DocIOXsdGenerator. + + + + + Summary description for XSDSchemeGenerator. + + + + + + + + + + + + + + + Gets the DLS local schema. + + Returns the DLS local schema. + + + + Generates the DLS schema. + + Returns the DLS schema. + + + + Generates the schema. + + The meta schema. + Returns the XmlSchema. + + + + Gets the resource stream. + + + Name of the res. + The res namespace. + + + + + Gets the DLS resource stream. + + + Name of the res. + + + + + Loads the XML document. + + + The stream. + + + + + Called when [validation]. + + + The sender. + The instance containing the event data. + + + + Parses the type. + + The type node. + + + + Parses the type of the simple. + + The type node. + The mode. + + + + Parses the type of the complex. + + The group. + The type node. + if set to true [is grouping]. + + + + Parses the element. + + The element node. + The group. + + + + Parses the group. + + The group node. + The group. + + + + Parses the attribute. + + The attr node. + The attributes. + + + + Merges the with include. + + The meta schema. + The include schema. + + + + Merges the with include. + + The include schema. + The meta schema. + Name of the tags. + + + + constant string value. + + + + + + Returns Schema of DocIO. + + Returns the Schema in XML format. + + + + Generates Schema for DocIO. + + Returns the Schema in XML format. + + + + Gets the doc IO resource stream. + + + Name of the res. + + + + + Returns Stream for a specified resource. + + + Specifies resource Name. + Specified Resource NameSpace. + + + + + The class WordColor implements routines working with Color. + + + + + + + + + + + + + + + Reserved for internal use. + + + + + + + + + + + + + + + Initializes a new instance of the class with known color index. + + The byte index represents the index of the known color. + + + + Converts the HSL to RGB. + + The hue. + The saturation. + The luminance. + + + + + Converts the color by shade. + + The color. + The shade. + + + + + Shades the specified color value. + + The color value. + The shade. + + + + + Converts the color by tint. + + The color. + The tint. + + + + + Applies tint to the specified color value. + + The color value. + The tint. + + + + + Converts based on modulation. + + The value. + The percent. + + + + + Converts based on offset. + + The value. + The percent. + + + + + Converts based on hue. + + The color. + The angle. + + + + Converts based on hue mod. + + The color. + The ratio. + + + + Converts based on hue offset. + + The color. + The angle. + + + + Converts based on lum. + + The color. + The percent. + + + + Converts based on lum mod. + + The color. + The percent. + + + + Converts based on lum offset. + + The color. + The percent. + + + + Converts based on sat. + + The color. + The percent. + + + + Converts based on sat mod. + + The color. + The percent. + + + + Converts based on sat offset. + + The color. + The percent. + + + + Complements the color. + + The color. + + + + + Inverses the color of the gamma. + + The color. + + + + + Converts the RGB to linear RGB. + + The value. + + + + + Gammas the color. + + The color. + + + + + Converts the linear RGB to RGB. + + The value. + + + + + Grays the color. + + The color. + + + + + Inverses the color. + + The color. + + + + + Inverses the specified color value. + + The color value. + + + + + Converts the colorto HSL. + + The color. + The hue. + The saturation. + The luminance. + + + + Converts the color of the HSL to. + + The hue. + The saturation. + The luminance. + + + + + Hues to RGB. + + The n1. + The n2. + The hue. + + + + + Returns the Color value for the specified color ID. + + Specifies color ID. + Returns the Color value. + + + + Converts the Color value as an integer value. + + Specifies Color value. + Returns the corresponding ID value of the color. + + + + Converts the color to RGB. + + Specifies the Color value. + Returns the converted RGB value. + + + + Converts the color to RGB. + + The color. + If set to true ignores alpha channel. + Returns the converted RGB value. + + + + Converts the specified ID value as RGB value. + + Color identification value. + Returns RGB value. + + + + Converts RGB value as int value. + + Specifies RGB value. + Returns the ID value for a specified RGB. + + + + Converts the RGB as Color value. + + RGB Value. + Returns Color value. + + + + Converts the Color as a color ID. + + Specifies Color value. + Returns color ID. + + + + Gets the Color value for a specified ID. + + Specifies Color ID value. + Returns Color value/. + + + + + + + + + + + + + + + + + + + Gets a value indicating whether the specified background color is very dark. + So that text with color automatic in this background will be displayed as white by Microsoft Word. + + The red component value of the background color + The green component value of the background color + The blue component value of the background color + True if the specified background color is very dark; false otherwise. + + + + Gets a value indicating whether the specified background color is not very dark. + So that text with color automatic in this background will be displayed as black by Microsoft Word. + + The background color of the text + True if the specified background color is not very dark; false otherwise. + + + + Gets the a null color. + + + + + Gets Black color. Read-only. + + + + + Gets Blue color. Read-only. + + + + + Gets Cyan color. Read-only. + + + + + Gets Green color. Read-only. + + + + + Gets Magenta color. Read-only. + + + + + Gets Red color. Read-only. + + + + + Gets Yellow color. Read-only. + + + + + Gets White color. Read-only. + + + + + Gets DarkBlue color. Read-only. + + + + + Gets DarkCyan color. Read-only. + + + + + Gets DarkGreen color. Read-only. + + + + + Gets DarkMagenta color. Read-only. + + + + + Gets DarkRed color. Read-only. + + + + + Gets DarkYellow color. Read-only. + + + + + Gets DarkGray color. Read-only. + + + + + Gets LightGray color. Read-only. + + + + + Gets the system Color. Read-only. + + + + + Gets the byte value for a Color. Read-only. + + + + + Gets RGB Color. Read-only. + + + + + Contains classes and enumerations for generating the Word document. + + + + + + ControlChar class represents control characters which are used in binary MS Word document. + + + + + End of non-nested table cell or row character: (char)7 or "\a". + + + + + End of column character: (char)14. + + + + + End of MS Word field character: (char)21. + + + + + Field separator character separates field code from field value. Optional in some fields. + Value: (char)20. + + + + + Start of MS Word field character: (char)19. + + + + + Page break character: (char)12 or "\f". + + + + + End of paragraph character: (char)13. + + + + + End of section character: (char)12 or "\f". + + + + + Carriage return character: "\x000d" or "\r". Same as ParagraphBreak. + + + + + Carriage return followed by line feed character: "\x000d\x000a" or "\r\n". + Not used as such in Microsoft Word documents, but commonly used in text files for + paragraph breaks. + + + + + This is the "o" string used as a default value in text input form fields. + + + + + This is the 'o' character used as a default value in text input form fields. + + + + + Line break string: "\x000b" or "\v". + + + + + Line break character: (char)11. + + + + + Line feed string: "\x000a" or "\n". Same as Line feed. + + + + + Line feed character: (char)10. + + + + + Non-breaking space string: "\x00a0". + + + + + Non-breaking space character: (char)160. + + + + + Tab string: "\x0009" or "\t". + + + + + Tab character: (char)9 or "\t". + + + + + Optional hyphen string. + + + + + Optional hyphen character. + + + + + Space string. + + + + + Space character + + + + + Double Quote character. + + + + + Left Double Quote character. + + + + + Right Double Quote character. + + + + + Double low Quote character. + + + + + Double Quote string. + + + + + Left Double Quote string. + + + + + Right Double Quote string. + + + + + Double low Quote string. + + + + + Non-breaking hyphen string. + + + + + Non-breaking hyphen character. + + + + + End of non-nested table cell or row character: "\x0007" or "\a" + + + + + End of column character: "\x000e". + + + + + Page break character: "\x000c" or "\f". Note it has the same value as SectionBreak. + + + + + End of paragraph character: "\x000d" or "\r". Same as Carriage return. + + + + + End of section character: "\x000c" or "\f". Note it has the same value as PageBreak. + + + + + Summary description for _constants. + + + + + Specifies SaclingFactor of an Image. + + + + + Specifies BitmapScaleFactor. + + + + + Specifies MetafileScaleFactor. + + + + + width of a single line in 1/8 pt, max of 32 pt. + + + + + Number Twips in 1 Point + + + + + Specifies PercentageFactor. + + + + + EMUs in one point + + + + + EMUs in one point + + + + + Hundredths unit + + + + + Thousandths of a percentage. + + + + + Positive Fixed Angle 60000ths of a degree. + + + + + Maximum opaque limit (100%) and 0% transparent. + + + + + Size of the Int32 value. + + + + + Size of the Int16 value. + + + + + Size of the Int64 value. + + + + + Number of bits inside single short value. + + + + + Number of bits inside single byte value. + + + + + Size of the Double value in bytes. + + + + + Microsoft Windows code page + + + + + Represents date time format structure. + + + + + Lakh unit + + + + + Contains Ascii-codes of some special characters + + + + + + End of paragraph character: 0x000d. + + + + + End of the page character: 0x000c. + + + + + End of the column character:0x000e. + + + + + Specifies charcter for Table: 0x0007; + + + + + Specifies charcter for Image: 0x0001; + + + + + Specifies character for Shape: 0x0008. + + + + + Specifies character value for FootNote:0x0002. + + + + + Begining of Field Mark character: 0x0013. + + + + + End of Field Mark character: 0x0015. + + + + + Specifies character value for FieldSeparator: 0x0014. + + + + + Specifies character value for Tab: 0x0009. + + + + + Specifies character value for line break: 0x000b. + + + + + Specifies character value for symbol: 0x0028. + + + + + Specifies value for Annotation: 0x0005. + + + + + Specifies character value for page number: 0x0000. + + + + + Specifies the non breaking hyphen character + + + + + Specifies the soft hyphen character + + + + + Specifies the non breaking space character + + + + + Specifies the Footnotes/Endnotes separator character. + + + + + Specifies the Footnotes/Endnotes continuation separator character. + + + + + Specifies value as string. + + + + + Specifies value as string. + + + + + Array of special symbols. + + + + + Specifies type of break. + + + + + No break with the new section beginning on the next paragraph of the same page. + + + + + Column break with the new section beginning on the next column on the page. + + + + + Section break with the new section beginning on the next page. + + + + + Section break with the new section beginning on the next even-numbered page. + + + + + Section break with the new section beginning on the next odd-numbered page. + + + + + Specifies the type of header or footer. + + + + + Specifies InvalidValue. + + + + + Header for even numbered pages. + + + + + Header for odd numbered pages. + + + + + Footer for even numbered pages. + + + + + Footer for odd numbered pages. + + + + + Header for the first page of the section. + + + + + Footer for the first page of the section. + + + + + Specifies the type of elementary during reading or writing. + + + + + Specifies text element. + + + + + Specifies end of the paragraph. + + + + + Specifies section`s end. + + + + + Specifies page break. + + + + + Specifies column break. + + + + + Specifies document end. + + + + + Specifies an Image. + + + + + Specifies a Shape. + + + + + Specifies Table. + + + + + Specifies row of the table. + + + + + specifies table`s cell. + + + + + Specifies FootNote. + + + + + Specifies field begin mark. + + + + + Specifies separator for a field. + + + + + Specifies field begin end. + + + + + Specifies tab. + + + + + Specifies an annotation. + + + + + Specifies a line break. + + + + + Specifies a symbol. + + + + + Specifies a current page number. + + + + + Specifies end of the document text. + + + + + Specifies the type of sub document. + + + + + Main. + + + + + FootNote. + + + + + HeaderFooter. + + + + + EndNote. + + + + + Annotation. + + + + + TextBox. + + + + + HeaderTextBox. + + + + + Type of subdocument as Header/Footer, Annotation, etc. + + + + + Specifies the file format type to use. + + + + + Microsoft Word 97-2003 document format. + + + + + Microsoft Word 97-2003 template format. + + + + + Microsoft Word document format. + + + + + Microsoft Strict Word document format. + + + + + Microsoft Word 2007 document format. + + + + + Microsoft Word 2010 document format. + + + + + Microsoft Word 2013 document format. + + + + + Microsoft Word 2007 template format. + + + + + Microsoft Word 2010 template format. + + + + + Microsoft Word 2013 template format. + + + + + Microsoft Word template format. + + + + + Microsoft Word 2007 macro enabled file format. + + + + + Microsoft Word 2010 macro enabled file format. + + + + + Microsoft Word 2013 macro enabled file format. + + + + + Microsoft Word macro enabled file format. + + + + + Microsoft Word 2007 macro enabled template format. + + + + + Microsoft Word 2010 macro enabled template format. + + + + + Microsoft Word 2013 macro enabled template format. + + + + + Microsoft Word macro enabled template format. + + + + + Specifies the WordProcessingML (.XML) documents + + Provides Read/Write support for Microsoft Office WordXML format (FlatOPC) documents + Provides read only support for Microsoft Office Word 2003 XML format documents + + + + + Rich text format (RTF). + + + + + Microsoft Windows text format. + + + + + Markdown. + + + + + E-book format. + + This enum is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamrain platforms. + + + + DLS based Xml file format. + + This enum is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform, MVC6 and Xamrain platforms. + + + + Support all Format Types. + + This enum is not supported in Silverlight, WinRT, Windows Phone, Universal, Universal Windows Platform and Xamrain platforms. + + + + Html format + + This enum is not supported in Silverlight, Windows Phone, Universal and Universal Windows Platform applications. + + + + Saves theWord document as an Open Document Textformat. + + + + + Specifies options to stream content to browser. + + + + + Open document directly in browser. + + + + + Save document as attachment to the disk. + + + + + Specifies the type of protection applied to the Word document. + + + + + Allow only comments to be added to the document. + + + + + Allow content to be added to the document only through form fields. + + + + + Allow read-only access to the document. + + + + + Allow only revisions to be made to existing content. + + + + + Do not apply protection to the document. + + + + + Specified the shading texture to use. + + + + + 10 percent shading. + + + + + 12.5 percent shading. + + + + + 15 percent shading. + + + + + 17.5 percent shading. + + + + + 20 percent shading. + + + + + 22.5 percent shading. + + + + + 25 percent shading. + + + + + 27.5 percent shading. + + + + + 2.5 percent shading. + + + + + 30 percent shading. + + + + + 32.5 percent shading. + + + + + 35 percent shading. + + + + + 37.5 percent shading. + + + + + 40 percent shading. + + + + + 42.5 percent shading. + + + + + 45 percent shading. + + + + + 47.5 percent shading. + + + + + 50 percent shading. + + + + + 52.5 percent shading. + + + + + 55 percent shading. + + + + + 57.5 percent shading. + + + + + 5 percent shading. + + + + + 60 percent shading. + + + + + 62.5 percent shading. + + + + + 65 percent shading. + + + + + 67.5 percent shading. + + + + + 70 percent shading. + + + + + 72.5 percent shading. + + + + + 75 percent shading. + + + + + 77.5 percent shading. + + + + + 7.5 percent shading. + + + + + 80 percent shading. + + + + + 82.5 percent shading. + + + + + 85 percent shading. + + + + + 87.5 percent shading. + + + + + 90 percent shading. + + + + + 92.5 percent shading. + + + + + 95 percent shading. + + + + + 97.5 percent shading. + + + + + Horizontal cross shading. + + + + + Dark horizontal cross shading. + + + + + Dark diagonal cross shading. + + + + + Dark diagonal down shading. + + + + + Dark diagonal up shading. + + + + + Dark horizontal shading. + + + + + Dark vertical shading. + + + + + Diagonal cross shading. + + + + + Diagonal down shading. + + + + + Diagonal up shading. + + + + + Horizontal shading. + + + + + No shading. + + + + + Solid shading. + + + + + Vertical shading. + + + + + Nil shading. + + + + + Specifies the type of fields. + + + + + Field type is not Specifies. + + + + + Specifies Addins. + + + + + Offset subsequent text within a line to the left, right, up or down. + + + + + Prompt the user for text to assign to a bookmark. + + + + + The name of the document's author from Summary Info. + + + + + Insert an automatic number. + + + + + Insert an automatic number in legal format. + + + + + Insert an automatic number in outline format. + + + + + Insert an AutoText entry. + + + + + Insert text based on style. + + + + + Insert a delivery point barcode. + + + + + The comments from Summary Info. + + + + + Compares two values. + + + + + The date the document was created. + + + + + Specifies data. + + + + + Insert data from an external database. + + + + + Specified Today`s Date. + + + + + Specified Type as FieldDDE. + + + + + Specified Type as FieldDDEAuto. + + + + + Insert the value of the property. + + + + + Insert the value of the document variable. + + + + + The total document editing time. + + + + + Specifies OLE embedded object. + + + + + Specified Empty Field. + + + + + Specifies Field Expression. + + + + + The document's name. + + + + + The size on disk of the active document. + + + + + Prompt the user for text to insert in the document. + + + + + Specifies FieldType as FootnoteRef. + + + + + Specifies Check box control. + + + + + Specifies Drop Down box control. + + + + + Specifies Text control. + + + + + Calculates the result of an expression. + + + + + Specifies FieldGlossary. + + + + + Specifies GoToButton control. + + + + + Specifies HTMLActiveX control. + + + + + Specifies Hyperlink control. + + + + + Evaluate arguments conditionally. + + + + + Specifies FieldType as Import. + + + + + Specifies FieldType as Export. + + + + + Insert a picture from a file. + + + + + Insert text from a file. + + + + + Create an index. + + + + + Mark an index entry. + + + + + Data from Summary Info. + + + + + The keywords from Summary Info. + + + + + Name of user who last saved the document. + + + + + Linked OLE2 object. + + + + + Insert an element in a list. + + + + + Run a macro. + + + + + Insert a mail merge field. + + + + + The number of the current merge record. + + + + + Merge record sequence number. + + + + + Go to the next record in a mail merge. + + + + + Conditionally go to the next record in a mail merge. + + + + + Insert the number of a footnote or endnote. + + + + + The number of characters in the document. + + + + + The number of pages in the document. + + + + + The number of words in the document. + + + + + Represents an ActiveX control such as a command button etc. + + + + + Insert the number of the current page. + + + + + Insert the number of the page containing the specified bookmark. + + + + + Download commands to a printer. + + + + + The date the document was last printed. + + + + + Stores data for documents converted from other file formats. + + + + + Insert literal text. + + + + + Insert the text marked by a bookmark. + + + + + Create an index, table of contents, table of figures, and/or table of authorities by using multiple documents. + + + + + Insert the number of times the document has been saved. + + + + + The date the document was last saved. + + + + + Insert the number of the current section. + + + + + Insert the total number of pages in the section. + + + + + Insert an automatic sequence number. + + + + + Assign new text to a bookmark. + + + + + Conditionally skip a record in a mail merge. + + + + + Insert the text from a like-style paragraph. + + + + + The document's subject from Summary Info. + + + + + The document's Subscriber from Summary Info. + + + + + Insert a special character + + + + + The name of the template attached to the document. + + + + + The current time. + + + + + The document's title from Summary Info. + + + + + Create a table of authorities. + + + + + Make a table of authorities entry. + + + + + Create a table of contents. + + + + + Make a table of contents entry. + + + + + Address from Tools Options User Info. + + + + + Initials form Tools Options User Info. + + + + + Name from Tools Options User Info. + + + + + Specifies FieldType as Shape. + + + + + Specifies FieldType as BIDIOUTLINE. + + + + + Specifies AddressBlock + + + + + Specifies FieldType as Unknown. + + + + + Specifies the information to be included in the cross-reference. + + + + + Insert text value of the specified item. For example, insert text of the specified heading. + + + + + Insert the word "Above" or the word "Below" as appropriate. + + + + + Insert the page number of the specified bookmark. + + + + + Insert paragraph with as much of its relative position in the outline numbered list as necessary to identify the item. + + + + + Insert paragraph without its relative position in the outline numbered list. + + + + + Insert complete paragraph number. + + + + + Specifies the type of item for which a cross-reference is to be inserted. + + + + + Insert the bookmark text as appropriate. + + + + + Specifies the number style to be used with the caption label text. + + + + + Numbers + + + + + Roman Numerals + + + + + Alphabets + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies the bookmark type to be considered while converting a Word document to PDF. + + + This property is applicable only for Word to PDF conversion in Windows Forms, WPF, ASP.NET Web, ASP.NET MVC, ASP.NET Core and Xamarin platforms. + + + + + Creates a bookmark in the exported document for each Word bookmark. This is the Default ExportBookmarkType. + + + + + Creates a bookmark in the exported document for each Microsoft Office Word heading, which includes only headings within the main document and text boxes not within headers, footers, endnotes, footnotes, or comments. + + + + + Creates no bookmark in the converted PDF document. + + + + + Specifies the position of the caption label text. + + + + + Caption is positioned above the Image. + + + + + Caption is positioned below the image. + + + + + Specifies the view type. + + + + + Specifies that the document will be rendered in the default view of the application. + + + + + Everything that will appear in the printed document appears on the screen. + + + + + Shows the headings and subheadings in the word document. + + + + + Document appears with a dotted line separating the pages and/or document sections. + Columns, drawings, headers/footers, footnotes/endnotes, and comments do not appear. + + + + + Designed to show the word document will look as a web page. + + + + + Specifies the type of zoom. + + + + + Indicates to use the explicit zoom percentage. + + + + + Zoom percentage is automatically recalculated to fit one full page. + + + + + Zoom percentage is automatically recalculated to fit page width. + + + + + Zoom percentage is automatically recalculated to fit text. + + + + + Specifies the Character-Level Whitespace + + + + + Specifies the line numbering mode to apply. + + + + + Line numbering restarts at the start of every page + + + + + Line numbering restarts at the section start. + + + + + Line numbering continuous from the previous section. + + + + + Specifies LineNumberingMode as None. + + + + + Specifies the type of page border to apply. + + + + + Page border applies to all pages. + + + + + Page border applies only to first pages. + + + + + Page border applies to all pages except the first. + + + + + Specifies the position of page border. + + + + + Page border is measured from text. + + + + + Page border is measured from the edge of the page. + + + + + Specifies the type of animation to apply to a font. + + + + + No animation. Default. + + + + + Alternating color and pattern border. + + + + + Black-and-white, blinking background. + + + + + Randomly alternating pattern and color background. + + + + + Rotating black-dashed border. + + + + + Rotating red-dashed border. + + + + + Font shimmers in and out of focus. + + + + + Specifies the outline level to apply to a paragraph. + + + + + Outline level 1. + + + + + Outline level 2. + + + + + Outline level 3. + + + + + Outline level 4. + + + + + Outline level 5. + + + + + Outline level 6. + + + + + Outline level 7. + + + + + Outline level 8. + + + + + Outline level 9. + + + + + No outline level. + + + + + Specifies the Wrapping mode of the frame + + + + + + This value specifies automatic text wrapping. + + + + + This value specifies that there is no text wrapping to either side of the frame. + + + + + This value specifies that text is wrapped around the frame. + + + + + Text is not wrapped around the frame. + + + + + This value specifies that text is tightly wrapped around the frame. + + + + + This value specifies that text is wrapped through the frame, to the contours of the contents of the frame. + + + + + Specifies the horizontal relative position. + + + + + Relative to column. + + + + + Relative to margin. + + + + + Relative to page. + + + + + Specified the vertical relative position. + + + + + Relative to margin. + + + + + Relative to page. + + + + + Relative to paragraph. + + + + + Specifies the absolute horizontal position. + + + + + The object is aligned to the left of the reference origin. + + + + + The object is centered to the reference origin. + + + + + The object is aligned to the right of the reference origin. + + + + + The object is aligned to the inside of the reference origin. + + + + + The object is aligned to the outside of the reference origin. + + + + + Specifies the absolute vertical position. + + + + + No vertical positioning + + + + + The object is aligned to the top of the reference origin. + + + + + The object is aligned to the center of the reference origin. + + + + + The object is aligned to the bottom of the reference origin. + + + + + The object is aligned to the inside of the reference origin. + + + + + The object is aligned to the outside of the reference origin. + + + + + Specifies the dash style for a line. + + + + + Line is solid. + + + + + Line consists of dashes only. + + + + + Line consists of dots only. + + + + + Line is a dash-dot pattern. + + + + + Line is a dash-dot-dot pattern. + + + + + Line consists of dots only. + + + + + Line consists of dashes only. + + + + + Line consists of long dashes only. + + + + + Line is a dash-dot pattern. + + + + + Line is a long dash and short dot pattern. + + + + + Line is a long dash and short dot-dot pattern. + + + + + Specifies the style of the arrowhead at the end of a line. + + + + + No arrowhead. + + + + + Triangular. + + + + + Stealth-shaped. + + + + + Diamond-shaped. + + + + + Oval-shaped. + + + + + Open. + + + + + Specifies the wrap mode. + + + + + Square wrap mode. + + + + + ByPoints wrap mode. + + + + + No wrap mode. + + + + + TopBottom wrap mode. + + + + + Through wrap mode. + + + + + Specifies the value type for the property. + + + + + Specifies Value type as boolean. + + + + + Specifies Value type as date. + + + + + Specifies Value type as float. + + + + + Specifies Value type as double. + + + + + Specifies Value type as integer. + + + + + Specifies Value type as String. + + + + + Specifies Value type as byte array. + + + + + Specifies Value type as ClipData. + + + + + Specifies the type of the property. + + + + + Specifies Property Type as Summary. + + + + + Specifies Property Type as DocumentSummary. + + + + + Specifies Property Type as Custom. + + + + + Specifies a line spacing format to be applied to a paragraph. + + + + + Line spacing is always at least a specified amount. The amount is specified separately. + + + + + Line spacing is only the exact maximum amount of space required. This setting commonly uses less space than single spacing. + + + + + Line spacing determined by the number of lines indicated. + + + + + Specifies the horizontal alignment of a shape. + + + + + The object is explicitly positioned using position properties. + + + + + The object is aligned to the left of the reference origin. + + + + + The object is centered to the reference origin. + + + + + The object is aligned to the right of the reference origin. + + + + + The object is aligned to the inside of the reference origin. + + + + + The object is aligned to the outside of the reference origin. + + + + + Specifies vertical alignment of a shape. + + + + + The object is aligned to the bottom of the reference origin. + + + + + The object is centered relative to the reference origin. + + + + + The object is aligned to the in line of the reference origin. + + + + + The object is aligned to the inside of the reference origin. + + + + + The object is explicitly positioned using position properties. + + + + + The object is aligned to the outside of the reference origin. + + + + + The object is aligned to the top of the reference origin. + + + + + Specifies the text form field type. + + + + + Regular text field. + + + + + Number text field. + + + + + Date text field. + + + + + Current date text field. + + + + + Current time text field. + + + + + Calculation text field. + + + + + Specifies the position of footnotes. + + + + + Footnotes are output at the bottom of each end notes. + + + + + At bottom of current page. + + + + + Beneath current text on each page. + + + + + Specifies the restart index of footnotes. + + + + + Numbering continuous throughout the document. + + + + + Numbering restarts at each section. + + + + + Numbering restarts at each page. + + + + + Specifies the restart index of the endnotes. + + + + + Numbering continuous throughout the document. + + + + + Numbering restarts at each section. + + + + + Specifies the position of the endnotes. + + + + + Display at the end of each section. + + + + + Display at the end of the document. + + + + + Specifies the number format of endnotes and footnotes. + + + + + Arabic format (1, 2, 3, ...). + + + + + Upper case roman format (I, II, III, ...). + + + + + Lower case roman format (i, ii, iii, ...). + + + + + Upper case letters format (A, B, C, ...) . + + + + + Lower case letters format (a, b, c, ...) . + + + + + Specifies the type of the footnote. + + + + + Specifies object is a footnote. + + + + + Specifies object is a endnote. + + + + + Specifies the Type of the FontFamily. + + + + + + Font family is unspecified for this font. + + + + + Roman (Serif). + + + + + Swiss (Sans-serif). + + + + + Swiss (Sans-serif). + + + + + Script (Cursive). + + + + + Decorative (Fantasy). + + + + + Specifies the type of the font pitch request. + + + + + Default pitch. + + + + + Fixed pitch. + + + + + Variable pitch. + + + + + Specifies preferred width type + + + + + + No Preffered Width + + + + + Preferred table width specified as Auto + + + + + Preferred table width specified in percentage + + + + + Preferred table width specified in points + + + + + Specifies the vertical alignment of all text on each line displayed within a paragraph + + + + + Specifies that all text shall be aligned to the top of each character + + + + + Specifies that all text shall be aligned to the center of each character + + + + + Specifies that all text shall be aligned to the baseline of each character + + + + + Specifies that all text shall be aligned to the bottom of each character + + + + + Specifies that all text shall be aligned automatically + + + + + Specifies the text wrapping options for a text box when tight wrapping is set for the text box in the paragraph. + + + + + No lines of the paragraph allow the surrounding text to tightly wrap around their edges. + + + + + All lines of the paragraph allow the surrounding text to tightly wrap to their edges. + + + + + Only the first and last lines of the paragraph allow the surrounding text to tightly wrap around their edges. + + + + + Only the first line of the paragraph allows the surrounding text to tightly wrap around its edges. + + + + + Only the last line of the paragraph allows the surrounding text to tightly wrap around its edges. + + + + + Specifies the drop cap type. + + + + + No drop cap + + + + + Regular drop cap, which is a single letter beginning at the leading edge of the paragraph. + + + + + A drop cap which is in the margin of the page, outside of the paragraph. + + + + + Specifies structure of the clipped data. + + + + + Size of the data. + + + + + Pointer to the data. + + + + + Format of the data. + + + + + Represents Clip data wrapper class. + + + + + Reads the specified PROPVARIANT variable. + + The PROPVARIANT variable. + + + + Reads the specified data. + + The data. + + + + Writes the specified PROPVARIANT variable. + + The PROPVARIANT variable. + + + + Writes to string. + + + Returns the updated string. + + + + + Gets or sets bullet character pattern for the specified list level. + + + + + Gets or sets the string inserted after the number for the specified list level. + + + + + Gets or sets the string inserted before the number for the specified list level. + + + + + Gets or sets the string inserted before the number for the specified list level. + + + + + Gets or sets the string inserted before the number for the specified list level. + + + + + Gets or sets the left margin. + + + + + Gets or sets the text indent. + + + + + Gets/Sets the list level text alignment property + + + + + Closes the instances used in OListStyle + + + + + Gets or sets the name for the list style. + + The string that represents the style name. + + + diff --git a/ZZPDFTest/bin/Debug/Syncfusion.DocToPDFConverter.Base.dll b/ZZPDFTest/bin/Debug/Syncfusion.DocToPDFConverter.Base.dll new file mode 100644 index 00000000..7f35fc35 Binary files /dev/null and b/ZZPDFTest/bin/Debug/Syncfusion.DocToPDFConverter.Base.dll differ diff --git a/ZZPDFTest/bin/Debug/Syncfusion.DocToPDFConverter.Base.xml b/ZZPDFTest/bin/Debug/Syncfusion.DocToPDFConverter.Base.xml new file mode 100644 index 00000000..380764bc --- /dev/null +++ b/ZZPDFTest/bin/Debug/Syncfusion.DocToPDFConverter.Base.xml @@ -0,0 +1,5724 @@ + + + + Syncfusion.DocToPDFConverter.Base + + + + + + + + + + + + + + + + + + + + + + Get Curved Connector path + + + formulaColl.Add("x2","*/ w adj1 100000"); + formulaColl.Add("x1","+/ l x2 2"); + formulaColl.Add("x3","+/ r x2 2"); + formulaColl.Add("y3","*/ h 3 4"); + + + + + + This method is used to get the Curved connector 2 path. + + + + + + This method is used to call the Get Curved Connector 4 path. + + + + + + This method is used to get the curved connector5 path. + + + + + + Get Bent Connector path + + + formulaColl.Add("x1","*/ w adj1 100000"); + + + + + + This method is used to get the bend connector 2 path. + + + + + + This method is used to get the bend connector 4 path. + + + + + + This method is used to get the bend connector 5 path. + + + + + + Gets Rounded Rectangle Path + + + + + + Gets Snip Single Corner Rectangle Path + + + + + + Gets Snip Same Side Corner Rectangle Path + + + + + + Gets Snip Diagonal Corner Rectangle Path + + + + + + Gets Snip And Round Single Corner Rectangle Path + + + + + + Gets Round Single Corner Rectangle Path + + + + + + Gets Round Same Side Corner Rectangle Path + + + + + + Gets Round Diagonal Corner Rectangle Path + + + + + + Get Triangle path + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the right arrow path. + + + + + + Gets the left arrow path. + + + + + + Gets down arrow path. + + + + + + Gets the left right arrow path. + + + + + + Gets the curved right arrow path. + + + + + + Gets the curved left arrow path. + + + + + + Gets the curved up arrow path. + + + + + + Gets the curved down arrow path. + + + + + + Gets up down arrow path. + + + + + + Gets the quad arrow path. + + + + + + Gets the left right up arrow path. + + + + + + Gets the bent arrow path. + + + + + + Gets the U trun arrow path. + + + + + + Gets the left up arrow path. + + + + + + Gets the bent up arrow path. + + + + + + Gets the striped right arrow path. + + + + + + Gets the notched right arrow path. + + + + + + Gets the pentagon path. + + + + + + Gets the chevron path. + + + + + + Gets the right arrow callout path. + + + + + + Gets down arrow callout path. + + + + + + Gets the left arrow callout path. + + + + + + Gets up arrow callout path. + + + + + + Gets the left right arrow callout path. + + + + + + Gets the quad arrow callout path. + + + + + + Gets the circular arrow path. + + + + + + Gets the math plus path. + + + + + + Gets the math minus path. + + + + + + Gets the math multiply path. + + + + + + Gets the math division path. + + + + + + Gets the math equal path. + + + + + + Gets the math not equal path. + + + + + + Gets the flow chart alternate process path. + + + + + + Gets the flow chart predefined process path. + + + + + + Gets the flow chart internal storage path. + + + + + + Gets the flow chart document path. + + + + + + Gets the flow chart multi document path. + + + + + + Gets the flow chart terminator path. + + + + + + Gets the flow chart preparation path. + + + + + + Gets the flow chart manual input path. + + + + + + Gets the flow chart manual operation path. + + + + + + Gets the flow chart connector path. + + + + + + Gets the flow chart off page connector path. + + + + + + Gets the flow chart card path. + + + + + + Gets the flow chart punched tape path. + + + + + + Gets the flow chart summing junction path. + + + + + + Gets the flow chart or path. + + + + + + Gets the flow chart collate path. + + + + + + Gets the flow chart sort path. + + + + + + Gets the flow chart extract path. + + + + + + Gets the flow chart merge path. + + + + + + Gets the flow chart online storage path. + + + + + + Gets the flow chart delay path. + + + + + + Gets the flow chart sequential access storage path. + + + + + + Gets the flow chart magnetic disk path. + + + + + + Gets the flow chart direct access storage path. + + + + + + Gets the flow chart display path. + + + + + + Gets the rectangular callout path. + + + + + + Gets the rounded rectangular callout path. + + + + + + Gets the oval callout path. + + + + + + Gets the cloud callout path. + + + + + + Gets the line callout1 path. + + + + + + Gets the line callout2 path. + + + + + + Gets the line callout3 path. + + + + + + Gets the line callout1 accent bar path. + + + + + + Gets the line callout2 accent bar path. + + + + + + Gets the line callout3 accent bar path. + + + + + + Gets the line callout1 no border path. + + + + + + Gets the line callout2 no border path. + + + + + + Gets the line callout3 no border path. + + + + + + Gets the line callout1 border and accent bar path. + + + + + + Gets the line callout2 border and accent bar path. + + + + + + Gets the line callout3 border and accent bar path. + + + + + + Gets the VML custom shape path path. + + + + + + Gets a custom shape (DrawingML) GraphicPath. + + Represent a bounds of custom shape. + Represent a GraphicPath/PdfPath object. + Represent a custom shape object. + Returns a GraphicPath/PdfPath with custom shape drawing points. + + + + Gets a geometry path of Path2D. + + Represent a GraphicPath. + Represent a input path elements. + Represent a width of Path. + Represent a height of Path. + Represent a bounds of Path. + + + + Gets a X value of Path. + + Represent a width of Path. + Represent a X value. + Represent a bounds of Path. + Returns a X value. + + + + Gets a Y value of Path. + + Represent a height of Path. + Represent a Y value. + Represent a bounds of Path. + Returns a Y value. + + + + Convert the path element of custom shape + + Represent a path element to convert. + Represent a converted path elements. + Represent a formula collection. + Represent a path object. + Represent formula with its values. + + + + Gets a new GraphicsPath object. + + Returns a new GraphicsPath object. + + + + + + + + + + + + + + + + + + + Get Path adjust value + + + + + + + Parse Shape Formula + + + + + + + Gets Formula Values + + + + + + + + + Gets Operand Values + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents the class which acts as an drawing context. + + + + + The default script factor for sub/super script. + + + + + The default factor values to fit the DinOffc font text into the corresponding font grid. + /// + + + + The default font size. + + + + + The default minimum font size for picture bullet. + + + + + The default scale factor for picture bullet. + + + + + Drawing Graphics. + + + + + Image Quality. + + + + + PreserveFormFields. + + + + + PdfFont collection + + + + + This collection contains the Pdf fonts which are created by SubstitutedFont event streams. + + + + + Drawing Graphics. + + + + + Holds the list of hyperlinks and its corrsponding bounds. + + + + + Used to skip a text highlighter between the comment ranges. + + + + + Auto tag index + + + + + Skips the bookmark add for all the textrange of paragraph. + + + + + We have hold the underline style properties and bounds to draw a line. + using this dictionary, we have draw the line after the text drawn. + + + + + We have hold the Strike-Through properties and bounds to draw a line. + using this dictionary, we have draw the line after the text drawn. + + + + + Clear the font cache. + + + + + Initializes a new instance of the PDFDrawingContext class. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the PDFDrawingContext class. + + The graphics. + The page unit. + The page unit. + The page unit. + + + + Draws the Overlapping shape widgets. + Currently handled only for Docx format documents + + + + + Create pdf font and maintain it in the collection, To improve the performance + + + + + + + + + + Paragraph has a color which is mismatched from the next sibling paragraph color + + + + + Create Auto tag. + + + + + + + + + + Creates Pdf structure element for headings and paragraph. + + The paragraph. + The layouted widge. + + + + + Gets the Pdf tag type enum value for heading style. + + The outline level of the heading style. + + + + + Creates Pdf structure element for table, table row and table data. + + The lt widget. + The owner widget. + The cell widget. + + + + Draws the paragraph. + + The paragraph. + The lt widget. + + + + Draws the text box. + + The text box. + The lt widget. + + + + We have handle for rotated childshapes. + + clipbounds value + return the clipbounds value + + + + Draw Bar Tab Stop of the paragraph + + + + + + + Get bounds to draw a paragraph back ground color and texture styles + + + + + + + + + + + Check whether Paragraph Containing list has break. + + ltWidget + + + + + Get the base entity + + + + + + + Get the text top position + + Represent the text + Represent the font + Represent the size + Return the Text drawing y position + + + + Decides whether, we should update the tab position or not. + + The widget. + Index of the entity. + + + + Updates the tab position. + + The widget. + The client area. + + + + Updates the decimal tab position. + + The lt widget. + The client area. + + + + Updates the decimal tab position in cell. + + The lt widget. + The client area. + + + + Determine whether is Decimal Tab Start + + + + + + + + + + + + Get Width To Shift the xposition of childwidget + + + + + + + + + + Get the paragraph format for current tab + + The Paragraph + Paragrph format + + + + Get Column Width + + The Paragraph + + + + + Get Left width of the Decimal seperator + + + + + + + + + Get Left width of the Decimal seperator + + The lt widget. + The decimal tab start. + The decimal tab end. + + + + + Get Index of Decimal Separator + Index denotes the TextRange which have a decimal separator + + + + + + + + + + + + Get Index of Decimal Separator + Index denotes the TextRange which have a decimal separator + + The lt widget. + The decimal tab start. + The decimal tab end. + Width of the left. + The decimal separator. + if set to true [is separator]. + + + + + Determine whether is Decimal Separator + + + + + + + + + Get Owner paragraph of the LayoutedWidget + + + + + + + Gets the tab end index. + Index denotes the item, previous of next subsequent tab. + + The lt widget. + The start index. + + + + + Get the current list size. + + + + + + + + + Draws the list. + + Paragraph + Layouted Widget + List Format + + + + Draws the list tab leader. + + The paragraph. + The paragraph info. + Width of the list. + The x position. + The y position. + + + + Gets the tab leader. + + The paragraph info. + + + + + Gets the ascet value for Equation field. + + Equation field + + + + + Check whether the current lines contains the equation field and it + contains the height of the corresponding line. + + + + + + + Determines whether the paragraph is empty + + paragraph + returns true if paragraph is empty + + + + Calculate a line points for the WCommentMark. + + + + + + + Draw the WCommentMark. + + + + + Draw AbsoluteTab + + + + + + + Update AbsoluteTab leader + + + + + + + + Draws the Footnote separator + + The TXT range. + The lt widget. + + + + Draws the Editable text range. + + The TXT range. + The lt widget. + + + + Inverse the specified character with suitable bidi character + + Specify the input character + Return the inversed character + + + + Determines whether the characters are inverses in the input text. + + Specify the input text + + + + Draws the text range. + + The TXT range. + The lt widget. + The text. + + + + Trim the space characters in the text. + + + + + + Check whether the widget is in field result or not. + + Hyper link field + Widget. + If the widget is in field result, return True;else false. + + + + Update Target position to the bookmark hyperlink + + + + + + + Create Bookmark reference link + + + + + + + Determine whether the tab stop is preserved after the text range in the current line + + + + + + + Update Tab Width. + + + + + Fill with dots for tab leader + + Font + Current layouted widget + Character format of layouted widget + String format + text + + + + Fill with sigle for tab leader + + Font + Current layouted widget + Character format of layouted widget + String format + text + + + + Fill with hyphens for tab leader + + Font + Current layouted widget + Character format of layouted widget + String format + text + + + + Fills with space + + + + + + + + + Draws the Symbol + + + + + + + Draws the image. + + The image. + The bounds. + + + + Creates color matrix. + + brightness + contrast + saturation + + + + Convert the image to specified color using ImageAttributes. + + Original Image + ImageAttributes used to change the color. + Return the recolored image. + + + + Decides whether table is preserved inside text box or not. + + Table cell + Indicates whether to check textbox only. + + + + + Gets the bounding box of the rectangular bounds after rotation. + + Bounds + Degree of rotation + Bounding box of the rectangular bounds + + + + Calculates the minX, minY, maxX and maxY of the rotated bounds. + + + Bounding box of a rectangular bounds + + + + Gets the rotation transformation matrix + + Bounds of the picture + Rotation angle + Transformation matrix + + + + Get matrix values of skia's matrix. + + SKia's matrix to get values from. + Image matrix. + + + + Gets the PdfImage with image quality from image + + Image + + + + Gets the PdfImage with image quality from stream + + Memory stream + + + + Converts the ole object into bitmap when the image and object is of WMF and equation type respectively. + + + + + + + + Draw the InlineShapePicture + + + + + + + + + Create the Pen to draw the picture border + + + + + + + Get the color for the picture border + + + + + + + Get the line cap for picture border + + + + + + + Get LineJoin for picture border + + + + + + + Get the Dash and line style for the picture shape + + + + + + + + + Get the dash and line style for picture border + + + + + + + + Get the Dash style for the border + + + + + + + + Set the CropImageBounds if the image offset is negative + + + + + + + + + Gets the position to crop the image + + + + + + + Draws the equation field swtiches. + + + + + Draws an Array EQ switch using their properties. + + Represents a script type + A layouted array EQ switch. + Represents a charFormat for array switch. + Represents a for array EQ switch. + + + + Draws a radical switch and the radical symbol as a graphic path. + + Represents a script type. + A layouted radical EQ switch. + Represents a charFormat for radical switch elements. + + + + Draws the Editable DrawDropDownFormField. + + dropDownFormField + The ltWidget. + + + + Align the layouted equation field switch based on the current y position. + + Layouted EQ field switches + x position of layouted equation field switch + Y position of layouted equation field switch + + + + Shift the eqaution field's x, y position based on the given x,y value. + + Layouted EQ field switches + x position of layouted equation field switch + Y position of layouted equation field switch + + + + Generates the error text for the equation field. + + Represents a equation field to generate. + Represents a which set for equation field. + Represents a X position of equation field. + Represents a Y position of equation field. + + + + Shift the equation field's y position based on the given y value. + + Layouted EQ field switches + Y position of layouted equation field switch + + + + Gets the top most Y position of layouted EQ fields. + + Layouted EQ field + Minimum value of y position + + + + + Draws the string. + + Represents a script type. + The text. + The char format. + The para format. + The bounds. + The clipwidth. + The layouted widget. + + + + Rotate a Graphics based on Shape Rotation. + + Specified the rotation angle. + Specifies whether text needs to vertically flip. + Specifies whether text needs to horizontally flip. + Specifies whether the text need to rotate. + Specifies the text wrapping style. + Indicates whether the text need to scale or not. + Indicates whether the line rotate transform is applied or not. + Specifies the modified rotation angle. + + + + Check that previous or next sibling is tab in that line paragraph + + CharacterFormat + textBounds + LayoutedWidget + isSameLine + + + + Calculate the Text Bounds + + + + + + + + + + Add the line to the Dictionary collection + + + + + + + + + + + + Check that can we extend the previous Underline to the next text. + + Previous boundsRight + Current boundsX + Current CharacterFormat + Previous CharacterFormat + + + + + Compare the two float values. + + Value 1 + value 2 + Round off value + + + + + Check that text having underline or strike through. + + TextRange + Charformat + + + + + + Check that the Inline content control having the text range. + + + Return true, if the InlineContentControl have text range; Else false. + + + + Checks whether the current widget is tab + + + + + + + Get the text box widget of current widget. + + + + + + + Reverse the string + + + + + + Draws the small cap string. + + scriptType + characterRangeType. + The text. + The character format. + The bounds. + The font. + The format. + The text brush. + if set to true [is character spacing]. + + + + Determine whether the text is need to clip when the text range y position is greater than the owner row bottom position + + + + + + Determine whether the text is need to clip when the text range x position is beyond the cell bounds or crossing the cell bounds + + + + + + Gets the index of the column. + + The section. + The section bounds. + + + + + Get Y position to clip paragraph items + + + + + + + + Get Default font to render non east characters + + + + + + + + + Draw String based on CharacterSpacing + + Script Type + Character Range Type + Font style of current Layouted widget + Text brush + Layouted widget bounds + Text + string format + character Format + + + + Draws a string based on expanded character spacing. + + The script type of the text. + The font used for drawing the text. + The bounds within which the text is drawn. + The text to be drawn. + The string format. + The character format. + + + + Transform the graphics rendering positions based on rotation angle + + Current ltWidget + set to true when the widget need to scale + set to true when the widget rotate transform is applied + Translation points + Rotation angle + OwnerParagraph + + + + Update the X and Y position + + X posiiton + Y position + Owner entity + Layouted Widget + Update the X and Y position when document has different page setup. + + + + Gets the height of the layouted text box content. + + The lt widget. + + + + + Get Width to shift vertical text + + + + + + + + + Get Bounds to clip the text + + + + + + + + + Update clip bounds based on vertical cell + + + + + + + + Update clipping bounds based on owner clipping + + + + + + + + Get Height of the cell with text direction as vertical + + + + + + + Draw Chinese Text + + + + + + + + + + + + + Draw String method for Drawing the string without its width and height + + + + + + + + + + + Checks whether the text is valid. (applicable for Arial text) + + + + + + Draw Unicode Text + + + + + + + + + + + + + Draw unicode string + + + + + + + + + + + + + Determines whether the owner paragraph is empty + + text + + true if owner paragraph is empty, set to true. + + + + + Rotate and scale the graphics transform matrix + + Layoted widget bounds + Clip bounds + Scaling factor value + Translation points + Rotation angle + + + + Scale the graphics transform matrix. + + Scaling factor value + Translation points + Rotation angle + + + + Prepares a matrix to PDF. + + The matrix. + The page scale value. + + A properly prepared PdfTransformationMatrix class instance. + + + + + Draws the paragraph borders. + + the paragraph + The paragraph format. + The lt widget. + isParagraphMarkIsHidden + + + + Draws the paragraph borders + + Collection of borders, contains the each border rendering order + Border bounds + Current paragraph borders + Previous paragraph borders + Paragraph + Layouted widget + + + + Draws the horizontal border. + + The border rendering order. + The bounds. + The borders. + The border. + if set to true [is multi line left border]. + if set to true [is multi line right border]. + if set to true [is multi line horizontal border]. + Width of the between border line. + Width of the left border line. + Width of the right border line. + Paragraph + Layouted widget + + + + Draws the left border. + + The border rendering order. + The bounds. + The borders. + The border. + The previous border. + if set to true [is multi line top border]. + if set to true [is multi line bottom border]. + if set to true [is multi line left border]. + if set to true [is multi line horizontal border]. + Width of the left border line. + Width of the top border line. + Width of the between border line. + Width of the bottom border line. + Paragraph + Layouted widget + + + + Draws the right border. + + The border rendering order. + The bounds. + The borders. + The border. + The previous border. + if set to true [is multi line top border]. + if set to true [is multi line horizontal border]. + if set to true [is multi line right border]. + if set to true [is multi line bottom border]. + Width of the right border line. + Width of the top border line. + Width of the between border line. + Width of the bottom border line. + Paragraph + Layouted widget + + + + Draws the top border. + + The border rendering order. + The bounds. + The borders. + The border. + if set to true [is multi line top border]. + Width of the top border line. + Width of the left border line. + Width of the right border line. + + + + Draws the bottom border. + + The border rendering order. + The bounds. + The borders. + The border. + if set to true [is multi line bottom border]. + Width of the left border line. + Width of the bottom border line. + Width of the right border line. + Paragraph + Layouted widget + + + + If paragraph inside Text box or shape have bottom border and that paragraph is the last element of textbox means + Microsoft word will preserve the bottom border at the top of the bottom margin of text box or shape by subtracting the internal bottom margin spacing and the text box or shape line width. + + + The spacing between the paragraph bottom border and textbox's or shape's bottom border + + + + Sort the borders based on brightness + + Border rendering order list + Horizontal border + Either left border/right border + Current paragraph borders + To ensure wether we need to remove left or right border + + + + Adds the next paragraph bounds. + + The layouted widget. + The bounds. + + + + + Draw the revision bars in the specified color and width + + Start point of the revision bar + End point of the revision bar + Color of the revision bar + Width of the revision bar + + + + Draws the border. + + The border. + The start. + The end. + + + + Draws the border. + + The border. + The start. + The end. + + + + Draws the border. + + The border. + The start. + The end. + + + + Draws the table. + + The table. + The lt widget. + + + + Draws the table row. + + The row. + The lt widget. + + + + Draws the table cell. + + The cell. + The lt widget. + + + + Fill the Cell Color + + The Layouted widget + + + + Checks the TextBox for Background picture. + + + + + + + Draws the texture style. + + + + + + + + + Gets the fore color. + + + + + + + + + Gets the color value. + + The fore color value. + The back color value. + The percent. + isForeColorEmpty + isBackColorEmpty + + + + + Fill Texture within the bounds + + Texture Style + Fore Color + Back Color + Bounds + + + + Draws the cell borders. + + The cell. + The lt widget. + The previous cells top border width + + + + Draws the multi line left border. + + The cell layout information. + The left border. + The start. + The end. + if set to true [is first row]. + if set to true [is last row]. + if set to true [is first cell]. + if set to true [is last cell]. + + + + Draws the double line left border. + + The cell layout information. + The left border. + The start. + The end. + if set to true [is first row]. + if set to true [is last row]. + if set to true [is first cell]. + if set to true [is last cell]. + + + + Draws the multi line right border. + + The cell layout information. + The right border. + The start. + The end. + if set to true [is first row]. + if set to true [is last row]. + if set to true [is first cell]. + if set to true [is last cell]. + + + + Draws the right double line border. + + The cell layout information. + The right border. + The start. + The end. + if set to true [is first row]. + if set to true [is last row]. + if set to true [is first cell]. + if set to true [is last cell]. + + + + Draws the multi line bottom border. + + The cell layout information. + The start. + The end. + isBiDiTable + + + + Draws the double line bottom border. + + The cell layout information. + The start. + The end. + isBiDiTable + + + + Draws the multi line top border. + + The cell layout information. + The top border. + The start. + The end. + if set to true [is start]. + if set to true [is end]. + + + + Draws the top double line border. + + The cell layout information. + The top border. + The start. + The end. + if set to true [is start]. + if set to true [is end]. + + + + Determines whether the specified border is multiline border + + Type of the border. + + + + + Determines whether [is multi line paragraph border] [the specified border type]. + + Type of the border. + + + + + Gets the border line array. + + Type of the border. + Width of the line. + + + + + To identify whether current border is double line border or triple line border + + Current border which is need to be check + Trueid the current border type is double border + + + + Draws the multi line left border. + + The left border. + The start. + The end. + if set to true [is top border same]. + if set to true [is between border same]. + if set to true [is bottom border same]. + + + + Draws the double line left border. + + The left border. + The start. + The end. + if set to true [is top border same]. + if set to true [is between border same]. + if set to true [is bottom border same]. + + + + Draws the triple line left border. + + The left border. + The start. + The end. + if set to true [is top border same]. + if set to true [is between border same]. + if set to true [is bottom border same]. + + + + Draws the multi line right border. + + The right border. + The start. + The end. + if set to true [is top border same]. + if set to true [is between border same]. + if set to true [is bottom border same]. + + + + Draws the double line right border. + + The right border. + The start. + The end. + if set to true [is top border same]. + if set to true [is between border same]. + if set to true [is bottom border same]. + + + + Draws the triple line right border. + + The right border. + The start. + The end. + if set to true [is top border same]. + if set to true [is between border same]. + if set to true [is bottom border same]. + + + + Draws the multi line top border. + + The top border. + The start. + The end. + if set to true [is left border same]. + if set to true [is right border same]. + + + + Draws the double line top border. + + The top border. + The start. + The end. + if set to true [is left border same]. + if set to true [is right border same]. + + + + Draws the triple line top border. + + The top border. + The start. + The end. + if set to true [is left border same]. + if set to true [is right border same]. + + + + Draws the multi line bottom border. + + The bottom border. + The start. + The end. + if set to true [is left border same]. + if set to true [is right border same]. + + + + Draws the double line bottom border. + + The bottom border. + The start. + The end. + if set to true [is left border same]. + if set to true [is right border same]. + + + + Draw the double line for the text. + + charFormat + borderType + lineWidth + start point + end point + + + + Draws the triple line bottom border. + + The bottom border. + The start. + The end. + if set to true [is left border same]. + if set to true [is right border same]. + + + + Draws the multi line between border. + + The between border. + The start. + The end. + if set to true [is left border same]. + if set to true [is right border same]. + The left border. + The right border. + if set to true [is overlap left]. + if set to true [is overlap right]. + + + + Draws the double line between border. + + The between border. + The start. + The end. + if set to true [is left border same]. + if set to true [is right border same]. + The left border. + The right border. + if set to true [is overlap left]. + if set to true [is overlap right]. + + + + Draws the triple line between border. + + The between border. + The start. + The end. + if set to true [is left border same]. + if set to true [is right border same]. + The left border. + The right border. + if set to true [is overlap left]. + if set to true [is overlap right]. + + + + Gets the adjacent border line width + + Left or right border line array + true if we passing left border line array; otherwise false + + + + + Draws the color of the background. + + Color of the bg. + The width. + The height. + + + + Draws the back ground image. + + The image. + The page setup. + + + + Draws the Watermark + + Watermark + Page setup + Bounds + + + + Imlementation of Draw method of page. + + Currentl drawing page + autoTagsCount + + + + Retrieves the list of previous line comment start marks and clears the current marks. + + + + + Draws Markup triangles. + + Position to draw the triangle. + Revision Color + + + + Checks the current watermark is empty watermark or not. + + + + + + Checks the HeaderFooter Paragraph and Table Weather WaterMark has to draw first + + + + + + Checks the paragraph weather watermark in Paragraph + + + + + + + + Checks the paragraph weather watermark in Table + + + + + + + + Checks which One has to draw first watermark or picture,shape,textbox + + + + + + + + + Draw the splitWidgetContainer to PDF document or Image. + + Currentl split widget container + Layouted widget + + + + Align the child widgets. + + The layouted widget. + The paragraph. + + + + Imlementation of Draw method of IWidget interface . + + + + + + + Draw widget to graphics. + + + + + Draws the specified dc. + + + + + + + Check whether the widget is need to drwa or not + + + + + + + Draw the page border + + Page number + + + + + Imlementation of Draw method of BookMark interface . + + + + + + + Decides whether Clipping is necessary or not. + + + + + + + Get text highlight color + + + + + + + Check whether the paragrah contains Text range + + + + + + + Draw the Empty string with white space to preserve Tags. + + + + + + + Imlementation of Draw method of LayoutedWidget interface . + + The Layouted widget. + Is need to initialize layout info + + + + Iterate every child elements of the table and add the floating items into the OverLappedShapeWidgets collection + + Table layouted widget + + + + Iterate the child elements of the paragraph + + Paragraph layouted widget + + + + Checks whether the child widget is floating item and add into the collection + + Child layouted widget + + + + Get space width at end of the line widget. + + + + + Checks whether the paragraph line is RTL. + + + + + + + Checks whether the paragraph line has text bidi. + + + + + + + Check that Line item are drawn. + + LayoutedWidget + Return true, if line items are drawn. + + + + Draw the Line Based in the collection. + + Contains the underline values + Contains the strike through values + + + + Transform the graphics based on the rotation and scaling. + + The character format. + Indicates whether the line need to scale or not. + Indicates whether the line rotate transform is applied or not. + Indicates whether the line need to set clip or not. + Line widget. + + + + Gets the rotation values from the textbox, shapes(ChildShapes/GroupShapes). + + Specified the rotation angle. + Specifies whether it is vertical flip. + Specifies whether it is horizontally flip. + Specifies whether the text need to rotate. + Specifies the text wrapping style. + Specifies the current textrange. + + + + Checks whether the underline width is need to change or not. + + + + + Draw the underline style. + + + + + + + Draw double underline style using compoundArray property + + + + + + + + + Draw a wavy line using Bezier points + + represents the character properties of the text + represents the bounds of the text + represents the font of the text + Returns the Object of PDFGraphics to draw the wavy line + To-Do:- PdfPath.AddCurve() method is not supported in PDF library. So, only here we are using PdfPath.AddBezier() method to draw the wavy line + + + + + Create the Pen to draw the Line for Underline and Strike through. + + charFormat + lineWidth + Return the Pen to draw the line. + + + + Checks whether clip bounds need to remove from container. + + + + + + + Increase the bounds with the table paddings. + + + + + + + Updates the clip bounds based on its owner clip bounds. + + + + + + + + Sets clipping for the particular region. + + + + + + Resets Graphics Transform positions. + + + + + Scale the graphics with input X and Y scaling values. + + Specify the scaling factor of X. + Specify the scaling factor of Y. + + + + Get the bounds based on the frame content. + + + + + + + Draw the paragraph + + + + + + + Draw a Comment highlighter for the line. + + Represents a layouted widget of line. + Represents a WordDocument. + + + + Gets a KeyValuePair for the specified key from specified collection. + + Represents a input key to find. + Represents a KVP colection. + Returns a KeyValuePair for the specified key from specified collection. + + + + Check whether a KeyValuePair is available in specified collection for the specified key. + + Represents a input key to find. + Represents a KVP colection. + Returns a true, if KeyValuePair available in specified collection; Otherwise false. + + + + Draw a comment highlighter. + + + + + + + Gets maximum height widget of line. + + Represent a layouted widget of line. + Returns a LayoutedWidget, which has maximum height in line. + + + + Check whether any of line for current paragraph intersect with floating items. + + Current widget + Whether this is line or line container + + + + + Draw the back ground colour for current line. + + Current paragraph + Current line widget + + + + Find the Back ground color rendering bounds. + + + + + + + + Check whether line preserved left or right or between floating items. + + + + + + + + + + Get the current child widget total bounds. + + + + + + + Draw the split table widget + + + + + + + Draw method for BlockContentControl + + + + + + + Draw method for InlineContentControl + + + + + + + Draw WCommentMark + + + + + + + Draw AbsoluteTab + + + + + + + Draw chart as image + + + + + + + Draws chart + + + + + + + Draw the Check box. + + + + + + + Draw the Drop Down Form Field. + + + + + + + Draw the Fields. + + + + + + + Draw Ole Object. + + + + + + + Draw the Picture. + + + + + + + Draw the symbol. + + + + + + + Draw the table. + + + + + + + Gets the frames first item. + + + + + + + + + Draw the table cell. + + + + + + + Draw the table row. + + + + + + + Draw the textbox. + + + + + + + Draw the text form field. + + + + + + + Imlementation of Draw method of LayoutedWidget interface + + + + + + + Draw the shape to PDF document or Image. + + Current shape entity + Current shale layouted widget + + + + Draw the shape to PDF document or Image. + + Current shape entity + Current shale layouted widget + + + + Draw the splitStringWidget + + SplitStringWidget + Layouted split string widget + + + + Draw the text ranges. + + + + + + + Draw widget to graphics. + + + + + + + + Draw widget to graphics. + + + + + Get Cell Widget + + + + + + + Gets the owner widget of the paragraph + + + + + + + Get owner widget of the cell + + + + + + + Determines whether the layouted widget is Overlapping Widget + + The lt widget. + + true if the layouted widget is Overlapping shape widget; otherwise, false. + + + + + Update the positions of text watermark. + + TextWatermark + + + + + + + Draw the text watermark. + + + + + + + + Convert the Watermark text as Bitmap Image. + + + + + + + + Change the given color brightness + + + + + + + + Draw border for the page + + Page setup object + Header bounds + Footer bounds + Page bounds + + + + + Gets the bounds to draw left border + + Page setup object + Header bounds + Footer bounds + Page bounds + + + + + Gets the bounds to draw right border + + Page setup object + Header bounds + Footer bounds + Page bounds + + + + + Gets the bounds to draw bottom border + + Page setup object + Header bounds + Footer bounds + Page bounds + + + + + Gets the bounds to draw top border + + Page setup object + Header bounds + Footer bounds + Page bounds + + + + + Gets the font size for Text Watermark + + Text Watermark + + + + Adjust the brightness and contrast of the picture. + + Represents a image that we need to gets a graphics. + The image. + Represents image Attributes + if set to true [is picture watermark]. + + + + + Draws the Picture Watermark + + Picture Watermark + Bounds + Page Setup + + + + Draws the Editable check box. + + The checkbox. + The ltWidget. + + + + Draws the check box. + + The checkbox. + The lt widget. + + + + Draw picture fill + + Imagebytes + Shapes path + Layouted widget bounds + + + + Apply transparency for image + + Represents image Attributes + Represents image transparency + + + + Convert the LineJoin as PdfLineJoin + + + + + + + Draw child shape + + + + + + + + + + + + + + Rotate the shape based on Flip positions + + + + + + + + + + + + + + + + + + + + + + Measures the image. + + The image. + + + + + Measures the picture bullet size + + Picture + Font + The size of picture bullet + + + + Measures the string. + + The text. + The font. + The format. + + + + + Measures the string. + + The text. + The font. + The format. + The character format. + isMeasureFromTabList + + + + + Gets the exact bounds of a string without an line spacing and top/bottom spacing values of font. + + Specify the input string. + Specify the font to measure. + + + + + Measures the string. + + The text. + The font. + The format. + The character format. + if set to true [is measure from tab list]. + if set to true [is measure from small cap string]. + + + + + Gets fall back font to preserve the text in converted PDF document. + + Represent original Pdf Font. + Represent original System font. + Represent a input text. + Represent the scriptType of a input text. + Represent PdfStringFormat. + Returns a fall back font instance, if it has; otherwise returns original Pdf Font. + + + + Gets fall back font to preserve the text in converted PDF document. + + Represent original Pdf Font. + Represent original System font. + Represent a input text. + Represent PdfStringFormat. + Represent Substituted or embedded font stream. + Returns a fall back font instance, if it has; otherwise returns original Pdf Font. + + + + Get fall back font from font substituted or embedded font stream. + + Represent a input text. + Represent the fallback font name. + Represent the fallback font instances. + Represent substituted or embedded font stream. + Returns a fallback font instance, if it exists in the substituted or embedded font stream collection; otherwise returns null. + + + + Check whether all the characters (glyphs) of input text is available in input font or not. + + Represent the input font to check. + Represent the input text to check. + Represent the PdfStringFormat. + Returns true, if all input character glyphs are available in input font; Otherwise false. + + + + Get the factor. + + Represents a font name. + + + + Calculates the font size for subscript and superscript font. + + Represets a normal font to change as subscript and superscript size. + Returns font size of subscript and superscript for corresponding inputed font. + + + + Get the Exceeded line height of the Arial unicode MS font. + + The font. + isAscent. + + + + + Measures the string. + + The text. + The font. + The default font + The format. + The Character format + + + + + Measures the small cap string. + + The text. + The size. + The font. + The format. + The character format. + + + + Draw Unicode Text + + + + + + + + + + + + + + + + + + Gets the ascent + + The Font. + + + + + Gets the descent + + The Font. + + + + + Translate the specified matrix with offsetX and offsetY + + Represent the matrix to translate + Represent the offsetX + Represent the offsetY + Represent the MatrixOrder to traslate + + + + Multiply the specified matrix with target matrix + + Represent the matrix to translate + Represent the target matrix + Represent the MatrixOrder to traslate + + + + Rotate the specified matrix with specified angle. + + + Represent the angle to rotate the matrix + Represent the center point to rotate a matrix + Represent the MatrixOrder to traslate + + + + Gets a new GraphicsPath object. + + Returns a new GraphicsPath object. + + + + Gets a new Bitmap object with specified width and height. + + Represents a width of Bitmap. + Represents a height of Bitmap. + Returns a new Bitmap object with specified width and height. + + + + Gets a Graphics of with specified image. + + Represents a image that we need to gets a graphics. + Returns a Graphics of with specified image. + + + + Gets a new SolidBrush object with specified color. + + Represents a color of SolidBrush. + Returns a new SolidBrush object with specified color. + + + + Gets a new ColorMatrix object. + + Returns new ColorMatrix object. + + + + Gets a new ColorMatrix object with specified color matrix. + + Represents a color of matrix. + Returns new ColorMatrix object with specified color matrix. + + + + Gets a new ImageAttributes object. + + Returns a new ImageAttributes object. + + + + Draws the arrow head. + + The shape. + The pen. + The bounds. + if set to true [is arrow head exist]. + The path. + The line points1. + + + + Draws the arrow head. + + The shape. + The pen. + The bounds. + if set to true [is arrow head exist]. + The path. + The line points1. + + + + Draws the open end arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Draws the close end arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Draws the stealth end arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Draws the close end arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Draws the stealth end arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Draws the open begin arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Draws the open begin arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Draws the close begin arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Draws the close begin arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Draws the stealth begin arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Draws the stealth begin arrow head. + + The shape. + The pen. + The bounds. + The line points. + The end point. + if set to true [is arrow head exist]. + The path. + + + + Adds the close arrow head points. + + The points. + The pen. + + + + Adds the stealth arrow head points. + + The points. + The pen. + + + + Adds the open arrow head points. + + The points. + The path. + + + + Gets the open arrow default values. + + The lineFormat. + Width of the line. + Length of the arrow. + The arrow angle. + The adjust value. + if set to true [is from begin arrow]. + + + + Gets the close arrow default values. + + The shape lineFormat. + Width of the line. + Length of the arrow. + The arrow angle. + The adjust value. + if set to true [is from begin arrow]. + + + + Gets the length of the arrow head. + + + + + + Gets the close narrow arrow default values. + + Length of the arrow head. + Width of the line. + Length of the arrow. + The arrow angle. + The adjust value. + + + + Gets the close medium arrow default values. + + Length of the arrow head. + Width of the line. + Length of the arrow. + The arrow angle. + The adjust value. + + + + Gets the close wide arrow default values. + + Length of the arrow head. + Width of the line. + Length of the arrow. + The arrow angle. + The adjust value. + + + + Gets the open narrow arrow default values. + + Length of the arrow head. + Width of the line. + Length of the arrow. + The arrow angle. + The adjust value. + + + + Gets the open medium arrow default values. + + Length of the arrow head. + Width of the line. + Length of the arrow. + The arrow angle. + The adjust value. + + + + Gets the open wide arrow default values. + + Length of the arrow head. + Width of the line. + Length of the arrow. + The arrow angle. + The adjust value. + + + + Finds the angle to left and right head point. + + + + + The point1. + The point2. + + + + + + Finds the angle to left and right head point. + + The shape. + The point1. + The point2. + + + + + + Finds the arrow head angle radians. + + The point1. + The point2. + if set to true [is from separate orientation]. + + + + + Finds the base line end point. + + + + + + The line points. + The adjust value. + + + + + + Gets the end point. + + if set to true [is from begin arrow]. + The degree. + The length. + The adjust value. + The line points. + The x. + The y. + + + + Finds the angle radians. + + The line points. + if set to true [is from bottom to top]. + + + + + Finds the end cap arrow head points. + + The shape. + The pen. + The bounds. + The line points. + if set to true [is from open arrow]. + + + + + + Finds the end cap arrow head points. + + The shape. + The pen. + The bounds. + The line points. + if set to true [is from open arrow]. + + + + + + Finds the left right head points. + + + + + The line points. + The points. + The arrow angle. + Length of the arrow. + if set to true [is from begin arrow]. + + + + Construcs the baset line. + + if set to true [is from begin arrow]. + The points. + The line points. + + + + + + Gets the arrow default values. + + The line Format. + The pen. + Length of the arrow. + The arrow angle. + The adjust value. + + if set to true [is from begin arrow]. + + + + Radians to degree. + + The angle. + + + + + Degree2s the radian. + + A. + + + + + Gets the end point. + + The angle. + The length. + The start_x. + The start_y. + The end_x. + The end_y. + + + + Gets the line points based on flip. + + + + The bounds. + + + + + Determines whether the text range is soft hyphen and that need to be drawn. + + The lt widget. + + + + + Gets the string format. + + The char format. + + + + + Gets the brush. + + The color. + + + + + Gets the pdf brush. + + The color. + + + + + Gets the color of the text. + + The char format. + + + + + Get the RevisionColor + + Revision color + + + + + Get the RevisionColor + + Revision color + Is revision type insert type + + + + + Get the RevisionColor + + Revision color + Is revision type insert type + + + + + Get the RevisionColor to fill a comment balloon. + + Revision color + Is revision type insert type + + + + + Updates the alternate font for the font not installed in the system. + + The char format. + Name of the font. + The font. + + + + Checks the owner paragraph of the textrange is a TOC + + Text Range + + + + + Determins whether the paragraph is TOC. + + + + + + + Determines the the paragraph contians hyperlink field. + + + + + + + To check the current text range is present inside the HyperLink. + + + + + + + Check whether current text range is present inside the hyperlink field. + + + + + + + + Gets the font. + + + The char format. + + + + + + Updates the font name and size based on the Bidi property. + + + Character format of the current text range. + Font applied to the current text. + Font size applied to the current text. + Font style applied to the current text. + Returns current text range Bidi font. + + + + Gets the string alignment. + + The para format. + + + + + Gets the pen. + + The border. + + + + + + Gets the pen. + + Type of the border. + Width of the border line. + Color of the border. + + + + + Gets the pen. + + Type of the underline. + Width of the underline. + Color of the underline. + + + + + Scales the image. + + The image. + The width. + The height. + + + + + Adds link to the bookmark. + + The bounds. + The bookmark name. + The target is nothing. + + + + Creates bookmark hyperlink and add into list. + + + + + + + + Adds the hyper link to collection. + + The hyperlink. + The bounds. + + + + Adds the hyper link to collection. + + The picture. + The bounds. + + + + Updates the target bounds and page number for current bookmark. + + Bookmark hyperlink. + Bookmark hyperlink value. + + + + Updates the TOC level. + + The paragraph. + The bookmark. + + + + Updates Result index + + text + the measurer + res index + bSplitByChar + bIsInCell + offset + Client Width + + + res Index + + + + Determine whether the character is CJK leading character + A line of text cannot end with any leading characters, which are listed below + + + + + + + Determine whether the character is Begin CJK character + A line of text cannot begin with any following characters + + + + + + + Determine whether the character is CJK overflow character + Overflow characters are allowed to render in the same line when it doesn't have required client width to fit the character + + + + + + + + + + + + + + Get previous text range + + + + + + Get cell Width + + The paragraph item + + + + + Concatenates the font name, style, font size and Unicode text and returns the key for PDFFontCollection. + + Font object to extract font name, font size and font style from. + check whether it's unicode or not. + Key for the PdfFontCollection dictionary to store and retreive the created PdfFont. + + + + Determines whether the text is unicode + + text + + true if text is unicode, set to true. + + + + + Gets length of WORD. + NOTE: + - WORD: text run that finished by last space letter + (sample: "text " or " "; wrong sample: " text" or "text text" ) + EXCLUSION: + - If text working part have zero symbols return (-1) + - If text working part don't consist SPACE letters return legth of + text working part + + + Index of word first letter + Length of found word + + + + Closes this instance. + + + + + Draws the behind shape widgets. + + + + + Get Order index of the floating item + + + + + + Get the line width of the picture border for Inline picture shape + + + + + + + Get the line width of the picture border + + + + + + + + + + + + Gets or sets a value that indicates whether to regenerate the nested EMF images present in the Word document during PDF conversion. Default value isfalse. + + True if it is necessary to regenerate the nested EMF images present in the Word document during PDF conversion; otherwise false. + + + + Gets or sets the PdfDocument. + + The PdfDocument. + + + + Get the Current Bookmark name + + + + + Gets or sets the value indicates whether to export Word document heading as PDF bookmarks. + + + + + Decides whether, we should enable PdfMetafile.ComplexScript property for current page. + + + + + Gets or sets the graphics. + + The graphics. + + + + Gets or sets the ImageQuality. + + image quality + + + + Gets or sets the PreserveFormFields. + + PreserveFormFields + + + + Gets or sets the custom font collection. + + + + + Gets or sets the custom font name collection. + + fontName + + + + Gets a Fallback font collection of Word document. + + + + + Gets or set the embedded fonts. + + + + + Gets or sets the graphics. + + The graphics. + + + + Gets the bitmap graphics. + + The graphics. + + + + Gets the hyperlinks. + + The hyperlinks. + + + + Gets the bookmark hyperlinks list. + + + + + Gets the bookmarks. + + + + + Gets the overlapping shape widgets. + + The overlapping shape widgets. + + + + Gets the font metric. + + + The font metric. + + + + + Gets the string formt. + + + The string formt. + + + + + Gets or sets a value indicating whether to embed fonts to converted PDF in Word to PDF conversion. + + + + + Gets or sets a value indicating whether to preserve the ole equation as bitmap in Word to PDF conversion. + + + + + Gets or sets a value indicating whether to embed the complete font information in the resultant PDF document. + + + + + Gets or sets a value indicates whether the converted PDF document is tagged or not. + + Remarks: Set this property as true, to preserve the accessible structure tags from Word document to the converted PDF. Using this property Word documents can be converted to PDF with 508 compliance. + Setting this property as true will automatically enable EnableFastRendering property. + + + + + + + + + + + + + + + + + Gets the vertical border + + + + + Gets / sets the horizontal border + + + + + Initializes a new instance of the class. + + Name of the bookmark. + The page number. + The bounds. + + + + Gets or sets the bookmarkStyle. + + The bookmarkStyle. + + + + Gets or sets the bounds. + + The bounds. + + + + Gets or sets the page number. + + The page number. + + + + Gets or sets the name of the bookmark. + + The name of the bookmark. + + + + Sort the border rendering order based on its color brightness order + + + + + Represents the class which drawing a Math Equations. + + + + + Creates a class instance to render the WMath entity. + + Represent the + + + + Draw the WMath instance. + + Represent the WMath instance to draw + Represent the layouted widget of WMath instance + + + + Draw the IOfficeMath instance. + + Represent the layouted widget of OfficeMath instance + + + + Draw the delimiter character with required stretching. + + Specify the delimiter widget. + Specify the required height to stretch. + Specify the character format. + + + + Draw the Line used in MathML. + + Represent the layouted widget of a line. + + + + Draw the layouted string widget. + + Represent the string widget + Represent the characterFormat + Represent the scalingFactor + + + + Dispose a MathRenderer object. + + + + + Gets a class object for drawing. + + + + + This class provides support for converting WordDocument into an PDF Document. + + + + This class is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + This example converts the specified Word Document in to PDF Document. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Instantiation of DocToPDFConverter for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases all resources used by the object. + converter.Dispose(); + //Closes the instance of document objects + pdfDocument.Close(true); + wordDocument.Close(); + + + 'Loads an existing Word document + Dim wordDocument As New WordDocument("Template.docx", FormatType.Docx) + 'Instantiation of DocToPDFConverter for Word to PDF conversion + Dim converter As New DocToPDFConverter() + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + 'Releases all resources used by the object. + converter.Dispose(); + 'Closes the instance of document objects + pdfDocument.Close(true); + wordDocument.Close(); + + + + + + converter settings to the document + + + + + The m_flag + + + + + Initializes a new instance of the class. + + This constructor is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + This example converts the specified Word Document in to PDF Document. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Instantiation of DocToPDFConverter for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases all resources used by the object. + converter.Dispose(); + //Closes the instance of document objects + pdfDocument.Close(true); + wordDocument.Close(); + + + 'Loads an existing Word document + Dim wordDocument As New WordDocument("Template.docx", FormatType.Docx) + 'Instantiation of DocToPDFConverter for Word to PDF conversion + Dim converter As New DocToPDFConverter() + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + 'Releases all resources used by the object. + converter.Dispose(); + 'Closes the instance of document objects + pdfDocument.Close(true); + wordDocument.Close(); + + + + + + Release the resources occupied by this instance. + + + + + Releases all resources used by the object. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + This example converts the specified Word Document in to PDF Document. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Instantiation of DocToPDFConverter for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases all resources used by the object. + converter.Dispose(); + //Closes the instance of document objects + pdfDocument.Close(true); + wordDocument.Close(); + + + 'Loads an existing Word document + Dim wordDocument As New WordDocument("Template.docx", FormatType.Docx) + 'Instantiation of DocToPDFConverter for Word to PDF conversion + Dim converter As New DocToPDFConverter() + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + 'Releases all resources used by the object. + converter.Dispose(); + 'Closes the instance of document objects + pdfDocument.Close(true); + wordDocument.Close(); + + + + + + Converts the specified WordDocument to PDF. + + The word document. + The PdfDocument. + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + If running the application by hosting in Azure environment, is enabled automatically. + + This example converts the specified Word Document in to PDF Document. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Instantiation of DocToPDFConverter for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases all resources used by the object. + converter.Dispose(); + //Closes the instance of document objects + pdfDocument.Close(true); + wordDocument.Close(); + + + 'Loads an existing Word document + Dim wordDocument As New WordDocument("Template.docx", FormatType.Docx) + 'Instantiation of DocToPDFConverter for Word to PDF conversion + Dim converter As New DocToPDFConverter() + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + 'Releases all resources used by the object. + converter.Dispose(); + 'Closes the instance of document objects + pdfDocument.Close(true); + wordDocument.Close(); + + + + + + Check and set balloon count for track changes. + + + + + + Embed the Document fonts in the private font collection. + + + + + Gets the font name from the given stream. + + + + + Check whether the font stream is valid + ToDo : Need to implement similar method for Word to Image + + Stream from which font instance will be created. + + + + + Convert ODTTF font stream to TTF font stream. + + ODTTF font stream + TTF font stream + embed font key + + + + + Converts the specified WordDocument to PDF. + + Name of the file. + The PdfDocument. + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + If running the application by hosting in Azure environment, is enabled automatically. + + This example converts the specified Word Document in to PDF Document. + + //Instantiation of DocToPDFConverter for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Converts the specified WordDocument to PDF. + PdfDocument pdfDocument = converter.ConvertToPDF("Template.docx"); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases all resources used by the object. + converter.Dispose(); + //Closes the instance of document objects + pdfDocument.Close(true); + + + 'Creates an instance of the DocToPDFConverter + Dim converter As New DocToPDFConverter() for Word to PDF conversion + 'Instantiation of DocToPDFConverter + Dim pdfDocument As PdfDocument = converter.ConvertToPDF("Template.docx") + 'Save the document in the given name and PDF format + pdfDocument.Save("WordtoPDF.pdf"); + 'Releases all resources used by the object. + converter.Dispose(); + 'Closes the instance of document objects + pdfDocument.Close(true); + + + + + + Converts to PDF. + + The stream. + The PdfDocument. + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + If running the application by hosting in Azure environment, is enabled automatically. + + This example converts the specified Word Document in to PDF Document. + + //Loads an existing Word document + Stream fileStream = new FileStream("Template.docx", FileMode.Open, FileAccess.Read, FileShare.Read); + //Instantiation of DocToPDFConverter for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Converts the specified WordDocument to PDF. + PdfDocument pdfDocument = converter.ConvertToPDF(fileStream); + //Save the document in the given name and PDF format + pdfDocument.Save("WordtoPDF.pdf"); + //Releases all resources used by the object. + converter.Dispose(); + //Closes the instance of document objects + fileStream.Close(); + pdfDocument.Close(true); + + + //Loads an existing Word document + Dim fileStream As Stream = New FileStream("Template.docx", FileMode.Open, FileAccess.Read, FileShare.Read) + 'Instantiation of DocToPDFConverter for Word to PDF conversion + Dim converter As New DocToPDFConverter() + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(fileStream) + 'Save the document in the given name and PDF format + pdfDocument.Save("WordtoPDF.pdf"); + 'Releases all resources used by the object. + converter.Dispose(); + 'Closes the instance of document objects + fileStream.Close(); + pdfDocument.Close(true); + + + + + + Creates the PDF document. + + + + + + Adds the section. + + The page setup. + + + + + Sets the pages settings. + + The layouter. + + + + Adds the document properties. + + The doc properties. + + + + Adds the hyper links. + + The hyperlinks. + + + + Scale the given rectangle bounds with specified scaling factor. + + + + + Getting Parent Node for the levels of the Bookmarks + + + + + + Draw To PDF + + The DocumentLayouter + PdfDocument + + + + Create temp font stream + + Actual font streams + Temp font streams + + + + Draw To PDF + + The DocumentLayouter + PdfDocument + + + + Shows the warnings. + + + + + + Create warning element names into the list + + + + + + Gets the page settings. + + The page settings. + + + + Gets or sets the quality. + + This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Gets a value indicating whether this conversion has been canceled. + + + true if this conversion is canceled; otherwise, false. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Gets or sets a value indicating whether the PDF document was generated using web service. + + + true if the PDF document was generated using web service; otherwise, false. + + + + + Represents a class to get fallback fonts during Direct PDF conversion. + + + + + Gets fall back font to preserve the text in converted PDF document. + + Represent original font. + Represent a input text. + Represent the scriptType of a input text. + Represent the character format of a input text. + Represent the fallback fonts list. + Represent the substituted or Embedded fonts collection. + Returns fallback font if it has; otherwise returns original font. + + + + Gets or sets a value indicating whether to embed fonts to converted PDF in Word to PDF conversion. + + + + + Gets or sets a value indicating whether to embed the complete font information in the resultant PDF document. + + + + + Represent class with setting of converter. + + This example illustrates DocToPDFConverter settings. + This class is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Instantiation of DocToPDFConverter for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Skip the updating process for Alternate chunks in the Word document + converter.Settings.EnableAlternateChunks = false; + //Sets the image resolution + converter.Settings.ImageResolution = 640; + //Sets the jpeg image quality to reduce the Pdf file size + converter.Settings.ImageQuality = 100; + //Sets true to optimize the memory usage for identical image + converter.Settings.OptimizeIdenticalImages = false; + //Sets the PdfConformanceLevel + converter.Settings.PdfConformanceLevel = PdfConformanceLevel.None; + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Closes the instance of Word document object + wordDocument.Close(); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases the resources occupied by DocToPDFConverter instance + converter.Dispose(); + //Closes the instance of PDF document object + pdfDocument.Close(true); + + + 'Loads an existing Word document + Dim wordDocument As WordDocument = New WordDocument("Template.docx", FormatType.Docx) + 'Instantiation of DocToPDFConverter for Word to PDF conversion + Dim converter As DocToPDFConverter = New DocToPDFConverter() + 'Skip the updating process for Alternate chunks in the Word document + converter.Settings.EnableAlternateChunks = False + 'Sets the image resolution + converter.Settings.ImageResolution = 640 + 'Sets the jpeg image quality to reduce the Pdf file size + converter.Settings.ImageQuality = 100 + 'Sets true to optimize the memory usage for identical image + converter.Settings.OptimizeIdenticalImages = False + 'Sets the PdfConformanceLevel + converter.Settings.PdfConformanceLevel = PdfConformanceLevel.None + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Closes the instance of Word document object + wordDocument.Close() + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Releases the resources occupied by DocToPDFConverter instance + converter.Dispose() + 'Closes the instance of PDF document object + pdfDocument.Close(True) + + + + + + Need to enable the Alternate chunks element + + + + + Need to enable the direct PDF rendering + + + + + Need to update the fields present in the document. + + + + + Indicates the quality of the image. + + + + + Indicates whether to preserve the Word document form fields as PDF document form fields + + + + + Indicates the Image resolution + + + + + The m_warning + + + + + Gets or sets a value indicates to automatically detect the complex script text present in the Word document during PDF conversion. Default value is false. + + Trueif it is necessary to automatically detect the complex script text present in the Word document during PDF conversion; otherwise, false. + Set this property to true, only if you have complex script text that is not marked as complex script type (CharacterFormat.ComplexScript is false) in the Word document. + You can mark a text as complex script by enabling the WTextRange.CharacterFormat.ComplexScript property. + Since automatic detection of complex script text involves validation of all the text in the document and may impact proportionally in Word to PDF conversion performance. + This example illustrates AutoDetectComplexScript property of DocToPDFConverter settings. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Instantiates DocToPDFConverter instance for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Sets AutoDetectComplexScript property as true, to detect the complex scripts automatically + converter.Settings.AutoDetectComplexScript = true; + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Closes the instance of Word document object + wordDocument.Close(); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases the resources occupied by DocToPDFConverter instance + converter.Dispose(); + //Closes the instance of PDF document object + pdfDocument.Close(true); + + + 'Loads an existing Word document + Dim wordDocument As WordDocument = New WordDocument("Template.docx", FormatType.Docx) + 'Instantiates DocToPDFConverter instance for Word to PDF conversion + Dim converter As DocToPDFConverter = New DocToPDFConverter() + 'Sets AutoDetectComplexScript property as true, to detect the complex scripts automatically + converter.Settings.AutoDetectComplexScript = True + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Closes the instance of Word document object + wordDocument.Close() + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Releases the resources occupied by DocToPDFConverter instance + converter.Dispose() + 'Closes the instance of PDF document object + pdfDocument.Close(True) + + + + + + Gets or sets a value that indicates whether to regenerate the nested Metafile images present in the Word document during PDF conversion. Default value isfalse. + + True if it is necessary to regenerate the nested Metafile images present in the Word document during PDF conversion; otherwise false. + This example illustrates RecreateNestedMetafile property of DocToPDFConverter settings. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Instantiates DocToPDFConverter instance for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Sets RecreateNestedMetafile property to true to Recreate the Nested Metafile automatically + converter.Settings.RecreateNestedMetafile = true; + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Closes the instance of Word document object + wordDocument.Close(); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases the resources occupied by DocToPDFConverter instance + converter.Dispose(); + //Closes the instance of PDF document object + pdfDocument.Close(true); + + + 'Loads an existing Word document + Dim wordDocument As WordDocument = New WordDocument("Template.docx", FormatType.Docx) + 'Instantiates DocToPDFConverter instance for Word to PDF conversion + Dim converter As DocToPDFConverter = New DocToPDFConverter() + 'Sets RecreateNestedMetafile property to true to Recreate the Nested Metafile automatically + converter.Settings.RecreateNestedMetafile = True + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Closes the instance of Word document object + wordDocument.Close() + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Releases the resources occupied by DocToPDFConverter instance + converter.Dispose() + 'Closes the instance of PDF document object + pdfDocument.Close(True) + + + + + + Gets or sets a value indicates to enable the Alternate chunks present in the Word document . Default value is True. + + True if need to enable the Alternate chunks; otherwise, false. + This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Gets or sets a value that indicates whether to convert PDF faster by using direct PDF rendering. The default value is false. + + True If True, converts PDF faster by using direct PDF rendering approach. Otherwise uses EMF rendering. otherwise, false. + EMF rendering – Convert a Word document to EMF and render the generated EMF to PDF during Word to PDF conversion. + This is default approach, to maintain compatibility for earlier versions. PDF rendering – Directly render a Word document to PDF. + This approach is available from 2016 Volume 4 release. + + + + Gets or sets a value that indicates whether to preserve Word document form field as editable PDF form field.Default value isfalse. + + TrueIf True, converts Word document form field as editable PDF form field in Word to PDF conversion. Otherwise editable form field will be preserved as text in Word to PDF conversion false. + + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument(@"TemplateFormFields.docx"); + //Instantiates DocToPDFConverter instance for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Sets to preserve the Word document form field as editable PDF form field in PDF document. + converter.Settings.PreserveFormFields = true; + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Releases the resources occupied by DocToPDFConverter instance + converter.Dispose(); + //Closes the instance of Word document object + wordDocument.Close(); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Closes the instance of PDF document object + pdfDocument.Close(true); + + + 'Loads an existing Word document + Dim wordDocument As WordDocument = New WordDocument(@"TemplateFormFields.docx") + 'Instantiates DocToPDFConverter instance for Word to PDF conversion + Dim converter As DocToPDFConverter = New DocToPDFConverter() + 'Sets to preserve the Word document form field as editable PDF form field in PDF document. + converter.Settings.PreserveFormFields = True + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Releases the resources occupied by DocToPDFConverter instance + converter.Dispose() + 'Closes the instance of Word document object + wordDocument.Close() + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Closes the instance of PDF document object + pdfDocument.Close(True) + + + + + + Gets or sets a value that indicates whether to update fields present in the Word document while converting a Word document to PDF.Default value is false. + + True If true, updates the fields present in the Word document during Word to PDF conversion. otherwise, false. + + This API is alternative for UpdateDocumentFields() to improve performance, if your requirement is to update the fields and convert the Word document to PDF. + You can remove UpdateDocumentFields() method and enable UpdateDocumentFields property to update the Word document fields and convert the Word document to PDF in optimized way. + + + The following code example demonstrates how to update the fields present while performing Word to PDF conversion. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Instantiates DocToPDFConverter instance for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Updates the fields present in Word document + converter.Settings.UpdateDocumentFields = true; + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Closes the instance of Word document object + wordDocument.Close(); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases the resources occupied by DocToPDFConverter instance + converter.Dispose(); + //Closes the instance of PDF document object + pdfDocument.Close(true); + + + 'Loads an existing Word document + Dim wordDocument As WordDocument = New WordDocument("Template.docx", FormatType.Docx) + 'Instantiates DocToPDFConverter instance for Word to PDF conversion + Dim converter As DocToPDFConverter = New DocToPDFConverter() + 'Updates the fields present in Word document + converter.Settings.UpdateDocumentFields = True + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Closes the instance of Word document object + wordDocument.Close() + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Releases the resources occupied by DocToPDFConverter instance + converter.Dispose() + 'Closes the instance of PDF document object + pdfDocument.Close(True) + + + + + + Gets or sets the quality. The value indicates in percentage, max value represents best quality and min value represents best compression. + + + The value indicates in percentage, max value represents best quality and min value represents best compression + This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Sets the image resolution to the image, which are Embedded + in the Word document + + This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Gets/Sets a value indicating whether to optimize the memory usage for the identical (duplicate) images in Doc to Pdf conversion and converted Pdf document. + + This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Gets or sets the warning that describes the unsupported elements found while converting the specified Word document to PDF. + + + The warning. + + This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Gets or sets the Pdf document's Conformance-level. + + The of the PDF document. + This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Gets or sets a value indicating whether to embed fonts in the converted PDF document. Default value is false + + + True: if need to embed fonts in the converted PDF document; otherwise, False. + + + + This property is supported to embed TrueType fonts only. + This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + This example illustrates EmbedFonts property of DocToPDFConverter settings. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Instantiates DocToPDFConverter instance for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Sets EmbedFonts property as true, to embed fonts in resultant PDF + converter.Settings.EmbedFonts = true; + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Closes the instance of Word document object + wordDocument.Close(); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases the resources occupied by DocToPDFConverter instance + converter.Dispose(); + //Closes the instance of PDF document object + pdfDocument.Close(true); + + + 'Loads an existing Word document + Dim wordDocument As WordDocument = New WordDocument("Template.docx", FormatType.Docx) + 'Instantiates DocToPDFConverter instance for Word to PDF conversion + Dim converter As DocToPDFConverter = New DocToPDFConverter() + 'Sets EmbedFonts property as true, to embed fonts in resultant PDF + converter.Settings.EmbedFonts = True + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Closes the instance of Word document object + wordDocument.Close() + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Releases the resources occupied by DocToPDFConverter instance + converter.Dispose() + 'Closes the instance of PDF document object + pdfDocument.Close(True) + + + + + + Gets or sets a value indicating whether to preserve ole equation as bitmap while converting a Word document ot PDF. Default value is false + + + True: if need to preserve the ole equation as bitmap; otherwise, False. + + This example illustrates PreserveOleEquationAsBitmap of DocToPDFConverter settings. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Instantiates DocToPDFConverter instance for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Sets PreserveOleEquationAsBitmap property as true, to preserve the ole equation as bitmap in resultant PDF + converter.Settings.PreserveOleEquationAsBitmap = true; + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Closes the instance of Word document object + wordDocument.Close(); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases the resources occupied by DocToPDFConverter instance + converter.Dispose(); + //Closes the instance of PDF document object + pdfDocument.Close(true); + + + 'Loads an existing Word document + Dim wordDocument As WordDocument = New WordDocument("Template.docx", FormatType.Docx) + 'Instantiates DocToPDFConverter instance for Word to PDF conversion + Dim converter As DocToPDFConverter = New DocToPDFConverter() + 'Sets PreserveOleEquationAsBitmap property as true, to preserve the ole equation as bitmap in resultant PDF + converter.Settings.PreserveOleEquationAsBitmap = True + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Closes the instance of Word document object + wordDocument.Close() + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Releases the resources occupied by DocToPDFConverter instance + converter.Dispose() + 'Closes the instance of PDF document object + pdfDocument.Close(True) + + + + + + Gets or sets a value indicating whether to embed the complete font information in the converted PDF document. Default value is false + + + True: if need to embed the complete font information in the converted PDF document; otherwise, False. + + + + This property is used to indicate whether the complete font information of + the characters in the resultant PDF document to embedded or not. + This property is supported to embed TrueType fonts only. + This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + This example illustrates EmbedCompleteFonts property of DocToPDFConverter settings. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Instantiates DocToPDFConverter instance for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Sets the embed complete font information in converted PDF + converter.Settings.EmbedCompleteFonts = true; + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Closes the instance of Word document object + wordDocument.Close(); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Releases the resources occupied by DocToPDFConverter instance + converter.Dispose(); + //Closes the instance of PDF document object + pdfDocument.Close(true); + + + 'Loads an existing Word document + Dim wordDocument As WordDocument = New WordDocument("Template.docx", FormatType.Docx) + 'Instantiates DocToPDFConverter instance for Word to PDF conversion + Dim converter As DocToPDFConverter = New DocToPDFConverter() + 'Sets the embed complete font information in converted PDF + converter.Settings.EmbedCompleteFonts = True + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Closes the instance of Word document object + wordDocument.Close() + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Releases the resources occupied by DocToPDFConverter instance + converter.Dispose() + 'Closes the instance of PDF document object + pdfDocument.Close(True) + + + + + + Gets or sets a value indicates whether the converted PDF document is tagged or not. Default value is false + + + True: if need to preserve the accessible structure tags from Word document to the converted PDF; otherwise, False. + + + + Set this property as true, to preserve the accessible structure tags from Word document to the converted PDF. Using this property Word documents can be converted to PDF with 508 compliance. + Setting this property as true will automatically enable property . + This property will set the title and description for images, diagrams and other objects in the generated PDF document. This information is useful for people with vision or cognitive impairments who may not able to see or understand the object + This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + This property is only applicable while converting the Word document as PDF document. + + + This example illustrates how to convert an Word document to PDF with AutoTag property. + + //Loads an existing Word document + WordDocument wordDocument = new WordDocument("Template.docx", FormatType.Docx); + //Instantiates DocToPDFConverter instance for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Sets the accessible structure tags in converted PDF + converter.Settings.AutoTag = true; + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Closes the instance of Word document object + wordDocument.Close(); + //Releases the resources occupied by DocToPDFConverter instance + converter.Dispose(); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Closes the instance of PDF document object + pdfDocument.Close(true); + + + 'Loads an existing Word document + Dim wordDocument As WordDocument = New WordDocument("Template.docx", FormatType.Docx) + 'Instantiates DocToPDFConverter instance for Word to PDF conversion + Dim converter As DocToPDFConverter = New DocToPDFConverter() + 'Sets the accessible structure tags in converted PDF + converter.Settings.AutoTag = True + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Closes the instance of Word document object + wordDocument.Close() + 'Releases the resources occupied by DocToPDFConverter instance + converter.Dispose() + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Closes the instance of PDF document object + pdfDocument.Close(True) + + + + + + Gets or sets a value indicates whether to export Word document headings or bookmarks as PDF bookmarks while performing Word to PDF conversion. Default value is ExportBookmarkType.Bookmarks + + + The member specifies whether Word headings or bookmarks need to be considered in Word to PDF conversion. + + + + The will consider only headings within the main document and text boxes not within headers, footers, endnotes, footnotes, or comments. + This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + This property is only applicable while converting the Word document as PDF document. + + + This example illustrates how to convert an Word document headings to PDF Bookmarks with the help of ExportBookmark property. + + //Creates a new Word document + WordDocument wordDocument = new WordDocument(); + //Add a section into the word document + IWSection section = wordDocument.AddSection(); + //Add a paragraph into the section + IWParagraph paragraph = section.AddParagraph(); + //Add a text into the paragraph + paragraph.AppendText("First Chapter1"); + //Apply style for the text + paragraph.ApplyStyle(BuiltinStyle.Heading1); + paragraph.AppendText("First Chapter2"); + paragraph.ApplyStyle(BuiltinStyle.Heading2); + paragraph.AppendText("First Chapter3"); + paragraph.ApplyStyle(BuiltinStyle.Heading3); + //Instantiates DocToPDFConverter instance for Word to PDF conversion + DocToPDFConverter converter = new DocToPDFConverter(); + //Sets ExportBookmarks for preserving Word document headings as PDF bookmarks + converter.Settings.ExportBookmarks = Syncfusion.DocIO.ExportBookmarkType.Headings; + //Converts Word document into PDF document + PdfDocument pdfDocument = converter.ConvertToPDF(wordDocument); + //Closes the instance of Word document object + wordDocument.Close(); + //Releases the resources occupied by DocToPDFConverter instance + converter.Dispose(); + //Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf"); + //Closes the instance of PDF document object + pdfDocument.Close(true); + + + 'creates a new Word document + Dim wordDocument As WordDocument = New WordDocument() + 'Add a section into the word document + Dim section As IWSection = wordDocument.AddSection() + 'Add a paragraph into the section + Dim paragraph As IWParagraph = section.AddParagraph(); + 'Add a text into the paragraph + paragraph.AppendText("First Chapter1"); + 'Apply style for the text + paragraph.ApplyStyle(BuiltinStyle.Heading1); + paragraph.AppendText("First Chapter2"); + paragraph.ApplyStyle(BuiltinStyle.Heading2); + paragraph.AppendText("First Chapter3"); + paragraph.ApplyStyle(BuiltinStyle.Heading3); + 'Instantiates DocToPDFConverter instance for Word to PDF conversion + Dim converter As DocToPDFConverter = New DocToPDFConverter() + 'Sets ExportBookmarks for preserving Word document headings as PDF bookmarks + converter.Settings.ExportBookmarks = Syncfusion.DocIO.ExportBookmarkType.Headings + 'Converts Word document into PDF document + Dim pdfDocument As PdfDocument = converter.ConvertToPDF(wordDocument) + 'Closes the instance of Word document object + wordDocument.Close() + 'Releases the resources occupied by DocToPDFConverter instance + converter.Dispose() + 'Saves the PDF file + pdfDocument.Save("WordtoPDF.pdf") + 'Closes the instance of PDF document object + pdfDocument.Close(True) + + + + + diff --git a/ZZPDFTest/bin/Debug/Syncfusion.ExcelToPDFConverter.Base.dll b/ZZPDFTest/bin/Debug/Syncfusion.ExcelToPDFConverter.Base.dll new file mode 100644 index 00000000..95eab880 Binary files /dev/null and b/ZZPDFTest/bin/Debug/Syncfusion.ExcelToPDFConverter.Base.dll differ diff --git a/ZZPDFTest/bin/Debug/Syncfusion.ExcelToPDFConverter.Base.xml b/ZZPDFTest/bin/Debug/Syncfusion.ExcelToPDFConverter.Base.xml new file mode 100644 index 00000000..941773a6 --- /dev/null +++ b/ZZPDFTest/bin/Debug/Syncfusion.ExcelToPDFConverter.Base.xml @@ -0,0 +1,5773 @@ + + + + Syncfusion.ExcelToPDFConverter.Base + + + + + Represents the method that handles the CurrentProgressChanged Event. + + + + + Represents the method that handles the SheetBeforDrawn Event. + + + + + Represents the method that handles the sheetAfterDrawn Event. + + + + + Event occurs when current progress changed. + + + + + Initializes a new instance of the class. + + The no of sheets. + Index of the active sheet. + The source. + + + + Gets the current progress changed. + + The current progress changed. + + + + Event occurs before sheet is drawn. + + + + + Initializes a new instance of the class. + + The current sheet. + The source. + + + + Gets or sets the current sheet. + + The current sheet. + + + + Gets or sets a value indicating whether to skip . The default value is false. + + true if skip; otherwise, false. + + + + Event occurs after sheet is drawn. + + + + + Initializes a new instance of the class. + + The after sheet. + The source. + + + + Gets the current sheet. + + The current sheet. + + + + The Syncfusion.ExcelToPdfConverter namespace contains classes for converting Excel documents into PDF. + + + + + Represent for maintain the header and footer details + + + + + Represent the PDF section. + + + + + Represent header and footer collection. + + + + + Represent page setup of worksheet. + + + + + Represent top margin of PDF page. + + + + + Represent bottom margin of PDF page. + + + + + Represent layout option of worksheet + + + + + True, if header is shown, false otherwise. + + + + + True, if footer is shown, false otherise. + + + + + Represent the PDF page template collection. + + + + + Represent footer margin or PDF page. + + + + + Represent header margin or PDF page. + + + + + Gets or sets PDF page template collection. + + + + + Gets or sets to show header in PDF page. + + + + + Gets or sets to show footer in PDF page. + + + + + Gets or sets layout option of PDF page. + + + + + Gets or sets PDF section. + + + + + Gets or sets header and footer collection. + + + + + Gets or sets page setup in PDF. + + + + + Gets or sets top margin of PDF page. + + + + + Gets or sets bottom margin of PDF page. + + + + + Gets or sets footer margin of PDF page. + + + + + Gets or sets header margin of PDF page. + + + + + Represents the conversion of Excel document to a PDF document. + + + Excel To Pdf Conversion is not supported in WinRT, Windows Phone, Universal, Portable and Silverlight platforms. + + + + + Defines a default script factor. + + + + + Defines a default number format. + + + + + Defines a text number format. + + + + + Number of bits in cell index that holds column value. + + + + + Indicates whether header has page count or not. + + + + + Indicates whether footer has page count or not. + + + + + Represent HeaderFooterImpl class collection. + + + + + Indicates the number of sections in PDF. + + + + + Indicates whether the Excel to PDF process cancelled. + + + + + Cancellation source + + + + + Defines a default coordinates for TextBox. + + + + + Represents the object of Excel sheet conditional formatting . + + + + + Indicates the object of the pdf document. + + + + + Indicates the current rendering pdf page in the document. + + + + + Indicates the active workbook of the input document. + + + + + Indicates the active worksheet of the workbook. + + + + + Indicates the chart object. + + + + + Indicates the object of the workbook Implementation class. + + + + + This object is used for the conversion between the units. + + + + + Indicates the object of the Excel to pdf converter settings object. + + + + + Indicates the object of the pdf template in which the document is drawn first. + + + + + Indicates the object of the pdf graphics of the current pdf page. + + + + + Indicates the object of the excel engine. + + + + + Indicates the object of the current Pdf section. + + + + + Represents the collection of Pdf templates. + + + + + Represents the collection of Header and Footer representations and their respecive values. + + + + + Represents the collection of table style border color list. + + + + + Reprents the collection of table style borders. + + + + + Represents the collection of the table style font list. + + + + + Represents the collection of bordrs and its XF index. + + + + + Represents the collection of the header and footer objects. + + + + + Indicates the Excelborder index width. + + + + + Indicates the no of page counts in the Pdf/ + + + + + Indicates the Bookmark for the Pdf page. + + + + + Indicates the scaled page width to which the template should be drawn. + + + + + Indicates the scaled page height to which the template should be drawn. + + + + + Indicates the list of the fonts collections to which the fonts are need to substituted. + + + + + Indicates the list of the fonts to exclude in SwitchFont + + + + + Indicates the list of the fonts supported by latin font + + + + + Indicates the object of the Table style. + + + + + Indicates the wrapped cell display text for a rotated text. + + + + + Indicates the sortedList for conditional Formatting + + + + + Indicates the unicode fonts. + + + + + It contains the alternate PdfFont collection using alternatefontstream + + + + + Style collection which dont have visible fill and borders + + + + + It's define the Pdf Page-setup. + + + + + It's define the page layout settings. + + + + + It's define the used range coloum width + + + + + It's define the used range row height + + + + + It's define the current draw sheet pagesetup information's + + + + + Represents the list of sorted border values. + + + + + Represents the list of border line styles. + + + + + Helper Methods. + + + + + Find Header Footer having the Rich Text. + + + + + Represents maximum font size in a row + + + + + Merged regions. + + + + + Represents Right width + + + + + Represents Left width + + + + + Represents Header Footer Image bounds. + + + + + Represents Header Footer RTF process. + + + + + Represents the collection of PrintTitle Pdf templates. + + + + + Indicates the object of the pdf template in which the PrintTitle is drawn first. + + + + + Indicates the first row of each page. + + + + + Indicates the first column of each page. + + + + + Indicates the current cell is merged. + + + + + Denotes the scaled page width value when the page is centered Horizontally. + + + + + Denotes the scaled page height value when the page is centered Vertically. + + + + + PDF loaded document object. + + + + + Start index of print page. + + + + + Last index of print page. + + + + + Indicates whether the document is already converted. + + + + + Represent system font name collection. + + + + + Represent style for the Option Button + + + + + Represents the substitute pdf font. + + + + + Dictionary to maintain parent elements + + + + + Dictionary to maintain the parent table elements. + + + + + Dictionary to maintain the target parent elements. + + + + + Represents the conditional format is DataBar. + + + + + List to maintain the PdfGraphicsState elements. + + + + + Indicates whether the sheet is contains chart or not. + + + + + Start position of the print page.. + + + + + List to maintain the footer template. + + + + + List to maintain the footer Bounds. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified workbook. + + The workbook. + + + + Initializes a new instance of the class with the specified worksheet. + + The worksheet. + + + + Initializes a new instance of the class with the specified chart. + + The chart. + + + + Initializes a new instance of the class with the specified file name. + + The file path. + + + + Initializes a new instance of the class with the specified stream. + + The workbook stream. + + + + Gets the LayoutOptions based on PageSetup. + + Current Page setup. + Returns the LayoutOptions. + + + + Raises a warning with the description and warning type. + + Warning detail + Type of warning + + + + Converts the document. + + Returns the PDFDocument Object + + The following code snippet illustrates how to convert the workbook. + + using Syncfusion.XlsIO; + using Syncfusion.Pdf; + using Syncfusion.ExcelToPdfConverter; + class Example + { + static void Main() + { + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ExcelToPdfConverter converter = new ExcelToPdfConverter(workbook); + PdfDocument doc = converter.Convert(); + doc.Save("Output.pdf"); + } + } + } + + + + + + Convert the Excel document to PDF + + + + + Draw worksheet comments in new Page. + + + + + Print the Excel document. + + + The following code snippet illustrates how to print the Excel document. + + using Syncfusion.XlsIO; + using Syncfusion.ExcelToPdfConverter; + class Example + { + static void Main() + { + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ExcelToPdfConverter converter = new ExcelToPdfConverter(workbook); + converter.Print(); + } + } + } + + + The assemblies Syncfusion.ExcelToPDFConverter.dll and Syncfusion.PDF.Base.dll is essential to print Excel documents. + + + + + + Print the Excel document with specified printer settings. + + The printer settings. + + The following code snippet illustrates how to print the Excel document. + + using Syncfusion.XlsIO; + using Syncfusion.ExcelToPdfConverter; + using System.Drawing.Printing; + class Example + { + static void Main() + { + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ExcelToPdfConverter converter = new ExcelToPdfConverter(workbook); + PrinterSettings printerSettings = new PrinterSettings(); + converter.Print(printerSettings); + } + } + } + + + The assemblies Syncfusion.ExcelToPDFConverter.dll and Syncfusion.PDF.Base.dll is essential to print Excel documents. + + + + + + Print the Excel document with specified Excel to PDF converter settings. + + The converter settings. This will be ignored if the document is already converted. + + The following code snippet illustrates how to print the Excel document. + + using Syncfusion.XlsIO; + using Syncfusion.ExcelToPdfConverter; + class Example + { + static void Main() + { + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ExcelToPdfConverter converter = new ExcelToPdfConverter(workbook); + + ExcelToPdfConverterSettings converterSettings = new ExcelToPdfConverterSettings(); + converterSettings.LayoutOptions = LayoutOptions.FitAllColumnsOnOnePage; + converter.Print(converterSettings); + } + } + } + + + The assemblies Syncfusion.ExcelToPDFConverter.dll and Syncfusion.PDF.Base.dll is essential to print Excel documents. + + + + + + Print the Excel document with specified printer and Excel to PDF converter settings. + + The printer settings. + The converter settings. This will be ignored if the document is already converted. + + The following code snippet illustrates how to print the Excel document. + + using Syncfusion.XlsIO; + using Syncfusion.ExcelToPdfConverter; + using System.Drawing.Printing; + class Example + { + static void Main() + { + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ExcelToPdfConverter converter = new ExcelToPdfConverter(workbook); + + PrinterSettings printerSettings = new PrinterSettings(); + ExcelToPdfConverterSettings converterSettings = new ExcelToPdfConverterSettings(); + converterSettings.LayoutOptions = LayoutOptions.FitAllColumnsOnOnePage; + converter.Print(printerSettings, converterSettings); + } + } + } + + + The assemblies Syncfusion.ExcelToPDFConverter.dll and Syncfusion.PDF.Base.dll is essential to print Excel documents. + + + + + + Print the PDF document. + + The PDF document to be print. + The printer settings. + + + + Helper method for Printing the document page. + + + + + Add the styles (Index) dont have visible fill and border + + + + + To draw the chart Sheet in to pdf + + workbook chart + sheets count + layout options for the chart sheet + + + + + To draw the workbook chart in pdf + + It's represent the chart object + pdf template for the workbook chart + + + + Converts the document with the specified converter settings. + + The converter settings. + Returns the PDFdocument object + + The following code snippet illustrates how to convert the workbook. + + using Syncfusion.XlsIO; + using Syncfusion.ExcelToPdfConverter; + class Example + { + static void Main() + { + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ExcelToPdfConverter converter = new ExcelToPdfConverter(workbook); + + ExcelToPdfConverterSettings converterSettings = new ExcelToPdfConverterSettings(); + converterSettings.LayoutOptions = LayoutOptions.FitAllColumnsOnOnePage; + PdfDocument doc = converter.Convert(converterSettings); + doc.Save("Output.pdf"); + } + } + } + + + + + + Called when [progress changed]. + + The no of sheets. + Index of the active sheet. + + + + Raises the event. + + + The instance containing the + event data. + + + + + Called when [sheet after drawn]. + + Index of the active sheet. + + + + Raises the sheet before drawn. + + Index of the active sheet. + the boolean values + + + + Releases both unmanaged and managed resources. + + + + + Releases unmanaged and optionally managed resources + + + true to release both managed and unmanaged resources; false to release only + unmanaged resources. + + + + + Draws the sheet. + + The work sheet. + Ranges to be Drawn + pdfdocument object + + + + Update the Sheet width and height. + + The first column. + The first row. + + + + Gets center width and height values according to the page templates. + + First row that can be drawn in the Pdf page + First column that can be drawn in the Pdf page + Last row that can be drawn in the Pdf page + Last column that can be drawn in Pdfpage + List of center width values + List of center height values + + + + It's finding the scaled page width and height + + + + + + + + + + + + Add HeaderFooterImpl class in header footer collection + + header footer collection + Worksheet + Chart sheetc + PDF page template + + + + Calculates the scaled page height value when centered vertically property is set. + + + + Returns the scaled page height value + + + + Calculates the scaled page width value when centered horizontally property is set. + + + + Returns the scaled page width value + + + + Get margins for center alignment. + + + + + Draws the split text. + + Center width values. + Center height values. + + + + Returns PDF font from system font. + + System Font. + Is font embeded. + Alternate font stream. + returns the PF font + + + + Draws the split text. + + The split text. + + + + Draws the Header and Footer to the PDF page . + + The Pdf section. + The header footer collection. + The Worksheet. + The Pdf page. + Height of the header. + Height of the footer. + Top Margin + Bottom Margin + + + + Returns header footer teample. + + The sheet page setup. + The pdf page. + Template height. + Pdf template. + + + + Draws the row. + + The wk sheet. + The start column. + The end column. + The start row. + The end row. + The x value. + The y value. + Width of the original. + The Object of Pdf Document. + + + + Draws the row. + + The wk sheet. + The start column. + The end column. + The start row. + The end row. + The x value. + The y value. + The start x value. + The start y value. + The height of range + The Width of range + Width of the original. + The Object of Pdf Document. + + + + Draws all necessary shapes. + + It's represent the worksheet + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + The x value. + The y value. + + + + Draws all necessary shapes. + + It's represent the worksheet + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + The x value. + The y value. + + + + Draws all the shape in the shape collection. + + It's represent the worksheet + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + The x value. + The y value. + + + + Get Range Border X and Y + + Cell + Identify the X or Y axis + + + + + Transparancy is applied if it is required + + The graphics + The shape + Apply transparency for line + + + + Draws the shape. + + It's represent the Textbox + Pdf Graphics + First row + First Column + Last row of chart shape + Last column of chart shape + Starting point of chartshape-X Point + starting point of chartshape - Y point + + + + Check whether the AutoShape type is line. + + AutoShape to be checked. + Returns true if the AutoShape is a type of line else returns false. + + + + + + + + + + + + + + + + + + + + + + + + + + + Draws the ComboBox. + + Rectangle bounds of the combobox to be rendered + It's represents the combobox properties + It's represents the pen to draw the combo box + It's used to set the color for combobox pen + Represents the path for rendering the Combobox + It's represents the bounds of the Combo box filled with gray color + Pdf Graphics + + + + Draws the CheckBox. + + Rectangle bounds of the checkbox to be rendered + It's represents the checkbox properties + Represents the path for rendering the Checkbox + It's represents the pen to draw the checkbox + It's used to set the color for checkbox pen + Pdf Graphics + + + + Draws the Option Button. + + Rectangle bounds of the optionButton to be rendered + It's represents the optionButton properties + Represents the path for rendering the optionButton + It's represents the pen to draw the optionButton + It's represents the pen to draw the optionButton + It's used to set the color for optionButton pen + Pdf Graphics + + + + Check whether the AutoShape type is line. + + AutoShape to be checked. + Returns true if the AutoShape is a type of line else returns false. + + + + Draw Rich text inside the AutoShape. + + RichText object that holds the formatted text. + AutoShape for which text should be rendered. + Rectangle bounds of the text to be rendered.. + PdfGraphics object to render the RichText. + + + + Get the anchor position from text direction and alignment + + input text direction of the text body + input text body vertical alignment + input text body horizontal alignment + + + + Updates the bound's of the text inside the AutoShape. + + Rectangle bounds of the text inside the AutoShape. + Rectangle bounds of the AutoShape. + AutoShape for which text bounds should be updated. + + + + Gets the text layout's bounds for the AutoShape. + + AutoShape for which the text bounds should be obtained. + Bound value of the shape from which text bounds to be calculated. + Rectangle bound values for the text inside the AutoShape. + + + + Check whether shape can be set fill or not. + + Shape to check. + Returns true if fill can be applied to shape else returns false. + + + + Checks and applies fill to autoshapes and textboxes. + + pdfPath of the autoshape/textbox. + shape for which fill has to be applied. + pdfPen to draw autoshape. + pdfGraphics to draw autoshape into. + Rectangle bounds of the shape. + + + + Creates image in the meta format. + + Boundary values of the image. + Memorystream to save the image to. + Newly created image stream. + + + + Fills the shape background. + + pdfGraphics to apply fill to. + Shape for which fill should be applied. + Path of the shape on the PdfGraphics. + Fill format of the shape. + + + + Get Gradient Brush for shapes + + Shape for which fill should be applied. + Path of the shape on the PdfGraphics. + Fill format of the shape. + + + + + Linear Gradient Fill implementation. + + + Collection of colors with respective positions + Path of the shape on the PdfGraphics. + Fill format of the shape. + + + + + Radial Gradient Fill implementation. + + + Collection of colors with respective positions + Path of the shape on the PdfGraphics. + Fill format of the shape. + + + + + Gets the Pdf hatch brush for the given fill format. + + Format for which hatch brush should be obtained. + Newly created pdf hatch brush. + + + + Gets the hatch style for the Pdf brush. + + Pattern for which the brush should be obtained. + Equivalent pdf hatch style for the pattern. + + + + Gets the graphics path for autoshapes. + + Bounds to indicate the size of the autoshape. + PdfPen to draw outlines of the autoshapes. + pdfGraphics object in which autoshapes has to be drawn. + Autoshape for which path should be obtained. + Newly created pdfPath for the autoshape. + + + + Get drark color. + + Fill color + Increase or decrease the color vlaue based on given value. + Fill color + + + + Gets the graphics path for autoshapes. + + Bounds to indicate the size of the autoshape. + PdfPen to draw outlines of the autoshapes. + pdfGraphics object in which autoshapes has to be drawn. + Autoshape for which path should be obtained. + Newly created pdfPath for the autoshape. + + + + Caches range's merges. + + First Row. + First Column. + Last Row. + Last Column. + List to save merges in + + + + Creates the pen. + + The format of the line. + The PdfPen object. + + + + Creates pen with line format + + shape which line format is to be created. + line format of the shape. + + + + + Creates pen with line format + + shape which line format is to be created. + line format of the shape. + + + + + Gets the dash style. + + The format of the line. + The PdfDashStyle value. + + + + Gets the custom line head style. + + Head style of the arrow. + Head lenght of the arrow. + Head width of the arrow. + + + + + Gets the custom line style's graphics path. + + Arrow head style of the line. + Arrow head length of the line. + Arrow head width of the line. + Base in set value. + + + + + Gets the Arrow head's style value. + + Arrow head's style. + Graphics path to draw. + Style value to be returned. + Returns true if not drawn else returns false. + + + + Gets the custom line head style. + + Head style of the arrow. + Head lenght of the arrow. + Head width of the arrow. + + + + + Gets the custom line style's graphics path. + + Arrow head style of the line. + Arrow head length of the line. + Arrow head width of the line. + Base in set value. + + + + + Gets the Arrow head's style value. + + Arrow head's style. + Graphics path to draw. + Style value to be returned. + Returns true if not drawn else returns false. + + + + Gets the width of the line + + The format of the line. + The borderWidth of the line index. + + + + Draws the headers and footers. + + The PDF section. + The sheet impl. + The chart to be drawn + The collection of the header and footer objects. + + + + Draws the lines. + + The sheet. + The first row. + The first column. + The last row. + The last column. + The graphics. + The x value. + The y value. + The width. + The height. + + + + Iterates the merges. + + The sheet. + The first row. + The first column. + The last row. + The last column. + The graphics. + The x value. + The y value. + The method. + Width of the i original. + + + + Draws the merge. + + The sheet. + The merged region. + The first row. + The first column. + The graphics. + The x value. + The y value. + The last row. + The last column. + Width of the i original. + + + + Converts page setup PrintErrors option into string representation used by Excel 2007. + + Cell to get print value. + Converted value. + + + + Draws the back ground. + + The sheet. + The first row. + The first column. + The last row. + The last column. + The graphics. + The x value. + The y value. + The method. + Width of the i original. + + + + Draw the data bar + + ExtendedFormatStandAlone + percent of the data bar + left of the rectangle + right of the rectangle + top of the rectangle + bottom of the rectangle + x of the rectangle + y of the rectangle + width of the rectangle + height of the rectangle + The sheet + The graphics + the cell range + Return the rectangle in float + + + + Indicates whether the cell is merged or not. + + Cell. + Returns true if the cell is merged otherwise false. + + + + Draws the background. + + The cell range. + The cell rectangle. + The pdf page graphics object. + + + + Draws the background. + + The internal extended format. + The cell rectangle. + The pdf page graphics. + The cell range. + + + + Get Gradient Brush + + The cell gradient fill. + The cell rectangle. + the PdfBrush object + + + + Draws the merged background. + + The sheet. + The merged region. + The first row. + The first column. + The graphics. + The x value. + The y value. + The last row. + The last column. + Width of the i original. + + + + Gets the width of the merged cells. + + The first column. + The last column. + The merged first column. + The merged last column. + + + + + Draws the cells. + + The sheet. + The first row. + The first column. + The last row. + The last column. + The graphics. + The x value. + The y value. + Width of the i original. + Width of the cell + + + + Draws the cell. + + The migrant cell range. + The cell rectangle. + The adjacent cell rectangle. + The pdf page graphics. + The width of Merged Cell + The cell is last cell of the sheet or not + + + + Add tag elementes to Table. + + + + + Add tag elementes to Pivot Table. + + + + + Draws the cell. + + The extended format impl. + The cell range. + The cell rectangle. + The adjacent cell rect. + The pdf page graphics. + The width of Merged Cell + The cell is last cell of the sheet or not + + + + Add tag elemnets for new Table + + + + + Add tag elemnets for Table With ConditionalFormat + + + + + Get the text margin based on font size. + + Cell text font size + Text margin based on font size. + + + + Returns PDF font from system font. + + System Font. + Is font embeded. + Alternate font stream. + returns the PF font + + + + Draws IconSet image. + + The pdf page graphics. + The extended format of the cell. + The adjacent cell rect. + The Pdf font in the cell. + The display text of the cell. + + + + Returns right alignment if the first character is rtl otherwise left. + + Cell text character codes. + returns PdfTextAlignment. + + + + Fill the text into the given bounds. + + Cell bounds + Cell text + Pdf font + + + + + Draw the RTf text. + + The cell rectangle. + The cell adjacent rectangle. + The pdf graphics. + Font collection. + DrawString collection. + Indicating wheather shape or not. + Indicating wheather is wrapText or not + Indicating wheather shape Horizontal Text is overflow or not + Indicating wheather shape vertical Text is overflow or not. + Indicating wheather the header footer or not + + + + Draws the rotated text. + + The adjacent cell rect. + The extended format impl of the cell. + The cell range. + The cell display text. + The pdf page graphics. + The native font. + The pdf brush. + The pdf string format. + First char width of the display text . + The total width of the display text. + Last char size of the display text . + + + + Aligns the rotated text based on pdf string format. + + Pdf string format. + Rotation angle. + Shape object + returns Pdf string format. + + + + Draws the borders. + + The border collections of the cell. + The rectangle of the cell. + The pdf page graphics. + The cell range. + + + + Draws the borders as MS Excel. + + The border collections of the cell. + The rectangle of the cell. + The pdf page graphics. + The cell range. + The cell is last cell of the sheet or not + + + + Sort border line style. + + + + + Fill border line style. + + + + + Calculate the color contrast of the cell borders. + + The border collections of the cell. + Border index. + + + + Sort the dictionary by its values. + + + + + Draw all border lines. + + + + + Draw single border. + + The borders collection of the cell. + The cell Excel border indez. + The x1 point of the border line. + The y1 point of the border line. + The x2 point of the border line. + The y2 point of the border line. + The pdf page graphics. + The cell range. + Color of the cell border. + border index. + check is this is first border. + Border index to fill edge. + + + + Checks conditional formats and updates if border is to be drawn + + Border index of the cell + Current cell being manipulated + Boolean value indicating if teh specified border index can be drawn + + + + + Draws the border. + + The borders collection of the cell. + The cell Excel border indez. + The x1 point of the border line. + The y1 point of the border line. + The x2 point of the border line. + The y2 point of the border line. + The pdf page graphics. + The cell range. + Color of the cell border. + Border Index of the cell + + + + Gets left adjecent cell. + + Range + + + + Gets rigth adjecent cell. + + Range + + + + Gets top adjecent cell. + + Range + + + + Gets bottom adjecent cell. + + Range + + + + Gets relative cell. + + Row + Column + Range + Range + + + + Draws the double border. + + The borders collection of the cell. + The Excel cell border Index. + The x1 point of the border line. + The y1 point of the border line. + The x2 point of the border line. + The y2 point of the border line. + The pdf page graphics. + The cell range. + Color of the cell border. + + + + Draws the outer line. + + The pdf page graphics. + The pdf pen to draw the border. + Index of the border . + The x1 point of the border line. + The y1 point of the border line. + The x2 point of the border line. + The y2 point of the border line. + The delta X. + The delta Y. + The cell range. + + + + Draws the inner line. + + The pdf page graphics. + The pdf pen to draw the border. + The borders collection of the cell. + Index of the border . + The x1 point of the border line. + The y1 point of the border line. + The x2 point of the border line. + The y2 point of the border line. + The delta X. + The delta Y. + The cell range. + + + + Draws the ordinary border. + + The Excel border index. + The x1 point of the border line. + The y1 point of the border line. + The x2 point of the border line. + The y2 point of the border line. + The pdf page graphics. + Color of the border. + Border index of the cell + + + + Draws the images. + + The sheet. + Return the Pdf document with the image. + + + + Draws all necessary images. + + Shape to draw as image. + Image to draw in pdf page. + PdfGraphics to draw cells at. + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + The x value. + The y value. + + + + Get Image has external properties or not. + + BitmapShape + Image rectangle + Image width + Image height + True if image has external properties style, otherwise false + + + + Apply Image transparency. + + In where the transparency need to apply. + Transparency to apply. + + + + Apply recolor to the give image. + + In where the recolor need to apply. + Picture shape. + Recolored image. + + + + Apply duotone to the give image. + + Picture shape. + ImageAttributes need to be applied. + Color changed ImageAttributes. + + + + Apply duotone to the give image. + + In where the duotone need to apply. + duotone color informations. + Duotone applied image. + + + + Executes Linear interpolation for Duotone. + + In where the factor is applied. + In where the factor is applied. + Factor value. + Final factorized color. + + + + Create Non-Index image from source image. + + Source Image. + Created Non-Indexed image. + + + + Convert EMU to Point. + + EMU value. + Point value. + + + + Update the image width in points. + + The image. + Image width. + + + + Update the image height in points. + + The image. + Image height. + + + + Rotate Shape. + + Pdf page graphics. + Shape. + Shape bounds. + + + + Checked whether the group shape contains Horizontal flip. + + Group Shape. + True if the group shape contains flip.. + + + + Checked whether the group shape contains Vertical flip. + + Group Shape. + True if the group shape contains flip.. + + + + Get Horizontal flip count. + + Group Shape. + Flip count. + Flip count. + + + + Get Vertical flip count. + + Group Shape. + Flip count. + Flip count. + + + + Gets the lattitude value of the shape from Scene 3D. + + AutoShape for which the lattitude value should be obtained. + Boolean value indicates whether AutoShape is flipped horizontally. + Rotation angle of the AutoShape. + + + + Applies rotation for the AutoShape/Textbox. + + Shape for which rotation should be applied. + Rectangle bound values of the Shape. + Rotation angle to apply the rotation. + PdfGraphics to render the Shape. + + + + Rotates the text bounds of the Shape. + + Current rectangle bound. + Direction of the text. + + + + Gets the transformation matrix for the AutoShape. + + Rectangle bounds of the AutoShape. + Rotation angle to be applied. + Horizontal flip. + Vertical flip. + Transformed matrix value in which shape will be rendered. + + + + Prepares a matrix to PDF. + + Render bounds. + Rotation Angle. + + A properly prepared PdfTransformationMatrix class instance. + + + + + Set hyperlink to shape + + The shape. + Shape bounds. + + + + It's draw the worksheet chart's to the pdf + + It's represent the chartshape + Pdf Graphics + First row + First Column + Last row of chart shape + Last column of chart shape + Starting point of chartshape-X Point + starting point of chartshape - Y point + + + + Crops the image with the specified offset. + + Source image to crop. + Left offset to crop from. + Top offset to crop from. + Right offset to crop. + Bottom offset to crop. + Indicates whether the destination image is transparent. + Returns the cropped image for the offsets specified. + + + + returns float array which contains preserved height and width. + + preserved style for header and footer + height and width of header/footer image + + + + returns float value from preserved style. + + Preserved style for width and height + + + + Draws the header and footer images. + + The worksheet object. + Image width. + Image height. + The pdf page template. + The alignment of the header and footer text. + The name represents the header part or footer part. + The PDF section. + + + + + + + + + + + Initializes the PDF page. + + + + + Intializes the header and footer. + + The sheet. + + + + Initialize the default header and footer for chartsheet + + + + + + Intializes the fonts. + + + + + Represent the system font name added the collection. + + + + + Intializes the Remoable Characters + + + + + Gets the adjacent cell size. + + The cell rnage. + The cell rectangle. + Denotes whether the last column is changed or not + The first column of the range. + The adjacent cell. + Width of the sheet. + The Adjacent cell RectangleF + + + + Gets the vertical coordinates of image background. + + The X coordinate. + The Y coordinate. + Width of the image. + Height of the image. + The image coordinate. + The PDF page. + + returns the vertical coordinates of image background. + + + + + Gets the horizontal coordinates of image background. + + The X coordinate. + The Y coordinate. + Width of the image. + Height of the image. + The image coordinate. + The PDF page. + + Returns the horizontal coordinates of background image. + + + + + Gets the width of the border. + + The border. + The borderWidth of the Excel border Index. + + + + Get the border based on priority for using compare the two border. + + Boder lineStyle + + + + Get the brightness of color. + + + + + + + Gets the bottom text. + + The value. + The rotation angle. + The text to be displayed in the rotated Text. + + + + Gets the brush. + + The internal extended format of the cell. + The PdfBrush object. + + + + Gets the counter clockwise rotation. + + The rotation angle. + The rotation angle as an MS Excel representation. + + + + Gets the dash style. + + The border. + The PdfDashStyle value. + + + + Checks the index. + + The index. + The text. + The split value. + The value. + + + + + Gets the display wrap text list. + + The PDF font. + The PDF string format. + The cell text value. + The cell rectangle. + The list of wrapped text. + + + + Gets the display wrap text list. + + The PDF font. + The PDF string format. + The cell text value. + The cell rectangle. + The split text list. + The List of wrapped text. + + + + Gets the font. + + The font object of the cell. + Name of the font. + The size of the font. + Font object + + + + Gets the font. + + The name of the font. + The size of the font. + The settings of the font + Denotes whether the font has underline or not + Font object + + + + Gets the font. + + The name of the font. + The size of the font. + Font object + + + + Gets the header footer information. + + The header footer collection. + The header footer section + The PDF section. + The font color settings. + The PDF template. + The width of the header or footer. + The height of the header or footer. + The alignment of the header and footer text. + The name represents either the header or footer. + The page number of the pdf document. + The page setup for pdf document + + + + Update Header and footer text. + + Headerfooter section + current string + RichTexting + Rich text collection + current richtext index + + + + Gets the header information. + + The font color settings. + The alignment of the header and footer Text. + The name represets either the header part or the footer part. + The height of the Header or Footer. + The width of the Header or Footer. + Width of the page. + The page setup for pdf document + + + + Returns size of the string part. + + Start position. + End position. + Rich text string. + Size of the string part. + + + + Measure and return the size of the given text. + + String to measure + System Font. + Size of the string. + + + + Gets the header footer options. + + The dictionart collection of the header and footer page setups. + The PDF section. + The worksheet object. + Width of the template. + The name represents either the header part or the footer part. + It's Represent the sheet or chart name + + + + + Modifies the specified string to pass String.Format(). + + The header or footer string to be modified to escape '{' or '}'. + Modified header/footer string. + + + + To get the headerfooter font color settings + + The splitted header footer values. + Header footer values count. + The color settings for the header footer. + Specifies a boolean value indicating if ampersand (&) is removed in header footer string. + The color settings loaded from header footer string. + + + + Gets the color of the header footer text color. + + The color value. + The HeaderFooter Text color. + + + + Checks whether the string contains the digit or not. + + string values + + + + Checks whether the string contains the digit or not. + + font value + + + + Gets the horizontal alignment from extended format. + + The extended format style. + The cell range. + The PdfTextAlignment value. + + + + Gets the horizontal left. + + The rotation angle of the cell display text. + Length of the string. + The cell rectangle. + The vertical alignment of the cell text. + First char size of the display text . + The native font of the cell text. + The pdf string format. + The vector for the text rotation. + + + + Gets the horizontal right. + + The rotation angle of the cell display text. + Length of the string. + The cell rectangle. + The vertical alignment of the cell text. + Last char size of the display text. + First char size of the display text . + The native font of the cell text. + The pdf string format. + The vector for the text rotation. + + + + Gets the horizontal center. + + The rotation angle of the cell display text. + Length of the string. + The cell rectangle. + The vertical alignment of the cell text. + Last char size of the display text. + First char size of the display text . + The native font of the cell text. + The pdf string format. + The vector for the text rotation. + + + + Gets the Max height of the HeaderFooterSection. + + The sections. + The Maximum value. + + + + Gets the width of the max. + + The sizes. + + + + + Gets the max value. + + The max list. + The maximum value + + + + Gets the max value. + + The max list. + The maximum value. + + + + Gets the merged rectangle. + + The sheet. + The merged region. + The first row. + The first column. + The last row. + The last column. + The start x value. + The start y value. + The Merge Rectangle Coordinates. + + + + Gets the resized image. + + The original image. + The width. + The height. + The resized Image. + + + + Gets the adjacent range. + + The cell. + + + + + Gets the scaled page. + + Width of the original. + Height of the original. + Width of the max. + Height of the max. + if set to true [fit page]. + + + + Gets the scaled page. + + Width of the original. + Height of the original. + Width of the max. + Height of the max. + if set to true [fit page]. + + + + Gets the scaled picture. + + The original image. + Width of the max. + Height of the max. + The scaled Image + + + + Gets the scaled picture width height. + + The original image. + Width of the max. + Height of the max. + The scaled Image + + + + Gets the width of the sorted. + + The align. + The temps. + Width of the divided. + + + + + Gets the splitted header and footer text. + + The page setup. + The Array of splitted strings + + + + Replaces ascii character in the string with Dollar ($) symbol. + + Array of header/footer strings. + Modified array of header/footer strings. + + + + Gets the start index of the end border. + + Index of the Excel border. + The start Excelborder index. + The end Excel border index. + + + + Gets the height of the template. + + The page setup object of the sheet. + The name represents either the header part or the footer part. + The alignent of the header and footer text. + Height of the image. + Width of the image. + + + + Update the image width and height in points. + + The image. + Image height. + Image width. + + + + Gets the text alignment from shape. + + The shape. + The PdfTextAlignment value. + + + + Gets the vector. + + The rotation angle of the cell display text. + Length of the string. + The cell rectangle. + The horizontal alignment of the cell text. + The vertical alignment of the cell text. + Last char size of the display text. + First char size of the display text . + The native font of the cell text. + The pdf string format. + The vector for the text rotation. + + + + Gets the vector. + + The rotation angle of the text within the cell. + The total width of the display text. + The adjacent cell rect. + The extended format impl of the cell. + Last char size of the display text. + First char size of the display text . + The native font of the cell. + The pdf string format. + The vector for the text rotation + + + + Gets the vertical alignment from extended format. + + The style. + The PdfVerticalAlignment value + + + + Gets the vertical alignment from shape. + + The text box shape. + The pdfVerticalAlignment value + + + + Sets the document properties. + + + + + Sets the hyper link. + + The cell rectangle. + The range to which hyperlink is to be set + + + + Sets the hyper link from formula. + + The cell rectangle. + The range to which hyperlink is to be set + Formula of the cell + + + + Updates the friendly name part to URI part to calculate the URI value + + cell hyperlink formula + + + + + To Resize the hyperlink position for fit in the pdf page. + + + + + + + Gets the actual used range. + + The sheet. + The IRange object + + + + Updates the used Range + + The Worksheet + Actual used range of worksheet + Returns the updated used range + + + + Check whether the given range is empty or not. + Exclude hidden rows and columns. + + The range. + Returns True if the range is Blank otherwise False. + + + + Adds the book mark. + + + + + Checks the range. + + The table range. + The sheet range. + True if the sheet range is within the table range else false will be returned. + + + + Checks the unicode. + + The unicode text. + + True if the text is an unicode else false will returned. + + + + + Checks whether the unicode characters are only punctuations + 8208,8286 are the starting and ending utf-8 value of punctuations + + + + + + + Determines whether [has merged region] [the specified i range]. + + The i range. + + true if [has merged region] [the specified i range]; otherwise, false. + + + + + Checks if array of flags contains at least on RTL symbol. + + Array of flags. + True if array of flags contains at least on RTL symbol, False otherwise. + + + + Creates the pen. + + The border. + Color of the border. + The PdfPen object. + + + + Degrees to radian. + + The angle. + Radian value + + + + Normalizes the color. + + The color. + The Normailzed Color + + + + The function used to identify the required width. + + Width of the excel sheet. + Height of the sheet. + Height of the excel sheet. + Returns the required width + + + + The function used to identify the required height. + + Width of the excel sheet. + Width of the sheet. + Height of the excel sheet. + Returns the required height + + + + Updates the border delta. + + The sheet. + The row of the excel sheet. + The column of the excel sheet. + The delta X. + The delta Y. + The delta x1. + The delta y1. + if set to true [is invert condition]. + The borders collection of the cell. + The start Excel border index. + The end Excel border index. + if set to true [is line start]. + + + + Updates the rectangle coordinates. + + The cell rectangle. + The borders collection of the cell. + The updated Rectangle coordinates + + + + To update the used range for the shape + + Represents the worksheet + Represents the actual range + + + + + To update the used range for the chart shape + + + + + + + + Draw the Pdf HeaderFooter + + The page setup for pdf document + Represent the pdf Section for drawing the HeaderOrFooter + Used to identify the Header or Footer + Used to identify the chart + Return the pdfpagetemplete element + + + + Draw the Pdf Header Footer string + + PdfPagetemplate-HeaderOrFooter + HeaderOrFooter Section + + + + Modifies font name so as to render Unicode characters. + + The sting in test for Unicode characters. + The Charset of the font. + The name of the font. + + + + + Gets fall back font extension to preserve the text in converted Image. + + Represent fontName. + Represent testString. + Represent FallbackFonts. + Returns a fall back font instance, if it has; otherwise returns original Font. + + + + Check unicode symbols for unicode string + + string + True, if string value as unicode symbol, otherwise false. + + + + The text string is can draw current font name or not. + + The current font name + the current cell text + Returns the current cell text font name + + + + Get the text have symbols + + The given text + If text have symbols return true + + + + Checks for Segoe UI symbols characters in the Unicode string + + Input Unicode string + True if the Unicode string contain Segoe UI symbols characters. False otherwise + + + + Checks for Segoe UI Emoji symbols characters in the Unicode string + + Input Unicode string + True if the Unicode string contain Segoe UI Emoji Symbols characters. False otherwise + + + + Checks for Segoe UI Emoji symbols characters in the Unicode string + + Input Unicode string + True if the Unicode string contain Segoe UI Emoji symbols characters. False otherwise + + + + Checks for Segoe UI Emoji symbols characters in the Unicode string + + Input Unicode string + True if the Unicode string contain Segoe UI Emoji symbols characters. False otherwise + + + + Checks for amharic characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Amharic characters. False otherwise. + + + + Checks for khmer characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Khmer characters. False otherwise. + + + + Checks for thai characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Thai characters. False otherwise. + + + + Checks for sinhala characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Sinhala characters. False otherwise. + + + + Checks for myanmar characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Myanmar characters. False otherwise. + + + + Checks for tamil characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Tamil characters. False otherwise. + + + + Checks for telugu characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Telugu characters. False otherwise. + + + + Checks for punjabi characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Punjabi characters. False otherwise. + + + + Checks for malayalam characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Malayalam characters. False otherwise. + + + + Checks for kannada characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Kannada characters. False otherwise. + + + + Checks for gujarati characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Gujarati characters. False otherwise. + + + + Checks for marathi characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Marathi characters. False otherwise. + + + + Checks for bengali characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Bengali characters. False otherwise. + + + + Checks for odia characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Odia characters. False otherwise. + + + + Checks for Latin characters in the Unicode string. + + Input Unicode string. + True if the Unicode string does not contain Latin characters. False otherwise. + + + + Checks for CJK characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contains CJK characters. False otherwise. + + + + Checks for Hebrew or Arabic characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contains Arabic or Hebrew characters. False otherwise. + + + + Checks for Korean characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contains Korean characters. False otherwise. + + + + Checks whether the image is transparent or not. + + Input Image + Returns whether the image is transparent or not + + + + Get the Scale Transform value + + + + + Set the tag element + + + + + Get system font name collection. + + + + + Represents the warning detail about unsupported and substituted elements in Excel to PDF conversion. + + + + + Represents Header Footer RTF Process. + + + + + Represents Left width. + + + + + Represents Right width. + + + + + Represents Excel to pdf converter settings. + + + + + Represents Header Footer Image bounds. + + + + + Get or set the alternate pdf font while applying substitute font. + + + + + Occurs when current progress changed. + + + + + Occurs before the sheet is drawn. + + + + + Occurs after the sheet is drawn. + + + + + Represents the chart to image converter instance. + + + + + Gets a value indicating whether this instance is print title row page. + + + true if this instance is print title row page; otherwise, false. + + + + + Gets a value indicating whether this instance is print title column page. + + + true if this instance is print title column page; otherwise, false. + + + + + Gets the row height getter. + + + + + Gets the column width getter. + + + + + PDF Unit Converter. + + + + + Delegate for Merged cell rendering. + + + + + Delegate for background cell rendering. + + + + + Returns the when trying to convert the Excel document to a PDF document. + + + + + Default message. + + + + + Initializes a new instance of the class with an empty error message. + + + + + Initializes a new instance of the class with a specified error message. + + Error message. + + + + True if rendering sheet by sheet, otherwise false. + + + + + Enables the complex script detection. + + + + + Represents the Header footer option of the output document. + + + + + Represents the display style of the gridlines in the output document. + + + + + Indicates whether to embed the fonts to the output pdf document. + + + + + Indicates whether the output pdf sheet should be rendered from right to left. + + + + + Indicates whether to export the bookmarks to the output pdf document. + + + + + Indicates whether to export the document properties to the output pdf document. + + + + + TRUE - Use TIFF Quality Image while converting Excel to PDF document,otherwise FALSE + + + + + Represents the layout mode of the output sheet. + + + + + Represents the Need Blank Option + + + + + Indicates whether to export the blank PDF page in the output pdf document. + + + + + Represents the Pdf document object. + + + + + TRUE - Throw exception when excel file is empty,otherwise FALSE + + + + + Represents the custom paper size + + + + + Represents Conformance level of PDF + + + + + Represents the warning details. + + + + + Enables the form fields conversion + + + + + Boolean value indicating whether the accessibility tags should be enabled + + + + + Enables the file extension in header and footer + + + + + Initializes a new instance of the class. + + + + + Gets the size of the excel sheet. + + Size of the paper. + Excel to PDF converter settings.> + The Size of the output pdf page. + + + + Gets or sets value to indicate whether the PDF rendering to be done sheet-by-sheet or not. + + + + + Gets or sets a value indicating whether to display the file extension along with file name in the header footer or not, when converting an Excel to PDF. The default value is false. + + + + using Syncfusion.XlsIO; + using System.Text; + using Syncfusion.Pdf; + using Syncfusion.ExcelToPdfConverter; + class Example + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Fund_Calendar_KF-US_2018.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ExcelToPdfConverterSettings setting = new ExcelToPdfConverterSettings(); + setting.ShowFileNameWithExtension = true; + + ExcelToPdfConverter converter = new ExcelToPdfConverter(workbook); + PdfDocument doc = converter.Convert(setting); + doc.Save("Output.pdf"); + } + + + + + + + Gets or sets a value to enable complex script validation for the text present in the Excel document and render it in PDF conversion. + Default value is FALSE. + + + + using Syncfusion.XlsIO; + using System.Text; + using Syncfusion.Pdf; + using Syncfusion.ExcelToPdfConverter; + class Example + { + static void Main() + { + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Fund_Calendar_KF-US_2018.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ExcelToPdfConverterSettings setting = new ExcelToPdfConverterSettings(); + setting.AutoDetectComplexScript = true; + + ExcelToPdfConverter converter = new ExcelToPdfConverter(workbook); + PdfDocument doc = converter.Convert(setting); + doc.Save("Output.pdf"); + } + } + } + + + + + + Gets or sets the PDF template document. + + + + + Gets or sets the style of grid lines. + + + + + True if the font is an embedded font. The default value is False. + + + + + Gets or sets a value indicating whether to export bookmarks. The default value is True. + + + + + Gets or sets a value indicating whether to export document properties. The default value is True. + + + + + Gets the header and footer option. + + + + + Gets or sets the layout mode. + + The layout mode. + + The following code snippet illustrates how to set the lay out options. + + using Syncfusion.XlsIO; + using Syncfusion.ExcelToPdfConverter; + class Example + { + static void Main() + { + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ExcelToPdfConverter converter = new ExcelToPdfConverter(workbook); + + ExcelToPdfConverterSettings converterSettings = new ExcelToPdfConverterSettings(); + converterSettings.LayoutOptions = LayoutOptions.FitAllColumnsOnOnePage; + PdfDocument doc = converter.Convert(converterSettings); + doc.Save("Output.pdf"); + } + } + } + + + + + + Gets or sets a value indicating whether [enable RTL]. + + true if [enable RTL]; otherwise, false. + + + + Gets or sets a value indicating whether to throw exception when empty Excel document is being converted to a PDF + document. + + + + + Gets or sets a value indicating whether to export quality image. The default value is False. + + + + + Gets or sets a value indicating whether to convert blank sheet. The default value is true. + + + + + Gets or sets a value indicating whether to convert blank PDF page. The default value is true. + + + + + Gets or sets a Custom paper size in inches. The default value is empty(i.e.,{Width = 0.0 Height = 0.0}) + + + The following code snippet illustrates how to set the custom page size for the document. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + + //Open the file as Stream + FileStream excelStream = new FileStream("Template.xlsx", FileMode.Open, FileAccess.Read); + IWorkbook workbook = application.Workbooks.Open(excelStream); + ExcelToPdfConverterSettings settings = new ExcelToPdfConverterSettings(); + //Setting custom paper size to the document + settings.CustomPaperSize = new SizeF(10, 20); + //Convert the workbook into PDF. + PdfDocument document = converter.Convert(settings); + + //Saving the PDF as stream + FileStream stream = new FileStream("Output.pdf", FileMode.Create, FileAccess.ReadWrite); + document.Save(pdfStream); + + pdfStream.Dispose(); + excelStream.Dispose(); + document.Close(); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets or sets the Pdf document's Conformance-level. + + The of the PDF document. + + The following code snippet illustrates how to set set the PdfConformanceLevel while converting Excel workbook to PDF. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open(DEFAULTPATH + "sample.xlsx"); + + //Open the Excel document to Convert + ExcelToPdfConverter converter = new ExcelToPdfConverter(workbook); + ExcelToPdfConverterSettings settings = new ExcelToPdfConverterSettings(); + + // Set the conformance for PDF/A-1b conversion. + settings.PdfConformanceLevel = PdfConformanceLevel.Pdf_A1B; + + //Initialize PDF document + PdfDocument pdfDocument = converter.Convert(settings); + + //Save the PDF file + pdfDocument.Save("Output.pdf"); + pdfDocument.Close(); + + + + + + Gets or sets value to indicate whether the PDF rendering to be done by form fields or not. + + + + + Gets or sets a boolean value indicating whether the accessibility tags should be enabled in the converted PDF document. Default value is false + + + + + The class has the functions and properties to manipulate the Header and footers of the output page. + + + + + Indicates the name of the HeaderFooter. + + + + + Indicates the HeaderFooter Section collections. + + + + + Indicates the template size of the HeaderFooter. + + + + + Initializes a new instance of the class. + + + + + Clone corresponding headerFooter + + + + + + Gets or sets the size of the template. + + The size of the template. + + + + Gets or sets the name of the header footer. + + The name of the header footer. + + + + Gets or sets the header footer sections. + + The header footer sections. + + + + The class has the properties to hold the header and footer section settings. + + + + + Represents the collection of the HF. + + + + + Represents the height of the HF Section. + + + + + Represents the HF Section name. + + + + + Represents the width of the HF section. + + + + + Represents the collection of Richtext string. + + + + + Text Alignment of Header Footer String. + + + + + True, if header/footer having page count, false otherwise. + + + + + Clone corresponding HeaderFooterSection. + + + + + + Gets and Sets to indicate if header or footer having page count. + + + + + Gets or sets the width. + + The width. + + + + Gets or sets the height. + + The height. + + + + Gets or sets the name of the section. + + The name of the section. + + + + Gets or sets the header footer collections. + + The header footer collections. + + + + Gets or sets the RTF. + + The RTF. + + + + Represents the Header Footer Section text alignmet + + + + + The class has the properties and functions for the HF color and font settings. + + + + + Represents the font of the header and footer text. + + + + + Represents the font color of the header and footer text. + + + + + Represents the Underline for the header and footer text. + + + + + Represents the StrikeThrough for the header and footer text. + + + + + Represents the superscript for the header and footer text. + + + + + Represents the subscript for the header and footer text. + + + + + Initializes a new instance of the class. + + + + + Creates a new object that is a copy of the current instance. + + + A new object that is a copy of this instance. + + + + + Gets or sets the font. + + The font of the header and footer text. + + + + Gets or sets a value indicating whether this instance has underline. + + + true if this instance has underline; otherwise, false. + + + + + Gets or sets a value indicating whether this instance has StrikeThrough. + + + true if this instance has StrikeThrough; otherwise, false. + + + + + Get or set a value indicating wheather this instance has superscript. + + + + + Get or set a value indicating wheather this instance has subscript. + + + + + Gets or sets the color of the font. + + The color of the font. + + + + Represents the display style of the grid lines. + + + + + Grid line is not rendered in the output page. The default value is Invisible. + + + + + Grid line is rendered in the output page. + + + + + Grid line is not rendered in the output page. + + + + + Represents the layout of the output document. + + + + + Renders the sheet in one page. + + + + + Print sheets at their actual size. + + + + + Renders all columns in one page. + + + + + Renders all rows in one page. + + + + + Print sheets at specified scaling option. + + + + + Print sheets at their actual size. The default value is NoScaling. + + + + + Represents the options for Header and footer. + + + The options of header and footer are show header and footer. + + + + + + + + + + + + + The options for showing header and footer are set. + + + + + Gets or sets a value indicating whether to show header. The default value is true. + + + + + Gets or sets a value indicating whether to show footer. The default value is true. + + + + + Class used for Table style rendering in the pdf page. + + + + + Collection of List object ranges and their respective borders and bordercolors. + + + + + Collection of built in styles bordercolors. + + + + + Collection of font colors of listobjects. + + + + + Collection of Dark built in styles for the Last and first column. + + + + + Collection of double border built in styles. + + + + + Collection of list object ranges and their font colors. + + + + + Collection of Light buit in Styles for the Row and column stripes. + + + + + Sheet List objects. + + + + + Collection of Medium styles for the column stripes. + + + + + Collection of Medium built in Styles for the Last and first column that has border settings. + + + + + Collection of Medium built in Styles for the Last and first column that has no border settings. + + + + + Collection of built in styles that has top border as solid. + + + + + List object built in style. + + + + + Indicates whether the Column Stripes are shown. + + + + + Indicates whether First Column is shown. + + + + + List Object Header color + + + + + Indicates whether Header Row is shown. + + + + + Indicates whether Last Column is shown. + + + + + Indicates whether the Row stripes are shown. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The sheet list objects. + + + + Applies the styles. + + The sheet. + The font color collection. + Range collection with the borders and their respective colors + + + + Initializes the light style. + + + + + Initializes the borders. + + + + + Initializes the color fonts. + + + + + Initializes the double borders. + + + + + Initializes the top solid. + + + + + Initializes the column settings. + + + + + Initializes the medium style. + + + + + Apply related table tyle element and range to set the border, font and back ground color and format. + + Current work sheet from work book + Table style element object + Related table range + True, If table style element total row is applied, Other wise false. + FirstColumnStripeStyle stripe size + SecondColumnStripeStyle stripe size + FirstRowStripeStyle stripe size + SecondRowStripeStyle stripe size + + + + custom table style element in whole table element range to get and set the border, back ground and font color, format. + + current sheet in work book + whole table element range + custom table style element + + + + Custom table style elements range get and set the border, back ground and font color, format. + + current sheet in work book + whole table element range + custom table style element + + + + Custom table style in first column stripe element range to set the border, back ground and font color and format. + + + + + + SecondColumnStripeStyle stripe size + + + + Custom table style in second column stripe element range to set the border, back ground and font color and format. + + + + + + FirstColumnStripeStyle stripe size + + + + Custom table style in first row stripe element range to set the border, back ground and font color and format. + + + + + + SecondRowStripeStyle strip size + + + + Custom table style in second row stripe element range to set the border, back ground and font color and format. + + + + + + firstRowStripeStyle strip size + + + + Draws the table style. + + The worksheet. + The built in style. + The list object location. + if set to true [show totals]. + + + + Renders the style to the total part of the table. + + The worksheet. + The listobject location. + The border style. + Color of the border. + if set to true [entire row]. + Color of the background. + The solid style. + if set to true [show totals]. + Color of the font. + if set to true [bold font]. + + + + Apply text color. + + Text color. + The Range. + + + + + Apply borders and line style in table. + + Apply border color and line style range + custom table style element + + + + Apply Whole table style element borders. + + Current sheet in work book + Apply Border color and line style range + sustom table style element + + + + Apply Font Color and format in table. + + Font Range + Custom table style element + + + + Apply back ground color and format. + + Apply back ground color and format range + custom table style element + + + + Renders the style to the header part of the table. + + The Worksheet. + The header range. + The header border style. + Color of the border. + if set to true [entire row]. + Color of the background. + The solid line style. + Color of the font. + + + + Renders the style to the content part of the table. + + The Worksheet. + The header range. + The content border style. + Color of the border. + if set to true [entire row]. + First color of the Background. + Second color of the Background. + The solid line style. + Color of the font. + if set to true [show totals]. + + + + Applies the background color. + + Color of the background. + Cells. + + + + Applies the border. + + The Worksheet. + The border range. + The solid style. + The border style. + Color of the border. + if set to true [entire row]. + + + + Apply border to cell. + + The cell. + Excel border index. + Solid style. + Solid style first. + Solid style second. + Border color. + + + + Applies the border to the first and last column of the table. + + The Worksheet. + The border range. + The solid style. + The border style. + Color of the border. + if set to true [entire row]. + + + + Applies the cell top border. + + The Worksheet. + The border range. + The solid style. + Color of the border. + + + + Applies the first and last column style. + + The Worksheet. + The content range. + Color of the font. + First color of the bg. + if set to true [show totals]. + IRange Object + + + + Checks the style. + + + Returns true if the built in style is within the this.lastColumn and first column list else false will be returned. + + + + + Enumeration of the Border Styles. + + + + + Represents that no ExcelBorderIndex is set. + + + + + Represents that Top ExcelBorderIndex is set. + + + + + Represents that Bottom ExcelBorderIndex is set. + + + + + Represents that Left ExcelBorderIndex is set. + + + + + Represents that Right ExcelBorderIndex is set. + + + + + Represents that both Top and Bottom ExcelBorderIndex is set. + + + + + Represents that both Left and Right ExcelBorderIndex is set. + + + + + Represents that all ExcelBorderIndex is set. + + + + + Enumeration of the Solid style in Borders + + + + + Represents the No Solidstyle. + + + + + Represents the solid style for the Top ExcelBorderIndex. + + + + + Represents the solid style for the Bottom ExcelBorderIndex. + + + + + Represents the solid style for the Right ExcelBorderIndex. + + + + + Represents the solid style for the Left ExcelBorderIndex. + + + + + Represents the solid style for both Top and Bottom ExcelBorderIndex. + + + + + Represents the solid style for both Right and Left ExcelBorderIndex. + + + + + + + + + Defines a hash reference of print title columns + + + + + Contains the list of horizontal breaks. + + + + + Contains the list of vertical breaks. + + + + + Indicates whether print title row or print title column is invalid. + + + + + Initializes a new instance of the class. + + The sheet. + The actual used range + + + + Initializes a new instance of the class. + + The sheet. + Used range. + The converter. + + + + Empty constructor + + + + + Validates row or column name wih the provided cell names. + + The cell names to find column or row of. + True if print titles are valid. Otherwise False. + + + + Parses the title rows. + + + + + Parses the title columns. + + + + + Parses the print area. + + + + + From the input rangeHolder it returns the valid range + + input range holder object + input workbook + range holder's worksheet + the required range + + + + Gets the splitted title. + + The value. + + + + + Gets the height of the row. + + The converter. + The row height getter. + + + + + Gets the width of the column. + + The converter. + The column width getter. + + + + + Updates the range. + + The input range. + + + + + Checks the row bounds. + + The start index. + The end index. + + + + + Checks the column bounds. + + The start index. + The end index. + + + + + Gets the break ranges. + + The option. + The actual used range. + + + + + Gets the horizontal breaks. + + The ranges. + + + + Gets the vertical breaks. + + The veri range. + The final column. + + + + Fit pages wide + + + + + Fit pages tall + + + + + Horizontal breaks. + + + + + Vertical breaks. + + + + + Gets the print title first row. + + The print title first row. + + + + Gets the print title first column. + + The print title first column. + + + + Gets the print title last row. + + The print title last row. + + + + Gets the print title last column. + + The print title last column. + + + + Gets a value indicating whether this instance has print title rows. + + + true if this instance has print title rows; otherwise, false. + + + + + Gets a value indicating whether this instance has print title columns. + + + true if this instance has print title columns; otherwise, false. + + + + + Gets a value indicating whether this instance has print area. + + + true if this instance has print area; otherwise, false. + + + + + Gets the height of the title row. + + The height of the title row. + + + + Gets the width of the title column. + + The width of the title column. + + + + Gets the row indexes. + + + + + Gets the column indexes. + + + + + Gets the print areas. + + The print areas. + + + + Gets the worksheet. + + + + + Gets the page setup of the worksheet. + + + + + To assign the Excel to pdf converter + + + + + + It reture the pdftemplate for FitAllcolumnOnOnePage. + + + + + + + + + + It's Return the Pdf Template for FitAllrowsOnOnePage. + + + + + + + + + + NoScaling Layout option + + + + + + + + + Represents font value. + + + + + Represents column title value. + + + + + Represents row title value. + + + + + Get print title width for custom scaling. + + + + + Get print title Height for custom scaling. + + + + + Calculate the font style value. + + + + + Get the font style value. + + + + + Represents the splitting of text. + + + + + The column. + + + + + Pdf brush. + + + + + Pdf string format. + + + + + Text Bounds. + + + + + The pdf template. + + + + + Pdf font. + + + + + The row. + + + + + The sheet. + + + + + Splitted text. + + + + + RichText font collection + + + + + RichText string collection + + + + + Text Bounds. + + + + + Splitted text. + + + + + Splitted text. + + + + + Pdf font. + + + + + Pdf brush. + + + + + Pdf string format. + + + + + The row. + + + + + The column. + + + + + The pdf template. + + + + + RichText font collection + + + + + RichText string collection + + + + + + + + + + + + + + + + + + + + + + Get Curved Connector path + + + formulaColl.Add("x2","*/ w adj1 100000"); + formulaColl.Add("x1","+/ l x2 2"); + formulaColl.Add("x3","+/ r x2 2"); + formulaColl.Add("y3","*/ h 3 4"); + + + + + + + + Get Curved Connector path + + + formulaColl.Add("x2","*/ w adj1 100000"); + formulaColl.Add("x1","+/ l x2 2"); + formulaColl.Add("x3","+/ r x2 2"); + formulaColl.Add("y3","*/ h 3 4"); + + + + + + + + Get Bent Connector path + + + formulaColl.Add("x1","*/ w adj1 100000"); + > + + + + + + + Get Bent Connector path + + + formulaColl.Add("x1","*/ w adj1 100000"); + > + + + + + + + Get bend connector 2 path. + + bend connector2 points + + + + Get bend connector 2 path. + + Graphics path for bend connector2 points + + + + Get bend connector4 path. + + Pdf path for bentconnector4 points + + + + Get bent connector5 path. + + Pdf path for bent connector5 points + + + + Get bent connector4 path. + + Graphics path for bent connector4 points + + + + Get bent connector 5 path. + + Graphics path for bent connector5 points + + + + Get curved connector 2 path + + Grpahics path for curved connector 2 points + + + + Get curved connector 4 path. + + Graphics path for curved connector4 points + + + + Get curved connector5 path. + + Graphics path for curved connector5 points + + + + Get curved connector2 path. + + Pdf path for curved connector2 points + + + + Get curved connector 4 path. + + Pdf path for curved connector4 points + + + + Get curved connector 5 path. + + Pdfpath for curved connector 5 path + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get Triangle path + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the right arrow path. + + + + + + Gets the left arrow path. + + + + + + Gets down arrow path. + + + + + + Gets the left right arrow path. + + + + + + Gets the curved right arrow path. + + + + + + Gets the curved left arrow path. + + + + + + Gets the curved up arrow path. + + + + + + Gets the curved down arrow path. + + + + + + Gets up down arrow path. + + + + + + Gets the quad arrow path. + + + + + + Gets the left right up arrow path. + + + + + + Gets the bent arrow path. + + + + + + Gets the U trun arrow path. + + + + + + Gets the left up arrow path. + + + + + + Gets the bent up arrow path. + + + + + + Gets the striped right arrow path. + + + + + + Gets the notched right arrow path. + + + + + + Gets the pentagon path. + + + + + + Gets the chevron path. + + + + + + Gets the right arrow callout path. + + + + + + Gets down arrow callout path. + + + + + + Gets the left arrow callout path. + + + + + + Gets up arrow callout path. + + + + + + Gets the left right arrow callout path. + + + + + + Gets the quad arrow callout path. + + + + + + Gets the circular arrow path. + + + + + + Gets the math plus path. + + + + + + Gets the math minus path. + + + + + + Gets the math multiply path. + + + + + + Gets the math division path. + + + + + + Gets the math equal path. + + + + + + Gets the math not equal path. + + + + + + Gets the flow chart alternate process path. + + + + + + Gets the flow chart predefined process path. + + + + + + Gets the flow chart internal storage path. + + + + + + Gets the flow chart document path. + + + + + + Gets the flow chart multi document path. + + + + + + Gets the flow chart terminator path. + + + + + + Gets the flow chart preparation path. + + + + + + Gets the flow chart manual input path. + + + + + + Gets the flow chart manual operation path. + + + + + + Gets the flow chart connector path. + + + + + + Gets the flow chart off page connector path. + + + + + + Gets the flow chart card path. + + + + + + Gets the flow chart punched tape path. + + + + + + Gets the flow chart summing junction path. + + + + + + Gets the flow chart or path. + + + + + + Gets the flow chart collate path. + + + + + + Gets the flow chart sort path. + + + + + + Gets the flow chart extract path. + + + + + + Gets the flow chart merge path. + + + + + + Gets the flow chart online storage path. + + + + + + Gets the flow chart delay path. + + + + + + Gets the flow chart sequential access storage path. + + + + + + Gets the flow chart magnetic disk path. + + + + + + Gets the flow chart direct access storage path. + + + + + + Gets the flow chart display path. + + + + + + Gets the rectangular callout path. + + + + + + Gets the rounded rectangular callout path. + + + + + + Gets the oval callout path. + + + + + + Gets the cloud callout path. + + + + + + Gets the line callout1 path. + + + + + + Gets the line callout2 path. + + + + + + Gets the line callout3 path. + + + + + + Gets the line callout1 accent bar path. + + + + + + Gets the line callout2 accent bar path. + + + + + + Gets the line callout3 accent bar path. + + + + + + Gets the line callout1 no border path. + + + + + + Gets the line callout2 no border path. + + + + + + Gets the line callout3 no border path. + + + + + + Gets the line callout1 border and accent bar path. + + + + + + Gets the line callout2 border and accent bar path. + + + + + + Gets the line callout3 border and accent bar path. + + + + + + + + + + + + + + + + + + + + + Get Path adjust value + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + collection used to maintain the parent Pdf Structure Element + + + + + Represents the CurrentPage + + + + + Get alternate pdf font from system and substitute font + + system font. + rendering text. + + + + Draw the text template. + + The cell bounds. + Pdf graphics. + The lineinfo collection. + shift y. + + + diff --git a/ZZPDFTest/bin/Debug/Syncfusion.OfficeChart.Base.dll b/ZZPDFTest/bin/Debug/Syncfusion.OfficeChart.Base.dll new file mode 100644 index 00000000..1af69fcd Binary files /dev/null and b/ZZPDFTest/bin/Debug/Syncfusion.OfficeChart.Base.dll differ diff --git a/ZZPDFTest/bin/Debug/Syncfusion.OfficeChart.Base.xml b/ZZPDFTest/bin/Debug/Syncfusion.OfficeChart.Base.xml new file mode 100644 index 00000000..53569fdd --- /dev/null +++ b/ZZPDFTest/bin/Debug/Syncfusion.OfficeChart.Base.xml @@ -0,0 +1,148690 @@ + + + + Syncfusion.OfficeChart.Base + + + + + Performs the parsing operation of Array formulas. + + + + + To check the index of "_" in a string(formula). + + + + + The operators which are involved in array formula. If these operators are not + present in formula, then formula must be returned without parsing. + + + + + Length in each splitted range of array formula. + + + + + Gets or sets the ArrayRecordPostion method from XlsIO side to get the position + of the cell in the array. + + + + + Initialize the object for parsing operations. + + An instance of . + + + + Gets or sets the instance of . + + + + + To split the strings based on the pattern involving operators(-,+,*,/,&). + For example:"A1:B1 * C1:D1" will be splitted as "A1:B1" and "C1:D1" which will + be stored separately in string array. + + The string to be splitted into string array. + String array. + + + + To calculate the height and width of the passed argument. Based on the argument's type of + cell reference or constants, they are calculated separately and if any of the width/height is less than + max height/width, correspondingly range is increased/decreased for range.The minimum width/height is + maintained. + + A string passed to compute maximum height/width. + The height determined for array. + The width determined for array. + The minimum height. + The minimum width. + The string with altered height/width. + + + + Resize range based on the max height and max width of the array and stored in a list + which needs to be parsed. For example: "A1:B3*C1:C2" will be resized based on the + height of "2"(value of smaller row count but not 1) and width of "2"(Value of smaller column count but not 1). + The arguments splitted from GetCellsFromArgs method, will be of the mentioned length of 4. Hence "A1:B3" will be + splitted and be first argument in the list and "C1:C2" will be splitted as the next argument in the list. + This list will be passed for making expressions in Parse method as "A1*C1,B1*C1,A2*C2,B2*C2". + + The formula array which needs to be adjusted and parsed. + The parsed formula string in original format. + The string array. + + + + A method that splits the formula based on the operators. + For example: if the argument is passed as "(A1:B2+C1:D2)" which will be parsed + as "A1+C1,B1+D1,A2+C2,B2+D2". + + The formula passed in with operator. + The parsed formula string in original format. + Splitted formula based on logic. + + + + A method that parses the array formula and return it as normal formula for computation. + For example if the formula is passed as "{=SUM(A1:B1*C1:D1)}", then it will be parsed + and returned as SUM(A1*C1,B1*D1). + + The array formula to be parsed. + The normal formula for parsing in CalcEngine. + + + + A method that invokes for computation of LEN,ROW,COLUMN methods in array formula. + For example if the formula SUM(ROW(A1:A5)) then it should be parsed as SUM({1,2,3,4,5})(excel behavior) + and if the formula is ROW(A1:A5), based on the required cell, the corresponding row index is returned. + + The formula's argument. + The formula name. + The computation level of the formula. + A string which holds the computed value with curly braces. + + + + The function to check if the given formula is multi cell array or not. + For example: if the formula is "{A1:B1 * C1:D1}", then it is a multi cell array + whereas, if the formula is "SUM(A1:B1*C1:D1), then it is not a multi cell array. + + The formula which is passed to check. + True; if it is multicell array;else False. + + + + To parse the multi cell array, that is to get the positon of the array record and returning + the particular formula for the given cell. + For example: if the parsed formula is "A1*C1,B1*D1,A2*C2,B2*D2",then based on the given cell if + the index is 2, then resultant formula is "B1*D1" whereas if the index is "-1", then error + messages is returned. + + formula to be parsed. + The parsed formula string in original format. + Formula required for given cell. + + + + Parsing the one/multi dimensional array constants in formula. For Eg: parsing of + {1,2,3} or {1;2;3} or {1,2;3,4}. It also parses the multi dimensional array with constants + such as {1,2}*{3,4}. + + Formula to be parsed. + The formula/value which needs to be displayed. + + + + If passed formula contains operators involving expressions with commas, then it will + be parsed by splitting the arg's based on comma and storing in the list. For eg: if the + passed argument is "{1*2,3*4,4*5}, then based on the cell's index, particular expression + will be returned + + The formula for parsing. + The height of the arg. + The width of the arg. + Expression/Value based on the formula. + + + + For parsing the horizontal arrays. (i.e) the formula which is separated by + commas, for eg: {1,2,3}. + + Formula to be parsed. + The value based on position of cell. + + + + For parsing the vertical arrays. (i.e) the formula which is separated by + semi colon, for eg: {1;2;3}. + + Formula to be parsed. + The value based on position of cell. + + + + Getting the height in which the array formula will arrange the values of selected range. + Smaller height of the given expression should be preferred but if the smaller value is 1, then the + height of another expression should be considered. + For example:"A1:B3*C1:D2" in which, the smaller height 2 will be considered and returned. + + Splitted strings from original formula. + The height required for array formula. + + + + Getting the width in which the array formula will arrange the values of selected range. + Smaller width of the given expression should be preferred but if the smaller value is 1, then the + width of another expression should be considered. + For example:"A1:B3*C1:E2" in which, the smaller width is 2 will be considered and returned. + + Splitted strings from original formula. + The width required for array formula. + + + + To get the position of the cell in the array formula applied range. + if the cell like "A5" is passed with height and width, then it finds the exact + postion in the selected range "A4:D7" from XlsIO side and returns it. + + The height of the array record. + The width of the array record + The position of the cell. + + + + To Compute the length of the given argument, based on the computational level. + For example if the formula SUM(LEN(A1:A3)), the computation level is greater than 1, + hence it should be parsed as SUM({LEN(A1),LEN(A2),LEN(A3)})(excel behavior) + and if the formula is LEN(A1:A3), the computation level is 1, then + the corresponding length of the cell is returned. + + Passed argument for computation. + Computational level. + Computed result. + + + + To Compute the row index of the given argument, based on the computational level. + For example if the formula SUM(ROW(A1:A3)), the computation level is greater than 1, + hence it should be parsed as SUM({ROW(A1),ROW(A2),ROW(A3)})(excel behavior) + and if the formula is ROW(A1:A3), the computation level is 1, then + the corresponding row index of the cell is returned. + + Passed argument for computation. + Computational level. + Computed result. + + + + To Compute the column index of the given argument, based on the computational level. + For example if the formula SUM(COLUMN(A1:C1)), the computation level is greater than 1, + hence it should be parsed as SUM({COLUMN(A1),COLUMN(B1),COLUMN(C1)})(excel behavior) + and if the formula is COLUMN(A1:C3), the computation level is 1, then + the corresponding column index of the cell is returned. + + Passed argument for computation. + Computational level. + Computed result. + + + + To compute the IF fomrula based on the computation level. + If the computation level is greater than zero and the formula is "IF(G3:G30="",0,1) get the value and perform logical test for each cell and return the array structure value(“1,1,1,1,1,1,0,0,0,1”). + + Passed argument for computation. + Computational level. + Computed result. + + + + To compute the IF fomrula based on the computation level. + + CellRange + Tokens("=",">",">=") + The criteria used to determine which cells to add. + the parsed criteria is number is set as true.otherwise false. + Computational level. + The length of parsed range. + Computed result. + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Delegate defined to access the method GetArrayRecordPosition for + getting position of the cell. + + Row index of the cell. + Column index of the cell. + The height required for the selected range. + The width required for the selected range. + The method containing the four integer parameters. + + + + A property that gets/sets the text of the initial formula. + + + + + A property that gets/sets the last computed value of this formula. + + + + + A property that gets/sets the formula as a parsed string. + + + + + CalcEngine encapsulates the code required to parse and compute formulas. Hashtable + properties maintain a Formula Library of functions as well as a list + of dependent cells. + + You can add and remove library functions. + + + + + Used to store the value as double + + + + + Used to store the value as double + + + + + Used to store the value as double + + + + + used to calculate the row in Table. + + + + + used to calculate the header in Table. + + + + + used to calculate the total in Table. + + + + + used to calculate the data in Table + + + + + used to calculate all in Table + + + + + This field holds equivalent double value of 1904(DateTime). + + + + + Field that turns on/off processing of the ICalcData.ValueChanged event. + + + + + Used to store the number + + + + + Used to store the big number as double + + + + + Used to store the value as double + + + + + This field will be set as true, if the 1904 date system is enabled in Excel. + + + + + Set the boolean as true + + + + + The constructor. + + + + + The constructor. + + The ICalcData from the underlying grid. + + + + Gets or sets whether the formula is array formula or not. + + + + + Gets or sets the instance of . + + + + + Gets or sets the instance of + + + + + Used to store the registed values + + + + + The list of error strings which are used within the Essential Calculate internally. Users can make changes to this internal error strings. + Default settings by assigning the new strings to the corresponding position.ReloadErrorStrings should be invoked to reset or modify the internal error strings. + + + + + A method that checks the possible cases for error string(invalid arguments for formula). + + The arguments of formula. + The formula's argument type. + Returns the Error string if formula has invalid arguments + + + + Below method has been used to find the negative values(ex formula:=LARGE({6,23,-5,2.3}, 2)). + + string contains negative values(eg:-2,-2,-2) or possitve value. + True if the values are number.else false. + + + + Returns true when Namedarange is in the scope and returns cellRange based on scope. + + NamedRange + CellRange + True when Namedarange is in the scope.else false. + + + + This method check "\"in the string and removes if the string contains "\"\. + + input string. + returns The parsed string value without the "\"\ + + + + A method that parses the text in a formula passed in. + + The text formula to be parsed. + A string holding a parsed representation of the formula. + + + + A method that parses and computes the string formula passed in. + + The text formula to be parsed and computed. + A string holding the computed value. + + + + Accepts an unparsed formula string and replaces any sheet references with corresponding tokens. + + The unparsed formula string. + + This is an advanced method that lets you replace sheet names with corresponding tokens. You may have need of + this method if you are adding your own functions to the function library. + + + + + Tokenizes all library references. + + + Accepts a string such as Sin(A1+A2) and tokenizes it into + bqSIN[A1A2a]b which serves as input to ComputedValue. + + Formula to be tokenized. + + + + A method that adds a function to the function library. + + The name of the function to be added. + The function to be added. + True if successfully added, otherwise False. + + LibraryFunction is a delegate that defines the signature of functions that + you can add to the function library. + + public delegate string LibraryFunction(string args); + + + + + + A method that removes a function from the function library. + + The name of the function to be removed. + True if successfully removed, otherwise False. + + + + Creates and initially loads the function library with the supported functions. + + + + + CreateSheetFamilyID is a method to create familyID for a sheet. + + Sheet family ID. + + Essential Calculate supports multisheet references within a family of ICalcData objects. To use + this functionality, you use this method to get a unique identifier for + the family. Then in the RegisterGridAsSheet method that you call to add ICalcData objects + to this family, you pass this unique identifier to mark the ICalcData objects as belonging + to this family. You can only cross reference ICalcData objects within the same family. + + + + + RegisterGridAsSheet is a method that registers an ICalcData object so it can be referenced in a formula from another ICalcData object. + + The reference name used to refer to this ICalcData object from formulas in other ICalcData objects. + + The ICalcData from the ICalcData object being registered. + + /// An integer previously created with a call + to CalcEngine.CreateSheetFamilyID. This number is used to identify + the ICalcData objects as belonging to a particular family of ICalcData objects. You can only reference + ICalcData objects from within the same family. + + + Essential Calculate supports multisheet references with its formulas. For example, if you + have two ICalcData objects, then you can reference cells from the first ICalcData object + in the second ICalcData object. For this to work, both ICalcData objects need to be registered using this method. + The syntax for using a sheet reference as part of a formula is to prefix a cell reference + with the sheet reference name followed by an exclamation point. + The formula "= sheet1!A1 + sheet2!C3" would add the value is cell A1 for + the ICalcData object whose reference name is sheet1 to the value from cell C3 in the ICalcData object + whose reference name is sheet2. + + Use this code to use cross sheet references: + + //Register three ICalcData objects so cell can be referenced across ICalcData objects: + int sheetfamilyID = CalcEngine.CreateSheetFamilyID(); + myCalcEngine.RegisterGridAsSheet("summary", calcData1, sheetfamilyID); + myCalcEngine.RegisterGridAsSheet("income", calcData2, sheetfamilyID); + myCalcEngine.RegisterGridAsSheet("expenses", calcData3, sheetfamilyID); + .... + //Sample formula usage for cells in calcData1, the 'summary' data source. + //This code sums ups some cells from calcData3, the 'expenses' data source + //and calcData2, the 'income' data source. + //Sum the range B2:B8 from expenses: + string sumExpenses = "= Sum(expenses!B2:expenses!B8)"; + //Sum the range B2:B4 from income: + string sumIncome = "= Sum(income!B2:income!B4)"; + + + 'Register three ICalcData objects so cell can be referenced across ICalcData objects: + Dim sheetfamilyID As Integer = CalcEngine.CreateSheetFamilyID(); + myCalcEngine.RegisterGridAsSheet("summary", calcData1, sheetfamilyID) + myCalcEngine.RegisterGridAsSheet("income", calcData2, sheetfamilyID) + myCalcEngine.RegisterGridAsSheet("expenses", calcData3, sheetfamilyID) + .... + 'Sample formula usage for cells in calcData1, the 'summary' data source. + 'This code sums ups some cells from calcData3, the 'expenses' data source + 'and calcData2, the 'income' data source. + 'Sum the range B2:B8 from expenses: + Dim sumExpenses As String = "= Sum(expenses!B2:expenses!B8)" + 'Sum the range B2:B4 from income: + Dim sumIncome As String = "= Sum(income!B2:income!B4)" + + + + + + Unregisters a grid so it can no longer be referenced in a formula from another grid. + + The reference name used to refer to this grid from formulas in other grids. + + The grid model. + + + + Change the sheet name of with the given name. + + Name of the sheet. + The ICalcData object. + + + + Triggers a calculation for any value depending upon the given cell. + + The cell. + + + + Returns the GridSheetFamilyItem for the specified model. If there was no item registered for + the model, a new item is created and cached. + + The grid model. + The GridSheetFamilyItem for the specified model. + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Return the value of arraybounds as boolean + + current cell + height + width + firstrowindex + firstcolumnindex + lastrowindex + lastcolumnindex + + + + + A method to retrieve the row index from a cell reference. + + String holding a cell reference such as C21 or AB11. + An integer with the corresponding row number. + + + + A method that gets the column index from a cell reference passed in. + + String holding a cell reference such as C21 or AB11. + An integer with the corresponding column number. + + + + Determines whether the arg is a valid cell name. + + Cell name. + True is the arg is a valid cell name, false otherwise. + + + + To check whether the row index can be obtained from the arguments + + + + + A method to split the arguments using argument seperator. + + arguments to split. + argument seperator used to split. + A string array. + + + + Removes outer quote marks from a string with no inner quote marks. + + The string with possible outer quote marks. + The string with any outer quote marks removed. + This is a utility method that removes outer quotes on a string. + + + + Returns an array of argument strings from a single string where the arguments are delimited by . + + Contains the argument list. + A string array of arguments. + This method properly preserves any quoted strings that contain the character. + + + + Tests whether a string is NULL or empty. + + String to be tested. + True is passed in string is null or empty, otherwise False. + + + + Given a string, it returns a string that is passed through the FormulaParsing event + to allow any listener to modify it. + + A string that is to be potentially parsed. + + + + Accepts a possible parsed formula and returns the calculated value + without quotes. + + The argument to be adjusted. + + This method is useful in custom functions if you want to allow + your custom functions to handle parsed formulas as arguments. In + this case, calling this method at the beginning of your custom function + will allow you custom function to work only with computed values, and not + have to handle parsed formulas directly. + + + + + Call this method to clear whether an exception was raised during the computation of a library function. + + + + + Returns the value of specified cell in a Grid. + + Cell address + If true, compute the formula and returns calculated result. + Else, simply returns the value of the cell. + value of the cell + + + + Conditionally gets either the formula value or the cell + value depending upon whether the requested cell is a FormulaCell. + + Row index of the requested cell. + Column index of the requested cell. + String holding either the cell value or the computed formula value. + + + + Computes the exact date value when the input string is based on time span. + + value to be converted into date. + computed date for the time. + returns true if the value can be converted to date time. + + + + Conditionally gets either the formula value or the cell + value depending upon whether the requested cell is a FormulaCell. + + The ICalcData object holding the requested cell. + Row index of the requested cell. + Column index of the requested cell. + String holding either the cell value or the computed formula value. + + + + Returns the value of specified cell in a Grid. + + The ICalcData object holding the requested cell. + Row index of the requested cell. + Column index of the requested cell. + If true, compute the formula and returns calculated result. + Else, simply returns the value of the cell + the value of the cell. + + + + A Virtual method to compute the value based on the argument passed in. + + + This method takes the argument and checks whether it is a + parsed formula, a raw number, or a cell reference like A21. + The return value is a string that holds the computed value of + the passed in argument. + + A parsed formula, raw number, or cell reference. + A string with the computed number in it. + + + + A method that retrieves a string array of cells from the range passed in. + + + Converts arguments in these forms to a string array of individual cells: + A1,A2,B4,C1,...,D8 + A1:A5 + A1:C5 + + String containing a cell range. + String array of cells. + + + + A method that retrieves a string array of cells from the range passed in. + + + Converts arguments in these forms to a string array of individual cells: + A1,A2,B4,C1,...,D8 + A1:A5 + A1:C5 + + String containing a cell range. + default value is true. + String array of cells if findCellsFromRange is true.otherwise return cell reference. + + + + This method recalculates any formula cells in the specified range. + + The calculations for non-visible formula cells are performed the next time + cell are actually displayed. If you want the calculation performed immediately + on cells (visible or not), call the two argument overload of RecalculateRange, + passing the forceCalculations argument as True. + GridRangInfo object that specifies the cells to be recalculated. + ICalcData object that holds the data to be recalculated. + + + + An overridden method to display information on the cell currently being calculated. + + String with information on the cell currently being calculated. + + + + Conditionally gets either the formula value or the cell + value depending upon whether the requested cell is a FormulaCell. + + The alphanumeric cell label, like A1, or EE14. + String holding either the cell value or the computed formula value. + + + + Conditionally gets either the formula value or the cell + value depending upon whether the requested cell is a FormulaCell. + + Row index of the requested cell. + Column index of the requested cell. + String holding either the cell value or the computed formula value. + + + + Evaluates a parsed formula. + + A string holding a valid parsed formula. + The computed value of the formula. + The string passed into this function must be previously parsed + using ParseFormula. + + + + Compute the NestedIF formulas using the old code structure of CalcEngine. + + formula to execute / compute + + + + Compute the NestedIF formulas using new parse and compute technique. + + formula to execute / compute + + + + This method is used to retrieve the exact results from a cell reference based on the cell formula. + + This parameter represents the Parameter of IF formulas it can be either logical true or logical false. + This parameter represents the result of the IF formulas parameter. + Returns zero if the cell reference does not have any formula; otherwise, it returns the value of the formula in the cell reference. + + + + A method that computes a parsed formula. + + The parsed formula to be computed. + A string holding the computed value. + + + + This method retrieves the value in the requested cell reference using fresh computations + for any cells that affect the value of the requested cell. + + A cell reference like: Sheet5!B14 + A freshly computed value for the cell. + + + + PullUpdatedValue is a method used to recompute the cells that are referred to compute the requested value. + + Integer identifying the ICalcData object. + The row in the ICalcData object. + The column in the ICalcData object. + + + + A method that increases the calculation level of the CalcEngine. + + Every formula has a calculation ID level associated with it. Every time + a formula is retrieved, its calculation ID level is compared with the CalcEngine + ID level. If they do not agree, the formula is recomputed. Calling UpdateCalcID + will force any formula to be recomputed the next time it is retrieved. + + + + + Refresh is a method that recalculates any cell that depends upon the passed in cell. + + A cell such as A21 or EE31. + + + + Returns the amount received at maturity for a fully invested security. + + Number and the number of digits + Received amount + + + + Counts the nonblank cells in a field (column) of records in a list or database that match conditions that you specify. + + Number and the number of digits + Received amount + + + + Averages the values in a field (column) of records in a list or database that match conditions you specify. + + Number and the number of digits + Received amount + + + + Extracts a single value from a column of a list or database that matches conditions that you specify. + + Number and the number of digits + Received amount + + + + Returns the largest number in a field (column) of records in a list or database that matches conditions you that specify. + + Number and the number of digits + Received amount + + + + Returns the smallest number in a field (column) of records in a list or database that matches conditions that you specify. + + Number and the number of digits + Received amount + + + + Returns the smallest number in a field (column) of records in a list or database that matches conditions that you specify. + + Number and the number of digits + Received amount + + + + Estimates the variance of a population based on a sample by using the numbers in a field (column) of records in a list or database that match conditions that you specify. + + Number and the number of digits + Received amount + + + + Calculates the variance of a population based on the entire population by using the numbers in a field (column) of records in a list or database that match conditions that you specify. + + Number and the number of digits + Received amount + + + + Estimates the standard deviation of a population based on a sample by using the numbers in a field (column) of records in a list or database that match conditions that you specify. + + Number and the number of digits + Received amount + + + + Calculates the standard deviation of a population based on the entire population by using the numbers in a field (column) of records in a list or database that match conditions that you specify. + + Number and the number of digits + Received amount + + + + Adds the numbers in a field (column) of records in a list or database that match conditions that you specify + + Number and the number of digits + Received amount + + + + Used to get the data from arguments + + Arguments + + + + + This field is enable when the criteria is double. + + + + + Returns the archyperbolic cosecant of an angle. + + A cell reference or a cell or a number + A string containing the archyperbolic cosecant of an angle + + + + Returns the full product of two 32-bit numbers. + + The two 32 bit numbers. + A string containing the product of two 32 bit numbers. + + + + Calculates the quotient of two 64-bit signed integers and also returns the remainder in an output parameter. + + + returns the quotient of two 64-bit signed integers. + + + + Returns the remainder resulting from the division of a specified number by another specified number. + + contains a divisor and dividend + Returns the remainder. + + + + replaces part of a text string, based on the number of characters, with a different text string + + Text in which is want to replace, The position of the character in old_text., The number of characters in old_text + returns replaced text + + + + Returns the row index of the passed in cell reference. + + Contains zero or one argument. If no argument is passed, returns the row index of the + location of this Row function cell, otherwise returns the row index of the passed in cell reference. + The row index. + + This method doesn't return an array of row numbers as the array formula entry is not supported in engine. It is another usecase of this library function. + This method is deprecated. Please use the instead. + + + + + Returns the m parameter of the exponential curve y = b * m^x that best fits the given points. Only the first two Excel parameters are used. + + Y_range, x_range. + returns m parameter. + + + + Returns the b value from the exponential curve y = b * m^x. + + Y_range, x_range. + returns calculated b value. + + + + Returns the most recent points from an array (the points with the highest index values). + For functions with a decay factor, the weight on the last element in the array is the highest. + In many applications this corresponds with the assumption that the last element in the array represents the most recent data point. + + Array from which the data points will be selected. + The number of data points to be returned. + + + + + Returns the mean of an array. + + Array of data for which we are calculating the mean. For time series, the last element (index = n-1), is the most recent. + In most applications, the decay factor is between 0 and 1. Weigth on the last element in array is 1.0, the 2nd to last element d, 3rd to last d^2, ... + Window length. Method uses the most recent n points, n = length. + + + + Returns the weighted averages of the values in valueArray using the corresponding weights in weightArray. + + array of values for which we are computing the weighted average + array of weights used in computing the weighted average + + + + Returns the CDF of the uniform distribution. + + Value at which the distribution is evaluated. + Minimum value of the distribution. + Maximum value of the distribution. + + + + Returns the half-life of a geometric series of length n, who's first element is 1. + For decay factor d, 1 + d + d^2 + ... + d^(h-1) = 0.5 * [1 + d + d^2 + ... + d^(n-1)] + + Decay factor Typically between -1 adn +1. + Number of elements in the geometric series, must be positive. + + + + + Returns the sum of a geometric series of length n, who's first element is 1. + For decay factor d, S = 1 + d + d^2 + ... + d^(n-1) + + Decay factor Typically between -1 adn +1. + Number of elements in the geometric series, must be positive. + + + + + Returns the sum of an infinite geometric series who's first element is 1. + For decay factor d, S = 1 + d + d^2 + ... + + Decay factor. Typically between -1 adn +1. + + + + + Returns the sample covariance between two arrays. + Arrays should be of equal length, and contain more than one element. + + + + In most applications, the decay factor is between 0 and 1. Weigth on the last element in arrays is 1.0, the 2nd to last element d, 3rd to last d^2, ... + + + + Recalculates every cell that depends upon any cell in the passed-in range. + + For example, if range is RangeInfo(1,1,2,2), and cells (5,6) and + (12,17) hold formulas that reference the cells in the range, then cells (5,6) + and (12,17) will be re-computed as the result of this call. + RangeInfo object to be refreshed. + + + + Clears any variable names registered with the CalcEngine. + + + + + Registers a list of variable names so you can use it within formulas. + + List of names. + + + + Swaps variable names for tokens. + + The formula holding variable names. + The formula with tokens. + + + + Return the value of besseli1 + + value + + + + + Return the value of the besselk1 + + value + + + + + Return the value of besselk0 + + value + + + + + A method to get submatrix for matrix function used internally. + + double Array - Matrix + Matix rows + Columns + Matrix + + + + Return the value of between strings + + source string + start + end + + + + + Gets the text of any formula at the given row and column of the ICalcData object. + + The ICalcData object. + The one-based row in the grd object. + The one-based col in the grd object. + String containing the text of the formula. + If the data item at row and column is not a formula, the + return value is an empty string. + + + + Retrieves the current CalcEngine calculation level ID. + + Current calculation level ID. + + + + A method to reset the cached ICalcData object IDs. + + + + + Resets the internal sheet token marker to 0. + + + When RegisterGridAsSheet is called to add a ICalcData object to a CalcEngine, + this newly added sheet is associated with an integer used in tokenizing formulas. + This sheetID integer is required in the PullUpdatedValue method to specify the ICalcData + object being accessed. The GetSheetID method allows you to retrieve a sheetID given + an ICalcData object. This internal sheet token marker is a static member of CalcEngine, + and is incremented each time a new ICalcData object is registered with the CalcEngine + using RegisterGridAsSheet. + + + + + Return the value of HandleIteration + + value + formula + + + + + Adds a named range to the NamedRanges collection. + + The name of the range to be added. + The range to be added. + True if successfully added, otherwise False. + + The range should be a string such as A4:C8. + + + + + Removes a range from the NamedRanges collection. + + The name of the range to be removed. + True if successfully removed, otherwise False. + + + + Replaces NamedRanges with their values. + + + Accepts a string such as Sin(SumRange) and tokenizes it into + bqSIN[A1A4a]b which serves as input to ComputedValue. + + argList containing named ranges. + + + + Get the cell Range for table NameRange + + Formula or NamedRange + cell range string + + + + Get the first row Index of Cell Range + + Cell Range to find index + get the top row index + + + + This method is used to check the given text is Namedrange or not. + + Parsed string. + returns the CellRange value if the parsed text is NamedRange + + + + Below method used to intersect the NamedRanges when the parsed formula contains space. + + A string holding a valid parsed formula. + The intersected NamedRanges value. + If the namerange intersects, returns true, else false. + + + + Find the next table formula or table Range end index i.e last index of '[' + + formula to find index + location of start index to search the char '[' + locatio of end index + + + + Returns the number of days since 01 Jan 1900. + + Year, month, and day. + Number of days. + + + + Returns the number of days since 01 Jan 1900. + + Text containing a date. + Number of days. + + + + Returns the day of the serial number date. + + Serial number date. + Day of the given date. + + + + Number of days between 2 dates using 360 day year. + + Serial number date1, serial number date1 and method. + Days between the dates. + + + + returns the fraction of the year represented by the number of whole days between two given dates + + startDate, endDate, basis (optional) + returns the fraction of the year + + + + Returns the number of days between two dates. + + startDate, endDate + Returns the number of days + + + + returns the date of given date after the specific month + + startDate, months + returns the date + + + + Returns the last date of the date after the specific month of given date. + + startDate, month + return the date. + + + + Returns the week number of a specific date + + serial_number,start_day of week (optional) + 1 or omitted - Sunday + 2 Monday + 11 Monday + 12 Tuesday + 13 Wednesday + 14 Thursday + 15 Friday + 16 Saturday + 17 Sunday + 21 Monday + returns the week number + + + + Returns ISO week number of the year for a given date + + date + returns ISO week number + + + + returns the date of the given date after the number of working days + + startDate, days, holidays (optional) + returns the date + + + + Returns the value of ComputeNetworkDays + + arguments + + + + + Returns the number of whole workdays between two dates, week end and holidays are not consider as working days + + start_date, end_date,weekend (optional), holidays (optional) + return the work days + + + + Returns the serial number of the given date before or after a specified number of workdays + + startDate, days, weekend (optional) , holidays (optional) + return the serial number of specific date. + + + + Returns the hour of the given time. + + Given time. + Hour of given time. + + + + Returns the minute of the given time. + + Given time. + Minute of given time. + + + + Returns the second of the given time. + + Given time. + Second of given time. + + + + Returns the month of the given date. + + given time + Month of given date. + + + + Returns the current date and time as a date serial number. + + Parameter Ignored. + Current date and time as serial number. + + + + Returns the current date as a date serial number. + + Parameter Ignored. + Current date as date serial number. + + + + Returns a fraction of a day. + + Hour, minute, and second. + Fraction of a day. + + + + Returns a fraction of a day. + + Time as a text string. + Fraction of a day. + + + + Day of the week. + + Serial number date1 and return_type. + Days between the dates. + + + + Returns the year of the given date. + + Given date. + Month of given date. + + + + Returns the number of days or months or years between two dates. + + Start date, end date and unit. + The number of days, months, or years between two dates. + + + + Calculates the Output to the concerned base. + + Data to be converted. + Base of the Given Data + Base to be obtained. + The data concerning to the base in 'to' parameter + + + + Computes the Binary value for the given Decimal Number. + + Data to be converted. + Returns the calculated Binary value. + + + + Computes the Octal value for the given Decimal Number. + + data to be converted. + Returns the calculated Octal value. + + + + Computes the Hexadecimal value for the given Decimal Number. + + Data to be converted. + Returns the calculated Hexadecimal value. + + + + Computes the Octal Number for the given binary NUmber. + + Input BinaryNumber + The resultant Octal Number + + + + Computes the Decimal Number for the given binary NUmber. + + Input BinaryNumber + The resultant Decimal Number + + + + + + + + + + + Computes the Binary value for the given Hexadecimal Data. + + Data to be converted. + Returns the calculated Binary value. + + + + Computes the Octal Equivalent for the given Hexadecimal value + + Data to be converted. + The calculated Octal value for the given. + + + + Computes the Decimal Equivalent for the given Hexadecimal value + + Data to be converted. + The calculated Decimal value for the given. + + + + Computes the Binary value for the given Octal Number. + + Data to be converted. + Returns the calculated Binary value. + + + + Calculates the Hexadecimal equivalent value for the given Octal value + + Data to be converted. + The Converted Hexadecimal value. + + + + Computes the Decimal Equivalent for the given Octal value + + The Value to be converted to Decimal + The calculated value for the given + + + + Gets the Real part of the given Complex number. + + Given complex number. + Real part of the given complex Number. + + + + Gets the Imaginary part of the given Complex number. + + Given complex number. + Imaginary part of the given complex Number. + + + + Returns the absolute value (modulus) of a complex number in x + yi or x + yj text format. + + Input Complex Number + The absolute value (modulus) of given complex number + + + + Computes the Product of the given Complex Numbers + + Input Complex Numbers + The multiplied result of the two complex numbers. + + + + Obtains the complex number for the given real and imaginary part. + + Given real and Imaginary part. + The complex number derived from the real and imaginary part. + + + + Computes the sum of two complex number. + + Parameter that is used for performing sum + The calculated sum of the numbers + + + + Computes the Difference of two complex number. + + Parameter that is used for performing Subtraction + The calculated difference of the numbers + + + + Returns the complex conjugate of a complex number in x + yi or x + yj text format. + + Input Complex Number + The complex conjugate of a complex number in x + yi or x + yj text format. + + + + Computes the Division of the given Complex Numbers + + Input Complex Numbers + The Divided result of the two complex numbers. + + + + Returns the Square Root of the given Complex Number. + + Input Complex Number + The Square Root of the given Complex Number. + + + + Returns the argument (theta), an angle expressed in radians + + Input Complex Number + The argument (theta), an angle expressed in radians + + + + Returns the IMSin of the given Complex Number. + + Input Complex Number + The IMSin of the given Complex Number. + + + + Returns the Hyperbolic Sine value of the given Complex Number. + + Input Complex Number + The Hyperbolic Sine Value of the given Complex Number. + + + + Returns the IMCSC of the given Complex Number. + + Input Complex Number + The IMCSC of the given Complex Number. + + + + Returns the IMCos of the given Complex Number. + + Input Complex Number + The IMCos of the given Complex Number. + + + + Returns the IMSEC of the given Complex Number. + + Input Complex Number + The IMSEC of the given Complex Number. + + + + Returns the IMTan of the given Complex Number. + + Input Complex Number + The IMTan of the given Complex Number. + + + + Returns the IMCot of the given Complex Number. + + Input Complex Number + The IMCot of the given Complex Number. + + + + Returns the IMCSCH of the given Complex Number. + + Input Complex Number + The IMCSCH of the given Complex Number. + + + + Returns the Hyperbolic Cos value of the given Complex Number. + + Input Complex Number + The Hyperbolic Cos Value of the given Complex Number. + + + + Returns the IMTanH of the given Complex Number. + + Input Complex Number + The IMTanH of the given Complex Number. + + + + Returns the IMCotH of the given Complex Number. + + Input Complex Number + The IMCotH of the given Complex Number. + + + + Returns the IMSecH of the given Complex Number. + + Input Complex Number + The IMSecH of the given Complex Number. + + + + Returns the LOG10 value of the given Complex Number. + + Input Complex Number + The Log10 of the given Complex Number. + + + + Returns the Log2 of the given Complex Number. + + Input Complex Number + The Log2 of the given Complex Number. + + + + Returns the LOG value of the given Complex Number. + + Input Complex Number + The Log of the given Complex Number. + + + + Returns the Exponent of the given Complex Number. + + Input Complex Number + The Exponent of the given Complex Number. + + + + Returns the power of the given Complex Number. + + Input Complex Number + The power of the given Complex Number. + + + + Computes the Difference of two complex number. + + Parameter that is used for performing Subtraction + The difference of two complex numbers in x + yi or x + yj text format. + + + + Computes the Bit OR of the given two numbers. + + Input Numbersfor which the OR operations has to be performed. + Bit OR value of the given two numbers. + + + + Computes the Bit XoR of the given two numbers. + + Input Numbersfor which the OR operations has to be performed. + Bit OR value of the given two numbers. + + + + Computes the Bit AND of the given two numbers. + + Input Numbersfor which the AND operations has to be performed. + Bit AND value of the given two numbers. + + + + Computes the Bit Left Shift of the given number. + + Input Numbersfor which the OR operations has to be performed. + Bit Left Shift value of the given number. + + + + Computes the Bit Right Shift of the given number. + + Input Numbersfor which the Bit Right Shift operations has to be performed. + Bit Right Shift value of the given number. + + + + Returns the error function . + + Input Number + The error function. + + + + Returns the Complement of error function . + + Input Number + The Complement of error function. + + + + Returns the error function . + + Input Number + The error function. + + + + Return the value of the ComputeBesselI + + arguments + + + + + Return the value of besseli0 + + value + + + + + Returns the BesselJ function of order n of the specified number. + + Input Number + The BesselJ of the Number. + + + + Returns the Bessel function of order 1 of the specified number. + + + + + + + Returns the Bessel function of order 0 of the specified number. + + + + + + + Returns the BesselY function of order n of the specified number. + + Input Number + The BesselY of the Number. + + + + Returns the Bessel function of the second kind, of order 0 of the specified number. + + + + + + + Returns the Bessel function of the second kind, of order 1 of the specified number. + + + + + + + Returns the value of ComputebesselK + + arguments list + + + + + Returns the value of ComputeConversion + + arguments list + + + + + Clears all look up caches used in HLookUp and VLookUp calculations so they will be recreated the + next time one of these functions is used. + + + + + Returns the value of Clearsheet + + Icalcdata + + + + Use this method to reset internal error strings if you make changes to . + + + + + This method used to find the sheet id of the parsed grid. + + Intsance of ICalcData + The sheet id of the grid + + + + Used to find the determinant internally for matrix function + + double array + array length + double value + + + + Returns the Probabilitydistribution of the normal distribution. + + Value at which the distribution is evaluated. + Mean of the distribution. + Standard deviation of the distribution. + + + + find the cofactor of matrix + + + array length + return the inverse matrix + return success state + + + + To find the inverse of matrix + + matrix + cofactor matrix + matrix length + Inveser matrix + Inverse Matrix + + + + Chi-squared probability density function. + + The value at which the PDF is evaluated. + Degress of freedom, or number independent standard normal distributions. + + + + + Returns the inverse of the CDF of the normal distribution. + + Cumulative probability of the distribution. 0 <= p >= 1. + Mean of the distribution. + Standard deviation of the distribution. + + + + Returns the inverse of the CDF of the standard normal distribution. + + Cumulative probability of the distribution. p is between 0 and 1. + + + + Computes the net present value an investment. + + Delimited string containing the rate as percentage per period + and a list of invested values. + Net present value. + + + + Computes the payment for a loan. + + Delimited string containing the rate as percentage per period, + number of periods, present value, future value, and payment type (0 = end of period, 1 = start of period). + Payment amount. + + + + Computes the principal payment for a period. + + Delimited string containing the rate as percentage per period, the period, + number of periods, present value, future value, and payment type (0 = end of period, 1 = start of period). + Principal payment. + + + + Computes the present value of an investment. + + Delimited string containing the rate as percentage per period, + number of periods, payment per period, future value, and payment type (0 = end of period, 1 = start of period). + Present value. + + + + Compute the effective annual interest rate. + + the nominal annual interest rate and the number of compounding periods per year + The effective annual interest rate. + + + + Computes the internal rate of return of a series of cash flows. + + Delimited string containing a range of cells and an initial guess. + Internal rate of return. + + This IRR calculation uses Newton's method to approximate a root of + f(r) = Sum( values[i]/(1+r)^i) = 0 + where the Sum index is i = 1 to the number of values. The algorithm returns a value if + the relative difference between root approximations is less than 1e-7. It fails if this + accuracy is not attained in 20 iterations. + + + + + Computes the straight-line depreciation of an asset per period. + + Delimited string containing the cost, + salvage value, and life. + Depreciation of the asset. + + + + Computes the sum of years digits depreciation of an asset per period. + + Delimited string containing the cost, + salvage value, life, and period. + Depreciation for the requested period. + + + + Computes the variable declining balance of an asset. + + Delimited string containing the initial cost, + salvage value, life of asset, period of calculation, and factor. + Variable declining balance. + + + + Converts a number to text using currency format. + + Number and the number of digits. + Currency format string. + + + + Converts a number to text using currency format. + + Number and the number of digits. + Currency format string. + + + + Returns the weighted average of the present value of the cash flows + + Number and the number of digits + Number of years + + + + Calculates the accrued interest of a security that pays interest at maturity. + + Number and the number of digits + Accrued interest + + + + Calculates the equivalent interest rate for the growth of an investment. + + Investment periods, present and future value of the investments. + Returns the equivalent interest. + + + + Returns the future value of an initial principal after applying a series of compound interest rates. + + Number and the number of digits + Number of future value + + + + Returns the interest rate for a fully invested security. + + Number and the number of digits + Rate of interest + + + + Returns the discount rate for a security. + + Number and the number of digits + Rate of Discount + + + + Computes the future value of an investment. + + Delimited string containing the rate as percentage per period, + number of periods, payment per period, present value, and payment type (0 = end of period, 1 = start of period). + Future value of the investment. + + + + Computes the interest payment for a period. + + Delimited string containing the rate as percentage per period, the period, + number of periods, present value, future value, and payment type (0 = end of period, 1 = start of period). + Interest payment. + + + + Computes the internal rate of return of a series of cash flows. + + Delimited string containing a range of cells and an initial guess. + Internal rate of return. + + This IRR calculation uses Newton's method to approximate a root of + f(r) = Sum( values[i]/(1+r)^i) = 0 + where the Sum index is i = 1 to the number of values. The algorithm returns a value if + the relative difference between root approximations is less than 1e-5. It fails if this + accuracy is not attained in 20 iterations. + + + + + Computes the internal rate of return for a schedule of possibly non-periodic cash flows. + + A list of two or three arguments. The first argument contains a range of cash flows, the second argument + contains a list of corresponding date serial number values, and the third argument contains an initial guess at the return value. + The internal rate of return. + The computation uses a root finding algorithm. If the algorithm does not converge to a result within 100 iterations, + an error is returned. The convergence requirement is an absolute error of 0.000001. The first date must be the earliest date, + and the dates must be date serial numbers. Also, there must be at least one positive cash flow and at least one negative cash + flow in the cash flow values. + + + + + Computes the extended internal rate of return for a schedule of possibly non-periodic cash flows. + + Which contains the non periodic cashflows. + Which contains the details about the investment days of non-periodic cash flows. + Which denotes the inital guess value. + + Returns the xiir calculation value. + + + + + Computes the extended internal rate of return for a schedule of possibly non-periodic cash flows. + + Which contains the non periodic cashflows. + Which contains the details about the investment days of non-periodic cash flows. + Which denotes the guess value. + + Returns the xiir calculation value. + + + + + Computes the Net Present Value for a schedule of possibly non-periodic cash flows. + + Which contains the non periodic cashflows. + Which contains the details about the investment days of non-periodic cash flows. + Which denotes the guess value. + + Returns the Net Present Value. + + + + + Computes the Net Present Dervative Value for a schedule of possibly non-periodic cash flows. + + Which contains the non periodic cashflows. + Which contains the details about the investment days of non-periodic cash flows. + Which denotes the guess value. + + Returns the Net Present Dervative Value. + + + + + Computes the simple interest payment. + + Delimited string containing the rate as percentage per period, the period, + number of periods, and present value. + Simple interest payment. + + + + Computes the modified internal rate of return of a series of cash flows. + + Delimited string containing a range of cells, + finance interest rate, and a reinvested interest rate. + Modified internal rate of return. + + + + Computes the number of periods an investment. + + Delimited string containing the rate as percentage per period, + payment per period, present value, future value, and payment type (0 = end of period, 1 = start of period). + Number of periods. + + + + Computes the declining balance of an asset. + + Delimited string containing the initial cost, + salvage value, life of asset, period of calculation, and months in the initial year. + Declining balance. + + + + Computes the double declining balance of an asset. + + Delimited string containing the initial cost, + salvage value, life of asset, period of calculation, and factor. + Double declining balance. + + + + Returns the cumulative interest paid for an investment period with a constant interest rate. + + Number and the number of digits + Number of interest rate + + + + Calculates the accrued interest of a security in the case of periodic payments. + + Number and the number of digits + Accrued interest + + + + Returns the cumulative principal paid for an investment period with a constant interest rate. + + Number and the number of digits + Cumulative principal value + + + + Returns the amount received at maturity for a fully invested security. + + Number and the number of digits + Received amount + + + + This function computes the nominal interest rate based on the effective annual interest rate and the number of compounding periods per year. + + + A comma-separated string containing two values. The format should be: effective_rate, npery. + + effective_rate: The effective annual interest rate as a decimal (e.g., 0.053543 for 5.3543%). + npery: The number of compounding periods per year as an integer (e.g., 4 for quarterly compounding). + + + + A string representing the nominal interest rate. If the input is invalid or cannot be parsed, an error message is returned. + + + The nominal interest rate is calculated using the formula: + + nominalRate = npery * (Math.Pow(1 + effectRate, 1.0 / npery) - 1) + + where effectRate is the effective annual interest rate and npery is the number of compounding periods per year. + The method checks that the effective annual interest rate is positive and that the number of compounding periods is at least 1. + If the inputs are invalid (e.g., non-numeric values, negative rates, or invalid period counts), an appropriate error message is returned. + + + + + This function calculates the Modified Duration (MDuration) of a security, similar to the MDuration function in Excel. + This measure indicates how sensitive the bond's price is to changes in interest rates, adjusted for the bond's yield and the frequency of its coupon payments. + + + A comma-separated string of arguments. The format should be: settlement_date, maturity_date, coupon_rate, yield_rate, frequency, [basis]. + + settlement_date: The date when the bond is purchased (format: DATE function or serial number). + maturity_date: The date when the bond matures (format: DATE function or serial number). + coupon_rate: The annual coupon rate of the bond as a decimal (e.g., 0.08 for 8%). + yield_rate: The annual yield of the bond as a decimal (e.g., 0.09 for 9%). + frequency: The number of coupon payments per year (e.g., 1 for annual, 2 for semiannual, 4 for quarterly). + basis: Optional. The day count basis to use (0 for US 30/360, 1 for Actual/Actual, 2 for Actual/360, 3 for Actual/365, 4 for European 30/360). + + + + A string representing the modified duration of the bond, rounded to a reasonable number of decimal places. + If any input is invalid (e.g., incorrect date format, negative rates, or invalid frequency), an error message is returned. + + + + + Calculates the modified duration of a bond given its parameters. + + The bond's settlement date. + The bond's maturity date. + The bond's annual coupon rate. + The bond's annual yield. + The number of coupon payments per year. + The day count basis for the bond's interest calculation. + The modified duration of the bond as a string. + + + + This function computes the number of periods required for an investment to reach a specified future value based on the given interest rate and present value. + + + A comma-separated string of arguments. The format should be: rate, present_value, future_value. + + rate: The interest rate per period as a decimal (e.g., 0.025 for 2.5%). + present_value: The current value of the investment. + future_value: The desired future value of the investment. + + + + A string representing the number of periods required to reach the future value, rounded to two decimal places. + If any input is invalid (e.g., negative values or non-numeric inputs), an error message is returned. + + + + + This function computes the next coupon date after the settlement date for a bond and returns the date as a serial date number. + + + A comma-separated string of arguments. The format should be: settlement_date, maturity_date, frequency, [basis]. + + settlement_date: The date when the bond is purchased (format: DATE function or serial number). + maturity_date: The date when the bond matures (format: DATE function or serial number). + frequency: The number of coupon payments per year (e.g., 1 for annual, 2 for semiannual, 4 for quarterly). + basis: Optional. The day count basis to use (0 for US 30/360, 1 for Actual/Actual, 2 for Actual/360, 3 for Actual/365, 4 for European 30/360). + + + + A string representing the next coupon date after the settlement date, formatted as a serial date number. + If any input is invalid (e.g., incorrect date format, invalid frequency, or if the settlement date is on or after the maturity date), an error message is returned. + + + + + Checks and parses the input arguments for COUP functions. + + A string containing the arguments: settlement date, maturity date, frequency, and optionally, the basis. + Outputs the parsed settlement date. + Outputs the parsed maturity date. + Outputs the parsed coupon payment monthBetweenCoupon + Outputs the parsed day count basis (0-4). + Returns an error message if arguments are invalid, otherwise an empty string. + + + + This function computes the previous coupon date before the settlement date for a bond and returns the date as a serial date number. + + + A comma-separated string of arguments. The format should be: settlement_date, maturity_date, frequency, [basis]. + + settlement_date: The date when the bond is purchased (format: DATE function or serial number). + maturity_date: The date when the bond matures (format: DATE function or serial number). + frequency: The number of coupon payments per year (e.g., 1 for annual, 2 for semiannual, 4 for quarterly). + basis: Optional. The day count basis to use (0 for US 30/360, 1 for Actual/Actual, 2 for Actual/360, 3 for Actual/365, 4 for European 30/360). + + + + A string representing the previous coupon date before the settlement date, formatted as a serial date number. + If any input is invalid (e.g., incorrect date format, invalid frequency, or if the settlement date is on or after the maturity date), an error message is returned. + + + + + This function computes the number of days from the beginning of the coupon period to the settlement date for a bond. + + + A comma-separated string of arguments. The format should be: settlement_date, maturity_date, frequency, [basis]. + + settlement_date: The date when the bond is purchased (format: DATE function or serial number). + maturity_date: The date when the bond matures (format: DATE function or serial number). + frequency: The number of coupon payments per year (e.g., 1 for annual, 2 for semiannual, 4 for quarterly). + basis: Optional. The day count basis to use (0 for US 30/360, 1 for Actual/Actual, 2 for Actual/360, 3 for Actual/365, 4 for European 30/360). + + + + A string representing the number of days from the beginning of the coupon period to the settlement date. + If any input is invalid (e.g., incorrect date format, invalid frequency, or if the settlement date is on or after the maturity date), an error message is returned. + + + + + Computes the number of days in the coupon period that contains the settlement date. + + The settlement date. + The maturity date. + The coupon frequency (1, 2, or 4). + The day count basis (0 to 4). + A string representing the number of days in the coupon period. + + + + Calculates the number of days between two dates based on the 30/360 day count convention. + + The start date. + The end date. + The day count basis: 0 for US (NASD) 30/360, 4 for European 30/360. + The number of days between the start and end dates, adjusted according to the specified 30/360 basis. + + + + This function computes the number of days from the settlement date to the next coupon date for a bond. + + + A comma-separated string of arguments. The format should be: settlement_date, maturity_date, frequency, [basis]. + + settlement_date: The date when the bond is purchased (format: DATE function or serial number). + maturity_date: The date when the bond matures (format: DATE function or serial number). + frequency: The number of coupon payments per year (e.g., 1 for annual, 2 for semiannual, 4 for quarterly). + basis: Optional. The day count basis to use (0 for US 30/360, 1 for Actual/Actual, 2 for Actual/360, 3 for Actual/365, 4 for European 30/360). + + + + A string representing the number of days from the settlement date to the next coupon date. + If any input is invalid (e.g., incorrect date format, invalid frequency, or if the settlement date is on or after the maturity date), an error message is returned. + + + + + This function calculates the total number of days in the coupon period that contains the settlement date for a bond. + + + A comma-separated string of arguments. The format should be: settlement_date, maturity_date, frequency, [basis]. + + settlement_date: The date when the bond is purchased (format: DATE function or serial number). + maturity_date: The date when the bond matures (format: DATE function or serial number). + frequency: The number of coupon payments per year (e.g., 1 for annual, 2 for semiannual, 4 for quarterly). + basis: Optional. The day count basis to use (0 for US 30/360, 1 for Actual/Actual, 2 for Actual/360, 3 for Actual/365, 4 for European 30/360). + + + + A string representing the total number of days in the coupon period that contains the settlement date. If any input + is invalid (e.g., incorrect date format, invalid frequency, or if the settlement date is on or after the maturity date), + an error message is returned. + + + + + This function calculates the number of coupons payable between the settlement date and the maturity date. + + + A string containing the input arguments separated by commas. The format should be: "settlement, maturity, frequency, [basis]" + + + settlement: The settlement date of the security, represented as a date string. + + + maturity: The maturity date of the security, represented as a date string. + + + frequency: The number of coupon payments per year (1 for annual, 2 for semi-annual, 4 for quarterly). + + + basis [optional]: The day count basis to use (0 = US (NASD) 30/360, 1 = Actual/actual, 2 = Actual/360, 3 = Actual/365, 4 = European 30/360). If omitted, the default is 0. + + + + + A string representing the number of coupons payable between the settlement date and maturity date, rounded up to the nearest whole coupon. + Returns an error message if the input arguments are invalid or if an error occurs during the calculation. + + + + + + Check and parse the input arguments for Treasury bill formula. + + + + + This function computes the linear depreciation (AMORLINC) for an asset over each accounting period. + + + A comma-separated string containing the input arguments in the following format: "cost, datePurchased, firstPeriod, salvage, period, rate, [basis]". + + + cost: The initial cost of the asset. + + + datePurchased: The date the asset was purchased, provided in "yyyy-MM-dd" format. + + + firstPeriod: The end date of the first depreciation period, provided in "yyyy-MM-dd" format. + + + salvage: The expected salvage value of the asset at the end of its useful life. + + + period: The total number of periods over which the asset will be depreciated. + + + rate: The depreciation rate applied for each period. + + + + basis [optional]: The day count basis to use + (0 = US (NASD) 30/360, + 1 = Actual/actual, + 2 = Actual/360, + 3 = Actual/365, + 4 = European 30/360). + If omitted, the default is 0. + + + + + + A string representing the calculated depreciation for the specified period. If the input parameters are invalid, an error message is returned. + + + + + + This function calculates the price discount of a security based on its settlement date, maturity date, discount rate, redemption value, and day count basis. + + + A comma-separated containing the input arguments in the format: "settlement, maturity, discount, redemption, [basis]" + + + settlement: The settlement date of the security, represented as a date string (yyyy-MM-dd) or serial number. + + + maturity: The maturity date of the security, represented as a date string (yyyy-MM-dd) or serial number. + + + discount: The discount rate of the security, represented as a decimal value (e.g., 0.05 for 5%). Must be greater than 0. + + + redemption: The redemption value of the security, represented as a decimal value. Must be greater than 0. + + + + basis [optional]: The day count basis to use + (0 = US (NASD) 30/360, + 1 = Actual/actual, + 2 = Actual/360, + 3 = Actual/365, + 4 = European 30/360). + If omitted, the default is 0. + + + + + + A string representing the calculated price discount. Returns an error message if the input arguments are invalid or if an error occurs during the calculation. + + + + + Parses and validates input arguments for both yield and price discount methods. + + Input arguments as a string. + Array of parsed argument values. + The settlement date of the security. + The maturity date of the security. + Price or discount value, depending on the calculation. + The redemption value of the security. + The day count basis to use. + Indicates whether the method is calculating yield (true) or price (false). + Returns an error string if any issues are encountered; otherwise, returns an empty string. + + + + Determine number of days between two dates based on the day count basis. + + + + + Get the year basis for day count. + + + + + This function calculates the price per $100 face value for a Treasury bill based on the settlement date, maturity date, and discount rate. + + + A comma-separated string containing the input arguments in the format: "settlement, maturity, discount". + + + + settlement: The Treasury bill's settlement date in "yyyy-MM-dd" format. + This is the date the T-bill is purchased. + + + + + maturity: The Treasury bill's maturity date in "yyyy-MM-dd" format. + This is the date the T-bill matures, and the face value is repaid. + + + + + discount: The T-bill's discount rate expressed as a percentage + (e.g., 5.5 for 5.5%). + + + + + + A string representing the calculated price per $100 face value for the Treasury bill + If input parameters are invalid or calculation errors occur, an error message will be returned. + + + + + This function calculates and returns the yield for a Treasury bill based on the settlement date, maturity date, and price per $100 face value. + + + A comma-separated string containing the input arguments in the format: "settlement, maturity, pr". + + + + settlement: The settlement date of the Treasury bill in "yyyy-MM-dd" format. + This is the date on which the T-bill is purchased by the buyer. + + + + + maturity: The maturity date of the Treasury bill in "yyyy-MM-dd" format. + This is the date on which the T-bill expires and its face value is paid to the holder. + + + + + pr: The price of the Treasury bill per $100 face value, represented as a numeric value. + + + + + + A string representing the calculated yield of the Treasury bill as a percentage. + If the input arguments are invalid or an error occurs during calculation, an appropriate error message is returned. + + + + + This function Computes and returns the price per $100 face value of a security that pays periodic interest. + + + A comma-separated string containing the numeric input values for which the price is to be calculated. + The format should be: "settlement, maturity, rate, yld, redemption, frequency, [basis]". + + + + settlement: The settlement date of the security in "yyyy-MM-dd" format. + This is the date after the issue date when the security is traded to the buyer. + + + + + maturity: The maturity date of the security in "yyyy-MM-dd" format. + This is the date on which the security expires, and its face value is paid to the holder. + + + + + rate: The annual coupon rate of the security, represented as a decimal value + (e.g., 0.05 for 5%). + + + + + yld: The annual yield of the security, represented as a decimal value + (e.g., 0.04 for 4%). + + + + + redemption: The redemption value of the security per $100 face value, typically + represented as 100 or another numeric value. + + + + + frequency: The number of coupon payments per year. Use: + + 1 for annual payments + 2 for semiannual payments + 4 for quarterly payments + + + + + + basis [optional]: The day-count basis to use for the calculation. Valid values are: + + 0 = US (NASD) 30/360 (default) + 1 = Actual/Actual + 2 = Actual/360 + 3 = Actual/365 + 4 = European 30/360 + + If omitted, the default is 0 (30/360). + + + + + + A string representing the price per $100 face value of a security that pays periodic interest. + If the input values are invalid or if an error occurs during the calculation, an appropriate + error message is returned. + + + + + Parses and validates input arguments for yield and price calculations. + Extracts dates, rates, and other parameters, ensuring they meet the required constraints. + Returns an error message string if validation fails, or an empty string upon success. + + Array of input argument strings. + Output: Annual coupon rate as a percentage. + Output: Price of the bond. + Output: Redemption value of the bond. + Output: Number of coupon payments per year (1, 2, or 4). + Output: Day count basis (0 to 4). + Output: Serial number representing the settlement date. + Output: Serial number representing the maturity date. + + An empty string if validation succeeds, or an error message string if it fails. + + + + + Calculates the price of a bond when the number of coupons is greater than one. + Incorporates periodic coupon payments, discounting, and redemption value. + + Number of days from the beginning of the coupon period to the settlement date. + Total number of days in the coupon period. + Annual coupon rate as a percentage. + Yield to maturity as a percentage. + Redemption value of the bond. + Number of coupon payments per year. + Number of remaining coupon payments. + The computed bond price. + + + + Computes the power of a number with optimization for near-integer exponents. + Reduces computation time by checking if the exponent is close to an integer. + + Base number. + Exponent value. + The computed power of the base number raised to the given exponent. + + + + This function calculates the yield of a security that pays periodic interest. + + + A comma-separated string containing the input arguments in the format: "settlement, maturity, rate, price, redemption, frequency, [basis]". + + + + settlement: The settlement date of the security, specified in "yyyy-MM-dd" format or as a serial number. This is the date when the security is traded to the buyer. + + + + + maturity: The maturity date of the security, specified in "yyyy-MM-dd" format or as a serial number. This is the date when the security expires, and its face value is paid to the holder. + + + + + rate: The annual coupon rate of the security, expressed as a decimal (e.g., 0.05 for 5%). + + + + + price: The price of the security per $100 face value, typically a numeric value. + + + + + redemption: The redemption value of the security per $100 face value, typically a numeric value. + + + + + frequency: The number of coupon payments per year. Acceptable values are: + + 1 for annual payments. + 2 for semi-annual payments. + 4 for quarterly payments. + + + + + + basis (optional): The day count basis used for the calculation. Defaults to 0 (NASD 30/360). Acceptable values are: + + 0: NASD 30/360. + 1: Actual/Actual. + 2: Actual/360. + 3: Actual/365. + 4: European 30/360. + + + + + + + A string representing the calculated yield of the security as a percentage. If the input parameters are invalid, an error message is returned. + + + + + Calculates the yield for a bond with less than one coupon payment remaining. + + The calculated yield. + + + + Estimates the yield of a security using an iterative approach for cases with more than one coupon payment. + + + + + This function calculates the annual yield of a security that pays interest at maturity based on its settlement date, maturity date, issue date, coupon rate, price, and day count basis. + + + A comma-separated string containing the input arguments in the following format: "settlement, maturity, issue, rate, price, [basis]". + + + + settlement: The settlement date of the security, specified in "yyyy-MM-dd" format or as a serial number. This is the date when the security is traded to the buyer. + + + + + maturity: The maturity date of the security, specified in "yyyy-MM-dd" format or as a serial number. This is the date when the security expires, and its face value is paid to the holder. + + + + issue: The issue date of the security, specified in "yyyy-MM-dd" format or as a serial number. This is the date when the security is first issued. + + + rate: The annual coupon rate of the security, represented as a decimal value (e.g., 0.05 for 5%).This value must be greater than 0. + + + price: The price of the security per $100 face value. This value must be greater than 0. + + + + basis [optional]: The day count basis to use for the calculation. Defaults to 0 (US NASD 30/360) if omitted. Acceptable values are: + (0 = US (NASD) 30/360, + 1 = Actual/actual, + 2 = Actual/360, + 3 = Actual/365, + 4 = European 30/360). + + + + + + A string representing the calculated yield value at the maturity date. If the input arguments are invalid, an error message is returned. + + + + + This method parses the input arguments for YIELDMAT and PRICEMAT functions and extracts the required values. + + Returns an error string if validation fails, or an empty string if successful. + + + + Calculates the price of a security that pays interest at maturity, based on its settlement date, maturity date, issue date, coupon rate, yield, and day count basis. + + + A comma-separated string containing the input arguments in the following format: "settlement, maturity, issue, rate, yield, [basis]". + + + + settlement: The settlement date of the security. + This is the date when the security is traded to the buyer. + It should be provided as a date string in "yyyy-MM-dd" format or as a serial number. + + + + + maturity: The maturity date of the security. + This is the date when the security expires, and its face value is paid to the holder. + It should be provided as a date string in "yyyy-MM-dd" format or as a serial number. + + + + + issue: The issue date of the security. + This is the date when the security was first issued. + It should be provided as a date string in "yyyy-MM-dd" format or as a serial number. + + + + + rate: The annual coupon rate of the security, represented as a decimal value (e.g., 0.05 for 5%). + This value must be greater than 0. + + + + + yield: The annual yield of the security, represented as a decimal value (e.g., 0.06 for 6%). + This value must be greater than 0. + + + + + basis [optional]: The day count basis to use for the calculation. + Defaults to 0 (US NASD 30/360) if omitted. + Acceptable values are: + + 0 = US (NASD) 30/360 + 1 = Actual/actual + 2 = Actual/360 + 3 = Actual/365 + 4 = European 30/360 + + + + + + + A string representing the calculated price of the security. + If the input arguments are invalid, an error message is returned. + + + + + This function calculates the yield discount of a security based on its settlement date, maturity date, price, redemption value, and day count basis. + + + A comma-separated string containing the input arguments in the following format: "settlement, maturity, price, redemption, [basis]". + + + + settlement: The settlement date of the security. + This is the date when the security is traded to the buyer. + It should be provided as a date string in "yyyy-MM-dd" format or as a serial number. + + + + + maturity: The maturity date of the security. + This is the date when the security expires, and its face value is paid to the holder. + It should be provided as a date string in "yyyy-MM-dd" format or as a serial number. + + + + + price: The price of the security, represented as a decimal value per $100 face value. + This value must be greater than 0. + + + + + redemption: The redemption value of the security, represented as a decimal value per $100 face value. + This value must be greater than 0. + + + + + basis [optional]: The day count basis to use for the calculation. + Defaults to 0 (US NASD 30/360) if omitted. + Acceptable values are: + + 0 = US (NASD) 30/360 + 1 = Actual/actual + 2 = Actual/360 + 3 = Actual/365 + 4 = European 30/360 + + + + + + + A string representing the calculated annual yield discount. If the input arguments are invalid, an error message is returned. + + + + + This function calculates the Net Present Value (NPV) of a series of cash flows occurring at irregular intervals using a specified discount rate. + + + A comma-separated string of arguments in the format: rate, values, dates. + + + rate: The discount rate applied to the cash flows.It is used to discount future cash flows to their present value. + + + + values: A series of cash flow amounts corresponding to the payment dates. + The first payment is optional and typically represents a cost or initial investment, and should be negative if it is a payment. + All subsequent payments are discounted based on a 365-day year. + The series must include at least one positive value (income) and one negative value (expense). + + + + + dates: A series of dates corresponding to the cash flow payments. + The first date represents the starting point of the cash flow schedule.Subsequent dates must occur after the first date, although they can be in any order.. + + + + + + Returns the calculated Net Present Value (NPV) as a string based on the provided discount rate, cash flows, and payment dates. + If an error occurs, such as invalid input format or mismatched values and dates, an error message is returned. + + + + + This method compute and return the Values and Dates array.If error string finds retrun error string. + + + + + Computes and populates a values array based on the provided input string. + If an error is encountered during processing, an error string is returned. + + + The input string to be processed. + + + A reference to a list where valid numeric values will be added. + + + A reference to a string where the error message will be set if the input string is invalid. + + + + + Computes and populates a values array based on the provided input string. + If an error is encountered during processing, an error string is returned. + + + The input string to be processed. + + + A reference to a list where valid numeric values will be added. + + + A reference to a string where the error message will be set if the input string is invalid. + + + + + This function calculates the price per $100 face value of a security that has an odd (short or long) last coupon period. + + + A comma-separated string containing the input arguments in the format: + "settlement, maturity, issue, rate, yld, redemption, frequency, [basis]". + + + + settlement: The settlement date of the security, specified in "yyyy-MM-dd" format or as a serial number. + This is the date the buyer purchases the security. + + + + + maturity: The maturity date of the security, specified in "yyyy-MM-dd" format or as a serial number. + This is the date the security expires. + + + + + last_interest: The security's last coupon date, specified in "yyyy-MM-dd" format or as a serial number. + This is the date of the most recent coupon payment prior to the settlement date. + + + + + rate: The annual coupon rate of the security, expressed as a percentage (e.g., 5% is represented as 5.0). + + + + + yld: The annual yield of the security, expressed as a percentage (e.g., 5% is represented as 5.0). + + + + + redemption: The redemption value of the security per $100 face value. + Typically, this is 100 if the security is redeemed at par. + + + + + frequency: The number of coupon payments per year. Valid values are: + + 1: Annual payments. + 2: Semi-annual payments. + 4: Quarterly payments. + + + + + + basis (optional): The day count basis for the calculation. Defaults to 0 (NASD 30/360). Valid values are: + + 0: NASD 30/360. + 1: Actual/Actual. + 2: Actual/360. + 3: Actual/365. + 4: European 30/360. + + + + + + + A string representing the calculated price of the security with an odd last period. + Returns an error message if the input parameters are invalid or if validation fails. + + + + + Parses and validates input arguments for the ODDLPRICE and ODDLYIELD functions. + + A string containing the input arguments for ODDLPRICE or ODDLYIELD. + Returns an error message if validation fails, or an empty string if successful. + + + + Calculates the non-negative day difference between two dates using a day count basis, with additional logic for day count convention. + + The positive difference in days between start and end dates as a double. + + + + Calculates the non-negative difference in days between two dates based on the specified day count basis. + + The positive difference in days between start and end dates as a double. + + + + This function calculates the yield of a security with an odd (short or long) last coupon period. + + + A comma-separated string containing the input arguments in the format: + "settlement, maturity, issue, rate, yld, redemption, frequency, [basis]". + + + + settlement: The settlement date of the security, specified in "yyyy-MM-dd" format or as a serial number. + This is the date the buyer purchases the security. + + + + + maturity: The maturity date of the security, sepcified in "yyyy-MM-dd" format or as a serial number. + This is the date the security expires. + + + + + issue: The issue date of the security, sepcified in "yyyy-MM-dd" format or as a serial number. + This is the date the security was originally issued. + + + + + rate: The annual coupon rate of the security, expressed as a percentage (e.g., 5% is represented as 5.0). + + + + + pr: The price of the security per $100 face value, expressed as a percentage (e.g., a price of $95 is represented as 95.0). + + + + + redemption: The redemption value of the security per $100 face value. + Typically, this is 100 if the security is redeemed at par. + + + + + frequency: The number of coupon payments per year. Valid values are: + + 1: Annual payments. + 2: Semi-annual payments. + 4: Quarterly payments. + + + + + + basis (optional): The day count basis for the calculation. Defaults to 0 (NASD 30/360). Valid values are: + + 0: NASD 30/360. + 1: Actual/Actual. + 2: Actual/360. + 3: Actual/365. + 4: European 30/360. + + + + + + + A string representing the computed yield of the security with an odd last period. + Returns an error message if the input parameters are invalid or if validation fails. + + + + + This function calculates the depreciation for an asset using the AMORDEGRC method, an accelerated depreciation approach. + The method applies a declining balance approach where the depreciation rate increases based on the asset's lifespan. + + + A comma-separated string containing the input arguments in the format: "cost, purchaseDate, firstPeriodEndDate, salvageValue, period, rate, [basis], [lifetime]". + + + + cost: The initial cost of the asset. + + + + + purchaseDate: The date of purchase, sepcified in "yyyy-MM-dd" format or as a serial number. + + + + + firstPeriodEndDate: The end date of the first period, sepcified in "yyyy-MM-dd" format or as a serial number. + + + + + salvageValue: The salvage value of the asset at the end of its useful life. + + + + + period: The period for which depreciation is to be calculated (e.g., the number of years). + + + + + rate: The depreciation rate of the asset. + + + + + basis (optional): The day count basis to use for the calculation. Defaults to 0 (NASD 30/360). Acceptable values are: + + 0: NASD 30/360. + 1: Actual/Actual. + 2: Actual/360. + 3: Actual/365. + 4: European 30/360. + + + + + + lifetime (optional): The total lifetime of the asset in periods. If omitted, it defaults to the standard asset lifetime. + + + + + + A formatted string containing the calculated depreciation value for the specified period. If the input parameters are invalid, an error message is returned. + + + + + Performs the AMORDEGRC depreciation calculation for an asset based on cost, dates, salvage value, depreciation period, and rate. + + String representation of the calculated depreciation amount. + + + + Determines the depreciation coefficient based on the asset's lifetime. + + Depreciation coefficient as a multiplier (1.0, 1.5, 2.0, or 2.5). + + + + Adjusts the date to ensure proper handling of the first period depreciation based on the day count basis. + + The adjusted date. + + + + Calculates the AMORDEGRC depreciation for a given period. + + The depreciation value for the specified period. + + + + This function calculates the price per $100 face value of a security with an odd first period + + + A comma-separated string containing the input arguments in the format: + "settlement, maturity, issue, first_coupon, rate, yld, redemption, frequency, [basis]". + + + + settlement: The settlement date of the security, in "yyyy-MM-dd" format or as a serial number. + + + + + maturity: The maturity date of the security, in "yyyy-MM-dd" format or as a serial number. + + + + + issue: The issue date of the security, in "yyyy-MM-dd" format or as a serial number. + + + + + first_coupon: The date of the first coupon payment, in "yyyy-MM-dd" format or as a serial number. + + + + + rate: The annual coupon rate of the security. + + + + + yld: The annual yield of the security. + + + + + redemption: The redemption value of the security per $100 face value. + + + + + frequency: The number of coupon payments per year. Acceptable values are: + + 1 for annual payments. + 2 for semi-annual payments. + 4 for quarterly payments. + + + + + + basis (optional): The day count basis to use for the calculation. Defaults to 0 (NASD 30/360). Acceptable values are: + + 0: NASD 30/360. + 1: Actual/Actual. + 2: Actual/360. + 3: Actual/365. + 4: European 30/360. + + + + + + + A formatted string of the calculated price of the security with an odd first period. If the input parameters are invalid, an error message is returned. + + + + + Parses and validates input arguments for the ODDFPRICE and ODDFYIELD formulae. + + + + + Calculates the odd first coupon price for a bond based on the given parameters. + + + + + Calculates the adjustment factors for the odd first coupon period in a bond price calculation. + + A function that calculates cumulative adjustment values for principal and interest components. + + + + Aggregates values over a specified range, applying a collector function to accumulate results. + + An array containing the accumulated results. + + + + Calculates an aggregated result by applying a specified function to a range of integers, + accumulating the result as a double value. The function iterates from the specified start to end values, + using a seed value as the initial result and aggregating using the provided collector function. + + The final accumulated result as a double after applying the collector function across the specified range. + + + + Generates a sequence of integers between a specified start and end, inclusive. + + An IEnumerable containing integers from start to end. + + + + Calculates the number of coupon periods between two dates based on the specified interval in months. + + The number of coupon periods between startDate and endDate. + + + + This function calculates the yield of a security that has an odd (short or long) first period. + + + A comma-separated string containing the input arguments in the format: "settlement, maturity, issue, first_coupon, rate, yld, redemption, frequency, [basis]". + + + + settlement: The settlement date of the security, in the provided format "yyyy-MM-dd" or as a serial number. + + + + + maturity: The maturity date of the security, in the provided format "yyyy-MM-dd" or as a serial number. + + + + + issue: The issue date of the security, in the provided format "yyyy-MM-dd" or as a serial number. + + + + + first_coupon: The date of the first coupon payment, in the provided format "yyyy-MM-dd" or as a serial number. + + + + + rate: The annual coupon rate of the security. + + + + + pr: The annual price of the security. + + + + + redemption: The redemption value of the security per $100 face value. + + + + + frequency: The number of coupon payments per year. Acceptable values are: + + 1 for annual payments. + 2 for semi-annual payments. + 4 for quarterly payments. + + + + + + basis (optional): The day count basis to use for the calculation. Defaults to 0 (NASD 30/360). Acceptable values are: + + 0: NASD 30/360. + 1: Actual/Actual. + 2: Actual/360. + 3: Actual/365. + 4: European 30/360. + + + + + + + A formatted string of the calculated yield of the security with an odd first period. If the input parameters are invalid, an error message is returned. + + + + + Finds the root of a function using a combination of Newton's and Bisection methods. + + + + + Determines bounds that contain a root of the given function by expanding outward from an initial guess. + + + + + this function used to obtain the address of a cell in a worksheet, given specified row and column numbers + + The argList contain the row and column postion and type of reference + Address of the given row and column + + + + Return the information about cell + + content, reference + Cell information + + + + Returns the current operation environment information + + Type + environment information + + + + Returns the interger value for the datatype of given text + + text + integer value + + + + Return the value of ComputeIsFormula + + arguments + + + + + Returns a horizontal table look up value. + + Contains search value, table, return index and match properties. + Matching value found in the table. + For example, =HLOOKUP("Axles",A1:C4,2,TRUE) looks for the exact + match for Axles in A1:C1 and returns the corresponding value in A2:C2. + + + + + Finds the index a specified value in a lookup_range. + + look_value, lookup_range, match_type + The relative index of the lookup_value in the lookup_range. + + Lookup_range should be a either a single row range or a single column range. + If match_type is 0, the relative index of the first exact match (ignoring case) + in the specified range is returned. If match_type is 1, the values in the range + should be in ascending order, and the index of the largest value less than or + equal to the lookup_value is returned. If match_type is -1, the values in the range + should be in descending order, and the index of the smallest value greater than or + equal to the lookup_value is returned. + + + + + Below method is used to returns the cellrange while the lookup vector is cellrange and result vector is cell(eg:=LOOKUP(2,D7:I7,A1)). + + lookup vectors value. + result vectors value. + The default value is false.True when the resultant vector range from GetResultRange is modified. + Returns the cellrange of result vector. + + + + Calculate multiple range lookup with logical operators and retruns calculated lookup range. + + + Calculated lookup range + + + + Returns a value from result table either from a one-row or one-column range or from an array + + Lookup Value, lookup range, result range + Matching value found in the table + + + + To get the result value of lookup formula. + + ResultVector cell range. + lookup value + Set to true if the resultant vector range from is modified or not. + column index. + lookup arguments list. + lookup vector list + Returns the result value of lookup formula. + + + + Returns true Matching value found in the lookup otherwise false. + + >Contains search value + The value you want to look up. + + + + + Returns a vertical table look up value. + + Contains search value, table, return index and match properties. + Matching value found in the table. + For example, =VLOOKUP("Axles",A1:C4,2,TRUE) looks for the exact + match for Axles in A1:A4 and returns the corresponding value in B1:B4. + + + + + Returns the left so many characters in the given string. + + Contains the string and the number of characters. + A left sub string.. + + + + Returns the length of the given string. + + Contains the string. + An integer length. + + + + Returns a substring of the given string. + + Contains the original string, start position of the substring, + and the number of characters in the substring. + A substring. + + + + Returns the right so many characters in the given string. + + Contains the string and the number of characters. + A right substring. + + + + Returns True if the ParseArgumentSeparator character is included in a string. + + The string to be searched. + True or False. + + + + Returns an array of strings from an argument list. + + A delimited argument list. + Array of strings from an argument list. + + + + Returns a single character string. + + List of strings to be concatenated. + A single string. + + + + Returns the reference specified by a text string. References are immediately evaluated to display their contents. + Syntax: INDIRECT(CellRefString, [IsA1Style]) + + Cell reference string. + Cell reference. + + + + Replaces the old text with new in text based on matching. + + Text to be changed. + Text to replace. + Text to be replaced with old_text + The instance to replace + + + + + In a given string, this method substitutes an occurrence of one string with another string. + + A list of 3 or 4 arguments: the original string, the search string, the + replacement string, and optionally, an integer representing the occurrence to be replaced. + + The modified string. + + + + Returns a quoted string from a date or number. + + Value to be converted to a string. + Quoted string. + + + + Returns a number. + + A date or number string. + A number in the given string. + + + + Returns the remainder after dividing one number by another. + + Two numbers in a list. + The remainder. + + + + Truncates a number to an integer. + + Value and number of digits. + Truncated value. + + + + To Peroform arithmetic operations of range. + + + + + To Peroform SumProduct default arithmetic operations. + + values of Array + Sum of the products. + + + + Returns the sum of the products of corresponding values. + + Two cell ranges. + Sum of the products. + + + + Converts a number to text using currency format. + + Number and the number of digits. + Currency format string. + + + + Rounds a number to the specified number of decimals, formats the number + in decimal format using a period and commas, and return the result as text. + + + Number, number of digits, a flag that prevents from include + commas in the returned text. + + Formatted number as string. + + + + Returns the value at the specified index from a list of values. + + A string of the form "Index, Value1, Value2,..." in which the term 'Index' denotes the index of the value to be retrieved. + The selected value. + + + + Converts text to lowercase. + + Value to convert. + Converted string. + + + + Converts text to uppercase. + + Value to convert. + Converted string. + + + + Returns the string or text referred by the given value. + + value to find the referred text - Required + Returns the referred text + + + + Returns the column index of the passed in cell reference. + + Contains zero or one argument. If no argument is passed, returns the column index of the + location of this Column function call, otherwise returns the column index of the passed in cell reference. + The column index. + + + + Returns the row index of the passed in cell reference. + + Contains zero or one argument. If no argument is passed, returns the row index of the + location of this Row function cell, otherwise returns the row index of the passed in cell reference. + The row index. + + This method doesn't return an array of row numbers as the array formula entry is not supported in engine. It is another usecase of this library function. + + + + + Returns a number converted from the provided value. + + Value to be converted. + A number in string format or an error string. + + + + Returns the error value(#N/A). Used internally. + + empty string. + error value. + + + + Returns the error value (#N/A - value not available). + + error value. + + + + Returns a number corresponding to the predefined error values(#NULL!, #VALUE!, #REF!, #NAME?, #NUM!, #N/A, "#GETTING_DATA). Returns #N/A if not or any value enclosed within double quotes. + + + + + Removes all leading and trailing white-space characters. + + Value to trim. + + The string that remains after all leading and trailing white-space characters + were removed. + + + + + Determines whether the value is a logical value. + + Value to be tested. + True if the value is a logical value, False otherwise. + + + + Determines whether the value is the #NA error value. + + Value to be tested. + True if the value is the #NA error value, False otherwise. + + + + Returns True is the string denotes an error except #N/A. + + Value to be tested. + True if the value is an error except #N/A, false otherwise. + + + + Determines whether the value is empty string. + + Value to be tested. + True if the value is empty, False otherwise. + + + + Determines whether the value is string or not. + + Value to be tested. + True if the value is a string, false otherwise. + + + + Determines whether the value is not a string. + + Value to be tested. + True if the value is not a string, false otherwise. + + + + Returns True is the string denotes an error. + + String to be tested. + True if the value is an error. + + + + Checks whether the value is a reference or not. + + value or reference + TRUE or FALSE + + + + Returns the And of all values treated as logical values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. Each item in the list is considered True if it is nonzero + and False if it is zero. + A string holding the And of all values listed in the argument. + + + + Returns the inclusive Or of all values treated as logical values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. Each item in the list is considered True if it is nonzero + and False if it is zero. + A string holding the Or of all values listed in the argument. + + + + Flips the logical value represented by the argument. + + + The argument is + treated as a logical expression with a non-zero value considered True and a zero value considered False. + + A string holding either a single argument consisting of a + cell reference, formula, or number. + + Returns 0 if the argument evaluates to a non-zero value. Otherwise, it returns 1. + + + + Returns a range that is the offset of the reference range by rows and cols. + + reference, rows, cols, [height], [width] + A range offset. + The returned range is the range passed in through the reference variable offset + by the number of rows in the rows variable and number of columns in the cols variable. If height and + width are present in the argument list, they determine the number of rows and columns + in the returned range. Otherwise, the dimensions of the returned range match the input range. + + + + + Returns the logical value True. + + Empty string. + Logical True value string. + + + + Returns the logical value False. + + Empty string. + Logical False value string. + + + + Returns the exclusive OR of all values treated as logical values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. Each item in the list is considered True if it is nonzero + and False if it is zero. + A string holding the exclusive OR of all values listed in the argument. + + + + Returns a value you specify if a formula evaluates to #N/A + otherwise, returns the result of the formula. + + String to be tested. + Returns the computed value. + + + + Computes angle whose cosine is the argument. + + A cell reference, formula, or number. + A string holding an angle whose cosine is the argument. + + + + Returns the Arabic value of Raman numeric + + + + + + + Returns the area of the passed in cell reference range + + Contains one argument - reference + area of the passed in cell reference. + + + + Computes angle whose sine is the argument. + + A cell reference, formula, or number. + A string holding an angle whose sine is the argument. + + + + The inverse of Sinh. + + The given value. + Result of ASinh(value). + + + + Computes angle whose tangent is the argument. + + A cell reference, formula, or number. + A string holding the tangent of the argument. + + + + The ArcTangent of the x and y values. + + x_value and y_value. + Angle whose tangent is y_value/x_value. + + + + The inverse of Tanh. + + |Value| < 1. + Result of ATanh(value). + + + + Computes the smallest whole number greater than or equal to the argument. + + A cell reference, formula, or number. + A string holding the smallest whole number greater than or equal to the argument. + + + + Returns the RoundUp of the given number to the given significance + + Number, significance, mode + RoundUp number + + + + Returns the number of columns of the passed in cell reference. + + Contains one argument - reference + number of columns. + + + + The number of combinations of a given number of items. + + Number, number_items. + The number of combinations. + + + + Returns the value of ComputeCombinA + + arguments + + + + + Computes the natural logarithm of the value in the argument. + + A cell reference, formula, or number. + A string holding the natural logarithm of the value in the argument. + + + + Computes the base 10 logarithm of the value in the argument. + + A cell reference, formula, or number. + A string holding the base 10 logarithm of the value in the argument. + + + + Computes e raised to the value of the argument. + + A cell reference, formula, or number. + A string holding the e raised to the value of the argument. + + + + Returns the square root of product of given number with PI. + + Number + Sqrtpi value of given number + + + + Computes the square root of the argument. + + A cell reference, formula, or number. + A string holding the square root of the argument. + + + + Computes the absolute value of the argument. + + A cell reference, formula, or number. + A string holding the absolute value of the argument. + + + + Computes the cosine of the argument. + + A cell reference, formula, or number. + A string holding the cosine of the argument. + + + + The inverse of Cosh. + + Value >= 1. + Result of ACosh(value). + + + + Returns an evenly distributed random number >= 0 and < 1. + + Ignored. Can be empty. + + A string holding the random number. + + + + + Computes the tangent the argument. + + A cell reference, formula, or number. + A string holding the tangent of the argument. + + + + Computes the hyperbolic tangent of the argument. + + A cell reference, formula, or number. + A string holding the hyperbolic tangent of the argument. + + + + Checks if value of S mets the Criteria or Not. + + Operator + Cell + The String value to be compared + True if Value of S equals Criteria Otherwise False + + + + Checks if value of S mets the Criteria or Not. + + Operator + Cell + The double value to be compare + True if Value of S mets Criteria Otherwise returns False + + + + Sums the cells specified by some criteria. + + The criteria range, the criteria, and the sum range. + A string holding the sum. + + + + Below method used to find the row,col index when the start row or start column is -1. + + Start row of the range. + End row of the range. + Start column of the range. + End column of the range. + + + + Used to compute the value + + arguments + + + + + Returns the arccotangent of a number. + + A cell reference or number + A string containing the arccotangent of a number + + + + Returns the hyperbolic arccotangent of a number. + + A cell reference or number + A string containing the hyperbolic arccotangent of a number + + + + Returns the archyperbolic secant of an angle. + + A cell reference or a number + A string containing the archyperbolic secant of an angle + + + + Retuns the number into text for the given radix base + + + + + + + Computes the hyperbolic cosine of the argument. + + A cell reference, formula, or number. + A string holding the hyperbolic cosine of the argument. + + + + Returns the hyperbolic cosine of a number. + + A cell reference or a number + A string containing the hyperbolic cosine of a number + + + + Returns the cotangent of an angle. + + A cell reference or a number + A string containing the cotangent of an angle + + + + Returns the cosecant of an angle + + a cell reference or number + A string containing the cosecant of an angle + + + + Returns the hyperbolic cosecant of an angle. + + + A string containing the hyperbolic cosecant of an angle + + + + Returns the decimal number of the given text to the given base. + + text,base + Decimal number. + + + + Converts radians into degrees. + + Value in radians. + Degrees for the given radians. + + + + Rounds up to larger in magnitude even number. + + Number to be rounded. + Rounded even value. + + + + Factorial of a given number. + + The given value, x. + Factorial of x. + + + + Returns the Double factorial value for given number. + + number to find FactDouble + FactDouble of given number. + + + + Computes the largest whole number less than or equal to the argument. + + A cell reference, formula, or number. + A string holding the largest whole number less than or equal to the argument. + + + + Returns the Calculated Floor value for the given Input. + + + + + + Return the value of ComputeFormulaText + + arguments + + + + + Returns the largest integer that divide the given numbers without any reminders. + + number1,number2,... + Returns the GCD value of given arguments + + + + Create a shortcut for the link / path + + link,name + shortcut name + + + + Returns the integer value. + + Number to be truncated. + An integer. + + + + Determines whether the value is even or not. + + Value to be tested. + True, if the value is even, false otherwise. + + + + Determines whether the string contains a number or not. + + String to be tested. + True if the string is a number. + + + + Determines whether the value is odd or not. + + Value to be tested. + True, if the value is odd, false otherwise. + + + + returns the smallest positive integer that is a multiple of all given values. + + Number1,Number2,... + The LCM value of given aruments + + + + Computes the natural logarithm of the value in the argument. + + A cell reference, formula, or number. + A string holding the natural logarithm of the value in the argument. + + + + Returns the number of columns of the passed in cell reference. + + Contains one argument - reference + number of columns. + + + + Returns the Inverse of Matrix. + + Matrix + Inverse matrix + + + + Returns the number of columns of the passed in cell reference. + + Contains one argument - reference + number of columns. + + + + Returns the number of columns of the passed in cell reference. + + Contains one argument - reference + number of columns. + + + + Determines the number rounded to the given multiple. + + Number, Multible both are required + Mround value of given number + + + + Determines the Multinominal value of given range of numbers. + + Given numbers + Multinominal value of given range of numbers. + + + + Returns the number of columns of the passed in cell reference. + + Contains one argument - reference + number of columns. + + + + Rounds up to larger in magnitude odd number. + + Number to be rounded. + Rounded odd value. + + + + Returns the number pi. + + Ignored. Can be empty. + A string holding the number pi. + + + + Returns a specified number raised to the specified power. + + String containing two parameters separated by commas: + the first being base number, + the second being the exponent. + A string holding the value of the base number raised to the exponent. + + + + Returns the product of the arguments in the list. + + List of arguments. + Product of the arguments. + + + + Returns the integer portion of division function. + + numerator, denominator to find the quotient + returns integer value. + + + + Converts degrees into radians. + + Value in degrees. + Radians for the given degrees. + + + + Returns the arabic numeral to roman in TEXT format + + Number, Form for style of roman text. + 0 or omitted Classic. + 1 More concise. + 2 More concise. + 3 More concise. + 4 Simplified. + TRUE Classic. + FALSE Simplified. + + Retuns the Roman string of given numeric value based on the style form + + + + Rounds a number to a specified number of digits. + + Number and number of digits. + Rounded number. + + + + Rounds a number to a specified number of digits. + + Number and number of digits. + Rounded number. + + + + Rounds a number to a specified number of digits. + + Number and number of digits. + Rounded number. + + + + Returns the number of rows of the passed in cell reference. + + Contains one argument. + number of rows. + + + + Returns the secant of an angle. + + A cell reference, or number. + A string conaining the secant of an angle + + + + Returns the hyperbolic secant of an angle. + + A cell reference, or number + A string containing the hyperbolic secant of an angle. + + + + return the sheet number of the given value + + SheetName or cell or named range + sheet number + + + + return the sheet number of the given values + + SheetName or cell or named range + sheet number + + + + Returns a number indicating the sign of the argument. + + A cell reference, formula, or number. + A string holding a number representing the sign of the argument. + + + + Computes the sine of the argument. + + A cell reference, formula, or number. + A string holding the sine of the argument. + + + + Computes the hyperbolic sine of the argument. + + A cell reference, formula, or number. + A string holding the hyperbolic sine of the argument. + + + + Returns the sum of all values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the sum of all values listed in the argument. + + + + Returns the sum of all the cells in a range which is statisfy the given multible criteria + + range of cells, criteria1, average_range1,... + returns the sum value of the cells. + + + + Returns the sum of the square of all values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the sum of the squares of all values listed in the argument. + + + + Returns the sum of the differences of squares of the two ranges. + + x_range and y_range. + A string holding sum of the differences of squares. + + + + Returns the sum of the sums of squares of the two ranges. + + x_range and y_range. + A string holding sum of the sums of squares. + + + + Returns the sum of the squares of the differences between two ranges. + + x_range and y_range. + A string holding sum of the squares of the differences. + + + + Returns the vertical range of cells as a horizontal range, or vice versa + + Cell refrences + value + + + + Returns the value of computeTruncate + + arguments + + + + + Returns a random integer number between the specified two numbers. + + StartNumber, EndNumber + Random numberbetween two value + + + + Return the value of ComputeSeriessum + + arguments + + + + + Searches a range or an array, and then returns the item corresponding to the first match it finds. + If no match exists, then XLOOKUP can return the closest (approximate) match. + + + A string containing the arguments separated by commas. + The format should be: "lookup_value, lookup_array, return_array, if_not_found, match_mode, search_mode". + + lookup_value: The value to search for. + lookup_array: The array or range of cells to search within. + return_array: The array or range of cells from which to return a value. + if_not_found: The value to return if no match is found. + + match_mode: [Optional] The match type (default is 0): + + 0 for exact match (default) + -1 for exact match or next smaller item + 1 for exact match or next larger item + 2 for wildcard match + + + + search_mode: [Optional] The search mode (default is 1): + + 1 for search from first to last (default) + -1 for search from last to first + 2 for binary search ascending + -2 for binary search descending + + + + + The item corresponding to the first match it finds. If no match exists, then XLOOKUP can return the closest (approximate) match. + + + + Calculate and retrun the matched value based on match mode and search mode + + The value to search + The range or array where to search. + The range or array from which to return values. + The value to return if no match is found. If omitted, an #N/A error is returned. + The match type to perform: + The direction of search + The matched value + + + + + Returns the range of cells as an array by scanning column wise + + cell range + array of cells + + + + Convert multi criteria lookup range to single range + + multicriteria lookup range + return calculated lookup range + + + + Match the lookup value and return the index based on match mode + + the matched index + + + + Calculate and get the matchMode value from the argument + + argument + the matchMode value + + + + Calculate and get the SearchMode value from the argument + + argument + the SearchMode value + + + + Validate argument type for the possible cases for error string + + argument + >The formula's argument typ + + + + + Returns the relative position of an item in an array or range of cells. + + + A string containing the arguments separated by commas. + The format should be: "lookup_value,lookup_array,match_mode,search_mode". + + lookup_value: The value to search for. + lookup_array: The array or range of cells to search within, provided as a comma-separated string of values. + + match_mode: [Optional] The match type (default is 0): + + 0 for exact match (default) + -1 for exact match or next smallest item + 1 for exact match or next largest item + 2 for wildcard match + + + + search_mode: [Optional] The search mode (default is 1): + + 1 for search from first to last (default) + -1 for search from last to first + 2 for binary search ascending + -2 for binary search descending + + + + + The relative position of an item in an array or range of cells. + + + + + Sort the lookup array in DescendingOrder + + the array in DescendingOrder + + + + Sort the lookup array in AscendingOrder + + the array in AscendingOrder + + + + Match the lookup value and return the index based on match mode + + the matched index + + + + check and match the lookup value when its contains "?" + + TTrue when match or false + + + + Rounds a number down to the nearest integer or to the nearest multiple of significance. + + + A string containing the arguments separated by commas. + The format should be: "number, significance, mode". + + + number: The number to be rounded down. + + + significance: [optional] The multiple to which you want to round. + + + mode: [optional] The direction (toward or away from 0) to round negative numbers. + + + + A number rounded down to the nearest integer or to the nearest multiple of significance. + + + + Validate and retrun the argument as double value. + + + + + Calculate array format argument value. + + + Return calculated array format argument value for interior and direct FloorMath formula + + + + convert string values(number,sign,mode) to double value + + + + + convert string values(number,sign) to double value + + + + + Calculated FloorMath value for the given Input. + + Return round a number down to the nearest integer or to the nearest multiple of significance. + + + + Computes and returns a number that is rounded down to the nearest integer or to the nearest multiple of significance. + + + A string containing the arguments separated by commas. + The format should be: "number, significance". + + + number: The value to be rounded. + + + significance: [optional] The multiple to which the number is to be rounded. + + + + A number that is rounded down to the nearest integer or to the nearest multiple of significance. Regardless of the sign of the number, the number is rounded down. However, if the number or the significance is zero, zero is returned. + + + + Returns the Calculated FloorPrecise value for the given Input. + + + + + Returns the Calculated CeilingPrecise value for the given Input. + + + + + Calculate array format argument value. + + + Return calculated array format argument value for interior and direct FloorPrecise formula. + + + + Calculate array format argument value. + + + calculated array format argument value for interior and direct IsoCeiling formula. + + + + Calculate array format argument value. + + + calculated array format argument value for interior and direct CeilingPrecise formula. + + + + Computes and returns a number that is rounded up to the nearest integer or to the nearest multiple of significance. + + + A string containing the arguments separated by commas. + The format should be: "number, significance". + + + number: The value to be rounded. + + + significance: [optional] The multiple to which the number is to be rounded. The default value is 1. + + + + A number that is rounded up to the nearest integer or to the nearest multiple of significance. Regardless of the sign of the number, the number is rounded up. However, if the number or the significance is zero, zero is returned. This follows the ISO 8601 standard. + + + + Computes and returns a number that is rounded up to the nearest integer or to the nearest multiple of significance. + + + A string containing the arguments separated by commas. + The format should be: "number, significance". + + + number: The value to be rounded. + + + significance: [optional] The multiple to which the number is to be rounded. The default value is 1. + + + + A number that is rounded up to the nearest integer or to the nearest multiple of significance. Regardless of the sign of the number, the number is rounded up. However, if the number or the significance is zero, zero is returned. + + + + This function appends arrays vertically and in sequence to return a larger array. + + + A string containing the arguments separated by commas. + The format should be: "array1,[array2],..." + + array1, array2, ...: The arrays to append. + + + A single array that has as many columns as all of the source arrays combined and as many rows as the tallest of the source arrays. + + + + This function appends arrays horizontally and in sequence to return a larger array. + + + A string containing the arguments separated by commas. + The format should be: "array1,[array2],..." + + array1, array2, ...: The arrays to append. + + + A single array that has as many columns as all of the source arrays combined and as many rows as the tallest of the source arrays. + + + + Validate the argument for VStack and HStack formula and return array list. + + + + + Compute and return appended array as string value for VStack and HStack formula. + + + + + Compute and append array vertically and return array as string value. + + + + + Compute and append array horizontally and return array as string value. + + + + + This function computes and returns the value of the density function for a standard normal distribution. + + A string representing the numeric input for which PHI is to be calculated. + + A formatted string representing the calculated PHI value. + If the input is invalid, an error message is returned indicating the type of error. + + + + + This function converts a specified monetary amount from one currency to another using predefined Euro conversion rates. + The Euro is used as an intermediary currency for conversions between non-Euro currencies. + + + A comma-separated string containing the input arguments in the format: + "amount, sourceCurrency, targetCurrency, [fullPrecision], [triangulationPrecision]". + + + + amount: The numeric value to be converted. + This value must be a valid floating-point number. + + + + + sourceCurrency: The three-character ISO currency code for the source currency. + This must represent a valid currency included in the predefined Euro conversion table. + + + + + targetCurrency: The three-character ISO currency code for the target currency. + This must represent a valid currency included in the predefined Euro conversion table. + + + + + fullPrecision (optional): A boolean value indicating whether the result should use full precision. + If omitted, the default value is false, meaning the result will be rounded. + + + + + triangulationPrecision (optional): An integer specifying the precision for intermediate Euro calculations. + If omitted, the default value is 3. Values less than 3 are invalid. + + + + + + A string representing the converted amount in the target currency. If the input parameters are invalid, an error message is returned. + + + + + Converts a given monetary amount from one currency to another using predefined Euro conversion rates. + + + The converted monetary amount as double value. + If the conversion is invalid (e.g., unsupported currency codes), the method returns double.NaN. + + + + + Returns the sample covariance between two arrays. + Arrays should be of equal length, and contain more than one element. + + + + + + + Returns the mean of an array. + + Array of data for which we are calculating the mean. + + + + Returns the mean of an array. + + Array of data for which we are calculating the mean. For time series, the last element (index = n-1), is the most recent. + In most applications, the decay factor is between 0 and 1. Weigth on the last element in array is 1.0, the 2nd to last element d, 3rd to last d^2, ... + + + + Returns the inverse of the sum of a geometric series of length n, who's first element is 1. + For decay factor d, S = 1 + d + d^2 + ... + d^(n-1). Return 1/S. + + Decay factor Typically between -1 adn +1. + Number of elements in the geometric series, must be positive. + + + + + Calculates the natural logarithm of gamma function. + + + + + + + Returns the average deviation of all values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the average deviation of all values listed in the argument. + + + + Returns the simple average of all values (including text) listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the simple average of all values listed in the argument. + + + + Returns the average of all the cells in a range which is statisfy the given multible criteria + + range of cells, criteria1, average_range1,... + returns the average value of the cells. + + + + Below method used to find the criteria value which is combined with tokens. + + Criteria value with tokens. + Tokens + The criteria value splited from tokens. + + + + Below method used to find whether the criteria is matched with the Tokens "=",">",">=" or not. + + CellRange + Tokens("=",">",">=") + The criteria used to determine which cells to add. + true criteria match or false. + + + + Returns the chi-squared distribution. + + x, degrees of freedom. + The chi-squared distribution. + + + + Returns the growth estimate using the exponential curve y = b * m^x that best fits the given points. Only the first two Excel parameters are used. + + Y_range, x_range. + returns estimated value. + + + + Returns the m and b value used in exponential curve y = b * m^x. + + The set of y-values required in y = b*m^x + The set of x-values in y = b*m^x + output of b + output of m + returns calculated b value. + + + + Returns the natural logarithm of the gamma function. + + The value to be evaluated. + The natural logarithm of the gamma function. + + + + Calculates the statistics for a straight line that explains the relationship between the independent variable and one or more dependent variables + + Parsed range. + an array describing the line. The function uses the least squares method to find the best fit for your data. + + + + Returns the inverse of the chi-squared distribution. + + x, degrees of freedom. + The inverse of the chi-squared distribution. + + + + Returns the Chi Test for independence. + + Actual_range, expected_range. + Result of Chi Test: y-intercept. + + + + Returns the normal distribution. + + x, mean, standarddev, cumulative. + The normal distribution. + + Cumulative should be either + True if you want to return the value of the distribution function or False + if you want to return the value of the density function. The distribution value + is computed interactively using Trapezoidal Rule to six to seven significant digits + or 20 iteration maximum. + + + + + Returns the standard normal cumulative distribution function. The distribution has a mean of 0 (zero) and a standard deviation of one. + Syntax: NORMSDIST(z) + + Z is the value for which you want the distribution. + Standard normal cumulative distribution. + + + + Returns the inverse of normal distribution. + + P, mean, standard deviation. + Returns x such that normal distribution at x is p. + + P should be between 0 and 1. + + + + + Enabled only when ExcelLikeComputations property is set to true. + + + Computes the inverse normal cumulative distribution for the given probability. + + probability + a double value. + + + + Returns the inverse of the standard normal cumulative distribution. The distribution has a mean of zero and a standard deviation of one. + Syntax: NORMSINV(p) + + p is a probability corresponding to the normal distribution. + Inverse of standard normal cumulative distribution. + + p should be between 0 and 1. + + + + + Returns a confidence interval radius. + + Alpha, standard deviation, size. + Returns x such that normal distribution at x is p. + + P should be between 0 and 1. + + + + + Returns the correlation coefficient of the two sets of points. + + range1, range2. + Correlation coefficient. + + + + Returns the count of all values (including text) listed in the argument to + evaluate to a number. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the count of all numerical values listed in the argument. + + + + Returns the count of all values (including text) listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the count of all values listed in the argument. + + + + Returns the count of blank cells listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the count of blank cells listed in the argument. + + + + Counts the cells specified by some criteria. + + The criteria range, the criteria. + Number of cells meeting the criteria. + + + + Calculates the CountIF and CountIFS formula + + The criteria range, the criteria + If true, calculate CountIF formula. Else calculate CountIFS formula. + Number of cells meeting the criteria. + + + + Returns the covariance between the two sets of points. + + range1, range2. + The covariance. + + + + Returns the smallest value for which the cumulative binomial distribution is greater than or equal to a criterion value. + + Number of trials, probability, alpha. + Returns the critical value. + + + + Returns the exponential distribution. + + x, lambda, cumulative. + The exponential distribution. + + Cumulative should be either + True if you want to return the value of the distribution function or False + if you want to return the value of the density function. + + + + + Returns the F (Fisher) probability distribution. + + x, degreesfreedom1, degreesfreedom2. + Returns the F probability distribution. + + + + Returns the inverse of F distribution. + + p, degreesfreedom1, degreesfreedom2. + Returns x such that F distribution at x is p. + + P should be between 0 and 1. + + + + + Returns the Fisher transformation of the input variable. + + Input variable x. + Fisher transformation of x. + + X should be between -1 and 1. + + + + + Returns the inverse of Fisher transformation. + + Input variable y. + The value x such that the Fisher transformation y is x. + + + + Returns a forecasted value based on two sets of points using least square fit regression. + + x, rangex, rangey. + Forecasted value. + + + + Returns the kurtosis of the passed in values. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + The kurtosis of the data. + + + + Returns the Kth largest value in the range. + + range, k. + Kth largest value. + + + + Returns the lognormal distribution. + + x, mean, standarddev. + The lognormal distribution. + + + + Returns the inverse of the lognormal distribution. + + p, mean, standarddev. + Returns the value x where the lognormal distribution of x is p. + + + + Returns the maximum value of all values listed in the argument including logical values. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the maximum value of all values listed in the argument. + True is treated as 1; False is treated as 0. + + + + + Returns the median value in the range. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + Median value. + + + + Returns the minimum value of all values listed in the argument including logical values. + + A string holding a list (separated by commas) of: + cell references, + formulas, or numbers. + A string holding the minimum value of all values listed in the argument. + True is treated as 1; False is treated as 0. + + + + + Returns the most frequent value in the range. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + The most frequent value. + + + + Returns the negative binomial distribution. + + Number of failures, success threshold, probability, cumulative. + The negative binomial distribution. + + + + Returns the Pearson product moment correlation coefficient. + + Range1, range2. + Pearson product. + + + + Returns the percentile position in the range. + + Range, k. + Percentile position. + K is a value between 0 and 1. + + + + Returns the percentile position in the ranges. + This method used only for contional formatting to calculate the percentile value. + When the argument contains more no of cell reference. + + Ranges, k. + Percentile position. + K is a value between 0 and 1. + + + + Returns the percentage rank in the range. + + Range, x, significant digits. + Percentile position. + Significant digits are optional, defaulting to 3. + + + + The number of permutations of n items taken k at the time. + + n, k + The number of combinations. + + + + Returns the Poisson distribution. + + x, mean, cumulative + Returns the exponential distribution. + + Cumulative should be either + True if you want to return the value of the distribution function or False + if you want to return the value of the density function. + + + + + Returns the probability that a value in the given range occurs. + + xrange1, prange2, lowerbound, upperbound. + The probability. + + + + Returns the quartile position in the range. + + Range, q. + Percentile position. + Q is 0, 1, 2, 3, 4. + + + + Returns the rank of x in the range. + + X, range, order. + Rank of x. + + + + Returns the square of the Pearson product moment correlation coefficient. + + Range1, range2. + Square of the Pearson product. + + + + Returns the skewness of a distribution. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + Skewness of a distribution. + + + + Returns the slope of the least square fit line through the given points. + + Y_range, x_range. + Y-intercept for the given points. + + + + Returns the kth smallest value in the range. + + Range, k. + Kth smallest value. + + + + Returns a normalized value. + + X, mean, stddev. + Normalized value. + + + + Returns the sample standard deviation. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + The sample standard deviation. + + + + Returns the sample standard deviation. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + The sample standard deviation. + Treats True as 1; False as 0. + + + + + Returns the sample standard deviation. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + The sample standard deviation. + Treats True as 1; False as 0. + + + + + Returns the population standard deviation. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + The population standard deviation. + + + + Returns the population standard deviation. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + The population standard deviation. + Treats True as 1; False as 0. + + + + + Returns the standard error of the least square fit line through the given points. + + Y_range, x_range. + Standard error. + + + + Returns the mean of the range after removing points on either extreme. + + Range, percent. + Kth smallest value. + + + + Returns sample variance of the listed values. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + The sample variance. + + + + Returns sample variance of the listed values. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + The sample variance. + True is treated as 1; False is treated as 0. + + + + + Returns population variance of the listed values. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + The population variance. + + + + Returns population variance of the listed values. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + The population variance. + True is treated as 1; False is treated as 0. + + + + + Returns the Weibull distribution. + + X, alpha, beta, cumulative. + The Weibull distribution. + + + + Returns the one-tailed probability value of a Z test. + + Range, mu, sigma. + Kth smallest value. + + + + Calculate muti range and return cell value + + contains multi cell range(eg:A1:A100) + + + + Returns the maximum value of all values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the maximum value of all values listed in the argument. + + + + Returns the subtotal of input range(s). + + A list of cell references(seperated by commas) + Subtotal of range(s) + + + + Returns the minimum value of all values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the minimum value of all values listed in the argument. + + + + Returns the simple average of all values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the simple average of all values listed in the argument. + + + + Returns the harmonic mean of all values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + The harmonic mean all values listed in the argument. + + + + Returns the hypergeometric distribution. + + Number of sample successes, number of sample, number of population successes, number of population. + Returns the gamma distribution. + + + + Returns the hypergeometric distribution. + + Number of sample successes, number of sample, number of population successes, number of population. + Returns the gamma distribution. + + + + Conditionally computes one of two alternatives depending upon a logical expression. + + + The first argument is + treated as a logical expression with a non-zero value considered True and a zero value considered False. + The value of only one of the alternatives is computed depending upon the logical expression. + + A string holding a list of three arguments. + + Returns a string holding the second argument if the first argument is True (non-zero). Otherwise, it returns a string holding the third argument. + + + + Returns a value you specify if a formula evaluates to an error + otherwise, returns the result of the formula. + + String to be tested. + Retuns the error string + + + + Returns the y-intercept of the least square fit line through the given points. + + y_range, x_range. + y-intercept for the given points. + + + + Returns the binomial distribution. + + Number of successes, number of trials, probability, cumulative. + The binomial distribution. + + + + Returns the skewness of a distribution based on a population a characterization of the degree of asymmetry of a distribution around its mean. + + numbers or names, arrays, or reference that contain numbers + Skewness of a distribution. + + + + Returns population covariance, the average of the products of deviations for each data point pair in two data sets. + + range1, range2. + The covarianceP + + + + Returns the sample covariance, the average of the products of deviations for each data point pair in two data sets. + + range1, range2. + The covariances + + + + Returns the percentile position in the range. + + Range, k. + Percentile position. + K is a value between 0 and 1. + + + + Returns the percentage rank Exc in the range. + + Range, x, significant digits. + Percentile position. + Significant digits are optional, defaulting to 3. + + + + Returns the percentile position in the range. + + Range, k. + Percentile position. + K is a value between 0 and 1. + + + + Returns the percentage rank Inc in the range. + + Range, x, significant digits. + Percentile position. + Significant digits are optional, defaulting to 3. + + + + Returns the sample standard deviation. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + The sample standard deviation. + Treats True as 1; False as 0. + + + + + Returns sample variance of the listed values. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + The sample variance. + + + + Calculates variance based on the entire population (ignores logical values and text in the population). + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + The sample variance. + + + + Returns the number of permutations for a given number of objects (with repetitions) that can be selected from the total objects. + + n, k + The number of combinations. + + + + Returns the normal distribution for the specified mean and standard deviation. + + x, mean, standarddev, cumulative. + The normal distribution. + + Cumulative should be either + True if you want to return the value of the distribution function or False + if you want to return the value of the density function. + + + + + Returns the inverse of the normal cumulative distribution for the specified mean and standard deviation. + + P, mean, standard deviation. + Returns x such that normal distribution at x is p. + + P should be between 0 and 1. + + + + + Returns the standard normal cumulative distribution function. The distribution has a mean of 0 (zero) and a standard deviation of one. + Syntax: NORMSDIST(z) + + Z is the value for which you want the distribution. + Standard normal cumulative distribution. + + + + Returns the PDF of the standard normal distribution. + + Value at which the distribution is evaluated. + + + + Returns the CDF of the standard normal distribution. + + Value at which the distribution is evaluated. + + + + Returns the PDF of the standard normal distribution. + + Value at which the distribution is evaluated. + + + + Returns the CDF of the standard normal distribution. + + Value at which the distribution is evaluated. + + + + Returns the inverse of the CDF of the standard normal distribution. + + Cumulative probability of the distribution. p is between 0 and 1. + + + + Returns the inverse of the standard normal cumulative distribution. The distribution has a mean of zero and a standard deviation of one. + Syntax: NORMSINV(p) + + p is a probability corresponding to the normal distribution. + Inverse of standard normal cumulative distribution. + + p should be between 0 and 1. + + + + + Calculates the Weibull Probability Density Function or the Weibull Cumulative Distribution Function for a supplied set of parameters. + + x, alpha, beta, cumulative. + Returns the calculated weibull distribution. + + cumulative = A logical argument which denotes the type of distribution to be used + TRUE = Weibull Cumulative Distribution Function + FALSE = Weibull Probability Density Function + + + + + Returns the exponential distribution. + + x, lambda, cumulative. + The exponential distribution. + + Cumulative should be either + True if you want to return the value of the distribution function or False + if you want to return the value of the density function. + + + + + Used to calculate the inverse of gamma cummulative distribution + + + + + + + + + Used to calculate the inverse gamma distribution at inital stage. + + + + + + + + + + + + + + Used to calculate the inverse gamma distribution at middle stage. + + + + + + + + + + + + + + Used to calculate the inverse gamma distribution at final stage. + + + + + + + + + + + + + + Used to calculate the upper incomplete integral of inverse gamma function. + + + + + + + + Used to calculate the lower incomplete integral of gamma function. + + + + + + + + Used to calculate the upper incomplete integral of gamma function. + + + + + + + + Used to calculate the CDF(Cummulative Distribution Function) of Gamma distribution. + + Alpha + Beta + + + + + + Used to calculate the PDF(Probability Distribution Function) of Gamma distribution. + + Alpha + Beta + + + + + + Returns the gamma distribution. + + X, alpha, beta, cumulative. + The gamma distribution. + + X, alpha, and beta should be positive real numbers. Cumulative should be either + True if you want to return the value of the distribution function or False + if you want to return the value of the density function. The distribution value + is computed interactively using Trapezoidal Rule to six to seven significant digits + or 20 iteration maximum. + + + + + Returns the inverse of gamma distribution. + + p, alpha, beta + Returns x such that gamma distribution at x is p. + + P, alpha, and beta should be positive real numbers, with p between 0 and 1. + + + + + Returns the geometric mean of all values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + The geometric mean all values listed in the argument. + + + + Returns the gamma distribution. + + X, alpha, beta, cumulative. + The gamma distribution. + + X, alpha, and beta should be positive real numbers. Cumulative should be either + True if you want to return the value of the distribution function or False + if you want to return the value of the density function. The distribution value + is computed interactively using Trapezoidal Rule to six to seven significant digits + or 20 iteration maximum. + + + + + Returns the inverse of gamma distribution. + + p, alpha, beta + Returns x such that gamma distribution at x is p. + + P, alpha, and beta should be positive real numbers, with p between 0 and 1. + + + + + Returns the natural logarithm of the gamma function. + + The value to be evaluated. + The natural logarithm of the gamma function. + + + + Returns the Student's t-distribution. + + x, degreesfreedom1. + Returns the Student's t-distribution. + + + + Returns the inverse of the CDF of the Student's t distribution. + For k = 3, and 5+ the solution is an approximation. + + Cumulative probability of the distribution. p is between 0 and 1. + Degrees of freedom. + + + + Returns the PDF of Student's t distribution. + + Value at which the distribution is evaluated. + Degrees of freedom. + + + + Returns the CDF of Student's t distribution. + + Value at which the distribution is evaluated. + Degrees of freedom. + + + + Returns the inverse of F distribution. + + p, degreesfreedom1, degreesfreedom2. + Returns x such that F distribution at x is p. + + P should be between 0 and 1. + + + + + Returns the smallest value for which the cumulative binomial distribution is greater than or equal to a criterion value. + + Number of trials, probability, alpha. + Returns the critical value. + + + + Returns the inverse of the lognormal distribution. + + p, mean, standarddev. + Returns the value x where the lognormal distribution of x is p. + + + + Returns the lognormal distribution. + + x, mean, standarddev. + The lognormal distribution. + + + + Returns a confidence interval radius. + + Alpha, standard deviation, size. + Returns x such that normal distribution at x is p. + + P should be between 0 and 1. + + + + + Returns the chi-squared distribution. + + x, degrees of freedom. + The chi-squared distribution. + + + + Returns the F probability distribution. + + x, degreesfreedom1, degreesfreedom2. + Returns the F probability distribution. + + + + Returns the PDF of the F distribution. + + Value at which the distribution is evaluated. + Degrees of freedom for numerator chi-sqared distribution. k1 > 0. + Degrees of freedom for denominator chi-sqared distribution. k2 > 0. + + + + Returns the CDF of the F distribution. + + Value at which the distribution is evaluated. + Degrees of freedom for numerator chi-sqared distribution. + Degrees of freedom for denominator chi-sqared distribution. + + + + Euler integral. + + + + + Integral from 0 to infinity of e^(-t) * t^(z-1) dt + + If z > 143 the return value will exceed the double.MaxValue. The function will throw an exception. + + + + To get the CDF of the beta distribution. + + + + + + + + Euler integral. + + + + + Returns the F (Fisher) probability distribution. + + x, degreesfreedom1, degreesfreedom2. + Returns the F probability distribution. + + + + Returns the chi-squared distribution. + + x, degrees of freedom. + The chi-squared distribution. + + + + Returns the inverse of the chi-squared distribution. + + x, degrees of freedom. + The inverse of the chi-squared distribution. + + + + Returns the Chi Test for independence. + + Actual_range, expected_range. + Result of Chi Test: y-intercept. + + + + Returns the inverse of the chi-squared distribution. + + x, degrees of freedom. + The inverse of the chi-squared distribution. + + + + Returns the binomial distribution. + + Number of successes, number of trials, probability, cumulative. + The binomial distribution. + + + + Returns the one-tailed probability value of a Z test. + + Range, mu, sigma. + Kth smallest value. + + + + Returns the rank of x in the range. + + X, range, order. + Rank of x. + + + + Returns the rank of x in the range. + + X, range, order. + Rank of x. + + + + The Irwin-Hall distribution results from the sum on n independent standard uniform variables + + The value at which to evaluate the distribution. + + + + The Irwin-Hall distribution results from the sum on n independent standard uniform variables + + The value at which to evaluate the distribution. + The number of standard uniform variables. + + + + Returns the number of possible combinations of k objects from a set of n object. The order of the chosen objects does not matter. + + Number of objects + Number of objects chosen + + + + Returns n! + 0! = 1,otherwise n! = n * (n-1) * (n-2) * ... * 2 * 1, + + + + + Returns the PDF of the uniform distribution. + + Number of successes, number of trials, probability, cumulative. + The binomial distribution. + + + + Returns the PDF of the uniform distribution. + + Value at which the distribution is evaluated. + Minimum value of the distribution. + Maximum value of the distribution. + + + + Returns the quartile position in the range. + + Range, q. + Percentile position. + Q is 0, 1, 2, 3, 4. + + + + Returns the quartile position in the range. + + Range, q. + Percentile position. + Q is 0, 1, 2, 3, 4. + + + + Returns the negative binomial distribution. + + Number of failures, success threshold, probability, cumulative. + The negative binomial distribution. + + + + Returns the Poisson distribution. + + x, mean, cumulative + Returns the exponential distribution. + + Cumulative should be either + True if you want to return the value of the distribution function or False + if you want to return the value of the density function. + + + + + Compares the given two values + + Two Numbers to be compared. + Returns the result of the comparision in the form of 0 or 1 + + + + Compares the given two values + + Two Numbers to be compared. + Returns the result of the comparision in the form of 0 or 1 + + + + Returns the sum of the squares of the mean deviations. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + Sum of the squares of the mean deviation. + + + + Returns the average of all the cells in a range which is statisfy the given single criteria + + range of cells, criteria, average_range + returns the average value of the cells. + + + + Return the value of ComputeConfidenceT + + arguments + + + + + Returns the inverse of F distribution. + + p, degreesfreedom1, degreesfreedom2. + Returns x such that F distribution at x is p. + + P should be between 0 and 1. + This method is deprecated. Please use the instead. + + + + + Returns the inverse of the CDF of the F distribution. + For k = 3, and 5+ the solution is an approximation. + + Cumulative probability of the distribution. p is between 0 and 1. + Degrees of freedom for numerator chi-sqared distribution. + Degrees of freedom for denominator chi-sqared distribution. + + + + Returns the inverse of the CDF of the normal distribution. + + Cumulative probability of the distribution. 0 <= p >= 1. + Mean of the distribution. + Standard deviation of the distribution. + + + + Returns a vertical array of the most frequently occurring, or repetitive values in an array or range of data. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + The most frequent value. + + + + Returns the most frequent value in the range. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + The most frequent value. + + + + Returns the Student's t-distribution. + + x, degreesfreedom1. + Returns the Student's t-distribution. + + + + Returns the beta distribution. + + x, degreesfreedom1, degreesfreedom2. + Returns the beta distribution. + + + + Returns the Beta cumulative density function. + + Value of the random variable for which the CDF is beign evaluated. x is between 0 and 1. + First shape parameter. + Second shape parameter. + + + + + Returns the Beta probability density function. + + Value of the random variable for which the PDF is beign evaluated. x is between 0 and 1. + Number of trials. + Number of times the event occurs in n trials. + + + + + Calculates the standard normal cumulative distribution function (Gauss) for a given z-value. + This function returns the probability that a value from a standard normal distribution (with a mean of 0 and a standard deviation of 1) is less than or equal to the given z-value. + + + A string containing the arguments separated by commas. The format should be: + "z" + + z: The z-value for which you want to compute the cumulative distribution. + + + + The probability that a value from a standard normal distribution is less than or equal to the given z-value. + + + The Gauss function is used in statistics to determine the likelihood of a value falling within a specific range of a normal distribution. + This can be particularly useful in hypothesis testing or probability estimation scenarios. + + + + + Computes the gamma function for the specified input. + + A string representing the input number for which the gamma function will be calculated. + A string representing the result of the gamma function calculation. + + The gamma function is an extension of the factorial function to real and complex numbers. + + + + + Calculate and return the gamma function value. + + + + + Computes the sample variance for a set of numbers. + + + A string containing a comma-separated list of numbers for which the sample variance will be calculated. + + + A string representing the sample variance of the provided numbers. + + + The sample variance is a measure of the dispersion of data points in a sample, and is calculated by taking the average of the squared deviations from the mean. + + + + + This function calculates how often values occur within a range of values, and then returns a vertical array of numbers. + + + A string containing two arguments separated by a comma. the format should be: data_array, bins_array. + + data_array: The range or array of data values you want to count. + bins_array: The range or array of intervals to group the data values into. + + + + A formatted string with the frequency counts separated by semicolons, or an error message if the input is invalid. + + + + + Calculates the frequency counts of numeric and date values from the provided source and bin arrays. + Text and blank values are ignored during processing. + + An array of strings representing the source and bin data ranges. + A string representing the frequency counts separated by semicolons. + + + + This function computes the probability of a specific outcome or a range of outcomes in a binomial distribution. + + + A comma-separated string containing the input arguments in the format: + "trials, probability_s, number_s, [number_s2]". + + + + trials: The number of independent trials. + This value must be a non-negative integer. (e.g., 0, 1, 2, ...). + + + + + probability_s: The probability of success for each trial, represented as a decimal value. + This value must be a number between 0 and 1 (inclusive). + + + + + number_s: The specific number of successes for which to calculate the probability. + This must be an integer between 0 and trials. + + + + + number_s2 (optional): The upper limit for a range of successes. + If provided, the function calculates the probability for successes between number_s and number_s2 (inclusive). + This value must be an integer greater than or equal to number_s and less than or equal to trials. + + + + + + A string representing the calculated probability for the specified number of successes or success range in the binomial distribution. + If the input parameters are invalid, an error message is returned. + + + + + This function calculates the cumulative Beta probability density function, which evaluates proportions or probabilities over a specified range. + + + A comma-separated string containing the input arguments in the format: "x, alpha, beta, [A], [B]". + + + x: The value at which to evaluate the Beta distribution. Must lie within the interval [A, B]. If A and B are omitted, the default range is [0, 1]. + + + alpha: A positive shape parameter of the Beta distribution, determining its skewness. + + + beta: A positive shape parameter of the Beta distribution, determining its skewness. + + + A: (Optional) The lower bound of the interval. Defaults to 0 if omitted. + + + B: (Optional) The upper bound of the interval. Defaults to 1 if omitted. + + + + + A string representing the calculated cumulative Beta probability density function at the specified value x. Returns an error message if the input arguments are invalid or if x is outside the interval [A, B]. + + + + + This function calculates and returns the t-value corresponding to the given two-tailed probability for the Student's t-distribution. It is commonly used to find critical t-values in hypothesis testing. + + + A comma-separated string containing the input arguments in the format: "Probability, Deg_freedom". + + Probability: The cumulative probability for both tails of the distribution. This value must be a decimal between 0 and 1 (exclusive). + Deg_freedom: The degrees of freedom, typically the sample size minus 1. + This must be a positive integer. + + + + A string representing the t-value corresponding to the specified two-tailed probability and degrees of freedom. + Returns an error message if the input arguments are invalid. + + + + + + Retrieves two arrays of string values parsed from the input argument string. + Validates the inputs and checks for errors before computation. + + The first array of strings parsed from the input arguments. + The second array of strings parsed from the input arguments. + The input argument string containing comma-separated values for two arrays. + A string indicating validation error if any, or an empty string if successful. + Thrown if the number of arguments is incorrect and exceptions are rethrown. + + + + Calculates the F-test p-value based on two arrays of double values representing two data sets. + Assumes that input validation has already been performed by GetValuesOfFTest. + + The first array of doubles representing the first data set. + The second array of doubles representing the second data set. + The p-value of the F-test for the two data sets. + + + + + This function computes and returns the critical t-value for a two-tailed Student's t-distribution based on a specified probability and degrees of freedom. + + + A comma-separated string containing the input arguments in the format: probability, deg_freedom. + + Probability: The cumulative probability for the two-tailed Student's t-distribution. This value must be between 0 and 1 (exclusive of 0 and 1). + Deg_freedom: The number of degrees of freedom that defines the distribution.It must be a positive integer. + + + A string representing the t-value corresponding to the given two-tailed probability and degrees of freedom. + If the input is invalid, an error message or exception may be returned. + + + + + This function computes the critical value (inverse) of the F-distribution for a specified cumulative probability and degrees of freedom. + It is typically used in hypothesis testing or analysis of variance (ANOVA). + + + A comma-separated string containing the input arguments in the format: "p, degreesFreedom1, degreesFreedom2". + + + + p: The cumulative probability for which the F value is to be calculated. This value must be a number between 0 and 1 (exclusive of 0 and 1). + + + + + degreesFreedom1: The degrees of freedom for the numerator. This must be a positive integer. + + + + + degreesFreedom2: The degrees of freedom for the denominator.This must be a positive integer. + + + + + + A string representing the critical F value such that the cumulative probability of the F-distribution equals p. + If the input parameters are invalid, an error message is returned. + + + + + Calculates the inverse of the F-distribution for the given probability and degrees of freedom. + Uses a binary search approach to find the value corresponding to the specified cumulative probability. + + The cumulative probability for which the F value is to be calculated. Must be between 0 and 1. + The degrees of freedom for the numerator. + The degrees of freedom for the denominator. + The F value corresponding to the given cumulative probability. + + + + Calculates the cumulative distribution function (CDF) of the F-distribution. + This computes the probability that a random variable from the F-distribution is less than or equal to a given value. + + The F value for which the cumulative probability is calculated. + The degrees of freedom for the numerator. + The degrees of freedom for the denominator. + The cumulative probability corresponding to the given F value. + + + + This function computes a linear trend line based on a given set of dependent y-values and, optionally, independent x-values, and returns predicted values along the trend line. + This function can also calculate predictions for new X values if provided. + + + A comma-separated string containing the input arguments in the format: "knownY, [knownX], [newX], [const]". + + + knownY: A set of dependent y-values for which a trend line will be calculated.These values must be provided as a comma-separated string.. + + + knownX [optional]: A set of independent x-values corresponding to knownY. These values must be provided as a comma-separated string.If omitted, x-values are assumed to be a sequence starting from 1. + + + newX [optional]: A set of new x-values for which corresponding y-values are to be predicted. These values must be provided as a comma-separated string. If omitted, predictions are made for the given knownX. + + + const [optional]: A boolean value indicating whether the regression line should include a y-intercept.If true (default), the intercept is included. If false, the intercept is forced to be 0. + + + + A comma-separated string of predicted y-values along the trend line. If an error occurs, such as invalid input or mismatched data sets, an error message is returned.. + + + + Calculate and retrun the y-values along that line for the array of new_x's. + + + + + Get the argument values for Trend function and return error string for invalid arguments. + + + + + Adds an intercept column to a matrix, where the intercept column is filled with ones. + + + The input matrix to which the intercept column will be added. A 2D array with dimensions [rows, columns]. + + + A new 2D array with the same number of rows as the input matrix and one additional column. + The first column of the result is filled with ones (intercept column), followed by the original matrix columns. + + + + + Computes the transpose of a given matrix. + + + The input matrix to be transposed. A 2D array where elements are rearranged + such that rows become columns and columns become rows. + + + A 2D array representing the transposed matrix. The resulting matrix will have + dimensions [columns of the input matrix, rows of the input matrix]. + + + + + + Computes the inverse of a square matrix using the Gaussian elimination method. + + + The input matrix to be inverted. It must be a square matrix (same number of rows and columns). + + + a 2D array representing the inverse of the input matrix. If the matrix is singular or non-invertible, + an exception may be thrown due to division by zero or numerical instability. + + + + + Converts a single-column matrix into a one-dimensional vector (array). + + + The input matrix, which must have exactly one column. + + + a one-dimensional array containing the elements of the input matrix's single column. + + + + + Generates an identity matrix of the specified size. + + The size of the identity matrix (number of rows and columns). + + a square 2D array representing the identity matrix, where all diagonal elements are 1, + and all off-diagonal elements are 0. + + + + + Converts a one-dimensional vector (array) into a column matrix. + + The input vector to be converted. + + a 2D array representing the column matrix where each element of the + input vector becomes a row in the single-column matrix. + + + + + Calculate and return double values for xValues,yValues and newXValues. + + + + + + Calculate and return the Student's t-Test probability value. + + + + + Calculates the variance of a dataset. + + A list of double values representing the dataset. + The mean of the dataset. + The variance of the dataset. + + + + Computes the cumulative distribution function (CDF) for Student's t-distribution. + + The t-statistic for which to compute the CDF. + The degrees of freedom associated with the t-distribution. + + A double value representing the cumulative probability associated with the given t-statistic + and degrees of freedom. + s + + + + This function calculates and returns the probability (percentage points) for the Student's t-distribution, given a numeric t-value (x), degrees of freedom, and number of tails. + This function is typically used in hypothesis testing to determine the significance of results. + + + A string containing three arguments separated by commas, in the format: x, deg_freedom, tails. + + X: A numeric value representing the t-statistic (calculated from a statistical test). + Deg_freedom: An integer representing the degrees of freedom, typically calculated as the sample size minus 1. + Tails: Specifies whether to calculate the one-tailed or two-tailed distribution. + Use Tails = 1 for a one-tailed test and Tails = 2 for a two-tailed test. + + + + A string representing the probability (as percentage points) associated with the given inputs:x (t-value), deg_freedom, and the specified number of tails. + This value helps in determining the significance level during hypothesis testing. + + + + + This function computes and returns the two-tailed probability for the Student's t-distribution. + This function calculates the probability of observing a t-value as extreme as the given t-value (in either tail),for a specified degrees of freedom. + + + A string containing two arguments separated by commas, in the format: X, deg_freedom. + + X: The numeric t-value at which to evaluate the distribution. This represents the test statistic. + Deg_freedom: An integer representing the degrees of freedom, usually calculated as the sample size minus 1. + + + + A string representing the two-tailed probability associated with the specified t-value and degrees of freedom. + The result indicates the likelihood of observing a t-value as extreme as X, in both tails of the distribution. + The two-tailed t-distribution is commonly used in hypothesis testing where the alternative hypothesis tests for a difference in either direction (e.g., not equal to a specified value). + Input values should be in the correct format and range to avoid calculation errors. + + + Input: "2.5, 10" + Output: "0.0254" (depending on implementation and precision, result represents a probability). + + + + + This function computes and returns the right-tailed probability for the Student's t-distribution. + This function calculates the probability of observing a t-statistic greater than the given t-value (X), for a specified degrees of freedom. + + + A string containing two arguments separated by commas, in the format: X, deg_freedom. + + X: The numeric t-value at which to evaluate the distribution.This represents the test statistic. + Deg_freedom: An integer representing the degrees of freedom, usually calculated as the sample size minus 1. + + + + A string representing the right-tailed probability (as a percentage) associated with the specified t-value and degrees of freedom. + This value indicates the likelihood of observing a t-value greater than X.The right-tailed t-distribution is commonly used in hypothesis testing for one-sided tests where the alternative hypothesis specifies a direction (e.g., greater than a given value). + Input values should adhere to the expected format and range for accurate results. + Input: "2.5, 10" + Output: "0.0127" (depending on the implementation and precision; result represents a probability). + + + + + This method compute the actual T-distribution probability value by using numeric value and the number of degrees of freedom. + + + + + This method computes the incomplete beta function, which is part of the distribution's calculation, using series and logarithmic expressions. + + + + + This method computes a series used to approximate the incomplete beta function for values of a and b. + + + + + This function computes and returns the fraction expansion of the incomplete beta function + + + + + This function predicts a future value along a linear trend based on existing data using linear regression. + Calculates the forecasted value for a specified independent variable, x,based on the relationship between the provided dependent (known_y's) and independent (known_x's) data sets. + + + A comma-separated string containing three arguments in the format: x, known_y's, known_x's. + + x: The independent variable (data point) for which the prediction is to be made. + known_y's: A space-separated string representing an array or range of dependent values (the values to predict). + known_x's: A space-separated string representing an array or range of independent values corresponding to known_y's. + + + + A string representing the predicted value for the specified x, or an error message if the input is invalid or the calculation cannot be performed. + + + + + Return the value of TranslateText + + value + language + + + This method is deprecated. + + + + + Return the numeric code for first char of text + + text + numeric code + + + + Finds the first occurrence of one string in another string. + + Conatins two or three arguments. The first argument is the string + to find. The second string is the string that is being searched. The third argument + is the start location in the second string for the search. + The location of the found string. + + + + Returns the left so many characters in the given string. + + Contains the string and the number of characters. + A left sub string.. + + + + Used to compute the JIS function + + arguments + + + + + Returns the length of the given string. + + Contains the string. + An integer length. + + + + Returns a substring of the given string. + + Contains the original string, start position of the substring, + and the number of characters in the substring. + A substring. + + + + Returns the right so many characters in the given string. + + Contains the string and the number of characters. + A right substring. + + + + Convert the text to number + + text, + decimal separator,group separator + + + + Returns the text like first letter with upper letter in each word + + Text + proper text + + + + Replace the part of the text with a new text from orginal text + + Text,Start index, Number of char to replace, new text + replaced string + + + + Returns the number of repeated text + + text, repeated count + text + + + + Returns the number of the starting position of the first string from the second string. + + first strring, second string and starting position + index of the string + + + + Returns the Unicode char for the respective numeric value + + Number + unicode char + + + + Returns the corresponding number code for the first char of string. + + text + numeric code + + + + Returns the character whose number code is specified in the argument. + + The number used to retrieve the character. + The character string. + + + + Retuns the text removing the first 32 nonprintable characters(ranging from 0 to 31) in 7-bit ASCII code. + + Text or range holding text including nonprintable characters + Text without nonprintable characters(first 32) + + + + Returns whether or not the two arguments passed in are exactly the same. + + A string holding two arguments (separated by commas) of + cell references, strings, + formulas, or numbers. + True if the arguments are exactly the same ignoring formats, false other wise. + + + + Finds the first occurrence of one string in another string. + + Conatins two or three arguments. The first argument is the string + to find. The second string is the string that is being searched. The third argument + is the start location in the second string for the search. + The location of the found string. + The location count starts at 1. If the third argument is missing, it defaults to 1. + If the first string does not appear in the second string, #VALUE! is returned. The searches are done + in a case sensitive manner. + + + + + Returns the value at a specified row and column from within a given range. + + look_range, row, col + The value. + + Only the array form of this function is supported. + + + + + Returns the number of the starting position of the first string from the second string. + + first strring, second string and starting position + index of the string + + + + Find and return list of unique elements for two dimentional array elements. + + return list of unique elements. + + + + + Validate and return the error string for TextBefore/TextAfter formula. + + validated argument + + + + This function returns text that occurs after given character or string. + + + A string containing the arguments separated by commas. + The format should be: "text,delimiter,instance_num, match_mode, match_end, if_not_found". + + textThe text you are searching within. Wildcard characters not allowed. + delimiterThe text that marks the point after which you want to extract. + instance_num[Optional] The instance of the delimiter after which you want to extract the text.(default is 1). + match_mode[Optional] Determines whether the text search is case-sensitive. The default is case-sensitive. + + 0 - Case sensitive. + 1 - Case insensitive. + + + match_end[Optional] Treats the end of text as a delimiter. By default, the text is an exact match. + + 0 - Don't match the delimiter against the end of the text. + 1 - Match the delimiter against the end of the text. + + + if_not_found[Optional] Value returned if no match is found. By default, #N/A is returned. + + + The text that occurs after given character or string. + + + + Validate and get the argument for TextAfter/TextBefore formula. + + + + + This function returns text that occurs text that occurs before a given character or string + + + A string containing the arguments separated by commas. + The format should be: "text,delimiter,instance_num, match_mode, match_end, if_not_found" + + textThe text you are searching within. Wildcard characters not allowed. + delimiterThe text that marks the point after which you want to extract. + instance_num[Optional] The instance of the delimiter after which you want to extract the text.(default is 1). + match_mode[Optional] Determines whether the text search is case-sensitive. The default is case-sensitive. + + 0 - Case sensitive. + 1 - Case insensitive. + + + match_end[Optional] Treats the end of text as a delimiter. By default, the text is an exact match. + + 0 - Don't match the delimiter against the end of the text. + 1 - Match the delimiter against the end of the text. + + + if_not_found[Optional] Value returned if no match is found. By default, #N/A is returned. + + + The text that occurs before a given character or string. + + + + Find index to returns text when delimiter is character and instance_num is negative that appears after a given character. + + The text you are searching within + The text that marks the point after which you want to extract. + The instance of the delimiter after which you want to extract the text.By default, instance_num = 1 + The index to returns text that appears after a given character. + + + + Find index to returns text when delimiter is word and instance_num is negative that appears after a given character. + + The text you are searching within + The text that marks the point after which you want to extract. + The instance of the delimiter after which you want to extract the text.By default, instance_num = 1. + The index to returns text that appears after a given word. + + + + Find index to returns text when delimiter is word and instance_num is positive that appears after a given character. + + The text you are searching within. + The text that marks the point after which you want to extract. + The instance of the delimiter after which you want to extract the text.By default, instance_num = 1. + The index to returns text that appears after a given word. + + + + Find index to returns text when delimiter is character and instance_num is positive that appears after a given character. + + The text you are searching within + The text that marks the point after which you want to extract. + The instance of the delimiter after which you want to extract the text.By default, instance_num = 1. + The index to returns text that appears after a given character. + + + + This function returns text from any specified value. It passes text values unchanged, and converts non-text values to text. + + + A string containing the arguments separated by commas. + The format should be: "value, format" + + valueThe value to return as text. + formatThe format of the returned data.[optional] + + 0 - Concise format that is easy to read. The text returned will be the same as the text rendered in a cell that has general formatting applied. + 1 - Strict format that includes escape characters and row delimiters. Generates a string that can be parsed when entered into the formula bar. Encapsulates returned strings in quotes except for Booleans, Numbers and Errors. + + + + + Text from any specified value + + + + Returns the text from any specified value. + + The value to return as text. + The format of the returned data. + + + + Calculate array format argument value. + + Return calculated array format argument value for interior and direct VALUETOTEXT formula. + + + + This function returns text from any specified array/range. It passes text values of array unchanged, and converts non-text values to text. + + + A string containing the arguments separated by commas. + The format should be: "array, format" + + arrayThe array to return as text. + formatThe format of the returned data.[optional] + + 0 - Concise format that is easy to read. + The text returned will be the same as the text rendered in a cell that has general formatting applied. + + 1 - Strict format that includes escape characters and row delimiters. + Generates a string that can be parsed when entered into the formula bar. + Encapsulates returned strings in quotes except for Booleans, Numbers and Errors. + + + + + + Text from the specified array/range. + + + + Calculates the final string of the specified condition in the formula from the sepcified range of cells. + + an array of text values from any specified range. + + + + Converts a flat list of cell data into a structured list of rows and columns. + + List of cell data. + Number of columns in the data. + Structured data as a list of lists. + + + + Returns the text from any specified value. + + The value to return as text. + The format of the returned data. + string value after checking with the conditions. + + + + + Validates the argument list and extracts the range, ignore, and scanByColumn values. + + Output parameter that holds the value to be ignored. + Output parameter that indicates whether to scan by column. + Output parameter that holds the range value. + The argument list string to be parsed and validated. + + Returns an error string if there is any validation error, otherwise returns an empty string. + + Thrown when there is an invalid number of arguments or invalid argument value. + + + + Converts the values of a given array range to a single column/row format. + + The range of the array to be converted. + A value indicating whether to ignore certain cells (e.g., blanks or errors). + A boolean indicating whether to scan the range by columns (true) or by rows (false). + A string representing the values of the array converted to a single column/row, separated by the defined separator. + + + + Checks the conditions of the given cell value in the array based on specified criteria. + + The value of the cell to be checked. + A value indicating whether to ignore certain cells (e.g., blanks or errors). + A list to which the cell value will be added if it meets the conditions. + A boolean indicating whether the cell value was added to the list. + + + + Retrieves the totalnumber of columns, totalnumber of rows, and array values from the given array/range. + + Output parameter for the total number of columns. + Output parameter for the total number of rows. + Output parameter for the list of array values. + Input arguments, including range or array values. + + + + + Returns specified columns from an array or range. + + + A string containing the array or range and the column indexes separated by commas. + The format should be: array, col_num1, [col_num2], ... + + + array: The source array or range. + + + col_num1: An integer specifying the first column to return. + + + [col_num2]: [optional] Index numbers of additional columns to return. + + + + A formatted string representing the specified columns from the array or range. + + + + Returns the row/column indexes as a string array from the argument. + + The arguments specifying the range and indexes to choose. + The total number of columns in the range. + The total number of rows in the range. + A boolean indicating whether the indexes are for columns (true) or rows (false). + An output parameter that will contain the computed indexes as an integer array. + A string indicating any error that occurred during the computation; otherwise, an empty string. + + + + Computes and returns a formatted string of column or row values from a range based on specified indexes. + + The range of the array to be processed. + An array of indexes specifying the columns or rows to be chosen. + The total number of columns in the range. + The total number of rows in the range. + A list of the values in the array. + A boolean indicating whether the indexes are for columns (true) or rows (false). + A formatted string representing the chosen column or row values, separated by the defined separator. + + + + Returns specified rows from an array or range. + + + A string containing the array or range and the row indexes separated by commas. + The format should be: array, row_num1, [row_num2], ... + + + array: The source array or range. + + + row_num1: An integer specifying the first row to return. + + + [row_num2]: [optional] Index numbers of additional rows to return. + + + + A formatted string representing the specified rows from the array or range. + + + + Converts a flat list of cell data into a structured list of columns. + + List of cell data + Number of columns in the data + Structured data as a list of lists by columns + + + + This function generates a list of sequential numbers in an array. + + + A string containing the arguments separated by commas. + The format should be: "rows, columns, start, step". + + rows: The number of rows to fill. + columns: The number of columns to fill. If omitted, defaults to 1 column. + start: The starting number in the sequence. If omitted, defaults to 1. + + step: The increment for each subsequent value in the sequence. It can be positive or negative. + + If positive, subsequent values increase, creating an ascending sequence. + If negative, subsequent values decrease, producing a descending sequence. + If omitted, the step defaults to 1. + + + + + Generates and returns an array of sequential numbers. + + + + Generate an array of sequential number + + Generate and return an array of sequential number + + + + This function splits text strings by using column and row delimiters. + + + A string containing the arguments separated by commas. + The format should be: "text, col_delimiter, row_delimiter, ignore_empty, match_mode, pad_with". + + text: The text you want to split. + col_delimiter: The text that marks the point where to spill the text across columns. + row_delimiter [optional]: The text that marks the point where to spill the text down rows. + + ignore_empty [optional]: Specifies whether to ignore empty values or not. Defaults to FALSE. + + FALSE (default) - create empty cells for consecutive delimiters without a value in-between. + TRUE - ignore empty values, i.e., don't create empty cells for two or more consecutive delimiters. + + + + match_mode [optional]: Determines case-sensitivity for the delimiter. Enabled by default. + + 0 (default) - case-sensitive. + 1 - case-insensitive. + + + pad_with [optional]: A value to use in place of missing values in two-dimensional arrays. The default is a #N/A error. + + + Splitted text strings by using column and row delimiters. + + + + Compute and return delimters when delimter contains multiple character{",",";"}. + + delimters when contains multiple character. + + + + splits text strings by a given row and column delimiter across columns or/and rows. + + the text to split + a character(s) that indicates where to split the text across rows. + a character(s) that indicates where to split the text across columns. + specifies whether to ignore empty values or not. + determines case-sensitivity for the delimiter. + a value to use in place of missing values in two-dimensional arrays. + maxColumn count. + list of splitted text. + + + + splits text strings by a column delimiter across columns. + + + + + This function retrieves a specified subset of values from a given array or range based on the number of rows and/or columns provided. + + + A string containing the arguments separated by commas in the following format: + + + array: The array or range from which to retrieve values. + + + + rows: [Optional] The number of rows to return. + A positive value returns rows from the start of the array, while a negative value returns rows from the end. + If omitted, columns must be provided. + + + columns: [Optional] The number of columns to return. + A positive integer returns columns from the start of the array, while a negative integer returns columns from the end. + If omitted, rows must be provided. + + + + A formatted string containing the subset of values from the specified array or range. If the input is invalid, an appropriate error message is returned. + + + + Retrieves values from the given range based on the specified rows and columns. + + The range of cells. + The number of rows to retrieve. + The number of columns to retrieve. + A string containing the retrieved values, separated by a specified separator. + + + + This function removes the specified number of rows and/or columns from the start or end of an array or range. + + + A string containing the arguments separated by commas. The format should be: array, rows, [columns]. + + + + array: The array or range from which values are to be removed. + + + + + rows: [Optional] The number of rows to remove. A positive value removes rows from the start of the array, + and a negative value removes rows from the end of the array. If omitted, columns must be provided. + + + + + columns: [Optional] The number of columns to remove. A positive integer removes columns from the start of the array, + and a negative integer removes columns from the end of the array. If omitted, rows must be provided. + + + + + + A formatted string representing the array after removing the specified rows and/or columns. + If the inputs are invalid, an error message is returned. + + + + + Drops specified rows and/or columns from the array. + + Input range or array. + Number of rows to drop. + Number of columns to drop. + Total number of rows in the array. + Total number of columns in the array. + List of array values. + Resultant string after dropping specified rows and/or columns. + + + + This function expands or pads an array to specified row and column dimensions. + + + A string containing the arguments separated by commas. + The format should be: "array, rows, columns, pad_with". + + array: The array to expand. + rows: The number of rows in the expanded array. If missing, rows will not be expanded. + columns: The number of columns in the expanded array. If missing, columns will not be expanded. + pad_with: The value with which to pad. The default is #N/A. + + + An expanded or padded array with the specified row and column dimensions. + + + + Compute and return the expanded arraay based on pad_with and rows and cols argument. + + + + + This function computes the vector (one-dimensional array) and returns the wrapped values. + + + The input arguments as a single string separated by commas. + The format is: vector, wrap_count, [pad_with] + + + vector: The source one-dimensional array or range. + + + wrap_count: The maximum number of values per row. + + + pad_with [optional]: The value to pad the last row with if there are insufficient items to fill it. + If omitted, the missing values will be padded with #N/A (default). + + + + A string representing the wrapped rows or an error message. + + + + Wraps the rows or columns of an array based on the specified wrap count and padWith. + + The vector of values to be wrapped. + The count at which to wrap the rows or columns. + The value to pad with if necessary. + A boolean indicating whether to wrap rows (true) or columns (false). + A string representing the wrapped rows or columns. + + + + This function computes the vector (one-dimensional array) and returns the wrapped values. + + + The input arguments as a single string separated by commas. + The format is: vector, wrap_count, [pad_with] + + vector: The source one-dimensional array or range. + wrap_count: The maximum number of values per column. + pad_with [optional]: The value to pad the last column with if there are insufficient items to fill it. + If omitted, the missing values will be padded with #N/A (default). + + + A string representing the wrapped columns or an error message. + + + + Checks for error strings in the given arguments and extracts the range, wrap count, and pad width. + + The input arguments as a single string. + The extracted range of values. + The extracted wrap count. + The extracted pad width. + A string representing any error found, or an empty string if no errors are found. + + + + This function sorts the contents of an array or range by columns or rows in ascending or descending order. + + + A string containing the arguments separated by commas. The format should be: "array, sort_index, sort_order, by_col". + + + + array: The array or range to be sorted. + + + + + sort_index [Optional]: The column or row index on which to base the sorting. If omitted, the first column or row is used. + + + + + sort_order [Optional]: Defines the sort order. If omitted, the default is ascending order. + + 1 or omitted - Ascending order (default). + -1 - Descending order. + + + + + + by_col [Optional]: A logical value indicating the direction of sorting. If omitted, the default is to sort by rows. + + FALSE or omitted - Sort by row (default). + TRUE - Sort by column. + + + + + + A string representing the sorted array. + + + + Compute and sort the values from array or range + + Array values specified as a range + Sort index is a column index from the range or array values + Sorting order (1 for ascending, -1 for descending) + Scan by column (true/false) + String of the sorted values + + + + Sorts the structured data by the specified row index and order. + + Structured data as a list of lists + Index of the row to sort by + Order to sort by (1 for ascending, -1 for descending) + Sorted structured data + + + + Sorts the structured data by the specified column and order. + + Structured data as a list of lists + Index of the column to sort by + Order to sort by (1 for ascending, -1 for descending) + Sorted structured data + + + + Compares two values for sorting based on the specified sort order. + + The first value to compare. + The second value to compare. + The sort order (1 for ascending, -1 for descending). + An integer indicating the relative order of the values. + + + + This function sorts the contents of a range or array based on the values in corresponding ranges or arrays. + + + A string containing the arguments separated by commas. + The format should be: "array, by_array1, sort_order1, by_array2, sort_order2,…". + + + array: The array or range to sort. + + + by_array1: The array or range to sort by. + + + sort_order1: The order to use for sorting. Default is ascending. + + 1 for ascending. + -1 for descending. + + + + + A sorted range or array. + + + + Retrieves the values of the specified arrays and performs sorting based on the provided criteria. + + An array of strings representing the arguments for the SORTBY function. + A list of strings representing the sort orders for each byArray. + A list of strings representing the byArrays used for sorting. + A string representing the sorted values. + + + + Performs the sorting for the SORTBY function. + + A list of strings representing the values of the initial array or range. + A list of strings representing the byArrays used for sorting. + A list of strings representing the sort orders for each byArray. + The number of columns in the initial array or range. + A string representing the sorted values. + + + + This function is used to filter a range of data based on the criteria that you specify. + + + The input arguments as a single string, separated by commas. + The format is: array, include, [if_empty] + + + array: The source range or array of values to filter. + + + include: The criteria for filtering, provided as a Boolean array or a condition that results in a Boolean array (e.g., B2:B13=B2"). + + + if_empty [optional]: The value to return if no entries meet the criteria. If omitted, a default error message is returned. + + + + A string representing the filtered values based on the criteria, or an error message if the arguments are invalid or if an error occurs. + + + + This method used to calculate the criteria for Filter formula using include argument and retrun the calculated string. + + + + + This method filters the given array based on specified criteria and returns the results as a formatted string. + + The array to filter. + The criteria for filtering the array. + Additional conditions or logical operators for filtering. + Value to return if no items match the criteria. + Number of columns in the array for filtering. + True if includeArray is horizontal, false if vertical. + A formatted string with the filtered results. + + + + This method converts a numeric value to its equivalent Thai text and adds the currency unit "Baht" for the integer part, and "Satang" for the fractional part if applicable. + + + A string representing a number, a reference to a cell containing a number, or a formula that evaluates to a number. This number will be converted to Thai text with a "Baht" suffix. + + + A string representing the given number in Thai text, followed by "Baht" for the whole number part and "Satang" for the fractional part. + If the input number is zero, it returns "ศูนย์บาทถ้วน". If the input is invalid, it returns an error message. + + + + + Converts the integer part of a number into its equivalent Thai text representation. + + The integer part of the number to convert. + Array of Thai words for ones (1-9). + Array of Thai words for tens (10, 20, etc.). + Array of Thai words for higher units (hundred, thousand, etc.). + A string representing the integer in Thai text. + + + + Return the XML content of the given document + + web link + XML data + + + + Returns the encode url of the given text + + text + returns the EncodeURL + + + + Filter the value from XML document + + XML content + value + + + + Occurs whenever a string needs to be tested to determine whether it should be treated as a formula string and parsed, + or be treated as a non-formula string. This event allows for preprocessing the unparsed formula. + + This event may be raised more than once in the processing of a string into a formula. + + + + + Occurs whenever an unknown function is encountered during the parsing of a formula. + + This event may be raised more than once in the parsing of a formula. + + + + + Occurs whenever an UpdateNamedRange function is encountered during the parsing of a formula. + + This event may be raised more than once in the parsing of a formula. + + + + + Occurs when the formula computes the values. + + This event may be raised more than once in the computation of a formula. + + + + + Occurs whenever an ExternalFormula function is encountered during the parsing of a formula. + + This event may be raised more than once in the parsing of a formula. + + + + + Occurs whenever an ExternalFormula function is encountered during the parsing of a formula. + + This event may be raised more than once in the parsing of a formula. + + + + + Occurs whenever an ExternalFormula function is encountered during the parsing of a formula. + + This event may be raised more than once in the parsing of a formula. + + + + + Gets of sets whether the CalcEngine treats nonempty strings as zeros when they are + encountered during calculations. + + + The default value is true meaning that if a nonempty string is encountered during an arithmetic operation, it will be treated as zero. + + + + + This property is used to return the cell ranges for print area calculation. + + + + + Specifies the maximum number of recursive calls that can be used to compute a cellvalue. + + This property comes into play when you have a calculated formula cell that depends on + another calculated formula that depends on another calculated formula and so on. If the number of + 'depends on another formula' exceeds MaximumRecursiveCalls, you will see a Too Complex message + displayed in the cell. The default value is 100, but you can set it higher or lower depending upon + your expected needs. The purpose of the limit is to avoid a circular reference locking up your + application. + + + + + Indicates whether formulas are immediately calculated as dependent cells are changed. + + Use this property to suspend calculations while a series of changes + are made to dependent cells either by the user or programmatically. When the changes are + complete, set this property to False, and then call Engine.RecalculateRange to recalculate + the affected range. See the sample in GridCellFormulaModel.CalculatingSuspended. + + + + + A read-only property that gets a collection holding the current library functions. + + + This property gives you direct access to all library functions. + The function name serves as the hash key and the function delegate + serves as the hash value. + The function name should contain only letters, digits or an underscore. + You should use the method to add functions + to this collection. Do not use the Add method inherited from Hashtable. + The reason is that the hash key needs to be strictly upper case even though + formula syntax is case insensitive with respect to functions names. + Using the AddFunction method makes sure the hash key is properly set. + + + + + A property that gets/sets whether strings concatenated using the '&' operator should be + returned inside double quote marks. + + + + + A property that is used to identify whether the exception thrown or not while calculating the value. + + + + + Gets any Exception raised during the computation of a library function + provided RethrowLibraryComputationExceptions is set true. + + + Use the method to set this property + to null to indicate that there is no pending library exception within the engine. + + + + + Gets / sets whether the engine Rethrows any exception + raised during the computation of a library function. + + The default value is false. + + + + A property that gets or sets the calculations of the computations to mimic the computations of Excel. + + + + + Gets or sets the maximum calculation stack depth. + + + The default is 50. This is the number of recursive calls that can be made during calculations. + + + + Gets or sets a string array that hold the reserved strings + that will be used for the OR, AND, XOR, IF, THEN, ELSE and NOT logical operators. + + Here is the code that you can use to define this string array. This code + shows the default strings that are used. Note that the string must include a leading + and trailing blank, and must be lower case. In formulas that use these operators, + the formulas themselves are case agnostic. + + engine.ReservedWordOperators = new string[] + { + " or ", //0 + " and ", //1 + " xor ", //2 + " if ", //3 + " then ", //4 + " else ", //5 + " not " //6 + }; + + + + + + A static property that gets/sets character by which string starts with, can be treated as formula. + + + + + Enables / disables using row = 0 in formulas to represent the current row. + + + When this property is set True, entering zero as a row in a formula is + interpreted to be the current row. Using the current row notation allows + you to sort a column in the grid and maintain the relative formula. + After sorting, you do have to call engine.RecalculateRange to allow the + relative formulas to reset themselves. + + + + + Below property is used to find the active function name. + + + + + Gets the cell that is being calculated by the Engine. + + You can use this properly within your custom functions to + identify the item in the ICalcData object being computed. + + + + + Gets or sets whether IF function calculations should specifically avoid + computing the non-used alternative. + + + The default value is false for code legacy consistency. When AllowShortCircuitIFs + is set true, only the necessary alternative of an IF function is computed. To support + this behavior, a change in how nested IF function calculations are done is necessary. + The default way of calculating nested functions is inside-out, with the inner most + functions being computed to a value before the next outer function is evaluated. To + support short circuiting IF functions, nested IF functions need to be computed from + the outside-in to know what alternative needs to be evaluated. This outside-in calculation + pattern only applies to IF functions, and only when AllowShortCircuitIFs is true. + + + + + Gets or sets whether FormulaInfo.calcID is tested before + computing a formula during a call to + + When a value changes, then the Refresh method is called on any other + formula that had a dependency on the changed value. During the Refresh call, + the default behavior is to recompute all formulas (AlwaysComputeDuringRefresh = true). + If you are using to strictly control when new values + should be used, then you should set this property to false. For example, if you are + only using exclusively to retrieve computed values, + then setting AlwaysComputeDuringRefresh = false + may be more efficient as it will only recompute the value once during the calculations. + + + + A property that gets/sets whether Formula returns its FormulaValue instead of repeated calculation + + Use this property to return the FormulaValue when a cell contain more depency cells. + + + + + Gets or sets whether Invalid Formula is returned when the calculation stack is not fully exhausted during a calculation. + + + If you enter a formula like "=(1+2)(9+8)", Essential Calculate will compute this formula as 17, ignoring the dangling + 3 value on its calculation stack. If you want this situation flagged as a Invalid Formula, set this CheckDanglingStack property + to true. The default value is false for backward compatibility purposes. + + + + + Used with row ranges to possibly provide the upperlimit on the number of columns in the ICalcData object. + + + Essential Calculate supports column ranges of the form 2:4 as in =SUM(2:4) to represent all cells in rows + 2, 3 and 4 from a ICalcData object. To get a value for the number of columns, the CalcEngine first checks to + see if the ICalcData object supports the ISheetData interface. If this interface is supported, the column + count used to determine the range is obtained through this interface. If the ICalcData object does not support + ISupportColumnCount, then the value of ColumnMaxCount is used provided ColumnMaxCount > 0. If not, the fixed value 50 + is used. + + + + + Gets or sets whether the IF function implementation is called when is true. + The default behavior is to not call the IF Function code in the library, but instead, work directly with the + IF clauses. + + + + + Gets or sets whether must be called on every cells whenever + the is triggered. + The default value is false. + + + When a value changes, then the Refresh method is called recursively every time + the grid_ValuChanged is called. Setting this ForceRefreshCall to false will call + Refresh for only those cells where the calculated value is actually modified. + + + + + A read-only property that gets the collection of FormulaInfo objects being used by the CalcEngine. + + + + + Gets or sets whether leading zeros are preserved in a call to . + + + If the value of arg is "0123" or a cell reference like A1 where A1 holds 0123, then the default behavior + is for GetValueFromArg(arg) to return 123, stripping away any leading zeros. If you want calls to + GetValueFromArg to preserve the leading zeros, then set GetValueFromArgPreserveLeadingZeros to true. + + + + + Gets or sets the maximum number of iterative calls that can be made on a cell. + will be set to true when you set IterationMaxCount to any value other than zero. + + + Essential Calculate supports an iterative process to solve equations of the + form x=f(x). Here you should think of x as being a cell reference like B2 for example. Setting + IterationMaxCount to some value other than zero allows the engine to iteratively compute + f(x) using the previous iteration's calculated value for x. The initial value is either 0 + or the last saved value for a formula in that cell (if the calculation has been performed previously). + The iterations continue until either the iteration count exceeds IterationMaxCount, or two + successive iteration return values have a relative difference less than IterationMaxTolerance. + For example, to have an initial value of 1, you can enter a formula =1 into the cell, and then + enter the self referencing formula into the same cell. This will make the iterative calculations start + at 1 instead of 0. + must be set to true in order for the Iterative Calculation + support to function For this reason, ThrowCircularException will be automatically set to true + when you set a non-zero value to IterationMaxCount. + The default value is 0 indicating that iterative calculation support is turned off. + + + + + Gets or sets the success tolerance used by the CalcEngine's iterative calculation support. + + + Essential Calculate supports an iterative process to solve equations of the + form x=f(x). Here you should think of x as being a cell reference like B2 for example. Setting + IterationMaxCount to some value other than zero allows the engine to iteratively compute + f(x) using the previous iteration's calculated value for x. The initial value is either 0 + or the last saved value for a formula in that cell (if the calculation has been performed previously). + The iterations continue until either the iteration count exceeds IterationMaxCount, or two + successive iteration return values have a relative difference less than IterationMaxTolerance. + The default value is 0.001. + + + + + Gets or sets a value indicating whether editing a cell’s value will update dependent cells.  + + The default value is False. + + If enabled, editing a cell's value will not update dependent cells based on the edited value. + + + + + Used with column ranges to possibly provide the upperlimit on the number of rows in the ICalcData object. + + + Essential Calculate supports column ranges of the form A:D as in =SUM(A:D) to represent all cells in columns + A, B, C and D from a ICalcData object. To get a value for the number of rows, the CalcEngine first checks to + see if the ICalcData object supports the ISheetData interface. If this interface is supported, the row + count used to determine the range is obtained through this interface. If the ICalcData object does not support + ISupportRowCount, then the value of RowMaxCount is used provided RowMaxCount > 0. If not, the fixed value 50 + is used. + + + + + Gets or sets whether OR, AND, XOR and IF THEN ELSE logical + operators are supported. + + + The default value is false for backward compatibility. + + + + + Gets or sets whether ranges can be used as binary operands. + + + If this property is true, Essential Calculate recognizes ranges such + as B1:B5 and A4:E4 as operands of binary operators. So, if you + set the formula = A1:A5 + B1:B5 into cell C4, the calculation + will retrieve the values in A4 and B4 to be used in place of the + corresponding ranges A1:A5 and B1:B5. Note that such ranges must + either have one column wide or one row tall. This fact is used to + make the corresponding lookup determined by where the host cell that holds + the formula is located. This host cell + must either be in the same row or column as some cell in range. + + The default value is false. + + + + + Gets or sets whether sheet range notation is supported. + + + Excel supports sheet range notation such as + = SUM( sheet1:sheet3!A1 ) + Sum( sheet1:sheet3!B1:B4 ). + For backward compatibility with earlier versions that did + not support this sheet range notation, you can set + this SupportsSheetRanges false. + + This implementation replaces a sheet range (sheet1:sheet3!B1:B4) with + list of ranges (sheet1!B1:B4,sheet2!B1:B4,sheet3!B1:B4). + + + + + Gets / sets whether the CalcQuick should throw an exception when a circular calculation is encountered. + + If this property is True, the CalcQuick will throw an exception + when it detects a circular calculation. If ThrowCircularException is False, then + no exception is thrown and the calculation will loop recursively until Engine.MaximumRecursiveCalls + is exceeded. + + + + + A property that gets / sets whether the CalcEngine should track dependencies. + + If you are using the CalEngine in a manner where you always + call PullUpdatedValue to access the computations, then setting UseDependencies + to False will make things more efficient as any requested computed value will + be fully computed every time it is retrieved. In this situation, the CalcEngine + does not need to track dependencies. + + + + + For internal use. + + + + + Gets or sets a value indicating whether [preserve formula]. + + true if [preserve formula]; otherwise, false. + + + + A static property that gets/sets character to be recognized by the parsing code as the delimiter for arguments in a named formula's argument list + + + + + A static property that gets/sets the character to be recognized by the parsing engine as decimal separator for numbers. + + + + + A static property that gets/sets the character to be recognized by the parsing engine as decimal separator for date. + + + + + A property that gets/sets list of # error strings recognized by Excel. + + + + + A read-only property that gets a mapping between a cell and a list of formula cells that depend on it. + + + The key is the given cell, and the value is a ArrayList of cells containing + formulas that reference this cell. + + Here is code that will list formula cells affected by changing the given cell. + + public void DisplayAllAffectedCells() + { + CalcEngine engine = ((GridFormulaCellModel)this.gridControl1.CellModels["FormulaCell"]).Engine; + foreach(object o in engine.DependentCells.Keys) + { + string s1 = o as string; + Console.Write(s1 + " affects "); + ArrayList ht = (ArrayList) engine.DependentCells[s1]; + foreach(object o1 in ht) + { + string s2 = o1 as string; + Console.Write(s2 + " "); + } + Console.WriteLine(""); + } + } + + + Public Sub DisplayAllAffectedCells() + Dim engine As GridCalcEngine = CType(Me.gridControl1.CellModels("FormulaCell"), GridFormulaCellModel).Engine + Dim o As Object + For Each o In engine.DependentCells.Keys + Dim s1 As String = CStr(o) + Console.Write((s1 + " affects ")) + Dim ht As ArrayList = CType(engine.DependentCells(s1), ArrayList) + Dim o1 As Object + For Each o1 In ht + Dim s2 As String = CStr(o1) + Console.Write((s2 + " ")) + Next o1 + Console.WriteLine("") + Next o + End Sub 'DisplayAllAffectedCells + + + + + + A read-only property that gets a mapping between a formula cell and a list of cells upon which it depends. + + + The key is the given formula cell and the value is a Hashtable of cells that this + formula cell references. + + Here is code that will lists formula cells affected by changing a given cell: + + public void DisplayAllFormulaDependencies() + { + GridCalcEngine engine = ((GridFormulaCellModel)this.gridControl1.CellModels["FormulaCell"]).Engine; + foreach(object o in engine.DependentFormulaCells.Keys) + { + string s1 = o as string; + Console.Write(s1 + " depends upon "); + Hashtable ht = (Hashtable) engine.DependentFormulaCells[s1]; + foreach(object o1 in ht.Keys) + { + string s2 = o1 as string; + Console.Write(s2 + " "); + } + Console.WriteLine(""); + } + } + + + Public Sub DisplayAllFormulaDependencies() + Dim engine As GridCalcEngine = CType(Me.gridControl1.CellModels("FormulaCell"), GridFormulaCellModel).Engine + + Dim o As Object + For Each o In engine.DependentFormulaCells.Keys + Dim s1 As String = CStr(o) + Console.Write((s1 + " depends upon ")) + Dim ht As Hashtable = CType(engine.DependentFormulaCells(s1), Hashtable) + Dim o1 As Object + For Each o1 In ht.Keys + Dim s2 As String = CStr(o1) + Console.Write((s2 + " ")) + Next o1 + Console.WriteLine("") + Next o + End Sub 'DisplayAllFormulaDependencies + + + + + + A property that gets/sets the current named ranges. + + + + + Gets the weekend type + + + + + Gets or sets whether dates can be used as operands in calculations. The default value is false. + + + + + Gets / sets whether the engine throws an exception when + parsing fails with an unknown function error. + + + + + The List holds the formats of a Chinese Language. + + + + + Gets or sets whether lookup tables used in the VLookUp and HLookUp functions are cached. + + + Depending upon your use case, caching look up tables can greatly speed up calculations involving HLookUp + and VLookUp. If you make multiple calls to these functions passing in the same look up tables, and if these + look up tables are relatively static (don't dynamically change as the look ups are taking place), then caching + these tables will likely improve performance. + + + + + Delegate used to define functions that you add to the function library. + + Resultant value. + + + + Specifies the options for checking the formula error strings. + + + + + Formula contains null arguments. For Example:PI,RANDOM...etc + + + + + Formula contains range argument. For example:MEDIAN,...etc + + + + + Formula contains two text arguments with Number argument. For example:FIND,SEARCH...etc + + + + + Formula contains number and text arguments. For example:LEFT,RIGHT...etc + + + + + Formula contains number arguments only. For example:ABS,ROUND,ROUNDDOWN,LOG...etc + + + + + Formula contains text arguments only. For example:ARABIC,CLEAN...etc + + + + + Formula contains Date argument. For example:DISC,...etc + + + + + Compares 2 strings based on their length. + + 0, if both strings are equal; positive value if second string is greater; neagative value if first string is greater. + + + + Event delegate for ExternalFormulaEventArgs event. + + The CalcEngine. + The for this event. + + + + The event args for the ExternalFormulaEventArgs event, which is raised whenever the CalcEngine calculate external reference formula. + + + + + Event delegate for ExternalFormulaEventArgs event. + + The CalcEngine. + The for this event. + + + + The event args for the ExternalFormulaEventArgs event, which is raised whenever the CalcEngine is trying to get external worksheet from external reference formula. + + + + + Event delegate for ExternalFormulaEventArgs event. + + The CalcEngine. + The for this event. + + + + The event args for the ExternalFormulaEventArgs event, which is raised whenever the CalcEngine is trying to get external named range address from external reference formula. + + + + + Event delegate for the FormulaParsing event + + + + + Used by the event, FormulaParsingEventArgs holds a reference + to the string that is to be parsed. The FormulaParsing event allows the listener to preprocess + the string that is being parsed. + + + Please note that this event may be raised more than once as a string is parsed. + + Here is code snippets that show how to tell a engine to also treat any text in a formula cell + that begins with a minus(-) or a plus(+) as formulas. The default behavior is to treat only text beginning + with equal(=) as formulas. + + //subscribe to the event before any formulas are loaded into the grid... + Engine.FormulaParsing += new FormulaParsingEventHandler(Engine_FormulaParsing); + + //Here is the handler code that adds an = if necessary so any string beginning with +, - or = + //is treated as a formula. + void Engine_FormulaParsing(object sender, FormulaParsingEventArgs e) + { + //allow cells starting with + and - to be treated as formula cells. + if (e.Text.StartsWith("-")) + e.Text = "=" + e.Text; + else if (e.Text.StartsWith("+")) + e.Text = "=" + e.Text.Substring(1); + } + + + + + + Holds a reference to the string that is to be parsed.. + + The formula that is to be parsed. + + + + Default constructor. + + + + + A property that gets/sets the formula about to be parsed. + + + + + Event delegate for UnknownFunction event. + + The CalcEngine. + The for this event. + + + + The event args for the UnknownFunction event which is raised whenever the CalcEngine encounters a function + that is does not know. + + + + + Gets the name of the unknown function. + + + + + Gets the location of the missing function. + + + + + Event delegate for UpdateNamedRange event. + + The CalcEngine. + The for this event. + + + + The event args for the UpdateNamedRange event, which is raised whenever the CalcEngine calculate the intersection range of two named range . + + + + + Represents the method that will handle FormulaComputed event. + + Source of this event. + An instance of that contains the event data. + + + + Represents a class which holds the properties of FormulaComputed event. + + + + + Initializes a new instance of the FormulaComputedEventArgs class. + + Currently calculated formula. + The CalculatedValue for the formula. + The currently calculating cell address. + Returns true if the currently calculating formula is interior formula;else false. + + + + Gets the currently calculated formula name. + + + + + Gets or sets the value for the calculated formula. + + + + + Gets the currently calculated formula's cell reference. + + + + + Gets the value whether the currently calculated formula is interior formula or not. + + Returns true if the currently calculated formula is interior formula;else false. + + + + Gets the value whether to handle the calculation of the formula. + + To handle the calculation of the formula. + + + + The CustomComparer class provides a mechanism for comparing two strings based on a custom comparison logic. + It implements the interface to allow sorting or ordering operations on collections + of strings using the specified comparison logic. + + + This class is particularly useful when you need to perform custom sorting or ordering of strings in a collection, + such as a list or array. The comparison logic is provided via a delegate, which + allows flexibility in defining how two strings should be compared. + + + + + Initializes a new instance of the class with the specified comparison logic. + + A delegate that defines the logic for comparing two strings. + + + + Compares two strings and returns a value indicating whether one is less than, equal to, or greater than the other. + + The first string to compare. + The second string to compare. + + A signed integer that indicates the relative values of and : + + Less than zero: is less than . + Zero: equals . + Greater than zero: is greater than . + + + + + + Encapsulates the properties that are needed to support multiple families of crossed-referenced grids. + This class is for internal use only. + + + + + Holds mapping from parent object to sheet token. + + + + + Holds mapping from sheet token to parent object. + + + + + Holds mapping from parent object to sheet name. + + + + + Holds mapping from sheet name to parent object. + + + + + Performs the calculation of LINEST formula. + + + + + Gets or sets the instance of . + + + + + Initialize the object for parsing operations. + + An instance of . + + + + + This method is used to split the range and logical value when the range contains logical value. + + Range with logical value(ex:\u0092C1:C3\"1,2\"m\u0092) + Spilt the range ex("C1:C3") + Split the logical value ex("\"1,2\"m") + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + A class that allows you to quickly add calculation support for controls on a form, or usercontrol. + + + To use CalcQuick, you instantiate an instance of the class. Then just by indexing the + class object with string names to identify a formula object, you can have calculation support + in your form. Alternatively, you can add a collection of Control-derived objects and the + CalcQuick object will bind the Control.Text property allowing you to use the Control/Name property + to reference other controls in a formula. + + + Here is code that uses three TextBoxes, the first showing a value for an angle in degrees, + and the other two displaying the sine and cosine of this angle. In this code, the calculations + are done on the click of a button: + + CalcQuick calculator = null; + private void AngleForm_Load(object sender, System.EventArgs e) + { + //TextBox Angle = new TextBox(); + this.Angle.Name = "Angle"; + this.Angle.Text = "30"; + //cosTB = new TextBox(); + this.cosTB.Name = "cosTB"; + this.cosTB.Text = "= cos([Angle] * pi() / 180) "; + //sinTB = new TextBox(); + this.sinTB.Name = "sinTB"; + this.sinTB.Text = "= sin([Angle] * pi() / 180) "; + // Instantiate the CalcQuick object: + this.calculator = new CalcQuick(); + } + // Perform a manual calculation: + private void ComputeButton_Click(object sender, System.EventArgs e) + { + // Let the calculator know the values/formulas + // by using an indexer on the calculator object. + // Here we are using the TextBox.Name as the indexer key + // provided to the calculator object. This is not required. + // The only restriction for the indexer key values is that they + // be unique nonempty strings: + this.calculator["Angle"] = this.Angle.Text; + this.calculator["cosTB"] = this.cosTB.Text; + this.calculator["sinTB"] = this.sinTB.Text; + // Mark the calculator dirty: + this.calculator.SetDirty(); + // Now as the values are retrieved from the calculator, they + // will be the newly calculated values: + this.cosTB.Text = this.calculator["cosTB"]; + this.sinTB.Text = this.calculator["sinTB"]; + } + + + Dim calculator As CalcQuick = Nothing + Private Sub AngleForm_Load(sender As Object, e As System.EventArgs) + 'TextBox Angle = new TextBox(); + Me.Angle.Name = "Angle" + Me.Angle.Text = "30" + 'cosTB = new TextBox(); + Me.cosTB.Name = "cosTB" + Me.cosTB.Text = "= cos([Angle] * pi() / 180) " + + 'sinTB = new TextBox(); + Me.sinTB.Name = "sinTB" + Me.sinTB.Text = "= sin([Angle] * pi() / 180) " + + 'Instantiate the CalcQuick object: + Me.calculator = New CalcQuick() + End Sub 'AngleForm_Load + + 'Perform a manual calculation: + Private Sub ComputeButton_Click(sender As Object, e As System.EventArgs) + 'Let the calculator know the values/formulas + 'by using an indexer on the calculator object. + 'Here we are using the TextBox.Name as the indexer key + 'provided to the calculator object. This is not required. + 'The only restriction for the indexer key values is that they + 'be unique nonempty strings: + Me.calculator("Angle") = Me.Angle.Text + Me.calculator("cosTB") = Me.cosTB.Text + Me.calculator("sinTB") = Me.sinTB.Text + + 'Mark the calculator dirty: + Me.calculator.SetDirty() + + 'Now as the values are retrieved from the calculator, they + 'will be the newly calculated values: + Me.cosTB.Text = Me.calculator("cosTB") + Me.sinTB.Text = Me.calculator("sinTB") + End Sub 'ComputeButton_Click + + Here is code that uses the same three TextBoxes as above, but this time + the code is set up to automatically compute things as you change the + value in the Angle TextBox. There is no longer a need for a button handler + to trigger setting / getting values. + + CalcQuick calculator = null; + + private void AngleForm_Load(object sender, System.EventArgs e) + { + //TextBox Angle = new TextBox(); + this.Angle.Name = "Angle"; + this.Angle.Text = "30"; + + //cosTB = new TextBox(); + this.cosTB.Name = "cosTB"; + this.cosTB.Text = "= cos([Angle] * pi() / 180) "; + + //sinTB = new TextBox(); + this.sinTB.Name = "sinTB"; + this.sinTB.Text = "= sin([Angle] * pi() / 180) "; + + // Instantiate the CalcQuick object: + this.calculator = new CalcQuick(); + } + + // Perform a manual calculation: + private void ComputeButton_Click(object sender, System.EventArgs e) + { + // Let the calculator know the values/formulas + // by using an indexer on the calculator object. + // Here we are using the TextBox.Name as the indexer key + // provided to the calculator object. This is not required. + // The only restriction for the indexer key values is that they + // be unique nonempty strings: + this.calculator["Angle"] = this.Angle.Text; + this.calculator["cosTB"] = this.cosTB.Text; + this.calculator["sinTB"] = this.sinTB.Text; + + // Mark the calculator dirty: + this.calculator.SetDirty(); + + // Now as the values are retrieved from the calculator, they + // will be the newly calculated values: + this.cosTB.Text = this.calculator["cosTB"]; + this.sinTB.Text = this.calculator["sinTB"]; + } + + + Dim calculator As CalcQuick = Nothing + + Private Sub AngleForm_Load(sender As Object, e As System.EventArgs) + 'TextBox Angle = new TextBox(); + Me.Angle.Name = "Angle" + Me.Angle.Text = "30" + + 'cosTB = new TextBox(); + Me.cosTB.Name = "cosTB" + Me.cosTB.Text = "= cos([Angle] * pi() / 180) " + + 'sinTB = new TextBox(); + Me.sinTB.Name = "sinTB" + Me.sinTB.Text = "= sin([Angle] * pi() / 180) " + + 'Instantiate the CalcQuick object: + Me.calculator = New CalcQuick() + End Sub 'AngleForm_Load + + 'Perform a manual calculation: + Private Sub ComputeButton_Click(sender As Object, e As System.EventArgs) + 'Let the calculator know the values/formulas + 'by using an indexer on the calculator object. + 'Here we are using the TextBox.Name as the indexer key + 'provided to the calculator object. This is not required. + 'The only restriction for the indexer key values is that they + 'be unique nonempty strings: + Me.calculator("Angle") = Me.Angle.Text + Me.calculator("cosTB") = Me.cosTB.Text + Me.calculator("sinTB") = Me.sinTB.Text + + 'Mark the calculator dirty: + Me.calculator.SetDirty() + + 'Now as the values are retrieved from the calculator, they + 'will be the newly calculated values: + Me.cosTB.Text = Me.calculator("cosTB") + Me.sinTB.Text = Me.calculator("sinTB") + End Sub 'ComputeButton_Click + + + + + + Used in conjunction with . + + + Essential Calculate supports column ranges of the form A:D as in =SUM(A:D) to represent all cells in columns + A, B, C and D from a ICalcData object. To get a value for the number of rows, the CalcEngine first checks to + see if the ICalcData object supports the ISheetData interface. If this interface is supported, the row + count used to determine the range is obtained through this interface. If the ICalcData object does not support + ISheetData, then the value of is used provided RowMaxCount > 0. + and the index of first and last rows and columns + is used. + + + + + ICalcData defines the minimal interface that a data object must support in order to use + this formula engine. + + + + + A method that gets the data value from the specified row and column. + + 1-based index specifying the row index of the requested value. + + 1-based index specifying the column index of the requested data. + The data value at the given row and column index. + + + + A method that sets the data value to the specified row and column. + + The value. + One-based index specifying the row index of the value. + One-based index specifying the column index of the value. + + + + A method that wires the ParentObject after the CalcEngine object is created or when a + RegisterGridAsSheet call is made. + + This method is a callback to the ParentObject so it can have a chance + to subscribe to any change events it may need to implement ValueChanged properly. + + + + + Event for value changed + + + + + Get the idex of the first row in UsedRange + + index of first row + + + + get the index of the last row in UsedRange + + index of last row + + + + Gets the row count. + + Number of rows + + + + Gets the first column index. + + Index of first column + + + + Gets the last column index / column count. + + Index of last column + + + + Gets the column count. + + Number of columns + + + + Returns the value as false + + + + + Default constructor: + + Use this constructor when you want to have + several CalcQuick objects that access the same + static members of the CalcEngine. + + + + + Constructor that resets the CalcEngine object. + + + Indicates whether the static members of the CalcEngine class will be cleared. + + + + A method to reset all the keys registered with CalcQuickBase object. + + + + + Creates the object used by this CalQuick object. + + Returns an instance of a CalcEngine object. + You can override this method and return a derived CalcEngine object use + by the derived CalcQuick object. + + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + A method that parses and computes a well-formed algebraic expression passed in. + + The text of the formula. + The computed value. + You would use this method if you have a formula string which + contains only constants or library function references. Such formulas + do not depend upon other values. If you have registered a variable through + an indexer, then that variable can be used in a formula expression passed into this + method. This method will return the Exception text if an exception is thrown + during the computation. + + + + + A method that returns the formula string associated with the key passed in from a FormulaInfo object. + + The Hashtable key associated with the FormulaInfo object. + The formula string may be the empty string if no formula is stored with this key. + + + + A method to get the value of the cell referred. For internal CalcQuick use only. + + Row index. + Column index. + (row, col) data. + + CalcQuick does not expose a (row, col) data access model. + But since CalcEngine requires such a model, CalcQuick uses + a row, col access model internally, but only exposes the + formula Key model to access values. + + + + + Initializes any structures needed by this instance. + + + Indicates whether the static members of the CalcEngine class will be cleared. + + + + A method that parses and computes a well-formed algebraic expression passed in. + + The text of the formula. + The computed value. + You would use this method if you have a formula string which + contains only constants or library function references. Such formulas + do not depend upon other values. If you have registered a variable through + an indexer, then that variable can be used in a formula expression passed into this + method. + + + + + A method that recompute any formulas stored in the CalcQuick instance. + + + This method only has is used when AutoCalc is False. It loops through + all FormulaInfo objects stored in the CalcQuick object and recomputes + any formulas. + + + + + A method to force all calculations to be performed the next time the CalcQuick object is + accessed with an indexer requesting the value. + + + Each FormulaInfo object contained in the CalcQuick instance + has a calculation index that is checked any time the computed value is needed. If this index + is current, no calculation is done, and the last computed value is returned. If this index + is not current, the calculation is redone before the value is returned. Calling this method + guarantees that no FormulaInfo object's calculation indexes will be current. + + + + + A method to set value to the specified cell. For internal CalcQuick use only. + + + + + Loops through and updates all formula items that depend + on the FormulaInfo object pointed to by the key. + + Identifies FormulaInfo object that triggered the update. + + + + A method that wires the ParentObject after the CalcQuick object is created. For internal CalcQuick use only. + + + + + Get the idex of the first row in UsedRange + + index of first row + + + + get the index of the last row in UsedRange + + index of last row + + + + This API supports the .NET Framework infrastructure and is not intended to be used directly from your code + + + + + + Gets the first column index. + + Index of first column + + + + Gets the last column index / column count. + + Index of last column + + + + This API supports the .NET Framework infrastructure and is not intended to be used directly from your code + + + + + + For internal CalcQuick use only. + + + + + Occurs when one of the FormulaInfo objects being + maintained by the CalcQuick instance has changed. + + + + + A property that gets/sets the auto calculation mode of the CalcQuick. + + + By default, the CalcQuick will not update other values when you change + a FormulaInfo object. By default, you explicitly call SetDirty() + of the CalcQuick instance to force calculations to be done the next time + they are required. Setting AutoCalc to True tells the CalcQuick to maintain + the dependency information necessary to automatically update + dependent formulas when values that affect these formulas change. + + + + + Gets or sets whether formulas should be checked for syntax during key substitutions. Default is true. + + + Prior to version 4.4, no syntax checking was performed during the initial parsing process of substituting + for keys (variable names enclosed in square brackets). This early syntax checking support has been added to + catch cases where a keys was not preceded (or followed) properly in the formula. This CheckKeys property + is available for backward compatibility. To maintain the exact parsing algorithm found in versions + prior to 4.4, set this property to false. + + + + + Maintains a set of modified flags indicating whether + any control has had a value changed. + + + + + Maintains a collection of FormulaInfo objects. + + + This Hashtable serves as the data store for the + CalcQuick instance. The keys are the strings used + to identify formulas and the values are FormulaInfo + objects that hold the information on each formula or value. + + + + + Determines whether the CalcEngine object of this CalcQuick should be disposed on disposing this object. + Default value is true. + + + + + A read-only property that gets the reference to the CalcEngine object being used by this CalcQuick instance. + + + + + A property that gets/sets character by which string starts with, are treated as + formulas when indexing a CalcQuick object. + + If you use the technique of indexing the CalcQuick object + to set a varaible value, then you indicate that the value should be a + formula by starting the string with this character. If you do not want + to require your formulas to start with this character, then you will not + be able to use the indexing technique. Instead, you will have to call + ParseAndCompute directly to handle formulas not starting with this + character. + + + + Maintains a mapping between the string key and the row + used in a CalcSheet to identify a FormulaInfo object. + + + + + Maintains a mapping between the string key and a + vector of numbers entered using a brace expression. + + + + + Maintains a mapping between the string key and the control + which is being used to identify a FormulaInfo object. + + + + + Maintains a mapping between the row used in a CalcSheet + and the string key used to identify a FormulaInfo object. + + + + + Gets / sets formula values for CalcQuick. + + The indexer used to identify the formula. + + Using an indexer on the CalcQuick instance is the primary method + of setting a value to be used in a CalcQuick object. The string + used as the indexer is the key that you use to reference this formula + value in other formulas used in this CalcQuick instance. + + + + + Gets / sets whether the CalcQuick should throw an exception when a circular calculation is encountered. + + If this property is True, the CalcQuick will throw an exception + when it detects a circular calculation. If ThrowCircularException is False, then + no exception is thrown and the calculation will loop recursively until Engine.MaximumRecursiveCalls + is exceeded. + + + + + An event handler that represents the method to handle the event. + + + This event is raised whenever an indexer is used on the CalcQuick object to assign + it a value or when a value is assigned as the result of a calculation being done. + + + + + Event argument class for the event. + + + + + The only constructor for QuickValueSetEventArgs. + + This is the object that is used as the key value in the Hashtable to + identify the formula information. It is also the string you use in formulas (enclosed in brackets) + to reference a formula from another formula. + New value being assigned. + Indicates the reason the event is being raised. See FormulaInfoSetAction. + + + + The reason the event was raised. + + + + + A property that gets/sets the Hashtable lookup object for the FormulaInfo object being changed. + + + + + A property that gets/sets the new value being set. + + + + + Flags the reason that quickValueSet was raised. + + When QuickValueSet event is raised, it passes an + argument of FormulaInfoSetAction to indicate what was being assigned + to the CalcQuick object using an indexer. + + + + A formula (string starting with FormulaCharacter) was assigned. + + + + + Something other than a formula was assigned. + + + + + A calculated value was assigned. + + + + + Typed Hashtable returning FormulaInfo objects. + + + + + Gets or sets the FormulaInfo with the specified obj. + + The key to identify the given FormulaInfo. + FormulaInfo + + + + CalcSheet represents a single worksheet in a workbook. + + + A CalcSheet plays the role of an Excel Worksheet. It maintains its own internal data object + to hold FormulaInfo objects used by the CalcEngine in its calculation work. The CalcSheet accesses + the raw data / formulas that you want to use in the calculations via the ICalcData interface. + + + + + Default constructor. + + + + + Constructor that initializes an internal object array to + hold data. + + Number of rows in the data object. + Number of columns in the data object. + + + + Constructor used during serialization. + + + + + Creates a CalcSheet from a delimited text file + created by WriteSheetToFile. + + The file name. + A CalcSheet instantiated with the file content. + + + + Supports serialization. + + Serialization information. + Describes source and destination of the given stream.. + + + + Returns the value at the row and column. + + One-based row index. + One based column index. + The cell value. + + + + Raises the CalculatedValueChanged event. + + Includes the row, col, and value of the change. + This event should be raised any time a value changes. + + + + Raises the ValueChanged event. + + Includes the row, col, and value of the change. + This event should be raised any time a value changes. + + + + Creates a CalcSheet object from the content of a StreamReader. + + The StreamReader. + The newly created CalcSheet object. + + + + A Virtual method to save the value through the ICalcData.SetValueRowCol implementation method + and raise the ValueChanged event. + + The row index, one-based. + The column index, one-based. + The value. + + + + A Virtual method to set a value at a given row and column. + + Value to be set. + One-based row index. + One-based column index. + + + + A Virtual method that can be used to handle subscribing to any base object events necessary for implementing the + ValueChanged event. + + For example, when implementing ICalcData on a DataGrid-derived object, + you need to know when something in the DataGrid changes so you can raise the + required ICalcData.ValueChanged event. In WireParentObject, the DataGrid can + subscribe to its DataSource's change event to handle this requirement. If the + DataSource is a DataTable, then the DataTable.ColumnChanged event can fulfill + the requirement. + + + + Get the idex of the first row in UsedRange + + index of first row + + + + get the index of the last row in UsedRange + + index of last row + + + + This API supports the .NET Framework infrastructure and is not intended to be used directly from your code + + + + + + Gets the first column index. + + Index of first column + + + + Gets the last column index / column count. + + Index of last column + + + + This API supports the .NET Framework infrastructure and is not intended to be used directly from your code + + + + + + Writes a delimited file. + + The output file name. + The static Delimiter member specifies the field delimiter. + Rows are delimited by Environment.NewLine characters. + This method serializes formulas instead of computed values. To + write a file containing computed values, use the WriteValuesToFile method. + + + + Writes this CalcSheet object to the given StreamWriter. + + The StreamWriter. + Indicates whether to serialize formulas (False) + or computed values (True). + + + + Writes this CalcSheet object with formulas serialized to the given StreamWriter. + + The StreamWriter. + + + + Serializes the data with computed values to a delimited + text file. + + The file name. + The static Delimiter member specifies the field delimiter. + Rows are delimited by Environment.NewLine characters. + This method serializes computed values instead of formulas. To + write a file containing formulas, use the WriteSheetToFile method. + + + + This event is raised in SetValueRowCol. + + + + + This event should be raised by the implementer of ICalcData whenever a value changes. + + + + + Gets / sets a flag that indicates whether to compute dependent values + as cells change. + + + + + A read-only property that gets the column count. + + + + + Gets / sets the field delimiter for the + WriteSheetToFile method. + + The default value is tab. + + + + A read-only property that gets the CalcEngine object used by this CalcSheet. + + + + + Enables or disables saving changes within the CalcSheet. + + + + + A property that gets / sets the name used to refer to this sheet. + + + + + A read-only property that gets the row count. + + + + + Gets / sets a value through the ICalcData.GetValueRowCol + and ICalcData.SetValueRowCol implementation methods. + + The row index. + The column index. + + + + Calls SecurityPermission.Demand to find out if SecurityPermission is available. + + True if SecurityPermission is available. + + + + CalcWorkbook holds a collection of objects. + + + + + ArrayList of strings holding the CalcSheets names. + + + + + Initializes a new instance of the CalcWorkbook class. + + The calc sheets. + Hashtable of key, value pairs for Namedrange values. + + + + Initializes a new from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + A Virtual method to calculate all formulas in this workbook. + + + + + Removes all formulas in the given CalcSheet. + + The CalcSheet. + + + + Implements the ISerializable interface and returns the data needed to serialize the workbook. + + A SerializationInfo object containing the information required to serialize the cell model. + A StreamingContext object containing the source and destination of the serialized stream. + + + + A method that gets the integer ID of a CalcSheet. + + The CalcSheet name. + The integer ID. + + + + Creates a CalcWorkbook from a file written using WriteSSS. + + Pathname of the file. + A CalcWorkbook object. + + + + Writes a tab-delimited file holding the Workbook information. + + The pathname of the file to be written. + + + + Gets or sets an Arraylist of CalcSheet objects used in this workbook. + + + + + Array of CalcSheets objects used in this workbook. + + + + + Gets/Sets the CalcEngine object. + + + The setter only sets once, and only if InitCalcWorkbook has been called + with a zero CalcSheet count. + + + + + Number of CalcSheets in this workbook. + + + + + Gets / sets a CalcSheet object with the given name. + + The sheet name. + + + + Gets / sets a CalcSheet object with the given index. + + The sheet index. + + + + Wrapper ArrayList that holds a collection of CalcSheets. + + + + + Default constructor. + + + + + Creates an CalcSheetList instance owned by the given workbook with the given CalcSheet list. + + list of CalcSheets + The Workbook + + + + A method that adds a new CalcSheet. + + The CalcSheet to be added. + The index of the added CalcSheet. + + + + Not supported. + + + + + Not supported. + + + + + Returns the index for a CalcSheet. + + The name of the CalcSheet. + The index of the CalcSheet. + + + + A method that removes a CalcSheet. + + The CalcSheet to be removed. + + + + Removes a CalcSheet. + + The index of the CalcSheet to be removed. + + + + The CalcSheets in this collection. + + Returns a CalcSheet[]. + + + + Gets or sets the CalcSheet at the given index. + + The sheet index. + + + + Gets or sets the CalcSheet with a given name. + + The sheet name. + + + + An event handler that represents the method to handle the + event. + + The source of the event. + A that contains the event data. + + + + A class containing data for the ICalcData.ValueChanged event. + + + + + The constructor. + + One-based row index for the value. + One-based col index for the value. + the value at the specified row,col. + + + + A property that gets/sets One-base column index. + + + + + A property that gets/sets One-based row index. + + + + + A property that gets/sets the value. + + + + + Specifies options for caching look up tables in HLookUp and VLookUp functions. + + + + + No caching is done. + + + + + Tables will be cached only for VLookUp. + + + + + Tables will be cached only for HLookUp. + + + + + Tables will be cached for both VLookUp and HLookUp. + + + + + Tables will be optimized for searching for exact matches. Set this flag if you expect your searches to find exact matches. + + + + + RangeInfo represents a rectangle array of cells that may contain formulas, strings, or numbers + that may be referenced by other formulas. + + + + + Constructs a RangeInfo instance with the given top, left, bottom and right values. + + Top row index of this range. + Left column index of this range. + Bottom row index of this range. + Right column index of this range. + The range values must be one-based indexes. + + + + A method to retrieve a range based on the numeric arguments passed in. + + Top row index of this range. + Left column index of this range. + Bottom row index of this range. + Right column index of this range. + A RangeInfo object. + The range values must be one-based indexes. + + + + GetAlphaLabel is a method that retrieves a string value for the column whose numerical index is passed in. + + Number index such as 1, 5, 27. + Corresponding alphabets label like A, E, AA. + + + + A property that gets/sets the bottom row index of this range. + + + + + A property that gets/sets the left column index of this range. + + + + + A property that gets/sets the right row index of this range. + + + + + A property that gets/sets the top row index of this range. + + + + + Represents a collection of charts. + + + + + Defines a new name. + + Name of the new chart's sheet. + Newly created chart object. + + + + Returns the number of objects in the collection. Read-only Long. + + + + + Returns a single Chart object from a Charts collection + + + + + Returns a single Chart object from a Charts collection. + + + + + Collection of the Charts object. + + + + + This is the base class for all collections. + + + + + List with collection items. + + + + + Initializes a new instance of the class with the default initial capacity. + + + + + Initializes a new instance of the class with the specified capacity. + + The number of elements that the new list can initially store. + + + + Removes all objects from the System.Collections.CollectionBase instance. + + + + + Inserts an element into the list at the specified index. + + The zero-based index at which item should be inserted. + The object to insert. The value can be null for reference types. + + + + Returns an enumerator that iterates through this instance. + + An enumerator for this instance. + + + + Performs additional custom processes when clearing the contents of this instance. + + + + + Performs additional custom processes after clearing the contents of this instance. + + + + + Performs additional custom processes before inserting a new element into this instance. + + The zero-based index at which to insert value. + The new value of the element at index. + + + + Performs additional custom processes after inserting a new element into this instance. + + The zero-based index at which to insert value. + The new value of the element at index. + + + + Performs additional custom processes when removing an element from this instance. + + The zero-based index at which value can be found. + The value of the element to remove from index. + + + + Performs additional custom processes after removing an element from this instance. + + The zero-based index at which value can be found. + The value of the element to remove from index. + + + + Performs additional custom processes before setting a value in this instance. + + The zero-based index at which oldValue can be found. + The value to replace with newValue. + The new value of the element at index. + + + + Performs additional custom processes after setting a value in this instance. + + The zero-based index at which oldValue can be found. + The value to replace with newValue. + The new value of the element at index. + + + + Removes the element at the specified index of this instance. + + The zero-based index of the element to remove. + + + + Gets or sets the number of elements that the System.Collections.CollectionBase can contain. + + + + + Gets the number of elements contained in the System.Collections.CollectionBase instance. + + + + + Gets the list of elements in the instance. + + + + + Gets the list of elements in the instance. + + + + + Interface that contains parent application. + + + + + Parent object for this object. + + + + + Supports cloning, which creates a new instance of a class + with the same value as an existing instance. + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + An Application object that represents the Excel application. + + + + + The parent object for the specified object. + + + + + If True, events will not be raised; if False, events will be raised. + + + + + Default constructor. To prevent class creation by default constructor. + + + + + Creates collection and sets its Application and Parent values. + + + Application object that represents the Excel application. + + Parent object of this collection. + + + + This method raises the Changed event. + + + + + OnClear is invoked before Clear behavior. + + + + + OnClear is invoked after Clear behavior. + + + + + Performs additional processes before inserting + a new element into the collection. + + The zero-based index at which to insert value. + The new value of the element at index. + + + + Performs additional processes after inserting + a new element into the collection. + + The zero-based index at which to insert value. + The new value of the element at index. + + + + Performs additional processes before removing + an element from the collection. + + + The zero-based index at which the value can be found. + + + The value of the element to remove from index. + + + + + Performs additional processes after removing + an element from the collection. + + The zero-based index at which the value can be found. + The value of the element to remove from index. + + + + Performs additional processes before setting + a value in the collection. + + + The zero-based index at which oldValue can be found. + + The value to replace with newValue. + The new value of the element at index. + + + + Performs additional processes after setting a value in the collection. + + The zero-based index at which oldValue can be found. + The value to replace with newValue. + The new value of the element at the index. + + + + Method used to find parent within a specific type. + + Parent type to search. + Found parent if was parent was found or NULL otherwise. + + When there is cycle in object tree. + + + + + Method used to find parent within a specific type. + + Parent type to search. + Indicates whether to look into subclasses. + Found parent if was parent was found or NULL otherwise. + + When there is cycle in object tree. + + + + + Sets parent object for class. + + Parent object for sets. + + + + Creates copy of the collection. + + Parent object for the new collection. + A copy of the collection. + + + + Enlarges internal storage if necessary. + + Required size. + + + + Generates default name. + + Names collection. + Start string. + Returns string with new name. + + + + Generates default name. + + Names collection. + Start string. + Returns string with new name. + + + + Generate default name. + + Start string. + Collection with names. + Returns new name. + + + + Generates ID. + + Shape collection. + Returns new id. + + + + Read-only. An Application object that represents the Excel application. + + + + + Read-only. The parent object for the specified object. + + + + + Gets / sets whether class can raise events. + + + + + Application object. Read-only. + + + + + Change in the collection. + + + + + Raised by class before real cleaning of collection. + + + + + Raised by class after collection clean process. + + + + + Raised by class before item will be added into the collection. + + + + + Raised by class after item is added to the collection. + + + + + Raised by class before real item is removed from the collection. + + + + + Raised by class after item is removed from the collection storage + + + + + Raised by class before item is replaced in the collection. + + + + + Raised by class after item is replaced in the collection. + + + + + Delegate for Clear event. + + + + + Delegate for Change event. + + + + + Delegate for Set event. + + + + + Default start of the chart name. + + + + + Name-to-Chart dictionary. + + + + + Represent the current workbook. + + + + + Creates chart collection. + + Application object for the collection. + Parent object for the collection. + + + + Adds specified chart to the collection. + + Chart that should be added to the collection. + Added chart object. + + + + Defines a new name. + + Name of the new chart's sheet. + Newly created chart object. + + + + Sets all parents. + + + If one of the parent objects cannot be found. + + + + + Performs additional operations before Clear method execution. + + + + + Adds chart into internal collections. + + Chart to add. + + + + Returns a single Chart object from a Charts collection. + + + + + Class used for format constants. + + + + + Number of hours in a day. + + + + + Number of minutes in a hour. + + + + + Number of minutes in a day. + + + + + Number of seconds in a minute. + + + + + Number of seconds in a day. + + + + + This class gives access to the XlsIO IApplication interface. + + + + + Storage of XlsIO Application object which provides an IApplication interface + + + + + Indicates if the class was disposed. + TRUE - If the class was disposed, otherwise FALSE + + + + + TRUE - Throw exception when object is disposed and it's data was + not saved, otherwise FALSE + + + + + Default constructor. + + + + + Destructor. + + + + + Releases all resources used by the object. + + + Thrown when ThrowNotSavedOnDestoy property is set to TRUE and XlsIO + object data was not saved. + + + + + Checks whether license is valid. + + + + + Interface to the XlsIO Application which gives + access to all supported functions. + + + + + Dispose will throw an ExcelWorkbookNotSavedException when the workbook is not saved + and this property is set to TRUE. Default value is FALSE. + + + + + Checks whether security permission can be granted. Read-only. + + + + + Exception that will be thrown when the user tries to dispose XlsIO + application without saving it. + + + + + Creates new ExcelWorkbookNotSavedException. + + Text that showed after rising. + + + + Initializes a new instance of the Exception 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. + If the innerException parameter is not a null reference + (Nothing in Visual Basic), the current exception is raised + in a catch block that handles the inner exception. + + + + + Represents config xls class. + + + + + Creates xls config object. + + + + + Gets Copyright string. Read-only. + + + + + Class used for format parsing. + + + + + This is the base class for all Implementation's classes. + + + + + Reference to Application object. + + + + + Reference to parent Object. + + + + + Counter which can be used for calculating references. + + + + + Flag which indicates if the object was disposed or not. + + + + + Default constructor. Object cannot be constructed without setting Application + and parent references. + + + + + Main class constructor. Application and Parent properties are set. + + Reference to Application instance. + + Reference to the Parent object which will host this object + + + If specified application or parent is null. + + + + + Destructor. Call dispose method of current object. + + + + + This method is used to find parent with specific type. + + Parent type to locate. + The found parent or NULL if parent was not found. + + When there is cycle in object tree. + + + + + This method is used to find parent with specific type. + + Parent type to locate. + Indicates whether to search subtypes. + The found parent or NULL if parent was not found. + + When there is cycle in object tree. + + + + + This method is used to find parent with specific type. + + Start object for search operation. + Parent type to locate. + The found parent or NULL if parent was not found. + + + + This method is used to find parent with specific type. + + Start object for search operation. + Parent type to locate. + Indicates whether to search subtypes. + The found parent or NULL if parent was not found. + + + + Finds parent objects. + + Array of parents type. + Returns array of found parent objects. + + + + Find parent of object. + + Array of parents type. + Returns found parent object. + + + + Sets parent of the object. + + New parent for this object. + + + + Checks whether object was disposed and throws exception if it was. + + + + + Increase the quantity of reference. User must use this method when + new wrapper on object is created or reference on object stored. + + New state of Reference count value. + + + + Decrease quantity of Reference. User must call this method + when freeing resources. + + New state of Reference count value. + + + + Dispose object and free resources. + + + + + Method which can be overridden by users to take any specific actions when + object is disposed. + + + + + Reference to Application which hosts all objects. Read-only. + + + + + Reference to Parent object. Read-only. + + + + + Reference to Application which hosts all objects. Read-only. + + + + + Get quantity of instance references. + + + + + Constant Exponential symbol + + + + + constant Hash Symbol + + + + + List with all known format tokens. + + + + + Initializes a new instance of the FormatParserImpl class. + + Represents current application. + Represents parent object. + + + + Parses format string. + + String to parse. + Collection with parsed tokens. + + + + Class used for Format Section. + + + + + Return this value when element wasn't found. + + + + + Thousand separator. + + + + + Minus sign. + + + + + Default round off digit. + + + + + Table for token type detection. Value in TokenType arrays must be sorted. + + + + + Break tokens when locating hour token. + + + + + Break tokens when locating second token. + + + + + Possible digit tokens in the millisecond token. + + + + + Date Tokens + + + + + Time Tokens + + + + + Array of tokens. + + + + + Indicates whether format is prepared. + + + + + Position of decimal separator. + + + + + Position of E/E+ or E- signs in format string. + + + + + Last digit. + + + + + Indicates whether there are groups after last digit. + + + + + Number of digits in decimal fraction part. + + + + + Number of digits in integer part of number. + + + + + Position where fraction sign '/' was met for the first time. + + + + + Indicates whether number format contains fraction sign. + + + + + Start of the fraction numerator group. + + + + + End of the fraction denumerator group. + + + + + Length of the denumerator. + + + + + End position of the integer value. + + + + + End position of the decimal value. + + + + + Condition token. + + + + + Culture token. Used to display values. + + + + + Section format type. + + + + + Indicates whether we digits must be grouped. + + + + + Indicates whether more than one decimal point was met in the format string. + + + + + Indicates whether we should use system + + + + + Initializes a new instance of the FormatSection class. + + Represents current application. + Represents parent object. + + + + Initializes a new instance of the FormatSection class based on array of tokens. + + Represents current application. + Represents parent object. + Array of section's tokens. + + + + Prepares format if necessary. + + + + + Checks whether digits must be grouped. + + True if digits must be grouped, otherwise returns false. + + + + Prepares tokens and sets iternal position pointers. + + + + + Prepares insignificant digits that are present in decimal fraction part of this section. + + + + + Searches for corresponding hour token. + + Start index to search. + Corresponding hour token. + + + + Applies format to the value. + + Value to apply format to. + Indicates whether to show reserved symbols. + String representation of the value. + + + + Applies format to the value. + + Value to apply format to. + Indicates whether to show reserved symbols. + String representation of the value. + + + + Assigns position to the variable and checks if it wasn't assigned + before (throws ForamtException if it was). + + Variable to assign. + Current position. + + + + Applies part of the format tokens to the value. + + Value to apply format to. + Indicates whether to show reserved symbols. + Start format token. + End format token. + Indicates whether token index should be increased after each step. + String representation of the value. + + + + Applies part of the format tokens to the value. + + Value to apply format to. + Indicates whether to show reserved symbols. + Start format token. + End format token. + Indicates whether token index should be increased after each step. + Indicates whether to group digit tokens. + Indicates whether we should add negative sign before first digit token. + String representation of the value. + + + + Applies digit token to the value. + + Represents a digit token to apply. + Digit index. + Represents Start index of the range. + Represents Value to apply digit token to. + Represents digit counter. + Represents the StringBuilder to add value to. + Boolean value indicating direction of the apply cycle. + Boolean value indicating whether we should show hidden symbols. + Boolean value indicating whether digits are grouped. + Value of the digit count. + + + + Applies digit token to the value. + + Digit index. + Represents start index. + Represents digit counter. + Represents result of token string. + Represents the StringBuilder to add value to. + Boolean value indicating direction of the apply cycle. + Boolean value indicating whether digits are grouped. + Number of digits. + + + + Adds value to a StringBuilder. + + The StringBuilder to add value to. + Indicates whether we should call append method or insert. + Value to add. + + + + Checks whether iPos is inside range of correct values. + + End token index. + Indicates whether position is increasing each cycle. + Current position. + Value indicating whether iPos in inside of range of valid values. + + + + Locates last digit of the decimal fraction. + + Value of last decimal digit. + + + + Locates last group symbols. + + Start index to search. + Value indicating whether groups are present after last decimal digit. + + + + Applies last groups tokens. + + Value to apply to. + Indicates whether to show hidden symbols (reserved place). + + + + Prepares value for format application. + + Value to apply to. + Indicates whether to show hidden symbols (reserved place). + + + + Calculates number of fraction digits. + + Number of fraction digits. + + + + Calculates number of digits in the integer part of format string. + + Number of digits in the integer part of format string. + + + + Calculates number of digits in the specified range. + + Start index of the range. + End index of the range. + Number of digits in the specified range. + + + + Searches for block of digits that correspond to the fraction. + + + + + Searches for start of the group of digits. + + Start position to search. + Direction of the search: true - from left to right, false - from right to left. + Position of the start of the group. + + + + Indicates whether range contains any digits. + + Start range index. + End range index. + Value indicating whether range contains any digits. + + + + Checks whether value value meets the condition. + + Value to check. + True if value meets the condition; otherwise returns False. + + + + Tries to detect format type. + + + + + Checks whether section contains only specified token types. + + Array with possible tokens. + Value indicating whether the section contains only specified token types. + + + + Check whether this token is really minute token and substitutes it by Month if necessary. + + Token index to check. + + + + Searches for required time token. + + Start token index. + Types of tokens that could stop search process. + Indicates whether we have to increase token index on each iteration. + Types of token to search. + Index of the found token or -1 if token was not found. + + + + Sets to all second tokens. + + + + + Indicates whether type of specified token is in the array of tokens. + + Array of tokens to check. + Token type to locate. + True if token type is in the array of possible tokens. + + + + Splits value into integer and decimal parts. + + Value to split. + Return fraction value. + Integer value. + + + + Rounds value. + + Represents value to be rounded. + Rounded Value. + + + + Creates a new object that is a copy of the current instance. + + Represents parent object. + A new object that is a copy of this instance. + + + + Indicate whether the format string in time format + + + + + Indicate whether the format string in date format + + + + + Returns single token from the section. Read-only. + + + + + Gets the number of tokens in the section. + + + + + Gets a value indicating whether section contains condition. Read-only. + + + + + Gets the section type. + + + + + Gets the culture used for conversion. Read-only. + + + + + Gets the number of digits after "." sign. Read-only. + + + + + Class used for Section Collection. + + + + + Two many sections error message. + + + + + Maximum number of sections in "conditional mode". + + + + + Maximum number of secionts in "non-conditional mode"; + + + + + Index of section with positive number format. + + + + + Index of section with negative number format. + + + + + Index of section with positive number format. + + + + + Index of section with positive number format. + + + + + Indicates whether format contains conditions. + + + + + Initializes a new instance of the FormatSectionCollection class to prevent creation without arguments. + + Represents current application. + Represents parent object. + + + + Initializes a new instance of the FormatSectionCollection class. + + Represents current application. + Represents parent object. + List to parse. + + + + Returns format type for a specified value. + + Value to get format type for. + Format type for the specified value. + + + + Returns format type for a specified value. + + Value to get format type for. + Format type for the specified value. + + + + Splits array of tokens by SectionSeparator. + + List to parse. + + + + Applies format to the value. + + Value to apply format to. + Indicates whether to show reserved symbols. + String representation of the value. + + + + Applies format to the value. + + Value to apply format to. + Indicates whether to show reserved symbols. + String representation of the value. + + + + Returns section for formatting with specified index. + + Section index. + Format section that should be to the value. + + + + Returns section that corresponds to the specified value. + + Value to search section for. + If section is found then returns it, otherwise returns Null. + + + + Searches for section that should be used for zero number formatting. + + Section that should be used for zero number formatting. + + + + Returns text section. + + Text format section. + + + + Indicate whether the format string in time format + + + + + Indicate whether the format string in date format + + + + + Creates a new object that is a copy of the current instance. + + Represents parent object. + A new object that is a copy of this instance. + + + + Contains Am Pm Token descriptions. + + + + + Base class for formula tokens. + + + + + Default regular expressions options: + + + + + Part of format. + + + + + Initializes a new instance of the FormatTokenBase class + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Tries to parse format string using regular expression. + + Regular expression to use. + Format string to parse. + Start index. + Position after parsing. + + + + Tries to parse format string using regular expression. + + Regular expression to use. + Format string to parse. + Start index. + Output regular expression match. + Position after parsing. + + + + Applies format to the value. + + Value to format. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Applies format to the value. + + Value to format. + Formatted value. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Searches for string from strings array in the format starting from the specified position. + + Array of strings to check. + String format to search in. + Start index in the format. + Indicates whether to ignore case. + String index or -1 if not found. + + + + This method is called after format string was changed. + + + + + Gets or sets format of the token. + + + + + Gets type of the token. Read-only. + + + + + Start of the token. + + + + + Start of the token. + + + + + Edge between AM and PM symbols. + + + + + AM symbol. + + + + + PM symbol. + + + + + Length of the token. + + + + + Initializes a new instance of the AmPmToken class + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Checks the AMPM is other pattern. + + + + + + + Returns type of the token. Read-only. + + + + + Class used for Asterix Token. + + + + + Default start character. + + + + + Initializes a new instance of the AsterixToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for Character Token. + + + + + Start of the token. + + + + + Initializes a new instance of the CharacterToken class + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for Color Tokens. + + + + + Class used for parsing Brackets. + + + + + Start character of the token. + + + + + End character of the token. + + + + + Initializes a new instance of the InBracketToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Tries to parse format string. + + Format string to parse. + Position of the first bracket. + Position to start parsing at. + Position of the end bracket. + Position after parsed block. + + + + Reserved keyword for color definition in excel number format. + + + + + Minimum possible color index. + + + + + Maximum possible color index. + + + + + Color increment. + + + + + Regex for color selecting. + + + + + Possible color values. + + + + + Color index. + + + + + Initializes a new instance of the ColorToken class + + + + + Tries to parse format string. + + Format string to parse. + Position of the first bracket. + Position to start parsing at. + Position of the end bracket. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Searches for color in the array of known colors. + + Format string. + Start index. + Index in the array of known colors or -1 if color was not found. + + + + Tries to get color number from format string. + + Format string + Index to start looking from. + End index of the token. + Extracted color index or -1 if color was not found. + + + + Returns type of the token. Read-only. + + + + + Class used for Condition Tokens. + + + + + All compare operations. + + + + + Indicates whether token should be formatted using am/pm time format. + + + + + Applied compare operation. + + + + + Initializes a new instance of the ConditionToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position of the first bracket. + Position to start parsing at. + Position of the end bracket. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Checks value with the condition. + + Value to check. + Value that indicates whether the condition is true for the value. + + + + Returns type of the token. Read-only. + + + + + Possible compare operators. + + + + + Class used for Culture Tokens. + + + + + Group in regular expression with locale id. + + + + + Group in regular expression with characters. + + + + + LocaleId value that indicates that we should use system settings instead of provided number format. + + + + + Regular expression for hours part of the format: + + + + + Locale id of the desired culture. + + + + + Character specifying the culture. + + + + + Initializes a new instance of the CultureToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Gets the culture info. Read-only. + + + + + Gets a value indicating whether we should ignore all following format tokens and use system date format. Read-only. + + + + + Class used for describing Day Tokens. + + + + + Regular expression for minutes part of the format: + + + + + Format string in lower case. + + + + + Initializes a new instance of the DayToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for describing DecimalSeparatorToken. + + + + + Class used for character token. + + + + + Initializes a new instance of the SingleCharToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Gets format character. Read-only. + + + + + Format character. + + + + + Initializes a new instance of the DecimalPointToken class. + + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Format character. Read-only. + + + + + Returns type of the token. Read-only. + + + + + Class used for describing Digit Tokens. + + + + + Indicates whether this digit is last in the sequence of digits + and all significant numbers should be displayed. + + + + + Initializes a new instance of the DigitToken class. + + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Gets single digit from number and updates number. + + Number to get digit from. + Extracted digit. + + + + Returns string representation according to the current format and digit value. + + Value after removing current digit. + Digit to convert into string. + Indicates whether to show hidden symbols. + Converted value. + + + + Gets or sets a value indicating whether this digit is last in the sequence of digits + and all significant numbers should be displayed. Read-only. + + + + + Class used for Fraction tokens. + + + + + Format character. + + + + + Initializes a new instance of the FractionToken class. + + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Returns type of the token. Read-only. + + + + + Class used for organizing General Tokens. + + + + + Format string. + + + + + Initializes a new instance of the GeneralToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for 24 hour Token. + + + + + Regular expression for hours part of the format: + + + + + Initializes a new instance of the Hour24Token class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for Hour Token. + + + + + Long format. + + + + + Regular expression for hours part of the format: + + + + + Indicates whether token should be formatted using am/pm time format. + + + + + Initializes a new instance of the HourToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Gets or sets a value indicating whether token should be formatted using am/pm time format. + + + + + Class used for Significant Digit Tokens. + + + + + Format character. + + + + + Indicates that we shouldn't show string value if digit is zero. + + + + + Initializes a new instance of the InsignificantDigitToken class. + + + + + Returns string representation according to the current format and digit value. + + Value after removing specified digit. + Digit to convert into string. + Indicates whether to show hidden symbols. + Converted value. + + + + Returns type of the token. Read-only. + + + + + Format character. Read-only. + + + + + Gets or sets a value indicating whether to show string value if digit is zero. + + + + + Class used for MilliSecond Token. + + + + + Long format. + + + + + Represents Dot. + + + + + Default OleDateValue + + + + + Maximum OleDateValue + + + + + Maximum format length. + + + + + Initializes a new instance of the MilliSecondToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for Minute Token. + + + + + Long type of the format. + + + + + Default OleDateValue + + + + + Maximum OleDateValue + + + + + Regular expression for minutes part of the format: + + + + + Initializes a new instance of the MinuteToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + This method is called after format string was changed. + + + + + Returns type of the token. Read-only. + + + + + Class used for organizing Minutes since midnight. + + + + + Regular expression for hours part of the format: + + + + + Initializes a new instance of the MinuteTotalToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for Month Token. + + + + + Short year format. + + + + + Length of the format for full name of the month. + + + + + Length of the format for full name of the month. + + + + + Length of the format for full name of the month. + + + + + Format for long number month representation. + + + + + Regular expression for minutes part of the format: + + + + + Initializes a new instance of the MonthToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + This method is called after format string was changed. + + + + + Returns type of the token. Read-only. + + + + + Class used for Percent Token. + + + + + Format character. + + + + + Initializes a new instance of the PercentToken class. + + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Format character. Read-only. + + + + + Class used for placing reserved digit token. + + + + + Format character. + + + + + String to display when digit is 0 and ShowHiddenSymbols is set to False. + + + + + Initializes a new instance of the PlaceReservedDigitToken class. + + + + + Returns string representation according to the current format and digit value. + + Value after removing specified digit. + Digit to convert into string. + Indicates whether to show hidden symbols. + Converted value. + + + + Returns type of the token. Read-only. + + + + + Format character. Read-only. + + + + + Class used for reserved place format token. + + + + + Start of the token. + + + + + Space symbol. + + + + + Initializes a new instance of the ReservedPlaceToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for Scientific Token. + + + + + Short form without plus sign. + + + + + One of the possible formats. + + + + + Used format index. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for Seconds Token. + + + + + Long type of the format. + + + + + Half of possible milliseconds. + + + + + Default OleDateValue + + + + + Maximum OleDateValue + + + + + Regular expression for minutes part of the format: + + + + + Indicates whether number of seconds must be rounded. + + + + + Initializes a new instance of the SecondToken class + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Gets or sets a value indicating whether number of seconds must be rounded. + + + + + Class used for second total token. + + + + + Regular expression for hours part of the format: + + + + + Initializes a new instance of the SecondTotalToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for separator token. + + + + + Default string representation of the separator. + + + + + Initializes a new instance of the SectionSeparatorToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for Significant Digit Token. + + + + + Format character. + + + + + Initializes a new instance of the SignificantDigitToken class. + + + + + Returns type of the token. Read-only. + + + + + Format character. Read-only. + + + + + Class used for String Token. + + + + + Regular expression for minutes part of the format: + + + + + Initializes a new instance of the StringToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for Text Token. + + + + + Format character for text token. + + + + + Initializes a new instance of the TextToken class. + + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Format character. Read-only. + + + + + Class used for thousands separator token. + + + + + Format character. + + + + + Indicates whether this separator is placed immediately after last digit token. + + + + + Initializes a new instance of the ThousandsSeparatorToken class. + + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Prepares value to display. + + Value to prepare. + Prepared value. + + + + Format character. Read-only. + + + + + Returns type of the token. Read-only. + + + + + Gets or sets a value indicating whether this separator is placed immediately + after last digit token. Read-only. + + + + + Class used for UnknownToken. + + + + + Initializes a new instance of the UnknownToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for YearToken. + + + + + Short year format. + + + + + Regular expression for minutes part of the format: + + + + + Initializes a new instance of the YearToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Represents possible token types. + + + + + Represents unknown format token. + + + + + Represents section format token. + + + + + Represents hour format token. + + + + + Represents hours in 24 hours format format token. + + + + + Represents minute format token. + + + + + Represents total minutes format token. + + + + + Represents second format token. + + + + + Represents total seconds format token. + + + + + Represents year format token. + + + + + Represents month format token. + + + + + Represents day format token. + + + + + Represents string format token. + + + + + Represents reserved place format token. + + + + + Represents character format token. + + + + + Represents am/pm format token. + + + + + Represents color format token. + + + + + Represents condition format token. + + + + + Represents text format token. + + + + + Represents significant digit format token. + + + + + Represents insignificant digit format token. + + + + + Represents place reserved digit format token. + + + + + Represents percent format token. + + + + + Represents scientific format token. + + + + + Represents general format token. + + + + + Represents thousands separator format token. + + + + + Represents decimal point format token. + + + + + Represents asterix format token. + + + + + Represents fraction format token. + + + + + Represents millisecond format token. + + + + + Represents culture token. + + + + + Represents common fraction. Used to apply number format to the value. + + + + + Maximum number of digits. + + + + + Maximum accuracy. + + + + + Fraction numerator. + + + + + Fraction denumerator. + + + + + Initializes a new instance of the Fraction class. + + Represents numerator of the fraction. + Represents denominator of the fraction. + + + + Initializes a new instance of the Fraction class. + + Represents numerator of the fraction. + + + + Initializes a new instance of the Fraction class. + + Represents first term of the fraction. + Represents second term of the fraction. + Fraction of the numerator and denominator. + + + + Converts fraction to double value. + + Fraction to convert. + Double value equal to the fraction. + + + + Converts List into fraction. + + List to convert. + Converted value. + + + + Converts long into fraction. + + Value to convert. + Converted value. + + + + Swaps numerator and denumerator. + + Current fraction after reverse. + + + + Converts number to fraction using required digits number. + + Value to convert. + Maximum number of digits. + Optimal fraction. + + + + Returns maximum common divisor of two numbers using Euclid method. + + First number. + Second number. + Maximum common divisor of two numbers. + + + + Returns absolute difference between fraction and double. + + Fraction for difference evaluation. + Double value for difference evaluation. + Evaluated difference. + + + + Adds next number to List with continued fraction. + + List with continued fraction. + Remainder of the fraction. + Remainder after adding next number to the fraction. + + + + Returns string representation of the Fraction. + + String representation of the Fraction. + + + + Gets or sets the fraction numerator. + + + + + Gets or sets the fraction denumerator. + + + + + Gets the number of digits in the denumerator. + + + + + Summary description for AddInFunctionImpl. + + + + + Index to extern workbook. + + + + + Name index in the extern workbook. + + + + + Parent workbook. + + + + + Searches for all necessary parents. + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + XlsIO Application interface declaration. + + + + + Represents the Excel application. + + + + + Saves changes to the active workbook. + + File name of result file. + + + + Check whether the file version is supported by XlsIO. + + File full path that contains workbook. + + + + + Check whether the file version is supported by XlsIO. + + File stream that contains workbook. + + + + + Converts units. + + Value to convert. + Form option. + To option. + Returns converted result. + + + + Returns an object that represents the active sheet (the sheet on + top) in the active workbook or in the specified window or workbook. + Returns Nothing if no sheet is active. Read-only. + + + + + Returns a Workbook object that represents the workbook in the active + window (the window on top). Read-only. Returns Nothing if there are + no windows open or if either the Info window or the Clipboard window + is the active window. + + + + + Returns a Workbooks collection that represents all the open workbooks. + Read-only. + + + + + Returns or sets the number of sheets that Microsoft Excel + automatically inserts into new workbooks. Read/write Long. + + + + + Sets or returns the character used for the decimal separator as a + String. Read/write. + + + + + Returns or sets the default path that Microsoft Excel uses when it + opens files. Read/write String. + + + + + Returns the path separator character ("\"). Read-only String. + + + + + Returns or sets the standard (default) height of all the rows in the worksheet, + in points. This value is used only for newly created worksheets. + Read/write Double. + + + + + Returns or sets the standard (default) height option flag, which defines that + standard (default) row height and book default font height do not match. + This value is used only for newly created worksheets. Read/write Bool. + + + + + Returns or sets the standard (default) width of all the columns in the + worksheet. This value is used only for newly created worksheets. + Read/write Double. + + + + + Indicates whether to optimize fonts count. This option will + take effect only on workbooks that will be added after setting + this property. + WARNING: Setting this property to True can decrease performance significantly, + but will reduce resulting file size. + + + + + Indicates whether to optimize Import data. This option will + take effect only on Import methods that are available with the worksheet + WARNING: Setting this property to True can decrease memory significantly, + but will increase the performance of data import . + + + + + Gets / sets row separator for array parsing. + + + + + Formula arguments separator. + + + + + Represents CSV Separator. Using for Auto recognize file type. + + + + + Returns or sets the name of the standard font. Read/write String. + + + + + Returns or sets the standard font size, in points. Read/write. + + + + + Indicates whether to try fast record parsing. + + + + + Gets / sets memory allocation block for single row. Each row will allocate memory block + that can be divided on this number. Smaller value means smaller memory usage but slower + speed when changing cell's value. Default value is 128. That is enough to allocate 9 string records, + or 9 integer numbers (or floating numbers with 1 or 2 digits after decimal point) or 7 double numbers. + + + + + Indicates whether XlsIO should delete destination file before saving into it. + Default value is TRUE. + + + + + Gets / sets default excel version. This value is used in create methods. + + + + + Indicates whether we should use native storage (standard windows COM object) + or our .Net implementation to open excel 97-2003 files. + + + + + Changes data provider type for all operations after it. + + + + + Indicates whether to preserve the datatypes for the CSV file formats. + + + + + Represents the chart to image converter instance. + + + + + When workbook is read from stream and position of the stream changed, + this event is raised. + + + + + This event is fired when user tries to open password protected workbook + without specifying password. It is used to obtain password. + + + + + This event is fired when user specified wrong password when trying to open + password protected workbook. It is used to obtain correct password. + + + + + Width of the zero character. + + + + + Build number. + + + + + Default font size. + + + + + Default quantity of decimal digits after separator. + + + + + Default sheets in the new workbook. + + + + + Default font name. + + + + + Name of the object "Microsoft Excel". + + + + + Name of the switch. + + + + + Switch description. + + + + + Argument separator. + + + + + Row separator. + + + + + Represents size of biff file header. + + + + + Represents xml header. + + + + + Represents xml header. + + + + + Represents default buffer size for auto recognize. + + + + + Path separator. + + + + + Represents default header for .xls and .xlt files. + + + + + Array of Proportions. + + + + + Minimum cell size. + + + + + Represents the Graphic. + + + + + Switch indicating whether to show debug information. + + + + + Flag for debug message. + + + + + All types in the assembly (in order to increase performance). + + + + + Parent object + + + + + Indicates is debug info enabled. + + + + + XlsIO Static Members. + + + + + + + + + + Indicates whether seprator value is changed or not. + + + + + Default styles names. Index means outline level value. + + + + + Table with paper sizes. + + + + + Range representing active cell of the active worksheet of the active workbook. + + + + + Active worksheet. + + + + + Active workbook. + + + + + Collection of all workbooks in the application. + + + + + All data entered after this field is set to True will be formatted + with the number of fixed decimal places set by the FixedDecimalPlaces + property. + + + + + True (default) if the system separators of Microsoft Excel are + enabled. + + + + + Standard font size, in points. + + + + + Number of fixed decimal places used when the FixedDecimal + property is set to True. + + + + + The number of sheets that Microsoft Excel automatically + inserts into new workbooks. + + + + + The character used for the decimal separator as a String. + + + + + Name of the standard font. + + + + + The character used for the thousands separator as a String. + + + + + The name of the current user. + + + + + If this value is True and if some cells have reference + to the same style, changes will influence all these cells. + False otherwise + + + + + Storage of SkipExtendedRecords property value. + + + + + Standard row height - height of the rows that do not have specified row height. + + + + + Standard (default) height option flag, which defines that standard (default) + row height and book default font height do not match. + + + + + Standard column width. + + + + + Indicates whether to optimize fonts count. This option will + take effect only on workbooks that will be added after setting + this property. + WARNING: Setting this property to True can decrease performance significantly, + but will reduce resulting file size. + + + + + Indicates whether to optimize Import data. This option will + take effect only on Import methods that are available with the worksheet + WARNING: Setting this property to True can decrease memory significantly, + but will increase the performance of data import . + + + + + Row separator for array parsing. + + + + + Formula arguments separator. + + + + + Represents CSV Separator. + + + + + Indicates whether to try fast record parsing. + + + + + Memory allocation block for single row. + + + + + Indicates whether XlsIO should delete destination file before saving into it. + Default value is TRUE. + + + + + Represents the Graphic. + + + + + Default excel version for new workbooks. + + + + + + + + + + Indicates whether evaluation license expired. + + + + + Indicates whether the dafault font is changed or not. + + + + + Indicates whether workbook is in parsing process. + + + + + Static constructor. + + + + + Default constructor. + + + + + This method initializes inner collections of workbooks. + + + + + Check whether the file version is supported by XlsIO. + + File full path that contains workbook + + + + + Check whether the file version is supported by XlsIO. + + File stream that contains workbook + + + + + Gets file type based on stream data. + + Represents data stream. + Represents type of the file for open operation. + Returns defined open type (cannot return automatic). + + + + Detects is csv or xml file type. + + Represents data stream. + MemoryStream with data from the file that will be used for file type detection. + Represents start position in stream. + Parsed workbook if detected or null. + + + + Indicates is surrogate value. + + Value for search. + Represents current separator. + Indicates is compare with separator content, or not. + + + + + Saves changes to the active workbook. + + File name of result file. + + + + Creates a new Workbook. + + Parent object for the new workbook. + Stream to read. + Current separator + Number of first row to write. + Number of first column to write. + Excel version. + Filename is used to generate worksheet name + Created workbook. + + + + Creates a new Workbook. + + Parent object for the new workbook. + Stream with workbook's data. + Excel version. + Newly created workbook. + + + + Creates a new Workbook. + + Parent object for the new workbook. + Name of the file with workbook. + Parse options. + Indicates whether to open workbook in read-only mode. + Password to decrypt. + Excel version. + Newly created workbook. + + + + Creates a new Workbook. + + Parent object for the new workbook. + Number of sheets in the new workbook. + Excel version. + Newly created workbook. + + + + Creates a new Workbook. + + Parent object for the new workbook. + Name of the file with workbook. + Excel version. + Newly created workbook. + + + + Creates a new Workbook. + + Parent object for the new workbook. + Name of the file with workbook. + Parse options. + Excel version. + Newly created workbook. + + + + Creates a new Worksheet. + + Parent object for the new worksheet. + Newly created worksheet. + + + + Creates a new Range. + + Parent object for the new range. + Newly created range. + + + + Creates new range for a single cell. + + Parent object for the new range. + Column index for the new range. + Row index for the new range. + Newly created range. + + + + Creates a new Range. + + Parent object for the new range. + First column of the range. + First row of the range. + Last column of the range. + Last row of the range. + Newly created range. + + + + Creates a new Range. + + Parent object for the new range. + Range record to parse. + Indicates whether styles should be ignored. + Newly created range. + + + + Creates a new Style. + + Parent object for the new style object. + Name of the new style. + Newly created style. + + + + Creates a new Style. + + Parent object for the new style object. + Name of the new style. + Base style for this style. + Newly created style. + + + + Creates a new Style. + + Parent object for the new style object. + Style record with style information. + Newly created style. + + + + Creates a new Style. + + Parent object for the new style object. + Name of the new style.> + Indicates whether built in style should be created. + + + + + Creates new font. + + Parent object for the new font. + Newly created font. + + + + Method creates a font object based on native font and register it in the workbook. + ] + Parent object for the new font. + Native font to get settings from. + Newly created font. + + + + Creates new font. + + Base font for the new one. + Newly created font. + + + + Creates new font. + + Parent object for the new font. + Font record that contains font information. + Newly created font. + + + + Creates new font. + + Parent object for the new font. + Font object that contains font information. + Newly created font. + + + + This method should be called before creating font. + Sets default font name and size. + + + + + Creates new instance of RangesCollection. + + Parent object for the collection. + Newly created collection. + + + + Creates intptr data provider. + + New instance of created data provider. + + + + + + + + + + Create image from stream. + + + + + + + Creates new instance of the textbox shape. + + Parent shapes collection. + Created textbox shape. + + + + Checks and apply the seperators to the current culture. + (ie.. DecimalSeperator, ThousandSeperators). + + Current Culture with the new Seperators. + + + + Get the current culture; + + Old cultrue + New cultrue + CultureInfo + + + + Sets active workbook. + + Workbook that becomes active. + + + + Sets active worksheet. + + Worksheet that becomes active. + + + + Sets active cell. + + Range that becomes active. + + + + Converts to pixels. + + Value to convert. + MeasureUnits. + Returns converted result. + + + + Converts from pixel. + + Pixel to convert. + Convert options. + Returns converted result. + + + + Converts units. + + Value to convert. + Form option. + To option. + Returns converted result. + + + + Converts units. + + Value to convert. + Form option. + To option. + Returns converted result. + + + + Raising progress event. + + Position. + Full size. + + + + Measures string. + + String to measure. + Font to measure. + Rect size. + Returns new size. + + + + Switch indicating whether to show debug information. Read-only. + + + + + Indicates whether debug info is enabled. Read-only. + + + + + Indicates is use unsafe code. Static property. + + + + + Changes data provider type for all operations after it. Static property. + + + + + If True, no changes were made since last save. + + + + + Returns standard row height in units used by RowRecord. + + + + + Indicates whether evaluation license expired. + + + + + Returns an object that represents the active sheet (the sheet on + top) in the active workbook or in the specified window or workbook. + Returns NULL (Nothing in VB) if no sheet is active. Read-only. + + + + + Returns a Workbook object that represents the workbook in the active + window (the window on top). Read-only. Returns NULL (Nothing in VB) if there are + no windows open or if either the Info window or the Clipboard window + is the active window. + + + + + Used without an object qualifier, this property returns an Application + object that represents the Microsoft Excel application. Used with an + object qualifier, this property returns an Application object that + represents the creator of the specified object (you can use this property + with an OLE Automation object to return that object's application). + Read-only. + + + + + Returns a Workbooks collection that represents all the open workbooks. + Read-only. + + + + + Returns the parent object for the specified object. Read-only. + + + + + Returns or sets the standard font size, in points. Read/write. + + + + + Returns or sets the number of sheets that Microsoft Excel + automatically inserts into new workbooks. Read/write Long. + + + + + Sets or returns the character used for the decimal separator as a + String. Read/write. + + + + + Returns or sets the default path that Microsoft Excel uses when it + opens files. Read/write String. + + + + + Returns the path separator character ("\"). Read-only String. + + + + + Returns or sets the name of the standard font. Read/write String. + + + + + Returns or sets the standard (default) height of all the rows in the worksheet, + in points. Read/write Double. + + + + + Returns or sets the standard (default) height option flag, which defines that + standard (default) row height and book default font height do not match. + Read/write Bool. + + + + + Returns or sets the standard (default) width of all the columns in the + worksheet. Read/write Double. + + + + + Indicates whether to optimize fonts count. This option will + take effect only on workbooks that will be added after setting + this property. + WARNING: Setting this property to True can decrease performance significantly, + but will reduce resulting file size. + + + + + Indicates whether to optimize Import data. This option will + take effect only on Import methods that are available with the worksheet + WARNING: Setting this property to True can decrease memory significantly, + but will increase the performance of data import . + + + + + Gets / sets row separator for array parsing. + + + + + Formula arguments separator. + + + + + Represents CSV Separator. + + + + + Indicates whether to try fast record parsing. + + + + + Gets / sets memory allocation block for single row. Each row will allocate memory block + that can be divided on this number. Smaller value means smaller memory usage but slower + speed when changing cell's value. Default value is 128. That is enough to allocate 9 string records, + or 9 integer numbers (or floating numbers with 1 or 2 digits after decimal point) or 7 double numbers. + + + + + Indicates whether XlsIO should delete destination file before saving into it. + Default value is TRUE. + + + + + Gets / sets default excel version. This value is used in create methods. + + + + + Indicates whether we should use native storage (standard windows COM object) + or our .Net implementation to open excel 97-2003 files. + + + + + Changes data provider type for all operations after it. Static property. + + + + + Indicates whether to preserve the datatypes for the CSV file formats. + + + + + Indicates whether workbook is in parsing process. + + + + + Represents the Chart to Image Converter instance. + Returns null if it is not instantiated. + + + + + Progress event handler. + + + + + This event is fired when user tries to open password protected workbook + without specifying password. It is used to obtain password. + + + + + This event is fired when user specified wrong password when trying to open + password protected workbook. It is used to obtain correct password. + + + + + Default size of autofilter arrow width. + + + + + This text should be added to value of the header of the table to equal the width of the dropdown symbol. + + + + + Intializes the AutoFit Manager + + + + + + + + + + Measures to fit column. + + The graphics. + The first row. + The last row. + The first column. + The last column. + + + + Measures the character ranges. + + The graphics. + The style with text. + The param num. + The rect F. + + + + + Measures the character ranges. + + The graphics. + The style. + The STR text. + The num. + The rect F. + + + + + Collection of DisplayText with matching fonts. + This class used to improve the AutoFitToColumn method + Performance. + + + + + Represents the border of an object. + + + + + Represents the border of an object. + + + + + Returns or sets the primary color of the object. + Read/write ExcelKnownColors. + + + + + Returns or sets the primary color of the object. + Read/write ExcelKnownColors. + + + + + Returns color of the border. + + + + + Returns or sets the line style for the border. Read/write OfficeLineStyle. + + + + + This property is used only by Diagonal borders. For any other border + index property will have no influence. + + + + + Maximum color index that requires modification in order to let MS Excel edit styles. + + + + + Increment for color value in order to let MS Excel edit styles. + + + + + Index of the border. + + + + + Extended format that contains this border. + + + + + Creates a class instance and sets its Application and Parent properties. + + Application object for the Border. + Parent object for the Border. + + + + Creates border with specified index. + + Application object for the border. + Parent object for the border. + Index of border that should be created. + + + + Creates border from ExtendedFormat with specified border index. + + Application object for the border. + Parent object for the border. + + ExtendedFormat that contains all information about required border. + + Border index of the 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. + + + + Serves as a hash function for a particular type, suitable for use + in hashing algorithms and data structures like a hash table. + + A hash code for the current object. + + + + Normalizes border color to let MS Excel edit style. + + Color to normalize. + New color value. + + + + Returns or sets the primary color of the object, as shown in the + following table. Use the RGB function to create a color value. + Read/write Long. + + + + + Returns or sets the primary color of the object, as shown in the + following table. Use the RGB function to create a color value. + Read/write Long. + + + + + Returns or sets the primary color of the object, as shown in the + following table. Use the RGB function to create a color value. + Read/write Color. + + + + + Returns or sets the line style for the border. Read/write OfficeLineStyle. + + + + + This property is used only by Diagonal borders. For any other border + index property will have no influence. + + + + + Returns border index. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + This class represents border for multicell range. + + + + + Cells of the range. + + + + + Border index. + + + + + Parent workbook. + + + + + Creates wrapper for specified range and border index. + + Range for which this wrapper is created. + Border index. + + + + Creates wrapper for specified range and border index. + + Range for which this wrapper is created. + Border index. + + + + Returns or sets the primary color of the object. + Read/write ExcelKnownColors. + + + + + Returns or sets the primary color of the object, as shown in the + following table. Use the RGB function to create a color value. + + + + + Returns or sets the primary color of the object, as shown in the + following table. Use the RGB function to create a color value. + Read/write Long. + + + + + Returns or sets the line style for the border. Read/write OfficeLineStyle. + + + + + This property is used only by Diagonal borders. For any other border + index property will have no influence. + + + + + Worksheet calculation options block. + + + + + Represents the Calculation options in a Excel Workbook. + + + + + Indicates whether R1C1 reference mode is turned on. + + + + + Correct records. + + + + + Specifies whether to calculate formulas manually, automatically, or automatically + except for multiple table operations. + + + + + Specifies the maximum number of times the formulas should be iteratively calculated. + This is a fail-safe against mutually recursive formulas locking up + a spreadsheet application. + + + + + Describes which reference mode to use. + + + + + Tells whether to iterate over formula calculations or not + (if a formula is dependent upon another formula's result) + (odd feature for something that can only have 32 elements in a formula). + + + + + Stores the maximum change of the result to the exit of an iteration. + + + + + Defines whether to recalculate before saving (set to 1). + + + + + Initializes new instance and sets application and parent fields. + + Application object for the page setup. + Parent object for the page setup. + + + + Recovers Page setup from the Biff Records array starting from the position specified. + + Biff Records data. + Position of first PageSetup record - PrintHeadersRecord. + Position after extracting calculation options. + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Indicates whether R1C1 reference mode is turned on. + + + + + Summary description for CellStyle. + + + + + This class wraps extended format inside in order to hide from user + creation of new extended formats when user changes any properties + of extended format. + + + + + Common wrapper code. Implements BeginUpdate and EndUpdate methods. + + + + + This interface describes methods for optimized object update. + + + + + This method should be called before several updates to the object will take place. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the chart title + chart.ChartTitle = "This is a chart Title"; + //Invoke the begin update method + chart.ChartTitleArea.BeginUpdate(); + //Set the bold font style + chart.ChartTitleArea.Bold = true; + //Set the color of the text area + chart.ChartTitleArea.Color = OfficeKnownColors.Plum; + //Invoke end update method + chart.ChartTitleArea.EndUpdate(); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Set the chart title + chart.ChartTitle = "This is a chart Title" + 'Invoke the begin update method + chart.ChartTitleArea.BeginUpdate() + 'Set the bold font style + chart.ChartTitleArea.Bold = True + 'Set the color of the text area + chart.ChartTitleArea.Color = OfficeKnownColors.Plum + 'Invoke end update method + chart.ChartTitleArea.EndUpdate() + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + This method should be called after several updates to the object took place. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the chart title + chart.ChartTitle = "This is a chart Title"; + //Invoke the begin update method + chart.ChartTitleArea.BeginUpdate(); + //Set the bold font style + chart.ChartTitleArea.Bold = true; + //Set the color of the text area + chart.ChartTitleArea.Color = OfficeKnownColors.Plum; + //Invoke end update method + chart.ChartTitleArea.EndUpdate(); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Set the chart title + chart.ChartTitle = "This is a chart Title" + 'Invoke the begin update method + chart.ChartTitleArea.BeginUpdate() + 'Set the bold font style + chart.ChartTitleArea.Bold = True + 'Set the color of the text area + chart.ChartTitleArea.Color = OfficeKnownColors.Plum + 'Invoke end update method + chart.ChartTitleArea.EndUpdate() + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Number of begin update calls that have no corresponding end update. + + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object. + + + + + Creates a copy of the current object. + + Parent object for the new object. + A copy of the current object. + + + + Returns number of begin update calls that have no corresponding end update. Read-only. + + + + + Summary description for IInternalExtendedFormat. + + + + + Contains the font attributes (font name, size, + color, and so on) for an object. + + + + + Returns borders object for this extended format. + + + + + Gets / Sets index of fill background color. Obsolete, will be removed in next release. + + + + + Gets / Sets fill background color. Obsolete, will be removed in next release. + + + + + Gets / Sets index of fill foreground color. Obsolete, will be removed in next release. + + + + + Gets / Sets fill foreground color. Obsolete, will be removed in next release. + + + + + Gets / Sets fill pattern. + + + + + Returns font object for this extended format. + + + + + True if formula is hidden. + + + + + Horizontal alignment. + + + + + True if the style includes the AddIndent, HorizontalAlignment, + VerticalAlignment, WrapText, and Orientation properties. + Read / write Boolean. + + + + + True if the style includes the Color, ColorIndex, LineStyle, + and Weight border properties. Read / write Boolean. + + + + + True if the style includes the Background, Bold, Color, + ColorIndex, FontStyle, Italic, Name, OutlineFont, Shadow, + Size, Strikethrough, Subscript, Superscript, and Underline + font properties. Read / write Boolean. + + + + + True if the style includes the NumberFormat property. + Read / write Boolean. + + + + + True if the style includes the Color, ColorIndex, + InvertIfNegative, Pattern, PatternColor, and PatternColorIndex + interior properties. Read / write Boolean. + + + + + True if the style includes the FormulaHidden and Locked protection + properties. Read / write Boolean. + + + + + Indent level. + + + + + If true then first symbol in cell is apostrophe. + + + + + True if cell is locked. + + + + + For far east languages. Supported only for format. Always 0 for US. + + + + + Returns or sets the format code for the object. Read / write String. + + + + + Gets / Sets format index. + + + + + Returns or sets the format code for the object as a string in the + language of the user. Read / write String. + + + + + Text direction, the reading order for far east versions. + + + + + Text rotation angle: + 0 Not rotated + 1-90 1 to 90 degrees counterclockwise + 91-180 1 to 90 degrees clockwise + 255 Letters are stacked top-to-bottom, but not rotated. + + Thrown when value is more than 0xFF. + + + + True - shrink content to fit into cell. + + + + + Vertical alignment. + + + + + True - Text is wrapped at right border. + + + + + Returns or sets the color of the interior pattern as an index into the current color palette. + + + + + Returns or sets the color of the interior pattern as an Color value. + + + + + Returns or sets the color of the interior. The color is specified as + an index value into the current color palette. + + + + + Returns or sets the cell shading color. + + + + + Gets value indicating whether format was modified, compared to parent format. + + + + + Returns the Cell has border + + + + + Starts updating process. + + + + + Ends updating process. + + + + + Get/set BottomBorder color. + + + + + Get/set TopBorder color. + + + + + Get/set LeftBorder color. + + + + + Get/set RightBorder color. + + + + + Get/set DiagonalUpBorder color. + + + + + Gets / sets line style of the left border. + + + + + Gets / sets line style of the right border. + + + + + Gets / sets line style of the top border. + + + + + Gets / sets line style of the bottom border. + + + + + Gets / sets line style of the diagonal border. + + + + + Gets / sets line style of the diagonal border. + + + + + Indicates whether DiagonalUp line is visible. + + + + + Indicates whether DiagonalDown line is visible. + + + + + Parent workbook. + + + + + Summary description for IXFIndex. + + + + + Gets format index in m_book.InnerFormats. + + + + + Represents a style description for a range. The Style object contains + all style attributes (font, number format, alignment, and so on) as + properties. There are several built-in styles, including Normal, + Currency, and Percent. Using the Style object is a fast and efficient + way to change several cell-formatting properties on multiple cells at + the same time. + For the Workbook object, the Style object is a member of the Styles + collection. The Styles collection contains all the defined styles for + the workbook + + + + + True if the style is a built-in style. Read-only Boolean. + + + + + Returns or sets the name of the object. Read-only String. + + + + + Indicates whether style is initialized (differs from Normal style). + Read-only. + + + + + Returns interior object for this extended format. + + + + + Extended format with style settings. + + + + + Parent workbook. + + + + + Font wrapper. + + + + + Borders collection. + + + + + Interior wrapper. + + + + + Creates new instance of extended format wrapper. + + + + + Creates new instance of extended format wrapper. + + Parent workbook. + Index of extended format to wrap. + + + + Sets solid fill pattern when changing + + + + + Creates inner extended format. + + Index to extended format to wrap. + + + + Updates inner extended format's font wrapper. + + + + + Searches for all necessary parent objects. + + Parent object. + + + + Sets Saved flag of the parent workbook to the False. + Called when any changes occurred in the style. + + + + + Event handler for font AfterChange event. + + Event sender. + Event arguments. + + + + Event handler for interior AfterChange event. + + Event sender. + Event arguments. + + + + This method is called after changes in NumberFormat. + + + + + + + + + + + + This method is called before reading any value. Can be used + to update wrapped object before read operation. + + + + + Gets style object either from parent or from this instance if it has no parent. + + Parent style object. + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Returns parent workbook. Read-only. + + + + + Gets / Sets fill pattern. + + + + + Gets format index in m_book.InnerFormats. + + + + + Gets / Sets index of fill background color. + + + + + Gets / Sets fill background color. + + + + + Gets / Sets index of fill foreground color. + + + + + Gets / Sets fill foreground color. + + + + + Gets / Sets format index. + + + + + Horizontal alignment. + + + + + True if the style includes the AddIndent, HorizontalAlignment, + VerticalAlignment, WrapText, and Orientation properties. + Read / write Boolean. + + + + + True if the style includes the Color, ColorIndex, LineStyle, + and Weight border properties. Read / write Boolean. + + + + + True if the style includes the Background, Bold, Color, + ColorIndex, FontStyle, Italic, Name, OutlineFont, Shadow, + Size, Strikethrough, Subscript, Superscript, and Underline + font properties. Read / write Boolean. + + + + + True if the style includes the NumberFormat property. + Read / write Boolean. + + + + + True if the style includes the Color, ColorIndex, + InvertIfNegative, Pattern, PatternColor, and PatternColorIndex + interior properties. Read / write Boolean. + + + + + True if the style includes the FormulaHidden and Locked protection + properties. Read / write Boolean. + + + + + Indent level. + + + + + True if formula is hidden. + + + + + True if cell is locked. + + + + + For far east languages. Supported only for format. Always 0 for US. + + + + + Returns or sets the format code for the object. Read / write String. + + + + + Returns or sets the format code for the object as a string in the + language of the user. Read / write String. + + + + + Text direction, the reading order for far east versions. + + + + + Text rotation angle: + 0 Not rotated + 1-90 1 to 90 degrees counterclockwise + 91-180 1 to 90 degrees clockwise + 255 Letters are stacked top-to-bottom, but not rotated. + + Thrown when value is more than 0xFF. + + + + True - shrink content to fit into cell. + + + + + Vertical alignment. + + + + + True - Text is wrapped at right border. + + + + + Returns font object for this extended format. + + + + + Returns borders object for this extended format. + + + + + If true then first symbol in cell is apostrophe. + + + + + Returns or sets the color of the interior pattern as an index into the current color palette. + + + + + Returns or sets the color of the interior pattern as an Color value. + + + + + Returns or sets the color of the interior. The color is specified as + an index value into the current color palette. + + + + + Returns or sets the cell shading color. + + + + + Returns interior object for this extended format. + + + + + Gets value indicating whether format was modified, compared to parent format. + + + + + Gets / Sets font index. + + + + + Returns wrapped format. + + + + + Get/set BottomBorder color. + + + + + Get/set TopBorder color. + + + + + Get/set LeftBorder color. + + + + + Get/set RightBorder color. + + + + + Get/set DiagonalUpBorder color. + + + + + Gets / sets line style of the left border. + + + + + Gets / sets line style of the right border. + + + + + Gets / sets line style of the top border. + + + + + Gets / sets line style of the bottom border. + + + + + Gets / sets line style of the diagonal border. + + + + + Gets / sets line style of the diagonal border. + + + + + Indicates whether DiagonalUp line is visible. + + + + + Indicates whether DiagonalDown line is visible. + + + + + Event is raised after changes in number format. + + + + + Reference to Application which hosts all objects. Read-only. + + + + + Reference to Parent object. Read-only. + + + + + Indicates whether style is build in. Read-only. + + + + + Returns name of the style. Read-only. + + + + + Indicates whether style is initialized (differs from Normal style). + Read-only. + + + + + Parent range. + + + + + Represents whether to get adjacent or not + + + + + Creates new instance of cell style. + + Parent range. + Index of extended format to wrap. + + + + This method is called before changes in extended format. + + + + + This method is called after changes in extended format. + + + + + Searches for all necessary parent objects. + + Parent object. + + + + This method is called before reading any value. Can be used + to update wrapped object before read operation. + + + + + Gets line style of the left border. + + + + + + + Gets line style of the right border. + + + + + + + Gets line style of the top border. + + + + + + + Get line style of the bottom border. + + + + + + + Gets line color of the left border. + + + + + + + Gets line color of the right border. + + + + + + + Gets line color of the top border. + + + + + + + Get line color of the bottom border. + + + + + + + Gets left adjecent cell. + + + + + + Gets rigth adjecent cell. + + + + + + Gets top adjecent cell. + + + + + + Gets bottom adjecent cell. + + + + + + Gets relative cell. + + + + + + + + Get/set LeftBorder color. + + + + + Get/set RightBorder color. + + + + + Get/set TopBorder color. + + + + + Get/set BottomBorder color. + + + + + Gets / sets line style of the left border. + + + + + Gets / sets line style of the right border. + + + + + Gets / sets line style of the top border. + + + + + Gets / sets line style of the top border. + + + + + Gets or sets a boolean value + whether to get adjacent or not + + + + + Class used for Chart Axis implementation. + + + + + Represents an axis in a chart. + + + + + Gets or sets the format code for the axis values. + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Create an instance of chart axis + //Set the number format of axis + chartAxis.NumberFormat = "Number"; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart= TryCast(slide.Shapes(0), IPresentationChart) + 'Create an instance of chart axis + 'Set the number format of axis + chartAxis.NumberFormat = "Number" + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the axis type. Read-only. + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Create an instance of chart axis + IOfficeChartAxis chartAxis = chart.PrimaryValueAxis; + //Get the chart axis type, read only + OfficeAxisType axisType = chartAxis.AxisType; + //Enable reverse plot order + chartAxis.ReversePlotOrder = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart= TryCast(slide.Shapes(0), IPresentationChart) + 'Create an instance of chart axis + Dim chartAxis As IOfficeChartAxis = chart.PrimaryValueAxis + 'Get the chart axis type, read only + Dim axisType As OfficeAxisType = chartAxis.AxisType + 'Enable reverse plot order + chartAxis.ReversePlotOrder = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the axis title. + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Create an instance of chart axis + IOfficeChartAxis chartAxis = chart.PrimaryValueAxis; + chartAxis.ReversePlotOrder = true; + //Set the text rotation angle + chartAxis.TextRotationAngle = 30; + //Set the title + chartAxis.Title = "Chart Axis"; + //Set the font style for title area + chartAxis.TitleArea.Bold = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart= TryCast(slide.Shapes(0), IPresentationChart) + 'Create an instance of chart axis + Dim chartAxis As IOfficeChartAxis = chart.PrimaryValueAxis + chartAxis.ReversePlotOrder = True + 'Set the text rotation angle + chartAxis.TextRotationAngle = 30 + 'Set the title + chartAxis.Title = "Chart Axis" + 'Set the font style for title area + chartAxis.TitleArea.Bold = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the text rotation angle. Should be integer value between -90 and 90. + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Create an instance of chart axis + IOfficeChartAxis chartAxis = chart.PrimaryValueAxis; + chartAxis.ReversePlotOrder = true; + //Set the text rotation angle + chartAxis.TextRotationAngle = 50; + //Set the title + chartAxis.Title = "Chart Axis"; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart= TryCast(slide.Shapes(0), IPresentationChart) + 'Create an instance of chart axis + Dim chartAxis As IOfficeChartAxis = chart.PrimaryValueAxis + chartAxis.ReversePlotOrder = True + 'Set the text rotation angle + chartAxis.TextRotationAngle = 30 + 'Set the title + chartAxis.Title = "Chart Axis" + 'Set the font style for title area + chartAxis.TitleArea.Bold = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets text area for the axis title. Read-only. + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Create an instance of chart axis + IOfficeChartAxis chartAxis = chart.PrimaryValueAxis; + chartAxis.ReversePlotOrder = true; + //Set the text rotation angle + chartAxis.TextRotationAngle = 30; + //Set the title + chartAxis.Title = "Chart Axis"; + //Set the font style for title area + chartAxis.TitleArea.Bold = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart= TryCast(slide.Shapes(0), IPresentationChart) + 'Create an instance of chart axis + Dim chartAxis As IOfficeChartAxis = chart.PrimaryValueAxis + chartAxis.ReversePlotOrder = True + 'Set the text rotation angle + chartAxis.TextRotationAngle = 30 + 'Set the title + chartAxis.Title = "Chart Axis" + 'Set the font style for title area + chartAxis.TitleArea.Bold = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets a Font object that represents character formatting. Read-only. + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Create an instance of chart axis + IOfficeChartAxis chartAxis = chart.PrimaryValueAxis; + //Set auto tick label spacing + chartAxis.AutoTickLabelSpacing = true; + //Set the border of chart axis + chartAxis.Border.LineWeight = OfficeChartLineWeight.Medium; + //Set 3D options for chart + chartAxis.Chart3DOptions.BevelBottomWidth = 200; + //Set the font color for chart axis + chartAxis.Font.Color = OfficeKnownColors.Lavender; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart= TryCast(slide.Shapes(0), IPresentationChart) + 'Create an instance of chart axis + Dim chartAxis As IOfficeChartAxis = chart.PrimaryValueAxis + 'Set auto tick label spacing + chartAxis.AutoTickLabelSpacing = True + 'Set the border of chart axis + chartAxis.Border.LineWeight = OfficeChartLineWeight.Medium + 'Set 3D options for chart + chartAxis.Chart3DOptions.BevelBottomWidth = 200 + 'Set the font color for chart axis + chartAxis.Font.Color = OfficeKnownColors.Lavender + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the major gridlines for the axis. Read-only + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Create an instance of chart axis + IOfficeChartAxis chartAxis = chart.PrimaryValueAxis; + //Set major gridline + chartAxis.HasMajorGridLines = true; + //Get the major gridline of chart axis, read only + IOfficeChartGridLine gridline = chartAxis.MajorGridLines; + //Set border of major grid line + gridline.Border.AutoFormat = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation__1.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Create an instance of chart axis + Dim chartAxis As IOfficeChartAxis = chart.PrimaryValueAxis + 'Set major gridline + chartAxis.HasMajorGridLines = True + 'Get the major gridline of chart axis, read only + Dim gridline As IOfficeChartGridLine = chartAxis.MajorGridLines + 'Set border of major grid line + gridline.Border.AutoFormat = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the minor gridlines for the axis. Read-only + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Create an instance of chart axis + IOfficeChartAxis chartAxis = chart.PrimaryValueAxis; + //Set minor gridline + chartAxis.HasMinorGridLines = true; + //Get the minor gridline of chart axis, read only + IOfficeChartGridLine gridline = chartAxis.MinorGridLines; + //Set border of minor grid line + gridline.Border.AutoFormat = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation__1.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Create an instance of chart axis + Dim chartAxis As IOfficeChartAxis = chart.PrimaryValueAxis + 'Set minor gridline + chartAxis.HasMinorGridLines = True + 'Get the minor gridline of chart axis, read only + Dim gridline As IOfficeChartGridLine = chartAxis.MinorGridLines + 'Set border of minor grid line + gridline.Border.AutoFormat = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that indicates the axis has minor gridlines. + + True If the axis has minor gridlines.Otherwise False + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Create an instance of chart axis + IOfficeChartAxis chartAxis = chart.PrimaryValueAxis; + //Set 3D options for chart + chartAxis.Chart3DOptions.BevelBottomWidth = 200; + //Set the font color for chart axis + chartAxis.Font.Color = OfficeKnownColors.Lavender; + //Set the minor grid lines + chartAxis.HasMinorGridLines = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation__1.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Create an instance of chart axis + Dim chartAxis As IOfficeChartAxis = chart.PrimaryValueAxis + 'Set 3D options for chart + chartAxis.Chart3DOptions.BevelBottomWidth = 200 + 'Set the font color for chart axis + chartAxis.Font.Color = OfficeKnownColors.Lavender + 'Set the minor grid lines + chartAxis.HasMinorGridLines = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that indicates the axis has major gridlines. + + True If the axis has major gridlines.Otherwise False + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Create an instance of chart axis + IOfficeChartAxis chartAxis = chart.PrimaryValueAxis; + //Set minor gridline + chartAxis.HasMinorGridLines = true; + //Set the font color for chart axis + chartAxis.Font.Color = OfficeKnownColors.Lavender; + //Set the major gridlines + chartAxis.HasMajorGridLines = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation__1.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Create an instance of chart axis + Dim chartAxis As IOfficeChartAxis = chart.PrimaryValueAxis + 'Set minor gridline + chartAxis.HasMinorGridLines = True + 'Set the font color for chart axis + chartAxis.Font.Color = OfficeKnownColors.Lavender + 'Set the major gridlines + chartAxis.HasMajorGridLines = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the type of minor tick mark for the axis. + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Create an instance of chart axis + IOfficeChartAxis chartAxis = chart.PrimaryValueAxis; + //Set the border of chart axis + chartAxis.Border.LineWeight = OfficeChartLineWeight.Medium; + //Set 3D options for chart + chartAxis.Chart3DOptions.BevelBottomWidth = 200; + //Set the font color for chart axis + chartAxis.Font.Color = OfficeKnownColors.Lavender; + //Set the minor tick mark + chartAxis.MinorTickMark = OfficeTickMark.TickMark_Outside; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation__1.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Create an instance of chart axis + Dim chartAxis As IOfficeChartAxis = chart.PrimaryValueAxis + 'Set the border of chart axis + chartAxis.Border.LineWeight = OfficeChartLineWeight.Medium + 'Set 3D options for chart + chartAxis.Chart3DOptions.BevelBottomWidth = 200 + 'Set the font color for chart axis + chartAxis.Font.Color = OfficeKnownColors.Lavender + 'Set the minor tick mark + chartAxis.MinorTickMark = OfficeTickMark.TickMark_Outside + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the type of major tick mark for the axis. + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Create an instance of chart axis + IOfficeChartAxis chartAxis = chart.PrimaryValueAxis; + //Set the border of chart axis + chartAxis.Border.LineWeight = OfficeChartLineWeight.Medium; + //Set 3D options for chart + chartAxis.Chart3DOptions.BevelBottomWidth = 200; + //Set the font color for chart axis + chartAxis.Font.Color = OfficeKnownColors.Lavender; + //Set the major tick mark + chartAxis.MajorTickMark = OfficeTickMark.TickMark_Inside; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation__1.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Create an instance of chart axis + Dim chartAxis As IOfficeChartAxis = chart.PrimaryValueAxis + 'Set the border of chart axis + chartAxis.Border.LineWeight = OfficeChartLineWeight.Medium + 'Set 3D options for chart + chartAxis.Chart3DOptions.BevelBottomWidth = 200 + 'Set the font color for chart axis + chartAxis.Font.Color = OfficeKnownColors.Lavender + 'Set the major tick mark + chartAxis.MajorTickMark = OfficeTickMark.TickMark_Inside + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets border of the axis. Read-only. + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Create an instance of chart axis + IOfficeChartAxis chartAxis = chart.PrimaryValueAxis; + //Set auto tick label spacing + chartAxis.AutoTickLabelSpacing = true; + //Set the border of chart axis + chartAxis.Border.LineWeight = OfficeChartLineWeight.Medium; + //Set 3D options for chart + chartAxis.Chart3DOptions.BevelBottomWidth = 200; + //Set the font color for chart axis + chartAxis.Font.Color = OfficeKnownColors.Lavender; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart= TryCast(slide.Shapes(0), IPresentationChart) + 'Create an instance of chart axis + Dim chartAxis As IOfficeChartAxis = chart.PrimaryValueAxis + 'Set auto tick label spacing + chartAxis.AutoTickLabelSpacing = True + 'Set the border of chart axis + chartAxis.Border.LineWeight = OfficeChartLineWeight.Medium + 'Set 3D options for chart + chartAxis.Chart3DOptions.BevelBottomWidth = 200 + 'Set the font color for chart axis + chartAxis.Font.Color = OfficeKnownColors.Lavender + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets a value that indicates the tick label position is automatic or not + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Create an instance of chart axis + IOfficeChartAxis chartAxis = chart.PrimaryValueAxis; + //Set auto tick label spacing + chartAxis.AutoTickLabelSpacing = true; + //Set the border of chart axis + chartAxis.Border.LineWeight = OfficeChartLineWeight.Medium; + //Set 3D options for chart + chartAxis.Chart3DOptions.BevelBottomWidth = 200; + //Set the font color for chart axis + chartAxis.Font.Color = OfficeKnownColors.Lavender; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart= TryCast(slide.Shapes(0), IPresentationChart) + 'Create an instance of chart axis + Dim chartAxis As IOfficeChartAxis = chart.PrimaryValueAxis + 'Set auto tick label spacing + chartAxis.AutoTickLabelSpacing = True + 'Set the border of chart axis + chartAxis.Border.LineWeight = OfficeChartLineWeight.Medium + 'Set 3D options for chart + chartAxis.Chart3DOptions.BevelBottomWidth = 200 + 'Set the font color for chart axis + chartAxis.Font.Color = OfficeKnownColors.Lavender + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the position of tick-mark labels on the axis. + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Create an instance of chart axis + IOfficeChartAxis chartAxis = chart.PrimaryValueAxis; + //Set the tick label position + chartAxis.TickLabelPosition = OfficeTickLabelPosition.TickLabelPosition_NextToAxis; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation__1.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Create an instance of chart axis + Dim chartAxis As IOfficeChartAxis = chart.PrimaryValueAxis + 'Set the tick label position + chartAxis.TickLabelPosition = OfficeTickLabelPosition.TickLabelPosition_NextToAxis + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that indicates axis is visible or not. + + True If axis visible. Otherwise False + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Create an instance of chart axis + IOfficeChartAxis chartAxis = chart.PrimaryValueAxis; + //Hide the visibility of chart axis + chartAxis.Visible = false; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation__1.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Create an instance of chart axis + Dim chartAxis As IOfficeChartAxis = chart.PrimaryValueAxis + 'Hide the visibility of chart axis + chartAxis.Visible = False + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets How to plots data points in the axis.True if plots data points from last to first. + + True if plots data points from last to first.Otherwise False + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Create an instance of chart axis + IOfficeChartAxis chartAxis = chart.PrimaryValueAxis; + //Get the chart axis type, read only + OfficeAxisType axisType = chartAxis.AxisType; + //Enable reverse plot order + chartAxis.ReversePlotOrder = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart= TryCast(slide.Shapes(0), IPresentationChart) + 'Create an instance of chart axis + Dim chartAxis As IOfficeChartAxis = chart.PrimaryValueAxis + 'Get the chart axis type, read only + Dim axisType As OfficeAxisType = chartAxis.AxisType + 'Enable reverse plot order + chartAxis.ReversePlotOrder = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets shadow formatting properties for the chart element. Read-only + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Create an instance of chart axis + IOfficeChartAxis chartAxis = chart.PrimaryValueAxis; + //Get the shadow od axis + IShadow shadow = chartAxis.Shadow; + //Set the shadow color + shadow.ShadowColor = Color.Brown; + //Set the shadow angle + shadow.Angle = 87; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation__1.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Create an instance of chart axis + Dim chartAxis As IOfficeChartAxis = chart.PrimaryValueAxis + 'Get the shadow od axis + Dim shadow As IShadow = chartAxis.Shadow + 'Set the shadow color + shadow.ShadowColor = Color.Brown + 'Set the shadow angle + shadow.Angle = 87 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the 3-D�effect formatting properties for the specified chart. Read-only + + The three_ D. + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Create an instance of chart axis + IOfficeChartAxis chartAxis = chart.PrimaryValueAxis; + //Set the border of chart axis + chartAxis.Border.LineWeight = OfficeChartLineWeight.Medium; + //Set 3D options for chart + chartAxis.Chart3DOptions.BevelBottomWidth = 200; + //Set the font color for chart axis + chartAxis.Font.Color = OfficeKnownColors.Lavender; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart= TryCast(slide.Shapes(0), IPresentationChart) + 'Create an instance of chart axis + Dim chartAxis As IOfficeChartAxis = chart.PrimaryValueAxis + 'Set auto tick label spacing + chartAxis.AutoTickLabelSpacing = True + 'Set the border of chart axis + chartAxis.Border.LineWeight = OfficeChartLineWeight.Medium + 'Set 3D options for chart + chartAxis.Chart3DOptions.BevelBottomWidth = 200 + 'Set the font color for chart axis + chartAxis.Font.Color = OfficeKnownColors.Lavender + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Represents default number format index; + + + + + Represents index to general format. + + + + + True if chart category label text wrapped, false as default. + + + + + Type of the axis. + + + + + True if this is the primary axis; false if secondary. + + + + + Text area for the axis title. + + + + + Chart tick record for this axis. + + + + + Represents Shadow + + + + + Indicates whether line format is present. + + + + + Font used for axis drawing. + + + + + Font used to store the default font used with axis drawing. + + + + + Represents major grid. + + + + + Represents minor grid. + + + + + Represents if axis has major gridlines. + + + + + Represents if axis has minor gridlines. + + + + + Represents parent axis. + + + + + Represents format index. + + + + + Represents border axis. + + + + + Represents text direction. + + + + + Axis id. + + + + + Inidicates whether axis was deleted. + + + + + Indicates whether tick label spacing value is automatically evaluated. + + + + + Indicates whether TickMarkSpacing has automatic value. + + + + + Stores label alignment setting. + + + + + Stores label text alignment setting. + + + + + Represents the 3D features + + + + + Represents the TextArea Paragraph + + + + + Represents the frame format of Axis + + + + + Creates axis of specified type and specified IsPrimary value. + + Application object for the axis. + Parent object for the axis. + Type of the new axis. + + True if primary axis should be created; otherwise False. + + + + + Finds parent objects. + + + + + Sets some important variables to the initial state. + + + + + Initializes internal tick record. + + + + + Clone current object. + + Parent object. + Dictionary with new indexes. + Dictionary with new worksheet names. + Returns cloned object. + + + + Updates surface tick record. + + Represents value type. + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Initializes frame format. + + + + + Creates frame format. + + Newly created frame format. + + + + Set the border on this object + + the input border + + + + Gets and sets the indicate whether the chart category label text wrapped, false default. + + + + + Type of the axis. + + + + + True if this is primary axis; False if secondary. + + + + + Title of the axis. + + + + + Text rotation angle. Should be integer value between -90 and 90. + + + + + Gets value indicating whether text rotation angle is autoselected. + + + + + Returns text area for the axis title. Read-only. + + + + + Returns font used for axis text displaying. Read-only. + + + + + Gets or Sets the value indicating whether the aixs font settings are applied from the chart default font settings. + + + + + Returns major gridLines. Read-only. + + + + + Returns minor gridLines. Read-only. + + + + + Gets or sets if axis has minor gridlines. + + + + + Gets or sets if axis has major gridlines. + + + + + Returns chart parent axis. Read-only. + + + + + Gets or sets format index. + + + + + Gets or sets number format string. + + + + + Represents minor tick marks. + + + + + Represents major tick marks. + + + + + Represents chart border. Read-only. + + + + + Represents tick label position. + + + + + Indicates is axis is visible. + + + + + Represents alignment for the tick label. + + + + + True if plots data points from last to first. + + + + + Returns axis id. + + + + + Returns parent chart object. Read-only. + + + + + Gets or Sets the value indicating whether axis was deleted. + + + + + Represents the Shadow.Read-only + + + + + Represents Shadow Propertes.Read-Only + + + + + This property indicates whether the shadow object has been created + + + + + Gets the chart3 D options. + + The chart3 D options. + + + + Gets the chart3 D properties. + + The chart3 D properties. + + + + This property Indicates whether the Shadow object has been created(which includes the 3D properties) + + + + + Return frame format of Axis. Read-only. + + + + + Indicates wheather the axis has title + + + + + Represents the TextArea Paragraph + + + + + Represents the Default Text Settings + + + + + Represents label text alignment setting + + + + + Creates title area. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + Represents chart border object. + + + + + Represents the border of an object. + + + + + Gets or sets the Color of the line. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the chart area border + IOfficeChartBorder chartAreaBorder = chart.ChartArea.Border; + //Enable auto line color + chartAreaBorder.IsAutoLineColor = false; + //Set the line color + chartAreaBorder.LineColor = System.Drawing.Color.CornflowerBlue; + //Set the line pattern + chartAreaBorder.LinePattern = OfficeChartLinePattern.DashDotDot; + //Set the line weight + chartAreaBorder.LineWeight = OfficeChartLineWeight.Wide; + //Set the transparency of border + chartAreaBorder.Transparency = 0.8; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the chart area border + Dim chartAreaBorder As IOfficeChartBorder = chart.ChartArea.Border + 'Enable auto line color + chartAreaBorder.IsAutoLineColor = False + 'Set the line color + chartAreaBorder.LineColor = System.Drawing.Color.CornflowerBlue + 'Set the line pattern + chartAreaBorder.LinePattern = OfficeChartLinePattern.DashDotDot + 'Set the line weight + chartAreaBorder.LineWeight = OfficeChartLineWeight.Wide + 'Set the transparency of border + chartAreaBorder.Transparency = 0.8 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the Line pattern for the border. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the chart area border + IOfficeChartBorder chartAreaBorder = chart.ChartArea.Border; + //Enable auto line color + chartAreaBorder.IsAutoLineColor = false; + //Set the line color + chartAreaBorder.LineColor = System.Drawing.Color.CornflowerBlue; + //Set the line pattern + chartAreaBorder.LinePattern = OfficeChartLinePattern.DashDotDot; + //Set the line weight + chartAreaBorder.LineWeight = OfficeChartLineWeight.Wide; + //Set the transparency of border + chartAreaBorder.Transparency = 0.8; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the chart area border + Dim chartAreaBorder As IOfficeChartBorder = chart.ChartArea.Border + 'Enable auto line color + chartAreaBorder.IsAutoLineColor = False + 'Set the line color + chartAreaBorder.LineColor = System.Drawing.Color.CornflowerBlue + 'Set the line pattern + chartAreaBorder.LinePattern = OfficeChartLinePattern.DashDotDot + 'Set the line weight + chartAreaBorder.LineWeight = OfficeChartLineWeight.Wide + 'Set the transparency of border + chartAreaBorder.Transparency = 0.8 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the Weight of the line. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the chart area border + IOfficeChartBorder chartAreaBorder = chart.ChartArea.Border; + //Enable auto line color + chartAreaBorder.IsAutoLineColor = false; + //Set the line color + chartAreaBorder.LineColor = System.Drawing.Color.CornflowerBlue; + //Set the line pattern + chartAreaBorder.LinePattern = OfficeChartLinePattern.DashDotDot; + //Set the line weight + chartAreaBorder.LineWeight = OfficeChartLineWeight.Wide; + //Set the transparency of border + chartAreaBorder.Transparency = 0.8; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the chart area border + Dim chartAreaBorder As IOfficeChartBorder = chart.ChartArea.Border + 'Enable auto line color + chartAreaBorder.IsAutoLineColor = False + 'Set the line color + chartAreaBorder.LineColor = System.Drawing.Color.CornflowerBlue + 'Set the line pattern + chartAreaBorder.LinePattern = OfficeChartLinePattern.DashDotDot + 'Set the line weight + chartAreaBorder.LineWeight = OfficeChartLineWeight.Wide + 'Set the transparency of border + chartAreaBorder.Transparency = 0.8 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that indicates the border format as automatic or custom. + + True if border has automatic format.Otherwise False. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the chart area border + IOfficeChartBorder chartAreaBorder = chart.ChartArea.Border; + //Set the auto format + chartAreaBorder.AutoFormat = false; + //Set the color index of chart area border + chartAreaBorder.ColorIndex = OfficeKnownColors.Light_orange; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the chart area border + Dim chartAreaBorder As IOfficeChartBorder = chart.ChartArea.Border + 'Set the auto format + chartAreaBorder.AutoFormat = False + 'Set the color index of chart area border + chartAreaBorder.ColorIndex = OfficeKnownColors.Light_orange + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets whether the line color is automatic. + + True if the line color is auto.Otherwise False + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the chart area border + IOfficeChartBorder chartAreaBorder = chart.ChartArea.Border; + //Enable auto line color + chartAreaBorder.IsAutoLineColor = false; + //Set the line color + //chartAreaBorder.LineColor = Color.Chocolate; + //Set the line pattern + chartAreaBorder.LinePattern = OfficeChartLinePattern.DashDotDot; + //Set the line weight + chartAreaBorder.LineWeight = OfficeChartLineWeight.Wide; + //Set the transparency of border + chartAreaBorder.Transparency = 0.8; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the chart area border + Dim chartAreaBorder As IOfficeChartBorder = chart.ChartArea.Border + 'Enable auto line color + chartAreaBorder.IsAutoLineColor = False + 'Set the line color + 'chartAreaBorder.LineColor = Color.Chocolate; + 'Set the line pattern + chartAreaBorder.LinePattern = OfficeChartLinePattern.DashDotDot + 'Set the line weight + chartAreaBorder.LineWeight = OfficeChartLineWeight.Wide + 'Set the transparency of border + chartAreaBorder.Transparency = 0.8 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the color of the border. + + The color is specified as an index value into the current color palette. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the chart area border + IOfficeChartBorder chartAreaBorder = chart.ChartArea.Border; + //Set the color index of chart area border + chartAreaBorder.ColorIndex = OfficeKnownColors.Light_orange; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the chart area border + Dim chartAreaBorder As IOfficeChartBorder = chart.ChartArea.Border + 'Set the color index of chart area border + chartAreaBorder.ColorIndex = OfficeKnownColors.Light_orange + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the transparency level of the specified Solid color shaded fill as a floating-point + value from 0.0 (Clear) through 1.0(Opaque) + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the chart area border + IOfficeChartBorder chartAreaBorder = chart.ChartArea.Border; + //Set the color index of chart area border + chartAreaBorder.ColorIndex = OfficeKnownColors.Light_orange; + //Set the transparency of border + chartAreaBorder.Transparency = 0.8; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the chart area border + Dim chartAreaBorder As IOfficeChartBorder = chart.ChartArea.Border + 'Set the color index of chart area border + chartAreaBorder.ColorIndex = OfficeKnownColors.Light_orange + 'Set the transparency of border + chartAreaBorder.Transparency = 0.8 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Get or set the begin arrow style. + + + + + Get or set the end arrow style. + + + + + Get or set the begin arrow length. + + + + + Get or set end arrow length. + + + + + Represents default color index. + + + + + Line format. + + + + + Represents parent workbook. + + + + + Represents parent Series format. + + + + + Represents line color. + + + + + Represents the default transparency level for the solid type + + + + + Preserve Gradient Stops (Supported in Excel 2007 and higher) + + + + + border edge join type + + + + + Represents begin arrow style. + + + + + Represents end arrow style. + + + + + Represents begin arrow length. + + + + + Represents end arrow length. + + + + + + + + + + Indicates the cap styles of the line + + + + + Indicated the line style. + + + + + Creates new instance of class. + + Represents current application. + Represents parent object. + + + + Creates new instance of class. + + Represents current application. + Represents parent object. + Represents line record. + + + + Parsing current object. + + Records offset. + Position in offset. + + + + Finds parent objects. + + + + + Updates internal record for Excel97 file format. + + + + + Check whether the serie Format is available, if it update auto color + Only to be called on auto format is false + + + + + Clones current object. + + Represents parent object. + Returns cloned object. + + + + Makes complete copy of the current object and updates its parent. + + Parent object to set. + Cloned object. + + + + Color of line. + + + + + Get or set the BeginArrowType + + + + + Indicates the cap styles of the line + + + + + Get or set the EndArrowType + + + + + Get or set the BeginArrowSize + + + + + Get or set the EndArrowSize + + + + + Line pattern. + + + + + Weight of line. + + + + + preserve fill and gradient stops (Supported in Excel 2007 and higher) + + + + + indicates whether the line filled with gradient fill + + + + + Border edge join type + + + + + If true - default format; otherwise custom. + + + + + True to draw tick labels on this axis. + + + + + Custom format for line color. + + + + + Line color index. + + + + + Returns border color object. Read-only. + + + + + Returns the transparency level of the specified Solid color shaded fill as a floating-point + value from 0.0 (light) through 1.0(dark) + + + + + Gets or sets the line weight string. + + The line weight string. + + + + Gets or sets the line style type. + + + + + Represents the chart category + + + + + Gets or sets the category filter. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IPresentationChart chart = presentation.Slides[0].Charts[0] as IPresentationChart; + //Get the categories of chart + IOfficeChartCategories categories = chart.Categories; + //Get the name of the category + string name = categories[0].Name; + //Set the category filter + categories[0].IsFiltered = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IPresentationChart = TryCast(presentation__1.Slides(0).Charts(0), IPresentationChart) + 'Get the categories of chart + Dim categories As IOfficeChartCategories = chart.Categories + 'Get the name of the category + Dim name As String = categories(0).Name + 'Set the category filter + categories(0).IsFiltered = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the category name.Read-only. + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Get the category from the category collection + IOfficeChartCategory category = chart.Categories[0]; + //Get the name of the category + string name = category.Name; + //Get the category label, read only + IOfficeDataRange dataRange = category.CategoryLabel; + //Set the value + dataRange.SetValue(2, 1, "2ndRow, 1stCol"); + dataRange.SetValue(2, 4, 290); + //Get the values of category + IOfficeDataRange values = category.Values; + //Set the value + values.SetValue(3, 2, 120); + values.SetValue(5, 2, 320); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation__1.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Get the category from the category collection + Dim category As IOfficeChartCategory = chart.Categories(0) + 'Get the name of the category + Dim name As String = category.Name + 'Get the category label, read only + Dim dataRange As IOfficeDataRange = category.CategoryLabel + 'Set the value + dataRange.SetValue(2, 1, "2ndRow, 1stCol") + dataRange.SetValue(2, 4, 290) + 'Get the values of category + Dim values As IOfficeDataRange = category.Values + 'Set the value + values.SetValue(3, 2, 120) + values.SetValue(5, 2, 320) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the category labels of the category. Read-only. + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Get the category from the category collection + IOfficeChartCategory category = chart.Categories[0]; + //Get the name of the category + string name = category.Name; + //Get the category label, read only + IOfficeDataRange dataRange = category.CategoryLabel; + //Set the value + dataRange.SetValue(2, 1, "2ndRow, 1stCol"); + dataRange.SetValue(2, 4, 290); + //Get the values of category + IOfficeDataRange values = category.Values; + //Set the value + values.SetValue(3, 2, 120); + values.SetValue(5, 2, 320); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation__1.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Get the category from the category collection + Dim category As IOfficeChartCategory = chart.Categories(0) + 'Get the name of the category + Dim name As String = category.Name + 'Get the category label, read only + Dim dataRange As IOfficeDataRange = category.CategoryLabel + 'Set the value + dataRange.SetValue(2, 1, "2ndRow, 1stCol") + dataRange.SetValue(2, 4, 290) + 'Get the values of category + Dim values As IOfficeDataRange = category.Values + 'Set the value + values.SetValue(3, 2, 120) + values.SetValue(5, 2, 320) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the category values.Read-only. + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Get the category from the category collection + IOfficeChartCategory category = chart.Categories[0]; + //Get the name of the category + string name = category.Name; + //Get the category label, read only + IOfficeDataRange dataRange = category.CategoryLabel; + //Set the value + dataRange.SetValue(2, 1, "2ndRow, 1stCol"); + dataRange.SetValue(2, 4, 290); + //Get the values of category + IOfficeDataRange values = category.Values; + //Set the value + values.SetValue(3, 2, 120); + values.SetValue(5, 2, 320); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation__1.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Get the category from the category collection + Dim category As IOfficeChartCategory = chart.Categories(0) + 'Get the name of the category + Dim name As String = category.Name + 'Get the category label, read only + Dim dataRange As IOfficeDataRange = category.CategoryLabel + 'Set the value + dataRange.SetValue(2, 1, "2ndRow, 1stCol") + dataRange.SetValue(2, 4, 290) + 'Get the values of category + Dim values As IOfficeDataRange = category.Values + 'Set the value + values.SetValue(3, 2, 120) + values.SetValue(5, 2, 320) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents the Filterd Category + + + + + Represents the category labels + + + + + Represents the category labels + + + + + Represents the category values + + + + + Represents the category values + + + + + Represents the categoryname. + + + + + Class used for Chart Category Axis implementation. + + + + + Class used for Chart Value Axis implementation. + + + + + Represents the chart value axis. + + + + + Gets or sets the minimum value on the value axis. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Diable auto major + chart.PrimaryValueAxis.IsAutoMin = false; + //Disable auto max + chart.PrimaryValueAxis.IsAutoMinor = false; + //Set the major unit + chart.PrimaryValueAxis.MinorUnit = 24.34; + //Set the maximum value + chart.PrimaryValueAxis.MinimumValue = 60; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets the maximum value on the value axis. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Diable auto major + chart.PrimaryValueAxis.IsAutoMajor = false; + //Disable auto max + chart.PrimaryValueAxis.IsAutoMax = false; + //Set the major unit + chart.PrimaryValueAxis.MajorUnit = 24.34; + //Set the maximum value + chart.PrimaryValueAxis.MaximumValue = 60; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets the major units on the value axis. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Diable auto major + chart.PrimaryValueAxis.IsAutoMajor = false; + //Disable auto max + chart.PrimaryValueAxis.IsAutoMax = false; + //Set the major unit + chart.PrimaryValueAxis.MajorUnit = 24.34; + //Set the maximum value + chart.PrimaryValueAxis.MaximumValue = 60; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets the minor units on the value axis. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Diable auto major + chart.PrimaryValueAxis.IsAutoMin = false; + //Disable auto max + chart.PrimaryValueAxis.IsAutoMinor = false; + //Set the major unit + chart.PrimaryValueAxis.MinorUnit = 24.34; + //Set the maximum value + chart.PrimaryValueAxis.MinimumValue = 60; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets the point on the value axis where the category axis crosses it. Applies only to the value axis. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Set the crosses At + chart.PrimaryValueAxis.CrossesAt = 1.2; + //Set the display unit + chart.PrimaryValueAxis.DisplayUnit = OfficeChartDisplayUnit.Hundreds; + //Set the display unit custom + chart.PrimaryValueAxis.DisplayUnitCustom = 12.34; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or set a value that indicates whether automatically calculates the minimum value for the value axis. + + Trueif Essential Presentation calculates the minimum value for the value axis.Otherwise False. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Diable auto major + chart.PrimaryValueAxis.IsAutoMin = false; + //Disable auto max + chart.PrimaryValueAxis.IsAutoMinor = false; + //Set the major unit + chart.PrimaryValueAxis.MinorUnit = 24.34; + //Set the maximum value + chart.PrimaryValueAxis.MinimumValue = 60; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or set a value that indicates whether automatically calculates the maximum value for the value axis. + + Trueif Essential Presentation calculates the maximum value for the value axis.Otherwise False. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Diable auto major + chart.PrimaryValueAxis.IsAutoMajor = false; + //Disable auto max + chart.PrimaryValueAxis.IsAutoMax = false; + //Set the major unit + chart.PrimaryValueAxis.MajorUnit = 24.34; + //Set the maximum value + chart.PrimaryValueAxis.MaximumValue = 60; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or set a value that indicates whether automatically calculates the major units for the value axis. + + Trueif Essential Presentation calculates the major units for the value axis.Otherwise False. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Diable auto major + chart.PrimaryValueAxis.IsAutoMajor = false; + //Disable auto max + chart.PrimaryValueAxis.IsAutoMax = false; + //Set the major unit + chart.PrimaryValueAxis.MajorUnit = 24.34; + //Set the maximum value + chart.PrimaryValueAxis.MaximumValue = 60; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or set a value that indicates whether automatically calculates the minor units for the value axis. + + Trueif Essential Presentation calculates the minor units for the value axis.Otherwise False. + + + + Gets or sets a value that indicates whether the automatic category crossing point selected on the value axis or not. + + Trueif automatically category crossing point selected on the value axis.Otherwise False. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Disable the auto cross + chart.PrimaryValueAxis.IsAutoCross = false; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets a value that indicates whether the Logarithmic scale is using or not. + + Trueif using logarithmic scale.Otherwise False. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Set the log scale + chart.PrimaryValueAxis.IsLogScale = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Returns or sets the base of the logarithm when you are using log scales. The default value is 10. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range (start row, start column, end row, end column) of chart series + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range (start row, start column, end row, end column) of chart series + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Set the log scale and log base + chart.PrimaryValueAxis.IsLogScale = true; + chart.PrimaryValueAxis.LogBase = 2; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets a value that indicates whether category axis to cross at maximum value or not. + + Trueif category axis to cross at maximum value.Otherwise False. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Disable the auto cross + chart.PrimaryValueAxis.IsAutoCross = false; + //Set the Max cross + chart.PrimaryValueAxis.IsMaxCross = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets the value of the displayed units. while DisplayUnit type is custom. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Set the crosses At + chart.PrimaryValueAxis.CrossesAt = 1.2; + //Set the display unit + chart.PrimaryValueAxis.DisplayUnit = OfficeChartDisplayUnit.Hundreds; + //Set the display unit custom + chart.PrimaryValueAxis.DisplayUnitCustom = 12.34; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets the unit label for the value axis. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Set the crosses At + chart.PrimaryValueAxis.CrossesAt = 1.2; + //Set the display unit + chart.PrimaryValueAxis.DisplayUnit = OfficeChartDisplayUnit.Hundreds; + //Set the display unit custom + chart.PrimaryValueAxis.DisplayUnitCustom = 12.34; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets a value that indicates whether the label is displayed on the value axis or not. + + if the label is displayed on the value axis.Otherwise False. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Set the display unit + chart.PrimaryValueAxis.DisplayUnit = OfficeChartDisplayUnit.MillionMillions; + //Hide the display unit label + chart.PrimaryValueAxis.HasDisplayUnitLabel = false; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets the DisplayUnitLabel object for the value axis. + Gets a Null reference if the HasDisplayUnitLabel property is set to False. Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Set the display unit + chart.PrimaryValueAxis.DisplayUnit = OfficeChartDisplayUnit.MillionMillions; + //Set the italic font style for the lable + chart.PrimaryValueAxis.DisplayUnitLabel.Italic = true; + //Set the RGB color of the label + chart.PrimaryValueAxis.DisplayUnitLabel.RGBColor = System.Drawing.Color.Bisque; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Represents logarithmic scale. + + + + + Represents reverse plot order. + + + + + Represents maximum value. + + + + + Represents minimum value. + + + + + Represents the log base + + + + + Represents array of display units values. + Index - display units index, value - double value. + + + + + Indicates is has display unit label. + + + + + Chart value record. + + + + + Represents log base. Default value is 10. + + + + + Represents custom unit to display. + + + + + Represents display unit. + + + + + Represents display Unit label. + + + + + Indicates whether tick label spacing value is automatically evaluated. + + + + + Represents the indicate whether the chart axis auto cross value change or not. + + + + + Represents the indicate whether the chart axis auto cross value change or not in loading. + + + + + Represents the display unit is percentage. + + + + + Creates primary axis of specified type. + + Application object for the axis. + Parent object for the axis. + Type of the new axis. + + + + Creates axis of specified type and specified IsPrimary value. + + Application object for the axis. + Parent object for the axis. + Type of the new axis. + + True if primary axis should be created; otherwise False. + + + + + Initializes internal variables. + + + + + Checks if everything is ok with ChartValueRangeRecord. + + True if check succeeded. + + + + Checks if everything is ok with ChartValueRangeRecord. + + Indicates whether we should throw an exception in the case of check failed. + True if check succeeded. + + + + Clone current object. + + Parent object. + Dictionary with new indexes. + Dictionary with new worksheet names. + Returns cloned object. + + + + Creates display unit label. + + + + + Maximum value on axis. + + + + + Maximum value on axis. + + + + + Value of major increment. + + + + + Value of minor increment. + + + + + Represents the point on the axis another axis crosses it. + + + + + Represents the point on the axis another axis crosses it. + + + + + Automatic minimum selected. + + + + + Automatic maximum selected. + + + + + Represents whether the label spacing is automatic or not + + + + + Automatic major selected. + + + + + Automatic minor selected. + + + + + Automatic category crossing point selected. + + + + + Get or set the indicates whether the chart axis auto cross value change or not. + + + + + Get or set the indicates whether the chart axis auto cross value change or not in loading. + + + + + Logarithmic scale. + + + + + Returns or sets the base of the logarithm when you are using log scales. The default value is 10. + + + + + True if plots data points from last to first. + + + + + Category axis to cross at maximum value. + + + + + Gets or sets the ChartValueRangeRecord. + + + + + Represents custom unit to display. + + + + + Returns or sets the unit label for the specified axis. + + + + + True if the label is displayed on the specified axis. + + + + + Returns the DisplayUnitLabel object for the specified axis. + Returns Null if the HasDisplayUnitLabel property is set to False. Read-only. + + + + + Gets text link for this axis. + + + + + Represents the chart Category Axis. + + + + + Gets or sets the number of categories or series between tick-mark labels. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "9/21/2015"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "9/24/2015"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "9/28/2015"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the primary category axis of chart + IOfficeChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + //Set the category labels + categoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Set the number format of axis + categoryAxis.NumberFormat = "m/d/yyyy"; + //Set the tick label spacing + categoryAxis.TickLabelSpacing = 2; + //Set the tick mark spacing + categoryAxis.TickMarkSpacing = 2; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "9/21/2015") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "9/24/2015") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "9/28/2015") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the primary category axis of chart + Dim categoryAxis As IOfficeChartCategoryAxis = chart.PrimaryCategoryAxis + 'Set the category labels + categoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Set the number format of axis + categoryAxis.NumberFormat = "m/d/yyyy" + 'Set the tick label spacing + categoryAxis.TickLabelSpacing = 2 + 'Set the tick mark spacing + categoryAxis.TickMarkSpacing = 2 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that indicates whether the tick label spacing is automatic. + + True if the tick label spacing is automatic.Otherwise False. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the primary category axis of chart + IOfficeChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + //Set the auto tick label spacing + categoryAxis.AutoTickLabelSpacing = false; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the primary category axis of chart + Dim categoryAxis As IOfficeChartCategoryAxis = chart.PrimaryCategoryAxis + 'Set the auto tick label spacing + categoryAxis.AutoTickLabelSpacing = False + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the number of categories or series between tick marks. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "9/21/2015"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "9/24/2015"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "9/28/2015"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the primary category axis of chart + IOfficeChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + //Set the category labels + categoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Set the number format of axis + categoryAxis.NumberFormat = "m/d/yyyy"; + //Set the tick label spacing + categoryAxis.TickLabelSpacing = 2; + //Set the tick mark spacing + categoryAxis.TickMarkSpacing = 2; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "9/21/2015") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "9/24/2015") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "9/28/2015") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the primary category axis of chart + Dim categoryAxis As IOfficeChartCategoryAxis = chart.PrimaryCategoryAxis + 'Set the category labels + categoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Set the number format of axis + categoryAxis.NumberFormat = "m/d/yyyy" + 'Set the tick label spacing + categoryAxis.TickLabelSpacing = 2 + 'Set the tick mark spacing + categoryAxis.TickMarkSpacing = 2 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets true - cuts unused plot area. Default for area, surface charts. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "9/21/2015"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "9/24/2015"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "9/28/2015"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the primary category axis of chart + IOfficeChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + //Set the category labels + categoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Set the number format of axis + categoryAxis.NumberFormat = "m/d/yyyy"; + //Set the tick label spacing + categoryAxis.TickLabelSpacing = 2; + //Set the tick mark spacing + categoryAxis.TickMarkSpacing = 2; + //Set IsBetween, default is true + categoryAxis.IsBetween = false; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "9/21/2015") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "9/24/2015") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "9/28/2015") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the primary category axis of chart + Dim categoryAxis As IOfficeChartCategoryAxis = chart.PrimaryCategoryAxis + 'Set the category labels + categoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Set the number format of axis + categoryAxis.NumberFormat = "m/d/yyyy" + 'Set the tick label spacing + categoryAxis.TickLabelSpacing = 2 + 'Set the tick mark spacing + categoryAxis.TickMarkSpacing = 2 + 'Set IsBetween, default is true + categoryAxis.IsBetween = False + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets Category labels for the chart. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "9/21/2015"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "9/24/2015"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "9/28/2015"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the primary category axis of chart + IOfficeChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + //Set the category labels + categoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Set the number format of axis + categoryAxis.NumberFormat = "m/d/yyyy"; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "9/21/2015") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "9/24/2015") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "9/28/2015") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the primary category axis of chart + Dim categoryAxis As IOfficeChartCategoryAxis = chart.PrimaryCategoryAxis + 'Set the category labels + categoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Set the number format of axis + categoryAxis.NumberFormat = "m/d/yyyy" + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Get or set the Directly category lables for the chart. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 1, "Jan"); + chart.ChartData.SetValue(1, 2, "Feb"); + chart.ChartData.SetValue(1, 3, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "10"); + chart.ChartData.SetValue(2, 2, "20"); + chart.ChartData.SetValue(2, 3, "30"); + ///'Sets the data range of chart + chart.DataRange = chart.ChartData(1, 1, 2, 2) + //Get the primary category axis of chart + IOfficeChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + //Set the category labels + categoryAxis.DirectCategoryLabels = = new object[] { "Oct", "Nov", "Dec" };; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets the category axis type. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "9/21/2015"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "9/24/2015"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "9/28/2015"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the primary category axis of chart + IOfficeChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + //Set the category labels + categoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Set the number format of axis + categoryAxis.NumberFormat = "m/d/yyyy"; + //Set the category type + categoryAxis.CategoryType = OfficeCategoryType.Category; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "9/21/2015") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "9/24/2015") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "9/28/2015") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the primary category axis of chart + Dim categoryAxis As IOfficeChartCategoryAxis = chart.PrimaryCategoryAxis + 'Set the category labels + categoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Set the number format of axis + categoryAxis.NumberFormat = "m/d/yyyy" + 'Set the category type + categoryAxis.CategoryType = OfficeCategoryType.Category + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the distance between the labels and axis line. + The value can be from 0 through 1000. + + + + + Gets or sets the base unit for the category axis + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "9/21/2015"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "9/24/2015"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "9/28/2015"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the primary category axis of chart + IOfficeChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + //Set the category labels + categoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Set the number format of axis + categoryAxis.NumberFormat = "m/d/yyyy"; + //Set the base unit + categoryAxis.BaseUnit = OfficeChartBaseUnit.Month; + //Set the base unit for the category axis, default is true + categoryAxis.BaseUnitIsAuto = false; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "9/21/2015") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "9/24/2015") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "9/28/2015") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the primary category axis of chart + Dim categoryAxis As IOfficeChartCategoryAxis = chart.PrimaryCategoryAxis + 'Set the category labels + categoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Set the number format of axis + categoryAxis.NumberFormat = "m/d/yyyy" + 'Set the base unit + categoryAxis.BaseUnit = OfficeChartBaseUnit.Month + 'Set the base unit for the category axis, default is true + categoryAxis.BaseUnitIsAuto = False + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets True if use automatic base units for the category axis. The default is true. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "9/21/2015"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "9/24/2015"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "9/28/2015"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the primary category axis of chart + IOfficeChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + //Set the category labels + categoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Set the number format of axis + categoryAxis.NumberFormat = "m/d/yyyy"; + //Set the base unit + categoryAxis.BaseUnit = OfficeChartBaseUnit.Month; + //Set the base unit for the category axis, default is true + categoryAxis.BaseUnitIsAuto = false; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "9/21/2015") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "9/24/2015") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "9/28/2015") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the primary category axis of chart + Dim categoryAxis As IOfficeChartCategoryAxis = chart.PrimaryCategoryAxis + 'Set the category labels + categoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Set the number format of axis + categoryAxis.NumberFormat = "m/d/yyyy" + 'Set the base unit + categoryAxis.BaseUnit = OfficeChartBaseUnit.Month + 'Set the base unit for the category axis, default is true + categoryAxis.BaseUnitIsAuto = False + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the major unit scale value for the category axis + when the CategoryType property is set to TimeScale. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "9/21/2015"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "9/24/2015"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "9/28/2015"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the primary category axis of chart + IOfficeChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + //Set the category labels + categoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Set the number format of axis + categoryAxis.NumberFormat = "m/d/yyyy"; + //Set the base unit + categoryAxis.BaseUnit = OfficeChartBaseUnit.Month; + //Set the major unit scale + categoryAxis.MajorUnitScale = OfficeChartBaseUnit.Month; + //Set the minor unit scale + categoryAxis.MinorUnitScale = OfficeChartBaseUnit.Month; + //Set the minor unit + categoryAxis.MinorUnit = 10; + //Set the major unit + categoryAxis.MajorUnit = 10; + //Set the offset value + categoryAxis.Offset = 450; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "9/21/2015") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "9/24/2015") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "9/28/2015") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the primary category axis of chart + Dim categoryAxis As IOfficeChartCategoryAxis = chart.PrimaryCategoryAxis + 'Set the category labels + categoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Set the number format of axis + categoryAxis.NumberFormat = "m/d/yyyy" + 'Set the base unit + categoryAxis.BaseUnit = OfficeChartBaseUnit.Month + 'Set the major unit scale + categoryAxis.MajorUnitScale = OfficeChartBaseUnit.Month + 'Set the minor unit scale + categoryAxis.MinorUnitScale = OfficeChartBaseUnit.Month + 'Set the minor unit + categoryAxis.MinorUnit = 10 + 'Set the major unit + categoryAxis.MajorUnit = 10 + 'Set the offset value + categoryAxis.Offset = 450 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the minor unit scale value for the category axis + when the CategoryType property is set to TimeScale. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "9/21/2015"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "9/24/2015"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "9/28/2015"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the primary category axis of chart + IOfficeChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + //Set the category labels + categoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Set the number format of axis + categoryAxis.NumberFormat = "m/d/yyyy"; + //Set the base unit + categoryAxis.BaseUnit = OfficeChartBaseUnit.Month; + //Set the major unit scale + categoryAxis.MajorUnitScale = OfficeChartBaseUnit.Month; + //Set the minor unit scale + categoryAxis.MinorUnitScale = OfficeChartBaseUnit.Month; + //Set the minor unit + categoryAxis.MinorUnit = 10; + //Set the major unit + categoryAxis.MajorUnit = 10; + //Set the offset value + categoryAxis.Offset = 450; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "9/21/2015") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "9/24/2015") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "9/28/2015") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the primary category axis of chart + Dim categoryAxis As IOfficeChartCategoryAxis = chart.PrimaryCategoryAxis + 'Set the category labels + categoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Set the number format of axis + categoryAxis.NumberFormat = "m/d/yyyy" + 'Set the base unit + categoryAxis.BaseUnit = OfficeChartBaseUnit.Month + 'Set the major unit scale + categoryAxis.MajorUnitScale = OfficeChartBaseUnit.Month + 'Set the minor unit scale + categoryAxis.MinorUnitScale = OfficeChartBaseUnit.Month + 'Set the minor unit + categoryAxis.MinorUnit = 10 + 'Set the major unit + categoryAxis.MajorUnit = 10 + 'Set the offset value + categoryAxis.Offset = 450 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + True if multi-Level category axis is not allowed. otherwise False. + + + + + True if bins generated by category values. otherwise False + + Applies only to Histogram and Pareto charts. + + + + True if bins generated are automatic. otherwise False + + Applies only to Histogram and Pareto charts. + + + + Gets / Sets the Number of Bins in the axis + + Applies only to Histogram and Pareto charts.Can be a value from 1 through 31999. + + + + Get or Set the number of data points in each range. + + Applies only to Histogram and Pareto charts. + + + + Get or Set the UnderFlow Bin value + + Applies only to Histogram and Pareto charts. + + + + Get or Set the OverFlow Bin value + + Applies only to Histogram and Pareto charts. + + + + Error message for not supported property. + + + + + Represents default offset. + + + + + Represents month count. + + + + + Represents min axis data. + + + + + boolean value used for tick label spacing + + + + + boolean value used for ChartAxisOffsetRecord + + + + + Object that holds the information required for Histogram series + + + + + ChartCatserRangeRecord that describes this axis. + + + + + UnknownRecord that describes label intervals of this axis. + + + + + Represents time scale data. + + + + + Represents category axis type. + + + + + Represents default axis offset. + + + + + Indicates whether tick label spacing value is automatically evaluated. + + + + + Indicates whether multi level label is allowed or not + + + + + Represents to serialize NoMultiLvlLbl attribute or not + + + + + Represents to serialize majorUnitScale is Auto + + + + + Represents to serialize minorUnitScale is Auto + + + + + Represents the date time axis value change or not + + + + + Creates primary axis of specified type. + + Application object for the axis. + Parent object for the axis. + Type of the new axis. + + + + Creates axis of specified type and specified IsPrimary value. + + Application object for the axis. + Parent object for the axis. + Type of the new axis. + + True if primary axis should be created; otherwise False. + + + + + Initializes internal variables. + + + + + Checks if everything is ok with ChartValueRangeRecord. + + Indicates whether we should throw an exception in the case of check failed. + True if check succeeded. + + + + Clones current object. + + Parent object. + Dictionary with new indexes. + Dictionary with new worksheet names. + Returns cloned object. + + + + Checks for time scale axis mode. Otherwise rise exception. + + + + + Swap the values from category axis properties + + + + + Value axis crosses at the far right category (in a line, bar, + column, scatter, or area chart; 2D charts only). + + + + + Represents the point on the axis another axis crosses it. + + + + + Represents the date time axis value change or not + + + + + Represents whether the label spacing is present or not + + + + + Represents whether the label spacing is automatic or not + + + + + Represents the number of categories or series between tick-mark labels. + + + + + Represents the number of categories or series between tick-mark labels. + + + + + Represents the number of categories or series between tick marks. + + + + + Represents the number of categories or series between tick marks. + + + + + Creates title area. Read-only. + + + + + If false - cuts unused plot area. Default for area, surface charts. + + + + + True if plots data points from last to first. + + + + + Category labels for the chart. + + + + + Category labels for the chart. + + + + + Get or set the Directly category lables for the chart. + + + + + Entered directly category labels for the chart. + + + + + Represents axis category type. + + + + + Represents distance between the labels and axis line. + The value can be from 0 through 1000. + + + + + Represents base unit for the specified category axis. + + + + + True if use automatic base units for the specified category axis. + + + + + True if use automatic major units for the specified category axis. + + + + + True if use automatic major units for the specified category axis. + + + + + Automatic major selected. + + + + + Automatic minor selected. + + + + + Automatic category crossing point selected. + + + + + Automatic maximum selected. + + + + + Automatic minimum selected. + + + + + Value of major increment. + + + + + Value of minor increment. + + + + + Represents the major unit scale value for the category axis + when the CategoryType property is set to TimeScale. + + + + + Represents the minor unit scale value for the category axis + when the CategoryType property is set to TimeScale. + + + + + Represents whether axis labels allow multi level string or not + + + + + True if bins generated by category values. otherwise False + + Applies only to Histogram and Pareto charts. + + + + True if bins generated are automatic. otherwise False + + Applies only to Histogram and Pareto charts. + + + + Get or set the Number of Bins in the axis + + Applies only to Histogram and Pareto charts.Can be a value from 1 through 31999. + + + + Get or Set the number of data points in each range. + + Applies only to Histogram and Pareto charts. + + + + Get or Set the UnderFlow Bin value + + Applies only to Histogram and Pareto charts. + + + + Get or Set the OverFlow Bin value + + Applies only to Histogram and Pareto charts. + + + + returns an Object that holds the information required for Histogram series + + + + + Returns ChartCatserRangeRecord record. Read-only. + + + + + Indicates is chart bubble or scatter. Using series start type. + + + + + Indicates is category axis type is category. Read-only. + + + + + Represents the collection of IOfficeChartCategory + + + + + Gets the number of objects in the collection. Read-only Long. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IPresentationChart chart = presentation.Slides[1].Charts[0] as IPresentationChart; + //Get the categories of chart + IOfficeChartCategories categories = chart.Categories; + //Get the count of categories + int count = categories.Count; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IPresentationChart = TryCast(presentation__1.Slides(1).Charts(0), IPresentationChart) + 'Get the categories of chart + Dim categories As IOfficeChartCategories = chart.Categories + 'Get the count of categories + Dim count As Integer = categories.Count + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a single instance at the specified index from the collection. Read-only. + + The zero-based index of the element. + Returns the particular category based on the index. + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IPresentationChart chart = presentation.Slides[0].Charts[0] as IPresentationChart; + //Get the categories of chart + IOfficeChartCategories categories = chart.Categories; + //Get the name of the category + string name = categories[0].Name; + //Set the category filter + categories[0].IsFiltered = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IPresentationChart = TryCast(presentation__1.Slides(0).Charts(0), IPresentationChart) + 'Get the categories of chart + Dim categories As IOfficeChartCategories = chart.Categories + 'Get the name of the category + Dim name As String = categories(0).Name + 'Set the category filter + categories(0).IsFiltered = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a single instance with the specified index from the collection. Read-only. + + Name of the category + Returns the particular category based on the given name. + + + + Creates collection. + + Application object for the collection. + Parent object for the collection. + + + + Performs additional operations before the Clear method. + + + + + Clone current instance. + + Parent object. + Returns cloned instance. + + + + Represents access to the linked or embedded data associated with a chart. + + + + + Sets the value in the specified row and column index of the cell with the integer value. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IOfficeChart chart = slide.Shapes[0] as IOfficeChart; + //Get the chart data + IOfficeChartData chartData = chart.ChartData; + //Get the category label, read only + IOfficeDataRange dataRange = chartData[2, 2, 4, 5]; + //Set the cell with an integer + dataRange.SetValue(2, 4, 290); + //Set the cell with double value + dataRange.SetValue(3, 3, 23.34); + //Set the cell with a string + dataRange.SetValue(3, 1, "ChartData - 3R1C"); + //Set the cell with an object + object value = "@!@#"; + dataRange.SetValue(2, 1, "value"); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation__1.Slides(0) + 'Get the chart from slide + Dim chart As IOfficeChart = TryCast(slide.Shapes(0), IOfficeChart) + 'Get the chart data + Dim chartData As IOfficeChartData = chart.ChartData + 'Get the category label, read only + Dim dataRange As IOfficeDataRange = chartData(2, 2, 4, 5) + 'Set the cell with an integer + dataRange.SetValue(2, 4, 290) + 'Set the cell with double value + dataRange.SetValue(3, 3, 23.34) + 'Set the cell with a string + dataRange.SetValue(3, 1, "ChartData - 3R1C") + 'Set the cell with an object + Dim value As Object = "@!@#" + dataRange.SetValue(2, 1, "value") + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Sets the specified value at the specified row and column index. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IOfficeChart chart = slide.Shapes[0] as IOfficeChart; + //Get the chart data + IOfficeChartData chartData = chart.ChartData; + //Get the category label, read only + IOfficeDataRange dataRange = chartData[2, 2, 4, 5]; + //Set the cell with an integer + dataRange.SetValue(2, 4, 290); + //Set the cell with double value + dataRange.SetValue(3, 3, 23.34); + //Set the cell with a string + dataRange.SetValue(3, 1, "ChartData - 3R1C"); + //Set the cell with an object + object value = "@!@#"; + dataRange.SetValue(2, 1, "value"); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation__1.Slides(0) + 'Get the chart from slide + Dim chart As IOfficeChart = TryCast(slide.Shapes(0), IOfficeChart) + 'Get the chart data + Dim chartData As IOfficeChartData = chart.ChartData + 'Get the category label, read only + Dim dataRange As IOfficeDataRange = chartData(2, 2, 4, 5) + 'Set the cell with an integer + dataRange.SetValue(2, 4, 290) + 'Set the cell with double value + dataRange.SetValue(3, 3, 23.34) + 'Set the cell with a string + dataRange.SetValue(3, 1, "ChartData - 3R1C") + 'Set the cell with an object + Dim value As Object = "@!@#" + dataRange.SetValue(2, 1, "value") + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Sets the value in the specified row and column index of the cell with the string value. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IOfficeChart chart = slide.Shapes[0] as IOfficeChart; + //Get the chart data + IOfficeChartData chartData = chart.ChartData; + //Get the category label, read only + IOfficeDataRange dataRange = chartData[2, 2, 4, 5]; + //Set the cell with an integer + dataRange.SetValue(2, 4, 290); + //Set the cell with double value + dataRange.SetValue(3, 3, 23.34); + //Set the cell with a string + dataRange.SetValue(3, 1, "ChartData - 3R1C"); + //Set the cell with an object + object value = "@!@#"; + dataRange.SetValue(2, 1, "value"); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation__1.Slides(0) + 'Get the chart from slide + Dim chart As IOfficeChart = TryCast(slide.Shapes(0), IOfficeChart) + 'Get the chart data + Dim chartData As IOfficeChartData = chart.ChartData + 'Get the category label, read only + Dim dataRange As IOfficeDataRange = chartData(2, 2, 4, 5) + 'Set the cell with an integer + dataRange.SetValue(2, 4, 290) + 'Set the cell with double value + dataRange.SetValue(3, 3, 23.34) + 'Set the cell with a string + dataRange.SetValue(3, 1, "ChartData - 3R1C") + 'Set the cell with an object + Dim value As Object = "@!@#" + dataRange.SetValue(2, 1, "value") + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Sets the value in the specified row and column index of the cell with the object value. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IOfficeChart chart = slide.Shapes[0] as IOfficeChart; + //Get the chart data + IOfficeChartData chartData = chart.ChartData; + //Get the category label, read only + IOfficeDataRange dataRange = chartData[2, 2, 4, 5]; + //Set the cell with an integer + dataRange.SetValue(2, 4, 290); + //Set the cell with double value + dataRange.SetValue(3, 3, 23.34); + //Set the cell with a string + dataRange.SetValue(3, 1, "ChartData - 3R1C"); + //Set the cell with an object + object value = "@!@#"; + dataRange.SetValue(2, 1, "value"); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation__1.Slides(0) + 'Get the chart from slide + Dim chart As IOfficeChart = TryCast(slide.Shapes(0), IOfficeChart) + 'Get the chart data + Dim chartData As IOfficeChartData = chart.ChartData + 'Get the category label, read only + Dim dataRange As IOfficeDataRange = chartData(2, 2, 4, 5) + 'Set the cell with an integer + dataRange.SetValue(2, 4, 290) + 'Set the cell with double value + dataRange.SetValue(3, 3, 23.34) + 'Set the cell with a string + dataRange.SetValue(3, 1, "ChartData - 3R1C") + 'Set the cell with an object + Dim value As Object = "@!@#" + dataRange.SetValue(2, 1, "value") + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Sets the chart data in the specified two dimensional object array. + + Represents the two dimensional chart data + + + + Sets the chart data in the specified row and column index with the two dimensional object array. + + Represents the two dimensional chart data + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + + + + Sets the chart data in the specified row and column index with the IEnumerable object data. + + IEnumerable object with desired data + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + + + + + Returns the cell value at the specified row and column index. + + One-based row index of the cell to get value from. + One-based column index of the cell to get value from. + Returns value corresponding to the cell. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IOfficeChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the chart data + IOfficeChartData chartData = chart.ChartData; + //Get the value of a particular cell from the chart data + object value = chartData.GetValue(2, 3); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with postion and size + Dim chart As IOfficeChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the chart data + Dim chartData As IOfficeChartData = chart.ChartData + 'Get the value of a particular cell from the chart data + Dim value As Object = chartData.GetValue(2, 3) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Clears the chart data. + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IOfficeChart chart = slide.Shapes[0] as IOfficeChart; + //Get the chart data + IOfficeChartData chartData = chart.ChartData; + //Clear the chart data + chartData.Clear(); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation__1.Slides(0) + 'Get the chart from slide + Dim chart As IOfficeChart = TryCast(slide.Shapes(0), IOfficeChart) + 'Get the chart data + Dim chartData As IOfficeChartData = chart.ChartData + 'Clear the chart data + chartData.Clear() + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the particular data range from the chart data. + + Represents the first row of the chart data. + Represents the first column of the chart data. + Represents the last row of the chart data. + Represents the last column of the chart data. + Returns the data range specified from the chart data. + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IOfficeChart chart = slide.Shapes[0] as IOfficeChart; + //Get the chart data + IOfficeChartData chartData = chart.ChartData; + //Get the category label, read only + IOfficeDataRange dataRange = chartData[2, 2, 4, 5]; + //Set the cell with an integer + dataRange.SetValue(2, 4, 290); + //Set the cell with double value + dataRange.SetValue(3, 3, 23.34); + //Set the cell with a string + dataRange.SetValue(3, 1, "ChartData - 3R1C"); + //Set the cell with an object + object value = "@!@#"; + dataRange.SetValue(2, 1, "value"); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation__1.Slides(0) + 'Get the chart from slide + Dim chart As IOfficeChart = TryCast(slide.Shapes(0), IOfficeChart) + 'Get the chart data + Dim chartData As IOfficeChartData = chart.ChartData + 'Get the category label, read only + Dim dataRange As IOfficeDataRange = chartData(2, 2, 4, 5) + 'Set the cell with an integer + dataRange.SetValue(2, 4, 290) + 'Set the cell with double value + dataRange.SetValue(3, 3, 23.34) + 'Set the cell with a string + dataRange.SetValue(3, 1, "ChartData - 3R1C") + 'Set the cell with an object + Dim value As Object = "@!@#" + dataRange.SetValue(2, 1, "value") + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Retruns the internal worksheet referred from the chart range + + + + + Class used for Chart Data Labels implementation. + + + + + Represents the chart data labels for the serie. + + + + + Represents the Text Area in a chart. + + + + + Represents character formatting for text or a bullet. + + + + + Generates .Net font object corresponding to the current font. + + Generated .Net font. + + + + Gets or sets a value that Determines whether the font in the specified text is bold. + + Trueif text is bold.Otherwise False. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the chart title + chart.ChartTitle = "This is a chart Title"; + //Set the bold font style + chart.ChartTitleArea.Bold = true; + //Set the color of chart title area + chart.ChartTitleArea.Color = OfficeKnownColors.BlueCustom; + //Set the font name + chart.ChartTitleArea.FontName = "Calibri"; + //Get if the chart area is auto color + bool autoColor = chart.ChartTitleArea.IsAutoColor; + //Set the italic font style + chart.ChartTitleArea.Italic = true; + //Set the underline property + chart.ChartTitleArea.Underline = OfficeUnderline.Double; + //Set the alignment + chart.ChartTitleArea.VerticalAlignment = OfficeFontVerticalAlignment.Baseline; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets the primary color of the object. Read / write OfficeKnownColors. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the chart title + chart.ChartTitle = "This is a chart Title"; + //Set the bold font style + chart.ChartTitleArea.Bold = true; + //Set the color of chart title area + chart.ChartTitleArea.Color = OfficeKnownColors.BlueCustom; + //Set the font name + chart.ChartTitleArea.FontName = "Calibri"; + //Get if the chart area is auto color + bool autoColor = chart.ChartTitleArea.IsAutoColor; + //Set the italic font style + chart.ChartTitleArea.Italic = true; + //Set the underline property + chart.ChartTitleArea.Underline = OfficeUnderline.Double; + //Set the alignment + chart.ChartTitleArea.VerticalAlignment = OfficeFontVerticalAlignment.Baseline; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets / sets font color. Searches for the closest color in + the presentation palette. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the chart title + chart.ChartTitle = "This is a chart Title"; + //Set the size of text area + chart.ChartTitleArea.Size = 32; + //Set the RGB color + chart.ChartTitleArea.RGBColor = System.Drawing.Color.Peru; + //Set strike through + chart.ChartTitleArea.Strikethrough = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets a value that determines the font style is italic or not. + + Trueif font style is italic.Otherwise False. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the chart title + chart.ChartTitle = "This is a chart Title"; + //Set the bold font style + chart.ChartTitleArea.Bold = true; + //Set the color of chart title area + chart.ChartTitleArea.Color = OfficeKnownColors.BlueCustom; + //Set the font name + chart.ChartTitleArea.FontName = "Calibri"; + //Get if the chart area is auto color + bool autoColor = chart.ChartTitleArea.IsAutoColor; + //Set the italic font style + chart.ChartTitleArea.Italic = true; + //Set the underline property + chart.ChartTitleArea.Underline = OfficeUnderline.Double; + //Set the alignment + chart.ChartTitleArea.VerticalAlignment = OfficeFontVerticalAlignment.Baseline; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets a value that indicates the font is an outline font. + + Trueif the font is an outline font.Otherwise False. + + + + Gets or sets a value that indicates the font is a shadow font. + + Trueif the font is a shadow font.Otherwise False. + + + + Gets or sets the character size, in points. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the chart title + chart.ChartTitle = "This is a chart Title"; + //Set the size of text area + chart.ChartTitleArea.Size = 32; + //Set the RGB color + chart.ChartTitleArea.RGBColor = System.Drawing.Color.Peru; + //Set strike through + chart.ChartTitleArea.Strikethrough = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets a value that indicates the font is struck through with a horizontal line or not. + + Trueif the font is struck through with a horizontal line.Otherwise False. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the chart title + chart.ChartTitle = "This is a chart Title"; + //Set the size of text area + chart.ChartTitleArea.Size = 32; + //Set the RGB color + chart.ChartTitleArea.RGBColor = System.Drawing.Color.Peru; + //Set strike through + chart.ChartTitleArea.Strikethrough = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets a value that Determines whether the text is subscript or not.The default is false. + + Trueif the text is subscript.Otherwise False. + + + + Gets or sets a value that Determines whether the text is superscript or not.The default is false. + + Trueif the text is superscript.Otherwise False. + + + + Gets or sets the type of underline applied to the font. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the chart title + chart.ChartTitle = "This is a chart Title"; + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the bold font style + chart.ChartTitleArea.Bold = true; + //Set the color of chart title area + chart.ChartTitleArea.Color = OfficeKnownColors.BlueCustom; + //Set the font name + chart.ChartTitleArea.FontName = "Calibri"; + //Get if the chart area is auto color + bool autoColor = chart.ChartTitleArea.IsAutoColor; + //Set the italic font style + chart.ChartTitleArea.Italic = true; + //Set the underline property + chart.ChartTitleArea.Underline = OfficeUnderline.Double; + //Set the alignment + chart.ChartTitleArea.VerticalAlignment = OfficeFontVerticalAlignment.Baseline; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets the name of the font. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the chart title + chart.ChartTitle = "This is a chart Title"; + //Set the bold font style + chart.ChartTitleArea.Bold = true; + //Set the color of chart title area + chart.ChartTitleArea.Color = OfficeKnownColors.BlueCustom; + //Set the font name + chart.ChartTitleArea.FontName = "Calibri"; + //Get if the chart area is auto color + bool autoColor = chart.ChartTitleArea.IsAutoColor; + //Set the italic font style + chart.ChartTitleArea.Italic = true; + //Set the underline property + chart.ChartTitleArea.Underline = OfficeUnderline.Double; + //Set the alignment + chart.ChartTitleArea.VerticalAlignment = OfficeFontVerticalAlignment.Baseline; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets a value of the font vertical alignment. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the chart title + chart.ChartTitle = "This is a chart Title"; + //Set the bold font style + chart.ChartTitleArea.Bold = true; + //Set the color of chart title area + chart.ChartTitleArea.Color = OfficeKnownColors.BlueCustom; + //Set the font name + chart.ChartTitleArea.FontName = "Calibri"; + //Get if the chart area is auto color + bool autoColor = chart.ChartTitleArea.IsAutoColor; + //Set the italic font style + chart.ChartTitleArea.Italic = true; + //Set the underline property + chart.ChartTitleArea.Underline = OfficeUnderline.Double; + //Set the alignment + chart.ChartTitleArea.VerticalAlignment = OfficeFontVerticalAlignment.Baseline; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets a value that Indicates whether color is automatically selected. Read-only. + + Trueif the color is automatically selected.Otherwise False. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the chart title + chart.ChartTitle = "This is a chart Title"; + //Set the bold font style + chart.ChartTitleArea.Bold = true; + //Set the color of chart title area + chart.ChartTitleArea.Color = OfficeKnownColors.BlueCustom; + //Set the font name + chart.ChartTitleArea.FontName = "Calibri"; + //Get if the chart area is auto color + bool autoColor = chart.ChartTitleArea.IsAutoColor; + //Set the italic font style + chart.ChartTitleArea.Italic = true; + //Set the underline property + chart.ChartTitleArea.Underline = OfficeUnderline.Double; + //Set the alignment + chart.ChartTitleArea.VerticalAlignment = OfficeFontVerticalAlignment.Baseline; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Area's text. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the size of title text area + chart.ChartTitleArea.Size = 26; + //Set the border color of frame format + chart.ChartTitleArea.FrameFormat.Border.LineColor = System.Drawing.Color.Peru; + //Set the text for chart title + chart.ChartTitleArea.Text = "The Chart Title"; + //Set the text rotation angle + chart.ChartTitleArea.TextRotationAngle = 45; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Set the size of title text area + chart.ChartTitleArea.Size = 26 + 'Set the border color of frame format + chart.ChartTitleArea.FrameFormat.Border.LineColor = System.Drawing.Color.Peru + 'Set the text for chart title + chart.ChartTitleArea.Text = "The Chart Title" + 'Set the text rotation angle + chart.ChartTitleArea.TextRotationAngle = 45 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that represents rotation angle of the text area. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the size of title text area + chart.ChartTitleArea.Size = 26; + //Set the border color of frame format + chart.ChartTitleArea.FrameFormat.Border.LineColor = System.Drawing.Color.Peru; + //Set the text for chart title + chart.ChartTitleArea.Text = "The Chart Title"; + //Set the text rotation angle + chart.ChartTitleArea.TextRotationAngle = 45; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Set the size of title text area + chart.ChartTitleArea.Size = 26 + 'Set the border color of frame format + chart.ChartTitleArea.FrameFormat.Border.LineColor = System.Drawing.Color.Peru + 'Set the text for chart title + chart.ChartTitleArea.Text = "The Chart Title" + 'Set the text rotation angle + chart.ChartTitleArea.TextRotationAngle = 45 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the object that represents fill,line and effects formatting of the text area.Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the chart title + chart.ChartTitle = "The Chart Title"; + //Set the size of title text area + chart.ChartTitleArea.Size = 26; + //Set the border color of frame format + chart.ChartTitleArea.FrameFormat.Border.LineColor = System.Drawing.Color.Peru; + //Set the line pattern + chart.ChartTitleArea.FrameFormat.Border.LinePattern = OfficeChartLinePattern.DashDot; + //Set the line weight + chart.ChartTitleArea.FrameFormat.Border.LineWeight = OfficeChartLineWeight.Medium; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Set the chart title + chart.ChartTitle = "The Chart Title" + 'Set the size of title text area + chart.ChartTitleArea.Size = 26 + 'Set the border color of frame format + chart.ChartTitleArea.FrameFormat.Border.LineColor = System.Drawing.Color.Peru + 'Set the line pattern + chart.ChartTitleArea.FrameFormat.Border.LinePattern = OfficeChartLinePattern.DashDot + 'Set the line weight + chart.ChartTitleArea.FrameFormat.Border.LineWeight = OfficeChartLineWeight.Medium + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the object that represents layout settings of the text area. + + + + + Gets or sets a value that indicates to show the series name for the data labels on a chart. + + Trueto show the series name.Falseto hide the series name. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the serie data labels + IOfficeChartDataLabels dataLabels = chart.Series[0].DataPoints.DefaultDataPoint.DataLabels; + //Set the serie name + dataLabels.IsSeriesName = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the serie data labels + Dim dataLabels As IOfficeChartDataLabels = chart.Series(0).DataPoints.DefaultDataPoint.DataLabels + 'Set the serie name + dataLabels.IsSeriesName = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that indicates to display the category name for the data labels on a chart. + + Trueto display the category name.Falseto hide the category name. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the serie data labels + IOfficeChartDataLabels dataLabels = chart.Series[0].DataPoints.DefaultDataPoint.DataLabels; + //Set the serie name + dataLabels.IsSeriesName = true; + //Set the category name + dataLabels.IsCategoryName = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the serie data labels + Dim dataLabels As IOfficeChartDataLabels = chart.Series(0).DataPoints.DefaultDataPoint.DataLabels + 'Set the serie name + dataLabels.IsSeriesName = True + 'Set the category name + dataLabels.IsCategoryName = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that indicates to display a chart's data label values. + + Trueto display a chart's data label values.Falseto hide a chart's data label values. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the serie data labels + IOfficeChartDataLabels dataLabels = chart.Series[0].DataPoints.DefaultDataPoint.DataLabels; + //Set the value for data labels + dataLabels.IsValue = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the serie data labels + Dim dataLabels As IOfficeChartDataLabels = chart.Series(0).DataPoints.DefaultDataPoint.DataLabels + 'Set the value for data labels + dataLabels.IsValue = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that indicates to display the percentage value for the data labels on a chart. + + Trueto display the percentage value.Falseto hide the percentage value. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type as Pie chart + chart.ChartType = OfficeChartType.Pie; + //Get the serie data labels + IOfficeChartDataLabels dataLabels = chart.Series[0].DataPoints.DefaultDataPoint.DataLabels; + //Set the data label as percentage + dataLabels.IsPercentage = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type as Pie chart + chart.ChartType = OfficeChartType.Pie + 'Get the serie data labels + Dim dataLabels As IOfficeChartDataLabels = chart.Series(0).DataPoints.DefaultDataPoint.DataLabels + 'Set the data label as percentage + dataLabels.IsPercentage = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the format string of the data label. + + + Number format is specified by the formatCode attribute.To know more about the possible formatCode + see NumberFormat. + + + + //Create an instance equivalent to PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add a blank slide + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart of specific size and position + IPresentationChart chart = slide.Charts.AddChart(100, 100, 300, 400); + chart.ChartData.SetValue(1, 2, 1); + chart.ChartData.SetValue(1, 3, 2); + chart.ChartData.SetValue(1, 4, 3); + chart.ChartData.SetValue(2, 1, "Blue"); + chart.ChartData.SetValue(2, 2, 0.4); + chart.ChartData.SetValue(2, 3, 0.5); + chart.ChartData.SetValue(2, 4, 1.2); + chart.ChartData.SetValue(3, 1, "Red"); + chart.ChartData.SetValue(3, 2, 2.6); + chart.ChartData.SetValue(3, 3, 3.6); + chart.ChartData.SetValue(3, 4, 2.1); + chart.ChartData.SetValue(4, 1, "Orange"); + chart.ChartData.SetValue(4, 2, 1.1); + chart.ChartData.SetValue(4, 3, 0.6); + chart.ChartData.SetValue(4, 4, 1.2); + chart.ChartData.SetValue(5, 1, "Light Blue"); + chart.ChartData.SetValue(5, 2, 2.1); + chart.ChartData.SetValue(5, 3, 3.4); + chart.ChartData.SetValue(5, 4, 1.1); + IOfficeChartSerie serieJan = chart.Series.Add("1"); + //Sets the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 5, 2]; + IOfficeChartSerie serieFeb = chart.Series.Add("2"); + //Sets the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 5, 3]; + //Creates a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("3"); + //Sets the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 5, 4]; + //Set chart data range + chart.DataRange = chart.ChartData[2, 1, 5, 4]; + //Specifies the chart type + chart.ChartType = OfficeChartType.Bar_Stacked; + chart.Series[0].DataPoints.DefaultDataPoint.DataLabels.IsValue = true; + //Set the number format of the data label in percentage, round off to two decimal places + chart.Series[0].DataPoints.DefaultDataPoint.DataLabels.NumberFormat = "0.00%"; + //Save the presentation + presentation.Save("sample.pptx"); + //Close the Presentation + presentation.Close(); + + + 'Create an instance equivalent to PowerPoint presentation + Dim presentationDocument As IPresentation = Presentation.Create() + 'Add a blank slide + Dim slide As ISlide = presentationDocument.Slides.Add(SlideLayoutType.Blank) + 'Add chart of specific size and position + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 100, 300, 400) + chart.ChartData.SetValue(1, 2, 1) + chart.ChartData.SetValue(1, 3, 2) + chart.ChartData.SetValue(1, 4, 3) + chart.ChartData.SetValue(2, 1, "Blue") + chart.ChartData.SetValue(2, 2, 0.4) + chart.ChartData.SetValue(2, 3, 0.5) + chart.ChartData.SetValue(2, 4, 1.2) + chart.ChartData.SetValue(3, 1, "Red") + chart.ChartData.SetValue(3, 2, 2.6) + chart.ChartData.SetValue(3, 3, 3.6) + chart.ChartData.SetValue(3, 4, 2.1) + chart.ChartData.SetValue(4, 1, "Orange") + chart.ChartData.SetValue(4, 2, 1.1) + chart.ChartData.SetValue(4, 3, 0.6) + chart.ChartData.SetValue(4, 4, 1.2) + chart.ChartData.SetValue(5, 1, "Light Blue") + chart.ChartData.SetValue(5, 2, 2.1) + chart.ChartData.SetValue(5, 3, 3.4) + chart.ChartData.SetValue(5, 4, 1.1) + Dim serieJan As IOfficeChartSerie = chart.Series.Add("1") + 'Sets the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 5, 2) + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("2") + 'Sets the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 5, 3) + 'Creates a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("3") + 'Sets the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 5, 4) + 'Set chart data range + chart.DataRange = chart.ChartData(2, 1, 5, 4) + 'Specifies the chart type + chart.ChartType = OfficeChartType.Bar_Stacked + chart.Series(0).DataPoints.DefaultDataPoint.DataLabels.IsValue = True + 'Set the number format of the data label in percentage, round off to two decimal places. + chart.Series(0).DataPoints.DefaultDataPoint.DataLabels.NumberFormat = "0.00%" + 'Save the presentation + presentationDocument.Save("sample.pptx") + 'Close the Presentation + presentationDocument.Close() + + + + + + Gets or sets a value that indicates to show bubble size for the data labels of a chart. + + True to show the bubble size. False to hide the bubble size. + + + + Gets or sets the delimiter for data labels. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the serie data labels + IOfficeChartDataLabels dataLabels = chart.Series[0].DataPoints.DefaultDataPoint.DataLabels; + //Set the position of data labels + dataLabels.Delimiter = "L"; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the serie data labels + Dim dataLabels As IOfficeChartDataLabels = chart.Series(0).DataPoints.DefaultDataPoint.DataLabels + 'Set the position of data labels + dataLabels.Delimiter = "L" + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that indicates the data label legend key is visible. + + Trueto show the legend key.Falseto hide the legend key. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the serie data labels + IOfficeChartDataLabels dataLabels = chart.Series[0].DataPoints.DefaultDataPoint.DataLabels; + //Set the serie name + dataLabels.IsSeriesName = true; + //Set the legend key for data labels + dataLabels.IsLegendKey = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the serie data labels + Dim dataLabels As IOfficeChartDataLabels = chart.Series(0).DataPoints.DefaultDataPoint.DataLabels + 'Set the serie name + dataLabels.IsSeriesName = True + 'Set the legend key for data labels + dataLabels.IsLegendKey = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that indicates Leader Lines is in data labels. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type as Pie chart + chart.ChartType = OfficeChartType.Pie; + //Get the serie data labels + IOfficeChartDataLabels dataLabels = chart.Series[0].DataPoints.DefaultDataPoint.DataLabels; + //Set the leader lines + dataLabels.ShowLeaderLines = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type as Pie chart + chart.ChartType = OfficeChartType.Pie + 'Get the serie data labels + Dim dataLabels As IOfficeChartDataLabels = chart.Series(0).DataPoints.DefaultDataPoint.DataLabels + 'Set the leader lines + dataLabels.ShowLeaderLines = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the position of the data labels. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the serie data labels + IOfficeChartDataLabels dataLabels = chart.Series[0].DataPoints.DefaultDataPoint.DataLabels; + //Set the serie name + dataLabels.IsSeriesName = true; + //Set the legend key for data labels + dataLabels.IsLegendKey = true; + //Set the position of data labels + dataLabels.Position = OfficeDataLabelPosition.Outside; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the serie data labels + Dim dataLabels As IOfficeChartDataLabels = chart.Series(0).DataPoints.DefaultDataPoint.DataLabels + 'Set the serie name + dataLabels.IsSeriesName = True + 'Set the legend key for data labels + dataLabels.IsLegendKey = True + 'Set the position of data labels + dataLabels.Position = OfficeDataLabelPosition.Outside + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that indicates to show the value from cells for the data labels on a chart. + + Trueto show the value from cells range.Falseto hide the value form cells range. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the serie data labels + IOfficeChartDataLabels dataLabels = chart.Series[0].DataPoints.DefaultDataPoint.DataLabels; + //Set the value form cells to datalabels. + dataLabels.IsValueFromCells = true; + //Set teh value form cells range in datalabels. + dataLabels.ValueFromCellsRange=chart.ChartData[3,5,3,7]; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the serie data labels + Dim dataLabels As IOfficeChartDataLabels = chart.Series(0).DataPoints.DefaultDataPoint.DataLabels + 'Set value form cells to DataLables. + 'Set value from cells range in Datalabels' + dataLabels.IsValueFromCells = true; + dataLabels.ValueFromCellsRange=chart.ChartData[3,5,3,7]; + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that indicates to value from cells range for the data labels on a chart. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the serie data labels + IOfficeChartDataLabels dataLabels = chart.Series[0].DataPoints.DefaultDataPoint.DataLabels; + //Set the value form cells to datalabels. + dataLabels.IsValueFromCells = true; + //Set teh value form cells range in datalabels. + dataLabels.ValueFromCellsRange=chart.ChartData[3,5,3,7]; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the serie data labels + Dim dataLabels As IOfficeChartDataLabels = chart.Series(0).DataPoints.DefaultDataPoint.DataLabels + 'Set value form cells to DataLables. + 'Set value from cells range in Datalabels' + dataLabels.IsValueFromCells = true; + dataLabels.ValueFromCellsRange=chart.ChartData[3,5,3,7]; + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Summary description for IInternalFont. + + + + + Returns font index. Read-only. + + + + + Returns FontImpl for current font. Read-only. + + + + + Returns textarea's color object. Read-only. + + + + + Gets value indicating whether TextRotation was changed. Read-only. + + + + + Represents the Legend Paragraph + + + + + Represents the Default Fontname + + + + + Represents the Default Language + + + + + Represents the Default size + + + + + Represent the value form cells range in datalabels. + + + + + Represent the highlight color is applied for the datalabels. + + + + + Represent the indicates whether to check the condition. + + + + + Parent Series. + + + + + Parent chart + + + + + Text area. + + + + + Parent data point; + + + + + Represents Excel 2007 layout data + + + + + boolean containing delete value + + + + + Represents the TextArea Paragraph + + + + + Indicats whether to show text properties or not + + + + + Indicats whether to show text size properties or not + + + + + Indicats whether to show text bold properties or not + + + + + Indicats whether to show text italic properties or not + + + + + Indicates if data labels are linked to source + + + + + Indicates whether to show leader lines or not + + + + + The array stores the cache information + + + + + Indicates whether the font is changed or not + + + + + Indicates if the data label is created by the user + + + + + Initializes new instance of data label and sets its parent and application objects. + + Application object. + Parent object + Data point index. + + + + Searches for all necessary parent objects. + + boolean value indicates whether the parent is chart or serie + + + + Set data labels to individual data points + + value to set + name of the data label + + + + Generates the font object corresponding to the current font. + + The generated supported font. + + + + Sets the format string of the data label. + + + + + Update datalabel text. + + ChartDataLabel object + Indicating whether value from cells value display to datalabels. + + + + Updates Series index. + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + New font indexes. + New worksheet names. + A new object that is a copy of this instance. + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Gets and sets boolean value indicating whether display to value from cells value to datalabels. + + + + + Gets and sets indicating whether value from cells range in datalables. + + + + + Gets and sets indicating whether value from cells range in datalables. + + + + + Indicates whether series name is in data labels. + + + + + Indicates whether category name is in data labels. + + + + + Indicates whether value is in data labels. + + + + + Indicates whether percentage is in data labels. + + + + + Indicates if data labels are linked to source. + + + + + Indicates whether bubble size is in data labels. + + + + + Delimiter. + + + + + Indicates whether legend key is in data labels. + + + + + Indicates whether Leader Lines is in data labels. + + + + + Represents data labels position. + + + + + Area's text. + + + + + Text rotation angle. + + + + + Return format of the text area. + + + + + True if the font is bold. Read / write Boolean. + + + + + Returns or sets the primary color of the object. + Read / write ExcelKnownColors. + + + + + True if the Highlight color is applied. Read / write Boolean. + + + + + Gets / sets font color. Searches for the closest color in + the workbook palette. + + + + + True if the font style is italic. Read / write Boolean. + + + + + True if the font is an outline font. Read / write Boolean. + + + + + True if the font is a shadow font or if the object has + a shadow. Read / write Boolean. + + + + + Returns or sets the size of the font. Read / write Variant. + + + + + True if the font is struck through with a horizontal line. + Read / write Boolean + + + + + True if the font is formatted as subscript. + False by default. Read / write Boolean. + + + + + True if the font is formatted as superscript. False by default. + Read/write Boolean + + + + + Returns or sets the type of underline applied to the font. Can + be one of the following ExcelUnderlineStyle constants. + Read / write OfficeUnderline. + + + + + Returns or sets the font name. Read / write string. + + + + + Gets / sets font vertical alignment. + + + + + Indicates whether color is automatically selected. Read-only. + + + + + Gets / sets text area. + + + + + Gets corresponding data format. Read-only. + + + + + Gets or sets Excel 2007 layout data + + + + + Gets or sets whether to delete or not. + + + + + Gets value indicating whether TextRotation was changed. Read-only. + + + + + Represents the Legend Paragraph + + + + + Gets or sets the format string of the data label. + + + Number format is specified by the formatCode attribute.To know more about the possible formatCode + see NumberFormat. + + + + //Create an instance equivalent to PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add a blank slide + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart of specific size and position + IPresentationChart chart = slide.Charts.AddChart(100, 100, 300, 400); + chart.ChartData.SetValue(1, 2, 1); + chart.ChartData.SetValue(1, 3, 2); + chart.ChartData.SetValue(1, 4, 3); + chart.ChartData.SetValue(2, 1, "Blue"); + chart.ChartData.SetValue(2, 2, 0.4); + chart.ChartData.SetValue(2, 3, 0.5); + chart.ChartData.SetValue(2, 4, 1.2); + chart.ChartData.SetValue(3, 1, "Red"); + chart.ChartData.SetValue(3, 2, 2.6); + chart.ChartData.SetValue(3, 3, 3.6); + chart.ChartData.SetValue(3, 4, 2.1); + chart.ChartData.SetValue(4, 1, "Orange"); + chart.ChartData.SetValue(4, 2, 1.1); + chart.ChartData.SetValue(4, 3, 0.6); + chart.ChartData.SetValue(4, 4, 1.2); + chart.ChartData.SetValue(5, 1, "Light Blue"); + chart.ChartData.SetValue(5, 2, 2.1); + chart.ChartData.SetValue(5, 3, 3.4); + chart.ChartData.SetValue(5, 4, 1.1); + IOfficeChartSerie serieJan = chart.Series.Add("1"); + //Sets the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 5, 2]; + IOfficeChartSerie serieFeb = chart.Series.Add("2"); + //Sets the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 5, 3]; + //Creates a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("3"); + //Sets the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 5, 4]; + //Set chart data range + chart.DataRange = chart.ChartData[2, 1, 5, 4]; + //Specifies the chart type + chart.ChartType = OfficeChartType.Bar_Stacked; + chart.Series[0].DataPoints.DefaultDataPoint.DataLabels.IsValue = true; + //Set the number format of the data label in percentage, round off to two decimal places + chart.Series[0].DataPoints.DefaultDataPoint.DataLabels.NumberFormat = "0.00%"; + //Save the presentation + presentation.Save("sample.pptx"); + //Close the Presentation + presentation.Close(); + + + 'Create an instance equivalent to PowerPoint presentation + Dim presentationDocument As IPresentation = Presentation.Create() + 'Add a blank slide + Dim slide As ISlide = presentationDocument.Slides.Add(SlideLayoutType.Blank) + 'Add chart of specific size and position + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 100, 300, 400) + chart.ChartData.SetValue(1, 2, 1) + chart.ChartData.SetValue(1, 3, 2) + chart.ChartData.SetValue(1, 4, 3) + chart.ChartData.SetValue(2, 1, "Blue") + chart.ChartData.SetValue(2, 2, 0.4) + chart.ChartData.SetValue(2, 3, 0.5) + chart.ChartData.SetValue(2, 4, 1.2) + chart.ChartData.SetValue(3, 1, "Red") + chart.ChartData.SetValue(3, 2, 2.6) + chart.ChartData.SetValue(3, 3, 3.6) + chart.ChartData.SetValue(3, 4, 2.1) + chart.ChartData.SetValue(4, 1, "Orange") + chart.ChartData.SetValue(4, 2, 1.1) + chart.ChartData.SetValue(4, 3, 0.6) + chart.ChartData.SetValue(4, 4, 1.2) + chart.ChartData.SetValue(5, 1, "Light Blue") + chart.ChartData.SetValue(5, 2, 2.1) + chart.ChartData.SetValue(5, 3, 3.4) + chart.ChartData.SetValue(5, 4, 1.1) + Dim serieJan As IOfficeChartSerie = chart.Series.Add("1") + 'Sets the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 5, 2) + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("2") + 'Sets the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 5, 3) + 'Creates a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("3") + 'Sets the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 5, 4) + 'Set chart data range + chart.DataRange = chart.ChartData(2, 1, 5, 4) + 'Specifies the chart type + chart.ChartType = OfficeChartType.Bar_Stacked + chart.Series(0).DataPoints.DefaultDataPoint.DataLabels.IsValue = True + 'Set the number format of the data label in percentage, round off to two decimal places + chart.Series(0).DataPoints.DefaultDataPoint.DataLabels.NumberFormat = "0.00%" + 'Save the presentation + presentationDocument.Save("sample.pptx") + 'Close the Presentation + presentationDocument.Close() + + + + + + Gets or sets a value indicating whether this instance is formula. + + + true if this instance is formula; otherwise, false. + + + + + Gets or sets a value indicating whether to show text properties or not + + + + + Gets or sets a value indicating whether to show text size properties or not + + + + + Gets or sets a value indicating whether to show text bold properties or not + + + + + Gets or sets a value indicating whether to show text italic properties or not + + + + + Gets or sets the Text Rotation + + + + + Indicates if the data label is created by the user + + + + + Indicates whether the serie type is pie + + + + + Parent Workbook + + + + + Gets / Sets the string array + + + + + Gets or sets the Chart serie. + + + + + Data labels color. Read-only. + + + + + Returns font index. Read-only. + + + + + Returns FontImpl for current font. Read-only. + + + + + Indicates whether the font is changed or not + + + + + Represents single data point in the collection. + + + + + Represents single data point in the chart. + + + + + Gets the data label associated with the data point. Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Bar_Stacked_3D; + //Get the serie data point + IOfficeChartDataPoint dataPoint = chart.Series[0].DataPoints.DefaultDataPoint; + //Get the data labels of data point + IOfficeChartDataLabels dataLabels = dataPoint.DataLabels; + //Set the position of the data label + dataLabels.Position = OfficeDataLabelPosition.Center; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Bar_Stacked_3D + 'Get the serie data point + Dim dataPoint As IOfficeChartDataPoint = chart.Series(0).DataPoints.DefaultDataPoint + 'Get the data labels of data point + Dim dataLabels As IOfficeChartDataLabels = dataPoint.DataLabels + 'Set the position of the data label + dataLabels.Position = OfficeDataLabelPosition.Center + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets index of the point in the points collection. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Bar_Stacked_3D; + //Get the serie data point + IOfficeChartDataPoint dataPoint = chart.Series[0].DataPoints.DefaultDataPoint; + //Gets the index of data point from points collection + int index = dataPoint.Index; + //Check if the point is default data point + bool isDefault = dataPoint.IsDefault; + //Set the default marker type + dataPoint.IsDefaultmarkertype = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Bar_Stacked_3D + 'Get the serie data point + Dim dataPoint As IOfficeChartDataPoint = chart.Series(0).DataPoints.DefaultDataPoint + 'Gets the index of data point from points collection + Dim index As Integer = dataPoint.Index + 'Check if the point is default data point + Dim isDefault As Boolean = dataPoint.IsDefault + 'Set the default marker type + dataPoint.IsDefaultmarkertype = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the data format of chart serie. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Bar_Stacked_3D; + //Get the serie data point + IOfficeChartDataPoint dataPoint = chart.Series[0].DataPoints.DefaultDataPoint; + //Get the data format of the data point, read only + IOfficeChartSerieDataFormat dataFormat = dataPoint.DataFormat; + //Set the BarShapeTop + dataFormat.BarShapeTop = OfficeTopFormat.Trunc; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Bar_Stacked_3D + 'Get the serie data point + Dim dataPoint As IOfficeChartDataPoint = chart.Series(0).DataPoints.DefaultDataPoint + 'Get the data format of the data point, read only + Dim dataFormat As IOfficeChartSerieDataFormat = dataPoint.DataFormat + 'Set the BarShapeTop + dataFormat.BarShapeTop = OfficeTopFormat.Trunc + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets whether this data point is default data point. Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Bar_Stacked_3D; + //Get the serie data point + IOfficeChartDataPoint dataPoint = chart.Series[0].DataPoints.DefaultDataPoint; + //Gets the index of data point from points collection + int index = dataPoint.Index; + //Check if the point is default data point + bool isDefault = dataPoint.IsDefault; + //Set the default marker type + dataPoint.IsDefaultmarkertype = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Bar_Stacked_3D + 'Get the serie data point + Dim dataPoint As IOfficeChartDataPoint = chart.Series(0).DataPoints.DefaultDataPoint + 'Gets the index of data point from points collection + Dim index As Integer = dataPoint.Index + 'Check if the point is default data point + Dim isDefault As Boolean = dataPoint.IsDefault + 'Set the default marker type + dataPoint.IsDefaultmarkertype = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets whether marker type is default. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Bar_Stacked_3D; + //Get the serie data point + IOfficeChartDataPoint dataPoint = chart.Series[0].DataPoints.DefaultDataPoint; + //Gets the index of data point from points collection + int index = dataPoint.Index; + //Check if the point is default data point + bool isDefault = dataPoint.IsDefault; + //Set the default marker type + dataPoint.IsDefaultmarkertype = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Bar_Stacked_3D + 'Get the serie data point + Dim dataPoint As IOfficeChartDataPoint = chart.Series(0).DataPoints.DefaultDataPoint + 'Gets the index of data point from points collection + Dim index As Integer = dataPoint.Index + 'Check if the point is default data point + Dim isDefault As Boolean = dataPoint.IsDefault + 'Set the default marker type + dataPoint.IsDefaultmarkertype = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Data labels. + + + + + Point index. + + + + + Data format. + + + + + Represents parent chart. + + + + + Represents whether the series has datapoint or not + + + + + Represent whether it's having the seperate seperate marker + + + + + Indicates whether bubbles have a 3-D effect applied to them or not + + + + + Represents the amount the data shall be moved from the center of the pie. + + + + + Represents whether the pie has explosion + + + + + Initializes new instance and sets its application and parent objects. + + Application object. + Parent object. + Index of the data point. + + + + Creates data labels object if necessary. + + + + + Creates a new object that is a copy of the current instance. + + Parent object for the cloned object. + New font indexes. + Dictionary with new worksheet names. + A new object that is a copy of this instance. + + + + Updates Series index. + + + + + Changes data format to create ChartStockHighLowClose chart type. + + + + + Changes data format to create ChartStockHighLowClose chart type. + + + + + Changes intimate bubble series. + + Type to change. + + + + Updates current data format. + + Represents data format for update. + + + + Clears data formats. + + Represents format to update. + + + + Returns data labels object for the data point. Read-only. + + + + + Returns data format. Read-only. + + + + + Gets /sets inner data format. + + + + + Gets / sets index of the point in the points collection. + + + + + Returns data format or null. + + + + + Indicates whether this data point is default data point. Read-only. + + + + + Indicates whether data labels object was created for this data point. Read-only. + + + + + Indicates whether the series has datapoint or not. + + + + + Indicate It's having the seperate marker type + + + + + Indicates whether bubbles have a 3-D effect applied to them or not + + + + + Gets or sets the amount the data shall be moved from the center of the pie. + + + + + Gets the boolean value which represents whether the pie has explosion + + + + + True if the data point is considered as Subtotals or Totals. otherwise False. + + Applies only to Waterfall charts. + + + + Represents collection of data points in the chart series. + + + + + Represents a collection of data point in the series. + + + + + Gets the default data points of the chart. Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IOfficeChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the series data points + IOfficeChartDataPoints dataPoints = chart.Series[0].DataPoints; + //Get the default data point, read only + IOfficeChartDataPoint dataPoint = dataPoints.DefaultDataPoint; + //Get the data labels of data point + IOfficeChartDataLabels dataLabels = dataPoint.DataLabels; + //Set the position of the data label + dataLabels.Position = OfficeDataLabelPosition.Center; + //Set the series name + dataLabels.IsSeriesName = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IOfficeChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the series data points + Dim dataPoints As IOfficeChartDataPoints = chart.Series(0).DataPoints + 'Get the default data point, read only + Dim dataPoint As IOfficeChartDataPoint = dataPoints.DefaultDataPoint + 'Get the data labels of data point + Dim dataLabels As IOfficeChartDataLabels = dataPoint.DataLabels + 'Set the position of the data label + dataLabels.Position = OfficeDataLabelPosition.Center + 'Set the series name + dataLabels.IsSeriesName = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets single data point by its index. Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IOfficeChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the series data points + IOfficeChartDataPoints dataPoints = chart.Series[0].DataPoints; + //Get the data point using the index, read only + IOfficeChartDataPoint dataPoint = dataPoints[0]; + //Get the data labels of data point + IOfficeChartDataLabels dataLabels = dataPoint.DataLabels; + //Set the position of the data label + dataLabels.Position = OfficeDataLabelPosition.Center; + //Set the series name + dataLabels.IsSeriesName = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IOfficeChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the series data points + Dim dataPoints As IOfficeChartDataPoints = chart.Series(0).DataPoints + 'Get the data point using the index, read only + Dim dataPoint As IOfficeChartDataPoint = dataPoints(0) + 'Get the data labels of data point + Dim dataLabels As IOfficeChartDataLabels = dataPoint.DataLabels + 'Set the position of the data label + dataLabels.Position = OfficeDataLabelPosition.Center + 'Set the series name + dataLabels.IsSeriesName = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Format for data points without explicit format. + + + + + Collection of used data points, key - int index, value - data point. + + + + + Parent chart series. + + + + + Parent chart + + + + + Initializes new instance of the collection and sets its parent and application properties. + + Application object. + Parent object. + + + + Finds parent objects. + + + + + Finds parent objects for chart common data points + + + + + Creates a new object that is a copy of the current instance. + + Parent object for the cloned object. + Parent workbook. + Dictionary with new font indexes. + Dictionary with new worksheet names. + A new object that is a copy of this instance. + + + + Adds new data point to the collection. + + Data point to add. + + + + Removes all elements from the collection. + + + + + Check for data labels on data points + + retuns true,if single data point have data labels,otherwise false + + + + Updates index of the parent Series. + + + + + Clears all series data formats. + + Represents format to update. + + + + Clear the data points and the formats of the individual and default data points are preserved + + + + + Returns an enumerator that iterates through a collection. + + An IEnumerator object that can be used to iterate through the collection. + + + + Returns single entry from the collection. Read-only. + + + + + Returns default data point which describes formats for data points without format. Read-only. + + + + + Indicates whether workbook is loading. Read-only. + + + + + Gets the default data format or null. Read-only. + + + + + Returns number of defined (created) data points. Read-only. + + + + + Represents a range of values of the chart. + + + + + Sets the value in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + + Sets the value in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + + Sets the value in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + + Sets the value in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + + Returns the cell value. + + One-based row index of the cell to get value from. + One-based column index of the cell to get value from. + Returns value corresponding to the cell. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Get data from the chart using specific RowIndex and columnIndex + object value = chart.DataRange.GetValue(2, 3); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Returns the cell value. + + One-based row index of the cell to get value from. + One-based column index of the cell to get value from. + If true returns formula value otherwise returns formula. + if true returns the value of formula. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Get data from the chart using specific RowIndex and columnIndex + object value = chart.DataRange.GetValue(2, 3,true); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets a first row of the range. Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to slide + IPresentationChart chart = slide.Shapes.AddChart(100, 120, 500, 300); + //Sets the data range of chart + chart.DataRange = chart.ChartData[1, 2, 4, 3]; + //Set data to the chart- RowIndex, columnIndex and data + chart.ChartData.SetValue(1, 2, "2012"); + chart.ChartData.SetValue(2, 2, 330); + chart.ChartData.SetValue(3, 2, 490); + chart.ChartData.SetValue(4, 2, 700); + //Set the chart type + chart.ChartType = OfficeChartType.Area; + //Get the first and last row + int _firstRow = chart.DataRange.FirstRow; + int _lastRow = chart.DataRange.LastRow; + //Get the first and last column + int _firstColumn = chart.DataRange.FirstColumn; + int _lastColumn = chart.DataRange.LastColumn; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets a last row of the range. Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to slide + IPresentationChart chart = slide.Shapes.AddChart(100, 120, 500, 300); + //Sets the data range of chart + chart.DataRange = chart.ChartData[1, 2, 4, 3]; + //Set data to the chart- RowIndex, columnIndex and data + chart.ChartData.SetValue(1, 2, "2012"); + chart.ChartData.SetValue(2, 2, 330); + chart.ChartData.SetValue(3, 2, 490); + chart.ChartData.SetValue(4, 2, 700); + //Set the chart type + chart.ChartType = OfficeChartType.Area; + //Get the first and last row + int _firstRow = chart.DataRange.FirstRow; + int _lastRow = chart.DataRange.LastRow; + //Get the first and last column + int _firstColumn = chart.DataRange.FirstColumn; + int _lastColumn = chart.DataRange.LastColumn; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets a first column of the range. Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to slide + IPresentationChart chart = slide.Shapes.AddChart(100, 120, 500, 300); + //Sets the data range of chart + chart.DataRange = chart.ChartData[1, 2, 4, 3]; + //Set data to the chart- RowIndex, columnIndex and data + chart.ChartData.SetValue(1, 2, "2012"); + chart.ChartData.SetValue(2, 2, 330); + chart.ChartData.SetValue(3, 2, 490); + chart.ChartData.SetValue(4, 2, 700); + //Set the chart type + chart.ChartType = OfficeChartType.Area; + //Get the first and last row + int _firstRow = chart.DataRange.FirstRow; + int _lastRow = chart.DataRange.LastRow; + //Get the first and last column + int _firstColumn = chart.DataRange.FirstColumn; + int _lastColumn = chart.DataRange.LastColumn; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets a last column of the range. Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to slide + IPresentationChart chart = slide.Shapes.AddChart(100, 120, 500, 300); + //Sets the data range of chart + chart.DataRange = chart.ChartData[1, 2, 4, 3]; + //Set data to the chart- RowIndex, columnIndex and data + chart.ChartData.SetValue(1, 2, "2012"); + chart.ChartData.SetValue(2, 2, 330); + chart.ChartData.SetValue(3, 2, 490); + chart.ChartData.SetValue(4, 2, 700); + //Set the chart type + chart.ChartType = OfficeChartType.Area; + //Get the first and last row + int _firstRow = chart.DataRange.FirstRow; + int _lastRow = chart.DataRange.LastRow; + //Get the first and last column + int _firstColumn = chart.DataRange.FirstColumn; + int _lastColumn = chart.DataRange.LastColumn; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + One-based row index of the cell to get value from. + One-based column index of the cell to get value from. + + + One-based row index of the cell to get value from. + One-based column index of the cell to get value from. + If true returns formula value otherwise returns formula. + + + + Retruns the internal worksheet referred from the chart range + + + + + Class used for Chart DataTable implementation. + + + + + Represents the data table of the chart. + + + + + Gets or sets a value that indicates the chart data table has horizontal cell borders or not. + + Trueif the chart data table has horizontal cell borders.OtherwiseFalse. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Enable the chart data table + chart.HasDataTable = true; + //Get the data table of chart + IOfficeChartDataTable datatable = chart.DataTable; + //Set the horizontal border + datatable.HasHorzBorder = true; + //Set the vertical border + datatable.HasVertBorder = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Enable the chart data table + chart.HasDataTable = True + 'Get the data table of chart + Dim datatable As IOfficeChartDataTable = chart.DataTable + 'Set the horizontal border + datatable.HasHorzBorder = True + 'Set the vertical border + datatable.HasVertBorder = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that indicates the chart data table has vertical cell borders or not. + + Trueif the chart data table has vertical cell borders.OtherwiseFalse. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Enable the chart data table + chart.HasDataTable = true; + //Get the data table of chart + IOfficeChartDataTable datatable = chart.DataTable; + //Set the horizontal border + datatable.HasHorzBorder = true; + //Set the vertical border + datatable.HasVertBorder = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Enable the chart data table + chart.HasDataTable = True + 'Get the data table of chart + Dim datatable As IOfficeChartDataTable = chart.DataTable + 'Set the horizontal border + datatable.HasHorzBorder = True + 'Set the vertical border + datatable.HasVertBorder = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that indicates the chart data table has borders or not. + + Trueif the chart data table has borders.OtherwiseFalse. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Enable the chart data table + chart.HasDataTable = true; + //Get the data table of chart + IOfficeChartDataTable datatable = chart.DataTable; + //Set the borders + datatable.HasBorders = true; + //Set the horizontal border + datatable.HasHorzBorder = true; + //Set the vertical border + datatable.HasVertBorder = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Enable the chart data table + chart.HasDataTable = True + 'Get the data table of chart + Dim datatable As IOfficeChartDataTable = chart.DataTable + 'Set the horizontal border + datatable.HasHorzBorder = True + 'Set the vertical border + datatable.HasVertBorder = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that indicates the chart data table show series keys or not. + + Trueif the chart data table show series keys.OtherwiseFalse. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Enable the chart data table + chart.HasDataTable = true; + //Get the data table of chart + IOfficeChartDataTable datatable = chart.DataTable; + //Set the horizontal border + datatable.HasHorzBorder = true; + //Set the vertical border + datatable.HasVertBorder = true; + //Set the series keys + datatable.ShowSeriesKeys = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Enable the chart data table + chart.HasDataTable = True + 'Get the data table of chart + Dim datatable As IOfficeChartDataTable = chart.DataTable + 'Set the horizontal border + datatable.HasHorzBorder = True + 'Set the vertical border + datatable.HasVertBorder = True + 'Set the series keys + datatable.ShowSeriesKeys = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets text area of the data table. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Enable the chart data table + chart.HasDataTable = true; + //Get the data table of chart + IOfficeChartDataTable datatable = chart.DataTable; + //Get the text area of data table + IOfficeChartTextArea textArea = datatable.TextArea; + //Set the color of text area + textArea.Color = OfficeKnownColors.Violet; + //Set the font name + textArea.FontName = "Helvetica"; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Enable the chart data table + chart.HasDataTable = True + 'Get the data table of chart + Dim datatable As IOfficeChartDataTable = chart.DataTable + 'Get the text area of data table + Dim textArea As IOfficeChartTextArea = datatable.TextArea + 'Set the color of text area + textArea.Color = OfficeKnownColors.Violet + 'Set the font name + textArea.FontName = "Helvetica" + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + This record stores options for the chart data table. + + + + + Records that were read (if data table was not created but loaded). + + + + + Represents chart text record and sub records. + + + + + Represents data table has shape properties or not. + + + + + This is used to hold data table's shape properties. + + + + + Creates default data table. + + Application object for the new data table. + Parent object for the new data table. + + + + Clone current Record. + + Parent object for create new instance. + Returns clone of current object. + + + + True if data table has horizontal border. + + + + + True if data table has vertical border. + + + + + True if data table has borders. + + + + + True if there is series keys in the data table. + + + + + Return text area of data table. + + + + + Represents ChartDropBar record and another records. + + + + + Represents ChartDropBarImpl. + + + + + Represents the options for area: area fill and border formatting. + + + + + Gets whether interior object was created. Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the serie format + IOfficeChartFillBorder chartFill = chart.Series[0].SerieFormat; + //Get the line properties of chart fill + IOfficeChartBorder line = chartFill.LineProperties; + //Check interior object, read only + bool interior = chartFill.HasInterior; + //Check for 3D properties, read only + bool _3DProperties = chartFill.Has3dProperties; + //Check the line properties, read only + bool lineProps = chartFill.HasLineProperties; + //Check the shadow properties, read only + bool shadowProps = chartFill.HasShadowProperties; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the serie format + Dim chartFill As IOfficeChartFillBorder = chart.Series(0).SerieFormat + 'Get the line properties of chart fill + Dim line As IOfficeChartBorder = chartFill.LineProperties + 'Check interior object, read only + Dim interior As Boolean = chartFill.HasInterior + 'Check for 3D properties, read only + Dim _3DProperties As Boolean = chartFill.Has3dProperties + 'Check the line properties, read only + Dim lineProps As Boolean = chartFill.HasLineProperties + 'Check the shadow properties, read only + Dim shadowProps As Boolean = chartFill.HasShadowProperties + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets whether line formatting object was created. Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the serie format + IOfficeChartFillBorder chartFill = chart.Series[0].SerieFormat; + //Get the line properties of chart fill + IOfficeChartBorder line = chartFill.LineProperties; + //Check interior object, read only + bool interior = chartFill.HasInterior; + //Check for 3D properties, read only + bool _3DProperties = chartFill.Has3dProperties; + //Check the line properties, read only + bool lineProps = chartFill.HasLineProperties; + //Check the shadow properties, read only + bool shadowProps = chartFill.HasShadowProperties; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the serie format + Dim chartFill As IOfficeChartFillBorder = chart.Series(0).SerieFormat + 'Get the line properties of chart fill + Dim line As IOfficeChartBorder = chartFill.LineProperties + 'Check interior object, read only + Dim interior As Boolean = chartFill.HasInterior + 'Check for 3D properties, read only + Dim _3DProperties As Boolean = chartFill.Has3dProperties + 'Check the line properties, read only + Dim lineProps As Boolean = chartFill.HasLineProperties + 'Check the shadow properties, read only + Dim shadowProps As Boolean = chartFill.HasShadowProperties + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a value indicating whether [has3d properties]. + + true if [has3d properties]; otherwise, false. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the serie format + IOfficeChartFillBorder chartFill = chart.Series[0].SerieFormat; + //Get the line properties of chart fill + IOfficeChartBorder line = chartFill.LineProperties; + //Check interior object, read only + bool interior = chartFill.HasInterior; + //Check for 3D properties, read only + bool _3DProperties = chartFill.Has3dProperties; + //Check the line properties, read only + bool lineProps = chartFill.HasLineProperties; + //Check the shadow properties, read only + bool shadowProps = chartFill.HasShadowProperties; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the serie format + Dim chartFill As IOfficeChartFillBorder = chart.Series(0).SerieFormat + 'Get the line properties of chart fill + Dim line As IOfficeChartBorder = chartFill.LineProperties + 'Check interior object, read only + Dim interior As Boolean = chartFill.HasInterior + 'Check for 3D properties, read only + Dim _3DProperties As Boolean = chartFill.Has3dProperties + 'Check the line properties, read only + Dim lineProps As Boolean = chartFill.HasLineProperties + 'Check the shadow properties, read only + Dim shadowProps As Boolean = chartFill.HasShadowProperties + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a value indicating whether this instance has shadow properties. + + + true if this instance has shadow properties; otherwise, false. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the serie format + IOfficeChartFillBorder chartFill = chart.Series[0].SerieFormat; + //Get the line properties of chart fill + IOfficeChartBorder line = chartFill.LineProperties; + //Check interior object, read only + bool interior = chartFill.HasInterior; + //Check for 3D properties, read only + bool _3DProperties = chartFill.Has3dProperties; + //Check the line properties, read only + bool lineProps = chartFill.HasLineProperties; + //Check the shadow properties, read only + bool shadowProps = chartFill.HasShadowProperties; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the serie format + Dim chartFill As IOfficeChartFillBorder = chart.Series(0).SerieFormat + 'Get the line properties of chart fill + Dim line As IOfficeChartBorder = chartFill.LineProperties + 'Check interior object, read only + Dim interior As Boolean = chartFill.HasInterior + 'Check for 3D properties, read only + Dim _3DProperties As Boolean = chartFill.Has3dProperties + 'Check the line properties, read only + Dim lineProps As Boolean = chartFill.HasLineProperties + 'Check the shadow properties, read only + Dim shadowProps As Boolean = chartFill.HasShadowProperties + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets object, that represents line properties. Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the serie format + IOfficeChartFillBorder chartFill = chart.Series[0].SerieFormat; + //Get the line properties of chart fill + IOfficeChartBorder line = chartFill.LineProperties; + //Set the line color + line.LineColor = System.Drawing.Color.DarkGreen; + //Set the line weight + line.LineWeight = OfficeChartLineWeight.Wide; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the serie format + Dim chartFill As IOfficeChartFillBorder = chart.Series(0).SerieFormat + 'Get the line properties of chart fill + Dim line As IOfficeChartBorder = chartFill.LineProperties + 'Set the line color + line.LineColor = System.Drawing.Color.DarkGreen + 'Set the line weight + line.LineWeight = OfficeChartLineWeight.Wide + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets object, that represents area properties. Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the serie format + IOfficeChartFillBorder chartFill = chart.Series[0].SerieFormat; + //Get the interior of chart fill + IOfficeChartInterior _interior = chartFill.Interior; + //Enable the automatic format + _interior.UseAutomaticFormat = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the serie format + Dim chartFill As IOfficeChartFillBorder = chart.Series(0).SerieFormat + 'Get the interior of chart fill + Dim _interior As IOfficeChartInterior = chartFill.Interior + 'Enable the automatic format + _interior.UseAutomaticFormat = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets fill options. Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the serie format + IOfficeChartFillBorder chartFill = chart.Series[0].SerieFormat; + //Get the line properties of chart fill, read only + IOfficeFill fill = chartFill.Fill; + //set the fill type as pattern + fill.FillType = OfficeFillType.Pattern; + //Set the back color + fill.BackColor = Color.Red; + //Set the fore color + fill.ForeColor = Color.Yellow; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the serie format + Dim chartFill As IOfficeChartFillBorder = chart.Series(0).SerieFormat + 'Get the line properties of chart fill, read only + Dim fill As IOfficeFill = chartFill.Fill + 'set the fill type as pattern + fill.FillType = OfficeFillType.Pattern + 'Set the back color + fill.BackColor = System.Drawing.Color.Red + 'Set the fore color + fill.ForeColor = System.Drawing.Color.Yellow + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the chart3 D properties. + + The chart3 D properties. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the serie format + IOfficeChartFillBorder chartFill = chart.Series[0].SerieFormat; + //Get the shadow properties + IThreeDFormat _3Dimension = chartFill.ThreeD; + //Set the 3D properties + _3Dimension.BevelBottom = Office2007ChartBevelProperties.HardEdge; + _3Dimension.BevelBottomHeight = 140; + _3Dimension.BevelBottomWidth = 67; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the serie format + Dim chartFill As IOfficeChartFillBorder = chart.Series(0).SerieFormat + 'Get the shadow properties + Dim _3Dimension As IThreeDFormat = chartFill.ThreeD + 'Set the 3D properties + _3Dimension.BevelBottom = Office2007ChartBevelProperties.HardEdge + _3Dimension.BevelBottomHeight = 140 + _3Dimension.BevelBottomWidth = 67 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the shadow properties. + + The shadow properties. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the serie format + IOfficeChartFillBorder chartFill = chart.Series[0].SerieFormat; + //Get the shadow properties + IShadow shadow = chartFill.Shadow; + //Set the custom shadow style + shadow.HasCustomShadowStyle = true; + //set the shadow color + shadow.ShadowColor = System.Drawing.Color.Green; + //Set the shadow with inner preset + shadow.ShadowInnerPresets = Office2007ChartPresetsInner.InsideDiagonalBottomRight; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the serie format + Dim chartFill As IOfficeChartFillBorder = chart.Series(0).SerieFormat + 'Get the shadow properties + Dim shadow As IShadow = chartFill.Shadow + 'Set the custom shadow style + shadow.HasCustomShadowStyle = True + 'set the shadow color + shadow.ShadowColor = System.Drawing.Color.Green + 'Set the shadow with inner preset + shadow.ShadowInnerPresets = Office2007ChartPresetsInner.InsideDiagonalBottomRight + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the drop bar gap width (0 to 100%). + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Get the chart serie option + IOfficeChartFormat chartFormat = chart.Series[0].SerieFormat.CommonSerieOptions; + //Get the First Drop Bar + IOfficeChartDropBar dropBar = chartFormat.FirstDropBar; + //Set the gap width of data series in chart + dropBar.Gap = 100; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation__1.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Get the chart serie option + Dim chartFormat As IOfficeChartFormat = chart.Series(0).SerieFormat.CommonSerieOptions + 'Get the First Drop Bar + Dim dropBar As IOfficeChartDropBar = chartFormat.FirstDropBar + 'Set the gap width of data series in chart + dropBar.Gap = 100 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents interface, that synchronize chart fill color properties and interior colors. + + + + + Represents foreground color. + + + + + Represents background color. + + + + + Represents pattern. + + + + + Represents is automatic format. + + + + + Represents fill properties. + + + + + Represents visible. + + + + + Represents chart drop bar record. + + + + + Represents drop bar line format. + + + + + Represents drop bar area format. + + + + + Represents parent workBook. + + + + + Represents drop bar filling options. + + + + + Represents the 3D features + + + + + Represents Shadow + + + + + Initialize new instance. + + Current application. + Parent object. + + + + Sets parent objects. + + + + + Clones current object. + + Parent object. + Returns cloned object. + + + + This property indicates whether interior object was created. Read-only. + + + + + Represents the Shadow.Read-only + + + + + Gets a value indicating whether this instance has shadow properties. + + + true if this instance has shadow properties; otherwise, false. + + + + + Gets the chart3 D options. + + The chart3 D options. + + + + This property Indicates whether the Shadow object has been created(which includes the 3D properties) + + + + + This property indicates whether border formatting object was created. Read-only. + + + + + Drop bar gap width. + + + + + Returns interior object. Read-only. + + + + + Returns object, that represents line properties. Read-only. + + + + + Represents fill options. Read-only. + + + + + Represents foreground color. + + + + + Represents background color. + + + + + Represents pattern. + + + + + Represents if use automatic format. + + + + + Represents visibility. + + + + + Represents chart error bars. + + + + + Represents the error bars on a chart series. + + + + + Clears the formatting of the error bars. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line; + //Enable error bar X for a serie + chart.Series[0].HasErrorBarsX = true; + //Get the error bar X + IOfficeChartErrorBars errorBars = chart.Series[0].ErrorBarsX; + //Set the type + errorBars.Type = OfficeErrorBarType.StandardDeviation; + //Set the cap for errorbars + errorBars.HasCap = true; + //Set the include property + errorBars.Include = OfficeErrorBarInclude.Minus; + //Clear formats + errorBars.ClearFormats(); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line + 'Enable error bar X for a serie + chart.Series(0).HasErrorBarsX = True + 'Get the error bar X + Dim errorBars As IOfficeChartErrorBars = chart.Series(0).ErrorBarsX + 'Set the type + errorBars.Type = OfficeErrorBarType.StandardDeviation + 'Set the cap for errorbars + errorBars.HasCap = True + 'Set the include property + errorBars.Include = OfficeErrorBarInclude.Minus + 'Clear formats + errorBars.ClearFormats() + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Deletes the error bars. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line; + //Enable error bar X for a serie + chart.Series[0].HasErrorBarsX = true; + //Get the error bar X + IOfficeChartErrorBars errorBars = chart.Series[0].ErrorBarsX; + //Set the type + errorBars.Type = OfficeErrorBarType.StandardDeviation; + //Set the cap for errorbars + errorBars.HasCap = true; + //Set the include property + errorBars.Include = OfficeErrorBarInclude.Minus; + //Delete the error bars + errorBars.Delete(); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line + 'Enable error bar X for a serie + chart.Series(0).HasErrorBarsX = True + 'Get the error bar X + Dim errorBars As IOfficeChartErrorBars = chart.Series(0).ErrorBarsX + 'Set the type + errorBars.Type = OfficeErrorBarType.StandardDeviation + 'Set the cap for errorbars + errorBars.HasCap = True + 'Set the include property + errorBars.Include = OfficeErrorBarInclude.Minus + 'Delete the error bars + errorBars.Delete() + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the border object of the error bars. Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line; + //Enable error bar X for a serie + chart.Series[0].HasErrorBarsX = true; + //Get the error bar X + IOfficeChartErrorBars errorBars = chart.Series[0].ErrorBarsX; + //set the border line color + errorBars.Border.LineColor = System.Drawing.Color.BlueViolet; + //Set the border line weight + errorBars.Border.LineWeight = OfficeChartLineWeight.Wide; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line + 'Enable error bar X for a serie + chart.Series(0).HasErrorBarsX = True + 'Get the error bar X + Dim errorBars As IOfficeChartErrorBars = chart.Series(0).ErrorBarsX + 'set the border line color + errorBars.Border.LineColor = System.Drawing.Color.BlueViolet + 'Set the border line weight + errorBars.Border.LineWeight = OfficeChartLineWeight.Wide + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets error bar include type. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line; + //Enable error bar X for a serie + chart.Series[0].HasErrorBarsX = true; + //Get the error bar X + IOfficeChartErrorBars errorBars = chart.Series[0].ErrorBarsX; + //Set the type + errorBars.Type = OfficeErrorBarType.StandardDeviation; + //Set the cap for errorbars + errorBars.HasCap = true; + //Set the include property + errorBars.Include = OfficeErrorBarInclude.Minus; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line + 'Enable error bar X for a serie + chart.Series(0).HasErrorBarsX = True + 'Get the error bar X + Dim errorBars As IOfficeChartErrorBars = chart.Series(0).ErrorBarsX + 'Set the type + errorBars.Type = OfficeErrorBarType.StandardDeviation + 'Set the cap for errorbars + errorBars.HasCap = True + 'Set the include property + errorBars.Include = OfficeErrorBarInclude.Minus + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the value that indicates error bars has cap or not. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line; + //Enable error bar X for a serie + chart.Series[0].HasErrorBarsX = true; + //Get the error bar X + IOfficeChartErrorBars errorBars = chart.Series[0].ErrorBarsX; + //Set the type + errorBars.Type = OfficeErrorBarType.StandardDeviation; + //Set the cap for errorbars + errorBars.HasCap = true; + //Set the include property + errorBars.Include = OfficeErrorBarInclude.Minus; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line + 'Enable error bar X for a serie + chart.Series(0).HasErrorBarsX = True + 'Get the error bar X + Dim errorBars As IOfficeChartErrorBars = chart.Series(0).ErrorBarsX + 'Set the type + errorBars.Type = OfficeErrorBarType.StandardDeviation + 'Set the cap for errorbars + errorBars.HasCap = True + 'Set the include property + errorBars.Include = OfficeErrorBarInclude.Minus + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets chart error bar type. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line; + //Enable error bar X for a serie + chart.Series[0].HasErrorBarsX = true; + //Get the error bar X + IOfficeChartErrorBars errorBars = chart.Series[0].ErrorBarsX; + //set the border line color + errorBars.Border.LineColor = System.Drawing.Color.BlueViolet; + //Set the border line weight + errorBars.Border.LineWeight = OfficeChartLineWeight.Wide; + //Set the type + errorBars.Type = OfficeErrorBarType.StandardDeviation; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line + 'Enable error bar X for a serie + chart.Series(0).HasErrorBarsX = True + 'Get the error bar X + Dim errorBars As IOfficeChartErrorBars = chart.Series(0).ErrorBarsX + 'set the border line color + errorBars.Border.LineColor = System.Drawing.Color.BlueViolet + 'Set the border line weight + errorBars.Border.LineWeight = OfficeChartLineWeight.Wide + 'Set the type + errorBars.Type = OfficeErrorBarType.StandardDeviation + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets number value. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line; + //Enable error bar X for a serie + chart.Series[0].HasErrorBarsX = true; + //Get the error bar X + IOfficeChartErrorBars errorBars = chart.Series[0].ErrorBarsX; + //Set the include property + errorBars.Include = OfficeErrorBarInclude.Minus; + //Set the number value + errorBars.NumberValue = 12.78; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line + 'Enable error bar X for a serie + chart.Series(0).HasErrorBarsX = True + 'Get the error bar X + Dim errorBars As IOfficeChartErrorBars = chart.Series(0).ErrorBarsX + 'Set the include property + errorBars.Include = OfficeErrorBarInclude.Minus + 'Set the number value + errorBars.NumberValue = 12.78 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets custom plus value. + + + + + Gets or sets custom minus value. + + + + + Gets shadow formatting properties for the error bars. + + The shadow. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line; + //Enable error bar X for a serie + chart.Series[0].HasErrorBarsX = true; + //Get the error bar X + IOfficeChartErrorBars errorBars = chart.Series[0].ErrorBarsX; + //Set the shadow color + errorBars.Shadow.ShadowColor = System.Drawing.Color.Brown; + //Set the inner preset of shadow + errorBars.Shadow.ShadowInnerPresets = Office2007ChartPresetsInner.InsideDiagonalBottomRight; + //Set the size of the shadow + errorBars.Shadow.Size = 34; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line + 'Enable error bar X for a serie + chart.Series(0).HasErrorBarsX = True + 'Get the error bar X + Dim errorBars As IOfficeChartErrorBars = chart.Series(0).ErrorBarsX + 'Set the shadow color + errorBars.Shadow.ShadowColor = System.Drawing.Color.Brown + 'Set the inner preset of shadow + errorBars.Shadow.ShadowInnerPresets = Office2007ChartPresetsInner.InsideDiagonalBottomRight + 'Set the size of the shadow + errorBars.Shadow.Size = 34 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the 3-D�effect formatting properties for the error bars. Read-only + + The chart3 D options. + + + + Represents default value for X error bar. + + + + + Represents default value for Y axis. + + + + + Represents border object. + + + + + Represents error bar record. + + + + + Represents Shadow + + + + + Represents error include. + + + + + Represents parent Series. + + + + + Represents positive range of custom values. + + + + + Represents negative range of custom values. + + + + + Indicates that is on Y axis. + + + + + ChartAI record containing referred range. + + + + + Preserved marker formta record + + + + + Represents the 3D features + + + + + Represents the chart ErrorBar plus range values + + + + + Represents the chart ErrorBar minus range values + + + + + Creates new instance of error bars implementation. + + Application object. + Represents parent object. + Indicates if it's Y axis bar. + + + + Finds parent objects. + + + + + Clears current error bar. + + + + + Deletes current error bar. + + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Checks include value. + + Represents include value. + Returns true if class support current inclure; otherwise false. + + + + Clones current object. + + Represents parent object for new cloned instance. + Represents new names. + Returns cloned object. + + + + Represents border object. Read-only. + + + + + Represents error bar include type. + + + + + Indicates if error bar has cap. + + + + + Represents excel error bar type. + + + + + Represents number value. + + + + + Gets or sets a value indicating whether this instance is plus number literal. + + + true if this instance is plus number literal; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is minus number literal. + + + true if this instance is minus number literal; otherwise, false. + + + + + Represents custom positive value. + + + + + Represents custom positive value. + + + + + Represents custom negative value. + + + + + Represents custom negative value. + + + + + Represents the Shadow.Read-only + + + + + Gets the chart3 D options. + + The chart3 D options. + + + + Represents the chart ErrorBar plus range values + + + + + Represents the chart ErrorBar minus range values + + + + + Represents fill format in chart object. + + + + + Represents fill format in shape object. + + + + + Represents fill formatting for a shape. + + + + + Fills the specified shape with one large image. + + The name of the picture file. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the picture fill type for plot area + chart.PlotArea.Fill.UserPicture("Image.gif"); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Fills the specified shape with one large image. + + Represents user defined image. + The name of the picture file. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create instance for image + System.Drawing.Image image = System.Drawing.Image.FromFile("Image.gif"); + //Set the picture fill type for chart area + chart.ChartArea.Fill.UserPicture(image, "Image"); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Fills the specified shape with small tiles of an image. + + Represents user defined texture. + Represents name of user defined texture. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create instance for image + System.Drawing.Image image = System.Drawing.Image.FromFile("Image.gif"); + //Set the texture fill type for chart area + chart.ChartArea.Fill.UserTexture(image, "Image"); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Fills the specified shape with small tiles of an image. + + Path to image. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the texture fill type for plot area + chart.PlotArea.Fill.UserTexture("Image.gif"); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Sets the specified fill to a pattern. + + The pattern to be used for the specified fill. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the pattern fill for chart area + chart.ChartArea.Fill.Patterned(OfficeGradientPattern.Pat_50_Percent); + //Set the fore color + chart.ChartArea.Fill.ForeColor = System.Drawing.Color.PowderBlue; + //Set the back color + chart.ChartArea.Fill.BackColor = System.Drawing.Color.Pink; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Sets the specified fill to a preset gradient. + + Represents preset gradient type. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the preset gradient + chart.ChartArea.Fill.PresetGradient(OfficeGradientPreset.Grad_Early_Sunset); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Sets the specified fill to a preset gradient. + + Represents preset gradient type. + Represents gradient style, for preset gradient. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the preset gradient + chart.ChartArea.Fill.PresetGradient(OfficeGradientPreset.Grad_Parchment, OfficeGradientStyle.Horizontal); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Sets the specified fill to a preset gradient. + + Represents preset gradient type. + Represents gradient style, for preset gradient. + Represents gradient variant for preset gradient. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the preset gradient + chart.ChartArea.Fill.PresetGradient(OfficeGradientPreset.Grad_Fire, OfficeGradientStyle.FromCorner, OfficeGradientVariants.ShadingVariants_1); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Sets the specified fill format to a preset texture. + + Represents texture to set. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the preset texture + chart.ChartArea.Fill.PresetTextured(OfficeTexture.Canvas); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Sets the specified fill to a two-color gradient. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the gradient color + chart.ChartArea.Fill.TwoColorGradient(); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Sets the specified fill to a two-color gradient. + + Represents shading style. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the gradient color + chart.ChartArea.Fill.TwoColorGradient(OfficeGradientStyle.Horizontal); + //Set the fore color index + chart.ChartArea.Fill.ForeColorIndex = OfficeKnownColors.BlueCustom; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Sets the specified fill to a two-color gradient. + + Represents shading style. + Represents shading variant. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the gradient color + chart.ChartArea.Fill.TwoColorGradient(OfficeGradientStyle.Vertical, OfficeGradientVariants.ShadingVariants_2); + //Set the fore color index + chart.ChartArea.Fill.ForeColorIndex = OfficeKnownColors.BlueCustom; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Sets the specified fill to a one-color gradient. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the fill type as texture + chart.ChartArea.Fill.FillType = OfficeFillType.Gradient; + //Se the specified fill to one color gradient + chart.ChartArea.Fill.OneColorGradient(); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Sets the specified fill to a one-color gradient. + + Represents shading style. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the fill type as texture + chart.ChartArea.Fill.FillType = OfficeFillType.Gradient; + //Se the specified fill to one color gradient + chart.ChartArea.Fill.OneColorGradient(OfficeGradientStyle.Vertical, OfficeGradientVariants.ShadingVariants_2); + //Set the fill type for plot area + chart.PlotArea.Fill.FillType = OfficeFillType.Gradient; + //Set the fore color for plot area + chart.PlotArea.Fill.ForeColor = System.Drawing.Color.PowderBlue; + //Se the specified fill to one color gradient + chart.PlotArea.Fill.OneColorGradient(OfficeGradientStyle.Diagonl_Up); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Sets the specified fill to a one-color gradient. + + Represents shading style. + Represents shading variant. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the fill type as texture + chart.ChartArea.Fill.FillType = OfficeFillType.Gradient; + //Se the specified fill to one color gradient + chart.ChartArea.Fill.OneColorGradient(OfficeGradientStyle.Vertical, OfficeGradientVariants.ShadingVariants_2); + //Set the fill type for plot area + chart.PlotArea.Fill.FillType = OfficeFillType.Gradient; + //Set the fore color for plot area + chart.PlotArea.Fill.ForeColor = System.Drawing.Color.PowderBlue; + //Se the specified fill to one color gradient + chart.PlotArea.Fill.OneColorGradient(OfficeGradientStyle.Diagonl_Up); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Sets the specified fill to a uniform color. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the solid fill for chart area + chart.ChartArea.Fill.Solid(); + //Set the fore color for chart area + chart.ChartArea.Fill.ForeColor = System.Drawing.Color.PowderBlue; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets the fill type for the shape. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the fill type of the chart area + chart.ChartArea.Fill.FillType = OfficeFillType.Gradient; + //Set the gradient color type + chart.ChartArea.Fill.GradientColorType = OfficeGradientColor.TwoColor; + //Set the Back and fore colors + chart.ChartArea.Fill.BackColor = System.Drawing.Color.FromArgb(205, 217, 234); + chart.ChartArea.Fill.ForeColor = System.Drawing.Color.White; + //Set the gradient style + chart.ChartArea.Fill.GradientStyle = OfficeGradientStyle.FromCorner; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets the gradient style for the specified fill. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the fill type of the chart area + chart.ChartArea.Fill.FillType = OfficeFillType.Gradient; + //Set the gradient color type + chart.ChartArea.Fill.GradientColorType = OfficeGradientColor.TwoColor; + //Set the Back and fore colors + chart.ChartArea.Fill.BackColor = System.Drawing.Color.FromArgb(205, 217, 234); + chart.ChartArea.Fill.ForeColor = System.Drawing.Color.White; + //Set the gradient style + chart.ChartArea.Fill.GradientStyle = OfficeGradientStyle.FromCorner; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets the gradient variant type for the specified fill. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the fill type of the chart area + chart.ChartArea.Fill.FillType = OfficeFillType.Gradient; + //Set the fore color index of the fill + chart.ChartArea.Fill.ForeColorIndex = OfficeKnownColors.Brown; + //Set the gradient variant + chart.ChartArea.Fill.GradientVariant = OfficeGradientVariants.ShadingVariants_2; + //Set the preset gradient type + chart.ChartArea.Fill.PresetGradientType = OfficeGradientPreset.Grad_Desert; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets the degree of transparency of the specified fill as + a value from 0.0 (opaque) through 1.0 (clear). + + + + + Gets or sets the degree of transparency of the specified fill as + a value from 0.0 (opaque) through 1.0 (clear). + + + + + Gets or sets the gradient color type for the specified fill. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the fill type of the chart area + chart.ChartArea.Fill.FillType = OfficeFillType.Gradient; + //Set the gradient color type + chart.ChartArea.Fill.GradientColorType = OfficeGradientColor.TwoColor; + //Set the Back and fore colors + chart.ChartArea.Fill.BackColor = System.Drawing.Color.FromArgb(205, 217, 234); + chart.ChartArea.Fill.ForeColor = System.Drawing.Color.White; + //Set the gradient style + chart.ChartArea.Fill.GradientStyle = OfficeGradientStyle.FromCorner; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets a value that represents the pattern applied to the specified fill. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the fill type of the chart area + chart.ChartArea.Fill.FillType = OfficeFillType.Pattern; + //Set the back anf fore color of the pattern + chart.ChartArea.Fill.BackColor = System.Drawing.Color.Green; + chart.ChartArea.Fill.ForeColor = System.Drawing.Color.Blue; + //Set the pattern + chart.ChartArea.Fill.Pattern = OfficeGradientPattern.Pat_30_Percent; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets texture of the specified fill. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the fill type as texture + chart.ChartArea.Fill.FillType = OfficeFillType.Texture; + //Set the texture type + chart.ChartArea.Fill.Texture = OfficeTexture.Blue_Tissue_Paper; + //Set the horizontal scale + chart.ChartArea.Fill.TextureHorizontalScale = 6.7F; + //Set the offset X + chart.ChartArea.Fill.TextureOffsetX = 50.40F; + //Set the offset Y + chart.ChartArea.Fill.TextureOffsetY = 67.54F; + //Set the vertical scale + chart.ChartArea.Fill.TextureVerticalScale = 4.5F; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets a index value that represents a background color of the specified fill or patterned line. + + + + + Gets or sets a index value that represents a foreground color of the specified fill or patterned line. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the fill type of the chart area + chart.ChartArea.Fill.FillType = OfficeFillType.Gradient; + //Set the gradient color type + chart.ChartArea.Fill.GradientColorType = OfficeGradientColor.OneColor; + //Set the gradient degree + chart.ChartArea.Fill.GradientDegree = 0.67; + //Set the gradient style + chart.ChartArea.Fill.GradientStyle = OfficeGradientStyle.Horizontal; + //Set the fore color index of the fill + chart.ChartArea.Fill.ForeColorIndex = OfficeKnownColors.Blue_grey; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets a value that represents background color of the specified fill.This property is only for the pattern type fill. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the fill type of the chart area + chart.ChartArea.Fill.FillType = OfficeFillType.Pattern; + //Set the back anf fore color of the pattern + chart.ChartArea.Fill.BackColor = System.Drawing.Color.Green; + chart.ChartArea.Fill.ForeColor = System.Drawing.Color.Blue; + //Set the pattern + chart.ChartArea.Fill.Pattern = OfficeGradientPattern.Pat_30_Percent; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets a value that represents foreground color of the specified fill. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the fill type of the chart area + chart.ChartArea.Fill.FillType = OfficeFillType.Pattern; + //Set the back anf fore color of the pattern + chart.ChartArea.Fill.BackColor = System.Drawing.Color.Green; + chart.ChartArea.Fill.ForeColor = System.Drawing.Color.Blue; + //Set the pattern + chart.ChartArea.Fill.Pattern = OfficeGradientPattern.Pat_30_Percent; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets the preset gradient type for the specified fill. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the fill type of the chart area + chart.ChartArea.Fill.FillType = OfficeFillType.Gradient; + //Set the fore color index of the fill + chart.ChartArea.Fill.ForeColorIndex = OfficeKnownColors.Brown; + //Set the gradient variant + chart.ChartArea.Fill.GradientVariant = OfficeGradientVariants.ShadingVariants_2; + //Set the preset gradient type + chart.ChartArea.Fill.PresetGradientType = OfficeGradientPreset.Grad_Desert; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or Sets the Transparency for specified picture_only. + + + + + Gets a instance that represents user defined picture or texture. Read-only. + + + + + Gets a user defined picture or texture name. Read-only. + + + + + Gets or sets a value that indicates whether the fill style is visible or not. + + Trueif visible.Otherwise False. + + + + Gets or sets the value that represents gradient degree of the specified one-color shaded fill as a floating-point + value from 0.0 (dark) through 1.0 (light) + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the fill type of the chart area + chart.ChartArea.Fill.FillType = OfficeFillType.Gradient; + //Set the gradient color type + chart.ChartArea.Fill.GradientColorType = OfficeGradientColor.OneColor; + //Set the gradient degree + chart.ChartArea.Fill.GradientDegree = 0.67; + //Set the gradient style + chart.ChartArea.Fill.GradientStyle = OfficeGradientStyle.Horizontal; + //chart.ChartArea.Fill.BackColorIndex = OfficeKnownColors.Blue; + chart.ChartArea.Fill.ForeColorIndex = OfficeKnownColors.Blue_grey; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets a value that represents transparency level of the specified Solid color shaded fill as a floating-point + value from 0.0 (Clear) through 1.0(Opaque) + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the fill type of the chart area + chart.ChartArea.Fill.FillType = OfficeFillType.SolidColor; + //chart.ChartArea.Fill.BackColorIndex = OfficeKnownColors.Blue; + chart.ChartArea.Fill.ForeColorIndex = OfficeKnownColors.Blue_grey; + //Set the transparency of the fill + chart.ChartArea.Fill.Transparency = 0.5; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets the vertical scaling factor for the texture fill. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the fill type as texture + chart.ChartArea.Fill.FillType = OfficeFillType.Texture; + //Set the texture type + chart.ChartArea.Fill.Texture = OfficeTexture.Blue_Tissue_Paper; + //Set the horizontal scale + chart.ChartArea.Fill.TextureHorizontalScale = 6.7F; + //Set the offset X + chart.ChartArea.Fill.TextureOffsetX = 50.40F; + //Set the offset Y + chart.ChartArea.Fill.TextureOffsetY = 67.54F; + //Set the vertical scale + chart.ChartArea.Fill.TextureVerticalScale = 4.5F; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets the horizontal scaling factor for the texture fill. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the fill type as texture + chart.ChartArea.Fill.FillType = OfficeFillType.Texture; + //Set the texture type + chart.ChartArea.Fill.Texture = OfficeTexture.Blue_Tissue_Paper; + //Set the horizontal scale + chart.ChartArea.Fill.TextureHorizontalScale = 6.7F; + //Set the offset X + chart.ChartArea.Fill.TextureOffsetX = 50.40F; + //Set the offset Y + chart.ChartArea.Fill.TextureOffsetY = 67.54F; + //Set the vertical scale + chart.ChartArea.Fill.TextureVerticalScale = 4.5F; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets the horizontal offset of the texture from the origin in points. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the fill type as texture + chart.ChartArea.Fill.FillType = OfficeFillType.Texture; + //Set the texture type + chart.ChartArea.Fill.Texture = OfficeTexture.Blue_Tissue_Paper; + //Set the horizontal scale + chart.ChartArea.Fill.TextureHorizontalScale = 6.7F; + //Set the offset X + chart.ChartArea.Fill.TextureOffsetX = 50.40F; + //Set the offset Y + chart.ChartArea.Fill.TextureOffsetY = 67.54F; + //Set the vertical scale + chart.ChartArea.Fill.TextureVerticalScale = 4.5F; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets the vertical offset of the texture from the origin in points. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the fill type as texture + chart.ChartArea.Fill.FillType = OfficeFillType.Texture; + //Set the texture type + chart.ChartArea.Fill.Texture = OfficeTexture.Blue_Tissue_Paper; + //Set the horizontal scale + chart.ChartArea.Fill.TextureHorizontalScale = 6.7F; + //Set the offset X + chart.ChartArea.Fill.TextureOffsetX = 50.40F; + //Set the offset Y + chart.ChartArea.Fill.TextureOffsetY = 67.54F; + //Set the vertical scale + chart.ChartArea.Fill.TextureVerticalScale = 4.5F; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Represents background color. + + + + + Represents foreground color. + + + + + Represents whether picture is tiled or stretched. + + + + + It's define Alphamodfix for bilp(tranparency) + + + + + It's define the Texture properties + + + + + Represents gradient fill format. + + + + + Compares the gradient instances to determine the equality. + + Gradient to compare with. + Returns Zero if gradients are equal. + + + + Sets the specified fill to a two-color gradient. + + + + + Sets the specified style to a two-color gradient. + + Represents shading style. + Represents shading variant. + + + + Gets or sets a object that represents background color of the gradient fill. + + + + + Gets or sets the background color for the gradient fill using System.Drawing.Color. + + + + + Gets or sets a index value that represents a background color for the gradient fill. + + + + + Gets or sets a object that represents foreground color for the gradient fill. + + + + + Gets or sets the foreground color for the gradient fill using System.Drawing.Color. + + + + + Gets or sets a index value that represents a foreground color for the gradient fill. + + + + + Gets or sets the gradient shading style type for the gradient fill. + + + + + Gets or sets the gradient shading variant type for the gradient fill. + + + + + Represents default vertical shading style. + + + + + Represents default vertical shading style in Excel 2007 generated xls files. + + + + + Represents default diagonal up shading style. + + + + + Represents default diagonal down shading style. + + + + + Represents color constant. + + + + + Represents default value for one color. + + + + + Represents pattern prefix. + + + + + Represents texture prefix. + + + + + Represents preset gradient prefix. + + + + + Represents pattern enum prefix. + + + + + Represents value, that indicate that fill doesn't visible. + + + + + Represents index, that represents default comment color. + + + + + Represents corner gradient style. + + + + + Represents center gradient style. + + + + + Represents default offset. + + + + + Maximum value for such attributes like Alpha, Tint, Shade. + + + + + Represents horizontal angle of fill. + + + + + Represents vertical angle of fill. + + + + + Represents Diagonal up angle of fill. + + + + + Represents Diagonal down angle of fill. + + + + + Represents default shade variant array value. + + + + + Represents default shade third variant array value. + + + + + Represents default shade variant array value. + + + + + Represents additional data for center variants. + + + + + Represents additional data for corner variants. + + + + + Represents array, that indicate, that current picture is bitmap. + + + + + Represents default comment fill color. + + + + + Represents rectangular structure fill from center. + + + + + Represents rectangular structure fill from corner. + + + + + Dictionary to access to resource data. Key - string, resource id, value - byte[], resource data. + + + + + Represents fill type. + + + + + Represents shading style. + + + + + Represents current shading variants. + + + + + Represents transparency to. + + + + + Represents transparency from. + + + + + Represents gradient style. + + + + + Represents gradient pattern. + + + + + Represents gradient texture. + + + + + Represents parent book. + + + + + Represents background color index. + + + + + Represents foreground color index. + + + + + Represents preset gradient. + + + + + Represents user defined picture of texture. + + + + + Represents picture name. + + + + + Represents if fill style is visible. + + + + + Represents image index. + + + + + Represents gradient degree. + + + + + Represents picture data to parse. + + + + + Indicates if this instance of object is shape fill. + + + + + Represent the fillrectangle + + + + + Represent the source rectangle + + + + + It's define the alphamodfix value + + + + + Preset gradient. + + + + + Indicates whether gradient is supported. + + + + + It's define the texture attributes + + + + + Represents current assembly. + + + + + Represent array, that contain all preset gradient types. + + + + + This collection contains gradient stops collection for preset gradients. + + + + + Initialize all static members. + + + + + Gets picture from resources file by id. + + Represents unique id in resource file. + Returns picture from resource file by unique id. + + + + Parses color. + + Represents parent book. + Color value to parse. + Extracted color. + + + + Parses color. + + Represents parent book. + Color value to parse. + + + + Returns collection of gradient stops that stores specified preset color. + + Gradient preset to return gradient stops collection for. + Corresponding gradient stops collection. + + + + Returns binary data for collection of gradient stops that stores specified preset color. + + Gradient preset to return gradient stops collection for. + Corresponding gradient stops binary data. + + + + Creates new instance of this class. + + Represents current application. + Represents parent object. + + + + Creates new instance of this class. AutoShapeImplementation + + Represents current application. + Represents parent object. + Fill type. + + + + Creates new instance of this class. + + Represents current application. + Represents parent object. + Fill type. + + + + Finds parent objects. + + + + + Sets user defined picture. + + Path to image. + + + + Sets user defined picture. + + Represents user defined image. + Represents name of user defined image. + + + + Sets user defined texture. + + Path to image. + + + + Sets user defined texture. + + Represents user defined texture. + Represents name of user defined texture. + + + + Sets the specified fill to a pattern. + + Pattern to set. + + + + Sets the specified fill to a preset gradient. + + Represents preset gradient type. + + + + Sets the specified fill to a preset gradient. + + Represents preset gradient type. + Represents gradient style, for preset gradient. + + + + Sets the specified fill to a preset gradient. + + Represents preset gradient type. + Represents gradient style, for preset gradient. + Represents gradient variant for preset gradient. + + + + Sets the specified fill format to a preset texture. + + Represents texture to set. + + + + Sets the specified fill to a two-color gradient. + + + + + Sets the specified fill to a two-color gradient. + + Represents shading shading style. + + + + Sets the specified fill to a two-color gradient. + + Represents shading shading style. + Represents shading variant. + + + + Sets the specified fill to a one-color gradient. + + + + + Sets the specified fill to a one-color gradient. + + Represents shading shading style. + + + + Sets the specified fill to a one-color gradient. + + Represents shading shading style. + Represents shading variant. + + + + Sets the specified fill to a uniform color. + + + + + Compares with shape fill impl. + + Shape fill to compare with. + Zero if shape fills are equal. + + + + Parses fill options. + + Record to parse. + Value indicating fill option. + + + + Parses fill type. + + Represents fill type value. + + + + Parses shading style. + + Represents option value byte array. + + + + Parse shading variant. + + Represents variant value. + + + + Parses pattern or texture name. + + Represents addition data, that contain name. + + + + Parses gradient color. + + Represents gradient color value to parse. + + + + Parses preset gradient type. + + Represents data to parse. + + + + Parses picture or user defined texture. + + Represents name of picture. + If true - parses picture otherwise user defined texture. + + + + Updates bitmap header to stream. + + Represents memory stream. + Represents bitmap data. + + + + Parses visible property. + + Represents data value. + + + + Indicates if fill type is gradient. If not throw NotSupportedException. + + + + + Indicates if fill type is user defined texture or picture. If not throw NotSupportedException. + + + + + Indicates if fill type is pattern. If not throw NotSupportedException. + + + + + Indicates if fill type is texture. If not throw NotSupportedException. + + + + + Validates the type of the solid. + + + + + Convert name to byte array. + + Represents name to convert. + Returns converted name in byte array. + + + + Parses gradient degree. + + Represents value to parse. + Returns parsed gradient degree. + + + + Parses corner variants. + + Represents value to parse. + + + + Fills internal collection with preset gradients default data. + + + + + Sets picture to bse collection. + + Image to set. + Represent name of image. + Return index of image. + + + + If need changes visible. + + + + + Clones current object. + + Represents parent object. + Returns cloned methods. + + + + Copies filling settings from. + + Object to copy settings from. + + + + Returns true if colors should be placed in inverted order. + + Gradient style. + Gradient variant. + True if colors should be placed in inverted order. + + + + Evaluates whether colors should be placed in inverted order for DiagonalDown gradient style. + + Gradient variant to check. + True if colors should be placed in inverted order. + + + + Evaluates whether colors should be placed in inverted order for the most + of gradient styles (Horizontal, Vertical, DiagonalUp and FromCenter). + + Represents gradient variant. + Value indicating whether colors placed in inverted order. + + + + Detects whether color sequence should be doubled or not. + + Gradient style. + Gradient variant. + True if color sequence should be doubled. + + + + Detects whether color sequence should be doubled for the most of gradient + styles (all except FromCorner). + + Gradient variant. + True if color sequence should be doubled. + + + + Evaluates gradient angle based on gradient style. + + Gradient style. + Gradient angle, or -1 when gradient style is not linear gradient. + + + + Evaluates fillToRect value for gradient. + + Gradient style. + Gradient variant. + Value of the fillToRect rectangle or Rectangle.Empty if gradient style doesn't need it. + + + + Returns gradient type value based on gradient style. + + Gradient style. + Gradient type value that correspond to the specified gradient style. + + + + Set the group shape property value to all the inner shapes. + + Property value to set. + Property name. + + + + Set the group shape fill visible to all the inner shapes. + + + + + Set ColorObject to BackColorObject. + + ColorObject value to set. + + + + Set ColorObject to ForeColorObject. + + ColorObject value to set. + + + + Returns collection of gradient stops that stores gradient fill settings. Read-only. + + + + + Represents whether picture is tiled or stretched. + + + + + Gets or Sets the fillrect values + + + + + Gets or Sets the sourcerect values + + + + + Gets parsed picture data. + + + + + Represents shape fill type. + + + + + Represents gradient shading style. + + + + + Represents current shading variant. + + + + + Returns or sets the degree of transparency of the specified fill as + a value from 0.0 (opaque) through 1.0 (clear). + + + + + Returns or sets the degree of transparency of the specified fill as + a value from 0.0 (opaque) through 1.0 (clear). + + + + + It Gets or Sets the TransparencyColor value + + + + + Returns the transparency level of the specified Solid color shaded fill as a floating-point + value from 0.0 (opaque) through 1.0(transparent) + + + + + + Represents gradient style. + + + + + Represents gradient pattern + + + + + Represents gradient texture + + + + + Represents background color index. + + + + + Represents foreground color index. + + + + + Represents background color. + + + + + Represents foreground color. + + + + + Represents background color. + + + + + Represents foreground color. + + + + + Represents preset gradient type. + + + + + Represents user defined picture or texture. Read-only. + + + + + Returns user defined picture of texture name. Read-only. + + + + + Represents if fill style visible. + + + + + Returns the gradient degree of the specified one-color shaded fill as a floating-point + value from 0.0 (dark) through 1.0 (light) + + + + + Gets or Sets the TextureVerticalScale for specified fill + + + + + Gets or Sets the TextureHorizontalScale for specified fill + + + + + Gets or Sets the offset X for the specified fill + + + + + Gets or Sets the offset Y for the specified fill + + + + + Define Alignment value + + + + + Define TileFlipping value + + + + + Represents gel record. + + + + + It's define the series color with invertifnegative attribute + + + + + Initialize new instance of fill class. + + Represents current application. + Represents parent object. + + + + Sets picture to bse collection. + + Image to set. + Represent name of image. + Return index of image. + + + + Changes if need visible. + + + + + Returns or sets the degree of transparency of the specified fill as + a value from 0.0 (opaque) through 1.0 (clear). + + + + + Returns or sets the degree of transparency of the specified fill as + a value from 0.0 (opaque) through 1.0 (clear). + + + + + Represents foreground color. + + + + + Represents background color. + + + + + Represents if fill format is visible. + + + + + Represent the invert option's + + + + + Represents collection of ChartFormatImpl. + + + + + Represents default array value. + + + + + Represents capacity of array. + + + + + Represents chart types that need secondary axis. + + + + + Key - ZOrder, value - index. + + + + + Represents parent axis. + + + + + Creates new instance of collection. + + Application object. + Parent object. + + + + Sets parent objects. + + + + + Adds new format. + + Chartformat to add. + Returns just added format. + + + + Checks whether similar format is already present in the collection + and returns it, otherwise it add new format. + + Format that should be placed in the collection. + Format from the collection. + + + + Checks for containing index in collection. + + Index to check. + If contains - returns true; otherwise - false. + + + + Removes formats by instance. + + Removes current instance. + + + + Updates indexes in collection after remove. + + Index of removed format. + + + + Changes Series chart group in all series. + + New index. + Old Index. + + + + Clears current collection. + + + + + Clones current object. + + Parent object. + Returns cloned object. + + + + Sets the value by index. + + Index to set. + Value to set. + + + + Updates formats on adding format. + + Index to updates. + + + + Updates formats on removing. + + Index to update. + + + + Gets format by index, and shallow removes current format. + + Format order. + If true - delete current format. + Format by index. + + + + Shallow adds format to collection. + + Format to add. + + + + Returns single format by DrawingZOrder. Read-only. + + + + + If true - this collection represents formats for primary axis; + otherwise - secondary collection. + + + + + Returns true if this collection is primary and contain series that need + secondary axis. + + + + + Boolean value indicates whether the axis is depends on the bar series + + + + + Boolean value indicates whether the axis is stacked 100 series + + + + + Represent the ChartChartFormatRecord. + + + + + Provides access to the OfficeArt formatting for chart elements. + + + + + Gets or set the color vary for each data point. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the bubble chart from the slide + IPresentationChart chart = presentation.Slides[0].Charts[0]; + //Set the serie format of chart + IOfficeChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + //Set the bubble scale + format.BubbleScale = 200; + //Set the vary color + format.IsVaryColor = true; + //Set negative bubbles + format.ShowNegativeBubbles = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the bubble chart from the slide + Dim chart As IPresentationChart = presentation__1.Slides(0).Charts(0) + 'Set the serie format of chart + Dim format As IOfficeChartFormat = chart.Series(0).SerieFormat.CommonSerieOptions + 'Set the bubble scale + format.BubbleScale = 200 + 'Set the vary color + format.IsVaryColor = True + 'Set negative bubbles + format.ShowNegativeBubbles = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets Space between bars ( -100 : 100 ). + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Bar_Clustered; + //Set the serie format of chart + IOfficeChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + //Set the gap width + format.GapWidth = 200; + //Set the overlap + format.Overlap = -90; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Bar_Clustered + 'Set the serie format of chart + Dim format As IOfficeChartFormat = chart.Series(0).SerieFormat.CommonSerieOptions + 'Set the gap width + format.GapWidth = 200 + 'Set the overlap + format.Overlap = -90 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + + Gets or sets Angle of the first pie slice expressed in degrees. ( 0 - 360 ) + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type as Pie + chart.ChartType = OfficeChartType.Pie; + //Set the serie format of chart + IOfficeChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + //Set the angle of first slice + format.FirstSliceAngle = 240; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type as Pie + chart.ChartType = OfficeChartType.Pie + 'Set the serie format of chart + Dim format As IOfficeChartFormat = chart.Series(0).SerieFormat.CommonSerieOptions + 'Set the angle of first slice + format.FirstSliceAngle = 240 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets Size of center hole in a doughnut chart (as a percentage).( 0 - 90 ) + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type as Doughtnut + chart.ChartType = OfficeChartType.Doughnut; + //Set the serie format of chart + IOfficeChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + //Set the doughnut hole size + format.DoughnutHoleSize = 50; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type as Doughtnut + chart.ChartType = OfficeChartType.Doughnut + 'Set the serie format of chart + Dim format As IOfficeChartFormat = chart.Series(0).SerieFormat.CommonSerieOptions + 'Set the doughnut hole size + format.DoughnutHoleSize = 50 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets Percent of largest bubble compared to chart in general. ( 0 - 300 ) + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the bubble chart from the slide + IPresentationChart chart = presentation.Slides[0].Charts[0]; + //Set the serie format of chart + IOfficeChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + //Set the bubble scale + format.BubbleScale = 200; + //Set the vary color + format.IsVaryColor = true; + //Set negative bubbles + format.ShowNegativeBubbles = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the bubble chart from the slide + Dim chart As IPresentationChart = presentation__1.Slides(0).Charts(0) + 'Set the serie format of chart + Dim format As IOfficeChartFormat = chart.Series(0).SerieFormat.CommonSerieOptions + 'Set the bubble scale + format.BubbleScale = 200 + 'Set the vary color + format.IsVaryColor = True + 'Set negative bubbles + format.ShowNegativeBubbles = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value indicates what the bubble size represents in a bubble chart. + + + + + Gets or sets true to show negative bubbles. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the bubble chart from the slide + IPresentationChart chart = presentation.Slides[0].Charts[0]; + //Set the serie format of chart + IOfficeChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + //Set the bubble scale + format.BubbleScale = 200; + //Set the vary color + format.IsVaryColor = true; + //Set negative bubbles + format.ShowNegativeBubbles = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the bubble chart from the slide + Dim chart As IPresentationChart = presentation__1.Slides(0).Charts(0) + 'Set the serie format of chart + Dim format As IOfficeChartFormat = chart.Series(0).SerieFormat.CommonSerieOptions + 'Set the bubble scale + format.BubbleScale = 200 + 'Set the vary color + format.IsVaryColor = True + 'Set negative bubbles + format.ShowNegativeBubbles = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets true if a radar chart has axis labels. Applies only to radar charts. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type as Radar + chart.ChartType = OfficeChartType.Radar; + //Set the serie format of chart + IOfficeChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + //Set the axis labels + format.HasRadarAxisLabels = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type as Radar + chart.ChartType = OfficeChartType.Radar + 'Set the serie format of chart + Dim format As IOfficeChartFormat = chart.Series(0).SerieFormat.CommonSerieOptions + 'Set the axis labels + format.HasRadarAxisLabels = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the way the two sections of either a pie of pie chart or a bar + of pie chart are split. + + + + + Gets or sets the threshold value separating the two sections of either a pie of pie chart or a bar of pie chart. + + + + + Gets or sets the size of the secondary section of either a pie of pie chart or a bar of pie chart, + as a percentage of the size of the primary pie. ( 5 - 200 ) + + + + + Gets object that represents first drop bar.Read-only. + + + + + Gets object that represents second drop bar.Read-only. + + + + + Gets series line properties. ( For pie of pie or pie of bar chart types only. ) Read-only. + + + + + + + + + + + Id for bar stacked chart type. + + + + + Represents default series number. + + + + + Represents the ChartChartFormatRecord + + + + + Represents the chart format of some series. + + + + + Represents chart 3d record. + + + + + Represents format link record. + + + + + Represents data labels record. + + + + + Represents chart chart line record. + + + + + Represents data format record and subrecords. + + + + + Represents first drop bar record and subrecords. + + + + + Represents second drop bar record and subrecords. + + + + + Represents series list record. + + + + + Parent chart object. + + + + + Parent axis object. + + + + + Represents chart Series line properties object. + + + + + Represents chart High-low line properties object + + + + + Represents chart Drop line properties object + + + + + Boolean value indicates whether the format is in chart ex type + + + + + Create new instance. + + Current application. + Parent object. + + + + Finds parent objects. + + + + + Gets start Series type. + + Type to extract. + Returns start Series type. + + + + Changed chart type. + + Type to change. + Indicates whether we are in the process of series creation. + + + + Sets drop lines or hi-low lines or series lines: + 0 = drop lines + 1 = hi-low lines + 2 = series lines (lines used in Pie of Pie and Bar of Pie charts) + + + + + Sets null for some records. + + + + + Changes for chart stock. + + + + + Changes type for stock high low close type. + + + + + Changes type for stock open high low close type. + + + + + Change type for stock volume high low close type in primary axis. + + + + + Change type for stock volume high low close type in secondary axis. + + + + + Change type for stock volume open high low close type. + + + + + Changes Series type. + + Type to change. + Indicates whether we are in the process of series creation. + + + + Change Series type as one kind of doughnut. + + Type to change. + + + + Change Series type to one kind of bubble. + + Type to change. + Indicates whether we are in the process of series creation. + + + + Updates bubble series. + + Represents series collection. + + + + Change Series type as one kind of surface. + + Type to change. + Indicates whether we are in the process of series creation. + + + + Change Series type as one kind of radar. + + Type to change. + + + + Change Series type as one kind of bar clustered. + + Type to change. + + + + Change Series type as one kind of bar stacked. + + Type to change. + + + + Change Series type as one kind of line. + + Type to change. + + + + Change Series type as one kind of pie. + + Type to change. + + + + Change Series type as one kind of area. + + Type to change. + + + + Change Series type as one kind of scatter. + + Type to change. + + + + Changes Series type for Cylinder or Pyramid, Cone. + + Type to change. + + + + Clones current object. + + Parent object for clone. + Returns just cloned object. + + + + cloning the removed format from collection + + Parent object for clone + format to be cloned + If true clone the dataformat,else clone others + + + + Vary color for each data point. + + + + + Vary color for each data point. + + + + + Returns data format. Read-only. + + + + + Space between bars ( -100 : 100 ). + + + + + Space between categories (percent of bar width), default = 50. + + + + + True for horizontal bars (bar chart). + False for vertical bars (column chart). + + + + + Stack the displayed values. + + + + + Each category is displayed as a percentage. + + + + + True if this bar has a shadow; otherwise False. + + + + + Stack the displayed values. + + + + + Each category is broken down as a percentage. + + + + + True if this line has a shadow. + + + + + Angle of the first pie slice expressed in degrees. + + + + + 0 = True pie chart + Non-zero = size of center hole in a donut chart (as a percentage). + + + + + True if this pie has a shadow. + + + + + True to show leader lines to data labels. + + + + + Percent of largest bubble compared to chart in general.( 0 - 300 ) + + + + + Returns or sets what the bubble size represents on a bubble chart. + + + + + True if this a bubble series. + + + + + True to show negative bubbles. + + + + + True if bubble series has a shadow. + + + + + Series in this group are stacked. + + + + + Each category is broken down as a percentage. + + + + + This area has a shadow. + + + + + True if chart contains color fill for surface. + + + + + True if this surface chart has shading. + + + + + True if this radar series has a shadow. + + + + + True if a radar chart has axis labels. Applies only to radar charts. + + + + + 0 = normal pie chart + 1 = pie of pie chart + 2 = bar of pie chart + + + + + True to use default split value; otherwise False. + + + + + Returns or sets the way the two sections of either a pie + of pie chart or a bar of pie chart are split. + + + + + Returns or sets the threshold value separating the two sections of either a pie of pie chart or a bar of pie chart. + + + + + For split = 2, what percentage should go to the other pie / bar. + + + + + Returns or sets the size of the secondary section of either a pie of pie chart or + a bar of pie chart, as a percentage of the size of the primary pie. + + + + + Space between the first pie and the second. + + + + + For split = 1, what values should go to the other pie / bar. + + + + + 1 = the second pie / bar has a shadow. + + + + + If true Series has name. + + + + + If true category has name. + + + + + If true has value. + + + + + If true has percentage. + + + + + If true bubble has size. + + + + + Returns delimiter length. + + + + + Represents delimiter. + + + + + Drop lines / hi-lo lines: + 0 = drop lines + 1 = hi-lo lines + 2 = series lines (the lines that connect the columns in a stacked column chart) + + + + + Gets or sets drop lines or hi-low lines or series lines: + 0 = drop lines + 1 = hi-low lines + 2 = series lines (lines used in Pie of Pie and Bar of Pie charts) + + + + + Returns object that represents first drop bar (up bar). + + + + + Returns object that represents second drop bar (down bar). + + + + + Represents series line properties. ( For pie of pie or pie of bar chart types only. ) Read-only. + + + + + Returns or sets the rotation of the 3-D chart view + (the rotation of the plot area around the z-axis, in degrees).(0 to 360 degrees). + + + + + Indicates whether rotation has default value. + + + + + Returns or sets the elevation of the 3-D chart view, in degrees (�90 to +90 degrees). + + + + + Indicates whether elevation has default value. + + + + + Returns or sets the perspective for the 3-D chart view.( 0 - 100 ) + + + + + Returns or sets the height of a 3-D chart as a percentage of the chart width + (between 5 and 500 percent). + + + + + Returns or sets the depth of a 3-D chart as a percentage of the chart width + (between 20 and 2000 percent). + + + + + Returns or sets the distance between the data series in a 3-D chart, as a percentage of the marker width.( 0 - 500 ) + + + + + True if the chart axes are at right angles, independent of chart rotation or elevation. + + + + + 3D columns are clustered or stacked. + + + + + Gets or Sets the chart type as chart ex or not + + + + + True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart.. + + + + + True if gridlines are drawn two-dimensionally on a 3-D chart. + + + + + Try to convert m_serieFormat to chartBarRecord. + If can - returns chartBarRecord; otherwise rise exception. Read-only. + + + + + Try to convert m_serieFormat to chartLineRecord. + If can - returns chartLineRecord; otherwise rise exception. Read-only. + + + + + Try to convert m_serieFormat to chartPieRecord. + If can - returns chartPieRecord; otherwise rise exception. Read-only. + + + + + Try to convert m_serieFormat to chartScatterRecord. + If can - returns chartScatterRecord; otherwise rise exception. Read-only. + + + + + Try to convert m_serieFormat to chartAreaRecord. + If can - returns chartAreaRecord; otherwise rise exception. Read-only. + + + + + Try to convert m_serieFormat to chartSurfaceRecord. + If can - returns chartSurfaceRecord; otherwise rise exception. Read-only. + + + + + Try to convert m_serieFormat to chartRadarRecord. + If can - returns chartRadarRecord; otherwise rise exception. Read-only. + + + + + Try to convert m_serieFormat to chartRadarAreaRecord. + If can - returns chartRadarAreaRecord; otherwise rise exception. Read-only. + + + + + Try to convert m_serieFormat to chartBoppopRecord. + If can - returns chartBoppopRecord; otherwise rise exception. Read-only. + + + + + Returns data labels record. Read-only. + + + + + Returns chart data format. Read-only. + + + + + Returns chart chart format. Read-only. + + + + + Returns Chart3d record. Read-only. + + + + + If true then belong to primary axis; otherwise to secondary axis. + + + + + If true - format contains chart chart line record. Read-only. + + + + + If true - format contains series line. Read-only. + + + + + If true - format contains drop bar record. Read-only. + + + + + Returns record that represents Series format. Read-only. + + + + + Drawing order (0 = bottom of the z-order). + + + + + Represents type code of major format record type. Read-only. + + + + + If true - Series 3D; otherwise Series 2D. Read-only. + + + + + Returns dataformat or null; Read-only. + + + + + If true - format has marker; otherwise false. Read-only. + + + + + If true - format has line; otherwise false. Read-only. + + + + + If true - format has smoothed line; otherwise false. Read-only. + + + + + Represents High-low lines of Stock and Line Charts. Read-only. + + + + + True if stock, line or area charts has drop lines + + + + + True if stock or line charts has high-low lines + + + + + True if pie of pie or bar of pie charts has series lines + + + + + Class provide the options for Box and Whisker series + + + + + It provide the options used for Box and Whisker series + + + + + Indicates whether the show mean line option is enabled + Bit position - 0 + + + + + Indicates whether the show mean marker option is enabled + Bit position - 1 + + + + + Indicates whether the show inner points option is enabled + Bit position - 2 + + + + + Indicates whether the show outlier points option is enabled + Bit position - 3 + + + + + Indicates quartile calculation is exclusive or inclusive + Bit position - 4 + + + + + Gets / Sets the options for the charts + + + + + Class provide the options for Histogram and Pareto Chart axis + + + + + byte value used as flag and boolean property for the values + + + + + Indicates the number of bins in the axis + + + + + Indicates the bin width for axis + + + + + Indicates the overflow bin value + + + + + Indicates the underflow bin value + + + + + Reset the member values respect to input value + + Input Bit position changed + + + + Clones the value from input object + + input object + + + + Check for the equals an object + + input another histogram object + the boolean value indicates whether the objects are equal or not. + + + + Get or Set the is Automatic Bin member value + Bit Position - 0 + + + + + Get or Set the isBinning by Category member value + Bit position - 1 + + + + + Get or Set the Bin width member value + flag Bit position - 2 + + + + + Get or Set the number of Bins member value + Flag Bit position - 3 + + + + + Get or Set the overflow bin member value + Flag Bit Position - 4 + + + + + Get or Set the underflow bin member value + Flag Bit position - 5 + + + + + Get or Set the value for interval is closed in left or right + Flag Bit position - 6 + + + + + Byte value shows the options used in this class + + + + + + Class used for Chart FrameFormat implementation. + + + + + Represents the formatting settings of the chart element. + + + + + Clear current plot area. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set border settings + chart.PlotArea.Border.AutoFormat = false; + //Set the auto line color + chart.PlotArea.Border.IsAutoLineColor = false; + //Set the border line color + chart.PlotArea.Border.LineColor = System.Drawing.Color.Blue; + //Set the border line pattern + chart.PlotArea.Border.LinePattern = OfficeChartLinePattern.DashDot; + //Set the border line weight + chart.PlotArea.Border.LineWeight = OfficeChartLineWeight.Wide; + //Set the border transparency + chart.PlotArea.Border.Transparency = 0.6; + //Set the plot area�s fill type + chart.PlotArea.Fill.FillType = OfficeFillType.SolidColor; + //Set the plot area�s fill color + chart.PlotArea.Fill.ForeColor = System.Drawing.Color.LightPink; + //Set the plot area shodow presence + chart.PlotArea.Shadow.ShadowInnerPresets = Office2007ChartPresetsInner.InsideDiagonalTopLeft; + //Reset the plotarea + chart.PlotArea.Clear(); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set border settings + chart.PlotArea.Border.AutoFormat = False + 'Set the auto line color + chart.PlotArea.Border.IsAutoLineColor = False + 'Set the border line color + chart.PlotArea.Border.LineColor = System.Drawing.Color.Blue + 'Set the border line pattern + chart.PlotArea.Border.LinePattern = OfficeChartLinePattern.DashDot + 'Set the border line weight + chart.PlotArea.Border.LineWeight = OfficeChartLineWeight.Wide + 'Set the border transparency + chart.PlotArea.Border.Transparency = 0.6 + 'Set the plot area�s fill type + chart.PlotArea.Fill.FillType = OfficeFillType.SolidColor + 'Set the plot area�s fill color + chart.PlotArea.Fill.ForeColor = System.Drawing.Color.LightPink + 'Set the plot area shodow presence + chart.PlotArea.Shadow.ShadowInnerPresets = Office2007ChartPresetsInner.InsideDiagonalTopLeft + 'Reset the plotarea + chart.PlotArea.Clear() + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets flag if border corners is round. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Set the borders with rounded corners + chart.ChartArea.IsBorderCornersRound = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Set the borders with rounded corners + chart.ChartArea.IsBorderCornersRound = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the border of the chart element. Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Format Chart Area. + IOfficeChartFrameFormat chartArea = chart.ChartArea; + //Chart Area Border Settings + //Style + chartArea.Border.LinePattern = OfficeChartLinePattern.Solid; + //Color + chartArea.Border.LineColor = System.Drawing.Color.Blue; + //Weight + chartArea.Border.LineWeight = OfficeChartLineWeight.Hairline; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Format Chart Area. + Dim chartArea As IOfficeChartFrameFormat = chart.ChartArea + 'Chart Area Border Settings + 'Style + chartArea.Border.LinePattern = OfficeChartLinePattern.Solid + 'Color + chartArea.Border.LineColor = System.Drawing.Color.Blue + 'Weight + chartArea.Border.LineWeight = OfficeChartLineWeight.Hairline + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the Layout settings of TextArea of the chart element. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get a bubble chart from the slide + IPresentationChart chart = presentation.Slides[0].Charts[0]; + //Format Plot Area + IOfficeChartFrameFormat plotArea = chart.PlotArea; + //Set the height mode + plotArea.Layout.Height = 150; + plotArea.Layout.HeightMode = LayoutModes.factor; + //Set the top mode + plotArea.Layout.Top = 100; + plotArea.Layout.TopMode = LayoutModes.edge; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get a bubble chart from the slide + Dim chart As IPresentationChart = presentation__1.Slides(0).Charts(0) + 'Format Plot Area + Dim plotArea As IOfficeChartFrameFormat = chart.PlotArea + 'Set the height mode + plotArea.Layout.Height = 150 + plotArea.Layout.HeightMode = LayoutModes.factor + 'Set the top mode + plotArea.Layout.Top = 100 + plotArea.Layout.TopMode = LayoutModes.edge + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Chart frame. + + + + + Represents chart border. + + + + + Represents the 3D features + + + + + Represents chart interior. + + + + + Represents Shadow + + + + + Represents fill format. + + + + + Parent chart. + + + + + Represents Excel 2007 layout data. + + + + + Plot area layout + + + + + Creates chart and sets its Application and Parent + properties to specified values. + + Application object for the chart. + Parent object for the chart. + + + + Creates chart and sets its Application and Parent + properties to specified values. + + Application object for the chart. + Parent object for the chart. + Indicates is auto size. + Indicates is interior is gray. + Indicates whether we should set defaults for fill and border properties. + + + + Searches for all necessary parent objects. + + + + + Set variable to the default state. + + Indicates whether MS Excel should calculate size of the frame. + Indicates is default interior is gray. + + + + Updates known colors. + + Color to update. + Returns updated color. + + + + Clears current frame. + + + + + Clone current Record. + + Parent object. + Returns clone of current object. + + + + Gets frame record. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + Gets / sets Excel 2007 layout data. + + + + + This property indicates whether interior object was created. Read-only. + + + + + This property indicates whether border formatting object was created. Read-only. + + + + + Represents chart border. Read-only. + + + + + Represents frame interior. Read-only + + + + + Gets the chart3 D properties. + + The chart3 D properties. + + + + Represents fill gradient format. Read-only. + + + + + This property indicates whether the shadow object has been created + + + + + This property Indicates whether the Shadow object has been created(which includes the 3D properties) + + + + + Gets the shadow properties. + + The shadow properties. + + + + Rectangle style. + + + + + Microsoft Excel calculates size. + + + + + Microsoft Excel calculates position. + + + + + Gets or sets flag if border corners is round. + + + + + Represents chart border. Read-only. + + + + + Represents foreground color. + + + + + Represents background color. + + + + + Represents pattern. + + + + + Represents if use automatic format. + + + + + Represents visibility. + + + + + Contains primary parent axis, secondary parent axis. + + + + + + + + + + + + + + + Represents primary parent axis. + + + + + Represents secondary parent axis. + + + + + Default constructor. + + + + + Creates object and initializes collections. + + Application object. + Parent object for primary collection. + Parent object for secondary collection. + + + + If can - removes format. + + Format to remove. + + + + Changes primary and secondary format collections. + + + + + Helper methods for adding new formats. + + Format to add. + Format order. + Format index. + If true - adds in primary format; otherwise - in secondary. + + + + + Removes format from collection. + + Index to remove. + Order to remove. + If true - removes in primary collection; otherwise - secondary. + + + + Returns collection by parameter. + + If true - returns primary collection; otherwise - secondary. + Returns one of collection. + + + + Clones current instance. + + Parent for primary collection. + Returns just cloned method. + + + + Clones secondary collection. + + Global collection. + Parent object. + + + + Detects chart type. + + Chart series collection. + Returns chart type. + + + + Detects chart type by primary formats only. + + Chart series collection. + Returns chart type. + + + + Clears all format collections. + + + + + Changes not intimate types. + + Type to change. + Current Series type. + Application object. + Chart object. + Returns format for current type. + + + + Change format in axis. + + If true - changes format to primary. otherwise - to secondary. + Format order. + If true - standard add; otherwise - shallow. + Represents new order. + + + + Changes format in axis collection. + + Collection from format gets. + Collection to format sets. + Formats order. + New order to set. + IF true - standard add; otherwise - shallow. + + + + Represents primary format collection. Read-only. + + + + + Represents secondary format collection. Read-only. + + + + + Represents chart grid lines. + + + + + Represents major or minor gridlines on a chart axis. + + + + + Clears current GridLines. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Delete gridline + chart.PrimaryValueAxis.MajorGridLines.Delete(); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Delete gridline + chart.PrimaryValueAxis.MajorGridLines.Delete() + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the border of the gridline. Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Get the major grid line + IOfficeChartGridLine gridLine = chart.PrimaryValueAxis.MajorGridLines; + //Set the line pattern + gridLine.Border.LinePattern = OfficeChartLinePattern.DarkGray; + //Set the line weight + gridLine.Border.LineWeight = OfficeChartLineWeight.Hairline; + //Set the line color + gridLine.Border.LineColor = System.Drawing.Color.Green; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Get the major grid line + Dim gridLine As IOfficeChartGridLine = chart.PrimaryValueAxis.MajorGridLines + 'Set the line pattern + gridLine.Border.LinePattern = OfficeChartLinePattern.DarkGray + 'Set the line weight + gridLine.Border.LineWeight = OfficeChartLineWeight.Hairline + 'Set the line color + gridLine.Border.LineColor = System.Drawing.Color.Green + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents default color index. + + + + + Represents axis line record. + + + + + Represents parent axis. + + + + + Represents Shadow + + + + + Represents parent book. + + + + + Represents chart border. + + + + + Represents the 3D features + + + + + Creates ChartGridLine object. + + Application object. + Parent object. + Represents type of axisline record. + + + + Finds all parent objects. + + + + + Clears the grid lines of the chart. + + + + + Clones current object. + + Parent object. + Returns cloned object. + + + + Gets line border. Read-only. + + + + + Gets line border. Read-only. + + + + + This property indicates whether line formatting object was created. Read-only. + + + + + Represents the Shadow.Read-only + + + + + This property indicates whether the shadow object has been created + + + + + Gets the chart3 D options. + + The chart3 D options. + + + + This property Indicates whether the Shadow object has been created(which includes the 3D properties) + + + + + This property indicates whether interior object was created. Read-only. + + + + + Returns object, that represents area properties. Read-only. + + + + + Represents fill options. Read-only. + + + + + Gets or sets axis line type. + + + + + This class represents the Excel Chart object. + + + + + Base class for all worksheet objects (objects that have own tab in the workbook) + like worksheets and charts. + + + + + Implement objects that contains Name. + + + + + Name of the object. + + + + + Supports parsing, which parses internal records and creates necessary objects. + + + + + Parses internal records. + + + + + Represents an Excel worksheet Tab. + + + + + Makes the current sheet the active sheet. Equivalent to clicking the + sheet's tab. + + + + + Unselects current tab sheet. + + + + + Protects current worksheet. + + Represents password to protect. + Represents params to protect. + + + + Gets / sets tab color. + + + + + Gets / sets tab color. + + + + + Returns parent workbook. Read-only. + + + + + Returns shapes collection. Read-only. + + + + + Indicates whether worksheet is displayed right to left. + + + + + Indicates whether tab of this sheet is selected. Read-only. + + + + + Gets / sets name of the tab sheet. + + + + + Control visibility of worksheet to end user. + + + + + Name used by macros to access workbook items. Read-only. + + + + + Maximum length of the password. + + + + + Default password hash value. + + + + + Min column index. + + + + + Min row index. + + + + + Default tab color. + + + + + Maximum one-based index of the row. + + + + + Maximum one-based index of the column. + + + + + Maximum allowed worksheet name length. + + + + + Records that do not belong to mso part of the worksheet. + + + + + Default tab color. + + + + + Represents a boolean value to parse worksheets on demand + + + + + Represents to parse sheet on demand + + + + + Parent workbook. + + + + + Worksheet's name. + + + + + Indicates whether worksheet was changed and need saving. + + + + + Real worksheet's index in the workbook. + + + + + Starting index for Mso record. + + + + + Current index of the mso drawing object. + + + + + Parse options. + + + + + List with all mso drawing records in the worksheet. + + + + + Collection of all pictures in the worksheet. + + + + + List in which all records which belong to worksheet are stored. + + + + + Collection with all shapes in the worksheet. + + + + + Charts collection. + + + + + True - indicates that record extracted from stream can be used, by this + implementation, otherwise False. + + + + + Zoom of the current window. + + + + + Represents sheet protection record. + + + + + Describes password entered by user to protect worksheet's data. + + + + + Code name. + + + + + Indicates whether worksheet was parsed. + + + + + Indicates whether object is currently being parsed. + + + + + Indicates whether to skip parsing. + + + + + Window two record. + + + + + One field from Worksheet dimension records. + + + + + One field from Worksheet dimension records. + + + + + One field from Worksheet dimension records. + + + + + One field from Worksheet dimension records + + + + + Index of the tab color. + + + + + Contains images used in header and footer. + + + + + Worksheet index. + + + + + Represents sheet protection for support old version. Using for parsing. + + + + + BOF record that will be serialized. + + + + + Indicates whether to keep record inside of internal storage. + + + + + Visibility of worksheet. + + + + + Data holder for 2007 Excel. + + + + + Indicates whether worksheet contains some unknown vml shapes. + + + + + Collection with all textboxes. + + + + + Custom height + + + + + + + + + + Indicate whether sheet contain tab color rgb + + + + + Alogrithm name to protect/unprotect worksheet. + + + + + Hash value to ensure the sheet protected password. + + + + + Random generated Salt for the sheet password. + + + + + Spin count to loop the hash algorithm. + + + + + Initializes new instance and sets its application and parent properties. + + Application object for the new instance. + Parent object for the new instance. + + + + Clears NameChanged event. + + + + + Returns true if visible sheet found. Also sets active sheet index and display tab. + + Workbook objects collection + Object index. + True if visible sheet found + + + + Searches for all necessary parent objects. + + + + + This method is called when Name of the worksheet was changed. + + Event arguments. + + + + This method raises NameChanged event. + + Event arguments. + + + + This method should be called after any changes in the worksheet. + Sets Saved property of the parent workbook to false. + + + + + Initializes all required collections. + + + + + Clear all internal collections. + + Allows to avoid clearing of some properties. + + + + Makes the current sheet the active sheet. Equivalent to clicking the + sheet's tab in MS Excel. + + + + + Selects current tab sheet. + + + + + Unselects current tab sheet if possible. + + + + + Unselects current tab sheet if possible. + + Indicates whether to allow unselect last sheet. + + + + Protects current worksheet. + + Represents password to protect. + Represents params to protect. + + + + Prepares protection options before setting protection. + + + + + + + Unprotects this worksheet without password. + + + + + This method is called after RealIndex property change. + + Old index. + + + + Adds sheet tab to the selected tab. + + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + This method should be called immediately after extended format removal. + + Dictionary with updated extended formats. + + + + Creates copy of the current object. + + Parent object for the new object. + Copy of the current object. + + + + Creates copy of the current object. + + Parent object for the new object. + Indicates whether we should clone shapes or not. + Copy of the current object. + + + + Create copy of the shapes collection inside specified worksheet object. + + Object to put shapes into. + + + + Updates style indexes. + + Array with changed style indexes. + + + + Protects worksheet. + + Password hash to use for protection. + Protection options. + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Prepares protection variables. + + + + + Parses dimensions record. + + Record to parse. + + + + Returns hash value for the password string. + + Password to hash. + Hash value for the password string. + + + + Converts character to 15 bits sequence + + Character to convert. + Array of values indicating 15 bit sequence. + + + + Converts bits array to UInt16 value. + + Array to convert. + Converted UInt16 value. + + + + Rotates (cyclic shift) bits in the array specified number of times + + Array to rotate + Number of times to rotate + Rotated array. + + + + Rounds value. + + Value to be rounded. + Represents degree used to round the given value. + Rounded value. + + + + Parses internal records. + + + + + Parses worksheet's data. + + + + + Parses worksheet's data. + + + + + Extracts MsoDrawing records from internal array. + + Index to the first MsoDrawing record. + Parse options. + + + + Combines all MsoBase records into one array. + + Array of records. + + + + Extracts client data for mso records. + + Array of records. + + + + Combines several byte arrays into one. + + Size of the combined data. + List that contains byte arrays to combine. + Combined array. + + + + Copies all data from another worksheet. + + Parent worksheet. + Dictionary with style names. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Copy flags. + + Dictionary with extended format indexes, key - old index, value - new index. + + + + + Copies preserved header/footer images. + + Source worksheet. + Hash with new WorkSheet names. + Dictionary with new font indexes. + + + + Copies all shapes from a source worksheet. + + Source worksheet. + Hash with new WorkSheet names. + Dictionary with new font indexes. + + + + Copies different sheet options. + + Source sheet. + + + + Generates unique name for the parent collection + + Name getter. + Proposed name + Generated unique name. + + + + Gets code name of the tabsheet. + + Tabsheet to get name from. + Code name of the tabsheet. + + + + Gets name of the tabsheet. + + Tabsheet to get name from. + Name of the tabsheet. + + + + Copies tab color from another worksheet. + + Worksheet to copy tab color from. + + + + Checks the worksheet for parse on demand load + + + + + Creates random salt. + + Desired salt length. + Array with random data. + + + + Returns or sets the name of the object. Read / write String. + + + + + Indicates whether worksheet was saved. + + + + + Returns embedded charts collection. Read-only. + + + + + Returns shapes collection. Read-only. + + + + + Shapes collection. + + + + + Returns InnerShapes base collection. + + + + + Header / footer shapes collection. + + + + + Header / footer shapes collection. + + + + + Returns charts collection. Read-only. + + + + + Name used by macros to access workbook items. Read-only. + + + + + Sheet window settings. + + + + + Indicates is current sheet is protected. + + + + + True if objects are protected. Read-only. + + + + + True if the scenarios of the current sheet are protected. Read-only. + + + + + Gets a value indicating whether worksheet is protected with password. + + + + + Indicates whether object was parsed. + + + + + Indicates whether object is currently being parsed. + + + + + Indicates whether worksheet was opened in skip parsing mode. Read-only. + + + + + Indicates whether worksheet type is supported. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + Gets / sets one-based index of the first row of the worksheet. + + + + + Gets / sets one-based index of the first column of the worksheet. + + + + + Gets / sets one-based index of the last row of the worksheet. + + + + + Gets / sets one-based index of the last column of the worksheet. + + + + + Zoom factor of document. Value must be in range from 10 to 400. + + + + + Tab color. + + + + + Tab color. + + + + + Tab color. + + + + + Grid line color. + + + + + Indicates whether gridline color has default value. + + + + + Get parent workbook of current worksheet. + + + + + Indicates whether worksheet is displayed right to left. + + + + + Return page setup. Read-only. + + + + + Indicates whether tab of this sheet is selected. Read-only. + + + + + Returns the index number of the object within the collection of + similar objects. Read-only. + + + + + Gets protected options. Read-only. For sets protection options use "Protect" method. + + + + + Gets protected options. Read-only. For sets protection options use "Protect" method. + + + + + Returns internal BOF record. Read-only. + + + + + Controls end user visibility of worksheet. + + + + + Gets / sets worksheet data holder. + + + + + Gets/sets top visible row of the worksheet. + + + + + Gets/sets left visible column of the worksheet. + + + + + Describes password entered by user to protect worksheet's data. + + + + + Indicates whether worksheet contains some unknown vml shapes. + + + + + Returns inner textboxes collection. Read-only. + + + + + Returns inner textboxes collection. Read-only. + + + + + Returns inner textboxes collection. Read-only. + + + + + Returns number of known vml shapes. Read-only. + + + + + Gets the default protection options for the worksheet. + + + + + Indicates whether Protection property is direct (specified items are + protected) or indirect (specified items are unprotected). + + + + + Inidicates whether protection should be serialized. + + + + + Returns sheet protection record. + + + + + Gets or Sets a boolean value to parse worksheets on demand + + + + + Gets or sets the boolean value to load worksheets on demand + + + + + Indicate whether sheet contain tab color rgb + + + + + Alogrithm name to protect/unprotect worksheet. + + + + + Hash value to ensure the sheet protected password. + + + + + Random generated Salt for the sheet password. + + + + + Spin count to loop the hash algorithm. + + + + + Gets pictures collection in the worksheet. Read-only. + + + + + Returns pictures collection. Read-only. + + + + + This event is raised when name of the worksheet is changed. + + + + + Index of the worksheet in the workbook + (not necessary in Worksheets collection) + + + + + Delegate to be used for getting name information from the worksheet. + + Worksheet to get name from. + Extracted name. + + + + Represents a chart in a document + + + + + Refreshes the chart with the modified excel data. + + + + //Open a presentation containing charts + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the slide from presentation + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Charts[0]; + //Refresh the chart to set worksheet data to current chart + chart.Refresh(); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation containing charts + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + 'Get the slide from presentation + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = slide.Charts(0) + 'Refresh the chart to set worksheet data to current chart + chart.Refresh() + 'Save the presentation + presentation.Save("Sample.pptx") + 'Close the presentation + presentation.Close() + + + + + + Converts the chart to image and saves the image in the specified stream. + + The stream to save the image. + + + //Open the presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Initialize the ChartToImageConverter class; this is mandatory + presentation.ChartToImageConverter = new ChartToImageConverter(); + //Set the scaling mode for quality + presentation.ChartToImageConverter.ScalingMode = Syncfusion.OfficeChart.ScalingMode.Best; + //Get the first slide + ISlide slide = presentation.Slides[0]; + //Get the chart in slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Create a stream instance to store the image + MemoryStream stream = new MemoryStream(); + //Save the image to stream + chart.SaveAsImage(stream); + //Save the stream to a file + using (FileStream fileStream = File.Create("ChartImage.png", (int)stream.Length)) + fileStream.Write(stream.ToArray(), 0, stream.ToArray().Length); + //Close the stream + stream.Close(); + //Save the Presentation + presentation.Save("output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open the presentation + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + 'Initialize the ChartToImageConverter class; this is mandatory + presentation.ChartToImageConverter = New ChartToImageConverter() + 'Set the scaling mode for quality + presentation.ChartToImageConverter.ScalingMode = Syncfusion.OfficeChart.ScalingMode.Best + 'Get the first slide + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart in slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Create a stream instance to store the image + Dim stream As New MemoryStream() + 'Save the image to stream + chart.SaveAsImage(stream) + 'Save the stream to a file + Using fileStream As FileStream = File.Create("ChartImage.png", CInt(stream.Length)) + fileStream.Write(stream.ToArray(), 0, stream.ToArray().Length) + End Using + 'Close the stream + stream.Close() + 'Save the Presentation + presentation.Save("output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Sets the chart data with the specified two dimensional object array. + + Represents the two dimensional chart data + + + + //Create a new PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to slide + IPresentationChart chart = slide.Charts.AddChart(100, 100, 300, 200); + //Create an instance of object array + object[][] chartData = { new object[3], new object[4] }; + //Invoke setChartData method by passing object array + chart.SetChartData(chartData); + //Set the chart title + chart.ChartTitle = "Chart"; + //Save the Presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new PowerPoint presentation + Dim presentation As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to slide + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 100, 300, 200) + 'Create an instance of object array + Dim chartData As Object()() = {New Object(2) {}, New Object(3) {}} + 'Invoke setChartData method by passing object array + chart.SetChartData(chartData) + 'Set the chart title + chart.ChartTitle = "Chart" + 'Save the Presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Sets the chart data with the specified two dimensional object array, row index and column index. + + Represents the two dimensional chart data + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + + + //Create a new PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to slide + IPresentationChart chart = slide.Charts.AddChart(100, 100, 300, 300); + //Create an instance of object array + object[][] dataRange = { new object[5], new object[5] }; + //Invoke set data Range method + chart.SetDataRange(dataRange, 1, 3); + //Save the Presentation + presentation.Save("output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new PowerPoint presentation + Dim presentation As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to slide + Dim chart As IPresentationChart= slide.Charts.AddChart(100, 100, 300, 300) + 'Create an instance of object array + Dim dataRange As Object()() = {New Object(4) {}, New Object(4) {}} + 'Invoke set data Range method + chart.SetDataRange(dataRange, 1, 3) + 'Save the Presentation + presentation.Save("output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Sets the chart data with the specified enumerable, row index and column index. + + IEnumerable object with desired data + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + + + + Gets or sets the Chart Type. + Initiate series, ranges and update the ChartType. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Specify the chart type + chart.ChartType = OfficeChartType.Surface_3D; + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Specify the chart title + chart.ChartTitle = "Sales Analysis" + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Specify the chart type + chart.ChartType = OfficeChartType.Surface_3D + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the DataRange for the chart series. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to slide + IPresentationChart chart = slide.Shapes.AddChart(100, 120, 500, 300); + //Sets the data range of chart + chart.DataRange = chart.ChartData[1, 2, 4, 3]; + //Set data to the chart- RowIndex, columnIndex and data + chart.ChartData.SetValue(1, 2, "2012"); + chart.ChartData.SetValue(2, 2, 330); + chart.ChartData.SetValue(3, 2, 490); + chart.ChartData.SetValue(4, 2, 700); + chart.ChartType = OfficeChartType.Area; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to slide + Dim chart As IPresentationChart = slide.Shapes.AddChart(100, 120, 500, 300) + 'Sets the data range of chart + chart.DataRange = chart.ChartData(1, 2, 4, 3) + 'Set data to the chart- RowIndex, columnIndex and data + chart.ChartData.SetValue(1, 2, "2012") + chart.ChartData.SetValue(2, 2, 330) + chart.ChartData.SetValue(3, 2, 490) + chart.ChartData.SetValue(4, 2, 700) + chart.ChartType = OfficeChartType.Area + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets whether series in rows or not. True if series are in rows in DataRange; + False otherwise. + + + + + Gets or sets the Title of the chart. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Specify the chart title + chart.ChartTitle = "Sales Analysis" + 'Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets an object that represents the title area for the chart. Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Specify the chart type + chart.ChartType = OfficeChartType.Surface_3D; + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Get the chart title text area + IOfficeChartTextArea textArea = chart.ChartTitleArea; + //Set the background mode of the title area + textArea.BackgroundMode = OfficeChartBackgroundMode.Transparent; + //Set bold font style + textArea.Bold = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Specify the chart title + chart.ChartTitle = "Sales Analysis" + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Specify the chart type + chart.ChartType = OfficeChartType.Surface_3D + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Get the chart title text area + Dim textArea As IOfficeChartTextArea = chart.ChartTitleArea + 'Set the background mode of the title area + textArea.BackgroundMode = OfficeChartBackgroundMode.Transparent + 'Set bold font style + textArea.Bold = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the X coordinate of the upper-left corner + of the chart in points (1/72 inch). + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the x - position of the chart + chart.XPos = 300; + //Set the y - position of the chart + chart.YPos = 140; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the x - position of the chart + chart.XPos = 300 + 'Set the y - position of the chart + chart.YPos = 140 + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the Y coordinate of the upper-left corner + of the chart in points (1/72 inch). + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the x - position of the chart + chart.XPos = 300; + //Set the y - position of the chart + chart.YPos = 140; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the x - position of the chart + chart.XPos = 300 + 'Set the y - position of the chart + chart.YPos = 140 + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the Width of the chart in points (1/72 inch). + + + + //Open the presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Get the first slide + ISlide slide = presentation.Slides[0]; + //Get the chart in slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Modify the chart height + chart.Height = 500; + //Modify the chart width + chart.Width = 700; + //Change the title + chart.ChartTitle = "New title"; + //Change the serie name of first chart serie + chart.Series[0].Name = "Modified serie name"; + //Hiding the category labels + chart.CategoryLabelLevel = OfficeCategoriesLabelLevel.CategoriesLabelLevelNone; + //Show Data Table. + chart.HasDataTable = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open the presentation + Dim presentation As IPresentation = Presentation.Open("Sample.pptx") + 'Get the first slide + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart in slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Modify the chart height + chart.Height = 500 + 'Modify the chart width + chart.Width = 700 + 'Change the title + chart.ChartTitle = "New title" + 'Change the serie name of first chart serie + chart.Series(0).Name = "Modified serie name" + 'Hiding the category labels + chart.CategoryLabelLevel = OfficeCategoriesLabelLevel.CategoriesLabelLevelNone + 'Show Data Table. + chart.HasDataTable = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the Height of the chart in points (1/72 inch). + + + + //Open the presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Get the first slide + ISlide slide = presentation.Slides[0]; + //Get the chart in slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Modify the chart height + chart.Height = 500; + //Modify the chart width + chart.Width = 700; + //Change the title + chart.ChartTitle = "New title"; + //Change the serie name of first chart serie + chart.Series[0].Name = "Modified serie name"; + //Hiding the category labels + chart.CategoryLabelLevel = OfficeCategoriesLabelLevel.CategoriesLabelLevelNone; + //Show Data Table. + chart.HasDataTable = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open the presentation + Dim presentation As IPresentation = Presentation.Open("Sample.pptx") + 'Get the first slide + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart in slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Modify the chart height + chart.Height = 500 + 'Modify the chart width + chart.Width = 700 + 'Change the title + chart.ChartTitle = "New title" + 'Change the serie name of first chart serie + chart.Series(0).Name = "Modified serie name" + 'Hiding the category labels + chart.CategoryLabelLevel = OfficeCategoriesLabelLevel.CategoriesLabelLevelNone + 'Show Data Table. + chart.HasDataTable = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the collection of the all series of this chart. Read-only. + + + + //Open the presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Get the first slide + ISlide slide = presentation.Slides[0]; + //Get the chart in slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Modify the chart height + chart.Height = 500; + //Modify the chart width + chart.Width = 700; + //Change the title + chart.ChartTitle = "New title"; + //Change the serie name of first chart serie + chart.Series[0].Name = "Modified serie name"; + //Hiding the category labels + chart.CategoryLabelLevel = OfficeCategoriesLabelLevel.CategoriesLabelLevelNone; + //Show Data Table. + chart.HasDataTable = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open the presentation + Dim presentation As IPresentation = Presentation.Open("Sample.pptx") + 'Get the first slide + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart in slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Modify the chart height + chart.Height = 500 + 'Modify the chart width + chart.Width = 700 + 'Change the title + chart.ChartTitle = "New title" + 'Change the serie name of first chart serie + chart.Series(0).Name = "Modified serie name" + 'Hiding the category labels + chart.CategoryLabelLevel = OfficeCategoriesLabelLevel.CategoriesLabelLevelNone + 'Show Data Table. + chart.HasDataTable = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the primary category axis for the chart. Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the primary category axis + IOfficeChartCategoryAxis primaryCategoryAxis = chart.PrimaryCategoryAxis; + //Set the data range of the category axis + primaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the primary category axis + Dim primaryCategoryAxis As IOfficeChartCategoryAxis = chart.PrimaryCategoryAxis + 'Set the data range of the category axis + primaryCategoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the primary value axis for the chart. Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the primary value axis + IOfficeChartValueAxis primaryValueAxis = chart.PrimaryValueAxis; + //Set bold font style + primaryValueAxis.Font.Bold = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the primary value axis + Dim primaryValueAxis As IOfficeChartValueAxis = chart.PrimaryValueAxis + 'Set bold font style + primaryValueAxis.Font.Bold = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the primary series axis for the chart. Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Get the primary serie axis + IOfficeChartSeriesAxis primarySerieAxis = chart.PrimarySerieAxis; + //Set the font style of serie axis + primarySerieAxis.Font.Italic = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Get the primary serie axis + Dim primarySerieAxis As IOfficeChartSeriesAxis = chart.PrimarySerieAxis + 'Set the font style of serie axis + primarySerieAxis.Font.Italic = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the secondary category axis for the chart. Read-only. + + + + //Open a presentation with Combinational chart type + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Get the secondary category axis + IOfficeChartCategoryAxis secondaryCategoryAxis = chart.PrimaryCategoryAxis; + //Set the minor grid lines + secondaryCategoryAxis.HasMinorGridLines = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation with Combinational chart type + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Get the secondary category axis + Dim secondaryCategoryAxis As IOfficeChartCategoryAxis = chart.PrimaryCategoryAxis + 'Set the minor grid lines + secondaryCategoryAxis.HasMinorGridLines = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the secondary value axis for the chart. Read-only. + + + + //Open a presentation with Combinational chart type + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Get the secondary value axis + IOfficeChartValueAxis secondaryValueAxis = chart.SecondaryValueAxis; + //Set the tick label position + secondaryValueAxis.TickLabelPosition = OfficeTickLabelPosition.TickLabelPosition_NextToAxis; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation with Combinational chart type + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Get the secondary value axis + Dim secondaryValueAxis As IOfficeChartValueAxis = chart.SecondaryValueAxis + 'Set the tick label position + secondaryValueAxis.TickLabelPosition = OfficeTickLabelPosition.TickLabelPosition_NextToAxis + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets an object that represents the complete chart area for the chart. Read-only. + + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to slide + IPresentationChart chart = slide.Shapes.AddChart(100, 100, 400, 300); + //Set the chart data value + chart.ChartData.SetValue(1, 2, "1"); + chart.ChartData.SetValue(2, 1, "A"); + chart.ChartData.SetValue(2, 2, 20); + //Set chart data range + chart.DataRange = chart.ChartData[2, 2, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Get the chart area + IOfficeChartFrameFormat chartArea = chart.ChartArea; + //Set the line pattern of chart border + chartArea.Border.LinePattern = OfficeChartLinePattern.DashDotDot; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to slide + Dim chart As IPresentationChart = slide.Shapes.AddChart(100, 100, 400, 300) + 'Set the chart data value + chart.ChartData.SetValue(1, 2, "1") + chart.ChartData.SetValue(2, 1, "A") + chart.ChartData.SetValue(2, 2, 20) + 'Set chart data range + chart.DataRange = chart.ChartData(2, 2, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Column_Clustered + 'Get the chart area + Dim chartArea As IOfficeChartFrameFormat = chart.ChartArea + 'Set the line pattern of chart border + chartArea.Border.LinePattern = OfficeChartLinePattern.DashDotDot + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + + Gets the walls of the 3-D chart. Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Set the fill type of wall as pattern + chart.Walls.Fill.FillType = OfficeFillType.Pattern; + //set the back color of the pattern fill + chart.Walls.Fill.BackColor = Color.AliceBlue; + //Set the fore color of the pattern fill + chart.Walls.Fill.ForeColor = Color.Brown; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Set the fill type of wall as pattern + chart.Walls.Fill.FillType = OfficeFillType.Pattern + 'set the back color of the pattern fill + chart.Walls.Fill.BackColor = Color.AliceBlue + 'Set the fore color of the pattern fill + chart.Walls.Fill.ForeColor = Color.Brown + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets an object that allows to individually format the side wall of a 3-D chart. Read-only. + + + + //Open the presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Get the first slide + ISlide slide = presentation.Slides[0]; + //Get the chart in slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Change the chart type to 3D + chart.ChartType = OfficeChartType.Bar_Clustered_3D; + //Set the rotation + chart.Rotation = 80; + //Set the shadow angle + chart.SideWall.Shadow.Angle = 60; + //Set the backwall border weight + chart.BackWall.Border.LineWeight = OfficeChartLineWeight.Narrow; + //Save the presentation + presentation.Save("output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open the presentation + Dim presentation As IPresentation = Presentation.Open("Sample.pptx") + 'Get the first slide + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart in slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Change the chart type to 3D + chart.ChartType = OfficeChartType.Bar_Clustered_3D + 'Set the rotation + chart.Rotation = 80 + 'Set the shadow angle + chart.SideWall.Shadow.Angle = 60 + 'Set the backwall border weight + chart.BackWall.Border.LineWeight = OfficeChartLineWeight.Narrow + 'Save the presentation + presentation.Save("output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets an object that allows to individually format the back wall of a 3-D chart. Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Specify the chart type + chart.ChartType = OfficeChartType.Surface_3D; + //Get the back wall of the chart + IOfficeChartWallOrFloor backWall = chart.BackWall; + //Set the line properties of the back wall + backWall.LineProperties.LineWeight = OfficeChartLineWeight.Narrow; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Specify the chart title + chart.ChartTitle = "Sales Analysis" + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Specify the chart type + chart.ChartType = OfficeChartType.Surface_3D + 'Get the back wall of the chart + Dim backWall As IOfficeChartWallOrFloor = chart.BackWall + 'Set the line properties of the back wall + backWall.LineProperties.LineWeight = OfficeChartLineWeight.Narrow + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the floor of the 3-D chart. Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Get the floor of chart + IOfficeChartWallOrFloor floor = chart.Floor; + //Set the filltype of floor as pattern fill + floor.Fill.FillType = OfficeFillType.Pattern; + //Set the back and fore color of the pattern fill + floor.Fill.BackColor = Color.Blue; + floor.Fill.ForeColor = Color.Brown; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Get the floor of chart + Dim floor As IOfficeChartWallOrFloor = chart.Floor + 'Set the filltype of floor as pattern fill + floor.Fill.FillType = OfficeFillType.Pattern + 'Set the back and fore color of the pattern fill + floor.Fill.BackColor = Color.Blue + floor.Fill.ForeColor = Color.Brown + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the charts dataTable object. + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Set the chart with data table + chart.HasDataTable = true; + //Get the data table, read only + IOfficeChartDataTable dataTable = chart.DataTable; + //set borders for data table + dataTable.HasBorders = true; + //Set the show serie keys + dataTable.ShowSeriesKeys = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Set the chart with data table + chart.HasDataTable = True + 'Get the data table, read only + Dim dataTable As IOfficeChartDataTable = chart.DataTable + 'set borders for data table + dataTable.HasBorders = True + 'Set the show serie keys + dataTable.ShowSeriesKeys = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets whether the chart has data table. + + TrueIf the chart has a data table. Otherwise False + + + //Open the presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Get the first slide + ISlide slide = presentation.Slides[0]; + //Get the chart in slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Modify the chart height + chart.Height = 500; + //Modify the chart width + chart.Width = 700; + //Change the title + chart.ChartTitle = "New title"; + //Change the serie name of first chart serie + chart.Series[0].Name = "Modified serie name"; + //Hiding the category labels + chart.CategoryLabelLevel = OfficeCategoriesLabelLevel.CategoriesLabelLevelNone; + //Show Data Table. + chart.HasDataTable = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open the presentation + Dim presentation As IPresentation = Presentation.Open("Sample.pptx") + 'Get the first slide + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart in slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Modify the chart height + chart.Height = 500 + 'Modify the chart width + chart.Width = 700 + 'Change the title + chart.ChartTitle = "New title" + 'Change the serie name of first chart serie + chart.Series(0).Name = "Modified serie name" + 'Hiding the category labels + chart.CategoryLabelLevel = OfficeCategoriesLabelLevel.CategoriesLabelLevelNone + 'Show Data Table. + chart.HasDataTable = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the legend for the chart. Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to slide + IPresentationChart chart = slide.Shapes.AddChart(100, 120, 500, 300); + //Sets the data range of chart + chart.DataRange = chart.ChartData[1, 2, 4, 3]; + //Set data to the chart- RowIndex, columnIndex and data + chart.ChartData.SetValue(1, 2, "2012"); + chart.ChartData.SetValue(2, 2, 330); + chart.ChartData.SetValue(3, 2, 490); + chart.ChartData.SetValue(4, 2, 700); + chart.ChartType = OfficeChartType.Area; + //Edge: Specifies that the width or Height will be interpreted as right or bottom of the chart element + //Factor: Specifies that the width or Height will be interpreted as the width or height of the chart element + chart.PlotArea.Layout.LeftMode = LayoutModes.auto; + chart.PlotArea.Layout.TopMode = LayoutModes.factor; + //Value in points should not be a negative value if LayoutMode is Edge + //It can be a negative value if the LayoutMode is Factor. + chart.ChartTitleArea.Layout.Left = 10; + chart.ChartTitleArea.Layout.Top = 100; + //Manually positioning chart plot area + chart.PlotArea.Layout.LayoutTarget = LayoutTargets.outer; + chart.PlotArea.Layout.LeftMode = LayoutModes.edge; + chart.PlotArea.Layout.TopMode = LayoutModes.edge; + //Manually positioning chart legend + chart.Legend.Layout.LeftMode = LayoutModes.factor; + chart.Legend.Layout.TopMode = LayoutModes.factor; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to slide + Dim chart As IPresentationChart = slide.Shapes.AddChart(100, 120, 500, 300) + 'Sets the data range of chart + chart.DataRange = chart.ChartData(1, 2, 4, 3) + 'Set data to the chart- RowIndex, columnIndex and data + chart.ChartData.SetValue(1, 2, "2012") + chart.ChartData.SetValue(2, 2, 330) + chart.ChartData.SetValue(3, 2, 490) + chart.ChartData.SetValue(4, 2, 700) + chart.ChartType = OfficeChartType.Area + 'Edge: Specifies that the width or Height will be interpreted as right or bottom of the chart element + 'Factor: Specifies that the width or Height will be interpreted as the width or height of the chart element + chart.PlotArea.Layout.LeftMode = LayoutModes.auto + chart.PlotArea.Layout.TopMode = LayoutModes.factor + 'Value in points should not be a negative value if LayoutMode is Edge + 'It can be a negative value if the LayoutMode is Factor. + chart.ChartTitleArea.Layout.Left = 10 + chart.ChartTitleArea.Layout.Top = 100 + 'Manually positioning chart plot area + chart.PlotArea.Layout.LayoutTarget = LayoutTargets.outer + chart.PlotArea.Layout.LeftMode = LayoutModes.edge + chart.PlotArea.Layout.TopMode = LayoutModes.edge + 'Manually positioning chart legend + chart.Legend.Layout.LeftMode = LayoutModes.factor + chart.Legend.Layout.TopMode = LayoutModes.factor + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets whether the chart has legends. + + TrueIf the chart has a legend. Otherwise False + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Hide the legend + chart.HasLegend = false; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Hide the legend + chart.HasLegend = False + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets whether the chart has title. + + TrueIf the chart has a title. Otherwise False + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Hide the chart title + chart.HasTitle = false; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Hide the chart title + chart.HasTitle = False + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the rotation of the 3-D chart view + (the rotation of the plot area around the z-axis, in degrees).(0 to 360 degrees). + + + + //Open the presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Get the first slide + ISlide slide = presentation.Slides[0]; + //Get the chart in slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Change the chart type to 3D + chart.ChartType = OfficeChartType.Bar_Clustered_3D; + //Set the rotation + chart.Rotation = 80; + //Set the shadow angle + chart.SideWall.Shadow.Angle = 60; + //Set the backwall border weight + chart.BackWall.Border.LineWeight = OfficeChartLineWeight.Narrow; + //Save the presentation + presentation.Save("output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open the presentation + Dim presentation As IPresentation = Presentation.Open("Sample.pptx") + 'Get the first slide + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart in slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'Change the chart type to 3D + chart.ChartType = OfficeChartType.Bar_Clustered_3D + 'Set the rotation + chart.Rotation = 80 + 'Set the shadow angle + chart.SideWall.Shadow.Angle = 60 + 'Set the backwall border weight + chart.BackWall.Border.LineWeight = OfficeChartLineWeight.Narrow + 'Save the presentation + presentation.Save("output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the elevation of the 3-D chart view, in degrees (�90 to +90 degrees). + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Set the elevation of chart + chart.Elevation = -50; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Set the elevation of chart + chart.Elevation = -50 + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the perspective for the 3-D chart view (0 to 100). + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Set the perspective + chart.Perspective = 100; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Set the perspective of chart + chart.Perspective = 100 + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the height of a 3-D chart as a percentage of the chart width + (between 5 and 500 percent). + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Set the height percent + chart.HeightPercent = 400; + //Set the Depth percent + chart.DepthPercent = 200; + //Set the gap depth of data series + chart.GapDepth = 400; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Set the height percent + chart.HeightPercent = 400 + 'Set the Depth percent + chart.DepthPercent = 200 + 'Set the gap depth of data series + chart.GapDepth = 400 + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the depth of a 3-D chart as a percentage of the chart width + (between 20 and 2000 percent). + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Set the height percent + chart.HeightPercent = 400; + //Set the Depth percent + chart.DepthPercent = 200; + //Set the gap depth of data series + chart.GapDepth = 400; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Set the height percent + chart.HeightPercent = 400 + 'Set the Depth percent + chart.DepthPercent = 200 + 'Set the gap depth of data series + chart.GapDepth = 400 + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the distance between the data series in a 3-D chart, as a percentage of the marker width.( 0 - 500 ) + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Set the height percent + chart.HeightPercent = 400; + //Set the Depth percent + chart.DepthPercent = 200; + //Set the gap depth of data series + chart.GapDepth = 400; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Set the height percent + chart.HeightPercent = 400 + 'Set the Depth percent + chart.DepthPercent = 200 + 'Set the gap depth of data series + chart.GapDepth = 400 + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets a value that indicates the chart axes are at right angles, independent of chart rotation or elevation. + + Trueif the chart axes are at right angles.Otherwise False. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the right angle axes + chart.RightAngleAxes = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the right angle axes + chart.RightAngleAxes = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets whether chart has 3-D scaling. RightAngleAxes property must be true. + + + TrueIf Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Set the right angle axes property of the chart + chart.RightAngleAxes = true; + //Set the auto scaling of chart + chart.AutoScaling = true; + //Save the presentation + presentation.Save("sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the right angle axes + chart.RightAngleAxes = True + 'Set the auto scaling of chart + chart.AutoScaling = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets if gridlines are drawn two-dimensionally on a 3-D chart. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Set the 2D gridlines for chart + chart.WallsAndGridlines2D = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Set the 2D gridlines for chart + chart.WallsAndGridlines2D = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets a value that indicates chart has plot area. + + Trueif chart has plot area. Otherwise False. + + + + Gets or sets the way that blank cells are plotted on a chart. + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Set the way blank cells to be plotted + chart.DisplayBlanksAs = OfficeChartPlotEmpty.Interpolated; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Set the way blank cells to be plotted + chart.DisplayBlanksAs = OfficeChartPlotEmpty.Interpolated + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets a value that indicates the visible/hidden cells are plotted. + + True if only visible cells are plottedFalse if both visible and hidden cells are plotted + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Hide the plot visiblity of cells + chart.PlotVisibleOnly = false; + //Hide the chart size with sheet window + chart.SizeWithWindow = false; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Hide the plot visiblity of cells + chart.PlotVisibleOnly = False + 'Hide the chart size with sheet window + chart.SizeWithWindow = False + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets whether the chart size matches with the chart sheet window. True if Microsoft Excel resizes the chart to match the size of the chart sheet window. + False if the chart size isn't attached to the window size. Applies only to chart sheets. + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Hide the plot visiblity of cells + chart.PlotVisibleOnly = false; + //Hide the chart size with sheet window + chart.SizeWithWindow = false; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IPresentationChart) + 'set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Hide the plot visiblity of cells + chart.PlotVisibleOnly = False + 'Hide the chart size with sheet window + chart.SizeWithWindow = False + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the collection of the all categories of this chart. Read-only. + + + + + Gets or sets an constant that specifies the source level of the series names. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //set the serie name level + chart.SeriesNameLevel = OfficeSeriesNameLevel.SeriesNameLevelNone; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'set the serie name level + chart.SeriesNameLevel = OfficeSeriesNameLevel.SeriesNameLevelNone + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets an constant that specifies the source level of the chart category labels. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Specify the chart type + chart.ChartType = OfficeChartType.Surface_3D; + //Set the category label level + chart.CategoryLabelLevel = OfficeCategoriesLabelLevel.CategoriesLabelLevelAll; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Specify the chart title + chart.ChartTitle = "Sales Analysis" + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Specify the chart type + chart.ChartType = OfficeChartType.Surface_3D + 'Set the category label level + chart.CategoryLabelLevel = OfficeCategoriesLabelLevel.CategoriesLabelLevelAll + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets a style value for the chart. + + + By default is set to 0. Here for example, we set property for style change. + + Chart style value should be between 1 to 48 or 101 to 148. Otherwise style will not be applied. + Not applicable to 2016 charts. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //set the chart style + chart.Style = 14; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'set the chart style + chart.Style = 14 + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets an information about the linked or embedded data associated with a chart. Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Specify the chart title + chart.ChartTitle = "Sales Analysis" + 'Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + INamedObject interface declaration - object with name, + index, and ability to serialize. + + + + + Name of the object. + + + + + Index of the object in the collection. + + + + + + + + + + First Series default name. + + + + + Default chart type. + + + + + Prefix for 3D charts. + + + + + Prefix for bar charts. + + + + + Prefix for clustered charts. + + + + + Prefix for contour charts. + + + + + Prefix for exploded charts. + + + + + Prefix for line charts. + + + + + Prefix for charts with markers. + + + + + Prefix for charts with no color. + + + + + Prefix for 100% charts. + + + + + Prefix for charts with smoothed lines. + + + + + Prefix for stacked charts. + + + + + Start of the chart type for area charts. + + + + + Start of the chart type for bar charts. + + + + + Start of the chart type for bubble charts. + + + + + Start of the chart type for column charts. + + + + + Start of the chart type for cone charts. + + + + + Start of the chart type for cylinder charts. + + + + + Start of the chart type for doughnut charts. + + + + + Start of the chart type for line charts. + + + + + Start of the chart type for pie charts. + + + + + Start of the chart type for pyramid charts. + + + + + Start of the chart type for radar charts. + + + + + Start of the chart type for scatter charts. + + + + + Start of the chart type for surface charts. + + + + + Index of the primary axes. + + + + + Si value index. + + + + + Si category index. + + + + + Si bubble index. + + + + + Index of the secondary axes. + + + + + Maximum font count. + + + + + Represents the Defualt Plot Area Top Left X. + + + + + Represents the Default Plot Area Top Left Y. + + + + + Represents the Default Plot Area X Length. + + + + + Represents the Default Plot Area Y Length. + + + + + Represents start types of chart that support data point. + + + + + Represents types of chart that support series axis . + + + + + Represents types of chart that do not support the pivot chart. + + + + + Represents start types of chart that support data table. + + + + + Represents start types of chart that support error bars. + + + + + Represents start types of chart that support trendlines. + + + + + Represents types of charts that contain walls or floor objects. + + + + + Specifies default secondary axis types. + + + + + Represents types of charts that can't be 3d. + + + + + Represents types of charts that are not 3d. + + + + + Represents series type that supports gridlines. + + + + + Represents series type that must be in secondary primary axis. + + + + + Represents + + + + + Represents array that contain start Series types sorted by drawing order. + + + + + Represents chart types that can change as intimate types. + + + + + Represents chart start types that doesn't need plot or walls. + + + + + Represents chart types for pivot chart which need view tag to be rendered. + + + + + 100% charts: + + + + + Stacked charts: + + + + + 3D charts: + + + + + Line charts: + + + + + Bubble charts: + + + + + Charts that can be without category axis: + + + + + Charts that need another color for each value: + + + + + Exploded charts: + + + + + Charts that need series lines: + + + + + Scatter charts: + + + + + Charts with smoothed lines: + + + + + Stock charts: + + + + + Charts with perspective: + + + + + Clustered charts: + + + + + Charts with plot area (by default): + + + + + Legend types that are displayed vertically: + + + + + Unknown bytes. Needed for data labels serialization. + + + + + Charts that have different ways of data labels storage: + + + + + Charts that can have percentage data labels: + + + + + True if the chart file contains theme override file + + + + + Represents the data contained in the ClrMapOvr tag + + + + + Represent the line chart count. + + + + + Represents to parse sheet on demand + + + + + Specifies the contents of this attribute contain an integer between -100 and 100. + + + + + Represents whether datetime axis contains string reference + + + + + Specifies the contents + + + + + Represents whether to serialize gapwidth + + + + + If true than chart contain secondary axis. + + + + + Represents if chart in worksheet. + + + + + Chart type. + + + + + Pivot Chart type. + + + + + DataRange for the chart series. + + + + + True if series are in rows in DataRange; + otherwise False. + + + + + True if has data table; + otherwise False. + + + + + Page setup for the chart. + + + + + X coordinate of the upper-left corner + of the chart in points (1/72 inch). + + + + + Y coordinate of the upper-left corner + of the chart in points (1/72 inch). + + + + + Width of the chart in points (1/72 inch). + + + + + Height of the chart in points (1/72 inch). + + + + + Array of the fonts used in the chart. + + + + + Collection of all the series of this chart. + + + + + Collection of all the categories of this chart. + + + + + Chart's data table. + + + + + Chart sheet properties. + + + + + This record stores scale factors for font scaling. + + + + + Position of the plot area bounding box. The plot-area bounding box + includes the plot area, tick marks, and a small border around + the tick marks. + + + + + Chart frame format. + + + + + Frame for plot area. + + + + + Dictionary that contains information about default text. + Key - Object identifier for the text, + Value - List with text records. + + + + + Title area. + + + + + Represents primary parent axis record and subrecords. + + + + + Represents secondary parent axis record and subrecords. + + + + + Represents legend in chart. + + + + + True if has legend; + otherwise False. + + + + + Represents chart walls/back_walls. + + + + + Represents chart side_walls. + + + + + Represents chart floor. + + + + + Represents chart plot area. + + + + + Indicates if we change chart or Series type. + + + + + Indicates if we change chart or Series type. + + + + + Represents helper array for parse trends. Use only for parsing. + + + + + Represents list with pivot records; + + + + + WindowZoomRecord that was met inside ChartChartRecord block. + + + + + Relations collection. + + + + + Style index for Excel 2007 chart. + + + + + Stream with extracted higlight color data. + + + + + + + + + + Dictionary with error bars which requires future reparsing. + + + + + Preserved band formats. + + + + + Since we don't parse pivot tables we can only preserve pivot source using string variable, this should be remove after we start pivot tables parsing. + + + + + represents the format id of the chart + + + + + Indicates the all button fields in a pivot chart. + + + + + Indicates the Axis button in a pivot chart. + + + + + Indicates the value button in a pivot chart. + + + + + Indicates the legend button in a pivot chart. + + + + + Indicates the filter button in a pivot chart. + + + + + Indicates wheather the chart contains title + + + + + Indicates wheather the chart have both primary and secondary category + + + + + Indicates wheather the chart have both primary and secondary category + + + + + Preserves the Chart's Default Text Property. + TODO: Need to support Chart default text proprety, should be remove after we start to parse. + + + + + Font used for chart drawing. + + + + + Plot area layout + + + + + Collect the filter from category + + + + + Collect the filter from series + + + + + Represents the Excel2013 series name filter + + + + + Represents the Excel2013 category Filter + + + + + Indicates whether the PlotVisOnly attribute exists or not + + + + + Indicates whether the PlotVisOnly attribute exists or not + + + + + Indicates whether Radar series type is changed on parsing + + + + + Indicates whether the chart is copied from another workbook + + + + + Represents the common category label values. + + + + + Represents the category lable reference as range. + + + + + This stream stores xml text with overided themes. + + + + + Contains list of theme colors. + + + + + Indicates that the chart data is cleared or not. + + + + + Boolean value indicates whether the chart style element file (style1.xml) is skipped on parsing + + + + + Preserves the collection of streams hold the color, style and User shapes elements. + + + + + Dictionary with Data Points which has data labels for different chart groups. + + + + + Chart relational items collection + + + + + Represents indicate wheather chart has external workbook or not. + + + + + Represents the chart is created or parsed + + + + + Represents the show data lables over max value. + + + + + short value indicates the chartEx element position + + + + + Boolean value indicates whether the title can be overlay or not + + + + + Boolean value indicates whether the external data need to be updated + Useful only in parsed workbook + + + + + Relation id denotes the external referenced Id + Useful only in parsed workbook + + + + + Contains list of series groups in the chart + + + + + Sets the Worksheet data into the current chart. + + + + + Sets the Worksheet data into the current chart. + + If the value is true then the chart data is recalculated based on the updated value otherwise the same chart data is maintained. + + + + Creates chart and sets its Application and Parent + properties to specified values. + + Application object for the chart. + Parent object for the chart. + + + + Creates chart from the array of BiffRecords. + + Application object for the chart. + Parent object for the chart. + Array of BiffRecords with chart's data. + Position of the first chart's record. + Parse options. + + + + Searches for all necessary parent objects. + + + + + Creates chart title object. + + + + + Parses internal records. + + + + + Parses object's records. + + + + + Saves all chart records in the internal storage (without first BOF record). + + Array with chart records. + Position to the first chart record. + Array that will get all chart records. + Parse options. + + + + Detects type of the chart. + + + When it is not possible to detect chart type. + + + + + Find and Update Category + + + + + + + Update seriesFilter + + + + + + Find the Category Range + + + + + + + + + + Getting the filter from series and categories + + + + + Filter is assigned to the categories/series. + + + + + Get chart title name + + return chart Title name + + + + Returns True if chart is a clustered chart. Read-only. + + + + + Returns True if chart is 100%. Read-only. + + + + + Returns True if chart is a stacked chart. Read-only. + + + + + Indicates whether specified charttype is pie chart. + + Represents chart type to check. + Value indicating whether specified chart type is pie chart. + + + + Creates necessary primary axes. + + Value indicating whether axis is primary. + + + + Initializes all internal collections. + + + + + Checks whether chart support data table. + + + + + Checks whether data table is compatible with specified start type. + + + + + + Initializes collection of default text objects. + + + + + This method is called if DataRange was changed. + + Represents chart type. + + + + Calculate the serie name range by empty spaces + + Input data range to calculate + Input Data Range without series name range + boolean value indicates whether the chart is Office 2016 or not + series name range + + + + Calculate and retruns the range after removing the input series name range + + The complete input range to calculate + Input series name range + Input series name range modified + the axis range + + + + This method is called when IsSeriesInRows is changed. + + + + + Updates series in bubble chart. + + + + + This method is called when chart type is changed. + + Represents chart type. + Value indicating whether series needs to be created. + + + + Updates tick record in surface chart type. + + + + + Updates tick record in radar chart type. + + + + + Updates chart members on type changing. + + Represents new chart type. + + + + Check whether the input chart type is ChartEx type or not + + input chart type + the boolean value indicates whether the chart type is chart ex + + + + Change the chart to chart ex type + + Indicates the old chart type + input chart type to be modified + boolean value indicates whether the series is created or not + + + + Changes Chart type for one of stock types. + + Type to change. + + + + Initializes chart frames. + + + + + Removes chart format. + + Format to remove. + + + + Detects data range by series and category axis. + + Returns detected data range or null if cann't detect. + + + + Detects if series in rows or in column. + + Represents data range. + Returns true if in rows; otherwise in column. + + + + Gets range, that represents series name or category axis by data range. + + Represents data range. + Represents if series in row. + Represents range, that contain series value range. + Returns series name or category axis range, if can; otherwise null. + + + + Validates Series range for min Series count of custom chart type. + + Represents range, that contain Series values. + Represents chart type. + Returns true if can set data range, otherwise false. + + + + Indicates if Series is in data range. + + Represents rec of first Series values. + Represents range of current Series values. + index of this Series in collection. + Represents sheet name. + Returns true if series values is equal. + + + + Gets range, that represents series value range. + + Represents last range. + Represents bubble range. + Represents parent sheet. + Represents name of worksheet in data range. + Returns detected series range. + + + + Gets range, that represents series name values. + + Represents first Series name range. + Represents bubble range. + Represents parent sheet. + Represents sheet name. + Sets out parameter to Series name range. + Value indicating range representing serie name values. + + + + Updates data range rectangle. + + Represents range to update. + Represents rec, that represents current data range. Ref parameter. + Indicates if values is in rows. + Returns true if can update data range; otherwise false. + + + + Detects if series in rows. + + Returns true if series values in row; otherwise - false. + + + + Changes chart type. + + Represents new chart type. + Value indicating whether to create series. + + + + Prepares protection options before setting protection. + + + + + + + Check and update the needed changes for chart to chartEx or chartEx to chart conversion + + previous chart type + new chart type + Value indicating whether to create series. + + + + Clear the stream which is to be ignored on chartEx and chart conversion + + + + + Clones current instance. + + Parent object. + Returns clone of current object. + + + + Clones current instance. + + Hash table with new Worksheet names. + Parent object. + Dictionary with new font indexes. + Returns clone of current object. + + + + Changes primary axis from primary to secondary. + + If parsing - true; otherwise false. + + + + Updates Fbi Font indexes. + + Dictionary with new indexes. + + + + Updates Fontx indexes. + + Dictionary with new indexes. + + + + Chacks for existing gridlines in chart. + + Returns true if can exist; otherwise false. + + + + Check for if any series is bubble_3D,Assign SerieFormat + + Chart to be changed + + + + Sets to default chart grid lines on chart type or Series type changing. + + Represents type to change. + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Method saves the chart sheet as image in the stream. + + The stream to save the image. + + + + Indicates whether the chart type is Stock chart + + + + + Creates primary series axis. + + Created axis. + + + + Returns the chart color respect to index on automatic format + + index of the series or data points + total count of series and data points + Indicates whether the parent workbook is binary or not + Indicates whether the color to be taken from color palette only for line,scatter,radar in binary files + the Color of the chart + + + + Get the chart color based on the color index + + input color theme index + the equivalent color based on the theme index + + + + Check whether the formula is valid and returns the boolean value + If returns false, the formula parsing skipped + + input formula value + the boolean value + + + + Gets the chart string for Word comparison. + + + + + + Gets the Biff storage string for Word comparison. + + + + + + + Gets the chart serie string for Word comparison. + + + + + + + Gets the chart legend entry string for Word comparison. + + + + + + + Gets the chart legend record string for Word comparison. + + + + + + + Gets the chart attached label layout record string for Word comparison. + + + + + + + Gets the chart manual layout string for Word comparison. + + + + + + + Gets the chart Legend entries string for Word comparison. + + + + + + + Gets the chart position record string for Word comparison. + + + + + + + Gets the chart marker format record string for Word comparison. + + + + + + + Gets the Gradient stops string for Word comparison. + + + + + + + Gets the Rectangle string for Word comparison. + + + + + + + Gets the chart interior string for Word comparison. + + + + + + + Gets the Shadow string for Word comparison. + + + + + + + Gets the 3D format string for Word comparison. + + + + + + + Gets the Fill string for Word comparison. + + + + + + + Gets the chart Series string for Word comparison. + + + + + + + Gets the chart catrgories string for Word comparison. + + + + + + + Gets the chart data table string for Word comparison. + + + + + + + Gets the chart wall or floor string for Word comparison. + + + + + + + Gets the chart frame format string for Word comparison. + + + + + + + Gets the chart text area string for Word comparison. + + + + + + + Gets the Data range string for Word comparison. + + + + + + + Gets the Work sheet string for Word comparison. + + + + + + + Gets the chart sheet properties record string for Word comparison. + + + + + + + Gets the chart format collection string for Word comparison. + + + + + + + Gets the chart format string for Word comparison. + + + + + + + Gets the chart frame format string for Word comparison. + + + + + + + Gets the chart legend string for Word comparison. + + + + + + + Gets the properties text for Chart + + + + + Gets the properties text for Chart + + + + + Gets the Font wrapper string for Word comparison. + + + + + + + Gets the properties text for Chart + + + + + Gets the properties text for Chart + + + + + Gets the properties text for Chart + + + + + Gets the properties text for Chart + + + + + Gets the properties text for Chart + + + + + Gets the properties text for Chart + + + + + Gets the properties text for Chart + + + + + Gets the properties text for Chart + + + + + Gets the properties text for Chart + + + + + Gets the properties text for Chart + + + + + Gets the properties text for Chart + + + + + Gets the properties text for Chart + + + + + Gets the properties text for Chart + + + + + Gets the properties text for Chart + + + + + Gets the properties text for Chart + + + + + To compare two chart objects whether they have same properties + + + + + + + Compare one data range with another and returns true if equal else false. + + + + + To compare the worksheetImpl object of the chart and return boolean value. + + + + + Compares the ChartFrameFormat of two objects and returns true else false. + + + + + Compares the chart Frame object of two charts with argument as Implementation object. + + + + + Compares the two chart Walls or Floor are equal or not + + + + + Compares two chart series are equal or not. + + + + + Compares the two chart DataTable adn return true if equal else false. + + + + + method checks whether two ChartPosRecord objects are equal in their properties and returns a boolean value + + + + + Method to compare the categories of two chart. + + + + + Method to compare the two fonts are equal or not. + + + + + To compare the two chart category axis , whether they are equal or not. + + + + + To compare the two chart series axis and return whether true or false. + + + + + To compare the two chart Value axis , whether they are equal or not. + + + + + To compare the two chart border objects and return true or false + + + + + To Com[pare two text record objects whether they are equal or not. + + + + + To compare two color object whether they have same color properties. + + + + + Compares two chart ObjectLinkRecord and return a boolean value. + + + + + Compare the two differnet chartAlrunsRecord1 object and return true if equal else false. + + + + + Compare the Label layout records and returns a boolean value false if any properties mismatch else true. + + + + + Compares two ChartAI Record objects and returns a boolean value. + + + + + compares the workbook object with another and return a boolean value. + + + + + To compare the chart layout options and properties object + + + + + Compare the rich Text string of the two objects are same + + + + + To compare the fill objects and return true if equal else false. + + + + + To compare thh Three format options of two chart and return true if equal else falase. + + + + + To compare the shadow properties of two shadow objects are same and return true if equal else false. + + + + + To compare the interior properties of two objects. + + + + + To compare the two gradient stops object have the same properties. + + + + + To compare the HistogramAxis format properties of two objects. + + + + + To compare the chart MarkerFormatRecord of two chart and return a boolean value. + + + + + To compare two diffetent chart Legend entries and return true if equal else false. + + + + + To Compare two manual layout object in the chart and compare the properties and return true if equal else false. + + + + + To Compare two different chart serie Impl objects and return true if equal else false. + + + + + To Compare Two Biff storage objects have same properties and values and return true, else return false + + + + + To Compare two ChartShtpropsRecord objects and return true if equal, otherwise false. + + + + + To compare twp chart format collections objects and return true else return false. + + + + + To Compare the chart format impl objects and return true if equal, otherwise return false. + + + + + To Compare the chart frame format impl objects and check the propeties are same and return true if equal, otherwise return false. + + + + + To Compare the Grid Lines objects adn return true if equal and else false. + + + + + To Compare two Chart PlotGrowthRecord objects are equal or not, if equal return true,else false. + + + + + To Compare two plotAreaLayoutRecord have the same properties and return true if equal else false. + + + + + To Compare two legends are same if equal returns true, else returns false. + + + + + Compare two legend record object and return true if equal or else false. + + + + + + To compare the font wrapper objects in the charts and return true if equal else false. + + + + + Chart relational items collection + + + + + Indicates the DateTime axis contains a string reference or not. + + + + + Specifies the contents of this attribute contain an integer between -100 and 100. + + + + + Represents whether to serialize gapwidth + + + + + Returns or sets the rotation of the 3-D chart view + (the rotation of the plot area around the z-axis, in degrees).(0 to 360 degrees). + + + + + Returns or sets the elevation of the 3-D chart view, in degrees (90 to +90 degrees). + + + + + Returns or sets the perspective for the 3-D chart view.( 0 - 100 ) + + + + + Gets or sets the type of the pivot chart. + + The type of the pivot chart. + + + + It specifies the Format id of the chart + + + + + Gets or sets a value indicating whether [show all field buttons]. + + + true if [show all field buttons]; otherwise, false. + + + + + Gets or sets a value indicating whether [show value field buttons]. + + + true if [show value field buttons]; otherwise, false. + + + + + Gets or sets a value indicating whether [show axis field buttons]. + + + true if [show axis field buttons]; otherwise, false. + + + + + Gets or sets a value indicating whether [show legend field buttons]. + + + true if [show legend field buttons]; otherwise, false. + + + + + Gets or sets a value indicating whether [show report filter field buttons]. + + + true if [show report filter field buttons]; otherwise, false. + + + + + Returns or sets the height of a 3-D chart as a percentage of the chart width + (between 5 and 500 percent). + + + + + Returns or sets the depth of a 3-D chart as a percentage of the chart width + (between 20 and 2000 percent). + + + + + Returns or sets the distance between the data series in a 3-D chart, as a percentage of the marker width.( 0 - 500 ) + + + + + True if the chart axes are at right angles, independent of chart rotation or elevation. + + + + + True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart.. + + + + + True if gridlines are drawn two-dimensionally on a 3-D chart. + + + + + Type of the chart. + + + + + Represents the Series NameLevel. + + + + + Represents the Cateories NameLevel. + + + + + DataRange for the chart series. + + + + + DataRange for the chart series. + + + + + True if series are in rows in DataRange; + otherwise False. + + + + + Title of the chart. + + + + + Returns object that describes chart title area. Read-only. + + + + + Gets font used for title displaying. Read-only. + + + + + Title of the category axis. + + + + + Indicates wheather the chart have both primary and secondary category + + + + + Indicates wheather the chart have both primary and secondary value + + + + + Title of the value axis. + + + + + Title of the secondary category axis. + + + + + Title of the secondary value axis. + + + + + Title of the series axis. + + + + + Returns primary category axis. Read-only. + + + + + Returns primary value axis. Read-only. + + + + + Returns primary series axis. Read-only. + + + + + Returns secondary category axis. Read-only. + + + + + Returns secondary value axis. Read-only. + + + + + Page setup for the chart. Read-only. + + + + + X coordinate of the upper-left corner + of the chart in points (1/72 inch). + + + + + Y coordinate of the upper-left corner + of the chart in points (1/72 inch). + + + + + Width of the chart in points (1/72 inch). + + + + + Height of the chart in points (1/72 inch). + + + + + Collection of the all series of this chart. Read-only. + + + + + Collection of all categories of this chart.Read-only + + + + + Returns chart format collection in primary axis. + + + + + Returns chart format collection in secondary axis. + + + + + Returns an object that represents the complete chart area for the chart. Read-only. + + + + + Indicates whether chart has chart area. + + + + + Indicates whether chart has plot area. + + + + + Returns plot area frame format. Read-only. + + + + + Returns primary parent axis. + + + + + Returns secondary parent axis. + + + + + Represents chart walls. + + + + + Represents the SideWall + + + + + Represents the BackWall + + + + + Represents chart floor. + + + + + Represents charts dataTable object. + + + + + True if the chart has a data table. + + + + + Represents chart legend. + + + + + True if the chart has a legend object. + + + + + True if the chart has a title. + + + + + Represents the way that blank cells are plotted on a chart. + + + + + True if only visible cells are plotted. False if both visible and hidden cells are plotted. + + + + + Indicates whether to show the PlotVisOnly attribute or not + + + + + True if Microsoft Excel resizes the chart to match the size of the chart sheet window. + False if the chart size isn't attached to the window size. Applies only to chart sheets. + + + + + Indicates whether this chart supports walls and floor. Read-only. + + + + + True if objects are protected. Read-only. + + + + + True if the scenarios of the current sheet are protected. Read-only. + + + + + Gets protected options. Read-only. For sets protection options use "Protect" method. + + + + + Return attached label layout record. Read-only + + + + + Represents the common category label values. + + + + + Represents the category lable reference as range + + + + + Represents the chart is created or parsed + + + + + Indicates the position and alignment of chart title + + + + + Indicates the chart title included in chart + + + + + Gets / Sets the Auto update member variable + + + + + Gets / Sets the ChartEx relation Id member variable + + + + + True if the chart type is treemap or sunburst. Otherwise false + + + + + True if the chart type is histogram or pareto. Otherwise false + + + + + True if the chart contains theme override file + + + + + Represents the data contained in the ClrMapOvr tag + + + + + Get or set indicate wheather the chart has external workbook or not. + + + + + Gets and sets the line chart count. + + + + + Tab color. + + + + + Returns True if chart has a category axis. Read-only. + + + + + Returns True if chart has a value axis. Read-only. + + + + + Returns True if chart has a series axis. Read-only. + + + + + Returns True if chart is stacked. Read-only. + + + + + Returns True if chart is 100%. Read-only. + + + + + Returns True if chart is 3D. Read-only. + + + + + Gets a value indicating whether this instance is pivot chart3 D. + + + true if this instance is pivot chart3 D; otherwise, false. + + + + + Returns True if chart is line. Read-only. + + + + + Returns True if chart needs data format to be saved. Read-only. + + + + + Returns True if chart needs marker format to be saved. Read-only. + + + + + Returns True if chart is a bar chart. Read-only. + + + + + Returns True if chart is a pyramid shape. Read-only. + + + + + Returns True if chart is a conical shape. Read-only. + + + + + Returns True if chart is a cylinder shape. Read-only. + + + + + Returns True if chart is a bubble chart. Read-only. + + + + + Returns True if chart is a doughnut chart. Read-only. + + + + + Returns True if chart should have a different color for each series value. Read-only. + + + + + Returns True if chart is exploded. Read-only. + + + + + Returns True if chart has series lines. Read-only. + + + + + Returns True if chart can have series lines. Read-only. + + + + + Returns True if chart is a scatter chart. Read-only. + + + + + Returns default line pattern for the chart. Read-only. + + + + + Returns True if chart has smoothed lines. Read-only. + + + + + Returns True if this is a stock chart. Read-only. + + + + + Returns True if chart needs drop bars to be saved. Read-only. + + + + + Returns True if chart is a stock chart with volume. Read-only. + + + + + Returns True if chart has perspective. Read-only. + + + + + Returns True if chart is a clustered chart. Read-only. + + + + + Returns True if chart has no plot area. Read-only. + + + + + Returns True if chart is a radar chart. Read-only. + + + + + Returns True if chart is a pie chart. Read-only. + + + + + Returns True if chart has walls. Read-only. + + + + + Returns True if chart has floor. Read-only. + + + + + Gets the serialized axis ids. + + The serialized axis ids. + + + + Returns True if secondary category axis present. Read-only. + + + + + Returns True if secondary value axis present. Read-only. + + + + + Returns True if at least one of the secondary axes is present. Read-only. + + + + + Returns True if chart needs special data labels serialization. + Read-only. + + + + + Returns True if chart can have percentage data labels. Read-only. + + + + + Returns True if chart can have bubble data labels. Read-only. + + + + + Indicates whether chart was manually formatted. + + + + + This record stores scale factors for font scaling. + + + + + Plot are bounding box. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + Returns inner frame format. Read-only. + + + + + Returns inner plot area frame format. Read-only. + + + + + Returns start type of chart type. Read-only. + + + + + Page setup for the chart. Read-only. + + + + + Gets chart options. Read-only. + + + + + Represents if chart is reading from biff stream. Read-only. + + + + + Gets chart format for 3-d charts. Read-only. + + + + + Indicates if we change chart or Series type. + + + + + Resulting chart type after type change operation. + + + + + Returns collection of chart relations. Read-only. + + + + + Style index for chart. + + + + + Gets value indicating whether floor object was created. + + + + + Gets value indicating whether floor object was created. + + + + + Get or set the highlight color stream for data labels + + + + + Gets or sets zoomToFit value. + + + + + Gets the default protection options for the worksheet. + + + + + Gets value indicating whether chart is embeded into worksheet. + + + + + Gets font index from the default font records. + + + + + Gets or sets preserved band formats for surface chart. + + + + + Indicates whether chart has title. + + + + + Preserves the Chart's Default Text Property. + TODO: Need to support Chart default text proprety, should be remove after we start to parse. + + + + + Returns font used for axis text displaying. Read-only. + + + + + Gets or sets to specify the title shall not be shown for this chart. + + + + + Gets or sets the boolean value to load worksheets on demand + + + + + Gets or sets to specify the title shall not be shown for this chart. + + + + + Returns the preserved stream collection of the chart + + + + + Properties for list of chart series groups. + + + + + Provides the data cache information + Used at parsing + + + + + formula referred for category values + + + + + formula referred for series values + + + + + Array of values used in series values + + + + + Array of values used in categories + + + + + Boolean value indicates category values interpreted in row-wise + + + + + Boolean value indicates series values interpreted in row-wise + + + + + format code used in series values + + + + + format code used in category values + + + + + Copy the current properties to chart serie + + series in which properties to be copied + Parent workbook + + + + Gets/Sets formula referred for category values + + + + + Gets / Sets formula referred for series values + + + + + Gets / SetsArray of values used in series values + + + + + Gets/Sets Array of values used in categories + + + + + Gets / SetsBoolean value indicates category values interpreted in row-wise + + + + + Gets / SetsBoolean value indicates series values interpreted in row-wise + + + + + Gets / Sets the format code for series values + + + + + Gets / Sets the format code for series categories + + + + + Represents chart interior. + + + + + Represents the interior of the chart element. + + + + + Gets or sets the foreground color (RGB). + + + + + Gets or sets background color (RGB). + + + + + Gets or sets area pattern. + + + + + Gets or sets index of foreground color. + + + + + Gets or sets the background color index. + + + + + Gets or sets a value that indicates the interior space should use the automatic or custom format. + + Trueif use automatic.Otherwise False. + + + + Gets or sets a value that indicated a foreground and background are swapped when the data value is negative. + + + + + Represents area format record. + + + + + Represents parent book. + + + + + Represents parent Series format. + + + + + Represents series fore color. + + + + + Represents series back color. + + + + + Represents dictionary to convert OfficePattern to excelgradient pattern. + key - OfficePattern, value - OfficeGradientPattern. + + + + + Initialize all static members. + + + + + Creates chart interior instance. + + Represents current application. + Represents parent object. + + + + Finds parent objects. + + + + + Updates foreground color. + + + + + Updated background color. + + + + + Initialize interior for frame format. + + Indicate is autosize interior. + Represents is 3d chart. + Indicates is interior is gray. + + + + Initialize interior for frame format. + + Indicate is autosize interior. + Represents is 3d chart. + Indicates is interior is gray. + Indicates is default color is gray_50. + + + + Clones current object. + + Represents parent object. + Returns cloned object. + + + + Makes copy of the current object and update its parent. + + Represents Parent object to set. + Cloned object. + + + + Foreground color (RGB). + + + + + Background color (RGB). + + + + + Foreground color (RGB). + + + + + Background color (RGB). + + + + + Area pattern. + + + + + Index of foreground color. + + + + + Background color index. + + + + + If true - use automatic format; otherwise custom. + + + + + Foreground and background are swapped when the data value is negative. + + + + + Class used for setting chart elements layout + + + + + Represents the layout of the chart element. + + + + + Gets or sets the manual layout of the chart element. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IPresentationChart chart = presentation.Slides[0].Charts[0] as IPresentationChart; + //Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top; + //Get the legend layout + IOfficeChartLayout layout = chart.Legend.Layout; + //Get the manual layout + IOfficeChartManualLayout manualLayout = layout.ManualLayout; + //Modify the manual layout left position + manualLayout.Left = 100; + //Modify the manual layout left mode + manualLayout.LeftMode = LayoutModes.factor; + //Modify the manual layout top position + manualLayout.Top = 100; + //Modify the manual layout top mode + manualLayout.TopMode = LayoutModes.factor; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IPresentationChart = TryCast(presentation__1.Slides(0).Charts(0), IPresentationChart) + 'Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top + 'Get the legend layout + Dim layout As IOfficeChartLayout = chart.Legend.Layout + 'Get the manual layout + Dim manualLayout As IOfficeChartManualLayout = layout.ManualLayout + 'Modify the manual layout left position + manualLayout.Left = 100 + 'Modify the manual layout left mode + manualLayout.LeftMode = LayoutModes.factor + 'Modify the manual layout top position + manualLayout.Top = 100 + 'Modify the manual layout top mode + manualLayout.TopMode = LayoutModes.factor + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets whether to layout only the plot area. + + + + + Gets or sets how to interpret the Left element for this manual layout + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IPresentationChart chart = presentation.Slides[0].Charts[0] as IPresentationChart; + //Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top; + //Get the legend layout + IOfficeChartLayout layout = chart.Legend.Layout; + //Modify the legend layout height + layout.Height = 120; + //Modify the legend layout height mode + layout.HeightMode = LayoutModes.factor; + //Modify the legend layout width + layout.Width = 100; + //Modify the legend layout width mode + layout.WidthMode = LayoutModes.edge; + //Modify the legend layout left position + layout.Left = 100; + //Modify the legend layout left mode + layout.LeftMode = LayoutModes.factor; + //Modify the legend layout top position + layout.Top = 100; + //Modify the legend layout top mode + layout.TopMode = LayoutModes.factor; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IPresentationChart = TryCast(presentation__1.Slides(0).Charts(0), IPresentationChart) + 'Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top + 'Get the legend layout + Dim layout As IOfficeChartLayout = chart.Legend.Layout + 'Modify the legend layout height + layout.Height = 120 + 'Modify the legend layout height mode + layout.HeightMode = LayoutModes.factor + 'Modify the legend layout width + layout.Width = 100 + 'Modify the legend layout width mode + layout.WidthMode = LayoutModes.edge + 'Modify the legend layout left position + layout.Left = 100 + 'Modify the legend layout left mode + layout.LeftMode = LayoutModes.factor + 'Modify the legend layout top position + layout.Top = 100 + 'Modify the legend layout top mode + layout.TopMode = LayoutModes.factor + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets how to interpret the Top element for this manual layout. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IPresentationChart chart = presentation.Slides[0].Charts[0] as IPresentationChart; + //Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top; + //Get the legend layout + IOfficeChartLayout layout = chart.Legend.Layout; + //Modify the legend layout height + layout.Height = 120; + //Modify the legend layout height mode + layout.HeightMode = LayoutModes.factor; + //Modify the legend layout width + layout.Width = 100; + //Modify the legend layout width mode + layout.WidthMode = LayoutModes.edge; + //Modify the legend layout left position + layout.Left = 100; + //Modify the legend layout left mode + layout.LeftMode = LayoutModes.factor; + //Modify the legend layout top position + layout.Top = 100; + //Modify the legend layout top mode + layout.TopMode = LayoutModes.factor; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IPresentationChart = TryCast(presentation__1.Slides(0).Charts(0), IPresentationChart) + 'Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top + 'Get the legend layout + Dim layout As IOfficeChartLayout = chart.Legend.Layout + 'Modify the legend layout height + layout.Height = 120 + 'Modify the legend layout height mode + layout.HeightMode = LayoutModes.factor + 'Modify the legend layout width + layout.Width = 100 + 'Modify the legend layout width mode + layout.WidthMode = LayoutModes.edge + 'Modify the legend layout left position + layout.Left = 100 + 'Modify the legend layout left mode + layout.LeftMode = LayoutModes.factor + 'Modify the legend layout top position + layout.Top = 100 + 'Modify the legend layout top mode + layout.TopMode = LayoutModes.factor + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the x location (left) of the chart element as a fraction of the width of the chart. + If Left Mode is Factor, then the position is relative to the default position for the chart element. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IPresentationChart chart = presentation.Slides[0].Charts[0] as IPresentationChart; + //Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top; + //Get the legend layout + IOfficeChartLayout layout = chart.Legend.Layout; + //Modify the legend layout height + layout.Height = 120; + //Modify the legend layout height mode + layout.HeightMode = LayoutModes.factor; + //Modify the legend layout width + layout.Width = 100; + //Modify the legend layout width mode + layout.WidthMode = LayoutModes.edge; + //Modify the legend layout left position + layout.Left = 100; + //Modify the legend layout left mode + layout.LeftMode = LayoutModes.factor; + //Modify the legend layout top position + layout.Top = 100; + //Modify the legend layout top mode + layout.TopMode = LayoutModes.factor; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IPresentationChart = TryCast(presentation__1.Slides(0).Charts(0), IPresentationChart) + 'Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top + 'Get the legend layout + Dim layout As IOfficeChartLayout = chart.Legend.Layout + 'Modify the legend layout height + layout.Height = 120 + 'Modify the legend layout height mode + layout.HeightMode = LayoutModes.factor + 'Modify the legend layout width + layout.Width = 100 + 'Modify the legend layout width mode + layout.WidthMode = LayoutModes.edge + 'Modify the legend layout left position + layout.Left = 100 + 'Modify the legend layout left mode + layout.LeftMode = LayoutModes.factor + 'Modify the legend layout top position + layout.Top = 100 + 'Modify the legend layout top mode + layout.TopMode = LayoutModes.factor + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the top of the chart element as a fraction of the height of the chart. + If Top Mode is Factor, then the position is relative to the default position for the chart element. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IPresentationChart chart = presentation.Slides[0].Charts[0] as IPresentationChart; + //Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top; + //Get the legend layout + IOfficeChartLayout layout = chart.Legend.Layout; + //Modify the legend layout height + layout.Height = 120; + //Modify the legend layout height mode + layout.HeightMode = LayoutModes.factor; + //Modify the legend layout width + layout.Width = 100; + //Modify the legend layout width mode + layout.WidthMode = LayoutModes.edge; + //Modify the legend layout left position + layout.Left = 100; + //Modify the legend layout left mode + layout.LeftMode = LayoutModes.factor; + //Modify the legend layout top position + layout.Top = 100; + //Modify the legend layout top mode + layout.TopMode = LayoutModes.factor; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IPresentationChart = TryCast(presentation__1.Slides(0).Charts(0), IPresentationChart) + 'Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top + 'Get the legend layout + Dim layout As IOfficeChartLayout = chart.Legend.Layout + 'Modify the legend layout height + layout.Height = 120 + 'Modify the legend layout height mode + layout.HeightMode = LayoutModes.factor + 'Modify the legend layout width + layout.Width = 100 + 'Modify the legend layout width mode + layout.WidthMode = LayoutModes.edge + 'Modify the legend layout left position + layout.Left = 100 + 'Modify the legend layout left mode + layout.LeftMode = LayoutModes.factor + 'Modify the legend layout top position + layout.Top = 100 + 'Modify the legend layout top mode + layout.TopMode = LayoutModes.factor + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets how to interpret the Width element for this manual layout. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IPresentationChart chart = presentation.Slides[0].Charts[0] as IPresentationChart; + //Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top; + //Get the legend layout + IOfficeChartLayout layout = chart.Legend.Layout; + //Modify the legend layout height + layout.Height = 120; + //Modify the legend layout height mode + layout.HeightMode = LayoutModes.factor; + //Modify the legend layout width + layout.Width = 100; + //Modify the legend layout width mode + layout.WidthMode = LayoutModes.edge; + //Modify the legend layout left position + layout.Left = 100; + //Modify the legend layout left mode + layout.LeftMode = LayoutModes.factor; + //Modify the legend layout top position + layout.Top = 100; + //Modify the legend layout top mode + layout.TopMode = LayoutModes.factor; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IPresentationChart = TryCast(presentation__1.Slides(0).Charts(0), IPresentationChart) + 'Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top + 'Get the legend layout + Dim layout As IOfficeChartLayout = chart.Legend.Layout + 'Modify the legend layout height + layout.Height = 120 + 'Modify the legend layout height mode + layout.HeightMode = LayoutModes.factor + 'Modify the legend layout width + layout.Width = 100 + 'Modify the legend layout width mode + layout.WidthMode = LayoutModes.edge + 'Modify the legend layout left position + layout.Left = 100 + 'Modify the legend layout left mode + layout.LeftMode = LayoutModes.factor + 'Modify the legend layout top position + layout.Top = 100 + 'Modify the legend layout top mode + layout.TopMode = LayoutModes.factor + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets how to interpret the Height element for this manual layout. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IPresentationChart chart = presentation.Slides[0].Charts[0] as IPresentationChart; + //Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top; + //Get the legend layout + IOfficeChartLayout layout = chart.Legend.Layout; + //Modify the legend layout height + layout.Height = 120; + //Modify the legend layout height mode + layout.HeightMode = LayoutModes.factor; + //Modify the legend layout width + layout.Width = 100; + //Modify the legend layout width mode + layout.WidthMode = LayoutModes.edge; + //Modify the legend layout left position + layout.Left = 100; + //Modify the legend layout left mode + layout.LeftMode = LayoutModes.factor; + //Modify the legend layout top position + layout.Top = 100; + //Modify the legend layout top mode + layout.TopMode = LayoutModes.factor; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IPresentationChart = TryCast(presentation__1.Slides(0).Charts(0), IPresentationChart) + 'Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top + 'Get the legend layout + Dim layout As IOfficeChartLayout = chart.Legend.Layout + 'Modify the legend layout height + layout.Height = 120 + 'Modify the legend layout height mode + layout.HeightMode = LayoutModes.factor + 'Modify the legend layout width + layout.Width = 100 + 'Modify the legend layout width mode + layout.WidthMode = LayoutModes.edge + 'Modify the legend layout left position + layout.Left = 100 + 'Modify the legend layout left mode + layout.LeftMode = LayoutModes.factor + 'Modify the legend layout top position + layout.Top = 100 + 'Modify the legend layout top mode + layout.TopMode = LayoutModes.factor + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the width (if Width Mode is Factor) or right (if Width Mode is Edge) of the chart element + as a fraction of the width of the chart. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IPresentationChart chart = presentation.Slides[0].Charts[0] as IPresentationChart; + //Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top; + //Get the legend layout + IOfficeChartLayout layout = chart.Legend.Layout; + //Modify the legend layout height + layout.Height = 120; + //Modify the legend layout height mode + layout.HeightMode = LayoutModes.factor; + //Modify the legend layout width + layout.Width = 100; + //Modify the legend layout width mode + layout.WidthMode = LayoutModes.edge; + //Modify the legend layout left position + layout.Left = 100; + //Modify the legend layout left mode + layout.LeftMode = LayoutModes.factor; + //Modify the legend layout top position + layout.Top = 100; + //Modify the legend layout top mode + layout.TopMode = LayoutModes.factor; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IPresentationChart = TryCast(presentation__1.Slides(0).Charts(0), IPresentationChart) + 'Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top + 'Get the legend layout + Dim layout As IOfficeChartLayout = chart.Legend.Layout + 'Modify the legend layout height + layout.Height = 120 + 'Modify the legend layout height mode + layout.HeightMode = LayoutModes.factor + 'Modify the legend layout width + layout.Width = 100 + 'Modify the legend layout width mode + layout.WidthMode = LayoutModes.edge + 'Modify the legend layout left position + layout.Left = 100 + 'Modify the legend layout left mode + layout.LeftMode = LayoutModes.factor + 'Modify the legend layout top position + layout.Top = 100 + 'Modify the legend layout top mode + layout.TopMode = LayoutModes.factor + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the height (if Height Mode is Factor) or bottom (if Height Mode is edge) of the chart + element as a fraction of the height of the chart. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IPresentationChart chart = presentation.Slides[0].Charts[0] as IPresentationChart; + //Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top; + //Get the legend layout + IOfficeChartLayout layout = chart.Legend.Layout; + //Modify the legend layout height + layout.Height = 120; + //Modify the legend layout height mode + layout.HeightMode = LayoutModes.factor; + //Modify the legend layout width + layout.Width = 100; + //Modify the legend layout width mode + layout.WidthMode = LayoutModes.edge; + //Modify the legend layout left position + layout.Left = 100; + //Modify the legend layout left mode + layout.LeftMode = LayoutModes.factor; + //Modify the legend layout top position + layout.Top = 100; + //Modify the legend layout top mode + layout.TopMode = LayoutModes.factor; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IPresentationChart = TryCast(presentation__1.Slides(0).Charts(0), IPresentationChart) + 'Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top + 'Get the legend layout + Dim layout As IOfficeChartLayout = chart.Legend.Layout + 'Modify the legend layout height + layout.Height = 120 + 'Modify the legend layout height mode + layout.HeightMode = LayoutModes.factor + 'Modify the legend layout width + layout.Width = 100 + 'Modify the legend layout width mode + layout.WidthMode = LayoutModes.edge + 'Modify the legend layout left position + layout.Left = 100 + 'Modify the legend layout left mode + layout.LeftMode = LayoutModes.factor + 'Modify the legend layout top position + layout.Top = 100 + 'Modify the legend layout top mode + layout.TopMode = LayoutModes.factor + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Parent chart. + + + + + Parent object + + + + + Chart interface + + + + + ChartShape interface + + + + + Manual layout + + + + + Creates chart and sets its Application and Parent + properties to specified values. + + Application object for the chart. + Parent object for the chart. + + + + Creates chart and sets its Application and Parent + properties to specified values. + + Application object for the chart. + Parent object for the chart. + Indicates is auto size. + Indicates is interior is gray. + Indicates whether we should set defaults for fill and border properties. + + + + Searches for all necessary parent objects. + + + + + Set variable to the default state. + + Indicates whether MS Excel should calculate size of the frame. + Indicates is default interior is gray. + + + + Returns parent workbook. Read-only. + + + + + Return the parent object. Read-only. + + + + + Gets or sets the manual layout for the layout + + + + + Gets or sets the layout target + + + + + Gets or sets the left mode (x) value + + + + + Gets or sets the top mode (y) value + + + + + Gets or sets the left (x) value + + + + + Gets or sets the top (y) value + + + + + Gets or sets the Width mode + + + + + Gets or sets the Height mode + + + + + Gets or sets the Width + + + + + Gets or sets the Height + + + + + Indicates whether the manual layout is initialized or not + + + + + Represents collection of ChartLegendEntries in chart legend. + + + + + Represents a collection of all the objects in the specified chart legend. + + + + + Gets the count of legend entries in collection. Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the legend entries + IChartLegendEntries legendEntries = chart.Legend.LegendEntries; + //Get the count of the legend entries + int count = legendEntries.Count; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the legend entries + Dim legendEntries As IChartLegendEntries = chart.Legend.LegendEntries + 'Get the count of the legend entries + Dim count As Integer = legendEntries.Count + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a single instance at the specified index from the collection. Read-only. + + The zero-based index of the element. + Returns the particular legend entry based on the index. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the legend entries + IChartLegendEntries legendEntries = chart.Legend.LegendEntries; + //Get the count of the legend entries + int count = legendEntries.Count; + //Set the bold style for text area + legendEntries[0].TextArea.Bold = true; + //Set the color of the text area + legendEntries[0].TextArea.Color = OfficeKnownColors.Magenta; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the legend entries + Dim legendEntries As IChartLegendEntries = chart.Legend.LegendEntries + 'Get the count of the legend entries + Dim count As Integer = legendEntries.Count + 'Set the bold style for text area + legendEntries(0).TextArea.Bold = True + 'Set the color of the text area + legendEntries(0).TextArea.Color = OfficeKnownColors.Magenta + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents global storage for legend entries. + Key - entry index; Value - legend entry. + + + + + Represents parent chart. + + + + + Creates new instance of Legend entry collection. + + Represents current application. + Parent object. + + + + Finds all parent objects. + + + + + Adds legend to collection by index. + + Represents index of new entry in collection.( Zero based ) + Returns added entry. + + + + Adds legend to collection by index. + + Represents index of new entry in collection.( Zero based ) + Represents entry to add. + Returns added entry. + + + + Checks before deleting legend entry. + + Represents index in collection. + If true - can delete; otherwise false. + + + + Updates legend entries collection after removing series. + + Index of legend entry to remove. + + + + Clones current object. + + Parent for cloned object. + Represents list with new font indexes. + Dictionary with new worksheet names. + Returns cloned object. + + + + Clears current collection. + + + + + Represents count of legend entries in collection. Read-only. + + + + + Gets legend entry object by index. Read-only. + + + + + Class used for Chart Legend entries implementation. + + + + + Represents the functionalities for IOfficeChartLegendEntry. + + + + + Clears current data point + + + + + Deletes current legend entry. + + + + + Gets or sets a value that indicates the removal of the legend entry. + + + + + Gets or sets that indicates whether the legend entry is formatted of not. + + + + + Gets object that represents a text area of the single legend entry.Read-only. + + + + + Represents LegendXN record. + + + + + Represents text of legend entry. + + + + + Represents parent chart legend entry collection. + + + + + Represents index of legend entry in collection. + + + + + Creates new instance of legend entry. + + Application object. + Parent object. + Represents index in collection + + + + Finds parent object for collection. + + + + + Clears the current data point + + + + + Deletes the current legend entry. + + + + + Clones current object. + + Parent object. + Dictionary with new font indexes. + Dictionary with new worksheet names. + Returns cloned object. + + + + If true then this entry deleted. otherwise false. + + + + + True if the legend entry has been formatted. + + + + + Returns text area. Read-only. + + + + + Legend-entry index. + + + + + Represents index in collection. + + + + + Represents ChartLegend. + + + + + Represents the legend in a chart. Each chart can have only one legend. + + + + + Clears chart legend. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the chart legend + IOfficeChartLegend legend = chart.Legend; + //Set the legend border format + legend.FrameFormat.Border.AutoFormat = false; + //Set the legend border auto line color + legend.FrameFormat.Border.IsAutoLineColor = false; + //Set the border line color + legend.FrameFormat.Border.LineColor = Color.Blue; + //Set the border line pattern + legend.FrameFormat.Border.LinePattern = OfficeChartLinePattern.DashDot; + //Set the legend border line weight + legend.FrameFormat.Border.LineWeight = OfficeChartLineWeight.Wide; + //Reset the legend format + legend.Clear(); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the chart legend + Dim legend As IOfficeChartLegend = chart.Legend + 'Set the legend border format + legend.FrameFormat.Border.AutoFormat = False + 'Set the legend border auto line color + legend.FrameFormat.Border.IsAutoLineColor = False + 'Set the border line color + legend.FrameFormat.Border.LineColor = Color.Blue + 'Set the border line pattern + legend.FrameFormat.Border.LinePattern = OfficeChartLinePattern.DashDot + 'Set the legend border line weight + legend.FrameFormat.Border.LineWeight = OfficeChartLineWeight.Wide + 'Reset the legend format + legend.Clear() + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Deletes chart legend. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the chart legend + IOfficeChartLegend legend = chart.Legend; + //Delete the chart's legend + legend.Delete(); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the chart legend + Dim legend As IOfficeChartLegend = chart.Legend + 'Delete the chart's legend + legend.Delete() + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the object that represents the formatting settings of the legend.Read-only. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IPresentationChart chart = presentation.Slides[0].Charts[0] as IPresentationChart; + //Get the chart legend + IOfficeChartLegend legend = chart.Legend; + //Set the legend border format + legend.FrameFormat.Border.AutoFormat = false; + //Set the legend border auto line color + legend.FrameFormat.Border.IsAutoLineColor = false; + //Set the border line color + legend.FrameFormat.Border.LineColor = System.Drawing.Color.Blue; + //Set the border line pattern + legend.FrameFormat.Border.LinePattern = OfficeChartLinePattern.DashDot; + //Set the legend border line weight + legend.FrameFormat.Border.LineWeight = OfficeChartLineWeight.Wide; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IPresentationChart = TryCast(presentation__1.Slides(0).Charts(0), IPresentationChart) + 'Get the chart legend + Dim legend As IOfficeChartLegend = chart.Legend + 'Set the legend border format + legend.FrameFormat.Border.AutoFormat = False + 'Set the legend border auto line color + legend.FrameFormat.Border.IsAutoLineColor = False + 'Set the border line color + legend.FrameFormat.Border.LineColor = System.Drawing.Color.Blue + 'Set the border line pattern + legend.FrameFormat.Border.LinePattern = OfficeChartLinePattern.DashDot + 'Set the legend border line weight + legend.FrameFormat.Border.LineWeight = OfficeChartLineWeight.Wide + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets object that represents a text area of the legend.Read-only. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IPresentationChart chart = presentation.Slides[0].Charts[0] as IPresentationChart; + //Get the chart legend + IOfficeChartLegend legend = chart.Legend; + //Set the text area font weight + legend.TextArea.Bold = true; + //Set the legend text area forecolor + legend.TextArea.Color = OfficeKnownColors.Sky_blue; + //Set the legend text area font name + legend.TextArea.FontName = "Times New Roman"; + //Set the legend text area font size + legend.TextArea.Size = 15; + //Set the legend text area' strike through + legend.TextArea.Strikethrough = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IPresentationChart = TryCast(presentation__1.Slides(0).Charts(0), IPresentationChart) + 'Get the chart legend + Dim legend As IOfficeChartLegend = chart.Legend + 'Set the text area font weight + legend.TextArea.Bold = True + 'Set the legend text area forecolor + legend.TextArea.Color = OfficeKnownColors.Sky_blue + 'Set the legend text area font name + legend.TextArea.FontName = "Times New Roman" + 'Set the legend text area font size + legend.TextArea.Size = 15 + 'Set the legend text area' strike through + legend.TextArea.Strikethrough = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets X-position of upper-left corner. 1/4000 of chart plot. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IPresentationChart chart = presentation.Slides[0].Charts[0] as IPresentationChart; + //Get the chart legend + IOfficeChartLegend legend = chart.Legend; + //Set the legend position + legend.Position = OfficeLegendPosition.Top; + //Set the position of legend + legend.X = 120; + legend.Y = 25; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IPresentationChart = TryCast(presentation__1.Slides(0).Charts(0), IPresentationChart) + 'Get the chart legend + Dim legend As IOfficeChartLegend = chart.Legend + 'Set the legend position + legend.Position = OfficeLegendPosition.Top + 'Set the position of legend + legend.X = 120 + legend.Y = 25 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets Y-position of upper-left corner. 1/4000 of chart plot. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IPresentationChart chart = presentation.Slides[0].Charts[0] as IPresentationChart; + //Get the chart legend + IOfficeChartLegend legend = chart.Legend; + //Set the legend position + legend.Position = OfficeLegendPosition.Top; + //Set the position of legend + legend.X = 120; + legend.Y = 25; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IPresentationChart = TryCast(presentation__1.Slides(0).Charts(0), IPresentationChart) + 'Get the chart legend + Dim legend As IOfficeChartLegend = chart.Legend + 'Set the legend position + legend.Position = OfficeLegendPosition.Top + 'Set the position of legend + legend.X = 120 + legend.Y = 25 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the position of the legend on the chart + Type: + 0 = bottom + 1 = corner + 2 = top + 3 = right + 4 = left + 7 = not docked or inside the plot area + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IPresentationChart chart = presentation.Slides[0].Charts[0] as IPresentationChart; + //Get the chart legend + IOfficeChartLegend legend = chart.Legend; + //Set the legend position + legend.Position = OfficeLegendPosition.Left; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IPresentationChart = TryCast(presentation__1.Slides(0).Charts(0), IPresentationChart) + 'Get the chart legend + Dim legend As IOfficeChartLegend = chart.Legend + 'Set the legend position + legend.Position = OfficeLegendPosition.Left + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets whether the legend is vertical. + True if vertical legend (a single column of entries); + False if horizontal legend (multiple columns of entries). + Manual-sized legends always have this bit set to False. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IPresentationChart chart = presentation.Slides[0].Charts[0] as IPresentationChart; + //Get the chart legend + IOfficeChartLegend legend = chart.Legend; + //Set the legend position + legend.Position = OfficeLegendPosition.Left; + //Enable the vertical legend + legend.IsVerticalLegend = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IPresentationChart = TryCast(presentation__1.Slides(0).Charts(0), IPresentationChart) + 'Get the chart legend + Dim legend As IOfficeChartLegend = chart.Legend + 'Set the legend position + legend.Position = OfficeLegendPosition.Left + 'Enable the vertical legend + legend.IsVerticalLegend = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets legend entries collection. Read-only. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IPresentationChart chart = presentation.Slides[0].Charts[0] as IPresentationChart; + //Get the chart legend + IOfficeChartLegend legend = chart.Legend; + //Set the text area font weight + legend.TextArea.Bold = true; + //Set the legend text area forecolor + legend.TextArea.Color = OfficeKnownColors.Sky_blue; + //Set the legend text area font name + legend.TextArea.FontName = "Times New Roman"; + //Set the legend text area font size + legend.TextArea.Size = 15; + //Modify the legend entry + legend.LegendEntries[0].IsDeleted = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IPresentationChart = TryCast(presentation__1.Slides(0).Charts(0), IPresentationChart) + 'Get the chart legend + Dim legend As IOfficeChartLegend = chart.Legend + 'Set the text area font weight + legend.TextArea.Bold = True + 'Set the legend text area forecolor + legend.TextArea.Color = OfficeKnownColors.Sky_blue + 'Set the legend text area font name + legend.TextArea.FontName = "Times New Roman" + 'Set the legend text area font size + legend.TextArea.Size = 15 + 'Modify the legend entry + legend.LegendEntries(0).IsDeleted = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that indicates the legends are overlapping with chart space or not. Default is true. + + Trueif a legend will occupy the chart layout space when a chart layout is being determined.Otherwise False + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IPresentationChart chart = presentation.Slides[0].Charts[0] as IPresentationChart; + //Get the chart legend + IOfficeChartLegend legend = chart.Legend; + //Set the layout inclusion + legend.IncludeInLayout = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IPresentationChart = TryCast(presentation__1.Slides(0).Charts(0), IPresentationChart) + 'Get the chart legend + Dim legend As IOfficeChartLegend = chart.Legend + 'Set the layout inclusion + legend.IncludeInLayout = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the Layout settings of TextArea + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IPresentationChart chart = presentation.Slides[0].Charts[0] as IPresentationChart; + //Get the chart legend + IOfficeChartLegend legend = chart.Legend; + //Modify the legend layout height + legend.Layout.Height = 100; + //Modify the legend layout height mode + legend.Layout.HeightMode = LayoutModes.factor; + //Modify the legend layout left position + legend.Layout.Left = 100; + //Modify the legend layout left mode + legend.Layout.LeftMode = LayoutModes.factor; + //Modify the legend layout top position + legend.Layout.Top = 100; + //Modify the legend layout top mode + legend.Layout.TopMode = LayoutModes.factor; + //Modify the legend layout width + legend.Layout.Width = 150; + //Modify the legend layout width mode + legend.Layout.WidthMode = LayoutModes.factor; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IPresentationChart = TryCast(presentation__1.Slides(0).Charts(0), IPresentationChart) + 'Get the chart legend + Dim legend As IOfficeChartLegend = chart.Legend + 'Modify the legend layout height + legend.Layout.Height = 100 + 'Modify the legend layout height mode + legend.Layout.HeightMode = LayoutModes.factor + 'Modify the legend layout left position + legend.Layout.Left = 100 + 'Modify the legend layout left mode + legend.Layout.LeftMode = LayoutModes.factor + 'Modify the legend layout top position + legend.Layout.Top = 100 + 'Modify the legend layout top mode + legend.Layout.TopMode = LayoutModes.factor + 'Modify the legend layout width + legend.Layout.Width = 150 + 'Modify the legend layout width mode + legend.Layout.WidthMode = LayoutModes.factor + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents top-left position in pos record. + + + + + Represents chart legend record. + + + + + Represents chart pos record. + + + + + Attached label layout + + + + + Represents chart text record and sub records. + + + + + Represents legend frame format. + + + + + Show legend without overlapping. Default is True. + + + + + Represents parent chart. + + + + + Represents collection of legend entries. + + + + + Represents Excel 2007 layout data + + + + + Represents the TextArea Paragraph + + + + + Represents the legend text properties stream + + + + + Represents the default ChartTextArea settings + + + + + Represents the default ChartTextArea settings + + + + + Creates new instance. + + Current application. + Parent object. + + + + Finds all parent objects. + + + + + Clones current object. + + Parent object. + Array with new font indexes. + Dictionary with new worksheet names. + Returns cloned object. + + + + Clears the chart legend. + + + + + Deletes the chart legend. + + + + + Sets to default position + + + + + Sets legend to custom position. + + + + + Represents chart frame format. + + + + + Return text area of legend. + + + + + Show legend without overlapping. Default is True. + + + + + X-position of upper-left corner. 1/4000 of chart plot. + + + + + Y-position of upper-left corner. 1/4000 of chart plot. + + + + + Type: + 0 = bottom + 1 = corner + 2 = top + 3 = right + 4 = left + 7 = not docked or inside the plot area + + + + + True if vertical legend (a single column of entries); + False if horizontal legend (multiple columns of entries). + Manual-sized legends always have this bit set to False. + + + + + Represents legend entries collection. Read-only. + + + + + Represents the Default ChartTextArea Settings + + + + + Gets or Sets the value indicating whether the ChartTextArea settings are applied from the chart default text settings. + + + + + X-size. + + + + + Y-size. + + + + + True if chart contains data table. + + + + + Spacing: + 0 = close + 1 = medium + 2 = open + + + + + Automatic positioning (True if legend is docked). + + + + + Automatic series distribution (True in Microsoft Excel 5.0). + + + + + X positioning is automatic. + + + + + Y positioning is automatic. + + + + + Gets / sets Excel 2007 layout data + + + + + Represents the Legend Paragraph + + + + + Return attached label layout record. Read-only + + + + + Returns legend record. Read-only. + + + + + Returns position record. Read-only. + + + + + Class used for setting chart elements layout manually + + + + + Represents the manual layout of the chart element. + + + + + Specifies whether to layout only the plot area + + + + + Specifies how to interpret the Left element for this manual layout + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IOfficeChart chart = presentation.Slides[0].Charts[0] as IOfficeChart; + //Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top; + //Get the legend layout + IOfficeChartLayout layout = chart.Legend.Layout; + //Get the manual layout + IOfficeChartManualLayout manualLayout = layout.ManualLayout; + //Modify the manual layout left position + manualLayout.Left = 100; + //Modify the manual layout left mode + manualLayout.LeftMode = LayoutModes.factor; + //Modify the manual layout top position + manualLayout.Top = 100; + //Modify the manual layout top mode + manualLayout.TopMode = LayoutModes.factor; + //Modify the manual layout height + manualLayout.Height = 120; + //Modify the manual layout height mode + manualLayout.HeightMode = LayoutModes.factor; + //Modify the manual layout width + manualLayout.Width = 100; + //Modify the manual layout width mode + manualLayout.WidthMode = LayoutModes.edge; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IOfficeChart = TryCast(presentation__1.Slides(0).Charts(0), IOfficeChart) + 'Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top + 'Get the legend layout + Dim layout As IOfficeChartLayout = chart.Legend.Layout + 'Get the manual layout + Dim manualLayout As IOfficeChartManualLayout = layout.ManualLayout + 'Modify the manual layout left position + manualLayout.Left = 100 + 'Modify the manual layout left mode + manualLayout.LeftMode = LayoutModes.factor + 'Modify the manual layout top position + manualLayout.Top = 100 + 'Modify the manual layout top mode + manualLayout.TopMode = LayoutModes.factor + 'Modify the manual layout height + manualLayout.Height = 120 + 'Modify the manual layout height mode + manualLayout.HeightMode = LayoutModes.factor + 'Modify the manual layout width + manualLayout.Width = 100 + 'Modify the manual layout width mode + manualLayout.WidthMode = LayoutModes.edge + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Specifies how to interpret the Top element for this manual layout. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IOfficeChart chart = presentation.Slides[0].Charts[0] as IOfficeChart; + //Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top; + //Get the legend layout + IOfficeChartLayout layout = chart.Legend.Layout; + //Get the manual layout + IOfficeChartManualLayout manualLayout = layout.ManualLayout; + //Modify the manual layout left position + manualLayout.Left = 100; + //Modify the manual layout left mode + manualLayout.LeftMode = LayoutModes.factor; + //Modify the manual layout top position + manualLayout.Top = 100; + //Modify the manual layout top mode + manualLayout.TopMode = LayoutModes.factor; + //Modify the manual layout height + manualLayout.Height = 120; + //Modify the manual layout height mode + manualLayout.HeightMode = LayoutModes.factor; + //Modify the manual layout width + manualLayout.Width = 100; + //Modify the manual layout width mode + manualLayout.WidthMode = LayoutModes.edge; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IOfficeChart = TryCast(presentation__1.Slides(0).Charts(0), IOfficeChart) + 'Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top + 'Get the legend layout + Dim layout As IOfficeChartLayout = chart.Legend.Layout + 'Get the manual layout + Dim manualLayout As IOfficeChartManualLayout = layout.ManualLayout + 'Modify the manual layout left position + manualLayout.Left = 100 + 'Modify the manual layout left mode + manualLayout.LeftMode = LayoutModes.factor + 'Modify the manual layout top position + manualLayout.Top = 100 + 'Modify the manual layout top mode + manualLayout.TopMode = LayoutModes.factor + 'Modify the manual layout height + manualLayout.Height = 120 + 'Modify the manual layout height mode + manualLayout.HeightMode = LayoutModes.factor + 'Modify the manual layout width + manualLayout.Width = 100 + 'Modify the manual layout width mode + manualLayout.WidthMode = LayoutModes.edge + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Specifies the x location (left) of the chart element as a fraction of the width of the chart. + If Left Mode is Factor, then the position is relative to the default position for the chart element. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IOfficeChart chart = presentation.Slides[0].Charts[0] as IOfficeChart; + //Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top; + //Get the legend layout + IOfficeChartLayout layout = chart.Legend.Layout; + //Get the manual layout + IOfficeChartManualLayout manualLayout = layout.ManualLayout; + //Modify the manual layout left position + manualLayout.Left = 100; + //Modify the manual layout left mode + manualLayout.LeftMode = LayoutModes.factor; + //Modify the manual layout top position + manualLayout.Top = 100; + //Modify the manual layout top mode + manualLayout.TopMode = LayoutModes.factor; + //Modify the manual layout height + manualLayout.Height = 120; + //Modify the manual layout height mode + manualLayout.HeightMode = LayoutModes.factor; + //Modify the manual layout width + manualLayout.Width = 100; + //Modify the manual layout width mode + manualLayout.WidthMode = LayoutModes.edge; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IOfficeChart = TryCast(presentation__1.Slides(0).Charts(0), IOfficeChart) + 'Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top + 'Get the legend layout + Dim layout As IOfficeChartLayout = chart.Legend.Layout + 'Get the manual layout + Dim manualLayout As IOfficeChartManualLayout = layout.ManualLayout + 'Modify the manual layout left position + manualLayout.Left = 100 + 'Modify the manual layout left mode + manualLayout.LeftMode = LayoutModes.factor + 'Modify the manual layout top position + manualLayout.Top = 100 + 'Modify the manual layout top mode + manualLayout.TopMode = LayoutModes.factor + 'Modify the manual layout height + manualLayout.Height = 120 + 'Modify the manual layout height mode + manualLayout.HeightMode = LayoutModes.factor + 'Modify the manual layout width + manualLayout.Width = 100 + 'Modify the manual layout width mode + manualLayout.WidthMode = LayoutModes.edge + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Specifies the top of the chart element as a fraction of the height of the chart. + If Top Mode is Factor, then the position is relative to the default position for the chart element. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IOfficeChart chart = presentation.Slides[0].Charts[0] as IOfficeChart; + //Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top; + //Get the legend layout + IOfficeChartLayout layout = chart.Legend.Layout; + //Get the manual layout + IOfficeChartManualLayout manualLayout = layout.ManualLayout; + //Modify the manual layout left position + manualLayout.Left = 100; + //Modify the manual layout left mode + manualLayout.LeftMode = LayoutModes.factor; + //Modify the manual layout top position + manualLayout.Top = 100; + //Modify the manual layout top mode + manualLayout.TopMode = LayoutModes.factor; + //Modify the manual layout height + manualLayout.Height = 120; + //Modify the manual layout height mode + manualLayout.HeightMode = LayoutModes.factor; + //Modify the manual layout width + manualLayout.Width = 100; + //Modify the manual layout width mode + manualLayout.WidthMode = LayoutModes.edge; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IOfficeChart = TryCast(presentation__1.Slides(0).Charts(0), IOfficeChart) + 'Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top + 'Get the legend layout + Dim layout As IOfficeChartLayout = chart.Legend.Layout + 'Get the manual layout + Dim manualLayout As IOfficeChartManualLayout = layout.ManualLayout + 'Modify the manual layout left position + manualLayout.Left = 100 + 'Modify the manual layout left mode + manualLayout.LeftMode = LayoutModes.factor + 'Modify the manual layout top position + manualLayout.Top = 100 + 'Modify the manual layout top mode + manualLayout.TopMode = LayoutModes.factor + 'Modify the manual layout height + manualLayout.Height = 120 + 'Modify the manual layout height mode + manualLayout.HeightMode = LayoutModes.factor + 'Modify the manual layout width + manualLayout.Width = 100 + 'Modify the manual layout width mode + manualLayout.WidthMode = LayoutModes.edge + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Specifies how to interpret the Width element for this manual layout. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IOfficeChart chart = presentation.Slides[0].Charts[0] as IOfficeChart; + //Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top; + //Get the legend layout + IOfficeChartLayout layout = chart.Legend.Layout; + //Get the manual layout + IOfficeChartManualLayout manualLayout = layout.ManualLayout; + //Modify the manual layout left position + manualLayout.Left = 100; + //Modify the manual layout left mode + manualLayout.LeftMode = LayoutModes.factor; + //Modify the manual layout top position + manualLayout.Top = 100; + //Modify the manual layout top mode + manualLayout.TopMode = LayoutModes.factor; + //Modify the manual layout height + manualLayout.Height = 120; + //Modify the manual layout height mode + manualLayout.HeightMode = LayoutModes.factor; + //Modify the manual layout width + manualLayout.Width = 100; + //Modify the manual layout width mode + manualLayout.WidthMode = LayoutModes.edge; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IOfficeChart = TryCast(presentation__1.Slides(0).Charts(0), IOfficeChart) + 'Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top + 'Get the legend layout + Dim layout As IOfficeChartLayout = chart.Legend.Layout + 'Get the manual layout + Dim manualLayout As IOfficeChartManualLayout = layout.ManualLayout + 'Modify the manual layout left position + manualLayout.Left = 100 + 'Modify the manual layout left mode + manualLayout.LeftMode = LayoutModes.factor + 'Modify the manual layout top position + manualLayout.Top = 100 + 'Modify the manual layout top mode + manualLayout.TopMode = LayoutModes.factor + 'Modify the manual layout height + manualLayout.Height = 120 + 'Modify the manual layout height mode + manualLayout.HeightMode = LayoutModes.factor + 'Modify the manual layout width + manualLayout.Width = 100 + 'Modify the manual layout width mode + manualLayout.WidthMode = LayoutModes.edge + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Specifies how to interpret the Height element for this manual layout. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IOfficeChart chart = presentation.Slides[0].Charts[0] as IOfficeChart; + //Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top; + //Get the legend layout + IOfficeChartLayout layout = chart.Legend.Layout; + //Get the manual layout + IOfficeChartManualLayout manualLayout = layout.ManualLayout; + //Modify the manual layout left position + manualLayout.Left = 100; + //Modify the manual layout left mode + manualLayout.LeftMode = LayoutModes.factor; + //Modify the manual layout top position + manualLayout.Top = 100; + //Modify the manual layout top mode + manualLayout.TopMode = LayoutModes.factor; + //Modify the manual layout height + manualLayout.Height = 120; + //Modify the manual layout height mode + manualLayout.HeightMode = LayoutModes.factor; + //Modify the manual layout width + manualLayout.Width = 100; + //Modify the manual layout width mode + manualLayout.WidthMode = LayoutModes.edge; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IOfficeChart = TryCast(presentation__1.Slides(0).Charts(0), IOfficeChart) + 'Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top + 'Get the legend layout + Dim layout As IOfficeChartLayout = chart.Legend.Layout + 'Get the manual layout + Dim manualLayout As IOfficeChartManualLayout = layout.ManualLayout + 'Modify the manual layout left position + manualLayout.Left = 100 + 'Modify the manual layout left mode + manualLayout.LeftMode = LayoutModes.factor + 'Modify the manual layout top position + manualLayout.Top = 100 + 'Modify the manual layout top mode + manualLayout.TopMode = LayoutModes.factor + 'Modify the manual layout height + manualLayout.Height = 120 + 'Modify the manual layout height mode + manualLayout.HeightMode = LayoutModes.factor + 'Modify the manual layout width + manualLayout.Width = 100 + 'Modify the manual layout width mode + manualLayout.WidthMode = LayoutModes.edge + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Specifies the width (if Width Mode is Factor) or right (if Width Mode is Edge) of the chart element + as a fraction of the width of the chart. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IOfficeChart chart = presentation.Slides[0].Charts[0] as IOfficeChart; + //Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top; + //Get the legend layout + IOfficeChartLayout layout = chart.Legend.Layout; + //Get the manual layout + IOfficeChartManualLayout manualLayout = layout.ManualLayout; + //Modify the manual layout left position + manualLayout.Left = 100; + //Modify the manual layout left mode + manualLayout.LeftMode = LayoutModes.factor; + //Modify the manual layout top position + manualLayout.Top = 100; + //Modify the manual layout top mode + manualLayout.TopMode = LayoutModes.factor; + //Modify the manual layout height + manualLayout.Height = 120; + //Modify the manual layout height mode + manualLayout.HeightMode = LayoutModes.factor; + //Modify the manual layout width + manualLayout.Width = 100; + //Modify the manual layout width mode + manualLayout.WidthMode = LayoutModes.edge; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IOfficeChart = TryCast(presentation__1.Slides(0).Charts(0), IOfficeChart) + 'Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top + 'Get the legend layout + Dim layout As IOfficeChartLayout = chart.Legend.Layout + 'Get the manual layout + Dim manualLayout As IOfficeChartManualLayout = layout.ManualLayout + 'Modify the manual layout left position + manualLayout.Left = 100 + 'Modify the manual layout left mode + manualLayout.LeftMode = LayoutModes.factor + 'Modify the manual layout top position + manualLayout.Top = 100 + 'Modify the manual layout top mode + manualLayout.TopMode = LayoutModes.factor + 'Modify the manual layout height + manualLayout.Height = 120 + 'Modify the manual layout height mode + manualLayout.HeightMode = LayoutModes.factor + 'Modify the manual layout width + manualLayout.Width = 100 + 'Modify the manual layout width mode + manualLayout.WidthMode = LayoutModes.edge + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Specifies the height (if Height Mode is Factor) or bottom (if Height Mode is edge) of the chart + element as a fraction of the height of the chart. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the chart from the first slide + IOfficeChart chart = presentation.Slides[0].Charts[0] as IOfficeChart; + //Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top; + //Get the legend layout + IOfficeChartLayout layout = chart.Legend.Layout; + //Get the manual layout + IOfficeChartManualLayout manualLayout = layout.ManualLayout; + //Modify the manual layout left position + manualLayout.Left = 100; + //Modify the manual layout left mode + manualLayout.LeftMode = LayoutModes.factor; + //Modify the manual layout top position + manualLayout.Top = 100; + //Modify the manual layout top mode + manualLayout.TopMode = LayoutModes.factor; + //Modify the manual layout height + manualLayout.Height = 120; + //Modify the manual layout height mode + manualLayout.HeightMode = LayoutModes.factor; + //Modify the manual layout width + manualLayout.Width = 100; + //Modify the manual layout width mode + manualLayout.WidthMode = LayoutModes.edge; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Get the chart from the first slide + Dim chart As IOfficeChart = TryCast(presentation__1.Slides(0).Charts(0), IOfficeChart) + 'Set the legend position + chart.Legend.Position = OfficeLegendPosition.Top + 'Get the legend layout + Dim layout As IOfficeChartLayout = chart.Legend.Layout + 'Get the manual layout + Dim manualLayout As IOfficeChartManualLayout = layout.ManualLayout + 'Modify the manual layout left position + manualLayout.Left = 100 + 'Modify the manual layout left mode + manualLayout.LeftMode = LayoutModes.factor + 'Modify the manual layout top position + manualLayout.Top = 100 + 'Modify the manual layout top mode + manualLayout.TopMode = LayoutModes.factor + 'Modify the manual layout height + manualLayout.Height = 120 + 'Modify the manual layout height mode + manualLayout.HeightMode = LayoutModes.factor + 'Modify the manual layout width + manualLayout.Width = 100 + 'Modify the manual layout width mode + manualLayout.WidthMode = LayoutModes.edge + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Parent chart. + + + + /// + Parent object + + + + + byte value used as flag and boolean property for the values + + + + + Creates chart and sets its Application and Parent + properties to specified values. + + Application object for the chart. + Parent object for the chart. + + + + Creates chart and sets its Application and Parent + properties to specified values. + + Application object for the chart. + Parent object for the chart. + Indicates is auto size. + Indicates is interior is gray. + Indicates whether we should set defaults for fill and border properties. + + + + Searches for all necessary parent objects. + + + + + Return the parent object. Read-only. + + + + + Gets or sets the layout target + + + + + Gets or sets the left mode (x) value + + + + + Gets or sets the top mode (y) value + + + + + Gets or sets the left (x) value + + + + + Gets or sets the top (y) value + + + + + Gets or sets the dx value + + + + + Gets or sets the dy value + + + + + Gets or sets the Width mode + + + + + Gets or sets the Height mode + + + + + Gets or sets the Width + + + + + Gets or sets the Height + + + + + Gets or sets the xTL value + + + + + Gets or sets the yTL value + + + + + Gets or sets the xBR value + + + + + Gets or sets the yBR value + + + + + Returns the flag options for this class. + + + + + Class allows users to configure Print setting of chart. + + + + + Summary description for PageSetupBaseImpl. + + + + + Base interface for all page setups. + + + + + Returns or sets the center part of the footer. Read / write String. + + + + + Returns or sets the center part of the header. Read / write String. + + + + + Returns or sets the left part of the footer. Read / write String. + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + + + + + Returns or sets the left part of the header. Read / write String. + + + + + Portrait or landscape printing mode. Read / write OfficePageOrientation. + + + + + Returns or sets the right part of the footer. Read / write String. + + + + + Returns or sets the right part of the header. Read / write String. + + + + + Summary description for IBiffStorage. + + + + + Size of the required storage space. Read-only. + + + + + Returns type code of the biff storage. Read-only. + + + + + Returns code of the biff storage. Read-only. + + + + + Indicates whether data array is required by this record. + + + + + Indicates record position in stream. This is a utility member of class and + is used only in the serialization process. Does not influence the data. + + + + + Value of the top margin by default. + + + + + Value of the bottom margin by default. + + + + + Value of the left margin by default. + + + + + Value of the right margin by default. + + + + + Name of the shape with header image. + + + + + Name of the shape with header image. + + + + + Whether to center between horizontal margins. + + + + + Whether to center between vertical margins. + + + + + Unknown record. This record contains additional information about + system printer. If such record is found, it is stored, otherwise we is skipped. + + + + + Stores print setup options. + + + + + This record contains information about worksheet bottom margin. + + + + + This record contains information about worksheet left margin. + + + + + This record contains information about worksheet right margin. + + + + + This record contains information about worksheet top margin. + + + + + Array of headers: 0 - left header, 1 - center header, 2 - right header. + + + + + Array of footers: 0 - left footer, 1 - center footer, 2 - right footer. + + + + + Parent sheet. + + + + + Contains background image. + + + + + Indicates whether page setup is in FitTo printing mode. + + + + + Dictionary which stores Max paper width + + + + + Dictionary which stores Max paper height + + + + + Stores print setup options. + + + + + Value of the header string limit + + + + + Value of the footer string limit + + + + + Fills the dictionaries with paper width size and height size + + + + + + Sets application and parent fields. + + Application object for the page setup. + Parent object for the page setup. + + + + Find parent Worksheet. + + + Can't find parent worksheet. + + + + + This function splits header or footer into three parts left, center, and right. + + + Header (footer) string that will be split into + parts: left, center, right. + + Array of split strings. + + + + Function combines header or footer strings array to one format string. + + Array which must contain only 3 elements. + Combined format string. + + When parameter is null. + + + When number of strings in parts is not 3. + + + + + Serializes some records after main page setup block. + + OffsetArrayList to serialize into. + + + + Parses page setup. + + Array with biff records. + Starting position. + Position after parsing. + + + + Parses record. + + Record to parse. + True if record was successfully parsed, false otherwise. + + + + Returns record of the specified type from the array of Biff + records and sets its position after the returned record. + + Array of Biff records. + Starting from this position, record must be searched. + Type of the needed record. + Biff record if it was found, null otherwise. + + + + Returns current record from the Biff records array and updates its position by 1. + + Array of Biff records. + + Position of the record in the array that will be returned. + + Current record from array. + + + + Returns record of the specified type from the array of Biff + records and sets its position after the returned record. + + Array of Biff records. + Starting from this position, record must be searched. + Type of the needed record. + Biff record if it was found, null otherwise. + + + + This method is called after changes to the page setup. + Sets Saved property of the parent workbook to the False state. + + + + + Size of the required storage space. Read-only. + + + + + Indicates whether fit to page mode is selected. + + + + + Returns or sets the center part of the footer. Read / write String. + Special Formatting symbols: + &P Current page number + &N Page count + &D Current date + &T Current time + &A Sheet name (BIFF5-BIFF8) + &F File name without path + &Z File path without file name (BIFF8X) + &G Picture (BIFF8X) + &B Bold on/off (BIFF2-BIFF4) + &I Italic on/off (BIFF2-BIFF4) + &U Underlining on/off + &E Double underlining on/off (BIFF5-BIFF8) + &S Strikeout on/off + &X Superscript on/off (BIFF5-BIFF8) + &Y Subscript on/off (BIFF5-BIFF8) + &"[FONTNAME]" Set new font [FONTNAME] + &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. + The style [fontstyle] is in most cases one of Regular, Bold, Italic, + or Bold Italic. But this setting is dependent on the used font, it may + differ (localised style names, or Standard, Oblique, ...). (BIFF5-BIFF8) + &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). + If this command is followed by a plain number to be printed in the header, + it will be separated from the font height with a space character. + + + + + Returns or sets the center part of the header. Read/write String. + Special Formatting symbols: + &P Current page number + &N Page count + &D Current date + &T Current time + &A Sheet name (BIFF5-BIFF8) + &F File name without path + &Z File path without file name (BIFF8X) + &G Picture (BIFF8X) + &B Bold on/off (BIFF2-BIFF4) + &I Italic on/off (BIFF2-BIFF4) + &U Underlining on/off + &E Double underlining on/off (BIFF5-BIFF8) + &S Strikeout on/off + &X Superscript on/off (BIFF5-BIFF8) + &Y Subscript on/off (BIFF5-BIFF8) + &"[FONTNAME]" Set new font [FONTNAME] + &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. + The style [fontstyle] is in most cases one of Regular, Bold, Italic, + or Bold Italic. But this setting is dependent on the used font, it may + differ (localised style names, or Standard, Oblique, ...). (BIFF5-BIFF8) + &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). + If this command is followed by a plain number to be printed in the header, + it will be separated from the font height with a space character. + + + + + Returns or sets the left part of the footer. Read/write String. + Special Formatting symbols: + &P Current page number + &N Page count + &D Current date + &T Current time + &A Sheet name (BIFF5-BIFF8) + &F File name without path + &Z File path without file name (BIFF8X) + &G Picture (BIFF8X) + &B Bold on/off (BIFF2-BIFF4) + &I Italic on/off (BIFF2-BIFF4) + &U Underlining on/off + &E Double underlining on/off (BIFF5-BIFF8) + &S Strikeout on/off + &X Superscript on/off (BIFF5-BIFF8) + &Y Subscript on/off (BIFF5-BIFF8) + &"[FONTNAME]" Set new font [FONTNAME] + &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. + The style [fontstyle] is in most cases one of Regular, Bold, Italic, + or Bold Italic. But this setting is dependent on the used font, it may + differ (localized style names, or Standard, Oblique, ...). (BIFF5-BIFF8) + &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). + If this command is followed by a plain number to be printed in the header, + it will be separated from the font height with a space character. + + + + + Returns or sets the left part of the header. Read/write String. + Special Formatting symbols: + &P Current page number + &N Page count + &D Current date + &T Current time + &A Sheet name (BIFF5-BIFF8) + &F File name without path + &Z File path without file name (BIFF8X) + &G Picture (BIFF8X) + &B Bold on/off (BIFF2-BIFF4) + &I Italic on/off (BIFF2-BIFF4) + &U Underlining on/off + &E Double underlining on/off (BIFF5-BIFF8) + &S Strikeout on/off + &X Superscript on/off (BIFF5-BIFF8) + &Y Subscript on/off (BIFF5-BIFF8) + &"[FONTNAME]" Set new font [FONTNAME] + &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. + The style [fontstyle] is in most cases one of Regular, Bold, Italic, + or Bold Italic. But this setting is dependent on the used font, it may + differ (localised style names, or Standard, Oblique, ...). (BIFF5-BIFF8) + &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). + If this command is followed by a plain number to be printed in the header, + it will be separated from the font height with a space character. + + + + + Portrait or landscape printing mode. Read/write OfficePageOrientation. + + + + + Returns or sets the right part of the footer. Read / write String. + Special Formatting symbols: + &P Current page number + &N Page count + &D Current date + &T Current time + &A Sheet name (BIFF5-BIFF8) + &F File name without path + &Z File path without file name (BIFF8X) + &G Picture (BIFF8X) + &B Bold on/off (BIFF2-BIFF4) + &I Italic on/off (BIFF2-BIFF4) + &U Underlining on/off + &E Double underlining on/off (BIFF5-BIFF8) + &S Strikeout on/off + &X Superscript on/off (BIFF5-BIFF8) + &Y Subscript on/off (BIFF5-BIFF8) + &"[FONTNAME]" Set new font [FONTNAME] + &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. + The style [fontstyle] is in most cases one of Regular, Bold, Italic, + or Bold Italic. But this setting is dependent on the used font, it may + differ (localised style names, or Standard, Oblique, ...). (BIFF5-BIFF8) + &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). + If this command is followed by a plain number to be printed in the header, + it will be separated from the font height with a space character. + + + + + Returns or sets the right part of the header. Read / write String. + Special Formatting symbols: + &P Current page number + &N Page count + &D Current date + &T Current time + &A Sheet name (BIFF5-BIFF8) + &F File name without path + &Z File path without file name (BIFF8X) + &G Picture (BIFF8X) + &B Bold on/off (BIFF2-BIFF4) + &I Italic on/off (BIFF2-BIFF4) + &U Underlining on/off + &E Double underlining on/off (BIFF5-BIFF8) + &S Strikeout on/off + &X Superscript on/off (BIFF5-BIFF8) + &Y Subscript on/off (BIFF5-BIFF8) + &"[FONTNAME]" Set new font [FONTNAME] + &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. + The style [fontstyle] is in most cases one of Regular, Bold, Italic, + or Bold Italic. But this setting is dependent on the used font, it may + differ (localised style names, or Standard, Oblique, ...). (BIFF5-BIFF8) + &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). + If this command is followed by a plain number to be printed in the header, + it will be separated from the font height with a space character. + + + + + Represents full header string. Read/write. + + + + + Gets footer full string. Read/write. + + + + + Returns type code of the biff storage. Read-only. + + + + + Returns code of the biff storage. Read-only. + + + + + Indicates whether data array is required by this record. + + + + + Indicates record position in stream. This is a utility member of class and + is used only in the serialization process. Does not influence the data. + + + + + Set indexes as constants. + + + + + Left part of header or footer formatting. + + + + + Center part of header or footer formatting. + + + + + Right part of header or footer formatting. + + + + + This class contains size of the paper. + + + + + Paper width in points. + + + + + Paper height in points. + + + + + Default constructor. To prevent creation without arguments. + + + + + Initializes new instance of paper size entry. + + Paper width. + Paper height. + Units in which width and height are set. + + + + Represents the page setup description. The PageSetup object + contains all page setup attributes (left margin, bottom margin, + paper size, and so on) as properties. + + + + + Returns or sets the number of pages tall the worksheet will be scaled + to when it is printed. Applies only to worksheets. Read / write Boolean. + + + + + Returns or sets the number of pages wide the worksheet will be scaled + to when it is printed. Applies only to worksheets. Read / write Boolean. + + + + + Informs how chart should be printed. + + + + + Sets application and parent fields. + + Application object for the page setup. + Parent object for the page setup. + + + + Recovers Page setup from the Biff Records list starting from position. + + Application object for the page setup. + Parent object for the page setup. + List which contains Biff Records. + Position of PrintHeadersRecord in the array. + + + + Parses record. + + Record to parse. + True if record was successfully parsed, false otherwise. + + + + Serializes some records after main page setup block. + + OffsetArrayList to serialize into. + + + + Clone current Record. + + Parent object for create new instance. + Returns clone of current object. + + + + Returns or sets the number of pages tall the worksheet will be scaled + to when it is printed. Applies only to worksheets. Read / write Boolean. + + + + + Returns or sets the number of pages wide the worksheet will be scaled + to when it is printed. Applies only to worksheets. Read / write Boolean. + + + + + Represents ChartParentAxis record and subrecords. + + + + + Represents chartAxisParent record. + + + + + Represents chart pos record. + + + + + Represents chart category axis. + + + + + Represents Chart value axis. + + + + + Represents Chart series axis. + + + + + Represents parent chart. + + + + + Represents formats coll. + + + + + Creates new instance of chart parent axis. + + Application object. + Parent object. + + + + Creates new instance of chart parent axis. + + Application object. + Parent object. + If true - creates primary axis; otherwise - secondary. + + + + Finds all parent objects. + + + + + Creates global format collection. + + + + + Using for creating secondary axis in Series type change. + + Value indicating whether to create new axis. + + + + Clones current object. + + Parent object. + Dictionary with new font indexes. + Dictionary with new sheet names. + Returns cloned object. + + + + Clears all walls, floor, gridLines. + + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Returns collection that contain chart format. Read-only. + + + + + If true this axis is primary axis; otherwise false. Read-only. + + + + + Gets or sets ChartCategoryAxis. + + + + + Gets or sets the value axis. + + + + + Gets or sets series axis. + + + + + Returns parent chart. Read-only. + + + + + Represents formats collection. Read-only. + + + + + Represents chart plot area object. + + + + + Represents chart plot area record. + + + + + Represents Excel 2007 layout data + + + + + Creates new instance. + + Represents current application + Represents parent object. + + + + Creates new instance. + + Represents current application + Represents parent object. + Represents chart type. + + + + Gets or sets Excel 2007 layout data + + + + + Represents rich text string in the workbook. + + + + + Represents a Rich Text String that can be used to apply several styles inside a single cell. + + + + + Sets font for range of characters. + + First character of the range. + Last character of the range. + Font to set. + + + + Gets font for the specified formatting run. + + Formatting run to return its font + + + + Returns the entire text value + + + + + Gets the formatting runs of rich-text + + + + + Low level text object. + + + + + Parent workbook. + + + + + Indicates whether string is read-only. + + + + + Represents the parent object + + + + + Represents the chart text area + + + + + Initializes new instance of the RichTextString. + + Application object for the RichTextString. + Parent object for the RichTextString. + + + + Searches for all necessary parent objects. + + + + + Sets font for range of characters. + + First character of the range. + Last character of the range. + Font to set. + + + + Gets font for the specified formatting run. + + Formatting run to return its font + + + + Adds font to all required collections.. + + Font to add. + Font index in the collection. + + + + Gets the formatting runs of rich-text + + + + + Gets or sets the chart text area + + + + + Gets the text + + + + + Returns parent object. Read-only. + + + + + Returns parent application object. Read-only. + + + + + ChartSerieDataFormatImpl class. + + + + + Summary description for IOfficeChartSerieDataFormat. + + + + + Gets the object, that represents area of the series. Read-only. + + + + + Gets or sets type that represents base of the shape. + + + + + Gets or sets type that represents top of the shape. + + + + + Get or set Background color: RGB value (high byte = 0) to the marker. + + + + + Gets or sets Foreground color: RGB value (high byte = 0) to the marker. + + + + + Gets or sets type of the marker. + + + + + Gets or sets the marker foreground color as an index into the current color palette. + + + + + Get or sets the marker background color as an index into the current color palette. + + + + + Gets or sets the data-marker size, in points. + + + + + Gets or set a value that indicates whether the marker has auto or custom. + + Trueif marker has auto.Otherwise False. + + + + Gets or sets a value that represents Distance of pie slice from center of pie. + + This property is only for pie chart. + + + + Gets or sets a value that indicates whether to draw bubbles with 3D effects. + + Trueto draw bubbles with 3D effects.Otherwise False. + + + + Gets the object, that represents common formatting settings of the series. Read-only. + + + + + Gets or sets a value that Indicates whether marker is supported by this chart/series. + + Trueif supported.Otherwise False + + + + Gets / Sets the Display label position in Tree map chart + + By Default the Label is overlapped + + + + Gets / Sets a boolean value indicating whether to display + Connector Lines between data points + + Applies only to Waterfall Charts + + + + Gets or sets a value indicating whether a line chart is smoothed or not. The default value is False. + /// + + This property is applicable only for line and scatter charts. + + + + + Gets / Sets a boolean value indicating whether to display + Mean Line in Box and Whisker chart + + + + + Gets / Sets a boolean value indicating whether to display + Mean Marker in Box and Whisker chart + + + + + Gets / Sets a boolean value indicating whether to display + Inner Points in Box and Whisker chart + + + + + Gets / Sets a boolean value indicating whether to display + Outlier Points in Box and Whisker chart + + + + + Gets / Sets whether the Quartile calculation is Exclusive or Inclusive + + Applies only to Box and Whisker Charts + + + + Represents None color index. + + + + + Represents marker size mull prefix. + + + + + Represents start color. + + + + + Represents start pie type. + + + + + Represents start doughnut type. + + + + + Represents start surface type. + + + + + Represents start line type. + + + + + Represents start scatter type. + + + + + Represents default line size in marker record. + + + + + Represents default line size in marker record. + + + + + Represents default line color. + + + + + Represents default index for marker record. + + + + + Represents default color in marker record. + + + + + Represents types of chart that support data format properties. + + + + + Main series data format record. + + + + + 3-D data format. + + + + + Pie format. + + + + + Represents the 3D features + + + + + Represents the Chart Shadow + + + + + Marker format. + + + + + Attached label. + + + + + Represents the beginning of a collection of records + + + + + Represents the shape formatting properties for chart elements + + + + + Represents the end of a collection of records + + + + + Attached label layout + + + + + Series format. + + + + + Represents default data point. + + + + + Parent series. + + + + + Parent chart format. + + + + + Parent chart. + + + + + Represents border. + + + + + Represents chart area properties. + + + + + Represents if DataFormat is Formatted. + + + + + Represents fill properties. + + + + + Used to store the border width value for the marker + Default value is 0.75 + + + + + Object that holds marker background color. + + + + + Object that holds marker foreground color. + + + + + Preserved marker gradient data. + + + + + Represents whether the marker properties exists or not + + + + + Represents whether the data point is parsed or not + + + + + Represents whether the data point color is parsed or not + + + + + Represents whether the MarkerColor is changed or not + + + + + Represents whether the connector lines shown between data points + Used only in waterfall Chart + + + + + It represents the label position in tree map chart + + + + + Object that holds the information required for Box and whisker series + + + + + Object that holds the information required for Histogram series + + + + + + Creates series and set its Application and Parent + properties to specified values. + + Application object for the chart. + Parent object for the chart. + + + + Initializes marker color variables. + + + + + Searches for all necessary parents. + + + + + Sets 3D data format to the default state. + + + + + Set the default values for the records related to serie formats + + + + + Clone current instance. + + Parent object. + Return cloned object. + + + + Copy the Back and Fore ground color objects from the seriedataformat + + + + + + Updates Series index. + + + + + Changes data format to create radar chart. + + Type to change. + + + + Changes data format to create scatter chart. + + Type to change. + + + + Changes data format to create line chart. + + Type to change. + + + + Updates bar column properties in series and chartformat points. + + If true updates data format top property; otherwise data format base. + + + + Updates line color for line, radar, skater Series data format. + + Returns updated color index or -1. + + + + Updates color for line, markers and series. + + Represents series to update color. + Represents data point to update color. + Returns updated color index. + + + + Updates series formats for chartformat object. + + + + + Clears sub data formats on property change. + + + + + Validate marker properties. + + If true than marker properties valid for this chart type; otherwise false. + + + + Indicates whether interior object is supported. Read-only. + + Chart type to check whether interior object is supported. + Value indicating whether interior object is supported. + + + + Indicates whether border object is supported. Read-only. + + Chart type to check whether border is supported. + Vale indicating whether border is supported. + + + + Event handler for marker foreground color change. + + + + + Event handler for marker background color change. + + + + + Gets or sets the value indicating whether line properties are created. + + + + + Gets a value indicating whether this instance has shadow properties. + + + true if this instance has shadow properties; otherwise, false. + + + + + Gets the chart3 D options. + + The chart3 D options. + + + + This property Indicates whether the Shadow object has been created(which includes the 3D properties) + + + + + Gets or sets the value indicating whether interior object was created. + + + + + Returns object, that represents line properties. Read-only. + + + + + Returns object, that represents area properties. Read-only. + + + + + Represents the base data format. + + + + + Represents the top data format. + + + + + Foreground color: RGB value (high byte = 0). + + + + + Background color: RGB value (high byte = 0). + + + + + Type of marker. + + + + + Index to color of marker border. + + + + + Index to color of marker fill. + + + + + Size of markers. + + + + + Automatic color. + + + + + Distance of pie slice from center of pie. + + + + + True if the line series has a smoothed line. + + + + + True to draw bubbles with 3D effects. + + + + + Represents fill options. Read-only. + + + + + Gets value indicating whether chart supports transparency. + + + + + Gets common Series options. Read-only. + + + + + Indicates whether marker is supported by this chart/series. + + + + + Returns object, that represents area properties. Read-only. + + + + + Indicates whether interior object is supported. Read-only. + + + + + Indicates whether border object is supported. Read-only. + + + + + Indicates whether the marker properties exists or not + + + + + Gets / Sets the line width of the marker + Stored on parsing only for Chart to Image Conversion + + + + + Returns parent Series. Read-only. + + + + + Returns data format main record. + + + + + Returns pie format record. Read-only. + + + + + Returns marker format main record. Read-only. + + + + + Returns 3dData format main record. Read-only. + + + + + Returns Series format main record. Read-only. + + + + + Returns attached label record. Read-only. + + + + + If line not null - returns true; otherwise - false. Read-only. + + + + + If marker is not null returns marker format main record otherwise null. Read-only. + + + + + If 3dData not Null returns 3DData format main record; otherwise - returns null. Read-only. + + + + + if SerieFormat not Null returns Series format main record; otherwise - returns null. Read-only. + + + + + Returns pie format or null. Read-only. + + + + + Gets or sets Series number. + + + + + If true - format has marker; otherwise false. Read-only. + + + + + If true - format has line; otherwise false. Read-only. + + + + + If true - format has smoothed line; otherwise false. Read-only. + + + + + Gets Series type. Read-only. + + + + + Indicate if data format is formatted. + + + + + Represents parent chart. Read-only. + + + + + Gets object that holds marker background color. + + + + + Gets object that holds marker foreground color. + + + + + Gets or sets the transparency of the line marker. + + The transparency. + + + + Gets or sets whether the data point is parsed or not. + If parsed, it will be serialized. + + + + + Gets or sets whether the data point color is parsed or not. + If parsed, it will be serialized. + + + + + Indicates whether the MarkerColor is changed or not. + + + + + Indicates whether the default properties are exist or not. + + + + + Represents foreground color. + + + + + Represents background color. + + + + + Represents pattern. + + + + + Indicates, if automatic format is used for area. + + + + + Represents visibility. + + + + + Gets/ Sets the histogram axis format property for individual series + + + + + Gets or sets a boolean value indicating whether to display + Connector Lines between data points + + Applies only to Waterfall Charts + + + + Gets / Sets the Display label position in Tree map chart + + By Default the Label is overlapped + + + + Gets or sets a boolean value indicating whether to display + Mean Line in Box and Whisker chart + + + + + Gets or sets a boolean value indicating whether to display + Mean Marker in Box and Whisker chart + + + + + Gets or sets a boolean value indicating whether to display + Inner Points in Box and Whisker chart + + + + + Gets or sets a boolean value indicating whether to display + Outlier Points in Box and Whisker chart + + + + + Gets / Sets whether the Quartile calculation is Exclusive or Inclusive + + Applies only to Box and Whisker Charts + + + + Get or Set the isBinning by Category member value + + + + + Get or Set the number of Bins member value + + + + + Get or Set the Bin width member value + + + + + Get or Set the overflow bin member value + + + + + Get or Set the underflow bin member value + + + + + Get or Set the value for interval is closed in left or right + + + + + This class represents ChartSeries object. + + + + + Represents a series in a chart. + + + + + Creates error bar for the series. + + If true - on Y axis; otherwise on X axis. + Returns error bar object of the series. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line; + //Add error bars to series + serieJan.ErrorBar(true); + serieFeb.ErrorBar(false); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line + 'Add error bars to series + serieJan.ErrorBar(True) + serieFeb.ErrorBar(False) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Creates error bar for the series. + + If true - on Y axis; otherwise on X axis. + Represents include type. + Return error bar object of the series. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line; + //Add error bars to series + serieJan.ErrorBar(true,OfficeErrorBarInclude.Both); + serieFeb.ErrorBar(false,OfficeErrorBarInclude.Minus); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line + 'Add error bars to series + serieJan.ErrorBar(True, OfficeErrorBarInclude.Both) + serieFeb.ErrorBar(False, OfficeErrorBarInclude.Minus) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Creates error bar for the series. + + If true - on Y axis; otherwise on X axis. + Represents include type. + Represents error bar type. + Return error bar object. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line; + //Add error bars to series + serieJan.ErrorBar(true, OfficeErrorBarInclude.Both, OfficeErrorBarType.StandardDeviation); + serieFeb.ErrorBar(false, OfficeErrorBarInclude.Plus, OfficeErrorBarType.StandardError); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line + 'Add error bars to series + serieJan.ErrorBar(True, OfficeErrorBarInclude.Both, OfficeErrorBarType.StandardDeviation) + serieFeb.ErrorBar(False, OfficeErrorBarInclude.Plus, OfficeErrorBarType.StandardError) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Creates error bar for the series. + + If true - on Y axis; otherwise on X axis. + Represents include type. + Represents error bar type. + Represents number value. + Return error bar object. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line; + //Add error bars to series + serieJan.ErrorBar(true, OfficeErrorBarInclude.Both, OfficeErrorBarType.StandardDeviation, 12.34); + serieFeb.ErrorBar(false, OfficeErrorBarInclude.Plus, OfficeErrorBarType.StandardError, 25.89); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line + 'Add error bars to series + serieJan.ErrorBar(True, OfficeErrorBarInclude.Both, OfficeErrorBarType.StandardDeviation, 12.34) + serieFeb.ErrorBar(False, OfficeErrorBarInclude.Plus, OfficeErrorBarType.StandardError, 25.89) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Creates error bar for the series. + + If true - on Y axis; otherwise on X axis. + Represents plus range. + Represents minus range. + Returns error bar object. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line; + //Set the error bar X for serie + serieJan.HasErrorBarsX = true; + //Set the plus range + serieJan.ErrorBarsX.PlusRange = chart.ChartData[2, 2, 4, 2]; + //Set the minus range + serieJan.ErrorBarsX.MinusRange = chart.ChartData[2, 3, 4, 3]; + //Add Error bar to serie + serieJan.ErrorBar(true, serieJan.ErrorBarsX.PlusRange, serieJan.ErrorBarsX.MinusRange); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Set the chart type + chart.ChartType = OfficeChartType.Scatter_Line + 'Set the error bar X for serie + serieJan.HasErrorBarsX = True + 'Set the plus range + serieJan.ErrorBarsX.PlusRange = chart.ChartData(2, 2, 4, 2) + 'Set the minus range + serieJan.ErrorBarsX.MinusRange = chart.ChartData(2, 3, 4, 3) + 'Add Error bar to serie + serieJan.ErrorBar(True, serieJan.ErrorBarsX.PlusRange, serieJan.ErrorBarsX.MinusRange) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value to specify the series to invert its colors if the value is negative. + + + + IPresentation presentationDocument = Presentation.Create(); + ISlide slide = presentationDocument.Slides.Add(SlideLayoutType.Blank); + //Loads the excel file as stream + Stream excelStream = File.OpenRead("Excel_Template.xlsx"); + //Creates and Appends chart to the paragraph with excel stream as parameter + IPresentationChart chart = slide.Shapes.AddChart(excelStream, 1, "A1:C6", new RectangleF(0, 0, 470, 300)); + foreach (IOfficeChartSerie serie in chart.Series) + { + serie.InvertIfNegative = true; + series.InvertIfNegativeColor = Color.Red; + } + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 6, 1]; + //Sets chart type and title + chart.ChartType = OfficeChartType.Bar_Clustered; + chart.ChartTitle = "Purchase Details"; + chart.ChartTitleArea.FontName = "Calibri"; + chart.ChartTitleArea.Size = 14; + chart.PrimaryValueAxis.CrossesAt = 1500; + presentationDocument.Save("Output.pptx"); + presentationDocument.Close(); + + + Dim presentationDocument As IPresentation = Presentation.Create() + Dim slide As ISlide = presentationDocument.Slides.Add(SlideLayoutType.Blank) + 'Loads the excel file as stream + Dim excelStream As Stream = File.OpenRead("Excel_Template.xlsx") + 'Creates and Appends chart to the paragraph with excel stream as parameter + Dim chart As IPresentationChart = slide.Shapes.AddChart(excelStream, 1, "A1:C6", New RectangleF(0, 0, 470, 300)) + For Each serie As IOfficeChartSerie In chart.Series + serie.InvertIfNegative = False + series.InvertIfNegativeColor = Color.Red + Next + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData(2, 1, 6, 1) + 'Sets chart type and title + chart.ChartType = OfficeChartType.Bar_Clustered + chart.ChartTitle = "Purchase Details" + chart.ChartTitleArea.FontName = "Calibri" + chart.ChartTitleArea.Size = 14 + chart.PrimaryValueAxis.CrossesAt = 1500 + presentationDocument.Save("Output.pptx") + presentationDocument.Close() + + + + + + Gets or sets the value range of the series. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentationDocument As IPresentation = Presentation.Create() + Dim slide As ISlide = presentationDocument.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Save the presentation + presentationDocument.Save("Output.pptx") + 'Close the presentation + presentationDocument.Close() + + + + + + Gets or sets a value to specify the series to invert its colors if the value is negative. The default value is true. + + + + IPresentation presentationDocument = Presentation.Create(); + ISlide slide = presentationDocument.Slides.Add(SlideLayoutType.Blank); + //Loads the excel file as stream + Stream excelStream = File.OpenRead("Excel_Template.xlsx"); + //Creates and Appends chart to the paragraph with excel stream as parameter + IPresentationChart chart = slide.Shapes.AddChart(excelStream, 1, "A1:C6", new RectangleF(0, 0, 470, 300)); + foreach (IOfficeChartSerie serie in chart.Series) + { + serie.InvertIfNegative = false; + } + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 6, 1]; + //Sets chart type and title + chart.ChartType = OfficeChartType.Bar_Clustered; + chart.ChartTitle = "Purchase Details"; + chart.ChartTitleArea.FontName = "Calibri"; + chart.ChartTitleArea.Size = 14; + chart.PrimaryValueAxis.CrossesAt = 1500; + presentationDocument.Save("Output.pptx"); + presentationDocument.Close(); + + + Dim presentationDocument As IPresentation = Presentation.Create() + Dim slide As ISlide = presentationDocument.Slides.Add(SlideLayoutType.Blank) + 'Loads the excel file as stream + Dim excelStream As Stream = File.OpenRead("Excel_Template.xlsx") + 'Creates and Appends chart to the paragraph with excel stream as parameter + Dim chart As IPresentationChart = slide.Shapes.AddChart(excelStream, 1, "A1:C6", New RectangleF(0, 0, 470, 300)) + For Each serie As IOfficeChartSerie In chart.Series + serie.InvertIfNegative = False + Next + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData(2, 1, 6, 1) + 'Sets chart type and title + chart.ChartType = OfficeChartType.Bar_Clustered + chart.ChartTitle = "Purchase Details" + chart.ChartTitleArea.FontName = "Calibri" + chart.ChartTitleArea.Size = 14 + chart.PrimaryValueAxis.CrossesAt = 1500 + presentationDocument.Save("Output.pptx") + presentationDocument.Close() + + + + + + Gets or sets the range of category labels of the series. + + + + //Creates a Presentation instance + IPresentation presentation = Presentation.Open("BubbleChart.pptx"); + ISlide slide = presentation.Slides[0]; + IPresentationChart chart = slide.Charts[0]; + //Retrieves the range of category labels + IOfficeDataRange dataRange = chart.Series[0].CategoryLabels; + //Changes the category label of a specific cell within the data range. + dataRange.SetValue(dataRange.FirstRow, dataRange.FirstColumn, 2.4); + //Saves the presentation + presentation.Save("Output.pptx"); + //Closes the presentation + presentation.Close(); + + + 'Creates a Presentation instance + Dim presentationDocument As IPresentation = Presentation.Open("BubbleChart.pptx") + Dim slide As ISlide = presentationDocument.Slides(0) + Dim chart As IPresentationChart = slide.Charts(0) + Retrieves the range of category labels + Dim dataRange As IOfficeDataRange = chart.Series(0).CategoryLabels + 'Changes the category label of a specific cell within the data range. + dataRange.SetValue(dataRange.FirstRow, dataRange.FirstColumn, 2.4) + 'Saves the presentation + presentationDocument.Save("Output.pptx") + 'Closes the presentation + presentationDocument.Close() + + + + + + Gets or sets the range of bubble sizes of the bubble chart. + + + + //Creates a Presentation instance + IPresentation presentation = Presentation.Open("BubbleChart.pptx"); + ISlide slide = presentation.Slides[0]; + IPresentationChart chart = slide.Charts[0]; + //Retrieves the range of bubble sizes of the chart + IOfficeDataRange dataRange = chart.Series[0].Bubbles; + //Changes the bubble size in a specific cell within the data range. + dataRange.SetValue(dataRange.FirstRow, dataRange.FirstColumn, 20); + //Saves the presentation + presentation.Save("Output.pptx"); + //Closes the presentation + presentation.Close(); + + + 'Creates a Presentation instance + Dim presentationDocument As IPresentation = Presentation.Open("BubbleChart.pptx") + Dim slide As ISlide = presentationDocument.Slides(0) + Dim chart As IPresentationChart = slide.Charts(0) + 'Retrieves the range of bubble sizes of the chart + Dim dataRange As IOfficeDataRange = chart.Series(0).Bubbles + 'Changes the bubble size in a specific cell within the data range. + dataRange.SetValue(dataRange.FirstRow, dataRange.FirstColumn, 20) + 'Saves the presentation + presentationDocument.Save("Output.pptx") + 'Closes the presentation + presentationDocument.Close() + + + + + + Gets or sets the name of the series. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type as Radar + chart.ChartType = OfficeChartType.Radar; + //Reset the name of the serie + serieFeb.Name = "February"; + //Get the Serie Format + IOfficeChartSerieDataFormat serieFormat = serieFeb.SerieFormat; + //Set the radar axis labels + serieFormat.CommonSerieOptions.HasRadarAxisLabels = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type as Radar + chart.ChartType = OfficeChartType.Radar + 'Reset the name of the serie + serieFeb.Name = "February" + 'Get the Serie Format + Dim serieFormat As IOfficeChartSerieDataFormat = serieFeb.SerieFormat + 'Set the radar axis labels + serieFormat.CommonSerieOptions.HasRadarAxisLabels = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the Name range of the series. + + + + //Creates a Presentation instance + IPresentation presentation = Presentation.Open("BubbleChart.pptx"); + ISlide slide = presentation.Slides[0]; + IPresentationChart chart = slide.Charts[0]; + //Retrieves the name range of the series + IOfficeDataRange dataRange = chart.Series[0].NameRange; + //Sets a new name to the series + dataRange.SetValue(dataRange.FirstRow, dataRange.FirstColumn, "My serie Name"); + //Saves the presentation + presentation.Save("Output.pptx"); + //Closes the presentation + presentation.Close(); + + + 'Creates a Presentation instance + Dim presentationDocument As IPresentation = Presentation.Open("BubbleChart.pptx") + Dim slide As ISlide = presentationDocument.Slides(0) + Dim chart As IPresentationChart = slide.Charts(0) + 'Retrieves the name range of the series + Dim dataRange As IOfficeDataRange = chart.Series(0).NameRange + 'Sets a new name to the series + dataRange.SetValue(dataRange.FirstRow, dataRange.FirstColumn, "My serie Name") + 'Saves the presentation + presentationDocument.Save("Output.pptx") + 'Closes the presentation + presentationDocument.Close() + + + + + + Gets or Sets a value that Indicates whether to use primary axis for series drawing. + + True if use primary axis.Otherwise False. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the primary axis for the serie + serieMarch.UsePrimaryAxis = true; + //Add the trendline to chart serie + serieJan.TrendLines.Add(); + serieJan.TrendLines.Add(OfficeTrendLineType.Moving_Average); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create()///Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the primary axis for the serie + serieMarch.UsePrimaryAxis = True + 'Add the trendline to chart serie + serieJan.TrendLines.Add() + serieJan.TrendLines.Add(OfficeTrendLineType.Moving_Average) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the collection of data points of the series. Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the series data points + IOfficeChartDataPoints dataPoints = chart.Series[0].DataPoints; + //Get the data point using the index, read only + IOfficeChartDataPoint dataPoint = dataPoints[0]; + //Get the data labels of data point + IOfficeChartDataLabels dataLabels = dataPoint.DataLabels; + //Set the position of the data label + dataLabels.Position = OfficeDataLabelPosition.Center; + //Set the series name + dataLabels.IsSeriesName = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the series data points + Dim dataPoints As IOfficeChartDataPoints = chart.Series(0).DataPoints + 'Get the data point using the index, read only + Dim dataPoint As IOfficeChartDataPoint = dataPoints(0) + 'Get the data labels of data point + Dim dataLabels As IOfficeChartDataLabels = dataPoint.DataLabels + 'Set the position of the data label + dataLabels.Position = OfficeDataLabelPosition.Center + 'Set the series name + dataLabels.IsSeriesName = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the object that represents formatting settings of the series.Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type as Radar + chart.ChartType = OfficeChartType.Radar; + //Reset the name of the serie + serieFeb.Name = "February"; + //Get the Serie Format + IOfficeChartSerieDataFormat serieFormat = serieFeb.SerieFormat; + //Set the radar axis labels + serieFormat.CommonSerieOptions.HasRadarAxisLabels = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type as Radar + chart.ChartType = OfficeChartType.Radar + 'Reset the name of the serie + serieFeb.Name = "February" + 'Get the Serie Format + Dim serieFormat As IOfficeChartSerieDataFormat = serieFeb.SerieFormat + 'Set the radar axis labels + serieFormat.CommonSerieOptions.HasRadarAxisLabels = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a series type for the series. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the serie type for each serie + serieFeb.SerieType = OfficeChartType.Line; + serieJan.SerieType = OfficeChartType.Area; + serieMarch.SerieType = OfficeChartType.Bar_Clustered; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the serie type for each serie + serieFeb.SerieType = OfficeChartType.Line + serieJan.SerieType = OfficeChartType.Area + serieMarch.SerieType = OfficeChartType.Bar_Clustered + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the object that represents horizontal error bars. Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type as Scatter line + chart.ChartType = OfficeChartType.Scatter_Line; + //Set the error Bar Y + serieJan.HasErrorBarsY = true; + //Set the color of error barX border + serieJan.ErrorBarsY.Border.LineColor = System.Drawing.Color.Red; + //Set the has cap + serieJan.ErrorBarsY.HasCap = true; + //Set the include + serieJan.ErrorBarsY.Include = OfficeErrorBarInclude.Minus; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type as Scatter line + chart.ChartType = OfficeChartType.Scatter_Line + 'Set the error Bar Y + serieJan.HasErrorBarsY = True + 'Set the color of error barX border + serieJan.ErrorBarsY.Border.LineColor = System.Drawing.Color.Red + 'Set the has cap + serieJan.ErrorBarsY.HasCap = True + 'Set the include + serieJan.ErrorBarsY.Include = OfficeErrorBarInclude.Minus + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that Indicates the series contains Y error bars. + + Trueif series contains Y error bars.Otherwise False. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type as Scatter line + chart.ChartType = OfficeChartType.Scatter_Line; + //Set the error Bar Y + serieJan.HasErrorBarsY = true; + //Set the color of error barX border + serieJan.ErrorBarsY.Border.LineColor = System.Drawing.Color.Red; + //Set the has cap + serieJan.ErrorBarsY.HasCap = true; + //Set the include + serieJan.ErrorBarsY.Include = OfficeErrorBarInclude.Minus; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type as Scatter line + chart.ChartType = OfficeChartType.Scatter_Line + 'Set the error Bar Y + serieJan.HasErrorBarsY = True + 'Set the color of error barX border + serieJan.ErrorBarsY.Border.LineColor = System.Drawing.Color.Red + 'Set the has cap + serieJan.ErrorBarsY.HasCap = True + 'Set the include + serieJan.ErrorBarsY.Include = OfficeErrorBarInclude.Minus + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the object that represents vertical error bars. Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type as Scatter line + chart.ChartType = OfficeChartType.Scatter_Line; + //Set the error Bar X + serieJan.HasErrorBarsX = true; + //Set the color of error barX border + serieJan.ErrorBarsX.Border.LineColor = System.Drawing.Color.Red; + //Set the has cap + serieJan.ErrorBarsX.HasCap = true; + //Set the include + serieJan.ErrorBarsX.Include = OfficeErrorBarInclude.Minus; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type as Scatter line + chart.ChartType = OfficeChartType.Scatter_Line + 'Set the error Bar X + serieJan.HasErrorBarsX = True + 'Set the color of error barX border + serieJan.ErrorBarsX.Border.LineColor = System.Drawing.Color.Red + 'Set the has cap + serieJan.ErrorBarsX.HasCap = True + 'Set the include + serieJan.ErrorBarsX.Include = OfficeErrorBarInclude.Minus + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that Indicates the series contains X error bars. + + Trueif series contains X error bars.Otherwise False. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type as Scatter line + chart.ChartType = OfficeChartType.Scatter_Line; + //Set the error Bar X + serieJan.HasErrorBarsX = true; + //Set the color of error barX border + serieJan.ErrorBarsX.Border.LineColor = System.Drawing.Color.Red; + //Set the has cap + serieJan.ErrorBarsX.HasCap = true; + //Set the include + serieJan.ErrorBarsX.Include = OfficeErrorBarInclude.Minus; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type as Scatter line + chart.ChartType = OfficeChartType.Scatter_Line + 'Set the error Bar X + serieJan.HasErrorBarsX = True + 'Set the color of error barX border + serieJan.ErrorBarsX.Border.LineColor = System.Drawing.Color.Red + 'Set the has cap + serieJan.ErrorBarsX.HasCap = True + 'Set the include + serieJan.ErrorBarsX.Include = OfficeErrorBarInclude.Minus + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the trend lines collection of the series. Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the primary axis for the serie + serieMarch.UsePrimaryAxis = true; + //Add the trendline to chart serie + serieJan.TrendLines.Add(); + serieJan.TrendLines.Add(OfficeTrendLineType.Moving_Average); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the primary axis for the serie + serieMarch.UsePrimaryAxis = True + 'Add the trendline to chart serie + serieJan.TrendLines.Add() + serieJan.TrendLines.Add(OfficeTrendLineType.Moving_Average) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Returns or sets a value that determines whether the specified chart series is filtered out from the chart. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Filter the serie value + serieJan.IsFiltered = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation__1 As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Filter the serie value + serieJan.IsFiltered = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the Pareto line on the Pareto charts. Read-only. + + + Gets the Pareto line on the Pareto charts. Read-only. + + + + + Index for format that corresponds to all points in the Series. + + + + + Represents default point number for surface chart type. + + + + + Represents default chart group. + + + + + Represents start radar type. + + + + + Represents true as string. + + + + + Represents false as string. + + + + + Represent the value form cells range values collection in datalabels. + + + + + Values range for the series. + + + + + Category labels for the series. + + + + + Bubble sizes for the series. + + + + + Name of the series. + + + + + Represents whether the series are reversed. + + + + + Dictionary IndexIdentifier-to-ChartAiRecord + + + + + Index of the chart group this axis belongs to. + + + + + Parent workbook for the series. + + + + + ChartSeries record describing this series. + + + + + Parent chart for the series. + + + + + Parent series collection. + + + + + Index of the series. + + + + + Drawing order of the series. + + + + + Indicates whether series name has default value. + + + + + Data points collection. + + + + + Represents Series type. + + + + + Represents array of number or label records for value range. + + + + + Represents array of number or label records for category range. + + + + + Represents array of number or label records for bubble range. + + + + + Represents array of values for value range. + + + + + Represents array of values for category range. + + + + + Represents array of values for bubble range. + + + + + Represents series name range. + + + + + Represents not default series text for first Series on parsing. + + + + + Represents Y error bar. + + + + + Represents X error bar. + + + + + Represents trend line collection. + + + + + This element specifies the series + to invert its colors if the value is negative. + + + + + Represents the string reference formula + + + + + Represents the number reference formula + + + + + Represents the number reference formula + + + + + Preserve the drop lines + + + + + Reprsent the Filter option + + + + + Reprsent the category filter range + + + + + Reprsent the category value Range + + + + + Specifies the kind of grouping for a column, line or area chart + + + + + Represents chart gapWidth for the first series + + + + + Represents chart overlap for the first series + + + + + Represents whether to serialize gapwidth + + + + + This holds index value of the series values + + + + + This holds Format Code For Num Cache Values + + + + + Represents the stream for preserving the Extents node + + + + + + Represents the stream for preserving the Extents node + + + + + Represents the multi level string cache. + + + + + Represents the list of formatcode for Values present in Series. + + + + + Represents the list of formatcode for Category present in Series. + + + + + Represents multi level string cache point count + + + + + ShowLeaderLines for the series. + + + + + Border settings for ShowleaderLines. + + + + + Represents whether Value range for the series valid or not. + + + + + Represents whether Category range for the series valid or not. + + + + + Creates series and set its Application and Parent + properties to specified values. + + Application object for the chart. + Parent object for the chart. + + + + Creates error bar object. + + If true - on Y axis; otherwise on X axis. + Return error bar object. + + + + Creates error bar object. + + If true - on Y axis; otherwise on X axis. + Represents include type. + Return error bar object. + + + + Creates error bar object. + + If true - on Y axis; otherwise on X axis. + Represents include type. + Represents error bar type. + Return error bar object. + + + + Creates error bar object. + + If true - on Y axis; otherwise on X axis. + Represents include type. + Represents error bar type. + Represents number value. + Returns error bar object. + + + + Sets custom error bar type. + + If true - on Y axis; otherwise on X axis. + Represents plus range. + Represents minus range. + Returns error bar object. + + + + Set leader lines. + + bool value to set. + + + + Searches for all needed parent objects. + + + When parents cannot be found. + + + + + Initializes m_hashAI member. + + + + + Initializes all internal collections. + + + + + Sets data format. + + Data format to set. + + + + This method is called when the name of the series needs to be changed. + + New name of the series. + + + + Raises ValueRangeChanged event and sets new value to the ValueRange. + + + + + Sets new value to the CategoryRange. + + + + + Sets new value to the BubbleRange. + + + + + Clone current instance. + + Parent object. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Cloned series. + + + + Changes axis. + + If true - to primary; otherwise - to secondary. + + + + Returns new series order. + + If true - to primary; otherwise - to secondary. + A new series order. + + + + Gets values of entered directly values. + + Record storage. + Returns just created array of values. + + + + Detects name. + + Returns detected Series name. + + + + Gets text range value for Series name that supports cell, or row, or column. + + Range to gets text value. + Value representing text range. + + + + Update the row wise or column wise members of chart series for chart Ex + + boolean values indicates whether the property of values need to be changed or not. + + + + Sets default Series name. + + Represents Series name. + + + + Gets Series name range. + + Returns range, that represents Series name range. Can be null. + + + + Detects Series type. + + Extracted series type. + + + + Detects Series type. + + Detected string representationg of the series type. + + + + Detects Series type. + + Extracted series type. + + + + Detects the type of the series when describing record is ChartBar. + + Series format. + Returns series type. + + + + Gets bar start string. + + Format for detect start string. + Returns start string. + + + + Detects the type of the series when describing record is ChartPie. + + Series format. + Returns series type. + + + + Detects the type of the series when describing record is ChartArea. + + Series format. + Returns series type. + + + + Detects the type of the series when describing record is ChartSurface. + + Series format. + Returns series type. + + + + Detects the type of the series when describing record is ChartBoppop. + + Series format. + Returns series type. + + + + Detects the type of the series when describing record is ChartRadar. + + Series format. + Returns series type. + + + + Detects the type of the series when describing record is Chartline. + + Series format. + Returns series type. + + + + Detects the type of the series when describing record is ChartScatter. + + Series format. + Returns series type. + + + + This method changes series type. + + Series type to change to. + Indicates whether this change happens because of series creation process. + + + + This method changes series type. + + Series type to change to. + Indicates whether this change happens because of series creation process. + + + + Calls before series type changed. + + Type to change. + Indicates whether we are in the process of series creation. + Type of the series + Indicates whether the axis changes + + + + Changes not intimate type. + + Type to change. + + + + Checks is types are intimate. If intimate then change chart type. + + Format to change. + Type to change. + Returns true if changed type. otherwise false. + + + + Changes intimate line series. + + Format to change. + Type to change. + TypeToChange string representation. + + + + Initialize hash table for change intimate line type. + + HashTable to initialize. + + + + Changes series in combination charts. + + Type to change. + + + + Finds intimate format by type. + + Type to find. + Returns found format or null. + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + Updates formulas after copy operation. + + Record with range info to update. + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + Updated range. + + + + Updates formulas after copy operation. + + Formula token to update. + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + Updated token. + + + + Updates formula token when only part of it was moved. + + Original token. + Source worksheet index. + Rectangle with token range. + Source rectangle. + Destination rectangle. + Token after move operation. + + + + Partially removes token. + + Token to shrink + Sheet index. + Range rectangle. + Source rectangle. + Destination rectangle. + Token after shrink operation. + + + + Gets common series format. + + Returns common series format. + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Sets range value into the ChartAi record. + + ChartAi record that will contain specified range. + Range that will be assigned. + ReferenceType that should be written if range is NULL. + + When specified ChartAi record is NULL. + + + + + Checks whether number of items inside single series is correct. + + + + + Indicates the format index of chart pareto line + Used only in loaded chart + + + + + Indicates whether the pareto line is hidden + + + + + Objects that holds the pareto line settings + + + + + Boolean value indicates category values interpreted in row-wise + + + + + Boolean value indicates series values interpreted in row-wise + + + + + format code used in series values + + + + + format code used in category values + + + + + Returns range from ChartAi record. + + ChartAi record that contains range. + Parsed range. + + When chartAi is NULL. + + + + + Gets IRange from current ptg. + + Current ptg. + Returns ptg. + + + + This event is raised when ValueRange was changed. + + + + + Represents whether the series are reversed. + + + + + Name of the series. + + + + + Series Name range for the series. + + + + + + Gets the Name range of the series. + + + + //Creates a Presentation instance + IPresentation presentation = Presentation.Open("BubbleChart.pptx"); + ISlide slide = presentation.Slides[0]; + IPresentationChart chart = slide.Charts[0]; + //Retrieves the name range of the series + IOfficeDataRange dataRange = chart.Series[0].NameRange; + //Sets a new name to the series + dataRange.SetValue(dataRange.FirstRow, dataRange.FirstColumn, "My serie Name"); + //Saves the presentation + presentation.Save("Output.pptx"); + //Closes the presentation + presentation.Close(); + + + 'Creates a Presentation instance + Dim presentationDocument As IPresentation = Presentation.Open("BubbleChart.pptx") + Dim slide As ISlide = presentationDocument.Slides(0) + Dim chart As IPresentationChart = slide.Charts(0) + 'Retrieves the name range of the series + Dim dataRange As IOfficeDataRange = chart.Series(0).NameRange + 'Sets a new name to the series + dataRange.SetValue(dataRange.FirstRow, dataRange.FirstColumn, "My serie Name") + 'Saves the presentation + presentationDocument.Save("Output.pptx") + 'Closes the presentation + presentationDocument.Close() + + + + + + Values range for the series. + + + + + Represents whether Value range for the series valid or not. + + + + + Gets or sets the value range of the series. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie - start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie - start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series - start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentationDocument As IPresentation = Presentation.Create() + Dim slide As ISlide = presentationDocument.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie - start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie - start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series - start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Save the presentation + presentationDocument.Save("Output.pptx") + 'Close the presentation + presentationDocument.Close() + + + + + + Category labels for the series. + + + + + Represents whether Category labels for the series. + + + + + Gets or sets the range of category labels of the series. + + + + //Creates a Presentation instance + IPresentation presentation = Presentation.Open("BubbleChart.pptx"); + ISlide slide = presentation.Slides[0]; + IPresentationChart chart = slide.Charts[0]; + //Retrieves the range of category labels + IOfficeDataRange dataRange = chart.Series[0].CategoryLabels; + //Changes the category label of a specific cell within the data range. + dataRange.SetValue(dataRange.FirstRow, dataRange.FirstColumn, 2.4); + //Saves the presentation + presentation.Save("Output.pptx"); + //Closes the presentation + presentation.Close(); + + + 'Creates a Presentation instance + Dim presentationDocument As IPresentation = Presentation.Open("BubbleChart.pptx") + Dim slide As ISlide = presentationDocument.Slides(0) + Dim chart As IPresentationChart = slide.Charts(0) + Retrieves the range of category labels + Dim dataRange As IOfficeDataRange = chart.Series(0).CategoryLabels + 'Changes the category label of a specific cell within the data range. + dataRange.SetValue(dataRange.FirstRow, dataRange.FirstColumn, 2.4) + 'Saves the presentation + presentationDocument.Save("Output.pptx") + 'Closes the presentation + presentationDocument.Close() + + + + + + Bubble sizes for the series. + + + + + Gets or sets the range of bubble sizes of the bubble chart. + + + + //Creates a Presentation instance + IPresentation presentation = Presentation.Open("BubbleChart.pptx"); + ISlide slide = presentation.Slides[0]; + IPresentationChart chart = slide.Charts[0]; + //Retrieves the range of bubble sizes of the chart + IOfficeDataRange dataRange = chart.Series[0].Bubbles; + //Changes the bubble size in a specific cell within the data range. + dataRange.SetValue(dataRange.FirstRow, dataRange.FirstColumn, 20); + //Saves the presentation + presentation.Save("Output.pptx"); + //Closes the presentation + presentation.Close(); + + + 'Creates a Presentation instance + Dim presentationDocument As IPresentation = Presentation.Open("BubbleChart.pptx") + Dim slide As ISlide = presentationDocument.Slides(0) + Dim chart As IPresentationChart = slide.Charts(0) + 'Retrieves the range of bubble sizes of the chart + Dim dataRange As IOfficeDataRange = chart.Series(0).Bubbles + 'Changes the bubble size in a specific cell within the data range. + dataRange.SetValue(dataRange.FirstRow, dataRange.FirstColumn, 20) + 'Saves the presentation + presentationDocument.Save("Output.pptx") + 'Closes the presentation + presentationDocument.Close() + + + + + + Synonym for Index property. + + + + + Returns data points collection for the chart series. Read-only. + + + + + Returns format of current Series. + + + + + Represents Series type. + + + + + Indicates whether to use primary axis for series drawing. + + + + + Represents value as entered directly. + + + + + Represents category values as entered directly. + + + + + Represents bubble values as entered directly. + + + + + Gets and sets the value form range cells values collection in datalabels. + + + + + Indicates if the serie has specific column shape + + + + + Represents Y error bars. Read-only. + + + + + Indicates if Series contains Y error bars. + + + + + Represents X error bars. Read-only. + + + + + Indicates if Series contains X error bars. + + + + + Represents Series trend lines collection. Read-only. + + + + + Gets or sets the value that represents the kind of grouping for a column, line or area chart + + + + + Gets or sets the value of chart gapWidth of first series + + + + + Gets or sets the value of chart overlap of first series + + + + + Represents whether to serialize gapwidth + + + + + This holds Format Code For Num Cache Values + + + + + This holds formatcodes of value axis. + + + + + This holds formatcodes of category axis. + + + + + This holds cache information of multi level category axis. + + + + + This holds multi level cache point count. + + + + + This event is raised when name of the series changes. + + + + + Gets or Set the ShowLeaderLines if true. + + + + + Gets or Set the LeaderLines border settings. + + + + + Represents index of the series. + + + + + Represent series is Filter + + + + + Series drawing/settings order.//Number of the series. + + + + + Index of the chart group. + + + + + Returns parent chart. Read-only. + + + + + Indicates whether series has default title. + + + + + Returns number of points in the series. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + Represent the filtered category label range + + + + + Represent the Filtered Category value + + + + + Returns series start type. Read-only. + + + + + Represents not default series text for first series. Read-only. + + + + + Gets parent series collection. Read - only. + + + + + Represents parent chart. Read - only. + + + + + Gets parent workbook. Read - only. + + + + + Indicates whether this is pie series. + + + + + Gets series name or formula value (not actual string value). + + + + + Gets or sets a value to specify the series to invert its colors if the value is negative. The default value is true. + + + + + Gets or sets a value to specify the series to invert its colors if the value is negative. The default value is true. + + + + + Gets or sets the string reference formula + + + + + Gets or sets the number reference formula + + + + + Gets or sets the number reference formula + + + + + Gets or sets a value to specify the series to invert its colors if the value is negative. + + + + + Gets or sets the chart's drop lines property as stream. + TODO: Need to add parsing support for drop lines. Should be removed after adding parsing support. + + + + + Gets / Sets the pareto line is hidden + + + + + Gets / Sets the series is hidden or not + + + + + Gets / Sets the format index of chart pareto line + Used only in loaded chart + + + + + Gets / SetsBoolean value indicates category values interpreted in row-wise + + + + + Gets / Sets the format code for series categories + + + + + Class used for Chart Series Axis implementation. + + + + + Represents the chart series Axis. + + + + + Represents the number of categories or series between tick-mark labels. + + + + + Gets or sets the number of categories or series between tick-mark labels. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Set the number of series between tick-mark labels + chart.PrimarySerieAxis.TickLabelSpacing = 10; + //Sets the number of series between tick marks. + chart.PrimarySerieAxis.TickMarkSpacing = 15; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Set the number of series between tick-mark labels + chart.PrimarySerieAxis.TickLabelSpacing = 10 + 'Sets the number of series between tick marks. + chart.PrimarySerieAxis.TickMarkSpacing = 15 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the number of categories or series between tick marks. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Set the number of series between tick-mark labels + chart.PrimarySerieAxis.TickLabelSpacing = 10; + //Sets the number of series between tick marks. + chart.PrimarySerieAxis.TickMarkSpacing = 15; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Set the number of series between tick-mark labels + chart.PrimarySerieAxis.TickLabelSpacing = 10 + 'Sets the number of series between tick marks. + chart.PrimarySerieAxis.TickMarkSpacing = 15 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Specifies maximum spacing value. + + + + + Catser range record. + + + + + Creates primary axis of specified type. + + Application object for the axis. + Parent object for the axis. + Type of the new axis. + + + + Creates axis of specified type and specified IsPrimary value. + + Application object for the axis. + Parent object for the axis. + Type of the new axis. + + True if primary axis should be created; otherwise False. + + + + + Initializes variables. + + + + + Clone current object. + + Parent object. + Dictionary with new font indexes. + Dictionary with new worksheet names. + Returns cloned object. + + + + Represents the number of categories or series between tick-mark labels. + + + + + Represents the number of categories or series between tick-mark labels. + + + + + Represents the number of categories or series between tick marks. + + + + + Represents the number of categories or series between tick marks. + + + + + Display categories in reverse order. + + + + + Returns title area. Read-only. + + + + + Represents the point on the axis another axis crosses it. + + + + + Returns or sets the base of the logarithm when you are using log scales. The default value is 10. + + + + + ChartSeriesCollection - collection of the chart series. + + + + + Represents the collection of chart series. + + + + + Adds a new series to the collection. + + Returns the Added object to the collection. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add(); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb",OfficeChartType.Area); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add() + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb", OfficeChartType.Area) + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Adds a new series to the collection with specified type. + + Type of the new series. + Returns the Added object to the collection. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add(); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb",OfficeChartType.Area); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add() + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb", OfficeChartType.Area) + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Adds a new series to the collection with specified series name. + + Name of the new series. + Returns the Added object to the collection. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Adds a new series to the collection with specified series name and type. + + Name of the new series. + Type of the new series. + Returns the Added object to the collection. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add(); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb",OfficeChartType.Area); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add() + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb", OfficeChartType.Area) + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes object at the specified index from the collection. + + The zero-based index of the serie to remove. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add(); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb",OfficeChartType.Area); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Remove a serie using the index position + chart.Series.RemoveAt(0); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add() + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb", OfficeChartType.Area) + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Remove a serie using the index position + chart.Series.RemoveAt(0) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes object with specified name from the collection. + + Name of the series to remove. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add(); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb",OfficeChartType.Area); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Remove a specific serie from collection + chart.Series.Remove(serieJan); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add() + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb", OfficeChartType.Area) + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Remove a specific serie from collection + chart.Series.Remove(serieJan) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the number of objects in the collection. Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add(); + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb",OfficeChartType.Area); + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the count of the series + int count = chart.Series.Count; + //Set the data range of chart serie � start row, start column, end row, end column + chart.Series[0].Values = chart.ChartData[2, 2, 4, 2]; + chart.Series["Feb"].Values = chart.ChartData[2, 3, 4, 3]; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add() + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb", OfficeChartType.Area) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the count of the series + Dim count As Integer = chart.Series.Count + 'Set the data range of chart serie � start row, start column, end row, end column + chart.Series(0).Values = chart.ChartData(2, 2, 4, 2) + chart.Series("Feb").Values = chart.ChartData(2, 3, 4, 3) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a single instance at the specified index from the collection. Read-only. + + The zero-based index of the element. + Returns the particular series based on the index. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add(); + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb",OfficeChartType.Area); + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the count of the series + int count = chart.Series.Count; + //Set the data range of chart serie � start row, start column, end row, end column + chart.Series[0].Values = chart.ChartData[2, 2, 4, 2]; + chart.Series["Feb"].Values = chart.ChartData[2, 3, 4, 3]; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add() + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb", OfficeChartType.Area) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the count of the series + Dim count As Integer = chart.Series.Count + 'Set the data range of chart serie � start row, start column, end row, end column + chart.Series(0).Values = chart.ChartData(2, 2, 4, 2) + chart.Series("Feb").Values = chart.ChartData(2, 3, 4, 3) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a single instance with the specified name from the collection. Read-only. + + Name of the series + Returns the particular series based on the given name. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add(); + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb",OfficeChartType.Area); + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the count of the series + int count = chart.Series.Count; + //Set the data range of chart serie � start row, start column, end row, end column + chart.Series[0].Values = chart.ChartData[2, 2, 4, 2]; + chart.Series["Feb"].Values = chart.ChartData[2, 3, 4, 3]; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add() + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb", OfficeChartType.Area) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the count of the series + Dim count As Integer = chart.Series.Count + 'Set the data range of chart serie � start row, start column, end row, end column + chart.Series(0).Values = chart.ChartData(2, 2, 4, 2) + chart.Series("Feb").Values = chart.ChartData(2, 3, 4, 3) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Start of the default series name. + + + + + Represents parent chart. + + + + + Represents record storage for serialize error bars and trend lines. Use only for serialize. + + + + + Array that helps to serialize trendlines labels. Use only for serialize. + + + + + Represents summary index for error bars and trends. Use only for serialize. + + + + + Represents trend line index. + + + + + Creates collection. + + Application object for the collection. + Parent object for the collection. + + + + Defines a new series. + + Returns a Series object. + + + + Defines a new series. Returns a Series object. + + Name of the new series. + Newly created series object. + + + + Defines a new series. Returns a Series object. + + Type of new series. + Newly created series object. + + + + Defines a new series. Returns a Series object. + + Name of the new series. + Type of new series. + Newly created series object. + + + + Removes Series object from the collection. + + Index of the series to remove. + + + + Removes series by name. + + Series name to remove. + + + + Adds series to the collection. + + Series that should be added to the collection. + Series that was added. + + + + Performs additional operations before the Clear method. + + + + + Clone current instance. + + Parent object. + Hash table with new Worksheet names. + Dictionary with new font indexes. + Returns cloned instance. + + + + Clone current instance. + + Parent object. + Returns cloned instance. + + + + Gets count of series that has same chart group index. + + Parameter to check. + Returns count of found series. + + + + Gets series that has same chart group index. + + Parameter to check. + Returns list of found series. + + + + Gets count of series with same type in collection. + + Current type. + Returns count of same types. + + + + Gets count of series with same type in collection. + + Current type. + Returns count of same start types. + + + + Sets for default all series in chart. + + boolean value indicates whether the formats to be preserved or not + Current type. + + + + Sets for default all series in chart. + + + + + Finds order by series type. + + Type to find. + Returns order. + + + + Updates data points for create one of Pyramid, Cylinder, Cone chart types. + + Base format for update. + Top format for update. + + + + Updates series index after remove + + Remove index. + + + + Updates ExistingOrder after remove + + Remove index. + + + + Gets series type by order. + + Current order. + Returns found type. + + + + Clears all series data formats. + + Represents format to update. + + + + Gets the default series name. + + Returns default series name. + + + + Gets the default series name. + + Represents series index in collections. + Returns default series name. + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + Clears error bars. + + + + + Puts all series into correct order based on their index. + + Dictionary containing series axis. + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Returns a single Name object from a Names collection. + + + + + Returns a single Name object from a Names collection. + + + + + Represents record storage for serialize error bars and trend lines. Use only for serialize. + + + + + Represents summary index for error bars and trends. Use only for serialize. + + + + + Represents record storage for serialize trend labels. Use only for serialize. Read-only. + + + + + Represents count of trends + series count. + + + + + Represents text area in the chart. + + + + + Indicating wheather baseline have percentage or not. + + + + + Indicating whether display value from cells values to datalabels. + + + + + Indicating whether value form cells range in datalabels. + + + + + Text area font. + + + + + Chart text record. + + + + + Parent workbook. + + + + + Text frame. + + + + + Text. + + + + + Object link. + + + + + Data labels record. + + + + + Chart ai record. + + + + + Chart Al Runs record represents the rich text format + + + + + Represents chart position record. + + + + + Attached label layout + + + + + Indicates if current text assign to trend object. + + + + + Represents Excel 2007 layout data + + + + + Represents the TextArea Paragraph + + + + + Indicats whether to show text properties or not + + + + + Indicats whether to show text size properties or not + + + + + Indicats whether to show text bold properties or not + + + + + Indicats whether to show text italic properties or not + + + + + Represents RTF string. + + + + + Represents Vertical Text Rotation. + + + + + Indicates whether text is parsed or not + + + + + The array stores the cache information + + + + + Boolean value indicates whether other elements in chart can overlap this text area. + + + + + The list stores the default paragraph properties + + + + + Creates objects sets its Application and Parent properties to specified values. + + Application object. + Parent object. + + + + Creates objects sets its Application and Parent properties to specified values. + + Application object. + Parent object. + Text link. + + + + Searches for all necessary parent objects. + + + + + Generates .Net font object corresponding to the current font. + + Generated .Net font. + + + + Creates frame format. + + Newly created frame format. + + + + Initializes frame format. + + + + + Sets internal font according to the font index. + + Font index to set. + + + + Creates data labels object if necessary. + + + + + Clone current record. + + Parent object for create new instance. + Dictionary with new font indexes. + Dictionary with new worksheet names. + Returns clone of current object. + + + + Creates object that is copy of the current instance. + + Parent object for create new instance. + Returns clone of current object. + + + + Updates Series index. + + Index to set. + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Attaches all necessary events. + + + + + Detaches all events. + + + + + Event handler for color change. + + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Creates rich text string. + + + + + True if the font is bold. Read / write Boolean. + + + + + Returns or sets the primary color of the object. Read / write ExcelKnownColors. + + + + + Gets / sets font color. If there is at least one free color, + define a new color; if not, search for the closest one in + workbook palette. + + + + + True if the font style is italic. Read / write Boolean. + + + + + True if the font is an outline font. Read / write Boolean. + + + + + True if the font is a shadow font or if the object has + a shadow. Read / write Boolean. + + + + + Returns or sets the size of the font. Read / write Variant. + + + + + True if the font is struck through with a horizontal line. + Read / write Boolean + + + + + Gets or sets the offset value of superscript and subscript + + + + + True if the font is formatted as subscript. + False by default. Read / write Boolean. + + + + + True if the font is formatted as superscript. False by default. + Read/write Boolean + + + + + Returns or sets the type of underline applied to the font. Can + be one of the following ExcelUnderlineStyle constants. + Read / write OfficeUnderline. + + + + + Returns or sets the font name. Read / write string. + + + + + Gets / sets font vertical alignment. + + + + + True if the font is set to capitalize, character spacing or kerning value. + + + + + True if the font is set to capitalize. + + + + + Returns or sets the character spacing value of the font. + + + + + Returns or sets the kerning value of the font. + + + + + Gets and sets the indicating wheather baseline have percentage value or not. + + + + + Text. + + + + + Gets rich text. + + + + + Return frame format. Read-only. + + + + + Gets object link record. Read-only. + + + + + Text rotation angle. + + + + + Gets value indicating whether TextRotation was changed. Read-only. + + + + + Represents Vertical Text Rotation. + + + + + Returns chart text record. Read-only. + + + + + Gets / sets number format for the text area. + + + + + Gets index to the number format. Read-only. + + + + + Returns ChartAIRecord for the text area (creates it if necessary). Read-only. + + + + + Return ChartAlRunsRecord for the text area (creates if necessary). Read-only. + + + + + Returns true if contain dataLabels otherwise false. Read-only. + + + + + Display mode of the background. + + + + + True if background is set to automatic. + + + + + Indicates if current text assign to trend object. + + + + + Indicates whether color has automatic color. Read-only. + + + + + Gets or sets Excel 2007 layout data + + + + + Returns parent workbook object. + + + + + Gets / Sets the overlay boolean value + + + + + Represents the TextArea Paragraph + + + + + Gets or sets a value indicating whether to show text properties or not + + + + + Gets or sets a value indicating whether to show text size properties or not + + + + + Gets or sets a value indicating whether to show text bold properties or not + + + + + Gets or sets a value indicating whether to show text italic properties or not + + + + + Gets / Sets the string array + + + + + Indicates whether text area contains text. + + + + + Gets or sets a value indicating whether this instance is formula. + + + true if this instance is formula; otherwise, false. + + + + + Indicats whether text is parsed or not + + + + + Gets and sets boolean value indicating whether display to value from cells value to datalabels. + + + + + Gets and sets indicating whether value from cells range in datalables. + + + + + Indicates whether series name is in data labels. + + + + + Indicates whether category name is in data labels. + + + + + Indicates whether value is in data labels. + + + + + Indicates whether percentage is in data labels. + + + + + Indicates whether bubble size is in data labels. + + + + + Indicates whether Leader Lines is in data labels. + + + + + Delimiter. + + + + + Indicates whether legend key is in data labels. + + + + + Represents data labels position. + + + + + Return attached label layout record. Read-only + + + + + Gets or sets the value indicating whether to show category label and value as percentage. + + + + + Returns textarea's color object. Read-only. + + + + + Returns font index. Read-only. + + + + + Returns FontImpl for current font. Read-only. + + + + + Represents Trend Line Collection. + + + + + Interface that represents trend line collection. + + + + + Adds new instance of trend line to collection. + + Returns added trend line object. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Add trendline to the serie + serieJan.TrendLines.Add(); + //Add trendline with specific type + serieFeb.TrendLines.Add(OfficeTrendLineType.Moving_Average); + //Set the trendline color and weight + serieFeb.TrendLines[0].Border.LineWeight = OfficeChartLineWeight.Wide; + serieFeb.TrendLines[0].Border.LineColor = System.Drawing.Color.Blue; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Specify the chart title + chart.ChartTitle = "Sales Analysis" + 'Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Add trendline to the serie + serieJan.TrendLines.Add() + 'Add trendline with specific type + serieFeb.TrendLines.Add(OfficeTrendLineType.Moving_Average) + 'Set the trendline color and weight + serieFeb.TrendLines(0).Border.LineWeight = OfficeChartLineWeight.Wide + serieFeb.TrendLines(0).Border.LineColor = System.Drawing.Color.Blue + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Adds new instance of trend line to collection with specified type of trend line. + + Represents type of trend line. + Returns added trend line object. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Add trendline to the serie + serieJan.TrendLines.Add(); + //Add trendline with specific type + serieFeb.TrendLines.Add(OfficeTrendLineType.Moving_Average); + //Set the trendline color and weight + serieFeb.TrendLines[0].Border.LineWeight = OfficeChartLineWeight.Wide; + serieFeb.TrendLines[0].Border.LineColor = System.Drawing.Color.Blue; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Specify the chart title + chart.ChartTitle = "Sales Analysis" + 'Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Add trendline to the serie + serieJan.TrendLines.Add() + 'Add trendline with specific type + serieFeb.TrendLines.Add(OfficeTrendLineType.Moving_Average) + 'Set the trendline color and weight + serieFeb.TrendLines(0).Border.LineWeight = OfficeChartLineWeight.Wide + serieFeb.TrendLines(0).Border.LineColor = System.Drawing.Color.Blue + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes trend line object at the specified index from the collection. + + Represents + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Add trendline to the serie + serieJan.TrendLines.Add(); + serieFeb.TrendLines.Add(); + //Add trendline with specific type + serieFeb.TrendLines.Add(OfficeTrendLineType.Moving_Average); + //Get the count of the trendline + int count = serieFeb.TrendLines.Count; + //Get the trendline instance from collection + IOfficeChartTrendLine trendline = serieFeb.TrendLines[0]; + //Set the trendline color and weight + trendline.Border.LineWeight = OfficeChartLineWeight.Wide; + trendline.Border.LineColor = System.Drawing.Color.Blue; + //Remove a trendline object using index + serieFeb.TrendLines.RemoveAt(1); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Specify the chart title + chart.ChartTitle = "Sales Analysis" + 'Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Add trendline to the serie + serieJan.TrendLines.Add() + serieFeb.TrendLines.Add() + 'Add trendline with specific type + serieFeb.TrendLines.Add(OfficeTrendLineType.Moving_Average) + 'Get the count of the trendline + Dim count As Integer = serieFeb.TrendLines.Count + 'Get the trendline instance from collection + Dim trendline As IOfficeChartTrendLine = serieFeb.TrendLines(0) + 'Set the trendline color and weight + trendline.Border.LineWeight = OfficeChartLineWeight.Wide + trendline.Border.LineColor = System.Drawing.Color.Blue + 'Remove a trendline object using index + serieFeb.TrendLines.RemoveAt(1) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Clears trend line collection. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Add trendline to the serie + serieJan.TrendLines.Add(); + serieFeb.TrendLines.Add(); + //Add trendline with specific type + serieFeb.TrendLines.Add(OfficeTrendLineType.Moving_Average); + //Get the count of the trendline + int count = serieFeb.TrendLines.Count; + //Get the trendline instance from collection + IOfficeChartTrendLine trendline = serieFeb.TrendLines[0]; + //Set the trendline color and weight + trendline.Border.LineWeight = OfficeChartLineWeight.Wide; + trendline.Border.LineColor = System.Drawing.Color.Blue; + //Clear the trendlines in serie + serieFeb.TrendLines.Clear(); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Specify the chart title + chart.ChartTitle = "Sales Analysis" + 'Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Add trendline to the serie + serieJan.TrendLines.Add() + serieFeb.TrendLines.Add() + 'Add trendline with specific type + serieFeb.TrendLines.Add(OfficeTrendLineType.Moving_Average) + 'Get the count of the trendline + Dim count As Integer = serieFeb.TrendLines.Count + 'Get the trendline instance from collection + Dim trendline As IOfficeChartTrendLine = serieFeb.TrendLines(0) + 'Set the trendline color and weight + trendline.Border.LineWeight = OfficeChartLineWeight.Wide + trendline.Border.LineColor = System.Drawing.Color.Blue + 'Clear the trendlines in serie + serieFeb.TrendLines.Clear() + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a single instance at the specified index from the collection. Read-only. + + The zero-based index of the element. + Returns the particular trend line based on the index. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Add trendline to the serie + serieJan.TrendLines.Add(); + serieFeb.TrendLines.Add(); + //Add trendline with specific type + serieFeb.TrendLines.Add(OfficeTrendLineType.Moving_Average); + //Get the count of the trendline + int count = serieFeb.TrendLines.Count; + //Get the trendline instance from collection + IOfficeChartTrendLine trendline = serieFeb.TrendLines[0]; + //Set the trendline color and weight + trendline.Border.LineWeight = OfficeChartLineWeight.Wide; + trendline.Border.LineColor = System.Drawing.Color.Blue; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Specify the chart title + chart.ChartTitle = "Sales Analysis" + 'Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Add trendline to the serie + serieJan.TrendLines.Add() + serieFeb.TrendLines.Add() + 'Add trendline with specific type + serieFeb.TrendLines.Add(OfficeTrendLineType.Moving_Average) + 'Get the count of the trendline + Dim count As Integer = serieFeb.TrendLines.Count + 'Get the trendline instance from collection + Dim trendline As IOfficeChartTrendLine = serieFeb.TrendLines(0) + 'Set the trendline color and weight + trendline.Border.LineWeight = OfficeChartLineWeight.Wide + trendline.Border.LineColor = System.Drawing.Color.Blue + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the number of objects in the collection.Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Add trendline to the serie + serieJan.TrendLines.Add(); + serieFeb.TrendLines.Add(); + //Add trendline with specific type + serieFeb.TrendLines.Add(OfficeTrendLineType.Moving_Average); + //Get the count of the trendline + int count = serieFeb.TrendLines.Count; + //Get the trendline instance from collection + IOfficeChartTrendLine trendline = serieFeb.TrendLines[0]; + //Set the trendline color and weight + trendline.Border.LineWeight = OfficeChartLineWeight.Wide; + trendline.Border.LineColor = System.Drawing.Color.Blue; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Specify the chart title + chart.ChartTitle = "Sales Analysis" + 'Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie � start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Add trendline to the serie + serieJan.TrendLines.Add() + serieFeb.TrendLines.Add() + 'Add trendline with specific type + serieFeb.TrendLines.Add(OfficeTrendLineType.Moving_Average) + 'Get the count of the trendline + Dim count As Integer = serieFeb.TrendLines.Count + 'Get the trendline instance from collection + Dim trendline As IOfficeChartTrendLine = serieFeb.TrendLines(0) + 'Set the trendline color and weight + trendline.Border.LineWeight = OfficeChartLineWeight.Wide + trendline.Border.LineColor = System.Drawing.Color.Blue + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents parent series. + + + + + Creates new instance of collection. + + Represents current application. + Represents parent object. + + + + Adds new instance of trend line to collection. + + Returns added trend line object. + + + + Adds new instance of trend line to collection. + + Represents type of trend line. + Returns added trend line object. + + + + Removes trend line object from collection. + + Represents + + + + Checks if current trend line supported negative values. + + Represents trend line types. + + + + Adds trend object to trends collection. + + Represents trend object to add. + + + + Checks series type. If current type does not support trendlines throw exception. + + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Clones current object. + + Represents parent object for new cloned instance. + Represents new font indexes. + Dictionary with new worksheet names. + Returns cloned object. + + + + Gets single trend line by index. Read-only + + + + + Indicates whether object was parsed. + + + + + Represents chart trend line. + + + + + Represents a trend line in a chart. + + + + + Clears the formatting of the trend line. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Add trendline to the serie + serieJan.TrendLines.Add(); + //Get the trendline of serie + IOfficeChartTrendLine trendline = serieJan.TrendLines[0]; + //Set the type of trendline + trendline.Type = OfficeTrendLineType.Polynomial; + //Set the intercept of trendline + trendline.Intercept = 0.8; + //Set the name for trendline + trendline.Name = "Trendline"; + //Set the order + trendline.Order = 3; + //Clear the trendline formats + trendline.ClearFormats(); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Add trendline to the serie + serieJan.TrendLines.Add() + 'Get the trendline of serie + Dim trendline As IOfficeChartTrendLine = serieJan.TrendLines(0) + 'Set the type of trendline + trendline.Type = OfficeTrendLineType.Polynomial + 'Set the intercept of trendline + trendline.Intercept = 0.8 + 'Set the name for trendline + trendline.Name = "Trendline" + 'Set the order + trendline.Order = 3 + 'Clear the trendline formats + trendline.ClearFormats() + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the border of the trend line. Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Bar_Clustered; + //Add trendline to the serie + serieJan.TrendLines.Add(); + //Get the trendline of serie + IOfficeChartTrendLine trendline = serieJan.TrendLines[0]; + //Set the line color of border + trendline.Border.LineColor = System.Drawing.Color.Green; + //Set the line weight + trendline.Border.LineWeight = OfficeChartLineWeight.Medium; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Bar_Clustered + 'Add trendline to the serie + serieJan.TrendLines.Add() + 'Get the trendline of serie + Dim trendline As IOfficeChartTrendLine = serieJan.TrendLines(0) + 'Set the line color of border + trendline.Border.LineColor = System.Drawing.Color.Green + 'Set the line weight + trendline.Border.LineWeight = OfficeChartLineWeight.Medium + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the number of periods (or units on a scatter chart) that the trend line extends backward. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Bar_Clustered; + //Add trendline to the serie + serieJan.TrendLines.Add(); + //Get the trendline of serie + IOfficeChartTrendLine trendline = serieJan.TrendLines[0]; + //Set the backward + trendline.Backward = 0.3; + //Set the line color of border + trendline.Border.LineColor = System.Drawing.Color.Green; + //Set the line weight + trendline.Border.LineWeight = OfficeChartLineWeight.Medium; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Bar_Clustered + 'Add trendline to the serie + serieJan.TrendLines.Add() + 'Get the trendline of serie + Dim trendline As IOfficeChartTrendLine = serieJan.TrendLines(0) + 'Set the backward + trendline.Backward = 0.3 + 'Set the line color of border + trendline.Border.LineColor = System.Drawing.Color.Green + 'Set the line weight + trendline.Border.LineWeight = OfficeChartLineWeight.Medium + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the number of periods (or units on a scatter chart) that the trend line extends forward. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Add trendline to the serie + serieJan.TrendLines.Add(); + //Get the trendline of serie + IOfficeChartTrendLine trendline = serieJan.TrendLines[0]; + //Set the intercept as auto + trendline.InterceptIsAuto = true; + //Set the name as auto + trendline.NameIsAuto = true; + //Set the forward + trendline.Forward = 0.3; + //Set the type of trendline + trendline.Type = OfficeTrendLineType.Logarithmic; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Add trendline to the serie + serieJan.TrendLines.Add() + 'Get the trendline of serie + Dim trendline As IOfficeChartTrendLine = serieJan.TrendLines(0) + 'Set the intercept as auto + trendline.InterceptIsAuto = True + 'Set the name as auto + trendline.NameIsAuto = True + 'Set the forward + trendline.Forward = 0.3 + 'Set the type of trendline + trendline.Type = OfficeTrendLineType.Logarithmic + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that indicates whether the equation for the trend line is displayed on the chart or not. + + Trueif the equation for the trend line is displayed on the chart.Otherwise False. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Add trendline to the serie + serieJan.TrendLines.Add(); + //Get the trendline of serie + IOfficeChartTrendLine trendline = serieJan.TrendLines[0]; + //Set the display equation + trendline.DisplayEquation = true; + //Set the display RSSquared + trendline.DisplayRSquared = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Add trendline to the serie + serieJan.TrendLines.Add() + 'Get the trendline of serie + Dim trendline As IOfficeChartTrendLine = serieJan.TrendLines(0) + 'Set the display equation + trendline.DisplayEquation = True + 'Set the display RSSquared + trendline.DisplayRSquared = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets of sets a value that indicates whether the R-squared value of the trend line is displayed on the chart or not. + + Trueif the R-squared value of the trend line is displayed on the chart.Otherwise False. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Add trendline to the serie + serieJan.TrendLines.Add(); + //Get the trendline of serie + IOfficeChartTrendLine trendline = serieJan.TrendLines[0]; + //Set the display equation + trendline.DisplayEquation = true; + //Set the display RSSquared + trendline.DisplayRSquared = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Add trendline to the serie + serieJan.TrendLines.Add() + 'Get the trendline of serie + Dim trendline As IOfficeChartTrendLine = serieJan.TrendLines(0) + 'Set the display equation + trendline.DisplayEquation = True + 'Set the display RSSquared + trendline.DisplayRSquared = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the point where the trend line crosses the value axis. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Add trendline to the serie + serieJan.TrendLines.Add(); + //Get the trendline of serie + IOfficeChartTrendLine trendline = serieJan.TrendLines[0]; + //Set the type of trendline + trendline.Type = OfficeTrendLineType.Polynomial; + //Set the intercept of trendline + trendline.Intercept = 0.8; + //Set the name for trendline + trendline.Name = "Trendline"; + //Set the order + trendline.Order = 3; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Add trendline to the serie + serieJan.TrendLines.Add() + 'Get the trendline of serie + Dim trendline As IOfficeChartTrendLine = serieJan.TrendLines(0) + 'Set the type of trendline + trendline.Type = OfficeTrendLineType.Polynomial + 'Set the intercept of trendline + trendline.Intercept = 0.8 + 'Set the name for trendline + trendline.Name = "Trendline" + 'Set the order + trendline.Order = 3 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the value that indicates whether the point where the trend line crosses the value + axis is automatically determined by the regression. + + Trueif the point where the trend line crosses the value axis.Otherwise False. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Add trendline to the serie + serieJan.TrendLines.Add(); + //Get the trendline of serie + IOfficeChartTrendLine trendline = serieJan.TrendLines[0]; + //Set the intercept as auto + trendline.InterceptIsAuto = true; + //Set the name as auto + trendline.NameIsAuto = true; + //Set the forward + trendline.Forward = 0.3; + //Set the type of trendline + trendline.Type = OfficeTrendLineType.Logarithmic; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance///Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Add trendline to the serie + serieJan.TrendLines.Add() + 'Get the trendline of serie + Dim trendline As IOfficeChartTrendLine = serieJan.TrendLines(0) + 'Set the intercept as auto + trendline.InterceptIsAuto = True + 'Set the name as auto + trendline.NameIsAuto = True + 'Set the forward + trendline.Forward = 0.3 + 'Set the type of trendline + trendline.Type = OfficeTrendLineType.Logarithmic + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Returns or sets the trend line type + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Add trendline to the serie + serieJan.TrendLines.Add(); + //Get the trendline of serie + IOfficeChartTrendLine trendline = serieJan.TrendLines[0]; + //Set the intercept as auto + trendline.InterceptIsAuto = true; + //Set the name as auto + trendline.NameIsAuto = true; + //Set the forward + trendline.Forward = 0.3; + //Set the type of trendline + trendline.Type = OfficeTrendLineType.Logarithmic; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Add trendline to the serie + serieJan.TrendLines.Add() + 'Get the trendline of serie + Dim trendline As IOfficeChartTrendLine = serieJan.TrendLines(0) + 'Set the intercept as auto + trendline.InterceptIsAuto = True + 'Set the name as auto + trendline.NameIsAuto = True + 'Set the forward + trendline.Forward = 0.3 + 'Set the type of trendline + trendline.Type = OfficeTrendLineType.Logarithmic + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the trend line order (an integer greater than 1) when the trend line type is Polynomial. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Add trendline to the serie + serieJan.TrendLines.Add(); + //Get the trendline of serie + IOfficeChartTrendLine trendline = serieJan.TrendLines[0]; + //Set the type of trendline + trendline.Type = OfficeTrendLineType.Polynomial; + //Set the intercept of trendline + trendline.Intercept = 0.8; + //Set the name for trendline + trendline.Name = "Trendline"; + //Set the order + trendline.Order = 3; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Add trendline to the serie + serieJan.TrendLines.Add() + 'Get the trendline of serie + Dim trendline As IOfficeChartTrendLine = serieJan.TrendLines(0) + 'Set the type of trendline + trendline.Type = OfficeTrendLineType.Polynomial + 'Set the intercept of trendline + trendline.Intercept = 0.8 + 'Set the name for trendline + trendline.Name = "Trendline" + 'Set the order + trendline.Order = 3 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that Indicates whether the name of the trend line is determined automatically or not. + + Trueif Essential presentation automatically determines the name of the trendline.Otherwise False. + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Add trendline to the serie + serieJan.TrendLines.Add(); + //Get the trendline of serie + IOfficeChartTrendLine trendline = serieJan.TrendLines[0]; + //Set the intercept as auto + trendline.InterceptIsAuto = true; + //Set the name as auto + trendline.NameIsAuto = true; + //Set the forward + trendline.Forward = 0.3; + //Set the type of trendline + trendline.Type = OfficeTrendLineType.Logarithmic; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Add trendline to the serie + serieJan.TrendLines.Add() + 'Get the trendline of serie + Dim trendline As IOfficeChartTrendLine = serieJan.TrendLines(0) + 'Set the intercept as auto + trendline.InterceptIsAuto = True + 'Set the name as auto + trendline.NameIsAuto = True + 'Set the forward + trendline.Forward = 0.3 + 'Set the type of trendline + trendline.Type = OfficeTrendLineType.Logarithmic + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets name of the trend line. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Add trendline to the serie + serieJan.TrendLines.Add(); + //Get the trendline of serie + IOfficeChartTrendLine trendline = serieJan.TrendLines[0]; + //Set the type of trendline + trendline.Type = OfficeTrendLineType.Polynomial; + //Set the intercept of trendline + trendline.Intercept = 0.8; + //Set the name for trendline + trendline.Name = "Trendline"; + //Set the order + trendline.Order = 3; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Add trendline to the serie + serieJan.TrendLines.Add() + 'Get the trendline of serie + Dim trendline As IOfficeChartTrendLine = serieJan.TrendLines(0) + 'Set the type of trendline + trendline.Type = OfficeTrendLineType.Polynomial + 'Set the intercept of trendline + trendline.Intercept = 0.8 + 'Set the name for trendline + trendline.Name = "Trendline" + 'Set the order + trendline.Order = 3 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the data label that is associated with the trendline.Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Bar_Clustered; + //Add trendline to the serie + serieJan.TrendLines.Add(); + //Get the trendline of serie + IOfficeChartTrendLine trendline = serieJan.TrendLines[0]; + //Set the bold font style for data label + trendline.DataLabel.Bold = true; + //Set the color of data label + trendline.DataLabel.Color = OfficeKnownColors.Red; + //Set the font name + trendline.DataLabel.FontName = "Helvetica"; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie � start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series � start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Bar_Clustered + 'Add trendline to the serie + serieJan.TrendLines.Add() + 'Get the trendline of serie + Dim trendline As IOfficeChartTrendLine = serieJan.TrendLines(0) + 'Set the bold font style for data label + trendline.DataLabel.Bold = True + 'Set the color of data label + trendline.DataLabel.Color = OfficeKnownColors.Red + 'Set the font name + trendline.DataLabel.FontName = "Helvetica" + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the shadow that is associated with the trendline.Read-only. + + The shadow. + + + + Gets the chart3D options that is associated with the trendline.Read-only. + + The chart3 D options. + + + + Represents max order value for polynomial trend line type. + + + + + Represents name hash table + Key - trend line type, Value - legend string. + + + + + Represents main trend line record. + + + + + Represents Shadow + + + + + Represents border object. + + + + + Represents parent series. + + + + + Represents trend line type. + + + + + Indicates if name is auto. + + + + + Represents custom name. + + + + + Represents text area for data label. + + + + + Represents some unique ID. + + + + + Represents the 3D features + + + + + Represents the chart Legend Entry + + + + + Initialize all static members. + + + + + Creates new instance of object. + + Represents current application. + Represents parent object. + + + + Finds parent objects. + + + + + Clears current trend line. + + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Checks some records properties. + + + + + Check if current trend support intercept property, if failed throws exception. + + + + + Check if current trend support backward property, if failed throws exception. + + Represents value. + + + + Changes trend line type. + + Represents new trend line type. + + + + Updates data labels + + Represents flag for updates. + + + + Clones current object. + + Represents parent object for new cloned instance. + Represents new font indexes. + Dictionary with new worksheet names. + Returns cloned object. + + + + Represents LegendEntry object + + + + + Represents border object. Read-only. + + + + + Represents the Shadow.Read-only + + + + + Gets the chart3 D options. + + The chart3 D options. + + + + Represents number of periods that the trend line extends backward. + + + + + Represents number of periods that the trend line extends forward. + + + + + True if the equation for the trend line is displayed on the chart. + + + + + True if the R-squared value of the trend line is displayed on the chart. + + + + + Represents point where the trend line crosses the value axis. + + + + + True if the point where the trend line crosses the value + axis is automatically determined by the regression. + + + + + Represents trend line type. + + + + + Represents for Moving Average and Polynomial trend line type order value. + + + + + Indicates if name is default. + + + + + Represents trend line name. + + + + + Returns data label. Read-only. + + + + + Represents chart walls or floor. + + + + + Represents the walls or floors of a 3-D chart. + + + + + Gets or Sets the thickness of the walls or floor. + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get a bubble chart from the slide + IPresentationChart chart = presentation.Slides[0].Charts[0]; + //Change the chart type to 3D + chart.ChartType = OfficeChartType.Bar_Clustered_3D; + //Get the side wall of chart + IOfficeChartWallOrFloor sideWall = chart.SideWall; + //Set the picture unit of side wall + sideWall.PictureUnit = OfficeChartPictureType.stretch; + //Set the thickness + sideWall.Thickness = 40; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or Sets the pictureType in walls or floor + + + + //Open a presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get a bubble chart from the slide + IPresentationChart chart = presentation.Slides[0].Charts[0]; + //Change the chart type to 3D + chart.ChartType = OfficeChartType.Bar_Clustered_3D; + //Get the side wall of chart + IOfficeChartWallOrFloor sideWall = chart.SideWall; + //Set the picture unit of side wall + sideWall.PictureUnit = OfficeChartPictureType.stretch; + //Set the thickness + sideWall.Thickness = 40; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Represents default line color for walls or plot. + + + + + Represents default color index for walls or plot. + + + + + Represents default line color for floor. + + + + + Represents default foreground color for walls or plot. + + + + + Represents default background color index for walls or plot. + + + + + Represents default value background color index. + + + + + Represents default value foreground color index. + + + + + Indicates if wall or floor object. + + + + + Represents chart interior. + + + + + Represents parent chart + + + + + Represents the Shadow + + + + + Represents the 3D features + + + + + Represents fill properties. + + + + + Indicates if shape properties for the wall or flooe. + + + + + It specifies the thickness of the walls or floor as a percentage of the largest dimension of the plotarea. + + + + + It specifies the pictureformat struct or stretch + + + + + Creates ChartWallsOrFloor object. + + Application object. + Parent object. + If true - represents walls; otherwise - floor. + + + + Clears current walls or floor. + + + + + Sets to default floor or walls. + + + + + Sets as default line record in category axis. + + + + + Sets as default line record in value axis. + + + + + Sets as default area record in category axis. + + + + + Sets as default area record in value axis. + + + + + Clones current object. + + Parent object. + Returns cloned object. + + + + Represents chart interior. + + + + + Represents the Shadow.Read-only + + + + + + This property indicates whether the shadow object has been created + + + + + + Indicates whether Shape properties has been created. + + + true if this instance has shape properties; otherwise, false. + + + + + Returns or sets the thickness of the walls or floor as a percentage of the largest dimension of the plot area. + + The thickness. + + + + Gets or Sets the picture format of the walls or floor + + + + + Gets the chart3 D options. + + The chart3 D options. + + + + This property Indicates whether the Shadow object has been created(which includes the 3D properties) + + + + + Represents fill properties. Read-only. + + + + + This property indicates whether interior object was created. Read-only. + + + + + Represents foreground color. + + + + + Represents background color. + + + + + Represents pattern. + + + + + Represents if use automatic format. + + + + + Represents visible. + + + + + Represents frame format each record is wrapped by ChartWrapperRecord. + + + + + Initializes new instance of ChartWrappedFrameFormat. + + Application object. + Parent object. + + + + Represents chart text area, each record is wrapped into ChartWrappedRecord. + + + + + Unknown bytes. Needed for data labels serialization. + + + + + Unknown end. + + + + + Initializes new instance. + + Application object. + Parent object. + + + + Creates objects sets its Application and Parent properties to specified values. + + Application object. + Parent object. + Text link. + + + + Creates frame format. + + Newly created frame format. + + + + Summary description for ArrayListEx. + + + + + Represents item storage. + + + + + Represents count of elements. + + + + + Creates new instance current collection. + + + + + Creates new instance of current collection. + + Represents count. + + + + Updates count of storage array. + + Represents count of array to update. + + + + Reduces size of the internal array if necessary. + + Maximum size of the internal array. + + + + Inserts specified number of null RowStorages into specified position. + + Index to insert into. + Number of items to insert. + Number of items after index position to preserve. + + + + Get Maximum Row Count + + + + + + Get Row Index in Row Storage Based on the row number + + RowNumber + RowIndex in RowStorage + + + + + Gets value by index. + + + + + Borders collection. + + + + + A collection of four Border objects that represent the four + borders of a Range or Style object. + + + + + Returns or sets the primary color of the object, as shown in the + following table. Use the RGB function to create a color value. + Read / write ExcelKnownColors. + + + + + Returns or sets the primary color of the object, as shown in the + following table. Use the RGB function to create a color value. + Read / write Color. + + + + + Returns the number of objects in the collection. Read-only, Long. + + + + + Returns a Border object that represents one of the borders of either a + range of cells or a style. + + + + + Returns or sets the line style for the border. Read / write OfficeLineStyle. + + + + + Synonym for Borders.LineStyle. Read / write. + + + + + Parent workbook. + + + + + Specifies a boolean value that indicate whether the border collection has a empty border + + + + + Creates collection and sets its application and parent properties. + + Application object for this collection. + The parent object for this collection. + Indicates whether null elements must be added to internal array. + + + + Creates collection taking borders from ExtendedFormatImplWrapper. + + The application object for the collection. + The parent object for the collection. + + ExtendedFormatImplWrapper from where all borders will be taken. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns or sets the primary color of the object. + Read / write ExcelKnownColors. + + + + + Returns or sets the primary color of the object. Use the RGB function to create a color value. + Read / write ExcelKnownColors. + + + + + Returns a Border object that represents one of the borders of either a + range of cells or a style. Read-only. + + + + + Returns or sets the line style for the border. + Read / write OfficeLineStyle. + + + + + Synonym for Borders.LineStyle. Read / write OfficeLineStyle. + + + + + Specifies a boolean value that indicate whether the border collection has a empty border + + + + + Contains borders for range that contains more than one cell. + + + + + All cells of the range. + + + + + Parent workbook. + + + + + Application. + + + + + Creates instances for specified range. + + Range for which instance must be created. + + + + Creates instances for specified range. + + Range for which instance must be created. + + + + + + + + + Returns or sets the primary color of the object, as shown in the + following table. Use the RGB function to create a color value. + Read / write ExcelKnownColors. + + + + + Returns or sets the primary color of the object, as shown in the + following table. Use the RGB function to create a color value. + Read / write color. + + + + + Returns a Border object that represents one of the borders of either a + range of cells or a style. + + + + + Returns or sets the line style for the border. Read / write OfficeLineStyle. + + + + + Synonym for Borders.LineStyle. Read / write Variant. + + + + + Summary description for CellRecordCollection. + + + + + Table with cell records. + + + + + Table with created ranges. + + + + + Parent worksheet. + + + + + Parent workbook. + + + + + Indicates whether we should use ranges cache or not. + + + + + Record extractor to get Biff records from. + + + + + Initializes new instance of the collection. + + Application object for the collection. + Parent object for the collection. + + + + Searches for all necessary parent objects. + + + + + Removes all elements from the IDictionary. + + + + + Adds an element with the provided key and value to the IDictionary. + + The Object to use as the key of the element to add. + The Object to use as the value of the element to add. + + + + Returns an IDictionaryEnumerator for the IDictionary. + + An IDictionaryEnumerator for the IDictionary. + + + + Removes the element with the specified key from the IDictionary. + + The key of the element to remove. + + + + Determines whether the IDictionary contains an element with the specified key. + + The key to locate in the IDictionary. + True if the IDictionary contains an element with the key; otherwise, False. + + + + Returns an IDictionaryEnumerator for the IDictionary. + + An IDictionaryEnumerator for the IDictionary. + + + + Adds an element with the provided key and value to the IDictionary. + + The Object to use as the key of the element to add. + The Object to use as the value of the element to add. + + + + Adds an specified cell to the IDictionary. + + The Object to use as the value of the element to add. + + + + Removes the element with the specified key from the IDictionary. + + The key of the element to remove. + + + + Removes the element with the specified key from the IDictionary. + + One-based row index of the cell to remove. + One-based column index of the cell to remove. + + + + Determines whether collection contains row. + + Zero-based row index. + True if the collection contains at least one element with specified row index; otherwise, False. + + + + Determines whether the IDictionary contains an element with the specified key. + + The key to locate in the IDictionary. + True if the IDictionary contains an element with the key; otherwise, False. + + + + Determines whether the IDictionary contains an element with the specified key. + + One-based row index of the cell to locate. + One-based column index of the cell to locate. + True if the IDictionary contains an element with the key; otherwise, False. + + + + Copies the elements of the ICollection to an Array, starting at a particular Array index. + + + The one-dimensional Array that is the destination of the elements copied + from ICollection. The Array must have zero-based indexing. + + The zero-based index in array at which copying begins. + + + + Adds record to the collection. + + Record to add. + Indicates whether to ignore styles. + + + + Adds record to the collection. + + Record to add. + Indicates whether to ignore styles. + + + + Adds MulRKRecord to the records collection. + + Record to add. + Indicates whether to ignore styles. + + + + Adds MulBlankRecord to the records collection. + + Record to add. + Indicates whether to ignore styles. + + + + Adds formula record and its string value. + + Formula record to add. + String value to add. + Indicates whether styles should be ignored. + + + + Indicates whether specified formula is complex + and requires range object to be created for it. + + FormulaRecord to check. + + True if specified formula is complex and requires + range object to be created for it. + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Sets cell range. + + Cell key. + Range to set. + + + + Sets cell range. + + One-based row index. + One-based column index. + Range to set. + + + + Returns cell range. + + Cell key. + Corresponding cell range. + + + + Returns cell range. + + One-based row index. + One-based column index. + Corresponding cell range. + + + + Sets cell record. + + Cell key. + Cell to set. + + + + Sets cell record. + + One-based row index. + One-based column index. + Cell to set. + + + + Returns cell record. + + Cell key. + Corresponding cell record. + + + + Returns cell record. + + One-based row index. + One-based column index. + Corresponding cell record. + + + + Clears range in the dictionary that corresponds to the specified range. + + Rectangle to clear. + + + + Copies cells from another worksheet. + + Source cells collection to copy cells from. + + Dictionary with changes in style indexes, + key - old style index, + value - new style index. + + Dictionary with changes in worksheet names. + Dictionary with new extended format indexes. + Dictionary with new name indexes. + Dictionary with new font indexes. + + + + Returns string value associated with specified cell index. + + Index to cell. + Indicates whether we are interested in correct height or width. + String value associated with specified cell index. + + + + Returns string value associated with specified cell index. + + Index to cell. + Indicates whether we are interested in correct height or width. + String object to fill. + String value associated with specified cell index. + + + + + + Cell index. + Indicates whether we are interested in correct height or width. + + + + + Fills rich text string object with string data. + + Record to get data from. + Indicates whether we are interested in correct height or width. + String to fill. + + + + Returns text value. + + Cell index. + Text value if appropriate record was found; otherwise - empty string. + + + + Gets error value by cell index. + + Cell index. + Returns string that represents error value. + + + + Gets bool value by cellindex. + + Cell index. + Returns value by cell index. + If true than value is correct; otherwise incorrect. + + + + Returns cell value by cell index. + + Cell index. + Cell value if appropriate record was found; otherwise returns double.MinValue. + + + + Returns cell value by cell index without formula value. + + Cell index. + Cell value if appropriate record was found; otherwise returns double.MinValue. + + + + Returns formula value. + + Cell index. + Formula value if appropriate record was found; otherwise double.MinValue. + + + + Sets string formula value. + + Cell index. + String value to set. + + + + Returns string formula value. + + Cell index. + String formula value. + + + + Gets date time by cell index. + + Cell index. + Returns date time or null. + + + + Returns minimum used row. + + Start column. + End column. + Minimum used row. + + + + Returns maximum used row. + + Start column. + End column. + maximum used row. + + + + Returns minimum used column. + + One-based index of the start row. + One-based index of the end row. + One-based index of the minimum used column. + + + + Returns maximum used column. + + Start row. + End row. + Maximum used column. + + + + Gets formula value by cell index. + + Cell index. + Returns formula value or null. + + + + Gets formula value by cell index. + + Cell index. + If true - returns in R1C1 notations. + Returns formula value or null. + + + + Gets formula value by cell index. + + Cell index. + If true - returns in R1C1 notations. + Represents number info. Can be null. + Returns formula value or null. + + + + Gets string value by cell index. + + Cell Index. + Returns string value or empty string. + + + + Gets extended format index by cell index. + + Cell index. + Returns extended format index or int.MINVALUE. + + + + Gets extended format index by cell index. + + One-based row index. + One-based column index + Returns extended format index or int.MinValue if not found. + + + + Gets extended format index of the row. + + One-based row index. + Returns extended format index or int.MinValue if not found. + + + + Gets extended format index of the column. + + One-based column index. + Returns extended format index or int.MinValue if not found. + + + + Gets font by cell index. + + Cell index. + Returns font or null. + + + + Copies style from one cell into another. + + One-based row index of the source cell. + One-based column index of the source cell. + One-based row index of the destination cell. + One-based column index of the destination cell. + + + + Sets number value. + + Represents column index. One-based. + Represents row index. One-based. + Represents number value. + Represents xf index. + + + + Sets boolean value. + + Represents column index. One based + Represents row index. One based. + Represents boolean value. + + + + Sets boolean value. + + Cell index. + Represents boolean value. + + + + Sets boolean value. + + Represents column index. One-based. + Represents row index. One-based. + Represents boolean value. + Represents xf index. + + + + Sets error value. + + Represents column index. One based. + Represents row index. One based. + Represents error value. + + + + Sets error value. + + Cell index. + Represents error value. + + + + Sets error value. + + Represents column index. One based. + Represents row index. One based. + Represents error value. + Represents xf index. + + + + Sets error value. + + Represents column index. One based. + Represents row index. One based. + Represents error code. + Represents xf index. + + + + Sets formula value. + + Represents column index. One based. + Represents row index. One based. + Represents formula to set. + Represents extended format index. + + + + Sets formula value. + + Represents column index. One based. + Represents row index. One based. + Represents formula to set. + Represents extended format index. + If true - value in R1C1 notation. + Represent number format info, can be null. + + + + Sets formula value. + + Represents column index. One based. + Represents row index. One based. + Represents formula to set. + Represents extended format index. + If true - value in R1C1 notation. + + + + Sets formula value. + + Represents column index. One based. + Represents row index. One based. + Represents formula to set. + Represents extended format index. + If true - value in R1C1 notation. + If true - parse formula. + Represent number format info, can be null. + + + + Sets blank value. + + Represents column index. One based. + Represents row index. One based. + Represents extended format index. + + + + Sets RTF value. + + Represents column index. One based. + Represents row index. One based. + Represents extended format index. + Represents rtf to set. + + + + Sets string value from existing SST collection. + + Represents column index. One based. + Represents row index. One based. + Represents extended format index. + Represents SST index + + + + Sets cell to the non-SST string record (LabelRecord). + + One-based row index. + One-based column index. + Extended format index. + String value to set. + + + + Free's range object. + + One-based row index of the range object to remove from internal cache. + One-based column index of the range object to remove from internal cache. + + + + Removes all data saving cells formatting. + + + + + Sets array formula. + + Record to set. + + + + Returns array record corresponding to the cell + + One-based row index of the cell to get ArrayRecord for. + One-based column index of the cell to get ArrayRecord for. + Corresponding array record. + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + Removes last column from the worksheet. + + One-based column index. + + + + Updates indexes to named ranges. + + Parent workbook. + New indexes. + + + + Replaces all shared formula with ordinary formula. + + + + + Updates string indexes. + + List with new indexes. + + + + Returns found values or null. + + Storage range. + Value to find. + If true - finds first value; otherwise - all values. + If findfirst - true then returns range; otherwise - array with all found values. + List with cell indexes that contains specified value. + + + + Returns found values or null. + + Storage range. + Value to find. + If true - finds first value; otherwise - all values. + Way to find + If findfirst - true then returns range; otherwise - array with all found values. + + List with cell indexes that contains specified value. + + + + + Returns found values or null. + + Storage range. + Value to find. + If true - finds first value; otherwise - all values. + If findfirst - true then returns range; otherwise - array with all found values. + List with cell indexes that contains specified value. + + + + Returns found values or null. + + Storage range. + Value to find. + Indicates whether we should look for error code or boolean value. + If findfirst - true then returns range; otherwise - array with all found values. + List with cell indexes that contains specified value. + + + + + + + + + + Caches and removes specified rectangle from the table. + + Source range. + Row delta to add to the resulting table. + Column delta to add to the resulting table. + Output maximum zero-based row index. + Output maximum zero-based column index. + Cached table. + + + + This method should be called immediately after extended format removal. + + Dictionary with updated extended formats. + + + + This method should be called immediately after extended format removal. + + Array with updated extended formats. + + + + This method updates indexes to the extended formats after version change. + + New restriction for maximum possible XF index. + + + + Sets cell style. + + One-based row index. + One-based column index. + Index of the extended format to set. + + + + Sets row style. + + One-based row index. + Index of the extended format to set. + + + + Looks through all records and calls AddIncrease for each LabelSST record. + + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Parses bool or error value from formula value. + + Represents formula record. + Returns value string. + + + + Creates internal cache for range objects. + + + + + Updates sheet references in the formula. + + Formula to update. + Dictionary with new worksheet names. + Source workbook. + + + + Copies string records. + + Source collection with strings to copy. + + + + Returns format applied to the cell. + + Cell index. + Format applied to the cell. + + + + Returns font applied to the cell. + + Cell index. + Font applied to the cell. + + + + Gets new index of an extended format. + + Old index of the extended format. + Dictionary with new extended format indexes. + Copy range options. + New index of the extended format. + + + + Updates LabelSST indexes after SST record parsing. + + Dictionary with indexes to update, key - old index, value - new index. + + + + Fills string object with data. + + String object to fill. + Index in the shared strings table. + + + + Returns cell type. + + One-based row index. + One-based column index. + + + + This method is called when object is about to be disposed. + + + + + Searches for the record of specified type. + + Record type to look for. + One-based index to the row to look at. + One-based index of the column to start looking at. + One-based index of the column to end looking at. + Column index that contains record of the specified type or value beyond iLastCol if not found. + + + + Returns first used row. Read-only. + + + + + Returns last used row. Read-only. + + + + + Represents parent worksheet. + + + + + Table with cell records. Read-only. + + + + + Indicates whether we should use ranges cache or not. Default value if false. + + + + + + + + + + + + + + + Returns number of elements in the collection. Read-only. + + + + + Gets a value indicating whether the IDictionary has a fixed size. Read-only. + + + + + Gets a value indicating whether the IDictionary is read-only. Read-only. + + + + + Gets an ICollection containing the keys of the IDictionary. Read-only. + + + + + Gets an ICollection containing the values in the IDictionary. Read-only. + + + + + Gets or sets the element with the specified key. + + + + + Gets or sets the element with the specified key. + + + + + Gets or sets the element with the specified one-based row and column indexes. + + + + + Gets a value indicating whether access to the ICollection is synchronized. Read-only. + + + + + Gets an object that can be used to synchronize access to the ICollection. Read-only. + + + + + Represents collection of all extended formats in the workbook. + + + + + Number of default extended formats. + + + + + Dictionary with all formats in the collection. + Key - ExtendedFormatImpl, value - same format. + + + + + Creates collection and sets its Application and Parent values. + + + Application object that represents the Excel application. + + Parent object of this collection. + + + + Adds format into collection. + + Format to add. + + If there is same format in the collection, this method will return it; + otherwise format that was passed as argument will be added. + + + + + Adds format into collection. + + Format to add. + Format that was added. + + + + Adds index to the collection. + + Dictionary to add index to. + List with extended formats. + Index to add. + + + + Creates copy of the current instance. + + Parent object for the new collection. + Copy of the current instance. + + + + Sets maximum possible count of extended formats in the collections. + Updates ParentIndex and overall number of extended formats if necessary. + + New value of maximum possible extended formats. + + + + + + + + + + + Returns single entry from the collection. Read-only. + + + + + Returns parent workbook object. Read-only. + + + + + Collection of external workbooks in the worksheet. + + + + + Default options of StdDocumnt extern name. + + + + + Sheet index for non-existing sheet. + + + + + This URL is written by MS Excel 2003 when referenced file is closed before saving workbook. + + + + + Parent workbook. + + + + + Dictionary key - extern workbook url, value - corresponding extern workbook. + + + + + Dictionary key - short name of the workbook, value - workbook. + + + + + Creates collection with specified Application and Parent. + + Application object for the collection. + Parent object for the collection. + + + + Adds workbook into collection. + + Book to add. + Index of the new workbook. + + + + + + + + + + + + + + Adds new workbook into collection + + Workbook to add. + Index of the new workbook. + + + + Inserts SupbookRecord describing this workbook. + + + Index to the SupBookRecord that describes current workbook. + + + + + Checks whether any of books in this collection contains extern name. + + Name to search. + True if name was found; false otherwise. + + + + Checks whether any of books in this collection contains extern name. + + Name to search. + Output extern workbook index. + Output name index. + True if name was found; false otherwise. + + + + Returns extern workbook with specified short name. + + Short name to find. + + Extern workbook that corresponds to the specified short name; + or Null if there isn't such workbook. + + + + + Sets all necessary parent objects. + + + + + Returns first index of current book in collection. + + Returns first index of current book in collection. + + + + + + + + + + + Tries to find corresponding workbook or creates new if not found. + + Name of the workbook file. + Path to the workbook. + Found or created extern workbook. + + + + Frees all allocated unmanaged resources. + + + + + Returns single extern workbook from the collection. + + + + + Returns single extern workbook from the collection. + + + + + Summary description for ExternNamesCollection. + + + + + Parent extern workbook. + + + + + Hash table with all names. + + + + + Sometimes different applications (not MS Excel) can create duplicated + extern names, we have to remember all of them and after parsing remove it. + + + + + Creates collection with specified Application and Parent. + + Application object for the collection. + Parent object for the collection. + + + + Searches for all necessary parents. + + + + + Adds new name to the collection. + + Name to add. + Index of added extern name. + + + + Adds new name to the collection. + + Name to add. + Index of added extern name. + + + + Checks if collection contains extern name with specified name. + + Name to find. + Boolean value indicating whether collection contains extern name. + + + + Return index to the extern name. + + Name to locate. + Index to the extern name, or -1 if name was not found. + + + + Creates copy of the collection. + + Parent object for the new collection. + + + + + + + + + + + + + + + + + + + Returns extern name. Read-only. + + + + + Returns extern name. Read-only. + + + + + Summary description for FontsCollection. + + + + + Parent workbook. + + + + + + + + + + Creates collection with specified Application and Parent. + + Application object for the collection. + Parent object for the collection. + + + + Adds font to collection. + + Font to add. + Added font. + + + + Inserts default fonts into collection. + + + + + Searches for all necessary parents. + + + + + Forces add to the collection even if same font is already in the collection. + + Font to add. + + + + Saves fonts collection as a set of biff records. + + OffssetArrayList that will receive biff records. + + + + Indicates whether such font is in collection. + + Font to search. + True if such font is present in the collection, false otherwise. + + + + Creates copy of the fonts collection. + + Parent workbook for the new collection. + Copy of this collection. + + + + Returns single font from collection. + + + + + Represents collection of formats in the workbook. + + + + + Represents the Decimal Seprator. + + + + + Represents the Thousand seprator. + + + + + Represents the percentage in decimal numbers. + + + + + Represents the fraction symbol. + + + + + Represents the index of the date format. + + + + + Represents the time separator. + + + + + Represents the Exponenet Symbol. + + + + + Represents the Minus symbol. + + + + + Represents the Currency Symbol. + TODO: support currency based on the Culture. + + + + + Index to the first user-defined number format. + + + + + Japan code. + + + + + Represents the collection of DateFormats. + + + + + Default format strings. + + + + + Default currency format strings. + + + + + Default currency format . + + + + + Index-to-FormatImpl. + + + + + Dictionary. Key - format string, value - FormatImpl. + + + + + Format parser. + + + + + Represent the indexes of the Raw Formats. + + + + + Number Formats Taken. + + + + + Dictionary. Key - currency symbol , value - currency format string. + + + + + Initializes new instance and sets its application and parent objects. + + Application object to set. + Parent object to set. + + + + Adds new format to the collection. + + Format to add. + + + + + + + + + + + + + + + + + Creates copy of the current instance. + + Parent object for the new collection. + Copy of the current instance. + + + + Method that creates format object based on the format string + and registers it in the workbook. + + Format string for the new format record. + Index of created format. + + + + Gets customized datetime format string of user input format string, inaccordance with MS Excel behaviour + + + + + + + Determines whether the IDictionary contains an element with the specified format. + + Format to locate in the collection. + True if the collection contains an element with the key; otherwise, False. + + + + Searches for format with specified format string + and creates one if a match is not found. + + String describing needed format. + Found or created format. + + + + Inserts all default formats into list. + + + + + Gets all used formats. + + Array that contains all used format records. + + + + Returns an IDictionaryEnumerator for the IDictionary. + + An IDictionaryEnumerator for the IDictionary. + + + + Determines whether the IDictionary contains an element with the specified key. + + The key to locate in the IDictionary. + True if the IDictionary contains an element with the key; otherwise, False. + + + + Removes all elements from the IDictionary. + + + + + Returns single entry from the collection. Read-only. + + + + + Gets or Sets a value indicating whether worksheet contains number formats. + + + + + Returns single entry from the collection by format string. Read-only. + + + + + Returns format parser. Read-only. + + + + + Gets currency format string. Read-only. + + + + + Gets the number of elements contained in the collection. Read-only + + + + + Summary description for BorderGroup. + + + + + Border index. + + + + + Parent style group. + + + + + Creates new instance of the group. + + Application object for the new group. + Parent object for the new group. + Border index. + + + + Searches for all necessary parent objects. + + + + + Returns single entry from the group. Read-only. + + + + + Returns number of elements in the group. Read-only. + + + + + Returns or sets the primary color of the object. + Read/write Long. + + + + + Returns or sets the primary color of the object. + Read/write Long. + + + + + Returns color of the border. + + + + + Returns or sets the line style for the border. Read/write OfficeLineStyle. + + + + + This property is used only by Diagonal borders. For any other border + index property will have no influence. + + + + + Summary description for BordersGroup. + + + + + Parent style group. + + + + + Creates new instance of the group. + + Application object for the new group. + Parent object for the new group. + + + + Searches for all necessary parent objects. + + + + + Returns single entry from the group. Read-only. + + + + + Returns number of elements in the group. Read-only. + + + + + Returns or sets the primary color of the object. + Read / write ExcelKnownColors. + + + + + Returns or sets the primary color of the object, as shown in the + following table. Use the RGB function to create a color value. + Read / write Color. + + + + + Returns the number of objects in the collection. Read-only, Long. + + + + + Returns a Border object that represents one of the borders of either a + range of cells or a style. + + + + + Returns or sets the line style for the border. Read / write OfficeLineStyle. + + + + + Synonym for Borders.LineStyle. Read / write. + + + + + Summary description for FontGroup. + + + + + Parent range group. + + + + + Creates new instance of the group. + + Application object for the new group. + Parent object for the new group. + + + + Searches for all necessary parent objects. + + + + + Generates .Net font object corresponding to the current font. + + Generated .Net font. + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Returns single entry from the group. Read-only. + + + + + Returns number of elements in the group. Read-only. + + + + + True if the font is bold. Read / write Boolean. + + + + + Returns or sets the primary color of the object. Read / write ExcelKnownColors. + + + + + Gets / sets font color. Searches for the closest color in + the workbook palette. + + + + + True if the font style is italic. Read / write Boolean. + + + + + True if the font is an outline font. Read / write Boolean. + + + + + True if the font is a shadow font or if the object has + a shadow. Read / write Boolean. + + + + + Returns or sets the size of the font. Read / write Variant. + + + + + True if the font is struck through with a horizontal line. + Read / write Boolean + + + + + True if the font is formatted as subscript. + False by default. Read / write Boolean. + + + + + True if the font is formatted as superscript. False by default. + Read/write Boolean + + + + + Returns or sets the type of underline applied to the font. Can + be one of the following ExcelUnderlineStyle constants. + Read / write OfficeUnderline. + + + + + Returns or sets the font name. Read / write string. + + + + + Gets / sets font vertical alignment. + + + + + Indicates whether color is automatically selected. Read-only. + + + + + Summary description for PageSetupGroup. + + + + + Represents the page setup description. The PageSetup object + contains all page setup attributes (left margin, bottom margin, + paper size, and so on) as properties. + + + + + Indicates whether summary rows will appear below detail in outlines. + + + + + Indicates whether summary columns will appear right of the detail in outlines. + + + + + Indicates whether fit to page mode is selected. + + + + + Parent group of worksheets. + + + + + Initializes new instance and sets its application and parent properties. + + Application object for the new instance. + Parent object for the new instance. + + + + Looks for all necessary parent objects. + + + + + Indicates whether summary rows will appear below detail in outlines. + + + + + Indicates whether summary columns will appear right of the detail in outlines. + + + + + Indicates whether fit to page mode is selected. + + + + + Returns or sets the center part of the footer. Read / write String. + + + + + Returns or sets the center part of the header. Read / write String. + + + + + Returns or sets the left part of the footer. Read / write String. + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + + + + + Returns or sets the left part of the header. Read / write String. + + + + + Portrait or landscape printing mode. Read / write OfficePageOrientation. + + + + + Returns or sets the right part of the footer. Read / write String. + + + + + Returns or sets the right part of the header. Read / write String. + + + + + Summary description for RangeGroup. + + + + + Represents a cell, row, column, selection of cells + containing one or more contiguous blocks of cells, + or a 3-D range. + + + + + Clear the contents of the Range. + + + + + Returns intersection of this range with the specified one. + + The Range with which to intersect. + Range intersection; if there is no intersection, NULL is returned. + + + + Autofits all columns in the range. + + + + + Returns the range reference in the language of the macro. + Read-only String. + + + + + Returns the range reference for the specified range in the language + of the user. Read-only String. + + + + + Returns range Address in format "'Sheet1'!$A$1". + + + + + Returns the range reference using R1C1 notation. + Read-only String. + + + + + Returns the range reference using R1C1 notation. + Read-only String. + + + + + Gets / sets boolean value that is contained by this range. + + + + + Returns a Borders collection that represents the borders of a style + or a range of cells (including a range defined as part of a + conditional format). + + + + + Returns a Range object that represents the cells in the specified range. + Read-only. + + + + + Returns the number of the first column in the first area in the specified + range. Read-only. + + + + + Column group level. Read-only. + -1 - Not all columns in the range have same group level. + 0 - No grouping, + 1 - 7 - Group level. + + + + + Returns or sets the width of all columns in the specified range. + Read/write Double. + + + + + Returns the number of objects in the collection. Read-only. + + + + + Gets / sets DateTime contained by this cell. Read-write DateTime. + + + + + Returns cell value after number format application. Read-only. + + + + + Returns a Range object that represents the cell at the end of the + region that contains the source range. + + + + + Returns a Range object that represents the entire column (or + columns) that contains the specified range. Read-only. + + + + + Returns a Range object that represents the entire row (or + rows) that contains the specified range. Read-only. + + + + + Gets / sets error value that is contained by this range. + + + + + Returns or sets the object's formula in A1-style notation and in + the language of the macro. Read/write Variant. + + + + + Represents array formula which can perform multiple calculations on one or more of the items in an array. + + + + + Returns or sets the formula array for the range, using R1C1-style notation. + + + + + True if the formula will be hidden when the worksheet is protected. + False if at least part of formula in the range is not hidden. + + + + + Get / set formula DateTime value contained by this cell. + DateTime.MinValue if not all cells of the range have same DateTime value. + + + + + Returns or sets the formula for the range, using R1C1-style notation. + + + + + Returns the calculated value of the formula as a boolean. + + + + + Returns the calculated value of the formula as a string. + + + + + Indicates whether range contains bool value. Read-only. + + + + + Indicates whether range contains DateTime value. Read-only. + + + + + True if all cells in the range contain formulas; False if + at least one of the cells in the range doesn't contain a formula. + Read-only Boolean. + + + + + Indicates whether range contains array-entered formula. Read-only. + + + + + Indicates whether the range contains number. Read-only. + + + + + Indicates whether cell contains formatted rich text string. + + + + + Indicates whether the range contains String. Read-only. + + + + + Indicates whether range has default style. False means default style. + Read-only. + + + + + Returns or sets the horizontal alignment for the specified object. + Read/write OfficeHAlign. + + + + + Returns or sets the indent level for the cell or range. Can be an integer + from 0 to 15 for Excel 97-2003 and 250 for Excel 2007. Read/write Integer. + + + + + Indicates whether the range is blank. Read-only. + + + + + Indicates whether range contains boolean value. Read-only. + + + + + Indicates whether range contains error value. + + + + + Indicates whether this range is grouped by column. Read-only. + + + + + Indicates whether this range is grouped by row. Read-only. + + + + + Indicates whether cell is initialized. Read-only. + + + + + Returns last column of the range. Read-only. + + + + + Returns last row of the range. Read-only. + + + + + Gets / sets double value of the range. + + + + + Format of current cell. Analog of Style.NumberFormat property. + + + + + Returns the number of the first row of the first area in + the range. Read-only Long. + + + + + Row group level. Read-only. + -1 - Not all rows in the range have same group level. + 0 - No grouping, + 1 - 7 - Group level. + + + + + Returns the height of all the rows in the range specified, + in points. Returns Double.MinValue if the rows in the specified range + aren't all the same height. Read / write Double. + + + + + For a Range object, returns an array of Range objects that represent the + rows in the specified range. + + + + + For a Range object, returns an array of Range objects that represent the + columns in the specified range. + + + + + Returns a Style object that represents the style of the specified + range. Read/write IStyle. + + + + + Returns name of the Style object that represents the style of the specified + range. Read/write String. + + + + + Gets / sets string value of the range. + + + + + Gets / sets time value of the range. + + + + + Returns or sets the value of the specified range. + Read/write Variant. Does not support FormulaArray value. + + + + + Returns or sets the cell value. Read/write Variant. + The only difference between this property and the Value property is + that the Value2 property doesn't use the Currency and Date data types. + Does not support FormulaArray value. + + + + + Returns or sets the vertical alignment of the specified object. + Read/write OfficeVAlign. + + + + + Returns a Worksheet object that represents the worksheet + containing the specified range. Read-only. + + + + + Gets / sets cell by row and column index. Row and column indexes are one-based. + + + + + Get cell range. Row and column indexes are one-based. Read-only. + + + + + Get cell range. Read-only. + + + + + Gets cell range. Read-only. + + + + + Gets / sets string value evaluated by formula. + + + + + Gets / sets number value evaluated by formula. + + + + + Indicates if current range has formula bool value. Read-only. + + + + + Indicates if current range has formula error value. Read-only. + + + + + Indicates if current range has formula value formatted as DateTime. Read-only. + + + + + Indicates if the current range has formula number value. Read-only. + + + + + Indicates if the current range has formula string value. Read-only. + + + + + String with rich text formatting. Read-only. + + + + + Indicates whether this range is part of merged range. Read-only. + + + + + Returns a Range object that represents the merged range containing + the specified cell. If the specified cell isn�t in a merged range, + this property returns NULL. Read-only. + + + + + True if Microsoft Excel wraps the text in the object. + Read/write Boolean. + + + + + Indicates is current range has external formula. Read-only. + + + + + Gets/sets built in style. + + + + + First row. + + + + + First column. + + + + + Last row. + + + + + Last column. + + + + + Parent group of worksheets. + + + + + Rich text string group. + + + + + Value of End property. + + + + + Style group. + + + + + Creates new instance of the group. + + Application object for the new group. + Parent object for the new group. + + + + Creates new instance of the group. + + Application object for the new group. + Parent object for the new group. + The first row of the range. + The first column of the range. + + + + Creates new instance of the group. + + Application object for the new group. + Parent object for the new group. + The first row of the range. + The first column of the range. + The last row of the range. + The last column of the range. + + + + Creates new instance of the group. + + Application object for the new group. + Parent object for the new group. + String representation of the range. + + + + Creates new instance of the group. + + Application object for the new group. + Parent object for the new group. + String representation of the range. + Indicates is name in R1C1 notation. + + + + Searches for all necessary parent objects. + + + + + Returns range for specific sheet. + + Sheet index in the group. + + + + + Creates Subtotal for the corresponding ranges + + GroupBy + ConsolidationFunction + TotalList + + + + Creates SubTotal for the corresponding Ranges + + GroupByGroupBy + ConsolidationFunction + TotalList + Replace exisiting SubTotal + Insert PageBreaks + SummaryBelowData + + + + Clear the contents of the Range. + + + + + Returns intersection of this range with the specified one. + + The Range with which to intersect. + Range intersection; if there is no intersection, NULL is returned. + + + + Autofits all columns in the range. + + + + + Returns number of ranges in the group. Read-only. + + + + + Returns range from the specified worksheet in the range. Read-only. + + + + + Returns parent workbook object. Read-only. + + + + + Returns the range reference in the language of the macro. + Read-only String. + + + + + Returns the range reference for the specified range in the language + of the user. Read-only String. + + + + + Returns range Address in format "'Sheet1'!$A$1". + + + + + Returns the range reference using R1C1 notation. + Read-only String. + + + + + Returns the range reference using R1C1 notation. + Read-only String. + + + + + Gets / sets boolean value that is contained by this range. + + + + + Returns a Borders collection that represents the borders of a style + or a range of cells (including a range defined as part of a + conditional format). + + + + + Returns a Range object that represents the cells in the specified range. + Read-only. + + + + + Returns the number of the first column in the first area in the specified + range. Read-only. + + + + + Column group level. Read-only. + -1 - Not all columns in the range have same group level. + 0 - No grouping, + 1 - 7 - Group level. + + + + + Returns or sets the width of all columns in the specified range. + Read/write Double. + + + + + Returns the number of objects in the collection. Read-only. + + + + + Gets / sets DateTime contained by this cell. Read-write DateTime. + + + + + Returns cell value after number format application. Read-only. + + + + + Returns a Range object that represents the cell at the end of the + region that contains the source range. + + + + + Returns a Range object that represents the entire column (or + columns) that contains the specified range. Read-only. + + + + + Returns a Range object that represents the entire row (or + rows) that contains the specified range. Read-only. + + + + + Gets / sets error value that is contained by this range. + + + + + Returns or sets the object's formula in A1-style notation and in + the language of the macro. Read/write Variant. + + + + + Returns or sets the object's formula in R1C1-style notation and in + the language of the macro. Read/write Variant. + + + + + Represents array-entered formula. + + + + + Returns or sets the object's formula in R1C1-style notation and in + the language of the macro. Read/write Variant. + + + + + True if the formula will be hidden when the worksheet is protected. + False if at least part of formula in the range is not hidden. + + + + + Get / set formula DateTime value contained by this cell. + DateTime.MinValue if not all cells of the range have same DateTime value. + + + + + Indicates whether specified range object has data validation. + If Range is not single cell, then returns true only if all cells have data validation. Read-only. + + + + + Indicates whether range contains bool value. Read-only. + + + + + Indicates whether range contains DateTime value. Read-only. + + + + + Indicates if current range has formula bool value. Read-only. + + + + + Indicates if current range has formula error value. Read-only. + + + + + Indicates if current range has formula value formatted as DateTime. Read-only. + + + + + Indicates if the current range has formula number value. Read-only. + + + + + Indicates if the current range has formula string value. Read-only. + + + + + True if all cells in the range contain formulas; False if + at least one of the cells in the range doesn't contain a formula. + Read-only Boolean. + + + + + Indicates whether range contains array-entered formula. Read-only. + + + + + Indicates whether the range contains number. Read-only. + + + + + Indicates whether cell contains formatted rich text string. + + + + + Indicates whether the range contains String. Read-only. + + + + + Indicates whether range has default style. False means default style. + Read-only. + + + + + Returns or sets the horizontal alignment for the specified object. + Read/write OfficeHAlign. + + + + + Returns or sets the indent level for the cell or range. Can be an integer + from 0 to 15 for Excel 97-2003 and 250 for Excel 2007. Read/write Integer. + + + + + Indicates whether the range is blank. Read-only. + + + + + Indicates whether range contains boolean value. Read-only. + + + + + Indicates whether range contains error value. + + + + + Indicates whether this range is grouped by column. Read-only. + + + + + Indicates whether this range is grouped by row. Read-only. + + + + + Indicates whether cell is initialized. Read-only. + + + + + Returns last column of the range. Read-only. + + + + + Returns last row of the range. Read-only. + + + + + Gets / sets double value of the range. + + + + + Format of current cell. Analog of Style.NumberFormat property. + + + + + Returns the number of the first row of the first area in + the range. Read-only Long. + + + + + Row group level. Read-only. + -1 - Not all rows in the range have same group level. + 0 - No grouping, + 1 - 7 - Group level. + + + + + Returns the height of all the rows in the range specified, + in points. Returns Double.MinValue if the rows in the specified range + aren't all the same height. Read / write Double. + + + + + For a Range object, returns an array of Range objects that represent the + rows in the specified range. + + + + + For a Range object, returns an array of Range objects that represent the + columns in the specified range. + + + + + Returns a Style object that represents the style of the specified + range. Read/write IStyle. + + + + + Returns name of the Style object that represents the style of the specified + range. Read/write String. + + + + + Gets / sets string value of the range. + + + + + Gets / sets time value of the range. + + + + + Returns or sets the value of the specified range. + Read/write Variant. + + + + + Returns the calculated value of a formula using the most current inputs. + + + + + Returns or sets the cell value. Read/write Variant. + The only difference between this property and the Value property is + that the Value2 property doesn't use the Currency and Date data types. + + + + + Returns or sets the vertical alignment of the specified object. + Read/write OfficeVAlign. + + + + + Returns a Worksheet object that represents the worksheet + containing the specified range. Read-only. + + + + + Gets / sets cell by row and column index. Row and column indexes are one-based. + + + + + Get cell range. Row and column indexes are one-based. Read-only. + + + + + Get cell range. Read-only. + + + + + Get cell range. Read-only. + + + + + Gets / sets string value evaluated by formula. + + + + + Gets / sets number value evaluated by formula. + + + + + Gets / sets number value evaluated by formula. + + + + + Returns the calculated value of the formula as a string. + + + + + String with rich text formatting. Read-only. + + + + + Indicates whether this range is part of merged range. Read-only. + + + + + Returns a Range object that represents the merged range containing + the specified cell. If the specified cell isn�t in a merged range, + this property returns NULL. Read-only. + + + + + True if Microsoft Excel wraps the text in the object. + Read/write Boolean. + + + + + Indicates is current range has external formula. Read-only. + + + + + Represents ignore error options. If not single cell returs concatenateed flags. + + + + + Gets/sets built in style. + + + + + Summary description for RichTextStringGroup. + + + + + Represents a Rich Text String that can be used to apply several styles inside a single cell. + + + + + Returns font which is applied to character at the specified position. + + Character index. + Font which is applied to character at the specified position. + + + + Sets font for range of characters. + + First character of the range. + Last character of the range. + Font to set. + + + + Clears string formatting. + + + + + Clears text and formatting. + + + + + Appends rich text string with specified text and font. + + Text to append. + Font to use. + + + + Gets / sets text of the string. + + + + + Returns text in rtf format. Read-only. + + + + + Indicates whether rich text string has formatting runs. Read-only. + + + + + Parent group of ranges. + + + + + Represents an RTF string. + + + + + Creates new instance of the group. + + Application object for the new group. + Parent object for the new group. + + + + Searches for all necessary parent objects. + + + + + Returns font which is applied to character at the specified position. + + Character index. + Font which is applied to character at the specified position. + + + + Sets font for range of characters. + + First character of the range. + Last character of the range. + Font to set. + + + + Clears string formatting. + + + + + Appends rich text string with specified text and font. + + Text to append. + Font to use. + + + + Clears text and formatting. + + + + + + + + + + + + + + + Returns single RichTextString from the group. Read-only. + + + + + Returns number of elements in the group. Read-only. + + + + + Gets / sets text of the string. + + + + + Returns text in rtf format. Read-only. + + + + + Indicates whether rich text string has formatting runs. Read-only. + + + + + Summary description for StyleGroup. + + + + + Parent range group. + + + + + Font group. + + + + + Borders group. + + + + + Creates new instance of the group. + + Application object for the new group. + Parent object for the new group. + + + + Searches for all necessary parent objects. + + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object. + + + + + Returns single entry from the group. Read-only. + + + + + Returns number of elements in the group. Read-only. + + + + + Returns parent workbook object. Read-only. + + + + + Returns a Borders collection that represents the borders of a + style or a range of cells (including a range defined as part of + a conditional format). + + + + + True if the style is a built-in style. Read-only Boolean. + + + + + Gets / sets fill pattern. + + + + + Gets / sets index of fill background color. + + + + + Gets / Sets fill background color. + + + + + Gets / sets index of fill foreground color. + + + + + Gets / sets fill foreground color. + + + + + Returns a Font object that represents the font of the specified + object. + + + + + Returns Interior object that represents interior of the specified object. + + + + + True if the formula will be hidden when the worksheet is protected. + Read/write Boolean. + + + + + Returns or sets the horizontal alignment for the specified object. + For all objects, this can be one of the following OfficeHAlign constants. + Read/write OfficeHAlign. + + + + + True if the style includes the AddIndent, HorizontalAlignment, + VerticalAlignment, WrapText, and Orientation properties. + Read/write Boolean. + + + + + True if the style includes the Color, ColorIndex, LineStyle, + and Weight border properties. Read/write Boolean. + + + + + True if the style includes the Background, Bold, Color, + ColorIndex, FontStyle, Italic, Name, OutlineFont, Shadow, + Size, Strikethrough, Subscript, Superscript, and Underline + font properties. Read/write Boolean. + + + + + True if the style includes the NumberFormat property. + Read/write Boolean. + + + + + True if the style includes the Color, ColorIndex, + InvertIfNegative, Pattern, PatternColor, and PatternColorIndex + interior properties. Read / write Boolean. + + + + + True if the style includes the FormulaHidden and Locked protection + properties. Read/write Boolean. + + + + + Returns or sets the indent level for the style. Read/write. + + + + + True if the object is locked, False if the object can be + modified when the sheet is protected. Read/write Boolean. + + + + + Returns or sets the name of the object. Read-only String. + + + + + Returns or sets the format code for the object. Read/write String. + + + + + Returns or sets the format code for the object. Read/write String. + + + + + Gets / sets index of the number format. + + + + + Text rotation angle: + 0 Not rotated + 1-90 1 to 90 degrees counterclockwise + 91-180 1 to 90 degrees clockwise + 255 Letters are stacked top-to-bottom, but not rotated. + + Thrown when value is more than 0xFF. + + + + True if text automatically shrinks to fit in the available + column width. Read/write Boolean. + + + + + Returns or sets the vertical alignment of the specified object. + Read/write OfficeVAlign. + + + + + True if Excel wraps the text in the object. + Read/write Boolean. + + + + + Indicates whether style is initialized (differs from Normal style). + Read-only. + + + + + Text direction, the reading order for far east versions. + + + + + If true then first symbol in cell is apostrophe. + + + + + For far east languages. Supported only for format. Always False for US. + + + + + Gets / sets index of fill background color. + + + + + Gets / Sets fill background color. + + + + + Gets / sets index of fill foreground color. + + + + + Returns or sets the cell shading color. + + + + + Gets value indicating whether format was modified, compared to parent format. + + + + + Gets format index in m_book.InnerFormats. + + + + + Represents group of worksheets. + + + + + Represents a worksheet group. + + + + + Represents a worksheet. The Worksheet object is a member of the + Worksheets collection. The Worksheets collection contains all the + Worksheet objects in a workbook. + + + + + Creates new instance of IRanges. + + New instance of ranges collection. + + + + Imports data from a DataTable into worksheet. + + DataTable with desired data. + True if column names must also be imported. + Row of the first cell where DataTable should be imported. + Column of the first cell where DataTable should be imported. + Number of imported rows. + + + + Autofits specified row. + + One-based row index. + + + + Autofits specified column. + + One-based column index. + + + + Replaces specified string by data table values. + + String value to replace. + Data table with new data. + Indicates whether field name must be shown. + + + + Replaces specified string by data column values. + + String value to replace. + Data table with new data. + Indicates whether field name must be shown. + + + + Removes worksheet from parent worksheets collection. + + + + + Moves worksheet. + + New index of the worksheet. + + + + Converts pixels into column width (in characters). + + Width in pixels + Width in characters. + + + + Sets column width. + + One-based column index. + Width to set. + + + + Sets column width. + + One-based column index. + Width in pixels to set. + + + + Returns width from ColumnInfoRecord if there is corresponding ColumnInfoRecord + or StandardWidth if not. + + One-based index of the column. + Width of the specified column. + + + + Returns width in pixels from ColumnInfoRecord if there is corresponding ColumnInfoRecord + or StandardWidth if not. + + One-based index of the column. + Width in pixels of the specified column. + + + + Returns height from RowRecord if there is a corresponding RowRecord. + Otherwise returns StandardHeight. + + One-based index of the row + + Height from RowRecord if there is corresponding RowRecord. + Otherwise returns StandardHeight. + + + + + Returns height from RowRecord if there is a corresponding RowRecord. + Otherwise returns StandardHeight. + + One-based index of the row. + + Height in pixels from RowRecord if there is corresponding RowRecord. + Otherwise returns StandardHeight. + + + + + Save tabsheet using separator. + + File to save. + Current separator. + + + + Save tabsheet using separator. + + File to save. + Current separator. + Encoding to use. + + + + Save tabsheet using separator. + + Stream to save. + Current separator. + + + + Save tabsheet using separator. + + Stream to save. + Current separator. + Encoding to use. + + + + Sets the value in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + + Sets the value in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + + Sets the value in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + + Sets text in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Text to set. + + + + Sets formula in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Formula to set. + + + + Sets formula number value. + + One based row index. + One based column index. + Represents formula number value for set. + + + + Sets formula error value. + + One based row index. + One based column index. + Represents formula error value for set. + + + + Sets formula bool value. + + One based row index. + One based column index. + Represents formula bool value for set. + + + + Sets formula string value. + + One based row index. + One based column index. + Represents formula string value for set. + + + + True if page breaks (both automatic and manual) on the specified + worksheet are displayed. Read / write Boolean. + + + + + Returns the index number of the object within the collection of + similar objects. Read-only. + + + + + For a Worksheet object, returns a Names collection that represents + all the worksheet-specific names (names defined with the "WorksheetName!" + prefix). Read-only Names object. + + + + + Returns a PageSetup object that contains all the page setup settings + for the specified object. Read-only. + + + + + Returns a Range object that represents a cell or a range of cells. + + + + + Returns or sets the standard (default) height of all the rows in the worksheet, + in points. Read/write Double. + + + + + Returns or sets the standard (default) height option flag, which defines that + standard (default) row height and book default font height do not match. + Read/write Bool. + + + + + Returns or sets the standard (default) width of all the columns in the + worksheet. Read/write Double. + + + + + Returns a Range object that represents the used range on the + specified worksheet. Read-only. + + + + + Zoom factor of document. Value must be in range from 10 till 400. + + + + + Position of the vertical split (px, 0 = No vertical split): + Unfrozen pane: Width of the left pane(s) (in twips = 1/20 of a point) + Frozen pane: Number of visible columns in left pane(s) + + + + + Position of the horizontal split (by, 0 = No horizontal split): + Unfrozen pane: Height of the top pane(s) (in twips = 1/20 of a point) + Frozen pane: Number of visible rows in top pane(s) + + + + + Index to first visible row in bottom pane(s). + + + + + Index to first visible column in right pane(s). + + + + + Identifier of pane with active cell cursor. + + + + + True if zero values to be displayed + False otherwise. + + + + + True if gridlines are visible; + False otherwise. + + + + + Gets / sets Grid line color. + + + + + True if row and column headers are visible; + False otherwise. + + + + + Indicates if all values in the workbook are preserved as strings. + + + + + Gets / sets cell by row and index. + + + + + Get cells range. + + + + + Get cell range. + + + + + Get cell range. + + + + + Indicates whether all created range objects should be cached. Default value is false. + + + + + Defines whether freezed panes are applied. + + + + + Gets/sets top visible row of the worksheet. + + + + + Gets/sets left visible column of the worksheet. + + + + + There are two different algorithms to create UsedRange object: + 1) Default. This property = true. The cell is included into UsedRange when + it has some record created for it even if data is empty (maybe some formatting + changed, maybe not - cell was accessed and record was created). + 2) This property = false. In this case XlsIO tries to remove empty rows and + columns from all sides to make UsedRange smaller. + + + + + Gets or sets the view setting of the sheet. + + + + + Adds new worksheet to the collection. + + Worksheet to add. + Index of the added worksheet. + When sheet is Null. + + + + Returns single entry from the collection. Read-only. + + + + + Indicates whether collection is empty. Read-only. + + + + + Number of selected worksheets. + + + + + Represents the object associated with implementation + + + + + Parent workbook. + + + + + Page setup. + + + + + Used range. + + + + + Migrant range - row and column of this range object can be changed by user. + + + + + Creates new instance of the worksheet group. + + Application object for the new group. + Parent object for the new group. + + + + Searches for all necessary parent objects. + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Adds new worksheet to the collection. + + Worksheet to add. + Index of the added worksheet. + When sheet is Null. + + + + Removes worksheet from the collection. + + Worksheet to remove. + When sheet is Null. + + + + Selects single tab sheet. + + Sheet to select. + + + + Returns the formula string if the cell contains a formula, or the value if + the cell cantains anything other than a formula. + + The row of the cell. + The column of the cell. + The formula string or value. + + + + Sets the value of a cell. + + The value to be set. + The row of the cell. + The column of the cell. + + + + Not implemented. + + + + + Raises the event. + + The row of the change. + The column of the change. + The changed value. + + + + Makes the current sheet the active sheet. Equivalent to clicking the + sheet's tab. + + + + + Creates new instance of IRanges. + + New instance of ranges collection. + + + + Imports data from a DataTable into worksheet. + + DataTable with desired data. + True if column names must also be imported. + Row of the first cell where DataTable should be imported. + Column of the first cell where DataTable should be imported. + Number of imported rows. + + + + Exports worksheet data into a DataTable. + + Row of the first cell from where DataTable should be exported. + Column of the first cell from where DataTable should be exported. + Maximum number of rows to export. + Maximum number of columns to export. + Export options. + DataTable with worksheet data. + + + + Exports worksheet data into a DataTable. + + Range to export. + Export options. + DataTable with worksheet data. + + + + Protects current worksheet. + + Represents password to protect. + Represents params to protect. + + + + Autofits specified row. + + One-based row index. + + + + Autofits specified column. + + One-based column index. + + + + Replaces specified string by data table values. + + String value to replace. + Data table with new data. + Indicates whether field name must be shown. + + + + Replaces specified string by data column values. + + String value to replace. + Data table with new data. + Indicates whether field name must be shown. + + + + Removes worksheet from parent worksheets collection. + + + + + Moves worksheet. + + New index of the worksheet. + + + + Converts column width into pixels. + + Width in characters. + Width in pixels + + + + Converts pixels into column width (in characters). + + Width in pixels + Width in characters. + + + + Sets column width. + + One-based column index. + Width to set. + + + + Sets column width. + + One-based column index. + Width in pixels to set. + + + + Returns width from ColumnInfoRecord if there is corresponding ColumnInfoRecord + or StandardWidth if not. + + One-based index of the column. + Width of the specified column. + + + + Returns width in pixels from ColumnInfoRecord if there is corresponding ColumnInfoRecord + or StandardWidth if not. + + One-based index of the column. + Width in pixels of the specified column. + + + + Returns height from RowRecord if there is a corresponding RowRecord. + Otherwise returns StandardHeight. + + One-based index of the row + + Height from RowRecord if there is corresponding RowRecord. + Otherwise returns StandardHeight. + + + + + Returns height from RowRecord if there is a corresponding RowRecord. + Otherwise returns StandardHeight. + + One-based index of the row. + + Height in pixels from RowRecord if there is corresponding RowRecord. + Otherwise returns StandardHeight. + + + + + + Save tabsheet using separator. + + File to save. + Current separator. + Encoding to use. + + + + + Save tabsheet using separator. + + Stream to save. + Current separator. + Encoding to use. + + + + Sets the value in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + + Sets the value in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + + Sets the value in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + + Sets text in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Text to set. + + + + Sets formula in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Formula to set. + + + + Sets formula number value. + + One based row index. + One based column index. + Represents formula number value for set. + + + + Sets formula error value. + + One based row index. + One based column index. + Represents formula error value for set. + + + + Sets formula bool value. + + One based row index. + One based column index. + Represents formula bool value for set. + + + + Sets formula string value. + + One based row index. + One based column index. + Represents formula string value for set. + + + + Converts range into image (Bitmap). + + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + + + + + Converts range into image. + + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Type of the image to create. + Output stream. It is ignored if null. + Created image. + + + + Converts range into metafile image. + + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Metafile EmfType. + Output stream. It is ignored if null. + Created image. + + + + Converts range into image. + + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Type of the image to create. + Output stream. It is ignored if null. + Metafile EmfType. + Created image. + + + + Unselects current tab sheet. + + + + + Event handler for Inserted event. + + Event sender. + Event arguments. + + + + Event handler for Removing event. + + Event sender. + Event arguments. + + + + This method is called before clearing all elements. + + + + + Event raised when an unknown function is encountered. + + + + + Indicates whether collection is empty. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + Gets or sets the a object associated with implementation. + + + + + An event raised on the IWorksheet whenever a value changes. + + + + + Gets workbook to which current worksheet belong. Read-only. + + + + + Gets or sets the view setting of the sheet. + + + + + + True if page breaks (both automatic and manual) on the specified + worksheet are displayed. Read / write Boolean. + + + + + Gets or sets a value indicating whether this instance is OLE object. + + + true if this instance is OLE object; otherwise, false. + + + + + Returns the index number of the object within the collection of + similar objects. Read-only. + + + + + Returns or sets the name of the object. Read / write String. + + + + + For a Worksheet object, returns a Names collection that represents + all the worksheet-specific names (names defined with the "WorksheetName!" + prefix). Read-only Names object. + + + + + Name that is used by macros to access the workbook items. + + + + + Returns a PageSetup object that contains all the page setup settings + for the specified object. Read-only. + + + + + Returns a Range object that represents a cell or a range of cells. + + + + + Returns the standard (default) height of all the rows in the worksheet, + in points. Read-only Double. + + + + + Returns or sets the standard (default) height option flag, which defines that + standard (default) row height and book default font height do not match. + Read/write Bool. + + + + + Returns or sets the standard (default) width of all the columns in the + worksheet. Read/write Double. + + + + + Returns a Range object that represents the used range on the + specified worksheet. Read-only. + + + + + Zoom factor of document. Value must be in range from 10 till 400. + + + + + Control visibility of worksheet to end user. + + + + + Position of the vertical split (px, 0 = No vertical split): + Unfrozen pane: Width of the left pane(s) (in twips = 1/20 of a point) + Frozen pane: Number of visible columns in left pane(s) + + + + + Position of the horizontal split (py, 0 = No horizontal split): + Unfrozen pane: Height of the top pane(s) (in twips = 1/20 of a point) + Frozen pane: Number of visible rows in top pane(s) + + + + + Index to first visible row in bottom pane(s). + + + + + Index to first visible column in right pane(s). + + + + + Identifier of pane with active cell cursor. + + + + + True if zero values to be displayed + False otherwise. + + + + + True if gridlines are visible; + False otherwise. + + + + + Gets/Sets Grid line color. + + + + + True if row and column headers are visible; + False otherwise. + + + + + Indicates if all values in the workbook are preserved as strings. + + + + + Gets / sets cell by row and index. + + + + + Get cells range. + + + + + Get cell range. + + + + + Get cell range. + + + + + Indicates whether all created range objects should be cached. + + + + + + + + + + + + + + + There are two different algorithms to create UsedRange object: + 1) Default. This property = true. The cell is included into UsedRange when + it has some record created for it even if data is empty (maybe some formatting + changed, maybe not - cell was accessed and record was created). + 2) This property = false. In this case XlsIO tries to remove empty rows and + columns from all sides to make UsedRange smaller. + + + + + Defines whether freeze panes are applied. + + + + + Gets / sets tab color. + + + + + Gets / sets tab color. + + + + + Returns shapes collection. Read-only. + + + + + Indicates whether worksheet is displayed right to left. + + + + + Indicates whether tab of this sheet is selected. Read-only. + + + + + Summary description for HeaderFooterShapesCollection. + + + + + Summary description for ShapeCollectionBase. + + + + + Default id increment when group changes. + + + + + Shapes count would be rounded to this value. + + + + + Container of all worksheet's shapes. + + + + + Parent worksheet. + + + + + Index of the collection. + + + + + Id of the last shape. + + + + + Id of the first shape. + + + + + + + + + + + + Initializes collection. + + + + + Searches for all necessary parent objects. + + + + + Parses shapes group container. + + Container to parse. + Parse options. + + + + Parses shapes group description record. + + Record to parse. + + + + Parses MsoDrawing records. + + Array of MsoDrawing records. + Parse options. + + + + Parses MsofbtDgContainer. + + Container to parse. + Parse options. + + + + Parses MsofbtDg record. + + Record to parse. + + + + Adds shape copy to shapes collection. + + Shape to copy. + Dictionary with new names of worksheets. + Dictionary with new font indexes. + Added shape. + + + + Adds shape copy to shapes collection. + + Shape to copy. + Dictionary with new names of worksheets. + List with new font indexes. + Added shape. + + + + Adds new shape to the collection. + + Shape to add. + Newly added shape. + + + + Adds new shape to the collection. + + Shape record to add. + Parse options. + Newly added shape. + + + + Adds the group container shapes. + + GroupShape record to add. + Parse options. + Newly added shape. + + + + Create the group container shapes. + + GroupShape record to create. + Parse options. + Newly created shape. + + + + Adds new child shape to the collection. + + Shape container to add. + Parse options. + Newly added shape. + + + + Adds new shape to the collection. + + Shape container to add. + Parse options. + Newly added shape. + + + + Creates new shape object. + + Object type to create. + Shape container. + Parse options. + Subrecords of the shape's OBJRecord. + Index to the cmo record inside subrecords. + + + + Removes shape from the collection. + + Shape to remove. + + + + Creates copy of the collection. + + Parent object for the new collection. + Copy of the collection. + + + + Registers in the parent worksheet. + + + + + Returns parent WorksheetBase. Read-only. + + + + + Returns parent worksheet. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + Returns single shape from the collection by its index. Read-only. + + + + + Returns single shape from the collection by its name or null when cannot find. Read-only. + + + + + Returns shared shape data for all shapes in this collection. Read-only. + + + + + Index of the collection. + + + + + Id of the last shape. + + + + + Id of the first shape. + + + + + + + + + + + + Creates new shape object. + + Object type to create. + Shape container. + Parse options. + Subrecords of the shape's OBJRecord. + Index to the cmo record inside subrecords. + + + + Adds new shape to the collection. + + Shape container to add. + Parse options. + Newly added shape. + + + + Registers in the parent worksheet. + + + + + Sets picture. + + Shape name. + Image to set. + + + + Sets picture. + + Shape name. + Image to set. + Represents new shape blip id index. If set -1 - auto indicate. + + + + Sets picture. + + Shape name. + Image to set. + Represents new shape blip id index. If set -1 - auto indicate. + Indicates is current picture include options. + + + + Returns shared shape data for all shapes in this collection. Read-only. + + + + + Suitable Node colors used for 2-3-4 nodes detection. + + + + + Red color of node. + + + + + Black color of node. + + + + + Node class used for proper storing of data in the Map Collection. + + + + + Reference on left branch. + + + + + Reference on right branch. + + + + + Reference on parent branch. + + + + + Color of node branch. + + + + + Is current node Nil element or not? + + + + + Key part of stored in node data. + + + + + Value part of stored in node data. + + + + + Create red colored Tree node. + + Reference on left branch. + Reference on parent branch. + Reference on right branch. + Key value of node. + Value part of node. + + + + Main constructor of class. + + Reference on left branch. + Reference on parent branch. + Reference on right branch. + Key value of node. + Value part of node. + Color of node. + + + + Reference on left branch. + + + + + Reference on right branch. + + + + + Reference on parent branch. + + + + + Color of node branch. + + + + + Is current node Nil element or not? + + + + + Key part of stored in node data. + + + + + Value part of stored in node data. + + + + + Is current node set to red color? + + + + + Is current node set to black color? + + + + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + Create collection with specified comparer for Key values. + + Comparer for key values. + + + + Create Empty node for collection. + + + + + Clear collection. + + + + + Add item into collection. + + Key part. + Value. + + + + Check whether collection contains specified key. + + True if node with specified key is found; otherwise False. + Key for check. + + + + Remove from collection item with specified key. + + Key to identify item. + + + + TODO: place correct comment here + + + TODO: place correct comment here + + + + + Get minimum value for specified branch. + + Branch start node. + Reference on minimum value node. + + + + Get maximum value for specified branch. + + Branch start node. + Reference on maximum value node. + + + + Go to to next item in collection. + + Start node. + Reference on next item in collection or this.Empty if nothing found. + + + + Get previous item from collection. + + Start node. + Reference on previous item in collection. + + + + Find node in collection by key value (search in lower side). + + Key of node to find. + Reference on found node, otherwise this.Empty value. + + + + Find node in collection by key value (search in upper side). + + Key of node to find. + Reference on found node, otherwise this.Empty value. + + + + Rotate branch into left side. + + Branch start node. + + + + Rotate branch into right side. + + Branch start node. + + + + Erase node from collection. + + Item to erase. + + + + Insert item into collection. + + Add into left side of tree or right. + Node for placement. + Key part of node. + Value part of node. + + + + Returns enumerator. + + Returns enumerator of current interface. + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + + + + + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + Summary description for RangesCollection. + + + + + Represents a collection of ranges. + + + + + Adds new range to the collection. + + Range to add. + + + + Removes range from the collection. + + Range to remove. + + + + Returns item by index from the collection. + + + + + Represents a combined Range. + + + + + Gets new address of range. + + Dictionary with Worksheet names. + String that sets as a worksheet name. + Returns string with new name. + + + + Clones current IRange. + + Parent object. + Dictionary with new names. + Parent workbook. + Returns clone of current instance. + + + + Returns array that contains information about range. + + Rectangles that describes range + + + + Returns number of rectangles returned by GetRectangles method. + + Number of rectangles returned by GetRectangles method. + + + + Number of cells in the range. Read-only. + + + + + Gets address global in the format required by Excel 2007. + + + + + Interface that contains method for to take native ptg. + + + + + Gets ptg of current range. + + Returns native ptg. + + + + Error message for wrong worksheet exception. + + + + + Parent worksheet. + + + + + One-based first row index. + + + + + One-based first column index. + + + + + One-based last row index. + + + + + One-based last column index. + + + + + Rich text string. + + + + + Creates new instance of RangesCollection. + + Application object. + Parent object. + + + + Searches for all necessary parents of this collection. + + + If can't find parent of some class. + + + + + Creates Subtotal for the corresponding ranges + + GroupBy + ConsolidationFunction + TotalList + + + + Creates SubTotal for the corresponding Ranges + + GroupByGroupBy + ConsolidationFunction + TotalList + Replace exisiting SubTotal + Insert PageBreaks + SummaryBelowData + + + + Clear the contents of the Range. + + + + + Returns intersection of this range with the specified one. + + The Range with which to intersect. + Range intersection; if there is no intersection, NULL is returned. + + + + + + + + + Gets new address of range. + + Dictionary with Worksheet names. + String that sets as a worksheet name. + Returns string with new name. + + + + Clones current IRange. + + Parent object. + Dictionary with new names. + Parent workbook. + Returns clone of current instance. + + + + Returns array that contains information about range. + + Rectangles that describes range + + + + Returns number of rectangles returned by GetRectangles method. + + Number of rectangles returned by GetRectangles method. + + + + Adds new range to the collection. + + Range to add. + + + + Adds range to the collection. + + Range to add. + + + + Removes range from the collection. + + Range to remove. + + + + Evaluates dimensions of the ranges collection. + + + + + Returns SortedListEx that describes used rows / columns. + + Indicates whether information about columns should be returned. + SortedListEx that describes used rows / columns. + + + + Adds new element to the list of used rows / columns. + + List to add entry to. + Row / column index. + Entry to add. + + + + Adds new element to the list of used rows / columns. + + List to add entry to. + Row / column index. + Start index of the new entry. + End index of the new entry. + + + + + + + + + + + Returns array of used rows / columns. + + Indicates whether columns array should be returned. + Array of used rows / columns. + + + + Checks whether collection is disposed. + + + + + + + + + + + Gets ptg of current range. + + Returns native ptg. + + + + Returns the calculated value of a formula using the most current inputs. + + + + + Returns the range reference in the language of the macro. + Read-only String. + + + + + Returns the range reference for the specified range in the language + of the user. Read-only String. + + + + + Returns the range reference in the language of the macro. + Read-only String. + + + + + Returns the range reference in the language of the macro using R1C1-style reference. + Read-only String. + + + + + Returns the range reference for the specified range in the language + of the user using R1C1 style reference . Read-only String. + + + + + Gets / sets boolean value that is contained by this range. + + + + + Returns a Borders collection that represents the borders of a style + or a range of cells (including a range defined as part of a + conditional format). + + + + + Returns a Range object that represents the cells in the specified range. + For big number of ranges can be very slow operation. Read-only. + + + + + Returns the number of the first column in the first area in the specified + range. Read-only. + + + + + Column group level. Read-only. + -1 - Not all columns in the range have same group level. + 0 - No grouping, + 1 - 7 - Group level. + + + + + Returns or sets the width of all columns in the specified range. + Read/write Double. + + + + + Returns the number of objects in the collection. Read-only. + + + + + Gets / sets DateTime contained by this cell. Read-write DateTime. + + + + + Returns cell value after number format application. Read-only. + + + + + Returns a Range object that represents the cell at the end of the + region that contains the source range. + + + + + Returns a Range object that represents the entire column (or + columns) that contains the specified range. Read-only. + + + + + Returns a Range object that represents the entire row (or + rows) that contains the specified range. Read-only. + + + + + Gets / sets error value that is contained by this range. + + + + + Returns or sets the object's formula in A1-style notation and in + the language of the macro. Read/write Variant. + + + + + Returns or sets the object's formula in R1C1-style notation and in + the language of the macro. Read/write Variant. + + + + + Represents array-entered formula. + Visit http://www.cpearson.com/excel/array.htm for more information. + + + + + Returns or sets the array-entered formula in R1C1-style notation and in + the language of the macro. Read/write Variant. + + + + + True if the formula will be hidden when the worksheet is protected. + False if at least part of formula in the range is not hidden. + + + + + Get / set formula DateTime value contained by this cell. + DateTime.MinValue if not all cells of the range have same DateTime value. + + + + + Indicates whether specified range object has data validation. + If Range is not single cell, then returns true only if all cells have data validation. Read-only. + + + + + Indicates whether range contains bool value. Read-only. + + + + + Indicates whether range contains DateTime value. Read-only. + + + + + Indicates if current range has formula bool value. Read-only. + + + + + Indicates if current range has formula error value. Read-only. + + + + + Indicates if current range has formula value formatted as DateTime. Read-only. + + + + + True if all cells in the range contain formulas; False if + at least one of the cells in the range doesn't contain a formula. + Read-only Boolean. + + + + + Indicates whether range contains array-entered formula. Read-only. + + + + + Indicates whether the range contains number. Read-only. + + + + + Indicates whether cell contains formatted rich text string. + + + + + Indicates whether the range contains String. Read-only. + + + + + Indicates whether range has default style. False means default style. + Read-only. + + + + + Returns or sets the horizontal alignment for the specified object. + Read/write OfficeHAlign. + + + + + Returns or sets the indent level for the cell or range. Can be an integer + from 0 to 15 for Excel 97-2003 and 250 for Excel 2007. Read/write Integer. + + + + + Indicates whether the range is blank. Read-only. + + + + + Indicates whether range contains boolean value. Read-only. + + + + + Indicates whether range contains error value. + + + + + Indicates whether this range is grouped by column. Read-only. + + + + + Indicates whether this range is grouped by row. Read-only. + + + + + Indicates whether cell is initialized. Read-only. + + + + + Returns last column of the range. Read-only. + + + + + Returns last row of the range. Read-only. + + + + + Gets / sets double value of the range. + + + + + Format of current cell. Analog of Style.NumberFormat property. + + + + + Returns the number of the first row of the first area in + the range. Read-only Long. + + + + + Row group level. Read-only. + -1 - Not all rows in the range have same group level. + 0 - No grouping, + 1 - 7 - Group level. + + + + + Returns the height of all the rows in the range specified, + in points. Returns Double.MinValue if the rows in the specified range + aren't all the same height. Read / write Double. + + + + + For a Range object, returns an array of Range objects that represent the + rows in the specified range. + + + + + For a Range object, returns an array of Range objects that represent the + columns in the specified range. + + + + + Returns a Style object that represents the style of the specified + range. Read/write IStyle. + + + + + Returns name of the Style object that represents the style of the specified + range. Read/write String. + + + + + Gets / sets string value of the range. + + + + + Gets / sets time value of the range. + + + + + Returns or sets the value of the specified range. + Read/write Variant. + + + + + Returns or sets the cell value. Read/write Variant. + The only difference between this property and the Value property is + that the Value2 property doesn't use the Currency and Date data types. + + + + + Returns or sets the vertical alignment of the specified object. + Read/write OfficeVAlign. + + + + + Returns a Worksheet object that represents the worksheet + containing the specified range. Read-only. + + + + + Gets / sets cell by row and index. + + + + + Get cell range. + + + + + Get cell range. + + + + + Gets cell range. Read-only. + + + + + + + + + + + + + + + Returns the calculated value of the formula as a boolean. + + + + + Returns the calculated value of the formula as a string. + + + + + String with rich text formatting. Read-only. + + + + + Indicates whether this range is part of merged range. Read-only. + + + + + Returns a Range object that represents the merged range containing + the specified cell. If the specified cell isn�t in a merged range, + this property returns NULL. Read-only. + + + + + True if Microsoft Excel wraps the text in the object. + Read/write Boolean. + + + + + Indicates is current range has external formula. Read-only. + + + + + Represents ignore error options. If not single cell returs concatenateed flags. + + + + + Indicates whether all values in the range are preserved as strings. + + + + + Gets/sets built in style. + + + + + Gets address global in the format required by Excel 2007. + + + + + Number of cells in the range. Read-only. + + + + + Returns item by index from the collection. + + + + + Implements a two-dimensional table that holds an SFArrayList of rows. Each row + is an SFArrayList of objects. + + +

This is a memory efficient way to represent a table where values can remain empty. Only rows + that actually contain data will allocate an SFArrayList and the array only holds + as many objects as the specific row contains columns.

+

When you access data that are out of range, an empty () object will be returned. + If you set data that are out of range, an exception will be thrown. If you set data for + a row that is empty, the row will be allocated before the value is stored.

+

SFTable provides methods that let you insert, remove or rearrange columns or m_arrRows + in the table.

+ + + + + Number of m_arrRows in the collection. + + + + + Collection of rows. + + + + + First created row. + + + + + Last created row. + + + + + Indicates whether object was disposed. + + + + + This array contains all shared formulas found during parsing. + + + + + Parent workbook. + + + + + Parent worksheet. + + + + + Initializes a new instance of the + class. + + + Initializes a new instance of the + class that is empty. + + Number of rows in the collection. + Parent worksheet object. + + + + Initializes a new instance of the + class and optional copies of data from an existing table. + + Represents record table data. + Indicates is clone. + Parent worksheet object. + + + + + + + + + Object finalizer. + + + + + Creates a deep copy of the . + + Parent worksheet object. + + A deep copy of the . + + + + + Removes all elements from the . + + + + + Creates a collection of cells for a row. + + Zero-based row index. + Row height. + Excel version. + An SFArrayList or derived object for the cell collection. + + + + Indicates whether an element is at the specified coordinates in the . + + The zero-based row index. + The zero-based column index. + + + if an element exists at the specified coordinates in the ; + otherwise. + + + + + Updates first and last row indexes. + + Zero-based index of the created row. + + + + Sets row. + + Zero-based row index to set. + Row object to set. + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + Removes last column from the worksheet. + + Zero-based column index. + + + + Removes row from the worksheet. + + Zero-based row index to remove. + + + + Updates indexes to named ranges. + + Parent workbook. + New indexes. + + + + Replaces all shared formula with ordinary formula. + + + + + + Replaces all shared formula with ordinary formula. + + + + + Updates string indexes. + + List with new indexes. + + + + Copies cells from another worksheet. + + Source cells collection to copy cells from. + Source SST dictionary. + Destination SST dictionary. + Dictionary with new extended format indexes. + Dictionary with new worksheet names. + Dictionary with new name indexes. + Dictionary with new font indexes. + + + + Returns found values or null. + + Storage range. + Value for finding. + If true - finds first value; otherwise - all values. + If findfirst - true then returns range; otherwise - array with all found values. + Parent workbook. + + + + + Returns found values or null. + + Storage range. + Value to find. + If true - finds first value; otherwise - all values. + Way to find the value. + If findfirst - true then returns range; otherwise - array with all found values. + The book. + + List with cell indexes that contains specified value. + + + + + Returns found values or null. + + Storage range. + Value for finding. + If true - finds first value; otherwise - all values. + If findfirst - true then returns range; otherwise - array with all found values. + Parent workbook. + + + + + Returns found values or null. + + Storage range. + Value for finding. + Indicates whether we should look for error code or boolean value. + If findfirst - true then returns range; otherwise - array with all found values. + Parent workbook. + + + + + Returns minimum used column. + + Start row. + End row. + Minimum used column. + + + + Returns maximum used column. + + Start row. + End row. + Maximum used column. + + + + Determines whether collection contains row. + + Zero-based row index. + True if the collection contains at least one element with specified row index; otherwise, False. + + + + + + + + + + Caches and removes specified rectangle from the table. + + Source rectangle. + Row delta to add to the resulting table. + Column delta to add to the resulting table. + Output maximum zero-based row index. + Output maximum zero-based column index. + Cached table. + + + + This method should be called immediately after extended format removal. + + Dictionary with updated extended formats. + + + + This method should be called immediately after extended format removal. + + Array with updated extended formats. + + + + This method updates indexes to the extended formats after version change. + + New restriction for maximum possible XF index. + + + + Updates LabelSST indexes after SST record parsing. + + Dictionary with indexes to update, key - old index, value - new index. + + + + Adds shared formula to record table. + + Row index of the cell containing shared formula description. + Column index of the cell containing shared formula description. + Shared formula record to add. + + + + Returns row from the collection or creates one if necessary. + + Zero-based row index. + Row height. + Indicates whether to create row if it doesn't exist. + Excel version. + Desired row object. + + + + Ensures that array will be able to handle desired number of rows. + + + + + + Gets bool value by row or column indexes. Without check input parameters. + + One based row index. + One based column index. + If found - returns value; otherwise - 0. + + + + Gets formula bool value by row or column indexes. Without check input parameters. + + One based row index. + One based column index. + If found - returns value; otherwise - 0. + + + + Gets error value by row or column indexes. Without check input parameters. + + One based row index. + One based column index. + If found - returns value; otherwise - null. + + + + Gets formula error value by row or column indexes. Without check input parameters. + + One based row index. + One based column index. + If found - returns value; otherwise - null. + + + + Gets number value by row or column indexes. Without check input parameters. + + One based row index. + One based column index. + If found - returns value; otherwise - double.NaN. + + + + Gets formula number value by row or column indexes. Without check input parameters. + + One based row index. + One based column index. + If found - returns value; otherwise - double.NaN. + + + + Gets string value by row or column indexes. Without check input parameters. + + One based row index. + One based column index. + Represents sst dictionary. + If found - returns value; otherwise - null. + + + + Gets string value by row or column indexes. Without check input parameters. + + One based row index. + One based column index. + Represents sst dictionary. + If found - returns value; otherwise - null. + + + + Gets array of formula ptg. + + One based row index. + One based column index. + If found - returns ptg array; otherwise - null. + + + + Indicates if there is formula record. + + One based row index. + One based column index. + Indicates whether formula record is contained. + + + + Indicates is contain formula array. + + Zero based row index. + Zero based column index. + If found return true; otherwise - false. + + + + Gets cell type from current column. + + Indicates row. + Indicates column. + Indicates is need to indentify formula sub type. + Returns cell type. + + + + Sets formula value. Use for setting FormulaError, FormulaBoolean, FormulaNumber, FormulaString values. + + One based row index. + One based column index. + Represents value for set. + Represents string record as formula string value. Can be null. + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Return parent Application object. Read-only. + + + + + Return parent Application object. Read-only. + + + + + Returns the SFArrayList from all rows. + + + + + Gets the number of rows contained in the . Read-only. + + + + + Returns zero-based index of the first created row. + + + + + Returns zero-based index of the last created row. + + + + + Gets / sets an element at the specified coordinates in the . + + The zero-based row index. + The zero-based column index. + + If you query for an element and the coordinates are out of range, an empty () object will be returned. + If you set an element and the the coordinates are out of range, an exception is thrown. + + + + + Returns List with shared formulas. Read-only. + + + + + Number of shared formulas. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + Represents enumerator for SFTable + + + + + Table to enumerate. + + + + + One-based current row index. + + + + + SFTable to enumerate. + + + + + Offset inside current row. + + + + + To prevent creation instances of this class without arguments. + + + + + Initializes new instance of the enumerator. + + Table to enumerate. + + + + Sets the enumerator to its initial position, which is before + the first element in the collection. + + + + + Advances the enumerator to the next element of the collection. + + + + + + Moves pointer to the next non-empty row if it is possible. + + True if operation succeeded. + + + + Gets the current element in the collection. + + + + + Gets the key of the current dictionary entry. Read-only. + + + + + Gets the value of the current dictionary entry. Read-only. + + + + + Gets both the key and the value of the current dictionary entry. Read-only. + + + + + Stores single row data and gives functionality to access and modify it. + + + + + Contains outline information about. + + + + + Outline level. + + + + + Indicates whether object is collapsed. + + + + + Indicates whether object is hidden. + + + + + Index of extended format. + + + + + Row or column index. + + + + + Memory block will be divisible of this value. + + + + + Represents MULRK xf indexes period. + + + + + Represents MULBLANK xf indexes period. + + + + + Indicates the dot symbol + + + + + Records that are not simply ICellPositionFormat records but that contains multiple subrecords. + + + + + First record type - record that can contain several sub records, second + record type - type of the single record corresponding to the multi record type. + + + + + Zero-based index of the first column. + + + + + Zero-based index of the last column. + + + + + Size of used data. + + + + + Data provider. + + + + + Storage options. + + + + + Column that is referenced by m_iCurrentOffset. -1 - means that we have no correct offset. + + + + + Offset in the data storage to the record with m_iCurrentColumn. + + + + + Workbook object. + + + + + Represents the row index. + + + + + Represents the cells contains WrapText + + + + + Height of the row, in twips = 1/20 of a point. + + + + + Options flag. + + + + + + + + + + Preserves Table record for datatable support + + + + + Default constructor. + + + + + + + + Performs application-defined tasks associated with freeing, + releasing, or resetting unmanaged resources. + + + + + Disposes this object. + + + + + Returns row storage enumerator. + + Record extractor to get Biff records from. + + + + + Sets cell style. + + Zero-based row index. + Zero-based column index. + Index of the extended format to set. + Memory allocation elementary block size. + + + + Creates new record based on the data at the specified position. + + Offset to the record. + + + + + Returns record corresponding to the specified cell. + + Zero-based column index. + Memory allocation elementary block size. + Record corresponding to the specified cell. + + + + Returns record corresponding to the specified cell. + + Zero-based column index. + Memory allocation elementary block size. + Object used to extract records from internal data array. + Record corresponding to the specified cell. + + + + Sets cell data. + + Zero-based column index of the cell. + Cell to set. + Memory allocation elementary block size. + + + + Removes all data saving cells formatting. + + + + + Returns formula string value. + + Zero-based column index. + Value to set. + Memory allocation elementary block size. + + + + Sets array record. + + Zero-based column index. + Record to set. + Memory allocation elementary block size. + + + + Returns array record. + + Offset to the record. + Formula array record. + + + + Returns array record. + + Zero-based column index. + Corresponding array record. + + + + Creates copy of the storage. + + RowStorage with copied data. + + + + Creates copy of the storage. + + RowStorage with copied data. + + + + Creates copy of the storage. + + Zero-based index of the first column to copy. + Zero-based index of the last column to copy. + Memory allocation elementary block size. + RowStorage with copied data. + + + + Creates copy of the storage. + + Source strings table. + Destination strings table + Dictionary with new extended format indexes. + Dictionary with new worksheet names. + New name indexes. + Dictionary with new font indexes. + RowStorage with copied data. + + + + Creates copy of the storage. + + Zero-based index of the first column to copy. + Zero-based index of the last column to copy. + Represents allocation block size. + + + + Indicates whether row contains record with specified index. + + Zero-based column index to find. + True if required record was found. + + + + Inserts data from another row object. + + Source row data. + Memory allocation elementary block size. + Heap handle that must be used to allocate memory. + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + Memory allocation elementary block size. + Parent workbook. + + + + Adds specified values to row and columns indexes. + + Value to add to row index. + Value to add to column index. + Memory allocation elementary block size. + + + + Updates indexes to named ranges. + + Parent workbook. + New indexes. + Memory allocation elementary block size. + + + + Replaces all shared formula with ordinary formula. + + Parent workbook. + Shared formula that should be replaced. + + + + Updates string indexes. + + List with new indexes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Checks the string value. + + The first. + The second. + The options. + The book. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Moves pointer to the next record. + + Offset of the current record. + Offset to the next record. + + + + This method should be called immediately after extended format removal. + + Dictionary with updated extended formats. + Memory allocation elementary block size. + + + + This method should be called immediately after extended format removal. + + Array with updated extended formats. + Memory allocation elementary block size. + + + + This method updates indexes to the extended formats after version change. + + New restriction for maximum possible XF index. + Index to the default extended format. + + + + Updates LabelSST indexes after SST record parsing. + + Dictionary with indexes to update, key - old index, value - new index. + + + + Appends storage with record's data. + + Record type. + Data length. + Array with required data. + Memory allocation elementary block size. + + + + Appends storage with record's data. + + Record type. + Data length. + Array with required data. + Memory allocation elementary block size. + + + + Appends storage with record's data. + + Data length. + Array with required data. + Memory allocation elementary block size. + + + + Appends storage with record's data. + + Zero-based column index to insert data. + Data length. + Array with required data. + Memory allocation elementary block size. + + + + Appends storage with record's data. + + Records to append. + Temporary buffer for record data. + Indicates whether we have to ignore styles. + Memory allocation elementary block size. + + + + Converts all MultiRK and MultiBlank records into set of RK / Blank records. + + Indicates whether styles must be ignored. + Memory allocation elementary block size. + + + + Compresses data storage - combines several rk/blank records into one MulRK/MulBlank records. + + + + + + + + + Indicates whether fast parsing is turned on. If it is not then we don't + need to update FirstColumn and LastColumn indexes. + + + + + Creates RowRecord and copies all required data into it. + + Parent workbook. + Created record. + + + + Copies row settings (default style, height and some other settings) from another row storage. + + Storage to copy settings from. + + + + Sets default row options. + + + + + Updates column indexes of the specified row. + + Column index. + Last column index. + + + + + + + Memory allocation block size. + + + + Returns extended format index for the specified column or int.MinValue if not found. + + Zero-based column index. + Extended format index for the specified column or int.MinValue if not found. + + + + Looks through all records and calls AddIncrease for each LabelSST record. + + Dictionary to update. + + + + + + + + + + + Updates columns indexes. + + + + + Iterates through all cells in the row. + + Method to call for each cell. + Data to pass to the calling method. + + + + Sets items with used reference indexes to true. + + Record type to check. + Offset to the record to check. + Array to mark used references in. + + + + Updates reference indexes. + + Represents Biff record type. + Represents offset value. + Data to be updated. + + + + + + + + + + Sets items with used reference indexes to true. + + Represents used items. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Searches for the record of specified type. + + Record type to look for. + Zero-based index of the column to start looking at. + Zero-based index of the column to end looking at. + Column index that contains record of the specified type or value beyond endColumn if not found. + + + + Searches for the first cell in the specified range. + + Zero-based column index to start search at. + Zero-based column index to end search at. + + + + + Gets indexes of the used named range objects. + + Collection to put named range indexes into. + + + + Adds all named range indexes referenced by formula tokens into resulting dictionary. + + Dictionary that will get named range tokens. + Tokens to check. + + + + Inserts records data into data storage. + + Position to insert at. + Array of records to insert. + + + + Sets cell position size to 4 and converts internal data storage. + + + + + Sets cell position size to 4 and converts internal data storage. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Evaluates number of records in this storage. + + Number of records. + + + + Updates all required indexes after copying row into another worksheet. + + Source SST dictionary. + Destination SST dictionary. + Dictionary with new extended format indexes. + Dictionary with new worksheet names. + Dictionary with new name indexes. + Dictionary with new font indexes. + + + + Updates MulRK or MulBlank XF Indexes. + + HashTable with new XF Indexes. + Represents offset on start mull record. + Record length without header. + Indicates whether offset is offset to MulRK record (TRUE) or to MulBlank record (false). + + + + Updates sst records. + + Represents source sst. + Represents destination sst. + Represents offset to add. + + Dictionary with new font indexes. + + + + Updates formula indexes. + + Represents source SST. + Represents destination sst. + Represents offset. + Represents hash table with worksheet names. + Represents dic name indexes. + Represents length + + + + Updates sheet references in the formula. + + Formula to update. + Dictionary with new worksheet names. + Source workbook. + Destination workbook. + True if any changes were made. + + + + Updates named range references in the formula. + + Formula to update. + Dictionary with new name indexes. + True if any changes were made. + + + + Updates sheet references in the formula. + + Formula to update. + Dictionary with new worksheet names. + Source workbook. + Destination workbook. + Represents dictionary with name indexes. + True if any changes were made. + + + + Indicates whether multi- record contains records of the same type as specified one. + + Cell type to check. + Offset to the multi- record. + True if record types are compatible. + + + + Splits record into two parts by removing subrecord with specified column index. + + Offset to the record to split. + Column index to split by. + Memory allocation elementary block size. + Offset to the second part. + + + + Inserts record inside record that contains multiple values. + + Offset to the record to insert into. + Record to insert. + + + + Inserts record data into storage. + + Offset to the record. + Size that could be overwritten by new record. + Size required by new record. + Record to write. + Memory allocation elementary block size. + + + + Inserts record data into storage. + + Offset to the record. + Size that could be overwritten by new record. + Records to write. + Memory allocation elementary block size. + + + + Locates record in the row. + + One-based column index of the record to find. + Indicates whether record was found. + Offset where record should be placed. + + + + Locates record in the row. + + One-based column index of the record to find. + Indicates whether record was found. + Indicates is found multi record or not. + If true returns offset on valid mull rk structure, by current column index. + Otherwise on MulRk record. + Offset where record should be placed. + + + + + + + + + + + + + + + + + Ensures that internal data storage will be able to store specified number of bytes. + + Required data storage size. + Memory allocation elementary block size. + + + + Updates row dimension information. + + Accessed zero-based column index. + + + + Updates row dimension information. + + Accessed zero-based column index. + Cell that was set. + + + + Removes formula string record. + + Zero-based column index. + Old offset to the string record. + + + + Removes formula string record. + + Zero-based column index. + Returns offset to the corresponding FormulaRecord. + Old offset to the string record. + + + + Removes record from the storage. + + Offset to the record to remove. + + + + Moves pointer to the next record. + + Offset of the current record. + Offset to the next record. + + + + Returns offsets, first one (X) is position before start column and the second one (Y) after end column. + + Zero-based index of the start column. + Zero-based index of the end column. + Output start column index. + Output end column index. + Point with evaluated offsets. + + + + Evaluates offset after specified record and satellite records. + + Offset to the record. + Offset after specified record and satellite records. + + + + Creates multi record. + + Type of sub record. + Created record. + + + + Tries to get record for the next column. + + Column index. + Records that corresponds to the column index. + Current record offset. + Indicates whether record is multi- record. + Record corresponding to the + + + + Returns last column index from the multi- record. + + Offset to the record's start. + Last column index from the multi- record. + + + + Sets cell data without trying to create multi record. + + Zero-based column index of the cell. + Cell to set. + Memory allocation elementary block size. + + + + Evaluates size of the data in the compressed state. + + Compressed data size. + + + + Simply skips record. + + User data. + Offset after skipping record data. + + + + Skips RK records. + + User data. + Offset after skipping record data. + + + + Skips RK records. + + User data. + Offset after skipping record data. + + + + Simply skips record. + + User data. + Offset after skipping record data. + + + + Writes RK records into data array. + + User data. + Offset after skipping record data. + + + + Writes Blank records into data array. + + User data. + Offset after skipping record data. + + + + Creates MulRK record based on set of RK records. + + + Class that contains additional information needed to create + MulRK record correctly. + + Number of RK records. + Created record. + + + + Creates MulRK record based on set of RK records. + + Offset to the first RK record. + Number of RK records. + Created record. + + + + Creates MulBlank record based on set of Blank records. + + Offset to the first Blank record. + Number of Blank records. + Created record. + + + + + + + + + + + + + + + + + + + + + + + Creates multi-cell record (MulRK or MulBlank) at the specified offset. + + Offset to the record to create. + Instance of MulBlank record. + Instance of MulRK record. + Record length including header. + Created record or null if there is incorrect record type. + + + + + + + + + + + + Gets row from the record. + + Offset to the record's start. + Zero-based row index. + + + + Sets row for the record. + + Offset to the record's start. + Zero-based row index to set. + + + + Gets column from the record. + + Offset to the record's start. + Zero-based column index. + + + + Sets column for the record. + + Offset to the record's start. + Zero-based column index to set. + + + + Gets last column index from the MulRk or MulBlank record. + + Offset to the record's start. + Record length. + Zero-based column index. + + + + Gets XF index from the record. + + Offset to the record's start. + Indicates whether record is multi record or not. + Zero-based index to the extended format record with style settings. + + + + Sets XF index for the record. + + Offset to the record's start. + Zero-based index to the extended format record with style settings to set. + + + + Sets XF index inside of "multi" record (MulRK or MulBlank). + + Offset to the record's start. + Zero-based index to the extended format record with style settings to set. + Zero-based column index of the cell to set style. + Size of subrecord inside of multi record. + + + + Size of the required storage space. Read-only. + + + + + Gets bool value by column index. Without check input parameters. + + One based column index. + If found - returns boolean value; otherwise - 0. + + + + Gets formula bool value by column index. Without check input parameters. + + One based column index. + If found - returns boolean value; otherwise - 0. + + + + Gets error value by column index. Without check input parameters. + + One based column index. + If found - returns error value; otherwise - null. + + + + Gets formula error value by column index. Without check input parameters. + + One based column index. + If found - returns error value; otherwise - null. + + + + Gets number value. + + Column index. + Returns number value or NaN. + + + + Checks the format. + + The format. + + + + + Gets formula number value. + + Column index. + Returns number value or NaN. + + + + Gets string value. + + Column index. + Represents sst dictionary. + Returns string value or null. + + + + Returns formula string value. + + Zero-based column index. + String result of the formula. + + + + Returns formula string value. + + Offset to record. + Formula string value. + + + + Gets string value. + + Column index. + Returns ptg array or null. + + + + Gets cell type from current column. + + Indicates column. + Indicates is need to indentify formula sub type. + Returns cell type. + + + + Gets sub formula type. + + Represents offset on start formula record. + + + + + Indicates if there is formula record. + + Zero based column index. + Indicates whether formula record is contained. + + + + Indicates is contain formula array. + + Zero based column index. + If found return true; otherwise - false. + + + + Gets error string by number. + + Represents number. + Returns error string or null. + + + + Sets the workbook. + + The book. + The i row. + + + + Sets formula value. Use for setting FormulaError, FormulaBoolean, FormulaNumber, FormulaString values. + + Zero based column index. + Represents value for set. + Represents string record as formula string value. Can be null. + Memory allocation elementary block size. + + + + Zero-based index of the first column. Read/write. + + + + + Zero-based index of the last column. Read/write. + + + + + Size of used data. Read-only. + + + + + Size of allocated data. Read-only. + + + + + Gets or sets the value indicating whether storage possibly contains Rk or Blank records. + + + + + Gets or sets the value indicating whether storage possibly contains MultiRk or MultiBlank records. + + + + + Indicates that storage was disposed. Read-only. + + + + + Zero-based index of the first column. Read/write. + + + + + Returns internal data provider. Read-only. + + + + + Returns size of the cell position block. Read-only. + + + + + + + + + + Returns type code of the biff storage. Read-only. + + + + + Returns code of the biff storage. Read-only. + + + + + Indicates whether data array is required by this record. Read-only. + + + + + Indicates record position in stream. This is a utility member of class and + is used only in the serialization process. Does not influence the data. + + + + + Height of the row, in twips = 1/20 of a point. + + + + + If the row is formatted, then this is the index to + the extended format record. + + + + + The outline level of this row. + Changes some bits of m_usOptionFlags private member. + + + When value is more than 7. + + + + + Whether or not to collapse this row. + + + + + Whether or not to display this row with 0 height. + + + + + Whether the font and row height are not compatible. + True if they aren't compatible. + + + + + Whether the row has been formatted (even if it has all blank cells). + + + + + True if there is additional space above the row. + + + + + True if there is additional space below the row. + + + + + Undocumented bit flag. If it is set to False, then Excel will + not show row groups. Default value is True. + + + + + Row or column index. + + + + + Storage options. + + + + + None. + + + + + Indicates that storage contains (or can contain) some RK or Blank records. + + + + + Indicates that storage contains (or can contain) some MultiRK or MultiBlank records. + + + + + Indicates that storage was disposed. + + + + + Calls each cell. + + Record type to check. + Offset to the record to check. + Data to be passed. + + + + Data for size evaluation. + + + + + Start offset. + + + + + Used size. + + + + + Data for writing defragmented data. + + + + + Offset to the record data in the old storage. + + + + + Size of the data. + + + + + Delegate used for defragmentation. + + + + + Represents enumerator for RowStorage + + + + + RowStorage to enumerate. + + + + + Offset to current cell. + + + + + Record extractor. + + + + + To prevent creation instances of this class without arguments. + + + + + Initializes new instance of the enumerator. + + RowStorage to enumerate. + Record extractor to get Biff records from. + + + + Sets the enumerator to its initial position, which is before + the first element in the collection. + + + + + Advances the enumerator to the next element of the collection. + + + + + + Returns formula array record from current cell if it exists. + + Formula array record; null - if doesn't exist. + + + + Returns formula string value if formula contains it. + + + + + + Gets the current element in the collection. + + + + + Gets current cell row. + + + + + Gets current cell column. + + + + + Gets current cell extended format. + + + + + Extends List with MoveRange, InsertRange and RemoveRange methods. The Item property + will grow the array on demand or return NULL if an index is out of range. + + + + + Overloaded. Initializes a new instance of the SFArrayList + class that is empty and has the default initial capacity. + + + + + Initializes a new instance of the SFArrayList class that contains + elements copied from the specified collection and has the same initial + capacity as the number of elements copied. + + The whose elements are copied to the new list. + + + + Overridden. Creates a deep copy of the SFArrayList. + + + A deep copy of the SFArrayList. + + + + + Enlarges the array if needed. + + The size to be checked. If the array has less elements, empty () objects will be appended + at the end of the array. + + + + Gets / sets the element at the specified index. + In C#, this property is the indexer for the SFArrayList class. + + The zero-based index of the element to get / set. + + The element at the specified index. + When querying the value and the index is out of range, an empty () object will be returned. + When setting the value and the index is out of range the array will be enlarged. See SFArrayList.EnsureCount + + + + + Implements a two-dimensional table that holds an SFArrayList of rows. Each row + is an SFArrayList of objects. + + +

This is a memory efficient way to represent a table where values can remain empty. Only rows + that actually contain data will allocate an SFArrayList and the array only holds + as many objects as the specific row contains columns.

+

When you access data that are out of range, an empty () object will be returned. + If you set data that are out of range, an exception will be thrown. If you set data for + a row that is empty, the row will be allocated before the value is stored.

+

SFTable provides methods that let you insert, remove or rearrange columns or m_arrRows + in the table.

+ + + + + Number of m_arrRows in the collection. + + + + + Number of columns in the collection. + + + + + Collection of rows. + + + + + Number of cells in the collection. + + + + + Initializes a new instance of the + class. + + + Initializes a new instance of the + class that is empty. + + Number of rows in the collection. + Number of columns in the collection. + + + + Removes all elements from the . + + + + + Creates a collection of cells for a row. + + An SFArrayList or derived object for the cell collection. + + + + Returns the SFArrayList from all rows. + + + + + Gets / sets an element at the specified coordinates in the . + + The zero-based row index. + The zero-based column index. + + If you query for an element and the coordinates are out of range, an empty () object will be returned. + If you set an element and the the coordinates are out of range, an exception is thrown. + + + + + Collection of worksheet's shapes. + + + + + Represents shapes collection in the workbook. + + + + + Adds new chart shape to the collection. + + Newly added shape. + + + + Adds shape copy to shapes collection. + + Shape to copy. + Dictionary with new names of worksheets. + List with new font indexes. + Added shape. + + + + Adds new text box to the collection. + + Newly created textbox. + + + + Returns the number of objects in the collection. Read-only Long. + + + + + Returns single shape from the collection by its index. + + + + + Returns single shape from the collection by its name or null when cannot find. Read-only. + + + + + Default start of the chart shape name. + + + + + Default start of the textbox shape name. + + + + + Default start of the checkbox shape name. + + + + + + Default start of the combobox shape name. + + + + + Default start of the picture shape name. + + + + + Default start of the ole object name. + + + + + + + + + + + + Initializes collection + + + + + Adds new chart shape to the collection. + + Newly added shape. + + + + Adds new textbox shape to the collection. + + Newly added shape. + + + + Creates new shape to object to this collection. + + Object type to create. + Shape container. + Parse options. + Subrecords of the shape's OBJRecord. + Index to the cmo record inside subrecords. + Created shape. + + + + Adds picture to collections. + + Represents picture to add. + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + Creates copy of the collection. + + Parent object for the new collection. + Copy of the collection. + + + + Removes all shapes that are out of new dimensions. + + Version to set. + + + + Create a group shape for selected items. + + Group shape to add inner shapes. + Shape array to add in the group shape. + Newly created group shape + + + + Removes group shape from the collection. + + Shape to remove. + + + + Returns shared shape data for all shapes in this collection. Read-only. + + + + + A collection of all the Style objects in the specified or active + workbook. Each Style object represents a style description for a + range. The Style object also contains all style attributes (font, + number format, alignment, and so on) as properties. There are + several built-in styles � including Normal, Currency, and Percent + � which are listed in the Style name box in the Style dialog box + (Format menu). + + + + + A collection of all the Style objects in the specified or active + workbook. Each Style object represents a style description for a + range. The Style object contains all style attributes (font, + number format, alignment, and so on) as properties. There are + several built-in styles including Normal, Currency, and Percent + which are listed in the Style name box in the Style dialog box. + (Format menu). + + + + + Creates a new style and adds it to the list of styles that are + available for the current workbook. Returns a Style object. + + Name of the newly created style. + Prototype for the style. + Newly created style. + + + + Creates a new style and adds it to the list of styles that are + available for the current workbook. Returns a Style object. + + Name of the created style. + Newly created style. + + + + Method return true if collection contains style + with specified by user name. + + Name to check. + True - if style exists, otherwise False. + + + + Used without an object qualifier, this property returns an Application + object that represents the Microsoft Excel application. + + + + + Returns the number of objects in the collection. Read-only, Long. + + + + + Returns a single object from a collection. + + + + + Returns a single object from a collection. + + + + + Returns the parent object for the specified object. + + + + + RB-tree for quick style search operation. + + + + + Collection of all the styles in the workbook. + + + + + Dictionary StyleXFIndex to StyleImpl. + + + + + Parent workbook. + + + + + + + + + + + + + + + Creates the collection and sets its Application and Parent properties. + + The application object for this collection. + The parent object for this collection. + + + + Creates a new style and adds it to the list of styles that are + available for the current workbook. Returns a Style object. + + Name of the newly created style. + Prototype for the style. + Newly created style. + + If name is NULL. + + + When collection already contains style with specified name. + + + + + Creates a new style and adds it to the list of styles that are + available for the current workbook. Returns a Style object. + + Name of the newly created style. + Newly created style. + + + + Adds specified style into this collection. + + Style that must be added. + + + + Adds specified style to collection. + + Style to add. + If true and ContainName then replace old name; otherwise add. + + + + Method returns True if collection contains style + with specified by user name. + + Name to check. + True if style exists; otherwise False. + + + + Compares two styles. + + The first style to compare. + The second style to compare. + True if styles are the same; otherwise False. + + + + Compare all Border Collections items. + + First border to compare. + Second border to compare. + True if borders are the same; otherwise False. + + + + Compare Border interfaces. + + First border to compare. + Second border to compare. + True if borders are the same; otherwise False. + + + + Generates default name. + + Name prefix. + Dictionary with used names. + Automatically generated unique name. + + + + Creates built in style. + + Name of the style. + Created style. + + + + Returns style corresponding to the index of extended format. + + Index of the extended format to find. + Found style. + + + + Searches in collection for style named styleName. + + Style name to search. + Searched style if found; otherwise returns NULL. + + + + Method checks whether the collection contains a style with the specified name. + + Name to check. + True if style exits; otherwise False. + + + + Adds new style to the collection. + + Style to add. + + + + Creates copy of the current instance. + + Parent object for the new collection. + Copy of the current instance. + + + + Performs additional processes after clearing the collection. + + + + + Performs additional processes after inserting a new element into the collection. + + The zero-based index at which to insert value. + The new value of the element at the index. + + + + Performs additional processes after removing an element from the collection. + + The zero-based index at which value can be found. + The value of the element to remove from the index. + + + + Performs additional processes after setting a value in the collection. + + The zero-based index at which oldValue can be found. + The value to replace with newValue. + The new value of the element at the index. + + + + + + + + + + + + + + + + + + Clears hashIndexToStyle member. + + + + + Returns a single object from a collection. Read-only. + + + + + + + + + + Represents worksheet's textbox collection. + + + + + This interface represents TextBoxes collection inside single worksheet. + + + + + Returns number of items in the collection. + + + + + Parent worksheet. + + + + + Initializes new instance of the collection. + + Application object for the new instance. + Parent object for the new instance. + + + + Adds new item to the collection. + + Textbox to add. + + + + Collection of the Workbook names (NamedRanges). + + + + + A collection of all the Name objects in the application or + workbook. Each Name object represents a defined name for a + range of cells. + + + + + Defines a new name. + + Name for the new Name object. + Returns a Name object. + + + + Defines a new name. + + Name object to add. + + + + Removes Name object from the collection. + + Name of the object to remove from the collection. + + + + Removes the element at the specified index of the collection. + + The zero-based index of the element to remove. + + + + Checks whether the Name object is present in the collection or not + + Name object to check whether it is present or not. + + + + + Used without an object qualifier, this property returns an Application + object that represents the Excel application. + + + + + Returns the number of objects in the collection. Read-only Long. + + + + + Returns the parent object for the specified object. + + + + + Returns a single Name object from a Names collection. + + + + + Returns a single Name object from a Names collection. + + + + + Dictionary Name-to-IName. + + + + + Parent workbook for the collection. + + + + + Flags indicating whether WorkbookNamesCollection changed. + + + + + Creates an empty collection. + + Application object for the collection. + Parent object for the collection. + + + + + + + + + + + Checks whether name of named range contains invalid characters. + + + + + + Checks the namedRange's name is a valid name based on the + Excel version. + + name to check. + Active workbook. + True, if the name is valid. + + + + Defines a new name. Returns a Name object. + + IName object that must be added to the collection. + Created IName object. + + If the collection already contains object with the same name. + + + + + Removes specified name from the collection. + + Name of the object to remove. + + + + Removes specified name from the collection. + + Name of the object to remove. + + + + + + + + + + + Represents the given range presents in the workbook names collection + + Name + Indicate whether formula range or not + true/false + + + + Updates named range when inserting row. + + Represents row index. + Represents row count. + Represents sheet for update. + + + + Updates named range when deleting row. + + Represents row index. + Represents sheet for update. + + + + Updates named range when deleting row. + + Represents row index. + Represents sheet for update. + Number of rows to remove. + + + + Updates named ranges after column insertion. + + One-based column index. + Number of columns to insert. + Represents reference sheet name. + + + + Updates named ranges after column removal. + + One-based column index. + Represents reference sheet name. + + + + Updates named ranges after column removal. + + One-based column index. + Represents reference sheet name. + Number of columns to remove. + + + + Defines a new name. Returns a Name object. + + NameRecord describing new Name object. + Newly created Name object. + + If the collection already contains object with the same name. + + + When specified NameRecord is NULL. + + + + + Adds into list and hashtable, for local named ranges. + + Name to add. + + + + Adds into list and hashtable, for local named ranges. + + Name to add. + Indicates is adds in global names hash. + + + + Adds copy of global name during worksheet copy. + + Name to copy. + Destination worksheet. + Dictionary with new extern worksheet names. + Dictionary with new worksheet names. + Added name. + + + + Creates a copy of the current collection. + + Parent object for the new collection. + A copy of the current collection. + + + + Performs additional processes after inserting a new element into the collection. + + The zero-based index at which to insert value. + The new value of the element at the index. + + + + Converts full row or column tokens between versions. + + Version to convert into. + + + + Returns a single Name object from a Names collection. + + + + + Sets parent workbook value. + + + When parent workbook cannot be found. + + + + + Inserts/removes rows/columns from all named ranges in the collection. + + Represents sheet name. + Index of row/column to insert/remove. + Indicates whether we should remove rows or columns. + Indicates whether we are operating with rows. + Number of rows/columns to insert/remove. + + + + Inserts/removes row from all named ranges in the collection. + + + + + + + + + + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Returns a single Name object from a Names collection. + + + + + Returns a single Name object from a Names collection. + + + + + Represent the known named ranges count + The name in the formula which has no reference is + unknown named ranges + + + + + Represents the known and unknown named + ranges Count + + + + + set Flags m_bWorkNamesChanged + + + + + + Summary description for WorkbookObjectsCollection. + + + + + Summary description for ITabSheets. + + + + + Returns number of elements in the collection. Read-only. + + + + + Returns single entry from the collection by its index. Read-only. + + + + + Dictionary name of the object - to - value. + + + + + Parent workbook. + + + + + Creates a collection and sets its Application and Parent properties. + + Application object for the collection. + Parent object for the collection. + + + + Add new object to the collection. + + Named object to adding. + + + + Disposes internal data. + + + + + Creates copy of the collection. + + Parent object for the new collection. + A copy of the collection. + + + + Searches for all necessary parents. + + + + + Performs additional processes after inserting a new element into the collection. + + The zero-based index at which to insert value. + The new value of the element at index. + + + + Performs additional processes after setting a value in the collection. + + The zero-based index at which oldValue can be found. + The value to replace with newValue. + The new value of the element at the index. + + + + Performs additional processes after removing an element from the collection. + + The zero-based index at which value can be found. + The value of the element to remove from the index. + + + + OnClear is invoked after Clear behavior. + + + + + This method is called when sheet name was changed. + + Sender of the event. + Event arguments. + + When workbook already contains worksheet with specified name. + + + + + + + + + + Returns single entry from the collection. + + + + + A collection of all the Workbook objects that are currently open in + the XlsIO application. + + + + + A collection of all the Workbook objects that are currently open in + the Excel application. + + + + + Create workbook with specified quantity of empty worksheets. + + Quantity of worksheets to create. + Interface on instance of created workbook. + + + + Opens a workbook. + + File name that contains workbook. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Excel version - defines file format (excel 97-2003 or excel 2007). + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Parse options. + Opened workbook. + + + + Opens a Workbook using separator. + + File name to open. + Current separator. + Number of first row to write. + Number of first column to write. + Opened WorkBook. + + + + Opens a Workbook using separator. + + File name to open. + Current separator. + Number of first row to write. + Number of first column to write. + Encoding to use to parse text data. + Opened WorkBook. + + + + Opens a Workbook using separator. + + Stream to open. + Current separator. + Encoding to use to parse text data. + Opened WorkBook. + + + + Opens a Workbook using separator. + + Stream to open. + Current separator. + Encoding to use to parse text data. + Opened WorkBook. + + + + Open new workbook in read-only mode. + + File to open. + Newly created workbook. + + + + Open new workbook in read-only mode. + + File to open. + Represents open type for open. + Parse options. + Newly created workbook. + + + + Open new workbook in read-only mode. + + File to open. + + + Password that should be used for decryption. + Newly created workbook. + + + + Opens a workbook. + + File name that contains workbook. + Parse options. + Indicates is open book in read - only mode. + Represents valid password for opening workbook. + Workbook version. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Parse options. + Indicates is open book in read - only mode. + Represents valid password for opening workbook. + Represents type of the file for open operation. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Represents open type for open. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Represents open type for open. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Represents open type for open. + Desired version of the workbook. + Opened workbook. + + + + Read workbook from xml file. + + Full path to xml file. + Xml open type. + Returns opened workbook. + + + + Opens a Workbook using separator. + + Stream to open. + Current separator. + Number of first row to write. + Number of first column to write. + Encoding to use to parse text data. + Opened WorkBook. + + + + Opens a Workbook using separator. + + Stream to open. + Current separator. + Opened WorkBook. + + + + Opens a workbook. + + Stream with workbook's data. + Represents open type for open. + Opened workbook. + + + + Used without an object qualifier, this property returns an + Application object that represents the Excel application. + + + + + Returns the number of objects in the collection. Read-only Long. + + + + + Returns a single object from a collection. + + + + + Returns the parent object for the specified object. + + + + + Create workbook with specified number of empty worksheets. + + Number of worksheets to create. + Interface on instance of created workbook. + + When sheetsQuantity is less than zero. + + + + + Sets the Application name as Essential XlsIO. + + + + + + Opens a workbook. + + File name that contains workbook. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Version of the excel file format. + Opened workbook. + + + + Opens a Workbook using separator. + + Stream to open. + Current separator. + Number of first row to write. + Number of first column to write. + Encoding to use to parse text data. + Opened WorkBook. + + + + Opens a Workbook using separator. + + Stream to open. + Current separator. + Number of first row to write. + Number of first column to write. + Name of the file that is being opened. + Opened WorkBook. + + + + Opens a Workbook using separator. + + Stream to open. + Current separator. + Number of first row to write. + Number of first column to write. + Name of the file that is being opened. + Opened WorkBook. + + + + Opens a Workbook using separator. + + File name to open. + Current separator. + Number of first row to write. + Number of first column to write. + Opened WorkBook. + + + + Opens a Workbook using separator. + + File name to open. + Current separator. + Number of first row to write. + Number of first column to write. + Opened WorkBook. + + + + Opens a Workbook using separator. + + Stream to open. + Current separator. + Opened WorkBook. + + + + Opens a Workbook using separator. + + Stream to open. + Current separator. + Opened WorkBook. + + + + Opens a Workbook using separator. + + Stream to open. + Current separator. + Encoding to use to parse text data. + Opened WorkBook. + + + + Opens a workbook. + + File name that contains workbook. + Parse options. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Parse options. + Indicates is open book in read - only mode. + Represents valid password for opening workbook. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Parse options. + Indicates is open book in read - only mode. + Represents valid password for opening workbook. + Workbook version. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Parse options. + Indicates is open book in read - only mode. + Represents valid password for opening workbook. + Represents type of the file for open operation. + Opened workbook. + + + + Read workbook from the stream. + + Stream with workbook's data. + Version of the excel file format. + Newly created workbook. + + + + Opens a workbook. + + File name that contains workbook. + Represents type of the file for open operation. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Represents type of the file for open operation. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Represents type of the file for open operation. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Represents type of the file for open operation. + Opened workbook. + + + + Opens a workbook. + + Stream with workbook's data. + Represents type of the file for open operation. + Opened workbook. + + Opens a workbook. + + Stream with workbook's data. + Represents type of the file for open operation. + Opened workbook. + + + + Read workbook from xml file. + + Path to xml file. + Xml open type. + Returns opened workbook. + + + + Read workbook from xml file. + + Path to xml file. + Xml open type. + Returns opened workbook. + + + + Read workbook from xml stream. + + Xml reader. + Xml open type. + Returns opened workbook. + + + + Open new workbook in read-only mode. + + File to open. + Newly created workbook. + + + + Open new workbook in read-only mode. + + File to open. + Parse options. + Newly created workbook. + + + + Creates workbook and sets its Application and Parent properties. + + Application object for the collection. + Parent object for the collection. + + + + Returns a single object from a collection. + + + + + + + + + + Represents a collection of embedded charts. + + + + + Creates a new chart. + + Newly created chart object. + + + + Returns the number of objects in the collection. Read-only Long. + + + + + Returns a single Chart object from a Charts collection. + + + + + Parent worksheet. + + + + + + + + + + + + Adds new chart to the collection (doesn't add it to the shapes collection). + + Chart to add. + Added chart. + + + + Adds new chart to the collection. + + Chart to add. + Added chart. + + + + Searched for all necessary parents. + + + If can't find parent worksheet. + + + + + Creates a new chart. + + Newly created chart object. + + + + Returns a single Chart object from a Charts collection. + + + + + Summary description for NamesCollection. + + + + + Dictionary Name-to-IName + + + + + Parent workbook for the collection. + + + + + Parent worksheet for the collection. + + + + + Creates new empty collection. + + Application object for the collection. + Parent object for the new collection. + + + + Renames name in Name-to-IName hashtable. + + New name implementation. + Old name. + + + + Adds new named range to the collection. + + Name of the new named range. + Newly added named range. + + + + Defines a new name. + + Name object to add. + Added Name object. + + If name argument is NULL. + + + + + Defines a new name. + + Name object to add. + Indicates is adds in global names hash. + Added Name object. + + If name argument is NULL. + + + + + Removes Name object from the collection. + + Name of the object to remove. + + + + Clear collection. + + + + + Checks whether collection contains named range. + + Name of the named range to search. + True if collection contains such named range; otherwise returns False. + + + + Checks whether collection contains named range. + + Name + Indicate whether formula range or not + true/false + + + + Represent the known named ranges count + + + + + Adds a new name only to this collection (without registering it in the workbook names collection). + + Name object to add. + Added Name object. + + If name argument is NULL. + + + + + Defines a new name. + + NameRecord containing info for new Name object. + Name object that was added to the collection. + + If specified NameRecord is NULL. + + + + + Defines a new name. + + NameRecord containing info for new Name object. + Indicates is adds in global names hash. + Name object that was added to the collection. + + If specified NameRecord is NULL. + + + + + Fills Names. + + Source names collection. + Dictionary with modified worksheet names. + Flags for filling. + Dictionary, key - old name index, value - new name index. + Represents hash table with new extern sheet indexes. + + + + Updates reference indexes in the name record. + + Name record to update. + Old workbook object. + Dictionary with new worksheet names. + Dictionary with changed extern sheet indexes. + New workbook object. + + + + Sets sheet index. + + Sheet index to set. + + + + Returns existing or creates new name. + + Name to create. + Required name. + + + + Converts full row or column tokens between versions. + + Version to convert into. + + + + Returns a single Name object from a Names collection. + + + + + Sets parent workbook and worksheet for the collection. + + + If the parent workbook or worksheet cannot be found. + + + + + Performs additional processes after inserting a new element into the collection. + + The zero-based index at which to insert value. + The new value of the element at the index. + + + + Returns a single Name object from a Names collection. + + + + + Represent the known named ranges count + The name in the formula which has no reference is + unknown named ranges + + + + + Returns a single Name object from a Names collection. + + + + + A collection of all the Worksheet objects in the specified or + active workbook. Each Worksheet object represents a worksheet. + + + + + A collection of all the Worksheet objects in the specified or + active workbook. Each Worksheet object represents a worksheet. + + + + + Create worksheet with specified name. + + New name of worksheet. Must be unique for collection. + Reference on created worksheet. + + + + Used without an object qualifier, this property returns an + Application object that represents the Microsoft Excel application. + + + + + Returns the number of objects in the collection. Read-only Long. + + + + + Returns a single object from a collection. + + + + + Returns a single object from a collection. + + + + + Returns the parent object for the specified object. + + + + + Hash table that contains all worksheets and gives access + to them by worksheet name. + + + + + Parent workbook. + + + + + Indicates whether to use hash for worksheet look up. + + + + + Sheet Name Validator + + + + + Creates a collection and sets its Application and Parent properties. + + Application object for the collection. + Parent object for the collection. + + + + Adds new worksheet into collection. + + Added worksheet. + + + + Adds an empty worksheet. + + Name of the newly created worksheet. + Newly created worksheet. + + + + Performs additional processes after inserting a new element into the collection. + + The zero-based index at which to insert value. + The new value of the element at the index. + + + + Performs additional processes after setting a value in the collection. + + The zero-based index at which oldValue can be found. + The value to replace with newValue. + The new value of the element at the index. + + + + Performs additional processes after removing an element from the collection. + + The zero-based index at which value can be found. + The value of the element to remove from the index. + + + + OnClear is invoked after Clear behavior. + + + + + This method is called when sheet name was changed. + + Sender of the event. + Event arguments. + + When workbook already contains worksheet with specified name. + + + + + Creates empty worksheet with specified name. + + New name of worksheet. Must be unique for collection. + Reference on created worksheet. + + When specified name is NULL. + + + + + Updates string indexes. + + List with new indexes. + + + + Removes specified worksheet from the collection. + + Index of the sheet to remove. + + + + Adds worksheet into internal collection. + + Worksheet to add. + + + validates the sheet name to avoid the invalid names + + + + Returns a single object from a collection. Read-only. + + + + + Returns a single object from a collection. Read-only. + + + + + Indicates whether worksheet is displayed right to left. + + + + + Class that represent event args. + + + + + Element index. + + + + + Element value. + + + + + Default constructor. + + + + + Creates new instance of event arguments. + + Changed element index. + Changed element value. + + + + Element index. Read-only. + + + + + Element value. Read-only. + + + + + Represents an ARGB (alpha, red, green, blue) color. + + + + + Type of the stored color. + + + + + Color value. + + + + + Color Saturation Modulation value + + + + + Color Luminence value + + + + + Color Saturation + + + + + Color Luminence Modulation + + + + + Indicate Scheme color + + + + + Indicate Schema Name + + + + + Indicate Hex color + + + + + Initializes a new instance of the class with the specified instance. + + Color value to initialize. + + + + Initializes a new instance of the class with the specified instance. + + Color value to initialize. + + + + Initializes a new instance of the class with the specified instance and color value. + + Represents type of Color. + Represents color value. + + + + Initializes a new instance of the class with the specified instance, color value and tint value. + + Represents color type. + Represents color value. + Represents tint value. + + + + Returns the index for indexed color or the closest color for any other color type. + + Parent workbook + Index for indexed color or the closest color for any other color type. + + + + Sets the indexed color with the specified instance. + + Color index to set. + + + + Sets the indexed color with the specified value and event action. + + Color index to set. + Determines whether to call AfterChange event + + + + Sets the indexed. + + Color index to set. + if set to true [raise event]. + The book. + + + + Returns the RGB Color object that corresponds to this color. + + Parent workbook. + RGB Color object that corresponds to this color. + + + + Sets the RGB color value. + + Value to set. + Parent workbook. + + + + Sets RGB color value. + + Value to set. + + + + Converts the specified to instance. + + Color value to convert. + Returns Converted instance. + + + + Checks whether two instances have the same data. + + First color object to check. + Second color object to check. + True if they have the same data.Otherwise False + + + + Checks whether two instances have different data. + + First color object to check. + Second color object to check. + True if they have different data. Otherwise False + + + + Copies data from another color object. + + Color object to copy data from. + Indicates whether we should call AfterChange method. + + + + Converts current color to closest indexed. + + Parent workbook. + + + + Returns the HashCode for the instance. + + A 32-bit signed integer hash code. + + + + Sets indexed color without calling AfterChange event. + + Color index to set. + + + + Creates independent copy of the current object. + + A copy of the current object. + + + + Normalizes indexed color if necessary. + + + + + Normalizes indexed color if necessary. + + + + + Normalizes indexed color if necessary. + + + + + Determines whether the specified color objects are equal or not. + + The object to compare with the current instance. + true if the specified Object is equal to the current Object; otherwise, false. + + + + Sets theme color + + Theme color index. + Parent workbook. + Tint value. + + + + Sets rgb color. + + Rgb color to set. + Parent workbook. + Tint value. + + + + Represents an event called after color change. + + + + + Gets color value (it can be index, rgb color, etc.) + + + + + Gets or sets Tint value. + + + + + Indicate Hex color + + + + + Gets or sets the type of the stored color. + + + + + Delegate used for after change event. + + + + + Specifies the color type. + + + + + Indicates ColorType is Automatic. + + + + + Indicates ColorType which is determined by Indexed color. + + + + + Indicates ColorType which is determined by values of red, green, and blue. + + + + + Indicates ColorType which is determined by theme colors. + + + + + Indicates color is not set. + + + + + Is thrown when range is invalid, i.e. when can't copy / move range into new location. + + + + + Default exception message. + + + + + Initializes a new instance of the class with default error message. + + + + + Initializes a new instance of the class with a specified error message. + + Error message. + + + + Is thrown when the data array is larger than it should be. + + + + + Initializes a new instance of the class with an empty error message. + + + + + Initializes a new instance of the class with a specified error message. + + Error message. + + + + This exception should be thrown when there are problems with formula parsing. + + + + + Default message format. + + + + + Default constructor. + + + + + Initializes a new instance of the class with a specified error message. + + Error message. + + + + Initializes a new instance of the Exception 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. + If the innerException parameter is not a NULL reference + (Nothing in Visual Basic), the current exception is raised + in a catch block that handles the inner exception. + + + + + + + + + + + + + + Is thrown when user tries to modify read-only data. + + + + + Default message. + + + + + Initializes a new instance of the class with an empty error message. + + + + + Initializes a new instance of the class with a specified error message. + + Error message. + + + + Is thrown when data array is smaller than it should be. + + + + + Initializes a new instance of the class with a specified error message. + + Error message. + + + + Is thrown when some internal data error is found. + + + + + Initializes a new instance of the class with an empty error message. + + + + + Initializes a new instance of the class with a specified error message. + + Error message. + + + + Represents exception, that occurred during parse excel structure from xml stream. + + + + + Represents default error message. + + + + + Initializes a new instance of the class with a specified error message. + + Error message. + + + + Contains the font attributes (font name, font size, + color, and so on) for an object. + + + + + Parent index that indicates that extended format doesn't have any parent format. + + + + + Indicates that text is drawn from top to bottom. + + + + + Maximum tint value. + + + + + Weight of the bold font. + + + + + Weight of the normal font. + + + + + ExtendedFormatRecord that contains information about font and format indexes, + borders, colors, etc. + + + + + + Parent workbook. + + + + + Position of this format in m_book.InnerExtFormats. + + + + + ShapeFill implementation that contains gradient fill effects. + + + + + + + + + + + + + + + Represent the cell-border + + + + + Indicating whether cell has pivot button + + + + + This method should be called after any changes. + Sets Saved property of the parent workbook to False. + + + + + Copies all data from this XF into another. + + Format to copy into. + + + + Creates child format if this format is for named style and registers it in workbook. + + Child format. + + + + Creates child format if this format is for named style. + + Defines whether to register format in workbook. + Child format. + + + + + + + + + + + Synchronizes properties with parent record. + + + + + Copies borders from source format. + + Format to copy border settings from. + + + + Copies patterns from source format. + + Format to copy pattern settings from. + + + + Starts updating process. + + + + + Ends updating process. + + + + + Sets application and parent fields. + + Application object for the format. + Parent object for the format. + + + + Gets information about extended format from specified format. + + Application object for the XF. + Parent object for the XF. + Format that contains all needed information. + + + + Gets information about extended format from specified format. + + Application object for the XF. + Parent object for the XF. + Format that contains all needed information. + + + + Searches for all necessary parent objects. + + + + + Parses ExtendedFormatRecord + + Record to parse. + + When font index in format record is larger than size + of the inner font collection of the parent workbook. + + + + + Parses ExtendedFormatRecord + + Record to parse. + + When font index in format record is larger than size + of the inner font collection of the parent workbook. + + + + + Updates values from parent format and initializes colors if necessary. + + + + + Updates values from current format. + + + + + Initializes color objects. + + + + + Updates color field in the record. + + + + + Updates pattern color in the record. + + + + + Updates top border color in the record. + + + + + Updates bottom border color in the record. + + + + + Updates left border color in the record. + + + + + Updates right border color in the record. + + + + + Updates diagonal border color in the record. + + + + + Copy Colors. + + + + + Compares formats without comparing indexes. + + Format to compare. + 0 if formats are equal. + + + + Copies alignment of one XFormat into another. + + Destination format. + Source format. + Indicates whether we should change corresponding + Include... flag(s) after copying data. + + + + Copies borders of one XFormat into another. + + Destination format. + Source format. + Indicates whether we should change corresponding + Include... flag(s) after copying data. + + + + Copies font of one XFormat into another. + + Destination format. + Source format. + Indicates whether we should change corresponding + Include... flag(s) after copying data. + + + + Copies number format of one XFormat into another. + + Destination format. + Source format. + Indicates whether we should change corresponding + Include... flag(s) after copying data. + + + + Copies patterns of one XFormat into another. + + Destination format. + Source format. + Indicates whether we should change corresponding + Include... flag(s) after copying data. + + + + Copies protection of one XFormat into another. + + Destination format. + Source format. + Indicates whether we should change corresponding + Include... flag(s) after copying data. + + + + Copies color settings from specified format object. + + + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of the current instance. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of the current instance. + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Checks the record for borders and updates hasBorder + + The record to be checked + + + + Get / set font index. + + + + + Gets format index in m_book.InnerFormats. + + + + + Get / set Format index. + + + + + Get / set fill pattern. + + + + + Get / set fill background color. + + + + + Get / set fill background color. + + + + + Get / set fill foreground color. + + + + + Get / set fill foreground color. + + + + + Horizontal alignment. + + + + + Indent level. + + + + + Indicates whether formula is hidden. + + + + + Indicates whether cell with this XF is locked. + + + + + For far east languages. Supported only for format. Always 0 for US. + + + + + Returns or sets the format code for the object. Read/write String. + + + + + Returns or sets the format code for the object as a string in the + language of the user. Read/write String. + + + + + True- Indicates that the contents are shrunk to fit into cell. + + + + + True - Indicates that text is wrapped at right border. + + + + + Vertical alignment. + + + + + Flag for horizontal and vertical alignment, text wrap, indentation, + orientation, rotation, and text direction. If False, the attribute + of parent style is used. + + + + + Flag for border lines. + If False, the attribute of parent style is used. + + + + + Flag for font. + If False, the attribute of parent style is used. + + + + + Flag for number format. + If False, the attribute of parent style is used. + + + + + Flag for background area style. + If False, the attribute of parent style is used. + + + + + Flag for cell protection (cell locked and formula hidden). + If False, the attribute of parent style is used. + + + + + + + + + + + + + + + If true then first symbol in cell is apostrophe. + + + + + Returns or sets the color of the interior pattern as an index into the current color palette. + + + + + Returns or sets the color of the interior pattern as an Color value. + + + + + Returns or sets the color of the interior pattern as an Color value. + + + + + Returns or sets the color of the interior. The color is specified as + an index value into the current color palette. + + + + + Returns or sets the cell shading color. + + + + + Returns or sets the cell shading color. + + + + + Gets value indicating whether format was modified, compared to parent format. + + + + + List of extended property. + + + + + Text direction, the reading order for far east versions. + + + + + Text rotation angle: + 0 Not rotated + 1-90 1 to 90 degrees counterclockwise + 91-180 1 to 90 degrees clockwise + 255 Letters are stacked top-to-bottom, but not rotated. + + + Thrown when value is more than 0xFF. + + + + + Type of the extended format. + + + + + Gets / sets gradient object. + + + + + Get / set index for this record in Workbook.InnerExtFormats collection. + + + + + Read-only. Returns ExtendedFormatRecord with + information about this format. + + + + + Read-only. Returns ExtendedXFormat with information about this format. + + + + + Index of the parent extended format. + + + + + Returns parent workbook. + + + + + Get/set BottomBorder color. + + + + + Get/set TopBorder color. + + + + + Get/set LeftBorder color. + + + + + Get/set RightBorder color. + + + + + Get/set DiagonalUpBorder color. + + + + + Gets / sets line style of the left border. + + + + + Gets / sets line style of the right border. + + + + + Gets / sets line style of the top border. + + + + + Gets / sets line style of the bottom border. + + + + + Gets / sets line style of the diagonal border. + + + + + Gets / sets line style of the diagonal border. + + + + + Indicates whether DiagonalUp line is visible. + + + + + Indicates whether DiagonalDown line is visible. + + + + + Indicates whether this format is child format. + + + + + Indicates whether color is default. Read-only. + + + + + Indicates whether pattern color is default. Read-only. + + + + + Returns record from parent format if possible, otherwise just returns format record. Read-only. + + + + + Returns parent format if possible, otherwise just returns this format. Read-only. + + + + + Gets number format object. + + + + + Indicating whether cell has pivot button + + + + + + + + + + + + + + + Returns color of the top border. Read-only. + + + + + Returns color of the bottom border. Read-only. + + + + + Returns color of the left border. Read-only. + + + + + Returns color of the right border. Read-only. + + + + + Returns color of the diagonal border. Read-only. + + + + + This class contains some extension to the Color class in (PORTABLE). + + + + + Contains black color. + + + + + Contains white color. + + + + + Contains empty color. + + + + + Contains red color. + + + + + Contains blue color. + + + + + Contains dark gray color. + + + + + Contains yellow color. + + + + + Contains cyan color. + + + + + Contains magenta color. + + + + + Contains gray color. + + + + + Chart foreground color. + + + + + Chart background color. + + + + + Chart neutral color. + + + + + Converts Int32 value into Color. + + Value to convert. + Converted value. + + + + Parent worksheet. + + + + + + + + + + + + + + + + + + + + Initializes new instance of the class. + + Parent external worksheet. + First row. + First column. + + + + Initializes new instance of the class. + + Parent external worksheet. + First row. + First column. + Last row. + Last column. + + + + Returns the calculated value of a formula using the most current inputs. + + + + + Gets address global in the format required by Excel 2007. + + + + + Gets or sets a value indicating whether this instance is num reference for chart axis. + + + true if this instance is num reference; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is a string reference for chart axis. + + + true if this instance is string reference; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is multi reference for chart axis. + + + true if this instance is multi reference; otherwise, false. + + + + + Summary description for ExternNameImpl. + + + + + Summary description for INameIndexChangedEventProvider. + + + + + Event for Name index changed + + + + + Extern name record with information about this name. + + + + + Index of the extern name in extern names collection. + + + + + Parent extern workbook. + + + + + Represents the refersTo attribute of the definedName tag + + + + + + + + + + + + + + Searches for all necessary parents. + + + + + + + + + + + Saves class into OffsetArrayList. + + OffsetArrayList that would receive class data. + + + + Creates copy of the current object. + + Parent object for the new object. + Copy of the current object. + + + + Index of the extern name in extern names collection. + + + + + Returns name of this extern name. Read-only. + + + + + Returns index of the parent extern workbook. Read-only. + + + + + Returns internal record that stores all data. Read-only. + + + + + Represents the refersTo attribute of the definedName tag + + + + + + + + + + Describes external workbook. + + + + + Array of all worksheets in this workbook. Key - index, Value - ExternWorksheet. + + + + + Dictionary key - worksheet name, value - corresponding worksheet. + + + + + Array of all extern names in this workbook. + + + + + Corresponding SupBookRecord. + + + + + Book index. + + + + + Parent workbook. + + + + + Workbook's short name. + + + + + Program id for ole object links. + + + + + Indicates if the workbook is parsed. + + + + + + + + + + + + Initializes internal variables. + + + + + Inserts default worksheet. + + + + + Searches for all necessary parent objects. + + + + + Parses extern workbook. + + Records array that contains workbook data. + Offset to the workbook data. + Offset after reading all necessary data. + + + + Adds extern worksheet. + + Sheet to add. + + + + Returns index of worksheet in this workbook. + + Sheet name to search for. + Index of the worksheet in the workbook; -1 if worksheet was not found. + + + + Creates copy of the current extern workbook. + + Parent for the copy of this extern workbook. + Copy of the current extern workbook. + + + + Gets name of the sheet at specified index. + + Index of the desired worksheet. + Name of the sheet. + + + + Initializes ShortName property. + + + + + Gets file name with extension from the path. + + Url to get name from. + File name without extension from the path. + + + + Gets file name without extension from the path. + + Url to get name from. + File name without extension from the path. + + + + Adds new worksheets to the extern workbook. + + Array that contains worksheet names to add. + + + + Adds new worksheets to the extern workbook. + + Array that contains worksheet names to add. + + + + Adds new worksheet to the collection of worksheets. + + Name of the worksheet to add. + Create worksheet. + + + + + + + + + + Adds external name object to the workbook. + + Name of the named range to add. + + + + + + + + + + + This method is called during dispose operation. + + + + + Returns collection of extern names. Read-only. + + + + + Indicates whether this is workbook is used for internal reference. + + + + + Number of sheet names (if external references) or + number of sheets in this document (if internal references). + + + + + Encoded URL without sheet name (for external references). + + + + + Gets / sets index of the workbook. + + + + + Returns parent workbook. Read-only. + + + + + Returns short name of the workbook. Read-only. + + + + + Indicates whether add-in function names are stored + in EXTERNNAME records following this SUPBOOK record. + + + + + Returns worksheets collection sorted by index. Read-only. + + + + + Gets or sets program id for the ole object. + + + + + Indicates if the workbook is parsed. + + + + + Summary description for ExternWorksheetImpl. + + + + + Represents internal worksheet object. It can be internal or external. + + + + + Gets object that is clone of current worksheet in the specified workbook. + + Dictionary with update worksheet names. + New workbook object. + Object that is clone of the current worksheet. + + + + Return default row height in pixel. + + + + + Gets or sets one-based index of the first row of the worksheet. + + + + + Gets or sets one-based index of the first column of the worksheet. + + + + + Gets or sets one-based index of the last row of the worksheet. + + + + + Gets or sets one-based index of the last column of the worksheet. + + + + + Returns collection of cell records. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + Represents the object associated with implementation + + + + + + + + + + List with sheet records. + + + + + Parent workbook. + + + + + Worksheet name. + + + + + Collection with worksheet's cached cell records. + + + + + First used row. + + + + + First used column. + + + + + Last used row. + + + + + Last used column. + + + + + Additional attributes for sheetData tag. + + + + + + + + + + + + Creates copy of the object. + + Parent object for the new object. + Created object that is copy of the current object. + + + + This method is called during dispose operation. + + + + + Caches values from specified range. + + Range to cache data from. + + + + Set cell records for current worksheet. + + Parent object for the new object. + + + + Returns the formula string if the cell contains a formula, or the value if + the cell cantains anything other than a formula. + + The row of the cell. + The column of the cell. + The formula string or value. + + + + Sets the value of a cell. + + The value to be set. + The row of the cell. + The column of the cell. + + + + Not implemented. + + + + + Raises the event. + + The row of the change. + The column of the change. + The changed value. + + + + Creates new instance of IRanges. + + New instance of ranges collection. + + + + Imports data from a DataTable into worksheet. + + DataTable with desired data. + True if column names must also be imported. + Row of the first cell where DataTable should be imported. + Column of the first cell where DataTable should be imported. + Number of imported rows. + + + + Exports worksheet data into a DataTable. + + Row of the first cell from where DataTable should be exported. + Column of the first cell from where DataTable should be exported. + Maximum number of rows to export. + Maximum number of columns to export. + Export options. + DataTable with worksheet data. + + + + Exports worksheet data into a DataTable. + + Range to export. + Export options. + DataTable with worksheet data. + + + + Protects current worksheet. + + Represents password to protect. + Represents params to protect. + + + + Autofits specified row. + + One-based row index. + + + + Autofits specified column. + + One-based column index. + + + + Replaces specified string by data table values. + + String value to replace. + Data table with new data. + Indicates whether field name must be shown. + + + + Replaces specified string by data column values. + + String value to replace. + Data table with new data. + Indicates whether field name must be shown. + + + + Removes worksheet from parent worksheets collection. + + + + + Converts column width into pixels. + + Width in characters. + Width in pixels + + + + Converts pixels into column width (in characters). + + Width in pixels + Width in characters. + + + + Sets column width. + + One-based column index. + Width to set. + + + + Sets column width. + + One-based column index. + Width in pixels to set. + + + + Returns width from ColumnInfoRecord if there is corresponding ColumnInfoRecord + or StandardWidth if not. + + One-based index of the column. + Width of the specified column. + + + + Returns width in pixels from ColumnInfoRecord if there is corresponding ColumnInfoRecord + or StandardWidth if not. + + One-based index of the column. + Width in pixels of the specified column. + + + + Returns height from RowRecord if there is a corresponding RowRecord. + Otherwise returns StandardHeight. + + One-based index of the row + + Height from RowRecord if there is corresponding RowRecord. + Otherwise returns StandardHeight. + + + + + Returns height from RowRecord if there is a corresponding RowRecord. + Otherwise returns StandardHeight. + + One-based index of the row. + + Height in pixels from RowRecord if there is corresponding RowRecord. + Otherwise returns StandardHeight. + + + + + + Save tabsheet using separator. + + File to save. + Current separator. + Encoding to use. + + + + + Save tabsheet using separator. + + Stream to save. + Current separator. + Encoding to use. + + + + Sets the value in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + + Sets the value in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + + Sets the value in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + + Sets text in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Text to set. + + + + Sets formula in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Formula to set. + + + + Sets formula number value. + + One based row index. + One based column index. + Represents formula number value for set. + + + + Sets formula error value. + + One based row index. + One based column index. + Represents formula error value for set. + + + + Sets formula bool value. + + One based row index. + One based column index. + Represents formula bool value for set. + + + + Sets formula string value. + + One based row index. + One based column index. + Represents formula string value for set. + + + + Converts range into image (Bitmap). + + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Created image. + + + + Converts range into image. + + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Type of the image to create. + Output stream. It is ignored if null. + Created image. + + + + Makes the current sheet the active sheet. Equivalent to clicking the + sheet's tab. + + + + + Unselects current tab sheet. + + + + + Gets object that is clone of current worksheet in the specified workbook. + + Dictionary with update worksheet names. + New workbook object. + Object that is clone of the current worksheet. + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Event raised when an unknown function is encountered. + + + + + Sheet index. + + + + + Gets parent extrnal workbook. + + + + + Gets index of the reference to this worksheet. + + + + + + + + + + Gets or sets the a object associated with implementation. + + + + + An event raised on the IWorksheet whenever a value changes. + + + + + True if page breaks (both automatic and manual) on the specified + worksheet are displayed. Read / write Boolean. + + + + + Gets or sets the view setting of the sheet. + + + + + + Gets or sets a value indicating whether this instance is OLE object. + + + true if this instance is OLE object; otherwise, false. + + + + + For a Worksheet object, returns a Names collection that represents + all the worksheet-specific names (names defined with the "WorksheetName!" + prefix). Read-only Names object. + + + + + Name that is used by macros to access the workbook items. Read-only. + + + + + Returns a PageSetup object that contains all the page setup settings + for the specified object. Read-only. + + + + + Returns a Range object that represents a cell or a range of cells. + + + + + Returns or sets the standard (default) height of all the rows in the worksheet, + in points. Read/write Double. + + + + + Returns or sets the standard (default) height option flag, which defines that + standard (default) row height and book default font height do not match. + Read/write Bool. + + + + + Returns or sets the standard (default) width of all the columns in the + worksheet. Read/write Double. + + + + + Returns a Range object that represents the used range on the + specified worksheet. Read-only. + + + + + Zoom factor of document. Value must be in range from 10 till 400. + + + + + Position of the vertical split (px, 0 = No vertical split): + Unfrozen pane: Width of the left pane(s) (in twips = 1/20 of a point) + Frozen pane: Number of visible columns in left pane(s) + + + + + Position of the horizontal split (by, 0 = No horizontal split): + Unfrozen pane: Height of the top pane(s) (in twips = 1/20 of a point) + Frozen pane: Number of visible rows in top pane(s) + + + + + Index to first visible row in bottom pane(s). + + + + + Index to first visible column in right pane(s). + + + + + Identifier of pane with active cell cursor. + + + + + True if zero values to be displayed + False otherwise. + + + + + True if gridlines are visible; + False otherwise. + + + + + Gets / sets Grid line color. + + + + + True if row and column headers are visible; + False otherwise. + + + + + Indicates if all values in the workbook are preserved as strings. + + + + + Gets / sets cell by row and index. + + + + + Get cells range. + + + + + Get cell range. + + + + + Get cell range. + + + + + Indicates whether all created range objects should be cached. Default value is false. + + + + + Defines whether freezed panes are applied. + + + + + Gets/sets top visible row of the worksheet. + + + + + Gets/sets left visible column of the worksheet. + + + + + There are two different algorithms to create UsedRange object: + 1) Default. This property = true. The cell is included into UsedRange when + it has some record created for it even if data is empty (maybe some formatting + changed, maybe not - cell was accessed and record was created). + 2) This property = false. In this case XlsIO tries to remove empty rows and + columns from all sides to make UsedRange smaller. + + + + + Gets / sets tab color. + + + + + Gets / sets tab color. + + + + + Returns parent workbook. Read-only. + + + + + Returns shapes collection. Read-only. + + + + + Indicates whether worksheet is displayed right to left. + + + + + Indicates whether tab of this sheet is selected. Read-only. + + + + + Gets / sets name of the tab sheet. + + + + + Control visibility of worksheet to end user. + + + + + Return default row height in pixel. + + + + + Gets or sets one-based index of the first row of the worksheet. + + + + + Gets or sets one-based index of the first column of the worksheet. + + + + + Gets or sets one-based index of the last row of the worksheet. + + + + + Gets or sets one-based index of the last column of the worksheet. + + + + + Returns collection of cell records. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + Summary description for FillImpl. + + + + + + + + + + + + + + + + + + + + Gradient fill style. + + + + + Gradient fill variant. + + + + + Gradient fill type. + + + + + Prevents user from creating such items without arguments. + + + + + Initializes new instance of the fill. + + Parent extended format. + + + + Initializes new instance of the fill. + + + + + + + + Initializes new instance of the fill. + + Represents pattern. + Represents color. + Represents pattern color. + + + + 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. + + + + Serves as a hash function for a particular type, suitable for use + in hashing algorithms and data structures like a hash table. + + A hash code for the current object. + + + + Creates copy of the current object. + + A copy of the current object. + + + + Returns the color of the interior. The color is specified as + an index value into the current color palette. Read-only. + + + + + Returns the color of the interior pattern as an index into the current + color palette. Read-only. + + + + + Returns fill pattern. Read-only. + + + + + Gets / sets gradient style. + + + + + Gets / sets gradient variant. + + + + + Gets / sets fill type. + + + + + Contains the font attributes (font name, font size, + color, and so on) for an object. + + + + + Weight of the bold font. + + + + + Weight of the normal font. + + + + + + + + + + Font index which is not present in file. + + + + + Multiplier for small bold font. + + + + + Multiplier for bold font. + + + + + Represents last not default color index. + + + + + + + + + + Wrapped FontRecord. + + + + + Parent workbook. + + + + + Current position of FontImpl class in the InnerFont Collection. + + + + + Font charset. + + + + + Native font object. + + + + + Color object. + + + + + Font's language. + + + + + Paragraph alignment + + + + + Represents whether RTF has paragraph alignment or not + + + + + Creates font and sets its Application and Parent + properties to specified values. + + Application object for the font. + Parent object for the font. + + + + Creates FontImpl from FontRecord. + + Application object for the font. + Parent object for the font. + Record with font data. + + + + Creates FontImpl from FontRecord. + + Application object for the font. + Parent object for the font. + Record with font data. + + + + Creates font using data from baseFont. + + IFont that will be copied. + + When baseFont is not FontImpl and not FontImplWrapper. + + + + + Creates font based on native font and sets its Application and Parent + properties to specified values. + + Application object for the font. + Parent object for the font. + Native font to create from. + + + + Initializes color object. + + + + + Updates font record after color change. + + + + + Updates color with record's data. + + + + + Initializes parent objects. + + + + + Saves all range cells into OffsetArrayList. + + Array that will receive font record. + + + + Copies data from this instance to another. + + Font impl that will receive data from this font. + + + + This method should be called after any changes. + Sets Saved property of the parent workbook to false. + + + + + Generates .Net font object corresponding to the current font. + + Generated .Net font. + + + + Generates .Net font object corresponding to the current font. + + Desired font size. + Generated .Net font. + + + + Parses native font. + + Font to parse. + + + + Measures the specified string when drawn with this font. + + String to measure. + String size. + + + + Measures the specified string in special way (as close as possible to MS Excel). + + String to measure. + String size. + + + + + + + + + + + + + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of the current instance. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of the current instance. + + + + Clones FontImpl. + + Parent object. + Returns cloned object. + + + + Converts size of the font to the twips. + + Size of the font. + Size of the font in twips. + + + + + + + + + + + Updates font indexes in different workbooks. + + Index to update. + Dictionary with new indexes. + Parse options. + Returns new index. + + + + Find and returns the supported font font style by the respective font. + + + + + + + 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. + + + + + Serves as a hash function for a particular type, suitable for + use in hashing algorithms and data structures like a hash table. + + A hash code for the current Object. + + + + Compares the current instance with another object of the same type. + + Object to compare with this instance. + + Less than zero - This instance is less than obj. + Zero - This instance is equal to obj. + Greater than zero - This instance is greater than obj. + + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + True if the font is bold. Read/write Boolean. + + + + + Returns or sets the primary color of the object. Read / write ExcelKnownColors. + + + + + Gets / sets font color. Searches for the closest color in + the workbook palette. + + + + + True if the font style is italic. Read/write Boolean. + + + + + True if the font is an outline font. Read/write Boolean. + + + + + True if the font is a shadow font or if the object has + a shadow. Read/write Boolean. + + + + + Returns or sets the size of the font in points. Read / write Variant. + + + When size is less than 1 or greater than 409. + + + + + True if the font is struck through with a horizontal line. + Read/write Boolean. + + + + + True if the font is formatted as subscript. + False by default. Read/write Boolean. + + + + + True if the font is formatted as superscript; False by default. + Read/write Boolean. + + + + + Returns or sets the type of underline applied to the font. Can + be one of the following ExcelUnderlineStyle constants. + Read/write OfficeUnderline. + + + + + Returns or sets the font name. Read/write string. + + + + + Gets / sets font vertical alignment. + + + + + Indicates whether color is automatically selected. Read-only. + + + + + Gets or sets the baseline value which indicates whether superscript or subscript + + + + + True if the font is set to capitalize, character spacing or kerning value. + + + + + True if the font is set to capitalize. + + + + + Returns or sets the character spacing value of the font. + + + + + Returns or sets the kerning value of the font. + + + + + Returns wrapped FontRecord. Read-only. + + + + + Parent workbook. Read-only. + + + + + Font index in the workbook fonts collection. + + + + + Gets/sets font charset. + + + + + Gets or sets the family. + + The family. + + + + Returns color object. + + + + + Gets or sets font's language. + + + + + Gets or sets RTF paragraph alignment + + + + + Returns whether RTF text has paragraph alignment or not + + + + + + + + + + Returns font index. Read-only. + + + + + Returns current font. Read-only. + + + + + Class that is created when user accesses the + font in a multicell range. Redirects all calls + to the fonts of the individual cells. + + + + + Array that contains all cells of the range. + + + + + Create new instance of object. + + Base range. + + + + Create new instance of object. + + Base range. + + + + Generates .Net font object corresponding to the current font. + + Generated .Net font. + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + True if the font is bold. Read/write Boolean. + + + + + Returns or sets the primary color of the object. Read / write ExcelKnownColors. + + + + + Gets / sets font color. If there is at least one free color, + define a new color. If not, search for the closest one in + workbook palette. + + + + + True if the font style is italic. Read/write Boolean. + + + + + True if the font is an outline font. Read/write Boolean. + + + + + True if the font is a shadow font or if the object has + a shadow. Read/write Boolean. + + + + + Returns or sets the size of the font. Read/write Variant. + + + + + True if the font is struck through with a horizontal line. + Read/write Boolean + + + + + True if the font is formatted as subscript. + False by default. Read/write Boolean. + + + + + True if the font is formatted as superscript; False by default. + Read/write Boolean. + + + + + Returns or sets the type of underline applied to the font. Can + be one of the following ExcelUnderlineStyle constants. + Read/write OfficeUnderline. + + + + + Returns or sets the font name. Read/write string. + + + + + Gets / sets font vertical alignment. + + + + + Indicates whether color is automatically selected. Read-only. + + + + + Summary description for FontWrapper. + + + + + Wrapped font. + + + + + Font character set. + + + + + Indicates whether font is read-only. + + + + + Indicates whether raise events. + + + + + Indicates whether wrapped font is accessed directly (without creating + new font in OnBeforeChange, OnAfterChange methods). + + + + + Font color object + + + + + Represents the color format + + + + + Represents the Range + + + + + Creates new font wrapper. + + + + + Creates new font wrapper. + + Font to wrap. + + + + Creates new font wrapper. + + Font to wrap. + Indicates whether wrapper should be read-only. + + Indicates whether to call OnBeforeChange and OnAfterChange when any property changes. + + + + + Generates .Net font object corresponding to the current font. + + Generated .Net font. + + + + Returns copy of current object. + + Parent Workbook. + Parent object. + Dictionary with new indexes. + Clone of FontWraper. + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Invokes after change event. + + + + + True if the font is bold. Read / write Boolean. + + + + + Returns or sets the primary color of the object, as shown in the + following table. Use the RGB function to create a color value. + Read / write Integer. + + + + + Gets / sets font color. Searches for the closest color in + the workbook palette. + + + + + True if the font style is italic. Read / write Boolean. + + + + + True if the font is an outline font. Read / write Boolean. + + + + + True if the font is a shadow font or if the object has + a shadow. Read / write Boolean. + + + + + Returns or sets the size of the font. Read / write Variant. + + + + + True if the font is struck through with a horizontal line. + Read / write Boolean + + + + + Gets or sets the offset value of superscript and subscript + + + + + True if the font is formatted as subscript. + False by default. Read / write Boolean. + + + + + True if the font is formatted as superscript. False by default. + Read/write Boolean + + + + + Returns or sets the type of underline applied to the font. Can + be one of the following ExcelUnderlineStyle constants. + Read / write OfficeUnderline. + + + + + Returns or sets the font name. Read / write string. + + + + + Returns the font character set + + + + + Gets / sets font vertical alignment. + + + + + Indicates whether color is automatically selected. Read-only. + + + + + True if the font is set to capitalize, character spacing or kerning value. + + + + + True if the font is set to capitalize. + + + + + Returns or sets the character spacing value of the font. + + + + + Returns or sets the kerning value of the font. + + + + + Application object. + + + + + Parent object. + + + + + Event raised after wrapped font changed. + + + + + Returns font index. Read-only. + + + + + Returns wrapped font. Read-only. + + + + + Indicates whether font is read-only. + + + + + Returns parent workbook. + + + + + Indicates whether wrapped font is accessed directly (without creating + new font in OnBeforeChange, OnAfterChange methods). + + + + + + + + + + Indicates the range. + + + + + Returns index of the wrapped font. Read-only. + + + + + Returns wrapped font. Read-only. + + + + + Represents number format. Responsible for reading, writing, + parsing, applying, checking and other operations with number formats. + + + + + Represents settings of number format. + + + + + Returns format index. Read-only. + + + + + Returns format string. Read-only. + + + + + Returns format type of the first section of this number format. Read-only. + + + + + Format record that contains low-level information about format. + + + + + Parsed format. + + + + + Reference to the format parser. + + + + + Initializes new instance of the format. + + Application object for the new format. + Parent object for the new format. + + + + Initializes new instance of the format. + + Application object for the new format. + Parent object for the new format. + Format record that contains low-level information about format. + + + + Initializes new instance of the format. + + Application object for the new format. + Parent object for the new format. + Format index. + Format string. + + + + Searches for all necessary parent objects. + + + + + Checks whether format is already parsed, if it isn't than parses it. + + + + + Returns format type for a specified value. + + Value to get format type for. + Format type for the specified value. + + + + Returns format type for a specified value. + + Value to get format type for. + Format type for the specified value. + + + + Applies format to the value. + + Value to apply format to. + String representation of the value according to the number format. + + + + Applies format to the value. + + Value to apply format to. + Indicates whether to show hidden symbols. + String representation of the value according to the number format. + + + + Applies format to the value. + + Value to apply format to. + String representation of the value according to the number format. + + + + Applies format to the value. + + Value to apply format to. + Indicates whether to show hidden symbols. + String representation of the value according to the number format. + + + + Indicate whether the format string in time format + + + + + Indicate whether the format string in date format + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Returns format index. Read-only. + + + + + Returns format string. Read-only. + + + + + Returns format record that contains low-level information about format. Read-only. + + + + + Returns format type of the first section of this number format. Read-only. + + + + + Parses formula tokens extracted by FormulaTokenizer and converts them into tokens in RPN form. + + + + + Name of if function in uppercase. + + + + + Options value for tAttr token in the case of space token. + + + + + Data value for tAttr token in the case of space token. + + + + + Default options for ExternName that is used as part of DDE link. + + + + + Represents the Abosulte cell references. + + + + + Converts string into set of tokens. + + + + + Array with tokens in RPN order. + + + + + + + + + + Parent workbook. + + + + + Initializes new instance of the formula parser. + + Parent workbook object. + + + + Sets formula separators. + + Operand separator to set. + Array rows separator to set. + + + + Parses formula string. + + String to parse. + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Constant arguments required by some parse methods. + + + + Parses expression. + + Subexpression priority. + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Constant arguments required by some parse methods. + + + + + Creates binary operation. + + Type of the token to create. + Space token that can be added before operation if not null, + becomes null after adding to the tokens array. + Created operation. + + + + Parses spaces and creates required tokens. + + + + + + Space token if any was created. + + + + Creates spaces token. + + Number of spaces. + Created space token. + + + + + + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Constant arguments required by some parse methods. + + + + + Updates parsing options if necessary. + + Options to update. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Identifier to parse. + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Constant arguments required by some parse methods. + Created token for the specified identifier. + + + + Tries to get named range object based on the formula string. + + + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Location reference index; -1 means local sheet reference. + + + + + Converts location string into reference. + + Location to convert. + Constant arguments required by some parse methods. + Reference index. + + + + + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Constant arguments required by some parse methods. + + + + + Creates Excel 2007 function. + + Resulting formula token. + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Constant arguments required by some parse methods. + True if current string was recognized as formula token. + + + + This function tries to create range (cell or area) based on the formula string and other arguments. + + Identifier string without location part (worksheet, book). + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Constant arguments required by some parse methods. + Resulting token. + Location reference index; -1 means local sheet reference. + True if formula string was parsed as range. + + + + Tries to create named range object based on the formula string. + + + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Location reference index; -1 means local sheet reference. + + + + + Creates named range token for external name. + + Location reference index. + Name of the named range to create token for. + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Created token. + + + + Creates named range token for local name. + + Location reference index; -1 means local sheet reference. + Name of the named range to create token for. + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Created token. + + + + Creates named range token. + + Reference index to the token location. + Name index. + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Created name token. + + + + Creates token for local name. + + Name location. + Token + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + + + + + Checks whether specified location is extern. + + Parent workbook. + Location to check. + True if it is extern location. + + + + Creates function token and adds all argument tokens to the internal token array. + + Id of the function to create. + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Constant arguments required by some parse methods. + Created function token. + + + + Creates IF function and adds all argument tokens to the internal token array. + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Constant arguments required by some parse methods. + Space token that must be inserted before IF. + Created function token. + + + + Creates custom functions and adds all argument tokens to the internal token array. + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Constant arguments required by some parse methods. + Created function token. + + + + Evaluates size of the tokens range. + + The first token to measure (included). + The last token to measure (not included). + Arguments required by some parse methods. + Size in bytes of the specified tokens. + + + + Extracts operands from the string. + + Parsing options. + Arguments required by some parse methods. + Parent function id. + + + + + + + + + + + + + Parses error reference. + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Parent worksheet. + Reference error Ptg. + + + + + + + + + Gets / sets number format info. + + + + + Contains objects that can be used by some parse methods. + + + + + Instance of the FormulaUtil class - helper class for formula parsing. + + + + + Worksheet that contains cell that is currently parsed. + + + + + + + + + + Indicates whether R1C1 notation should be used. + + + + + Cell row index (it is used when parsing R1C1 and Shared and Array formulas). + + + + + Cell column index (it is used when parsing R1C1 and Shared and Array formulas). + + + + + Workbook that contains cell that is currently parsed. + + + + + Destination excel version. + + + + + Initializes new instance of the parameters. + + Worksheet that contains cell that is currently parsed. + + Indicates whether R1C1 notation should be used. + Cell row index (it is used when parsing R1C1 and Shared and Array formulas). + Cell column index (it is used when parsing R1C1 and Shared and Array formulas). + Instance of the FormulaUtil class - helper class for formula parsing. + Parent workbook. + + + + Converts string into set of tokens. + + + + + Indicates end of formula string. + + + + + Indicates whitespace character. + + + + + Indicates colon character. + + + + + Current character. + + + + + Formula length. + + + + + + + + + + Current formula. + + + + + Start position of the current token. + + + + + Current token TokenType. + + + + + Token type of the previous token. + + + + + Previous character position. + + + + + String builder that contains string representation of the current token. + + + + + Parent workbook. + + + + + Argument separator. + + + + + Number format info. + + + + + Default constructor. + + + + + Prepares tokinezer for formula parsing. + + Formula to parse. + + + + Moves pointer to the next character. + + + + + Moves back to the specified character. + + + + + + Extracts next token from the string. + + + + + + + + + + + + + + + Extracts number token. + + + + + Process '>' character and creates required token. + + + + + Process '<' character and creates required token. + + + + + Appends internal string builder while current character is number. + + + + + Parses identifier, it can be range address, named range of function name. + + + + + Extracts spaces from the string. + + + + + Parses string token. + + Indicates whether first character is quotation character or not. + + + + Parses error token. + + + + + Extracts string representation of an array token. + + + + + Skips string and adds its value into internal string builder. + + + + + Raises parse exception. + + Exception message. + Inner exception. + + + + Raises parser exception with message that token was unexpected. + + Additional message. + + + + Returns value of the current token. Read-only. + + + + + Gets / sets argument separator. + + + + + Gets / sets number format info. + + + + + This class provides functionality needed for formula parsing. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Default regular expression options. + + + + + Default index inside named range formula. + + + + + Default reference index. + + + + + Default reference index for array token. + + + + + + + + + + + + + + + + + + + + + + + + + Column of the first cell. + + + + + Column of the second cell. + + + + + Row of the first cell. + + + + + Row of the second cell. + + + + + Worksheet name can be enclosed in this characters. + + + + + Name of the sheet name group. + + + + + Name of the book name group. + + + + + Name of the range name group. + + + + + Name of the first row name group. + + + + + Name of the first column name group. + + + + + Name of the path group. + + + + + Name of sheet. + + + + + Default sheet name regular expression. + + + + + + + + + + Array of all open brackets. + + + + + T corresponding close brackets. + + + + + String 'brackets'. + + + + + All known unary operations. + + + + + Plus and minus signs. + + + + + Plus minus signs in sorted storage. + + + + + Gives access to the function name by its id. + + + + + Gives access to the number of parameter needed by the function. + + + + + Provides access to function id by its name. + + + + + Provides access to Dictionary that contains all Reference index + by type of the argument token. + + + + + Provides access to constructor that takes one string argument + by name of the error. + + + + + Dictionary error code to name. + + + + + Dictionary error name to error code. + + + + + Provides access to TokenConstructorAttribute by token code. + This table allows user to rewrite default token classes. + + + + + Represents hash table that get access by token code to PTG. + Key - token code. Value - instance of created PTG. + + + + + Regular expression for checking if specified string is cell reference. + + + + + Regular expression for checking if specified string is cell reference. + + + + + Regular expression for checking if specified string is cell range. + + + + + Regular expression for checking if specified string is full row range. + + + + + Regular expression for checking if specified string is full column range. + + + + + Regular expression for checking if specified string is full row range in R1C1 notation + + + + + Regular expression for checking if specified string is full column range in R1C1 notation. + + + + + Regular expression for checking if specified string is 3D full row range. + + + + + Regular expression for checking if specified string is 3D full column range. + + + + + Regular expression for checking if specified string is cell range in R1C1 notation. + + + + + Regular expression for checking if specified string is cell range in R1C1 notation. + + + + + Regular expression for checking if specified string is cell range in R1C1 notation. + + + + + Regular expression for 3d reference detection. + + + + + Regular expression for 3d reference detection in R1C1 notation. + + + + + Regular expression for 3d cell range detection. + + + + + Regular expression for 3d cell range detection second possible case. + + + + + Regular expression for 3d cell range detection. + + + + + Regular expression for 3d cell range detection second possible case. + + + + + Regular expression for add-in function detection. + + + + + Array of functions that need tAttr with HasSemiVolatile = true before them. + + + + + + + + + + + + + + + Represents number format for parsing double value. + + + + + Parent workbook. + + + + + All known operations for invariant culture. + + + + + Operations with priorities. + + + + + All operations sorted by operation string. + Key - operation string, Value - operation priority. + + + + + + + + + + Array row separator. + + + + + Operands separator. + + + + + Formula parser. + + + + + Static constructor. It does all necessary preparations, + such as preparing all hashtables for functions, errors + and token constructor. + + + + + Initializes new instance of the formula parsing utility. + + Application object. + Parent object. + + + + Initializes new instance of the formula parsing utility. + + Application object. + Parent object. + Number format information. + Argument separator. + Row separator. + + + + Searches for all necessary parent objects. + + + + + Fills operations with default values. + + + + + Fills internal hashtable that permits to construct + token classes by token code. + + + + + Fills all information about known Excel functions. + + + + + Fills all information about known Excel functions. + + + + + Fills information about all known error names. + + + + + Add information about all supported errors from specified type. + + Type that supports some errors. + + + + + + + + + Converts string array into sorted list. + + Array to convert. + Created sorted list. + + + + Converts string to shared formula token array. + + Represents formula string. + Represents first row from cells range. One-based. + Represents first column from cells range. One-based. + Parent worksheet object. + Shared formula tokens. + + + + Converts string to token array. + + + String that should be parsed into Ptg array. + + Token array representing specified string. + + When any error occurs in the specified formula string. + + + + + Converts string to token array. Used when copying worksheets into another workbook. + + + String that should be parsed into Ptg array. + + Parent sheet. + + Dictionary that contains old name of the worksheet as + a key and new name of the worksheet as value. + + Token array representing specified string. + + When any error occurs in the specified formula string. + + + + + Converts string to token array. Used when copying worksheets into another workbook. + + + String that should be parsed into Ptg array. + + Parent sheet. + + Dictionary that contains old name of the worksheet as + a key and new name of the worksheet as value. + + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + Indicates whether R1C1 notation is used. + Token array representing specified string. + + When any error occurs in the specified formula string. + + + + + Converts string to token array. + + String that should be parsed into Ptg array. + Worksheet that contains formula. + Token indexes, indicates whether to use reference token, value token, or array token. + Index in string. + Hash table with worksheet names. + Parse options. + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + Parsed formula. + + When formula string is empty or if there is another error in formula string + or when string consists only of %. + + + + + Returns operand that is placed before unary operation. + + + Formula string that contains operand and unary operation. + + + Index of unary operation in the string. + + Left operand of the specified unary operation. + + + + Returns operand that is placed after unary operation. + + + Formula string that contains operation and operand. + + Index of the operation. + Right operand of the specified unary operation. + + + + Returns right operand for binary operation. + + Formula string. + Index of first operand character. + String with operation. + Right operand for the specified operation. + + + + Extracts function operand from formula string. + + Formula string to extract operand from. + First character of the operand. + Extracted operand. + + + + This method converts FormulaRecord to its string representation. + + FormulaRecord that will be parsed. + String representation of the specified formula. + + + + This method converts FormulaRecord to its string representation. + + FormulaRecord that will be parsed. + Indicates whether formula must be parsed using R1C1 notation. + String representation of the specified formula. + + + + Parses shared formula. + + Formula to parse. + String representation of the specified formula. + + + + Parses shared formula. + + Formula to parse. + Zero-based row index of the cell with shared formula. + Zero-based column index of the cell with shared formula. + String representation of the specified formula. + + + + Parses shared formula. + + Formula to parse. + Zero-based row index of the cell with shared formula. + Zero-based column index of the cell with shared formula. + Indicates whether formula must be parsed using R1C1 notation. + String representation of the specified formula. + + + + Converts array of tokens into string. + + Tokens to convert. + String representation of the specified tokens array. + + + + This method converts array of Ptg to its string representation. + + Ptg array that will be parsed. + First row to convert. + First column to convert. + Indicates whether R1C1 notation must be used. + String representation of the specified Ptg array. + + + + This method converts array of Ptg to its string representation. + + Ptg array that will be parsed. + First row to convert. + First column to convert. + Indicates whether R1C1 notation must be used. + Represents current number info, can be null. + String representation of the specified Ptg array. + + + + This method converts array of Ptg to its string representation. + + Ptg array that will be parsed. + First row to convert. + First column to convert. + Indicates whether R1C1 notation must be used. + Represents current number info, can be null. + Indicates whether to remove worksheet name from 3d tokens. + String representation of the specified Ptg array. + + + + Checks the formula version. + + The PTGS. + The result. + + + + + Splits array. Each string in result represents single row of the array. + + Array string to split. + Separator + Splitted array. + + + + Updates index of the name. + + Token to update. + Array with new named ranges indexes. + + + + Updates index of the name. + + Token to update. + Dictionary with new named ranges indexes. + + + + Updates name indexes. + + Parsed expression to update. + Dictionary with new indexes. + True if at least one of references to named ranges was updated. + + + + Updates name indexes. + + Parsed expression to update. + Array with new indexes. + True if at least one of references to named ranges was updated. + + + + Sets separators. + + Operand separator to set. + Array rows separator to set. + + + + Replaces keys in the list. + + List to replace in. + Old keys to replace. + New keys to replace. + + + + Marks used references. + + Tokens to get used references from. + Array to mark used references in. + + + + Updates reference indexes. + + Tokens to get used references from. + Array with updated indexes. + + + + Converts string that represents constant value to Ptg. + + String that represents constant. + Parent worksheet. + Dictionary with worksheet names + Parse options. + Token corresponding to the specified string. + + + + Converts string that represents constant value to Ptg. + + String that contains constant. + Parent worksheet. + + Dictionary with attributes that describes token index + that should be used at special function position. + + Parameter position. + + + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + Newly created token. + + When specified string is not constant formula token. + + + + + Normalizes sheet name. + + + + + + + Converts byte array to Ptg array. + + Object that provides access to the data. + + Number of bytes to parse (there can be array data + after of all tokens). + + Excel version that was used to infill data provider. + + String representation of the specified byte array that contains tokens. + + + + + Converts byte array to Ptg array. + + Object that provides access to the data. + Start position in data array to parse from. + + Number of bytes to parse (there can be array data + after of all tokens). + + + Receives offset of first byte after all tokens' data. + + Excel version that was used to infill data provider. + Converted Ptg array. + + + + Converts token array to corresponding byte array. + + Ptg array that will be converted to byte array. + Excel version that should be used to infill data. + Converted byte array + + + + Converts token array to corresponding byte array. + + Ptg array that will be converted to byte array. + + Length of formula without tArray data if there is tArray in Tokens. + + Excel version that should be used to infill data. + Converted byte array. + + + + Searches for position of corresponding bracket. + + String to search. + Position of bracket( "(){}" ). + + Position of corresponding bracket if there is one, otherwise -1. + + + When specified position does not contain bracket. + + + + + Returns operand of the operation. + + + Formula string that contains operation and operands. + + Index of the operation. + Delimiters between operands. + + Search direction (TRUE -right to left, + FALSE - left to right). + + Operand defined by function parameters. + + When a open bracket is found without a corresponding closing bracket. + + + + + Registers function in internal collections. + + + Name of the function that must be registered. + + + Index of the function that must be registered. + + + Array of ReferenceIndexAttribute that contains information + about proper token index. + + + Number of parameters in the function, + -1, for variable parameters. + + + + + This method raises the FormulaEvaluation event. + + Range that caused FormulaEvaluation event. + Object that contains event arguments. + + + + Registers token class (can be user defined). + + Token class that will be registered. + + When class is not derived from Ptg. + + + When parameter type is NULL. + + + + + Registers new function alias. + + New alias name. + Function index. + + + + Updates index of the name. + + Ptg to Update + Old index. + New index. + + + + Searches for the specified object and returns the index of + the first occurrence within the entire one-dimensional array. + + Array to search. + Value to locate in the array. + + The index of the first occurrence of value within the entire array, if found; + otherwise, -1. + + + + Searches for the specified object and returns the index of + the first occurrence within the entire one-dimensional array. + + Array to search. + Value to locate in the array. + + The index of the first occurrence of value within the entire array, if found; + otherwise, -1. + + + + Searches for the specified object and returns the index of + the first occurrence within the entire one-dimensional array. + + Array to search. + Value to locate in the array. + + The index of the first occurrence of value within the entire array, if found; + otherwise, -1. + + + + Searches for the specified object and returns the index of + the first occurrence within the entire one-dimensional array. + + Array to search. + Value to locate in the array. + + The index of the first occurrence of value within the entire array, if found; + otherwise, -1. + + + + Searches for the specified object and returns the index of + the first occurrence within the entire one-dimensional array. + + String to search in. + Start index. + Break strings. + Position of one of the break strings. + + + + Searches for the specified object and returns the index of + the first occurrence within the entire one-dimensional array. + + String to search in. + Start index. + Key is break string. + Position of one of the break strings. + + + + Returns lower bound of strings that have specified first character. + + Sorted array of string to search. + Desired first character. + + Lower bound of the strings that have chFirst as the first character + if there are such strings; otherwise -1. + + + + Returns lower bound of strings that have specified first character. + + Sorted array of string to search. + Desired first character. + + Lower bound of the strings that have chFirst as the first character + if there are such strings; otherwise -1. + + + + Returns lower bound of strings that have specified first character. + + Sorted array of string to search. + Desired first character. + + Lower bound of the strings that have chFirst as the first character + if there are such strings; otherwise -1. + + + + Converts SharedFormula tokens into regular formula tokens. + + Shared formula to convert. + Parent workbook. + Row of the destination formula. + Column of the destination formula. + Converted token array. + + + + Updates formula after move / copy operation. + + Tokens to update. + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + One-based row index. + One-based column index. + Updated tokens array. + + + + Pushes operand into stack correctly. + + + + + + + Indicates whether specified string is name of custom function. + + String to check. + Workbook that contains function. + Index to the extern workbook. + Name index. + True if specified string is name of custom function. + + + + Indicates whether specified name is name of local custom function. + + Parent workbook. + Function name. + Resulting name index. + + + + + Checks is custom function. + + Parent Workbook. + Current Match. + Book index. + Name index. + True if it is custom function, otherwise false. + + + + Indicates if specified string is cell name. + + Formula string that will be checked. + Indicates whether R1C1 notation must be used. + String representation of the row. + String representation of the column. + True if parameter is cell name, i.e. "A1", False otherwise. + + + + Returns true, if specified string is R1C1 reference. + + Formula string that will be checked. + True, if paramater is R1C1 cell reference. + + + + Indicates if specified string is cell range. + + Formula string that will be checked. + Indicates whether R1C1 notation must be used. + The first cell's row. + The first cell's column. + The second cell's row. + The second cell's column + True if parameter is cell range, i.e. "A1:D1", False otherwise. + + + + + + + + + + + + Indicates if specified strings is 3d cell reference. + + Formula string that will be checked. + Indicates whether R1C1 notation must be used. + Name of the worksheet if succeeded; otherwise - NULL. + String representation of the row part of the cell reference. + String representation of the column part of the cell reference. + + True if parameter is 3d cell reference, i.e. "Sheet1!A1", False otherwise. + + + + + Indicates whether specified string is 3d cell range. + + String that should be checked. + Indicates whether R1C1 notation must be used. + String that initialize by current sheet name. + String representation of the row part of the first cell reference. + String representation of the column part of the first cell reference. + String representation of the row part of the second cell reference. + String representation of the column part of the second cell reference. + True if string is 3d cell range. + + + + Tells whether specified string contains error + at the specified position. + + String that can contain error string. + Index were error. + + True if specified string contains error + at the specified position. + + + + + Indicates whether specified string is name defined in the workbook. + + String to check. + Parent workbook. + IWorksheet implement. + True if specified string is name defined in the workbook; False otherwise. + + + + Searches for corresponding bracket. + + Formula string where bracket was found. + Position of the found bracket. + Array of all possible opening brackets. + Search direction. + Position of the corresponding record. + + If the corresponding bracket is not found. + + + If there is no bracket at the specified bracket position. + + + + + Indicates if specified string contains unary operation + at the specified position. + + Formula string. + Index of unary operation. + Returns true if operation is unary, false otherwise. + + + + Checks whether the specified string contains operation at the specified position. + + Formula string. + Index of operation symbol in the string. + Operation index. + True if operation is in specified location. + + + + Checks whether specified operand is a function call. + + Operand that will be checked. + Position of the opening bracket. + True if operand denotes function call, False otherwise. + + + + Gets string representing error name that started from errorIndex. + + Formula string that contains error name. + Index of the first char of the error. + + String representing error name that started from errorIndex. + + + When starting symbol of the possible error is not '#' + or if can't find such error name. + + + + + + + + + + + + + + Returns index of the token that should be used at + position i by type targetType in function call. + + Target type for which index will be searched. + + Dictionary with indexes. + Position of the function parameter. + Parse options. + Index of the token code. + + + + Creates new Ptg and sets offset to point just after its data. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + Parsed Ptg token. + + When data array is smaller than token that should be stored in it. + + + + + Creates formula token using token code. + + Token code. + Newly created token. + + + + Creates formula token using token code. + + Token code that is used to get constructor and as constructor argument as well. + Newly created token. + + + + Creates token using token id and string representing this token. + + Token id of the token that should be created. + String that will be passed to the token constructor. + Newly created token. + + + + Creates token using token code, token string, and parent workbook. + + Code of the new token. + String representation of the token. + Parent workbook. + Newly created token. + + + + Creates specified token, passes specified parameters to its constructor. + + Code of the token that will be created. + Constructor parameters. + Newly created token. + + + + Creates specified token, passes two integers to its constructor. + + Token to create. + First integer argument. + Second integer argument. + Newly created token. + + + + Creates specified token, passes function index to its constructor. + + Token to create. + Function index. + Newly created token. + + + + Creates token using two string values. + + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + Token to create. + First value. + Second value. + Indicates whether R1C1 notation is used. + Created formula token. + + + + Creates token using two string values. + + Token to create. + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + First value. + Second value. + Third value. + Fourth value. + Indicates whether R1C1 notation is used. + Parent workbook. + Created formula token. + + + + Creates token using two string values. + + Token to create. + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + Worksheet reference index. + First value. + Second value. + Third value. + Fourth value. + Indicates whether R1C1 notation is used. + Parent workbook. + Created formula token. + + + + Removes tokens that are unnecessary. + + + + + + + Puts all right sided unary operations before operand. + + Formula to transform. + Formula after transformation. + + + + Registers function in internal collections. + + + Name of the function that must be registered. + + + Index of the function that must be registered. + + + Array of ReferenceIndexAttribute that contains information + about proper token index. + + + Number of parameters in the function, + -1, for variable parameters. + + + + + Indicates whether specified function is supported just in Excel 2013. + + Function id. + Value indicating whether specified function appeared in Excel 2013. + + + + Indicates whether specified function is supported just in Excel 2010. + + Function id. + Value indicating whether specified function appeared in Excel 2010. + + + + Indicates whether specified function is supported just in Excel 2007. + + Function id. + Value indicating whether specified function appeared in Excel 2007. + + + + Checks whether any of these tokens has external reference. + + + + + + + Event handler that will receive array of Ptg after parsing. + + + + + Returns IDictionary error code - to - name. Read-only. + + + + + Returns IDictionary error name - to - error code. Read-only. + + + + + Returns array row separator. Read-only. + + + + + Returns operands separator. Read-only. + + + + + Gets or sets number format for parsing double value. + + + + + + + + + + Constructor id. + + + + + This class is used in the construction of formula tokens. + + + + + Dictionary key (int) - constructor id, value - ConstructorInfo. + + + + + Token class for which this instance was created. + + + + + Token class for which this instance was created. + + + + + Creates class instance for specified type. + + + Type for which an object will be created. Must be inherited from Ptg class. + + + When specified type is not inherited from Ptg class. + + + When specified type is null. + + + + + Creates token using default constructor. + + Newly created token. + + + + Creates token using string parameter. + + Token type to pass to constructor. + Newly created token. + + + + Creates token using string parameter. + + + String parameter that will be passed to constructor. + + Newly created token. + + + + Creates token using array of bytes and offset + where token data begins. + + Object that provides access to the data. + Offset to the token data. + Arguments required by some parse methods. + Newly created token + + + + This method looks for constructor that takes specified + parameters and invokes it. + + + Parameters that will be passed to the constructor. + + Newly created token. + + + + Creates token using string and parent workbook. + + String representation of the token. + Parent workbook. + Created formula token. + + + + Creates token using two integer values. + + First value. + Second value. + Created formula token. + + + + Creates token using function index. + + Function index. + Created formula token. + + + + Creates token using two string values. + + Row index of the cell that contains new token. + Column index of the cell that contains new token. + First value. + Second value. + Indicates whether R1C1 notation is used. + Created formula token. + + + + Creates token using two string values. + + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + First value. + Second value. + Third value. + Fourth value. + Indicates whether R1C1 notation is used. + Parent workbook. + Created formula token. + + + + Creates token using two string values. + + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + Worksheet reference index. + First value. + Second value. + Third value. + Fourth value. + Indicates whether R1C1 notation is used. + Parent workbook. + Created formula token. + + + + Gets constructor. + + Constructor id. + Constructor with specified id. + + + + Sets constructor. + + Constructor id. + Corresponding ConstructorInfo. + + + + Gets / sets default constructor. + + + + + Gets / sets string constructor. + + + + + Gets / sets ByteArrayOffset constructor. + + + + + Gets / sets StringParent constructor. + + + + + Gets / sets TwoInts constructor. + + + + + Gets / sets FunctionIndex constructor. + + + + + Gets / sets constructor that accepts two strings as arguments. + + + + + Gets / sets constructor that accepts four strings as arguments. + + + + + Gets / sets constructor that accepts three ints, four strings + and a bool as arguments. + + + + + Gets / sets constructor that accepts three ints, four strings + and a bool as arguments. + + + + + This class is used when formula value needs to be + evaluated. Provides range that contains formula that should + be evaluated and Ptg array - parsed formula string. + + + + + Range that raised this event. Read-only. + + + + + Ptg array with formula tokens of the range. + + + + + Default constructor. + + + + + Main constructor. + + Range containing formula. + Formula tokens array. + + + + Range that raised this event. Read-only. + + + + + Ptg array with formula tokens of the range. + + + + + Empty arguments (all properties with default values). Read-only. + + + + + + Delegate that can be used for formula evaluation purposes. + + + + + Summary description for GradientWrapper. + + + + + Wrapped shape fill. + + + + + Creates new gradient wrapper. + + Gradient to wrap. + + + + Compares with shape fill impl. + + Shape fill to compare with. + Zero if shape fills are equal. + + + + Sets the specified fill to a two-color gradient. + + + + + Sets the specified fill to a two-color gradient. + + Represents shading shading style. + Represents shading variant. + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Validates whether gradient variant is correct for current gradient style. + + Gradient variant to validate. + + + + Represents background color. + + + + + Represents background color. + + + + + Represents background color index. + + + + + Represents foreground color. + + + + + Represents foreground color. + + + + + Represents foreground color index. + + + + + + + + + + Represents gradient shading style. + + + + + Returns wrapped gradient. Read-only. + + + + + Event raised after wrapped font changed. + + + + + Summary description for GradientArrayWrapper. + + + + + Array that contains all cells of the range. + + + + + Create new instance of object. + + Base range. + + + + Compares with shape fill impl. + + Gradient to compare with. + Zero if shape fills are equal. + + + + Sets the specified fill to a two-color gradient. + + + + + Sets the specified fill to a two-color gradient. + + Represents shading shading style. + Represents shading variant. + + + + Represents background color. + + + + + Represents background color. + + + + + Represents background color index. + + + + + Represents foreground color. + + + + + Represents foreground color. + + + + + Represents foreground color index. + + + + + Represents gradient shading style. + + + + + Represents gradient shading variant. + + + + + This class is responsible for shape id's reservation. + + + + + Size of the single id's segment. + + + + + Dictionary that contains information about reserved id's. + key - segment start + value - id of the collection that reserved current segment. + + + + + Dictionary that contains information about number of reserved id's. + key - segment start + value - number of reserved sectors. + + + + + Number of sectors (key) and first id (value) reserved by some collection. + + + + + Maximum reserved id. + + + + + Additional shapes. + + + + + Evaluates start of the segment containing specified id. + + Id to get segment start for. + + + + + Checks whether segment with specified id is free. + + Id to check. + Number of segments to check. + True if all segments are free. + + + + Gets index of the collection which reserved specified id. + + Id to check. + Index of the collection which reserved id, or 0 if it is not reserved. + + + + Tries to reserve segment or segments containing specified ids for the specified collection. + + Start id to reserve. + Last id to reserve. + Collection owning those ids + True if reservation succeeded. + + + + Increases number of reserved shapes in the segment. + + Id that belongs to the segment to increase number for. + + + + Checks whether specified id range is reserved by specified shape collection. + + Start id to check. + End id to check. + Collection id to check. + True if all ids are reserved by the specified collection. + + + + Frees segment that contains specified id. + + Id used to detect segment start. + + + + Frees segments sequence if they belong to specified collection. + + Id to detect first segment. + Collection to free segments for. + + + + Frees all segments allocated by the collection. + + Collection id. + + + + Allocates specified number of segments. + + Ids count to allocate. + Collection id. + Index to the first allocate id. + + + + Returns number of reserved ids by specified collection. + + Collection index. + Number of reserved ids. + + + + Registers any number of additional shapes required by collection. + + Collection index. + Number of additional shapes to add. + + + + Gets number of additional shapes reserved by collection. + + Collection index. + Number of additional shapes. + + + + Gets maximum accessed shape id. + + + + + + + + + Construct data table. + + DataTable with desired data. + Row of the first cell where DataTable should be imported. + Column of the first cell where DataTable should be imported. + style index of date. + + + + + + + + Summary description for GradientWrapper. + + + + + Represents Interior of an object. + + + + + Gets or sets the color of the interior pattern as an index into the current color palette. + + + + + Gets or sets the color of the interior pattern as an Color value. + + + + + Gets or sets the interior color of the object. The color is specified as + an index value into the current color palette. + + + + + Gets or sets the interior color of the object. + + + + + Gets the gradient object for this extended format. + + + + + Gets or sets type that represents the interior pattern. + + + + + Extended format. + + + + + Gradient wrapper. + + + + + Creates new interior wrapper. + + Extended format. + + + + Event handler for gradient AfterChange event. + + Event sender. + Event arguments. + + + + Creates gradient wrapper. + + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Returns or sets the color of the interior pattern as an index into the current color palette. + + + + + Returns or sets the color of the interior pattern as an Color value. + + + + + Gets or sets the interior color of the object. The color is specified as + an index value into the current color palette. + + + + + Gets or sets the interior color of the object. + + + + + Returns gradient object for this extended format. + + + + + Gets or sets type that represents the interior pattern. + + + + + Event raised after wrapped font changed. + + + + + Returns wrapped interior. Read-only. + + + + + Class that is created when user accesses the interior in a multicell range. + Redirects all calls to the interiors of the individual cells. + + + + + Array that contains all cells of the range. + + + + + Create new instance of object. + + Base range. + + + + Returns or sets the color of the interior pattern as an index into the current color palette. + + + + + Returns or sets the color of the interior pattern as an Color value. + + + + + Returns or sets the color of the interior. The color is specified as + an index value into the current color palette. + + + + + Returns or sets the cell shading color. + + + + + Returns gradient object. + + + + + Gets / Sets fill pattern. + + + + + This class contains information about all merged + cells in the parent workbook. + + + + + Parent worksheet. + + + + + Contains all not parsed merge records. + + + + + Indicates whether object was parsed. + + + + + Cell range address list of all merged cells. + + + + + Sets application and parent fields. + + Application object for the new instance. + Parent object for the new instance. + + + + Searches for all necessary parents. + + + + + Adds new merge to the existing merges. + + Range that should be merged. + + Operation type - Information on what needs to be done if some of + the cells are already merged. + + + + + Adds a new region if it intersects with other regions. + If operation is Leave, the function leaves the old region. Otherwise + it deletes old region. + + Region that will be merged. + + Operation type - tells what should be done if some of + the cells are already merged. + + + + + Adds new region if it intersects with other regions. + + First row to merge. Zero-based. + Last row to merge. Zero-based. + First column to merge. Zero-based. + Last column to merge. Zero-based. + + Operation type - tells what should be done if some of + the cells are already merged. + + + + + Removes merge that contains a specific cell. + + + Range of the cells to be removed. + + + + + Clear all merges. + + + + + Adds merge regions from the MergeCellsRecord. + + + + + Removes row(s) from the collection. + + Row index to remove. + Number of rows to remove. + + + + Inserts row to the collection. + + Row index to insert. + Number of row to insert. + + + + Removes columns from the collection. + + Column index to remove. + Number of columns to remove + + + + Inserts column into collection + + Column index to insert. + Number of columns to insert. + + + + Removes or inserts one row from merges collection. + + One-based row index to remove or insert. + Indicates whether to remove or insert rows. + Count of row to remove. + + + + Removes or inserts one column from merges collection. + + One-based column index to remove. + Indicates whether to remove or insert rows. + Number of columns to insert or remove. + + + + Creates a copy of the current object. + + Parent object for the new object. + A copy of the current object. + + + + Creates copy of the specified list. + + List to clone. + A copy of the specified list. + + + + Sets new dimensions - removes unnecessary items (that are out of bounds) or truncates them. + + New maximum possible row count. + New maximum possible column count. + + + + Finds merged region for specific cell. + + Cell range address. + Merged region that includes specified cell. + + + + Converts rectangle to merged region. + + Rectangle to convert. + Merged region. + + + + Inserts or removes row into the merge region before first row. + + Region to modify after insert/remove row operation. + Indicates whether it is remove operation. + Row index. + Number of rows to insert. + Workbook where operation is performed. + Modified region. + + + + Inserts or removes row into region the merge at the first row. + + Region to modify after insert/remove row operation. + Indicates whether it is remove operation. + Number of rows to insert. + Workbook where operation is performed. + Modified region. + + + + Inserts or removes row into the merge region in the middle or at the end of the range. + + Region to modify after insert/remove row operation. + Indicates whether it is remove operation. + Row index. + Number of rows to insert. + Workbook where operation is performed. + Modified region. + + + + Inserts or removes row after end of the region. + + Region to modify after insert/remove row operation. + Indicates whether it is remove operation. + Number of rows to insert. + Modified region. + + + + Inserts or removes row. + + Region to modify after insert/remove row operation. + Row index. + Indicates whether it is remove operation. + Number of rows to insert. + Workbook where operation is performed. + + + + + Inserts or removes column into the merge region before first column. + + Region to modify after insert/remove column operation. + Indicates whether it is remove operation. + Column index. + Number of columns to insert. + Workbook where operation is performed. + Modified region. + + + + Inserts or removes column into the merge region at the first column. + + Region to modify after insert/remove column operation. + Indicates whether it is remove operation. + Number of columns to insert. + Workbook where operation is performed. + Modified region. + + + + Inserts or removes column into the merge region in the middle or at the end of the range. + + Region to modify after insert/remove column operation. + Indicates whether it is remove operation. + Column index. + Number of columns to insert. + Workbook where operation is performed. + Modified region. + + + + Inserts or removes column after end of the region. + + Region to modify after insert/remove column operation. + Indicates whether it is remove operation. + Number of columns to insert. + Modified region. + + + + + + Region to modify after insert/remove column operation. + Column index. + Indicates whether it is remove operation. + Number of columns to insert. + Workbook where operation is performed. + Modified region. + + + + Ensures that row index is in correct range. + + Row index to check. + Workbook where operation is performed. + Row index from the correct range. + + + + Ensures that column index is in correct range. + + Column index to check. + Workbook where operation is performed. + Column index from the correct range. + + + + Number of merges in the collection. + + + + + Collection of all merged regions. + + + + + Returns single merge region from the collection. + + + + + Returns single merge region from the collection. + + + + + Summary description for MigrantRangeImpl. + + + + + Range represents one cell or a rectangle of cells. + + + + + + + + + + + + + + + + + + + + Row zero-based index. + + + + + Column zero-based index. + + + + + Index of extended format. + + + + + Returns type code. Read-only. + + + + + Default format for date values. + + + + + Default format for time values. + + + + + Default format for date time values. + + + + + Default date time index. + + + + + Default OleDateValue + + + + + Maximum OleDateValue + + + + + Default format for number values. + + + + + Default format for text values. + + + + + General format. + + + + + Format for array-entered formula representation. + + + + + Error message when method that should be called only for single-cell ranges + was called for range with multiple cells. + + + + + Default style. + + + + + Index of extended format for normal style. + + + + + Default format for WrapText values. + + + + + Whitspace for the numberformat. + + + + + Represents default cell name separator. + + + + + Column section start in the R1C1 reference string. + + + + + Row section start in the R1C1 reference string. + + + + + Opening bracket for relative row / column index in the R1C1 reference mode. + + + + + Closing bracket for relative row / column index in the R1C1 reference mode. + + + + + Local address format in R1C1 notation. + + + + + Maximum OADate value. + + + + + Represents default number format index. + + + + + Represents first number format index. + + + + + Represents second number format index. + + + + + Number of bits in cell index that holds column value. + + + + + Defines whether to set XF index in SetFormulaArrayRecord method. + + + + + Defines the singleQuote. + + + + + Defines a new line character + + + + + Default percentage number format . + + + + + Default decimal percentage number format . + + + + + Default exponential number format . + + + + + Default culture info time token + + + + + Default time token number format . + + + + + Represents the UK culture Name. + + + + + Cell types that can contain date time values. + + + + + Represents auto format types, that contain right horizontal alignment. + + + + + Represents auto format types, that contain number format. + + + + + Minimum supported date time value. + + + + + Minimum supported date time value. + + + + + Represents the list of date time formula. + + + + + Reference on worksheet to which current range belongs to. + + + + + Reference on workbook to which worksheet and current range belong to. + + + + + Index of the left column. + + + + + Index of the right column. + + + + + Index of the top row. + + + + + Index of the bottom row. + + + + + + + + + + + + + + + + + + + + This array stores references of all cells that this + range represents. + + + + + Style wrapper for this range. + + + + + True - indicates that cells collection was filled before, otherwise False. + + + + + Defines a date separator of current culture + + + + + Defines a time separator of current culture + + + + + Represents RTF string. + + + + + True if it is Entire row. + + + + + True if it is Entire column. + + + + + False if Number format is set in run time + + + + + Creates a new outline levels dictionary. + + + + + Number of subtotal in a specific range + + + + + Get DateTime based on culture + + Display text. + The cell value. + The format impl. + + + + + + Checks the OS specific formats. + + The inner number format. + + + + + Create style for Entire row or Entire column. + + + + + Called after changing of value. + + Old value. + New value. + + + + Checks if all formula arrays partially contained by this range + or fully contained by this range. Read-only. + + Collection of array formula records. + Value indicating whether all formula arrays partially contained by this range. + + + + Returns number from the style name, i.e. Normal_1 result is 1. + + Style name. + Parsed number. + + + + This method is called after changing last column index. + + + + + This method is called after changing first column index. + + + + + This method is called after changing last row index. + + + + + This method is called after changing first row index. + + + + + This method is called after changing style of the range. + + Cell type. + + + + Checks whether first symbol is apostrophe and sets appropriate cell style. + + Value to check. + Updated string value. + + + + Converts object to double if possible. + + Object to convert. + Converted value. + + + + Gets Row from collection. + + One-based row index. + Row information. + + + + Gets Column from collection. + + One-based column index. + Column information. + + + + Sets the workbook. + + The book. + + + + Return outline from the dictionary that corresponds to the specified index, + creates new one if necessary. + + + Indicates whether row outline or column outline + should be returned from the collection. + + Collection of outlines. + Index of the needed outline. + + Indicates whether exeption should be thrown when incorrect index passed + or just return Null value. + + Outline from the collection or newly created one. + + + + Gets display text. + + Value representing displayed string. + + + + Parses the number format. + + + + + + Checks the unnecessary char. + + The split format. + + + + + Fills internal BiffRecord with data from specified DateTime. + + DateTime with range value. + + + + Fills internal BiffRecord with data from specified DateTime. + + DateTime with range value. + + + + Returns number value from the cell if possible. + + Stored number. + + + + Fills internal BiffRecord with data from specified number. + + Number with range value. + + + + Fills internal BiffRecord with data from specified number. + + Number with range value. + + + + Creates correct record that can store specified number. + + Value to store. + Created record with number. + + + + Fills internal BiffRecord with data with specified boolean value. + + Boolean with range value. + + + + Fills internal BiffRecord with data with specified error value. + + String with error value. + + + + Gets error code by error string. + + Represents error string. + Returns error code. + + + + Copies formula record. + + Record to copy. + + + + This method should be called after any changes in the range. + Sets Saved property of the parent workbook to false. + + + + + Checks if specified cell has correct row and column index. + + Index of the row of the cell. + Index of the column of the cell. + + When row or column is less than 1 or column is greater than maximum possible column index + (it is 256 for Excel 2003, and 16384 for Excel 2007). + + + + + Searches for specified worksheet in the parent workbook. + + Name of the worksheet to search. + Found worksheet. + + If there is no such worksheet in the parent workbook. + + + + + Parses formula record. + + Record to parse. + + Indicates whether to return formula string in R1C1 notation. + + Parsed string value. + + + + Sets row height. + + Value to set. + Indicates whether font and row height are not compatible. + + + + Creates rich text string. + + + + + Tries to create Value2. + + Value2 value. + + + + Detects whether specified value is error or boolean and tries to parse it. + + String to parse. + True if value type was detected and value was parsed correctly. + + + + Sets index in the LabelSST record. + + New index value. + + + + Tries to remove all formula arrays from this range. + + + Thrown when it's impossible to remove array formula. + + + + + Blanks cell. + + + + + Sets new parent. + + Parent to set. + + + + Updates named ranges indexes. + + New indexes. + + + + Creates record and sets range data in it. + + Record type to create. + Newly created record. + + + + Creates record and sets range data in it. + + Record type to create. + Newly created record. + + + + Updates range. + + First row index. + First column index. + Last row index. + Last column index. + + + + Tries to convert string into datetime value. + + String to parse. + Converted value. + True if conversion succeeded, false otherwise. + + + + Identifies the Date separator + + returns a date seperator + + + + Identifies the time separator + + Returns a time seperator + + + + Parses R1C1 reference. + + Reference to parse. + Range that corresponds to the string. + + + + Parses R1C1 expression + + String to parse. + Represents rectangle of coordinates. + Indicates is it first expression. + Returns rectangle with updated coordinates. + + + + Parses index string in R1C1 style and evaluates absolute row or column index. + + Value to parse. + Indicates whether this is row or column index. + Parsed row or column index. + + + + Converts array-entered formula to string.. + + Indicates whether R1C1 notation must be used. + String representation of the array-entered formula. + + + + Sets array-entered formula. + + String representation of the formula. + Indicates whether R1C1 notation is used. + + + + Sets array formula record. + + Formula array record. + + + + Sets array formula record. + + Formula array record. + Extended format index. + + + + Updates record with new position and extended format record if necessary. + + Record to update. + Cell to get data from. + XF index to set. + + + + Normalizes row index. + + One-based row index to normalize. + First column. + Last column. + Normalized row index. + + + + Normalizes row index. + + One-based column index to normalize. + First row. + Last row. + Normalized column index. + + + + Partially clear range. + + + + + Sets border to single cell. + + Represents border index. + Represents border line type. + Represents border line color. + + + + Collapses or expands this group. + + Should we perform operation on rows or columns? + Indicates desired group state. If it is True then group should be collapsed, otherwise expanded. + Flag indicating collapse or expand settings. + + + + Collapses or expands group. + + Indicates whether group is collapsed. + Represents start index. + Represents end index. + Represents maximum index. + Indicates whether last index. + Provides outline information. + Flag for expand or collapse setting. + + + + Sets hidden state. + + Represents starting index. + Represents ending index. + Provides Outline information. + Value indicating whether outline is hidden + + + + Expands outlines. + + Represents starting index. + Represents end index. + Provides outline information. + Value indicating whether to include sub groups + Value indicating whether last index + + + + Determines whether parent outline group is visible or not. + + Start index of the child group. + End index of the child group. + Maximum possible outline index. + Method that is used to get outline by index. + True if parent group is visible. + + + + Searches for the first outline with lower level (parent). + + Start index to search from. + Delta to add to outline index after each iteration (direction). + Maximum possible outline index. + Method that is used to get outline by index. + Found outline index with lower level or -1. + + + + Searches for the edge of the group. + + Start index to search from. + Delta to add to the index at each iteration. + Maximum possible outline index. + Method that is used to get outline by index. + Outline level of the group to find edge for. + Index of the parent group start. + + + + Searches for the first visible outline of the required level. + + Start index to search. + End index to search. + Method that is used to get outline by index. + Outline level to check. + Index of the first found visible outline. + + + + Gets the formula value. + + Type of the field. + Represents the row to fetch the value. + Represents the column to fetch the value. + if set to true [is string]. + Returns the formula value. + + + + The specified value is detected for fraction value and set to Value property. + + The value assigned to property. + True if the specified value is a fraction. Otherwise False. + + + + sets the time number format based on value. + + Value to check the time format. + + + + Sets formula value to the current Range. + + Formula value. + + + + Sets formula value to the current Range. + + Formula value. + + Dictionary with new worksheet names (to copy worksheet's + into workbook's and merging workbooks). + + Indicates whether R1C1-style notation is used. + + + + Sets auto format pattern. + + Represents pattern color. + Represents first row. + Represents last row. + Represents first column. + Represents last column. + + + + Sets auto format pattern. + + Represents pattern color. + Represents first row. + Represents last row. + Represents first column. + Represents last column. + Represents pattern color. + Represents cell pattern. + + + + Sets auto format patterns. + + Represents auto format type. + + + + Sets auto format pattern for list_1 or list_2 types. + + Indicates if it is list_1 auto format type. + Represents default fore color. + Represents default back color. + + + + Sets auot format alignment. + + Represents auto format type. + + + + Sets auto format alignment. + + Represents align. + Represents first row. + Represents last row. + Represents first column. + Represents last column. + + + + Sets auto format width height. + + Represents auto format type. + + + + Sets auto format number. + + Represents auto format type. + + + + Sets auto format font border. + + Represents auto format type. + Indicates if set font object. + Indicates if set borders. + + + + Sets auto format simple font border. + + Indicates if set font object. + Indicates if set borders. + + + + Sets auto format Classic_1 font and border. + + Indicates if set font object. + Indicates if set borders. + + + + Sets auto format Classic_2 font and border. + + Indicates if set font object. + Indicates if set borders. + + + + Sets auto format Classic_3 font and border. + + Indicates if set font object. + Indicates if set borders. + + + + Sets auto format Accounting_1 font and border. + + Indicates if set font object. + Indicates if set borders. + + + + Sets auto format Accounting_2 font and border. + + Indicates if set font object. + Indicates if set borders. + + + + Sets auto format Accounting_3 font and border. + + Indicates if set font object. + Indicates if set borders. + + + + Sets auto format Accounting_4 font and border. + + Indicates if set font object. + Indicates if set borders. + + + + Sets auto format font. + + Represents font object. + Represents first row. + Represents last row. + Represents first column. + Represents last column. + + + + Creates an object and sets its Application and Parent + properties to specified values. + + Application object for the range. + Parent object for the range. + + The parent worksheet or workbook cannot be found. + + + + + Recover Range from Biff records. + + Application object for the range. + Parent object for the range. + Array of BiffRecordRaws which contains record for the range. + Index of record for the range. + + + + Recover Range from Biff records. + + Application object for the range. + Parent object for the range. + + Array of BiffRecordRaws which contains record for the range. + + Index of record for the range. + Indicates whether to ignore styles. + + + + Recover Range from Biff records. + + Application object for the range. + Parent object for the range. + Array of BiffRecordRaws which contains record for the range. + Index of record for the range. + Indicates whether to ignore styles. + + + + Creates range with specified top-left and bottom-right corners. + + Application object for the range. + Parent object for the range. + First row of the range. + Last row of the range. + First column of the range. + Last column of the range. + + + + Creates range for specified single cell. + + Application object for the range. + Parent object for the range. + Row index for the range. + Column index for the range. + + + + Creates new range based on the record. + + Application object. + Parent object. + Range record. + Indicates whether to ignore styles. + + + + Fill internal collection by references on cells. + + + + + Clears internal cells array. + + + + + This method is called when disposing the object. + + + + + Searches for all necessary parents. + + + + + Recover region from array of Biff Records and position in it. + + Array of BiffRecordRaws that contains range record. + Position of range record. + + + + Recover region from array of Biff Records and position in it. + + Array of BiffRecordRaws that contains range record. + Position of range record. + Indicates whether to ignore style. + + + + Parses double value accordingly to format string. + + Value to parse. + Parsed value. + + + + Parses BlankRecord. + + BlankRecord to parse. + Blank string. + + + + Reparses formula record. + + Record to reparse. + + + + Parses FormulaRecord. + + FormulaRecord to parse. + List with Biff records. + Position of formula in the list. + + + + Parses BoolErrRecord. + + BoolErrRecord to parse. + Extracted BoolError record. + + + + Parses RStringRecord. + + RStringRecord to parse. + Blank string. + + + + Attaches handler to NameIndexChanged event. + + Workbook with name. + Event handler. + Parsed formula. + Workbook index. + New index. + Indicates whether event handler should be added. + + + + Attaches index changed event handler to extern name collection. + + Parent workbook. + NamexPtg that identifies named range. + Workbook index. + NamedRange index to attach to. + Event handler. + Dictionary with indexes of named range that already have attached event. + Indicates whether event handler should be added. + + + + Attaches index changed event handler to local name collection. + + Parent workbook. + NamePtg that identifies named range. + Workbook index. + New name index. + Event handler + Dictionary with indexes of named range that already have attached event. + Indicates whether event handler should be added. + + + + Combines book index and name index into one index. + + Book index. + Name index. + Combined index. + + + + Clear the contents of the Range. + + + + + Clear the contents of the Range with formatting. + + True if formatting should also be cleared. + + + + Returns intersection of this range with the specified one. + + The Range with which to intersect. + Range intersection. If there is no intersection, NULL is returned. + + + + Autofit columns. + + + + + Auto fit the column. + + The first column. + The last column. + + + + Determines whether the range is Merged or not. + + The merged cells. + Represents the row. + Represents the column + whether method called by AutoFitColumn or AutoFitRow + Difference of Merged Range. + + true, if the Range is merged, else false. + + + + + Gets the display text. + + The row. + The column. + The format impl. + + + + + Gets the number or date time. + + The format impl. + The cell value. + + + + + Replaces oldValue by newValue. + + Value to compare. + Value to replace by. + + + + Replaces oldValue by newValue. + + Value to compare. + Value to replace by. + + + + Replaces oldValue by newValue. + + Value to compare. + Value to replace by. + + + + Replaces oldValue by newValue. + + Value to compare. + Array to replace by. + Indicates whether to import values vertically or horizontally. + + + + Replaces oldValue by newValue. + + Value to compare. + Array to replace by. + Indicates whether to import values vertically or horizontally. + + + + Replaces oldValue by newValue. + + Value to compare. + Array to replace by. + Indicates whether to import values vertically or horizontally. + + + + Replaces oldValue by newValue. + + Value to compare. + DataTable to replace by. + Indicates whether to import field names. + + + + Replaces oldValue by newValue. + + Value to compare. + DataTable to replace by. + Indicates whether to import field names. + + + + Sets cell value. + + Value to be set. + + + + Gets new address of range. + + Dictionary with Worksheet names. + String that sets as a worksheet name. + Returns string with new name. + + + + Clones current IRange. + + Parent object. + Hash table with new names. + Parent workbook. + Returns clone of current instance. + + + + Returns array that contains information about range. + + Rectangles that describes range with zero-based coordinates. + + + + Returns number of rectangles returned by GetRectangles method. + + Number of rectangles returned by GetRectangles method. + + + + Gets R1C1 address from cell index. + + Cell index. + Returns R1C1 address. + + + + Converts cell name to cell index. + + Name of the cell. + Cell index of the specified cell. + + When specified cell name is null. + + + When length of the specified cell name is less than 2. + + + When length of the alpha part of the name is less + than 1 or greater than 2. + + + When length of the number part of the name is less + than 1 or greater than 5. + + + + + Converts cell name to row and column index. + + Name of the cell. + Row index. + Column index. + + + + Converts column name into index. + + Name to convert. + Converted value. + + + + Converts column index into string representation. + + Column to process. + String name in excel of the column + + + + Get cell name yy column and row index. + + Column index of the cell. + Row index of the cell. + Cell name. + + When firstColumn or firstRow is less than one. + + + + + Get cell name yy column and row index. + + Column index of the cell. + Row index of the cell. + Indicates whether to use R1C1-style reference mode. + Cell name. + + When firstColumn or firstRow is less than one. + + + + + Get cell name yy column and row index. + + Column index of the cell. + Row index of the cell. + Indicates whether to use R1C1-style reference mode. + If true adds '$' separator. + Cell name. + + When firstColumn or firstRow is less than one. + + + + + Returns the range reference for the specified range in the language + of the user. + + First row of the range. + First column of the range. + Last row of the range. + Last column of the range. + The range reference for the specified range in the language of the user. + + + + Returns the range reference for the specified range in the language + of the user. + + First row of the range. + First column of the range. + Last row of the range. + Last column of the range. + Indicates whether to use R1C1-style reference mode. + The range reference for the specified range in the language of the user. + + + + Get cell name by column and row index. + + Column index of the cell. + Row index of the cell. + Cell name. + + When firstColumn or firstRow is less than one. + + + + + Get cell index by column and row index. + + Column index of the cell. + Row index of the cell. + Cell index. + + When firstRow or firstColumn is less than zero. + + + + + Gets row index from cell index. + + Cell index. + Row index. + + + + Gets column index from cell index. + + Cell index. + Column index. + + + + Extracts worksheet name from range name. + + Range name to extract from. + Worksheet name. + + + + Helper methods for WrapText Property. + + List of IRange. + Gets WrapText property value. + + + + Helper methods for WrapText Property. + + List of IRange. + Value to set. + + + + Helper methods for WrapText Property. + + List of IRange. + Gets WrapText property value. + + + + Helper methods for CellStyleName Property. + + List of IRange. + Gets CellStyleName property value. + + + + Parses string representation of the range. + + Range to parse. + Parent workbook. + First row. + First column. + Last row. + Last column. + Number of parts: 1 - one cell, 2 - range of cells. + + + + Gets rectangle object, that represents rect of range. + + Represents current range. + If true than thrown an exception, if range is null. + Returns rectangle, that represents borders of range. + + + + This method is called when NumberFormat of the range changes. + + Event sender. + Event arguments. + + + + Attaches handler to NumberFormatChanged event of parent style. + + + + + Attaches event to cell styles. + + + + + Attaches handler to NumberFormatChanged of the specified wrapper. + + Wrapper to attach event to. + Handler to attach. + + + + Creates style wrapper. + + + + + Initializes style wrapper. + + Extended format index. + + + + Initializes style wrapper. + + Extended format index. + + + + Sets index of extended format that defines style for this range.. + + Index to set. + + + + Changes style name. + + Name to set. + Style object that corresponds to the name. + + + + Returns name of the style, applied to the cell. + + Name of the style, applied to the cell. + + + + Returns WrapText of the style, applied to the cell. + + WrapText of the style, applied to the cell. + + + + Gets format code. + + Value representing number format code + + + + Gets the date time by culture. + + Date in string format. + Result in Datetime. + Returns true, when the date time is culture based. + + + + Checks whether formula arrays inside this range are separated or not. + + Dictionary with records to skip. + True if records are not separated. + + + + Returns customized number format + + Number format string to be customized + Cutomized number format string + + + + Reparse cell if parsing wasn't successful when loading the workbook. + + + + + Gets ptg of current range. + + Returns native ptg. + + + + Gets the calculated value of a formula in the Range. Read-only. + + To compute a formula, it is mandatory to enable calculate engine by + invoking EnableSheetCalculations method of worksheet object. It is also recommend to disable + calculate engine once all formula are computed by invoking DisableSheetCalculations method of worksheet object + + + + Returns the range reference in the language of the macro. + Read-only String. + + + + + Returns the range reference for the specified range in the language + of the user. Read-only String. + + + + + Returns the range reference using R1C1 notation. + Read-only String. + + + + + Returns the range reference using R1C1 notation. + Read-only String. + + + + + Get / set boolean value that is contained by this range. + + + + + Returns a Borders collection that represents the borders of a style + or a range of cells (including a range defined as part of a + conditional format). + + + + + Returns a Range object that represents the cells in the specified range. + Read-only. + + + + + Returns the number of the first column in the first area of the specified + range. Read-only. + + + + + Column group level. Read-only. + -1 - not all column in the range have same group level. + 0 - No grouping, + 1 - 7 - group level. + + + + + Returns or sets the width of all columns in the specified range. + Read/write Double. + + + + + Returns the number of objects in the collection. Read-only. + + + + + Gets RowStorage from row + + + + + Get / set DateTime contained by this cell. + DateTime.MinValue if not all cells of the range have same DateTime value. + + + + + Returns cell value after number format application. Read-only. + + + + + Returns a Range object that represents the cell at the end of the + region that contains the source range. + + + + + True if it is Entire row. + + + + + True if it is Entire Column. + + + + + Returns a Range object that represents the entire column (or + columns) that contains the specified range. Read-only. + + + + + Returns a Range object that represents the entire row (or + rows) that contains the specified range. Read-only. + + + + + Get / set error value that is contained by this range. + + + + + Returns or sets the object's formula in A1-style notation and in + the language of the macro. Read/write Variant. + + + + + Represents array formula which can perform multiple calculations on one or more of the items in an array. + + + + + Returns the Formula in the cell as a string. + + + + + Returns the calculated value of the formula as a number. + + + + + Returns the calculated value of the formula as a boolean. + + + + + Returns the calculated value of the formula as a string. + + + + + Gets formula value. + + + + + True if the formula will be hidden when the worksheet is protected. + False if at least part of formula in the range is not hidden. + + + + + Get / set formula DateTime value contained by this cell. + DateTime.MinValue if not all cells of the range have same DateTime value. + + + + + Returns or sets the formula for the range, using R1C1-style notation. + + + + + Returns or sets the formula array for the range, using R1C1-style notation. + + + + + True if all cells in the range contain formulas; False if + none of the cells in the range contains a formula; NULL + otherwise. Read-only Variant. + + + + + Indicates whether range contains array-entered formula. Read-only. + + + + + Returns or sets the horizontal alignment for the specified object. + Read/write OfficeHAlign. + + + + + Returns or sets the indent level for the cell or range. Can be an integer + from 0 to 15 for Excel 97-2003 and 250 for Excel 2007. Read/write Integer. + + + + + Indicates whether range contains boolean value. + + + + + Indicates whether range contains error value. + + + + + Indicates whether this range is grouped by column. Read-only. + + + + + Indicates whether this range is grouped by row. Read-only. + + + + + Gets / sets last column of the range. + + + + + Gets / sets last row of the range. + + + + + Get / set number value that is contained by this range + + + When range value is not a number. + + + + + Returns or sets the format code for the object. Returns NULL + if all cells in the specified range don't have the same number + format. Read/write String. + + + + + Returns the number of the first row of the first area in + the range. Read-only Long. + + + + + Row group level. Read-only. + -1 - not all row in the range have same group level. + 0 - No grouping. + 1 - 7 - group level. + + + + + Returns the height of all the rows in the range specified, + in points. Returns Double.MinValue if the rows in the specified range + arent all the same height. Read / write. Double. Maximum Row height can be 409 + value, minimum is zero. + + + + + For a Range object, it returns an array of Range objects that represent the + rows in the specified range. + + + + + For a Range object, it returns an array of Range objects that represent the + columns in the specified range. + + + + + Returns a Style object that represents the style of the specified + range. Read/write Variant. + + + + + Gets / sets name of the style for the current range. + + + + + Gets/sets built in style. + + + + + Gets / sets text contained by this cell. + + + + + Gets / sets TimeSpan contained by this cell. + + + + + Returns or sets the value of the specified range. + Read/write Variant. + + + + + Returns or sets the cell value. Read/write Variant. + The only difference between this property and the Value property is + that the Value2 property doesn't use the Currency and Date data types. + + + + + Gets or sets a value indicating whether this instance is num reference for chart axis. + + + true if this instance is num reference; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is a string reference for chart axis. + + + true if this instance is string reference; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is multi reference for chart axis. + + + true if this instance is multi reference; otherwise, false. + + + + + Returns or sets the vertical alignment of the specified object. + Read/write OfficeVAlign. + + + + + Returns a worksheet object that represents the worksheet + containing the specified range. Read-only. + + + + + Gets or sets cell by row and column index. Row and column indexes are one-based. + + + + + Get cell range. Row and column indexes are one-based. Read-only. + + + + + Gets cell range. Read-only. + + + + + Gets cell range. Read-only. + + + + + Indicates if current range has formula bool value. Read-only. + + + + + Indicates if current range has formula error value. Read-only. + + + + + Indicates if current range has formula value formatted as DateTime. Read-only. + + + + + Indicates whether current range has formula number value. Read-only. + + + + + Indicates whether current range has formula value evaluated as string. Read-only. + + + + + Indicates whether the range is blank. Read-only. + + + + + Indicates whether the range has value or style. Read-only. + + + + + Indicates whether range contains bool value. Read-only. + + + + + Indicates whether cell contains DateTime value. Read-only. + + + + + Indicates whether the range contains number. Read-only. + + + + + Indicates whether the range contains string. Read-only. + + + + + Gets rich text. + + + + + Indicates whether cell contains formatted rich text string. + + + + + Checks whether this range is part of merged range. + + + + + Returns a Range object that represents the merged range containing + the specified cell. If the specified cell isn�t in a merged range, + this property returns NULL. Read-only. + + + + + Indicates whether cell is initialized. Read-only. + + + + + Indicates whether range's style differs from default style. + Read-only. + + + + + True if Microsoft Excel wraps the text in the object. + Read/write Boolean. + + + + + Indicates is current range has external formula. Read-only. + + + + + Indicates whether all values in the range are preserved as strings. + + + + + Application object for this object. + + + + + Parent object for this object. + + + + + Application object for this object. + + + + + Returns the range reference in the language of the macro. + Read-only String. + + + + + Return global address (with $ signs) without worksheet name. + + + + + Gets list of all cells. + + + + + Checks if the range represents a single cell or range of cells. Read-only. + + + + + Gets / sets first row of the range. + + + + + Gets / sets first column of the range. + + + + + If it is a single cell, then it returns its name; otherwise returns NULL. Read-only. + + + + + If single cell, returns its name; otherwise returns -1. Read-only. + + + + + Returns type of the cell. Read-only. + + + + + Gets index of extended format. Read-only. + + + + + Sets / gets index of extended format. + + + When method is applied for the range that contains + more than one cell. + + + + + Converts range to rk subrecord. Read-only. + + + When cell does not contain rk record. + + + + + Returns parent workbook. Read-only. + + + + + Returns merge region if range is part of any merge region; otherwise + returns null. Read-only. + + + + + Returns parent worksheet. Read-only. + + + + + Internal record. + + + + + Gets Dictionary where key is ArrayRecord that at least partially intersects + with this range. Read-only. + + + + + Checks if all formula arrays partially contained by this range + are fully contained by this range. Read-only. + + + + + Number of cells in the range. Read-only. + + + + + Returns number format object corresponding to this range. Read-only. + + + + + Gets address global in the format required by Excel 2007. + + + + + Gets a date separator of current culture + + + + + Gets a time separator of current culture + + + + + Read-only. Returns FormatRecord for this range. + + + + + Indicates whether range contains number. Read-only. + + + + + Get / sets type of the format. + + + + + Returns the boolean value if any cell contains string + + + + + Returns extended format for this range. Read-only. + This property should only be used for reading values. + + + + + Returns type code of the underlying record. Read-only. + + + + + Gets / sets cell column. + + + + + Gets / sets cell row. + + + + + Enumeration that contains all possible cell types for the range. + + + + + Indicates that range contains NumberRecord. + + + + + Indicates that range contains RKRecord. + + + + + Indicates that range contains LabelSSTRecord. + + + + + Indicates that range contains BlankRecord. + + + + + Indicates that range contains FormulaRecord. + + + + + Indicates that range contains BoolErrRecord. + + + + + Indicates that range contains RStringRecord. + + + + + Indicates that range contains LabelRecord. + + + + + + + + + + Represents range object for the single cell. Coordinates of such object can be changed. + There should be only one such object for single worksheet. + + + + + Resets row and column values. + + One-based row index of the new cell address. + One-based column index of the new cell address. + + + + + + + + + + + Resets row and column values. + + One-based row index of the new cell address. + One-based column index of the new cell address. + + + + Represents named range in the excel. + + + + + Represents a defined name for a range of cells. Names can be + either built-in names such as Database, Print_Area, and + Auto_Open or custom names. + + + + + Deletes the object. + + + + + Returns or sets the name of the object. Read / write String. + + + + + Gets / sets Range associated with the Name object. + + + + + For the Name object, a string containing the formula that the name is + defined to refer to. The string is in A1-style notation in the language + of the macro, without an equal sign. + + + + + Determines whether the object is visible. Read / write Boolean. + + + + + Indicates whether name is local. + + + + + Gets named range RefersTo. Read-only. + + + + + Returns parent worksheet. Read-only. + + + + + Returns string representation of the name's scope. Read-only. + + + + + Represents default sheet name separator. + + + + + String format for cell range. + + + + + Represents removed sheet index. + + + + + String representation of the workbook scope value. + + + + + Represents valid symbols. + + + + + Name record with info about this Name object. + + + + + Parent workbook for this object. + + + + + Parent worksheet for this object. + (but NameRecord still must be in Workbook). + + + + + Index of the Name object in the Workbook's Names collection. + + + + + Indicates whether the named range is deleted or not. + + + + + + + + + + + + + + + + + + + + Specifies if the name is associated with the Formula. + + + + + Creates a new Name object. + + Application object for the new Name object. + Parent object for the new Name object. + + + + Creates new Name object. + + Application object for the new Name object. + Parent object for the new Name object. + Name of the new Name object. + Current index. + + + + Creates new Name object. + + Application object for the new Name object. + Parent object for the new Name object. + Name of the new Name object. + Current index. + Indicates whether name is local. + + + + Sets index or global depending on IsLocal property value. + + Indicates whether name should be local. + + + + Autofits all columns in the range. + + + + + Returns intersection of this range with the specified one. + + The Range with which to intersect. + Range intersection; if there is no intersection, NULL is returned. + + + + Clear the contents of the Range. + + + + + Removes this Name object from the workbook's Names collection. + + + + + Sets parent workbook and worksheet. + + + When parent workbook or worksheet cannot be found. + + + + + Reads information from the NameRecord. + + NameRecord to parse + + When specified NameRecord is NULL. + + + + + This method is called when Value property was changed. + + Old value of the property. + New value of the property. + Is Value in R1C1 style. + + + + Sets name value. + + Parsed expression value to set. + + + + This method raises NameIndexChanged event. + + Event arguments. + + + + Sets the value. + + New value of the property. + Is Value in R1C1 style. + + + + Converts full row or column tokens between versions. + + Version to convert into. + + + + A string containing the formula that the name is defined to refer to. + + Formula util to take setting from. + Formula string. + + + + Sets index of the named range and raise event. + + New index. + + + + Sets index of the named range. + + New index. + Indicates whether events should be raised. + + + + This method should be called after worksheet index change. + + New sheet index. + + + + Parses named range. + + + + + Gets ptg of current range. + + Returns native ptg. + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Indicates whether the named range is deleted or not. + + + + + Index of the Name object in the workbook's Names collection. + + + + + Name of the Name object. + + + + + Gets / sets Range associated with the Name object. + + + + + For the Name object, a string containing the formula that the name is + defined to refer to. The string is in A1-style notation in the language + of the macro, without an equal sign. + + + + + Gets/sets named range RefersTo. Read-only. + + + + + Determines whether the object is visible. Read/write Boolean. + + + + + Indicates whether current name is locally defined name. Read-only. + + + + + Returns parent worksheet. Read-only. + + + + + Returns string representation of the name's scope. Read-only. + + + + + Returns the range reference in the language of the macro. + Read-only String. + + + + + Returns the range reference for the specified range in the language + of the user. Read-only String. + + + + + Returns range Address in format "'Sheet1'!$A$1". + + + + + Returns range address in format "$A$1". + + + + + Returns the range reference using R1C1 notation. + Read-only String. + + + + + Returns the range reference using R1C1 notation. + Read-only String. + + + + + Gets / sets boolean value that is contained by this range. + + + + + Returns a Borders collection that represents the borders of a style + or a range of cells (including a range defined as part of a + conditional format). + + + + + Returns a Range object that represents the cells in the specified range. + Read-only. + + + + + Returns the number of the first column in the first area in the specified + range. Read-only. + + + + + Column group level. Read-only. + -1 - Not all columns in the range have same group level. + 0 - No grouping, + 1 - 7 - Group level. + + + + + Returns or sets the width of all columns in the specified range. + Read/write Double. + + + + + Returns the number of objects in the collection. Read-only. + + + + + Gets / sets DateTime contained by this cell. Read-write DateTime. + + + + + Returns cell value after number format application. Read-only. + + + + + Returns a Range object that represents the cell at the end of the + region that contains the source range. + + + + + Returns a Range object that represents the entire column (or + columns) that contains the specified range. Read-only. + + + + + Returns a Range object that represents the entire row (or + rows) that contains the specified range. Read-only. + + + + + Gets / sets error value that is contained by this range. + + + + + Returns or sets the object's formula in A1-style notation and in + the language of the macro. Read/write Variant. + + + + + Represents array-entered formula. + + + + + Returns or sets the formula array for the range, using R1C1-style notation. + + + + + True if the formula will be hidden when the worksheet is protected. + False if at least part of formula in the range is not hidden. + + + + + Get / set formula DateTime value contained by this cell. + DateTime.MinValue if not all cells of the range have same DateTime value. + + + + + Returns or sets the formula for the range, using R1C1-style notation. + + + + + Indicates whether specified range object has data validation. + If Range is not single cell, then returns true only if all cells have data validation. Read-only. + + + + + Indicates whether range contains bool value. Read-only. + + + + + Indicates whether range contains DateTime value. Read-only. + + + + + Indicates if current range has formula bool value. Read-only. + + + + + Indicates if current range has formula error value. Read-only. + + + + + Indicates if current range has formula value formatted as DateTime. Read-only. + + + + + True if all cells in the range contain formulas; False if + at least one of the cells in the range doesn't contain a formula. + Read-only Boolean. + + + + + Indicates whether range contains array-entered formula. Read-only. + + + + + Indicates whether the range contains number. Read-only. + + + + + Indicates whether cell contains formatted rich text string. + + + + + Indicates whether the range contains String. Read-only. + + + + + Indicates whether range has default style. False means default style. + Read-only. + + + + + Returns or sets the horizontal alignment for the specified object. + Read/write OfficeHAlign. + + + + + Returns or sets the indent level for the cell or range. Can be an + integer from 0 to 15. Read/write Integer. + + + + + Indicates whether the range is blank. Read-only. + + + + + Indicates whether range contains boolean value. Read-only. + + + + + Indicates whether range contains error value. + + + + + Indicates whether this range is grouped by column. Read-only. + + + + + Indicates whether this range is grouped by row. Read-only. + + + + + Indicates whether cell is initialized. Read-only. + + + + + Returns last column of the range. Read-only. + + + + + Returns last row of the range. Read-only. + + + + + Gets / sets double value of the range. + + + + + Format of current cell. Analog of Style.NumberFormat property. + + + + + Returns the number of the first row of the first area in + the range. Read-only Long. + + + + + Row group level. Read-only. + -1 - Not all rows in the range have same group level. + 0 - No grouping, + 1 - 7 - Group level. + + + + + Returns the height of all the rows in the range specified, + in points. Returns Double.MinValue if the rows in the specified range + aren't all the same height. Read / write Double. + + + + + For a Range object, returns an array of Range objects that represent the + rows in the specified range. + + + + + For a Range object, returns an array of Range objects that represent the + columns in the specified range. + + + + + Returns a Style object that represents the style of the specified + range. Read/write IStyle. + + + + + Returns name of the Style object that represents the style of the specified + range. Read/write String. + + + + + Gets / sets string value of the range. + + + + + Gets / sets time value of the range. + + + + + Returns or sets the value of the specified range. + Read/write Variant. + + + + + Returns or sets the cell value. Read/write Variant. + The only difference between this property and the Value property is + that the Value2 property doesn't use the Currency and Date data types. + + + + + Returns or sets the vertical alignment of the specified object. + Read/write OfficeVAlign. + + + + + Returns a Worksheet object that represents the worksheet + containing the specified range. Read-only. + + + + + Gets / sets string value evaluated by formula. + + + + + Gets / sets number value evaluated by formula. + + + + + Returns the calculated value of the formula as a boolean. + + + + + Returns the calculated value of the formula as a string. + + + + + String with rich text formatting. Read-only. + + + + + Indicates whether this range is part of merged range. Read-only. + + + + + Returns a Range object that represents the merged range containing + the specified cell. If the specified cell isn�t in a merged range, + this property returns NULL. Read-only. + + + + + True if Microsoft Excel wraps the text in the object. + Read/write Boolean. + + + + + Gets / sets cell by row and column index. Row and column indexes are one-based. + + + + + Get cell range. Row and column indexes are one-based. Read-only. + + + + + Get cell range. Read-only. + + + + + Gets cell range. Read-only. + + + + + Indicates is current range has external formula. Read-only. + + + + + Represents ignore error options. If not single cell returs concatenated flags. + + + + + Gets/sets built in style. + + + + + Get NameRecord to which point current object. + + + + + Get worksheet of Name Object. + + + + + Get workbook of Name Object. + + + + + Indicates whether the name is extern name. + + + + + Indicates whether name is built-in or not. + + + + + Indicates whether this is function. + + + + + Gets or sets a value indicating whether this instance is num reference for chart axis. + + + true if this instance is num reference; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is a string reference for chart axis. + + + true if this instance is string reference; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is multi reference for chart axis. + + + true if this instance is multi reference; otherwise, false. + + + + + It's used to identify the common workbook Names + + + + + Utility event. Raised on Name object index property change. + + + + + + + + + + Event arguments for NameIndexChanged event. + + + + + Old index. + + + + + New index. + + + + + Creates new instance of the event arguments. + + Old index. + New index. + + + + This Class allows the user to configure Print settings of a document. + + + + + Represents default print area. + + + + + Represents default print title. + + + + + Represents default print area tokens. + + + + + This record contains information as to whether or not the the row/column headers have to be printed. + + + + + This record defines whether or not to print the gridlines. + + + + + This record specifies if the option to print sheet grid lines + (PrintGridlinesRecord)has ever been changed. + + + + + Contains information about the layout of outline symbols. + + + + + Row height for rows with undefined or inexplicitly defined heights. + + + + + This record stores a 16-bit value with Boolean options for the current sheet. + + + + + Parent worksheet for this page setup. + + + + + Id of the printer settings part. + + + + + Size of the required storage space. Read-only. + + Represents Excel version. + + + + Sets application and parent fields. + + Application object for the page setup. + Parent object for the page setup. + + + + + Find parent worksheet. + + + When can't find parent worksheet. + + + + + Creates necessary records. + + + + + Parses record. + + Record to parse. + True if record was successfully parsed, false otherwise. + + + + Fills internal guts record with information from Rows + and ColumnInfo records. + + + + + Initialize collections. + + + + + Creates copy of the current instance. + + Parent for the new instance. + A clone of the current instance. + + + + Indicates whether fit to page mode is selected. + + + + + Indicates whether summary rows will appear below detail in outlines. + + + + + Indicates whether summary columns will appear right of the detail in outlines. + + + + + Gets / sets default row height. + + + + + Gets / sets default row height option flag. + + + + + Gets / sets relation id to the printer settings part. + + + + + Returns parent worksheet. Read-only. + + + + + + + + + + Gets or sets the old value. + + The old value. + + + + Gets or sets the new value. + + The new value. + + + + Gets or sets the range. + + The range. + + + + Summary description for RangeRichTextString. + + + + + Represents rich text string in the workbook. + + + + + Zero character. + + + + + Low level text object. + + + + + Represents the RTF string + + + + + Parent workbook. + + + + + Indicates whether string is read-only. + + + + + Represents the parent RTF object. + + + + + All digits without zero. + + + + + + + + + + Default font index. + + + + + Initializes new instance of the RichTextString. + + Application object for the RichTextString. + Parent object for the RichTextString. + + + + Initializes new instance of the RichTextString. + + Application object for the RichTextString. + Parent object for the RichTextString. + Indicates whether string is read-only. + + + + Initializes new instance of the RichTextString. + + Application object for the RichTextString. + Parent object for the RichTextString. + Indicates whether string is read-only. + Indicates whether to create inner TextWithFormat. + + + + Initializes new instance of the RichTextString. + + Application object for the RichTextString. + Parent object for the RichTextString. + Indicates whether string is read-only. + Indicates whether to create inner TextWithFormat. + + + + Initializes new instance of the RichTextString. + + Application object for the RichTextString. + Parent object for the RichTextString. + Indicates whether string is read-only. + >Indicates whether to create inner TextWithFormat. + Logger information for AutoShapes + + + + Initializes new instance of the RichTextString. + + Application object for the RichTextString. + Parent object for the RichTextString. + Text to wrap. + + + + Searches for all necessary parent objects. + + + + + Returns font which is applied to character at the specified position. + + Character index. + Font which is applied to character at the specified position. + + + + Returns font which is applied to character at the specified position. + + Character index. + Font which is applied to character at the specified position. + + + + Sets font for range of characters. + + First character of the range. + Last character of the range. + Font to set. + + + + Clears string formatting. + + + + + Appends rich text string with specified text and font. + + Text to append. + Font to use. + + + + Appends the text. + + text to append. + + + + Updates the RTF font. + + + + + Returns font by its index. + + Font index. + Font that corresponds to the specified index. + + + + This method is called before any changes made to the rich text string. + + + + + This method is called after any changes made to the rich text string. + + + + + Copies data from another rich text string. + + String to copy data from. + Dictionary with updated font indexes. + + + + Parse rich text string. + + TextWithFormat to parse. + Dictionary with updated font indexes. + Parse options. + + + + Creates a copy of the current object. + + Parent object for the new object. + A copy of the current object. + + + + Clears string and formatting. + + + + + Adds font to all required collections.. + + Font to add. + Font index in the collection. + + + + Sets internal text object that stores rtf string. + + New value for the text object. + + + + Returns font which is applied to character at the specified position. + + Character index. + Font which is applied to character at the specified position. + + + + Returns size of the string part. + + Start position. + End position. + Size of the string part. + + + + Generates text in rtf format. + + Generated text. + + + + Writes formatting run with corresponding text into writer. + + Writer to write text and formatting into. + Index of the formatting run. + First character in the text range. + End position of the text range. + + + + Adds all used fonts to the rtf text writer. + + RtfTextWriter to write into. + + + + Adds single font to the fonts table. + + Font to add. + RtfTextWriter to write into. + + + + Writes text into RtfTextWriter. + + RtfTextWriter to write into. + Font index. + Text value. + + + + Gets / sets text of the string. + + + + + Returns text in rtf format. Read-only. + + + + + Indicates whether rich text string has formatting runs. Read-only. + + + + + Returns parent object. Read-only. + + + + + Returns parent application object. Read-only. + + + + + Returns size of the string. Read-only. + + + + + Returns default font. Read-only. + + + + + Returns text object. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + Gets / sets default font index. + + + + + Gets or sets the image RTF. + + The image RTF. + + + + Interface for Rich text string wrapper. + + + + + Parent worksheet. + + + + + Cell index. + + + + + + + + + + + + + + + + + + Cell index. + + + + + + + + Cell index. + Formatted text object. + + + + This method is called before any changes made to the rich text string. + + + + + This method is called after any changes made to the rich text string. + + + + + Performs application-defined tasks associated with freeing, + releasing, or resetting unmanaged resources. + + + + + Returns default font. Read-only. + + + + + Returns index of the string. + + + + + + + + + + Parent range. + + + + + Represents an RTF string. + + + + + Creates new instance of the RTFStringArray. + + Parent range. + + + + Returns font which is applied to character at the specified position. + + Character index. + Font which is applied to character at the specified position. + + + + Sets font for range of characters. + + First character of the range. + Last character of the range. + Font to set. + + + + Clears string formatting. + + + + + Appends rich text string with specified text and font. + + Text to append. + Font to use. + + + + + + + + + + + + + + Performs application-defined tasks associated with freeing, + releasing, or resetting unmanaged resources. + + + + + + + + + + Gets / sets text of the string. + + + + + Returns text in rtf format. Read-only. + + + + + Indicates whether rich text string has formatting runs. Read-only. + + + + + Application object for this object. + + + + + Parent object for this object. + + + + + + + + + + Maximum number of rectangles after split. + + + + + Cell ranges list. + + + + + Default constructor. + + + + + Creates new instance of current class. + + Cell ranges list. + + + + Indicates whether collection contains all specified ranges. + + Ranges to check. + True if collection contains all specified ranges. + + + + Indicates whether collection contains all specified ranges. + + Ranges to check. + Start index in the internal ranges collection to search from. + True if collection contains all specified ranges. + + + + Indicates whether collection contains all specified ranges. + + Ranges to check. + Start index in the internal ranges collection to search from. + True if collection contains all specified ranges. + + + + Indicates whether collection contains specified range. + + Range to check. + Start index in the internal ranges collection to search from. + True if collection contains specified range. + + + + Adds cells from the collection. + + Cells to add to the collection. + + + + Adds new cell range to the collection. + + Range to add. + + + + Clears internal list. + + + + + Checks whether ranges can be merged. + + Range to add to. + Range to add. + True if operation succeeded. + + + + Removes range from the collection of conditional formats. + + Array of ranges to remove. + + + + Removes rectangle from the collection. + + Rectangle to remove. + Index after last element that should be checked. + + + + Splits rectangle into several parts after remove specified rectangle. + + Rectangle to split. + Rectangle to remove. + List with splitted rectangle. + + + + Gets / sets list of the cells. + + + + + This class contains stores true/false/undefined values for ranges. + + + + + Object that contains ranges with value equal to true. + + + + + Object that contains ranges with value equal to false. + + + + + Returns value for the range object. + + Range to get information about. + Value for the range. + + + + Sets property value for the range. + + Range to set value for. + Value to set. + + + + Clears all ranges. + + + + + Stores created Biff records and allows to get specific record. + + + + + Dictionary with Biff records. Key - Biff record type value. + + + + + Initializes new instance. + + + + + Returns Biff record filled with speciffic values. + + Object that provides access to the data. + Offset to the record's start. + Excel version used for infill. + Extracted record. + + + + Returns empty Biff record. + + Biff record type. + Extracted record. + + + + Class wich reads Rich Text. + + + + + Represents the font characterset. + + + + + Represents the string seperator. + + + + + Represents the control word start. + + + + + Represents the para end without the properties. + + + + + Represents the font index. + + + + + Font size in half-points (the default is 24). + + + + + Represents font bold attribute + + + + + Represents font italic attribute + + + + + Represents the tab character. + + + + + Represents the Foreground color (default is 0). + + + + + Represents the para end with properties. + + + + + Represents the para end with properties. + + + + + Represents the para end with properties. + + + + + Continuous underline. \ul0 turns off all underlining. + + + + + Continuous underline with italics font attribute + + + + + Stops underlining. + + + + + Represents the text strike through. + + + + + Subscripts text and shrinks point size according to font information. + + + + + Turns off superscripting or subscripting. + + + + + Superscripts text and shrinks point size according to font information. + + + + + Marks a destination whose text should be ignored. + + + + + Represents the Red color. + + + + + Represents the Green color. + + + + + Represents the blue color. + + + + + Represents paragraph center + + + + + Represents paragraph justify + + + + + Represents paragraph left + + + + + Represents paragraph right + + + + + Represents language + + + + + Represents open curly braces + + + + + Represents close curly braces + + + + + Represents single quotation + + + + + Represents unicode character + + + + + Represents Default Code Page + + + + + Represents the Application. + + + + + Dictionary of Colors table. + + + + + Entire Rtf Text. + + + + + Represents the font Dictionary. + + + + + Index of the RTF Text. + + + + + Represents the workbook. + + + + + Represents the current Font Index. + + + + + Represents the Rtf Text. + + + + + Represents the WorksheetImpl. + + + + + Represents the Range to store the RTF Text. + + + + + Represents the RichTextString class Object. + + + + + Represents the Index of RTF string. + + + + + Intializes the RichTextReader Members. + + sheet. + + + + Finds the color. + + Color of the find. + + + + + Parses this instance. + + + + + Parses the color table. + + + + + Parses the content. + + + + + Parses the control word. + + + + + Appends RTF string + + RTF string + + + + Appends extended characters to rtf string + + String Array + + + + Parses the font table. + + + + + Parses the number. + + The num text. + + + + + Sets the RTF. + + The text. + + + + Creates rich text string. + + + + + Parses Accented character + + + + + + + + Seperate Token keyword from the token Value + + + + + + + Determines whether current code page is single byte encoding. + + + true if [is single byte]; otherwise, false. + + + + + Get the code page for the current Font character set + + + + + + Determine Whether the code page is supported for Encoding + + + + + + + Get the code page is supported for Encoding + + + + + + + Get's or set's the Default code page of the document + + + + + Class used for optimized row height evaluation. + + + + + List with height of the rows. + + + + + Method used to get size of the measured items. + + + + + Initializes new instance of the class. + + Delegate used to get size of the items. + + + + Returns height of all rows starting from the first one and finishing specified row. + + One-based row index. + Sum of height of all rows till rowIndex (included). + + + + Gets size starting from rowStart and ending rowEnd (both included). + + Index of the first item to measure. + Index of the last item to measure. + Total size starting from rowStart and ending rowEnd (both included). + + + + Evaluates size of the specified item. + + Item's index. + Size of the specified item. + + + + Delegate used to get size of the single object by its index. + + Item's index to get size for. + Size of the specified item. + + + + Rtf text writer used for converting rtf string into rtf format. + + + + + 0 - font index, + 1 - charset, + 2 - font name. + + + + + Font attribute. + + + + + 0 - red component (0-255), + 1 - green, + 2 - blue. + + + + + Underline tags. + + + + + Strike through tags. + + + + + Other tags. + + + + + Array list with all used colors. + + + + + Fonts dictionary. Font - to - font index. + + + + + Colors dictionary. Color - to - color index. + + + + + Indicates whether formatting is enabled. + + + + + Inner text writer. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the image RTF. + + The RTF. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns string that implement current object. + + Returns string that implement current object. + + + + Writes a character to the text stream. + + Char value to write. + + + + Writes a string to the text stream. + + String to write. + + + + Adds new font to the collection. + + Font to add. + Index of the font. + + + + Adds color to the colors table. + + + + + + + Writes fonts table into inner text writer. + + + + + Writes colors table into inner text writer. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns current Encoding. + + + + + \ul Continuous underline. \ul0 turns off all underlining. + \ulcN Underline color + \uld Dotted underline. + \uldash Dash underline. + \uldashd Dash dot underline. + \uldashdd Dash dot dot underline. + \uldb Double underline. + \ulhwave Heavy wave underline + \ulldash Long dash underline + \ulnone Stops all underlining. + \ulth Thick underline + \ulthd Thick dotted underline + \ulthdash Thick dash underline + \ulthdashd Thick dash dot underline + \ulthdashdd Thick dash dot dot underline + \ulthldash Thick long dash underline + \ululdbwave Double wave underline + \ulw Word underline. + \ulwave Wave underline. + + Elements order is very important. + + + + + Continuous underline. + + + + + Turns off all underlining. + + + + + Dotted underline. + + + + + Dash underline. + + + + + Dash dot underline. + + + + + Dash dot dot underline. + + + + + Double underline. + + + + + Heavy wave underline. + + + + + Long dash underline. + + + + + Stops all underlining. + + + + + Thick underline. + + + + + Thick dotted underline. + + + + + Thick dash underline. + + + + + Thick dash dot underline. + + + + + Thick dash dot dot underline. + + + + + Thick long dash underline. + + + + + Double wave underline. + + + + + Word underline. + + + + + Wave underline. + + + + + Elements order is very important. + + + + + Single is on. + + + + + Single is off. + + + + + Double is on. + + + + + Double is off. + + + + + Elements order is very important. + + + + + Font table begins. + + + + + Font table ends. + + + + + Color table starts. + + + + + Color table ends. + + + + + Bold on. + + + + + Bold off. + + + + + Italic on. + + + + + Italic off. + + + + + Rtf begins. + + + + + Rtf ends. + + + + + Group starts. + + + + + Group ends. + + + + + End of line. + + + + + Foreground color. + + + + + Background color. + + + + + Subscript. + + + + + SuperScribt. + + + + + The Shadow record defines the Shadow properties and + the 3D features(bevel top and bevel bottom),Lignting and + Material properties + + + + + NoShadow=0 + OffsetRight=1 + OffsetDiagonalBottomRight=2 + OffsetBottom=3 + OffsetDiagonalTopLeft=4 + OffsetCenter=5 + OffsetTop=6 + OffsetLeft=7 + OffsetDiagonalTopRight=8 + OffsetDiagonalBottomLeft=9 + + + + + NoShadow=0 + InsideDiagonalBottomLeft=1 + InsideTop=2 + InsideRight=3 + InsideLeft=4 + InsideDiagonalTopRight=5 + InsideDiagonalBottomRight=6 + InsideCenter=7 + InsideBottom=8 + InsideDiagonalTopLeft=9 + + + + + NoShadow=0, + PrespectiveDiagonalUpperRight=1, + PrespectiveDiagonalLowerRight=2, + PrespectiveDiagonalUpperLeft=3, + PrespectiveDiagonalLowerLeft=4, + Below=5 + + + + + NoAngle=0, + Angle=1, + ArtDeco=2, + Circle=3, + Convex=4, + CoolSlant=5, + Cross=6, + Divot=7, + HardEdge=8, + RelaxedInset=9, + Riblet=10, + Slope=11, + SoftRound=12 + + + + + NoEffect=0, + Matte=1, + WarmMatte=2, + Plastic=3, + Metal=4, + DarkEdge=5, + SoftEdge=6, + Flat=7, + WireFrame=8, + Powder=9, + TranslucentPowder=10, + Clear=11 + + + + + ThreePoint=0, + Balance=1, + BrightRoom=2, + Chilly=3, + Contrasting=4, + Flat=5, + Flood=6, + Freezing=7, + Glow=8, + Harsh=9, + Morning=10, + Soft=11, + Sunrise=12, + SunSet=13, + TwoPoint=14 + + + + + Gets or sets the shadow outer presets. + + The shadow outer presets. + + + + Gets or sets the shadow inner presets. + + The shadow inner presets. + + + + Gets or sets the shadow prespective presets. + + The shadow prespective presets. + + + + Gets or sets the material. + + The material. + + + + Gets or sets the lighting. + + The lighting. + + + + Gets or sets the bevel top. + + The bevel top. + + + + Gets or sets the bevel bottom. + + The bevel bottom. + + + + Represents chart shadow object + + + + + Represents the shadow formatting properties of the chart. + + + + + Customize the outer shadow styles. + + The Office2007ChartPresetsOuter enumeration. + Transparency of the Shadow accepts the values between(0-100). + Size of the Shadow accepts the values between(0-200). + Blur level of the Shadow accepts the values between(0-100). + Angle or Direction of the Shadow accepts the values between(0-359). + Distance of the Shadow accepts the values between(0-200). + if set to true [custom shadow style]. + + + + Customize the inner shadow styles. + + The Office2007ChartPresetsInner enumeration. + Transparency of the Shadow accepts the values between(0-100). + Blur level of the Shadow accepts the values between(0-100). + Angle or Direction of the Shadow accepts the values between(0-359). + Distance of the Shadow accepts the values between(0-200). + if set to true [custom shadow style]. + + + + Customize the perspective shadow styles. + + The Excel2007ChartPresetsPerspective enumeration. + Transparency of the Shadow accepts the values between(0-100). + Size of the Shadow accepts the values between(0-200). + Blur level of the Shadow accepts the values between(0-100). + Angle or Direction of the Shadow accepts the values between(0-359). + Distance of the Shadow accepts the values between(0-200). + if set to true [i custom shadow style]. + + + + Gets or sets the shadow outer presets. + + The shadow outer presets. + + + + Gets or sets the shadow inner presets. + + The shadow inner presets. + + + + Gets or sets the shadow perspective presets. + + The shadow perspective presets. + + + + Gets or sets a value indicating whether this instance has custom shadow style. + + + True if this instance has custom shadow style; otherwise, False. + + + + + Gets or sets the transparency of Shadow. + + The transparency. + + + + Gets or sets the size of the Shadow. + + The size. + + + + Gets or sets the blur of the Shadow. + + The blur. + + + + Gets or sets the angle of the Shadow. + + The angle. + + + + Gets or sets the distance of the Shadow. + + The distance. + + + + Gets or sets the color of the shadow. + + The color of the shadow. + + + + Class used for Shadowformat Implementation + + + + + Object of WorkbookImpl + + + + + Indicates whether customshadowstyle is set or not + + + + + Represents the Transparency of the Shadow,the values are between(0-100) + + + + + Represents the Size of the Shadow,the values are between(0-200) + + + + + Represents the Blurradius of the Shadow,the values are between(0-100) + + + + + Object of ChartMarkerFormatRecord to get Shadow color + + + + + Represents the Direction of the Shadow,the values are between(0-359) + + + + + Represents the Distance of the Shadow,the values are between(0-200) + + + + + Represents the Shadow Color + + + + + + Creates the shadow and sets its Application and Parent + properties to specified values. + + Application object for the shadow. + Parent object for the shadow. + + + + Initializes the colors. + + + + + Shadows the color changed. + + + + + Searches for all necessary parent objects. + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + + A new object that is a copy of this instance. + + + + + Clone current Record. + + Parent object. + Returns clone of current object. + + + + Customize the outer shadow styles. + + + + + + + + + + + Customize the inner shadow styles. + + + + + + + + + + Customize the perspective shadow styles. + + + + + + + + + + + Gets the shadow format. + + The shadow format. + + + + Gets or sets the shadow outer presets. + + The shadow outer presets. + + + + Gets or sets the shadow inner presets. + + The shadow inner presets. + + + + Gets or sets a value indicating whether this instance has custom shadow style. + + + true if this instance has custom shadow style; otherwise, false. + + + + + Gets or sets the shadow prespective presets. + + The shadow prespective presets. + + + + Gets or sets the transparency of Shadow. + + The transparency. + + + + Gets / sets color of this shadow. + + + + + Gets or sets the size of Shadow. + + The size. + + + + Gets or sets the blur of Shadow. + + The blur. + + + + Gets or sets the angle of Shadow. + + The angle. + + + + Gets or sets the distance of Shadow. + + The distance. + + + + Class used for Bitmap shape implementation. + + + + + Class used for Shape Implementation. + + + + + Represents a shape. + + + + + Removes this shape from shapes collection. + + + + + Scales the shape. + + Width scale in percents. + Height scale in percents. + + + + Height of the shape. + + + + + Shape id. + + + + + Left position of the shape. + + + + + Name of the shape. + + + + + Top position of the shape. + + + + + Width of the shape. + + + + + Shape type. + + + + + Indicates whether shape is visible. + + + + + Alternative text. + + + + + Indicates whether shape must be moved with cells. + + + + + Indicates whether shape must be sized with cells. + + + + + Represents fill properties. Read-only. + + + + + Represents line format properties. Read-only. + + + + + Gets or sets macro associated with this shape + + + + + Returns or sets the rotation of the shape, in degrees. + + + + + Returns a TextFrame object that contains the + alignment and anchoring properties for the specified shape. Read-only. + + + + + Represents alpha constant, that represents index in ExcelKnownColors structures. + + + + + Value of SizeTextToFitShape option when it is set to false. + + + + + Value of SizeTextToFitShape option when it is set to true. + + + + + Value of NoFillHitTest option. + + + + + Offset for full column. + + + + + Offset for full row. + + + + + Represents default line weight. + + + + + Represents default transparency mull. + + + + + Represents default transparency mull multiplied by 100. + + + + + Represents default line weight mull. + + + + + Represents maximum shape width and height in pixel. + + + + + Represents minimum shape width and height in pixel. + + + + + Default foreground color. + + + + + Default background color. + + + + + Represents default parent types. + + + + + Fill options. + + + + + Represent the shape start x position inside the chart. + + + + + Represent the shape start y position inside the chart. + + + + + Represent the shape to width inside the chart. + + + + + Represent the shape to height inside the chart. + + + + + Represent the shape to x position inside the chart. + + + + + Represent the shape to y position inside the chart. + + + + + Represent the shape X position inside the chart. + + + + + Represent the shape Y position inside the chart. + + + + + Represent the shape width inside the chart. + + + + + Represent the shape height inside the chart. + + + + + Indicates if this shape support shape color-line options. + + + + + Indicate if comments is valid or not + + + + + Indicate if left value is set. + + + + + Name of the shape. + + + + + Name of assigned Macro Name + + + + + Alternative text. + + + + + Shape's record. + + + + + Parent workbook for the shape. + + + + + Type of the shape. + + + + + Shape record. + + + + + Client anchor record. + + + + + Preset Geometry element specifies when a preset geometric shape should be used instead of a custom geometric shape. + + + + + Parent shapes collection. + + + + + OBJ record. + + + + + Shape's options. + + + + + Absolute coordinates of the shape in pixels. + + + + + Represents fill properties. + + + + + Represents shape line format. + + + + + Indicates is parse or serialize Line fill properties. + + + + + This object contains not parsed xml data. + + + + + This object contains not parsed type stream data. + + + + + Preserved relation to the image. + + + + + Preserved relation id. + + + + + Indicates whether we have to update absolute positions after setting TopRow, + BottomRow, LeftColumn, RightColumn. + + + + + Indicates whether shape is vml shape or not. + + + + + Id of this shape. + + + + + Macrolink of this shape + + + + + Tokens containing reference to the associated macro. + + + + + Visibility of the shape. + + + + + Represents Shadow + + + + + Represents the 3D features + + + + + Represens the Child Shapes in the Group. + + + + + Child Client anchor record. + + + + + Unknown record. + + + + + Preserves the Style properties. + + + + + Preserves the Style properties as string value. + + + + + FormulaMacro maintain as stream + + + + + Indicates the whether the shape has the borders. + + + + + Stream to preserve the Slicers graphic frame + + + + + Anchor type + + + + + Stream to preserve the ExtLst of picture. + + + + + Dictionary to have preserved streams of shape properties + + + + + Indicates whether custom geometry will be used for this shape. + + + + + + + Represents the group frame of the shape. + + + + + Indicates whether the group shape contains fill. + + + + + Indicates whether the group shape contains line. + + + + + Indicates whether the shape is slicer shape or not. + + + + + Indicates whether extent tag is present or not. + + + + + Serialize FOPTE structure. + + Parent collection. + Structure id to serialize. + Array of byte - main byte of structure. + + + + Serialize FOPTE structure. + + Parent collection. + Structure id to serialize. + Array of byte - main byte of structure. + Represents additional data. + Represents if valid + + + + Serialize FOPTE structure. + + Parent collection. + Structure id to serialize. + Represents UInt value of structure. + + + + Serialize FOPTE structure. + + Parent collection. + Structure id to serialize. + Represents int value of structure. + Represents additional data. + Represents if valid + + + + Indicates whether text frame should be autosized. + + + + + Initializes new instance of the shape. + + Application object for the new shape. + Parent object for the new shape. + + + + Initializes new instance of the shape. + + Application object for the new shape. + Parent object for the new shape. + Current object to clone. + + + + Initializes new instance of the shape. + + Application object for the new shape. + Parent object for the new shape. + Shape container record that describes the new shape. + Parse options. + + + + Initializes new instance of the shape. + + Application object for the new shape. + Parent object for the new shape. + Record that describes the new shape. + + + + Initializes new instance of the shape. + + Application object for the new shape. + Parent object for the new shape. + Record that describes the new shape. + Parse options. + + + + Creates default fill and line formatting options. + + + + + Parses shape container record. + + Parse options. + + + + Parses client data record. + + Record to parse. + Parse options. + + + + Parses all unknown records (should be overridden in child classes). + + Record to parse. + Parse options. + + + + Parses options. + + Options to parse. + + + + Parses fill options. + + Represents single fill option + Returns true if parsed correctly. + + + + Parses option record. + + Record to parse. + Value indicating fill option. + + + + Parses shape record. + + Record to parse. + + + + Parses client anchor record. + + Record to parse. + + + + Searches for all necessary parent objects. + + + + + Change the parent for the shape. + + + + + Raises events. + + + + + Suppress events. + + + + + Parses shape group record. + + Record to parse. + + + + Parses shape group container. + + Container to parse. + + + + Parses child anchor record. + + Record to parse. + + + + Parses Unknown record. + + Record to parse. + + + + Converts option value to color. + + Option to convert. + Corresponding color value. + + + + Gets single byte by index for forte structure. + + Represents current FORTE structure. + Byte index. + Returns single byte by index. + + + + Extracts shape name from option. + + Option that contains shape name. + Name extracted. + + + + Extracts all necessary option. + + Represents option holder. + + + + Extract necessary option. + + Option to extract. + Value indicating extracted option. + + + + Removes this shape from the collection. + + + + + Scales the shape. + + Width scale in percent. + Height scale in percent. + + + + Detaches events and disposes current object. + + + + + Serializes shape into shape group container. + + Shape group container that will receive shape data. + + + + Serializes shape record (MsofbtSp) into shape group container. + + Shape group container that will receive shape data. + + + + Serializes SizeTextToFitShape option. + + MsofbtOPT record to which text ID will be added. + + If options argument is NULL. + + + + + Serializes HitTest option. + + MsofbtOPT record to which text ID will be added. + + If options argument is NULL. + + + + + Serialize shape's options. + + Options record. + Option ID. + Option value. + + + + Serialize shape's options. + + Options record. + Option ID. + Option value. + Record with option. + + + + Serialize shape's options sorted by option id. + + Options record. + Option ID. + Option value. + + + + Serializes shape visibility. + + Option holder. + + + + Serializes shape name. + + Option holder. + + + + Serializes shape name. + + Options object to store name in. + Option id to store name in. + Name to serialize. + + + + Create default shape options. + + Record with option. + + + + Gets border thickness + + + + + + Get border color + + Color + + + + Get fill color. + + Color + + + + Gets the default fill color for the shape from style. + + Preserved flag to be checked. + Xml tag to create reader. + Shape for which fill color should be obtained. + color + + + + Get color from style element. + + AutoshapeImpl + Preserved flag to be checked. + Stream tage name + xml tag to the create reader + Fill or border color. + + + + Check whether color is empty or not. + + RGB Color object to check. + Returns true if color is empty. + + + + Generates default shape name and sets it. + + + + + This method is called when removing shapes from the collection. + + + + + Sets object with value. + + Value to be set. + + + + Creates a clone of the current shape and adds it to the parent shapes collection. + + New parent for the shape object. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Indicates whether we should add created + shape into all necessary parent collections. + A copy of the current shape. + + + + Creates a clone of the current shape. + + New parent for the shape object. + A copy of the current shape. + + + + Copies settings from another shape object. + + Shape to copy settings from. + Dictionary with new worksheet names. + Dictionary with new font indexes. + + + + Checks whether it is possible insert row or column into iIndex. + + Index of row or column to insert. + Number of rows or columns to insert. + Indicates whether rows or columns are inserted. + Maximum possible index. + True if it is possible to insert row or column. + + + + Returns lower bound of the shape. + + Indicates whether lower row or lower column must be returned. + Lower bound of the shape. + + + + Returns upper bound of the shape. + + Indicates whether upper row or upper column must be returned. + Upper bound of the shape. + + + + Removes row or column. + + Index of row or column to remove. + Number of rows or columns to remove. + Indicates whether rows or columns are removed. + + + + This method should be called after rows or columns were inserted. + + Index of row or column to insert. + Number of rows or columns to insert. + Indicates whether rows or columns are inserted. + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + Sets shape name without updating parent shapes collection. + + Name to set. + + + + Registers shape in all required sub collections. + + + + + Copy comments options. + + Represents source shape. + Represents dictionary with font indexes. + + + + Sets instance value for the shape. + + Instance to set. + + + + Sets option with value. + + Represents shape option. + Represents value to be set. + + + + Updates indexes to named ranges. + + New indexes. + + + + Updates left column and offset values correspondingly + to X-coordinate changes. + + + + + Clears the Shape Offsets. + + Clears the offset if True. + + + + Update right column + + + + + + Updates right column and offset values correspondingly + to left column or offset or width changes. + + + + + Updates top row and offset values correspondingly + to Y-coordinate changes. + + + + + Updates bottom row of the shape. + + + + + Updates width of the shape. + + + + + Updates Height of the shape. + + + + + Converts offset value into pixels. + + Width of row or column. + Offset in row or column. + Indicates whether it is column offset. + Offset value in pixels. + + + + Converts offset value into pixels. + + Width or Height. + Offset in row or column. + Indicates whether it is column offset. + Offset value in pixels. + + + + Converts pixels into offset value. + + Index to the current row or column. + Size in pixels. + Indicates whether iCurRowColumn is column index should. + Size of the row / column in pixels. + + + + Converts pixels into offset value. + + Index to the current row or column. + Size in pixels. + Indicates whether iCurRowColumn is column index should. + Size of the row / column in pixels. + + + + Returns width of the area. + + Column index. + Column offset. + Second column index. + Offset in the second column. + Indicates whether offsets are in pixels. + Width in pixels of the specified area. + + + + Returns height of the specified area. + + The first row. + Offset in the first row. + The second row. + Offset in the second row. + Indicates whether offsets are in pixels. + Height in pixels of the specified area. + + + + Converts width offset into pixels and checks if it is out of range. + + Width of the target column. + Offset in the target column. + + Indicates whether offset is in pixels (True) or in the units + relative to width of the column (False). + + Offset in pixels. + + If resulting offset is more that column width. + + + + + Converts width offset into pixels and checks if it is out of range. + + Height of the target row. + Offset in the target row. + + Indicates whether offset is in pixels (True) or in the units + relative to height of the row (False). + + Offset in pixels. + + If resulting offset is more than row height. + + + + + Converts pixels into column width offset. + + Represents pixel. + Width of the target column. + Value in column width. + + + + Converts pixels into height offset. + + Pixels to convert. + Represents target row height. + Offset in terms of Row height. + + + + Evaluates top left position of the shape. + + + + + Evaluates left position. + + + + + Evaluates Right Position. + + + + + Evaluates top position. + + + + + Sets client anchor record. + + Represents anchor. + + + + This method is called when left column was changed. + + + + + This method is called when top row was changed. + + + + + Indicates whether specified row / column index is before shape. + + Row / column index. + Indicates whether it is row or column index. + True if specified row / column index is before shape. + + + + Indicates whether specified row / column index is in the middle of the shape. + + Row / column index. + Indicates whether it is row or column index. + True if specified row / column index is before shape. + + + + Indicates whether it is last row or column index + + Row / column index. + Indicates whether it is row or column index. + Value indicating whether it is last row or column index. + + + + Increases and updates both begin and end of the shape. + + Number of inserted rows / columns. + Indicates whether rows where inserted. + + + + Increases and updates end of the shape. + + Number of inserted rows / columns. + Indicates whether rows where inserted. + + + + Gets count of rows \ columns that is above shape. + + Represents start index. + Represents count of rows \ columns. + Indicates is in row. + Returns count of rows \ columns above shape. + + + + Gets count of rows inside. + + Represents first index. + Represents count. + Indicates is row or column. + Returns count of inside. + + + + Indicates is when remove or insert use top\left row\column. + + Represents start index of remove \ insert. + Represents count. + Indicates is in row. + If true - use first row\column; otherwise - false. + + + + Updates row \ column indexes. + + Count to update. + Indicates is update row indexes or column. + + + + Updates first row/column indexes. + + Indicates is in row. + Represents count. + + + + Updates shape that include not size and not move flags. + + Indicates is row or column to update. + Row or column index. + Number of inserted/removed rows/column. + + + + Updates inside row/column indexes. + + Represents count. + Indicates is in row. + + + + Updates last row\column indexes. + + Indicates is row or column. + + + + Updates record. + + Represents client anchor. + + + + Parses line and fill objects. + + Options holder. + + + + Updates mso object. + + Represents mso object to update. + Returns true if updated otherwise - false. + + + + Clones line and fill objects. + + Shape to be cloned. + + + + Column width change event. + + Represents sender object + Represents value changed event. + + + + Leaves bottom right corner of the shape. + + + + + This method should be called after any change in font of "Normal" style. + + Event sender. + Event arguments. + + + + This method should be called after row height changes. + + Event sender. + Event arguments. + + + + Checks the Left Offset. + + + + + Update GroupFrame for the shape.. + + Event sender. + Event arguments. + + + + Update GroupFrame for the shape.. + + Event sender. + Event arguments. + + + + Update the GroupFrame position. + + left position of the group frame + top position of the group frame + width position of the group frame + height position of the group frame + + + + Get the updated child shape positions. + + Group shape rectangle. + The group shape rotation. + The child shape rectangle to be updated. + The updated child shape rectangle. + + + + Get Shape Rotations. + + Group Shape. + Flip count. + + + + Get the updated the rectangle from the Matrix. + + Group Shape. + The shape rectangle. + The updated rectangle. + + + + Creates the from points array. + + The points. + The rectangle. + + + + Gets the transformation matrix for the AutoShape. + + Rectangle bounds of the AutoShape. + Rotation angle to be applied. + Horizontal flip. + Vertical flip. + Transformed matrix value in which shape will be rendered. + + + + Gets the transformation matrix for the AutoShape. + + Rectangle bounds of the AutoShape. + Rotation angle to be applied. + Horizontal flip. + Vertical flip. + Transformed matrix value in which shape will be rendered. + + + + Update the shape bounds based on ShapeRotation. + + Current Rectangle bound values of the AutoShape. + Rotation angle of the shape. + Updated Rectangle bounds of the AutoShape. + + + + Set postions for the shape. + + X-coordinate. + Y-coordinate. + Extenstion Width. + Extenstion Height. + + + + Set Left postion for the shape. + + double value to set. + + + + Set Top postion for the shape. + + double value to set. + + + + Set Height for the shape. + + double value to set. + + + + Set Height for the shape. + + double value to set. + + + + Set the group shape property value to all the inner shapes. + + Property value to set. + Property name. + + + + Gets or sets the height of the shape. + + + + + Gets or sets the height of the shape. + + + + + Gets Shape ID. + + + + + Gets the chart3 D properties. + + The chart3 D properties. + + + + Gets or sets the value indicating if comment has proper row column values + + + + + Gets the shadow properties. + + The shadow properties. + + + + Gets or sets the value indicating if Left value is set. + + + + + Gets or sets the value of the shape has extent tag or not + + + + + Gets or set x coordinate of upper left corner of shape. + + + + + Gets or set x coordinate of upper left corner of shape. + + + + + Gets or sets name of the shape. + + + + + Gets or sets the Y coordinate of the shape + + + + + Gets or sets the Y coordinate of the shape + + + + + Gets or sets width of the shape. + + + + + Gets or sets width of the shape. + + + + + Gets or sets shape type + + + + + Gets or set a value indicating whether shape is visible + + + + + Gets or sets alternative text of the shape + + + + + Gets or set a value indicating whether shape can move with cell + + + + + Gets or sets a value indicating whether shape can size with cell. + + + + + Represents fill properties. Read-only. + + + + + Represents line format properties. Read-only. + + + + + Preset Geometry element specifies when a preset geometric shape should be used instead of a custom geometric shape. + + + + + Gets or sets the macro name. + + + + + True if the size of the specified object is changed automatically + to fit text within its boundaries. Read/write Boolean. + + + + + Gets / sets xml data stream. + + + + + Gets or sets xml type stream. + + + + + Indicates whether this is vml shape or not. + + + + + Gets or sets macro-command that is called when action happens. + + + + + Gets or sets the Image relation id + + + + + Gets or sets the image relation + + + + + Returns or sets the rotation of the shape, in degrees. + + + + + + Returns a TextFrame object that contains the + alignment and anchoring properties for the specified shape. Read-only. + + + + + FormulaMacro Stream + + + + + Preserve the style as stream for further processing. + + + + + Gets and sets the shape x position inside the chart. + + + + + Gets and sets the shape y position inside the chart. + + + + + Gets and sets the shape width inside the chart. + + + + + Gets and sets the shape height inside the chart. + + + + + Gets and sets shape start x position inside the chart. + + + + + Gets and sets shape start y position inside the chart. + + + + + Get and sets shape ToWidth inside the chart. + + + + + Get and sets shape ToHeight inside the chart. + + + + + Gets and sets shape to x position inside the chart. + + + + + Get and sets shape to y position inside the chart. + + + + + Stream to preserve the Slicers graphic frame + + + + + Indicates the whether the shape has the borders. + + + + + Parent workbook. Read-only. + + + + + Parent workbook. Read-only. + + + + + Parent shapes collection. Read-only. + + + + + Parent worksheet. Read-only. + + + + + OBJ record. Read-only. + + + + + Client anchor. Read-only. + + + + + Top row for the shape. + + + + + Left column for the shape. + + + + + Bottom row for the shape. + + + + + Right column for the shape. + + + + + Top row offset for the shape. + + + + + Left column offset for the shape. + + + + + Bottom row offset for the shape. + + + + + Right column offset for the shape. + + + + + Gets or sets object id. + + + + + Returns internal shapes record. Read-only. + + + + + Returns inner sp record. Read-only. + + + + + Indicates whether it is short version of the shape + (without obj and maybe some other properties). + + + + + Returns number of shapes contained by this shape (1 means no sub shapes). Read-only. + + + + + Indicates whether we have to update absolute positions after setting TopRow, + BottomRow, LeftColumn, RightColumn. + + + + + Returns instance value. Read-only. + + + + + Indicates whether fill item was created. Read-only. + + + + + Indicates whether the group shape contains fill. + + + + + Indicates whether the group shape contains line. + + + + + Indicates whether line item was created. Read-only. + + + + + Gets / sets shape id. + + + + + Returns internal shape record, creates new one if necessary. Read-only. + + + + + Preserves the Shape style properties as string value. + + + + + We find the anchor type. + + + + + gets and sets the extlst of the picture,which intends to get preserved. + + + + + Represents whether the shape is slicer or not. + + + + + Represents the parent group shape. + + + + + Indicates whether the shape is group shape. + + + + + Gets stream of preserved elements in shape properties + + + + + Indicates whether custom geometry will be used for this shape. + + + + + Represents the shape frame of the shape. + + + + + Represents the group frame of the shape. + + + + + Gets shape options. + + + + + Represens the Child Shapes in the Group. + + + + + Child Client Anchor Record. + + + + + Represents an Image in a worksheet. + + + + + Gets the Filename, Read only. + + + The following code illustrates how to access the FileName property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream from svg + Stream svgStream = new FileStream("image.svg", FileMode.Open); + + //Create image stream from png + Stream stream = new FileStream("image.png", FileMode.Open); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, svgStream, stream, 50, 50); + + //Check + Console.Write(picture.FileName); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //Picture0 + + + + + + Gets or sets the picture. + + + The following code illustrates how Picture property can be accessed. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream from svg + Stream svgStream = new FileStream("image.svg", FileMode.Open); + + //Create image stream from png + Stream stream = new FileStream("image.png", FileMode.Open); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, svgStream, stream, 50, 50); + + //Check + Console.Write(picture.Picture != null); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + + + + + + Gets or sets the svg data for the picture. + + + The following code illustrates how SvgData property can be accessed. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream from svg + Stream svgStream = new FileStream("image.svg", FileMode.Open); + + //Create image stream from png + Stream stream = new FileStream("image.png", FileMode.Open); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, svgStream, stream, 50, 50); + + //Check + Console.Write(picture.SvgData != null); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + + + + + + Instance field value for this shape. + + + + + Represents Blip id. + + + + + Name of the blip file. + + + + + Shape's picture (maybe should be moved to BitmapShape class). + + + + + Represents a bitmap image. + + + + + Stream that contains subnodes of the blip xml node in Excel 2007 format. + + + + + Stream that contains shape properties xml-tag in Excel 2007 format. + + + + + Stream that contains svg data. + + + + + Stream that contains shape properties xml-tag in Excel 2007 format. + + + Value indicating relation id for the Svg image. + + + + + Value indicating Svg picture path. + + + + + Boolean value indicating if the Svg stream is updated. + + + + + Stream that contains srcRect tag if shape was extracted from Excel 2007 file. + + + + + Macro name associated with this shape. + + + + + x-coordinate in the offset + + + + + y-coordinate in the offset + + + + + Specifies the length of the extents rectangle in EMUs. + + + + + Specifies the width of the extents rectangle in EMUs. + + + + + Specifies a vertical flip. When true, this attribute defines that the group is flipped + vertically about the center of its bounding box + + + + + Specifies a horizontal flip. When true, this attribute defines that the shape is flipped + horizontally about the center of its bounding box + + + + + Specifies the external link for the image. + + + + + Specifies the external link for the image. + + + + + + CropOptions of BitmapShape + + + + + Refer in Open XML specification for more details: + TODO: Need to add support transparancy details. + + + + + Represents the AlphaModeFix value. + + + + + Represents the Threshold value. + + + + + Indicates whether the GrayScale is applied in picture. + + + + + Indicates whether the alpha value is used in color change. + + + + + Represents the due tone color collection. + + + + + Represents the color change collection. + + + + + Initializes a new instance of the BitmapShapeImpl class. + + Current application. + Parent object + + + + Initializes a new instance of the BitmapShapeImpl class. + + Current application. + Parent object. + Indicates is shape include options. False supports only for header / footer image. + + + + Initializes a new instance of the BitmapShapeImpl class. + + Current application. + Parent object. + Represents container. + + + + Checks Blip parse option. + + Represents option. + Value indicating parse option. + + + + Parse the Crop Rectangle + + + + + + Parses blip id option. + + Option to parse. + + + + Parses blip name option. + + Option to parse. + + + + Extract necessary option. + + Option to extract. + value indicating extracted option. + + + + Dispose object. + + + + + Registers shape in all required sub collections. + + + + + This method is called when shapes is deleted. + + + + + This method is called when shapes is deleted. + + Removes image that is referenced by this shape from collection too, + if we didn't detect image usage. XlsIO doesn't detect this situation correctly in all cases + if there are shapes in charts in Excel 2007 or if some image shapes are grouped in any excel version. + If you are not sure whether image is referenced in charts or grouped shapes and you are working with + Excel 2007 version, set this argument to true (this could cause file size increase, but will keep + document in the correct state). + + + + Creates a clone of the current shape. + + New parent for the shape object. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Indicates whether we should add created + shape into all necessary parent collections. This argument is ignored. + A copy of the current shape. + + + + Updates mso object. + + Represents mso object to update. + Returns true if updated otherwise - false. + + + + Generates default shape name and sets it. + + + + + Sets Blip id. + + new Blip id + + + + Download image from url + + Url + Image + + + + Used for internal purpose. + + + + + Gets or sets Blip file name + + + + + Gets or sets external link for the image. + + + + + Gets or sets external link for the image. + + + + + Gets or sets Blip id. + + + + + In and above MS Excel 2007 format, this value should be divided by + 1000 to get the left crop percentage of actual image size. + + + + + In and above MS Excel 2007 format, this value should be divided by + 1000 to get the right crop percentage of actual image size. + + + + + In and above MS Excel 2007 format, this value should be divided by + 1000 to get the bottom crop percentage of actual image size. + + + + + In and above MS Excel 2007 format, this value should be divided by + 1000 to get the top crop percentage of actual image size. + + + + + Gets or sets picture. + + + + + Gets or sets stream that contains subnodes of the blip xml node in Excel 2007 format. + + + + + Gets or sets Stream that contains shape properties xml-tag in Excel 2007 format. Obsolete, will be removed in future release. + + + + + Gets or sets Svg data for the picture. + + + + + Gets or sets the relation id for Svg image. + + + + + Gets or sets a boolean value indicating if the Svg stream is updated. + + + + + Gets or sets value indicating Svg picture path. + + + + + Gets stream of preserved elements in shape properties + + + + + Gets or sets stream that contains srcRect tag if shape was extracted from Excel 2007 file. + + + + + Returns instance value. Read-only. + + + + + Gets or sets macro name associated with this shape. + + + + + Gets or sets if the BitmapShape is DDE + + + + + Gets or sets if the BitmapShape is Camera + + + + + Gets or sets the offset X + + + + + Gets or sets the offset Y + + + + + Gets or sets the extents of X + + + + + Gets or sets the extents of Y + + + + + Gets or Sets vetical flip + + + + + Gets or Sets vetical flip + + + + + Indicates whether the alpha value is used in color change. + + + + + Represents the due tone color collection. + + + + + Represents the color change collection. + + + + + Represents the AlphaModeFix value. + + + + + Represents the Threshold value. + + + + + Indicates whether the GrayScale is applied in picture. + + + + + Class used for Chart Shapes. + + + + + Represents an Embedded Excel chart. [Chart embedded in a worksheet]. + + + + + Top row of the chart in the worksheet. + + + + + Bottom row of the chart in the worksheet. + + + + + Left column of the chart in the worksheet. + + + + + Right column of the chart in the worksheet. + + + + + Instance value of MsofbtSp record. + + + + + Version value of MsofbtSp record. + + + + + Version value of MsofbtOPT record. + + + + + Instance value of MsofbtOPT record. + + + + + Lock against grouping option value. + + + + + Value of LineColor option. + + + + + Value of NoLineDrawDash option. + + + + + Value of ShadowObscured option. + + + + + Fore color. + + + + + Back color. + + + + + Chart object. + + + + + Zero-based index of top row. + + + + + Zero-based index of bottom row. + + + + + Zero-based index of left column. + + + + + Zero-based index of right column. + + + + + Parent worksheet. + + + + + Initializes new instance of the shape. + + Application object for the new shape. + Parent object for the new shape. + Cloned object. + Dictionary with new names. + Dictionary with new font indexes. + + + + Initializes new instance of the chart shape. + + Application object for the new shape. + Parent object for the new shape. + + + + Initializes new instance of the chart shape. + + Application object for the new shape. + Parent object for the new shape. + Shape container record that describes new shape. + Flags to create. + + + + Sets the Worksheet data into the current chart. + + + + + Method saves the chart as image. + + The stream to save the image. + + + + Creates a clone of the current shape. + + New parent for the shape object. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Indicates whether we should add created + shape into all necessary parent collections. + A copy of the current shape. + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + Registers shape in all required sub collections. + + + + + Parses client data record. + + Record to parse. + Parse options. + + + + Parses client anchor record. + + Record to parse. + + + + Creates default options. + + Created MsofbtOPT record. + + + + Searches for all parents + + + + + Converts chart shape into WorksheetBaseImpl. + + Shape to convert. + Converted object. + + + + Returns internal chart object. Read-only + + + + + Gets or sets the offset X + + + + + Gets or sets the offset Y + + + + + Gets or sets the extents of X + + + + + Gets or sets the extents of Y + + + + + Returns or sets the rotation of the 3-D chart view + (the rotation of the plot area around the z-axis, in degrees).(0 to 360 degrees). + + + + + Represents the series name level + + + + + Gets or sets the style index chart. + + + + + Represents the category name level + + + + + Represents the category collection + + + + + Returns or sets the elevation of the 3-D chart view, in degrees (�90 to +90 degrees). + + + + + Returns or sets the perspective for the 3-D chart view.( 0 - 100 ) + + + + + Returns or sets the height of a 3-D chart as a percentage of the chart width + (between 5 and 500 percent). + + + + + Returns or sets the depth of a 3-D chart as a percentage of the chart width + (between 20 and 2000 percent). + + + + + Returns or sets the distance between the data series in a 3-D chart, as a percentage of the marker width.( 0 - 500 ) + + + + + True if the chart axes are at right angles, independent of chart rotation or elevation. + + + + + True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart.. + + + + + True if gridlines are drawn two-dimensionally on a 3-D chart. + + + + + Type of the chart. + + + + + DataRange for the chart series. + + + + + True if series are in rows in DataRange; + otherwise False. + + + + + Title of the chart. + + + + + Gets title text area. Read-only. + + + + + X coordinate of the upper-left corner + of the chart in points (1/72 inch). + + + + + Y coordinate of the upper-left corner + of the chart in points (1/72 inch). + + + + + Width of the chart in points (1/72 inch). + + + + + Height of the chart in points (1/72 inch). + + + + + Collection of the all series of this chart. Read-only. + + + + + Returns primary category axis. Read-only. + + + + + Returns primary value axis. Read-only. + + + + + Returns primary series axis. Read-only. + + + + + Returns secondary category axis. Read-only. + + + + + Returns secondary value axis. Read-only. + + + + + Returns an object that represents the complete chart area for the chart. Read-only. + + + + + Returns plot area frame format. Read-only. + + + + + Represents chart walls. Read-only. + + + + + sidewall property.. + + + + + backwall property.. + + + + + Represents chart floor. Read-only. + + + + + Represents charts dataTable object. + + + + + True if the chart has a data table. + + + + + True if the chart has a legend object. + + + + + True if the chart has a title. + + + + + Represents chart legend. + + + + + Indicates whether chart has plot area. + + + + + Represents the way that blank cells are plotted on a chart. + + + + + True if only visible cells are plotted. False if both visible and hidden cells are plotted. + + + + + True if Microsoft Excel resizes the chart to match the size of the chart sheet window. + False if the chart size isn't attached to the window size. Applies only to chart sheets. + + + + + Represents the Autoshape. + + + + + Extended the ShapeImpl class to support AutoShape. + + + + + Gets or set a value indicating whether shape can move with cell + + + + + Gets or sets a value indicating whether shape can size with cell. + + + + + Indicates whether shape fill color is preserved or not. + + + + + Indicates whether autoshape has noFill or not. + + + + + Instantiates the ShapeExt with the Shape Type. + + Type of the AutoShape. + Represents the Worksheet object. + + + + Updates the shape id. + + + + + + Updates the Placement Value for the shape. + + + + + Specifies a vertical flip. When true, this attribute defines that the group is flipped + vertically about the center of its bounding box + + + + + Specifies a horizontal flip. When true, this attribute defines that the shape is flipped + horizontally about the center of its bounding box + + + + + Gets the Extended ShapeImpl class to support AutoShape. + + + + + Indicates whether shape fill color is preserved or not. + + + + + Indicates whether autoshape has noFill or not. + + + + + Represents the Text Frame. + + + + + + Represents the Shape's Description. + + + + + Represents the Shape's unique id. + + + + + Represents the name of the Shape. + + + + + Represents the BottomRow position of the Shape. + + + + + Represents the BottomRowOffset of the Shape. + + + + + Represents the Height of the shape. + + + + + Represents the Left position of the shape. + + + + + Represents the Left position of the shape. + + + + + Represents the Left column offset of the shape. + + + + + Represents the RightColumn of the Shape. + + + + + Represent the Right Column Offset of the shape. + + + + + Represents the Top position of the shape. + + + + + Represents the Top row of the shape. + + + + + Represents of the top row offset of the shape. + + + + + Represents the Shape width. + + + + + Represents the Shape Rotation. + + + + + Represents the fill. + + + + + Represents the Line Format. + + + + + Indicates whether the shape is hidden. + + + + + Represents the shape title. + + + + + Gets or set a value indicating whether shape can move with cell + + + + + Gets or sets a value indicating whether shape can size with cell. + + + + + Represents the size information of the shape. + + + + + Represents the Current worksheet instance. + + + + + Intializes the members. + + Current Worksheet object. + + + + Specifies the direction for text. + + + + + Indicates the text direction is horizontal + + + + + Indicates the text direction is RotateAllText90 + + + + + Indicates the text direction is RotateAllText270 + + + + + Indicates the text direction is StackedLeftToRight + + + + + Indicates the text direction is StackedRightToLeft + + + + + Specifies the horizontal alignment of text in a text frame. + + + + + Indicates the text is aligned left horizontally. + + + + + Indicates the text is aligned centered horizontally. + + + + + Indicates the text is aligned right horizontally. + + + + + Indicates the text is aligned left middly horizontally. + + + + + Indicates the text is aligned centered middle horizontally. + + + + + Indicates the text is aligned right middle horizontally. + + + + + Specifies the vertical alignment of text in a text frame. + + + + + Aligns text to top of text frame. + + + + + Centers text vertically. + + + + + Aligns text to bottom of text frame. + + + + + Anchors top of text string to current position, regardless of text resizing. When you resize text without baseline anchoring, text centers itself on previous position. + + + + + Anchors center of text string to current position, regardless of text resizing. When you resize text without baseline anchoring, text centers itself on previous position. + + + + + Anchors bottom of text string to current position, regardless of text resizing. When you resize text without baseline anchoring, text centers itself on previous position. + + + + + Specifies the vertical overflow type for text + + + + + Indicates the vertical overflow type is OverFlow + + + + + Indicates the vertical overflow type is ellipsis + + + + + Indicates the vertical overflow type is clip + + + + + Specifies the horizontal overflow type for text + + + + + Indicates the horizontal overflow type is OverFlow + + + + + Indicates the horizontal overflow type is Clip + + + + + Extended the ShapeImp to add support for the Autoshape. + + + + + Shape guide dictionary to hold the path information of the autoshapes. + + + + + Represents custom geometry or not.(If shape is free form shape this is true). + + + + + List to hold the path information of the free form shape. + + + + + Initializes new instance of the shape extension. + + Auto shape type. + WorksheetBaseImpl. + + + + Searches for all necessary parent objects. + + + + + Shape guide dictionary to hold the path information of the autoshapes. + + + + + Represents custom geometry or not.(If shape is free form shape this is true). + + + + + List to hold the path information of the free form shape. + + + + + attribute used as prefix + + + + + autoshape parent + + + + + Name space used on serialization + + + + + mods enum value for the style element + style entry is not provided + + + + + It specifies a reference to a line style within the style matrix. + must be initialized for chartStyle + + + + + It specifies a multiplier to apply to the line width. + + + + + It reference to an effect style within the style matrix. + must be initialized for chartStyle + + + + + It specifies a reference to a fill style within the style matrix. + must be initialized for chartStyle + + + + + It specifies a reference to a themed font. + must be initialized for chartStyle + + + + + It specifies visual shape properties associated with this StyleEntry + + + + + It specifies the default text character properties for a text body associated with this StyleEntry. + + + + + It specifies the body properties for a text body associated with this StyleEntry + + + + + Constructor used for chart style + + input attribute value + input namespace value + input style modifier enum value + + + + Serialize the Style or font reference for entry + + input XML writer + input style entry reference + style entry reference name + boolean value indicates whether thr reference is font or not + + + + Serialize the input color and its values + + input XML writer + color model type + color value string + luminance modulation value + luminance offset 1 value + luminance offset 2 value + shade value on color + + + + Serialize the shape properties current object + + input XML writer + + + + Serialize the Default run paragraph properties + + input XML writer + + + + Serialize the current shape style and its member + + input XML writer + input parent element of chart style + + + + Gets / Sets the line reference style entry + + + + + Gets / Sets the effect reference of style entry + + + + + Gets / Sets the Fill reference of style entry + + + + + Gets / Sets the Font reference of style entry + + + + + Gets / Sets the shape properties of style entry + + + + + Gets / Sets the Default paragraph run properties of style entry + + + + + Gets / Sets the text body properties of style entry + + + + + Style entry Index + integer for lineRef, fillRef, effectRef style elements + enum integer value for fontRef style elements + + + + + Color model value + + + + + Its stores the value of color respect to color model + hexa color or schema color information + + + + + luminace modulation value for scheme color + + + + + luminance offset value 1 for scheme color + + + + + luminance offset value 2 for scheme color + + + + + stores the shade value + + + + + Initialize the member with its values + + Index value + colorModel value + color value + luminance modulation value + luminance offset 1 value + luminance offset value 2 + shade value of color + + + + Gets / Sets the value of member index + + + + + Gets / Sets the value of member ColorModelType + + + + + Gets / Sets the value of member ColorValue + + + + + Gets / Sets the value of member LumModValue + + + + + Gets / Sets the value of member LumOffValue1 + + + + + Gets / Sets the value of member LumOffValue2 + + + + + Gets / Sets the value of member Shade value + + + + + Stores the information of shape properties of style entry + + + + + Indicates whether the options are enabled. Bit position + 0-Shape fill + 1-Line fill + 2-line width (if set to 0, no fill) + 3-line cap + 4-line cmpd + 5-line align + + + + + enum indicates the fill type of shape s + + + + + indicates the line width + + + + + shape fill color model value + + + + + Its stores the value of shape fill color respect to color model + hexa color or schema color information + + + + + luminace modulation value for scheme color of shape fill + + + + + luminance offset value 1 for scheme color of shape fill + + + + + luminance offset value 2 for scheme color of shape fill + + + + + Color model value + + + + + Its stores the value of border color respect to color model + hexa color or schema color information + + + + + luminace modulation value for scheme color of border + + + + + luminance offset value 1 for scheme color of border + + + + + luminance offset value 2 for scheme color of border + + + + + Specifies the compound line type to be used for the underline stroke. + + + + + Indicates that lines joined together have a round join. + + + + + Specifies the ending caps that should be used for this line. + + + + + Specifies the alignment to be used for the underline stroke. + + + + + Default constructor + + + + + Gets / Sets the shapefillType member + + + + + Gets / Sets the Border Weight member + + + + + Gets / Sets the ShapeFillColorModel member + + + + + Gets / Sets the ShapeFillColorValue member + + + + + Gets / Sets the ShapeFill Luminance Modulation member + + + + + Gets / Sets the shapefill luminace offset 1 member + + + + + Gets / Sets the shapefill luminace offset 2 member + + + + + Gets / Sets the Border Fill ColorModelType member + + + + + Gets / Sets the BorderFill Color member + + + + + Gets / Sets the BorderFill Luminance Modulation member + + + + + Gets / Sets the borderFill Luminace Offset Value1 member + + + + + Gets / Sets the borderFill Luminace Offset Value2 member + + + + + Gets / Sets the shapeLineStyle member + + + + + Gets / Sets the BorderIsRound member + + + + + Gets / Sets the LineCap member + + + + + Gets / Sets the IsInsetPen member + + + + + Get the options enabled flags + + + + + Returns a TextFrame object that contains the + alignment and anchoring properties for the specified shape. Read-only. + + + + + Searches for all necessary parent objects. + + + + + Returns the TextRange object that represents the text in the object. Read-only. + + + + + Text of the comment. Read-only. + + + + + Searches for all necessary parent objects. + + + + + Initializes variables. + + + + + Comment text. + + + + + Class that stores that text body properties + + + + + text vertical overflow type + + + + + text horizontal overflow type + + + + + text direction enum + + + + + left margin point of text + + + + + top margin point of text + + + + + right margin point of text + + + + + bottom margin of text + + + + + boolean value indicates whether the text to be wrapped in text + + + + + struct type of columns + + + + + vertical alignment of text + + + + + horizontal alignment of text + + + + + Boolean value indicates whether the text is to be auto sized + + + + + Boolean value indicates whether margin is automatically generated + + + + + boolean value indicates whether the text to be preset wrapped in text + + + + + Get the anchor position from text direction and alignment + + input text Direction of the text body + input text body vertical alignment + input text body horizontal alignment + output anchor + the boolean value + + + + Get the string formatted text direction from enum + + input text direction enum + output string formatted text direction + + + + Get Left margin value of text body + + converted left margin value + + + + Set Left margin value of text body + + converted left margin value + + + + Get Top margin value of text body + + converted Top margin value + + + + Set Top margin value of text body + + converted Top margin value + + + + Get Right margin value of text body + + converted right margin value + + + + Set Right margin value of text body + + converted right margin value + + + + Get Bottom margin value of text body + + converted Bottom margin value + + + + Set Bottom margin value of text body + + converted Bottom margin value + + + + Get anchor position value of text body from current object properties + + anchor position value + + + + Serializes the text body properties attributes + + input XML writer + prefix of the element + namespace of the element + + + + Gets / Sets the TextVertOverflowType member + + + + + Gets / Sets the TextHorzOverflowType member + + + + + Gets / Sets the TextDirection member + + + + + Gets / Sets the LeftMarginPt member + + + + + Gets / Sets the TopMarginPt member + + + + + Gets / Sets the RightMarginPt member + + + + + Gets / Sets the BottomMarginPt member + + + + + Gets / Sets the WrapTextInShape member + + + + + Gets / Sets the VerticalAlignment member + + + + + Gets / Sets the HorizontalAlignment member + + + + + Gets / Sets the IsAutoSize member + + + + + Gets / Sets the IsAutoMargins member + + + + + Gets / Sets the number of column + + + + + Gets / Sets the spacingPt of column + + + + + This class represents single GradientStop of the gradient fill. + + + + + Size of the binary data. + + + + + GradientStop color. + + + + + Stop position. + + + + + Transparency. + + + + + Tint of the color for this GradientStop. + + + + + Shade of the color for this GradientStop. + + + + + Creates new instance of the GradientStop. + + GradientStop color. + GradientStop position. + GradientStop transparecy. + + + + Creates new instance of the GradientStop. + + GradientStop color. + GradientStop position. + GradientStop transparecy. + Color tint value. + Color shade value. + + + + Initializes new instance of the GradientStop and extracts settings from specified data array.. + + Data to parse. + Offset to start data parsing from. + + + + Serializes GradientStop into specified stream. + + Stream to serialize data into. + + + + Creates copy of the current instance. + + A copy of the current instance. + + + + Checks whether the specified GradientStop is equal to the current + GradientStop without taking transparency into consideration. + + Represents GradientStop. + Value indicating transparency + + + + Gets / sets color of this GradientStop. + + + + + Gets / sets position of this GradientStop. + + + + + Gets / sets transparency of this GradientStop. + + + + + Gets / sets tint of the color for this GradientStop. + + + + + Gets / sets shade of the color for this GradientStop. + + + + + Represents collection of gradient stops. + + + + + Maximum possible gradient position. + + + + + Gradient angle. + + + + + Gradient type. + + + + + This element defines the "focus" rectangle for the center shade, + specified relative to the fill tile rectangle. + + + + + Gradient fill rect element + + + + + Default constructor. + + + + + Initializes new instance of the gradient stops collection and extracts settings from byte array. + + Byte array to parse. + + + + Saves gradient stops into stream in binary format. + + Stream to serialize into. + + + + Parse byte array. + + Array to parse. + + + + Doubles gradient stops in the collection and updates their positions. + + + + + Inverts gradient stops order and updates their positions correctly. + + + + + Shrinks GradientStop. + + Shrinked Gradient stops. + + + + Creates copy of the current instance. + + Copy of the current instance. + + + + Checks whether specified Gradient stops has colors equal to this gradient stops. + + Represents GradientStop + Value indicating whether GradientStop has color. + + + + Gets / sets gradient angle. + + + + + Gets / sets type of the gradient. + + + + + This element defines the "focus" rectangle for the center shade, + specified relative to the fill tile rectangle. + + + + + it's define the tilerect property. + + + + + Returns true if gradient stops are symmetric. Read-only. + + + + + Specifies all possible gradient types. + + + + + This element specifies a linear gradient. + + + + + Gradient follows a circular path. + + + + + Gradient follows a rectangular path. + + + + + Gradient follows the shape. + + + + + Specifies x-coordinate in the offset + + + + + Specifies y-coordinate in the offset + + + + + Specifies the width of the extents rectangle. + + + + + Specifies the height of the extents rectangle. + + + + + Specifies the rotation of the shape. + + + + + Specifies the x-coordinate in the child shape offset + + + + + Specifies the y-coordinate in the child shape offset + + + + + Specifies the width of the extents rectangle for child shape. + + + + + Specifies the height of the extents rectangle for child shape. + + + + + Specifies the parent shape. + + + + + Initializes new instance of the shape frame. + + Parent shape. + + + + Set offset values for shape frame. + + shape rotation. + X-coordinate in the offset. + Y-coordinate in the offset. + Width of the extents rectangle. + Height of the extents rectangle. + + + + Set child offset values for shape frame. + + X-coordinate in the child offset. + Y-coordinate in the child offset. + Width of the extents rectangle for child shape. + Height of the extents rectangle for child shape. + + + + Creates a clone of the current shape frame. + + A copy of the current shape frame. + + + + Set parent for shape frame.. + + X-coordinate in the child offset. + + + + Close the shape frame. + + + + + Specifies x-coordinate in the offset + + + + + Specifies y-coordinate in the offset + + + + + Specifies the width of the extents rectangle. + + + + + Specifies the height of the extents rectangle. + + + + + Specifies the x-coordinate in the child shape offset + + + + + Specifies the y-coordinate in the child shape offset + + + + + Specifies the width of the extents rectangle for child shape. + + + + + Specifies the height of the extents rectangle for child shape. + + + + + Specifies the rotation of the shape. + + + + + Class used for Shapes Line Format. + + + + + Represents the line formatting properties. + + + + + Gets or sets the line weight. + + + + + Gets or sets the fore color of the line. + + + + + Gets or sets the back color of the line. + + + + + Gets or sets the fore color index of the line. + + + + + Gets or sets the back color index of the line. + + + + + Gets or sets the style of the arrowhead at the beginning of the specified line. + + + + + Gets or sets the style of the arrowhead at the end of the specified line. + + + + + Gets or sets the length of the arrowhead at the beginning of the specified line. + + + + + Gets or sets the length of the arrowhead at the end of the specified line. + + + + + Gets or sets the width of the arrowhead at the beginning of the specified line. + + + + + Gets or sets the width of the arrowhead at the end of the specified line. + + + + + Gets or sets the line dash style. + + + + + Gets or sets the line style. + + + + + Gets or sets the line transparency. + + + + + Gets or sets a boolean value indicates whether to visible the line or not. + + + + + Gets or set the line gradient pattern. + + + + + Gets or sets a boolean value indicates whether the line has pattern or not. + + + + + Represents default line weight mull. + + + + + Represents max line weight. + + + + + Represents length of helper parse array. + + + + + Represents helper byte array to parse pattern. + + + + + Represents weight of shape line. + + + + + Represents foreground color. + + + + + Represents foreground color. + + + + + Represents parent book. + + + + + Represents begin arrow style. + + + + + Represents end arrow style. + + + + + Represents begin arrow length. + + + + + Represents end arrow length. + + + + + Represents begin arrow width. + + + + + Represents end arrow width. + + + + + Represents dash style. + + + + + Represents line style. + + + + + Represents line transparency. + + + + + Represents is line format visible. + + + + + Represents line pattern. + + + + + Indicate if line format contain pattern. + + + + + Indicates whether border join is round. + + + + + Represent indicating whether line properties having nofill element or not. + + + + + Represent indicating whether line properties having solid element or not. + + + + + Default Style index + + + + + Initialize new static members. + + + + + Creates new instance of object. + + Current application. + Parent object. + + + + Creates new instance of object. Autoshape Implementation + + Current application. + Parent object. + + + + Finds all parent objects. + + + + + Parses transparency. + + Transparency value to parse. + Returns parsed value. + + + + Serialize transparency. + + Represents option holder. + Represents transparency id. + Represents transparency value. + + + + Serialize color to stream. + + Represents option holder. + Represents color to serialize. + Represents option id to serialize. + + + + Parses fill options. + + Record to parse. + Value indicating extracted option. + + + + Parses arrows options + + Represents option to parse. + Returns true if parsed; otherwise false. + + + + Parses current pattern. + + Represents pattern option. + Returns parsed pattern value. + + + + Parse visible property. + + Represents visible data. + + + + Serialize shape line format as biff format. + + Represents option holder. + + + + Serialize arrow line options. + + Represents options storage. + Returns updated option storage. + + + + Serialize dash style as biff recorded structure. + + Represents option holder. + + + + Serialize line style as biff recorded structure. + + Represents option holder. + + + + Serialize visible property. + + Represents option holder. + + + + Serialize pattern to mso option. + + Represents option holder. + + + + Gets pattern by pattern data. + + Represents patt data. + Returns parsed data. + + + + Clones current object. + + Represents parent object for new instance. + Returns cloned object. + + + + Represents weight of the line in pts.( 0 - 1584 ) + + + + + Represents foreground color. + + + + + Represents background color. + + + + + Represents foreground color index. + + + + + Represents background color index. + + + + + Represents begin arrow head style. + + + + + Represents end arrow head style. + + + + + Represents begin arrow head length. + + + + + Represents end arrow head length. + + + + + Represents begin arrow head width. + + + + + Represents end arrow head width. + + + + + Represents the dash style for the specified line. + + + + + Represents line style. + + + + + Represents line transparency. + + + + + Represents if line format is visible. + + + + + Represents line pattern. + + + + + Indicates if current line format contain pattern. + + + + + Represent indicating whether line properties having nofil element or not. + + + + + Represent indicating whether line properties having soild element or not. + + + + + Default line style index. + + + + + Returns parent workbook. Read-only. + + + + + Indicates whether join is round. + + + + + This is base class for text box shapes such as TextBox and Comment. + + + + + Represents default formatting run size. + + + + + Value of text direction property. + + + + + Horizontal alignment of the text. + + + + + Vertical alignment of the text. + + + + + Text rotation. + + + + + Indicates whether comment text is locked. + + + + + Comment text. + + + + + Length of text. + + + + + Length of formatting runs. + + + + + Shape filling color. + + + + + Represents worksheet + + + + + Color Object. + + + + + Initializes new instance of the class. + + Application object for the new item. + Parent object for the new item. + + + + Extracts comment from MsofbtSpContainer. + + Application object for the current object. + Parent object for the current object. + Container that represents comment. + Parse options. + + + + Creates a clone of the current shape. + + New parent for the shape object. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Indicates whether we should add created + shape into all necessary parent collections. + A copy of the current shape. + + + + Sets text to the specified TextWithFormat value. + + RTF text to set. + + + + Parses TextObjectRecord. + + Record to parse. + If textObject is NULL. + + + + Parses two continue records. First contains text, second is formatting runs. + + Comment text. + Comment formatting runs. + Parse options. + + When textRecord or formattingRecord is NULL. + + + + + Initializes variables. + + + + + Parses ClientTextBox record. + + Record to parse. + Parse options. + + + + Copies data from another comment shape. + + Text shape to copy from. + Dictionary with new font indexes. + + + + Creates default shape options. + + Record containing default options. + + + + Serializes text direction. + + MsofbtOPT record to which text ID will be added. + + If options argument is NULL. + + + + + Parses all unknown for ShapeImpl records. + + Record to parse. + Parse options. + + + + Horizontal alignment of the text. + + + + + Vertical alignment of the text. + + + + + Text rotation. + + + + + Indicates whether comment text is locked. + + + + + Comment text. + + + + + Gets or sets text box text. + + + + + Gets inner rich text string object. Read-only. + + + + + Shape filling color. + + + + + Color Object. + + + + + This class represents TextBox form control. + + + + + This interface represents TextBox form control shape. + + + + + This interface represents TextBox form control shape. + + + + + This interface represents TextBox form control. + + + + + Horizontal alignment of the text. + + + + + Vertical alignment of the text. + + + + + Text rotation. + + + + + Indicates whether comment text is locked. + + + + + Text of the comment. Read-only. + + + + + Text of the comment. + + + + + Text of the comment. + + + + + Correct shape instance. + + + + + Correct shape version. + + + + + Represents embedded string. + + + + + Represents a formula linking to spreadsheet cell data + + + + + Represent indicating wheather text box is created or not. + + + + + Object to hold the textbody properties. + + + + + Represents Horizontal flip of the textbox + + + + + Represents vertical flip of the textbox + + + + + Represent indicating whether text box having the line element or not. + + + + + Indicates whether shape fill color is preserved or not + + + + + Indicates whether text box has noFill or not. + + + + + Initialize new instance of the text box shape. + + Application object for the new shape. + Parent object for the new shape. + + + + Initializes new instance of the text box shape. + + Application object for the new shape. + Parent object for the new shape. + Shape's container. + Parsing options. + + + + Creates default shape options. + + Record with default option specified. + + + + Creates a clone of the current shape. + + New parent for the shape object. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Indicates whether we should add created + shape into all necessary parent collections. + A copy of the current shape. + + + + Indicates whether shape fill color is preserved or not + + + + + Indicates whether text box has noFill or not. + + + + + Specifies a formula linking to spreadhseet cell data + + + + + Represent indicating wheather text box is created or not. + + + + + Text body properties holder to hold the properties of the textbody. + + + + + Represents the horizontal flip of the textbox shape. + + + + + Represents vertical flip of the textbox shape. + + + + + Style wrapper for multicell range. Redirects all + properties and method calls to the range styles. + + + + + Array that contains all cells. + + + + + Parent workbook. + + + + + Application. + + + + + Creates object that will contain all styles that are used by range. + + Range from which styles must be taken. + + + + Creates object that will contain all styles that are used by range. + + Range from which styles must be taken. + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object. + + + + + For far east languages. Supported only for format. Always 0 for US. + + + + + Returns or sets the format code for the object as a string in the + language of the user. Read / write String. + + + + + Gets format index in m_book.InnerFormats. + + + + + Indicates whether style has border. Read-only Boolean. + + + + + Returns a Borders collection that represents the borders of a + style or a range of cells (including a range defined as part of + a conditional format). + + + + + True if the style is a built-in style. Read-only Boolean. + + + + + Gets / sets fill pattern. + + + + + Gets / sets index of fill background color. + + + + + Gets / sets fill background color. + + + + + Gets / sets index of fill foreground color. + + + + + Gets / sets fill foreground color. + + + + + Returns a Font object that represents the font of the specified + object. Read-only. + + + + + True if the formula will be hidden when the worksheet is protected. + Read/write Boolean. + + + + + Returns or sets the horizontal alignment for the specified object. + For all objects, this can be one of the following OfficeHAlign constants. + Read/write OfficeHAlign. + + + + + True if the style includes the AddIndent, HorizontalAlignment, + VerticalAlignment, WrapText, and Orientation properties. + Read/write Boolean. + + + + + True if the style includes the Color, ColorIndex, LineStyle, + and Weight border properties. Read/write Boolean. + + + + + True if the style includes the Background, Bold, Color, + ColorIndex, FontStyle, Italic, Name, OutlineFont, Shadow, + Size, Strikethrough, Subscript, Superscript, and Underline + font properties. Read/write Boolean. + + + + + True if the style includes the NumberFormat property. + Read/write Boolean. + + + + + True if the style includes the Color, ColorIndex, + InvertIfNegative, Pattern, PatternColor, and PatternColorIndex + interior properties. Read / write Boolean. + + + + + True if the style includes the FormulaHidden and Locked protection + properties. Read / write Boolean. + + + + + Returns or sets the indent level for the style. Read/write. + + + + + Indicates whether style is initialized (differs from Normal style). + Read-only. + + + + + True if the object is locked, False if the object can be + modified when the sheet is protected. Read/write Boolean. + + + + + Returns or sets the name of the object. Read-only String. + + + + + Returns or sets the format code for the object. Read / write String. + + + + + Gets / sets index of the number format. + + + + + Text rotation angle: + 0 Not rotated + 1-90 1 to 90 degrees counterclockwise + 91-180 1 to 90 degrees clockwise + 255 Letters are stacked top-to-bottom, but not rotated. + int.MinValue - different rotation angle for different ranges. + + Thrown when value is more than 0xFF. + + + + True if text automatically shrinks to fit in the available + column width. Read/write Boolean. + + + + + Returns or sets the vertical alignment of the specified object. + Read/write OfficeVAlign. + + + + + True if Microsoft Excel wraps the text in the object. + Read/write Boolean. + + + + + Text direction, the reading order for far east versions. + + + + + If true then first symbol in cell is apostrophe. + + + + + Returns or sets the color of the interior pattern as an index into the current color palette. + + + + + Returns or sets the color of the interior pattern as an Color value. + + + + + Returns or sets the color of the interior. The color is specified as + an index value into the current color palette. + + + + + Returns or sets the cell shading color. + + + + + Returns Interior object that represents the interior of the specified + object. Read-only. + + + + + Gets value indicating whether format was modified, compared to parent format. + + + + + Represents a style description. The Style object contains + all style attributes (font, number format, alignment, and so on) as + properties. There are several built-in styles, including Normal, + Currency, and Percent. Using the Style object is a fast and efficient + way to change several cell-formatting properties on multiple cells at + the same time. + For the Workbook object, the Style object is a member of the Styles + collection. The Styles collection contains all the defined styles for + the workbook. + + + + + First excel 2007 specific style in the styles array. + + + + + Constant indicating that one object is less than another. Used by CompareTo method. + + + + + Constant indicating that one object is equal to another. Used by CompareTo method. + + + + + Constant indicating that one object is larger than another. Used by CompareTo method. + + + + + Build in style index for RowLevel_n styles. + + + + + Build in style index for ColLevel_n styles. + + + + + Style record that describes style. + + + + + StyleExt record that describes style. + + + + + Indicates whether do not to compare name during CompareTo operation. + + + + + Initializes new instance of the style. + + Parent workbook. + + + + Initializes new instance of the style. + + Parent workbook. + Style record to parse. + + + + Initializes new instance of the style. + + Parent workbook. + Name of the style to create. + + + + Initializes new instance of the style. + + Parent workbook. + Name of the style to create. + Base style. + + + + Initializes new instance of the style. + + Parent workbook. + Name of the style to create. + Base style. + Indicates whether created style is built in. + + + + Copies default style settings into internal extended format from built-in style. + + Built-in style index. + + + + Updates style record according to the xf indexes. + + + + + This method is called after any changes are made in styles. + + + + + This method is called before any changed are made in styles. + + + + + Creates copy of the current instance. + + Parent object for the new collection. + Copy of the current instance. + + + + + + + + + + Indicates whether style is build in. Read-only. + + + + + Returns name of the style. Read-only. + + + + + Represents actual style name in case of AsciiConversion + + + + + Indicates whether style is initialized (differs from Normal style). + Read-only. + + + + + Returns index of the style's extended format. + + + + + Indicates whether do not to compare name during CompareTo operation. + + + + + Returns style record. Read-only. + + + + + /Represents if the stylename is encoded, when style name is greater than 256 symbols + + + + + StyleExt record that describes style. + + + + + This event is raised before any changes are made in styles. + + + + + This event is raised after any changes are made in styles. + + + + + This class stores default predefined styles settings. + + + + + Fill settings. + + + + + Font settings. + + + + + Borders information. + + + + + Initializes new instance of the class. + + Fill object. + Font object. + + + + Initializes new instance of the class. + + Fill object. + Font object. + Borders object. + + + + Style options. + + + + + Represents the 3-D format of the chart. + + + + + Gets or sets the top bevel. + + The bevel top. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the 3D format of chart serie + IThreeDFormat format = chart.Series[0].SerieFormat.ThreeD; + //Set the bevel top + format.BevelTop = Office2007ChartBevelProperties.CoolSlant; + //Set the height of bevel top + format.BevelTopHeight = 300; + //Set the width of bevel top + format.BevelTopWidth = 320; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets the bottom bevel. + + The bevel bottom. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the 3D format of chart serie + IThreeDFormat format = chart.Series[0].SerieFormat.ThreeD; + //Set the bevel bottom + format.BevelBottom = Office2007ChartBevelProperties.Angle; + //Set the height of bevel bottom + format.BevelBottomHeight = 100; + //Set the width of bevel bottom + format.BevelBottomWidth = 120; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets the material property of the chart. + + The material. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the 3D format of chart serie + IThreeDFormat format = chart.Series[0].SerieFormat.ThreeD; + //Set the 3D lightning + format.Lighting = Office2007ChartLightingProperties.Chilly; + //Set the 3D material + format.Material = Office2007ChartMaterialProperties.DarkEdge; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets lighting property of the chart. + + The lighting. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the 3D format of chart serie + IThreeDFormat format = chart.Series[0].SerieFormat.ThreeD; + //Set the 3D lightning + format.Lighting = Office2007ChartLightingProperties.Chilly; + //Set the 3D material + format.Material = Office2007ChartMaterialProperties.DarkEdge; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets or sets the top bevel height. + + The bevel top height. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the 3D format of chart serie + IThreeDFormat format = chart.Series[0].SerieFormat.ThreeD; + //Set the bevel top + format.BevelTop = Office2007ChartBevelProperties.CoolSlant; + //Set the height of bevel top + format.BevelTopHeight = 300; + //Set the width of bevel top + format.BevelTopWidth = 320; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + The value ranges from 0 to 1584 + + + + Gets or sets the top bevel width. + + The bevel top width. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the 3D format of chart serie + IThreeDFormat format = chart.Series[0].SerieFormat.ThreeD; + //Set the bevel top + format.BevelTop = Office2007ChartBevelProperties.CoolSlant; + //Set the height of bevel top + format.BevelTopHeight = 300; + //Set the width of bevel top + format.BevelTopWidth = 320; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + The value ranges from 0 to 1584 + + + + Gets or sets the bottom bevel height. + + The bevel bottom height. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the 3D format of chart serie + IThreeDFormat format = chart.Series[0].SerieFormat.ThreeD; + //Set the bevel bottom + format.BevelBottom = Office2007ChartBevelProperties.Angle; + //Set the height of bevel bottom + format.BevelBottomHeight = 100; + //Set the width of bevel bottom + format.BevelBottomWidth = 120; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + The value ranges from 0 to 1584 + + + + Gets or sets the bottom bevel width. + + The bevel bottom width. + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2011"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2009"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2010"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the 3D format of chart serie + IThreeDFormat format = chart.Series[0].SerieFormat.ThreeD; + //Set the bevel bottom + format.BevelBottom = Office2007ChartBevelProperties.Angle; + //Set the height of bevel bottom + format.BevelBottomHeight = 100; + //Set the width of bevel bottom + format.BevelBottomWidth = 120; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + The value ranges from 0 to 1584 + + + + Class used for Shadowformat Implementation + + + + + Bevel top height value + + + + + Bevel top width value + + + + + Bevel bottom height value + + + + + Bevel bottom width value + + + + + Preset Shape for Bevel + + + + + Represents the ligthning latitude. + + + + + Represents the lightning longitude. + + + + + Represents the lightning angle. + + + + + Creates the shadow and sets its Application and Parent + properties to specified values. + + Application object for the shadow. + Parent object for the shadow. + + + + Searches for all necessary parent objects. + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + + A new object that is a copy of this instance. + + + + + Clone current Record. + + Parent object. + Returns clone of current object. + + + + Gets or sets the bevel top. + + The bevel top. + + + + Gets or sets the bevel bottom. + + The bevel bottom. + + + + Gets or sets the material. + + The material. + + + + Gets or sets the lighting. + + The lighting. + + + + Get or Set BevelT height + + Integer Number + The value ranges from 0 to 1584 + + + + Get or Set BevelB height + + Integer Number + The value ranges from 0 to 1584 + + + + Get or Set BevelT Width + + Integer Number + The value ranges from 0 to 1584 + + + + Get or Set BevelB height + + Integer Number + The value ranges from 0 to 1584 + + + + Boolean value indicates whether the bevel top width set or not. + + + + + Boolean value indicates whether the bevel top height set or not. + + + + + Boolean value indicates whether the bevel bottom width set or not. + + + + + Boolean value indicates whether the bevel bottom height set or not. + + + + + Gets or set the lightning latitude value. + + + + + Gets or set the lightning longitude value. + + + + + Gets or set the lightning angle value. + + + + + + + + + + + + Default capacity of internal buffers. + + + + + Array which store keys in sorted order. + + + + + Collection stores values. + + + + + Size of collection. + + + + + Version of collection data. + + + + + Default comparer for keys. + + + + + List of keys. + + + + + List of values. + + + + + Default constructor. + + + + + Creates an empty list with the specified initial capacity. + + Initial capacity. + + When initialCapacity is less than zero. + + + + + Creates an empty SortedList with the default initial capacity + and specified comparer. + + + The IComparer is used to determine whether two keys are equal. + + + + + Creates an empty SortedList with the specified initial capacity + and specified comparer. + + Initial capacity. + + The IComparer is used to determine whether two keys are equal. + + + + + Copies the elements from the specified dictionary to a new list + with the same initial capacity as the number of elements copied. + + The IDictionary to copy. + + + + Copies the elements from the specified dictionary to a new list with the same + initial capacity as the number of elements copied and with the specified comparer. + + The IDictionary to copy. + + The IComparer to use to determine whether two keys are equal. + + + When argument d is null. + + + + + Returns a synchronized (thread-safe) wrapper for the SortedList. + + The SortedList to synchronize. + A synchronized (thread-safe) wrapper for the SortedList. + + When list is null. + + + + + Adds an element with the provided key and value to the list. + + The Object to use as the key of the element to add. + The Object to use as the value of the element to add. + + When key is null. + + + When list already contains specified key. + + + + + Removes all elements from the collection. + + + + + Creates a new object that is a copy of the current instance. + + Copy of the current instance. + + + + Clone current instance. + + Returns clone of current object. + + + + Determines whether the list contains an element with the specified key. + + Key of the element to search. + True if list contains specified key. + + + + Determines whether the list contains an element with the specified key. + + Key of the element to search. + True if list contains specified key. + + + + Determines whether the list contains the specified value. + + Value of the element to search. + True if list contains specified value. + + + + Copies all the elements of the SortedListEx to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + If specified array is null. + + + If rank of the array is not 1 or there are not enough elements. + + + If specified arrayIndex is less than zero. + + + + + Gets the value at the specified index of the SortedListEx. + + The zero-based index of the value to get. + The value at the specified index of the SortedListEx. + + When index is less than zero or greater than size of the list. + + + + + Gets the value at the specified name of the SortedListEx. + + The value to get. + The value at the specified index of the SortedListEx. + + When string is null. + + + + + Gets the key at the specified index of the SortedListEx. + + The zero-based index of the key to get. + The key at the specified index of the SortedListEx. + + When index is less than zero or greater than size of the list. + + + + + Gets the keys in the SortedListEx. + + An IList containing the keys in the SortedListEx. + + + + Gets the values in the SortedListEx. + + An IList containing the values in the SortedListEx. + + + + Returns the zero-based index of the specified key. + + The key to locate. + The zero-based index of key, if key is found; otherwise, -1. + + If specified key is null. + + + + + Returns the zero-based index of the first occurrence of the specified value. + + The value to locate (can be NULL). + + The zero-based index of the first occurrence of value, if value is found; + otherwise, -1. + + + + + Removes the element at the specified index. + + The zero-based index of the element to remove. + + When index is less than zero or greater than size of the list. + + + + + Removes the element with the specified key from SortedListEx. + + The key of the element to remove. + + + + Replaces the value at the specific index. + + The zero-based index at which to save value. + The Object to save into. Can be NULL. + + When index is less than zero or greater than size of the list. + + + + + Sets the capacity to the actual number of elements. + + + + + Returns an IEnumerator that can iterate through the SortedListEx. + + An IEnumerator for the SortedListEx. + + + + + + + + + + Inserts element with specified key and value at specified index. + + The zero-based index to insert element at. + The key of the element to insert. + The value of the element to insert. + + + + Ensures that the capacity of this instance is at least the specified value. + + The minimum capacity to ensure. + + + + Capacity of internal buffers. + + + + + Size of the collection. Read-only. + + + + + List of keys. Read-only. + + + + + List of values. Read-only. + + + + + Returns True if list is readonly, False otherwise. Read-only. + + + + + Returns True if collection has fixed size, False otherwise. + + + + + Returns True if the collection is synchronized, False otherwise. + + + + + Returns the object that can be used to synchronize access to the collection. + Read-only. + + + + + Gets or sets the value associated with the specified key. + + + + + + + + + + List for which is this enumerator. + + + + + Key of the current element. + + + + + Values of the current element. + + + + + Index of current element. + + + + + Starting index for the enumerator. + + + + + Ending index for this enumerator. + + + + + Version of collection data. + + + + + True if current element is correct, False otherwise + (before beginning or after end). + + + + + Creates enumerator for specified list, starting from specified index + and with specified count. + + List for which enumerator is being created. + Starting index. + Number of elements to enumerate. + + + + Performs application-defined tasks associated with freeing, releasing, or + resetting unmanaged resources. + + + + + Creates a new object that is a copy of the current instance. + + Copy of the current instance. + + + + Advances the enumerator to the next element of the collection. + + + True if the enumerator was successfully advanced to the next element; + False if the enumerator has passed the end of the collection. + + + When the current version is not equal to the SortedListEx version. + + + + + Sets the enumerator to its initial position, which is before + the first element in the collection. + + + When the current version is not equal to the SortedListEx version. + + + + + Returns key of the current element. Read-only. + + + When the current version is not equal to the SortedListEx version + or if current is false. + + + + + Return DictionaryEntry for the current element. + + + When the current version is not equal to the SortedListEx version + or if current is false. + + + + + The current element in the collection. Read-only. + + + If current is false. + + + + + The current element in the collection. Read-only. + + + If current is false. + + + + + Returns value for the current element. + + + When the current version is not equal to the SortedListEx version + or if current is false. + + + + + + + + + + + + + + + Index of current element. + + + + + Version of collection data. + + + + + + + + + + + + + + + + + + + + + List for which this collection was created. + + + + + Creates KeyList for specified SortedListEx. + + TypedSortedListEx for which KeyList must be created. + + + + Adds an element with the provided key to the list. + + The Object to use as the key of the element to add. + + + + Removes all elements from the collection. + + + + + Determines whether the list contains an element with the specified key. + + Key of the element to search. + True if list contains specified key. + + + + Copies all the elements of the list to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + If array is null or rank of the array is not 1. + + + + + Copies all the elements of the list to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + If array is null or rank of the array is not 1. + + + + + Insert the value at the specific index. + + The zero-based index at which to save value. + The Object to save into. Can be NULL. + + + + Returns an IEnumerator that can iterate through the list. + + An IEnumerator for the list. + + + + Returns an IEnumerator that can iterate through the list. + + An IEnumerator for the list. + + + + Returns the zero-based index of the specified key. + + The key to locate. + The zero-based index of the key, if the key is found; otherwise, -1. + + + + Removes the element with the specified key from list. + + The key of the element to remove. + + + + Removes the element at the specified index from the list. + + The zero-based index of the element to remove. + + + + Size of the collection. Read-only. + + + + + Returns True if list is readonly, False otherwise. Read-only. + + + + + Returns True if collection has fixed size, False otherwise. + + + + + Returns True if the collection is synchronized, False otherwise. + + + + + Returns the object that can be used to synchronize access to the collection. + Read-only. + + + + + Gets or sets the key at the specified index. + + + + + + + + + + List for which this collection was created. + + + + + Array that contain values. + + + + + Creates ValueList for specified SortedListEx. + + List for which ValueList must be created. + + + + Re-read values from the list. + + + + + Adds an element with the provided key to the list. + + Value to add. + + + + Removes all elements from the collection. + + + + + Determines whether the list contains an element with the specified value. + + Value to search. + True if list contains specified value. + + + + Copies all the elements of the list to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + + + Copies all the elements of the list to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + + + Insert the value at the specific index. + + The zero-based index at which to save value. + The Object to save into. Can be NULL. + + + + Returns an IEnumerator that can iterate through the list. + + An IEnumerator for the list. + + + + Returns an IEnumerator that can iterate through the list. + + An IEnumerator for the list. + + + + Returns the zero-based index of the specified value. + + The value to locate. + The zero-based index of the value, if the value is found, otherwise -1. + + + + Removes the specified value from list. + + The value to remove. + + + + Removes the element at the specified index from the list. + + The zero-based index of the element to remove. + + + + Size of the collection. Read-only. + + + + + Returns True if list is readonly, False otherwise. Read-only. + + + + + Returns True if collection has fixed size, False otherwise. + + + + + Returns True if the collection is synchronized, False otherwise. + + + + + Returns the object that can be used to synchronize access to the collection. + Read-only. + + + + + Gets or sets the value at the specified index. + + + + + + This class contains utility methods, that cannot be logically placed in any other class. + + + + + Number of days that are incorrectly displayed by MS Excel. + + + + + Excel 2007 maximum row count. + + + + + Excel 2007 maximum column count. + + + + + Excel 97-03 maximum row count. + + + + + Excel 97-03 maximum column count. + + + + + To prevent creation instances of this class. + + + + + Determines if rectangles intersect with each other. + + The first rectangle to test. + The second rectangle to test. + This method returns true if there is any intersection. + + + + + + + + + + + + + Searches for the specified object and returns the index of + the first occurrence within the entire one-dimensional array. + + Array to search. + Value to locate in the array. + + The index of the first occurrence of value within the entire array, if found; + otherwise, -1. + + + + Searches for the specified object and returns the index of + the first occurrence within the entire one-dimensional array. + + Array to search. + Value to locate in the array. + + The index of the first occurrence of value within the entire array, if found; + otherwise, -1. + + + + Searches for the specified object and returns the index of + the first occurrence within the entire one-dimensional array. + + Array to search. + Value to locate in the array. + + The index of the first occurrence of value within the entire array, if found; + otherwise, -1. + + + + Converts DateTime into number. + + Value to convert. + Converted value. + + + + Converts number into DateTime. + + Number to convert. + Converted value. + + + + Creates new cell without adding it to the collection.. + + Zero-based row index of the cell to create. + Zero-based column index of the cell to create. + Record type. + Created cell. + + + + Removes first character from the string. + Warning: this method doesn't performs any argument check for performance purposes. + + Value to remove first character from. + Updated string. + + + + + + + + + + + + Gets maximum row and column count for specific version. + + + + + + + + Copies one stream into another. + + Source stream to copy from. + Destination stream to copy into. + + + + Creates copy of the MemoryStream. + + Source stream to copy. + A copy of the original MemoryStream. + + + + Creates a XmlReader from data stream. + + Data stream to create reader from. + Xml element tag to return the reader. + Newly created XmlReader from given stream. + + + + Creates xml reader to read data from the stream. + + Data to read. + Created xml reader. + + + + Creates xml reader to read data from the current stream position. + + Data to read. + Created xml reader. + + + + Creates xml reader to read data from the stream. + + Data to read. + Created xml reader. + + + + Creates xml writer to read data from the stream. + + Data to read. + Created xml writer. + + + + Creates xml writer to read data from the stream. + + Data to read. + Created xml writer. + + + + Creates xml writer to read data from the stream. + + Data to read. + Created xml writer. + + + + This class represents an Excel Workbook. + + + + + Represents an MS Excel Workbook. + + + + + Activates the first window associated with the workbook. + + + + + Adds font to the inner fonts collection and makes this font read-only. + + Font to add. + Added font. + + + + Closes the object. + + + + + + + Closes the object. + + If True, all changes will be saved. + + + + Closes the object without saving. + + + + + Closes the object and saves changes into specified file. + + + File name in which workbook will be saved if SaveChanges is true. + + + + + Saves changes to the specified workbook. + + + + + Short variant of SaveAs method. + + + + + + Short variant of SaveAs method. + + + + + + + Save active WorkSheet using separator. + + Path to save. + Current separator. + + + + Method creates a font object based on native font and register it in the workbook. + ] + Native font to get settings from. + Newly created font. + + + + Replaces specified string by data table values. + + String value to replace. + Data table with new data. + Indicates whether field name must be shown. + + + + Replaces specified string by data column values. + + String value to replace. + Data table with new data. + Indicates whether field name must be shown. + + + + Set user color for specified element in Color table. + + Index of Color in array. + New color which must be set. + + + + Method return Color object from workbook palette by its index. + + Index from palette array. + RGB Color. + + + + Gets the nearest color to the specified Color structure + from Workbook palette. + + + Color index from workbook palette. + + + + Method to create a font object and register it in the workbook. + ] + Newly created font. + + + + Sets protection for workbook. + + Indicates if protect workbook window. + Indicates if protect workbook content. + + + + Sets protection for workbook. + + Indicates if protect workbook window. + Indicates if protect workbook content. + Password to protect with. + + + + Creates copy of the current instance. + + Copy of the current instance. + + + + Returns an object that represents the active sheet (the sheet on top) + in the active workbook or in the specified window or workbook. Returns + Nothing if no sheet is active. Read-only. + + + + + Gets / sets index of the active sheet. + + + + + Returns or sets the author of the comment. Read-only String. + + + + + Gets or sets a value indicating whether to display horizontal scroll bar. + + + + + Gets or sets a value indicating whether to display vertical scroll bar. + + + + + Name which is used by macros to access the workbook items. + + + + + True if the workbook uses the 1904 date system. Read / write Boolean. + + + + + True if the precision to be used as displayed. + + + + + True if cell is protected. + + + + + True if window is protected. + + + + + For an Application object, returns a Names collection that represents + all the names in the active workbook. For a Workbook object, returns + a Names collection that represents all the names in the specified + workbook (including all worksheet-specific names). + + + + + True if the workbook has been opened as Read-only. Read-only Boolean. + + + + + True if no changes have been made to the specified workbook since + it was last saved. If current value is false then setting it to true cause Save() method call. + Read/write Boolean. + + + + + Returns a Styles collection that represents all the styles + in the specified workbook. Read-only. + + + + + Returns a Sheets collection that represents all the worksheets + in the specified workbook. Read-only Sheets object. + + + + + True indicate that opened workbook contains VBA macros. + + + + + Get Palette of colors which an Excel document can have. + Here is a table of color indexes to places in the color tool box + provided by Excel application: + -------------------------------------------- + | | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | + ---+---------------------------------------- + |1 | 00 | 51 | 50 | 49 | 47 | 10 | 53 | 54 | + |2 | 08 | 45 | 11 | 09 | 13 | 04 | 46 | 15 | + |3 | 02 | 44 | 42 | 48 | 41 | 40 | 12 | 55 | + |4 | 06 | 43 | 05 | 03 | 07 | 32 | 52 | 14 | + |5 | 37 | 39 | 35 | 34 | 33 | 36 | 38 | 01 | + ---+---------------------------------------- + |6 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | + |7 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | + -------------------------------------------- + + + + + Index of tab which will be displayed on document open. + + + + + Indicates whether exception should be thrown when unknown + name was found in a formula. + + + + + This Property allows users to disable load of macros from + document. Excel on file open will simply skip macros and will + work as if document does not contain them. This options works + only when file contains macros (HasMacros property is True). + + + + + Returns or sets the standard font size, in points. Read/write. + + + + + Returns or sets the name of the standard font. Read/write String. + + + + + Indicates whether to allow usage of 3D ranges in DataValidation + list property (MS Excel doesn't allow). + + + + + Gets / sets row separator for array parsing. + + + + + Formula arguments separator. + + + + + Indicates whether worksheet is displayed right to left. + + + + + Indicates whether tabs are visible. + + + + + Returns collection of tab sheets. Read-only. + + + + + Indicates whether library should try to detect string value passed to Value (and Value2) + property as DateTime. Setting this property to false can increase performance greatly for + such operations especially on Framework 1.0 and 1.1. Default value is true. + + + + + Toggles string searching algorithm. If true then Dictionary will be used + to locate string inside strings dictionary. This mode is faster but uses + more memory. If false then each time string is added to strings dictionary + we will have to iterate through it and compare new strings with existing ones. + Default value is TRUE. + + + + + True to display a message when the file is opened, recommending that the file be opened as read-only. + + + + + Gets / sets password to encrypt document. + + + + + Returns maximum row count for each worksheet in this workbook. Read-only. + + + + + Returns maximum column count for each worksheet in this workbook. Read-only. + + + + + Gets / sets excel version. + + + + + This event is fired after workbook is successfully saved. + + + + + This event is fired when trying to save to a Read-only file. + + + + + Stream name that represent summary name. + + + + + Stream name that represent document summary name. + + + + + Stream name used by new versions of Excel. + + + + + Old styled name of stream in Excel binary file. + + + + + Name of sub-storage in input file which contains macros of opened file. + + + + + Sub-storage of Macros storage. Used for checks is file format correct + or not. + + + + + Self-referential external reference. + + + + + File name has been excoded. + + + + + Reference to an empty workbook name. + + + + + Represents an MS-DOS drive letter. It is followed by the drive letter. + For example, the formula ='D:\SALES.XLS'!A1 generates this character key + when the dependent workbook is not on the D drive. UNC file names, such as + \\server\share\myfile.xls, generate an @ character after this character key; + this replaces the initial double backslash (\\). + + + + + Indicates that the source workbook is on the same drive as the + dependent workbook (the drive letter is omitted). For example + the formula ='\SALES.XLS'!A1 generates this key when + the dependent workbook is not in the root directory. + + + + + Indicates that the source workbook is in a subdirectory of the current directory. + For example, the formula ='XL\SALES.XLS'!A1 generates the DEF_CHAR_DOWNDIR key. + The subdirectory name precedes the DEF_CHAR_DOWNDIR key, and the file + name follows it. + + + + + Indicates that the source workbook is in the parent directory of the current directory. + For example, the formula ='..\SALES.XLS'!A1 generates the DEF_CHAR_UPDIR key. + + + + + Not used. + + + + + Indicates that the source workbook is in the startup directory + (the Xlstart subdirectory of the directory that contains Excel.exe). + + + + + Indicates that the source workbook is in the alternate startup directory. + + + + + Indicates that the source workbook is in the Library directory. + + + + + Indicates that path is UNC file name (is replaced by \\). + + + + + Start of the UNC network path. + + + + + Indicates that current workbook is not protected. + + + + + Index of the removed sheet. + + + + + Start of the http url string. + + + + + Defines a new line character + + + + + First user-defined color. + + + + + + + + + + + + + + + + + + + + + + + + + Index of the removed sheet. + + + + + Content type for Excel 97. + + + + + Content type for Excel 2000. + + + + + Content type for Excel 2007. + + + + + Content type for CSV. + + + + + Standard password. + + + + + TextQualifier. + + + + + Default regular expression options. + + + + + Name of the book's group in regular expressions. + + + + + Name of the sheet's group in regular expressions. + + + + + Index of worksheet used for workbook references. + + + + + Name prefix for styles in ignore style mode. + + + + + Text for evaluation warning. + + + + + Name of the expired evaluation sheet. + + + + + First chart color index. + + + + + Last chart color index. + + + + + Separator between worksheets in the cross-worksheet formula (Sheet1:Sheet3!A1). + + + + + Represents the Difference value of 1904 and 1899 date system format. + + + + + + Default theme version on excel workbook 2007 and 2010 + + + + + Defines a default script factor. + + + + + Default Palette colors. + + + + + Records that should be stored in m_arrPivotRecords. + + + + + Regular expression for workbook-worksheet pair. + + + + + Array with streams that shouldn't be copied. + + + + + Array with characters that are reserved. + + + + + + + + + + + + + + + Default theme colors. + + + + + + Indicates whether all the formula in the workbook is evaluated. + + + + + Used to store records which belong to the Workbook part. + Temporary array which must be cleaned after read/parse operations. + + + + + Active sheet in the current workbook. + + + + + Returns a Sheets collection that represents all the worksheets + in the specified workbook. Read-only Sheets object. + + + + + Styles collection that represents all the styles + in the specified workbook. + + + + + Storage of all Fonts created in a workbook. + + + + + Storage of all ExtendedFormats created in a workbook. + + + + + Storage of NameRecords. + + + + + New value changes for the format Record + + + + + Collection of workbook's formats. + + + + + Storage of BoundSheet records. Is a temporary storage which + after read / parse operations must be cleaned. + + + + + Dictionary which is used for storage of SST strings. + + + + + Collection contains all SupBookRecords. + + + + + Represents the continuity of ExternSheet record + + + + + List of the ranges that should be reparsed. + + + + + Full name of the file where workbook was saved or loaded. + + + + + True if the workbook uses the 1904 date system. + + + + + True if workbook uses Precision + + + + + True if the workbook has been opened as Read-only. + + + + + True if no changes have been made to the specified workbook since + it was last saved. Read / write Boolean. + + + + + + + + + + Indicates whether workbook is in loading state. + + + + + Indicates whether workbook is in saving state. + + + + + True if cells are protected. + + + + + True if window is protected. + + + + + Default name of workbook used by macros. + + + + + True if pivot table Fields lists are hidden + + + + + Indicates default theme version for wokbook. + + + + + True - indicates that current workbook contains macros sub-storage. + + + + + True - indicates that current workbook contains summary information. + + + + + True - indicates that current workbook contains document summary information. + + + + + True - indicate that macros exists in document and they + are disabled, otherwise False. + + + + + Stores current workbook's palette. + + + + + True- indicates that user used custom palette instead of the default. + + + + + Window one record for the workbook. + + + + + Collection of all Name objects defined in the workbook + + + + + Collection of all Chart objects of the workbook. + + + + + Collection of Charts and Worksheets objects. + + + + + One of protection records. + + + + + One of protection records. + + + + + One of protection records. + + + + + + + + + + Data needed by workbook shapes (unique images and other things). + + + + + First unused color (color that wasn't redefined yet). + + + + + Current object id. + + + + + First free shape id. + + + + + + + + + + List of ExtendedXF Format record + + + + + + + + + + + Indicates whether to allow usage of 3D ranges in DataValidation + list property (MS Excel doesn't allow). + + + + + Collection of extern workbooks. + + + + + Collection of header / footer pictures. + + + + + Calculation options. + + + + + Workbook level Conditional Priority count. + + + + + Formula parser. + + + + + Represents group of selected worksheets. + + + + + Indicates whether original worksheet contains duplicated names. + + + + + Indicates whether workbook is write protected. + + + + + File sharing record. + + + + + Indicates whether library should try to detect string value passed to Value (and Value2) + property as DateTime. Setting this property to false can increase performance greatly for + such operations especially on .Net Framework 1.0 and 1.1. Default value is true. + + + + + Size of the default character measured using first function. + + + + + Size of the default character measured using second function. + + + + + Password used to encrypt document. + + + + + Encryption type. + + + + + Document id. + + + + + Maximum row count for each worksheet in this workbook. + + + + + Maximum column count for each worksheet in this workbook. + + + + + Maximum possible number of extended formats. + + + + + Maximum possible indent value. + + + + + Current excel version. + + + + + Default XF index. + + + + + File data holder, used to store data for Excel 2007 format. + + + + + Maximum digit width (used to evaluate different column width) + + + + + Workbook's heap handle. + + + + + This field is used to preserve BookExt record. + + + + + Contains list of theme colors. + + + + + Unparsed controls stream. + + + + + Maximum used table index. + + + + + Country code. + + + + + Stream contains custom table styles + + + + + Indicates whether workbook was loaded or it is created. + + + + + Indicates whether the theme colors of the workbook is parsed or not + + + + + Represents the Compatibility record + + + + + Represents the Shared string stream + + + + + Represents whether workbook has Inlinestring. + + + + + Preserves the pivot cache. + + + + + Store the font indexes. + + + + + Represents the Excel Parse Options. + + + + + Preserves the unique styles cells count. + + + + + Boolean that represent the extended format CRC value status. + + + + + Extended format CRC value. + + + + + Find the beginning version of excel + + + + + + + + + + Preserves the child element in the document management properties. + + + + + Illegal xml character defined names count. + + + + + Connection Support for Excel2003 + + + + + Represents to parse sheet on demand + + + + + Calc Identifier. + + + + + Preserves the DDE type link in workbook + + + + + Alogrithm name to protect/unprotect Workbook. + + + + + Hash value to ensure the workbook protected password. + + + + + Random generated Salt for the workbook password. + + + + + Spin count to loop the hash algorithm. + + + + + Custom date patterns in excel + + + + + Date time pattern for the current culture with custom date pattern + + + + + OfficeSheetType-to-Name. + + + + + Returns theme color by its index. + + + + + + + Returns theme color by its index on ExcelVersion 2013. + + index value on list of colors + the Color value + + + + Creates extended format record and registers it in workbook. + + Indicates whether to force add to collection. + Newly created extended format. + + + + Creates extended format based on baseFormat and registers it in workbook. + + Base format for the new format. + Indicates whether to force add. + Newly created format. + + + + Creates extended format based on baseFormat without registering it in the workbook. + + Base format for the new format. + Newly created format. + + + + Registers extended format. + + Format to register. + + Format from the collection if there were such format; + otherwise returns format that was added. + + + + + Registers extended format. + + Format to register. + Indicates whether to force format object registration in the collection. + + Format from the collection if there were such format; + otherwise returns format that was added. + + + + + Inserts SupbookRecord describing this workbook. + + + Index to the SupBookRecord that describes current workbook. + + + + + Adds internal sheet reference. + + Name of the sheet that should be referenced. + Index to the sheet in ExternSheetRecord. + + When can't find specified worksheet in this workbook. + + + + + Adds reference to the extern worksheet. + + + Workbook name (can be null or empty than sheet name is treated as book name. + + Worksheet name. + Index in the ExternSheet record. + + + + Adds internal sheet reference. + + Name of the sheet that should be referenced. + Worksheet to be referenced. + + When can't find specified worksheet in this workbook. + + + + + Adds internal sheet reference. + + Name of the sheet that should be referenced. + Worksheet to be referenced. + + When can't find specified worksheet in this workbook. + + + + + Adds internal sheet reference. + + Name of the sheet that should be referenced. + Worksheet to be referenced. + + When can't find specified worksheet in this workbook. + + + + + This method adds one TREF structure to the list. + + SUPBOOK index. + Index to first SUPBOOK sheet. + Index to last SUPBOOK sheet. + + Index of the old REF structure (if there was one) + or new REF structure. + + + + + Adds incorrect sheet reference. + + Worksheet to be referenced. + + When can't find specified worksheet in this workbook. + + + + + Decreases index (in ExternSheet record) of all worksheets with index + that is smaller than specified index. + + + + + + Increases index (in ExternSheet record) of all worksheets with index + that is larger or equal than specified index. + + + + + + This method updates external sheet table when a worksheet was moved. + + Old index of the worksheet. + New index of the worksheet. + + + + Updates active sheet index after move operation. + + Old sheet index. + New sheet index. + + + + Gets sheet index after move operation. + + Current sheet index. + Old index of the sheet that was moved. + New index of the sheet that was moved. + New index for current sheet index. + + + + Returns worksheet name. + + Reference to worksheet. + Returns sheet name. + + + + Returns worksheet name. + + Reference to worksheet. + Returns sheet name. + Indicates whether to throw exception if reference index is out of range. + + + + Get name of the external worksheet by reference. + + + + + Get name of the internal worksheet by reference. + + + + + Returns worksheet by its reference index. + + Reference index of the sheet. + Found worksheet. + + When can't find referenced worksheet. + + + + + Returns worksheet by its reference index. + + Reference index of the sheet. + + Indicates whether to throw exception when can't + find worksheet with specified index. + + Found worksheet. + + When can't find referenced worksheet. + + + + + Check for internal Reference; If external - rise NotSupported exception. + + Ref index. + + + + Indicates whether reference is reference to local worksheet. + + Reference index. + Value that indicates whether reference is reference to local worksheet. + + + + + + + + + + + Inserts reparse into array of object that should be reparsed + when loading will be complete. + + Object that will be reparsed later. + + + + Returns number from the style name, i.e. Normal_1 result is 1. + + Style name. + Parsed number. + + + + Raises argument to the second power. + + Value to be squared. + Squared value. + + + + Calculates distance between two colors. + + First color. + Second color. + Distance between two colors. + + + + Clears collection of references. + + + + + Raises FileSaved event. + + + + + Raises OnReadOnlyFile event. + + + + + + + + + + + + Returns extern workbook index by reference index. + + Reference index. + Extern workbook index. + + + + Returns external sheet object by reference index. + + Reference index. + External worksheet that corresponds to the specified reference index. + + + + Decodes name encoded in supbook. + + Name to decode. + Decoded name. + + + + Modifies record in skip styles mode. + + Record to modify. + Boolean value indicating that record should be added to the array. + + + + Modifies record in skip styles mode. + + Records to modify. + + + + Adds licensing worksheet if necessary. + + + + + Checks whether workbook contains licensing worksheet and removes it. + + + + + Checks whether protected content is correct. + + Worksheet to check. + True if content is correct. + + + + Optimizes internal references by removing unused ones. + + + + + Updates reference indexes. + + Array with updated indexes. + + + + Static constructor. + + + + + Base constructor which must be used when workbook is created + from scratch (maybe clipboard data)and not from file. + + Application object for the workbook. + Parent object for the workbook. + Excel version. + + + + Creates workbook with specific number of worksheets. + + Application object for the workbook. + Parent object for the workbook. + Quantity of empty worksheets to create. + Excel version. + + + + Create Workbook from file. + + Application object for the workbook. + Parent object for the workbook. + Name of the file with workbook. + Excel version. + + When can't find workbook stream in the file. + + + + + Create Workbook from file. + + Application object for the workbook. + Parent object for the workbook. + Name of the file with workbook. + Parse options. + Excel version. + + When can't find workbook stream in the file. + + + + + Create Workbook from file. + + Application object for the workbook. + Parent object for the workbook. + Name of the file with workbook. + Parse options. + Indicates whether to open workbook in read-only mode. + Password to decrypt workbook stream. + Excel version. + + When can't find workbook stream in the file. + + + + + Initializes a new instance of the class. + + Application object for the workbook. + Parent object for the workbook. + Name of the file with workbook. + Parse options. + Indicates whether to open workbook in read-only mode. + Password to decrypt workbook stream. + Excel version. + + When can't find workbook stream in the file. + + + + + Create WorkBook from file. + + Application object for the workbook. + Parent object for the workbook. + Stream to open. + Current separator. + Number of first row to write. + Number of first column to write. + Excel version. + Filename is used to generate worksheet name + + + + Create Workbook from stream. + + Application object for the workbook. + Parent object for the workbook. + Stream that contains workbook's data. + Parse options. + Excel version. + + When specified stream is NULL. + + + + + Parses new workbook from xml stream. + + Current application + Parent object. + Xml reader. + Xml open type. + + + + Initializes all internal collections. + + + + + Fills collection with default formats, extended format, and styles. + + + + + Inserts all default extended formats into special list. Excel has 21 + default formats for each workbook. + + + + + Inserts all default styles into special list. + + + + + Inserts all default styles into special list. + + Styles that were read from file. + + + + Registers default style inside styles collection. + + Style to register. + + + + + + + + + + + Gets file name with extension from the path. + + Url to get name from. + File name without extension from the path. + + + + Gets create workbook name. + + Workbook to get name from. + Workbook name. + + + + + + + + + + + + + + + + Compares two style records. + + First style record to compare. + Second style record to compare. + True if records describe same default style. + + + + Inserts default fonts into special list. + + + + + Disposes internal collections. + + + + + Clears all internal collections. + + + + + Clears the extended formats. + + + + + This method parses stream that holds data in Excel 2007 format (Open XML). + + Stream to parse. + Password to use during for decryption. + + + + Parses specified file. + + File to parse. + Password to use for decryption (null if file is not encrypted). + Excel version. + Parsing options. + + + + Parses specified stream. + + Stream to parse. + Password to use for decryption (null if file is not encrypted). + Excel version. + Parsing options. + + + + Class finalizer. + + + + + + Recheck the Format Record + + + + + Normalizes border settings for specified extended format record in some incorrect files. + + ExtendedFormatRecord to process. + + + + Prepares fonts, formats and styles collections. + + Indicates whether parsing is made in ignore styles mode. + List with all styles. + Dictionary with new extended format indexes for ignore styles mode. + + + + Prepares extended format records. + + + + + Parses all worksheets, charts, etc. on demand + + + + + Creates all necessary styles for the workbook. + + Array of all read StyleRecords. + + + + Searches StyleRecord for the specified index of the Extended + Format record in the list. + + List that contains StyleRecord. + Index of the Extended Format. + + Found style index (if it is greater or equal to zero than it is index + from arrStyles array; otherwise it is evaluated as index in arrDefaultStyles + increased by 1 and multiplied by -1. + . + + + + Returns array of default styles. + + Array of StyleRecords with default styles. + + + + Creates style each number format. + + + Dictionary with new extended format indexes. + + + + + Activates the first window associated with the workbook. + + + + + Closes the object and saves changes into specified file. + + + File name in which workbook will be saved if SaveChanges is true. + + + + + Closes the object. + + If True, all changes will be saved. + + File name in which workbook will be saved if SaveChanges is true. + + + + + Closes the object. + + If TRUE all changes will be saved + + + + Closes the object without saving. + + + + + Saves changes to the specified workbook. + + + If file name was not specified before. + + + + + Short variant of SaveAs method. + + + Name of the file into which workbook will be saved. + + + When FileName is NULL. + + + When FileName is empty. + + + + + Short variant of SaveAs method. + + + Name of the file into which workbook will be saved. + + Options for save. + + When FileName is NULL. + + + When FileName is empty. + + + + + Short variant of SaveAs method. + + + Name of the file into which workbook will be saved. + + Options for save. + Excel version that should be used. + + When FileName is NULL. + + + When FileName is empty. + + + + + Prepares shapes for serialization. + + + + + Registers new shapes (that have no shapeId yet) inside shapeIdReserver. + + IdReserver that helps in the id generation process. + Delegate used to get necessary shapes collection from a TabSheet. + + + + Updates shapes that were added after last save operation. + + IdReserver that helps in the id generation process. + Delegate used to get necessary shapes collection from a TabSheet. + + + + Assigns indexes to the new shapes. + + IdReserver that helps in the id generation process. + Shape collection to process. + + + + Gets number of free indexes inside currently allocated/reserved ids. + + IdReserver that helps in the id generation process. + Shape collection to process. + Number of free indexes inside currently allocated/reserved ids. + + + + Evaluates number of shapes without assigned id. + + Shape collection to check. + Number of shapes without assigned id. + + + + Registers absolutely new shape collections using IdReserver. + + IdReserver that helps in the id generation process. + Delegate used to get necessary shapes collection from a TabSheet. + + + + Allocates and assigns indexes for all shapes inside shape collection. + + IdReserver that helps in the id generation process. + Shape collection to process. + + + + Creates IdReserver based on the current shapes. + + Delegate used to get necessary shapes collection from a TabSheet. + IdReserver filled with current shape id's data. + + + + Re-indexes shape collections if necessary. + + Delegate used to get necessary shapes collection from a TabSheet. + True if there are shapes inside the workbook. + + + + Returns sheet's shapes collection. + + TabSheet to get collection from. + Extracted collection. + + + + Returns header/footer shapes collection. + + TabSheet to get collection from. + Extracted collection. + + + + Save active WorkSheet using separator. + + Path to save. + Current separator. + + + + Set user color for specified element in Color table. + + Index of Color in array. + New color which must be set. + + + + Method return Color object from workbook palette by its index. + + Index from palette array. + RGB Color. + + + + Gets the nearest color to the specified Color structure + from Workbook palette. + + Color to look for. + Color index from workbook palette. + + + + Gets the nearest color to the specified Color structure + from Workbook palette. + + Color to look for. + Start index. + Color index from workbook palette. + + + + Replaces specified string by data table values. + + String value to replace. + Data table with new data. + Indicates whether field name must be shown. + + + + Replaces specified string by data column values. + + String value to replace. + Data table with new data. + Indicates whether field name must be shown. + + + + Method to create a font object and register it in the workbook. + ] + Newly created font. + + + + Method creates a font object based on native font and register it in the workbook. + ] + Native font to get settings from. + Newly created font. + + + + Adds font into collection. + + Font to add. + + Current font with correct font index, or same font from the collection if was added before. + + + + + Method that creates font object based on another font object + and registers it in the workbook. + + Base font for the new one. + Newly created font. + + + + Method that creates font object based on another font object + and registers it in the workbook. + + Base font for the new one. + Indicates whether font should be added to the collection. + Newly created font. + + + + Sets protection for workbook. + + Indicates if protect workbook window. + Indicates if protect workbook content. + + + + Sets protection for workbook. + + Indicates if protect workbook window. + Indicates if protect workbook content. + Password to protect with. + + + + Creates copy of the current instance. + + Copy of the current instance. + + + + Creates copy of the palette. + + Copy of the palette. + + + + Saves workbook data in Excel 2007 format into specified stream. + + Stream to save into. + Represents type of the saving document (on the current + moment supported values are template or ordinary document). + + + + Creates serializator that can be used to serialize workbook into file or stream. + + Version that must be used to serialize workbook. + Created serializator. + + + + This method changes internal styles structure for Excel 97. + + + + + + + + + + + + + + + + + This method checks whether we must change styles model from 2007 into 97 format + (if document (or file) was created by XlsIO we don't need to change styles). + + True if additional styles must be added for Excel 97. + + + + + + + + + + + Converts extended format colors. + + + + + + + Reduces font count based by switching all colors into indexed color mode. + + List with new font indexes. + + + + Reads the complete stream and retruns false if the doument is notvalid. + + Read to get data from. + Separator between cell values. + Encoding scheme for the StreamReader. + boolean value. + + + + Serialize workbook for the clipboard. + + Record's list to serialize into. + Worksheet to serialize. + + + + Sets active worksheet. + + Worksheet that will be activated. + + + + Sets Saved flag to the False state. + + + + + Updates string indexes. + + List with new indexes. + + + + Looks through all records and calls AddIncrease for each LabelSST record. + + + + + Updates indexes in all records accordingly to the new maximum count property. + + New value of maximum possible XF index. + + + + Indicates whether specified xf index differs from the default one. + + XFIndex to check. + True if there is no difference. + + + + Evaluates maximum digit width of the font for Normal style. + + Maximum digit width of the font for Normal style. + + + + Evaluates maximum digit width of the font for Normal style. + + Maximum digit width of the font for Normal style. + + + + Evaluates maximum digit width of the specified font. + + Font to measure. + Maximum digit width of the specified font. + + + + Gets maximum digit height. + + Font to get digit height for. + Maximum digit height. + + + + Updates width from the rectangle. + + Current rectangle. + Current maximum value. + + + + Updates height from the rectangle. + + Current rectangle. + Current maximum value. + + + + Measures all digits using specified font and calls digitProcessor passing measurement results. + + Font to use. + DigitProcessor to call. + Value returned by digitProcessor after processing all digits. + + + + Converts column width in characters into column width in file. + + Column width in characters. + Column width in file. + + + + Convert column width that is stored in file into pixels. + + Column width in file. + Column width in pixels. + + + + Converts column width in pixels into column width in characters. + + Column width in pixels. + Column width in characters. + + + + + + + + + + + CRC checksum calculation + + + + + Add list of extended properties into XF extended record. + + + + + Add extended property into list. + + + + + Get extended property type. + + + + + Convert ARGB to RGBA. + + + + + Convert ARGB to RGBA. + + + + + Convert Color object to unsigned integer. + + + + + Convert unsigned integer to Color object. + + + + + Whether a given character is allowed by XML 1.0. + + + + + Remove illegal xml character which is not allowed by XML 1.0. + + + + + Find the font object style. + + The cell text + The rich text string + RTF Collection + The excel font + + + + + Update the rtf text. + + XlsIO font. + Pdf font collection. + DrawString Collection. + RTF text. + + + + Indicates whether the text is null or whitespace. + + The text. + returns true if the text is null or whitespace otherwise false. + + + + To get the cell scaled height. + + The cell font name. + The cell font size. + + + + To update the cell scaled width and height. + + scale[0] refers to the cell width. + scale[1] refers to the cell height + + + + Gets the system font from XlsIO font. + + XlsIO font. + returns system font. + + + + Gets the system font from XlsIO font. + + XlsIO font. + New font name for the font object. + returns system font. + + + + Gets the font style. + + XlsIO font. + return font style. + + + + Gets the font size. + + XlsIO font. + returns font size based on superscript and subscript. + + + + Returns an object that represents the active sheet (the sheet + on top) in the active workbook or in the specified window or + workbook. Returns Nothing if no sheet is active. Read-only. + + + + + Preserves the DDE type links in workbook + + + + + Gets / sets index of the active sheet. + + + + + Returns or sets the author of the comment. Read / write String. + + + + + Name which used by macros to access to workbook items. + + + + + Indicates whether pivot table fields option is hidden or not. + + + + + Indicates default theme version for wokbook + + + + + True if the workbook uses the 1904 date system. Read / write Boolean. + + + + + True if the workbook uses precision. + + + + + True if cells are protected. + + + + + True if window is protected. + + + + + For an Application object, it returns a Names collection that represents + all the names in the active workbook. For a Workbook object, it returns + a Names collection that represents all the names in the specified + workbook (including all worksheet-specific names). + + + + + True if the workbook has been opened as Read-only. Read-only Boolean. + + + + + True if no changes have been made to the specified workbook since + it was last saved. If current value is false then setting it to true cause Save() method call. + Read/write Boolean. + + + + + Returns a Styles collection that represents all the styles + in the specified workbook. Read-only. + + + + + Returns a Sheets collection that represents all the worksheets + in the specified workbook. Read-only Sheets object. + + + + + True indicates that opened workbook contains VBA macros. + + + + + Gets a Palette of colors the Excel document can have. + Here is a Table of color indexes their places in the color tool box + provided by XlsIO application: + -------------------------------------------- + | | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | + ---+---------------------------------------- + |0 | 00 | 51 | 50 | 49 | 47 | 10 | 53 | 54 | + |1 | 08 | 45 | 11 | 09 | 13 | 04 | 46 | 15 | + |2 | 02 | 44 | 42 | 48 | 41 | 40 | 12 | 55 | + |3 | 06 | 43 | 05 | 03 | 07 | 32 | 52 | 14 | + |4 | 37 | 39 | 35 | 34 | 33 | 36 | 38 | 01 | + ---+---------------------------------------- + |5 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | + |6 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | + -------------------------------------------- + + + + + Index of the tab which will be displayed on document open. + + + + + + + + + + Gets or sets the value to display horizontal scrollbar + + + + + Gets or sets the value to display vertical scrollbar + + + + + This Property allows users to disable load of macros from + document. Excel on file open will simply skip macros and will + work like document does not contains them. This options works + only when file contains macros (HasMacros property is True ). + + + + + Returns or sets the standard font size. Read/write. + + + + + Returns or sets the name of the standard font. Read/write String. + + + + + Indicates whether to allow usage of 3D ranges in DataValidation + list property (MS Excel doesn't allow). + + + + + Gets / sets row separator for array parsing. + + + + + Formula arguments separator. + + + + + Indicates whether worksheet is displayed right to left. + + + + + Indicates whether workbook tabs are visible. + + + + + Returns collection with all tabsheets in the workbook. Read-only. + + + + + Indicates whether library should try to detect string value passed to Value (and Value2) + property as DateTime. Setting this property to false can increase performance greatly for + such operations especially on Framework 1.0 and 1.1. Default value is true. + + + + + Toggles string searching algorithm. If true then Dictionary will be used + to locate string inside strings dictionary. This mode is faster but uses + more memory. If false then each time string is added to strings dictionary + we will have to iterate through it and compare new strings with existing ones. + Default value is TRUE. + + + + + True to display a message when the file is opened, recommending that the file be opened as read-only. + + + + + Gets / sets password to encrypt document. + + + + + Returns maximum row count for each worksheet in this workbook. Read-only. + + + + + Returns maximum column count for each worksheet in this workbook. Read-only. + + + + + Returns maximum possible number of extended formats. Read-only. + + + + + Gets maximum possible indent value. Read-only. + + + + + Workbook level Conditional Priority count. + + + + + Indicates whether all the formula in the workbook is evaluated. + + + + + Represents the Excel Parse Options. + + + + + gets/ Sets the pivot table last index + + + + + Preserves the pivot cache. + + + + + Store the font indexes. + + + + + /Return file data holder, used to store data for Excel 2007 format. + + + + + Return WorkbookNamesColection from parent WorkBook. + + + + + Returns name of the file the workbook was saved + in last time or loaded from. + + + + + Collection of all fonts used in the workbook. Read-only. + + + + + Collection of all ExtendedFormats used in the workbook. + + + + + Collection of all formats used in the workbook. Read-only. + + + + + SSTDictionary that contains all strings used in the workbook. Read-only. + + + + + Indicates whether workbook is loading. Read-only. + + + + + Indicates whether workbook is in saving process. Read-only. + + + + + Stores the attributes of the workbook window. Read-only. + + + + + Returns count of charts and worksheets in the workbook. + + + + + + + + + + Gets or sets the SST stream. + + The SST stream. + + + + Gets or sets a value indicating whether this instance has inline strings. + + + true if this instance has inline strings; otherwise, false. + + + + + Gets / sets PasswordRecord. + + + + + + + + + + First free shape id. + + + + + + + + + + + + + + + Returns collection of named objects owned by the workbook + (worksheet and charts). Read-only. + + + + + + + + + + Worksheets collection. + + + + + Charts collection. + + + + + Returns collection of external workbooks. + + + + + Returns calculation options. Read-only. + + + + + Returns class for formula parsing. Read-only. + + + + + Returns grouped worksheets. Read-only. + + + + + Indicates whether original file contains duplicated external names. + + + + + Returns data that is shared by all shapes (global options, unique pictures, etc. ). + + + + + Returns data that is shared by all header/footers. + + + + + Gets externSheet record. Read - only. + + + + + Gets / sets internal flag that indicates whether workbook was saved or not. + + + + + + + + + + + + + + + Gets a value indicating whether this Workbook is converted. + + + true if this instance is converted; otherwise, false. + + + + + Gets / sets excel version. + + + + + Returns index to the default extended format. + + + + + Returns internal array with palette colors. Read-only. + + + + + Gets value indicating whether workbook controls stream or not. Read-only. + + + + + Gets value indicating whether workbook controls stream or not. Read-only. + + + + + Gets or sets maximum used table (list object) index. + + + + + Gets value indicating whether workbook was loaded from file or stream. + + + + + Specifies wheather the workbook checks the Compability of earlier version + + + + + Gets or sets a value indicating whether the name ranges has apostrophe. + + + true if this instance has apostrophe; otherwise, false. + + + + + Indicates whether book has oleObjects + + + + + Indicates whether Ole Objects are copied + + + + + Gets or sets boolean value to parse worksheets on demand + + + + + Alogrithm name to protect/unprotect workbook. + + + + + Hash value to ensure the workbook protected password. + + + + + Random generated Salt for the workbook password. + + + + + Spin count to loop the hash algorithm. + + + + + This event is fired after workbook is successfully saved. + + + + + This event is fired when user tries to save into read-only file. + + + + + Gets or sets standard ( default ) row height of all the worksheets. + in points. Double. + + + + + Contains the Date Time patterns od the current culture with date custom format + + + + + Delegate used for digit size evaluation. + + Rectangle containing current digit size. + Current maximum value. + + + + Summary description for WorkbookShapeDataImpl. + + + + + Array of blips that should be parsed by MsoMetafilePicture. + + + + + Contains all workbook's pictures. + + + + + Drawing group not parsed records. + + + + + Parent workbook. + + + + + Dictionary, key - image hash (ArrayWrapper), value - MsofbtBSE structure that describes + + + + + Shape getter. + + + + + Last used worksheet shapes collection id. + + + + + Dictionary blip type - to - Instance, RequiredMac, RequiredWin32, subrecord type values. + + + + + Preserved Clusters. + + + + + Indexed Pixel Types and not supported image format + + + + + Static constructor. + + + + + Initializes new instance. + + Application object for the new instance. + Parent object for the new instance. + Shape getter to use for retrieving shapes from worksheet. + + + + Searches for all necessary parent objects. + + + + + Adds picture to the storage. + + Picture to add. + Desired image format. + Name of the picture. + Number of pictures after adding new picture (blip id). + + + + Adds picture to the storage. + + Picture to add. + Number of pictures after adding new picture.. + + + + Returns picture record. + + Picture index. + Picture record. + + + + Removes picture from this collection. + + Picture id to remove. + Indicates whether to remove image (not picture + shape) from workbook if we didn't detect any reference to it. + + + + Clears all internal data. + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Registers new shapes collection. + + + + + + Converts image format into blip type. + + Format to convert. + Returns appropriate image format. + + + + Converts image format into blip type. + + Format to convert. + Desired image format. + + + + + Indicates whether blip is bitmap blip. + + Blip type to check. + True if specified blip is bitmap blip; False otherwise. + + + + Returns BlipParams for picture record. + + MsofbtBSE record to set fields. + BlipParams for picture record. + + + + List with all pictures. Read-only. + + + + + Indicates whether this mso drawing group has to be serialized. + + + + + Contains information about different properties of image. + + + + + Instance property value. + + + + + ReqMac property value. + + + + + ReqWin32 property value. + + + + + SubRecordType property value. + + + + + + + + + + + + + + Indicates if there is formula record. + + Worksheet to get data for. + Represents row index. + Represents column index. + Indicates whether cell contains formula record. + + + + Returns row from the collection or creates one if necessary. + + Worksheet to get row from. + Zero-based row index. + Indicates whether to create row if it doesn't exist. + Desired row object. + + + + Gets row information. + + One-based row index. + Row information. + + + + Updates FirstColumn and LastColumn indexes. + + Column that was accessed. + + + + Updates FirstRow and LastRow indexes. + + Row to access. + + + + Represents a worksheet. The Worksheet object is a member of the + Worksheets collection. The Worksheets collection contains all the + Worksheet objects in a workbook. + + + + + Default character (for width measuring). + + + + + One degree in radians. + + + + + Maximum column width. + + + + + Width of the zero character. + + + + + Default size for the dictionary of ranges. + + + + + Default size of autofilter arrow width. + + + + + Represents indent width. + + + + + + Maximum OleDateValue + + + + + Represents the Carriage Return character. + + + + + Represents the Carriage new line character. + + + + + Microsoft Excel. + + + + + Default number format index for date. + + + + + Indicates whether this instance has Alernate Content. + + + + + Represents the object associated with implementation + + + + + Indicate the shapes are able to copy for sorting + + + + + Collection of all pictures in the worksheet. + + + + + Enables the calculation support. + + Enabling this method will initialize objects and retrieves calculated values of formulas in a worksheet. + + + + + Create and update named ranges + + + + + Update external formula. + + + + + Gets the position of array record position of the cell. + + Input row + Input column + Height to be considered + Width to be considered + Sheet reference to be considered + Returns Array Record Position + + + + Get external worksheet. + + + + + Try to Get Identifier of given formula. + + Workbook. + Formula to updated. + the boolean value, indicates whether the formula is updated + + + + Try to Get Identifier of given formula. + + External workbook. + Identifier to get. + Sheet index to get. + the boolean value, indicates whether the Identifier is updated + + + + Gets external worksheet index from the specified external workbook. + + worksheet name to search. + External workbook. + External worksheet index. + + + + Checked whether the string is a cell range or not. + + workbook. + string to check. + True if the string is cell range, otherwise false + + + + Raises the event. + + The row of the change. + The column of the change. + The changed value. + + + + Returns the formula string if the cell contains a formula, or the value if + the cell cantains anything other than a formula. + + The row of the cell. + The column of the cell. + The formula string or value. + + + + Sets the value of a cell. + + The value to be set. + The row of the cell. + The column of the cell. + + + + Not implemented. + + + + + Array with autofilter record types. + + + + + Represent the Unsupported forumulas. + + + + + Represents to parse sheet on demand + + + + + Range that contains all used cells. + + + + + The dictionary holds a records objects, representing each cell. + Holds information about used cells only. + Key - cell index. + Value - corresponding BiffRecordRaw. + + + + + In the dictionary store, where ColumnIndex-to-ColumnInfoRecord. + Column Index is started from 1. + + + + + Indicates whether page breaks should be displayed. + + + + + Object that contains information about page setup, i.e. + paper size, paper orientation, footers, headers, etc. + + + + + Standard column width. + + + + + Object that contains all merged regions of the worksheet. + + + + + Array store containing all selection records. + + + + + + + + + + Collection of all names defined in the worksheet (like named ranges). + + + + + Type of the worksheet. + + + + + Indicates if values are preserved as strings. + + + + + Array of all records for autofilter. + + + + + SortedList with all NoteRecords. + + + + + Notes sorted by cell index, key - cell index, value - note record. + + + + + + + + + + Contains all worksheet's sort records. + + + + + Start index for pivot table records. + + + + + Start index for hyperlinks records. + + + + + Start index for conditional formatting records. + + + + + Start index for data validation formatting records. + + + + + Start index of custom properties block. + + + + + DCon records. + + + + + Migrant range - row and column of this range object can be changed by user. + + + + + There are two different algorithms to create UsedRange object: + 1) Default. This property = true. The cell is included into UsedRange when + it has some record created for it even if data is empty (maybe some formatting + changed, maybe not - cell was accessed and record was created). + 2) This property = false. In this case XlsIO tries to remove empty rows and + columns from all sides to make UsedRange smaller. + + + + + Indicates to include the CFRange in UsedRange. + + + + + Contains settings of string preservation for ranges. + + + + + Object used for shape coordinates evaluation on loading. + + + + + List with preserved table object's records. + + + + + To set Ishidden property + + + + + For Zeroheight attribute to enable or disable + + + + + Specifies the number of characters of the maximum digit width of the normal style's font. + + + + + 'True' if rows have a thick bottom border by default. + + + + + 'True' if rows have a thick top border by default. + + + + + Highest number of outline levels for columns in this sheet. + + + + + Default column width of sheet. + + + + + Highest number of outline level for rows in this sheet. + + + + + List of Outline Wrappers collection + + + + + Represents the Column group outline dictionary collection + + + + + Represents the row group outline dictionary collection + + + + + Represents the Collection of InlineStrings + + + + + Preserves the External connection setting in the worksheet. + + + + + Preserves the pivot tables. + + + + + Stream to preserve the worksheet slicer + + + + + Represents a formula string for external links + + + + + Represents the Data table export + + + + + + + + + + Creates worksheet and set its Application and Parent + properties to specified values. + + Application object for the worksheet. + Parent object for the worksheet. + + + + Initializes all inner data such as Comments collection, + Page setup, etc. + + + + + Clear all internal collections. + + + + + Clear all internal collections. + + Allows to avoid clearing of some properties. + + + + Copies names from another worksheet. + + Worksheet to copy names from. + Dictionary with new worksheet names. + Dictionary, key - old name index, value - new name index. + Represents hash table with new extern sheet indexes. + + + + Searches for all used named range objects. + + Dictionary where key means named range index. + + + + Copies row height. + + Source worksheet. + Dictionary with new extended format indexes. + + + + Copies autofilters. + + Base worksheet. + + + + Copies column width. + + Source worksheet. + Array with new extended format indexes. + + + + Returns true if specified column index can be found inside list of columns with default width. + + List of columns with default width (sorted). + Start index in the list. + Column index to check. + True if specified column index can be found inside list if columns. + + + + Updates indexes of extended formats. + + Collection with IOutline elements that should be updated. + Source worksheet. + Dictionary with new extended format indexes. + + + + Updates indexes of extended formats. + + Collection with IOutline elements that should be updated. + Source worksheet. + Dictionary with new extended format indexes. + Indicates whether update default format index. + + + + Updates indexes of extended formats. + + Collection with IOutline elements that should be updated. + Array with new extended format indexes. + + + + Creates columns on update. + + Represents column collection. + Represents new XF indexes. + List of columns that had default column width and were create by this method. + Items in this list are placed in ascending order. + + + + Copies merged regions. + + Source worksheet. + + + + + + + + + + + + + + This method is called during dispose operation. + + + + + Copies page setup from another worksheet. + + Worksheet to copy from. + + + + Updates style indexes. + + Array with changed style indexes. + + + + Indicates whether to parseCF or not. + + + + + Gets object that is clone of current worksheet in the specified workbook. + + Dictionary with update worksheet names. + New workbook object. + Object that is clone of the current worksheet. + + + + This method should be called immediately after extended format removal. + + Dictionary with updated extended formats. + + + + This method updates indexes to the extended formats after version change. + + New restriction for maximum possible XF index. + + + + Creates Rtf string for LabelSST record. + + Cell index. + Created rtf string. + + + + Returns found values or null. + + Storage range. + Value for finding. + If true - finds as error; otherwise as bool value. + If true - finds first value; otherwise - all values. + If findfirst - true then returns range; otherwise - array with all found values. + + + + Returns found values or null. + + Storage range. + Value for finding. + Finding flags. + If true - finds first value; otherwise - all values. + If findfirst - true then returns range; otherwise - array with all found values. + + + + Returns found values or null. + + Storage range. + Value for finding. + If true - finds first value; otherwise - all values. + If findfirst - true then returns range; otherwise - array with all found values. + Range array with found values. + + + + Returns found values or null. + + Storage range. + Value for finding. + If true - finds first value; otherwise - all values. + If findfirst - true then returns range; otherwise - array with all found values. + Range array with found values. + + + + Removes all formulas in colRemove from internal ArrayFormula collection. + + Formulas to remove. + Indicates whether to clear range before remove operation. + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + Autofits row. + + Row index. + + + + Autofits column. + + Column index. + + + + Copies all data from another worksheet. + + Parent worksheet. + Dictionary with style names. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Copy flags. + + Dictionary with new extended format indexes. + + Dictionary with new name indexes. + Represents collection with extern sheets indexes. + + + + Copies all table objects. + + Worksheet to copy table objects from. + + + + Gets range from string value. + + Range value represented in string. + Extracted Range. + + + + Returns string index of the specified cell. + + Cell index to locate. + String index of the specified cell. + + + + Returns TextWithFormat object corresponding to the specified cell. + + Cell index. + TextWithFormat object corresponding to the specified cell. + + + + Returns extended format for specified cell. + + Cell index. + Extended format for specified cell. + + + + Sets string index in the specified cell. + + Cell index to set sst index in. + SST index to set. + + + + Updates string indexes. + + List with new indexes. + + + + Sets active cell + + Cell to activate. + + + + Sets active cell + + Cell to activate. + + + + Gets selection with active cell. + + + + + + Returns active cell. + + Currently active cell. + + + + Tells whether specific FormulaRecord is array-entered formula. + + FormulaRecord to check. + True if it is array-entered formula. + + + + Returns height from RowRecord if there is a corresponding RowRecord. + Otherwise returns StandardHeight. + + One-based index of the row + Indicates whether to raise events on row autofitting. + + Height from RowRecord if there is corresponding RowRecord. + Otherwise returns StandardHeight. + + + + + Creates copy of the current object. + + Parent object for the new object. + Indicates whether we should clone shapes or not. + Copy of the current object. + + + + Looks through all records and calls AddIncrease for each LabelSST record. + + + + + Gets string preservation option for the range. + + Range to get value for. + True if strings are preserved for all cells of the range, + false - if it is not preserved, + null - undefined or different cells have different values. + + + + Sets the value indicating whether string should be preserved for range. + + Range to set value for. + Value to set. + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Creates default pane. + + + + + Removes required number of last rows from the worksheet. + + Indicates whether to update formulas after row remove. + Number of rows to remove. + + + + Removes all formulas in colRemove from internal ArrayFormula collection. + + Formula to remove. + Indicates whether to clear range before remove operation. + + + + Autofits row. + + Row index. + One-based index of the first column to be used for autofit operation. + One-based index of the last column to be used for autofit operation. + If true then raise events. + + + + Sets inner row height. + + Row index. + Value to set. + If true then bad row height. + Current units. + if true then raise events. + + + + Returns True if row is empty;Checking only for styles. + + One-based row index to check. + True if row is empty. + + + + Returns True if row is empty + + One-based row index to check. + If true - checking for styles and value, otherwise - for value only. + True if row is empty. + + + + Returns True if column is empty. + + One-based column index to check. + True if column is empty. + + + + Indicate if column is empty. + + One-based Column index. + If true - ignore styles. + If true - column is empty. + + + + Parses Range. + + Current Range. + String where parsing is. + Current separator. + Current index of parsing string. + Index of parsed range. + + + + Gets size of string that contain cell found by cellindex. + + Cell index to Autofit. + If true then autofit Rows, otherwise - columns. + RichTextString object to use for text measuring - + to reduce time and memory consumption. + Indicates whether rotation must be ignored. + Returns new size of string. + + + + Updates indent size. + + Represents current size. + Represents extended format. + Returns updated size by indent value. + + + + Updates text width by rotation. + + String size without rotation. + Current rotation. + If true then update height otherwise - width. + Updated width or height. + + + + Copies different sheet options. + + Source sheet. + + + + This method is called after RealIndex property change. + + Old value. + + + + Creates migrant range. + + + + + Copies style from above/below/left/right after insert row/column operation. + + Index where insert operation took place. + Number of inserted rows/columns. + Insert options. + Indicates whether rows where inserted. + + + + Copies row and column settings + + Represents source row. + Represents source column. + Represents row or column + Source index + Current index + Insert option + + + + Calculates row or column index from which style must be copied + into inserted area. + + Row or column index whether insert operation was called. + Number of rows/columns to insert. + Insert options. + Update row or column index. + + + + Gets value from the cell record. + + Cell to get value from. + String representation of the cell's value. + + + + Updates dictionary with outlines after extended format removal. + + Dictionary to update. + Dictionary with updated extended formats. + + + + Converts list of cell indexes into ranges array. + + List of cell indexes. + Array with ranges. + + + + Returns Range which represents specified cell. + + Column index of the cell. + Row index of the cell. + Range which represents specified cell. + + + + Returns Range which represents specified cell. + + Column index of the cell. + Row index of the cell. + Index to extended format for new range. + Range which represents specified cell. + + + + Returns Range which represents specified cell. + + Column index of the cell. + Row index of the cell. + Index to extended format for new range. + Range which represents specified cell. + + + + Converts biff record into range. + + Record to convert. + Created range. + + + + Sets Range which represents specified cell. + + Column index of the cell. + Row index of the cell. + Range which represents specified cell. + + + + Sets cell value. + + One-based column index. + One-based row index. + Record to set into cell. + + + + Returns dimensions of the worksheet. + + Variable that receives index of the first used column. + Variable that receives index of the first used row. + Variable that receives index of the last used column. + Variable that receives index of the last used row. + + + + Updates LabelSST indexes after SST record parsing. + + Dictionary with indexes to update, key - old index, value - new index. + + + + Insert into columns. + + Represents column index. + Represents number of columns to be inserted. + Represents insert options. + + + + Remove from column. + + Represents column index. + Represents number of columns to remove. + Insert Options + + + + Updates coordinates for used range, by removing empty rows and columns if necessary. + + First row to start looking from. + First column to start looking from. + Last row to finish looking at. + Last column to finish looking at. + + + + Checks whether row is empty. + + Row index to check. + True if the whole row is empty. + + + + Checks whether column is empty. + + Column index to check. + True if the whole column is empty. + + + + Creates used range. + + Represents first row of the range. + Represents first column of the range. + Represents last row of the range. + Represents last column of the range. + + + + Prepares protection options before setting protection. + + + + + + + Method opens excel file using separator. + + Stream to reading. + Current separator. + First row to write. + First column to write. + boolen value for the valid document + + + + Read single cell value plus ending separator or new line character if present. + + Read to get data from. + Separator between cell values. + Builder to store temporary results. + Boolean value for the Valid Document. + Extracted cell value. + + + + Checks whether data inside specified string builder ends with specified string. + + Builder to check. + Separator to locate. + True if it ends with specified value. + + + + Read data from reader until it find specified character. + + Reader to read data from. + Character to locate. + Builder to put extracted data into. + BoolenValue for the ValidDocument. + + + + Parses worksheet's data. + + + + + Replaces all shared formula with ordinary formula. + + + + + Parses ColumnInfo record. + + Record to parse. + Indicates whether we should ignore styles settings. + + + + Parses row record. + + Record to parse. + Indicates whether we should ignore styles settings. + + + + Extracts calculation options. + + Position in the records array after extraction. + + + + Extracts page setup from biff records array + + Start index of the first pagesetup record. + + + + Extracts custom properties from the records array. + + Position of the first custom property record. + + + + Returns width from ColumnInfoRecord if there is corresponding ColumnInfoRecord + or StandardWidth if not. + + One-based index of the column. + Width of the specified column. + + + + Converts column width into pixels. + + Column width to convert. + Column width in pixels. + + + + Converts pixels count into column width value. + + Column width in pixels. + Column width. + + + + Returns width displayed by Excel. + + Width written in file. + Width displayed by Excel. + + + + Handler for NameIndexChanged event. + + Event sender. + Event arguments. + + + + Returns record at specified cell index. + + One-based row index. + One-based column index. + Record at specified cell index. + + + + Parses dimensions record. + + Record to parse. + + + + Creates all necessary selection records. + + + + + Re-indexes selection records. + + Dictionary with currently used selection indexes. + + + + Tries to add next pane index if necessary. + + Dictionary with pane indexes that must be present in the file. + Panes that are absent. + Indexes that are currently present. + Pane index to add. + + + + Gets free index for the selection. + + Start index to try. + Dictionary with used indexes. + Unused index that can be used as pane index. + + + + Clears the worksheet. All the data including formatting and merges are removed. + + + + + Clears the data in the worksheet. Only the data in the cells are removed. + The formatting and merges are not removed. + + + + + Indicates whether a cell was initialized or accessed by the user. + + One-based row index of the cell. + One-based column index of the cell. + Value indicating whether the cell was initialized or accessed by the user. + + + + Creates new instance of IRanges. + + New instance of ranges collection. + + + + Shows / Hides the specified column. + + One-based column index to show or hide. + TRUE - show column, FALSE - hide column. + + + + Hides the specified column. + + One-based column index to hide. + + + + Hides the specified row. + + One-based row index to hide. + + + + Shows / Hides the specified row. + + One-based row index to show or hide. + TRUE - show row, FALSE - hide row. + + + + Shows / Hides the specified range. + + Range specifies the particular range to show / hide + True - Range is visible; false - hidden. + + + + Shows/ Hides the collection of range. + + Ranges specifies the range collection. + True - Row is visible; false - hidden. + + + + Shows/ Hides an array of range. + + Ranges specifies the range array. + True - Row is visible; false - hidden. + + + + Method check is Column with specified index visible to end user or not + + Index of column + True - column is visible, otherwise False + + + + Method check is Row with specified index visible to user or not + + Index of row visibility of each must be checked + True - row is visible to user, otherwise False + + + + Returns width in pixels from ColumnInfoRecord if there is corresponding ColumnInfoRecord + or StandardWidth if not. + + One-based index of the column. + Width in Excel units of the specified column. + + + + Returns width in pixels from ColumnInfoRecord if there is corresponding ColumnInfoRecord + or StandardWidth if not. + + One-based index of the column. + Width in pixels of the specified column. + + + + Returns height from RowRecord if there is a corresponding RowRecord. + Otherwise returns StandardHeight. + + One-based index of the row + + Height from RowRecord if there is corresponding RowRecord. + Otherwise returns StandardHeight. + + + + + Returns height from RowRecord if there is a corresponding RowRecord. + Otherwise returns StandardHeight. + + One-based index of the row. + + Height in pixels from RowRecord if there is corresponding RowRecord. + Otherwise returns StandardHeight. + + + + + Imports an array of objects into a worksheet. + + Array to import. + + Row of the first cell where array should be imported. + + + Column of the first cell where array should be imported. + + + TRUE if array should be imported vertically; FALSE - horizontally. + + Number of imported elements. + + + + Checks the string object is a formula. + + The value. + + + + + + + Imports an array of objects into a worksheet. + + Array to import. + + Row of the first cell where array should be imported. + + + Column of the first cell where array should be imported. + + + TRUE if array should be imported vertically; FALSE - horizontally. + + Number of imported elements. + + + + Imports an array of strings into a worksheet. + + Array to import. + + Row of the first cell where array should be imported. + + + Column of the first cell where array should be imported. + + + TRUE if array should be imported vertically; FALSE - horizontally. + + Number of imported elements. + + + + Imports an array of integers into a worksheet. + + Array to import. + + Row of the first cell where array should be imported. + + + Column of the first cell where array should be imported. + + + TRUE if array should be imported vertically; FALSE - horizontally. + + Number of imported elements. + + + + Imports an array of doubles into a worksheet. + + Array to import. + + Row of the first cell where array should be imported. + + + Column of the first cell where array should be imported. + + + TRUE if array should be imported vertically; FALSE - horizontally. + + Number of imported elements. + + + + Imports data from a DataTable into worksheet + + DataTable with desired data + TRUE if column names must also be imported + + Row of the first cell where DataTable should be imported + + + Column of the first cell where DataTable should be imported + + Number of imported rows + + + + Imports data from a DataTable into worksheet + + DataTable with desired data + TRUE if column names must also be imported + + Row of the first cell where DataTable should be imported + + + Column of the first cell where DataTable should be imported + + Maximum number of rows to import + Maximum number of columns to import + Number of imported rows + + + + Imports data from a DataTable into worksheet + + DataTable with desired data + TRUE if column names must also be imported + + Row of the first cell where DataTable should be imported + + + Column of the first cell where DataTable should be imported + + Maximum number of rows to import + Maximum number of columns to import + Array of columns to import. + Indicates whether to preserve column types. + Number of imported rows + + + + Imports data from a DataTable into worksheet + + DataTable with desired data + TRUE if column names must also be imported + + Row of the first cell where DataTable should be imported + + + Column of the first cell where DataTable should be imported + + Maximum number of rows to import + Maximum number of columns to import + Array of columns to import. + Indicates whether to preserve column types. + Indicates whether to serialize the data table directly. + Number of imported rows + + + + Replace the string data type value into SST index. + + DataTable with desired data. + Represents shared string collection. + Date time style index. + + + + Imports data column. + + Data column to import. + Indicates whether to import field names. + Index of the first row. + Index of the first column + Number of imported rows. + + + + Imports array of data columns. + + Data columns to import. + Indicates whether to import field names. + Index to the first row. + Index to the first column. + Number of imported rows. + + + + Intersects two ranges. + + First range to intersect. + Second range to intersect. + Intersection of two ranges or null if there is no ranges intersection. + + When range1 or range2 is null. + + + + + + Replaces specified string by data table values. + + String value to replace. + Data table with new data. + Indicates whether field name must be shown. + + This can be long operation (needs iteration through all cells + in the worksheet). Better use named ranges instead and call + Import function instead of placeholders. + + + + + Replaces specified string by data table values. + + String value to replace. + Data column with new data. + Indicates whether field name must be shown. + + This can be long operation (needs iteration through all cells + in the worksheet). Better use named ranges instead and call + Import function instead of placeholders. + + + + + Removes worksheet from parent worksheets collection. + + + + + + + + + + + Sets column width. + + One-based column index. + Width to set. + + + + Sets column width in pixels. + + One-based column index. + Width in pixels to set. + + + + Save tabsheet using separator. + + File to save. + Current separator. + + + + Save tabsheet using separator. + + File to save. + Current separator. + Encoding to use. + + + + Save tabsheet using separator. + + Stream to save. + Current separator. + + + + Save tabsheet using separator. + + Stream to save. + Current separator. + Encoding to use. + + + + Save tabsheet using separator. + + Stream to save. + Current separator. + Encoding to use. + + + + Imports data table without checking arguments for correctness. + + Data table to import. + Index of the first row to import. + Index of the first column to import. + Maximum number of rows to import. + Maximum number of columns to import. + Array of columns to import. + + + + Imports data table with type preservation, but without checking arguments for correctness. + + Data table to import. + Index of the first row to import. + Index of the first column to import. + Maximum number of rows to import. + Maximum number of columns to import. + Array of columns to import. + + + + Converts object value into RangeProperty enum. + + Value to convert. + Column index in DataRowView. + Dictionary to cache results. + Corresponding RangeProperty. + + + + Raises ColumnWidthChanged event. + + Zero-based column index. + New width value. + + + + Raises RowHeightChanged event. + + Zero-based row index. + New height. + + + + This method is called when normal font changes. + + Event sender. + Event arguments. + + + + Sets the value in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + + Sets the value in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + + Sets the value in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + + Sets the value in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + + Sets text in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Text to set. + + + + Sets formula in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Formula to set. + + + + Sets formula in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Formula to set. + Indicates is formula in R1C1 notation. + + + + Sets blank record into cell with specified row and column. + + Row index. + Column index. + + + + Sets number record into cell with specified row and column. + + One-based row index. + One-based column index. + Value to set. + Represents xf index. + + + + Sets formula value. + + One based row index. + One based column. + Formula value to set. + Indicates whether range is represented as R1C1 notation. + + + + Sets formula number value. + + One based row index. + One based column index. + Represents formula number value for set. + + + + Sets formula error value. + + One based row index. + One based column index. + Represents formula error value for set. + + + + Sets formula bool value. + + One based row index. + One based column index. + Represents formula bool value for set. + + + + Sets formula string value. + + One based row index. + One based column index. + Represents formula string value for set. + + + + Sets string to a range. + + Row index + Column index + String value to set. + + + + Removes string from a cell. + + Row index. + Column index. + Index to extended format + + + + Returns index of an extended format for specified cell. + + One-based row index. + One-based column index. + Index to the extended format. + + + + Returns index of an extended format for specified Row. + + One-based row index. + Index to the extended format. + + + + Returns index of an extended format for specified Column. + + first column index. + last column index. + Index to the extended format. + + + + Tries to create Rk record from double value. + + Row index. + Column index. + Double that should be converted to RkRecord. + Created RkRecord if succeeded, null otherwise. + + + + Tries to create Rk record from double value. + + Row index. + Column index. + Double that should be converted to RkRecord. + Represents xf index. + Created RkRecord if succeeded, null otherwise. + + + + Creates record. + + Record to create. + One-based row index. + One-based column index. + Created biff record. + + + + Creates record. + + Record to create. + One-based row index. + One-based column index. + Represents xf index. + Created biff record. + + + + Sets formula number. Use for setting FormulaError, FormulaBoolean, FormulaNumber values. + + One based row index. + One based column index. + Represents value for set. + + + + Sets formula value. Use for setting FormulaError, FormulaBoolean, FormulaNumber, FormulaString values. + + One based row index. + One based column index. + Represents value for set. + Represents string record as formula string value. Can be null. + + + + Returns formula corresponding to the cell. + + One-based row index of the cell to get value from. + One-based column index of the cell to get value from. + Indicates whether R1C1 notation should be used. + Formula contained by the cell. + + + + Returns formula corresponding to the cell. + + One-based row index of the cell to get value from. + One-based column index of the cell to get value from. + Indicates whether R1C1 notation should be used. + Formula contained by the cell. + + + + Returns formula corresponding to the cell. + + One-based row index of the cell to get value from. + One-based column index of the cell to get value from. + Indicates whether R1C1 notation should be used. + Formula utilities to use for parsing. + Formula contained by the cell. + + + + Returns formula corresponding to the cell. + + Zero-based row index of the cell to get value from. + Zero-based column index of the cell to get value from. + Array with formula tokens. + Indicates whether R1C1 notation should be used. + Formula utilities to use for parsing. + Formula contained by the cell. + + + + Gets formula array. + + Represents formula. + Formula array. + + + + Returns string value corresponding to the cell. + + One-based row index of the cell to get value from. + One-based column index of the cell to get value from. + String contained by the cell. + + + + Returns formula string value corresponding to the cell. + + One-based row index of the cell to get value from. + One-based column index of the cell to get value from. + String contained by the cell. + + + + Returns number value corresponding to the cell. + + One-based row index of the cell to get value from. + One-based column index of the cell to get value from. + Number contained by the cell. + + + + Returns formula number value corresponding to the cell. + + One-based row index of the cell to get value from. + One-based column index of the cell to get value from. + Number contained by the cell. + + + + Gets error value from cell. + + Row index. + Column index. + Returns error value or null. + + + + Gets formula error value from cell. + + Row index. + Column index. + Returns error value or null. + + + + Gets bool value from cell. + + Represents row index. + Represents column index. + Returns found bool value. If cannot found returns false. + + + + Gets formula bool value from cell. + + Represents row index. + Represents column index. + Returns found bool value. If cannot found returns false. + + + + Indicates is has array formula. + + Represents row index. + Represents column index. + Indicates is contain array formula record. + + + + Indicates whether tokens array contains array formula reference. + + Tokens to check. + True if it refers to + + + + Gets cell type from current column. + + Indicates row. + Indicates column. + Indicates is need to indentify formula sub type. + Returns cell type. + + + + Indicates is formula in cell is formula to external workbook. + + Represents row index. + Represents column index. + If contain extern formula returns true; otherwise false. + + + + Get the idex of the first row in UsedRange + + index of first row + + + + get the index of the last row in UsedRange + + index of last row + + + + This API supports the .NET Framework infrastructure and is not intended to be used directly from your code + + + + + + Gets the first column index. + + Index of first column + + + + Gets the last column index / column count. + + Index of last column + + + + This API supports the .NET Framework infrastructure and is not intended to be used directly from your code + + + + + + Archive Item name holds the path for embedded excel file work sheet + + + + + Try to Get intersection range of given names. + + cell range string or named range string + intersection range to be got + the boolean value, indicates whether the given ranges are intersected or not + + + + Get the intersection range. + + named range collection + range address array + intersection range + + + + Check if the string is entire range or not. + + Range string to be checked + The boolean value, indicates whether the given string is entire range + + + + Add worksheet name to range address. + + range address + range address with sheet name + + + + Try to Get intersection range of external ranges. + + External cell range string or named range string + intersection range to be got + the boolean value, indicates whether the given ranges are intersected or not + + + + + Event raised when an unknown function is encountered. + + + + + Gets or sets the a object associated with implementation. + + + + + Indicates the shapes can be copied while sorting + + + + + Gets a value indicating whether this instance has sheet calculation. + + + true if this instance has sheet calculation; otherwise, false. + + + + + Gets a value indicating whether this instance has Alernate Content. + + + true if this instance has sheet AlernateContent; otherwise, false. + + + + + An event raised on the IWorksheet whenever a value changes. + + + + + Stream to preserve the worksheet slicer + + + + + Default column width mentioned in the attribute + + + + + Read-only. Access to merged cells. + + + + + Read-only. Access to column info records. + + + + + Gets or sets position of vertical split. + + + + + Gets or sets position of horizontal split. + + + + + Gets or sets first visible row in bottom pane. + + + + + Max_Coloumn width + + + + + Gets or sets first visible column in right pane. + + + + + Gets a value indicating selection count of pane. + + + + + Gets or sets the view setting of the sheet. + + + + + + Return default row height in pixel. + + + + + Returns inner names collection. Read-only. + + + + + Returns collection of cell records. Read-only. + + + + + Returns a PageSetup object that contains all the page setup settings + for the specified object. Read-only. + + + + + Gets pain record or null. Read-only. + + + + + Gets array with selection records or null. Read-only. + + + + + Indicates whether all created range objects should be cached. Default value is true. + + + + + Returns all autofilter records. Read-only. + + + + + Returns all DCon records that were met in the source document. Read-only. + + + + + Returns all Sort records that were met in the source document. Read-only. + + + + + Returns quoted name of the worksheet. + + + + + Gets or sets excel version. + + + + + Returns object used for records creation/extraction from data provider. Read-only. + + + + + + + + + + Indicates whether IsHidden property is set. + + + + + Indicates whether ZeroHeight property has enabled or not. + + + + + Specifies the number of characters of the maximum digit width of the normal style's font. + + + + + 'True' if rows have a thick bottom border by default. + + + + + 'True' if rows have a thick top border by default. + + + + + Highest number of outline levels for columns in this sheet. + + + + + Highest number of outline level for rows in this sheet. + + + + + Highest number of outline level for rows in this sheet. + + + + + Returns the rows outline level count + + + + + Returns the columns outline level count + + + + + Returns or sets the list of outline wrapper collection + + + + + Indicates whether worksheet has merged cells. Read-only. + + + + + Gets the default protection options for the worksheet. + + + + + Gets the inline strings. + + The inline strings. + + + + Preserves the External connection setting in the worksheet. + + + + + Preserves the pivot tables. + + + + + Gets or sets the boolean value to load worksheets on demand + + + + + Return or sets the columns outline levels collection + + + + + Returns the row outline levels collection + + + + + Get cell by row and index. + + + + + Get cell range. + + + + + Get cell range. + + + + + Get cell range. + + + + + Gets / sets index of the active pane. + + + + + For a Worksheet object, returns an array of Range objects that represents + all used columns on the specified worksheet. Read-only Range object. + + + + + True if page breaks (both automatic and manual) on the specified + worksheet are displayed. Read / write Boolean. + + + + + True if zero values to be displayed + False otherwise. + + + + + True if gridlines are visible; + False otherwise. + + + + + True if row and column headers are visible. + False otherwise. + + + + + Indicates if all values in the workbook are preserved as strings. + + + + + Name used by macros to access to workbook items. + + + + + Returns a PageSetup object that contains all the page setup settings + for the specified object. Read-only. + + + + + Gets or sets range indicating first visible row and column. + + + + + Read-only. Returns a Range object that represents a cell or a range of cells. + + + + + For a Worksheet object, returns an array of Range objects that represents + all the rows on the specified worksheet. Read-only Range object. + + + + + Defines whether freeze panes are applied. + + + + + Gets or sets range for vertical and horizontal split + + + + + Gets or sets standard ( default ) height of all the rows in the worksheet, + in points. Double. + + + + + Gets or sets the standard (default) height option flag, which defines that + standard (default) row height and book default font height do not match. Bool. + + + + + Returns or sets the standard ( default ) width of all the columns in the + worksheet. Read/write Double. + + + + + Returns or sets the worksheet type. Read-only OfficeSheetType. + + + + + Returns a Range object that represents the used range on the + specified worksheet. Read-only. + + + + + Indicates whether worksheet is empty. Read-only. + + + + + Returns instance of migrant range - row and column of this range + object can be changed by user. Read-only. + + + + + There are two different algorithms to create UsedRange object: + 1) Default. This property = true. The cell is included into UsedRange when + it has some record created for it even if data is empty (maybe some formatting + changed, maybe not - cell was accessed and record was created). + 2) This property = false. In this case XlsIO tries to remove empty rows and + columns from all sides to make UsedRange smaller. + + + + + Indicates whether to include CFRange in Used range. + + + + + Indicates is current sheet is protected. + + + + + Returns ImportDTHelper objects. + + + + + Indicates whether it is importing. + + + + + This event is raised after column width changed. + + + + + This event is raised after column height changed. + + + + + Gets top left cell of the worksheet. + + + + + + Get/Set the archive item name referred in the worksheet + + + + + Defines which property of IRange should be used. + + + + + Represents range value type. + + + + + Represents Blank type. + + + + + Represents Error type. + + + + + Represents Boolean type. + + + + + Represents Number type. + + + + + Represents Formula type. + + + + + Represents String type. + + + + + Delegate for outline creation. + + + + + + Represents the method that will return array of biff records for MsoDrawing record. + + + + + Event delegate for MissingFunction event. + + The CalcEngine. + The for this event. + + + + The event args for the MissingFunction event which is raised whenever the CalcEngine encounters a function + that is does not know. + + + + + Gets the name of the unknown function. + + + + + Gets the location of the missing function. + + + + + Class used for parsing Excel 2007 workbooks. + + + + + Represents HLS max value. + + + + + Represents RGB max value. + + + + + Represents undefined HLS value. + + + + + CarriageReturn ControlCharacters + + + + + LineFeed ControlCharacters + + + + + NullChar ControlCharacters + + + + + BackSpace ControlCharacters + + + + + Tab ControlCharacters + + + + + Content TypeSchema + + + + + Content Type NameSpace + + + + + Xml Schema NameSpace + + + + + Element Name + + + + + Name Attribute + + + + + Display Name Attribute + + + + + Internal Name Attribute + + + + + Ref attribute + + + + + Complex content + + + + + Parent workbook. + + + + + Formula utils. + + + + + Dictionary with all available shape parsers. Key - shape instance value, + or o:spt value; Value - shape parser. + + + + + Theme colors list. + + + + + Dictionary of theme colors: key - theme color name, value - corresponding color. + + + + + Dictionary to store the color mapping values. + + + + + Dictionary of theme override colors + + + + + Parent element name. + + + + + Represents the current worksheet. + + + + + Collecton of Outline levels + + + + + The number format indexes that are always serialized. + + + + + Initializes new instance of the parser. + + Parent workbook. + + + + Converts theme color name into rgb color value. + + Color name to get rgb color value for. + Rgb color object that corresponds to the theme color. + + + + Converts theme color name into rgb color value. + + Color name to get rgb color value for. + Dictionary that holds theme color name and color. + Rgb color object that corresponds to the theme color. + + + + + + + + + + + + Parses workbook part. + + XmlReader to extract workbook part data from. + Workbook relations. + Object that stores document data. + Absolute path in zip archive to the parent workbook. + Stream that will get all xml tags before worksheets. + Stream that will get all xml tags after named ranges section. + Workbook views collection. + + + + Parses workbook Pr tag and parses Date1904 value + + XmlReader to extract workbook part data from. + + + + Parses calculation tag and reads Precision + + XmlReader to extract workbook part data from. + + + + Extracts workbook protection options. + + XmlReader to extract protection options from. + + + + Parses workbook views. + + Reader to get data from. + Active sheet index. + Display tab index. + Workbook views collection. + + + + Parses workbook view. + + Reader to get data from. + Dictionary where key - attribute name, value - attribute value. + + + + Parses sheet (chart of worksheet). + + Reader to get data from. + Sheet to parse. + Absolute path to the parent worksheet item. + This stream will receive xml text starting just + after "worksheet" tag to "col" or "sheetData" tag. + This stream contains conditional formatting. + List with new style indexes (index - old + style index, value - new one). + Dictionary with archive items to remove after parsing. + + + + Parses worksheet before sheetData tag. + + + + + + + + + Parses sheet views. + + Reader to get data from. + Worksheet to place extracted data into. + + + + Parses single sheet view item. + + XmlReader to get data from. + Worksheet to put extracted data into. + + + + Extracts selection data. + + XmlReader to get data from. + Worksheet to put extracted data into. + + + + Extracts pane objects. + + XmlReader to get data from. + Worksheet to put extracted data into. + + + + Parses pane state. + + WindowTwo record that stores pane state flags. + State value to parse + + + + Check whether the choice denotes chartEx or not + + input XML reader + the boolean value indicates the chartEx choice or not + + + + + + + + + + + + + + Extracts default row height from sheet format properties tag. + + XmlReader to get info from. + Worksheet to put settings into. + + + + Extracts Zero row height from sheet format properties tag. + + XmlReader to get info from. + Worksheet to put settings into. + + + + This methods extracts named ranges from XmlReader. + + Reader to get information from. + + + + Parses styles of the workbook. + + XmlReader to read styles data from. + Stream that will get Dxfs formatting. + + + + Parses shared strings table. + + XmlReader to get data from. + Dictionary with updated string indexes. + + + + Parses string item. + + XmlReader to get data from. + Added string index. + + + + Parses string item. + + XmlReader to get data from. + Added string index. + + + + Extracts relations collection from XmlReader. + + Reader to extract data from. + Extracted relations collection. + + + + Extracts sheet data from reader and insets it into worksheet. + + XmlReader to get data from. + Worksheet to put data into. + List with new style indexes (index - old style index, value - new one). + Tag used for cell definition. + Dictionary with all attributes of sheetData tag. + + + + This method extracts drawings from specified XmlReader. + + XmlReader to extract data from. + Worksheet to place extracted shapes into. + Absolute path to the drawings. + List that will get relation id of the picture + (used to remove parsed relations after parsing). + Dictionary with archive items to remove after parsing. + + + + This method extracts all xml tags after SheetData tag. + + Reader to get data from. + + + + Extracts single drawing defined by TwoCellAnchor tag name from the specified XmlReader. + + XmlReader to get shape data from. + Worksheet to put extracted shape into. + Absolute path to the drawings. + Relation ids that were parsed (to remove them from the collection later). + Dictionary with archive items to remove after parsing. + + + + Parse group shape specified by "grpSp" tag and registers it in required collections. + + XmlReader to get shape data from. + Worksheet to put extracted shape into. + Absolute path to the drawings. + Relation ids that were parsed (to remove them from the collection later). + Created group shape object. + + + + This method extracts all xml tags from group shape spPr element. + + Reader to get data from. + Group shape to parse. + + + + Parses the transformation2D of group shape + + xmlreader object + group shape being parsed + + + + Extracts shape specified by "sp" tag and registers it in required collections. + + XmlReader to get data from. + Parent worksheet. + Stream that will contains xml representation of the shape if necessary. + Created shape object. + + + + Checks and returns of type if AutoShape type is . + + Custom geometry's stream. + Parent Worksheet of the . + XmlReader to extract the properties. + + + + + Tries to extract chart object from specified stream with GraphicFrame tag. + + Stream with GraphicFrame tag. + Parent worksheet. + Path to the drawing item. + Extracted chart shape; or null if chart wasn't located. + + + + Tries to extract chart object from specified stream with GraphicFrame tag. + + Stream with GraphicFrame tag. + Parent worksheet. + Path to the drawing item. + Extracted chart shape; or null if chart wasn't located. + + + + + + + + + + + Extracts extent settings from reader and converts them into pixels. + + Reader to get extent data from. + Size of the shape in pixels. + + + + Extracts anchor point from the specified XmlReader. + + Reader to get data from. + Rectangle with extracted data. + + + + Parse the row and column emu value is convert to rectangle. + + XmlReader + + + + + Parse picture shape. + + XmlReader to get picture data from. + Worksheet to place extracted shape into. + Absolute path to the drawings. + List that will get relation id of the picture + (used to remove parsed relations after parsing). + Dictionary with archive items to remove after parsing. + + + + This method extracts shape properties from the specified XmlReader. + + XmlReader to get data from. + Shape to put extracted data into. + + + + Extracts blip data from the specified XmlReader. + + Reader to get blip data from. + Shape to put extracted data into. + Worksheet drawings relations collection. + Path to the parent item. + Parent file data holder. + List that will get relation id of the picture + (used to remove parsed relations after parsing). + Dictionary with archive items to remove after parsing. + + + + Parses blip tag and sets appropriate image to the specified shape. + + Reader to get data from. + Shape to put image into. + Collection with all drawings relations. + Path to the parent item (used to resolve related relation path). + Parent file data holder. + List that will get relation id of the picture + (used to remove parsed relations after parsing). + Dictionary with archive items to remove after parsing. + + + + This method parses picture properties. + + Reader to extract data from. + Shape to put properties into. + + + + Parses non visual picture canvas properties. + + XmlReader to get data from. + Shape to place extracted data into. + + + + Parses non visual canvas properties. + + XmlReader to get data from. + Shape to store extracted data. + + + + Parses Click Hyper link properties. + + XmlReader to get data from. + Shape to store extracted data. + + + + Parses rich text run. + + XmlReader to get data from. + Index of the added string. + + + + Extracts TextWithFormat from the specified XmlReader. + + XmlReader to get data from. + Tag that means that we have to stop parsing. + Parsed text with format. + + + + + + + + + + + Parses text content. + + XmlReader to get data from. + Parsed string index. + + + + Parses text content. + + XmlReader to get data from. + Parsed string index. + + + + Extracts named styles from specified XmlReader. + + XmlReader to get data from. + List with updated font indexes, index - font index + in the file, value - font index in our document (we can change indexes during parsing). + List with extracted fill objects. + List with extracted borders. + List with indexes of created extended formats. + + + + Extracts cell formats from specified XmlReader. + + XmlReader to get data from. + List with updated font indexes, index - font index + in the file, value - font index in our document (we can change indexes during parsing). + List with extracted fill objects. + List with extracted borders. + List with updated parent indexes, index - xfId in + the xml document, value - xf index in our internal collection. + List with indexes of created extended formats. + + + + Parses named style settings (name, etc.). + + XmlReader to get data from. + List with modified indexes to named + style's extended formats. + + + + Converts style name sting to Ascii string + + + + + + + Parses single style object. + + XmlReader to get data from. + List with modified indexes to named + style's extended formats. + + + + Extracts single extended format from the XmlReader. + + XmlReader to get data from. + List with updated font indexes, index - font index + in the file, value - font index in our document (we can change indexes during parsing). + List with extracted fill objects. + List with extracted borders. + List with updated parent indexes. + Created ExtendedFormat object. + + + + Parse alignment and protection properties for extended format + if they are present in the document. + + XmlReader to get data from. + ExtendedFormatRecord to put data into. + + + + Parses alignment settings. + + XmlReader to get alignment data from. + Record to write alignment data into. + + + + Parses protection settings. + + XmlReader to get protection data from. + Record to write protection data into. + + + + Extracts Include (IncludeAlignment, IncludeFont, etc.) attributes from XmlReader. + + XmlReader to get data from. + ExtendedFormat to put data into. + + + + This method extracts font, fill and border settings from specified + XmlReader and sets inside specified ExtendedFormat. + + XmlReader to get data from. + Extended format to put data into. + List with updated font indexes, index - font index + in the file, value - font index in our document (we can change indexes during parsing). + List with extracted fill objects. + List with extracted borders. + + + + Copies border settings from specified borders collection into ExtendedFormatImpl. + + BordersCollection to copy settings from. + Format object to copy into. + + + + Extracts single relation item from the reader and puts it into relations collection. + + XmlReader to extract relation from. + Relations collection that should get extracted value. + + + + Parses sheet options. + + XmlReader to extract sheet options from (name, visibility, relation, etc.). + Workbook relations. + Object that holds document data. + Absolute path in zip archive to the parent workbook. + + + + Parses sheet entry from workbook item. + + Reader to extract data from. + Workook's relations collection. + FileDataHolder that stores document data. + Absolute path in zip archive to the parent workbook. + + + + Sets sheet visibility. + + Worksheet to set visibility into. + Visibility string value. + + + + + + + + + + + + + Extracts single MergeRegion from reader and inserts it into collection inside worksheet. + + XmlReader to get data from. + Named range value. + + + + Extracts fonts from XmlReader. + + XmlReader to get data from. + List with new font indexes. + + + + Extracts font object from specified XmlReader. + + Reader to read font data from. + List to add new font index into. + + + + Extracts font settings from specified XmlReader. + + Reader to read font data from. + Font to extract data into. + + + + Parses the family. + + The reader. + + + + + Extracts + + + + + + + Extracts collection of number formats from specified reader. + + XmlReader to get data from. + + + + Extracts single number format entry from specified reader. + + Reader to extract from. + + + + Extracts color from XmlReader. + + XmlReader to get data from. + Extracted color index (on the current moment we support only indexed colors). + + + + Extracts color from XmlReader. + + XmlReader to get data from. + Color object to put extracted values into. + + + + Extracts backgroundcolor from XmlReader. + + XmlReader to get data from. + Color object to put extracted values into. + + + + Applies tint to the specified color. + + Color to apply tint value to. + Tint value to apply. + Color after applying tint value. + + + + Applies tint to the specified color. + + Color to apply tint value to. + Tint value to apply. + Color after applying tint value. + + + + Calculate double value from int. + + + double value + + + + Calculate int value from double. + + + int value. + + + + Converts color to HLS values. + + Color to convert. + Hue value. + Luminance value. + Saturation value. + + + + Converts HLS components to RGB color values and returns Color, according to this values. + + Hue value. + Luminance value. + Saturation value. + + + + + Converts Hue value to RGB single component. + + Magic number 1. + Magic number 2. + Hue value. + RGB component value. + + + + Extracts boolean value from the current xml tag. + + XmlReader to get value from. + Name of the attribute where value is stored. + Default value (when there is no attribute specified). + Extracted value. + + + + Extract value of the attribute from reader. + + XmlReader to get data from. + Name of the attribute to extract. + Extracted value; or null if there were no attribute with such name. + + + + Extracts fill objects from XmlReader. + + XmlReader to get data from. + List with all extracted fills. + + + + Extracts single fill object from specified XmlReader. + + XmlReader to read fill data from. + Indicates whether fore and back colors should be swapped. + Extracted Fill object. + + + + Extracts single gradient fill object from specified XmlReader. + + XmlReader to read gradient fill from. + Extracted gradient fill object. + + + + Extracts single path gradient fill object from specified XmlReader. + + XmlReader to read gradient fill from. + Extracted path gradient fill object. + + + + Extracts stop colors from specified XmlReader. + + XmlReader to read stop colors from. + Colors list. + + + + Extracts single linear gradient fill object from specified XmlReader. + + XmlReader to read linear gradient fill from. + Extracted linear gradient fill object. + + + + Sets gradients fill style and variant values according to degree value. + + Fill to set data into. + Degree value. + + + + Extracts attribute value. + + XmlReader to extract attribute value from. + Attribute name. + Attribute double value. + + + + Extracts pattern fill from specified XmlReader. + + XmlReader to get data from. + Indicates whether fore and back colors should be swapped. + Extracted fill object. + + + + Converts specified string in MS Excel 2007 pattern format into pattern value. + + Value to convert. + Converted value. + + + + Extracts border objects from XmlReader. + + XmlReader to get data from. + List with new borders indexes. + + + + Extracts border collection from specified XmlReader. + + XmlReader to get data from. + Extracted borders collection. + + + + Extracts single border from the XmlReader. + + XmlReader to get data from. + Output - index of the extracted border (left, top, etc.). + Extracted border. + + + + Extracts row data from reader and inserts it into worksheet. + + XmlReader to get data from. + Worksheet to put data into. + Style hashtable. Key - recovered from xml extended format id, + value - extended format index in workbook collection. + Current row id. + + + + Extracts cell from reader and inserts it into worksheet. + + XmlReader to get data from. + Worksheet to put data into. + Style hashtable. Key - recovered from xml extended format id, + value - extended format index in workbook collection. + + + + Returns type of the cell. + + String representation of the cell type. + + + + + Extracts formula from reader and inserts it into worksheet. + + XmlReader to get data from. + Worksheet to put data into. + Current row index. + Current column index. + Extended format index. + + + + Extracts and fills palette settings from specified XmlReader. + + XmlReader to get palette from. + + + + + + + + + + Parses columns collection. + + XmlReader to get data from. + Worksheet that will store extracted data. + List with new style indexes. + + + + + + + + + + + + + + + + + Extracts themes. + + XmlReader to get data from. + + + + Skips the white spaces in the XML. + + + + + + Extracts theme colors. + + XmlReader to get data from. + Dictionary that will be filled with theme colors, + key - color name, value - color value. + Returns theme colors list. + + + + Extracts sheet-level properties from reader and inserts it into worksheet. + + XmlReader to get data from. + Worksheet to put data into. + + + + Parses worksheet page setup properties. + + Reader to extract data from. + Object to put extracted data into. + + + + Parses worksheet outline properties. + + Reader to get data from. + Page setup to put data into. + + + + Parses external link file. To set URL field we have to have access to + relations, so it is better to do it in some other place. + + XmlReader to get data from. + Item's relations. + + + + Parses the OLE object link. + + The reader. + The relations. + + + + + + + + + + + Extracts external names from the reader. + + XmlReader to get data from. + External workbooks to put defined names into. + + + + Extracts single external name from the reader. + + XmlReader to get external name data from. + External workbook to put extracted name into. + + + + Extracts cached external data. + + XmlReader to get data from. + External workbook to put cache into. + + + + Extracts single external worksheet cached data from XmlReader. + + XmlReader to get cached data from. + External workbook to place extracted data into. + + + + Creates external workbook. + + Relations collection that helps to locate external workbook. + Relation id of the target workbook. + Name of the workbook's worksheets. + + + + + Extract names of external worksheets from the reader. + + XmlReader to get data from. + List with extracted names. + + + + Parses workbook part of the external links description. + + Reader to get data from. + + + + Parses single external link from the workbook. + + Reader to get link information from. + + + + Creates cell record. + + Cell type. + Record value. + Current cells collection. + Represents column index. + Represents row index. + Represents extended format index. + + + + Sets formula value. + + Worksheet to set formula value into. + Cell type. + Value to set. + Represents row index. + Represents column index. + + + + Sets array formula record into worksheet. + + Worksheet to put data into. + Formula string to insert. + Cell range of the formula. + Extended format index. + + + + Sets shared formula record into worksheet. + + Worksheet to put data into. + Formula string to insert. + Cell range of the formula. + Shared formula group index. + Current row index. + Current column index. + Extended format index. + + + + Converts color by applying shade value. + + Color to process. + Shade to apply. + Modified color. + + + + Copies fill settings from fill object into extended format. + + Fill to copy from. + Extended format to copy into. + + + + Parse the theme overrided colors from the chart + + Input chart object + the parsed theme colors + + + + Gets FformulaUtil that corresponds to invariant culture. + + + + + Gets the worksheet. + + The worksheet. + + + + Gets the workbook. + + The workbook. + + + + This class is responsible for vml shape and shape type parsing. + + + + + Saves current node into stream. + + Reader to get node from. + Stream with current node's data. + + + + Saves current node into stream. + + Reader to get node from. + Stream with current node's data. + + + + Reads node from the stream and writes it into XmlWriter. + + Writer to write node into. + Stream to get node from. + + + + Reads node from the stream and writes it into XmlWriter. + + Writer to write node into. + Stream to get node from. + + + + This class is used to parse text box shape. + + + + + Extracts text box settings from XmlReader. + + TextBox to fill with settings. + XmlReader to get data from. + Parser used to help in parsing process. + + + + Parses non visual shape properties. + + Shape to be parsed. + XML reader to extract data from. + Parser used to help in parsing process. + + + + Parses shape properties. + + TextBox to be parsed. + XML reader to extract data from. + Parser used to help in parsing process. + + + + Parses rich text. + + XmlReader to read rich text from. + Parser object that helps to extract data. + TextBox to be parsed. + + + + Parses text area body properties. + + XmlReader to read body properties from. + Text area to put body properties into. + Textbox to be parsed. + + + + Parses text rotation value. + + Rotation value to parse. + TextBox to put extracted value into. + + + + Parses anchor (vertical alignment). + + Anchor value to parse. + TextBox to put extracted value into. + + + + Extracts list styles for a text area. + + XmlReader to extract list styles from. + Text area that will get extracted settings. + + + + Parses paragraph. + + XmlReader to get paragraph tag from. + Text box that needs its paragraph text to be parsed. + Parser object that helps to extract data. + + + + Extracts paragraph properties + + XmlReader to get data from. + TextBox to put data into. + + + + Parses paragraph run. + + XmlReader to get paragraph run from. + Text area to put extracted properties into. + Parser object that helps to extract data. + + + + Parses paragraph run. + + XmlReader to extract paragraph tag from. + Text area that will get paragraph run information (formatting and text). + Parser object that helps to extract data. + Font attributes of the paragraph run. + + + + Serialize line properties. + + XmlReader to serialize into. + Chart line properties to serialize. + Indicates whether border is rounded or not + Excel2007Parser to help in extraction process. + + + + Font name. + + + + + Font size. + + + + + Value indicating whether font is bold. + + + + + Value indicating whether text + + + + + Value indicating whether text is underlined. + + + + + Value indicating whether text is striked. + + + + + Language used to display text. + + + + + Font color. + + + + + Represents the baseline properties + + + + + Specifies the minimum font size at which character kerning occurs for this text run. + default -1, it was non negative on chart style + + + + + Specifies the spacing between characters within a text run. + default -1, it was non negative + + + + + Adds slash ('/') before the file name if necessary. + + + + + Initializes a new instance of the AddSlashPreprocessor class. + + + + + Somehow converts full path into name that will be stored in the zip archive. + + Name to process. + Converted name. + + + + Class used for holding border settings. + + + + + Returns or sets the primary color of the object. + Read/write ExcelKnownColors. + + + + + Represents border line style. + + + + + This field is used only by Diagonal borders. For any other + border index property will have no influence. + + + + + Specifies a boolean value that indicate whether the border setting has a empty border + + + + + Initializes a new instance of the BorderSettingsHolder class. + + + + + Creates a shallow copy of the current System.Object. + + A shallow copy of the current System.Object. + + + + Gets or sets the primary color of the object. + Read/write ExcelKnownColors. + + + + + Gets color of the border. + + + + + Gets or sets color of the border. + + + + + Gets or sets the line style for the border. Read/write OfficeLineStyle. + + + + + Gets or sets a value indicating whether to show Diagonal lines. This property is used only by Diagonal borders. For any other border + index property will have no influence. + + + + + Specifies a boolean value that indicate whether the border setting has a empty border + + + + + Parent object for this object. + + + + + This class is responsible for chart axis parsing. + + + + + Default font name. + + + + + Default axis font size. + + + + + Represents dictionary for Ticklabel to Attribute value. + + + + + Represents dictionary for TickMark to Attribute value. + + + + + Represents axis id of the bar series. + + + + + Indicate whether series is bar chart or not + + + + + Initializes static members of the ChartAxisParser class. + + + + + Extracts date axis from XmlReader. + + XmlReader to serialize into. + Axis to serialize. + Chart item relations. + Prognosed type of the chart (or chart part) that is being parsed. + + + + Serializes category axis. + + XmlReader to extract data from. + Axis to serialize. + Chart item relations. + Prognosed type of the chart (or chart part) that is being parsed. + + + + Extracts value axis. + + XmlReader to extract axis from. + Axis to put extracted data into. + Chart item relations. + Prognosed type of the chart (or chart part) that is being parsed. + + + + Extracts series axis data. + + XmlReader to extract data from. + Axis to put extracted data into. + Chart item relations. + Prognosed type of the chart (or chart part) that is being parsed. + + + + Extracts common part of the axis. + + XmlReader to extract data from. + Axis to serialize. + Relations collection for chart item that is being parsed. + Prognosed type of the chart (or chart part) that is being parsed. + + + + Extracts chart axis text properties from the reader. + + XmlReader to get data from. + Axis to put extracted data into. + + + + Extracts text body properties + + XmlReader to get data from. + Axis to put extracted data into. + + + + Parses crosses xml tag. + + XmlReader to extract data from. + Axis to put extracted data into. + + + + Parses cross axis tag. + + XmlReader to extract data from. + Axis to put extracted data into. + + + + Extracts tick mark. + + XmlReader to extract data from. + Extracted value. + + + + Extracts tick label position. + + XmlReader to extract data from. + Axis to set tick label position. + + + + Extracts number format used by the axis. + + XmlReader to extract data from. + Axis to put extracted number format into. + + + + Extracts single gridline object. + + XmlReader to extract data from. + Gridlines to put extracted data into. + Parent file data holder. + Chart item relations. + + + + Extracts axis position. + + XmlReader to extract data from. + Axis to serialize. + Extracted Axis position. + + + + Extracts scaling tag and all necessary child tags. + + XmlReader to serialize into. + Extracted Axis scale. + + + + Extracts display unit from XmlReader. + + XmlReader to extract data from. + Axis to put extracted data into. + + + + Extracts built-in display unit. + + XmlReader to get value from. + Value axis to put extracted value into. + + + + Parses additional tags of category axis. + + XmlReader to get data from. + Axis to put data into. + Chart relations. + + + + Parses additional tags of date axis. + + XmlReader to get data from. + Axis to put data into. + Chart relations. + + + + Parses additional tags of value axis. + + XmlReader to get data from. + Axis to put data into. + Chart relations. + + + + Parses additional tags of series axis. + + XmlReader to get data from. + Axis to put data into. + Chart relations. + + + + This class is responsible for chartEx axis parsing + + + + + Select and Parse the chartEx axis from the reader + + input XML reader + input secondaryAxisId + input chart + input chart relation collections + excel 2007 parser + input file data holder + + + + Extracts display unit from XmlReader. + + XmlReader to extract data from. + Axis to put extracted data into. + + + + Parse the Axis attributes return the axis values + + input XML reader + output axis hidden value + output axis id value + + + + Parse the chart axis (category or value scaling element) attributes + + input XML reader + input chart Axis + boolean value indicates whether the axis is value or category + + + + Extracts tick mark. + + XmlReader to extract data from. + Extracted value. + + + + Class used for representing chart axis scale. + + + + + Represents logarithmic scale. + + + + + Indicates whether datapoint plot from last to first. + + + + + Represents maximum value. + + + + + Represents minimum value. + + + + + Represents the log base. + + + + + Method used to copy the axis scale. + + Represents Chart value axis. + + + + This class is responsible for chart axis serialization. + + + + + Defines text rotation multiplier constant. + + + + + Represents dictionary for TickLabel to Attribute value. + + + + + Represents dictionary for TickMark to Attribute value. + + + + + Initializes static members of the ChartAxisSerializator class. + + + + + Serializes chart axis. + + XmlWriter to serialize into. + Axis to serialize. + + + + Serializes date axis. + + XmlWriter to serialize into. + Axis to serialize. + + + + Convert date unit to string. + + ExcelChartBaseUnit to serialize. + Date unit as string. + + + + Serializes category axis. + + XmlWriter to serialize into. + Axis to serialize. + + + + Serializes value axis. + + XmlWriter to serialize into. + Axis to serialize. + + + + Serializes series axis. + + XmlWriter to serialize into. + Axis to serialize. + + + + Serializes common part of the axis. + + XmlWriter to serialize into. + Axis to serialize. + + + + Returns pair for the specified axis, it is category axis for value axis and vice versa. + + Axis to get pair for. + Pair for the specified axis. + + + + Serializes cross axis. + + XmlWriter to serialize into. + Axis to serialize. + + + + Serializes tick mark. + + XmlWriter to serialize into. + Tag name to use. + Tick mark to serialize + + + + Serializes tick label position. + + XmlWriter to serialize into. + Axis to get tick label position from. + + + + Serializes number format used by the axis. + + XmlWriter to serialize into. + Axis to serialize number format for. + + + + Serializes axis gridlines. + + XmlWriter to serialize into. + Axis to serialize gridlines for. + + + + Serializes single gridline object. + + XmlWriter to serialize into. + Gridlines to serialize. + Name of the xml tag to use. + Parent workbook. + + + + Serializes axis position. + + XmlWriter to serialize into. + Axis to serialize. + + + + Serializes scaling tag and all necessary child tags. + + XmlWriter to serialize into. + Axis to serialize settings for. + + + + Serializes display unit. + + XmlWriter to serialize into. + Value to serialize. + Custom unit value (used only if displayUnit is set to custom). + + + + Serializes text settings. + + XmlWriter to serialize into. + Axis to serialize settings for. + + + + Serializes text settings. + + XmlWriter to serialize into. + + + + Object that gives access to border, interior and fill of the ChartSerieDataFormatImpl. + + + + + Provides access to filling options (border, interior and fill) of some chart object. + + + + + Gets border object. Read-only. + + + + + Gets interior object. Read-only. + + + + + Gets fill object. Read-only. + + + + + Gets Shadow object.Read-only + + + + + Gets the three_ D.Read-only + + + + + Parent data format to get fill objects from. + + + + + Initializes a new instance of the ChartFillObjectGetter class. + + Parent data format. + + + + Gets chart border object. Read-only. + + + + + Gets chart interior object. Read-only. + + + + + Gets chart fill object. Read-only. + + + + + Gets Shadow object.Read-only + + + + + + Gets the three_ D.Read-only + + + + + + Object that gives access to border, interior and fill. + + + + + Border object. + + + + + Interior object. + + + + + Fill object. + + + + + Shadow object + + + + + Three_D object + + + + + Initializes a new instance of the ChartFillObjectGetterAny class. + + Border object to use. + Interior object to use. + Fill object to use. + + + + Gets border object. Read-only. + + + + + Gets chart interior object. Read-only. + + + + + Gets fill object. Read-only. + + + + + Gets Shadow object.Read-only + + + + + + Gets the three_ D.Read-only + + + + + + This class is responsible for charts parsing. + + + + + Excel engine. + + + + + Extracts chart from XmlReader. + + XmlReader to serialize into. + Chart to serialize. + Chart item relations. + version of the app. + + + + Calculate chart with shapes position. + + Chart impl + chart width + chart height + + + + Parse the invert solid fill format. + + Preserved stream. + Chart serie. + returns the color object. + + + + Extracts chart from XmlReader. + + XmlReader to serialize into. + Chart to serialize. + Chart item relations. + + + + Assign the key as chart group for common data points collection + + chart to be changed + + + + Extracts data lables from chart. + + XmlReader to extract data from. + Parent Chart + Chart item relations. + chart group identified by this values,added to dictionary + + + + Serializes data label for single data point. + + XmlReader to extract data from. + Parent Chart + Chart item relations. + chart group identified by this values,added to dictionary + + + + Parse the stream and set the style id for the chart + + input alternate content stream + the input chart + + + + Parses the Chart default text properties. + + The Xml reader to parse from. + The chart to put the extracted data. + + + + Parses chart body properties + + + + + + + Parses Chart Paragraph Properties + + + + + + + Checks Default Text Settings for the axis. + + + + + Parses user shapes. + + XmlReader to serialize into. + Chart to serialize. + Chart item relations. + + + + Parses main chart xml tag. + + XmlReader to extract data from. + Chart to put extracted data into. + Chart's relations. + + + + Parse the chart title / legend attributes for chart Ex + + input XML reader + output isoverlay boolean value + output position value + + + + Copies 3D settings from Chart3DRecord into chart. + + Chart to copy data into. + Record to copy data from. + + + + Extracts chart legend from XmlReader. + + XmlReader to extract data from. + Chart legend to put extracted data into. + Chart object that stores specified legend. + Chart relations collection. + + + + Convert the chartExLegend position and returns the chart legend position + + position short value + the chart legend position value + + + + Extracts legend entry from specified reader. + + XmlReader to extract legend entry from. + Legend to put extracted legend entry into. + Excel2007Parser object to use if necessary. + + + + Extracts 3-D view options from XmlReader. + + XmlReader to get data from. + Chart to put extracted options into. + Record with 3D view settings. + + + + Serializes error bars. + + XmlReader to extract data from. + Series to put extracted error bars into. + Chart item relations. + + + + Extracts error bar range. + + XmlReader to extract data from. + Represents Workbook. + Extracted range. + + + + Extracts trendlines collection. + + XmlReader to extract data from. + Series to put extracted data into. + Chart item relations. + + + + Extracts trend line. + + XmlReader to extract data from. + Series to put extracted data into. + Chart item relations. + + + + Extracts trend line label settings. + + XmlReader to extract data from. + Data label to serialize. + + + + Serializes surface (wall or floor). + + XmlWriter to serialize into. + Surface to serialize. + Parent data holder. + Drawing's relations. + + + + Extracts plotarea tag from XmlReader. + + XmlReader to get data from. + Chart to put extracted data into. + Chart item relations. + + + + parse the bar chart + + + + + Parses bar chart. + + XmlReader to extract chart from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Parse the Filtered Series + + + + + + + + + + + + Stores extracted axis id inside structures for future use. + + XmlReader to get data from. + Series list. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Parses bar 3D chart. + + XmlReader to extract chart from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts shape of the bar chart. + + XmlReader to extract data from. + Chart serie data format. + + + + Extracts part of the bar chart that is common for all bar charts. + + XmlReader to extract data from. + Chart to put extracted data into. + Chart item relations. + Indicates whether we are parsing 3D chart. + List that will get extracted series. + First extracted series. + + + + Parse Secondary Axis Filter + + + + + + + + + + + + + When we parsing the categoryfiltered chart, we need to find the filtered category + + + + + + + + + + Supporting method for Find Filter + + + + + + + + Find the series or category Range + + + + + + + + + + Find series in Row or Column. + + + + + + + Converts direction and grouping values into type of bar series. + + Represents direction of bar series. + Represents series grouping value. + Indicates whether we are parsing 3D chart. + Extracted chat type. + + + + Converts grouping value into type of area series. + + Area series grouping value. + Indicates whether we are parsing 3D chart. + Area chart type that corresponds to grouping and is3D values. + + + + Converts grouping value into type of line series. + + Line series grouping value. + Indicates whether we are parsing 3D chart. + Line chart type that corresponds to grouping and is3D values. + + + + Extracts area3D chart. + + XmlReader to extract data from. + Chart to serialize. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts area chart from XmlReader. + + XmlReader to get data from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts properties common to the area chart. + + XmlReader to extract data from. + Chart to put extracted data into. + Indicates whether we are parsing 3D chart. + Chart item relations. + List that will get extracted series. + + + + This method extracts common properties of the line charts. + + XmlReader to extract data from. + Chart to put extracted data into. + Indicates whether we are parsing 3D chart. + Chart item relations. + List that will get extracted series. + One of the extracted series. + + + + Extracts line3DChart from XmlReader. + + XmlReader to extract line 3d chart from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts line chart. + + XmlReader to extract data from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts bubble chart. + + XmlReader to extract data from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts 2-D surface chart from XmlReader. + + XmlReader to extract data from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts common part of the surface charts. + + XmlReader to extract data from. + Chart to put extracted data into. + Indicates whether we are parsing 3D chart. + Chart item relations. + List that will get extracted series. + + + + Extracts band formats from the stream. + + + + + + + Returns type of the series to create. + + Indicates whether surface is wireframe or not. + Indicates whether we are parsing 3D chart. + Surface chart type. + + + + Extracts radar chart. + + XmlReader to extract data from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts scatter chart. + + XmlReader to extract chart from. + Chart to serialize. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts pie chart. + + XmlReader to extract data from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts 3-D pie chart. + + XmlReader to extract data from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts pie of pie or pie of bar chart. + + XmlReader to extract data from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts stock chart. + + XmlReader to extract from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts hi-low lines object from xml reader. + + XmlReader to extract data from. + Series object to extract. + + + + Extracts doughnut chart. + + XmlReader to extract data from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts common properties of a pie charts. + + XmlReader to extract data from. + Chart to put extracted data into. + Type of the series to create. + Chart item relations. + List that will get extracted series. + One of the parsed series. + + + + Extracts data lables. + + XmlReader to extract data from. + Parent series. + + + + Serializes data label for single data point. + + XmlReader to extract data from. + Chart series to put extracted data into. + + + + Extracts data labels settings. + + XmlReader to extract data from. + Data labels to put extracted data into. + Excel2007Parser to use if necessary. + + + + Parse the DataLeabels extension lists + + XmlReader to extract data from. + Data labels to put extracted data into. + File Data Holder + Chart item relations. + + + + Parse the DataLables Extension and leaderlines. + + XmlReader to extract data from. + Data labels to put extracted data into. + File Data Holder + Chart item relations. + + + + Parse the DataLables leader lines. + + XmlReader to extract data from. + Data labels to put extracted data into. + File Data Holder + Chart item relations. + + + + Parses single chart series of a bar chart. + + XmlReader to extract series from. + Parent chart object. + Type of the series to create. + Extracted chart series. + Chart item relations. + + + + Parse Series or category name filter + + + + + + + Parse data labels range. + + Xml reader + Chart series. + + + + parse datalabel range cache. + + Xml reader. + Chart series. + + + + Parses single chart series of a surface chart. + + XmlReader to extract series from. + Parent chart object. + Type of the series to create. + Extracted chart series. + Chart item relations. + + + + Extracts single chart series for pie chart. + + XmlReader to extract data from. + Chart to put extracted data into. + Type of the series to extract. + Chart item relations. + Extracted series. + + + + Parse the data label visibilty settings for chart series + + input XML reader + Data labels visibilty to be set + + + + Extracts line series. + + XmlReader to extract data from. + Chart to put extracted series into. + Type of the extracted series. + Chart item relations. + Extracted series. + + + + Extracts scatter series. + + XmlReader to extract series data from. + Chart to put extracted series into. + Type of the series to extract. + Chart item relations. + Extracted series. + + + + Extracts radar series. + + XmlReader to extract data from. + Chart to put extracted data into. + Type of the series to create. + Chart item relations. + Extracted series. + + + + Extracts single chart series for bubble chart. + + XmlReader to extract data from. + Chart to put extracted series into. + Extracted series. + Chart item relations. + + + + Extracts single chart series for area chart. + + XmlReader to extract data from. + Chart to put extracted series into. + Type of the series to extract. + Chart item relations. + Extracted series. + + + + Parses common part of the series. + WARNING: this method doesn't call last Read(), so this call + must be made by parent item after series parsing complete. + + XmlReader to extract data from. + Series to put extracted data into. + Chart item relations. + + + + Parses name of the series. + + XmlReader to extract data from. + Series to put extracted name into. + + + + Parses single data point. + + XmlReader to extract from. + Series to put data point into. + Parent relations. + + + + Extracts series values. + + XmlReader to extract data from. + Series to parse values for. + Array of series values. + Indicates whether axis is ValueAxis or CategoryAxis. + Range referencing series values. + + + + Extracts null reference tag. + + XmlReader to extract data from. + String which is enclosed inside the formula tag. + + + + Filtered Number Reference + + + + + + + + + Extracts string reference tag. + + XmlReader to extract data from. + String which is enclosed inside the formula tag. + + + + Filtered series range + + + + + + + + Extracts multi level string reference tag. + + XmlReader to extract data from. + String which is enclosed inside the formula tag. + + + + Parse the multi level string cache of the chart. + + XmlReader to extract the data from. + Chart Series to set the multi level cache data to. + Tag name to start parsing. + + + + + Extracts series marker from XmlReader. + + XmlReader to extract data from. + Series to serialize marker for. + + + + Parser marker fill. + + Reader to get fill information from. + Data format to put extracted marker information into. + Parser to help with color parsing. + + + + Extracts up/down bars. + + XmlReader to extract data from. + Series to put up/down bars into. + Chart item relations. + + + + Extracts single drop bar (up or down bar). + + XmlReader to extract data from. + Drop bar to put extracted data into. + Parent file data holder. + Chart item relations. + + + + This method extracts chart data table. + + XmlReader to extract data table from. + Chart to put extracted data into. + + + + Extracts series formatting options. + + XmlReader to extract formatting from. + Series to extract formatting from. + Chart item relations. + + + + Extracts default text formatting. + + XmlReader to extract data from. + Object with text formatting. + Excel2007Parser to use if necessary. + + + + Extracts number or string value from the reader. + + XmlReader to get value from. + Extracted object. + + + + Class used to parse the chartEx (Excel 2016 charts) + + + + + Extracts chart from XmlReader. + + XmlReader to serialize into. + Chart to serialize. + Chart item relations. + + + + Parse the chart data from the reader + + input XML reader + input chart + input chart relations + the chart data parsed + + + + Parse the external Data attributes and store it in chart + + input XML reader + input chart + + + + Parse the every Data node of collection and returns the list + + input XML reader + input chart + relation + the chart data parsed + + + + Parse the (string/numeric) dimension data + + input XML reader + input cache + + + + Parse the (string/numeric) data values + + input XML reader + input cache + boolean value indicates whether the dimension is string or numeric + + + + Parse the chart element data from the reader + + input XML reader + input chart + input chart relations + Chart serie Index and dataId pair + + + + Parse the chart plot area from the reader + + input XML reader + input chart + input chart relations + excel 2007 parser + Chart serie Index and dataId pair + + + + Parse the chart plot area region from the reader + + input XML reader + input chart + input chart relations + excel 2007 parser + secondary axis Id + The collection of data Id and series index pair + + + + + Parse the pareto line format + + input XML reader + input Pareto Line format + input File Data holder + input chart relations + Returns the axis id integer value + + + + Parse the ChartEx series and set the chart type and format Index + + input XML reader + input chart + output pareto line series + the output series + + + + Parse the chartEx series properties and set the series settings + + input XML reader + input chartEx series + input relation collections + + + + Parse the binning properties for histogram and pareto charts + + input XML reader + input chart serie data format + + + + Parse the chartEx series visibility for series + Box and whisker , waterfall chart + + input XML reader + input Serie Data Format + + + + Parse the chart plot area surface from the reader + + input XML reader + input chart + input chart relations + excel 2007 parser + + + + Parse the chart axes from the reader + + input XML Reader + input secondaryAxis ID + hashCodeList to identify the + Parser used to parse the Axis + input chart + Input File Data Holder + Excel 2007 parser + input chart relations + the hashcode for an axis, which will not be further modified + + + + Parse the Axis element and retruns the required axis + + input axis reader + input Axis Parser + input chart + current parsed axis id + secondary axis id + + + + + Parse the data label visibilty settings for chart series + + input XML reader + Data labels visibilty to be set + + + + Class used for parsing charts. + + + + + Contains chart line pattern values. + + + + + Initializes static members of the ChartParserCommon class. + + + + + Parses text area. + + XmlReader to extract data from. + Text area to put extracted data into. + Parent data holder object. + Chart's relations. + + + + Parses text area. + + XmlReader to extract data from. + Text area to put extracted data into. + Parent data holder object. + Chart's relations. + Default font size. + + + + Parses text area tag. + + XmlReader to extract data from. + Text area to put extracted data into. + Parent data holder object. + Chart's relations. + Default font size. + + + + Extracts default text formatting. + + XmlReader to extract data from. + Object with text formatting. + Excel2007Parser to use if necessary. + + + + Extracts value from XmlReader.. + + XmlReader to extract data from. + Extracted value. + + + + Assigns default value for val attribute. + + LocalName of the current tag. + Assigned value. + + + + Extracts boolean value from xml tag. + + XmlReader to extract data from. + Extracted value. + + + + Extracts int value from xml tag. + + XmlReader to extract data from. + Extracted value. + + + + Extracts double value from xml tag. + + XmlReader to extract data from. + Extracted value. + + + + Extracts Line properties of chart. + + XmlReader to extract data from. + Chart line properties to parse. + Excel2007Parser to help in extraction process. + + + + Extracts pattern fill. + + XmlReader to extract data from. + Fill to put extracted data into. + Excel2007Parser to help in extraction process. + + + + Extracts solid fill. + + XmlReader to extract data from. + Interior to put extracted data into. + Excel2007Parser to help in extraction process. + + + + Extracts solid fill. + + XmlReader to extract data from. + Object that is used to help in color parsing. + Color object to put extracted color into. + + + + Extracts solid fill. + + XmlReader to extract data from. + Object that is used to help in color parsing. + Color object to put extracted color into. + + + + Extracts rgb color. + + XmlReader to extract data from. + Extracted color. + + + + Extracts rgb color. + + XmlReder to extract data from. + Alpha component of the extracted color (0-100000). + Tint part of the extracted color (0-100000) or -1 if no tint part was present. + Shade part of the extracted color (0-100000) or -1 if no shade part was present. + Extracted color. + + + + Extracts scheme color and converts it into rgb. + + XmlReader to extract data from. + Excel2007Parser to help in extraction process. + Extracted color. + + + + Extracts scheme color and converts it into rgb. + + XmlReader to extract data from. + Output alpha value. + Excel2007Parser to help in extraction process. + Extracted color. + + + + Extracts preset color and converts it into rgb. + + XmlReader to extract data from. + Output alpha value. + Excel2007Parser to help in extraction process. + Extracted color. + + + + Extracts system color and converts it into rgb. + + XmlReader to extract data from. + Output alpha value. + Excel2007Parser to help in extraction process. + Extracted color. + + + + Serialize line properties. + + XmlReader to serialize into. + Chart line properties to serialize. + Indicates whether border is rounded or not + Excel2007Parser to help in extraction process. + + + + Represents ParseArrow setting + + + + + + + + Represents get head style + + + + + + + Represents get head legnth + + + + + + + Extracts picture fill. + + XmlReader to extract data from. + Fill to put extracted data into. + Chart item relations. + Parent file data holder. + + + + Extracts text from XmlReader and places it into text area. + + XmlReader to extract data from. + Text area to put extracted data into. + Parser object that helps to extract data. + + + + Parse and returns the formula / value from the reader + + input XML reader + output formula + output value + + + + Extracts layout from XmlReader and places it into text area. + + XmlReader to extract data from. + Layout to put extracted data into. + Parser object that helps to extract data. + + + + Parse the chart title stream + + input chart title stream + input chart text area element + parent data holder for chart + relation collections of chart + + + + Parses manual layout. + + XmlReader to read rich text from. + manualLayout that will get extracted the manual position settings. + Parser object that helps to extract data. + + + + Parse the string cache and used to stores it in array + + XML reader object used to parse + the parsed string array + + + + Parses rich text. + + XmlReader to read rich text from. + Text area that will get extracted rich text. + Parser object that helps to extract data. + + + + Parses text area body properties. + + XmlReader to read body properties from. + Text area to put body properties into. + + + + Extracts list styles for a text area. + + XmlReader to extract list styles from. + Text area that will get extracted settings. + + + + Parses paragraph. + + XmlReader to get paragraph tag from. + Text area that will get paragraph information (formatting and text). + Parser object that helps to extract data. + Default text area that will get default paragraph information. + + + + Parses fld element. + + XmlReader to get paragraph run from. + Text area to put extracted properties into. + Parser object that helps to extract data. + Default text settings. + Default font size + + + + Parses paragraph properties. + + XmlReader to get data from. + + + + Extracts default paragraph properties from the reader. + + Reader to get properties from. + Instance of Excel2007Parser that helps in parsing process. + Default paragraph properties. + + + + Extracts default paragraph properties from the reader. + + Reader to get properties from. + Instance of Excel2007Parser that helps in parsing process. + Default font size. + Default paragraph properties. + + + + Extracts color of the default paragraph. + + + + + + + Parses paragraph run. + + XmlReader to get paragraph run from. + Text area to put extracted properties into. + Parser object that helps to extract data. + Default text settings. + + + + Parses paragraph run. + + XmlReader to extract paragraph tag from. + Text area that will get paragraph run information (formatting and text). + Parser object that helps to extract data. + Default text settings. + + + + + Extracts gradient stops collection from the specified reader. + + XmlReader to extract data from. + Excel2007Parser to help in extraction process. + Extracted gradient stops. + + + + Extracts gradient path. + + XmlReader to extract from. + Resulting GradientStop collection + + + + Extracts GradientStops collection. + + XmlReader to extract data from. + Parser object that helps to extract data. + Extracted collection. + + + + Extracts single GradientStop settings. + + XmlReader to extract data from. + Excel parser to help in extraction process. + Extracted GradientStop. + + + + Parse the Scheme color. + + + + + + + + Parse the Scheme color of shadow + + + + + + + + Extracts color settings. + + XmlReader to extract data from. + Transparency part of the extracted color (0-100000) or -1 if no transparecy part was present. + Tint part of the extracted color (0-100000) or -1 if no tint part was present. + Shade part of the extracted color (0-100000) or -1 if no shade part was present. + Excel parser to help in extraction process. + Color extracted. + + + + Converts Excel 2007 gradient stops collection into set of properties used by Excel 97-2003. + + Gradient stops collection to convert. + Fill object to put extracted properties into. + + + + To check the default settings of text area + + Text area to check the default values + + + + Copies color data from GradientStop. + + Color object to copy data into. + GradientStop to copy color data from. + + + + Extracts shape properties. + + XmlReader to extract data from. + Object that provides access to filling objects. + FileDataHolder of the document that is parsed. + Chart item relations. + + + + Parses the lighting. + + The reader. + The shadow. + The relations. + The holder. + + + + Checks the specified lighttype. + + The lighttype. + + + + + This method tries to get the Bevel properties read from the XML + + Linewidth mentions the Width of the line and represents the 'W' tag + LineHeight mentions the Heigth and represents the 'H' tag + Presetshape mentions the shape of the 3D feature + XmlReader to extract data from. + it returns the Excel2007Chartbevel properties or Noangle will be returned(which means 0) + + + + This method tries to get the material properties + + Material is denotes the type of the Material properties read from the XML + XmlReader to extract data from. + Excel 2007 chartmaterial properties or Noeffect value will be returned(which means 0) + + + + Checks the specified custom shadow color. + + The shadow. + The reader. + The parser. + + + + + Parses the Shadow Properties + + XmlReader to extract data from. + Shadow object to access the properties + Object that provides access to filling objects. + FileDataHolder of the document that is parsed. + Chart item relations. + Excel 2007 Parser + + + + + + It gets the Blur Radius Tag value + It gets the Sizex Tag value + It gets the Sizey Tag value + It gets the Distance Tag Tag value + It gets the Direction Tag value + It gets the Alignment Tag value + It gets the Rotationwithshape Tag value + Excel 2007 Parser + Shadow object to access the properties + Xml reader to extract data from. + The Office2007ChartPresetsOuter value or Noshadow value will be returned(Which means 0) + + + + Checks the specified Custom Outer Shadow . + + The blurval. + The sizex. + The disttag. + The dirtag. + The align. + The rot. + The shadow. + The reader. + The parser. + + + + + Parses the shadow alpha. + + The reader. + The shadow. + + + + Extracts value from XmlReader.. + + XmlReader to extract data from. + Extracted value. + + + + This Method tries to get the value of perspective shadow + + It gets the Blur Radius Tag value + It gets the Sizex Tag value + It gets the Sizey Tag value + It gets the Kx Tag value + It gets the Distance Tag Tag value + It gets the Direction Tag value + It gets the Alignment Tag value + It gets the Rotationwithshape Tag value + the Excel2007Chartpresetsperspective value or NoShadow value will be returned(which means 0) + + + + This method tries to get the Inner shadow values based on the parsed Info + + It gets the Blur Radius Tag value + It gets the Distance Tag Tag value + It gets the Direction Tag value + This returns the Office2007ChartPresetsInner value or No shadow (which means 0) + + + + Checks the Custom Inner Shadow. + + The blurval. + The disttag. + The dirtag. + The shadow. + The reader. + if set to true [Current format has Custom shadow style]. + + + + + This method tries to detect gradient color settings (One or Two color gradient). + + Gradient stops to detect gradient color + Detected gradient color or -1 if it is neither one nor two color gradient. + + + + Detects gradient variant type. + + Gradient stops to detect variant type for. + Already detected gradient style. + Already detected gradient color. + Indicates whether gradient stops for preset + gradient are in inverted order. This argument is used in the case of OfficeGradientColor.Preset. + Detected gradient variant type. + + + + Detects diagonal gradient variant. + + Checks whether gradient stops in the collection are in inverted order or not. + Represents double order variant. + Detected gradient variant. + + + + Detects gradient variant. + + Checks whether gradient stops in the collection are in inverted order or not. + Represents double ordered variant. + Detected gradient variant. + + + + Detects gradient variant for FromCorner gradient style. + + FillToRect used by gradient stops collection. + Detected gradient variant. + + + + Checks whether gradient stops in the collection are in inverted order or not. + + Gradient stops to check. + Gradient color type. + Indicates whether gradient stops for preset + gradient are in inverted order. This argument is used in the case of OfficeGradientColor.Preset. + True if gradient stops are inverted. + + + + Detect Gradient style. + + Gradient stops to check. + Detected Gradient style. + + + + Gets gradient style for rectangular gradient. + + Gradient stops collection to get gradient style for. + Converted gradient style. + + + + Gets gradient style for linear gradient. + + Gradient stops collection to get gradient style for. + Converted gradient style. + + + + Tries to find preset gradient corresponding to the specified collection. + + Gradient stops collection to analyze. + Indicates whether gradient stops are in inverted order. + Preset value or ( OfficeGradientPreset )( -1 ) if there is no corresponding preset value found. + + + + Sets GradientDegree property if necessary. + + Gradient stops to detect degree from. + Detected gradient color. + Fill to set gradient degree for. + + + + This class is responsible for chart object serialization into XmlWriter in Excel 2007 SpreadsheetML format. + + + + + Default constructor + + + + + Serializes chart inside XmlWriter. + + XmlWriter to serialize into. + Chart to serialize. + Name of the xml file containing chart item. + Represent the version of the application + + + + Serializes chart inside XmlWriter. + + XmlWriter to serialize into. + Chart to serialize. + Name of the xml file containing chart item. + + + + Serializes clrMapOvr tag. + + + + + + + Serializes the Chart default text properties. + + XmlWriter to serializes into. + chart to get the data to serialize. + + + + Serializes shapes. + + XmlWriter to serialize into. + Chart to serialize shapes for. + Name of the xml file containing chart item. + + + + Serializes chart legend. + + XmlWriter to serialize into. + Chart legend to serialize. + Parent chart object. + + + + Serializes single legend entry. + + XmlWriter to serialize legend entry into. + Legend entry to serialize. + Legend entry index. + Parent workbook object. + + + + Serializes view 3D. + + XmlWriter to serialize legend entry into. + Chart to serialize shapes for. + + + + Serializes error bars. + + XmlWriter to serialize into. + Error bars to serialize. + Error bars direction (x or y). + Parent workbook. + + + + Serializes trendlines collection. + + XmlWriter to serialize into. + Trendlines to serialize. + Parent workbook. + + + + Serializes trend line. + + XmlWriter to serialize into. + Trend line to serialize. + Parent workbook. + + + + Serializes trend line label settings. + + XmlWriter to serialize into. + Data label to serialize. + + + + Serializes surface (wall or floor). + + XmlWriter to serialize into. + Surface to serialize. + Name of the top xml tag to use. + Parent chart object. + + + + Serializes plotarea tag and everything inside it. + + XmlWriter to serialize into. + Chart to serialize. + + + + Serializes bar chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized bar series. + + + + Serializes axis id's for bar chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + + + + Serialize bar3D chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized 3Dbar series. + + + + Serializes gap depth. + + XmlWriter to serialize into. + Chart to serialize gap depth for. + + + + Serializes shape of the bar chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + + + + Serializes part of the bar chart that is common for all bar charts. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized bar series. + + + + Serializes chart series with the same formatting. + + XmlWriter to serialize into. + Chart to get series from. + First series in the list of the series to serialize. + It is used to determine which series should be serialized. + Delegate used to serialize chart series. + Number of serialized series. + + + + serialiae filtered serie + + + + + + + Serilaize filtered series + + + + + + + Serialize Filtered Text + + + + + + + Serialize filtered text values + + + + + + + + serialize filtered category + + + + + + + + serialize filtered values + + + + + + + + Returns the series filter type + + + + + + + Serializes grouping tag. + + XmlWriter to serialize into. + Chart to serialize grouping for. + + + + Serializes area3D chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized area3D series. + + + + Serializes area chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized area series. + + + + Serializes properties common to the area chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + This method serializes common properties of the line charts. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized line series. + + + + Serialize line3DChart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized line3D series. + + + + Serializes line chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized line series. + + + + Serialize bubble chart. + + XmlWriter to serialize chart into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized bubble series. + + + + Serializes 2-D surface chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes 3-D surface chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes common part of the surface charts. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes preserved band formats if necessary. + + XmlWriter to serialize into. + Chart to serialize. + + + + Serializes main chart tag. + + XmlWriter to serialize into. + Chart to serialize. + Index of the series group to serialize. + Number of the serialized series. + + + + Serializes radar chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes scatter chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes pie chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes 3-D pie chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes pie of pie or pie of bar chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes stock chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes doughnut chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes common properties of pie charts. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes data lables. + + XmlWriter to serialize into. + parent chart + data points to be serialized + + + + Serializes data lables. + + XmlWriter to serialize into. + DataLabels to serialize. + Parent series. + + + + Serializes number format. + + XmlWriter to serialize into. + Number format serialize. + Parent series. + + + + Serializes data label for single data point. + + XmlWriter to serialize into. + Data labels to serialize. + Data point index. + Parent chart object. + + + + Serializes data labels settings. + + XmlWriter to serialize into. + Data labels to serialize. + Parent chart. + + + + Serializes default text formatting. + + XmlWriter to serialize into. + Text formatting to serialize. + Parent workbook. + + + + Serializes IsVaryColors option. + + XmlWriter to serialize into. + First series in the list of series with the + same formatting to serialize vary colors option for. + + + + Serializes single chart series for bar chart. + + XmlWriter to serialize into. + Series to serialize. + + + + Serialize the InvertIfNegativeColor. + + Xml writer + Series to serialize. + + + + Seriealize value from cells range in datalabels. + + Xml Writer + ChartSerieImpl + + + + Serialize datalabel range cache. + + Xml writer + series value from cell range values. + + + + Find the category filter + + + + + + + To update the filtered value range + + + + + + Update the category filterlabel range + + + + + + serialize the filtered category or series name + + + + + + + + serilaize the category name + + + + + + + Serializes single chart series for pie chart. + + XmlWriter to serialize into. + Series to serialize. + + + + Serializes error bars. + + XmlWriter to serialize into. + Series to serialize. + + + + Serialize line series. + + XmlWriter to serialize into. + Chart line series to serialize. + + + + Serializes scatter series. + + XmlWriter to serialize into. + Chart scatter series to serialize. + + + + Serializes chart radar series. + + XmlWriter to serialize into. + Chart series to serialize. + + + + Serializes single chart series for bubble chart. + + XmlWriter to serialize into. + Series to serialize. + + + + Serializes single chart series for area chart. + + XmlWriter to serialize into. + Series to serialize. + + + + Serializes common part of the series. + WARNING: this method doesn't call last WriteEndElement(), so this call + must be made by parent item after series serialization complete. + + XmlWriter to serialize into. + Series to serialize. + + + + Serializes single data point. + + XmlWriter to serialize into. + Data point to serialize. + + + + Serializes series category. + + XmlWriter to serialize into. + Series to serialize category labels for. + + + + Serializes series category. + + XmlWriter to serialize into. + Series to serialize category labels for. + + + + Serializes series values. + + XmlWriter to serialize into. + Series to serialize values for. + + + + Serializes series values. + + XmlWriter to serialize into. + Series to serialize values for. + + + + Serializes series values. + + XmlWriter to serialize into. + Range to serialize values for. + Name of the xml tag to use. + + + + Serializes the normal reference. + + The writer. + The range. + The values. + Name of the tag. + + + + Serializes number or string reference. + + + + + + + Serializes number references. + + XmlWriter to serialize into. + Range to serialize values for. + Range values to serialize cache values for. + + + + This function is used for serializing the number cache values. + + This is used for serializing the chart date in XML format. + This is Holding the chart serie type of values. + This is used to get the current tag name. + + + + Serializes string references. + + XmlWriter to serialize into. + Range to serialize values for. + + + + Serializes String references. + + XmlWriter to serialize into. + Range to serialize values for. + + + + This function is used for serializes the string cache values for the current chart serie. + + Used to write the string cache values in XML format. + This is holding the Chart Serie contents. + + + + This is used for serializes the Category type of string Cache values. + + This is used to write the chart serie category values in XMl format. + This is holding the Chart serie contents. + + + Returns a DateTime equivalent to the specified OLE Automation Date. + An OLE Automation Date value. + An object that represents the same date and time as input date. + + This function is used to fint the object type and convert to string based on cluture. + + Object type of value + + + + + Serializes Multi level string references. + + XmlWriter to serialize into. + Range to serialize values for. + Range values to serialize cache values for. + + + + Serializes multi level string cache. + + XmlWriter to serialize into. + Chart series to get the cache data from. + + + + Serializes the formula if the range is null + + XMLWriter to serialize into + Tag to serialize values for + Formula to serialize for the tag + + + + Serializes chart axes. + + XmlWriter to serialize into. + Chart to serializes axes of. + + + + Serializes series marker if necessary. + + XmlWriter to serialize into. + Series to serialize marker for. + + + + Serializes series marker if necessary. + + XmlWriter to serialize into. + Series to serialize marker for. + + + + Serializes line with the specified color. + + XmlWriter to serialize into. + Line color. + Parent workbook. + + + + Serializes up/down bars. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with same + formatting to serialize up/down bars for. + + + + Serializes single drop bar (up or down bar). + + XmlWriter to serialize into. + Drop bar to serialize. + Name of the main tag. + Chart to serialize dropbar for. + + + + This method serializes chart data table. + + XmlWriter to serialize into. + Chart to serialize data table for. + + + + Serializes series value that were entered directly. + + XmlWriter to serialize into. + Values to serialize. + + + + Serializes series value that were entered directly. + + XmlWriter to serialize + Values to serialize. + series to get the format code + + + + Converts object into xml string. + + Value to convert. + Converted value. + + + + This delegate is used for series serialization. + + XmlWriter to serialize series into. + Series to serialize. + + + + This class is responsible for chartEx object (all) serialization into XmlWriter in Excel SpreadsheetML format. + + + + + Represents dictionary for TickMark to Attribute value. + + + + + Initialize the members of this class + + + + + Serialize the chart + + input XML writer + input chart + + + + Serialize the chart tag input element + + input XML writer + input chart + input relations + + + + Serializes plotarea tag and everything inside it. + + XmlWriter to serialize into. + Chart to serialize. + input relation collection + + + + Serialize the required axes + + XmlWriter to serialize into. + Chart to serialize. + chart type of the chart + input relation collection + + + + Serialzie the single axis + + input XML writer + input axis to be serialized + input Chart to serialize. + input relation collection + axis Id of the axis + + + + Serialzie the single axis common properties + + input XML writer + input axis to be serialized + input Chart to serialize. + input relation collection + axis Id of the axis + + + + Serialzie the axis display unit + + input XML writer + input axis to be serialized + input Chart to serialize. + input relation collection + axis Id of the axis + + + + Serialize the chart's every pareto line as series + + input XML writer + input chart + input chartType + + + + Serialize the input serie and everything inside it. + + input XML writer + input chart serie + input chart serie Index for data referring + chart type + input chart + relation collection of the chart + + + + Serialize the input chart serie layout properties + + input XML writer + input chart serie + input chart + relation collection of the chart + + + + Serialize the subtotal data points of the series + + input XML writer + input serie to subtotal serialized + + + + Serialize the bin properties of the chart + + input XML writer + input chart serie data format for binning properties + input chart + + + + Serialize the single chart serie data labels + + input XML writer + input serie to data labels serialized + input chart + input chart relations + + + + Serializes the input data label settings + + input XML writer + input data labels + paret chart of the data labels + chart relation collection + + + + check whether the frame format is formatted or not + + input chart frame format impl + the boolean value + + + + Serializes number format. + + XmlWriter to serialize into. + dataLabels of data points which have number format to serialize + + + + Serialize the data point properties of the chart serie + + input XML writer + input chart serie + + + + Serialize the chart serie name + + input XML writer + input chart serie + + + + Serialize the single chart serie attributes + + input XML writer + input chart serie + chart type of the chart + chart serie index + boolean value indicates whether the pareto line option is serialized or not + + + + Serialize the chart legend + + input XML writer + input chart legend + input chart + + + + Serialize the chart text area properties for text elements + + input XML writer + input chart text area + input chart + input relation collection + default font size for text area + input XML elemet parent + boolean value indicates whether the title is auto + boolean value indicates whether element is chart title + + + + Serialize the chart text element properties for chart title and legend + + input XML writer + input position of element + boolean value indicates the layout of element + + + + Serialize the chart text area Tx and rich + + input XML writer + input chart text area + input chart + default font size for text area + boolean value indicates whether the title serialized as rich text or not + + + + Serialize the chartEx data element + + input XML writer + input chart + + + + Individial series data serialized with this. + + input XML chart + input chart serie + serie index + chart type + + + + Serialize the dimension data for series + + input XML writer + input range + input direct values array + boolean value indicates whether range is in row + number format code + Indeicates whether the range is category or series values + + + + This class contains common code used for charts serialization. + + + + + Key - OfficeChartLinePattern, + Value - pair, where key is Excel 2007 pattern value, value - preset pattern of the pattern fill. + + + + + Jagged Array represents the Outer Shadow Attributes + + + + + Jagged Array represents the Inner Shadow Attributes + + + + + Jagged Array represents the Perspective Shadow Attributes + + + + + Jagged Array represents the 3D Bevel Attributes + + + + + Jagged Array represents the 3D Material Attributes + + + + + Jagged Array represents the 3D Lighting Attributes + + + + + Initializes static members of ChartSerializatorCommon class. + + + + + Serializes frame format. + + XmlWriter to serialize into. + Fill format to serialize. + Parent chart object. + Indicates whether area corners should be rounded. + + + + Serializes frame format. + + XmlWriter to serialize into. + Fill format to serialize. + Parent chart object. + Indicates whether area corners should be rounded. + + + + Serializes frame format. + + XmlWriter to serialize into. + Fill format to serialize. + Parent file data holder. + Chart's relations collection + Indicates whether area corners should be rounded. + + + + This method serializes the Shadow properties + + XmlWriter to serialize into. + Shadow format to serialize into + Whether the current format contains the Custom Shadow Style + + + + Serializes the custom shadow properties + + XmlWriter to serialize into. + The ShadowImpl object. + + + + Serializes the inner shadow. + + XmlWriter to serialize into. + The jagged array index of the InnerAttributeArry. + if set to true [custom shadow style]. + The ShadowImpl object. + + + + This method Serializes the Outer Shadow + + XmlWriter to serialize into. + the jagged array index of OuterAttributeArry + if set to true [custom shadow style]. + The ShadowImpl object + + + + This method serializes the Perspective shadow properties + + XmlWriter to serialize into. + the jagged array index of PerspectiveAttributeArry + if set to true [custom shadow style]. + The ShadowImpl object + + + + This method Serailizes the 3DProperties + + XmlWriter to serialize into. + ThreeD format + + + + This method serailize the Lighting properties + + XmlWriter to serialize into. + the jagged array index of LightingPropertiesArray + + + + This method serialize the Material properties + + XmlWriter to serialize into. + the jagged array index of MaterialPropertiesArray + + + + This method serialize the Bevel top + + XmlWriter to serialize into. + the jagged array index of bevelpropertiesArray + + + + This method serializes the Bevel Bottom + + XmlWriter to serialize into. + the jagged array index of Bevelproperties Array + + + + Serializes fill object. + + XmlWriter to serialize into. + Fill to serialize. + Parent file data holder. + Chart's relations collection + + + + Serializes text area. + + XmlWriter to serialize into. + Text area to serialize. + Parent workbook. + Chart's relations. + + + + Serialize xml tag that contains value attribute with tag value. + + XmlWriter to serialize into. + Tag name to serialize. + Value to serialize. + + + + Serialize the double value attributes. + + + + + + + + Serialize xml tag that contains value attribute with tag value. + + XmlWriter to serialize into. + Tag name to serialize. + Namespace of the xml tag. + Value to serialize. + + + + Seralize the double value + + + + + + + + + Serialize xml tag that contains value attribute with tag value. + + XmlWriter to serialize into. + Tag name to serialize. + Value to serialize. + + + + Serializes chart line properties. + + XmlWriter to serialize into. + Border to serialize. + Parent workbook. + + + + Serializes pattern fill. + + XmlWriter to serialize into. + Color to serialize. + Indicates whether color is automatic and should be ignored or not. + Preset dash value. + Preset pattern value. + Parent workbook. + + + + Serializes pattern fill. + + XmlWriter to serialize into. + Foreground color. + Indicates whether foreground color is auto and foreColor argument should be ignored. + Background color. + Indicates whether background color is auto and backColor argument should be ignored. + Preset pattern value. + Parent workbook. + + + + Serializes pattern fill. + + XmlWriter to serialize into. + Foreground color. + Indicates whether foreground color is auto and foreColor argument should be ignored. + Background color. + Indicates whether background color is auto and backColor argument should be ignored. + Pattern to serialize. + Parent workbook. + + + + Serializes solid fill. + + XmlWriter to serialize into. + Color that is used for filling. + Indicates whether color is automatic or was manually changed. + Parent workbook. + + + + Serializes rgb color. + + XmlWriter to serialize into. + Color to serialize. + + + + Serializes rgb color. + + XmlWriter to serialize into. + Color index to serialize. + Parent workbook. + + + + Serializes rgb color. + + XmlWriter to serialize into. + Color to serialize. + Alpha component of the color to serialize, 0 - 100000. + + + + Serializes rgb color. + + XmlWriter to serialize into. + Color to serialize. + Alpha component of the color to serialize, 0-100000. + Tint value of the color to serialize, 0-100000. + Shape value of the color to serialize, 0-100000. + + + + Serialize line properties. + + XmlWriter to serialize into. + Chart line properties to serialize. + Indicates whether border is rounded or not + Parent workbook. + + + + Returns the cap style for serializing. + + + + + + + + Serailize Line Join Type + + XmlWriter to serialize into. + Line Join Type + + + + Return the image stream from the given image + + the input image + the image object + + + + Serializes picture fill. + + XmlWriter to serialize into. + Picture to serialize. + Parent file data holder object. + Relations collection to add relation to. + Indicates whether image should be tiled. + + + + Serialize the picture with fillrect and source rect. + + + + + Serializes texture fill. + + XmlWriter to serialize into. + Fill object that contains settings to serialize. + Parent file data holder object. + Relations collection to add relation to. + + + + Serializes gradient fill. + + XmlWriter to serialize into. + Fill to serialize. + Parent workbook. + + + + Serializes default text formatting. + + XmlWriter to serialize into. + Text formatting to serialize. + Parent workbook. + + + + Serializes text from text area. + + XmlWriter to serialize into. + Text area to serialize values for. + Parent workbook. + + + + Serializes rich text. + + XmlWriter to serialize into. + Text area that contains rich text to serialize. + Parent workbook. + Name of the main xml tag. + + + + Serialize text area body properties. + + XmlWriter to serialize into. + Text area to serialize body properties for. + + + + Serializes list styles for a text area. + + XmlWriter to serialize into. + Text area to serialize list styles for. + + + + Serializes paragraph. + + XmlWriter to serialize paragraph tag into. + Text area that contains paragraph information (formatting and text). + Parent workbook. + + + + Serializing the rich-text formatting + + XmlWriter to serialize paragraph tag into. + Text area that contains paragraph information (formatting and text) of text area. + Parent workbook. + Default font size + + + + Serializing the rich-text formatting + + XmlWriter to serialize paragraph tag into. + Text area that contains paragraph information (formatting and text) of text area. + Parent workbook. + Default font size + Default text area that contains paragraph information (formatting and text) of text area. + Run properties start index. + + + + Serializing the rich-text formatting + + XmlWriter to serialize paragraph tag into. + Text area that contains paragraph information (formatting and text) of data labels. + Parent workbook. + Default font size + + + + Check the serialize fld element. + + Chart data label + Data label text. + fld element type + if serialize the fld return true otherwise false. + + + + Serializes paragraph run. + + XmlWriter to serialize paragraph tag into. + Text area that contains paragraph run information (formatting and text). + Name of the main xml tag. + Parent workbook. + + + + Serializes paragraph run. + + XmlWriter to serialize paragraph tag into. + Text area that contains paragraph run information (formatting and text). + Name of the main xml tag. + Parent workbook. + + + + Serializes string reference settings. + + XmlWriter to serialize into. + Text area to get settings from. + String array used as cache values + + + + Serializes text area layout settings. + + XmlWriter to serialize into. + Text area to serialize layout settings for. + + + + Boolean value indicates whether the element is manual layoutted + + input manual layout object + the boolean value + + + + Serializes text area manual layout settings. + + XmlWriter to serialize into. + Manual layout to serialize manual layout settings for. + + + + This method serialize the Bevel bottom + + XmlWriter to serialize into. + Bevel bottom Height Value + Bevel bottom width Value + + + + This method serialize the Bevel top + + XmlWriter to serialize into. + Bevel top Height Value + Bevel top width Value + + + + This class contains constants used for autofilter parsing and serialization in Excel 2007 format. + + + + + Name of the xml tag name that represents auto filter settings. + + + + + Name of the xml attribute that represents reference to the cell range to which the AutoFilter is applied. + + + + + Name of the xml tag that identifies a particular column in the AutoFilter range and specifies + filter information that has been applied to this column + + + + + Name of the xml attribute that indicates the AutoFilter column to which this filter information applies. + + + + + Name of the xml tag that specifies the top N (percent or number of items) to filter by. + + + + + Name of the xml attribute that represents top or bottom value to use as the filter criteria. + + + + + Name of the xml attribute that represents flag indicating whether or not to filter by top order. + + + + + Name of the xml attribute that represents the actual cell value in the range + which is used to perform the comparison for this filter. + + + + + Name of the xml attribute that represents flag indicating whether or not to filter by percent value of the column. + + + + + Name of the xml tag that groups filter criteria together. + + + + + Flag indicating whether to filter by blank. + + + + + Name of the xml tag that expresses a filter criteria value. + + + + + Name of the xml attribute that represents filter value used in the criteria. + + + + + Name of the xml tag that represents custom filters criteria. + + + + + Name of the xml attribute that represents flag indicating whether the two criteria have an "and" relationship. + '1' indicates "and", '0' indicates "or". + + + + + Name of the xml tag that represents custom filter criteria. + + + + + Name of the xml attribute name that represents operator used by the filter comparison. + + + + + Show results which are equal to criteria. + + + + + Show results which are greater than criteria. + + + + + Show results which are greater than or equal to criteria. + + + + + Show results which are less than criteria. + + + + + Show results which are less than or equal to criteria. + + + + + Show results which are not equal to criteria. + + + + + This class contains constants required for charts parsing and serialization in Excel 2007 format. + + + + + Main charts namespace. + + + + + Main charts namespace. + + + + + Namespace of the slicer + + + + + Main charts namespace for Excel 2010 + + + + + Chart color style namespace for Excel 2013 + + + + + Chart style namespace for Excel 2013 + + + + + Uri for the pivot chart. + + + + + prefix for the Excel 2010 chart tag. + + + + + This element specifies a category axis. + + + + + This element specifies a value axis. + + + + + This element specifies a series axis. + + + + + This element specifies a date axis. + + + + + Value attribute. + + + + + Some value axis id. + + + + + Some category axis id. + + + + + Some series axis id. + + + + + Some secondary category axis id. + + + + + Some secondary value axis id. + + + + + This element contains additional axis settings. + + + + + This element specifies the logarithmic base for a logarithmic axis. + + + + + This element specifies the maximum value of the axis. + + + + + This element specifies the minimum value of the axis. + + + + + This element specifies the stretching and stacking of the picture on the + data point, series, wall, or floor. + + + + + When specified as a child element of valAx, dateAx, catAx, or serAx, + this element specifies the identifier for the axis. When specified as + a child element of a chart, this element specifies the identifier of + an axis that defines the coordinate space of the chart. + + + + + Specifies that the values on the axis shall be reversed so they go from maximum to minimum. + + + + + Specifies that the axis values shall be in the usual order, minimum to maximum. + + + + + This element specifies the position of the axis on the chart. + + + + + Specifies that the axis shall be displayed at the left of the plot area. + + + + + Specifies that the axis shall be displayed at the right of the plot area. + + + + + Specifies that the axis shall be displayed at the top of the plot area. + + + + + Specifies that the axis shall be displayed at the bottom of the plot area. + + + + + This element specifies major gridlines. + + + + + This element specifies minor gridlines. + + + + + This element specifies number formatting for the parent element. + + + + + This element specifies a string representing the format code to apply. + + + + + Indicates whether number format is applied to the axis. + + + + + This element specifies the position of the tick labels on the axis. + + + + + Specifies the axis labels shall be at the high end of the perpendicular axis. + + + + + Specifies the axis labels shall be at the low end of the perpendicular axis. + + + + + Specifies the axis labels shall be next to the axis. + + + + + Specifies the axis labels are not drawn. + + + + + This element specifies the major tick marks. + + + + + This element specifies the minor tick marks. + + + + + Specifies there shall be no tick marks. + + + + + Specifies the tick marks shall be inside the plot area. + + + + + Specifies the tick marks shall be outside the plot area. + + + + + Specifies the tick marks shall cross the axis. + + + + + This element specifies the ID of axis that this axis crosses. + + + + + This element specifies whether the value axis crosses the category axis between categories. + + + + + Specifies the value axis shall cross the category axis between data markers. + + + + + Specifies the value axis shall cross the category axis at the midpoint of a category. + + + + + This element specifies the distance between major ticks. + + + + + This element specifies the distance between minor tick marks. + + + + + This element specifies the distance of labels from the axis. + + + + + This element specifies how many tick labels to skip between label that is drawn. + + + + + This element specifies how many tick marks shall be skipped before the next one shall be drawn. + + + + + This element specifies whether multi level labels exists or not + + + + + This element specifies the smallest time unit that is represented on the date axis. + + + + + This element specifies the time unit for major tick marks. + + + + + This element specifies the time unit for the minor tick marks. + + + + + This element specifies the chart. + + + + + This element specifies the plot area of the chart. + + + + + This element specifies whether the series form a bar (horizontal) chart or a column (vertical) chart. + + + + + Specifies that the chart is a bar chart - the data markers are horizontal rectangles. + + + + + Specifies that the chart is a column chart - the data markers are vertical rectangles. + + + + + This element specifies the type of grouping for a bar chart. + + + + + Specifies that the chart series are drawn next to each other along the category axis. + + + + + Specifies that the chart series are drawn next to each other along the + value axis and scaled to total 100%. + + + + + Specifies that the chart series are drawn next to each other on the value axis. + + + + + Specifies that the chart series are drawn next to each other on the depth axis. + + + + + This element specifies that each data marker in the series shall have a different color. + + + + + This element specifies a series on a chart. + + + + + This element specifies the index of the containing element. This index + shall determine which of the parent's children collection this element applies to. + + + + + This element specifies the order of the series in the collection. It is 0 based. + + + + + This element specifies the data values which shall be used to define + the location of data markers on a chart. + + + + + This element specifies the data used for the category axis. + + + + + This element specifies a reference to numeric data with a cache of the last values used. + + + + + This element specifies a reference to string data with a cache of the last values used. + + + + + This element specifies a reference to data for the category axis (or for the x-values in a bubble or scatter chart)), + along with a cache of the last values used. + + + + + This element specifies the last numeric data used for a chart. + + + + + This element specifies the last string data used for a chart. + + + + + This element specifies a cache of the labels on the category axis, or the x-values in a bubble or scatter chart. + + + + + This element specifies a reference to source of the data contained in this chart. + + + + + This element specifies overall settings for a single chart, and is the root node for the chart part. + + + + + This element specifies the 3-D area series on this chart. + + + + + This element specifies the 2-D area series on this chart. + + + + + This element contains the 2-D bar or column series on this chart. + + + + + This element contains the 3-D bar or column series on this chart. + + + + + This element contains the 3-D line chart series. + + + + + This element contains the 2-D line chart series. + + + + + This element specifies the space between bar or column clusters, + as a percentage of the bar or column width. + + + + + This element specifies the space between bar or column clusters, + as a percentage of the bar or column width. + + + + + This element specifies how much bars and columns shall overlap on 2-D charts. + + + + + Specifies the chart shall be drawn as a cone, with the base of the cone + on the floor and the point of the cone at the top of the data marker. + + + + + Specifies the chart shall be drawn with truncated cones such that the + point of the cone would be the maximum data value. + + + + + Specifies the chart shall be drawn as a rectangular pyramid, with the + base of the pyramid on the floor and the point of the pyramid at the + top of the data marker. + + + + + Specifies the chart shall be drawn with truncated cones such that the + point of the cone would be the maximum data value. + + + + + Specifies the chart shall be drawn as a cylinder. + + + + + Specifies the chart shall be drawn with a box shape. + + + + + This element specifies the shape of a series or a 3-D bar chart. + + + + + This element contains the bubble series on this chart. + + + + + This element specifies that the bubbles have a 3-D effect applied to them. + + + + + Default bubble scale value. + + + + + This element specifies the scale factor for the bubble chart. This element can be + an integer value from 0 to 300, corresponding to a percentage of the default size. + + + + + This element specifies negative sized bubbles shall be shown on a bubble chart. + + + + + Specifies the area of the bubbles shall be proportional to the bubble size value. + + + + + Specifies the radius of the bubbles shall be proportional to the bubble size value. + + + + + This element specifies how the bubble size values are represented on the chart. + + + + + This element contains the set of 2-D contour charts. + + + + + This element contains the set of 3-D surface series. + + + + + This element specifies the surface chart is drawn as a wireframe. + + + + + This element contains the radar chart series on this chart. + + + + + This element specifies what type of radar chart shall be drawn. + + + + + This element contains the scatter chart series for this chart. + + + + + This element specifies the type of lines for the scatter chart. + + + + + This element contains the 2-D pie series for this chart. + + + + + This element contains the 3-D pie series for this chart. + + + + + This element specifies the angle of the first pie or doughnut chart slice, + in degrees (clockwise from up). + + + + + This element contains the doughnut chart series. + + + + + This element specifies the size of the hole in a doughnut chart group. + + + + + This element contains the pie of pie or bar of pie series on this chart. + + + + + Specifies that the chart is pie of pie chart, not a bar of pie chart. + + + + + Specifies that the chart is a bar of pie chart, not a pie of pie chart. + + + + + This element specifies whether this chart is pie of pie or bar of pie. + + + + + This element specifies a value that shall be used to determine which data + points are in the second pie or bar on a pie of pie or bar of pie chart. + + + + + This element specifies the size of the second pie or bar of a pie of pie + chart or a bar of pie chart, as a percentage of the size of the first pie. + + + + + This element specifies how to determine which data points are in the + second pie or bar on a pie of pie or bar of pie chart. + + + + + This element contains the collection of stock chart series. + + + + + This element serves as a root element that specifies the settings for the + data labels for an entire series or the entire chart. It contains child + elements that specify the specific formatting and positioning settings. + + + + + This element specifies the position of the data label. + + + + + This element specifies the show the dalabels range. + + + + + This element specifies the dalabel range. + + + + + This element specifies the dalalabelRangeCache name. + + + + + This element specifies the Uri Tag. + + + + + This element specifies the Uri Id link. + + + + + This element specifies the C15 nameSpaces. + + + + + This element specifies a cellRange tag. + + + + + This element specfies a seriesName tag. + + + + + This element specifies a value tage. + + + + + This element specifies a category name tag. + + + + + This element specifies a percentage tag. + + + + + This element specifies a category x axis tag. + + + + + This element specifies a value y axis tag. + + + + + Prefix for Chart 15. + + + + + This element specifies that the value shall be shown in a data label. + + + + + This element specifies that the category name shall be shown in the data label. + + + + + This element specifies that the percentage shall be shown in a data label. + + + + + This element specifies the bubble size shall be shown in a data label. + + + + + This element specifies that the series name shall be shown in a data label. + + + + + This element specifies legend keys shall be shown in data labels. + + + + + This element specifies Leader Lines shall be shown in data labels. + + + + + This element specifies text that shall be used to separate the parts of a data label. + The default is a comma, except for pie charts showing only category name and percentage, + when a line break shall be used instead. + + + + + This element specifies a data marker. + + + + + This element specifies the marker that shall be used for the data points. + + + + + This element specifies the size of the marker in points. + + + + + This element specifies the floor of a 3D chart. + + + + + This element specifies the back wall of the chart. + + + + + This element specifies the side wall. + + + + + This element specifies a title. + + + + + This element specifies a trend line. + + + + + This element specifies the name of the trend line. + + + + + This element specifies the type of the trend line. + + + + + This element specifies the order of the polynomial trend line. + It is ignored for other trend line types. + + + + + This element specifies the period of the trend line for a moving average + trend line. It is ignored for other trend line types. + + + + + This element specifies the number of categories (or units on a scatter + chart) that the trend line extends after the data for the series that is + being trended. On non-scatter charts, the value must be a multiple of 0.5. + + + + + This element specifies the number of categories (or units on a scatter chart) + that the trend line extends before the data for the series that is being trended. + On non-scatter charts, the value shall be 0 or 0.5. + + + + + This element specifies the value where the trend line shall cross the y + axis. This property shall be supported only when the trend line type is + exp, linear, or poly. + + + + + This element specifies that the R-squared value of the trend line is + displayed on the chart (in the same label as the equation). + + + + + This element specifies that the equation for the trend line is displayed + on the chart (in the same label as the R-squared value). + + + + + This element specifies error bars. + + + + + This element specifies the type of the error bars - positive, negative, or both. + + + + + This element specifies the type of values used to determine the length of the error bars. + + + + + This element specifies an end cap is not drawn on the error bars. + + + + + This element specifies a value which is used with the Error Bar Type + to determine the length of the error bars. + + + + + This element specifies the error bar value in the positive direction. + It shall be used only when the errValType is cust. + + + + + This element specifies the error bar value in the negative direction. + It shall be used only when the errValType is cust. + + + + + Specifies that error bars shall be shown in the x direction. + + + + + Specifies that error bars shall be shown in the y direction. + + + + + This element specifies the direction of the error bars. + + + + + This element specifies the 3-D view of the chart. + + + + + This element specifies the amount a 3-D chart shall be rotated in the X direction. + + + + + This element specifies the height of a 3-D chart as a percentage of the + chart width (between 5 and 500). + + + + + This element specifies the amount a 3-D chart shall be rotated in the Y direction. + + + + + This element specifies that the chart axes are at right angles, + rather than drawn in perspective. Applies only to 3-D charts. + + + + + This element specifies the field of view angle for the 3-D chart. + This element is ignored if Right Angle Axes is true. + + + + + This element specifies the depth of a 3-D chart as a percentage of the + chart width (between 20 and 2000 percent). + + + + + This element specifies the legend. + + + + + This element specifies the position of the legend. + + + + + This element specifies that other chart elements shall be allowed to overlap this chart element. + + + + + This element specifies a legend entry. + + + + + This element specifies that the chart element specified by its containing + element shall be deleted from the chart. + + + + + This element specifies how blank cells shall be plotted on a chart. + + + + + This element specifies that only visible cells should be plotted on the chart. + + + + + This element specifies the page margins for a chart. + + + + + Specifies the contents of this attribute will contain the left page margin in inches. + + + + + Specifies the contents of this attribute will contain the right page margin in inches. + + + + + Specifies the contents of this attribute will contain the top page margin in inches. + + + + + Specifies the contents of this attribute will contain the bottom page margin in inches. + + + + + Specifies the contents of this attribute will contain the header margin in inches. + + + + + Specifies the contents of this attribute will contain the footer margin in inches. + + + + + This element specifies the up and down bars. + + + + + This element specifies the up bars on the chart. + + + + + This element specifies the down bars on the chart. + + + + + This element specifies text to use on a chart, including rich text formatting. + + + + + This element contains a string with rich text formatting. + + + + + This is the root element of Sheet Parts that are of type 'chartsheet'. + + + + + Prefix for chart namespace. + + + + + Underline the text with a single line of normal thickness. + + + + + Underline the text with two lines of normal thickness. + + + + + A single strikethrough is applied to the text. + + + + + Text is not strike through. + + + + + This element specifies how this axis crosses the perpendicular axis. + + + + + This element specifies where on the axis the perpendicular axis crosses. + The units are dependent on the type of axis. + + + + + The category axis crosses at the zero point of the value axis (if possible), + or the minimum value (if the minimum is greater than zero) or the maximum + (if the maximum is less than zero). + + + + + The axis crosses at the maximum value + + + + + This element specifies the x values which shall be used to define the + location of data markers on a chart. + + + + + This element specifies the y values which shall be used to define the + location of data markers on a chart. + + + + + This element specifies the data for the sizes of the bubbles on the bubble chart. + + + + + This element specifies the amount the data point shall be moved from the center of the pie. + + + + + This element specifies series lines for the chart. + + + + + This element specifies the line connecting the points on the chart shall + be smoothed using Catmull-Rom splines. + + + + + This element specifies the label for the trend line. + + + + + This element specifies text for a series name, without rich text formatting. + + + + + This element specifies a text value for a category axis label or a series name. + + + + + This element specifies the high-low lines for the series. + + + + + This element specifies how the chart element is placed on the chart. + + + + + This element specifies how the chart element is placed on the chart manually + + + + + This element specifies the chart layout target + + + + + Represents left element for manual layout + + + + + Represents top element for manual layout + + + + + Represents the x location (left) of the chart element as a + fraction of width of the chart + + + + + Represents the y location (top) of the chart element as a + fraction of width of the chart + + + + + Represents the width or horizontal offset + + + + + Represents the height or a vertical offset + + + + + Represents the layout mode for the width of the element + + + + + Represents the layout mode for the height of the element + + + + + Represents the width of the element + + + + + Represents the height of the element + + + + + This element specifies a single data point. + + + + + This element specifies a data label. + + + + + This element specifies the logarithmic base for a logarithmic axis. + + + + + Default value of the logBase tag. + + + + + This element specifies the scaling value of the display units for the value axis. + + + + + This element specifies the display unit is one of the built in values. + + + + + This element specifies a custom value for the display unit. + + + + + This element specifies a data table. + + + + + This element specifies the horizontal borders shall be shown in a data table. + + + + + This element specifies the vertical border shall be shown in a data table. + + + + + This element specifies the outline shall be shown on a data table. + + + + + This element specifies the legend keys shall be shown in a data table. + + + + + This element specifies drop lines. + + + + + This element contains text properties. + + + + + This element specifies that this axis is a date or text axis based on + the data that is used for the axis labels, not a specific choice. + + + + + This element specifies the rounded corner tag. + + + + + This element specifies the style tag. + + + + + This element specifies the shapes drawn on top of the chart. + + + + + This element specifies that the shape described here to reside within a + chart should be sized based on absolute anchor points. + + + + + This element specifies that the shape described here to reside within a + chart should be sized based on relative anchor points. + + + + + This element specifies the relative x coordinate that is used to define + the percentage-based horizontal position for a shape within a chart drawing object. + + + + + This element specifies the relative y coordinate that is used to define + the percentage-based vertical position for a shape within a chart drawing object. + + + + + Multiplier for coordinates transform. + + + + + This element specifies a set of numbers used for the parent element. + + + + + This element specifies a set of strings used for the parent element. + + + + + This element contains the number of values in the cache. + + + + + This element specifies data for a particular data point. + + + + + This element specifies the series + to invert its colors if the value is negative. + + + + + Value attribute. + + + + + Represents the standard Number format attribute. + + + + + Name of the leader lines element + + + + + This element describes Arrow width as large + + + + + This element describes arrow width as small + + + + + This element describes arrow width as medium + + + + + This element describes Arrow shape as arrow + + + + + This element describes Arrow shape as diamond + + + + + This element describes Arrow shape as none + + + + + This element describes Arrow shape as oval + + + + + This element describes Arrow shape as stealth + + + + + This element describes Arrow shape as triangle + + + + + This element describes type + + + + + This element describes width + + + + + This element describes length. + + + + + Value indicates the show data lables over max element. + + + + + This class contains constants required for chartExs parsing and serialization in Excel 2016 format. + + + + + Main chartExs namespace. + + + + + Prefix for chartEx namespace. + + + + + Prefix for chartEx1 namespace for required. + + + + + Namespace used in choice content + + + + + The element specifies the chart data used for chartEx + + + + + The element specifies the data used for chartEx + + + + + The element specifies the text data used for chartEx text + + + + + The element specifies the value used for chartEx value + + + + + The element specifies the chart element position + + + + + The element specifies the chart element alignment + + + + + The element specifies the chart plot area region + + + + + The element specifies the chart axis + + + + + The element specifies the chart series + + + + + The element specifies the plot surface + + + + + The element specifies the chart data point + + + + + The element specifies the chart data labels + + + + + The element specifies the chart data label of single data point + + + + + The element specifies the chart data Id used in series + + + + + The element specifies the chart layout properties used in series + + + + + The element specifies the chart axis Id used in series + + + + + The element specifies the chart data Label position + + + + + The element specifies the data label hidden in setting + + + + + The element specifies the data label visibility setting + The element also specifies the visibility options on box and whisker, waterfall + + + + + The attribute specifies the data label visibility option of series Name + + + + + The attribute specifies the data label visibility option of category Name + + + + + The attribute specifies the data label visibility option of value + + + + + The attribute specifies the layout Id on series + + + + + The attribute specifies the series is hidden or not + + + + + The attribute specifies the owner index on series for refering other series + Pareto line series only + + + + + The attribute specifies the series unique Identifier + + + + + The attribute specifies the format index for series + + + + + The element specifies the parent label layout + + + + + The element specifies the by category option in histogram and pareto chart + + + + + The element specifies the binning option in histogram and pareto chart + + + + + The element specifies the statistics for the box and whisker series + + + + + The element specifies the subtotal for the water fall series + + + + + This attribute specifies the connector line used in Water fall chart + + + + + This attribute specifies the mean line used in Box and Whisker chart + + + + + This attribute specifies the mean marker used in Box and Whisker chart + + + + + This attribute specifies the mean non outliers used in Box and Whisker chart + + + + + This attribute specifies the outliers used in Box and Whisker chart + + + + + This attribute specifies the interval closing in Histogram, Pareto chart + + + + + This attribute specifies the underflow bin value in Histogram, Pareto chart + + + + + This attribute specifies the overflow bin value in Histogram, Pareto chart + + + + + This element specifies the bin width value in Histogram, Pareto chart + + + + + This element specifies the bin count in Histogram, Pareto chart + + + + + This attribute specifies the quartile method used in box and whisker chart + + + + + This value specifies the exclusive quartile method used in box and whisker chart + + + + + This value specifies the inclusive quartile method used in box and whisker chart + + + + + This element speifies the category axis scaling + + + + + This element speifies the value axis scaling + + + + + This attribute specifies the index of element + + + + + This string denotes the automatic value on current property + + + + + This element specifies the display unit axis + + + + + This element specifies the major tick marks. + + + + + This element specifies the minor tick marks. + + + + + Describes the tick marks in the axis + + + + + Describes the type attribute tag + + + + + Describes the Display unit label tag + + + + + Describes the Display unit attribute tag + + + + + This element describes the external data referenced in chartEx + + + + + This attibute specifies whether the work book need to be updated or not + + + + + This element describes the numeric dimension of data + + + + + This element describes the string dimension of data + + + + + This element describes the level of data + + + + + This attibute specifies direction for data dimension + + + + + Value indicates the diemension is column wise + + + + + Value indicates the diemension is row wise + + + + + This class contains the required chart style elements + + + + + It specifies visual and text properties for all elements present on a chart + + + + + It specifies colors used to resolve StyleColor in a ChartStyle. + + + + + Element specifies reference to a line style within the style matrix. + + + + + Element that specifies a multiplier to apply to the line width. + + + + + Element that specifies a reference to a fill style within the style matrix. + + + + + Element that specifies a reference to an effect style within the style + + + + + Element that specifies a reference to a themed font. + + + + + Element that specifies visual shape properties of the part of the chart associated with this CT_StyleEntry. + + + + + Element that specifies the default text character properties for a text body on a chart which is associated with this CT_StyleEntry + + + + + Element that specifies the body properties for a text body on a chart that is associated with this CT_StyleEntry. + + + + + Attribute that specifies the style matrix index of the style referred to. + + + + + Attribute that specifies a list of modifiers for this reference. + + + + + (Accent Color 1) Extra scheme color 1 + + + + + (Accent Color 2) Extra scheme color 2 + + + + + (Accent Color 3) Extra scheme color 3 + + + + + (Accent Color 4) Extra scheme color 4 + + + + + (Accent Color 5) Extra scheme color 5 + + + + + (Accent Color 6) Extra scheme color 6 + + + + + (Background Color 1) Semantic background color + + + + + (Background Color 2) Semantic additional background color + + + + + (Dark Color 1) Main dark color 1 + + + + + (Dark Color 2) Main dark color 2 + + + + + (Followed Hyperlink Color) Followed Hyperlink Color + + + + + (Hyperlink Color) Regular Hyperlink Color + + + + + (Light Color 1) Main Light Color 1 + + + + + (Light Color 2) Main Light Color 2 + + + + + (Style Color) A color used in theme definitions which means to use the color of the style. + + + + + (Text Color 1) Semantic text color + + + + + (Text Color 2) Semantic additional text color + + + + + It specifies a list of transforms that are appended to all colors in a ColorStyle to produce a variation of the color style + + + + + + Bitmap image content type. + + + + + Jpeg image content type. + + + + + Png image content type. + + + + + Emf image content type. + + + + + Gif image content type. + + + + + Svg image content type. + + + + + Content type for xml files. + + + + + Content type for rels files. + + + + + Content type for workbook item (used in [Content_Types].xml). + + + + + Content type for workbook item that contains macros (used in [Content_Types].xml). + + + + + Content type for macro template item that contains macros (used in [Content_Types].xml). + + + + + Content type for template item that contains macros (used in [Content_Types].xml). + + + + + Content type for calculation chain item. + + + + + Content type of the worksheet. + + + + + Content type of the chartsheet. + + + + + Content type of the dialogsheet. + + + + + Content type of the macrosheet + + + + + Content type of the intlmacrosheet + + + + + Content type of the shared strings table. + + + + + Content type of the styles. + + + + + Content type of the vml drawings item. + + + + + Content type of the comments item. + + + + + Content type for drawings item. + + + + + Content type for chart drawings item. + + + + + Content type for core properties. + + + + + Content type for extended properties. + + + + + Content type for custom properties. + + + + + Content type for extern link item. + + + + + Content type for chart object. + + + + + Content type for chartEx object. + + + + + Content type for worksheet custom property. + + + + + Content type for pivot table. + + + + + Content type for pivot cache definition. + + + + + Content type for pivot cache records. + + + + + Content type for table object. + + + + + Content type for CustomXml Objects + + + + + Tiff image content type. + + + + + Content type for chart Style object. + + + + + Content type for chart color Style object. + + + + + This class contains constants required for document properties parsing and serialization in Excel 2007 format. + + + + + Core properties enable users to get and set well-known and common sets of property metadata within packages. + + + + + Represents a categorization of the content of this package. + + + + + Represents the date of creation of the resource. + + + + + Represents an entity primarily responsible for making the content of the resource. + + + + + Represents an explanation of the content of the resource. + + + + + Represents a delimited set of keywords to support searching and indexing. + + + + + Represents the user who performed the last modification. + + + + + Represents the date and time of the last printing. + + + + + Represents the date on which the resource was changed. + + + + + Represents the topic of the content of the resource. + + + + + Represents the name given to the resource. + + + + + Represents Xsi attribute. + + + + + Represents Xsi attribute value. + + + + + Represents date time format structure. + + + + + This element specifies the application properties of a document. + + + + + This element specifies the name of the application that created this document. + + + + + This element specifies the total number of characters in a document. + + + + + This element specifies the name of a company associated with the document. + + + + + MS Excel uses this Tag to represents the xml parts. In our XlsIO, + this tag is used to find the document is generated by MS Excel. + + + + + Tag to represents the file is generated by XlsIO. + + + + + This element specifies the total number of lines in a document when last saved by a conforming producer if applicable. + + + + + This element specifies the name of a supervisor associated with the document. + + + + + This element specifies the total number of sound or video clips that are present in the document. + + + + + This element specifies the number of slides in a presentation containing notes. + + + + + This element specifies the total number of pages of a document if applicable. + + + + + This element specifies the total number of paragraphs found in a document if applicable. + + + + + This element specifies the intended format for a presentation document. + + + + + This element specifies the total number of slides in a presentation document. + + + + + This element specifies the name of an external document template containing format and style information + used to create the current document. + + + + + Total time that a document has been edited. The default time unit is minutes. + + + + + This element specifies the total number of words contained in a document when last saved. + + + + + This element specifies the base string used for evaluating relative hyperlinks in this document. + + + + + Represents default Excel97-03 hyperlink base name. + + + + + Parent element for the custom file properties part. + + + + + This element specifies a single custom file property. + + + + + Uniquely relates a custom property with an OLE property. + + + + + Uniquely relates a custom property with an OLE property. + + + + + Specifies the name of this custom file property. + + + + + This element specifies a Boolean variant type. + + + + + This element specifies a wide string variant type. + + + + + This element specifies a string variant type. + + + + + This element specifies a date variant type of type date-time as defined in RFC 3339. + + + + + This element specifies a 4-byte signed integer variant type. + + + + + This element specifies a 8-byte real number variant type. + + + + + This element specifies an integer variant type. + + + + + This element specifies a file-time variant type of type date-time. + + + + + Class used for defining constants and namespace for drawings. + + + + + preset text warp + + + + + Specifies the shape autofit element tag + + + + + This element specifies the location of the bounding box of a child object. + + + + + This element specifies the size of the bounding box enclosing the referenced child object. + + + + + This element specifies that blip fill. + + + + + Vertical flip attribute tag + + + + + Horizontal flip attribute tag + + + + + Specifies the minimum font size at which character kerning occurs for this text run. + + + + + This element specifies shade. + + + + + specifies the capitialization for rich text + + + + + Specifies the spacing between characters within a text run. + + + + + Specifies the left inset of the bounding rectangle attribute + + + + + Specifies the bottom inset of the bounding rectangle attribute + + + + + Specifies the top inset of the bounding rectangle attribute + + + + + Specifies the right inset of the bounding rectangle attribute + + + + + Determines whether the text can flow out of the bounding box vertically + + + + + Determines whether the text can flow out of the bounding box horizontally + + + + + + Attribute used to denote the requires + + + + + This element specifies a two cell anchor placeholder for a group, a shape, + or a drawing element. It moves with cells and its extents are in EMU units. + + + + + Element specifies the fallback content + + + + + Main spreadsheet drawings namespace ('xdr' abbreviation is used in MS Excel documents). + + + + + Main drawings namespace ('a' abbreviation is used in MS Excel documents). + + + + + Main chartsheet drawings namespace ('cdr' abbreviation is used in MS Excel documents). + + + + + Main drawings namespace ('cs' abbreviation is used in MS Excel documents). + + + + + Prefix used by MS Excel for XdrNamespace definition. + + + + + Prefix used by MS Excel for CdrNamespace definition. + + + + + Prefix used by MS Excel for ANamespace definition. + + + + + This element specifies a one cell anchor placeholder for a group, a shape, + or a drawing element. It moves with the cell and its extents is in EMU units. + + + + + Specifies how the DrawingML contents shall be moved and/or resized when + the rows and columns between its start and ending anchor (the from and + to child elements) are resized, or have additional rows/columns inserted + within them, or additional row/columns are added before them. + + + + + This element specifies the first anchor point for the drawing element. + This will be used to anchor the top and left sides of the shape within + the spreadsheet. That is when the cell that is specified in the from + element is adjusted, the shape will also be adjusted. + + + + + This element specifies the second anchor point for the drawing element. + This will be used to anchor the bottom and right sides of the shape within + the spreadsheet. That is when the cell that is specified in the to element + is adjusted, the shape will also be adjusted. + + + + + This element specifies the column that will be used within the from and to + elements to specify anchoring information for a shape within a spreadsheet. + + + + + This element is used to specify the column offset within a cell. + + + + + This element specifies the row that will be used within the from and to + elements to specify anchoring information for a shape within a spreadsheet. + + + + + This element is used to specify the row offset within a cell. + + + + + This element specifies the non visual properties for a picture. + This allows for additional information that does not affect + the appearance of the picture to be stored. + + + + + This element specifies non-visual canvas properties. + + + + + This element specifies non-visual GroupShape properties. + + + + + This element specifies GroupShape properties. + + + + + This element specifies the non-visual connector shape drawing properties + + + + + This element specifies the non-visual properties for the picture canvas. + + + + + This element specifies the on-click hyperlink information to be applied to a run of text. + When the hyperlink text is clicked the link is fetched. + + + + + This element specifies the type of picture fill that the picture object + will have. Because a picture has a picture fill already by default, + it is possible to have two fills specified for a picture object. + + + + + This element specifies the existence of an image (binary large image + or picture) and contains a reference to the image data. + + + + + It's define the Picture fill option + + + + + It's define the values of Transparency + + + + + Specifies the identification information for an embedded picture. This + attribute is used to specify an image that resides locally within the file. + + + + + Specifies that the current start and end positions shall be maintained + with respect to the distances from the absolute start point of the worksheet. + + + + + Specifies that the current drawing shall move with its row and column + (i.e. the object is anchored to the actual from row and column), but + that the size shall remain absolute. + + + + + Specifies that the current drawing shall move and resize to maintain its + row and column anchors (i.e. the object is anchored to the actual from + and to row and column). + + + + + This element specifies that a BLIP should be stretched to fill the target rectangle. + + + + + This element specifies that a BLIP should be tiled to fill the available space. + + + + + This element specifies the portion of the blip used for the fill. + + + + + This element specifies a fill rectangle. When stretching of an image is specified, + a source rectangle, srcRect, is scaled to fit the specified fill rectangle. + + + + + This element specifies the existence of a picture object within the document. + + + + + Name of the xml attribute that stores id. + + + + + Name of the xml attribute that stores shape name. + + + + + Name of the xml attribute that stores alternative description. + + + + + This element specifies all locking properties for a graphic frame. + + + + + Specifies that the generating application should not allow aspect ratio + changes for the corresponding connection shape. If this attribute is not + specified, then a value of false is assumed. + + + + + This element specifies the visual shape properties that can be applied to a shape. + + + + + This element specifies the thickness of the walls or floor as a percentage of the largest dimension of the plot volume. + + + + + It's define picturefill in shapeproperty. + + + + + It's define pictureformat options + + + + + It's define the Pictureformatvalue + + + + + This element represents 2-D transforms for ordinary shapes. + + + + + This element specifies the location of the bounding box of an object. + + + + + This element specifies the size of the bounding box enclosing the referenced object. + + + + + Specifies a coordinate on the x-axis. + + + + + Specifies a coordinate on the x-axis. + + + + + Specifies the length of the extents rectangle in EMUs. + + + + + Specifies the width of the extents rectangle in EMUs. + + + + + Specifies the preset geometry that will be used for this shape. + + + + + This elemet specifies that the chart has inverted shape elements and that is to be filled with a solid color. + + + + + Specifies the preset geometry that will be used for this shape. + + + + + This element indicates that the sheet contains drawing components built + on the drawingML platform. + + + + + This element specifies all drawing objects within the worksheet. + + + + + This element specifies the adjust values that will be applied to the specified shape. + + + + + This element is used to set certain properties related to a drawing element + on the client spreadsheet application. + + + + + This element describes a single graphical object frame for + a spreadsheet which contains a graphical object. + + + + + This element specifies the existence of a single shape. A shape can either + be a preset or a custom geometry, defined using the SpreadsheetDrawingML + framework. In addition to a geometry each shape can have both visual and + non-visual properties attached. Text and corresponding styling information + can also be attached to a shape. This shape is specified along with all + other shapes within either the shape tree or GroupShape elements. + + + + + This element specifies the properties for a connection shape drawing element. + A connection shape is a line, etc. that connects two other shapes in this drawing. + + + + + This element specifies a GroupShape that represents many shapes grouped together. + This shape is to be treated just as if it were a regular shape but instead of being + described by a single geometry it is made up of all the shape geometries encompassed + within it. Within a GroupShape each of the shapes that make up the group are + specified just as they normally would. The idea behind grouping elements however + is that a single transform can apply to many shapes at the same time. + + + + + This element specifies the custom function associated with the object. + + + + + This element specifies the existence of a single graphic object. + + + + + This element specifies the reference to a graphic object within the document. + + + + + Specifies the URI, or uniform resource identifier that represents the data + stored under this tag. The URI is used to identify the correct 'server' that + can process the contents of this tag. + + + + + This element specifies all non-visual properties for a graphic frame. + + + + + This element defines the body properties for the text body within a shape. + + + + + This element specifies the list of styles associated with this body of text. + + + + + This element specifies the presence of a paragraph of text within the containing text body. + + + + + This element contains all paragraph level text properties for the containing paragraph. + These paragraph properties should override any and all conflicting properties that are + associated with the paragraph in question. + + + + + This element contains all default run level text properties for the text + runs within a containing paragraph. These properties are to be used when + overriding properties have not been defined within the rPr element. + + + + + This element specifies the presence of a run of text within the containing text body. + + + + + This element specifies the actual text for this text run. This is the + text that will be formatted using all specified body, paragraph and run + properties. This element must be present within a run of text. + + + + + This element contains all run level text properties for the text runs within a containing paragraph. + + + + + Specifies whether a run of text will be formatted as bold text. If this + attribute is omitted, than a value of 0, or false is assumed. + + + + + Specifies whether a run of text will be formatted as italic text. If this + attribute is omitted, than a value of 0, or false is assumed. + + + + + Specifies whether a run of text will be formatted as strikethrough text. + If this attribute is omitted, than no strikethrough is assumed. + + + + + Specifies the size of text within a text run. Whole points are specified + in increments of 100 starting with 100 being a point size of 1. For instance + a font point size of 12 would be 1200 and a font point size of 12.5 would be + 1250. If this attribute is omitted, than the value in defRPr should be used. + + + + + Specifies whether a run of text will be formatted as underlined text. + If this attribute is omitted, than no underline is assumed. + + + + + This element is used as an anchor placeholder for a shape or group of shapes. + It will anchor the object in the same position relative to sheet position + and its extents are in EMU unit. + + + + + This element describes the position of a drawing element within a spreadsheet. + + + + + Specifies that the generating application should not allow shape grouping + for the corresponding connection shape. + + + + + This element specifies all locking properties for a graphic frame. + + + + + This element specifies the non-visual drawing properties for a graphic frame. + + + + + This element specifies an outline style that can be applied to a number + of different objects such as shapes and text. + + + + + Specifies the width to be used for the underline stroke. If this + attribute is omitted, then a value of 0 is assumed. + + + + + Specifies the width cap of the dashStyle + + + + + Specifies the compound line type to be used for the underline stroke. + If this attribute is omitted, then a value of sng is assumed. + + + + + This element specifies that no fill will be applied to the parent element. + + + + + This element specifies a solid color fill. The shape is filled entirely with the specified color. + + + + + This element specifies a highlight color. + + + + + border miter join Tag + + + + + border bevel join tag + + + + + This element specifies a color using the red, green, blue RGB color model. + Red, green, and blue is expressed as sequence of hex digits, RRGGBB. + A perceptual gamma of 2.2 is used. + + + + + This element specifies a color bound to a user's theme. As with all elements + which define a color, it is possible to apply a list of color transforms to + the base color defined. + + + + + This color is based upon the value that this color currently has + within the system on which the document is being viewed. + + + + + Applications shall use the lastClr attribute to determine + the absolute value of the last color used if system colors + are not supported. + + + + + This element specifies that a preset line dashing scheme should be used. + + + + + This element specifies the background color of a Pattern fill. + + + + + This element specifies the foreground color of a pattern fill. + + + + + This element specifies a pattern fill. A repeated pattern is used to fill the object. + + + + + Specifies one of a set of preset patterns to fill the object. + + + + + This element specifies that lines joined together will have a round join. + + + + + This element defines a gradient fill. + + + + + This element specifies decorations which can be added to the head of a line. + + + + + This element specifies decorations which can be added to the tail of a line. + + + + + The list of gradient stops that specifies the gradient colors and their + relative positions in the color band. + + + + + This element specifies a linear gradient. + + + + + It's define the Tailtag property + + + + + Specifies the direction of color change for the gradient. To define this + angle, let its value be x measured clockwise. Then ( -sin x, cos x ) is + a vector parallel to the line of constant color in the gradient fill. + + + + + Whether the gradient angle scales with the fill region. + + + + + This element defines that a gradient fill will follow a path vs. a linear line. + + + + + Specifies the shape of the path to follow. + + + + + This element defines a GradientStop. A GradientStop consists of a position + where the stop appears in the color band. + + + + + Specifies where this GradientStop should appear in the color band. + + + + + This element specifies its input color with the specific opacity, + but with its color unchanged. + + + + + This element defines the "focus" rectangle for the center shade, specified + relative to the fill tile rectangle. The center shade fills the entire tile + except the margins specified by each attribute. + + + + + This element specifies a Color Change Effect. Instances of clrFrom are replaced with instances of clrTo + + + + + Specifies the left edge of the rectangle. + + + + + Specifies the top edge of the rectangle. + + + + + Specifies the right edge of the rectangle. + + + + + Specifies the bottom edge of the rectangle. + + + + + This element specifies a lighter version of its input color. A 10% tint is 10% + of the input color combined with 90% white. + + + + + This element specifies a darker version of its input color. A 10% shade is 10% + of the input color combined with 90% black. + + + + + This element specifies that the output color rendered by the generating + application should be the sRGB gamma shift of the input color. + + + + + This element specifies that the output color rendered by the generating + application should be the inverse sRGB gamma shift of the input color. + + + + + This element specifies the input color with its luminance modulated by the given percentage. + + + + + This element specifies the input color with its luminance shifted, but with its hue and saturation unchanged. + + + + + This element specifies the input color with its saturation modulated by the given percentage. + + + + + This element specified the rotation of text. + + + + + Specifies that all text in the parent object shall be aligned to the baseline of + each character when displayed. + + + + + This element specifies that a Latin font be used for a specific run of text. + + + + + Represents font type face. + + + + + Represents embedded controls in worksheet. + + + + + Represents a single embedded control. + + + + + This element specifies the non-visual drawing properties for a shape. These properties + are to be used by the generating application to determine how the shape should be dealt with. + + + + + Specifies that the corresponding shape is a text box and thus should be treated + as such by the generating application. If this attribute is omitted then it is + assumed that the corresponding shape is not specifically a text box. + + + + + This element specifies all non-visual properties for a shape. This element + is a container for the non-visual identification properties, shape properties + and application properties that are to be associated with a shape. This + allows for additional information that does not affect the appearance + of the shape to be stored. + + + + + This element specifies the existence of text to be contained within the + corresponding shape. All visible text and visible text related properties + are contained within this element. There can be multiple paragraphs and + within paragraphs multiple runs of text. + + + + + Default value for subscript baseline value. + + + + + Default value for superscript baseline value. + + + + + Specifies the anchoring position of the txBody within the shape. If this + attribute is omitted, then a value of t, or top is implied. + + + + + Determines if the text within the given text body should be displayed vertically. + If this attribute is omitted, then a value of horz, or no vertical text is implied. + + + + + This attribute indicates whether to allow text editing within this drawing + object when the parent worksheet is protected. + + + + + Specifies the alignment that is to be applied to the paragraph. Possible + values for this include left, right, centered, justified and distributed. + If this attribute is omitted, then a value of left is implied. + + + + + Specifies the constant value used for converting angle + + + + + Represents the glow properties tag. + + + + + Represents the lgihtning rotation tag. + + + + + Represents the lightning latitude attribute. + + + + + Represents the ligtning longitude attribute. + + + + + This class contains constants related with external links storing in Excel 2007 format. + + + + + Main namespace for external links file. + + + + + This element is a container for specific types of external links. + + + + + This element represents an external workbook which is supplying data to the current workbook. + + + + + This element is the container for all of the worksheet names in a supporting workbook. + + + + + Name of a worksheet in the supporting workbook. + + + + + This element defines the collection of external references for this workbook. + + + + + This element defines an external reference that stores data for workbook elements. + + + + + Name of the xml attribute that stores sheet name value. + + + + + This element serves as the collection for 1 or more sheetData elements. + + + + + This element is a collection of the defined names associated with the supporting workbook. + + + + + This element contains information about a named range in an external workbook. + + + + + The defined name attribute. + + + + + Name range definition string. + + + + + The index of the worksheet that the named range applies to for named ranges + that are scoped to a particular worksheet rather than the full workbook. + + + + + This class gives access to xml tag/attribute names used for + pagesetup serialization/parsing. + + + + + Gets name of the xml tag that stores margin settings. Read-only. + + + + + Gets name of the xml attribute used to store left margin. Read-only. + + + + + Gets name of the xml attribute used to store right margin. Read-only. + + + + + Gets name of the xml attribute used to store top margin. Read-only. + + + + + Gets name of the xml attribute used to store bottom margin. Read-only. + + + + + Gets name of the xml attribute used to store header margin. Read-only. + + + + + Gets name of the xml attribute used to store footer margin. Read-only. + + + + + Gets tag's namespace. Read-only. + + + + + This class stores all constants connected with page setup settings. + + + + + Print options for the sheet. + + + + + Used in conjunction with gridLinesSet. If both gridLines and gridlinesSet are true, then + grid lines shall print. Otherwise, they shall not (i.e., one or both have false values). + + + + + Used in conjunction with gridLines. If both gridLines and gridLinesSet are true, then + grid lines shall print. Otherwise, they shall not (i.e., one or both have false values). + + + + + Print row and column headings. + + + + + Center on page horizontally when printing. + + + + + Center on page vertically when printing. + + + + + Page margins for a sheet or a custom sheet view. + + + + + Bottom Page Margin in inches. + + + + + Footer Page Margin in inches. + + + + + Header Page Margin in inches. + + + + + Left Page Margin in inches. + + + + + Right Page Margin in inches. + + + + + Top Page Margin in inches. + + + + + Page setup settings for the worksheet. + + + + + Print black and white. + + + + + This attribute specifies how to print cell comments. + + + + + Number of copies to print. + + + + + Print without graphics. + + + + + Specifies how to print cell values for cells with errors. + + + + + Page number for first printed page. If no value is specified, then 'automatic' is assumed. + + + + + Number of vertical pages to fit on. + + + + + Number of horizontal pages to fit on. + + + + + Horizontal print resolution of the device. + + + + + Relationship Id of the devMode printer settings part. + + + + + Orientation of the page. + + + + + Order of printed pages. + + + + + Paper size + + + + + Print scaling. Valid values range from 10 to 400. + + + + + Use firstPageNumber value for first page number, and do not auto number the pages. + + + + + Use the printer�s defaults settings for page setup values and don't use the default values + specified in the schema. For example, if dpi is not present or specified in the XML, the + application shall not assume 600dpi as specified in the schema as a default and instead + shall let the printer specify the default dpi. + + + + + Vertical print resolution of the device. + + + + + Print cell comments as displayed. + + + + + Do not print cell comments. + + + + + Print cell comments at end of document. + + + + + Display cell errors as blank. + + + + + Display cell errors as dashes. + + + + + Display cell errors as displayed on screen. + + + + + Display cell errors as #N/A. + + + + + Header and footer settings. + + + + + Odd header string. + + + + + Odd footer string. + + + + + Header Footer Scales with Document string + + + + + Header Footer Margins align with Document string + + + + + Header Footer Odd/Even pages is different with the document string + + + + + Header Footer first page is different with document string + + + + + This class contains constants used for pane parsing/serialization. + + + + + Represents worksheet view pane. + + + + + Horizontal position of the split, in 1/20th of a point; 0 (zero) if none. + If the pane is frozen, this value indicates the number of columns visible + in the top pane. + + + + + Vertical position of the split, in 1/20th of a point; 0 (zero) if none. + If the pane is frozen, this value indicates the number of rows visible + in the left pane. + + + + + Location of the top left visible cell in the bottom right pane (when in Left-To-Right mode). + + + + + The pane that is active. + + + + + Indicates whether the pane has horizontal / vertical splits, + and whether those splits are frozen. + + + + + Panes are frozen, but were not split being frozen. In this state, when the + panes are unfrozen again, a single pane results, with no split. + + + + + Panes are frozen and were split before being frozen. In this state, when + the panes are unfrozen again, the split remains, but is adjustable. + + + + + Panes are split, but not frozen. In this state, the split bars are adjustable by the user. + + + + + Selected or active cell information + + + + + Active cell in the worksheet + + + + + Sequence of References + + + + + Possible values for active pane. + + + + + Bottom left pane, when both vertical and horizontal splits are applied. + This value is also used when only a horizontal split has been applied, + dividing the pane into upper and lower regions. In that case, this value + specifies the bottom pane. + + + + + Bottom right pane, when both vertical and horizontal splits are applied. + + + + + Top left pane, when both vertical and horizontal splits are applied. + This value is also used when only a horizontal split has been applied, + dividing the pane into upper and lower regions. In that case, this value + specifies the top pane. This value is also used when only a vertical split + has been applied, dividing the pane into right and left regions. In that + case, this value specifies the left pane. + + + + + Top right pane, when both vertical and horizontal splits are applied. + This value is also used when only a vertical split has been applied, + dividing the pane into right and left regions. In that case, this value + specifies the right pane. + + + + + Specifies a boolean value that indicates whether the application will + refresh the cache when the workbook has been opened. + + + + + Specifies the name of the end-user who last refreshed the cache. + + + + + Specifies the date when the cache was last refreshed. + + + + + Specifies the version of the application that created the cache. + + + + + Specifies the version of the application that last refreshed the cache. + + + + + Specifies the earliest version of the application that is required to refresh the cache. + + + + + Specifies the number of records in the cache. + + + + + Represents the description of data source whose data is stored in the pivot cache. + + + + + Specifies the cache type. + + + + + Indicates that the cache contains data that + consolidates ranges. + + + + + Indicates that the cache contains data from an + external data source. + + + + + Indicates that the cache contains a scenario summary + report + + + + + Indicates that the cache contains worksheet data. + + + + + Represents the location of the source of the data that is stored in the cache. + + + + + Specifies the reference that defines a cell range that is the source of the data. + + + + + Specifies the name of the sheet that is the source for the cached data. + + + + + Represents the collection of field definitions in the source data. + + + + + Specifies the number of fields in the cache. + + + + + Represent a single field in the PivotCache. + + + + + Specifies the name of the cache field. + + + + + Represents the PivotTable root element for non-null PivotTables. + + + + + This element enumerates pivot cache definition parts used by pivot tables and formulas in this workbook. + + + + + This element represents a cache of data for pivot tables and formulas in the workbook. + + + + + Specifies the unique identifier for the pivot cache for this workbook in the pivot cache part. + + + + + Specifies the name of the value area field header in the PivotTable. + + + + + Specifies the version of the application that last updated the PivotTable view. + + + + + Specifies a boolean value that indicates whether calculated members should be shown + in the PivotTable view. This attribute applies to PivotTables from OLAP-sources only. + + + + + Specifies a boolean value that indicates whether auto formatting has + been applied to the PivotTable view. + + + + + Specifies a boolean value that indicates whether PivotItem names should + be repeated at the top of each printed page. + + + + + Specifies the indentation increment for compact axis and can be used to + set the Report Layout to Compact Form. + + + + + Specifies a boolean value that indicates whether new fields should have + their outline flag set to true. + + + + + Specifies a boolean value that indicates whether data fields in the + PivotTable should be displayed in outline form. + + + + + Specifies a boolean value that indicates whether the fields of a PivotTable + can have multiple filters set on them. + + + + + Represents the collection of fields that appear on the PivotTable. + + + + + Represents a single field in the PivotTable. + + + + + Specifies a boolean value that indicates whether to show all items for this field. + + + + + Represents location information for the PivotTable. + + + + + Specifies the first row of the PivotTable header, relative to the top + left cell in the ref value. + + + + + Specifies the first row of the PivotTable data, relative to the top left cell in the ref value. + + + + + Specifies the first column of the PivotTable data, relative to the top left cell in the ref value. + + + + + Represents the pivotCacheDefinition part. This part defines each field + in the source data, including the name, the string resources of the + instance data (for shared items), and information about the type of + data that appears in the field. + + + + + Represents the collection of row fields for the PivotTable. + + + + + Represents the collection of items in row axis of the PivotTable. + + + + + Represents the collection of fields that are on the column axis of the PivotTable. + + + + + Represents the collection of column items of the PivotTable. + + + + + Specifies the index to the number format applied to this data field. + + + + + Represent information on style applied to the PivotTable. + + + + + Specifies a boolean value that indicates whether to show row headers for the table. + + + + + Specifies a boolean value that indicates whether to show column headers for the table. + + + + + Specifies a boolean value that indicates whether to show row + stripe formatting for the table. + + + + + Specifies a boolean value that indicates whether to show column stripe + formatting for the table. + + + + + Specifies a boolean value that indicates whether to show the last column. + + + + + Specifies a boolean value that indicates whether grand totals should be + displayed for the PivotTable columns. + + + + + Specifies a boolean value that indicates whether grand totals should be + displayed for the PivotTable rows. + + + + + Specifies a boolean value that indicates whether drill indicators should be hidden. + + + + + Represents the collection of unique items for a field in the PivotCacheDefinition. + + + + + Specifies a boolean value that indicates that this field contains text values. + The field may also contain a mix of other data type and blank values. + + + + + Specifies a boolean value that indicates whether this field contains a text value. + + + + + Specifies a boolean value that indicates whether this field contains numeric values. + + + + + Specifies a boolean value that indicates whether this field contains integer values. + + + + + Specifies a boolean value that indicates that the field contains at least one date. + + + + + Specifies a boolean value that indicates that the field contains at + least one value that is not a date. + + + + + Specifies a boolean value that indicates whether this field contains a blank value. + + + + + Specifies a boolean value that indicates wheter this field contains a long Text. + + + + + Specifies a boolean value that indicates whether to suppress display of pivot field. + + + + + Represents a generic field that can appear either on the column or the row region of the PivotTable. + + + + + Specifies the index to a pivotField item value. + + + + + Represents the collection of items in the row or column region of the PivotTable. + + + + + GrandTotal constant + + + + + Row Labels of pivot table + + + + + Specifies the type of the item. + + + + + constant + + + + + Represents an array of indexes to cached member property values. + + + + + Represents the collection of items in the data region of the PivotTable. + + + + + Represents a field from a source list, table, or database that contains data that is summarized in a PivotTable. + + + + + Specifies the index to the field (<r>) in the pivotCacheRecords part that this data item summarizes. + + + + + Specifies the index to the base field when the ShowDataAs calculation is in use. + + + + + Specifies the index to the base item when the ShowDataAs calculation is in use. + + + + + Specifies the aggregation function that applies to this data field. + + + + + Specifies the custom text that is displayed for the subtotals label. + + + + + Specifies the region of the PivotTable that this field is displayed. + + + + + Specifies a boolean value that indicates whether this field appears in the + data region of the PivotTable. + + + + + Represents the collection of items in a PivotTable field. + + + + + Represents a single item in PivotTable field. + + + + + Specifies the type of this item. A value of 'default' indicates the subtotal or total item. + + + + + Indicates the pivot item represents the default type for this PivotTable. + The default pivot item type is the "total" aggregate function. + + + + + Represents the collection of records in the PivotCache. + + + + + Represents a single record of data in the PivotCache. + + + + + Represents a numeric value in the PivotTable. + + + + + Represents a character value in a PivotTable. + + + + + Represents a value that was not specified. + + + + + Represents a date-time value in the PivotTable. + + + + + Represents a boolean value for an item in the PivotTable. + + + + + Unified date time format. + + + + + Specifies the value of the item. + + + + + Specifies a boolean value that indicates whether to apply the 'Average' + aggregation function in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether to apply the 'countA' + aggregation function in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether to apply the 'count' + aggregation function in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether to apply the 'max' + aggregation function in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether to apply the 'min' + aggregation function in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether to apply 'product' + aggregation function in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether to apply the 'stdDevP' + aggregation function in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether to use 'stdDev' + in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether apply the 'sum' + aggregation function in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether to apply the 'varP' + aggregation function in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether to apply the 'variance' + aggregation function in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether the default subtotal + aggregation function is displayed for this field. + + + + + Specifies a boolean value that indicates whether the application should query and + retrieve records asynchronously from the cache. + + + + + Specifies a boolean value that indicates whether the user can refresh the cache. + + + + + Specifies a boolean value that indicates whether the cache needs to be refreshed. + + + + + Specifies a boolean value that indicates whether the application will apply optimizations + to the cache to reduce memory usage + + + + + Specifies a boolean value that indicates whether the pivot records are saved with the + cache. + + + + + Specifies whether the cache's data source supports attribute drilldown + + + + + Specifies whether the cache's data source supports subqueries. + + + + + Specifies a boolean value that indicates whether the cache is scheduled for version + upgrade. + + + + + Specifies a boolean value that indicates whether this field came from the source + database + + + + + Specifies the formula for the calculated field + + + + + Represents the collection of properties for a field group. + + + + + Specifies a boolean value that indicates whether an asterisks should be displayed in + subtotals and totals + + + + + Specifies the string to be displayed in column header in compact mode. This attribute + depends on whether the application implements a compact mode for displaying + PivotTables in the user interface. + + + + + Specifies the compact new fileds + + + + + Specifies the display compact Data + + + + + This attribute indicates the wheater to auto sort pivot table or not + + + + + This attribute represents the multiple fields in the data region + is located in the row area or the column area + + + + + This attribute represents the position for the field which representing multiple data field in the PivotTable + + + + + this attribute indicates whether to disable the PivotTable field list. + + + + + This attribute that indicates whether the user is allowed to edit the cells in + the data area of the PivotTable. + + + + + This attribute that indicates whether the user is prevented from drilling down + on a PivotItem or aggregate value. + + + + + indicates whether the user is prevented from displaying + PivotField properties. + + + + + This attribute that indicates whether the user is prevented from displaying + the PivotTable wizard. + + + + + This attribute Specifies the string to be displayed in cells that contain errors. + + + + + this attribute that indicates whether fields in the PivotTable are sorted in + non-default order in the field list. + + + + + Specifies the display name + + + + + Specifies the number of columns per page for this PivotTable that the filter area will + occupy. + + + + + Specifies the number of rows per page for this PivotTable that the filter area will occupy. + + + + + Specifies a boolean value that indicates whether the approximate number of child items + for this item is greater than zero. + + + + + Specifies a boolean value that indicates whether this item has been expanded in the + PivotTable view. + + + + + Specifies a boolean value that indicates whether attribute hierarchies nested next to + each other on a PivotTable row or column will offer drilling "across" each other or not. + + + + + Specifies a boolean value that indicates whether this item is a calculated member. + + + + + Specifies a boolean value that indicates whether the item is hidden. + + + + + Specifies the user caption of the item. + + + + + Specifies a boolean value that indicates whether the item has a character value. + + + + + Specifies a boolean value that indicates whether the details are hidden for this item. + + + + + Specifies a boolean value that indicate whether the item has a missing value. + + + + + Specifies the type of this item. A value of 'default' indicates the subtotal or total item. + + + + + Specifies the base of this field, + + + + + Specifies the parent of this field, + + + + + Represents the collection of discrete grouping properties for a field group + + + + + Represents the collection of items in a field group. + + + + + Represents the collection of range grouping properties. + + + + + Specifies a boolean value that indicates whether the application uses the source data to + set the ending range value. + + + + + Specifies a boolean value that indicates whether we use source data to set the beginning + range value. + + + + + Specifies the ending value for date grouping if autoEnd is false. + + + + + Specifies the ending value for numeric grouping if autoEnd is false. + + + + + Specifies the grouping. + + + + + Specifies the grouping interval for numeric range grouping. Specifies the number of days + to group by in date range grouping + + + + + Specifies the starting value for date grouping if autoStart is false. + + + + + Specifies the starting value for numeric grouping if autoStart is false. + + + + + Specifies a boolean value that indicates whether an "AutoShow" filter is applied to this + field. + + + + + Specifies a boolean value that indicates whether the field can be removed from the + PivotTable. + + + + + Specifies a boolean value that indicates whether the field can be dragged to the column + axis. + + + + + Specifies a boolean value that indicates whether the field can be dragged to the data + region. + + + + + Specifies a boolean value that indicates whether the field can be dragged to the page + region + + + + + Specifies a boolean value that indicates whether the field can be dragged to the row axis + + + + + Specifies a boolean value that indicates whether new items that appear after a refresh + should be hidden by default. + + + + + Specifies a boolean value that indicates whether manual filter is in inclusive mode. + + + + + Specifies a boolean value that indicates whether to insert a blank row after each item. + + + + + Specifies a boolean value that indicates whether to insert a page break after each item. + + + + + Specifies the number of items showed per page in the PivotTable. + + + + + Specifies a boolean value that indicates whether field has a measure based filter. + + + + + Specifies a boolean value that indicates whether the field can have multiple items + selected in the page field. + + + + + Specifies a boolean value that indicates whether to hide drop down buttons on PivotField + headers + + + + + Specifies a boolean value that indicates whether to show the property as a member + caption. + + + + + Specifies a boolean value that indicates whether to show the member property value in a + tooltip on the appropriate PivotTable cells. + + + + + Specifies the type of sort that is applied to this field. + + + + + Specifies the unique name of the member property to be used as a caption for the field + and field items. + + + + + Represents an item within a PivotTable field that uses a formula + + + + + Represents an item within a PivotTable field that uses a formula + + + + + Represents a set of selected fields and selected items within those fields + + + + + Represents a set of selected fields and selected items within those fields + + + + + Flag indicating whether any indexes refer to fields or items in the Pivot cache + + + + + Flag indicating whether the column grand total is included. + + + + + Flag indicating whether only the data values + + + + + Position of the field within the axis to which this rule applies. + + + + + Flag indicating whether the row grand total is included + + + + + Flag indicating whether only the item labels for an item selection + are selected and does + not include the data values + + + + + A Reference that specifies a subset of the selection area. + + + + + Specifies a boolean value that indicates whether the + item is referred to by position rather than item index. + + + + + Specifies a boolean value that indicates whether the item is + referred to by a relative reference rather than an absolute reference + + + + + Specifies a boolean value that indicates whether this field has selection + + + + + Pivot Area tag + + + + + Pivot Area Type + + + + + Represents the collection of conditional formats applied to a PivotTable + + + + + Represents the conditional formatting defined in the PivotTable. + + + + + Specifies a boolean value that indicates whether the in-grid drop zones should be + displayed at runtime, and whether classic layout is applied. + + + + + Specifies a boolean value that indicates how the page fields are laid out + when there are multiple PivotFields in the page area. + + + + + Specifies a boolean value that indicates whether to show error messages in cells + + + + + Specifies a boolean value that indicates + whether to show a message in cells with no value. + + + + + Specifies a boolean value that indicates whether to + show a message in cells with no value. + + + + + Specifies a boolean value that indicates whether the formatting applied by + the user to the PivotTable cells is discarded on refresh. + + + + + Specifies a boolean value that indicates whether tooltips should be + displayed for PivotTable data cells. + + + + + + + + + + Specifies a boolean value that indicates whether row or column titles that span multiple + cells should be merged into a single cell. + + + + + Specifies the number of page fields to display before starting another row or column. + + + + + Represents the collection of filters that apply to this PivotTable. + + + + + Specifies the description of the pivot filter. + + + + + Specifies the evaluation order of the pivot filter. + + + + + Specifies the index of the measure field. + + + + + Specifies the index of the measure cube field. + + + + + Indicates whether the AutoFilter button for this column is hidden + + + + + Flag indicating whether the filter button is visible. + + + + + Specifies the element for Auto filter. + + + + + Specifies the element for filter column + + + + + Specifies the attributes for operator which is applied in pivot filter. + + + + + Specifies the string value "1" used by label pivot filters. + + + + + Zero-based index indicating the AutoFilter column to which this filter information applies. + + + + + Specifies the string value "2" used by label pivot filters. + + + + + Specifies the unique identifier of the pivot filter as assigned by the PivotTable. + + + + + Specifies the element for Custom filters. + + + + + Specifies the element for Custom filter + + + + + Attribute specifying whether and operator is used. + + + + + Top or bottom value to use as the filter criteria. + + + + + Flag indicating whether to filter by blank. + + + + + The actual cell value in the range which is used to perform the comparison for this filter. + + + + + Flag indicating whether or not to filter by percent value of the column. + + + + + Flag indicating whether or not to filter by top order + + + + + Specifies the element for Top 10 filter + + + + + Represents the collection of filter that apply to this PivotFilters. + + + + + Represents the collection of custom formats apply to the pivot table. + + + + + Represents the collection of formats applied to PivotChart. + + + + + Specifies the string to be displayed in row header in compact mode. + + + + + Represents the sorting scope for the PivotTable. + + + + + Represents a Error value in a PivotTable. + + + + + Represents the collection of OLAP hierarchies in the PivotCache. + + + + + Represents the collection of Key Performance Indicators (KPIs) + defined on the OLAP server and stored in the PivotCache. + + + + + Represents the collection of PivotTable OLAP dimensions. + + + + + Represents a PivotTable OLAP measure group. + + + + + Represents the PivotTable OLAP measure group - Dimension maps. + + + + + Represents the collection of OLAP hierarchies associated with the PivotTable. + + + + + Represents the collection of references to OLAP hierarchies on the row axis of a PivotTable. + + + + + Specifies the hierarchy that this field is part of. + + + + + Specifies the hierarchy level that this field is part of. + + + + + Represents the Pivot Field Captions. + + + + + Specifies a boolean value that indicates whether sort is applied to this field in the datasource. + + + + + Specifies a boolean value that indicates the drill state of the attribute hierarchy in an + OLAP-based PivotTable. + + + + + Specifies a boolean value that indicates whether all items in the field are expanded. + Applies only to OLAP PivotTables. + + + + + Indicates whether the pivot cache has missing items. + + + + + Specifies the hierarchy level that this page field is part of. + + + + + Specifies a boolean value that indicates whether this field Member Property + database + + + + + Specifies the string to be displayed for grand totals. + + + + + Defines constants required for protection parsing/serialization in Excel 2007 format. + + + + + This collection expresses the sheet protection options to enforce when the sheet is protected. + + + + + Specifies the hash of the password required for editing this worksheet. + This protection is optional and may be ignored by applications that choose not + to support this functionality. The hash is generated from an 8-bit wide character. + + + + + Objects are locked when the sheet is protected. + + + + + Scenarios are locked when the sheet is protected. + + + + + Formatting cells is locked when the sheet is protected. + + + + + Formatting columns is locked when the sheet is protected. + + + + + Formatting rows is locked when the sheet is protected. + + + + + Inserting columns is locked when the sheet is protected. + + + + + Inserting rows is locked when the sheet is protected. + + + + + Inserting hyperlinks is locked when the sheet is protected. + + + + + Deleting columns is locked when the sheet is protected. + + + + + Deleting rows is locked when the sheet is protected. + + + + + Selection of locked cells is locked when the sheet is protected. + + + + + Sorting is locked when the sheet is protected. + + + + + Autofilters are locked when the sheet is protected. + + + + + Selection of unlocked cells is locked when the sheet is protected. + + + + + Pivot tables are locked when the sheet is protected. + + + + + Sheet is locked when the sheet is protected. + + + + + Specifies the specific cryptographic hashing algorithm which shall be used along with the + salt attribute and input password in order to compute the hash value. + + + + + Specifies the hash value for the password required to edit this worksheet. + + + + + Specifies the number of times the hashing function shall be iteratively run. + + + + + Specifies the salt which was prepended to the user-supplied password before it was + hashed using the hashing algorithm. + + + + + Specifies the specific cryptographic hashing algorithm which shall be used along with the + salt attribute and input password in order to compute the hash value. + + + + + Specifies the hash value for the password required to edit this workbook. + + + + + Specifies the number of times the hashing function shall be iteratively run. + + + + + Specifies the salt which was prepended to the user-supplied password before it was + hashed using the hashing algorithm. + + + + + This element specifies options for protecting data in the workbook. Applications + may use workbook protection to prevent anyone from accidentally changing, moving, + or deleting important data. + + + + + Specifies a boolean value that indicates whether structure of workbook is locked. + + + + + Specifies a boolean value that indicates whether the windows that comprise the workbook are locked. + + + + + Specifies the hash of the password required for unlocking this workbook. + + + + + This class simply hold all constants required by relations. + + + + + Content type for workbook item (used in relations). + + + + + Content type for styles item (used in relations). + + + + + Content type for SST dictionary item (used in relations). + + + + + Content type for calculation chain item (used in relations). + + + + + Content type for vml drawings (used in worksheet relations). + + + + + Content type of comment notes items (used in worksheet relations). + + + + + Content type for drawings (used in worksheet relations). + + + + + Content type for chart drawings (used in worksheet relations). + + + + + Represents package level relationships namespace. + + + + + Content type for theme item (used in relations). + + + + + Content type for image item (used in relations). + + + + + Content type for core properties item (used in relations). + + + + + Content type for extended properties item (used in relations). + + + + + Content type for custom properties item (used in relations). + + + + + Content type for path to extern link source (used in relations). + + + + + Content type for external link (used in relations). + + + + + Content type for chart. + + + + + Relation type for worksheet custom property. + + + + + Content type for path to extern link source that is missing. + + + + + Content type for pivot cache definition. + + + + + Content type for pivot cache records. + + + + + Content type for pivot table. + + + + + Content type for table object. + + + + + Content Type for Ole object. + + + + + Content Type for External connection. + + + + + Content Type for Query Table. + + + + + Content Type for Theme Override. + + + + + This class contains constants required for vml shapes parsing and serialization. + + + + + Name of a namespace used by VML (marked by 'v' in MS Excel 2007 documents). + + + + + Name of a namespace used by VML (marked by 'o' in MS Excel 2007 documents). + + + + + Name of a namespace used by VML (marked by 'x' in MS Excel 2007 documents). + + + + + Namespace prefix used in vml shapes. + + + + + Namespace prefix used in vml shapes. + + + + + Namespace prefix used in vml shapes. + + + + + Root tag for vml shapes. + + + + + Name of the xml tag that represents shape type definition in VML. + + + + + String format used to create shape type id. {0} must be replaced with instance + field of the shape object. + + + + + String format used to create shape id. {0} must be replaced with correct shape id number. + + + + + Name of the xml attribute that stores shape type id. + + + + + Name of the xml attribute that stores shape (or shape type) coordinate size. + + + + + Default value of the coord size for comment shape. + + + + + Name of the xml attribute that stores spt option (it looks like it equals to instance field of the shape). + + + + + Name of the xml attribute that stores shape path value. + + + + + Default value of the path value for comment shape. + + + + + Default value of the path value for bitmap shape. + + + + + Name of the xml tag that stores vml shape client data. + + + + + Name of the xml attribute that stores vml shape type. + + + + + Name of the xml tag that indicates whether shape should be moved with cells or not. + + + + + Name of the xml tag that indicates whether shape should be sized with cells or not. + + + + + Name of the xml tag that stores anchor settings. + + + + + Name of the xml tag that stores all shape settings. + + + + + Name of the xml tag that stores all shape layout settings. + + + + + Name of the xml tag that stores shape type attribute. + + + + + Name of the xml tag that stores information about vml drawings inside worksheet part. + + + + + Name of the xml tag that stores information about vml header/footer drawings inside + worksheet part. + + + + + Name of the xml tag that stores row index of the note shape. + + + + + Name of the xml tag that stores column index of the note shape. + + + + + Style attribute for vml shapes. + + + + + Name of the xml attribute that stores vml shape fill color value. + + + + + Name of the xml tag that stores vml shape shadows settings. + + + + + Name of the xml attribute that specifies whether to show a shadow. + + + + + Name of the xml attribute that specifies whether a shadow is transparent. + Default is false. If true, the shadow is transparent if there is no fill on the shape. + + + + + Name of the xml attribute that specifies the color of the primary shadow. + Default is gray (RGB 128,128,128). + + + + + Specifies text alignment. + + + + + Name of xml attribute that specifies whether the application calculates the + internal text margin instead of using the inset attribute. Default is custom. + This attribute is only meaningful for text boxes. + + + + + Name of the xml tag that stores some of text box settings. + + + + + Name of the xml tag that stores div settings. + + + + + Part of the style attribute value that defines whether shape is visible or hidden. + + + + + One of possible visibility values. Indicates that shape is hidden. + + + + + Name of the xml tag that specifies whether text is locked or not. + + + + + Name of the xml tag that specifies the horizontal text alignment for the object. + + + + + Name of the xml tag that specifies the vertical text alignment for the object. + + + + + This element is used to draw an image that has been loaded from an external source. + + + + + Specifies the relationship ID of the relationship to the image. + + + + + Determines the flow of the text layout in a textbox. + + + + + CheckStateChanged of layout-flow attribute which indicates that text is displayed vertically. + + + + + Specifies the alternate layout flow for text in textboxes. + + + + + Specifies the top to bottom layout flow for text in textboxes. + + + + + /// Specifies the bottom to top layout flow for text in textboxes. + + + + + Specifies whether the shape will stretch to fit the text in the textbox + + + + + Represents true expression + + + + + Represents false expression + + + + + This element defines a set of formulas whose calculated values are referenced by other attributes. + + + + + This element defines a single value as the result of the evaluation of an expression. + + + + + Specifies a single formula, which consists of a named operation followed + by up to three parameters. + + + + + This element defines the path that makes up the shape. + + + + + Specifies whether an extrusion is allowed to be displayed. + + + + + Specifies whether a gradient path will be made up of repeated concentric paths. + + + + + Specifies the type of connection points used for attaching shapes to other shapes. + + + + + Specifies whether the original size of an object is saved after reformatting. + + + + + Specifies whether the closed path will be filled. + + + + + Specifies whether the path defining the shape is stroked with a solid line. + + + + + This element describes how to draw the path if something beyond solid line + with a solid color is desired. + + + + + Specifies the join style for line ends. + + + + + This element specifies locks against actions that can be effected in the UI + of an authoring application or programmatically through an object model. + + + + + Specifies an optional value that indicates how applications that implement + VML should interpret extensions not defined as part of the original + specification of core VML. + + + + + Specifies whether the aspect ratio of a shape is locked from being edited. + + + + + Tag that stores checkbox checked state. + + + + + Specifies font and text inside div element. + + + + + Font face. + + + + + Font size. + + + + + Font color. + + + + + Fill style color. + + + + + Represents check box shape type. + + + + + + Represents combo box shape type. + + + + + This element specifies that the object is an AutoLine object. If this + element is specified without a value, it is assumed to be true. + + + + + This element specifies that the object is an AutoFill object. If this + element is specified without a value, it is assumed to be true. + + + + + This element specifies the cell the object is linked to, using standard cell reference syntax. + + + + + This element specifies whether the object is first button of the Grouped objects, + + + + + This element specifies the scroll bar position as the index of the list + item just above the item at the top of the view, given the current scroll + position. The list indexes are 1-based. + If omitted, the value is assumed to be 0. + + + + + This element specifies the minimum scroll bar position as the index of + the list item just above the item at the top of the view when the control + is scrolled all the way up, typically 0. The list indexes are 1-based. + If omitted, the value is assumed to be 0. + + + + + Specifies the position of the center rectangle of a radial gradient. The vector is a fraction + of the width and height of the shape. The first is a percentage of the fill to the left edge; + the second is a percentage of the fill to the top. Default is 0,0. To position a radial fill at + the center of a shape, use a value of 50%,50%. + + + + + Specifies the size of the center rectangle of a radial gradient. The vector is a fraction of + the width and height of the shape. The first is a percentage of the fill to the right edge; + the second is a percentage of the fill to the bottom. Default is 0,0. + + + + + lightness or darkness of "one color" option in Gradient + + + + + Colors attributes specifies the combination of colors + applied to the shape. this attribute usde for preset colors + + + + + This element specifies the number of lines to move the scroll bar on an increment click. + If omitted, the increment is 0. + + + + + This element specifies the number of lines to move the scroll bar on a page click. + + + + + This element specifies the width of the scroll bar in screen pixels. + + + + + This element specifies that 3D effects are disabled. If this element + is specified without a value, it is assumed to be true. + + + + + This element specifies that 3D effects are disabled. If this element + is specified without a value, it is assumed to be true. + + + + + This element specifies the range of source data cells used to populate + the list box, using standard cell reference syntax. + + + + + This element specifies that the object represents a password edit field. + If this element is specified without a value, it is assumed to be true. + + + + + This element specifies the selection type for the list box. If omitted, the control is assumed to be Single. + + + + + This element specifies the list box callback type. The application should + use the callback to determine how to handle user actions on the list box. + The only allowed value is Normal. + + + + + Normal value of the callback type. + + + + + This element specifies the style of the dropdown. + + + + + This element specifies the maximum number of lines in the dropdown before + scrollbars are added. + + + + + this part contains tags used in VML + + + + + Gradient Fill Method + + + + + Gradient fill method value none. + + + + + This element specifies how the shape should be filled + + + + + for two color fill + + + + + link attribute + + + + + solid fill tag + + + + + Texture Attribute value + + + + + Picture Attribute Value + + + + + Pattern Attribute Value + + + + + Fill type Tag value represents gradient fill type + + + + + Fill type Tag value represents gradient radial (From corner or Center) fill type + + + + + Fill type Tag value represents gradient radial (From corner or Center) fill type + + + + + fill One Color Darkeness + + + + + fillOne Color Lightness + + + + + "Transparency From" of the filled color + + + + + "Transparency To" of the filed color + + + + + Filled color Shading (Horizontal , vertical...) + + + + + filled color rotates with the shape + + + + + shape's border Line wieght + + + + + focus attribute specifies to shading variants + Values range from 100% to -100%. Default is 0. + + + + + Relation id for the resource + + + + + Title of the texture or picture or pattern + + + + + FillType specifies the pattern fill of + Line in VMLtexbox shapes + + + + + Represent Dash Style (solid, shortDash) + + + + + Represent line style (ThinThick,..) + + + + + Represents solid fill type of the shape + + + + + Alternate text for the Shape + + + + + represents the place holder image + + + + + Link Attribute value + + + + + Specifies that the fill uses an image + + + + + represents the path + + + + + represents the extrusion + + + + + represent strokeok + + + + + represent fillok + + + + + represent conect type + + + + + represent lock + + + + + represent extension + + + + + represent Shape type + + + + + represent shadoe ok + + + + + represent ole Update + + + + + Colors are prefixed with this char + + + + + indexed color enclosed with this char + + + + + Size value prefixed with this char + + + + + Size value store with this string + + + + + opacity value divided by this + + + + + Degree value divided by this + + + + + degree's dark limit + + + + + This enum specifies possible selection types. + + + + + The listbox may only have one selected item. + + + + + The listbox may have multiple items selected by clicking on each item. + + + + + The listbox may have multiple items selected by holding a control key and clicking on each item. + + + + + Possible drop styles. + + + + + Standard combo box. + + + + + Editable combo box. + + + + + Standard combo box with only the dropdown button visible when the box is not expanded. + + + + + Class used for Excel 2007 Serialization. + + + + + Maximum allowed formula length. + + + + + File heading. + + + + + Namespace with ContentTypes items. + + + + + Namespace for hyperlink. + + + + + Namespace for relation tags/attributes. + + + + + Main xml namespace. + + + + + Name of the relation type that indicates that part contains worksheet data. + + + + + Name of the relation type that indicates that part contains chartsheet data. + + + + + Name of the relation type that indicates that part contains extended document properties. + + + + + Name of the relation type that indicates that part contains core properties. + + + + + Name of the relation type that indicates that part contains the Sparkline properties. + + + + + Main Microsoft Namespace + + + + + Uri for the Sparkline properties. + + + + + Prefix for core properties namespace. + + + + + Name of the relation type that indicates dublin core part. + + + + + Prefix for dublin core namespace. + + + + + Name of the relation type that indicates dublin core terms part. + + + + + Prefix for dublin core terms namespace. + + + + + Name of the relation type that indicates DCMIType part. + + + + + Prefix for DCMIType namespace. + + + + + Name of the relation type that indicates XSI part. + + + + + Prefix for XSI namespace. + + + + + Name of the relation type that indicates that part contains custom properties. + + + + + Name of the relation type that indicates DocPropsVTypes namespace + + + + + OleObject Content Type + + + + + OleObject File Extension + + + + + Prefix for DocPropsVTypes namespace. + + + + + Prefix for relation namespace. + + + + + Prefix for Sparkline namespace. + + + + + Prefix for Microsoft Main Namespace. + + + + + Name of the xml tag that stores content types definitions. + + + + + Name of the xml attribute with part extension. + + + + + Name of the xml tag that stores default type name. + + + + + Name of the xml tag that stores content type string. + + + + + Name of the xml tag that stores type override. + + + + + Name of the xml attribute that stores part name. + + + + + Name of the xml tag that defines the structure of the workbook. + + + + + Name of the xml tag that represents the collection of sheets in the workbook. + + + + + Name of the xml tag that defines a sheet in this workbook. + + + + + Name of the xml attribute that stores sheet name. + + + + + Default worksheet path format + + + + + Relation id format + + + + + Name of the xml attribute that stores unique sheet id. + + + + + Name of the xml attribute that stores relation id. + + + + + Name of the xml attribute that stores relation id, + it is used in .rels file (starts with capital letter). + + + + + Name of the xml attribute that specifies the visible state of this sheet. + + + + + This element defines the collection of properties the application uses + to record calculation status and details. + + + + + Default delimiter between worksheet rows. + + + + + Indicates the book window is hidden, but can be shown by the user via the user interface. + + + + + Indicates the sheet is hidden and cannot be shown in the user interface (UI). + This state is only available programmatically. + + + + + Indicates the sheet is visible. + + + + + Name of the xml tag that holds relationships data. + + + + + Name of the xml tag that holds relationship data. + + + + + Name of the xml attribute that holds relationship type. + + + + + Name of the xml attribute that holds relationship target. + + + + + Name of the xml attribute that holds relationship target mode. + + + + + Name of relationship external target mode. + + + + + Name of the xml tag that contains merged cells data. + + + + + Name of the count attribute. + + + + + Name of the xml tag that contains single merge region's data. + + + + + Name of the ref attribute. + + + + + Name of the xml tag that contains all defined named ranges. + + + + + Name of the xml tag that contains single defined named range. + + + + + Name of the name attribute. + + + + + Name of the attribute that stores sheet id for named range. + + + + + Name of the xml tag that contains all styles settings (fonts, number formats, fills, etc.) inside. + + + + + Name of the xml tag that contains all fonts settings inside. + + + + + Name of the xml tag that contains all font settings inside. + + + + + Name of the xml tag that indicates that font is bold. + + + + + Name of the xml tag that indicates that font is italic. + + + + + Name of the xml tag that stores font underline settings. + + + + + Name of the value attribute. + + + + + Name of the xml tag that stores font underline settings. + + + + + Name of the xml tag that indicates that font has strike settings. + + + + + Name of the xml tag that represents font name. + + + + + Name of the xml tag that contains color settings. + + + + + Name of the indexed attribute in the color tag. + + + + + Name of the xml attribute that represents index into the theme colors collection. + + + + + Name of the xml attribute that represents the tint value applied to the color. + + + + + Name of the rgb attribute in the color tag. + + + + + Name of the default color attribute. + + + + + Name of the xml tag that stores indexed color values. + + + + + Name of the xml tag that stores color settings. + + + + + Name of the xml tag that stores rgb color. + + + + + Name of the xml tag that stores MacOSShadow settings. + + + + + Name of the xml tag that stores font vertical alignment settings. + + + + + Name of the xml tag that stores font family settings. + + + + + Name of the xml tag that stores font charset settings. + + + + + Name of the xml tag that represents number formats. + + + + + Name of the xml tag that represents single number format. + + + + + Name of the xml attribute that defines number format id. + + + + + Name of the xml attribute that defines number format string. + + + + + Name of the xml tag that represents fills collection. + + + + + Name of the xml tag that represents single fill object. + + + + + Name of the xml tag that represents pattern fill object. + + + + + Name of the xml tag that represents gradient-style cell fill. + + + + + Name of the xml attribute that represents type of gradient fill. + + + + + This gradient fill is of linear gradient type. + + + + + This gradient fill is of path gradient type. + + + + + Name of the xml attribute that represents angle of the linear gradient - vertical, horizontal, diagonal. + + + + + Name of the xml attribute that specifies in percentage format (from the top to the bottom) the + position of the bottom edge of the inner rectangle (color 1). + + + + + Name of the xml attribute that specifies in percentage format (from the left to the right) the + position of the left edge of the inner rectangle (color 1). + + + + + Name of the xml attribute that specifies in percentage format (from the left to the right) the + position of the right edge of the inner rectangle (color 1). + + + + + Name of the xml attribute that specifies in percentage format (from the top to the bottom) the + position of the top edge of the inner rectangle (color 1). + + + + + Name of the xml tag name that represents one of a sequence of two or more gradient stops, constituting this gradient fill. + + + + + Name of the xml attribute that represents position information for this GradientStop. + + + + + Name of the xml attribute that defines pattern. + + + + + Name of the xml tag that represents background color. + + + + + Name of the xml tag that represents foreground color. + + + + + Name of the xml tag that stores all border collections inside. + + + + + Name of the xml tag that stores single border collection. + + + + + Name of the xml attribute that represents border style. + + + + + Name of the xml tag that stores border color. + + + + + This is the root element of Sheet Parts that are of type 'worksheet'. + + + + + Name of the xml tag that stores worksheet dimension. + + + + + Name of the xml tag that stores sheet data. + + + + + Name of the xml tag that stores cell in the worksheet. + + + + + Name of the xml attribute that represents the cell metadata record associated with this cell. + + + + + Name of the xml attribute that represents boolean value to show phonetic information. + + + + + Name of the xml attribute that represents an A1 style reference to the location of this cell. + + + + + Name of the xml attribute that represents the index of this cell's style. + + + + + Name of the xml attribute that represents an enumeration representing the cell's data type. + + + + + Name of the xml attribute that represents index of the value metadata + record associated with this cell's value. + + + + + Name of xml tag that represents formula. + + + + + Name of xml tag that represents cell value. + + + + + Name of xml tag that represents rich text. + + + + + Name of xml tag that represents rich text run properties. + + + + + Name of xml tag that represents rich text run font name. + + + + + Name of the xml tag that stores all column settings. + + + + + Name of the xml tag that stores column settings range. + + + + + Name of the xml attribute that stores minimum column index of the column range. + + + + + Name of the xml attribute that stores maximum column index of the column range. + + + + + Name of the xml attribute that stores width of each column from column range. + + + + + Name of the xml attribute that stores style of each column from column range. + + + + + Name of the xml attribute that indicates whether column width differs from the default one. + + + + + + + + + + Name of xml tag that represents row. + + + + + Name of xml attribute that represents row index. + + + + + Name of xml attribute that represents row height in point size. + + + + + Name of xml attribute that shows whether row is visible or not. + + + + + Name of xml attribute that shows whether row style should be applied or not. + + + + + Name of xml attribute that shows whether row height has been manually set or not. + + + + + Name of xml attribute that shows whether row has been collapsed or not. + + + + + Name of xml attribute that represents outlining level of the row. + + + + + Name of xml attribute that represents thick bottom flag. + + + + + Name of xml attribute that represents thick top flag. + + + + + Name of xml attribute that represents formula type. + + + + + True indicates that this formula is an array formula and the entire array shall be + calculated in full. If false the individual cells of the array shall be calculated as needed. + + + + + Name of xml attribute that represents shared formula group index. + + + + + Name of xml attribute that represents range of cells which the formula applies to. + + + + + Name of the xml tag that holds list of all comment authors. + + + + + Name of the xml tag that holds single author name. + + + + + Name of the xml tag that holds all comment notes. + + + + + Name of the xml tag that holds single comment note. + + + + + Name of the xml tag that stores comment text. + + + + + Name of the xml tag that stores all comment notes settings. + + + + + Name of the xml attribute that stores comment author id. + + + + + Defines default cell data type. + + + + + Name of the xml tag that stores extended formats for named styles. + + + + + Name of the xml tag that stores extended formats for cell formats. + + + + + Name of the xml tag that stores extended formats for differential formats. + + + + + Name of the xml tag that stores table styles. + + + + + Name of the xml tag that stores single extended format settings. + + + + + Name of the xml attribute that represents font id. + + + + + Name of the xml attribute that represents fill id. + + + + + Name of the xml attribute that represents border id. + + + + + Name of the xml attribute that represents extended format index. + + + + + Name of the xml tag that stores named cell styles settings. + + + + + Name of the xml tag that stores single named cell style settings. + + + + + Name of the xml attribute that stores built in style id. + + + + + Name of the xml attribute that define the customized buildinstyles. + + + + + Indicates that this formatting is for an outline style. + + + + + Name of the xml attribute indicating whether the alignment formatting + specified for this xf should be applied. + + + + + Name of the xml attribute indicating whether the border formatting + specified for this xf should be applied. + + + + + Name of the xml attribute indicating whether the font formatting + specified for this xf should be applied. + + + + + Name of the xml attribute indicating whether the number formatting + specified for this xf should be applied. + + + + + Name of the xml attribute indicating whether the fill formatting + specified for this xf should be applied. + + + + + Name of the xml attribute indicating whether the protection formatting + specified for this xf should be applied. + + + + + Name of the xml tag that hold all style's alignment information. + + + + + Name of the xml tag that hold all style's protection information. + + + + + Name of the xml attribute that stores style indent level settings. + + + + + Name of the xml attribute that specifies the type of horizontal alignment in cells. + + + + + Name of the xml attribute indicating if the cells justified or distributed + alignment should be used on the last line of text. + + + + + Name of the xml attribute that holds reading order settings. + + + + + Name of the xml attribute that holds shrink to fit option. + + + + + Name of the xml attribute that holds text rotation value. + + + + + Name of the xml attribute that holds wrap text option. + + + + + Name of the xml attribute that specifies the type of vertical alignment in cells. + + + + + Name of the xml attribute that indicates whether cell is hidden. + + + + + Name of the xml attribute that indicates whether cell is locked. + + + + + Default value for FormulaHidden value. + + + + + Default value for Locked value. + + + + + Name of the xml attribute that stores value indicating whether the text + string in a cell should be prefixed by a single quote mark. + + + + + Name of the xml attribute that indicates whether diagonalDown border is present. + + + + + Name of the xml attribute that indicates whether diagonalUp border is present. + + + + + Name of the xml tag that represents shared string table. + + + + + Name of the xml attribute that represents the total count of unique strings in the SST. + + + + + Name of the xml tag that represents individual string in SST. + + + + + Name of the xml tag that represents the text content shown as part of a string. + + + + + Name of the xml tag that represents rich text run. + + + + + Root items for data preserving. + + + + + Attribute to specify string spacing. + + + + + Xml prefix. + + + + + Value specifying white space preservation in a string. + + + + + Represents Number data type. + + + + + Represents string data type. + + + + + Represents boolean data type. + + + + + Represents error. + + + + + Represents formula. + + + + + Represents inline string + + + + + Name of the xml tag that represents the root level complex type associated with a shared style sheet (or theme). + + + + + Name of the xml tag that represents the root level complex type associated with a shared style sheet (or theme) overrided. + + + + + Name of the xml tag that represents the theme formatting options for the theme and is the workhorse of the theme. + + + + + Name of the xml tag that represents a set of colors which are referred to as a color scheme. + + + + + Name of the xml attribute name that the actual color value, expressed as a sequence of hex digits RRGGBB. + + + + + Name of the xml tag that represents a color bound to predefined operating system elements. + + + + + Name of the xml attribute that represents the system color value. + + + + + Name of the xml attribute that represents the color value that was last computed by the generating application. + + + + + Name of the xml tag that represents a single dxf record, expressing incremental formatting to be applied. + + + + + Name of the xml tag that represents a collection of phonetic properties that affect the display of phonetic text. + + + + + Represents sorting state. + + + + + Name of the xml tag that represents a collection of hyperlinks. + + + + + Name of the xml tag that represents a single hyperlink. + + + + + Name of the xml attribute that represents display string, if different from string in string table. + + + + + Name of the xml attribute that represents relationship Id in this sheet's relationships part, + expressing the target location of the resource. + + + + + Name of the xml attribute that represents location within target. + + + + + Name of the xml attribute that represents cell location of hyperlink on worksheet. + + + + + Name of the xml attribute that represents additional text to help the user understand more about the hyperlink. + + + + + Name of the xml tag that represents sheet level properties. + + + + + Page setup properties of the worksheet. + + + + + Flag indicating whether the Fit to Page print option is enabled. + + + + + Name of the xml tag that represents background color of the sheet tab. + + + + + Name of the xml tag that represents sheet outline properties. + + + + + Name of the xml tag that represents Summary Row below property of sheet outline + + + + + Name of the xml tag that represents Summary column right property of sheet outline + + + + + Name of the xml tag that represents Background sheet image. + + + + + Represent file hyperlink string prefix. + + + + + Represent http hyperlink string prefix. + + + + + Name of the xml tag that stores sheet format properties. + + + + + Name of the xml attribute that stores rows are hidden by default. + + + + + Name of the xml attribute that stores default row height setting. + + + + + Name of the xml attribute that stores default col width setting. + + + + + Name of the xml attribute that stores base column width setting + + + + + Name of the xml attribute that stores thickBottom setting + + + + + Name of the xml attribute that stores thickTop setting + + + + + Name of the xml attribute that stores outlineLevelCol setting + + + + + Name of the xml attribute that stores outlineLevelRow setting + + + + + Name of the xml tag that specifies the collection of workbook views. + + + + + Name of the xml tag that specifies a single Workbook view. + + + + + Name of the xml attribute that specifies an unsignedInt that contains the index to the active sheet in this book view. + + + + + Name of the xml attribute that specifies a boolean value that indicates whether to group dates + when presenting the user with filtering options in the user interface. + + + + + Name of the xml attribute that specifies the index to the first sheet in this book view. + + + + + Name of the xml attribute that specifies a boolean value that indicates whether the book window is minimized. + + + + + Name of the xml attribute that specifies a boolean value that indicates whether + to display the horizontal scroll bar in the user interface. + + + + + Name of the xml attribute that specifies a boolean value that indicates whether + to display the sheet tabs in the user interface. + + + + + Name of the xml attribute that specifies a boolean value that indicates whether to display the vertical scroll bar. + + + + + Name of the xml attribute that specifies ratio between the workbook tabs bar and the horizontal scroll bar. + + + + + Name of the xml attribute that specifies visible state of the book window. + + + + + Name of the xml attribute that specifies the height of the workbook window. + + + + + Name of the xml attribute that specifies the width of the workbook window. + + + + + Name of the xml attribute that specifies the X coordinate for the upper left corner of the book window. + + + + + Name of the xml attribute that specifies the Y coordinate for the upper left corner of the book window. + + + + + Name of the xml tag that represents horizontal page break information. + + + + + Name of the xml tag that represents vertical page break information + + + + + Name of the xml attribute that represents number of breaks in the collection. + + + + + Name of the xml attribute that represents number of manual breaks in the collection. + + + + + Name of the xml tag that represents individual row or column breaks; + + + + + Name of the xml attribute that represents zero-based row or column Id of the page break. + Breaks occur above the specified row and left of the specified column. + + + + + Name of the xml attribute that represents manual Break flag. + '1' means the break is a manually inserted break. + + + + + Name of the xml attribute that represents zero-based index of end row or column of the break. + For row breaks, specifies column index; for column breaks, specifies row index. + + + + + Name of the xml attribute that represents zero-based index of start row or column of the break. + For row breaks, specifies column index; for column breaks, specifies row index. + + + + + Worksheet/chartsheet views collection. + + + + + This element specifies a chart sheet view. + + + + + Flag indicating whether this sheet should display zero values. + + + + + Zero-based index of this workbook view, pointing to a workbookView + element in the bookViews collection. + + + + + String used to serialize sheet zooming + + + + + String used to serialize sheet view + + + + + String used to serialize sheet zooming + + + + + String used to serialize Page break preview layout. + + + + + String used to serialize Normal layout. + + + + + String used to serialize boolean True value. + + + + + String used to serialize boolean False value. + + + + + String used to serialize Sparkline Column type. + + + + + String used to serialize Sparkline WinLoss type. + + + + + String used to serialize Display of Empty Cells as gaps. + + + + + String used to serialize Display of Empty Cells as zero. + + + + + String used to serialize Display of Empty Cells as Continued lines. + + + + + String used to serialize Vertical Axis type as custom. + + + + + String used to serialize Vertical Axis type as same. + + + + + Flag indicating whether this sheet should display gridlines. + + + + + Flag indicating whether the sheet is in 'right to left' display mode. + When in this mode, Column A is on the far right, Column B ;is one column + left of Column A, and so on. Also, information in cells is displayed in + the Right to Left format. + + + + + Flag indicating whether this sheet gridline is modified by user + + + + + String used to specify the color of grid line + + + + + This collection is used to reference binary parts containing arbitrary user-defined data. + + + + + The custom property element provides a mechanism to store name/value pairs + of arbitrary user-defined data. The name is stored in the attribute name, + the arbitrary data is stored in the binary part referenced by the relationshipId. + + + + + A collection of ignored errors, by cell range. + + + + + A single ignored error type for a range of cells. + + + + + + + + + + + + + + + Attribute used to store range reference. + + + + + This element defines properties that track which version of the application + accessed the data and source code contained in the file. + + + + + Specifies the incremental public release of the application. + For example, betas, service packs, and versions. + + + + + This xml element stores the details of WorkbookPr. + + + + + This element stores information about the Date format to be used. + + + + + This element stores information about the Precision to be followed. + + + + + Specifies the application name. + + + + + Value of the application name attribute. + + + + + Flag indicating whether the panes in the window are locked due to workbook protection. + This is an option when the workbook structure is protected. + + + + + Xml attribute containing sheet codename. + + + + + Attribute for showing or hiding the fields list of pivot table in workbook + + + + + Xml Tags and Attributes containing Sheet Sparklines. + + + + + Attribute to show two-dimenssional data table + + + + + Attribute to show one-dimentional data table is a row or column + + + + + Attribute to represent first input cell for data table. + + + + + First visible character. + + + + + Flag indicating whether this sheet should display row and column headers. + + + + + Properties Constant + + + + + DocumentManagement Constalt + + + + + Properties NameSpace + + + + + PartnerControls NameSpace + + + + + Default Theme Version + + + + + Represent the connections + + + + + Represent the connections + + + + + Represent the WebProperties + + + + + Represent the Olap Property + + + + + Indicating whether cell has pivot button + + + + + CustomXmlParts Constants + + + + + Sequence of error types (must be in the same order as in ErrorTagsSequence). + + + + + String that formulas for Ole images. + + + + + String for the BorderColor of OleObject Image + + + + + Sequence of error xml attribute names corresponding to error types defined in ErrorsSequence. + + + + + Chars with codes less than 0x20 which are allowed to be used inside xml strings. + + + + + Parent workbook. + + + + + Formula utils. + + + + + Record extractor. + + + + + Collection with vml shapes seriliazators. + + + + + Collection with header/footer vml shapes seriliazators. + + + + + Conditional formats list. + + + + + List of Sheet names. + + + + + Special characters can use in the sheet name. + + + + + Initializes a new instance of the Excel2007Serializator class. + + Parent workbook. + + + + Serializes styles collection into specified XmlWriter. + + XmlWriter to serialize styles into. + Stream that contains Dxfs formatting tags. + Dictionary with new XF indexes. + + + + Serialize the sheet format properties + + the XML writer + the input worksheet object + + + + Serializes Data table into sheet. + + XmlWriter to serialize into. + Worksheet to serialize. + + + + Serializes worksheet's dimension. + + XmlWriter to serialize into. + Worksheet to serialize dimension of. + + + + Serializes worksheet's view properties. + + XmlWriter to serialize into. + Worksheet to serialize. + + + + Serializes active cell. + + Writer to write selection information into. + Worksheet to get active cell from. + + + + Serializes pane record. + + XmlWriter to serialize into. + Worksheet to serialize pane for. + + + + Serializes stream. + + XmlWriter to serialize into. + Data to be serialized. + + + + Serializes stream data. + + XmlWriter to serialize into. + Data to be serialized + Root name of the data. + + + + Serializes fonts collection into specified XmlWriter. + + XmlWriter to serialize fonts into. + + + + Serialize single font object into specified XmlWriter. + + XmlWriter to serialize fonts into. + Font to serialize. + Element tag name to serialize font for. + + + + Serializes font color object. + + XmlWriter to serialize into. + Name of the tag to use. + Color object to serialize. + + + + Serializes number formats collection into XmlWriter. + + XmlWriter to serialize into. + + + + Serialize single instance of number format into XmlWriter. + + Writer to save number format into. + Number format to serialize. + + + + Serializes fills into specified writer. + + XmlWriter to save fills into. + Array with fill indexes, index in array means extended format index, value means fill index. + + + + Serializes single fill object into specified XmlWriter. + + XmlWriter to serialize into. + Object to serialize. + + + + Serializes single pattern fill object into specified XmlWriter. + + XmlWriter to serialize into. + Object to serialize. + + + + Serializes single gradient fill object into specified XmlWriter. + + XmlWriter to serialize into. + Object to serialize. + + + + Serializes single degree gradient fill object into specified XmlWriter. + + XmlWriter to serialize into. + Object to serialize. + + + + Serializes single from corner or from center gradient fill object into specified XmlWriter. + + XmlWriter to serialize into. + Object to serialize. + + + + Serializes stop color for gradient fill object into specified XmlWriter. + + XmlWriter to serialize into. + Stop position attribute value. + Represents Color. + + + + Converts specified pattern into string that can be understood by MS Excel 2007. + + Pattern to convert. + Converted value. + + + + Serializes borders into specified XmlWriter. + + XmlWriter to save borders into. + Border indexes. + + + + Serializes color into XmlWriter. + + XmlWriter to serialize color into. + Name of the color tag. + Color value. + + + + Serializes rgb color value. + + XmlWriter to serialize into. + Xml tag name to use for color serialization. + Color to serialize. + + + + Serializes theme color into XmlWriter. + + XmlWriter to serialize color into. + Name of the color tag. + Color value. + + + + Serializes color into XmlWriter. + + XmlWriter to serialize color into. + Name of the color tag. + Color value. + + + + Serializes borders collection into specified XmlWriter. + + XmlWriter to serialize borders into. + Borders collection to serialize. + + + + Serializes single border entry inside BordersCollection. + + XmlWriter to serialize border into. + Border to serialize. + + + + Gets border. + + Represents Border line type + Border extracted. + + + + Gets Border line style. + + Border line style to be extracted for. + Extracted line style. + + + + Serializes extended formats used by named styles. + + XmlWriter to serialize into. + Index to fill objects (position in array - xf index, + value - fill index). + Index to border objects (position in array - xf index, + value - border index). + Dictionary containing extended format indexes. + + + + Serialize extended formats that are responsible for cell format (do not have names). + + XmlWriter to serialize into. + Index to fill objects (position in array - xf index, + value - fill index). + Index to border objects (position in array - xf index, + value - border index). + Dictionary with new parent indexes. + Dictionary containing extended format indexes. + + + + Serializes single extended format. + + XmlWriter to serialize into. + Array with fill indexes. + Array with border indexes. + Format to serialize. + Dictionary with new parent indexes. + Default value for ApplyAlignment, ApplyBorder, etc. + + + + Serializes alignment options if necessary. + + XmlWriter to serialize into. + ExtendedFormat to serialize. + + + + Checks whether specified extended format has default alignment options. + + Extended format to check. + True if extended format has default alignment options. + + + + Serializes protection options if necessary. + + XmlWriter to serialize into. + ExtendedFormat to serialize. + + + + Serializes all named styles. + + XmlWriter to serialize into. + Dictionary with new extended format indexes. + Key - index in our collection of extended formats, value - index in the cellStyleXfs block. + + + + Serializes single named style object. + + XmlWriter to serialize into. + Style object to serialize. + Dictionary with new extended format indexes. + Key - index in our collection of extended formats, value - index in the cellStyleXfs block. + + + + Lower first letter in the string. + + String to process. + New string with the first letter in lower case. + + + + Serializes attribute if it differs from default value. + + XmlWriter to serialize into. + Attribute name. + Attribute value. + Default value. + + + + Serializes attribute if it differs from default value. + + XmlWriter to serialize into. + Attribute name. + Attribute value. + Default value. + + + + Serializes attribute if it differs from default value. + + XmlWriter to serialize into. + Attribute name. + Attribute value. + Default value. + + + + Serializes attribute if it differs from default value. + + XmlWriter to serialize into. + Attribute name. + Attribute value. + Default value. + Namespace of the attribute that is being serialized. + + + + Serializes attribute if it differs from default value. + + XmlWriter to serialize into. + Attribute name. + Attribute value. + Default value. + + + + Serializes sheet data. + + XmlWriter to serialize into. + Cell record collection. + Dictionary with new extended format indexes. + Key - index in our collection of extended formats, value - index in the cellStyleXfs block. + + + + Serializes single row. + + XmlWriter to serialize into. + Row to serialize. + Cell record collection. + Row index. + Dictionary with new extended format indexes. + Key - index in our collection of extended formats, value - index in the cellStyleXfs block. + + + + Serializes cells. + + XmlWriter to serialize into. + Current row. + Cell record collection. + Dictionary with new extended format indexes. + Key - index in our collection of extended formats, value - index in the cellStyleXfs block. + + + + Serializes cells, which are not represented by Blank, MulBlank and MulRK records. + + XmlWriter to serialize into. + Record to serialize. + Row storage enumerator. + Cell record collection. + Dictionary with new extended format indexes. + Key - index in our collection of extended formats, value - index in the cellStyleXfs block. + + + + Serialize blank cell. + + XmlWriter to serialize into. + Row index. + Column index. + Extended format index. + Dictionary with new extended format indexes. + Key - index in our collection of extended formats, value - index in the cellStyleXfs block. + + + + Serializes MulBlank record. + + XmlWriter to serialize into. + MulBlank record to serialize. + Dictionary with new extended format indexes. + Key - index in our collection of extended formats, value - index in the cellStyleXfs block. + + + + Serialize MulRKRecord cell values. + + XmlWriter to serialize into. + MulRK record. + Dictionary with new extended format indexes. + Key - index in our collection of extended formats, value - index in the cellStyleXfs block. + + + + Serializes array formula. + + XmlWriter to serialize into. + Formula array record. + + + + Serializes formula. + + XmlWriter to serialize into. + Formula record. + Cell record collection. + + + + Serializes cell value. + + XmlWriter to serialize into. + Record to get value from. + Cell type. + + + + Serializes formula value. + + XmlWriter to serialize into. + Formula record to serialize from. + Cell type. + Row storage enumerator. + + + + Defines cell data type to serialize. + + Biff record. + String representation of the cell type. + Extracted Cell data type. + + + + Serializes shared string table into specified XmlWriter. + + XmlWriter to save SST into. + + + + Serializes string item into specified XmlWriter. + + XmlWriter to save string item into. + Rich text or string object to serialize. + + + + Replaces characters with codes less then 0x20. + + Text to replace chars in. + + + + + Ignores the hexa string with the hexa code before serialize + + string to ignore the hexa string + ignored hexa string + + + + Checks whether specified string is hexadecimal number. + + + + + + + Serializes rich text run into specified XmlWriter. + + XmlWriter to save rich text into. + Rich text run to serialize. + + + + Serializes rich text run single entry. + + XmlWriter to save rich text into. + Fonts collection. + String to serialize. + Font index. + + + + Serializes colors settings. In the current implementation it serializes palette if necessary. + + Writer to serialize into. + + + + Serializes palette. + + XmlWriter to serialize palette into. + + + + Determines whether palette contains default colors. + + True if all colors have default value; false otherwise. + + + + Serializes column settings. + + XmlWriter to serialize into. + Worksheet that stores column settings. + Dictionary with modified style indexes. + + + + Serialize single ColumnInfoRecord into specified XmlWriter. + + Writer to serialize into. + Record to serialize. This value can be null, + in this case no data will be serialized. + Dictionary with modified style indexes. + Default column width. + Parent worksheet. + Last index in the sequence of the same columns. + + + + Checks whether columns after iColumnIndex have the same settings and + returns the last number in the sequence. + + Worksheet to search in. + Column index to start searching from. + Last index in the sequence of the same columns. + + + + Gets the active pane. + + The pane record. + + + + + Serializes worksheet properties. + + XmlWriter to serialize properties into. + Worksheet to get properties from. + + + + Serialize the individual worksheets in the workbook + + input file archive + the input workbook + the input chart + defalut worksheet index + the styleindex collection + the boolean value indicates whether the file is default + + + + Parse and Returns Worksheetstream data rather than the worksheet data + + input stream + the extra relation attributes + the sheet stream rather than data + + + + Serialize the default worksheet + + input file archive + the input workbook + the input chart + defalut worksheet index + the styleindex collection + + + + Gets Dictionary with serializators that can be used to serialize header/footer vml shapes. Read-only. + + + + + Gets Dictionary with serializators that can be used to serialize vml shapes. Read-only. + + + + + Gets version that is supported by this serializator. + + + + + Represents the cell's data type. + + + + + Cell containing a boolean. + + + + + Cell containing an error. + + + + + Cell containing an (inline) rich string. + + + + + Cell containing a number. + + + + + Cell containing a shared string. + + + + + Cell containing a formula string. + + + + + Represents type of formula. + + + + + Formula is an array entered formula. + + + + + Formula is a data table formula. + + + + + Formula is a regular cell formula. + + + + + Formula is part of a shared formula. + + + + + Class used for Excel 2007 Serialization. + + + + + Uri for data bar properties + + + + + Gets version that is supported by this serializator. + + + + + Gets version that is supported by this serializator. + + + + + Class used for holding file data. + + + + + Classes that implement this interface are responsible for whole + workbook serialization into stream or into file. + + + + + Name of the zip item with content types description. + + + + + Name of the directory with relations. + + + + + Extension for relations file. + + + + + Path to the top relations. + + + + + Xml files extension. + + + + + Relations default extension. + + + + + Binary item extension. + + + + + Default name of the workbook part. + + + + + Default name of the CustomXml Parts + + + + + Default name of the shared strings part. + + + + + Default name of the styles part name. + + + + + Default name of the themes part name. + + + + + Path format for the worksheet part. + + + + + Path format for the chartsheet part. + + + + + Path format for pictures. + + + + + Default name of the extended properties part. + + + + + Default name of the core properties part. + + + + + Default name of the custom properties part. + + + + + Format for relation id generation. + + + + + Default name format for the external link items. + + + + + Start of the External links item name. + + + + + Start of the worksheet custom property item. + + + + + Default name format for cache definition. + + + + + Default name format for cache records. + + + + + Default name format for pivot table. + + + + + Format to get full path to zip archive item that stores tables. + + + + + External connection + + + + + Dictionary which contains the stream of the emf image file and wmf image file + + + + + Represents Zip Archive. + + + + + Parent workbook. + + + + + Parser to parse data if necessary. + + + + + Dictionary which is used to identify content type and stores default types. + Key - file extension (string), Value - content type (string). + + + + + Dictionary which is used to identify content type and stores type overrides. + Key - part name, Value - content type (string). + + + + + Top-level relations. + + + + + Name of the workbook part. + + + + + Name of the shared strings table part. + + + + + Name of the styles part. + + + + + Connection part. + + + + + Name of the themes part. + + + + + Object used for workbook serialization. + + + + + Represents list of workbook styles. + + + + + Workbook-level relations. + + + + + Specifies style relation id. + + + + + Specifies shares string relation id. + + + + + Specifies theme relation id. + + + + + Specifies workbook content type. + + + + + Memory stream that will get workbook part after /sheets tag or after /definedNames tag. + + + + + Memory stream that will get workbook part before sheets tag. + + + + + Stream that can contains Dxfs formatting tags. + + + + + Index used to generate comments zip item names. + + + + + Index used to generate vml zip item names. + + + + + Index used to generate drawing zip item names. + + + + + Index used to generate image zip item names. + + + + + Represents image id. + + + + + Index used to generate chart zip item names. + + + + + Index used to generate the pivotCache item name + + + + + Index used to generate the pivotCacheRecords item name + + + + + Index used to generate extern link zip item name. + + + + + Array that contains names of the image items. + + + + + Workbook views collection. + + + + + Items that must be removed after parsing complete. + + + + + Stream containing functionGroups tag. + + + + + Build version, last edited version, etc.. + + + + + Calculation id. + + + + + Initializes a new instance of the FileDataHolder class. + + Parent workbook for the new instance. + + + + Initializes a new instance of the FileDataHolder class. + + Parent workbook for the new instance. + File name to get initial data from. + Password to use during for decryption. + + + + Parses document. + + Represents theme colors in document. + + + + Finds workbook part name according to content type. + + Content type. + True if item was found; false otherwise. + + + + Gets the Workbook Save Type. + + Workbook Content Type. + + + + Parses content type. + + + + + Parses all document properties. + + + + + Parses archive item by content type. Removes relation for this item and the item itself. + + Content type. + + + + Returns XmlReader for corresponding content type. + + Content type. + Name of the item that has specified content type. + Item name. + + + + Saves document into specified file. + + Name of the file to save into. + Type of the saving format. + + + + Converts image format into content type and file extension. + + Image format to convert. + Resulting file extension. + Content type for this image format. + + + + Parses workbook. + + Represents theme color in workbook. + + + + Parses relations item. + + Path to the item to parse. + Parsed relations collection; null if there are no such relation item. + + + + Tries to find path to the item by content type. + + Content type to locate. + First occurrence of the item with specified content type. + + + + Tries to find path to the item by content type inside default types. + + Content type to locate. + First occurrence of the item with specified content type. + + + + Tries to find path to the item by content type inside overridden types. + + Content type to locate. + First occurrence of the item with specified content type. + + + + Gets relations. + + Item name to get corresponding relation. + Extracted relation + + + + Splits item name (including path) into item name and path to this item. + + Item name to split. + Path without item name. + Item name without path. + + + + Gets image. + + Path of the image. + Extracted image + + + + Creates XmlReader for specified zip archive item. + + Item to create reader for. + Created reader. + + + + Creates XmlReader for specified zip archive item. + + Relation that points to the archive item. + Path to the parent item. + Created reader. + + + + Creates XmlReader for specified zip archive item. + + Relation that points to the archive item. + Path to the parent item. + Path to the desired item. + Created reader. + + + + Returns single zip item based on the relation and parent path. + + Relation that points to the archive item. + Path to the parent item. + Path to the desired item. + Requested zip item. + + + + Parses external link. + + Represents relation id. + + + + Tries to combine two paths into one. + + First part of the path. + Second part of the path. + Combined path. + + + + Saves styles into internal zip archive. + + Dictionary with new XF indexes. + + + + This method removes calculation chain item from the document. + + + + + Saves workbook into specified file. + + Destination file name. + Workbook to save. + Save type. + + + + Creates copy of the current object. + + Parent workbook for the new object. + A copy of the current object. + + + + Creates copy of the workbook's views. + + List with cloned items. + + + + Gets parent workbook. Read-only. + + + + + Gets Excel 2007 parser. + + + + + Returns archive item corresponding to the relation. + + + + + Gets object used for serialization. + + + + + Gets cell styles. + + + + + Gets zip archive object that stores Excel 2007 document. + + + + + Gets Items that must be removed after parsing complete. Read-only. + + + + + This class is responsible for gradient serialization. + + + + + Serializes gradient stops collection into specified XmlWriter. + + XmlWriter to serialize into. + Collection to serialize. + Parent workbook object. + + + + Serializes collection of gradient stops. + + XmlWriter to serialize into. + Collection to serialize. + Parent workbook. + + + + Serializes single GradientStop. + + XmlWriter to serialize into. + GradientStop to serialize. + Parent workbook. + + + + This class stores relation data (except relation id). + + + + + Represents Target. + + + + + Target type. + + + + + Defines whether target is external or not. + + + + + Initializes a new instance of the Relation class. + + Represents target. + Represents destination type. + + + + Initializes a new instance of the Relation class. + + Represents target. + Represents destination type. + Value indicating whether target is external. + + + + Create copy of the current object. + + A copy of the current object. + + + + Gets target. Read-only. + + + + + Gets destination type. Read-only. + + + + + Class used for Relations Collection. + + + + + Relation id start. + + + + + Length of the relation id start. + + + + + Dictionary with relations. Key - relation id, value = relation object. + + + + + Path to the item (this member should be filled when extracting collection from file). + + + + + Initializes a new instance of the RelationsCollection class. + + + + + Removes relation by id. + + Relation id to remove. + + + + Removes relation by content type. + + Content type of relation to delete. + + + + Searches for relation with appropriate content type. + + Content type to find. + Relation id. + Relation that contains desired content type or null if not found. + + + + Generates relation id that can be used as relation key. + + Free relation key. + + + + Generates id and adds relations to there collection. + + Relation to add. + Relation id. + + + + Removes all items from the collection. + + + + + Creates copy of the current collection. + + A copy of the current collection. + + + + Creates copy of the current collection. + + A copy of the current collection. + + + + Returns an enumerator that can iterate through a collection. + + An IEnumerator that can be used to iterate through the collection. + + + + Gets / sets relation by id. + + + + + Gets number of items in the collection. Read-only. + + + + + Gets or sets path to the item (this member should be filled when extracting collection from file). + + + + + This class is responsible for chart shape serialization. + + + + + Format for the default chart item. + + + + + Format for the default chart Ex item. + + + + + Format for the default chart style + + + + + Format for the default chart color style + + + + + This is general interface for classes that are responsible for shape serialization. + + + + + Xml serializator. Serializes XlsIO workbook into MsExcel xml file format. + + + + + Represents xml version. + + + + + Represents application string; + + + + + Represents o namespace. + + + + + Represents x namespace. + + + + + Represents ss namespace. + + + + + Represents html namespace. + + + + + Represents ss pref. + + + + + Represents html pref. + + + + + Represents o pref. + + + + + Represents x pref. + + + + + Represents default pref. + + + + + Represents xmlns pref. + + + + + dummy namespace + + + + + Represents WorkBook pref. + + + + + Represents WorkSheet pref. + + + + + Represents Name pref. + + + + + Represents Table pref. + + + + + Represents Row pref. + + + + + Represents Cell pref. + + + + + Represents Data pref. + + + + + Represents Names pref. + + + + + Represents NamedRange pref. + + + + + Represents Styles pref. + + + + + Represents Style pref. + + + + + Represents Font pref. + + + + + Represents Protection pref. + + + + + Represents Alignment pref. + + + + + Represents NumberFormat pref. + + + + + Represents Interior pref. + + + + + Represents Borders pref. + + + + + Represents Border pref. + + + + + Represents AutoFilter pref. + + + + + Represents AutoFilterColumn pref. + + + + + Represents AutoFilterAnd pref. + + + + + Represents AutoFilterCondition pref. + + + + + Represents AutoFilterOr pref. + + + + + Represents Comment pref. + + + + + Represents B tag. + + + + + Represents B end tag. + + + + + Represents I tag. + + + + + Represents I end tag. + + + + + Represents U tag. + + + + + Represents U end tag. + + + + + Represents S tag. + + + + + Represents S end tag. + + + + + Represents Sub tag. + + + + + Represents Sub end tag. + + + + + Represents Sup tag. + + + + + Represents Sup end tag. + + + + + Represents Font end tag. + + + + + Represents Font tag. + + + + + Represents Span pref. + + + + + Represents Column pref. + + + + + Represents ConditionalFormatting pref. + + + + + Represents Condition pref. + + + + + Represents Qualifier pref. + + + + + Represents Value1 pref. + + + + + Represents Value2 pref. + + + + + Represents worksheet options pref. + + + + + Represents page setup pref. + + + + + Represents footer pref. + + + + + Represents header pref. + + + + + Represents layout pref. + + + + + Represents page margins pref. + + + + + Represents print pref. + + + + + Represents print comments layout pref. + + + + + Represents print errors pref. + + + + + Represents fit to page pref. + + + + + Represents LeftToRight pref. + + + + + Represents active pane pref. + + + + + Represents first visible row pref. + + + + + Represents split horizontal pane pref. + + + + + Represents split vertical pane pref. + + + + + Represents top row bottom pane pref. + + + + + Represents left col right pane pref. + + + + + Represents freeze panes pref. + + + + + Represents freeze no split panes pref. + + + + + Represents panes pref. + + + + + Represents pane pref. + + + + + Represents number pane pref. + + + + + Represents active column pane pref. + + + + + Represents active row pane pref. + + + + + Represents tab color index pref. + + + + + Represents zoom pref. + + + + + Represents Do Not Display Gridlines pref. + + + + + Represents Visible pref. + + + + + Represents don't display headings pref. + + + + + Represents ExcelWorkbook pref. + + + + + Represents Active sheet pref. + + + + + Represents Selected pref. + + + + + Represents selected sheets pref. + + + + + Represents first visible sheet pref. + + + + + Represents DataValidation pref. + + + + + Represents RightToLeft pref. + + + + + Represents Index pref. + + + + + Represents Type pref. + + + + + Represents Ticked pref. + + + + + Represents Formula pref. + + + + + Represents RefersTo pref. + + + + + Represents ID pref. + + + + + Represents Parent pref. + + + + + Represents Bold pref. + + + + + Represents FontName pref. + + + + + Represents Color pref. + + + + + Represents Italic pref. + + + + + Represents Outline pref. + + + + + Represents Shadow pref. + + + + + Represents Size pref. + + + + + Represents StrikeThrough pref. + + + + + Represents Underline pref. + + + + + Represents Protected pref. + + + + + Represents HideFormula pref. + + + + + Represents Horizontal pref. + + + + + Represents Indent pref. + + + + + Represents ReadingOrder pref. + + + + + Represents Rotate pref. + + + + + Represents ShrinkToFit pref. + + + + + Represents Vertical pref. + + + + + Represents VerticalText pref. + + + + + Represents WrapText pref. + + + + + Represents Format pref. + + + + + Represents PatternColor pref. + + + + + Represents Pattern pref. + + + + + Represents Position pref. + + + + + Represents Range pref. + + + + + Represents Operator pref. + + + + + Represents Value pref. + + + + + Represents Author pref. + + + + + Represents ShowAlways pref. + + + + + Represents DefaultColumnWidth pref. + + + + + Represents DefaultRowHeight pref. + + + + + Represents Width pref. + + + + + Represents Hidden pref. + + + + + Represents StyleID pref. + + + + + Represents AutoFitWidth pref. + + + + + Represents AutoFitHeight pref. + + + + + Represents Height pref. + + + + + Represents Face pref. + + + + + Represents line style pref. + + + + + Represents weight pref. + + + + + Represents vertical align pref. + + + + + Represents merge column count pref. + + + + + Represents merge row count pref. + + + + + Represents hyper link tip pref. + + + + + Represents hyper link reference pref. + + + + + Represents margin pref. + + + + + Represents margin top pref. + + + + + Represents margin right pref. + + + + + Represents margin left pref. + + + + + Represents margin bottom pref. + + + + + Represents center horizontal pref. + + + + + Represents center vertical pref. + + + + + Represents orientation pref. + + + + + Represents start page number pref. + + + + + Represents number of copies to print. + + + + + Represents default numbers of copies to print. + + + + + Represents horizontal resolution pref. + + + + + Represents paper size index pref. + + + + + Represents Scale pref. + + + + + Represents fit width pref. + + + + + Represents fit height pref. + + + + + Represents gridlines pref. + + + + + Represents BlackAndWhite pref. + + + + + Represents DraftQuality pref. + + + + + Represents row and column headings pref. + + + + + Represents colon. + + + + + Represents semicolon. + + + + + Represents font color. + + + + + Represents font style. + + + + + Represents font weight style. + + + + + Represents bold font weight. + + + + + Represents regular font weight. + + + + + Represents italic font const. + + + + + Represents line through + + + + + Represents line through + + + + + Represents Single line through + + + + + Represents font underline. + + + + + Represents pattern back color. + + + + + Represents fill pattern. + + + + + Represents border constant. + + + + + Represents border top constant. + + + + + Represents border bottom constant. + + + + + Represents border left constant. + + + + + Represents border right constant. + + + + + Represents Arial font name. + + + + + Represents none style. + + + + + Represents default font size. + + + + + Represents left diagonal border index. + + + + + Represents right diagonal border index. + + + + + Represents zero constant. + + + + + Represents rotation constant. + + + + + Represents default style font size. + + + + + Represents default rotation text. + + + + + Represents default border increment. + + + + + Represents default style name. + + + + + Represents unique prephix. + + + + + Represents style align none. + + + + + Represents style align Subscript. + + + + + Represents style align Superscript. + + + + + Represents default margin. + + + + + Represents default page scale. + + + + + Represents default page fit. + + + + + Represents default zoom. + + + + + Represents xml true string. + + + + + Represents xml false string. + + + + + Represents All autofilter type. + + + + + Represents color string prefix. + + + + + Represents Bottom autofilter type. + + + + + Represents Top autofilter type. + + + + + Represents Percent autofilter type. + + + + + Represents blanks autofilter type. + + + + + Represents Custom autofilter type. + + + + + Represents non blanks autofilter type. + + + + + Represents default column width. + + + + + Represents default row Height. + + + + + Represents default column div. + + + + + Represents default row div. + + + + + Represents data time mask. + + + + + Represents default merged style first index. + + + + + Represents 13/10 chart. + + + + + Represents bad reference. + + + + + Represents bad reference in xml. + + + + + Represents bad formula reference. + + + + + Represents default maximum column index. + + + + + Represents default minimum column index. + + + + + Represents default cod for generate unique style index. + + + + + This class stores worksheet data extracted from document and is responsible + for parsing and serialization of this data into special FileDataHolder. + + + + + Format to get full path to zip archive item that stores vml drawings for worksheet. + + + + + Format got get full path to zip archive item that stores comments description for worksheet. + + + + + Format to get full path to zip archive item that stores drawings for worksheet. + + + + + Relations default extension. + + + + + Archive item that stores worksheet data. + + + + + Objects that stores workbook data. + + + + + This stream stores xml text starting just after "worksheet" tag to + "col" or "sheetData" tag. + + + + + This stream stores xml text with conditional formatting. + + + + + This stream stores xml text with conditional formattings in extended list. + + + + + Relation id in the parent workbook. Null means that item hasn't been serialized + yet and we must generate new id. + + + + + Sheet id. + + + + + Worksheet relations. + + + + + Drawings relations. + + + + + Header/footer drawings relations. + + + + + Relation id for vml drawings. Null means no vml drawings present (or were present). + + + + + Relation id for vml header/footer drawings. Null means no vml drawings present (or were present). + + + + + Relation id for comment notes. Null means no comment note present (or were present). + + + + + Relation id for drawings. Null means no drawings present (or were present). + + + + + Stream with controls data. + + + + + Initializes a new instance of the WorksheetDataHolder class. + + Objects that stores workbook data. + Relation that points at (relative path) necessary worksheet. + Path to the relation parent object (to convert relative + path into absolute). + + + + Initializes new instance of the WorksheetDataHolder class. + + Objects that stores workbook data. + Archive item with sheet data. + + + + Parses worksheet data. + + Worksheet to parse. + + + + This method tries to parse drawings part. + + Parent worksheet. + Relation pointing at drawings xml item.. + Dictionary with archive items to remove after parsing. + + + + Create copy of the current object. + + A copy of the current object. + + + + Gets parent FileDataHolder. Read-only. + + + + + Gets or sets Worksheet's relation id in the workbook. + + + + + Gets or sets sheet id extracted from the file. + + + + + Gets drawings relation collection. Read-only. + + + + + Gets or sets relation id for drawings. Null means no drawings present (or were present). + + + + + + Class used as message sender on Property value change. Class provides old and + new values which allow user to create advanced logic. + + + + + Storage of Old value. + + + + + Storage of new value. + + + + + Name of property or unique identifier of the object + whose value changed. + + + + + Value changed event arguments. + + + + + Default constructor. + + + + + Main constructor. + + Old property value. + New property value. + Unique Identifier of object whose value changed. + + + + Main constructor. + + Old property value. + New property value. + Unique Identifier of object whose value changed. + Next property which must be changed. + + + + New property value. Event handler property has new value set. + Read-only. + + + + + Old property value. Event handler property has new value set. + Read-only. + + + + + + Delegate which can be used for Property Changed events declarations. + + + + + Summary description for _constants. + + + + + This value is used instead of possible minimum row or column index. + + + + + This value is used instead of possible maximum row or column index. + + + + + This value is used instead of maximum used row or column index. + + + + + This value is used instead of minimum used row or column index. + + + + + Size of the Int32 value. + + + + + Size of the Int16 value. + + + + + Size of the Int64 value. + + + + + Number of bits inside single short value. + + + + + Number of bits inside single byte value. + + + + + Size of the Double value in bytes. + + + + + Optimized version of SortedList collection. Instead of keeping two + arrays, one for keys and one for values, the values array on + Hashtable collection are changed. Performance of this collection is better than that of SortedList. + + + + + Default capacity of internal buffers. + + + + + Array which store keys in sorted order. + + + + + Collection stores values. + + + + + Size of collection. + + + + + Version of collection data. + + + + + Default comparer for keys. + + + + + List of keys. + + + + + List of values. + + + + + Default constructor. + + + + + Creates an empty list with the specified initial capacity. + + Initial capacity. + + When initialCapacity is less than zero. + + + + + Creates an empty SortedList with the default initial capacity + and specified comparer. + + + The IComparer is used to determine whether two keys are equal. + + + + + Creates an empty SortedList with the specified initial capacity + and specified comparer. + + Initial capacity. + + The IComparer is used to determine whether two keys are equal. + + + + + Copies the elements from the specified dictionary to a new list + with the same initial capacity as the number of elements copied. + + The IDictionary to copy. + + + + Copies the elements from the specified dictionary to a new list with the same + initial capacity as the number of elements copied and with the specified comparer. + + The IDictionary to copy. + + The IComparer to use to determine whether two keys are equal. + + + When argument d is null. + + + + + Returns a synchronized (thread-safe) wrapper for the SortedList. + + The SortedList to synchronize. + A synchronized (thread-safe) wrapper for the SortedList. + + When list is null. + + + + + Adds an element with the provided key and value to the list. + + The Object to use as the key of the element to add. + The Object to use as the value of the element to add. + + When key is null. + + + When list already contains specified key. + + + + + Removes all elements from the collection. + + + + + Creates a new object that is a copy of the current instance. + + Copy of the current instance. + + + + Clone current instance. + + Returns clone of current object. + + + + Determines whether the list contains an element with the specified key. + + Key of the element to search. + True if list contains specified key. + + + + Determines whether the list contains an element with the specified key. + + Key of the element to search. + True if list contains specified key. + + + + Determines whether the list contains the specified value. + + Value of the element to search. + True if list contains specified value. + + + + Copies all the elements of the SortedListEx to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + If specified array is null. + + + If rank of the array is not 1 or there are not enough elements. + + + If specified arrayIndex is less than zero. + + + + + Gets the value at the specified index of the SortedListEx. + + The zero-based index of the value to get. + The value at the specified index of the SortedListEx. + + When index is less than zero or greater than size of the list. + + + + + Gets the key at the specified index of the SortedListEx. + + The zero-based index of the key to get. + The key at the specified index of the SortedListEx. + + When index is less than zero or greater than size of the list. + + + + + Gets the keys in the SortedListEx. + + An IList containing the keys in the SortedListEx. + + + + Gets the values in the SortedListEx. + + An IList containing the values in the SortedListEx. + + + + Returns the zero-based index of the specified key. + + The key to locate. + The zero-based index of key, if key is found; otherwise, -1. + + If specified key is null. + + + + + Returns the zero-based index of the first occurrence of the specified value. + + The value to locate (can be NULL). + + The zero-based index of the first occurrence of value, if value is found; + otherwise, -1. + + + + + Removes the element at the specified index. + + The zero-based index of the element to remove. + + When index is less than zero or greater than size of the list. + + + + + Removes the element with the specified key from SortedListEx. + + The key of the element to remove. + + + + Replaces the value at the specific index. + + The zero-based index at which to save value. + The Object to save into. Can be NULL. + + When index is less than zero or greater than size of the list. + + + + + Sets the capacity to the actual number of elements. + + + + + Returns an IDictionaryEnumerator that can iterate through the SortedListEx. + + An IDictionaryEnumerator for the SortedListEx. + + + + Returns an IEnumerator that can iterate through the SortedListEx. + + An IEnumerator for the SortedListEx. + + + + Inserts element with specified key and value at specified index. + + The zero-based index to insert element at. + The key of the element to insert. + The value of the element to insert. + + + + Ensures that the capacity of this instance is at least the specified value. + + The minimum capacity to ensure. + + + + Capacity of internal buffers. + + + + + Size of the collection. Read-only. + + + + + List of keys. Read-only. + + + + + List of values. Read-only. + + + + + Returns True if list is readonly, False otherwise. Read-only. + + + + + Returns True if collection has fixed size, False otherwise. + + + + + Returns True if the collection is synchronized, False otherwise. + + + + + Returns the object that can be used to synchronize access to the collection. + Read-only. + + + + + Gets or sets the value associated with the specified key. + + + + + Wrapped SortedListEx. + + + + + Sync object. + + + + + Creates SyncSortedListEx for specified SortedListEx. + + SortedListEx that will be wrapped. + + + + Adds an element with the provided key and value to the list. + + The Object to use as the key of the element to add. + The Object to use as the value of the element to add. + + + + Removes all the elements from the collection. + + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of the current instance. + + + + Determines whether the list contains an element with the specified key. + + Key of the element to search. + True if list contains specified key. + + + + Determines whether the list contains an element with the specified key. + + Key of the element to search. + True if list contains specified key. + + + + Determines whether the list contains the specified value. + + Value of the element to search. + True if list contains specified value. + + + + Copies all the elements of the list to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + + + Gets the value at the specified index of the list. + + The zero-based index of the value to get. + The value at the specified index of the SortedListEx. + + + + Returns an IDictionaryEnumerator that can iterate through the list. + + An IDictionaryEnumerator for the list. + + + + Gets the key at the specified index of the list. + + The zero-based index of the key to get. + The key at the specified index of the list. + + + + Gets the keys in the list. + + An IList containing the keys in the list. + + + + Gets the values in the list. + + An IList containing the values in the list. + + + + Returns the zero-based index of the specified key. + + The key to locate. + The zero-based index of key, if key is found; otherwise, -1. + + + + Returns the zero-based index of the first occurrence of the specified value. + + The value to locate (can be NULL). + + The zero-based index of the first occurrence of value, if value is found; + otherwise, -1. + + + + + Removes the element at the specified index. + + The zero-based index of the element to remove. + + + + Removes the element with the specified key from list. + + The key of the element to remove. + + + + Replaces the value at a specific index. + + The zero-based index at which to save value. + The Object to save into. Can be NULL. + + + + Sets the capacity to the actual number of elements. + + + + + Capacity of internal buffers. + + + + + Size of the collection. Read-only. + + + + + Returns the object that can be used to synchronize access to the collection. + Read-only. + + + + + Returns True if list is readonly, False otherwise. Read-only. + + + + + Returns True if collection has fixed size, False otherwise. + + + + + Returns True if the collection is synchronized, False otherwise. + + + + + Gets or sets the value associated with the specified key. + + + + + If it is assumed to getObjectRetType, Current will return key + of the current element. + + + + + If it is assumed to getObjectRetType, Current will return value + of the current element. + + + + + If it is assumed to getObjectRetType, Current will return both - + key and value (as DictionaryEntry). + + + + + List for which is this enumerator. + + + + + Key of the current element. + + + + + Values of the current element. + + + + + Index of current element. + + + + + Starting index for the enumerator. + + + + + Ending index for this enumerator. + + + + + Version of collection data. + + + + + True if current element is correct, False otherwise + (before beginning or after end). + + + + + Specifies what should return method Current (Key, Value or both). + + + + + Creates enumerator for specified list, starting from specified index + and with specified count. + + list for which to create enumerator. + Starting index. + Number of elements to enumerate. + Type of enumerating values (keys, value, DicEntry). + + + + Creates a new object that is a copy of the current instance. + + Copy of the current instance. + + + + Advances the enumerator to the next element of the collection. + + + True if the enumerator was successfully advanced to the next element; + False if the enumerator has passed the end of the collection. + + + When the current version is not equal to the SortedListEx version. + + + + + Sets the enumerator to its initial position, which is before + the first element in the collection. + + + When the current version is not equal to the SortedListEx version. + + + + + Returns key of the current element. Read-only. + + + When the current version is not equal to the SortedListEx version + or if current is false. + + + + + Return DictionaryEntry for the current element. + + + When the current version is not equal to the SortedListEx version + or if current is false. + + + + + The current element in the collection. Read-only. + + + If current is false. + + + + + Returns value for the current element. + + + When the current version is not equal to the SortedListEx version + or if current is false. + + + + + List for which this collection was created. + + + + + Creates KeyList for specified SortedListEx. + + SortedListEx for which KeyList must be created. + + + + Adds an element with the provided key to the list. + + The Object to use as the key of the element to add. + + + + Removes all elements from the collection. + + + + + Determines whether the list contains an element with the specified key. + + Key of the element to search. + True if list contains specified key. + + + + Copies all the elements of the list to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + If array is null or rank of the array is not 1. + + + + + Insert the value at the specific index. + + The zero-based index at which to save value. + The Object to save into. Can be NULL. + + + + Returns an IEnumerator that can iterate through the list. + + An IEnumerator for the list. + + + + Returns the zero-based index of the specified key. + + The key to locate. + The zero-based index of the key, if the key is found; otherwise, -1. + + + + Removes the element with the specified key from list. + + The key of the element to remove. + + + + Removes the element at the specified index from the list. + + The zero-based index of the element to remove. + + + + Size of the collection. Read-only. + + + + + Returns True if list is readonly, False otherwise. Read-only. + + + + + Returns True if collection has fixed size, False otherwise. + + + + + Returns True if the collection is synchronized, False otherwise. + + + + + Returns the object that can be used to synchronize access to the collection. + Read-only. + + + + + Gets or sets the key at the specified index. + + + + + List for which this collection was created. + + + + + Array list that contain values. + + + + + Creates ValueList for specified SortedListEx. + + SortedListEx for which ValueList must be created. + + + + Re-read values from the list. + + + + + Adds an element with the provided key to the list. + + The Object to use as the key of the element to add. + + + + Removes all elements from the collection. + + + + + Determines whether the list contains an element with the specified value. + + Value to search. + True if list contains specified value. + + + + Copies all the elements of the list to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + + + Insert the value at the specific index. + + The zero-based index at which to save value. + The Object to save into. Can be NULL. + + + + Returns an IEnumerator that can iterate through the list. + + An IEnumerator for the list. + + + + Returns the zero-based index of the specified value. + + The value to locate. + The zero-based index of the value, if the value is found, otherwise -1. + + + + Removes the specified value from list. + + The value to remove. + + + + Removes the element at the specified index from the list. + + The zero-based index of the element to remove. + + + + Size of the collection. Read-only. + + + + + Returns True if list is readonly, False otherwise. Read-only. + + + + + Returns True if collection has fixed size, False otherwise. + + + + + Returns True if the collection is synchronized, False otherwise. + + + + + Returns the object that can be used to synchronize access to the collection. + Read-only. + + + + + Gets or sets the value at the specified index. + + + + + Comparer for strings. + + + + + Compare two strings. + + String to compare. + String to compare. + Returns compared results. + + + + Dictionary is used for grouping strings used by Excel in order to prevent + doubling of data. Dictionary stores information as key string and value. + + + + + Default reserved space by internal collections. + + + + + Index of the empty string. + + + + + Default count of empty strings. + Returned by GetStringsCount method. + Arbitrary number but should be larger than 1. + + + + + Maximum allowed cell length. + + + + + Dictionary key-to-index in the array. + + + + + Strings data. + + + + + Array that contains indexes that are free (strings that were removed). + + + + + Parent workbook. + + + + + Original SSTRecord. + + + + + Indicates whether original SSTRecord was parsed. + + + + + Temporary string. + + + + + Number of references to each string. + + + + + Indicates whether we should use hashtable to increase search speed. + + + + + Default constructor. Reserves space for strings. + + + + + Returns SST content. + + Index of the target string. + SST content object. + + + + Clears the list. + + + + + Searches for all strings with specified text. + + String to search. + Dictionary, key - string index, value - null. + + + + Adds string into dictionary. If the string exists in dictionary, + add reference count. Method can influence on SST Indexes. + + Index to the string. + + + + Adds string into dictionary. If the string exists in dictionary, + add reference count. Method can influence on SST Indexes. + + String to add + Index of the added string. + + + + Adds string into dictionary. If the string exists in dictionary, + add reference count. Method can influence on SST Indexes. + + String to add + Reference count for new entries. + Index of the added string. + + + + Checks whether new string value is within allowed limits. + + + + + + Remove reference of string. When reference count reaches zero, string will be + removed from dictionary. Method can influence the SST indexes. + + String index to remove. + + + + Returns number of strings in the dictionary. + + Index of the target string. + + + + Creates copy of the current instance. + + Copy of the current instance. + + + + Updates internal array that stores reference count. + + + + + This methods looks through all row storages to find out used strings. + And removes all unnecessary strings after that. + + + + + Moves strings. + + Start index. + End index. + Decrease index. + List with new strings indexes. + + + + Removes all unused strings from inner collections. + + + + + Sets number of references to the string. + + String index. + References count to set. + + + + Gets number of references to the string. + + String index. + number of references to the string. + + + + Fills internal hash used for string searching. + + + + + Here we have to parse our SST record + + + + + Updates LabelSST indexes after SST record parsing. + + Dictionary with indexes to update, key - old index, value - new index. + + + + Returns LabelSST used. + + + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + + + + + + Gets text with format. + + + + + Gets quantity of unique strings. + + + + + Returns parent workbook. Read-only. + + + + + Gets / sets original SSTRecord. + + + + + + + + + + Contains types that are used to create�and manipulate charts. + + + + + + Represents chart plot area interface. + + + + + Represents the chart to image convertertion. + + + + + Converts the chart to image and saves the image to the specified stream. + + Represents the chart object to convert. + The stream to save the image + + + + Gets or sets a type that represents quality of the converted image. + + + + //Open a PowerPoint presentation file + IPresentation presentation = Presentation.Open("Template.pptx"); + //Create an instance of ChartToImageConverter + presentation.ChartToImageConverter = new ChartToImageConverter(); + //Set the scaling mode as best + presentation.ChartToImageConverter.ScalingMode = Syncfusion.OfficeChart.ScalingMode.Best; + //Convert the first slide into image + System.Drawing.Image image = presentation.Slides[0].ConvertToImage(Syncfusion.Drawing.ImageType.Metafile); + //Save the image as file + image.Save("slide1.png"); + //close the presentation instance + presentation.Close(); + + + 'Open a PowerPoint presentation file + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Create an instance of ChartToImageConverter + presentation__1.ChartToImageConverter = New ChartToImageConverter() + 'Set the scaling mode as best + presentation__1.ChartToImageConverter.ScalingMode = Syncfusion.OfficeChart.ScalingMode.Best + 'Convert the first slide into image + Dim image As System.Drawing.Image = presentation__1.Slides(0).ConvertToImage(Syncfusion.Drawing.ImageType.Metafile) + 'Save the image as file + image.Save("slide1.png") + 'close the presentation instance + presentation__1.Close() + + + + + + Summary description for IWorksheetCustomProperties. + + + + + Determines whether collection contains property with a specific name. + + The name of the property to locate. + True if collection contains required element. + + + + Enumeration of the sheet types in Excel. + + + + + Charts. + + + + + Dialogs. + + + + + Excel 4.0 International Macros. + + + + + Excel 4.0 Macros. + + + + + Worksheets. + + + + + Enumeration of the border line styles for cells in Excel. + + + + + Represents no border line style. + + + + + Represents the thin border line style. + + + + + Represents the medium border line style. + + + + + Represents the dashed border line style. + + + + + Represents the dotted border line style. + + + + + Represents the thick border line style. + + + + + Represents the double border line style. + + + + + Represents the hair border line style. + + + + + Represents the medium_dashed medium_dashed line style. + + + + + Represents the dash_dot border line style. + + + + + Represents the medium dash_dot border line style. + + + + + Represents the dash_dot_dot border line style. + + + + + Represents the medium dash_dot_dot border line style. + + + + + Represents the medium slanted_dash_dot border line style. + + + + + Enumeration of the border and diagonal line types in Excel. + + + + + Represents the diagonal line from top left to right bottom. + + + + + Represents the diagonal line from bottom left to right top. + + + + + Represents the border line on the bottom. + + + + + Represents the border line on the left. + + + + + Represents the border line on the right. + + + + + Represents the border line on the top. + + + + + Enum that defines different types of the formula calculations. + + + + + Represents the MANUAL calculation type. + + + + + Represents the AUTOMATIC calculation type. + + + + + Represents the AUTOMATIC EXCEPT TABLES calculation type. + + + + + Enumeration of the horizontal alignment options for cell formatting in Excel. + + + + + Represents the general horizontal alignment setting. + + + + + Represents left horizontal alignment setting. + + + + + Represents center horizontal alignment setting. + + + + + Represents center horizontal alignment setting. + + + + + Represents fill horizontal alignment setting. + + + + + Represents justify horizontal alignment setting. + + + + + Represents center across selection horizontal alignment setting. + + + + + Represents distributed horizontal alignment setting. + + + + + Enumeration of the vertical alignment options for cell formatting in Excel. + + + + + Represents top vertical alignment setting. + + + + + Represents center vertical alignment setting. + + + + + Represents bottom vertical alignment setting. + + + + + Represents justify vertical alignment setting. + + + + + Represents distributed vertical alignment setting. + + + + + Specifies whether a print device prints multi-page documents from front-to-back or back-to-front. + + + + + Indicates Down, then over setting. + + + + + Indicates Over, then down setting. + + + + + Specifies how pages of content are oriented on print media. + + + + + Indicates content of the imageable area is rotated on the page 90 degrees counterclockwise from standard (portrait) orientation. + + + + + Indicates standard orientation. + + + + + Specifies the paper size in the PaperSize property. + + + + + Indicates 10- by 14-inch sheet. + + + + + Indicates 11- by 17-inch sheet. + + + + + Indicates A3 sheet, 297- by 420-millimeters. + + + + + Indicates A4 sheet, 210- by 297-millimeters. + + + + + Indicates A4 small sheet, 210- by 297-millimeters. + + + + + Indicates A5 sheet, 148- by 210-millimeters. + + + + + Indicates B4 sheet, 250- by 354-millimeters. + + + + + Indicates B5 sheet, 182- by 257-millimeter paper. + + + + + Indicates C Sheet, 17- by 22-inches. + + + + + Indicates D Sheet, 22- by 34-inches. + + + + + Indicates #10 Envelope, 4 1/8- by 9 1/2-inches. + + + + + Indicates #11 Envelope, 4 1/2- by 10 3/8-inches. + + + + + Indicates #12 Envelope, 4 3/4- by 11-inches. + + + + + Indicates #14 Envelope, 5- by 11 1/2-inches. + + + + + Indicates #9 Envelope, 3 7/8- by 8 7/8-inches. + + + + + Indicates B4 Envelope, 250- by 353-millimeters. + + + + + Indicates B5 Envelope, 176- by 250-millimeters. + + + + + Indicates B6 Envelope, 176- by 125-millimeters. + + + + + Indicates C3 Envelope, 324- by 458-millimeters. + + + + + Indicates C4 Envelope, 229- by 324-millimeters. + + + + + Indicates C5 Envelope, 162- by 229-millimeters. + + + + + Indicates C6 Envelope, 114- by 162-millimeters. + + + + + Indicates C65 Envelope, 114- by 229-millimeters. + + + + + Indicates DL Envelope, 110- by 220-millimeters. + + + + + Indicates Italy Envelope, 110- by 230-millimeters. + + + + + Indicates Monarch Envelope, 3 7/8- by 7 1/2-inches. + + + + + Indicates 6 3/4 Envelope, 3 5/8- by 6 1/2-inches. + + + + + Indicates E Sheet, 34- by 44-inches. + + + + + Indicates Executive, 7 1/4- by 10 1/2-inches. + + + + + Indicates German Legal Fanfold, 8 - by 13-inches. + + + + + Indicates German Std Fanfold, 8 1/2- by 12-inches. + + + + + Indicates US Std Fanfold, 14 7/8- by 11-inches. + + + + + Indicates Folio, 8 1/2- by 13-inch paper. + + + + + Indicates Ledger, 17- by 11-inches. + + + + + Indicates Legal, 8 1/2- by 14-inches. + + + + + Indicates Letter, 8 1/2- by 11-inches. + + + + + Indicates Letter Small, 8 1/2- by 11-inches. + + + + + Indicates Note, 8 1/2- by 11-inches. + + + + + Indicates Quarto, 215- by 275-millimeter paper. + + + + + Indicates Statement, 5 1/2- by 8 1/2-inches. + + + + + Indicates Tabloid, 11- by 17-inches. + + + + + Indicates User paper size. + + + + + Indicates ISO B4 paper size(250 mm by 353 mm). + + + + + Indicates Japanese double postcard(200 mm by 148 mm). + + + + + Indicates Standard paper(9 in. by 11 in.). + + + + + Indicates Standard paper(10 in. by 11 in.). + + + + + Indicates Standard paper(15 in. by 11 in.). + + + + + Indicates Invite envelope (220 mm by 220 mm). + + + + + Indicates Letter extra paper (9.275 in. by 12 in.). + + + + + Indicates Legal extra paper (9.275 in. by 15 in.). + + + + + Indicates Tabloid extra paper (11.69 in. by 18 in.). + + + + + Indicates A4 extra paper (236 mm by 322 mm). + + + + + Indicates Letter transverse paper (8.275 in. by 11 in.). + + + + + Indicates A4 transverse paper (210 mm by 297 mm). + + + + + Indicates Letter extra transverse paper (9.275 in. by 12 in.). + + + + + Indicates SuperA/SuperA/A4 paper (227 mm by 356 mm). + + + + + Indicates SuperB/SuperB/A3 paper (305 mm by 487 mm). + + + + + Indicates Letter plus paper (8.5 in. by 12.69 in.). + + + + + Indicates A4 plus paper (210 mm by 330 mm). + + + + + Indicates A5 transverse paper (148 mm by 210 mm). + + + + + Indicates JIS B5 transverse paper (182 mm by 257 mm). + + + + + Indicates A3 extra paper (322 mm by 445 mm). + + + + + Indicates A5 extra paper (174 mm by 235 mm). + + + + + Indicates ISO B5 extra paper (201 mm by 276 mm). + + + + + Indicates A2 paper (420 mm by 594 mm). + + + + + Indicates A3 transverse paper (297 mm by 420 mm). + + + + + Indicates A3 extra transverse paper (322 mm by 445 mm). + + + + + Specifies the print comments. + + + + + Indicates the print as displayed on sheet setting. + + + + + Indicates no comments in print location. + + + + + Represents the end of the sheet of print location. + + + + + Specifies replacing error Values when printing. + + + + + Indicates the blank option. + + + + + Indicates the dash (--) option. + + + + + Indicates the displayed option. + + + + + Indicates the #N/A option. + + + + + Enumeration of page break types in Excel. + + + + + Represents the Automatic option. + + + + + Represents the Manual option. + + + + + Represents the None option. + + + + + Specifies the type of underline applied to a font. + + + + + Indicates No underlining. + + + + + Indicates Single underlining. + + + + + Indicates Double thick underline. + + + + + Indicates SingleAccounting underline. + + + + + Indicates Two thin underlines placed close together. + + + + + Indicates dashed underline + + + + + Indicates heavy dot dot dashed underline + + + + + Indicates heavy dot dashed underline + + + + + Indicates heavy dashed underline + + + + + Indicates long dashed underline + + + + + Indicates heavy long dashed underline + + + + + Indicates dot dashed underline + + + + + Indicates dot dot dashed underline + + + + + Indicates dotted underline + + + + + Indicates heavy dotted underline + + + + + Indicates heavy underline + + + + + Indicates wavy underline + + + + + Indicates double wavy underline + + + + + Indicates heavy wavy underline + + + + + Indicates words underline + + + + + Enumeration of merge operation types in Excel. + + + + + Represents the Leave option. + + + + + Represents the Delete option. + + + + + Enumeration of Worksheet functions in Excel. + + + + + Represents the NONE function. + + + + + Represents the Custom function. + + + + + Represents the ABS function. + + + + + Represents the ACOS function. + + + + + Represents the ACOSH function. + + + + + Represents the ADDRESS function. + + + + + Represents the AND operation. + + + + + Represents the Areas function. + + + + + Represents the ASIN function. + + + + + Represents the ASINH function. + + + + + Represents the ATAN function. + + + + + Represents the ATAN2 function. + + + + + Represents the ATANH function. + + + + + Represents the AVEDEV function. + + + + + Represents the AVERAGE function. + + + + + Represents the AVERAGEA function. + + + + + Represents the HEX2BIN function. + + + + + Represents the HEX2DEC function. + + + + + Represents the HEX2OCT function. + + + + + Represents the COUNTIF function. + + + + + Represents the BIN2DEC function. + + + + + Represents the BIN2HEX function. + + + + + Represents the BIN2OCT function. + + + + + Represents the DEC2BIN function. + + + + + Represents the DEC2HEX function. + + + + + Represents the DEC2OCT function. + + + + + Represents the OCT2BIN function. + + + + + Represents the OCT2DEC function. + + + + + Represents the OCT2HEX function. + + + + + Represents the ODDFPRICE function. + + + + + Represents the ODDFYEILD function. + + + + + Represents the ODDLPRICE function. + + + + + Represents the ODDLYEILD function. + + + + + Represents the ISODD function. + + + + + Represents the ISEVEN function. + + + + + Represents the LCM function. + + + + + Represents the GCD function. + + + + + Represents the SUMIFS function. + + + + + Represents the AVERAGEIF function. + + + + + Represents the AVERAGEIFS function. + + + + + Represents the CONVERT function. + + + + + Represents the COMPLEX function. + + + + + Represents the COUPDAYBS function. + + + + + Represents the COUPDAYS function. + + + + + Represents the COUPDAYSNC function. + + + + + Represents the COUPNCD function. + + + + + Represents the COUPNUM function. + + + + + Represents the COUPPCD function. + + + + + Represents the DELTA function. + + + + + Represents the DISC function. + + + + + Represents the DOLLARDE function. + + + + + Represents the DOLLARFR function. + + + + + Represents the DURATION function. + + + + + Represents the EDATE function. + + + + + Represents the EFFECT function. + + + + + Represents the EOMONTH function. + + + + + Represents the ERF function. + + + + + Represents the ERFC function. + + + + + Represents the FACTDOUBLE function. + + + + + Represents teh GESTEP function. + + + + + Represents the IFERROR function. + + + + + Represents the IMABS function + + + + + Represents the IMAGINARY function. + + + + + Represents the IMARGUMENT function. + + + + + Represents the IMCONJUGATE function. + + + + + Represents the IMCOS function. + + + + + Represents the IMEXP function. + + + + + Represents the IMLN function. + + + + + Represents the IMLOG10 function. + + + + + Represents the IMLOG2 function. + + + + + Represents the IMREAL function. + + + + + Represents the IMSIN function. + + + + + Represents the IMSQRT function. + + + + + Represents the IMSUB function. + + + + + Represents the IMSUM function. + + + + + Represents the IMDIV function. + + + + + Represents the IMPOWER function. + + + + + Represents the IMPRODUCT function. + + + + + Represents the ACCRINT function. + + + + + Represents the ACCRINTM function. + + + + + Represents the AGGREGATE function. + + + + + Represents the AMORDEGRC function. + + + + + Represents the AMORLINC function. + + + + + Represents the BAHTTEXT function. + + + + + Represents the BESSELI function. + + + + + Represents the BESSELJ function. + + + + + Represents the BESSELK function. + + + + + Represents the BESSELY function. + + + + + Represents the CUBEKPIMEMBER function. + + + + + Represents the CUBEMEMBER function. + + + + + Represents the CUBERANKEDMEMBER function. + + + + + Represents the CUBESET function. + + + + + Represents the CUBESETCOUNT function. + + + + + Represents the CUBEMEMBERPROPERTY function. + + + + + Represents the CUMIPMT function. + + + + + Represents the CUMPRINC function. + + + + + Represents the FVSCHEDULE function. + + + + + Represents the INTRATE function. + + + + + Represents the LINTEST function. + + + + + Represents the CUBEVALUE function. + + + + + Represents the MDURATION function. + + + + + Represents the MROUND function. + + + + + Represents the MULTINOMIAL function. + + + + + Represents the NETWORKDAYS function. + + + + + Represents the NOMINAL function. + + + + + Represents the PRICE function. + + + + + Represents the PRICEDISC function. + + + + + Represents the PRICEMAT function. + + + + + Represents the QUOTIENT function. + + + + + Represents the RANDBETWEEN function. + + + + + Represents the RECEIVED function. + + + + + Represents the SERIESSUM function. + + + + + Represents the SQRTPI function. + + + + + Represents the TBILLEQ function. + + + + + Represents the TBILLPRICE function. + + + + + Represents the TBILLYIELD function. + + + + + Represents the WEEKNUM function. + + + + + Represents the WORKDAY function. + + + + + Represents the XIRR function. + + + + + Represents the XNPV function. + + + + + Represents the YEAR function. + + + + + Represents the YIELD function. + + + + + Represents the YIELDDISC function. + + + + + Represents the YIELDMAT function. + + + + + Represents the WORKDAY.INTL function. + + + + + Represents the BETA.INV function. + + + + + Represents the BINOM.DIST function. + + + + + Represents the BINOM.INV function. + + + + + Represents the CEILING.PRECISE function. + + + + + Represents the CHISQ.DIST function. + + + + + Represents the CHISQ.DIST.RT function. + + + + + Represents the CHISQ.INV function. + + + + + Represents the CHISQ.INV.RT function. + + + + + Represents the CHISQ.TEST function. + + + + + Represents the CONFIDENCE.NORM function. + + + + + Represents the CONFIDENCE.T function. + + + + + Represents the COVARIANCE.P function. + + + + + Represents the COVARIANCE.S function. + + + + + Represents the ERF.PRECISE function. + + + + + Represents the ERFC.PRECISE function. + + + + + Represents the F.DIST function. + + + + + Represents the F.DIST.RT function. + + + + + Represents the F.INV function. + + + + + Represents the F.INV.RT function. + + + + + Represents the F.TEST function. + + + + + Represents the FLOOR.PRECISE function. + + + + + Represents the GAMMA.DIST function. + + + + + Represents the GAMMA.INV function. + + + + + Represents the GAMMALN.PRECISE function. + + + + + Represents the HYPGEOM.DIST function. + + + + + Represents the LOGNORM.DIST function. + + + + + Represents the LOGNORM.INV function. + + + + + Represents the MODE.MULT function. + + + + + Represents the MODE.SNGL function. + + + + + Represents the NEGBINOM.DIST function. + + + + + Represents the NETWORKDAYS.INTL function. + + + + + Represents the NORM.DIST function. + + + + + Represents the NORM.INV function. + + + + + Represents the NORM.S.DIST function. + + + + + Represents the PERCENTILE.EXC function. + + + + + Represents the PERCENTILE.INC function. + + + + + Represents the PERCENTRANK.EXC function. + + + + + Represents the PRECENTRANK.INC function. + + + + + Represents the POISSON.DIST function. + + + + + Represents the QUARTILE.EXC function. + + + + + Represents the QUARTILE.INC function. + + + + + Represents the RANK.AVG function. + + + + + Represents the RANK.EQ function. + + + + + Represents the STDEV.P function. + + + + + Represents the STDEV.S function. + + + + + Represents the T.DIST function. + + + + + Represents the T.DIST.2T function. + + + + + Represents the T.DIST.RT function. + + + + + Represents the T.INV function. + + + + + Represents the T.INV.2T function. + + + + + Represents the T.TEST function. + + + + + Represents the VAR.P function. + + + + + Represents the VAR.S function. + + + + + Represents the WEIBULL.DIST function. + + + + + Represents the WORKDAY.INTL function. + + + + + Represents the Z.TEST function. + + + + + Represents the BETA.DIST function. + + + + + Represents the EUROCONVERT function. + + + + + Represents the PHONETIC function. + + + + + Represents the REGISTER.ID function. + + + + + Represents the SQL.REQUEST function. + + + + + Represents the JIS function. + + + + + Represents the EXPON.DIST function. + + + + + Represents the DAYS function. + + + + + Represents the ISOWEEKNUM function. + + + + + Represents the BITAND function. + + + + + Represents the BITLSHIFT function. + + + + + Represents the BITOR function. + + + + + + Represents the BITXOR function. + + + + + Represents the IMCOSH function. + + + + + Represents the IMCOT function. + + + + + Represents the IMCSC function. + + + + + Represents the IMCSCH function. + + + + + Represents the IMSEC function. + + + + + Represents the IMSECH function. + + + + + Represents the IMSINH function. + + + + + Represents the IMTAN function. + + + + + Represents the PDURATION function. + + + + + Represents the RRI function. + + + + + Represents the ISFORMULA function. + + + + + Represents the SHEET function. + + + + + Represents the SHEETS function. + + + + + Represents the IFNA function. + + + + + Represents the XOR function. + + + + + Represents the FORMULATEXT function. + + + + + Represents the ACOT function. + + + + + Represents the ACOTH function. + + + + + Represents the ARABIC function. + + + + + Represents the BASE function. + + + + + Represents the CEILING.MATH function. + + + + + Represents the COMBINA function. + + + + + Represents the COT function. + + + + + Represents the COTH function. + + + + + Represents the CSC function. + + + + + Represents the CSCH function. + + + + + Represents the DECIMAL function. + + + + + Represents the FLOOR.MATH function. + + + + + Represents the ISO.CEILING function. + + + + + Represents the MUNIT function. + + + + + Represents the SEC function. + + + + + Represents the SECH function. + + + + + Represents the BINOM.DIST.RANGE function. + + + + + Represents the GAMMA function. + + + + + Represents the GAUSS function. + + + + + Represents the PERMUTATIONA function. + + + + + Represents the PHI function. + + + + + Represents the SKEW.P function. + + + + + Represents the NUMBERVALUE function. + + + + + Represents the UNICHAR function. + + + + + Represents the UNICODE function. + + + + + Represents the ENCODEURL function. + + + + + Represents the FILTERXML function. + + + + + Represents the WEBSERVICE function. + + + + + Represents the BETADIST function. + + + + + Represents the BETAINV function. + + + + + Represents the BINOMDIST function. + + + + + Represents the CEILING function. + + + + + Represents the CELL function. + + + + + Represents the CHAR function. + + + + + Represents the CHIDIST function. + + + + + Represents the CHIINV function. + + + + + Represents the CHITEST function. + + + + + Represents the CHOOSE function. + + + + + Represents the CLEAN function. + + + + + Represents the CODE function. + + + + + Represents the COLUMN function. + + + + + Represents the COLUMNS function. + + + + + Represents the COMBIN function. + + + + + Represents the CONCATENATE function. + + + + + Represents the CONFIDENCE function. + + + + + Represents the CORREL function. + + + + + Represents the COS function. + + + + + Represents the COSH function. + + + + + Represents the COUNT function. + + + + + Represents the COUNTA function. + + + + + Represents the COUNTBLANK function. + + + + + Represents the COUNTIF function. + + + + + Represents the COVAR function. + + + + + Represents the CRITBINOM function. + + + + + Represents the DATE function. + + + + + Represents the DATEVALUE function. + + + + + Represents the DAVERAGE function. + + + + + Represents the DAY function. + + + + + Represents the DAYS360 function. + + + + + Represents the DB function. + + + + + Represents the DCOUNT function. + + + + + Represents the DCOUNTA function. + + + + + Represents the DDB function. + + + + + Represents the DEGREES function. + + + + + Represents the DEVSQ function. + + + + + Represents the DMAX function. + + + + + Represents the DMIN function. + + + + + Represents the DOLLAR function. + + + + + Represents the DPRODUCT function. + + + + + Represents the DSTDEV function. + + + + + Represents the DSTDEVP function. + + + + + Represents the DSUM function. + + + + + Represents the DVAR function. + + + + + Represents the DVARP function. + + + + + Represents the ERROR function. + + + + + Represents the ERRORTYPE function. + + + + + Represents the EVEN function. + + + + + Represents the EXACT function. + + + + + Represents the EXP function. + + + + + Represents the EXPONDIST function. + + + + + Represents the FACT function. + + + + + Represents the FALSE function. + + + + + Represents the FDIST function. + + + + + Represents the FIND function. + + + + + Represents the FINDB function. + + + + + Represents the FINV function. + + + + + Represents the FISHER function. + + + + + Represents the FISHERINV function. + + + + + Represents the FIXED function. + + + + + Represents the FLOOR function. + + + + + Represents the FORECAST function. + + + + + Represents the FREQUENCY function. + + + + + Represents the FTEST function. + + + + + Represents the FV function. + + + + + Represents the GAMMADIST function. + + + + + Represents the GAMMAINV function. + + + + + Represents the GAMMALN function. + + + + + Represents the GEOMEAN function. + + + + + Represents the GETPIVOTDATA function. + + + + + Represents the GROWTH function. + + + + + Represents the HARMEAN function. + + + + + Represents the HLOOKUP function. + + + + + Represents the HOUR function. + + + + + Represents the HYPERLINK function. + + + + + Represents the HYPGEOMDIST function. + + + + + Represents the IF function. + + + + + Represents the INDEX function. + + + + + Represents the INDIRECT function. + + + + + Represents the INFO function. + + + + + Represents the INT function. + + + + + Represents the INTERCEPT function. + + + + + Represents the IPMT function. + + + + + Represents the IRR function. + + + + + Represents the ISBLANK function. + + + + + Represents the ISERR function. + + + + + Represents the ISERROR function. + + + + + Represents the ISLOGICAL function. + + + + + Represents the ISNA function. + + + + + Represents the ISNONTEXT function. + + + + + Represents the ISNUMBER function. + + + + + Represents the ISPMT function. + + + + + Represents the ISREF function. + + + + + Represents the ISTEXT function. + + + + + Represents the KURT function. + + + + + Represents the LARGE function. + + + + + Represents the LEFT function. + + + + + Represents the LEFTB function. + + + + + Represents the LEN function. + + + + + LENB function. + + + + + Represents the LINEST function. + + + + + Represents the LN function. + + + + + Represents the LOG function. + + + + + Represents the LOG10 function. + + + + + Represents the LOGEST function. + + + + + Represents the LOGINV function. + + + + + Represents the LOGNORMDIST function. + + + + + Represents the LOOKUP function. + + + + + Represents the LOWER function. + + + + + Represents the MATCH function. + + + + + Represents the MAX function. + + + + + Represents the MAXA function. + + + + + Represents the MDETERM function. + + + + + Represents the MEDIAN function. + + + + + Represents the MID function. + + + + + Represents the MIDB function. + + + + + Represents the MIN function. + + + + + Represents the MINA function. + + + + + Represents the MINUTE function. + + + + + Represents the MINVERSE function. + + + + + Represents the MIRR function. + + + + + Represents the MMULT function. + + + + + Represents the MOD function. + + + + + Represents the MODE function. + + + + + Represents the MONTH function. + + + + + Represents the N function. + + + + + Represents the NA function. + + + + + Represents the NEGBINOMDIST function. + + + + + Represents the NORMDIST function. + + + + + Represents the NORMINV function. + + + + + Represents the NORMSDIST function. + + + + + Represents the NORMSINV function. + + + + + Represents the NOT function. + + + + + Represents the NOW function. + + + + + Represents the NPER function. + + + + + Represents the NPV function. + + + + + Represents the ODD function. + + + + + Represents the OFFSET function. + + + + + Represents the OR function. + + + + + Represents the PEARSON function. + + + + + Represents the PERCENTILE function. + + + + + Represents the PERCENTRANK function. + + + + + Represents the PERMUT function. + + + + + Represents the PI function. + + + + + Represents the PMT function. + + + + + Represents the POISSON function. + + + + + Represents the POWER function. + + + + + Represents the PPMT function. + + + + + Represents the PROB function. + + + + + Represents the PRODUCT function. + + + + + Represents the PROPER function. + + + + + Represents the PV function. + + + + + Represents the QUARTILE function. + + + + + Represents the RADIANS function. + + + + + Represents the RAND function. + + + + + Represents the RANK function. + + + + + Represents the RATE function. + + + + + Represents the REPLACE function. + + + + + Represents the REPLACEB function. + + + + + Represents the RIGHT function. + + + + + Represents the RIGHTB function. + + + + + Represents the ROMAN function. + + + + + Represents the ROUND function. + + + + + Represents the ROUNDDOWN function. + + + + + Represents the ROUNDUP function. + + + + + Represents the ROW function. + + + + + Represents the ROWS function. + + + + + Represents the RSQ function. + + + + + Represents the SEARCH function. + + + + + Represents the SEARCHB function. + + + + + Represents the SECOND function. + + + + + Represents the SIGN function. + + + + + Represents the SIN function. + + + + + Represents the SINH function. + + + + + Represents the SKEW function. + + + + + Represents the SLN function. + + + + + Represents the SLOPE function. + + + + + Represents the SMALL function. + + + + + Represents the SQRT function. + + + + + Represents the STANDARDIZE function. + + + + + Represents the STDEV function. + + + + + Represents the STDEVA function. + + + + + Represents the STDEVP function. + + + + + Represents the STDEVPA function. + + + + + Represents the STEYX function. + + + + + Represents the SUBSTITUTE function. + + + + + Represents the SUBTOTAL function. + + + + + Represents the SUM function. + + + + + Represents the SUMIF function. + + + + + Represents the SUMPRODUCT function. + + + + + Represents the SUMSQ function. + + + + + Represents the SUMX2MY2 function. + + + + + Represents the SUMX2PY2 function. + + + + + Represents the SUMXMY2 function. + + + + + Represents the SYD function. + + + + + Represents the T function. + + + + + Represents the TAN function. + + + + + Represents the TANH function. + + + + + Represents the TDIST function. + + + + + Represents the TEXT function. + + + + + Represents the TIME function. + + + + + Represents the TIMEVALUE function. + + + + + Represents the TINV function. + + + + + Represents the TODAY function. + + + + + Represents the TRANSPOSE function. + + + + + Represents the TREND function. + + + + + Represents the TRIM function. + + + + + Represents the TRIMMEAN function. + + + + + Represents the TRUE function. + + + + + Represents the TRUNC function. + + + + + Represents the TTEST function. + + + + + Represents the TYPE function. + + + + + Represents the UPPER function. + + + + + Represents the VALUE function. + + + + + Represents the VAR function. + + + + + Represents the VARA function. + + + + + Represents the VARP function. + + + + + Represents the VARPA function. + + + + + Represents the VDB function. + + + + + Represents the VLOOKUP function. + + + + + Represents the WEEKDAY function. + + + + + Represents the WEIBULL function. + + + + + Represents the YEAR function. + + + + + Represents the ZTEST function. + + + + + Represents the ABSREF function. + + + + + Represents the ACTIVECELL function. + + + + + Represents the ADDBAR function. + + + + + Represents the ADDCOMMAND function. + + + + + Represents the ADDMENU function. + + + + + Represents the ADDTOOLBAR function. + + + + + Represents the APPTITLE function. + + + + + Represents the ARGUMENT function. + + + + + Represents the ASC function. + + + + + Represents the CALL function. + + + + + Represents the CALLER function. + + + + + Represents the CANCELKEY function. + + + + + Represents the CHECKCOMMAND function. + + + + + Represents the CREATEOBJECT function. + + + + + Represents the CUSTOMREPEAT function. + + + + + Represents the CUSTOMUNDO function. + + + + + Represents the DATEDIF function. + + + + + Represents the DATESTRING function. + + + + + Represents the DBCS function. + + + + + Represents the DELETEBAR function. + + + + + Represents the DELETECOMMAND function. + + + + + Represents the DELETEMENU function. + + + + + Represents the DELETETOOLBAR function. + + + + + Represents the DEREF function. + + + + + Represents the DGET function. + + + + + Represents the DIALOGBOX function. + + + + + Represents the DIRECTORY function. + + + + + Represents the DOCUMENTS function. + + + + + Represents the ECHO function. + + + + + Represents the ENABLECOMMAND function. + + + + + Represents the ENABLETOOL function. + + + + + Represents the EVALUATE function. + + + + + Represents the EXEC function. + + + + + Represents the EXECUTE function. + + + + + Represents the FILES function. + + + + + Represents the FOPEN function. + + + + + Represents the FORMULACONVERT function. + + + + + Represents the FPOS function. + + + + + Represents the FREAD function. + + + + + Represents the FREADLN function. + + + + + Represents the FSIZE function. + + + + + Represents the FWRITE function. + + + + + Represents the FWRITELN function. + + + + + Represents the FCLOSE function. + + + + + Represents the GETBAR function. + + + + + Represents the GETCELL function. + + + + + Represents the GETCHARTITEM function. + + + + + Represents the GETDEF function. + + + + + Represents the GETDOCUMENT function. + + + + + Represents the GETFORMULA function. + + + + + Represents the GETLINKINFO function. + + + + + Represents the GETMOVIE function. + + + + + Represents the GETNAME function. + + + + + Represents the GETNOTE function. + + + + + Represents the GETOBJECT function. + + + + + Represents the GETPIVOTFIELD function. + + + + + Represents the GETPIVOTITEM function. + + + + + Represents the GETPIVOTTABLE function. + + + + + Represents the GETTOOL function. + + + + + Represents the GETTOOLBAR function. + + + + + Represents the GETWINDOW function. + + + + + Represents the GETWORKBOOK function. + + + + + Represents the GETWORKSPACE function. + + + + + Represents the GOTO function. + + + + + Represents the GROUP function. + + + + + Represents the HALT function. + + + + + Represents the HELP function. + + + + + Represents the INITIATE function. + + + + + Represents the INPUT function. + + + + + Represents the LASTERROR function. + + + + + Represents the LINKS function. + + + + + Represents the MOVIECOMMAND function. + + + + + Represents the NAMES function. + + + + + Represents the NOTE function. + + + + + Represents the NUMBERSTRING function. + + + + + Represents the OPENDIALOG function. + + + + + Represents the OPTIONSLISTSGET function. + + + + + Represents the PAUSE function. + + + + + Represents the PIVOTADDDATA function. + + + + + Represents the POKE function. + + + + + Represents the PRESSTOOL function. + + + + + Represents the REFTEXT function. + + + + + Represents the REGISTER function. + + + + + Represents the REGISTERID function. + + + + + Represents the RELREF function. + + + + + Represents the RENAMECOMMAND function. + + + + + Represents the REPT function. + + + + + Represents the REQUEST function. + + + + + Represents the RESETTOOLBAR function. + + + + + Represents the RESTART function. + + + + + Represents the RESULT function. + + + + + Represents the RESUME function. + + + + + Represents the SAVEDIALOG function. + + + + + Represents the SAVETOOLBAR function. + + + + + Represents the SCENARIOGET function. + + + + + Represents the SELECTION function. + + + + + Represents the SERIES function. + + + + + Represents the SETNAME function. + + + + + Represents the SETVALUE function. + + + + + Represents the SHOWBAR function. + + + + + Represents the SPELLINGCHECK function. + + + + + Represents the STEP function. + + + + + Represents the TERMINATE function. + + + + + Represents the TEXTBOX function. + + + + + Represents the TEXTREF function. + + + + + Represents the UNREGISTER function. + + + + + Represents the USDOLLAR function. + + + + + Represents the VOLATIL function. + + + + + Represents the WINDOWS function. + + + + + Represents the WINDOWTITLE function. + + + + + Defines the view setting of the sheet. + + + + + Normal view + + + + + Page break preview + + + + + Page Layout View + + + + + Specifies the known officechart colors. + + + + + Indicates the black color. + + + + + Indicates the white color. + + + + + Indicates the red color. + + + + + Indicates the lightgreen color. + + + + + Indicates the blue color. + + + + + Indicates the yellow color. + + + + + Indicates the magenta color. + + + + + Indicates the cyan color. + + + + + No color. + + + + + Indicates the Aqua color. + + + + + Indicates the BlackCustom color. + + + + + Indicates the BlueCustom color. + + + + + Indicates the Blue_grey color. + + + + + Indicates the Bright_green color. + + + + + Indicates the Brown color. + + + + + Indicates the Dark_blue color. + + + + + Indicates the Dark_green color. + + + + + Indicates the Dark_red color. + + + + + Indicates the Dark_teal color. + + + + + Indicates the Dark_yellow color. + + + + + Indicates the Gold color. + + + + + Indicates the Green color. + + + + + Indicates the Grey_25_percent color. + + + + + Indicates the Grey_40_percent color. + + + + + Indicates the Grey_50_percent color. + + + + + Indicates the Grey_80_percent color. + + + + + Indicates the Indigo color. + + + + + Indicates the Lavender color. + + + + + Indicates the Light_blue color. + + + + + Indicates the Light_green color. + + + + + Indicates the Light_orange color. + + + + + Indicates the Light_turquoise color. + + + + + Indicates the Light_yellow color. + + + + + Indicates the Lime color. + + + + + Indicates the Olive_green color. + + + + + Indicates the Orange color. + + + + + Indicates the Pale_blue color. + + + + + Indicates the Pink color. + + + + + Indicates the Plum color. + + + + + Indicates the Red2 color. + + + + + Indicates the Rose color. + + + + + Indicates the Sea_green color. + + + + + Indicates the Sky_blue color. + + + + + Indicates the Tan color. + + + + + Indicates the Teal color. + + + + + Indicates the Turquoise color. + + + + + Indicates the Violet color. + + + + + Indicates the WhiteCustom color. + + + + + Indicates the YellowCustom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Indicates the Custom color. + + + + + Enumeration of Group types in Excel. + + + + + Represents the grouping by rows option. + + + + + Represents the grouping by columns option. + + + + + Specifies the fill pattern used in a chart. + + + + + Indicates no pattern. + + + + + Indicates the Solid pattern. + + + + + Indicates 50% of the foreground color. + + + + + Indicates 70% of the foreground color. + + + + + Indicates 25% of the foreground color. + + + + + Indicates thick horizontal lines in the foreground color. + + + + + Indicates thick vertical lines in the foreground color. + + + + + Indicates thick lines in the foreground color running from the top to the right-hand side of the chart. + + + + + Indicates thick lines in the foreground color running from the top to the left-hand side of the chart. + + + + + Indicates the ForwardDiagonal pattern. + + + + + Indicates 75% of the foreground color. + + + + + Indicates the Horizontal pattern. + + + + + Indicates the Vertical pattern. + + + + + Indicates thin lines in the foreground color running from the top to the right-hand side of the chart. + + + + + Indicates thin lines in the foreground color running from the top to the left-hand side of the chart. + + + + + Indicates the Angle pattern. + + + + + Indicates 60% of the foreground color. + + + + + Indicates 10% of the foreground color. + + + + + Indicates 5% of the foreground color. + + + + + Indicates the Percent50Gray pattern. + + + + + Indicates the Percent75Gray pattern. + + + + + Indicates the Percent25Gray pattern. + + + + + Indicates the HorizontalStripe pattern. + + + + + Indicates the VerticalStripe pattern. + + + + + Indicates the ReverseDiagonalStripe pattern. + + + + + Indicates the DiagonalStripe pattern. + + + + + Indicates the DiagonalCrosshatch pattern. + + + + + Indicates the ThickDiagonalCrosshatch pattern. + + + + + Indicates the ThinHorizontalStripe pattern. + + + + + Indicates the ThinVerticalStripe pattern. + + + + + Indicates the ThinReverseDeagonalStripe pattern. + + + + + Indicates the ThinDiagonalStripe pattern. + + + + + Indicates the ThinHorizontalCrosshatch pattern. + + + + + Indicates the ThinDiagonalCrosshatch pattern. + + + + + Indicates the Percent125Gray pattern. + + + + + Indicates the Percent625Gray pattern. + + + + + Indicates gradient pattern. + + + + + This enumeration used for controlling output stream infill on + save operation provided by Workbook. + + + + + Do not skip any information from source file. + + + + + Skip macros extension records in output stream. + + + + + Skip drawings extension records in output stream. + + + + + Skip summary information substreams creation. + + + + + Skip coping of substreams from source to destination files. + + + + + Skip all extended records. + + + + + Enumeration which controls visibility of worksheet in Excel. + + + + + Worksheet is visible to the user. + + + + + Worksheet is hidden for the user. + + + + + The strong hidden flag can only be set and cleared with a Visual Basic + macro. It is not possible to make such a sheet visible via the user interface. + + + + + Enumeration of the Save types in Excel. + + + + + Represents the save as xls option. + + + + + Represents the save as template option. + + + + + Specifies the chart type. + + + + + Indicates the Column_Clustered chart type. + + + + + Indicates the Column_Stacked chart type. + + + + + Indicates the Column_Stacked_100 chart type. + + + + + Indicates the Column_Clustered_3D chart type. + + + + + Indicates the Column_Stacked_3D chart type. + + + + + Indicates the Column_Stacked_100_3D chart type. + + + + + Indicates the Column_3D chart type. + + + + + Indicates the Bar_Clustered chart type. + + + + + Indicates the Bar_Stacked chart type. + + + + + Indicates the Bar_Stacked_100 chart type. + + + + + Indicates the Bar_Clustered_3D chart type. + + + + + Indicates the Bar_Stacked_3D chart type. + + + + + Indicates the Bar_Stacked_100_3D chart type. + + + + + Indicates the Line chart type. + + + + + Indicates the Line_Stacked chart type. + + + + + Indicates the Line_Stacked_100 chart type. + + + + + Indicates the Line_Markers chart type. + + + + + Indicates the Line_Markers_Stacked chart type. + + + + + Indicates the Line_Markers_Stacked_100 chart type. + + + + + Indicates the Line_3D chart type. + + + + + Indicates the Pie chart type. + + + + + Indicates the Pie_3D chart type. + + + + + Indicates the PieOfPie chart type. + + + + + Indicates the Pie_Exploded chart type. + + + + + Indicates the Pie_Exploded_3D chart type. + + + + + Indicates the Pie_Bar chart type. + + + + + Indicates the Scatter_Markers chart type. + + + + + Indicates the Scatter_SmoothedLine_Markers chart type. + + + + + Indicates the Scatter_SmoothedLine chart type. + + + + + Indicates the Scatter_Line_Markers chart type. + + + + + Indicates the Scatter_Line chart type. + + + + + Indicates the Area chart type. + + + + + Indicates the Area_Stacked chart type. + + + + + Indicates the Area_Stacked_100 chart type. + + + + + Indicates the Area_3D chart type. + + + + + Indicates the Area_Stacked_3D chart type. + + + + + Indicates the Area_Stacked_100_3D chart type. + + + + + Indicates the Doughnut chart type. + + + + + Indicates the Doughnut_Exploded chart type. + + + + + Indicates the Radar chart type. + + + + + Indicates the Radar_Markers chart type. + + + + + Indicates the Radar_Filled chart type. + + + + + Indicates the Surface_3D chart type. + + + + + Indicates the Surface_NoColor_3D chart type. + + + + + Indicates the Surface_Contour chart type. + + + + + Indicates the Surface_NoColor_Contour chart type. + + + + + Indicates the Bubble chart type. + + + + + Indicates the Bubble_3D chart type. + + + + + Indicates the Stock_HighLowClose chart type. + + + + + Indicates the Stock_OpenHighLowClose chart type. + + + + + Indicates the Stock_VolumeHighLowClose chart type. + + + + + Indicates the Stock_VolumeOpenHighLowClose chart type. + + + + + Indicates the Cylinder_Clustered chart type. + + + + + Indicates the Cylinder_Stacked chart type. + + + + + Indicates the Cylinder_Stacked_100 chart type. + + + + + Indicates the Cylinder_Bar_Clustered chart type. + + + + + Indicates the Cylinder_Bar_Stacked chart type. + + + + + Indicates the Cylinder_Bar_Stacked_100 chart type. + + + + + Indicates the Cylinder_Clustered_3D chart type. + + + + + Indicates the Cone_Clustered chart type. + + + + + Indicates the Cone_Stacked chart type. + + + + + Indicates the Cone_Stacked_100 chart type. + + + + + Indicates the Cone_Bar_Clustered chart type. + + + + + Indicates the Cone_Bar_Stacked chart type. + + + + + Indicates the Cone_Bar_Stacked_100 chart type. + + + + + Indicates the Cone_Clustered_3D chart type. + + + + + Indicates the Pyramid_Clustered chart type. + + + + + Indicates the Pyramid_Stacked chart type. + + + + + Indicates the Pyramid_Stacked_100 chart type. + + + + + Indicates the Pyramid_Bar_Clustered chart type. + + + + + Indicates the Pyramid_Bar_Stacked chart type. + + + + + Indicates the Pyramid_Bar_Stacked_100 chart type. + + + + + Indicates the Pyramid_Clustered_3D chart type. + + + + + Indicates the chart that contain different Series types. + + + + + + + Indicates the Histogram chart type. + + + + + Indicates the waterfall chart type. + + + + + Indicates the Treemap chart type . + + + + + Indicates the SunBurst chart type. + + + + + Indicates the BoxAndWhisker chart type. + + + + + Specifies the position of the legend on a chart. + + + + + Indicates legend position below the chart. + + + + + Indicates legend position in the upper right-hand corner of the chart border. + + + + + Indicates legent position above the chart. + + + + + Indicates legend position right of the chart. + + + + + Indicates legend position left of the chart. + + + + + Indicates the Not Docked option. + + + + + Enumeration of the print size of charts in Excel. + + + + + Represents the Custom option. + + + + + Represents the ScaleToFit page option. + + + + + Represents the Use Full Page option. + + + + + Specifies how blank cells are plotted on a chart. + + + + + Indicates blank cells are not plotted. + + + + + Indicates blanks are plotted as zero. + + + + + Indicates values are interpolated into the chart. + + + + + Specifies the background type in charts. + + + + + Indicates the Transparent option. + + + + + Indicates the Opaque option. + + + + + Enumeration of the horizontal alignment options for Charts in chart. + + + + + Represents the Left alignment option for the horizontal alignment setting for Chart. + + + + + Represents the Center alignment option for the horizontal alignment setting for Chart. + + + + + Represents the Right alignment option for the horizontal alignment setting for Chart. + + + + + Represents the Justify alignment option for the horizontal alignment setting for Chart. + + + + + Enumeration of the vertical alignment options for Charts in chart. + + + + + Represents the Top alignment option for the Vertical alignment setting for Chart. + + + + + Represents the Center alignment option for the Vertical alignment setting for Chart. + + + + + Represents the Bottom alignment option for the Vertical alignment setting for Chart. + + + + + Represents the Justify alignment option for the Vertical alignment setting for Chart. + + + + + Specifies a line style for chart. + + + + + Indicates a solid line for Chart. + + + + + Indicates a dashed line for Chart. + + + + + Indicates a line with a repeating dot pattern for Chart. + + + + + Indicates a line with a repeating dash-dot pattern for Chart. + + + + + Indicates a line a repeating dash-dot-dot pattern for Chart. + + + + + Indicates the line style is not set for chart. + + + + + Indicates the Dark Gray line pattern for Chart.This is only for Binary file format. + + + + + Indicates the Medium Gray line pattern for Chart.This is only for Binary file format. + + + + + Indicates the Light Gray line pattern for Chart.This is only for Binary file format. + + + + + Indicates the rounded dot line pattern for chart. + + + + + Long dashed line. + + + + + Long alternating dashes and dots. + + + + + Long dash followed by two dots. + + + + + Specifies the weight of the border around a range. + + + + + Indicates the Hairline weight for Chart line. + + + + + Indicates the Narrow weight for Chart line. + + + + + Indicates the Medium weight for Chart line. + + + + + Indicates the Wide weight for Chart line. + + + + + Specifies the marker type for a point or series in a line chart, scatter chart, or radar chart. + + + + + Indicates no markers. + + + + + Indicates the square style in the custom marker option for Chart lines. + + + + + Indicates the diamond style in the custom marker option for Chart lines. + + + + + Indicates the Triangle style in the custom marker option for Chart lines. + + + + + Indicates the X style in the custom marker option for Chart lines. + + + + + Indicates the Star style in the custom marker option for Chart lines. + + + + + Indicates the Dow Jones style in the custom marker option for Chart lines. + + + + + Indicates the Standard Deviation style in the custom marker option for Chart lines. + + + + + Indicates the Circle style in the custom marker option for Chart lines. + + + + + Indicates the Plus style in the custom marker option for Chart lines. + + + + + Specifies the axis type. + + + + + Indicates axis displays the Category (X) Axis. + + + + + Indicates axis displays the Value (Y) Axis. + + + + + Indicates axis displays data serie + + + + + Enumeration of the insert options in Excel. + + + + + Indicates that after insert operation inserted rows/columns + must be formatted as row above or column left. + + + + + Indicates that after insert operation inserted rows/columns + must be formatted as row below or column right. + + + + + Indicates that after insert operation inserted rows/columns + must have default format. + + + + + Enumeration of the type of conditional formatting in Excel. + + + + + Represents the Cell Value Is option for conditional formatting. + + + + + Represents the Formula Is option for conditional formatting. + + + + + Represents the ColorScale option for conditional formatting. + + + + + Represents the DataBar option for conditional formatting. + + + + + Represents the IconSet option for conditional formatting. + + + + + Represents conditional formatting rule highlights cells that are completely blank + + + + + Represents conditional formatting rule highlights cells that are not blank + + + + + Represents the Specific Text conditional formatting rule based on the text + + + + + Represents conditional formatting rule highlights cells that conatins errors + + + + + Represents conditional formatting rule highlights cells that does not conatins errors + + + + + Represents Time Perdiod conditional formatting rule highlights cells that has date time + + + + + Enumeration of the Comparison operator for conditional formatting in Excel. + + + + + Represents no option for comparison in conditional formatting. + + + + + Represents between option for comparison in conditional formatting. + + + + + Represents not between option for comparison in conditional formatting. + + + + + Represents equal to option for comparison in conditional formatting. + + + + + Represents not equal to option for comparison in conditional formatting. + + + + + Represents greater than option for comparison in conditional formatting. + + + + + Represents less than option for comparison in conditional formatting. + + + + + Represents greater than or equal to option for comparison in conditional formatting. + + + + + Represents less than or equal to option for comparison in conditional formatting. + + + + + Represents the begins with operation for Specific Text conditional formatting. + + + + + Represents the contains text operation for Specific Text conditional formatting. + + + + + Represents the ends with operation for Specific Text conditional formatting. + + + + + Represents the not contains text operation for Specific Text conditional formatting. + + + + + Enumeration of the time periods for date time conditional formatting in Excel. + + + + + Represents today's time period type + + + + + Represents yesterday's time period type + + + + + Represents tomorrow's time period type + + + + + Represents last seven days time period type + + + + + Represents this month time period type + + + + + Represents last month time period type + + + + + Represents next month period type + + + + + Represents this week period type + + + + + Represents last week time period type + + + + + Represents next week time period type + + + + + Enumeration of the Comparison operator for conditional formatting in Excel. + + + + + Represents between option for comparison in conditional formatting. + + + + + Represents not between option for comparison in conditional formatting. + + + + + Represents equal to option for comparison in conditional formatting. + + + + + Represents not equal to option for comparison in conditional formatting. + + + + + Represents greater than option for comparison in conditional formatting. + + + + + Represents less than option for comparison in conditional formatting. + + + + + Represents greater than or equal to option for comparison in conditional formatting. + + + + + Represents less than or equal to option for comparison in conditional formatting. + + + + + Possible data types: + + + + + Represents the Any data type. + + + + + Represents the Integer data type. + + + + + Represents the Decimal data type. + + + + + Represents the User data type. + + + + + Represents the Date data type. + + + + + Represents the Time data type. + + + + + Represents the TextLength data type. + + + + + Represents the Formula data type. + + + + + Possible error style values: + + + + + Represents the Stop error style. + + + + + Represents the Warning error style. + + + + + Represents the Info error style. + + + + + Enumeration of possible directions to shift cells after clearing a range. + + + + + Represents the MoveLeft move direction. + + + + + Represents the MoveUp move direction. + + + + + Represents the None move direction. + + + + + Enumeration of shapes available in Excel. + + + + + Represents the AutoShape shape type. + + + + + Represents the Callout shape type. + + + + + Represents the Canvas shape type. + + + + + Represents the Chart shape type. + + + + + Represents the Comment shape type. + + + + + Represents the Diagram shape type. + + + + + Represents the EmbeddedOLEObject shape type. + + + + + Represents the FormControl shape type. + + + + + Represents the Freeform shape type. + + + + + Represents the GroupShape type. + + + + + Represents the Line shape type. + + + + + Represents the LinkedOLEObject shape type. + + + + + Represents the LinkedPicture shape type. + + + + + Cannot be used with this property. This constant is used with shapes + in other Microsoft Office applications. + + + + + Represents the OLEControlObject shape type. + + + + + Represents the Picture shape type. + + + + + Cannot be used with this property. This constant is used with shapes + in other Microsoft Office applications. + + + + + Represents the ScriptAnchor shape type. + + + + + Represents the ShapeTypeMixed shape type. + + + + + Represents the Table shape type. + + + + + Represents the TextBox shape type. + + + + + Represents the TextEffect shape type. + + + + + Represents the Unknown shape type. + + + + + Enumeration to specify the possible Text Rotation options. + + + + + Represents the LeftToRight text rotation. + + + + + Represents the TopToBottom text rotation. + + + + + Represents the CounterClockwise text rotation. + + + + + Represents the Clockwise text rotation. + + + + + Enumeration to align the excel comment Horizontally. + + + + + Represents the Left comment align. + + + + + Represents the Center comment align. + + + + + Represents the Right comment align. + + + + + Represents the Justified comment align. + + + + + Represents the Justified comment align. + + + + + Represents the Distributed comment align. + + + + + Enumeration to align the excel comment vertically + + + + + Represents the Top comment align. + + + + + Represents the Center comment align. + + + + + Represents the Bottom comment align. + + + + + Represents the Justified comment align. + + + + + Represents the Distributed comment align. + + + + + Enumeration to specify if the spreadsheet should be opened inside browser or saved + as an attachment to disk. + + + + + File should be opened in browser. + + + + + Prompt dialog should be displayed. + + + + + HttpContent type. + + + + + Represents the Excel97 HttpContent type. + + + + + Represents the Excel2000 HttpContent type. + + + + + Represents the Excel2007 HttpContent type. + + + + + Represents the Excel2010 HttpContent type. + + + + + Represents the Excel2013 HttpContent type. + + + + + Represents the CSV HttpContent type. + + + + + Enumeration to specify the style merge options. + + + + + Represents the Leave style merge option. + + + + + Represents the Replace style merge option. + + + + + Represents the CreateDiffName style merge option. + + + + + Enumeration to specify Names Merge options. + + + + + Represents the Leave names merge option. + + + + + Represents the Replace names merge option. + + + + + Represents the Rename names merge option. + + + + + Represents the MakeLocal names merge option. + + + + + Enumeration to specify options when copying worksheets. + + + + + No flags. + + + + + Represents the ClearBefore copy flags. + + + + + Represents the CopyNames copy flags. + + + + + Represents the CopyCells copy flags. + + + + + Represents the CopyRowHeight copy flags. + + + + + Represents the CopyColumnHeight copy flags. + + + + + Represents the CopyOptions copy flags. + + + + + Represents the CopyMerges copy flags. + + + + + Represents the CopyShapes copy flags. + + + + + Represents the CopyConditionlFormats copy flags. + + + + + Represents the CopyAutoFilters copy flags. + + + + + Represents the CopyDataValidations copy flags. + + + + + Copy page setup (page breaks, paper orientation, header, footer and other properties). + + + + + Copy table objects. + + + + + Copy pivot table objects. + + + + + Copies palette. + + + + + Represents the CopyAll copy flags, except palette. + + + + + Represents the CopyWithoutNames copy flags. + + + + + Enumeration to specify the options to update formulas and merged ranges during copy range + operation. + + + + + No flags. + + + + + Indicates whether update formula during copy. WARNING: you should always + specify this flag if your operations could change position of Array formula. + + + + + Indicates whether update merges during copy. + + + + + Indicates that we have to copy styles during range copy. + + + + + Indicates that we have to copy shapes during range copy. + + + + + Indicates that we have to copy error indicators during range copy. + + + + + Indicates that we have to copy conditional formats during range copy. + + + + + Indicates that we have to copy data validations during range copy. + + + + + All flags. + + + + + Enumeration to specify the options of excel formula + + + + + No flags. + + + + + Represents the RootLevel formula parse option. + + + + + Represents the InArray formula parse option. + + + + + Represents the InName formula parse option. + + + + + Operand in function. + + + + + Operand is complex. + + + + + Indicates that R1C1 notation must be used. + + + + + Data type for autofilters. + + + + + Represents the filter data type. + + + + + Represents the FloatingPoint filter data type. + + + + + Represents the String filter data type. + + + + + Represents the Boolean filter data type. + + + + + Represents the ErrorCode filter data type. + + + + + Represents the MatchAllBlanks filter data type. + + + + + Represents the MatchAllNonBlanks filter data type. + + + + + Possible conditions in autofilter. + + + + + Represents the Less filter condition type. + + + + + Represents the Equal filter condition type. + + + + + Represents the LessOrEqual filter condition type. + + + + + Represents the Greater filter condition type. + + + + + Represents the NotEqual filter condition type. + + + + + Represents the GreaterOrEqual filter condition type. + + + + + Parsing options. + + + + + Represents the Default parse option. + + + + + Represents the SkipStyles parse option + + + + + Represents the DoNotParseCharts parse option + + + + + This is special mode. In this mode user can't modify strings or add new strings + (numbers and other types are ok), but it gives more speed and less memory usage. + + + + + Preserves the Pivot table. + + + + + Parses the sheet when accessed. + + + + + ExportDataTable options. + + + + + No datatable exports flags. + + + + + Represents the ColumnNames datatable export flag. + + + + + Represents the ComputedFormulaValues datatable export flag. + + + + + Indicates that XlsIO should try to detect column types. + + + + + When DetectColumnTypes is set and this flag is set too, it means that + default column style must be used to detect style, if this flag is not set, + but DetectColumnTypes is set, then first cell in the column will be used + to detect column type. + + + + + Indicates whether to preserve Ole date (double numbers) instead of date-time values. + + + + + Specifies the chart rectangle style, used in chart frames. + + + + + Indicates the Regular rectangle style. + + + + + Indicates the Shadowed rectangle style. + + + + + Possible types of hyperlinks. + + + + + No hyperlink. + + + + + Represents the Url hyperlink type. + + + + + Represents the File hyperlink type. + + + + + Represents the Unc hyperlink type. + + + + + Represents the Workbook hyperlink type. + + + + + Possible types of param, specified as string, number in FindFirst, FindAll methods. + + + + + Represents the Text Finding type. + + + + + Represents the Formula Finding type. + + + + + Represents the FormulaStringValue Finding type. + + + + + Represents the Error Finding type. + + + + + Represents the Number Finding type. + + + + + Represents the FormulaValue Finding type. + + + + + Possible type of finding options + + + + + Represents none of the option is selected. + + + + + Represents to match the case while finding the value. + + + + + Represents to match the whole search word while finding the value. + + + + + Possible types of direction order. + + + + + Represents the Context reading order type. + + + + + Represents the LeftToRight reading order type. + + + + + Represents the RightToLeft reading order type. + + + + + Possible image formats. + + + + + Try to keep original picture format. + + + + + Use PNG picture format. + + + + + Use JPG picture format. + + + + + Represents the MeasureUnits types. + + + + + Specifies 1/75 inch as the unit of measure. + + + + + Specifies the document unit (1/300 inch) as the unit of measure. + + + + + Specifies the inch as the unit of measure. + + + + + Specifies the millimeter as the unit of measure. + + + + + Specifies the centimeter as the unit of measure. + + + + + Specifies a device pixel as the unit of measure. + + + + + Specifies a printer's point (1/72 inch) as the unit of measure. + + + + + 12700 emu's = 1 point. + + + + + Specifies the chart bubble size. + + + + + Indicates area of the bubble. + + + + + Indicates width of the bubble. + + + + + Specifies the limit values of pie chart. + + + + + Indicates the Normal type. + + + + + Indicates the Pie type. + + + + + Indicates the Bar type. + + + + + Specifies the values displayed in the second chart. + + + + + Indicates the second chart displays the smallest values in the data series. The number of values to display is specified by the SplitValue property. + + + + + Indicates the second chart displays values less than the value specified by the SplitValue property. + + + + + Indicates second chart displays values less than some percentage of the total value. The percentage is specified by the SplitValue property. + + + + + Indicates the arbitrary slides are displayed in the second chart. + + + + + Represents the drop line style type. + + + + + Represents the Drop line style. + + + + + Represents the HiLow drop line style. + + + + + Represents the Series drop line style. + + + + + Represents the legend spacing options. + + + + + Represents the Close ExcelLegendSpacing option. + + + + + Represents the Medium ExcelLegendSpacing option. + + + + + Represents the Open ExcelLegendSpacing option. + + + + + Specifies base format options. + + + + + Indicates Rectangle base format. + + + + + Indicates Circle base format. + + + + + Specifies Top format options. + + + + + Indicates Straight top format. + + + + + Indicates Sharp top format. + + + + + Indicates Trunc top format. + + + + + Object text is linked to. + + + + + Represents the Chart object text type. + + + + + Represents the YAxis object text type. + + + + + Represents the XAxis object text type. + + + + + Represents the DataLabel object text type. + + + + + Represents the ZAxis object text type. + + + + + Represents the DisplayUnit object text type. + + + + + Enumeration which represents axis line identifier. + + + + + The axis line itself. + + + + + Major grid line along the axis. + + + + + Minor grid line along the axis. + + + + + Walls or floor -- walls if parent axis is type 0 or 2; + floor if parent axis is type 1. + + + + + Possible format types. + + + + + Represents unknown format type. + + + + + Represents general number format. + + + + + Represents text number format. + + + + + Represents number number format. + + + + + Represents datetime number format. + + + + + Represents percentage number format. + + + + + Represents currency number format. + + + + + Represents decimal percentage number format. + + + + + Represents Exponential number format. + + + + + Indicates what property will be used for export. + + + + + Represents Boolean property. + + + + + Represents Number property. + + + + + Represents Text property. + + + + + Represents DateTime property. + + + + + Represents TimeSpan property. + + + + + Represents Error property. + + + + + Represents Formula. + + + + + Supported Xml save types. + + + + + Xml format used by MS Excel. + + + + + Xml format used by Syncfusion.DLS. This format is used to export + into Syncfusion.Pdf and Syncfusion.DocIO. + + + + + Enumeration of possible directions to clear the Cell formats, content, comments or clear all of them. + + + + + Clears the formats of the cell. + + + + + Clears the contents of the cell. + + + + + Clears the comments of the cell. + + + + + Clears the comments, content and formats of the cell. + + + + + Clears all the Conditional Format + + + + + Clears all data validations + + + + + Supported Xml open types. + + + + + Xml format used by MS Excel. + + + + + Specifies the style for a line. + + + + + Indicates single line style. + + + + + Indicates thin thin line style. + + + + + Indicates thin thick line style. + + + + + Indicates thick thin line style. + + + + + Indicates thick between thin line style. + + + + + Specifies the dash style for a line. + + + + + Indicates the line is solid. + + + + + Indicates the line is dotted. + + + + + Indicates the line is made up of round dots. + + + + + Indicates the line consists of dashes only. + + + + + Indicates the line is Medium_dashed style. + + + + + Indicates the line is a dash-dot pattern. + + + + + Indicates the line is Medium_Dash_Dot style. + + + + + Indicates the line is a dash-dot-dot pattern. + + + + + Specifies the style of the arrowhead at the end of a line. + + + + + Indicates the line has no arrowhead. + + + + + Indicates the arrow style is triangular. + + + + + Indicates the arrow style is stealth. + + + + + Indicates the arrow style is diamond. + + + + + Indicates the arrow style is oval. + + + + + Indicates the arrow style is open. + + + + + Specifies the length of the arrowhead at the end of a line. + + + + + Indicates short arrow head length. + + + + + Indicates short arrow head length. + + + + + Indicates short arrow head length. + + + + + Specifies the width of the arrowhead at the end of a line. + + + + + Indicates the arrow head is narrow. + + + + + Indicates the arrow head is medium. + + + + + Specifies the arrow head is wide. + + + + + Specifies a shape's fill type. + + + + + Indicates Solid color. + + + + + Indicates pattern type. + + + + + Indicates texture type. + + + + + Indicates picture type. + + + + + Indicates unsupport gradient that can be created using Excel 2007, + but not supported correctly by Excel 2003 structures. + + + + + Indicates gradient type. + + + + + Specifies the style for a gradient fill. + + + + + Indicates gradient running horizontally across the chart. + + + + + Indicates gradient running vertically down the chart. + + + + + Indicates diagonal gradient moving from a bottom corner up to the opposite corner. + + + + + Indicates diagonal gradient moving from a top corner down to the opposite corner. + + + + + Indicates gradient running from a corner to the other three corners. + + + + + Indicates gradient running from the center out to the corners. + + + + + Indicates diagonal gradient moving from a bottom corner up to the opposite corner. + + + + + Indicates diagonal gradient moving from a top corner down to the opposite corner. + + + + + Indicates gradient running from a corner to the other three corners. + + + + + Indicates gradient running from the center out to the corners. + + + + + Specifies shape shading variants. + + + + + Indicates first shading variants. + + + + + Indicates second shading variants. + + + + + Indicates third shading variants. + + + + + Indicates fourth shading variants. + + + + + Specifies the type of gradient used in a chart's fill. + + + + + Indicates one color gradient style. + + + + + Indicates two color gradient style. + + + + + Indicates preset gradient style. + + + + + Specifies texture to be used to fill an object. + + + + + Indicates Newsprint texture type. + + + + + Indicates Recycled Paper texture type. + + + + + Indicates Parchment texture type. + + + + + Indicates Stationery texture type. + + + + + Indicates Green Marble texture type. + + + + + Indicates White Marble texture type. + + + + + Indicates Brown Marble texture type. + + + + + Indicates Granite texture type. + + + + + Indicates Blue Tissue Paper texture type. + + + + + Indicates Pink Tissue Paper texture type. + + + + + Indicates Purple Mesh texture type. + + + + + Indicates Bouquet texture type. + + + + + Indicates Papyrus texture type. + + + + + Indicates Canvas texture type. + + + + + Indicates Denim texture type. + + + + + Indicates Woven Mat texture type. + + + + + Indicates Water Droplets texture type. + + + + + Indicates Paper Bag texture type. + + + + + Indicates Fish Fossil texture type. + + + + + Indicates Sand texture type. + + + + + Indicates Cork texture type. + + + + + Indicates Walnut texture type. + + + + + Indicates Oak texture type. + + + + + Indicates Medium Wood texture type. + + + + + Indicates user defined texture type. + + + + + Specifies gradient pattern. + + + + + Indicates 5% gradient pattern + + + + + Indicates 10% gradient pattern + + + + + Indicates 20% gradient pattern + + + + + Indicates 25% gradient pattern + + + + + Indicates 30% gradient pattern + + + + + Indicates 40% gradient pattern + + + + + Indicates 50% gradient pattern + + + + + Indicates 60% gradient pattern + + + + + Indicates 70% gradient pattern + + + + + Indicates 75% gradient pattern + + + + + Indicates 80% gradient pattern + + + + + Indicates 90% gradient pattern + + + + + Indicates Dark Downward Diagonal gradient pattern + + + + + Indicates Dark Horizontal gradient pattern + + + + + Indicates Dark Upward Diagonal gradient pattern + + + + + Indicates Dark Vertical gradient pattern + + + + + Indicates Dashed Downward Diagonal gradient pattern + + + + + Indicates Dashed Horizontal gradient pattern + + + + + Indicates Dashed Upward Diagonal gradient pattern + + + + + Indicates Dashed Vertical gradient pattern + + + + + Indicates Diagonal Brick gradient pattern + + + + + Indicates Divot gradient pattern + + + + + Indicates Dotted Diamond gradient pattern + + + + + Indicates Dotted Grid gradient pattern + + + + + Indicates Horizontal Brick gradient pattern + + + + + Indicates Large Checker Board gradient pattern + + + + + Indicates Large Confetti gradient pattern + + + + + Indicates Large Grid gradient pattern + + + + + Indicates Light Downward Diagonal gradient pattern + + + + + Indicates Light Horizontal gradient pattern + + + + + Indicates Light Upward Diagonal gradient pattern + + + + + Indicates Light Vertical gradient pattern + + + + + Indicates Mixed gradient pattern + + + + + Indicates Narrow Horizontal gradient pattern + + + + + Indicates Narrow Vertical gradient pattern + + + + + Indicates Outlined Diamond gradient pattern + + + + + Indicates Plaid gradient pattern + + + + + Indicates Shingle gradient pattern + + + + + Indicates Small Checker Board gradient pattern + + + + + Indicates Small Confetti gradient pattern + + + + + Indicates Small Grid gradient pattern + + + + + Indicates Solid Diamond gradient pattern + + + + + Indicates Sphere gradient pattern + + + + + Indicates Trellis gradient pattern + + + + + Indicates Wave gradient pattern + + + + + Indicates Weave gradient pattern + + + + + Indicates Wide Downward Diagonal gradient pattern + + + + + Indicates Wide Upward Diagonal gradient pattern + + + + + Indicates Zig Zag gradient pattern + + + + + Specifies which predefined gradient to use to fill a shape. + + + + + Indicates early sunset preset gradient type. + + + + + Indicates late sunset preset gradient type. + + + + + Indicates nightfall preset gradient type. + + + + + Indicates daybreak preset gradient type. + + + + + Indicates horizon preset gradient type. + + + + + Indicates desert preset gradient type. + + + + + Indicates ocean preset gradient type. + + + + + Indicates calm water preset gradient type. + + + + + Indicates fire preset gradient type. + + + + + Indicates fog preset gradient type. + + + + + Indicates moss preset gradient type. + + + + + Indicates peacock preset gradient type. + + + + + Indicates wheat preset gradient type. + + + + + Indicates parchment preset gradient type. + + + + + Indicates mahogany preset gradient type. + + + + + Indicates rainbow preset gradient type. + + + + + Indicates rainbowII preset gradient type. + + + + + Indicates gold preset gradient type. + + + + + Indicates goldII preset gradient type. + + + + + Indicates brass preset gradient type. + + + + + Indicates chrome preset gradient type. + + + + + Indicates chromeII preset gradient type. + + + + + Indicates silver preset gradient type. + + + + + Indicates sapphire preset gradient type. + + + + + Specifies the position of major and minor tick marks for an axis. + + + + + Indicates No mark. + + + + + Indicates the tickmark inside the axis. + + + + + Indicates the tickmark outside the axis. + + + + + Indicates the tickmark crosses the axis. + + + + + Specifies the position of tick-mark labels on the specified axis. + + + + + Indicates no tick marks. + + + + + Indicates the tick label position at bottom or left side of the chart. + + + + + Indicates the tick label position at top or right side of the chart. + + + + + Indicates the tick label position next to axis (where axis is not at either side of the chart). + + + + + Represents auto format values. + + + + + Represents Simple auto format. + + + + + Represents Classic_1 auto format. + + + + + Represents Classic_2 auto format. + + + + + Represents Classic_3 auto format. + + + + + Represents Accounting_1 auto format. + + + + + Represents Accounting_2 auto format. + + + + + Represents Accounting_3 auto format. + + + + + Represents Accounting_4 auto format. + + + + + Represents Colorful_1 auto format. + + + + + Represents Colorful_2 auto format. + + + + + Represents Colorful_3 auto format. + + + + + Represents List_1 auto format. + + + + + Represents List_2 auto format. + + + + + Represents List_3 auto format. + + + + + Represents Effect3D_1 auto format. + + + + + Represents Effect3D_2 auto format. + + + + + Represents None auto format. + + + + + Represents auto format options. + + + + + Represents number auto format option. + + + + + Represents border auto format option. + + + + + Represents font auto format option. + + + + + Represents patterns auto format option. + + + + + Represents alignment auto format option. + + + + + Represents width\height auto format option. + + + + + Represents none auto format option. + + + + + Represents all auto format option. + + + + + Specifies the range marked by error bars. + + + + + Indicates percentage of range to be covered by the error bars. + + + + + Indicates fixed-length error bars. + + + + + Indicates range for specified number of standard deviations. + + + + + Indicates range is set by fixed values or cell values. + + + + + Indicates standard error range. + + + + + Specifies which error-bar parts to include. + + + + + Indicates both positive and negative error range. + + + + + Indicates only positive error range. + + + + + Indicates only negative error range. + + + + + Specifies how the trendline that smoothes out fluctuations in the data is calculated. + + + + + Uses an equation to calculate the least squares fit through points, for example, y=ab^x . + + + + + Uses the linear equation y = mx + b to calculate the least squares fit through points. + + + + + Uses the equation y = c ln x + b to calculate the least squares fit through points. + + + + + Uses a sequence of averages computed from parts of the data series. The number of points equals the total number of points in the series less the number specified for the period. + + + + + Uses an equation to calculate the least squares fit through points, for example, y = ax^6 + bx^5 + cx^4 + dx^3 + ex^2 + fx + g. + + + + + Uses an equation to calculate the least squares fit through points, for example, y = ax^b. + + + + + Specifies the type of the category axis. + + + + + Axis groups data by an arbitrary set of categories. + + + + + Axis groups data on a time scale. + + + + + Indicates automatic category type. + + + + + Represents sheet protection flags enums. + + + + + Represents none flags. + + + + + True to protect shapes. + + + + + True to protect scenarios. + + + + + True allows the user to format any cell on a protected worksheet. + + + + + True allows the user to format any column on a protected worksheet. + + + + + True allows the user to format any row on a protected. + + + + + True allows the user to insert columns on the protected worksheet. + + + + + True allows the user to insert rows on the protected worksheet. + + + + + True allows the user to insert hyperlinks on the worksheet. + + + + + True allows the user to delete columns on the protected worksheet, + where every cell in the column to be deleted is unlocked. + + + + + True allows the user to delete rows on the protected worksheet, + where every cell in the row to be deleted is unlocked. + + + + + True to protect locked cells. + + + + + True allows the user to sort on the protected worksheet. + + + + + True allows the user to set filters on the protected worksheet. + Users can change filter criteria but can not enable or disable an auto filter. + + + + + True allows the user to use pivot table reports on the protected worksheet. + + + + + True to protect the user interface, but not macros. + + + + + True to protect content. + + + + + Represents all flags + + + + + Specifies numeric units of measurement. + + + + + Indicates no units are displayed. + + + + + Indicates units of hundreds. + + + + + Indicates units of thousands. + + + + + Indicates units of tens of thousands. + + + + + Indicates units of hundreds of thousands. + + + + + Indicates units of millions. + + + + + Indicates units of tens of millions. + + + + + Indicates units of hundreds of millions. + + + + + Indicates units of thousands of millions. + + + + + Indicates units of millions of millions. + + + + + Indicates custom units. + + + + + Specifies units of time measurement. + + + + + Indicates Day units. + + + + + Indicates Month units. + + + + + Indicates Year units. + + + + + Represents excel open type. + + + + + Represents CSV open type. If data in the file exceeds worksheet limits, excepion will be thrown. + + + + + Represents SpreadsheetML open type. + + + + + Represents BIFF open type. + + + + + Represents SpreadsheetML that is used in Excel 2007 (Office Open XML format). + + + + + Represents SpreadsheetML that is used in Excel 2010 (Office Open XML format). + + + + + Automatically indicates open type. + + + + + Specifies the position of data labels relative to the data markers. + + + + + Indicates default position. + + + + + Indicates the Outside data label placement option. + + + + + Indicates the Inside data label placement option. + + + + + Indicates the Center data label placement option. + + + + + Indicates the OutsideBase data label placement option. + + + + + Indicates data label positioned above point. + + + + + Indicates data label positioned below point. + + + + + Indicates the Left data label placement option. + + + + + Indicates the Right data label placement option. + + + + + Indicates the BestFit data label placement option. + + + + + Indicates the Moved data label placement option. + + + + + Represents flags of excel ignore error indicator. + + + + + Represents None flag of excel ignore error indicator. + + + + + Represents EvaluateToError flag of excel ignore error indicator. + + + + + Represents EmptyCellReferences flag of excel ignore error indicator. + + + + + Represents NumberAsText flag of excel ignore error indicator. + + + + + Represents OmittedCells flag of excel ignore error indicator. + + + + + Represents InconsistentFormula flag of excel ignore error indicator. + + + + + Represents TextDate flag of excel ignore error indicator. + + + + + Represents UnlockedFormulaCells flag of excel ignore error indicator. + + + + + Represents All flag of excel ignore error indicator. + + + + + Represents encryption algorithm that will be used for encryption. + + + + + No encryption. + + + + + Standard encryption. + + + + + Represents possible excel versions. + + + + + Represents excel version 97-2003. + + + + + Represents excel version 2007 + + + + + Represents excel version 2010 + + + + + Represents excel version 2013 + + + + + Defines the possible settings for vertical alignment of a run of text. + This is used to get superscript or subscript text without altering the + font size properties of the rest of the text run. + + + + + Returns the text in this run to the baseline, default, + alignment, and returns it to the original font size. + + + + + Specifies that this text should be superscript. Raises the text in this + run above the baseline and changes it to a smaller size, if a smaller + size is available. + + + + + Specifies that this text should be subscript. Lowers the text in this + run below the baseline and changes it to a smaller size, if a smaller + size is available. + + + + + Specifies check state of the check box. + + + + + Indicates that checkbox is unchecked. + + + + + Indicates that checkbox is checked. + + + + + Mixed state. + + + + + Possible image types for image conversion. + + + + + Bitmap image. + + + + + Metafile image. + + + + + Flags for expand/collapse settings. + + + + + Default options. + + + + + Indicates whether subgroups must be included into operation. + + + + + Indicates whether we have to expand parent group when expanding child (to make it visible). + + + + + Specifies existing built-in styles for Excel 2007. + + + + + Indicates Normal style. + + + + + Indicates Comma style. + + + + + Indicates Currency style. + + + + + Indicates Percent style. + + + + + Indicates Comma[0] style. + + + + + Indicates Currency[0] style. + + + + + Indicates Note style. + + + + + Indicates Warning Text style. + + + + + Indicates Title style. + + + + + Indicates Heading 1 style. + + + + + Indicates Heading 2 style. + + + + + Indicates Heading 3 style. + + + + + Indicates Heading 4 style. + + + + + Indicates Input style. + + + + + Indicates Output style. + + + + + Indicates Calculation style. + + + + + Indicates Check Cell style. + + + + + Indicates Linked Cell style. + + + + + Indicates Total style. + + + + + Indicates Good style. + + + + + Indicates Bad style. + + + + + Indicates Neutral style. + + + + + Indicates Accent1 style. + + + + + Indicates 20% - Accent1 style. + + + + + Indicates 40% - Accent1 style. + + + + + Indicates 60% - Accent1 style. + + + + + Indicates Accent2 style. + + + + + Indicates 20% - Accent2 style. + + + + + Indicates 40% - Accent2 style. + + + + + Indicates 60% - Accent2 style. + + + + + Indicates Accent3 style. + + + + + Indicates 20% - Accent3 style. + + + + + Indicates 40% - Accent3 style. + + + + + Indicates 60% - Accent3 style. + + + + + Indicates Accent4 style. + + + + + Indicates 20% - Accent4 style. + + + + + Indicates 40% - Accent4 style. + + + + + Indicates 60% - Accent4 style. + + + + + Indicates Accent5 style. + + + + + Indicates 20% - Accent5 style. + + + + + Indicates 40% - Accent5 style. + + + + + Indicates 60% - Accent5 style. + + + + + Indicates Accent6 style. + + + + + Indicates 20% - Accent6 style. + + + + + Indicates 40% - Accent6 style. + + + + + Indicates 60% - Accent6 style. + + + + + Indicates Explanatory Text style. + + + + + Represents possible combo box type values.. + + + + + Regular sheet dropdown control. + + + + + PivotTable page field dropdown. + + + + + AutoFilter dropdown. + + + + + AutoComplete dropdown. + + + + + Data validation list dropdown. + + + + + PivotTable row or column field dropdown. + + + + + Dropdown for the Total Row of a table. + + + + + shape border join type + (Supported in Excel 2007 and higher) + + + + + Rounded edge + + + + + Beveled edge + + + + + Metter join + + + + + MS Chart Font preservation Type + (Internal use) + + + + + Without the Font Tag + + + + + font with the default Property tag + + + + + font in ritch text tag + + + + + Specifies how pictures are displayed on a column, bar picture chart, or legend key. + + + + + Indicates picture is sized to repeat a maximum of 15 times in the longest stacked bar. + + + + + Indicates picture is sized to a specified number of units and repeated the length of the bar. + + + + + Indicates picture is stretched the full length of stacked bar. + + + + + Represents the extension property data. + + + + + Cell interior foreground color. + + + + + Cell interior background color. + + + + + Cell interior gradient fill. + + + + + Top cell border color. + + + + + Bottom cell border color. + + + + + Left cell border color. + + + + + Right cell border color. + + + + + Diagonal cell border color. + + + + + Cell text color. + + + + + Font Scheme + + + + + The text indentation level. + + + + + Font Scheme. + + + + + No font scheme. + + + + + Major scheme. + + + + + Minor scheme. + + + + + Ninched state. + + + + + Specifies axis text direction. + + + + + Indicates context text direction. + + + + + Indicates Left-To-Right text direction. + + + + + Indicates Right-To-Left text direction. + + + + + Conditional format template. + + + + + Cell value. + + + + + Formula. + + + + + Color scale formatting. + + + + + Data bar formatting. + + + + + Icon set formatting. + + + + + Filter. + + + + + Unique values. + + + + + Contains text. + + + + + Contains blanks. + + + + + Contains no blanks. + + + + + Contains errors. + + + + + Contains no errors. + + + + + Today. + + + + + Tomorrow. + + + + + Yesterday. + + + + + Last 7 days. + + + + + Last month. + + + + + Next month. + + + + + This week. + + + + + Next week. + + + + + Last week. + + + + + This month. + + + + + Above average. + + + + + Below Average. + + + + + Duplicate values. + + + + + Above or equal to average. + + + + + Below or equal to average. + + + + + Conditional format type of Text rule. + + + + + Text contains. + + + + + Text does not contain. + + + + + Text begins with. + + + + + Text ends with. + + + + + Specifies the series labels for the series label levels. + + + + + Set series names to all series name levels w/in range on the chart. + + + + + Set no category labels in the chart; instead default to automatic indexed labels. + + + + + Specifies the category labels for the category label levels. + + + + + Set category labels to all category label levels within range on the chart. + + + + + Set no category labels in the chart. Defaults to automatic indexed labels. + + + + + ConsolidationFunctions + + + + + Sum + + + + + Count + + + + + Average + + + + + Maximum + + + + + Minimum + + + + + Multiply + + + + + Count numerical values only + + + + + Standard deviation, based on a sample + + + + + Standard deviation, based on the whole population + + + + + Variation, based on a sample + + + + + Variation, based on the whole population. + + + + + Specifies the type of arrow. + + + + + Represents Cap of the line. + + + + + Represents Flat cap style + + + + + Represents Square Cap Style + + + + + Represents Round cap style + + + + + Represents triangle Cap style + + + + + Represents custom Cap style + + + + + Specifies the size of arrow. + + + + + It specifies an enumeration of side positions + + + + + The title or legend is on the left side + + + + + The title or legend is on the top + + + + + The title or legend is on the left side + + + + + The title or legend is on the bottom + + + + + It represent side position alignment of a chart element + + + + + The chart element is positioned at the top of the side + + + + + The chart element is positioned at the bottom of the side + + + + + The chart element is positioned at the center of the side + + + + + It represents Quartile calculation used for Box and Whisker Chart series + + + + + It includes the Median when splitting the dataset into Quartiles. + + + + + It excludes the Median when splitting the dataset into Quartiles. + + + + + It represents the Label position in Tree Map chart + + + + + No Parent labels are shown + + + + + The Parent label layout is a Banner above the category + + + + + The Parent label is laid out within the category + + + + + Contains the list of style elements + + + + + Indicates the Axis Title Element + + + + + Indicates the Category Axis element + + + + + Indicates the chart Area Element + + + + + Indicates the Data Label Element + + + + + Indicates the Data Label callout Element + + + + + Indicates the Data Point Element + + + + + Indicates the Data Point 3D Element + + + + + Indicates the Data Point Line Element + + + + + Indicates the Data Point Marker Element + + + + + Indicates the Data Point Marker Layout Element + + + + + Indicates the Data Point Wireframe Element + + + + + Indicates the Data Table Element + + + + + Indicates the Down Bar Element + + + + + Indicates the Drop Line Element + + + + + Indicates the Error Bar Element + + + + + Indicates the Floor Element + + + + + Indicates the Major grid line Element + + + + + Indicates the Minor grid line Element + + + + + Indicates the High-Low Line Element + + + + + Indicates the Leader Line Element + + + + + Indicates the Legend Element + + + + + Indicates the Plot Area Element + + + + + Indicates the Plot Area 3D Element + + + + + Indicates the Series Axis Element + + + + + Indicates the SeriesLine Element + + + + + Indicates the Title Element + + + + + Indicates the Trendline Element + + + + + Indicates the TrendLine Label Element + + + + + Indicates the Up Bar Element + + + + + Indicates the Value Axis Element + + + + + Indicates the Wall Element + + + + + Indicates the Extension List Element + + + + + Contains the list of color models + + + + + No color models have been used + + + + + expressing Red, Green, Blue color in Percentages. + + + + + specifies the color two hex digits per color, in the order RGB. + + + + + represents a color using the Hue, Saturation, and Luminescence. + + + + + represents a system color, and introduces a level of indirection. + + + + + schemeClr represents a color from a theme. + + + + + prstClr represents a preset color by its name. + + + + + element that specifies a color calculated from a CT_ColorStyle. + + + + + Contains the style entry modifier enumerations + + + + + No modifier enum is applied + + + + + fill properties specified on this StyleEntry can be replaced with no fill instead. + + + + + line properties specified on this StyleEntry can be replaced with no line instead. + + + + + This simple type enumeration specifies how to cap the ends of lines. + + + + + Line ends at end point. + + + + + Rounded ends. Semi-circle protrudes by half line width. + + + + + Square protrudes by half line width. + + + + + Enumeration represents one of the fonts associated with the style. + + + + + (None) No font reference. + + + + + (Minor Font) The minor font of the style's font scheme. + + + + + (Major Font) The major font of the style's font scheme. + + + + + Specifies the quality of the image in chart to image conversion. + + + + + Save the image with normal image quality. + + + + + Save the image with best image quality which results large image size. + + + + + Enumeration represents patterns (pattern names) that are used in Excel 2007. + This enumeration is used to convert pattern from Excel 2003 into 2007 + + + + + The fill style is none (no fill). When foreground and/or background colors + are specified, a pattern of 'none' overrides and means the cell has no fill. + + + + + The fill style is solid. When solid is specified, the foreground color + (fgColor) is the only color rendered, even when a background color + (bgColor) is also specified. + + + + + The fill style is medium gray. + + + + + The fill style is 'dark gray'. + + + + + The fill style is light gray. + + + + + The fill style is dark horizontal. + + + + + The fill style is 'dark vertical'. + + + + + The fill style is 'dark down'. + + + + + The fill style is 'dark up'. + + + + + The fill style is 'dark grid'. + + + + + The fill style is 'dark trellis'. + + + + + The fill style is light horizontal. + + + + + The fill style is light vertical. + + + + + The fill style is 'light down'. + + + + + The fill style is light up. + + + + + The fill style is 'light grid'. + + + + + The fill style is 'light trellis'. + + + + + The fill style is grayscale of 0.125 (1/8) value. + + + + + The fill style is grayscale of 0.0625 (1/16) value. + + + + + The line style of a border in a cell as it is named Excel2007. + + + + + The line style of a border is dash-dot. + + + + + The line style of a border is dash-dot-dot. + + + + + The line style of a border is dashed. + + + + + The line style of a border is dotted. + + + + + The line style of a border is double line. + + + + + The line style of a border is hairline. + + + + + The line style of a border is medium. + + + + + The line style of a border is medium dash-dot. + + + + + The line style of a border is medium dash-dot-dot. + + + + + The line style of a border is medium dashed. + + + + + The line style of a border is none (no border visible). + + + + + The line style of a border is slant-dash-dot. + + + + + The line style of a border is 'thick'. + + + + + The line style of a border is thin. + + + + + Represents border index. + + + + + Represents left border. + + + + + Represents right border. + + + + + Represents top border. + + + + + Represents bottom border. + + + + + Represents diagonal border. + + + + + Represents no border. + + + + + Represents vertical inner border. + + + + + Represents horizontal innver border. + + + + + Represents the Axis labels alignment + + + + + Left alignment + + + + + Center alignment + + + + + Right alignment + + + + + Justify alignment + + + + + Specifies values Indicates the Outer Shadow values + + + + + Indicates No shadow + + + + + Indicates Outer shadow at Right + + + + + Indicates Outer shadow at DiagonalBottomRight + + + + + Indicates Outer shadow at Bottom + + + + + Indicates Outer shadow at DiagonalTopLeft + + + + + Indicates Outer shadow at Center + + + + + Indicates Outer shadow at Top + + + + + Indicates Outer shadow at Left + + + + + Indicates Outer shadow at DiagonalTopRight + + + + + Indicates Outer shadow at DiagonalBottomLeft + + + + + Specifies value indicates the Inner Shadow Values + + + + + Indicates No shadow(Default) + + + + + Indicates Inner Shadow at Diagonal Bottom Left + + + + + Indicates Inner Shadow at Top + + + + + Indicates Inner Shadow at Right + + + + + Indicates Inner Shadow at Left + + + + + Indicates Inner Shadow at TopRight + + + + + Indicates Inner Shadow at Diagonal Bottom Right + + + + + Indicates Inner Shadow at Center + + + + + Indicates Inner Shadow at Bottom + + + + + Indicates Inner Shadow at Diagonal Top left + + + + + Specifies the preset perspective Shadow Type + + + + + Indicates the No Shadow + + + + + Indicates Perspective Shadow at Diagonal Upper Right + + + + + Indicates Perspective Shadow at Diagonal Lower Right + + + + + Indicates Perspective Shadow at Diagonal Upper Left + + + + + Indicates Perspective Shadow at Diagonal Lower Left + + + + + Indicates Perspective Shadow at Below + + + + + Specifies the bevel type of a ThreeDFormat object. + + + + + Indicates a No angle type bevel. + + + + + Indicates a Angle type bevel. + + + + + Indicates a Art Deco type bevel. + + + + + Indicates a Circle type bevel. + + + + + Indicates a Convex type bevel. + + + + + Indicates a Cool Slant type bevel. + + + + + Indicates a Cross type bevel. + + + + + Indicates a Divot type bevel. + + + + + Indicates a Hard Edge type bevel. + + + + + Indicates a Relaxed Inset type bevel. + + + + + Indicates a Riblet type bevel. + + + + + Indicates a Slope type bevel. + + + + + Indicates a Soft round type bevel. + + + + + Specifies the extrusion surface material. + + + + + Indicates No Material Effect + + + + + Indicates Matte Material + + + + + Indicates WarmMatte Material + + + + + Indicates Plastic Material + + + + + Indicates Metal Material + + + + + Indicates Dark Edge Material + + + + + Indicates Soft Edge Material + + + + + Indicates Flat Material + + + + + Indicates Wire Frame Material + + + + + Indicates Powder Material + + + + + Indicates Translucent Powder Material + + + + + Indicates Clear Material + + + + + Specifies the value indicates the Lighting properties for the + Chart + + + + + Indicates ThreePoint Lighting(Default) + + + + + Indicates Balance Lighting + + + + + Indicates Bright Room Lighting + + + + + Indicates Chilly Lighting + + + + + Indicates Contrasting Lighting + + + + + Indicates Flat Lighting + + + + + Indicates Flood Lighting + + + + + Indicates Freezing Lighting + + + + + Indicates Glow Lighting + + + + + Indicates Harsh Lighting + + + + + Indicates Morning Lighting + + + + + Indicates Soft Lighting + + + + + Indicates Sunrise Lighting + + + + + Indicates Sun Set Lighting + + + + + Indicates TwoPoint Lighting + + + + + The enumeration value indicating the portion of Cell Alignment in + a cell format (XF) that is horizontal alignment. + + + + + The horizontal alignment is centered, meaning the text is centered across the cell. + + + + + The horizontal alignment is centered across multiple cells. + + + + + Indicates that each 'word' in each line of text inside the cell is evenly + distributed across the width of the cell, with flush right and left margins. + When there is also an indent value to apply, both the left and right side + of the cell are padded by the indent value. + + + + + Indicates that the value of the cell should be filled across the entire + width of the cell. + + + + + The horizontal alignment is general-aligned. Text data is left-aligned. + Numbers, dates, and times are rightaligned. Boolean types are centered. + Changing the alignment does not change the type of data. + + + + + The horizontal alignment is justified (flush left and right). For each + line of text, aligns each line of the wrapped text in a cell to the right + and left (except the last line). If no single line of text wraps in the + cell, then the text is not justified. + + + + + The horizontal alignment is left-aligned, even in Right-to-Left mode. + Aligns contents at the left edge of the cell. If an indent amount is + specified, the contents of the cell is indented from the left by the + specified number of character spaces. The character spaces are based + on the default font and font size for the workbook. + + + + + The horizontal alignment is right-aligned, meaning that cell contents + are aligned at the right edge of the cell, even in Right-to-Left mode. + + + + + This enumeration value indicates the type of vertical alignment for a cell. + + + + + The vertical alignment is aligned-to-bottom. + + + + + The vertical alignment is centered across the height of the cell. + + + + + When text direction is horizontal: the vertical alignment of lines of text + is distributed vertically, where each line of text inside the cell is evenly + distributed across the height of the cell, with flush top and bottom margins. + When text direction is vertical: behaves exactly as distributed horizontal + alignment. The first words in a line of text (appearing at the top of the cell) + are flush with the top edge of the cell, and the last words of a line of text + are flush with the bottom edge of the cell, and the line of text is distributed + evenly from top to bottom. + + + + + When text direction is horizontal: the vertical alignment of lines of text + is distributed vertically, where each line of text inside the cell is evenly + distributed across the height of the cell, with flush top and bottom margins. + When text direction is vertical: similar behavior as horizontal justification. + The alignment is justified (flush top and bottom in this case). For each line + of text, each line of the wrapped text in a cell is aligned to the top and + bottom (except the last line). If no single line of text wraps in the cell, + then the text is not justified. + + + + + The vertical alignment is aligned-to-top. + + + + + Enumeration which controls visibility of worksheet in Excel. + + + + + Worksheet is visible to the user. + + + + + Worksheet is hidden for the user. + + + + + The strong hidden flag can only be set and cleared with a Visual Basic + macro. It is not possible to make such a sheet visible via the user interface. + + + + + This simple type specifies the possible styles of radar chart. + + + + + Specifies that the radar chart shall have lines but no markers and no fill. + + + + + Specifies that the radar chart shall have lines and markers but no fill. + + + + + Specifies that the radar chart shall be filled and have lines but no markers. + + + + + This simple type specifies the possible styles of scatter chart. + + + + + Specifies the points on the scatter chart shall not be connected with + lines and markers shall be drawn. + + + + + Specifies the the points on the scatter chart shall be connected with + smoothed lines and markers shall be drawn. + + + + + Specifies the the points on the scatter chart shall be connected with + smoothed lines and markers shall not be drawn. + + + + + Specifies the points on the scatter chart shall be connected with + straight lines and markers shall be drawn. + + + + + Specifies the points on the scatter chart shall be connected with + straight lines but markers shall not be drawn. + + + + + Enumeration limits values which can be set by user. + + + + + Represents the Position split type. + + + + + Represents the Value split type. + + + + + Represents the Percent split type. + + + + + Represents the Custom split type. + + + + + + + + + + Specifies that data labels shall be displayed below the data marker. + + + + + Specifies that data labels shall be displayed in the best position. + + + + + Specifies that data labels shall be displayed centered on the data marker. + + + + + Specifies that data labels shall be displayed inside the base of the data marker. + + + + + Specifies that data labels shall be displayed inside the end of the data marker. + + + + + Specifies that data labels shall be displayed to the left of the data marker. + + + + + Specifies that data labels shall be displayed outside the end of the data marker. + + + + + Specifies that data labels shall be displayed to the right of the data marker. + + + + + Specifies that data labels shall be displayed above the data marker.} + + + + + Enumeration of the marker types for Chart lines in Excel. + + + + + Represents the None option for the marker type. + + + + + Represents the square style in the custom marker option for Chart lines. + + + + + Represents the diamond style in the custom marker option for Chart lines. + + + + + Represents the Triangle style in the custom marker option for Chart lines. + + + + + Represents the X style in the custom marker option for Chart lines. + + + + + Represents the Star style in the custom marker option for Chart lines. + + + + + Represents the Dow Jones style in the custom marker option for Chart lines. + + + + + Represents the Standard Deviation style in the custom marker option for Chart lines. + + + + + Represents the Circle style in the custom marker option for Chart lines. + + + + + Represents the Plus style in the custom marker option for Chart lines. + + + + + We don't provide picture marker type support for chart lines.So simply assign none value for picture type. + + + + + Represents trend line values. + + + + + Represents Exponential trend line type. + + + + + Represents Linear trend line type. + + + + + Represents Logarithmic trend line type. + + + + + Represents Moving average trend line type. + + + + + Represents Polynomial trend line type. + + + + + Represents Power trend line type. + + + + + Error-bar type. + + + + + Represents the Percentage error-bar source type. + + + + + Represents the FixedValue error-bar source type. + + + + + Represents the StandardDeviation error-bar source type. + + + + + Represents the Custom error-bar source type. + + + + + Represents the StandardError error-bar source type. + + + + + Enumeration of the legend placement for Charts in Excel. + + + + + Represents the bottom option. + + + + + Represents the Corner option. + + + + + Represents the Top option. + + + + + Represents the Right option. + + + + + Represents the Left option. + + + + + This enumeration specifies the possible ways to display blanks. + + + + + Specifies that blank values shall be left as a gap. + + + + + Specifies that blank values shall be treated as zero. + + + + + Specifies that blank values shall be spanned with a line. + + + + + Represents 5% gradient pattern + + + + + Represents 10% gradient pattern + + + + + Represents 20% gradient pattern + + + + + Represents 25% gradient pattern + + + + + Represents 30% gradient pattern + + + + + Represents 40% gradient pattern + + + + + Represents 50% gradient pattern + + + + + Represents 60% gradient pattern + + + + + Represents 70% gradient pattern + + + + + Represents 75% gradient pattern + + + + + Represents 80% gradient pattern + + + + + Represents 90% gradient pattern + + + + + Represents Dark Downward Diagonal gradient pattern + + + + + Represents Dark Horizontal gradient pattern + + + + + Represents Dark Upward Diagonal gradient pattern + + + + + Represents Dark Vertical gradient pattern + + + + + Represents Dashed Downward Diagonal gradient pattern + + + + + Represents Dashed Horizontal gradient pattern + + + + + Represents Dashed Upward Diagonal gradient pattern + + + + + Represents Dashed Vertical gradient pattern + + + + + Represents Diagonal Brick gradient pattern + + + + + Represents Divot gradient pattern + + + + + Represents Dotted Diamond gradient pattern + + + + + Represents Dotted Grid gradient pattern + + + + + Represents Horizontal Brick gradient pattern + + + + + Represents Large Checker Board gradient pattern + + + + + Represents Large Confetti gradient pattern + + + + + Represents Large Grid gradient pattern + + + + + Represents Light Downward Diagonal gradient pattern + + + + + Represents Light Horizontal gradient pattern + + + + + Represents Light Upward Diagonal gradient pattern + + + + + Represents Light Vertical gradient pattern + + + + + Represents Narrow Horizontal gradient pattern + + + + + Represents Narrow Vertical gradient pattern + + + + + Represents Outlined Diamond gradient pattern + + + + + Represents Plaid gradient pattern + + + + + Represents Shingle gradient pattern + + + + + Represents Small Checker Board gradient pattern + + + + + Represents Small Confetti gradient pattern + + + + + Represents Small Grid gradient pattern + + + + + Represents Solid Diamond gradient pattern + + + + + Represents Sphere gradient pattern + + + + + Represents Trellis gradient pattern + + + + + Represents Wave gradient pattern + + + + + Represents Weave gradient pattern + + + + + Represents Wide Downward Diagonal gradient pattern + + + + + Represents Wide Upward Diagonal gradient pattern + + + + + Represents Zig Zag gradient pattern + + + + + Represents excel 2007 chart uint to display. + + + + + Represents Hundreds display Unit + + + + + Represents Thousands display Unit + + + + + Represents TenThousands display Unit + + + + + Represents HundredThousands display Unit + + + + + Represents Millions display Unit + + + + + Represents TenMillions display Unit + + + + + Represents HundredMillions display Unit + + + + + Represents ThousandMillions display Unit + + + + + Represents MillionMillions display Unit + + + + + Possible types for row data storage. + + + + + Uses Win32 API and Marshal class calls to allocate and work with memory blocks. + + + + + Uses Win32 API and unsafe blocks to allocate and work with memory blocks. + + + + + Uses managed byte array and other managed functions to work with memory blocks. + This method is slowest, but it is the only one suitable for medium trust mode. + + + + + Possible icon set types. + + + + + 3 arrows icon set. + + + + + 3 gray arrows icon set. + + + + + 3 flags icon set. + + + + + 3 traffic lights icon set (#1). + + + + + 3 traffic lights icon set with thick black border. + + + + + 3 signs icon set. + + + + + 3 symbols icon set. + + + + + 3 Symbols icon set. + + + + + 4 arrows icon set. + + + + + 4 gray arrows icon set. + + + + + 4 'red to black' icon set. + + + + + 4 ratings icon set. + + + + + 4 traffic lights icon set. + + + + + 5 arrows icon set. + + + + + 5 gray arrows icon set. + + + + + 5 rating icon set. + + + + + 5 quarters icon set. + + + + + If there is vertical text, determines what type of vertical text is going to be used. + + + + + Horizontal text. This should be default. + + + + + Determines if all of the text is vertical ("one letter on top of another"). + + + + + Determines if all of the text is vertical orientation (each line is 90 + degrees rotated clockwise, so it goes from top to bottom; each next + line is to the left from the previous one). + + + + + Determines if all of the text is vertical orientation (each line is 270 + degrees rotated clockwise, so it goes from bottom to top; each next line + is to the right from the previous one). + + + + + A special version of vertical text, where some fonts are displayed as if rotated + by 90 degrees while some fonts (mostly East Asian) are displayed vertical. + + + + + A special version of vertical text, where some fonts are displayed as if + rotated by 90 degrees while some fonts (mostly East Asian) are displayed + vertical. The difference between this and the eastAsianVertical is the + text flows top down then LEFT RIGHT, instead of RIGHT LEFT. + + + + + Specifies that vertical WordArt should be shown from right to left rather than left to right. + + + + + Enumeration to align the excel comment Horizontally. + + + + + Represents the Left comment align. + + + + + Represents the Center comment align. + + + + + Represents the Right comment align. + + + + + Represents the Justified comment align. + + + + + Represents the Distributed comment align. + + + + + This type specifies a list of available anchoring types for text. + + + + + Anchor the text at the top of the bounding rectangle. + + + + + Anchor the text at the middle of the bounding rectangle. + + + + + Anchor the text at the bottom of the bounding rectangle. + + + + + Anchor the text so that it is justified vertically. + + + + + Anchor the text so that it is distributed vertically. + + + + + Represents line style. + + + + + Represents single line style. + + + + + Represents thin thin line style. + + + + + Represents thin thick line style. + + + + + Represents thick thin line style. + + + + + Represents thick between thin line style. + + + + + Represents functions added in Excel 2007. + + + + + Returns a key performance indicator (KPI) name, property, and measure, and displays the name and property in the cell. A KPI is a quantifiable measurement, such as monthly gross profit or quarterly employee turnover, used to monitor an organization's performance. + + + + + Returns a member or tuple in a cube hierarchy. Use to validate that the member or tuple exists in the cube. + + + + + Returns the value of a member property in the cube. Use to validate that a member name exists within the cube and to return the specified property for this member. + + + + + Returns the nth, or ranked, member in a set. Use to return one or more elements in a set, such as the top sales performer or top 10 students. + + + + + Defines a calculated set of members or tuples by sending a set expression to the cube on the server, which creates the set, and then returns that set to Microsoft Office Excel. + + + + + Returns the number of items in a set. + + + + + Returns an aggregated value from a cube. + + + + + Returns the modified Bessel function In(x). + + + + + Returns the Bessel function Jn(x). + + + + + Returns the modified Bessel function Kn(x). + + + + + Returns the Bessel function Yn(x). + + + + + Converts a binary number to decimal. + + + + + Converts a binary number to hexadecimal. + + + + + Converts a binary number to octal. + + + + + Converts real and imaginary coefficients into a complex number. + + + + + Converts a number from one measurement system to another. + + + + + Converts a decimal number to binary. + + + + + Converts a decimal number to hexadecimal. + + + + + Converts a decimal number to octal. + + + + + Tests whether two values are equal. + + + + + Returns the error function. + + + + + Returns the complementary error function. + + + + + Tests whether a number is greater than a threshold value. + + + + + Converts a hexadecimal number to binary. + + + + + Converts a hexadecimal number to decimal. + + + + + Converts a hexadecimal number to octal. + + + + + Returns the absolute value (modulus) of a complex number. + + + + + Returns the imaginary coefficient of a complex number. + + + + + Returns the argument theta, an angle expressed in radians. + + + + + Returns the complex conjugate of a complex number. + + + + + Returns the cosine of a complex number + + + + + Returns the quotient of two complex numbers. + + + + + Returns the exponential of a complex number. + + + + + Returns the natural logarithm of a complex number. + + + + + Returns the base-10 logarithm of a complex number. + + + + + Returns the base-2 logarithm of a complex number. + + + + + Returns a complex number raised to an integer power. + + + + + Returns the product of from 2 to 29 complex numbers + + + + + Returns the real coefficient of a complex number + + + + + Returns the sine of a complex number + + + + + Returns the square root of a complex number + + + + + Returns the difference between two complex numbers + + + + + Returns the sum of complex numbers. + + + + + Converts an octal number to binary. + + + + + Converts an octal number to decimal. + + + + + Converts an octal number to hexadecimal. + + + + + Adds the cells in a range that meet multiple criteria + + + + + Returns the average (arithmetic mean) of all the cells in a range that meet a given criteria + + + + + Returns the average (arithmetic mean) of all cells that meet multiple criteria. + + + + + Specifies the value indicates the layout modes for the chart. + + + + + Indicates the layout mode is automatic + + + + + Indicates the width or Height shall be interpreted as the + Right or Bottom of the chart element + + + + + Indicates the Width or Height shall be interpreted as the + Width or Height of the chart element + + + + + Specifies the value indicates the layout targets for the chart. + + + + + Indicates the layout target is automatic. + + + + + Indicates the plot area size shall determine the size of the plot area, + not including the tick marks and axis labels + + + + + Indicates the plot area size + shall determine the size of the plot area, the tick marks, and the axis labels + + + + + Represents an Custom Addin Function in Excel. + + + + + Returns name of the add-in function. Read-only. + + + + + Event arguments for notifying read progress. + + + + + Current read position. + + + + + Full stream size. + + + + + Creates new instance of the event arguments. + + Current read position. + Full stream size. + + + + Current read position. + + + + + Full stream size. + + + + + Progress event handler delegate + + + + + Represents an Autofilter in an Excel worksheet. + + + + + First condition of autofilter. + + + + + Second condition of autofilter. + + + + + False indicates that this autofilter was not used; otherwise True. Read-only. + + + + + True means to use AND operation between conditions, + False to use OR. Read-only. + + + + + True if the Top 10 AutoFilter shows percentage; + False if it shows items. Read-only. + + + + + True if the first condition is a simple equality. Read-only. + + + + + True if the second condition is a simple equality. Read-only. + + + + + True if the Top 10 AutoFilter shows the top items; + False if it shows the bottom items. + + + + + True if the condition is a Top 10 AutoFilter. + + + + + Number of elements to show in Top10 mode. + + + + + Represents the autofilter conditions. + + + + + Data type. + + + + + Comparison operator. + + + + + String value. + + + + + Boolean value. Read-only. + + + + + Error code. Read-only. + + + + + Floating-point value. + + + + + Represents single worksheet custom property. + + + + + Returns the name of the property. + + + + + Gets sets the value of the custom property. + + + + + Engine for parsing and creation of header/footer strings. + + + + + Parses text of header/footer part. + + Text of header/footer part. + + + + Returns string in format that is supported by Excel header/footer. + + String in format that is supported by Excel header/footer. + + + + Represents a Merged Cell. + + + + + Merges all cells in cellRange. + + + + + + + + + + If specified cell is contained in merged cell, delete that merge. + + + + + + This interface is used to perform some action on demand. + + + + + Performs required operation. + + + + + This interface is used to get shapes from worksheet. + + + + + Returns a shape collection from the worksheet. + + Worksheet to return sheet data for. + A shape collection from the worksheet. + + + + Represents a vertical page break. The VPageBreak object is a member + of the VPageBreaks collection. + + + + + Used without an object qualifier, this property returns an + Application object that represents the Excel application. + + + + + For the HPageBreak and VPageBreak objects, this property returns or + sets the cell (a Range object) that defines the page-break location. + Horizontal page breaks are aligned with the top edge of the location + cell; vertical page breaks are aligned with the left edge of the + location cell. Read / write Range. + + + + + Returns the parent object for the specified object. + + + + + Interface that represents single GradientStop of the gradient fill. + + + + + Gets / sets color. + + + + + Gets / sets position of the GradientStop. + + + + + Gets / sets transparency value. + + + + + This interface must be implemented by all xml serializators. + + + + + Saves workbook into writer. + + Writer to save workbook into. + Workbook to save. + + + + Event arguments for ReadOnlyFile event. + + + + + Indicates if file should be rewritten, default - False. + + + + + Indicates whether Read-only file should be rewritten. + + + + + Event arguments for PasswordRequired event. + + + + + Indicates whether we should stop parsing protected workbook. + + + + + New password to try. + + + + + Indicates whether we should stop parsing protected workbook. + + + + + New password to try. + + + + + Represents the method that will handle the ReadOnlyFile event. + + + + + Represents the method that will handle the PasswordRequired event. + + + + + Represents the method that will handle the PasswordRequired event. + + + + + Each cell range address (called an ADDR structure) contains 4 16-bit values. + Cell range address, BIFF8: + + + + + Index to first row. + + + + + Index to last row. + + + + + Index to first column. + + + + + Index to last column. + + + + + Initializes new instance. + + First row. + First column. + Last row. + Last column. + + + + Initializes new instance. + + Index of the top left cell. + Index of the bottom right cell. + + + + Initializes new instance. + + Rectangle containing initialization data. + + + + Converts object to the string. + + + + + Converts structure to rectangle. + + Created rectangle. + + + + Index to first column. + + + + + Index to first row. + + + + + Index to last column. + + + + + Index to last row. + + + + + Summary description for ArrayRecord. + + + + + + + + + + + Default size of the inner collections. + + + + + Maximum size of a record. + + + + + Maximum size of a record with header. + + + + + Size of the records header. + + + + + Number of bits in byte. + + + + + Number of bits in short. + + + + + Number of bits in int. + + + + + Used to optimize reflection typed extracting. + TBiffRecord - to - ReflectionCachePair + + + + + + + + + + Skips begin - end block and sub blocks. + + Record storage. + Position in storage. + Returns index after skipping. + + + + Code of the Biff record. + + + + + Length of the Biff record data. + + + + + Indicates whether m_data array need to be Infilled before usage. + + + + + Gets value with all bits that do not correspond + to the specified mask to zero. + + Unsigned Int16 value. + Bit mask. + + Value with all bits that do not correspond + to the specified mask to zero. + + + + + Sets the value with all bits that correspond to the specified + mask of zero to the same values as in the value. + + Variable that bits of which will be set. + Bit mask. + Value from which bit values will be taken. + + + + Gets value with all bits that do not correspond + to the specified mask to zero. + + Unsigned Int32 value. + Bit mask. + + Value with all bits that do not correspond + to the specified mask to zero. + + + + + Sets the value with all bits that correspond to the specified + mask to zero to the same values as in value. + + Variable that bits of which will be set. + Bit mask. + Value from which bit values will be taken. + + + + Default constructor, gets code value using reflection and attributes. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array iReserve bytes. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Method which updates the fields of record which contain stream offset + or other data. This method must be called before save operation. + + Array with all records. + + When not overridden in descendant class. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Array that contains record's data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + Returns size of the required storage space. + + Excel version. + Size of the required storage space. + + + + Checks offset and length of the array. + + Array to check. + Start offset. + Length of the data. + + + + Get array of bytes from internal record data. + + + Offset of first byte of data to get. + Length of required array. + Array of bytes from internal record data. + + If offset is less than zero or more than internal record data array size + or length is less than zero or more than internal record data array size + or length plus offset is more than internal record data array size. + + + + + Gets single byte from internal record data using GetBytes. + + Source byte array. + Offset of byte to get. + Single byte from internal record data. + + + + Gets ushort from internal record data using GetBytes. + + Source byte array. + Offset in bytes of ushort to get. + Ushort from internal record data. + + + + Gets short from internal record data using GetBytes. + + Source byte array. + Offset in bytes of short to get. + Short from internal record. + + + + Gets int from internal record data using GetBytes. + + Source byte array. + Offset in bytes of int to get. + Int from internal record. + + + + Gets single bit from internal record data using GetBytes. + + Source byte array. + Offset of the byte that contains needed bit. + Position of bit in the byte. + True if specified bit is set to 1; otherwise False. + + bitPos argument should be not less than zero and not more than 7. + + + + + Gets single bit from internal record data using GetBytes. + + Source memory block. + Offset of the byte that contains needed bit. + Position of bit in the byte. + True if specified bit is set to 1; otherwise False. + + bitPos argument should be not less than zero and not more than 7. + + + + + Searches for the next break. + + List of breaks. + Number of elements in the list. + Current break position. + Start index in the array. + Next break. + + + + Sets ushort in internal record data array using SetBytes method. + + Byte array list. + Offset to the required value. + New value for the specified ushort. + + + + Sets one bit in specified byte in internal record data array. + + Array where byte is located.. + Offset of the byte in the data array. + Bit position in the byte. + Value of bit. + + If bitPos is less than zero or more than 7. + + + + + Sets short in internal record data array using SetBytes method. + + Array where value should be placed located. + Offset to the required value. + New value for the specified short. + + + + Sets int in internal record data array using SetBytes method. + + Array where value should be placed located. + Offset to the required value. + New value for the specified int. + + + + Sets uint in internal record data array using SetBytes method. + + Array where value should be placed located. + Offset to the required value. + New value for the specified uint. + + + + Sets double in internal record data array using SetBytes method. + + Array where value should be placed. + Offset to the required value. + New value for the specified double. + + + + Sets string in internal record data array using SetBytes method + without string length, updates offset parameter (adds string length). + + Array where value should be placed located. + Offset to the string. + Value of the string. + + + + Sets string in internal record data array using SetBytes method. + The String length is saved in one byte. + + Array where value should be placed located. + Offset to the string. + Value of the string. + + + + Sets bytes in internal record data array values. + + Buffer to copy bytes into. + Offset in internal record data array to start from. + Array of bytes to set. + Position in value array to the data that will be set. + Length of the data. + If value array is NULL. + + If pos or length would be less than zero or their sum would be more + than size of value array. + + + If internal record data array is too small for receiving value array + and AutoGrowData is False. + + + + + Sets one bit in specified ushort. + + Offset of the byte in the internal record data array. + Value of bit. + Bit position in the byte. + + If bitPos is less than zero or more than 7. + + + + + Sets one bit in specified uint. + + Offset of the byte in the internal record data array. + Value of bit. + Bit position in the byte. + + If bitPos is less than zero or more than 7. + + + + + Return size in bytes for string with 16-bit length field. + + String to measure. + Indicates whether string should be compressed or not. + Size in bytes for string with 16-bit length field. + + + + Clears data. + + + + + Compares two Biff records. + + Biff record that should be compared with this Biff record. + True if this instance and extFormat contain the same data. + + + + Copies data from the current Biff record to the specified Biff record. + + Biff record that will receive data from the current record. + + When this record and parameter have different types. + + + + + Checked typeCode. + + TypeCode to check. + + + + + + + + + + + + + + + + + + + + + + + Sets record code. + + Code to set. + + + + Clone current Record. + + Returns memberwise clone on current object. + + + + Combines several byte arrays into one. + + Length of combined array. + List that contains byte arrays to combine. + Combined array. + + + + + + + + + + + + + + Copies string data into array of bytes without string length field. + + Destination array. + Offset to the string. + Value of the string. + Size of the string in bytes. + + + + Sets string in internal record data array using SetBytes method. + The String length is saved in two bytes + + Destination array. + Offset to the string. + Value of the string. + + + + Returns value of the single bit from byte. + + Byte to get bit value from. + Bit index. + Value of the single bit from byte. + + + + Returns value of the single bit from byte. + + Int16 to get bit value from. + Bit index. + Value of the single bit from byte. + + + + Returns value of the single bit from byte. + + UInt16 to get bit value from. + Bit index. + Value of the single bit from byte. + + + + Returns value of the single bit from byte. + + Byte to get bit value from. + Bit index. + Value of the single bit from byte. + + + + Returns value of the single bit from UInt32. + + UInt32 to get bit value from. + Bit index. + Value of the single bit from byte. + + + + Sets one bit in specified Int32. + + Int32 to set bit. + Bit position in the byte + Value of bit + + If bitPos is less than zero or more than 7 + + Value after + + + + Reads data array from another data array. + + Source array. + Source offset. + Destination array. + Updated source offset. + + + + Read-only. Will get record type if known; + otherwise it will get TBIFFRecord.Unknown. + + + + + Read-only. Returns integer value which is the unique identifier + of Biff record. + + + + + Gets / sets length of internal data array. + + + + + Read-only. Returns record data. + + + + + If True, the array will automatically grow when the offset limit + is reached. This is required when the real record size is not known for an + Infill operation. Will throw exception on buffer offset overrun + when set to False. Default value is False. + + + + + Indicates record position in stream. This is a utility member of class and + is used only in the serialization process. Does not influence the data. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Maximum memory size for internal buffer. + + + + + Indicates whether record needs to infill internal data array. + + + + + Indicates whether record needs internal data array + or if it can be cleaned. Read-only. + + + + + Indicates whether record allows shorter data. Read-only. + + + + + Indicates whether record need decoding when file is encoded or not. Read-only. + + + + + Returns offset in the data array where encoded/decoded data should start. Read-only. + + + + + + + + + + Interface for shared formula and array formula. + + + + + Index to first row of the array formula range. + + + + + Index to last row of the array formula range. + + + + + Index to first column of the array formula range. + + + + + Index to last column of the array formula range. + + + + + Parsed formula. + + + + + Summary description for IFormulaRecord. + + + + + Gets/sets parsed formula tokens. + + + + + Minimum size of the record. + + + + + Offset to the formula data. + + + + + First row. + + + + + Last row. + + + + + First row. + + + + + Last row. + + + + + Option flags. + + + + + Indicates whether formula value should always be recalculated. + + + + + Indicates whether formula value should be recalculated when the file is opened. + + + + + Unused must be 0. + + + + + Length of the parsed expression. + + + + + Formula expression. + + + + + + + + + + Default Constructor. + + + + + Read / initialize Constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for the record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Size of the required storage space. Read-only. + + + + + Serializes area that is covered by array formula. + + Object that contains dimensions data. + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Updated offset. + + + + Serializes area that is covered by array formula. + + Object that receives dimensions data. + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Updated offset. + + + + 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. + + + + Serves as a hash function for a particular type. + + A hash code for the current Object. + + + + + + + + + + Index to first row of the array formula range. Zero-based. + + + + + Index to last row of the array formula range. Zero-based. + + + + + Index to first column of the array formula range. Zero-based. + + + + + Index to last column of the array formula range. Zero-based. + + + + + Read-only. Size of the formula data. + + + + + Token array of the shared formula. + + + + + + + + + + Read-only. Reserved. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Indicates whether formula value should be always recalculated. + + + + + Indicates whether formula value should be recalculated when the file is opened. + + + + + Option flags. + + + + + This record is part of the Page Settings Block. + It stores the background bitmap of a worksheet. + + + + + BifRecords container. + + + + + Summary description for BiffRecordRawWithArray. + + + + + Array that contains record data. + + + + + True if internal data array will be automatically resized + if there is not enough space for record data. + + + + + Default constructor, gets code value using reflection and attributes. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array iReserve bytes. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, the class must pack all of its properties into + an internal Data array: m_data. This method is called by + FillStream, when the record must be serialized into stream. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + + + Get array of bytes from internal record data. + + Offset of first byte of data to get. + Length of required array. + Array of bytes from internal record data. + + If offset is less than zero or more than internal record data array size + or length is less than zero or more than internal record data array size + or length plus offset is more than internal record data array size. + + + + + Gets single byte from internal record data using GetBytes. + + Offset of byte to get. + Single byte from internal record data. + + + + Gets ushort from internal record data using GetBytes. + + Offset in bytes of ushort to get. + Ushort from internal record data. + + + + Gets short from internal record data using GetBytes. + + Offset in bytes of short to get. + Short from internal record. + + + + Gets int from internal record data using GetBytes. + + Offset in bytes of int to get. + Int from internal record. + + + + Gets uint from internal record data using GetBytes. + + Offset in bytes of uint to get. + Uint from internal record data. + + + + Gets long from internal record data using GetBytes. + + Offset in bytes of long to get. + Long from internal record data. + + + + Gets ulong from internal record data using GetBytes. + + Offset in bytes of ulong to get. + Ulong from internal record data. + + + + Gets float from internal record data using GetBytes. + + Offset in bytes of float to get. + Float from internal record data. + + + + Gets double from internal record data using GetBytes. + + Offset in bytes of double to get. + Double from internal record data. + + + + Gets single bit from internal record data using GetBytes. + + Offset of the byte that contains needed bit. + Position of bit in the byte. + True if specified bit is set to 1; otherwise False. + + bitPos argument should be not less than zero and not more than 7. + + + + + Gets string from internal record data using GetBytes, + and it increases the offset by string size in bytes. + + Offset of starting byte. + Indicates whether extracted string is ascii string (not unicode). + Retrieved string. + + if Offset + iStrLen is out of data array + + + + + Gets string from internal record data using GetBytes, + and it increases the offset by string size in bytes. + + Offset of starting byte. + Retrieved string. + + if Offset + iStrLen is out of data array + + + + + Gets string from internal record data using GetBytes + and it increases offset by string size in bytes. + + Offset of starting byte. + Length of the string. + Retrieved string. + + if Offset + iStrLen is out of data array + + + + + Gets string from internal record data using GetBytes. + + Offset of starting byte. + Retrieved string. + + if Offset + iStrLen is out of data array + + + + + Gets string from internal record data using GetBytes. + + Offset of starting byte. + Returns size of the read data. + Retrieved string. + + if Offset + iStrLen is out of data array + + + + + Gets string from internal record data using GetBytes. + + Offset of starting byte. + Length of the string. + Retrieved string. + + if Offset + iStrLen is out of data array + + + + + Gets string from internal record data using GetBytes. + + Offset of starting byte. + Length of the string. + Gets bytes count that this string occupies in the data array. + Retrieved string. + + + + Gets string from internal record data using GetBytes. + + Offset of starting byte. + Length of the string. + Gets bytes count that this string occupies in the data array. + Flag for is bytes count available. + Retrieved string. + + + + Detect type of string and extracts it. + + Record data offset. + Contain next position. + Number of elements in the continuePos collection. + Current index in the continuePos array. + Length of string record. + Array of rich formatting values. + Array of unknown FarEast data. + Extracted string. + + + + Gets TAddr structure from internal record data. + + Offset in bytes of TAddr structure to get. + Retrieved TAddr structure. + + + + Gets TAddr structure from internal record data. + + Offset in bytes of TAddr structure to get. + Retrieved TAddr structure. + + + + Enlarges the internal record data array to facilitate + at least offset + length of data to be placed. + + Offset to the accessed data. + Length of the needed data. + + + + Reserve memory for internal array. + + Number of bytes that should be reserved. + + + + Sets bytes in internal record data array values. + + Offset in internal record data array to start from. + Array of bytes to set. + Position in value array to the data that will be set. + Length of the data. + If value array is NULL. + + If pos or length would be less than zero or their sum would be more + than size of value array. + + + If internal record data array is too small for receiving value array + and AutoGrowData is False. + + + + + Sets bytes in internal record data array values. + + Offset in internal record data array to start from. + Array of bytes to set. + If value array is NULL. + + If pos or length would be less than zero or their sum would be more + than size of value array. + + + If internal record data array is too small for receiving value array + and AutoGrowData is False. + + + + + Sets single byte in internal record data array using SetBytes method. + + Offset to the required byte. + New value for the byte. + + + + + + + + + + + + Sets ushort in internal record data array using SetBytes method. + + Offset to the required value. + New value for the specified ushort. + + + + Sets short in internal record data array using SetBytes method. + + Offset to the required value. + New value for the specified short. + + + + Sets int in internal record data array using SetBytes method. + + Offset to the required value. + New value for the specified int. + + + + Sets uint in internal record data array using SetBytes method. + + Offset to the required value. + New value for the specified uint. + + + + Sets long in internal record data array using SetBytes method. + + Offset to the required value. + New value for the specified long. + + + + Sets ulong in internal record data array using SetBytes method. + + Offset to the required value. + New value for the specified ulong. + + + + Sets float in internal record data array using SetBytes method. + + Offset to the required value. + New value for the specified float. + + + + Sets double in internal record data array using SetBytes method. + + Offset to the required value. + New value for the specified double. + + + + Sets one bit in specified byte in internal record data array. + + Offset of the byte in the internal record data array. + Value of bit. + Bit position in the byte. + + If bitPos is less than zero or more than 7. + + + + + Sets string in internal record data array using SetBytes method + without string length, updates offset parameter (adds string length). + + Offset to the string. + Value of the string. + Indicates whether string should be compressed or not. + + + + Sets string in internal record data array using SetBytes method + without string length. + + Offset to the string. + Value of the string. + Size of the string in bytes. + + + + Detects whether specified string contains only characters supported by ASCII encoding. + + String to check. + True if this string is fully supported by ASCII encoding. + + + + Sets string in internal record data array using SetBytes method + without string length. + + Offset to the string. + Value of the string. + Size of the string in bytes. + + + + Sets string in internal record data array using SetBytes method + without string length. + + Offset to the string. + Value of the string. + Indicates whether write compressed attribute for empty strings. + Indicates whether to write compressed (ascii) string or not. + Size of the string in bytes. + + + + Sets string in internal record data array using SetBytes method. + The String length is saved in one byte. + + Offset to the string. + Value of the string. + Size of the string data. + + + + Sets string in internal record data array using SetBytes method. + The String length is saved in two bytes. + + Offset to the string. + Value of the string. + Size of the string in bytes. + + + + Sets string in internal record data array using SetBytes method. + The String length is saved in two bytes. + + Offset to the string. + Value of the string. + Indicates whether write compressed attribute for empty strings. + Indicates whether string should be compressed or not. + Size of the string in bytes. + + + + Sets string in internal record data array using SetBytes method. + The String length is saved in two bytes + + Offset to the string. + Value of the string. + + + + Sets string in internal record data array using SetBytes method. + The String length is saved in two bytes + + Offset to the string. + Value of the string. + Indicates whether string should be compressed or not. + + + + Sets TAddr structure in internal record data. + + Offset in bytes of TAddr structure to set. + New value of the TAddr at the specified position. + + + + Sets TAddr structure in internal record data. + + Offset in bytes of TAddr structure to set. + New value of the Rectangle at the specified position. + + + + Method extracts from class its fields which have the custom attribute: + BiffRecordPosAttribute. Method returns two arrays sorted in special + order, the order of extraction and saving from/to stream. + + Returns Sorted Fields. + + + + Algorithm extracts field values from internal data storage. + + + + + Gets value of the field by BiffRecordPosAttribute. + + BiffRecordPosAttribute that describes required field. + Value of the field. + + + + Method tries by metadata information fill internal array + of record. + + Size of the filled data. + + + + Sets the value of the specified field. + + BiffRecordPosAttribute that describes required field. + New field value. + Size of the used data. + + + + Clears internal data array. + + + + + Compares two Biff records. + + Biff record that should be compared with this Biff record. + True if this instance and extFormat contain the same data. + + + + Copies data from the current Biff record to the specified Biff record. + + Biff record that will receive data from the current record. + + When this record and parameter have different types. + + + + + + + + + + + + + + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + + + + Size of the required storage space. Read-only. + + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + + + + + + Read-only. Returns record data. + + + + + If True, the array will automatically grow when the offset limit + is reached. This is required when the real record size is not known for an + Infill operation. Will throw exception on buffer offset overrun + when set to False. Default value is False. + + + + + + + + + + + + + + + Array that contains positions of data of the continue records + in the m_data array. + + + + + + + + + + Default constructor fills all data with default values. + + + + + This method constitutes the main part of parsing with continue records. + For inheritors this method must be called to get Continue records + which is placed after this record in the input stream. + + + + + + + + + + Creates continue record builder. + + Created builder. + + + + Extracts all continue records from the stream if needed and updates internal data array. + + True if there was extracted any continue record. + + + + Returns List with byte arrays with continue record's data. + + Full length of the additional data. + Last position in the stream. + List with byte arrays with continue record's data. + + + + Adds record data from single record to the List. + + List to add data to. + Record to add data from. + Size of the added data. + + + + OnFirstContinue event handler. + + Event sender. + Event arguments. + + + + + + + + + + Creates copy of the current object. + + A copy of the current object. + + + + + + + + + Pixel rows in bitmap are aligned to this number of bytes. + + + + + Header start. + + + + + Unknown value. + + + + + Unknown value. + + + + + Total size of the following record data, without this field (including CONTINUE records). + + + + + Header structure size. + + + + + Width of the picture, in pixel. + + + + + Height of the picture, in pixel. + + + + + Number of planes, must be 1. + + + + + Color depth, must be 24 bit true-color. + + + + + Image contained in the record. + + + + + Allocated unmanaged memory. + + + + + Default Constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, the class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + + + + Infills record header. + + Size of the record header. + + + + Total size of the following record data, without this field (including CONTINUE records). + + + + + Header structure size. + + + + + Image. + + + + + This record represents an empty cell. + It contains the cell address and formatting information. + + + + + This is parent class for all records that have cell position elements inside. + + + + + Zero-based row index. + + + + + Zero-based column index. + + + + + Index to the cell's extended format. + + + + + Default constructor + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + Returns size of the required storage space. + + Excel version. + Size of the required storage space. + + + + Row zero-based index. + + + + + Column zero-based index. + + + + + Index of extended format. + + + + + Size of the record's data. + + + + + Record size with header. + + + + + Default constructor that fills all data with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + Returns size of the required storage space. + + Excel version. + Size of the required storage space. + + + + Read-only. Returns minimum possible size of the record's + internal data array. + + + + + Read-only. Returns maximum possible size of the record's + internal data array. + + + + + Summary description for BOFRecord. + It is used for the beginning of a set of + records that have a particular purpose or subject. + Used in sheets and workbooks. + + + + + Represents the record size. + + + + + Version: + + + + + Type of the following data: + + + + + Build identifier: + + + + + Build year: + + + + + File history flag: + + + + + Lowest Excel version that can read all records in this file: + + + + + + + + + + Default Constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Type of the following data: + + + + + Read-only. Returns minimum possible size of record. + + + + + Read-only. Returns maximum possible size of record. + + + + + Indicates whether record allows shorter data. Read-only. + + + + + Indicates whether record need decoding when file is encoded or not. Read-only. + + + + + This enum that describes all possible data after this BOF record. + + + + + Represents the workbook data. + + + + + Represents the vb_module data. + + + + + Represents the worksheet data. + + + + + Represents the chart data. + + + + + Represents the excel_4_macro data. + + + + + Represents the workspace file data. + + + + + This record represents a Boolean value or error value cell. + + + + + Interface for records that have Value property. + + + + + Value of the record. + + + + + Size of the record. + + + + + Boolean or error value (type depends on the m_bIsErrorCode). + + + + + False = Boolean value; True = Error code. + + + + + Default Constructor that fills all data with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + Returns size of the required storage space. + + Excel version. + Size of the required storage space. + + + + Reads record's value from the data provider. + + Provider to read data from. + Offset to the record's start. + Excel version that was used to infill. + Record's value (BoolOrError and IsErrorCode). + + + + Boolean or error value (type depends on the IsError property). + + + + + False = Boolean value; True = Error code. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Value of the record. + + + + + + Summary description for BoundSheetRecord. + This record is located in the workbook globals area and represents a sheet inside + of the workbook. A record is written for each sheet. It stores the sheet name and + a stream offset to the BOF record within the workbook stream. + + + + + Absolute stream position of the BOF record of the sheet represented by this record. + + + + + Options: Visibility and sheet type. + + + + + Sheet type: + 0x00 = Worksheet + 0x02 = Chart + 0x06 = Visual Basic module + + + + + Sheet name. + + + + + Helper field of record. Value is not stored as a record structure field. + This index is used by the UpdateOffsets method for detecting the corresponding BOF + field. + + + + + BOF record that should be referenced. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Size of the required storage space. Read-only. + + + + + Read-only. Returns minimum possible size of the record's + internal data array. + + + + + Returns offset in the data array where encoded/decoded data should start. Read-only. + + + + + Possible sheet types. + + + + + Represents the Worksheet sheet type. + + + + + Represents the Chart sheet type. + + + + + Represents the VisualBasicModule sheet type. + + + + + Summary description for ByteArrayDataProvider. + + + + + Summary description for DataProvider. + + + + + Default constructor. + + + + + + + + + + Returns bit value at the specified position. + + Offset to the required value. + Bit index in the byte. + Bit at the specified position. + + + + Returns byte value at the specified position. + + Offset to the required value. + Byte at the specified position. + + + + Returns boolean value at the specified position. + + Offset to the required value. + Byte at the specified position. + + + + Returns Int16 value at the specified position. + + Offset to the required value. + Int16 value at the specified position. + + + + Returns UInt16 value at the specified position. + + Offset to the required value. + Int16 value at the specified position. + + + + Returns Int32 value at the specified position. + + Offset to the required value. + Int32 value at the specified position. + + + + Returns Int32 value at the specified position. + + Offset to the required value. + Int32 value at the specified position. + + + + Returns Int32 value at the specified position. + + Offset to the required value. + Int32 value at the specified position. + + + + Returns Int32 value at the specified position. + + Offset to the required value. + Int32 value at the specified position. + + + + Copies data from internal storage into specified data array. + + Source offset. + Destination array. + Destination offset. + Size in bytes of the data to copy. + + + + Copies data from internal storage into specified provider. + + Source offset. + Destination provider. + Destination offset. + Size in bytes of the data to copy. + + + + Reads data from BinaryReader. + + Reader to get data from. + Offset in the internal data to start filling from. + Number of bytes to read. + Temporary buffer to use. + + + + Gets string from internal data and returns it's length in iFullLength parameter. + + Offset to the string data. + Length of the string in bytes. + Parsed string. + + When data array is smaller than the string that should be in it. + + + + + Gets string from internal data and updates offset. + + Offset to the string data. + Parsed string. + + When data array is smaller than the string that should be in it. + + + + + Gets string from byte array and returns it's length in iFullLength parameter. + + Offset to the string data. + Length of the string in bytes. + Parsed string. + + When data array is smaller than the string that should be in it. + + + + + Reads data array from another data array. + + Source offset. + Destination array. + Updated source offset. + + + + Reads data array from another data array. + + Source offset. + Destination array. + Number of bytes to read. + Updated source offset. + + + + Gets string from internal record data using GetBytes. + + Offset of starting byte. + Length of the string. + Gets bytes count that this string occupies in the data array. + Flags that represent is bytes count available. + Retrieved string. + + + + Gets string from internal record data using GetBytes + and it increases offset by string size in bytes. + + Offset of starting byte. + Length of the string. + Retrieved string. + + if Offset + iStrLen is out of data array + + + + + Reads string from data provider. + + Offset to the first character. + Number of bytes in the string. + Encoding to use. + Indicates whether string is unicode. + Extracted string. + + + + Gets TAddr structure from internal data. + + Offset in bytes of TAddr structure to get. + Retrieved TAddr structure. + + + + Gets TAddr structure from internal data. + + Offset in bytes of TAddr structure to get. + Retrieved TAddr structure. + + + + Saves data into binary writer. + + Writer to save data into. + Start offset in the internal storage. + Number of bytes to save. + Temporary buffer to use. + + + + Writes byte value at the specified position. + + Offset to the required value. + Byte value to write at the specified position. + + + + Writes Int16 value at the specified position. + + Offset to the required value. + Int16 value to write at the specified position. + + + + Writes Int16 value at the specified position. + + Offset to the required value. + Int16 value to write at the specified position. + + + + Writes Int16 value at the specified position. + + Offset to the required value. + Int32 value to write at the specified position. + + + + Writes Int16 value at the specified position. + + Offset to the required value. + Int32 value to write at the specified position. + + + + Writes Int16 value at the specified position. + + Offset to the required value. + Int32 value to write at the specified position. + + + + Sets one bit in specified byte in internal record data array. + + Offset of the byte in the data array. + Bit position in the byte. + Value of bit. + + If bitPos is less than zero or more than 7. + + + + + Writes Double value at the specified position. + + Offset to the required value. + Double value to write at the specified position. + + + + Sets string in internal data. The String length is saved in two bytes. + + Offset to the string. + Value of the string. + + + + Sets string in internal data. The String length is saved in two bytes. + + Offset to the string. + Value of the string. + + + + Sets string in internal data. The String length is saved in two bytes. + + Offset to the string. + Value of the string. + Indicates whether string should be stored as unicode. + + + + Sets string in internal data. The String length is saved in two bytes. + + Offset to the string. + Value of the string. + Size of the written data. + + + + Sets string in internal data. The String length is saved in two bytes. + + Offset to the string. + Value of the string. + Indicates whether string should be stored in unicode format. + Size of the written data. + + + + Sets string in internal record data without string length, + updates offset parameter (adds string length). + + Offset to the string. + Value of the string. + + + + Sets string in internal record data without string length, + updates offset parameter (adds string length). + + Offset to the string. + Value of the string. + Indicates whether string should be stored in Unicode encoding or not. + + + + Sets bytes in internal record data array values. + + Offset in internal record data array to start from. + Array of bytes to set. + If value array is NULL. + + If pos or length would be less than zero or their sum would be more + than size of value array. + + + If internal record data array is too small for receiving value array + and AutoGrowData is False. + + + + + Sets bytes in internal record data array values. + + Offset in internal record data array to start from. + Array of bytes to set. + Position in value array to the data that will be set. + Length of the data. + If value array is NULL. + + If pos or length would be less than zero or their sum would be more + than size of value array. + + + If internal record data array is too small for receiving value array + and AutoGrowData is False. + + + + + Sets TAddr structure in internal record data. + + Offset in bytes of TAddr structure to set. + New value of the TAddr at the specified position. + + + + Sets TAddr structure in internal record data. + + Offset in bytes of TAddr structure to set. + New value of the Rectangle at the specified position. + + + + Moves memory inside internal buffer. + + Destination offset. + Source offset. + Memory size. + + + + Copies memory inside internal buffer. + + Destination offset. + Source offset. + Memory size. + + + + Resizes internal storage if necessary. + + Required size. + + + + Writes zeros inside memory block. + + + + + Clears internal storage if allowed. + + + + + Creates data provider of the same type. + + Created data provider. + + + + + + + + + + + + + + Returns size of the internal buffer. Read-only. + + + + + Indicates whether data provider was cleared. + + + + + Pointer to the data array. + + + + + Default constructor to prevent creation of items without arguments. + + + + + Creates new instance of this class. + + Array to read data from. + + + + Returns byte value at the specified position. + + Offset to the required value. + Byte at the specified position. + + + + Returns Int16 value at the specified position. + + Offset to the required value. + Int16 value at the specified position. + + + + Returns Int32 value at the specified position. + + Offset to the required value. + Int32 value at the specified position. + + + + Returns Int32 value at the specified position. + + Offset to the required value. + Int32 value at the specified position. + + + + Copies data from internal storage into specified + + Source offset. + Destination array. + Destination offset. + Size in bytes of the data to copy. + + + + Copies data from internal storage into specified provider. + + Source offset. + Destination provider. + Destination offset. + Size in bytes of the data to copy. + + + + Reads data from BinaryReader. + + Reader to get data from. + Offset in the internal data to start filling from. + Number of bytes to read. + Temporary buffer needed for some operations. + + + + Reads string from data provider. + + Offset to the first character. + Number of bytes in the string. + Encoding to use. + Indicates is unicode encoding. + Extracted string. + + + + Resizes internal storage if necessary. + + Required size. + + + + Writes zeros inside memory block. + + + + + Writes byte value at the specified position. + + Offset to the required value. + Byte value to write at the specified position. + + + + Writes Int16 value at the specified position. + + Offset to the required value. + Int16 value to write at the specified position. + + + + Writes Int16 value at the specified position. + + Offset to the required value. + Int16 value to write at the specified position. + + + + Writes Int32 value at the specified position. + + Offset to the required value. + Int32 value to write at the specified position. + + + + Writes Int32 value at the specified position. + + Offset to the required value. + Int32 value to write at the specified position. + + + + Sets one bit in specified byte in internal record data array. + + Offset of the byte in the data array. + Bit position in the byte. + Value of bit. + + If bitPos is less than zero or more than 7. + + + + + Writes Int32 value at the specified position. + + Offset to the required value. + Double value to write at the specified position. + + + + Sets string in internal data without string length, + updates offset parameter (adds string length). + + Offset to the string. + Value of the string. + Indicates whether to use unicode encoding or not. + + + + Sets bytes in internal record data array values. + + Offset in internal record data array to start from. + Array of bytes to set. + Position in value array to the data that will be set. + Length of the data. + If value array is NULL. + + If pos or length would be less than zero or their sum would be more + than size of value array. + + + If internal record data array is too small for receiving value array + and AutoGrowData is False. + + + + + Saves data into binary writer. + + Writer to save data into. + Start offset in the internal storage. + Number of bytes to save. + Temporary buffer to use. + + + + Updates internal buffer. + + New buffer to set. + + + + Clears internal data. + + + + + Moves memory inside internal buffer. + + Destination offset. + Source offset. + Memory size. + + + + Copies memory inside internal buffer. + + Destination offset. + Source offset. + Memory size. + + + + Creates provider of the same type. + + Created provider object. + + + + Return internal buffer. Read-only. + + + + + Returns size of the internal buffer. Read-only. + + + + + + + + + + Specifies the maximum number of times the formulas should be iteratively calculated. + This is a fail-safe against mutually recursive formulas locking up + a spreadsheet application. + + + + + Correct record size. + + + + + Maximum number of iterations allowed in circular references. + + + + + Default Constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Maximum number of iterations allowed in circular references. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Specifies whether to calculate formulas manually, automatically, or automatically + except for multiple table operations. + + + + + Specifies whether to calculate formulas manually, automatically, or automatically + except for multiple table operations. See TCalcMode for possible values. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Specifies whether to calculate formulas manually, automatically, or automatically + except for multiple table operations. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Specifies whether the top or bottom items are displayed with the conditional formatting. + + + + + Specifies whether a percentage of the top or bottom items are displayed with the conditional formatting, + or whether a set number of the top or bottom items are displayed with the conditional formatting. + + + + + Specifies how many values are displayed with the conditional formatting. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Top or bottom items are displayed with rule. + + + + + Percentage of the top or bottom items are displayed with the rule. + + + + + Specifies how many values are displayed with the rule. + + + + + Specifies the type of text rule. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Specifies the type of date comparison. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Specifies the number of standard deviations above or below the average for the rule. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the first block of reserved bytes in the font block. + + + + + Size of the second block of reserved bytes in the font block. + + + + + Size of the third block of reserved bytes in the font block. + + + + + Mask for font posture bit. + + + + + Mask for font cancellation (strikethrough) bit. + + + + + Mask for font style modification bit. + + + + + Mask for font cancellation modification bit. + + + + + Mask for left border line style bits. + + + + + Mask for right border line style bits. + + + + + Mask for top border line style bits. + + + + + Mask for bottom border line style bits. + + + + + Mask for left border color bits. + + + + + Mask for right border color bits. + + + + + Mask for top border color bits. + + + + + Mask for bottom border color bits. + + + + + Start bit of left border color bits. + + + + + Start bit of right border color bits. + + + + + Start bit of top border color bits. + + + + + Start bit of bottom border color bits. + + + + + Mask for fill pattern bits. + + + + + Mask for pattern color bits. + + + + + Mask for pattern backcolor bits. + + + + + Start bit of fill pattern bits. + + + + + Start bit of fill pattern back color bits. + + + + + Size of the font block. + + + + + Size of the border block. + + + + + Size of the pattern block. + + + + + Size of the number format block. + + + + + Default color index. + + + + + Option flags + + + + + Not used + + + + + False if left border style and color are modified. + + + + + False if right border style and color are modified. + + + + + False if top border style and color are modified. + + + + + False if bottom border style and color are modified. + + + + + False if pattern style is modified. + + + + + False if pattern color is modified. + + + + + False if pattern background color is modified. + + + + + False if the number format is modified. + + + + + True if record contains number format. + + + + + True if record contains font formatting block. + + + + + True if record contains border formatting block. + + + + + True if record contains pattern formatting block. + + + + + True if record contains the user defined number format. + + + + + Font height. + + + + + Font options. + + + + + Font weight (100-1000, only if font - style = 0). + Standard values are 0190H (400) for normal text + and 02BCH (700) for bold text. + + + + + Escapement type (only if font - esc = 0): + 0000H = None; 0001H = Superscript; 0002H = Subscript + + + + + Underline type (only if font - underl = 0): + 00H = None + 01H = Single + 02H = Double + 21H = Single accounting + 22H = Double accounting + + + + + Font color index or FFFFFFFFH to preserve the cell font color: + + + + + Option flags for modified font attributes: + + + + + 0 = Escapement type modified + + + + + 0 = Underline type modified: + + + + + Border line styles: + + + + + Border line colour indexes: + + + + + Fill pattern style: + + + + + Fill pattern color indexes: + + + + + Unused + + + + + Unsigned integer that specifies the identifier of the number format. + + + + + Unsigned integer that specifies the size of the user defined number format. + + + + + Unsigned integer that specifies character count of the number format string. + + + + + Boolean that specifies whether the characters are in double byte character or not. + + + + + Number format string value. + + + + + Constructor. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Parses font block if it is present in the conditional format. + + Object that provides access to the data. + + Offset to the font block data in the internal data array. + + + + + Parses border block if it is present in the conditional format. + + Object that provides access to the data. + + Offset to the border block data in the internal data array. + + + + + Parses pattern block if it is present in the conditional format. + + Object that provides access to the data. + + Offset to the pattern block data in the internal data array. + + + + + Parses number format block if it is present in the conditional format. + + Object that provides access to the data. + + Offset to the number format block data in the internal data array. + + + + + Parses user defined number format block if it is present in the conditional format. + + Object that provides access to the data. + + Offset to the number format block data in the internal data array. + + + + + Writes font block into internal data array + if it is present in the conditional format. + + Object that provides access to the data. + + Offset where font block should be written. + + + + + Writes border block into internal data array + if it is present in the conditional format. + + Object that provides access to the data. + + Offset where border block should be written. + + + + + Writes pattern block into internal data array + if it is present in the conditional format. + + Object that provides access to the data. + + Offset where pattern block should be written. + + + + + Writes number format block into internal data array + if it is present in the conditional format. + + Object that provides access to the data. + + Offset where number format block should be written. + + + + + Writes number format block into internal data array + if it is present in the conditional format. + + Object that provides access to the data. + + Offset where number format block should be written. + + + + + Size of the required storage space. Read-only. + + + + + + + + + + + + + + + + + + + + + + + + + Default constructor, sets all fields default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + + + + + + + + + + + This record defines a 3D chart group and also contains generic formatting information. + + + + + Correct record size. + + + + + Rotation angle (0 to 360 degrees). + + + + + Elevation angle (�90 to +90 degrees). + + + + + Distance from eye to chart (0 to 100). + + + + + Height of plot volume relative to width and depth. + + + + + Depth of points relative to width. + + + + + Space between series. + + + + + Option flags. + + + + + Whether to use perspective transform. + + + + + 3-D columns are clustered or stacked. + + + + + Use auto scaling. + + + + + Reserved; must be one. + + + + + Use 2D walls and gridlines. + + + + + Indicates whether elevation has default value. + + + + + Indicates whether rotation has default value. + + + + + Default constructor, sets all fields with default values. + + + + + + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Rotation angle (0 to 360 degrees). + + + + + Elevation angle (�90 to +90 degrees). + + + + + Indicates whether rotation has default value. + + + + + Indicates whether elevation has default value. + + + + + Distance from eye to chart (0 to 100). + + + + + Height of plot volume relative to width and depth. + + + + + Depth of points relative to width. + + + + + Space between series. + + + + + Holder of flags. + + + + + Whether to use perspective transform. + + + + + 3D columns are clustered or stacked. + + + + + Use auto scaling. + + + + + Use 2D walls and gridlines. + + + + + This record specifies linked series data or text. + + + + + Link index identifier. + + + + + Reference type. + + + + + Option flags holder. + + + + + Index to number format record. + + + + + Size of parsed formula of link array. + + + + + True if this object has a custom number format; False if number format + is linked to data source. + + + + + + + + + + Default constructor, initializes all fields with default values. + + + + + + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Clones current record. + + Returns cloned object. + + + + Link index identifier. + + + + + Reference type. + + + + + Option flags holder. + + + + + Index to number format record. + + + + + Size of parsed formula of link array. + + + + + True if this object has a custom number format; False if number format + is linked to data source. + + + + + + + + + + Link index options. + + + + + Represents the LinkToTitleOrText link index option. + + + + + Represents the LinkToValues link index option. + + + + + Represents the LinkToCategories link index option. + + + + + Represents the LinkToBubbles link index option. + + + + + + + + + + Use default categories. + + + + + Text or value entered directly into the formula bar. + + + + + Linked to worksheet. + + + + + Not used. + + + + + Error reported. + + + + + This record specifies rich-text formatting (bold, italic, font changes, + etc.) within chart titles and data labels. + + + + + Number of rich-text runs. + + + + + + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Clones current record. + + Returns cloned object. + + + + Number of rich-text runs. + + + + + + + + + + + + + + + Size of the TRun item. + + + + + First char index. + + + + + Font index. + + + + + New paragarph start or not. + + + + + Creates new instance of TRuns. + + Base first char. + Base font index. + + + + Clones current object. + + Returns cloned object. + + + + Gets or sets first char index. + + + + + Gets or sets font index. + + + + + Check the new paragarph start or not. + + + + + This record describes the patterns and colors used in a filled area. + + + + + Correct size of the record. + + + + + Foreground color (RGB). + + + + + Background color (RGB). + + + + + Pattern. + + + + + Storage for record bit flags. + + + + + Automatic format. + + + + + Foreground and background are swapped when the data value is negative. + + + + + Index of foreground color. + + + + + Background color index. + + + + + Default constructor, initializes all fields with default values. + + + + + + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Foreground color (RGB). + + + + + Background color (RGB). + + + + + Pattern. + + + + + Index of foreground color. + + + + + Background color index. + + + + + Automatic format or not. + + + + + Foreground and background are swapped when the data value is negative. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record defines an area chart group. + + + + + Contains information about chart type. + + + + + Indicates whether values should be stacked. + + + + + Indicates whether values should be shown as percents. + + + + + Record size. + + + + + Holder of all flags. + + + + + Series in this group are stacked. + + + + + Each category is broken down as a percentage. + + + + + This area has a shadow. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Holder of all flags. + + + + + Series in this group are stacked. + + + + + Each category is broken down as a percentage. + + + + + This area has a shadow. + + + + + + + + + + + + + + + This record specifies the layout information for attached label + + + + + Correct record size. + + + + + Specifies the future record type header + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + If the checksum is incorrect, the layout information specified in this record must be ignored + + + + + + The ATTACHEDLABEL record defines the data label type. The ATTACHEDLABEL + record applies to the label data identified in the associated + DATAFORMAT record. + + + + + Correct record size. + + + + + Holder of all record flags. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + + + + + + Show value as a percent of the total. This bit applies only to pie charts. + + + + + Show category label and value as a percentage (pie charts only). + + + + + Show smoothed line. + + + + + Show category label. + + + + + Show bubble sizes. + + + + + Possible option flags + + + + + No option flag set. + + + + + Show the actual value of the data point. + + + + + Show value as a percent of the total. This bit applies only to pie charts. + + + + + Show category label and value as a percentage (pie charts only). + + + + + Show smoothed line. + + + + + Show category label. + + + + + Show bubble sizes. + + + + + This record defines axis options. + + + + + Correct record size. + + + + + Minimum category on axis. + + + + + Maximum category on axis. + + + + + Value of major unit. + + + + + Units of major unit. + + + + + Value of minor unit. + + + + + Units of minor unit. + + + + + Base unit of axis. + + + + + Crossing point of value axis (date). + + + + + Option flags. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Value of major unit. + + + + + Units of major unit. + + + + + Value of minor unit. + + + + + Units of minor unit. + + + + + Base unit of axis. + + + + + Use default minimum. + + + + + Use default maximum. + + + + + Use default major unit. + + + + + Use default minor unit. + + + + + Date axis. + + + + + Use default base. + + + + + Use default crossing point. + + + + + Use default date settings for axis. + + + + + Option flags. + + + + + None. + + + + + Use default minimum. + + + + + Use default maximum. + + + + + Use default major unit. + + + + + Use default minor unit. + + + + + This a date axis. + + + + + Use default base. + + + + + Use default crossing point. + + + + + Use default date settings for axis. + + + + + This record specifies the number of axes sets (1 = primary + only, 2 = primary and secondary) used on the chart (3D charts + can only have primary axes). + + + + + Number of axes sets. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Size of the required storage space. Read-only. + + + + + Represents DisplayUnits option. + + + + + Record size constant. + + + + + Represents display units in axis. + + + + + Represents display units value. + + + + + Indicates is show display unit label. + + + + + Reserved value. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Represents display units in axis. + + + + + Represents display units value. + + + + + Indicates is show display unit label. + + + + + + Maximum possible size of the record. + + + + + This record usually follows an AXIS record to define the axis line + as it appears on the chart. + + + + + Correct size of the record. + + + + + Axis line identifier: + 0 = the axis line itself + 1 = major grid line along the axis + 2 = minor grid line along the axis + 3 = walls or floor -- walls if parent axis is type 0 or 2; floor if parent axis is type 1. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Axis line identifier. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + Represents chart category axis offset record. + + + + + Minimum record size constant (generated by some version of MS Excel (probably 2007 Beta). + + + + + Record size constant. + + + + + Represents display units in axis. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Indicates is show display unit label. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record specifies the location and size of the chart axes, + in units of 1/4000 of the chart area. + + + + + Correct record size. + + + + + Axis index (0 = main, 1 = secondary). + + + + + X coordinate of top left corner. + + + + + Y coordinate of top left corner. + + + + + Length of x axis. + + + + + Length of y axis. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Axis index (0 = main, 1 = secondary). + + + + + X coordinate of top left corner. + + + + + Y coordinate of top left corner. + + + + + Length of x axis. + + + + + Length of y axis. + + + + + This record defines the axis type. + + + + + Correct record size. + + + + + Axis type: + 0 = category axis or x axis on a scatter chart + 1 = value axis + 2 = series axis + + + + + Field reserved by Microsoft. Read-only. + + + + + Field reserved by Microsoft. Read-only. + + + + + Field reserved by Microsoft. Read-only. + + + + + Field reserved by Microsoft. Read-only. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Axis type: + 0 = category axis or x axis on a scatter chart + 1 = value axis + 2 = series axis + + + + + Represents the Chart axis type. + + + + + Represents the CategoryAxis chart axis type. + + + + + Represents the ValueAxis chart axis type. + + + + + Represents the SeriesAxis chart axis type. + + + + + This record defines a bar or column chart group. + + + + + Correct record size. + + + + + Space between bars (percent of bar width), default = 0. + + + + + Space between categories (percent of bar width), default = 50. + + + + + Holder of all flags. + + + + + True for horizontal bars (bar chart). + False for vertical bars (column chart). + + + + + Stack the displayed values. + + + + + Each category is displayed as a percentage. + + + + + True if this bar has a shadow; otherwise False. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Space between bars. + + + + + Space between categories (percent of bar width), default = 50. + + + + + True for horizontal bars (bar chart). + False for vertical bars (column chart). + + + + + Stack the displayed values. + + + + + Each category is displayed as a percentage. + + + + + True if this bar has a shadow; otherwise False. + + + + + Represents begin display axis unit label record. + + + + + Record size constant. + + + + + Represents display units in axis. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record stores options for a custom bar of pie or pie of + pie chart; these are two of the pie chart subtypes. + + + + + Count of pie slices in the bar of pie or pie of pie chart. + + + + + Array of bytes; each byte contains a bit field that describes the + individual point positioning in the series. If a slice is on the + secondary pie or bar chart, the corresponding bit is set to 1 (one); + otherwise the bit is 0 (zero). + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Clones current record. + + Returns cloned record. + + + + This record stores options for a bar of pie or pie of pie chart; + these are two of the pie chart subtypes. + + + + + Record size. + + + + + 0 = normal pie chart + 1 = pie of pie chart + 2 = bar of pie chart + + + + + Holder of DefaultSplitValue property flag. + + + + + True to use default split value; otherwise False. + + + + + Split type: + 0 = Position + 1 = Value + 2 = Percent + 3 = Custom + + + + + For split = 0, which positions should go to the other pie / bar. + + + + + For split = 2, what percentage should go to the other pie / bar. + + + + + Size of the second pie as a percentage of the first. + + + + + Space between the first pie and the second. + + + + + For split = 1, what values should go to the other pie / bar. + + + + + Holder of HasShadow property. + + + + + True if the second bar / pie has a shadow; otherwise False. + + + + + Represents LeaderLines of datalabels + This property is included as the support in enabled after 2003 formats + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + 0 = normal pie chart + 1 = pie of pie chart + 2 = bar of pie chart + + + + + True to use default split value; otherwise False. + + + + + Split type: + 0 = Position + 1 = Value + 2 = Percent + 3 = Custom + + + + + For split = 0, which positions should go to the other pie / bar. + + + + + For split = 2, what percentage should go to the other pie / bar. + + + + + Size of the second pie as a percentage of the first. + + + + + Space between the first pie and the second. + + + + + For split = 1, what values should go to the other pie / bar. + + + + + 1 = the second pie / bar has a shadow. + + + + + True to show leader lines to data labels. + + + + + This record defines the scaling options for a category or series axis. + + + + + IMaxCross interface. + + + + + Gets or sets IsMaxCross property. + + + + + Minimum value for CrossingPoint, LabelsFrequency, and TickMarksFrequency properties. + + + + + Maximum value for CrossingPoint, LabelsFrequency, and TickMarksFrequency properties. + + + + + Correct record size. + + + + + Value axis / category crossing point (2D charts only). + + + + + Frequency of labels. + + + + + Frequency of tick marks. + + + + + Record flags holder. + + + + + Value axis crossing: + False if axis crosses mid-category. + True if axis crosses between categories. + + + + + Value axis crosses at the far right category (in a line, bar, + column, scatter, or area chart; 2D charts only). + + + + + Display categories in reverse order. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Value axis / category crossing point (2D charts only). + + + + + Frequency of labels. + + + + + Frequency of tick marks. + + + + + Value axis crossing: + False if axis crosses mid-category. + True if axis crosses between categories. + + + + + Value axis crosses at the far right category (in a line, bar, + column, scatter, or area chart; 2D charts only). + + + + + Display categories in reverse order. + + + + + This record is the parent record for the chart group format + description. Each chart group will have a separate CHARTFORMAT + record, followed by a BEGIN record, the chart-group description, + and an END record. + + + + + Correct size of the record. + + + + + Field reserved by Microsoft for own use. Read-only. + + + + + Field reserved by Microsoft for own use. Read-only. + + + + + Field reserved by Microsoft for own use. Read-only. + + + + + Field reserved by Microsoft for own use. Read-only. + + + + + Holder of record options. + + + + + Vary color for each data point. + + + + + Drawing order (0 = bottom of the z-order). + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Vary color for each data point. + + + + + Drawing order (0 = bottom of the z-order). + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record specifies drop lines, hi-lo lines, or series lines + on a line chart. If the chart has both drop lines and hi-lo + lines, two CHARTLINE records will be present. + + + + + Record size. + + + + + Drop lines / hi-lo lines: + 0 = drop lines + 1 = hi-lo lines + 2 = series lines (the lines that connect the columns in a stacked column chart) + + + + + Boolean value indicates whether drop lines are present in stock, line or area charts + + + + + Boolean value indicates whether high low lines are present in stock or line charts + + + + + Boolean value indicates whether series lines are present in pie of pie or bar of pie charts + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Drop lines / hi-lo lines: + 0 = drop lines + 1 = hi-lo lines + 2 = series lines (the lines that connect the columns in a stacked column chart) + + + + + True if stock, line or area charts has drop lines + + + + + True if stock or line charts has high low lines + + + + + True if pie of pie or bar of pie charts has series lines + + + + + The CHART record marks the start of the chart data substream in the + workbook BIFF stream. This record defines the location of the chart + on the display and its overall size. The X and Y fields define the + position of the upper-left corner of the bounding rectangle that + encompasses the chart. The position of the chart is referenced to the page. + The Width and Height fields define the overall size (the bounding rectangle) of + the chart, including title, pointing arrows, axis labels, etc. + The position and size are specified in points (1/72 inch), using a fixed + point format (two bytes integer, two bytes fraction). + + + + + Correct size of the record. + + + + + X-position of upper-left corner. + + + + + Y-position of upper-left corner. + + + + + X-size. + + + + + Y-size. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + X-position of upper-left corner. + + + + + Y-position of upper-left corner. + + + + + X-size. + (1/72 inch), used a fixed point format (two bytes integer, two bytes fraction). + + + + + Y-size. + (1/72 inch), used a fixed point format (two bytes integer, two bytes fraction). + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + The DATAFORMAT record contains the zero-based numbers of the data + point and series. The subordinate records determine the format of + the series or point defined by the DATAFORMAT record. + + + + + Correct size of the record. + + + + + Point number (FFFFh means entire series). + + + + + Series index (file relative). + + + + + Series number (as shown in name box -- S1, S2, etc.). This can + be different from yi if the series order has been changed. + + + + + Holder of record flags. + + + + + True to use Microsoft Excel 4.0 colors for automatic formatting. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Point number (FFFFh means entire series). + + + + + Series index (file relative). + + + + + Series number (as shown in name box -- S1, S2, etc.). This can + be different from yi if the series order has been changed. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Summary description for ChartDataLabelsRecord. + + + + + + + + + + Option flags. + + + + + Indicates whether series name is in data labels. + + + + + Indicates whether category name is in data labels. + + + + + Indicates whether value is in data labels. + + + + + Indicates whether percentage is in data labels. + + + + + Indicates whether bubble size is in data labels. + + + + + Length of the delimiter. + + + + + Delimiter. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Indicates whether series name is in data labels. + + + + + Indicates whether category name is in data labels. + + + + + Indicates whether value is in data labels. + + + + + Indicates whether percentage is in data labels. + + + + + Indicates whether bubble size is in data labels. + + + + + Length of the delimiter. + + + + + Delimiter. + + + + + This record stores options for the chart data table. + + + + + Record size. + + + + + Holder of record options. + + + + + True if data table has horizontal borders. + + + + + True if data table has vertical borders. + + + + + True if data table has a border. + + + + + True if data table shows series keys. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + True if data table has horizontal borders. + + + + + True if data table has vertical borders. + + + + + True if data table has a border. + + + + + True if data table shows series keys. + + + + + The DEFAULTTEXT record precedes a TEXT record to identify the text + defined in the TEXT record as the default properties for certain chart items. + + + + + Correct record size. + + + + + Object identifier for the text: + 0 = default text characteristics for "show labels" data labels + 1 = default text characteristics for value and percentage data labels + 2 = default text characteristics for all text in the chart + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Object identifier for the text: + TextDefaults.ShowLabels = default text characteristics for "show labels" data labels. + TextDefaults.ValueAndPercents = default text characteristics for value and percentage data labels. + TextDefaults.All = default text characteristics for all text in the chart. + + + + + Represents the text defaults options. + + + + + Represents the ShowLabels text defaults option. + + + + + Represents the ValueAndPercents text defaults option. + + + + + Represents the All text defaults option. + + + + + This record defines drop bars on a line chart. If the chart contains + drop bars, the chart BIFF will contain two DROPBAR records. The first + DROPBAR record corresponds to the up bar and the second DROPBAR record + corresponds to the down bar. + + + + + Record size. + + + + + Drop bar gap width (0 to 100%). + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Drop bar gap width (0 to 100%). + + + + + Represents end display axis unit label record. + + + + + Minimum record size constant (generated by some version of MS Excel (probably 2007 Beta). + + + + + Record size constant. + + + + + Represents display units in axis. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + The FBI record stores font metrics. + + + + + Correct record size. + + + + + Width of basis when font was applied. + + + + + Height of basis when font was applied. + + + + + Font height applied. + + + + + Scale basis. + + + + + Index number into the font table. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Font height applied. + + + + + Index number into the font table. + + + + + This record is the child of a TEXT record and defines a text + font by indexing the appropriate font in the font table. The + font table is built from FONT records. + + + + + Correct record size. + + + + + Index number into the font table. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Index number into the font table. + + + + + Read-only. Minimum possible size of the record. + + + + + Read-only. Maximum possible size of the record. + + + + + This record is written by Microsoft Excel but it is ignored. + Applications writing chart BIFF do not need to write this + record and applications reading chart BIFF can ignore it. + + + + + Default record size. + + + + + + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Returns size of the required storage space. + + + + + The FRAME record defines the border that is present around a + displayed label as a rectangle. A displayed label can include + the chart title, the legend (if not a regular rectangle), a + category name, or a value amount. + + + + + Correct size of the record. + + + + + 0 = regular rectangle/no border + 1�3 (reserved) + 4 = rectangle with shadow + + + + + Record flags holder. + + + + + Microsoft Excel calculates size. + + + + + Microsoft Excel calculates position. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + 0 = regular rectangle/no border + 1�3 (reserved) + 4 = rectangle with shadow + + + + + Microsoft Excel calculates size. + + + + + Microsoft Excel calculates position. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record stores fill effects such as gradient fills, patterns, + textures, and so on. The record data is obtained from the + Microsoft Office Drawing DLL. + + + + + Represents start mso index. + + + + + Represents last mso index. + + + + + Represents default offset. + + + + + Represents first bytes in record. + + + + + Represents last bytes. + + + + + Represents option list; + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + Parses data from stream. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + + + + Clones current record. + + Returns cloned object. + + + + Indicates whether record needs internal data array or if it can be cleaned. + + + + + Represents list of fill options. + + + + + This record specifies the number-format index for an axis. + + + + + Record size. + + + + + Number-format index (number of the FORMAT record in the BIFF, begins at zero). + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Number-format index (number of the FORMAT record in the BIFF, begins at zero). + + + + + The LEGEND record defines the location of the legend on the + display and its overall size. The displayed legend contains + all series on the chart. + + + + + Record size. + + + + + X-position of upper-left corner. + + + + + Y-position of upper-left corner. + + + + + X-size. + + + + + Y-size. + + + + + Type: + 0 = bottom + 1 = corner + 2 = top + 3 = right + 4 = left + 7 = not docked or inside the plot area + + + + + Spacing: + 0 = close + 1 = medium + 2 = open + + + + + Holder of record flags. + + + + + Automatic positioning (True if legend is docked). + + + + + Automatic series distribution (True in Microsoft Excel 5.0). + + + + + X positioning is automatic. + + + + + Y positioning is automatic. + + + + + True if vertical legend (a single column of entries); + False if horizontal legend (multiple columns of entries). + Manual-sized legends always have this bit set to False. + + + + + True if the chart contains a data table. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + X-position of upper-left corner. + + + + + Y-position of upper-left corner. + + + + + X-size. + + + + + Y-size. + + + + + Type: + 0 = bottom + 1 = corner + 2 = top + 3 = right + 4 = left + 7 = not docked or inside the plot area + + + + + Spacing: + 0 = close + 1 = medium + 2 = open + + + + + Automatic positioning (True if legend is docked). + + + + + Automatic series distribution (True in Microsoft Excel 5.0). + + + + + X positioning is automatic. + + + + + Y positioning is automatic. + + + + + True if vertical legend (a single column of entries); + False if horizontal legend (multiple columns of entries). + Manual-sized legends always have this bit set to False. + + + + + True if chart contains data table. + + + + + This record specifies information about a legend entry which has + been changed from the default legend-entry settings. + + + + + Record size. + + + + + Legend-entry index. + + + + + Record flags holder. + + + + + True if the legend entry has been deleted. + + + + + True if the legend entry has been formatted. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Legend-entry index. + + + + + True if the legend entry has been deleted. + + + + + True if the legend entry has been formatted. + + + + + This record defines the appearance of a line, such as an axis line or border. + + + + + Correct size of the record. + + + + + Color of line; RGB value high byte must be set to zero. + + + + + Pattern of line: + 0 = solid + 1 = dash + 2 = dot + 3 = dash-dot + 4 = dash dot-dot + 5 = none + 6 = dark gray pattern + 7 = medium gray pattern + 8 = light gray pattern + + + + + Weight of line: + �1 or 0xffff = hairline + 0 = narrow (single) + 1 = medium (double) + 2 = wide (triple) + + + + + Format flags holder. + + + + + Automatic format. + + + + + True to draw tick labels on this axis. + + + + + True to draw line by custom style. + + + + + Index to color of line. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Line pattern. + + + + + Weight of line. + + + + + If true - default format; otherwise custom. + + + + + True to draw tick labels on this axis. + + + + + Custom format for line color. + + + + + Line color index.. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record defines a line chart group. + + + + + Record size. + + + + + Holder of record flags. + + + + + Stack the displayed values. + + + + + Each category is broken down as a percentage. + + + + + True if this line has a shadow. + + + + + space between two lines + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Stack the displayed values. + + + + + Each category is broken down as a percentage. + + + + + True if this line has a shadow. + + + + + Space between the lines + + + + + This record defines the color and shape of the line + markers that appear on scatter and line charts. + + + + + Correct size of the record. + + + + + Foreground color: RGB value (high byte = 0). + + + + + Background color: RGB value (high byte = 0). + + + + + Type of marker. + + + + + Format flags. + + + + + Index to color of marker border. + + + + + Index to color of marker fill. + + + + + Size of line markers. + + + + + Automatic color. + + + + + True = "background = none". + + + + + True = "foreground = none". + + + + + Flags monitors the properties which is set and custom + + 0 th position - ForeColor/FillColorIndex + 1 th position - BackColor/BorderColorIndex + 2 th position - Interior None + 3 th position - Border None + 4 th position - Marker Type + 5 th position - Marker Size + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Foreground color: RGB value (high byte = 0). + + + + + Background color: RGB value (high byte = 0). + + + + + Type of marker. + + + + + Format flags. Read-only. + + + + + Index to color of marker border. + + + + + Index to color of marker fill. + + + + + Size of line markers. + + + + + Automatic color. + + + + + True = "background = none". + + + + + True = "foreground = none". + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + Indicates whether the Marker has the line properties. + + + + + Get/Set the flag options for the marker properties. + + + + + Type of marker. + + + + + Represents the NoMarker marker type. + + + + + Represents the Square marker type. + + + + + Represents the Diamond marker type. + + + + + Represents the Triangle marker type. + + + + + Represents the X marker type. + + + + + Represents the Star marker type. + + + + + Represents the DowJones marker type. + + + + + Represents the StandardDeviation marker type. + + + + + Represents the Circle marker type. + + + + + Represents the PlusSign marker type. + + + + + This record links a TEXT record to an object on + the chart or to the entire chart. + + + + + Correct size of the record. + + + + + Object text is linked to. + + + + + Link index 1, series number. + + + + + Link index 2, data point number. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Object text is linked to. + + + + + Link index 1, series number. + + + + + Link index 2, data point number. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record defines the format for a picture attached + to a data series or point. + + + + + Correct size of the record. + + + + + Picture type. + + + + + Image format. + + + + + Environment from which the file was written. + + + + + Option flags. + + + + + Formatting only; no picture attached. + + + + + Picture is attached to top and bottom of column. + + + + + Picture is attached to back and front of column. + + + + + Picture is attached to sides of column. + + + + + Scaling value for pictures, units/picture + (IEEE floating-point number). + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Maximum possible size of the record. + + + + + Picture type. + + + + + Represents the Stretched picture type. + + + + + Represents the Stacked picture type. + + + + + Image format. + + + + + Represents the WindowsMetafile image format. + + + + + Represents the MacintoshPICT image format. + + + + + Represents the WindowsBitmap image format. + + + + + Environment from which the file was written. + + + + + Represents the Windows environment option. + + + + + Represents the Macintosh environment option. + + + + + The distance of an open pie slice from the center of the pie + chart expressed as a percentage of the pie diameter. + For example, if the percent = 33 (21h), the pie slice is + one-third of the pie diameter away from the pie center. + + + + + Correct size of the record. + + + + + Distance of pie slice from center of pie. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Distance of pie slice from center of pie. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record defines a pie chart group and specifies pie chart options. + + + + + Correct size of the record. + + + + + Angle of the first pie slice expressed in degrees. + + + + + 0 = True pie chart + Non-zero = size of center hole in a donut chart (as a percentage). + + + + + Option flags. + + + + + True if this pie has a shadow. + + + + + True to show leader lines to data labels. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Angle of the first pie slice expressed in degrees. + + + + + 0 = True pie chart + Non-zero = size of center hole in a donut chart (as a percentage). + + + + + True if this pie has a shadow. + + + + + True to show leader lines to data labels. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record specifies the plot area layout information for attached label + + + + + Correct record size. + + + + + Specifies the future record type header + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + If the checksum is incorrect, the layout information specified in this record must be ignored + + + + + + + + + + + Correct size of the record. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record stores scale factors for font scaling. + + + + + Correct size of the record. + + + + + Horizontal growth of plot area for font scaling. + + + + + Vertical growth of plot area for font scaling. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Horizontal growth of plot area for font scaling. + + + + + Vertical growth of plot area for font scaling. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record defines manual position information for the main-axis + plot area, legend, and attached text (data labels, axis labels, + and chart title). The record data depends on the record's use, + as shown in the following sections. + + + + + Correct size of the record. + + + + + For plot area and text must be 2, + For legend must be 5. + + + + + + + + + + X coordinate of the top left corner. + + + + + Y coordinate of the top left corner. + + + + + X coordinate of the bottom right corner. + + + + + Y coordinate of the bottom right corner. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + + + + + + + + + + + X coordinate of the top left corner. + + + + + Y coordinate of the top left corner. + + + + + X coordinate of the bottom right corner. + + + + + Y coordinate of the bottom right corner. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + + + + + + Correct size of the record. + + + + + Option flags. + + + + + True if the chart contains radar axis labels. + + + + + Not used. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + True if the chart contains radar axis labels. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record defines a radar chart group. + + + + + Correct size of the record. + + + + + Option flags. + + + + + True if the chart contains radar axis labels. + + + + + True if this radar series has a shadow. + + + + + Not used. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + True if the chart contains radar axis labels. + + + + + True if this radar series has a shadow. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record specifies the PivotTable reference used for the chart. + + + + + Correct size of the record. + + + + + First PivotTable row. + + + + + Last PivotTable row. + + + + + First PivotTable column. + + + + + Last PivotTable column. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record stores the scatter chart properties. + + + + + Correct size of the record. + + + + + Percent of largest bubble compared to chart in general. + + + + + Bubble size. + + + + + Option flags. + + + + + True if this a bubble series. + + + + + True to show negative bubbles. + + + + + True if bubble series has a shadow. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + Percent of largest bubble compared to chart in general. + + + + + Bubble size. + + + + + True if this a bubble series. + + + + + True to show negative bubbles. + + + + + True if bubble series has a shadow. + + + + + This record defines the series error bars. + + + + + Correct size of the record. + + + + + Error-bar type. + + + + + Error-bar value source. + + + + + True if the error bars are T-shaped (have a line on the top and bottom). + + + + + Reserved; must be 1. + + + + + IEEE number; specifies the fixed value, percentage, + or number of standard deviations for the error bars. + + + + + Number of values or cell references used for custom error bars. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Error-bar type. + + + + + Error-bar value source. + + + + + True if the error bars are T-shaped (have a line on the top and bottom). + + + + + IEEE number; specifies the fixed value, percentage, + or number of standard deviations for the error bars. + + + + + Error-bar type. + + + + + Represents the XDirectionPlus error-bar type. + + + + + Represents the XDirectionMinus error-bar type. + + + + + Represents the YDirectionPlus error-bar type. + + + + + Represents the YDirectionMinus error-bar type. + + + + + This record defines a series trend line. + + + + + Correct size of the record. + + + + + Represents default byte array for NaN value. + + + + + Represents default NaN value; + + + + + Regression type. + + + + + Polynomial order or moving average period. + + + + + IEEE number; specifies forced intercept. + (#NA if no intercept is specified) + + + + + True if the equation is displayed. + + + + + True if the R-squared value is displayed. + + + + + IEEE number; specifies number of periods to forecast forward. + + + + + IEEE number; specifies number of periods to forecast backward. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Regression type. + + + + + Polynomial order or moving average period. + + + + + IEEE number; specifies forced intercept. + (#NA if no intercept is specified) + + + + + True if the equation is displayed. + + + + + True if the R-squared value is displayed. + + + + + IEEE number; specifies number of periods to forecast forward. + + + + + IEEE number; specifies number of periods to forecast backward. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + Regression type. + + + + + Represents the Polynomial regression type. + + + + + Represents the Exponential regression type. + + + + + Represents the Logarithmic regression type. + + + + + Represents the Power regression type. + + + + + Represents the MovingAverage regression type. + + + + + This record specifies series formatting information. + + + + + Correct size of the record. + + + + + Flags. + + + + + True if the line series has a smoothed line. + + + + + True to draw bubbles with 3D effects. + + + + + True if this series has a shadow. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + True if the line series has a smoothed line. + + + + + True to draw bubbles with 3D effects. + + + + + True if this series has a shadow. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record is subordinate to the second CHARTFORMAT (overlay) + record in a file and defines the series that are displayed as + the overlay to the main chart. The first CHARTFORMAT (main chart) + record in a file does not require a SERIESLIST record because all + series, except those specified for the overlay, are included in + the main chart. + + + + + Minimum size of the record. + + + + + Count of series. + + + + + List of series numbers (words). + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Clones current record. + + Returns cloned record. + + + + List of series numbers (words). + + + + + Minimum possible size of the record. + + + + + This record describes the series of the chart and contains the + type of data and number of data fields that make up the series. + Series can contain 4000 points in Microsoft Excel version 5. The + sdtX and sdtY fields define the type of data that is contained in + this series. At present, the two types of data used in the Microsoft + Excel chart series are numeric and text (date and sequence + information is not used). The cValx and cValy fields contain the + number of cell records in the series. + + + + + Correct size of the record. + + + + + Type of data in categories. + + + + + Type of data in values. + + + + + Count of categories. + + + + + Count of values. + + + + + Type of data in Bubble size series. + + + + + Count of Bubble series values. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Count of values. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + Type of data. + + + + + Represents the Date data format. + + + + + Represents the Numeric data format. + + + + + Represents the Sequence data format. + + + + + Represents the Text data format. + + + + + The value of the ID field determines the assignment of the text field. + + + + + Minimum size of the record. + + + + + Text identifier: 0 = series name or text. + + + + + The series text string. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + The series text string. + + + + + Minimum possible size of the record. + + + + + This record indicates the series index for the series that + the trend line or error bar is attached to. The series index + is the number of the series in the BIFF (starting with series one). + + + + + Correct size of the record. + + + + + Series index for the series that the trend line + or error bar is attached to. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Series index for the series that the trend line + or error bar is attached to. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record is part of the series specifications and indicates + the chart-group index for the series. The chart-group index + specifies the number of the chart group (specified by a + CHARTFORMAT record) in the BIFF, starting with chart group zero. + + + + + Correct size of the record. + + + + + Chart-group index. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Chart-group index. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record specifies chart sheet properties. + + + + + Correct size of the record. + + + + + Represents minimum record size. + + + + + Property flags. + + + + + True if chart type has been manually formatted (changed from the default). + + + + + True to plot only visible cells. + + + + + True not to size chart with window. + + + + + False to use default plot area dimensions; + True if POS record describes plot-area dimensions. + + + + + True if user has modified chart enough that fManPlotArea should be set to 0. + + + + + Empty cells plotted as: + 0 = not plotted + 1 = zero + 2 = interpolated + + + + + This field is not used. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Property flags. Read-only. + + + + + True if chart type has been manually formatted (changed from the default). + + + + + True to plot visible cells only. + + + + + True not to size chart with window. + + + + + False to use default plot area dimensions; + True if POS record describes plot-area dimensions. + + + + + True if user has modified chart enough that fManPlotArea should be set to 0. + + + + + Empty cells plotted as: + 0 = not plotted + 1 = zero + 2 = interpolated + + + + + Reserved by Microsoft. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record defines where a series appears in the list of series. + + + + + Correct size of the record. + + + + + Index into series list. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Index into series list. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record defines a surface chart group. + + + + + Correct size of the record. + + + + + Option flags. + + + + + True if chart contains color fill for surface. + + + + + True if this surface chart has shading. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + True if chart contains color fill for surface. + + + + + True if this surface chart has shading. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record is used in conjunction with several child records + (which further define the text displayed on the chart) to define + the alignment, color, position, size, and so on of text fields + that appear on the chart. The fields in this record have meaning + according to the TEXT record's parent (CHART, LEGEND, or DEFAULTTEXT). + + + + + Mask for the rotation value. + + + + + First bit of the rotation value. + + + + + Mask for data label placement. + + + + + First bit of the data label placement value. + + + + + Correct size of the record. + + + + + Horizontal alignment of the text. + + + + + Vertical alignment of the text. + + + + + Display mode of the background. + + + + + Text color. + + + + + X-position of the text in 1/4000 of chart area. + + + + + Y-position of the text in 1/4000 of chart area. + + + + + X-size of the text in 1/4000 of chart area. + + + + + Y-size of the text in 1/4000 of chart area. + + + + + Option flags. + + + + + Index to color value of text. + + + + + Option flags. + + + + + True for automatic color; False for user-selected color. + + + + + If text is an attached data label: + True to draw legend key with data label; + False for no legend key. + + + + + True if text of label is the value of the data point; + False if text is the category label. + + + + + True if text is not horizontal; + False if text is horizontal. + + + + + True to use automatically generated text string; + False to use user-created text string. + Must be one for fShowValue to be meaningful. + + + + + True if default or unmodified; + False if modified. + + + + + True if an automatic text label has been deleted by the user. + + + + + True if background is set to automatic. + + + + + True to show category label and value as a percentage. + (pie charts only) + + + + + True to show value as a percent. + This bit applies only to pie charts. + + + + + True to show bubble sizes. + + + + + True to show label. + + + + + Text rotation. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Horizontal alignment of the text. + + + + + Vertical alignment of the text. + + + + + Display mode of the background. + + + + + Text color. + + + + + X-position of the text in 1/4000 of chart area. + + + + + Y-position of the text in 1/4000 of chart area. + + + + + X-size of the text in 1/4000 of chart area. + + + + + Y-size of the text in 1/4000 of chart area. + + + + + Option flags. Read-only. + + + + + Index to color value of text. + + + + + Option flags. Read-only. + + + + + True if automatic color; False if user-selected color. + + + + + If text is an attached data label: + True to draw legend key with data label; + False if no legend key. + + + + + True if text of label is the value of the data point; + False if text is the category label. + + + + + True if text is not horizontal; + False if text is horizontal. + + + + + True to use automatically generated text string; + False to use user-created text string. + Must be one for fShowValue to be meaningful. + + + + + True if default or unmodified; + False if modified. + + + + + True if an automatic text label has been deleted by the user. + + + + + True if background is set to automatic. + + + + + True to show category label and value as a percentage + (pie charts only). + + + + + True to show value as a percent. + This bit applies only to pie charts. + + + + + True to show bubble sizes. + + + + + True to show label. + + + + + Rotation. + + + + + Data label placement. + + + + + Text rotation. + + + + + Text rotation. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record defines tick mark and tick label formatting. + + + + + Mask for the rotation value. + + + + + First bit of the rotation value. + + + + + Correct size of the record. + + + + + Maximum possible angle. + + + + + Size of the first reserved field. + + + + + Type of major tick mark. + + + + + Type of minor tick mark. + + + + + Tick label position relative to axis line. + + + + + Background mode. + + + + + Tick-label text color; RGB value, high byte = 0. + + + + + Automatic text color. + + + + + Display flags. + + + + + Automatic text background. + + + + + Automatic rotation. + + + + + Index to color of tick label. + + + + + Text rotation angle. + + + + + Indicates if axis label is left to right. + + + + + Indicates if axis label is right to left. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Type of major tick mark. + + + + + Type of minor tick mark. + + + + + Tick label position relative to axis line. + + + + + Reserved; must be zero. + + + + + Automatic text color. + + + + + Automatic rotation. + + + + + Indicates is axis label is left to right. + + + + + Indicates is axis label is right to left. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + Microsoft Excel writes this record, but its value is always zero. + Applications writing BIFF do not need to write this record. + If the application writes this record, the wUnits field must be zero. + + + + + Correct size of the record. + + + + + Always zero. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record defines the value axis. + + + + + Record size constant. + + + + + Maximum value on axis. + + + + + Maximum value on axis. + + + + + Value of major increment. + + + + + Value of minor increment. + + + + + Value where category axis crosses. + + + + + Format flags. + + + + + Automatic minimum selected. + + + + + Automatic maximum selected. + + + + + Automatic major selected. + + + + + Automatic minor selected. + + + + + Automatic category crossing point selected. + + + + + Logarithmic scale. + + + + + Values in reverse order. + + + + + Category axis to cross at maximum value. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Maximum value on axis. + + + + + Maximum value on axis. + + + + + Value of major increment. + + + + + Value of minor increment. + + + + + Value where category axis crosses. + + + + + Automatic minimum selected. + + + + + Automatic maximum selected. + + + + + Automatic major selected. + + + + + Automatic minor selected. + + + + + Automatic category crossing point selected. + + + + + Logarithmic scale. + + + + + Values in reverse order. + + + + + Category axis to cross at maximum value. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This class wraps single record. Used in charts for DataLabels settings. + + + + + Offset to the wrapped record data. + + + + + Wrapped record. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Gets / sets wrapped record. Read-only. + + + + + Represents interface, that implement mso option and fopte option wrapper classes. + + + + + Replaces option with specified value. + + Option to set. + + + + Removes current option by id. + + Represents option id to remove. + + + + Summary description for PrintedChartSizeRecord. + + + + + Correct size of the record. + + + + + Information on how chart should be printed. + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + Rotation type. + + + + + Represents the LeftToRight rotation type. + + + + + Represents the TopToBottom rotation type. + + + + + Represents the CounterClockwise rotation type. + + + + + Represents the Clockwise rotation type. + + + + + + Contains utility methods for object cloning. + + + + + Clones int array. + + Array to clone + Returns cloned array. + + + + Clones ushort array. + + Array to clone. + Returns cloned array. + + + + Clones string array. + + Array to clone. + Returns cloned array. + + + + Clones object array. + + Array to clone. + Returns cloned array. + + + + Clones object that implements ICloneable interface. + + Object to clone. + A clone of the object. + + + + Clones object that implements ICloneable interface. + + Object to clone. + A clone of the object. + + + + Clones List with objects that implement ICloneable interface. + + List with objects to clone. + List with clone of the objects. + + + + Clones List with objects that implement ICloneable interface. + + List with objects to clone. + List with clone of the objects. + + + + Clones SortedList with objects that implement ICloneable interface. + + SortedList with objects to clone. + SortedList with clone of the objects. + + + + Clone SortedList. + + SortedList to clone + Returns a copy of the SortedList. + + + + Clones List with objects that implement ICloneable interface. + + List with objects to clone. + Parent object for the new items. + List with clone of the objects. + + + + Clones object that implements ICloneable interface. + + Object to clone. + Parent object for the new object. + A clone of the object. + + + + Clones MsoBase record. + + Object to clone. + Parent object. + A clone of the object. + + + + Clones byte array. + + Array to clone. + Return cloned array. + + + + Clones formula tokens array. + + Array to clone. + Return cloned array. + + + + Clones ColumnInfo array. + + Array to clone. + Return cloned array. + + + + Clone Dictionary. + + Dictionary to clone + Returns a copy of the Dictionary. + + + + Clone Dictionary. + + Dictionary to clone + Returns a copy of the Dictionary. + + + + Clone Dictionary. + + Dictionary to clone + Returns a copy of the Dictionary. + + + + Clone Dictionary. + + Dictionary to clone + Returns a copy of the Dictionary. + + + + Clone Dictionary. + + Dictionary to clone. + Parent object for the new objects. + Returns a copy of the Dictionary. + + + + Creates copy of the stream. + + Stream to copy. + Created stream. + + + + Creates a copy of the array of boolean values. + + Array to clone. + Created object. + + + + Summary description for CodeNameRecord. + + + + + + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, the class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + + + + Size of the required storage space. Read-only. + + + + + + + + + + Defines the formatting information for a range of columns including width, + outline, and collapsed options. + + + + + Bit mask for the outlevel value. + + + + + Maximum and correct record size. + + + + + Index of first column in the range. + + + + + Index of the last column in the range. + + + + + Width of the columns in 1/256 of the width of zero character, + using default font (first font record in the file). + + + + + Index of extended format record for default column formatting. + + + + + Options: Use bit fields instead of using this field. + + + + + Columns are hidden. + + + + + Columns are collapsed. + + + + + Not used. + + + + + Default Constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Sets options into default state without setting extended format index. + + + + + Index of first column in the range. + + + + + Index of the last column in the range. + + + + + Width of the columns in 1/256 of the width of the zero character, + using default font (first font record in the file). + + + + + Index of extended format record for default column formatting. + + + + + Columns are hidden. + + + + + Gets or sets a value indicating whether this instance is best fit. + + + true if this instance is best fit; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is user set. + + + true if this instance is user set; otherwise, false. + + + + + Gets or sets a value indicating if the phonetic information should be displayed by default for the affected column(s) of the worksheet. + + + true if this instance is phenotic; otherwise, false. + + + + + Outline level of the columns (0 = no outline). + This property changes bits of private m_usOptions field. + Set method would raise ArgumentOutOfRange exception + if value is more than 7. + + + + + If 1, then columns are collapsed. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's internal data array. + + + + + Row or column index. + + + + + Specifies the Header structure of this record + + + + + Specifies wheather the workbook checks the Compability of earlier version + + + + + Specifies wheather the workbook checks the Compability of earlier version + + + + + Whenever the content of the record exceeds the given limits, + the record must be split. Several Continue Records containing + the additional data are added after the parent record. + + + + + Summary description for ILengthSetter. + + + + + Sets length of the internal data. + + New length to set. + + + + + + + + + + Sets internal data array. + + Data array to set. + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, a class must pack its own properties into + an internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + + + + Size of the required storage space. Read-only. + + + + + + + + + + This record stores the contents of an external cell or cell range. + An external cell range has only one row. If a cell range spans over more than + one row, several CRN records will be created. + + + + + Offset to the values. + + + + + Error message. + + + + + Default subitem size (boolean, error and number). + + + + + Unused bytes for boolean and error cell values. + + + + + Index to last column inside of the referenced sheet. + + + + + Index to first column inside of the referenced sheet. + + + + + Index to row inside of the referenced sheet. + + + + + Array of cell values. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Data provider that contains record's data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + + + + + + + + + + + Returns size of the required storage space. + + Excel version. + Size of the required storage space. + + + + Creates copy of the current object. + + A copy of the current object. + + + + + + + + + Index to last column inside of the referenced sheet. + + + + + Index to first column inside of the referenced sheet. + + + + + Index to row inside of the referenced sheet. + + + + + Read-only. Minimum possible size of the record. + + + + + Array of cell values. + + + + + + + + + + Summary description for CustomPropertyRecord. + + + + + Size of fixed data. + + + + + Max length of name string. + + + + + Unknown record header. + + + + + Property name. + + + + + Property value. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Returns size of the required data array. + + Size of the required data array. + + + + Gets / sets property name. + + + + + Gets / sets property value. + + + + + Row height for rows with undefined or inexplicitly defined heights. + + + + + Correct record size. + + + + + Option flags. + + + + + Default row height for undefined rows / rows with undefined height. + + + + + Specifies whether the default settings for the row height have been changed.. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Option flags. + + + + + Default row height for undefined rows / rows with undefined height. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Stores the maximum change of the result to the exit of an iteration. + + + + + Default value of the maximum change in iteration. + + + + + Correct record size. + + + + + Maximum change in iteration (IEEE floating-point value). + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Maximum change in iteration (IEEE floating-point value). + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Contains the range address of the used area in the current sheet. + + + + + Correct record size. + + + + + Index to first used row. Zero base. + + + + + Index to last used row. One base. + + + + + Index to first used column. Zero base. + + + + + Index to last used column. One base. + + + + + Not used. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Index to first used row. + + + + + Index to last used row. + + + + + Index to first used column. + + + + + Index to last used column. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record is part of the Data Validity Table. It stores data validity settings + and a list of cell ranges which contain these settings. The "prompt box" appears + while editing such a cell. The "error box" appears if the entered value does not + fit the conditions. The data validity settings of a sheet are stored in a sequential + list of DV records. This list is preluded by a DVAL record. If a string is empty + and the default text should appear in the prompt box or error box, the string + must contain a single zero character (string length will be 1). + + + + + Bit mask for data type. + + + + + Bit mask for error style. + + + + + Bit mask for condition. + + + + + Start bit of the error style in options. + + + + + Start bit of the condition in options. + + + + + + + + + + Size of the fixed part. + + + + + Evaluates size of the formula in bytes. + + Tokens to get size from. + Excel version that should be used to infill data. + Indicates whether we should add size of the additional data. + Formula size in bytes. + + + + It indicates the end of a record block with leading BOF record. + This could be the end of the workbook globals, a worksheet, a chart, etc. + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record specifies the number of XF records contained in this file and that contains a checksum of the data in those records. + This record MUST exist if and only if there are XFExt records in the file. + + + + + Header of this record + + + + + Specifies the number of XF records + + + + + Specifies the Checksum of the record + This checksum is used to detect whether the XF records in the file were modified by an + application that does not support the formatting feature extensions in XFExt records. + + + + + current parent workbook + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Get the size + + + + + Clone current Record. + + Returns memberwise clone on current object. + + + + One of the most complex records. There are two types: + Style and Cell. It should be noted that fields in the extended format record are + somewhat arbitrary. Almost all of the fields are bit-level, but + we name them as best as possible by functional group. In some + places, this is more conducive than others. + + + + + Indent bit mask: + + + + + Read order bit mask: + + + + + Start bit for read order value. + + + + + Parent index bit mask: + + + + + Rotation bit mask: + + + + + Top border palette bit mask: + + + + + Bottom border palette bit mask: + + + + + Diagonal bit mask: + + + + + Diagonal line bit mask: + + + + + Fill pattern bit mask: + + + + + Left border bit mask: + + + + + Right border bit mask: + + + + + Top border bit mask: + + + + + Bottom border bit mask: + + + + + Horizontal alignment bit mask: + + + + + Vertical alignment bit mask: + + + + + Background bit mask: + + + + + Foreground border bit mask: + + + + + Left border palette bit mask: + + + + + Right border palette bit mask: + + + + + Start bit for the right border bit mask: + + + + + + + + + + Mask for FillForeground property. + + + + + Default color index. + + + + + Default pattern color index. + + + + + Maximum possible index in the extended format, means that there is no parent. + + + + + Default value for HAlignJustify + + + + + Default value for VAlignJustify + + + + + Index to font record. + + + + + Index to FORMAT record. + + + + + Cell options. + + + + + True if cell is locked. + + + + + True if formula is hidden. + + + + + Type of extended format record, False = Cell XF; True = Style XF. + + + + + + + + + + Alignment options of the extended format. + + + + + True indicates that text is wrapped at right border. + + + + + For far east languages. Supported only for format, always 0 for US. + + + + + Indent options of the extended format. + + + + + True indicates shrinking content to fit into cell. + + + + + True indicates that XF contains merged cells. + + + + + Flag for number format, if False, then an attribute of the parent style is used. + + + + + Flag for font, if False, then an attribute of the parent style is used. + + + + + Flag for horizontal and vertical alignment, text wrap, indentation, + orientation, rotation, and text direction. If False, then an attribute + of the parent style is used. + + + + + Flag for border lines. + If False, then an attribute of the parent style is used. + + + + + Flag for background area style. + If False, then an attribute of the parent style is used. + + + + + Flag for cell protection (cell locked and formula hidden). + If False, then an attribute of the parent style is used. + + + + + Indent value. + + + + + Border options: + + + + + Palette options: + + + + + True if diagonal line runs from top left to right bottom. + + + + + True if diagonal line runs from bottom left to right top. + + + + + Additional palette options: + + + + + Fill options: + + + + + Indicates whether hash is valid. + + + + + Current hash value. + + + + + Index to the parent extended format. + + + + + Extended format fill pattern type. + + + + + Index of Fill. + + + + + Index of Border. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for the record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Compares with Extended format record. + + Param to compare. + Returns compare results. + + + + Serves as a hash function for a particular type, suitable for use + in hashing algorithms and data structures like a hash table. + + A hash code for the current Object. + + + + Swaps colors if necessary. + + + + + Copies border settings from another extended format record. + + Source record to copy data from. + + + + Copies alignment settings from another extended format record. + + Source record to copy data from. + + + + Copies pattern settings from another extended format record. + + Source record to copy data from. + + + + Copies protection / cells settings from another extended format record. + + Source record to copy data from. + + + + Copies data from the current ExtendedFormat record to the specified + ExtendedFormat record. + + ExtendedFormat record that will receive data from + the current record. + + + + Copies data from the current Biff record to the specified Biff record. + + Biff record that will receive data from the current record. + + + + Cell options bits in one location. Read-only. + + + + + Border options bits in one location. Read-only. + + + + + Alignment options bits in one location. Read-only. + + + + + Index to font record. + + + + + Represent the fill index + + + + + Represent the Border Index + + + + + Index to FORMAT record: + + + + + True if cell is locked. + + + + + True if formula is hidden. + + + + + Type of extended format record. + + + + + + + + + + Gets /sets index to parent style XF (always FFFH in style XFs in Excel 97). + + + + + True means that text is wrapped at right border. + + + + + For far east languages supported only for format, always use False for US. + + + + + Gets or sets indent level. + + + + + True means to shrink content to fit into cell. + + + + + True if extended format contains merged cells. + + + + + Text direction, the reading order for far east versions. + + + + + Text rotation angle: + 0- Not rotated + 1-90- 1 to 90 degrees counterclockwise + 91-180- 1 to 90 degrees clockwise + 255- Letters are stacked top-to-bottom, but not rotated. + + + Thrown when value is more than 0xFF. + + + + + Flag for number format, if False, then an attribute of the parent style is used. + + + + + Flag for font, if False, then an attribute of the parent style is used. + + + + + Flag for horizontal and vertical alignment, text wrap, indentation, + orientation, rotation, and text direction. If False, then an attribute + of the parent style is used. + + + + + Flag for border lines. + If False, then an attribute of the parent style is used. + + + + + Flag for background area style. + If False, then an attribute of the parent style is used. + + + + + Flag for cell protection (cell locked and formula hidden). + If False, then attributes of the parent style is used. + + + + + Color index for top line color. + This property changes bits of the m_uiAddPaletteOptions class member. + + + Thrown when value is more than 0x7F. + + + + + Color index for bottom line color. + This property changes bits of the m_uiAddPaletteOptions class member. + + + Thrown when value is more than 0x7F. + + + + + Color index for left line color + This property changes bits of the m_usPaletteOptions class member. + + + Thrown when value is more than 0x7F. + + + + + Color index for right line color. + This property changes bits of the m_usPaletteOptions class member. + + + Thrown when value is more than 0x7F. + + + + + Color index for diagonal line color. + This property changes bits of the m_uiAddPaletteOptions class member. + + + Thrown when value is more than 0x7F. + + + + + Diagonal line style. + This property changes bits of the m_uiAddPaletteOptions class member. + + + Thrown when value is more than 0x0F. + + + + + Diagonal line is drawing from top left to bottom right corner of cell. + + + + + Diagonal line is drawing from bottom left to top right corner of cell. + + + + + Fill pattern: + This property changes bits of the m_uiAddPaletteOptions class member. + + + Thrown when value is more than 0x3F. + + + + + Left line style: + This property changes bits of the m_usBorderOptions class member. + + + + + Right line style: + This property changes bits of the m_usBorderOptions class member. + + + + + Top line style: + This property changes bits of the m_usBorderOptions class member. + + + + + Bottom line style: + This property changes bits of the m_usBorderOptions class member. + + + + + Horizontal alignment. + + + + + Vertical alignment. + + + + + Color index for pattern color + This property changes bits of m_usFillPaletteOptions. + + + Thrown when value is more than 0x7F. + + + + + Color index for pattern background. + This property changes bits of m_usFillPaletteOptions. + + + Thrown when value is more than 0x7F. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Type of extended format. + + + + + Represents the XF_CELL extended format type. + + + + + Represents the XF_STYLE extended format type. + + + + + Header of this record + + + + + Specifies the index of XF record which is extended + + + + + Property count + + + + + Set of properties applied to the XF format + + + + + Default constructor + + + + + Initialize the variables + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Get the size + + + + + Copies data from the current Biff record to the specified Biff record. + + Biff record that will receive data from the current record. + + + + Copies data from the current ExtendedXF record to the specified + ExtendedXF record. + + ExtendedXF record that will receive data from + the current record. + + + + Clone current Record. + + Returns memberwise clone on current object. + + + + + + + + + Specifies the index of XF record which is extended + + + + + Properties count + + + + + Set of properties applied to the XF format + + + + + Maximum tint value. + + + + + Type of the Extended property + + + + + Size of the Extended property + + + + + Type of the stored color. + + + + + Color value. + + + + + Tint and shade. + + + + + Reserved. + + + + + Font Scheme. + + + + + Text indentation level. + + + + + Gradient type. + + + + + Gradient angle. + + + + + Left coordinate of the inner rectangle. + + + + + Right coordinate of the inner rectangle. + + + + + Top coordinate of the inner rectangle. + + + + + Bottom coordinate of the inner rectangle. + + + + + No. of items in the gradstops. + + + + + Gradient color value. + + + + + Gradient position. + + + + + Gradient tint. + + + + + List of gradient stops. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Parse the gradient. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + Serialize the gradient. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Type of the Extended property + + + + + Size of the color Record + + + + + Color type + + + + + Color value + + + + + Tint value + + + + + Text Indentation level. + + + + + Set of gradstops. + + + + + Type of the stored color. + + + + + Gradient color value. + + + + + Gradient position. + + + + + Gradient tint. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Option flags. + + + + + One-based index to sheet in preceding SUPBOOK record, 0 + for global defined names (for external names), or + Not used (for add-in functions). + + + + + Not used. + + + + + External name (Unicode string, 8-bit string length) or + Add-in function name (Unicode string, 8-bit string length). + + + + + Size of the formula data. + + + + + Formula data or + 02H 00H 1CH 17H (formula representing the #REF! error code). + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, a class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + Infills internal data in the case of DDE link extern name. + + + + + Read-only. Option flags. + + + + + Read-only. One-based index to sheet in preceding SUPBOOK + record, 0 for global defined names (for external names), or + Not used (for add-in functions). + + + + + Read-only. Not used. + + + + + Read-only. Formula data or + 02H 00H 1CH 17H (formula representing the #REF! error code). + + + + + External name (Unicode string, 8-bit string length) or + Add-in function name (Unicode string, 8-bit string length). + + + + + Read-only. Minimum possible size of the record. + + + + + + + + + + Indicates whether data array is needed to store record data. Read-only. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Possible options flags. + + + + + The record stores a list with indexes to SUPBOOK records. + + + + + Size of the fixed part. + + + + + Maximum references in one record. + + + + + Number of following REF structures. + + + + + List of REF structures. + + + + + Represents the number of elements in rgXTI array + + + + + Default constructor. + + + + + This method adds one TREF structure to the list. + + SUPBOOK index. + Index to first SUPBOOK sheet. + Index to last SUPBOOK sheet. + + Index of the old REF structure (if there was one) + or new REF structure. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, a class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + Size of the required storage space. Read-only. + + + + + Number of following REF structures. + + + + + List of REF structures. + + + + + Read-only. Minimum possible size of the record. + + + + + Stores index to SUPBOOK record. + + + + + Size of the TREF. + + + + + Index to SUPBOOK record. + + + + + Index to first SUPBOOK sheet. + + + + + Index to last SUPBOOK sheet. + + + + + Constructs reference by SUPBOOK index and its start and end sheet. + + SUPBOOK index. + Index to first SUPBOOK sheet. + Index to last SUPBOOK sheet. + + + + Index to SUPBOOK record. + + + + + Index to first SUPBOOK sheet. + + + + + Index to last SUPBOOK sheet. + + + + + Summary description for FilePassStandardBlock. + + + + + Correct record size. + + + + + Unique document identifier used to initialize the encryption algorithm. + + + + + Encrypted document identifier used to verify the entered password. + + + + + Digest used to verify the entered password. + + + + + Default constructor. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Buffer length. + + + + + + + + + + Unique document identifier used to initialize the encryption algorithm. Read-only. + + + + + Encrypted document identifier used to verify the entered password. Read-only. + + + + + Digest used to verify the entered password. Read-only. + + + + + Summary description for FilePassStrongBlock. + + + + + Option flags. + + + + + Unknown value. + + + + + Stream encryption algorithm identifier. + 00006801H = RC4 (Ron's Code 4) + 00006802H = SEAL (Secure Encryption Algorithm) + + + + + Password hashing algorithm identifier: + 00008001H = MD2 (Message Digest 2) + 00008002H = MD4 (Message Digest 4) + 00008003H = MD5 (Message Digest 5) + 00008004H = SHA-1 (Secure Hash Algorithm) + + + + + Hash key length (bits). + + + + + Cryptographic provider type: + 00000001H = RSA + 0000000CH = RSA SChannel + 0000000DH = DSS and Diffie-Hellman + 00000012H = DH SChannel + 00000018H = RSA and AES + + + + + Unknown or not used. + + + + + Cryptographic provider name, Unicode character array with trailing null character. + + + + + Unique document identifier used to initialize the encryption algorithm. + + + + + Encrypted document identifier used to verify the entered password. + + + + + Digest used to verify the entered password. + + + + + Default constructor. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + + + + Option flags. + + + + + Unknown value. + + + + + Stream encryption algorithm identifier. + 00006801H = RC4 (Ron's Code 4) + 00006802H = SEAL (Secure Encryption Algorithm) + + + + + Password hashing algorithm identifier: + 00008001H = MD2 (Message Digest 2) + 00008002H = MD4 (Message Digest 4) + 00008003H = MD5 (Message Digest 5) + 00008004H = SHA-1 (Secure Hash Algorithm) + + + + + Hash key length (bits). + + + + + Cryptographic provider type: + 00000001H = RSA + 0000000CH = RSA SChannel + 0000000DH = DSS and Diffie-Hellman + 00000012H = DH SChannel + 00000018H = RSA and AES + + + + + Unknown or not used. Read-only. + + + + + Cryptographic provider name, Unicode character array with trailing null character. + + + + + Returns digest used to verify the entered password. Read-only. + + + + + The record represents an empty cell. + It contains the cell address and formatting information. + + + + + 1 = Recommend Read-only state while loading the file. + + + + + Hash value calculated from the Read-only password. + + + + + User name of the file creator. + + + + + Default constructor fills all data with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + 1 = Recommend Read-only state while loading the file. + + + + + Hash value calculated from the Read-only password. + + + + + Index to XF (extended format) record. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Font Record describes a font in the workbook (index = 0-3,5-infinity - skip 4) + An element in the Font Table contains information about a used font, + including character formatting. + + + + + Incorrect hash value. + + + + + Offset to the byte that indicates whether string is unicode. + + + + + Default font color. + + + + + Height of the font (in twips = 1/20 of a point). + + + + + Font attributes. + + + + + Palette color index. + + + + + Boldness (100-1000). Standard values are 0190H (400) for normal text + and 02BCH (700) for bold text. + + + + + Escapement: + + + + + Underline type: + + + + + Font family: + + + + + Character set: + + + + + Not used. + + + + + Font name: Unicode string, 8-bit string length. + + + + + Cached hash code value. + + + + + Represents the baseline value which indicates whether superscript or subscript + + + + + True if the font is set to capitalize. + + + + + Returns or sets the character spacing value of the font. + + + + + Returns or sets the kerning value of the font. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + 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. + + + + + Serves as a hash function for a particular type, suitable for + use in hashing algorithms and data structures like a hash table. + + A hash code for the current object. + + + + + + + + + + + + + + + + + Height of the font (in twips = 1/20 of a point). + + + + + Palette color index. + + + + + Boldness (100-1000). Standard values are 0190H (400) for normal text + and 02BCH (700) for bold text. + + + + + Escapement: + + + + + Gets or sets the baseline value which indicates whether superscript or subscript + + + + + Underline type: + + + + + Font family: + + + + + Character set: + + + + + Font name: Unicode string, 8-bit string length. + + + + + True if characters are italic. + + + + + True if characters are strikeout. + + + + + Whether to use the Mac outline font style (Mac only). + + + + + Whether to use the Mac shadow font style thing (Mac only). + + + + + True if the font is set to capitalize, character spacing or kerning value. + + + + + True if the font is set to capitalize. + + + + + Returns or sets the character spacing value of the font. + + + + + Returns or sets the kerning value of the font. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Font attributes. + + + + + Indicates whether this font is in italics. + + + + + Indicates whether characters are strikeout. + + + + + Whether to use the Mac outline font style (Mac only). + + + + + Whether to use the Mac shadow font style (Mac only). + + + + + All known flags. + + + + + Record contains information about a number format. + + + + + Format index used in other records: + + + + + Length of format string: + + + + + Format string: + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Format index used in other records: + + + + + Length of format string: + + + + + Read-only. Minimum possible size of record. + + + + + Contains the token array and the result of a formula cell. + + + + + This interface supports DoubleValue property. + + + + + Returns double value. Read-only. + + + + + Returns type code. Read-only. + + + + + Represents first mask + + + + + Represents boolean mask. + + + + + Represents error mask. + + + + + Represents error mask. + + + + + String mask. + + + + + String mask. + + + + + Size of the fixed part. + + + + + Formula value in the case of string value. + + + + + Formula value in the case of blank value. + + + + + Offset to the formula value. + + + + + Size of the data before expression that belongs only to formula (without row, column, xf indexes). + + + + + + + + + + + + + + + + + + + + The calculated value of the formula. + + + + + The option flags. + + + + + True to always recalculate. + + + + + True to calculate on open. + + + + + True if part of a shared formula. + + + + + Reserved. + + + + + Size of the following formula data. + + + + + Formula data (RPN token array). + + + + + Array that contains all parsed tokens. + + + + + + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + Parses formula expression and fill and provides internal integrity data check. + + Object that provides access to the data. + Record's data offset. + Excel version that was used to infill data provider. + + If there is any internal error. + + + + + Prepares expression field. + + + + + Sets bool or error value. + + Represents bool or error byte value. + Indicates if this is error. + + + + Size of the required storage space. Read-only. + + + + + Converts error or bool value to formula double value. + + Represents error or bool value. + Indicates is error or bool. + Returns formula value. + + + + Sets flags so MS Excel understands that formula returns string. + + Object that provides access to the data. + Offset to the FormulaRecord.. + + + + Reads record's value from the data provider. + + Provider to read data from. + Offset to the record's start. + Excel version used to infill data. + Record's value. + + + + Reads record's value from the data provider. + + Provider to read data from. + Offset to the record's start. + Excel version used to infill data. + Record's value. + + + + Reads record's value from the data provider. + + Provider to read data from. + Offset to the record's start. + Excel version used to infill data. + Record's value. + + + + Writes record's value into the data provider. + + Provider to write data into. + Offset to the record's start. + Excel version used to infill data. + Record's value. + + + + + + + + + + + + + + + + Converts formula tokens from Excel97to2003 to Excel2007 version and vice versa. + + Formula tokens. + Defines what conversion must be applied. + + + + Converts formula GOTO and IF token from Excel97to2003 to Excel2007 version and vice versa. + + Formula tokens. + GOTO token index. + Defines what conversion must be applied. + + + + The calculated value of the formula. + + + + + True to always recalculate. + + + + + True to calculate on open. + + + + + True if part of a shared formula. + + + + + Array that contains all parsed tokens. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + + + + + + The calculated value of the formula. + + + + + Indicates if formula record contain bool value. Read-only. + + + + + Indicates if formula record contain error value. Read-only. + + + + + + + + + + The calculated boolean value of the formula. + + + + + The calculated error value of the formula. + + + + + Array that contains all parsed tokens. + + + + + This token contains a 3D reference or an external reference to a cell range. + + + + + This token contains the reference to a cell range in the same sheet. + + + + + This class is the base class for each token of a formula. + + + + + Code of the token. + + + + + Default constructor. + + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Returns size of the tokens array. + + Excel version - defines resulting size. + Size of the tokens array. + + + + Converts token to byte array. + + Excel version - defines resulting array format and size. + Array of bytes representing this token. + + + + Converts token to a string. + + String representation of the token. + + + + Converts token to the string. + + Formula util. + String representation of the token. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + + + + + Indicates whether R1C1 notation must be used. + Formula util. + + + + + + + + + + Indicates whether R1C1 notation must be used. + Formula util. + + + + + + Moves token by iRowOffset to the right and iColumnOffset to the left. + (Updates formula token after copy operation.) + + Row offset. + Column offset. + Parent workbook. + Updated token. + + + + Adjusts the location of the token by the specified amount. + Returns adjusted token. (Updates formula token after move operation.) + + Index of the sheet where formula is located. + Zero-based row index which this token is located. + Zero-based column index where this token is located. + Index of the source worksheet in move range operation. + Index of the destination worksheet in move range operation. + Rectangle that was moved. + Location were range was moved. + Indicates whether token was changed during move operation. + Parent workbook. + Adjusted token. + + + + + + + + + + + + + + + + + + + + + + Converts tokens from regular formula into tokens from shared formula. + + Represents parent workbook. + Represents row index. + Represents column index. + Formula token. + + + + Compares this token to the specified one. + + Token to compare with. + 0 if tokens are equal. + + + + Compares tokens content. + + Token to compare with this one. + 0 if tokens are equal. + + + + Compares two token arrays. + + The first array to compare. + The second array to compare. + True if arrays are equal; otherwise false. + + + + + + + + + + Converts index to token code. + + + + + + + + Read-only. True if this ptg represents operation ptg. + + + + + Gets / sets. Code of the token. + + + + + This interface should be implemented by those tokens + that can be converted to IRange. + + + + + This interface should be implemented by those tokens + that can be converted to IRange. + + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Worksheet that contains range. + Range represented by the token. + + + + This interface is implemented by formula tokens that can provide corresponding rectangle object. + + + + + Returns rectangle represented by the token that implements this interface. + All coordinates are zero-based. + + Rectangle represented by the token. + + + + Updates token using data from specified rectangle. + + Rectangle with new token coordinates. + Updated token. + + + + Converts current token into error token. + + Created token. + + + + Summary description for IToken3D. + + + + + Converts current token to the 3D token. + + Reference to the worksheet. + Created token. + + + + Index of first row (0..65535) or row offset (-32768..32767). + + + + + Index of last row (0..65535) or row offset (-32768..32767). + + + + + Index of first column (0..255) or column offset (-128..127). + + + + + Option flags of first row and first column. + + + + + Index of last column (0..255) or column offset (-128..127). + + + + + Option flags of last row and last column. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Creates copy of the token. + + Token to clone. + + + + + + + + + + + + + + + Creates token using strings that represents cell addresses. + + Row index of the cell that contains this token. + Column index of the cell that contains this token. + String representation of the first row. + String representation of the first column. + String representation of the last row. + String representation of the last column. + + Parent workbook. + + + + Parses specified column and row values and fills token + fields with appropriate values. + + Row index of the cell that contains this token. + Column index of the cell that contains this token. + String representing left column of the area. + String representing top row of the area. + String representing right column of the area. + String representing bottom row of the area. + Indicates whether R1C1 notation is used. + Parent workbook. + + + + Converts token code to index (inverse operation to IndexToCode). + + Reference index. + + + + Gets corresponding error code. + + Corresponding error code. + + + + Indicates whether area covers whole rows. Read-only. + + + + + + + Indicates whether area covers whole columns. Read-only. + + + + + + + Converts incorrect area range to corresponding error ptg. + + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Converts specified index to token code. + + Index of the needed token. + Token that corresponds to the index. + + When index is less than one or greater than 3. + + + + + Converts specified token code to index. + + Token code for which index is required. + Index that corresponds to the code. + + When index is not one of tArea1, tArea2, tArea3. + + + + + Read-only. Size of the record. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to byte array. + + Array of bytes representing token. + + + + Moves row by iRowOffset, iColumnOffset. + + Row offset. + Column offset. + Parent workbook. + Updated token. + + + + + + + + + + + + + + Parent workbook. + + + + + Converts tokens from regular formula into tokens from shared formula. + + Parent workbook. + Represents first row from cells range of shared formula.Zero-base. + Represents first column from cells range of shared formula.Zero-based. + New token for shared formula. + + + + Converts full row or column ptg from Excel2007 to Excel97to03 version and vice versa. + + Returns converted Ptg. + Defines what conversion must be applied. + + + + + + + + + + + + + + + + Returns True if referenced cell was moved. + + + + + + + + + + + + + + Parent workbook. + + + + + + + + + + + + Parent workbook. + + + + + + + + + + + + Parent workbook. + + + + + Checks if while moving rectSource full top row was moved. + + Rectangle that was moved. + True if whole top row was moved. + + + + Checks if while moving rectSource full bottom row was moved. + + Rectangle that was moved. + True if whole bottom row was moved. + + + + Checks if while moving rectSource full left row was moved. + + Rectangle that was moved. + True if whole left row was moved. + + + + Checks if while moving rectSource full right row was moved. + + Rectangle that was moved. + True if whole right row was moved. + + + + + + + + + + + Parent workbook. + + + + + + + + + + + + Parent workbook. + + + + + + + + + + + + Parent workbook. + + + + + + + + + + + + Parent workbook. + + + + + + + + + + + + Parent workbook. + + + + + Checks whether one rectangle is outside of another one. + + First rectangle to check. + Second rectangle to check. + True if toCheck rectangle is outside of owner rectangle. + + + + Checks whether one rectangle is inside of another one. + + Rectangle that could contain another one. + Rectangle that could be contained by another one. + True if toCheck rectangle is contained by owner rectangle. + + + + + + + + + + + Parent workbook. + + + + + + + + + + + + Parent workbook. + + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Worksheet that contains range. + Range represented by the token. + + + + Returns rectangle represented by the token that implements this interface. + All coordinates are zero-based. + + Rectangle represented by the token. + + + + + + + + + + + Converts current token into error token. + + Created token. + + + + Converts current token to the 3D token. + + Reference to the worksheet. + Created token. + + + + Index of the first row (0..65535) or row offset (-32768..32767). + + + + + True if the first row index is relative. + + + + + True if the first column index is relative. + + + + + Index to column (0..255) or column offset (-128..127). + + + + + Index of the last row (0..65535) or row offset (-32768..32767). + + + + + True if the last row index is relative. + + + + + True if the last column index is relative. + + + + + Index to column (0..255) or column offset (-128..127). + + + + + Options for the top left cell of the range. + + + + + Options for the bottom right cell of the range. + + + + + Represents tokens that contains reference to worksheet. + + + + + This interface should be implemented by those tokens which contains 3D references. + + + + + Index to ExternSheetRecord. + + + + + Calls ToString method of the base (not 3d) class. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Index to REF entry in EXTERNSHEET record. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Creates new token based on another Area3D token. + + Token to copy. + + + + Initializes new token. + + Worksheet reference index. + Zero-based first row index. + Zero-based first column index. + Zero-based last row index. + Zero-based last column index. + First cell options. + Second cell options. + + + + Initializes new token. + + Zero-based row index of the cell that will contain new token. + Zero-based column index of the cell that will contain new token. + Worksheet reference index. + String representation of the first row of the area. + String representation of the first column of the area. + String representation of the last row of the area. + String representation of the last column of the area. + Indicates whether strings are in R1C1 notation. + Parent workbook. + + + + Read-only. Size of the token. + + + + + Converts token to array of bytes. + + Array of bytes that represents this token. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + To check the sheet name it's having any special charecter or not + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Parent workbook. + + + + + Converts incorrect area range to corresponding error ptg. + + + + + Calls ToString method of the base (not 3d) class. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Converts specified index to the token code. + + Function parameter index. + Token code that corresponds to the specified index. + + When index is less than 1 or greater than 3. + + + + + Converts specified token code to index. + + Token code for which index is required. + Index that corresponds to the code. + + When index is not one of tArea1, tArea2, tArea3. + + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Worksheet that contains range. + Range represented by the token. + + + + Reference to the worksheet. Read-only. + + + + + Summary description for AreaError3dPtg. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + + + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token code to index (inverse operation to IndexToCode). + + Reference index. + + + + Converts specified index to the token code. + + Function parameter index. + Token code that corresponds to the specified index. + + When index is less than 1 or greater than 3. + + + + + Converts specified token code to index. + + Token code for which index is required. + Index that corresponds to the code. + + When index is not one of tAreaErr3d1, tAreaErr3d2, tAreaErr3d3. + + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Worksheet that contains range. + Range represented by the token. + + + + This token contains the last reference to a deleted cell range in the same sheet. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + + + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token code to index (inverse operation to IndexToCode). + + Reference index. + + + + Converts specified index to token code. + + Index of the needed token. + Token that corresponds to the index. + + When index is less than one or greater than 3. + + + + + Converts specified token code to index. + + Token code for which index is required. + Index that corresponds to the code. + + When index is not one of tAreaErr1, tAreaErr2, tAreaErr3. + + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Worksheet that contains range. + Range represented by the token. + + + + This token contains the reference to a cell range in the same sheet. + + + + + Default constructor. To prevent user from creating tokens without + parameters and to allow descendants. + + + + + Converts token from shared formula into token from regular formula. + + Parent workbook. + Row index. + Column index. + New token for regular formula. + + + + Converts token code to index (inverse operation to IndexToCode). + + Token code (should be one of tAreaN1, tAreaN2, tAreaN3). + Reference index. + + + + Converts reference index to token code. + + Reference index. + Token code. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Gets the index of the updated row. + + The i row. + The row. + if set to true [is first]. + + + + + Gets the index of the updated column. + + The i column. + The column. + if set to true [is first]. + + + + + First column offset (-128..127). + + + + + Column offset (-128..127). + + + + + This token contains an array constant. The values of the array constant do not follow + the token identifier but are stored behind the complete token array. + + + + + This interface should be implemented by all token classes that + needs some additional data to be read after all formula tokens. + + + + + Reads additional token data that is placed after all formula tokens. + + Object that provides access to the data. + Offset to the additional token data. + Final offset in the data array. + + + + Returns size of the additional data. Read-only. + + + + + Constant that indicates that there is double value in the array. + + + + + Constant that indicates that there is string value in the array. + + + + + Constant that indicates that there is boolean value in the array. + + + + + Constant that indicates that there is error code in the array. + + + + + Constant that indicates that there is null code in the array. + + + + + Separators between rows of the array. + + + + + Separators between columns of the array. + + + + + Number of columns decreased by 1. + + + + + Number of rows decreased by 1. + + + + + Array of cached values. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Reads array from byte array. + + Object that provides access to the data. + Starting position of array data. + Offset if the first byte after array. + + When data array is too small for tArray data. + + + + + Fills tArray token with data from byte array. + + Object that provides access to the data. + Offset in data array. + Number of columns in this array. + Number of rows in this array. + Returns final offset in data array. + + + + Returns all values in data array. Must be written after formula data. + + Array of bytes of all constants stored in the array. + + + + Returns an array representation of boolean value. + + Boolean value that will be converted. + Array of bytes representing boolean value. + + + + Returns an array representation of the error code value. + + Error code. + Array of bytes representing the error code. + + + + Returns an array representation of the null code value. + + Array of bytes representing the null code. + + + + Returns an array representation of double value. + + Double value that will be converted. + Array of bytes representing double value. + + + + Returns an array representation of the string value. + + String value that will be converted. + Array of bytes representing the string value. + + + + Read-only. Size of the array token. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts tArray token to byte array. + + Excel version - defines resulting array format and size. + Array of bytes representing this token. + + + + Returns token code by index. + + Index of the needed token. + + + When index is less than 1 or larger than 3. + + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + + + + + + A special attribute control token - typically either a SUM function or an IF function. + + + + + This class represents function with variable arguments number in a formula. + + + + + This class represents function token of a formula. + + + + + This class is the base class for all operation tokens in the formula. + + + + + Default arguments separator. + + + + + String representation of the operation. + + + + + Position of the operand (before (if it is set to False) or after (if it is set to True) operand) for unary operations. + + + + + Default constructor. + + + + + Converts the operation and its operands to the string. + Gets all needed operands from the Stack parameter and pushes the result into the Stack. + + Object used for formula parsing. + + Stack that contains all operands and receives result of the operation. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Returns arguments separator. + + FormulaUtil object, to get separator from. + Arguments separator. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Read-only. True if this class represents operation (always True for this class). + + + + + Gets / sets string representation of the operation. + + + + + Gets / sets True if operation sign should be placed after operand and False otherwise. + + + + + Array of all token attributes applied to the object. + This property is used to increase performance. + + + + + Delimiter between function arguments. + + + + + Index to built-in sheet function. + + + + + Number of arguments. + + + + + Default constructor + + + + + Constructs token by function index. + + Function index. + + + + + + + + + + + Read-only. Size of the token. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts the operation and its operands to the string. + Gets all needed operands from the Stack parameter and pushes the result into the Stack. + + Object used for formula parsing. + + Stack that contains all operands and receives result of the operation. + + + + + Converts token to byte array. + + Array of bytes representing this token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Returns built-in function index. + + + + + Number of function arguments. + + + + + Array of all token attributes applied to the object. + This property is used to increase performance. + + + + + Constructs token by built-in function index. + + Built-in function index. + + + + Default constructor + + + + + Read-only. Size of the token. + + + + + Converts token to byte array. + + Array of bytes representing this token. + + + + Takes all needed operands from the stack and pushes the result of the function. + + Object used for formula parsing. + + Stack that contains all operands and will receive result of the operation. + + + + + + + + + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Size of the token. + + + + + Size of word in bytes. + + + + + Sum function name. + + + + + If function name. + + + + + Goto function name. + + + + + Choose function name. + + + + + Not implemented message. + + + + + + + + + + The options used by the attribute. + + + + + The word contained in this attribute. + + + + + Offsets to the CHOOSE cases. Must be valid only if HasOptimizedChoose is true. + + + + + Default constructor for this token. + + + + + Constructs token by options value and data. + + Attribute options. + Attribute data. + + + + Constructs token by options value and data. + + Attribute options. + Attribute data. + + + + Read-only. Size of the token. + + + + + Takes all needed operands from the stack and pushes the result of the function. + + Object used for formula parsing. + + Stack that contains all operands that receive result of the operation. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to array of bytes. + + Array of bytes representing this token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + The word contained in this attribute. + + + + + + + + + + Gets / sets number of spaces in the case of space token. + + + + + + + + + + True when following function has semivolatile value, + that can change without user interaction (such as NOW, TODAY, etc.). + + + + + Returns True if this is an IF; otherwise False. + + + + + Returns True if this is a CHOOSE; otherwise False. + + + + + Returns True if this is a goto; otherwise False. + + + + + Returns True if this is SUM; otherwise False. + + + + + Returns True if space exist; otherwise False. + + + + + + This class represents every binary operation. + + + + + Dictionary that allows to convert operation name to the token code. + + + + + Dictionary that allows to convert operation token code to its string representation. + + + + + Contains all token attributes. + + + + + Static constructor. Fills hashtable that allows us to get + token code by token string. + + + + + Returns token code by string representation of the operation. + + Token to get string representation for. + String representation of the token. + + + + Default constructor. + + + + + Constructs BinaryOperation using string that contains the sign of operation. + + Token code of the operation to create. + + + + Takes all needed operands from the stack and pushes the result of the operation. + + Object used for formula parsing. + + Stack that contains all operands and will receive result of the operation. + + + + + + + + + + Array of all token attributes applied to the object. + This property is used to increase performance. + + + + + This token represents a boolean operand in a formula. + + + + + Boolean value. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Constructs token by boolean value. + + Boolean value that will be placed into this token. + + + + Read-only. Size of this token. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to byte array. + + Array of bytes representing this token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Gets / sets boolean value that is represented by this class. + + + + + Represents CellRangeList formula token. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Constructs BinaryOperation using string that contains the sign of operation. + + String representation of the operation. + + + + Converts token to a string. + + Object used for formula parsing. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + This class represents the control token (this can be tExp or tTbl). + + + + + This token contains an unsigned 16-bit integer value in the range from 0 to 65535. + + + + + Bit mask for row options. + + + + + Bit mask for column options. + + + + + Opening bracket for relative cell coordinates in R1C1 notation. + + + + + Closing bracket for relative cell coordinates in R1C1 notation. + + + + + Starting row character in R1C1 notation. + + + + + Starting column character in R1C1 notation. + + + + + Opening bracket for relative indexes in R1C1 notation. + + + + + Closing bracket for relative indexes in R1C1 notation. + + + + + Index to row (0..65535) or row offset (-32768..32767). + + + + + Index to column (0..255) or column offset (-128..127). + + + + + Option flags. + + + + + Default constructor: + To prevent user from creating tokens without arguments + and to allow descendants to do this. + + + + + Creates token by coordinates and options. + + Row index. + Column index. + Options. + + + + Constructs reference by its string representation. + + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + String representation of the row. + String representation of the column. + Indicates whether R1C1 notation was used. + + + + Read-only. Size of the record. + + + + + Converts token to a string. + + String representation of the token. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to array of bytes. + + Array of bytes that represents the token. + + + + Sets internal fields appropriate to specified row and column. + + Row index of the cell that contains this token. + Column index of the cell that contains this token. + String that contains column name. + String that contains row name. + Indicates whether R1C1 notation is used. + + + + Sets internal fields appropriate to specified row and column. + + String that contains column name. + String that contains row name. + + + + Sets internal fields appropriate to specified row and column. + + Row index of the cell that contains this token. + Column index of the cell that contains this token. + String that contains column name. + String that contains row name. + + + + Parses row or column index in R1C1 notation. + + Row or column index of the cell that contains reference. + String to parse. + Indicates whether index is relative. + + + + + Creates token and modifies it row and column indexes. + + Row offset. + Column offset. + Parent workbook. + Modified token. + + + + Returns modified token after move operation. + + Current sheet index. + Parent cell row index. + Parent cell column index. + Source sheet index. + Source rectangle. + Destination sheet index. + Destination rectangle. + Indicates whether token was changed. + Parent workbook. + + + + + Moves token into different worksheet. + + Token to move + Source sheet index. + Source rectangle. + Destination sheet index. + Row offset. + Column offset. + Parent workbook. + Modified token. + + + + Returns True if referenced cell was moved. + + + + + + + Converts token code to index (inverse operation to IndexToCode). + + Reference index. + + + + Gets corresponding error code. + + Corresponding error code. + + + + Updates token after move operation. + + Current sheet index. + Destination sheet index. + Row index. + Column index. + Indicates whether token was changed. + Parent workbook. + Updated token. + + + + Converts tokens from regular formula into tokens from shared formula. + + Parent workbook. + Represents first row from cells range of shared formula.Zero-base. + Represents first column from cells range of shared formula.Zero-based. + New token for shared formula. + + + + Returns True if bit specified by mask is set to 1; otherwise False. + + Options byte where bits will be checked. + Bit mask that should be used for checking. + True if bit specified by mask is set to 1. + + + + If value is True, then it sets all bits specified by mask in Options to 1; + otherwise clears them, return new value. + + Options byte where bits will be set. + Bit mask that should be used for checking. + Flag for operation. + Return Options with bit specified by mask set to value. + + + + Returns string representation of the cell. + + Row index of the cell that contains token. + Column index of the cell that contains token. + Index of cell row. + Index of cell column. + True if row is relative. + True if column is relative. + Indicates whether R1C1 notation must be used for string conversion. + String representation of the cell address. + + + + Returns string representation of the cell using A1 notation. + + Index of cell column. + Index of cell row. + True if column is relative. + True if row is relative. + String representation of the cell address. + + + + Returns column index of the cell. + + Column index of the cell that contains token. + String representation of the column. + Column index. + Indicates whether R1C1 notation is used. + Indicates whether resulting column index is relative. + + When parsed column index is greater than 255. + + + + + Returns column index of the cell. + + String representation of the column. + Column index. + Indicates whether resulting column index is relative. + + When parsed column index is greater than 255. + + + + + Returns row index of the cell. + + Row index of the cell that contains token. + String representation of the row. + Indicates whether R1C1 notation is used. + Indicates whether row index is relative. + Row index. + + + + Returns row index of the cell. + + String representation of the row. + Indicates whether row index is relative. + Row index. + + + + Converts reference index to token code. + + Reference index. + Token code. + + + + Converts token code to index (inverse operation to IndexToCode). + + Token code (should be one of tRef1, tRef2, tRef3). + Reference index. + + + + Gets string representation of the cell in R1C1 notation. + + Row index of the cell that contains token. + Column index of the cell that contains token. + Cell row index. + Cell column index. + Indicates whether row is relative. + Indicates whether column is relative. + String representation of the cell in R1C1 notation. + + + + Converts row or column index into string representation using R1C1 notation. + + + Row or column index of a cell that contains reference to convert. + + Starting character. + End index. + Indicates whether index is relative. + String representation of row or column index using R1C1 notation. + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Worksheet that contains range. + Range represented by the token. + + + + Returns rectangle represented by the token that implements this interface. + All coordinates are zero-based. + + Rectangle represented by the token. + + + + + + + + + + + Converts current token to the 3D token. + + Reference to the worksheet. + Created token. + + + + Converts current token into error token. + + Created token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Gets / sets. Index to row (0..65535) or row offset (-32768..32767). + + + + + Gets / sets True if row index is relative. + + + + + Gets / sets True if column index is relative. + + + + + Gets / sets index to column (0..255) or column offset (-128..127). + + + + + Options. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Read-only. Size of the token. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to byte array. + + Array of bytes that represents this token. + + + + + + + + + Moves token into different worksheet. + + Token to move + Source sheet index. + Source rectangle. + Destination sheet index. + Row offset. + Column offset. + Parent workbook. + Modified token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + + + + + + + + + + + + This token contains an error code. + + + + + Default error name - used when unknown error code was used. + + + + + Dictionary that allows to get error code by error name. + + + + + Dictionary that allows to get error name by error code. + + + + + Error code. + + + + + Static constructor. Fills hashtables which allow to convert + error code to error string and vice versa. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Read-only. Size of the token. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to byte array. + + Array of bytes representing this token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + This token contains an IEEE floating-point number. + + + + + Floating-point value. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Constructs token by double value. + + Double value. + + + + Read-only. Size of the token. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + Represents current number info. + String representation of this token. + + + + Converts token to byte array. + + Array of bytes representing this token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Gets or sets the value that is represented by the token. + + + + + This class represents an integer token in formula. + + + + + Contains an unsigned 16-bit integer value in the range from 0 to 65535. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Constructs token by integer value. + + Integer value that will be placed into token. + + + + Read-only. Size of the token. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to array of bytes. + + Array of bytes corresponding to the token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Get or sets the value contained by this token. + + + + + Summary description for MemAreaPtg. + + + + + Size of the one rectangle data. + + + + + Size of the header block. + + + + + Reserved. + + + + + The length of the reference subexpression. + + + + + Subexpression. + + + + + + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Size of the ptg token. Read-only. + + + + + Converts token to byte array. + + Array of bytes representing this token. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Extracts additional data. + + Object that provides access to the data. + Offset to the additional data. + Offset after extracting all required data. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Returns the reference subexpression. Read-only. + + + + + Returns size of the additional data. Read-only. + + + + + Not fully implemented because of lack of documentation. + + + + + Size of the token. + + + + + Token data. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to the array of bytes. + + + + + + Read-only. Size of the token. + + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Not fully implemented because of lack of documentation. + + + + + Size of the token. + + + + + The length of the reference subexpression. + + + + + Token data. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Create new instance of MemFuncPtg. + + Size of new instance. + + + + Read-only. Size of the token. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to the array of bytes. + + + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + A missing argument in a function argument list that is stored as a tMissArg token. + This token does not contain any additional data. + + + + + Default constructor + + + + + Read-only. Size of the token. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + This token contains the one-based index to a NAME record. + + + + + One-based Index of ExternNameRecord. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Creates token by name index. + + Name index. + + + + Read-only. Size of the token. + + + + + Converts token to string. + + String representation of the token. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to array of bytes. + + Array of bytes representing this token. + + + + Returns token code by index. + + Index of the token code. + Required token code. + + When index is less than 1 or greater than 3. + + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Parent sheet. + Range represented by the token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Gets / sets one-based index of ExternNameRecord. + + + + + This token contains the index to a NAME or EXTERNNAME record. It occurs by using + internal or external names, add-in functions, DDE links, or linked OLE objects. + + + + + Index to a REF entry in an EXTERNSHEET record in the Link Table. + + + + + One-based index to a NAME record or EXTERNNAME record. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Creates new instance of NameX token by extern workbook index and name index in the workbook. + + Zero-based book index. + Zero-based name index. + + + + Read-only. Size of the record. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Calls ToString method of the base (not 3d) class. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to array of bytes. + + Array of bytes corresponding to the token. + + + + Returns token code by index + + Index of the token code. + Required token code. + + When index is less than 1 or greater than 3. + + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Parent worksheet + Range represented by the token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Gets / sets one-based index of ExternNameRecord or NameRecord. + + + + + Gets / sets index to REF entry in EXTERNSHEET record in the Link Table. + + + + + Parentheses. This token is for display purposes only, it does not affect the result + of the token array. If it follows an operator, the parentheses will enclose + the operator and its operand(s), which is the result of the enclosed + operation. This operator does not modify the token class of its operand. + + + + + This class represents all unary operations. + + + + + Contains all token attributes. + + + + + Dictionary that allows to get token code by unary operation name. + + + + + Static constructor. Fills hashtable that allows us to get + token code by token string. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Constructs unary operation token by its string representation. + + + String representation of the operation that will be created. + + + + + Read-only. Size of the token. + + + + + Takes all needed operands from the stack and pushes the result of the operation. + + Object used for formula parsing. + + Stack that contains all operands and will receive the result of the operation. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Array of all token attributes applied to the object. + This property is used to increase performance. + + + + + Contains all token attributes. + + + + + Static constructor. + + + + + Default constructor + + + + + Creates token by string representation. + + String should be equal to "(". + + When strFormula is not equal to "(". + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Gets all needed operands from the Stack parameter and pushes result into the Stack. + + Object used for formula parsing. + + Stack that contains all operands and will receive operation result as string. + + + + + Returns all TokenAttributes applied to the token. Read-only. + + + + + This token contains a 3D reference or an external reference to a cell. + + + + + Index to a REF entry in an EXTERNSHEET record in the Link Table. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Creates token. + + Sheet reference. + Row index. + Column index. + Options. + + + + Read-only. Size of the record. + + + + + Converts token to the string. + + String representation of the token. + + + + Converts token to the array of bytes. + + Array of bytes that represents this token. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Calls ToString method of the base (not 3d) class. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + + + + + + + + + + + Parent workbook. + + + + + Converts token code to index (inverse operation to IndexToCode). + + Reference index. + + + + Gets corresponding error code. + + Corresponding error code. + + + + Returns referenced worksheet name. + + Parent workbook. + Sheet reference index + Referenced worksheet name. + + + + Returns token code by index. + + Index of the token code. + Required token code. + + When index is less than 1 or greater than 3. + + + + + Converts token code to index (inverse operation to IndexToCode). + + Token code (should be one of tRef1, tRef2, tRef3). + Reference index. + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Worksheet that contains range. + Range represented by the token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + + + + + + This token contains the last 3D reference or external reference to a cell in a + deleted row or column. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Converts token to string. + + String representation of this token. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + + + + + + + + + + + Parent workbook. + + + + + Returns token code by index. + + Index of the token code. + Required token code. + + When index is less than 1 or greater than 3. + + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Worksheet that contains range. + Range represented by the token. + + + + This token contains the last reference to a deleted cell in the same sheet. + + + + + + + + + + Static constructor. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Converts token to a string. + + String representation of this token. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + + + + + + + + + + + Parent workbook. + + + + + Converts reference index to token code. + + Reference index. + Token code. + + + + Converts tokens from regular formula into tokens from shared formula. + + Parent workbook. + Represents first row from cells range of shared formula.Zero-base. + Represents first column from cells range of shared formula.Zero-based. + New token for shared formula. + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Worksheet that contains range. + Range represented by the token. + + + + This token contains the reference to a cell in the same sheet. It stores relative + components as signed offsets and is used in shared formulas, conditional formatting, + and data validity. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Converts token from shared formula into token from regular formula. + + Parent workbook. + Row index. + Column index. + New token for regular formula. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts current token to the 3D token. + + Reference to the worksheet. + Created token. + + + + Converts token code to index (inverse operation to IndexToCode). + + Token code (should be one of tRefN1, tRefN2, tRefN3). + Reference index. + + + + Converts reference index to token code. + + Reference index. + Token code. + + + + This token contains a string constant. + The maximum length of the string is 255 characters in BIFF8. + + + + + String value. + + + + + 1 - 2 bytes per character, 0 - 1 byte per character (compressed unicode). + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Constructs token by string value. + + Value that will contain this token. + + + + Read-only. Size of the token. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to array of bytes. + + Array of bytes that correspond to the token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Gets or sets the value of this token (its string constant). + + + + + Summary description for _FormulaConstants. + + + + + + + + + + Represents the tAdd binary token. + + + + + Represents the tSub binary token. + + + + + Represents the tMul binary token. + + + + + Represents the tDiv binary token. + + + + + Represents the tPower binary token. + + + + + Represents the tConcat binary token. + + + + + Represents the tLessThan binary token. + + + + + Represents the tLessEqual binary token. + + + + + Represents the tEqual binary token. + + + + + Represents the tGreaterEqual binary token. + + + + + Represents the tGreater binary token. + + + + + Represents the tNotEqual binary token. + + + + + Represents the tCellRangeIntersection binary token. + + + + + Represents the tCellRangeList binary token. + + + + + Represents the tCellRange binary token. + + + + + Represents the tUnaryPlus unary token. + + + + + Represents the tUnaryMinus unary token. + + + + + Represents the tPercent unary token. + + + + + Represents the tParentheses unary token. + + + + + Represents the tFunction1 function token. + + + + + Represents the tFunction2 function token. + + + + + Represents the tFunction3 function token. + + + + + Represents the tFunctionVar1 function token. + + + + + Represents the tFunctionVar2 function token. + + + + + Represents the tFunctionVar3 function token. + + + + + Represents the tFunctionCE1 function token. + + + + + Represents the tFunctionCE2 function token. + + + + + Represents the tFunctionCE3 function token. + + + + + Represents the tMissingArgument constant token. + + + + + Represents the tStringConstant constant token. + + + + + Represents the tError constant token. + + + + + Represents the tBoolean constant token. + + + + + Represents the tInteger constant token. + + + + + Represents the tNumber constant token. + + + + + Represents the tExp control token. + + + + + Represents the tTbl control token. + + + + + Represents the tExtended control token. + + + + + Represents the tAttr control token. + + + + + Represents the tSheet control token. + + + + + Represents the tEndSheet control token. + + + + + Represents the tArray1 operand token. + + + + + Represents the tArray2 operand token. + + + + + Represents the tArray3 operand token. + + + + + Represents the tName1 operand token. + + + + + Represents the tName2 operand token. + + + + + Represents the tName3 operand token. + + + + + Represents the tRef1 operand token. + + + + + Represents the tRef2 operand token. + + + + + Represents the tRef3 operand token. + + + + + Represents the tArea1 operand token. + + + + + Represents the tArea2 operand token. + + + + + Represents the tArea3 operand token. + + + + + Represents the tMemArea1 operand token. + + + + + Represents the tMemArea2 operand token. + + + + + Represents the tMemArea3 operand token. + + + + + Represents the tMemErr1 operand token. + + + + + Represents the tMemErr2 operand token. + + + + + Represents the tMemErr3 operand token. + + + + + Represents the tMemNoMem1 operand token. + + + + + Represents the tMemNoMem2 operand token. + + + + + Represents the tMemNoMem3 operand token. + + + + + Represents the tMemFunc1 operand token. + + + + + Represents the tMemFunc2 operand token. + + + + + Represents the tMemFunc3 operand token. + + + + + Represents the tRefErr1 operand token. + + + + + Represents the tRefErr2 operand token. + + + + + Represents the tRefErr3 operand token. + + + + + Represents the tAreaErr1 operand token. + + + + + Represents the tAreaErr2 operand token. + + + + + Represents the tAreaErr3 operand token. + + + + + Represents the tRefN1 operand token. + + + + + Represents the tRefN2 operand token. + + + + + Represents the tRefN3 operand token. + + + + + Represents the tAreaN1 operand token. + + + + + Represents the tAreaN2 operand token. + + + + + Represents the tAreaN3 operand token. + + + + + Represents the tMemAreaN1 operand token. + + + + + Represents the tMemAreaN2 operand token. + + + + + Represents the tMemAreaN3 operand token. + + + + + Represents the tMemNoMemN1 operand token. + + + + + Represents the tMemNoMemN2 operand token. + + + + + Represents the tMemNoMemN3 operand token. + + + + + Represents the tNameX1 operand token. + + + + + Represents the tNameX2 operand token. + + + + + Represents the tNameX3 operand token. + + + + + Represents the tRef3d1 operand token. + + + + + Represents the tRef3d2 operand token. + + + + + Represents the tRef3d3 operand token. + + + + + Represents the tArea3d1 operand token. + + + + + Represents the tArea3d2 operand token. + + + + + Represents the tArea3d3 operand token. + + + + + Represents the tRefErr3d1 operand token. + + + + + Represents the tRefErr3d2 operand token. + + + + + Represents the tRefErr3d3 operand token. + + + + + Represents the tAreaErr3d1 operand token. + + + + + Represents the tAreaErr3d2 operand token. + + + + + Represents the tAreaErr3d3 operand token. + + + + + Indicates end of formula token. This token is used only for parser + internal purposes and shouldn't appear in the resulting formula. + + + + + Indicates closing parenthesis. This token is used only for parser + internal purposes and shouldn't appear in the resulting formula. + + + + + Indicates delimiter between arguments. This token is used only for parser + internal purpose and shouldn't appear in the resulting formula. + + + + + Indicates open bracket. This token is used only for parser + internal purpose and shouldn't appear in the resulting formula. + + + + + Indicates close bracket. This token is used only for parser + internal purpose and shouldn't appear in the resulting formula. + + + + + Indicates boolean value - true. This token is used only for parser + internal purpose and shouldn't appear in the resulting formula. + + + + + Indicates boolean value - false. This token is used only for parser + internal purpose and shouldn't appear in the resulting formula. + + + + + Indicates space token. This token is used only for parser + internal purpose and shouldn't appear in the resulting formula. + + + + + Indicates identifier token. This token can be range, named range, function call, etc. + This token is used only for parser internal purpose and shouldn't appear in the resulting formula. + + + + + Indicates identifier token that contains DDE link. + This token is used only for parser internal purpose and shouldn't appear in the resulting formula. + + + + + Indicates 3D identifier token. This token can be range, named range. + This token is used only for parser internal purpose and shouldn't appear in the resulting formula. + + + + + Represents the operation type. + + + + + Represents the TYPE_UNARY operation type. + + + + + Represents the TYPE_BINARY operation type. + + + + + Represents the TYPE_FUNCTION operation type. + + + + + + + + + + None priority. + + + + + Logical equality priority. + + + + + Concatenation priority. + + + + + Plus and minus operation priority. + + + + + Multiplication and divide operations priority. + + + + + Priority of the power operation. + + + + + Unary operation priority (-,+,%). + + + + + Cell Range operator (:). + + + + + Attribute provides link information between formula token and + formula token class. + + + + + Type of the formula token. + + + + + String representation of the operation (if this is attribute for + operation), otherwise string.Empty. + + + + + True if operation symbol should be placed after operand + (only for unary operands). + + + + + Creates token attribute by Formula code. + + Code of the token that will be created. + + + + Creates token attribute by formula code and operation sign. + + Token code. + String representation of the operation. + + + + Creates token attribute by formula code, operation sign, and position of + placement (before the False or after the True operand - this is only for unary operations, + default value is False). + + Code of the operation. + String representation of the operation. + True if operation is placed after operands; False if before. + + + + Read-only. Type of the formula token. + + + + + Read-only. String representation of the operation (if this is attribute for + operation); otherwise string.Empty. + + + + + Read-only. True if operation symbol should be placed after operand + (only for unary operands). + + + + + There can be multiple token codes that correspond to one class, + i.e. tRef1, tRef2, tRef3 correspond to class RefPtg. + This attribute is used to help FormulaUtil choose the token code to use. + + + + + Index of the reference type (for tokens that can have several types). + + + + + Array of indexes, first correspond to first parameter, + second for the second parameter and so on. + + + + + Expected token type. + + + + + Creates attribute that describes the function that has + the same token index index for all arguments. + + Index of the token. + + + + Creates attribute for function with specified token indexes order. + First member of the array corresponds to the first argument of the function, + second member for the second argument and so on. + + Array of token indexes. + + + + Creates attribute for specified token type with specified token indexes. + + Target token class. + Array of token indexes. + + + + Creates attribute for specified token type with specified token indexes. + + Target token class. + Token index for all function parameters. + + + + Returns index of the reference. + + + + + Returns token index for the specified argument number. + + + + + Target token class + + + + + This attribute describes error code. Used for converting error messages from + and to string. + + + + + String that represents error. + + + + + Code of the error. + + + + + Creates attribute for error with specified string value and error code. + + String representation of the error. + Error code. + + + + + + + + + + + + + + This structure specifies a future record type header. + + + + + Type of the following data: + + + + + Option Attribute Flags + + + + + Type of the following data: + + + + + This record specifies if the option to print sheet grid lines + (PrintGridlinesRecord) has ever been changed. + + + + + Correct size of the record. + + + + + Flag denoting whether the user has modified the grid lines. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + This flag specifies if the option to print sheet grid lines + (PrintGridlinesRecord) has ever been changed. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Contains information about the layout of outline symbols. + + + + + Width of the area to display row outlines (left of the sheet), in pixels. + + + + + Height of the area to display column outlines (above the sheet), in pixels. + + + + + Number of visible row outline levels (used row levels + 1; + or 0, if not used). + + + + + Number of visible column outline levels (used column levels + 1; + or 0, if not used). + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Width of the area to display row outlines (left of the sheet), in pixels. + + + + + Height of the area to display column outlines (above the sheet), in pixels. + + + + + Number of visible row outline levels (used row levels + 1; + or 0, if not used). + + + + + Number of visible column outline levels (used column levels + 1; + or 0, if not used). + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Summary description for HeaderFooterImageRecord. + + + + + Record header in workbook part. + + + + + Record header in worksheet part. + + + + + Record header in workbook when it is not first record + (when it is used instead of Continue record). + + + + + Data offset. + + + + + Excel 2003 record length + + + + + Excel 2010 record length + + + + + Type of data in categories. + + + + + Type of data in categories. + + + + + Type of data in categories. + + + + + Type of data in categories. + + + + + Record databytes. + + + + + HeaderFooter Record Code + + + + + Default constructor, initializes all fields with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Contains a list of explicit column page breaks. + + + + + Size of the fixed part. + + + + + Size of the subitem. + + + + + Size of the fixed part. + + + + + Number of page breaks. + + + + + Array of HorizontalPageBreaks. + + + + + Default constructor, sets all fields' default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + When data array does not fit to the page breaks array. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + Size of the required storage space. Read-only. + + + + + Array of HorizontalPageBreaks. + + + + + Read-only. Minimum possible size of the record. + + + + + This class contains information about single page break. + + + + + The row of the break. + + + + + The starting column of the break. + + + + + The ending column of the break. + + + + + Default constructor + + + + + Constructs class instance and fills fields with values. + + Row of the break. + Starting column of the break. + Ending column of the break. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + The row of the break. + + + + + The starting column of the break. + + + + + The ending column of the break. + + + + + Tells whether to iterate over formula calculations or not + (if a formula is dependent upon another formula's result) + (odd feature for something that can only have 32 elements in a formula). + + + + + Correct record size. + + + + + 0 = Iterations off; 1 = Iterations on + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + 0 = Iterations off; 1 = Iterations on + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record represents a cell that contains a string. + In BIFF8, it is replaced by the LABELSST record. + Nevertheless, Excel can import a LABEL record contained in a BIFF8 file. + + + + + This interface supports StringValue property. + + + + + Returns string value. Read-only. + + + + + Size of fixed part. 6 bytes - row, column and xf index, 2 bytes string len, 1 byte string type. + + + + + Label - Unicode string + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + Size of the required storage space. Read-only. + + + + + Label - Unicode string + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Returns string value. Read-only. + + + + + Value of the record. + + + + + Represents a cell that contains a string. + Refers to a string in the shared string table and is a column value. + + + + + Correct size of the record. + + + + + Index offset. + + + + + Index into SST record. + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + Returns size of the required storage space. + + Excel version. + Size of the required storage space. + + + + Sets new index. + + Object that provides access to the data. + Offset to the start of the record data. + New SST index. + Excel version of the used data storage. + + + + Sets new index. + + Object that provides access to the data. + Offset to the start of the record data. + Excel version of the used data storage. + Index in the SST table. + + + + Index into SST record. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + + + + + + This record is part of the Page Settings block. + It contains the margin of the current worksheet. + + + + + Default value of top margin. + + + + + Correct record size. + + + + + It contains the top page margin of the current worksheet + (IEEE floating-point value). + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + Maximum change in iteration (IEEE floating-point value). + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's internal data array. + + + + + Contains all merged cell ranges of the current sheet. + Optional record defining a square area of cells to "merge" into one cell. + + + + + Maximum possible number of regions in the single MergeCells record. + + + + + Size of the fixed part. + + + + + Subitem size. + + + + + Number of ranges. + + + + + All merged cell ranges of the current sheet. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + This method checks a record's internal data array for integrity. + + + If there is any internal error. + + + + + Size of the required storage space. Read-only. + + + + + Copies regions to the internal array. + + First region to copy. + Regions count. + Array with regions to copy. + + + + Returns number of ranges. + + + + + All merged cell ranges of the current sheet. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + This class contains information about the region of merged cells. + + + + + First row of the region. + + + + + Last row of the region. + + + + + First column of the region. + + + + + Last column of the region. + + + + + To prevent creation without parameters. + + + + + Creates copy of region. + + Region to copy. + + + + Creates region by specified first and last rows and first and last columns. + + First row of the region. + Last row of the region. + First column of the region. + Last row of the region. + + + + Converts region into Rectangle. + + Rectangle corresponding to this region. + + + + Creates a copy of the current object. + + A copy of the current object. + + + + Compares two merged regions. + + First region to compare. + Second region to compare. + + + + + 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. + + + + Serves as a hash function for a MergedRegion object. + + A hash code for the current object. + + + + Read-only. First row of the region. + + + + + Gets/sets last row of the region. + + + + + Read-only. First column of the region. + + + + + Gets/sets last column of the region. + + + + + Returns number of cells used by + + + + + This record contains a drawing object provided by the Microsoft + Office Drawing tool. + + + + + Default constructor fills all data with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + + + + + + + + Sets length of the internal data. + + Length to set. + + + + Size of the required storage space. Read-only. + + + + + + + + + + + + + + + Summary description for ArrayWrapper. + + + + + Wrapped byte array. + + + + + Hash value. + + + + + Default constructor. To prevent user from creation without arguments. + + + + + Initializes new instance of the wrapper. + + Buffer to wrap. + + + + 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. + + + + + Serves as a hash function for a particular type, suitable for use in + hashing algorithms and data structures like a hash table. + + A hash code for the current Object. + + + + Evaluates hash value. + + + + + Summary description for Attributes. + + + + + + + + + + Creates new instance. + + Type of new instance + + + + + + + + + Summary description for MsoBase. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Dictionary key - Type of the MsoBase class, Value - its code. + + + + + Default constructor. + + + + + + + + + + + + + + + Fills internal data array. + + + + + Fills internal data array. + + Stream to write record data into. + Offset index. + List with breaks indexes in arrRecords. + List with records. + Returns array of bytes. + + + + Infills internal data array. + + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + Clone current instance. + + Parent object to create instance. + Returns cloned instance. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Updates NextMsoDrawingData. + + + + + Extracts record from the stream. + + Stream to get data from. + + + + + + + + + Converts from fixed point integer value into double. + + Value to convert. + Converted double value. + + + + Writes Int32 value int stream. + + Stream to write value into. + Value to write. + + + + Writes UInt32 value int stream. + + Stream to write value into. + Value to write. + + + + Writes Int16 value int stream. + + Stream to write value into. + Value to write. + + + + Writes UInt16 value int stream. + + Stream to write value into. + Value to write. + + + + Reads Int32 value from stream. + + Stream to read value from. + Value extracted from the stream. + + + + Reads UInt32 value from stream. + + Stream to read value from. + Value extracted from the stream. + + + + Reads Int16 value from stream. + + Stream to read value from. + Value extracted from the stream. + + + + Reads UInt16 value from stream. + + Stream to read value from. + Value extracted from the stream. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns maximum record size. Read-only. + + + + + Summary description for MsoPicture. + + + + + Common interface for all records that contains picture. + + + + + Picture that is contained by the record. + + + + + Picture id. + + + + + Size of the bitmap header. + + + + + Number of used colors. + + + + + Size of each color definition in the palette. + + + + + To specify two UIDs. + + + + + To specify BlipPNG's two UIDs. + + + + + To specify BlipJPEG's two UIDs. + + + + + Dib identifier. ("BM"). + + + + + Reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates new instance of object. + + Parent object. + Stream to get data from. + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + + + + + + + Clone current instance. + + Returns cloned instance. + + + + Creates image stream and fills it with necessary data. + + Stream to read image data from. + Offset to the image data. + + + + Indicates whether Art Blip contains Two Unique Id's. + + + + + + Returns number of used colors in the dib image. + + Number of used colors in the dib image. + + + + Evaluates hash value for the stored picture. + + + + + Adds bitmap header to stream. + + + + + + + + + + Gets or sets picture of that is contained in the record. + + + + + + + + + + + + + + + + + + + + Indicates whether this is dib bitmap. + + + + + Summary description for MsoContainerBase. + + + + + + + + + + Creates new instance of object. + + Parent object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + Clone current instance. + + Returns cloned instance. + + + + Array of items. Read-only. + + + + + Internal list of items (to increase performance). Read-only. + + + + + Summary description for MsoFactory. + + + + + Represents new hashtable + key - code; value - mso record. + + + + + + + + + + Creates Mso record. + + Parent object. + Stream to get data from. + Returns new instance of Mso record. + + + + Create Mso Record. + + Parent object. + Type of created record. + Stream with record's data. + Returns new instance of MsoBase record. + + + + Creates Mso record. + + Parent object. + Stream to get data from. + Data getter. + Returns new instance of Mso record. + + + + Create Mso Record. + + Parent object. + Type of created record. + Stream to get data from. + Data getter. + Returns new instance of Mso Base. + + + + + + + + + + + + + + + + + + Registers all known mso record types inside internal collections. + + + + + Summary description for MsofbtSpgr. + + + + + Correct record size. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + Size of the required storage space. Read-only. + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for MsofbtBSE. + + + + + + + + + + + + + + + + + + + + Required type on Win32. + + + + + Required type on Mac. + + + + + Blip size in stream. + + + + + Reference count on the blip. + + + + + File offset in the delay stream. + + + + + How this blip is used. + + + + + Length of the blip name. + + + + + For the future. + + + + + For the future. + + + + + + + + + + + + + + + Index of the record in the collection. + + + + + Path to the picture item (used in Excel 2007). + + + + + Creates new instance. + + Parent object. + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + Clone current instance. + + Returns cloned instance. + + + + + + + + + + + Required type on Win32. + + + + + Required type on Mac. + + + + + + + + + + Blip size in stream. + + + + + Reference count on the blip. + + + + + File offset in the delay stream. + + + + + How this blip is used. + + + + + Length of the blip name. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets / sets index of the bse in the collection. + + + + + Gets / sets path to the picture zip item. Used in Excel 2007 format. + + + + + Summary description for MsofbtBstoreContainer. + + + + + Default version of container. + + + + + Default instance of container. + + + + + + + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + Summary description for MsofbtSpgr. + + + + + Correct record size. + + + + + + + + + + + + + + + + + + + + + + + + + Creates new instance. + + Parent object. + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for MsofbtClientAnchor. + + + + + Mask for column / row index. + + + + + Mask for offset index. + + + + + + + + + + Length for short data. + + + + + Correct record size. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Indicates whether it is short version of client anchor. Used in headers/footers. + + + + + Zero-based top row index. + + + + + Top row offset. + + + + + Zero-based bottom row index. + + + + + Bottom row offset. + + + + + Indicates whether this anchor is oneCellAnchor (used in Excel 2007 format). + + + + + + + + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + Size of the required storage space. Read-only. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Indicates whether it is short version of client anchor. Used in headers/footers. + + + + + Indicates whether parent shape should be stored as oneCellAnchor or not. + Default value false. + + + + + Summary description for MsofbtSpgr. + + + + + + + + + + Creates new object. + + Parent object. + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + Clone current instance. + + Returns cloned instance. + + + + Updates NextMsoDrawingData. + + + + + Adds single record to the AdditionalData array. + + Record to add. + + + + Adds range of records to the AdditionalData array. + + Collection to add. + + + + Adds range of records to the AdditionalData array. + + Collection to add. + + + + + + + + + + + + + + Summary description for MsofbtSpgr. + + + + + + + + + + + + + + + + + + Creates new object. + + Parent object. + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + Clone current instance. + + Returns cloned instance. + + + + Updates NextMsoDrawingData. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for MsofbtDg. + + + + + Default instance. + + + + + Correct record size. + + + + + The number of shapes in this drawing. + + + + + The last MSOSPID given to an SP in this Drawing Group. + + + + + Creates new object. + + Parent object. + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + Size of the required storage space. Read-only. + + + + + The number of shapes in this drawing. + + + + + The last MSOSPID given to an SP in this Drawing Group. + + + + + Summary description for MsofbtDgContainer. + + + + + Default container version. + + + + + Creates new object. + + Parent object. + + + + Represents MsofbtDgg in MsoDrawing. + + + + + Default offset to the array. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates new object. + + Parent object. + + + + Parse Structure of record. Convert Data buffer to special + values according to record specification. + + + + + In this method, the class must pack all of it's properties into + an internal Data array: m_data. This method is called by + FillStream, when the record must be serialized into stream. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + Clone current instance. + + Returns cloned instance. + + + + Adds cluster. + + Group id. + Number. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Cluster Id. + + + + + Size of the record. + + + + + DG owning the SPIDs in this cluster. + + + + + Number of SPIDs used so far. + + + + + + + + + + + + + + + + + + + + + + + + + Converts record to the bytes array. + + Array of bytes with record's data. + + + + + + + + + + Clone current instance. + + Return shallow copy of current instance. + + + + DG owning the SPIDs in this cluster. + + + + + Number of SPIDs used so far. + + + + + Record's size. + + + + + Summary description for MsofbtDggContainer. + + + + + Default container version. + + + + + Creates new object. + + Parent object. + + + + Summary description for MsofbtOPT. + + + + + Minimum option index. + + + + + List with shape properties. + + + + + Creates new object. + + Parent object. + + + + + + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + Clone current instance. + + Returns cloned instance. + + + + Clone current instance. + + Returns cloned instance. + + + + + + + + + + + + + + + + + + Option to set + + + + Replaces option with specified value. + + Option to set. + + + + Searches for option in the record. + + Option to find. + Index of the option. + + + + Removes some option by index. + + Index of option to remove. + + + + Returns index of option index. + + + + + + + Array with shape properties. Read-only. + + + + + Returns singe option from the collection. Read-only. + + + + + Gets property list with all properties. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Property ID. + + + + + Value is a blip ID � only valid if fComplex is FALSE. + + + + + Complex property, value is length. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Clone current instance. + + Return Clone of current object. + + + + Property ID. + + + + + Value is a blip ID � only valid if fComplex is FALSE. + + + + + Complex property, value is length. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for MsofbtSpgr. + + + + + + + + + + Creates new object. + + Parent object. + + + + + + + + + + Summary description for MsofbtSp. + + + + + Default record version. + + + + + Record size. + + + + + + + + + + + + + + + This shape is a GroupShape. + + + + + Not a top-level shape. + + + + + This is the topmost GroupShape. Exactly one of these per drawing. + + + + + The shape has been deleted. + + + + + The shape is an OLE object. + + + + + Shape has a hspMaster property. + + + + + Shape is flipped horizontally. + + + + + Shape is flipped vertically. + + + + + Connector type of shape. + + + + + Shape has an anchor of some kind. + + + + + Background shape. + + + + + Shape has a shape type property. + + + + + Creates new object. + + Parent object. + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + Size of the required storage space. Read-only. + + + + + + + + + + + + + + + This shape is a GroupShape. + + + + + Not a top-level shape. + + + + + This is the topmost GroupShape. Exactly one of these per drawing. + + + + + The shape has been deleted. + + + + + The shape is an OLE object. + + + + + Shape has a hspMaster property. + + + + + Shape is flipped horizontally. + + + + + Shape is flipped vertically. + + + + + Connector type of shape. + + + + + Shape has an anchor of some kind. + + + + + Background shape. + + + + + Shape has a shape type property. + + + + + Summary description for MsofbtSpgrContainer. + + + + + Default version of container. + + + + + Creates new object. + + Parent object. + + + + Summary description for MsofbtSpgr. + + + + + Default record version. + + + + + Correct record size. + + + + + + + + + + + + + + + + + + + + + + + + + Creates new object. + + Parent object. + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for MsofbtSpgrContainer. + + + + + Default container version. + + + + + Creates new object. + + Parent object. + + + + Summary description for MsofbtSplitMenuColors. + + + + + Correct record size. + + + + + + + + + + + + + + + + + + + + + + + + + Creates new object. + + Parent object. + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents metafile picture in the workbook. + + + + + Default buffer size. + + + + + Offset to UID. + + + + + Offset to metafile size. + + + + + Offset to compressed size. + + + + + To specify BlipEMF's two UIDs. + + + + + To specify BlipWMF's two UIDs. + + + + + To specify BlipPICT's two UIDs. + + + + + To specify BlipTIFF's two UIDs. + + + + + Memory stream with picture data. + + + + + Array with compressed picture. + + + + + UID of the picture. + + + + + Primary UID. + + + + + Cache of the metafile size. + + + + + Boundary of metafile drawing commands. + + + + + Size of metafile in EMUs. + + + + + Cache of saved size (size of m_pvBits). + + + + + Compression type. + + + + + Applied filter. + + + + + Inner picture. + + + + + Creates new instance of the picture. + + Parent record. + + + + Creates new object. + + Parent object. + Stream to get data from. + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + Parses structure. + + + + + Indicates whether Art Blip contains Two Unique Id's. + + + + + + Loads primary UID. + + Stream to get primary UID from if necessary. + Offset after reading primary uid. + + + + Saves metafile into MemoryStream. + + Picture to serialize. + Memory stream with metafile data. + + + + Converts GraphicsUnit into MetafileFrameUnit. + + Value to convert. + Converted value. + + + + Compresses metafile picture. + + Stream with metafile. + Offset to the metafile. + Compressed picture. + + + + Clone current instance. + + Returns cloned instance. + + + + Frees all unmanaged resources. + + + + + Destructor. + + + + + Picture. + + + + + + + + + + Summary description for MsoUnknown. + + + + + Creates new object. + + Parent object. + + + + + + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + Indicates whether record needs internal data array or if it can be cleaned. + + + + + Summary description for _MsoEnums. + + + + + Represents the msofbtDggContainer MsoRecord type. + + + + + Represents the Dgg type. + + + + + Represents the CLSID type. + + + + + Represents the OPT type. + + + + + Represents the ColorMRU type. + + + + + Represents the SplitMenuColors type. + + + + + Represents the BstoreContainer type. + + + + + Represents the BSE type. + + + + + Represents the DgContainer type. + + + + + Represents the Dg type. + + + + + Represents the RegroupItems type. + + + + + Represents the ColorScheme type. + + + + + Represents the SpgrContainer type. + + + + + Represents the SpContainer type. + + + + + Represents the Spgr type. + + + + + Represents the Sp type. + + + + + Represents the Textbox type. + + + + + Represents the ClientTextbox type. + + + + + Represents the Anchor type. + + + + + Represents the ChildAnchor type. + + + + + Represents the ClientAnchor type. + + + + + Represents the ClientData type. + + + + + Represents the OleObject type. + + + + + Represents the DeletedPspl type. + + + + + Represents the SolverContainer type. + + + + + Represents the ConnectorRule type. + + + + + Represents the AlignRule type. + + + + + Represents the ArcRule type. + + + + + Represents the ClientRule type. + + + + + Represents the CalloutRule type. + + + + + Represents the Selection type. + + + + + Represents the Unknown type. + + + + + Represents the MsoBlipUsage options. + + + + + Represents the Default option. + + + + + Represents the Texture option. + + + + + Represents the UsageMax option. + + + + + Represents the MsoBlipType options. + + + + + Represents the ERROR option. + + + + + Represents the UNKNOWN option. + + + + + Represents the EMF option. + + + + + Represents the WMF option. + + + + + Represents the PICT option. + + + + + Represents the JPEG option. + + + + + Represents the PNG option. + + + + + Represents the DIB option. + + + + + Represents the FirstClient option. + + + + + Represents the LastClient option. + + + + + Represents the MsoBlipCompression options. + + + + + Represents the Deflate option. + + + + + Represents the None option. + + + + + Represents the Test option. + + + + + Represents the MsoBlipFilter options. + + + + + Represents the Adaptive option. + + + + + Represents the None option. + + + + + Represents the Test option. + + + + + Represents the Mso options. + + + + + Do not group this shape. + + + + + Represents the TextId options. + + + + + Represents the wrap text options . + + + + + Represents the TextDirection options. + + + + + Represents the SizeTextToFitShape options. + + + + + Represents the BlipId options. + + + + + Represents the BlipName options. + + + + + Represents fill type. + + + + + Represents the location of the top of the crop rectangle + + + + + Represents the location of the bottom of the crop rectangle. + + + + + Represents the location of the left side of the crop rectangle. + + + + + Represents the location of the right side of the crop rectangle. + + + + + Host-defined ID for OLE objects (usually a pointer). + + + + + Represents the ForeColor options. + + + + + Represents the transparency. + + + + + Represents the BackColor options. + + + + + Represents the gradient transparency options. + + + + + Represents shape pattern. + + + + + Represents shape pattern, texture name. + + + + + Represents shape gradient shading style. + + + + + Represents shape gradient shading variants. + + + + + Represents first record for shape gradient shading style. + + + + + Represents second record for shape gradient shading style. + + + + + Represents third record for shape gradient shading style. + + + + + Represents fourth record for shape gradient shading style. + + + + + Represents preset gradient data. + + + + + Represents gradient color type. + + + + + Hit test a shape as though filled. + + + + + Line color. + + + + + Line color. + + + + + Line Weight. + + + + + Line color. + + + + + Contain line pattern. + + + + + Line pattern. + + + + + Line style + + + + + Line dash style + + + + + Line start arrow. + + + + + Line end arrow. + + + + + Start arrow width. + + + + + Start arrow len. + + + + + End arrow width. + + + + + End arrow len. + + + + + Represents if dot value is round. + + + + + Represents the NoLineDrawDash options. + + + + + Represents the ForeShadowColor options. + + + + + Excel5-style shadow. + + + + + Name of the shape (only if explicitly set). + + + + + Alternative text. + + + + + Represents in comment shape show always property. + + + + + Represents a range of empty cells. All cells are located in the same row. + + + + + + + + + + Returns size of the subrecord if it was placed as separate record (including BiffRecord header). Read-only. + + + + + Inserts cell inside this record. + + Cell to insert. + + + + Removes information about specified column from the record and splits record into two. + \ + Zero-based index of the column to remove. + Split records. + + + + Splits record into subrecords. + + Indicates whether styles must be ignored. + Array with all subrecords. + + + + Zero-based index of the first column. + + + + + Zero-based index of the last column. + + + + + Returns size of the sub record. Read-only. + + + + + Returns type of the subrecord. Read-only. + + + + + Size of the fixed part. + + + + + Minimum record size. + + + + + Size of the subitem. + + + + + List of 16-bit indexes to XF records. + + + + + Index to last column. + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + This method checks the record's internal data array for integrity. + + If there is any internal error. + + + + Creates BlankRecord corresponding to the specified column. + + Column index. + Corresponding BlankRecord. + + + + Returns size of the required storage space. + + Excel version. + Size of the required storage space. + + + + Increases last column of the record. + + Object that provides access to the data. + Offset to the record start (record code). + Record data length. + Value that must be added to the column width. + Excel version used to fill data. + + + + Returns size of the subrecord if it was placed as separate record (including BiffRecord header). Read-only. + + + + + Inserts cell inside this record. + + Cell to insert. + + + + Removes information about specified column from the record and splits record into two. + + Zero-based index of the column to remove. + Splitted records. + + + + Creates record based in the information from this record. + + The first column index in the resulting record. + The last column index in the resulting record. + Created record. + + + + Creates blank record with specified column index. + + Zero-based column index of the created record. + Created record. + + + + Splits record into subrecords. + + Indicates whether styles must be ignored. + Array with all subrecords. + + + + Index to first column. + + + + + List of 16-bit indexes to XF records. + + + + + Index to last column. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Returns size of the subrecord. Read-only. + + + + + Returns type of the subrecord. Read-only. + + + + + Represents a cell range containing RK value cells. + All cells are located in the same row. + + + + + Size of the fixed part. + + + + + Size of the subitem. + + + + + List of RkRec structures. + + + + + Index to last column. + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + Returns size of the required storage space. + + Excel version. + Size of the required storage space. + + + + Returns size of the subrecord if it was placed as separate record (including BiffRecord header). Read-only. + + + + + Inserts cell inside this record. + + Cell to insert. + + + + Merges this and specified records. + + Record to merge with. + + + + + + + + + + Creates subrecord corresponding to the specified record. + + + + + + + Removes information about specified column from the record and splits record into two. + + Zero-based index of the column to remove. + Splitted records. + + + + Creates record based in the information from this record. + + The first column index in the resulting record. + The last column index in the resulting record. + Created record. + + + + Creates blank record with specified column index. + + Zero-based column index of the created record. + Created record. + + + + Splits record into subrecords. + + Indicates whether styles must be ignored. + Array with all subrecords. + + + + Index to the first column. + + + + + Index to last column. + + + + + List of RkRec structures. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Returns size of the subrecord. Read-only. + + + + + Returns type of the subrecord. Read-only. + + + + + Contains information about single RK entry in MulRKRecord. + + + + + Index of ExtendedFormat of the RK entry. + + + + + RK number of the RK entry. + + + + + Default constructor. To prevent user creating class + instance without parameters. + + + + + Constructs RkRec and sets its ExtendedFormat and Rk number values. + + Value of ExtendedFormat index. + Value of RkNumber. + + + + Index of ExtendedFormatRecord for this Rk number. + + + + + Read-only. 32-bit value contained by the record. + + + + + Read-only. Returns double value stored as Rk. + + + + + The begin record defines the start of a block of records for a (Graphing) + data object. This record is matched with a corresponding EndRecord. + + + + + Bit mask of the Function group. + + + + + Size of the fixed part. + + + + + Predefined names: + + + + + Option flags. + + + + + True if name is hidden. + + + + + True if name is a function. + + + + + True if name is a command. + + + + + True if function macro or command macro. + + + + + True if complex function (array formula or user defined). + + + + + True if built-in name. + + + + + True if name contains binary data. + + + + + Keyboard shortcut. + + + + + Length of the name. + + + + + Size of the formula data. + + + + + Reserved. + + + + + 0 if global name; otherwise index to sheet (one-based). + + + + + Length of menu text. + + + + + Length of description text. + + + + + Length of help topic text. + + + + + Length of status bar text. + + + + + Name (Unicode string without length field). + + + + + Formula data (RPN token array without size field). + + + + + Optional. Menu text (Unicode string without length field). + + + + + Optional. Description text (Unicode string without length field). + + + + + Optional. Help topic text (Unicode string without length field). + + + + + Optional. Status bar text (Unicode string without length field). + + + + + Parsed formula expression. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Infill fixed part of the record. + + Object that provides access to the data. + Starting offset. + + + + Infill fixed part of the record. + + Object that provides access to the data. + Offset to the fixed part data. + + + + Size of the required storage space. Read-only. + + + + + Determines number of bytes needed to store string without length field. + + Value to measure. + Number of bytes needed to store string without length field. + + + + Method checks name of NameRecord and determines whether it is a default or not. + + Name to check. + True if name is Predefined name; otherwise False. + + + + Looks for name in the predefined names table. + + Value to look for. + Index in the predefined names array. + + + + + + + + + + True if name is hidden. + + + + + True if name is a function. + + + + + True if built-in name. + + + + + 0 if global name; otherwise index to sheet (one-based). + + + + + Name (Unicode string without length field). + + + + + Formula data (RPN token array without size field). + + + + + Read-only. Minimum possible size of the record. + + + + + The NOTE record specifies a comment associated with a particular cell. + + + + + Size of the fixed part of the record. + + + + + Row of the comment. + + + + + Column of the comment. + + + + + Options flag. + + + + + Whether the comment is visible. + + + + + Object ID for OBJ record that contains the comment. + + + + + Length of the name of the original comment author. + + + + + Name of the original comment author. + + + + + Default constructor fills all data with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Size of the required storage space. Read-only. + + + + + Index to row. + + + + + Index to column. + + + + + Object ID for OBJ record that contains the comment. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Represents a cell that contains a floating-point value. + + + + + Correct record size. + + + + + IEEE floating-point value. + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + Returns size of the required storage space. + + Excel version. + Size of the required storage space. + + + + Reads record's value from the data provider. + + Provider to read data from. + Offset to the record's start. + Excel version that was used to infill. + Record's value. + + + + IEEE floating-point value. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + + + + + + Returns double value. Read-only. + + + + + Value of the record. + + + + + This record is part of the worksheet / workbook protection. It determines whether + the objects of the current sheet are protected. Object protection is not active + if this record is omitted. + + + + + Default record size. + + + + + 0 = Objects not protected; 1 = Objects protected + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + 0 = Objects not protected; 1 = Objects protected + + + + + Read-only. Minimum possible size of the record. + + + + + Read-only. Maximum possible size of the record. + + + + + The OBJ record contains a partial description of a drawing object + and the MSODRAWING, MSODRAWINGGROUP, and MSODRAWINGSELECTION records contain + the remaining drawing object data. + + + + + Array that contain all subrecords. + + + + + Default constructor fills all data with default values. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Searches for the subrecord of the specified type. + + Record type to search for. + Found subrecord or null if not found. + + + + Searches for the index of the subrecord with the specified type. + + Record type to search for. + Index of the found subrecord or -1 if not found. + + + + Read-only. Returns array of subrecords. + + + + + Indicates whether this record needs a data array after parsing + is complete. Read-only. + + + + + To store an OBJ record in BIFF8, Microsoft Excel writes a collection + of sub-records. The structure of a sub-record is identical to the + structure of a BIFF record. Each sub-record begins with a 2-byte + ID number ft (see the following table). Next a 2-byte length field, + cb, specifies the length of the sub-record data field. The sub-record + data field follows the length field. The first sub-record is always + ftCmo (common object data) and the last sub-record is always ftEnd. + + + + + Represents the ftEnd subrecord type. + + + + + Represents the Reserved0 subrecord type. + + + + + Represents the Reserved1 subrecord type. + + + + + Represents the Reserved2 subrecord type. + + + + + Represents the ftMacro subrecord type. + + + + + Represents the ftButton subrecord type. + + + + + Represents the ftGmo subrecord type. + + + + + Represents the ftCf subrecord type. + + + + + Represents the ftPioGrbit subrecord type. + + + + + Represents the ftPictFmla subrecord type. + + + + + Represents the ftCbls subrecord type. + + + + + Represents the ftRbo subrecord type. + + + + + Represents the ftSbs subrecord type. + + + + + Represents the ftNts subrecord type. + + + + + Represents the ftSbsFmla subrecord type. + + + + + Represents the ftGboData subrecord type. + + + + + Represents the ftEdoData subrecord type. + + + + + Represents the ftRboData subrecord type. + + + + + Represents the ftCblsData subrecord type. + + + + + Represents the ftLbsData subrecord type. + + + + + Represents the ftCblsFmla subrecord type. + + + + + Represents the ftCmo subrecord type. + + + + + Possible object types: + + + + + Represents the otGroup object type. + + + + + Represents the otLine object type. + + + + + Represents the otRectangle object type. + + + + + Represents the otOval object type. + + + + + Represents the otArc object type. + + + + + Represents the otChart object type. + + + + + Represents the otText object type. + + + + + Represents the otButton object type. + + + + + Represents the otPicture object type. + + + + + Represents the otPolygon object type. + + + + + Represents the otReserved0 object type. + + + + + Represents the otCheckBox object type. + + + + + Represents the otOptionBtn object type. + + + + + Represents the otEditBox object type. + + + + + Represents the otLabel object type. + + + + + Represents the otDialogBox object type. + + + + + Represents the otSpinner object type. + + + + + Represents the otScrollBar object type. + + + + + Represents the otGroupBox object type. + + + + + Represents the otGroupBox object type. + + + + + Represents the otComboBox object type. + + + + + Represents the otReserved1 object type. + + + + + Represents the otReserved2 object type. + + + + + Represents the otReserved3 object type. + + + + + Represents the otReserved4 object type. + + + + + Represents the otComment object type. + + + + + Represents the otReserved5 object type. + + + + + Represents the otReserved6 object type. + + + + + Represents the otReserved7 object type. + + + + + Represents the otReserved8 object type. + + + + + Represents the otMSODrawing object type. + + + + + Common object data. + + + + + Base class for all obj subrecords. + + + + + Size of the header data. + + + + + Type of the subrecord. + + + + + Length of the subrecord's data. + + + + + Initializes new instance. + + Type of the subrecord. + + + + Initializes new instance. + + Type of the subrecord. + Length of the subrecord's data. + Array that contains subrecord's data. + + + + Parses byte array. + + Array to parse. + + + + Fills array with binary representation of the subrecord. + + Object that provides access to the data. + Offset in the buffer to copy data to. + + + + Serializes record's data. + + Provider to serialize into. + Offset to start serialization from. + + + + Size of the required storage space. Read-only. + + + + + Clones current objects. + + Returns instance of cloned object. + + + + Type of the subrecord. + + + + + Length of the subrecord's data. + + + + + Bit mask for ChangeColor property. + + + + + Type of the object. + + + + + Object's id. + + + + + Option flags. + + + + + Reserved. + + + + + Indicates that record length is zero. + + + + + Initialize new instance. + + Type of the subrecord. + Length of the subrecord's data. + Array that contains subrecord's data. + + + + Parses byte array. + + Array to parse. + + + + Fills array with binary representation of the subrecord. + + Object that provides access to the data. + Offset in the buffer to copy data to. + + + + Clones current objects. + + Returns instance of cloned object. + + + + Size of the required storage space. Read-only. + + + + + Indicates whether object is locked. + + + + + Indicates whether object is printable. + + + + + Indicates whether auto fill is turned on. + + + + + Indicates whether auto line option is turned on. + + + + + Indicates whether excel is allowed to change color of combo box (used in autofilters). + + + + + Object's ID. + + + + + Object type. + + + + + Reserved. + + + + + Returns record options. Read-only. + + + + + Formula tokens that identifies associated macro. + + + + + Default constructor. + + + + + Clones current objects. + + Returns instance of cloned object. + + + + Gets or sets formula tokens with associated macro. + + + + + + + + + + Correct record size. + + + + + Position of the vertical split (px, 0 = No vertical split). + Unfrozen pane: Width of the left pane(s) (in twips = 1/20 of a point). + Frozen pane: Number of visible columns in left pane(s). + + + + + Position of the horizontal split (py, 0 = No horizontal split). + Unfrozen pane: Height of the top pane(s) (in twips = 1/20 of a point). + Frozen pane: Number of visible rows in top pane(s). + + + + + Index to first visible row in bottom pane(s). + + + + + Index to first visible column in right pane(s). + + + + + Identifier of pane with active cell cursor (see below). The last field + specifying the active pane has a size of 1 byte in BIFF2-BIFF4 and 2 + bytes in BIFF5-BIFF8. The correct identifiers for all possible + combinations of visible panes are shown in the following pictures: + px=0, py=0 -> 3 + px=0, py>0 -> 3 + 2 + px>0, py=0 -> 3 1 + px>0, py>0 -> 3 1 + 2 0 + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Position of the vertical split (px, 0 = No vertical split). + Unfrozen pane: Width of the left pane(s) (in twips = 1/20 of a point). + Frozen pane: Number of visible columns in left pane(s). + + + + + Position of the horizontal split (py, 0 = No horizontal split). + Unfrozen pane: Height of the top pane(s) (in twips = 1/20 of a point). + Frozen pane: Number of visible rows in top pane(s). + + + + + Index to first visible row in bottom pane(s). + + + + + Index to first visible column in right pane(s). + + + + + Identifier of pane with active cell cursor (see below). The last field + specifying the active pane has a size of 1 byte in BIFF2-BIFF4 and 2 + bytes in BIFF5-BIFF8. The correct identifiers for all possible + combinations of visible panes are shown in the following pictures: + px=0, py=0 -> 3 + px=0, py>0 -> 3 + 2 + px>0, py=0 -> 3 1 + px>0, py>0 -> 3 1 + 2 0 + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Stores the encrypted password for a sheet or workbook. + + + + + 16-bit hash value of the password. + + + + + Default constructor. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + 16-bit hash value of the password. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Stores the (2 byte) encrypted password for a shared workbook. + + + + + Default record size. + + + + + Encrypted password for a shared workbook. + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record saves printer settings and printer driver information. + + + + + Summary description for BiffRecordWithContinue. + + + + + Summary description for BiffRecordRawWithDataProvider. + + + + + Object that gives access to the record's data. + + + + + Default constructor. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, the class must pack all of its properties into + an internal Data array: m_data. This method is called by + FillStream, when the record must be serialized into stream. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + + Gets string from internal record data using GetBytes. + + Offset of starting byte. + Length of the string. + Retrieved string. + + if Offset + iStrLen is out of data array + + + + + Gets string from internal record data using GetBytes. + + Offset of starting byte. + Length of the string. + Gets bytes count that this string occupies in the data array. + Retrieved string. + + + + Gets string from internal record data using GetBytes. + + Offset of starting byte. + Length of the string. + Gets bytes count that this string occupies in the data array. + Flag for is bytes count available. + Retrieved string. + + + + Detect type of string and extracts it. + + Record data offset. + Contain next position. + Number of elements in the continuePos collection. + Current index in the continuePos array. + Length of string record. + Array of rich formatting values. + Array of unknown FarEast data. + Extracted string. + + + + Sets byte in internal record data array values. + + Offset in internal record data array to start from. + Byte value to set. + + + + Sets ushort in internal record data array values. + + Offset in internal record data array to start from. + Value to set. + + + + Sets bytes in internal record data array values. + + Offset in internal record data array to start from. + Array of bytes to set. + Position in value array to the data that will be set. + Length of the data. + If value array is NULL. + + If pos or length would be less than zero or their sum would be more + than size of value array. + + + If internal record data array is too small for receiving value array + and AutoGrowData is False. + + + + + Sets bytes in internal record data array values. + + Offset in internal record data array to start from. + Array of bytes to set. + If value array is NULL. + + If pos or length would be less than zero or their sum would be more + than size of value array. + + + If internal record data array is too small for receiving value array + and AutoGrowData is False. + + + + + Sets string in internal record data array using SetBytes method + without string length. + + Offset to the string. + Value of the string. + Size of the string in bytes. + + + + Sets string in internal record data array using SetBytes method + without string length. + + Offset to the string. + Value of the string. + Indicates whether write compressed attribute for empty strings. + Size of the string in bytes. + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Mask to get two bytes value. + + + + + Array that contains positions of data of the continue records + in the m_data array. + + + + + Size of the first record length. + + + + + Default constructor. + + + + + Creates copy of the current object. + + A copy of the current object. + + + + Type of the first continue record. Read-only. + + + + + Indicates whether we should add header of continue records to the internal data provider. Read-only. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + When string's length does not fit to internal data length or + when last string ends before data (some extra data at the + end of m_data array). + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + Creates copy of the current object. + + A copy of the current object. + + + + + + + + + Indicates whether we should add header of continue records to the internal data provider. Read-only. + + + + + Indicates whether record needs internal data array + or if it can be cleaned. Read-only. + + + + + Defines whether or not to print the gridlines when you + print your spreadsheet on paper. + + + + + Default record size. + + + + + Whether or not to print the gridline. + + + + + Default constructor. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. + + + + + Whether or not to print the gridline. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Stores print setup options. + + + + + Bit mask for error print options. + + + + + Start bit of error print options in m_usOptions. + + + + + Correct record size. + + + + + Paper size. + + + + + Scaling factor in percent. + + + + + Start page number. + + + + + Fit worksheet width to this number of pages (0 = use as many as needed). + + + + + Fit worksheet height to this number of pages (0 = use as many as needed). + + + + + Options flag. + + + + + False to print pages in columns; + True to print pages in rows. + + + + + False for landscape; True for portrait. + + + + + True if paper size, scaling factor, paper orientation (portrait / landscape), + print resolution, and number of copies are not initialized. + + + + + False to print in color; True to print in black and white. + + + + + False for default print quality; True for draft quality. + + + + + Indicates whether to print cell notes. + + + + + False if paper orientation setting is valid; + True if paper orientation setting is not initialized. + + + + + False for automatic page numbers; + True to use starting page number. + + + + + False if print notes are displayed; + True if print notes are at the end of sheet. + + + + + Print resolution in dpi. + + + + + Vertical print resolution in dpi. + + + + + Header margin (IEEE floating-point value). + + + + + Footer margin (IEEE floating-point value). + + + + + Number of copies to print. + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Paper size. + + + + + Scaling factor in percent. + + + + + Start page number. + + + + + Fit worksheet width to this number of pages (0 = use as many as needed). + + + + + Fit worksheet height to this number of pages (0 = use as many as needed). + + + + + Print resolution in dpi. + + + + + Vertical print resolution in dpi. + + + + + Header margin (IEEE floating-point value). + + + + + Footer margin (IEEE floating-point value). + + + + + Number of copies to print. + + + + + False to print pages in columns; + True to print pages in rows. + + + + + False if landscape; True if portrait. + + + + + True if paper size, scaling factor, paper orientation (portrait / landscape), + print resolution, and number of copies are not initialized. + + + + + False to print in color; True to print in black and white. + + + + + False for default print quality; True for draft quality. + + + + + Indicates whether to print cell notes. + + + + + False if paper orientation setting is valid; + True if paper orientation setting is not initialized. + + + + + False for automatic page numbers; + True to use starting page number. + + + + + False if print notes as displayed; + True if print notes are at the end of sheet. + + + + + Indicates how to print errors. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Describes whether this is a protected shared / tracked workbook. + + + + + Default record size. + + + + + Whether or not this is protected shared / tracked workbook. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. + + + + + Whether or not this is protected shared / tracked workbook. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Whether a worksheet or a workbook is protected against modification. + Protection is not active if this record is omitted. + + + + + Whether a worksheet or a workbook is protected against modification. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Whether a worksheet or a workbook is protected against modification. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Describes which reference mode to use. + + + + + Correct record size. + + + + + Stores which method is used to show cell addresses in formulas. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Stores which method is used to show cell addresses in formulas: + 1 = A1 mode + 0 = RC mode + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Represents a cell that contains an RK value + (encoded integer or floating-point value). + + + + + Correct record size. + + + + + Record size with header. + + + + + Offset to the number from the start of the record's data. + + + + + Offset to the number from the start of the record's data. + + + + + Represents rk mask. + + + + + Maximum number that is possible to store as rk record. + + + + + Minimum number that is possible to store as rk record. + + + + + RK value. + + + + + True if value is multiplied by 100. + + + + + True if signed integer; False if floating-point value. + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + Returns size of the required storage space. + + Excel version. + Size of the required storage space. + + + + Converts string to the Rk number. + + String to convert. + + + + Sets RkNumber to the specified value. + + Double value to set. + + + + Sets integer value to the specified value. + + Value to set. + + + + Sets RkRecord values from MulRKRecord.RkRec + + MulRKRecord.RkRec with needed values. + + + + Converts RKRecord into MulRKRecord.RkRec. + + Converted record. + + + + Converts string to RK number. + + String to parse. + Parsed RK number. If returns int.MaxValue - cannot parse RK number. + + + + Converts double to RK number. + + Value to convert. + Converted RK number. If returns int.MaxValue - cannot parse RK number. + + + + Converts Rk number to double. + + Rk number to convert. + Converted double value. + + + + Converts double value to integer. Value as IEEE double or IEEE / 100 double. + + Value to convert. + Indicates is convert to IEEE / 100. + Int value corresponding to the double value. + + + + Encodes rk number. + + Represents value to encode. + Returns encoded value. + + + + Gets double value using safe code. + + Represents value. + Returns double value. + + + + Reads record's value from the data provider. + + Provider to read data from. + Offset to the record's start. + Excel version that was used to infill. + Record's value. + + + + Read-only. RK value. + + + + + RK value converted to double. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + + + + + + True if this is not a floating point value. + + + + + True if value was multiplied by 100. + + + + + Returns double value. Read-only. + + + + + Value of the record. + + + + + Stores the row information for the sheet. + + + + + Bit mask for outline level. + + + + + Maximum row height in points. + + + + + + + + + + Index of this row. + + + + + Index to column of the first cell which is described by a cell record. + + + + + Index to column of the last cell which is described by a cell record, + increased by 1. + + + + + Height of the row, in twips = 1/20 of a point. + + + + + Not used. + + + + + Options flag. + + + + + Worksheet object. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Index of this row. + + + + + Index to column of the first cell which is described by a cell record. + + + + + Index to column of the last cell which is described by a cell record, + increased by 1. + + + + + Height of the row, in twips = 1/20 of a point. + + + + + If the row is formatted, then this is the index to + the extended format record. + + + + + The outline level of this row. + Changes some bits of m_usOptionFlags private member. + + + When value is more than 7. + + + + + Whether or not to collapse this row. + + + + + Whether or not to display this row with 0 height. + + + + + Whether the font and row height are not compatible. + True if they aren't compatible. + + + + + Whether the row has been formatted (even if it has all blank cells). + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + + + + + + Row or column index. + + + + + Gets or sets the worksheet. + + The worksheet. + + + + Possible option flags. + + + + + Whether or not to collapse this row. + + + + + Whether or not to display this row with 0 height. + + + + + Whether the font and row height are not compatible. + True if they aren't compatible. + + + + + Whether the row has been formatted (even if its got all blank cells) or + row has explicit default format. + + + + + If this value is set to False, then Excel will not show row outline + groups. + + + + + Additional space above the row. + + + + + Additional space below the row. + + + + + This record stores a formatted text cell (Rich-Text). + In BIFF8 it is replaced by the LABELSST record. + Nevertheless, Excel uses this record if it copies formatted + text cells to the clipboard. + + + + + Index to row. + + + + + Index to column. + + + + + Index to XF (Extended Format) record. + + + + + Unformatted Unicode string, 16-bit string length. + + + + + Number of rich text formatting runs. + + + + + Array of formatting runs. + + + + + Default constructor fills all data with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Excel version used for infill. + Size of the record data. + + + + Index to row. + + + + + Index to column. + + + + + Index to XF (Extended Format) record. + + + + + Unformatted Unicode string, 16-bit string length. + + + + + Array of formatting runs. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Returns string value. Read-only. + + + + + Rich text formatting run. + + + + + First formatted character (zero-based). + + + + + Index to FONT record. + + + + + Defines whether to recalculate before saving (set to 1). + + + + + Correct record size. + + + + + Defines whether to recalculate before saving (set to 1). + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + Defines whether to recalculate before saving (set to 1). + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record is part of the worksheet / workbook protection. + It determines whether the scenarios of the current sheet + are protected. Scenario protection is not active + if this record is omitted. + + + + + Default record size. + + + + + 0 = Objects not protected; 1 = Objects protected + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. + + + + + 0 = Scenarios not protected; 1 = Scenarios protected + + + + + Read-only. Minimum possible size of the record. + + + + + Read-only. Maximum possible size of the record. + + + + + Shows the user's selection on the sheet + for write set num refs to 0. + + + + + Size of the fixed part. + + + + + Subitem size. + + + + + The window pane for the record. + + + + + The active cell's row. + + + + + The active cell's column. + + + + + The active cell's reference number. + + + + + The number of cell refs. + + + + + List of ADDR structures. + + + + + Sets selection range. + + Ref index. + Addr to set. + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Size of the required storage space. Read-only. + + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + The window pane for the record. + + + + + The active cell's row. + + + + + The active cell's column. + + + + + The number of cell refs. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Each cell range address (called an ADDR structure) contains 4 16-bit values. + Cell range address, BIFF8. + + + + + Index to first row. + + + + + Index to last row. + + + + + Index to first column. + + + + + Index to last column. + + + + + Creates TAddr by specified first and last rows and first and last columns. + + First row of the cell range. + Last row of the cell range. + First column of the cell range. + Last column of the cell range. + + + + Converts object to the string. + + String representation of the object. + + + + This record stores the token array of a shared formula. + Shared formulas are similar to array formulas in that they store + a formula used in a range of cells. The SharedFormula record + is not a real cell record but follows the first FORMULA + record of the cell range. + + + + + Size of the record's fixed part. + + + + + Index to first row of the shared formula range. + + + + + Index to last row of the shared formula range. + + + + + Index to first column of the shared formula range. + + + + + Index to last column of the shared formula range. + + + + + Not used. + + + + + Size of the formula data. + + + + + Token array of the shared formula. + + + + + + + + + + Default constructor fills all data with default values. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Index to first row of the shared formula range. + + + + + Index to last row of the shared formula range. + + + + + Index to first column of the shared formula range. + + + + + Index to last column of the shared formula range. + + + + + Gets/sets formula into/from shared formula record. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Whether to center between horizontal margins. + + + + + Whether or not to horizontally or vertically (depending on the record code) center this sheet. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Whether or not to horizontally or vertically (depending on record code) center this sheet. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Summary description for SheetProtection. + + + + + Represents the Error Indicator sheet protection id. + + + + + Represents option offset. + + + + + Represents default record store size. + + + + + Represents default embedded record data. + + + + + Options flag. + + + + + Indicates is contain sheet protection. + + + + + Represents the Protection type. + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Gets the default record store size. Read-only. + + + + + Represents protected options. + + + + + Indicates is record contain sheet protection. + + + + + Read-only. Minimum possible size of the record. + + + + + Read-only. Maximum possible size of the record. + + + + + Static String Table Record: + This holds all the strings for LabelSSTRecords. + + + + + Options byte offset in the string. + + + + + Number of string in workbook. + + + + + Number of unique strings in workbook. + + + + + Array of workbook's strings. + + + + + Array that stores positions of the strings in the m_data array. + + + + + Array that stores offsets of the strings starting from the beginning + of the record (Continue or SST). + + + + + + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + If any internal error occurred. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + Tries to prognose records size and prepare data storage so it won't require resize operation. + + + + + Resizes buffer if necessary. + + Buffer to check. + Desired buffer size. + + + + This method checks record's internal data array for integrity. + + If there is any internal error. + + + + Size of the required storage space. Read-only. + + + + + Number of string in workbook. + + + + + Number of unique strings in workbook. + + + + + Array of workbook's strings. + + + + + Array that stores positions of the strings in the m_data array. + + + + + Array that stores offsets of the strings starting from the beginning + of the record (Continue or SST). + + + + + Configuration property. If value is True, then on detection of dataless + record, the class will try to continue to get records from the stream. + + + + + + + + + + This record stores the result of a string formula. + It occurs directly after a string formula. + + + + + Size of the fixed part. + + + + + String length. + + + + + Non-empty Unicode string. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Non-empty Unicode string. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Header of this record + + + + + Whether the style is built in or user-defined. + + + + + Whether the style is hidden in user interface or not. + + + + + Whether the style is custom or not. + + + + + Reserved data. + + + + + Specify the type of style + + + + + Buid in data + + + + + The style's name (if user-defined). + + + + + The row or column level of the style. + + + + + If this is a built in style, then it is the number of the built in style. + If this is user-defined style, then it is length of style's name. + + + + + Default constructor + + + + + Initialize the variables + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Whether the style is built in or user-defined. + + + + + Whether the style is hidden in user interface or not + + + + + Style Record: + Describes a built-in style in the GUI or user defined style. + + + + + Extended format index bit mask. + + + + + The actual index of the style extended format record. + + + + + Whether the style is built in or user-defined. + + + + + If this is a built in style, then it is the number of the built in style. + If this is user-defined style, then it is length of style's name. + + + + + The row or column level of the style. + + + + + The style's name (if user-defined). + + + + + The style's name (if user-defined and greater than 256 symbols). + + + + + Represents the default external format index based on workbook version + + + + + /Represents if the stylename is encoded, when style name is greater than 256 symbols + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Copies this record into another StyleRecord. + + + + + + Whether the style is built in or user-defined. + + + + + + The actual index of the style extended format record. + + + + + The row or column level of the style. + + + + + The row or column level of the style. + + + + + The style's name (if user-defined). + + + + + Represents actual style name in case of AsciiConversion + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Returns style name. Read-only. + + + + + Gets or sets the default external format index based on workbook version + + + + + This record stores the URL of an external document + and a list of sheet names inside this document. Furthermore, + it is used to store DDE and OLE object links or to indicate + an internal 3D reference or an add-in function. + + + + + This constant indicates that the sup book record contains internal references. + + + + + This constant indicates that the sup book record contains add-in functions. + + + + + Indicates whether this record is used for internal references or external references. + + + + + Indicates whether add-in function names are stored + in EXTERNNAME records following this SUPBOOK record. + + + + + Number of sheet names (if external references) or + number of sheets in this document (if internal references). + + + + + Length of encoded URL without sheet name (if external references). + 0401h (if internal references) + + + + + Encoded URL without sheet name. + + + + + List of sheet names. + + + + + Original URL value. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + When string's length does not fit to internal data length or + when last string ends before data (some extra data at the + end of m_data array). + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + + + + + + Size of the required storage space. Read-only. + + + + + Whether the record is used for internal references or external references. + + + + + Read-only. Minimum possible size of the record. + + + + + Read-only. Maximum possible size of the record. + + + + + Encoded URL without sheet name (for external references). + + + + + List of sheet names. + + + + + Number of sheet names (if external references) or + number of sheets in this document (if internal references). + + + + + + + + + + This record stores information about a multiple operation + table in the sheet. It follows the first FORMULA record + of the cell range containing the operation table. + + + + + Bit mask for the operation mode. + + + + + First bit of the operation mode. + + + + + Index to first row of the multiple operation table range. + + + + + Index to last row of the multiple operation table range. + + + + + Index to first column of the multiple operation table range. + + + + + Index to last column of the multiple operation table range. + + + + + Option flags. + + + + + True to always recalculate array formula. + + + + + True to calculate array formula on open. + + + + + Index to row of input cell (in mode 1x2 index to row of + input cell for row input). + + + + + Index to column of input cell (in mode 1x2 index to column + of input cell for row input). + + + + + In mode 1x2 index to row of input cell for column input; + else not used. + + + + + In mode 1x2 index to column of input cell for column input; + else not used. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Index to first row of the multiple operation table range. + + + + + Index to last row of the multiple operation table range. + + + + + Index to first column of the multiple operation table range. + + + + + Index to last column of the multiple operation table range. + + + + + True to always recalculate array formula. + + + + + True to calculate array formula on open. + + + + + Whether to display outline symbols (in the gutters). + Changes bits of m_usOptions. + + + When value is more than 4. + + + + + Index to row of input cell (in mode 1x2 index to row of + input cell for row input). + + + + + Index to column of input cell (in mode 1x2 index to column + of input cell for row input). + + + + + In mode 1x2 index to row of input cell for column input; + else not used. + + + + + In mode 1x2 index to column of input cell for column input; + else not used. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record stores a text object. The TXO record is followed + by two CONTINUE records. The first CONTINUE record contains the text + data and the second CONTINUE contains the formatting runs. + If the text box contains no text, these CONTINUE records + are not written to the file. + + + + + Bit mask for horizontal alignment. + + + + + Bit mask for vertical alignment. + + + + + Option flags. + + + + + Whether the Lock Text option is on. + + + + + Orientation of text within the object boundary. + + + + + Reserved, must be zero. + + + + + Reserved, must be zero. + + + + + Length of text (in first CONTINUE record). + + + + + Length of formatting runs (in second CONTINUE record). + + + + + Reserved, must be zero. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + Horizontal text alignment. + This property changes bits of m_usOptions private field. + + + + + Vertical text alignment: + This property changes bits of m_usOptions private field. + + + + + Whether the Lock Text option is on. + + + + + Orientation of text within the object boundary. + + + + + Length of text (in first CONTINUE record). + + + + + Length of formatting runs (in second CONTINUE record). + + + + + Not used. + + + + + Not used. + + + + + Not used. + + + + + Read-only. Minimum possible size of the record. + + + + + Read-only. Maximum possible size of the record. + + + + + Summary description for TextFormat. + + + + + + + + + + + + + + + Size of a single formatting run. + + + + + + + + + + + + + + + Formatting runs, key - position, value - font index. + + + + + String value. + + + + + Default font index. + + + + + Options. + + + + + Indicates whether string was changed and possibly needs defragmentation. + + + + + Number of references to this object. + + + + + Reprsents the Rich Text. + + + + + Indicates the string is preserverd type or not + + + + + Default constructor. + + + + + Creates instance with specified default font index. + + Index of the default font. + + + + Converts TextWithFormat to string. + + Object to convert to string. + String value of the object. + + + + Converts string to TextWithFormat. + + String value. + Converted TextWithFormat. + + + + Sets font index for specified range of characters. + + Start character of the range. + End character of the range. + Font index to set. + + + + Returns font index for the specified character. + + Character index to get font index. + Font index for the specified character. + + + + Returns font index for the specified character. + + Character index to get font index. + Font index for the specified character. + + + + Returns font index at the specified position in the formatting runs array. + + Index of the formatting run. + Font index. + + + + Returns character position at the specified position in the formatting runs array. + + Index of the formatting run. + Character position. + + + + Sets font index at the specified position in the formatting runs array. + + Index of the formatting run. + Font index to set. + + + + Clears formatting. + + + + + Compares the current instance with another object of the same type. + + An object to compare with this instance. + + A 32-bit signed integer that indicates the relative order of the comparands. + + + + + Compares formatting runs. + + First formatting runs to compare. + Second formatting runs to compare. + + 0 if they are equal, + -1 if first formatting run is less then second; + otherwise 1. + + + + + + + + + + Returns starting position for formatting block which contains specified position. + + Position to which formatting is applied. + Starting position for formatting block which contains specified position. + + + + Removes all formatting within specified range. + + Start position of the range. + End position of specified range. + + + + Defragments text formatting. + + + + + Checks if specified offset is correct. + + Length of the array. + Offset in the array. + + When iOffset is out of range. + + + + + Copies formatting runs into another TextWithFormat object. + + TextWithFormat to copy data into. + + + + Converts this object to string. + + String representation of this object. + + + + 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 hashcode for the object. + + A hash code for the current object. + + + + Returns size of the formatting runs. + + Size of the formatting runs. + + + + Serializes formatting. + + Buffer for formatting data. + Offset in the buffer where to serialize formatting. + Indicates whether defragmentation is needed. + Size of formatting data. + + + + Returns string options. + + Options byte. + + + + Parses formatting runs. + + Array with formatting runs data. + Offset to formatting runs. + Number of formatting runs to parse. + + + + Parses formatting runs. + + Array with formatting runs. + + + + Serializes formatting runs into specified array. + + Destination array. + Offset to the data. + Indicates whether defragmentation is needed. + Size of the serialized data. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Creates a new object that is a copy of the current instance. + + Dictionary with new font indexes. + A new object that is a copy of this instance. + + + + Updates font indexes. + + Dictionary with new font indexes. + + + + Reprsents the Rich Text + + + + + Text string. + + + + + Formatting runs, key - position, value - font index. + + + + + List of formatting runs. Read-only. + + + + + Returns number of formatting runs. Read-only. + + + + + Returns true if string is preserved type. + + + + + Possible string flags. + + + + + The string is saved as double-byte characters. + + + + + Extended string follows (Far East versions). + + + + + Rich string follows. + + + + + This record describes all unknown information in records. + + + + + + + + + + + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + Size of the required storage space. Read-only. + + + + + Clones current instance. + + Returns cloned object. + + + + + + + + + + + + + + Contains a list of explicit column page breaks. + + + + + Size of the fixed part. + + + + + Size of the subitem. + + + + + Number of page breaks. + + + + + Array of VerticalPageBreaks. + + + + + Default constructor, sets all fields default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Size of the required storage space. Read-only. + + + + + Array of VerticalPageBreaks. + + + + + Read-only. Maximum possible size of the record. + + + + + Structure that contains information about a vertical page break. + + + + + The column of the break. + + + + + The starting row of the break. + + + + + The ending row of the break. + + + + + Default constructor + + + + + Constructs class instance and fills it with specified values. + + Column of the break. + Starting row of the break. + Ending row of the break. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + The column of the break. + + + + + The starting row of the break. + + + + + The ending row of the break. + + + + + Stores the attributes of the workbook window. This is basically + so that the GUI is aware of the size of the window holding the spreadsheet + document. + + + + + Correct record size. + + + + + Horizontal position. + + + + + Vertical position. + + + + + The width of the window. + + + + + The height of the window. + + + + + The option's bitmask (see bit setters). + + + + + The selected tab number. + + + + + The displayed tab number. + + + + + The number of selected tabs. + + + + + Ratio of the width of the tabs to the horizontal scrollbar. + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + The selected tab number. + + + + + The displayed tab number. + + + + + The number of selected tabs. + + + + + Indicates whether to display horizontal scrollbar. + + + + + Indicates whether to display vertical scrollbar. + + + + + Display tabs at the bottom. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Possible option flags. + + + + + Indicates whether window is hidden. + + + + + Indicates whether window is icon. + + + + + Reserved. + + + + + Indicates whether to display horizontal scrollbar. + + + + + Indicates whether to display vertical scrollbar. + + + + + Display tabs at the bottom. + + + + + Sheet window settings. + + + + + Maximum record size. + + + + + Indicates the size when this record is in Chart Sheet. + + + + + The option's bitmask (you should use the bit setters). + + + + + The top row visible in the window. + + + + + The leftmost column displayed in the window. + + + + + The palette index for the header color. + + + + + Zoom magification in page break view. + + + + + The zoom magnification in normal view. + + + + + Reserved. + + + + + Length of the original record. + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + The top row visible in the window. + + + + + The leftmost column displayed in the window. + + + + + The palette index for the header color. + + + + + Whether the window should display gridlines. + + + + + Whether the window should display row and column headings. + + + + + Whether the window should freeze panes. + + + + + Whether the window should display zero values. + + + + + Whether the window should display a default header. + + + + + Is this Arabic? + + + + + Freeze unsplit panes or not. + + + + + Sheet tab is selected. + + + + + Is the sheet currently displayed in the window? + + + + + Was the sheet saved in page break view? + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Length of the original record. + + + + + Possible option flags. + + + + + Indicates whether the window should display formulas. + + + + + Indicates whether the window should display gridlines. + + + + + Indicates whether the window should display row and column headings. + + + + + Indicates whether the window should freeze panes. + + + + + Indicates whether the window should display zero values. + + + + + Indicates whether the window should display a default header. + + + + + Indicates whether this is Arabic. + + + + + Indicates whether the outline symbols are displayed. + + + + + Indicates whether freeze panes are unsplit or not. + + + + + Indicates whether sheet tab is selected. + + + + + Indicates whether sheet is currently displayed in the window. + + + + + Indicates whether sheet was saved in page break view. + + + + + This record stores the magnification of the active view of the current worksheet. + In BIFF8 this can be either the normal view or the page break preview. + This is determined in the WINDOW2 record. + The magnification is stored as reduced fraction. The magnification results + from nscl / dscl. + + + + + Correct size of the record. + + + + + Numerator of the view magnification fraction. + + + + + Denominator of the view magnification fraction. + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + + + + + + This record stores a 16-bit value with Boolean options + for the current sheet. + + + + + Bit mask for DisplayGuts property. + + + + + First bit of the DispayGuts value. + + + + + + + + + + Option flags (you should use bit fields). + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Whether summary rows will appear below detail in outlines. + + + + + Whether summary rows will appear right of the detail in outlines. + + + + + Whether to fit stuff to the page. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + + + + + + + + + + + Indicates whether automatic breaks are visible. + + + + + Indicates whether sheet is a dialog sheet. + + + + + Indicates whether to apply automatic styles to outlines. + + + + + Indicates whether summary rows will appear below detail in outlines. + + + + + Indicates whether summary rows will appear right of the detail in outlines. + + + + + Indicates whether to fit stuff to the page. + + + + + Indicates whether to use alternate expression eval. + + + + + Indicates whether to use alternate formula entry. + + + + + XCT � CRN Count: + This record stores the number of immediately following CRN records. + These records are used to store the cell contents of external references. + + + + + Correct record size. + + + + + Number of following CRN records. + + + + + Index into sheet table of the involved SUPBOOK record. + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Number of following CRN records. + + + + + Index into sheet table of the SUPBOOK record. + + + + + Read-only. Minimum possible size of the record. + + + + + Read-only. Maximum possible size of the record. + + + + + Attribute provides link information between class and Biff8. + record types + + + + + Biff record code. + + + + + Default constructor. To prevent creation of attribute without attributes. + + + + + Creates attribute by record code. + + Biff record code. + + + + Read-only. Returns code of record. + + + + + Known field types to parser. + + + + + Represents the Integer field type. + + + + + Represents the Bit field type. + + + + + Represents the String field type. + + + + + Represents the String16Bit field type. + + + + + Represents the OEMString field type. + + + + + Represents the OEMString16Bit field type. + + + + + Represents the Float field type. + + + + + Attribute of records class members that provide information + about location of the variable in binary data. It also indicates + type to which the data must be converted to. + + + + + Position of the field in the record. + + + + + Size of the field. + + + + + True if attribute describes bit field. + + + + + True if attribute describes string field. + + + + + Indicates whether attribute describes string field with 16 bit length. + + + + + True if attribute describes OEM string field. + + + + + True if attribute describes OEM string field. + + + + + True if attribute describes float field. + + + + + True if attribute describes signed field. + + + + + Creates attribute by field position, size, signed flag, and field type. + + + Position of the filed data in the record data array. + + + Size of the field data or position of the bit in the byte. + + Is field signed or not? + Type of the field. + + + + Creates attribute for integer field by its position, + size, and signed flag. + + + Position of the filed data in the record data array. + + + Size of the field data or position of the bit in the byte. + + Is field signed or not? + + + + Creates attribute for unsigned field by field position, + size, and field type. + + + Position of the filed data in the record data array. + + + Size of the field data or position of the bit in the byte. + + Type of the field. + + + + Creates attribute by field position and field type. + Field size is zero and field is unsigned. + + + Position of the filed data in the record data array. + + Type of the field. + + + + Creates attribute for unsigned field by field position and size. + + + Position of the filed data in the record data array. + + + Size of the field data or position of the bit in the byte. + + + + + Read-only. Returns position of the field in the record data. + + + + + Read-only. Returns size of the filed or bit position (for bit fields). + + + + + Read-only. Returns True if attribute describes bit field. + + + + + Read-only. Returns True if attribute describes signed field. + + + + + Read-only. Returns True if attribute describes string field. + + + + + Indicates whether attribute describes string field with 16 bit length. + + + + + Read-only. Returns True if attribute describes float field. + + + + + Read-only. Returns True if this attribute describes OEM string. + + + + + Read-only. Returns True if this attribute describes OEM string with 16 bit length field. + + + + + Helper class which allows extract continue records from stream. + + + + + + + + + + Reference on reader. + + + + + Reference on start position in stream. + + + + + Current record extracted from stream. + + + + + Indicate whether the Reset method needs to be called. + + + + + + + + + + + + + + + + + + + + Class to store current stream position as start point. + + New position which stored as start point. + + + + + + + + + + Type safe Current record. + + + + + Special class for data publishing as Continue Records. + + + + + Reference to writer + + + + + Constructs class and sets reference to a writer. + + + Writer for which utility class will be constructed. + + + + + Publish / save data as Continue Records into writer stream. + + Data which must be published as Continue Records. + Start point in an array. + Size of records and data in bytes. + + + + Publish / save data as Continue Records into writer stream. + + Data which must be published as Continue Records. + Start point in an array. + Length of data from start point. + Size of records and data in bytes. + + + + Publish / save data as Continue Records into writer stream. + + Data which must be published as Continue Records. + Start point in an array. + Length of data from start point. + Maximum size of Continue Record size. + Size of records and data in bytes. + + + + Publish Continue Record into internal data array of destination record. + + Data to publish. + Start point. + Destination. + Offset in the destination's data array. + Size of the published data. + + + + Publish Continue Record into internal data array of destination record. + + Data to publish. + Start point. + Length of data to publish. + Destination. + Offset in the destination's data array. + Size of the published data. + + + + Publish Continue Record into internal data array of destination record. + + Data to publish. + Start point. + Length of data to publish. + Max size for continue record. + Destination. + Offset in the destination's data array. + Size of the published data. + + + + + Special class for building Continue Records. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Type of additional records. + + + + + + + + + + + + + + + + + + + + + + Write array of data into output stream. + + Array of data. + Start index of an array. + Length of data to copy. + Quantity of created Continue Records. + + + + + + + + + + Method that checks if Continue Record is needed. + + Length of data that needs to be stored. + True if Continue Record will be needed for data storage; + otherwise False. + + + + + + + + + + + + + + + + + + + + Returns the unused bytes. + + + + + + + + + + + + + + + Return maximum size of record. + + + + + Type of the first additional record. + + + + + Type of additional records. + + + + + Maximum size of the continue record data. + + + + + + + + + + Summary description for BytesList. + + + + + + + + + + + + + + + Default size of the internal array. + + + + + + + + + + First free position. + + + + + Indicates whether list can reserve some space. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains outline information about. + + + + + First Index of the row/column. + + + + + Last index of the row/column. + + + + + Indicates the Outline object + + + + + Indicates the Grouped range + + + + + Indicates the OfficeGroupBy type + + + + + Enum that defines constants for all known Biff records. + + + + + Represents the Array Biff record. + + + + + Represents the AutoFilter Biff record. + + + + + Represents the AutoFilterInfo Biff record. + + + + + Represents the BOF Biff record. + + + + + Represents the BOF2 Biff record. + + + + + Represents the Backup Biff record. + + + + + Represents the Begin Biff record. + + + + + It stores the background bitmap of a worksheet. + + + + + Represents the Blank Biff record. + + + + + Represents the BookBool Biff record. + + + + + Represents the BoolErr Biff record. + + + + + Represents the BottomMargin Biff record. + + + + + Represents the BoundSheet Biff record. + + + + + Represents the CF Biff record. + + + + + Represents the CF12 Biff record. + + + + + Represents the CFEx Biff record. + + + + + Represents the CRN Biff record. + + + + + Represents the CalCount Biff record. + + + + + Represents the CalcMode Biff record. + + + + + Represents the CodeName Biff record. + + + + + Represents the Codepage Biff record. + + + + + Represents the ColumnInfo Biff record. + + + + + Represents the CondFMT Biff record. + + + + + Represents the CondFMT12 Biff record. + + + + + Represents the Continue Biff record. + + + + + Represents the Continue Frt record. + + + + + Represents the Country Biff record. + + + + + Represents custom property record. + + + + + Represents the DBCell Biff record. + + + + + Represents the DCON Biff record. + + + + + Represents the DCONBIN Biff record. + + + + + Represents the DCONNAME Biff record. + + + + + Represents the DCONRef Biff record. + + + + + Represents the DSF Biff record. + + + + + Represents the DV Biff record. + + + + + Represents the DVal Biff record. + + + + + Represents the DateWindow1904 Biff record. + + + + + Represents the DefaultColWidth Biff record. + + + + + Represents the DefaultRowHeight Biff record. + + + + + Represents the Delta Biff record. + + + + + Represents the Dimensions Biff record. + + + + + Represents the EOF Biff record. + + + + + Represents the End Biff record. + + + + + Represents the ExtSST Biff record. + + + + + Represents the ExtSSTInfoSub Biff record. + + + + + Represents the ExtendedFormat Biff record. + + + + + Represents the ExtendedFormatCRC Biff record. + + + + + Represents the Extension of ExtendedFormat Biff record. + + + + + Represents the ExternCount Biff record. + + + + + Represents the ExternName Biff record. + + + + + Represents the ExternSheet Biff record. + + + + + Represents the FilePass Biff record. + + + + + Represents the FileSharing Biff record. + + + + + Represents the FilterMode Biff record. + + + + + Represents the FnGroupCount Biff record. + + + + + Represents the Font Biff record. + + + + + Represents the Footer Biff record. + + + + + Represents the Format Biff record. + + + + + Represents the Formula Biff record. + + + + + Represents the Gridset Biff record. + + + + + Represents the Guts Biff record. + + + + + Represents the HasBasic Biff record. + + + + + Represents the HCenter Biff record. + + + + + Represents the HLink Biff record. + + + + + Represents the Header Biff record. + + + + + Represents image in header or footer. + + + + + This record specifies the even page header and footer text, and the first page + header and footer text of the current sheet. + + + + + Represents the HideObj Biff record. + + + + + Represents the HorizontalPageBreaks Biff record. + + + + + Represents ImageData biff record. + + + + + Represents the Index Biff record. + + + + + Represents the InterfaceEnd Biff record. + + + + + Represents the InterfaceHdr Biff record. + + + + + Represents the Iteration Biff record. + + + + + Represents the Label Biff record. + + + + + Represents the LabelRanges Biff record. + + + + + Represents the LabelSST Biff record. + + + + + Represents the LeftMargin Biff record. + + + + + Represents the MMS Biff record. + + + + + Represents the MergeCells Biff record. + + + + + Represents the MSODrawing Biff record. + + + + + Represents the MSODrawingGroup Biff record. + + + + + Represents the MulBlank Biff record. + + + + + Represents the MulRK Biff record. + + + + + Represents the Name Biff record. + + + + + Represents the Note Biff record. + + + + + Represents the Number Biff record. + + + + + Represents the OBJ Biff record. + + + + + Represents the ObjectProtect Biff record. + + + + + Represents the OleSize Biff record. + + + + + Represents the Palette Biff record. + + + + + Represents the Pane Biff record. + + + + + Represents the Password Biff record. + + + + + Represents the PasswordRev4 Biff record. + + + + + Represents the Precision Biff record. + + + + + Represents the PrintedChartSize Biff record. + + + + + THis records saves settings and printer driver information. + + + + + Represents the PrintGridlines Biff record. + + + + + Represents the PrintHeaders Biff record. + + + + + Represents the PrintSetup Biff record. + + + + + Represents the Protect Biff record. + + + + + Represents the ProtectionRev4 Biff record. + + + + + Represents the QuickTip Biff record. + + + + + Represents the RefMode Biff record. + + + + + Represents the RefreshAll Biff record. + + + + + Represents the RightMargin Biff record. + + + + + Represents the RK Biff record. + + + + + Represents the Row Biff record. + + + + + Represents the RString Biff record. + + + + + Represents the SaveRecalc Biff record. + + + + + Represents the ScenProtect Biff record. + + + + + Represents the Selection Biff record. + + + + + Represents the default column width for all sheet columns. + + + + + Represents the Setup Biff record. + + + + + Represents the beginning of a collection of records + + + + + Represents the shape formatting properties for chart elements + + + + + Represents the end of a collection of records + + + + + Represents the SharedFormula Biff record. + + + + + Represents the SharedFormula2 Biff record. + + + + + This record stores the colour of the tab below the sheet containing the sheet name. + + + + + Represents the Sort Biff record. + + + + + Represents the SST Biff record. + + + + + Represents the String Biff record. + + + + + Represents the Style Biff record. + + + + + Represents the Extension of Style Biff record. + + + + + Represents the SupBook Biff record. + + + + + Represents the TabId Biff record. + + + + + Represents the Table Biff record. + + + + + Represents the Template Biff record. + + + + + Represents the TextObject Biff record. + + + + + Represents the TopMargin Biff record. + + + + + Represents the UseSelFS Biff record. + + + + + Represents the VCenter Biff record. + + + + + Represents the VerticalPageBreaks Biff record. + + + + + Represents the WSBool Biff record. + + + + + Represents the WindowOne Biff record. + + + + + Represents the WindowProtect Biff record. + + + + + Represents the WindowTwo Biff record. + + + + + Represents the WindowZoom Biff record. + + + + + Represents the WriteAccess Biff record. + + + + + Represents the WriteProtection record. + + + + + Represents the XCT Biff record. + + + + + Represents the Unknown Biff record. + + + + + Represents the UnkBegin Biff record. + + + + + Represents the UnkEnd Biff record. + + + + + Represents the UnkMarker Biff record. + + + + + Represents the UnkMacrosDisable Biff record. + + + + + This record contains workbook-specific information. + + + + + Represents the ChartDataLabels Biff record. + + + + + Represents the ChartChart Biff record. + + + + + Represents the ChartSeries Biff record. + + + + + Represents the ChartDataFormat Biff record. + + + + + Represents the ChartLineFormat Biff record. + + + + + Represents the ChartMarkerFormat Biff record. + + + + + Represents the ChartAreaFormat Biff record. + + + + + Represents the ChartPieFormat Biff record. + + + + + Represents the ChartAttachedLabel Biff record. + + + + + Represents the ChartAttachedLabelLayout Biff record. + + + + + Represents the ChartAttachedLabelPlotArea Biff record + + + + + Represents the ChartSeriesText Biff record. + + + + + Represents the ChartChartFormat Biff record. + + + + + Represents the ChartLegend Biff record. + + + + + Represents the ChartSeriesList Biff record. + + + + + Represents the ChartBar Biff record. + + + + + Represents the ChartLine Biff record. + + + + + Represents the ChartPie Biff record. + + + + + Represents the ChartArea Biff record. + + + + + Represents the ChartScatter Biff record. + + + + + Represents the ChartChartLine Biff record. + + + + + Represents the ChartAxis Biff record. + + + + + Represents the ChartTick Biff record. + + + + + Represents the ChartValueRange Biff record. + + + + + Represents the ChartCatserRange Biff record. + + + + + Represents the ChartAxisLineFormat Biff record. + + + + + Represents the ChartFormatLink Biff record. + + + + + Represents the ChartDefaultText Biff record. + + + + + Represents the ChartText Biff record. + + + + + Represents the ChartFontx Biff record. + + + + + Represents the ChartObjectLink Biff record. + + + + + Represents the ChartFrame Biff record. + + + + + Represents the ChartPlotArea Biff record. + + + + + Represents the Chart3D Biff record. + + + + + Represents the ChartPicf Biff record. + + + + + Represents the ChartDropBar Biff record. + + + + + Represents the ChartRadar Biff record. + + + + + Represents the ChartSurface Biff record. + + + + + Represents the ChartRadarArea Biff record. + + + + + Represents the ChartAxisParent Biff record. + + + + + Represents the ChartLegendxn Biff record. + + + + + Represents the ChartShtprops Biff record. + + + + + Represents the ChartSertocrt Biff record. + + + + + Represents the ChartAxesUsed Biff record. + + + + + Represents the ChartSbaseref Biff record. + + + + + Represents the ChartSerParent Biff record. + + + + + Represents the ChartSerAuxTrend Biff record. + + + + + Represents the ChartIfmt Biff record. + + + + + Represents the ChartPos Biff record. + + + + + Represents the ChartAlruns Biff record. + + + + + Represents the ChartAI Biff record. + + + + + Represents the chart text properties stream + + + + + Represents the ChartSerAuxErrBar Biff record. + + + + + Represents the ChartSerFmt Biff record. + + + + + Represents the Chart3DDataFormat Biff record. + + + + + Represents the ChartFbi Biff record. + + + + + Represents the ChartBoppop Biff record. + + + + + Represents the ChartAxcext Biff record. + + + + + Represents the ChartDat Biff record. + + + + + Represents the ChartPlotGrowth Biff record. + + + + + Represents the ChartSiIndex Biff record. + + + + + Represents the ChartGelFrame Biff record. + + + + + Represents the ChartBoppCustom Biff record. + + + + + Represents the ChartShadow Biff record. + + + + + Represents the ChartUnits Biff record. + + + + + Represents the ChartWrapper Biff record. + + + + + Represents the ChartAxisDisplayUnits biff record. + + + + + Represents the ChartBegDispUnitRecord biff record. + + + + + Represents the ChartEndDispUnitRecord biff record. + + + + + Represents the ChartAxisOffsetRecord biff record. + + + + + Represents the CacheData Biff record. + + + + + Represents the CacheDataEx Biff record. + + + + + Represents the DataItem Biff record. + + + + + Represents the ViewExtendedInfo Biff record. + + + + + Represents the ExternalSourceInfo Biff record. + + + + + Represents the SQLDataTypeId Biff record. + + + + + Represents the RuleFilter Biff record. + + + + + Represents the ParsedExpression Biff record. + + + + + Represents the PivotFormat Biff record. + + + + + Represents the PivotFormula Biff record. + + + + + Represents the StreamId Biff record. + + + + + Represents the RowColumnFieldId Biff record. + + + + + Represents the LineItemArray Biff record. + + + + + Represents the PivotName Biff record. + + + + + Represents the PivotNamePair Biff record. + + + + + Represents the PageItem Biff record. + + + + + Represents the RuleData Biff record. + + + + + Represents the SelectionInfo Biff record. + + + + + Represents the sheet protection biff record. + + + + + Represents range protection and error indicators. + + + + + Represents the PivotString Biff record. + + + + + Represents the PivotSourceInfo Biff record. + + + + + Represents the PageItemIndexes Biff record. + + + + + Represents the PageItemNameCount Biff record. + + + + + Represents the PivotViewFields Biff record. + + + + + Represents the PivotViewFieldsEx Biff record. + + + + + Represents the PivotViewItem Biff record. + + + + + Represents the PivotViewDefinition Biff record. + + + + + Represents the PivotViewSource Biff record. + + + + + Represents the PivotDateTime Biff record. + + + + + Represents the PivotDouble Biff record. + + + + + Represents the PivotEmpty Biff record. + + + + + Represents the PivotBoolean Biff record. + + + + + Represents the PivotError Biff record. + + + + + Represents the PivotField Biff record. + + + + + Represents the PivotIndexList Biff record. + + + + + Represents pivot view additional info record. + + + + + + Rerpresents the External connection record. + + + + + Represents properties for a query table. + + + + + Represents the properties for a query table field. + + + + + Represents a DbQuery or ParamQry record depending on the record. + + + + + Represents the name and refresh information for a query table or a PivotTable view. + + + + + Represents shared feature data that is used to describe a table in a worksheet + + + + + Represents the properties related to the formatting of a query table. + + + + + Represents the additional properties + + + + + Represents the DataBaseConnection + + + + + Represents the oledbconnection + + + + + Represents the Externalconnectioncollection + + + + + Represents the Feature record for query table + + + + + Represents the pagelayout view record + + + + + + + + + + Storage of all records. + + + + + Removes the item at the specified index from the list. + + Index of the item to removed. + + + + Inserts an item to the list at the specified position. + + Index at which value should be inserted. + The record to insert into list. + + + + Removes the first occurrence of a specific record from the list. + + Value to remove. + + + + Determines whether the list contains a specific value. + + The record to locate in the list. + True if the value is found in the list; otherwise False. + + + + Removes all items from the list. + + + + + Determines the index of a specific item in the list. + + Record to locate in the list. + The index of the value if found in the list; otherwise -1. + + + + Adds an item to the list. + + The item to add to the list. + The position into which the new element was inserted. + + + + Adds an item to the list. + + The item to add to the list. + The position into which the new element was inserted. + + + + Adds a range of items to the list. + + + Collection of the records that should be added to the list. + + + + + Adds a range of items to the list. + + + Collection of the records that should be added to the list. + + + + + Adds a range of items to the list. + + + Collection of the records that should be added to the list. + + + + + Inserts an item to the list at the specified position. + + Index at which value should be inserted. + The record to insert into list. + + + + Removes the first occurrence of a specific record from the list. + + Value to remove. + + + + Determines whether the list contains a specific value. + + The record to locate in the list. + True if the value is found in the list; otherwise False. + + + + Determines the index of a specific item in the list. + + Record to locate in the list. + The index of the value if found in the list; otherwise -1. + + + + Adds an item to the list. + + The item to add to the list. + The position into which the new element was inserted. + + + + Copies the elements of the ICollection to an array, + starting at a particular array index. + + + The one dimensional array that is the destination of the + elements copied from ICollection. The array must have + zero-based indexing. + + + The zero-based index in an array at which copying begins. + + + + + Returns an enumerator that can iterate through a collection. + + + An IEnumerator that can be used to iterate through the collection. + + + + + Returns an enumerator that can iterate through a collection. + + + An IEnumerator that can be used to iterate through the collection. + + + + + Updates offsets to the Biff records. + + + + + Method that updates StreamPos field in records stored in this collection. + + + + + Read-only. True if list has fixed size. + + + + + Read-only. True if list is Read-only. + + + + + Gets / sets record in the list at the specified index. + + + + + Gets / sets record in the list at the specified index. + + + + + Read-only. Gets a value indicating whether access to the + ICollection is synchronized (thread-safe). + + + + + Read-only. Gets the number of elements contained in the ICollection. + + + + + Read-only. Gets an object that can be used to synchronize + access to the ICollection. + + + + + This class contains information about all known biff records. + Used for registering the biff record type, creating new biff records + and extracting them from a stream. + + + + + Default size for the internal dictionaries + + + + + code-to-constructor pair + + + + + Initialize internal dictionary by Records + + + + + Fills factory without using reflection. + + + + + Create empty record by specified type. + + Type of the record that should be created. + Created record if succeeded, null otherwise. + + + + Create empty record by specified type. + + Type of the record that should be created. + Created record if succeeded, null otherwise. + + + + Extracts record from array of bytes. + + Object that provides access to the data. + Offset to the record's start. + Excel version used for infill. + Extracted record. + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + + Looks up a localized string similar to 0 #825600;8520f #ffa800;18350f #825600;28180f #ffa800;38011f #825600;47186f #ffa800;57016f #825600;1 #ffa800. + + + + + Looks up a localized string similar to 0 #ccf;11796f #9cf;23593f #96f;39977f #c9f;53740f #9cf;1 #ccf. + + + + + Looks up a localized string similar to 0 white;10486f #1f1f1f;11796f white;27525f #636363;34734f #cfcfcf;43254f #cfcfcf;49807f #1f1f1f;51773f white;1 #7f7f7f. + + + + + Looks up a localized string similar to 0 #cbcbcb;8520f #5f5f5f;13763f #5f5f5f;41288f white;43909f #b2b2b2;45220f #292929;53740f #777;1 #eaeaea. + + + + + Looks up a localized string similar to 0 #5e9eff;26214f #85c2ff;45875f #c4d6eb;1 #ffebfa. + + + + + Looks up a localized string similar to 0 #fc9fcb;8520f #f8b049;13763f #f8b049;41288f #fee7f2;43909f #f952a0;45220f #c50849;53740f #b43e85;1 #f8b049. + + + + + Looks up a localized string similar to 0 #000082;19661f #66008f;42598f #ba0066;58982f red;1 #ff8200. + + + + + Looks up a localized string similar to 0 #fff200;29491f #ff7a00;45875f #ff0300;1 #4d0808. + + + + + Looks up a localized string similar to 0 #8488c4;34734f #d4deff;54395f #d4deff;1 #96ab94. + + + + + Looks up a localized string similar to 0 #e6dcac;7864f #e6d78a;19661f #c7ac4c;29491f #e6d78a;50463f #c7ac4c;1 #e6dcac. + + + + + Looks up a localized string similar to 0 #fbe4ae;8520f #bd922a;13763f #bd922a;41288f #fbe4ae;43909f #bd922a;45220f #835e17;53740f #a28949;1 #fae3b7. + + + + + Looks up a localized string similar to 0 #dcebf5;5243f #83a7c3;8520f #768fb9;13763f #83a7c3;34079f white;36700f #9c6563;38011f #80302d;46531f #c0524e;61604f #ebdad4;1 #55261c. + + + + + Looks up a localized string similar to 0 black;13107f #000040;.5 #400040;.75 #8f0040;58982f #f27300;1 #ffbf00. + + + + + Looks up a localized string similar to 0 #d6b19c;19661f #d49e6c;45875f #a65528;1 #663012. + + + + + Looks up a localized string similar to 0 #ddebcf;.5 #9cb86e;1 #156b13. + + + + + Looks up a localized string similar to 0 black;26214f #0a128c;45875f #181cc7;57672f #7005d4;1 #8c3d91. + + + + + Looks up a localized string similar to 0 #03d4a8;.25 #21d6e0;.75 #0087e6;1 #005cbf. + + + + + Looks up a localized string similar to 0 #ffefd1;42598f #f0ebd5;1 #d1c39f. + + + + + Looks up a localized string similar to 0 #39f;10486f #0cc;30802f #99f;39322f #2e6792;46531f #33c;53084f #1170ff;1 #069. + + + + + Looks up a localized string similar to 0 #a603ab;13763f #0819fb;22938f #1a8d48;34079f yellow;47841f #ee3f17;57672f #e81766;1 #a603ab. + + + + + Looks up a localized string similar to 0 #f39;.25 #f63;.5 yellow;.75 #01a78f;1 #36f. + + + + + Looks up a localized string similar to 0 #000082;8520f #0047ff;18350f #000082;28180f #0047ff;38011f #000082;47186f #0047ff;57016f #000082;1 #0047ff. + + + + + Looks up a localized string similar to 0 white;4588f #e6e6e6;20972f #7d8496;30802f #e6e6e6;55706f #7d8496;1 #e6e6e6. + + + + + Looks up a localized string similar to 0 #fbeac7;11796f #fee7f2;23593f #fac77d;39977f #fba97d;53740f #fbd49c;1 #fee7f2. + + + + + Represents the group shape in a worksheet. + + + + + Returns the array of individual shapes in the specified . + + + The following code illustrates how to get items from group shape. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("GroupShapes.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IShapes shapes = worksheet.Shapes; + IShape[] groupItems = (shapes[0] as IGroupShape).Items; + + //Save and dispose + workbook.SaveAs("GroupShapes.xlsx"); + workbook.Close(); + } + + + + + + A collection of cell comments. Each comment is represented by a + Comment object. + + + + + Returns the number of objects in the collection. Read-only Long. + + + The following code illustrates how to access Count property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add pictures + worksheet.Pictures.AddPicture("image.png"); + worksheet.Pictures.AddPicture("image.png"); + + //Get count + Console.Write(worksheet.Pictures.Count); + + //Save and dispose + workbook.SaveAs("Pictures.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + + + + + + Returns a single object from the collection. + + + To know more about changing the dimensions of the added to refer Positioning and Re-Sizing Pictures. + + + The following code illustrates how to access an object in the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add picture + worksheet.Pictures.AddPicture("image.png"); + + //Set picture + IPictureShape picture = worksheet.Pictures[0]; + + //Set dimension + picture.Left = 3; + picture.Top = 3; + picture.Height = 50; + picture.Width = 50; + + //Save and dispose + workbook.SaveAs("Pictures.xlsx"); + workbook.Close(); + } + + + + + + Gets single from the collection. + + Name of the item to get. + Single item from the collection. + + The following code illustrates how to access a object from the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add picture + worksheet.Pictures.AddPicture("image.png"); + + //Set picture + IPictureShape picture = worksheet.Pictures["image"]; + + //Set dimension + picture.Left = 3; + picture.Top = 3; + picture.Height = 50; + picture.Width = 50; + + //Save and dispose + workbook.SaveAs("OLEObjects.xlsx"); + workbook.Close(); + } + + + + + + Represents the group shape in a worksheet. + + + + + Inner shapes collection. + + + + + Represents vetical flip of the shape. + + + + + Represents horizontal flip of the shape + + + + + Represents preserved elements of the group shape. + + + + + Initializes new instance of the group shape. + + Application object for the new group shape. + Parent object for the new group shape. + + + + Creates a clone of the current group shape. + + A copy of the current current shape. + + + + Layout the group shape and inner shapes. + + + + + Layout the group shape and inner shapes. + + Group shape to layout. + + + + Set updated child offset for group shape. + + + + + Returns the array of individual shapes in the specified . + + + + + Gets or Sets vetical flip + + + + + Gets or Sets vetical flip + + + + + Represents preserved elements of the group shape. + + + + + + + + + + Default prefix for picture name. + + + + + Parent worksheet. + + + + + + + + + + + + Removes picture from this collection only. + + Picture to remove. + + + + Adds picture to this collection only. + Should be called from Shapes collection only. + + Picture to add. + + + + + + + Can't find parent worksheet. + + + + + Generate Picture name + + + + + Gets single item from the collection. + + Name of the item to get. + Single item from the collection. + + + + + This class holds the name of the Syncfusion.OfficeChart.Base assembly and provides a helper + routine that helps with resolving types when loading a serialization stream and when + the framework probes for assemblies by reflection. + + + + + The full name of this assembly without version information: "Syncfusion.OfficeChart" + + + + + A reference to the for the XlsIO assembly. + + + + + The root namespace of this assembly. Used internally for locating resources within the assembly. + + + + + This delegate helps with resolving types and can be used as a eventhandler + for a event. + + The source of the event. + The event data with information about the type. + A reference to the assembly where the type is located. + + Use this handler when reading back types from a serialization stread + saved with an earlier version of this assembly. + + + + public static GridModel LoadSoap(Stream s) + { + try + { + AppDomain.CurrentDomain.AssemblyResolve += new ResolveEventHandler(GridAssembly.AssemblyResolver); + SoapFormatter b = new SoapFormatter(); + b.AssemblyFormat = FormatterAssemblyStyle.Simple; + GridModel t = b.Deserialize(s) as GridModel; + t.Modified = false; + return t; + } + finally + { + AppDomain.CurrentDomain.AssemblyResolve -= new ResolveEventHandler(GridAssembly.AssemblyResolver); + } + } + + + + + diff --git a/ZZPDFTest/bin/Debug/Syncfusion.PdfViewer.Windows.dll b/ZZPDFTest/bin/Debug/Syncfusion.PdfViewer.Windows.dll new file mode 100644 index 00000000..f7c21e0b Binary files /dev/null and b/ZZPDFTest/bin/Debug/Syncfusion.PdfViewer.Windows.dll differ diff --git a/ZZPDFTest/bin/Debug/Syncfusion.PdfViewer.Windows.xml b/ZZPDFTest/bin/Debug/Syncfusion.PdfViewer.Windows.xml new file mode 100644 index 00000000..10e3f895 --- /dev/null +++ b/ZZPDFTest/bin/Debug/Syncfusion.PdfViewer.Windows.xml @@ -0,0 +1,20892 @@ + + + + Syncfusion.PdfViewer.Windows + + + + + + + + WinAnsiEncoding Charcode table + + + + + Internal variable that holds cff glyphs + + + + + Takes in the encoded text, identifies the type of encoding used, decodes the encoded text, returns the decoded text. + + + Encoded string from the PDF document. + + Same font. + + Decoded string, human readable. + + + + + Decodes the octal text in the encoded text. + + The text encoded from the PDF document + Decoded text with replaced octal texts + + + + Decodes the HEX encoded string. + + + HEX encoded string. + + + Decoded string. + + + + + Extracts the font name associated with the string. + + + Font name. + + + + + Extracts the font style associated with the text string + + + Font style. + + + + + Extracts the font encoding associated with the text string + + + Font style. + + + + + Parsing the stream from the Adobe-Japan1-6.cidmap resource to create CIDMapTable + + CID map table resource + Adobe Japan CID map table + + + + Parse the Japanese character where the value is reference to another key in the Adobe Japan Cid Map Table + + mapped value which is a reference to another key + Mapped Character present in the Adobe Japan Cid Map table + + + + Decodes the ASCII85 encoded stream + + Encoded stream + Decoded Stream + + + + Decodes the Flate encoded stream + + Encoded stream + Decoded Stream + + + + Builds the mapping table that is used to map the decoded text to get the expected text. + + + A dictionary with key as the encoded element and value as the value to be mapped to. + + + + + Builds the mapping table that is used to map the decoded text to get the expected text. + + + + + Gets Latin Character + + The decodedCharacter. + decodedCharacter + + + + Gets Latin Character + + The decodedCharacter. + decodedCharacter + + + + Takes in the decoded text and maps it with its corresponding entry in the CharacterMapTable + + decoded text + Expected text string + + + + Takes in the decoded text and maps it with its corresponding entry in the CharacterMapTable + + decoded text + rendered string + Expected text string + + + + Takes in the decoded text and maps it with its corresponding entry in the CharacterMapTable + + encoded text + Expected text string + + + + Method to remove the new line character + + Text with new line character + Text without new line character + + + + Organizes the hex string enclosed within the hexa brackets + + Mapping string in the map table of the document + list of HEX entries in the string + + + + Checks whether the specified character is Non-Printable character or not. + + The character to be verified as either Non-Printable or not + Returns true, if the specified character is Non-Printable character. Otherwise it returns false + + + + Releasing, or resetting unmanaged resources. + + + + + Gets or sets the value indicating whether the encoded text is hexa decimal string + + + + + Gets the Font Matrix + + + + + Gets the Font BBox + + + + + Holds the font name associated with the text element + + + + + Holds the font style of the text to be decoded. + + + + + Gets and sets whether same font is denoted in more than one XObject. + + + + + Holds the font encoding associated with the text element + + + + + Gets or sets the rendered text. + + + + + Gets or sets the index and width for encode text (only utilized when different encode text decoded as same character). + + + + + Decodes the image stream in the PDF document into an image + + + + + Sets the fields associated with the TIFF image + + Number of fields + Value of the field + Name of the TIFF tag + Type of the tag value + + + + Writes the header to the TIFF image + + Specifies the header of the TIFF image + + + + Writes the list of fields associated with the TIFF image + + List of TIFF fields + + + + Writes short value into the TIFF stream + + Short value to be written + + + + Writes integer value into the TIFF stream + + Integer value to be written + + + + Structure of the TIFF header + + + + + Size of the byte order of the tiff image + + + + + TIFF version number + + + + + byte offset to first directory + + + + + Tag entry to the TIFF stream + + + + + Represents the TIFF tag + + + + + Represents the type of the TIFF tag + + + + + number of items; length in spec + + + + + byte offset to field data + + + + + Width of the image in pixels + + + + + Height of the image in pixels + + + + + Bits per channel (sample). + + + + + Compression technique + + + + + Photometric interpretation. + + + + + Offsets to data strips. + + + + + Samples per pixel. + + + + + Bytes counts for strips. + + + + + 16-bit unsigned integer. + + + + + 32-bit unsigned integer. + + + + + Collects all the ExtendedGraphicsSatate elements in the pdf document + + containing all the resources of the document + dictionary of ExtGState elements + + + + Collects all the fonts in the page in a dictionary + + dictionary containing all the resources in the Xobjects + dictionary containing font name and the font + + + + Extracts the text from the page given + + page from which text is extracted + font used in the text + text in the page to be decoded + decoded text + + + + Collects all the fonts in the page in a dictionary + + dictionary containing all the resources in the page + page in which text is to be extracted + dictionary containing font name and the font + + + + Collects all the images in the pdf document + + containing all the resources of the document + dictionary of images + + + + Updates the resources in the page + + Existing page resources + Dictionary items to the updated + Updated page resource + + + + The class provides methods and properties to access the PDF page resources. + + + + + Returns if the FontCollection has same font face. + + if font present true, else false + + + + Initializes the new instance of the class + + + + + Adds the resource with the specified name. + + Name of the resource + Resource to add + + + + Returns if the key already exists. + + if key present true,else false + + + + Gets the PDF page resources. + + + + + Gets or sets the value associated with the key. + + + + + Gets or sets the value that indicating the extracting of text data. + + + + + Gets or sets the value that indicating the extracting of text data. + + + + + Gets or sets the value that indicating the extracting of text data. + + + + + + + + + + + + + + Local variable to store the whitepoint value of CalGray colorspace. + + + + + Local variable to store the blackpoint value of CalGray colorspace. + + + + + Local variable to store the gamma value of CalGray colorspace. + + + + + Gets the number of components for the CalGray Colorspace. + + + + + Gets or sets the Whitepoint value for the CalGray Colorspace. + + + + + Gets or sets the Blackpoint value for the CalGray Colorspace. + + + + + Gets or sets the Gamma value for the CalGray Colorspace. + + + + + + + + Local variable to store the whitepoint value of CalRgb colorspace. + + + + + Local variable to store the blackpoint value of CalRgb colorspace. + + + + + Local variable to store the gamma value of CalRgb colorspace. + + + + + Local variable to store the matrix value of CalRgb colorspace. + + + + + Gets the number of components for the CalRgb Colorspace. + + + + + Gets or sets the Whitepoint value for the CalRgb Colorspace. + + + + + Gets or sets the Blackpoint value for the CalRgb Colorspace. + + + + + Gets or sets the Gamma value for the CalRgb Colorspace. + + + + + Gets or sets the Matrix value for the CalRgb Colorspace. + + + + + + + + + + + Gets the number of components for the DeviceCMYK Colorspace. + + + + + + + + Gets the number of components for the DeviceGray Colorspace. + + + + + + + + Local variable to store the AlternateColorspace value of DeviceN colorspace. + + + + + Local variable to store the function value of DeviceN colorspace. + + + + Set the Colorspace value to local variable from Pdfarray + ColorspaceArray + + + + Get the Colorspace value from Pdfarray + ColorspaceArray + Colorspace + + + + Gets the number of components for the DeviceN Colorspace. + + + + + Gets or set the AlternateColorspace value for DeviceN colorspace + + + + + Gets or set the Function value for DeviceN colorspace + + + + + + + + Gets the number of components for the DeviceRgb Colorspace. + + + + + + + + Local variable to store the IccProfile value of ICCBased colorspace. + + + + + Gets or sets the IccProfile value for the ICCBased Colorspace. + + + + + Gets the Components for the IccBased Alternate Colorspace. + + + + + + + + Local variable to store the N value of IccProfile. + + + + + Local variable to store the alternate colorspace. + + + + + Local variable to store the IccProfile value of IccBased colorspace. + + + + + Local variable to store the matrix value of CalRgb colorspace. + + + + + Gets the Alternate colorspace of IccBased colorspace. + + + + + Gets or sets the N value for the ICCBased Colorspace. + + + + + + + + Local variable to store the BaseColorspace value of Indexed colorspace. + + + + + Local variable to store the Maximum valid index value of Indexed colorspace. + + + + + Local variable to store the Lookup parameter value of Indexed colorspace. + + + + + Get the color value of Indexed colorspace + + Index value for color + Color + + + + Set the Indexed colorspace data to local variable + + Index value Array + + + + + Get the Color + + Color component + Color + + + + Get the Base colorspace of Indexed color space + + Index value Array + Colorspace + + + + Get the Lookup data of Indexed colorspace + + Index value Array + + + + + Get the colorspace of Base colorspace + + Colorspace + + + + Get the Decoded stream of Type0 data + + Type0 stream + Decoded Byte + + + + Decode the FlateDecode stream + + Type0 encoded stream + Memory stream + + + + Gets the number of components for the Indexed Colorspace. + + + + + Gets the DefaultBrush value for the Indexed BaseColorspace. + + + + + Gets or sets the BaseColorspace value for the Indexed Colorspace. + + + + + Gets or sets the Maximum valid index value for the Indexed Colorspace. + + + + + Gets or sets the Lookup parameter value for the Indexed Colorspace. + + + + + + + + Local variable to store the whitepoint value of Labcolorspace. + + + + + Local variable to store the blackpoint value of Labcolorspace. + + + + + Local variable to store the range value of Labcolorspace. + + + + + Gets the number of components for the Labcolorspace. + + + + + Gets or sets the Whitepoint value for the Labcolorspace. + + + + + Gets or sets the Blackpoint value for the Labcolorspace. + + + + + Gets or sets the Range value for the Labcolorspace. + + + + + + + + Local variable to store the Lookup Data of Indexed colorspace + + + + + Load the Lookup stream data of Indexed color space + + Lookup stream data + + + + + Load the Lookup byte string data of Indexed colorspace + + Byte string + + + + + Load the Lookup data reference of Indexed color space + + Reference of Lookup data + + + + + Gets the Lookup Data of Indexed colorspace + + + + + + + + Local variable to store the PatternType value of Pattern colorspace. + + + + + Local variable to store the AlternateColorspace value of Pattern colorspace. + + + + + Local variable to store the PatternMatrix value of Pattern colorspace. + + + + + Local variable to store the Pattern value of Pattern colorspace. + + + + + Gets or sets the AlternateColorspace value for the Pattern Colorspace. + + + + + Gets or sets the PatternMatrix value for the Pattern Colorspace. + + + + + Gets or sets the PatternType value for the Pattern Colorspace. + + + + + + + + Local variable to store the Alternate colorspace value of Seperation colorspace. + + + + + Local variable to store the Function value of Seperation colorspace founction. + + + + Get the color value from string value + string Array + Color + + + + Convert the string array to double array + + string Array + Double array + + + Get the color value from bytes + string Array + Offset Value + Color + + + + Set the Seperation colorspace data to local variable + + seperation value Array + + + + + Get the Seperation colorspace Alternate colorspace from array value + + seperation value Array + Alternate colorspace + + + + Gets the number of components for the Seperation Colorspace. + + + + + Gets or sets the Alternate colorspace value for the Seperation Colorspace. + + + + + Gets or sets the Function value for the Seperation Colorspace. + + + + + + + + + + + + + + Gets or sets a value of the StrokingColorspace + + + + + Gets or sets a value of the NonStrokingColorspace + + + + + Gets or sets a value of the StrokingBrush + + + + + Gets or sets a value of the NonStrokingBrush + + + + + + + + Set the Stroking colorspace of current graphics state + + current colorspace value + + + + + Set the Non Stroking colorspace of current graphics state + + current colorspace value + + + + + Set the Non Stroking RGB color of current graphics state brush + + color value of RGB + + + + + Set the Non Stroking CMYK color of current graphics state brush + + color value of CMYK + + + + + Set the Non Stroking Gray color of current graphics state brush + + color value of Gray + + + + + Set the Stroking RGB color of current graphics state brush + + color value of RGB + + + + + Set the Stroking CMYK color of current graphics state brush + + color value of CMYK + + + + + Set the Stroking Gray color of current graphics state brush + + color value of Gray + + + + + Set the Stroking of current graphics state brush + + color value + + + + + Set the Non Stroking of current graphics state brush + + color value + + + + + Determining valid email address + + email address to validate + true is valid, false if not valid + + + + Calculates the height of text. + + + + + Cleared the collections + + + + + Gets or sets the value that indicating the extracting of text data. + + + + + Holds the mcid value. + + + + + Renders the Text to the panel + + graphics element + location in which the graphics is to be drawn + + + + Renders the Text to the panel + + graphics element + location in which the graphics is to be drawn + + + + Removes the escape sequence characters in the given text + + text with the escape sequence + Text without escape sequence + + + + Gets or sets the rotate text angle. + + + + + Gets or sets the value that indicating the extracting of text data. + + + + + + + + + + + Local variable to store the Domain value of Function + + + + + Local variable to store the Range value of Function + + + + + Local variable to store the dictionary of Function + + + + + Create the function type from dictionary + + Array + Function + + + + Color transfer function + + Input color component value + Double array + + + + Extract the Input Data + + Input data + Double array + + + + Extract the Output Data + + Output data + Double array + + + + Perform Interpolate function + + result + + + + Clip the Data + + result + + + + Gets or sets the Domain value of Function. + + + + + Gets or sets the Range value of Function. + + + + + + + + Local variable to store the BitsPerSample of Type0 + + + + + Local variable to store the Order of Type0 + + + + + Local variable to store the Size of Type0 + + + + + Local variable to store the Encode value of Type0 + + + + + Local variable to store the Decode value of Type0 + + + + + Local variable to store the sample value of Type0 + + + + + Local variable to store the Output value count of Type0 + + + + + Local variable to store the Filter of Type0 Data + + + + + Load the Type0 function stream to local variable + + Type0 Data + + + + + Execute the Type0 function + + Input Data + Color values + + + + Encode the input data of Type0 + + EncodedData + + + + Decode the input data of Type0 + + DecodedData + + + + Get the index of data + + Data + Index + + + + Get the Decoded stream of Type0 data + + Type0 stream + Decoded Byte + + + + Decode the FlateDecode stream + + Type0 encoded stream + Memory stream + + + + Gets or sets the BitsPerSample value of Type0 function. + + + + + Gets or sets the Filter value of Type0 function. + + + + + Gets or sets the Order value of Type0 function. + + + + + Gets or sets the Decode value of Type0 function. + + + + + Gets or sets the Encode value of Type0 function. + + + + + Gets or sets the Size value of Type0 function. + + + + + + + + Local variable to store the C0 value of Type2 function + + + + + Local variable to store the C1 value of Type2 function + + + + + Local variable to store the N value of Type2 function + + + + + Local variable to store the Functions resources value of Type2 function + + + + + Perform the Type0 function + + Input Data + Color values + + + + Perform the Type0 function of Single input data + + Single input data + outputData + + + + Perform the ExponentialInterpolation function + + value + value + value + result + + + + Gets or sets the Function resource value of Type2 function. + + + + + Gets or sets the C0 value of Type2 function. + + + + + Gets or sets the C1 value of Type2 function. + + + + + Gets or sets the N value of Type2 function. + + + + + Gets the output element length + + + + + + + + Local variable to store the Encode value of Type3 function + + + + + Local variable to store the Bounds value of Type3 function + + + + + Local variable to store the Functions value of Type3 function + + + + + Perform the Type4 function + + Input Data + Color values + + + + Gets or sets the Encode value of Type3 function. + + + + + Gets or sets the Bounds value of Type3 function. + + + + + Gets or sets the Function value of Type4 function. + + + + + + + + Local variable to store the Post Script Stream + + + + + Local variable to store the Filter type of Post Script + + + + + Stack pointer + + + + + List of Post Script Operator + + + + + Stack value of Post Script Data + + + + + Operator type array of Post Script Operator + + + + + Current operator type value + + + + + Load the Type4 function stream to local variable + + Type4 Data + + + + + Get the Decoded stream of Type4 function + + Type0 Data + + + + + Perform the Type4 function + + Input Data + Color values + + + + Decodes the ASCII85 encoded stream + + Encoded stream + Decoded Stream + + + + Gets the output element value length + + + + + Gets or sets the Filter value of Type4 function stream. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains definition for sorting the enumerator in ascending order + + Type of return value + Delegate + Used to compare two object + If it is set to true, enumerator is sorted in descending order other it is sorted in ascending order + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets the embeded font family. + + + + + Gets the updated font size from text matrix. + + + + + + + + Base viewer interface for all PdfViewers. + + + + + Zooms the document to the specified value. + + Value in Percentage + + + + Displays the first page. + + + + + Displays the last page. + + + + + Displays the previous page. + + + + + Displays the next page. + + + + + Displays the page specified by the index. + + Index of the page + + + + Returns the number of pages. + + + + + Returns the current displayed page index. + + + + + Returns if first page can be displayed. + + + + + Returns if previous page can be displayed. + + + + + Returns if next page can be displayed. + + + + + Returns if last page can be displayed. + + + + + Specifies ZoomMode. + + + + + Displays with detault. + + + + + Fits the entire page in the viewer. + + + + + Fits the width of the page in the viewer. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required designer variable. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Gets or sets the font of the text displayed by the control. + + + + Reference on parent control + + + + Initializes new instance of ControlsCollectionBase class + + Reference on parent control. Can not be NULL. + + + + Initializes new instance of ControlsCollectionBase class + + Reference on parent control. Can not be NULL. + Attach event handler to ConfigureControl event on initialize. + + + Occurs when collection changed. + + + + + + + + + Add Control object to collection. + + + + + + + + + + + Removes control from collection. + + + + + + Insert control in position with index value is index. + + + + + + + + + + + + + + Includes/exclude controls from parent controls collection. + + If true - excludes, else includes controls in parent controls collection. + + + + + + + + + + + + + + + + + + + + + + Reference on parent control/container. + + + Typed version of indexer. + + + + + + + + + Message class that contains reference on control that + required configuration. + + + Storage of control reference. + + + Default constructor. + + + + Get reference on Control. + + + + + + + + + Represents a standard Windows horizontal scroll bar. + + + Most controls that need scroll bars already provide them and do not require this + control. This is true of a multi-line control, + a and a , + for example. + You can use this control to implement scrolling in containers that do not provide their + own scroll bars, such as a or for user input of numeric data. + The numeric data may be displayed in a control or utilized in code. + The and properties + determine the range of values the user can select. The property determines the effect of + clicking within the scroll bar but outside the scroll box. The property determines the effect of + clicking the scroll arrows at each end of the control. + + + + + + + Implements the basic functionality of a scroll bar control. + + + To adjust the value + range of the scroll bar control, + set the and + properties. + To adjust the distance the scroll box moves, set the and properties. To + adjust the starting point of the scroll box, set the property when the + control is initially displayed. + + The scroll box is sometimes + referred to as the "thumb". + + + + + + + + Defines an interface that provides all properties to configure a scrollbar. + + + + + Updates the scrollbar with latest changes to current position and scrollable range. + + + + + Gets or sets a value to be added to or subtracted from the value of the property when the scroll box is moved a large distance. + + + + + Gets or sets the upper limit of values of the scrollable range. + + + + + Gets or sets the lower limit of values of the scrollable range. + + + + + Gets or sets the value to be added to or subtracted from the value of the property when the scroll box is moved a small distance. + + + + + Gets or sets a numeric value that represents the current position of the scroll box on the scroll bar control. + + + + + Gets or sets a number that represents the current position of the scroll box on the scroll bar control. + + + + + Enables or disables thumbtrack feature for the scrollbar. + + + + + Indicates whether the scrollbar is in thumb drag mode. + + + + + Indicates whether ScrollTips should be shown for the scrollbar. + + + + + Creates the handler. Overridden to help set up scrollbar information. + + + + + + + + + + + + + + + + + Resets the backcolor of the scroll bar. + + + + + + + + Indicates whether the associated control should scroll while the user is dragging a scrollbar thumb. + + + + + Indicates whether the parent control should show ScrollTips while the user is dragging a scrollbar thumb. + + + checks this property to determine if ScrollTips should be displayed. + + + + + Indicates whether the scroll bar is currently in thumb drag mode. + + + + + Gets / sets the effect of clicking within the scroll bar but outside the scroll box. + + + + + Gets / sets the maximum range of the scroll bar. Default is 100. + + + + + Gets / sets the minimum range of the scroll bar. Default is zero. + + + + + Gets / sets the effect of clicking the scroll arrows at each end of the control. + + + + + Gets / sets the starting value of the scroll bar. + + + + + Gets / sets the background color of this scrollbar. + + + + + Gets / sets the scroll bar style. Default is Flat style. + + + + + Constructor. + + + + + + + + + + Returns the parameters needed to create the handler. Inheriting classes + can override this to provide extra functionality. They should not, + however, forget to call base.getCreateParams() first to get the structure + filled up with the basic info. + + + + + + + Represents a standard Windows vertical scroll bar. + + + Most controls that need scroll bars already provide them + and do not require this control. This is true of a multi-line + control, a + and a , for example. + You can use this control to implement scrolling in + containers that do not provide their own scroll bars, such as + a or for user input + of numeric data. The numeric data may be displayed in a control or utilized in + code. The and + properties determine the range of values the user can select. The property + determines the effect of clicking within the scroll bar but outside the scroll + box. The property + determines the effect of clicking the scroll arrows at each end of the control. + + + + + + + Constructor. + + + + + + + + + + Returns the parameters needed to create the handler. Inheriting classes + can override this to provide extra functionality. They should not, + however, forget to call base.getCreateParams() first to get the structure + filled up with the basic info. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Empty attributes array for optimization. + + + Hide default constructor. Allow to see it only inheritors. + + + + This is a base class for Disposable. It implements the IDisposable interface + as suggested in the .NET documentation using the Disposable pattern but it does not + implement a finalizer. If you need finalization you need to derive from Disposable + or add a finalizer to your derived class and manually call Dispose from the Finalizer. + + + + + Releases all resources used by the Component. + + + Releases all resources used by the Component. + + + + + Releases the unmanaged resources used by the Component and optionally releases the managed resources. + + to release both managed and unmanaged resources; to release only unmanaged resources. + See the documentation for the class and its Dispose member. + + + + This class provides a base class that implements the IDisposable interface + as suggested in the .NET documentation using the Disposable pattern. + + If you derive from this class, you only need to override the protected + Dispose method and check the disposing parameter. + + + + . + In C# and C++, finalizers are expressed using destructor syntax. + + + + + This is a base class for DisposableWithDisposedProp. It implements the IDisposable interface + as suggested in the .NET documentation using the Disposable pattern but it does not + implement a finalizer. If you need finalization you need to derive from Disposable + or add a finalizer to your derived class and manually call Dispose from the Finalizer. + + + + + Storage for IsDisposed property. True - object is disposed, + otherwise object is still alive and available for user use. + + + + + Releases all resources used by the Component. + + + Releases all resources used by the Component. + + + + + Releases the unmanaged resources used by the Component and optionally releases the managed resources. + + to release both managed and unmanaged resources; to release only unmanaged resources. + See the documentation for the class and its Dispose member. + + + + Allows to detect if object is disposed or not. True indicates object is disposed, + otherwise indicates object is still alive and ready for use. + + + + + This class provides a base class that implements the IDisposable interface + as suggested in the .NET documentation using the Disposable pattern. + + If you derive from this class, you only need to override the protected + Dispose method and check the disposing parameter. + + + + . + In C# and C++, finalizers are expressed using destructor syntax. + + + + + Specifies whether a property should be shown in the ToString result. + + + + + + Specifies that a property should be shown in the ToString result. + This field is Read-only. + + + + + Specifies that a property should not be shown in the ToString result. + This field is Read-only. + + + + + The default value for TracePropertyAttribute. (No) + + + + + Initializes a new instance of the class. + + + if a property should be shown in ToString result; otherwise. The default is . + + + + + + + Overridden. See . + + + + + + + + Indicates whether a property is shown in the ToString result. + + + + + Helper class for creating a string concatenating the string representation of all properties in an object. + + + The static method of this helper class will loop through any property + in a given object and check if the has been set. If it has + been set, the string representation of the property will be appended to the resulting string. + + + + + Indicates whether the has been set for the property. + + A . + True if property has a ; False otherwise. + + + + This method will loop through any property in a given object and append the + string representation of the property if the + has been set. + + + + + This is a base class for events of the Syncfusion libraries. It supports writing + properties in its ToString() method. + + + + + This method will loop through all properties in a derived class and append the + string representation of the property if the + has been set. + + + + + Provides data for a cancellable event. + + + + + Overloaded. Initializes a new instance of the SyncfusionCancelEventArgs class. + + + + + Initializes a new instance of the SyncfusionCancelEventArgs class with the Cancel property set to the given value. + + + + + + + + Provides data for an event that indicates success or failure. + + + + + Overloaded. Initializes a new instance of the SyncfusionSuccessEventArgs class with the Success property set to True. + + + + + Initializes a new instance of the SyncfusionSuccessEventArgs class with the Success property set to the given value. + + Indicates whether an operation was successful. + + + + Indicates whether an operation was successful. + + + + + Provides data for a event that can be handled by a subscriber and overrides the event's default behavior. + + + + + Overloaded. Initializes a new instance of the SyncfusionHandledEventArgs class with the Handled property set to False. + + + + + Initializes a new instance of the SyncfusionHandledEventArgs class with the Handled property set to the given value. + + + + + Indicates whether the event has been handled and no further processing of the event should happen. + + + + + Provides predefined switches for enabling / disabling trace + output or code instrumentation in the Syncfusion shared library. + + + + General switch for Shared Library. + + + Enable Tracing for the Styles. + + + Enable Tracing for the Shared Serialization. + + + Enable Tracing for the ScrollControl. + + + Enable Tracing for Timer Start and Stop + + + Enable Tracing for Timer Start and Stop. + + + Enable Tracing for BeginUpdate and EndUpdate methods calls + + + Enable Tracing for MouseController. + + + Enable Tracing for OperationFeedback. + + + Enable Tracing for BrushPaint drawing methods. + + + Enable Tracing for ArrowButtonBar events. + + + Enable Tracing for ButtonBar events. + + + Enable Tracing for RecordNavigationBar events. + + + Enable Tracing for RecordNavigationControl events. + + + Enable Tracing for SplitterControl events. + + + Enable Tracing for TabBar events. + + + Enable Tracing for TabBarSplitterControl events. + + + Enable Tracing for MouseControllerDispatcher events. + + + Enable Tracing for ScrollControl events. + + + Enable Tracing for Focus events. + + + + Returns the General Tracing level for the Grid Library. + + + + + Provides various diagnostic utilities for tracing methods, exception and more. + + + + + Writes a trace log with information about current class and method name and + string representations of any method arguments. + + An array of method arguments. + + + + Writes a trace log of the current stack. + + The number of method on the stack to trace. + + + + Writes a trace log for the given exception together with information where the exception was caught. + + An Exception. + + + + Insert this before a code block that should be measured. + + + + + Ends the code block that should be measured and increments the associated performance counter. + + + + + Prints all performance counters into a string and sorts it by ids. All counters will be reset afterwards. + + + + + Returns the time since Reset in microseconds. + + + + + MouseControllerDispatcher coordinates mouse events among competing mouse controllers. Based on + the position of the mouse and context of the control every registered controller's HitTest method + is called to determine the best controller for the following mouse action. This controller will then + receive mouse events. + + + Any Mouse Controller needs to implement the IMouseController interface. + In its implementation of MouseController.HitTest, the mouse controller should determine whether your + controller wants to handle the mouse events based current context. + MouseControllerDispatcher will call HitTest for each Mouse Controller that has been registered with + Add(IMouseController). The Mouse Controller that wins the vote will receive all Mouse hovering events + like MouseHoverEnter, MouseHover and MouseHoverLeave as long as its HitTest method indicates that it wants to + handle the mouse event. A MouseHoverLeave notification is guaranteed after MouseHoverEnter has been called. + When the user presses the mouse, a MouseDown will be sent to the controller. All subsequent mouse events + will then go to that specific controller until the user releases the mouse or the mouse operations is cancelled. + A call to either MouseUp or CancelMode is guaranteed after a controller MouseDown method was called. + Mouse controllers are registered by calling the Add method. + If the control that MouseControllerDispatcher should be associated with is derived from ScrollControl, + you should use ScrollControllMouseControllerDispatcher because it will automatically hook itself up + with mouse events from ScrollControl. + Otherwise if you want to attach MouseControllerDispatcher to a different type of Control, you need to + delegate mouse events to MouseControllerDispatcher. MouseControllerDispatcher provides ProcessXYZ methods + for every mouse event that should be forwarded. Simply call these methods from your mouse event handlers in + your control. + + + + + Initializes a new MouseControllerDispatcher object and associates it with the parent control. + + + + + + Resets the dispatcher and calls Dispose for any registered mouse controller and unregisters all mouse controllers. + + + + + + Registers a mouse controller. + + + + + + Removes a mouse controller. + + + + + + Indicates whether a mouse controller has previously been registered. + + + + + + + Search a mouse controller by comparing with the name returned from IMouseController.Name. + + + + + + + Changes the active controller and raises an ActiveControllerChanged event. + + + + + + Sets the controller that will receive mouse hovering messages. If the controller is changed, + MouseHoverLeave and MouseHoverEnter calls are made. + + + + + + + Raises the event. + + A that contains the event data. + + + + HitTest loops through all controllers and calls HitTest on each of them. Only one mouse controller + can get voted to receive mouse messages. + + + HitTest loops through all controllers and call HitTest on each of them. Only one mouse controller + can get voted to receive mouse messages. + + The point in client coordinates to be hit tested. + The result identifying the hit-test context. + + The current result of the vote gets passed to the next mouse controller. If a controller wants + to handle mouse events, it can decide based on the existing vote if it has higher priority for it + to handle mouse messages than the existing vote. + + + + + HitTest loops through all controllers and call HitTest on each of them. Only one mouse controller + can get voted to receive mouse messages. + + The point in client coordinates to be hit tested. + The mouse button that is pressed. + The result identifying the hit-test context. + + + + + HitTest loops through all controllers and call HitTest on each of them. Only one mouse controller + can get voted to receive mouse messages. + + The point in client coordinates to be hit tested. + The mouse button that is pressed. + A placeholder where a reference to the winning + is returned. + The result identifying the hit-test context. + + + + + HitTest loops through all controllers and call HitTest on each of them. Only one mouse controller + can get voted to receive mouse messages. + + The point in client coordinates to be hit tested. + The mouse button that is pressed. + 1 for single-click; 2 for double click. + A placeholder where a reference to the winning + is returned. + The result identifying the hit-test context. + + + + + Call this method from your control's MouseMove handler. + + + + + + Call this method from your control MouseDown handler. + + + + + + Call this method from your control's MouseUp handler. + + + + + + Call this method from your control's CancelMode handler. + + + + + + + + Resets support for mouse tracking. + + Call this method after a user interaction that should switch the control back into + normal mouse behavior. For example, when the control gets the focus or when the user clicks a scrollbar. + + + + + Raises the event. + + A that contains the event data. + + + + Indicates that the active controller has changed. + + + Active controller is the controller that is receiving MouseDown, MouseMove and MouseUp messages when the user + has pressed a mouse button. + + + + Returns a reference to the active mouse controller that is receiving MouseDown, MouseMove and MouseUp messages when the user + has pressed a mouse button. + + + + + Returns the controller that currently receives mouse hovering messages. + + + + + Returns the last HitTest value returned that was non-zero. Check this property + if you need to make decision on your mouse controller's HitTest. + + + + + Property AllowDoubleClickTimer (bool). + + + + + Returns the cursor to be displayed. + + + + + Returns a reference to the associated control. + + + + + Enables support for mouse tracking. + + + Specify the bounds where the mouse tracking should start. As soon as the user moves the mouse + over the specified region, MouseControllerDispatcher will simulate a mouse down event. When the user presses + any mouse button MouseControllerDispatcher will simulate a mouse up and resets the mouse tracking mode. After + the initial click on a mouse button, mouse processing will work as usual. + Mouse tracking lets you easily simulate the behavior of windows combo boxes. + + + + + Indicates that the value of the TrackMouse property has changed. + + + + + ScrollControllMouseControllerDispatcher is a specialized version of MouseControllerDispatcher + that automatically wires itself up with a ScrollControl. + + + If the control that MouseControllerDispatcher should be associated with is derived from ScrollControl, + you should use ScrollControllMouseControllerDispatcher because it will automatically hook itself up + with mouse events from ScrollControl. + No initialization is necessary. + You can register MouseControllers with: + + resizeCellsController = new GridResizeCellsMouseController(this); + MouseControllerDispatcher.Add(resizeCellsController); + + See ScrollControl.MouseControllerDispatcher property. + + + + + Initializes a object and associates it with a . + + The this object is associated with. + + + + + + + Provides data for a cancelable mouse event. + + + + + Initializes a new with data from a . + + The data for this event. + + + + + + + The data for this event. + + + + + Handles a cancelable mouse event. + + + + + ICancelModeProvider provides an interface for the CancelMode event. + + + + + Occurs when the window receives a WM_CANCELMODE message. + + + WM_CANCELMODE is sent to cancel certain modes, such as mouse capture. + For example, the system sends this message to the active window when a + dialog box or message box is displayed. Certain functions also send this + message explicitly to the specified window regardless of whether it is the + active window. For example, the EnableWindow function sends this message + when disabling the specified window. + + + + + Specifies the expected effect of the change in property of an object / Control. + + + Used by the class. + + + + + The Control needs a repaint due to change in property's value. + + + + + The Control needs to be laid out due to change in a property's value. + + + + + No effect when there is change in a property's value. + + + + + Provides data for the delegate. + + + + + Creates an instance of the SyncfusionPropertyChangedEventArgs class. + + A PropertyChangeEffect value. + The name of the property. + The old value cast into an object. + The new value cast into an object. + + + + Gets / sets the of this change in property value. + + The . + + + + The old value of the property before it changes. + + + The object representing the old value. This can be cast to + the type of the property. + + + + + The new value of the property after it changes. + + + The object representing the new value. This can be cast to + the type of the property. + + + + + Represents the method that will handle the PropertyChanged event of + certain classes. + + The source of the event. + A object that + contains the event data. + + + + A class implements this interface to let it be known that it provides + a event. + + + The class makes use of this interface when the items + in its list implement it. The listens to this event and + forwards the event args using its own event. + + + + + Occurs when one of the object's property changes. + + + This event provides a generic way of notifying changes + in an object's property, along with the old value, new value + and the PropertyChangeEffect. + + + + + Used internally to expose the DesignMode property of certain component-derived + classes. + + + + + Indicates whether the component is in design-mode. + + + + + IMouseController defines the interface for mouse controllers to be used with MouseControllerDispatcher. + + + Any mouse controller needs to implement the IMouseController interface. + In its implementation of MouseController.HitTest, the mouse controller should determine whether your + controller wants to handle the mouse events based current context. + See MouseControllerDispatcher for further discussion. + + + + + MouseHoverEnter is called when this controller signaled in HitTest that it wants to handle mouse events. MouseHoverEnter + is called before the MouseHover is called for the first time. + + + + + MouseHover is called when this controller signaled in HitTest that it wants to handle mouse events. MouseHover + is called after MouseHoverEnter. + + + + + MouseHoverLeave is called when hovering ends either because user dragged mouse out of the hit-test area or + when context changes (e.g. user pressed the mouse button). + + + + + MouseDown is called when this controller signaled in HitTest that it wants to handle mouse events and the + user pressed the mouse button. + + + MouseDown is called and this controller will become the active controller and receive all subsequent mouse messages + until the mouse button is released or the mouse operation is cancelled. + + + + + + MouseMove is called for the active controller after a MouseDown message when the user moves the mouse pointer. + + + + + + MouseUp is called for the active controller after a MouseDown message when the user releases the mouse button. + + + + + + CancelMode is called for the active controller after a MouseDown message when the mouse operation is cancelled. + + + + + HitTest is called to determine whether your controller wants to handle the mouse events based current context. + + + The current winner of the vote is specified through the controller parameter. Your implementation of HitTest + can decide if it wants to override the existing vote or leave it. + + + + + + + + Returns the name of this mouse controller. + + + + + Returns the cursor to be displayed. + + + + + Defines an interface for classes that support a BeginUpdate / EndUpdate pattern. + + + + + Suspends updating the component. An internal counter will be increased if called multiple times. + + + + + Resumes updating the component. If was called multiple times, an internal counter is decreased. + + + + + Indicates whether was called. + + + + + Creates a new instance of the context menu object managed by this provider. + + + If the provider contains a previously initialized context menu, then the existing menu will be disposed + before creating the new menu. + + + + + Gets the Menu items count. + + + + + + Indicates whether "Add or Remove buttons" is needed. + + + + + + Sets the visual style for the context menu. + + A value. + + + + Creates a new top-level menu item. + + A value representing the menu item. + The that will handle the menu item Click event. + + + + Creates a new menu item and adds it to the specified parent menu item. + + A value representing the parent menu item. + A value representing the menu item. + The that will handle the menu item Click event. + + + + Sets the menu item image. + + A value representing the menu item. + The containing the image. + The zero-based image index. + + + + Sets a shortcut key for the menu item. + + A value representing the menu item. + The key for the menu item. + + + + Returns the menu item's shortcut key. + + A value representing the menu item. + A key value. + + + + Sets the menu item's Checked property to the specified value. + + A value representing the menu item. + The boolean value to be set. + + + + Gets the menu item's Checked property. + + A value representing the menu item. + A boolean value. + + + + Sets the menu item's Enabled property to the specified value. + + A value representing the menu item. + The boolean value to be set. + + + + Indicates the state of the menu item's Enabled property. + + A value representing the menu item. + A boolean value. + + + + Inserts or removes a separator before the specified menu item's position. + + A value representing the menu item. + True to insert a new separator; False to remove an existing separator. + + + + Removes the specified context menu item. + + A value representing the menu item. + + + + Displays the context menu at the specified position. + + A object that specifies the control with which this context menu is associated. + A object that specifies the coordinates at which to display the menu. + + + + Disposes the context menu associated with this provider. + + + + + Clears all menu items. + + + + + Occurs when menu is popped up. + + + + + Occurs when menu is collapsed. + + + + + Creates an instance of the class. + + A instance representing the menu provider. + A value representing the context menu item. + + + + Returns the menu provider instance. + + A instance. + + + + Returns the text representing the context menu item. + + A value. + + + + + + + Workaround for incident 35141. When calling Timer.Stop in GridGroupDropArea + this ends up calling MdiSysMenuProvider.MsgHook + + + + + Provides some utility methods regarding the runtime. + + + + + Returns the major runtime version. + + + + + Returns the minor runtime version. + + + + + This class will provide more information that the .Net equivalent ignored. + + + + + Indicates whether menu access keys are always underlined. + + + + + Indicates whether the current application is a .Net application. + + True if .Net; false otherwise. + + By default, this method will automatically determine whether or not the current active + app is a .Net app or a native app. However, to speed up performance (by a fraction of a second), + you can set this value appropriately at the beginning of your app. Note that + an incorrect setting would cause unforeseen behavior. + + + + + Indicates whether the component is used inside developer studio. + + + + + Sets the advanced graphics mode. + + Handler to device context. + New graphics mode. + If the function succeeds, the return value is the old graphics + mode. If the function fails, the return value is zero. + + + + Changes the world transformation for a device context using + the specified mode. + + Handler to device context. + Transformation data. + Modification mode. + If the function succeeds, the return value is nonzero. + If the function fails, the return value is zero. + + + + Sets a two-dimensional linear transformation between world space and + page space for the specified device context. + + Handler to the device context. + Pointer to an XFORM structure that contains the transformation data. + TRUE if success; false otherwise. + + + + For the scroll bar itself, indicates the specified vertical or horizontal scroll bar does not exist. + For the page up or page down regions, indicates the thumb is positioned such that the region does not exist. + + + + + For the scroll bar itself, indicates the window is sized such that the specified vertical or horizontal scroll bar is not currently displayed. + + + + + The arrow button or page region is pressed. + + + + + The component is disabled. + + + + + Computes the string size that should be passed to a typical Win32 call. + This will be the character count under NT and the ubyte count for Win95. + + + The string whose size to compute. + + + The count of characters or bytes, depending on what the pinvoke + all wants + + + + + Native Matrix Object. + + + + + The NativeMethodsHelper class is a wrapper over some Interop calls that are exposed using static methods + in this class. + + + + + Keeps track of the number of times Suspend and Resume redraw window is called for a particular window. + + + + + Sends the WM_SETREDRAW to the handle of the Control to prevent drawing of the control. + + The handle of the control that is to be suspended. + + + + Resumes redrawing of the window. + + + + + Resumes redrawing of the window. + + + + + + + Sends the WM_SETREDRAW message to a window to allow changes in that window to be redrawn + or to prevent changes in that window from being redrawn. + + Handle to the native window. + Indicates the redraw state. + If this parameter is true, the content can be redrawn after a change. + If this parameter is false, the content cannot be redrawn after a change. + Forces redraw of the window using . + Works only if bRedraw is true. + + + + Overload of + Forcefully redraws window if redraw is enabled. + + + + Subclass window that allowing attaching of + message filters classes into Message processing. + + + Value that represent invalid window handle. + + + Reference on message filter instance. + + + Default constructor that subclass window by it handle automatically. + Window Handle. + + + Override of WndProc function. + Reference on message processed by Window. + + + Gets and Sets reference on message filter instance. + + + + A structure that represents a location in the registry. + + + This is a simple structure that refers to a Registry location + through the root RegistryKey and the subkey. + + + + + Creates a new instance of the RegistryEntry class and + initializes it with the root RegistryKey and subkey. + + The root RegistryKey. + The subkey string. + + + + Gets / sets the root RegistryKey. + + A RegistryKey value. + + + + Gets /sets the subkey under the root RegistryKey. + + A string value representing the subkey. + + + + SR provides localized access to string resources specific + from the assembly manifest Syncfusion.Windows.Forms.Localization.SR.resources + + + + + Specifies the category in which the property or event will be displayed in a visual designer. + + + This is a localized version of CategoryAttribute. The localized string will be loaded from the + assembly manifest Syncfusion.Windows.Forms.Localization.SR.resources + + + + + Specifies a description for a property or event. + + + This is a localized version of DescriptionAttribute. The localized string will be loaded from the + assembly manifest Syncfusion.Windows.Forms.Localization.SR.resources + + + + + Defines a interface. + + + + + Provides static methods and properties to localize the UI. + + + + + ResourceIdentifiers contains resource Ids specific to the Syncfusion.Shared.Base assembly. + + + + + + + Base class for scrollers control that support visual styles. + + + + + + Key for LargeChangeChanged event. + + + Key for MaximumChanged event. + + + Key for MinimumChanged event. + + + Key for SmallChangeChanged event. + + + Key for ValueChanged event. + + + Key for VisualStyleChanged event. + + + Key for ColorSchemeChanged event. + + + Key for ThemeEnabledChanged event. + + + + Used by threading timer. + + + + + A value to be added to or subtracted from the System.Windows.Forms.ScrollBar.Value + property when the scroll box is moved a large distance. + + + + + Cached m_largeChange + + + + + The upper limit of values of the scrollable range. + + + + + The lower limit of values of the scrollable range. + + + + + A value to be added to or subtracted from the Syncfusion.Windows.Forms.ScrollBarCustomDraw.Value + property when the scroll box is moved a small distance. + + + + + A numeric value that represents the current position of the + scroll box on the scroll bar control. + + + + + Visual style of the ScrollBarCustomDraw. + + + + + Indicates whether to use visual styles. + + + + + Indicates whether thumb is disabled. + + + + + Indicates whether minimum arrow is disabled. + + + + + Indicates whether maximum arrow is disabled. + + + + + Collection of controls that locates above the minimum arrow. + + + + + Collection of controls that locates under the maximum arrow. + + + + + True - say control to keep System settings instead of user defined, otherwise False. + + + + + Renderer which draws the control. + + + + + Array of rectangles that represents regions of the ScrollBarCustomDraw. + + + + + Used when user holds the arrow button clicked. + + + + + Position where was last click. + + + + + Zone where was last click . + + + + + Zone where mouse is over. + + + + + Cached m_selectedZone. + + + + + Zone where is mouse position. + + + + + False if all states is default? in other case value is false. + + + + + Color scheme that used in Rendering. + + + + + Color scheme that used in Rendering. + + + + + Color scheme for Office2016 that used in Rendering. + + + + + Color scheme for Office2010 that used in Rendering. + + + + + Instance of ContextMenu provider. + + + + + To avoid compile error CS0197 in VS2002. + + + + + Indicates whether scrollbar should be refreshed on each value change. + If set to false, scrollbar is invalidated only and therefore is visually refreshed after processing all scrolling messages. + + + + + Scroll bar's owner. + + + + + Metro color table for metro visual style. + + + + + Office2016 black color table for Office2016 visual style. + + + + + Office2016 white color table for Office2016 visual style. + + + + + Office2016 darkgray color table for Office2016 visual style. + + + + + Office2016 colorful color table for Office2016 visual style. + + + + + Apply Office2016Black color settings for scrollbar. + + + + + Apply Office2016DarkGray color settings for scrollbar. + + + + + Apply Office2016White color settings for scrollbar. + + + + + Apply Office2016Colorful color settings for scrollbar. + + + + + Initializes a new instance of the class. + + The owner. + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + + + + + + + + + + + + Override. Force recalculation of Scroller elements. + Layout arguments. + + + + Forces the laying out of combobox elements. + + + Advanced method. You do not have to call this directly. + + + + If outside code will work with collection instead + of our collections and , + then this method will help us in synchronization. + + + + If outside code will work with collection instead + of our collections and , + then this method will help us in synchronization. + + + + + Overridden. See . + + + + + + Occurs when control size changed. + + The event data. + + + + Reset control Width or Heigh to system settings + + + + + Raises the OnLargeChangeChanged event. + + The event data. + + + + Raises the OnSmallChangeChanged event. + + The event data. + + + + Raises the OnMaximumChanged event. + + The event data. + + + + Raises the OnMinimumChanged event. + + The event data. + + + + Raises the OnVisualStyleChanged event. + + The event data. + + + + Raises the OnMinimumChanged event. + + The event data. + + + + Raises the OnValueChanged event. + + The event data. + + + + Used for validating visibility of the ControlsAfter and ControlsBefore + + + + + + Overridden. See . + + + + + + Redraws scroll control when RightToLeft is changed. + + + + + + Overridden. See . + + + + + + Overridden. See . + + + + + + Overridden. See . + + + + + + Overridden. See . + + + + + + Occurs when mouse down and cursor change position. + + + + + + + Gets min button. Possible variants: Left or Down. + + + + + + Gets max button. Possible variants: Right or Up. + + + + + + Defines pressed zone. + + + + + + + + Recalculates bounds of the ScrollBarCustomDraw. + + + + + Recalculates bounds of the arrow buttons. + + + + + Recalculates bounds of the thumb. + + + + + If scroll contain all controls than controls is visible, in other case value is false. + + + + + + Gets DockStyle of afterControls. + + + + + + Gets DockStyle of beforeControls. + + + + + + used for calculates thumb offset. + + + + + + + + + + + + + + + + + + Utility API that open to user opportunity to destroy handle in runtime. + Very usefull for runtime resource cleanup. + + + + + Sets small change if value is less than large change; otherwise sets small change to large change. + + Value to set. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Method accumulate width and height of the controls in + specified collection. + + Method accumulate width and height of the controls in + specified collection. + collection of controls. + Accumulated values. + + + + Excludes/includes controls in collection. + + If true - excludes, else includes controls in collection. + + + + + + + + X coordinate of mouse. + Y coordinate of mouse. + + + + Sets value, but OnValueChanged don't raise. + + + + + + Dispose controls of ScrollBarCustomDraw. + + Collection of controls to be disposed. + + + + Used to raise the mouse event + + The args contains the MouseEventArgs data + + + + Used to raise the mouse event + + The args contains the MouseEventArgs data + + + + Used to raise the mouse event + + The args contains the MouseEventArgs data + + + + Gets or sets a value to be added to or subtracted from the System.Windows.Forms.ScrollBar.Value + property when the scroll box is moved a large distance. + + + + + Gets or sets the upper limit of values of the scrollable range. + + + + + Gets or sets the lower limit of values of the scrollable range. + + + + + Gets or sets a value to be added to or subtracted from the Syncfusion.Windows.Forms.ScrollBarCustomDraw.Value + property when the scroll box is moved a small distance. + + + + + Gets or sets a numeric value that represents the current position of the + scroll box on the scroll bar control. + + + + + Gets or sets the text associated with this control. + + + + + Visual style of the ScrollBarCustomDraw. + + + + + Gets or sets a value that indicates whether to use visual styles. + + + + + Gets or sets a value that indicates whether thumb is disabled. + + + + + Gets or sets a value that indicates whether minimum arrow is disabled. + + + + + Gets or sets a value that indicates whether maximum arrow is disabled. + + + + + Collection of controls that locates above the minimum arrow. + + + + + Collection of controls that locates under the maximum arrow. + + + + + True - say control to keep System settings instead of user defined, otherwise False. + + + + + Gets or sets the renderer which draws the control. + + + + + Returns the value that indicates whether RightToLeft is RightToLeft.Yes + + + + + Hide Controls collection from CodeDom serialization. + + + + + Gets or sets the metro color table. + + + + + Gets or sets the color table for Office2016 Black theme scrollbar. + + + + + Gets or sets the color table for Office2016 white theme scrollbar. + + + + + Gets or sets the color table for Office2016 dark gray theme scrollbar. + + + + + Gets or sets the color table for Office2016 colorful theme scrollbar. + + + + + Gets or sets whether the Office color scheme should be Silver or Blue or Black. + + + + + Gets or sets whether the Metro color scheme should be user defined color. + + + + + Gets or sets whether the Office2010 color scheme should be Silver or Blue or Black. + + + + + Gets or sets whether the Office2016 color scheme should be Black or White or DarkGray or Colorful. + + + This is applicable for both the horizontal and vertical scrollbar. + + + + + Gets / sets the menu provider object that will implement the 's contextmenu. + + + The ScrollBarCustomDraw control automatically initializes this property depending on the presence + of the Syncfusion Essential Tools library. If Essential Tools is available, then the menu provider + object will be an instance of the + type. If not, the class is used for + implementing the standard .NET context menu.

The ScrollersFrame's automatic initialization + should suffice for most applications and you should explicitly set this property only when you + want to override the default menu provider assignment.

 + A implementation; the default + is . + + + + Gets or sets value indicating whether scrollbar should be refreshed on each value change. + If set to false, scrollbar is invalidated only and therefore is visually refreshed after processing all scrolling messages. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Flag, if true than controls visivble in other case not visible. + + + + + Default size of the horizontal scroolbar. + + + + + Initializes a new instance of the class. + + The owner. + + + + Initializes a new instance of the class. + + + + + Occurs when control size changed. + + + + + + Used for validating visibility of the ControlsAfter and ControlsBefore + + + TODO: place correct comment here + + + + + Reset horizontal scrollbar to default height. + + + + + Gets dockStyle for controls which situated before scroll. + + + + + + Gets dockStyle for controls which situated after scroll. + + + + + + Gets value by cursor position + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Calculates bounds of thumb for scroll control. + + + + + Calculating bounds for leftThumb and rightThumb zones for scroll. + + + + + + + + + + + + + + + + + + + + + + + + + + Provides a property that lets you toggle support for Intelli-Mouse panning. + + + + + Toggles support for Intelli-Mouse panning. When the user presses the middle mouse button and drags the mouse, + the window will scroll. + + + The latest Intelli-Mouse drivers have also built-in . + + + + Implements support for Intelli-Mouse panning. When the user presses the middle mouse button and drags the mouse, + the window will scroll. has built-in support for this call. You only have + to enable . + + + + + Initializes the object. + + The control to add this functionality to. + + + + Initializes the object. + + The control to add this functionality to. + True if should listen for MouseDown event; + False if dragging should be started manually by calling StartDrag. + + + + + + + Starts the IntelliMouse dragging at the given screen coordinates. + + Screen coordinates, e.g. Control.MousePosition. + + + + Stops the Intelli-Mouse dragging. + + + + + Returns the bitmap from manifest. Red background in bitmap will be made transparent. + + + + + + + Occurs when the user has dragged the mouse outside the scrolling bitmap. + + + + + Returns the active object, if any. + + + + + Gets / sets the scrolling direction. + + + + + Indicates whether the user is dragging. + + + + + Indicates whether to toggle the Intelli-Mouse feature on or off. + + + + + Returns the cursor to be displayed. + + + + + Parent control supporting Drag operation. + + + + + Indicates whether shift value is calculated. + + + + + + + + Handles the WM_SETCURSOR message. + + + + + + + + + + + + Gets / sets the parent control supporting drag operation. + + + + + Interface for implementing by parent control supporting Drag operation. + Methods of this interface invoke corresponding drag methods of parent control. + + + + + Handles the DragScroll event of an IntelliMouseDragScroll object. + + + + + Provides data for the DragScroll event of an IntelliMouseDragScroll object. + + + + + Initializes a new instance of the IntelliMouseDragScrollEventArgs class. + + The distance in pixels the mouse pointer has been moved horizontally. + The distance in pixels the mouse pointer has been moved vertically. + + + + Gets / sets the distance in pixels the mouse pointer has been moved horizontally. + + + + + Gets / sets the distance in pixels the mouse pointer has been moved vertically. + + + + + Set this to True if you scrolled and do not want default scrolling behavior. + + + + + Implement this interface if you want to add support for shared scrollbars. + + + + + Returns a scrollbar object that implements a horizontal scrollbar. + + + + + Returns a scrollbar object that implements a vertical scrollbar. + + + + + Indicates whether the specified control is activated. + + + + + Handles the MouseWheelZoom events. + + + + + Provides data for the MouseWheelZoom event. + + + + + Initializes a with a given delta. + + The number of rows or columns to scroll. + + + + Returns the number of rows or columns to scroll. + + + + + Handles the NcPaint event of an ScrollControl object. + + + + + Provides data for the NCPaint event of an ScrollControl object. + + + + + Initializes a new instance of the NCPaintEventArgs class. + + + + + + + + + + + + + + + + Bounds an ScrollControl. + + + + + Bounds of an ScrollControl in screen coordinates. + + + + + Clipping region of an ScrollControl. + + + + + Gets or sets bounds an ScrollControl. + + + + + Gets or sets bounds of an ScrollControl in screen coordinates. + + + + + Gets or sets clipping region of an ScrollControl. + + + + + + + + + + + True if scroll bar is currently in thumb drag mode. + + + + + Indicates whether the associated control should scroll while the user is dragging a scrollbar thumb. + + + + + Indicates whether the parent control should show ScrollTips while the user is dragging a scrollbar thumb. + + + Checks this property to determine if ScrollTips should be displayed. + + + + + Gets / sets a value to be added to or subtracted from to the Value property when the scroll box is moved a large distance. + + + + + Gets / sets the upper limit of values of the scrollable range. + + + + + Gets / sets the lower limit of values of the scrollable range. + + + + + Gets / sets a value to be added to or subtracted from to the Value property when the scroll box is moved a small distance. + + + + + Gets / sets a numeric value that represents the current position of the scroll box on the scroll bar control. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Indicates whether scroll is vertical or horizontal + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Indicates whether scrollBar is vertical or horizontal. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Draws arrow button of scroll. If theme is disabled than draw classic scroll. + + + + + + + + + Draws background of scroll. If theme is disabled than draw classic scroll. + + + + + + + + Draws thumb for scroll. If theme is disabled than draw classic scroll. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Right office arrow. + + + + + + Left office arrow. + + + + + + Down office arrow. + + + + + + Up office arrow. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Retrieves color table according to style and scheme. + + Office2007 style. + Office2007 color scheme. + Color table. + + + + Registers color table within internal collection. + + Office2007 style. + Office2007 scheme. + Color table itself. + + + + + + + + + + + + + + + + Applies colors for managed scheme. + + Container form. + Base color for the managed theme. + + + + + + + + + + + + + + + + + + Registered color tables. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Interface to create an Office 2010 color table. + + + + + Color table for Office 2010 like scroll bars. + + + + + + Constructor for Office2010 color table which is used to register the color style of each theme. + + + + + Used internally + + + + Get the Alpha blended color. + Source color + destination color + alpha color + returns the alpha blended color + + + + Retrieves color table according to style and scheme. + + Office2010 style. + Office2010 color scheme. + Color table. + + + + Registers color table within internal collection. + + Office2010 style. + Office2010 scheme. + Color table itself. + + + + Updates the styles of the scrollbars related to Office2010 colors. + + base color. + + + + Updates the Office2010 scrollbar color schemes. + + Custom scrollbar draw style. + Office2010 color scheme. + + + + Applies colors for managed scheme. + + Custom scrollbar draw style. + Base color for the managed theme. + + + + Applies scheme for managed theme. + + Container form. + Custom scrollbar draw style. + Office2010 color scheme. + + + + Applies managed colors + + + + + Initialize scroll bar color fields. + + Scroll bar color references. + + + + Office 2010 color array. + + + + + Registered color tables. + + + + + Interface to create a Office2010 color table. + + returns office2010 color table + + + + Specifies the ScrollerGradientBegin color of the Office2010 scroll bars + + + + + Specifies the ScrollerGradientEnd color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonGradientBegin color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonGradientEnd color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonGradientSelectedBegin color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonGradientSelectedEnd color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonGradientPressedBegin color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonGradientPressedEnd color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonBorderDark color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonBorderLight color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonBorderSelectedDark color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonBorderSelectedLight color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonBorderPressedDark color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonBorderPressedLight color of the Office2010 scroll bars + + + + + Specifies the ArrowGradientBegin color of the Office2010 scroll bars + + + + + Specifies the ArrowGradientEnd color of the Office2010 scroll bars + + + + + Specifies the ArrowGradientNormalBegin color of the Office2010 scroll bars + + + + + Specifies the ArrowGradientNormalEnd color of the Office2010 scroll bars + + + + + Specifies the ThumbLinesGradientBegin color of the Office2010 scroll bars + + + + + Specifies the ThumbLinesGradientEnd color of the Office2010 scroll bars + + + + + Specifies the ThumbPressedBackgroundGradientBegin color of the Office2010 scroll bars + + + + + Specifies the ThumbPressedBackgroundGradientEnd color of the Office2010 scroll bars + + + + + Specifies the ScrollerBorderBegin color of the Office2010 scroll bars + + + + + Specifies the ScrollerBorderEnd color of the Office2010 scroll bars + + + + + Specifies the ScrollerGripDark color of the Office2010 scroll bars + + + + + Specifies the ScrollerGripLight color of the Office2010 scroll bars + + + + + Specifies the ScrollerGripBackGround color of the Office2010 scroll bars + + + + + Specifies the color of the Office2010 scroll bars + + + + + Color references for Office2010. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Constructor for color Table key. + + Custom scrollbar draw style. + Office2010 color scheme. + + + + Compare the color table keys through . + + Object of the ColorTableKey. + Returns 1 if color key is less. Otherwise returns 0. + + + + Compares the color table keys. + + A color table key. + returns true if passed one is less. Otherwise return false + + + + Provides attributes and methods for Office2010 blue color table. + + + + + Used internally + + + + + Interface to create an office2010 blue color table. + + returns office2010 blue color table. + + + + Provides attributes and methods for Office2010 Silver color table. + + + + + Used internally + + + + + Initialize scroll bar color fields for silver color. + + Scroll bar color references. + + + + Interface to create an office2010 Silver color table. + + returns office2010 silver color table + + + + Provides attributes and methods for Office2010 Black color table. + + + + + Used internally + + + + + Initialize scroll bar color fields for black color. + + Scroll bar color references. + + + + Interface to create an office2010 Black color table. + + returns Office2010 black color table + + + + The metro renderer for scrollbar + + + + + Initializes a new instance of the class. + + The parent control + + + + Initializes a new instance of the class. + + The parent control. + The metro color table. + + + + Draws background of scroll. If theme is disabled than draw classic scroll. + + The graphics. + The bounds of background. + The scroll button state. + + + + Draws pushed background. + + The graphics. + The bounds of background. + + + + Draws scroll background. + + The graphics. + The scroll bounds. + + + + Draws scroll thumb. If theme is disabled than draw classic scroll. + + + + + + + + Draws scroll thumb background. + + The graphics. + The bounds of thumb. + The scroll button state. + + + + Draws arrow button of scroll. If theme is disabled than draw classic scroll. + + The graphics. + The bounds of arrow. + The scroll button type. + The scroll button state. + + + + Draws arrow background. + + The graphics. + The arrow backgroud bounds. + The scroll button type. + The scroll button state. + + + + Draws scrollbar arrow + + The graphics. + The bounds of the arrow. + The scroll button type. + The scroll button state. + + + + Returns the pushed or checked state right arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the pushed or checked state right arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the pushed or checked state left arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the pushed or checked state left arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the pushed or checked state down arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the pushed or checked state down arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the pushed or checked state up arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the pushed or checked state up arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the normal right arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the normal left arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the normal down arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the normal up arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Indicates whether scrollBar style is EnableOffice2013Style + + + + + Metro color table. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the scroll bar background color. + + + + + Gets or sets the normal state thumb color. + + + + + Gets or sets the checked state thumb color. + + + + + Gets or sets the pushed state thumb color. + + + + + Gets or sets the Thumb Normal Border color + + + + + Gets or sets the Thumb Checked Border color + + + + + Gets or sets the pushed state Thumb Pushed Border. + + + + + Gets or sets the pushed state Thumb Pushed Border. + + + + + Gets or sets the Arrow Normal Border color + + + + + Gets or sets the Arrow Checked Border color + + + + + Gets or sets the Arrow Pushed Border color + + + + + Gets or sets the inactive state thumb color. + + + + + Gets or sets the normal state arrow color. + + + + + Gets or sets the checked state arrow color. + + + + + Gets or sets the pushed state arrow color. + + + + + Gets or sets the normal state Arrow Background Color. + + + + + Gets or sets the pushed state Arrow Pushed Background color. + + + + + Gets or sets the inactive state arrow color. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initialize new instance of Office2007Renderer + + + + + + + Draws arrow button of scroll. If theme is disabled than draw classic scroll. + + + + + + + + + Draws background of scroll. If theme is disabled than draw classic scroll. + + + + + + + + Draws thumb for scroll. If theme is disabled than draw classic scroll. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Right office arrow. + + + + + + Left office arrow. + + + + + + Down office arrow. + + + + + + Up office arrow. + + + + + + Right Normal office arrow. + + + + + + Left Normal office arrow. + + + + + + Down Normal office arrow. + + + + + + Up Normal office arrow. + + + + + + Vertical thumb lines. + + + + Horizontal thumb lines. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Provides renderer for Office2010 theme. + + + + Scroll Bar min thumb length for lines. + + + + + Scroll thumb line length. + + + + + Office2010 color table. + + + + + Blended background color. + + + + + Blended background black color. + + + + + Blended arrow button. + + + + + Blended selected arrow button. + + + + + Blended arrow button silver and black selected colors. + + + + + Blend for thumb background. + + + + + Bitmap for scroll images + + + + + Constructor for Office2010 renderers. + + + + + Initialize new instance of Office2010Renderer + + custom scrollbar. + Color Table. + + + + Draws arrow button of scroll. If theme is disabled than draw classic scroll. + + graphics for arrow buttons. + Arrow bounds. + type of the scroll button. + Scroll button state. + + + + Draws background of scroll. If theme is disabled than draw classic scroll. + + graphics for arrow buttons background. + arrow button background bounds + Button state. + + + + Draws thumb for scroll. If theme is disabled than draw classic scroll. + + graphics for scroll thumb. + scroll thimb bounds. + Button state. + + + Draw scroll bar background. + graphics for scroll bar backgrounds. + scroll background bounds. + + + Draw pushed scroll background. + Graphics for pushed scroll background + Scroll bounds. + + + Draw scroll bar arrow background. + Graphics for Arrow background. + Arrow bounds. + type of the scroll button. + Button state. + + + Draw scroll thumb background. + Graphics for thumb background. + Scroll thumb bounds. + Button state. + + + Draw scroll arrow. + Graphics for scroll arrow. + Arrow bounds. + type of scroll button. + Button state. + + + Draw scroll lines + Graphics. + Scroll bounds. + true if the scroll bar is vertical scrollbar. + + + + Get the horizontal scroll background brush. + + ScrollBar width. + scroll begin color. + scroll bar end color. + Returns the gradient brush. + + + + Get the Vertical scroll background brush. + + ScrollBar height. + scroll begin color. + scroll bar end color. + Returns the gradient brush. + + + + gets the vertical scroll brush. + + bounds. + Gradient top color. + Gradient bottom color. + Returns the Linear gradient brush. + + + + gets the vertical scroll brush. + + top of the scroll bar rectangle + Height of the scroll bar rectangle + Gradient top color. + Gradient bottom color. + Returns the Linear gradient brush. + + + + gets the horizontal scroll brush. + + bounds. + Gradient top color. + Gradient bottom color. + the Linear gradient brush. + + + + gets the rounded polygon. + + Bounds. + Radius of the polygon. + the edge points. + + + Right office arrow. + the bitmap. + Arrow width. + Arrow height. + + + Left office arrow. + the bitmap. + Arrow width. + Arrow height. + + + Down office arrow. + the bitmap. + Arrow width. + Arrow height. + + + Up office arrow. + the bitmap. + Arrow width. + Arrow height. + + + Right Normal office arrow. + the bitmap. + Arrow width. + Arrow height. + + + Left Normal office arrow. + the bitmap. + Arrow width. + Arrow height. + + + Down Normal office arrow. + the bitmap. + Arrow width. + Arrow height. + + + Up Normal office arrow. + the bitmap. + Arrow width. + Arrow height. + + + Vertical thumb lines. + the bitmap of the scroll thumb. + + + Horizontal thumb lines. + the horizontal thumb lines' Bitmap. + + + + Enumeration for scroll bar fields. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + WindowsXP Blue Style renderer implementation. + + + + + + + Angle for horizontal gradient brush. + + + + + Angle for vertical gradient brush. + + + + + Angle for vertical gradient brush. + + + + + Width for brush. + + + + + Height for brush. + + + + + Default radius truncation corners. + + + + + Count of lines on the thumb. + + + + + Height of lines on the thumb. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The color scheme that the renderer will render. + + + + + + + + Initialize new instance of WindowsXPRenderer + + + + + + Initialize new instance of WindowsXPRenderer + + + + + + Draws arrow button of scroll. If theme is disabled than draw classic scroll. + + + + + + + + + Draws background of scroll. If theme is disabled than draw classic scroll. + + + + + + + + Draws thumb for scroll. If theme is disabled than draw classic scroll. + + + + + + + + Sets WindowsXP color scheme for the control. + + + + + + Sets the color scheme for the button based on the current XP Scheme. + + + + + Initializes edges of specified rectangle. + + Bounds of the rectangle. + + + + + + + + Gets rounded path with specified radius for the rectangle. + + + + + + + + Gets vertical gradient brush. + + + + + + + + + Gets horizontal gradient brush. + + + + + + + + + Gets gradient brush with 53 angle. + + + + + + + + + Draws background lines. + + Graphics object to use. + Bounds of the background. + Color of the lines. + + + + Draws shadow for the arrow button. + + The graphics object to use. + Bounds of the arrow button. + + + + + + + Draws shadow for the thumb. + + The graphics object to use. + Bounds of the thumb. + + + + + Draws middle lines on the thumb. + + Graphics object to use. + Bounds of the thumb. + + + + + + Fill Rectangle with ControlLightLight color. + + Graphics objects to use. + Bounds of the rectangle. + + + + Draws disabled arrowButton. + + Graphics object to use. + Bounds of the button. + Type of the button. + + + + Draws disabled background. + + Graphics object to use. + Bounds of the button. + + + + Draws disabled thumb. + + Graphics object to use. + Bounds of the thumb. + + + + Draws up arrow on the button. + + The graphics object to use. + Bounds of the button. + + + + + + Draws two lines in specified points. + + + + + + + + + + Rotate shape on specified angle around center p. + + Array of points that represents shape to rotate. + Angle in radians to rotate. + Point to rotate around. + + + + The color scheme that the renderer will render. + + + + + Blend for the default and selected arrow button. + + + + + Blend for the pushed arrow button. + + + + + Blend for the thumb. + + + + + Blend for the thumb with height < 17. + + + + + Blend for the border of arrow button. + + + + + Blend for the background. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initialize new instance of WindowsXPRenderer + + + + + + Draws arrow button of scroll. If theme is disabled than draw classic scroll. + + + + + + + + + Draws background of scroll. If theme is disabled than draw classic scroll. + + + + + + + + Draws thumb for scroll. If theme is disabled than draw classic scroll. + + + + + + + + Gets path that represents left and top lines. + + + + + + + + Gets path that represents bottom and right lines. + + + + + + + + Fills background with specified colors and gradient. + + Graphics object to use. + Bounds of the background. + Start color of the gradient. + End color of the gradient. + + + + Draws default background. + + Graphics object to use. + Bounds of background. + + + + Draws pushed background. + + Graphics object to use. + Bounds of background. + + + + Draws default arrow button. + + Graphics object to use. + Bounds of the arrow button. + + + + Draws selected arrow button. + + Graphics object to use. + Bounds of the arrow button. + + + + Draws pushed arrow button. + + Graphics object to use. + Bounds of the arrow button. + + + + Draws default thumb. + + Graphics object to use. + Bounds of the thumb. + + + + Draws selected thumb. + + Graphics object to use. + Bounds of the thumb. + + + + Draws pushed thumb. + + Graphics object to use. + Bounds of the thumb. + + + + Draws rounded path for the rectangle of thumb with specified color. + + The graphics object to use. + Bounds of the arrow button. + Color to draw. + Color to draw. + + + + Draws rounded path for the rectangle of arrow button with specified color. + + The graphics object to use. + Bounds of the arrow button. + Color to draw. + Color to draw. + + + WindowsXP OliveGreen Style renderer implementation. + + + + Blend for the default and selected arrow button. + + + + + Blend for the default and selected arrow button. + + + + + Blend for the thumb. + + + + + Blend for the background. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initialize new instance of WindowsXPRenderer + + + + + Draws arrow button of scroll. If theme is disabled than draw classic scroll. + + + + + + + + + Draws background of scroll. If theme is disabled than draw classic scroll. + + + + + + + + Draws thumb for scroll. If theme is disabled than draw classic scroll. + + + + + + + + Fills background with specified colors and gradient. + + Graphics object to use. + Bounds of the background. + Start color of the gradient. + End color of the gradient. + + + + Draws default background. + + Graphics object to use. + Bounds of background. + + + + Draws pushed background. + + Graphics object to use. + Bounds of background. + + + + Draws default arrow button. + + Graphics object to use. + Bounds of the arrow button. + + + + Draws selected arrow button. + + Graphics object to use. + Bounds of the arrow button. + + + + Draws pushed arrow button. + + Graphics object to use. + Bounds of the arrow button. + + + + Draws default thumb. + + Graphics object to use. + Bounds of the thumb. + + + + Draws selected thumb. + + Graphics object to use. + Bounds of the thumb. + + + + Draws pushed thumb. + + Graphics object to use. + Bounds of the thumb. + + + + Draws rounded path for the rectangle of arrow button with specified color. + + The graphics object to use. + Bounds of the arrow button. + Color to draw. + + + WindowsXP Silver Style renderer implementation. + + + + Blend for the default and selected arrow button. + + + + + Blend for the pushed arrow button. + + + + + Blend for the thumb. + + + + + Blend for the pushed thumb. + + + + + Blend for the background. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initialize new instance of WindowsXPRenderer + + + + + Draws arrow button of scroll. If theme is disabled than draw classic scroll. + + + + + + + + + Draws background of scroll. If theme is disabled than draw classic scroll. + + + + + + + + Draws thumb for scroll. If theme is disabled than draw classic scroll. + + + + + + + + Fills background with specified colors and gradient. + + Graphics object to use. + Bounds of the background. + Start color of the gradient. + End color of the gradient. + + + + Draws default background. + + Graphics object to use. + Bounds of background. + + + + Draws pushed background. + + Graphics object to use. + Bounds of background. + + + + Draws default arrow button. + + Graphics object to use. + Bounds of the arrow button. + + + + Draws pushed arrow button. + + Graphics object to use. + Bounds of the arrow button. + + + + Draws default thumb. + + Graphics object to use. + Bounds of the thumb. + + + + Draws pushed thumb. + + Graphics object to use. + Bounds of the thumb. + + + + Draws borders for the arrow buttons and thumbs. + + The graphics object to use. + Bounds of the arrow button. + + + + Draws internal borders for the arrow buttons and thumbs. + + The graphics object to use. + Bounds of the arrow button. + + + Design time helper class. Do not allow resizing of scrollers + when set KeepSystmeMetrics property to TRUE value. + + + Typed version of control reference extracting. + + + Override selection rule only in case of KeepSystemMetrics value set to True. + + + + Defines an interface that provides all properties to configure a scrollbar. + + + + + Gets / sets a value to be added to or subtracted from the value of the property when the scroll box is moved a large distance. + + + + + Gets / sets the upper limit of values of the scrollable range. + + + + + Gets / sets the lower limit of values of the scrollable range. + + + + + Gets / sets the value to be added to or subtracted from the value of the property when the scroll box is moved a small distance. + + + + + Gets / sets a numeric value that represents the current position of the scroll box on the scroll bar control. + + + + + Gets / sets a number that represents the current position of the scroll box on the scroll bar control. + + + + + Gets / sets a number that represents the current position of the scroll box on the scroll bar control. + + + + + Returns a reference to a scrollbar contained in a user control. + + + Splittercontrol and Workbookcontrol check for the IScrollBarContainer to get the + scrollbar. This enables you to replace the shared scrollbar with any user control + that also has a scrollbar. An example is the . + + + + + Gets / sets the contained scrollbar in a user control. + + + + + ScrollbarWrapper manages scrollbars for a control and hides details about the scrollbar + from the control that utilizes ScrollBarWrapper. This allows you to replace the concrete + ScrollBar with , , + or any custom scrollbar implementation. + + + + + Overloaded. Initializes a new instance of the class. + + The parent control. + The scrollbar type: horizontal or vertical. + + + + Initializes a new instance of the class. + + The parent control. + The scrollbar type: horizontal or vertical. + The scrollbar object to be managed by this instance. + + + + Implements the method and releases all managed resource for this object. + + + + + Copies all information to another object. + + The to receive all copied information. + + + + Raises the event. + + . + An that contains the event data. + + + + Suspends updating the scrollbar until is called. + + + + + Resumes updating the scrollbar after a call. + + + + + Fetches scrollbar information from the managed scrollbar object and updates the information + in the object. + + + + + Applies scrollbar information to the managed scrollbar object based on the information + in the current object. + + + + + Call this for reflected scrollbars from your parent control's method if you + want to support reflected scrollbars (those window scrollbars that you enable with WS_VSCROLL and + WS_HSCROLL window styles). + + The that was passed as argument to . + + + + Sends or emulates a scroll event. + + + + + + Occurs when the scroll box has been + moved by either a mouse or keyboard action. + + + + + Occurs when the property has changed, either by a + event or programmatically. + + + + + Indicates whether the control should scroll while the user is dragging a scrollbar's thumb. + + + + + Indicates whether the parent control should show ScrollTips while the user is dragging a scrollbar thumb. + + + Checks this property to determine if ScrollTips should be displayed. + + + + + Gets / sets a reference to the scrollbar that is contained in this wrapper class. + + + + + True if this is a Reflecting scrollbar; False if it is a simple scrollbar. + + + + + True if this is a flat scrollbar; False if it is a simple scrollbar. + + + + + True if scroll bar is currently in thumb drag mode. + + + + + True if this is a Reflecting scrollbar; False if it is a simple scrollbar. + + + + + Indicates whether updating is locked. See . + + + + + Gets / sets a value to be added to or subtracted from the value of the property when the scroll box is moved a large distance. + + + + + Gets / sets the upper limit of values of the scrollable range. + + + + + Gets / sets the lower limit of values of the scrollable range. + + + + + Gets / sets the value to be added to or subtracted from the value of the property when the scroll box is moved a small distance. + + + + + Gets / sets a numeric value that represents the current position of the scroll box on the scroll bar control. + + + + + Gets / sets a number that represents the current position of the scroll box on the scroll bar control. + + + + + Returns a reference to the parent control. + + + + + Manages the theme handle given a control and exposes some basic themed Drawing methods. + + + + The bound to this class can either implement the + interface or pass on the WM_THEMECHANGED message + to this class with a call to the method. + + + + + Creates a new instance of the class. + + Pointer to a string that contains a semicolon-separated list of classes, as expected + in the OpenThemeData API. + + + The bound to this class can either implement the + interface or pass on the WM_THEMECHANGED message + to this class with a call to the method. + This is necessary in order that this class can refresh its handles when themes + settings are updated. + + You can get the part and state ids required for the DrawXXX methods from the tmschema.h file (that comes with + Platform SDK) or refer to the undocumented and incomplete ThemeParts and ThemeStates classes + in our shared library (in the ThemeDefines.cs file). + + + + + Creates a new instance of the class. + + Pointer to a string that contains a semicolon-separated list of classes, as expected + in the OpenThemeData API. + Owning component. + + + The bound to this class can either implement the + interface or pass on the WM_THEMECHANGED message + to this class with a call to the method. + This is necessary in order that this class can refresh its handles when themes + settings are updated. + + You can get the part and state ids required for the DrawXXX methods from the tmschema.h file (that comes with + Platform SDK) or refer to the undocumented and incomplete ThemeParts and ThemeStates classes + in our shared library (in the ThemeDefines.cs file). + If owning component is not null, automatically unregisters itself from + on component disposing. + + + + + Overridden. See . + + + + + + + Called to create a theme handle, given the specified control and classList. + + + + + Closes the currently open theme handle. + + + + + Closes the current theme handle. + + + + + Closes the current theme handle and tries to open a new one. + + + + + Overloaded. Draws the specified theme background. + + A object. + An integer specifying the part. + An integer specifying the state. + The background . + + See for information on how to get the part and state IDs. + This method uses the VisibleClipRegion in the Graphics object to obtain the clip rect. + + + + + Draws the specified theme background. + + A object. + An integer specifying the part. + An integer specifying the state. + The background . + The clip rect to be used. + + See for information on how to get the part and state IDs. + Use this function to provide custom clip bounds. + + + + + Overloaded. Draws the specified theme text. + + A object. + An integer specifying the part. + An integer specifying the state. + The text to be drawn. + The layout bounds within which to draw. + Refers to the DrawThemeText function in the Windows API. + Refers to the DrawThemeText function in the Windows API. + + + + Draws the specified theme text. + + A object. + An integer specifying the part. + An integer specifying the state. + The text to be drawn. + The layout bounds within which to draw. + Refers to the DrawThemeText function in the Windows API. + Refers to the DrawThemeText function in the Windows API. + + + + Returns the size for the specified part. + + A object. + An integer specifying the part. + An integer specifying the state. + The size type. + The requested size. + + + + Calculates the size and location of the specified text when rendered in the theme font. + + A object. + An integer specifying the part. + An integer specifying the state. + The text to draw. + The layout bounds. + See GetThemeTextExtent method documentation in Windows API. + The rectangle representing the extent. + + + + Returns the current theme handle used to render the parts. + + + + + A implementing the interface. + + + + + Implement this interface in a derived class to start supporting themes. + + + + + Indicates whether themes are enabled. + + + + + + + + Raises the ThemeChanged event. + + An EventArgs that contains the event data. + + The OnThemeChanged method also allows derived classes to handle the event + without attaching a delegate. This is the preferred technique for + handling the event in a derived class. + Note to Inheritors: When overriding OnThemeChanged in a derived + class, be sure to call the base class's OnThemeChanged method so that + registered delegates receive the event. + + + + + Fired when the ThemesEnabled property changes. + + + + + Indicates whether themes are enabled for this control. + + + + + + + + + + + + + + + + + + + + + + + + + + Gets / sets ScrollButton highlighted state. + + + + + Gets / sets for correctly GradientBrush creation, so that background + is same as Parent's background. + + + + + This interface provides properties for accessing a vertical and horizontal + and an method. + + + + + Updates scrollbars to reflect recent changes in scroll position, minimum and maximum scroll position values. + + + + + Returns a reference to an object with vertical scrollbar settings of the control. + + + + + Returns a reference to an object with horizontal scrollbar settings of the control. + + + + + Provides support for method. + + + + + Indicates whether this control contains focus. Override this method if you + want to show drop-down windows and indicate the control has not lost focus when + the drop-down is shown. + + True if the control or any child control has focus; false otherwise. + + + + A ScrollTip window is a top-level window that gives feedback about the + current scroll position when the user grabs a scrollbar thumb and drags it. + + + + + A form-derived class that can be derived to create custom top-level + windows like ToolTips, a splash window, etc. + + + + + Creates a new instance of the TopLevelWindow class. + + + + + Shows the window as the top-level window without activating it. + + + + + Overridden to ignore Win32Exception. + + + + + + + + + + + Initializes a new . + + + + + + + + + + Raises the event and refreshes the contents of the window. + + The with event data. + + + + + + + + + Returns the optimal size for the window to fit the given text. + + The text that should fit into the window. + A with the window size of the ScrollTip. + + + + + + + Gets / sets the border style of the control. + + + + Gets / sets the text layout information for the text in the ScrollTip. + + + + + Specifies the current ScrollTip state when a event was raised. + + + + + The user has grabbed the thumb. The ScrollTip should be shown. + + + + + The user has released the thumb. The ScrollTip should be hidden. + + + + + The user is dragging the thumb. The ScrollTip text should be updated. + + + + + Handles the event. + + + + + + + + Provides data for the event. + + + + + + + + Constructs a object. + + The exception that was cached. + + + + Returns the exception that was cached. + + + + + Handles the ScrollTip event. + + + + + + + + Provides data for the event. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns the scrollbar that is the source of this event. + + + + + Returns a value that specifies the user action that led to this event. + + + + + Returns the new scroll position. + + + + + Gets / sets the text to display in the ScrollTip. You can change this text in your event handler during + a Scroll action. + + + + + Gets / sets the size of the ScrollTip window. You can adjust the scroll window size in your event handler + when handling a ThumbTrack action. + + + + + Gets / sets the location of the ScrollTip window. You can adjust the scroll window size in your event handler + when handling a ThumbTrack action. + + + + + Gets / sets the font to be used for the ScrollTip text. You can adjust the scroll window size in your event handler + when handling a ThumbTrack or Scroll action. + + + + + Gets / sets the text color to be used for the ScrollTip text. You can adjust the scroll window size in your event handler + when handling a ThumbTrack or Scroll action. + + + + + Gets / sets the backcolor to be used for the ScrollTip text. You can adjust the scroll window size in your event handler + when handling a ThumbTrack or Scroll action. + + + + + Gets / sets the border style to be used for the ScrollTip text. You can adjust the scroll window size in your event handler + when handling a ThumbTrack action. + + + + + Gets / sets the text layout information for the text in the ScrollTip. + + + + + BeginUpdateOptions details which drawing operations should be performed during a batch of updates. + + + + + The control suspends any drawing and invalidation and will do a complete refresh when EndUpdate is called. + + + + + Regions that need to be redrawn afterward should be marked invalid by calling the controls Invalidate method. + + + + + ScrollWindow will scroll the window. + + + + + Scrollbars should be synchronized with the current scroll position. + + + + + Allows invalidating regions, scrolling and synchronizes the scrollbar thumb. + + + + + Contains data for the WindowScrolling and WindowScrolled event. + + + ScrollWindow will raise a WindowScrolling event before it scrolls the window and a WindowScrolled event after the scrolling. + + + + + + + + + + + + + + + + + + + + Initializes a new . + + The horizontal scroll distance in pixel. + The vertical scroll distance in pixel. + The bounds of the rectangle that is scrolled. + Clipping rectangle. + The rectangle that was scrolled into view. + + + + + + + + + Returns the horizontal scroll distance in pixels. + + + + + Returns the vertical scroll distance in pixels. + + + + + Returns the bounds of the rectangle that is scrolled. + + + + + Returns the Clipping rectangle. + + + + + Returns the rectangle that was scrolled into view. + + + + + Handles the scroll window event. + + + + + + + + Provides a global hook for exceptions that have been cached inside the framework and gives you + the option to provide specialized handling of the exception. You can also temporarily suspend and resume + caching exceptions. + + + The Syncfusion framework notifies about exceptions that + are cached by calling or . + The method will raise the + event. By handling the event, your code can analyze the exception that was cached + and optionally let it bubble up by rethrowing the exception. + Your code can also temporarily suspend and resume caching exceptions. This is useful if you want to provide your + own exception handling. Just call to disable handling exceptions and + to resume caching exceptions. + You also have the options to disable caching exceptions altogether by setting to True. + Note: All static settings for this class are thread local. + + + + + + + + + + + + + + + + + Temporarily suspends caching exceptions. + + + + + Temporarily resumes caching exceptions. + + + + + Indicates whether exceptions should be cached or if they should bubble up. + calls this method. + + + + + + Raises the event. + + + Raises the event. If caching exceptions has been disabled + by a call or if has been set to True, + the exception is rethrown. + + A that contains the event data. + + + + + + Raises the event. If caching exceptions has been disabled + by a call or if has been set to True, + the exception is rethrown. + + A that was cached. + + + + + + + + + Occurs when an exception was cached within the framework and was notified. + + + + + Lets you disable caching exceptions altogether by setting to True. + + + + Specifies the acceleration behavior for scrollbars. + + + + + Disable scrollbar acceleration. + + + + + Default, moderate acceleration after the user scrolled 60 increments. + + + + + Acceleration after the user scrolled 20 increments. + + + + + Immediate acceleration after the user scrolled 4 increments. + + + + + Specifies the type of autoscrolling, either scrollbar acceleration or mouse dragging outside window bounds. + + + + + The user held down a scrollbar button. + + + + + The user has dragged the mouse outside the autoscroll bounds. + + + + + The user is moving the mouse over the control during OLE drag-and-drop operation. + + + + + Handles the event. + + + + + + + + Provides data for the event which is called + when accelerated scrollbar scrolling or mouse drag-scrolling starts. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns the type of autoscrolling, either scrollbar acceleration or mouse dragging outside window bounds. + + + + + Returns the scroll bar direction: vertical, horizontal, or both. + + + + + Gets / sets the interval that is initially assigned to the timer for recurring scrolling. + + + + + Gets / sets the interval step that the timer should be decreased from time to time. + + + + + Gets / sets the minimum interval for the fastest scroll speed. + + + + + + + + Defines a base class for custom controls that support scrolling behavior. + + + The ScrollControl class acts as a base class for controls that require the + ability to scroll. To allow a control to display scrollbars as needed, + set the AutoScroll property to True. To select which scrollbars should be visible, + set the VScroll and HScroll properties. + You can also associate stand-alone scrollbars with the ScrollControl. The VertScrollBar + and HorizScrollBar properties allow you to associate external scrollbars. This is of benefit + if you want to share one scrollbar with a parent control. For example, if the ScrollControl + is a view inside a workbook or dynamic splitter frame. + ScrollControl supports automatic scrolling when the user drags the mouse. In a grid + when the user starts selecting cells the user can drag the mouse outside the grid + area and the grid will automatically scroll. To enable auto scrolling, override the + OnMouseDown event in your derived control and initialize the AutoScrolling, AutoScrollBounds + and InsideScrollBounds properties. + When the user scrolls your control and holds down the mouse on the down or up arrow + of the scrollbar, the scrolling speed will accelerate. + The FixRenderOrigin method will ensure correct initialization of the rendering origin + for brushes and patterns. You can call FixRenderOrigin from your control's OnPaint method. + ScrollControl supports scrolling with the mouse wheel and also cooperates fine with + with the IntelliMouseDragScroll class. + If you want to provide context information about your control and change the cursor on + the fly while the user moves the mouse, set the OverrideCursor property to the cursor + you want to show. Instead, you can also implement IMouseController and add the object + to MouseControllerDispatcher. + + + + Provides a property support for using the control + inside a dynamic splitter window and sharing scrollbars + with the parent window. + + + + + Indicates that the splitter control is closing the pane with this control. + + + + + Indicates that the splitter control has closed the pane with this control. + + + + + Toggles support for using the control inside a dynamic splitter window and sharing scrollbars + with the parent window. + + + + + Indicates whether the splitter control is closing the pane with this control. + + + + + Indicates whether the splitter control has closed the pane with this control. + + + + + Implement this method and draw your NonClient area using the passed in parameters. + + The PaintEventArgs using this to draw the non client area. + The control's window bounds into which to draw. Left and Top are usually zero. + The control's bounds in screen co-ordinates. + + HRgn (as IntPtr) that excludes the region you just drew in the displayRect. + + + + + Interface for SkinManager + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Internal only. + + + + + Internal only. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Indicates the shared behavior of the vertical scrollbar + + + + + Indicate the shared behavior of the horizontal scrollbar + + + + + The SizeGripStyle behavior has been changed after version 6.1. + For old behavior set this to true. Default value is false. + + + + + Initializes a new instance of . + + + + + Disposes the control. + + + + + + + + + + Raises a CancelMode for the active mouse controller for this control. + + holds a collection of mouse controllers. + + + + + + + + + + + + + + + + + + + + + Indicates whether serialize property value or not. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Offsets the point. + + + + + + + Returns PointToClient(LastMousePosition). + + + + + + Returns a value indicating the context at a given mouse position. + + + Returns a value indicating the context at a given mouse position. + + The mouse position in client coordinates. + A value indicating the context at a given mouse position; zero if no context found. + + Any Mouse Controller needs to implement the IMouseController interface. + In its implementation of MouseController.HitTest the mouse controller determines whether it + wants to handle the mouse events for the current mouse position. + MouseControllerDispatcher will call HitTest for each Mouse Controller that has been registered with + Add(IMouseController). The Mouse Controller that wins the vote will be returned together with the + context value its HitTest implementation returned. + + + + + Returns a value indicating the context at a given mouse position. + + The mouse position in client coordinates. + Indicates which mouse button was pressed. + A value indicating the context at a given mouse position; 0 if no context found. + + + + + Returns a value indicating the context at a given mouse position. + + The mouse position in client coordinates. + Indicates which mouse button was pressed. + A place holder where the controller is returned that won the vote. + A value indicating the context at a given mouse position; 0 if no context found. + + + + + Returns a value indicating the context at a given mouse position. + + The mouse position in client coordinates. + Indicates which mouse button was pressed. + Specifies the number of times the mouse button was pressed and released. + A place holder where the controller is returned that won the vote. + A value indicating the context at a given mouse position; 0 if no context found. + + + + + + + + + + + + + + + + + + + + + + Handles the WM_SETCURSOR message + + + + + + + + + + + + + + + + + + + + + + + Initialize the last vertical scroll value. + + + + + Initialize the last horizontal scroll value. + + + + + Used to save the touch start position. + + + + + Used to check the touch mode is enabled or not. + + + + + Used to check touch on the Horizontal scroll bar or not. + + + + + Used to check touch on the Vertical scroll bar or not. + + + + + Used to save the object for MultiTouch to configure the touch. + + + + + Used to disable the Gesture. + + + + + Decode the touch messages to do corresponding operations + + windows touch messages + return true when the message properly handled otherwise it will be false + + + + Applies the color table for scrollbars. + + + + + Apply the color settings for Office2016 scrollbar. + + Scrollbar visual styles + + + + Apply Office2016Black color settings for scrollbar. + + + + + Apply Office2016DarkGray color settings for scrollbar. + + + + + Apply Office2016White color settings for scrollbar. + + + + + Apply Office2016Colorful color settings for scrollbar. + + + + + Raises the event. + + A that contains the event data. + + + + Get or Set of Skin Manager Interface + + + + + Raises the event. + + Event data. + + + + Raises the event. + + Event data. + + + + Raises the event. + + Event data. + + + + Raises the event + + Office scrollbar type + + + + Apply the color scheme for Office2016 scrollbar. + + + + + + + + + + Handles mouse wheel processing for our scrollbars. + + + + + + Raises the event. + + An that contains the event data. + + + + Raises the event. + + An that contains the event data. + + + + Raises the event. + + An that contains the event data. + + + + Fires the ScrollbarsVisibleChanged event. + + A that contains the event data. + + + + Override this method to implement zooming in your derived control. + + The event data. + + + + Raises the event. + + A that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Initially save the current scrollbar values when begin the panning operation + + Touch begin position + return true + + + + Adjust the HScrollBar and VScrollBar values based on current touch position + + Current touch position + Used to decide the doing swipe operation or pan operation + + + + + After panning operation completes save the current scroll bar values + + touch end position + return true + + + + + + + + + + + + + + + + + + + Raises the event. + + A that contains the event data. + + + + + + + + + + + + + + + + + Handles the of the horizontal scrollbar. + + The source of the event. + An that contains the event data. + + + + Handles the of the vertical scrollbar. + + The source of the event. + An that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Listens for the horizontal scrollbar's scroll event. + + + A that contains data about the control. + + + A that contains the event data. + + + + + Listens for the vertical scrollbar's scroll event. + + + A that contains data about the control. + + + A that contains the event data. + + + + + Raises the ShowContextMenu event when the user right-clicks inside + the control. + + You can cancel showing a content menu when + you assign True to . + + + + + + Raises the event. + + An that contains the event data. + + + + Raises the event. + + + + + + Method calculate new client area size. If you want to increase Non-Client + area for control and draw on it then this is method especially for you. + + Rectangle of the control client area. + + + + Raises the event. + + A that contains the event data. + + + + Factory method that creates a for displaying ScrollTips. + + + + + + + + + + + Raises the event. + + An that contains the event data. + + + + Raises the event. + + A that contains the event data. + + The event handler for this event can check + to determine if or + was called. + + + + + Overridden. See the event. + + An that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Raises the event. + + An that contains the event data. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Raises the event. This method is called when the control + or any child control gets focus and this control did not have focus before. + + + Inheriting classes should override this method instead of overriding + because is also called when child controls get focus and it + is not called when focus is moved within child controls of this control. + + + + + Raises the event. This method is called when the control + or any child control loses focus and the new focused control is not a child of this control. + + + Inheriting classes should override this method instead of overriding + because is also called when child controls lose focus and it + is not called when focus is moved within child controls of this control. + + + + + This method is called if the control's notification occurs + while handling a event. This typically occurs if a + message box is displayed from a event handler. + + + + + Minimizes the time the first time the control is drawn. Calling + OnPaint before the control is made visible ensures that all relevant code for drawing + has been jitted. + + + + + Raises the event. + + An that contains the event data. + + + + + + + + + + + + + + + + + + + + + + + + + + Given a component, this retrieves the that it is parented to; + NULL if it is not parented to any . + + + The component to check. + + + A that the component is parented to; NULL if + no such interface exists. This will return the component if it + is an instance of . + + + + + Given a component, this retrieves the that it is parented to; + NULL if it is not parented to any . + + + The component to check. + + + An that the component is parented to; NULL if + no such interface exists. This will return the component if it + is an instance of . + + + + + Delegates the MouseWheelEvent from a child control. + + A MouseEventArgs that holds event data. + + internal class GridTextBox: RichTextBox + { + private GridTextBoxCell parent; + protected override void OnMouseWheel(MouseEventArgs e) + { + parent.Grid.ProcessMouseWheel(e); + } + } + + + + + Invalidate the vertical scrollbar + + + + + Invalidate the horizontal scrollbar + + + + + + + + The scrollbar height and width will be increased, when the DPI of system is increased. + + + ScrollBarCustomDraw + + + + Displays / hides the horizontal and vertical autoscrollbars. This will + also adjust the values of formState to reflect the new state. + + + True if the horizontal scrollbar should be displayed. + + + True if the vertical scrollbar should be displayed. + + + True if the form needs to be layed out again. + + + + + Raises the specified mouse event and catches any exception. If an exception is caught, NotifyCancelMode + is called. Returns False if event should be ignored by the grid. + + A that contains the event data. + A delegate that handles the event. + False if CancelMouseEventArgs.Cancel is True; True otherwise + + + + + + + + Method force to invalidate Non Client area of control. + + + Invalidate specified rectangle in Non Client area. + Rectangle to Invalidate. + + + Invalidate and wait till area update on Non Client area. + + + + Method draws non-client area of an ScrollControl. + + EventArgs with Non-client info for drawing. + + + + + + + + + + + Raises a event. + + + + + + Increases small change of the ScrollBar. + + + + + + + + + + + + + Resets the property to its default value. + + + + + Starts the AutoScroll timer. + + The scrollbar to be automatically scrolled. + The event to be sent to this scrollbar. + + + + Starts the AutoScroll timer. + + + Starts the AutoScroll timer. + + The message to be sent to the current control. + + + + + + + Starts the AutoScroll timer. + + The message to be sent to the current control. + The initial interval for sending messages. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Call this method from your control's OnPaint method to ensure correct + rendering origin for brushes and patterns. + + The graphics object. + + + + Updates scrollbars to reflect recent changes in scroll position, minimum and maximum scroll position values. + + + + + Call this method to check if you should do any update calculations for the view in your control and to notify scroll control + that the control's content needs to be updated. + + True if you should invalidate areas that need to be redrawn; False if a complete Refresh for the control is pending + and therefore invalidating the view is not necessary. + + + + Call this method to check if you should do any update calculations for the view in your control and to notify scroll control + that the control's content needs to be updated. + + If markPaintPending is True, ScrollControl will assume the control needs to be repainted in a subsequent EndUpdate call. + True if you should Invalidate regions to be repainted in your control. It will return False if a complete Refresh of + the control is pending and you don't need to invalidate individual regions of your control. + + + + Suspends the painting of the control until the method is called. + + + When many paints are made to the appearance of a control, you should invoke the + BeginUpdate method to temporarily freeze the drawing of the control. This results + in less distraction to the user and a performance gain. After all updates have + been made, invoke the EndUpdate method to resume drawing of the control. + + + + + Suspends the painting of the control until the method is called. + + Specifies the painting support during the BeginUpdate, EndUpdate batch. + When many paints are made to the appearance of a control, you should invoke the + BeginUpdate method to temporarily freeze the drawing of the control. This results + in less distraction to the user and a performance gain. After all updates have + been made, invoke the EndUpdate method to resume drawing of the control. + Pass BeginUpdateOptions if you do not want to do a complete Refresh of the control and instead + want to have certain regions of your control be invalidated or scroll the contents of control. + If you call BeginUpdate() and then later EndUpdate(), the control will know if a paint is pending and only + refresh the control if a paint is pending. Calling ShouldPrepareUpdate, Invalidate or a WM_PAINT message during + the BeginUpdate EndUpdate block will signal the control that a paint is pending. + + + + + + + Calls for both scrollbars. + + + + + Calls for both scrollbars. + + + + + Resumes the painting of the control suspended by calling the BeginUpdate method. + + + When many paints are made to the appearance of a control, you should invoke the + BeginUpdate method to temporarily freeze the drawing of the control. This results + in less distraction to the user and a performance gain. After all updates have + been made, invoke the EndUpdate method to resume drawing of the control. + + + + + + Cancels any prior calls. + + + + + + Resumes the painting of the control suspended by calling the BeginUpdate method. + + + When many paint are made to the appearance of a control you should invoke the + BeginUpdate method to temporarily freeze the drawing of the control. This results + in less distraction to the user, and a performance gain. After all updates have + been made, invoke the EndUpdate method to resume drawing of the control. + + + + + + Scrolls the contents of the control similar to the ScrollWindow Windows API. + + + The method will raise a WindowScrolling event before the contents are scrolled and a WindowScrolled event after + the contents have been scrolled. + If DisableScrollWindow is True, any calls to the ScrollWindow method will simply invalidate the affect region. The rendering origin will + still be recorded correctly and WindowScrolling and WindowScrolled events will be raised.If DisableScrollWindow is False, ScrollWindow will scroll the contents of the control. + + + + + + + + + + + + + + + + + Discards paint messages. + + + + + + + + + + + + + + + + Indicates whether this control contains focus. Override this method if you + want to show drop-down windows and indicate the control has not lost focus when + the drop-down is shown. + + True if the control or any child control has focus; false otherwise. + + + + + + + + + + + + + + + + Checks if the control is visible and a window handle has been created. + If it has not been drawn before, it calls . + + Set this True if you want to force a call to + even if the control is not visible and / or + no window handle has been created. + + + + Enables the DoubleBufferSurface for this control. The DoubleBufferSurface buffering + is different from the automatic .NET double buffering and also a bit slower but + it reduces flicker if lots of scrolling is used and gdi drawing for individual cells + in a grid. + + + + + Forces the assigned styles to be reapplied to the control. + + + + + Indicates whether the time the first time the control is drawn should be optimized + by calling OnPaint before the control is made visible and so that all relevant code for drawing + has been jitted (Just in Time) + + + + + Disables or specifies the direction for automatic scrolling when the user drags + the mouse cursor out of the scrolling area. + + ScrollBars.None will disable scrolling.ScrollBars.Horizontal will enable horizontal scrolling.ScrollBars.Vertical will enable vertical scrolling.ScrollBars.Horizontal|ScrollBars.Vertical will enable both horizontal and vertical scrolling. + + + + Lets you check or specify the setting if the window should be scrolled when ScrollWindow is called. + + If DisableScrollWindow is True, any calls to the ScrollWindow method will simply invalidate the affect region. The rendering origin will + still be recorded correctly and WindowScrolling and WindowScrolled events will be raised.If DisableScrollWindow is False, the ScrollWindow will scroll the contents of the control. + DisableScrollWindow will return True if BeginUpdate was called without the BeginUpdateOptions.ScrollWindow option. + + + + + + + + Indicates whether the control should scroll while the user is dragging a scrollbar thumb. + + + + + Indicates whether the control should scroll while the user is dragging a vertical scrollbar thumb. + + + + + Indicates whether the control should scroll while the user is dragging a horizontal scrollbar thumb. + + + + + Indicates whether the control should show ScrollTips while the user is dragging a vertical scrollbar thumb. + + + + + Indicates whether the control should show ScrollTips while the user is dragging a horizontal scrollbar thumb. + + + + + Gets or sets a size grip that should be drawn at the bottom-right corner if both scrollbars + are visible. + + + + + Indicates whether a size grip can be drawn inside the SizeBox and if the + of the parent form is allowed to be changed. + + + + + Indicates whether the size box should always be drawn when both scrollbars are visible. This + property differs from such that the control will not + check the docking state and parent form to determine whether to show the size box. + Note: Another better solution is drawing NonClientArea + ourselves. See SizeGripStyle which implements this newer solution. + + + Showing the size box works around a problem with .NET controls because by + default the area at the bottom right is not drawn and that can cause + drawing glitches. Note: Another better solution is drawing the NonClientArea + ourselves. See SizeGripStyle which implements this newer solution. + + + + + Indicates whether the size box should be drawn when both scrollbars are visible + and the control is not a docked window in an MDIChild window. Note: Another better solution is drawing the NonClientArea + ourselves. See SizeGripStyle which implements this newer solution. + + + Showing the size box works around a problem with .NET controls because by + default the the area at the bottom right is not drawn and that can cause + drawing glitches. Note: Another better solution is drawing NonClientArea + ourselves. See SizeGripStyle which implements this newer solution. + + + + + Indicates whether the control is currently scrolling and the user drags + the mouse outside the inner scrolling area. + + + + + Returns a reference to an object with vertical scrollbar settings of the control. + + + + + Returns a reference to an object with horizontal scrollbar settings of the control. + + + + + Internal only. Toggles thumb track mode. See ScrollBarWrapper.IsThumbTracking for a internal getter for this state. + + + + + Indicates whether the scroll control can increase the + property while doing accelerated scrolling. If this is True, the + will be set to 3 after 40 rows and to 5 after 80 rows. + + + By default the scroll control will increase the scrolling step after a while. Set this to + False if you want to enforce scrolling only one row at a time even with accelerated scrolling. + + + + + Gets or sets the outer scrolling area. Typically the client area of the control. + + + + + Returns the inside scrolling area. The control will scroll if the user drags + the mouse outside this area. + + + + + Gets or sets the default margins for the scrolling area when the user moves the mouse to the + margin between InsideScrollBounds and AutoScrollBounds. + + + + + Returns a reference to the for this control. Can be NULL. + + + + + Gets or sets the text to be displayed in the ScrollTip window with a place holder for scroll position . For example, " Position {0} " + + + + + Immediately changes the shown cursor. + + + + + Indicates whether the control is handling a event. + + + + + Indicates whether the method has been called. and resets this flag. + + + + + Indicates whether the method has been called. and resets this flag. + + + + + Indicates whether has been called. resets this flag. + + + + + Indicates whether has been called. resets this flag. + + + + + Indicates whether has been called. resets this flag. + + + + + ScrollControlMouseController checks this to see if it should cancel + existing mouse operation and call ScrollControlMouseController.CancelMode + when a UICuesChanged event is sent. That can happen when user activates + another application or simply when styles for a child window have changed. + + + + + Returns the Pane information. + + + + + Lets you override the scroll behavior for rolling the mouse wheel. Default is SystemInformation.MouseWheelScrollLines. + + + + + Indicates whether the control should perform one scroll command (faster) or + if it should perform multiple scroll commands with smaller increments (smoother) + when user rolls mouse wheel. + + + + + Gets or sets the multiplier for mouse wheel scrolling. + + + + + Gets or sets the multiplier for mouse wheel scrolling. + + + + + Enables shared scrollbars. Use this if the control is not embedded in a container control + that implements IScrollBarFrame and you want to provide your own scrollbars. + + + + Gets / sets the border style of the control. + + + + Indicates whether the horizontal scroll bar is visible. + + if the horizontal scroll bar is + visible; otherwise. + + + + + + Indicates whether the vertical scroll bar is visible. + + if the vertical scroll bar is + visible; otherwise. + + + + + + Indicates whether the splitter control has closed the pane with this control. + + + + + MouseControllerDispatcher coordinates mouse events among competing mouse controllers. Based on + the position of the mouse and context of the control every registered controller's HitTest method + is called to determine the best controller for the following mouse action. This controller will then + receive mouse events. + + + See for more information. + + + + + Returns a reference to the active mouse controller that is receiving MouseDown, MouseMove, MouseUp messages when the user + has pressed a mouse button. + + + + + + + + + Toggles support for using the control inside a dynamic splitter window and sharing scrollbars + with the parent window. + + + + + Indicates whether the splitter control is closing the pane with this control. + + + + + Toggles support for Intelli-Mouse panning. When the user presses the middle mouse button and drags the mouse, + the window will scroll. + + + + + + + + + + + When you call BeginUpdate(), the control by default does not handle WM_PAINT messages. Only + once you call EndUpdate they will be processed. If this causes problems in your application, you can + set this static property to True. In such cases, WM_PAINT messages will be simply discarded and + any invalid regions will be validated. + + + There is a problem with the default implementation of BeginUpdate. If a screen region is marked + invalid, the WndProc will be repeatedly called with WM_PAINT at the the top of the WndProc + until EndUpdate is called. This can cause your application to freeze if another window gets created + or if you make a web service call and WndProc messages need to be processed. + Setting DiscardPaintMessagesAfterBeginUpdate to True will help avoid these scenarios. + + + + + Returns true if object is executing method call. + + + + + Property MousePosition (Point) - cached Control.MousePosition. The variable is set + before any WM_MOUSE* messages being processed. + + + + + Gets or sets the acceleration behavior for scrollbars. + + + + + Indicates whether OnMouseMove should be called from OnDragOver. + + + + + + Gets or sets the control's size. Size is overridden here to prevent Code Generation in Designer. + + + + + + Gets or sets the control's bounds. Size is overridden here to prevent Code Generation in Designer. + + + + + Gets or sets the TabIndex. + TabIndex is overridden here to prevent Code Generation in Designer. + + + + Returns the settings for the current BeginUpdate option. + + + + + Indicates whether BeginUpdate() has been called and the painting for a control is suspended. + + + + + Indicates whether there are updates pending for the control when painting is suspended by BeginUpdate. + + + + + Determines if EnableDoubleBufferSurface method was called and double buffering + using the DoubleBufferSurface is enabled. The DoubleBufferSurface buffering + is different from the automatic .NET double buffering and also a bit slower but + it reduces flicker if lots of scrolling is used and gdi drawing for individual cells + in a grid. + + + + + Returns the DoubleBufferSurface if EnableDoubleBufferSurface() was called. Otherwise + the method returns null. + + + + + Indicates whether is internally called. + + + + + Occurs when both and occur. + + + + + Occurs when the property has been changed. + + + + + Occurs when vertical scrollbar is moved. + + + + + Occurs when horizontal scrollbar is moved. + + + + + Occurs when the user presses the mouse wheel and drags the mouse. + + + Set of + to True if you provide customized scrolling in your event handler. + + + + + The ShowContextMenu event occurs when the user right-clicks inside + the control. + + + + You can cancel showing a content menu when + you assign True to . + + + + + + Occurs when accelerated scrollbar scrolling or mouse drag-scrolling starts. + + + + + Occurs when the splitter control has closed the pane with this control. + + + + + Occurs when the splitter control is closing the pane with this control. + + + + + Occurs when the user is dragging the scrollbar thumb. + + + + + Occurs when scrollbars are hidden or shown. + + + + + Occurs when the user holds the Control Key and rolls the mouse wheel. + + + + + Occurs when the value has changed. + + + + + Occurs when has been called the first time or + has been called the last time. + + + + + Occurs after the window has been scrolled. + + + + + Occurs while the window is being scrolled. + + + + + Occurs before a is raised and allows you to cancel the mouse event. + + + + + Occurs after a is raised. + + + + + Occurs before a is raised and allows you to cancel the mouse event. + + + + + Occurs after a event is raised and after auto-scrolling. + + + + + Occurs before a is raised and allows you to cancel the mouse event. + + + + + Occurs after a event is raised. + + + + + Occurs when the window receives a WM_CANCELMODE message. + + + WM_CANCELMODE is sent to cancel certain modes, such as mouse capture. + For example, the system sends this message to the active window when a + dialog box or message box is displayed. Certain functions also send this + message explicitly to the specified window regardless of whether it is the + active window. For example, the EnableWindow function sends this message + when disabling the specified window. + + + + + Occurs when the AutoScrolling property is changed. + + + If you want to prevent autoscrolling, you should handle this event + and reset the AutoScrolling property to ScrollBars.None. + + + + + Overridden. Changes to show or hide scrollbars and also consider the control's + setting. + + + + + Gets or sets the touch mode. + + + + + Gets or sets the color table for Office2016 Black theme scrollbar. + + + + + Gets or sets the color table for Office2016 white theme scrollbar. + + + + + Gets or sets the color table for Office2016 Dark gray theme scrollbar. + + + + + Gets or sets the color table for Office2016 colorful theme scrollbar. + + + + + Gets or sets the Office2016 Scrollbars + + + + + Toggles between standard and Office2007 scrollbars. + + + + + Gets or sets the style of Office2007 scroll bars. + + + + + Occurs when the property has changed. + + + + + Occurs when the property has changed. + + + + + Occurs when the property has changed. + + + + + Occurs when the property has changed. + + + + + Occurs when the property has changed. + + + + + Gets the rectangle that represents the client area of the control. If custom + scroll bars (ScrollBarCustomDraw, Office2007 style) are shown in the client area, then + this method will remove the area occupied by the scrollbars. + + + + + Gets or sets the height and width of the client area of the control. If custom + scroll bars (ScrollBarCustomDraw, Office2007 style) are shown the client area, then + this method will remove the area occupied by the scrollbars. + + + + + Gets or sets the Office like scrollbars. + + + + + Gets or sets the style of MS Office2010 scroll bars. + + + + + Gets or sets the style of Office2016 theme for scrollbars. + + + This is applicable for both the horizontal and vertical scrollbar. + + + + + Gets or sets the boolean value for enhanching the apperance settings for DpiAware enabled Application. + + + + + Provides the data about event of a . + + + + + Initializes a new . + + The record index. + + + + Gets or sets the Office scroll bars + + + + + Delegate for ScrollControlMouseDown, OnBeforeMouseMove and ScrollControlMouseUp methods. + + + + + + + + + + + + + + + + + + + Internal Variable for ScrollControl + + + + + + + + + + + + + + + + + + + + Apply the scrollbar background color for scroll control. + + Graphics for scroll control + Bacground color for scroller background. + Border color for scroll control + + + + + + + + + + + + + + + Handles a cancellable event. + + The source of the event. + An that contains the event data. + + + + + + Provides data about the cancellable event. + + + ShowContextMenuEventArgs is a custom event argument class used by the + event when the user right-clicks inside + the control. + + You can cancel showing a context menu when + you assign True to . + + + + + + + Initializes a new object. + + The mouse location in screen coordinates. + + + + Returns the mouse location in screen coordinates. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the for the specified font. + + A graphics object to use when detecting the Panose + family. + The font to check. + The Panose font family type. + + + + + + + Enumeration of Panose Font Family Types. These can be used for + determining the similarity of two fonts or for detecting non-character + fonts like WingDings. + + + + + Any + + + + + No Fit + + + + + Text and Display + + + + + Script + + + + + Decorative + + + + + Pictorial + + + + + Indicates whether the rows were split at the given y coordinate. + + The vertical position in percentages of the splitter control's height. + True if rows were split successfully; False if they were already split or the operation aborted. + + + + Indicates whether the columns were split horizontally at the specified x coordinate. + + The horizontal position in percentages of the splitter control's width. + True if columns were split successfully; False if they were already split or the operation aborted. + + + + Deletes the splitter panes at the specified row. + + The zero-based index for the splitter pane row. + + + + Deletes the splitter panes at the specified column. + + The zero-based index for the splitter pane column. + + + + Returns the splitter pane at the specified row and column. + + The zero-based index for the splitter pane row. + The zero-based index for the splitter pane column. + The control at the pane. + + + + Returns the row and column index for a child pane. + + The control to search for. + A placeholder where the row is returned. + A placeholder where the column is returned. + True if the control is a pane; False if the control was not a child pane. + + + + Sets the active pane in the splitter control specified by row and column. + + The zero-based index for the splitter pane row. + The zero-based index for the splitter pane column. + + + + Indicates whether there is a next or previous pane that can be activated. + + True if previous pane should be activated; False if next pane should be activated. + True if activating next or previous pane is good; False if already at last or first pane. + + + + Activates the next or previous pane. + + True if previous pane should be activated; False if next pane should be activated. + + + + Gets / sets a value indicating what split behavior is supported. Rows, Columns or Both. + + + + + Returns the number of visible row panes. + + + + + Returns the number of visible column panes. + + + + + Gets / sets the active pane in the splitter control. + + + + + Occurs when the property has changed. + + + + + Occurs when the vertical splitter position has changed. + + + + + Occurs when the horizontal splitter position has changed. + + + + + Occurs when the splitter layout has changed. + + + + + Defines split behavior for a . + + + + + No dynamic splitter. + + + + + Split rows vertically. + + + + + Split columns horizontally. + + + + + Allow both splitting the view vertically and horizontally. + + + + + Specifies the style with which some controls will appear and behave. + + + Every control that incorporates these styles will define the styles differently, + so take a look at the individual control for more information. + + + + + Classic appearance. + + + + + Office XP-like appearance. + + + + + Office 2003-like appearance. + + + + + Visual Studio 2005-like appearance. + + + + + Office 2007-like appearance. + + + + + Office 2007 Outlook-like appearance. + + + + + Office 2010-like appearance. + + + + + Visual Studio 2010-like appearance. + + + + + Metro-like appearance. + + + + + Office2016 Colorful + + + + + Office2016 White + + + + + Office2016 Black + + + + + Office2016 DarkGray + + + + + Represents a class that provides support to get the current DPI value and calculate the values based on the current DPI values. + + + + + The which is used to calculate the DPI value. + + + + + Gets the image file from given assembly based on the DPI scaling factor. + If the DPI scaling is greater than 175 then returns the high DPI image, otherwise returns the default image. + + The used to read the image file. + The string contains the folder path. + The string value represents the name of the image file. + The imageName must contains the extension like AddNewRowIcon.png or AddNewRowIcon.bmp + Returns the image file from specified folder path. + + + + Gets an equivalent value based on the current DPI value. + + The float value. + Returns the value based on DPI value. + + + + Gets the current DPI value of the device. + + Returns the current DPI value of the device. + + + + Gets the used to calculate the DPI value of the device. + + + + + Represents the arguments associated with a `DocumentLoading` event. + + + + + Gets the value of currently loading page. + + + + + Gets the page count. + + + + + Gets or sets a value indicating whether the event should be canceled. + + + + + Event arguments for the event + + + + + Gets the error message + + + + + Gets the Exception details. + + + + + Provides data for the event + + + + + Provides data for the and events + + + + + Gets the index of the page in which mouse action is performed + + + + + Gets the position of the mouse pointer relative to the page + + + + + Provides data for the event + + + + + Provides the settings for message box + + + + + Enable or disable the message box notifications. The default value is true + + + + + Gets or sets Visual Styles of the PDF viewer. + + + + + Default appearance. + + + + + Office2016 Colorful + + + + + Office2016 White + + + + + Office2016 Black + + + + + Office2016 DarkGray + + + + + Defines the constants that specify color schemes for the Office 2016 theme. + + + + Office2016 white. + + + Office2016 black. + + + Office2016 dark gray. + + + Office2016 colorful color. + + + + Provides static properties to access the colors used by different components in the XPMenus framework. + + + + The primary objective of this class is to let you specify custom colors for the different + regions of the XPMenus components. When no colors are provided, this class returns the default + colors usually synthesized from the System Colors. If you have to reset a property that you set before, + simply set it to be Color.Empty; the next time the property is queried, it will return the default color. + + + If you are a consumer of the colors in this class, then note that the colors returned + by properties in this class need to be reinitialized when the system color changes. + This class doesn't listen to the system color change event, instead it expects the consumer to notify it + when the system color changes. To avoid redundant updates by multiple consumers, a unique notification pattern + is recommended. + + + To notify system color changes, you should listen to the + event and call the method. The SysColorsChanged method will let you specify whether to + update the colors immediately or later with a call to . You should + choose to update immediately if you will use the new colors to update certain properties in your control (Backcolor, for example). + On the other hand, if you use the colors within and only within your Paint event, then update the colors later in + the beginning of your Paint method with a call to UpdateMenuColors. Note that the + UpdateMenuColors method will actually update the colors only if necessary, letting you call it multiple times + without performance hit. + + + There is also a event that gets fired whenever colors + are updated, either due to change in System Colors (notified using the above pattern) or when a custom color is set on any of the properties. + + + + + + Initializes default colors based on SystemColors. + + + Calling this will not affect the custom colors set using the properties. + + + + + Initializes the default colors. + + + + + Call this method to indicate that the system colors have changed. + + Indicates whether to update colors immediately or later with a call to . + + Take a look at the MenuColors class reference for the recommended system color change notification pattern. + + + + + Fired when the colors have changed either because of change in system colors or + when a custom color is specified using one of the properties. + + + Take a look at the class reference for this class for information on how to notify + this class regarding system color changes. + + + + + Gets / sets the selected color for a menu item in a toolbar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the selected text color for an item in a toolbar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the background color of a drop-down menu. + + + The default value is derived from a System Color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the color for the left aligned strip in a drop-down menu where images and check boxes are shown. + + + The default value is derived from a System Color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the selected-pressed color for a menu item in a toolbar. + + The default value is derived from a System Color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the selected color for a checked menu item in a toolbar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the border color for a selected menu item in a toolbar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the border color for a drop-down menu. + + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the background color for a toolbar / commandbar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the background color for the main-menu bar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the background color for the Status Bar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the Caption background color for a floating toolbar / commandbar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the Backcolor for the expanded, + left-aligned menu strip region. This is the region you see when a partial menu + gets expanded to show all the menu items. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the alpha-blend factor to use to shade the inactive menu item's icons. (255 for no alpha-blending; 0 will completely hide the item) + + A value in the range 1 to 255; -1 will reset to default value. Default is 175. + + 255 will draw the icon without any alpha blending; 1 will almost hide the icons. This setting will be ignored when XPThemes is turned on. + + + + + Gets / sets the text color base for the text in the disabled menu items. + + The default value is derived from a system color. + + When you specify a custom color, ControlPaint.LightLight will be applied on it before using that color. + + + + + Gets / sets the text color base for the text in the disabled toolbar items. + + The default value is derived from a system color. + + + + Gets / sets the text color of the menu and toolbar items. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color, the next time it is queried. + + + + + Gets / sets the active text color of the menu and toolbar items. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Initializes default colors based on SystemColors. + + + Calling this will not affect the custom colors set using the properties. + + + + + Initializes the default colors. + + + + + Fired when the colors have changed either because of change in system colors or + when a custom color is specified using one of the properties. + + + Take a look at the class reference for this class for information on how to notify + this class regarding system color changes. + + + + + Initializes default colors based on SystemColors. + + + Calling this will not affect the custom colors set using the properties. + + + + + + + + + + Gets a value indicating whether themed colors are used. + + true if themed colors are used, false otherwise. + + + + gets/sets color of right auto hide panel. + + + + + Gets/sets color of left AH panel. + + + + + Gets or sets the color of the panel. + + + + + Gets or sets the color of the border. + + + + + Gets or sets the color of the inner border. + + + + + Gets or sets the color of the tab item. + + + + + Gets or sets the color for border of the DropDownBarItem. + + + + + Gets or sets the light color of the DropDownBarItem. + + + + + Gets or sets the dark color of the DropDownBarItem. + + + + + Gets or sets the color for border of the menu. + + + + + Gets or sets the color for separator of the menu. + + + + + Gets or sets the color for border selected item of the menu. + + + + + Gets or sets the color for selected item of the menu. + + + + + Gets or sets the dark color for column of the menu. + + + + + Gets or sets the light color for column of the menu. + + + + + Gets or sets the color for check mark of the menu. + + + + + Gets or sets the color for selected check mark of the menu. + + + + + Gets or sets the background color of the menu. + + + + + Gets or sets border color of the BarItem. + + + + + Gets or sets border color of the pressed BarItem. + + + + + Gets or sets border color of the checked BarItem. + + + + + Gets or sets light color of the checked BarItem. + + + + + Gets or sets dark color of the checked BarItem. + + + + + Gets or sets light color of the BarItem. + + + + + Gets or sets dark color of the BarItem. + + + + + Gets or sets light color of the pressed BarItem. + + + + + Gets or sets dark color of the pressed BarItem. + + + + + Gets or sets color of the separator BarItem. + + + + + Gets or sets light color of the DockBar. + + + + + Gets or sets dark color of the DockBar. + + + + + Gets or sets light color for dropdown button of the CommandBar. + + + + + Gets or sets dark color for dropdown button of the CommandBar. + + + + + Gets or sets dark color of the CommandBar. + + + + + Gets or sets light color of the CommandBar. + + + + + Gets or sets color for border of the CommandBar. + + + + + Gets or sets light color for highlight dropdown button of the CommandBar. + + + + + Gets or sets dark color for highlight dropdown button of the CommandBar. + + + + + Gets or sets light color for pressed dropdown button of the CommandBar. + + + + + Gets or sets dark color for pressed dropdown button of the CommandBar. + + + + + Gets or sets color for pressed dropdown button of the floating CommandBar. + + + + + Gets or sets border color for pressed dropdown button of the floating CommandBar. + + + + + Gets or sets light color of the floating CommandBar. + + + + + Gets or sets dark color of the floating CommandBar. + + + + + Gets or sets color for light border of the floating CommandBar. + + + + + Gets or sets background color of the floating CommandBar. + + + + + Gets or sets color for border of the floating CommandBar. + + + + + Gets or sets color for caption text of the floating CommandBar. + + + + + Fired when the colors have changed either because of change in system colors or + when a custom color is specified using one of the properties. + + + Take a look at the class reference for this class for information on how to notify + this class regarding system color changes. + + + + + + + + + + Call this method to indicate that the system colors have changed. + + Indicates whether to update colors immediately or later with a call to . + + Follow the same system color change notification pattern as explained in the class reference. + + + + + Fired when the colors have changed either because of change in system colors or + when a custom color is specified using one of the properties. + + + Take a look at the class reference for this class for information on how to notify + this class regarding system color changes. + + + + + Gets / sets the selected color for a menu item in a drop-down menu. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the pressed-selected color for a menu item in a toolbar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the background color of a selected check box in the drop-down menu margin or a checked item in the toolbar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the background color of a check box in the drop-down menu margin or a checked item in the toolbar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the border color of a menu item selection in the drop-down menus and toolbars. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the border color of a drop-down menu. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the left-gradient color of the drop-down menu margin. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the right-gradient color of the drop-down menu margin. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the left-gradient color of the drop-down menu margin of the expanded menu items. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the right-gradient color of the drop-down menu margin of the expanded menu items. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the right-gradient color of docked bars. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the left-gradient color of docked bars. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the color of the gripper. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the light-gradient border color of bars. + + + + + Gets or sets the dark-gradient border color of bars. + + + + + Gets or sets the light-gradient color of menu item for hot-tracking. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the dark-gradient color of menu item for hot-tracking. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the light-gradient color of quick customize button when it is pressed. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the dark-gradient color of quick customize button when it is pressed. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the caption background color of floating bars. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the color for the floating command bar item which is pressed. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the light-gradient color of quick customize dropdown button. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the dark-gradient color of quick customize dropdown button. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the light-gradient highlight color of groupBarItem. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the dark-gradient highlight color of groupBarItem. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the light-gradient color of selected groupBarItem. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the dark-gradient color of selected groupBarItem. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the light-gradient highlight color of selected groupBarItem. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the dark-gradient highlight color of selected groupBarItem. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the light-gradient color of groupBar header. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the dark-gradient color of groupBar header. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the color of the text in a GroupBar item. + + + + + Gets / sets the highlight color to be used for the selected text of the GroupBar item. + + + + + Gets / sets the color of the separator line between the bar items. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Initializes colors based on Windows XP color scheme. + + + + + Used for drawing the tabControlAdv tabPanel background. + + + + + Used for drawing the active tabPage. + + + + + Used for drawing the active tabPage. + + + + + Used for drawing the inactive tabPage. + + + + + Used for drawing the inactive tabPage. + + + + + Used for drawing the highlighted tabPage. + + + + + Used for drawing the highlighted tabPage. + + + + + Used for drawing the borders of tabPages. + + + + + Used for drawing the borders of tabPages. + + + + + Used for drawing the borders of tabPages. + + + + + Provides colors for Office2007 visual style. + + + + + Colors for blue colorscheme of the Office2007 visual style. + + + + + Colors for silver colorscheme of the Office2007 visual style. + + + + + Colors for black colorscheme of the Office2007 visual style. + + + + + + + + + + Default colorscheme for office2007 visual style. + + + + + Base color for managed scheme. + + + + + Gets color table for Office2007 visual style. + + + + + Applies colors for managed scheme. + + Container form. + Base color for the managed theme. + + + + + + + + + + + Initialize colors general for all colorscheme of the Office2007 visual style. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets default colors for Office2007 visual style. + + + + + Gets or sets default colorscheme for office2007 visual style. + + + + + + + + + + + + + + + Gets or sets border color for date time picker control. + + + + + Gets or sets highlighted border color for date time picker control. + + + + + Gets or sets selected border color for date time picker control>. + + + + + Gets or sets a dropdown arrow color for date time picker control. + + + + + Gets or sets a dropdown gradient light color for date time picker control. + + + + + Gets or sets a dropdown gradient dark color for date time picker control. + + + + + Gets or sets a dropdown highlighted gradient light color for date time picker control. + + + + + Gets or sets a dropdown highlighted gradient dark color for date time picker control. + + + + + Gets or sets a dropdown selected gradient light color for date time picker control. + + + + + Gets or sets a dropdown selected gradient dark color for date time picker control. + + + + + Gets or sets a checkbox color for date time picker control. + + + + + Gets or sets a checkbox selected color for date time picker control. + + + + + Gets or sets a checkbox pushed border color for date time picker control. + + + + + Gets or sets a checkbox border color for date time picker control. + + + + + Gets or sets a checkbox inner rectangle border color for date time picker control. + + + + + Gets or sets a checkbox inner rectangle selected border color for date time picker control. + + + + + Gets or sets a checkbox inner rectangle pushed border color for date time picker control. + + + + + Gets or sets a checkbox inner rectangle filling color for date time picker control. + + + + + Gets or sets a checkbox inner rectangle filling selected color for date time picker control. + + + + + Gets or sets a checkbox inner rectangle filling pushed color for date time picker control. + + + + + Gets or sets highlighted fore color for date time picker control. + + + + + Gets or sets border color for numeric up down control. + + + + + Gets or sets highlighted border color for numeric updown control. + + + + + Gets or sets selected border color for numeric updown control. + + + + + Gets or sets dropdown arrow gradient light color for numeric updown control. + + + + + Gets or sets dropdown arrow gradient dark color for numeric updown control. + + + + + Gets or sets gradient start color for month calendar control. + + + + + Gets or sets gradient end color for month calendar control. + + + + + Gets or sets fore color for month calendar control. + + + + + Gets or sets border color for group bar control. + + + + + Gets or sets gradient dark color for group bar item control. + + + + + Gets or sets gradient light color for group bar item control. + + + + + Gets or sets group bar control's header gradient color dark. + + + + + Gets or sets group bar control's header gradient color light. + + + + + Gets or sets gradient highlight light color for group bar control. + + + + + Gets or sets gradient highlight dark color for group bar control. + + + + + Gets or sets gradient selected dark color for group bar control. + + + + + Gets or sets gradient selected light color for group bar control. + + + + + Gets or sets gradient selected dark color for the upper part of group bar item control. + + + + + Gets or sets gradient selected light color for the upper part of group bar item control. + + + + + Gets or sets gradient highlighted and selected dark color for group bar control. + + + + + Gets or sets gradient highlighted and selected light color for group bar control. + + + + + Gets or sets text color for group bar item control. + + + + + Gets or sets group bar control's header text color. + + + + + Gets or sets gradient dark color for splitter of group bar control. + + + + + Gets or sets gradient light color for splitter of group bar control. + + + + + Gets or sets the client area background color of group bar control. + + + + + Gets or sets the color for the internal border of XP task panel. + + + + + Gets or sets the color for the border of XP task panel. + + + + + Gets or sets the back color for XP task page. + + + + + Gets or sets the color for border of the menu. + + + + + Gets or sets the color for separator of the menu. + + + + + Gets or sets the dark color for highlighted item of the menu. + + + + + Gets or sets the light color for highlighted item of the menu. + + + + + Gets or sets the border color for highlighted item of the menu. + + + + + Gets or sets the dark color for column of the menu. + + + + + Gets or sets the separator color for column of the menu. + + + + + Gets or sets the light color for arrow of the menu item. + + + + + Gets or sets the dark color for arrow of the menu item. + + + + + Gets or sets the color for check mark of the menu. + + + + + Gets or sets the background color for check mark of the menu. + + + + + Gets or sets the color for border check mark of the menu. + + + + + Gets or sets the border color for TextBox item of the menu. + + + + + Gets or sets the background color for TextBox item of the menu. + + + + + Gets or sets the color for ComboButton of the menu. + + + + + Gets or sets the color for ComboButton of the menu. + + + + + Gets or sets the color for ComboButton of the menu. + + + + + Gets or sets the color for ComboButton of the menu. + + + + + Gets or sets the light color for highlighted ComboButton of the menu. + + + + + Gets or sets the dark color for highlighted ComboButton of the menu. + + + + + Gets or sets the color for arrow ComboButton of the menu. + + + + + Gets or sets the background color of the menu. + + + + + Gets or sets light color for dropdown button of the CommandBar. + + + + + Gets or sets dark color for dropdown button of the CommandBar. + + + + + Gets or sets dark color of the CommandBar. + + + + + Gets or sets light color of the CommandBar. + + + + + Gets or sets color for border of the CommandBar. + + + + + Gets or sets background color of the DockBar. + + + + + Gets or sets light color for highlight dropdown button of the CommandBar. + + + + + Gets or sets dark color for highlight dropdown button of the CommandBar. + + + + + Gets or sets light color for pressed dropdown button of the CommandBar. + + + + + Gets or sets dark color for pressed dropdown button of the CommandBar. + + + + + Gets or sets color for highlighted dropdown button of the floating CommandBar. + + + + + Gets or sets border color for highlighted dropdown button of the floating CommandBar. + + + + + Gets or sets color for pressed dropdown button of the floating CommandBar. + + + + + Gets or sets border color for pressed dropdown button of the floating CommandBar. + + + + + Gets or sets border color for pressed close button of the floating CommandBar. + + + + + Gets or sets color for pressed close button of the floating CommandBar. + + + + + Gets or sets light color of the floating CommandBar. + + + + + Gets or sets dark color of the floating CommandBar. + + + + + Gets or sets color for light border of the floating CommandBar. + + + + + Gets or sets background color of the floating CommandBar. + + + + + Gets or sets color for border of the floating CommandBar. + + + + + Gets or sets color for caption text of the floating CommandBar. + + + + + Gets or sets color for separator line of the CommandBar. + + + + + Gets or sets color for pressed border of the BarItem. + + + + + Gets or sets color for highlighted border of the BarItem. + + + + + Gets or sets light color for background of the BarItem. + + + + + Gets or sets dark color for background of the BarItem. + + + + + Gets or sets light color for background of the DropDownBarItem. + + + + + Gets or sets dark color for background of the DropDownBarItem. + + + + + Gets or sets color for border of the DropDownBarItem. + + + + + Gets or sets light color for background of the checked BarItem. + + + + + Gets or sets dark color for background of the checked BarItem. + + + + + Gets or sets color for border of the checked BarItem. + + + + + Gets or sets color for flash of the checked BarItem. + + + + + Gets or sets color for flash of the pressed BarItem. + + + + + Gets or sets color for flash of the selected BarItem. + + + + + Gets or sets back color for the TextBoxBarItem. + + + + + Gets or sets color for border of the TextBoxBarItem. + + + + + Gets or sets color for border of the highlight TextBoxBarItem. + + + + + Gets or sets light color for ComboButton of the ComboBoxBarItem. + + + + + Gets or sets dark color for ComboButton of the ComboBoxBarItem. + + + + + Gets or sets light color for ComboButton of the pressed ComboBoxBarItem. + + + + + Gets or sets dark color for ComboButton of the pressed ComboBoxBarItem. + + + + + Gets or sets light color for ComboButton of the highlighted ComboBoxBarItem. + + + + + Gets or sets dark color for ComboButton of the highlighted ComboBoxBarItem. + + + + + Gets or sets border color for ComboButton of the ComboBoxBarItem. + + + + + Gets or sets border color for ComboButton of the pressed ComboBoxBarItem. + + + + + Gets or sets border color for ComboButton of the highlighted ComboBoxBarItem. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the arrow start color for UpDownButtons. + + + + + Gets the arrow end color for UpDownButtons. + + + + + Gets the border color for UpDownButtons in normal state. + + + + + Gets the background color for UpDownButtons in normal state. + + + + + Gets the background start color for UpDownButtons in normal state. + + + + + Gets the background end color for UpDownButtons in normal state. + + + + + Gets the border color for UpDownButtons in hot state. + + + + + Gets the inner border start color for UpDownButtons in hot state. + + + + + Gets the inner border end color for UpDownButtons in hot state. + + + + + Gets the border color for UpDownButtons in pressed state. + + + + + Gets the inner border start color for UpDownButtons in pressed state. + + + + + Gets the inner border end color for UpDownButtons in pressed state. + + + + + Gets the background start color for UpDownButtons in disabled state. + + + + + Gets the background end color for UpDownButtons in disabled state. + + + + + Gets the border color for UpDownButtons in disabled state. + + + + + Gets the background top start color for UpDownButtons in hot state. + + + + + Gets the background top end color for UpDownButtons in hot state. + + + + + Gets the background bottom start color for UpDownButtons in hot state. + + + + + Gets the background bottom end color for UpDownButtons in hot state. + + + + + Gets the background top start color for UpDownButtons in pressed state. + + + + + Gets the background top end color for UpDownButtons in pressed state. + + + + + Gets the background bottom start color for UpDownButtons in pressed state. + + + + + Gets the background bottom end color for UpDownButtons in pressed state. + + + + + Gets or sets the back color for ComboBox control. + + + + + Gets or sets the back color for the selected ComboBox control. + + + + + Gets or sets the border color for ComboBox control. + + + + + Gets or sets the border color for the selected ComboBox control. + + + + + Gets or sets the border color for the pushed ComboBox control. + + + + + Gets or sets the color for upper line of the dropdown button of ComboBox control. + + + + + Gets or sets the color for the arrow of ComboBox control. + + + + + Gets or sets the color for lower line of the arrow of ComboBox control. + + + + + Used in drawing of the hot background of dropdown button of ComboBox control. + + + + + Used in drawing of the hot background of dropdown button of ComboBox control. + + + + + Used in drawing of the hot background of dropdown button of ComboBox control. + + + + + Used in drawing of the hot background of dropdown button of ComboBox control. + + + + + Used in drawing of the normal background of dropdown button of ComboBox control. + + + + + Used in drawing of the normal background of dropdown button of ComboBox control. + + + + + Used in drawing of the normal background of dropdown button of ComboBox control. + + + + + Used in drawing of the normal background of dropdown button of ComboBox control. + + + + + Used in drawing of the pushed background of dropdown button of ComboBox control. + + + + + Used in drawing of the pushed background of dropdown button of ComboBox control. + + + + + Used in drawing of the pushed background of dropdown button of ComboBox control. + + + + + Used in drawing of the pushed background of dropdown button of ComboBox control. + + + + + Used in drawing of CheckBox control. + + + + + Used in drawing of CheckBox control. + + + + + Used in drawing of CheckBox control. + + + + + Used in drawing of the normal border of CheckBox control. + + + + + Used in drawing of the selected border of CheckBox control. + + + + + Used in drawing of the pushed border of CheckBox control. + + + + + Used in drawing of the normal internal border of CheckBox control. + + + + + Used in drawing of the selected internal border of CheckBox control. + + + + + Used in drawing of the pushed internal border of CheckBox control. + + + + + Used in drawing of the normal internal rectangle border of CheckBox control. + + + + + Used in drawing of the selected internal rectangle border of CheckBox control. + + + + + Used in drawing of the pushed internal rectangle border of CheckBox control. + + + + + Used in drawing of the normal internal rectangle of CheckBox control. + + + + + Used in drawing of the selected internal rectangle of CheckBox control. + + + + + Used in drawing of the pushed internal rectangle of CheckBox control. + + + + + Used in drawing of the normal tick of CheckBox control. + + + + + Used in drawing of the selected tick of CheckBox control. + + + + + Used in drawing of the pushed tick of CheckBox control. + + + + + Used in drawing of the disabled tick of CheckBox control. + + + + + Used in drawing of the indeterminate rectangle of CheckBox control. + + + + + Used in drawing of the disabled back color CheckBox control. + + + + + Used in drawing of the disabled border CheckBox control. + + + + + Used in drawing of the disabled internal border CheckBox control. + + + + + Used in drawing of Radio button control. + + + + + Used in drawing of the border of Radio button control. + + + + + Used in drawing of the internal border of Radio button control. + + + + + Used in drawing of Radio button control. + + + + + Used in drawing of the border of Radio button control. + + + + + Used in drawing of the internal border of Radio button control. + + + + + Used in drawing of Radio button control. + + + + + Used in drawing of the border of Radio button control. + + + + + Used in drawing of the internal border of Radio button control. + + + + + Used in drawing of the border of check mark of Radio button control. + + + + + Used in drawing of check mark of Radio button control. + + + + + Used in drawing of check mark of Radio button control. + + + + + Used in drawing of check mark of Radio button control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of XP taskbar. + + + + + Used in drawing of XP taskbar. + + + + + Used in drawing of XP taskbar. + + + + + Used in drawing of XP taskbar. + + + + + Used in drawing of XP taskbar. + + + + + Used in drawing of XP taskbar. + + + + + Used in drawing of XP taskbar. + + + + + Used in drawing of XP taskbar. + + + + + Used in drawing of Color UI control. + + + + + Used in drawing of Color UI control. + + + + + Used in drawing of Color UI control. + + + + + Used in drawing of Color UI control. + + + + + Used in drawing of Color UI control. + + + + + Used in drawing of Color UI control. + + + + + Used in drawing of Color UI control. + + + + + Used in drawing of Rating control. + + + + + Used in drawing of Rating control. + + + + + Used in drawing of Rating control. + + + + + Used in drawing of Rating control. + + + + + Used in drawing of Rating control. + + + + + Used in drawing of Rating control. + + + + + Used in drawing of Rating control. + + + + + Used in drawing of Rating control. + + + + + Arguments class for event. + + + + + Initializes instance. + + Container form. + Base color for the managed theme. + + + + Container form. + + + + + Base color for the managed theme. + + + + + Provides colors for blue colorscheme of the Office2007 visual style. + + + + + Initialize colors for Blue colorscheme of the Office2007 visual style. + + + + + Provides colors for silver colorscheme of the Office2007 visual style. + + + + + Initialize colors for Silver colorscheme of the Office2007 visual style. + + + + + Provides colors for black colorscheme of the Office2007 visual style. + + + + + Initialize colors for Black colorscheme of the Office2007 visual style. + + + + + Gets a value indicating whether themed colors are used. + + true if themed colors are used, false otherwise. + + + + gets/sets color of right auto hide panel. + + + + + Gets/sets color of left AH panel. + + + + + Gets or sets the color of the panel. + + + + + Gets or sets the color of the border. + + + + + Gets or sets the color of the inner border. + + + + + Gets or sets the color of the tab item. + + + + + Gets or sets the color for border of the DropDownBarItem. + + + + + Gets or sets the light color of the DropDownBarItem. + + + + + Gets or sets the dark color of the DropDownBarItem. + + + + + Gets or sets the color for border of the menu. + + + + + Gets or sets the color for separator of the menu. + + + + + Gets or sets the color for border selected item of the menu. + + + + + Gets or sets the color for selected item of the menu. + + + + + Gets or sets the color for column of the menu. + + + + + Gets or sets the color for check mark of the menu. + + + + + Gets or sets the color for selected check mark of the menu. + + + + + Gets or sets the color for check mark border of the menu. + + + + + Gets or sets the color for selected check mark border of the menu. + + + + + Gets or sets the background color of the menu. + + + + + Gets or sets border color of the BarItem. + + + + + Gets or sets border color of the pressed BarItem. + + + + + Gets or sets border color of the checked BarItem. + + + + + Gets or sets light color of the checked BarItem. + + + + + Gets or sets dark color of the checked BarItem. + + + + + Gets or sets light color of the BarItem. + + + + + Gets or sets dark color of the BarItem. + + + + + Gets or sets light color of the pressed BarItem. + + + + + Gets or sets dark color of the pressed BarItem. + + + + + Gets or sets light color for highlight dropdown button of the CommandBar. + + + + + Gets or sets dark color for highlight dropdown button of the CommandBar. + + + + + Gets or sets light color for pressed dropdown button of the CommandBar. + + + + + Gets or sets dark color for pressed dropdown button of the CommandBar. + + + + + Gets or sets light color for CombobBox button. + + + + + Gets or sets dark color for CombobBox button. + + + + + Gets a value indicating whether themed colors are used. + + true if themed colors are used, false otherwise. + + + + gets/sets color of right auto hide panel. + + + + + Gets/sets color of left AH panel. + + + + + Gets or sets the color of the panel. + + + + + Gets or sets the color of the border. + + + + + Gets or sets the color of the inner border. + + + + + Gets or sets the color of the tab item. + + + + + Gets or sets the color for border of the DropDownBarItem. + + + + + Gets or sets the light color of the DropDownBarItem. + + + + + Gets or sets the dark color of the DropDownBarItem. + + + + + Gets or sets the color for border of the menu. + + + + + Gets or sets the color for separator of the menu. + + + + + Gets or sets the color for border selected item of the menu. + + + + + Gets or sets the color for selected item of the menu. + + + + + Gets or sets the color for column of the menu. + + + + + Gets or sets the color for check mark of the menu. + + + + + Gets or sets the color for selected check mark of the menu. + + + + + Gets or sets the color for check mark border of the menu. + + + + + Gets or sets the color for selected check mark border of the menu. + + + + + Gets or sets the background color of the menu. + + + + + Gets or sets border color of the BarItem. + + + + + Gets or sets border color of the pressed BarItem. + + + + + Gets or sets border color of the checked BarItem. + + + + + Gets or sets light color of the checked BarItem. + + + + + Gets or sets dark color of the checked BarItem. + + + + + Gets or sets light color of the BarItem. + + + + + Gets or sets dark color of the BarItem. + + + + + Gets or sets light color of the pressed BarItem. + + + + + Gets or sets dark color of the pressed BarItem. + + + + + Gets or sets light color for highlight dropdown button of the CommandBar. + + + + + Gets or sets dark color for highlight dropdown button of the CommandBar. + + + + + Gets or sets light color for pressed dropdown button of the CommandBar. + + + + + Gets or sets dark color for pressed dropdown button of the CommandBar. + + + + + Gets or sets light color for CombobBox button. + + + + + Gets or sets dark color for CombobBox button. + + + + + Provides colors for blue colorscheme of the Office2010 visual style. + + + + + Provides colors for Office2010 visual style. + + + + + Colors for blue colorscheme of the Office2010 visual style. + + + + + Colors for silver colorscheme of the Office2010 visual style. + + + + + Colors for black colorscheme of the Office2010 visual style. + + + + + + + + + + Default colorscheme for office2010 visual style. + + + + + Base color for managed scheme. + + + + + Gets color table for Office2010 visual style. + + + + + Applies colors for managed scheme. + + Container form. + Base color for the managed theme. + + + + + + + + + + + Initialize colors general for all colorscheme of the Office2010 visual style. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets default colors for Office2010 visual style. + + + + + Gets or sets default colorscheme for office2010 visual style. + + + + + + + + + + + + + + + Gets or sets border color for Date time picker control. + + + + + Gets or sets highlighted border color for Date time picker control. + + + + + Gets or sets selected border color for Date time picker control. + + + + + Gets or sets a dropdown arrow color for Date time picker control. + + + + + Gets or sets a dropdown gradient light color for Date time picker control. + + + + + Gets or sets a dropdown gradient dark color for Date time picker control. + + + + + Gets or sets a dropdown highlighted gradient light color for Date time picker control. + + + + + Gets or sets a dropdown highlighted gradient dark color for Date time picker control. + + + + + Gets or sets a dropdown selected gradient light color for Date time picker control. + + + + + Gets or sets a dropdown selected gradient dark color for Date time picker control. + + + + + Gets or sets a checkbox color for Date time picker control. + + + + + Gets or sets a checkbox selected color for Date time picker control. + + + + + Gets or sets a checkbox pushed border color for Date time picker control. + + + + + Gets or sets a checkbox border color for Date time picker control. + + + + + Gets or sets a checkbox inner rectangle border color for Date time picker control. + + + + + Gets or sets a checkbox inner rectangle selected border color for Date time picker control. + + + + + Gets or sets a checkbox inner rectangle pushed border color for Date time picker control. + + + + + Gets or sets a checkbox inner rectangle filling color for Date time picker control. + + + + + Gets or sets a checkbox inner rectangle filling selected color for Date time picker control. + + + + + Gets or sets a checkbox inner rectangle filling pushed color for Date time picker control. + + + + + Gets or sets highlighted fore color for Date time picker control. + + + + + Gets or sets border color for numeric updown control. + + + + + Gets or sets highlighted border color for numeric updown control. + + + + + Gets or sets selected border color for numeric updown control. + + + + + Gets or sets dropdown arrow gradient light color for numeric updown control. + + + + + Gets or sets dropdown arrow gradient dark color for numeric updown control. + + + + + Gets or sets gradient start color for month calendar control. + + + + + Gets or sets gradient end color for month calendar control. + + + + + Gets or sets gradient end color for month calendar control. + + + + + Gets or sets fore color for month calendar control. + + + + + Gets or sets border color for group bar control. + + + + + Gets or sets gradient dark color for group bar item control. + + + + + Gets or sets gradient light color for group bar item control. + + + + + Gets or sets group bar control's header gradient color dark. + + + + + Gets or sets group bar control's header gradient color light. + + + + + Gets or sets gradient highlight light color for group bar control. + + + + + Gets or sets gradient highlight dark color for group bar control. + + + + + Gets or sets gradient selected dark color for group bar control. + + + + + Gets or sets gradient selected light color for group bar control. + + + + + Gets or sets gradient selected dark color for the upper part of group bar item control. + + + + + Gets or sets gradient selected light color for the upper part of group bar item control. + + + + + Gets or sets gradient highlighted and selected dark color for group bar control. + + + + + Gets or sets gradient highlighted and selected light color for group bar control. + + + + + Gets or sets text color for group bar item control. + + + + + Gets or sets Back color for group bar item control. + + + + + Gets or sets group bar control's header text color. + + + + + Gets or sets gradient dark color for splitter of group bar control. + + + + + Gets or sets gradient light color for splitter of group bar control. + + + + + Gets or sets the client area background color of group bar control. + + + + + Gets or sets the color for the internal border of XP task panel. + + + + + Gets or sets the color for the border of XP task panel. + + + + + Gets or sets the back color for XP task page. + + + + + Gets or sets the color for border of the menu. + + + + + Gets or sets the color for separator of the menu. + + + + + Gets or sets the dark color for highlighted item of the menu. + + + + + Gets or sets the light color for highlighted item of the menu. + + + + + Gets or sets the border color for highlighted item of the menu. + + + + + Gets or sets the dark color for column of the menu. + + + + + Gets or sets the separator color for column of the menu. + + + + + Gets or sets the light color for arrow of the menu item. + + + + + Gets or sets the dark color for arrow of the menu item. + + + + + Gets or sets the color for check mark of the menu. + + + + + Gets or sets the background color for check mark of the menu. + + + + + Gets or sets the color for border check mark of the menu. + + + + + Gets or sets the border color for TextBox item of the menu. + + + + + Gets or sets the background color for TextBox item of the menu. + + + + + Gets or sets the color for ComboButton of the menu. + + + + + Gets or sets the color for ComboButton of the menu. + + + + + Gets or sets the color for ComboButton of the menu. + + + + + Gets or sets the color for ComboButton of the menu. + + + + + Gets or sets the light color for highlighted ComboButton of the menu. + + + + + Gets or sets the dark color for highlighted ComboButton of the menu. + + + + + Gets or sets the color for arrow ComboButton of the menu. + + + + + Gets or sets the background color of the menu. + + + + + Gets or sets light color for dropdown button of the CommandBar. + + + + + Gets or sets dark color for dropdown button of the CommandBar. + + + + + Gets or sets dark color of the CommandBar. + + + + + Gets or sets light color of the CommandBar. + + + + + Gets or sets color for border of the CommandBar. + + + + + Gets or sets background color of the DockBar. + + + + + Gets or sets light color for highlight dropdown button of the CommandBar. + + + + + Gets or sets dark color for highlight dropdown button of the CommandBar. + + + + + Gets or sets light color for pressed dropdown button of the CommandBar. + + + + + Gets or sets dark color for pressed dropdown button of the CommandBar. + + + + + Gets or sets color for highlighted dropdown button of the floating CommandBar. + + + + + Gets or sets border color for highlighted dropdown button of the floating CommandBar. + + + + + Gets or sets color for pressed dropdown button of the floating CommandBar. + + + + + Gets or sets border color for pressed dropdown button of the floating CommandBar. + + + + + Gets or sets border color for pressed close button of the floating CommandBar. + + + + + Gets or sets color for pressed close button of the floating CommandBar. + + + + + Gets or sets light color of the floating CommandBar. + + + + + Gets or sets dark color of the floating CommandBar. + + + + + Gets or sets color for light border of the floating CommandBar. + + + + + Gets or sets background color of the floating CommandBar. + + + + + Gets or sets color for border of the floating CommandBar. + + + + + Gets or sets color for caption text of the floating CommandBar. + + + + + Gets or sets color for separator line of the CommandBar. + + + + + Gets or sets color for pressed border of the BarItem. + + + + + Gets or sets color for highlighted border of the BarItem. + + + + + Gets or sets light color for background of the BarItem. + + + + + Gets or sets dark color for background of the BarItem. + + + + + Gets or sets light color for background of the DropDownBarItem. + + + + + Gets or sets dark color for background of the DropDownBarItem. + + + + + Gets or sets color for border of the DropDownBarItem. + + + + + Gets or sets light color for background of the checked BarItem. + + + + + Gets or sets dark color for background of the checked BarItem. + + + + + Gets or sets color for border of the checked BarItem. + + + + + Gets or sets color for flash of the checked BarItem. + + + + + Gets or sets color for flash of the pressed BarItem. + + + + + Gets or sets color for flash of the selected BarItem. + + + + + Gets or sets back color for the TextBoxBarItem. + + + + + Gets or sets color for border of the TextBoxBarItem. + + + + + Gets or sets color for border of the highlight TextBoxBarItem. + + + + + Gets or sets light color for ComboButton of the ComboBoxBarItem. + + + + + Gets or sets dark color for ComboButton of the ComboBoxBarItem. + + + + + Gets or sets light color for ComboButton of the pressed ComboBoxBarItem. + + + + + Gets or sets dark color for ComboButton of the pressed ComboBoxBarItem. + + + + + Gets or sets light color for ComboButton of the highlighted ComboBoxBarItem. + + + + + Gets or sets dark color for ComboButton of the highlighted ComboBoxBarItem. + + + + + Gets or sets border color for ComboButton of the ComboBoxBarItem. + + + + + Gets or sets border color for ComboButton of the pressed ComboBoxBarItem. + + + + + Gets or sets border color for ComboButton of the highlighted ComboBoxBarItem. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the arrow start color for UpDownButtons. + + + + + Gets the arrow end color for UpDownButtons. + + + + + Gets the border color for UpDownButtons in normal state. + + + + + Gets the background color for UpDownButtons in normal state. + + + + + Gets the background start color for UpDownButtons in normal state. + + + + + Gets the background end color for UpDownButtons in normal state. + + + + + Gets the border color for UpDownButtons in hot state. + + + + + Gets the inner border start color for UpDownButtons in hot state. + + + + + Gets the inner border end color for UpDownButtons in hot state. + + + + + Gets the border color for UpDownButtons in pressed state. + + + + + Gets the inner border start color for UpDownButtons in pressed state. + + + + + Gets the inner border end color for UpDownButtons in pressed state. + + + + + Gets the background start color for UpDownButtons in disabled state. + + + + + Gets the background end color for UpDownButtons in disabled state. + + + + + Gets the border color for UpDownButtons in disabled state. + + + + + Gets the background top start color for UpDownButtons in hot state. + + + + + Gets the background top end color for UpDownButtons in hot state. + + + + + Gets the background bottom start color for UpDownButtons in hot state. + + + + + Gets the background bottom end color for UpDownButtons in hot state. + + + + + Gets the background top start color for UpDownButtons in pressed state. + + + + + Gets the background top end color for UpDownButtons in pressed state. + + + + + Gets the background bottom start color for UpDownButtons in pressed state. + + + + + Gets the background bottom end color for UpDownButtons in pressed state. + + + + + Gets or sets the back color for ComboBox control. + + + + + Gets or sets the back color for the selected ComboBox control. + + + + + Gets or sets the border color for ComboBox control. + + + + + Gets or sets the border color for the selected ComboBox control. + + + + + Gets or sets the border color for the pushed ComboBox control. + + + + + Gets or sets the color for upper line of the dropdown button of ComboBox control. + + + + + Gets or sets the color for the arrow of ComboBox control. + + + + + Gets or sets the color for lower line of the arrow of ComboBox control. + + + + + Used in drawing of the hot background of dropdown button of ComboBox control. + + + + + Used in drawing of the hot background of dropdown button of ComboBox control. + + + + + Used in drawing of the hot background of dropdown button of ComboBox control. + + + + + Used in drawing of the hot background of dropdown button of ComboBox control. + + + + + Used in drawing of the normal background of dropdown button of ComboBox control. + + + + + Used in drawing of the normal background of dropdown button of ComboBox control. + + + + + Used in drawing of the normal background of dropdown button of ComboBox control. + + + + + Used in drawing of the normal background of dropdown button of ComboBox control. + + + + + Used in drawing of the pushed background of dropdown button of ComboBox control. + + + + + Used in drawing of the pushed background of dropdown button of ComboBox control. + + + + + Used in drawing of the pushed background of dropdown button of ComboBox control. + + + + + Used in drawing of the pushed background of dropdown button of ComboBox control. + + + + + Used in drawing of CheckBox control. + + + + + Used in drawing of CheckBox control. + + + + + Used in drawing of CheckBox control. + + + + + Used in drawing of the normal border of CheckBox control. + + + + + Used in drawing of the selected border of CheckBox control. + + + + + Used in drawing of the pushed border of CheckBox control. + + + + + Used in drawing of the normal internal border of CheckBox control. + + + + + Used in drawing of the selected internal border of CheckBox control. + + + + + Used in drawing of the pushed internal border of CheckBox control. + + + + + Used in drawing of the normal internal rectangle border of CheckBox control. + + + + + Used in drawing of the selected internal rectangle border of CheckBox control. + + + + + Used in drawing of the pushed internal rectangle border of CheckBox control. + + + + + Used in drawing of the normal internal rectangle of CheckBox control. + + + + + Used in drawing of the selected internal rectangle of CheckBox control. + + + + + Used in drawing of the pushed internal rectangle of CheckBox control. + + + + + Used in drawing of the normal tick of CheckBox control. + + + + + Used in drawing of the selected tick of CheckBox control. + + + + + Used in drawing of the pushed tick of CheckBox control. + + + + + Used in drawing of the disabled tick of CheckBox control. + + + + + Used in drawing of the indeterminate rectangle of CheckBox control. + + + + + Used in drawing of the disabled back color CheckBox control. + + + + + Used in drawing of the disabled border CheckBox control. + + + + + Used in drawing of the disabled internal border CheckBox control. + + + + + Used in drawing of Radio button control. + + + + + Used in drawing of the border of Radio button control. + + + + + Used in drawing of the internal border of Radio button control. + + + + + Used in drawing of Radio button control. + + + + + Used in drawing of the border of Radio button control. + + + + + Used in drawing of the internal border of Radio button control. + + + + + Used in drawing of Radio button control. + + + + + Used in drawing of the border of Radio button control. + + + + + Used in drawing of the internal border of Radio button control. + + + + + Used in drawing of the border of check mark of Radio button control. + + + + + Used in drawing of check mark of Radio button control. + + + + + Used in drawing of check mark of Radio button control. + + + + + Used in drawing of check mark of Radio button control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of Tab bar splitter control. + + + + + Used in drawing of XP taskbar. + + + + + Used in drawing of XP taskbar. + + + + + Used in drawing of XP taskbar. + + + + + Used in drawing of XP taskbar. + + + + + Used in drawing of XP taskbar. + + + + + Used in drawing of XP taskbar. + + + + + Used in drawing of XP taskbar. + + + + + Used in drawing of XP taskbar. + + + + + Used in drawing of Color UI control. + + + + + Used in drawing of Color UI control. + + + + + Used in drawing of Color UI control. + + + + + Used in drawing of Color UI control. + + + + + Used in drawing of Color UI control. + + + + + Used in drawing of Color UI control. + + + + + Used in drawing of Color UI control. + + + + + Used in drawing of Rating control. + + + + + Used in drawing of Rating control. + + + + + Used in drawing of Rating control. + + + + + Used in drawing of Rating control. + + + + + Used in drawing of Rating control. + + + + + Used in drawing of Rating control. + + + + + Used in drawing of Rating control. + + + + + Used in drawing of Rating control. + + + + + Arguments class for event. + + + + + Initializes instance. + + Container form. + Base color for the managed theme. + + + + Container form. + + + + + Base color for the managed theme. + + + + + Initialize colors for Blue colorscheme of the Office2010 visual style. + + + + + Provides colors for silver colorscheme of the Office2010 visual style. + + + + + Initialize colors for Silver colorscheme of the Office2010 visual style. + + + + + Provides colors for black colorscheme of the Office2010 visual style. + + + + + Initialize colors for Black colorscheme of the Office2010 visual style. + + + + + Colors for silver colorscheme of the metro visual style. + + + + + Colors for black colorscheme of the metro visual style. + + + + + Colors for blue colorscheme of the metro visual style. + + + + + Colors for blue colorscheme of the metro visual style. + + + + /// + Colors for blue colorscheme of the metro visual style. + + + + + Colors for blue colorscheme of the metro visual style. + + + + + Colors for blue colorscheme of the metro visual style. + + + + + Colors for blue colorscheme of the metro visual style. + + + + + Colors for blue colorscheme of the metro visual style. + + + + + Colors for managed colorscheme of the metro visual style. + + + + + Default colorscheme for metro visual style. + + + + + Base color for managed scheme. + + + + + Gets color table for Metro Color. + + + + + Applies colors for managed scheme. + + Container form. + Base color for the managed theme. + + + + + + + + + + + Initialize colors general for all colorscheme of the Metro visual style. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets default colors for metro visual style. + + + + + Gets or sets default colorscheme for metro visual style. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets the back color for ComboBox control. + + + + + Gets or sets the back color for the selected ComboBox control. + + + + + Gets or sets the border color for ComboBox control. + + + + + Gets or sets the border color for the selected ComboBox control. + + + + + Gets or sets the border color for the pushed ComboBox control. + + + + + Gets or sets the color for upper line of the dropdown button of ComboBox control. + + + + + Gets or sets the color for the arrow of ComboBox control. + + + + + Gets or sets the color for lower line of the arrow of ComboBox control. + + + + + Used in drawing of the hot background of dropdown button of ComboBox control. + + + + + Used in drawing of the hot background of dropdown button of ComboBox control. + + + + + Used in drawing of the hot background of dropdown button of ComboBox control. + + + + + Used in drawing of the hot background of dropdown button of ComboBox control. + + + + + Used in drawing of the normal background of dropdown button of ComboBox control. + + + + + Used in drawing of the normal background of dropdown button of ComboBox control. + + + + + Used in drawing of the normal background of dropdown button of ComboBox control. + + + + + Used in drawing of the normal background of dropdown button of ComboBox control. + + + + + Used in drawing of the pushed background of dropdown button of ComboBox control. + + + + + Used in drawing of the pushed background of dropdown button of ComboBox control. + + + + + Used in drawing of the pushed background of dropdown button of ComboBox control. + + + + + Used in drawing of the pushed background of dropdown button of ComboBox control. + + + + + Used in drawing of the background of dropdown list item of ComboBox control. + + + + + Used in drawing of the background of dropdown list item Top of ComboBox control. + + + + + Used in drawing of the background of dropdown list item of ComboBox control. + + + + + Used in drawing of the background of dropdown list item of ComboBox control. + + + + + Used in drawing of the background of dropdown list item of ComboBox control. + + + + + Used in drawing of the background of dropdown list item of ComboBox control. + + + + + Used in drawing of the background of dropdown list item of ComboBox control. + + + + + Used in drawing of CheckBox control. + + + + + Used in drawing of CheckBox control. + + + + + Used in drawing of CheckBox control. + + + + + Used in drawing of the normal border of CheckBox control. + + + + + Used in drawing of the selected border of CheckBox control. + + + + + Used in drawing of the pushed border of CheckBox control. + + + + + Used in drawing of the normal internal border of CheckBox control. + + + + + Used in drawing of the selected internal border of CheckBox control. + + + + + Used in drawing of the pushed internal border of CheckBox control. + + + + + Used in drawing of the normal internal rectangle border of CheckBox control. + + + + + Used in drawing of the selected internal rectangle border of CheckBox control. + + + + + Used in drawing of the pushed internal rectangle border of CheckBox control. + + + + + Used in drawing of the normal internal rectangle of CheckBox control. + + + + + Used in drawing of the selected internal rectangle of CheckBox control. + + + + + Used in drawing of the pushed internal rectangle of CheckBox control. + + + + + Used in drawing of the normal tick of CheckBox control. + + + + + Used in drawing of the selected tick of CheckBox control. + + + + + Used in drawing of the pushed tick of CheckBox control. + + + + + Used in drawing of the disabled tick of CheckBox control. + + + + + Used in drawing of the indeterminate rectangle of CheckBox control. + + + + + Used in drawing of the disabled back color CheckBox control. + + + + + Used in drawing of the disabled border CheckBox control. + + + + + Used in drawing of the disabled internal border CheckBox control. + + + + + Used in drawing of Radio button control. + + + + + Used in drawing of the border of Radio button control. + + + + + Used in drawing of the internal border of Radio button control. + + + + + Used in drawing of Radio button control. + + + + + Used in drawing of the border of Radio button control. + + + + + Used in drawing of the internal border of Radio button control. + + + + + Used in drawing of Radio button control. + + + + + Used in drawing of the border of Radio button control. + + + + + Used in drawing of the internal border of Radio button control. + + + + + Used in drawing of the border of check mark of Radio button control. + + + + + Used in drawing of check mark of Radio button control. + + + + + Used in drawing of check mark of Radio button control. + + + + + Used in drawing of check mark of Radio button control. + + + + + Arguments class for event. + + + + + Initializes instance. + + Container form. + Base color for the managed theme. + + + + Container form. + + + + + Base color for the managed theme. + + + + + Provides colors for Magenta colorscheme of the Metro visual style. + + + + + Initialize colors for Magenta colorscheme of the Metro visual style. + + + + + Provides colors for Orange colorscheme of the Metro visual style. + + + + + Initialize colors for Blue colorscheme of the Metro visual style. + + + + + Provides colors for Teal colorscheme of the Metro visual style. + + + + + Initialize colors for Teal colorscheme of the Metro visual style. + + + + + Provides colors for Brown colorscheme of the Metro visual style. + + + + + Initialize colors for Brown colorscheme of the Metro visual style. + + + + + Provides colors for Lime colorscheme of the Metro visual style. + + + + + Initialize colors for Lime colorscheme of the Metro visual style. + + + + + Provides colors for Purple colorscheme of the Metro visual style. + + + + + Initialize colors for Purple colorscheme of the Metro visual style. + + + + + Provides colors for Pink colorscheme of the Metro visual style. + + + + + Initialize colors for Pink colorscheme of the Metro visual style. + + + + + Provides colors for Blue colorscheme of the Metro visual style. + + + + + Initialize colors for Blue colorscheme of the Metro visual style. + + + + + Provides colors for Red colorscheme of the Metro visual style. + + + + + Initialize colors for Red colorscheme of the Metro visual style. + + + + + Provides colors for Green colorscheme of the Metro visual style. + + + + + Initialize colors for Green colorscheme of the Metro visual style. + + + + + Specifies that this object supports . + + + + + Enables rendering with . + + + + + Specifies to use. + + + + + Specifies that this object supports . + + + + + Enables rendering with . + + + + + Specifies to use. + + + + + Specifies that this object supports . + + + + + Enables rendering with . + + + + + Specifies to use. + + + + + Draws a themed button. + + + + + Value for reduce ClientRectangle. + + + + + Value for shift image rectangle. + + + + + Image for draw foreground. + + + + + Indicate wether the image for button + is stretched or shrunk to fit the size of the button. + + + + + Indicates whether mouse positionin is over control. + + + + + + + + Initializes a new object. + + + + + Draws the text. + + The graphics object. + + + + Draws the button themed. + + Graphics object. + The button state. + The checked state. + + + + Draws the button without themes. + + Graphics object. + The button state. + The checked state. + + + + Draws the styled button without themes. + + Graphics object. + The button state. + The checked state. + + + + Gets or sets image for draw foreground. + + + + + Indicates whether mouse positionin is over control. + + + + + Indicate wether the image for button + is stretched or shrunk to fit the size of the button. + + + + + Occurs when is changed. + + + + + Occurs when is changed. + + + + + Gets / sets the flatcolor of the themed button. + + + + + Gets or sets the visual style of the themed button. + + + + + Indicates the Office2007 theme used for drawing the control. + + + + + Indicates the Office2010 theme used for drawing the control. + + + + + Indicates whether to draw the button text. + + + + + Gets / sets the text alignment. + + + + + Gets / sets the checked state. + + + + + Gets / sets the default button state. + + + + + Inflate offset for drawing selection rectangle. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Methods recalculate top left and right bottom points + using Graphics matrix settings. This method required when we will + draw on Graphics created from HDC that does not have applied transformations. + Very useful when used ControlPaint class for drawing. + reference on Graphics + rectangle to recalculate. + Transformed rectangle. + Methods will work fine only in limited cases. If on graphics applied + rotations then in most cases will be wrong calculated rectangle. + + + Methods recalculate point using Graphics matrix settings. + This method required when we will draw on Graphics created from HDC + that does not have applied transformations. Very useful when used + ControlPaint class for drawing. + reference on Graphics + Point to recalculate. + Transformed point. + + + + Method allow to draw borders according to specified styles. + + Reference on Graphics. + Output rectangle. + border style. + 3D border style. + border style in single mode. + border color in single mode. + sides that have to be drawn by methods. + True - fix known bug in method, otherwise leave + old code (for compatibility only). + + + + Returns the width required to draw the text specified using the font specified. + + A object. + The text that is to be drawn. + The using which to draw. + True - we use RTL, otherwise normal drawing. + Width required. + + + Measure string with limit by width. + + + + + -1 - apply single line mode for measuring, values greater zero + enables multiline measuring mode. + + + + + + + + + + + + + Call this method to help you prepare for non client painting. This method will in turn + call your INonClientPaintingSupport.NonClientPaint implementation. + + The control in which we will be drawing. + The INonClientPaintingSupport implementation to which we will delegate the final non client drawing. + The WM_NCPAINT message. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Adjusts the specified forecolor's brightness based on the specified backcolor and preferred contrast. + + The forecolor to adjust. + The backcolor for reference. + Preferred contrast level. + + This method checks if the current contrast in brightness between the 2 colors is + less than the specified contrast level. If so, it brightens or darkens the forecolor appropriately. + + + + + Draws an image using the ImageList, taking into account the Graphics.ClipBounds. + + The Graphics object into which to draw. + The ImageList containing the image. + The index of the image. + The rectangle into which to draw. + + This method will use ImageList_DrawEx to draw the image (to use the transparency info in the embedded images). + We use the PInvoke rather than ImageList.Draw because, the Draw method + uses the PaintEventArgs.ClipRectangle rather than g.ClipBounds (both + can be different) and here we force the ClipBounds on the DC. +

+ Also, you do not have to use this method if your images will never be + drawn clipped (in that case just use ImageList.Draw). +

+ + + + Draws specified image to graphics context. + If image size is less than maxWidth, maxHeight parameters, it will be drawn + without any changes, otherwise - it will be scaled proportionally to those values. + + Graphics context. + Image object which must be drawing. + X coordinate of the destination location. + Y coordinate of the destination location. + Maximum width of the image. + Maximum height of the image. + + + + Converts the HSB value to RGB. + + Hue. + Saturation. + Brightness. + Red. + Green. + Blue. + + This does not seem to yield accurate results, but very close. + + + + + Value of advanced graphics state. + + + + + Mode of transformation matrix multiplication. + + + + + Graphics object for target context. + + + + + Temporary virtual Graphics object. + + + + + Temporary bitmap object. + + + + + Target rectangle. + + + + + Rectangle of virtual temporary area. + + + + + Target graphics path. + + + + + Indicates whether image must be mirrored. + + + + + Indicates whether OS supports needed API functions. + + + + + Holds old value of source graphics mode. + + + + + Holds old value of source graphics transformation. + + + + + Handle wrapper of graphics object. + + + + + Handle of graphics object. + + + + + Private constructor. + + + + + Overloaded. Creates a new mirror object for drawing mirrored images. + + Source graphics object. + Source graphics path object. + If True mirror output; False otherwise. + + + + Creates a new mirror object for drawing mirrored images. + + Source graphics object. + Source rectangle structure. + If True mirror output; False otherwise. + + + + Overloaded ctor.. as a workaround for Themed Mirrored rendering issue. + + Creates a new mirror object for drawing mirrored images. + + Source graphics object. + Source rectangle structure. + If True mirror output; False otherwise. + False as a workaround when drawing themed mirrored graphics. + + + + Disposes all resources, but first paints all data + from the buffer to source device context. + + + + + Initializes an object. + + Source graphics object. + Source rectangle structure. + If True mirror output; False otherwise. + + + + Checks OS Version for API functions support. + Need NT 3.1 or later. + + True if current OS is NT 3.1 or later; False otherwise. + + + + Transforms graphics. + + + + + Restores graphics to its previous state. + + + + + Flushes all drawing data to destination if needed. + + + + + Returns virtual graphics context object. + + + + + Returns virtual rectangle. + + + + + Returns virtual Graphics path object. + + + + + Indicates whether additional bitmap is needed. + + + + Cached version of themed controls instances. Class will + return NULL instead of instance if OS does not support XP Themes. + + + Thread synchronization object. Used for instance clear and create + operations locks. + + + Edit control. + + + Button control. + + + Tree control. + + + Reset static class cache. All internal static resources will be released. + Operation is thread safe. + + + + + + + + + + + + + Requesting the minimum size. + + + + + Requesting the size of the theme part that will best fit the available space. + + + + + Requesting the size that the theme manager uses to draw a part. + + + + + Draws a themed scroll button. + + + + + Initializes a new object. + + + + + Disposes all resources being used. + + + + + + + + + + + + Returns the color for paint control background. + + + + + + + Gets / sets the type of scroll arrow. + + + + + Provides some information regarding themes support and state in the OS. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Used to unwire the ThemeChangeListenerForm class. + + + + + + + + Returns the theme file name with the path. + + + + + Returns the current theme color scheme name. + + + + + Indicates whether the default blue theme is on. + + + + + Indicates whether the Olive Green theme is on. + + + + + Indicates whether the Silver theme is on. + + + + + Indicates whether this OS has themes support built-in. + + True if themes are supported; False otherwise. + This property returns True for Windows XP and later versions. + + + + Indicates whether themes are enabled in the current OS. + + + + + Indicates whether the current application is themed. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies that this object subscribes to event. + + + + + Class for automatic subscription management of event. + + + + + Initializes a new instance of the class. + + The target. + + + + Handles theme change. + + The sender. + The instance containing the event data. + + + + Gets or sets the object (the target) referenced by the current object. + + + null if the object referenced by the current object has been garbage collected; otherwise, a reference to the object referenced by the current object. + + + The reference to the target object is invalid. This exception can be thrown while setting this property if the value is a null reference or if the object has been finalized during the set operation. + + + + + + + + + + + Distance from thumb Y position to mouse down Y position. + + + + + Flag, if true than controls visivble in other case not visible. + + + + + Default size of the vertical scroolbar. + + + + + Initializes a new instance of the class. + + The owner. + + + + Initializes a new instance of the class. + + + + + Occurs when control size changed. + + + + + + Used for validating visibility of the ControlsAfter and ControlsBefore + + + + + + Reset vertical scrollbar to default width. + + + + + Gets dockStyle for controls which situated before scroll. + + + + + + Gets dockStyle for controls which situated after scroll. + + + + + + Gets value by cursor position + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Calculating bounds for leftThumb and rightThumb zones for scroll. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Retrieves Office2010 scroll bars + + + + Office2016 style + + + + + Metro style + + + + + Characterize zone which contain mouse down position. + Order of enum's elements can not be changed, because ScrollBarCustomDraw + uses enum's indexes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Characterize Office2010 scroll bar color scheme. + + + + Office2010 blue. + + + Office2010 silver. + + + Office2010 black. + + + Office2010 default color. + + + + Defines the constants that specify color schemes for the Office 2016 theme. + + + + Office2016 black. + + + Office2016 white. + + + Office2016 dark gray. + + + Office2016 colorful color. + + + + Characterize MS-Office scroll bars. + + + + Office2007 Scrollbars. + + + Office2010 Scrollbars. + + + Metro Scrollbars. + + + Office2016 Scrollbars + + + Ordinary Scrollbars. + + + + Characterize zone which contain mouse position. + Order of enum's elements can not be changed, because ScrollBarCustomDraw + uses enum's indexes. + + + + + + + + + + + + + + + + + + + + + + + Specifies the layout and colors for scrollbars. + + + + + + + + + + + + + + Specifies behaviour of size gripper for scrollable frame controls. + + + + + Gripper is visible when both horizontal and vertical scrollbars are visible. + + + + + Gripper is always visible. + + + + + Gripper is always hidden. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Renderer for VisualStyle based theme + + + + + Initializes a new instance of the class. + + The parent control + + + + Initializes a new instance of the class. + + The parent control. + The metro color table. + + + + Draws background of scroll. If theme is disabled than draw classic scroll. + + The graphics. + The bounds of background. + The scroll button state. + + + + Draws pushed background. + + The graphics. + The bounds of background. + + + + Draws scroll background. + + The graphics. + The scroll bounds. + + + + Draws arrow button of scroll. If theme is disabled than draw classic scroll. + + The graphics. + The bounds of arrow. + The scroll button type. + The scroll button state. + + + + Draws arrow background. + + The graphics. + The arrow backgroud bounds. + The scroll button type. + The scroll button state. + + + + Draws scrollbar arrow + + The graphics. + The bounds of the arrow. + The scroll button type. + The scroll button state. + + + + Returns the pushed or checked state right arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the pushed or checked state right arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the pushed or checked state left arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the pushed or checked state left arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the pushed or checked state down arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the pushed or checked state down arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the pushed or checked state up arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the pushed or checked state up arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the normal right arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the normal left arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Draws scroll thumb. If theme is disabled than draw classic scroll. + + + + + + + + Draws scroll thumb background. + + The graphics. + The bounds of thumb. + The scroll button state. + + + + Method to calculate the center point to place the Thumb exactly at the center position inside the Scrollbar. + + + + + + + Occurs when a property in the Button Style info has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Occurs when a property in the Button Style info has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Occurs when a property in the Button Style info has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Occurs when a property in the Button Style info has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Occurs when a property in the Button Style info has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Occurs when a property in the Button Style info has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Occurs when a property in the Button Style info has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Represents BookmarkCloseButtonStyleInfo class. + + + + + Represents the constructor of BookmarkCloseButtonStyleInfo . + + + + + Represents the constructor of BookmarkCloseButtonStyleInfo. + + Represents the identity. + + + + Constructor of BookmarkCloseButtonStyleInfo. + + Represents the identity. + Represents the store. + + + + Represents the default style of BookmarkCloseButtonStyle. + + + + + Gets or sets the BackColor. + + + + + Gets or sets the HoverBackColor. + + + + + Gets or sets the PressedBackColor. + + + + + Gets or sets the DisabledBackColor. + + + + + Gets or sets the ForeColor. + + + + + Gets or sets the HoverForeColor. + + + + + Gets or sets the PressedForeColor. + + + + + Gets or sets the DisabledForeColor. + + + + + Occurs when a property in the Button Style info has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Occurs when a property in the Button Style info has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Occurs when a property in the Button Style info has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + PdfDocumentView helps to view and print PDF files. + + + PdfDocumentView helps to view and print PDF files. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + Gets the active theme name of the control. + + Returns the active theme name. + + + + Occurs when a page is clicked in + + + + + Occurs when the mouse pointer moves over the page in + + + + + Initializes PdfDocumentView class. + + + + + To wire up all the Mouse events + + Control to which the events should be wired + + + + Represents the method that will handle the mouse move event.  + + The sender the contains a PdfViewer. + The that contains the event data. + + + + Represents the method that will handle the mouse up event.  + + The sender the contains a PdfViewer. + The that contains the event data. + + + + Represents the method that will handle the mouse down event.  + + The sender the contains a PdfViewer. + The that contains the event data. + + + + Calculates the selected text bounds + + + + + + + + Opens the weblink in browser + + + + + Shows tooltip while the mouse is over an URL + + + + + Loads a Pdf document in the Pdf viewer + + The path for the Pdf document to display in the pdf viewer + + + + Loads a Pdf document in the Pdf viewer + + The path for the Pdf document to display in the pdf viewer + The password for opening the document. + + + + Loads a Pdf document in the Pdf viewer from the specified stream. + + A stream that contains the data for the Pdf document + The password for opening the document. + + + + Loads a Pdf document in the Pdf viewer from the specified stream. + + A stream that contains the data for the Pdf document + + + + Loads a pdf document in the Pdf viewer from the specified PdfLoadedDocuemnt. + + The PdfLoadedDocument to be viewed in the PdfViewer + + + + Prints the document on the specified printer. + + The name of the destination printer to print the PDF document. + + + + + + + + + + Unloads the Pdf document + + + + + Unloads the PDF document. + + Setting this parameter to true will dispose the loaded document completely. By default this parameter is set to true + + + + Resets the ScrollBar + + + + + Clean up any resources being used. + + + + + Exports the specified page as Image + + The page index to be converted into image + Returns the specified page as Image + + + + Exports the specified page as Image + + The page index to be converted into image + The horizontal DPI of the resultant image. + The vertical DPI of the resultant image. + Returns the specified page as Image with custom resolution + + + + Exports the specified page as Image + + The page index to be converted into image + The custom size of the converted image + Whether need to keep the aspect ratio of the page + Returns the image with custom size + + + + Exports the specified page as Image + + The page index to be converted into image + The custom size of the converted image + The horizontal DPI of the resultant image. + The vertical DPI of the resultant image. + Whether need to keep the aspect ratio of the page + Returns the specified page as image with custom size and resolution> + + + + Exports the specified pages as Images + + The starting page index + The ending page index + Returns the specified pages as Images + + + + Exports the specified pages as Images with respect to dpi specified. + + The starting page index + The ending page index + The horizontal DPI of the resultant image. + The vertical DPI of the resultant image. + Returns the specified pages as Images with custom resolution + + + + Exports the specified pages as Images + + The starting page index + The ending page index + The custom size of the converted image + Whether need to keep the aspect raio of the page + Returns the specified pages as images with custom size + + + + Exports the specified pages as Images + + The starting page index + The ending page index + The custom size of the converted image + The horizontal DPI of the resultant image. + The vertical DPI of the resultant image. + Whether need to keep the aspect ratio of the page + Returns the specified pages as images with custom size and resolution + + + + Exports the specified page as System.Drawing.Imaging.Metafile + + The index of the PDF page. + Metafile + + + + Exports the specified pages as System.Drawing.Imaging.Metafile + + The start index of the PDF page + The end index of the PDF page + Array of Metafile + + + + + + + + + + + + + + + + + + Search the next occurrence of the text. + + The text to be searched + + + + Search the previous occurrence of the text. + + The text to be searched + + + + Searches the text + + The text to be searched + + + + Searches and highlights all occurrences of the given text in the PDF document. + + + + + + Navigates to the specified page. + + The page index + + + + Returns the rectangle postions of the text matches + + The text which is to be searched + + + + + + size of GESTURECONFIG structure + + + + + size of GESTUREINFO structure + + + + + Handler of gestures + + Message object + + + + + + + + + + + Custom Mousewheel event for auto scrolling during text selection + + + + + + + + + + + + + + + + + Invoked when the attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for event. + + The that contains the event data. + + + + Invoked when the attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for event. + + The that contains the event data. + + + + Draws the page using PrintPageEventArgs + + Metafile to be printed + Provides data for the PrintPage event + + + + Magnifies the page of the document to the provided zoom percentage. + + Zoom percentage + + + + Magnifies the page of the document to the provided zoom mode. + + zoom mode + + + + Navigates to the first page of the document. + + + + + Navigates to the last page of the document + + + + + Navigates to the previous page of the document. + + + + + Navigates to the next page of the document. + + + + + Navigates to the specified location. + + + + + Navigates to the location of the bookmark. + + The object that contains the details of the bookmark to which the viewer has to navigate. + + + 0) + pdfDocumentView1.GoToBookmark(bookmark[0]);]]> + + + + + + Navigates to the specified page. + + The page index + + + + Returns the page number and rectangle positions of the text matchs + + The text to be searched + Holds the page number and rectangle positions of the text matches + + + + Extracts text along with its format from the PDF Page. + + Provides the text data collection + Returns the extracted text. + + + + Extracts text from the page of PDF document with lines and words collection. + + The page index. + Holds the lines with bounds in the page. + The Extracted Text. + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Occurs when theme name of the control has changed. + + + + + Gets or sets the theme name of the control. + + + The default value is null. + + + This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control. + + + + + Gets or sets a value indicating whether control elements styles can be overridden by theme style settings. + + Default value is false. + + By default, the control's element styles will not be overridden by theme style settings if the style is set in sample level. + If this property is enabled, element style will be overridden by theme style settings event if it is set in sample level. + This property should be enabled or disabled before calling the ThemeName property of the control. + + + + + Gets or sets the Base Theme name of the theme + + + + + Gets or sets a value indicating whether a theme settings + can be applied to the control. + + The default value is true. + + This property must be initialized before applying the VisualTheme /> + + + + + Gets the name of the control. + + + + + Gets or sets the VisualTheme of the control. + + + + + Gets or sets the value used to customize the appearance of the . + + + + + Gets a value indicating whether the visual style based theme is applied to the control and + also indicates whether the theme files are referred from external assemblies or not. + + Return true, if the visual style based theme is applied to the control. Otherwise returns false. + + + + Occurs when the error occurred in PdfViewerControl + + + + + Occurs when state of the navigation button is changed. + + + + + Occurs when current page is changed. + + + + + Occurs when the PDF document is loading. + + + + + Occurs when scroll is changed. + + + + + Occurs when a key is pressed + + + + + Occurs when the Pdf document is loaded + + + + + Occurs when the Hyperlink is clicked in a page of + + + + + Occurs when the mouse is moved over the hyperlink. + + + + + Occurs when zoom value is changed. + + + + + + + + Event triggered once the text selection was completed + + + + + Occurs when the PDF document is unloaded + + + + + Occurs to provide information on how much of printing content were submitted to printing subsystem + + + + + Occurs when the print is called and before the first page of the document prints. + + + + + Occurs when the last page of the document has printed. This event also occurs if the printing process is canceled or an exception occurs during the printing process. + + + + + Occurs when the text search is initiated. + + + + + Occurs when a match for the searched text found. + + + + + Occurs when a text search operation is completed. + + + + + Specifies the renderingMode for PdfViewer. + + + + + Gets or sets a value indicating whether text selection is enabled. Default value is true. + + + + + Gets or sets a value indicating whether text search is enabled. Default value is true. + + + + + Gets and sets the minimum zoom percentage. The value should be in between 10 and 400. The default value is 50. + + + + + Returns the loaded document of the PdfDocumentView + + + + + Specifes the Pdfium path in PDF Viewer control + + + + + Disposes the document completely + + + + + Visual style of the PdfViewerControl. + + + + + Returns true, if the PDF document is loaded in PDF viewer control. Default value is false. + + + + + Gets and Sets the background image for + + + + + Get or set thickness of the page border. Default value is 1. + + + + + Gets the information of the PDF document loaded + + + + + Represents printer settings for the document to be printed. + + + + + Gets and sets the message box settings. + + + + + Defines the textsearch settings when searching the text in the document + + + + + Gets the print document + + + + + Enables or disables the context menu. + + + + + Defines the page gap between the pages. The minimum value of ‘SpaceBetweenPages’ is 0. + + + Default value is 8. The unit of ‘SpaceBetweenPages’ is pixel. + + + + + Gets or sets the displacement value for scrolling. + + + + + Gets and sets the boolean value to show and hide the vertical scrollbar in + + + + + Gets and sets the Cursor Mode + + + + + Gets and sets the boolean value to show and hide horizontal scrollbar in + + + + + Gets or sets the horizontal scroll offset of the control. + + + + + Gets or sets the vertical scroll offset of the control. + + + + + Gets the page count. + + + + + Gets the current zoom percentage. + + + + + Gets the current page index which is currently in view. + + + + + Gets/Sets the Zoom mode. + + + + + Gets a boolean value indicating whether the control can navigate to the first page. + + + + + Gets a boolean value indicating whether the control can navigate to the previous page. + + + + + Gets a boolean value indicating whether the control can navigate to the next page. + + + + + Gets a boolean value indicating whether the control can navigate to the last page. + + + + + Delegate for KeyPressed event. + + + + + Delegate for NavigationButtonStateChanged event. + + + + + Delegate for the CurrentPageChanged event. + + + + + Delegate for DocumentLoaded event. + + + + + Delegate for ZoomChanged event. + + + + + Delegate for ZoomModeChanged event. + + + + + Delegate for TextselectionCompleted event + + + + + + + + + + + + + + + + + + + PdfViewerControl helps to view and print PDF files. The DocumentToolbar helps to navigate + easily anywhere inside the document and also provides direct access to open, save and print + documents. + + + PdfViewerControl helps to view and print PDF files. The DocumentToolbar helps to navigate + easily anywhere inside the document and also provides direct access to open, save and print + documents. + + + PdfViewerControl helps to view and print PDF files. The DocumentToolbar helps to navigate + easily anywhere inside the document and also provides direct access to open, save and print + documents. + + + + + It contains the value of the property. + + + + + Notifies when a theme name is changed. + + Represents the theme name. + + + + + + + Initializes PdfViewerControl. + + + + + To wire up all the Mouse events + + Control to which the events should be wired + + + + Represents the toolbar button click + + + + + Represents the method that will handle the mouse click event.  + + The sender the contains a PdfViewer. + The that contains the event data. + + + + Represents the method that will handle the mouse move event.  + + The sender the contains a PdfViewer. + The that contains the event data. + + + + Represents the method that will handle the mouse down event.  + + The sender the contains a PdfViewer. + The that contains the event data. + + + + Represents the method that will handle the mouse up event.  + + The sender the contains a PdfViewer. + The that contains the event data. + + + + Magnifies the page of the document to the provided zoom percentage. + + Zoom percentage + + + + Occurs when a page is clicked in + + + + + Occurs when the mouse pointer moves over the page in + + + + + Loads a Pdf document in the Pdf viewer + + The path for the Pdf document to display in the pdf viewer + + + + Loads a Pdf document in the Pdf viewer + + The path for the Pdf document to display in the pdf viewer + The password for opening the document. + + + + Loads a Pdf document in the Pdf viewer from the specified stream. + + A stream that contains the data for the Pdf document + The password for opening the document. + + + + Loads a pdf document in the Pdf viewer from the specified PdfLoadedDocuemnt. + + The PdfLoadedDocument to be viewed in the PdfViewer + + + + + + + Loads a Pdf document in the Pdf viewer from the specified stream. + + A stream that contains the data for the Pdf document + + + + + + + Unloads the Pdf document + + + + + Clean up any resources being used. + + + + + Exports the specified page as Image + + The page index to be converted into image + Returns the specified page as Image + + + + Returns the page number and rectangle positions of the text matchs + + The text to be searched + Holds the page number and rectangle positions of the text matches + + + + Searches the text + + The text to be searched + + + + Search the next occurrence of the text. + + The text to be searched + + + + Search the previous occurrence of the text. + + The text to be searched + + + + Exports the specified page as Image with respect to dpi specified. + + The page index to be converted into image + The horizontal DPI of the resultant image. + The vertical DPI of the resultant image. + Returns the specified page as Image with custom resolution + + + + Exports the specified pages as Images with respect to dpi specified. + + The starting page index + The ending page index + The horizontal DPI of the resultant image. + The vertical DPI of the resultant image. + Returns the specified pages as Images with custom resolution + + + + Exports the specified pages as Images + + The starting page index + The ending page index + Returns the specified pages as Images + + + + Exports the specified pages as Images + + The starting page index + The ending page index + The custom size of the converted image + Whether need to maintain the pdf page size + Returns the specified pages as images with custom size + + + + Exports the specified pages as Images + + The starting page index + The ending page index + The custom size of the converted image + The horizontal DPI of the resultant image. + The vertical DPI of the resultant image. + Whether need to maintain the pdf page size + Returns the specified pages as images with custom size and resolution + + + + Exports the specified page as System.Drawing.Imaging.Metafile + + The index of the PDF page. + Metafile + + + + Exports the specified pages as System.Drawing.Imaging.Metafile + + The start index of the PDF page + The end index of the PDF page + Array of Metafile + + + + Exports the specified page as Image + + The page index to be converted into image + The custom size of the converted image + Whether need to maintain the pdf page size + Returns the specified page as image with custom size + + + + Exports the specified page as Image + + The page index to be converted into image + The custom size of the converted image + The horizontal DPI of the resultant image. + The vertical DPI of the resultant image. + Whether need to maintain the pdf page size + Returns the specified page as image with custom size and resolution + + + + Navigates to the specified page. + + The page index + + + + Navigates to the location of the bookmark. + + The object that contains the details of the bookmark to which the viewer has to navigate. + + + 0) + pdfViewerControl1.GoToBookmark(bookmark[0]);]]> + + + + + + Display text search bar for search text in viewer. + + + + + Prints the document loaded in the viewer. + + If set to true, displays the PrintDialog box. Prints in silent mode when set to false. + + + + Prints the document loaded in the viewer. + + If set to true, displays the PrintDialog box. Prints in silent mode when set to false. + If set to true, text elements are printed as selectable text. Otherwise it is printed as non selectable text + + + + Prints the document on the specified printer. + + The name of the destination printer to print the PDF document. + + + + + + + + + + + + Invoked when the attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for event. + + The that contains the event data. + + + + Invoked when the attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for event. + + The that contains the event data. + + + + Extracts text along with its format from the PDF Page. + + Provides the text data collection + Returns the extracted text. + + + + Extracts text from the page of PDF document with lines and words collection. + + The page index. + Holds the lines with bounds in the page. + The Extracted Text. + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Gets or sets the value used to customize the appearance of the . + + + + + Specifies the rendering mode for PdfViewer. + + + + + Gets or sets a value indicating whether text selection is enabled. Default value is true. + + + + + Gets or sets a value indicating whether text search is enabled. Default value is true. + + + + + Gets the print document + + + + + Gets and sets the minimum zoom percentage. The value should be in between 10 and 400. The default value is 50. + + + + + Gets the LoadedDocument of + + + + + Gets the information of the PDF document loaded + + + + + Specifes the Pdfium path in PDF Viewer control + + + + + Visual style of the PdfViewerControl. + + + + + Gets the page count + + + + + Get or set the thickness of the page border. Default value is 1. + + + + + Enables or disables the bookmark feature. + + + + + Returns true, if the PDF document is loaded in PDF viewer control. Default value is false. + + + + + Represents printer settings for the document to be printed. + + + + + Gets and sets the message box settings. + + + + + Defines the textsearch settings when searching the text in the document + + + + + Represents document toolbar settings for PdfViewer. + + + + + Gets and sets the visibility of the toolbar + + + + + Gets and sets the boolean value to show and hide the vertical scrollbar in + + + + + Gets and sets the boolean value to show and hide the horizontal scrollbar in + + + + + Gets and sets the Cursor Mode + + + + + Enables or disables the context menu. + + + + + Defines the page gap between the pages. The minimum value of ‘SpaceBetweenPages’ is 0. + + + Default value is 8. The unit of ‘SpaceBetweenPages’ is pixel. + + + + + Gets or sets the horizontal scroll offset of the control. + + + + + Gets or sets the vertical scroll offset of the control. + + + + + Returns the index of the current page displayed in the Viewer + + + + + Enables the display of Notification bar on setting true. + + + + + Gets and sets the Zoom Mode + + + + + Gets or sets the displacement value for scrolling. + + + + + Gets the current zoom percentage. + + + + + Occurs when the error occurred in PdfViewerControl + + + + + Occurs when the PDF document is loading. + + + + + Occurs when button clicked. + + + + + Occurs when scroll is changed. + + + + + Occurs when a key is pressed + + + + + Occurs when the pdf document is loaded + + + + + Occurs when the Hyperlink is clicked in a page of + + + + + Occurs when the mouse is moved over the hyperlink. + + + + + Occurs prior to the rendering of every image in the document + + + + + Occurs when current page is changed. + + + + + Event triggered once the text selection was completed + + + + + Occurs when the PDF document is unloaded + + + + + Occurs before initiating the save operation of the PDF document. + + + + + Occurs after the completion of the save operation. + + + + + Occurs to provide information on how much of printing content were submitted to printing subsystem + + + + + Occurs when the print is called and before the first page of the document prints. + + + + + Occurs when the last page of the document has printed. This event also occurs if the printing process is canceled or an exception occurs during the printing process. + + + + + Occurs when the text search is initiated. + + + + + Occurs when a match for the searched text found. + + + + + Occurs when a text search operation is completed. + + + + + Delegate used for button clicked event. + + + + + Delegate used for KeyPressed event. + + + + + Delegate used for DocumentLoaded event. + + + + + Delegate used for ImagePreRender event. + + + + + Delegate used for TextSelectionCompleted event. + + + + + + + Represents bookmark button style info. + + + + + Constructor of bookmark button style info. + + + + + Constructor of bookmark button style info. + + Represents the identity. + + + + Constructor of bookmark button style info. + + Represents the identity. + Repesents the store. + + + + Gets the default style. + + + + + Gets or sets the fore color. + + + + + Gets or sets the hover fore color. + + + + + Gets or sets the pressed fore color. + + + + + Gets or sets the disabled fore color. + + + + + Gets or sets the back color. + + + + + Gets or sets the hover back color. + + + + + Gets or sets the pressed back color. + + + + + Gets or sets the disabled back color. + + + + + Represents the bookmark button style info store. + + + + + Constructor of BookmarkButtonStyleInfoStore class. + + + + + Represents the BookmarkButtonStyleInfoIdentity. + + + + + Constructor of the BookmarkButtonStyleInfoIdentity. + + + + + Returns the base styles. + + Represents the style info. + + + + + Occurs when a property in the Button Style info has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Occurs when a property in the Button Style info has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Occurs when a property in the Button Style info has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Occurs when a property in the Button Style info has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Occurs when a property in the Button Style info has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Occurs when a property in the Button Style info has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Occurs when a property in the Button Style info has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Occurs when a property in the Button Style info has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Occurs when a property in the Button Style info has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Represents the class to define the style for control. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Holds instance of a class. + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + Holds instance of a class + + + + + + + Gets the default style value of the DefaultStyle + + Returns the default style value. + + + + Implements the class that provide the identity information of + using . + + + + + Maintains the PdfDocumentViewControl for create the identity. + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Provides storage for the object. + + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Initializes the , if is null. + + + + + + Gets the static data value of the class. + + + + + Represents a class that provides style identity information for nested objects + + + + + Initializes a new instance of the class. + + + The that owns this sub-object. + + + The descriptor for this expandable + sub-object. + + + + + Represents the class to define the style for control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Holds instance of a class. + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + Holds instance of a class + + + + + + + Gets the default style value of the DefaultStyle. + + Returns the default style value. + + + + Implements the class that provide the identity information of + using . + + + + + Maintains the PdfViewerControl for create the identity. + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Provides storage for the object. + + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Initializes the , if is null. + + + + + + Gets the static data value of the class. + + + + + Represents a class that provides style identity information for nested objects + + + + + Initializes a new instance of the class. + + + The that owns this sub-object. + + + The descriptor for this expandable + sub-object. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required designer variable. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Parse the annotation properties within a page + + Annotation properties + The specific page in which annotations needs to be added + Zoom factor need to be considered while drawing the annotation rectangle + + + + Calculates the annotation rectangle according to the zoom values. + + Represents the annotation rectangle + + + + + + + + + Include the URL annotation rectangles with the specific page properties + + Represents the annotation properties such as rectangle,location and URI + + + + Calculates the annotation rectangle according to the zoom values. + + The specific page in which annotations needs to be added + Represents the annotation rectangle + Zoom factor need to be considered + Drawing panel is true or false is need to be considered + + + + Represents the annotation with associated within a page. + + + + + Provides data for the event. + + + + + Changes the URL. + + + + + Gets the URI (Unifrom Resource Identifer) of the hyperlink. + + + + + Gets or sets the value to handle the event. + + + If true, the event will be handled and disables the default processing of hyperlink navigation. Its default value is false. + + + + + Provides data for the event. + + + + + Changes the URL. + + + + + Gets the URI (Unifrom Resource Identifer) of the hyperlink. + + + + + Represents the URLS within a page. + + + + + Represents the URLS within a page. + + + + + Represents the Rectangle position of the matching text. + + + + + Represents printer settings for the document to be printed. + + + + + Scale percentage of the content. This value is applicable only if PageSizings is CustomScale. Default value is 100. + + + + + Gets or sets the value indicating to hide the status window while printing the document. Default value is true. + + + + + Gets or sets the number of copies of the document to print. The default value is 1. + + + + + Specifies information about page orientation + + + + + Specifies information about page size + + + + + To print the document content from the given location + + + + + Defines the constants that specify the page orientations for printing. Default value is Auto + + + + + Prints the document in auto orientation. + + + + + Prints the document in portrait rotation. + + + + + Prints the document in landscape rotation. + + + + + Defines the constants that specify the page sizings for printing. Default value is ActualSize + + + + + Prints the document in actual size. + + + + + Prints the document after fitting the content. + + + + + Prints the document with custom scaling. + + + + + Represents a text information + + + + + Gets the bounds of the text + + + + + Gets the text + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required designer variable. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required designer variable. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Toolbar for the PdfViewerControl. + + + + + + + Creates an instance DocumentToolbar. + + + + + Initializes DocumentToolbar for the document loaded in PdfDocumentView. + + + + + Sets the visibility of the toolbar item + + Represents the toolbar item in the document toolbar + Represents visiblity of toolbar item + + + + Sets enable property of the toolbar items + + Represents the toolbar item in the document toolbar + Represents enable property of the toolbar item + + + + This applies FontHelper font to the toolbar controls + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required designer variable. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + + + + label that acts as a separator for current page index and total page count + + + + + Gets or sets the PdfDocumentView associated with this instance of DocumentToolbar. + + + + + NotificationBar for the PdfViewerControl. + + + + + + + Boundary of the notification bar to draw the border + + + + + Graphics of the notification bar + + + + + Instance of the PdfViewerExceptions class to collect the exceptions thrown + + + + + Corresponding viewer to add the notification bar control + + + + + To specify the visibility of the notification bar + + + + + Initializes NotificationBar + + + + + Displays error in NotificationBar. + + The Message + The Exception + + + + Displays error in NotificationBar. + + The Exception + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required designer variable. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Get and set the visibility of the notification bar + + + + + Gets or sets the font of the text displayed by the control. + + + + + Gets or sets the font of the text displayed in the link. + + + + + Represent the cursor modes + + + + + This tool is used for selecting texts. + + + + + This tool is used for dragging and scrolling the pages in any direction (pan). + + + + + Class to show the tooltip + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Defines the constants that specify the rendering modes for PDF viewer. Default value is Pdfium. + + + + + Speficies the PDFium rendering engine. It is the recommended PDF rendering engine and it provides accurate and robust PDF rendering. . + + + + + Specifies the Syncfusion PDF rendering engine. + + + + + Provides classes to create PDF viewer control and various operations in Windows Forms application + + + + + Gets the information about the currently loaded PDF document + + + + + Gets the file path of the loaded PDF document + + + + + Gets the file name of the loaded PDF document + + + + + Represents document toolbar settings for PdfViewer. + + + + + Initializes the ToolbarItem + + + + + + Represents open button in document toolbar + + + + + Represents save button in document toolbar + + + + + Represents print button in document toolbar + + + + + Represents goto first page button in document toolbar + + + + + Represents goto previous page button in document toolbar + + + + + Represents goto next page button in document toolbar + + + + + Represents goto last page button in document toolbar + + + + + Represents zoom in button in document toolbar + + + + + Represents zoom out button in document toolbar + + + + + Represents fitwidth button in document toolbar + + + + + Represents fitpage button in document toolbar + + + + + Represents current zoom level button in document toolbar + + + + + Represents current page index button in document toolbar + + + + + Represents total page count button in document toolbar + + + + + Represents pan button in document toolbar + + + + + Represents selection button in document toolbar + + + + + Represents document toolbar items + + + + + Initializes a new instance of the of the specified . + + The control with which the toolbar item belongs to. + + + + Gets and sets the visibility of items in the document toolbar + + + + + Gets or sets the enable property of items in the document toolbar. + + + + + Represents the arguments associated with a scroll changed event. + + + + + Represents the old vertical scroll value + + + + + Represents the new vertical scroll value + + + + + Represents the maximum vertical scroll value + + + + + Provides the data for a button clicked events. + + + + + The name of the button which is clicked. + + + + + Cancel the default action of the button. + + + + + Custom event argument class used to notify when a key is pressed. + + + + + Returns the message. + + + + + Returns the key data. + + + + + Represents the arguments associated with a TextSelectionCompleted event. + + + + + Represents the current page number, selected text and text bounds. + + + + + Represents the selected text. + + + + + Defines the textsearch settings when searching the text in the document + + + + + Sets the color to highlight all the occurrence of the searched text. + + + + + Sets the color to highlight current occurrence of searched text. + + + + + Sets the value to enable or disable highlight all the occurrence of the searched text. + + + + + Provides data for `Beginsave` event. + + + + + Gets and sets a value indicating whether the save operation should be canceled. + + + + + Provides data for `EndSave` event. + + + + + Gets a value indicating whether the save process is canceled. + + + + + Provides data for `DocumentUnloaded` events. + + + + + Provides data for `Beginprint` events. + + + + + Provides data for 'PrintProgress' event. + + + + + Gets the count of total number of pages to be printed. + + + + + Get the current printing page index. + + + + + Provides data for `EndPrint` events. + + + + + Provides data for `TextSearchInitiated` events. + + + + + Gets the text being searched. + + A string that holds the text that is being searched in the PDF document. Default value is + + + + Provides data for `TextMatchFound` events. + + + + + Gets the text being searched. + + A string that holds the text that is being searched in the PDF document. Default value is + + + + Gets the match founded page number. + + A integer value that holds the match founded page number. + + + + Provides data for `TextSearchCompleted` events. + + + + + Gets a message that describes the results of text search completion. + + + + + Gets the text being searched. + + A string that holds the text that is being searched in the PDF document. Default value is + + + + Gets a value indicating whether there are no more occurrences of the text being searched. + + A boolean value which when set to true, represents that no more match of the searched text is found in the document and vice versa. + + + + Gets a value indicating whether there is no match to the text found. + + A boolean value which when set to true, represents no match of the searched text is found in the document and vice versa. + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required designer variable. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + + Looks up a localized resource of type System.Drawing.Bitmap. + + + + + Looks up a localized resource of type System.Drawing.Bitmap. + + + + + Looks up a localized resource of type System.Drawing.Bitmap. + + + + + Looks up a localized resource of type System.Byte[]. + + + + + Looks up a localized resource of type System.Drawing.Icon similar to (Icon). + + + + + Looks up a localized resource of type System.Byte[]. + + + + + Class for the PasswordToolBox + + + + + + Initializes PasswordToolBox class. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + + + + Instance of + + + + + + + + + + + Represents a localization resource manager class which manages localization resources to provide convenient access to culture-specific resources at run time. + + + + + + Sets lookup assembly and namespace for localization resource manager. + This can be used to set lookup assembly and namespace to locate localization resx files + when assembly name and default namespace of application differs. + + The assembly where the resx file located. + The default namespace of the assembly where resx file located. + + + + Gets the localized string for the current culture. + + The string that need to be localized. + Returns the localized string. + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + diff --git a/ZZPDFTest/bin/Debug/Syncfusion.Presentation.Base.dll b/ZZPDFTest/bin/Debug/Syncfusion.Presentation.Base.dll new file mode 100644 index 00000000..de1831e4 Binary files /dev/null and b/ZZPDFTest/bin/Debug/Syncfusion.Presentation.Base.dll differ diff --git a/ZZPDFTest/bin/Debug/Syncfusion.Presentation.Base.xml b/ZZPDFTest/bin/Debug/Syncfusion.Presentation.Base.xml new file mode 100644 index 00000000..484a8f6c --- /dev/null +++ b/ZZPDFTest/bin/Debug/Syncfusion.Presentation.Base.xml @@ -0,0 +1,57120 @@ + + + + Syncfusion.Presentation.Base + + + + + Represents the behavior properties. + + + + + Gets a instance at the specified index from the collection. Read-only. + + Determines the index of the effect. + Returns an instance. + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IPropertyEffect) + { + // Assign the property effect values + IPropertyEffect propertyEffect = (behavior as IPropertyEffect); + IBehaviorProperties behaviorProperties = propertyEffect.Properties; + AnimationPropertyType animationProperty = behaviorProperties[0]; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is property effect + If (TypeOf behavior Is PropertyEffect) Then + 'Assign the property effect values + Dim propertyEffect As PropertyEffect = TryCast(behavior,PropertyEffect) + Dim behaviorProperties As IBehaviorProperties = propertyEffect.Properties + Dim animationProperty As AnimationPropertyType = behaviorProperties(0) + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the count of behaviour list + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Fly, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IPropertyEffect) + { + // Assign the property effect values + IPropertyEffect propertyEffect = (behavior as IPropertyEffect); + IBehaviorProperties behaviorProperties = propertyEffect.Properties; + int behaviorsCount = behaviorProperties.Count; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Fly, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is property effect + If (TypeOf behavior Is PropertyEffect) Then + 'Assign the property effect values + Dim propertyEffect As PropertyEffect = TryCast(behavior,PropertyEffect) + Dim behaviorProperties As IBehaviorProperties = propertyEffect.Properties + Dim behaviorsCount As Integer = behaviorProperties.Count + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Connector class to represent the connector + + + + + Represents an object in the drawing layer, such as an AutoShape, text box or picture. + + + + + Represents an individual item in a slide. + + + + + Creates a copy of the instance. + + Returns the cloned instance + + + //Create a new presentation. + IPresentation pptxDoc = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + ISlideItem slideItem = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Clone the slide item. + ISlideItem clonedSlideItem = slideItem.Clone(); + //Add the slide item to the shape collection. + slide.Shapes.Add(clonedSlideItem); + //Modifying the top position value. + clonedSlideItem.Top = 250; + //Add text content to the cloned slide item. + (clonedSlideItem as IShape).TextBody.Text = "Cloned slide item"; + //Saves the Presentation to the file system. + pptxDoc.Save("Result.pptx"); + //Closes the Presentation. + pptxDoc.Close(); + + + 'Create a new presentation. + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim slideItem As ISlideItem = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Clone the slide item. + Dim clonedSlideItem As ISlideItem = slideItem.Clone() + 'Add the slide item to the shape collection. + slide.Shapes.Add(clonedSlideItem) + 'Modifying the top position value. + clonedSlideItem.Top = 250 + 'Add text content to the cloned slide item. + TryCast(clonedSlideItem, IShape).TextBody.Text = "Cloned slide item" + 'Save the presentation + pptxDoc.Save("Result.pptx") + 'Close the presentation + pptxDoc.Close() + + + + + + Gets or sets the item description. + + + The description of the shape. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance for SlideItem + ISlideItem slideItem = slide.Shapes[0]; + //Set the description for slide item + slideItem.Description = "This is a SlideItem"; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance for SlideItem + Dim slideItem As ISlideItem = slide.Shapes(0) + 'Set the description for slide item + slideItem.Description = "This is a SlideItem" + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the slide item type. Read-only. + + + The type of the slide item. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance for SlideItem + ISlideItem slideItem = slide.Shapes[0]; + //Set the description for slide item + slideItem.Description = "This is a SlideItem"; + //Set the title + slideItem.Title = "SlideItem"; + //Get the type of slide item, it is read only + SlideItemType type = slideItem.SlideItemType; + //Add the slide item to shape collection + slide.Shapes.Add(slideItem); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance for SlideItem + Dim slideItem As ISlideItem = slide.Shapes(0) + 'Set the description for slide item + slideItem.Description = "This is a SlideItem" + 'Set the title + slideItem.Title = "SlideItem" + 'Get the type of slide item, it is read only + Dim type As SlideItemType = slideItem.SlideItemType + 'Add the slide item to shape collection + slide.Shapes.Add(slideItem) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets height. + The Height value ranges from 0 to 169056, in points. + + + The height of the shape. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance for SlideItem + ISlideItem slideItem = slide.Shapes[0]; + //Set the height + slideItem.Height = 200; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance for SlideItem + Dim slideItem As ISlideItem = slide.Shapes(0) + 'Set the height + slideItem.Height = 200 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the boolean value which indicates whether the shape is hidden or not. + + + true if hidden; otherwise, false. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance for SlideItem + ISlideItem slideItem = slide.Shapes[0]; + //Hide the shape from slide + slideItem.Hidden = true; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance for SlideItem + Dim slideItem As ISlideItem = slide.Shapes(0) + 'Hide the shape from slide + slideItem.Hidden = True + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets left position. + The Left value ranges from -169056 to 169056, in points. + + + The left position of the shape. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance for SlideItem + ISlideItem slideItem = slide.Shapes[0]; + //Set the Left + slideItem.Left = 120; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance for SlideItem + Dim slideItem As ISlideItem = slide.Shapes(0) + 'Set the Left + slideItem.Left = 120 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets an instance which represents the line and arrowhead properties. Read only. + + + The line format object of the shape. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance for SlideItem + ISlideItem slideItem = slide.Shapes[0]; + //Set the length of begin arrow head of line format + slideItem.LineFormat.BeginArrowheadLength = ArrowheadLength.Long; + //Set the dash style of line format + slideItem.LineFormat.DashStyle = LineDashStyle.DashDotDot; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance for SlideItem + Dim slideItem As ISlideItem = slide.Shapes(0) + 'Set the length of begin arrow head of line format + slideItem.LineFormat.BeginArrowheadLength = ArrowheadLength.[Long] + 'Set the dash style of line format + slideItem.LineFormat.DashStyle = LineDashStyle.DashDotDot + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the shape name. + + + The name of the shape. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance for SlideItem + ISlideItem slideItem = slide.Shapes[0]; + //Set the shape name for the slide item + slideItem.ShapeName = "SlideItem"; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance for SlideItem + Dim slideItem As ISlideItem = slide.Shapes(0) + 'Set the shape name for the slide item + slideItem.ShapeName = "SlideItem" + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the shape title. + + + The title of the shape. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance for SlideItem + ISlideItem slideItem = slide.Shapes[0]; + //Set the title + slideItem.Title = "SlideItem"; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance for SlideItem + Dim slideItem As ISlideItem = slide.Shapes(0) + 'Set the title + slideItem.Title = "SlideItem" + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets top position. + The Top value ranges from -169056 to 169056, in points. + + + The top position of the shape. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance for SlideItem + ISlideItem slideItem = slide.Shapes[0]; + //Set the Top + slideItem.Top = 100; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance for SlideItem + Dim slideItem As ISlideItem = slide.Shapes(0) + 'Set the Top + slideItem.Top = 110 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets width. + The Width value ranges from 0 to 169056, in points. + + + The width of the shape. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance for SlideItem + ISlideItem slideItem = slide.Shapes[0]; + //Set the Width + slideItem.Width = 250; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance for SlideItem + Dim slideItem As ISlideItem = slide.Shapes(0) + 'Set the Width + slideItem.Width = 300 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Sets the hyperlink to the shape. + + Represents the address of the target hyperlink + Returns an instance. + The target can be a document path, web url, target slide index (index is valid from 0 to slides count – 1) or an email_id. + + + //Create a new PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 0, 0, 100, 100); + //Set the hypelink to the rectangle + shape.SetHyperlink("www.syncfusion.com"); + //Save the presentation + presentation.Save("Hyperlink.pptx"); + //Close the Presentation + presentation.Close(); + + + 'Create a new PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 0, 0, 100, 100) + 'Set the hypelink to the rectangle + shape.SetHyperlink("www.syncfusion.com") + 'Save the presentation + presentation__1.Save("Hyperlink.pptx") + 'Close the Presentation + presentation__1.Close() + + + + + + Removes the hyperlink from the current instance. + + + + //Load a PowerPoint presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Get the first slide from the presentation + ISlide slide = presentation.Slides[0]; + //Get the shape which have the hyperlink + IShape shape = (IShape)slide.Shapes[0]; + //Remove the hyperlink from the shape + shape.RemoveHyperlink(); + //Save the presentation + presentation.Save("Hyperlink.pptx"); + //Close the Presentation + presentation.Close(); + + + 'Load a PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Open("Sample.pptx") + 'Get the first slide from the presentation + Dim slide As ISlide = presentation__1.Slides(0) + 'Get the shape which have the hyperlink + Dim shape As IShape = DirectCast(slide.Shapes(0), IShape) + 'Remove the hyperlink from the shape + shape.RemoveHyperlink() + 'Save the presentation + presentation__1.Save("Hyperlink.pptx") + 'Close the Presentation + presentation__1.Close() + + + + + + Gets the type of the AutoShape instance. Read-only. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Retrieve the autoShape + AutoShapeType autoShape = shape.AutoShapeType; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Retrieve the autoShape + Dim autoShape As AutoShapeType = shape.AutoShapeType + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the connection site count of the shape. Read-only. + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Get the connection site count of the shape + int connectionSiteCount = shape.ConnectionSiteCount; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + ' Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + ' Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Get the connection site count of the shape + Dim connectionSiteCount As int = shape.ConnectionSiteCount; + ' Save the presentation file + ppDoc.Save("Sample.pptx") + ' Close the presentation file + ppDoc.Close + + + + + + Gets an instance that represents the fill formatting options of the shape. Read-only. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Set solid fill as fill type for the shape + shape.Fill.FillType = FillType.Solid; + //Set the solid fill color + shape.Fill.SolidFill.Color = ColorObject.Lime; + //Save the presentation + presentation.Save("FillShape.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Set solid fill as fill type for the shape + shape.Fill.FillType = FillType.Solid + 'Set the solid fill color + shape.Fill.SolidFill.Color = ColorObject.Lime + 'Save the presentation + presentation__1.Save("FillShape.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets an instance that represents the text in the shape. Read-only. + + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance for shape's textBody + ITextBody textBody = shape.TextBody; + //Add text to text body + textBody.Paragraphs.Add().AddTextPart("Hello World"); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance for shape's textBody + Dim textBody As ITextBody = shape.TextBody + 'Add text to text body + textBody.Paragraphs.Add().AddTextPart("Hello World") + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Returns an instance that represents the hyperlink for the specified shape. + + + + //Load a PowerPoint presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Get the first slide from the presentation + ISlide slide = presentation.Slides[0]; + //Get the shape which have the hyperlink + IShape shape = (IShape)slide.Shapes[0]; + //Get the hyperlink from the shape + IHyperLink hyperLink = shape.Hyperlink; + //Get the action type of the hyperlink + HyperLinkType hypelinkType = hyperLink.Action; + //Get the target slide of the hyperlink + ISlide targetSlide = hyperLink.TargetSlide; + //Get the url of the hyperlink + string url = hyperLink.Url; + //Save the presentation + presentation.Save("Hyperlink.pptx"); + //Close the Presentation + presentation.Close(); + + + 'Load a PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Open("Sample.pptx") + 'Get the first slide from the presentation + Dim slide As ISlide = presentation__1.Slides(0) + 'Get the shape which have the hyperlink + Dim shape As IShape = DirectCast(slide.Shapes(0), IShape) + 'Get the hyperlink from the shape + Dim hyperLink As IHyperLink = shape.Hyperlink + 'Get the action type of the hyperlink + Dim hypelinkType As HyperLinkType = hyperLink.Action + 'Get the target slide of the hyperlink + Dim targetSlide As ISlide = hyperLink.TargetSlide + 'Get the url of the hyperlink + Dim url As String = hyperLink.Url + 'Save the presentation + presentation__1.Save("Hyperlink.pptx") + 'Close the Presentation + presentation__1.Close() + + + + + + Gets an object that contains the properties that are unique to placeholders. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Title); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Retrieve the place holder + IPlaceholderFormat placeHolder = (slide.Shapes[0] as IShape).PlaceholderFormat; + //Set the name of the place holder + placeHolder.Name = "My Placeholder"; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Title) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Retrieve the place holder + Dim placeHolder As IPlaceholderFormat = TryCast(slide.Shapes(0), IShape).PlaceholderFormat + 'Set the name of the place holder + placeHolder.Name = "My Placeholder" + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the number of degrees the specified shape is rotated. + + + The rotation value ranges from -3600 degrees to 3600 degrees. + + + The rotation angle of the shape. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Set the rotation value to the shape instance. + shape.Rotation = 300; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Set the rotation value to the shape instance. + shape.Rotation = 300 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Checks whether the corresponding shape is predefined shape + + Returns true, if corresponding shape is Predefined Shape; Otherwise false. + + + + Checks whether the corresponding shape is Custom Shape + + Returns true, if corresponding shape is Custom Shape; Otherwise false. + + + + Gets the Autoshape type of the corresponding shape. + + Returns AutoShapeType, if corresponding shape contains AutoshapeType. + + + + Gets the ShapeGuide values of the corresponding shape. + + Returns ShapeGuide, if corresponding shape contains ShapeGuide. + + + + Gets the Path2DList of the corresponding shape. + + Returns Path2DList, if corresponding shape contains Path2DList. + + + + Retrieves the fill color from the preserved elements of the specified shape. + + The shape object from which to retrieve the fill color. + The fill format to apply the retrieved color to. + + Returns the updated fill format with the fill color from the preserved elements. If no valid color is found, the original fill format is returned. + + + + + Retrieves the fill format from its parent group shapes. + + + + + Get the spacing value between the columns + + + + + Get the number of columns in the shape. + + + + + Split a single column text body as multi column text body. + + Represents a paragraph collection. + Represent a text body bounds. + + + + Gets minimum height between first line of all the columns. + + Represents a layouted column info collection. + Represents a paragraph collection. + Returns minimum height between first line of all the columns. + + + + Split a single column into multi columns by shifting X and Y position of lines. + + Represents a paragraph collection. + Represent a text body bounds. + + + + Create a column in TextBody. + + Represents a paragraph collection of text body. + Represent a height of the text body. + Represent a paragraph index of column. + Represent a line index of paragraph. + Returns a created ColumnInfo object. + + + + Gets a single column width of TextBody. + + Represents a bounds of TextBody. + Returs a single column width of TextBody. + + + + Check whether current shape is having more than one GraphicsPath or not. + + Returns true, if it has more than one graphics path; Otherwise false. + + + + Check whether the shape paths are fit with in the shape bounds or not. + + Returns true, if its graphics path fit with in the shape bounds; Otherwise false. + + + + Compares the current Shape object with given Shape object. + + The Shape object to compare with the current instance. + True if the Shape objects are equal; otherwise, false. + + + + Compares the bounds of the current Shape object with given Shape object. + + The Shape object to compare with the current instance. + True if the bounds of the Shape objects are equal; otherwise, false. + + + + Sets the hyperlink to the textpart. + + Represents the address of the target hyperlink + Returns an instance. + The target can be a document path, web url, target slide, email_id. + + + + Removes the hyperlink from the current instance. + + + + + Checked whether the group shape contains Horizontal flip. + + Group Shape. + True if the group shape contains flip.. + + + + Checked whether the group shape contains Vertical flip. + + Group Shape. + True if the group shape contains flip.. + + + + Get Horizontal flip count. + + Group Shape. + Flip count. + Flip count. + + + + Get Vertical flip count. + + Group Shape. + Flip count. + Flip count. + + + + Creates the from points array. + + The points. + The rectangle. + + + + Parse TextBox Graphics data + + + + + + Skip whitespaces and moves the reader to the next node. + + The xml reader + + + + Compares the current Shape object with given Shape object. + + The Shape object to compare with the current instance. + True if the Shape objects are equal; otherwise, false. + + + + Returns an instance that represents the hyperlink for the specified shape. + + + + + Gets or Sets the hidden property of shape based on animation. + + + + + Returns true if the shape have a transparant fill or light color line fill + + + + + Returns a IPlaceholderFormat object that contains the properties that are unique to placeholders. + + + + + Gets or sets the number of degrees the specified shape is rotated. + + + The rotation value ranges from -3600 degrees to 3600 degrees. + + + The rotation angle of the shape. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Set the rotation value to the shape instance. + shape.Rotation = 300; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Set the rotation value to the shape instance. + shape.Rotation = 300 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the shape guide + + The shape guide. + + + + Represent the connector in presentation + + + + + Connect the begin portion of the connector with specified shape and site index + + Represent the shape instance that we want to connect with begin portion + Represent the site index of the specified shape to connnect with + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add a Rectangle shape on the slide + IShape rectangle = slide.Shapes.AddShape(AutoShapeType.Rectangle, 200, 300, 250, 200); + // Add a Oval shape on the slide + IShape oval = slide.Shapes.AddShape(AutoShapeType.Oval, 600, 10, 250, 250); + // Add connector on the slide + IConnector connector = slide.Shapes.AddConnector(ConnectorType.Straight, 10, 10, 10, 10); + // Set the begin connection + connector.BeginConnect(rectangle, 2); + // Set the end connection + connector.EndConnect(oval, 3); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + ' Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + ' Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + ' Add Rectangle shape on the slide + Dim rectangle As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 200, 300, 250, 200) + ' Add Oval shape on the slide + Dim oval As IShape = slide.Shapes.AddShape(AutoShapeType.Oval, 600, 10, 250, 250) + ' Add connector on the slide + Dim connector As IConnector = slide.Shapes.AddConnector(ConnectorType.Straight, 10, 10, 10, 10) + ' Set the begin connection + connector.BeginConnect(rectangle, 2) + ' Set the end connection + connector.EndConnect(oval, 3) + ' Save the presentation file + ppDoc.Save("Sample.pptx") + ' Close the presentation file + ppDoc.Close + + + + + + Disconnect the begin connection of the connector + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add a Rectangle shape on the slide + IShape rectangle = slide.Shapes.AddShape(AutoShapeType.Rectangle, 200, 300, 250, 200); + // Add a Oval shape on the slide + IShape oval = slide.Shapes.AddShape(AutoShapeType.Oval, 600, 10, 250, 250); + // Add connector on the slide + IConnector connector = slide.Shapes.AddConnector(ConnectorType.Straight, 10, 10, 10, 10); + // Set the begin connection + connector.BeginConnect(rectangle, 2); + // Set the end connection + connector.EndConnect(oval, 3); + //Disconnect the begin connection of the connector + connector.BeginDisconnect(); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + ' Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + ' Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + ' Add Rectangle shape on the slide + Dim rectangle As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 200, 300, 250, 200) + ' Add Oval shape on the slide + Dim oval As IShape = slide.Shapes.AddShape(AutoShapeType.Oval, 600, 10, 250, 250) + ' Add connector on the slide + Dim connector As IConnector = slide.Shapes.AddConnector(ConnectorType.Straight, 10, 10, 10, 10) + ' Set the begin connection + connector.BeginConnect(rectangle, 2) + ' Set the end connection + connector.EndConnect(oval, 3) + ' Disconnect the begin connection of the connector + connector.BeginDisconnect(); + ' Save the presentation file + ppDoc.Save("Sample.pptx") + ' Close the presentation file + ppDoc.Close + + + + + + Connect the end portion of the connector with specified shape and site index + + Represent the shape instance that we want to connect with end portion + Represent the site index of the specified shape to connnect with + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add a Rectangle shape on the slide + IShape rectangle = slide.Shapes.AddShape(AutoShapeType.Rectangle, 200, 300, 250, 200); + // Add a Oval shape on the slide + IShape oval = slide.Shapes.AddShape(AutoShapeType.Oval, 600, 10, 250, 250); + // Add connector on the slide + IConnector connector = slide.Shapes.AddConnector(ConnectorType.Straight, 10, 10, 10, 10); + // Set the begin connection + connector.BeginConnect(rectangle, 2); + // Set the end connection + connector.EndConnect(oval, 3); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + ' Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + ' Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + ' Add Rectangle shape on the slide + Dim rectangle As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 200, 300, 250, 200) + ' Add Oval shape on the slide + Dim oval As IShape = slide.Shapes.AddShape(AutoShapeType.Oval, 600, 10, 250, 250) + ' Add connector on the slide + Dim connector As IConnector = slide.Shapes.AddConnector(ConnectorType.Straight, 10, 10, 10, 10) + ' Set the begin connection + connector.BeginConnect(rectangle, 2) + ' Set the end connection + connector.EndConnect(oval, 3) + ' Save the presentation file + ppDoc.Save("Sample.pptx") + ' Close the presentation file + ppDoc.Close + + + + + + Disconnect the end connection of the connector + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add a Rectangle shape on the slide + IShape rectangle = slide.Shapes.AddShape(AutoShapeType.Rectangle, 200, 300, 250, 200); + // Add a Oval shape on the slide + IShape oval = slide.Shapes.AddShape(AutoShapeType.Oval, 600, 10, 250, 250); + // Add connector on the slide + IConnector connector = slide.Shapes.AddConnector(ConnectorType.Straight, 10, 10, 10, 10); + // Set the begin connection + connector.BeginConnect(rectangle, 2); + // Set the end connection + connector.EndConnect(oval, 3); + //Disconnect the end connection of the connector + connector.EndDisconnect(); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + ' Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + ' Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + ' Add Rectangle shape on the slide + Dim rectangle As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 200, 300, 250, 200) + ' Add Oval shape on the slide + Dim oval As IShape = slide.Shapes.AddShape(AutoShapeType.Oval, 600, 10, 250, 250) + ' Add connector on the slide + Dim connector As IConnector = slide.Shapes.AddConnector(ConnectorType.Straight, 10, 10, 10, 10) + ' Set the begin connection + connector.BeginConnect(rectangle, 2) + ' Set the end connection + connector.EndConnect(oval, 3) + ' Disconnect the end connection of the connector + connector.EndDisconnect(); + ' Save the presentation file + ppDoc.Save("Sample.pptx") + ' Close the presentation file + ppDoc.Close + + + + + + Update the bounds of modified connector + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add a Rectangle shape on the slide + IShape rectangle = slide.Shapes.AddShape(AutoShapeType.Rectangle, 200, 300, 250, 200); + // Add a Oval shape on the slide + IShape oval = slide.Shapes.AddShape(AutoShapeType.Oval, 600, 10, 250, 250); + // Add connector on the slide + IConnector connector = slide.Shapes.AddConnector(ConnectorType.Straight, 10, 10, 10, 10); + // Set the begin connection + connector.BeginConnect(rectangle, 2); + // Set the end connection + connector.EndConnect(oval, 3); + //Update the bounds of inserted connector immediately + connector.Update(); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + ' Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + ' Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + ' Add Rectangle shape on the slide + Dim rectangle As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 200, 300, 250, 200) + ' Add Oval shape on the slide + Dim oval As IShape = slide.Shapes.AddShape(AutoShapeType.Oval, 600, 10, 250, 250) + ' Add connector on the slide + Dim connector As IConnector = slide.Shapes.AddConnector(ConnectorType.Straight, 10, 10, 10, 10) + ' Set the begin connection + connector.BeginConnect(rectangle, 2) + ' Set the end connection + connector.EndConnect(oval, 3) + ' Update the bounds of inserted connector immediately + connector.Update(); + ' Save the presentation file + ppDoc.Save("Sample.pptx") + ' Close the presentation file + ppDoc.Close + + + + + + Gets or sets the type of IConnector instance. + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add a Rectangle shape on the slide + IShape rectangle = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 20, 250, 250); + // Add a Oval shape on the slide + IShape oval = slide.Shapes.AddShape(AutoShapeType.Oval, 600, 200, 250, 250); + // Add connector on the slide + IConnector connector = slide.Shapes.AddConnector(ConnectorType.Straight, 10, 10, 10, 10); + // Set the begin connection + connector.BeginConnect(rectangle, 3); + // Set the end connection + connector.EndConnect(oval, 3); + //Change the type of the connector + connector.Type = ConnectorType.Curve; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + ' Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + ' Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + ' Add Rectangle shape on the slide + Dim rectangle As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 20, 250, 250) + ' Add Oval shape on the slide + Dim oval As IShape = slide.Shapes.AddShape(AutoShapeType.Oval, 600, 200, 250, 250) + ' Add connector on the slide + Dim connector As IConnector = slide.Shapes.AddConnector(ConnectorType.Straight, 10, 10, 10, 10) + ' Set the begin connection + connector.BeginConnect(rectangle, 3) + ' Set the end connection + connector.EndConnect(oval, 3) + 'Change the type of the connector + connector.Type = ConnectorType.Curve + ' Save the presentation file + ppDoc.Save("Sample.pptx") + ' Close the presentation file + ppDoc.Close + + + + + + Gets the begin connected shape instance , if the connector begin point is connected. Read-only. + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add a Rectangle shape on the slide + IShape rectangle = slide.Shapes.AddShape(AutoShapeType.Rectangle, 200, 300, 250, 200); + // Add a Oval shape on the slide + IShape oval = slide.Shapes.AddShape(AutoShapeType.Oval, 600, 10, 250, 250); + // Add connector on the slide + IConnector connector = slide.Shapes.AddConnector(ConnectorType.Straight, 10, 10, 10, 10); + // Set the begin connection + connector.BeginConnect(rectangle, 2); + // Set the end connection + connector.EndConnect(oval, 3); + // Get the begin connected shape + IShape beginShape = connector.BeginConnectedShape; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + ' Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + ' Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + ' Add Rectangle shape on the slide + Dim rectangle As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 200, 300, 250, 200) + ' Add Oval shape on the slide + Dim oval As IShape = slide.Shapes.AddShape(AutoShapeType.Oval, 600, 10, 250, 250) + ' Add connector on the slide + Dim connector As IConnector = slide.Shapes.AddConnector(ConnectorType.Straight, 10, 10, 10, 10) + ' Set the begin connection + connector.BeginConnect(rectangle, 2) + ' Set the end connection + connector.EndConnect(oval, 3) + ' Get the begin connected shape + Dim beginShape As IShape = connector.BeginConnectedShape + ' Save the presentation file + ppDoc.Save("Sample.pptx") + ' Close the presentation file + ppDoc.Close + + + + + + Gets the begin connected site index, if the connector begin point is connected. Read-only. + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add a Rectangle shape on the slide + IShape rectangle = slide.Shapes.AddShape(AutoShapeType.Rectangle, 200, 300, 250, 200); + // Add a Oval shape on the slide + IShape oval = slide.Shapes.AddShape(AutoShapeType.Oval, 600, 10, 250, 250); + // Add connector on the slide + IConnector connector = slide.Shapes.AddConnector(ConnectorType.Straight, 10, 10, 10, 10); + // Set the begin connection + connector.BeginConnect(rectangle, 2); + // Set the end connection + connector.EndConnect(oval, 3); + // Get the begin connected site index + int beginSiteIndex = connector.BeginConnectionSiteIndex; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + ' Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + ' Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + ' Add Rectangle shape on the slide + Dim rectangle As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 200, 300, 250, 200) + ' Add Oval shape on the slide + Dim oval As IShape = slide.Shapes.AddShape(AutoShapeType.Oval, 600, 10, 250, 250) + ' Add connector on the slide + Dim connector As IConnector = slide.Shapes.AddConnector(ConnectorType.Straight, 10, 10, 10, 10) + ' Set the begin connection + connector.BeginConnect(rectangle, 2) + ' Set the end connection + connector.EndConnect(oval, 3) + ' Get the begin connected site index + Dim beginSiteIndex As int = connector.BeginConnectionSiteIndex + ' Save the presentation file + ppDoc.Save("Sample.pptx") + ' Close the presentation file + ppDoc.Close + + + + + + Gets the end connected shape instance , if the connector end point is connected. Read-only. + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add a Rectangle shape on the slide + IShape rectangle = slide.Shapes.AddShape(AutoShapeType.Rectangle, 200, 300, 250, 200); + // Add a Oval shape on the slide + IShape oval = slide.Shapes.AddShape(AutoShapeType.Oval, 600, 10, 250, 250); + // Add connector on the slide + IConnector connector = slide.Shapes.AddConnector(ConnectorType.Straight, 10, 10, 10, 10); + // Set the begin connection + connector.BeginConnect(rectangle, 2); + // Set the end connection + connector.EndConnect(oval, 3); + // Get the end connected shape + IShape endShape = connector.EndConnectedShape; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + ' Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + ' Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + ' Add Rectangle shape on the slide + Dim rectangle As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 200, 300, 250, 200) + ' Add Oval shape on the slide + Dim oval As IShape = slide.Shapes.AddShape(AutoShapeType.Oval, 600, 10, 250, 250) + ' Add connector on the slide + Dim connector As IConnector = slide.Shapes.AddConnector(ConnectorType.Straight, 10, 10, 10, 10) + ' Set the begin connection + connector.BeginConnect(rectangle, 2) + ' Set the end connection + connector.EndConnect(oval, 3) + ' Get the end connected shape + Dim endShape As IShape = connector.EndConnectedShape + ' Save the presentation file + ppDoc.Save("Sample.pptx") + ' Close the presentation file + ppDoc.Close + + + + + + Gets the end connected site index, if the connector end point is connected. Read-only. + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add a Rectangle shape on the slide + IShape rectangle = slide.Shapes.AddShape(AutoShapeType.Rectangle, 200, 300, 250, 200); + // Add a Oval shape on the slide + IShape oval = slide.Shapes.AddShape(AutoShapeType.Oval, 600, 10, 250, 250); + // Add connector on the slide + IConnector connector = slide.Shapes.AddConnector(ConnectorType.Straight, 10, 10, 10, 10); + // Set the begin connection + connector.BeginConnect(rectangle, 2); + // Set the end connection + connector.EndConnect(oval, 3); + // Get the end connected site index + int endSiteIndex = connector.EndConnectionSiteIndex; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + ' Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + ' Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + ' Add Rectangle shape on the slide + Dim rectangle As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 200, 300, 250, 200) + ' Add Oval shape on the slide + Dim oval As IShape = slide.Shapes.AddShape(AutoShapeType.Oval, 600, 10, 250, 250) + ' Add connector on the slide + Dim connector As IConnector = slide.Shapes.AddConnector(ConnectorType.Straight, 10, 10, 10, 10) + ' Set the begin connection + connector.BeginConnect(rectangle, 2) + ' Set the end connection + connector.EndConnect(oval, 3) + ' Get the end connected site index + Dim endSiteIndex As int = connector.EndConnectionSiteIndex + ' Save the presentation file + ppDoc.Save("Sample.pptx") + ' Close the presentation file + ppDoc.Close + + + + + + Compares the current Shape object with given Shape object. + + The Shape object to compare with the current instance. + True if the Shape objects are equal; otherwise, false. + + + + Get the direction of the given port + + + + + + + + Corners of the rectangle + + + + + Thickness to represent the margin thickness + + + + + Segmets represent the type of connector + + + + + IConnectorSegment + + + + + Angle is chosen internally + + + + + Absolute angle: 180 Degree + + + + + Absolute angle: 270 Degree or -90 Degree + + + + + Absolute angle: 0 degree + + + + + Absolute angle: 90 degree + + + + + Relative Angle: 0 degree + + + + + Relative Angle: 90 degree + + + + + Relative Angle: 180 degree + + + + + Relative Angle: 270 degree or -90 degree + + + + + Represents the color effect. + + + + + Represents the behavior. + + + + + Get the behavior Accumulate value + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is ISetEffect) + { + // Assign the set effect values + ISetEffect setEffect = (behavior as ISetEffect); + setEffect.Accumulate = null; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is set effect + If (TypeOf behavior Is SetEffect) Then + 'Assign the set effect values + Dim setEffect As SetEffect = TryCast(behavior,SetEffect) + setEffect.Accumulate = Nothing + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the behavior Additive value + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is ISetEffect) + { + // Assign the set effect values + ISetEffect setEffect = (behavior as ISetEffect); + setEffect.Additive = BehaviorAdditiveType.NotDefined; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is set effect + If (TypeOf behavior Is SetEffect) Then + 'Assign the set effect values + Dim setEffect As SetEffect = TryCast(behavior,SetEffect) + setEffect.Additive = BehaviorAdditiveType.NotDefined + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the properties values of behavior + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is ISetEffect) + { + // Assign the set effect values + ISetEffect setEffect = (behavior as ISetEffect); + IBehaviorProperties setProperties = setEffect.Properties; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is set effect + If (TypeOf behavior Is SetEffect) Then + 'Assign the set effect values + Dim setEffect As SetEffect = TryCast(behavior,SetEffect) + Dim setProperties As IBehaviorProperties = setEffect.Properties + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the list of timing values of behavior + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is ISetEffect) + { + // Assign the set effect values + ISetEffect setEffect = (behavior as ISetEffect); + ITiming setTiming = setEffect.Timing; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is set effect + If (TypeOf behavior Is SetEffect) Then + 'Assign the set effect values + Dim setEffect As SetEffect = TryCast(behavior,SetEffect) + Dim setTiming As ITiming = setEffect.Timing + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the from color value of animation + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IColorEffect) + { + // Assign the color effect values + IColorEffect colorEffect = (behavior as IColorEffect); + IColor fromColor = colorEffect.From; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is color effect + If (TypeOf behavior Is ColorEffect) Then + 'Assign the color effect values + Dim colorEffect As ColorEffect = TryCast(behavior,ColorEffect) + Dim fromColor As IColor = colorEffect.From + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the to color value of animation + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IColorEffect) + { + // Assign the color effect values + IColorEffect colorEffect = (behavior as IColorEffect); + IColor toColor = colorEffect.To; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is color effect + If (TypeOf behavior Is ColorEffect) Then + 'Assign the color effect values + Dim colorEffect As ColorEffect = TryCast(behavior,ColorEffect) + Dim toColor As IColor = colorEffect.[To] + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the color offset by value of animation + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IColorEffect) + { + // Assign the color effect values + IColorEffect colorEffect = (behavior as IColorEffect); + IColorOffset byOffSet = colorEffect.By; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is color effect + If (TypeOf behavior Is ColorEffect) Then + 'Assign the color effect values + Dim colorEffect As ColorEffect = TryCast(behavior,ColorEffect) + IColorOffset byOffSet = colorEffect.By + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the colorspace value + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IColorEffect) + { + // Assign the color effect values + IColorEffect colorEffect = (behavior as IColorEffect); + colorEffect.ColorSpace = ColorSpace.HSL; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is color effect + If (TypeOf behavior Is ColorEffect) Then + 'Assign the color effect values + Dim colorEffect As ColorEffect = TryCast(behavior,ColorEffect) + colorEffect.ColorSpace = ColorSpace.HSL + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the direction of color value + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IColorEffect) + { + // Assign the color effect values + IColorEffect colorEffect = (behavior as IColorEffect); + colorEffect.Direction = ColorDirection.ClockWise; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is color effect + If (TypeOf behavior Is ColorEffect) Then + 'Assign the color effect values + Dim colorEffect As ColorEffect = TryCast(behavior,ColorEffect) + colorEffect.Direction = ColorDirection.ClockWise; + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the command effect type of animation + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.GrowShrink, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is ICommandEffect) + { + // Assign the command effect values + ICommandEffect commandEffect = (behavior as ICommandEffect); + ICommandEffectType commandEffectType = commandEffect.Type; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.GrowShrink, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is command effect + If (TypeOf behavior Is CommandEffect) Then + 'Assign the command effect values + Dim commandEffect As CommandEffect = TryCast(behavior,CommandEffect) + Dim commandEffectType As CommandEffectType = commandEffect.Type + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the command string value of animation + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.GrowShrink, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is ICommandEffect) + { + // Assign the command effect values + ICommandEffect commandEffect = (behavior as ICommandEffect); + string commandString = commandEffect.CommandString; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.GrowShrink, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is command effect + If (TypeOf behavior Is CommandEffect) Then + 'Assign the command effect values + Dim commandEffect As CommandEffect = TryCast(behavior,CommandEffect) + Dim commandString As String = commandEffect.CommandString + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the shape target value + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].TimeLine.MainSequence.AddEffect(shape, EffectType.GrowShrink, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is ICommandEffect) + { + // Assign the command effect values + ICommandEffect commandEffect = (behavior as ICommandEffect); + IShape shapeTarget = commandEffect.ShapeTarget; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.GrowShrink, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is command effect + If (TypeOf behavior Is CommandEffect) Then + 'Assign the command effect values + Dim commandEffect As CommandEffect = TryCast(behavior,CommandEffect) + Dim shapeTarget As IShape = commandEffect.ShapeTarget + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Represents the filter effect. + + + + + Get the filter effect reveal type + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.GrowShrink, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IFilterEffect) + { + // Assign the filter effect values + IFilterEffect filterEffect = (behavior as IFilterEffect); + filterEffect.Reveal = FilterEffectRevealType.In; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.GrowShrink, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is filter effect + If (TypeOf behavior Is FilterEffect) Then + 'Assign the filter effect values + Dim filterEffect As FilterEffect = TryCast(behavior,FilterEffect) + filterEffect.Reveal = FilterEffectRevealType.[In] + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the type of filter effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.GrowShrink, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IFilterEffect) + { + // Assign the filter effect values + IFilterEffect filterEffect = (behavior as IFilterEffect); + filterEffect.Type = FilterEffectType.Dissolve; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.GrowShrink, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is filter effect + If (TypeOf behavior Is FilterEffect) Then + 'Assign the filter effect values + Dim filterEffect As FilterEffect = TryCast(behavior,FilterEffect) + filterEffect.Type = FilterEffectType.Dissolve + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the subtype of filter effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.GrowShrink, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IFilterEffect) + { + // Assign the filter effect values + IFilterEffect filterEffect = (behavior as IFilterEffect); + filterEffect.Subtype = SubtypeFilterEffect.None; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.GrowShrink, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is filter effect + If (TypeOf behavior Is FilterEffect) Then + 'Assign the filter effect values + Dim filterEffect As FilterEffect = TryCast(behavior,FilterEffect) + filterEffect.Subtype = SubtypeFilterEffect.None + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Represents the motion effect. + + + + + Get the from value of motion effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IMotionEffect) + { + // Assign the motion effect values + IMotionEffect motionEffect = (behavior as IMotionEffect); + PointF fromValue = motionEffect.From; + fromValue.X = 400; + fromValue.Y = 500; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is motion effect + If (TypeOf behavior Is MotionEffect) Then + 'Assign the motion effect values + Dim motionEffect As MotionEffect = TryCast(behavior,MotionEffect) + Dim fromValue As PointF = motionEffect.From + fromValue.X = 400 + fromValue.Y = 500 + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the To value of motion effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IMotionEffect) + { + // Assign the motion effect values + IMotionEffect motionEffect = (behavior as IMotionEffect); + PointF toValue = motionEffect.To; + toValue.X = 400; + toValue.Y = 500; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is motion effect + If (TypeOf behavior Is MotionEffect) Then + 'Assign the motion effect values + Dim motionEffect As MotionEffect = TryCast(behavior,MotionEffect) + Dim toValue As PointF = motionEffect.To + toValue.X = 400 + toValue.Y = 500 + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the By value of motion effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IMotionEffect) + { + // Assign the motion effect values + IMotionEffect motionEffect = (behavior as IMotionEffect); + PointF byValue = motionEffect.By; + byValue.X = 400; + byValue.Y = 500; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is motion effect + If (TypeOf behavior Is MotionEffect) Then + 'Assign the motion effect values + Dim motionEffect As MotionEffect = TryCast(behavior,MotionEffect) + Dim byValue As PointF = motionEffect.By + byValue.X = 400 + byValue.Y = 500 + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the rotation center value of motion effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IMotionEffect) + { + // Assign the motion effect values + IMotionEffect motionEffect = (behavior as IMotionEffect); + PointF rotationValue = motionEffect.RotationCenter; + rotationValue.X = 400; + rotationValue.Y = 500; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is motion effect + If (TypeOf behavior Is MotionEffect) Then + 'Assign the motion effect values + Dim motionEffect As MotionEffect = TryCast(behavior,MotionEffect) + Dim rotationValue As PointF = motionEffect.RotationCenter + rotationValue.X = 400 + rotationValue.Y = 500 + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the origin type of motion effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IMotionEffect) + { + // Assign the motion effect values + IMotionEffect motionEffect = (behavior as IMotionEffect); + motionEffect.Origin = MotionOriginType.Layout; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is motion effect + If (TypeOf behavior Is MotionEffect) Then + 'Assign the motion effect values + Dim motionEffect As MotionEffect = TryCast(behavior,MotionEffect) + motionEffect.Origin = MotionOriginType.Layout + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the path value of the motion effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IMotionEffect) + { + // Assign the motion effect values + IMotionEffect motionEffect = (behavior as IMotionEffect); + IMotionPath path = (motionEffect.Path as IMotionPath); + path[0].CommandType = MotionCommandPathType.MoveTo; + path[0].IsRelative = false; + path[0].PointsType = MotionPathPointsType.Auto; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is motion effect + If (TypeOf behavior Is MotionEffect) Then + 'Assign the motion effect values + Dim motionEffect As MotionEffect = TryCast(behavior,MotionEffect) + Dim path As MotionPath = TryCast(motionEffect.Path, MotionPath) + path(0).CommandType = MotionCommandPathType.MoveTo; + path(0).IsRelative = false; + path(0).PointsType = MotionPathPointsType.Auto; + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the path edit mode of motion effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IMotionEffect) + { + // Assign the motion effect values + IMotionEffect motionEffect = (behavior as IMotionEffect); + motionEffect.PathEditMode = MotionPathEditMode.Relative; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is motion effect + If (TypeOf behavior Is MotionEffect) Then + 'Assign the motion effect values + Dim motionEffect As MotionEffect = TryCast(behavior,MotionEffect) + motionEffect.PathEditMode = MotionPathEditMode.Relative + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the Angle value from the motion animation effect. + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IMotionEffect) + { + // Assign the motion effect values + IMotionEffect motionEffect = (behavior as IMotionEffect); + motionEffect.Angle = 30; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is motion effect + If (TypeOf behavior Is MotionEffect) Then + 'Assign the motion effect values + Dim motionEffect As MotionEffect = TryCast(behavior,MotionEffect) + motionEffect.Angle = 30 + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Represents the property effect. + + + + + Get the from value of property effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Flip, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IPropertyEffect) + { + // Assign the property effect values + IPropertyEffect propertyEffect = (behavior as IPropertyEffect); + propertyEffect.From = "(#ppt_x*2)"; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Flip, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is property effect + If (TypeOf behavior Is PropertyEffect) Then + 'Assign the property effect values + Dim propertyEffect As PropertyEffect = TryCast(behavior,PropertyEffect) + propertyEffect.From = "(#ppt_x*2)" + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the To value of property effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Flip, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IPropertyEffect) + { + // Assign the property effect values + IPropertyEffect propertyEffect = (behavior as IPropertyEffect); + propertyEffect.To = "1.5"; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Flip, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is property effect + If (TypeOf behavior Is PropertyEffect) Then + 'Assign the property effect values + Dim propertyEffect As PropertyEffect = TryCast(behavior,PropertyEffect) + propertyEffect.To = "1.5" + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the By value of property effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Flip, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IPropertyEffect) + { + // Assign the property effect values + IPropertyEffect propertyEffect = (behavior as IPropertyEffect); + propertyEffect.By = "(#ppt_w*2)"; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Flip, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is property effect + If (TypeOf behavior Is PropertyEffect) Then + 'Assign the property effect values + Dim propertyEffect As PropertyEffect = TryCast(behavior,PropertyEffect) + propertyEffect.By = "(#ppt_w*2)" + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the Value type of property effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Flip, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IPropertyEffect) + { + // Assign the property effect values + IPropertyEffect propertyEffect = (behavior as IPropertyEffect); + propertyEffect.ValueType = PropertyValueType.String; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Flip, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is property effect + If (TypeOf behavior Is PropertyEffect) Then + 'Assign the property effect values + Dim propertEffect As PropertyEffect = TryCast(behavior,PropertyEffect) + propertyEffect.ValueType = PropertyValueType.[String] + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the Calcmode value of property effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Fly, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IPropertyEffect) + { + // Assign the property effect values + IPropertyEffect propertyEffect = (behavior as IPropertyEffect); + propertyEffect.CalcMode = PropertyCalcModeType.Formula; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Fly, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is property effect + If (TypeOf behavior Is PropertyEffect) Then + 'Assign the property effect values + Dim propertyEffect As PropertyEffect = TryCast(behavior,PropertyEffect) + propertyEffect.CalcMode = PropertyCalcModeType.Formula + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the Points value of property effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Fly, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IPropertyEffect) + { + // Assign the property effect values + IPropertyEffect propertyEffect = (behavior as IPropertyEffect); + IAnimationPoints points = propertyEffect.Points; + points[0].Formula = "0.5"; + points[0].Time = 90; + points[0].Value = "#ppt_x"; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Fly, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is property effect + If (TypeOf behavior Is PropertyEffect) Then + 'Assign the property effect values + Dim propertyEffect As PropertyEffect = TryCast(behavior,PropertyEffect) + Dim points As IAnimationPoints = propertyEffect.Points + points(0).Formula = "0.5" + points(0).Time = 90 + points(0).Value = "#ppt_x" + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Represents the rotation effect. + + + + + Get the from value of rotation effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Teeter, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IRotationEffect) + { + // Assign the rotation effect values + IRotationEffect rotationEffect = (behavior as IRotationEffect); + rotationEffect.From = 10000; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Teeter, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is rotation effect + If (TypeOf behavior Is RotationEffect) Then + 'Assign the rotation effect values + Dim rotationEffect As RotationEffect = TryCast(behavior,RotationEffect) + rotationEffect.From = 10000 + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the To value of rotation effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Teeter, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IRotationEffect) + { + // Assign the rotation effect values + IRotationEffect rotationEffect = (behavior as IRotationEffect); + rotationEffect.To = 15000; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Teeter, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is rotation effect + If (TypeOf behavior Is RotationEffect) Then + 'Assign the rotation effect values + Dim rotationEffect As RotationEffect = TryCast(behavior,RotationEffect) + rotationEffect.To = 15000 + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the By value of rotation effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Teeter, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IRotationEffect) + { + // Assign the rotation effect values + IRotationEffect rotationEffect = (behavior as IRotationEffect); + rotationEffect.By = 20000; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Teeter, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is rotation effect + If (TypeOf behavior Is RotationEffect) Then + 'Assign the scale effect values + Dim rotationEffect As RotationEffect = TryCast(behavior,RotationEffect) + rotationEffect.By = 20000 + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Represents the scale effect. + + + + + Get the ZoomContent value of Scale effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.GrowShrink, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IScaleEffect) + { + // Assign the scale effect values + IScaleEffect scaleEffect = (behavior as IScaleEffect); + scaleEffect.ZoomContent = false; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.GrowShrink, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is scale effect + If (TypeOf behavior Is ScaleEffect) Then + 'Assign the scale effect values + Dim scaleEffect As ScaleEffect = TryCast(behavior,ScaleEffect) + scaleEffect.ZoomContent = False + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the From value of scale effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.GrowShrink, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IScaleEffect) + { + // Assign the scale effect values + IScaleEffect scaleEffect = (behavior as IScaleEffect); + PointF point = new PointF(); + point.X = 400; + point.Y = 500; + scaleEffect.From = point; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.GrowShrink, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + If TypeOf behavior Is ScaleEffect Then + 'Assign the scale effect values + Dim scaleEffect As ScaleEffect = TryCast(behavior, ScaleEffect) + Dim point As New PointF() + point.X = 400 + point.Y = 500 + scaleEffect.From = point + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the To value of scale effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.GrowShrink, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IScaleEffect) + { + // Assign the scale effect values + IScaleEffect scaleEffect = (behavior as IScaleEffect); + PointF point = new PointF(); + point.X = 400; + point.Y = 500; + scaleEffect.To = point; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.GrowShrink, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is scale effect + If (TypeOf behavior Is ScaleEffect) Then + 'Assign the scale effect values + Dim scaleEffect As ScaleEffect = TryCast(behavior, ScaleEffect) + Dim point As New PointF() + point.X = 400 + point.Y = 500 + scaleEffect.[To] = point + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the By value of scale effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.GrowShrink, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IScaleEffect) + { + // Assign the scale effect values + IScaleEffect scaleEffect = (behavior as IScaleEffect); + PointF point = new PointF(); + point.X = 400; + point.Y = 500; + scaleEffect.By = point; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.GrowShrink, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is scale effect + If (TypeOf behavior Is ScaleEffect) Then + 'Assign the scale effect values + Dim scaleEffect As ScaleEffect = TryCast(behavior, ScaleEffect) + Dim point As New PointF() + point.X = 400 + point.Y = 500 + scaleEffect.By = point + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Represents the set effect. + + + + + Get the To value of set effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is ISetEffect) + { + // Assign the set effect values + ISetEffect setEffect = (behavior as ISetEffect); + setEffect.To = "solid"; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is set effect + If (TypeOf behavior Is SetEffect) Then + 'Assign the set effect values + Dim setEffect As SetEffect = TryCast(behavior,SetEffect) + setEffect.[To] = "solid" + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Represents the size and bounds of notes. + + + + + Gets or sets the height, in percentage. + + + + + Specifies a collection of sections in a presentation. + + + + + Adds a new section at the last index position and returns the instance of the newly created section. + + Returns the instance. + + + //Creates a PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Adds a section to the PowerPoint presentation + ISection section = presentation.Sections.Add(); + //Sets a name to the created section + section.Name = "SectionDemo"; + //Adds a slide to the created section + ISlide slide = section.AddSlide(SlideLayoutType.Blank); + //Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo"); + //Saves the PowerPoint presentation + presentation.Save("Section.pptx"); + + + 'Creates a PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Adds a section to the PowerPoint presentation + Dim section As ISection = presentation__1.Sections.Add() + 'Sets a name to the created section + section.Name = "SectionDemo" + 'Adds a slide to the created section + Dim slide As ISlide = section.AddSlide(SlideLayoutType.Blank) + 'Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo") + 'Saves the PowerPoint presentation + presentation__1.Save("Section.pptx") + + + + + + Removes all the sections in the presentation. + + + + //Creates a PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Adds a section to the PowerPoint presentation + ISection section = presentation.Sections.Add(); + //Adds a slide to the created section + ISlide slide = section.AddSlide(SlideLayoutType.Blank); + //Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo"); + //Removes the sections + presentation.Sections.Clear(); + //Saves the PowerPoint presentation + presentation.Save("Section.pptx"); + + + 'Creates a PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Adds a section to the PowerPoint presentation + Dim section As ISection = presentation__1.Sections.Add() + 'Adds a slide to the created section + Dim slide As ISlide = section.AddSlide(SlideLayoutType.Blank) + 'Removes the sections + presentation.Sections.Clear() + 'Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo") + 'Saves the PowerPoint presentation + presentation__1.Save("Section.pptx") + + + + + + Inserts an element into the section collection at the specified index. + + The zero-based index at which section should be inserted. + The section instance to insert. + + + //Creates a PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Adds a section to the PowerPoint presentation + ISection section1 = presentation.Sections.Add(); + //Adds a section to the PowerPoint presentation + ISection section2 = presentation.Sections.Add(); + //Adds a slide to the created section + ISlide slide = section1.AddSlide(SlideLayoutType.Blank); + //Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo"); + //Insert a section at the specified index. + presentation.Sections.Insert(0,section2); + //Saves the PowerPoint presentation + presentation.Save("Section.pptx"); + + + 'Creates a PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Adds a section to the PowerPoint presentation + Dim section1 As ISection = presentation__1.Sections.Add() + 'Adds a section to the PowerPoint presentation + Dim section2 As ISection = presentation__1.Sections.Add() + 'Adds a slide to the created section + Dim slide As ISlide = section.AddSlide(SlideLayoutType.Blank) + 'Insert a section at the specified index + presentation.Sections.Insert(0,section2) + 'Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo") + 'Saves the PowerPoint presentation + presentation__1.Save("Section.pptx") + + + + + + Removes the first occurrence of a specified section from the section collection. + + Represent the instance to be removed. + + + //Creates a PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Adds a section to the PowerPoint presentation + ISection section1 = presentation.Sections.Add(); + //Adds a section to the PowerPoint presentation + ISection section2 = presentation.Sections.Add(); + //Adds a slide to the created section + ISlide slide = section1.AddSlide(SlideLayoutType.Blank); + //Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo"); + //Remove the section. + presentation.Sections.Remove(section2); + //Saves the PowerPoint presentation + presentation.Save("Section.pptx"); + + + 'Creates a PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Adds a section to the PowerPoint presentation + Dim section1 As ISection = presentation__1.Sections.Add() + 'Adds a section to the PowerPoint presentation + Dim section2 As ISection = presentation__1.Sections.Add() + 'Adds a slide to the created section + Dim slide As ISlide = section.AddSlide(SlideLayoutType.Blank) + 'Remove the section + presentation.Sections.Remove(section2) + 'Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo") + 'Saves the PowerPoint presentation + presentation__1.Save("Section.pptx") + + + + + + Removes the section at the specified index, from the section collection. + + Represents the index at which the section is to be removed. + + + //Creates a PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Adds a section to the PowerPoint presentation + ISection section1 = presentation.Sections.Add(); + //Adds a section to the PowerPoint presentation + ISection section2 = presentation.Sections.Add(); + //Adds a slide to the created section + ISlide slide = section1.AddSlide(SlideLayoutType.Blank); + //Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo"); + //Remove the section at the specified index. + presentation.Sections.RemoveAt(1); + //Saves the PowerPoint presentation + presentation.Save("Section.pptx"); + + + 'Creates a PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Adds a section to the PowerPoint presentation + Dim section1 As ISection = presentation__1.Sections.Add() + 'Adds a section to the PowerPoint presentation + Dim section2 As ISection = presentation__1.Sections.Add() + 'Adds a slide to the created section + Dim slide As ISlide = section.AddSlide(SlideLayoutType.Blank) + 'Remove the section at the specified index + presentation.Sections.RemoveAt(1) + 'Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo") + 'Saves the PowerPoint presentation + presentation__1.Save("Section.pptx") + + + + + + Returns the number of instance in the section collection. Read-only. + + + + //Creates a PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Adds a section to the PowerPoint presentation + ISection section = presentation.Sections.Add(); + //Adds a slide to the created section + ISlide slide = section.AddSlide(SlideLayoutType.Blank); + //Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo"); + //Get the count of the section in a presentation + int count = presentation.Sections.Count; + //Saves the PowerPoint presentation + presentation.Save("Section.pptx"); + + + 'Creates a PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Adds a section to the PowerPoint presentation + Dim section As ISection = presentation__1.Sections.Add() + 'Adds a slide to the created section + Dim slide As ISlide = section.AddSlide(SlideLayoutType.Blank) + 'Get the count of the section in a presentation + int count = presentation.Sections.Count + 'Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo") + 'Saves the PowerPoint presentation + presentation__1.Save("Section.pptx") + + + + + + Gets the instance at the specified index in section collection. Read-only. + + The index to locate the section. + Returns the section at the specified index in section collection. + + + //Creates a PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Adds a section to the PowerPoint presentation + ISection section1 = presentation.Sections.Add(); + //Adds a section to the PowerPoint presentation + presentation.Sections.Add(); + //Adds a slide to the created section + ISlide slide = section1.AddSlide(SlideLayoutType.Blank); + //Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo"); + //Get the section + ISection section2 = presentation.Sections[1]; + //Saves the PowerPoint presentation + presentation.Save("Section.pptx"); + + + 'Creates a PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Adds a section to the PowerPoint presentation + Dim section1 As ISection = presentation__1.Sections.Add() + 'Adds a section to the PowerPoint presentation + presentation__1.Sections.Add() + 'Adds a slide to the created section + Dim slide As ISlide = section.AddSlide(SlideLayoutType.Blank) + 'Get the section + Dim section2 As ISection = presentation.Sections(1) + 'Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo") + 'Saves the PowerPoint presentation + presentation__1.Save("Section.pptx") + + + + + + Specifies a section in the presentation + + + + + Moves the specified section to the specified index position within the presentation. + + The position at which the section is to be moved. + + + //Creates a PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Adds a section to the PowerPoint presentation + ISection section = presentation.Sections.Add(); + //Adds a section to the PowerPoint presentation + presentation.Sections.Add(); + //Adds a section to the PowerPoint presentation + presentation.Sections.Add(); + //Sets a name to the created section + section.Name = "SectionDemo"; + //Adds a slide to the created section + ISlide slide = section.AddSlide(SlideLayoutType.Blank); + //Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo"); + // Move the section at the specified index + presentation.Sections[1].Move(2); + //Saves the PowerPoint presentation + presentation.Save("Section.pptx"); + + + 'Creates a PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Adds a section to the PowerPoint presentation + Dim section As ISection = presentation__1.Sections.Add() + 'Adds a section to the PowerPoint presentation + presentation__1.Sections.Add() + 'Adds a section to the PowerPoint presentation + presentation__1.Sections.Add() + 'Sets a name to the created section + section.Name = "SectionDemo" + 'Adds a slide to the created section + Dim slide As ISlide = section.AddSlide(SlideLayoutType.Blank) + 'Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo") + 'Move the section at the specified index + presentation.Sections(2).Move(3) + 'Saves the PowerPoint presentation + presentation__1.Save("Section.pptx") + + + + + + Creates a slide with the specified layout type and adds the new slide to the end of section. + + Specifies the slide layout type. + Returns the newly created instance. + + + //Creates a PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Adds a section to the PowerPoint presentation + ISection section = presentation.Sections.Add(); + //Sets a name to the created section + section.Name = "SectionDemo"; + //Adds a slide to the created section + ISlide slide = section.AddSlide(SlideLayoutType.Blank); + //Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo"); + //Saves the PowerPoint presentation + presentation.Save("Section.pptx"); + + + 'Creates a PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Adds a section to the PowerPoint presentation + Dim section As ISection = presentation__1.Sections.Add() + 'Sets a name to the created section + section.Name = "SectionDemo" + 'Adds a slide to the created section + Dim slide As ISlide = section.AddSlide(SlideLayoutType.Blank) + 'Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo") + 'Saves the PowerPoint presentation + presentation__1.Save("Section.pptx") + + + + + + Inserts an element into the slide collection at the specified index within the section. + + The zero-based index at which the section should be inserted. + The section instance to be inserted. + + + //Creates a PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Adds a section to the PowerPoint presentation + ISection section = presentation.Sections.Add(); + //Adds a slide to the created section + ISlide slide1 = section.AddSlide(SlideLayoutType.Blank); + //Adds a slide to the created section + ISlide slide2 = section.AddSlide(SlideLayoutType.Blank); + //Insert a slide at the specified index + section.InsertSlide(0,slide2); + //Adds a text box to the slide + slide1.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo"); + //Saves the PowerPoint presentation + presentation.Save("Section.pptx"); + + + 'Creates a PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Adds a section to the PowerPoint presentation + Dim section As ISection = presentation__1.Sections.Add() + 'Sets a name to the created section + section.Name = "SectionDemo" + 'Adds a slide to the created section + Dim slide1 As ISlide = section.AddSlide(SlideLayoutType.Blank) + 'Adds a slide to the created section + Dim slide2 As ISlide = section.AddSlide(SlideLayoutType.Blank) + //Insert a slide at the specified index + section.InsertSlide(0,slide2); + 'Adds a text box to the slide + slide1.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo") + 'Saves the PowerPoint presentation + presentation__1.Save("Section.pptx") + + + + + + Creates an independent copy of instance. + + Returns the instance. + + + //Creates a PowerPoint presentation1 + IPresentation presentation1 = Presentation.Create(); + //Creates a PowerPoint presentation2 + IPresentation presentation2 = Presentation.Create(); + //Adds a section to the PowerPoint presentation + ISection section = presentation1.Sections.Add(); + //Adds a slide to the created section + ISlide slide = section.AddSlide(SlideLayoutType.Blank); + //Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo"); + //Clones the slides in 3rd section + ISlides slides = presentation1.Sections[0].Clone(); + //Iterates the cloned slides and adds the slides to the destination presentation + foreach (ISlide slide1 in slides) + presentation2.Slides.Add(slide1); + //Saves the PowerPoint presentation + presentation2.Save("Section.pptx"); + + + 'Creates a PowerPoint presentation1 + Dim presentation1 As IPresentation = Presentation.Create() + 'Creates a PowerPoint presentation2 + Dim presentation2 As IPresentation = Presentation.Create() + 'Adds a section to the PowerPoint presentation + Dim section As ISection = presentation1.Sections.Add() + 'Adds a slide to the created section + Dim slide As ISlide = section.AddSlide(SlideLayoutType.Blank) + 'Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo") + 'Clones the slides in 3rd section + Dim slides As ISlides = presentation.Sections(1).Clone() + 'Iterates the cloned slides and adds the slides to the destination presentation + For Each slide1 As ISlide In slides + presentation2.Slides.Add(slide1) + Next + 'Saves the PowerPoint presentation + presentation2.Save("Section.pptx") + + + + + + Gets or sets the name of the specified section. + + One or more sections may share a same name within the presentation. + + + //Creates a PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Adds a section to the PowerPoint presentation + ISection section = presentation.Sections.Add(); + //Sets a name to the created section + section.Name = "SectionDemo"; + //Adds a slide to the created section + ISlide slide = section.AddSlide(SlideLayoutType.Blank); + //Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo"); + //Saves the PowerPoint presentation + presentation.Save("Section.pptx"); + + + 'Creates a PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Adds a section to the PowerPoint presentation + Dim section As ISection = presentation__1.Sections.Add() + 'Sets a name to the created section + section.Name = "SectionDemo" + 'Adds a slide to the created section + Dim slide As ISlide = section.AddSlide(SlideLayoutType.Blank) + 'Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo") + 'Saves the PowerPoint presentation + presentation__1.Save("Section.pptx") + + + + + + Gets the number of slides in the specified section. Read-only. + + + + //Creates a PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Adds a section to the PowerPoint presentation + ISection section = presentation.Sections.Add(); + //Sets a name to the created section + section.Name = "SectionDemo"; + //Adds a slide to the created section + ISlide slide = section.AddSlide(SlideLayoutType.Blank); + //Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo"); + //Gets the number of slides in the specified section + int slidesCount = section.SlidesCount; + //Saves the PowerPoint presentation + presentation.Save("Section.pptx"); + + + 'Creates a PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Adds a section to the PowerPoint presentation + Dim section As ISection = presentation__1.Sections.Add() + 'Sets a name to the created section + section.Name = "SectionDemo" + 'Adds a slide to the created section + Dim slide As ISlide = section.AddSlide(SlideLayoutType.Blank) + 'Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo") + 'Gets the number of slides in the specified section + Dim slidesCount As int = section.SlidesCount + 'Saves the PowerPoint presentation + presentation__1.Save("Section.pptx") + + + + + + Gets the slide collection of instance. Read-only. + + Returns the instance. + + + //Creates a PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Adds a section to the PowerPoint presentation + ISection section = presentation.Sections.Add(); + //Sets a name to the created section + section.Name = "SectionDemo"; + //Adds a slide to the created section + ISlide slide = section.AddSlide(SlideLayoutType.Blank); + //Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo"); + //Gets the collection of slides in the specified section + ISlides slides = section.Slides; + //Saves the PowerPoint presentation + presentation.Save("Section.pptx"); + + + 'Creates a PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Adds a section to the PowerPoint presentation + Dim section As ISection = presentation__1.Sections.Add() + 'Sets a name to the created section + section.Name = "SectionDemo" + 'Adds a slide to the created section + Dim slide As ISlide = section.AddSlide(SlideLayoutType.Blank) + 'Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo") + 'Gets the collection of slides in the specified section + Dim slides As ISlides = section.Slides + 'Saves the PowerPoint presentation + presentation__1.Save("Section.pptx") + + + + + + Add the slide into current section. + + + + + + Remove the slide from current section. + + + + + + Represents the notes slide in a slide of the presentation. + + + + + Represents a base slide in a presentation. + + + Contains members which are common for slide, layout slide and master slide. + + + + + Finds the text based on specified string, taking into the consideration of caseSensitive and wholeWord options. + + + A text to find. + + + Set to true to match the similar case text which specified in the parameter; otherwise false. + + + Set to true to match the whole word text which specified in the parameter; otherwise false. + + + The that contains the found text in the document. + + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with a text + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Hello World"); + // Finds the text from the Presentation document + ITextSelection textSelection = slide.Find("World", false, false); + // Gets the found text containing text parts + foreach (ITextPart textPart in textSelection.GetTextParts()) + { + //Sets Bold property + textPart.Font.Bold = true; + } + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Creates a presentation. + Dim presentation As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + 'Add a new paragraph with a text + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Hello World") + 'Finds the text from the Presentation document + Dim textSelection As ITextSelection = slide.Find("World", False, False) + 'Gets the text parts from the selection + For Each textPart As ITextPart In textSelection.GetTextParts() + textPart.Font.Bold = True + Next + presentation.Save("Output.pptx") + presentation.Close() + + + + + + Finds the first occurrence of text that matches the specified Regex pattern. + + + The used to find the text. + + + The > that contains the found text in the document. + + + + //Opens an existing presentation. + using (IPresentation pptxDoc = Presentation.Open("Input.pptx")) + { + // Create a regex pattern to find a text that starts with 'H' and ends with 'o'. + Regex regex = new Regex("H.+?o"); + //Find the first occurrence of a specified regular expression. + ITextSelection textSelection = pptxDoc.Slides[0].Find(regex); + //Gets the found text as single text part + ITextPart textPart = textSelection.GetAsOneTextPart(); + //Replace the text + textPart.Text = "Replaced text"; + //Saves the Presentation + pptxDoc.Save("Output.pptx"); + } + + + 'Opens an existing presentation. + Using pptxDoc As IPresentation = Presentation.Open("Input.pptx") + ' Create a regex pattern to find a text that starts with 'H' and ends with 'o'. + Dim regex As Regex = New Regex("H.+?o") + 'Find the first occurrence of a specified regular expression. + Dim textSelection As ITextSelection = pptxDoc.Slides(0).Find(regex) + 'Gets the found text as single text part + Dim textPart As ITextPart = textSelection.GetAsOneTextPart() + 'Replace the text + textPart.Text = "Replaced text" + 'Saves the Presentation + pptxDoc.Save("Output.pptx") + End Using + + + + + + Finds and returns all entries of the specified string, taking into the consideration of caseSensitive and wholeWord options. + + + A text to find. + + + Set to true to match the similar case text which specified in the parameter; otherwise false. + + + Set to true to match the whole word text which specified in the parameter; otherwise false. + + + The collection that contains all the entries of the found text in the document. + + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with a text + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Hello World"); + // Finds the text from the mentioned slide + ITextSelection[] textSelections = slide.FindAll("World", false, false); + foreach (ITextSelection textSelection in textSelections) + { + //Gets the found text as single text part + ITextPart textPart = textSelection.GetAsOneTextPart(); + //Replace the text + textPart.Text = "Replaced text"; + } + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Creates a presentation. + Dim presentation As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + 'Add a new paragraph with a text + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Hello World") + 'Finds the text from the mentioned slide + Dim textSelections As ITextSelection() = slide.FindAll("World", False, False) + 'Gets the found text as single text part and replace it + For Each textSelection As ITextSelection In textSelections + Dim textPart As ITextPart = textSelection.GetAsOneTextPart() + textPart.Text = "Replaced text" + Next + presentation.Save("Output.pptx") + presentation.Close() + + + + + + Finds all occurrences of text that match the specified Regex pattern. + + + The used to find the text. + + + The collection that contains all the entries of the found text in the document. + + + + //Opens an existing presentation. + using (IPresentation pptxDoc = Presentation.Open("Input.pptx")) + { + // Create a regex pattern to find a text that starts with 'H' and ends with 'o'. + Regex regex = new Regex("H.+?o"); + //Finds all the occurrences of a specified regular expression. + ITextSelection[] textSelections = pptxDoc.Slides[0].FindAll(regex); + foreach (ITextSelection textSelection in textSelections) + { + //Gets the found text as single text part + ITextPart textPart = textSelection.GetAsOneTextPart(); + //Replace the text + textPart.Text = "Replaced text"; + } + //Saves the Presentation + pptxDoc.Save("Output.pptx"); + } + + + 'Opens an existing presentation. + Using pptxDoc As IPresentation = Presentation.Open("Input.pptx") + ' Create a regex pattern to find a text that starts with 'H' and ends with 'o'. + Dim regex As Regex = New Regex("H.+?o") + 'Finds all the occurrences of a specified regular expression. + Dim textSelections As ITextSelection() = pptxDoc.Slides(0).FindAll(regex) + For Each textSelection As ITextSelection In textSelections + 'Gets the found text as single text part + Dim textPart As ITextPart = textSelection.GetAsOneTextPart() + 'Replace the text + textPart.Text = "Replaced text" + Next + 'Saves the Presentation + pptxDoc.Save("Output.pptx") + End Using + + + + + + Gets or sets the name of a slide. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Set the name of the slide + slide.Name = "My Slide"; + //Save the presentation + presentation.Save("Slide.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Set the name of the slide + slide.Name = "My Slide" + 'Save the presentation + presentation__1.Save("Slide.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a collection that represents all the elements in the slide. Read-only. + + The collection can contain the drawings, shapes, pictures, text objects, titles, headers, footers, slide numbers, and date and time objects on a slide. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for shapes collection + IShapes shapes = slide.Shapes; + //Add auto shape - rectangle to slide + IShape shape = shapes.AddShape(AutoShapeType.Rectangle,300,400,150,200); + //Save the presentation + presentation.Save("Shapes.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for shapes collection + Dim shapes As IShapes = slide.Shapes + 'Add auto shape - rectangle to slide + Dim shape As IShape = shapes.AddShape(AutoShapeType.Rectangle, 300, 400, 150, 200) + 'Save the presentation + presentation__1.Save("Shapes.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the background of a slide. Read-only. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(); + //Retrieve the background. + IBackground background = slide.Background; + //Retrieve the fill of the background. + IFill fill = background.Fill; + //Set the fill type as gradient. + fill.FillType = FillType.Gradient; + //Retrieve the gradient fill. + IGradientFill gradientFill = fill.GradientFill; + //Add the first gradient stop. + gradientFill.GradientStops.Add(); + //Add the second gradient stop. + gradientFill.GradientStops.Add(); + //Save the presentation. + presentation.Save("Output.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add() + 'Retrieve the background. + Dim background As IBackground = slide.Background + 'Retrieve the fill of the background. + Dim fill As IFill = background.Fill + 'Set the fill type as gradient. + fill.FillType = FillType.Gradient + 'Retrieve the gradient fill. + Dim gradientFill As IGradientFill = fill.GradientFill + 'Add the first gradient stop. + gradientFill.GradientStops.Add() + 'Add the second gradient stop. + gradientFill.GradientStops.Add() + 'Save the presentation. + presentation__1.Save("Output.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets an instance that represents the GroupShape collection in a slide. Read-only. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for group shapes, it is read only + IGroupShapes groupShapes = slide.GroupShapes; + //Add group shape to the collection + IGroupShape groupShape1 = groupShapes.AddGroupShape(12, 12, 300, 350); + IGroupShape groupShape2 = groupShapes.AddGroupShape(34, 50, 200, 100); + IGroupShape groupShape3 = groupShapes.AddGroupShape(70, 30, 120, 100); + //Save the presentation + presentation.Save("GroupShapes.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for group shapes, it is read only + Dim groupShapes As IGroupShapes = slide.GroupShapes + 'Add group shape to the collection + Dim groupShape1 As IGroupShape = groupShapes.AddGroupShape(12, 12, 300, 350) + Dim groupShape2 As IGroupShape = groupShapes.AddGroupShape(34, 50, 200, 100) + Dim groupShape3 As IGroupShape = groupShapes.AddGroupShape(70, 30, 120, 100) + 'Save the presentation + presentation__1.Save("GroupShapes.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets an instance that represents the collection of all pictures in a slide. Read-only. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for shapes collection + IShapes shapes = slide.Shapes; + //Get the image from file path + Image image = Image.FromFile("Image.gif"); + // Add the image to the slide by specifying position and size + shapes.AddPicture(new MemoryStream(image.ImageData), 300, 120, 70, 40); + //Save the presentation + presentation.Save("Picture.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Get the image from file path + Dim image__2 As Image = Image.FromFile("Image.gif") + ' Add the image to the slide by specifying position and size + shapes.AddPicture(New MemoryStream(image__2.ImageData), 300, 120, 70, 40) + 'Save the presentation + presentation__1.Save("Picture.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets an collection that represents the tables in a slide. Read-only. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance to hold table collection + ITables tables = slide.Tables; + //Add table to the slide + ITable table = tables.AddTable(2, 2, 100, 120, 300, 200); + //Retrieve each cell and fill text content to the cell. + ICell cell = table[0, 0]; + cell.TextBody.AddParagraph("First Row and First Column"); + cell = table[0, 1]; + cell.TextBody.AddParagraph("First Row and Second Column"); + cell = table[1, 0]; + cell.TextBody.AddParagraph("Second Row and First Column"); + cell = table[1, 1]; + cell.TextBody.AddParagraph("Second Row and Second Column"); + //Give simple description to table shape + table.Description = "Table arrangement"; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance to hold table collection + Dim tables As ITables = slide.Tables + 'Add table to the slide + Dim table As ITable = tables.AddTable(2, 2, 100, 120, 300, 200) + 'Retrieve each cell and fill text content to the cell. + Dim cell As ICell = table(0, 0) + cell.TextBody.AddParagraph("First Row and First Column") + cell = table(0, 1) + cell.TextBody.AddParagraph("First Row and Second Column") + cell = table(1, 0) + cell.TextBody.AddParagraph("Second Row and First Column") + cell = table(1, 1) + cell.TextBody.AddParagraph("Second Row and Second Column") + 'Give simple description to table shape + table.Description = "Table arrangement" + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets an collection that represents the charts in a slide. Read-only. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Get the chart collection from slide + IPresentationCharts charts = slide.Charts; + //Add chart to slide + IPresentationChart chart =charts.AddChart(400, 300, 100, 100); + //Set the chart title + chart.ChartTitle = "Chart"; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Get the chart collection from slide + Dim charts As IPresentationCharts = slide.Charts + 'Add chart to slide + Dim chart As IPresentationChart = charts.AddChart(400, 300, 100, 100) + 'Set the chart title + chart.ChartTitle = "Chart" + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the slide size for the presentation. Read-only. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Retrieve the side size + ISlideSize slideSize = slide.SlideSize; + //Set slide orientation + slideSize.SlideOrientation = SlideOrientation.Landscape; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Retrieve the side size + Dim slideSize As ISlideSize = slide.SlideSize + 'Set slide orientation + slideSize.SlideOrientation = SlideOrientation.Landscape + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Get the timeline(Animation) of the slide + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Get the timeline(Animation) of the slide + IAnimationTimeline timeLine = slide.Timeline; + // Add animation effect on the slide with shape + IEffect effect = timeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Get the timeline(Animation) of the slide + Dim timeLine As IAnimationTimeLine = slide.TimeLine; + 'Add animation effect on the slide with shape + Dim effect As IEffect = timeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the slide transition for the presentation. Read-only. + + + + //Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + //Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + //Get the slide transition value + ISlideShowTransition transition = slide.SlideTransition; + //Add slide transition for slide + transition.TransitionEffect = TransitionEffect.Airplane; + //Save the presentation file + ppDoc.Save("Sample.pptx"); + //Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Get the slide transition value + Dim transition As ISlideShowTransition = slide.SlideTransition + 'Add slide transition for slide + transition.TransitionEffect = TransitionEffect.Airplane + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Gets a HeadersFooters for the specified slide. + + + Returns an IHeadersFooters object that represents the HeaderFooter collection of a slide. + + + + + Gets an instance that represents the text in the notes page. Read-only. + + + + + Sets the slide name. + + Specifies the slide name. + + + + Gets the slide name. + + Returns string value that represents the slide name. + + + + Remove a animation effect of a specified shape. + + Represent the shape to remove. + + + + Check whether Pictures of current slide is referring a mentioned picture path or not. + + Represents a picture path to search. + Returns true, if current slide picture used a input picture path; Otherwise false. + + + + Checks if an image reference exists within the provided shapes based on the specified picture path. + + The collection of shapes to search through. + The path of the picture to check for. + Returns true if the image reference exists in the shapes, otherwise false. + + + + Finds all the occurance of the given word from slide + + + + + Array of text selection + + + + Finds all the occurance of the given word from slide using Regex pattern + + + Array of text selection + + + + Find the first occurance of the given word + + + + + Text selection + + + + Find the first occurance of the given word using Regex pattern + + + Text selection + + + + Check whether the specified picture is used in some other elements such as Ole Object, Shape Fill, Smart Art Fill, Table Fill, Other picture. + + Represents the image path need to be check. + Represents the base slide shape collections need to be checked. + Returns true if the given image path is used in any of the shape collection elements, otherwise false + + + + Check whether the specified picture is used in some other slides such as other Slides, Layout slides, Master slides, Handout master, Notes master. + + Represents the image path need to be check. + Returns true if any slide contains the picture otherwise false. + + + + Check whether the specified picture is used in the given base slide. + + Represents the base slide of the picture to be checked. + Represents the picture image path need to be checked + Returns true if the picture is used in the given base slide, otherwise false. + + + + Gets VmlShape count. + + Returns Vml shape count if slide has Vml shape else 0. + + + + Compares the current BaseSlide object with given BaseSlide object. + + The BaseSlide object to compare with the current instance. + True if the BaseSlide objects are equal; otherwise, false. + + + + Updates the VML drawing relation for the specified slide if it contains an OLE object with a VML drawing. + + + This method applies to master slides, layout slides, notes slides, or normal slides. + If a VML drawing relation is found, it updates the relation's target to a new VML file with an incremented name based on the presentation's VML drawing count. + + + + + Gets a HeadersFooters of specified slide. Read-only. + + + Returns an IHeadersFooters object that represents the HeaderFooter collection of a slide. + + + + + Set the parent presentation for the notes slide. + + The parent presentation. + + + + Gets an instance that represents the text in the notes page. Read-only. + + + + + Gets the list of dictionaries containing URI hyperlinks and their corresponding rectangle points. + + + + + Represents the smart art graphic with different smart art types. + + + + + Gets a object that contains all the nodes within the SmartArt. Read-only. + + + + // Create an instance of PowerPoint Presentation + IPresentation pptxDoc = Presentation.Create(); + //Add a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Add a BasicBlockList SmartArt to the slide at the specified size and position. + ISmartArt smartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 100, 50, 640, 426); + //Gets the smart art node collection. + ISmartArtNodes nodes = smartArt.Nodes; + //Get the nodes count. + int count = nodes.Count; + //Save the Presentation + pptxDoc.Save("Sample.pptx"); + //Close the Presentation + pptxDoc.Close(); + + + 'Create an instance of PowerPoint Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a BasicBlockList SmartArt to the slide at the specified size and position. + Dim smartArt As ISmartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 100, 50, 640, 426) + 'Gets the smart art node collection. + Dim nodes As ISmartArtNodes = smartArt.Nodes + 'Gets the number of nodes. + Dim count As Integer = smartArt.Nodes.Count + 'Save the Presentation + pptxDoc.Save("Sample.pptx") + 'Close the Presentation + pptxDoc.Close() + + + + + + Gets a value that represents the layout associated with the SmartArt. Read-only. + + + + // Create an instance of PowerPoint Presentation + IPresentation pptxDoc = Presentation.Create(); + //Add a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Add a BasicBlockList SmartArt to the slide at the specified size and position. + ISmartArt smartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 100, 50, 640, 426); + //Sets the background color for the smart art shape + smartArt.Background.SolidFill.Color = ColorObject.AliceBlue; + //Gets the smart art layout. + SmartArtType smartArtType = smartArt.Layout; + //Save the Presentation + pptxDoc.Save("Sample.pptx"); + //Close the Presentation + pptxDoc.Close(); + + + 'Create an instance of PowerPoint Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a BasicBlockList SmartArt to the slide at the specified size and position. + Dim smartArt As ISmartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 100, 50, 640, 426) + 'Sets the background color for the smart art shape + smartArt.Background.SolidFill.Color = ColorObject.AliceBlue + 'Gets the smart art layout. + Dim layoutType As SmartArtType = smartArt.Layout + 'Save the Presentation + pptxDoc.Save("Sample.pptx") + 'Close the Presentation + pptxDoc.Close() + + + + + + Gets a object that represents the SmartArt background. + + + + // Create an instance of PowerPoint Presentation + IPresentation pptxDoc = Presentation.Create(); + //Add a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Add a BasicBlockList SmartArt to the slide at the specified size and position. + ISmartArt smartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 100, 50, 640, 426); + //Sets the background color for the smart art shape + smartArt.Background.SolidFill.Color = ColorObject.AliceBlue; + //Save the Presentation + pptxDoc.Save("Sample.pptx"); + //Close the Presentation + pptxDoc.Close(); + + + 'Create an instance of PowerPoint Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a BasicBlockList SmartArt to the slide at the specified size and position. + Dim smartArt As ISmartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 100, 50, 640, 426) + 'Sets the background color for the smart art shape + smartArt.Background.SolidFill.Color = ColorObject.AliceBlue + 'Save the Presentation + pptxDoc.Save("Sample.pptx") + 'Close the Presentation + pptxDoc.Close() + + + + + + Gets an object that represents the line and arrowhead properties of the SmartArt. Read only. + + + + // Create an instance of PowerPoint Presentation + IPresentation pptxDoc = Presentation.Create(); + //Add a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Add a BasicBlockList SmartArt to the slide at the specified size and position. + ISmartArt smartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 100, 50, 640, 426); + //Sets the line format color for the smart art shape + smartArt.LineFormat.Fill.SolidFill.Color = ColorObject.Blue; + //Save the Presentation + pptxDoc.Save("Sample.pptx"); + //Close the Presentation + pptxDoc.Close(); + + + 'Create an instance of PowerPoint Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a BasicBlockList SmartArt to the slide at the specified size and position. + Dim smartArt As ISmartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 100, 50, 640, 426) + 'Sets the line format color for the smart art shape + smartArt.LineFormat.Fill.SolidFill.Color = ColorObject.Blue + 'Save the Presentation + pptxDoc.Save("Sample.pptx") + 'Close the Presentation + pptxDoc.Close() + + + + + + Represents a single semantic node within the data model of a SmartArt graphic. + + + + + Gets the child nodes associated with the SmartArt node. Read-only. + + + + // Create an instance of PowerPoint Presentation + IPresentation pptxDoc = Presentation.Create(); + //Add a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Add a SmartArt to the slide at the specified size and position. + ISmartArt smartArt = slide.Shapes.AddSmartArt(SmartArtType.AlternatingHexagons, 10, 10, 640, 426); + // Add a new node to the SmartArt. + ISmartArtNode newNode = smartArt.Nodes.Add(); + // Add a child node to the SmartArt node + ISmartArtNode childNode = newNode.ChildNodes.Add(); + // Set a text to newly added child node. + childNode.TextBody.AddParagraph("Child node of the existing node."); + //Save the Presentation. + pptxDoc.Save("Sample.pptx"); + //Close the Presentation. + pptxDoc.Close(); + + + 'Create an instance of PowerPoint Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a SmartArt to the slide at the specified size and position. + Dim smartArt As ISmartArt = slide.Shapes.AddSmartArt(SmartArtType.AlternatingHexagons, 10, 10, 640, 426) + 'Add a new node to the SmartArt. + Dim newNode As ISmartArtNode = smartArt.Nodes.Add() + 'Add a child node to the SmartArt node + Dim childNode As ISmartArtNode = newNode.ChildNodes.Add() + 'Set a text to newly added child node. + childNode.TextBody.AddParagraph("Child node of the existing node.") + 'Save the Presentation. + pptxDoc.Save("Sample.pptx") + 'Close the Presentation. + pptxDoc.Close() + + + + + + Gets the shape collection associated with the SmartArt node. Read-only. + + + + // Create an instance of PowerPoint Presentation + IPresentation pptxDoc = Presentation.Create(); + //Add a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Add a BasicBlockList SmartArt to the slide at the specified size and position. + ISmartArt smartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 0, 0, 640, 426); + //Gets the smart art shape collection from the node. + ISmartArtShapes smartArts = smartArt.Nodes[0].Shapes; + //Gets the first smart art shape from the collection. + ISmartArtShape smartArtShape = smartArts[0]; + //Sets the fill color for the shape. + smartArtShape.Fill.SolidFill.Color = ColorObject.DarkCyan; + //Save the PowerPoint Presentation. + pptxDoc.Save("Sample.pptx"); + //Close the Presentation + pptxDoc.Close(); + + + 'Create an instance of PowerPoint Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a BasicBlockList SmartArt to the slide at the specified size and position. + Dim smartArt As ISmartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 0, 0, 640, 426) + 'Gets the smart art shape collection from the node. + Dim smartArts As ISmartArtShapes = smartArt.Nodes(0).Shapes + 'Gets the first smart art shape from the collection. + Dim smartArtShape As ISmartArtShape = smartArts(0) + 'Sets the fill color for the shape. + smartArtShape.Fill.SolidFill.Color = ColorObject.DarkCyan + 'Save the PowerPoint Presentation. + pptxDoc.Save("Sample.pptx") + 'Close the Presentation + pptxDoc.Close() + + + + + + Gets an instance that represents the text in the SmartArt node. Read-only. + + + + // Create an instance of PowerPoint Presentation + IPresentation pptxDoc = Presentation.Create(); + //Add a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Add a BasicBlockList SmartArt to the slide at the specified size and position. + ISmartArt smartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 0, 0, 640, 426); + //Gets the first node text body. + ITextBody textBody = smartArt.Nodes[0].TextBody; + //Sets the text to the text body. + textBody.AddParagraph("First node text"); + //Save the Presentation + pptxDoc.Save("Sample.pptx"); + //Close the Presentation + pptxDoc.Close(); + + + 'Create an instance of PowerPoint Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a BasicBlockList SmartArt to the slide at the specified size and position. + Dim smartArt As ISmartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 0, 0, 640, 426) + 'Gets the first node text body. + Dim textBody As ITextBody = smartArt.Nodes(0).TextBody + 'Sets the text to the text body. + textBody.AddParagraph("First node text") + 'Save the Presentation + pptxDoc.Save("Sample.pptx") + 'Close the Presentation + pptxDoc.Close() + + + + + + Gets the node level in the hierarchy. + + + + // Create an instance of PowerPoint Presentation + IPresentation pptxDoc = Presentation.Create(); + //Add a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Add a SmartArt to the slide at the specified size and position. + ISmartArt smartArt = slide.Shapes.AddSmartArt(SmartArtType.AlternatingHexagons, 0, 0, 640, 426); + // Add a new node to the SmartArt. + ISmartArtNode newNode = smartArt.Nodes.Add(); + // Add a child node to the SmartArt node + ISmartArtNode childNode = newNode.ChildNodes.Add(); + // Set a text to newly added child node. + childNode.TextBody.AddParagraph("Child node of the existing node."); + //Gets the level of the child node. + int level = childNode.Level; + //Save the Presentation. + pptxDoc.Save("Sample.pptx"); + //Close the Presentation. + pptxDoc.Close(); + + + 'Create an instance of PowerPoint Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a SmartArt to the slide at the specified size and position. + Dim smartArt As ISmartArt = slide.Shapes.AddSmartArt(SmartArtType.AlternatingHexagons, 10, 10, 640, 426) + 'Add a new node to the SmartArt. + Dim newNode As ISmartArtNode = smartArt.Nodes.Add() + 'Add a child node to the SmartArt node + Dim childNode As ISmartArtNode = newNode.ChildNodes.Add() + 'Set a text to newly added child node. + childNode.TextBody.AddParagraph("Child node of the existing node.") + 'Gets the level of the child node. + Dim level As Integer = childNode.Level + 'Save the Presentation. + pptxDoc.Save("Sample.pptx") + 'Close the Presentation. + pptxDoc.Close() + + + + + + Gets the parent of the SmartArt node. + + + + // Create an instance of PowerPoint Presentation + IPresentation pptxDoc = Presentation.Create(); + //Add a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Add a SmartArt to the slide at the specified size and position. + ISmartArt smartArt = slide.Shapes.AddSmartArt(SmartArtType.AlternatingHexagons, 0, 0, 640, 426); + // Add a new node to the SmartArt. + ISmartArtNode newNode = smartArt.Nodes.Add(); + // Add a child node to the SmartArt node + ISmartArtNode childNode = newNode.ChildNodes.Add(); + //Gets the parent node for the child node. + object parent = childNode.Parent; + // Set a text to parent node. + (parent as ISmartArtNode).TextBody.AddParagraph("Parent node for the child node."); + //Save the Presentation. + pptxDoc.Save("Sample.pptx"); + //Close the Presentation. + pptxDoc.Close(); + + + 'Create an instance of PowerPoint Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a SmartArt to the slide at the specified size and position. + Dim smartArt As ISmartArt = slide.Shapes.AddSmartArt(SmartArtType.AlternatingHexagons, 10, 10, 640, 426) + 'Add a new node to the SmartArt. + Dim newNode As ISmartArtNode = smartArt.Nodes.Add() + 'Add a child node to the SmartArt node + Dim childNode As ISmartArtNode = newNode.ChildNodes.Add() + Dim parent As Object = childNode.Parent + TryCast(parent, ISmartArtNode).TextBody.AddParagraph("Parent node for the child node.") + 'Save the Presentation. + pptxDoc.Save("Sample.pptx") + 'Close the Presentation. + pptxDoc.Close() + + + + + + Gets or sets a value indicating whether the SmartArt point is an assistant element. + + + Returns true if the SmartArt point is an assistant element; otherwise, false. + + + Setting this property to true will set the SmartArt point type to AssistantElement. + Setting this property to false will set the SmartArt point type to Node. + + + + // Create an instance of PowerPoint Presentation + IPresentation pptxDoc = Presentation.Create(); + //Add a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Add a SmartArt to the slide at the specified size and position + ISmartArt smartArt = slide.Shapes.AddSmartArt(SmartArtType.OrganizationChart, 0, 0, 640, 426.96); + //Traverse through all nodes of the SmartArt. + foreach (ISmartArtNode node in smartArt.Nodes) + { + //Check if the node is assistant or not. + if (node.IsAssistant) + //Set the assistant node to false. + node.IsAssistant = false; + } + //Save the Presentation. + pptxDoc.Save("Sample.pptx"); + //Close the Presentation. + pptxDoc.Close(); + + + Create an instance of PowerPoint Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a SmartArt to the slide at the specified size and position + Dim smartArt As ISmartArt = slide.Shapes.AddSmartArt(SmartArtType.OrganizationChart, 0, 0, 640, 426.96) + 'Traverse through all nodes of the SmartArt. + For Each node As ISmartArtNode In smartArt.Nodes + 'Check if the node is assistant or not. + If node.IsAssistant Then + 'Set the assistant node to false. + node.IsAssistant = False + End If + Next + 'Save the Presentation. + pptxDoc.Save("Sample.pptx") + 'Close the Presentation. + pptxDoc.Close() + + + + + + Represents a collection of nodes within a SmartArt diagram. + + + + + Adds a new SmartArt node at the end of the SmartArt node collection. + + Returns an instance that represents the new SmartArt diagram. + + + // Create an instance of PowerPoint Presentation + IPresentation pptxDoc = Presentation.Create(); + //Add a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Add a SmartArt to the slide at the specified size and position. + ISmartArt smartArt = slide.Shapes.AddSmartArt(SmartArtType.AlternatingHexagons, 0, 0, 640, 426); + // Add a new node to the SmartArt. + ISmartArtNode newNode = smartArt.Nodes.Add(); + // Set a text to newly added child node. + newNode.TextBody.AddParagraph("Added new node to the smart art shape."); + //Save the Presentation. + pptxDoc.Save("Sample.pptx"); + //Close the Presentation. + pptxDoc.Close(); + + + 'Create an instance of PowerPoint Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a SmartArt to the slide at the specified size and position. + Dim smartArt As ISmartArt = slide.Shapes.AddSmartArt(SmartArtType.AlternatingHexagons, 10, 10, 640, 426) + 'Add a new node to the SmartArt. + Dim newNode As ISmartArtNode = smartArt.Nodes.Add() + 'Set a text to newly added child node. + newNode.TextBody.AddParagraph("Parent node for the child node.") + 'Save the Presentation. + pptxDoc.Save("Sample.pptx") + 'Close the Presentation. + pptxDoc.Close() + + + + + + Removes all the nodes from the SmartArt. + + + + // Create an instance of PowerPoint Presentation + IPresentation pptxDoc = Presentation.Create(); + //Add a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Add a BasicBlockList SmartArt to the slide at the specified size and position. + ISmartArt smartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 100, 50, 640, 426); + //Sets the background color for the smart art shape + smartArt.Background.SolidFill.Color = ColorObject.AliceBlue; + //Clear the smart art nodes. + smartArt.Nodes.Clear(); + //Save the Presentation + pptxDoc.Save("Sample.pptx"); + //Close the Presentation + pptxDoc.Close(); + + + 'Create an instance of PowerPoint Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a BasicBlockList SmartArt to the slide at the specified size and position. + Dim smartArt As ISmartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 100, 50, 640, 426) + 'Sets the background color for the smart art shape + smartArt.Background.SolidFill.Color = ColorObject.AliceBlue + 'Clear the smart art nodes. + smartArt.Nodes.Clear() + 'Save the Presentation + pptxDoc.Save("Sample.pptx") + 'Close the Presentation + pptxDoc.Close() + + + + + + Removes the node at the specified index of SmartArt node collection. + + The zero-based index of the element to be removed. + + + // Create an instance of PowerPoint Presentation + IPresentation pptxDoc = Presentation.Create(); + //Add a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Add a BasicBlockList SmartArt to the slide at the specified size and position. + ISmartArt smartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 100, 50, 640, 426); + //Gets the first smart art node. + ISmartArtNode node = smartArt.Nodes[0]; + //Remove the smart art node from the node collection. + smartArt.Nodes.RemoveAt(1); + //Save the Presentation + pptxDoc.Save("Sample.pptx"); + //Close the Presentation + pptxDoc.Close(); + + + 'Create an instance of PowerPoint Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a BasicBlockList SmartArt to the slide at the specified size and position. + Dim smartArt As ISmartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 100, 50, 640, 426) + 'Gets the first smart art node + Dim node As ISmartArtNode = smartArt.Nodes(0) + 'Remove the smart art node from the node collection. + smartArt.Nodes.RemoveAt(1) + 'Save the Presentation + pptxDoc.Save("Sample.pptx") + 'Close the Presentation + pptxDoc.Close() + + + + + + Removes the first occurrence of a specified node from the SmartArt node collection. + + The SmartArt node to be removed from the collection. + Returns true if the specified SmartArt node is removed from the node collection otherwise returns false. + + + // Create an instance of PowerPoint Presentation + IPresentation pptxDoc = Presentation.Create(); + //Add a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Add a BasicBlockList SmartArt to the slide at the specified size and position. + ISmartArt smartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 100, 50, 640, 426); + //Gets the first smart art node. + ISmartArtNode node = smartArt.Nodes[0]; + //Remove the smart art node from the node collection. + smartArt.Nodes.Remove(node); + //Save the Presentation + pptxDoc.Save("Sample.pptx"); + //Close the Presentation + pptxDoc.Close(); + + + 'Create an instance of PowerPoint Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a BasicBlockList SmartArt to the slide at the specified size and position. + Dim smartArt As ISmartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 100, 50, 640, 426) + 'Gets the first smart art node + Dim node As ISmartArtNode = smartArt.Nodes(0) + 'Remove the smart art node from the node collection. + smartArt.Nodes.Remove(node) + 'Save the Presentation + pptxDoc.Save("Sample.pptx") + 'Close the Presentation + pptxDoc.Close() + + + + + + Returns the first occurrence of a specified node from the SmartArt node collection. + + The instance to locate in the collection. + Returns the zero-based index of the first occurrence of SmartArt node within the collection, if found; otherwise, �1. + + + // Create an instance of PowerPoint Presentation + IPresentation pptxDoc = Presentation.Create(); + //Add a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Add a SmartArt to the slide at the specified size and position. + ISmartArt smartArt = slide.Shapes.AddSmartArt(SmartArtType.AlternatingHexagons, 0, 0, 640, 426); + // Add a new node to the SmartArt. + ISmartArtNode newNode = smartArt.Nodes.Add(); + // Set a text to newly added child node. + newNode.TextBody.AddParagraph("Added new node to the smart art shape."); + //Gets the index of new node. + int index = smartArt.Nodes.IndexOf(newNode); + //Save the Presentation. + pptxDoc.Save("Sample.pptx"); + //Close the Presentation. + pptxDoc.Close(); + + + 'Create an instance of PowerPoint Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a SmartArt to the slide at the specified size and position. + Dim smartArt As ISmartArt = slide.Shapes.AddSmartArt(SmartArtType.AlternatingHexagons, 10, 10, 640, 426) + 'Add a new node to the SmartArt. + Dim newNode As ISmartArtNode = smartArt.Nodes.Add() + 'Set a text to newly added child node. + newNode.TextBody.AddParagraph("Added new node to the smart art shape.") + 'Gets the index of new node. + Dim index As Integer = smartArt.Nodes.IndexOf(newNode) + 'Save the Presentation. + pptxDoc.Save("Sample.pptx") + 'Close the Presentation. + pptxDoc.Close() + + + + + + Gets the number of nodes contained in the SmartArt node collection. Read-only. + + + + // Create an instance of PowerPoint Presentation + IPresentation pptxDoc = Presentation.Create(); + //Add a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Add a BasicBlockList SmartArt to the slide at the specified size and position. + ISmartArt smartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 0, 0, 640, 426); + //Gets the number of nodes + int count = smartArt.Nodes.Count; + //Save the Presentation + pptxDoc.Save("Sample.pptx"); + //Close the Presentation + pptxDoc.Close(); + + + 'Create an instance of PowerPoint Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a BasicBlockList SmartArt to the slide at the specified size and position. + Dim smartArt As ISmartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 0, 0, 640, 426) + 'Gets the number of nodes. + Dim count As Integer = smartArt.Nodes.Count + 'Save the Presentation + pptxDoc.Save("Sample.pptx") + 'Close the Presentation + pptxDoc.Close() + + + + + + Gets a node at the specified index of a SmartArt node collection. Read-only. + + Determines the index of the SmartArt node. + Returns an instance. + + + // Create an instance of PowerPoint Presentation + IPresentation pptxDoc = Presentation.Create(); + //Add a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Add a BasicBlockList SmartArt to the slide at the specified size and position. + ISmartArt smartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 0, 0, 640, 426); + //Gets the first smart art node + ISmartArtNode node = smartArt.Nodes[0]; + //Sets the text to the node. + node.TextBody.AddParagraph("First node text"); + //Save the Presentation + pptxDoc.Save("Sample.pptx"); + //Close the Presentation + pptxDoc.Close(); + + + 'Create an instance of PowerPoint Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a BasicBlockList SmartArt to the slide at the specified size and position. + Dim smartArt As ISmartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 0, 0, 640, 426) + 'Gets the first smart art node + Dim node As ISmartArtNode = smartArt.Nodes(0) + 'Sets the text to the node. + node.TextBody.AddParagraph("First node text") + 'Save the Presentation + pptxDoc.Save("Sample.pptx") + 'Close the Presentation + pptxDoc.Close() + + + + + + Represents the collection of shapes within a SmartArt node. + + + + + Represents the collection of shapes within a SmartArt node. + + + + + Gets a instance at the specified index from the collection. Read-only. + + Determines the index of the SmartArt shape. + Returns an instance. + + + // Create an instance of PowerPoint Presentation + IPresentation pptxDoc = Presentation.Create(); + //Add a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Add a BasicBlockList SmartArt to the slide at the specified size and position. + ISmartArt smartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 0, 0, 640, 426); + //Gets the smart art shape collection from the node. + ISmartArtShapes smartArts = smartArt.Nodes[0].Shapes; + //Gets the first smart art shape from the collection. + ISmartArtShape smartArtShape = smartArts[0]; + //Sets the fill color for the shape. + smartArtShape.Fill.SolidFill.Color = ColorObject.DarkCyan; + //Save the PowerPoint Presentation. + pptxDoc.Save("Sample.pptx"); + //Close the Presentation + pptxDoc.Close(); + + + 'Create an instance of PowerPoint Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a BasicBlockList SmartArt to the slide at the specified size and position. + Dim smartArt As ISmartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 0, 0, 640, 426) + 'Gets the smart art shape collection from the node. + Dim smartArts As ISmartArtShapes = smartArt.Nodes(0).Shapes + 'Gets the first smart art shape from the collection. + Dim smartArtShape As ISmartArtShape = smartArts(0) + 'Sets the fill color for the shape. + smartArtShape.Fill.SolidFill.Color = ColorObject.DarkCyan + 'Save the PowerPoint Presentation. + pptxDoc.Save("Sample.pptx") + 'Close the Presentation + pptxDoc.Close() + + + + + + Determines whether an element is in the List. + + Represent the item to find. + Returns true, if item is found; Otherwise, false. + + + + Gets a instance at the specified index from the collection. Read-only. + + Determines the index of the SmartArt shape. + Returns an instance. + + + + Represents a shape within the SmartArt node. + + + + + Gets a extra smart art shape point. + + Represents the current SmartArtType. + Represents the SmartArt point collecion. + + Returns the SmartArtPoint. + + + + Represent a top relation of drawing.xml file. + + + + + Sets the hyperlink for SmartArtPoint + + + + + + Set the textbody for SmartArtPoint + + Textbody to be set. + + + + Returns the SmartArt id + + + + + Returns the SmartArt name + + + + + Returns an instance that represents the hyperlink for the specified SmartArtPoint. + + + + + Represents the smart art graphic with different smart art types. + + + + + Sets the BaseSlide parent to the current SmartArt and its members. + + Represents the parent BaseSlide instance which needs to be assigned to the current SmartArt instance and its members. + + + + Compares the current Shape object with given Shape object. + + The Shape object to compare with the current instance. + True if the Shape objects are equal; otherwise, false. + + + + Gets a object that represents the SmartArt background. + + + + + Gets a value that represents the layout associated with the SmartArt. Read-only. + + + + + Gets a object that contains all the nodes within the SmartArt. Read-only. + + + + + Represents a single semantic node within the data model of a SmartArt graphic. + + + + + Gets the parent of the SmartArt node. + + + + + Gets the child nodes associated with the SmartArt node. Read-only. + + + + + Gets the node level in the hierarchy. + + + + + Gets the shape collection associated with the SmartArt node. Read-only. + + + + + Gets or sets a value indicating whether the SmartArt point is an assistant element. + + + Returns true if the SmartArt point is an assistant element; otherwise, false. + + + Setting this property to true will set the SmartArt point type to AssistantElement. + Setting this property to false will set the SmartArt point type to Node. + + + + + Gets an instance that represents the text in the SmartArt node. Read-only. + + + + + Represents a collection of nodes within a SmartArt diagram. + + + + + Returns the first occurrence of a specified node from the SmartArt node collection. + + The instance to locate in the collection. + Returns the zero-based index of the first occurrence of SmartArt node within the collection, if found; otherwise, �1. + + + + Adds a new SmartArt node at the end of the SmartArt node collection. + + Returns an instance that represents the new SmartArt diagram. + + + + Removes all the nodes from the SmartArt. + + + + + Removes the node at the specified index of SmartArt node collection. + + The zero-based index of the element to be removed. + + + + Removes the first occurrence of a specified node from the SmartArt node collection. + + The SmartArt node to be removed from the collection. + Returns true if the specified SmartArt node is removed from the node collection otherwise returns false. + + + + Add extra smart art points on each PictureStrips SmartArt node, to add the picture on node. + + Represent the node to add. + + + + Gets the number of nodes contained in the SmartArt node collection. Read-only. + + + + + Gets a node at the specified index of a SmartArt node collection. Read-only. + + Determines the index of the SmartArt node. + Returns an instance. + + + + Represents a shape within the SmartArt node. + + + + + Represents the comment in the slide. + + + + + + Gets or sets the left position of the comment in slide + + + + //Create a new presentation. + IPresentation presDoc = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add a paragraph to the textbody of the shape + shape.TextBody.AddParagraph("Hi Syncfusion Customers"); + //Add a comment to the slide + IComment comment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now); + //Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment); + //Set the left position for the comment + slide.Comments[1].Left = 0.50; + //Get the left position of the comment + double leftPosition = slide.Comments[1].Left; + //Save the presentation to the file system. + presDoc.Save("Output.pptx"); + //Close the presentation + presDoc.Close(); + + + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add a paragraph to the text body of the shape + shape.TextBody.AddParagraph() + 'Add a comment to the slide + Dim comment As IComment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now) + 'Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment) + 'Set the left position for the comment + slide.Comments(1).Left = 0.50 + 'Get the left position of the comment + Dim leftPosition As double = slide.Comments(1).Left + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + + + + + + Gets or sets the top position of the comment in slide + + + + //Create a new presentation. + IPresentation presDoc = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add a paragraph to the textbody of the shape + shape.TextBody.AddParagraph("Hi Syncfusion Customers"); + //Add a comment to the slide + IComment comment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now); + //Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment); + //Set the top position for the comment + slide.Comments[1].Top = 0.50; + //Get the top position of the comment + double topPosition = slide.Comments[1].Top; + //Save the presentation to the file system. + presDoc.Save("Output.pptx"); + //Close the presentation + presDoc.Close(); + + + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add a paragraph to the text body of the shape + shape.TextBody.AddParagraph() + 'Add a comment to the slide + Dim comment As IComment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now) + 'Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment) + 'Set the top position for the comment + slide.Comments(1).Top = 0.50 + 'Get the top position of the comment + Dim topPosition As double = slide.Comments(1).Top + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + + + + + + Gets or sets the author name of the comment + + + + //Create a new presentation. + IPresentation presDoc = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add a paragraph to the textbody of the shape + shape.TextBody.AddParagraph("Hi Syncfusion Customers"); + //Add a comment to the slide + IComment comment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now); + //Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment); + //Set the author name for the comment + slide.Comments[1].AuthorName = "Manager"; + //Get the author name of the comment + string authorName = slide.Comments[1].AuthorName; + //Save the presentation to the file system. + presDoc.Save("Output.pptx"); + //Close the presentation + presDoc.Close(); + + + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add a paragraph to the text body of the shape + shape.TextBody.AddParagraph() + 'Add a comment to the slide + Dim comment As IComment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now) + 'Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment) + 'Set the author name for the comment + slide.Comments(1).AuthorName = "Manager" + 'Get the author name of the comment + Dim authorName As string = slide.Comments(1).AuthorName + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + + + + + + Gets or sets the comment author initials + + + + //Create a new presentation. + IPresentation presDoc = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add a paragraph to the textbody of the shape + shape.TextBody.AddParagraph("Hi Syncfusion Customers"); + //Add a comment to the slide + IComment comment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now); + //Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment); + //Set the initial for the comment author. + slide.Comments[1].Initials = "M"; + //Get the initial of the comment author + string authorInitial = slide.Comments[1].Initials; + //Save the presentation to the file system. + presDoc.Save("Output.pptx"); + //Close the presentation + presDoc.Close(); + + + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add a paragraph to the text body of the shape + shape.TextBody.AddParagraph() + 'Add a comment to the slide + Dim comment As IComment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now) + 'Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment) + 'Set the initial for the comment author + slide.Comments(1).Initials = "M" + 'Get the initial of the comment author + Dim authorInitial As string = slide.Comments(1).Initials + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + + + + + + Gets or sets the comment text + + + + //Create a new presentation. + IPresentation presDoc = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add a paragraph to the textbody of the shape + shape.TextBody.AddParagraph("Hi Syncfusion Customers"); + //Add a comment to the slide + IComment comment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now); + //Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment); + //Set the text of the comment + slide.Comments[1].Text = "How can i convert a slide to image or PDF?"; + //Get the text of the comment + string commentText = slide.Comments[1].Text; + //Save the presentation to the file system. + presDoc.Save("Output.pptx"); + //Close the presentation + presDoc.Close(); + + + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add a paragraph to the text body of the shape + shape.TextBody.AddParagraph() + 'Add a comment to the slide + Dim comment As IComment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now) + 'Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment) + 'Set the text of the comment + slide.Comments(1).Text = "How can i convert a slide to image or PDF?" + 'Get the text of the comment + Dim commentText As string = slide.Comments(1).Text + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + + + + + + Gets or sets the created or modified date and time of the comment + + + + //Create a new presentation. + IPresentation presDoc = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add a paragraph to the textbody of the shape + shape.TextBody.AddParagraph("Hi Syncfusion Customers"); + //Add a comment to the slide + IComment comment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now); + //Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment); + //Set the date and time of the comment + DateTime date = new DateTime(2017, 1, 18); + slide.Comments[1].DateTime = date ; + //Get the date and time of the comment + DateTime date1 = slide.Comments[1].DateTime; + //Save the presentation to the file system. + presDoc.Save("Output.pptx"); + //Close the presentation + presDoc.Close(); + + + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add a paragraph to the text body of the shape + shape.TextBody.AddParagraph() + 'Add a comment to the slide + Dim comment As IComment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now) + 'Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment) + 'Set the date and time of the comment + Dim time As DateTime = New DateTime(2017, 1, 18) + slide.Comments(1).DateTime = time + 'Get the date and time of the comment + Dim commentDatetime As DateTime = slide.Comments(1).DateTime + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + + + + + + Returns a boolean value that indicates the comment is a parent comment or a reply comment + + + + //Create a new presentation. + IPresentation presDoc = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add a paragraph to the textbody of the shape + shape.TextBody.AddParagraph("Hi Syncfusion Customers"); + //Add a comment to the slide + IComment comment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now); + //Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment); + //Get the text of the the bool value that indicates whether a comment has reply or not + bool hasReply = slide.Comments[0].HasChild; + //Save the presentation to the file system. + presDoc.Save("Output.pptx"); + //Close the presentation + presDoc.Close(); + + + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add a paragraph to the text body of the shape + shape.TextBody.AddParagraph() + 'Add a comment to the slide + Dim comment As IComment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now) + 'Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment) + 'Get the bool value that indicates whether a comment has reply or not + Dim hasReply As Boolean = slide.Comments(0).HasChild + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + + + + + + Returns the parent comment otherwise returns null if there is no parent comment + + Returns an instance of parent comment + + + //Create a new presentation. + IPresentation presDoc = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add a paragraph to the textbody of the shape + shape.TextBody.AddParagraph("Hi Syncfusion Customers"); + //Add a comment to the slide + IComment comment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now); + //Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment); + //Get the parent comment + IComment parentComment = slide.Comments[1].Parent; + //Save the presentation to the file system. + presDoc.Save("Output.pptx"); + //Close the presentation + presDoc.Close(); + + + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add a paragraph to the text body of the shape + shape.TextBody.AddParagraph() + 'Add a comment to the slide + Dim comment As IComment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now) + 'Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment) + 'Get the parent comment + Dim parentComment As IComment = slide.Comments(1).Parent + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + + + + + + Represents the comment collection. + + + + + Adds a comment for an author in the slide. + + left poisiton of the comment in slide + top position of comment in slide + name of the comment author + initial of the author + specifies the comment + specifies the date time of the comment added + The comment gets added in the slide + Returns the instance of added comment. + + + //Create a new presentation. + IPresentation presDoc = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add a paragraph to the textbody of the shape + shape.TextBody.AddParagraph("Hi Syncfusion Customers"); + //Add a comment to the slide + IComment comment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now); + //Save the presentation to the file system. + presDoc.Save("Output.pptx"); + //Close the presentation + presDoc.Close(); + + + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add a paragraph to the text body of the shape + shape.TextBody.AddParagraph() + 'Add a comment to the slide + Dim comment As IComment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now) + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + + + + + + Adds a reply for an author to a specific comment. + + name of the comment author + initial of the author + specifies the comment + specifies the date time of the reply added + specifies the parent comment + The reply is made to a comment added in the slide + Returns the instance of added comment. + + + //Create a new presentation. + IPresentation presDoc = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add a paragraph to the textbody of the shape + shape.TextBody.AddParagraph("Hi Syncfusion Customers"); + //Add a comment to the slide + IComment comment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now); + //Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment); + //Save the presentation to the file system. + presDoc.Save("Output.pptx"); + //Close the presentation + presDoc.Close(); + + + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add a paragraph to the text body of the shape + shape.TextBody.AddParagraph() + 'Add a comment to the slide + Dim comment As IComment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now) + 'Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment) + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + + + + + + Removes the comment at the specified index, from the comment collection. + + The zero-based index of the element to be removed. + + + //Create a new presentation. + IPresentation presDoc = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add a paragraph to the textbody of the shape + shape.TextBody.AddParagraph("Hi Syncfusion Customers"); + //Add a comment to the slide + IComment comment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now); + //Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment); + //Remove the comment at the specified index + slide.Comments.RemoveAt(1); + //Save the presentation to the file system. + presDoc.Save("Output.pptx"); + //Close the presentation + presDoc.Close(); + + + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add a paragraph to the text body of the shape + shape.TextBody.AddParagraph() + 'Add a comment to the slide + Dim comment As IComment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now) + 'Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment) + 'Remove the comment at the specified index + slide.Comments.RemoveAt(1) + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + + + + + + Removes the first occurrence of a specified comment from the comment collection. + + The comment to be removed from the collection. + + + //Create a new presentation. + IPresentation presDoc = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add a paragraph to the textbody of the shape + shape.TextBody.AddParagraph("Hi Syncfusion Customers"); + //Add a comment to the slide + IComment comment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now); + //Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment); + //Remove the comment at the specified index from the comment collection + slide.Comments.Remove(comment); + //Save the presentation to the file system. + presDoc.Save("Output.pptx"); + //Close the presentation + presDoc.Close(); + + + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add a paragraph to the text body of the shape + shape.TextBody.AddParagraph() + 'Add a comment to the slide + Dim comment As IComment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now) + 'Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment) + 'Remove the comment at the specified index from the comment collection + slide.Comments.Remove(comment) + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + + + + + + Returns the zero-based index of the first occurrence of the instance within the comment collection. + + The instance to locate in the collection. + Returns the zero-based index of the first occurrence of comment within the collection, if found; otherwise, –1. + + + //Create a new presentation. + IPresentation presDoc = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add a paragraph to the textbody of the shape + shape.TextBody.AddParagraph("Hi Syncfusion Customers"); + //Add a comment to the slide + IComment comment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now); + //Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment); + //Get the index of the comment from the comment collection + int index = slide.Comments.IndexOf(comment); + //Save the presentation to the file system. + presDoc.Save("Output.pptx"); + //Close the presentation + presDoc.Close(); + + + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add a paragraph to the text body of the shape + shape.TextBody.AddParagraph() + 'Add a comment to the slide + Dim comment As IComment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now) + 'Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment) + 'Get the index of the comment from the comment collection + Dim index As Integer = slide.Comments.IndexOf(comment) + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + + + + + + Inserts the specified comment into the comment collection at specified index. + + The zero-based index at which the comment should be inserted. + The comment instance to insert. + + + //Create a new presentation. + IPresentation presDoc = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add a paragraph to the textbody of the shape + shape.TextBody.AddParagraph("Hi Syncfusion Customers"); + //Add a comment to the slide + IComment comment1 = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now); + //Author2 add reply to a parent comment + IComment comment2 = slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment1); + //Insert the comment at the specified index in comment collection + slide.Comments.Insert(0 , comment2); + //Save the presentation to the file system. + presDoc.Save("Output.pptx"); + //Close the presentation + presDoc.Close(); + + + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add a paragraph to the text body of the shape + shape.TextBody.AddParagraph() + 'Add a comment to the slide + Dim comment1 As IComment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now) + 'Author2 add reply to a parent comment + Dim comment2 As IComment = slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment1) + 'Insert the comment at the specified index in comment collection + slide.Comments.Insert(0,comment2) + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + + + + + + Removes all the comments in the slide. + + + + //Create a new presentation. + IPresentation presDoc = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add a paragraph to the textbody of the shape + shape.TextBody.AddParagraph("Hi Syncfusion Customers"); + //Add a comment to the slide + IComment comment1 = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now); + //Author2 add reply to a parent comment + IComment comment2 = slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment1); + //Clear the comment from the slide + slide.Comments.Clear(); + //Save the presentation to the file system. + presDoc.Save("Output.pptx"); + //Close the presentation + presDoc.Close(); + + + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add a paragraph to the text body of the shape + shape.TextBody.AddParagraph() + 'Add a comment to the slide + Dim comment1 As IComment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now) + 'Author2 add reply to a parent comment + Dim comment2 As IComment = slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment1) + 'Clear the comment from the slide + slide.Comments.Clear() + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + + + + + + Gets the instance at the specified index in comment collection. Read-only. + + The index to locate the comment. + Returns the instance at the specified index in comment collection. + + + //Create a new presentation. + IPresentation presDoc = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add a paragraph to the textbody of the shape + shape.TextBody.AddParagraph("Hi Syncfusion Customers"); + //Add a comment to the slide + IComment comment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now); + //Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment); + //Get the comment + IComment comment1 = slide.Comments[1]; + //Save the presentation to the file system. + presDoc.Save("Output.pptx"); + //Close the presentation + presDoc.Close(); + + + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add a paragraph to the text body of the shape + shape.TextBody.AddParagraph() + 'Add a comment to the slide + Dim comment As IComment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now) + 'Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment) + 'Get the comment + Dim comment1 As IComment = slide.Comments(1) + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + + + + + + Gets the number of elements in the comment collection. Read-only. + + + The total count of the comments. + + + + //Create a new presentation. + IPresentation presDoc = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add a paragraph to the textbody of the shape + shape.TextBody.AddParagraph("Hi Syncfusion Customers"); + //Add a comment to the slide + IComment comment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now); + //Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment); + //Get the count comment + int count = slide.Comments.Count; + //Save the presentation to the file system. + presDoc.Save("Output.pptx"); + //Close the presentation + presDoc.Close(); + + + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add a paragraph to the text body of the shape + shape.TextBody.AddParagraph() + 'Add a comment to the slide + Dim comment As IComment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now) + 'Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment) + 'Get the count of the comment + Dim count As Integer = slide.Comments.Count + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + + + + + + Represents the background of a slide. + + + + + Gets an instance that contains fill formatting properties. + Read-only. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for slide background + IBackground background = slide.Background; + //Set the fill type for background as Pattern fill + background.Fill.FillType = FillType.Pattern; + //Set the pattern + background.Fill.PatternFill.Pattern = PatternFillType.DashedHorizontal; + //set the fore color of pattern + background.Fill.PatternFill.ForeColor = ColorObject.Lavender; + //Set the back color of pattern + background.Fill.PatternFill.BackColor = ColorObject.Brown; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for slide background + Dim background As IBackground = slide.Background + 'Set the fill type for background as Pattern fill + background.Fill.FillType = FillType.Pattern + 'Set the pattern + background.Fill.PatternFill.Pattern = PatternFillType.DashedHorizontal + 'set the fore color of pattern + background.Fill.PatternFill.ForeColor = ColorObject.Lavender + 'Set the back color of pattern + background.Fill.PatternFill.BackColor = ColorObject.Brown + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Retrieves the color value from the layout or master slide based on the given color object and fill. + + The color object containing the initial color value. + The fill object that provides access to the slide's layout or master slide. + The modified color object with an updated theme color value if applicable. + + + + Compares the current Background object with given Background object. + + The Background object to compare with the current instance. + True if the Background objects are equal; otherwise, false. + + + + Represents the collection of charts. + + + + + + Represents a collection of instance in a slide. + + + + + Adds a chart to the shape collection with the specified bounds. + + Represents the left position, in points. The Left value ranges from -169056 to 169056. + Represents the top position, in points. The Top value ranges from -169056 to 169056. + Represents the width, in points. The Width value ranges from 0 to 169056. + Represents the height, in points. The Height value ranges from 0 to 169056. + Returns an instance. + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance to hold chart collection + IPresentationCharts charts = slide.Charts; + //Add chart to slide + IPresentationChart chart =charts.AddChart(300, 100, 300, 300); + //Set the fore color of the chart area. + chart.ChartArea.Fill.ForeColor = Color.AliceBlue; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance to hold chart collection + Dim charts As IPresentationCharts = slide.Charts + 'Add chart to slide + Dim chart As IPresentationChart = charts.AddChart(300, 100, 300, 300) + 'Set the fore color of the chart area. + chart.ChartArea.Fill.ForeColor = Color.AliceBlue + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Creates a chart for the data in specified excel document and adds the chart to the shape collection. + + Excel document stream having the data for chart[Only the "*.xlsx" format is supported]. + Worksheet number of the excel document. + Data range in the worksheet for the chart to be created. + Position and size of the chart, in points. + Returns an instance. + + + //Creates a Presentation instance + IPresentation pptxDoc = Presentation.Create(); + //Adds a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Gets the excel file as stream + FileStream excelStream = new FileStream("Book1.xlsx", FileMode.Open); + //Adds a chart to the slide with a data range from excel worksheet – excel workbook, worksheet number, Data range, position, and size. + IPresentationChart chart = slide.Charts.AddChart(excelStream, 1, "A1:D4", new RectangleF(100, 10, 700, 500)); + //Save the presentation + pptxDoc.Save("Output.pptx"); + //Closes the Presentation + pptxDoc.Close(); + + + 'Creates a Presentation instance + Dim pptxDoc As IPresentation = Presentation.Create() + 'Adds a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Gets the excel file as stream + Dim excelStream As New MemoryStream(File.ReadAllBytes("Book1.xlsx")) + 'Adds a chart to the slide with a data range from excel worksheet – excel workbook, worksheet number, Data range, position, and size. + Dim chart As IPresentationChart = slide.Charts.AddChart(excelStream, 1, "A1:D4", New RectangleF(100, 10, 700, 500)) + 'Saves the Presentation + pptxDoc.Save("output.pptx") + 'Closes the Presentation + pptxDoc.Close() + + + + + + + + Returns the zero-based index of the first occurrence of the instance within the collection. + + The IPresentationChart instance to locate in the collection. + Returns the zero-based index of the first occurrence of object within the entire collection, if found; otherwise, –1. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance to hold chart collection + IPresentationCharts charts = slide.Charts; + //Add chart to slide + IPresentationChart chart =charts.AddChart(300, 100, 300, 300); + //Set the fore color of the chart area. + chart.ChartArea.Fill.ForeColor = Color.AliceBlue; + //Get the index of specific chart + int index = charts.IndexOf(chart); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance to hold chart collection + Dim charts As IPresentationCharts = slide.Charts + 'Add chart to slide + Dim chart As IPresentationChart = charts.AddChart(300, 100, 300, 300) + 'Set the fore color of the chart area. + chart.ChartArea.Fill.ForeColor = Color.AliceBlue + 'Get the index of specific chart + Dim index As Integer = shapes.IndexOf(chart) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the element at the specified index of the chart collection. + + The zero-based index of the element to be removed. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance to hold chart collection + IPresentationCharts charts = slide.Charts; + //Add chart to slide + IPresentationChart chart = charts.AddChart(100, 300, 200, 200); + //Set the fore color of the chart area. + chart.ChartArea.Fill.ForeColor = Color.LightBlue; + //Add chart to slide + IPresentationChart chart2 = charts.AddChart(300, 300, 200, 200); + //Set the fore color of the chart area. + chart2.ChartArea.Fill.ForeColor = Color.AliceBlue; + //Remove chart specific index + charts.RemoveAt(0); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance to hold chart collection + Dim charts As IPresentationCharts = slide.Charts + 'Add chart to slide + Dim chart As IPresentationChart = charts.AddChart(100, 300, 200, 200) + 'Set the fore color of the chart area. + chart.ChartArea.Fill.ForeColor = Color.LightBlue + 'Add chart to slide + Dim chart2 As IPresentationChart = charts.AddChart(300, 300, 200, 200) + 'Set the fore color of the chart area. + chart2.ChartArea.Fill.ForeColor = Color.AliceBlue + 'Remove chart specific index + chart.RemoveAt(0) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a single instance from the collection. Read-only. + + Index from the collection. + Returns the particular chart based on the index. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance to hold chart collection + IPresentationCharts charts = slide.Charts; + //Add chart to slide + charts.AddChart(300, 100, 300, 300); + //Retrieve the chart at index 0 + IPresentationChart chart = charts[0]; + //Set the fore color of the chart area. + chart.ChartArea.Fill.ForeColor = Color.AliceBlue; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance to hold chart collection + Dim charts As IPresentationCharts = slide.Charts + 'Add chart to slide + charts.AddChart(300, 100, 300, 300) + 'Retrieve the chart at index 0 + Dim chart As IPresentationChart = charts(0) + 'Set the fore color of the chart area. + chart.ChartArea.Fill.ForeColor = Color.AliceBlue + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the number of elements in the chart collection. Read-only. + + + The total count of the charts in the chart collection. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance to hold chart collection + IPresentationCharts charts = slide.Charts; + //Add chart to slide + IPresentationChart chart =charts.AddChart(300, 100, 300, 300); + //Set the fore color of the chart area. + chart.ChartArea.Fill.ForeColor = Color.AliceBlue; + //Get the count for chart collection + int count = charts.Count; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance to hold chart collection + Dim charts As IPresentationCharts = slide.Charts + 'Add chart to slide + Dim chart As IPresentationChart = charts.AddChart(300, 100, 300, 300) + 'Set the fore color of the chart area. + chart.ChartArea.Fill.ForeColor = Color.AliceBlue + 'Get the count for chart collection + Dim count As Integer = charts.Count + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Adds a chart to the slide. + + The left position of the chart from left edge of the slide, in points + The top position of the chart from top edge of the slide, in points + Width of the chart, in points + Height of the chart, in points + Returns a chart object. + + + + Adds a chart to the slide. + + Excel document stream that has the data for chart,excel document should be in "*.xlsx" format + Worksheet number of the excel document. + Data range in the worksheet for which the chart to be created. + Size and Position of chart in the slide. + Returns a chart object. + + + + Adds a chart to the slide. + + Chart data in 2-dimensional array format. + The left position of the chart from left edge of the slide, in points + The left position of the chart from left edge of the slide, in points + The width of the chart, in points + The height of the chart, in points. + Returns a chart object. + + + + Adds a chart to the slide. + + IEnumerable object with desired data + The left position of the chart from left edge of the shape, in points + The top position of the chart from top edge of the shape, in points + The width of the chart, in points + The height of the chart, in points. + Returns a chart object. + + + + Returns the zero-based index of the first occurrence of the specified chart + + Represents a chart from the collection. + The zero-based index position of the chart, if found otherwise -1. + + + + Removes the chart at the specified index of the chart collection + + The zero-based index of the chart to remove. + + + + Returns an enumerator that iterates through the chart collection. + + An IEnumerator object that can be used to iterate through the chart collection. + + + + Gets the chart at the specified index. + + Index of the chart. + + + + + Gets the number of elements contained in the chart collection. + + + + + Represents the charts in the presentation + + + + + Replaces the chart data with the worksheet data. + + + Optional Boolean. Set to true to update all the formulas in the Excel sheet. The default value is false. + + + + //Open a presentation containing charts + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the slide from presentation + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Charts[0]; + //Refresh the chart to set worksheet data to current chart + chart.Refresh(true); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation containing charts + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + 'Get the slide from presentation + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = slide.Charts(0) + 'Refresh the chart to set worksheet data to current chart + chart.Refresh(True) + 'Save the presentation + presentation.Save("Sample.pptx") + 'Close the presentation + presentation.Close() + + + + + + Converts the chart to image and saves the image in the specified stream. + + The stream to save the image. + + + //Open the presentation + IPresentation presentation = Presentation.Open("Template.pptx"); + //Initialize the ChartToImageConverter class; this is mandatory + presentation.ChartToImageConverter = new ChartToImageConverter(); + //Set the scaling mode for quality + presentation.ChartToImageConverter.ScalingMode = Syncfusion.OfficeChart.ScalingMode.Best; + //Get the first slide + ISlide slide = presentation.Slides[0]; + //Get the chart in slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Create a stream instance to store the image + MemoryStream stream = new MemoryStream(); + //Save the image to stream + chart.SaveAsImage(stream); + //Save the stream to a file + using (FileStream fileStream = File.Create("ChartImage.png", (int)stream.Length)) + fileStream.Write(stream.ToArray(), 0, stream.ToArray().Length); + //Close the stream + stream.Close(); + //Save the Presentation + presentation.Save("output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open the presentation + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + 'Initialize the ChartToImageConverter class; this is mandatory + presentation.ChartToImageConverter = New ChartToImageConverter() + 'Set the scaling mode for quality + presentation.ChartToImageConverter.ScalingMode = Syncfusion.OfficeChart.ScalingMode.Best + 'Get the first slide + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart in slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IOfficeChart) + 'Create a stream instance to store the image + Dim stream As New MemoryStream() + 'Save the image to stream + chart.SaveAsImage(stream) + 'Save the stream to a file + Using fileStream As FileStream = File.Create("ChartImage.png", CInt(stream.Length)) + fileStream.Write(stream.ToArray(), 0, stream.ToArray().Length) + End Using + 'Close the stream + stream.Close() + 'Save the Presentation + presentation.Save("output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Sets the chart data with the specified two dimensional object array. + + Represents the two dimensional chart data + + + + //Create a new PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to slide + IPresentationChart chart = slide.Charts.AddChart(100, 100, 300, 200); + //Create an instance of object array + object[][] chartData = { new object[3], new object[4] }; + //Invoke setChartData method by passing object array + chart.SetChartData(chartData); + //Set the chart title + chart.ChartTitle = "Chart"; + //Save the Presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new PowerPoint presentation + Dim presentation As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to slide + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 100, 300, 200) + 'Create an instance of object array + Dim chartData As Object()() = {New Object(2) {}, New Object(3) {}} + 'Invoke setChartData method by passing object array + chart.SetChartData(chartData) + 'Set the chart title + chart.ChartTitle = "Chart" + 'Save the Presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Sets the chart data with the specified two dimensional object array, row index and column index. + + Represents the two dimensional chart data + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + + + //Create a new PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to slide + IPresentationChart chart = slide.Charts.AddChart(100, 100, 300, 300); + //Create an instance of object array + object[][] dataRange = { new object[5], new object[5] }; + //Invoke set data Range method + chart.SetDataRange(dataRange, 1, 3); + //Save the Presentation + presentation.Save("output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new PowerPoint presentation + Dim presentation As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to slide + Dim chart As IPresentationChart= slide.Charts.AddChart(100, 100, 300, 300) + 'Create an instance of object array + Dim dataRange As Object()() = {New Object(4) {}, New Object(4) {}} + 'Invoke set data Range method + chart.SetDataRange(dataRange, 1, 3) + 'Save the Presentation + presentation.Save("output.pptx") + 'Close the presentation + presentation.Close() + + + + + + + Gets or sets the Chart Type. + Initiate series, ranges and update the ChartType. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Specify the chart title + chart.ChartTitle = "Sales Analysis" + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets a instance for this presentation chart. Read-only. + + + This property can be used in to convert chart as an image. + + + + //Opens a Presentation + IPresentation pptxDoc = Presentation.Open("Sample.pptx"); + //Creates an instance of ChartToImageConverter + pptxDoc.ChartToImageConverter = new ChartToImageConverter(); + //Sets the scaling mode as best + pptxDoc.ChartToImageConverter.ScalingMode = Syncfusion.OfficeChart.ScalingMode.Best; + //Gets a slide from the Presentation + ISlide slide = pptxDoc.Slides[0]; + //Gets the presentation chart in slide + IPresentationChart presentationChart = slide.Shapes[0] as IPresentationChart; + //Gets the IOfficeChart instance + IOfficeChart officeChart = presentationChart.OfficeChart; + //Save the chart to image. + MemoryStream memoryStream = new MemoryStream(); + officeChart.SaveAsImage(memoryStream); + //Closes the Presentation + pptxDoc.Close(); + + + 'Opens a Presentation + Dim pptxDoc As IPresentation = Presentation.Open("Sample.pptx") + 'Creates an instance of ChartToImageConverter + pptxDoc.ChartToImageConverter = New ChartToImageConverter + 'Sets the scaling mode as best + pptxDoc.ChartToImageConverter.ScalingMode = Syncfusion.OfficeChart.ScalingMode.Best + 'Gets a slide from the Presentation + Dim slide As ISlide = pptxDoc.Slides(0) + 'Gets the presentation chart in slide + Dim presentationChart As IPresentationChart = CType(slide.Shapes(0), IPresentationChart) + 'Gets the IOfficeChart instance + Dim officeChart As IOfficeChart = presentationChart.OfficeChart + 'Save the chart to image. + Dim memoryStream As MemoryStream = New MemoryStream + officeChart.SaveAsImage(memoryStream) + 'Closes the Presentation + pptxDoc.Close + + + + + + Gets or sets the DataRange for the chart series. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to slide + IPresentationChart chart = slide.Shapes.AddChart(100, 120, 500, 300); + //Sets the data range of chart + chart.DataRange = chart.ChartData[1, 2, 4, 3]; + //Set data to the chart- RowIndex, columnIndex and data + chart.ChartData.SetValue(1, 2, "2012"); + chart.ChartData.SetValue(2, 2, 330); + chart.ChartData.SetValue(3, 2, 490); + chart.ChartData.SetValue(4, 2, 700); + chart.ChartType = OfficeChartType.Area; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to slide + Dim chart As IPresentationChart = slide.Shapes.AddChart(100, 120, 500, 300) + 'Sets the data range of chart + chart.DataRange = chart.ChartData(1, 2, 4, 3) + 'Set data to the chart- RowIndex, columnIndex and data + chart.ChartData.SetValue(1, 2, "2012") + chart.ChartData.SetValue(2, 2, 330) + chart.ChartData.SetValue(3, 2, 490) + chart.ChartData.SetValue(4, 2, 700) + chart.ChartType = OfficeChartType.Area + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets whether series in rows or not. True if series are in rows in DataRange; + False otherwise. + + + + //Create an instance for PowerPoint + IPresentation pptxDoc = Presentation.Create(); + //Add a blank slide to Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Adds chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Set the chart type as Scatter_Markers + chart.ChartType = OfficeChartType.Scatter_Markers; + //Assign data + chart.DataRange = chart.ChartData[1, 1, 4, 2]; + //Set data to the chart RowIndex, columnIndex, and data + chart.ChartData.SetValue(1, 1, "X-Axis"); + chart.ChartData.SetValue(1, 2, "Y-Axis"); + chart.ChartData.SetValue(2, 1, 1); + chart.ChartData.SetValue(3, 1, 5); + chart.ChartData.SetValue(4, 1, 10); + chart.ChartData.SetValue(2, 2, 10); + chart.ChartData.SetValue(3, 2, 5); + chart.ChartData.SetValue(4, 2, 1); + //Set chart title + chart.ChartTitle = "Scatter Markers Chart"; + //Set legend + chart.HasLegend = false; + //Set Datalabels + IOfficeChartSerie serie = chart.Series[0]; + serie.DataPoints.DefaultDataPoint.DataLabels.IsValue = true; + serie.DataPoints.DefaultDataPoint.DataLabels.IsCategoryName = true; + //Set IsSeriesInRows + chart.IsSeriesInRows = false; + //Saves the Presentation + pptxDoc.Save("Output.pptx"); + //Closes the presentation + pptxDoc.Close(); + + + 'Create an instance for PowerPoint + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add a blank slide to Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Adds chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Set the chart type as Scatter_Markers + chart.ChartType = OfficeChartType.Scatter_Markers + 'Assign data + chart.DataRange = chart.ChartData(1, 1, 4, 2) + 'Set data to the chart RowIndex, columnIndex, and data + chart.ChartData.SetValue(1, 1, "X-Axis") + chart.ChartData.SetValue(1, 2, "Y-Axis") + chart.ChartData.SetValue(2, 1, 1) + chart.ChartData.SetValue(3, 1, 5) + chart.ChartData.SetValue(4, 1, 10) + chart.ChartData.SetValue(2, 2, 10) + chart.ChartData.SetValue(3, 2, 5) + chart.ChartData.SetValue(4, 2, 1) + 'Apply chart elements + 'Set chart title + chart.ChartTitle = "Scatter Markers Chart" + 'Set legend + chart.HasLegend = False + 'Set Datalabels + Dim serie As IOfficeChartSerie = chart.Series(0) + serie.DataPoints.DefaultDataPoint.DataLabels.IsValue = True + serie.DataPoints.DefaultDataPoint.DataLabels.IsCategoryName = True + 'Set IsSeriesInRows + chart.IsSeriesInRows = False + 'Saves the Presentation + pptxDoc.Save("Output.pptx") + 'Closes the Presentation + pptxDoc.Close() + + + + + + Gets or sets the Title of the chart. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Specify the chart title + chart.ChartTitle = "Sales Analysis" + 'Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets title text area. Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Specify the chart type + chart.ChartType = OfficeChartType.Surface_3D; + //Get the chart title text area + IOfficeChartTextArea textArea = chart.ChartTitleArea; + //Set bold font style + textArea.Bold = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Specify the chart title + chart.ChartTitle = "Sales Analysis" + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Specify the chart type + chart.ChartType = OfficeChartType.Surface_3D + 'Get the chart title text area + Dim textArea As IOfficeChartTextArea = chart.ChartTitleArea + 'Set the background mode of the title area + textArea.BackgroundMode = OfficeChartBackgroundMode.Transparent + 'Set bold font style + textArea.Bold = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the X coordinate of the upper-left corner + of the chart in points (1/72 inch). + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the x - position of the chart + chart.XPos = 300; + //Set the y - position of the chart + chart.YPos = 140; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the x - position of the chart + chart.XPos = 300 + 'Set the y - position of the chart + chart.YPos = 140 + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the Y coordinate of the upper-left corner + of the chart in points (1/72 inch). + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the x - position of the chart + chart.XPos = 300; + //Set the y - position of the chart + chart.YPos = 140; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the x - position of the chart + chart.XPos = 300 + 'Set the y - position of the chart + chart.YPos = 140 + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the Width of the chart in points (1/72 inch). + + + + //Open the presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Get the first slide + ISlide slide = presentation.Slides[0]; + //Get the chart in slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Modify the chart height + chart.Height = 500; + //Modify the chart width + chart.Width = 700; + //Change the title + chart.ChartTitle = "New title"; + //Change the serie name of first chart serie + chart.Series[0].Name = "Modified serie name"; + //Hiding the category labels + chart.CategoryLabelLevel = OfficeCategoriesLabelLevel.CategoriesLabelLevelNone; + //Show Data Table. + chart.HasDataTable = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open the presentation + Dim presentation As IPresentation = Presentation.Open("Sample.pptx") + 'Get the first slide + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart in slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IOfficeChart) + 'Modify the chart height + chart.Height = 500 + 'Modify the chart width + chart.Width = 700 + 'Change the title + chart.ChartTitle = "New title" + 'Change the serie name of first chart serie + chart.Series(0).Name = "Modified serie name" + 'Hiding the category labels + chart.CategoryLabelLevel = OfficeCategoriesLabelLevel.CategoriesLabelLevelNone + 'Show Data Table. + chart.HasDataTable = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the Height of the chart in points (1/72 inch). + + + + //Open the presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Get the first slide + ISlide slide = presentation.Slides[0]; + //Get the chart in slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Modify the chart height + chart.Height = 500; + //Modify the chart width + chart.Width = 700; + //Change the title + chart.ChartTitle = "New title"; + //Change the serie name of first chart serie + chart.Series[0].Name = "Modified serie name"; + //Hiding the category labels + chart.CategoryLabelLevel = OfficeCategoriesLabelLevel.CategoriesLabelLevelNone; + //Show Data Table. + chart.HasDataTable = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open the presentation + Dim presentation As IPresentation = Presentation.Open("Sample.pptx") + 'Get the first slide + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart in slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IOfficeChart) + 'Modify the chart height + chart.Height = 500 + 'Modify the chart width + chart.Width = 700 + 'Change the title + chart.ChartTitle = "New title" + 'Change the serie name of first chart serie + chart.Series(0).Name = "Modified serie name" + 'Hiding the category labels + chart.CategoryLabelLevel = OfficeCategoriesLabelLevel.CategoriesLabelLevelNone + 'Show Data Table. + chart.HasDataTable = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the collection of the all series of this chart. Read-only. + + + + //Open the presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Get the first slide + ISlide slide = presentation.Slides[0]; + //Get the chart in slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Modify the chart height + chart.Height = 500; + //Modify the chart width + chart.Width = 700; + //Change the title + chart.ChartTitle = "New title"; + //Change the serie name of first chart serie + chart.Series[0].Name = "Modified serie name"; + //Hiding the category labels + chart.CategoryLabelLevel = OfficeCategoriesLabelLevel.CategoriesLabelLevelNone; + //Show Data Table. + chart.HasDataTable = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open the presentation + Dim presentation As IPresentation = Presentation.Open("Sample.pptx") + 'Get the first slide + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart in slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IOfficeChart) + 'Modify the chart height + chart.Height = 500 + 'Modify the chart width + chart.Width = 700 + 'Change the title + chart.ChartTitle = "New title" + 'Change the serie name of first chart serie + chart.Series(0).Name = "Modified serie name" + 'Hiding the category labels + chart.CategoryLabelLevel = OfficeCategoriesLabelLevel.CategoriesLabelLevelNone + 'Show Data Table. + chart.HasDataTable = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the primary category axis. Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the primary category axis + IOfficeChartCategoryAxis primaryCategoryAxis = chart.PrimaryCategoryAxis; + //Set the data range of the category axis + primaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the primary category axis + Dim primaryCategoryAxis As IOfficeChartCategoryAxis = chart.PrimaryCategoryAxis + 'Set the data range of the category axis + primaryCategoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the primary value axis. Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Get the primary value axis + IOfficeChartValueAxis primaryValueAxis = chart.PrimaryValueAxis; + //Set bold font style + primaryValueAxis.Font.Bold = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Get the primary value axis + Dim primaryValueAxis As IOfficeChartValueAxis = chart.PrimaryValueAxis + 'Set bold font style + primaryValueAxis.Font.Bold = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the primary series axis. Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Get the primary serie axis + IOfficeChartSeriesAxis primarySerieAxis = chart.PrimarySerieAxis; + //Set the font style of serie axis + primarySerieAxis.Font.Italic = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Get the primary serie axis + Dim primarySerieAxis As IOfficeChartSeriesAxis = chart.PrimarySerieAxis + 'Set the font style of serie axis + primarySerieAxis.Font.Italic = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the secondary category axis. Read-only. + + + + //Open a presentation with Combinational chart type + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Get the secondary category axis + IOfficeChartCategoryAxis secondaryCategoryAxis = chart.PrimaryCategoryAxis; + //Set the minor grid lines + secondaryCategoryAxis.HasMinorGridLines = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation with Combinational chart type + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IOfficeChart) + 'Get the secondary category axis + Dim secondaryCategoryAxis As IOfficeChartCategoryAxis = chart.PrimaryCategoryAxis + 'Set the minor grid lines + secondaryCategoryAxis.HasMinorGridLines = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the secondary value axis. Read-only. + + + + //Open a presentation with Combinational chart type + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Get the secondary value axis + IOfficeChartValueAxis secondaryValueAxis = chart.SecondaryValueAxis; + //Set the tick label position + secondaryValueAxis.TickLabelPosition = OfficeTickLabelPosition.TickLabelPosition_NextToAxis; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation with Combinational chart type + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IOfficeChart) + 'Get the secondary value axis + Dim secondaryValueAxis As IOfficeChartValueAxis = chart.SecondaryValueAxis + 'Set the tick label position + secondaryValueAxis.TickLabelPosition = OfficeTickLabelPosition.TickLabelPosition_NextToAxis + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets an object that represents the complete chart area for the chart. Read-only. + + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to slide + IPresentationChart chart = slide.Shapes.AddChart(100, 100, 400, 300); + //Set the chart data value + chart.ChartData.SetValue(1, 2, "1"); + chart.ChartData.SetValue(2, 1, "A"); + chart.ChartData.SetValue(2, 2, 20); + //Set chart data range + chart.DataRange = chart.ChartData[2, 2, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Get the chart area + IOfficeChartFrameFormat chartArea = chart.ChartArea; + //Set the line pattern of chart border + chartArea.Border.LinePattern = OfficeChartLinePattern.DashDotDot; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to slide + Dim chart As IPresentationChart = slide.Shapes.AddChart(100, 100, 400, 300) + 'Set the chart data value + chart.ChartData.SetValue(1, 2, "1") + chart.ChartData.SetValue(2, 1, "A") + chart.ChartData.SetValue(2, 2, 20) + 'Set chart data range + chart.DataRange = chart.ChartData(2, 2, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Column_Clustered + 'Get the chart area + Dim chartArea As IOfficeChartFrameFormat = chart.ChartArea + 'Set the line pattern of chart border + chartArea.Border.LinePattern = OfficeChartLinePattern.DashDotDot + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets plot area frame format. Read-only. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to slide + IPresentationChart chart = slide.Shapes.AddChart(100, 120, 500, 300); + //Set the data range of chart + chart.DataRange = chart.ChartData[1, 2, 4, 3]; + //Set data to the chart- RowIndex, columnIndex and data + chart.ChartData.SetValue(1, 2, "2012"); + chart.ChartData.SetValue(2, 2, 330); + chart.ChartData.SetValue(3, 2, 490); + chart.ChartData.SetValue(4, 2, 700); + chart.ChartType = OfficeChartType.Area; + //Edge: Specifies that the width or Height will be interpreted as right or bottom of the chart element + //Factor: Specifies that the width or Height will be interpreted as the width or height of the chart element + chart.PlotArea.Layout.LeftMode = LayoutModes.auto; + chart.PlotArea.Layout.TopMode = LayoutModes.factor; + //Value in points should not be a negative value if LayoutMode is Edge + //It can be a negative value if the LayoutMode is Factor. + chart.ChartTitleArea.Layout.Left = 10; + chart.ChartTitleArea.Layout.Top = 100; + //Manually positioning chart plot area + chart.PlotArea.Layout.LayoutTarget = LayoutTargets.outer; + chart.PlotArea.Layout.LeftMode = LayoutModes.edge; + chart.PlotArea.Layout.TopMode = LayoutModes.edge; + //Manually positioning chart legend + chart.Legend.Layout.LeftMode = LayoutModes.factor; + chart.Legend.Layout.TopMode = LayoutModes.factor; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to slide + Dim chart As IPresentationChart = slide.Shapes.AddChart(100, 120, 500, 300) + 'Sets the data range of chart + chart.DataRange = chart.ChartData(1, 2, 4, 3) + 'Set data to the chart- RowIndex, columnIndex and data + chart.ChartData.SetValue(1, 2, "2012") + chart.ChartData.SetValue(2, 2, 330) + chart.ChartData.SetValue(3, 2, 490) + chart.ChartData.SetValue(4, 2, 700) + chart.ChartType = OfficeChartType.Area + 'Edge: Specifies that the width or Height will be interpreted as right or bottom of the chart element + 'Factor: Specifies that the width or Height will be interpreted as the width or height of the chart element + chart.PlotArea.Layout.LeftMode = LayoutModes.auto + chart.PlotArea.Layout.TopMode = LayoutModes.factor + 'Value in points should not be a negative value if LayoutMode is Edge + 'It can be a negative value if the LayoutMode is Factor. + chart.ChartTitleArea.Layout.Left = 10 + chart.ChartTitleArea.Layout.Top = 100 + 'Manually positioning chart plot area + chart.PlotArea.Layout.LayoutTarget = LayoutTargets.outer + chart.PlotArea.Layout.LeftMode = LayoutModes.edge + chart.PlotArea.Layout.TopMode = LayoutModes.edge + 'Manually positioning chart legend + chart.Legend.Layout.LeftMode = LayoutModes.factor + chart.Legend.Layout.TopMode = LayoutModes.factor + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the chart walls. Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Set the fill type of wall as pattern + chart.Walls.Fill.FillType = OfficeFillType.Pattern; + //set the back color of the pattern fill + chart.Walls.Fill.BackColor = Color.AliceBlue; + //Set the fore color of the pattern fill + chart.Walls.Fill.ForeColor = Color.Brown; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Set the fill type of wall as pattern + chart.Walls.Fill.FillType = OfficeFillType.Pattern + 'set the back color of the pattern fill + chart.Walls.Fill.BackColor = Color.AliceBlue + 'Set the fore color of the pattern fill + chart.Walls.Fill.ForeColor = Color.Brown + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the chart BackWall. Read-only. + + + + //Open the presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Get the first slide + ISlide slide = presentation.Slides[0]; + //Get the chart in slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Change the chart type to 3D + chart.ChartType = OfficeChartType.Bar_Clustered_3D; + //Set the rotation + chart.Rotation = 80; + //Set the shadow angle + chart.SideWall.Shadow.Angle = 60; + //Set the backwall border weight + chart.BackWall.Border.LineWeight = OfficeChartLineWeight.Narrow; + //Save the presentation + presentation.Save("output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open the presentation + Dim presentation As IPresentation = Presentation.Open("Sample.pptx") + 'Get the first slide + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart in slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IOfficeChart) + 'Change the chart type to 3D + chart.ChartType = OfficeChartType.Bar_Clustered_3D + 'Set the rotation + chart.Rotation = 80 + 'Set the shadow angle + chart.SideWall.Shadow.Angle = 60 + 'Set the backwall border weight + chart.BackWall.Border.LineWeight = OfficeChartLineWeight.Narrow + 'Save the presentation + presentation.Save("output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the chart BackWall. Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Specify the chart type + chart.ChartType = OfficeChartType.Surface_3D; + //Get the back wall of the chart + IOfficeChartWallOrFloor backWall = chart.BackWall; + //Set the line properties of the back wall + backWall.LineProperties.LineWeight = OfficeChartLineWeight.Narrow; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Specify the chart title + chart.ChartTitle = "Sales Analysis" + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Specify the chart type + chart.ChartType = OfficeChartType.Surface_3D + 'Get the back wall of the chart + Dim backWall As IOfficeChartWallOrFloor = chart.BackWall + 'Set the line properties of the back wall + backWall.LineProperties.LineWeight = OfficeChartLineWeight.Narrow + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the chart floor. Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Get the floor of chart + IOfficeChartWallOrFloor floor = chart.Floor; + //Set the filltype of floor as pattern fill + floor.Fill.FillType = OfficeFillType.Pattern; + //Set the back and fore color of the pattern fill + floor.Fill.BackColor = Color.Blue; + floor.Fill.ForeColor = Color.Brown; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Get the floor of chart + Dim floor As IOfficeChartWallOrFloor = chart.Floor + 'Set the filltype of floor as pattern fill + floor.Fill.FillType = OfficeFillType.Pattern + 'Set the back and fore color of the pattern fill + floor.Fill.BackColor = Color.Blue + floor.Fill.ForeColor = Color.Brown + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the charts dataTable object. + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Set the chart with data table + chart.HasDataTable = true; + //Get the data table, read only + IOfficeChartDataTable dataTable = chart.DataTable; + //set borders for data table + dataTable.HasBorders = true; + //Set the show serie keys + dataTable.ShowSeriesKeys = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IOfficeChart) + 'Set the chart with data table + chart.HasDataTable = True + 'Get the data table, read only + Dim dataTable As IOfficeChartDataTable = chart.DataTable + 'set borders for data table + dataTable.HasBorders = True + 'Set the show serie keys + dataTable.ShowSeriesKeys = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets whether the chart has data table. + + + + //Open the presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Get the first slide + ISlide slide = presentation.Slides[0]; + //Get the chart in slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Modify the chart height + chart.Height = 500; + //Modify the chart width + chart.Width = 700; + //Change the title + chart.ChartTitle = "New title"; + //Change the serie name of first chart serie + chart.Series[0].Name = "Modified serie name"; + //Hiding the category labels + chart.CategoryLabelLevel = OfficeCategoriesLabelLevel.CategoriesLabelLevelNone; + //Show Data Table. + chart.HasDataTable = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open the presentation + Dim presentation As IPresentation = Presentation.Open("Sample.pptx") + 'Get the first slide + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart in slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IOfficeChart) + 'Modify the chart height + chart.Height = 500 + 'Modify the chart width + chart.Width = 700 + 'Change the title + chart.ChartTitle = "New title" + 'Change the serie name of first chart serie + chart.Series(0).Name = "Modified serie name" + 'Hiding the category labels + chart.CategoryLabelLevel = OfficeCategoriesLabelLevel.CategoriesLabelLevelNone + 'Show Data Table. + chart.HasDataTable = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the chart legend. + + + + IPresentation presentation = Presentation.Create(); + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to slide + IPresentationChart chart = slide.Shapes.AddChart(100, 120, 500, 300); + //Sets the data range of chart + chart.DataRange = chart.ChartData[1, 2, 4, 3]; + //Set data to the chart- RowIndex, columnIndex and data + chart.ChartData.SetValue(1, 2, "2012"); + chart.ChartData.SetValue(2, 2, 330); + chart.ChartData.SetValue(3, 2, 490); + chart.ChartData.SetValue(4, 2, 700); + chart.ChartType = OfficeChartType.Area; + //Edge: Specifies that the width or Height will be interpreted as right or bottom of the chart element + //Factor: Specifies that the width or Height will be interpreted as the width or height of the chart element + chart.PlotArea.Layout.LeftMode = LayoutModes.auto; + chart.PlotArea.Layout.TopMode = LayoutModes.factor; + //Value in points should not be a negative value if LayoutMode is Edge + //It can be a negative value if the LayoutMode is Factor. + chart.ChartTitleArea.Layout.Left = 10; + chart.ChartTitleArea.Layout.Top = 100; + //Manually positioning chart plot area + chart.PlotArea.Layout.LayoutTarget = LayoutTargets.outer; + chart.PlotArea.Layout.LeftMode = LayoutModes.edge; + chart.PlotArea.Layout.TopMode = LayoutModes.edge; + //Manually positioning chart legend + chart.Legend.Layout.LeftMode = LayoutModes.factor; + chart.Legend.Layout.TopMode = LayoutModes.factor; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Create() + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to slide + Dim chart As IPresentationChart = slide.Shapes.AddChart(100, 120, 500, 300) + 'Sets the data range of chart + chart.DataRange = chart.ChartData(1, 2, 4, 3) + 'Set data to the chart- RowIndex, columnIndex and data + chart.ChartData.SetValue(1, 2, "2012") + chart.ChartData.SetValue(2, 2, 330) + chart.ChartData.SetValue(3, 2, 490) + chart.ChartData.SetValue(4, 2, 700) + chart.ChartType = OfficeChartType.Area + 'Edge: Specifies that the width or Height will be interpreted as right or bottom of the chart element + 'Factor: Specifies that the width or Height will be interpreted as the width or height of the chart element + chart.PlotArea.Layout.LeftMode = LayoutModes.auto + chart.PlotArea.Layout.TopMode = LayoutModes.factor + 'Value in points should not be a negative value if LayoutMode is Edge + 'It can be a negative value if the LayoutMode is Factor. + chart.ChartTitleArea.Layout.Left = 10 + chart.ChartTitleArea.Layout.Top = 100 + 'Manually positioning chart plot area + chart.PlotArea.Layout.LayoutTarget = LayoutTargets.outer + chart.PlotArea.Layout.LeftMode = LayoutModes.edge + chart.PlotArea.Layout.TopMode = LayoutModes.edge + 'Manually positioning chart legend + chart.Legend.Layout.LeftMode = LayoutModes.factor + chart.Legend.Layout.TopMode = LayoutModes.factor + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets whether the chart has legends. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Hide the legend + chart.HasLegend = false; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Hide the legend + chart.HasLegend = False + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the rotation of the 3-D chart view + (the rotation of the plot area around the z-axis, in degrees).(0 to 360 degrees). + + + + //Open the presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Get the first slide + ISlide slide = presentation.Slides[0]; + //Get the chart in slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //Change the chart type to 3D + chart.ChartType = OfficeChartType.Bar_Clustered_3D; + //Set the rotation + chart.Rotation = 80; + //Set the shadow angle + chart.SideWall.Shadow.Angle = 60; + //Set the backwall border weight + chart.BackWall.Border.LineWeight = OfficeChartLineWeight.Narrow; + //Save the presentation + presentation.Save("output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open the presentation + Dim presentation As IPresentation = Presentation.Open("Sample.pptx") + 'Get the first slide + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart in slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IOfficeChart) + 'Change the chart type to 3D + chart.ChartType = OfficeChartType.Bar_Clustered_3D + 'Set the rotation + chart.Rotation = 80 + 'Set the shadow angle + chart.SideWall.Shadow.Angle = 60 + 'Set the backwall border weight + chart.BackWall.Border.LineWeight = OfficeChartLineWeight.Narrow + 'Save the presentation + presentation.Save("output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the elevation of the 3-D chart view, in degrees (–90 to 90 degrees). + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Set the elevation of chart + chart.Elevation = -50; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Set the elevation of chart + chart.Elevation = -50 + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the perspective for the 3-D chart view (0 to 100). + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Set the perspective + chart.Perspective = 100; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Set the perspective of chart + chart.Perspective = 100 + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the height of a 3-D chart as a percentage of the chart width + (between 5 and 500 percent). + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Set the height percent + chart.HeightPercent = 400; + //Set the Depth percent + chart.DepthPercent = 200; + //Set the gap depth of data series + chart.GapDepth = 400; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IOfficeChart) + 'set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Set the height percent + chart.HeightPercent = 400 + 'Set the Depth percent + chart.DepthPercent = 200 + 'Set the gap depth of data series + chart.GapDepth = 400 + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the depth of a 3-D chart as a percentage of the chart width + (between 20 and 2000 percent). + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Set the height percent + chart.HeightPercent = 400; + //Set the Depth percent + chart.DepthPercent = 200; + //Set the gap depth of data series + chart.GapDepth = 400; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IOfficeChart) + 'set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Set the height percent + chart.HeightPercent = 400 + 'Set the Depth percent + chart.DepthPercent = 200 + 'Set the gap depth of data series + chart.GapDepth = 400 + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the distance between the data series in a 3-D chart, as a percentage of the marker width.( 0 - 500 ) + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Set the height percent + chart.HeightPercent = 400; + //Set the Depth percent + chart.DepthPercent = 200; + //Set the gap depth of data series + chart.GapDepth = 400; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IOfficeChart) + 'set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Set the height percent + chart.HeightPercent = 400 + 'Set the Depth percent + chart.DepthPercent = 200 + 'Set the gap depth of data series + chart.GapDepth = 400 + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets whether if the chart axes are at right angles, independent of chart rotation or elevation. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the right angle axes + chart.RightAngleAxes = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the right angle axes + chart.RightAngleAxes = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets whether if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Set the right angle axes property of the chart + chart.RightAngleAxes = true; + //Set the auto scaling of chart + chart.AutoScaling = true; + //Save the presentation + presentation.Save("sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the right angle axes + chart.RightAngleAxes = True + 'Set the auto scaling of chart + chart.AutoScaling = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets if grid lines are drawn two-dimensionally on a 3-D chart. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Set the 2D gridlines for chart + chart.WallsAndGridlines2D = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Set the 2D gridlines for chart + chart.WallsAndGridlines2D = True + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + + Gets or sets the way that blank cells are plotted on a chart. + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Set the way blank cells to be plotted + chart.DisplayBlanksAs = OfficeChartPlotEmpty.Interpolated; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IOfficeChart) + 'set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Set the way blank cells to be plotted + chart.DisplayBlanksAs = OfficeChartPlotEmpty.Interpolated + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets whether if only visible cells are plotted. False if both visible and hidden cells are plotted. + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Hide the plot visiblity of cells + chart.PlotVisibleOnly = false; + //Hide the chart size with sheet window + chart.SizeWithWindow = false; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IOfficeChart) + 'set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Hide the plot visiblity of cells + chart.PlotVisibleOnly = False + 'Hide the chart size with sheet window + chart.SizeWithWindow = False + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets whether the chart size matches with the chart sheet window. True if Microsoft Excel resizes the chart to match the size of the chart sheet window. + False if the chart size isn't attached to the window size. Applies only to chart sheets. + + + + IPresentation presentation = Presentation.Open("Template.pptx"); + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Shapes[0] as IPresentationChart; + //set the chart type + chart.ChartType = OfficeChartType.Column_3D; + //Hide the plot visiblity of cells + chart.PlotVisibleOnly = false; + //Hide the chart size with sheet window + chart.SizeWithWindow = false; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = TryCast(slide.Shapes(0), IOfficeChart) + 'set the chart type + chart.ChartType = OfficeChartType.Column_3D + 'Hide the plot visiblity of cells + chart.PlotVisibleOnly = False + 'Hide the chart size with sheet window + chart.SizeWithWindow = False + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the collection of the all categories of this chart. Read-only. + + + + //Creates a Presentation instance + IPresentation pptxDoc = Presentation.Create(); + //Adds a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Adds chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specifies the chart title + chart.ChartTitle = "Sales Analysis"; + //Sets chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Sets chart data - Row2 + chart.ChartData.SetValue(2, 1, 2010); + chart.ChartData.SetValue(2, 2, 60); + chart.ChartData.SetValue(2, 3, 70); + chart.ChartData.SetValue(2, 4, 80); + //Sets chart data - Row3 + chart.ChartData.SetValue(3, 1, 2011); + chart.ChartData.SetValue(3, 2, 80); + chart.ChartData.SetValue(3, 3, 70); + chart.ChartData.SetValue(3, 4, 60); + //Sets chart data - Row4 + chart.ChartData.SetValue(4, 1, 2012); + chart.ChartData.SetValue(4, 2, 60); + chart.ChartData.SetValue(4, 3, 70); + chart.ChartData.SetValue(4, 4, 80); + //Creates a new chart series with the name + IOfficeChartSerie seriesJan = chart.Series.Add("Jan"); + //Sets the data range of chart series – start row, start column, end row, end column + seriesJan.Values = chart.ChartData[2, 2, 4, 2]; + //Creates a new chart series with the name + IOfficeChartSerie seriesFeb = chart.Series.Add("Feb"); + //Sets the data range of chart series – start row, start column, end row, end column + seriesFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Creates a new chart series with the name + IOfficeChartSerie seriesMarch = chart.Series.Add("March"); + //Sets the data range of chart series – start row, start column, end row, end column + seriesMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Sets the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Specifies the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Get the chart categories. + IOfficeChartCategories chartCategories = chart.Categories; + bool value = chartCategories.IsReadOnly; + //Save the presentation + pptxDoc.Save("Sample.pptx"); + //Close the presentation + pptxDoc.Close(); + + + 'Creates a Presentation instance + Dim pptxDoc As IPresentation = Presentation.Create() + 'Adds a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Adds chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Specifies the chart title + chart.ChartTitle = "Sales Analysis" + 'Sets chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Sets chart data - Row2 + chart.ChartData.SetValue(2, 1, 2010) + chart.ChartData.SetValue(2, 2, 60) + chart.ChartData.SetValue(2, 3, 70) + chart.ChartData.SetValue(2, 4, 80) + 'Sets chart data - Row3 + chart.ChartData.SetValue(3, 1, 2011) + chart.ChartData.SetValue(3, 2, 80) + chart.ChartData.SetValue(3, 3, 70) + chart.ChartData.SetValue(3, 4, 60) + 'Sets chart data - Row4 + chart.ChartData.SetValue(4, 1, 2012) + chart.ChartData.SetValue(4, 2, 60) + chart.ChartData.SetValue(4, 3, 70) + chart.ChartData.SetValue(4, 4, 80) + 'Creates a new chart series with the name + Dim seriesJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Sets the data range of chart series – start row, start column, end row, end column + seriesJan.Values = chart.ChartData(2, 2, 4, 2) + 'Creates a new chart series with the name + Dim seriesFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Sets the data range of chart series – start row, start column, end row, end column + seriesFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Creates a new chart series with the name + Dim seriesMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Sets the data range of chart series – start row, start column, end row, end column + seriesMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Sets the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Specifies the chart type + chart.ChartType = OfficeChartType.Column_Clustered + 'Get the chart categories + Dim chartCategories As IOfficeChartCategories = chart.Categories + Dim value As Boolean = chartCategories.IsReadOnly + 'Adds the third slide into the Presentation + pptxDoc.Save("Sample.pptx") + 'Closes the Presentation + pptxDoc.Close() + + + + + + Gets or sets the series name filter option + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 500, 300); + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //set the serie name level + chart.SeriesNameLevel = OfficeSeriesNameLevel.SeriesNameLevelNone; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 500, 300) + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'set the serie name level + chart.SeriesNameLevel = OfficeSeriesNameLevel.SeriesNameLevelNone + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the category name filter option + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Specify the chart type + chart.ChartType = OfficeChartType.Surface_3D; + //Set the category label level + chart.CategoryLabelLevel = OfficeCategoriesLabelLevel.CategoriesLabelLevelAll; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Specify the chart title + chart.ChartTitle = "Sales Analysis" + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Specify the chart type + chart.ChartType = OfficeChartType.Surface_3D + 'Set the category label level + chart.CategoryLabelLevel = OfficeCategoriesLabelLevel.CategoriesLabelLevelAll + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets the chart data. Read-only. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Specify the chart title + chart.ChartTitle = "Sales Analysis" + 'Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Gets or sets the Style of the chart. + + + + //Create a presentation instance + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add chart to the slide with position and size + IPresentationChart chart = slide.Charts.AddChart(100, 10, 700, 500); + //Specify the chart style + chart.Style=30; + //Specify the chart title + chart.ChartTitle = "Sales Analysis"; + //Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered; + //Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan"); + chart.ChartData.SetValue(1, 3, "Feb"); + chart.ChartData.SetValue(1, 4, "March"); + //Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010"); + chart.ChartData.SetValue(2, 2, "60"); + chart.ChartData.SetValue(2, 3, "70"); + chart.ChartData.SetValue(2, 4, "80"); + //Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011"); + chart.ChartData.SetValue(3, 2, "80"); + chart.ChartData.SetValue(3, 3, "70"); + chart.ChartData.SetValue(3, 4, "60"); + //Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012"); + chart.ChartData.SetValue(4, 2, "60"); + chart.ChartData.SetValue(4, 3, "70"); + chart.ChartData.SetValue(4, 4, "80"); + //Create a new chart series with the name + IOfficeChartSerie serieJan = chart.Series.Add("Jan"); + //Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData[2, 2, 4, 2]; + //Create a new chart series with the name + IOfficeChartSerie serieFeb = chart.Series.Add("Feb"); + //Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData[2, 3, 4, 3]; + //Create a new chart series with the name + IOfficeChartSerie serieMarch = chart.Series.Add("March"); + //Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData[2, 4, 4, 4]; + //Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 4, 1]; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation instance + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add chart to the slide with position and size + Dim chart As IPresentationChart = slide.Charts.AddChart(100, 10, 700, 500) + 'Specify the chart style + chart.Style=30; + 'Specify the chart title + chart.ChartTitle = "Sales Analysis" + 'Specify the chart type + chart.ChartType = OfficeChartType.Column_Clustered + 'Set chart data - Row1 + chart.ChartData.SetValue(1, 2, "Jan") + chart.ChartData.SetValue(1, 3, "Feb") + chart.ChartData.SetValue(1, 4, "March") + 'Set chart data - Row2 + chart.ChartData.SetValue(2, 1, "2010") + chart.ChartData.SetValue(2, 2, "60") + chart.ChartData.SetValue(2, 3, "70") + chart.ChartData.SetValue(2, 4, "80") + 'Set chart data - Row3 + chart.ChartData.SetValue(3, 1, "2011") + chart.ChartData.SetValue(3, 2, "80") + chart.ChartData.SetValue(3, 3, "70") + chart.ChartData.SetValue(3, 4, "60") + 'Set chart data - Row4 + chart.ChartData.SetValue(4, 1, "2012") + chart.ChartData.SetValue(4, 2, "60") + chart.ChartData.SetValue(4, 3, "70") + chart.ChartData.SetValue(4, 4, "80") + 'Create a new chart series with the name + Dim serieJan As IOfficeChartSerie = chart.Series.Add("Jan") + 'Set the data range of chart serie – start row, start column, end row, end column + serieJan.Values = chart.ChartData(2, 2, 4, 2) + 'Create a new chart series with the name + Dim serieFeb As IOfficeChartSerie = chart.Series.Add("Feb") + 'Set the data range of chart serie – start row, start column, end row, end column + serieFeb.Values = chart.ChartData(2, 3, 4, 3) + 'Create a new chart series with the name + Dim serieMarch As IOfficeChartSerie = chart.Series.Add("March") + 'Set the data range of chart series – start row, start column, end row, end column + serieMarch.Values = chart.ChartData(2, 4, 4, 4) + 'Set the data range of the category axis + chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData(2, 1, 4, 1) + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + True if chart is parsed; + otherwise False. + + + + + Determines whether to use the excel data range for the chart. + + + + + Determines whether the chart data range is set or not. + + + + + Converts the chart to image and saves the image to the specified stream. + + The stream to save the image. + + + + Sets the chart data with the specified two dimensional data. + + Represents the two dimensional chart data + + + + + Set data range for chart from the sheet. + + Worksheet number in the excel document that contains data for a chart. + Data range in the worksheet from which the chart to be created. + + + + Sets the chart data with the specified two dimensional data,row and column index. + + Represents the two dimensional chart data + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + + + + + Sets the chart data. + + IEnumerable object with desired data + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + + + + + Replaces the chart data with the worksheet data. + + + Optional Boolean. Set to true to update all the formulas in the Excel sheet. The default value is false. + + + + //Open a presentation containing charts + IPresentation presentation = Presentation.Open("Template.pptx"); + //Get the slide from presentation + ISlide slide = presentation.Slides[0]; + //Get the chart from slide + IPresentationChart chart = slide.Charts[0]; + //Refreshes the chart object according its excel data. + chart.Refresh(true); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation containing charts + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + 'Get the slide from presentation + Dim slide As ISlide = presentation.Slides(0) + 'Get the chart from slide + Dim chart As IPresentationChart = slide.Charts(0) + 'Refreshes the chart object according its excel data. + chart.Refresh(True) + 'Save the presentation + presentation.Save("Sample.pptx") + 'Close the presentation + presentation.Close() + + + + + + Returns the current chart object. + + + + + + Compares the current Shape object with given Shape object. + + The Shape object to compare with the current instance. + True if the Shape objects are equal; otherwise, false. + + + + Gets a instance for this chart. Read-only. + + + This property can be used in to convert chart as an image. + + + + + Type of the chart. + + + + + DataRange for the chart series. + + + + + True if series are in rows in DataRange; + False otherwise. + + + + + Title of the chart. + + + + + Returns object that describes chart title area. Read-only. + + + + + Page setup for the chart. Read-only. + + + + + X coordinate of the upper-left corner + of the chart in points (1/72 inch). + + + + + Y coordinate of the upper-left corner + of the chart in points (1/72 inch). + + + + + Collection of the all series of this chart. Read-only. + + + + + Primary category axis. Read-only. + + + + + Primary value axis. Read-only. + + + + + Primary series axis. Read-only. + + + + + Secondary category axis. Read-only. + + + + + Secondary value axis. Read-only. + + + + + Returns an object that represents the complete chart area for the chart. Read-only. + + + + + Returns plot area frame format. Read-only. + + + + + Represents chart walls. Read-only. + + + + + Represents chart BackWall. Read-only. + + + + + Represents chart BackWall. Read-only. + + + + + Represents chart floor. Read-only. + + + + + Represents charts dataTable object. + + + + + True if the chart has a data table. + + + + + Represents chart legend. + + + + + True if the chart has a legend object. + + + + + Returns or sets the rotation of the 3-D chart view + (the rotation of the plot area around the z-axis, in degrees).(0 to 360 degrees). + + + + + Returns or sets the elevation of the 3-D chart view, in degrees (–90 to +90 degrees). + + + + + Returns or sets the perspective for the 3-D chart view (0 to 100). + + + + + Returns or sets the height of a 3-D chart as a percentage of the chart width + (between 5 and 500 percent). + + + + + Returns or sets the depth of a 3-D chart as a percentage of the chart width + (between 20 and 2000 percent). + + + + + Returns or sets the distance between the data series in a 3-D chart, as a percentage of the marker width.( 0 - 500 ) + + + + + True if the chart axes are at right angles, independent of chart rotation or elevation. + + + + + True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart. + + + + + True if gridlines are drawn two-dimensionally on a 3-D chart.This is only for Binary file format. + + + + + Indicates whether chart has plot area. + + + + + Represents the way that blank cells are plotted on a chart. + + + + + True if only visible cells are plotted. False if both visible and hidden cells are plotted.This is only for Binary file format. + + + + + True if Microsoft Excel resizes the chart to match the size of the chart sheet window. + False if the chart size isn't attached to the window size. Applies only to chart sheets. + This is only for Binary file format. + + + + + Gets or sets the type of the pivot chart. + + The type of the pivot chart. + + + + Gets or sets a value indicating whether [show all field buttons]. + + + true if [show all field buttons]; otherwise, false. + + + + + Gets or sets a value indicating whether [show value field buttons]. + + + true if [show value field buttons]; otherwise, false. + + + + + Gets or sets a value indicating whether [show axis field buttons]. + + + true if [show axis field buttons]; otherwise, false. + + + + + Gets or sets a value indicating whether [show legend field buttons]. + + + true if [show legend field buttons]; otherwise, false. + + + + + Gets or sets a value indicating whether [show report filter field buttons]. + + + true if [show report filter field buttons]; otherwise, false. + + + + + Collection of the all categories of this chart. Read-only. + + + + + Represents the series name filter option + + + + + Represents the category name filter option + + + + + Represents the style of the chart + + + + + Represents chart data. Read-only. + + + + + Returns or sets whether to use the excel data range for chart. + + + + + Determines whether Chart data range is set or not. + + + + + True if chart is parsed; + False otherwise. + + + + + Represents the document properties in a MS Word document. + + + + + + Represents the built-in document properties. + + + + + Gets or sets the title. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the Title. + builtInDocumentProperties.Title = "Presentation Title"; + //Save the presentation. + presentation.Save("Title.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the Title + builtInDocumentProperties.Title = "Presentation Title" + 'Save the presentation. + presentation__1.Save("Title.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the subject. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the Subject + builtInDocumentProperties.Subject = "Subject"; + //Save the presentation. + presentation.Save("Subject.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the Subject + builtInDocumentProperties.Subject = "Subject" + 'Save the presentation. + presentation__1.Save("Subject.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the author. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the Author + builtInDocumentProperties.Author = "Author"; + //Save the presentation. + presentation.Save("Author.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the Author + builtInDocumentProperties.Author = "Author" + 'Save the presentation. + presentation__1.Save("Author.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the keywords. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the keywords. + builtInDocumentProperties.Keywords = "Keywords"; + //Save the presentation. + presentation.Save("Keywords.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the keywords. + builtInDocumentProperties.Keywords = "Keywords" + 'Save the presentation. + presentation__1.Save("Keywords.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the comments. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the comments. + builtInDocumentProperties.Comments = "Comments"; + //Save the presentation. + presentation.Save("Comments.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the comments. + builtInDocumentProperties.Comments = "Comments" + 'Save the presentation. + presentation__1.Save("Comments.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the template. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the template. + builtInDocumentProperties.Template = "Presentation Template"; + //Save the presentation. + presentation.Save("Template.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the template. + builtInDocumentProperties.Template = "Presentation Template" + 'Save the presentation. + presentation__1.Save("Template.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the last author. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the last author. + builtInDocumentProperties.LastAuthor = "Last Author"; + //Save the presentation. + presentation.Save("LastAuthor.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the last author. + builtInDocumentProperties.LastAuthor = "Last Author" + 'Save the presentation. + presentation__1.Save("LastAuthor.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the revision number. + + This property is intended to store only valid numerical string. + Any non-numerical string assigned to this property will not be accepted. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the revision number. + builtInDocumentProperties.RevisionNumber = "200"; + //Save the presentation. + presentation.Save("RevisionNumber.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the revision number. + builtInDocumentProperties.RevisionNumber = "200" + 'Save the presentation. + presentation__1.Save("RevisionNumber.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the edit time. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the edit time. + builtInDocumentProperties.EditTime = TimeSpan.FromDays(22); + //Save the presentation. + presentation.Save("EditTime.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the edit time. + builtInDocumentProperties.EditTime = TimeSpan.FromDays(22) + 'Save the presentation. + presentation__1.Save("EditTime.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the last printed. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the last printed. + builtInDocumentProperties.LastPrinted = DateTime.Now; + //Save the presentation. + presentation.Save("LastPrinted.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the last printed. + builtInDocumentProperties.LastPrinted = DateTime.Now + 'Save the presentation. + presentation__1.Save("LastPrinted.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the creation date. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the creation date. + builtInDocumentProperties.CreationDate = DateTime.Today; + //Save the presentation. + presentation.Save("CreationDate.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the creation date. + builtInDocumentProperties.CreationDate = DateTime.Today + 'Save the presentation. + presentation__1.Save("CreationDate.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the last save date. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the last save date. + builtInDocumentProperties.LastSaveDate = DateTime.Today; + //Save the presentation. + presentation.Save("LastSaveDate.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the last save date. + builtInDocumentProperties.LastSaveDate = DateTime.Today + 'Save the presentation. + presentation__1.Save("LastSaveDate.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the page count. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the page count. + builtInDocumentProperties.PageCount = 300; + //Save the presentation. + presentation.Save("PageCount.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the page count. + builtInDocumentProperties.PageCount = 300 + 'Save the presentation. + presentation__1.Save("PageCount.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the word count. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the word count. + builtInDocumentProperties.WordCount = 551; + //Save the presentation. + presentation.Save("WordCount.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the word count. + builtInDocumentProperties.WordCount = 551 + 'Save the presentation. + presentation__1.Save("WordCount.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the character count. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the character count. + builtInDocumentProperties.CharCount = 10; + //Save the presentation. + presentation.Save("CharCount.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the character count. + builtInDocumentProperties.CharCount = 10 + 'Save the presentation. + presentation__1.Save("CharCount.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the category. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the category. + builtInDocumentProperties.Category = "Category"; + //Save the presentation. + presentation.Save("Category.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the category. + builtInDocumentProperties.Category = "Category" + 'Save the presentation. + presentation__1.Save("Category.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the target format (35mm, printer, video, and so on). + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the PresentationTarget + builtInDocumentProperties.PresentationTarget = "Presentation Target"; + //Save the presentation. + presentation.Save("Output.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the PresentationTarget + builtInDocumentProperties.PresentationTarget = "Presentation Target" + 'Save the presentation. + presentation__1.Save("Output.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the byte count. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the byte count. + builtInDocumentProperties.ByteCount = 20; + //Save the presentation. + presentation.Save("ByteCount.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the byte count. + builtInDocumentProperties.ByteCount = 20 + 'Save the presentation. + presentation__1.Save("ByteCount.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the line count. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the line count. + builtInDocumentProperties.LineCount = 3; + //Save the presentation. + presentation.Save("LineCount.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the line count. + builtInDocumentProperties.LineCount = 3 + 'Save the presentation. + presentation__1.Save("LineCount.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the paragraph count. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the paragraph count. + builtInDocumentProperties.ParagraphCount = 84; + //Save the presentation. + presentation.Save("ParagraphCount.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the paragraph count. + builtInDocumentProperties.ParagraphCount = 84 + 'Save the presentation. + presentation__1.Save("ParagraphCount.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the SlideCount. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the SlideCount. + builtInDocumentProperties.SlideCount = 10; + //Save the presentation. + presentation.Save("SlideCount.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the SlideCount. + builtInDocumentProperties.SlideCount = 10 + 'Save the presentation. + presentation__1.Save("SlideCount.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the note count. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the note count. + builtInDocumentProperties.NoteCount = 100; + //Save the presentation. + presentation.Save("NoteCount.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the note count. + builtInDocumentProperties.NoteCount = 100 + 'Save the presentation. + presentation__1.Save("NoteCount.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the hidden count. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the hidden count. + builtInDocumentProperties.HiddenCount = 40; + //Save the presentation. + presentation.Save("NoteCount.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the hidden count. + builtInDocumentProperties.HiddenCount = 40 + 'Save the presentation. + presentation__1.Save("NoteCount.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the MultimediaClipCount. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the MultimediaClipCount. + builtInDocumentProperties.MultimediaClipCount = 0; + //Save the presentation. + presentation.Save("MultimediaClipCount.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the MultimediaClipCount. + builtInDocumentProperties.MultimediaClipCount = 0 + 'Save the presentation. + presentation__1.Save("MultimediaClipCount.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the manager name. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the manager name. + builtInDocumentProperties.Manager = "Manager"; + //Save the presentation. + presentation.Save("MultimediaClipCount.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the manager name. + builtInDocumentProperties.Manager = "Manager" + 'Save the presentation. + presentation__1.Save("MultimediaClipCount.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the company name. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the company name. + builtInDocumentProperties.Company = "Company"; + //Save the presentation. + presentation.Save("Company.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the company name. + builtInDocumentProperties.Company = "Company" + 'Save the presentation. + presentation__1.Save("Company.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Indicates whether the custom links are + hampered by excessive noise, for all applications. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the LinksDirty + builtInDocumentProperties.LinksDirty = true; + //Save the presentation. + presentation.Save("Company.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the LinksDirty + builtInDocumentProperties.LinksDirty = true + 'Save the presentation. + presentation__1.Save("Company.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the application name. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the application name. + builtInDocumentProperties.ApplicationName = "Application Name"; + //Save the presentation. + presentation.Save("ApplicationName.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the application name. + builtInDocumentProperties.ApplicationName = "Application Name" + 'Save the presentation. + presentation__1.Save("ApplicationName.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the content status. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the content status. + builtInDocumentProperties.ContentStatus = "Content Status"; + //Save the presentation. + presentation.Save("ContentStatus.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the content status. + builtInDocumentProperties.ContentStatus = "Content Status" + 'Save the presentation. + presentation__1.Save("ContentStatus.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the language. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the language. + builtInDocumentProperties.Language = "English"; + //Save the presentation. + presentation.Save("Language.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the language. + builtInDocumentProperties.Language = "English" + 'Save the presentation. + presentation__1.Save("Language.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the version. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built in document properties from the presentation. + IBuiltInDocumentProperties builtInDocumentProperties = presentation.BuiltInDocumentProperties; + //Set the version. + builtInDocumentProperties.Version = "1"; + //Save the presentation. + presentation.Save("Version.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built in document properties from the presentation. + Dim builtInDocumentProperties As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the version. + builtInDocumentProperties.Version = "1" + 'Save the presentation. + presentation__1.Save("Version.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Guid for parsing/serialization summary properties. + + + + + Guid for parsing/serialization document properties. + + + + + Dictionary with document properties, key - property name/id, value - property object. + + + + + Dictionary with summary document properties, key - property id, value - property object. + + + + + Default constructor. + + + + + Returns dictionary where property must be placed. + + Property id. + Dictionary where property must be placed. + + + + Title document property. + + + + + Subject document property. + + + + + Author document property. + + + + + Keywords document property. + + + + + Comments document property. + + + + + Template document property. + + + + + LastAuthor document property. + + + + + Revision number document property. + + This property is intended to store only valid numerical string. + Any non-numerical string assigned to this property will not be accepted. + + + + EditTime document property. + + + + + LastPrinted document property. + + + + + CreationDate document property. + + + + + LastSaveDate document property. + + + + + PageCount document property. + + + + + WordCount document property. + + + + + CharCount document property. + + + + + Indicates whether the file has Headpair tag. + + + + + Category. + + + + + Target format for presentation (35mm, printer, video, and so on). + + + + + ByteCount. + + + + + LineCount. + + + + + ParCount. + + + + + SlideCount. + + + + + NoteCount. + + + + + HiddenCount. + + + + + MmclipCount. + + + + + Set to True when scaling of the thumbnail is desired. If not set, cropping is desired. + + + + + Manager. + + + + + Company. + + + + + Boolean value to indicate whether the custom links are + hampered by excessive noise, for all applications. + + + + + + + + + + Clipboard format. + + + + + Clipboard data. + + + + + Createas copy of the current object. + + A copy of the current object. + + + + Saves clipboard data into stream. + + Stream to write data into. + Size of the written data. + + + + Extracts data from the stream. + + Stream to get data from. + + + + Contains utility methods for object cloning. + + + + + Clones int array. + + Array to clone + Returns cloned array. + + + + Clones ushort array. + + Array to clone. + Returns cloned array. + + + + Clones string array. + + Array to clone. + Returns cloned array. + + + + Clones object array. + + Array to clone. + Returns cloned array. + + + + Clones object that implements ICloneable interface. + + Object to clone. + A clone of the object. + + + + Clones byte array. + + Array to clone. + Return cloned array. + + + + Clone Dictionary. + + Dictionary to clone + Returns a copy of the Dictionary. + + + + Clone Dictionary. + + Dictionary to clone + Returns a copy of the Dictionary. + + + + Creates copy of the stream. + + Stream to copy. + Created stream. + + + + Summary description for CustomDocumentProperties. + + + + + + Represents the custom document properties. + + + + + Removes the property with specified name, from the document property collection. + + The name of the property to remove. + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document properties. + ICustomDocumentProperties customDocumentProperties = presentation.CustomDocumentProperties; + //Add a new custom document property + customDocumentProperties.Add("PropertyA"); + //Check if the item exist in document properties and remove + if (customDocumentProperties.Contains("PropertyA")) + customDocumentProperties.Remove("PropertyA"); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document properties. + Dim customDocumentProperties As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add a new custom document property + customDocumentProperties.Add("PropertyA") + 'Check if the item exist in document properties and remove + If customDocumentProperties.Contains("PropertyA") Then + customDocumentProperties.Remove("PropertyA") + End If + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Determines whether the property with specified name is in the document property collection. + + The name of the document property to locate. + true if property is present in the collection; otherwise, false. + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document properties. + ICustomDocumentProperties customDocumentProperties = presentation.CustomDocumentProperties; + //Add a new custom document property + customDocumentProperties.Add("PropertyA"); + //Check if the item exist in document properties + if (customDocumentProperties.Contains("PropertyA")) + //Sets a four byte signed integer value. + customDocumentProperties["PropertyA"].Int32 = 256; + //Save the presentation + presentation.Save("Clear.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document properties. + Dim customDocumentProperties As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add a new custom document property + customDocumentProperties.Add("PropertyA") + 'Check if the item exist in document properties + If customDocumentProperties.Contains("PropertyA") Then + 'Sets a four byte signed integer value. + customDocumentProperties("PropertyA").Int32 = 256 + End If + 'Save the presentation + presentation__1.Save("Clear.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Adds a document property to the presentation with the specified name. + + The name of the document property. + The instance + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document properties. + ICustomDocumentProperties customDocumentProperties = presentation.CustomDocumentProperties; + //Add a new custom document property + customDocumentProperties.Add("Property1"); + //Set a Boolean value. + customDocumentProperties["Property1"].Boolean = true; + //Save the presentation + presentation.Save("Output.pptx"); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document properties. + Dim customDocumentProperties As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add a new custom document property + customDocumentProperties.Add("Property1") + 'Set a Boolean value. + customDocumentProperties("Property1").[Boolean] = True + 'Save the presentation + presentation__1.Save("Output.pptx") + + + + + + Removes all the document properties from the presentation. + + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document properties. + ICustomDocumentProperties customDocumentProperties = presentation.CustomDocumentProperties; + //Add a new custom document property + customDocumentProperties.Add("Property1"); + //Set a Boolean value. + customDocumentProperties["Property1"].Boolean = true; + //Add a new custom document property + customDocumentProperties.Add("Property2"); + //Set a date time. + customDocumentProperties["Property2"].DateTime = DateTime.Now; + //Clear the properties + customDocumentProperties.Clear(); + //Save the presentation + presentation.Save("Clear.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document properties. + Dim customDocumentProperties As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add a new custom document property + customDocumentProperties.Add("Property1") + 'Set a Boolean value. + customDocumentProperties("Property1").[Boolean] = True + 'Add a new custom document property + customDocumentProperties.Add("Property2") + 'Set a date time. + customDocumentProperties("Property2").DateTime = DateTime.Now + 'Clear the properties + customDocumentProperties.Clear() + 'Save the presentation + presentation__1.Save("Clear.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a instance with the specified name, from the document property collection. Read-only. + + The name of the document property to locate. + Returns the element at the particular name. + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document properties. + ICustomDocumentProperties customDocumentProperties = presentation.CustomDocumentProperties; + //Add a new custom document property + customDocumentProperties.Add("Property1"); + //Set a Boolean value. + customDocumentProperties["Property1"].Boolean = true; + //Add a new custom document property + customDocumentProperties.Add("Property2"); + //Set a date time. + customDocumentProperties["Property2"].DateTime = DateTime.Now; + //Get the specific property, read only + IDocumentProperty documentProp = customDocumentProperties["Property1"]; + //Save the presentation + presentation.Save("CustomProperty.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document properties. + Dim customDocumentProperties As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add a new custom document property + customDocumentProperties.Add("Property1") + 'Set a Boolean value. + customDocumentProperties("Property1").[Boolean] = True + 'Add a new custom document property + customDocumentProperties.Add("Property2") + 'Set a date time. + customDocumentProperties("Property2").DateTime = DateTime.Now + 'Get the specific property, read only + Dim documentProp As IDocumentProperty = customDocumentProperties("Property1") + 'Save the presentation + presentation__1.Save("CustomProperty.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a instance at the specified index of document property collection. Read-only. + + The zero-based index of the element. + Returns the element at the particular index. + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document properties. + ICustomDocumentProperties customDocumentProperties = presentation.CustomDocumentProperties; + //Add a new custom document property + customDocumentProperties.Add("Property1"); + //Set a Boolean value. + customDocumentProperties["Property1"].Boolean = true; + //Add a new custom document property + customDocumentProperties.Add("Property2"); + //Set a date time. + customDocumentProperties["Property2"].DateTime = DateTime.Now; + //Get the property at specific index, read only + IDocumentProperty documentProperty = customDocumentProperties[0]; + //Save the presentation + presentation.Save("CustomProperty.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document properties. + Dim customDocumentProperties As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add a new custom document property + customDocumentProperties.Add("Property1") + 'Set a Boolean value. + customDocumentProperties("Property1").[Boolean] = True + 'Add a new custom document property + customDocumentProperties.Add("Property2") + 'Set a date time. + customDocumentProperties("Property2").DateTime = DateTime.Now + 'Get the property at specific index, read only + Dim documentProperty As IDocumentProperty = customDocumentProperties(0) + 'Save the presentation + presentation__1.Save("CustomProperty.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the number of document properties in the presentation. Read-only. + + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document properties. + ICustomDocumentProperties customDocumentProperties = presentation.CustomDocumentProperties; + //Add a new custom document property + customDocumentProperties.Add("Property1"); + //Set a Boolean value. + customDocumentProperties["Property1"].Boolean = true; + //Add a new custom document property + customDocumentProperties.Add("Property2"); + //Set a date time. + customDocumentProperties["Property2"].DateTime = DateTime.Now; + //Add a new custom document property + customDocumentProperties.Add("Property3"); + //Sets a four byte signed integer value. + customDocumentProperties["Property3"].Int32 = 256; + //Get the count of custom document properties, read only + int count = customDocumentProperties.Count; + //Save the presentation + presentation.Save("Count.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document properties. + Dim customDocumentProperties As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add a new custom document property + customDocumentProperties.Add("Property1") + 'Set a Boolean value. + customDocumentProperties("Property1").[Boolean] = True + 'Add a new custom document property + customDocumentProperties.Add("Property2") + 'Set a date time. + customDocumentProperties("Property2").DateTime = DateTime.Now + 'Add a new custom document property + customDocumentProperties.Add("Property3") + 'Sets a four byte signed integer value. + customDocumentProperties("Property3").Int32 = 256 + 'Get the count of custom document properties, read only + Dim count As Integer = customDocumentProperties.Count + 'Save the presentation + presentation__1.Save("Count.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Custom guid string. + + + + + Guid used for parsing/serialization of custom properties. + + + + + Dictionary with document properties, key - property name/id, value - property value. + + + + + Default constructor. + + + + + Returns custom property by name. + + Custom property. + Custom property. + + + + Returns the document property list of the custom document properties. + + Document property list. + + + + Removes specified object from the collection. + + Property name. + + + + Adds element to the collection. + + Property name to add. + Newly created property. + + + + Checks whether collection contains property with specified name. + + Name to check. + True if property is contained by collection; false otherwise. + + + + Returns single entry from the collection. Read-only. + + + + + Returns single entry from the collection. Read-only. + + + + + This class contains constants required for document properties parsing and serialization in Excel 2007 format. + + + + + Core properties enable users to get and set well-known and common sets of property metadata within packages. + + + + + Represents a categorization of the content of this package. + + + + + Represents the date of creation of the resource. + + + + + Represents an entity primarily responsible for making the content of the resource. + + + + + Represents an explanation of the content of the resource. + + + + + Represents a delimited set of keywords to support searching and indexing. + + + + + Represents the user who performed the last modification. + + + + + Represents the date and time of the last printing. + + + + + Represents the date on which the resource was changed. + + + + + Represents the topic of the content of the resource. + + + + + Represents the name given to the resource. + + + + + Represents Xsi attribute. + + + + + Represents Xsi attribute value. + + + + + Represents date time format structure. + + + + + This element specifies the application properties of a document. + + + + + This element specifies the name of the application that created this document. + + + + + This element specifies the total number of characters in a document. + + + + + This element specifies the name of a company associated with the document. + + + + + MS Excel uses this Tag to represents the xml parts. In our XlsIO, + this tag is used to find the document is generated by MS Excel. + + + + + Tag to represents the file is generated by Essential Presentation. + + + + + This element specifies the total number of lines in a document when last saved by a conforming producer if applicable. + + + + + This element specifies the name of a supervisor associated with the document. + + + + + This element specifies the total number of sound or video clips that are present in the document. + + + + + This element specifies the number of slides in a presentation containing notes. + + + + + This element specifies the total number of pages of a document if applicable. + + + + + This element specifies the total number of paragraphs found in a document if applicable. + + + + + This element specifies the intended format for a presentation document. + + + + + This element specifies the total number of slides in a presentation document. + + + + + This element specifies the name of an external document template containing format and style information + used to create the current document. + + + + + Total time that a document has been edited. The default time unit is minutes. + + + + + This element specifies the total number of words contained in a document when last saved. + + + + + This element specifies the base string used for evaluating relative hyperlinks in this document. + + + + + Represents default Excel97-03 hyperlink base name. + + + + + Parent element for the custom file properties part. + + + + + This element specifies a single custom file property. + + + + + Uniquely relates a custom property with an OLE property. + + + + + Uniquely relates a custom property with an OLE property. + + + + + Specifies the name of this custom file property. + + + + + This element specifies a Boolean variant type. + + + + + This element specifies a wide string variant type. + + + + + This element specifies a string variant type. + + + + + This element specifies a date variant type of type date-time as defined in RFC 3339. + + + + + This element specifies a 4-byte signed integer variant type. + + + + + This element specifies a 8-byte real number variant type. + + + + + This element specifies an integer variant type. + + + + + This element specifies a file-time variant type of type date-time. + + + + + Represents the name of the link target attribute. + + + + + Summary description for DocumentPropertyImpl. + + + + + + Represents the custom or built-in document property. + + + + + Indicates whether the property is built-in or not. Read-only. + + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document properties. + ICustomDocumentProperties customDocumentProperties = presentation.CustomDocumentProperties; + //Add a new document property. + IDocumentProperty documentProperty = customDocumentProperties.Add("PropertyA"); + //Set a Boolean value. + documentProperty.Boolean = true; + //Get boolean value to check if built-in property or not, it is read only + bool value = documentProperty.IsBuiltIn; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document properties. + Dim customDocumentProperties As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add a new document property. + Dim documentProperty As IDocumentProperty = customDocumentProperties.Add("PropertyA") + 'Set a Boolean value. + documentProperty.[Boolean] = True + 'Get boolean value to check if built-in property or not, it is read only + Dim value As Boolean = documentProperty.IsBuiltIn + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets the property id for the built-in property. Read-only. + + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document properties. + ICustomDocumentProperties customDocumentProperties = presentation.CustomDocumentProperties; + //Add a new document property. + IDocumentProperty documentProperty = customDocumentProperties.Add("PropertyA"); + //Set a Boolean value. + documentProperty.Boolean = true; + //Get the built-in property, it is read only + BuiltInProperty builtinProp = documentProperty.BuiltInProperty; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document properties. + Dim customDocumentProperties As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add a new document property. + Dim documentProperty As IDocumentProperty = customDocumentProperties.Add("PropertyA") + 'Set a Boolean value. + documentProperty.[Boolean] = True + 'Get the built-in property, it is read only + Dim builtinProp As BuiltInProperty = documentProperty.BuiltInProperty + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets the property name. Read-only. + + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document properties. + ICustomDocumentProperties customDocumentProperties = presentation.CustomDocumentProperties; + //Add a new document property. + IDocumentProperty documentProperty = customDocumentProperties.Add("PropertyA"); + //Set a Boolean value. + documentProperty.Boolean = true; + //Get the name of document property + string name = documentProperty.Name; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document properties. + Dim customDocumentProperties As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add a new document property. + Dim documentProperty As IDocumentProperty = customDocumentProperties.Add("PropertyA") + 'Set a Boolean value. + documentProperty.[Boolean] = True + 'Get the name of document property + Dim name As String = documentProperty.Name + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the property value. + + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document properties. + ICustomDocumentProperties customDocumentProperties = presentation.CustomDocumentProperties; + //Add a new document property. + IDocumentProperty documentProperty = customDocumentProperties.Add("PropertyA"); + //Set the timespan value + documentProperty.TimeSpan = TimeSpan.FromMinutes(20.30); + //Set the value of document property + documentProperty.Value = 100; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document properties. + Dim customDocumentProperties As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add a new document property. + Dim documentProperty As IDocumentProperty = customDocumentProperties.Add("PropertyA") + 'Set the timespan value + documentProperty.TimeSpan = TimeSpan.FromMinutes(20.3) + //Set the value of document property + documentProperty.Value = 100; + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the boolean value. + + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document properties. + ICustomDocumentProperties customDocumentProperties = presentation.CustomDocumentProperties; + //Add a new document property. + IDocumentProperty documentProperty = customDocumentProperties.Add("PropertyA"); + //Set a Boolean value. + documentProperty.Boolean = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document properties. + Dim customDocumentProperties As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add a new document property. + Dim documentProperty As IDocumentProperty = customDocumentProperties.Add("PropertyA") + 'Set a Boolean value. + documentProperty.[Boolean] = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the integer value. + + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document properties. + ICustomDocumentProperties customDocumentProperties = presentation.CustomDocumentProperties; + //Add a new document property. + IDocumentProperty documentProperty = customDocumentProperties.Add("PropertyA"); + //Set the integer property + documentProperty.Integer = 130; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document properties. + Dim customDocumentProperties As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add a new document property. + Dim documentProperty As IDocumentProperty = customDocumentProperties.Add("PropertyA") + 'Set integer property + documentProperty.[Integer] = 130 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the 4-bytes signed integer value. + + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document properties. + ICustomDocumentProperties customDocumentProperties = presentation.CustomDocumentProperties; + //Add a new document property. + IDocumentProperty documentProperty = customDocumentProperties.Add("PropertyA"); + //Set value for Int32 + documentProperty.Int32 = 25; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document properties. + Dim customDocumentProperties As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add a new document property. + Dim documentProperty As IDocumentProperty = customDocumentProperties.Add("PropertyA") + 'Set value for Int32 + documentProperty.Int32 = 25 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the double value. + + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document properties. + ICustomDocumentProperties customDocumentProperties = presentation.CustomDocumentProperties; + //Add a new document property. + IDocumentProperty documentProperty = customDocumentProperties.Add("PropertyA"); + //Set a double value. + documentProperty.Double = 345.00; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document properties. + Dim customDocumentProperties As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add a new document property. + Dim documentProperty As IDocumentProperty = customDocumentProperties.Add("PropertyA") + 'Set a double value. + documentProperty.[Double] = 345.0 + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the string value. + + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document properties. + ICustomDocumentProperties customDocumentProperties = presentation.CustomDocumentProperties; + //Add a new document property. + IDocumentProperty documentProperty = customDocumentProperties.Add("PropertyA"); + //Set the text + documentProperty.Text = "Document Property"; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document properties. + Dim customDocumentProperties As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add a new document property. + Dim documentProperty As IDocumentProperty = customDocumentProperties.Add("PropertyA") + 'Set the text + documentProperty.Text = "Document Property" + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the DateTime value. + + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document properties. + ICustomDocumentProperties customDocumentProperties = presentation.CustomDocumentProperties; + //Add a new document property. + IDocumentProperty documentProperty = customDocumentProperties.Add("PropertyA"); + //Set a date time. + documentProperty.DateTime = DateTime.Now; + //Save the presentation + presentation.Save("DateTime.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document properties. + Dim customDocumentProperties As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add a new document property. + Dim documentProperty As IDocumentProperty = customDocumentProperties.Add("PropertyA") + 'Set a date time. + documentProperty.DateTime = DateTime.Now + 'Save the presentation + presentation__1.Save("DateTime.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the TimeSpan value. + + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document properties. + ICustomDocumentProperties customDocumentProperties = presentation.CustomDocumentProperties; + //Add a new document property. + IDocumentProperty documentProperty = customDocumentProperties.Add("PropertyA"); + //Set the timespan value + documentProperty.TimeSpan = TimeSpan.FromMinutes(20.30); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document properties. + Dim customDocumentProperties As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add a new document property. + Dim documentProperty As IDocumentProperty = customDocumentProperties.Add("PropertyA") + 'Set the timespan value + documentProperty.TimeSpan = TimeSpan.FromMinutes(20.3) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets the source of a linked custom document property. + + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document properties. + ICustomDocumentProperties customDocumentProperties = presentation.CustomDocumentProperties; + //Add a new document property. + IDocumentProperty documentProperty = customDocumentProperties.Add("PropertyA"); + //Set the link source + documentProperty.LinkSource = "www.google.com"; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document properties. + Dim customDocumentProperties As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add a new document property. + Dim documentProperty As IDocumentProperty = customDocumentProperties.Add("PropertyA") + 'Set the link source + documentProperty.LinkSource = "www.google.com" + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets or sets a boolean value indicates whether the property is linked to the content. + + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document properties. + ICustomDocumentProperties customDocumentProperties = presentation.CustomDocumentProperties; + //Add a new document property. + IDocumentProperty documentProperty = customDocumentProperties.Add("PropertyA"); + //Set the link source + documentProperty.LinkSource = "www.google.com"; + //Set the link to content + documentProperty.LinkToContent = true; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document properties. + Dim customDocumentProperties As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add a new document property. + Dim documentProperty As IDocumentProperty = customDocumentProperties.Add("PropertyA") + 'Set the link source + documentProperty.LinkSource = "www.google.com" + 'Set the link to content + documentProperty.LinkToContent = True + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Start index for Id2 PropVariant property. + + + + + Start year for FILETIME structure. + + + + + Property id. + + + + + Property name. + + + + + Property value. + + + + + Property type. + + + + + The source of a linked custom document property. String. + + + + + True if the value of the custom document property is linked to the content + of the container document. False if the value is static. Boolean. + + + + + Default constructor. + + + + + Initializes new instance of the class. + + Property name. + Property value. + + + + Initializes new instance of the class. + + Property id. + Property value. + + + + Detects type of the string. + + String value to check. + Detected string type. + + + + Tries to detect and set property type. + + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Creates copy of the internal value. + + + + + Indicates whether property is built-in. Read-only. + + + + + Returns / sets property id for built-in properties. + + + + + Returns property name. Read-only. + + + + + Gets / sets property value. + + + + + Gets / sets boolean value. + + + + + Gets / sets integer value. + + + + + Gets / sets 4-bytes signed integer value. + + + + + Gets / sets double value. + + + + + Gets / sets string value. + + + + + Gets / sets DateTime value. + + + + + Gets / sets TimeSpan value. + + + + + Gets / sets Blob value. + + + + + Gets or sets clipboard data value. + + + + + Gets / sets array of strings. + + + + + Gets / sets array of objects. Supported object types are string and Int32. + + + + + Gets / sets document property type. + + + + + Returns or sets the source of a linked custom document property. String. + + + + + True if the value of the custom document property is linked to the content of the container document. False if the value is static. Boolean. + + + + + Internal name of the document property. + + + + + Specifies the built-in document properties of the PowerPoint presentation. + + + + + Specifies the Title of presentation. + + + + + Specifies the Subject of presentation. + + + + + Specifies the Author of presentation. + + + + + Specifies the Keywords of presentation. + + + + + Specifies the Comments of presentation. + + + + + Specifies the Template of presentation. + + + + + Specifies the Last Author of presentation. + + + + + Specifies the Revision number of presentation. + + + + + Specifies the Edit Time of presentation. + + + + + Specifies the Last Printed property of presentation. + + + + + Specifies the Creation Date of presentation. + + + + + Specifies the Last Save Date of presentation. + + + + + Specifies the Page Count of presentation. + + + + + Specifies the Word Count of presentation. + + + + + Specifies the Character Count of presentation. + + + + + Specifies the Thumbnail of presentation. + + + + + Specifies the Application Name of presentation. + + + + + Specifies the Security of the presentation. + + + + + Specifies the Category of presentation. + + + + + Specifies the Target format for presentation (35mm, printer, video, and so on) id. + + + + + Specifies the Byte Count of presentation. + + + + + Specifies the Line Count of presentation. + + + + + Specifies the Paragraph Count of presentation. + + + + + Specifies the slide count of presentation. + + + + + Specifies the note count of presentation. + + + + + Specifies the hidden count of presentation. + + + + + Specifies the multimedia clip count of presentation. + + + + + Specifies the ScaleCrop of presentation. + + + + + Specifies the heading pair of presentation. + + + + + Specifies the document parts of presentation. + + + + + Specifies the manager of presentation. + + + + + Specifies the company of presentation. + + + + + Specifies the dirty links of presentation. + + + + + Enumeration with all supported property types. + + + + + Indicates a Boolean value. + + + + + Indicates an integer value. + + + + + Indicates a 4-bytes signed integer value. + + + + + Indicates a 2-bytes signed interger value. + + + + + Indicates a 4-bytes unsigned interger value. + + + + + Indicates a wide string terminated by a null. + + + + + Indicates a string terminated by a null. + + + + + Indicates a FILETIME value. + + + + + Indicates length prefixed bytes. + + + + + Indicates a simple, counted array. + + + + + Indicates an object. + + + + + Indicates a double value. + + + + + Indicates an empty value. + + + + + Indicates null value. + + + + + Indicates clipboard data. + + + + + Indicates an array of strings. + + + + + Indicates an array of strings. + + + + + Indicates an array of objects. Supported types are string and integer values. + + + + + Size of the Int32 in bytes. + + + + + Size of the Int162 in bytes. + + + + + Size of the Double in bytes. + + + + + Reads Int16 value from the stream. + + Stream to get data from. + Temporary buffer to put extracted bytes into. + Extracted Int32 value. + + + + Reads Int32 value from the stream. + + Stream to get data from. + Temporary buffer to put extracted bytes into. + Extracted Int32 value. + + + + Reads Double value from the stream. + + Stream to get data from. + Temporary buffer to put extracted bytes into. + Extracted Double value. + + + + Writes Int16 value from the stream. + + Stream to get data from. + Value to write. + Size of the written data. + + + + Writes Int32 value from the stream. + + Stream to write data into. + Value to write. + Size of the written data. + + + + Reads Double value from the stream. + + Stream to get data from. + Temporary buffer to put extracted bytes into. + Extracted Double value. + + + + Gets ASCII string from the stream starting from the current position. + + Stream to get data from. + Approximate string size. + Extracted string. + + + + Extracts unicode string from the stream. + + + + + + + + Gets ASCII string from the stream starting from the current position. + + Stream to get data from. + Approximate string size. + Extracted string. + + + + Writes unicode string into steram. + + Stream to write data into. + Value to write. + Size of the written data in bytes. + + + + Writes string into stream using specified encoding. + + Stream to write data into. + Value to write. + Encoding to use. + Size of the written data in bytes. + + + + Adds padding if necessary. + + + + + + + Removes last zero character from the string if it is present. + + Value to check. + String after removal. + + + + Specifies the VarEnum. + + + + + Specifies the VarEnum is vt_ array + + + + + Specifies the VarEnum is vt_ BLOB + + + + + Specifies the VarEnum is vt_ blo b_ object + + + + + Specifies the VarEnum is vt_ bool + + + + + Specifies the VarEnum is vt_ BSTR + + + + + Specifies the VarEnum is vt_ byref + + + + + Specifies the VarEnum is vt_ carray + + + + + Specifies the VarEnum is vt_ cf + + + + + Specifies the VarEnum is vt_ CLSID + + + + + Specifies the VarEnum is vt_ cy + + + + + Specifies the VarEnum is vt_ date + + + + + Specifies the VarEnum is vt_ decimal + + + + + Specifies the VarEnum is vt_ dispatch + + + + + Specifies the VarEnum is vt_ empty + + + + + Specifies the VarEnum is vt_ error + + + + + Specifies the VarEnum is vt_ filetime + + + + + Specifies the VarEnum is vt_ hresult + + + + + Specifies the VarEnum is vt_ i1 + + + + + Specifies the VarEnum is vt_ i2 + + + + + Specifies the VarEnum is vt_ i4 + + + + + Specifies the VarEnum is vt_ i8 + + + + + Specifies the VarEnum is vt_ int + + + + + Specifies the VarEnum is vt_ LPSTR + + + + + Specifies the VarEnum is vt_ LPWSTR + + + + + Specifies the VarEnum is vt_ null + + + + + Specifies the VarEnum is vt_ PTR + + + + + Specifies the VarEnum is vt_ r4 + + + + + Specifies the VarEnum is vt_ r8 + + + + + Specifies the VarEnum is vt_ record + + + + + Specifies the VarEnum is vt_ safearray + + + + + Specifies the VarEnum is vt_ storage + + + + + Specifies the VarEnum is vt_ store d_ object + + + + + Specifies the VarEnum is vt_ stream + + + + + Specifies the VarEnum is vt_ streame d_ object + + + + + Specifies the VarEnum is vt_ u i1 + + + + + Specifies the VarEnum is vt_ u i2 + + + + + Specifies the VarEnum is vt_ u i4 + + + + + Specifies the VarEnum is vt_ u i8 + + + + + Specifies the VarEnum is vt_ uint + + + + + Specifies the VarEnum is vt_ unknown + + + + + Specifies the VarEnum is vt_ userdefined + + + + + Specifies the VarEnum is vt_ variant + + + + + Specifies the VarEnum is vt_ vector + + + + + Specifies the VarEnum is vt_ void + + + + + + + + + + Encryption namespace. + + + + + Namespace definition for key encryptor password. + + + + + Namespace definition for key encryptor certificate. + + + + + Represents the internal constants for Presentation. + + + + + + Defines the none placeholder type. + + + + + Hundredths of a point. + + + + + Defines the default offset value for a picture fill. + + + + + Defines the default scale value for the picture fill. + + + + + Defines thousandths of a percentage. + + + + + Defines the percentage value. + + + + + Default smart art left value is used when the smartart is create from scratch. + + + + + Default smart art top value is used when the smartart is create from scratch. + + + + + Default smart art width is used when the smartart is create from scratch. + + + + + Default smart art height is used when the smartart is create from scratch. + + + + + Default rotation angle constants of a shape. + + + + + Size of the Int32 value. + + + + + Size of the Int64 value. + + + + + Number of bits inside single byte value. + + + + + Name of a namespace used by VML (marked by 'v' in MS PowerPoint 2007 documents). + + + + + Name of a namespace used by VML (marked by 'o' in MS PowerPoint 2007 documents). + + + + + Name of a namespace used by VML (marked by 'x' in MS PowerPoint 2007 documents). + + + + + Namespace prefix used in vml shapes. + + + + + Namespace prefix used in vml shapes. + + + + + Root tag for vml shapes. + + + + + Defines the maximum font scale value. + + + + + Defines the minimum font scale value. + + + + + Serailize the child elements of a extLst. + + Represent the xmlWritter + Represent the relation id of the svg image + + + + Checks if a duplicate relation exists for the specified relation collection. + + The OleObject to check for duplicate relations. + The target of the relation to check. + True if a duplicate relation exists, otherwise false. + + + + Writes a custom data list of shape. + + Represents a XML writer. + Represents a shape object. + + + + Length of compObject stream + + + + + This MUST be a CompObjHeader structure. + + + + + This MUST be a LengthPrefixedAnsiString structure that contains a display + name of the linked object or embedded object + + + + + This MUST be a ClipboardFormatOrAnsiString structure that contains the + Clipboard Format of the linked object or embedded object. If the MarkerOrLength + field of the ClipboardFormatOrAnsiString structure contains a value other than + 0x00000000, 0xffffffff, or 0xfffffffe, the value MUST NOT be greater than 0x00000190. + Otherwise the CompObjStream structure is invalid + + + + + If present, this MUST be a LengthPrefixedAnsiString structure. If the Length field of + the LengthPrefixedAnsiString contains a value of 0 or a value that is greater than + 0x00000028, the remaining fields of the structure starting with the String field + of the LengthPrefixedAnsiString MUST be ignored on processing. + + + + + If this field is present and is NOT set to 0x71B239F4, + the remaining fields of the structure MUST be ignored on processing + + + + + This MUST be a LengthPrefixedUnicodeString structure that contains a display name + of the linked object or embedded object. + + + + + This MUST be a ClipboardFormatOrUnicodeString structure that contains a Clipboard + Format of the linked object or embedded object. If the MarkerOrLength field of the + ClipboardFormatOrUnicodeString structure contains a value other than 0x00000000, + 0xffffffff, or 0xfffffffe, the value MUST NOT be more than 0x00000190. Otherwise, + the CompObjStream structure is invalid + + + + + This MUST be a LengthPrefixedUnicodeString. The String field of the LengthPrefixedUnicodeString + can contain any arbitrary value and MUST be ignored on processing. + + + + + Initializes a new instance of the class. + + The stream. + + + + Initializes a default instance of the class. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Saves data to STG stream. + + The stream. + + + + Writes the zero byte array. + + The stream. + Length of the byte. + + + + Writes the length prefixed string. + + The stream. + The data. + + + + Gets the size of the structure. + + The length. + + + + Gets the type of the object. + + The type of the object. + + + + Gets the type of the object. + + The type of the object. + + + + + + + + + This can be set to any arbitrary value and MUST be ignored on processing. + + + + + This can be set to any arbitrary value and MUST be ignored on processing. + + + + + This can be set to any arbitrary value and MUST be ignored on processing. + + + + + Initializes a new instance of the class. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Saves to STG stream. + + The stream. + + + + Gets the size of the structure. + + The length. + + + + + + + + + + + + + + + + + + + This MUST be set to 0x00000001 or 0x00000002. If this field has a value of 1, the OLEStream + structure MUST be for a linked object. If this field has a value of 0, then the OLEStream + structure MUST be for an embedded object. + + + + + This field contains an implementation-specific hint supplied by the application or by a + higher-level protocol that creates the data structure. The hint MAY be ignored on + processing of this data structure. + + + + + This MUST be set to 0x00000000. Otherwise, the OLEStream structure is invalid. + + + + + This MUST be set to the size, in bytes, of the ReservedMonikerStream field. + If this field has a value 0x00000000, the ReservedMonikerStream field MUST NOT be present. + + + + + This MUST be a MONIKERSTREAM structure that can contain any arbitrary value + and MUST be ignored on processing. + + + + + This MUST be set to the size, in bytes, of the RelativeSourceMonikerStream field. + If this field has a value 0x00000000, the RelativeSourceMonikerStream field MUST NOT be present. + + + + + This MUST be a MONIKERSTREAM structure that specifies the relative path to the linked object. + + + + + This MUST be set to the size, in bytes, of the AbsoluteSourceMonikerStream field. + This field MUST NOT contain the value 0x00000000. + + + + + This MUST be a MONIKERSTREAM structure that specifies the full path to the linked object. + + + + + This MUST be the LONG value -1 + + + + + This MUST be the CLSID containing the object class GUID of the creating application. + + + + + This MUST be a LengthPrefixedUnicodeString that can contain + any arbitrary value and MUST be ignored on processing. + + + + + This can contain any arbitrary value and MUST be ignored on processing. + + + + + This MUST be a FILETIME that contains the time + when the container application last updated the RemoteUpdateTime field. + + + + + This MUST be a FILETIME that contains the time + when the container application last checked the update time of the linked object. + + + + + This MUST be a FILETIME that contains the time when the linked object was last updated. + + + + + The type of the link; + + + + + Path to linked file + + + + + Initializes a new instance of the class. + + The stream. + + + + Initializes a default instance of the class. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Saves to compound stream. + + The stream. + + + + Gets the size of the structure. + + The length. + + + + + + + + + + + + + + Path to file + + + + + Initializes a new instance of the class. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Gets the size of the structure. + + The length. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Gets the size of the structure. + + The length. + + + + Reads the int16. + + The data array. + The offset. + + + + + Reads the int32. + + The data array. + The offset. + + + + + Reads the int64. + + The data array. + The offset. + + + + + Reads the int16. + + The data array. + The offset. + + + + + Reads the int32. + + The data array. + The offset. + + + + + Reads the array of bytes. + + The data array. + The length. + The offset. + + + + + Saves the specified int16 value in the data array. + + The arr data. + The offset. + + + + Saves the specified uint16 value in the data array. + + The arr data. + The offset. + + + + Saves the specified int32 value in the data array. + + The arr data. + The offset. + + + + Saves the specified int64 value in the data array. + + The destination. + The offset. + The value. + + + + Saves the specified uint32 value in the data array. + + The arr data. + The offset. + + + + Saves the bytes byte array. + + The destination array. + The offset. + The bytes. + + + + Copies the memory. + + The destination. + The source. + The length. + + + + Summary description for _Constants. + + + + + Size of the File Character position. + + + + + Number of bytes in single word value. + + + + + Number of bytes in single int value. + + + + + Number of bytes in formatted disk page. + + + + + Number of bytes in single long value. + + + + + To prevent creating instances of this class constructor was made private. + + + + + + + + + + + + + + + Initializes a new instance of the class. + + The stream. + + + + Initializes a default instance of the class. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Saves the data to stream. + + The STG stream. + + + + Gets the size of the structure. + + The length. + + + + Contains empty color. + + + + + Converts Int32 value into Color. + + Value to convert. + Converted value. + + + + Represents the ARGB(alpha, red, green, blue) color. + + + + + Represents the ARGB (alpha, red, green, blue) color. + + + + + Converts the structure to 32-bit ARGB value. + + The 32-bit ARGB value of the structure. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for slide background + IBackground background = slide.Background; + //Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid; + //Set the color to slide background + background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 23, 12, 89); + //Create instance for color + IColor color = background.Fill.SolidFill.Color; + //Convert color to argb + int argb = color.ToArgb(); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for slide background + Dim background As IBackground = slide.Background + 'Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid + 'Set the color to slide background + background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 23, 12, 89) + 'Create instance for color + Dim color As IColor = background.Fill.SolidFill.Color + 'Convert color to argb + Dim argb As Integer = color.ToArgb() + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value. + + + The System.Drawing.Color. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for slide background + IBackground background = slide.Background; + //Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid; + //Set the color to slide background + background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 23, 12, 89); + //Create instance for color + IColor color = background.Fill.SolidFill.Color; + //Set the system color by specifying the rgb values + color.SystemColor = Color.Red; + //Save the presentation + presentation.Save("SystemColor.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for slide background + Dim background As IBackground = slide.Background + 'Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid + 'Set the color to slide background + background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 23, 12, 89) + 'Create instance for color + Dim color__2 As IColor = background.Fill.SolidFill.Color + 'Set the system color by specifying the rgb values + color__2.SystemColor = Color.Red + 'Save the presentation + presentation__1.Save("SystemColor.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the alpha color value. Read-only. + + + A. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for slide background + IBackground background = slide.Background; + //Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid; + //Set the color to slide background + background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 23, 12, 89); + //Create instance for color + IColor color = background.Fill.SolidFill.Color; + //Get the transparency value of color + byte alpha = color.A; + //Save the presentation + presentation.Save("AlphaValue.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for slide background + Dim background As IBackground = slide.Background + 'Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid + 'Set the color to slide background + background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 23, 12, 89) + 'Create instance for color + Dim color As IColor = background.Fill.SolidFill.Color + 'Get the transparency value of color + Dim alpha As Byte = color.A + 'Save the presentation + presentation__1.Save("AlphaValue.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the blue color value. Read-only. + + + The B. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for slide background + IBackground background = slide.Background; + //Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid; + //Set the color to slide background + background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 23, 12, 89); + //Create instance for color + IColor color = background.Fill.SolidFill.Color; + //Get the blue color + byte blue = color.B; + //Save the presentation + presentation.Save("BlueColor.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for slide background + Dim background As IBackground = slide.Background + 'Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid + 'Set the color to slide background + background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 23, 12, 89) + 'Create instance for color + Dim color As IColor = background.Fill.SolidFill.Color + 'Get the blue color + Dim blue As Byte = color.B + 'Save the presentation + presentation__1.Save("BlueColor.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the green color value. Read-only. + + + The G. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for slide background + IBackground background = slide.Background; + //Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid; + //Set the color to slide background + background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 23, 12, 89); + //Create instance for color + IColor color = background.Fill.SolidFill.Color; + //Get the green color value + byte green = color.G; + //Save the presentation + presentation.Save("GreenColor.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for slide background + Dim background As IBackground = slide.Background + 'Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid + 'Set the color to slide background + background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 23, 12, 89) + 'Create instance for color + Dim color As IColor = background.Fill.SolidFill.Color + 'Get the green color value + Dim green As Byte = color.G + 'Save the presentation + presentation__1.Save("GreenColor.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Specifies whether this structure is uninitialized. Read-only. + + + true if this instance is empty; otherwise, false. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for slide background + IBackground background = slide.Background; + //Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid; + //Set the color to slide background + background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 23, 12, 89); + //Create instance for color + IColor color = background.Fill.SolidFill.Color; + //To check if it is a empty + bool _isEmpty = color.IsEmpty; + //Save the presentation + presentation.Save("Empty.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for slide background + Dim background As IBackground = slide.Background + 'Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid + 'Set the color to slide background + background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 23, 12, 89) + 'Create instance for color + Dim color As IColor = background.Fill.SolidFill.Color + 'To check if it is a empty + Dim _isEmpty As Boolean = color.IsEmpty + 'Save the presentation + presentation__1.Save("Empty.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a value indicating whether the color object is a predefined color. Predefined colors are represented by the enumeration. Read-only. + + + true if this instance is known color; otherwise, false. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for slide background + IBackground background = slide.Background; + //Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid; + //Set the color to slide background + background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 23, 12, 89); + //Create instance for color + IColor color = background.Fill.SolidFill.Color; + //To check if it is a known color + bool _isKnownColor = color.IsKnownColor; + //Save the presentation + presentation.Save("KnownColor.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for slide background + Dim background As IBackground = slide.Background + 'Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid + 'Set the color to slide background + background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 23, 12, 89) + 'Create instance for color + Dim color As IColor = background.Fill.SolidFill.Color + 'To check if it is a known color + Dim _isKnownColor As Boolean = color.IsKnownColor + 'Save the presentation + presentation__1.Save("KnownColor.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a value indicating whether the color object is a named color or a member of the enumeration. Read-only. + + + true if this instance is named color; otherwise, false. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for slide background + IBackground background = slide.Background; + //Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid; + //Set the color to slide background + background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 23, 12, 89); + //Create instance for color + IColor color = background.Fill.SolidFill.Color; + //To check if it is a named color + bool _isNamedColor = color.IsNamedColor; + //Save the presentation + presentation.Save("NamedColor.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for slide background + Dim background As IBackground = slide.Background + 'Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid + 'Set the color to slide background + background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 23, 12, 89) + 'Create instance for color + Dim color As IColor = background.Fill.SolidFill.Color + 'To check if it is a known color + Dim _isNamedColor As Boolean = color.IsNamedColor + 'Save the presentation + presentation__1.Save("NamedColor.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a value indicating whether the color object is a system color. System colors are represented by elements of the enumeration. Read-only. + + + true if this instance is system color; otherwise, false. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for slide background + IBackground background = slide.Background; + //Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid; + //Set the color to slide background + background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 23, 12, 89); + //Create instance for color + IColor color = background.Fill.SolidFill.Color; + //To check if it is a system color + bool _isSystemColor = color.IsSystemColor; + //Save the presentation + presentation.Save("SystemColor.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for slide background + Dim background As IBackground = slide.Background + 'Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid + 'Set the color to slide background + background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 23, 12, 89) + 'Create instance for color + Dim color As IColor = background.Fill.SolidFill.Color + 'To check if it is a system color + Dim _isSystemColor As Boolean = color.IsSystemColor + 'Save the presentation + presentation__1.Save("SystemColor.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the red color value. Read-only. + + + The R. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for slide background + IBackground background = slide.Background; + //Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid; + //Set the color to slide background + background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 23, 12, 89); + //Create instance for color + IColor color = background.Fill.SolidFill.Color; + //Get the red color value + byte red = color.R; + //Save the presentation + presentation.Save("RedColor.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for slide background + Dim background As IBackground = slide.Background + 'Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid + 'Set the color to slide background + background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 23, 12, 89) + 'Create instance for color + Dim color As IColor = background.Fill.SolidFill.Color + 'Get the red color value + Dim red As Byte = color.R + 'Save the presentation + presentation__1.Save("RedColor.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Compares the current ColorObject with given ColorObject. + + The ColorObject to compare with the current instance. + True if the ColorObjects are equal; otherwise, false. + + + + Represents a color that is null. + + + + + Initialize the ColorObject type with KnowColor object + + + + + + Default Constructor for ColorObject. + + + + + Creates an structure from a 32-bit ARGB value. + + A value specifying the 32-bit ARGB value. + The structure this method creates. + + + //Create a new presentation. + IPresentation presentation = Presentation.Open("Template.pptx"); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Set the color for solid fill + slide.Background.Fill.SolidFill.Color = ColorObject.FromArgb(146880); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Set the color for solid fill + slide.Background.Fill.SolidFill.Color = ColorObject.FromArgb(146880); + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Creates an structure from the four ARGB component (alpha, red, green, and blue) values. + + The alpha component. Valid values are 0 through 255. + The red component. Valid values are 0 through 255. + The green component. Valid values are 0 through 255. + The blue component. Valid values are 0 through 255. + The structure this method creates. + + + //Create a new presentation. + IPresentation presentation = Presentation.Open("Template.pptx"); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Set the argb value for solid fill + slide.Background.Fill.SolidFill.Color = ColorObject.FromArgb(90, 120, 120, 120); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Set the argb value for solid fill + slide.Background.Fill.SolidFill.Color = ColorObject.FromArgb(90, 120, 120, 120); + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Creates an structure from the specified structure combined with the new alpha value. + + The alpha value for the new . Valid values are 0 through 255. + The instance from which to create the new color. + The structure this method creates. + + + //Create a new presentation. + IPresentation presentation = Presentation.Open("Template.pptx"); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Set the color for solid fill + slide.Background.Fill.SolidFill.Color = ColorObject.FromArgb(30, ColorObject.Red); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Set the color for solid fill + slide.Background.Fill.SolidFill.Color = ColorObject.FromArgb(30, ColorObject.Red); + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Creates an structure from the specified RGB values (red, green, and blue). The alpha value is implicitly 255 (fully opaque). + + The red component value for the new . Valid values are 0 through 255. + The green component value for the new . Valid values are 0 through 255. + The blue component value for the new . Valid values are 0 through 255. + The structure this method creates. + + + //Create a new presentation. + IPresentation presentation = Presentation.Open("Template.pptx"); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Set the rgb value for solid fill + slide.Background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 120, 120); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Set the rgb value for solid fill + slide.Background.Fill.SolidFill.Color = ColorObject.FromArgb(120, 120, 120); + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Creates an structure from the specified predefined color. + + An element of the enumeration. + The structure this method creates. + + + //Create a new presentation. + IPresentation presentation = Presentation.Open("Template.pptx"); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Set the color of solid Fill + slide.Background.Fill.SolidFill.Color = ColorObject.FromKnownColor(System.Drawing.KnownColor.ActiveBorder); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation As IPresentation = Presentation.Open("Template.pptx") + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Set the color of solid Fill + slide.Background.Fill.SolidFill.Color = ColorObject.FromKnownColor(System.Drawing.KnownColor.ActiveBorder) + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation + presentation.Close() + + + + + + Returns the hue-saturation-brightness (HSB) brightness value for the specified structure. + + The brightness of this color. The brightness ranges from 0.0 through 1.0, where 0.0 represents black and 1.0 represents white. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add shape to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Dodecagon, 234, 23, 120, 100); + //Set the fill type of shape + shape.Fill.FillType = FillType.Pattern; + //Set the back color of the pattern fill + shape.Fill.PatternFill.BackColor = ColorObject.Red; + //Create an instance for color object + ColorObject colorObject = shape.Fill.PatternFill.BackColor as ColorObject; + //Get the brightness of color, it is read only + float brightness = colorObject.GetBrightness(); + //Save the presentation + presentation.Save("Output.pptx"); + //close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add shape to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Dodecagon, 234, 23, 120, 100) + 'Set the fill type of shape + shape.Fill.FillType = FillType.Pattern + 'Set the back color of the pattern fill + shape.Fill.PatternFill.BackColor = ColorObject.Red + 'Create an instance for color object + Dim colorObject As ColorObject = TryCast(shape.Fill.PatternFill.BackColor, ColorObject) + 'Get the brightness of color, it is read only + Dim brightness As Single = colorObject.GetBrightness() + 'Save the presentation + presentation.Save("Output.pptx") + 'close the presentation + presentation.Close() + + + + + + Returns the hue-saturation-brightness (HSB) hue value, in degrees. + + The hue, in degrees, of the specified color. The hue is measured in degrees, ranging from 0.0 through 360.0, in HSB color space. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add shape to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Dodecagon, 234, 23, 120, 100); + //Set the fill type of shape + shape.Fill.FillType = FillType.Pattern; + //Set the back color of the pattern fill + shape.Fill.PatternFill.BackColor = ColorObject.LightBlue; + //Create an instance for color object + ColorObject colorObject = shape.Fill.PatternFill.BackColor as ColorObject; + //Get hue of color, read only + float hue = colorObject.GetHue(); + //Save the presentation + presentation.Save("Output.pptx"); + //close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add shape to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Dodecagon, 234, 23, 120, 100) + 'Set the fill type of shape + shape.Fill.FillType = FillType.Pattern + 'Set the back color of the pattern fill + shape.Fill.PatternFill.BackColor = ColorObject.LightBlue + 'Create an instance for color object + Dim colorObject As ColorObject = TryCast(shape.Fill.PatternFill.BackColor, ColorObject) + 'Get the hue of color, it is read only + Dim hue As Single = colorObject.GetHue() + 'Save the presentation + presentation.Save("Output.pptx") + 'close the presentation + presentation.Close() + + + + + + Returns the hue-saturation-brightness (HSB) saturation value. + + The saturation of the specified color. The saturation ranges from 0.0 through 1.0, where 0.0 is gray-scale and 1.0 is the most saturated. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add shape to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Dodecagon, 234, 23, 120, 100); + //Set the fill type of shape + shape.Fill.FillType = FillType.Pattern; + //Set the back color of the pattern fill + shape.Fill.PatternFill.BackColor = ColorObject.LightBlue; + //Create an instance for color object + ColorObject colorObject = shape.Fill.PatternFill.BackColor as ColorObject; + //Get the saturation of color, read only + float saturation = colorObject.GetSaturation(); + //Save the presentation + presentation.Save("Output.pptx"); + //close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add shape to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Dodecagon, 234, 23, 120, 100) + 'Set the fill type of shape + shape.Fill.FillType = FillType.Pattern + 'Set the back color of the pattern fill + shape.Fill.PatternFill.BackColor = ColorObject.LightBlue + 'Create an instance for color object + Dim colorObject As ColorObject = TryCast(shape.Fill.PatternFill.BackColor, ColorObject) + 'Get the saturation of color, it is read only + Dim saturation As Single = colorObject.GetSaturation() + 'Save the presentation + presentation.Save("Output.pptx") + 'close the presentation + presentation.Close() + + + + + + Gets the 32-bit ARGB value of this structure. + + The 32-bit Argb value of this color. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add shape to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Dodecagon, 234, 23, 120, 100); + //Set the fill type of shape + shape.Fill.FillType = FillType.Pattern; + //Set the back color of the pattern fill + shape.Fill.PatternFill.BackColor = ColorObject.Red; + //Create an instance for color object + ColorObject colorObject = shape.Fill.PatternFill.BackColor as ColorObject; + //Convert to the argb value + int argb = colorObject.ToArgb(); + //Save the presentation + presentation.Save("Output.pptx"); + //close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add shape to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Dodecagon, 234, 23, 120, 100) + 'Set the fill type of shape + shape.Fill.FillType = FillType.Pattern + 'Set the back color of the pattern fill + shape.Fill.PatternFill.BackColor = ColorObject.Red + 'Create an instance for color object + Dim colorObject As ColorObject = TryCast(shape.Fill.PatternFill.BackColor, ColorObject) + 'Convert to the argb value + Dim argb As Integer = colorObject.ToArgb() + 'Save the presentation + presentation.Save("Output.pptx") + 'close the presentation + presentation.Close() + + + + + + Gets the value of the structure. + + An element of the enumeration. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add shape to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Dodecagon, 234, 23, 120, 100); + //Set the fill type of shape + shape.Fill.FillType = FillType.Pattern; + //Set the pattern type + shape.Fill.PatternFill.Pattern = PatternFillType.DarkDownwardDiagonal; + //Set the back color of the pattern fill + shape.Fill.PatternFill.BackColor = ColorObject.Red; + //Create an instance for color object + ColorObject colorObject = shape.Fill.PatternFill.BackColor as ColorObject; + //Convert to known color + System.Drawing.KnownColor knownColor = colorObject.ToKnownColor(); + //Save the presentation + presentation.Save("Output.pptx"); + //close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add shape to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Dodecagon, 234, 23, 120, 100) + 'Set the fill type of shape + shape.Fill.FillType = FillType.Pattern + 'Set the pattern type + shape.Fill.PatternFill.Pattern = PatternFillType.DarkDownwardDiagonal + 'Set the back color of the pattern fill + shape.Fill.PatternFill.BackColor = ColorObject.Red + 'Create an instance for color object + Dim colorObject As ColorObject = TryCast(shape.Fill.PatternFill.BackColor, ColorObject) + 'Convert to known color + Dim knownColor As System.Drawing.KnownColor = colorObject.ToKnownColor() + 'Save the presentation + presentation.Save("Output.pptx") + 'close the presentation + presentation.Close() + + + + + + Gets a predefined object that has an ARGB value of #FFF0F8FF. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFAEBD7. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF00FFFF. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF7FFFD4. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFF0FFFF. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFF5F5DC. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFE4C4. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF000000. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFEBCD. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF0000FF. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF8A2BE2. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFA52A2A. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFDEB887. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF5F9EA0. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF7FFF00. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFD2691E. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFF7F50. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF6495ED. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFF8DC. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFDC143C. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF00FFFF. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF00008B. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF008B8B. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFB8860B. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFA9A9A9. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF006400. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFBDB76B. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF8B008B. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF556B2F. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFF8C00. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF9932CC. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF8B0000. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFE9967A. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF8FBC8F. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF483D8B. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF2F4F4F. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF00CED1. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF9400D3. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFF1493. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF00BFFF. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF696969. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF1E90FF. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFB22222. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFFAF0. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF228B22. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFF00FF. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFDCDCDC. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFF8F8FF. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFD700. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFDAA520. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF808080. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF008000. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFADFF2F. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFF0FFF0. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFF69B4. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFCD5C5C. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF4B0082. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFFFF0. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFF0E68C. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFE6E6FA. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFF0F5. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF7CFC00. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFFACD. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFADD8E6. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFF08080. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFE0FFFF. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFAFAD2. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFD3D3D3. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF90EE90. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFB6C1. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFA07A. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF20B2AA. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF87CEFA. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF778899. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFB0C4DE. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFFFE0. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF00FF00. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF32CD32. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFAF0E6. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFF00FF. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF800000. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF66CDAA. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF0000CD. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFBA55D3. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF9370DB. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF3CB371. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF7B68EE. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF00FA9A. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF48D1CC. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFC71585. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF191970. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFF5FFFA. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFE4E1. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFE4B5. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFDEAD. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF000080. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFDF5E6. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF808000. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF6B8E23. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFA500. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFF4500. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFDA70D6. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFEEE8AA. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF98FB98. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFAFEEEE. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFDB7093. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFEFD5. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFDAB9. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFCD853F. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFC0CB. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFDDA0DD. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFB0E0E6. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF800080. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFF0000. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFBC8F8F. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF4169E1. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF8B4513. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFA8072. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFF4A460. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF2E8B57. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFF5EE. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFA0522D. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFC0C0C0. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF87CEEB. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF6A5ACD. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF708090. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFFAFA. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF00FF7F. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF4682B4. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFD2B48C. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF008080. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFD8BFD8. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFF6347. Read-only. + + + + + Gets a predefined transparent color. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF40E0D0. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFEE82EE. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFF5DEB3. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFFFFF. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFF5F5F5. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FFFFFF00. Read-only. + + + + + Gets a predefined object that has an ARGB value of #FF9ACD32. Read-only. + + + + + Returns ThemeColorValue of the current color object. + + + + + Gets the alpha color value. Read-only. + + + + + Gets the blue color value. Read-only. + + + + + Gets the green color value. Read-only. + + + + + Specifies whether this structure is uninitialized. Read-only. + + + + + Gets a value indicating whether the color object is a predefined color. Predefined colors are represented by the enumeration. Read-only. + + + + + Gets a value indicating whether the color object is a named color or a member of the enumeration. Read-only. + + + + + Gets a value indicating whether the color object is a system color. System colors are represented by elements of the enumeration. Read-only. + + + + + Gets the red color value. Read-only. + + + + + Gets or sets a value. + + + + + Parse the hyperlink. + + + + + + + + Gets the color map values from layout slide + + The XML Reader + The layout slide + + + + + Gets the color map values from layout slide + + The XML Reader + ColorObject instance to hold color values + The layout slide + + + + + Parse the scrgb color values. + + XML reader used to parse. + ColorObject instance to hold color value + + + + Gets the scheme color of layout slide + + The XML Reader + ColorObject instance to hold color value + The layout slide + + + + Compares the current EffectList object with given EffectList object. + + The EffectList object to compare with the current instance. + True if the EffectList objects are equal; otherwise, false. + + + + Compares the current EffectStyle object with given EffectStyle object. + + The EffectStyle object to compare with the current instance. + True if the EffectStyle objects are equal; otherwise, false. + + + + Specifies the type of the connector + + + + + Specifies the connector type is Straight line connector. + + + + + Specifies the connector type is Elbow connector. + + + + + Specifies the connector type is Curved connector. + + + + + Specifies the length of the arrowhead at the end of a line. + + + + + Specifies the ArrowheadLength is None + + + + + Specifies the ArrowheadLength is Short + + + + + Specifies the ArrowheadLength is Medium + + + + + Specifies the ArrowheadLength is Long + + + + + Specifies the style of the arrowhead at the end of a line. + + + + + Specifies the ArrowheadStyle is None + + + + + Specifies the ArrowheadStyle is Arrow + + + + + Specifies the ArrowheadStyle is ArrowStealth + + + + + Specifies the ArrowheadStyle is ArrowDiamond + + + + + Specifies the ArrowheadStyle is ArrowOval + + + + + Specifies the ArrowheadStyle is ArrowOpen + + + + + Specifies the width of the arrowhead at the end of a line. + + + + + Specifies the ArrowheadWidth is None + + + + + Specifies the ArrowheadWidth is Narrow + + + + + Specifies the ArrowheadWidth is Medium + + + + + Specifies the ArrowheadWidth is Wide + + + + + Specifies the shape type for an object. + + + + + Specifies the AutoShapeType is Unknown + + + + + Specifies the AutoShapeType is SwooshArrow + + + + + Specifies the AutoShapeType is Line + + + + + Specifies the AutoShapeType is ElbowConnector + + + + + Specifies the AutoShapeType is CurvedConnector + + + + + Specifies the AutoShapeType is BentConnector2 + + + + + Specifies the AutoShapeType is StraightConnector + + + + + Specifies the AutoShapeType is BentConnector4 + + + + + Specifies the AutoShapeType is BentConnector5 + + + + + Specifies the AutoShapeType is CurvedConnector2 + + + + + Specifies the AutoShapeType is CurvedConnector4 + + + + + Specifies the AutoShapeType is CurvedConnector5 + + + + + Specifies the AutoShapeType is Rectangle + + + + + Specifies the AutoShapeType is RoundedRectangle + + + + + Specifies the AutoShapeType is SnipSingleCornerRectangle + + + + + Specifies the AutoShapeType is SnipSameSideCornerRectangle + + + + + Specifies the AutoShapeType is SnipDiagonalCornerRectangle + + + + + Specifies the AutoShapeType is SnipAndRoundSingleCornerRectangle + + + + + Specifies the AutoShapeType is RoundSingleCornerRectangle + + + + + Specifies the AutoShapeType is RoundSameSideCornerRectangle + + + + + Specifies the AutoShapeType is RoundDiagonalCornerRectangle + + + + + Specifies the AutoShapeType is Oval + + + + + Specifies the AutoShapeType is IsoscelesTriangle + + + + + Specifies the AutoShapeType is RightTriangle + + + + + Specifies the AutoShapeType is Parallelogram + + + + + Specifies the AutoShapeType is Trapezoid + + + + + Specifies the AutoShapeType is Diamond + + + + + Specifies the AutoShapeType is RegularPentagon + + + + + Specifies the AutoShapeType is Hexagon + + + + + Specifies the AutoShapeType is Heptagon + + + + + Specifies the AutoShapeType is Octagon + + + + + Specifies the AutoShapeType is Decagon + + + + + Specifies the AutoShapeType is Dodecagon + + + + + Specifies the AutoShapeType is Pie + + + + + Specifies the AutoShapeType is Chord + + + + + Specifies the AutoShapeType is Teardrop + + + + + Specifies the AutoShapeType is Frame + + + + + Specifies the AutoShapeType is HalfFrame + + + + + Specifies the AutoShapeType is diagonalstripe + + + + + Specifies the AutoShapeType is Cross + + + + + Specifies the AutoShapeType is Plaque + + + + + Specifies the AutoShapeType is Can + + + + + Specifies the AutoShapeType is Cube + + + + + Specifies the AutoShapeType is Bevel + + + + + Specifies the AutoShapeType is Donut + + + + + Specifies the AutoShapeType is NoSymbol + + + + + Specifies the AutoShapeType is BlockArc + + + + + Specifies the AutoShapeType is FoldedCorner + + + + + Specifies the AutoShapeType is SmileyFace + + + + + Specifies the AutoShapeType is Heart + + + + + Specifies the AutoShapeType is LightningBolt + + + + + Specifies the AutoShapeType is Sun + + + + + Specifies the AutoShapeType is Moon + + + + + Specifies the AutoShapeType is Cloud + + + + + Specifies the AutoShapeType is Arc + + + + + Specifies the AutoShapeType is DoubleBracket + + + + + Specifies the AutoShapeType is DoubleBrace + + + + + Specifies the AutoShapeType is LeftBracket + + + + + Specifies the AutoShapeType is RightBracket + + + + + Specifies the AutoShapeType is LeftBrace + + + + + Specifies the AutoShapeType is RightBrace + + + + + Specifies the AutoShapeType is RightArrow + + + + + Specifies the AutoShapeType is LeftArrow + + + + + Specifies the AutoShapeType is UpArrow + + + + + Specifies the AutoShapeType is DownArrow + + + + + Specifies the AutoShapeType is LeftRightArrow + + + + + Specifies the AutoShapeType is UpDownArrow + + + + + Specifies the AutoShapeType is QuadArrow + + + + + Specifies the AutoShapeType is LeftRightUpArrow + + + + + Specifies the AutoShapeType is BentArrow + + + + + Specifies the AutoShapeType is UTurnArrow + + + + + Specifies the AutoShapeType is LeftUpArrow + + + + + Specifies the AutoShapeType is BentUpArrow + + + + + Specifies the AutoShapeType is curved right arrow + + + + + Specifies the AutoShapeType is curved left arrow + + + + + Specifies the AutoShapeType is curved up arrow + + + + + Specifies the AutoShapeType is curved down arrow + + + + + Specifies the AutoShapeType is striped right arrow + + + + + Specifies the AutoShapeType is notched right arrow + + + + + Specifies the AutoShapeType is pentagon + + + + + Specifies the AutoShapeType is chevron + + + + + Specifies the AutoShapeType is right arrow callout + + + + + Specifies the AutoShapeType is Down arrow callout + + + + + Specifies the AutoShapeType is left arrow callout + + + + + Specifies the AutoShapeType is up arrow callout + + + + + Specifies the AutoShapeType is left right arrow callout + + + + + Specifies the AutoShapeType is up down arrow callout + + + + + Specifies the AutoShapeType is quad arrow callout + + + + + Specifies the AutoShapeType is circular arrow + + + + + Specifies the AutoShapeType is math plus + + + + + Specifies the AutoShapeType is math minus + + + + + Specifies the AutoShapeType is math multiply + + + + + Specifies the AutoShapeType is math division + + + + + Specifies the AutoShapeType is math equal + + + + + Specifies the AutoShapeType is math not equal + + + + + Specifies the AutoShapeType is flow chart process + + + + + Specifies the AutoShapeType is flow chart alternate process + + + + + Specifies the AutoShapeType is flow chart decision + + + + + Specifies the AutoShapeType is flow chart data + + + + + Specifies the AutoShapeType is flow chart predefined process + + + + + Specifies the AutoShapeType is flow chart internal storage + + + + + Specifies the AutoShapeType is flow chart document + + + + + Specifies the AutoShapeType is flow chart multi document + + + + + Specifies the AutoShapeType is flow chart terminator + + + + + Specifies the AutoShapeType is flow chart preparation + + + + + Specifies the AutoShapeType is flow chart manual input + + + + + Specifies the AutoShapeType is flow chart manual operation + + + + + Specifies the AutoShapeType is flow chart connector + + + + + Specifies the AutoShapeType is flow chart off page connector + + + + + Specifies the AutoShapeType is flow chart card + + + + + Specifies the AutoShapeType is flow chart punched tape + + + + + Specifies the AutoShapeType is flow chart summing junction + + + + + Specifies the AutoShapeType is flow chart or + + + + + Specifies the AutoShapeType is flow chart collate + + + + + Specifies the AutoShapeType is flow chart sort + + + + + Specifies the AutoShapeType is flow chart extract + + + + + Specifies the AutoShapeType is flow chart merge + + + + + Specifies the AutoShapeType is flow chart stored data + + + + + Specifies the AutoShapeType is flow chart delay + + + + + Specifies the AutoShapeType is flow chart sequential access storage + + + + + Specifies the AutoShapeType is flow chart magnetic disk + + + + + Specifies the AutoShapeType is flow chart direct access storage + + + + + Specifies the AutoShapeType is flow chart display + + + + + Specifies the AutoShapeType is explosion1 + + + + + Specifies the AutoShapeType is explosion2 + + + + + Specifies the AutoShapeType is star4 point + + + + + Specifies the AutoShapeType is star5 point + + + + + Specifies the AutoShapeType is star6 point + + + + + Specifies the AutoShapeType is star7 point + + + + + Specifies the AutoShapeType is star8 point + + + + + Specifies the AutoShapeType is star10 point + + + + + Specifies the AutoShapeType is star12 point + + + + + Specifies the AutoShapeType is Star16Point + + + + + Specifies the AutoShapeType is star24 point + + + + + Specifies the AutoShapeType is star32 point + + + + + Specifies the AutoShapeType is Up ribbon + + + + + Specifies the AutoShapeType is Down ribbon + + + + + Specifies the AutoShapeType is curved up ribbon + + + + + Specifies the AutoShapeType is curved down ribbon + + + + + Specifies the AutoShapeType is vertical scroll + + + + + Specifies the AutoShapeType is horizontal scroll + + + + + Specifies the AutoShapeType is wave + + + + + Specifies the AutoShapeType is double wave + + + + + Specifies the AutoShapeType is rectangular callout + + + + + Specifies the AutoShapeType is rounded rectangular callout + + + + + Specifies the AutoShapeType is oval callout + + + + + Specifies the AutoShapeType is cloud callout + + + + + Specifies the AutoShapeType is line callout1 + + + + + Specifies the AutoShapeType is line callout2 + + + + + Specifies the AutoShapeType is line callout3 + + + + + Specifies the AutoShapeType is line callout1 accent bar + + + + + Specifies the AutoShapeType is line callout2 accent bar + + + + + Specifies the AutoShapeType is line callout3 accent bar + + + + + Specifies the AutoShapeType is line callout1 no border + + + + + Specifies the AutoShapeType is line callout2 no border + + + + + Specifies the AutoShapeType is line callout3 no border + + + + + Specifies the AutoShapeType is line callout1 border and accent bar + + + + + Specifies the AutoShapeType is line callout2 border and accent bar + + + + + Specifies the AutoShapeType is line callout3 border and accent bar + + + + + Specifies the AutoShapeType is l_shape + + + + + Specifies the AutoShapeType is Pie Wedge + + + + + Specifies the AutoShapeType is Left Right Ribbon + + + + + Specifies the AutoShapeType is Funnel + + + + + Specifies the AutoShapeType is Gear6 + + + + + Specifies the AutoShapeType is Gear9 + + + + + Specifies the AutoShapeType is Left circular arrow + + + + + Specifies the BackgroundStyle for Slides. + + + + + Specifies the BackgroundStyle for Slides is Style1. + + + + + Specifies the BackgroundStyle for Slides is Style2. + + + + + Specifies the BackgroundStyle for Slides is Style3. + + + + + Specifies the BackgroundStyle for Slides is Style4. + + + + + Specifies the BackgroundStyle for Slides is Style5. + + + + + Specifies the BackgroundStyle for Slides is Style6. + + + + + Specifies the BackgroundStyle for Slides is Style7. + + + + + Specifies the BackgroundStyle for Slides is Style8. + + + + + Specifies the BackgroundStyle for Slides is Style9. + + + + + Specifies the BackgroundStyle for Slides is Style10. + + + + + Specifies the BackgroundStyle for Slides is Style11. + + + + + Specifies the BackgroundStyle for Slides is Style12. + + + + + Specifies the ColorType. + + + + + Specifies the ColorType is automatic. + + + + + Specifies the ColorType is automatic index. + + + + + Specifies the ColorType is RGB. + + + + + Specifies the ColorType is indexed color. + + + + + Specifies the PatternFillType is theme. + + + + + Specifies the pattern fill type for an object. + + + + + Specifies the PatternFillType is solid. + + + + + Specifies the PatternFillType is gray5. + + + + + Specifies the PatternFillType is gray10. + + + + + Specifies the PatternFillType is gray20. + + + + + Specifies the PatternFillType is gray30. + + + + + Specifies the PatternFillType is gray40. + + + + + Specifies the PatternFillType is gray50. + + + + + Specifies the PatternFillType is gray60. + + + + + Specifies the PatternFillType is gray70. + + + + + Specifies the PatternFillType is gray75. + + + + + Specifies the PatternFillType is gray80. + + + + + Specifies the PatternFillType is gray90. + + + + + Specifies the PatternFillType is gray25. + + + + + Specifies the PatternFillType is cross. + + + + + Specifies the PatternFillType is diagonal cross. + + + + + Specifies the PatternFillType is downward diagonal. + + + + + Specifies the PatternFillType is horizontal. + + + + + Specifies the PatternFillType is upward diagonal. + + + + + Specifies the PatternFillType is vertical. + + + + + Specifies the PatternFillType is light downward diagonal. + + + + + Specifies the PatternFillType is light upward diagonal. + + + + + Specifies the PatternFillType is dark downward diagonal. + + + + + Specifies the PatternFillType is dark upward diagonal. + + + + + Specifies the PatternFillType is wide downward diagonal. + + + + + Specifies the PatternFillType is wide upward diagonal. + + + + + Specifies the PatternFillType is light vertical. + + + + + Specifies the PatternFillType is light horizontal. + + + + + Specifies the PatternFillType is narrow vertical. + + + + + Specifies the PatternFillType is narrow horizontal. + + + + + Specifies the PatternFillType is dark vertical. + + + + + Specifies the PatternFillType is dark horizontal. + + + + + Specifies the PatternFillType is dashed downward diagonal. + + + + + Specifies the PatternFillType is dashed upward diagonal. + + + + + Specifies the PatternFillType is dashed vertical. + + + + + Specifies the PatternFillType is dashed horizontal. + + + + + Specifies the PatternFillType is small confetti. + + + + + Specifies the PatternFillType is large confetti. + + + + + Specifies the PatternFillType is zig zag. + + + + + Specifies the PatternFillType is wave. + + + + + Specifies the PatternFillType is diagonal brick. + + + + + Specifies the PatternFillType is horizontal brick. + + + + + Specifies the PatternFillType is weave. + + + + + Specifies the PatternFillType is plaid. + + + + + Specifies the PatternFillType is divot. + + + + + Specifies the PatternFillType is dotted grid. + + + + + Specifies the PatternFillType is dotted diamond. + + + + + Specifies the PatternFillType is shingle. + + + + + Specifies the PatternFillType is trellis. + + + + + Specifies the PatternFillType is sphere. + + + + + Specifies the PatternFillType is small grid. + + + + + Specifies the PatternFillType is large grid. + + + + + Specifies the PatternFillType is small checker board. + + + + + Specifies the PatternFillType is large checker board. + + + + + Specifies the PatternFillType is outlined diamond. + + + + + Specifies the PatternFillType is solid diamond. + + + + + Specifies the fill type of an object. + + + + + Specifies the FillType is automatic. + + + + + Specifies the FillType is solid. + + + + + Specifies the FillType is gradient. + + + + + Specifies the FillType is Picture. + + + + + Specifies the FillType is Texture. + + + + + Specifies the FillType is pattern. + + + + + Specifies the FillType is none. + + + + + Specifies the FontAlignmentType. + + + + + Specifies the FontAlignmentType is none. + + + + + Specifies the FontAlignmentType is baseline. + + + + + Specifies the FontAlignmentType is bottom. + + + + + Specifies the FontAlignmentType is top. + + + + + Specifies the FontAlignmentType is center. + + + + + Specifies the style of line cap at the line end. + + + + + Specifies the LineCapStyle is none. + + + + + Specifies the LineCapStyle is round. + + + + + Specifies the LineCapStyle is square. + + + + + Specifies the LineCapStyle is flat. + + + + + Specifies the dash style for a line. + + + + + Specifies the LineDashStyle is none. + + + + + Specifies the LineDashStyle is solid. + + + + + Specifies the LineDashStyle is dash. + + + + + Specifies the LineDashStyle is dash dot. + + + + + Specifies the LineDashStyle is dash dot dot. + + + + + Specifies the LineDashStyle is dash long dash. + + + + + Specifies the LineDashStyle is dash long dash dot. + + + + + Specifies the LineDashStyle is round dot. + + + + + Specifies the LineDashStyle is square dot. + + + + + Specifies the LineDashStyle is system dash dot. + + + + + Specifies the LineDashStyle is dot. + + + + + Specifies the type of join where two lines connects. + + + + + Specifies the LineJoinType is none. + + + + + Specifies the LineJoinType is miter. + + + + + Specifies the LineJoinType is round. + + + + + Specifies the LineJoinType is bevel. + + + + + Specifies the style for a line. + + + + + Specifies the LineStyle is single. + + + + + Specifies the LineStyle is thick between thin. + + + + + Specifies the LineStyle is thin thick. + + + + + Specifies the LineStyle is thick thin. + + + + + Specifies the LineStyle is thin thin. + + + + + Specifies the MirrorType. + + + + + + Specifies the MirrorType is none. + + + + + Specifies the MirrorType is horizonal. + + + + + Specifies the MirrorType is vertical. + + + + + Specifies the MirrorType is both. + + + + + Specifies the PenAlignmentType. + + + + + Specifies the PenAlignmentType is center. + + + + + Specifies the PenAlignmentType is In. + + + + + Specifies the predefined size types for the PlaceHolder object + + + + + Specifies the PlaceholderSize is none. + + + + + Specifies the PlaceholderSize is full. + + + + + Specifies the PlaceholderSize is half. + + + + + Specifies the PlaceholderSize is quarter. + + + + + Specifies the type of the ole object field. + + + + + Ole object field type is EMBED. + + + + + Ole object field type is LINK. + + + + + Specifies the type of OLE object. + + + + + Type is not defined. + + + + + Adobe Acrobat Document. File has ".pdf" extension. + + + + + Bitmap Image. File has ".png" extension. + + + + + Media Clip. + + + + + Equation. + + + + + Graph Chart. + + + + + Excel 97-2003 Worksheet. File has ".xls" extension. + + + + + Excel Binary Worksheet. File has ".xlsb" extension. + + + + + Excel chart. File has ".xls" extension. + + + + + Excel Macro-Enabled Worksheet. File has ".xlsm" extension. + + + + + Excel Worksheet. File has ".xlsx" extension. + + + + + PowerPoint 97-2003 Presentation. File has ".ppt" extension. + + + + + PowerPoint 97-2003 Slide. File has ".sld" extension. + + + + + PowerPoint Macro-Enabled Presentation. File has ".pptm" extension. + + + + + PowerPoint Macro-Enabled Slide. File has ".sldm" extension. + + + + + PowerPoint Presentation. File has ".pptx" extension. + + + + + PowerPoint Slide. File has ".sldx" extension. + + + + + Word 97-2003 Document. File has ".doc" extension. + + + + + Word Document. File has ".docx" extension. + + + + + Word Macro-Enabled Document. File has ".docm" extension. + + + + + Visio Deawing. + + + + + MIDI Sequence. + + + + + OpenDocument Presentation. + + + + + OpenDocument Spreadsheet. + + + + + OpenDocument Text. + + + + + OpenOffice.org 1.1 Spreadsheet. + + + + + OpenOffice.org 1.1 Text. + + + + + Package. + + + + + Video Clip. + + + + + Wave Sound. + + + + + WordPad Document. + + + + + OpenOffice spreadsheet. + + + + + OpenOffice Text. + + + + + Specifies the horizontal alignment for the rectangle. + + + + + Specifies the RectangleAlignmentType is bottom. + + + + + Specifies the RectangleAlignmentType is bottom left. + + + + + Specifies the RectangleAlignmentType is bottom right. + + + + + Specifies the RectangleAlignmentType is center. + + + + + Specifies the RectangleAlignmentType is left. + + + + + Specifies the RectangleAlignmentType is right. + + + + + Specifies the RectangleAlignmentType is top. + + + + + Specifies the RectangleAlignmentType is top left. + + + + + Specifies the RectangleAlignmentType is top right. + + + + + Specifies the horizontal alignment of the text. + + + + + Specifies the HorizontalAlignmentType is none. + + + + + Specifies the HorizontalAlignmentType is left. + + + + + Specifies the HorizontalAlignmentType is center. + + + + + Specifies the HorizontalAlignmentType is right. + + + + + Specifies the HorizontalAlignmentType is justify. + + + + + Specifies the HorizontalAlignmentType is distributed. + + + + + Specifies the HorizontalAlignment. + + + + + + Specifies the HorizontalAlignment is none. + + + + + Specifies the HorizontalAlignment is left. + + + + + Specifies the HorizontalAlignment is center. + + + + + Specifies the HorizontalAlignment is right. + + + + + Specifies the HorizontalAlignment is justify. + + + + + Specifies the HorizontalAlignment is distributed. + + + + + Specifies the HorizontalAlignment is justify low. + + + + + Specifies the HorizontalAlignment is Thai Distributed. + + + + + Specifies the vertical alignment of the text. + + + + + Specifies the VerticalAlignmentType is none. + + + + + Specifies the VerticalAlignmentType is top. + + + + + Specifies the VerticalAlignmentType is middle. + + + + + Specifies the VerticalAlignmentType is bottom. + + + + + Specifies the VerticalAlignmentType is none. + + + + + Specifies the VerticalAlignmentType is top. + + + + + Specifies the VerticalAlignmentType is middle. + + + + + Specifies the VerticalAlignmentType is bottom. + + + + + Specifies the VerticalAlignmentType is justify. + + + + + Specifies the VerticalAlignmentType is distributed. + + + + + Specifies the TabAlignmentType. + + + + + Specifies the TabAlignmentType is none. + + + + + Specifies the TabAlignmentType is left. + + + + + Specifies the TabAlignmentType is center. + + + + + Specifies the TabAlignmentType is right. + + + + + Specifies the TabAlignmentType is decimal. + + + + + Specifies the TextCap types. + + + + + Specifies the TextCapsType is none. + + + + + Specifies the TextCapsType is small. + + + + + Specifies the TextCapsType is All. + + + + + Specifies the TextOrientationType. + + + + + Specifies the TextOrientationType is no rotation. + + + + + Specifies the TextOrientationType is clock wise. + + + + + Specifies the TextOrientationType is counter clock wise. + + + + + Specifies the TextOrientationType is top to bottom. + + + + + Specifies the TextOverflowType. + + + + + Specifies the TextOverflowType is None. + + + + + Specifies the TextOverflowType is clip. + + + + + Specifies the TextOverflowType is ellipsis. + + + + + Specifies the TextOverflowType is overflow. + + + + + Specifies the types of strike through options applied for text. + + + + + Specifies the TextStrikethroughType is none. + + + + + Specifies the TextStrikethroughType is single. + + + + + Specifies the TextStrikethroughType is double. + + + + + Specifies the types of underline options applied to the text. + + + + + Specifies the TextUnderlineType is none. + + + + + Specifies the TextUnderlineType is single. + + + + + Specifies the TextUnderlineType is double. + + + + + Specifies the TextUnderlineType is dash. + + + + + Specifies the TextUnderlineType is dash dot dot heavy. + + + + + Specifies the TextUnderlineType is dash dot heavy. + + + + + Specifies the TextUnderlineType is dashed heavy. + + + + + Specifies the TextUnderlineType is dash long. + + + + + Specifies the TextUnderlineType is dash long heavy. + + + + + Specifies the TextUnderlineType is dot dash. + + + + + Specifies the TextUnderlineType is dot dot dash. + + + + + Specifies the TextUnderlineType is dotted. + + + + + Specifies the TextUnderlineType is dotted heavy. + + + + + Specifies the TextUnderlineType is heavy. + + + + + Specifies the TextUnderlineType is wave. + + + + + Specifies the TextUnderlineType is wavy double. + + + + + Specifies the TextUnderlineType is wavy heavy. + + + + + Specifies the type of underline for text + + + + + Specifies the TextUnderlineType is none. + + + + + Specifies the TextUnderlineType is single. + + + + + Specifies the TextUnderlineType is double. + + + + + Specifies the TextUnderlineType is dash. + + + + + Specifies the TextUnderlineType is dash dot dot heavy. + + + + + Specifies the TextUnderlineType is dash dot heavy. + + + + + Specifies the TextUnderlineType is dashed heavy. + + + + + Specifies the TextUnderlineType is dash long. + + + + + Specifies the TextUnderlineType is dash long heavy. + + + + + Specifies the TextUnderlineType is dot dash. + + + + + Specifies the TextUnderlineType is dot dot dash. + + + + + Specifies the TextUnderlineType is dotted. + + + + + Specifies the TextUnderlineType is dotted heavy. + + + + + Specifies the TextUnderlineType is heavy. + + + + + Specifies the TextUnderlineType is wave. + + + + + Specifies the TextUnderlineType is wavy double. + + + + + Specifies the TextUnderlineType is wavy heavy. + + + + + Specifies the TextUnderlineType is words. + + + + + Specifies the predefined types of TextureFill. + + + + + Specifies the TextureFillType is blue tissue paper. + + + + + Specifies the TextureFillType is bouquet. + + + + + Specifies the TextureFillType is brown marble. + + + + + Specifies the TextureFillType is canvas. + + + + + Specifies the TextureFillType is cork. + + + + + Specifies the TextureFillType is denim. + + + + + Specifies the TextureFillType is fish fossil. + + + + + Specifies the TextureFillType is granite. + + + + + Specifies the TextureFillType is green marble. + + + + + Specifies the TextureFillType is medium wood. + + + + + Specifies the TextureFillType is newsprint. + + + + + Specifies the TextureFillType is oak. + + + + + Specifies the TextureFillType is paper bag. + + + + + Specifies the TextureFillType is papyrus. + + + + + Specifies the TextureFillType is parchment. + + + + + Specifies the TextureFillType is pink tissue paper. + + + + + Specifies the TextureFillType is purple mesh. + + + + + Specifies the TextureFillType is recycled paper. + + + + + Specifies the TextureFillType is sand. + + + + + Specifies the TextureFillType is stationery. + + + + + Specifies the TextureFillType is walnut. + + + + + Specifies the TextureFillType is water droplets. + + + + + Specifies the TextureFillType is white marble. + + + + + Specifies the TextureFillType is woven mat. + + + + + Specifies the TextureFillType is unknown. + + + + + Specifies the type of text direction. + + + + + Specifies the TextDirectionType is horizontal. + + + + + Specifies the TextDirectionType is vertical. + + + + + Specifies the TextDirectionType is vertical270. + + + + + Specifies the TextDirectionType is word art vertical. + + + + + Specifies the TextDirection. + + + + + Specifies the TextDirection is horizontal. + + + + + Specifies the TextDirection is vertical. + + + + + Specifies the TextDirection is vertical270. + + + + + Specifies the TextDirection is word art vertical. + + + + + Specifies the TextDirection is east asian vertical. + + + + + Specifies the TextDirection is mongolian vertical. + + + + + Specifies the TextDirection is word art right to left. + + + + + Specifies the Black White Mode. + + + + + Specifies the Black White Mode is none. + + + + + Specifies the Black White Mode is clear. + + + + + Specifies the Black White Mode is automatic. + + + + + Specifies the Black White Mode is gray. + + + + + Specifies the Black White Mode is light gray. + + + + + Specifies the Black White Mode is inverse gray. + + + + + Specifies the Black White Mode is gray white. + + + + + Specifies the Black White Mode is black gray. + + + + + Specifies the Black White Mode is black white. + + + + + Specifies the Black White Mode is black. + + + + + Specifies the Black White Mode is white. + + + + + Specifies the Black White Mode is hidden. + + + + + Specifies the ColorMode. + + + + + Specifies the ColorMode is tint. + + + + + Specifies the ColorMode is shade. + + + + + Specifies the ColorMode is alpha. + + + + + Specifies the ColorMode is alpha mod. + + + + + Specifies the ColorMode is alpha off. + + + + + Specifies the ColorMode is red. + + + + + Specifies the ColorMode is red mod. + + + + + Specifies the ColorMode is red off. + + + + + Specifies the ColorMode is green. + + + + + Specifies the ColorMode is green mod. + + + + + Specifies the ColorMode is green off. + + + + + Specifies the ColorMode is blue. + + + + + Specifies the ColorMode is blue mod. + + + + + Specifies the ColorMode is blue off. + + + + + Specifies the ColorMode is hue. + + + + + Specifies the ColorMode is hue mod. + + + + + Specifies the ColorMode is hue off. + + + + + Specifies the ColorMode is sat. + + + + + Specifies the ColorMode is sat mod. + + + + + Specifies the ColorMode is sat off. + + + + + Specifies the ColorMode is lum. + + + + + Specifies the ColorMode is lum mod. + + + + + Specifies the ColorMode is lum off. + + + + + Specifies the ColorMode is gamma. + + + + + Specifies the ColorMode is inv gamma. + + + + + Specifies the ColorMode is comp. + + + + + Specifies the ColorMode is gray. + + + + + Specifies the ColorMode is inv. + + + + + Specifies the Drawing types. + + + + + Specifies the Drawing types is none. + + + + + Specifies the Drawing types is TextBox. + + + + + Specifies the Drawing types is PlaceHolder. + + + + + Specifies the Drawing types is Table. + + + + + Specifies the Drawing types is Chart. + + + + + Specifies the Drawing type is SmartArt. + + + + + Specifies the Drawing type is OleObject. + + + + + Specifies the path shape types. + + + + + Specifies the path shape types is circle. + + + + + Specifies the path shape types is rectangle. + + + + + Specifies the path shape types is shape. + + + + + Specifies the shape types. + + + + + Specifies the shape types is Sp. + + + + + Specifies the shape types is GRP sp. + + + + + Specifies the shape types is graphic frame. + + + + + Specifies the shape types is CXN sp. + + + + + Specifies the shape types is pic. + + + + + Specifies the shape types is content part. + + + + + Specifies the shape types is alternate content. + + + + + Specifies the shape types is Chart. + + + + + Specifies the smart art point shape, which is exist in data.xml. Used only for smart art. + + + + + Specifies the smart art drawing shape, which is exist in drawing.xml. Used only for smart art. + + + + + Specifies the manner in which a path should be filled. + + + + + This specifies that the corresponding path should have a darker shaded color applied to it’s fill. + + + + + This specifies that the corresponding path should have a slightly darker shaded color applied to it’s fill. + + + + + This specifies that the corresponding path should have a lightly shaded color applied to it’s fill. + + + + + This specifies that the corresponding path should have a slightly lighter shaded color applied to it’s fill. + + + + + This specifies that the corresponding path should have no fill. + + + + + This specifies that the corresponding path should have a normally shaded color applied to it’s fill. + + + + + Represents the fill format options of the object. + + + A fill format can have a solid, gradient, pattern, texture type. + + + + + Gets or sets the of the object. + + + + //Open a presentation. + IPresentation presentation = Presentation.Open("Template.pptx"); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(); + //Get the fill of slide background + IFill fill = slide.Background.Fill; + //Set the fill type + fill.FillType = FillType.Solid; + //Set the fill color + fill.SolidFill.Color = ColorObject.Red; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add() + 'Get the fill of slide background + Dim fill As IFill = slide.Background.Fill + 'Set the fill type + fill.FillType = FillType.Solid + 'Set the fill color + fill.SolidFill.Color = ColorObject.Red + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets an instance. Read-only. + + + The gradient fill. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add shape to slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.BlockArc, 12, 23, 100, 220); + //Retrieve fill from shape + IFill fill = shape.Fill; + //Set gradient fill to the shape + fill.FillType = FillType.Gradient; + //Retrieve the gradient fill from the shape + IGradientFill gradientFill = fill.GradientFill; + //Add the first gradient stop. + gradientFill.GradientStops.Add(); + //Add the second gradient stop. + gradientFill.GradientStops.Add(); + //Save the presentation + presentation.Save("GradientFill.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add shape to slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.BlockArc, 12, 23, 100, 220) + 'Retrieve fill from shape + Dim fill As IFill = shape.Fill + 'Set gradient fill to the shape + fill.FillType = FillType.Gradient + 'Retrieve the gradient fill from the shape + Dim gradientFill As IGradientFill = fill.GradientFill + 'Add the first gradient stop. + gradientFill.GradientStops.Add() + 'Add the second gradient stop. + gradientFill.GradientStops.Add() + 'Save the presentation + presentation__1.Save("GradientFill.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets an instance. Read-only. + + + The pattern fill. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add shape to slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.BlockArc, 12, 23, 100, 220); + //Retrieve fill from shape + IFill fill = shape.Fill; + //Set pattern fill type to shape + fill.FillType = FillType.Pattern; + //Create instance to hold pattern fill properties + IPatternFill patternFill = fill.PatternFill; + //Set the pattern type + patternFill.Pattern = PatternFillType.DashedDownwardDiagonal; + //Set back color for the pattern + patternFill.BackColor = ColorObject.PaleGreen; + //Set fore color for the pattern + patternFill.ForeColor = ColorObject.Blue; + //Save the presentation + presentation.Save("PatternFill.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add shape to slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.BlockArc, 12, 23, 100, 220) + 'Retrieve fill from shape + Dim fill As IFill = shape.Fill + 'Set pattern fill type to shape + fill.FillType = FillType.Pattern + 'Create instance to hold pattern fill properties + Dim patternFill As IPatternFill = fill.PatternFill + 'Set the pattern type + patternFill.Pattern = PatternFillType.DashedDownwardDiagonal + 'Set back color for the pattern + patternFill.BackColor = ColorObject.PaleGreen + 'Set fore color for the pattern + patternFill.ForeColor = ColorObject.Blue + 'Save the presentation + presentation__1.Save("PatternFill.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets an instance. Read-only. + + + The solid fill. + + + + //Open a presentation. + IPresentation presentation = Presentation.Open("Template.pptx"); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(); + //Get the fill of slide background + IFill fill = slide.Background.Fill; + //Set the fill type + fill.FillType = FillType.Solid; + //Set the fill color + fill.SolidFill.Color = ColorObject.Red; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation. + Dim presentation__1 As IPresentation = Presentation.Open("Template.pptx") + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add() + 'Get the fill of slide background + Dim fill As IFill = slide.Background.Fill + 'Set the fill type + fill.FillType = FillType.Solid + 'Set the fill color + fill.SolidFill.Color = ColorObject.Red + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets an instance. Read-only. + + + The picture fill. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a shape to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.BlockArc, 12, 23, 100, 220); + //Retrieve fill from the shape + IFill fill = shape.Fill; + //Set the picture fill type to shape + fill.FillType = FillType.Picture; + //Create an instance to hold the picture fill properties + IPictureFill pictureFill = fill.PictureFill; + //Create a file stream and copy it to the memory stream + FileStream pictureStream = new FileStream("Image.png", FileMode.Open); + MemoryStream memoryStream = new MemoryStream(); + pictureStream.CopyTo(memoryStream); + //Convert the memory stream into a byte array + byte[] picBytes = memoryStream.ToArray(); + //Set Image Bytes + pictureFill.ImageBytes = picBytes; + //Save the presentation + presentation.Save("PictureFill.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a shape to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.BlockArc, 12, 23, 100, 220) + 'Retrieve fill from the shape + Dim fill As IFill = shape.Fill + 'Set the picture fill type to shape + fill.FillType = FillType.Picture + 'Create an instance to hold the picture fill properties + Dim pictureFill As IPictureFill = fill.PictureFill + 'Create a file stream and copy it to the memory stream + Dim pictureStream As FileStream = New FileStream("Image.png", FileMode.Open) + Dim memoryStream As MemoryStream = New MemoryStream() + pictureStream.CopyTo(memoryStream) + 'Convert the memory stream into a byte array + Dim picBytes As Byte() = memoryStream.ToArray() + 'Set Image Bytes + pictureFill.ImageBytes = picBytes + 'Save the presentation + presentation__1.Save("PictureFill.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Compares the current Fill object with given Fill object. + + The Fill object to compare with the current instance. + True if the Fill objects are equal; otherwise, false. + + + + Represents the gradient type fill format. + + + + + Gets the gradient stop collection. Read-only. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + slide.Background.Fill.FillType = FillType.Gradient; + //Retrieve the gradient fill from the shape + IGradientFill gradientFill = slide.Background.Fill.GradientFill; + //Add a gradient stop. + gradientFill.GradientStops.Add(); + //Retrieve gradient stops, it is read only + IGradientStops stops = gradientFill.GradientStops; + //Add gradient stop with color + stops.Add().Color = ColorObject.FromArgb(13, 34, 89, 32); + //Add gradient stop with position + stops.Add().Position = 3.5F; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + slide.Background.Fill.FillType = FillType.Gradient + 'Retrieve the gradient fill from the shape + Dim gradientFill As IGradientFill = slide.Background.Fill.GradientFill + 'Add a gradient stop. + gradientFill.GradientStops.Add() + 'Retrieve gradient stops, it is read only + Dim stops As IGradientStops = gradientFill.GradientStops + 'Add gradient stop with color + stops.Add().Color = ColorObject.FromArgb(13, 34, 89, 32) + 'Add gradient stop with position + stops.Add().Position = 3.5F + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Compares the current GradientFill object with given GradientFill object. + + The GradientFill object to compare with the current instance. + True if the GradientFill objects are equal; otherwise, false. + + + + Represents a gradient stop in the object. + + + + + Gets or sets the structure for the gradient stop. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient; + //Create instance for gradient stop - 1 + IGradientStop gradStop = slide.Background.Fill.GradientFill.GradientStops.Add(); + //Set position for gradient stop + gradStop.Position = 2.4F; + //Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(23, 156, 90); + //Create instance for gradient stop - 2 + IGradientStop _gradStop = slide.Background.Fill.GradientFill.GradientStops.Add(); + //Set position for gradient stop + _gradStop.Position = 5F; + //Set color for gradient stop + _gradStop.Color = ColorObject.FromArgb(20, 106, 120); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient + 'Create instance for gradient stop - 1 + Dim gradStop As IGradientStop = slide.Background.Fill.GradientFill.GradientStops.Add() + 'Set position for gradient stop + gradStop.Position = 2.4F + 'Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(23, 156, 90) + 'Create instance for gradient stop - 2 + Dim _gradStop As IGradientStop = slide.Background.Fill.GradientFill.GradientStops.Add() + 'Set position for gradient stop + _gradStop.Position = 5F + 'Set color for gradient stop + _gradStop.Color = ColorObject.FromArgb(20, 106, 120) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the gradient stop position. The position ranges from 0 to 100. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient; + //Create instance for gradient stop - 1 + IGradientStop gradStop = slide.Background.Fill.GradientFill.GradientStops.Add(); + //Set position for gradient stop + gradStop.Position = 2.4F; + //Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(23, 156, 90); + //Create instance for gradient stop - 2 + IGradientStop _gradStop = slide.Background.Fill.GradientFill.GradientStops.Add(); + //Set position for gradient stop + _gradStop.Position = 5F; + //Set color for gradient stop + _gradStop.Color = ColorObject.FromArgb(20, 106, 120); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient + 'Create instance for gradient stop - 1 + Dim gradStop As IGradientStop = slide.Background.Fill.GradientFill.GradientStops.Add() + 'Set position for gradient stop + gradStop.Position = 2.4F + 'Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(23, 156, 90) + 'Create instance for gradient stop - 2 + Dim _gradStop As IGradientStop = slide.Background.Fill.GradientFill.GradientStops.Add() + 'Set position for gradient stop + _gradStop.Position = 5F + 'Set color for gradient stop + _gradStop.Color = ColorObject.FromArgb(20, 106, 120) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the transparency of the gradient stop. + The value of the transparency ranges from 0 to 100. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient; + //Create instance for gradient stop - 1 + IGradientStop gradStop = slide.Background.Fill.GradientFill.GradientStops.Add(); + //Set position for gradient stop + gradStop.Position = 2.4F; + //Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(23, 156, 90); + //Set transparency of gradient stop + gradStop.Transparency = 57; + //Create instance for gradient stop - 2 + IGradientStop _gradStop = slide.Background.Fill.GradientFill.GradientStops.Add(); + //Set position for gradient stop + _gradStop.Position = 5F; + //Set color for gradient stop + _gradStop.Color = ColorObject.FromArgb(20, 106, 120); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient + 'Create instance for gradient stop - 1 + Dim gradStop As IGradientStop = slide.Background.Fill.GradientFill.GradientStops.Add() + 'Set position for gradient stop + gradStop.Position = 2.4F + 'Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(23, 156, 90) + 'Set transparency of gradient stop + gradStop.Transparency = 57 + 'Create instance for gradient stop - 2 + Dim _gradStop As IGradientStop = slide.Background.Fill.GradientFill.GradientStops.Add() + 'Set position for gradient stop + _gradStop.Position = 5F + 'Set color for gradient stop + _gradStop.Color = ColorObject.FromArgb(20, 106, 120) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the brightness of the gradient stop. Read-only. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient; + //Create instance for gradient stop - 1 + IGradientStop gradStop = slide.Background.Fill.GradientFill.GradientStops.Add(); + //Set position for gradient stop + gradStop.Position = 2.4F; + //Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(23, 156, 90); + //Create instance for gradient stop - 2 + IGradientStop _gradStop = slide.Background.Fill.GradientFill.GradientStops.Add(); + //Set position for gradient stop + _gradStop.Position = 5F; + //Set color for gradient stop + _gradStop.Color = ColorObject.FromArgb(20, 106, 120); + //Get the brightness of gradient stop - read only. + float brightness = _gradStop.Brightness; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient + 'Create instance for gradient stop - 1 + Dim gradStop As IGradientStop = slide.Background.Fill.GradientFill.GradientStops.Add() + 'Set position for gradient stop + gradStop.Position = 2.4F + 'Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(23, 156, 90) + 'Create instance for gradient stop - 2 + Dim _gradStop As IGradientStop = slide.Background.Fill.GradientFill.GradientStops.Add() + 'Set position for gradient stop + _gradStop.Position = 5F + 'Set color for gradient stop + _gradStop.Color = ColorObject.FromArgb(20, 106, 120) + 'Get the brightness of gradient stop - read only. + Dim brightness As Single = _gradStop.Brightness + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Compares the current GradientStop object with given GradientStop object. + + The GradientStop object to compare with the current instance. + True if the GradientStop objects are equal; otherwise, false. + + + + Represents a collection of instance. + + + + + Adds a gradient stop at the end of the collection. + + Minimum of 2 gradient stops must be added while using gradient type fill. + Returns the instance. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient; + //Create instance to hold all the gradient stop + IGradientStops gradientStops = slide.Background.Fill.GradientFill.GradientStops; + //Add a gradient stop to the gradient stops collection + gradientStops.Add(); + //Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.Blue, 1.1F); + //Gets a single gradient stop from the collection + IGradientStop gradStop = gradientStops[0]; + //Set position for gradient stop + gradStop.Position = 2.4F; + //Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(23, 156, 90); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient + 'Create instance to hold all the gradient stop + Dim gradientStops As IGradientStops = slide.Background.Fill.GradientFill.GradientStops + 'Add a gradient stop to the gradient stops collection + gradientStops.Add() + 'Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.Crimson, 1.1F) + 'Gets a single gradient stop from the collection + Dim gradStop As IGradientStop = gradientStops(0) + 'Set position for gradient stop + gradStop.Position = 2.4F + 'Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(23, 156, 90) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Adds the specified gradient stop object at the end of the collection. + Minimum of 2 gradient stops must be added while using gradient type fill. + + Represents an gradient stop instance to be added. + Returns the zero-based index of the gradient stop object within collection. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient; + //Create instance to hold all the gradient stop + IGradientStops gradientStops = slide.Background.Fill.GradientFill.GradientStops; + //Add a gradient stop to the gradient stops collection + gradientStops.Add(); + //Gets a single gradient stop from the collection + IGradientStop gradStop = gradientStops[0]; + //Set position for gradient stop + gradStop.Position = 2.4F; + //Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(23, 156, 90); + //Add the gradient stop to collection + gradientStops.Add(gradStop); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient + 'Create instance to hold all the gradient stop + Dim gradientStops As IGradientStops = slide.Background.Fill.GradientFill.GradientStops + 'Add a gradient stop to the gradient stops collection + gradientStops.Add() + 'Gets a single gradient stop from the collection + Dim gradStop As IGradientStop = gradientStops(0) + 'Set position for gradient stop + gradStop.Position = 2.4F + 'Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(23, 156, 90) + 'Add the gradient stop to collection + gradientStops.Add(gradStop) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Inserts an item into the gradient stop collection at the specified index. + + The zero-based index value to insert the specified gradient stop item. + The gradient stop item to insert. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient; + //Create instance to hold all the gradient stop + IGradientStops gradientStops = slide.Background.Fill.GradientFill.GradientStops; + //Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.Crimson, 1.1F); + //Add a gradient stop to the gradient stops collection + IGradientStop gradStop = gradientStops.Add(); + //Set position for gradient stop + gradStop.Position = 2.4F; + //Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(23, 156, 90); + //Add the gradient stop to collection + gradientStops.Add(gradStop); + //Insert a gradient stop into the collection + gradientStops.Insert(1, gradStop); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient + 'Create instance to hold all the gradient stop + Dim gradientStops As IGradientStops = slide.Background.Fill.GradientFill.GradientStops + 'Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.Crimson, 1.1F) + 'Add a gradient stop to the gradient stops collection + Dim gradStop As IGradientStop = gradientStops.Add() + 'Set position for gradient stop + gradStop.Position = 2.4F + 'Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(23, 156, 90) + 'Add the gradient stop to collection + gradientStops.Add(gradStop) + 'Insert a gradient stop into the collection + gradientStops.Insert(1, gradStop) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the element at the specified index of the gradient stop collection. + + The zero-based index value to remove the specified gradient stop item. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient; + //Create instance to hold all the gradient stop + IGradientStops gradientStops = slide.Background.Fill.GradientFill.GradientStops; + //Add a gradient stop to the gradient stops collection + gradientStops.Add(); + //Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.Crimson, 1.1F); + //Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.LightBlue, 75F); + //Remove the gradient stop from specific index + gradientStops.RemoveAt(0); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient + 'Create instance to hold all the gradient stop + Dim gradientStops As IGradientStops = slide.Background.Fill.GradientFill.GradientStops + 'Add a gradient stop to the gradient stops collection + gradientStops.Add() + 'Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.Crimson, 1.1F) + 'Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.LightBlue, 75F) + 'Remove the gradient stop from specific index + gradientStops.RemoveAt(0) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the first occurrence of a specified instance from the gradient stop collection. + + The gradient stop instance to be removed from the collection. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient; + //Create instance to hold all the gradient stop + IGradientStops gradientStops = slide.Background.Fill.GradientFill.GradientStops; + //Add a gradient stop to the gradient stops collection + gradientStops.Add(); + //Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.Crimson, 1.1F); + //Create instance for gradient stop + IGradientStop gradStop = gradientStops.Add(); + //Set position for gradient stop + gradStop.Position = 5F; + //Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(20, 106, 120); + //Remove a gradient stop + gradientStops.Remove(gradStop); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient + 'Create instance to hold all the gradient stop + Dim gradientStops As IGradientStops = slide.Background.Fill.GradientFill.GradientStops + 'Add a gradient stop to the gradient stops collection + gradientStops.Add() + 'Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.Crimson, 1.1F) + 'Create instance for gradient stop + Dim gradStop As IGradientStop = gradientStops.Add() + 'Set position for gradient stop + gradStop.Position = 5F + 'Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(20, 106, 120) + 'Remove a gradient stop + gradientStops.Remove(gradStop) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Returns the zero-based index of the first occurrence of the instance within the collection. + + The instance to locate. + Returns the zero-based index of the first occurrence of instance within the collection, if found; otherwise, –1. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient; + //Create instance to hold all the gradient stop + IGradientStops gradientStops = slide.Background.Fill.GradientFill.GradientStops; + //Add a gradient stop to the gradient stops collection + gradientStops.Add(); + //Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.Crimson, 1.1F); + //Gets a single gradient stop from the collection + IGradientStop gradStop = gradientStops[0]; + //Set position for gradient stop + gradStop.Position = 2.4F; + //Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(23, 156, 90); + //Add the gradient stop to collection + gradientStops.Add(gradStop); + //Get the index of gradient stop from the collection + int index = gradientStops.IndexOf(gradStop); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient + 'Create instance to hold all the gradient stop + Dim gradientStops As IGradientStops = slide.Background.Fill.GradientFill.GradientStops + 'Add a gradient stop to the gradient stops collection + gradientStops.Add() + 'Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.Crimson, 1.1F) + 'Gets a single gradient stop from the collection + Dim gradStop As IGradientStop = gradientStops(0) + 'Set position for gradient stop + gradStop.Position = 2.4F + 'Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(23, 156, 90) + 'Add the gradient stop to collection + gradientStops.Add(gradStop) + 'Get the index of gradient stop from the collection + Dim index As Integer = gradientStops.IndexOf(gradStop) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes all the elements from gradient stop collection. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient; + //Create instance to hold all the gradient stop + IGradientStops gradientStops = slide.Background.Fill.GradientFill.GradientStops; + //Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.Crimson, 1.1F); + //Add a gradient stop to the gradient stops collection + gradientStops.Add(); + //Clears the collection + gradientStops.Clear(); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient + 'Create instance to hold all the gradient stop + Dim gradientStops As IGradientStops = slide.Background.Fill.GradientFill.GradientStops + 'Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.Crimson, 1.1F) + 'Add a gradient stop to the gradient stops collection + gradientStops.Add() + 'Clears the collection + gradientStops.Clear() + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Adds a gradient stop at the specified position. + Minimum of 2 gradient stops must be added while using gradient type fill. + + The color of gradient stop. + The position of the gradient stop. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient; + //Create instance to hold all the gradient stop + IGradientStops gradientStops = slide.Background.Fill.GradientFill.GradientStops; + //Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.LightBlue, 20F); + //Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.Crimson, 90.2F); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient + 'Create instance to hold all the gradient stop + Dim gradientStops As IGradientStops = slide.Background.Fill.GradientFill.GradientStops + 'Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.LightBlue, 20F) + 'Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.Crimson, 90.2F) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the number of elements in the gradient stop collection. Read-only. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient; + //Create instance to hold all the gradient stop + IGradientStops gradientStops = slide.Background.Fill.GradientFill.GradientStops; + //Add a gradient stop to the gradient stops collection + gradientStops.Add(); + //Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.Crimson, 1.1F); + //Create instance for gradient stop + IGradientStop gradStop = gradientStops.Add(); + //Set position for gradient stop + gradStop.Position = 5F; + //Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(20, 106, 120); + //Get the count of gradient stops added, read only + int totalGradientStops = gradientStops.Count; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient + 'Create instance to hold all the gradient stop + Dim gradientStops As IGradientStops = slide.Background.Fill.GradientFill.GradientStops + 'Add a gradient stop to the gradient stops collection + gradientStops.Add() + 'Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.Crimson, 1.1F) + 'Create instance for gradient stop + Dim gradStop As IGradientStop = gradientStops.Add() + 'Set position for gradient stop + gradStop.Position = 5F + 'Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(20, 106, 120) + 'Get the count of gradient stops added, read only + Dim totalGradientStops As Integer = gradientStops.Count + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets an instance at specified index from the gradient stop collection. Read-only. + + + The . + + Determines the index of the gradient stop. + Returns the instance. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient; + //Create instance to hold all the gradient stop + IGradientStops gradientStops = slide.Background.Fill.GradientFill.GradientStops; + //Add a gradient stop to the gradient stops collection + gradientStops.Add(); + //Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.Blue, 75F); + //Gets a single gradient stop from the collection + IGradientStop gradStop = gradientStops[0]; + //Set position for gradient stop + gradStop.Position = 25F; + //Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(23, 156, 90); + //Add the gradient stop to collection + gradientStops.Add(gradStop); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Set gradient fill to the slide background + slide.Background.Fill.FillType = FillType.Gradient + 'Create instance to hold all the gradient stop + Dim gradientStops As IGradientStops = slide.Background.Fill.GradientFill.GradientStops + 'Add a gradient stop to the gradient stops collection + gradientStops.Add() + 'Add a gradient stop by specifying color and position + gradientStops.Add(ColorObject.Blue, 75F) + 'Gets a single gradient stop from the collection + Dim gradStop As IGradientStop = gradientStops(0) + 'Set position for gradient stop + gradStop.Position = 25F + 'Set color for gradient stop + gradStop.Color = ColorObject.FromArgb(23, 156, 90) + 'Add the gradient stop to collection + gradientStops.Add(gradStop) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents the group shape in a slide. + + + + + Gets an instance that represents all the elements within the group shape. + + + The shapes. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a group shape to the slide + IGroupShape groupShape = slide.GroupShapes.AddGroupShape(12, 12, 400, 400); + //Create instance to hold all the shapes in a group shape + IShapes shapes = groupShape.Shapes; + //Add auto shapes to group shape + shapes.AddShape(AutoShapeType.Oval, 47, 50, 60, 120); + shapes.AddShape(AutoShapeType.Rectangle, 12, 12, 40, 30); + //Set description for the group shape + groupShape.Description = "This is a groupShape"; + //Set title for the group shape + groupShape.Title = "Group Shape"; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a group shape to the slide + Dim groupShape As IGroupShape = slide.GroupShapes.AddGroupShape(12, 12, 400, 400) + 'Create instance to hold all the shapes in a group shape + Dim shapes As IShapes = groupShape.Shapes + 'Add auto shapes to group shape + shapes.AddShape(AutoShapeType.Oval, 47, 50, 60, 120) + shapes.AddShape(AutoShapeType.Rectangle, 12, 12, 40, 30) + 'Set description for the group shape + groupShape.Description = "This is a groupShape" + 'Set title for the group shape + groupShape.Title = "Group Shape" + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets an instance that contains fill formatting properties. Read-only. + + + The fill. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a group shape to the slide + IGroupShape groupShape = slide.GroupShapes.AddGroupShape(12, 12, 400, 400); + //Create instance to hold all the shapes in a group shape + IShapes shapes = groupShape.Shapes; + //Add auto shapes to group shape + shapes.AddShape(AutoShapeType.Oval, 47, 50, 60, 120); + shapes.AddShape(AutoShapeType.Rectangle, 12, 12, 40, 30); + //Get the fill of a group shape + IFill fill = groupShape.Fill; + //Set the fill type for group shape + fill.FillType = FillType.Solid; + //Set the color for solid fill + fill.SolidFill.Color = ColorObject.Red; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a group shape to the slide + Dim groupShape As IGroupShape = slide.GroupShapes.AddGroupShape(12, 12, 400, 400) + 'Create instance to hold all the shapes in a group shape + Dim shapes As IShapes = groupShape.Shapes + 'Add auto shapes to group shape + shapes.AddShape(AutoShapeType.Oval, 47, 50, 60, 120) + shapes.AddShape(AutoShapeType.Rectangle, 12, 12, 40, 30) + 'Get the fill of a group shape + Dim fill As IFill = groupShape.Fill + 'Set the fill type for group shape + fill.FillType = FillType.Solid + 'Set the color for solid fill + fill.SolidFill.Color = ColorObject.Red + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents a collection of instance in a slide. + + + + + Creates a group shape and adds the group shape to the shape collection. + + Represents the left position, in points. The Left value ranges from -169056 to 169056. + Represents the top position, in points. The Top value ranges from -169056 to 169056. + Represents the width, in points. The Width value ranges from 0 to 169056. + Represents the height, in points. The Height value ranges from 0 to 169056. + Returns an instance this method creates. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for group shapes + IGroupShapes groupShapes = slide.GroupShapes; + //Add group shape to the collection + IGroupShape groupShape = groupShapes.AddGroupShape(12, 12, 300, 350); + //Add shapes to group shape. + groupShape.Shapes.AddShape(AutoShapeType.Rectangle, 12, 12, 40, 30); + groupShape.Shapes.AddShape(AutoShapeType.Oval, 47, 50, 60, 120); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for group shapes + Dim groupShapes As IGroupShapes = slide.GroupShapes + 'Add group shape to the collection + Dim groupShape As IGroupShape = groupShapes.AddGroupShape(12, 12, 300, 350) + 'Add shapes to group shape. + groupShape.Shapes.AddShape(AutoShapeType.Rectangle, 12, 12, 40, 30) + groupShape.Shapes.AddShape(AutoShapeType.Oval, 47, 50, 60, 120) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Returns the zero-based index of the first occurrence of the instance within the collection. + + The IGroupShape instance to locate in the collection. + Returns the zero-based index of the first occurrence of the specified group shape within the collection, if found; otherwise, –1. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for group shapes + IGroupShapes groupShapes = slide.GroupShapes; + //Add group shape to the collection + IGroupShape groupShape1 = groupShapes.AddGroupShape(12, 12, 250, 250); + IGroupShape groupShape2 = groupShapes.AddGroupShape(300, 50, 200, 100); + //Add shape to group shape. + groupShape1.Shapes.AddShape(AutoShapeType.Rectangle, 12, 12, 40, 30); + groupShape1.Shapes.AddShape(AutoShapeType.Oval, 47, 50, 60, 120); + groupShape2.Shapes.AddShape(AutoShapeType.Rectangle, 200, 12, 40, 30); + groupShape2.Shapes.AddShape(AutoShapeType.Oval, 250, 50, 60, 120); + //Get the index of added group shape + int index = groupShapes.IndexOf(groupShape1); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for group shapes + Dim groupShapes As IGroupShapes = slide.GroupShapes + 'Add group shape to the collection + Dim groupShape1 As IGroupShape = groupShapes.AddGroupShape(12, 12, 250, 250) + Dim groupShape2 As IGroupShape = groupShapes.AddGroupShape(300, 50, 200, 100) + 'Add shape to group shape. + groupShape1.Shapes.AddShape(AutoShapeType.Rectangle, 12, 12, 40, 30) + groupShape1.Shapes.AddShape(AutoShapeType.Oval, 47, 50, 60, 120) + groupShape2.Shapes.AddShape(AutoShapeType.Rectangle, 200, 12, 40, 30) + groupShape2.Shapes.AddShape(AutoShapeType.Oval, 250, 50, 60, 120) + 'Get the index of added group shape + Dim index As Integer = groupShapes.IndexOf(groupShape1) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the first occurrence of a specified instance from the group shape collection. + + The group shape object to be removed from the collection. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for group shapes + IGroupShapes groupShapes = slide.GroupShapes; + //Add group shape to the collection + IGroupShape groupShape1 = groupShapes.AddGroupShape(12, 12, 250, 250); + IGroupShape groupShape2 = groupShapes.AddGroupShape(300, 50, 200, 100); + //Add shape to group shape. + groupShape1.Shapes.AddShape(AutoShapeType.Rectangle, 12, 12, 40, 30); + groupShape1.Shapes.AddShape(AutoShapeType.Oval, 47, 50, 60, 120); + groupShape2.Shapes.AddShape(AutoShapeType.Rectangle, 200, 12, 40, 30); + groupShape2.Shapes.AddShape(AutoShapeType.Oval, 250, 50, 60, 120); + //Remove a group shape instance from collection + groupShapes.Remove(groupShape2); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for group shapes + Dim groupShapes As IGroupShapes = slide.GroupShapes + 'Add group shape to the collection + Dim groupShape1 As IGroupShape = groupShapes.AddGroupShape(12, 12, 250, 250) + Dim groupShape2 As IGroupShape = groupShapes.AddGroupShape(300, 50, 200, 100) + 'Add shape to group shape. + groupShape1.Shapes.AddShape(AutoShapeType.Rectangle, 12, 12, 40, 30) + groupShape1.Shapes.AddShape(AutoShapeType.Oval, 47, 50, 60, 120) + groupShape2.Shapes.AddShape(AutoShapeType.Rectangle, 200, 12, 40, 30) + groupShape2.Shapes.AddShape(AutoShapeType.Oval, 250, 50, 60, 120) + 'Remove a group shape instance from collection + groupShapes.Remove(groupShape2) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the element at the specified index of the group shape collection. + + The zero-based index of the group shape object to be removed. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for group shapes + IGroupShapes groupShapes = slide.GroupShapes; + //Add group shape to the collection + IGroupShape groupShape1 = groupShapes.AddGroupShape(12, 12, 250, 250); + IGroupShape groupShape2 = groupShapes.AddGroupShape(300, 50, 200, 100); + //Add shape to group shape. + groupShape1.Shapes.AddShape(AutoShapeType.Rectangle, 12, 12, 40, 30); + groupShape1.Shapes.AddShape(AutoShapeType.Oval, 47, 50, 60, 120); + groupShape2.Shapes.AddShape(AutoShapeType.Rectangle, 200, 12, 40, 30); + groupShape2.Shapes.AddShape(AutoShapeType.Oval, 250, 50, 60, 120); + //Remove an item from specific index. + groupShapes.RemoveAt(0); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for group shapes + Dim groupShapes As IGroupShapes = slide.GroupShapes + 'Add group shape to the collection + Dim groupShape1 As IGroupShape = groupShapes.AddGroupShape(12, 12, 250, 250) + Dim groupShape2 As IGroupShape = groupShapes.AddGroupShape(300, 50, 200, 100) + 'Add shape to group shape. + groupShape1.Shapes.AddShape(AutoShapeType.Rectangle, 12, 12, 40, 30) + groupShape1.Shapes.AddShape(AutoShapeType.Oval, 47, 50, 60, 120) + groupShape2.Shapes.AddShape(AutoShapeType.Rectangle, 200, 12, 40, 30) + groupShape2.Shapes.AddShape(AutoShapeType.Oval, 250, 50, 60, 120) + 'Remove an item from specific index. + groupShapes.RemoveAt(0) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a instance from the collection. Read-only. + + + The . + + Index from the collection. + Returns the particular group shape based on the index. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for group shapes + IGroupShapes groupShapes = slide.GroupShapes; + //Add group shape to the collection + IGroupShape groupShape1 = groupShapes.AddGroupShape(12, 12, 250, 250); + IGroupShape groupShape2 = groupShapes.AddGroupShape(300, 50, 200, 100); + //Add shape to group shape. + groupShape1.Shapes.AddShape(AutoShapeType.Rectangle, 12, 12, 40, 30); + groupShape1.Shapes.AddShape(AutoShapeType.Oval, 47, 50, 60, 120); + groupShape2.Shapes.AddShape(AutoShapeType.Rectangle, 200, 12, 40, 30); + groupShape2.Shapes.AddShape(AutoShapeType.Oval, 250, 50, 60, 120); + //To access a specific group shape in the collection + IGroupShape groupShape = groupShapes[0]; + //Set the description + groupShape.Description = "First group shape"; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for group shapes + Dim groupShapes As IGroupShapes = slide.GroupShapes + 'Add group shape to the collection + Dim groupShape1 As IGroupShape = groupShapes.AddGroupShape(12, 12, 250, 250) + Dim groupShape2 As IGroupShape = groupShapes.AddGroupShape(300, 50, 200, 100) + 'Add shape to group shape. + groupShape1.Shapes.AddShape(AutoShapeType.Rectangle, 12, 12, 40, 30) + groupShape1.Shapes.AddShape(AutoShapeType.Oval, 47, 50, 60, 120) + groupShape2.Shapes.AddShape(AutoShapeType.Rectangle, 200, 12, 40, 30) + groupShape2.Shapes.AddShape(AutoShapeType.Oval, 250, 50, 60, 120) + 'To access a specific group shape in the collection + Dim groupShape As IGroupShape = groupShapes(0) + 'Set the description + groupShape.Description = "First group shape" + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the number of elements in the group shape collection. Read-only. + + + The count. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for group shapes + IGroupShapes groupShapes = slide.GroupShapes; + //Add group shape to the collection + IGroupShape groupShape1 = groupShapes.AddGroupShape(12, 12, 250, 250); + IGroupShape groupShape2 = groupShapes.AddGroupShape(300, 50, 200, 100); + //Add shape to group shape. + groupShape1.Shapes.AddShape(AutoShapeType.Rectangle, 12, 12, 40, 30); + groupShape1.Shapes.AddShape(AutoShapeType.Oval, 47, 50, 60, 120); + groupShape2.Shapes.AddShape(AutoShapeType.Rectangle, 200, 12, 40, 30); + groupShape2.Shapes.AddShape(AutoShapeType.Oval, 250, 50, 60, 120); + //Get the count of group shapes collection + int count = groupShapes.Count; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for group shapes + Dim groupShapes As IGroupShapes = slide.GroupShapes + 'Add group shape to the collection + Dim groupShape1 As IGroupShape = groupShapes.AddGroupShape(12, 12, 250, 250) + Dim groupShape2 As IGroupShape = groupShapes.AddGroupShape(300, 50, 200, 100) + 'Add shape to group shape. + groupShape1.Shapes.AddShape(AutoShapeType.Rectangle, 12, 12, 40, 30) + groupShape1.Shapes.AddShape(AutoShapeType.Oval, 47, 50, 60, 120) + groupShape2.Shapes.AddShape(AutoShapeType.Rectangle, 200, 12, 40, 30) + groupShape2.Shapes.AddShape(AutoShapeType.Oval, 250, 50, 60, 120) + 'Get the count of group shapes collection + Dim count As Integer = groupShapes.Count + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Sets the language value + + + + + + + Sets the language value + + + + + + + Gets the layout number from the path. + + The path containing the layout number. + Layout number from the path + + + + Sorts the relation collection. + + The relation collection to be sorted + The sorted relation collection. + + + + Gets file name without extension from the path. + + Url to get name from. + File name without extension from the path. + + + + Gets folder name from the path. + + The file path from which to extract the folder name. + folder name from the path. + + + + Gets file name from the path. + + Url to get name from. + File name from the path. + + + + Gets the file extension from the path. + + Represents the file path. + Returns the file extension. + + + + Gets a PlaceholderType value with corresponding HeaderFooterType. + + Specifies a headerFooterType + Retruns a PlaceholderType value with corresponding HeaderFooterType. + + + + Check whether current PlaceHolder is HeaderFooter or not. + + Represent a PlaceholderType to check. + Returns true, if it is a HeaderFooter shape; Otherwise false. + + + + Gets a DateTimeFormatType for the provided field type. + + Represent the type of a field. + Returns a DateTimeFormatType for the corresponding field type. + + + + Gets a DateTime field type for the provided DateTimeFormatType. + + Represent the type of a DateTimeFormat. + Returns a DateTime field type for the provided DateTimeFormatType. + + + + Checks whether the layout placeholder and the current placeholder are same. + + Instance of the layout placeholder + Instance of the current placeholder + Returns whether both the placeholder are same. + + + + Checks whether the master placeholder and the current placeholder are same. + + Instance of the master placeholder + Instance of the current placeholder + Returns whether the master placeholder and the current placeholder are same. + + + + Checks whether the layout placeholder and the current placeholder are same. + + Instance of the layout placeholder + Instance of the current placeholder + Determines whether it is master slide or not + Returns whether the layout placeholder and the current placeholder are same. + + + + Converts the string to "OleObjectType" + + The OLE type STR. + + + + + Gets a OLE extension for specified ole type. + + Represent a OLE type. + Returns a extension for the corresponding OLE type. + + + + Converts the string to "OleObjectType" + + The OLE type STR. + + + + + Returns the color value from ColorMap dictionary. + + value + The layout slide + + + + + Gets the name of the placeholder. + + Represents the placeholder type. + Return the string format of the placeholder. + + + + Check whether source and destination PlaceholderTypes are same or not. + + Represent a source PlaceholderTypes to compare. + Represent a destination PlaceholderTypes to compare. + Returns true, if source and destination are same; Otherwise false. + + + + Gets a PathFillMode for a input string. + + Represent a input string. + Returns a PathFillMode. + + + + Gets the placeholder type from string. + + Placeholder type in string format. + Returns the type of placeholder. + + + + Returns the color value from ColorMap dictionary. + + value + The base slide + + + + + Converts a string to an integer. + + The string to convert to an integer. + + The integer representation of the string or returns 0 if the string is null or empty. + + + + + Converts a Base64 encoded string to a byte array. + + The Base64 encoded string to convert. + The byte array represented by the Base64 encoded string, or null if the string is null. + + + + Convert percentage value to int. + + + + + Gets a XML input for a PathFillMode. + + Represent a PathFillMode. + Returns a string for PathFillMode. + + + + Converts the placeholder type to string. + + Type of the internal placeholder. + Returns the string format of the placeholder type. + + + + Gets the font name from theme.xml, based on a script type. + + Represent a theme values. + Represent the script type of TextRange. + + + + + Check whether Lan attribute is valid or not. + + Returns true, if it is valid; Otherwise false. + + + + Gets a font name from theme.xml file. + + Represent the theme values. + Represent the theme font name. + Represent the script type. + Represent the Lang attribute value. + + + + + Gets a default font name to render the text, when retrived font name is null or empty. + + Represent a script type to check. + Returns a default font name to render. + + + + Check whether current script is EastAsia script or not. + + Represent a scipt to check. + Returns true, if it is an EastAsia script; Otherwise false. + + + + Check whether current script is Complex script or not. + + Represent a script to check. + Returns true, if it is an Complex script; Otherwise false. + + + + Get the first key from the Dictionary with specified value + + Represent the Dictionary that contains value + Represent the value + + + + + Gets the layout type value equivalent to the slide layout type. + + Returns a string value for the slide layout type. + + + + Provides access to the types used to create and manipulate images in PowerPoint Presentations. + + + + + + Specifies the file format of the image. + + + + + Specifies the image format is unknown + + + + + Specifies the image format is BMP + + + + + Specifies the image format is EMF + + + + + Specifies the image format is GIF + + + + + Specifies the image format is JPEG + + + + + Specifies the image format is PNG + + + + + Specifies the image format is WMF + + + + + Specifies the image format is icon + + + + + Specifies the image format is exif + + + + + Specifies the image format is memory BMP + + + + + Specifies the image format is tiff + + + + + Specifies the type of the image. + + + + + Specifies the ImageType is metafile + + + + + Specifies the ImageType is bitmap + + + + + Represents the functionalities for using images in presentation + + + + + + //Create an instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create an instance for image as stream + Stream imageStream = File.Open("Image.gif", FileMode.Open); + //Get the image from file path + Image image = new Image(imageStream); + // Add the image to the slide by specifying position and size + slide.Pictures.AddPicture(new MemoryStream(image.ImageData), 120,100,290,200); + //Save the presentation + presentation.Save("Output.pptx"); + //close the presentation + presentation.Close(); + + + 'Create an instance of PowerPoint presentation + Dim presentation As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Create an instance for image as stream + Dim imageStream As Stream = File.Open("Image.gif", FileMode.Open) + 'Get the image from file path + Dim image As New Image(imageStream) + ' Add the image to the slide by specifying position and size + slide.Pictures.AddPicture(New MemoryStream(image.ImageData), 120, 100, 290, 200) + 'Save the presentation + presentation.Save("Output.pptx") + 'close the presentation + presentation.Close() + + + + + + Checks if Bmp. + + + + + + Checks if EMF or WMF. + + + + + + Checks if GIF. + + + + + + Checks if icon. + + + + + + Checks if JPEG. + + + + + + Checks if PNG. + + + + + + Initializes this instance. + + + + + Parses the GIF image. + + + + + Parses the EMF or WMF image. + + + + + Parses the GIF image. + + + + + Parses the icon image. + + + + + Parses the JPEG image. + + + + + Parses the PNG image. + + + + + Reads the int16. + + + + + + Reads the int32. + + + + + + Reads the short LE. + + + + + + Reads the string. + + The len. + + + + + Reads the Uint32. + + + + + + Reads the word. + + + + + + Resets this instance. + + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + Returns the this method creates. + + + //Create an instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create an instance for image as stream + Stream imageStream = File.Open("Image.gif", FileMode.Open); + //Get the image from file path + Image image = Image.FromStream(imageStream); + // Add the image to the slide by specifying position and size + slide.Pictures.AddPicture(new MemoryStream(image.ImageData), 300, 270, 410, 250); + //Save the presentation + presentation.Save("Image.pptx"); + //close the presentation + presentation.Close(); + + + 'Create an instance of PowerPoint presentation + Dim presentation As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Create an instance for image as stream + Dim imageStream As Stream = File.Open("Image.gif", FileMode.Open) + 'Get the image from file path + Dim image As Image = Image.FromStream(imageStream) + ' Add the image to the slide by specifying position and size + slide.Pictures.AddPicture(New MemoryStream(image.ImageData), 300, 270, 410, 250) + 'Save the presentation + presentation.Save("Image.pptx") + 'close the presentation + presentation.Close() + + + + + + Creates an independent copy of the specified image. + + The this method creates. + + + //Create an instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create an instance for image as stream + Stream imageStream = File.Open("Image.gif", FileMode.Open); + //Get the image from file path + Image image = Image.FromStream(imageStream); + //Clone the image + Image clonedImage = image.Clone(); + // Add the image to the slide by specifying position and size + slide.Pictures.AddPicture(new MemoryStream(clonedImage.ImageData), 300, 270, 410, 250); + //Save the presentation + presentation.Save("Image.pptx"); + //close the presentation + presentation.Close(); + + + 'Create an instance of PowerPoint presentation + Dim presentation As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Create an instance for image as stream + Dim imageStream As Stream = File.Open("Image.gif", FileMode.Open) + 'Get the image from file path + Dim image As Image = Image.FromStream(imageStream) + 'Clone the image + Dim clonedImage As Image = image.Clone() + ' Add the image to the slide by specifying position and size + slide.Pictures.AddPicture(New MemoryStream(clonedImage.ImageData), 300, 270, 410, 250) + 'Save the presentation + presentation.Save("Image.pptx") + 'close the presentation + presentation.Close() + + + + + + Creates an image from the specified file. + + A string that contains the name of the file from which to create the . + Returns the this method creates. + + + //Create an instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Get the image from file path + Image image = Image.FromFile(@"image.jpg"); + // Add the image to the slide by specifying position and size + slide.Pictures.AddPicture(new MemoryStream(image.ImageData), 300, 270, 410, 250); + //Save the presentation + presentation.Save("Image.pptx"); + //close the presentation + presentation.Close(); + + + 'Create an instance of PowerPoint presentation + Dim presentation As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Get the image from file path + Dim image As Image = Image.FromFile("image.jpg") + ' Add the image to the slide by specifying position and size + slide.Pictures.AddPicture(New MemoryStream(image.ImageData), 300, 270, 410, 250) + 'Save the presentation + presentation.Save("Image.pptx") + 'close the presentation + presentation.Close() + + + + + + Gets the image format. Read-only. + + The image format. + + + //Create an instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create an instance for image as stream + Stream imageStream = File.Open("Image.gif", FileMode.Open); + //Get the image from file path + Image image = Image.FromStream(imageStream); + //Get the image format, read only + ImageFormat imageFormat = image.Format; + //Add the image to the slide by specifying position and size + slide.Pictures.AddPicture(new MemoryStream(image.ImageData), 300, 270, 410, 250); + //Save the presentation + presentation.Save("Output.pptx"); + //close the presentation + presentation.Close(); + + + 'Create an instance of PowerPoint presentation + Dim presentation As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Create an instance for image as stream + Dim imageStream As Stream = File.Open("Image.gif", FileMode.Open) + 'Get the image from file path + Dim image As Image = Image.FromStream(imageStream) + 'Get the image format, read only + Dim imageFormat As ImageFormat = image.Format + 'Add the image to the slide by specifying position and size + slide.Pictures.AddPicture(New MemoryStream(image.ImageData), 300, 270, 410, 250) + 'Save the presentation + presentation.Save("Output.pptx") + 'close the presentation + presentation.Close() + + + + + + Gets the height of the Image. Read-only. + + The height. + + + //Create an instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create an instance for image as stream + Stream imageStream = File.Open("Image.gif", FileMode.Open); + //Get the image from file path + Image image = Image.FromStream(imageStream); + //Get the size of image, it is read only + int Height = image.Height; + int width = image.Width; + //Add the image to the slide by specifying position and size + slide.Pictures.AddPicture(new MemoryStream(image.ImageData), 300, 270, 410, 250); + //Save the presentation + presentation.Save("Output.pptx"); + //close the presentation + presentation.Close(); + + + 'Create an instance of PowerPoint presentation + Dim presentation As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Create an instance for image as stream + Dim imageStream As Stream = File.Open("Image.gif", FileMode.Open) + 'Get the image from file path + Dim image As Image = Image.FromStream(imageStream) + 'Get the size of image, it is read only + Dim Height As Integer = image.Height + Dim width As Integer = image.Width + 'Add the image to the slide by specifying position and size + slide.Pictures.AddPicture(New MemoryStream(image.ImageData), 300, 270, 410, 250) + 'Save the presentation + presentation.Save("Output.pptx") + 'close the presentation + presentation.Close() + + + + + + Gets the image data as byte array. Read-only. + + The image data. + + + //Create an instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create an instance for image as stream + Stream imageStream = File.Open("Image.gif", FileMode.Open); + //Get the image from file path + Image image = Image.FromStream(imageStream); + //Get the image data of image + byte[] imageData = image.ImageData; + //Add the image to the slide by specifying position and size + slide.Pictures.AddPicture(new MemoryStream(imageData), 300, 270, 410, 250); + //Save the presentation + presentation.Save("Output.pptx"); + //close the presentation + presentation.Close(); + + + 'Create an instance of PowerPoint presentation + Dim presentation As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Create an instance for image as stream + Dim imageStream As Stream = File.Open("Image.gif", FileMode.Open) + 'Get the image from file path + Dim image As Image = Image.FromStream(imageStream) + 'Get the image data of image + Dim imageData As Byte() = image.ImageData + 'Add the image to the slide by specifying position and size + slide.Pictures.AddPicture(New MemoryStream(imageData), 300, 270, 410, 250) + 'Save the presentation + presentation.Save("Output.pptx") + 'close the presentation + presentation.Close() + + + + + + Gets the file format of the Image. Read-only. + + The image format. + + + //Create an instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create an instance for image as stream + Stream imageStream = File.Open("Image.gif", FileMode.Open); + //Get the image from file path + Image image = Image.FromStream(imageStream); + //Get the image format, read only + ImageFormat imageFormat = image.RawFormat; + //Add the image to the slide by specifying position and size + slide.Pictures.AddPicture(new MemoryStream(image.ImageData), 300, 270, 410, 250); + //Save the presentation + presentation.Save("Output.pptx"); + //close the presentation + presentation.Close(); + + + 'Create an instance of PowerPoint presentation + Dim presentation As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Create an instance for image as stream + Dim imageStream As Stream = File.Open("Image.gif", FileMode.Open) + 'Get the image from file path + Dim image As Image = Image.FromStream(imageStream) + 'Get the image format, read only + Dim imageFormat As ImageFormat = image.RawFormat + 'Add the image to the slide by specifying position and size + slide.Pictures.AddPicture(New MemoryStream(image.ImageData), 300, 270, 410, 250) + 'Save the presentation + presentation.Save("Output.pptx") + 'close the presentation + presentation.Close() + + + + + + Gets the width and height of the image. Read-only. + + The size. + + + //Create an instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create an instance for image as stream + Stream imageStream = File.Open("Image.gif", FileMode.Open); + //Get the image from file path + Image image = Image.FromStream(imageStream); + //Get the size of image, it is read only + System.Drawing.Size size = image.Size; + //Set the width and height of the image + size.Width = 300; + size.Width = 200; + //Add the image to the slide by specifying position and size + slide.Pictures.AddPicture(new MemoryStream(image.ImageData), 120,100,size.Width,size.Height); + //Save the presentation + presentation.Save("Output.pptx"); + //close the presentation + presentation.Close(); + + + 'Create an instance of PowerPoint presentation + Dim presentation As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Create an instance for image as stream + Dim imageStream As Stream = File.Open("Image.gif", FileMode.Open) + 'Get the image from file path + Dim image As Image = Image.FromStream(imageStream) + 'Get the size of image, it is read only + Dim size As System.Drawing.Size = image.Size + 'Set the width and height of the image + size.Width = 300 + size.Width = 200 + 'Add the image to the slide by specifying position and size + slide.Pictures.AddPicture(New MemoryStream(image.ImageData), 120, 100, size.Width, size.Height) + 'Save the presentation + presentation.Save("Output.pptx") + 'close the presentation + presentation.Close() + + + + + + Gets the width of the Image. Read-only. + + The width. + + + //Create an instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create an instance for image as stream + Stream imageStream = File.Open("Image.gif", FileMode.Open); + //Get the image from file path + Image image = Image.FromStream(imageStream); + //Get the size of image, it is read only + int Height = image.Height; + int width = image.Width; + // Add the image to the slide by specifying position and size + slide.Pictures.AddPicture(new MemoryStream(image.ImageData), 300, 270, 410, 250); + //Save the presentation + presentation.Save("Output.pptx"); + //close the presentation + presentation.Close(); + + + 'Create an instance of PowerPoint presentation + Dim presentation As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Create an instance for image as stream + Dim imageStream As Stream = File.Open("Image.gif", FileMode.Open) + 'Get the image from file path + Dim image As Image = Image.FromStream(imageStream) + 'Get the size of image, it is read only + Dim Height As Integer = image.Height + Dim width As Integer = image.Width + ' Add the image to the slide by specifying position and size + slide.Pictures.AddPicture(New MemoryStream(image.ImageData), 300, 270, 410, 250) + 'Save the presentation + presentation.Save("Output.pptx") + 'close the presentation + presentation.Close() + + + + + + Represents the line and arrowhead formatting options. + + + + + Gets or sets the length of the arrowhead at the beginning of the specified line. + + + The length of the begin arrowhead. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance of line format from shape + ILineFormat lineFormat = shape.LineFormat; + //Set the length of the beginning arrowhead of the line + lineFormat.BeginArrowheadLength = ArrowheadLength.Long; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance of line format from shape + Dim lineFormat As ILineFormat = shape.LineFormat + 'Set the length of the beginning arrowhead of the line + lineFormat.BeginArrowheadLength = ArrowheadLength.[Long] + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the style of the arrowhead at the beginning of the specified line. + + + The begin arrowhead style. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance of line format from shape + ILineFormat lineFormat = shape.LineFormat; + //Set the style of the beginning arrowhead of the line + lineFormat.BeginArrowheadStyle = ArrowheadStyle.ArrowOval; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance of line format from shape + Dim lineFormat As ILineFormat = shape.LineFormat + 'Set the style of the beginning arrowhead of the line + lineFormat.BeginArrowheadStyle = ArrowheadStyle.ArrowOval + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the width of the arrowhead at the beginning of the specified line. + + + The width of the begin arrowhead. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance of line format from shape + ILineFormat lineFormat = shape.LineFormat; + //Set the width of the beginning arrowhead of the line + lineFormat.BeginArrowheadWidth = ArrowheadWidth.Narrow; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance of line format from shape + Dim lineFormat As ILineFormat = shape.LineFormat + 'Set the width of the beginning arrowhead of the line + lineFormat.BeginArrowheadWidth = ArrowheadWidth.Narrow + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the line cap style. + + + The cap style. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance of line format from shape + ILineFormat lineFormat = shape.LineFormat; + //Set the line cap style + lineFormat.CapStyle = LineCapStyle.Flat; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance of line format from shape + Dim lineFormat As ILineFormat = shape.LineFormat + 'Set the line cap style + lineFormat.CapStyle = LineCapStyle.Flat + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the line dash style. + + + The dash style. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance of line format from shape + ILineFormat lineFormat = shape.LineFormat; + //Set the line dash style + lineFormat.DashStyle = LineDashStyle.DashLongDashDot; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance of line format from shape + Dim lineFormat As ILineFormat = shape.LineFormat + 'Set the line dash style + lineFormat.DashStyle = LineDashStyle.DashLongDashDot + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the length of the arrowhead at the end of the specified line. + + + The end length of the arrowhead. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance of line format from shape + ILineFormat lineFormat = shape.LineFormat; + //Set the length of the end arrowhead of the line + lineFormat.EndArrowheadLength = ArrowheadLength.Medium; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance of line format from shape + Dim lineFormat As ILineFormat = shape.LineFormat + 'Set the length of the end arrowhead of the line + lineFormat.EndArrowheadLength = ArrowheadLength.Medium + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the style of the arrowhead at the end of the specified line. + + + The end arrowhead style. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance of line format from shape + ILineFormat lineFormat = shape.LineFormat; + //Set the style of the end arrowhead of the line + lineFormat.EndArrowheadStyle = ArrowheadStyle.ArrowDiamond; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance of line format from shape + Dim lineFormat As ILineFormat = shape.LineFormat + 'Set the style of the end arrowhead of the line + lineFormat.EndArrowheadStyle = ArrowheadStyle.ArrowDiamond + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the width of the arrowhead at the end of the specified line. + + + The end width of the arrowhead. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance of line format from shape + ILineFormat lineFormat = shape.LineFormat; + //Set the width of the end arrowhead of the line + lineFormat.EndArrowheadWidth = ArrowheadWidth.Wide; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance of line format from shape + Dim lineFormat As ILineFormat = shape.LineFormat + 'Set the width of the end arrowhead of the line + lineFormat.EndArrowheadWidth = ArrowheadWidth.Wide + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets an instance that represents fill formatting options. Read-only. + + + The fill. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance of line format from shape + ILineFormat lineFormat = shape.LineFormat; + //Retrieve the fill of line format + IFill fill = lineFormat.Fill; + //Set the fill type of line + fill.FillType = FillType.Solid; + //Set the color for solid fill + fill.SolidFill.Color = ColorObject.DeepPink; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance of line format from shape + Dim lineFormat As ILineFormat = shape.LineFormat + 'Retrieve the fill of line format + Dim fill As IFill = lineFormat.Fill + 'Set the fill type of line + fill.FillType = FillType.Solid + 'Set the color for solid fill + fill.SolidFill.Color = ColorObject.DeepPink + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets line join type. + + + The type of the line join. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance of line format from shape + ILineFormat lineFormat = shape.LineFormat; + //Set the line join type + lineFormat.LineJoinType = LineJoinType.Miter; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance of line format from shape + Dim lineFormat As ILineFormat = shape.LineFormat + 'Set the line join type + lineFormat.LineJoinType = LineJoinType.Miter + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or set the line style. + + + The style. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance of line format from shape + ILineFormat lineFormat = shape.LineFormat; + //Set the line style + lineFormat.Style = LineStyle.ThickThin; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance of line format from shape + Dim lineFormat As ILineFormat = shape.LineFormat + 'Set the line style + lineFormat.Style = LineStyle.ThickThin + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or set the line weight, in points. + The range of Weight is from 0 to 1584. + + + The weight. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance of line format from shape + ILineFormat lineFormat = shape.LineFormat; + //Set the weight + lineFormat.Weight = 17; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance of line format from shape + Dim lineFormat As ILineFormat = shape.LineFormat + 'Set the weight + lineFormat.Weight = 17 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Check whether current border is conflicting border or not. + + Represent the current border type. + Returns true. If current border is a conflicting border; otherwise false. + + + + Gets the index of a current cell. + + + + + + Compares the current LineFormat object with given LineFormat object. + + The LineFormat object to compare with the current instance. + True if the LineFormat objects are equal; otherwise, false. + + + + Represents the OLE object in the PowerPoint presentation. + + + + + Gets the image data for the specified OLE object. + + The byte array that specifies the OLE image data. + + + //Load a PowerPoint presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Get the first slide from the presentation + ISlide slide = presentation.Slides[0]; + //Get the oleObject from the slide + IOleObject oleObject = (IShape)slide.Shapes[0] as IOleObject; + //Gets the image data of embedded Ole Object. + byte[] array = oleObject.ImageData; + //Save the extracted OLE image data into file system. + MemoryStream memoryStream = new MemoryStream(array); + FileStream fileStream = File.Create("OleImage.png"); + memoryStream.CopyTo(fileStream); + memoryStream.Dispose(); + fileStream.Dispose(); + //Close the Presentation + presentation.Close(); + + + 'Load a PowerPoint presentation + Dim presentation As IPresentation = Syncfusion.Presentation.Presentation.Open("Sample.pptx") + 'Get the first slide from the presentation + Dim slide As ISlide = presentation.Slides(0) + 'Get the oleObject from the slide + Dim oleObject As IOleObject = CType(CType(slide.Shapes(0), IOleObject), IShape) + 'Gets the image data of embedded Ole Object. + Dim array() As Byte = oleObject.ImageData + 'Save the extracted OLE image data into file system. + Dim memoryStream As MemoryStream = New MemoryStream(array) + Dim fileStream As FileStream = File.Create("OleImage.png") + memoryStream.CopyTo(fileStream) + memoryStream.Dispose + fileStream.Dispose + 'Close the Presentation + presentation.Close() + + + + + + Gets the embedded file data for the specified OLE object. + + The byte array that specifies the embedded file data. + + + //Load a PowerPoint presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Get the first slide from the presentation + ISlide slide = presentation.Slides[0]; + //Get the oleObject from the slide + IOleObject oleObject = (IShape)slide.Shapes[0] as IOleObject; + //Gets the embedded OLE object data + byte[] array = oleObject.ObjectData; + //Save the extracted OLE data into file system. + MemoryStream memoryStream = new MemoryStream(array); + FileStream fileStream = File.Create("OleFile.docx"); + memoryStream.CopyTo(fileStream); + memoryStream.Dispose(); + fileStream.Dispose(); + //Close the Presentation + presentation.Close(); + + + 'Load a PowerPoint presentation + Dim presentation As IPresentation = Syncfusion.Presentation.Presentation.Open("Sample.pptx") + 'Get the first slide from the presentation + Dim slide As ISlide = presentation.Slides(0) + 'Get the oleObject from the slide + Dim oleObject As IOleObject = CType(CType(slide.Shapes(0), IOleObject), IShape) + 'Gets the embedded OLE object data + Dim array() As Byte = oleObject.ObjectData + 'Save the extracted OLE data into file system. + Dim memoryStream As MemoryStream = New MemoryStream(array) + Dim fileStream As FileStream = File.Create("OleFile.docx") + memoryStream.CopyTo(fileStream) + memoryStream.Dispose + fileStream.Dispose + 'Close the Presentation + presentation.Close() + + + + + + Gets the programmatic identifier (ProgID) for the specified OLE object. + + The string that specifies the type of the OLE object. + + + //Load a PowerPoint presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Get the first slide from the presentation + ISlide slide = presentation.Slides[0]; + //Get the oleObject from the slide + IOleObject oleObject = (IShape)slide.Shapes[0] as IOleObject; + //Gets the embedded OLE object type + string objectType = oleObject.ProgID; + //Close the Presentation + presentation.Close(); + + + 'Load a PowerPoint presentation + Dim presentation As IPresentation = Syncfusion.Presentation.Presentation.Open("Sample.pptx") + 'Get the first slide from the presentation + Dim slide As ISlide = presentation.Slides(0) + 'Get the oleObject from the slide + Dim oleObject As IOleObject = CType(CType(slide.Shapes(0), IOleObject), IShape) + 'Gets the embedded OLE object type + Dim objectType As String = oleObject.ProgID + 'Close the Presentation + presentation.Close() + + + + + + Gets or sets a value indicating whether the OLE object is displayed as an icon or content. + + True if the OLE object is displayed as an icon; otherwise, false. + + Initially Presentation library generated documents display the icon (given image) in place of the embedded OLE instance. + By setting the DisplayAsIcon property to true, the icon is not updated after opening or editing the OLE instance by using Microsoft PowerPoint. + However, setting the DisplayAsIcon property to false enables the Presentation document to update the icons dynamically with the content after opening or editing the OLE instance. + + + + //Create new instance of PowerPoint presentation. + IPresentation pptxDoc = Presentation.Create(); + //Add slide with blank layout to presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Get the excel file as stream + Stream excelStream = File.Open("OleTemplate.xlsx", FileMode.Open); + //Image to be displayed, This can be any image + Stream imageStream = File.Open("OlePicture.png", FileMode.Open); + //Add an OLE object to the slide + IOleObject oleObject = slide.Shapes.AddOleObject(imageStream, "Excel.Sheet.12", excelStream); + //Set size and position of the OLE object + oleObject.Left = 10; + oleObject.Top = 10; + oleObject.Width = 400; + oleObject.Height = 300; + //Set DisplayAsIcon as true, to open the embedded document in separate (default) application. + oleObject.DisplayAsIcon = true; + //Save the presentation + pptxDoc.Save("OleObjectSample.pptx"); + //Close the presentation + pptxDoc.Close(); + + + 'Create New instance of PowerPoint presentation. + Dim pptxDoc As IPresentation = Presentation.Create + 'Add slide with blank layout to presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Get the excel file as stream + Dim excelStream As Stream = File.Open("OleTemplate.xlsx", FileMode.Open) + 'Image to be displayed, This can be any image + Dim imageStream As Stream = File.Open("OlePicture.png", FileMode.Open) + 'Add an OLE object to the slide + Dim oleObject As IOleObject = slide.Shapes.AddOleObject(imageStream, "Excel.Sheet.12", excelStream) + 'Set size and position of the OLE object + oleObject.Left = 10 + oleObject.Top = 10 + oleObject.Width = 400 + oleObject.Height = 300 + 'Set DisplayAsIcon as true, to open the embedded document in separate (default) application. + oleObject.DisplayAsIcon = True + 'Save the presentation + pptxDoc.Save("OleObjectSample.pptx") + 'Close the presentation + pptxDoc.Close() + + + + + + Gets the linked path for the specified OLE object. + + The string that specifies the OLE object link address. + + + //Load a PowerPoint presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Get the first slide from the presentation + ISlide slide = presentation.Slides[0]; + //Get the oleObject from the slide + IOleObject oleObject = (IShape)slide.Shapes[0] as IOleObject; + //Gets the OLE object linked path + string objectPath = oleObject.LinkPath; + //Close the Presentation + presentation.Close(); + + + 'Load a PowerPoint presentation + Dim presentation As IPresentation = Syncfusion.Presentation.Presentation.Open("Sample.pptx") + 'Get the first slide from the presentation + Dim slide As ISlide = presentation.Slides(0) + 'Get the oleObject from the slide + Dim oleObject As IOleObject = CType(CType(slide.Shapes(0), IOleObject), IShape) + 'Gets the OLE object linked path + Dim objectPath As String = oleObject.LinkPath + 'Close the Presentation + presentation.Close() + + + + + + Gets the file name of embedded or linked OLE object. + + The string that specifies the file name of the OLE object. + + + //Load a PowerPoint presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Get the first slide from the presentation + ISlide slide = presentation.Slides[0]; + //Get the oleObject from the slide + IOleObject oleObject = (IShape)slide.Shapes[0] as IOleObject; + //Gets the embedded OLE object data + byte[] array = oleObject.ObjectData; + //Gets the file name of OLE object + string fileName = oleObject.FileName; + //Save the extracted OLE data into file system. + MemoryStream memoryStream = new MemoryStream(array); + FileStream fileStream = File.Create(fileName); + memoryStream.CopyTo(fileStream); + memoryStream.Dispose(); + fileStream.Dispose(); + //Close the Presentation + presentation.Close(); + + + 'Load a PowerPoint presentation + Dim presentation As IPresentation = Syncfusion.Presentation.Presentation.Open("Sample.pptx") + 'Get the first slide from the presentation + Dim slide As ISlide = presentation.Slides(0) + 'Get the oleObject from the slide + Dim oleObject As IOleObject = CType(CType(slide.Shapes(0), IOleObject), IShape) + 'Gets the embedded OLE object data + Dim array() As Byte = oleObject.ObjectData + 'Gets the file name of OLE object + Dim fileName As string = oleObject.FileName + 'Save the extracted OLE data into file system. + Dim memoryStream As MemoryStream = New MemoryStream(array) + Dim fileStream As FileStream = File.Create(fileName) + memoryStream.CopyTo(fileStream) + memoryStream.Dispose + fileStream.Dispose + 'Close the Presentation + presentation.Close() + + + + + + The ole stream name + + + + + Updates the GUID. + + The CMP file. + The index. + + + + Saves the specified native data. + + The native data. + The data path. + The OLE object. + + + + Writes the "Ole" stream. + + Type of the link. + Type of the obj. + The data path. + + + + Writes the "ObjInfo" stream. + + Type of the link. + Type of the obj. + + + + Writes the "CompObj" stream. + + Type of the obj. + + + + Writes the native data. + + The native data. + The data path. + Type of the object. + + + + Writes the native data. + + The native data. + Name of the stream. + + + + Writes the embedded drawing. + + The native data. + + + + Writes the native streams. + + The stream. + + + + Writes the package. + + The native data. + The data path. + + + + Update a embedded OLE object data. + + + + + Get byte array from a ICompoundStorage. + + Represent the ICompoundStorage + Represent the stream name to extract. + Returns the byte array + + + + Gets a default Ole package names + + + + + + Sets the type of the OLE. + + The type. + + + + Sets the link path of the OLE. + + The type. + + + + Sets the file name of the OLE. + + The file name of a OLE. + + + + Sets the OLE picture. + + The picture. + + + + Compares the current Shape object with given Shape object. + + The Shape object to compare with the current instance. + True if the Shape objects are equal; otherwise, false. + + + + Clones the OleObject instance. + + Returns the cloned OleObject instance. + + + + Close the OLEObject instance + + + + + Sets the baseslide parent to the current OleObject instance. + + Parent instance to be assigned to the current oleobject's parent. + + + + Gets the programmatic identifier (ProgID) for the specified OLE object. + + The string that specifies the type of the OLE object. + + + + Gets the image data for the specified OLE object. + + The byte array that specifies the OLE image data. + + + + Gets the linked path for the specified OLE object. + + The string that specifies the OLE object link address. + + + + Gets the file name of embedded or linked OLE object. + + The string that specifies the file name of the OLE object. + + + + Gets the embedded file data for the specified OLE object. + + The byte array that specifies the embedded file data. + + + + Gets or sets a value indicating whether the OLE object is displayed as an icon or content. + + True if the OLE object is displayed as an icon; otherwise, false. + Initially Presentation library generated documents display the icon (given image) in place of the embedded OLE instance. + By setting the DisplayAsIcon property to true, the icon is not updated after opening or editing the OLE instance by using Microsoft PowerPoint. + However, setting the DisplayAsIcon property to false enables the Presentation document to update the icons dynamically with the content after opening or editing the OLE instance. + + + + Gets or sets the type of relation. + + + + + Gets the type of the OLE object. + + The type of the OLE object. + + + + Class specifies storage with sub storages and streams. + + + + + Initializes a new instance of the class. + + Name of the storage. + + + + Parses the storages. + + The storage. + + + + Parses the streams. + + The storage. + + + + Writes to storage. + + The storage. + + + + Gets the byte array of the stream + + + + + + + Compare storages + + + + + + + Compares the array. + + The buffer1. + The buffer2. + + + + + Updates the GUID. + + The CMP file. + The index. + The storage name + + + + Clones this instance. + + + + + + Closes this instance. + + + + + Gets or sets the name of the storage. + + The name of the storage. + + + + Gets the streams. + + The streams. + + + + Gets the storages. + + The storages. + + + + Gets/sets the occurrence of the OleObject + + + + + Class performs converting string to OleObjectType enum and vice versa. + + + + + Converts the string to "OleObjectType" + + The OLE type STR. + + + + + Converts the string to "OleObjectType" + + The OLE type STR. + + + + + Gets the GUID for specified type of object. + + The type. + + + + + Implemented alternative method to improve the performance + + + + + + + + Represent the parsing algorithm of a OLE native stream + + + + + Create a object of the Ole10NativeParser + + + + + + Read a string until the empty byte comes. + + Specifies the byte array to read + Specifies a start position of a array to read + Returns the builded string + + + + Gets the native data from the OLE native stream + + + + + Gets the file name of the OLE native stream. + + + + + Clones the VmlShape instance. + + Returns the cloned VmlShape instance. + + + + Gets or Sets a FillMode of Path2D. + + Specifies how the corresponding path should be filled. + + + + Represents the pattern type in fill format. + + + + + Gets or sets the back color for the pattern. + + + The color of the background. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add shape to slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.BlockArc, 12, 23, 100, 220); + //Retrieve fill from shape + IFill fill = shape.Fill; + //Set pattern fill type to shape + fill.FillType = FillType.Pattern; + //Retrieve the pattern fill + IPatternFill patternFill = fill.PatternFill; + //Set back color for the pattern + patternFill.BackColor = ColorObject.Blue; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add shape to slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.BlockArc, 12, 23, 100, 220) + 'Retrieve fill from shape + Dim fill As IFill = shape.Fill + 'Set pattern fill type to shape + fill.FillType = FillType.Pattern + 'Retrieve the pattern fill + Dim patternFill As IPatternFill = fill.PatternFill + 'Set back color for the pattern + patternFill.BackColor = ColorObject.Blue + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the foreground color for the pattern. + + + The color of the foreground. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add shape to slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.BlockArc, 12, 23, 100, 220); + //Retrieve fill from shape + IFill fill = shape.Fill; + //Set pattern fill type to shape + fill.FillType = FillType.Pattern; + //Retrieve the pattern fill + IPatternFill patternFill = fill.PatternFill; + //Set fore color for the pattern + patternFill.ForeColor = ColorObject.Blue; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add shape to slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.BlockArc, 12, 23, 100, 220) + 'Retrieve fill from shape + Dim fill As IFill = shape.Fill + 'Set pattern fill type to shape + fill.FillType = FillType.Pattern + 'Retrieve the pattern fill + Dim patternFill As IPatternFill = fill.PatternFill + 'Set fore color for the pattern + patternFill.ForeColor = ColorObject.Blue + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets of sets a pattern type of the fill format. + + + The pattern. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add shape to slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.BlockArc, 12, 23, 100, 220); + //Retrieve fill from shape + IFill fill = shape.Fill; + //Set pattern fill type to shape + fill.FillType = FillType.Pattern; + //Retrieve the pattern fill + IPatternFill patternFill = fill.PatternFill; + //Set the pattern type + patternFill.Pattern = PatternFillType.DashedDownwardDiagonal; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add shape to slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.BlockArc, 12, 23, 100, 220) + 'Retrieve fill from shape + Dim fill As IFill = shape.Fill + 'Set pattern fill type to shape + fill.FillType = FillType.Pattern + 'Retrieve the pattern fill + Dim patternFill As IPatternFill = fill.PatternFill + 'Set the pattern type + patternFill.Pattern = PatternFillType.DashedDownwardDiagonal + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents ForeColor color index. + + + + + Compares the current PatternFill object with given PatternFill object. + + The PatternFill object to compare with the current instance. + True if the PatternFill objects are equal; otherwise, false. + + + + Gets or sets a boolean value indicates whether format options are applied from Picture or Shape. + + + + + Represents the image in presentation. + + + + + Gets or sets the image data as byte array. + + + The byte data of the image. + + + + //Open an existing presentation. + IPresentation presentation = Presentation.Open("Picture.pptx"); + //Retrieve the first slide from the presentation. + ISlide slide = presentation.Slides[0]; + //Retrieve the first picture from the slide. + IPicture picture = slide.Pictures[0]; + //Get the new picture as stream. + Stream pictureStream = File.Open("Image.gif", FileMode.Open); + //Create instance for memory stream + MemoryStream memoryStream = new MemoryStream(); + //Copy stream to memoryStream. + pictureStream.CopyTo(memoryStream); + //Replace the existing image with new image. + picture.ImageData = memoryStream.ToArray(); + //Save the presentation to the file system. + presentation.Save("ImageData.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open an existing presentation. + Dim presentation__1 As IPresentation = Presentation.Open("Picture.pptx") + 'Retrieve the first slide from the presentation. + Dim slide As ISlide = presentation__1.Slides(0) + 'Retrieve the first picture from the slide. + Dim picture As IPicture = slide.Pictures(0) + 'Get the new picture as stream. + Dim pictureStream As Stream = File.Open("Image.gif", FileMode.Open) + 'Create instance for memory stream + Dim memoryStream As New MemoryStream() + 'Copy stream to memoryStream. + pictureStream.CopyTo(memoryStream) + 'Replace the existing image with new image. + picture.ImageData = memoryStream.ToArray() + 'Save the presentation to the file system. + presentation__1.Save("ImageData.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the SVG image data as byte array. The default value is null. + + Returns the byte array of the SVG image. + + + //Open an existing presentation. + IPresentation presDoc = Presentation.Open("Picture.pptx"); + //Retrieve the first slide from the presentation. + ISlide slide = presDoc.Slides[0]; + //Retrieve the first picture from the slide. + IPicture picture = slide.Pictures[0]; + //Get the new SVG image as stream. + Stream svgStream = File.Open("Image.svg", FileMode.Open); + //Create instance for memory stream + MemoryStream memoryStream = new MemoryStream(); + //Copy stream to memoryStream. + svgStream.CopyTo(memoryStream); + //Replace the existing svg image with new image. + picture.SvgData = memoryStream.ToArray(); + //Save the presentation to the file system. + presDoc.Save("ImageData.pptx"); + //Close the presentation + presDoc.Close(); + + + 'Open an existing presentation. + Dim presDoc As IPresentation = Presentation.Open("Picture.pptx") + 'Retrieve the first slide from the presentation. + Dim slide As ISlide = presDoc.Slides(0) + 'Retrieve the first picture from the slide. + Dim picture As IPicture = slide.Pictures(0) + 'Get the new SVG image as stream. + Dim svgStream As Stream = File.Open("Image.svg", FileMode.Open) + 'Create instance for memory stream + Dim memoryStream As New MemoryStream() + 'Copy stream to memoryStream. + svgStream.CopyTo(memoryStream) + 'Replace the existing svg image with new image. + picture.SvgData = memoryStream.ToArray() + 'Save the presentation to the file system. + presDoc.Save("ImageData.pptx") + 'Close the presentation + presDoc.Close() + + + + + + Gets the . + + + The image format of the current image. + + + + //Open an existing presentation. + IPresentation presentation = Presentation.Open("Picture.pptx"); + //Retrieve the first slide from the presentation. + ISlide slide = presentation.Slides[0]; + //Retrieve the first picture from the slide. + IPicture picture = slide.Pictures[0]; + //Get the new picture as stream. + Stream pictureStream = File.Open("Image.gif", FileMode.Open); + //Create instance for memory stream + MemoryStream memoryStream = new MemoryStream(); + //Copy stream to memoryStream. + pictureStream.CopyTo(memoryStream); + //Replace the existing image with new image. + picture.ImageData = memoryStream.ToArray(); + //Get the image format of the pictures + Syncfusion.Drawing.ImageFormat imageFormat = picture.ImageFormat; + //Save the presentation to the file system. + presentation.Save("ImageData.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open an existing presentation. + Dim presentation__1 As IPresentation = Presentation.Open("Picture.pptx") + 'Retrieve the first slide from the presentation. + Dim slide As ISlide = presentation__1.Slides(0) + 'Retrieve the first picture from the slide. + Dim picture As IPicture = slide.Pictures(0) + 'Get the new picture as stream. + Dim pictureStream As Stream = File.Open("Image.gif", FileMode.Open) + 'Create instance for memory stream + Dim memoryStream As New MemoryStream() + 'Copy stream to memoryStream. + pictureStream.CopyTo(memoryStream) + 'Replace the existing image with new image. + picture.ImageData = memoryStream.ToArray() + 'Get the image format of the pictures + Dim imageFormat As Syncfusion.Drawing.ImageFormat = picture.ImageFormat + 'Save the presentation to the file system. + presentation__1.Save("ImageData.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents the crop properties used to define the portion of an image to be cropped. + + + + //Open an existing presentation. + IPresentation presentation = Presentation.Open("Input.pptx"); + //Retrieve the first slide from the presentation. + ISlide slide = presentation.Slides[0]; + //Retrieve the first picture from the slide. + IPicture picture = slide.Pictures[0]; + //Crops the picture. + picture.Crop.ContainerLeft = 200; + picture.Crop.ContainerTop = 200; + picture.Crop.ContainerWidth = 200; + picture.Crop.ContainerHeight = 200; + //Save the presentation to the file system. + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open an existing presentation. + Dim presentation__1 As IPresentation = Presentation.Open("Input.pptx") + 'Retrieve the first slide from the presentation. + Dim slide As ISlide = presentation__1.Slides(0) + 'Retrieve the first picture from the slide. + Dim picture As IPicture = slide.Pictures(0) + //Crops the picture. + picture.Crop.ContainerLeft = 200; + picture.Crop.ContainerTop = 200; + picture.Crop.ContainerWidth = 200; + picture.Crop.ContainerHeight = 200; + 'Save the presentation to the file system. + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Add the svg and raster image stream + + Represent the svg stream + Represent the raster image stream + + + + Add the stream of the svg and raster images. + + Represent the svg stream + Represent the raster image stream + + + + Compares the current Picture object with given Picture object. + + The Shape object to compare with the current instance. + True if the Shape objects are equal; otherwise, false. + + + + Sets the BaseSlide parent to the current picture's base instance. + + + + + + Gets or sets a value indicating whether the picture is in the OLE format + + + + + Get or Set the data of the SVG picture. + + + + + Gets or sets the image layer data as a byte array. + + + It’s used to store the “.wdp” image data, which is generated while applying the brightness to the picture. + + + + + Retrieves an instance of the Crop class. + + An instance of the Crop class. + + + + Represents a collection of in a slide. + + + + Represents the left position, in points. The Left value ranges from -169056 to 169056. + Represents the top position, in points. The Top value ranges from -169056 to 169056. + Represents the width, in points. The Width value ranges from 0 to 169056. + Represents the height, in points. The Height value ranges from 0 to 169056. + Returns an instance. + + + //Create an instance for PowerPoint + IPresentation presentation = Presentation.Create(); + //Add a blank slide to presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance to hold picture collection + IPictures pictures = slide.Pictures; + //Create an instance for image as stream + Stream imageStream = File.Open("Image.gif", FileMode.Open); + //Add picture to the picture collection + pictures.AddPicture(imageStream, 373, 83, 200, 100); + //Create an instance for image as stream + Stream stream = File.Open("pptxtoimage.png", FileMode.Open); + //Add picture to the shape collection + pictures.AddPicture(stream, 100, 20, 200, 300); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create an instance for PowerPoint + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance to hold picture collection + Dim pictures As IPictures = slide.Pictures + 'Create an instance for image as stream + Dim imageStream As Stream = File.Open("Image.gif", FileMode.Open) + 'Add picture to the picture collection + pictures.AddPicture(imageStream, 373, 83, 200, 100) + 'Create an instance for image as stream + Dim stream As Stream = File.Open("pptxtoimage.png", FileMode.Open) + 'Add picture to the shape collection + pictures.AddPicture(stream, 100, 20, 200, 300) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Creates a picture from the specified svg, its fallback image stream and adds the picture to the picture collection. + + The instance of SVG image. + The instance of fallback image. + Represents the left position, in points. The Left value ranges from -169056 to 169056. + Represents the top position, in points. The Top value ranges from -169056 to 169056. + Represents the width, in points. The Width value ranges from 0 to 169056. + Represents the height, in points. The Height value ranges from 0 to 169056. + Returns an instance. + + + //Create an instance for PowerPoint + IPresentation presDoc = Presentation.Create(); + //Add a blank slide to presentation + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Create instance to hold picture collection + IPictures pictures = slide.Pictures; + //Create an instance for fallback image as stream + Stream imageStream = File.Open("Image.gif", FileMode.Open); + //Create an instance for vector image as stream + Stream svgStream = File.Open("Image.svg", FileMode.Open); + //Add picture to the picture collection + pictures.AddPicture(svgStream, imageStream, 373, 83, 200, 100); + //Save the presentation + presDoc.Save("Sample.pptx"); + //Close the presentation + presDoc.Close(); + + + 'Create an instance for PowerPoint + Dim presDoc As IPresentation = Presentation.Create() + 'Add a blank slide to presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + 'Create instance to hold picture collection + Dim pictures As IPictures = slide.Pictures + 'Create an instance for fallback image as stream + Dim imageStream As Stream = File.Open("Image.gif", FileMode.Open) + 'Create an instance for vector image as stream + Dim svgStream As Stream = File.Open("Image.svg", FileMode.Open) + 'Add picture to the picture collection + pictures.AddPicture(svgStream, imageStream, 373, 83, 200, 100) + 'Save the presentation + presDoc.Save("Sample.pptx") + 'Close the presentation + presDoc.Close() + + + + + + Returns the index of first occurrence of the specified picture instance from the collection. + + Represents the picture from the collection. + The zero-based index of the first occurrence of picture within the picture collection, if found; otherwise, –1. + + + //Create an instance for PowerPoint + IPresentation presentation = Presentation.Create(); + //Add a blank slide to presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance to hold picture collection + IPictures pictures = slide.Pictures; + //Create an instance for image as stream + Stream imageStream = File.Open("Image.gif", FileMode.Open); + //Add picture to the picture collection + pictures.AddPicture(imageStream, 373, 83, 200, 100); + //Create an instance for image as stream + Stream stream = File.Open("pptxtoimage.png", FileMode.Open); + //Add picture to the shape collection + pictures.AddPicture(stream, 100, 20, 200, 300); + //Retrieve a specific picture from the collection, read only + IPicture picture = pictures[0]; + //Get the index of specific picture instance + int index = pictures.IndexOf(picture); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create an instance for PowerPoint + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance to hold picture collection + Dim pictures As IPictures = slide.Pictures + 'Create an instance for image as stream + Dim imageStream As Stream = File.Open("Image.gif", FileMode.Open) + 'Add picture to the picture collection + pictures.AddPicture(imageStream, 373, 83, 200, 100) + 'Create an instance for image as stream + Dim stream As Stream = File.Open("pptxtoimage.png", FileMode.Open) + 'Add picture to the shape collection + pictures.AddPicture(stream, 100, 20, 200, 300) + 'Retrieve a specific picture from the collection, read only + Dim picture As IPicture = pictures(0) + 'Get the index of specific picture instance + Dim index As Integer = pictures.IndexOf(picture) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the first occurrence of the specified picture object from the picture collection + + Represents the picture to be removed from the collection. + + + //Create an instance for PowerPoint + IPresentation presentation = Presentation.Create(); + //Add a blank slide to presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance to hold picture collection + IPictures pictures = slide.Pictures; + //Create an instance for image as stream + Stream imageStream = File.Open("Image.gif", FileMode.Open); + //Add picture to the picture collection + pictures.AddPicture(imageStream, 373, 83, 200, 100); + //Create an instance for image as stream + Stream stream = File.Open("pptxtoimage.png", FileMode.Open); + //Add picture to the shape collection + pictures.AddPicture(stream, 100, 20, 200, 300); + //Retrieve a specific picture from the collection, read only + IPicture picture = pictures[0]; + //Remove a specific picture from collection + pictures.Remove(picture); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create an instance for PowerPoint + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance to hold picture collection + Dim pictures As IPictures = slide.Pictures + 'Create an instance for image as stream + Dim imageStream As Stream = File.Open("Image.gif", FileMode.Open) + 'Add picture to the picture collection + pictures.AddPicture(imageStream, 373, 83, 200, 100) + 'Create an instance for image as stream + Dim stream As Stream = File.Open("pptxtoimage.png", FileMode.Open) + 'Add picture to the shape collection + pictures.AddPicture(stream, 100, 20, 200, 300) + 'Retrieve a specific picture from the collection, read only + Dim picture As IPicture = pictures(0) + 'Remove a specific picture from collection + pictures.Remove(picture) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the picture from the collection. + + The zero-based index of the first occurrence of the picture within the picture collection, if found; otherwise, –1. + + + //Create an instance for PowerPoint + IPresentation presentation = Presentation.Create(); + //Add a blank slide to presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance to hold picture collection + IPictures pictures = slide.Pictures; + //Create an instance for image as stream + Stream imageStream = File.Open("Image.gif", FileMode.Open); + //Add picture to the picture collection + pictures.AddPicture(imageStream, 373, 83, 200, 100); + //Create an instance for image as stream + Stream stream = File.Open("pptxtoimage.png", FileMode.Open); + //Add picture to the shape collection + pictures.AddPicture(stream, 100, 20, 200, 300); + //Remove a picture using index position + pictures.RemoveAt(0); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create an instance for PowerPoint + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance to hold picture collection + Dim pictures As IPictures = slide.Pictures + 'Create an instance for image as stream + Dim imageStream As Stream = File.Open("Image.gif", FileMode.Open) + 'Add picture to the picture collection + pictures.AddPicture(imageStream, 373, 83, 200, 100) + 'Create an instance for image as stream + Dim stream As Stream = File.Open("pptxtoimage.png", FileMode.Open) + 'Add picture to the shape collection + pictures.AddPicture(stream, 100, 20, 200, 300) + 'Remove a picture using index position + pictures.RemoveAt(0) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the picture at the specified index. + + + Specified index value of picture from the picture collection. + + The index value of the picture collection. + + Returns picture at the particular index. + + + + //Create an instance for PowerPoint + IPresentation presentation = Presentation.Create(); + //Add a blank slide to presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance to hold picture collection + IPictures pictures = slide.Pictures; + //Create an instance for image as stream + Stream imageStream = File.Open("Image.gif", FileMode.Open); + //Add picture to the picture collection + pictures.AddPicture(imageStream, 373, 83, 200, 100); + //Create an instance for image as stream + Stream stream = File.Open("pptxtoimage.png", FileMode.Open); + //Add picture to the shape collection + pictures.AddPicture(stream, 100, 20, 200, 300); + //Retrieve a specific picture from the collection, read only + IPicture picture = pictures[0]; + //Set the description + picture.Description = "My picture"; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create an instance for PowerPoint + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance to hold picture collection + Dim pictures As IPictures = slide.Pictures + 'Create an instance for image as stream + Dim imageStream As Stream = File.Open("Image.gif", FileMode.Open) + 'Add picture to the picture collection + pictures.AddPicture(imageStream, 373, 83, 200, 100) + 'Create an instance for image as stream + Dim stream As Stream = File.Open("pptxtoimage.png", FileMode.Open) + 'Add picture to the shape collection + pictures.AddPicture(stream, 100, 20, 200, 300) + 'Retrieve a specific picture from the collection, read only + Dim picture As IPicture = pictures(0) + 'Set the description + picture.Description = "My picture" + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Returns the number of pictures present in the picture collection. + + + The total count of the picture. + + + + //Create an instance for PowerPoint + IPresentation presentation = Presentation.Create(); + //Add a blank slide to presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance to hold picture collection + IPictures pictures = slide.Pictures; + //Create an instance for image as stream + Stream imageStream = File.Open("Image.gif", FileMode.Open); + //Add picture to the picture collection + pictures.AddPicture(imageStream, 373, 83, 200, 100); + //Create an instance for image as stream + Stream stream = File.Open("pptxtoimage.png", FileMode.Open); + //Add picture to the shape collection + pictures.AddPicture(stream, 100, 20, 200, 300); + //Get the count of picture collection + int count = pictures.Count; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create an instance for PowerPoint + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance to hold picture collection + Dim pictures As IPictures = slide.Pictures + 'Create an instance for image as stream + Dim imageStream As Stream = File.Open("Image.gif", FileMode.Open) + 'Add picture to the picture collection + pictures.AddPicture(imageStream, 373, 83, 200, 100) + 'Create an instance for image as stream + Dim stream As Stream = File.Open("pptxtoimage.png", FileMode.Open) + 'Add picture to the shape collection + pictures.AddPicture(stream, 100, 20, 200, 300) + 'Get the count of picture collection + Dim count As Integer = pictures.Count + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Add a SVG image within the current shape + + Represent the Svg Picture stream + Represent the raster Picture stream + Represent the left side position + Represent the top position + Represent the width + Represent the height + retruns a IPicture instance + + + + Defines the Placeholder properties of the IPlaceholder. + + + + + Represents the placeholder formatting options. + + + + + Gets the type. Read-only. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Title); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance for place holder format + IPlaceholderFormat placeholder = (slide.Shapes[0] as IShape).PlaceholderFormat; + //Get the type of place holder format, read only + PlaceholderType type = placeholder.Type; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Title) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance for place holder format + Dim placeholder As IPlaceholderFormat = TryCast(slide.Shapes(0), IShape).PlaceholderFormat + 'Get the type of place holder format, read only + Dim type As PlaceholderType = placeholder.Type + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the name of the place holder. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Title); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Create instance for place holder format + IPlaceholderFormat placeholder = (slide.Shapes[0] as IShape).PlaceholderFormat; + //Set the name of the place holder format + placeholder.Name = "Place holder format"; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Title) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Create instance for place holder format + Dim placeholder As IPlaceholderFormat = TryCast(slide.Shapes(0), IShape).PlaceholderFormat + 'Set the name of the place holder format + placeholder.Name = "Place holder format" + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the placeholder type. + + Returns placeholder type. + + + + Sets the orientation for the placeholder. And modifies the specified placeholder according to the orientation. + + Represents the orientation of the placeholder. + + + + Sets the placeholder type based on the orientation. + + + + + Set the placeholder values. + + Represents the placeholder type. + Represents the placeholder size. + Represents the placeholder direction. + Represents the index of the placeholder. + + + + Sets the placeholder type. + + Represents the placeholder type. + + + + Gets the type of the placeholder. + + + + + Gets or sets the name of the specified placeholder. + + + + + Gets or sets the bounding rectangle of the object. + + + A that represents the boundaries of the object. + + + Represents an actual bounds of placeholder, which is retrieved from either Slide, Layout slide, or Master slide. + + + + + Represents a collection of instance in a slide. + + + + + Adds the specified instance at the end of the shape collection. + + The instance to be added. + Returns the zero-based index of the newly added shape within the shape collection. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.TitleAndContent); + //Get the shape collection of slide + IShapes shapes = slide.Shapes; + //Create instance for SlideItem + ISlideItem slideItem = shapes[0]; + //Set the description for slide item + slideItem.Description = "This is a SlideItem"; + //Set the title + slideItem.Title = "SlideItem"; + //Add the slide item + shapes.Add(slideItem); + //Save the presentation + presentation.Save("Cells.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.TitleAndContent) + 'Get the shape collection of slide + Dim shapes As IShapes = slide.Shapes + 'Create instance for SlideItem + Dim slideItem As ISlideItem = shapes(0) + 'Set the description for slide item + slideItem.Description = "This is a SlideItem" + 'Set the title + slideItem.Title = "SlideItem" + 'Add the slide item + shapes.Add(slideItem) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Inserts an element into the shape collection at the specified index. + + The zero-based index at which item should be inserted. + The slide item to insert in the collection. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for shapes collection + IShapes shapes = slide.Shapes; + //Add text box to slide + IShape textBox = shapes.AddTextBox(100, 30, 100, 200); + //Add a paragraph with text content. + IParagraph paragraph = textBox.TextBody.AddParagraph("This is a Text Box"); + //Insert shape at specific index + shapes.Insert(1, textBox); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for shapes collection + Dim shapes As IShapes = slide.Shapes + 'Add text box to slide + Dim textBox As IShape = shapes.AddTextBox(100, 30, 100, 200) + 'Add a paragraph with text content. + Dim paragraph As IParagraph = textBox.TextBody.AddParagraph("This is a Text Box") + 'Insert shape at specific index + shapes.Insert(1, textBox) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the element at the specified index of the shape collection. + + The zero-based index of the shape to be removed. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for shapes collection + IShapes shapes = slide.Shapes; + //Add text box to slide + IShape textBox = shapes.AddTextBox(100, 30, 100, 200); + //Add a paragraph with text content. + IParagraph paragraph = textBox.TextBody.AddParagraph("This is a Text Box"); + //Remove shape at specific index + shapes.RemoveAt(0); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for shapes collection + Dim shapes As IShapes = slide.Shapes + 'Add text box to slide + Dim textBox As IShape = shapes.AddTextBox(100, 30, 100, 200) + 'Add a paragraph with text content. + Dim paragraph As IParagraph = textBox.TextBody.AddParagraph("This is a Text Box") + 'Remove shape at specific index + shapes.RemoveAt(0) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the first occurrence of a specified slide from the shape collection. + + The shape to be removed from the collection. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for shapes collection + IShapes shapes = slide.Shapes; + //Add text box to slide + IShape textBox = shapes.AddTextBox(100, 30, 100, 200); + //Add a paragraph with text content. + IParagraph paragraph = textBox.TextBody.AddParagraph("This is a Text Box"); + //Remove specific shape from collection + shapes.Remove(textBox); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for shapes collection + Dim shapes As IShapes = slide.Shapes + 'Add text box to slide + Dim textBox As IShape = shapes.AddTextBox(100, 30, 100, 200) + 'Add a paragraph with text content. + Dim paragraph As IParagraph = textBox.TextBody.AddParagraph("This is a Text Box") + 'Remove specific shape from collection + shapes.Remove(textBox) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Returns the zero-based index of the first occurrence of the specified within the shape collection. + + The instance to locate. + Returns the zero-based index of the first occurrence of specified slide item within the shape collection, if found; otherwise, –1. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for shapes collection + IShapes shapes = slide.Shapes; + //Add text box to slide + IShape textBox = shapes.AddTextBox(100, 30, 100, 200); + //Add a paragraph with text content. + IParagraph paragraph = textBox.TextBody.AddParagraph("This is a Text Box"); + //Get the index of specific shape + int index = shapes.IndexOf(textBox); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for shapes collection + Dim shapes As IShapes = slide.Shapes + 'Add text box to slide + Dim textBox As IShape = shapes.AddTextBox(100, 30, 100, 200) + 'Add a paragraph with text content. + Dim paragraph As IParagraph = textBox.TextBody.AddParagraph("This is a Text Box") + 'Get the index of specific shape + Dim index As Integer = shapes.IndexOf(textBox) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes all the elements from shape collection. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for shapes collection + IShapes shapes = slide.Shapes; + //Add text box to slide + IShape textBox = shapes.AddTextBox(100, 30, 100, 200); + //Add a paragraph with text content. + IParagraph paragraph = textBox.TextBody.AddParagraph("This is a Text Box"); + //Clear the shapes + shapes.Clear(); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for shapes collection + Dim shapes As IShapes = slide.Shapes + 'Add text box to slide + Dim textBox As IShape = shapes.AddTextBox(100, 30, 100, 200) + 'Add a paragraph with text content. + Dim paragraph As IParagraph = textBox.TextBody.AddParagraph("This is a Text Box") + 'Clear the shapes + shapes.Clear() + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Adds a new chart to the shape collection. + + Represents the left position, in points. The Left value ranges from -169056 to 169056. + Represents the top position, in points. The Top value ranges from -169056 to 169056. + Represents the width, in points. The Width value ranges from 0 to 169056. + Represents the height, in points. The Height value ranges from 0 to 169056. + Returns an instance this method creates. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for shapes collection + IShapes shapes = slide.Shapes; + //Add chart to slide + IPresentationChart chart =shapes.AddChart(400, 300, 100, 100); + //Set the fore color of the chart area. + chart.ChartArea.Fill.ForeColor = Color.AliceBlue; + //Set the chart title + chart.ChartTitle = "Chart"; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for shapes collection + Dim shapes As IShapes = slide.Shapes + 'Add chart to slide + Dim chart As IPresentationChart = shapes.AddChart(400, 300, 100, 100) + 'Set the fore color of the chart area. + chart.ChartArea.Fill.ForeColor = Color.AliceBlue + 'Set the chart title + chart.ChartTitle = "Chart" + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Creates a chart for the data in specified excel document and adds the chart to the shape collection. + + Excel document stream having the data for chart[Only the "*.xlsx" format is supported]. + Worksheet number of the excel document. + Data range in the worksheet for the chart to be created. + Position and size of the chart, in points. + Returns an instance this method creates. + + + //Creates a Presentation instance + IPresentation pptxDoc = Presentation.Create(); + //Adds a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Gets the excel file as stream + FileStream excelStream = new FileStream("Book1.xlsx", FileMode.Open); + //Adds a chart to the slide with a data range from excel worksheet – excel workbook, worksheet number, Data range, position, and size. + IPresentationChart chart = slide.Charts.AddChart(excelStream, 1, "A1:D4", new RectangleF(100, 10, 700, 500)); + //Save the presentation + pptxDoc.Save("Output.pptx"); + //Closes the Presentation + pptxDoc.Close(); + + + 'Creates a Presentation instance + Dim pptxDoc As IPresentation = Presentation.Create() + 'Adds a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Gets the excel file as stream + Dim excelStream As New MemoryStream(File.ReadAllBytes("Book1.xlsx")) + 'Adds a chart to the slide with a data range from excel worksheet – excel workbook, worksheet number, Data range, position, and size. + Dim chart As IPresentationChart = slide.Charts.AddChart(excelStream, 1, "A1:D4", New RectangleF(100, 10, 700, 500)) + 'Saves the Presentation + pptxDoc.Save("output.pptx") + 'Closes the Presentation + pptxDoc.Close() + + + + + + + Creates a chart from the specified enumerable and adds the chart to the shape collection. + + Specifies the object with desired data + Represents the left position, in points. The Left value ranges from -169056 to 169056. + Represents the top position, in points. The Top value ranges from -169056 to 169056. + Represents the width, in points. The Width value ranges from 0 to 169056. + Represents the height, in points. The Height value ranges from 0 to 169056. + Returns an instance this method creates. + + + Represents the left position, in points. The Left value ranges from -169056 to 169056. + Represents the top position, in points. The Top value ranges from -169056 to 169056. + Represents the width, in points. The Width value ranges from 0 to 169056. + Represents the height, in points. The Height value ranges from 0 to 169056. + Returns an instance this method creates. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for shapes collection + IShapes shapes = slide.Shapes; + //Get the image from file path + Image image = Image.FromFile("Image.gif"); + // Add the image to the slide by specifying position and size + shapes.AddPicture(new MemoryStream(image.ImageData), 300, 120, 70, 40); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for shapes collection + Dim shapes As IShapes = slide.Shapes + 'Get the image from file path + Dim image__2 As Image = Image.FromFile("Image.gif") + ' Add the image to the slide by specifying position and size + shapes.AddPicture(New MemoryStream(image__2.ImageData), 300, 120, 70, 40) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Creates a picture from the specified svg, its fallback image stream and adds the picture to the shape collection. + + The instance of SVG image. + The instance of fallback image. + Represents the left position, in points. The Left value ranges from -169056 to 169056. + Represents the top position, in points. The Top value ranges from -169056 to 169056. + Represents the width, in points. The Width value ranges from 0 to 169056. + Represents the height, in points. The Height value ranges from 0 to 169056. + Returns an instance. + + + //Create a new presentation. + IPresentation presDoc = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Create instance for shapes collection + IShapes shapes = slide.Shapes; + //Create an instance for fallback image as stream + Stream imageStream = File.Open("Image.gif", FileMode.Open); + //Create an instance for vector image as stream + Stream svgStream = File.Open("Image.svg", FileMode.Open); + // Add the image to the slide by specifying position and size + shapes.AddPicture(svgStream, imageStream, 300, 120, 70, 40); + //Save the presentation + presDoc.Save("Sample.pptx"); + //Close the presentation + presDoc.Close(); + + + 'Create a new presentation. + Dim presDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + 'Create instance for shapes collection + Dim shapes As IShapes = slide.Shapes + 'Create an instance for fallback image as stream + Dim imageStream As Stream = File.Open("Image.gif", FileMode.Open) + 'Create an instance for vector image as stream + Dim svgStream As Stream = File.Open("Image.svg", FileMode.Open) + 'Add the image to the slide by specifying position and size + shapes.AddPicture(svgStream, imageStream, 300, 120, 70, 40) + 'Save the presentation + presDoc.Save("Sample.pptx") + 'Close the presentation + presDoc.Close() + + + + + + Creates a shape for the specified and adds the shape to the shape collection. + + Determines the auto shape type. + Represents the left position, in points. The Left value ranges from -169056 to 169056. + Represents the top position, in points. The Top value ranges from -169056 to 169056. + Represents the width, in points. The Width value ranges from 0 to 169056. + Represents the height, in points. The Height value ranges from 0 to 169056. + Returns an instance this method creates. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for shapes collection + IShapes shapes = slide.Shapes; + //Add auto shape - rectangle to slide + IShape shape = shapes.AddShape(AutoShapeType.Rectangle,300,200,150,200); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for shapes collection + Dim shapes As IShapes = slide.Shapes + 'Add auto shape - rectangle to slide + Dim shape As IShape = shapes.AddShape(AutoShapeType.Rectangle, 300, 200, 150, 200) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Adds a to the shape collection of a Slide. + + Determines the connector type + Represents the begin X of connector. The begin X value ranges from -169055 to 169056. + Represents the begin Y of connector. The begin Y value ranges from -169055 to 169056. + Represents the end X of connector. The end X value ranges from -169055 to 169056. + Represents the end Y of connector. The end Y value ranges from -169055 to 169056. + Returns an instance this method creates. + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add a Rectangle shape on the slide + IShape rectangle = slide.Shapes.AddShape(AutoShapeType.Rectangle, 200, 200, 250, 250); + // Add a Oval shape on the slide + IShape oval = slide.Shapes.AddShape(AutoShapeType.Rectangle, 600, 100, 250, 250); + // Add connector on the slide and connect the end points of connector + IConnector connector = slide.Shapes.AddConnector(ConnectorType.Straight, rectangle, 0, oval, 3); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + ' Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + ' Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + ' Add Rectangle shape on the slide + Dim rectangle As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 200, 200, 250, 250) + ' Add Oval shae on the slide + Dim oval As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 600, 100, 250, 250) + ' Add connector on the slide and connect the end points of connector + Dim connector As IConnector = slide.Shapes.AddConnector(ConnectorType.Straight, rectangle, 0, oval, 3) + ' Save the presentation file + ppDoc.Save("Sample.pptx") + ' Close the presentation file + ppDoc.Close + + + + + + Adds a to the shape collection of a Slide. + + Determines the connector type + Represents the begin X of connector. The begin X value ranges from -169055 to 169056. + Represents the begin Y of connector. The begin Y value ranges from -169055 to 169056. + Represents the end X of connector. The end X value ranges from -169055 to 169056. + Represents the end Y of connector. The end Y value ranges from -169055 to 169056. + Returns an instance this method creates. + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add connector on the slide + IConnector connector = slide.Shapes.AddConnector(ConnectorType.Straight, 150, 150, 300, 300); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + ' Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + ' Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + ' Add connector on the slide + Dim connector As IConnector = slide.Shapes.AddConnector(ConnectorType.Straight, 150, 150, 300, 300) + ' Save the presentation file + ppDoc.Save("Sample.pptx") + ' Close the presentation file + ppDoc.Close + + + + + + Adds a to the shape collection of a Slide. + + Represents the left position, in points. The left value ranges from -169056 to 169056. + Represents the top position, in points. The top value ranges from -169056 to 169056. + Represents the width, in points. The width value ranges from 0 to 169056. + Represents the height, in points. The height value ranges from 0 to 169056. + The SmartArt type to add. + Returns an instance that represents the new SmartArt diagram. + + + // Create an instance of PowerPoint Presentation + IPresentation pptxDoc = Presentation.Create(); + //Add a blank slide to the Presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Add a BasicBlockList SmartArt to the slide at the specified size and position. + ISmartArt smartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 100, 50, 640, 426); + //Save the PowerPoint Presentation. + pptxDoc.Save("Sample.pptx"); + //Close the Presentation + pptxDoc.Close(); + + + 'Create an instance of PowerPoint Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the Presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a BasicBlockList SmartArt to the slide at the specified size and position. + Dim smartArt As ISmartArt = slide.Shapes.AddSmartArt(SmartArtType.BasicBlockList, 100, 50, 640, 426) + 'Save the Presentation + pptxDoc.Save("Sample.pptx") + 'Close the Presentation + pptxDoc.Close() + + + + + + Creates an instance with the specified image, program id, and data, then adds it to the collection. + + Image used to be displayed + The ProgID of the object to be embedded + File stream from which the object is to be created + + + //Create new instance of PowerPoint presentation. + IPresentation pptxDoc = Presentation.Create(); + //Add slide with blank layout to presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Get the excel file as stream + Stream excelStream = File.Open("OleTemplate.xlsx", FileMode.Open); + //Image to be displayed, This can be any image + Stream imageStream = File.Open("OlePicture.png", FileMode.Open); + //Add an OLE object to the slide + IOleObject oleObject = slide.Shapes.AddOleObject(imageStream, "Excel.Sheet.12", excelStream); + //Set size and position of the OLE object + oleObject.Left = 10; + oleObject.Top = 10; + oleObject.Width = 400; + oleObject.Height = 300; + //Save the presentation + pptxDoc.Save("Sample.pptx"); + //Close the presentation + pptxDoc.Close(); + + + 'Create new instance of PowerPoint presentation. + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add slide with blank layout to presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Get the excel file as stream + Dim excelStream As Stream = File.Open("OleTemplate.xlsx", FileMode.Open) + 'Image to be displayed, This can be any image + Dim imageStream As Stream = File.Open("OlePicture.png", FileMode.Open) + 'Add an OLE object to the slide + Dim oleObject As IOleObject = slide.Shapes.AddOleObject(imageStream, "Excel.Sheet.12", excelStream) + 'Set size and position of the OLE object + oleObject.Left = 10 + oleObject.Top = 10 + oleObject.Width = 400 + oleObject.Height = 300 + 'Save the presentation + pptxDoc.Save("Sample.pptx") + 'Close the presentation + pptxDoc.Close() + + + + + + Creates an instance with the specified image, program id, and data, then adds it to the collection. + + Image used to be displayed + The ProgID of the object to be embedded + String path from which the object is to be created + + + //Create new instance of PowerPoint presentation. + IPresentation pptxDoc = Presentation.Create(); + //Add slide with blank layout to presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Image to be displayed, This can be any image + Stream imageStream = File.Open("OlePicture.png", FileMode.Open); + //Add an OLE object to the slide + IOleObject oleObject = slide.Shapes.AddOleObject(imageStream, "Excel.Sheet.12", "OleTemplate.xlsx"); + //Set size and position of the OLE object + oleObject.Left = 10; + oleObject.Top = 10; + oleObject.Width = 400; + oleObject.Height = 300; + //Save the presentation + pptxDoc.Save("Sample.pptx"); + //Close the presentation + pptxDoc.Close(); + + + 'Create new instance of PowerPoint presentation. + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add slide with blank layout to presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Image to be displayed, This can be any image + Dim imageStream As Stream = File.Open("OlePicture.png", FileMode.Open) + 'Add an OLE object to the slide + Dim oleObject As IOleObject = slide.Shapes.AddOleObject(imageStream, "Excel.Sheet.12", "OleTemplate.xlsx") + 'Set size and position of the OLE object + oleObject.Left = 10 + oleObject.Top = 10 + oleObject.Width = 400 + oleObject.Height = 300 + 'Save the presentation + pptxDoc.Save("Sample.pptx") + 'Close the presentation + pptxDoc.Close() + + + + + + Creates a group shape and adds the group shape to the shape collection. + + Represents the left position, in points. The Left value ranges from -169056 to 169056. + Represents the top position, in points. The Top value ranges from -169056 to 169056. + Represents the width, in points. The Width value ranges from 0 to 169056. + Represents the height, in points. The Height value ranges from 0 to 169056. + Returns an instance this method creates. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for shapes collection + IShapes shapes = slide.Shapes; + //Add a group shape to the slide + IGroupShape groupShape = shapes.AddGroupShape(12, 12, 200, 200); + //Add auto shapes to group shape + groupShape.Shapes.AddShape(AutoShapeType.Oval, 47, 50, 60, 120); + groupShape.Shapes.AddShape(AutoShapeType.Rectangle, 12, 12, 40, 30); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for shapes collection + Dim shapes As IShapes = slide.Shapes + 'Add a group shape to the slide + Dim groupShape As IGroupShape = shapes.AddGroupShape(12, 12, 200, 200) + 'Add auto shapes to group shape + groupShape.Shapes.AddShape(AutoShapeType.Oval, 47, 50, 60, 120) + groupShape.Shapes.AddShape(AutoShapeType.Rectangle, 12, 12, 40, 30) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Adds a new table to the shape collection with the specified number of rows and columns. The valid range is 1 to 75. + + Represents the number of rows. The valid range is 1 to 75. + Represents the number of columns. The valid range is 1 to 75 + Represents the left position, in points. The Left value ranges from -169056 to 169056. + Represents the top position, in points. The Top value ranges from -169056 to 169056. + Represents the width, in points. The Width value ranges from 0 to 169056. + Represents the height, in points. The Height value ranges from 0 to 169056. + Returns an instance this method creates. + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for shapes collection + IShapes shapes = slide.Shapes; + //Add table to the shape collection + ITable table = shapes.AddTable(2, 2, 100, 120, 300, 200); + //Retrieve each cell and fill text content to the cell. + ICell cell = table[0, 0]; + cell.TextBody.AddParagraph("First Row and First Column"); + cell = table[0, 1]; + cell.TextBody.AddParagraph("First Row and Second Column"); + cell = table[1, 0]; + cell.TextBody.AddParagraph("Second Row and First Column"); + cell = table[1, 1]; + cell.TextBody.AddParagraph("Second Row and Second Column"); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for shapes collection + Dim shapes As IShapes = slide.Shapes + 'Add table to the shape collection + Dim table As ITable = shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Retrieve each cell and fill text content to the cell. + Dim cell As ICell = table(0, 0) + cell.TextBody.AddParagraph("First Row and First Column") + cell = table(0, 1) + cell.TextBody.AddParagraph("First Row and Second Column") + cell = table(1, 0) + cell.TextBody.AddParagraph("Second Row and First Column") + cell = table(1, 1) + cell.TextBody.AddParagraph("Second Row and Second Column") + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Adds a new text box to the shape collection. + + Represents the left position, in points. The Left value ranges from -169056 to 169056. + Represents the top position, in points. The Top value ranges from -169056 to 169056. + Represents the width, in points. The Width value ranges from 0 to 169056. + Represents the height, in points. The Height value ranges from 0 to 169056. + Returns an instance this method creates. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for shapes collection + IShapes shapes = slide.Shapes; + //Add text box to slide + IShape textBox = shapes.AddTextBox(100, 30, 100, 200); + //Add a paragraph with text content. + IParagraph paragraph = textBox.TextBody.AddParagraph("This is a Text Box"); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for shapes collection + Dim shapes As IShapes = slide.Shapes + 'Add text box to slide + Dim textBox As IShape = shapes.AddTextBox(100, 30, 100, 200) + 'Add a paragraph with text content. + Dim paragraph As IParagraph = textBox.TextBody.AddParagraph("This is a Text Box") + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the number of elements in the shape collection. Read-only. + + + The count. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for shapes collection + IShapes shapes = slide.Shapes; + //Add auto shape - rectangle to slide + IShape shape = shapes.AddShape(AutoShapeType.Rectangle,300,200,150,200); + //Add chart to slide + IPresentationChart chart =shapes.AddChart(500, 300, 100, 100); + //Set the chart title + chart.ChartTitle = "Chart"; + //Get the count for shape collection + int count = shapes.Count; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for shapes collection + Dim shapes As IShapes = slide.Shapes + 'Add auto shape - rectangle to slide + Dim shape As IShape = shapes.AddShape(AutoShapeType.Rectangle, 300, 200, 150, 200) + 'Add chart to slide + Dim chart As IPresentationChart = shapes.AddChart(500, 300, 100, 100) + 'Set the chart title + chart.ChartTitle = "Chart" + 'Get the count for shape collection + Dim count As Integer = shapes.Count + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a instance at the specified index from the shape collection. Read-only. + + Specifies the slide item index to locate. + Returns an instance. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.TitleAndContent); + //Get the shape collection of slide + IShapes shapes = slide.Shapes; + //Create instance for SlideItem + ISlideItem slideItem = shapes[0]; + //Set the description for slide item + slideItem.Description = "This is a SlideItem"; + //Set the title + slideItem.Title = "SlideItem"; + //Add the slide item + shapes.Add(slideItem); + //Save the presentation + presentation.Save("Cells.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.TitleAndContent) + 'Get the shape collection of slide + Dim shapes As IShapes = slide.Shapes + 'Create instance for SlideItem + Dim slideItem As ISlideItem = shapes(0) + 'Set the description for slide item + slideItem.Description = "This is a SlideItem" + 'Set the title + slideItem.Title = "SlideItem" + 'Add the slide item + shapes.Add(slideItem) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a PlaceholderTypes available in current shape collection. + + Returns PlaceholderTypes available in current shape collection. + + + + Compares the content and properties of the current Shapes collection with given Shapes collection. + + The Shapes collection to compare with the current instance. + True if the content and properties of the Shapes collections are equal; otherwise, false. + + + + Sets the frame values (left, top, width, height) of a shape based on its placeholder bounds, + if the shape is a placeholder and has valid placeholder data. + + + The instance representing the shape to update. + + + This method checks if the provided shape is of type and + has a placeholder. If so, it updates the shape's frame to match the bounds of the placeholder. + + + + + Adds a chart to the slide. + + The left position of the chart from left edge of the slide, in points. + The top position of the chart from top edge of the slide, in points + Width of the chart, in points + Height of the chart, in points + Returns chart object. + + + + Adds a chart to the slide. + + Excel stream that has data for chart[Excel stream should be "*.xlsx" format] + Worksheet number in the excel document that contains data for a chart. + Data range in the worksheet from which the chart to be created. + Position of the chart in the slide. + + + + + Method to identify the Excel file format + + Excel file stream + + + + + Adds a chart to the slide. + + Chart data in 2-dimensional array format. + The left position of the chart from left edge of the shape, in points + The top position of the chart from top edge of the shape, in points + The width of the chart, in points + The height of the chart, in points. + Returns chart object. + + + + Adds a chart to the slide. + + IEnumerable object with desired data + The left position of the chart from left edge of the shape, in points + The top position of the chart from top edge of the shape, in points + The width of the chart, in points + The height of the chart, in points. + Returns chart object. + + + + Adds a to the shape collection of a Slide. + + Represents the left position, in points. The left value ranges from -169056 to 169056. + Represents the top position, in points. The top value ranges from -169056 to 169056. + Represents the width, in points. The width value ranges from 0 to 169056. + Represents the height, in points. The height value ranges from 0 to 169056. + The SmartArt type to add. + Returns an instance that represents the new SmartArt diagram. + + + + Add a SVG image within the current shape + + Represent the Svg Picture stream + Represent the raster Picture stream + Represent the left side position + Represent the top position + Represent the width + Represent the height + retruns a IPicture instance + + + + Adds the placeholder to the current shape collection + + Determines the type of placeholder + Left position of the placeholder. + Top position of the placeholder. + Width of the placeholder. + Height of the placeholder. + Returns the IPlaceholderFormat object. + + + + Finds all the occurance of the given word from shapes using Regex pattern + + + Array of text selection + + + + Find the first occurance of the given word using Regex pattern + + + Text selection + + + + Adds the OleObject to the current shape collection + + Determines the OleObject + Determines the pictureStream of the OleObject + Determines the type of the OleObject . + Determines the stream of OleObject + Determines the path of the OleObject + + + + Finds all the given text from the SmartArt shape using Regex Pattern. + + Represent main smart art nodes need to find. + Represents regex pattern used to find. + The collection that contains all the entries of the found text in the document. + + + + Find the first occurrence of the given word using Regex pattern. + + Represent main smart art nodes need to find. + Represents regex pattern used to find. + The that contains the found text in the document. + + + + Updates the hyperlink relations in the parent slide for the specified slide item. + + The slide item whose hyperlink relations need to be updated. + + + + Updates the hyperlink relations for all text parts within the specified text body. + + The text body containing paragraphs with hyperlinks. + + + + Converts a placeholder to a shape if the current slide is either a master slide or a notes slide. + + The slide item representing the placeholder that will be converted to a shape. + + + + Gets or sets height value. + + + + + Gets or sets left position value. + + + + + Gets or sets top position value. + + + + + Gets or sets width value. + + + + + Represents the solid type fill formatting. + + + + + Gets or sets the color for the solid fill. + + + The color of the solid fill. + + + Uses 'ColorObject' type to apply the color. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for slide background + IBackground background = slide.Background; + //Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid; + //Create instance for solid Fill + ISolidFill solidFill = background.Fill.SolidFill; + //Set the color for solid fill object + solidFill.Color = ColorObject.FromArgb(120, 234, 67, 89); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for slide background + Dim background As IBackground = slide.Background + 'Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid + 'Create instance for solid Fill + Dim solidFill As ISolidFill = background.Fill.SolidFill + 'Set the color for solid fill object + solidFill.Color = ColorObject.FromArgb(120, 234, 67, 89) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the transparency in percentage. Ranges from 1 to 100. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for slide background + IBackground background = slide.Background; + //Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid; + //Create instance for solid Fill + ISolidFill solidFill = background.Fill.SolidFill; + //Set the color for solid fill object + solidFill.Color = ColorObject.FromArgb(120, 234, 67, 89); + //Set the color transparency + solidFill.Transparency = 30; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for slide background + Dim background As IBackground = slide.Background + 'Set the fill type for background as Solid fill + background.Fill.FillType = FillType.Solid + 'Create instance for solid Fill + Dim solidFill As ISolidFill = background.Fill.SolidFill + 'Set the color for solid fill object + solidFill.Color = ColorObject.FromArgb(120, 234, 67, 89) + 'Set the color transparency + solidFill.Transparency = 30 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Compares the current Solid fill object with given Solid fill object. + + The Solid fill object to compare with the current instance. + True if the Solid fill objects are equal; otherwise, false. + + + + Represents the picture or texture type in fill format. + + + + + Represents the picture or texture type in fill format. + + + + + Gets or sets the transparency of the image. + + + + + Gets or sets the image as byte. + + + + + Gets or sets the value of type enumeration. + + + + + Compares the current TextureFill object with given TextureFill object. + + The TextureFill object to compare with the current instance. + True if the TextureFill objects are equal; otherwise, false. + + + + Gets or sets top position of the background image. + OffsetTop values ranges from - 2147483.647 to 2147483.647, in Percentage. + + + + + Gets or sets the threshold value. + + + + + Gets or sets the grayScale value. + + + + + Gets or sets left position of the background image. + OffsetLeft values ranges from - 2147483.647 to 2147483.647, in Percentage. + + + + + Gets or sets height of the background image. + OffsetBottom values ranges from - 2147483.647 to 2147483.647, in Percentage. + + + + + Gets or sets width of the background image. + OffsetRight values ranges from - 2147483.647 to 2147483.647, in Percentage. + + + + + Gets or sets OffsetX of the background image. + The OffsetX value ranges from - 2147483648 to 2147483647, in Points. + + + + + Gets or sets OffsetY of the background image. + The OffsetY value ranges from - 2147483648 to 2147483647, in Points. + + + + + Gets or sets ScaleX of the background image. + The ScaleX value ranges from - 2147483.648 to 2147483.647, in Percentage. + + + + + Gets or sets ScaleX of the background image. + The ScaleX value ranges from - 2147483.648 to 2147483.647, in Percentage. + + + + + Gets or sets the transparency of the image. + + + + + Gets or sets the image as byte. + + + + + Gets or sets the value of type enumeration. + + + + + Represents a header, footer, date and time, slide number on a slide or master. + + + All the IHeaderFooter objects for a slide or master are contained in a IHeadersFooters object. + + + + + Represents a header, footer, date and time, slide number on a slide or master. + + + All the IHeaderFooter objects for a slide or master are contained in a IHeadersFooters object. + + + + + Gets or sets the visibility of IHeaderFooter object for the specified slide. + + + Visibility of HeaderFooter is only applied, when specified HeaderFooter is exist in parent slide. + + + + //Creates an instance of Presentation + IPresentation pptxDoc = Presentation.Create(); + //Adds a blank slide. + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Gets the footer of the slide. + IHeaderFooter footer = slide.HeadersFooters.Footer; + //Sets the visibility of Footer content in the slide + footer.Visible = true; + //Sets the text to be added to the Footer + footer.Text = "Footer content"; + //Add an auto shape to slide + slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 250, 250); + //Saves the Presentation to the file system + pptxDoc.Save("Sample.pptx"); + //Closes the Presentation + pptxDoc.Close(); + + + 'Creates an instance of Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Adds a blank slide + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Gets the footer of the slide. + Dim footer As IHeaderFooter = slide.HeadersFooters.Footer + 'Sets the visibility of Footer content in the slide + footer.Visible = True + 'Sets the text to be added to the Footer + footer.Text = "Footer content" + 'Add an auto shape to slide + slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 250, 250) + 'Saves the Presentation to the file system + pptxDoc.Save("Sample.pptx") + 'Closes the Presentation + pptxDoc.Close() + + + + + + Gets or sets a text from IHeaderFooter object for the specified slide. + + + If sets a value to Text property of DateAndTime or SlideNumber, it will be displayed as fixed text. + + + + //Creates an instance of Presentation + IPresentation pptxDoc = Presentation.Create(); + //Adds a blank slide. + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Sets the visibility of Footer content in the slide + slide.HeadersFooters.Footer.Visible = true; + //Gets the footer of the slide. + IHeaderFooter footer = slide.HeadersFooters.Footer; + //Sets the text to be added to the Footer + footer.Text = "Footer content"; + //Add an auto shape to slide + slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 250, 250); + //Saves the Presentation to the file system + pptxDoc.Save("Sample.pptx"); + //Closes the Presentation + pptxDoc.Close(); + + + 'Creates an instance of Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Adds a blank slide + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Sets the visibility of Footer content in the slide + slide.HeadersFooters.Footer.Visible = True + 'Gets the footer of the slide. + Dim footer As IHeaderFooter = slide.HeadersFooters.Footer + 'Sets the text to be added to the Footer + footer.Text = "Footer content" + 'Add an auto shape to slide + slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 250, 250) + 'Saves the Presentation to the file system + pptxDoc.Save("Sample.pptx") + 'Closes the Presentation + pptxDoc.Close() + + + + + + Gets or sets a date and time format of Date placeholder for the specified slide. + + + Used to represent DateTimeFormat of a Date placeholder and will not valid for Header, Footer and SlideNumber placeholders. + + + + //Creates an instance of Presentation + IPresentation pptxDoc = Presentation.Create(); + //Adds a blank slide. + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Sets the visibility of Date and Time in the slide + slide.HeadersFooters.DateAndTime.Visible = true; + //Gets the DateTime header footer of the slide. + IHeaderFooter headerFooter = slide.HeadersFooters.DateAndTime; + //Sets the format of the Date and Time to the Footer + headerFooter.Format = DateTimeFormatType.DateTimehmmAMPM; + //Add an auto shape to slide + slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 250, 250); + //Saves the Presentation to the file system + pptxDoc.Save("Sample.pptx"); + //Closes the Presentation + pptxDoc.Close(); + + + 'Creates an instance of Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Adds a blank slide + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Sets the visibility of Date and Time in the slide + slide.HeadersFooters.DateAndTime.Visible = True + 'Gets the DateTime header footer of the slide. + Dim headerFooter As IHeaderFooter = slide.HeadersFooters.DateAndTime + 'Sets the format of the Date and Time to the Footer + headerFooter.Format = DateTimeFormatType.DateTimehmmAMPM + 'Add an auto shape to slide + slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 250, 250) + 'Saves the Presentation to the file system + pptxDoc.Save("Sample.pptx") + 'Closes the Presentation + pptxDoc.Close() + + + + + + Gets a HeaderFooter shape instance of provided HeaderFooterType. + + Specify a headerFooter type + Returns a HeaderFooter shape instance for the specified HeaderFooterType + + + + Add the specified header footer shape into slide. + + Represent the HeaderFooterType to add. + + + + Applies a parent shape text field properties into newly created shape. + + Represent a newly created header footer shape. + Represent a parent shape. + + + + Applies a common place holder properties to newly created headerFooterShape. + + Represent the headerFooterShape to apply the properties. + + + + Gets a constant index value for the header footer shape. + + Returns a header footer constant index. + + + + Remove the specified header footer shape from a slide. + + Represent the HeaderFooterType to remove. + + + + Clone a HeaderFooter class instances + + + + + + Set a new parent slide. + + + + + + Gets or sets the visibility of IHeaderFooter object for the specified slide. + + + Visibility of HeaderFooter is only applied, when specified HeaderFooter is exist in parent slide. + + + + + Gets or sets a text from IHeaderFooter object for the specified slide. + + + If sets a value to Text property of DateAndTime or SlideNumber, it will be displayed as fixed text. + + + + + Gets or sets a date and time format of Date placeholder for the specified slide. + + + Used to represent DateTimeFormat of a Date placeholder and will not valid for Header, Footer and SlideNumber placeholders. + + + + + Gets a owner slide of HeaderFooter + + + + + Gets a type of HeaderFooter + + + + + Represent a collection of IHeaderFooter object. + + + It contains all the IHeaderFooter objects on the specified slide, notes slide, or master. + + + + + Contains all the IHeaderFooter objects on the specified slide, notes slide, or master. + + + + + Gets an IHeaderFooter object that represents a DateAndTime item that appears in the lower-left corner of a slide or in the upper-right corner of a notes slide. + + + + //Creates an instance of Presentation + IPresentation pptxDoc = Presentation.Create(); + //Adds a blank slide. + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Gets the date time header footer of the slide. + IHeaderFooter dateTimeFooter = slide.HeadersFooters.DateAndTime; + //Sets the visibility of Date and Time in the slide + dateTimeFooter.Visible = true; + //Sets the format of the Date and Time to the Footer + dateTimeFooter.Format = DateTimeFormatType.DateTimehmmssAMPM; + //Add an auto shape to slide + slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 250, 250); + //Saves the Presentation to the file system + pptxDoc.Save("Sample.pptx"); + //Closes the Presentation + pptxDoc.Close(); + + + 'Creates an instance of Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Adds a blank slide + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Gets the date time header footer of the slide. + Dim dateTimeFooter As IHeaderFooter = slide.HeadersFooters.DateAndTime + 'Sets the visibility of Date and Time in the slide + dateTimeFooter.Visible = True + 'Sets the format of the Date and Time to the Footer + dateTimeFooter.Format = DateTimeFormatType.DateTimehmmssAMPM + 'Add an auto shape to slide + slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 250, 250) + 'Saves the Presentation to the file system + pptxDoc.Save("Sample.pptx") + 'Closes the Presentation + pptxDoc.Close() + + + + + + Gets an IHeaderFooter object that represents the SlideNumber in the lower-right corner of a slide, or the page number in the lower-right corner of a notes slide. + + + + //Creates an instance of Presentation + IPresentation pptxDoc = Presentation.Create(); + //Adds a blank slide. + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Sets the visibility of slide number in the slide + slide.HeadersFooters.SlideNumber.Visible = true; + //Add an auto shape to slide + slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 250, 250); + //Saves the Presentation to the file system + pptxDoc.Save("Sample.pptx"); + //Closes the Presentation + pptxDoc.Close(); + + + 'Creates an instance of Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Adds a blank slide + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Sets the visibility of slide number in the slide + slide.HeadersFooters.SlideNumber.Visible = True + 'Add an auto shape to slide + slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 250, 250) + 'Saves the Presentation to the file system + pptxDoc.Save("Sample.pptx") + 'Closes the Presentation + pptxDoc.Close() + + + + + + Gets an IHeaderFooter object that represents a Header that appears at the top-left corner of a notes slide. + + + Header is valid only for Notes slide. + + + + //Creates an instance of Presentation + IPresentation pptxDoc = Presentation.Create(); + //Adds a blank slide. + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Adds new notes slide in the specified slide. + INotesSlide notesSlide = slide.AddNotesSlide(); + //Adds text content into the Notes Slide. + notesSlide.NotesTextBody.AddParagraph("Notes content"); + //Gets the header of the notes slide. + IHeaderFooter header = notesSlide.HeadersFooters.Header; + //Sets the visibility of header content in the notes slide + header.Visible = true; + //Sets the text to be added to the header + header.Text = "Header content is added"; + //Add an auto shape to slide + slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 250, 250); + //Saves the Presentation. + pptxDoc.Save("Sample.pptx"); + //Closes the Presentation + pptxDoc.Close(); + + + 'Creates an instance of Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Adds a blank slide. + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Adds new notes slide in the specified slide. + Dim notesSlide As INotesSlide = slide.AddNotesSlide() + 'Adds text content into the Notes Slide. + notesSlide.NotesTextBody.AddParagraph("Notes content") + 'Gets the header of the notes slide. + Dim header As IHeaderFooter = notesSlide.HeadersFooters.Header + 'Sets the visibility of header content in the notes slide + header.Visible = True + 'Sets the text to be added to the header + header.Text = "Header content is added" + 'Add an auto shape to slide + slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 250, 250) + 'Saves the Presentation. + pptxDoc.Save("Sample.pptx") + 'Closes the Presentation + pptxDoc.Close() + + + + + + Gets an IHeaderFooter object that represents a Footer that appears at the bottom of a slide or in the lower-left corner of a notes slide. + + + + //Creates an instance of Presentation + IPresentation pptxDoc = Presentation.Create(); + //Adds a blank slide. + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Gets the footer of the slide. + IHeaderFooter footer = slide.HeadersFooters.Footer; + //Sets the visibility of Footer content in the slide + footer.Visible = true; + //Sets the text to be added to the Footer + footer.Text = "Footer content"; + //Add an auto shape to slide + slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 250, 250); + //Saves the Presentation to the file system + pptxDoc.Save("Sample.pptx"); + //Closes the Presentation + pptxDoc.Close(); + + + 'Creates an instance of Presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Adds a blank slide + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Gets the footer of the slide. + Dim footer As IHeaderFooter = slide.HeadersFooters.Footer + 'Sets the visibility of Footer content in the slide + footer.Visible = True + 'Sets the text to be added to the Footer + footer.Text = "Footer content" + 'Add an auto shape to slide + slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 250, 250) + 'Saves the Presentation to the file system + pptxDoc.Save("Sample.pptx") + 'Closes the Presentation + pptxDoc.Close() + + + + + + Set a parent base slide + + Represent a new parent slide. + + + + Dispose the HeaderFooter class instances. + + + + + Returns an IHeaderFooter object that represents a Header, which appears at the top-left corner of a notes slide. Read-only. + + + Header is only valid for the notes slide. + + + + + Returns an IHeaderFooter object that represents a Footer, which appears at bottom of a slide or in the lower-left corner of a notes slide. Read-only. + + + + + Returns an IHeaderFooter object that represents a DateAndTime item, which appears in the lower-left corner of a slide or in the upper-right corner of a notes slide. Read-only. + + + + + Returns an IHeaderFooter object that represents the SlideNumber in the lower-right corner of a slide, or in the lower-right corner of a notes slide. Read-only. + + + + + Gets a owner slide of HeadersFooters + + + + + + + + + + Specifies the date and time format of a Date placeholder. + + + + + Specifies the date time format is None + + + + + Specifies the date time format is Mdyy + + + + + Specifies the date time format is ddddMMMMddyyyy + + + + + Specifies the date time format is dMMMMyyyy + + + + + Specifies the date time format is MMMMdyyyy + + + + + Specifies the date time format is dMMMyy + + + + + Specifies the date time format is MMMMyy + + + + + Specifies the date time format is MMMyy + + + + + Specifies the date time format is MMddyyhmmAMPM + + + + + Specifies the date time format is MMddyyhmmssAMPM + + + + + Specifies the date time format is Hmm + + + + + Specifies the date time format is Hmmss + + + + + Specifies the date time format is hmmAMPM + + + + + Specifies the date time format is hmmssAMPM + + + + + Specifies the HeaderFooter instance type. + + + + + Specifies the paste options while copy and paste the slide in presentation. + + + + + Specifies to use the destination theme for the slide + + + + + Specifies to use the source theme of the slide + + + + + Specifies the type of slide item + + + + + Specifies the SlideItemType is unknown + + + + + Specifies the SlideItemType is picture + + + + + Specifies the SlideItemType is table + + + + + Specifies the SlideItemType is autoshape + + + + + Specifies the SlideItemType is GroupShape + + + + + Specifies the SlideItemType is connection shape + + + + + Specifies the SlideItemType is chart + + + + + Specifies the SlideItemType is placeholder + + + + + Specifies the SlideItemType is smart art. + + + + + Specifies the slide item is OLE Object. + + + + + Represents the gradient fill types in presentation. + + + + + This element specifies a linear gradient. + + + + + Gradient follows a radial path. + + + + + Gradient follows a rectangular path. + + + + + Gradient follows the shape. + + + + + Specifies the type of AutoMargin. + + + + + + Specifies the AutoMarginType is not defined + + + + + Specifies the AutoMarginType is text shape automatic fit + + + + + Specifies the AutoMarginType is normal automatic fit + + + + + Specifies the AutoMarginType is no automatic fit + + + + + Specifies the PowerPoint presentation format. + + + + + Specifies the PowerPoint presentation file format. + + + + + Specifies the macro-enabled PowerPoint presentation file format. + + + + + Specifies the PowerPoint template file format. + + + + + Specifies the macro-enabled PowerPoint template file format. + + + + + Specifies the types of lists that can be applied to the paragraph. + + + + + Specifies the ListType is not defined + + + + + Specifies the ListType is none + + + + + Specifies the ListType is numbered + + + + + Specifies the ListType is picture + + + + + Specifies the ListType is bulleted + + + + + + + + + + Specifies the hyper link color types. + + + + + Specifies hyperlink uses the hyperlink text color from the document’s theme. + + + + + Specifies that hyperlink uses the text color + + + + + Specifies the hyper link types in presentation. + + + + + Specifies the HyperLinkType is unknown + + + + + Specifies the HyperLinkType isThe no action + + + + + Specifies the HyperLinkType is hyperlink + + + + + Specifies the HyperLinkType is jump first slide + + + + + Specifies the HyperLinkType is jump previous slide + + + + + Specifies the HyperLinkType is jump next slide + + + + + Specifies the HyperLinkType is jump last slide + + + + + Specifies the HyperLinkType is jump end show + + + + + Specifies the HyperLinkType is jump last viewed slide + + + + + Specifies the HyperLinkType is jump specific slide + + + + + Specifies the HyperLinkType is open file + + + + + Specifies the HyperLinkType is start program + + + + + + + + + + Specifies the NumberedListStyle is arabic abjad dash + + + + + Specifies the NumberedListStyle is arabic alpha dash + + + + + Specifies the NumberedListStyle is kanji korean period + + + + + Specifies the NumberedListStyle is kanji korean plain + + + + + Specifies the NumberedListStyle is kanji simp chin database period + + + + + Specifies the NumberedListStyle is none + + + + + Specifies the NumberedListStyle is simp chin period + + + + + Specifies the NumberedListStyle is simp chin plain + + + + + Specifies the NumberedListStyle is trad chin period + + + + + Specifies the NumberedListStyle is trad chin plain + + + + + Specifies the NumberedListStyle is alpha lc paren both + + + + + Specifies the NumberedListStyle is alpha lc paren right + + + + + Specifies the NumberedListStyle is alpha lc period + + + + + Specifies the NumberedListStyle is alpha uc paren both + + + + + Specifies the NumberedListStyle is alpha uc paren right + + + + + Specifies the NumberedListStyle is alpha uc period + + + + + Specifies the NumberedListStyle is arabic database period + + + + + Specifies the NumberedListStyle is arabic database plain + + + + + Specifies the NumberedListStyle is arabic paren both + + + + + Specifies the NumberedListStyle is arabic paren right + + + + + Specifies the NumberedListStyle is arabic period + + + + + Specifies the NumberedListStyle is arabic plain + + + + + Specifies the NumberedListStyle is circle number database plain + + + + + Specifies the NumberedListStyle is circle number wd black plain + + + + + Specifies the NumberedListStyle is circle number wd white plain + + + + + Specifies the NumberedListStyle is hebrew alpha dash + + + + + Specifies the NumberedListStyle is hindi alpha1 period + + + + + Specifies the NumberedListStyle is hindi alpha period + + + + + Specifies the NumberedListStyle is hindi number paren right + + + + + Specifies the NumberedListStyle is hindi number period + + + + + Specifies the NumberedListStyle is roman lc paren both + + + + + Specifies the NumberedListStyle is roman lc paren right + + + + + Specifies the NumberedListStyle is roman lc period + + + + + Specifies the NumberedListStyle is roman uc paren both + + + + + Specifies the NumberedListStyle is roman uc paren right + + + + + Specifies the NumberedListStyle is roman uc period + + + + + Specifies the NumberedListStyle is thai alpha paren both + + + + + Specifies the NumberedListStyle is thai alpha paren right + + + + + Specifies the NumberedListStyle is thai alpha period + + + + + Specifies the NumberedListStyle is thai number paren both + + + + + Specifies the NumberedListStyle is thai number paren right + + + + + Specifies the NumberedListStyle is thai number period + + + + + Specifies the style of NumberedList for paragraphs. + + + + + Specifies the NumberedListStyle is alpha lc paren both + + + + + Specifies the NumberedListStyle is alpha lc paren right + + + + + Specifies the NumberedListStyle is alpha lc period + + + + + Specifies the NumberedListStyle is alpha uc paren both + + + + + Specifies the NumberedListStyle is alpha uc paren right + + + + + Specifies the NumberedListStyle is alpha uc period + + + + + Specifies the NumberedListStyle is arabic database period + + + + + Specifies the NumberedListStyle is arabic database plain + + + + + Specifies the NumberedListStyle is arabic paren both + + + + + Specifies the NumberedListStyle is arabic paren right + + + + + Specifies the NumberedListStyle is arabic period + + + + + Specifies the NumberedListStyle is arabic plain + + + + + Specifies the NumberedListStyle is circle number database plain + + + + + Specifies the NumberedListStyle is circle number wd black plain + + + + + Specifies the NumberedListStyle is circle number wd white plain + + + + + Specifies the NumberedListStyle is hebrew alpha dash + + + + + Specifies the NumberedListStyle is hindi alpha1 period + + + + + Specifies the NumberedListStyle is hindi alpha period + + + + + Specifies the NumberedListStyle is hindi number paren right + + + + + Specifies the NumberedListStyle is hindi number period + + + + + Specifies the NumberedListStyle is roman lc paren both + + + + + Specifies the NumberedListStyle is roman lc paren right + + + + + Specifies the NumberedListStyle is roman lc period + + + + + Specifies the NumberedListStyle is roman uc paren both + + + + + Specifies the NumberedListStyle is roman uc paren right + + + + + Specifies the NumberedListStyle is roman uc period + + + + + Specifies the NumberedListStyle is thai alpha paren both + + + + + Specifies the NumberedListStyle is thai alpha paren right + + + + + Specifies the NumberedListStyle is thai alpha period + + + + + Specifies the NumberedListStyle is thai number paren both + + + + + Specifies the NumberedListStyle is thai number paren right + + + + + Specifies the NumberedListStyle is thai number period + + + + + + + + + + Specifies the type of placeholder. + + + + + Specifies the placeholdertype is title. + + + + + Specifies the placeholdertype is body. + + + + + Specifies the placeholdertype is centertitle. + + + + + Specifies the placeholdertype is subtitle. + + + + + Specifies the placeholder type is vertical title. + + + + + Specifies the placeholder type is vertical body. + + + + + Specifies the placeholdertype is object. + + + + + Specifies the placeholdertype is chart. + + + + + Specifies the placeholdertype is bitmap. + + + + + Specifies the placeholdertype is media clip. + + + + + Specifies the placeholdertype is OrganizationChart. + + + + + Specifies the placeholdertype is table. + + + + + Specifies the placeholdertype is slidenumber. + + + + + Specifies the placeholdertype is header. + + + + + Specifies the placeholdertype is footer. + + + + + Specifies the placeholdertype is dateandtime. + + + + + Specifies the placeholder type is vertical object. + + + + + Specifies the placeholdertype is picture. + + + + + Specifies the placeholdertype is image. + + + + + Specifies the layout type of the slide. + + + + + Specifies the user-defined slide layout type. + + + + + Specifies the SlideLayoutType is title + + + + + Specifies the SlideLayoutType is section header + + + + + Specifies the SlideLayoutType is two content + + + + + Specifies the SlideLayoutType is comparison + + + + + Specifies the SlideLayoutType is title only + + + + + Specifies the SlideLayoutType is blank + + + + + Specifies the SlideLayoutType is content with caption + + + + + Specifies the SlideLayoutType is picture with caption + + + + + Specifies the SlideLayoutType is title and vertical text + + + + + Specifies the SlideLayoutType is vertical title and text + + + + + Specifies the SlideLayoutType is title and content + + + + + + + + + + Specifies the orientation of the slide in presentation. + + + + + Specifies the SlideOrientation is landscape + + + + + Specifies the SlideOrientation is portrait + + + + + Specifies the size type for the slide in presentation. + + + + + Specifies the SlideSizeType is on screen + + + + + Specifies the SlideSizeType is letter paper + + + + + Specifies the SlideSizeType is a4 paper + + + + + Specifies the SlideSizeType is slide35 mm + + + + + Specifies the SlideSizeType is overhead + + + + + Specifies the SlideSizeType is banner + + + + + Specifies the SlideSizeType is custom + + + + + Specifies the SlideSizeType is ledger + + + + + Specifies the SlideSizeType is a3 paper + + + + + Specifies the SlideSizeType is b4 iso paper + + + + + Specifies the SlideSizeType is b5 iso paper + + + + + Specifies the SlideSizeType is on screen16 x9 + + + + + Specifies the SlideSizeType is on screen16 X10 + + + + + Specifies the predefined styles of a table. + + + + + Specifies the BuiltInTableStyle is custom + + + + + Specifies the BuiltInTableStyle is none + + + + + Specifies the BuiltInTableStyle is medium style2 accent1 + + + + + Specifies the BuiltInTableStyle is medium style2 + + + + + Specifies the BuiltInTableStyle is no style no grid + + + + + Specifies the BuiltInTableStyle is themed style1 accent1 + + + + + Specifies the BuiltInTableStyle is themed style1 accent2 + + + + + Specifies the BuiltInTableStyle is themed style1 accent3 + + + + + Specifies the BuiltInTableStyle is themed style1 accent4 + + + + + Specifies the BuiltInTableStyle is themed style1 accent5 + + + + + Specifies the BuiltInTableStyle is themed style1 accent6 + + + + + Specifies the BuiltInTableStyle is no style table grid + + + + + Specifies the BuiltInTableStyle is themed style2 accent1 + + + + + Specifies the BuiltInTableStyle is themed style2 accent2 + + + + + Specifies the BuiltInTableStyle is themed style2 accent3 + + + + + Specifies the BuiltInTableStyle is themed style2 accent4 + + + + + Specifies the BuiltInTableStyle is themed style2 accent5 + + + + + Specifies the BuiltInTableStyle is themed style2 accent6 + + + + + Specifies the BuiltInTableStyle is light style1 + + + + + Specifies the BuiltInTableStyle is light style1 accent1 + + + + + Specifies the BuiltInTableStyle is light style1 accent2 + + + + + Specifies the BuiltInTableStyle is light style1 accent3 + + + + + Specifies the BuiltInTableStyle is light style1 accent4 + + + + + Specifies the BuiltInTableStyle is light style2 accent5 + + + + + Specifies the BuiltInTableStyle is light style1 accent6 + + + + + Specifies the BuiltInTableStyle is light style2 + + + + + Specifies the BuiltInTableStyle is light style2 accent1 + + + + + Specifies the BuiltInTableStyle is light style2 accent2 + + + + + Specifies the BuiltInTableStyle is light style2 accent3 + + + + + Specifies the BuiltInTableStyle is medium style2 accent3 + + + + + Specifies the BuiltInTableStyle is medium style2 accent4 + + + + + Specifies the BuiltInTableStyle is medium style2 accent5 + + + + + Specifies the BuiltInTableStyle is light style2 accent6 + + + + + Specifies the BuiltInTableStyle is light style2 accent4 + + + + + Specifies the BuiltInTableStyle is light style3 + + + + + Specifies the BuiltInTableStyle is light style3 accent1 + + + + + Specifies the BuiltInTableStyle is medium style2 accent2 + + + + + Specifies the BuiltInTableStyle is light style3 accent2 + + + + + Specifies the BuiltInTableStyle is light style3 accent3 + + + + + Specifies the BuiltInTableStyle is light style3 accent4 + + + + + Specifies the BuiltInTableStyle is light style3 accent5 + + + + + Specifies the BuiltInTableStyle is light style3 accent6 + + + + + Specifies the BuiltInTableStyle is medium style1 + + + + + Specifies the BuiltInTableStyle is medium style1 accent1 + + + + + Specifies the BuiltInTableStyle is medium style1 accent2 + + + + + Specifies the BuiltInTableStyle is medium style1 accent3 + + + + + Specifies the BuiltInTableStyle is medium style1 accent4 + + + + + Specifies the BuiltInTableStyle is medium style1 accent5 + + + + + Specifies the BuiltInTableStyle is medium style1 accent6 + + + + + Specifies the BuiltInTableStyle is medium style2 accent6 + + + + + Specifies the BuiltInTableStyle is medium style3 + + + + + Specifies the BuiltInTableStyle is medium style3 accent1 + + + + + Specifies the BuiltInTableStyle is medium style3 accent2 + + + + + Specifies the BuiltInTableStyle is medium style3 accent3 + + + + + Specifies the BuiltInTableStyle is medium style3 accent4 + + + + + Specifies the BuiltInTableStyle is medium style3 accent5 + + + + + Specifies the BuiltInTableStyle is medium style3 accent6 + + + + + Specifies the BuiltInTableStyle is medium style4 + + + + + Specifies the BuiltInTableStyle is medium style4 accent1 + + + + + Specifies the BuiltInTableStyle is medium style4 accent2 + + + + + Specifies the BuiltInTableStyle is medium style4 accent3 + + + + + Specifies the BuiltInTableStyle is medium style4 accent4 + + + + + Specifies the BuiltInTableStyle is medium style4 accent5 + + + + + Specifies the BuiltInTableStyle is medium style4 accent6 + + + + + Specifies the BuiltInTableStyle is dark style1 + + + + + Specifies the BuiltInTableStyle is dark style1 accent1 + + + + + Specifies the BuiltInTableStyle is dark style1 accent2 + + + + + Specifies the BuiltInTableStyle is dark style1 accent3 + + + + + Specifies the BuiltInTableStyle is dark style1 accent4 + + + + + Specifies the BuiltInTableStyle is dark style1 accent5 + + + + + Specifies the BuiltInTableStyle is dark style1 accent6 + + + + + Specifies the BuiltInTableStyle is dark style2 + + + + + Specifies the BuiltInTableStyle is dark style2 accent1 accent2 + + + + + Specifies the BuiltInTableStyle is dark style2 accent3 accent4 + + + + + Specifies the BuiltInTableStyle is dark style2 accent5 accent6 + + + + + Specifies the BuiltInTableStyle is light style1 accent5 + + + + + Provides options to fit a picture as background for slides and shapes. + + + + + Specifies the TileMode is Stretch. + + + + + Specifies the TileMode is Tile. + + + + + + + + + + + + + + + + + + + + Specifies the FitTextOption of shape TextBody + + + + + Specifies the do not automatic fit + + + + + Specifies the shrink text on over flow + + + + + Specifies the resize shape to fit text + + + + + + + + + + + + + + + + + + + + Specifies the SmartArt type. + + + + + Specifies the SmartArt type is BasicBlockList. + + + + + Specifies the SmartArt type is AlternatingHexagons. + + + + + Specifies the SmartArt type is PictureCaptionList. + + + + + Specifies the SmartArt type is LinedList. + + + + + Specifies the SmartArt type is VerticalBulletList. + + + + + Specifies the SmartArt type is VerticalBoxList. + + + + + Specifies the SmartArt type is HorizontalBulletList. + + + + + Specifies the SmartArt type is SquareAccentList. + + + + + Specifies the SmartArt type is PictureAccentList. + + + + + Specifies the SmartArt type is BendingPictureAccentList. + + + + + Specifies the SmartArt type is StackedList. + + + + + Specifies the SmartArt type is IncreasingCircleProcess. + + + + + Specifies the SmartArt type is PieProcess. + + + + + Specifies the SmartArt type is DetailedProcess. + + + + + Specifies the SmartArt type is GroupedList. + + + + + Specifies the SmartArt type is HorizontalPictureList. + + + + + Specifies the SmartArt type is ContinuousPictureList. + + + + + Specifies the SmartArt type is PictureStrips. + + + + + Specifies the SmartArt type is VerticalPictureList. + + + + + Specifies the SmartArt type is AlternatingPictureBlocks. + + + + + Specifies the SmartArt type is VerticalPictureAccentList. + + + + + Specifies the SmartArt type is TitledPictureAccentList. + + + + + Specifies the SmartArt type is VerticalBlockList. + + + + + Specifies the SmartArt type is VerticalChevronList. + + + + + Specifies the SmartArt type is VerticalAccentList. + + + + + Specifies the SmartArt type is VerticalArrowList. + + + + + Specifies the SmartArt type is TrapezoidList. + + + + + Specifies the SmartArt type is DescendingBlockList. + + + + + Specifies the SmartArt type is TableList. + + + + + Specifies the SmartArt type is SegmentedProcess. + + + + + Specifies the SmartArt type is VerticalCurvedList. + + + + + Specifies the SmartArt type is PyramidList. + + + + + Specifies the SmartArt type is TargetList. + + + + + Specifies the SmartArt type is VerticalCircleList. + + + + + Specifies the SmartArt type is TableHierarchy. + + + + + Specifies the SmartArt type is BasicProcess. + + + + + Specifies the SmartArt type is StepUpProcess. + + + + + Specifies the SmartArt type is StepDownProcess. + + + + + Specifies the SmartArt type is AccentProcess. + + + + + Specifies the SmartArt type is AlternatingFlow. + + + + + Specifies the SmartArt type is ContinuousBlockProcess. + + + + + Specifies the SmartArt type is IncreasingArrowsProcess. + + + + + Specifies the SmartArt type is ContinuousArrowProcess. + + + + + Specifies the SmartArt type is ProcessArrows. + + + + + Specifies the SmartArt type is CircleAccentTimeLine. + + + + + Specifies the SmartArt type is BasicTimeLine. + + + + + Specifies the SmartArt type is BasicChevronProcess. + + + + + Specifies the SmartArt type is ClosedChevronProcess. + + + + + Specifies the SmartArt type is ChevronList. + + + + + Specifies the SmartArt type is SubStepProcess. + + + + + Specifies the SmartArt type is PhasedProcess. + + + + + Specifies the SmartArt type is RandomToResultProcess. + + + + + Specifies the SmartArt type is StaggeredProcess. + + + + + Specifies the SmartArt type is ProcessList. + + + + + Specifies the SmartArt type is CircleArrowProcess. + + + + + Specifies the SmartArt type is BasicBendingProcess. + + + + + Specifies the SmartArt type is VerticalBendingProcess. + + + + + Specifies the SmartArt type is AscendingPictureAccentprocess. + + + + + Specifies the SmartArt type is UpwardArrow. + + + + + Specifies the SmartArt type is DescendingProcess. + + + + + Specifies the SmartArt type is CircularBendingProcess. + + + + + Specifies the SmartArt type is Equation. + + + + + Specifies the SmartArt type is VerticalEquation. + + + + + Specifies the SmartArt type is Funnel. + + + + + Specifies the SmartArt type is Gear. + + + + + Specifies the SmartArt type is ArrowRibbon. + + + + + Specifies the SmartArt type is OpposingArrows. + + + + + Specifies the SmartArt type is ConvergingArrows. + + + + + Specifies the SmartArt type is DivergingArrows. + + + + + Specifies the SmartArt type BasicCycle. + + + + + Specifies the SmartArt type is TextCycle. + + + + + Specifies the SmartArt type is BlockCycle. + + + + + Specifies the SmartArt type is NondirectionalCycle. + + + + + Specifies the SmartArt type is ContinuousCycle. + + + + + Specifies the SmartArt type is MultiDirectionalCycle. + + + + + Specifies the SmartArt type is SegmentedCycle. + + + + + Specifies the SmartArt type is BasicPie. + + + + + Specifies the SmartArt type is RadialCycle. + + + + + Specifies the SmartArt type is BasicRadial. + + + + + Specifies the SmartArt type is DivergingRadial. + + + + + Specifies the SmartArt type is RadialVenn. + + + + + Specifies the SmartArt type is RadialCluster. + + + + + Specifies the SmartArt type is OrganizationChart. + + + + + Specifies the SmartArt type is NameAndTitleOrganizationChart. + + + + + Specifies the SmartArt type is HalfCircleOrganizationChart. + + + + + Specifies the SmartArt type is CirclePictureHierarchy. + + + + + Specifies the SmartArt type is Hierarchy. + + + + + Specifies the SmartArt type is LabeledHierarchy. + + + + + Specifies the SmartArt type is HorizontalOrganizationChart. + + + + + Specifies the SmartArt type is HorizontalMulti_levelHierarchy. + + + + + Specifies the SmartArt type is HorizontalHierarchy. + + + + + Specifies the SmartArt type is HorizontalLabeledHierarchy. + + + + + Specifies the SmartArt type is Balance. + + + + + Specifies the SmartArt type is CircleRelationship. + + + + + Specifies the SmartArt type is HexagonCluster. + + + + + Specifies the SmartArt type is OpposingIdeas. + + + + + Specifies the SmartArt type is PlusAndMinus. + + + + + Specifies the SmartArt type is ReverseList. + + + + + Specifies the SmartArt type is CounterBalanceArrows. + + + + + Specifies the SmartArt type is SegmentedPyramid. + + + + + Specifies the SmartArt type is NestedTarget. + + + + + Specifies the SmartArt type is ConvergingRadial. + + + + + Specifies the SmartArt type is RadialList. + + + + + Specifies the SmartArt type is BasicTarget. + + + + + Specifies the SmartArt type is BasicMatrix. + + + + + Specifies the SmartArt type is TitledMatrix. + + + + + Specifies the SmartArt type is GridMatrix. + + + + + Specifies the SmartArt type is CycleMatrix. + + + + + Specifies the SmartArt type is AccentedPicture. + + + + + Specifies the SmartArt type is CircularPictureCallOut. + + + + + Specifies the SmartArt type is SnapshotPictureList. + + + + + Specifies the SmartArt type is SpiralPicture. + + + + + Specifies the SmartArt type is CaptionedPictures. + + + + + Specifies the SmartArt type is BendingPictureCaption. + + + + + Specifies the SmartArt type is BendingPictureSemiTransparentText. + + + + + Specifies the SmartArt type is BendingPictureBlocks. + + + + + Specifies the SmartArt type is BendingPictureCaptionList. + + + + + Specifies the SmartArt type is TitledPictureBlocks. + + + + + Specifies the SmartArt type is PictureGrid. + + + + + Specifies the SmartArt type is PictureAccentBlocks. + + + + + Specifies the SmartArt type is AlternatingPictureCircles. + + + + + Specifies the SmartArt type is TitlePictureLineup. + + + + + Specifies the SmartArt type is PictureLineUp. + + + + + Specifies the SmartArt type is FramedTextPicture. + + + + + Specifies the SmartArt type is BubblePictureList. + + + + + Specifies the SmartArt type is BasicPyramid. + + + + + Specifies the SmartArt type is InvertedPyramid. + + + + + Specifies the SmartArt type is BasicVenn. + + + + + Specifies the SmartArt type is LinearVenn. + + + + + Specifies the SmartArt type is StackedVenn. + + + + + Specifies the SmartArt type is HierarchyList. + + + + + Specifies the SmartArt type is PictureAccentProcess. + + + + + Specifies the SmartArt type is RepeatingBendingProcess. + + + + + Specifies the SmartArt type is VerticalProcess. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Check whether Pictures of current document is referring a mentioned picture path or not. + + Represents a Baseslide. + Represents a picture path to search. + Returns true, if current document picture used a input picture path; Otherwise false. + + + + Sorts the presentation relations based on a specific criterion. + + The list of presentation relations to be sorted. + The sorted list of presentation relations. + + + + Parse the excel stream. + + Stream containing excel file. + Current workbook. + + + + Saves the presentation into the stream. + + Stream in which the presentation is to be saved. + + + + Writes theme override elements. + + string Theme path + Baseslide theme collection + + + + Writes theme override relation collection. + + Theme count + Baseslide Relation collection + + + + Check and modify the notes slide notes master target. + + + + + + Serialize the chart's preserved streams in the file + + input chart object + current chart itme count + + + + Generate the file name which is not in the ziparchive item + + input item + + + + + + Serialize the default style element loaded for chartEx + + input XML writer + input application object + + + + Serialize the default style element loaded for chartEx + + input XML writer + input chart object + input application object + + + + Generate image path with existing image count. + + Represents the image format extension. + Returns image path string. + + + + Represents a hyperlink associated with a non-placeholder shape or text. + + + + + Gets the type of action, the hyperlink will be perform when the specified shape or text is clicked. Read-only. + + + The action. + + + + //Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Adds paragraph into the shape + IParagraph paragraph = shape.TextBody.AddParagraph(); + //Adds text to the TextPart + paragraph.Text = "Google"; + //Set hyperlink to the TextPart + IHyperLink hyperLink = paragraph.TextParts[0].SetHyperlink("https://www.google.com"); + //Set screen tip to the hyperlink + hyperLink.ScreenTip = "This hyperlink navigates to Google site"; + //Gets the hyperlink action type. + HyperLinkType actionType = hyperLink.Action; + //Save the presentation + ppDoc.Save("Sample.pptx"); + //Close the presentation + ppDoc.Close(); + + + 'Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Adds paragraph into the shape + Dim paragraph As IParagraph = shape.TextBody.AddParagraph() + 'Adds text to the TextPart + paragraph.Text = "Google" + 'Set hyperlink to the TextPart + Dim hyperLink As IHyperLink = paragraph.TextParts(0).SetHyperlink("https://www.google.com") + 'Set screen tip to the hyperlink + hyperLink.ScreenTip = "This hyperlink navigates to Google site" + 'Gets the hyperlink action type. + Dim actionType As HyperLinkType = hyperLink.Action + 'Save the presentation + ppDoc.Save("Sample.pptx") + 'Close the presentation + ppDoc.Close() + + + + + + Gets the url address of the hyperlink. Read-only. + + + The URL. + + + + //Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Adds paragraph into the shape + IParagraph paragraph = shape.TextBody.AddParagraph(); + //Adds text to the TextPart + paragraph.Text = "Google"; + //Set hyperlink to the TextPart + IHyperLink hyperLink = paragraph.TextParts[0].SetHyperlink("https://www.google.com"); + //Set screen tip to the hyperlink + hyperLink.ScreenTip = "This hyperlink navigates to Google site"; + //Gets the hyperlink action type. + string hyperlinkUrl = hyperLink.Url; + //Save the presentation + ppDoc.Save("Sample.pptx"); + //Close the presentation + ppDoc.Close(); + + + 'Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Adds paragraph into the shape + Dim paragraph As IParagraph = shape.TextBody.AddParagraph() + 'Adds text to the TextPart + paragraph.Text = "Google" + 'Set hyperlink to the TextPart + Dim hyperLink As IHyperLink = paragraph.TextParts(0).SetHyperlink("https://www.google.com") + 'Set screen tip to the hyperlink + hyperLink.ScreenTip = "This hyperlink navigates to Google site" + 'Gets the hyperlink Url. + Dim hyperlinkUrl As String = hyperLink.Url + 'Save the presentation + ppDoc.Save("Sample.pptx") + 'Close the presentation + ppDoc.Close() + + + + + + Gets or sets the screen tip text of a hyperlink. + + + The text to be appeared in surface of hyperlink. + + + + //Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Adds paragraph into the shape + IParagraph paragraph = shape.TextBody.AddParagraph(); + //Adds text to the TextPart + paragraph.Text = "Google"; + //Set hyperlink to the TextPart + IHyperLink hyperLink = paragraph.TextParts[0].SetHyperlink("https://www.google.com"); + //Set screen tip to the hyperlink + hyperLink.ScreenTip = "This hyperlink navigates to Google site"; + //Save the presentation + ppDoc.Save("Sample.pptx"); + //Close the presentation + ppDoc.Close(); + + + 'Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Adds paragraph into the shape + Dim paragraph As IParagraph = shape.TextBody.AddParagraph() + 'Adds text to the TextPart + paragraph.Text = "Google" + 'Set hyperlink to the TextPart + Dim hyperLink As IHyperLink = paragraph.TextParts(0).SetHyperlink("https://www.google.com") + 'Set screen tip to the hyperlink + hyperLink.ScreenTip = "This hyperlink navigates to Google site" + 'Save the presentation + ppDoc.Save("Sample.pptx") + 'Close the presentation + ppDoc.Close() + + + + + + Gets the target slide of the hyperlink. + + + The target slide. + + Returns the target slide instance. + + + //Create a new presentation. + IPresentation presDoc = Presentation.Create(); + //Add slides to the presentation. + ISlide slide1 = presDoc.Slides.Add(SlideLayoutType.Blank); + ISlide slide2 = presDoc.Slides.Add(); + ISlide slide3 = presDoc.Slides.Add(); + ISlide slide4 = presDoc.Slides.Add(); + //Add a rectangle shape to the slide. + IShape shape = slide1.Shapes.AddShape(AutoShapeType.Rectangle, 100, 20, 200, 100); + //Sets the hyperlink to the shape. + shape.SetHyperlink("2"); + //Gets the target slide of the hyperlink. + ISlide slide = shape.Hyperlink.TargetSlide; + //Save the presentation to the file system. + presDoc.Save("Output.pptx"); + //Close the presentation + presDoc.Close(); + + + 'Create a new presentation. + Dim presDoc As IPresentation = Presentation.Create() + 'Add slides to the presentation. + Dim slide1 As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + Dim slide2 As ISlide = presDoc.Slides.Add() + Dim slide3 As ISlide = presDoc.Slides.Add() + Dim slide4 As ISlide = presDoc.Slides.Add() + 'Add a rectangle shape to the slide. + Dim shape As IShape = slide1.Shapes.AddShape(AutoShapeType.Rectangle, 100, 20, 200, 100) + 'Sets the hyperlink to the shape. + shape.SetHyperlink("2") + 'Gets the target slide of the hyperlink. + Dim slide As ISlide = shape.Hyperlink.TargetSlide + 'Save the presentation to the file system. + presDoc.Save("Output.pptx") + 'Close the presentation + presDoc.Close() + + + + + + Sets parent as specified SmartArtPoint for hyperlink. + + + + + + Updates the hyperlink relation within the parent slide. + + The parent slide where the hyperlink relation is being updated. + + + + Retrieves the target slide string from the document. + + The presentation containing the slide information. + The path of the target slide if found; otherwise, null. + + + + Validates if the provided email address is in valid format. + + The email address to validate. + True if email address is valid; otherwise, false. + + + + Sets the parent as a TextPart. + + + + + + Set parent as specified SmartArtPoint + + + + + + Retrieves the master slide associated with the specified base slide. + + + + + + + Gets the target slide of the hyperlink. + + + The target slide. + + Returns the target slide instance if the action is JumpSpecificSlide, otherwise null. + + + IPresentation presentation = Presentation.Create(); + ISlide slide1 = presentation.Slides.Add(SlideLayoutType.Blank); + ISlide slide2 = presentation.Slides.Add(); + ISlide slide3 = presentation.Slides.Add(); + ISlide slide4 = presentation.Slides.Add(); + IShape shape = slide1.Shapes.AddShape(AutoShapeType.Rectangle, 100, 20, 200, 100); + shape.SetHyperlink("2"); + ISlide slide = shape.Hyperlink.TargetSlide; + + + + Dim presentation As IPresentation = Presentation.Create() + Dim slide1 As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + Dim slide2 As ISlide = presentation.Slides.Add() + Dim slide3 As ISlide = presentation.Slides.Add() + Dim slide4 As ISlide = presentation.Slides.Add() + Dim shape As IShape = slide1.Shapes.AddShape(AutoShapeType.Rectangle, 100, 20, 200, 100) + shape.SetHyperlink("2") + Dim slide As ISlide = shape.Hyperlink.TargetSlide + + + + + Gets or Sets the color type of Hyperlink. + + Indicates if the hyperlink uses the theme’s hyperlink color or the text color. + + + + Represents the layout slide in presentation. + + + + + Gets the layout type of the slide. Read-only. + + + The type of the layout. + + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Retrieve the collection of layout Slide + ILayoutSlides layoutSlides = presentation.Masters[0].LayoutSlides; + //Create a new instance of layout slide + ILayoutSlide layoutSlide = layoutSlides[0]; + //Get the layout type of layout slide, read only + SlideLayoutType slidelayoutType = layoutSlide.LayoutType; + //Set the fill type of background as solid + layoutSlide.Background.Fill.FillType = FillType.Solid; + //Set the color for solid fill + layoutSlide.Background.Fill.SolidFill.Color = ColorObject.Firebrick; + //Add the layout slide to the collection + layoutSlides.Add(layoutSlide); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Retrieve the collection of layout Slide + Dim layoutSlides As ILayoutSlides = presentation__1.LayoutSlides + 'Create a new instance of layout slide + Dim layoutSlide As ILayoutSlide = layoutSlides(0) + 'Get the layout type of layout slide, read only + Dim slidelayoutType As SlideLayoutType = layoutSlide.LayoutType + 'Set the fill type of background as solid + layoutSlide.Background.Fill.FillType = FillType.Solid + 'Set the color for solid fill + layoutSlide.Background.Fill.SolidFill.Color = ColorObject.Firebrick + 'Add the layout slide to the collection + layoutSlides.Add(layoutSlide) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the corresponding master slide. Read-only. + + + The master slide. + + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Retrieve the collection of layout Slide + ILayoutSlides layoutSlides = presentation.Masters[0].LayoutSlides; + //Create a new instance of layout slide + ILayoutSlide layoutSlide = layoutSlides[0]; + //Add the layout slide to the collection + layoutSlides.Add(layoutSlide); + //Get the master slide of the layout slide, read only + IMasterSlide masterSlide = layoutSlide.MasterSlide; + //Set the slide orientation of the master slide + masterSlide.SlideSize.SlideOrientation = SlideOrientation.Portrait; + //Set the name of the master slide + masterSlide.Name = "Master Slide"; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Retrieve the collection of layout Slide + Dim layoutSlides As ILayoutSlides = presentation__1.LayoutSlides + 'Create a new instance of layout slide + Dim layoutSlide As ILayoutSlide = layoutSlides(0) + 'Add the layout slide to the collection + layoutSlides.Add(layoutSlide) + 'Get the master slide of the layout slide, read only + Dim masterSlide As IMasterSlide = layoutSlide.MasterSlide + 'Set the slide orientation of the master slide + masterSlide.SlideSize.SlideOrientation = SlideOrientation.Portrait + 'Set the name of the master slide + masterSlide.Name = "Master Slide" + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents a collection of instance in a presentation + + + + + Adds a layout slide at the end of the collection. + + Represents an instance to be added. + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Retrieve the collection of layout Slide + ILayoutSlides layoutSlides = presentation.Masters[0].LayoutSlides; + //Create a new instance of layout slide + ILayoutSlide layoutSlide = layoutSlides[0]; + //Set name to the layout slide + layoutSlide.Name = "Layout Slide"; + //Add an auto shape - bentconnector5 to the layout slide + layoutSlide.Shapes.AddShape(AutoShapeType.BentConnector5, 123, 234, 200, 180); + //Add the layout slide to the collection + layoutSlides.Add(layoutSlide); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Retrieve the collection of layout Slide + Dim layoutSlides As ILayoutSlides = presentation__1.Masters(0).LayoutSlides + 'Create a new instance of layout slide + Dim layoutSlide As ILayoutSlide = layoutSlides(0) + 'Set name to the layout slide + layoutSlide.Name = "Layout Slide" + 'Add an auto shape - bentconnector5 to the layout slide + layoutSlide.Shapes.AddShape(AutoShapeType.BentConnector5, 123, 234, 200, 180) + 'Add the layout slide to the collection + layoutSlides.Add(layoutSlide) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Creates an instance with the specified and layout name, then adds it to the collection. + + The layout type to customize + The custom name of the layout slide + Returns the created layout slide with specified name and type + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the collection of layout Slide + ILayoutSlides layoutSlides = presentation.Masters[0].LayoutSlides; + //Add the layout slide to the collection + layoutSlides.Add(SlideLayoutType.Custom, "Custom Layout"); + //Add the slide into the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Custom); + //Get the count of the layout slides in a presentation + int count = layoutSlides.Count; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim pptxDoc As IPresentation = Presentation.Create() + 'Retrieve the collection of layout Slide. + Dim layoutSlides As ILayoutSlides = pptxDoc.Masters(0).LayoutSlides + 'Add the layout slide to the collection. + layoutSlides.Add(SlideLayoutType.Custom, "Custom Layout") + 'Add the slide into the presentation. + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Custom) + 'Get the count of the layout slides in a presentation. + Dim count As Integer = layoutSlides.Count + 'Saves the Presentation. + pptxDoc.Save("Sample.pptx") + 'Close the presentation. + pptxDoc.Close() + + + + + + Inserts an element into the layout slide collection at the specified index. + + The zero-based index at which value should be inserted. + The layout slide item to insert. + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Retrieve the collection of layout Slide + ILayoutSlides layoutSlides = presentation.Masters[0].LayoutSlides; + //Create a new instance of layout slide + ILayoutSlide layoutSlide = layoutSlides[0]; + //Set name to the layout slide + layoutSlide.Name = "Layout Slide"; + //Add a text box to the layout slide + IShape shape = layoutSlide.Shapes.AddTextBox(200, 120, 345, 200); + //Add paragraph to the text body + shape.TextBody.Paragraphs.Add("This is a layout slide"); + //Insert the layout slide at index 2 + layoutSlides.Insert(2,layoutSlide); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Retrieve the collection of layout Slide + Dim layoutSlides As ILayoutSlides = presentation__1.Masters(0).LayoutSlides + 'Create a new instance of layout slide + Dim layoutSlide As ILayoutSlide = layoutSlides(0) + 'Set name to the layout slide + layoutSlide.Name = "Layout Slide" + 'Add a text box to the layout slide + Dim shape As IShape = layoutSlide.Shapes.AddTextBox(200, 120, 345, 200) + 'Add paragraph to the text body + shape.TextBody.Paragraphs.Add("This is a layout slide") + 'Insert the layout slide at index 2 + layoutSlides.Insert(2, layoutSlide) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the element at the specified index of the layout slide collection. + + The zero-based index of the element to be removed. + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Retrieve the collection of layout Slide + ILayoutSlides layoutSlides = presentation.Masters[0].LayoutSlides; + //Remove a specific layout slide using index position + layoutSlides.RemoveAt(1); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Retrieve the collection of layout Slide + Dim layoutSlides As ILayoutSlides = presentation__1.Masters(0).LayoutSlides + 'Remove a specific layout slide using index position + layoutSlides.RemoveAt(1) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the first occurrence of a specified object from the layout slide collection. + + The layout slide object to be removed from the collection. + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Retrieve the collection of layout Slide + ILayoutSlides layoutSlides = presentation.Masters[0].LayoutSlides; + //Create a new instance of layout slide + ILayoutSlide layoutSlide = layoutSlides[0]; + //Set name to the layout slide + layoutSlide.Name = "Layout Slide"; + //Add a text box to the layout slide + IShape shape = layoutSlide.Shapes.AddTextBox(200, 120, 345, 200); + //Add paragraph to the text body + shape.TextBody.Paragraphs.Add("This is a layout slide"); + //Add the layout slide to the collection + layoutSlides.Add(layoutSlide); + //Remove a specific layout slide from the collection + layoutSlides.Remove(layoutSlide); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Retrieve the collection of layout Slide + Dim layoutSlides As ILayoutSlides = presentation__1.Masters(0).LayoutSlides + 'Create a new instance of layout slide + Dim layoutSlide As ILayoutSlide = layoutSlides(0) + 'Set name to the layout slide + layoutSlide.Name = "Layout Slide" + 'Add a text box to the layout slide + Dim shape As IShape = layoutSlide.Shapes.AddTextBox(200, 120, 345, 200) + 'Add paragraph to the text body + shape.TextBody.Paragraphs.Add("This is a layout slide") + 'Add the layout slide to the collection + layoutSlides.Add(layoutSlide) + 'Remove a specific layout slide from the collection + layoutSlides.Remove(layoutSlide) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Returns the zero-based index of the first occurrence of the within the collection. + + The ILayoutSlide instance to locate in the collection. + Returns the zero-based index of the first occurrence of object within the entire collection, if found; otherwise, –1. + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Retrieve the collection of layout Slide + ILayoutSlides layoutSlides = presentation.Masters[0].LayoutSlides; + //Create a new instance of layout slide + ILayoutSlide layoutSlide = layoutSlides[0]; + //Set name to the layout slide + layoutSlide.Name = "Layout Slide"; + //Add a text box to the layout slide + IShape shape = layoutSlide.Shapes.AddTextBox(200, 120, 345, 200); + //Add paragraph to the text body + shape.TextBody.Paragraphs.Add("This is a layout slide"); + //Add the layout slide to the collection + layoutSlides.Add(layoutSlide); + //Get the index of layout slide + int index = layoutSlides.IndexOf(layoutSlide); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Retrieve the collection of layout Slide + Dim layoutSlides As ILayoutSlides = presentation__1.Masters(0).LayoutSlides + 'Create a new instance of layout slide + Dim layoutSlide As ILayoutSlide = layoutSlides(0) + 'Set name to the layout slide + layoutSlide.Name = "Layout Slide" + 'Add a text box to the layout slide + Dim shape As IShape = layoutSlide.Shapes.AddTextBox(200, 120, 345, 200) + 'Add paragraph to the text body + shape.TextBody.Paragraphs.Add("This is a layout slide") + 'Add the layout slide to the collection + layoutSlides.Add(layoutSlide) + 'Get the index of layout slide + Dim index As Integer = layoutSlides.IndexOf(layoutSlide) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes all the elements from layout slide collection. + + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Retrieve the collection of layout Slide + ILayoutSlides layoutSlides = presentation.Masters[0].LayoutSlides; + //Clear the layout slides + layoutSlides.Clear(); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Retrieve the collection of layout Slide + Dim layoutSlides As ILayoutSlides = presentation__1.Masters(0).LayoutSlides + 'Clear the layout slides + layoutSlides.Clear() + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Returns an instance with the specified item. + + The type of the layout slide to find the instance. + Returns the layout slide with the specified slide layout type. + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Retrieve the collection of layout Slide + ILayoutSlides layoutSlides = presentation.Masters[0].LayoutSlides; + //Get the layout slide by specifying the slide layout type + ILayoutSlide layoutSlide = layoutSlides.GetByType(SlideLayoutType.Title); + //Set name to the layout slide + layoutSlide.Name = "Layout Slide"; + //Add a text box to the layout slide + IShape shape = layoutSlide.Shapes.AddTextBox(200, 120, 345, 200); + //Add paragraph to the text body + shape.TextBody.Paragraphs.Add("This is a layout slide"); + //Add the layout slide to the collection + layoutSlides.Add(layoutSlide); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Retrieve the collection of layout Slide + Dim layoutSlides As ILayoutSlides = presentation__1.Masters(0).LayoutSlides + 'Get the layout slide by specifying the slide layout type + Dim layoutSlide As ILayoutSlide = layoutSlides.GetByType(SlideLayoutType.Title) + 'Set name to the layout slide + layoutSlide.Name = "Layout Slide" + 'Add a text box to the layout slide + Dim shape As IShape = layoutSlide.Shapes.AddTextBox(200, 120, 345, 200) + 'Add paragraph to the text body + shape.TextBody.Paragraphs.Add("This is a layout slide") + 'Add the layout slide to the collection + layoutSlides.Add(layoutSlide) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the number of elements in the layout slide collection. Read-only. + + + The total count of the slides in the layout slide collection. + + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Retrieve the collection of layout Slide + ILayoutSlides layoutSlides = presentation.Masters[0].LayoutSlides; + //Create a new instance of layout slide + ILayoutSlide layoutSlide = layoutSlides[0]; + //Add the layout slide to the collection + layoutSlides.Add(layoutSlide); + //Get the count of the layout slides in a presentation + int count = layoutSlides.Count; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Retrieve the collection of layout Slide + Dim layoutSlides As ILayoutSlides = presentation__1.Masters(0).LayoutSlides + 'Create a new instance of layout slide + Dim layoutSlide As ILayoutSlide = layoutSlides(0) + 'Add the layout slide to the collection + layoutSlides.Add(layoutSlide) + 'Get the count of the layout slides in a presentation + Dim count As Integer = layoutSlides.Count + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a instance from the collection. Read-only. + + Index from the collection. + Returns the particular layout slide based on the index. + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Retrieve the collection of layout Slide + ILayoutSlides layoutSlides = presentation.Masters[0].LayoutSlides; + //Create a new instance of layout slide + ILayoutSlide layoutSlide = layoutSlides[0]; + //Set the fill type of background as solid + layoutSlide.Background.Fill.FillType = FillType.Solid; + //Set the color for solid fill + layoutSlide.Background.Fill.SolidFill.Color = ColorObject.Firebrick; + //Add the layout slide to the collection + layoutSlides.Add(layoutSlide); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Retrieve the collection of layout Slide + Dim layoutSlides As ILayoutSlides = presentation__1.Masters(0).LayoutSlides + 'Create a new instance of layout slide + Dim layoutSlide As ILayoutSlide = layoutSlides(0) + 'Set the fill type of background as solid + layoutSlide.Background.Fill.FillType = FillType.Solid + 'Set the color for solid fill + layoutSlide.Background.Fill.SolidFill.Color = ColorObject.Firebrick + 'Add the layout slide to the collection + layoutSlides.Add(layoutSlide) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents the master slide in a presentation. + + + + + Gets the collection of a instance. Read-only. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Title); + //Gets the first master slide. + IMasterSlide masterSlide = presentation.Masters[0]; + //Retrieve the collection of layout Slide + ILayoutSlides layoutSlides = masterSlide.LayoutSlides; + int count = layoutSlides.Count; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation As Presentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Title) + 'Gets the first master slide. + Dim masterSlide As IMasterSlide = presentation.Masters(0) + 'Retrieve the collection of layout Slide + Dim layoutSlides As ILayoutSlides = masterSlide.LayoutSlides + 'Gets the layout slides count. + Dim count As Integer = layoutSlides.Count + 'Saves the Presentation. + presentation.Save("Sample.pptx") + 'Close the presentation. + presentation.Close() + + + + + + Represents a collection of instance in a presentation. + + + + + Adds a master slide at the end of the collection. + + Represents an instance to be added. + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Retrieve the collection of layout Slide + IMasterSlides masterslides = presentation.Masters; + //Get a master by specifying the index in collection + IMasterSlide masterSlide = presentation.Masters[0]; + //Add a group shape to master slide + masterSlide.GroupShapes.AddGroupShape(200,234,198,173); + //Add an auto shape - bevel to master slide + masterSlide.Shapes.AddShape(AutoShapeType.Bevel,237,45,187,120); + //Add master slide to the collection + masterslides.Add(masterSlide); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Retrieve the collection of layout Slide + Dim masterslides As IMasterSlides = presentation__1.Masters + 'Get a master by specifying the index in collection + Dim masterSlide As IMasterSlide = presentation__1.Masters(0) + 'Add a group shape to master slide + masterSlide.GroupShapes.AddGroupShape(200, 234, 198, 173) + 'Add an auto shape - bevel to master slide + masterSlide.Shapes.AddShape(AutoShapeType.Bevel, 237, 45, 187, 120) + 'Add master slide to the collection + masterslides.Add(masterSlide) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Inserts an element into the master slide collection at the specified index. + + The zero-based index at which master slide should be inserted. + The master slide item to insert. + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Retrieve the collection of layout Slide + IMasterSlides masterslides = presentation.Masters; + //Get a master by specifying the index in collection + IMasterSlide masterSlide = presentation.Masters[0]; + //Set the fill type for background of the master slide + masterSlide.Background.Fill.FillType = FillType.Solid; + //Set color of the solid fill + masterSlide.Background.Fill.SolidFill.Color = ColorObject.FromArgb(123, 54, 234, 112); + //Add a group shape to master slide + masterSlide.GroupShapes.AddGroupShape(200,234,198,173); + //Add an auto shape - bevel to master slide + masterSlide.Shapes.AddShape(AutoShapeType.Bevel,237,45,187,120); + //Insert master slide in the collection + masterslides.Insert(1, masterSlide); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Retrieve the collection of layout Slide + Dim masterslides As IMasterSlides = presentation__1.Masters + 'Get a master by specifying the index in collection + Dim masterSlide As IMasterSlide = presentation__1.Masters(0) + 'Set the fill type for background of the master slide + masterSlide.Background.Fill.FillType = FillType.Solid + 'Set color of the solid fill + masterSlide.Background.Fill.SolidFill.Color = ColorObject.FromArgb(123, 54, 234, 112) + 'Add a group shape to master slide + masterSlide.GroupShapes.AddGroupShape(200, 234, 198, 173) + 'Add an auto shape - bevel to master slide + masterSlide.Shapes.AddShape(AutoShapeType.Bevel, 237, 45, 187, 120) + 'Insert master slide in the collection + masterslides.Insert(1, masterSlide) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the first occurrence of a specified instance from the master slide collection. + + The master slide object to be removed from the collection. + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Retrieve the collection of layout Slide + IMasterSlides masterslides = presentation.Masters; + //Get a master by specifying the index in collection + IMasterSlide masterSlide = presentation.Masters[0]; + //Add a group shape to master slide + masterSlide.GroupShapes.AddGroupShape(200,234,198,173); + //Insert master slide in the collection + masterslides.Insert(1, masterSlide); + //Remove a specific master slide + masterslides.Remove(masterSlide); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Retrieve the collection of layout Slide + Dim masterslides As IMasterSlides = presentation__1.Masters + 'Get a master by specifying the index in collection + Dim masterSlide As IMasterSlide = presentation__1.Masters(0) + 'Add a group shape to master slide + masterSlide.GroupShapes.AddGroupShape(200, 234, 198, 173) + 'Insert master slide in the collection + masterslides.Insert(1, masterSlide) + 'Remove a specific master slide + masterslides.Remove(masterSlide) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the element at the specified index of the master slide collection. + + The zero-based index of the element to be removed. + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Retrieve the collection of layout Slide + IMasterSlides masterslides = presentation.Masters; + //Get a master by specifying the index in collection + IMasterSlide masterSlide = presentation.Masters[0]; + //Add a group shape to master slide + masterSlide.GroupShapes.AddGroupShape(200,234,198,173); + //Insert master slide in the collection + masterslides.Insert(1, masterSlide); + //Remove a specific master slide + masterslides.RemoveAt(0); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Retrieve the collection of layout Slide + Dim masterslides As IMasterSlides = presentation__1.Masters + 'Get a master by specifying the index in collection + Dim masterSlide As IMasterSlide = presentation__1.Masters(0) + 'Add a group shape to master slide + masterSlide.GroupShapes.AddGroupShape(200, 234, 198, 173) + 'Insert master slide in the collection + masterslides.Insert(1, masterSlide) + 'Remove a specific master slide + masterslides.RemoveAt(0) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Returns the zero-based index of the first occurrence of the instance within the collection. + + The IMasterSlide instance to locate in the collection. + Returns the zero-based index of the first occurrence of object within the entire collection, if found; otherwise, –1. + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Retrieve the collection of layout Slide + IMasterSlides masterslides = presentation.Masters; + //Get a master by specifying the index in collection + IMasterSlide masterSlide = presentation.Masters[0]; + //Set the fill type for background of the master slide + masterSlide.Background.Fill.FillType = FillType.Solid; + //Set color of the solid fill + masterSlide.Background.Fill.SolidFill.Color = ColorObject.FromArgb(123, 54, 234, 112); + //Add master slide to the collection + masterslides.Add(masterSlide); + //Get the index of master slide in collection + int index = masterslides.IndexOf(masterSlide); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Retrieve the collection of layout Slide + Dim masterslides As IMasterSlides = presentation__1.Masters + 'Get a master by specifying the index in collection + Dim masterSlide As IMasterSlide = presentation__1.Masters(0) + 'Set the fill type for background of the master slide + masterSlide.Background.Fill.FillType = FillType.Solid + 'Set color of the solid fill + masterSlide.Background.Fill.SolidFill.Color = ColorObject.FromArgb(123, 54, 234, 112) + 'Add master slide to the collection + masterslides.Add(masterSlide) + 'Get the index of master slide in collection + Dim index As Integer = masterslides.IndexOf(masterSlide) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes all the elements from master slide collection. + + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Retrieve the collection of layout Slide + IMasterSlides masterslides = presentation.Masters; + //Get a master by specifying the index in collection + IMasterSlide masterSlide = presentation.Masters[0]; + //Clear the master slide collection + masterslides.Clear(); + //Add master slide to the collection + masterslides.Add(masterSlide); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Retrieve the collection of layout Slide + Dim masterslides As IMasterSlides = presentation__1.Masters + 'Get a master by specifying the index in collection + Dim masterSlide As IMasterSlide = presentation__1.Masters(0) + 'Clear the master slide collection + masterslides.Clear() + 'Add master slide to the collection + masterslides.Add(masterSlide) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the number of elements in the collection. Read-only. + + + The total count of the master slides in the master slide collection. + + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Retrieve the collection of layout Slide + IMasterSlides masterslides = presentation.Masters; + //Get a master by specifying the index in collection + IMasterSlide masterSlide = presentation.Masters[0]; + //Add a group shape to master slide + masterSlide.GroupShapes.AddGroupShape(200,234,198,173); + //Add an auto shape - bevel to master slide + masterSlide.Shapes.AddShape(AutoShapeType.Bevel,237,45,187,120); + //Add master slide to the collection + masterslides.Add(masterSlide); + //Get the count of the master slide + int count = masterslides.Count; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Gets a instance from the collection. Read-only. + + Index from the collection. + Returns the particular master slide based on the index. + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Retrieve the collection of layout Slide + IMasterSlides masterslides = presentation.Masters; + //Get a master by specifying the index in collection + IMasterSlide masterSlide = presentation.Masters[0]; + //Set the fill type for background of the master slide + masterSlide.Background.Fill.FillType = FillType.Solid; + //Set color of the solid fill + masterSlide.Background.Fill.SolidFill.Color = ColorObject.FromArgb(123, 54, 234, 112); + //Add a group shape to master slide + masterSlide.GroupShapes.AddGroupShape(200,234,198,173); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + + + + Represents the PowerPoint presentation. + + + + + Saves the presentation to the specified file name. + + Specifies the file name to save the presentation. + At present, the Essential Presentation library only supports the PPTX file format. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(3, 3, 100, 120, 300, 200); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(3, 3, 100, 120, 300, 200) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + At present, the Essential Presentation library only supports the PPTX file format. + + + //Create instance for memory stream + MemoryStream fileStream = new MemoryStream(); + //Open a presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(3, 3, 100, 120, 300, 200); + //Save the presentation using stream + presentation.Save(fileStream); + //Close the presentation. + presentation.Close(); + //Dispose the file stream + fileStream.Dispose(); + + + 'Create instance for memory stream + Dim fileStream As New MemoryStream() + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(3, 3, 100, 120, 300, 200) + 'Save the presentation using stream + presentation__1.Save(fileStream) + 'Close the presentation. + presentation__1.Close() + 'Dispose the file stream + fileStream.Dispose() + + + + + + Saves the presentation to the specified HttpResponse instance. + + + At present, the Essential Presentation library only supports the PPTX file + format. + + The name of the file in HttpResponse. + The format type of the presentation. + The HttpResponse to save the presentation. + + + //Create a presentation + IPresentation presentation = Presentation.Create(); + //Save the presentation to the specified HttpResponse + presentation.Save("Sample.pptx", FormatType.Pptx, HttpContext.Current.Response); + + + 'Create a presentation + Dim presentation__1 As IPresentation = Presentation.Create() + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(3, 3, 100, 120, 300, 200); + 'Save the presentation to the specified HttpResponse + presentation__1.Save("Sample.pptx", FormatType.Pptx, Response) + + + + + + Encrypts the presentation using the specified password. + + The password to encrypt the presentation. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a new slide of content with caption slide layout type. + ISlide slide = presentation.Slides.Add(SlideLayoutType.ContentWithCaption); + //Add a auto shape of moon type auto shape. + IShape shape = slide.Shapes.AddShape(AutoShapeType.Moon, 50, 0, 200, 200); + //Add a paragraph with text content to the shape. + shape.TextBody.AddParagraph("Text for moon shape"); + //Encrypt the presentation with the combination of alpha and symbol string password. + presentation.Encrypt("MYPASSWORD!@#$%"); + //Save the presentation. + presentation.Save("Sample.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a new slide of content with caption slide layout type. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.ContentWithCaption) + 'Add a auto shape of moon type auto shape. + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Moon, 50, 0, 200, 200) + 'Add a paragraph with text content to the shape. + shape.TextBody.AddParagraph("Text for moon shape") + 'Encrypt the presentation with the combination of alpha and symbol string password. + presentation__1.Encrypt("MYPASSWORD!@#$%") + 'Save the presentation. + presentation__1.Save("Sample.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Removes the encryption from presentation. + + + + //Open the encrypted presentation. + IPresentation presentation = Presentation.Open("Input.pptx", "MYPASSWORD!@#$%"); + //Remove the encryption. + presentation.RemoveEncryption(); + //Save the presentation. + presentation.Save("Sample.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Open the encrypted presentation. + Dim presentation__1 As IPresentation = Presentation.Open("Input.pptx", "MYPASSWORD!@#$%") + 'Remove the encryption. + presentation__1.RemoveEncryption() + 'Save the presentation. + presentation__1.Save("Sample.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Converts the presentation slides to images and returns the image array. + + Specifies the image type to convert slides. + Returns the array of the converted images. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a content with caption slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.ContentWithCaption); + //Add a table to the slide. + ITable table = slide.Tables.AddTable(5, 5, 20, 20, 500, 500); + //Set the built in table style. + table.BuiltInStyle = BuiltInTableStyle.DarkStyle2Accent3Accent4; + //Iterate through the row collection. + foreach (IRow row in table.Rows) + { + //Iterate through the cell collection. + foreach (ICell cell in row.Cells) + { + //Add a paragraph to the cell. + cell.TextBody.AddParagraph("New Paragraph"); + } + } + //Converts the each and every slide in the presentation to image of System.Drawing.Image type array. + System.Drawing.Image[] imageArray = presentation.RenderAsImages(Syncfusion.Drawing.ImageType.Metafile); + //Iterate the image array. + foreach (System.Drawing.Image image in imageArray) + { + //Save the image of .bmp format. + image.Save("RenderAsImage" + Guid.NewGuid() + ".bmp"); + } + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a content with caption slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.ContentWithCaption) + 'Add a table to the slide. + Dim table As ITable = slide.Tables.AddTable(5, 5, 20, 20, 500, 500) + 'Set the built in table style. + table.BuiltInStyle = BuiltInTableStyle.DarkStyle2Accent3Accent4 + 'Iterate through the row collection. + For Each row As IRow In table.Rows + 'Iterate through the cell collection. + For Each cell As ICell In row.Cells + 'Add a paragraph to the cell. + cell.TextBody.AddParagraph("New Paragraph") + Next + Next + 'Converts the each and every slide in the presentation to image of System.Drawing.Image type array. + Dim imageArray As Image() = presentation__1.RenderAsImages(Syncfusion.Drawing.ImageType.Metafile) + 'Iterate the image array. + For Each image As Image In imageArray + 'Save the image of .bmp format. + image.Save("RenderAsImage" + Guid.NewGuid() + ".bmp") + Next + 'Close the presentation. + presentation__1.Close() + + + + + + Converts the presentation slides to images and returns the stream array. + + Specifies the image format to convert slides. + Returns the array of the converted images. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a content with caption slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.ContentWithCaption); + //Add a table to the slide. + ITable table = slide.Tables.AddTable(5, 5, 0, 0, 500, 500); + //Set the built in table style. + table.BuiltInStyle = BuiltInTableStyle.DarkStyle2Accent3Accent4; + //Iterate through the row collection. + foreach (IRow row in table.Rows) + { + //Iterate through the cell collection. + foreach (ICell cell in row.Cells) + { + //Add a paragraph to the cell. + cell.TextBody.AddParagraph("New Paragraph"); + } + } + //Converts the each and every slide in the presentation to image of stream array type. + Stream[] imageStreamArray = presentation.RenderAsImages(Syncfusion.Drawing.ImageFormat.Jpeg); + //Iterate the stream array. + foreach (Stream stream in imageStreamArray) + { + //Save the stream in image of .jpg format. + Image.FromStream(stream).Save("RenderAsImage" + Guid.NewGuid() + ".jpg"); + } + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a content with caption slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.ContentWithCaption) + 'Add a table to the slide. + Dim table As ITable = slide.Tables.AddTable(5, 5, 0, 0, 500, 500) + 'Set the built in table style. + table.BuiltInStyle = BuiltInTableStyle.DarkStyle2Accent3Accent4 + 'Iterate through the row collection. + For Each row As IRow In table.Rows + 'Iterate through the cell collection. + For Each cell As ICell In row.Cells + 'Add a paragraph to the cell. + cell.TextBody.AddParagraph("New Paragraph") + Next + Next + 'Converts the each and every slide in the presentation to image of stream array type. + Dim imageStreamArray As Stream() = presentation__1.RenderAsImages(Syncfusion.Drawing.ImageFormat.Jpeg) + 'Iterate the stream array. + For Each stream As Stream In imageStreamArray + 'Save the stream in image of .jpg format. + Image.FromStream(stream).Save("RenderAsImage" + Guid.NewGuid() + ".jpg") + Next + 'Close the presentation. + presentation__1.Close() + + + + + + Releases any resources associated with the presentation instance. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a new slide of comparison slide layout type. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Comparison); + //Save the presentation. + presentation.Save("Sample.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a new slide of comparison slide layout type. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Comparison) + 'Save the presentation. + presentation__1.Save("Sample.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Creates an independent copy of instance. + + Returns the cloned presentation instance. + + + //Create an instance for presentation + IPresentation presentation = Presentation.Create(); + //Add a new slide of comparison slide layout type. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Comparison); + //Clone the entire presentation. + IPresentation presentationClone = presentation.Clone(); + //Add a new slide of title layout type. + slide = presentationClone.Slides.Add(SlideLayoutType.Title); + //Add an auto shape of regular pentagon auto shape type. + slide.Shapes.AddShape(AutoShapeType.RegularPentagon, 10, 20, 300, 400); + //Save the cloned presentation + presentationClone.Save("Sample.pptx"); + //Close the presentation. + presentation.Close(); + //Close the cloned presentation. + presentationClone.Close(); + + + 'Create an instance for presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a new slide of comparison slide layout type. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Comparison) + 'Clone the entire presentation. + Dim presentationClone As IPresentation = presentation__1.Clone() + 'Add a new slide of title layout type. + slide = presentationClone.Slides.Add(SlideLayoutType.Title) + 'Add an auto shape of regular pentagon auto shape type. + slide.Shapes.AddShape(AutoShapeType.RegularPentagon, 10, 20, 300, 400) + 'Save the cloned presentation + presentationClone.Save("Sample.pptx") + 'Close the presentation. + presentation__1.Close() + 'Close the cloned presentation. + presentationClone.Close() + + + + + + Removes the macros from the presentation instance. + + + + //Opens an existing macro enabled PowerPoint presentation + IPresentation pptxDoc = Presentation.Open("Sample.PPTM"); + //Checks whether the presentation has macros and then removes them + if (pptxDoc.HasMacros) + pptxDoc.RemoveMacros(); + //Saves the presentation + pptxDoc.Save("Output.pptx"); + //Closes the presentation + pptxDoc.Close(); + + + 'Opens an existing macro enabled PowerPoint presentation + Dim pptxDoc As IPresentation = Presentation.Open("Sample.PPTM") + 'Checks whether the presentation has macros and then removes them + If pptxDoc.HasMacros Then + pptxDoc.RemoveMacros() + End If + 'Saves the presentation + pptxDoc.Save("Output.pptx") + 'Closes the presentation + pptxDoc.Close() + + + + + + Sets the write protection for the presentation instance + + Password to enforce protection. + Maximum length of password should be 15. If it exceeds 15, first 15 characters will be considered for protection, remaining will be ignored. + + + //Create an instance for presentation + IPresentation presentation = Presentation.Create(); + //Add a new slide of comparison slide layout type. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Comparison); + //Add an auto shape of regular pentagon auto shape type. + slide.Shapes.AddShape(AutoShapeType.RegularPentagon, 10, 20, 300, 400); + //Set the write protection for Presentation instance with password. + presentation.SetWriteProtection("MYPASSWORD"); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create an instance for presentation + Dim presentation As IPresentation = Presentation.Create() + 'Add a new slide of comparison slide layout type. + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Comparison) + 'Add an auto shape of regular pentagon auto shape type. + slide.Shapes.AddShape(AutoShapeType.RegularPentagon, 10, 20, 300, 400) + 'Set the write protection for Presentation instance with password. + presentation.SetWriteProtection("MYPASSWORD") + 'Save the presentation + presentation.Save("Sample.pptx") + 'Close the presentation. + presentation.Close() + + + + + + Removes the write Protection from presentation instance + + + + //Create an instance for presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Check whether the presentation is write protected. + if (presentation.IsWriteProtected) + { + //Removes the write protection from presentation instance + presentation.RemoveWriteProtection(); + } + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create an instance for presentation + Dim presentation As IPresentation = Presentation.Open("Sample.pptx") + 'Check whether the presentation is write protected. + if (presentation.IsWriteProtected) + { + //Removes the write protection from presentation instance + presentation.RemoveWriteProtection() + } + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation. + presentation.Close() + + + + + + Finds the text based on specified string, taking into the consideration of caseSensitive and wholeWord options. + + + A text to find. + + + Set to true to match the similar case text which specified in the parameter; otherwise false. + + + Set to true to match the whole word text which specified in the parameter; otherwise false. + + + The that contains the found text in the document. + + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with a text + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Hello World"); + // Finds the text from the Presentation document + ITextSelection textSelection = presentation.Find("World", false, false); + // Gets the found text containing text parts + foreach (ITextPart textPart in textSelection.GetTextParts()) + { + //Sets Bold property + textPart.Font.Bold = true; + } + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Creates a presentation. + Dim presentation As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + 'Add a new paragraph with a text + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Hello World") + 'Finds the text from the Presentation document + Dim textSelection As ITextSelection = presentation.Find("World", False, False) + 'Gets the text parts from the selection + For Each textPart As ITextPart In textSelection.GetTextParts() + textPart.Font.Bold = True + Next + presentation.Save("Output.pptx") + presentation.Close() + + + + + + Finds the first occurrence of text that matches the specified Regex pattern. + + + The used to find the text. + + + The that contains the found text in the document. + + /// + + //Opens an existing presentation. + using (IPresentation pptxDoc = Presentation.Open("Input.pptx")) + { + // Create a regex pattern to find a text that starts with 'H' and ends with 'o'. + Regex regex = new Regex("H.+?o"); + //Find the first occurrence of a specified regular expression. + ITextSelection textSelection = pptxDoc.Find(regex); + //Gets the found text as single text part + ITextPart textPart = textSelection.GetAsOneTextPart(); + //Replace the text + textPart.Text = "Replaced text"; + //Saves the Presentation + pptxDoc.Save("Output.pptx"); + } + + + 'Opens an existing presentation. + Using pptxDoc As IPresentation = Presentation.Open("Input.pptx") + ' Create a regex pattern to find a text that starts with 'H' and ends with 'o'. + Dim regex As Regex = New Regex("H.+?o") + 'Find the first occurrence of a specified regular expression. + Dim textSelection As ITextSelection = pptxDoc.Find(regex) + 'Gets the found text as single text part + Dim textPart As ITextPart = textSelection.GetAsOneTextPart() + 'Replace the text + textPart.Text = "Replaced text" + 'Saves the Presentation + pptxDoc.Save("Output.pptx") + End Using + + + + + + Finds and returns all entries of the specified string, taking into the consideration of caseSensitive and wholeWord options. + + + A text to find. + + + Set to true to match the similar case text which specified in the parameter; otherwise false. + + + Set to true to match the whole word text which specified in the parameter; otherwise false. + + + The collection that contains all the entries of the found text in the document. + + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with a text + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Hello World"); + // Finds all the text from the Presentation document + ITextSelection[] textSelections = presentation.FindAll("World", false, false); + foreach (ITextSelection textSelection in textSelections) + { + //Gets the found text as single text part + ITextPart textPart = textSelection.GetAsOneTextPart(); + //Replace the text + textPart.Text = "Replaced text"; + } + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Creates a presentation. + Dim presentation As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + 'Add a new paragraph with a text + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Hello World") + 'Finds the text from the Presentation document + Dim textSelections As ITextSelection() = presentation.FindAll("World", False, False) + 'Gets the found text as single text part and replace it + For Each textSelection As ITextSelection In textSelections + Dim textPart As ITextPart = textSelection.GetAsOneTextPart() + textPart.Text = "Replaced text" + Next + presentation.Save("Output.pptx") + presentation.Close() + + + + + + Finds all occurrences of text that match the specified Regex pattern. + + + The used to find the text. + + + The collection that contains all the entries of the found text in the document. + + + + //Opens an existing presentation. + using (IPresentation pptxDoc = Presentation.Open("Input.pptx")) + { + // Create a regex pattern to find a text that starts with 'H' and ends with 'o'. + Regex regex = new Regex("H.+?o"); + //Finds all the occurrences of a specified regular expression. + ITextSelection[] textSelections = pptxDoc.FindAll(regex); + foreach (ITextSelection textSelection in textSelections) + { + //Gets the found text as single text part + ITextPart textPart = textSelection.GetAsOneTextPart(); + //Replace the text + textPart.Text = "Replaced text"; + } + //Saves the Presentation + pptxDoc.Save("Output.pptx"); + } + + + 'Opens an existing presentation. + Using pptxDoc As IPresentation = Presentation.Open("Input.pptx") + ' Create a regex pattern to find a text that starts with 'H' and ends with 'o'. + Dim regex As Regex = New Regex("H.+?o") + 'Finds all the occurrences of a specified regular expression. + Dim textSelections As ITextSelection() = pptxDoc.FindAll(regex) + For Each textSelection As ITextSelection In textSelections + 'Gets the found text as single text part + Dim textPart As ITextPart = textSelection.GetAsOneTextPart() + 'Replace the text + textPart.Text = "Replaced text" + Next + 'Saves the Presentation + pptxDoc.Save("Output.pptx") + End Using + + + + + + Returns a collection of instances. Read-only. + + + + //Creates a PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Adds a section to the PowerPoint presentation + ISection section = presentation.Sections.Add(); + //Sets a name to the created section + section.Name = "SectionDemo"; + //Adds a slide to the created section + ISlide slide = section.AddSlide(SlideLayoutType.Blank); + //Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo"); + //Saves the PowerPoint presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Creates a PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Adds a section to the PowerPoint presentation + Dim section As ISection = presentation__1.Sections.Add() + 'Sets a name to the created section + section.Name = "SectionDemo" + 'Adds a slide to the created section + Dim slide As ISlide = section.AddSlide(SlideLayoutType.Blank) + 'Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo") + 'Saves the PowerPoint presentation + presentation__1.Save("Sample.pptx") + 'Close the Presentation instance + presentation__1.Close() + + + + + + Gets the slide collection in the presentation. Read-only. + + + + //Open a presentation. + IPresentation presentation = Presentation.Open("Input.pptx"); + //Retrieve the slide collection, it is read only + ISlides slides = presentation.Slides; + //Add a slide to the presentation + ISlide slide = slides[0]; + //Create instance for slide background + IBackground background = slide.Background; + //Set the fill type for background as Pattern fill + background.Fill.FillType = FillType.Pattern; + //Set the pattern + background.Fill.PatternFill.Pattern = PatternFillType.DashedHorizontal; + //set the fore color of pattern + background.Fill.PatternFill.ForeColor = ColorObject.Lavender; + //Set the back color of pattern + background.Fill.PatternFill.BackColor = ColorObject.Brown; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open a presentation. + Dim presentation__1 As IPresentation = Presentation.Open("Input.pptx") + 'Retrieve the slide collection, it is read only + Dim slides As ISlides = presentation__1.Slides + 'Add a slide to the presentation + Dim slide As ISlide = slides(0) + 'Create instance for slide background + Dim background As IBackground = slide.Background + 'Set the fill type for background as Pattern fill + background.Fill.FillType = FillType.Pattern + 'Set the pattern + background.Fill.PatternFill.Pattern = PatternFillType.DashedHorizontal + 'set the fore color of pattern + background.Fill.PatternFill.ForeColor = ColorObject.Lavender + 'Set the back color of pattern + background.Fill.PatternFill.BackColor = ColorObject.Brown + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + + Gets or sets a value indicating whether the instance is marked as final. + + + + //Create an instance for PowerPoint presentation + IPresentation pptxDoc = Presentation.Create(); + //Add slide to the presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Mark the presentation as final + pptxDoc.Final = true; + //Save the presentation + pptxDoc.Save("Sample.pptx"); + //Close the presentation + pptxDoc.Close(); + + + 'Create an instance for PowerPoint presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Mark the presentation as final + pptxDoc.Final = True + 'Save the presentation + pptxDoc.Save("Sample.pptx") + 'Close the presentation + pptxDoc.Close() + + + + + + + Gets the instance. + + + Initialize the ChartToImageConverter in-order to convert the chart in presentation to image. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Initialize the chart to image converter. + presentation.ChartToImageConverter = new ChartToImageConverter(); + //Set the scaling mode for the chart. + presentation.ChartToImageConverter.ScalingMode = ScalingMode.Best; + //Add a blank slide for the chart. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a chart to the slide. + IPresentationChart officeChart = slide.Charts.AddChart(100, 100, 600, 400); + //Set chart data + officeChart.ChartData.SetValue(1, 4, "Month"); + officeChart.ChartData.SetValue(2, 4, "July"); + officeChart.ChartData.SetValue(3, 4, "August"); + officeChart.ChartData.SetValue(4, 4, "September"); + officeChart.ChartData.SetValue(5, 4, "October"); + officeChart.ChartData.SetValue(6, 4, "November"); + officeChart.ChartData.SetValue(7, 4, "December"); + officeChart.ChartData.SetValue(1, 1, "2013"); + officeChart.ChartData.SetValue(2, 1, 35); + officeChart.ChartData.SetValue(3, 1, 37); + officeChart.ChartData.SetValue(4, 1, 30); + officeChart.ChartData.SetValue(5, 1, 29); + officeChart.ChartData.SetValue(6, 1, 25); + officeChart.ChartData.SetValue(7, 1, 30); + officeChart.ChartData.SetValue(1, 2, "2014"); + officeChart.ChartData.SetValue(2, 2, 30); + officeChart.ChartData.SetValue(3, 2, 25); + officeChart.ChartData.SetValue(4, 2, 29); + officeChart.ChartData.SetValue(5, 2, 35); + officeChart.ChartData.SetValue(6, 2, 38); + officeChart.ChartData.SetValue(7, 2, 32); + officeChart.ChartData.SetValue(1, 3, "2015"); + officeChart.ChartData.SetValue(2, 3, 35); + officeChart.ChartData.SetValue(3, 3, 37); + officeChart.ChartData.SetValue(4, 3, 30); + officeChart.ChartData.SetValue(5, 3, 50); + officeChart.ChartData.SetValue(6, 3, 25); + officeChart.ChartData.SetValue(7, 3, 30); + //Add chart serie. + IOfficeChartSerie serie1 = officeChart.Series.Add("2013"); + //Set serie value. + serie1.Values = officeChart.ChartData[2, 1, 7, 1]; + //Add chart serie. + IOfficeChartSerie serie2 = officeChart.Series.Add("2014"); + //Set serie value. + serie2.Values = officeChart.ChartData[2, 2, 7, 2]; + //Add chart serie. + IOfficeChartSerie serie3 = officeChart.Series.Add("2015"); + //Set serie value. + serie3.Values = officeChart.ChartData[2, 3, 7, 3]; + //Set category labels value for the primary category axis. + officeChart.PrimaryCategoryAxis.CategoryLabels = officeChart.ChartData[2, 4, 7, 4]; + //Set the chart type. + officeChart.ChartType = OfficeChartType.Column_Clustered; + //Set the chart title. + officeChart.ChartTitle = "Mine Chart"; + //Convert the chart to image. + System.Drawing.Image[] chartImages = presentation.RenderAsImages(Syncfusion.Drawing.ImageType.Metafile); + foreach (System.Drawing.Image image in chartImages) + { + //Save the image. + image.Save("ChartToImageConverter" + Guid.NewGuid() + ".png"); + } + //Save the presentation. + presentation.Save("ChartToImageConverter.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Initialize the chart to image converter. + presentation__1.ChartToImageConverter = New ChartToImageConverter() + 'Set the scaling mode for the chart. + presentation__1.ChartToImageConverter.ScalingMode = ScalingMode.Best + 'Add a blank slide for the chart. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a chart to the slide. + Dim officeChart As IPresentationChart = slide.Charts.AddChart(100, 100, 600, 400) + 'Set chart data + officeChart.ChartData.SetValue(1, 4, "Month") + officeChart.ChartData.SetValue(2, 4, "July") + officeChart.ChartData.SetValue(3, 4, "August") + officeChart.ChartData.SetValue(4, 4, "September") + officeChart.ChartData.SetValue(5, 4, "October") + officeChart.ChartData.SetValue(6, 4, "November") + officeChart.ChartData.SetValue(7, 4, "December") + officeChart.ChartData.SetValue(1, 1, "2013") + officeChart.ChartData.SetValue(2, 1, 35) + officeChart.ChartData.SetValue(3, 1, 37) + officeChart.ChartData.SetValue(4, 1, 30) + officeChart.ChartData.SetValue(5, 1, 29) + officeChart.ChartData.SetValue(6, 1, 25) + officeChart.ChartData.SetValue(7, 1, 30) + officeChart.ChartData.SetValue(1, 2, "2014") + officeChart.ChartData.SetValue(2, 2, 30) + officeChart.ChartData.SetValue(3, 2, 25) + officeChart.ChartData.SetValue(4, 2, 29) + officeChart.ChartData.SetValue(5, 2, 35) + officeChart.ChartData.SetValue(6, 2, 38) + officeChart.ChartData.SetValue(7, 2, 32) + officeChart.ChartData.SetValue(1, 3, "2015") + officeChart.ChartData.SetValue(2, 3, 35) + officeChart.ChartData.SetValue(3, 3, 37) + officeChart.ChartData.SetValue(4, 3, 30) + officeChart.ChartData.SetValue(5, 3, 50) + officeChart.ChartData.SetValue(6, 3, 25) + officeChart.ChartData.SetValue(7, 3, 30) + 'Add chart serie. + Dim serie1 As IOfficeChartSerie = officeChart.Series.Add("2013") + 'Set serie value. + serie1.Values = officeChart.ChartData(2, 1, 7, 1) + 'Add chart serie. + Dim serie2 As IOfficeChartSerie = officeChart.Series.Add("2014") + 'Set serie value. + serie2.Values = officeChart.ChartData(2, 2, 7, 2) + 'Add chart serie. + Dim serie3 As IOfficeChartSerie = officeChart.Series.Add("2015") + 'Set serie value. + serie3.Values = officeChart.ChartData(2, 3, 7, 3) + 'Set category labels value for the primary category axis. + officeChart.PrimaryCategoryAxis.CategoryLabels = officeChart.ChartData(2, 4, 7, 4) + 'Set the chart type. + officeChart.ChartType = OfficeChartType.Column_Clustered + 'Set the chart title. + officeChart.ChartTitle = "Mine Chart" + 'Convert the chart to image. + Dim chartImages As Image() = presentation__1.RenderAsImages(Syncfusion.Drawing.ImageType.Metafile) + For Each image As Image In chartImages + 'Save the image. + image.Save("ChartToImageConverter" + Guid.NewGuid() + ".png") + Next + 'Save the presentation. + presentation__1.Save("ChartToImageConverter.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Gets an instance that represents the built in document properties of presentation. Read-only. + + + + //Create an instance for presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the built-in document property, it is read only + IBuiltInDocumentProperties builtin = presentation.BuiltInDocumentProperties; + //Set the application name + builtin.ApplicationName = "Essential Presentation"; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create an instance for presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the built-in document property, it is read only + Dim builtin As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the application name + builtin.ApplicationName = "Essential Presentation" + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets an instance that represents the custom document properties of presentation. Read-only. + + + + //Create a new presentation + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document properties. + ICustomDocumentProperties customDocumentProperties = presentation.CustomDocumentProperties; + //Add a new custom document property + customDocumentProperties.Add("Property1"); + //Set a Boolean value. + customDocumentProperties["Property1"].Boolean = true; + //Add a new custom document property + customDocumentProperties.Add("Property2"); + //Set a date time. + customDocumentProperties["Property2"].DateTime = DateTime.Now; + //Save the presentation + presentation.Save("CustomProperty.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document properties. + Dim customDocumentProperties As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add a new custom document property + customDocumentProperties.Add("Property1") + 'Set a Boolean value. + customDocumentProperties("Property1").[Boolean] = True + 'Add a new custom document property + customDocumentProperties.Add("Property2") + 'Set a date time. + customDocumentProperties("Property2").DateTime = DateTime.Now + 'Save the presentation + presentation__1.Save("CustomProperty.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets whether the presentation has macros. Read-only. + + + + //Opens an existing macro enabled PowerPoint presentation + IPresentation pptxDoc = Presentation.Open("Sample.PPTM"); + //Checks whether the presentation has macros and then removes them + if (pptxDoc.HasMacros) + pptxDoc.RemoveMacros(); + //Saves the presentation + pptxDoc.Save("Output.pptx"); + //Closes the presentation + pptxDoc.Close(); + + + 'Opens an existing macro enabled PowerPoint presentation + Dim pptxDoc As IPresentation = Presentation.Open("Sample.PPTM") + 'Checks whether the presentation has macros and then removes them + If pptxDoc.HasMacros Then + pptxDoc.RemoveMacros() + End If + 'Saves the presentation + pptxDoc.Save("Output.pptx") + 'Closes the presentation + pptxDoc.Close() + + + + + + Gets whether the presentation is write Protected. Read-only. + + + + //Create an instance for presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Check whether the presentation is write protected. + if (presentation.IsWriteProtected) + { + //Removes the write protection from presentation instance + presentation.RemoveWriteProtection(); + } + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create an instance for presentation + Dim presentation As IPresentation = Presentation.Open("Sample.pptx") + 'Check whether the presentation is write protected. + if (presentation.IsWriteProtected) + { + 'Removes the write protection from presentation instance + presentation.RemoveWriteProtection() + } + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation. + presentation.Close() + + + + + + Gets or sets the first slide number of the PowerPoint Presentation. The default value is 1. + + + First slide number is the starting slide number of presentation, and this API allows to set the first slide number from 0 to 9999. + + + + //Creates a new PowerPint Presentation. + using (IPresentation presentation = Presentation.Create()) + { + //Sets the first slide number of the PowerPoint Presentation. + presentation.FirstSlideNumber = 5; + //Adds slide to the PowerPoint. + ISlide slide1 = presentation.Slides.Add(SlideLayoutType.TitleAndContent); + //Adds slide to the PowerPoint. + ISlide slide2 = presentation.Slides.Add(SlideLayoutType.TitleAndContent); + //Adds slide to the PowerPoint. + ISlide slide3 = presentation.Slides.Add(SlideLayoutType.TitleAndContent); + //Gets the first slide slidenumber. + int firstSlideNumber = slide1.SlideNumber; + //Gets the second slide slidenumber. + int secondSlideNumber = slide2.SlideNumber; + //Saves the PowerPoint Presentation. + presentation.Save("Output.pptx"); + } + + + 'Creates a PowerPoint instance + Using pptxDoc As IPresentation = Presentation.Create() + 'Sets the first slide number of the PowerPoint Presentation. + pptxDoc.FirstSlideNumber = 5 + 'Adds a slide to the PowerPoint presentation + Dim slide1 As ISlide = pptxDoc.Slides.Add(SlideLayoutType.TitleAndContent) + 'Adds a slide to the PowerPoint presentation + Dim slide2 As ISlide = pptxDoc.Slides.Add(SlideLayoutType.TitleAndContent) + 'Adds a slide to the PowerPoint presentation + Dim slide3 As ISlide = pptxDoc.Slides.Add(SlideLayoutType.TitleAndContent) + 'Gets the first slide slidenumber. + Dim firstSlideNumber As Integer = slide1.SlideNumber + 'Gets the second slide slidenumber. + Dim secondSlideNumber As Integer = slide2.SlideNumber + 'Saves the Presentation to the file system. + pptxDoc.Save("Output.pptx") + End Using + + + + + + Represents the slide in the presentation. + + + + + Converts the slide to image. + + Specifies the image type to convert the slide. + Returns an image instance that represents the converted slide. + + + //Open a PowerPoint presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Convert the slides to images + System.Drawing.Image[] images = presentation.RenderAsImages(Syncfusion.Drawing.ImageType.Bitmap); + //Close the PowerPoint presentation + presentation.Close(); + + + 'Open a PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Open("Sample.pptx") + 'Convert the slides to images + Dim images As Image() = presentation__1.RenderAsImages(Syncfusion.Drawing. ImageType.Bitmap) + 'Close the PowerPoint presentation + presentation__1.Close() + + + + + + Converts the slide to image. + + Specifies the image format to convert the slide. + Returns a stream instance that represents the converted slide. + + + //Create a presentation. + IPresentation presentation = Presentation.Open("Input.pptx"); + //Create instance for chart to image converter + presentation.ChartToImageConverter = new ChartToImageConverter(); + //Set the scaling mode + presentation.ChartToImageConverter.ScalingMode = Syncfusion.OfficeChart.ScalingMode.Best; + //Retrieve the first slide from presentation + ISlide slide = presentation.Slides[0]; + //Convert slide to image + Image image = Image.FromStream(slide.ConvertToImage(Syncfusion.Drawing.ImageFormat.Emf)); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation. + Dim presentation__1 As IPresentation = Presentation.Open("Input.pptx") + 'Create instance for chart to image converter + presentation__1.ChartToImageConverter = New ChartToImageConverter() + 'Set the scaling mode + presentation__1.ChartToImageConverter.ScalingMode = Syncfusion.OfficeChart.ScalingMode.Best + 'Retrieve the first slide from presentation + Dim slide As ISlide = presentation__1.Slides(0) + 'Convert slide to image + Dim image__2 As Image = Image.FromStream(slide.ConvertToImage(Syncfusion.Drawing.ImageFormat.Emf)) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Moves the slide to the start of the specified section index. + + Specifies the section index to be moved. + + + + Adds a new notes to the slide. + + Returns the notes slide of instance. + + + + Adds a text box to the slide. + + Represents the left position,in points. The Left value ranges from -169056 to 169056. + Represents the top position,in points. The Top value ranges from -169056 to 169056. + Represents the width,in points. The Width value ranges from 0 to 169056. + Represents the height,in points. The Height value ranges from 0 to 169056. + Returns an instance that represents the text box. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a new slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide. + IShape shape = slide.AddTextBox(10, 10, 300, 350); + //Add a paragraph with text content to the shape. + shape.TextBody.AddParagraph("This is a new text box"); + //Save the presentation. + presentation.Save("Slide_TextBox.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a new slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide. + Dim shape As IShape = slide.AddTextBox(10, 10, 300, 350) + 'Add a paragraph with text content to the shape. + shape.TextBody.AddParagraph("This is a new text box") + 'Save the presentation. + presentation__1.Save("Slide_TextBox.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Creates an independent copy of instance. + + Returns the cloned slide instance. + + + //Open an existing presentation. + IPresentation presentation = Presentation.Open("Presentation.pptx"); + //Retrieve the slide instance. + ISlide slide = presentation.Slides[0]; + //Create a cloned copy of slide. + ISlide slideClone = slide.Clone(); + //Add a new text box to the cloned slide. + IShape textboxShape = slideClone.AddTextBox(0, 0, 250, 250); + //Add a paragraph with text content to the shape. + textboxShape.TextBody.AddParagraph("Hello Presentation"); + //Add the slide to the presentation. + presentation.Slides.Add(slideClone); + //Save the presentation to the file system. + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open an existing presentation. + Dim presentation__1 As IPresentation = Presentation.Open("Presentation.pptx") + 'Retrieve the slide instance. + Dim slide As ISlide = presentation__1.Slides(0) + 'Create a cloned copy of slide. + Dim slideClone As ISlide = slide.Clone() + 'Add a new text box to the cloned slide. + Dim textboxShape As IShape = slideClone.AddTextBox(0, 0, 250, 250) + 'Add a paragraph with text content to the shape. + textboxShape.TextBody.AddParagraph("Hello Presentation") + 'Add the slide to the presentation. + presentation__1.Slides.Add(slideClone) + 'Save the presentation to the file system. + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the notes slide. + + + + + Gets or sets the boolean value which indicates whether the slide is visible or not. + + + true if this slide instance is visible; otherwise, false. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Hide the slide in presentation + slide.Visible = false; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Hide the slide in presentation + slide.Visible = False + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the number of the current slide. Read-only. + + + + + Returns the section instance of the slide. Read-only. + + If there is no sections associated with the slide then the Section property will be “null” + + + + Gets the Unique ID for the current slide. Read-only. The Unique ID ranges from 256 to 2147483647. + + + + + Gets the current notes slide instance. Returns null if no notes are present. + + + + + Gets the layout slide instance of current slide. + + + + + Returns the collection of slide comments. Read-only. + + + + //Create a new presentation. + IPresentation presDoc = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add a paragraph to the textbody of the shape + shape.TextBody.AddParagraph("Hi Syncfusion Customers"); + //Add a comment to the slide + IComment comment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now); + //Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment); + //Get the collection of the comments + IComments comments = slide.Comments; + //Save the presentation to the file system. + presDoc.Save("Output.pptx"); + //Close the presentation + presDoc.Close(); + + + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add a paragraph to the text body of the shape + shape.TextBody.AddParagraph() + 'Add a comment to the slide + Dim comment As IComment = slide.Comments.Add(0.35, 0.04, "Author1", "A1", "Essential Presentation is available from 13.1 versions of Essential Studio", DateTime.Now); + 'Author2 add reply to a parent comment + slide.Comments.Add("Author2", "A2", "Does it support rendering of slides as images or PDF?", DateTime.Now, comment); + 'Get the collection of the comments + Dim comments As IComments = slide.Comments; + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + + + + + + Represents the slide collection. + + + + + Adds a slide at the end of the slide collection. + + Returns the newly created instance. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Create instance to hold the slide collection + ISlides slides = presentation.Slides; + //Add slide to presentation + slides.Add(); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Create instance to hold the slide collection + Dim slides As ISlides = presentation__1.Slides + 'Add slide to presentation + slides.Add() + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Creates an instance with relation to the specified instance and adds it to the collection. + + Layout slide instance + Returns the slide with the specified slide layout. + + + + Adds the specified slide at the end of the slide collection. + + Represents an instance to be added. + Returns the zero based index of the specified slide in the slide collection if found otherwise -1 + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Create instance to hold the slide collection + ISlides slides = presentation.Slides; + //Add slide to collection + ISlide slide = slides.Add(SlideLayoutType.TwoContent); + //Retrieve the specific slide item, read only + ISlide _slide = slides[0]; + slides.Add(_slide); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Create instance to hold the slide collection + Dim slides As ISlides = presentation__1.Slides + 'Add slide to collection + Dim slide As ISlide = slides.Add(SlideLayoutType.TwoContent) + 'Retrieve the specific slide item, read only + Dim _slide As ISlide = slides(0) + slides.Add(_slide) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Adds the specified cloned slide at the end of slide collection with specified paste options. + + An instance to be added to the destination presentation. + Specifies the for merging the slide. + Optional Parameter. An instance of the source presentation from which the slide is cloned from. + The cloned slide can be added within the same presentation or this can be done between one presentation to another + + + //Open the source presentation + IPresentation sourcePresentation = Presentation.Open("Source.pptx"); + //Open the destination presentation + IPresentation destinationPresentation = Presentation.Open("Destination.pptx"); + //Clone the first slide of the source presentation. + ISlide clonedSlide = sourcePresentation.Slides[0].Clone(); + //Merge the cloned slide to the destination presentation with paste option - Destination Them. + destinationPresentation.Slides.Add(clonedSlide, PasteOptions.UseDestinationTheme); + //Save the destination presentation. + destinationPresentation.Save("Output.pptx"); + // Close the presentation + destinationPresentation.Close(); + sourcePresentation.Close(); + + + 'Open the source presentation + Dim sourcePresentation As IPresentation = Presentation.Open("Source.pptx") + 'Open the destination presentation + Dim destinationPresentation As IPresentation = Presentation.Open("Destination.pptx") + 'Clone the first slide of the source presentation. + Dim clonedSlide As ISlide = sourcePresentation.Slides(0).Clone() + 'Merge the cloned slide to the destination presentation with paste option - Destination Them. + destinationPresentation.Slides.Add(clonedSlide, PasteOptions.UseDestinationTheme) + 'Save the destination presentation. + destinationPresentation.Save("Output.pptx") + 'Closes the destination presentation. + destinationPresentation.Close() + sourcePresentation.Close() + + + + + + Creates a slide with the specified layout type and adds the new slide to the end of slide collection. + + Specifies the slide layout type. + Returns the newly created instance. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Create instance to hold the slide collection + ISlides slides = presentation.Slides; + //Add slide to collection + ISlide slide = slides.Add(SlideLayoutType.TwoContent); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Create instance to hold the slide collection + Dim slides As ISlides = presentation__1.Slides + 'Add slide to collection + Dim slide As ISlide = slides.Add(SlideLayoutType.TwoContent) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Inserts the specified slide into the slide collection at specified index. + + The zero-based index at which the slide should be inserted. + The slide value to insert. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Create instance to hold the slide collection + ISlides slides = presentation.Slides; + //Add slide to collection + ISlide slide = slides.Add(SlideLayoutType.TwoContent); + //Insert a slide at specific index in collection + slides.Insert(2, slides.Add()); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Create instance to hold the slide collection + Dim slides As ISlides = presentation__1.Slides + 'Add slide to collection + Dim slide As ISlide = slides.Add(SlideLayoutType.TwoContent) + 'Insert a slide at specific index in collection + slides.Insert(2, slides.Add()) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the slide at the specified index, from the slide collection. + + The zero-based index of the element to be removed. + + + //Create a new presentation. + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Create instance to hold the slide collection + ISlides slides = presentation.Slides; + //Remove slide from specific index + slides.RemoveAt(0); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Open("Sample.pptx") + 'Create instance to hold the slide collection + Dim slides As ISlides = presentation__1.Slides + 'Remove slide from specific index + slides.RemoveAt(0) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the first occurrence of a specified slide from the slide collection. + + The slide to be removed from the collection. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Create instance to hold the slide collection + ISlides slides = presentation.Slides; + //Add slide to collection + ISlide slide = slides.Add(SlideLayoutType.TwoContent); + //Remove a specific slide object + slides.Remove(slide); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Create instance to hold the slide collection + Dim slides As ISlides = presentation__1.Slides + 'Add slide to collection + Dim slide As ISlide = slides.Add(SlideLayoutType.TwoContent) + 'Remove a specific slide object + slides.Remove(slide) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Returns the zero-based index of the first occurrence of the instance within the slide collection. + + The instance to locate in the collection. + Returns the zero-based index of the first occurrence of slide within the collection, if found; otherwise, –1. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Create instance to hold the slide collection + ISlides slides = presentation.Slides; + //Add slide to collection + ISlide slide = slides.Add(SlideLayoutType.TwoContent); + //Get the index of the slide instance + int index = slides.IndexOf(slide); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Create instance to hold the slide collection + Dim slides As ISlides = presentation__1.Slides + 'Add slide to collection + Dim slide As ISlide = slides.Add(SlideLayoutType.TwoContent) + 'Get the index of the slide instance + Dim index As Integer = slides.IndexOf(slide) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes all the slides in the presentation. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Create instance to hold the slide collection + ISlides slides = presentation.Slides; + //Add slide to collection + ISlide slide = slides.Add(SlideLayoutType.TwoContent); + //Retrieve the specific slide item, read only + ISlide _slide = slides[0]; + slides.Add(_slide); + //Clear the slide collection + slides.Clear(); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Create instance to hold the slide collection + Dim slides As ISlides = presentation__1.Slides + 'Add slide to collection + Dim slide As ISlide = slides.Add(SlideLayoutType.TwoContent) + 'Retrieve the specific slide item, read only + Dim _slide As ISlide = slides(0) + slides.Add(_slide) + 'Clear the slide collection + slides.Clear() + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Adds the specified cloned slide at the specified index of slide collection with specified paste options. + + Specifies the index position of the slide in which the cloned slide should get added + An instance to be added to the destination presentation. + Specifies the for merging the slide. + Optional Parameter. An instance of the source presentation from which the slide is cloned from. + The cloned slide can be added within the same presentation or this can be done between one presentation to another + + + //Open the source presentation + IPresentation sourcePresentation = Presentation.Open("Source.pptx"); + //Open the destination presentation + IPresentation destinationPresentation = Presentation.Open("Destination.pptx"); + //Clone the first slide of the source presentation. + ISlide clonedSlide = sourcePresentation.Slides[0].Clone(); + //Merge the cloned slide to the destination presentation with paste option - Destination Them. + destinationPresentation.Slides.Insert(1, clonedSlide, PasteOptions.UseDestinationTheme); + //Save the destination presentation. + destinationPresentation.Save("Output.pptx"); + + + 'Open the source presentation + Dim sourcePresentation As IPresentation = Presentation.Open("Source.pptx") + 'Open the destination presentation + Dim destinationPresentation As IPresentation = Presentation.Open("Destination.pptx") + 'Clone the first slide of the source presentation. + Dim clonedSlide As ISlide = sourcePresentation.Slides(0).Clone() + 'Merge the cloned slide to the destination presentation with paste option - Destination Them. + destinationPresentation.Slides.Insert(1, clonedSlide, PasteOptions.UseDestinationTheme) + 'Save the destination presentation. + destinationPresentation.Save("Output.pptx") + + + + + + Gets the number of elements in the slide collection. Read-only. + + + The total count of the slides. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Create instance to hold the slide collection + ISlides slides = presentation.Slides; + //Add slide to presentation + slides.Add(); + //Add a blank slide to the presentation. + slides.Add(SlideLayoutType.Blank); + //Add slide to the collection by passing the slide instance + slides.Add(slides.Add(SlideLayoutType.Title)); + //Get the slide count, read only + int count = slides.Count; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Create instance to hold the slide collection + Dim slides As ISlides = presentation__1.Slides + 'Add slide to presentation + slides.Add() + 'Add a blank slide to the presentation. + slides.Add(SlideLayoutType.Blank) + 'Add slide to the collection by passing the slide instance + slides.Add(slides.Add(SlideLayoutType.Title)) + 'Get the slide count, read only + Dim count As Integer = slides.Count + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the instance at the specified index in slide collection. Read-only. + + The index to locate the slide. + Returns the slide at the specified index in slide collection. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Create instance to hold the slide collection + ISlides slides = presentation.Slides; + //Add slide to presentation + slides.Add(); + //Add a blank slide to the presentation. + slides.Add(SlideLayoutType.Blank); + //Add slide to the collection by passing the slide instance + slides.Add(slides.Add(SlideLayoutType.Title)); + //Retrieve the specific slide item, read only + ISlide _slide = slides[0]; + //Set the slide name + _slide.Name = "My Slide"; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Create instance to hold the slide collection + Dim slides As ISlides = presentation__1.Slides + 'Add slide to presentation + slides.Add() + 'Add a blank slide to the presentation. + slides.Add(SlideLayoutType.Blank) + 'Add slide to the collection by passing the slide instance + slides.Add(slides.Add(SlideLayoutType.Title)) + 'Retrieve the specific slide item, read only + Dim _slide As ISlide = slides(0) + 'Set the slide name + _slide.Name = "My Slide" + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents the size and bounds of a slide. + + + + + Gets or sets the predefined size type. + + + The slide size type of the slide. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for slide size + ISlideSize slideSize = slide.SlideSize; + //Set the type of slide size + slideSize.Type = SlideSizeType.Banner; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for slide size + Dim slideSize As ISlideSize = slide.SlideSize + 'Set the type of slide size + slideSize.Type = SlideSizeType.Banner + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the width, in points. Read-only. + + + The width of the slide. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for slide size + ISlideSize slideSize = slide.SlideSize; + //Get the width of the slide size, read only + double width = slideSize.Width; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for slide size + Dim slideSize As ISlideSize = slide.SlideSize + 'Get the width of the slide size, read only + Dim width As Double = slideSize.Width + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the height, in points. Read-only. + + + The height of the slide. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for slide size + ISlideSize slideSize = slide.SlideSize; + //Get the height of the slide size, read only + double height = slideSize.Height; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for slide size + Dim slideSize As ISlideSize = slide.SlideSize + 'Get the height of the slide size, read only + Dim height As Double = slideSize.Height + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the slide orientation. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance for slide size + ISlideSize slideSize = slide.SlideSize; + //Retrieve the slide orientation + SlideOrientation slideOrientation = slideSize.SlideOrientation; + //Set the slide orientation + slideOrientation = SlideOrientation.Landscape; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance for slide size + Dim slideSize As ISlideSize = slide.SlideSize + 'Retrieve the slide orientation + Dim slideOrientation__2 As SlideOrientation = slideSize.SlideOrientation + 'Set the slide orientation + slideOrientation__2 = SlideOrientation.Landscape + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents the font attributes of the text. + + + + + Gets or sets the caps type. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Create instance by adding text part to the shape + ITextPart textPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart"); + //Create font instance for text part + IFont font = textPart.Font; + //Set the caps type for text part + font.CapsType = TextCapsType.Small; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Create instance by adding text part to the shape + Dim textPart As ITextPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart") + 'Create font instance for text part + Dim font As IFont = textPart.Font + 'Set the caps type for text part + font.CapsType = TextCapsType.Small + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the foreground color of the text. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Create instance by adding text part to the shape + ITextPart textPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart"); + //Create font instance for text part + IFont font = textPart.Font; + //Create instance to hold color properties of font + IColor color = font.Color; + //Set font color for text part + color = ColorObject.Green; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Create instance by adding text part to the shape + Dim textPart As ITextPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart") + 'Create font instance for text part + Dim font As IFont = textPart.Font + 'Create instance to hold color properties of font + Dim color As IColor = font.Color + 'Set font color for text part + color = ColorObject.Green + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a value that indicates whether the text is bold or not. + + + true if bold; otherwise, false. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Create instance by adding text part to the shape + ITextPart textPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart"); + //Create font instance for text part + IFont font = textPart.Font; + //Set text part with bold style + font.Bold = true; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Create instance by adding text part to the shape + Dim textPart As ITextPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart") + 'Create font instance for text part + Dim font As IFont = textPart.Font + 'Set text part with bold style + font.Bold = True + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a boolean value that indicates whether the text is italic or not. + + + true if italic; otherwise, false. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Create instance by adding text part to the shape + ITextPart textPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart"); + //Create font instance for text part + IFont font = textPart.Font; + //Set text part with italic style + font.Italic = true; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Create instance by adding text part to the shape + Dim textPart As ITextPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart") + 'Create font instance for text part + Dim font As IFont = textPart.Font + 'Set text part with italic style + font.Italic = True + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a boolean value that indicates whether the text is subscript or not. + + + true if subscript; otherwise, false. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Create instance by adding text part to the shape + ITextPart textPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart"); + //Create font instance for text part + IFont font = textPart.Font; + //Set the subscript + font.Subscript = true; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Create instance by adding text part to the shape + Dim textPart As ITextPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart") + 'Create font instance for text part + Dim font As IFont = textPart.Font + 'Set the subscript + font.Subscript = True + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a boolean value that indicates whether the text is superscript or not. + + + true if superscript; otherwise, false. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Create instance by adding text part to the shape + ITextPart textPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart"); + //Create font instance for text part + IFont font = textPart.Font; + //Set the superscript + font.Superscript = true; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Create instance by adding text part to the shape + Dim textPart As ITextPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart") + 'Create font instance for text part + Dim font As IFont = textPart.Font + 'Set the superscript + font.Superscript = True + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the name of the font. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Create instance by adding text part to the shape + ITextPart textPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart"); + //Create font instance for text part + IFont font = textPart.Font; + //Set the font name + font.FontName = "Calibri"; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Create instance by adding text part to the shape + Dim textPart As ITextPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart") + 'Create font instance for text part + Dim font As IFont = textPart.Font + 'Set the font name + font.FontName = "Calibri" + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the size of the font. + + + + ///Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Create instance by adding text part to the shape + ITextPart textPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart"); + //Create font instance for text part + IFont font = textPart.Font; + //Set font size of the text + font.FontSize = 32; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Create instance by adding text part to the shape + Dim textPart As ITextPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart") + 'Create font instance for text part + Dim font As IFont = textPart.Font + 'Set font size of the text + font.FontSize = 32 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the strike through type. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Create instance by adding text part to the shape + ITextPart textPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart"); + //Create font instance for text part + IFont font = textPart.Font; + //Set strike type for text part + font.StrikeType = TextStrikethroughType.None; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Create instance by adding text part to the shape + Dim textPart As ITextPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart") + 'Create font instance for text part + Dim font As IFont = textPart.Font + 'Set strike type for text part + font.StrikeType = TextStrikethroughType.None + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the underline type. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Create instance by adding text part to the shape + ITextPart textPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart"); + //Create font instance for text part + IFont font = textPart.Font; + //Set underline type of font + font.Underline = TextUnderlineType.Dash; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Create instance by adding text part to the shape + Dim textPart As ITextPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart") + 'Create font instance for text part + Dim font As IFont = textPart.Font + 'Set underline type of font + font.Underline = TextUnderlineType.Dash + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the language identifier (locale). + + The short value that specifies the equivalent locale id. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Create instance by adding text part to the shape + ITextPart textPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart"); + //Create font instance for text part + IFont font = textPart.Font; + //Sets a language as "Spanish (Argentina)" for TextPart + font.LanguageID = (short) LocaleIDs.es_AR; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Create instance by adding text part to the shape + Dim textPart As ITextPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart") + 'Create font instance for text part + Dim font As IFont = textPart.Font + 'Sets a language as "Spanish (Argentina)" for TextPart + font.LanguageID = CType(LocaleIDs.es_AR,Short) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the Highlight color of the text. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Create instance by adding text part to the shape + ITextPart textPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph, second TextPart"); + //Create font instance for text part + IFont font = textPart.Font; + //Create instance to hold color properties of font + IColor color = ColorObject.Yellow; + //Set Highlight color for text part + font.HighlightColor = color; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Create instance by adding text part to the shape + Dim textPart As ITextPart = shape.TextBody.AddParagraph().AddTextPart("First Paragraph") + 'Create font instance for text part + Dim font As IFont = textPart.Font + 'Create instance to hold highlight color properties of font + Dim color As IColor = font.HighlightColor + 'Set font color for text part + color = ColorObject.Yellow + 'Save the presentation + presentation.Save("Sample.pptx") + 'Close the presentation + presentation.Close() + + + + + + Represents a list or bullet formatting options. + + + + The picture stream. + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with the text in the left hand side text box. + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."); + //Set the list type as Numbered + paragraph.ListFormat.Type = ListType.Picture; + //Set the image for the list. + paragraph.ListFormat.Picture(new MemoryStream(Syncfusion.Drawing.Image.FromFile("Image.gif").ImageData)); + // Set the picture size. If 100, here means 100% of its text. Possible values can range from 25 to 400 + paragraph.ListFormat.Size = 150; + //Set the list level as 1 + paragraph.IndentLevelNumber = 1; + // Set the hanging value + paragraph.FirstLineIndent = -20; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation instance. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + ' Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + ' Add a new paragraph with the text in the left hand side text box. + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.") + 'Set the list type as Numbered + paragraph.ListFormat.Type = ListType.Picture + 'Set the image for the list. + paragraph.ListFormat.Picture(New MemoryStream(Syncfusion.Drawing.Image.FromFile("Image.gif").ImageData)) + ' Set the picture size. If 100, here means 100% of its text. Possible values can range from 25 to 400 + paragraph.ListFormat.Size = 150 + 'Set the list level as 1 + paragraph.IndentLevelNumber = 1 + ' Set the hanging value + paragraph.FirstLineIndent = -20 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the Unicode character value that is used for bullets in the specified text. + + + The character. + + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with the text in the left hand side text box. + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."); + //Set the list level as 1 + paragraph.IndentLevelNumber = 1; + // Set the hanging value + paragraph.FirstLineIndent = -20; + //Create list format instance for the paragraph + IListFormat listFormat = paragraph.ListFormat; + //Set the type of list + listFormat.Type = ListType.Bulleted; + //Set the character for bullet + listFormat.BulletCharacter = '♠'; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation instance. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + ' Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + ' Add a new paragraph with the text in the left hand side text box. + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.") + 'Set the list level as 1 + paragraph.IndentLevelNumber = 1 + ' Set the hanging value + paragraph.FirstLineIndent = -20 + 'Create list format instance for the paragraph + Dim listFormat As IListFormat = paragraph.ListFormat + 'Set the type of list + listFormat.Type = ListType.Bulleted + 'Set the character for bullet + listFormat.BulletCharacter = "♠"C + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + The number style. + + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with the text in the left hand side text box. + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."); + //Set the list level as 1 + paragraph.IndentLevelNumber = 1; + // Set the hanging value + paragraph.FirstLineIndent = -20; + //Create instance for list format + IListFormat listFormat = paragraph.ListFormat; + //Set the list type as Numbered + listFormat.Type = ListType.Numbered; + //Set the numbered style (list numbering) as Arabic number following by period. + listFormat.NumberStyle = NumberedListStyle.ArabicPeriod; + //Set the starting value as 1 + listFormat.StartValue = 1; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation instance. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + ' Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + ' Add a new paragraph with the text in the left hand side text box. + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.") + 'Set the list level as 1 + paragraph.IndentLevelNumber = 1 + ' Set the hanging value + paragraph.FirstLineIndent = -20 + 'Create instance for list format + Dim listFormat As IListFormat = paragraph.ListFormat + 'Set the list type as Numbered + listFormat.Type = ListType.Numbered + 'Set the numbered style (list numbering) as Arabic number following by period. + listFormat.NumberStyle = NumberedListStyle.ArabicPeriod + 'Set the starting value as 1 + listFormat.StartValue = 1 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + The start value. + + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with the text in the left hand side text box. + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."); + //Set the list level as 1 + paragraph.IndentLevelNumber = 1; + // Set the hanging value + paragraph.FirstLineIndent = -20; + //Create instance for list format + IListFormat listFormat = paragraph.ListFormat; + //Set the list type as Numbered + listFormat.Type = ListType.Numbered; + //Set the numbered style (list numbering) as Arabic number following by period. + listFormat.NumberStyle = NumberedListStyle.ArabicPeriod; + //Set the starting value as 10 + listFormat.StartValue = 10; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation instance. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + ' Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + ' Add a new paragraph with the text in the left hand side text box. + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.") + 'Set the list level as 1 + paragraph.IndentLevelNumber = 1 + ' Set the hanging value + paragraph.FirstLineIndent = -20 + 'Create instance for list format + Dim listFormat As IListFormat = paragraph.ListFormat + 'Set the list type as Numbered + listFormat.Type = ListType.Numbered + 'Set the numbered style (list numbering) as Arabic number following by period. + listFormat.NumberStyle = NumberedListStyle.ArabicPeriod + 'Set the starting value as 10 + listFormat.StartValue = 10 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the . + + + The type. + + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + //Add another paragraph to the text body + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Reynold Xin, PhD student at UC Berkeley AMPLab"); + //Set the list level as 1 + paragraph.IndentLevelNumber = 1; + // Set the hanging value + paragraph.FirstLineIndent = -25; + //Retrieve the list format of paragraph + IListFormat listFormat = paragraph.ListFormat; + //Set the list type as Numbered + listFormat.Type = ListType.Numbered; + //Set the numbered style (list numbering) as Arabic number following by period. + listFormat.NumberStyle = NumberedListStyle.ArabicPeriod; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation instance. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + ' Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + 'Add another paragraph to the text body + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Reynold Xin, PhD student at UC Berkeley AMPLab") + 'Set the list level as 1 + paragraph.IndentLevelNumber = 1 + ' Set the hanging value + paragraph.FirstLineIndent = -25 + 'Retrieve the list format of paragraph + Dim listFormat As IListFormat = paragraph.ListFormat + 'Set the list type as Numbered + listFormat.Type = ListType.Numbered + 'Set the numbered style (list numbering) as Arabic number following by period. + listFormat.NumberStyle = NumberedListStyle.ArabicPeriod + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the list size relative to the size of the first text character in the paragraph. + + + The size. + + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with the text in the left hand side text box. + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."); + //Set the list level as 1 + paragraph.IndentLevelNumber = 1; + // Set the hanging value + paragraph.FirstLineIndent = -20; + //Create instance for list format + IListFormat listFormat = paragraph.ListFormat; + //Set the list type as Numbered + listFormat.Type = ListType.Numbered; + //Set the numbered style (list numbering) as Arabic number following by period. + listFormat.NumberStyle = NumberedListStyle.ArabicPeriod; + //Set the starting value as 1 + listFormat.StartValue = 1; + // Set the bullet character size. If 100, here means 100% of its text. Possible values can range from 25 to 400 + listFormat.Size = 100; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation instance. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + ' Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + ' Add a new paragraph with the text in the left hand side text box. + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.") + 'Set the list level as 1 + paragraph.IndentLevelNumber = 1 + ' Set the hanging value + paragraph.FirstLineIndent = -20 + 'Create instance for list format + Dim listFormat As IListFormat = paragraph.ListFormat + 'Set the list type as Numbered + listFormat.Type = ListType.Numbered + 'Set the numbered style (list numbering) as Arabic number following by period. + listFormat.NumberStyle = NumberedListStyle.ArabicPeriod + 'Set the starting value as 1 + listFormat.StartValue = 1 + ' Set the bullet character size. If 100, here means 100% of its text. Possible values can range from 25 to 400 + listFormat.Size = 100 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the font name for the list. + + + The name of the font. + + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + //Add another paragraph to the text body + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Reynold Xin, PhD student at UC Berkeley AMPLab"); + //Set the list level as 1 + paragraph.IndentLevelNumber = 1; + // Set the hanging value + paragraph.FirstLineIndent = -20; + //Create list format instance for the paragraph + IListFormat listFormat = paragraph.ListFormat; + //Set the type of list + listFormat.Type = ListType.Bulleted; + //Set font name for the bullet + listFormat.FontName = "Helvetica"; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation instance. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + ' Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + 'Add another paragraph to the text body + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Reynold Xin, PhD student at UC Berkeley AMPLab") + 'Set the list level as 1 + paragraph.IndentLevelNumber = 1 + ' Set the hanging value + paragraph.FirstLineIndent = -20 + 'Create list format instance for the paragraph + Dim listFormat As IListFormat = paragraph.ListFormat + 'Set the type of list + listFormat.Type = ListType.Bulleted + 'Set font name for the bullet + listFormat.FontName = "Helvetica" + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the color of instance. + + + The color. + + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + //Add another paragraph to the text body + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Reynold Xin, PhD student at UC Berkeley AMPLab"); + //Set the list level as 1 + paragraph.IndentLevelNumber = 1; + // Set the hanging value + paragraph.FirstLineIndent = -20; + //Create list format instance for the paragraph + IListFormat listFormat = paragraph.ListFormat; + //Set the type of list + listFormat.Type = ListType.Bulleted; + //Set the character for bullet + listFormat.BulletCharacter = '♠'; + //Set the color of the bullet + listFormat.Color = ColorObject.FromArgb(23, 12, 234); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation instance. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + ' Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + 'Add another paragraph to the text body + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Reynold Xin, PhD student at UC Berkeley AMPLab") + 'Set the list level as 1 + paragraph.IndentLevelNumber = 1 + ' Set the hanging value + paragraph.FirstLineIndent = -20 + 'Create list format instance for the paragraph + Dim listFormat As IListFormat = paragraph.ListFormat + 'Set the type of list + listFormat.Type = ListType.Bulleted + 'Set the character for bullet + listFormat.BulletCharacter = "♠"C + 'Set the color of the bullet + listFormat.Color = ColorObject.FromArgb(23, 12, 234) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents a paragraph in the shape. + + + + + Adds a text part to the text part collection. + + + Returns an instance this method creates. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //Add first paragraph to the text body + IParagraph paragraph = shape.TextBody.AddParagraph(); + //Create instance for text part + ITextPart textPart = paragraph.AddTextPart(); + //Set text for the text part + textPart.Text = " First Paragraph, second Textpart"; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'Create instance for text part + Dim text part As ITextPart = paragraph.AddTextPart() + 'Set text for the text part + text part.Text = " First Paragraph, second Textpart" + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Adds a text part to the text part collection with the specified text. + + The text content to initialize the new instance. + Returns an instance this method creates. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //Add first paragraph to the text body + IParagraph paragraph = shape.TextBody.AddParagraph(); + //Add first text part to the paragraph + paragraph.AddTextPart("First Paragraph, First Textpart"); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'Add first paragraph to the text body + Dim paragraph As IParagraph = shape.TextBody.AddParagraph() + 'Add first text part to the paragraph + paragraph.AddTextPart("First Paragraph, First Textpart") + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Creates an independent copy of instance. + + Returns the cloned paragraph instance. + /// + + //Open an existing presentation. + IPresentation presentation = Presentation.Open("Presentation.pptx"); + //Retrieve the slide instance. + ISlide slide = presentation.Slides[0]; + //Add a new text box to the slide. + IShape textboxShape = slide.AddTextBox(0, 0, 250, 250); + //Add a paragraph with text content to the shape. + IParagraph paragraph = textboxShape.TextBody.AddParagraph("Hello Presentation"); + //Create a cloned copy of paragraph. + IParagraph clonedParagraph = paragraph.Clone(); + clonedParagraph.TextParts[0].Text = "Replaced text"; + //Save the presentation to the file system. + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Open an existing presentation. + Dim presentation__1 As IPresentation = Presentation.Open("Presentation.pptx") + 'Retrieve the slide instance. + Dim slide As ISlide = presentation__1.Slides(0) + 'Add a new text box to the cloned slide. + Dim textboxShape As IShape = slide.AddTextBox(0, 0, 250, 250) + 'Add a paragraph with text content to the shape. + Dim paragraph As IParagraph = textboxShape.TextBody.AddParagraph("Hello Presentation") + 'Create a cloned copy of paragraph. + Dim clonedParagraph As IParagraph = paragraph.Clone(); + clonedParagraph.TextParts[0].Text = "Replaced Text"; + 'Add the slide to the presentation. + presentation__1.Slides.Add(slideClone) + 'Save the presentation to the file system. + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Adds the hyperlink to the textpart with the specified link. + + The text content to initialize the new instance. + Represents the address of the target document path or web url. + Returns an instance. + + + //Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Add paragraph into the shape + IParagraph paragraph = shape.TextBody.AddParagraph(); + //Add hyperlink to the TextPart and screen tip to the hyperlink. + IHyperLink hyperLink = paragraph.AddHyperlink("Google", "https://www.google.com"); + hyperLink.ScreenTip = "This hyperlink navigates to Google site"; + //Save the presentation + ppDoc.Save("Sample.pptx"); + //Close the presentation + ppDoc.Close(); + + /// + 'Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide into the presentation + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Adds paragraph into the shape + Dim paragraph As IParagraph = shape.TextBody.AddParagraph() + 'Add hyperlink to the TextPart and screen tip to the hyperlink. + Dim hyperLink As IHyperLink = paragraph.AddHyperlink("Google", "https://www.google.com") + hyperLink.ScreenTip = "This hyperlink navigates to Google site" + 'Saves the Presentation. + ppDoc.Save("Sample.pptx") + 'Close the presentation. + ppDoc.Close() + + + + + + Gets an instance that represents the list formatting for the specified paragraph. Read-only. + + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with the text in the left hand side text box. + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."); + //Get the list format of paragraph, read only + IListFormat listFormat = paragraph.ListFormat; + //Set the list type + listFormat.Type = ListType.Bulleted; + //Set the character for bullet + listFormat.BulletCharacter = '♠'; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation instance. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + ' Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + ' Add a new paragraph with the text in the left hand side text box. + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.") + 'Get the list format of paragraph, read only + Dim listFormat As IListFormat = paragraph.ListFormat + 'Set the list type + listFormat.Type = ListType.Bulleted + 'Set the character for bullet + listFormat.BulletCharacter = "♠"C + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the text content of the paragraph. Read-only. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //Add first paragraph to the text body + IParagraph paragraph = shape.TextBody.AddParagraph(); + //Add first text part to the paragraph + paragraph.AddTextPart("First Paragraph, First Textpart"); + //Add text part to the paragraph + ITextPart textPart = paragraph.AddTextPart(); + //Set text for the text part + textPart.Text = " First Paragraph, second Textpart"; + //Get the paragraph text, it is read only + string entireText = paragraph.Text; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'Add first paragraph to the text body + Dim paragraph As IParagraph = shape.TextBody.AddParagraph() + 'Add first text part to the paragraph + paragraph.AddTextPart("First Paragraph, First Textpart") + 'Add text part to the paragraph + Dim text part As ITextPart = paragraph.AddTextPart() + 'Set text for the text part + text part.Text = " First Paragraph, second Textpart" + 'Get the paragraph text, it is read only + Dim entireText As String = paragraph.Text + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the horizontal alignment of the paragraph. + + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with the text in the left hand side text box. + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."); + //Set the horizontal alignment + paragraph.HorizontalAlignment = HorizontalAlignmentType.Justify; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation instance. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + ' Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + ' Add a new paragraph with the text in the left hand side text box. + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.") + 'Set the horizontal alignment + paragraph.HorizontalAlignment = HorizontalAlignmentType.Justify + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the text part collection of instance. Read-only. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //Add first paragraph to the text body + IParagraph paragraph = shape.TextBody.AddParagraph(); + //Add first text part to the paragraph + paragraph.AddTextPart("First Paragraph, First Textpart"); + //Create instance for text part + ITextPart textPart = paragraph.AddTextPart(); + //Set text for the text part + textPart.Text = " First Paragraph, second Textpart"; + //Get the collection of text part in a paragraph, it is read only + ITextParts textParts = paragraph.TextParts; + //Set the first text part with bold style + textParts[0].Font.Bold = true; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'Add first paragraph to the text body + Dim paragraph As IParagraph = shape.TextBody.AddParagraph() + 'Add first text part to the paragraph + paragraph.AddTextPart("First Paragraph, First Textpart") + 'Create instance for text part + Dim text part As ITextPart = paragraph.AddTextPart() + 'Set text for the text part + text part.Text = " First Paragraph, second Textpart" + 'Get the collection of text part in a paragraph, it is read only + Dim text parts As ITextParts = paragraph.TextParts + 'Set the first text part with bold style + text parts(0).Font.Bold = True + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets an instance of the paragraph. Read-only. + + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with the text in the left hand side text box. + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."); + //Retrieve the paragraph font + IFont font = paragraph.Font; + //Set the font size + font.FontSize = 26; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation instance. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + ' Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + ' Add a new paragraph with the text in the left hand side text box. + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.") + 'Retrieve the paragraph font + Dim font As IFont = paragraph.Font + 'Set the font size + font.FontSize = 26 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + + Gets or sets the first line indent of the paragraph, in points. + + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with the text in the left hand side text box. + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."); + // Set the hanging value + paragraph.FirstLineIndent = 20; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation instance. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + ' Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + ' Add a new paragraph with the text in the left hand side text box. + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.") + ' Set the hanging value + paragraph.FirstLineIndent = 20 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the left indent of the paragraph, in points. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //Add first paragraph to the text body + IParagraph paragraph = shape.TextBody.AddParagraph(); + //Add first text part to the paragraph + paragraph.AddTextPart("First Paragraph, First Textpart"); + //Set the left indent + paragraph.LeftIndent = 20; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'Add first paragraph to the text body + Dim paragraph As IParagraph = shape.TextBody.AddParagraph() + 'Add first text part to the paragraph + paragraph.AddTextPart("First Paragraph, First Textpart") + 'Set the left indent + paragraph.LeftIndent = 20 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the indent level as an integer from 0 to 8, where 0 indicates a first-level + paragraph with no indentation. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //Add first paragraph to the text body + IParagraph paragraph = shape.TextBody.AddParagraph(); + //Add first text part to the paragraph + paragraph.AddTextPart("First Paragraph, First Textpart"); + //Create instance for text part + ITextPart textPart = paragraph.AddTextPart(); + //Set text for the text part + textPart.Text = " First Paragraph, second Textpart"; + //Set the list level as 1 + paragraph.IndentLevelNumber = 1; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'Add first paragraph to the text body + Dim paragraph As IParagraph = shape.TextBody.AddParagraph() + 'Add first text part to the paragraph + paragraph.AddTextPart("First Paragraph, First Textpart") + 'Create instance for text part + Dim text part As ITextPart = paragraph.AddTextPart() + 'Set text for the text part + text part.Text = " First Paragraph, second Textpart" + 'Set the list level as 1 + paragraph.IndentLevelNumber = 1 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the line spacing, in points. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //Add first paragraph to the text body + IParagraph paragraph = shape.TextBody.AddParagraph(); + //Add first text part to the paragraph + paragraph.AddTextPart("First Paragraph, First Textpart"); + //Set line spacing for paragraph + paragraph.LineSpacing = 20; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'Add first paragraph to the text body + Dim paragraph As IParagraph = shape.TextBody.AddParagraph() + 'Add first text part to the paragraph + paragraph.AddTextPart("First Paragraph, First Textpart") + 'Set line spacing for paragraph + paragraph.LineSpacing = 20 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the amount of space after the last line in each paragraph of the specified text, in points. + + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with the text in the left hand side text box. + IParagraph paragraph1 = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."); + //Add another paragraph. + IParagraph paragraph2 = textBoxShape.TextBody.AddParagraph("Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."); + //Set space after + paragraph1.SpaceAfter = 30; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation instance. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + ' Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + ' Add a new paragraph with the text in the left hand side text box. + Dim paragraph1 As IParagraph = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.") + 'Add another paragraph. + Dim paragraph2 As IParagraph = textBoxShape.TextBody.AddParagraph("Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.") + 'Set space after + paragraph1.SpaceAfter = 30 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the amount of space before the first line in each paragraph of the specified text, in points. + + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with the text in the left hand side text box. + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."); + //Set space before + paragraph.SpaceBefore = 10; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation instance. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + ' Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + ' Add a new paragraph with the text in the left hand side text box. + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.") + 'Set space before + paragraph.SpaceBefore = 10 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents a collection of instance in a . + + + + + Adds a paragraph at the end of the paragraph collection. + + Returns an instance. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //Create instance to hold paragraph collection + IParagraphs paragraphs = shape.TextBody.Paragraphs; + //Add paragraph to collection; in turn add text part + paragraphs.Add().TextParts.Add("Lorem ipsum dolor sit amet"); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'Create instance to hold paragraph collection + Dim paragraphs As IParagraphs = shape.TextBody.Paragraphs + 'Add paragraph to collection; in turn add text part + paragraphs.Add().TextParts.Add("Lorem ipsum dolor sit amet") + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Adds a paragraph with the specified text, at the end of the paragraph collection. + + Specifies the text content to add. + Returns an instance this method creates. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //Create instance to hold paragraph collection + IParagraphs paragraphs = shape.TextBody.Paragraphs; + //Add paragraph to collection + IParagraph paragraph = paragraphs.Add("Lorem ipsum dolor sit amet, consectetur adipiscing elit"); + //Retrieve the paragraph font + IFont font = paragraph.Font; + //Set the font size + font.FontSize = 26; + //Set the horizontal alignment + paragraph.HorizontalAlignment = HorizontalAlignmentType.Justify; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'Add paragraph to collection + Dim paragraph As IParagraph = paragraphs.Add("Lorem ipsum dolor sit amet, consectetur adipiscing elit") + 'Retrieve the paragraph font + Dim font As IFont = paragraph.Font + 'Set the font size + font.FontSize = 26 + 'Set the horizontal alignment + paragraph.HorizontalAlignment = HorizontalAlignmentType.Justify + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Inserts a specific paragraph at the specific location of the paragraph collection. + + Returns an instance this method creates. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //create instance for text body from shape + ITextBody textBody = shape.TextBody; + //Add first paragraph + IParagraph paragraph1 = textBody.AddParagraph(); + //Add first text part to the paragraph + textBody.Paragraphs[0].AddTextPart("Add First Paragraph"); + //Add second paragraph + IParagraph paragraph2 = textBody.AddParagraph(); + //Add first text part to the paragraph + textBody.Paragraphs[1].AddTextPart("Add Second Paragraph"); + //Add second paragraph + textBody.Paragraphs.Insert(0, textBody.Paragraphs[1]); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'create instance for text body from shape + Dim textBody As ITextBody = shape.TextBody + 'Add first paragraph + Dim paragraph1 As IParagraph = textBody.AddParagraph() + 'Add first text part to the paragraph + textBody.Paragraphs(0).AddTextPart("Add First Paragraph") + 'Add second paragraph + Dim paragraph2 As IParagraph = textBody.AddParagraph() + 'Add first text part to the paragraph + textBody.Paragraphs(1).AddTextPart("Add Second Paragraph") + 'Add second paragraph + textBody.Paragraphs.Insert(0, paragraph2) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the first occurrence of a specified instance from the paragraph collection. + + The paragraph instance to be removed from the collection. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //Create instance to hold paragraph collection + IParagraphs paragraphs = shape.TextBody.Paragraphs; + //Add paragraph to collection; in turn add text part + paragraphs.Add().TextParts.Add("Lorem ipsum dolor sit amet"); + //Add paragraph to collection + IParagraph paragraph = paragraphs.Add(", consectetur adipiscing elit"); + //Remove a specific paragraph instance + paragraphs.Remove(paragraph); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'Create instance to hold paragraph collection + Dim paragraphs As IParagraphs = shape.TextBody.Paragraphs + 'Add paragraph to collection; in turn add text part + paragraphs.Add().TextParts.Add("Lorem ipsum dolor sit amet") + 'Add paragraph to collection + Dim paragraph As IParagraph = paragraphs.Add(", consectetur adipiscing elit") + 'Remove a specific paragraph instance + paragraphs.Remove(paragraph) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the instance at the specified index of the paragraph collection. + + The zero-based index of the element to be removed. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //Create instance to hold paragraph collection + IParagraphs paragraphs = shape.TextBody.Paragraphs; + //Add paragraph to collection; in turn add text part + paragraphs.Add().TextParts.Add("Lorem ipsum dolor sit amet"); + //Add paragraph to collection + IParagraph paragraph = paragraphs.Add(", consectetur adipiscing elit"); + //Remove paragraph at specific index + paragraphs.RemoveAt(0); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'Create instance to hold paragraph collection + Dim paragraphs As IParagraphs = shape.TextBody.Paragraphs + 'Add paragraph to collection; in turn add text part + paragraphs.Add().TextParts.Add("Lorem ipsum dolor sit amet") + 'Add paragraph to collection + Dim paragraph As IParagraph = paragraphs.Add(", consectetur adipiscing elit") + 'Remove paragraph at specific index + paragraphs.RemoveAt(0) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Returns the zero-based index of the first occurrence of the instance within the collection. + + The IParagraph instance to locate in the collection. + Returns the zero-based index of the first occurrence of the paragraph within the collection, if found; otherwise, –1. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //Create instance to hold paragraph collection + IParagraphs paragraphs = shape.TextBody.Paragraphs; + //Add paragraph to collection; in turn add text part + paragraphs.Add().TextParts.Add("Lorem ipsum dolor sit amet"); + //Create instance for paragraph + IParagraph paragraph = paragraphs.Add(", consectetur adipiscing elit"); + //Get the index of specific paragraph instance + int index = paragraphs.IndexOf(paragraph); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'Create instance to hold paragraph collection + Dim paragraphs As IParagraphs = shape.TextBody.Paragraphs + 'Add paragraph to collection; in turn add text part + paragraphs.Add().TextParts.Add("Lorem ipsum dolor sit amet") + 'Create instance for paragraph + Dim paragraph As IParagraph = paragraphs.Add(", consectetur adipiscing elit") + 'Get the index of specific paragraph instance + Dim index As Integer = paragraphs.IndexOf(paragraph) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes all the elements from paragraph collection. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //Create instance to hold paragraph collection + IParagraphs paragraphs = shape.TextBody.Paragraphs; + //Add paragraph to collection; in turn add text part + paragraphs.Add().TextParts.Add("Lorem ipsum dolor sit amet"); + //Add paragraph to paragraphs + paragraphs.Add("sed do eiusmod tempor incididunt"); + paragraphs.Add("ut labore et dolore magna aliqua."); + //Clear the paragraph collection + paragraphs.Clear(); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'Create instance to hold paragraph collection + Dim paragraphs As IParagraphs = shape.TextBody.Paragraphs + 'Add paragraph to collection; in turn add text part + paragraphs.Add().TextParts.Add("Lorem ipsum dolor sit amet") + 'Add paragraph to paragraphs + paragraphs.Add("sed do eiusmod tempor incididunt") + paragraphs.Add("ut labore et dolore magna aliqua.") + 'Clear the paragraph collection + paragraphs.Clear() + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the number of elements in the paragraph collection. Read-only. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //Create instance to hold paragraph collection + IParagraphs paragraphs = shape.TextBody.Paragraphs; + //Add paragraph to collection; in turn add text part + paragraphs.Add().TextParts.Add("Lorem ipsum dolor sit amet"); + //Create instance for paragraph + IParagraph paragraph = paragraphs.Add(", consectetur adipiscing elit"); + //Get the paragraphs count, read only + int count = paragraphs.Count; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'Create instance to hold paragraph collection + Dim paragraphs As IParagraphs = shape.TextBody.Paragraphs + 'Add paragraph to collection; in turn add text part + paragraphs.Add().TextParts.Add("Lorem ipsum dolor sit amet") + 'Create instance for paragraph + Dim paragraph As IParagraph = paragraphs.Add(", consectetur adipiscing elit") + 'Get the paragraphs count, read only + Dim count As Integer = paragraphs.Count + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a instance at the specified index from the collection. Read-only. + + Determines the index of the text part. + Returns an instance. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //Create instance to hold paragraph collection + IParagraphs paragraphs = shape.TextBody.Paragraphs; + //Add paragraph to collection; in turn add text part + paragraphs.Add().TextParts.Add("Lorem ipsum dolor sit amet"); + //Create instance for paragraph + IParagraph paragraph = paragraphs.Add(", consectetur adipiscing elit"); + //Get the specific paragraph instance, read only + IParagraph paragraph1 = paragraphs[0]; + // Set the hanging value + paragraph1.FirstLineIndent = 20; + //Set the list level as 1 + paragraph1.IndentLevelNumber = 1; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'Create instance to hold paragraph collection + Dim paragraphs As IParagraphs = shape.TextBody.Paragraphs + 'Add paragraph to collection; in turn add text part + paragraphs.Add().TextParts.Add("Lorem ipsum dolor sit amet") + 'Create instance for paragraph + Dim paragraph As IParagraph = paragraphs.Add(", consectetur adipiscing elit") + 'Get the specific paragraph instance, read only + Dim paragraph1 As IParagraph = paragraphs(0) + ' Set the hanging value + paragraph1.FirstLineIndent = 20 + 'Set the list level as 1 + paragraph1.IndentLevelNumber = 1 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents the alignment and anchoring of the text. + + + + + Adds a paragraph at the end of the paragraph collection. + + Returns an instance this method creates. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //create instance for text body from shape + ITextBody textBody = shape.TextBody; + //Add first paragraph + IParagraph paragraph1 = textBody.AddParagraph(); + //Add first text part to the paragraph + textBody.Paragraphs[0].AddTextPart("Add First Paragraph"); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'create instance for text body from shape + Dim textBody As ITextBody = shape.TextBody + 'Add first paragraph + Dim paragraph1 As IParagraph = textBody.AddParagraph() + 'Add first text part to the paragraph + textBody.Paragraphs(0).AddTextPart("Add First Paragraph") + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Adds a paragraph at the end of the collection. + + Represents the text content. + Returns an instance this method creates. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //create instance for text body from shape + ITextBody textBody = shape.TextBody; + //Add first paragraph + IParagraph paragraph1 = textBody.AddParagraph("Add First Paragraph"); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'create instance for text body from shape + Dim textBody As ITextBody = shape.TextBody + 'Add first paragraph + Dim paragraph1 As IParagraph = textBody.AddParagraph("Add First Paragraph") + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the distance between the bottom of the text body and the bottom of the rectangle shape that contains the text, in points. Value ranges from 1 to 1583. + + + The margin bottom of the TextBody. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //create instance for text body from shape + ITextBody textBody = shape.TextBody; + //Add first paragraph + IParagraph paragraph1 = textBody.AddParagraph(); + //Add first text part to the paragraph + textBody.Paragraphs[0].AddTextPart("Add First Paragraph"); + //Set the Margin bottom + textBody.MarginBottom = 100; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'create instance for text body from shape + Dim textBody As ITextBody = shape.TextBody + 'Add first paragraph + Dim paragraph1 As IParagraph = textBody.AddParagraph() + 'Add first text part to the paragraph + textBody.Paragraphs(0).AddTextPart("Add First Paragraph") + 'Set the Margin bottom + textBody.MarginBottom = 100 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the distance between the left edge of the text body and the left edge of the rectangle shape that contains the text, in points. Value ranges from 1 to 1583. + + + The margin left of the TextBody. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //create instance for text body from shape + ITextBody textBody = shape.TextBody; + //Add first paragraph + IParagraph paragraph1 = textBody.AddParagraph(); + //Add first text part to the paragraph + textBody.Paragraphs[0].AddTextPart("Add First Paragraph"); + //Set the Margin left + textBody.MarginLeft = 150; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'create instance for text body from shape + Dim textBody As ITextBody = shape.TextBody + 'Add first paragraph + Dim paragraph1 As IParagraph = textBody.AddParagraph() + 'Add first text part to the paragraph + textBody.Paragraphs(0).AddTextPart("Add First Paragraph") + 'Set the Margin left + textBody.MarginLeft = 130 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the distance between the right edge of the text body and the right edge of the rectangle shape that contains the text, in points. Value ranges from 1 to 1583. + + + The margin right of the TextBody. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //create instance for text body from shape + ITextBody textBody = shape.TextBody; + //Add first paragraph + IParagraph paragraph1 = textBody.AddParagraph(); + //Add first text part to the paragraph + textBody.Paragraphs[0].AddTextPart("Add First Paragraph"); + //Set the Margin right + textBody.MarginRight = 50; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'create instance for text body from shape + Dim textBody As ITextBody = shape.TextBody + 'Add first paragraph + Dim paragraph1 As IParagraph = textBody.AddParagraph() + 'Add first text part to the paragraph + textBody.Paragraphs(0).AddTextPart("Add First Paragraph") + 'Set the Margin right + textBody.MarginRight = 160 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the distance between the top of the text body and the top of the rectangle shape that contains the text, in points. Value ranges from 1 to 1583. + + + The margin top of the TextBody. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //create instance for text body from shape + ITextBody textBody = shape.TextBody; + //Add first paragraph + IParagraph paragraph1 = textBody.AddParagraph(); + //Add first text part to the paragraph + textBody.Paragraphs[0].AddTextPart("Add First Paragraph"); + //Set the Margin top + textBody.MarginTop = 140; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'create instance for text body from shape + Dim textBody As ITextBody = shape.TextBody + 'Add first paragraph + Dim paragraph1 As IParagraph = textBody.AddParagraph() + 'Add first text part to the paragraph + textBody.Paragraphs(0).AddTextPart("Add First Paragraph") + 'Set the Margin Top + textBody.MarginTop = 200 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets an instance that represents the paragraph collection. Read-only. + + + The paragraphs object of the TextBody. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //create instance for text body from shape + ITextBody textBody = shape.TextBody; + //Add first paragraph + IParagraph paragraph1 = textBody.AddParagraph(); + //Add first text part to the paragraph + textBody.Paragraphs[0].AddTextPart("Add First Paragraph"); + //Retrieve the paragraph from text body + IParagraph paragraph = textBody.Paragraphs[0]; + //Add second text part to the first paragraph + paragraph.AddTextPart().Text = ",2nd text part in 1st paragraph"; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'create instance for text body from shape + Dim textBody As ITextBody = shape.TextBody + 'Add first paragraph + Dim paragraph1 As IParagraph = textBody.AddParagraph() + 'Add first text part to the paragraph + textBody.Paragraphs(0).AddTextPart("Add First Paragraph") + 'Retrieve the paragraph from text body + Dim paragraph As IParagraph = textBody.Paragraphs(0) + 'Add second text part to the first paragraph + paragraph.AddTextPart().Text = ",2nd text part in 1st paragraph" + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the text content of the text body. + + + The text of the TextBody. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //create instance for text body from shape + ITextBody textBody = shape.TextBody; + //Add first paragraph + IParagraph paragraph1 = textBody.AddParagraph(); + //Add first text part to the paragraph + textBody.Paragraphs[0].AddTextPart("Add First Paragraph"); + //Get the text of text body, read only + string text = textBody.Text; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'create instance for text body from shape + Dim textBody As ITextBody = shape.TextBody + 'Add first paragraph + Dim paragraph1 As IParagraph = textBody.AddParagraph() + 'Add first text part to the paragraph + textBody.Paragraphs(0).AddTextPart("Add First Paragraph") + 'Get the text of text body, read only + Dim text As String = textBody.Text + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a boolean value indicates whether lines break automatically to fit inside the shape. + + + true if [wrap text]; otherwise, false. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //create instance for text body from shape + ITextBody textBody = shape.TextBody; + //Add first paragraph + IParagraph paragraph1 = textBody.AddParagraph(); + //Add first text part to the paragraph + textBody.Paragraphs[0].AddTextPart("Add First Paragraph"); + //Retrieve the paragraph from text body + IParagraph paragraph = textBody.Paragraphs[0]; + //Add second text part to the first paragraph + paragraph.AddTextPart().Text = ",2nd text part in 1st paragraph"; + //Set wrap text to fit the text within shape + textBody.WrapText = true; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'create instance for text body from shape + Dim textBody As ITextBody = shape.TextBody + 'Add first paragraph + Dim paragraph1 As IParagraph = textBody.AddParagraph() + 'Add first text part to the paragraph + textBody.Paragraphs(0).AddTextPart("Add First Paragraph") + 'Retrieve the paragraph from text body + Dim paragraph As IParagraph = textBody.Paragraphs(0) + 'Add second text part to the first paragraph + paragraph.AddTextPart().Text = ",2nd text part in 1st paragraph" + 'Set wrap text to fit the text within shape + textBody.WrapText = True + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the vertical alignment of text in a text body. + + + The vertical alignment type of the TextBody. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //create instance for text body from shape + ITextBody textBody = shape.TextBody; + //Add first paragraph + IParagraph paragraph1 = textBody.AddParagraph(); + //Add first text part to the paragraph + textBody.Paragraphs[0].AddTextPart("Add First Paragraph"); + //Retrieve the paragraph from text body + IParagraph paragraph = textBody.Paragraphs[0]; + //Add second text part to the first paragraph + paragraph.AddTextPart().Text = ",2nd text part in 1st paragraph"; + //Set vertical alignment + textBody.VerticalAlignment = VerticalAlignmentType.Middle; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'create instance for text body from shape + Dim textBody As ITextBody = shape.TextBody + 'Add first paragraph + Dim paragraph1 As IParagraph = textBody.AddParagraph() + 'Add first text part to the paragraph + textBody.Paragraphs(0).AddTextPart("Add First Paragraph") + 'Retrieve the paragraph from text body + Dim paragraph As IParagraph = textBody.Paragraphs(0) + 'Add second text part to the first paragraph + paragraph.AddTextPart().Text = ",2nd text part in 1st paragraph" + 'Set vertical alignment + textBody.VerticalAlignment = VerticalAlignmentType.Middle + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a boolean value indicates whether to anchor center with the vertical alignment. + + + true if [anchor center]; otherwise, false. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //create instance for text body from shape + ITextBody textBody = shape.TextBody; + //Add first paragraph + IParagraph paragraph1 = textBody.AddParagraph(); + //Add first text part to the paragraph + textBody.Paragraphs[0].AddTextPart("Add First Paragraph"); + //Set anchor center to the textBody + textBody.AnchorCenter = true; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'create instance for text body from shape + Dim textBody As ITextBody = shape.TextBody + 'Add first paragraph + Dim paragraph1 As IParagraph = textBody.AddParagraph() + 'Add first text part to the paragraph + textBody.Paragraphs(0).AddTextPart("Add First Paragraph") + 'Set anchor center to the textBody + textBody.AnchorCenter = True + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the text direction. + + + The text direction type of the TextBody. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 350); + //create instance for text body from shape + ITextBody textBody = shape.TextBody; + //Add first paragraph + IParagraph paragraph1 = textBody.AddParagraph(); + //Add first text part to the paragraph + textBody.Paragraphs[0].AddTextPart("Add First Paragraph"); + //Set the text direction + textBody.TextDirection = TextDirectionType.Horizontal; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 350) + 'create instance for text body from shape + Dim textBody As ITextBody = shape.TextBody + 'Add first paragraph + Dim paragraph1 As IParagraph = textBody.AddParagraph() + 'Add first text part to the paragraph + textBody.Paragraphs(0).AddTextPart("Add First Paragraph") + 'Set the text direction + textBody.TextDirection = TextDirectionType.Horizontal + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a boolean value indicates whether to enable shrink text on overflow + + + true if [ShrinkTextOnOverflow]; otherwise, false. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 50); + //create instance for text body from shape + ITextBody textBody = shape.TextBody; + //Add first paragraph + IParagraph paragraph1 = textBody.AddParagraph("Hi hello welcome to syncfusion."); + //Add second paragraph + IParagraph paragraph2 = textBody.AddParagraph("A warm welcome to the syncfusion with greedy hearts."); + //Set ShrinkTextOnOverflow to the textBody + textBody.FitTextOption = FitTextOption.ShrinkTextOnOverFlow; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 50) + 'create instance for text body from shape + Dim textBody As ITextBody = shape.TextBody + 'Add first paragraph + Dim paragraph1 As IParagraph = textBody.AddParagraph("Hi hello welcome to syncfusion.") + 'Add second paragraph + Dim paragraph1 As IParagraph = textBody.AddParagraph("A warm welcome to syncfusion with greedy hearts.") + 'Set ShrinkTextOnOverflow to the textBody + textBody.FitTextOption = FitTextOption.ShrinkTextOnOverFlow; + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents an individual text part in a paragraph. + + + + + Sets the hyperlink to the textpart. + + Represents the address of the target hyperlink + Returns an instance. + The target can be a document path, web url, target slide, email_id. + + + //Create a new presentation. + IPresentation presDoc = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //create instance for text body from shape + ITextBody textBody = shape.TextBody; + //Add first paragraph to text body + textBody.AddParagraph(); + //Create instance for text part + ITextPart textPart = textBody.Paragraphs[0].AddTextPart(); + //Set text for the text part + textPart.Text = "Syncfusion"; + //Set HyperLink for this textpart + IHyperLink hyperLink = textPart.SetHyperlink("www.syncfusion.com"); + //Save the presentation to the file system. + presDoc.Save("Output.pptx"); + //Close the presentation + presDoc.Close(); + + + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'create instance for text body from shape + Dim textBody As ITextBody = shape.TextBody + 'Add first paragraph to text body + textBody.AddParagraph() + 'Create instance for text part + Dim textPart As ITextPart = textBody.Paragraphs(0).AddTextPart() + 'Set text for the text part + textPart.Text = "Syncfusion" + 'Set HyperLink for this textpart + Dim hyperLink As IHyperLink = textPart.SetHyperlink("www.syncfusion.com") + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + + + + + + Removes the hyperlink from the current textpart. + + + + //Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Adds paragraph into the shape + IParagraph paragraph = shape.TextBody.AddParagraph(); + //Adds text to the TextPart + paragraph.Text = "Google"; + //Set hyperlink to the TextPart + IHyperLink hyperLink = paragraph.TextParts[0].SetHyperlink("https://www.google.com"); + //Set screen tip to the hyperlink + hyperLink.ScreenTip = "This hyperlink navigates to Google site"; + //Remove the hyperlink. + paragraph.TextParts[0].RemoveHyperLink(); + //Save the presentation + ppDoc.Save("Sample.pptx"); + //Close the presentation + ppDoc.Close(); + + + 'Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Adds paragraph into the shape + Dim paragraph As IParagraph = shape.TextBody.AddParagraph() + 'Adds text to the TextPart + paragraph.Text = "Google" + 'Set hyperlink to the TextPart + Dim hyperLink As IHyperLink = paragraph.TextParts(0).SetHyperlink("https://www.google.com") + 'Set screen tip to the hyperlink + hyperLink.ScreenTip = "This hyperlink navigates to Google site" + 'Remove the hyperlink + paragraph.TextParts(0).RemoveHyperLink() + 'Save the presentation + ppDoc.Save("Sample.pptx") + 'Close the presentation + ppDoc.Close() + + + + + + Gets an instance of the text part. Read-only. + + + The font of the TextPart. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //create instance for text body from shape + ITextBody textBody = shape.TextBody; + //Add first paragraph to text body + textBody.AddParagraph(); + //Create instance for text part + ITextPart textPart = textBody.Paragraphs[0].AddTextPart("FirstParagraph, first TextPart"); + //Create instance to hold font properties of text part + IFont font = textPart.Font; + //Set the bold style + font.Bold = true; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'create instance for text body from shape + Dim textBody As ITextBody = shape.TextBody + 'Add first paragraph to text body + textBody.AddParagraph() + 'Create instance for text part + Dim textPart As ITextPart = textBody.Paragraphs(0).AddTextPart("FirstParagraph, first TextPart") + 'Create instance to hold font properties of text part + Dim font As IFont = textPart.Font + 'Set the bold style + font.Bold = True + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the text content. + + + The text value of the TextPart. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //create instance for text body from shape + ITextBody textBody = shape.TextBody; + //Add first paragraph to text body + textBody.AddParagraph(); + //Create instance for text part + ITextPart textPart = textBody.Paragraphs[0].AddTextPart(); + //Set text for the text part + textPart.Text = "FirstParagraph, first TextPart"; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'create instance for text body from shape + Dim textBody As ITextBody = shape.TextBody + 'Add first paragraph to text body + textBody.AddParagraph() + 'Create instance for text part + Dim textPart As ITextPart = textBody.Paragraphs(0).AddTextPart() + 'Set text for the text part + textPart.Text = "FirstParagraph, first TextPart" + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the underline color for the text. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //create instance for text body from shape + ITextBody textBody = shape.TextBody; + //Add first paragraph to text body + textBody.AddParagraph(); + //Create instance for text part + ITextPart textPart = textBody.Paragraphs[0].AddTextPart(); + //Set text for the text part + textPart.Text = "FirstParagraph, first TextPart"; + IColor underlineColor = textPart.UnderlineColor; + //Set the text part underline color + underlineColor = ColorObject.Navy; + //Set underline type for text part + textPart.Font.Underline = TextUnderlineType.Double; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'create instance for text body from shape + Dim textBody As ITextBody = shape.TextBody + 'Add first paragraph to text body + textBody.AddParagraph() + 'Create instance for text part + Dim textPart As ITextPart = textBody.Paragraphs(0).AddTextPart() + 'Set text for the text part + textPart.Text = "FirstParagraph, first TextPart" + Dim underlineColor As IColor = textPart.UnderlineColor + 'Set the text part underline color + underlineColor = ColorObject.Navy + 'Set underline type for text part + textPart.Font.Underline = TextUnderlineType.[Double] + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Returns an instance that represents the hyperlink for the specified textpart. Read-only. + + + + //Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + //Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + //Add a rectangle to the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100); + //Adds paragraph into the shape + IParagraph paragraph = shape.TextBody.AddParagraph(); + //Adds text to the TextPart + paragraph.Text = "Google"; + //Set hyperlink to the TextPart + IHyperLink hyperLink = paragraph.TextParts[0].SetHyperlink("https://www.google.com"); + //Set screen tip to the hyperlink + hyperLink.ScreenTip = "This hyperlink navigates to Google site"; + //Remove the hyperlink. + paragraph.TextParts[0].RemoveHyperLink(); + //Save the presentation + ppDoc.Save("Sample.pptx"); + //Close the presentation + ppDoc.Close(); + + + 'Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a rectangle to the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 100, 100, 100, 100) + 'Adds paragraph into the shape + Dim paragraph As IParagraph = shape.TextBody.AddParagraph() + 'Adds text to the TextPart + paragraph.Text = "Google" + 'Set hyperlink to the TextPart + Dim hyperLink As IHyperLink = paragraph.TextParts(0).SetHyperlink("https://www.google.com") + 'Set screen tip to the hyperlink + hyperLink.ScreenTip = "This hyperlink navigates to Google site" + 'Save the presentation + ppDoc.Save("Sample.pptx") + 'Close the presentation + ppDoc.Close() + + + + + + Represents a collection of instance in a paragraph. + + + + + Adds a new instance to the text part collection. + + Returns the newly created instance. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add paragraph to the shape's text body + IParagraph paragraph = shape.TextBody.Paragraphs.Add(); + //Retrieve the text parts of a paragraph + ITextParts textParts = paragraph.TextParts; + //Add a text part to the collection + ITextPart textPart = textParts.Add(); + //Set text to text part + textPart.Text = "Reynold Xin, PhD student at UC Berkeley AMPLab"; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add paragraph to the shape's text body + Dim paragraph As IParagraph = shape.TextBody.Paragraphs.Add() + 'Retrieve the text parts of a paragraph + Dim text parts As ITextParts = paragraph.TextParts + 'Add a text part to the collection + Dim text part As ITextPart = text parts.Add() + 'Set text to text part + text part.Text = "Reynold Xin, PhD student at UC Berkeley AMPLab" + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the first occurrence of a specified instance from the text part collection. + + Represents the instance to remove. + /// /// + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add paragraph to the shape's text body + IParagraph paragraph = shape.TextBody.Paragraphs.Add(); + //Retrieve the text parts of a paragraph + ITextParts textParts = paragraph.TextParts; + //Add text part to collection + textParts.Add("Reynold Xin, PhD student at UC Berkeley AMPLab"); + //Add a text part to the collection + ITextPart textPart = textParts.Add(); + //Set text to text part + textPart.Text = "My Textpart"; + //Remove a particular text part from collection + textParts.Remove(textPart); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add paragraph to the shape's text body + Dim paragraph As IParagraph = shape.TextBody.Paragraphs.Add() + 'Retrieve the text parts of a paragraph + Dim text parts As ITextParts = paragraph.TextParts + 'Add text part to collection + text parts.Add("Reynold Xin, PhD student at UC Berkeley AMPLab") + 'Add a text part to the collection + Dim text part As ITextPart = text parts.Add() + 'Set text to text part + text part.Text = "My Textpart" + 'Remove a particular text part from collection + text parts.Remove(text part) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the instance at the specified index of the text part collection. + + The zero-based index of the text part to be removed. + /// + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add paragraph to the shape's text body + IParagraph paragraph = shape.TextBody.Paragraphs.Add(); + //Retrieve the text parts of a paragraph + ITextParts textParts = paragraph.TextParts; + //Add text part to collection + textParts.Add("Reynold Xin, PhD student at UC Berkeley AMPLab"); + //Add a text part to the collection + ITextPart textPart = textParts.Add(); + //Set text to text part + textPart.Text = "My Textpart"; + //Remove text part at specific index + textParts.RemoveAt(1); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add paragraph to the shape's text body + Dim paragraph As IParagraph = shape.TextBody.Paragraphs.Add() + 'Retrieve the text parts of a paragraph + Dim text parts As ITextParts = paragraph.TextParts + 'Add text part to collection + text parts.Add("Reynold Xin, PhD student at UC Berkeley AMPLab") + 'Add a text part to the collection + Dim text part As ITextPart = text parts.Add() + 'Set text to text part + text part.Text = "My Textpart" + 'Remove text part at specific index + text parts.RemoveAt(1) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Returns the zero-based index of the first occurrence of the instance within the collection. + + The instance to locate in the collection. + Returns the zero-based index of the first occurrence of instance within the collection, if found; otherwise, –1. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add paragraph to the shape's text body + IParagraph paragraph = shape.TextBody.Paragraphs.Add(); + //Retrieve the text parts of a paragraph + ITextParts textParts = paragraph.TextParts; + //Add text part to collection + textParts.Add("Reynold Xin, PhD student at UC Berkeley AMPLab"); + //Add a text part to the collection + ITextPart textPart = textParts.Add(); + //Set text to text part + textPart.Text = "My Textpart"; + //Get the index position of a text part + int index = textParts.IndexOf(textPart); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add paragraph to the shape's text body + Dim paragraph As IParagraph = shape.TextBody.Paragraphs.Add() + 'Retrieve the text parts of a paragraph + Dim text parts As ITextParts = paragraph.TextParts + 'Add text part to collection + text parts.Add("Reynold Xin, PhD student at UC Berkeley AMPLab") + 'Add a text part to the collection + Dim text part As ITextPart = text parts.Add() + 'Set text to text part + text part.Text = "My Textpart" + 'Get the index position of a text part + Dim index As Integer = text parts.IndexOf(text part) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes all the instance from text part collection. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add paragraph to the shape's text body + IParagraph paragraph = shape.TextBody.Paragraphs.Add(); + //Retrieve the text parts of a paragraph + ITextParts textParts = paragraph.TextParts; + //Add a text part to the collection + ITextPart textPart = textParts.Add("Reynold Xin, PhD student at UC Berkeley AMPLab"); + //Clear the text parts + textParts.Clear(); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add paragraph to the shape's text body + Dim paragraph As IParagraph = shape.TextBody.Paragraphs.Add() + 'Retrieve the text parts of a paragraph + Dim text parts As ITextParts = paragraph.TextParts + 'Add a text part to the collection + Dim text part As ITextPart = text parts.Add("Reynold Xin, PhD student at UC Berkeley AMPLab") + 'Clear the text parts + text parts.Clear() + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Adds a new instance at the end of the text part collection with the specified text. + + Represents the text content to initialize the text part. + Returns the newly added instance. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add paragraph to the shape's text body + IParagraph paragraph = shape.TextBody.Paragraphs.Add(); + //Retrieve the text parts of a paragraph + ITextParts textParts = paragraph.TextParts; + //Add a text part to the collection + ITextPart textPart = textParts.Add("Reynold Xin, PhD student at UC Berkeley AMPLab"); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add paragraph to the shape's text body + Dim paragraph As IParagraph = shape.TextBody.Paragraphs.Add() + 'Retrieve the text parts of a paragraph + Dim text parts As ITextParts = paragraph.TextParts + 'Add a text part to the collection + Dim text part As ITextPart = text parts.Add("Reynold Xin, PhD student at UC Berkeley AMPLab") + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Returns a boolean value indicates whether the specified text content is in the text part collection or not. + + The text to locate in the text part collection. + Returns true if text founds in the collection otherwise false + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add paragraph to the shape's text body + IParagraph paragraph = shape.TextBody.Paragraphs.Add(); + //Retrieve the text parts of a paragraph + ITextParts textParts = paragraph.TextParts; + //Add text part to collection + textParts.Add("Reynold Xin, PhD student at UC Berkeley AMPLab"); + //Add a text part to the collection + ITextPart textPart = textParts.Add(); + //Set text to text part + textPart.Text = "My Textpart"; + //Check if text exist in the text part collection + if (textParts.Contains("My Textpart")) + textParts.RemoveAt(1); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add paragraph to the shape's text body + Dim paragraph As IParagraph = shape.TextBody.Paragraphs.Add() + 'Retrieve the text parts of a paragraph + Dim text parts As ITextParts = paragraph.TextParts + 'Add text part to collection + text parts.Add("Reynold Xin, PhD student at UC Berkeley AMPLab") + 'Add a text part to the collection + Dim text part As ITextPart = text parts.Add() + 'Set text to text part + text part.Text = "My Textpart" + 'Check if text exist in the text part collection + If text parts.Contains("My Textpart") Then + text parts.RemoveAt(1) + End If + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the number of elements in the text part collection. Read-only. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add paragraph to the shape's text body + IParagraph paragraph = shape.TextBody.Paragraphs.Add(); + //Retrieve the text parts of a paragraph + ITextParts textParts = paragraph.TextParts; + //Add a text part to the collection + ITextPart textPart = textParts.Add(); + //Set text to text part + textPart.Text = "Reynold Xin, PhD student at UC Berkeley AMPLab"; + //Add text part to paragraph + shape.TextBody.Paragraphs[0].AddTextPart("First Paragraph, second TextPart"); + //Get the count of the text parts, read only + int count = textParts.Count; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add paragraph to the shape's text body + Dim paragraph As IParagraph = shape.TextBody.Paragraphs.Add() + 'Retrieve the text parts of a paragraph + Dim text parts As ITextParts = paragraph.TextParts + 'Add a text part to the collection + Dim text part As ITextPart = text parts.Add() + 'Set text to text part + text part.Text = "Reynold Xin, PhD student at UC Berkeley AMPLab" + 'Add text part to paragraph + shape.TextBody.Paragraphs(0).AddTextPart("First Paragraph, second TextPart") + 'Get the count of the text parts, read only + Dim count As Integer = text parts.Count + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a instance at the specified index of the collection. Read-only. + + Determines the index of the text part. + Returns an instance. + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a blank slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a text box to the slide + IShape shape = slide.Shapes.AddTextBox(100, 150, 300, 200); + //Add paragraph to the shape's text body + IParagraph paragraph = shape.TextBody.Paragraphs.Add(); + //Retrieve the text parts of a paragraph + ITextParts textParts = paragraph.TextParts; + //Add a text part to the collection + ITextPart textPart = textParts.Add(); + //Set text to text part + textPart.Text = "Reynold Xin, PhD student at UC Berkeley AMPLab"; + //Add text part to paragraph + shape.TextBody.Paragraphs[0].AddTextPart(); + //Retrieve the text part using index position + ITextPart _textPart = textParts[1]; + //Set the font name for text part + _textPart.Font.FontName = "Calibri"; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a blank slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to the slide + Dim shape As IShape = slide.Shapes.AddTextBox(100, 150, 300, 200) + 'Add paragraph to the shape's text body + Dim paragraph As IParagraph = shape.TextBody.Paragraphs.Add() + 'Retrieve the text parts of a paragraph + Dim text parts As ITextParts = paragraph.TextParts + 'Add a text part to the collection + Dim text part As ITextPart = text parts.Add() + 'Set text to text part + text part.Text = "Reynold Xin, PhD student at UC Berkeley AMPLab" + 'Add text part to paragraph + shape.TextBody.Paragraphs(0).AddTextPart() + 'Retrieve the text part using index position + Dim _text part As ITextPart = text parts(1) + 'Set the font name for text part + _text part.Font.FontName = "Calibri" + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represent a selection of text inside paragraph. + + + + + Gets the selected text parts. + + Array of TextParts + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with a text + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Hello World"); + ITextSelection textSelection = presentation.Find("World", false, false); + // Gets the found text containing text parts + foreach (ITextPart textPart in textSelection.GetTextParts()) + { + //Sets Bold property + textPart.Font.Bold = true; + } + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Creates a presentation. + Dim presentation As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + 'Add a new paragraph with a text + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Hello World") + 'Finds the text from the Presentation document + Dim textSelection As ITextSelection = presentation.Find("World", False, False) + 'Gets the text parts from the selection + For Each textPart As ITextPart In textSelection.GetTextParts() + textPart.Font.Bold = True + Next + presentation.Save("Output.pptx") + presentation.Close() + + + + + + Gets as one text part. + + TextPart + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with a text + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Hello World"); + // Finds the text from the mentioned slide + ITextSelection[] textSelections = slide.FindAll("World", false, false); + foreach (ITextSelection textSelection in textSelections) + { + //Gets the found text as single text part + ITextPart textPart = textSelection.GetAsOneTextPart(); + //Replace the text + textPart.Text = "Replaced text"; + } + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Creates a presentation. + Dim presentation As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + 'Add a new paragraph with a text + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Hello World") + 'Finds the text from the mentioned slide + Dim textSelections As ITextSelection() = slide.FindAll("World", False, False) + 'Gets the found text as single text part and replace it + For Each textSelection As ITextSelection In textSelections + Dim textPart As ITextPart = textSelection.GetAsOneTextPart() + textPart.Text = "Replaced text" + Next + presentation.Save("Output.pptx") + presentation.Close() + + + + + + Gets the selected text. Read-only. + + The string that represents the selected text. + + string that contains the selected text. + + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with a text + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Hello World"); + // Finds the text from the Presentation document + ITextSelection textSelection = presentation.Find("World", false, false); + // Gets the selected text from the text selection + string text = textSelection.SelectedText; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Creates a presentation. + Dim presentation As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + 'Add a new paragraph with a text + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Hello World") + 'Finds the text from the Presentation document + Dim textSelection As ITextSelection = presentation.Find("World", False, False) + 'Gets the selected text from the text selection + Dim text As String = textSelection.SelectedText + presentation.Save("Output.pptx") + presentation.Close() + + + + + + Gets the string at the specified index from the + collection. + + The zero-based index of the string to get. + The string at the specified collection. + + string that contains the selected text from the specified index. + + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with a text + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Hello World"); + // Finds all the text from the Presentation document + ITextSelection[] textSelections = presentation.FindAll("World", false, false); + string text = textSelections[0].SelectedText; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Creates a presentation. + Dim presentation As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + 'Add a new paragraph with a text + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Hello World") + 'Finds all the text from the Presentation document + Dim textSelections As ITextSelection() = presentation.FindAll("World", False, False) + 'Gets the selected text from the text selections index + Dim text As String = textSelections(0).SelectedText + presentation.Save("Output.pptx") + presentation.Close() + + + + + + Gets the number of text chunks in the collection. Read-only. + + The count. + + integer value that represents the number of text chunks. + + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with a text + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Hello World"); + ITextSelection textSelection = presentation.Find("World", false, false); + int count = textSelection.Count; + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Creates a presentation. + Dim presentation As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + 'Add a new paragraph with a text + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Hello World") + 'Finds the text from the Presentation document + Dim textSelection As ITextSelection = presentation.Find("World", False, False) + 'Gets the selected text from the text selections index + Dim count As Integer = textSelection.Count + presentation.Save("Output.pptx") + presentation.Close() + + + + + + Represents the table cell. + + + + + Creates a copy of the current cell. + + Returns the cloned cell object + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Gets the first column cell. + ICell cell = table.Columns[0].Cells[0]; + //Clone the cell element. + ICell clonedCell = cell.Clone(); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Gets the first column cell. + Dim cell As ICell = table.Columns(0).Cells(0) + 'Clone the cell element. + Dim clonedCell As ICell = cell.Clone() + 'Saves the Presentation. + pptxDoc.Save("Sample.pptx") + 'Close the presentation. + pptxDoc.Close() + + + + + + Gets an instance that represents the borders and diagonal lines of a cell. Read-only. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200); + //Get the cell from a row in a table + ICell cell = table.Rows[0].Cells[0]; + //Get the cell border properties, read only + ICellBorders cellBorders = cell.CellBorders; + //Set the Cell border property + cellBorders.BorderBottom.BeginArrowheadLength = ArrowheadLength.Medium; + //Save the presentation + presentation.Save("CellBorders.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200) + 'Get the cell from a row in a table + Dim cell As ICell = table.Rows(0).Cells(0) + 'Get the cell border properties, read only + Dim cellBorders As ICellBorders = cell.CellBorders + 'Set the Cell border property + cellBorders.BorderBottom.BeginArrowheadLength = ArrowheadLength.Medium + 'Save the presentation + presentation__1.Save("CellBorders.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the number of cells merged in a row. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200); + //Get the cell from a row in a table + ICell cell = table.Rows[0].Cells[0]; + //Set the column span + cell.ColumnSpan = 2; + //Save the presentation + presentation.Save("ColumnSpan.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200) + 'Get the cell from a row in a table + Dim cell As ICell = table.Rows(0).Cells(0) + 'Set the column span + cell.ColumnSpan = 2 + 'Save the presentation + presentation__1.Save("ColumnSpan.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the column width in points. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200); + //Get the cell from a row in a table + ICell cell = table.Rows[0].Cells[0]; + //Set the column width + cell.ColumnWidth = 40; + //Save the presentation + presentation.Save("ColumnWidth.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200) + 'Get the cell from a row in a table + Dim cell As ICell = table.Rows(0).Cells(0) + 'Set the column width + cell.ColumnWidth = 40 + 'Save the presentation + presentation__1.Save("ColumnWidth.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets an instance that contains fill formatting options. Read-only. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200); + //Get the cell from a row in a table + ICell cell = table.Rows[0].Cells[0]; + //Set the fill type of the cell as solid + cell.Fill.FillType = FillType.Solid; + //Set color for the solid fill + cell.Fill.SolidFill.Color = ColorObject.FromArgb(10, 34, 89, 32); + //Save the presentation + presentation.Save("CellFill.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200) + 'Get the cell from a row in a table + Dim cell As ICell = table.Rows(0).Cells(0) + 'Set the fill type of the cell as solid + cell.Fill.FillType = FillType.Solid + 'Set color for the solid fill + cell.Fill.SolidFill.Color = ColorObject.FromArgb(10, 34, 89, 32) + 'Save the presentation + presentation__1.Save("CellFill.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets whether this cell is part of a horizontally merged cells. Read-only. + + + true if horizontal merge; otherwise, false. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200); + //Get the cell from a row in a table + ICell cell = table.Rows[0].Cells[0]; + //Set the column span + cell.ColumnSpan = 2; + //Check if it is horizontal merge, it is read only + bool horizontalMerge = cell.IsHorizontalMerge; + //Save the presentation + presentation.Save("HorizontalMerge.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200) + 'Get the cell from a row in a table + Dim cell As ICell = table.Rows(0).Cells(0) + 'Set the column span + cell.ColumnSpan = 2 + 'Check if it is horizontal merge, it is read only + Dim horizontalMerge As Boolean = cell.IsHorizontalMerge + 'Save the presentation + presentation__1.Save("HorizontalMerge.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the number of cells merged in a column. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200); + //Get the cell from a row in a table + ICell cell = table.Rows[0].Cells[0]; + //Set the row span + cell.RowSpan = 2; + //Save the presentation + presentation.Save("RowSpan.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200) + 'Get the cell from a row in a table + Dim cell As ICell = table.Rows(0).Cells(0) + 'Set the row span + cell.RowSpan = 2 + 'Save the presentation + presentation__1.Save("RowSpan.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets an instance that represents the text in a paragraph. Read-only. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200); + //Get the cell from a row in a table + ICell cell = table.Rows[0].Cells[0]; + //Set the text content for the cell + cell.TextBody.AddParagraph("First row First Cell"); + //Save the presentation + presentation.Save("CellTextBody.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200) + 'Get the cell from a row in a table + Dim cell As ICell = table.Rows(0).Cells(0) + 'Set the text content for the cell + cell.TextBody.AddParagraph("First row First Cell") + 'Save the presentation + presentation__1.Save("CellTextBody.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets whether this cell is part of a vertically merged cells. Read-only. + + + true if vertical merge; otherwise, false. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200); + //Get the cell from a row in a table + ICell cell = table.Rows[0].Cells[0]; + //Set the column span + cell.ColumnSpan = 2; + //Check if it is vertical merge, it is read only + bool verticalMerge = cell.IsVerticalMerge; + //Save the presentation + presentation.Save("VerticalMerge.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200) + 'Get the cell from a row in a table + Dim cell As ICell = table.Rows(0).Cells(0) + 'Set the column span + cell.ColumnSpan = 2 + 'Check if it is vertical merge, it is read only + Dim verticalMerge As Boolean = cell.IsVerticalMerge + 'Save the presentation + presentation__1.Save("VerticalMerge.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represent the borders and diagonal lines of a cell. + + + + + Gets the bottom border of the cell. Read-only. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200); + //Get the cell from a row in a table + ICell cell = table.Rows[0].Cells[0]; + //Get the cell border properties + ICellBorders cellBorders = cell.CellBorders; + //Get the border bottom of the cell, read only + ILineFormat borderBottom = cellBorders.BorderBottom; + //Set the begin arrow head length + borderBottom.BeginArrowheadLength = ArrowheadLength.Long; + //Set the dash style of border bottom + borderBottom.DashStyle = LineDashStyle.DashDotDot; + //Set the weight + borderBottom.Weight = 5; + //Save the presentation + presentation.Save("BorderBottom.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200) + 'Get the cell from a row in a table + Dim cell As ICell = table.Rows(0).Cells(0) + 'Get the cell border properties + Dim cellBorders As ICellBorders = cell.CellBorders + 'Get the border bottom of the cell, read only + Dim borderBottom As ILineFormat = cellBorders.BorderBottom + 'Set the begin arrow head length + borderBottom.BeginArrowheadLength = ArrowheadLength.[Long] + 'Set the dash style of border bottom + borderBottom.DashStyle = LineDashStyle.DashDotDot + 'Set the weight + borderBottom.Weight = 5 + 'Save the presentation + presentation__1.Save("BorderBottom.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the diagonal down border of the cell. Read-only. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200); + //Get the cell from a row in a table + ICell cell = table.Rows[0].Cells[0]; + //Get the cell border properties + ICellBorders cellBorders = cell.CellBorders; + //Get the border diagonal down of the cell, read only + ILineFormat borderDiagonalDown = cellBorders.BorderDiagonalDown; + //Set the fill type of border diagonal down + borderDiagonalDown.Fill.FillType = FillType.Solid; + //Set the color for solid fill + borderDiagonalDown.Fill.SolidFill.Color = ColorObject.Navy; + //Save the presentation + presentation.Save("BorderDiagonalDown.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200) + 'Get the cell from a row in a table + Dim cell As ICell = table.Rows(0).Cells(0) + 'Get the cell border properties + Dim cellBorders As ICellBorders = cell.CellBorders + 'Get the border diagonal down of the cell, read only + Dim borderDiagonalDown As ILineFormat = cellBorders.BorderDiagonalDown + 'Set the fill type of border diagonal down + borderDiagonalDown.Fill.FillType = FillType.Solid + 'Set the color for solid fill + borderDiagonalDown.Fill.SolidFill.Color = ColorObject.Navy + 'Save the presentation + presentation__1.Save("BorderDiagonalDown.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the diagonal up border of the cell. Read-only. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200); + //Get the cell from a row in a table + ICell cell = table.Rows[0].Cells[0]; + //Get the cell border properties + ICellBorders cellBorders = cell.CellBorders; + //Get the border diagonal up of the cell, read only + ILineFormat borderDiagonalUp = cellBorders.BorderDiagonalUp; + //Set the end arrow head style of border diagonal up + borderDiagonalUp.EndArrowheadStyle = ArrowheadStyle.ArrowOpen; + //Save the presentation + presentation.Save("BorderDiagonalUp.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200) + 'Get the cell from a row in a table + Dim cell As ICell = table.Rows(0).Cells(0) + 'Get the cell border properties + Dim cellBorders As ICellBorders = cell.CellBorders + 'Get the border diagonal up of the cell, read only + Dim borderDiagonalUp As ILineFormat = cellBorders.BorderDiagonalUp + 'Set the end arrow head style of border diagonal up + borderDiagonalUp.EndArrowheadStyle = ArrowheadStyle.ArrowOpen + 'Save the presentation + presentation__1.Save("BorderDiagonalUp.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the left border of the cell. Read-only. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200); + //Get the cell from a row in a table + ICell cell = table.Rows[0].Cells[0]; + //Get the cell border properties + ICellBorders cellBorders = cell.CellBorders; + //Get the border left of the cell, read only + ILineFormat borderLeft = cellBorders.BorderLeft; + //Set the end arrow head width + borderLeft.EndArrowheadWidth = ArrowheadWidth.Narrow; + //Set the cap style + borderLeft.CapStyle = LineCapStyle.Round; + //Save the presentation + presentation.Save("BorderLeft.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200) + 'Get the cell from a row in a table + Dim cell As ICell = table.Rows(0).Cells(0) + 'Get the cell border properties + Dim cellBorders As ICellBorders = cell.CellBorders + 'Get the border left of the cell, read only + Dim borderLeft As ILineFormat = cellBorders.BorderLeft + 'Set the end arrow head width + borderLeft.EndArrowheadWidth = ArrowheadWidth.Narrow + 'Set the cap style + borderLeft.CapStyle = LineCapStyle.Round + 'Save the presentation + presentation__1.Save("BorderLeft.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the right border of the cell. Read-only. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200); + //Get the cell from a row in a table + ICell cell = table.Rows[0].Cells[0]; + //Get the cell border properties + ICellBorders cellBorders = cell.CellBorders; + //Get the border right of the cell, read only + ILineFormat borderRight = cellBorders.BorderRight; + //Set the end arrow head style of border right + borderRight.EndArrowheadStyle = ArrowheadStyle.ArrowStealth; + //Save the presentation + presentation.Save("BorderRight.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200) + 'Get the cell from a row in a table + Dim cell As ICell = table.Rows(0).Cells(0) + 'Get the cell border properties + Dim cellBorders As ICellBorders = cell.CellBorders + 'Get the border right of the cell, read only + Dim borderRight As ILineFormat = cellBorders.BorderRight + 'Set the end arrow head style of border right + borderRight.EndArrowheadStyle = ArrowheadStyle.ArrowStealth + 'Save the presentation + presentation__1.Save("BorderRight.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the top border of the cell. Read-only. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200); + //Get the cell from a row in a table + ICell cell = table.Rows[0].Cells[0]; + //Get the cell border properties + ICellBorders cellBorders = cell.CellBorders; + //Get the border top of the cell, read only + ILineFormat borderTop = cellBorders.BorderTop; + //Set the begin arrow head width of border top + borderTop.BeginArrowheadWidth = ArrowheadWidth.Wide; + //Set the line type of border top + borderTop.LineJoinType = LineJoinType.Miter; + //Save the presentation + presentation.Save("BorderTop.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(4, 3, 100, 120, 300, 200) + 'Get the cell from a row in a table + Dim cell As ICell = table.Rows(0).Cells(0) + 'Get the cell border properties + Dim cellBorders As ICellBorders = cell.CellBorders + 'Get the border top of the cell, read only + Dim borderTop As ILineFormat = cellBorders.BorderTop + 'Set the begin arrow head width of border top + borderTop.BeginArrowheadWidth = ArrowheadWidth.Wide + 'Set the line type of border top + borderTop.LineJoinType = LineJoinType.Miter + 'Save the presentation + presentation__1.Save("BorderTop.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents a collection of objects in a table. + + + + + Gets the number of cells in the row or column. Read-only. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(3, 3, 100, 120, 300, 200); + //Create instance to hold the cell collection from the table + ICells cells = table.Rows[0].Cells; + //Get the count of cells, read only + int count = cells.Count; + //Save the presentation + presentation.Save("Cells.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(3, 3, 100, 120, 300, 200) + 'Create instance to hold the cell collection from the table + Dim cells As ICells = table.Rows(0).Cells + 'Get the count of cells, read only + Dim count As Integer = cells.Count + 'Save the presentation + presentation__1.Save("Cells.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a instance at the specified index from the row or column. Read-only. + + The zero-based index of the element. + Returns the cell at the particular index if found otherwise -1. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(3, 3, 100, 120, 300, 200); + //Create instance to hold the cell collection from the table + ICells cells = table.Rows[0].Cells; + //Get the specific cell from the collection, read only + ICell cell = cells[0]; + //Add text content to cell + cell.TextBody.AddParagraph("First row, first cell"); + //Save the presentation + presentation.Save("Cells.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(3, 3, 100, 120, 300, 200) + 'Create instance to hold the cell collection from the table + Dim cells As ICells = table.Rows(0).Cells + 'Get the specific cell from the collection, read only + Dim cell As ICell = cells(0) + 'Add text content to cell + cell.TextBody.AddParagraph("First row, first cell") + 'Save the presentation + presentation__1.Save("Cells.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents the row in a table. + + + + + Creates a copy of the current row. + + Returns the cloned row object + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Clone the row element. + IRow row = table.Rows[0].Clone(); + //Add text content to the cell. + row.Cells[0].TextBody.Text = "Cloned row"; + //Add row to the collection + table.Rows.Add(row); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Clone the row element. + Dim row As IRow = table.Rows(0).Clone() + 'Add text content to the cell. + row.Cells(0).TextBody.Text = "Cloned row" + 'Add row to the collection + table.Rows.Add(row) + 'Saves the Presentation. + pptxDoc.Save("Sample.pptx") + 'Close the presentation. + pptxDoc.Close() + + + + + + Gets an instance that represents the cell collection. Read-only + + + The cells. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Get the row from row collection + IRow row = table.Rows[0]; + //Get the cell collection from the row, read only + ICells cells = row.Cells; + //Set the text content for cells in row + cells[0].TextBody.AddParagraph("First row, First Column"); + cells[1].TextBody.AddParagraph("First row, Second Column"); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Get the row from row collection + Dim row As IRow = table.Rows(0) + 'Get the cell collection from the row, read only + Dim cells As ICells = row.Cells + 'Set the text content for cells in row + cells(0).TextBody.AddParagraph("First row, First Column") + cells(1).TextBody.AddParagraph("First row, Second Column") + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets height of the row, in points. + + + The height. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Get the row from row collection + IRow row = table.Rows[0]; + //Set the height of the row + row.Height = 40; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Get the row from row collection + Dim row As IRow = table.Rows(0) + 'Set the height of the row + row.Height = 40 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents a collection of objects in a table. + + + + + Adds a new row at the end of the row collection. + + Returns the newly added instance. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Get the row collection from table + IRows rows = table.Rows; + //Add row to the collection + rows.Add(); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Get the row collection from table + Dim rows As IRows = table.Rows + 'Add row to the collection + rows.Add() + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Adds the specified row at the end of the row collection. + + Represents an instance to be added. + Returns the zero-based index of the newly added row object in the row collection. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Get the row collection from table + IRows rows = table.Rows; + //Retrieve a single row from the row collection, read only + IRow row = table.Rows[0]; + //Add a specific row to the collection + rows.Add(row); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Get the row collection from table + Dim rows As IRows = table.Rows + 'Retrieve a single row from the row collection, read only + Dim row As IRow = table.Rows(0) + 'Add a specific row to the collection + rows.Add(row) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Inserts the specified row at specified index in the table. + + The zero-based index at which the row should be inserted. + The row instance to insert. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Retrieve a single row from the row collection, read only + IRow row = table.Rows[0]; + //Set fill type for the cell in a row + row.Cells[0].Fill.FillType = FillType.Solid; + //Set color of the solid fill + row.Cells[0].Fill.SolidFill.Color = ColorObject.SaddleBrown; + //Get the row collection from table + IRows rows = table.Rows; + //Insert row at index 2 + rows.Insert(2, row); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Retrieve a single row from the row collection, read only + Dim row As IRow = table.Rows(0) + 'Set fill type for the cell in a row + row.Cells(0).Fill.FillType = FillType.Solid + 'Set color of the solid fill + row.Cells(0).Fill.SolidFill.Color = ColorObject.SaddleBrown + 'Insert row at index 2 + rows.Insert(2, row) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the row at the specified index of the row collection. + + The zero-based index of the row to remove. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(4, 2, 100, 120, 300, 200); + //Get the row collection from table + IRows rows = table.Rows; + //Remove a specific row instance + rows.RemoveAt(0); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(4, 2, 100, 120, 300, 200) + 'Remove a specific row instance + rows.RemoveAt(0) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the first occurrence of a specified row from the row collection. + + The row object to be removed from the collection. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Retrieve a single row from the row collection, read only + IRow row = table.Rows[0]; + //Get the row collection from table + IRows rows = table.Rows; + //Remove a specific row instance + rows.Remove(row); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Retrieve a single row from the row collection, read only + Dim row As IRow = table.Rows(0) + 'Remove a specific row instance + rows.Remove(row) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Returns the zero-based index of the first occurrence of the instance within the collection. + + The instance to locate in the collection. + Returns the zero-based index of the first occurrence of row instance within the collection, if found; otherwise, –1. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Get the row collection from table + IRows rows = table.Rows; + //Retrieve a single row from the row collection, read only + IRow row = table.Rows[0]; + //Add a specific row to the collection + rows.Add(row); + //Get the index of a specific row from the collection + int index = rows.IndexOf(row); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Get the row collection from table + Dim rows As IRows = table.Rows + 'Retrieve a single row from the row collection, read only + Dim row As IRow = table.Rows(0) + 'Add a specific row to the collection + rows.Add(row) + 'Get the index of a specific row from the collection + Dim index As Integer = rows.IndexOf(row) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes all the elements from row collection. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Get the row collection from table + IRows rows = table.Rows; + //Retrieve a single row from the row collection, read only + IRow row = table.Rows[0]; + //Add a specific row to the collection + rows.Add(row); + //Clear the row collection + rows.Clear(); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Get the row collection from table + Dim rows As IRows = table.Rows + 'Retrieve a single row from the row collection, read only + Dim row As IRow = table.Rows(0) + 'Add a specific row to the collection + rows.Add(row) + 'Clear the row collection + rows.Clear() + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the number of elements in the rows collection. Read-only. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Get the row collection from table + IRows rows = table.Rows; + //Retrieve a single row from the row collection, read only + IRow row = table.Rows[0]; + //Add a specific row to the collection + rows.Add(row); + //Get the count of row collection, read only + int count = rows.Count; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Get the row collection from table + Dim rows As IRows = table.Rows + 'Retrieve a single row from the row collection, read only + Dim row As IRow = table.Rows(0) + 'Add a specific row to the collection + rows.Add(row) + 'Get the count of row collection, read only + Dim count As Integer = rows.Count + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a instance at the specified index from the row collection. Read-only. + + Specifies the index of the row to locate. + Returns an instance. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Get the row from row collection + IRow row = table.Rows[0]; + //Set the height of the row + row.Height = 30; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Get the row from row collection + Dim row As IRow = table.Rows(0) + 'Set the height of the row + row.Height = 30 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents the table in a slide. + + + + + Gets the dynamic height of the table. + + + + //Create instance of PowerPoint presentation + IPresentation presDoc = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 10); + //Set the text content for specific cell in a row + table.Rows[0].Cells[0].TextBody.AddParagraph("Hello World"); + //Get the dynamic height of the table + float height = table.GetActualHeight(); + //Save the presentation + presDoc.Save("Sample.pptx"); + //Close the presentation + presDoc.Close(); + + /// + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Open Table in the slide to make changes + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 10) + ‘Set the text content for specific cell in a row + table.Rows[0].Cells[0].TextBody.AddParagraph("Hello World"); + ‘Get the dynamic height of table + Dim height As float = table.GetActualHeight() + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + /// + + + + + Inserts the column at the specified index position of the table + + The index position to insert the column + + + //Create instance of PowerPoint presentation + IPresentation presDoc = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Insert the column at the specified index position + table.InsertColumn(1); + //Save the presentation + presDoc.Save("Sample.pptx"); + //Close the presentation + presDoc.Close(); + + + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + ‘Insert the column at the specified index position + table.InsertColumn(1); + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + /// + + + + + Gets or sets a boolean value indicates whether to display special formatting for the first column. + + + true if this instance has first column; otherwise, false. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Retrieve each cell and fill text content to the cell, it is read only + ICell cell = table[0, 0]; + cell.TextBody.AddParagraph("First Row and First Column"); + cell = table[0, 1]; + cell.TextBody.AddParagraph("First Row and Second Column"); + cell = table[1, 0]; + cell.TextBody.AddParagraph("Second Row and First Column"); + cell = table[1, 1]; + cell.TextBody.AddParagraph("Second Row and Second Column"); + //Set the table has first column + table.HasFirstColumn = true; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Retrieve each cell and fill text content to the cell, it is read only + Dim cell As ICell = table(0, 0) + cell.TextBody.AddParagraph("First Row and First Column") + cell = table(0, 1) + cell.TextBody.AddParagraph("First Row and Second Column") + cell = table(1, 0) + cell.TextBody.AddParagraph("Second Row and First Column") + cell = table(1, 1) + cell.TextBody.AddParagraph("Second Row and Second Column") + 'Set the table has first column + table.HasFirstColumn = True + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a boolean value indicates whether to display special formatting for the first row. + + + true if this instance has header row; otherwise, false. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Retrieve each cell and fill text content to the cell, it is read only + ICell cell = table[0, 0]; + cell.TextBody.AddParagraph("First Row and First Column"); + cell = table[0, 1]; + cell.TextBody.AddParagraph("First Row and Second Column"); + cell = table[1, 0]; + cell.TextBody.AddParagraph("Second Row and First Column"); + cell = table[1, 1]; + cell.TextBody.AddParagraph("Second Row and Second Column"); + //Set the header row + table.HasHeaderRow = true; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Retrieve each cell and fill text content to the cell, it is read only + Dim cell As ICell = table(0, 0) + cell.TextBody.AddParagraph("First Row and First Column") + cell = table(0, 1) + cell.TextBody.AddParagraph("First Row and Second Column") + cell = table(1, 0) + cell.TextBody.AddParagraph("Second Row and First Column") + cell = table(1, 1) + cell.TextBody.AddParagraph("Second Row and Second Column") + 'Set the table has header row + table.HasHeaderRow = True + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a boolean value indicates whether to display banded rows, in which even rows are formatted differently from odd rows. + + + true if this instance has banded rows; otherwise, false. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Retrieve each cell and fill text content to the cell, it is read only + ICell cell = table[0, 0]; + cell.TextBody.AddParagraph("First Row and First Column"); + cell = table[0, 1]; + cell.TextBody.AddParagraph("First Row and Second Column"); + cell = table[1, 0]; + cell.TextBody.AddParagraph("Second Row and First Column"); + cell = table[1, 1]; + cell.TextBody.AddParagraph("Second Row and Second Column"); + //Set horizontal banding for the table + table.HasBandedRows = true; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Retrieve each cell and fill text content to the cell, it is read only + Dim cell As ICell = table(0, 0) + cell.TextBody.AddParagraph("First Row and First Column") + cell = table(0, 1) + cell.TextBody.AddParagraph("First Row and Second Column") + cell = table(1, 0) + cell.TextBody.AddParagraph("Second Row and First Column") + cell = table(1, 1) + cell.TextBody.AddParagraph("Second Row and Second Column") + 'Set horizontal banding for the table + table.HasBandedRows = True + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a boolean value indicates whether to display special formatting for the last column. + + + true if this instance has last column; otherwise, false. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Retrieve each cell and fill text content to the cell, it is read only + ICell cell = table[0, 0]; + cell.TextBody.AddParagraph("First Row and First Column"); + cell = table[0, 1]; + cell.TextBody.AddParagraph("First Row and Second Column"); + cell = table[1, 0]; + cell.TextBody.AddParagraph("Second Row and First Column"); + cell = table[1, 1]; + cell.TextBody.AddParagraph("Second Row and Second Column"); + //Set the last column + table.HasLastColumn = true; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Retrieve each cell and fill text content to the cell, it is read only + Dim cell As ICell = table(0, 0) + cell.TextBody.AddParagraph("First Row and First Column") + cell = table(0, 1) + cell.TextBody.AddParagraph("First Row and Second Column") + cell = table(1, 0) + cell.TextBody.AddParagraph("Second Row and First Column") + cell = table(1, 1) + cell.TextBody.AddParagraph("Second Row and Second Column") + 'Set the table has last column + table.HasLastColumn = True + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a boolean value indicates whether to display special formatting for the last row of the specified table. + + + true if this instance has total row; otherwise, false. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Retrieve each cell and fill text content to the cell, it is read only + ICell cell = table[0, 0]; + cell.TextBody.AddParagraph("First Row and First Column"); + cell = table[0, 1]; + cell.TextBody.AddParagraph("First Row and Second Column"); + cell = table[1, 0]; + cell.TextBody.AddParagraph("Second Row and First Column"); + cell = table[1, 1]; + cell.TextBody.AddParagraph("Second Row and Second Column"); + //Set the total row + table.HasTotalRow = true; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Retrieve each cell and fill text content to the cell, it is read only + Dim cell As ICell = table(0, 0) + cell.TextBody.AddParagraph("First Row and First Column") + cell = table(0, 1) + cell.TextBody.AddParagraph("First Row and Second Column") + cell = table(1, 0) + cell.TextBody.AddParagraph("Second Row and First Column") + cell = table(1, 1) + cell.TextBody.AddParagraph("Second Row and Second Column") + 'Set the table has total row + table.HasTotalRow = True + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets an instance that represents the row collection. Read-only. + + + The rows. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Get the row collection from the table, it is read only + IRows rows = table.Rows; + //Set the text content for specific cell in a row + rows[0].Cells[0].TextBody.AddParagraph("Row - 1, Column - 1"); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Get the row collection from the table, it is read only + Dim rows As IRows = table.Rows + 'Set the text content for specific cell in a row + rows(0).Cells(0).TextBody.AddParagraph("Row - 1, Column - 1") + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets an instance that represents the column collection. Read-only. + + + The columns. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Get the row collection from the table, it is read only + IColumns columns = table.Columns; + //Set the text content for specific cell in a column + columns[0].Cells[0].TextBody.AddParagraph("Column - 1, Row - 1"); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Get the row collection from the table, it is read only + Dim columns As IColumns = table.Columns + 'Set the text content for specific cell in a column + columns(0).Cells(0).TextBody.AddParagraph("Column - 1, Row - 1") + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a instance that represents the table style. + + + The built in style. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Get the row collection from the table, it is read only + IRows rows = table.Rows; + //Set the text content for specific cell in a row + rows[0].Cells[0].TextBody.AddParagraph("Row - 1, Column - 1"); + //Set the builtin style for the table + table.BuiltInStyle = BuiltInTableStyle.MediumStyle2Accent6; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Get the row collection from the table, it is read only + Dim rows As IRows = table.Rows + 'Set the text content for specific cell in a row + rows(0).Cells(0).TextBody.AddParagraph("Row - 1, Column - 1") + 'Set the builtin style for the table + table.BuiltInStyle = BuiltInTableStyle.MediumStyle2Accent6 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets a boolean value indicates whether to display banded columns, in which even columns are formatted differently from odd columns. + + + true if this instance has banded columns; otherwise, false. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Retrieve each cell and fill text content to the cell, it is read only + ICell cell = table[0, 0]; + cell.TextBody.AddParagraph("First Row and First Column"); + cell = table[0, 1]; + cell.TextBody.AddParagraph("First Row and Second Column"); + cell = table[1, 0]; + cell.TextBody.AddParagraph("Second Row and First Column"); + cell = table[1, 1]; + cell.TextBody.AddParagraph("Second Row and Second Column"); + //Set vertical banding for the table + table.HasBandedColumns = true; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Retrieve each cell and fill text content to the cell, it is read only + Dim cell As ICell = table(0, 0) + cell.TextBody.AddParagraph("First Row and First Column") + cell = table(0, 1) + cell.TextBody.AddParagraph("First Row and Second Column") + cell = table(1, 0) + cell.TextBody.AddParagraph("Second Row and First Column") + cell = table(1, 1) + cell.TextBody.AddParagraph("Second Row and Second Column") + 'Set vertical banding for the table + table.HasBandedColumns = True + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a single instance from the table. Read-only. + + Determines the row index. + Determines the column index. + Returns an instance. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Retrieve each cell and fill text content to the cell, it is read only + ICell cell = table[0, 0]; + cell.TextBody.AddParagraph("First Row and First Column"); + cell = table[0, 1]; + cell.TextBody.AddParagraph("First Row and Second Column"); + cell = table[1, 0]; + cell.TextBody.AddParagraph("Second Row and First Column"); + cell = table[1, 1]; + cell.TextBody.AddParagraph("Second Row and Second Column"); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Retrieve each cell and fill text content to the cell, it is read only + Dim cell As ICell = table(0, 0) + cell.TextBody.AddParagraph("First Row and First Column") + cell = table(0, 1) + cell.TextBody.AddParagraph("First Row and Second Column") + cell = table(1, 0) + cell.TextBody.AddParagraph("Second Row and First Column") + cell = table(1, 1) + cell.TextBody.AddParagraph("Second Row and Second Column") + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the total number of columns in the table. + + + + //Create instance of PowerPoint presentation + IPresentation presDoc = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presDoc.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Get the total number of columns in the table + int columnsCount = table.ColumnsCount; + //Save the presentation + presDoc.Save("Sample.pptx"); + //Close the presentation + presDoc.Close(); + + /// + Dim presDoc As IPresentation = Presentation.Create() + ‘Add slide to the presentation + Dim slide As ISlide = presDoc.Slides.Add(SlideLayoutType.Blank) + ‘Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + ‘Get the total number of columns in the table + Dim columnsCount As Integer = table.ColumnsCount + ‘Save the presentation + presDoc.Save("Sample.pptx") + ‘Close the presentation + presDoc.Close() + /// + + + + + Represents a collection of instance. + + + + + Adds a table to the shape collection with the specified number of rows and columns. The valid range is 1 to 75. + + Specifies the row count of the table. The valid range is 1 to 75. + Specifies the column count of the table. The valid range is 1 to 75. + Represents the left position, in points. The Left value ranges from -169056 to 169056. + Represents the top position, in points. The Top value ranges from -169056 to 169056. + Represents the width, in points. The Width value ranges from 0 to 169056. + Represents the height, in points. The Height value ranges from 0 to 169056. + Returns the instance that represents the newly created table. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance to hold table collection in a slide + ITables tables = slide.Tables; + //Add tables to the table collection + ITable table = tables.AddTable(2, 2, 100, 120, 300, 200); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance to hold table collection in a slide + Dim tables As ITables = slide.Tables + 'Add tables to the table collection + Dim table As ITable = tables.AddTable(2, 2, 100, 120, 300, 200) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Returns the zero-based index of the first occurrence of the instance within the collection. + + The instance to locate in the collection. + Returns the zero-based index of the first occurrence of table within the collection, if found; otherwise, –1. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance to hold table collection in a slide + ITables tables = slide.Tables; + //Add tables to the table collection + ITable table = tables.AddTable(2, 2, 100, 120, 300, 200); + tables.AddTable(1, 1, 300, 200, 100, 100); + tables.AddTable(1, 1, 400, 30, 100, 100); + //Get the index of a specific table + int index = tables.IndexOf(table); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance to hold table collection in a slide + Dim tables As ITables = slide.Tables + 'Add tables to the table collection + Dim table As ITable = tables.AddTable(2, 2, 100, 120, 300, 200) + tables.AddTable(1, 1, 300, 200, 100, 100) + tables.AddTable(1, 1, 400, 30, 100, 100) + 'Get the index of a specific table + Dim index As Integer = tables.IndexOf(table) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the first occurrence of a specified table from the table collection. + + The table object to be removed from the collection. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance to hold table collection in a slide + ITables tables = slide.Tables; + //Add tables to the table collection + ITable table = tables.AddTable(2, 2, 100, 120, 300, 200); + tables.AddTable(1, 1, 300, 200, 100, 100); + tables.AddTable(1, 1, 400, 30, 100, 100); + //Get the specific table from the collection using index, read only + ITable _table = tables[1]; + //Remove a particular table instance + tables.Remove(_table); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance to hold table collection in a slide + Dim tables As ITables = slide.Tables + 'Add tables to the table collection + Dim table As ITable = tables.AddTable(2, 2, 100, 120, 300, 200) + tables.AddTable(1, 1, 300, 200, 100, 100) + tables.AddTable(1, 1, 400, 30, 100, 100) + 'Get the specific table from the collection using index, read only + Dim _table As ITable = tables(1) + 'Remove a particular table instance + tables.Remove(_table) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the table at the specified index of the table collection. + + The zero-based index of the element to be removed. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance to hold table collection in a slide + ITables tables = slide.Tables; + //Add tables to the table collection + ITable table = tables.AddTable(2, 2, 100, 120, 300, 200); + tables.AddTable(1, 1, 300, 200, 100, 100); + //Remove table using index position + tables.RemoveAt(1); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance to hold table collection in a slide + Dim tables As ITables = slide.Tables + 'Add tables to the table collection + Dim table As ITable = tables.AddTable(2, 2, 100, 120, 300, 200) + tables.AddTable(1, 1, 300, 200, 100, 100) + 'Remove table using index position + tables.RemoveAt(1) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a instance at specified index from the collection. Read-only. + + Determines the table index. + Returns an instance. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance to hold table collection in a slide + ITables tables = slide.Tables; + //Add tables to the table collection + ITable table = tables.AddTable(2, 2, 100, 120, 300, 200); + tables.AddTable(1, 1, 300, 200, 100, 100); + tables.AddTable(1, 1, 400, 30, 100, 100); + //Get the specific table from the collection using index, read only + ITable _table = tables[1]; + //Set the built-in style for the table + _table.BuiltInStyle = BuiltInTableStyle.MediumStyle2Accent6; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance to hold table collection in a slide + Dim tables As ITables = slide.Tables + 'Add tables to the table collection + Dim table As ITable = tables.AddTable(2, 2, 100, 120, 300, 200) + tables.AddTable(1, 1, 300, 200, 100, 100) + tables.AddTable(1, 1, 400, 30, 100, 100) + 'Get the specific table from the collection using index, read only + Dim _table As ITable = tables(1) + 'Set the built-in style for the table + _table.BuiltInStyle = BuiltInTableStyle.MediumStyle2Accent6 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the number of elements in the table collection. Read-only. + + + The total count of the table. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Create instance to hold table collection in a slide + ITables tables = slide.Tables; + //Add tables to the table collection + ITable table = tables.AddTable(2, 2, 100, 120, 300, 200); + tables.AddTable(1, 1, 300, 200, 100, 100); + tables.AddTable(1, 1, 400, 30, 100, 100); + //Get the count of table collection, it is read only + int count = tables.Count; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Create instance to hold table collection in a slide + Dim tables As ITables = slide.Tables + 'Add tables to the table collection + Dim table As ITable = tables.AddTable(2, 2, 100, 120, 300, 200) + tables.AddTable(1, 1, 300, 200, 100, 100) + tables.AddTable(1, 1, 400, 30, 100, 100) + 'Get the count of table collection, it is read only + Dim count As Integer = tables.Count + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents the Column in a table. + + + + + Creates a copy of the current column. + + Returns the cloned column object + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Clone the column element. + IColumn column = table.Columns[0].Clone(); + //Add text content to the cell. + column.Cells[0].TextBody.Text = "Cloned column"; + //Add column to the collection + table.Columns.Add(column); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Clone the column element. + Dim column As IColumn = table.Columns(0).Clone() + 'Add text content to the cell. + column.Cells(0).TextBody.Text = "Cloned column" + 'Add column to the collection + table.Columns.Add(column) + 'Saves the Presentation. + pptxDoc.Save("Sample.pptx") + 'Close the presentation. + pptxDoc.Close() + + + + + + Gets an instance that represents the cell collection. Read-only + + + The cells. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Get the column from column collection + IColumn column = table.Columns[0]; + //Get the cell collection from the column, read only + ICells cells = column.Cells; + //Set the text content for cells in column + cells[0].TextBody.AddParagraph("First row, First Column"); + cells[1].TextBody.AddParagraph("Second row, First Column"); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Get the column from column collection + Dim column As IColumn = table.Columns(0) + 'Get the cell collection from the column, read only + Dim cells As ICells = column.Cells + 'Set the text content for cells in column + cells(0).TextBody.AddParagraph("First row, First Column") + cells(1).TextBody.AddParagraph("Second row, First Column") + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets width of the column, in points. + + + The width. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Get the column from column collection + IColumn column = table.Columns[0]; + //Set the width of the column + column.Width = 240; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Get the column from column collection + Dim column As IColumn = table.Columns(0) + 'Set the width of the column + column.Width = 240 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Represents a collection of objects in a table. + + + + + Adds a new column at the end of the column collection. + + Returns the newly added instance. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Get the column collection from table + IColumns columns = table.Columns; + //Add column to the collection + columns.Add(); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Get the column collection from table + Dim columns As IColumns = table.Columns + 'Add column to the collection + columns.Add() + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Adds the specified column at the end of the column collection. + + Represents an instance to be added. + Returns the zero-based index of the newly added column object in the column collection. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Get the column collection from table + IColumns columns = table.Columns; + //Retrieve a single column from the column collection, read only + IColumn column = columns[0]; + //Add a specific column to the collection + columns.Add(column); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Get the column collection from table + Dim columns As IColumns = table.Columns + 'Retrieve a single column from the column collection, read only + Dim column As IColumn = columns(0) + 'Add a specific column to the collection + columns.Add(column) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Inserts the specified column at specified index in the table. + + The zero-based index at which the column should be inserted. + The column instance to insert. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Retrieve a single column from the column collection, read only + IColumn column = table.Columns[0]; + //Set fill type for the cell in a column + column.Cells[0].Fill.FillType = FillType.Solid; + //Set color of the solid fill + column.Cells[0].Fill.SolidFill.Color = ColorObject.SaddleBrown; + //Get the column collection from table + IColumns columns = table.Columns; + //Insert column at index 2 + columns.Insert(2, column); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Get the column collection from table + Dim columns As IColumns = table.Columns + 'Retrieve a single column from the column collection, read only + Dim column As IColumn = columns(0) + 'Set fill type for the cell in a column + column.Cells(0).Fill.FillType = FillType.Solid + 'Set color of the solid fill + column.Cells(0).Fill.SolidFill.Color = ColorObject.SaddleBrown + 'Insert column at index 2 + columns.Insert(2, column) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the column at the specified index of the column collection. + + The zero-based index of the column to remove. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(4, 2, 100, 120, 300, 200); + //Get the column collection from table + IColumns columns = table.Columns; + //Remove a specific column instance + columns.RemoveAt(0); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(4, 2, 100, 120, 300, 200) + 'Get the column collection from table + Dim columns As IColumns = table.Columns + 'Remove a specific column instance + columns.RemoveAt(0) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes the first occurrence of a specified column from the column collection. + + The column object to be removed from the collection. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Retrieve a single column from the column collection, read only + IColumn column = table.Columns[0]; + //Get the column collection from table + IColumns columns = table.Columns; + //Remove a specific column instance + columns.Remove(column); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Get the column collection from table + Dim columns As IColumns = table.Columns + 'Retrieve a single column from the column collection, read only + Dim column As IColumn = table.Columns(0) + 'Remove a specific column instance + columns.Remove(column) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Returns the zero-based index of the first occurrence of the instance within the collection. + + The instance to locate in the collection. + Returns the zero-based index of the first occurrence of column instance within the collection, if found; otherwise, –1. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Get the column collection from table + IColumns columns = table.Columns; + //Retrieve a single column from the column collection, read only + IColumn column = table.Columns[0]; + //Add a specific column to the collection + columns.Add(column); + //Get the index of a specific column from the collection + int index = columns.IndexOf(column); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Get the column collection from table + Dim columns As IColumns = table.Columns + 'Retrieve a single column from the column collection, read only + Dim column As IColumn = columns(0) + 'Add a specific column to the collection + columns.Add(column) + 'Get the index of a specific column from the collection + Dim index As Integer = columns.IndexOf(column) + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Removes all the elements from column collection. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Get the column collection from table + IColumns columns = table.Columns; + //Retrieve a single column from the column collection, read only + IColumn column = columns[0]; + //Add a specific column to the collection + columns.Add(column); + //Clear the column collection + columns.Clear(); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Get the column collection from table + Dim columns As IColumns = table.Columns + 'Retrieve a single column from the column collection, read only + Dim column As IColumn = columns(0) + 'Add a specific column to the collection + columns.Add(column) + 'Clear the column collection + columns.Clear() + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the number of elements in the column collection. Read-only. + + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Get the column collection from table + IColumns columns = table.Columns; + //Retrieve a single column from the column collection, read only + IColumn column = columns[0]; + //Add a specific column to the collection + columns.Add(column); + //Get the count of column collection, read only + int count = columns.Count; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Get the column collection from table + Dim columns As IColumns = table.Columns + 'Retrieve a single column from the column collection, read only + Dim column As IColumn = columns(0) + 'Add a specific column to the collection + columns.Add(column) + 'Get the count of column collection, read only + Dim count As Integer = columns.Count + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets a instance at the specified index from the column collection. Read-only. + + Specifies the index of the column to locate. + Returns an instance. + + + //Create instance of PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200); + //Get the column from column collection + IColumn column = table.Columns[0]; + //Set the width of the column + column.Width = 240; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create instance of PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(2, 2, 100, 120, 300, 200) + 'Get the column from column collection + Dim column As IColumn = table.Columns(0) + 'Set the width of the column + column.Width = 300 + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Check whether current line has different height or not. + + Returns true, if it has different height; Otherwise false. + + + + Gets or Sets a height of line. + + + + + Gets or Sets a maximum ascent of the line. + + + + + Represents a TextBody column information. Used in multi column layouting. + + + + + Create a object of ColumnInfo. + + Represents a owner text body, where this column exists. + + + + Gets a owner text body of the column. + + + + + Gets or Sets the paragraph start index of this column. + + + + + Gets or Sets the line start index of the paragraph. + + + + + Gets or Sets the height of the column. + + + + + Gets or Sets a TextBody columns information. Used in multi column layouting. + + + + + Represent a CharacterRangeType of current text range. + + + + + Parse a ColorMapOvr elements of slide. + + Represent a reader object. + Represent a Baseslide. + + + + Parse the ole object + + + + + + + Parse the ole data + + + + + + + Check whether the mentioned node exists or not + + + + + + + + Extracts extended properties from reader and inserts it workbook. + + XmlReader to extract extended properties from. + + + + Extracts core properties from reader and inserts it workbook. + + XmlReader to extract core properties from. + + + + Extracts custom properties from reader and inserts it workbook. + + XmlReader to extract custom properties from. + + + + Extracts custom property from reader and inserts it into custom property implementation. + + XmlReader to extract data from. + Custom property. + + + + Parses the smart art whole property. + + Represents the reader object. + Represents the Smart Art data model. + + + + Parse the extension list properties + + + + + + + Parse the extension + + + + + + + Parse the NonVisual drawing properties for SmartArtPoint + + + + + + + + + + + + + + + + + + + + + + + + Get Path adjust value + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents the font settings in the PowerPoint document. + + + + + + //Open the existing PowerPoint presentation. + IPresentation pptxDoc = Presentation.Open("Template.pptx"); + //Initializes a set of default fallback fonts. + pptxDoc.FontSettings.FallbackFonts.InitializeDefault(); + //Converts the first slide into image + Image image = pptxDoc.Slides[0].ConvertToImage(Syncfusion.Drawing.ImageType.Metafile); + //Disposes the image + image.Dispose(); + //Close the Presentation + pptxDoc.Close(); + + + 'Open the existing PowerPoint presentation. + Dim pptxDoc As IPresentation = Presentation.Open("Template.pptx") + 'Initializes a set of default fallback fonts. + pptxDoc.FontSettings.FallbackFonts.InitializeDefault() + 'Converts the first slide into image + Dim image As Image = pptxDoc.Slides(0).ConvertToImage(Syncfusion.Drawing.ImageType.Metafile) + 'Disposes the image + image.Dispose() + 'Close the Presentation + pptxDoc.Close() + + + + + + Gets the font based on given font details. + + Name of the font. + Size of the font. + Style of the font. + The created font, or substituted font by event. + + + + Creates font based on given font details. + + Name of the font. + Size of the font. + Style of the font. + The created font. + + + + Dispose the objects of FontSetting class. + + + + + + + //Open the existing PowerPoint presentation. + IPresentation pptxDoc = Presentation.Open("Template.pptx"); + //Adds fallback font for "Hebrew" script type. + pptxDoc.FontSettings.FallbackFonts.Add(ScriptType.Hebrew, "Arial, Courier New"); + //Adds fallback font for "Hindi" script type. + pptxDoc.FontSettings.FallbackFonts.Add(ScriptType.Hindi, "Mangal, Nirmala UI"); + //Converts the first slide into image + Image image = pptxDoc.Slides[0].ConvertToImage(Syncfusion.Drawing.ImageType.Metafile); + //Disposes the image + image.Dispose(); + //Close the Presentation + pptxDoc.Close(); + + + 'Open the existing PowerPoint presentation. + Dim pptxDoc As IPresentation = Presentation.Open("Template.pptx") + 'Adds fallback font for "Hebrew" script type. + pptxDoc.FontSettings.FallbackFonts.Add(ScriptType.Hebrew, "Arial, Courier New") + 'Adds fallback font for "Hindi" script type. + pptxDoc.FontSettings.FallbackFonts.Add(ScriptType.Hindi, "Mangal, Nirmala UI") + 'Converts the first slide into image + Dim image As Image = pptxDoc.Slides(0).ConvertToImage(Syncfusion.Drawing.ImageType.Metafile) + 'Disposes the image + image.Dispose() + 'Close the Presentation + pptxDoc.Close() + + + + + + Represents the method that handles substitute font event. + + + + + + Represents the original font name. + + + + + Represents the substitute font name. + + + + + Represents the substitute font name. + + + + + Represents the original fontstyle. + + + + + Initializes a new instance of class for the specified document + with original (missing) font name, and alternate font name. + + Name of the original (missing) font name. + Name of the alternate font name. + Font style of the font + + + + Gets the original font name. Read Only. + + The string that specifies the original font name. + + + //Load the PowerPoint presentation and convert to image + IPresentation pptxDoc = Presentation.Open("Sample.pptx"); + // Initializes the 'SubstituteFont' event to set the replacement font + pptxDoc.FontSettings.SubstituteFont += FontSettings_SubstituteFont; + //Converts the first slide into image + Image image = pptxDoc.Slides[0].ConvertToImage(Syncfusion.Drawing.ImageType.Metafile); + //Disposes the image + image.Dispose(); + //Close the presentation. + pptxDoc.Close(); + /// + /// Sets the alternate font when a specified font is unavailable in the production environment + /// + /// FontSettings type of the Presentation in which the specified font is used but unavailable in production environment. + /// Retrieves the unavailable font name and receives the substitute font name for conversion. + private static void FontSettings_SubstituteFont(object sender, SubstituteFontEventArgs args) + { + if (args.OriginalFontName == "Arial Unicode MS") + args.AlternateFontName = "Arial"; + else if (args.OriginalFontName == "Calibri Light") + args.AlternateFontName = "Calibri"; + else + args.AlternateFontName = "TimesNewRoman"; + } + + + 'Load the PowerPoint presentation and convert to image + Dim pptxDoc As IPresentation = Presentation.Open("Sample.pptx") + 'Initializes the 'SubstituteFont' event to set the replacement font + AddHandler pptxDoc.FontSettings.SubstituteFont, AddressOf SubstituteFont + 'Convert the PowerPoint presentation to image. + Dim image As Image = pptxDoc.Slides(0).ConvertToImage(Syncfusion.Drawing.ImageType.Metafile) + 'Dispose the image + image.Dispose() + 'Close the Presentation. + pptxDoc.Close() + ''' + ''' Sets the alternate font when a specified font is unavailable in the production environment + ''' + ''' FontSettings type of the Presentation in which the specified font is used but unavailable in production environment. + ''' Retrieves the unavailable font name and receives the substitute font name for conversion. + Private Sub SubstituteFont(ByVal sender As Object, ByVal args As SubstituteFontEventArgs) + ' Sets the alternate font when a specified font is not installed in the production environment + If args.OriginalFontName = "Arial Unicode MS" Then + args.AlternateFontName = "Arial" + ElseIf args.OriginalFontName = "Calibri Light" Then + args.AlternateFontName = "Calibri" + Else + args.AlternateFontName = "Times New Roman" + End If + End Sub + + + + + + Gets or sets the alternate font name. + + The string that specifies the alternate font name. + + + //Load the PowerPoint presentation and convert to image + IPresentation pptxDoc = Presentation.Open("Sample.pptx"); + // Initializes the 'SubstituteFont' event to set the replacement font + pptxDoc.FontSettings.SubstituteFont += FontSettings_SubstituteFont; + //Converts the first slide into image + Image image = pptxDoc.Slides[0].ConvertToImage(Syncfusion.Drawing.ImageType.Metafile); + //Disposes the image + image.Dispose(); + //Close the presentation. + pptxDoc.Close(); + /// + /// Sets the alternate font when a specified font is unavailable in the production environment + /// + /// FontSettings type of the Presentation in which the specified font is used but unavailable in production environment. + /// Retrieves the unavailable font name and receives the substitute font name for conversion. + private static void FontSettings_SubstituteFont(object sender, SubstituteFontEventArgs args) + { + if (args.OriginalFontName == "Arial Unicode MS") + args.AlternateFontName = "Arial"; + else if (args.OriginalFontName == "Calibri Light") + args.AlternateFontName = "Calibri"; + else + args.AlternateFontName = "TimesNewRoman"; + } + + + 'Load the PowerPoint presentation and convert to image + Dim pptxDoc As IPresentation = Presentation.Open("Sample.pptx") + 'Initializes the 'SubstituteFont' event to set the replacement font + AddHandler pptxDoc.FontSettings.SubstituteFont, AddressOf SubstituteFont + 'Convert the PowerPoint presentation to image. + Dim image As Image = pptxDoc.Slides(0).ConvertToImage(Syncfusion.Drawing.ImageType.Metafile) + 'Dispose the image + image.Dispose() + 'Close the Presentation. + pptxDoc.Close() + ''' + ''' Sets the alternate font when a specified font is unavailable in the production environment + ''' + ''' FontSettings type of the Presentation in which the specified font is used but unavailable in production environment. + ''' Retrieves the unavailable font name and receives the substitute font name for conversion. + Private Sub SubstituteFont(ByVal sender As Object, ByVal args As SubstituteFontEventArgs) + ' Sets the alternate font when a specified font is not installed in the production environment + If args.OriginalFontName = "Arial Unicode MS" Then + args.AlternateFontName = "Arial" + ElseIf args.OriginalFontName = "Calibri Light" Then + args.AlternateFontName = "Calibri" + Else + args.AlternateFontName = "Times New Roman" + End If + End Sub + + + + + + + + Contains types that support Presentation which is used to create and manipulate PowerPoint Presentations. + + + + + + Represents the PowerPoint presentation. + + + + + Stream name that represent summary name. + + + + + Stream name that represent document summary name. + + + + + Creates a new instance. + + Returns the newly created presentation instance. + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Add a new slide of comparison slide layout type. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Comparison); + //Save the presentation. + presentation.Save("Sample.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Add a new slide of comparison slide layout type. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Comparison) + 'Save the presentation. + presentation__1.Save("Sample.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Opens the presentation from the specified file name. + + Specifies the file name of the presentation to open. + Returns a object that represents the opened presentation. + + + //Open a presentation. + Presentation presentation = Presentation.Open("Input.pptx") as Presentation; + //Add a new slide of comparison slide layout type. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Comparison); + //Save the presentation. + presentation.Save("Sample.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Open a presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Open("Input.pptx"), Presentation) + 'Add a new slide of comparison slide layout type. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Comparison) + 'Save the presentation. + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Opens the presentation from the specified stream. + + The stream instance that represents the presentation. + Returns a object that represents the opened presentation. + From v20.4.0.x release, this method will not dispose the given . You should handle the disposal of in your application. + + + //Create instance for memory stream + MemoryStream fileStream = new MemoryStream(); + //Open a presentation + IPresentation presentation = Presentation.Open(fileStream); + presentation.Save("Sample.pptx"); + //Close the presentation. + presentation.Close(); + //Dispose the filestream + fileStream.Dispose(); + + + 'Create instance for memory stream + Dim fileStream As New MemoryStream() + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open(fileStream) + presentation__1.Save("Sample.pptx") + 'Close the presentation. + presentation__1.Close() + 'Dispose the filestream + fileStream.Dispose() + + + + + + Saves the presentation to the specified file name. + + Specifies the file name to save the presentation. + At present, the Essential Presentation library only supports the PPTX file format. + + + //Create an instance of presentation + Presentation presentation = Presentation.Create() as Presentation; + //Add slide to the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add table to the slide + ITable table = slide.Shapes.AddTable(3, 3, 100, 120, 300, 200); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create an instance of presentation + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Add slide to the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add table to the slide + Dim table As ITable = slide.Shapes.AddTable(3, 3, 100, 120, 300, 200) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + At present, the Essential Presentation library only supports the PPTX file format. + + + //Create instance for memory stream + MemoryStream fileStream = new MemoryStream(); + //Create an instance of presentation + Presentation presentation = Presentation.Create() as Presentation; + //Save the presentation using stream + presentation.Save(fileStream); + //Close the presentation. + presentation.Close(); + //Dispose the filestream + fileStream.Dispose(); + + + 'Create instance for memory stream + Dim fileStream As New MemoryStream() + 'Create an instance of presentation + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Save the presentation using stream + presentation__1.Save(fileStream) + 'Close the presentation. + presentation__1.Close() + 'Dispose the filestream + fileStream.Dispose() + + + + + + Creates an independent copy of instance. + /// Returns the cloned presentation instance. + + + //Create an instance for presentation + Presentation presentation = Presentation.Create() as Presentation; + //Add a new slide of comparison slide layout type. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Comparison); + //Clone the entire presentation. + IPresentation presentationClone = presentation.Clone(); + //Add a new slide of title layout type. + slide = presentationClone.Slides.Add(SlideLayoutType.Title); + //Add an auto shape of regular pentagon auto shape type. + slide.Shapes.AddShape(AutoShapeType.RegularPentagon, 10, 20, 300, 400); + //Save the cloned presentation + presentationClone.Save("Sample.pptx"); + //Close the presentation. + presentation.Close(); + //Close the cloned presentation. + presentationClone.Close(); + + + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Add a new slide of comparison slide layout type. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Comparison) + 'Clone the entire presentation. + Dim presentationClone As IPresentation = presentation__1.Clone() + 'Add a new slide of title layout type. + slide = presentationClone.Slides.Add(SlideLayoutType.Title) + 'Add an auto shape of regular pentagon auto shape type. + slide.Shapes.AddShape(AutoShapeType.RegularPentagon, 10, 20, 300, 400) + 'Save the cloned presentation + presentationClone.Save("Sample.pptx") + 'Close the presentation. + presentation__1.Close() + 'Close the cloned presentation. + presentationClone.Close() + + + + + + Saves the presentation to the specified HttpResponse instance. + + + At present, the Essential Presentation library only supports the PPTX file + format. + + The name of the file in HttpResponse. + The format type of the presentation. + The HttpResponse to save the presentation. + + + //Create a presentation + Presentation presentation = Presentation.Create() as Presentation; + //Save the presentation to the specified HttpResponse + presentation.Save("Sample.pptx", FormatType.Pptx, HttpContext.Current.Response); + + + 'Create a presentation + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Save the presentation to the specified HttpResponse + presentation__1.Save("Sample.pptx", FormatType.Pptx, Response) + + + + + + Opens the encrypted presentation from the specified file name and password. + + Path of the presentation file. + Password required to open the presentation file. + Returns a object that represents the opened presentation. + + + //Open the encrypted presentation. + Presentation presentation = Presentation.Open("Input.pptx", "MYPASSWORD!@#$%") as Presentation; + //Save the presentation. + presentation.Save("Sample.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Open the encrypted presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Open("Input.pptx", "MYPASSWORD!@#$%"), Presentation) + 'Save the presentation. + presentation__1.Save("Sample.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Opens the encrypted presentation from the specified stream and password. + + The instance of the presentation. + The password required to open the presentation. + Returns the object that represents the opened presentation. + From v20.4.0.x release, this method will not dispose the given . You should handle the disposal of in your application. + + + //Create instance for memory stream + MemoryStream fileStream = new MemoryStream(); + //Open a presentation + string InputPath = ""; + IPresentation presentation = Presentation.Open(fileStream,InputPath); + presentation.Save("Sample.pptx"); + //Close the presentation. + presentation.Close(); + //Dispose the filestream + fileStream.Dispose(); + + + 'Create instance for memory stream + Dim fileStream As New MemoryStream() + 'Open a presentation + Dim presentation__1 As IPresentation = Presentation.Open(fileStream, Input.pptx) + presentation__1.Save("Sample.pptx") + 'Close the presentation. + presentation__1.Close() + 'Dispose the filestream + fileStream.Dispose() + + + + + + Encrypts the presentation using the specified password. + + Password to encrypt the presentation. + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Add a new slide of content with caption slide layout type. + ISlide slide = presentation.Slides.Add(SlideLayoutType.ContentWithCaption); + //Add a auto shape of moon type auto shape. + IShape shape = slide.Shapes.AddShape(AutoShapeType.Moon, 50, 0, 200, 200); + //Add a paragraph with text content to the shape. + shape.TextBody.AddParagraph("Text for moon shape"); + //Encrypt the presentation with the combination of alpha and symbol string password. + presentation.Encrypt("MYPASSWORD!@#$%"); + //Save the presentation. + presentation.Save("Sample.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Add a new slide of content with caption slide layout type. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.ContentWithCaption) + 'Add a auto shape of moon type auto shape. + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Moon, 50, 0, 200, 200) + 'Add a paragraph with text content to the shape. + shape.TextBody.AddParagraph("Text for moon shape") + 'Encrypt the presentation with the combination of alpha and symbol string password. + presentation__1.Encrypt("MYPASSWORD!@#$%") + 'Save the presentation. + presentation__1.Save("Sample.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Removes the encryption from presentation. + + To remove the encryption we must have opened the presentation with password. + + + //Open the encrypted presentation. + Presentation presentation = Presentation.Open("Input.pptx", "MYPASSWORD!@#$%") as Presentation; + //Remove the encryption. + presentation.RemoveEncryption(); + //Save the presentation. + presentation.Save("Sample.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Open the encrypted presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Open("Input.pptx", "MYPASSWORD!@#$%"), Presentation) + 'Remove the encryption. + presentation__1.RemoveEncryption() + 'Save the presentation. + presentation__1.Save("Sample.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Add a watermark to the presentation file + + The presentation instance + + + + Add a watermark to the slide + + The slide instance + + + + Add a watermark shape to the center of the master slide + + + + + + + + + + Add a watermark shape to the bottom of the first and last slide + + + + + + + + + + Converts the slides in presentation to images using the specified image format. + + Specifies the image format in which you want to convert slides. + Returns the array of the converted images. + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Add a content with caption slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.ContentWithCaption); + //Add a table to the slide. + ITable table = slide.Tables.AddTable(5, 5, 0, 0, 500, 500); + //Set the built in table style. + table.BuiltInStyle = BuiltInTableStyle.DarkStyle2Accent3Accent4; + //Iterate through the row collection. + foreach (IRow row in table.Rows) + { + //Iterate through the cell collection. + foreach (ICell cell in row.Cells) + { + //Add a paragraph to the cell. + cell.TextBody.AddParagraph("New Paragraph"); + } + } + //Converts the each and every slide in the presentation to image of stream array type. + Stream[] imageStreamArray = presentation.RenderAsImages(Syncfusion.Drawing.ImageFormat.Jpeg); + //Iterate the stream array. + foreach (Stream stream in imageStreamArray) + { + //Save the stream in image of .jpg format. + Image.FromStream(stream).Save("RenderAsImage" + Guid.NewGuid() + ".jpg"); + } + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Add a content with caption slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.ContentWithCaption) + 'Add a table to the slide. + Dim table As ITable = slide.Tables.AddTable(5, 5, 0, 0, 500, 500) + 'Set the built in table style. + table.BuiltInStyle = BuiltInTableStyle.DarkStyle2Accent3Accent4 + 'Iterate through the row collection. + For Each row As IRow In table.Rows + 'Iterate through the cell collection. + For Each cell As ICell In row.Cells + 'Add a paragraph to the cell. + cell.TextBody.AddParagraph("New Paragraph") + Next + Next + 'Converts the each and every slide in the presentation to image of stream array type. + Dim imageStreamArray As Stream() = presentation__1.RenderAsImages(Syncfusion.Drawing.ImageFormat.Jpeg) + 'Iterate the stream array. + For Each stream As Stream In imageStreamArray + 'Save the stream in image of .jpg format. + Image.FromStream(stream).Save("RenderAsImage" + Guid.NewGuid() + ".jpg") + Next + 'Close the presentation. + presentation__1.Close() + + + + + + Converts the slides in presentation to images using the specified image type. + + Specifies the image type in which you want to convert slides. + Returns the array of the converted images. + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Add a content with caption slide to the presentation. + ISlide slide = presentation.Slides.Add(SlideLayoutType.ContentWithCaption); + //Add a table to the slide. + ITable table = slide.Tables.AddTable(5, 5, 0, 0, 500, 500); + //Set the built in table style. + table.BuiltInStyle = BuiltInTableStyle.DarkStyle2Accent3Accent4; + //Iterate through the row collection. + foreach (IRow row in table.Rows) + { + //Iterate through the cell collection. + foreach (ICell cell in row.Cells) + { + //Add a paragraph to the cell. + cell.TextBody.AddParagraph("New Paragraph"); + } + } + //Converts the each and every slide in the presentation to image of System.Drawing.Image type array. + Image[] imageArray = presentation.RenderAsImages(Syncfusion.Drawing.ImageType.Metafile); + //Iterate the image array. + foreach (Image image in imageArray) + { + //Save the image of .bmp format. + image.Save("RenderAsImage" + Guid.NewGuid() + ".bmp"); + } + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Add a content with caption slide to the presentation. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.ContentWithCaption) + 'Add a table to the slide. + Dim table As ITable = slide.Tables.AddTable(5, 5, 0, 0, 500, 500) + 'Set the built in table style. + table.BuiltInStyle = BuiltInTableStyle.DarkStyle2Accent3Accent4 + 'Iterate through the row collection. + For Each row As IRow In table.Rows + 'Iterate through the cell collection. + For Each cell As ICell In row.Cells + 'Add a paragraph to the cell. + cell.TextBody.AddParagraph("New Paragraph") + Next + Next + 'Converts the each and every slide in the presentation to image of System.Drawing.Image type array. + Dim imageArray As Image() = presentation__1.RenderAsImages(Syncfusion.Drawing.ImageType.Metafile) + 'Iterate the image array. + For Each image As Image In imageArray + 'Save the image of .bmp format. + image.Save("RenderAsImage" + Guid.NewGuid() + ".bmp") + Next + 'Close the presentation. + presentation__1.Close() + + + + + + Prepares response before saving. + + + + + + + Adds the preserved elements into new presentation. + + + + + + Releases any resources associated with the presentation instance. + + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Add a new slide of comparison slide layout type. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Comparison); + //Save the presentation. + presentation.Save("Sample.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Add a new slide of comparison slide layout type. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Comparison) + 'Save the presentation. + presentation__1.Save("Sample.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Releases all resources used by the instance. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Add a new slide of comparison slide layout type. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Comparison); + //Save the presentation. + presentation.Save("Sample.pptx"); + //Dispose the presentation. + presentation.Dispose(); + + + 'Create a new presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add a new slide of comparison slide layout type. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Comparison) + 'Save the presentation. + presentation__1.Save("Sample.pptx") + 'Dispose the presentation. + presentation__1.Dispose() + + + + + + Determines whether the data in the stream are encrypted or not. + + Stream in which the presentation content are stored. + Returns whether the stream is encrypted or not. + + + + Removes the macros from the presentation instance. + + + + //Opens an existing macro enabled PowerPoint presentation + IPresentation pptxDoc = Presentation.Open("Sample.PPTM"); + //Checks whether the presentation has macros and then removes them + if (pptxDoc.HasMacros) + pptxDoc.RemoveMacros(); + //Saves the presentation + pptxDoc.Save("Output.pptx"); + //Closes the presentation + pptxDoc.Close(); + + + 'Opens an existing macro enabled PowerPoint presentation + Dim pptxDoc As IPresentation = Presentation.Open("Sample.PPTM") + 'Checks whether the presentation has macros and then removes them + If pptxDoc.HasMacros Then + pptxDoc.RemoveMacros() + End If + 'Saves the presentation + pptxDoc.Save("Output.pptx") + 'Closes the presentation + pptxDoc.Close() + + + + + + Sets the write protection for the presentation instance + + Password to enforce protection. + Maximum length of password should be 15. If it exceeds 15, first 15 characters will be considered for protection, remaining will be ignored. + + + //Create an instance for presentation + IPresentation presentation = Presentation.Create(); + //Add a new slide of comparison slide layout type. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Comparison); + //Add an auto shape of regular pentagon auto shape type. + slide.Shapes.AddShape(AutoShapeType.RegularPentagon, 10, 20, 300, 400); + //Set the write protection for Presentation instance with password. + presentation.SetWriteProtection("MYPASSWORD"); + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create an instance for presentation + Dim presentation As IPresentation = Presentation.Create() + 'Add a new slide of comparison slide layout type. + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Comparison) + 'Add an auto shape of regular pentagon auto shape type. + slide.Shapes.AddShape(AutoShapeType.RegularPentagon, 10, 20, 300, 400) + 'Set the write protection for Presentation instance with password. + presentation.SetWriteProtection("MYPASSWORD") + 'Save the presentation + presentation.Save("Sample.pptx") + 'Close the presentation. + presentation.Close() + + + + + + Removes the write Protection from presentation instance + + + + //Create an instance for presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Check whether the presentation is write protected. + if (presentation.IsWriteProtected) + { + //Removes the write protection from presentation instance + presentation.RemoveWriteProtection(); + } + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create an instance for presentation + Dim presentation As IPresentation = Presentation.Open("Sample.pptx") + 'Check whether the presentation is write protected. + if (presentation.IsWriteProtected) + { + 'Removes the write protection from presentation instance + presentation.RemoveWriteProtection() + } + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation. + presentation.Close() + + + + + + Finds all the given text from the presentation document + + + + + The collection that contains all the entries of the found text in the document. + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with a text + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Hello World"); + // Finds all the text from the Presentation document + ITextSelection[] textSelections = presentation.FindAll("World", false, false); + foreach (ITextSelection textSelection in textSelections) + { + //Gets the found text as single text part + ITextPart textPart = textSelection.GetAsOneTextPart(); + //Replace the text + textPart.Text = "Replaced text"; + } + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Creates a presentation. + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + 'Add a new paragraph with a text + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Hello World") + 'Finds the text from the Presentation document + Dim textSelections As ITextSelection() = pptxDoc.FindAll("World", False, False) + 'Gets the found text as single text part and replace it + For Each textSelection As ITextSelection In textSelections + Dim textPart As ITextPart = textSelection.GetAsOneTextPart() + textPart.Text = "Replaced text" + Next + pptxDoc.Save("Output.pptx") + 'Close the presentation. + pptxDoc.Close() + + + + + + Finds all the given text from the presentation document using Regex Pattern + + + The collection that contains all the entries of the found text in the document. + + + //Opens an existing presentation. + IPresentation pptxDoc = Presentation.Open("Input.pptx"); + // Create a regex pattern to find a text that starts with 'H' and ends with 'o'. + Regex regex = new Regex("H.+?o"); + //Finds all the occurrences of a specified regular expression. + ITextSelection[] textSelections = pptxDoc.FindAll(regex); + foreach (ITextSelection textSelection in textSelections) + { + //Gets the found text as single text part + ITextPart textPart = textSelection.GetAsOneTextPart(); + //Replace the text + textPart.Text = "Replaced text"; + } + //Saves the Presentation + pptxDoc.Save("Output.pptx"); + // Close the presentation. + pptxDoc.Close(); + + + 'Opens an existing presentation. + Dim pptxDoc As IPresentation = Presentation.Open("Input.pptx") + ' Create a regex pattern to find a text that starts with 'H' and ends with 'o'. + Dim regex As Regex = New Regex("H.+?o") + 'Finds all the occurrences of a specified regular expression. + Dim textSelections As ITextSelection() = pptxDoc.FindAll(regex) + For Each textSelection As ITextSelection In textSelections + 'Gets the found text as single text part + Dim textPart As ITextPart = textSelection.GetAsOneTextPart() + 'Replace the text + textPart.Text = "Replaced text" + Next + 'Saves the Presentation + pptxDoc.Save("Output.pptx") + 'Close the presentation. + pptxDoc.Close() + + + + + + Finds the first occurance of the given word from the presentation + + + + + The that contains the found text in the document. + + + //Create a new presentation instance. + IPresentation presentation = Presentation.Create(); + //Add the slide into the presentation + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + // Add a text box to hold the list + IShape textBoxShape = slide.AddTextBox(65, 140, 410, 270); + // Add a new paragraph with a text + IParagraph paragraph = textBoxShape.TextBody.AddParagraph("Hello World"); + // Finds the text from the Presentation document + ITextSelection textSelection = presentation.Find("World", false, false); + // Gets the found text containing text parts + foreach (ITextPart textPart in textSelection.GetTextParts()) + { + //Sets Bold property + textPart.Font.Bold = true; + } + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Creates a presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Add the slide into the presentation + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a text box to hold the list + Dim textBoxShape As IShape = slide.AddTextBox(65, 140, 410, 270) + 'Add a new paragraph with a text + Dim paragraph As IParagraph = textBoxShape.TextBody.AddParagraph("Hello World") + 'Finds the text from the Presentation document + Dim textSelection As ITextSelection = presentation__1.Find("World", False, False) + 'Gets the text parts from the selection + For Each textPart As ITextPart In textSelection.GetTextParts() + textPart.Font.Bold = True + Next + presentation__1.Save("Output.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Finds the first occurance of the given word from the presentation using Regex Pattern + + + The that contains the found text in the document. + + + //Opens an existing presentation. + IPresentation pptxDoc = Presentation.Open("Input.pptx"); + // Create a regex pattern to find a text that starts with 'H' and ends with 'o'. + Regex regex = new Regex("H.+?o"); + //Find the first occurrence of a specified regular expression. + ITextSelection textSelection = pptxDoc.Find(regex); + //Gets the found text as single text part + ITextPart textPart = textSelection.GetAsOneTextPart(); + //Replace the text + textPart.Text = "Replaced text"; + //Saves the Presentation + pptxDoc.Save("Output.pptx"); + //Close the presentation + pptxDoc.Close(); + + + 'Opens an existing presentation. + Dim pptxDoc As IPresentation = Presentation.Open("Input.pptx") + 'Create a regex pattern to find a text that starts with 'H' and ends with 'o'. + Dim regex As Regex = New Regex("H.+?o") + 'Find the first occurrence of a specified regular expression. + Dim textSelection As ITextSelection = pptxDoc.Find(regex) + 'Gets the found text as single text part + Dim textPart As ITextPart = textSelection.GetAsOneTextPart() + 'Replace the text + textPart.Text = "Replaced text" + 'Saves the Presentation + pptxDoc.Save("Output.pptx") + 'Close the presentation. + pptxDoc.Close() + + + + + + Returns a collection of instances. Read-only. + + + + //Creates a PowerPoint presentation + IPresentation presentation = Presentation.Create(); + //Adds a section to the PowerPoint presentation + ISection section = presentation.Sections.Add(); + //Sets a name to the created section + section.Name = "SectionDemo"; + //Adds a slide to the created section + ISlide slide = section.AddSlide(SlideLayoutType.Blank); + //Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo"); + //Saves the PowerPoint presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Creates a PowerPoint presentation + Dim presentation__1 As IPresentation = Presentation.Create() + 'Adds a section to the PowerPoint presentation + Dim section As ISection = presentation__1.Sections.Add() + 'Sets a name to the created section + section.Name = "SectionDemo" + 'Adds a slide to the created section + Dim slide As ISlide = section.AddSlide(SlideLayoutType.Blank) + 'Adds a text box to the slide + slide.AddTextBox(10, 10, 100, 100).TextBody.AddParagraph("Slide in SectionDemo") + 'Saves the PowerPoint presentation + presentation__1.Save("Sample.pptx") + 'Close the Presentation instance + presentation__1.Close() + + + + + + Gets the font settings. Read Only. + + The font settings in the PowerPoint document. + + + //Load the PowerPoint presentation and convert to image + IPresentation pptxDoc = Presentation.Open("Sample.pptx"); + // Initializes the 'SubstituteFont' event to set the replacement font + pptxDoc.FontSettings.InitializeFallbackFonts(); + //Converts the first slide into image + Image image = pptxDoc.Slides[0].ConvertToImage(Syncfusion.Drawing.ImageType.Metafile); + //Close the presentation. + pptxDoc.Close(); + + + 'Load the PowerPoint presentation and convert to image + Dim pptxDoc As IPresentation = Presentation.Open("Sample.pptx") + 'Use a sets of default FallbackFont collection to IPresentation. + pptxDoc.FontSettings.FallbackFonts.InitializeDefault() + 'Convert the PowerPoint presentation to image. + Dim image As Image = pptxDoc.Slides(0).ConvertToImage(Syncfusion.Drawing.ImageType.Metafile) + 'Close the Presentation instance + pptxDoc.Close() + + + + + + Gets the collection of the instance. Read-only. + + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Retrieve the collection of layout Slide + IMasterSlides masterslides = presentation.Masters; + //Get a master by specifying the index in collection + IMasterSlide masterSlide = presentation.Masters[0]; + //Add a group shape to master slide + masterSlide.GroupShapes.AddGroupShape(200,234,198,173); + //Add an autoshape - bevel to master slide + masterSlide.Shapes.AddShape(AutoShapeType.Bevel,237,45,187,120); + //Add master slide to the collection + masterslides.Add(masterSlide); + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Retrieve the collection of layout Slide + Dim masterslides As IMasterSlides = presentation__1.Masters + 'Get a master by specifying the index in collection + Dim masterSlide As IMasterSlide = presentation__1.Masters(0) + 'Add a group shape to master slide + masterSlide.GroupShapes.AddGroupShape(200, 234, 198, 173) + 'Add an autoshape - bevel to master slide + masterSlide.Shapes.AddShape(AutoShapeType.Bevel, 237, 45, 187, 120) + 'Add master slide to the collection + masterslides.Add(masterSlide) + 'Save the presentation + presentation__1.Save("Output.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets the slide collection of instance. Read-only. + + + + //Create a new presentation. + IPresentation presentation = Presentation.Create(); + //Create instance to hold the slide collection + ISlides slides = presentation.Slides; + //Add slide to presentation + slides.Add(); + //Add a blank slide to the presentation. + slides.Add(SlideLayoutType.Blank); + //Add slide to the collection by passing the slide instance + slides.Add(slides.Add(SlideLayoutType.Title)); + //Retrieve the specific slide item, read only + ISlide _slide = slides[0]; + //Set the slide name + _slide.Name = "My Slide"; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a new presentation. + IPresentation presentation = Presentation.Create(); + 'Create instance to hold the slide collection + ISlides slides = presentation.Slides; + 'Add slide to presentation + slides.Add(); + 'Add a blank slide to the presentation. + slides.Add(SlideLayoutType.Blank); + 'Add slide to the collection by passing the slide instance + slides.Add(slides.Add(SlideLayoutType.Title)); + 'Retrieve the specific slide item, read only + ISlide _slide = slides[0]; + 'Set the slide name + slide.Name = "My Slide"; + 'Save the presentation + presentation.Save("Sample.pptx"); + 'Close the presentation + presentation.Close(); + + + + + + Gets or sets a value indicating whether the instance is marked as final. + + + + //Create an instance for PowerPoint presentation + IPresentation pptxDoc = Presentation.Create(); + //Add slide to the presentation + ISlide slide = pptxDoc.Slides.Add(SlideLayoutType.Blank); + //Mark the presentation as final + pptxDoc.Final = true; + //Save the presentation + pptxDoc.Save("Sample.pptx"); + //Close the presentation + pptxDoc.Close(); + + + 'Create an instance for PowerPoint presentation + Dim pptxDoc As IPresentation = Presentation.Create() + 'Add slide to the presentation + Dim slide As ISlide = pptxDoc.Slides.Add(SlideLayoutType.Blank) + 'Mark the presentation as final + pptxDoc.Final = True + 'Save the presentation + pptxDoc.Save("Sample.pptx") + 'Close the presentation + pptxDoc.Close() + + + + + + Gets an instance. + + + Initialize the ChartToImageConverter in-order to convert a chart in presentation to image. + + + + //Create a new presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Initialize the chart to image converter. + presentation.ChartToImageConverter = new ChartToImageConverter(); + //Set the scaling mode for the chart. + presentation.ChartToImageConverter.ScalingMode = ScalingMode.Best; + //Add a blank slide for the chart. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Add a chart to the slide. + IPresentationChart officeChart = slide.Charts.AddChart(100, 100, 600, 400); + //Set chart data + officeChart.ChartData.SetValue(1, 4, "Month"); + officeChart.ChartData.SetValue(2, 4, "July"); + officeChart.ChartData.SetValue(3, 4, "August"); + officeChart.ChartData.SetValue(4, 4, "September"); + officeChart.ChartData.SetValue(5, 4, "October"); + officeChart.ChartData.SetValue(6, 4, "November"); + officeChart.ChartData.SetValue(7, 4, "December"); + officeChart.ChartData.SetValue(1, 1, "2013"); + officeChart.ChartData.SetValue(2, 1, 35); + officeChart.ChartData.SetValue(3, 1, 37); + officeChart.ChartData.SetValue(4, 1, 30); + officeChart.ChartData.SetValue(5, 1, 29); + officeChart.ChartData.SetValue(6, 1, 25); + officeChart.ChartData.SetValue(7, 1, 30); + officeChart.ChartData.SetValue(1, 2, "2014"); + officeChart.ChartData.SetValue(2, 2, 30); + officeChart.ChartData.SetValue(3, 2, 25); + officeChart.ChartData.SetValue(4, 2, 29); + officeChart.ChartData.SetValue(5, 2, 35); + officeChart.ChartData.SetValue(6, 2, 38); + officeChart.ChartData.SetValue(7, 2, 32); + officeChart.ChartData.SetValue(1, 3, "2015"); + officeChart.ChartData.SetValue(2, 3, 35); + officeChart.ChartData.SetValue(3, 3, 37); + officeChart.ChartData.SetValue(4, 3, 30); + officeChart.ChartData.SetValue(5, 3, 50); + officeChart.ChartData.SetValue(6, 3, 25); + officeChart.ChartData.SetValue(7, 3, 30); + //Add chart serie. + IOfficeChartSerie serie1 = officeChart.Series.Add("2013"); + //Set serie value. + serie1.Values = officeChart.ChartData[2, 1, 7, 1]; + //Add chart serie. + IOfficeChartSerie serie2 = officeChart.Series.Add("2014"); + //Set serie value. + serie2.Values = officeChart.ChartData[2, 2, 7, 2]; + //Add chart serie. + IOfficeChartSerie serie3 = officeChart.Series.Add("2015"); + //Set serie value. + serie3.Values = officeChart.ChartData[2, 3, 7, 3]; + //Set category labels value for the primary category axis. + officeChart.PrimaryCategoryAxis.CategoryLabels = officeChart.ChartData[2, 4, 7, 4]; + //Set the chart type. + officeChart.ChartType = OfficeChartType.Column_Clustered; + //Set the chart title. + officeChart.ChartTitle = "Mine Chart"; + //Convert the chart to image. + Image[] chartImages = presentation.RenderAsImages(Syncfusion.Drawing.ImageType.Metafile); + foreach (Image image in chartImages) + { + //Save the image. + image.Save("ChartToImageConverter" + Guid.NewGuid() + ".png"); + } + //Save the presentation. + presentation.Save("ChartToImageConverter.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create a new presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Initialize the chart to image converter. + presentation__1.ChartToImageConverter = New ChartToImageConverter() + 'Set the scaling mode for the chart. + presentation__1.ChartToImageConverter.ScalingMode = ScalingMode.Best + 'Add a blank slide for the chart. + Dim slide As ISlide = presentation__1.Slides.Add(SlideLayoutType.Blank) + 'Add a chart to the slide. + Dim officeChart As IPresentationChart = slide.Charts.AddChart(100, 100, 600, 400) + 'Set chart data + officeChart.ChartData.SetValue(1, 4, "Month") + officeChart.ChartData.SetValue(2, 4, "July") + officeChart.ChartData.SetValue(3, 4, "August") + officeChart.ChartData.SetValue(4, 4, "September") + officeChart.ChartData.SetValue(5, 4, "October") + officeChart.ChartData.SetValue(6, 4, "November") + officeChart.ChartData.SetValue(7, 4, "December") + officeChart.ChartData.SetValue(1, 1, "2013") + officeChart.ChartData.SetValue(2, 1, 35) + officeChart.ChartData.SetValue(3, 1, 37) + officeChart.ChartData.SetValue(4, 1, 30) + officeChart.ChartData.SetValue(5, 1, 29) + officeChart.ChartData.SetValue(6, 1, 25) + officeChart.ChartData.SetValue(7, 1, 30) + officeChart.ChartData.SetValue(1, 2, "2014") + officeChart.ChartData.SetValue(2, 2, 30) + officeChart.ChartData.SetValue(3, 2, 25) + officeChart.ChartData.SetValue(4, 2, 29) + officeChart.ChartData.SetValue(5, 2, 35) + officeChart.ChartData.SetValue(6, 2, 38) + officeChart.ChartData.SetValue(7, 2, 32) + officeChart.ChartData.SetValue(1, 3, "2015") + officeChart.ChartData.SetValue(2, 3, 35) + officeChart.ChartData.SetValue(3, 3, 37) + officeChart.ChartData.SetValue(4, 3, 30) + officeChart.ChartData.SetValue(5, 3, 50) + officeChart.ChartData.SetValue(6, 3, 25) + officeChart.ChartData.SetValue(7, 3, 30) + 'Add chart serie. + Dim serie1 As IOfficeChartSerie = officeChart.Series.Add("2013") + 'Set serie value. + serie1.Values = officeChart.ChartData(2, 1, 7, 1) + 'Add chart serie. + Dim serie2 As IOfficeChartSerie = officeChart.Series.Add("2014") + 'Set serie value. + serie2.Values = officeChart.ChartData(2, 2, 7, 2) + 'Add chart serie. + Dim serie3 As IOfficeChartSerie = officeChart.Series.Add("2015") + 'Set serie value. + serie3.Values = officeChart.ChartData(2, 3, 7, 3) + 'Set category labels value for the primary category axis. + officeChart.PrimaryCategoryAxis.CategoryLabels = officeChart.ChartData(2, 4, 7, 4) + 'Set the chart type. + officeChart.ChartType = OfficeChartType.Column_Clustered + 'Set the chart title. + officeChart.ChartTitle = "Mine Chart" + 'Convert the chart to image. + Dim chartImages As Image() = presentation__1.RenderAsImages(Syncfusion.Drawing.ImageType.Metafile) + For Each image As Image In chartImages + 'Save the image. + image.Save("ChartToImageConverter" + Guid.NewGuid() + ".png") + Next + 'Save the presentation. + presentation__1.Save("ChartToImageConverter.pptx") + 'Close the presentation. + presentation__1.Close() + + + + + + Represents the Show Header and Footer Placeholders on Title slide + + + + + Gets an instance. Read-only. + + + + //Create a presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Retrieve the built-in document property, it is read only + IBuiltInDocumentProperties builtin = presentation.BuiltInDocumentProperties; + //Set the application name + builtin.ApplicationName = "Essential Presentation"; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Retrieve the built-in document property, it is read only + Dim builtin As IBuiltInDocumentProperties = presentation__1.BuiltInDocumentProperties + 'Set the application name + builtin.ApplicationName = "Essential Presentation" + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets an instance. Read-only. + + + + //Create a presentation. + IPresentation presentation = Presentation.Create(); + //Retrieve the custom document property, it is read only + ICustomDocumentProperties custom = presentation.CustomDocumentProperties; + //Add custom document property + custom.Add("PropertyA"); + //Set the boolean property + custom["PropertyA"].Boolean = true; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation. + Dim presentation__1 As IPresentation = Presentation.Create() + 'Retrieve the custom document property, it is read only + Dim [custom] As ICustomDocumentProperties = presentation__1.CustomDocumentProperties + 'Add custom document property + [custom].Add("PropertyA") + 'Set the boolean property + [custom]("PropertyA").[Boolean] = True + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the first slide number of the PowerPoint Presentation. The default value is 1. + + + First slide number is the starting slide number of presentation, and this API allows to set the first slide number from 0 to 9999. + + + + //Creates a new PowerPint Presentation. + using (IPresentation presentation = Presentation.Create()) + { + //Sets the first slide number of the PowerPoint Presentation. + presentation.FirstSlideNumber = 5; + //Adds slide to the PowerPoint. + ISlide slide1 = presentation.Slides.Add(SlideLayoutType.TitleAndContent); + //Adds slide to the PowerPoint. + ISlide slide2 = presentation.Slides.Add(SlideLayoutType.TitleAndContent); + //Adds slide to the PowerPoint. + ISlide slide3 = presentation.Slides.Add(SlideLayoutType.TitleAndContent); + //Gets the first slide slidenumber. + int firstSlideNumber = slide1.SlideNumber; + //Gets the second slide slidenumber. + int secondSlideNumber = slide2.SlideNumber; + //Saves the PowerPoint Presentation. + presentation.Save("Output.pptx"); + } + + + 'Creates a PowerPoint instance + Using pptxDoc As IPresentation = Presentation.Create() + 'Sets the first slide number of the PowerPoint Presentation. + pptxDoc.FirstSlideNumber = 5 + 'Adds a slide to the PowerPoint presentation + Dim slide1 As ISlide = pptxDoc.Slides.Add(SlideLayoutType.TitleAndContent) + 'Adds a slide to the PowerPoint presentation + Dim slide2 As ISlide = pptxDoc.Slides.Add(SlideLayoutType.TitleAndContent) + 'Adds a slide to the PowerPoint presentation + Dim slide3 As ISlide = pptxDoc.Slides.Add(SlideLayoutType.TitleAndContent) + 'Gets the first slide slidenumber. + Dim firstSlideNumber As Integer = slide1.SlideNumber + 'Gets the second slide slidenumber. + Dim secondSlideNumber As Integer = slide2.SlideNumber + 'Saves the Presentation to the file system. + pptxDoc.Save("Output.pptx") + End Using + + + + + + Gets the notes size of instance. Read-only. + + + + + Gets or sets the slide names and its ISlide instance from input file. + + + + + Gets the slide size of instance. Read-only. + + + + //Create a presentation. + Presentation presentation = Presentation.Create() as Presentation; + //Add a blank slide for the chart. + ISlide slide = presentation.Slides.Add(SlideLayoutType.Blank); + //Retrieve the slides size, read only + ISlideSize slidesize = presentation.SlideSize; + //Set the slide orientation of presentation + slidesize.SlideOrientation = SlideOrientation.Landscape; + //Save the presentation + presentation.Save("Sample.pptx"); + //Close the presentation + presentation.Close(); + + + 'Create a presentation. + Dim presentation__1 As Presentation = TryCast(Presentation.Create(), Presentation) + 'Add a blank slide for the chart. + Dim slide As ISlide = presentation.Slides.Add(SlideLayoutType.Blank) + 'Retrieve the slides size, read only + Dim slidesize As ISlideSize = presentation__1.SlideSize + 'Set the slide orientation of presentation + slidesize.SlideOrientation = SlideOrientation.Landscape + 'Save the presentation + presentation__1.Save("Sample.pptx") + 'Close the presentation + presentation__1.Close() + + + + + + Gets or sets the theme override count. + + + + + Gets or sets the VML drawing count. + + + + + Represents a RendererBase object. + + Used to perform a MeasureString process. + + + + Gets or sets the password for the current presentation. + + + + + Get or Sets the ExcelCount in the presentation + + + + + Gets or sets whether the presentation has macros. + + + + //Opens an existing macro enabled PowerPoint presentation + IPresentation pptxDoc = Presentation.Open("Sample.PPTM"); + //Checks whether the presentation has macros and then removes them + if (pptxDoc.HasMacros) + pptxDoc.RemoveMacros(); + //Saves the presentation + pptxDoc.Save("Output.pptx"); + //Closes the presentation + pptxDoc.Close(); + + + 'Opens an existing macro enabled PowerPoint presentation + Dim pptxDoc As IPresentation = Presentation.Open("Sample.PPTM") + 'Checks whether the presentation has macros and then removes them + If pptxDoc.HasMacros Then + pptxDoc.RemoveMacros() + End If + 'Saves the presentation + pptxDoc.Save("Output.pptx") + 'Closes the presentation + pptxDoc.Close() + + + + + + Gets whether the presentation is write Protected. Read-only. + + + + //Create an instance for presentation + IPresentation presentation = Presentation.Open("Sample.pptx"); + //Check whether the presentation is write protected. + if (presentation.IsWriteProtected) + { + //Removes the write protection from presentation instance + presentation.RemoveWriteProtection(); + } + //Save the presentation + presentation.Save("Output.pptx"); + //Close the presentation. + presentation.Close(); + + + 'Create an instance for presentation + Dim presentation As IPresentation = Presentation.Open("Sample.pptx") + 'Check whether the presentation is write protected. + if (presentation.IsWriteProtected) + { + 'Removes the write protection from presentation instance + presentation.RemoveWriteProtection() + } + 'Save the presentation + presentation.Save("Output.pptx") + 'Close the presentation. + presentation.Close() + + + + + + Specifies the iterations count (spin count) to run hashing algorithm. + + + + + Specifies the dictionary used to hold the attributes and values for modifyVerifier/writeProtection element. + Key - Attribute name and Value - Attribute values. + + + + + Generates necessary attributes and its values of write protection element for setting the write protection. + + + + + + Removes all the attributes and its values of write protection element. + + + + + Creates the salt. + + The length. + + + + + Computes the hash. + + The salt. + The encrypted password. + + + + + Combines the byte arrays. + + The array1. + The array2. + + + + + Specifies the dictionary used to hold the attributes and values for modifyVerifier/writeProtection element. + Key - Attribute name and Value - Attribute values. + + + + + Gets a Boolean value represents whether the dictionary has any attributes and values for modifyVerifier/writeProtection element. + + + + + Gets the remove image element dictionary. + + + + + + Retrieves the content type based on the specified relation ID. + + The ID of the relation used to look up the content type. + + The content type associated with the given relation ID if found; otherwise, null. + + + + + Draw notes placeholder shape. + + Represents the shape to be draw. + + + + Check whether the picture is cropped with predefined shape path. + + Specify the picture to check + Return true, if picture is cropped with shape; otherwise return false. + + + + Apply duotone to the give image. + + In where the duotone need to apply. + duotone color informations. + Duotone applied image. + + + + Apply color Transformation to the given color. + + Color Transformation information. + color in where the transformation occur. + Transformation applied color. + + + + Executes Linear interpolation for Duotone. + + In where the factor is applied. + In where the factor is applied. + Factor value. + Final factorized color. + + + + Draws the paragraph collection. + + The collection of paragraphs to draw. + + + + Draws the paragraphs of notes slide shapes. + + The collection of paragraphs to draw. + + + + Draws the string using character spacing by splitting the string into character. + + Represents the paragraph object. + Represents the System.Drawing.Font. + Represents the solid brush to draw the text. + Represents the bounds of the text. + Represents the text content. + Represents the font instance. + + + + Gets or sets a value, which indicates whether the converted PDF document is tagged or not. + + + + + Draws a solid Rectangle in the image with the given Rectangle object that acts as a Highlight Color for that textpart + + Highlight color of the textpart + Rectangle object that has to be filled with the highlight color + + + + Draws the notes slide content. + + The notes slide to draw. + An array of streams containing the rendered content of notes slide. + + + + Radial Gradient Fill implementation. + + Path + + + + + + Specifies whether azure compatible with Metafile creation + + + + + Determine to check whether Azure compatible with EMF creation + + + + + + Creates the image. + + + + + + Change the Syncfusion.Drawing.ImageFormat to System.Drawing.Imaging.ImageFormat. + + Represent the image format to change. + Returns the System.Drawing.Imaging.ImageFormat. + + + + Specifies whether azure compatible with Metafile creation + + + + + Represents the conversion of PowerPoint slide to series of images based on animation order. + + + + + + //Open a PowerPoint Presentation. + IPresentation pptxDoc = Presentation.Open("Input.pptx"); + //Initialize the PresentationAnimationConverter to perform slide to image conversion based on animation order. + PresentationAnimationConverter animationConverter = new PresentationAnimationConverter(); + int i = 0; + foreach (ISlide slide in pptxDoc.Slides) + { + //Convert the PowerPoint slide to a series of images based on entrance animation effects. + Stream[] imageStreams = animationConverter.Convert(slide, Syncfusion.Drawing.ImageFormat.Png); + //Save the image stream. + foreach (Stream stream in imageStreams) + { + //Dispose the stream. + stream.Dispose(); + } + } + //Close the Presentation + pptxDoc.Close(); + //Dispose the instance. + animationConverter.Dispose(); + + + 'Open a PowerPoint Presentation. + Dim pptxDoc As IPresentation = Presentation.Open("Input.pptx") + 'Initialize the PresentationAnimationConverter to perform slide to image conversion based on animation order. + Dim animationConverter As PresentationAnimationConverter = New PresentationAnimationConverter() + Dim i As Integer = 0 + For Each slide As ISlide In pptxDoc.Slides + 'Convert the PowerPoint slide to a series of images based on entrance animation effects. + Dim imageStreams As Stream() = animationConverter.Convert(slide, Syncfusion.Drawing.ImageFormat.Png) + 'Save the image stream. + For Each stream As Stream In imageStreams + 'Dispose the stream. + stream.Dispose() + Next + Next + 'Close the Presentation + pptxDoc.Close() + 'Dispose the instance. + animationConverter.Dispose() + + + + + + Releases all resources used by the object. + + + + //Open a PowerPoint Presentation. + IPresentation pptxDoc = Presentation.Open("Input.pptx"); + //Initialize the PresentationAnimationConverter to perform slide to image conversion based on animation order. + PresentationAnimationConverter animationConverter = new PresentationAnimationConverter(); + int i = 0; + foreach (ISlide slide in pptxDoc.Slides) + { + //Convert the PowerPoint slide to a series of images based on entrance animation effects. + Stream[] imageStreams = animationConverter.Convert(slide, Syncfusion.Drawing.ImageFormat.Png); + //Save the image stream. + foreach (Stream stream in imageStreams) + { + //Dispose the stream. + stream.Dispose(); + } + } + //Close the Presentation + pptxDoc.Close(); + //Dispose the instance. + animationConverter.Dispose(); + + + 'Open a PowerPoint Presentation. + Dim pptxDoc As IPresentation = Presentation.Open("Input.pptx") + 'Initialize the PresentationAnimationConverter to perform slide to image conversion based on animation order. + Dim animationConverter As PresentationAnimationConverter = New PresentationAnimationConverter() + Dim i As Integer = 0 + For Each slide As ISlide In pptxDoc.Slides + 'Convert the PowerPoint slide to a series of images based on entrance animation effects. + Dim imageStreams As Stream() = animationConverter.Convert(slide, Syncfusion.Drawing.ImageFormat.Png) + 'Save the image stream. + For Each stream As Stream In imageStreams + 'Dispose the stream. + stream.Dispose() + Next + Next + 'Close the Presentation + pptxDoc.Close() + 'Dispose the instance. + animationConverter.Dispose() + + + + + + Gets the animated object list of the given slide. + + Represent the slide. + Represents the animated object collection. + Represents the trigger type of each animation effects. + Returns the animated object list of the given slide. + + + + + + + + + + + + + + + + + + + + + + + + + + Get Curved Connector path + + + formulaColl.Add("x2","*/ w adj1 100000"); + formulaColl.Add("x1","+/ l x2 2"); + formulaColl.Add("x3","+/ r x2 2"); + formulaColl.Add("y3","*/ h 3 4"); + + + + + + + + Get Bent Connector path + + + formulaColl.Add("x1","*/ w adj1 100000"); + > + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get Triangle path + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the right arrow path. + + + + + + Gets the left arrow path. + + + + + + Gets down arrow path. + + + + + + Gets the left right arrow path. + + + + + + Gets the curved right arrow path. + + + + + + Gets the curved left arrow path. + + + + + + Gets the curved up arrow path. + + + + + + Gets the curved down arrow path. + + + + + + Gets up down arrow path. + + + + + + Gets the quad arrow path. + + + + + + Gets the left right up arrow path. + + + + + + Gets the bent arrow path. + + + + + + Gets the U trun arrow path. + + + + + + Gets the left up arrow path. + + + + + + Gets the bent up arrow path. + + + + + + Gets the striped right arrow path. + + + + + + Gets the notched right arrow path. + + + + + + Gets the pentagon path. + + + + + + Gets the chevron path. + + + + + + Gets the right arrow callout path. + + + + + + Gets down arrow callout path. + + + + + + Gets the left arrow callout path. + + + + + + Gets up arrow callout path. + + + + + + Gets the left right arrow callout path. + + + + + + Gets the quad arrow callout path. + + + + + + Gets the circular arrow path. + + + + + + Gets the math plus path. + + + + + + Gets the math minus path. + + + + + + Gets the math multiply path. + + + + + + Gets the math division path. + + + + + + Gets the math equal path. + + + + + + Gets the math not equal path. + + + + + + Gets the flow chart alternate process path. + + + + + + Gets the flow chart predefined process path. + + + + + + Gets the flow chart internal storage path. + + + + + + Gets the flow chart document path. + + + + + + Gets the flow chart multi document path. + + + + + + Gets the flow chart terminator path. + + + + + + Gets the flow chart preparation path. + + + + + + Gets the flow chart manual input path. + + + + + + Gets the flow chart manual operation path. + + + + + + Gets the flow chart connector path. + + + + + + Gets the flow chart off page connector path. + + + + + + Gets the flow chart card path. + + + + + + Gets the flow chart punched tape path. + + + + + + Gets the flow chart summing junction path. + + + + + + Gets the flow chart or path. + + + + + + Gets the flow chart collate path. + + + + + + Gets the flow chart sort path. + + + + + + Gets the flow chart extract path. + + + + + + Gets the flow chart merge path. + + + + + + Gets the flow chart online storage path. + + + + + + Gets the flow chart delay path. + + + + + + Gets the flow chart sequential access storage path. + + + + + + Gets the flow chart magnetic disk path. + + + + + + Gets the flow chart direct access storage path. + + + + + + Gets the flow chart display path. + + + + + + Gets the rectangular callout path. + + + + + + Gets the rounded rectangular callout path. + + + + + + Gets the oval callout path. + + + + + + Gets the cloud callout path. + + + + + + Gets the line callout1 path. + + + + + + Gets the line callout2 path. + + + + + + Gets the line callout3 path. + + + + + + Gets the line callout1 accent bar path. + + + + + + Gets the line callout2 accent bar path. + + + + + + Gets the line callout3 accent bar path. + + + + + + Gets the line callout1 no border path. + + + + + + Gets the line callout2 no border path. + + + + + + Gets the line callout3 no border path. + + + + + + Gets the line callout1 border and accent bar path. + + + + + + Gets the line callout2 border and accent bar path. + + + + + + Gets the line callout3 border and accent bar path. + + + + + + + + + + + + + + + + + + + + + Sets the font name of the bullet. + + Represent the font name. + + + + Compares the current ListFormat object with given ListFormat object. + + The ListFormat object to compare with the current instance. + True if the ListFormat objects are equal; otherwise, false. + + + + Specifies default numbering format. + + + + + Specifies UppRoman numbering format. + + + + + Specifies LowRoman numbering format. + + + + + Specifies UpLetter numbering format. + + + + + Specifies LowLetter numbering format. + + + + + Specifies Ordinal numbering format. + + + + + Specifies Number numbering format. + + + + + Specifies OrdinalText numbering format. + + + + + Specifies LeadingZero numbering format. + + + + + Specifies Bullet numbering format. + + + + + + + + + + Special numbering format. + + + + + Specifies None numbering format. + + + + + Compare the input font instance with current font instance. + + Represent a input font to compare. + Returns true, if input font is same as current font;Otherwise false. + + + + Gets the Default HighlightColor from the slide + + Color object + + + + Gets the Default HighlightColor from the layout or master slide + + ColorObject + + + + Gets a font name to render. + + + + + + Gets the default size for table font from master slide text style list. + + Returns the master slide other text style font size otherwise the default size + + + + Retrieves the theme color from the preserved elements of the specified shape. + + The shape object from which to retrieve the color. + + Returns the theme color based on the "fontRef" key from the preserved elements if it exists; otherwise, returns null. + + + + + Applies color mapping to the specified ColorObject. + + The ColorObject to which the color mapping will be applied. + The modified ColorObject with the color mapping applied. + + + + Gets the HighlightColor from style list or Placeholder + + ColorObject + + + + Gets the highlightColor from the Master Slide + + + + ColorObject + + + + Gets the default highlightColor from the Presentation + + ColorObject + + + + Gets the default highlightColor from the Stylelist + + + ColorObject + + + + Returns a font name value bases on script type. + + + + + + Sets the highlight colorobject + + + + + + Gets the highlight colorobject + + Highlight color + + + + Returns the bold property from the current paragraph + + + + + Creates color object to the color mapping value in the base slide + + + + + Updates the properties of the text part based on the current settings and styles. + + + + + Updates the style list properties for the given property type. + + The property type to update in the style list (e.g., "solidFill", "typeface"). + + + + Updates the style list properties with the given element. + + A dictionary where keys are style names and values are objects. + The element string used to update the properties of paragraphs in the style list. + + A boolean value indicating whether the update was successful. + + + + + Sets the character spacing to the current font instance. + + Character spacing value. + + + + Gets the character spacing of the current font. + + Returns the character spacing value. + + + + Gets whether character spacing is applied in current font or not. + + + + + + Represent whether TextPart is bi-directional or not. + + + + + Gets or sets the language identifier (locale). + + The short value that specifies the equivalent locale id. + + + + Check whether current font object has a font name or not. + + + + + Gets and Sets the Highlight color for the Font + + + + + Returns the bold property from the hierarchy if it is not mentioned in the current paragraph + + + + + Represent the RTL property. + + + + + Gets the BaseSlide from the paragraph, if available. + + + + + Gets a Language value as string. + + + + + Gets or sets the character spacing value for the text in a paragraph. + + + + + Splits the text part based on line break character. + + Specifies the given text. + Specifies the current text part. + + + + Adds a line break text part to the text part collection. + + + + + Adds the specified text part to the textpart collection with the specified link. + + The text content to initialize the new instance. + Applies hyperlink with to the textpart. + Returns an instance. + + + + Gets a default Alignement Type from table styles. + + Returns a default alignment type. + + + + Split a text part based on the font script type. + + + + + Check whether textInfo collection has a word split characters ' ', '-', '\t' (Tab) or not. + + Represent a input textinfo collection to check. + Retruns true if textInfo collection has a word split characters ' ', '-', '\t'; Otherwise false. + + + + Check whether input text has RTL text or not. + + Represent a input text + + Returns true, if input text has RTL character; Otherwise false. + + + + To check whether the specified language is arabic language or not. + + Specify the language local id + Return true if the language id is represent the arabic + + + + Split a text part based on the RTL text. + + + + + + Combine the TextPart by consicutive LTR and RTL texts. + + + + + Shift the layouted textpart in right to left direction + + + + + Update a bounds of re-ordered widgets. + + + + + + + + Get the start position of line based on paraBidi property. + + + + + + + + + Reorders the child widgets of a line for RTL text. + + + + + + Check whether to insert a WordSplit Character into left or right. + + + + + + + + + Update a CharacterRange type based on previous and next characters. + + + + + + + + + + Check whether current line has RTL content or not. + + Returns true, if current line have a RTL text; Otherwise false. + + + + Gets the line spacing value for the line + + + + + + + Check whether the last text part of the paragraph is line break + + + + + Close and Dispose the memory. + Note: Do not invoke this method, use Close method clear the memmory. + + + + + Finds all the occurance of the given word from the paragraph + + + List of TextSelection + + + + Finds the first occurance of the given word in the paragraph + + + Text selection + + + + Update the start and end index of the paragraph text parts + + + + + + Compares the content and properties of the current Paragraph object with given Paragraph object. + + The Paragraph object to compare with the current instance. + True if the content and properties of the Paragraph objects are equal; otherwise, false. + + + + Updates the properties of the paragraph based on certain conditions and style list properties. + + + + + Updates the paragraph properties based on a specified property by checking both the TextBody's + and the Presentation's default style list, if available. + + The property to update from the style lists. + + + + Updates the style list properties with the given element. + + A dictionary where keys are style names and values are objects. + The element string used to update the properties of paragraphs in the style list. + + A boolean value indicating whether the update was successful. + + + + + Gets or Sets the hidden property of paragraph based on animation. + + + + + Property to access the end paragraph font properties + + + + + Check whether the paragraph collection is hidden or not. + + Returns true, if its hidden; Otherwise, false. + + + + Compares the content and properties of the current Paragraphs object with given Paragraphs object. + + The Paragraphs object to compare with the current instance. + True if the content and properties of the Paragraphs objects are equal; otherwise, false. + + + + Check whether langauage has been defined or not. + + + + + + + Change first letter of string to uppercase. + + + + + + + Finds all the occurance of the given word from the TextBody + + + List of TextSelection + + + + Finds the first occurance of the given word in the TextBody + + + Text selection + + + + Compares the current TextBody object with given TextBody object. + + The TextBody object to compare with the current instance. + True if the TextBody objects are equal; otherwise, false. + + + + Compares the styles in the current style list with given style list. + + The dictionary representing the style list to compare with the current instance. + True if the styles in the style lists are equal; otherwise, false. + + + + Splits the paragraph if it contains '\n' and adds the splitted paragraph to the paragraph collection. + + The collection to which the split paragraphs are added. + The collection of split paragraphs. + + + + Gets or sets the spacing between the columns. + + + This property only valid, when there is more than 1 column present. + + + + + Gets or sets the right to left order of columns. + + + + + Sets the hyperlink to the textpart. + + Represents the address of the target hyperlink + Returns an instance. + The target can be a document path, web url, target slide, email_id. + + + + Gets a updated slide number value. + + Returns a corrsponding slide number value. + + + + Gets a updated date and time string. + + Returns a upated date and time string + + + + Removes the hyperlink from the current textpart. + + + + + Check whether current TextPart is, only having a WordSplit characters or not. + + Returns true, if it only has a WordSplit characters. Otherwise false. + + + + Check whether current TextPart is Hindi or not. + + Returns true, if it is a Hindi character. Otherwise false. + + + + Compares the content and properties of the current TextPart object with given TextPart object. + + The TextPart object to compare with the current instance. + True if the content and properties of the TextPart objects are equal; otherwise, false. + + + + Represent a FontScriptType of current text range. + + + + + Represents whether current TextRange has any chinese or symbol unicode or not. + + + + + Represent a CharacterRangeType of current text range. + + + + + Returns an instance that represents the hyperlink for the specified textpart. + + + + + Gets or Sets the starting position of the TextPart in a Paragraph + + + + + Represents the Text Selection + + + + + Initializes a new instance of the class. + + The paragraph. + The start char position. + The end char position. + + + + Splits and returns the required text part from the parent text part + + Text part array + + + + Combines and returns the splited text parts as one text part. + + Text part + + + + Split the required text part from the owner text part + + + + + Ensure the indexes + + + + + Gets the start or end range index + + + + + integer + + + + Add the text parts to the list + + + + + Update the following text selections + + + + + + Gets the selected text. Read-only. + + The string that represents the selected text. + + + + Gets the string at the specified index from the + collection. + + The zero-based index of the string to get. + The string at the specified collection. + + + + Gets the number of text chunks in the collection. Read-only. + + The count. + integer count of the selection + + + + Compares the content and properties of the current TextParts object with given TextParts object. + + The TextParts object to compare with the current instance. + True if the content and properties of the TextParts objects are equal; otherwise, false. + + + + This class used for implementing Advanced Encryption Standard algorithm. + + + + + Initializes a new instance of the Aes class. + + Key size. + Key bytes + + + + Initializes this instance. + + + + + Encipher 16 bit input + + 16 bit Input + Output value + + + + Decipher 16-bit input + + + + + + + Sets the nb nk nr. + + Size of the key. + + + + Builds the sbox. + + + + + Builds the inv sbox. + + + + + Builds the rcon. + + + + + Adds the round key. + + The round. + + + + Subs the bytes. + + + + + Invs the sub bytes. + + + + + Shifts the rows. + + + + + Invs the shift rows. + + + + + Mixes the columns. + + + + + Invs the mix columns. + + + + + Keys the expansion. + + + + + Subs the word. + + The word. + + + + + Rots the word. + + The word. + + + + + Possible key sizes. + key size, in bits, for constructor. + + + + + 128-bit. + + + + + 192-bit. + + + + + 256-bit. + + + + + This class is responsible for decryption of Agile encryption (Word 2010/2013) files. + + + + + Segment size. + + + + + Dataspace map. + + + + + Encryption info. + + + + + Compound storage that should be decrypted. + + + + + Intermediate key. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Hashing Algorithm used to compute hash. + + + + + Computes a Hash-based Message Authentication Code (HMAC) using the System.Security.Cryptography.SHA1 hash function. + + + + + Decrypts internal storage. + + Decrypted stream. + + + + Prepares decryptor for actual decryption. + + Compound storage to get required data. + + + + Checks whether password is correct. + + Password to check. + True if password verification succeeded. + + + + Checks the encrypted package. + + The encrypted package. + + + + + Decrypts the specified data. + + The data. + Size of the block. + The arr key. + The IV. + The actual length. + + + + + Parses the transform. + + The data spaces. + + + + Parses the data space map. + + The data spaces. + + + + Parses the transform info. + + The transform storage. + + + + Represents the agile encryption info for Encryption/Decryption of Word 2010/2013 documents. + + + + + A Version structure where Version.vMajor MUST be 0x0004, and Version.vMinor MUST be 0x0004. + + + + + A Reserved 4 bytes, MUST be 0x00000040. + + + + + An XmlEncryptionDescriptor structure that specifies encryption and hashing algorithm. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Default constructor. + + + + + Initializes new instance. + + Stream to get data from. + + + + Serializes object into stream. + + Stream to serialize into. + + + + Gets or sets the version info. + + The version info. + + + + Gets or sets the reserved. + + The reserved. + + + + An XmlEncryptionDescriptor structure that specifies encryption and hashing algorithm. + + + + + This class used to encrypt data using Agile encryption (Word 2010/2013). + + + + + Default version. + + + + + Reserved bytes. + + + + + Segment size. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Hashing Algorithm used to compute hash. + + + + + Computes a Hash-based Message Authentication Code (HMAC) using the System.Security.Cryptography.SHA1 hash function. + + + + + Hashing Algorithm name used to compute hash. + + + + + Encryption key bits. + + + + + Hash size. + + + + + Initializes encryptor for agile encryption. + + + + + Initializes encryptor for agile encryption. + + The hash algorithm. + The key bits. + Size of the hash. + + + + Encrypts specified stream. + + Data to encrypt. + Password to use. + Root storage to put encrypted data into. + + + + Prepares the encryption info. + + The data. + The root. + The password. + + + + Prepares the encrypted package. + + The data. + The root. + The key data. + The intermediate key. + + + + + Initializes the key data. + + The key data. + + + + Initializes the encrypted key. + + The key. + + + + Preparse data spaces structures inside specified storage. + + Storage to put DataSpaces inside. + + + + Serializes VersionInfo stream inside specified storage. + + Storage to serialize VersionInfo into. + + + + Serializes transformation info. + + Storage to serialize into. + + + + Serializes dataspace info. + + Storage to serialize into. + + + + Serializes DataSpaceMap stream. + + Storage to place stream into. + + + + Creates the salt. + + The length. + + + + + Encrypts the specified data. + + The data. + Size of the block. + The key. + The IV. + + + + + Represents the data space definition for Encryption/Decryption of Word documents. + + + + + Default header size. + + + + + Header length. + + + + + List with transform references. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Initializes new instance. + + + + + Initializes new instance of DataSpaceDefinition. + + Stream to get data from. + + + + Serializes dataspace definition into the stream. + + Stream to serialize into. + + + + List with transform references. + + + + + Represents the data space map for Encryption/Decryption of Word documents. + + + + + Size of the header. + + + + + Map entries. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Default constructor. + + + + + Initializes new instance of the DataSpaceMap. + + Stream to get data from. + + + + Serializes dataspace map into the stream. + + Stream to serialize into. + + + + Map entries. + + + + + Represents the data space map entry for Encryption/Decryption of Word documents. + + + + + List of the reference components. + + + + + DataSpace name. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Default constructor. + + + + + Initializes new instance of the map entry. + + Stream to get data from. + + + + Serializes single dataspace map entry into the stream. + + Stream to serialize into. + + + + List of the reference components. + + + + + DataSpace name. + + + + + Represents the data space reference component for Encryption/Decryption of Word documents. + + + + + Component type. + + + + + Component name. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Initializes new instance of the reference component. + + Component type. + Component name. + + + + Initializes new instance of the component reference. + + Stream to get data from. + + + + Serializes object into stream. + + Stream to serialize into. + + + + Component type. + + + + + Component name. + + + + + Represents the encryption header for Encryption/Decryption of Word documents. + + + + + An EncryptionHeaderFlags structure that specifies properties of the encryption algorithm used. + + + + + Reserved, MUST be 0x00000000. + + + + + A signed integer that specifies the encryption algorithm. + + + + + A signed integer that specifies the hashing algorithm in concert with the Flags.fExternal bit. + + + + + An unsigned integer that specifies the number of bits in the encryption key. + MUST be a multiple of 8. + + + + + An implementation specified value which corresponds to constants accepted by + the specified CSP. MUST be compatible with the chosen CSP. + + + + + Undefined and MUST be ignored. + + + + + MUST be 0x00000000 and MUST be ignored. + + + + + A null-terminated Unicode string that specifies the CSP name. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Default constructor. + + + + + Initializes new instance of the header and extracts its data from the stream. + + Stream to get data from. + + + + Extracts item's data from the specified stream. + + Stream to get data from. + + + + Serialize item in the specified stream. + + Stream to serialize data into. + + + + An EncryptionHeaderFlags structure that specifies properties of the encryption algorithm used. + + + + + Reserved, MUST be 0x00000000. + + + + + A signed integer that specifies the encryption algorithm. + + + + + A signed integer that specifies the hashing algorithm in concert with the Flags.fExternal bit. + + + + + An unsigned integer that specifies the number of bits in the encryption key. + MUST be a multiple of 8. + + + + + An implementation specified value which corresponds to constants accepted by + the specified CSP. MUST be compatible with the chosen CSP. + + + + + Undefined and MUST be ignored. + + + + + MUST be 0x00000000 and MUST be ignored. + + + + + A null-terminated Unicode string that specifies the CSP name. + + + + + Represents the encryption transform info for Encryption/Decryption of Word documents. + + + + + Transform name. + + + + + Block size. + + + + + Cipher mode. + + + + + Reserved. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Default constructor. + + + + + Initializes new instance of the class. + + Stream to get data from. + + + + Serializes object into stream. + + Stream. + + + + Transform name. + + + + + Block size. + + + + + Cipher mode. + + + + + Reserved. + + + + + Represents the encryption verifier for Encryption/Decryption of Word documents. + + + + + An array of bytes that specifies the salt value used during password hash + generation. MUST NOT be the same data used for the verifier stored encrypted + in the EncryptedVerifier field. + + + + + MUST be the randomly generated Verifier value encrypted using the algorithm + chosen by the implementation. + + + + + An array of bytes that contains the encrypted form of the hash of the randomly + generated Verifier value. The length of the array MUST be the size of the + encryption block size multiplied by the number of blocks needed to encrypt + the hash of the Verifier. If the encryption algorithm is RC4, the length + MUST be 20 bytes. If the encryption algorithm is AES, the length MUST be 32 bytes. + + + + + Size of the verifier hash. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Default constructor. + + + + + Initializes new instance of the verifier. + + Stream to get data from. + + + + Extracts object from stream. + + Stream to get data from. + + + + Serializes object into stream. + + Stream to serialize into. + + + + An array of bytes that specifies the salt value used during password hash + generation. MUST NOT be the same data used for the verifier stored encrypted + in the EncryptedVerifier field. + + + + + MUST be the randomly generated Verifier value encrypted using the algorithm + chosen by the implementation. + + + + + An array of bytes that contains the encrypted form of the hash of the randomly + generated Verifier value. The length of the array MUST be the size of the + encryption block size multiplied by the number of blocks needed to encrypt + the hash of the Verifier. If the encryption algorithm is RC4, the length + MUST be 20 bytes. If the encryption algorithm is AES, the length MUST be 32 bytes. + + + + + Gets/sets size of the verifier hash. + + + + + + + + + + Initializes a new instance of the class. + + + + + Initializes this instance. + + + + + Initializes the before reading the document. + + + + + Reads the Fib records from the specified stream. + + The stream. + + + + Reads the Fib records from the decrypted stream. + + The stream. + + + + Reads the Fib records after 64 bytes - cslw from the specified stream. + + The stream. + + + + Validates the cbRgFcLcb. + + + + + Validates the CSW new. + + + + + + + + + + Writes the Fib records to the specified stream. + + The stream. + + + + Writes the internal. + + The stream. + + + + Writes the after encryption. + + The stream. + + + + Updates the fcMac. + + + + + Closes this instance. + + + + + Gets the fib version determined in the Word document as per file format specifications. + + + The fib version. + + + + + Gets or sets an unsigned integer that specifies that this is a Word Binary File. This value MUST be 0xA5EC. + + + The w ident. + + + + + + Gets or sets the unused value. + This value is undefined and MUST be ignored. + + + The BaseUnused. + + + + + Gets or sets a LID that specifies the install language of the application that is producing the document. + If nFib is 0x00D9 or greater, then any East Asian install lid or any install lid with a base language of Spanish, German or French MUST be recorded as lidAmerican. + If the nFib is 0x0101 or greater, then any install lid with a base language of Vietnamese, Thai, or Hindi MUST be recorded as lidAmerican. + + + The lid. + + + + + Gets or sets an unsigned integer that specifies the offset in the WordDocument stream of the FIB for the document which contains all the AutoText items. + If this value is 0, there are no AutoText items attached. Otherwise the FIB is found at file location pnNext�512. + If fGlsy is 1 or fDot is 0, this value MUST be 0. + If pnNext is not 0, each FIB MUST share the same values for FibRgFcLcb97.fcPlcBteChpx, FibRgFcLcb97.lcbPlcBteChpx, FibRgFcLcb97.fcPlcBtePapx, FibRgFcLcb97.lcbPlcBtePapx, and FibRgLw97.cbMac. + + + The pn next. + + + + + Gets or sets a value specifies whether this is a document template (1). + + + true if this is a document template; otherwise, false. + + + + + Gets or sets a value specifies whether this is a document that contains only AutoText items (see FibRgFcLcb97.fcSttbfGlsy, FibRgFcLcb97.fcPlcfGlsy and FibRgFcLcb97.fcSttbGlsyStyle). + + + true if this is a document that contains only AutoText items; otherwise, false. + + + + + Gets or sets a value specifies that the last save operation that was performed on this document was an incremental save operation. + + + true if fComplex; otherwise, false. + + + + + + Gets or sets an unsigned integer. + If nFib is less than 0x00D9, then cQuickSaves specifies the number of consecutive times this document was incrementally saved. + If nFib is 0x00D9 or greater, then cQuickSaves MUST be 0xF. + + + The c quick saves. + + + + + Gets or sets a value specifies whether the document is encrypted or obfuscated as specified in Encryption and Obfuscation. + + + true if the document is encrypted or obfuscated; otherwise, false. + + + + + Gets or sets a value specifies the Table stream to which the FIB refers. When this value is set to 1, use 1Table; when this value is set to 0, use 0Table. + + + true if the Table stream is 1Table; otherwise, false. + + + + + Gets or sets a value specifies whether the document author recommended that the document be opened in read-only mode. + + + true if the document to be opened in read-only mode; otherwise, false. + + + + + Gets or sets a value specifies whether the document has a write-reservation password. + + + true if the document has a write-reservation password; otherwise, false. + + + + + Gets or sets a value indicating ext character. + This value MUST be 1. + + + true if ext character; otherwise, false. + + + + + Gets or sets a value specifies whether to override the language information and font that are specified in the paragraph style at istd 0 (the normal style) with the defaults that are appropriate for the installation language of the application. + + + true if load override; otherwise, false. + + + + + Gets or sets a value specifies whether the installation language of the application that created the document was an East Asian language. + + + true if far east; otherwise, false. + + + + + Gets or sets a value specifies whether the document is obfuscated by using XOR obfuscation. + If fEncrypted is 1, this bit specifies whether the document is obfuscated by using XOR obfuscation (section 2.2.6.1); otherwise, this bit MUST be ignored. + + + true if the document is obfuscated by using XOR obfuscation; otherwise, false. + + + + + + Gets or sets the key. + If fEncrypted is 1 and fObfuscation is 1, this value specifies the XOR obfuscation (section 2.2.6.1) password verifier. + If fEncrypted is 1 and fObfuscation is 0, this value specifies the size of the EncryptionHeader that is stored at the beginning of the Table stream as described in Encryption and Obfuscation. + Otherwise, this value MUST be 0. + + + The l key. + + + + + Gets or sets the envr. + This value MUST be 0, and MUST be ignored. + + + The envr. + + + + + Gets or sets a value indicating whether mac. + This value MUST be 0, and MUST be ignored. + + + true if mac; otherwise, false. + + + + + + Gets or sets a value specifies whether to override the section properties for page size, orientation, and margins with the defaults that are appropriate for the installation language of the application. + + + true if load override page; otherwise, false. + + + + + Gets or sets a value indicating the reserved1. + This value is undefined and MUST be ignored. + + + true if reserved1; otherwise, false. + + + + + Gets or sets a value indicating the reserved2. + This value is undefined and MUST be ignored. + + + true if reserved2; otherwise, false. + + + + + Gets or sets the spare0. + This value is undefined and MUST be ignored. + + + The f spare0. + + + + + Gets or sets a value indicating the reserved3. + This value MUST be 0 and MUST be ignored. + + + The reserved3. + + + + + Gets or sets a value indicating the reserved4. + This value MUST be 0 and MUST be ignored. + + + The reserved4. + + + + + Gets or sets a value indicating the reserved5. + This value is undefined and MUST be ignored. + + + The reserved5. + + + + + Gets or sets a value indicating the reserved6. + This value is undefined and MUST be ignored. + + + The reserved6. + + + + + Gets or sets an unsigned integer that specifies the count of 16-bit values corresponding to fibRgW that follow. MUST be 0x000E. + + + The CSW. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg w reserved1. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg w reserved2. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg w reserved3. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fib rg w reserved4. + + + + + + + + + + + + + + A LID whose meaning depends on the nFib value. Gets or sets the lid fe. + + + The lid fe. + + + + + Gets or sets an unsigned integer that specifies the count of 32-bit values corresponding to fibRgLw that follow. MUST be 0x0016. + + + The CSLW. + + + + + Specifies the count of bytes of those written to the WordDocument stream of the file that have any meaning. Gets or sets the cb mac. + + + The cb mac. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The rg lw reserved1. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The rg lw reserved2. + + + + + Specifies the count of CPs in the main document. Gets or sets the CCP text. + + + The CCP text. + + + + + Specifies the count of CPs in the footnote subdocument. Gets or sets the CCP FTN. + + + The CCP FTN. + + + + + Specifies the count of CPs in the header subdocument. Gets or sets the CCP HDD. + + + The CCP HDD. + + + + + Gets or sets this value MUST be zero and MUST be ignored. + + + The rg lw reserved3. + + + + + Specifies the count of CPs in the comment subdocument. Gets or sets the CCP atn. + + + The CCP atn. + + + + + Specifies the count of CPs in the endnote subdocument. Gets or sets the CCP edn. + + + The CCP edn. + + + + + Specifies the count of CPs in the textbox subdocument of the main document. Gets or sets the CCP TXBX. + + + The CCP TXBX. + + + + + Specifies the count of CPs in the textbox subdocument of the header. Gets or sets the CCP HDR TXBX. + + + The CCP HDR TXBX. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The rg lw reserved4. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The rg lw reserved5. + + + + + Gets or sets the rg lw reserved6. + + + The rg lw reserved6. + + + + + Gets or sets this value is undefined and MUST be ignored + + + The rg lw reserved7. + + + + + Gets or sets this value is undefined and MUST be ignored + + + The rg lw reserved8. + + + + + Gets or sets the rg lw reserved9. + + + The rg lw reserved9. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The rg lw reserved10. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The rg lw reserved11. + + + + + + Gets or sets this value MUST be zero and MUST be ignored. + + + The rg lw reserved13. + + + + + Gets or sets this value MUST be zero and MUST be ignored. + + + The rg lw reserved14. + + + + + Gets or sets an unsigned integer that specifies the count of 64-bit values corresponding to fibRgFcLcbBlob that follow. + This MUST be one of the following values, depending on the value of nFib. + Value of nFib cbRgFcLcb + 0x00C1 0x005D + 0x00D9 0x006C + 0x0101 0x0088 + 0x010C 0x00A4 + 0x0112 0x00B7 + + + The cb rg fc LCB. + + + + the fib rg fc LCB97 fc STSHF original. + Gets or sets This value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc STSHF original. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fib rg fc LCB97 LCB STSHF original. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An STSH that specifies the + style sheet for this document begins at this offset. + + + The fc STSHF. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the STSH that begins at offset + fcStshf in the Table Stream. This MUST be a nonzero value. + + + The LCB STSHF. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcffndRef begins at this + offset and specifies the locations of footnote references in the Main Document, and whether those references + use auto-numbering or custom symbols. If lcbPlcffndRef is zero, fcPlcffndRef is undefined and MUST be + ignored. + + + The fc PLCFFND reference. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcffndRef that begins at offset + fcPlcffndRef in the Table Stream. + + + The LCB PLCFFND reference. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcffndTxt begins at this + offset and specifies the locations of each block of footnote text in the Footnote Document. If lcbPlcffndTxt + is zero, fcPlcffndTxt is undefined and MUST be ignored. + + + The fc PLCFFND text. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcffndTxt that begins at offset + fcPlcffndTxt in the Table Stream. + + + The LCB PLCFFND text. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfandRef begins at this + offset and specifies the dates, user initials, and locations of comments in the Main Document. If + lcbPlcfandRef is zero, fcPlcfandRef is undefined and MUST be ignored. + + + The fc plcfand reference. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfandRef at offset fcPlcfandRef + in the Table Stream. + + + The LCB plcfand reference. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfandTxt begins at this + offset and specifies the locations of comment text ranges in the Comment Document. If lcbPlcfandTxt is zero, + fcPlcfandTxt is undefined, and MUST be ignored. + + + The fc plcfand text. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfandTxt at offset fcPlcfandTxt + in the Table Stream. + + + The LCB plcfand text. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfSed begins at this + offset and specifies the locations of property lists for each section in the Main Document. If lcbPlcfSed is + zero, fcPlcfSed is undefined and MUST be ignored. + + + The LCB plcfand text. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfSed that begins at offset + fcPlcfSed in the Table Stream. + + + The LCB PLCF sed. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc PLC pad. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The fc PLC pad. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Plc at offset fcPlcfPhe in the + Table Stream. + + + The LCB PLCF phe. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A SttbfGlsy that contains + information about the AutoText items that are defined in this document begins at this offset. + + + The fc STTBF glsy. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbfGlsy at offset fcSttbfGlsy + in the Table Stream. If base.fGlsy of the Fib that contains this FibRgFcLcb97 is zero, this value MUST be + zero. + + + The LCB STTBF glsy. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfGlsy that contains + information about the AutoText items that are defined in this document begins at this offset. + + + The fc PLCF glsy. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfGlsy at offset fcPlcfGlsy in + the Table Stream. If base.fGlsy of the Fib that contains this FibRgFcLcb97 is zero, this value MUST be zero. + + + The LCB PLCF glsy. + + + + + Gets or sets An unsigned integer that specifies the offset in the Table Stream where a Plcfhdd begins. The + Plcfhdd specifies the locations of each block of header/footer text in the WordDocument Stream. + + + The fc PLCF HDD. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Plcfhdd at offset fcPlcfHdd in + the Table Stream. If there is no Plcfhdd, this value MUST be zero. A Plcfhdd MUST exist if FibRgLw97.ccpHdd + indicates that there are characters in the Header Document + + + The LCB PLCF HDD. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcBteChpx begins at the + offset. fcPlcfBteChpx MUST be greater than zero, and MUST be a valid offset in the Table Stream. + + + The fc PLCF bte CHPX. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcBteChpx at offset + fcPlcfBteChpx in the Table Stream. lcbPlcfBteChpx MUST be greater than zero. + + + The LCB PLCF bte CHPX. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcBtePapx begins at the + offset. fcPlcfBtePapx MUST be greater than zero, and MUST be a valid offset in the Table Stream. + + + The fc PLCF bte papx. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcBtePapx at offset + fcPlcfBtePapx in the Table Stream. lcbPlcfBteChpx MUST be greater than zero. + + + The LCB PLCF bte papx. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc PLCF sea. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB PLCF sea. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An SttbfFfn begins at this + offset. This table specifies the fonts that are used in the document. If lcbSttbfFfn is 0, fcSttbfFfn is + undefined and MUST be ignored. + + + The fc STTBF FFN. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbfFfn at offset fcSttbfFfn in + the Table Stream. + + + The LCB STTBF FFN. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcFld begins at this + offset and specifies the locations of field characters in the Main Document. All CPs in this PlcFld MUST be + greater than or equal to 0 and less than or equal to FibRgLw97.ccpText. If lcbPlcfFldMom is zero, + fcPlcfFldMom is undefined and MUST be ignored. + + + The fc PLCF field mom. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcFld at offset fcPlcfFldMom in + the Table Stream. + + + The LCB PLCF field mom. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcFld begins at this + offset and specifies the locations of field characters in the Header Document. All CPs in this PlcFld are + relative to the starting position of the Header Document. + + + The fc PLCF field HDR. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcFld at offset fcPlcfFldHdr in + the Table Stream. + + + The LCB PLCF field HDR. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcFld begins at this + offset and specifies the locations of field characters in the Footnote Document. All CPs in this PlcFld are + relative to the starting position of the Footnote Document. + + + The fc PLCF field FTN. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcFld at offset fcPlcfFldFtn in + the Table Stream. + + + The LCB PLCF field FTN. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcFld begins at this + offset and specifies the locations of field characters in the Comment Document. All CPs in this PlcFld are + relative to the starting position of the Comment Document. + + + The fc PLCF field atn. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcFld at offset fcPlcfFldAtn in + the Table Stream. + + + The LCB PLCF field atn. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc PLCF field MCR. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB PLCF field MCR. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An SttbfBkmk that contains + the names of the bookmarks (1) in the document begins at this offset. + + + The fc STTBF BKMK. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbfBkmk at offset fcSttbfBkmk. + + + The LCB STTBF BKMK. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfBkf that contains + information about the standard bookmarks (1) in the document begins at this offset. If lcbPlcfBkf is zero, + fcPlcfBkf is undefined and MUST be ignored. + + + The fc PLCF BKF. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfBkf at offset fcPlcfBkf. + + + The LCB PLCF BKF. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfBkl that contains + information about the standard bookmarks (1) in the document begins at this offset. + + + The fc PLCF BKL. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfBkl at offset fcPlcfBkl. + + + The LCB PLCF BKL. + + + + + Gets or sets An unsigned integer that specifies the offset in the Table Stream of a Tcg that specifies + command-related customizations. If lcbCmds is zero, fcCmds is undefined and MUST be ignored. + + + The fc CMDS. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Tcg at offset fcCmds. + + + The LCB CMDS. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc unused1. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB unused1. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc STTBF MCR. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB STTBF MCR. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. The PrDrvr, which contains + printer driver information (the names of drivers, port, and so on), begins at this offset. + + + The fc pr DRVR. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PrDrvr at offset fcPrDrvr. + + + The LCB pr DRVR. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. The PrEnvPort that is the + print environment in portrait mode begins at this offset. If lcbPrEnvPort is zero, fcPrEnvPort is undefined + and MUST be ignored. + + + The fc pr env port. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PrEnvPort at offset fcPrEnvPort. + + + The LCB pr env port. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. The PrEnvLand that is the + print environment in landscape mode begins at this offset. If lcbPrEnvLand is zero, fcPrEnvLand is undefined + and MUST be ignored. + + + The fc pr env land. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PrEnvLand at offset fcPrEnvLand. + + + The LCB pr env land. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A Selsf begins at this offset + and specifies the last selection that was made in the Main Document. If lcbWss is zero, fcWss is undefined + and MUST be ignored. + + + The fc WSS. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Selsf at offset fcWss. + + + The LCB WSS. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A Dop begins at this offset. + + + The fc dop. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Dopat fcDop. This value MUST NOT + be zero. + + + The LCB dop. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An SttbfAssoc that contains + strings that are associated with the document begins at this offset. + + + The fc STTBF assoc. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbfAssoc at offset fc + SttbfAssoc. This value MUST NOT be zero. + + + The LCB STTBF assoc. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A Clx begins at this offset. + + + The fc CLX. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Clx at offset fcClx in the Table + Stream. This value MUST be greater than zero. + + + The LCB CLX. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc PLCF PGD FTN. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB PLCF PGD FTN. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc autosave source. + + + + + Gets or sets This value MUST be zero and MUST be ignored. + + + The LCB autosave source. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An array of XSTs begins at + this offset. The value of cch for all XSTs in this array MUST be less than 56. The number of entries in this + array is limited to 0x7FFF. + + + The fc GRP XST atn owners. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the XST array at offset + fcGrpXstAtnOwners in the Table Stream. + + + The LCB GRP XST atn owners. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An SttbfAtnBkmk that contains + information about the annotation bookmarks in the document begins at this offset. + + + The fc STTBF atn BKMK. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbfAtnBkmk at offset + fcSttbfAtnBkmk. + + + The LCB STTBF atn BKMK. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc unused2. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB unused2. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc unused3. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB unused3. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfSpa begins at this + offset. The PlcfSpa contains shape information for the Main Document. + + + The fc PLC spa mom. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfSpa at offset fcPlcSpaMom. + + + The LCB PLC spa mom. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfSpa begins at this + offset. The PlcfSpa contains shape information for the Header Document. + + + The fc PLC spa HDR. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfSpa at the offset + fcPlcSpaHdr. + + + The LCB PLC spa HDR. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfBkf that contains + information about annotation bookmarks in the document begins at this offset. If lcbPlcfAtnBkf is zero, + fcPlcfAtnBkf is undefined and MUST be ignored. + + + The LCB PLC spa HDR. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfBkf at offset fcPlcfAtnBkf. + + + The LCB PLCF atn BKF. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfBkl that contains + information about annotation bookmarks in the document begins at this offset. If lcbPlcfAtnBkl is zero, then + fcPlcfAtnBkl is undefined and MUST be ignored. + + + The fc PLCF atn BKL. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfBkl at offset fcPlcfAtnBkl. + + + The LCB PLCF atn BKL. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A Pms, which contains the + current state of a print merge operation, begins at this offset. If lcbPms is zero, fcPms is undefined and + MUST be ignored. + + + The fc PMS. + + + + + Gets or sets An unsigned integer which specifies the size, in bytes, of the Pms at offset fcPms. + + + The LCB PMS. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc form field STTBS. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB form field STTBS. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfendRef that begins at + this offset specifies the locations of endnote references in the Main Document and whether those references + use auto-numbering or custom symbols. + + + The fc plcfend reference. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfendRef that begins at offset + fcPlcfendRef in the Table Stream. + + + The LCB plcfend reference. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfendTxt begins at this + offset and specifies the locations of each block of endnote text in the Endnote Document. If lcbPlcfendTxt + is zero, fcPlcfendTxt is undefined and MUST be ignored. + + + The fc plcfend text. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfendTxt that begins at offset + fcPlcfendTxt in the Table Stream. + + + The LCB plcfend text. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcFld begins at this + offset and specifies the locations of field characters in the Endnote Document. + + + The fc PLCF field edn. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcFld at offset fcPlcfFldEdn in + the Table Stream. + + + The LCB PLCF field edn. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc unused4. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB unused4. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An OfficeArtContent that + contains information about the drawings in the document begins at this offset. + + + The fc DGG information. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the OfficeArtContent at the offset + fcDggInfo. If lcbDggInfo is zero, there MUST NOT be any drawings in the document. + + + The LCB DGG information. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An SttbfRMark that contains + the names of authors who have added revision marks or comments to the document begins at this offset. + + + The fc STTBF r mark. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbfRMark at the offset + fcSttbfRMark. + + + The LCB STTBF r mark. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An SttbfCaption that contains + information about the captions that are defined in this document begins at this offset. + + + The fc STTBF caption. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbfCaption at offset + fcSttbfCaption in the Table Stream. If base.fDot of the Fib that contains this FibRgFcLcb97 is zero, this + value MUST be zero. + + + The LCB STTBF caption. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A SttbfAutoCaption that + contains information about the AutoCaption strings defined in this document begins at this offset. + + + The fc STTBF automatic caption. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbfAutoCaption at offset + fcSttbfAutoCaption in the Table Stream. If base.fDot of the Fib that contains this FibRgFcLcb97 is zero, + this MUST be zero. + + + The LCB STTBF automatic caption. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfWKB that contains + information about all master documents and subdocuments begins at this offset. + + + The fc PLCF WKB. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfWKB at offset fcPlcfWkb in + the Table Stream. If lcbPlcfWkb is zero, fcPlcfWkb is undefined and MUST be ignored. + + + The LCB PLCF WKB. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A Plcfspl, which specifies + the state of the spell checker for each text range, begins at this offset. If lcbPlcfSpl is zero, then + fcPlcfSpl is undefined and MUST be ignored. + + + The fc PLCF SPL. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Plcfspl that begins at offset + fcPlcfSpl in the Table Stream. + + + The LCB PLCF SPL. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcftxbxTxt begins at this + offset and specifies which ranges of text are contained in which textboxes. If lcbPlcftxbxTxt is zero, + fcPlcftxbxTxt is undefined and MUST be ignored. + + + The fc PLCFTXBX text. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcftxbxTxt that begins at offset + fcPlcftxbxTxt in the Table Stream. + + + The LCB PLCFTXBX text. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcFld begins at this + offset and specifies the locations of field characters in the Textbox Document. All CPs in this PlcFld are + relative to the starting position of the Textbox Document. + + + The fc PLCF field TXBX. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcFld at offset fcPlcfFldTxbx in + the Table Stream. + + + The LCB PLCF field TXBX. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfHdrtxbxTxt begins at + this offset and specifies which ranges of text are contained in which header textboxes. + + + The fc PLCF HDRTXBX text. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfHdrtxbxTxt that begins at + offset fcPlcfHdrtxbxTxt in the Table Stream. + + + The LCB PLCF HDRTXBX text. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcFld at offset fcPlcffldHdrTxbx + in the Table Stream. + + + The fc PLCFFLD HDR TXBX. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcFld at offset fcPlcffldHdrTxbx + in the Table Stream. + + + The LCB PLCFFLD HDR TXBX. + + + + + Gets or sets An unsigned integer that specifies an offset into the Table Stream. An StwUser that specifies + the user-defined variables and VBAdigital signature (2), as specified by [MS-OSHARED] section 2.3.2, begins + at this offset. + + + The fc STW user. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the StwUser at offset fcStwUser. + + + The LCB STW user. + + + + + Gets or sets An unsigned integer that specifies an offset into the Table Stream. A SttbTtmbd begins at this + offset and specifies information about the TrueType fonts that are embedded in the document. If lcbSttbTtmbd + is zero, fcSttbTtmbd is undefined and MUST be ignored. + + + The fc STTB TTMBD. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbTtmbd at offset fcSttbTtmbd. + + + The LCB STTB TTMBD. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the RgCdb at offset fcCookieData in + the Table Stream. + + + The LCB cookie data. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated document page layout + cache at offset fcPgdMotherOldOld in the Table Stream. + + + The LCB PGD mother old old. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated document text flow + break cache at offset fcBkdMotherOldOld in the Table Stream. + + + The LCB BKD mother old old. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated footnote layout cache + at offset fcPgdFtnOldOld in the Table Stream. + + + The LCB PGD FTN old old. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated footnote text flow + break cache at offset fcBkdFtnOldOld in the Table Stream. + + + The LCB BKD FTN old old. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated endnote layout cache + at offset fcPgdEdnOldOld in the Table Stream. + + + The LCB PGD edn old old. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated endnote text flow + break cache at offset fcBkdEdnOldOld in the Table Stream. + + + The LCB BKD edn old old. + + + + + Gets or sets this value is undefined and MUST be ignored. + + + The fib rg fc LCB97 fc STTBF intl field. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB STTBF intl field. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the RouteSlip at offset fcRouteSlip + in the Table Stream. + + + The LCB route slip. + + + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An SttbFnm that contains + information about the external files that are referenced by this document begins at this offset. If + lcbSttbFnm is zero, fcSttbFnm is undefined and MUST be ignored. + + + The fc STTB FNM. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbFnm at the offset fcSttbFnm. + + + The LCB STTB FNM. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlfLst that contains list + formatting information begins at this offset. An array of LVLs is appended to the PlfLst. + + + The fc PLF LST. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlfLst at the offset fcPlfLst. + This does not include the size of the array of LVLs that are appended to the PlfLst. + + + The LCB PLF LST. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlfLfo that contains list + formatting override information begins at this offset. If lcbPlfLfo is zero, fcPlfLfo is undefined and MUST + be ignored. + + + The fc PLF lfo. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlfLfo at the offset fcPlfLfo. + + + The LCB PLF lfo. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcftxbxBkd begins at this + offset and specifies which ranges of text go inside which textboxes. + + + The fc PLCF TXBX BKD. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcftxbxBkd that begins at offset + fcPlcfTxbxBkd in the Table Stream. + + + The LCB PLCF TXBX BKD. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfTxbxHdrBkd begins at + this offset and specifies which ranges of text are contained inside which header textboxes. + + + The fc PLCF TXBX HDR BKD. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfTxbxHdrBkd that begins at + offset fcPlcfTxbxHdrBkd in the Table Stream. + + + The LCB PLCF TXBX HDR BKD. + + + + + + Gets or sets An unsigned integer. If this is nonzero, version-specific undo information exists at offset + fcDocUndoWord9 in the WordDocument Stream. + + + The LCB document undo word9. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the version-specific undo information + at offset fcRgbUse in the WordDocument Stream. + + + The LCB RGB use. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the version-specific undo + information at offset fcUsp in the WordDocument Stream. + + + The LCB usp. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the version-specific undo informatio + at offset fcUskf in the Table Stream. + + + The LCB uskf. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Plc at offset fcPlcupcRgbUse in + the Table Stream. + + + The LCB plcupc RGB use. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Plc at offset fcPlcupcUsp in the + Table Stream. + + + The LCB plcupc usp. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A SttbGlsyStyle, which + contains information about the styles that are used by the AutoText items which are defined in this + document, begins at this offset. + + + The fc STTB glsy style. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbGlsyStyle at offset + fcSttbGlsyStyle in the Table Stream. If base.fGlsy of the Fib that contains this FibRgFcLcb97 is zero, this + value MUST be zero. + + + The LCB STTB glsy style. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlfGosl begins at the + offset. If lcbPlgosl is zero, fcPlgosl is undefined and MUST be ignored. + + + The fc plgosl. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlfGosl at offset fcPlgosl in the + Table Stream. + + + The LCB plgosl. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A RgxOcxInfo that specifies + information about the OLE controls in the document begins at this offset. + + + The fc plcocx. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the RgxOcxInfo at the offset + fcPlcocx. + + + The LCB plcocx. + + + + + + + Gets or sets The low-order part of a FILETIME structure, as specified by [MS-DTYP], that specifies when the + document was last saved. + + + The dw low date time. + + + + + Gets or sets The high-order part of a FILETIME structure, as specified by [MS-DTYP], that specifies when the + document was last saved. + + + The dw high date time. + + + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfAsumy begins at the + offset. If lcbPlcfAsumy is zero, fcPlcfAsumy is undefined and MUST be ignored. + + + The fc PLCF asumy. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfAsumy at offset fcPlcfAsumy + in the Table Stream. + + + The LCB PLCF asumy. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A Plcfgram, which specifies + the state of the grammar checker for each text range, begins at this offset. If lcbPlcfGram is zero, then + fcPlcfGram is undefined and MUST be ignored. + + + The fc PLCF gram. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Plcfgram that begins at offset + fcPlcfGram in the Table Stream. + + + The LCB PLCF gram. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A SttbListNames, which + specifies the LISTNUM field names of the lists in the document, begins at this offset. + + + The fc STTB list names. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbListNames at the offset + fcSttbListNames. + + + The LCB STTB list names. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated, version-specific undo + information at offset fcSttbfUssr in the Table Stream. + + + The LCB STTBF ussr. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcfTch at offset fcPlcfTch. + + + The LCB PLCF TCH. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An RmdThreading that specifies the data concerning the e-mail + messages and their authors in this document begins at this offset. + + + The fc RMD threading. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the RmdThreading at the offset fcRmdThreading. This value MUST NOT be zero. + + + The LCB RMD threading. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A double-byte character Unicode string that specifies the + message identifier of the document begins at this offset. This value MUST be ignored. + + + The fc mid. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the double-byte character Unicode string at offset fcMid. This value MUST be ignored. + + + The LCB mid. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A SttbRgtplc that specifies the styles of lists in the document + begins at this offset. If lcbSttbRgtplc is zero, fcSttbRgtplc is undefined and MUST be ignored. + + + The fc STTB RGTPLC. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbRgtplc at the offset fcSttbRgtplc. + + + The LCB STTB RGTPLC. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An MsoEnvelopeCLSID, which specifies the envelope data as + specified by [MS-OSHARED] section 2.3.8.1, begins at this offset. If lcbMsoEnvelope is zero, fcMsoEnvelope is undefined and MUST be ignored. + + + The fc mso envelope. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the MsoEnvelopeCLSID at the offset fcMsoEnvelope. + + + The LCB mso envelope. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A Plcflad begins at this offset and specifies the language + auto-detect state of each text range. If lcbPlcfLad is zero, fcPlcfLad is undefined and MUST be ignored. + + + The fc PLCF lad. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the Plcflad that begins at offset fcPlcfLad in the Table Stream. + + + The LCB PLCF lad. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A variable-length array with elements of type Dofrh begins at that offset. + The elements of this array are records that support the frame set and list style features. If lcbRgDofr is zero, fcRgDofr is undefined and MUST be ignored. + + + The fc rg dofr. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the array that begins at offset fcRgDofr in the Table Stream. + + + The LCB rg dofr. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A PlfCosl begins at the offset. If lcbPlcosl is zero, + fcPlcosl is undefined and MUST be ignored. + + + The fc plcosl. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PlfCosl at offset fcPlcosl in the Table Stream. + + + The LCB plcosl. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PlcfcookieOld at offset fcPlcfcookieOld in the Table Stream. + + + The LCB PLCF cookie old. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated document page layout cache at offset fcPgdMotherOld in the Table Stream. + + + The LCB PGD mother old. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated document text flow break cache at offset fcBkdMotherOld in the Table Stream. + + + The LCB BKD mother old. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated footnote layout cache at offset fcPgdFtnOld in the Table Stream. + + + The LCB PGD FTN old. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated footnote text flow break cache at offset fcBkdFtnOld in the Table Stream. + + + The LCB BKD FTN old. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated endnote layout cache at offset fcPgdEdnOld in the Table Stream. + + + The LCB PGD edn old. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated endnote text flow break cache at offset fcBkdEdnOld in the Table Stream. + + + The LCB BKD edn old. + + + + + Gets or sets the fc unused1. This value is undefined and MUST be ignored. + + + The fc unused1. + + + + + Gets or sets the LCB unused1.This value MUST be zero, and MUST be ignored + + + The LCB unused1. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A PGPArray begins at this offset. + If lcbPlcfPgp is 0, fcPlcfPgp is undefined and MUST be ignored. + + + The fc PLCF PGP. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PGPArray that is stored at offset fcPlcfPgp. + + + The LCB PLCF PGP. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A Plcfuim begins at this offset. + If lcbPlcfuim is zero, fcPlcfuim is undefined and MUST be ignored. + + + The fc plcfuim. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the Plcfuim at offset fcPlcfuim. + + + The LCB plcfuim. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A PlfguidUim begins at this offset. + If lcbPlfguidUim is zero, fcPlfguidUim is undefined and MUST be ignored. + + + The fc plfguid uim. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PlfguidUim at offset fcPlfguidUim. + + + The LCB plfguid uim. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. An AtrdExtra begins at this offset. + If lcbAtrdExtra is zero, fcAtrdExtra is undefined and MUST be ignored. + + + The fc atrd extra. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the AtrdExtra at offset fcAtrdExtra in the Table Stream. + + + The LCB atrd extra. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A PLRSID begins at this offset. + If lcbPlrsid is zero, fcPlrsid is undefined and MUST be ignored. + + + The fc plrsid. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PLRSID at offset fcPlrsid in the Table Stream. + + + The LCB plrsid. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An SttbfBkmkFactoid containing + information about smart tag bookmarks in the document begins at this offset. If lcbSttbfBkmkFactoid is zero, + fcSttbfBkmkFactoid is undefined and MUST be ignored. + + + The fc STTBF BKMK factoid. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the SttbfBkmkFactoid at offset fcSttbfBkmkFactoid. + + + The LCB STTBF BKMK factoid. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfBkfd that contains + information about the smart tag bookmarks in the document begins at this offset. If lcbPlcfBkfFactoid is zero, + fcPlcfBkfFactoid is undefined and MUST be ignored. + + + The fc PLCF BKF factoid. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PlcfBkfd at offset fcPlcfBkfFactoid. + + + The LCB PLCF BKF factoid. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the Plcfcookie at offset fcPlcfcookie in the Table Stream. + + + The LCB plcfcookie. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A Plcfbkld that contains + information about the smart tag bookmarks in the document begins at this offset. If lcbPlcfBklFactoid is zero, + fcPlcfBklFactoid is undefined and MUST be ignored. + + + The fc PLCF BKL factoid. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the Plcfbkld at offset fcPlcfBklFactoid. + + + The LCB PLCF BKL factoid. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A SmartTagData begins + at this offset and specifies information about the smart tag recognizers that are used in this document. + If lcbFactoidData is zero, fcFactoidData is undefined and MUST be ignored. + + + The fc factoid data. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the SmartTagData at offset fcFactoidData in the Table Stream. + + + The LCB factoid data. + + + + + + Gets or sets An unsigned integer. If this value is nonzero, version-specific undo information exists at offset fcDocUndo in the WordDocument Stream. + + + The LCB document undo. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. An SttbfBkmkFcc that contains + information about the format consistency-checker bookmarks in the document begins at this offset. + If lcbSttbfBkmkFcc is zero, fcSttbfBkmkFcc is undefined and MUST be ignored. + + + The fc STTBF BKMK FCC. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the SttbfBkmkFcc at offset fcSttbfBkmkFcc. + + + The LCB STTBF BKMK FCC. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcfBkfd that contains + information about format consistency-checker bookmarks in the document begins at this offset. If lcbPlcfBkfFcc is zero, + fcPlcfBkfFcc is undefined and MUST be ignored. + + + The fc PLCF BKF FCC. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PlcfBkfd at offset fcPlcfBkfFcc. + + + The LCB PLCF BKF FCC. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A PlcfBkld that contains information + about the format consistency-checker bookmarks in the document begins at this offset. If lcbPlcfBklFcc is zero, + fcPlcfBklFcc is undefined and MUST be ignored. + + + The fc PLCF BKL FCC. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PlcfBkld at offset fcPlcfBklFcc. + + + The LCB PLCF BKL FCC. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. An SttbfBkmkBPRepairs + that contains information about the repair bookmarks in the document begins at this offset. If lcbSttbfBkmkBPRepairs + is zero, fcSttbfBkmkBPRepairs is undefined and MUST be ignored. + + + The fc STTBFBKMK bp repairs. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the SttbfBkmkBPRepairs at offset fcSttbfBkmkBPRepairs. + + + The LCB STTBFBKMK bp repairs. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A PlcfBkf that contains + information about the repair bookmarks in the document begins at this offset. If lcbPlcfBkfBPRepairs is zero, + fcPlcfBkfBPRepairs is undefined and MUST be ignored. + + + The fc PLCFBKF bp repairs. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PlcfBkf at offset fcPlcfbkfBPRepairs. + + + The LCB PLCFBKF bp repairs. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A PlcfBkl that contains + information about the repair bookmarks in the document begins at this offset. If lcbPlcfBklBPRepairs is zero, + fcPlcfBklBPRepairs is undefined and MUST be ignored. + + + The fc PLCFBKL bp repairs. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PlcfBkl at offset fcPlcfBklBPRepairs. + + + The LCB PLCFBKL bp repairs. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A new Pms, which contains + the current state of a print merge operation, begins at this offset. If lcbPmsNew is zero, fcPmsNew is + undefined and MUST be ignored. + + + The fc PMS new. + + + + + Gets or sets an unsigned integer which specifies the size, in bytes, of the Pms at offset fcPmsNew. + + + The LCB PMS new. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. Office Data Source Object + (ODSO) data that is used to perform mail merge begins at this offset. The data is stored in an array of + ODSOPropertyBase items. The ODSOPropertyBase items are of variable size and are stored contiguously. + The complete set of properties that are contained in the array is determined by reading each ODSOPropertyBase, + until a total of lcbODSO bytes of data are read. If lcbODSO is zero, fcODSO is undefined and MUST be ignored. + + + The fc odso. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the Office Data Source Object data + at offset fcODSO in the Table Stream. + + + The LCB odso. + + + + + + + + + + + Gets or sets the fc unused2.This value is undefined and MUST be ignored. + + + The fc unused2. + + + + + Gets or sets the LCB unused2.This value MUST be zero, and MUST be ignored. + + + The LCB unused2. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A Plcffactoid, which specifies + the smart tag recognizer state of each text range, begins at this offset. If lcbPlcffactoid is zero, fcPlcffactoid + is undefined and MUST be ignored. + + + The fc plcffactoid. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes of the Plcffactoid that begins at offset + fcPlcffactoid in the Table Stream. + + + The LCB plcffactoid. + + + + + + + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An Hplxsdr structure begins + at this offset. This structure specifies information about XML schema definition references. + + + The fc HPLXSDR. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the Hplxsdr structure at the offset + fcHplxsdr in the Table Stream. If lcbHplxsdr is zero, then fcHplxsdr is undefined and MUST be ignored. + + + The LCB HPLXSDR. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An SttbfBkmkSdt that contains + information about the structured document tag bookmarks in the document begins at this offset. If lcbSttbfBkmkSdt is zero, then fcSttbfBkmkSdt is undefined and MUST be ignored. + + + The fc STTBF BKMK SDT. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the SttbfBkmkSdt at offset + fcSttbfBkmkSdt. + + + The LCB STTBF BKMK SDT. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcBkfd that contains + information about the structured document tag bookmarks in the document begins at this offset. If + lcbPlcfBkfSdt is zero, fcPlcfBkfSdt is undefined and MUST be ignored. + + + The fc PLCF BKF SDT. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcBkfd at offset fcPlcfBkfSdt. + + + The LCB PLCF BKF SDT. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. A PlcBkld that contains + information about the structured document tag bookmarks in the document begins at this offset. If + lcbPlcfBklSdt is zero, fcPlcfBklSdt is undefined and MUST be ignored. + + + The fc PLCF BKL SDT. + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the PlcBkld at offset fcPlcfBklSdt. + + + The LCB PLCF BKL SDT. + + + + + Gets or sets An unsigned integer that specifies an offset in the Table Stream. An array of 16-bit Unicode + characters, which specifies the full path and file name of the XML Stylesheet to apply when saving this + document in XML format, begins at this offset. If lcbCustomXForm is zero, fcCustomXForm is undefined and MUST + be ignored. + + + The fc custom x form. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the array at offset fcCustomXForm in + the Table Stream. This value MUST be less than or equal to 4168 and MUST be evenly divisible by two. + + + The LCB custom x form. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. An SttbfBkmkProt that + contains information about range-level protection bookmarks in the document begins at this offset. If + lcbSttbfBkmkProt is zero, fcSttbfBkmkProt is undefined and MUST be ignored. + + + The fc STTBF BKMK prot. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the SttbfBkmkProt at offset + fcSttbfBkmkProt. + + + The LCB STTBF BKMK prot. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A PlcBkf that contains + information about range-level protection bookmarks in the document begins at this offset. If lcbPlcfBkfProt + is zero, then fcPlcfBkfProt is undefined and MUST be ignored. + + + The fc PLCF BKF prot. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PlcBkf at offset fcPlcfBkfProt. + + + The LCB PLCF BKF prot. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A PlcBkl containing + information about range-level protection bookmarks in the document begins at this offset. If lcbPlcfBklProt + is zero, then fcPlcfBklProt is undefined and MUST be ignored. + + + The fc PLCF BKL prot. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the PlcBkl at offset fcPlcfBklProt. + + + The LCB PLCF BKL prot. + + + + + Gets or sets an unsigned integer that specifies an offset in the Table Stream. A SttbProtUser that specifies + the usernames that are used for range-level protection begins at this offset. + + + The fc STTB prot user. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the SttbProtUser at the offset + fcSttbProtUser. + + + The LCB STTB prot user. + + + + + Gets or sets this value MUST be zero, and MUST be ignored. + + + The fc unused. + + + + + Gets or sets this value MUST be zero, and MUST be ignored. + + + The LCB unused. + + + + + + + + + + + + + + + + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated document page layout + cache at offset fcPgdMother in the Table Stream. + + + The fc PGD mother. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated document text flow + break cache at offset fcBkdMother in the Table Stream. + + + The fc BKD mother. + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated document text flow + break cache at offset fcBkdMother in the Table Stream. + + + The LCB BKD mother. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated document author filter + cache at offset fcAfdMother in the Table Stream. + + + The LCB afd mother. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated footnote layout cache + at offset fcPgdFtn in the Table Stream. + + + The LCB PGD FTN. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated footnote text flow + break cache at offset fcBkdFtn in the Table Stream. + + + The LCB BKD FTN. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated footnote author filter + cache at offset fcAfdFtn in the Table Stream. + + + The LCB afd FTN. + + + + + + Gets or sets an unsigned integer that specifies the size, in bytes, of the deprecated endnote layout cache + at offset fcPgdEdn in the Table Stream. + + + The LCB PGD edn. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated endnote text flow + break cache at offset fcBkdEdn in the Table Stream. + + + The LCB BKD edn. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated endnote author filter + cache at offset fcAfdEdn in the Table Stream. + + + The LCB afd edn. + + + + + + Gets or sets An unsigned integer that specifies the size, in bytes, of the deprecated AFD structure at + offset fcAfd in the Table Stream. + + + The LCB afd. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc PLCFMTHD. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB PLCFMTHD. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc STTBF BKMK move from. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB STTBF BKMK move from. + + + + + Gets or sets This value is undefined and MUST be ignored + + + The fc PLCF BKF move from. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB PLCF BKF move from. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc PLCF BKL move from. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB PLCF BKL move from. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc STTBF BKMK move to. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB STTBF BKMK move to. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc PLCF BKF move to. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB PLCF BKF move to. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc PLCF BKL move to. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB PLCF BKL move to. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc unused1. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB unused1. + + + + + Gets or sets This value is undefined and MUST be ignored + + + The fc unused2. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB unused2. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc unused3. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB unused3. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc STTBF BKMK arto. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB STTBF BKMK arto. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc PLCF BKF arto. + + + + + Gets or sets This value MUST be zero, and MUST be ignored + + + The LCB PLCF BKF arto. + + + + + Gets or sets Undefined and MUST be ignored. + + + The fc PLCF BKL arto. + + + + + Gets or sets MUST be zero, and MUST be ignored. + + + The LCB PLCF BKL arto. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc arto data. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB arto data. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc unused4. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB unused4. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc unused5. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB unused5. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc unused6. + + + + + Gets or sets This value MUST be zero, and MUST be ignored. + + + The LCB unused6. + + + + + Gets or sets This value is undefined and MUST be ignored. + + + + The fc oss theme. + + + + + + Gets or sets This value is undefined and MUST be ignored. + + + The fc color scheme mapping. + + + + + + Gets or sets an unsigned integer that specifies the count of 16-bit values corresponding to fibRgCswNew that follow. + This MUST be one of the following values, depending on the value of nFib. + Value of nFib cswNew + 0x00C1 0 + 0x00D9 0x0002 + 0x0101 0x0002 + 0x010C 0x0002 + 0x0112 0x0005 + + + The CSW new. + + + + + Gets or sets an unsigned integer that specifies the version number of the file format that is used. + This value MUST be one of the following. + 0x00D9 + 0x0101 + 0x010C + 0x0112 + + + The n fib new. + + + + + Gets or sets an unsigned integer that specifies the number of times that this document was incrementally saved since the last full save. This value MUST be between 0 and 0x000F, inclusively. + + + The c quick saves new. + + + + + Gets or sets the lid theme other. + This value is undefined and MUST be ignored. + + + The lid theme other. + + + + + Gets or sets the lid theme far east. + This value is undefined and MUST be ignored. + + + The lid theme fe. + + + + + Gets or sets the lid theme complex script. + This value is undefined and MUST be ignored. + + + The lid theme cs. + + + + + Gets the size of the encoding character. + + + The size of the encoding character. + + + + + Gets or sets the encoding. + + + The encoding. + + + + + Summary description for MD5_CTX. + + + + + + + + + + scratch buffer + + + + + input buffer + + + + + actual digest after MD5Final call + + + + + Updates + + The input buf. + The buffer length. + + + + Finals this instance. + + + + + Stores the digest. + + + + + F(x, y, z) + + The x. + The y. + The z. + + + + + G(x, y, z) + + The x. + The y. + The z. + + + + + H(x, y, z) + + The x. + The y. + The z. + + + + + I(x, y, z) + + The x. + The y. + The z. + + + + + ROTATE_LEFT + + The x. + The n. + + + + + FF + + A. + The b. + The c. + The d. + The x. + The s. + The ac. + + + + GG + + A. + The b. + The c. + The d. + The x. + The s. + The ac. + + + + HH + + A. + The b. + The c. + The d. + The x. + The s. + The ac. + + + + II + + A. + The b. + The c. + The d. + The x. + The s. + The ac. + + + + Transforms the specified inn. + + The inn. + + + + Gets the I. + + The I. + + + + Gets the buffer. + + The buffer. + + + + Gets the input buffer. + + The input buffer. + + + + Gets the digest. + + The digest. + + + + This class contains utility methods used by Word 2007 and Word 2010 Encryption/Decryption implementation. + + + + + Number of iterations used for key generation. + + + + + Name of encryption info stream. + + + + + Name of dataspaces storage. + + + + + Name of dataspace map stream. + + + + + Name of the transform primary stream. + + + + + Name of dataspace info storage. + + + + + Name of transform info storage. + + + + + Name of encrypted package stream. + + + + + Gets the type of the encryption. + + The storage. + + + + + Reads Int32 value from the stream. + + Stream to get data from. + Temporary buffer to put extracted bytes into. + Extracted Int32 value. + + + + Extracts padded unicode string from a stream. + + Stream to get data from. + Extracted string. + + + + Read zero-terminated string from the stream. + + Stream to get string from. + Extracted string (without trailing zero). + + + + Writes Int32 value into the stream. + + Stream to put data into. + Value to write. + + + + Writes padded unicode string from a stream. + + Stream to get data from. + Value to write. + + + + Writes zero-terminated string into the stream. + + Stream to put string into. + Value to write. + + + + Creates key object based on the salt and password. + + Password to use. + Salt to use. + Required key length. + Array with created key. + + + + Creates the agile encryption key. + + The password. + The salt. + The block key. + Length of the key. + The iteration count. + + + + + Encrypts/decrypts buffer with specified method. + + Data to process. + Method to use. + Size of the encryption block. + Modified (encrypted/decrypted) data. + + + + Combines two arrays into one. + + The first buffer to combine. + The second buffer to combine. + Combined array. + + + + Corrects the size. + + The hash buf. + The size. + The padding. + + + + + Concatenates the IV. + + The data. + The IV. + + + + + Compares the array. + + The buffer1. + The buffer2. + + + + + Represents type of the encryption. + + + + + Word 2007 encryption format. + + + + + Word 2010 encryption format. + + + + + Wrong encryption format. + + + + + This class is responsible for decryption of Standard encryption (Word 2007) files. + + + + + Size of the decryption block. + + + + + Dataspace map. + + + + + Encryption info. + + + + + Compound storage that should be decrypted. + + + + + Array containing key data. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Decrypts internal storage. + + Decrypted stream. + + + + Prepares decryptor for actual decryption. + + Compound storage to get required data from. + + + + Checks whether password is correct. + + Password to check. + True if password verification succeeded. + + + + Decrypts specified buffer. + + + + + + + + Extracts transform data from the storage. + + Storage to get data from. + + + + Extracts dataspace map from the storage. + + Storage to get data from. + + + + Extracts TransformInfo from the storage. + + Storage to get data from. + + + + Represents the standard encryption info for Encryption/Decryption of Word documents. + + + + + A Version structure where Version.vMajor MUST be 0x0003, and Version.vMinor MUST be 0x0002. + + + + + A copy of the Flags stored in the EncryptionHeader field of this structure. + + + + + An EncryptionHeader structure that specifies parameters used to encrypt data. + + + + + An EncryptionVerifier structure. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Default constructor. + + + + + Initializes new instance. + + Stream to get data from. + + + + Serializes object into stream. + + Stream to serialize into. + + + + A Version structure where Version.vMajor MUST be 0x0003, and Version.vMinor MUST be 0x0002. + + + + + A copy of the Flags stored in the EncryptionHeader field of this structure. + + + + + An EncryptionHeader structure that specifies parameters used to encrypt data. + + + + + An EncryptionVerifier structure. + + + + + This class used to encrypt data using Standard encryption (Word 2007) with AES 128 + encryption algorithm and SHA-1 hashing algorithm. + + + + + Key length. + + + + + Default version. + + + + + Default flags. + + + + + Encryption algorithm id (AES-128). + + + + + Hashing algorithm id (SHA-1). + + + + + Provider type. + + + + + Default CSP name. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Encrypts specified stream. + + Data to encrypt. + Password to use. + Root storage to put encrypted data into. + + + + Preparse data spaces structures inside specified storage. + + Storage to put DataSpaces inside. + + + + Serializes VersionInfo stream inside specified storage. + + Storage to serialize VersionInfo into. + + + + Serializes transformation info. + + Storage to serialize into. + + + + Serializes dataspace info. + + Storage to serialize into. + + + + Serializes DataSpaceMap stream. + + Storage to place stream into. + + + + Prepare EncryptionInfo record and stores it in appropriate stream. + + Root storage. + Encryption password. + Encryption key. + + + + Creates random salt. + + Desired salt length. + Array with random data. + + + + Encrypts specified buffer. + + Data to encrypt. + Encryption key. + Encrypted data. + + + + Encrypt specified stream. + + Stream to encrypt. + Encryption key. + Output stream. + + + + Represents the transform info header for Encryption/Decryption of Word documents. + + + + + An unsigned integer that specifies the type of transform to be applied. + + + + + An identifier associated with a specific transform. + + + + + The friendly name of the transform. + + + + + The reader version. + + + + + The updater version. + + + + + The writer version. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Default constructor. + + + + + Initializes new instance of the class. + + Stream to get data from. + + + + Serializes object into stream. + + Stream to serialize into. + + + + An unsigned integer that specifies the type of transform to be applied. + + + + + An identifier associated with a specific transform. + + + + + The friendly name of the transform. + + + + + The reader version. + + + + + The updater version. + + + + + The writer version. + + + + + Represents the version information for Encryption/Decryption of Word documents. + + + + + The functionality for which the DataSpaceVersionInfo structure specifies + version information. MUST be "Microsoft.Container.DataSpaces". + + + + + The reader version of the data spaces structure. + + + + + The updater version of the data spaces structure. + + + + + The writer version of the data spaces structure. + + + + + Security helper contains utility methods for encryption/decryption. + + + + + Default constructor. + + + + + Serializes object into specified stream. + + Stream to serialize into. + + + + The functionality for which the DataSpaceVersionInfo structure specifies + version information. MUST be "Microsoft.Container.DataSpaces". + + + + + The reader version of the data spaces structure. + + + + + The updater version of the data spaces structure. + + + + + The writer version of the data spaces structure. + + + + + Represents the xml encryption descriptor for Encryption/Decryption of Word 2010/2013 documents. + + + + + Specifies the key data used for Encryption/Decryption. + + + + + Specifies the data integrity used for Encryption/Decryption. + + + + + Specifies the key encryptors used for Encryption/Decryption. + + + + + Default constructor. + + + + + Parses the specified stream. + + The stream. + + + + Serializes object into stream. + + Stream to serialize into. + + + + Create xml writer + + The stream + returns the xml writer + + + + Gets or sets the key data. + + The key data. + + + + Gets or sets the data integrity. + + The data integrity. + + + + Gets or sets the key encryptors. + + The key encryptors. + + + + Represents the key data for Encryption/Decryption of Word 2010 documents. + + + + + Specifies the number of bytes used by salt. + + + + + Specifies the number of bytes used to encrypt one block of data. + + + + + Specifies the number of bits used by encryption algorithm. + + + + + Specifies the number of bytes used by hash value. + + + + + Specifies the cipher algorithm. + + + + + Specifies the chaining mode used by the cipher algorithm. + + + + + Specifies the hashing algorithm. + + + + + Specifies the salt value. + + + + + Default constructor. + + + + + Parses the specified reader. + + The reader. + + + + Serializes the specified writer. + + The writer. + + + + Gets or sets the size of the salt. + + The size of the salt. + + + + Gets or sets the size of the block. + + The size of the block. + + + + Gets or sets the key bits. + + The key bits. + + + + Gets or sets the size of the hash. + + The size of the hash. + + + + Gets or sets the cipher algorithm. + + The cipher algorithm. + + + + Gets or sets the cipher chaining. + + The cipher chaining. + + + + Gets or sets the hash algorithm. + + The hash algorithm. + + + + Gets or sets the salt. + + The salt. + + + + Represents the data integrity for Encryption/Decryption of Word 2010 documents. + + + + + Specifies an encrypted key used for generating the encryptedHmacValue. + + + + + Specifies an HMAC derived from the encryptedHmacKey and the encrypted data. + + + + + Default constructor. + + + + + Parses the specified reader. + + The reader. + + + + Serializes the specified writer. + + The writer. + + + + Gets or sets the encrypted hmac key. + + The encrypted hmac key. + + + + Gets or sets the encrypted hmac value. + + The encrypted hmac value. + + + + Represents the key encryptors for Encryption/Decryption of Word 2010 documents. + + + + + Specifies encrypted key used for Encryption/Decryption. + + + + + Default constructor. + + + + + Parses the specified reader. + + The reader. + + + + Serializes the specified writer. + + The writer. + + + + Gets or sets the encrypted key. + + The encrypted key. + + + + Represents the encrypted key for Encryption/Decryption of Word 2010 documents. + + + + + Specifies the spin count + + + + + Specifies the number of bytes used by salt. + + + + + Specifies the number of bytes used to encrypt one block of data. + + + + + Specifies the number of bits used by encryption algorithm. + + + + + Specifies the number of bytes used by hash value. + + + + + Specifies the cipher algorithm. + + + + + Specifies the chaining mode used by the cipher algorithm. + + + + + Specifies the hashing algorithm. + + + + + Specifies the salt value. + + + + + Specifies the encrypted verifier hash input used in password verification. + + + + + Specifies the encrypted verifier hash value used in password verification. + + + + + Specifies the encrypted form of the intermediate key. + + + + + Default constructor. + + + + + Parses the specified reader. + + The reader. + + + + Serializes the specified writer. + + The writer. + + + + Gets or sets the spin count. + + The spin count. + + + + Gets or sets the size of the salt. + + The size of the salt. + + + + Gets or sets the size of the block. + + The size of the block. + + + + Gets or sets the key bits. + + The key bits. + + + + Gets or sets the size of the hash. + + The size of the hash. + + + + Gets or sets the cipher algorithm. + + The cipher algorithm. + + + + Gets or sets the cipher chaining. + + The cipher chaining. + + + + Gets or sets the hash algorithm. + + The hash algorithm. + + + + Gets or sets the salt. + + The salt. + + + + Gets or sets the encrypted verifier hash input. + + The encrypted verifier hash input. + + + + Gets or sets the encrypted verifier hash value. + + The encrypted verifier hash value. + + + + Gets or sets the encrypted key value. + + The encrypted key value. + + + + Prefix for DocPropsVTypes namespace. + + + + + Name of the relation type that indicates XSI part. + + + + + Prefix for core properties namespace. + + + + + Name of the relation type that indicates dublin core part. + + + + + Prefix for dublin core namespace. + + + + + Name of the relation type that indicates dublin core terms part. + + + + + Prefix for dublin core terms namespace. + + + + + Name of the relation type that indicates DCMIType part. + + + + + Name of the relation type that indicates that part contains extended document properties. + + + + + Name of the relation type that indicates that part contains core properties. + + + + + Writes the theme override. + + XML writer instance + Baseslide theme collection + + + + Serializes the Theme override elements. + + XML writer instance + Baseslide theme collection + + + + Serializes extended document properties. + + XmlWriter to serialize extended properties into. + + + + Serializes core properties into XmlWriter. + + XmlWriter to serialize core properties into. + + + + Serializes created and modified datetime element into XmlWriter. + + XmlWriter to serialize into. + Element tag name. + Date time value. + + + + Serializes custom properties into XmlWriter. + + XmlWriter to serialize properties into. + + + + Serializes attribute if it differs from default value. + + XmlWriter to serialize into. + Attribute name. + Attribute value. + Default value. + + + + Serializes attribute if it differs from default value. + + XmlWriter to serialize into. + Attribute name. + Attribute value. + Default value. + + + + Serializes custom property into XmlWriter. + + XmlWriter to serialize into. + Custom property to serialize. + Custom property id. + + + + Serialize the extension list properties + + + + + + + Serialize the NonVisual SmartArtPoint properties + + + + + + + Adds a relation to the layout slide with specified number and master slide. + + The relation id of the layout slide. + The master slide of the layout slide. + The collection of relations after adding the relation. + + + + Generates the layout number. + + + + + Adds a layout slide at the end of the collection. + + Represents an instance to be added. + + + + Creates an instance with the specified and layout name, then adds it to the collection. + + The layout type to customize + The custom name of the layout slide + Returns the created layout slide with specified name and type + + + + Inserts an element into the layout slide collection at the specified index. + + The zero-based index at which value should be inserted. + The layout slide item to insert. + + + + Inserts an element into the layout slide collection at the specified index. + + The zero-based index at which value should be inserted. + The layout slide item to insert. + + + + Inserts a layout slide into the collection at the specified index. + + The zero-based index at which the layout slide should be inserted. + The layout slide to insert into the collection. + The type of the layout slide. + The name of the layout slide. + The inserted layout slide. + + + + Generates a unique layout ID. + + A string representing the generated layout ID. + + + + Sorts the string list in ascending order. + + The string list to be sorted. + The largest value among the list. + + + + Remove a layout slide relation from the master slide and presentation document. + + Represent the layout slide to remove. + + + + Gets a LayoutSlide collection with respect to its SlideLayoutType. + + Represent a SlideLayoutType to select. + Returns a LayoutSlide collection with respect to its SlideLayoutType. + + + + Gets a LayoutSlide collection with respect to its LayoutSlide name. + + Represent a LayoutSlide name to select. + Returns a LayoutSlide collection with respect to its LayoutSlide name + + + + Filter (Remove) a LayoutSlide based on available PlaceHolders. + + Represent a PlaceHolderType to compare. + Represent a LayoutSlide collection to filter. + + + + Gets a equivalent LayoutSlide from a destination Presentation. + + Represent a source LayoutSlide to compare. + Returns a equivalent LayoutSlide from a destination Presentation. + + + + Adds a master slide at the end of the collection. + + Represents an instance to be added. + + + + Inserts the master slide to the collection at the specified index. + + Represents index position at which the master slide should be inserted. + Represents the master slide to be inserted. + + + + Inserts the master slide to the collection at the specified index. + + Represents index position at which the master slide should be inserted. + Represents the master slide to be inserted. + + + + Clears the master slides collection. + + + + + Remove the MasterSlide from PowerPoint document. + + Represent a master slide to remove. + + + + Add the master slide to the collection at the specified index. + + Represents index position at which the master slide should be inserted. + Represents the master slide to be inserted. + Represents the source Presentation. + + + + Updates the VML drawing relations for a master slide and its associated layout slides, + if they contain OLE objects with VML drawing. + + The master slide whose VML drawing relations need to be updated. + + + + Updates the layout slide relation. + + + + + + Check whether the relation need to be removed. + + Represents the string value to be checked. + Returns true if the string does not contains the keywords; otherwise false + + + + Updates the master slide theme relation. + + + + + + Updates the layout slide id and gets the master slide id. + + Represents the master slide. + Returns the new master slide id. + + + + Sorts the list. + + Represents the list to be sorted. + Returns the largest value of the list. + + + + Sort the layout slide list. + + Represents the layout slide list. + + + + Adds a new notes to the slide. + + Returns the notes slide of instance. + + + + Removes the notes slide. + + + + + Gets the Unique ID for the current slide. Read-only. The Unique ID ranges from 256 to 2147483647. + + + + + Gets the number of the current slide. Read-only. + + + + + Gets the current notes slide instance. Returns null if no notes are present. + + + + + Adds the specified cloned slide at the end of slide collection with specified paste options. + + An instance to be added to the destination presentation. + Specifies the for merging the slide. + Optional Parameter. An instance of the source presentation from which the slide is cloned from. + The cloned slide can be added within the same presentation or this can be done between one presentation to another + + + + Updates the comments author in the destination document. + + The cloned slide. + + If the source document author is not present in the destination, a source author will be newly added to the destination and linked with the cloned comment. + Otherwise, if the source document author is present in the destination, the cloned comment is linked with the same author in the destination. + + + + + Checks if a given master slide and layout slide have related master and layout slides in a presentation. + + The source master slide to compare. + The source layout slide to compare. + Related master slide number. + True if a related master and layout are found; otherwise, false. + + + + Updates the properties of each paragraph within shapes in the presentation. + + The source presentation containing the shapes. + The collection of shapes to inspect. + + + + Inserts an element into the slide collection at the specified index. + + The zero-based index at which value should be inserted. + The slide value to insert. + + + + Adds the specified cloned slide at the specified index of slide collection with specified paste options. + + Specifies the index position of the slide in which the cloned slide should get added + An instance to be added to the destination presentation. + Specifies the for merging the slide. + Optional Parameter. An instance of the source presentation from which the slide is cloned from. + The cloned slide can be added within the same presentation or this can be done between one presentation to another + + + + Updates the layout slide relationship of the slide. + + Represents the master slide. + The slide to be updated with the layout slide relation. + + + + Compares the current SlideSize object with given SlideSize object. + + The SlideSize object to compare with the current instance. + True if the SlideSize objects are equal; otherwise, false. + + + + Checks whether all the cell borders are applied + + Return false if any one cell border was not applied + + + + Sets a default line for cell borders + + + + + Gets the column index from the specified cell index. + + Represent the index of a cell. + Return the column index of the cell. + + + + Gets the row index from the specified cell index. + + Represent the index of a cell. + Return the row index of the cell. + + + + Creates a copy of the current cell. + + Returns the cloned cell object + + + + If the column is passed from another table or another slide Sets the parent as the current base slide + + Represents the column object + + + + Creates a copy of the current row. + + Returns the cloned row object + + + + If the row is passed from another table or from another slide Sets the parent as the current base slide + + Represents the row object + + + + Gets the adjacent cell border for the current border. + + Represent the current cell index. + Represent the current border type. + Returns the adjacent cell border + + + + Compares the current Shape object with given Shape object. + + The Shape object to compare with the current instance. + True if the Shape objects are equal; otherwise, false. + + + + Creates a copy of the current table. + + Returns the cloned table object + + + + Retrieves the font name based on the specified theme and font reference index. + + + + + + + Compares the current DefaultFonts object with given DefaultFonts object. + + The DefaultFonts object to compare with the current instance. + True if the DefaultFonts objects are equal; otherwise, false. + + + + Compares the current Theme object with given Theme object. + + The Theme object to compare with the current instance. + True if the Theme objects are equal; otherwise, false. + + + + Compares the theme colors in the current theme color dictionary with given theme color dictionary. + + The dictionary representing the theme color list to compare with the current instance. + True if the theme colors in the dictionaries are equal; otherwise, false. + + + + Compares the fills in the current fill list with given fill list. + + The list representing the fill list to compare with the current instance. + True if the fills in the lists are equal; otherwise, false. + + + + Compares the background fills in the current fill list with given fill list. + + The list representing the fill list to compare with the current instance. + True if the background fills in the lists are equal; otherwise, false. + + + + Compares the line formats in the current line format list with given line format list. + + The list representing the line format list to compare with the current instance. + True if the line formats in the lists are equal; otherwise, false. + + + + Compares the effect styles in the current effect style list with given effect style list. + + The list representing the effect style list to compare with the current instance. + True if the effect styles in the lists are equal; otherwise, false. + + + + Name of the theme. + + + + + Name of the color scheme. + + + + + Represents the conversion utilities. + + + + UtilityMethods utility = new UtilityMethods(); + //Convert emu to inch + double inch = UtilityMethods.EmuToInch(234); + //Convert emu to point + double point = UtilityMethods.EmuToPoint(234); + //Convert inch to emu + double emu = UtilityMethods.InchToEmu(12); + //Convert inch to pixel + float pixel = UtilityMethods.InchToPixel(34); + //convert inch to point + float inchToPoint = UtilityMethods.InchToPoint(540); + //Convert point to emu + double pointToEmu = UtilityMethods.PointToEmu(45.89); + //Convert point to pixel + double pointToPixel = UtilityMethods.PointToPixel(786.90); + + + Dim utility As New UtilityMethods() + 'Convert emu to inch + Dim inch As Double = UtilityMethods.EmuToInch(234) + 'Convert emu to point + Dim point As Double = UtilityMethods.EmuToPoint(234) + 'Convert inch to emu + Dim emu As Double = UtilityMethods.InchToEmu(12) + 'Convert inch to pixel + Dim pixel As Single = UtilityMethods.InchToPixel(34) + 'convert inch to point + Dim inchToPoint As Single = UtilityMethods.InchToPoint(540) + 'Convert point to emu + Dim pointToEmu As Double = UtilityMethods.PointToEmu(45.89) + 'Convert point to pixel + Dim pointToPixel As Double = UtilityMethods.PointToPixel(786.9) + + + + + + Creates xml reader to read data from the stream. + + Data to read. + Created xml reader. + + + + Creates xml reader to read data from the stream. + + Data to read. + + Created xml reader. + + + + Check whether input XML document is in valid structure + + Represent the input XML document stream + Return whether this is an valid XML or not + + + + Creates xml writer to read data from the stream. + + Data to read. + Created xml writer. + + + + Convert and returns the given word as Regex pattern + + + + + Regex pattern + + + + Converts the specified Emu unit to the equivalent Point unit. + + Specifies the value in Emu unit. + Returns the value in Point unit. + + + + Converts the specified Emu unit to the equivalent Inch unit. + + Specifies the value in Emu unit. + Returns the value in Inch unit. + + + + Converts the specified Inch unit to the equivalent Emu unit. + + Specifies the value in Inch unit. + Returns the value in Emu unit. + + + + Converts the specified Point unit to the equivalent Emu unit. + + Specifies the value in Point unit. + Returns the value in Emu unit. + + + + Converts the specified Inch unit to the equivalent Point unit. + + Specifies the value in Inch unit. + Returns the value in Point unit. + + + + Converts the specified Inch unit to the equivalent Pixel unit. + + Specifies the value in Inch unit. + Returns the value in Pixel unit. + + + + Converts the specified Emu unit to the equivalent Point unit. + + Specifies the value in Emu unit. + Returns the value in Point unit. + + + + Converts the specified Point unit to the equivalent Pixel unit. + + The value to convert. + Returns the converted value in Pixel unit. + 1 inch equals 72 points. + + + + This interface represents stream in the compound file. + + + + + Name of the stream. + + + + + Initializes new instance of the compound stream object. + + Name of the stream. + + + + Copies stream content into another stream object. + + Stream to copy data into. + + + + Returns name of the stream. + + + + + This interface gives access to compound file functionality. + + + + + Flushes content into internal buffer. + + + + + Saves compound file into stream + + Stream to save data into. + + + + Saves compound file into file. + + Name of the file to save into. + + + + Returns root storage object for this file. + + + + + This interface represents storage object in the compound file. + + + + + Creates new stream inside this storage. + + Name of the stream to create. + Created stream object. + + + + Opens existing stream inside this storage. + + Name of the stream to open. + + + + + Removes existing stream from this storage. + + Name of the stream to remove. + + + + Determines whether storage contains specified stream. + + Name of the stream to check. + true if storage contains specified stream. + + + + Creates new substorage inside this one. + + Name of the storage to create. + Created storage object. + + + + Opens existing substorage inside this one. + + Name of the storage to open. + Created storage object. + + + + Removes exisiting substorage from this one. + + Name of the storage to remove. + + + + Determines whether this storage contains substorage with specified name. + + Name of the storage to check. + true if storage contains substorage with specified name. + + + + Commits changes. + + + + + Inserts copy of the storage and all subitems inside current storage. + + Storage to copy. + + + + Inserts copy of the stream inside current storage. + + Stream to copy. + + + + Returns all stream names that are placed inside this stream. + + + + + Returns all storage names that are placed inside this stream. + + + + + Returns name of the storage. + + + + + .Net compound file implementation. + + + + + Name of the root entry. + + + + + Source stream. + + + + + File header. + + + + + + + + + + + + + + + + + + + + Root storage. + + + + + Short stream. + + + + + Stream containing items described by minifat. + + + + + MiniFAT. + + + + + Indicates whether substreams should maintain their own stream or should write + directly into the file's stream. + + + + + + + + + + Writes directory structure into file. + + Destination path. + Directory to write. + + + + Writes storage to specified path + + Destination path. + Storage to write. + + + + Writes stream into file + + Destination path. + Stream name. + Parent storage object. + + + + Default constructor. + + + + + Default constructor. + + + + + Default constructor. + + + + + + + + + + + Initializes internal variables. + + + + + + + + + + + + + + + + + + + + + Sets stream data for directory entry. + + Directory entry to update stream data for. + Stream to set. + + + + Sets entrie's long stream. + + Entry to update data for. + Data to set. + + + + Sets entrie's short stream. + + Entry to update data for. + Data to set. + + + + Writes stream data into compound file main stream + + Main stream to write into. + Start sector to write. + Stream to write. + Fat object. + + + + Here we have to allocate required sectors number. + + Entry to allocate sectors for. + Number of already allocated sectors. + Number of required sectors. + FAT object. + + + + Allocates sectors. + + Start sector in the chain. + Number of already allocated sectors. + Number of required sectors. + Fat object. + Start sector of the added chain. + + + + Gets offset to the sector. + + Zero-based sector index. + Sector shift (2^sectorShift = sector size). + Offset to the required sector. + + + + Gets offset to the sector. + + Zero-based sector index. + Sector shift (2^sectorShift = sector size). + Size of the header. + Offset to the required sector. + + + + Checks whether stream header belongs to compound file. + + Stream to check. + True if stream probably contains compound file data. + + + + Allocates new directory entry. + + Name of the stream. + Entry type. + Created directory entry. + + + + Marks item as free. + + Directory entry to be removed/freed. + + + + Reads data from internal stream. + + Entry to read data from. + Position inside entry stream. + Buffer that will cotain read data. + Size of the data to read. + Number of actually read bytes. + + + + Writes data into internal stream. + + Entry to write data into. + Position inside entry stream. + Buffer containing data to write. + Offset inside buffer to the data to write. + Size of the data to write. + + + + Saves compound file into stream. + + Stream to save data into. + + + + Writes internal stream into specified one. + + Destination stream to write into. + + + + Saves mini stream data. + + + + + Serializes directory entries. + + + + + Saves compound file into file. + + Name of the file to save into. + + + + Performs application-defined tasks associated with freeing, + releasing, or resetting unmanaged resources. + + + + + + + + + + + + + + + Returns root storage. + + + + + + + + + + + + + + + Returns base stream. Read-only. + + + + + Gets or sets value indicating whether substreams should maintain their own stream + or should write directly into the file's stream. + + + + + Returns root storage object for this file. + + + + + This is exception thrown when experiencing problems with compound file. + + + + + Default exception message. + + + + + Default constructor. + + + + + Initializes new instance of the exception. + + Exception message. + + + + + + + + + RBTree with child elements. + + + + + + + + + + Initializes new instance of the storage. + + Parent file. + Name of the new storage. + Index to the directory entry that stores storage information. + + + + Initializes new instance of the storage. + + Parent compound file object. + Entry that describes current storage. + + + + + + + + + + Creates new stream. + + Name of the stream to create. + Created stream. + + + + Opens stream. + + Name of the stream to open. + Opened stream or null if there is no such stream. + + + + Removes stream from the storage, if it contains stream with such name. + + Stream name to delete. + + + + Checks whether storage contains stream with specified name. + + Name of the stream to check. + True if storage has stream with such name; false otherwise. + + + + Opens existing storage. + + Name of the storage to open. + Opened storage item or null if it was impossible to open it. + + + + Removes substorage from existing storage. + + Name of the storage to remove. + + + + + + + + + Checks whether this storage contains substorage with specified name. + + Name to check. + True if there is such storage; false otherwise. + + + + + + + + + Returns directory entry id that corresponds to the specified node. + + + + + + + Returns name of the storage. + + + + + Returns directory entry for this stream. + + + + + This is wrapper over compound stream object. Simply redirects all calls to it + with one exception - it doesn't dispose underlying stream object. + + + + + Wrapped storage object. + + + + + Initializes new instance of the wrapper. + + Object to wrap. + + + + Frees all allocated resources. + + + + + Creates new stream inside this storage. + + Name of the stream to create. + Created stream object. + + + + Opens existing stream inside this storage. + + Name of the stream to open. + + + + + Removes existing stream from this storage. + + Name of the stream to remove. + + + + Determines whether storage contains specified stream. + + Name of the stream to check. + true if storage contains specified stream. + + + + Creates new substorage inside this one. + + Name of the storage to create. + Created storage object. + + + + Opens existing substorage inside this one. + + Name of the storage to open. + Created storage object. + + + + Removes exisiting substorage from this one. + + Name of the storage to remove. + + + + Determines whether this storage contains substorage with specified name. + + Name of the storage to check. + true if storage contains substorage with specified name. + + + + Commits changes. + + + + + Returns all stream names that are placed inside this stream. + + + + + Returns all storage names that are placed inside this stream. + + + + + Returns name of the storage. + + + + + Returns directory entry for this stream. + + + + + .Net implementation of the compound stream. + + + + + .Net implementation of the compound stream. + + + + + Parent file item. + + + + + Directory entry of this stream. + + + + + Stream with data. If it is null, then data hasn't been read yet or stream is closed. + + + + + Initializes new instance of the stream. + + Parent file object. + Entry that describes this stream item. + + + + + + + + + Reads a sequence of bytes from the current stream and advances the position + within the stream by the number of bytes read. + + An array of bytes. When this method returns, the buffer + contains the specified byte array with the values between offset and + (offset + count - 1) replaced by the bytes read from the current source. + The zero-based byte offset in buffer at which to begin + storing the data read from the current stream. + The maximum number of bytes to be read from the current stream. + The total number of bytes read into the buffer. This can be less than + the number of bytes requested if that many bytes are not currently available, + or zero (0) if the end of the stream has been reached. + + + + writes a sequence of bytes to the current stream and advances the current + position within this stream by the number of bytes written. + + An array of bytes. This method copies count bytes + from buffer to the current stream. + The zero-based byte offset in buffer at which to + begin copying bytes to the current stream. + The number of bytes to be written to the current stream. + + + + Sets the position within the current stream. + + A byte offset relative to the origin parameter. + A value of type SeekOrigin indicating the reference + point used to obtain the new position. + The new position within the current stream. + + + + Sets the length of the current stream. + + The desired length of the current stream in bytes. + + + + Causes any buffered data to be written to the underlying compound file. + + + + + Releases the unmanaged resources used by the Stream and optionally releases the managed resources. + + true to release both managed and unmanaged resources; + false to release only unmanaged resources. + + + + Returns directory entry for this stream. + + + + + Gets the length in bytes of the stream. Read-only. + + + + + Gets or sets the position within the current stream. + + + + + Gets a value indicating whether the current stream supports reading. + + + + + Gets a value indicating whether the current stream supports seeking. + + + + + Gets a value indicating whether the current stream supports writing. + + + + + Stream position. + + + + + Initializes new instance of the stream. + + Parent file object. + Entry that describes this stream item. + + + + + + + + + Reads a sequence of bytes from the current stream and advances the position + within the stream by the number of bytes read. + + An array of bytes. When this method returns, the buffer + contains the specified byte array with the values between offset and + (offset + count - 1) replaced by the bytes read from the current source. + The zero-based byte offset in buffer at which to begin + storing the data read from the current stream. + The maximum number of bytes to be read from the current stream. + The total number of bytes read into the buffer. This can be less than + the number of bytes requested if that many bytes are not currently available, + or zero (0) if the end of the stream has been reached. + + + + writes a sequence of bytes to the current stream and advances the current + position within this stream by the number of bytes written. + + An array of bytes. This method copies count bytes + from buffer to the current stream. + The zero-based byte offset in buffer at which to + begin copying bytes to the current stream. + The number of bytes to be written to the current stream. + + + + Sets the position within the current stream. + + A byte offset relative to the origin parameter. + A value of type SeekOrigin indicating the reference + point used to obtain the new position. + The new position within the current stream. + + + + Sets the length of the current stream. + + The desired length of the current stream in bytes. + + + + Causes any buffered data to be written to the underlying compound file. + + + + + Gets the length in bytes of the stream. Read-only. + + + + + Gets or sets the position within the current stream. + + + + + This is wrapper over compound stream object. Simply redirects all calls to it + with one exception - it doesn't dispose underlying stream object. + + + + + Wrapped stream object. + + + + + Initializes new instance of the wrapper. + + Object to wrap. + + + + Causes any buffered data to be written to the underlying compound file. + + + + + Reads a sequence of bytes from the current stream and advances the position + within the stream by the number of bytes read. + + An array of bytes. When this method returns, the buffer + contains the specified byte array with the values between offset and + (offset + count - 1) replaced by the bytes read from the current source. + The zero-based byte offset in buffer at which to begin + storing the data read from the current stream. + The maximum number of bytes to be read from the current stream. + The total number of bytes read into the buffer. This can be less than + the number of bytes requested if that many bytes are not currently available, + or zero (0) if the end of the stream has been reached. + + + + Sets the position within the current stream. + + A byte offset relative to the origin parameter. + A value of type SeekOrigin indicating the reference + point used to obtain the new position. + The new position within the current stream. + + + + Sets the length of the current stream. + + The desired length of the current stream in bytes. + + + + writes a sequence of bytes to the current stream and advances the current + position within this stream by the number of bytes written. + + An array of bytes. This method copies count bytes + from buffer to the current stream. + The zero-based byte offset in buffer at which to + begin copying bytes to the current stream. + The number of bytes to be written to the current stream. + + + + + + + + + + Gets a value indicating whether the current stream supports reading. + + + + + Gets a value indicating whether the current stream supports seeking. + + + + + Gets a value indicating whether the current stream supports writing. + + + + + Gets the length in bytes of the stream. Read-only. + + + + + Gets or sets the position within the current stream. + + + + + Number of items in the file header. + + + + + List of all fat sector ids. + + + + + List with used Dif sectors. + + + + + Default constructor. + + + + + + + + + + + + Adds required number of DIF sectors. + + Number of sectors to add. + FAT object. + + + + + + + + + This class represents directory structure in the compound file. + + + + + List of directory entries. + + + + + Default constructor. + + + + + Initializes new instance of the directory. + + Data to parse. + + + + Searches for empty entry index. + + Index of the first empty directory entry. + + + + Adds new entry to the collection or replaces existing empty entry with this one. + + Entry to add. + + + + Saves directory entries into specified stream. + + Stream to save directory into. + + + + Returns list of directory entries. + + + + + Represents single directory entry in the compound file. + + + + + Size of a single directory entry. + + + + + Size of the stream name field. + + + + + Entry name. + + + + + Entry type. + + + + + Entry "color" in red-black tree. + + + + + Id of the left-sibling. + + + + + Id of the right-sibling. + + + + + Id of the child acting as the root of all the children of thes element (if entry type if Storage). + + + + + Storage CLSID. + + + + + User flags of this storage. + + + + + Create time-stamp for a storage. + + + + + Modify time-stamp for a storage. + + + + + Starting stream sector. + + + + + Stream size. + + + + + Reserved. Must be zero. + + + + + Entry id. + + + + + Last sector id. + + + + + Initializes new instance of the entry. + + Name of the new entry. + Type of the new entry. + Id of the new entry. + + + + Initializes new instance of the entry. + + Data of the new entry. + Offset to the entry data. + Entry id. + + + + Writes directory entry data inside specified stream. + + Stream to write data into. + + + + Entry name. + + + + + Entry type. + + + + + Entry "color" in red-black tree. + + + + + Id of the left-sibling. + + + + + Id of the right-sibling. + + + + + Id of the child acting as the root of all the children of thes element (if entry type if Storage). + + + + + Storage CLSID. + + + + + User flags of this storage. + + + + + Create time-stamp for a storage. + + + + + Modify time-stamp for a storage. + + + + + Starting stream sector. + + + + + Stream size. + + + + + Reserved. Must be zero. + + + + + Returns entry id. Read-only. + + + + + Possible entry types. + + + + + Invalid entry. + + + + + Entry is storage. + + + + + Entry is stream. + + + + + Root entry. + + + + + The STGTY enumeration values are used in the type member of the STATSTG + structure to indicate the type of the storage element. + + + + + Indicates that the storage element is a storage object. + + + + + Indicates that the storage element is a stream object. + + + + + Indicates that the storage element is a byte-array object. + + + + + Indicates that the storage element is a property storage object. + + + + + The STREAM_SEEK enumeration values specify the origin from which to + calculate the new seek-pointer location. + + + + + The new seek pointer is an offset relative to the beginning of + the stream. In this case, the dlibMove parameter is the new seek + position relative to the beginning of the stream. + + + + + The new seek pointer is an offset relative to the current seek + pointer location. In this case, the dlibMove parameter is the + signed displacement from the current seek position. + + + + + The new seek pointer is an offset relative to the end of the stream. + In this case, the dlibMove parameter is the new seek position + relative to the end of the stream. + + + + + The LOCKTYPE enumeration values indicate the type of locking requested + for the specified range of bytes. + + + + + If this lock is granted, the specified range of bytes can be opened + and read any number of times, but writing to the locked range is + prohibited except for the owner who granted this lock. + + + + + If this lock is granted, writing to the specified range of bytes is + prohibited except by the owner granted this lock. + + + + + If this lock is granted, no other LOCK_ONLYONCE lock can be obtained + on the range. Usually this lock type is an alias for some other lock + type. Thus, specific implementations can have additional behavior + associated with this lock type. + + + + + The STGM enumeration values are used in the IStorage, IStream, and + IPropertySetStorage interfaces. These elements are often combined + using an OR operator. + + + + + Indicates that the object is read-only, meaning that modifications + cannot be made. + + + + + STGM_WRITE lets you save changes to the object, but does not permit + access to its data. + + + + + STGM_READWRITE allows you to both access and modify an object's data. + + + + + Specifies that subsequent openings of the object are not denied read + or write access. If no flag from the sharing group is specified, + this flag is assumed. + + + + + Prevents others from subsequently opening the object in STGM_READ mode. + It is typically used on a root storage object. + + + + + Prevents others from subsequently opening the object for STGM_WRITE + or STGM_READWRITE access. + + + + + Prevents others from subsequently opening the object in any mode. In + transacted mode, sharing of STGM_SHARE_DENY_WRITE or STGM_SHARE_EXCLUSIVE + can significantly improve performance since they don't require snapshotting. + + + + + Opens the storage object with exclusive access to the most recently + committed version. + + + + + Indicates that an existing storage object or stream should be removed + before the new one replaces it. + + + + + Creates the new object while preserving existing data in a stream + named "Contents". + + + + + Causes the create operation to fail if an existing object with the + specified name exists. + + + + + In direct mode, each change to a storage or stream element is + written as it occurs. + + + + + In transacted mode, changes are buffered and written only if an + explicit commit operation is called. + + + + + In transacted mode, a temporary scratch file is usually used to + save modifications until the Commit method is called. + + + + + This flag is used when opening a storage object with STGM_TRANSACTED + and without STGM_SHARE_EXCLUSIVE or STGM_SHARE_DENY_WRITE. + + + + + STGM_SIMPLE is a mode that provides a much faster implementation of + a compound file in a limited, but frequently used case. + + + + + The STGM_DIRECT_SWMR supports direct mode for single-writer, + multireader file operations. + + + + + Indicates that the underlying file is to be automatically destroyed + when the root storage object is released. + + + + + The STGFMT enumeration values specify the format of a storage object + and are used in the StgCreateStorageEx and StgOpenStorageEx functions + in the STGFMT parameter. + + + + + Indicates that the file must be a compound file. + + + + + Indicates that the file must not be a compound file. + + + + + Indicates that the system will determine the file type and use the + appropriate structured storage or property set implementation. + + + + + Indicates that the file must be a compound file and is similar to + the STGFMT_STORAGE flag, but indicates that the compound-file form + of the compound-file implementation must be used. + + + + + Error code which StgOpenStorage method can return after execution. + + + + + Success code. + + + + + Filed. + + + + + Access Denied. + + + + + File already exists. + + + + + File could not be found. + + + + + There is insufficient memory available to complete operation. + + + + + Invalid flag error. + + + + + Unable to perform requested operation. + + + + + Attempted an operation on an invalid object. + + + + + The name is not valid. + + + + + Invalid pointer error. + + + + + A lock violation has occurred. + + + + + The compound file was not created with the STGM_SIMPLE flag. + + + + + The compound file was produced with a newer version of storage. + + + + + The compound file was produced with an incompatible version of storage. + + + + + The path could not be found. + + + + + A share violation has occurred. + + + + + There are insufficient resources to open another file. + + + + + The STGC enumeration constants specify the conditions for performing + the commit operation in the IStorage::Commit and IStream::Commit methods. + + + + + You can specify this condition with STGC_CONSOLIDATE or some + combination of the other three flags in this list of elements. + + + + + The commit operation can overwrite existing data to reduce overall + space requirements. + + + + + Prevents multiple users of a storage object from overwriting each + other's changes. + + + + + Commits the changes to a write-behind disk cache, but does not save + the cache to the disk. + + + + + Microsoft Windows 2000/XP: Indicates that a storage should be + consolidated after it is committed, resulting in a smaller file on disk. + + + + + Reserved global Property IDs. + + + + + PID_DICTIONARY Id. + + + + + PID_CODEPAGE Id. + + + + + PID_FIRST_USABLE Id. + + + + + PID_FIRST_NAME_DEFAULT Id. + + + + + PID_LOCALE Id. + + + + + PID_MODIFY_TIME Id. + + + + + PID_SECURITY Id. + + + + + PID_BEHAVIOR Id. + + + + + PID_ILLEGAL Id. + + + + + PID_MIN_READONLY Id. + + + + + PID_MAX_READONLY Id. + + + + + PRSPEC property ids. + + + + + INVALID Id. + + + + + LPWSTR Id. + + + + + PROPID Id. + + + + + The PROPSPEC structure is used by many of the methods of IPropertyStorage to specify a + property either by its property identifier (ID) or the associated string name. + + + + + Indicates the union member used. This member can be one of the following values. + + + + + Specifies the value of the property ID. Use either this value or the following lpwstr, not both. + + + + + This enumeration is used in VARIANT, TYPEDESC, OLE property sets, and safe arrays. + + + + + Variable type is not specified. + + + + + Variable type is 4-byte signed INT. + + + + + Variable type is date. + + + + + Variable type is binary string. + + + + + Variable type is Boolean; True=-1, False=0. + + + + + Variable type is VARIANT FAR*. + + + + + Variable type is int. + + + + + Variable type is LPSTR. + + + + + Variable type is LPWSTR + + + + + Variable type is FILENAME string. + + + + + Variable type is binary VECTOR. + + + + + Flags for GlobalAlloc function. + + + + + Allocates fixed memory. The return value is a pointer. + + + + + Allocates movable memory. Memory blocks are never moved in physical memory, + but they can be moved within the default heap. + + + + + Initializes memory contents to zero. + + + + + NO Discard memory. + + + + + This class represents FAT object in the compound file. + + + + + + + + + + List with free sectors. + + + + + Sector size. + + + + + + + + + + Default constructor. + + + + + Default constructor. + + + + + Initializes new instance of the fat. + + Parent compound file object. + Stream to extract fat from. + DIF object to help in parsing + File header object. + + + + Gets data of the compound file substream. + + Stream with compound file data. + First sector of the stream to get. + Parent compound file object. + + + + + Gets index of the next sector in the chain. + + Index of the current sector in the chain. + Next sector in the chain. + + + + Closes sectors chain by marking all those sectors as free starting from specified one. + + + + + + Enlarges existing sectors chain. + + Last sector in the chain that requires enlargment. + Number of sectors to add. + Index of the chain start (used when chain wasn't created before). + + + + Frees specified sector. + + Sector to free. + + + + Allocates required number of new sectors. + + Start sector index. + Number of sectors to allocate. + First sector in the new part of the chain. + + + + Allocates required number of free sectors. + + Start sector index (this value points to the last used sector after this operation). + Number of sectors to allocate. + First sector in the new part of the chain + + + + Saves fat data into stream. + + Stream to write fat data into. + DIF object to update after writing. + File header. + + + + Allocates required number of fat sectors. + + Number of sectors that must be allocated. + DIF structure that contains info about fat sectors sequence. + + + + Fills single fat sector. + + Index in the fat to start writing from. + Sector to fill. + First item that wasn't saved inside sector. + + + + Allocates new sector of the specified sector type. + + Sector type to allocate. + Allocated sector index. + + + + Adds single sector to the stream. + + Index of the added sector. + + + + Writes fat data directly into a stream. + + Stream to write data into. + Size of the sector to use for writing. + + + + Evaluates sector offset. + + Zero-based sector index to evaluate offset for. + Offset to the sector start. + + + + Evaluates number of sectors in the sector chain starting from the specified sector. + + Starting sector of the entry to enumerate. + Number of sectros in the sector chain. + + + + Sector size. + + + + + This class represents compound file header. + + + + + Size of the header. + + + + + Signature size. + + + + + Default (and the only supported) signature. + + + + + File signature. + + + + + Class id. + + + + + Minor version of the format. + + + + + Major version of the dll/format. + + + + + Byte order, 0xFFFE for Intel byte-ordering. + + + + + Size of sectors in power-of-two (typically 9). + + + + + Size of mini-sectors in power-of-two (typically 6). + + + + + Reserved, must be zero. + + + + + Reserved, must be zero. + + + + + Reserved, must be zero. + + + + + Number of sectors in the FAT chain. + + + + + First sector in the directory chain. + + + + + Signature used for transactioning, must be zero. + + + + + Maximum size for mini-streams. Typically 4096 bytes. + + + + + First sector in the mini-FAT chain. + + + + + Number of sectors in the mini-FAT chain. + + + + + First sector in the DIF chain. + + + + + Number of sectors in the DIF chain. + + + + + First 109 fat sectors. + + + + + Default constructor. + + + + + Initializes new instance of the file header and extracts data from the stream. + + Stream to extract header data from. + + + + Saves header into specified stream. + + Stream to write header into. + + + + Checks whether starting bytes of the stream are the same as signature of the compound file. + + Stream to check. + True if stream contains required signature. + + + + Checks whether signature is supported. + + + + + Checks whether signature is supported. + + Data to compare with default signature. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Size of the sector. Read-only. + + + + + Minor version of the format. + + + + + Major version of the dll/format. + + + + + Byte order, 0xFFFE for Intel byte-ordering. + + + + + Size of sectors in power-of-two (typically 9). + + + + + Size of mini-sectors in power-of-two (typically 6). + + + + + Reserved, must be zero. + + + + + Reserved, must be zero. + + + + + Reserved, must be zero. + + + + + Number of sectors in the FAT chain. + + + + + First sector in the directory chain. + + + + + Signature used for transactioning, must be zero. + + + + + Maximum size for mini-streams. Typically 4096 bytes. + + + + + First sector in the mini-FAT chain. + + + + + Number of sectors in the mini-FAT chain. + + + + + First sector in the DIF chain. + + + + + Number of sectors in the DIF chain. + + + + + First 109 fat sectors. + + + + + This comparer is used to compare item names inside storage. + + + + + Compares two objects 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. + + Less than zero if x is less than y. + Zero if x equals y. + Greater than zero if x is greater than y. + + + + + Compares two objects 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. + + Less than zero if x is less than y. + Zero if x equals y. + Greater than zero if x is greater than y. + + + + + Suitable Node colors used for 2-3-4 nodes detection. + + + + + Red color of node. + + + + + Black color of node. + + + + + Node class used for proper storing of data in the Map Collection. + + + + + Reference on left branch. + + + + + Reference on right branch. + + + + + Reference on parent branch. + + + + + Color of node branch. + + + + + Is current node Nil element or not? + + + + + Key part of stored in node data. + + + + + Value part of stored in node data. + + + + + Create red colored Tree node. + + Reference on left branch. + Reference on parent branch. + Refernce on right branch. + Key value of node. + Value part of node. + + + + Main constructor of class. + + Reference on left branch. + Reference on parent branch. + Refernce on right branch. + Key value of node. + Value part of node. + Color of node. + + + + Reference on left branch. + + + + + Reference on right branch. + + + + + Reference on parent branch. + + + + + Color of node branch. + + + + + Is current node Nil element or not? + + + + + Key part of stored in node data. + + + + + Value part of stored in node data. + + + + + Is current node set to red color? + + + + + Is current node set to black color? + + + + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + Create collection with specified comparer for Key values. + + Comparer for key values. + + + + Create Empty node for collection. + + + + + Clear collection. + + + + + Add item into collection. + + Key part. + Value. + + + + Check whether collection contains specified key. + + True if node with specified key is found; otherwise False. + Key for check. + + + + Remove from collection item with specified key. + + Key to identify item. + + + + TODO: place correct comment here + + + TODO: place correct comment here + + + + + Get minimum value for specified branch. + + Branch start node. + Reference on minimum value node. + + + + Get maximum value for specified branch. + + Branch start node. + Reference on maximum value node. + + + + Go to to next item in collection. + + Start node. + Reference on next item in collection or this.Empty if nothing found. + + + + Get previous item from collection. + + Start node. + Rererence on previous item in collection. + + + + Find node in collection by key value (search in lower side). + + Key of node to find. + Reference on found node, otherwise this.Empty value. + + + + Find node in collection by key value (search in upper side). + + Key of node to find. + Reference on found node, otherwise this.Empty value. + + + + Rotate branch into left side. + + Branch start node. + + + + Rotate branch into right side. + + Branch start node. + + + + Erase node from collection. + + Item to erase. + + + + Insert item into collection. + + Add into left side of tree or right. + Node for placement. + Key part of node. + Value part of node. + + + + Returns enumerator. + + Returns enumerator of current interface. + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + Contains constants that defines all known sector types. + + + + + Represents the behaviors. + + + + + Get the index of particulare behavior item + + behavior + Index of the particular behavior + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors index + IBehavior behavior = effect.Behaviors[0]; + int index = effect.Behaviors.IndexOf(behavior); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors index + Dim behavior As IBehavior = effect.Behaviors(0) + Dim index As Integer = effect.Behaviors.IndexOf(behavior) + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the count of behavior + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors count from the effect + int count = effect.Behaviors.Count; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).Timeline.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors count from the effect + Dim count As Integer = effect.Behaviors.Count + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Gets a instance at the specified index from the collection. Read-only. + + Determines the index of the behavior. + Returns an instance. + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behavior with index from the effect + IBehavior behavior = effect.Behaviors[0]; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behavior with index from the effect + Dim behavior As IBehavior = effect.Behaviors(0) + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Represents the color offset. + + + + + Get the color offset value0 + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IColorEffect) + { + // Assign the color effect values + IColorEffect colorEffect = (behavior as IColorEffect); + float color1 = colorEffect.By.Value0; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is color effect + If (TypeOf behavior Is ColorEffect) Then + 'Assign the color effect values + Dim colorEffect As ColorEffect = TryCast(behavior,ColorEffect) + Dim color1 As Single = colorEffect.By.Value0 + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the color offset value1 + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IColorEffect) + { + // Assign the color effect values + IColorEffect colorEffect = (behavior as IColorEffect); + float color2 = colorEffect.By.Value1; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is color effect + If (TypeOf behavior Is ColorEffect) Then + 'Assign the color effect values + Dim colorEffect As ColorEffect = TryCast(behavior,ColorEffect) + Dim color2 As Single = colorEffect.By.Value1 + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the color offset value2 + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IColorEffect) + { + // Assign the color effect values + IColorEffect colorEffect = (behavior as IColorEffect); + float color3 = colorEffect.By.Value2; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is color effect + If (TypeOf behavior Is ColorEffect) Then + 'Assign the color effect values + Dim colorEffect As ColorEffect = TryCast(behavior,ColorEffect) + Dim color3 As Single = colorEffect.By.Value2 + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Represents the effect. + + + + + Get the main sequences list of animations + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the sequences from the effect + ISequence effectSequence = effect.Sequence; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the sequences from the effect + Dim effectSequence As ISequence = effect.Sequence + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the build type value of text animation + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the build type from the effect + BuildType effectBuildType = effect.BuildType; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the build type from the effect + Dim effectBuildType As BuildType = effect.BuildType + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the list of behaviors in particular effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors effectBehaviors = effect.Behaviors; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim effectBehaviors As IBehaviors = effect.Behaviors + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the preset class type of effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the preset class type from the effect + EffectPresetClassType effectPresetClass = effect.PresetClassType; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the effect preset class type from the effect + Dim effectPresetClass As EffectPresetClassType = effect.PresetClassType + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the sub type value of effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the subtype from the effect + EffectSubtype effectSubType = effect.Subtype; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the subtype from the effect + Dim effectSubType As EffectSubtype = effect.Subtype + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the timing properties values of effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the timing list from the effect + ITiming effectTiming = effect.Timing; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the timing list from the effect + Dim effectTiming As ITiming = effect.Timing + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the type of effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // Get effect type + EffectType effectType = effect.Type; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get effect type + Dim effectType As EffectType = effect.Type + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Specifies the type of the effect preset class type + + + + + Specifies the effect preset class type is none + + + + + Specifies the effect preset class type is Entrance + + + + + Specifies the effect preset class type is Exit + + + + + Specifies the effect preset class type is Emphasis + + + + + Specifies the effect preset class type is Path + + + + + Specifies the additive type of property + + + + + Specifies the behavior additive type is Not Defined + + + + + Specifies the behavior additive type is None + + + + + Specifies the behavior additive type is Base + + + + + Specifies the behavior additive type is Sum + + + + + Specifies the behavior additive type is Replace + + + + + Specifies the behavior additive type is Multiply + + + + + Specifies the restart type of effect + + + + + Specifies the restart type is Not Defined + + + + + Specifies the restart type is Always + + + + + Specifies the restart type is When Not Active + + + + + Specifies the restart type is Never + + + + + Specifies the trigger type of effect + + + + + Specifies the effect trigger type is After Previous + + + + + Specifies the effect trigger type is On Click + + + + + Specifies the effect trigger type is With Previous + + + + + Specifies the reveal type of filter effect + + + + + Specifies the filter effect reveal type is Not Defined + + + + + Specifies the filter effect reveal type is None + + + + + Specifies the filter effect reveal type is In + + + + + Specifies the filter effect reveal type is Out + + + + + Specifies the subtype of filter effect + + + + + Specifies the filter effect subtype is None + + + + + Specifies the filter effect subtype is Across + + + + + Specifies the filter effect subtype is Down + + + + + Specifies the filter effect subtype is DownLeft + + + + + Specifies the filter effect subtype is DownRight + + + + + Specifies the filter effect subtype is From Bottom + + + + + Specifies the filter effect subtype is From Left + + + + + Specifies the filter effect subtype is From Right + + + + + Specifies the filter effect subtype is From Top + + + + + Specifies the filter effect subtype is Horizontal + + + + + Specifies the filter effect subtype is In + + + + + Specifies the filter effect subtype is InHorizontal + + + + + Specifies the filter effect subtype is InVertical + + + + + Specifies the filter effect subtype is Left + + + + + Specifies the filter effect subtype is Out + + + + + Specifies the filter effect subtype is OutHorizontal + + + + + Specifies the filter effect subtype is OutVertical + + + + + Specifies the filter effect subtype is Right + + + + + Specifies the filter effect subtype is Spokes1 + + + + + Specifies the filter effect subtype is Spokes2 + + + + + Specifies the filter effect subtype is Spokes3 + + + + + Specifies the filter effect subtype is Spokes4 + + + + + Specifies the filter effect subtype is Spokes8 + + + + + Specifies the filter effect subtype is Up + + + + + Specifies the filter effect subtype is UpLeft + + + + + Specifies the filter effect subtype is UpRight + + + + + Specifies the filter effect subtype is Vertical + + + + + Specifies the type of filter effect + + + + + Specifies the filter effect type is None + + + + + Specifies the filter effect type is Barn + + + + + Specifies the filter effect type is Blinds + + + + + Specifies the filter effect type is Box + + + + + Specifies the filter effect type is Checkerboard + + + + + Specifies the filter effect type is Circle + + + + + Specifies the filter effect type is Diamond + + + + + Specifies the filter effect type is Dissolve + + + + + Specifies the filter effect type is Fade + + + + + Specifies the filter effect type is Image + + + + + Specifies the filter effect type is Pixelate + + + + + Specifies the filter effect type is Plus + + + + + Specifies the filter effect type is RandomBar + + + + + Specifies the filter effect type is Slide + + + + + Specifies the filter effect type is Stretch + + + + + Specifies the filter effect type is Strips + + + + + Specifies the filter effect type is Wedge + + + + + Specifies the filter effect type is Wheel + + + + + Specifies the filter effect type is Wipe + + + + + Specifies the type of animation property + + + + + Specifies the animation property type is Not Defined + + + + + Specifies the animation property type is Color + + + + + Specifies the animation property type is PptHeight + + + + + Specifies the animation property type is Opacity + + + + + Specifies the animation property type is Rotation + + + + + Specifies the animation property type is RotationPPT + + + + + Specifies the animation property type is ShapesStrokeColor + + + + + Specifies the animation property type is StrokeOn + + + + + Specifies the animation property type is ShapeFillType + + + + + Specifies the animation property type is ShapeFillBackColor + + + + + Specifies the animation property type is Shape Fill Color + + + + + Specifies the animation property type is Shape Fill Color2 + + + + + Specifies the animation property type is Shape Fill On + + + + + Specifies the animation property type is ShapeFillOpacity + + + + + Specifies the animation property type is ShapeLineColor + + + + + Specifies the animation property type is ShapeLineOn + + + + + Specifies the animation property type is Shape Picture Brightness + + + + + Specifies the animation property type is Shape Picture Contrast + + + + + Specifies the animation property type is Shape Picture Gamma + + + + + Specifies the animation property type is Shape Picture Gray Scale + + + + + Specifies the animation property type is Shape Shadow Color + + + + + Specifies the animation property type is Shape Shadow OffsetX + + + + + Specifies the animation property type is Shape Shadow OffsetY + + + + + Specifies the animation property type is Shape Shadow On + + + + + Specifies the animation property type is Shape Shadow Opacity + + + + + Specifies the animation property type is Shape Shadow Type + + + + + Specifies the animation property type is Text Bullet Character + + + + + Specifies the animation property type is Text Bullet Color + + + + + Specifies the animation property type is Text Bullet Font Name + + + + + Specifies the animation property type is Text Bullet Number + + + + + Specifies the animation property type is Text Bullet Relative Size + + + + + Specifies the animation property type is Text Bullet Style + + + + + Specifies the animation property type is Text Bullet Type + + + + + Specifies the animation property type is Text Font Bold + + + + + Specifies the animation property type is Text Font Color + + + + + Specifies the animation property type is Text Font Emboss + + + + + Specifies the animation property type is Text Font Italic + + + + + Specifies the animation property type is Text Font Name + + + + + Specifies the animation property type is Text Font Shadow + + + + + Specifies the animation property type is Text Font Size + + + + + Specifies the animation property type is Text Font Style + + + + + Specifies the animation property type is Text Font Weight + + + + + Specifies the animation property type is Text Font StrikeThrough + + + + + Specifies the animation property type is Text font Subscript + + + + + Specifies the animation property type is Text font Superscript + + + + + Specifies the animation property type is Text Font Underline + + + + + Specifies the animation property type is Visibility + + + + + Specifies the animation property type is PptWidth + + + + + Specifies the animation property type is PptX + + + + + Specifies the animation property type is PptY + + + + + Specifies the animation property type is PptXPptY + + + + + Specifies the animation property type is XShear + + + + + Specifies the value type of property effect + + + + + Specifies the property value type is NotDefined + + + + + Specifies the property value type is String + + + + + Specifies the property value type is Number + + + + + Specifies the property value type is Color + + + + + Specifies the calcMode type of property effect + + + + + Specifies the property calcMode type is NotDefined + + + + + Specifies the property calcMode type is Discrete + + + + + Specifies the property calcMode type is Linear + + + + + Specifies the property calcMode type is Formula + + + + + Specifies the motion path edit mode + + + + + Specifies the motion path edit mode is NotDefined + + + + + Specifies the motion path edit mode is Relative + + + + + Specifies the motion path edit mode is Fixed + + + + + Specifies the points type of motion path + + + + + Specifies the motion path points type is None + + + + + Specifies the motion path points type is Auto + + + + + Specifies the motion path points type is Corner + + + + + Specifies the motion path points type is Straight + + + + + Specifies the motion path points type is Smooth + + + + + Specifies the motion path points type is CurveAuto + + + + + Specifies the motion path points type is CurveCorner + + + + + Specifies the motion path points type is CurveStraight + + + + + Specifies the motion path points type is CurveSmooth + + + + + Specifies the motion command path type of motion effect + + + + + Specifies the motion command path type is MoveTo + + + + + Specifies the motion command path type is LineTo + + + + + Specifies the motion command path type is CurveTo + + + + + Specifies the motion command path type is CloseLoop + + + + + Specifies the motion command path type is End + + + + + Specifies the origin type of motion effect + + + + + Specifies the motion origin type is NotDefined + + + + + Specifies the motion origin type is Parent + + + + + Specifies the motion origin type is Layout + + + + + Specifies the color direction value for color effect + + + + + Specifies the color direction value is NotDefined + + + + + Specifies the color direction value is ClockWise + + + + + Specifies the color direction value is CounterClockWise + + + + + Specifies the color space value for color effect + + + + + Specifies the color space value is NotDefined + + + + + Specifies the color space value is RGB + + + + + Specifies the color space value is HSL + + + + + Specifies the type of the animation effect + + + + + Specifies the animation effect type is Appear + + + + + Specifies the animation effect type is CurveUpdown + + + + + Specifies the animation effect type is Ascend + + + + + Specifies the animation effect type is Blast + + + + + Specifies the animation effect type is Blinds + + + + + Specifies the animation effect type is Blink + + + + + Specifies the animation effect type is BoldFlash + + + + + Specifies the animation effect type is BoldReveal + + + + + Specifies the animation effect type is Boomerang + + + + + Specifies the animation effect type is Bounce + + + + + Specifies the animation effect type is Box + + + + + Specifies the animation effect type is BrushOnColor + + + + + Specifies the animation effect type is BrushOnUnderline + + + + + Specifies the animation effect type is CenterRevolve + + + + + Specifies the animation effect type is ChangeFillColor + + + + + Specifies the animation effect type is ChangeFont + + + + + Specifies the animation effect type is ChangeFontColor + + + + + Specifies the animation effect type is ChangeFontSize + + + + + Specifies the animation effect type is ChangeFontStyle + + + + + Specifies the animation effect type is ChangeLineColor + + + + + Specifies the animation effect type is Checkerboard + + + + + Specifies the animation effect type is Circle + + + + + Specifies the animation effect type is ColorBlend + + + + + Specifies the animation effect type is ColorTypewriter + + + + + Specifies the animation effect type is ColorWave + + + + + Specifies the animation effect type is ComplementaryColor + + + + + Specifies the animation effect type is ComplementaryColor2 + + + + + Specifies the animation effect type is Compress + + + + + Specifies the animation effect type is ContrastingColor + + + + + Specifies the animation effect type is Crawl + + + + + Specifies the animation effect type is Credits + + + + + Specifies the animation effect type is Custom + + + + + Specifies the animation effect type is Darken + + + + + Specifies the animation effect type is Desaturate + + + + + Specifies the animation effect type is Descend + + + + + Specifies the animation effect type is Diamond + + + + + Specifies the animation effect type is Dissolve + + + + + Specifies the animation effect type is EaseInOut + + + + + Specifies the animation effect type is Expand + + + + + Specifies the animation effect type is Fade + + + + + Specifies the animation effect type is FadedSwivel + + + + + Specifies the animation effect type is FadedZoom + + + + + Specifies the animation effect type is FlashBulb + + + + + Specifies the animation effect type is FlashOnce + + + + + Specifies the animation effect type is Flicker + + + + + Specifies the animation effect type is Flip + + + + + Specifies the animation effect type is Float + + + + + Specifies the animation effect type is Fly + + + + + Specifies the animation effect type is Fold + + + + + Specifies the animation effect type is Glide + + + + + Specifies the animation effect type is GrowAndTurn + + + + + Specifies the animation effect type is GrowShrink + + + + + Specifies the animation effect type is GrowWithColor + + + + + Specifies the animation effect type is Lighten + + + + + Specifies the animation effect type is LightSpeed + + + + + Specifies the animation effect type is Path4PointStar + + + + + Specifies the animation effect type is Path5PointStar + + + + + Specifies the animation effect type is Path6PointStar + + + + + Specifies the animation effect type is Path8PointStar + + + + + Specifies the animation effect type is PathArcDown + + + + + Specifies the animation effect type is PathArcLeft + + + + + Specifies the animation effect type is PathArcRight + + + + + Specifies the animation effect type is PathArcUp + + + + + Specifies the animation effect type is PathBean + + + + + Specifies the animation effect type is PathBounceLeft + + + + + Specifies the animation effect type is PathBounceRight + + + + + Specifies the animation effect type is PathBuzzsaw + + + + + Specifies the animation effect type is PathCircle + + + + + Specifies the animation effect type is PathCrescentMoon + + + + + Specifies the animation effect type is PathCurvedSquare + + + + + Specifies the animation effect type is PathCurvedX + + + + + Specifies the animation effect type is PathCurvyLeft + + + + + Specifies the animation effect type is PathCurvyRight + + + + + Specifies the animation effect type is PathCurvyStar + + + + + Specifies the animation effect type is PathDecayingWave + + + + + Specifies the animation effect type is PathDiagonalDownRight + + + + + Specifies the animation effect type is PathDiagonalUpRight + + + + + Specifies the animation effect type is PathDiamond + + + + + Specifies the animation effect type is PathDown + + + + + Specifies the animation effect type is PathEqualTriangle + + + + + Specifies the animation effect type is PathFigure8Four + + + + + Specifies the animation effect type is PathFootball + + + + + Specifies the animation effect type is PathFunnel + + + + + Specifies the animation effect type is PathHeart + + + + + Specifies the animation effect type is PathHeartbeat + + + + + Specifies the animation effect type is PathHexagon + + + + + Specifies the animation effect type is PathHorizontalFigure8 + + + + + Specifies the animation effect type is PathInvertedSquare + + + + + Specifies the animation effect type is PathInvertedTriangle + + + + + Specifies the animation effect type is PathLeft + + + + + Specifies the animation effect type is PathLoopdeLoop + + + + + Specifies the animation effect type is PathNeutron + + + + + Specifies the animation effect type is PathOctagon + + + + + Specifies the animation effect type is PathParallelogram + + + + + Specifies the animation effect type is PathPeanut + + + + + Specifies the animation effect type is PathPentagon + + + + + Specifies the animation effect type is PathPlus + + + + + Specifies the animation effect type is PathPointyStar + + + + + Specifies the animation effect type is PathRight + + + + + Specifies the animation effect type is PathRightTriangle + + + + + Specifies the animation effect type is PathSCurve1 + + + + + Specifies the animation effect type is PathSCurve2 + + + + + Specifies the animation effect type is PathSineWave + + + + + Specifies the animation effect type is PathSpiralLeft + + + + + Specifies the animation effect type is PathSpiralRight + + + + + Specifies the animation effect type is PathSpring + + + + + Specifies the animation effect type is PathSquare + + + + + Specifies the animation effect type is PathStairsDown + + + + + Specifies the animation effect type is PathSwoosh + + + + + Specifies the animation effect type is PathTeardrop + + + + + Specifies the animation effect type is PathTrapezoid + + + + + Specifies the animation effect type is PathTurnDown + + + + + Specifies the animation effect type is PathTurnRight + + + + + Specifies the animation effect type is PathTurnUp + + + + + Specifies the animation effect type is PathTurnUpRight + + + + + Specifies the animation effect type is PathUp + + + + + Specifies the animation effect type is PathUser + + + + + Specifies the animation effect type is PathVerticalFigure8 + + + + + Specifies the animation effect type is PathWave + + + + + Specifies the animation effect type is PathZigzag + + + + + Specifies the animation effect type is Peek + + + + + Specifies the animation effect type is Pinwheel + + + + + Specifies the animation effect type is Plus + + + + + Specifies the animation effect type is RandomBars + + + + + Specifies the animation effect type is RandomEffects + + + + + Specifies the animation effect type is RiseUp + + + + + Specifies the animation effect type is Shimmer + + + + + Specifies the animation effect type is Sling + + + + + Specifies the animation effect type is Spin + + + + + Specifies the animation effect type is Spinner + + + + + Specifies the animation effect type is Spiral + + + + + Specifies the animation effect type is Split + + + + + Specifies the animation effect type is Stretch + + + + + Specifies the animation effect type is Strips + + + + + Specifies the animation effect type is StyleEmphasis + + + + + Specifies the animation effect type is Swish + + + + + Specifies the animation effect type is Swivel + + + + + Specifies the animation effect type is Teeter + + + + + Specifies the animation effect type is Thread + + + + + Specifies the animation effect type is Transparency + + + + + Specifies the animation effect type is Unfold + + + + + Specifies the animation effect type is VerticalGrow + + + + + Specifies the animation effect type is Wave + + + + + Specifies the animation effect type is Wedge + + + + + Specifies the animation effect type is Wheel + + + + + Specifies the animation effect type is Whip + + + + + Specifies the animation effect type is Wipe + + + + + Specifies the animation effect type is Magnify + + + + + Specifies the animation effect type is Zoom + + + + + Specifies the subtype of animation effect + + + + + Specifies the animation effect Subtype is NotDefined + + + + + Specifies the animation effect Subtype is None + + + + + Specifies the animation effect Subtype is Across + + + + + Specifies the animation effect Subtype is Bottom + + + + + Specifies the animation effect Subtype is BottomLeft + + + + + Specifies the animation effect Subtype is BottomRight + + + + + Specifies the animation effect Subtype is Center + + + + + Specifies the animation effect Subtype is Clockwise + + + + + Specifies the animation effect Subtype is CounterClockwise + + + + + Specifies the animation effect Subtype is GradualAndCycleClockwise + + + + + Specifies the animation effect Subtype is GradualAndCycleCounterClockwise + + + + + Specifies the animation effect Subtype is Down + + + + + Specifies the animation effect Subtype is DownLeft + + + + + Specifies the animation effect Subtype is DownRight + + + + + Specifies the animation effect Subtype is FontAllCaps + + + + + Specifies the animation effect Subtype is FontBold + + + + + Specifies the animation effect Subtype is FontItalic + + + + + Specifies the animation effect Subtype is FontShadow + + + + + Specifies the animation effect Subtype is FontStrikethrough + + + + + Specifies the animation effect Subtype is FontUnderline + + + + + Specifies the animation effect Subtype is Gradual + + + + + Specifies the animation effect Subtype is Horizontal + + + + + Specifies the animation effect Subtype is HorizontalIn + + + + + Specifies the animation effect Subtype is HorizontalOut + + + + + Specifies the animation effect Subtype is In + + + + + Specifies the animation effect Subtype is InBottom + + + + + Specifies the animation effect Subtype is InCenter + + + + + Specifies the animation effect Subtype is InSlightly + + + + + Specifies the animation effect Subtype is Instant + + + + + Specifies the animation effect Subtype is Left + + + + + Specifies the animation effect Subtype is OrdinalMask + + + + + Specifies the animation effect Subtype is Out + + + + + Specifies the animation effect Subtype is OutBottom + + + + + Specifies the animation effect Subtype is OutCenter + + + + + Specifies the animation effect Subtype is OutSlightly + + + + + Specifies the animation effect Subtype is Right + + + + + Specifies the animation effect Subtype is Slightly + + + + + Specifies the animation effect Subtype is Top + + + + + Specifies the animation effect Subtype is TopLeft + + + + + Specifies the animation effect Subtype is TopRight + + + + + Specifies the animation effect Subtype is Up + + + + + Specifies the animation effect Subtype is UpLeft + + + + + Specifies the animation effect Subtype is UpRight + + + + + Specifies the animation effect Subtype is Vertical + + + + + Specifies the animation effect Subtype is VerticalIn + + + + + Specifies the animation effect Subtype is VerticalOut + + + + + Specifies the animation effect Subtype is Wheel1 + + + + + Specifies the animation effect Subtype is Wheel2 + + + + + Specifies the animation effect Subtype is Wheel3 + + + + + Specifies the animation effect Subtype is Wheel4 + + + + + Specifies the animation effect Subtype is Wheel8 + + + + + Specifies the build type value for text animation effect + + + + + Specifies the text animation build type is AsOneObject + + + + + Specifies the text animation build type is AllParagraphsAtOnce + + + + + Specifies the text animation build type is ByLevelParagraphs1 + + + + + Specifies the text animation build type is ByLevelParagraphs2 + + + + + Specifies the text animation build type is ByLevelParagraphs3 + + + + + Specifies the text animation build type is ByLevelParagraphs4 + + + + + Specifies the text animation build type is ByLevelParagraphs5 + + + + + Specifies the command effect type + + + + + Specifies the command effect type is Not Defined + + + + + Specifies the command effect type is event + + + + + Specifies the command effect type is Call + + + + + Specifies the command effect type is verb + + + + + Represents the motion command path. + + + + + Get the command type of motion effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + //Add the line command to move the shape in straight line + PointF[] points = new PointF[1]; + points[0] = new PointF(0, 0.25f); + foreach (IBehavior behavior in behaviors) + { + if (behavior is IMotionEffect) + { + // Assign the motion effect values + IMotionEffect motionEffect = (behavior as MotionEffect); + IMotionPath path = (motionEffect.Path as IMotionPath); + path[0].CommandType = MotionCommandPathType.MoveTo; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As IBehavior In behaviors + 'Check condition for behavior is motion effect + If (TypeOf behavior Is IMotionEffect) Then + 'Assign the motion effect values + Dim motionEffect As IMotionEffect = TryCast(behavior,IMotionEffect) + Dim path As IMotionPath = TryCast(motionEffect.Path, IMotionPath) + path(0).CommandType = MotionCommandPathType.MoveTo + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the relative value + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IMotionEffect) + { + // Assign the motion effect values + IMotionEffect motionEffect = (behavior as IMotionEffect); + IMotionPath path = (motionEffect.Path as IMotionPath); + path[0].IsRelative = false; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As IBehavior In behaviors + 'Check condition for behavior is motion effect + If (TypeOf behavior Is IMotionEffect) Then + 'Assign the motion effect values + Dim motionEffect As IMotionEffect = TryCast(behavior,IMotionEffect) + Dim path As IMotionPath = TryCast(motionEffect.Path, IMotionPath) + path(0).IsRelative = false + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the path values in points + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IMotionEffect) + { + // Assign the motion effect values + IMotionEffect motionEffect = (behavior as IMotionEffect); + IMotionPath path = (motionEffect.Path as IMotionPath); + PointF[] points = path[0].Points; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As IBehavior In behaviors + 'Check condition for behavior is motion effect + If (TypeOf behavior Is IMotionEffect) Then + 'Assign the motion effect values + Dim motionEffect As IMotionEffect = TryCast(behavior,IMotionEffect) + Dim path As IMotionPath = TryCast(motionEffect.Path, IMotionPath) + Dim points As PointF() = path(0).Points + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the points type value of motion effect + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IMotionEffect) + { + // Assign the motion effect values + IMotionEffect motionEffect = (behavior as IMotionEffect); + IMotionPath path = (motionEffect.Path as IMotionPath); + path[0].PointsType = MotionPathPointsType.Auto; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As IBehavior In behaviors + 'Check condition for behavior is motion effect + If (TypeOf behavior Is IMotionEffect) Then + 'Assign the motion effect values + Dim motionEffect As IMotionEffect = TryCast(behavior,IMotionEffect) + Dim path As IMotionPath = TryCast(motionEffect.Path, IMotionPath) + path(0).PointsType = MotionPathPointsType.Auto + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Represents the motion path. + + + + + Add the motion path values into the list + + Motion command path type + Path values in points + Motion path points type + Check bool value of relative coordination + Return the newly added path + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + //Add the line command to move the shape in straight line + PointF[] points = new PointF[1]; + points[0] = new PointF(0, 0.25f); + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IMotionEffect) + { + // Assign the motion effect values + IMotionEffect motionEffect = (behavior as IMotionEffect); + IMotionPath path = (motionEffect.Path as IMotionPath); + path.Add(MotionCommandPathType.LineTo, points, MotionPathPointsType.CurveSmooth, false); + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is motion effect + If (TypeOf behavior Is MotionEffect) Then + 'Assign the motion effect values + Dim motionEffect As MotionEffect = TryCast(behavior,MotionEffect) + Dim path As MotionPath = TryCast(motionEffect.Path, MotionPath) + path.Add(MotionCommandPathType.LineTo, points, MotionPathPointsType.CurveSmooth, false) + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Clear the motion command path values from the list + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IMotionEffect) + { + // Assign the motion effect values + IMotionEffect motionEffect = (behavior as IMotionEffect); + IMotionPath path = (motionEffect.Path as IMotionPath); + path.Clear(); + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is motion effect + If (TypeOf behavior Is MotionEffect) Then + 'Assign the motion effect values + Dim motionEffect As MotionEffect = TryCast(behavior,MotionEffect) + Dim path As MotionPath = TryCast(motionEffect.Path, MotionPath) + path.Clear() + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Insert the motion path into list with particular index. + + Index to insert motion path value + Motion command path type + Path value in pointF type + Motion path points type + Check bool value of relative coordination + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IMotionEffect) + { + // Assign the motion effect values + IMotionEffect motionEffect = (behavior as IMotionEffect); + IMotionPath path = (motionEffect.Path as IMotionPath); + path.Insert(2, MotionCommandPathType.CurveTo, points, MotionPathPointsType.Smooth, false); + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is motion effect + If (TypeOf behavior Is MotionEffect) Then + 'Assign the motion effect values + Dim motionEffect As MotionEffect = TryCast(behavior,MotionEffect) + Dim path As MotionPath = TryCast(motionEffect.Path, MotionPath) + path.Insert(2, MotionCommandPathType.CurveTo, points, MotionPathPointsType.Smooth, false) + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Remove the particular motion command path value + + Command path item to remove from the collection + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IMotionEffect) + { + // Assign the motion effect values + IMotionEffect motionEffect = (behavior as IMotionEffect); + IMotionPath path = (motionEffect.Path as IMotionPath); + path.Remove(path[1]); + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is motion effect + If (TypeOf behavior Is MotionEffect) Then + 'Assign the motion effect values + Dim motionEffect As MotionEffect = TryCast(behavior,MotionEffect) + Dim path As MotionPath = TryCast(motionEffect.Path, MotionPath) + path.Remove(path(1)) + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Remove the particular motion path with index value + + Remove the particular path from collection using index + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IMotionEffect) + { + // Assign the motion effect values + IMotionEffect motionEffect = (behavior as IMotionEffect); + IMotionPath path = (motionEffect.Path as IMotionPath); + path.RemoveAt(0); + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is motion effect + If (TypeOf behavior Is MotionEffect) Then + 'Assign the motion effect values + Dim motionEffect As MotionEffect = TryCast(behavior,MotionEffect) + Dim path As MotionPath = TryCast(motionEffect.Path, MotionPath) + path.RemoveAt(0) + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the count of motion path values + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IMotionEffect) + { + // Assign the motion effect values + IMotionEffect motionEffect = (behavior as IMotionEffect); + IMotionPath path = (motionEffect.Path as IMotionPath); + int pathCount = path.Count; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is motion effect + If (TypeOf behavior Is MotionEffect) Then + 'Assign the motion effect values + Dim motionEffect As MotionEffect = TryCast(behavior,MotionEffect) + Dim path As MotionPath = TryCast(motionEffect.Path, MotionPath) + Dim pathCount As Integer = path.Count + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Gets a instance at the specified index from the collection. Read-only. + + Determines the index of the effect. + Returns an instance. + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IMotionEffect) + { + // Assign the motion effect values + IMotionEffect motionEffect = (behavior as IMotionEffect); + IMotionPath path = (motionEffect.Path as IMotionPath); + IMotionCmdPath motionPath = (path[0] as IMotionCmdPath); + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.PathCrescentMoon, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is motion effect + If (TypeOf behavior Is MotionEffect) Then + 'Assign the motion effect values + Dim motionEffect As MotionEffect = TryCast(behavior,MotionEffect) + Dim path As MotionPath = TryCast(motionEffect.Path, MotionPath) + Dim motionPath As MotionCmdPath = TryCast(path(0), MotionCmdPath) + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Represents the animation points. + + + + + Get the count of points + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Fly, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IPropertyEffect) + { + // Assign the property effect values + IPropertyEffect propertyEffect = (behavior as IPropertyEffect); + IAnimationPoints points = propertyEffect.Points; + int count = points.Count; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Fly, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is property effect + If (TypeOf behavior Is PropertyEffect) Then + 'Assign the property effect values + Dim propertyEffect As PropertyEffect = TryCast(behavior,PropertyEffect) + Dim points As IAnimationPoints = propertyEffect.Points + Dim count As Integer = points.Count + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Gets a instance at the specified index from the collection. Read-only. + + Determines the index of the point. + Returns an instance. + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Fly, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IPropertyEffect) + { + // Assign the property effect values + IPropertyEffect propertyEffect = (behavior as IPropertyEffect); + IAnimationPoint point = propertyEffect.Points[0]; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Fly, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As Behavior In behaviors + 'Check condition for behavior is property effect + If (TypeOf behavior Is PropertyEffect) Then + 'Assign the property effect values + Dim propertyEffect As PropertyEffect = TryCast(behavior,PropertyEffect) + Dim point As IAnimationPoint = propertyEffect.Points(0) + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Represents the animation point. + + + + + Get the formula of point + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Fly, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IPropertyEffect) + { + // Assign the property effect values + IPropertyEffect propertyEffect = (behavior as IPropertyEffect); + IAnimationPoints points = propertyEffect.Points; + points[0].Formula = "0.5"; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Fly, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As IBehavior In behaviors + 'Check condition for behavior is property effect + If (TypeOf behavior Is IPropertyEffect) Then + 'Assign the property effect values + Dim propertyEffect As IPropertyEffect = TryCast(behavior,IPropertyEffect) + Dim points As IAnimationPoints = propertyEffect.Points + points(0).Formula = "0.5" + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the time value of point + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Fly, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IPropertyEffect) + { + // Assign the property effect values + IPropertyEffect propertyEffect = (behavior as IPropertyEffect); + IAnimationPoints points = propertyEffect.Points; + points[1].Time = 90; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Fly, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As IBehavior In behaviors + 'Check condition for behavior is property effect + If (TypeOf behavior Is IPropertyEffect) Then + 'Assign the property effect values + Dim propertyEffect As IPropertyEffect = TryCast(behavior,IPropertyEffect) + Dim points As IAnimationPoints = propertyEffect.Points + points(1).Time = 90 + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the value of point + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Fly, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the behaviors list from the effect + IBehaviors behaviors = effect.Behaviors; + // Get behavior using foreach loop + foreach (IBehavior behavior in behaviors) + { + if (behavior is IPropertyEffect) + { + // Assign the property effect values + IPropertyEffect propertyEffect = (behavior as IPropertyEffect); + IAnimationPoints points = propertyEffect.Points; + points[0].Value = "#ppt_x"; + break; + } + } + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Fly, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the behaviors list from the effect + Dim behaviors As IBehaviors = effect.Behaviors + 'Get behavior using foreach loop + For Each behavior As IBehavior In behaviors + 'Check condition for behavior is property effect + If (TypeOf behavior Is IPropertyEffect) Then + 'Assign the property effect values + Dim propertyEffect As IPropertyEffect = TryCast(behavior,IPropertyEffect) + Dim points As IAnimationPoints = propertyEffect.Points + points(0).Value = "#ppt_x" + Exit For + End If + Next + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Represents the sequence. + + + + + Add the effect in main sequence + + Shape to apply animation + Animation effect type + Animation Subtype + Trigger type for perform animation + Returns the newly added effect type + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Add the text animation effect in mainsequence + + Shape to apply animation effect + Animation effect type + Animation Subtype + Trigger type to perform animation + Build type for text animation + Returns the newly added animation effect + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Blink, EffectSubtype.None, EffectTriggerType.OnClick, BuildType.AsOneObject); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Blink, EffectSubtype.None, EffectTriggerType.OnClick, BuildType.AsOneObject) + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Clear the effects from mainsequence list + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // clear the mainsequence + ppDoc.Slides[0].Timeline.MainSequence.Clear(); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'clear the mainsequence + ppDoc.Slides(0).TimeLine.MainSequence.Clear() + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the count of applied animation effects on particular shape + + Shape which have animation effect + Returns the animation effect count based on shape + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the effects count by shape + int effectsCount = ppDoc.Slides[0].Timeline.MainSequence.GetCount(shape); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the effects count by shape + Dim effectsCount As Integer = pres.Slides(0).TimeLine.MainSequence.GetCount(shape) + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the effects list by shape in presentation + + Shape which have animation effect + Returns the effects list on particular shape + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the effects list by shape + IEffect[] effects = ppDoc.Slides[0].Timeline.MainSequence.GetEffectsByShape(shape); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the effects list by shape + Dim effects As IEffect() = pres.Slides(0).TimeLine.MainSequence.GetEffectsByShape(shape) + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Insert the effect in sequence using index + + Index to add the effectr + Effect value to add in sequence + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // Insert effect in mainsequence with effect value + ppDoc.Slides[0].Timeline.MainSequence.Insert(1,effect); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'Insert effect in mainsequence with effect value + ppDoc.Slides(0).TimeLine.MainSequence.Insert(1, effect) + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Remove the effect by particular effect item + + Effect item to remove from collection + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // Remove the mainsequence with effect value + ppDoc.Slides[0].Timeline.MainSequence.Remove(effect); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'Remove the mainsequence with effect value + ppDoc.Slides(0).TimeLine.MainSequence.Remove(effect) + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Remove the effect by index + + Index to remove the effect from collection + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // Remove the behavior with index value + ppDoc.Slides[0].Timeline.MainSequence.RemoveAt(0); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'Remove the behavior with index value + ppDoc.Slides(0).TimeLine.MainSequence.RemoveAt(0) + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Remove the effect by using shape + + Shape to remove the animation effects + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // Remove the mainsequence with shape value + ppDoc.Slides[0].Timeline.MainSequence.RemoveByShape(shape); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'Remove the mainsequence with shape value + ppDoc.Slides(0).TimeLine.MainSequence.RemoveByShape(shape); + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the count value of list of main sequence + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the main sequences count from the effect + int mainCount = ppDoc.Slides[0].Timeline.MainSequence.Count; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the main sequences count from the effect + Dim mainCount As Integer = ppDoc.Slides(0).TimeLine.MainSequence.Count + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Gets a instance at the specified index from the collection. Read-only. + + Determines the index of the effect. + Returns an instance. + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the mainsequence effect with index + IEffect mainEffect = ppDoc.Slides[0].Timeline.MainSequence[0]; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the mainsequence effect with index from the effect + Dim mainEffect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence(0) + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the trigger shape value + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.InteractiveSequences.Add(shape).AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the trigger shape from the interactive sequence. + IShape triggerShape = ppDoc.Slides[0].Timeline.InteractiveSequences[0].TriggerShape; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.InteractiveSequences.Add(shape).AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the trigger shape from the interactive sequence. + Dim triggerShape As IShape = ppDoc.Slides(0).TimeLine.InteractiveSequences(0).TriggerShape + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Represents the sequences. + + + + + Add the animation Sequence in sequences collection + + Trigger shape type for animation effect + Returns the new added sequence detail + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 250, 250, 250, 150); + // Add trigger shape on the slide + IShape triggerShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 150, 150, 200, 100); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.InteractiveSequences.Add(triggerShape).AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 250, 250, 250, 150) + 'Add trigger shape on the slide + Dim triggerShape As IShape = slide.Shapes.AddShape(AutoShapeType.Rectangle, 150, 150, 200, 100) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.InteractiveSequences.Add(triggerShape).AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Clear all the animation sequences in slide + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.InteractiveSequences.Add(shape).AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // clear the interactive sequences + ppDoc.Slides[0].Timeline.InteractiveSequences.Clear(); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.InteractiveSequences.Add(shape).AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'clear the interactive sequences + ppDoc.Slides(0).TimeLine.InteractiveSequences.Clear() + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Remove the particular sequence from collection + + Item to remove sequence + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.InteractiveSequences.Add(shape).AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the interactive sequence + ISequence interactiveSequence = ppDoc.Slides[0].Timeline.InteractiveSequences[0]; + // Remove the interactive sequence with effect value + ppDoc.Slides[0].Timeline.InteractiveSequences.Remove(interactiveSequence); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.InteractiveSequences.Add(shape).AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the interactive sequence + Dim interactiveSequence As ISequence = ppDoc.Slides(0).TimeLine.InteractiveSequences(0) + 'Remove the interactive sequence with effect value + ppDoc.Slides(0).TimeLine.InteractiveSequences.Remove(interactiveSequence) + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Remove the particular sequence from collection using index + + Index to remove sequence + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.InteractiveSequences.Add(shape).AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Remove the behavior with index value + ppDoc.Slides[0].Timeline.InteractiveSequences.RemoveAt(0); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.InteractiveSequences.Add(shape).AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Remove the behavior with index value + ppDoc.Slides(0).TimeLine.InteractiveSequences.RemoveAt(0) + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the effects count value + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + IShape shapeTrigger = ppDoc.Slides[0].Shapes.AddShape(AutoShapeType.Bevel, 10, 10, 20, 20); + // Add interactive sequence in slide with trigger shape + ISequence seqInter = ppDoc.Slides[0].Timeline.InteractiveSequences.Add(shapeTrigger); + // Add animation effect on the slide with shape + IEffect bouncePath = seqInter.AddEffect(shape, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the interactive sequences count from the effect + int interactiveCount = ppDoc.Slides[0].Timeline.InteractiveSequences.Count; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + Dim shapeTrigger As IShape = pres.Slides(0).Shapes.AddShape(AutoShapeType.Bevel, 10, 10, 20, 20) + 'Add interactive sequence in slide with trigger shape + Dim seqInter As ISequence = pres.Slides(0).TimeLine.InteractiveSequences.Add(shapeTrigger) + 'Add animation effect on the slide with shape + Dim bouncePath As IEffect = seqInter.AddEffect(ashp, EffectType.Bounce, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the interactive sequences count from the effect + Dim interactiveCount As Integer = ppDoc.Slides(0).TimeLine.InteractiveSequences.Count + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Gets a instance at the specified index from the collection. Read-only. + + Determines the index of the sequence. + Returns an instance. + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.InteractiveSequences.Add(shape).AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the interactive sequences effect with index from the effect + ISequence interactiveSequence = ppDoc.Slides[0].Timeline.InteractiveSequences[0]; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.InteractiveSequences.Add(shape).AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the interactive sequences effect with index from the effect + Dim interactiveSequence As ISequence = ppDoc.Slides(0).TimeLine.InteractiveSequences(0) + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Represents the animation timeline. + + + + + Get the list of interactive sequences from the slide + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.InteractiveSequences.Add(shape).AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.InteractiveSequences.Add(shape).AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the list of main sequence from the slide + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create() + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Represents the timing. + + + + + Get the accelerate value of timing property + + /// + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the Timing properties of effect and assign it in new Timing property + ITiming time = (effect.Timing as ITiming); + // Assign the Set effect Accelerate property + time.Accelerate = 0; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the Timing properties of effect and assign it in new Timing property + Dim time As Timing = TryCast(effect.Timing, Timing) + 'Assign the Set effect Accelerate property + time.Accelerate = 0 + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the auto reverse value of timing property + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the Timing properties of effect and assign it in new Timing property + ITiming time = (effect.Timing as ITiming); + // Assign the Set effect Accelerate property + time.AutoReverse = false; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the Timing properties of effect and assign it in new Timing property + Dim time As Timing = TryCast(effect.Timing, Timing) + 'Assign the Set effect Accelerate property + time.AutoReverse = False + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the decelerate value of timing property + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the Timing properties of effect and assign it in new Timing property + ITiming time = (effect.Timing as ITiming); + // Assign the Set effect Accelerate property + time.Decelerate = 0; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the Timing properties of effect and assign it in new Timing property + Dim time As Timing = TryCast(effect.Timing, Timing) + 'Assign the Set effect Accelerate property + time.Decelerate = 0 + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the duration value of timing property + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the Timing properties of effect and assign it in new Timing property + ITiming time = (effect.Timing as ITiming); + // Assign the Set effect Accelerate property + time.Duration = 25; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the Timing properties of effect and assign it in new Timing property + Dim time As Timing = TryCast(effect.Timing, Timing) + 'Assign the Set effect Accelerate property + time.Duration = 25 + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the repeat count value of timing property + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the Timing properties of effect and assign it in new Timing property + ITiming time = (effect.Timing as ITiming); + // Assign the Set effect Accelerate property + time.RepeatCount = 3; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the Timing properties of effect and assign it in new Timing property + Dim time As Timing = TryCast(effect.Timing, Timing) + 'Assign the Set effect Accelerate property + time.RepeatCount = 3 + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the repeat duration value of timing property + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the Timing properties of effect and assign it in new Timing property + ITiming time = (effect.Timing as ITiming); + // Assign the Set effect Accelerate property + time.RepeatDuration = 2; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the Timing properties of effect and assign it in new Timing property + Dim time As Timing = TryCast(effect.Timing, Timing) + 'Assign the Set effect Accelerate property + time.RepeatDuration = 2 + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the restart value of timing property + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the Timing properties of effect and assign it in new Timing property + ITiming time = (effect.Timing as ITiming); + // Assign the Set effect Accelerate property + time.Restart = EffectRestartType.Always; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the Timing properties of effect and assign it in new Timing property + Dim time As Timing = TryCast(effect.Timing, Timing) + 'Assign the Set effect Accelerate property + time.Restart = EffectRestartType.Always + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the speed value of timing property + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the Timing properties of effect and assign it in new Timing property + ITiming time = (effect.Timing as ITiming); + // Assign the Set effect Accelerate property + time.Speed = 50; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the Timing properties of effect and assign it in new Timing property + Dim time As Timing = TryCast(effect.Timing, Timing) + 'Assign the Set effect Accelerate property + time.Speed = 50 + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the trigger delay time value of timing property + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the Timing properties of effect and assign it in new Timing property + ITiming time = (effect.Timing as ITiming); + // Assign the Set effect Accelerate property + time.TriggerDelayTime = 20; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the Timing properties of effect and assign it in new Timing property + Dim time As Timing = TryCast(effect.Timing, Timing) + 'Assign the Set effect Accelerate property + time.TriggerDelayTime = 20 + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Get the trigger type value of timing property + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add animation effect on the slide with shape + IEffect effect = ppDoc.Slides[0].Timeline.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick); + // Get the Timing properties of effect and assign it in new Timing property + ITiming time = (effect.Timing as ITiming); + // Assign the Set effect Accelerate property + time.TriggerType = EffectTriggerType.OnClick; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + 'Create a new presentation + Dim ppDoc As IPresentation = Presentation.Create + 'Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + 'Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + 'Add animation effect on the slide with shape + Dim effect As IEffect = ppDoc.Slides(0).TimeLine.MainSequence.AddEffect(shape, EffectType.ChangeFillColor, EffectSubtype.None, EffectTriggerType.OnClick) + 'Get the Timing properties of effect and assign it in new Timing property + Dim time As Timing = TryCast(effect.Timing, Timing) + 'Assign the Set effect Accelerate property + time.TriggerType = EffectTriggerType.OnClick + 'Save the presentation file + ppDoc.Save("Sample.pptx") + 'Close the presentation file + ppDoc.Close() + + + + + + Represents the slide show transition. + + + + + Get the Slide Transition Mouse On Click value + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add slide transition effect on the slide + slide.SlideTransition.TransitionEffect = TransitionEffect.PageCurlDouble; + //Set the mouse on click bool value + slide.SlideTransition.TriggerOnClick = true; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + ' Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + ' Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + ' Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + ' Add slide transition effect on the slide + slide.SlideTransition.TransitionEffect = TransitionEffect.PageCurlDouble + ' Set the mouse on click bool value + slide.SlideTransition.TriggerOnClick = true + ' Save the presentation file + ppDoc.Save("Sample.pptx") + ' Close the presentation file + ppDoc.Close() + + + + + + Get the Next Slide Advance Time Check Value + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add slide transition effect on the slide + slide.SlideTransition.TransitionEffect = TransitionEffect.PageCurlDouble; + // Set the next slide advance time bool value + slide.SlideTransition.TriggerOnTimeDelay = true; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + ' Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + ' Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + ' Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + ' Add slide transition effect on the slide + slide.SlideTransition.TransitionEffect = TransitionEffect.PageCurlDouble + ' Set the next slide advance time bool value + slide.SlideTransition.TriggerOnTimeDelay = True + ' Save the presentation file + ppDoc.Save("Sample.pptx") + ' Close the presentation file + ppDoc.Close() + + + + + + + Get the advance time value for navigating to next slide. + + + Max Advance time value is 86399. + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add slide transition effect on the slide + slide.SlideTransition.TransitionEffect = TransitionEffect.PageCurlDouble; + // Set the next slide advance time bool value + slide.SlideTransition.TriggerOnTimeDelay = true; + // Set the advance on time value for next slide + slide.SlideTransition.TimeDelay = 25000; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + ' Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + ' Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + ' Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + ' Add slide transition effect on the slide + slide.SlideTransition.TransitionEffect = TransitionEffect.PageCurlDouble + ' Set the next slide advance time bool value + slide.SlideTransition.TriggerOnTimeDelay = True + ' Set the advance on time value for next slide + slide.SlideTransition.TimeDelay = 25000 + ' Save the presentation file + ppDoc.Save("Sample.pptx") + ' Close the presentation file + ppDoc.Close() + + + + + + Get the Duration of the Slide Transition. + + + Max Duration is 59 seconds(0 to 59). + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add slide transition effect on the slide + slide.SlideTransition.TransitionEffect = TransitionEffect.PageCurlDouble; + // Set the duration value(in seconds) for slide transition effect + slide.SlideTransition.Duration = 30; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + ' Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + ' Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + ' Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + ' Add slide transition effect on the slide + slide.SlideTransition.TransitionEffect = TransitionEffect.PageCurlDouble + ' Set the duration value(in seconds) for slide transition effect + slide.SlideTransition.Duration = 30 + ' Save the presentation file + ppDoc.Save("Sample.pptx") + ' Close the presentation file + ppDoc.Close() + + + + + + Get the Transition effect type + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add slide transition effect on the slide + slide.SlideTransition.TransitionEffect = TransitionEffect.PageCurlDouble; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + ' Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + ' Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + ' Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + ' Add slide transition effect on the slide + slide.SlideTransition.TransitionEffect = TransitionEffect.PageCurlDouble + ' Save the presentation file + ppDoc.Save("Sample.pptx") + ' Close the presentation file + ppDoc.Close() + + + + + + Get the Transition effect SubType(Direction) + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add slide transition effect on the slide + slide.SlideTransition.TransitionEffect = TransitionEffect.PageCurlDouble; + // Add subtype for the transition effect + slide.SlideTransition.TransitionEffectOption = TransitionEffectOption.Right; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + ' Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + ' Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + ' Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + ' Add slide transition effect on the slide + slide.SlideTransition.TransitionEffect = TransitionEffect.PageCurlDouble + ' Add subtype for the transition effect + slide.SlideTransition.TransitionEffectOption = TransitionEffectOption.Right + ' Save the presentation file + ppDoc.Save("Sample.pptx") + ' Close the presentation file + ppDoc.Close() + + + + + + Get the Speed of the Transition effect + + + Transition duration value will change based on speed. + The duration values are Fast - 0.5 sec, Medium - 0.75 sec, Slow - 1.0 sec + + + + // Create a new presentation. + IPresentation ppDoc = Presentation.Create(); + // Add a slide to the presentation. + ISlide slide = ppDoc.Slides.Add(SlideLayoutType.Blank); + // Add shape on the slide + IShape shape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150); + // Add slide transition effect on the slide + slide.SlideTransition.TransitionEffect = TransitionEffect.PageCurlDouble; + // Add the speed value for the transition effect + slide.SlideTransition.Speed = TransitionSpeed.Slow; + // Save the presentation file + ppDoc.Save("Sample.pptx"); + // Close the presentation file + ppDoc.Close(); + + + ' Create a new presentation. + Dim ppDoc As IPresentation = Presentation.Create() + ' Add a slide to the presentation. + Dim slide As ISlide = ppDoc.Slides.Add(SlideLayoutType.Blank) + ' Add shape on the slide + Dim shape As IShape = slide.Shapes.AddShape(AutoShapeType.Diamond, 150, 150, 250, 150) + ' Add slide transition effect on the slide + slide.SlideTransition.TransitionEffect = TransitionEffect.PageCurlDouble + ' Add the speed value for the transition effect + slide.SlideTransition.Speed = TransitionSpeed.Slow + ' Save the presentation file + ppDoc.Save("Sample.pptx") + ' Close the presentation file + ppDoc.Close() + + + + + + Specifies the transition effect + + + + + Specifies the transition effect is None + + + + + Specifies the transition effect is Blinds + + + + + Specifies the transition effect is Checkerboard + + + + + Specifies the transition effect is Circle + + + + + Specifies the transition effect is Comb + + + + + Specifies the transition effect is Cover + + + + + Specifies the transition effect is Cut + + + + + Specifies the transition effect is Diamond + + + + + Specifies the transition effect is Dissolve + + + + + Specifies the transition effect is FadeAway + + + + + Specifies the transition effect is NewsFlash + + + + + Specifies the transition effect is Plus + + + + + Specifies the transition effect is Push + + + + + Specifies the transition effect is Random + + + + + Specifies the transition effect is RandomBars + + + + + Specifies the transition effect is Split + + + + + Specifies the transition effect is Strips + + + + + Specifies the transition effect is Wedge + + + + + Specifies the transition effect is Wheel + + + + + Specifies the transition effect is Wipe + + + + + Specifies the transition effect is Zoom + + + + + Specifies the transition effect is Vortex + + + + + Specifies the transition effect is Switch + + + + + Specifies the transition effect is Flip + + + + + Specifies the transition effect is Ripple + + + + + Specifies the transition effect is HoneyComb + + + + + Specifies the transition effect is Cube + + + + + Specifies the transition effect is Box + + + + + Specifies the transition effect is Rotate + + + + + Specifies the transition effect is orbit + + + + + Specifies the transition effect is Doors + + + + + Specifies the transition effect is Window + + + + + Specifies the transition effect is FerrisWheel + + + + + Specifies the transition effect is Gallery + + + + + Specifies the transition effect is Conveyor + + + + + Specifies the transition effect is Pan + + + + + Specifies the transition effect is GlitterDiamond + + + + + Specifies the transition effect is GlitterHexagon + + + + + Specifies the transition effect is Warp + + + + + Specifies the transition effect is FlyThrough + + + + + Specifies the transition effect is Flashbulb + + + + + Specifies the transition effect is Shred + + + + + Specifies the transition effect is Reveal + + + + + Specifies the transition effect is FallOver + + + + + Specifies the transition effect is Drape + + + + + Specifies the transition effect is Curtains + + + + + Specifies the transition effect is Wind + + + + + Specifies the transition effect is Prestige + + + + + Specifies the transition effect is Fracture + + + + + Specifies the transition effect is Crush + + + + + Specifies the transition effect is PeelOff + + + + + Specifies the transition effect is PageCurlSingle + + + + + Specifies the transition effect is PageCurlDouble + + + + + Specifies the transition effect is Origami + + + + + Specifies the transition effect is Airplane + + + + + Specifies the transition effect is Morph + + + + + Specifies the transition effect is Uncover + + + + + Specifies the transition effect option + + + + + Specifies the transition subtype is None + + + + + Specifies the transition subtype is Left + + + + + Specifies the transition subtype is Right + + + + + Specifies the transition subtype is Up + + + + + Specifies the transition subtype is Down + + + + + Specifies the transition subtype is LeftDown + + + + + Specifies the transition subtype is LeftUp + + + + + Specifies the transition subtype is RightDown + + + + + Specifies the transition subtype is RightUp + + + + + Specifies the transition subtype is In + + + + + Specifies the transition subtype is Out + + + + + Specifies the transition subtype is Horizontal + + + + + Specifies the transition subtype is Vertical + + + + + Specifies the transition subtype is ByObject + + + + + Specifies the transition subtype is ByWord + + + + + Specifies the transition subtype is ByChar + + + + + Specifies the transition subtype is StripsIn + + + + + Specifies the transition subtype is StripsOut + + + + + Specifies the transition subtype is RectangleIn + + + + + Specifies the transition subtype is RectangleOut + + + + + Specifies the transition subtype is SmoothLeft + + + + + Specifies the transition subtype is SmoothRight + + + + + Specifies the transition subtype is BlackLeft + + + + + Specifies the transition subtype is BlackRight + + + + + Specifies the transition subtype is Inbounce + + + + + Specifies the transition subtype is Outbounce + + + + + Specifies the transition subtype is Center + + + + + Specifies the transition subtype is HorizontalOut + + + + + Specifies the transition subtype is HorizontalIn + + + + + Specifies the transition subtype is VerticalOut + + + + + Specifies the transition subtype is VerticalIn + + + + + Specifies the transition subtype is Across + + + + + Specifies the transition subtype is ThroughBlack + + + + + Specifies the transition subtype is Smoothly + + + + + Specifies the transition subtype is Spoke1 + + + + + Specifies the transition subtype is Spokes2 + + + + + Specifies the transition subtype is Spokes3 + + + + + Specifies the transition subtype is Spokes4 + + + + + Specifies the transition subtype is Spokes8 + + + + + Specifies the transition subtype is Reverse1Spoke + + + + + Specifies the transition speed + + + + + Specifies the transition speed is None + + + + + Specifies the transition speed is Slow + + + + + Specifies the transition speed is Medium + + + + + Specifies the transition speed is Fast + + + + + Specifies the direction value is None + + + + + Specifies the direction value is Horizontal + + + + + Specifies the direction value is Vertical + + + + + Specifies the eight direction type is None. + + + + + Specifies the eight direction type is LeftDown + + + + + Specifies the eight direction type is LeftUp + + + + + Specifies the eight direction type is RightDown + + + + + Specifies the eight direction type is RightUp + + + + + Specifies the eight direction type is Left + + + + + Specifies the eight direction type is Up + + + + + Specifies the eight direction type is Down + + + + + Specifies the eight direction type is Right + + + + + Specifies the side direction is None + + + + + Specifies the side direction is Down + + + + + Specifies the side direction is Left + + + + + Specifies the side direction is Right + + + + + Specifies the side direction is Up + + + + + Specifies the InOut direction is None + + + + + Specifies the InOut direction is In + + + + + Specifies the InOut direction is Out + + + + + Specifies the Corner direction is None + + + + + Specifies the Corner direction is LeftDown + + + + + Specifies the Corner direction is LeftUp + + + + + Specifies the Corner direction is RightDown + + + + + Specifies the Corner direction is RightUp + + + + + Specifies the Pattern is None + + + + + Specifies the Pattern is Diamond + + + + + Specifies the Pattern is Hexagon + + + + + Specifies the ShredPattern is None + + + + + Specifies the ShredPattern is Strip + + + + + Specifies the ShredPattern is Rectangle + + + + + Specifies the LeftRight direction is None + + + + + Specifies the LeftRight direction is Left + + + + + Specifies the LeftRight direction is Right + + + + + Specifies the Morph option is ByObject + + + + + Specifies the Morph option is ByWord + + + + + Specifies the Morph option is ByChar + + + + + + This class holds the name of the Syncfusion.OfficeChart.Base assembly and provides a helper + routine that helps with resolving types when loading a serialization stream and when + the framework probes for assemblies by reflection. + + + + + The full name of this assembly without version information: "Syncfusion.OfficeChart" + + + + + A reference to the for the XlsIO assembly. + + + + + The root namespace of this assembly. Used internally for locating resources within the assembly. + + + + diff --git a/ZZPDFTest/bin/Debug/Syncfusion.Shared.Base.dll b/ZZPDFTest/bin/Debug/Syncfusion.Shared.Base.dll new file mode 100644 index 00000000..0ec30fc5 Binary files /dev/null and b/ZZPDFTest/bin/Debug/Syncfusion.Shared.Base.dll differ diff --git a/ZZPDFTest/bin/Debug/Syncfusion.Shared.Base.xml b/ZZPDFTest/bin/Debug/Syncfusion.Shared.Base.xml new file mode 100644 index 00000000..850586af --- /dev/null +++ b/ZZPDFTest/bin/Debug/Syncfusion.Shared.Base.xml @@ -0,0 +1,94442 @@ + + + + Syncfusion.Shared.Base + + + + + + This class holds the name of the Syncfusion.Shared.Base assembly and provides a helper + routine that helps with resolving types when loading a serialization stream and when + the framework probes for assemblies by reflection. + + + + + The full name of this assembly without version information: "Syncfusion.Shared.Base". + + + + + A reference to the for the grid assembly. + + + + + The root namespace of this assembly. Used internally for locating resources within the assembly. + + + + + This delegate helps with resolving types and can be used as an eventhandler + for a event. + + The source of the event. + The event data with information about the type. + A reference to the assembly where the type is located. + + + + Defines the interface for extendable text box wrappper. + + + + + Text box control native handle. + + Must return if handle isn't created yet. + + + + Occurs when text box is created. + + + + + Occurs when text of text box is changed. + + + + + Indicates whether text box is focused. + + + + + Background color of text box. + + + + + Client rectangle of text box + + + + + Font of text box. + + + + + Indicates whether text box is in RTL mode. + + + + + Invalidates text box. + + + + + Defines the interface for extending text box owned by some components. + + + + + Specifies whether this component can provide banner text extender properties to the specified object. + + The to receive the extender properties. + true if this object can provide extender properties to the specified object. + + + + Retrieves extendable text box info. + + Extended component. + object + + + + Type of extended component. + + + + + Component's type. + + + + + Collection of extended components. + + + + + Stores text box to component backaward mapping. + + + + + Stores map of bannet text info to extenders . + + + + + Default banner text providers. + + + + + Default constructor. + + + + + Creates instance of class and registers it in owner's container. + + Owner's container. + + + + Static constructor. + + Registers default banner text providers. + + + + Register additional . + + Provider to register. + + + + Returns for given component. + + Component to retirive info for. + Associated object. + Returns a copy of object. + + + + Associates with component. + + Component. + info object. + + + + Retrieves text box to component backward map. + + Mapping is created on demand. + + + + Renders banner text for -derived control. + + + + + Draws banner text. + + to draw at. + Specifies banner text appearance. + Banner text background color. + Fallback font for the case when doesn't contain valid font. + Text flow layout. + Rectangle to draw within. + + + + Determines whether draw text is visible and must be drawn. + + Describes banner text appearance. + Indicates whether extended text box is focused. + Indicates whether extended text box's text is empty. + True if banner text is visible. + + + + Describes banner text rendering behavior. + + + + + Banner text disappears when the control gets focus. + + + + + Banner text disappears only when associated text box is not empty. + + + + + Describes banner text appearance and behavior. + + + + + Variable to indicate the Text alignment for BannerTextInfo. + + + + + Static constructor. + + + + + Default constructor. + + + + + Copy constructor. + + + + + Specifies banner text. + + + + + Gets or sets the value to indicate the Text alignment for . + + + + + Specifies whether to serialize TextAlignment property + + Returns true when the value is not Near. + + + + Specifies whether to reset TextAlignment property + + + + + + Specifies font of banner text. + + + + + Specifies banner text rendering mode. See for details. + + + + + Specifies banner text color. + + + + + Type converter for + + + + + Designer for + + + + + Attribute used to specify the default child type for a parent type. + + + + A parent type designer, say TabControl for example, usually lets you add child types, + TabPage in this case, during design-time. However, when you create custom types deriving + from TabControl and TabPage, the designer needs to be informed about this change in "default child type" + for your derived parent type. This attribute lets you declare this relationship. + + + Some of our components like TabControlExt and XPTaskBar use this attribute to declare + their default child type. Their corresponding designers query this attribute before creating a new child instance. + This way, when you derive custom types for the above Controls, you + can specify the new default child type using this attribute on your parent type. + + + + + + Creates a new instance of the DefaultChildTypeAttribute specifying the child type. + + An Type instance. + + + + Returns the specified child Type. + + + + + This should be called during design time when a component has been moved, sized or re-parented, + but the change was not the result of a property change. All property + changes are monitored by the selection UI service, so this is automatic most + of the time. There are times, however, when a component may be moved without + property change notification occurring. Scrolling an auto scroll Win32 + form is an example of this. + This method simply re-queries all currently selected components for their + bounds and updates the selection handles for the ones that have changed. + + + + + Initializes the PersistenceModeAttribute type with the specified constant, using reflection, if the + System.Web.dll is loaded. + + + + + + A dummy PropertyDescriptor that could be used to add custom attributes dynamically. + + + + + Generic enumeration value filter class. + + + + + Enumeration values to be skipped. + + + + + Default enumeration value filter class. + + Skips value. + + + + Default values to be skipped. + + + + + EnumFlagsEditor implements a UITypeEditor for modifying a enum value that + has been marked with the FlagsAttribute. + + The editor lets you check and uncheck + individual flags in a dropdown CheckedListBox. A None button allows to reset all + flags at once. + + + + + + + + + + + Returns the edit style from the current context. + + The context of the object the bindings provide values to. + + A value. + + + + + Edits the specified value using the specified provider + within the specified context. + + The context of the value. + The provider to use to provide values. + The object to be edited. + + + + Adds an event handler to listen to the disposed event on the component. + + + + + Initializes a new instance of the class. + + The collection of bindings to store. + + + + Adds an event handler to listen to the disposed event on the component. + + + + + Gets / sets the name for this object. + + + + + Gets / sets the collection of bindings. + + + + + Indicates whether to show all bindings. + + + + + Initializes a new instance of the class. + + A type descriptor context that can provide context information. + + + + Indicates whether the value of this property should be persisted. + + The component that owns the property to determine whether the value should be persisted. + + + if the property should be persisted; + otherwise. + + + + + Sets the specified value of the property on the specified component. + + + The component that owns the property whose value has to be set. + The value to set the property to. + + + + Resets the value of the property on the specified component. + + The component with this property that should be reset. + + + + Returns the current value of the property on the specified + component. + + The component from which to get the value of the property this descriptor describes. + + The value of the property on the specified component. + + + + + Returns an editor of the specified type. + + The type of editor to retrieve. + + An instance of the requested editor type, or if an + editor could not be found. + + + + + Indicates whether resetting the component will change the value of the + component. + + The component to determine if resetting will change the value of the property on. + + + if the component can be reset without changing the + value of the property; otherwise. + + + + + Returns the type of the property. + + + + + Indicates whether this property is read-only. + + + + + Returns the type of component this property is bound to. + + + + + In a derived class, adds the attributes of the inherited class to the + specified list of attributes in the parent class. + + An that lists the attributes in the parent class. Initially, this will be empty. + + + + Indicates whether the specified component should persist the value. + + The component to determine whether the value of should be persisted. + + + if the value should be persisted; + otherwise. + + + + + Sets the specified value for the specified component. + + The component to set the value for. + The value to set. + + + + Resets the value of the specified component. + + The component whose value is to be reset. + + + + Returns a value from the specified component. + + The component to retrieve a value from. + + The value of the specified component. + + + + + Indicates whether the specified component can reset the value + of the property. + + The component to test whether it can change the value of the property. + + + if the value can be reset; + otherwise. + + + + + Returns the type of the property. + + + + + Indicates whether the property is read-only. + + + + + Returns the type converter. + + + + + Returns the type of the component that owns the property. + + + + + Base implementation for interface. + + + + + HandleCreated event delegate. + + + + + TextBoxTextChanged event delegate. + + + + + Releases unmanaged and - optionally - managed resources + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Releases unmanaged resources and performs other cleanup operations before the + is reclaimed by garbage collection. + + + + + Extendable text box wrapper for . + + + + + Initializes a new instance of the class. + + The text box. + + + + Gets the handle. + + The handle. + + + + Gets a value indicating whether this is focused. + + true if focused; otherwise, false. + + + + Gets the color of the back. + + The color of the back. + + + + Gets the client rectangle. + + The client rectangle. + + + + Sets the cursor position to initial state + + The font. + + + + Gets the font. + + The font. + + + + Gets the right to left. + + The right to left. + + + + Invalidates this instance. + + + + + Releases unmanaged and - optionally - managed resources + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Banner text provider for TextBox-derived classes. + + + + + Banner text provider for ComboDropDown-derived classes. + + + + + Extendable text box wrapper for . + + + + + Banner text provider for ComboBox-derived classes. + + + + + Represents the class used to validate customization. + + + + + Helps to calculate the Path for CornerRadius customization in Control + + + + + Render button in metro style + + + + + Default radius truncation coreners of the control. + + + + + Angle for vertical gradient brush. + + + + + Width for brush. + + + + + + + + + + Blend for selected control. + + + + + Blend for control. + + + + + Blend for pressed control. + + + + + Blend for disabled control. + + + + + + Metro ForeColor + + + + + + + + + Make class cleanup + + + + + Sets metro color + + + + + Gets vertical gradient brush. + + + + + Draws background. + + + + + Draws border. + + + + + + + + + + + + + + + + + + + + + Fill rectangle with gradient for disabled control. + + + + + + + + + Specifies region for drawing + + + + + Constructor for this class + + + + + + CreateDrawingObjects method has been set to define background and border color + + + + + Design of background + + + + + + + + Design of border + + + + + + + + + Draws text over the button + + + + + + + Overrides the render method from base(ButtonRenderer) + + + + + + Constructor for this class + + + + + + CreateDrawingObjects method has been set to define background and border color + + + + + Design of background + + + + + + + + Design of border + + + + + + + + + Draws text over the button + + + + + + + Overrides the render method from base(ButtonRenderer) + + + + + + Constructor for this class + + + + + + CreateDrawingObjects method has been set to define background and border color + + + + + Design of background + + + + + + + + Design of border + + + + + + + + + Overrides the render method from base(ButtonRenderer) + + + + + + Constructor for this class + + + + + + CreateDrawingObjects method has been set to define background and border color + + + + + Design of background + + + + + + + + Design of border + + + + + + + + + Draws text over the button + + + + + + + Overrides the render method from base(ButtonRenderer) + + + + + + Represents the class to define the style for control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Holds instance of a class. + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + Holds instance of a class + + + + Gets the default style value for the control. + + + + + Gets or sets the value of the + control. + + + + + Gets or sets the value for corner radius of the + control. + + + + + Gets or sets the value used to draw the border of the + control. + + + + + Gets or sets the value used to draw the border of the + control in default state. + + The value is used to draw the border of the button. + The default value is null. + + + + Gets or sets the value used to draw the border of the + control in pressed state. + + The value is used to draw the border of the button. + The default value is null. + + + + + Gets or sets the value used to draw the border of the + control in disabled state. + + + + + Gets or sets the value used to draw the border of the + control in default state. + + The value is used to draw the border of the button. + The default value is null. + + + + Gets or sets the value used to draw the border of the + control in pressed state. + + The value is used to draw the border of the button. + The default value is null. + + + + + Gets or sets the value used to draw the border of the + control in disabled state. + + + + + Gets or sets the value used to draw the border of the + control in focused state. + + The value is used to draw the border of the button. + The default value is null. + + + + Gets or sets the value used to draw the font of the + control in hover state. + + The value is used to draw the font of the button. + The default value is null. + + + + Gets or sets the value used to draw the font of the + control in pressed state. + + The value is used to draw the font of the button. + The default value is null. + + + + Gets or sets the value used to draw the border of the + control in focused state. + + The value is used to draw the border of the button. + The default value is null. + + + + Gets the default style value of the class. + + Returns the default style value. + + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Implements the class that provide the identity information of + using . + + + + + Maintains the ButtonAdv for create the identity. + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Provides storage for the object. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + Represents a ButtonAdv control with advanced customization options on background, text, and border etc. + + + Button with advanced rendering features + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + Occurs when theme name of the has changed. + + + + + Gets or sets a value indicating whether a theme style + has been applied to the control. + + The default value is true. + + + + Gets or sets the theme name of the ButtonAdv control. + + + + + Gets or sets a value indicating whether control elements styles can be overridden by theme style settings. + + Default value is false. + + By default, the control's element styles will not be overridden by theme style settings if the style is set in sample level. + If this property is enabled, element style will be overridden by theme style settings event if it is set in sample level. + This property should be enabled or disabled before calling the ThemeName property of the control. + + + + + Gets or sets the BaseTheme name of the theme + + + + + Gets a value indicating whether the visual style based theme is applied to the control and + also indicates whether the theme files are referred from external assemblies or not. + + Return true, if the visual style based theme is applied to the control. Otherwise returns false. + + + + + Gets the name of the control. + + + + + Gets the active theme name of the ButtonAdv control. + + Returns the active theme name. + + + + Returns the name of the control. + + + + + Raises the event when themename changed. + + The sender value. + A contains the event data. + + + + Helps to reset Layout customization of the ButtonAdv Control. + + + + + Updates the Style renderers of ButtonAdv Control based on applied Theme. + + + + + Specifies ButtonAdv default border width. + + + + + Draw the window only if it is visible. + + + + + Draw the non-client area of the window. + + + + + Draw the client area of the window. + + + + + Erase the background before drawing the window. + + + + + Draw all visible child windows. + + + + + Draw all owned windows. + + + + + + + + + Indicates whether renderer could draw the background for half of the control differently. + Used in XP style when used as a combo button. + + Used only for by class. + + + + Indicates whether renderer could draw the background for half of the control differently. + Used in XP style when used as a combo button. + + Used only for by class. + + + + + + + Specifies border style of ButtonAdv. + + + + + Internal usage field ( Border drawing ). + + + + + Reference counter. + + + + + + + + Indicates whether ButtonAdv will show focus rectenagle. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Metrocolor + + + + + + + + + + + + + + + + + + + + + + Default size of the control + + + + + Drawing ButtonAdv's surface on custom Graphics + + Graphics to draw on + buttonAdv control to draw + Point that represents the location of the upper-left + corner of the drawn image. + + private void pictureBox1_Paint(object sender, PaintEventArgs e) + { + e.Graphics.RotateTransform(20); + ButtonAdv.PaintButton(e.Graphics, this.buttonAdv1, new Point(75, 25)); + } + + + + + Indicates whether button have DesignMode + + + + + It stores the value of the property. + + + + + + It contains the value of the property. + + + + + Gets or sets office 2007 color scheme. + + + + + Gets or sets office 2010 color scheme. + + + + + Gets or sets ButtonAdv border style. Borders styles supported only in + appearance styles: , + and . + + + + + Gets or Sets value specifying whether ButtonAdv will show focus rectangle receiveng focus. + + + + + Gets or sets the look and feel of the ButtonAdv. Set + to True if you want to apply style on button, otherwise False. + + + + + Gets or sets the MetroColor color of the ButtonAdv + + + + + Gets or sets the value for the control. + + + + + To indicate whether to serialize MetroColor or not + + + + + + To Reset MetroColor + + + + + Gets or sets the foreground color of the ButtonAdv + + + + + Gets or sets the background color of the ButtonAdv + + + + + Gets or sets the ImageListAdv of the ButtonAdv + + + + + Gets or sets the background color of the ButtonAdv + + + + + Gets or sets a value indicating whether the custom managed color is to be applied by overriding the Form's managed color + + + + + Indicates whether Visual Styles must be enabled for the button. + Set value to True if you want to apply settings of properties: + , , + and etc. on current button. + + + + + Gets or sets the type of button to be used. + + + + + Gets or sets the text to be displayed on the button. + + + + + Gets or sets the different states the button can hold: Default, MouseOver, Pressed. + + + + + Indicates the state of control. + + + + + Gets or sets a value indicating whether state should be reset on focus lost. + + + true if reset state on lost focus; otherwise, false. + + + + + Indicates whether the mouse is currently pressed. + + + + + Indicates whether the button is of ComboButton type. + + + + + Gets or sets the combo edit backcolor. + + + + + Indicates whether Appearance of the ButtonAdv has changed. + + + + + + + + Constructor. + + Indicates whether button is of combo button type. + + + + + + + Cleans up any resources being used. + + + + + + gets or sets the touchmode + + + + + + + + applies the scaling + + + + + + Font changed event + + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Indicates whether to animate the image. + + + + + + + Sets the value of animateState member. + + + + + + + + + + + + If animate is true - animates the image, else doesn`t animate. + + + + + + + + + + + + finding the button is BackStageButton or not. + + + + + Gets/Sets the value for IsBackStageButton + + + + + Holds MessageBoxAdvOptionButton + + + + + Gets/Sets whether this is MessageBoxAdv Button + + + + + Holds is DropDown Button + + + + + Gets/Sets whether this is DropDownButton + + + + + Reset DropDown Button + + + + + Specifies whether this is DropDown Button + + + + + Specifies whether this is DropDown Button + + + + + + + + + + + + + Creates delegates for border drawing methods. + + + + + Performs border drawing. + + PaintEventArgs from OnPaint method + border width + + + + Draws border with ButtonAdvBorderStyle.Flat style. + + Graphics to draw on + rectangle to draw border in + border width + + + + Draws border with ButtonAdvBorderStyle.SunkenOuter style. + + Graphics to draw on + rectangle to draw border in + border width + + + + Draws border with ButtonAdvBorderStyle.SunkenInner style. + + Graphics to draw on + rectangle to draw border in + border width + + + + Draws border with ButtonAdvBorderStyle.Sunken style. + + Graphics to draw on + rectangle to draw border in + border width + + + + Draws border with ButtonAdvBorderStyle.RaisedOuter style. + + Graphics to draw on + rectangle to draw border in + border width + + + + Draws border with ButtonAdvBorderStyle.RaisedInner style. + + Graphics to draw on + rectangle to draw border in + border width + + + + Draws border with ButtonAdvBorderStyle.Raised style. + + Graphics to draw on + rectangle to draw border in + border width + + + + Draws border with ButtonAdvBorderStyle.Etched style. + + Graphics to draw on + rectangle to draw border in + border width + + + + Draws border with ButtonAdvBorderStyle.Bump style. + + Graphics to draw on + rectangle to draw border in + border width + + + + Draws border with ButtonAdvBorderStyle.Outset style. + + Graphics to draw on + rectangle to draw border in + border width + + + + Draws border with ButtonAdvBorderStyle.Inset style. + + Graphics to draw on + rectangle to draw border in + border width + + + + Draws border with ButtonAdvBorderStyle.Solid style. + + Graphics to draw on + rectangle to draw border in + border width + + + + Draws border with ButtonAdvBorderStyle.Dotted style. + + Graphics to draw on + rectangle to draw border in + border width + + + + Draws border with ButtonAdvBorderStyle.Dashed style. + + Graphics to draw on + rectangle to draw border in + border width + + + + This method draws nothing. Used with ButtonAdvBorderStyle.Default and ButtonAdvBorderStyle.None + + Graphics to draw on + rectangle to draw border in + border width + + + + Gets color to draw border with. + + border color + + + + Recover or suspends mouse handling logic for property . + + + True to suspend, otherwise to resume handling logic. + + + + + Suspend property updating till the method call. + + + + + Recover mouse handling logic for property . To suspend call method. + + + + + If the isLastleftButton is set to True, the button's renderer could + draw the background for half of the control differently. Used in XP style + when used as a combo button. + + Used only for by class. + The value that is to be set. + + + + If the IsFirstRightButton is set to True, the button's renderer could + draw the background for half of the control differently. Used in XP style + when used as a combo button. + + Used only for by class. + The value that is to be set. + + + + If the isLastleftButton is set to True, the button's renderer could + draw the background for half of the control differently. Used in XP style + when used as a combo button. + + Used only for by class. + + + + + If the IsFirstRightButton is set to True, the button's renderer could + draw the background for half of the control differently. Used in XP style + when used as a combo button. + + Used only for by class. + + + + + + + + + Gets/Sets Control size before touch enabled + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Raises the event. + + An that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Resets the UseVisualStyle to default. + + + + + + + + + Resets the ComboEditBackColor to default. + + + + + + + + + Resets the System.Windows.Forms.Control.ForeColor property to its default value. + + + + + + + + Resets the System.Windows.Forms.Control.BackColor property to its default value. + + + + + Should serialize for IsBackStageButton. + + + + + Indicates whether the property should be persisted. + + + + Method allow to raise event. + Paint event arguments. + + + + + + + + Sets region of the control + + + + + Gets ButtonAppearance depending on current operating system + + + + + + + + + Delegate used for border drawing. + + + + + + + + Represents the class to define the Theme customization of control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + ButtonAdv + + + + Draws text over the button + + + + + + + Overrides the render method from base(ButtonRenderer) + + + + + + CreateDrawingObjects method has been set to define background and border color + + + Design of background + + + + + + + + Design of border + + + + + + + + + Represents the class that provides the accessibility object for the + + + + + Specifies the accessibility control. + + + + + Initializes a new instance of the class. + + The which needs to create the accessibility object. + + + + Gets the AccessibleRole of the control. + + + + + Gets the AccessibleName of the control. + + + + + Gets the bounds of the control. + + + + + Gets the AccessibleDescription of the control. + + + + + Gets the details about what the object does or how the object is used. + + + + + Gets the accessibility object of the parent. + + + + + Gets the state for the control. + + + + + Gets the selected color value of the control. + + + + + Overridden. Retrieves the child object at the specified screen coordinates. + + The horizontal screen coordinate. + The vertical screen coordinate. + + + + + Represents the class that provides the accessibility object for the + + + + + Specifies the accessibility control. + + + + + Initializes a new instance of the class. + + The which needs to create the accessibility object. + + + + Gets the AccessibleRole of the . + + + + + Gets the AccessibleName of the . + + + + + Gets the bounds of the accessible object. + + + + + Gets the AccessibleDescription of the . + + + + + Gets the details about what the object does or how the object is used. + + + + + Gets the accessibility object of the parent. + + + + + Gets the state for the . + + + + + Gets the value of the . + + + + + Design the property values into the class. + + + + + Initialize a new instance of the ColorUIActionList class. + + Represents component + + + + Overrridden InitializeActionList. + + + + + Gets or sets the Text + + + + + Gets or sets the visual style. + + The style. + + + + Gets or sets the visual style. + + The style. + + + + Gets or sets Name. + + + + + + This class represents to maintain DPI based image + + + + + Instance of . + + + + + Instance of . + + Image in 125 scaling + Image in 150 scaling + Image in 200 scaling + + + + + Stores the value of DPI120Image + + + + + Stores the value of DPI144Image + + + + + Stores the value of DPI192Image + + + + + Stores the value of Index + + + + + Get or sets the image of the item in 125 scaling + + + + + Get or sets the image of the item in 150 scaling + + + + + Get or sets the image of the item in 200 scaling + + + + + Gets or sets the index of the default image. + + + + + + The class which represents the collection of DPI images. + + + + + Adds image to the collection. + + Image to add. + + + + Checks whether collection contains given image. + + Image to be checked. + True if collection contains given image; otherwise false. + + + + Removes given image from collection. + + Image to remove. + + + + Gets index of given image. + + Image to get index of. + Index of given image or -1 if image doesn't exist in collection. + + + + Adds array of images to collection. + + Array of images to add. + + + + Gets value indicating whether collection is empty. + + + + + Gets or sets image at specified index. + + Index of image. + Image at specified index + + + + + The class which represents the collection editor to store the DPI images. + + + + + Initializes a new instance of the class. + + The type of the collection for this editor to edit. + + + + Initializes the class. + + + + + Static instance of custom for s. + + + + + Static instance of . + + + + + Creates the instance. + + The type. + + + + + Returns a list containing the given object + + An returned as an object. + + An which contains the individual objects to be created. + + + + + Destroys the specified instance of the object. + + The object to destroy. + + + + Edits the value of the specified object using the specified service provider and context. + + An that can be used to gain additional context information. + A service provider object through which editing services can be obtained. + The object to edit the value of. + + The new value of the object. If the value of the object has not changed, this should return the same object it was passed. + + + An attempt to check out a file that is checked into a source code management program did not succeed. + + + + + + Custom provider of custom type descriptor for class. + + + + + Initializes a new instance of the class. + + + + + Gets a custom type descriptor for the given type and object. + + The type of object for which to retrieve the type descriptor. + An instance of the type. Can be null if no instance was passed to the . + + An that can provide metadata for the type. + + + + + + Editor for DPiImages in ImageListAdv. + + + + + FileDialog for selecting images. + + + + + Array of image editors of different types. Used in building string of file extensions. + + + + + Initializes static members. + + + + + Edits the specified object value using the edit style provided by GetEditStyle. + + An ITypeDescriptorContext that can be used to gain additional context information. + A service provider object through which editing services can be obtained. + An instance of the value being edited. + The new value of the object. If the value of the object has not changed, + this method should return the same object passed to it. + + + + The types of buttons that the child button of the + ButtonEdit class can be set to. The ButtonType specifies + the image that is to be used for the button. + Set the button to normal appearance if you want to use your + own image. + + + The ButtonType and property are only loosely enforced by the + control and the designer. In the case where the ButtonType is set to one of these + values other than ButtonTypes.Normal and the Image property of the ButtonEditChildButton + is changed, the new image will be displayed and the ButtonType will still be the same + (it will not be changed to normal as its displaying a new image). + + The ButtonTypes are only provided for ease of use and do not in any way change the + functionality of the buttons. + + + + + + Normal button. The image can be set by the user. + + + + + Calculator image is used. + + + + + Currency image is used. + + + + + Down image is used. + + + + + Down image like in a Windows XP combo box. + + + + + Up image is used. + + + + + Left image is used. + + + + + Right image is used. + + + + + Redo image is used. + + + + + Undo image is used. + + + + + Check image is used. + + + + + Browse image is used. + + + + + Left end image is used. + + + + + Right end image is used. + + + + + Extends the class to handle currency input + and validation. + + + The CurrencyTextBox is derived from the textbox and provides all the functionality + of a text box and adds additional functionality of its own. + + Collecting currency input in a consistent format requires a lot of validation code + that needs to be built into the application when using the Windows Forms textbox control. + The CurrencyTextBox includes all this logic into its methods and properties + and makes it easy for the developer and the end user to collect and enter currency data. + + + The CurrencyTextBox is also closely tied to the globalization settings of the + operating system for Currency related properties. Please refer to the + class for a detailed explanation of globalization and Currency related attributes. + + + The CurrencyTextBox has full support for the Windows Forms designer and you can + just drag-and-drop and set properties on the control just as you would with the + Windows Forms textbox. + + + The CurrencyTextBox also raises a event when + inappropriate data is entered into the control. + + + All clipboard functions such as copy, paste and cut are also supported with + special accommodations for currency related issues. + + + + + // Create the Calculator Control. + this.currencyTextBox1 = new CurrencyTextBox(); + + // Set the initial value. + this.currencyTextBox1.Text = "$1.00"; + + // Set the clipmode. + this.currencyTextBox1.ClipMode = CurrencyClipModes.IncludeFormatting; + + // Set formatting properties. + this.currencyTextBox1.CurrencyDecimalDigits = 2; + this.currencyTextBox1.CurrencyDecimalSeparator = "."; + this.currencyTextBox1.CurrencyGroupSeparator = ","; + this.currencyTextBox1.CurrencyGroupSizes = new int[] {3}; + this.currencyTextBox1.CurrencyNegativePattern = 1; + this.currencyTextBox1.CurrencyNumberDigits = 27; + this.currencyTextBox1.CurrencyPositivePattern = 0; + this.currencyTextBox1.CurrencySymbol = "$"; + this.currencyTextBox1.ForeColor = System.Drawing.Color.Black; + this.currencyTextBox1.NegativeColor = System.Drawing.Color.Red; + this.currencyTextBox1.NegativeSign = "-"; + this.currencyTextBox1.PositiveColor = System.Drawing.Color.Black; + + this.currencyTextBox1.Size = new System.Drawing.Size(256, 20); + this.currencyTextBox1.TextAlign = System.Windows.Forms.HorizontalAlignment.Right; + + // Add the CurrencyTextBox control to the form. + this.Controls.Add(this.currencyTextBox1); + + + + Represents the class to apply the theme for control. + + + + + The maximum number of valid digits the textbox can take. + This is set to the maximum value a decimal type can hold. + + + + + The negative patterns. + + + + + The minimum value. + + + + + The maximum value. + + + + + The maximum number of currency digits. + + + + + The initial decimal value set in InitializeComponent. + + + + + The decimal value when the control gets the focus. Used when validating. + + + + + The decimal value that is set through the DecimalValue property. + + + + + + + + + + + + + + + For initialization of Culture related values. Needed when SpecialCultureValue is + not the default value. Since the base class will reset the Culture property during + ISupportInitialize.EndInit, we will have to hold these values and set them on the + correct cultureinfo / numberformatinfo. + + + + + Static initializer for the CurrencyTextBox. + + + + + Gets the currency formatted text and the decimal value for a given NumberFormatInfo object and + text value. + + The NumberFormatFormatInfo object to be used for the formatting. + The text to be formatted. + The value to be returned if the currencyText is considered a NULL value. This should be NULL if the string is not to be formatted as NULL even if value is NULL. + The decimal value. + + + + + Overloaded. Creates an object of type CurrencyTextBox. + + + The CurrencyTextBox object will be initialized with the default values + for the display and data properties. You need to set any specific + values. + + + + + + + + + + Overrides . + + + + + The number of digits for the number part. This is not part of the globalization structure. + + + This value is initially set based on the maximum value of the + Currency data type. + + + + + Gets or sets a value indicating whether the control should enable its Accessibility support. + + + + + Indicates whether to serialize the CurrencyNumberDigits property + if its the same as the MaximumLength. + + + + + + Restores the CurrencyNumberDigits to the MaximumLength. + + + + + The maximum number of digits for the decimal portion of the currency. + + + The US dollar requires 2 decimal points to accomodate the smallest + denomination and this property will have the value 2 in this case. If there + is a need to have a different value based on the locale, it will be + automatically changed based on the current locale. + + + + + + + + + + Indicates whether the CurrencyDecimalDigits should not be serialized if the value is the same + as the one for the current culture. + + True if the value is different from the value for the current culture. + + + + Reset the value to the culture specific value. + + + + + The decimal separator character that will be used for the display. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + Indicates whether the CurrencyDecimalSeparator should not be serialized if the value is the same + as the one for the current culture. + + True if the value is different from the value for the current culture. + + + + Resets the value to the culture specific value. + + + + + This property specifies the separator to be used for grouping digits. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + Indicates whether the CurrencyGroupSeparator should not be serialized if the value is the same + as the one for the current culture. + + True if the value is different from the value for the current culture. + + + + Resets the value to the culture specific value. + + + + + This property specifies the grouping of CurrencyDigits in the CurrencyTextBox. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + Indicates whether the CurrencyGroupSizes should not be serialized if the value is the same + as the one for the current culture. + + True if the value is different from the value for the current culture. + + + + Resets the value to the culture specific value. + + + + + This property specifies the pattern to use when the value is negative. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + Indicates whether the CurrencyNegativePattern should not be serialized if the value is the same + as the one for the current culture. + + True if the value is different from the value for the current culture. + + + + Resets the value to the culture specific value. + + + + + This property specifies the pattern to use when the value is positive. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + Indicates whether the CurrencyPositivePattern should not be serialized if the value is the same + as the one for the current culture. + + True if the value is different from the value for the current culture. + + + + Resets the value to the culture specific value. + + + + + This property specifies the currency symbol to be used in the CurrencyTextBox. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + Indicates whether the CurrencySymbol should not be serialized if the value is the same + as the one for the current culture. + + True if the value is different from the value for the current culture. + + + + Resets the value to the culture specific value + + + + + The number of digits for the number part. This is not part of the globalization structure. + + + This value is initially set based on the maximum value of the + Currency data type. + + + + + Indicates whether to serialize the CurrencyNumberDigits property + if its the same as the MaximumLength + + + + + + Restores the CurrencyNumberDigits to the MaximumLength. + + + + + + + + + + + Leading symbol. + + + + + Remove last decimal zeros. + + + + + If need correct ConcatModifiedText. + + + + + Zeros need added count. + + + + + Gets or sets remove last decimal zeros. + + + + + Format the given text according to the current setting. + + + + + + + Overrides the Text property of . + + + This property is overriden in order to normalize the data that is set + to the Text property and format it as needed. The method + is used to format the data. + + + + + Indicates whether to serialize the Text property + if it is null or quals NullString + + + + + + Restores the CurrencyNumberDigits to the MaximumLength. + + + + + The Maximum Value that can be set through the CurrencyTextBox. + + + The default value is the MaxValue for . + + + + + Indicates whether the MaxValue property should be serialized. + + true if the value is not equal to + + + + Resets the value to the default. + + + + + The Minimum Value that can be set through the CurrencyTextBox. + + + + + Indicates whether the MinValue property should be serialized. + + True if the value is not equal to + + + + Resets the value to the default. + + + + + Occurs when the property is changed. + + + + + The decimal value of the control. This will be formatted and + displayed. + + + + + Raises the event. + + A that contains the event data. + + + + Overrides OnTextChanged. + + The event data. + + + + Releases the unmanaged resources used by the and optionally releases the managed resources. + + true to release both managed and unmanaged resources; false to release only unmanage resources. + + + + Raises the System.Windows.Forms.Control.EnabledChanged event. + + An System.EventArgs that contains the event data. + + + + Calculates start position of numeric value. + + + + + + Calculates end position of numeric value. + + + + + + + + + + + + + + + + + + Checks if the text can be inserted subject to the constraints. + + The current content of the TextBox. + The text to be inserted. + The length of the acceptable string to be inserted. + + + + Returns the position of the decimal separator taking into account + the CurrencySymbol. + + The text in which to look for the decimal separator. + The decimal separator's position. + + + + Override this to return CurrencyDecimalSeparator in CurrencyTextBox + and PercentDecimalSeparator in PercentTextBox. + + + + + Override this to return CurrencyDecimalSeparator in CurrencyTextBox + and PercentGroupSeparator in PercentTextBox. + + + + + Overrides + + The text to be parsed. + True if the value is negative; false, otherwise + + + + Overrides the method. + + The event data. + + Saves the current DecimalValue so that it can be compared + during validation. The DecimalValueChanged and TextChanged event + will only be raised if the value is different during validation. + + + + + It contains the value of the property. + + + + + Checks whether the value is zero. + + True, if value is zero. + + + + Helps to apply the ThemeName settings in control + + ThemeName + + + + Helps to override the ThemeName property settings + + ThemeName + + + + Helps to override the OnGotFocus events + + An System.EventArgs that contains the event data. + + + + Helps to draw text border of control + + + + + Provides information about a control that can be used by an accessibility application. + + + + + CurrencyTextBox + + + + + Constructor + + The RibbonControlAdv instance. + + + + Bounds of the Control + + The accessible object bounds. + + + + Gets the role for the RibbonControlAdv. This is used by accessibility programs. + + + + + Gets or sets the accessible object name + + The accessible object name. + + + + Gets the description of the RibbonControlAdvAccessibility + + A string describing the RibbonControlAdvAccessibility. + + + + Retrieves the child object at the specified screen coordinates. + + The horizontal screen coordinate. + The vertical screen coordinate. + An RibbonControlAdvAccessibility that represents the child object at the given screen coordinates. + This method returns the calling object if the object itself is at the location specified. + Returns null if no object is at the tested location. + + + + Represents a class to define the style for the control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Holds instance of a class. + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + Holds instance of a class + + + + Gets the default style value for the control. + + + + + Gets or sets the value used to draw the fore color of the + control when text value is negative. + + The value is used to fill the fore color of the textbox. + + + + Gets or sets the value used to draw the fore color of the + control when text value is zero. + + The value is used to fill the fore color of the textbox. + + + + Gets or sets the value used to draw the back color of the + control when text value is read only. + + The value is used to fill the back color of the textbox. + + + + Overridden to create a product-specific identity object for the sub object. + + + StyleInfoProperty descriptor for this sub object. + + + Identity for the sub object. + + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Implements a class that provide the identity information of + using . + + + + + Maintains the CurrencyTextBox for create the identity. + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Represents a class that provides style identity information for nested objects of the + class. + + + + + Initializes a new instance of the class. + + + The that owns this sub-object. + + + The descriptor for this expandable + sub-object. + + + + + Summary description for CurrencyCultureEditor. + + + + + + + + + + + + + + + + + + + + + + Managed control + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Updates bounds of the instertion pointer + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for MaskedEditCultureEditor. + + + + + TypeConverter for MaskedEditDataGroupInfo. + + + + + Indicates whether this converter can convert an object to + the given destination type using the context. + + An ITypeDescriptorContext object that provides a format context. + A object that represents the type to which you want to convert. + True if conversion is possible; false otherwise. + + + + This member overrides . + + An ITypeDescriptorContext that provides a format context. + A CultureInfo object. If a null reference (Nothing in Visual Basic) is passed, the current culture is assumed. + The Object to convert. + The Type to convert the value parameter to. + Converted object. + + + + + + + Workaround for incident 35141. When calling Timer.Stop in GridGroupDropArea + this ends up calling MdiSysMenuProvider.MsgHook + + + + + Represents a class to define the style for the control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Holds instance of a class. + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + Holds instance of a class + + + + Gets the default style value for the control. + + + + + Gets or sets the value used to draw the inner border color of the + control in default state. + + The value is used to draw the inner border color of the GradientPanelExt. + + + + Gets or sets the value used to draw the disabled inner border color of the + control in disabled state. + + The value is used to draw the disabled inner border color of the GradientPanelExt. + + + + Gets or sets the value used to draw the inner back color of the + control in default state. + + The value is used to draw the inner back color of the GradientPanelExt. + + + + Gets or sets the value used to draw the inner back color of the + control in disabled state. + + The value is used to draw the disabled inner back color of the GradientPanelExt. + + + + Gets or sets the value used to draw the CornerRadius of the + control. + + The value is used to draw the CornerRadius of the GradientPanelExt. + + + + Overridden to create a product-specific identity object for the sub object. + + + StyleInfoProperty descriptor for this sub object. + + + Identity for the sub object. + + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Implements a class that provide the identity information of + using . + + + + + Maintains the GradientPanelExt for create the identity. + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Represents a class that provides style identity information for nested objects of the + class. + + + + + Initializes a new instance of the class. + + + The that owns this sub-object. + + + The descriptor for this expandable + sub-object. + + + + + Represents a class to define the style for the control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Holds instance of a class. + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + Holds instance of a class + + + + Gets the default style value for the control. + + + + + Gets or sets the value used to draw the border thickness of the + control. + + The value is used to draw the border thickness of the GradientPanel. + + + + Gets or sets the value used to draw the back color of the + control in the default state. + + The value is used to draw the back color of the GradientPanel. + The default value is null. + + + + Gets or sets the value used to draw the back color of the + control in the disabled state. + + The value is used to draw the disabled back color of the GradientPanel. + The default value is null. + + + + Gets or sets the value used to draw the border color of the + control in the default state. + + The value is used to draw the border color of the GradientPanel. + The default value is null. + + + + Gets or sets the value used to draw the border color of the + control in the disabled state. + + The value is used to draw the disabled border color of the GradientPanel. + The default value is null. + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Overridden to create a product-specific identity object for the sub object. + + + StyleInfoProperty descriptor for this sub object. + + + Identity for the sub object. + + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Implements a class that provide the identity information of + using . + + + + + Maintains the GradientPanel for create the identity. + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Represents a class that provides storage for the object. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + Represents a class that provides style identity information for nested objects of the + class. + + + + + Initializes a new instance of the class. + + + The that owns this sub-object. + + + The descriptor for this expandable sub-object. + + + + + Represents a class to apply the theme for the control. + + + The GradientPanel is a -derived class that has numerous border styles and has a background composed of a multiple gradient brush. + + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + Get or Set of Skin Manager Interface + + + + + It contains the value of the property. + + + + + + Gets or sets the theme name of the control. + + + The default value is null. + + + This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control. + + + + + Get or Set of Visual theme + + + + + Gets or sets a value indicating whether control elements styles can be overridden by theme style settings. + + Default value is false. + + By default, the control's element styles will not be overridden by theme style settings if the style is set in sample level. + If this property is enabled, element style will be overridden by theme style settings event if it is set in sample level. + This property should be enabled or disabled before calling the ThemeName property of the control. + + + + + Gets or sets a value indicating whether a theme settings + can be applied to the control. + + The default value is true. + + This property must be initialized before applying the VisualTheme /> + + + + + Gets or sets the Base Theme name of the theme + + + + + Gets or sets the value used to customize the appearance of the . + + + This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control. + + + + + Gets a value indicating whether the visual style based theme is applied to the control and + also indicates whether the theme files are referred from external assemblies or not. + + Return true, if the visual style based theme is applied to the control. Otherwise returns false. + + + + Gets the name of the control. + + + + + Gets the active theme name of the control. + + Returns the active theme name. + + + + Helps to override the CanOverriderStyle property settings + + CanOverriderStyle + + + + Helps to override the CanApplyTheme property settings + + CanApplyTheme + + + + Raises the event when theme name changed. + + The sender value. + A contains the event data. + + + + Helps to apply the ThemeName settings in control + + ThemeName + + + + Helps to override the ControlName property settings + + ControlName + + + + Default size of the control + + + + + Occurs when border style is changed. + + + + + Occurs when border's 3D style is changed. + + + + + Occurs when border's 2D style is changed. + + + + + Occurs when border color is changed. + + + + + Occurs when gradient background is changed. + + + + + Occurs when vertical gradient is changed. + + + + + Occurs when gradient colors are changed. + + + + + Occurs when border sides are changed. + + + + + Occurs when property is changed. + + + + + Indicates whether the control will ignore the theme's background color and draw the backcolor instead. + + + + + Indicates whether the control is themed. + + + + + Gets or sets the border sides of the panel. + + + + + The background color, gradient and other styles can be set through + this property. + + + The GradientPanel control provides this property to enable specialized + custom gradient backgrounds. + + + + + Gets or Sets whether to have custom scrollbar + + + + + Gets or sets the color array that defines the gradient. + + + This property will be removed in the future. Please use the BackgroundColor property instead. + + + + + Indicates whether the gradient is vertical. + + + This property will be removed in the future. Please use the BackgroundColor property instead. + + + + + Indicates whether the background will be drawn with the gradient. + + + This property will be removed in the future. Please use the BackgroundColor property instead. + + + + + Gets or sets the color of the 2D border. + + + + + + + + + + Gets or sets the 2D border style. + + + + + Gets or sets the border style of the panel. + + + + + Gets or sets the style of the 3D border. + + + + + Required designer variable. + + + + + Gets the ScrollerFrame + + + + + Cleans up any resources being used. + + + + + Required method for designer support - do not modify + the contents of this method with the code editor. + + + + + Gets or Sets the touch mode + + + + + + + + Applies the scaling for controls + + + + + Font changed + + + + + Signals the object that initialization is starting. + + + + + Signals the object that initialization is complete. + + + + + Represents the class to apply the theme for control. + + + Represents panel that has border and collection of + that can be drawn on border. Control perhaps has rounded or right corner. + + + For setting rounded corner, assign property. + You can set space between the bounds of the control and border + using property. Control has two states: collapse or expand. + For change this state use property. + Collapse/Expand state can be used with animation. For using animation, you + must set as true. For specifying speed animation + use . To specify delay for animation use + . + Control can contain , see . + + + + + It contains the value of the property. + + + + + Gets or sets the value used to customize the appearance of the . + + + This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control. + + + + + Helps to apply the ThemeName settings in control + + ThemeName + + + + Helps to override the ThemeName property settings + + ThemeName + + + + Helps to override the OnGotFocus events + + An System.EventArgs that contains the event data. + + + + Invoked when corner radius changed. + + + + + Sets correctly corner radius. + + + + + Gets maximum radius. + + + + + + Find maximum size of the primitive in the collection. + + + + + Refresh work sizes. + + + + + Gets size collapsed control. + + + + + Gets minimum size of the control. + + + + + Gets minimum size of the control relative to Primitives. + + + + + Gets minimum size of the control relative to controls when contains control. + + + + + Refresh location for all primitives + + + + + Sets correctly position of the primitive. + + + + + Gets IDesignerHost interface. + + + + + + Gets start point position primitive from given side. + + + + + Gets end point position of the primitive from given side. + + + + + Gets rectangle which primitive is drawing. + + + + + Sets size of the control. + + + + + Sets correctly border gap. + + + + + Gets minimum border gap for a specific side. + + + + + Find maximum size of the primitive in the collection for a specific side. + + + + + Gets maximum border gap for the specified side. + + + + + Gets minimum border gap. + + + + + Gets rounded path. + + + + + Gets rounded path. + + + + + Gap between primitive and bounds control. + + + + + Minimum lenght for border where draw primitives. + + + + + Default corner radius. + + + + + Gap between border and bounds control. + + + + + Width for pent which draws light line for border. + + + + + Gap between border and side of the primitive. + + + + + Offset for border. + + + + + Offset for border when control is collapse. + + + + + Delay for timer. + + + + + Animation speed. + + + + + Angle degree 0. + + + + + Angle degree 45. + + + + + Angle degree 90; + + + + + Angle degree 180; + + + + + Angle degree 270; + + + + + Indicate that control is collapse or expande. + + + + + Radius truncation of the corner. + + + + + Space between the bound of the control and the border. + + + + + Inner Border Thickness + + + + + Inner Rectangle Border Color + + + + + Inner Rectangle Border Color + + + + + Inner Rectangle Background Brush + + + + + Inner Rectangle Background Brush + + + + + Padding like space between the bounds of the control and the borders. + + + + + Background color for control. + + + + + Graphics path which represent client area. + + + + + Graphics path which represent control area. + + + + + Collection of the Primitives. + + + + + Size of the control for expande state. + + + + + Location of the control for expande state. + + + + + Alignment collapse control. + + + + + Last alignment of the control. + + + + + Use for sets correctly location control regarding client path. + + + + + A value indicating whether the control uses animation. + + + + + Collapsed size of the control. + + + + + Mimimal controls size. + + + + + Rectangle which contains border. + + + + + Uses for animation. + + + + + Indicate that control in process of collapse. + Uses by redraw. + + + + + Delay for animation. + + + + + Speed of animation. + + + + + Indicate that control need redraw. + Uses by redraw before animation. + + + + + Default size of the control + + + + + Gets or sets delay for animation. + + + + + Gets or sets speed of animation. + + + + + Location expanded control. + When control expanded it is Empty. + + + + + Size expanded control. + When control expanded it is Empty. + + + + + Gets or sets a value indicating whether the control uses animation. + + + + + Gets or sets state of the control, collapsed or expanded. + + + + + Gets or sets alignment collapsed control. + + + + + Gets or sets radius truncation corner of the control. + + + + + Gets or sets border gap. + + + + + Gets or sets border gap. + + + + + Gets / Sets the Inner Rectangle Border Thickness + + + + + Resets the Inner Rectangle Border Thickness + + + + + Serializes the Inner Border Thickness + + + + + + Gets / Sets the Inner Rectangle Border Color + + + + + Resets the Inner Rectangle Border Color + + + + + Serializes the Inner Rectangle Border Color + + + + + + Gets / Sets the Inner Rectangle Background Brush + + + + + Resets the Inner Rectangle Background Brush + + + + + Serializes the Inner Rectangle Background Brush + + + + + + Gets or sets graphics path which represent client area. + + + + + Gets or sets graphics path which represent control area. + + + + + Gets collection of the primitives. + + + + + Gets bounds for expanded control. + + + + + Gets size for expanded control. + + + + + Get location for expanded control. + + + + + Initialize animation. + + + + + Initialize control's style. + + + + + Initialize control's colors. + + + + + Initialize primitives. + + + + + Gets or Sets the touchmode + + + + + + + + Applies the scaling + + + + + Font Chnaged + + + + + Draws transparent background. + + + + + Calculates count position of animation. + + + + + Initiate animation. + + + + + Collapsing control. + + + + + Expanding control. + + + + + Check position added control regarding client path. + + True if control contains within client area, otherwise False. + + + + Refresh control path and client path. + + + + + Refresh location for all primitives + + + + + Refresh correctly position and size for all controls + which contain in GradinetPanelExt. + + + + + Refresh work sizes. + + + + + Gets inscribed rectangle in rounded path. + + + + + Gets rectangle which drawing control. + + + + + Gets rectangle which drawing control. + + + + + Gets rounded path. + + + + + Gets graphics path which represent control. + + + + + Gets graphics path which represent client area of the control. + + + + + Gets rectangle which primitive is drawing. + + + + + Gets start point position primitive from given side. + + + + + Gets end point position of the primitive from given side. + + + + + Gets size collapsed control. + + + + + Find maximum size of the primitive in the collection. + + + + + Find maximum size of the primitive in the collection for a specific side. + + + + + Gets minimum border gap. + + + + + Gets minimum border gap for a specific side. + + + + + Gets maximum border gap. + + + + + Gets maximum border gap for the specified side. + + + + + Ensures if the PBorderGap can be set + + + + + Gets maximum radius. + + + + + + Gets minimum size of the control. + + + + + Gets minimum size of the control relative to Primitives. + + + + + Gets minimum size of the control relative to controls when contains control. + + + + + Gets lines which dont contained in border. + + + + + Gets IDesignerHost interface. + + + + + + Gets region when dont draw. + + + + + Draws control. + + + + + Draws the border. + + + + + Draws non-rectangle border. + + + + + Draws light lines for non-rectangle border. + + + + + Draws dark lines for non-rectangle border. + + + + + Draws light arcs for non-rectangle border. + + + + + Draws dark arcs for non-rectangle border. + + + + + Draws rectangle border. + + + + + Draws lines for collapsed control. + + + + + Draws light line for collapsed control. + + + + + Draws dark line for collapsed control. + + + + + Changes size of the control. + + + + + Changes location of the control. + + + + + Sets correctly position of the control regarding client path. + + + + + Determines whether the control is the HostControl. + + + + + Sets correctly corner radius. + + + + + Sets correctly border gap. + + + + + Sets correctly position of the primitive. + + + + + Gets correct size of the control. + + + + + Sets position of the control. + + + + + Hide primitives. + + + + + Show primitives. + + + + + Sets size of the control. + + + + + Hide all controls which contains this control. + + + + + Show all controls which contains this control. + + + + + Gets bound of the control when doing animation. + + + + + Gets rectangle for redwaw when doing animation. + + + + + Gets dark pen for border. + + + + + Gets light pen for border. + + + + + Changes collapse state for each CollapsePrimitive from . + + + + + Raise by method. + + + + + Raise by method. + + + + + Raise by method. + + + + + Raise by method. + + + + + Raise by method. + + + + + Represents the partial class of the GroupView which contains the theme renderer properties and methods. + + + Represents a control that can display a list of items. + + +

+ The GroupView control implements a list type control that can display a set of items where + each item is represented by an image and a descriptor. Items are implemented as + instances of the class. The collection of GroupViewItems in the + control can be accessed through the property that returns + a reference to the object maintained + by the control. +

+

+ The GroupView control is capable of displaying items with large or small icons in various + combinable styles such as the default selectable style, button-type selection, full-item select + and an icon-only flowview mode. All styles are available in the regular 3D or a FlatLook mode. + The control also implements an IntegratedScrolling option that allows scrolling to + be delegated to its parent container. +

+

+ The GroupView control can be used in conjunction with the Essential Tools control + to implement composite controls such as the Microsoft OutlookBar and the Visual Studio.NET toolbox window. + The latter scenario makes use of the IntegratedScrolling feature supported by the two controls. +

+ + + + The sample code shows how to create a GroupView control and initialize the Behavior and Appearance properties + to resemble the Visual Studio.NET toolbox window. A handler for the GroupView.GroupViewItemSelected event + is also shown. + + + + + + + + + + + It contains the value of the property. + + + + + Gets or sets the value used to customize the appearance of the . + + + This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control. + + + + + Helps to apply the ThemeName settings for the . + + ThemeName + + + + Helps to apply the ControlName settings for . + + ThemeName + + + + Gets the rectangle for the items to be drawn + + + + + + Helps to update the renderer settings of . + + PaintEventArgs + + + + Draws the highlighting of GroupViewitem. + + object. + The index of the groupViewItem. + value specifying the GroupViewItem bounds. + The state of the item. + + + + Returns the Backcolor according to the . + + of the GroupViewItem + + + + + Returns the forecolor according to the . + + of the GroupViewItem + + + + + Returns the border color according to the . + + of the GroupViewItem + + + + + Helps to draw text of the . + + object. + The index of the groupViewItem. + value specifying the GroupViewItem bounds. + The state of the item. + + + + Helps to draw the background of the . + + PaintEventArgs object + + + + Helps to draw the drag drop indicator of the . + + object. + Start point of the drag provider + End point of the drag provider + + + + Helps to draw the scroll button of the . + + object. + Rectangle of the ScrollButton + Button direction + + + + Draws the arrow of scrollbuttons for GroupView + + + + + Indicates whether the is enabled / disabled. + + True if the ToolTip is enabled. The default is False. + + + + Indicates whether the items being selected. + + + + + Indicates whether FlowView value was changed during renaming. + + + + + Gets or sets whether tooltips for GroupViewItems should be shown or not. + Use property to get\set ToolTip text. + + + + + Gets or sets the value of the control. + + + + + Store index of which was hitted before current + + + + + Indicate whether is under mouse pointer + + + + + Indicate whether is showing for the first time + + False if the ToolTip isn't showing. The default is True. + + + + Initialize Timer + + + + + Initialize ToolTip + + + + + Shows ToolTip + + A string value representing ToolTip's text + + + + Get which is under mouse pointer + + Represent mouse pointer + + + + Start showing tooltips + + Representint interval before showing ToolTip + + + + Stops showing tooltips + + + + + Gets/Sets Control size before touch enabled + + + + + Gets or Sets the touchmode + + + + + + + + Applies the scaling + + + + + Font changed + + + + + ToolTip last mouse buttons downed. + + + + + ToolTip last mouse downed time. + + + + + ToolTip last mouse downed point. + + + + + Indicates whether control should show GroupViewItem text in FlowView mode. + + + + + Stores length in FlowView mode. + + + + + GroupViev orientation. + + + + + Gets or sets GroupViev orientation. + + + + + Gets or sets ToolTip last mouse buttons downed. + + + + + Gets or sets ToolTip last mouse downed time. + + + + + Gets or sets ToolTip last mouse downed point. + + + + + Gets the small icon width of the GroupViewItem based on DPI + + Width of the Icon + + + + Gets the large icon width of the GroupViewItem based on DPI + + Width of the Icon + + + + Gets the spacing between text and image + + spacing between text and image + + + + Gets the height between the highlighted edge of a GroupViewItem and the image. + + spacing between highligheted edge of item and image + + + + Gets the horizontal distance between a GroupViewItem and the control's left border. + + + + + + Gets the vertical distance between a GroupViewItem and the control's bottom border. + + + + + + Gets the GroupViewItem Bounds. + + GroupViewItem index + Padding between the GroupViewItem + Bounds + + + + Gets the GroupViewItem Bounds. + + GroupViewItem index + Padding between the GroupViewItem + Bounds + + + + The collection of objects present in the GroupView control. + + + Each item in a control is an instance of a + type and the collection is represented by the GroupViewItemCollection class. + The GroupViewItemCollection class implements the IList and ICollection interfaces. + + + + + + Occurs when a is changed. + + + + + Raises the collection changed event. + + + + + Gets / sets a in the collection. + + The zero-based index of the GroupViewItem to get or set. + + + + Creates a new instance of the class. + + The control that contains this collection. + + + + Adds the GroupViewItem to the collection. + + The to be added. + The zero-based index of the new item within the collection. + + + + Inserts the into the collection at the specified index. + + The zero-based index at which the item is to be inserted. + The to be inserted. + + + + Removes the GroupViewItem from the collection. + + The to be removed. + + + + Adds an array of GroupViewItems to the control's collection. + + An array of objects. + + + + Indicates whether the specified GroupViewItem is present in the collection. + + The to locate in the collection. + True if the item is present; False otherwise. + + + + Returns the zero-based index of the GroupViewItem. + + The to locate in the collection. + The zero-based index of the item; -1 if the item cannot be found. + + + + Specifies the name of the custom type used for drag-and-drop. + + + + + Name visible property for PropertyChangedEventArgs + + + + + ArrayList visible items. + + + + + Gets ArrayList visible items. + + + + + Holds the backcolor of metro theme + + + + + Occurs when a in the + control is selected. + + + Use the property to get the index of the newly + selected item. + + + + + Occurs when a GroupViewItem is double clicked. + + + + + Occurs when a in the control is highlighted. + + + Use the property to get the index of the newly + selected item. + + + + + Occurs after the items in a control have been reordered by a + drag-and-drop operation. + + + + + Occurs after a has been renamed by an in-place edit operation. + + + See and . + + . + + + + Occurs when the right mouse button is clicked over the control. + + The property will provide the index + of the over which the mouse was clicked. + + + + Default size of the control + + + + + Gets / sets the collection of objects in the control. + + An instance of the type. + + + + Gets or sets the height between the highlighted edge of a and the image. + + + In mode, the ImageSpacing value also + dictates the horizontal distance between the highlighted edge and the image. + + An integer value. + + + + Gets / sets the distance between the image and the text. + + + In large icon mode, this attribute represents the vertical distance between the GroupViewItem image and the text, + while in small icon mode, it represents the horizontal distance between the two. + + An integer value. + + + + Gets / sets the horizontal distance between a and the control's left border. + + An integer value. + + This attribute is valid only when is True. In large image view, the items are drawn centered. + + + + + Gets / sets the height between adjacent s. + + An integer value. + + + + Gets or sets the 's text length in FlowView mode. + + An integer value. + + + + Gets or sets the distance by which the image is offset when the mouse is moved over it. + + A value. + + + + Resets the property to its default value. + + + + + Gets or sets the distance by which the text is offset when the mouse is moved over it. + + A value. + + + + Resets the property to its default value. + + + + + Gets the office2016 style colors respective to the style + + + + + Holds the office2016 colorscheme + + + + + Gets or sets the office2016 colorscheme + + + + + Reset the Office2016ColorScheme + + + + + + Serializes the Office2016ColorScheme + + + + + + Holds the style + + + + + Gets or sets the style + + + + + Reset the Style + + + + + + Serializes the Style + + + + + + Occurs when the style changes + + + + + Gets / sets the distance by which the image is offset when it is selected. + + A value. + + + + Resets the property to its default value. + + + + + Gets / sets the distance by which the text is offset when it is selected. + + A value. + + + + Resets the property to its default value. + + + + + Gets / sets the distance by which the selected image is offset when the mouse is moved over it. + + A value. + + + + Resets the property to its default value. + + + + + Gets / sets the distance by which the selected text is offset when the mouse is moved over it. + + A value. + + + + Resets the property to its default value. + + + + + Gets / sets the distance by which the image is offset when it is being selected. + + A value. + + + + Resets the property to its default value. + + + + + Gets / sets the distance by which the text is offset when it is being selected. + + A value. + + + + Resets the property to its default value. + + + + + Gets / sets the image list containing the large (32x32) images. + + + + + An ImageList type. + + + + Gets / sets the image list containing the small (16x16) images. + + An ImageList type. + + + + + + + Indicates whether the control displays items using the images in the . + + True if the small image mode is set. The default is False. + + + + Indicates whether items are drawn with a button-type flat look upon selection. + + True if the button-type selection is set. The default is False. + + + + Indicates whether the flow view display mode is set. + + + In the default display mode, the control items are arranged top-down in list form. + In the flow mode, however, item images are arranged side by side for the full width of the control. + Resizing the control will wrap the images. Text will not be displayed in this mode, + unless the ShowFlowViewItemText property set to True. + + True if flow view is set. The default is False. + + + + Indicates whether control should show GroupViewItem text in FlowView mode. + + + True if should show text. The default is False. + + + + + Indicates whether scrolling should be delegated to the control's parent. + + + This option is primarily intended for use with the Syncfusion control. + When this option is set, the GroupView control delegates scrolling behavior to the + parent GroupBar control. When IntegratedScrolling is set to False, the control provides its own scroll buttons. + + True to enable integrated scrolling. The default is False. + + + + + Gets / sets the index of the currently selected . + + The zero-based index of the selected item. -1 if a selected item is not available. + + + + Returns the over which the mouse cursor is hovering. + + The zero-based index of the item under the cursor. -1 if no item is being highlighted. + + + + Returns the index of that triggered the event. + + The zero-based index of the item. + + + + Gets / sets a value indicating whether the image is highlighted when the mouse is moved over it. + + False if image highlighting is disabled. The default is True. + + + + Indicates whether the text is highlighted when the mouse is moved over it. + + False if text highlighting is disabled. The default is True. + + + + Indicates whether the text is underlined when the mouse is moved over it. + + True if text underlining is enabled. The default is False. + + + + Gets or sets the color used for drawing the background of a when the mouse is moved over it. + + A value. + + + + Resets the property to its default value. + + + + + Gets / sets the color used for drawing the background of the selected . + + A value. + + + + Resets the property to its default value. + + + + + Gets / sets the color used for drawing the background of the selected when the mouse is moved over it. + + A value. + + + + Resets the property to its default value. + + + + + Gets / sets the color used for drawing the background of the being selected. + + A value. + + + + Resets the property to its default value. + + + + + Gets or sets the color used for drawing the text when the mouse is moved over it. + + A value. + + + + Resets the property to its default value. + + + + + Gets / sets the color used for drawing the selected text. + + A value. + + + + Resets the property to its default value. + + + + + Gets / sets the color used for drawing the selected text when the mouse is moved over it. + + A value. + + + + Resets the property to its default value. + + + + + Gets / sets the color used for drawing the text while it is being selected. + + A value. + + + + Resets the property to its default value. + + + + + Gets or sets the brush used for drawing the control background. + + A value. + + + + Gets / sets the color used for drawing the Metro style border + + A value. + + + + Resets the property to its default value. + + + + + Gets or sets the brush used for drawing the background of the selected . + + A value. + + + + Gets or sets the brush used for drawing the background of the selected + when the mouse is moved over it. + + A value. + + + + Gets or sets the brush used for drawing the background of the highlighted . + + A value. + + + + Gets or sets the brush used for drawing the background of the being selected. + + A value. + + + + Gets or sets the border style of the control. + + A value. The default is BorderStyle.Fixed3D. + + + + Indicates whether the text should be wrapped. + + + Text wrapping is available only with the large icon display mode. + + True to turn on wrapping. The default is False. + + + + Indicates whether the control is displayed with a flat look. + + True to display in flat mode. The default is False. + + + + Indicates whether XP Themes (visual styles) should be used for drawing the control. + + True to turn on themes; the default is False. + + + + Gets a value indicating whether the control supports drop. + + + + + Indicates whether the control supports drag-and-drop of objects. + + + + + Allow drag any object. + + + + + Gets or sets allow drag any object. For use this property AllowDragDrop must be true. + + + + + Indicates whether the selection bounds of a are clipped around its image and text. + + A Boolean value. The default is False. + + + + Gets the Height of the Item's Text. + + + + + Creates a new instance of the control. + + + + + Starts an in-place edit of the specified text. + + + Invoking this method will create an editable text box and and populate it with + the item text. Editing the textbox contents and selecting ENTER will update the item text. + Selecting ESC will cancel the edit. + + The zero-based index of the item to be renamed. + + + + + Cancels an inplace renaming that is in progress. + + + + + + Brings the specified into the visible area of the control. + + The zero-based index of the item. + + + + Raises the event. + + A value that contains the event data. + + + + Raises the GroupView Item double click event. + + GroupViewItemDoubleClickEventArgs + + + + Raises the event. + + A value that contains the event data. + + + + Raises the event. + + A value that contains the event data. + + + + Raises the event. + + A value that contains the event data. + + + + Raises the event. + + A value that contains the event data. + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Size changed + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Called by the tab control when mouse hovers on the control. + + The instance containing the event data. + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overloaded. Returns the GroupViewItem at the specified point in client coordinates. + + X - coordinate of the item. + Y- coordinate of the item. + GroupViewItem, whose area contains specified point; null, if nothing is found. + + + + Returns GroupViewItem at the specified point in client coordinates. + + Point where the GroupViewItem is located. + GroupViewItem, whose area contains specified point; Null, if nothing is found. + + + + Retrieving Image with its default image size + + Expected size of the images + collection of images which is need to be changed + New image list with updated image size + + + + Draws the highlighting of GroupViewitem. + + A object. + The index of the groupViewItem. + A value specifying the GroupViewItem bounds. + The state of the item. + + + + Overridden. See . + + + + + Variable which denotes the value changed of TextSpacing property + + + + + Variable which denotes the value changed of ImageSpacing property + + + + + Variable which denotes the value changed of ItemYSpacing property + + + + + Variable which denotes the value changed of ItemXSpacing property + + + + + Displays a set of related controls as selectable groups or tabs. + + +

+ The GroupBar class implements a container that can serve as a host for other controls. + The control is functionally similar to the Windows Forms + and provides a tab user-interface that will display only one control, the , + at any given time. +

+

+ Each control in the GroupBar is associated with a and the + various GroupBarItems are arranged in a vertical stack. Clicking on a GroupBarItem will make + it the current selected item and the client control tied to that item will be displayed + within the GroupBar's client region. The collection of GroupBarItems in the control is + implemented as an instance of the type and + can be accessed and manipulated through the property. +

+

+ The GroupBar can be used in combination with the Syncfusion control + to implement composite controls with user interfaces similar to the Outlook Bar in + Microsoft Outlook and the toolbox window present in the Visual Studio.NET development environment. +

+ + + + The sample code shows how to create a GroupBar, create and add two GroupBarBarItems, and + assign client controls to each of the GroupBarItems. + + + + + + + + + + + It contains the value of the property. + + + + + Gets or sets the value used to customize the appearance of the . + + + This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control. + + + + + Helps to apply the ThemeName settings for the . + + ThemeName + + + + Helps to apply the ControlName settings for . + + ThemeName + + + + Draws GroupBarItem for theme renderer + + Graphics used for drawing + Zero-Based index of the GroupBarItem + Rectangle used to draw the GroupBarItem + + + + Draws text of the GroupBarItem for theme renderer + + Graphics used for drawing + Zero-Based index of the GroupBarItem + Rectangle used to draw the GroupBarItem text + + + + Draws border od the GroupBar + + Graphics used for drawing + Rectangle used to draw the border + + + + Draw header background of stacked groupbar + + Graphics used for drawing + Rectangle used to draw the header + + + + Draws Header text of the stacked groupbar + + Graphics used for drawing + Text to be drawn + Rectangle used to draw the header + + + + Gets the background color of the GroupBarItem according to the item state + + State of the GroupBarItem + Indicates the item enabled + + + + Sets the size of ToopTip based on the font. + + + + + + + Gets the foreground color of the GroupBarItem according to the item state + + State of the GroupBarItem + Indicates the item enabled + + + + Draws stacked GroupBar for theme renderer + + Graphics used for drawing + Rectangle used to draw the Stacked GroupBar + + + + Draws expand/collapse button for theme renderer + + Graphics used for drawing + + + + Draws Navigation pane for GroupBar Renderer + + Graphics used for drawing + Rectangle used to draw the navigation pane + + + + Draws DropDown button for GroupBar Renderer + + Graphics used for drawing + Rectangle used to draw the button + Indicates whether orientation is RightToLeft + + + + Draws collapsed client area background for GroupBar Renderer + + Graphics used for drawing + + + + Draws the collapse expand button + + Graphics used for drawing + Rectangle used to draw the button + + + + Draws the tooltip for theme + + Tooltip object invokes the event + DrawToolTipEventArgs of the tooltip + + + + Draws the navigation pane text for theme + + Graphics used for drawing + Indicates whether RightToLeft applied + + + + Draws background of the GroupBar + + + + + Draws border of the GroupBar + + + + + The collection of objects in the control. + + + Each group in the GroupBar is an instance of the GroupBarItem type and + the collection of these groups is represented by an instance of the + GroupBarItemCollection class. GroupBarItems may be added or removed using the + IList and ICollection interface methods implemented by the GroupBarItemCollection. + + + + + + Gets / sets a in the collection. + + The zero-based index of the GroupBarItem to get / set. + + + + Creates an instance of the GroupBarItemCollection class. + + The control that contains this collection. + + + + Adds the to the collection. + + The to be added. + The index of the new item within the collection. + + + + Inserts the into the collection at the specified index. + + The zero-based index at which the item is to be inserted. + The to be inserted. + + + + Removes the specified by the index parameter. + + A zero-based index specifying the GroupBarItem to be removed. + + + + Removes the from the collection. + + The to be removed. + + + + Adds an array of GroupBarItems to the control's collection. + + An array of objects. + + + + Indicates whether the specified is present in the collection. + + The to locate in the collection. + True if the item is present; False otherwise. + + + + Returns the zero-based index of the in the collection. + + The to locate in the collection. + The zero-based index of the item; -1 if the item is not present. + + + + Collection of visible + + + + + Visible group bar items array list. + + + + + Copies the elements of the to an , starting at a particular index. + + + + + Gets the number of elements contained in the . + + + + + Gets an object that can be used to synchronize access to the . + + + + + Gets a value indicating whether access to the is synchronized (thread safe). + + + + + Returns the enumerator that iterates through the item collection. + + + + + Holds the Office2016 Theme colors + + + + + Indicates whether ScrollBar is displayed + + + + + Scroll Position + + + + + ScrollerFrame + + + + + Indicates whether to show the chevron button on the Navigation Panel + in the stacked GroupBar. + + + + + Collection of visible group bar items. + + + + + Gets or sets the color of the splitter in GroupBar if GroupBar is in stacked mode + + + + + Enable to change the color of the splitter in stacked mode. + + + + + Colors for Office2007 visual style. + + + + + Colors for Office2010 visual style. + + + + + Default item height for Office2019Theme + + + + + Indcates the touch down is enabled or not. + + + + + Default size of the control + + + + + Default size of the collapsebutton + + + + + Header font + + + + + barItem height + + + + + Header height + + + + + Collapsedwidth + + + + + Gets or sets a value indicating whether GroupBarItem background color is changed internally or not. + + + + + Occurs when a in the control + is selected. + + + Use the property to get the index of the newly + selected item. + + + + + Occurs when a in the control is being selected. + + + + + Occurs after a has been renamed by an in-place edit operation. + + See and . + . + + + + Occurs after a has been added to the collection. + + See and . + + + + Occurs after a has been removed from the collection. + + See and . + + + + Occurs when the right mouse button is clicked over the control. + + The property will provide the index + of the over which the mouse was clicked. + + + + Occurs when a is about to be drawn. + + + Handle this event to provide a custom brush for painting the GroupBarItem background. + + See and . + + + + Occurs when the user clicks on the control's navigation pane drop-down button. + + + This GroupBar control displays the navigation pane only when the property is set. + + See and . + + + + Specifies the type of rendering done to icons + + + + + Returns the collection of visible group bar items. + + + + + Returns the collection of s in the control. + + An instance of the type. + + + + Gets / sets the alignment of the text displayed on the . + + A value. The default value is TextAlignment.Center. + + + + Indicates whether applying the default forecolor for GroupBar as per the visual style + + True if highlighting is enabled. The default is True. + + + + Indicates whether moving the mouse cursor over a will highlight it. + + True if highlighting is enabled. The default is True. + + + + Indicates whether switching between different s is animated. + + True if animated selection is enabled. The default is True. + + + + Gets / sets an integer that represents the index of the current selected . + + An integer value that specifies the zero-based index of the GroupBarItem. + + + + Returns the index of the that is currently under the mouse cursor. + + An integer value that specifies the zero-based index of the GroupBarItem. + + + + Returns the index of the that triggered the event. + + The zero-based index of the item. + + + + Gets / sets the height. + + An integer value that specifies the item height. + + + + Indicates whether integrated scroll buttons are to be used. + + This option is primarily intended for use with the Syncfusion control. + When this flag is set, the provides the scroll buttons for the current + selected GroupView control and interacts with it to achieve seamless scrolling behavior. + + True to enable integrated scrolling. The default is False. + + + + + Gets / sets the border style of the control. + + A value. The default is BorderStyle.Fixed3D. + + + + Indicates whether XP Themes (visual styles) should be used for drawing the control. + + True to turn on themes; the default is False. + + + + Indicates whether the control is displayed with a flat look. + + True to display in flat mode. The default is False. + + + + Indicates the style to be used for drawing the control. + + A value; the default is VisualStyle.OfficeXP. + + + + Method to apply office2016 style to Tooltip + + + + + Draws office2016 theme tooltip + + + + + + + Indicates the Office2007 theme used for drawing the control. + + + + + Indicates the Office2010 theme used for drawing the control. + + + + + Gets / sets the cursor that is displayed when the mouse pointer is over the control. + + A object. + + + + Gets / sets the cursor that is displayed when the mouse pointer is over the s. + + A object. + + + + Indicates whether the s are displayed in a stack. + + +

When the property is set, the GroupBarItems are stacked at + the bottom of the control on top of a navigation pane. The stack size can be increased + or decreased by moving items to and from the navigation pane.

+ NOTE: The StackedMode interface is similar to the Navigation Pane in Microsoft Outlook 2003. + + True to set the stacked mode. The default is False. + + + + Resets the Splittercolor + + + + + ShouldSerialize the AddButtonHoverColor. + + + + + Resets the EnableSplittercolorCustomization + + + + + ShouldSerialize the EnableSplittercolorCustomization. + + + + + + Gets / sets the height of the header. + + + The GroupBar header is shown only when the property is set. + + An integer value that specifies the header height. + + + + Gets / sets the font of the text displayed in the header. + + + The GroupBar header is shown only when the property is set. + + A value. + + + + Resets the property to its default value. + + + + + Gets / sets the forecolor for the header. + + + The GroupBar header is shown only when the property is set. + + A value. + + + + Resets the property to its default value. + + + + + Gets / sets the backcolor for the header. + + + The GroupBar header is shown only when the property is set. + + A value. + + + + Resets the property to its default value. + + + + + Gets / sets the height of the navigation pane. + + + The navigation pane is shown only when the property is set. + + An integer value that specifies the height. + + + + Gets / sets the width of the s shown in the navigation pane. + + + The navigation pane is shown only when the property is set. + + An integer value that specifies the GroupBarItem width. + + + + Indicates whether a border is drawn around the 's client window. + + + The border colors for each can be individually specified using the + property. + + A boolean value; the default is False. + + + + Gets / sets the menu provider object that will implement the 's contextmenu. + + + The GroupBar control automatically initializes this property depending on the presence of the Syncfusion Essential Tools library. + If Essential Tools is available, then the menu provider object will be an instance of the + type. If not, the class is used for implementing the standard .NET context menu. +

The GroupBar's automatic initialization should suffice for most applications and you should explicitly set this property + only when you want to override the default menu provider assignment.

+ + A implementation; the default is . + + + + Indicates whether the Chevron button on the + Navigation Panel is shown in the Stacked GroupBar. + + + The navigation pane is shown only when the property is set. + + + + + Indicates whether the selected item's image is shown in header in the Stacked GroupBar. + + + + + Indicates the color of the 2D border. + + + + + + + + + + + + + + + + Gets/Sets Control size before touch enabled + + + + + Gets or Sets the touchmode + + + + + + + + Applies the scaling + + + + + Gets a value of GroupBarItem height based on DPI + + Height of GroupBar item + + + + Gets a value of GroupBar Header height based on DPI + + Height of GroupBar Header + + + + Gets a width of the collapsed GroupBar based on DPI + + Width of the collapsed group bar + + + + Gets a height of the navigation pane based on DPI + + Height of navigation pane + + + + Gets the width of the navigation button based on DPI + + Width of the navigation button + + + + Font changed + + + + + + + + + Creates a new instance of the class. + + + + + Starts an in-place edit of the specified text. + + Invoking this method will create an editable text box and and populates it with + the item text. Editing the text box contents and selecting ENTER will update the GroupBarItem text. + Selecting ESC will cancel the edit. + The zero-based index of the item to be renamed. + + + + + Cancels an in-place edit that is in progress. + + + + + + Raises the event. + + A value that contains the event data. + + + + Raises the event. + + A value that contains the event data. + + + + Raises the event. + + A value that contains the event data. + + + + Raises the event. + + A value that contains the event data. + + + + Raises the event. + + An value that contains the event data. + + + + Raises the event. + + A value that contains the event data. + + + + Raises the event. + + A value that contains the event data. + + + + Overridden. See . + + + + + Overridden. See . + + + + + Draws the group bar control. + + A object. + + + + Draws the stacked group bar. + + The GPH. + + + + Draws the Header for . + + The control calls this method to paint the specified GroupBar Header. + Override this method to customize the GroupBar Header drawing. + + A object. + + + + Draws the object. + + The control calls this method to paint the specified GroupBarItem. + Override this method to customize the GroupBar drawing. + + A object. + The zero-based index of the to be drawn. + A value specifying the GroupBarItem bounds. + + + + Helps to apply the background color of GroupBarItem. + + graphics to draw on + group bar item + rectangle to fill the back color + back color + + + + Draws a border around the selected client control. + + The control calls this method to paint a border around the + the current selected client control. Override this method to customize the GroupBar drawing. + + A object. + A value specifying the client control bounds. + + + + Draws the icon. + + + The control calls this method to paint the specified + GroupBarItem's icon. Override this method to customize the GroupBar drawing. + + A object. + The zero-based index of the for which the icon is drawn. + A value specifying the GroupBarItem bounds. + + + + Draws the icon. + + + The control calls this method to paint the specified + GroupBarItem's icon. Override this method to customize the GroupBar drawing. + + A object. + The zero-based index of the for which the icon is drawn. + A value specifying the GroupBarItem bounds. + + + + Returns the String format for text drawing. + + + + + Returns the string format object for header drawing. + + + + + Draws the text. + + + The control calls this method to paint the specified + GroupBarItem's text. Override this method to customize the GroupBar drawing. + + A object. + The zero-based index of the for which the text is drawn. + A value specifying the GroupBarItem bounds. + + + + Draws icon\image in navigation panel. + + + + + + + + Draws the drop down button. + + A object. + A value specifying the GroupBarItem bounds. + If set to true button is mirrored for RTL. + + + + Overridden. See . + + + + + Indicates, if process of setting client for is in progress. + + + + + Gets or Sets a value indicating whether selection logic includes visible items alone for SelectedItem calculation. + + + + + Gets or Sets a value indicating whether selection logic includes visible items alone for SelectedItem calculation. + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overrides the MouseWheel event + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + + + Index of selected item is VisibleGroupBarItems + Index of selected item is GroupBarItems collection + + + + Gets the GroupBarItem from the corresponding mouse point. + + + + + Overloaded. Returns the GroupBarItem at the specified point in client coordinates. + + X - coordinate of the item. + Y - coordinate of the item. + GroupBarItem, whose area contains the specified point; Null, if nothing is found. + + + + Returns GroupBarItem at specified point in client coordinates. + + Point to search GroupBarItem at. + GroupBarItem, whose area contains the specified point; Null, if nothing is found. + + + + Creates and displays the drop-down button context menu. + + + + + Initializes the navigation button menu. + + The context menu provider used to create the menus. + + + + Raises the navigation pane button click event. + + An that contains the event data. + + + + Called when more buttons menuitem is clicked. + + An that contains the event data. + + + + Called when fewer buttons menuitem is clicked. + + An that contains the event data. + + + + + + + Helps to apply the Visual Style for Scroll Bar + + + + + Helps to update the Bounds of GroupBarItems + + + + + Helps to update the Bounds of GroupBarItems, when Scrolling action is performed + + AutoScrollPosition + + + + Overridden. See . + + + + + Signals the object that initialization is starting. + + + + + Signals the object that initialization is complete. + + + + + Get is control initializing. + + + + + + + + + + + + + + + Indicates whether is collapsed. + + + + + Stores value while initialization. + + + + + Indicates whether can be collapsed. + + + + + Width of the collapsed . + + + + + Width of the expanded . + + + + + Item popup's client heigth. + + + + + Text shown in collapsed client area of GroupBar. + + + + + Collapse button's state. + + + + + Collapsed client area's state. + + + + + Collapse button's image in expanded state. + + + + + Collapse button's image in collapsed state. + + + + + Collapse button's tooltip, when control is expanded. + + + + + Group Bar button's tooltip. + + + + + GroupBarDropDownTooltip. + + + + + Navigation pane's tooltip. + + + + + 's popup. + + + + + Indicates whether item popup is allowed to be opened. + + + + + Image list for navigation menu in collapsed mode. + + + + + Image list for navigation menu for add/remove sub menu. + + + + + Size of the popup for GroupBarItem client. + + + + + item to its popup size mapping. + + + + + Indicates whether to show popup's gripper. + + + + + Popup's resize mode. + + + + + Indicates whether popup is shown to the left of . + + + + + Indicates whether popup is shown to the top of + + + + + Indicates whether popup is closed after clicking on item. + + + + + for drawing . + + + + + Default collapse button's image in expanded state. + + + + + Default collapse button's image in collapsed state. + + + + + Group Bar button's tooltip. + + + + + Collapse button's tooltip, when is expanded. + + + + + Collapsed client area's tooltip. + + + + + Caption for add/remove parent menu item in navgation menu. + + + + + Gets or sets a value indicating whether this is collapsed. + + + Works only is in stacked mode. + + + + + + Gets or sets a value indicating whether can be collapsed. + + + + + + Gets or sets the width of the collapsed . + + + + + Gets or sets the text shown in collapsed client area of . + + + + + Resets the property to its default value. + + + + + Resets the property to its default value. + + + + + Indicates whether property should be serialized. + + + + + Indicates whether property should be serialized. + + + + + Gets or sets the image of the collapse button in expanded state. + + + + + Resets the property to its default value. + + + + + Indicates whether property should be serialized. + + + + + Gets or sets the image of the collapse button in collapsed state. + + + + + Resets the property to its default value. + + + + + Indicates whether property should be serialized. + + + + + Gets or sets the initial size of the popup for client. + + + + + Gets or sets a value indicating whether to show popup's gripper. + + + + + Gets or sets the popup's resize mode. + + + + + Gets or sets the tooltip for collapse button, when control is expanded. + + + + + Resets the property to its default value. + + + + + Indicates whether property should be serialized. + + + + + Gets or sets the tooltip for collapse button, when control is collapsed. + + + + + Indicates whether property should be serialized. + + + + + Resets the property to its default value. + + + + + Gets or sets the tooltip for GroupBarDropDownToolTip. + + + + + Resets the property to its default value. + + + + + Indicates whether property should be serialized. + + + + + Gets or sets the navigation pane's tooltip. + + + + + Resets the property to its default value. + + + + + Indicates whether property should be serialized. + + + + + Gets or sets a value indicating whether popup is closed after clicking on item. + + + + + Occurs when property is changed. + + + + + Occurs when property is about to be changed. + + Can cancel state changing. + + + + Provides data for the event. + + The collapsed control uses the events to notify users, + that 's popup is about to be shown. + + + + + + Item that popup. + + + + + Popup's bounds. + + + + + Indicates whether popup is shown to the left of . + + + + + Indicates whether popup is shown to the top of + + + + + Initializes a new instance of the class. + + The item. + The popup's bounds. + true to cancel the event; otherwise, false. + + + + Initializes a new instance of the class. + + The item. + The popup's bounds. + + + + The that popups. + + + + + Gets or sets the popup's bounds. + + + + + Indicates whether popup is shown to the left of . + + + + + Indicates whether popup is shown to the top of + + + + + Represents the method that will handle the event in the control. + + The source of the event. + A that contains the event data. + + + + Occurs when before 's popup is shown. + + Can cancel popup showing. + + + + Shows the item popup when the Group bar is Collapsed + + + GroupBar Item for which Popup to be shown + + + + + Hides the 's popup. + + + + + Variable to denotes the value changed of GroupBarItemHeight + + + + + Variable to denotes the value changed of GroupBarHeaderHeight + + + + + Variable to denotes the value changed of Collapsed width of GroupBar + + + + + Variable to denotes the value changed of Navigation Pane height of GroupBar + + + + + Variable to denotes the value changed of width of the navigation button + + + + + Gets the back color of the AutoLabel for office2016 colorful style. + + + + + Gets the Fore color of the AutoLabel for office2016 colorful style. + + + + + Gets the Fore color of the AutoLabel, when control is disabled. + + + + + Gets the Border color of the AutoLabel for office2016 colorful style. + + + + + Gets the back color of the AutoLabel for office2016DarkGray style. + + + + + Gets the Fore color of the AutoLabel for office2016DarkGray style. + + + + + Gets the Border color of the AutoLabel for office2016DarkGray style. + + + + + Gets the Border color of the AutoLabel for office2016 colorful style. + + + + + Gets the back color of the AutoLabel for office2016Black style. + + + + + Gets the Fore color of the AutoLabel for office2016Black style. + + + + + Gets the Border color of the AutoLabel for office2016Black style. + + + + + Represents the class to define the style of control. + + + + + Maintains the default style of the . + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + The store. + + + + Gets the default AutoLabelStyleInfo value. + + + + + Gets or sets the value for corner radius of the + control. + + + + + Gets or sets the value for the drop down of + control. + + + + + Gets or sets the background color of the control. + + + + + Gets or sets the fore color value of the items of control in disabled state. + + + + + Gets or sets the fore color value of the control. + + + + + Gets or sets the fore color value of the items of control in disabled state. + + + + + Gets or sets the value used to draw the border of the + control in default state. + + + + + Gets or sets the fore color value of the items of control in disabled state. + + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Represents the class holds the plain data for a style object excluding identity information. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Maintains the static data. + + + + + + Initializes a new instance of the class. + + Populates the SerializationInfo store with the name, type, and value of each piece of information it wants to serialize + Describes the source and destination of a given serialized stream, and provides an additional caller-defined context. + + + + Overridden to get the static data source. + + + + + Implements the class that provide the identity information of + using . + + + + + Maintains the AutoLabel for create the identity. + + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Represents a control with advanced customization options on background, text, and border etc. + + + A derived class that lets you label any control with it. + + + Once a control is labeled by an instance of AutoLabel (through the property, + the label gets moved around as the labeled control moves around + automatically, preserving the relative positions. The relative positions can + also be configured to be left, top or custom through the property. + + Note that the manager will treat the label and its control as a + pair, always laying them out together as if they were one single control. + + + + + using System.Windows.Forms; + namespace AutoLabel + { + public partial class Form1 : Form + { + private Syncfusion.Windows.Forms.Tools.AutoLabel autoLabel1; + public Form1() + { + InitializeComponent(); + //Initialization + this.autoLabel1 = new Syncfusion.Windows.Forms.Tools.AutoLabel(); + //Set the properties + this.autoLabel1.Text = "autoLabel1"; + this.autoLabel1.BackColor = System.Drawing.Color.DarkGray; + this.autoLabel1.ForeColor = System.Drawing.Color.DarkBlue; + this.autoLabel1.Font = new System.Drawing.Font("Microsoft Sans Serif", 8.25F, System.Drawing.FontStyle.Bold, System.Drawing.GraphicsUnit.Point, ((byte)(0))); + this.autoLabel1.TextAlign = System.Drawing.ContentAlignment.MiddleCenter; + // Add the AutoLabel control to the form. + this.Controls.Add(this.autoLabel1); + } + } + } + + + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + Occurs when theme name of the has changed. + + + + + It contains the value of the property. + + + + + Gets or sets a value indicating whether a . + has been applied to the control. + + The default value is true. + + + + + Gets or sets the theme name of the control. + + + + + Gets or sets a value indicating whether control elements styles can be overridden by settings. + + Default value is false. + + By default, the control's element styles will not be overridden by settings if the style is set in sample level. + If this property is enabled, element style will be overridden by settings event if it is set in sample level. + This property should be enabled or disabled before calling the property of the control. + + + + + + + Gets or sets the BaseTheme name of the theme + + + + + Gets the name of the control. + + + + + Gets a value indicating whether the visual style based theme is applied to the control and + also indicates whether the theme files are referred from external assemblies or not. + + Return true, if the visual style based theme is applied to the control. Otherwise returns false. + + + + + + Gets the active theme name of the control. + + Returns the active theme name. + + + + Gets or sets the value used to customize the appearance of the . + + + This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control. + + + + + + + Raises the event when themename changed. + + The sender value. + A contains the event data. + + + + Apply themes based on the theme name passing in the + + Represents style for the control + + + + Value for PreferredHeight adding when borders are present. + + + + + Value for PreferredHeight adding when borders are absent. + + + + + Initializes a new instance of the class. + + + + + Font changed + + + + + Fired when the Control, and properties of this class changes. + + + + + Raises the PropertyChanged event. + + + An object containing data pertaining to this event. + + + The OnPropertyChanged method also allows derived classes to handle the event + without attaching a delegate. This is the preferred technique for + handling the event in a derived class. + Note to Inheritors: When overriding OnPropertyChanged in a derived + class, be sure to call the base class's OnPropertyChanged method so that + registered delegates receive the event. + + + + + Sets the specified bounds of the label. + + + + + + + + Get location of the when the parameters that affect + the relative positions have changed (like the LabeledControl's position, size, etc.). + + + + + + + + + + + + + + Updates the position of the when the parameters that affect + the relative positions have changed (like the LabeledControl's position, size, etc.). + + + + + Called when a new control is getting labeled (when set through the property. + + The control that is being labeled. + + + + Called when an exisiting label is getting unlabeled. + + The control that is being unlabeled. + + + + + + + Update the renderer for Office2016 style. + + + + + Gets or sets the to the . + + + + + + Gets or Sets of Interface. + + + + + Gets or sets the control is enabled. + + + + + + + Processes Windows messages. + + The Windows System.Windows.Forms.Message to process. + + + + Paints the control. + + + + + Draw the border to the contol. + + Represents the Graphics to draw. + Represents the dimension of border. + Represents the color of border. + + + + Gets or sets a value indicating whether the control is automatically resized + to display its entire contents. + + + + + + + Gets or sets the control that is being labeled. + + A control instance. + + + + Gets or sets the relative position of the control and the . + + + + + + + + Gets or sets the horizontal and vertical gap to use when computing the relative position. + + + + + + + + + + Gets or sets the effective horizontal distance between the left of the and its labeled control. + + When == DX is the distance between the right of the labeled control + and the right of the . + + + + + + + + + Gets or sets the effective vertical distance between the top of the AutoLabel and its labeled control. + + + + + + + + + + Calculates the size of the label's text. + + Text for measuring. + Current font. + Size of the text. + + + + Represents a class to define the style for the control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Holds instance of a class. + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + Holds instance of a class + + + + Gets the default style value for the control. + + + + + Gets or sets the value used to draw the fore color of the + control when text value is negative. + + The value is used to fill the fore color of the textbox. + + + + Gets or sets the value used to draw the fore color of the + control when text value is zero. + + The value is used to fill the fore color of the textbox. + + + + Gets or sets the value used to draw the back color of the + control when text value is read only. + + The value is used to fill the back color of the textbox. + + + + Overridden to create a product-specific identity object for the sub object. + + + StyleInfoProperty descriptor for this sub object. + + + Identity for the sub object. + + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Implements a class that provide the identity information of + using . + + + + + Maintains the DoubleTextBox for create the identity. + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Represents a class that provides style identity information for nested objects of the + class. + + + + + Initializes a new instance of the class. + + + The that owns this sub-object. + + + The descriptor for this expandable + sub-object. + + + + + Represents a class to define the style for the control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Holds instance of a class. + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + Holds instance of a class + + + + Gets the default style value for the control. + + + + + Gets or sets the value used to draw the fore color of the + control when text value is negative. + + The value is used to fill the fore color of the textbox. + + + + Gets or sets the value used to draw the fore color of the + control when text value is zero. + + The value is used to fill the fore color of the textbox. + + + + Gets or sets the value used to draw the back color of the + control when text value is read only. + + The value is used to fill the back color of the textbox. + + + + Overridden to create a product-specific identity object for the sub object. + + + StyleInfoProperty descriptor for this sub object. + + + Identity for the sub object. + + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Implements a class that provide the identity information of + using . + + + + + Maintains the IntegerTextBox for create the identity. + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Represents a class that provides style identity information for nested objects of the + class. + + + + + Initializes a new instance of the class. + + + The that owns this sub-object. + + + The descriptor for this expandable + sub-object. + + + + + Represents the class to apply the theme for control. + + + Extends the class to handle double input + and validation. + + + The DoubleTextBox is derived from textbox and provides all the functionality + of a textbox and adds additional functionality of its own. + + Collecting double input in a consistent format requires validation code + that needs to be built into the application when using the Windows Forms text box control. + The DoubleTextBox includes all this logic into its methods and properties + and makes it easy for the developer and the end user to collect and enter double data. + + + The DoubleTextBox is also closely tied to the globalization settings of the + operating system for number related properties. Please refer to the + + class for a detailed explanation of globalization and number related attributes. + + + The DoubleTextBox has full support for the Windows Forms designer and you can + just drag-and-drop and set properties on the control just as you would with the + Windows Forms text box. + + + The DoubleTextBox also raises a event when + in appropriate data is entered into the control. + + + All clipboard functions such as copy, paste and cut are also supported with + special accommodations for number related issues. + + + + + + It contains the value of the property. + + + + + Helps to apply the ThemeName settings in control + + ThemeName + + + + Helps to draw text border of control + + + + + Helps to override the ThemeName property settings + + ThemeName + + + + Helps to override the OnGotFocus events + + An System.EventArgs that contains the event data. + + + + The minimum value. + + + + + + + + + + + + + + + The maximum value. + + + + + The initial double value set in InitializeComponent. + + + + + The double value when the control gets the focus. Used when validating. + + + + + The double value that is set through the DoubleValue property. + + + + + Occurs when the property is changed. + + + + + The line of the null value. + + + + + Overloaded. Creates an object of type DoubleTextBox. + + + The DoubleTextBox object will be initialized with the default values + for the display and data properties. You need to set any specific + values. + + + + + + + + + + Overrides . + + + + + Raises the System.Windows.Forms.Control.EnabledChanged event. + + An System.EventArgs that contains the event data. + + + + Releases the unmanaged resources used by the and optionally releases the managed resources. + + true to release both managed and unmanaged resources; false to release only unmanage resources. + + + + + + + + + + Formats the given text according to the current setting. + + + + + + + Overrides the Text property of . + + + This property is overriden in order to normalize the data that is set + to the Text property and format it as needed. The method + is used to format the data. + + + + + Gets or sets a value indicating whether the control should enable its Accessibility support. + + + + + Indicates whether to serialize the Text property + if it is null or quals NullString + + + + + + Restores the CurrencyNumberDigits to the MaximumLength. + + + + + Indicates whether the NULLString property will be used. + + + + + Gets or sets the double value of the control. This will be formatted and + displayed. + + + + + Gets or sets the maximum value that can be set through the DoubleTextBox. + + + + + Indicates whether the MaxValue property should be serialized. + + True if the value is not equal to . + + + + Resets the Max value to the default. + + + + + Gets or sets the minimum value that can be set through the DoubleTextBox. + + + + + Indicates whether the MinValue property should be serialized. + + True if the value is not equal to . + + + + Resets the value to the default. + + + + + Raises the event. + + A that contains the event data. + + + + Overrides OnTextChanged. + + The event data. + + + + Raises the event. + + A that contains the event data. + + + + Overrides the method. + + The event data. + + Saves the current DoubleValue so that it can be compared + during validation. The DoubleValueChanged and TextChanged event + will only be raised if the value is different during validation. + + + + + Represents the class to apply the theme for control. + + + Extends the class to handle integer input + and validation. + + + The IntegerTextBox is derived from textbox and provides all the functionality + of a textbox and adds additional functionality of its own. + + Collecting integer input in a consistent format requires validation code + that needs to be built into the application when using the Windows Forms textbox control. + The IntegerTextBox includes all this logic into its methods and properties + and makes it easy for the developer and the end user to collect and enter double data. + + + The IntegerTextBox is also closely tied to the globalization settings of the + operating system for number related properties. Please refer to the + + class for a detailed explanation of globalization and number related attributes. + + + The IntegerTextBox has full support for the Windows Forms designer and you can + just drag-and-drop and set properties on the control just as you would with the + Windows Forms textbox. + + + The IntegerTextBox also raises a event when + inappropriate data is entered into the control. + + + All clipboard functions such as copy, paste and cut are also supported with + special accommodations for a number related issues. + + + + + + It contains the value of the property. + + + + + Helps to draw text border of control + + + + + Helps to apply the ThemeName settings in control + + ThemeName + + + + Helps to override the ThemeName property settings + + ThemeName + + + + Helps to override the OnGotFocus events + + An System.EventArgs that contains the event data. + + + + Specifies whether MinMaxValidation is being in progress. + + + + + The minimum value. + + + + + The maximum value. + + + + + The initial Int64 value set in InitializeComponent. + + + + + + + + + + + + + + + The integer value when the control gets the focus. Used when validating. + + + + + The text when the control gets the focus. Used when validating. + + + + + The Int64 value that is set through the IntegerValue property. + + + + + Indicates whether to allow insets zero in the beginning value. + + + + + Indicates whether NullString should be set if UseNullString is true. + + + + + Occurs when the property is changed. + + + + + Gets or sets a value indicating whether the control should enable its Accessibility support. + + + + + Overloaded. Creates an object of type IntegerTextBox. + + + The IntegerTextBox object will be initialized with the default values + for the display and data properties. You need to set any specific + values. + + + + + + + + + + Overrides . + + + + + Overrides the Text property of . + + + This property is overriden in order to normalize the data that is set + to the Text property and format it as needed. The method + is used to format the data. + + + + + Indicates whether to serialize the Text property + if it is null or quals NullString + + + + + + Gets / sets the integer value of the control. This will be formatted and + displayed. + + + + + Gets / sets the maximum value that can be set through the IntegerTextBox. + + + + + + + + Indicates whether the MaxValue property should be serialized. + + True if the value is not equal to . + + + + Resets the max value to the default. + + + + + Generates string format for use in Conver.Format. + + + + + + + + + Adds negative symbol. + + + + + + + + + Returns zero string as began sValue. + + + + + + + + Gets / sets the minimum value that can be set through the IntegerTextBox. + + + + + Indicates whether the MinValue property should be serialized. + + True if the value is not equal to . + + + + Resets the value to the default. + + + + + Indicates whether to allow insets zero in the beginning value. + + + + + Raises the event. + + A that contains the event data. + + + + Overrides OnTextChanged. + + The event data. + + + + Overrides the method. + + The event data. + + Saves the current IntegerValue so that it can be compared + during validation. The IntegerValueChanged and TextChanged event + will only be raised if the value is different during validation. + + + + + performs the Min/Max validation. + + + + + Gets / sets the decimal separator character that will be used for the display. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + Gets / sets the maximum number of digits for the decimal portion. + + + This property is always set to zero for the IntegerTextBox. + + + + + Indicates whether to serialize property value. + + + + + + Indicates whether to serialize property value + + + + + + Releases the unmanaged resources used by the and optionally releases the managed resources. + + true to release both managed and unmanaged resources; false to release only unmanage resources. + + + + Raises the System.Windows.Forms.Control.EnabledChanged event. + + An System.EventArgs that contains the event data. + + + + + + + + + + Formats the given text according to the current setting. + + + + + + + Represents a class to define the style for the control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Holds instance of a class. + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + Holds instance of a class + + + + Gets the default style value for the control. + + + + + Gets or sets the value of the + control. + + + + + + Gets or sets the value used to draw the back color of the + control in the default state. + + The value is used to draw the back color of the TextBoxExt. + The default value is null. + + + + Gets or sets the value used to draw the back color of the + control in the disabled state. + + The value is used to draw the disabled back color of the TextBoxExt. + The default value is null. + + + + Gets or sets the value used to draw the fore color of the + control in the default state. + + The value is used to draw the fore color of the TextBoxExt. + The default value is null. + + + + Gets or sets the value used to draw the fore color of the + control in the disabled state. + + The value is used to draw the disabled fore color of the TextBoxExt. + The default value is null. + + + + Gets or sets the value used to draw the border color of the + control in the default state. + + The value is used to draw the border color of the TextBoxExt. + The default value is null. + + + + Gets or sets the value used to draw the border color of the + control in the focussed state. + + The value is used to draw the focussed border color of the TextBoxExt. + The default value is null. + + + + Gets or sets the value used to draw the border color of the + control in the disabled state. + + The value is used to draw the disabled border color of the TextBoxExt. + The default value is null. + + + + Gets or sets the value used to draw the border color of the + control in the hover state. + + The value is used to draw the hover border color of the TextBoxExt. + The default value is null. + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Overridden to create a product-specific identity object for the sub object. + + + StyleInfoProperty descriptor for this sub object. + + + Identity for the sub object. + + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Implements a class that provide the identity information of + using . + + + + + Maintains the TextBoxExt for create the identity. + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Represents a class that provides storage for the object. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + Represents a class that provides style identity information for nested objects of the + class. + + + + + Initializes a new instance of the class. + + + The that owns this sub-object. + + + The descriptor for this expandable sub-object. + + + + + Represents a class to apply the theme for the control. + + + An extended textbox that provides advanced border styles. + + + The property provides you advanced 3D border options. The + property lets you specify custom single border colors. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + Gets or sets the Base Theme name of the theme + + + + + Gets or sets the value used to customize the appearance of the . + + + This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control. + + + + + Gets the name of the control. + + + + + Gets a value indicating whether the visual style based theme is applied to the control and + also indicates whether the theme files are referred from external assemblies or not. + + Return true, if the visual style based theme is applied to the control. Otherwise returns false. + + + + Helps to apply the ThemeName settings in control + + ThemeName + + + + Helps to override the ControlName property settings + + ControlName + + + + Helps to draw text border of control + + + + + Overflow indicator size. + + + + + Overflow indicator element size. + + + + + Overflow indicator border indent. + + + + + Overflow indicator border color. + + + + + Overflow indicator foreground element color. + + + + + Overflow indicator ToolTip offset. + + + + + Default size of the control + + + + + To check whether the scaling of the TextBoxExt; + + + + + Default font style of the control + + + + + Default windows message for gesture support. + + + + + Default windows message for Mouse captured. + + + + + Font which stored after changed in design + + + + + + + + + + + + + + + + + + + + + + + + + + + Parent sub class. + + + + + overflow indicator visibility. + + + + + Last overflow indicator state. + + + + + Overflow indicator ToolTip. + + + + + Left last painted overflow indicator rectcangle. + + + + + Right last painted overflow indicator rectcangle. + + + + + + + + + + Collects the boolean value if Control is selected by Touch or Mouse control. + + + + + Show overflow indicator ToolTip. + + + + + Overrides the base class font property. + + + + + Gets/Sets Control size before touch enabled + + + + + Gets or sets value to enable or disable the Touchmode to the controls. + + Scale factor will be updated automatically if scalefactor is equal to 1 + + + + + + + + + + + + + + + Scale the control based on the scale factor passed in the argument. + + value to scale the factor based upon. + + + + + + + + MetroColor. + + + + + Gets or sets the metrocolor. + + + + + Gets or sets the FocusBorderColor + + + + + + + + + + + + Enables the FocusBorderColor property + + + + + + + + + + + + Gets or sets can show overflow indicator ToolTip. + + + + + Gets or sets overflow indicator ToolTip text. + + + + + Gets or sets overflow indicator visibility. + + + + + Indicates whether the text should be drawn active even when the control is disabled. + + False for default textbox behavior; True to draw the text enabled even when the control is + disabled. + + + + Gets or sets the border sides for which you want the 3D border style applied. + + + This property is used only when BorderStyle is Fixed3D. + + + + + Gets or sets the 3D border style for the control. + + + This property is used only when BorderStyle is Fixed3D. + + + + + Gets or sets the single border color for the control. + + + This property is used only when BorderStyle is FixedSingle. + + + + + Used to set the Hover and Focussed border color + + + + + Gets or sets the Hover and Focussed border color for Office2016 styles. + + + + + Last overflow indicator state. + + + + + Overflow indicator ToolTip. + + + + + Indicates whether XPThemes should be used when BorderStyle is set to Fixed3D. + + True to use XPThemes; False otherwise. Default is True. + + This property is used only when BorderStyle is Fixed3D. + + + + + Gets or sets the maximum size for the control. + + + + + Gets or sets the minimum size for the control. + + + + + Gets or sets the case of characters as they are typed. + + + + + Gets or sets corner radius of control. + + Radius has to be not less than zero or half of minimum dimension (width or height) of control. + If radius is zero, control has standard rectangular appearance. + + + + + Gets or sets the near image. + + + + + It contains the value of the property. + + + + + Gets or sets the theme name of the control. + + + The default value is null. + + + This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control. + + + + + Gets the active theme name of the control. + + Returns the active theme name. + + + + Gets or sets the far image. + + + + + This event is raised if the BorderSides property is changed. + + + + + This event is raised if the Border3DStyle property is changed. + + + + + Occurs when theme name of the control has changed. + + + + + This event is raised when the value of the BorderColor property is changed. + + + + + This event is raised if the ThemesEnabled property is changed. + + + + + This event is raised if the MaximumSize property is changed. + + + + + This event is raised if the MinimumSize property is changed. + + + + + This event is raised if the CharacterCasing property is changed. + + + + + Event will be triggered when the TextBoxExt lost its Focus. + + + + + + + Creates a new instance of the TextBoxExt class. + + + + + To Show/Display the virtual keyboard + + + + + + To hide the touch keyboad. + + + + + + + + + + Dispose all created internal object + + + + + + + + + + + + Raises the MaximumSizeChanged event. + + An EventArgs that contains the event data. + Raising an event invokes the event handler + through a delegate. For more information, see Raising + an Event. The OnMaximumSizeChanged method also + allows derived classes to handle the event without + attaching a delegate. This is the preferred technique + for handling the event in a derived class. + Note to Inheritors: When overriding OnMaximumSizeChanged + in a derived class, be sure to call the base class's + OnMaximumSizeChanged method so that registered + delegates receive the event. + + + + + Event will be triggered while clicking on the TextBoxExt. + + + + + + Sends the specified message to the default windows procedure. + + + + + + + + + + + + Raises the MinimumSizeChanged event. + + An EventArgs that contains the event data. + Raising an event invokes the event handler + through a delegate. For more information, see Raising + an Event. The OnMinimumSizeChanged method also + allows derived classes to handle the event without + attaching a delegate. This is the preferred technique + for handling the event in a derived class. + Note to Inheritors: When overriding OnMinimumSizeChanged + in a derived class, be sure to call the base class's + OnMinimumSizeChanged method so that registered + delegates receive the event. + + + + + Raises the CharacterCasingChanged event. + + An EventArgs that contains the event data. + Raising an event invokes the event handler + through a delegate. For more information, see Raising + an Event. The OnCharacterCasingChanged method also + allows derived classes to handle the event without + attaching a delegate. This is the preferred technique + for handling the event in a derived class. + Note to Inheritors: When overriding OnCharacterCasingChanged + in a derived class, be sure to call the base class's + OnCharacterCasingChanged method so that registered + delegates receive the event. + + + + + Raises the BorderSidesChanged event. + + An EventArgs that contains the event data. + Raising an event invokes the event handler + through a delegate. For more information, see Raising + an Event. The OnBorderSidesChanged method also + allows derived classes to handle the event without + attaching a delegate. This is the preferred technique + for handling the event in a derived class. + Note to Inheritors: When overriding OmBorderSidesChanged + in a derived class, be sure to call the base class's + OnBorderSidesChanged method so that registered + delegates receive the event. + + + + + Raises the BorderColorChanged event. + + An EventArgs that contains the event data. + Raising an event invokes the event handler + through a delegate. For more information, see Raising + an Event. The OnBorderColorChanged method also + allows derived classes to handle the event without + attaching a delegate. This is the preferred technique + for handling the event in a derived class. + Note to Inheritors: When overriding OnBorderColorChanged + in a derived class, be sure to call the base class's + OnBorderColorChanged method so that registered + delegates receive the event. + + + + + Raises the Border3DStyleChanged event. + + An EventArgs that contains the event data. + Raising an event invokes the event handler + through a delegate. For more information, see Raising + an Event. The OnBorder3DStyleChanged method also + allows derived classes to handle the event without + attaching a delegate. This is the preferred technique + for handling the event in a derived class. + Note to Inheritors: When overriding OnBorder3DStyleChanged + in a derived class, be sure to call the base class's + OnBorder3DStyleChanged method so that registered + delegates receive the event. + + + + + Raises the event when theme name changed. + + The sender value. + A contains the event data. + + + + It contains the value of the property. + + + + + Gets or sets a value indicating whether control elements styles can be overridden by theme style settings. + + Default value is false. + + By default, the control's element styles will not be overridden by theme style settings if the style is set in sample level. + If this property is enabled, element style will be overridden by theme style settings event if it is set in sample level. + This property should be enabled or disabled before calling the ThemeName property of the control. + + + + + It contains the value of the property. + + + + + Gets or sets a value indicating whether a theme settings + can be applied to the control. + + The default value is true. + + This property must be initialized before applying the VisualTheme /> + + + + + Helps to override the CanApplyTheme property settings + + CanApplyTheme + + + + Helps to override the CanOverriderStyle property settings + + CanOverriderStyle + + + + Raises the ThemesEnabledChanged event. + + An EventArgs that contains the event data. + Raising an event invokes the event handler + through a delegate. For more information, see Raising + an Event. The OnThemesEnabledChanged method also + allows derived classes to handle the event without + attaching a delegate. This is the preferred technique + for handling the event in a derived class. + Note to Inheritors: When overriding OnThemesEnabledChanged + in a derived class, be sure to call the base class's + OnThemesEnabledChanged method so that registered + delegates receive the event. + + + + + + + + + Raises the System.Windows.Forms.Control.EnabledChanged event. + + An System.EventArgs that contains the event data. + + + + Helps to reset Control Layout Settings + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Overflow indicators drawing. + + + + + + + + Raises the event. + + An that contains the event data. + + + + Raises the event. + + An that contains the event data. + + + + + + + + + + + + + + + + + + + + + + + + Return GDI text size. + + + + + + + Send WM_NCCALCSIZE message. + + + + + Send WM_NCCALCSIZE message and invalidate NC area. + + + + + Return overflow indicator state. + + + + + + + + + + + + + + + + Get or Set of Skin Manager Interface + + + + + Office2010 color scheme. + + + + + Gets color table for Office2010 visual style. + + + + + Gets or sets the Office2016 colors for the Office2016 style. + + + + + Office2007 color scheme. + + + + + Gets color table for Office2007 visual style. + + + + + Draw one overflow indicator. + + + + + + + + Draw overflow indicator foregraund element. + + + + + + + + Signals the object that initialization is starting. + + + + + Signals the object that initialization is complete. + + + + + Gets a value indicating whether this is initializing. + + true if initializing; otherwise, false. + + + + CheckBoxAdvActionList class. + + + + + Initializes a new instance of the ClockActionList class. + + Represents component + + + + Overrridden InitializeActionList. + + + + + Gets the image collection + + + + + Represents the class to define the style of control. + + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + The store. + + + + Gets the default ProgressBarAdvStyleInfo value. + + + + + Gets or sets used to draw the progress value of the control. + + + + + Gets or sets an integer value that describes the thickness of border. + + + + + Gets or sets an interger integer value that describes the amount of space between a progress rectangle and its element border. + + + + + Gets or sets the background color of the control. + + + + + Gets or sets the background color of the control in the disabled state. + + + + + Gets or sets the fore color used to draw the progress value of the control. + + + + + Gets or sets the progress fill color value used to draw the progress rectangle of the control. + + + + + Gets or sets the progress fill color used to draw the progress rectangle of the control in the disabled state. + + + + + Gets or sets the border color used to draw the border of the control in the disabled state. + + + + + Gets or sets the foreground color value used to draw the text of the control to in the disabled state. + + + + + Gets or sets the value used to draw the border of the control in the default state. + + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Represents the class holds the plain data for a style object excluding identity information. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Maintains the static data. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Populates the SerializationInfo store with the name, type, and value of each piece of information it wants to serialize + Describes the source and destination of a given serialized stream, and provides an additional caller-defined context. + + + + Overridden to get the static data source. + + + + + Implements the class that provide the identity information of + using . + + + + + Maintains the progressBarAdv for create the identity. + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + ProgressBarAdv is an extension to the standard + progress bar with many styles to choose from. + + + + The ProgressBarAdv control has background, border and foreground styles. + The background styles are . + The border styles are . + The foreground styles are . + + + this.progressBarEx1 = new ProgressBarAdv(); + this.progressBarEx1.BackGradientEndColor = System.Drawing.SystemColors.ControlLightLight; + this.progressBarEx1.BackGradientStartColor = System.Drawing.SystemColors.ControlDark; + this.progressBarEx1.BackgroundStyle = ProgressBarBackgroundStyles.VerticalGradient; + this.progressBarEx1.BackSegments = false; + this.progressBarEx1.Border3DStyle = System.Windows.Forms.Border3DStyle.RaisedOuter; + this.progressBarEx1.FontColor = System.Drawing.SystemColors.HighlightText; + this.progressBarEx1.Location = new System.Drawing.Point(240, 8); + this.progressBarEx1.ProgressStyle = ProgressBarStyles.Tube; + this.progressBarEx1.SegmentWidth = 20; + this.progressBarEx1.Size = new System.Drawing.Size(400, 23); + this.progressBarEx1.TextShadow = false; + this.progressBarEx1.ThemesEnabled = false; + this.progressBarEx1.TubeEndColor = System.Drawing.SystemColors.Control; + this.progressBarEx1.TubeStartColor = System.Drawing.SystemColors.ControlDark; + this.progressBarEx1.Value = 79; + + + + ProgressBarAdv is an extension to the standard + progress bar with many styles to choose from. + + + + The ProgressBarAdv control has background, border and foreground styles. + The background styles are . + The border styles are . + The foreground styles are . + + + this.progressBarEx1 = new ProgressBarAdv(); + this.progressBarEx1.BackGradientEndColor = System.Drawing.SystemColors.ControlLightLight; + this.progressBarEx1.BackGradientStartColor = System.Drawing.SystemColors.ControlDark; + this.progressBarEx1.BackgroundStyle = ProgressBarBackgroundStyles.VerticalGradient; + this.progressBarEx1.BackSegments = false; + this.progressBarEx1.Border3DStyle = System.Windows.Forms.Border3DStyle.RaisedOuter; + this.progressBarEx1.FontColor = System.Drawing.SystemColors.HighlightText; + this.progressBarEx1.Location = new System.Drawing.Point(240, 8); + this.progressBarEx1.ProgressStyle = ProgressBarStyles.Tube; + this.progressBarEx1.SegmentWidth = 20; + this.progressBarEx1.Size = new System.Drawing.Size(400, 23); + this.progressBarEx1.TextShadow = false; + this.progressBarEx1.ThemesEnabled = false; + this.progressBarEx1.TubeEndColor = System.Drawing.SystemColors.Control; + this.progressBarEx1.TubeStartColor = System.Drawing.SystemColors.ControlDark; + this.progressBarEx1.Value = 79; + + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + Occurs when theme name of the has changed. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + Gets or sets the value used to customize the appearance of the . + + + + + Gets or sets a value indicating whether a theme style + has been applied to the control. + + The default value is true. + + + + Gets or sets the theme name of the ProgressBarAdv control. + + + + + Gets or sets a value indicating whether control elements styles can be overridden by theme style settings. + + Default value is false. + + By default, the control's element styles will not be overridden by theme style settings if the style is set in sample level. + If this property is enabled, element style will be overridden by theme style settings event if it is set in sample level. + This property should be enabled or disabled before calling the ThemeName property of the control. + + + + + Gets or sets the BaseTheme name of the theme + + + + + Gets a value indicating whether the visual style based theme is applied to the control and + also indicates whether the theme files are referred from external assemblies or not. + + Return true, if the visual style based theme is applied to the control. Otherwise returns false. + + + + Gets or sets the VisualTheme of the ProgressBarAdv control. + + + + + Draws the dual gradient color of the progress bar when office2016 theme is selected. + + + + + + + + + Draws the border of the ProgressBar. + + The object to the border. + The of the border. + + + + Draws the specified text string at the specified location. + + The object to the text. + The of the ProgressBarAdv + + + + Gets the name of the control. + + + + + Gets the active theme name of the ProgressBarAdv control. + + Returns the active theme name. + + + + Raises the event when themename changed. + + The sender value. + A contains the event data. + + + + Updates the Style renderers of ProgressBarAdv Control based on applied Theme. + + + + + Helps to reset Layout customization of the ProgressBarAdv Control. + + + + + Handle this event to set the text of the progressbar when the value changes. + Make sure the TextStyle property is set to Custom. + + + To set the text of the progressbar, set the and the to True. + + + + + Handle this event to draw a custom waiting render. + WaitingCustomRender must be set to True. + + + + + Starts initialization mode. + + + + + Ends initialization mode and calls . + + + + + Implementation of the interface. + + Set this to False if you want to refresh brushes later. + + + + Constructor. + + + + + Cleans up any resources being used. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Gets/Sets the renderer of the ProgressBarAdv. + + + + + Gets/Sets the Renderer of the ProgressBarAdv. + + + + + Gets the Office2016 style colors respective to the ProgressBarAdv style + + + + + Paints the control. + + Event sender. + Event data. + + + + Paints the control by using Renderer class. + + Provides data for the Paint event. + The is helps to draw the progress. + + + + Font changed + + + + + + + + Draws the contents of the progress bar at the specified rectangle. This method can only + be called when the control has no handle attached or is not visible. + + + Draws the contents of the progress bar at the specified rectangle. This method can only + be called when the control has no handle attached or is not visible. + + The graphics context. + The rectangle. + + Essential Grid calls this method to render the contents of the progress bar + within a cell's area. + + No border will be drawn around the control. + + The method will throw an InvalidOperationException if the control has a handle + and is visible. + + The method will reset the bounds and BorderStyle of this control. + This method only supports horizontal progress bars. We will add support for static drawing of vertical progress bars in the future. + + + + + Draws the contents of the progress bar at the specified rectangle. This method can only + be called when the control has no handle attached or is not visible. + + The graphics context. + The rectangle. + Specifies if the progressbar should be drawn right to left. + + Essential Grid calls this method to render the contents of the progress bar + within a cell's area. + + No border will be drawn around the control. + + The method will throw an InvalidOperationException if the control has a handle + and is visible. + + The method will reset bounds and BorderStyle of this control. + This method only support horizontal progress bars. We will add support for static drawing of vertical progress bars in the future. + + + + + Holds the progress rectangle bounds + + + + + Gets or sets a value indicating whether the fore color is changed or not. + + + + + Gets or sets a value indicating whether the GradientStartColor is changed or not. + + + + + Gets or sets a value indicating whether GradientEndColor is changed or not. + + + + + Gets or sets a value indicating whether BackGradientStartColor is changed or not. + + + + + Gets or sets a value indicating whether BackGradientEndColor is changed or not. + + + + + Gets or sets a value indicating whether FontColor is changed or not. + + + + + Gets or sets a value indicating whether BorderColor is changed or not. + + + + + Gets / sets the value between minimum and maximum. + + + This value represents the progress state of the ProgessBar. For default if it is set to 50, minimum=0 and maximum=100 ( 50% ). + + + + + Gets / sets the lower boundary for the value. + + + By default, its value is zero which means that the value of the ProgressBar cannot take values lower than zero. + + + + + Gets / sets the upper boundary for the value. + + + By default, its value is 100 which means that the value of the ProgressBar cannot take values higher than 100. + + + + + Gets / sets the value to increment when Increment() and Decrement() methods. + + + By default, its value is 10 which means that when Increment() is called, the value of the ProgressBar is incremented by 10. + + + + + Indicates whether the waiting gradient will be replaced by another custom waiting render which is defaulted to segments. + To customize it, handle the DrawCustomWaitingRender event. + + + + + Gets / sets the width of the waiting gradient. + + + + + Indicates whether the waiting gradient is enabled. + + + + + Gets / sets the interval of the waiting gradient. + + + + + Indicates whether the foreground is segmented. + + + By default, its value is True which means that the foreground will be drawn segmented. + + + + + Indicates whether the multiple gradient is compressed if the value is smaller than the maximum. + + + By default, its value is True which means that if the value is less than the maximum, the multiple gradient is compressed. + + + + + Gets / sets the colors of the foreground multiple gradient when ForegroundStyle is multiple gradient. + + + By default, its value is an empty color array. You can add colors to multiple gradients by modifying this property. + + + + + Gets / sets the start color of the foreground gradient when ForegroundStyle is gradient. + + + + + Gets / sets the end color of the foreground gradient when ForegroundStyle is gradient. + + + + + Serialize the gradient color + + + + + Resets the gradient color + + + + + Serialize the gradient color + + + + + Resets the gradient color + + + + + Gets / sets the start color of the foreground tube when ForegroundStyle is Tube. + + + + + Gets / sets the end color of the foreground tube when ForegroundStyle is Tube. + + + + + Indicates whether the background is segmented. + + + By default, its value is False. + + + + + Gets / sets the colors of the background multiple gradients when BackgroundStyle is multiple gradient. + + + By default, its value is an empty array of colors. + + + + + Gets / sets the start color of the background gradient when BackgroundStyle is gradient or vertical gradient. + + + + + Gets / sets the end color of the background gradient when BackgroundStyle is gradient or vertical gradient. + + + + + Gets / sets the start color of the background tube when BackgroundStyle is Tube. + + + + + Gets / sets the end color of the background tube when BackgroundStyle is Tube. + + + + + Gets / sets the text alignment of the ProgressBarAdv. + + + + + Indicates whether the foreground image will be stretched. + + + By default, its value is True. + + + + + Gets / sets the image to draw on the foreground when ProgressStyle is Image. + + + + + Gets / sets the width of the segments. + + By default, its value is 12. + + + + Gets / sets the color of the font. + + + + + Gets / sets the color used to draw the foreground in segment mode and constant mode. + + + + + Indicates whether the text is visible. + + + + + Gets / sets the style of the text: + -Percentage + -Value (Ex: 70/150 ) + + + + + Gets / sets the orientation of the text. + + + + + Indicates whether the text shadow is visible. + + + + + Gets or sets the custom text for the ProgressBarAdv. + + The custom text. + + This value represents the CustomText of the ProgessBarAdv. The customText is returned only if we set the ProgressBarTextStyles.Custom + + + + + Gets / sets the style of the foreground: + -Constant + -Gradient + -Multiple gradient + -Tube + -Image + -System + -Office2016Colorful + -Office2016Black + -Office2016White + -Office2016DarkGray + + + By default, its value is constant. + + + + + Gets or sets used to draw the progress value of the control. + + + + + Initialize the whether the Marker imager is shown or not. + + + + + Gets or sets whether the Marker image is shows on ProgressBar. + + + + + Resets the property to it's default value. + + + + + Indicates whether the current value of the property is to be serialized. + + + + + + Display the marker image. + + + + + Gets / sets the marker image to draw on right side of the Progress. + + + + + Resets the property to it's default value. + + + + + Indicates whether the current value of the property is to be serialized. + + + + + + Specify the marker image size. + + + + + Gets / sets the marker image size to draw on right side of the Progress. + + + + + Resets the property to it's default value. + + + + + Indicates whether the current value of the property is to be serialized. + + + + + + Gets / sets the style of the foreground when ProgressStyle is System and the system can not support themes. + + + + + Gets / sets the style of the border when BorderStyle is Fixed3D. + + + By default, its value is Sunken. + + + + + Gets / sets the style of the border. It can be None, 3D or 2D. + + + By default, its value is Fixed3D. + + + + + Serialize the borderstyle + + + + + Reset the border style + + + + + Gets / sets the style of the border when BorderStyles is FixedSingle. + + + By default, its value is Solid. + + + + + Gets / sets the color of the border when BorderStyles is FixedSingle. + + + + + Serializes the bordercolor + + + + + Resets the bordercolor + + + + + Determines whether FontColor has been modified and its contents should be serialized at design-time. + + True if FontColor were changed; False otherwise. + + + + Resets the FontColor back to its default value. + + + + + Determines whether BackTubeStartColor has been modified and its contents should be serialized at design-time. + + True if BackTubeStartColor were changed; False otherwise. + + + + Resets the BackTubeStartColor back to its default value. + + + + + Determines whether BackTubeEndColor has been modified and its contents should be serialized at design-time. + + True if BackTubeEndColor were changed; False otherwise. + + + + Resets the BackTubeEndColor back to its default value. + + + + + Determines whether TubeEndColor has been modified and its contents should be serialized at design-time. + + True if TubeEndColor were changed; False otherwise. + + + + Resets the TubeEndColor back to its default value. + + + + + Determines whether TubeStartColor has been modified and its contents should be serialized at design-time. + + True if TubeStartColor were changed; False otherwise. + + + + Resets the TubeStartColor back to its default value. + + + + + Determines whether BackGradientStartColor has been modified and its contents should be serialized at design-time. + + True if BackGradientStartColor were changed; False otherwise. + + + + Resets the BackGradientStartColor back to its default value. + + + + + Determines whether BackGradientEndColor has been modified and its contents should be serialized at design-time. + + True if BackGradientEndColor were changed; False otherwise. + + + + Resets the BackGradientEndColor back to its default value. + + + + + Gets / sets the style of the background. It can have the following values: + -Office2016Colorful + -Office2016Black + -Office2016White + -Office2016DarkGray + -Image + -Gradient + -Vertical gradient + -Tube + -Multiple gradient + -System + -None + + + By default, its value is None. + + + + + Gets / sets the style of the background when BackgroundStyle is set to System and the system cannot support themes. + + + By default, its value is None. + + + + + Gets / sets the horizontal or vertical style of the progress bar. + + + By default, its value is Horizontal. + + + + + Gets or sets value indicating whether progress rectangle bounds value + + + + + Recreates the brushes used to draw the ProgressBar. + + + + + Draws the fill color of the ProgressBar when continuous is selected. + + + + + Draws segments in the given rectangle when system is selected. + + + The to draw the segments in. + + + + Draws the dual gradient of the ProgressBar when gradient is selected. + + + + + Draws the dual gradient color of the progress bar when office2016 theme is selected. + + + + + + + + + Draws the image of the ProgressBar when image is selected. + + + The to draw the image in. + The used to draw in the rectangle. + + + + Draws the dual tube of the ProgressBar when tube is selected. + + + + + Draws the multiple gradient of the ProgressBar when multiple gradient is selected. + + + + + Returns the region of the segments if segment mode is selected. + + The rectangle in which the segments are situated in. + Indicates the segments are offset. + The region containing the segments. + + + + + + + + + + + Indicates whether the ProgressBar is vertical. + + + + + + + Increments the Value property with the Step value. + + The success or failure of the Increment. It fails if the incremented value is bigger than the maximum. + + + + Decrements the Value property with the Step value. + + The success or failure of the Increment. It fails if the incremented value is smaller than minimum. + + + + CheckBoxAdvActionList class. + + + + + Initializes a new instance of the ClockActionList class. + + Represents component + + + + Overrridden InitializeActionList. + + + + + Gets or sets Name. + + + + + Gets or sets the Progressbar style. + + The style. + + + + Gets or sets the Text style. + + The style. + + + + Gets or sets the Text style. + + The style. + + + + Gets or sets the Text orientation. + + The style. + + + + RadioButtonAdvActionList Class. + + + + + Initializes a new instance of the RadioButtonAdvActionList class. + + Represents component + + + + Gets or sets thumb color. + + + + + InitializeActionList method + + + + + Modified PopupControlContainer that takes a child control and + adds a sizable grip so that the window can be sized. + + + + + The child control that is to be embedded. + + + + + Indicates whether the container has already been initialized. + + + + + Indicates whether size is dependant of child control size. + + + + + Creates an object of type SizablePopupControlContainer. + + + + + + + + + Displays the popup control. + + The location at which the popup's left top position will appear. + + + + Indicates whether size is dependant of child control size. + + + + + Initializes the container control. + + + + + Holds the theme name of it's parent control. + + + + + Adjusts bounds of the popupHost. + + + + + Derives from the PopupHost class and adds a gripper label and + makes the form sizable. + + + + + Used when ShowGripper or ShowCloseButton property is set to true; + + + + + Label for the gripper. + + + + + The close button. + + + + + The embedded child control. + + + + + The current size - used when resizing. + + + + + Indicates whether the window is being resized. + + + + + The host rectangle. + + + + + Internal initialization state of drop-down window. + + + + + The last size of the window. + + + + + Indicates whether to show gripper. + + + + + Indicates whether to show close bytton. + + + + + Create an object of type SizablePopupHost. + + + + + + + + + Last size property. + + For AutoComplete DropDownSize persistance + + + + Returns/sets the visibility of the close button + + + + + Indicates whether a gripper will be shown that can used for resizing + + + + + Hides the popup. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Overrides PopupHost.ComputeMySize. + + + + + + + + Handles the MouseDown event of the gripper label. + + The gripper label. + The event data. + + + + Handles the MouseUp event of the gripper label. + + The gripper label. + The event data. + + + + Handler for the MouseMove event of the gripper label. + + The gripper label. + The event data. + + + + Handler for the MouseEnter event of the Close Button. + + The close button. + The event data. + + + + Handler for the MouseLeave event of the Close Button. + + The close button. + The event data. + + + + Handler for the Click event of the close button. + Closes the popup window. + + The close button. + The event data. + + + + The close button used in SizablePopupHost. + + + + + Override OnPaint. + + The event data. + + + + Gets / sets the text property. + + + + + Summary description for GradienPanelExtPrimitivesEditorForm. + + + + + Reference to owner control. + + + + + Collection of the primitives when added. + + + + + Collection of the primitives when removed. + + + + + Fills ListBox of primitives. + + + + + Fills cbPrimitives of types prmitive. + + + + + Creates primitive. + + + + + Accessibility class to provide Coded UI support. + + + + + Variable for GradientPanel. + + + + + Constructor. + + GradientPanel + + + + Bounds of the Control + + + + + Gets the role for the GradientPanel. This is used by accessibility programs. + + + + + Gets or sets the accessible object name + + + + + Gets the description of the Control.ControlAccessibleObject + + + + + Gets the state of the accessible object. + + + + + Gets the description of what the object does or how the object is used. + + + + + Gets the parent of an accessible object. + + + + + Gets or sets the value of an accessible object. + + + + + Retrieves the object that has the focus. + + + + + + Retrieves the currently selected child. + + Child + + + + Retrieves the child object at the specified screen coordinates. + + The horizontal screen coordinate + The vertical screen coordinate + An System.Windows.Forms.AccessibleObject that represents the child object + at the given screen coordinates. + + + + Represent line. + + + + + Start point of the line. + + + + + End point of the line. + + + + + Represents a null Line. + + + + + Gets or sets start point of the line. + + + + + Gets or set end point of the line. + + + + + Gets size of the line. + + + + + Summary description for GradientPanelExtCollectionEditor. + + + + + Summary description for GradientPanelExtDesigner. + + + + + Selected primitive. + + + + + Distance from a mouse and bounds of the primitive. + + + + + Gets or sets selected primitive. + + + + + Gets owner control. + + + + + Gets rectangle where can location primitives. + + + + + Sets alignment of primitive. + + + + + Sets position of primitive. + + + + + Gets draged primitive. + + + + + Represents primitive that can be displayed in . + + + In order to display the Primitive, you must add it to the + property of . This is normally achieved using simple drag-and-drop + during design-time. + The Primitive class provides properties that enable you to configure the + appearance, behavior abd layoutof a primitive. For selecting a primitive you must click on it. + You can change , + and . You can define + of the Primitive in , + inside . + + + + + Color which uses for drawing border selected primitive. + + + + + Default size for primitive. + + + + + Offset for select rectangle. + + + + + Offset for redraw primitive. + + + + + Start position for primitive. + + + + + Size of the primitive. + + + + + Reprecent position of the primitive. + + + + + Border color for primitive. + + + + + Background color for primitive. + + + + + Border style for primitive. + + + + + Control which contains this primitive. + + + + + Size and location of the primitive. + + + + + Rectangle which drawing primitive. + + + + + Rectangle which drew primitive on previous position. + Uses for redraw previous position of the primitives. + + + + + Alignment primitive. + + + + + A value indicating whether the primitive is displayed. + + + + + Indicate that primitive is selectes. + + + + + Gets or sets value indicate that primitive is selected. + + + + + Gets or sets a value indicating whether the primitive is displayed. + + + + + Gets or set alignment of the primitive. + + + + + Gets or sets size of the primitive. + + + + + Gets or sets border color for primitive. + + + + + Gets or sets background color for primitive. + + + + + Gets or sets border style for primitive. + + + + + Gets or sets position of the primitive. + + + + + Gets control which contains this primitive. + + + + + Gets or sets the size and location of the primitive. + + + + + Gets rectangle of drawing primitive. + + + + + Draws primitive. + + + + + Redraws primitive. + + + + + Draws border for primitive. + + + + + Draws primitive. + + + + + Draws border for selected primitive in the designer. + + + + + Gets rectangle for selected primitive. + + + + + Gets rectangle which drawing primitive. + + + + + Gets center of the primitive. + + + + + Gets count position of the primitive. + + + + + Gets correctly position of the primitive. + + + + + Raise by method. + + + + + Raise by method. + + + + + Raise by method. + + + + + Raise by method. + + + + + Raise by method. + + + + + Raise by method. + + + + + Raise by method. + + + + + Raise by method. + + + + + Raise by method. + + + + + Raise by method. + + + + + Raise by method. + + + + + Raise by method. + + + + + Raise by method. + + + + + Represents a collapse/expand primitive. + + + + + Indicate that primitive is collapse. + + + + + Image for collapsed primitive. + + + + + Image for expanded primitive. + + + + + Gets or sets image for collapsed primitive. + + + + + Gets or sets image for expanded primitive. + + + + + Gets or sets value which indicate that primitive is collapse. + + + + + Sets collapse state. Don't raise event. + + + + + Draws plus/minus primitive. + + + + + Raise by method. + + + + + Raise by method. + + + + + Raise by method. + + + + + Raise by method. + + + + + Represents a text primitive. + + + + + Angle of rotation for text primitive. + + + + + Displayed text. + + + + + Font for displayed text. + + + + + Color of the displayed text. + + + + + Gets or sets displayed text. + + + + + Gets or sets font for displayed text. + + + + + Gets or sets color of the displayed text. + + + + + Raise by method. + + + + + Raise by method. + + + + + Raise by method. + + + + + Represents an image primitive. + + + + + Displayed image. + + + + + Rotated image. + + + + + A value indicating whether the primitive is rotated. + + + + + Gets or set displayed image. + + + + + Gets or sets a value indicating whether the primitive is rotated. + + + + + Raise by method. + + + + + Raise by method. + + + + + Represents a primitive which contain any control. + + + + + Control which displaying. + + + + + Gets or set control which displaying inside the primitive. + + + + + Refresh location and size for host control. + + + + + Determines if a primitive contains control. + + + + + Raise by method. + + + + + Border style for Primitive. + + + + + Alignment primitive within control. + + + + + Types of the Primitives. + + + + + A collection that stores objects. + + + + + Initializes a new instance of 'PrimitiveCollection'. + + + + + Raise by method. + + + + + Adds primitive to collection. + + + + + Adds primitives to collection. + + + + + Removes primitive from collection. + + + + + Indexer. + + + + + Class helps to apply Office2016 Theme colors + + + + + Constructor + + + + + Holds Visual style + + + + + GroupBar Visual Style + + + + + Holds Splitter Dot Color + + + + + Gets Splitter Dot Color + + + + + Holds Splitter Backcolor + + + + + Gets the Splitter Color + + + + + Holds the Collapsed Panel Backcolor in Normal state + + + + + Gets the Collapsed panel Backcolor in Normal state + + + + + Holds the Collapsed Panel Backcolor in Hover state + + + + + Gets the Collapsed panel Backcolor in Hover state + + + + + Holds the Collapsed DropDown button Backcolor on Selected state + + + + + Gets the Collapsed Dropdown Button Selected Backcolor + + + + + Holds the Collapsed DropDown button Backcolor on Hover state + + + + + Gets the Collapsed Dropdown Button Hover Backcolor + + + + + Holds the Collapsed DropDown button ForeColor + + + + + Gets the Collapsed Dropdown Button ForeColor + + + + + Holds the Header Border color + + + + + Gets the Header Border color + + + + + Holds the Header BackColor + + + + + Gets the Header BackColor + + + + + Holds the Default Forecolor + + + + + Gets the Header Forecolor + + + + + Holds Header Backcolor in pressed state + + + + + Gets the Header Backcolor in pressed state + + + + + Holds the Header Forecolor in pressed state + + + + + Gets the Header Forecolor in pressed state + + + + + Holds the Header Backcolor in hovered state + + + + + Gets the Header Backcolor in Hovered state + + + + + Holds the Header Fore color + + + + + Gets the Header Forecolor in hovered state + + + + + Holds the Colapsed panel text color + + + + + Gets the Colapsed panel text color + + + + + Holds the Overflow button hover color + + + + + Gets the Overflow button hover color + + + + + Holds the Group bar boder color + + + + + Gets the Group bar boder color + + + + + Holds the Overflow Icon Color + + + + + Gets the Overflow Icon Color + + + + + Holds the TootTip backcolor + + + + + Gets the TootTip backcolor + + + + + Holds the TootTip backcolor + + + + + Gets the TootTip backcolor + + + + + Specifies the colors used for drawing the control's client rectangle borders. + + + The BorderColors structure is used by the objects in a + to specify the set of colors used for drawing the borders around the client control. The + BorderColors value is set through the property. + + + + + Gets / sets the color used to draw the left border. + + A value. + + + + Gets / sets the color used to draw the top border. + + A value. + + + + Gets / sets the color used to draw the right border. + + A value. + + + + Gets / sets the color used to draw the bottom border. + + A value. + + + + Represents a instance with empty color values. + + + + + Represents a instance with the default color values. + + + + + Creates a new instance of the class with the specified colors. + + Left border color. + Top border color. + Right border color. + Bottom border color. + + + + Represents an item in the control. + + + The GroupBar control is composed of a number of selectable groups or items each of which is + associated with a client control. Each of these items is an instance of the GroupBarItem type. + The collection of items present in the GroupBar can be accessed through the control's + property. + + + + + Gets or sets a value indicating whether background color of GroupBarItem is changed or not. + + + + + The image representing the item in the GroupBar's navigation pane. + + + + + Gets/Sets the Control Bounds + + + + + Indicates whether all types of images can be used or not + + + + + Gets / sets the text displayed on the . + + A String value. + + + + Padding provides spacing between the icons (images) and the text in the . + + + + + Gets or sets padding for . + + + + + Gets / sets the client control associated with the . + + A instance. + + + + Gets / sets the image displayed on the . + + An value. + + + + Gets / sets the icon displayed on the . + + An value. + + + + Indicates whether the is enabled / disabled. + + False if the item is disabled. The default is True. + + + + Indicates whether the is visible. + + False if the item is hidden. The default is True. + + + + Gets / sets the font used for drawing the text. + + A value. + + + + Resets the property to its default value. + + + + + Gets / sets the foreground color used to paint the text in the . + + A value. + + + + + + + + + + Resets the property to its default value. + + + + + Gets / sets the color used to fill the background. + + A value. + + + + Resets the property to its default value. + + + + + Gets / sets the brush used for painting the background. + + A value. + + + + Gets / sets the colors used to draw the borders around the 's client + control. + + A value. + + + + Resets the property to its default value. + + + + + Gets / sets the object that contains data about the . + + + A value that contains data about the control. + The default is a NULL reference (Nothing in Visual Basic). + + + Any type derived from the Object class can be assigned + to this property. If the Tag property is set through + the Windows Forms designer, only text may be assigned. + + + + + Returns the GroupBar control that the item is assigned to. + + + A that represents the parent GroupBar control that the is assigned to. + + + + + Indicates whether the should be added to the navigation pane. + + + This property is valid only when the control is in the stacked mode. + + + TRUE if the item should be added to the navigation pane. The default is FALSE. + + + + Gets / sets the icon representing the in the navigation pane. + + + This property is valid only when the control is in the stacked mode. + + + An value. + + + + Gets / sets image representing the item in the GroupBar's navigation pane. + + + + + + + + + + Creates an instance of the class. + + + + + Overridden. See . + + + + + Specifies an alignment value for the text. + + + The TextAlignment enum is used for specifying a value for the + control's property. + + + + + The text is aligned to the left. + + + + + The text is horizontally centered. + + + + + The text is aligned to the right. + + + + + Provides data for the event. + + The control uses the event to + obtain a custom brush from the application to draw the background region of a . + + + + + + Creates an instance of the ProvideBrushEventArgs class. + + The bounds for which a brush is requested. + + + + Returns the index of the being drawn. + + An Integer value. + + + + Returns the bounds for which a brush is requested. + + The Rectangle specifying the bounds. + + + + Gets / sets the brush that will be used to draw the specified bounds. + + A brush object. + The event handler should set this property for it + to be used while drawing the specified bounds. + + + + Represents the method that will handle the event + in the control. + + The source of the event. + A that contains the event data. + + + + Provides data for the and events. + + The control uses the and + events to notify users of a change in its collection. + + + + + + Returns the GroupBarItem used by this event. + + The object used by the event. + + + + Creates a new instance of the class. + + The to store in this event. + + + + Represents the method that will handle the and + events in the control. + + The source of the event. + A that contains the event data. + + + + Provides data for the event. + + The control uses the event to + allow users to cancel or change the context menu displayed when the drop-down button is clicked. + + + + + + Returns the menu provider object used by for creating its context menu. + + The object. + + + + Creates a new instance of the class. + + The implementing the context menu. + + + + Represents the method that will handle the event in the + control. + + The source of the event. + A that contains the event data. + + + + Provides data for the event. + + The control uses the event to + allow users to cancel bar item selection. + + + + + + Initializes a new instance of the class. + + The newly selected item index. + The old selected item index. + + + + Returns the newly selected index. + + + + + Returns the previously selected index. + + + + + Represents the method that will handle the event in the + control. + + The source of the event. + A that contains the event data. + + + + ControlAccessibleObject derived class that implements the Accessibility object for the GroupBar control. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + Provides data about the and + events. + + + See , , and . + + + + + Returns the zero-based index of the renamed item. + + An integer representing the item index. + + + + Returns the new text of the item. + + A String value. + + + + Returns the old text of the item. + + A String value. + + + + Creates a new instance of the GroupItemRenamedEventArgs class. + + The zero-based index of the renamed item. + The old item text. + The new item text. + + + + Delegate representing the method that will handle the and + events. + + The source of the event. + A value that contains the event data. + + + + + Resize is not allowed. + + + + + Horizontal resize is allowed. + + + + + Vertical resize is allowed. + + + + + Both horizontal and vertical resize are allowed. + + + + + Owner control of the popup. + + + + + CallWnd hook. + + + + + Popup visibility. + + + + + Indicates whether popup is shown to the left of . + + + + + Indicates whether popup is shown to the top of + + + + + Gets or sets a value indicating whether the popup is displayed. + + true if the popup is displayed; otherwise, false. The default is false. + + + + Gets the required creation parameters when the control handle is created. + + + A that contains the required creation parameters when the handle to the control is created. + + + + Processes Windows messages. + + The Windows to process. + + + + Shows the popup. + + if set to true shows the popup; hides overwise. + The instance containing the event data. + + + + Hides the popup. + + + + + Hides the popup. + + Allows to determine whether to clsoe popup in event handler. + + + + Class for subclassing parent form and prevent it from blinking. + + + + + Catches WM_NCACTIVATE message if needed. + + + + + + Specifies whether OnLoad was called. + + + + + Specifies whether form is visible. + + + + + Indicates whether form must be inactive. + + + + + Gets or sets bool specifying whether form is visible. + + + + + Represents an item in the control. + + + Each item in a GroupView control is an instance of the GroupViewItem type. The + collection of GroupViewItems in the control can be accessed through the + property. + + + + + Gets / sets the 's tooltiptext. + + A string value. + + + + Gets or Sets the value to change the Text Position of the GroupViewItem + + + + + Gets or Sets the value to change the Text Position of the GroupViewItem + + + + + Serializes the ItemXSpacing property value. + + + + + Resets the ItemXSpacing property to its default value. + + + + + Gets / sets the height between adjacent GroupViewItems. + + + + + Gets / sets the height between adjacent s. + + An integer value. + + + + Indicates whether the is visible. + + + + + Item bounds. + + + + + Gets or sets item bounds. + + + + + Indicates whether the is visible. + + False if the item is hidden. The default is True. + + + + Gets / sets the 's text. + + A String value. + + + + Gets / sets the 's image index. + + An integer value. + A zero-based index into the control's + and property values. + + + + + Indicates whether the is enabled / disabled. + + False if the item is disabled. The default is True. + + + + Gets / sets an object that contains data about the . + + + An value that contains data about the GroupViewItem. + The default is a NULL reference (Nothing in Visual Basic). + + + Any type derived from the Object class can be assigned + to this property. If the Tag property is set through + the Windows Forms designer, only text may be assigned. + + + + + Returns the GroupView control that the item is assigned to. + + + A that represents the parent GroupView control that the is assigned to. + + + + + Overloaded. Creates an instance of the class. + + + + + Creates an instance of the class with the specified attributes. + + A String value representing the GroupViewItem text. + An integer value representing a zero-based index into the + control's small and large imagelists. + + + + Creates an instance of the class with the specified attributes. + + A String value representing the GroupViewItem text. + An integer value representing a zero-based index into the + control's small and large imagelists. + A boolean value representing the item's enabled / disabled state. + + + + Creates an instance of the class with the specified attributes. + + A String value representing the GroupViewItem text. + An integer value representing a zero-based index into the + control's small and large imagelists. + An Object value that contains data about the GroupViewItem. + + + + Creates an instance of the class with the specified attributes. + + A String value representing the GroupViewItem text. + An integer value representing a zero-based index into the + control's small and large imagelists. + A boolean value representing the item's enabled / disabled state. + An Object value that contains data about the GroupViewItem. + + + + Creates an instance of the class with the specified attributes. + + A String value representing the GroupViewItem text. + An integer value representing a zero-based index into the + control's small and large imagelists. + A boolean value representing the item's enabled / disabled state. + An Object value that contains data about the GroupViewItem. + A String value representing the GroupViewItem tooltiptext. + + + + Creates an instance of the class with the specified attributes. + + A String value representing the GroupViewItem text. + An integer value representing a zero-based index into the + control's small and large imagelists. + An Object value that contains data about the GroupViewItem. + A boolean value representing the item's show/hide the GroupViewItems. + + + + Event handler for Double click event for GroupViewItem. + + Sender as GroupView + GroupViewItemDoubleClickEventArgs + + + + Event args for Double click in GroupViewItem. + + + + + GroupView Item + + + + + Constructor + + GroupView Item + + + + Gets/ Sets the currently selected item. + + + + + ControlAccessibleObject derived class that implements the Accessibility object for the GroupView control. + + + + + This class represents renderer class for office2016 theme + + + + + Holds the backcolor + + + + + Holds the forecolor + + + + + Holds the border color + + + + + Holds the item selected border color + + + + + Holds the item highlighted border color + + + + + Holds the item pressed border color + + + + + Holds the item highlighted backcolor + + + + + Holds the item selected backcolor + + + + + Holds the item selected and highlighted backcolor + + + + + Holds the item pressed backcolor + + + + + Holds the item highlighted text color + + + + + Holds the item selected text color + + + + + Holds the selected and highlighted text color + + + + + Holds the item pressed color + + + + + Holds the disabled backcolor + + + + + Holds the disabled border color + + + + + Holds the disabled forecolor + + + + + Holds the scrollbutton backcolor + + + + + Holds the scrollbutton pressed backcolor + + + + + Holds the scrollbutton forecolor + + + + + Holds the scrollbutton border color + + + + + Holds the dragdrap line color + + + + + Gets the backcolor + + + + + Gets the forecolor + + + + + Gets the item selected border color + + + + + Gets the item highlighted border color + + + + + Gets the item pressed border color + + + + + Gets the border color + + + + + Gets the item highlighted backcolor + + + + + Gets the item selected backcolor + + + + + Gets the item selected and highlighted backcolor + + + + + Gets the item pressed backcolor + + + + + Gets the item highlighted text color + + + + + Gets the item selected text color + + + + + Gets the item selected and highlighted text color + + + + + Gets the item pressed text color + + + + + Gets the disabled backcolor + + + + + Gets the disabled forecolor + + + + + Gets the disabled border Color + + + + + Gets the scrollbutton backcolor + + + + + Gets the scrollbutton pressed backcolor + + + + + Gets the scrollbutton forecolor + + + + + Gets the scrollbutton border color + + + + + Gets the dragdrop line color + + + + + Constructor for renderer class + + Theme of GroupView + + + + + This class represents renderer class for office2016 white theme + + + + + Holds the backcolor + + + + + Holds the forecolor + + + + + Holds the border color + + + + + Holds the item selected border color + + + + + Holds the item highlight border color + + + + + Holds the item pressed border color + + + + + Holds the item highlighted backcolor + + + + + Holds the selected item backcolor + + + + + Holds the selected and highlighted backcolor + + + + + Holds the pressed item backcolor + + + + + Holds the item highlight text color + + + + + Holds the item selected text color + + + + + Holds the item selected and highlighted text color + + + + + Holds the item pressed text color + + + + + Holds the disabled backcolor + + + + + Holds the disabled border color + + + + + Holds the disabled forecolor + + + + + Holds the scrollbutton backcolor + + + + + Holds the scrollbutton pressed backcolor + + + + + Holds the scrollbutton forecolor + + + + + Holds the scrollbutton border color + + + + + Holds the dragdrap line color + + + + + Gets the backcolor + + + + + Gets the forecolor + + + + + Gets the border color + + + + + Gets the selected item border color + + + + + Gets the item highlighted border color + + + + + Gets the item pressed border color + + + + + Gets the item highlighted backcolor + + + + + Gets the item selected backcolor + + + + + Gets the item selected and highlighted backcolor + + + + + Gets the item pressed backcolor + + + + + Gets the item highlighted text color + + + + + Gets the item selected text color + + + + + Gets the selected and highlighted item color + + + + + Gets the item pressed text color + + + + + Gets the disabled backcolor + + + + + Gets the disabled forecolor + + + + + Gets the disabled border color + + + + + Gets the scrollbutton backcolor + + + + + Gets the scrollbutton pressed backcolor + + + + + Gets the scrollbutton forecolor + + + + + Gets the scrollbutton border color + + + + + Gets the dragdrop line color + + + + + This class represents rendered class for office2016 darkgray theme + + + + + Holds the backcolor + + + + + Holds the forecolor + + + + + Holds the border color + + + + + Holds the selected Border color + + + + + Holds the highlighted border color + + + + + Holds the pressed border color + + + + + Holds the item highlighted backcolor + + + + + Holds the item selected backcolor + + + + + Holds the item highlighted backcolor + + + + + Holds the pressed item backcolor + + + + + Holds the highlighted item text color + + + + + Holds the selected item text color + + + + + Holds the selected and highlighted item text color + + + + + Holds the pressed item text color + + + + + Holds the disabled backcolor + + + + + Holds the disabled border color + + + + + Holds the disabled forecolor + + + + + Holds the scrollbutton backcolor + + + + + Holds the scrollbutton pressed backcolor + + + + + Holds the scrollbutton forecolor + + + + + Holds the scrollbutton border color + + + + + Holds the dragdrap line color + + + + + Gets the backcolor + + + + + Gets the forecolor + + + + + Gets the border color + + + + + Gets the selected item border color + + + + + Gets the item highlighted border color + + + + + Gets the item pressed border color + + + + + Gets the item highlighted backcolor + + + + + Gets the item selected backcolor + + + + + Gets the item selected and highlighted backcolor + + + + + Gets the item pressed backcolor + + + + + Gets the item highlighting text color + + + + + Gets the item selected text color + + + + + Gets the selected and highlighted item text color + + + + + Gets the item pressed text color + + + + + Gets the disabled backcolor + + + + + Gets the disabled forecolor + + + + + Gets the disabled border color + + + + + Gets the scrollbutton backcolor + + + + + Gets the scrollbutton pressed backcolor + + + + + Gets the scrollbutton forecolor + + + + + Gets the scrollbutton border color + + + + + Gets the dragdrop line color + + + + + This class represents rendered class for office2016 black theme + + + + + Holds the backcolor + + + + + Holds the forecolor + + + + + Holds the border color + + + + + Holds the item selected border color + + + + + Holds the item highlighted border color + + + + + Holds the item pressed border color + + + + + Holds the item highlighted backcolor + + + + + Holds the item selected backcolor + + + + + Holds the item selected and highlighted backcolor + + + + + Holds the item pressed backcolor + + + + + Holds the highlighted item text color + + + + + Holds the selected item text color + + + + + Holds the selected and highlighted item text color + + + + + Holds the pressed item text color + + + + + Holds the disabled backcolor + + + + + Holds the disabled border color + + + + + Holds the disabled forecolor + + + + + Holds the scrollbutton backcolor + + + + + Holds the scrollbutton pressed backcolor + + + + + Holds the scrollbutton forecolor + + + + + Holds the scrollbutton border color + + + + + Holds the dragdrap line color + + + + + Gets the backcolor + + + + + Gets the forecolor + + + + + Gets the border color + + + + + Gets the selected item border color + + + + + Gets the item highlighted border color + + + + + Gets the item pressed border color + + + + + Gets the item highlighted backcolor + + + + + Gets the item selected backcolor + + + + + Gets the item selected and highlighted backcolor + + + + + Gets the item pressed backcolor + + + + + Gets the item highlighted text color + + + + + Gets the item selected text color + + + + + Gets the selected and highlighted item text color + + + + + Gets the item pressed text color + + + + + Gets the disabled backcolor + + + + + Gets the disabled forecolor + + + + + Gets the disabled border color + + + + + Gets the scrollbutton backcolor + + + + + Gets the scrollbutton pressed backcolor + + + + + Gets the scrollbutton forecolor + + + + + Gets the scrollbutton border color + + + + + Gets the dragdrop line color + + + + + This enum represents the color schemes of office2016 style + + + + + This option represents the colorful theme of office2016 style + + + + + This option represents the white theme of office2016 style + + + + + This option represents the darkgray theme of office2016 style + + + + + This option represents the black theme of office2016 style + + + + + Collection of images for ImageListAdv. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + Holds the ImageListAdv + + + + + Custom type descriptor for class. + Filters our property + + + + + Initializes a new instance of the class. + + The parent custom type descriptor. + + + + Returns a collection of property descriptors for the object represented by this type descriptor. + + + A containing the property descriptions for the object represented by this type descriptor. The default is . + + + + + Returns a filtered collection of property descriptors for the object represented by this type descriptor. + + An array of attributes to use as a filter. This can be null. + + A containing the property descriptions for the object represented by this type descriptor. The default is . + + + + + Filters the properties. + + The initial collection of property descriptors. + The filtered collection of property descriptors. + + + + Custom rpovider of custom type descriptor for class. + + + + + Initializes a new instance of the class. + + + + + Gets a custom type descriptor for the given type and object. + + The type of object for which to retrieve the type descriptor. + An instance of the type. Can be null if no instance was passed to the . + + An that can provide metadata for the type. + + + + + Editor for ImageCollection. + + + + + Static instance of . + + + + + Static instance of custom for s. + + + + + Initializes the class. + + + + + Initializes a new instance of the class. + + The type of the collection for this editor to edit. + + + + Creates the instance. + + The type. + + + + + Returns a list containing the given object + + An returned as an object. + + An which contains the individual objects to be created. + + + + + Destroys the specified instance of the object. + + The object to destroy. + + + + Edits the value of the specified object using the specified service provider and context. + + An that can be used to gain additional context information. + A service provider object through which editing services can be obtained. + The object to edit the value of. + + The new value of the object. If the value of the object has not changed, this should return the same object it was passed. + + + An attempt to check out a file that is checked into a source code management program did not succeed. + + + + + Editor for images in ImageListAdv. + + + + + FileDialog for selecting images. + + + + + Array of image editors of different types. Used in building string of file extensions. + + + + + Initializes static members. + + + + + Edits the specified object value using the edit style provided by GetEditStyle. + + An ITypeDescriptorContext that can be used to gain additional context information. + A service provider object through which editing services can be obtained. + An instance of the value being edited. + The new value of the object. If the value of the object has not changed, + this method should return the same object passed to it. + + + + Class containing info about image: the image itself and string key. + + + + + Image. + + + + + Key. + + + + + Gets or sets image. + + + + + Gets or sets key. + + + + + Creates new ImageInfo. + + Image. + Key. + + + + Gets value indicating whether collection is empty. + + + + + Added for compatibility reasons. + + + + + Gets or sets image at specified index. + + Index of image. + Image at specified index + + + + Gets the image based on the current DPI + + Image Index + Returns image based on the current DPI + + + + Gets or sets image with specified key. + + Key of image. + Image with specified key. + + + + Gets collection of keys. + + + + + Adds icon to the collection. + + Icon to add. + + + + Adds image to the collection. + + Image to add. + + + + Checks whether collection contains given image. + + Image to be checked. + True if collection contains given image; otherwise false. + + + + Gets index of given image. + + Image to get index of. + Index of given image or -1 if image doesn't exist in collection. + + + + Removes given image from collection. + + Image to remove. + + + + Adds icon with specified key to collection. + + Key of the icon. + Icon to add. + + + + Adds image with specified key to collection. + + Key of the image. + Image to add. + + + + Adds array of images to collection. + + Array of images to add. + + + + Checks whether given key exists in collection. + + Key to be checked. + True if given key exists in collection; otherwise false. + + + + Gets enumerator for collection. + + Enumerator for collection. + + + + Gets index of given key. + + Key to get index of. + Index if given key or -1 if key doesn't exist in collection. + + + + Removes image with specified key. + + Key of image to remove. + + + + Sets new name to specified key. + + Index of key to set new name to. + New name of specified key. + + + + Copies the elements of the ICollection to an Array, starting at a particular Array index. + + The one-dimensional Array that is the destination of the elements copied from ICollection. + The Array must have zero-based indexing. + The zero-based index in array at which copying begins. + + + + Adds an item to the IList. + + The Object to add to the IList. + The position into which the new element was inserted. + + + + Determines whether the IList contains a specific value. + + The Object to locate in the IList. + True if the Object is found in the IList; otherwise, false. + + + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. + The element at the specified index. + + + + Determines the index of a specific item in the IList. + + The Object to locate in the IList. + The index of value if found in the list; otherwise, -1. + + + + Inserts an item to the IList at the specified position. + + The zero-based index at which value should be inserted. + The Object to insert into the IList. + + + + Removes the first occurrence of a specific object from the IList. + + The Object to remove from the IList. + + + + ImageList with support for images of different sizes and transparency. + + + + + Default image size. + + + + + Collection of images. + + + + + Collections images based on DPI + + + + + Size of images. Used in drawing and for compatibility reasons. + + + + + Indicates whether images should be drawn using ImageSize property. + + + + + Tag object. + + + + + Gets collection of images. + + + + + Gets or sets the DPI based images + + + + + Gets or sets size of images. Used in drawing. + + + + + Gets or sets value indicating whether images should be drawn using ImageSize property. + + + + + Gets or sets tag object. + + + + + Creates and initializes new ImageListAdv. + + + + + Creates and initializes new ImageListAdv. + + Container to add component to. + + + + Draws selected image to specified Graphics. If UseImageSize property is set to true, image is drawn using ImageSize property; + otherwise it's drawn using original size. + + Graphics to draw to. + Point to draw image at. + Index of image to draw. + + + + Draws selected image to specified Graphics. If UseImageSize property is set to true, image is drawn using ImageSize property; + otherwise it's drawn using original size. + + Graphics to draw to. + X coordinate of point to draw image at. + Y coordinate of point to draw image at. + Index of image to draw. + + + + Draws selected image to specified Graphics using given size. + + Graphics to draw to. + X coordinate of point to draw image at. + Y coordinate of point to draw image at. + Width of rectangle to draw image to. + Height of rectangle to draw image to. + Index of image to draw. + + + + Explicitly converts ImageList to ImageListAdv. + + ImageList to convert. + ImageListAdv with images from given ImageList. + + + + Explicitly converts ImageListAdv to ImageList. + + ImageListAdv to convert. + ImageList with images from given ImageListAdv. + + + + Converts ImageListAdv to ImageList. + + ImageList with images from ImageListAdv. + + + + creates ImageListAdv from ImageList. + + ImageList to create ImageListAdv from. + Created ImageListAdv. + + + + Converts Icon to Image with correction of alpha channel. + + Icon to convert. + Resulting Image. + + + + Checks whether Bitmap has alpha channel. + + BitmapData to check. + True if bitmap has alpha channel; otherwise false. + + + + Creates string with info about ImageListAdv. + + String with info about ImageListAdv + + + + + + + + + + + + + + + + + + + + + ImageListAdv Designer + + + + + Designer ActionList collection + + + + + Initializes a new instance of the CheckBoxAdvDesigner class + + + + + Gets a value indication the designer action + + + + + Specifies the relative position of an control to that of the + control it labels. + + + + + The relative AutoLabel position can be set manually. + + + + + Left has been replaced with side, to take into account RightToLeft configs. Please use side instead. + + + + + The AutoLabel is always positioned to the top of the labeled control. + + + + + The AutoLabel is always positioned to the left (or right if the parent control is RTL enabled) of the labeled control. + Replaces Left. + + + + + Specifies the style with which some controls will appear and behave. + + + + + Classic appearance. + + + + + Office2016 Colorful + + + + + Office2016 White + + + + + Office2016 Black + + + + + Office2016 DarkGray + + + + + Represents the that lays out the children along the borders and + at the center, very similar to the Windows Form's control docking behavior. + + + + This will dock up to five controls along the four borders and the + center. This is very similar to the control docking behavior exhibited by the + setting of a control. + + The and methods + let you specify a for a child control and also + act as an extended property during design-time for the child controls. + Here are some of the differences between Windows Forms style docking and the + . + + + When using , there can be only a single control that + can be docked to a border. + + + When using and the setting, + the bounds for layout can be customized to be something different from the control's client + rectangle. + + + Just like our other s, you can layout non-control + based items when using the . + + + + + Here is some sample code that tells you how to initialize a manager. + + // Binding a control to the manager programmatically. + this.borderLayout1 = new BorderLayout(); + this.borderLayout1.ContainerControl = this; + + // Set the border-position of the button. + this.borderLayout1.SetPosition(this.btnNorth, BorderPosition.North); + this.borderLayout1.SetPosition(this.btnSouth, BorderPosition.South); + this.borderLayout1.SetPosition(this.btnCenter, BorderPosition.Center); + this.borderLayout1.SetPosition(this.btnEast, BorderPosition.East); + this.borderLayout1.SetPosition(this.btnWest, BorderPosition.West); + + Also, take a look at the project in Tools/Samples/Layout Manager Package/ for an example. + + + + + Hashtable to maintain constraint to control mapping. + + + + + Overloaded. Creates an instance of the class and sets its defaults. + + + + + Creates an instance of the class and sets its . + + + + + Creates an instance of the class and sets its Control. + + + + + Creates an instance of the class and sets its Control, + and . + + + + + Gets or sets the vertical spacing between the layout border and the components. + + The vertical space in pixels. + + + + Gets or sets the horizontal spacing between the layout border and the components. + + The horizontal space in pixels. + + + + Sets the for a child component. + + The child component whose position is to be set. + The . + + + + Removes a child component from the layout list. + + + The childcontrol which is need to remove from layout + + + + Adds a child component to the layout list with the specified constraints. + + + The childcontrol which is added to the layout + The + + + + Returns the of a child component. + + The child component whose position is to be retrieved. + The . + + + + Retrieves the preferred size associated with the specified control. + + + The control whose perferred size is to be retrieved + Returns the PreferredSize of the control + + + + + + + Retrieves the minimum size associated with the specified control. + + + The control whose minimum size is to be retrieved + Returns the MinimumSize of the control + + + + Returns the preferred size for the ContainerControl. + + + + + + Returns the minimum size for the ContainerControl. + + + + + + Triggers a layout of the child components. + + + + + + Specifies the position and the manner in which the control will be laid out + by the . + + + + + The control is not laid out. + + + + + The control's top edge is docked to the top of its containing control. + + + + + The control's bottom edge is docked to the bottom of its containing control. + + + + + The control's right edge is docked to the right edge of its containing control. + + + + + The control's left edge is docked to the left edge of its containing control. + + + + + The control is resized to fit the area between the controls laid out in the other borders. + + + + + Convert the card names into String type. + + + + + Gets the Cards name as + + + + + + + Specifies how the children will be laid out. + + + In Default mode, the manager will center the control within the + layout rectangle based on its preferred size, when there is enough space available. + When the space available is less than the preferred size, it will simply show the + child from the top / left of the layout rectangle, shrinking the size to fit the + layout rectangle, not going below the minimum size. + In Fill mode, the preferred size of the control will be ignored and it will + be made to fill the entire client area of the parent, taking into consideration the + parent's DockPading parent(if the parent is a ScrollableControl). + + + + + The child control is laid out based on its preferred size. + + + + + The child control is laid out to fill the parent. + + + + + Represents the that lays out the children as "Cards". + + + Each child component is a "Card" with a name attached to it. + The will display only one Card at a time, allowing you + to flip through it. Use the , , , , and methods to do so. + The property lets you specify whether to lay out the children based on their + preferred size or make them fill the parent's client rectangle. + The method will expect you to pass a string value + indicating the name of the Card as the constraint. + Setting the same Card name for more than one component will result in unforseen conflicts. + During design-time, you can change the order of the child controls being laid out by moving them around + using the "Bring to Front" and "Send to Back" verbs provided by the control designer. + Take a look at the class documentation for more information on + in general. + + + Here is some sample code that tells you how to initialize a manager: + + // Binding a Control to the manager programmatically. + this.cardLayout1 = new CardLayout(); + + // Set the container control; all the child controls of this container control are + // automatically registered as children with the manager and get default card names. + this.cardLayout1.ContainerControl = this.panel1; + // Set custom card names to replace default card names. + this.cardLayout1.SetCardName(this.label1, "MyCard1"); + + // To select a card manually, use the SelectedCard property. + this.cardLayout1.SelectedCard = "MyCard1"; + + // Or move through the cards like this: + this.cardLayout1.Next(); + this.cardLayout1.Previous(); + + Also, take a look at the project in Tools/Samples/Quick Start/ for an example. + + + + + Indicates the Base Name of the card. + + + + + Overloaded. Creates a new instance of the class and sets its defaults. + + + + + Creates a new instance of the class and adds itself to the specified container. + + The logical parent into which to add itself. + This constructor is used by the design-time to add a component to the form's + field so that it gets Disposed when the form gets Disposed. + Note that this is not the same as the 's container control. + + + + Creates a new instance of the class and sets its . + + + + + Ends designer initialization. + + + + + Gets or sets the . + + The current . Default is .Default. + + + + Gets or sets the selected control. + + + + + Returns the Card name of a child component. + + The child component whose Card name is to be retrieved. + The Card name as string. + + + + Sets the Card name for a child component. + + The child component whose Card name is to be set. + The Card name as string. + Use this method to change the card name of a component + once set using . Setting a NULL or empty string + will also remove the component from the layout list. + + + + Returns the value for maintaining aspect ratio based on the control's PreferredSize. + + The control whose aspect ratio setting is to be known. + True if the aspect ratio should be maintained; false otherwise. + + + + Sets the value for maintaining aspect ratio based on the control's PreferredSize. + + The control to associate the aspect ratio setting. + True to maintain aspect ratio. False otherwise. + Use this method to specify whether or not the control will be drawn + maintaining its aspect ratio based on the control's PreferredSize. Applicable only + when the property is set to .Default. + + + + Overridden. See . + + + + + + + Generates a new unique name for a card that could be added to this . + + A card name unique within this . + + + + Overridden. See . + + + + + + Overridden. See . + + The child control which is added to the Layout + The Card Name as string + + + + Overridden. See . + + The child control which is need to remove from layout + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Validates hidden states. + + + + + Overridden. See . + + + + + Returns the current active Card. + + The control representing the card. + + + + Shows the first Card. + + + + + Returns the index of the next card that will be shown when the method gets called. + + A valid index into the list returned by the method; -1 if + a next card is not available. + This property will return the first card if the currently selected card is the last card. + + + + Shows the next Card in the list. + + + + + Returns the index of the previous card that will be shown when the method gets called. + + A valid index into the list returned by the method; -1 if + a previous card is not available. + This property will return the last card if the currently selected card is the first card. + + + + Shows the previous Card in the list. + + + + + Shows the last Card in the list. + + + + + Shows a Card by name. + + The Card's name. + + + + Gets or sets the current Card's name. + + The current Card's name. + + + + Returns an array containing the Card names as strings. + + An ArrayList of Card names. + + + + Returns an associated control given a Card name. + + The card name whose control to retrieve. + A control associated with the card name. + + + + This event is raised in method before applying new bounds. + + + + + Represents the method that will handle the event of + the . + + The source of the event. + A that contains the event data. + + + + Specifies the alignment of layout components in the direction of flow. + + + + + Center the components within the parent's width (if vertical layout) or + height (if horizontal layout). + + + + + Dock the components to the left border (if vertical layout) or + top border (if horizontal layout). + + + + + Dock the components to the right border (if vertical layout) or + bottom border (if horizontal layout). + + + + + Refer to the child's to determine the alignment and layout. + + + + + Specifies whether the children should be laid out horizontally or vertically. + + + + + Children will be laid out horizontally, left to right. + + + + + Children will be laid out vertically, top to bottom. + + + + + Specifies how child components will be positioned inside a container managed + by the manager. + + + are a set of properties that determine how a + child component will be horizontally and vertically aligned when laid out in + rows or columns. + + + + + Returns a default object (that is not empty). + + The default object. + + + + Overloaded. Creates a new instance of the class and sets its defaults. + + + + + Creates a new instance of the class + with the specified values. + + True indicates this child should participate in layout; False otherwise. + The mode in which child should be laid out (when in horizontal flow mode). + The mode in which child should be laid out (when in vertical flow mode). + True indicates a line break when this child is encountered + while laying out. + True indicates that the width of the column the corresponding + child control occupies should be proportional to the laid out column's preferred width (when laid out vertically). + True indicates that the height of the row the corresponding + child control occupies should be proportional to the laid out row's preferred height (when laid out horizontally). + + + + Indicates whether the child should participate in layout. + + True to indicate this child should participate in layout; False otherwise. Default is True. + + + + Specifies the mode in which the child should be laid out within a row. + + A value. Default is .Justify. + + + + Specifies the mode in which the child should be laid out within a column. + + A value. Default is .Center. + + + + Indicates whether this child should always be moved to the beginning of a new line when laid out. + + True to move to a new line; False otherwise. Default is False. + + + + Indicates whether the effective height of the row the corresponding child control occupies should be + proportional to the laid out rows' preferred heights, for horizontal layout mode. + + True for proportional height; False otherwise. Default is False. + + This property is in effect only when the layout mode is horizontal. When this property is on, the row + this control occupies will be deemed to take proportional height. Then the remaining vertical space + available will be split proportionally between such rows wanting proportional-height based on their preferred height. + + + + + Indicates whether the effective width of the column the corresponding child control occupies should be + proportional to the laid out columns' preferred widths, for vertical layout mode. + + True for proportional width; False otherwise. Default is False. + + This property is in effect only when the layout mode is vertical. When this property is on, the column + this control occupies will be deemed to take proportional width. Then the remaining horizontal space + available will be split proportionally between such columns wanting proportional-width based on their preferred width. + + + + + Gets or sets the structure with its properties left uninitialized. + + + + + Creates an exact copy of this object. + + The cloned object. + + + + Overridden. See + + + + + + Check the object equals with current object and properties. + True, If the object equals with . Otherwise false. Default is false. + + The object + bool + + + + The basic == operator. + + The left-hand side of the operator. + The right-hand side of the operator. + + Boolean value. + + + + + The basic != operator. + + The left-hand side of the operator. + The right-hand side of the operator. + + bool + + + + + Convert the properties values into . + + + + + Overridden. See + + + + + Binds the assembly name and type to the assembly. + + + + + Binds the assembly type to the same type in a different assembly. + + + + + Overridden. See + + + + + Overridden. See + + + + + Overridden. See + + + + + Specifies the alignment of child components within a row when horizontally laid out. + + + + + The child component is left aligned within the row. + + + + + The child component is right aligned within the row. + + + + + The child component is centered within the row. + + + + + The child component will be expanded (or shrunk up to the MinimumSize) to fill any available extra width. + + Justified components are positioned after the centered ones. + + + + Specifies the alignment of child components within a column when vertically laid out. + + + + + The child component is top aligned within the column. + + + + + The child component is bottom aligned within the column. + + + + + The child component is center aligned within the column. + + + + + The child component will be expanded to fill any available extra height. + + Justified components are positioned after the centered ones. + + + + Represents the that does a left to right or top to bottom + layout. + + + Arranges components horizontally (left to right) or vertically (top to bottom) + (As specified in the property). When there is no more space + in a line, it moves the components to the next line. + By default, each line is centered. You can change this justification using + the property. + You can also set on each component for more control + over the component's alignment and spacing within a row / column. + You can control the component spacing, in pixels, through the and properties. + When the 's changes, it automatically assigns default to the + children, for convenience sake, so that you don't + have to call for each child component. + Take a look at the class documentation for more information on + in general. + + + The following example shows you how to initialize a manager with a container control: + + // Binding a control to the manager programmatically: + this.flowLayout1 = new FlowLayout(); + + // Set the container control; all the child controls of this container control are + // automatically registered as children with the manager: + this.flowLayout1.ContainerControl = this.panel1; + + // Set some properties on the manager: + this.flowLayout1.HGap = 20; + this.flowLayout1.Alignment = FlowAlignment.Near; + + // You can prevent one or more child controls from being laid out, like this (the first argument for should be False). + // This will have the same effect as calling RemoveLayoutComponent: + this.flowLayout1.SetConstraints(this.label10, new FlowLayoutConstraints(false, HorzFlowAlign.Left, VertFlowAlign.Center, false, false, false)); + + // You can prevent automatic layout during the layout event. + // If you decide to do so, make sure to call flowLayout.LayoutContainer manually: + // this.flowLayout1.AutoLayout = false; + + Also take a look at the project in Tools/Samples/Quick Start/ for an example. + + + + + Gets or sets the alignment of layout components in the direction of flow. + + A FlowAlignment value specifying the justification. + Default is FlowAlignment.Center. + + FlowAlignment.Near will be either left justified or top justified based on + whether the layout mode is vertical or horizontal. And similarly, + FlowAlignment.Far will be either right justified or bottom justified. + FlowAlignment.ChildConstraints will make the manager refer to the child's constraints. + + + + + Gets or sets the layout mode. + + The current FlowLayoutMode. Default is FlowLayoutMode.Horizontal. + + + + Indicates whether to lay out rows in the opposite direction (right to left or bottom to top). + + False for regular layout; True for reverse layout. Default is False. + + + + Gets or sets the horizontal spacing between the components. + + The horizontal space in pixels. + + + + Indicates whether the container control should automatically grow in height when + there is not enough space when in horizontal alignment mode. + + True to automatically increase the height; False otherwise. + + This applies only in horizontal alignment mode. + + + + + Gets or sets the vertical spacing between the layout border and the components. + + The vertical space in pixels. + + + + Overloaded. Creates a new instance of the component and sets its defaults. + + + + + Creates a new instance of the class and adds itself to the specified container. + + The logical parent into which to add itself. + This constructor is used by the design-time to add a component to the form's + IContainer field so that it gets Disposed when the form gets Disposed. + Note that this is not the same as the 's container control. + + + + Creates a new instance of the component and sets its . + + The logical parent into which to add itself. + + + + + + + + + + + + Specifies the constraints associated with the specified control. + + The control for which to set the constraints. + The constraints of the control. NULL to remove the control + from the layout list. + + Passing a NULL value will actually remove the component from the layout list. + + + + + Adds or removes the specified control from the layout list. + + The control to be added or removed. + True means the control will be added; False will remove it. + + This method will be removed in a future version. Instead, use the method passing in a + instance with its + property set to the appropriate value. + + + + + Indicates whether the component is in the layout list. + + The control whose participation needs to be verified. + True if it is in the layout list; False otherwise. + + This method will be removed in a future version. Use the method to get hold of the + associated with this control and then check its + property instead. + + + + + Returns a reference to the constraints associated with the specified control. + + The control with constraints to retrieve. + A reference to the actual constraints object. + This is the actual object where the manager stores the constraints for + the control. Hence, making changes to the returned object will affect the + layout logic. + + + + Returns the constraints associated with the specified control. + + The control with constraints to retrieve. + A clone of the stored constraints object. + + The returned value is a clone which can be used independently by itself. + The changes made to the returned instance will not have any effect on the stored + constraints. Use to get hold of the actual constraints object + that is used by the manager. + + + + + Overridden. See . + + The control to associate the preferred size with. + The preferred size of the control. + + + + Overridden. See . + + + + + Overridden. See . + + The control which PreferredSize to be reset. + + + + Indicates whether to serialize the PreferredSize property. + + + + + Overridden. See . + + The Control which MinimumSize to be reset. + + + + Indicates whether to serialize the MinimumSize property. + + + + + Overridden. See . + + An EventArgs that contains the event data. + + + + + + + Removes a child component from the layout list. + + The control to be removed. + + + You can also pass a LayoutItemBase derived class as the first argument because + it has an implicit type-conversion operator that will provide its corresponding + control object (a place-holder control that allows the LayoutItemBase to participate + in the layout framework seemlessly). In VB, use the LayoutItemBase.ToControl method. + + + + + + + Overridden. See . + + Returns the size with the preferred height (when laying out Horizontal) + or size with the preferred width (when laying out Vertical). + + + + Overridden. See . + + + + + Arrange the layout components horizontally in the layout container. + + + + + Arranged the layout components vertically in the layout container. + + + + + Overridden. See . + + + + + Occurs when property is changed. + + + + + Occurs when property is changed. + + + + + Create the labeledcontrol with Autolabel which is presented in layout container. + + + + + Create the new instance for add added its controls bounds. + + Childcontrol's bounds values for the layout. + + + + Create the new instance for add added its controls bounds. + + AutoLabel's bounds values for the layout + Position for AutoLable + Horizontal space between the left of AutoLable and its labledcontrol. + Vertical space between the top ofthe AutoLable andIts labledcontrol. + Childcontrol's bounds values for the layout. + + + + Suspends updating the until is called. + + + + + Resumes updating the after a call. + + + + + Gets or sets the Location of the childcomponent. + + + + + Gets or sets the height of the childcomponent. + + + + + Gets or sets the width of the childcomponent. + + + + + InsetsCoverter sets the layout components left,right,top and bottom margins. + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Specifies the inset padding, in pixels, for a component. Used by + the manager. + + + This is the extra space that the manager adds around a component's preferred bounds before + laying out the component. + + + + + Creates an instance on the Insets class. + + Number of pixels added to the left of the component. + Number of pixels added to the top of the component. + Number of pixels added to the right of the component. + Number of pixels added to the bottom of the component. + + + + Gets or sets the insets to the left of the component. + + + + + Gets or sets the insets to the right of the component. + + + + + Gets or sets the insets to the top of the component. + + + + + Gets or sets the insets to the bottom of the component. + + + + + Overriden.See . + + + + + Overriden.See . + + + + + Overriden. See . + + + + + The basic == operator. + + The left-hand side of the operator. + The right-hand side of the operator. + + Boolean value. + + + + + The basic != operator. + + The left-hand side of the operator. + The right-hand side of the operator. + + Boolean value. + + + + + Serialize and Deserialize the objects. + + + + + Convert the properties values into . + + + + + Binds the assembly name and type to the assembly. + + + + + Binds the assembly type to the same type in a different assembly. + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Specifies how to resize a component when the component's + layout bounds are larger than its preferred size. + + + + + The component is not resized. + + + + + The component's width and height are both changed to fill the + entire available layout bounds. + + + + + The component's width is changed to fill its layout bounds + horizontally. + + + + + The component's height is changed to fill its layout bounds + vertically. + + + + + Specifies how a layout component anchors to the edges of its layout bounds when managed + by a . + + + A child component usually gets more space than its preferred size when being laid out. + These values specify how to align such components within the layout bounds. + + + + + The child component is anchored to the center of its layout bounds. + + + + + The child component is anchored to the North of its layout bounds. + + + + + The child component is anchored to the NorthEast of its layout bounds. + + + + + The child component is anchored to the East of its layout bounds. + + + + + The child component is anchored to the SouthEast of its layout bounds. + + + + + The child component is anchored to the South of its layout bounds. + + + + + The child component is anchored to the SouthWest of its layout bounds. + + + + + The child component is anchored to the West of its layout bounds. + + + + + The child component is anchored to the NorthWest of its layout bounds. + + + + + Specifies how components will be positioned inside a container managed + by the manager. + + + are a set of properties that determine how a + component will grow, shrink or reposition itself when its container is resized. + Each component has its own which means that there is potential for + unforseen size and boundary conflicts. Make sure to manually test the layout design + to determine that it behaves appropriately. + + + + + Relative positioning preference. + + + + + Makes the child component occupy the remainder of the row / column. + + + + + Returns a default object that is also empty. + + The default object. + + + + Overloaded. Creates a new instance of the class and sets its defaults. + + + + + Creates a new instance of the class + with the specified values. + + Grid column beggining position. + Grid row beggining position. + The number of columns this component should span in the virtual grid. + The number of rows this component should span in the virtual grid. + The weight of the component to obtain the extra horizontal space. + The weight of the component to obtain the extra vertical space. + The justification of a component within its available layout bounds. + The filltype to resize the components in layout bounds. + Adding the extra space arround the components preferred bounds. + The amount of pixels to add to the component size while calculating the overall width. + The amount of pixels to add to the component size while calculating the overall height. + Represents the structure with its properties left uninitialized. + + + + Gets or sets the column in the virtual grid where the component's + layout bounds begin. + + A value specifying the beginning column. Can be -1. + Default is -1. + + When -1, the positioning is relative, which means the component will + be positioned immediately to the right of the component that was + most recently added to the container. + + + + + Gets or sets the row in the virtual grid where the component's + layout bounds begin. + + A value specifying the beginning row. Can be -1. + Default is -1(.Relative). + + When -1, the positioning is relative, which means the component will + be positioned immediately to the bottom of the component that was + most recently added to the container. + + + + + Gets or sets the number of columns this component should span in the + virtual grid. + + The number of columns to span, default is 1. Can be zero (.Remainder). + + When value is zero, the component will be the last one in its row. + + + + + Gets or sets the number of rows this component should span in the + virtual grid. + + The number of rows to span, default is 1. Can be zero (.Remainder). + + When value is zero, the component will be the last one in its column. + + + + + Gets or sets the weight of this component in obtaining the extra + horizontal space. + + A double value representing the weight. Default is zero. + + Specifies how to distribute extra horizontal space for a column. + The weight of a column is calculated as the maximum WeightX of all + the components in that column. + When there is extra horizontal space it is distributed to each column + based on its weight. A component that has zero weight receives no + extra space. + + + + + Gets or sets the weight of this component in obtaining the extra + vertical space. + + A double value representing the weight. Default is zero. + + Specifies how to distribute extra vertical space for a row. + The weight of a row is calculated as the maximum WeightY of all + the components in that row. + When there is extra vertical space it is distributed to each row + based on its weight. A component that has zero weight receives no + extra space. + + + + + Gets or sets the justification of a component within its available layout + bounds (a cell in the virtual grid). + + + One of the AnchorTypes values. Default is center. + + + + + Gets or sets the fill type to resize a component when the component's + layout bounds are larger than its preferred size. + + One of the FillType values. The default is none. + + + + Gets or sets the extra space that the manager adds around a component's preferred bounds before + laying out the component. + + An Inset's instance. Default is zero inset padding on all sides. + + + + Gets or sets the amount in pixels to add to the size of the component + when determining its overall width. + + The integer value representing the padding in pixels. + Default is zero. + + + + Gets or sets the amount in pixels to add to the size of the component + when determining its overall height. + + The integer value representing the padding in pixels. + Default is zero. + + + + Gets or sets the structure with its properties left uninitialized. + + + + + Creates an exact copy of this object. + + The cloned object. + + + + Overridden. See + + + + + Overridden. See . + + The object. + + + + The basic == operator. + + The left-hand side of the operator. + The right-hand side of the operator. + + Boolean value. + + + + + The basic != operator. + + The left-hand side of the operator. + The right-hand side of the operator. + + Boolean value. + + + + + Raises when properties changed. + + + + + Initialize the layout bounds. + + + + + Represents the that performs . + + + The manager creates and manages a grid within the + container's layout bounds. Each column and row in this grid can be + of different sizes and a component can span more than one cell. + Each component can be assigned weights to determine how to distribute + extra space between components. A component can also be anchored to a border / corner + of its virtual grid cell. It can also fill its cell. + + Note that if you want the child components to be laid out purely based on their weights, + set their preferred sizes to be (0,0), specify a non-zero weightX and weigthY, + and set their Fill mode to FillMode.Both. + + The structure specifies all the above constraints associated + with a component. Use the SetConstraints method to set the constraints for each component. + To exclude a component from layout, call SetConstraints with NULL constraints. + Each component has a constraint, which means that there is potential + for conflicts in size and boundaries between components. Make + sure to manually test the layout design to determine that it + behaves appropriately. + + + The following example shows you how to initialize a manager with a container control and its children: + + // Binding a control to the manager programmatically: + this.gridBagLayout1 = new GridBagLayout(); + + // Set the container control; all the child controls of this container control are + // automatically registered as children with the manager: + this.gridBagLayout1.ContainerControl = this.panel1; + + this.gridBagLayout1.SetConstraints( + this.button1, + new GridBagConstraints(0, 0, 3, 1, 1, 0.2, AnchorTypes.Center, FillType.Both, new Insets(0, 0, 0, 0), 0, 0, false) + ); + this.gridBagLayout1.SetConstraints( + this.button2, + new GridBagConstraints(0, 1, 1, 3, 0.2, 0.6, AnchorTypes.Center, FillType.Both, new Insets(0, 0, 0, 0), 0, 0, false) + ); + + // Exclude button3 from layout: + this.gridBagLayout1.SetConstraints(this.button3, GridBagConstraints.Empty); + + // Modify an exisiting constraint: + GridBagConstraints constraints1 = this.gridBagLayout1.GetConstraintsRef(this.button1); + constraints1.Fill = FillType.Horizontal; + + // You can prevent automatic layout during the layout event. + // If you decide to do so, make sure to call gridBagLayout1.LayoutContainer manually: + // this.gridBagLayout1.AutoLayout = false; + + Also take a look at the project in Tools/Samples/Quick Start/ for an example. + + + + + Largest minimum width in each column. + + + + + Largest minimum height in each row. + + + + + Largest weight in each column. + + + + + Largest weight in each row. + + + + + Overloaded. Creates a new instance of the class and sets its defaults. + + + + + Creates a new instance of the class and adds itself to the specified container. + + The logical ContainerControl parent into which to add itself. + This constructor is used by the design-time to add a component to the form's + IContainer field so that it gets Disposed when the form gets Disposed. + Note that this is not the same as the 's ContainerControl. + + + + Creates a new instance of the class and sets its ContainerControl. + + The logical ContainerControl parent into which to add itself. + + + + + + + + + + Overridden. See . + + The control which PreferredSize to be reset. + + + + Indicates whether to serialize the PreferredSize property. + + + + + Overridden. See . + + The Control which MinimumSize to be reset. + + + + Indicates whether to serialize the MinimumSize property. + + + + + Specifies the constraints associated with the specified control. + + The control for which to set the constraints. + The constraints of the control. Or NULL to remove the control + from the layout list. + + Passing a NULL value will actually remove the component from the layout list. + + + + + Overridden. See . + + The control to associate the preferred size with. + The preferred size of the control. + + + + Returns the constraints associated with the specified control. + + The control whose constraints to retrieve. + A clone of the stored constraints object. + + The returned value is a clone which can be used independently by itself. + The changes made to the returned instance will not have any effect on the stored + constraints. Use to get hold of the actual constraints object + that is used by the manager. + + + + + Returns a reference to the constraints associated with the specified control. + + The control with constraints to retrieve. + A reference to the actual constraints object. + This is the actual object where the manager stores the constraints for + the control. Hence, making changes to the returned object will affect the + layout logic. + + + + Returns the top-left origin of the virtual grid in the current layout. + + A point representing the top-left position. + + + + Returns the row and column dimensions of the current layout. + + A 2D integer array containing the dimensions. + + + + Returns the row and column weights of the current layout. + + A 2D integer array containing the weights. + + + + Returns the cell in the virtual grid (as a point) given a location. + + The x coordinate of the location. + The y coordinate of the location. + A Point representing the virtual grid cell. + + + + Adds a component to the child layout list. + + The control to add to the layout list. + The associated with this component. + If the second argument is not a , an exception will be thrown. + + + + + + + Overridden. See . + + The control to be removed. + + + + + Overridden. See . + + Reutrns the preferred size of the Container control. + + + + Overridden. See . + + Returns the MinimumSize of the ContainerControl. + + + + Overridden. See . + + + + + Overridden. See . + + + + + Represents the that lays out the child components as a + grid consisting of rows and columns. + + + The divides the layout space into rows and columns based on the + Rows and Columns properties and assigns each similar sized cell to a child component. + You can control the component spacing, in pixels, through the and properties. + You can remove or add child controls through the SetParticipateInLayout + method. When the 's ContainerControl changes, it automatically includes all of its + children in the layout component list, for convenience sake, so that you don't + have to call SetParticipateInLayout for each child component. + The PreferredSize and MinimimumSize settings for the children are ignored by + the during layout, however the and + methods do refer to the above settings to determine the sizes. + Take a look at the class documentation for more information on + in general. + + + The following example shows you how to initialize a manager with a container control: + + // Binding a Control to the manager programmatically: + this.gridLayout1 = new Syncfusion.Windows.Forms.Tools.GridLayout(); + + // Set the container control; all the child controls of this container control are + // automatically registered as children with the manager: + this.gridLayout1.ContainerControl = this.innerPanel; + // Set some properties on the manager: + this.gridLayout1.Columns = 4; + this.gridLayout1.Rows = 5; + this.gridLayout1.HGap = 4; + this.gridLayout1.VGap = 4; + + // You can ignore one or more child Control from being laid out, like this. + // This will have the same effect as calling RemoveLayoutComponent: + //this.gridLayout1.SetParticipateInLayout(this.button1, false); + + // You can prevent automatic layout during the layout event: + // If you decide to do so, make sure to call gridLayout1.LayoutContainer manually: + // this.gridLayout1.AutoLayout = false; + + Also take a look at the project in Tools/Samples/Quick Start/ for an example. + + + + + Overloaded. Creates an instance of the class and sets its defaults. + + + + + Creates a new instance of the class and adds itself to the specified container. + + The logical parent into which to add itself. + This constructor is used by the design-time to add a component to the form's + IContainer field so that it gets Disposed when the form gets Disposed. + Note that this is not the same as the 's ContainerControl. + + + + Creates an instance of the class and sets its ContainerControl. + + The logical parent into which to add itself. + + + + Creates an instance of the class and sets its ContainerControl, + rows and columns. + + The logical parent into which to add itself. + Number of rows to be displayed in the + Number of columns to be displayed in the + + + + Creates an instance of the class and sets its ContainerControl, + rows, columns, horizontal gap and vertical gap. + + The logical parent into which to add itself. + Number of rows to be displayed in the . + Number of columns to be displayed in the . + The horizontal space between the child controls. + The vertical space between the child controls. + + + + Gets / sets the number of rows to be displayed in the . + + The number of rows. Default is 1. + At least one Row or Column property should be greater than zero. + If they are both set to zero, then the Rows property will be changed to 1. + If you try to set a negative value, this will instead be set to zero. + + + + Gets / sets the number of columns to be displayed in the . + + The number of columns. Default is 1. + At least one Row or Column property should be greater than zero. + If they are both set to zero, then the Row property will be changed to 1. + If you try to set a negative value, this will instead be set to zero. + + + + Gets / sets the horizontal spacing between the layout border and the components. + + The horizontal space in pixels. + + + + Gets / sets the vertical spacing between the layout border and the components. + + The vertical space in pixels. + + + + Indicates whether the component is in the layout list. + + The control whose participation needs to be verified. + True if it is in the layout list; False otherwise. + + + + Adds or removes the specified control from the layout list. + + The control to be added or removed. + True means the control will be added; False will remove it. + + + + Overridden. See . + + + + + + + Overridden. See . + + + + + + Retrieves the preferred size associated with the specified control. + + + + + + Retrieves the minimum size associated with the specified control. + + + + + + + + + Overridden. See . + + Returns the preferred layout size. + + + + Overridden. See . + + + + + Overridden. See . + + + + + Calculate the rows count when column count is zero. + + Number of columns + Number of rows + Number of controls + + + + Calculate the columns count when row count is zero. + + Number of columns + Number of rows + Number of controls + + + + + + + Represents a non-control based layout component. + + + Derive your non-control based components from this class if you want them to + participate in the layout management. + You can add such components to the manager using the same methods as the control + derived classes. You can pass a LayoutItemBase derived class to any method that + expects a control type argument since the LayoutItemBase has an implicit type-conversion operator + that can convert itself to a control. In VB, use the method to convert this instance to a control. + In your derived class, you can find out the size set by the layout manager + through the property and the visibility through the Visible property (listening + for the event should also help). You + should also provide the preferred size and minimum size of your component through + the and overrides. + + + This first example shows a sample LayoutItemBase derived class: + + public class MyRectangle : LayoutItemBase + { + public static Size PrefSize = new Size(0, 0); + protected Control parent; + protected Color color; + protected string text; + public MyRectangle(Control parent, Color color, string text) + { + this.parent = parent; + this.color = color; + this.text = text; + } + public void OnPaint( PaintEventArgs e) + { + e.Graphics.FillRectangle(new SolidBrush(color), this.Bounds); + StringFormat sf = new StringFormat(); + sf.Alignment = StringAlignment.Center; + sf.LineAlignment = StringAlignment.Center; + RectangleF r = new RectangleF(Bounds.Left, Bounds.Top, + Bounds.Width, Bounds.Height); + e.Graphics.DrawString(text, Control.DefaultFont, SystemBrushes.ControlText, r, sf); + } + // This override is a good place to repaint. + // Or you can listen to BoundsChanged event in LayoutItemBase. + protected override void OnBoundsChanged() + { + parent.Invalidate(new Rectangle(0, 0, this.parent.Width, this.parent.Height)); + } + + public override System.Drawing.Size MinimumSize + { + get { return MyRectangle.PrefSize; } + } + + public override System.Drawing.Size PreferredSize + { + get + { + return MyRectangle.PrefSize; + } + } + } + The above class can then participate in layout as follows. The example assumes + that there is a GridBagLayout manager that is already bound to a container. + + private void Form1_Load(object sender, System.EventArgs e) + { + this.SuspendLayout(); + // Current layout manager (Update every time you change the manager) + + // Layout Component 1: + this.myRect1 = new MyRectangle(this.gridBagLayout1.ContainerControl, Color.FromArgb(133, 191, 117), "Paint Area 1"); + this.myRect1.Bounds = new Rectangle(10, 10, 80, 20); + this.myRect1.Visible = true; + + // Layout Component 2: + this.myRect2 = new MyRectangle(this.gridBagLayout1.ContainerControl, Color.FromArgb(222, 100, 19), "Paint Area 2"); + this.myRect2.Bounds = new Rectangle(10, 40, 80, 20); + this.myRect2.Visible = true; + + // Layout Component 3: + this.myRect3 = new MyRectangle(this.gridBagLayout1.ContainerControl, Color.FromArgb(196, 214, 233), "Paint Area 3"); + this.myRect3.Bounds = new Rectangle(10, 70, 80, 20); + this.myRect3.Visible = true; + + + // Sample GridBagConstraints: + GridBagConstraints gbc1 = new GridBagConstraints(); + GridBagConstraints gbc2 = new GridBagConstraints(); + GridBagConstraints gbc3 = new GridBagConstraints(); + + gbc1.Fill = FillType.Both; + gbc1.WeightX = 0.2; + gbc1.WeightY = 0.5; + gbc1.GridPosX = 0; + gbc1.GridPosY = 0; + + gbc2.Fill = FillType.Both; + gbc2.WeightX = 0.2; + gbc2.WeightY = 0.5; + gbc2.GridPosX = 1; + gbc2.GridPosY = 0; + + gbc3.Fill = FillType.Both; + gbc3.WeightX = 0.4; + gbc3.WeightY = 0.5; + gbc3.GridPosX = 0; + gbc3.GridPosY = 1; + gbc3.CellSpanX = 2; + + // Add all the components that are to participate in Layout Management. + + // For GridBagLayouts pass gbcs for GridBagLayouts: + this.gridBagLayout1.SetConstraints(this.myRect1.ToControl(), gbc1); + this.gridBagLayout1.SetConstraints(this.myRect2.ToControl(), gbc2); + this.gridBagLayout1.SetConstraints(this.myRect3.ToControl(), gbc3); + + this.ResumeLayout(true); + } + + + + + + Creates an instance of the LayoutItemBase. + + + + + Called when the Bounds property changes. + + + + + Returns the preferred size of the component. + + + + + Returns the minimum size of the component. + + + + + Indicates whether the component should be drawn visible. + + True for visible; False for hidden. + + + + Gets / sets the bounds of the component in the corresponding layout manager's + ContainerControl's client co-ordinates. + + The rectangle within the parent control, in client co-ordinates. + + + + Returns the place holder control corresponding to the LayoutItemBase that lets + the LayoutItemBase participate in the LayoutManager framework. + + The LayoutItemBase object. + The corresponding place holder control. + + + + Returns the place holder control corresponding to this LayoutItemBase that lets + the LayoutItemBase participate in the LayoutManager framework. + + The corresponding place holder control. + + + + Defines a mechanism through which dynamic size information can be provided. + + + When a layout component implements this interface, the layout manager will obtain + the size information through this interface whenever layout is performed. This allows + you to provide dynamic layout information. + + + + + Returns the preferred size of the component. + + + + + Returns the minimum size of the component. + + + + + Specifies the type of size information requested. + + + + + The preferred size of the component. + + + + + The minimum size of the component. + + + + + Represents the method that will handle the event of + the LayoutManager. + + The source of the event. + A that contains the event data. + + + + Provides data for the event. + + + + + Creates a new instance of the ProvideLayoutInformationEventArgs class. + + The control for which the layout information is requested. + The type of information requested. + + + + Returns the type of information requested. + + A enum. + + + + Returns the control for which the layout information is requested. + + A control instance. + + + + Gets / sets the size to be returned. + + A size value. + + + + Indicates whether this event was handled and a value provided. + + True to indicate a value was provided; False otherwise. + + + + Defines the base class for Layout Managers. + + + The , , , and classes derive from this + base class. + Use one of the above classes to include layout management support in your forms / controls. + The layout manager can be configured to operate in different modes. By default, mode + layout will be automatically triggered when the fires a event. If not in + this mode, then you can call the method to trigger a layout. + By default, the ContainerControl's ClientRectangle will be used as the bounds for the + layout. But, if the property is set to a value other than Rectangle.Empty + then that rectangle area will be used as the layout bounds. + You can also lay out non-control based components as long as they derive from + the class. The LayoutItemBase derived object can be used in any + method call that expects a control instance because the LayoutItemBase has an implicit type-conversion operator + that can convert itself to a control (use the method in VB). + You can also specify / provide preferred and minimum sizes for the child components. + The default layout logic uses the component's preferred size to lay them out. + The LayoutManager also has the and methods + that will let you query for the corresponding sizes. + There are different ways in which you can provide the preferred and minimum sizes + for a component. The manager will first look for the interface + in your child component, which if found, will be used to obtain the sizes. Second, the + manager will throw a event for a specific child component, which if + handled will then be used to obtain the sizes, if provided. Third, the sizes provided + using the / method will be used to obtain the sizes. However + if SetPreferredSize / SetMinimumSize was never called, the framework will call them + with the current size of the component as the preferred / minimum size. + Take a look at the class documentation for sample code on how to + create non-control based classes that can participate in Layout management. + + + + + This event is triggered when the ContainerControl property is changed. + + + + + This event is triggered to obtain preferred size information for a child control + during layout. + + + + + Gets or sets the designer host. + + + + + Gets or sets the component designer. + + + + + Gets or sets the container control that this manager will lay out. + + A control object. + + Changing this property will raise the ContainerControlChanged event. + + + + + Raises the ContainerControlChanged event. + + An EventArgs that contains the event data. + + The OnContainerControlChanged method also allows derived classes to handle the event + without attaching a delegate. This is the preferred technique for + handling the event in a derived class. + Note to Inheritors: When overriding OnContainerControlChanged in a derived + class, be sure to call the base class's OnContainerControlChanged method so that + registered delegates receive the event. + + + + + Gets or sets the custom layout bounds, if any, to be used for layout calculation + instead of the container control's ClientRectangle. + + A Rectangle specifying the custom bounds. Default is Rectangle.Empty. + + If this value is Rectangle.Empty, then the manager will use the container control's + ClientRectangle. If other than Rectangle.Empty, then that value will be used. + When using CustomLayoutBounds, you might have to disable in + most cases and instead manually reset CustomLayoutBounds and call in + the container control's Layout event handler. + + + + + Sets the CustomLayoutBounds property to Rectangle.Empty. + + + + + Indicates whether the CustomLayoutBounds property is a value other than Rectangle.Empty. + + + + + Indicates whether the container control's + should be used as the order for laying out the child controls. + + True to use the ControlCollection order; False to use the order in which + the child components were added to the manager. + Default value is true. + + This property matters only when the corresponding layout manager relies on the + order of children in the child list in its layout logic. The FlowLayout, CardLayout + and the GridLayout managers rely on the order, while the GridBagLayout managers do not. + Note that if you have both control-based and -based child components + participating in the layout and this property is True, then the LayoutItemBase based + child components will always be at the bottom of the list when layout is performed. + In this case, if you want more control on the child order, set this property to False + and use the LayoutControls list to modify the exisiting order. + + + + + Returns the list of child components participating in layout. + + An ArrayList containing the child components. + + There are very specific cases when you have to access this list. + You should access this list to modify the position of the children in the child + components list only when property is False and + you are laying out both control-based and LayoutItemBase-based components in + the manager. Take a look at the UseControlCollectionPosition property documentation + for information on this issue. + However, you should only use this property to change the position of child + components, but never to effectively add or remove components (use the + methods provided by the respective managers). + + + + + Indicates whether the manager should lay out automatically on Layout event. + + True indicates auto layout; False otherwise. Default is True. + + If True, the manager will listen to the ContainerControl control's Layout event and perform layout + automatically. If False, you should call the manager's method to trigger + layout. + + + + + This method has been replaced by HorzNearMargin. Please use that instead. + + + + + Gets or sets the left margin between the client rectangle and the layout rectangle. + + An integer value in pixels. Default is 4 pixels. + + + + This method has been replaced by HorzFarMargin. Please use that instead. + + + + + Gets or sets the right margin between the client rectangle and the layout rectangle. + + An integer value in pixels. Default is 4 pixels. + + + + Gets or sets the top margin between the client rectangle and the layout rectangle. + + An integer value in pixels. Default is 4 pixels. + + + + Gets or sets the bottom margin between the client rectangle and the layout rectangle. + + An integer value in pixels. Default is 4 pixels. + + + + + + + Constructor to be called by derived classes. + + + + + Starts designer initialization. + + + + + Ends designer initialization. + + + + + Retrieves the preferred size associated with the specified control. + + The control for which to retrieve the preferred size. + The preferred size for the specified control. + + Take a look at the LayoutManager class documentation for information on the + different ways in which the manager obtains and you can specify the preferred and minimum size information + for a child component. + + + + + Returns the preferred size provided with a call to SetPreferredSize. + + The control whose preferred size is to be known. + The size, if any, provided or the current control size. + + Unlike GetPreferredSize, this does not throw an event or look for IProvideLayoutInformation + in the child controls. + Calling this will in turn call SetPreferredSize with the current control size, if there is no size available. + + + + + Associates a preferred size with the specified control. + + The control to associate the preferred size with. + The preferred size of the control. + + Take a look at the LayoutManager class documentation for information on the + different ways in which the manager obtains and you can specify the preferred and minimum size information + for a child component. + + + + + Makes the current sizes of the child controls their minimum and preferred sizes. + + + + + Indicates whether the PreferredSize property is a value other than Rectangle.Empty. + + + + + Removes any custom preferred size set for the specified control. + + + + + Retrieves the minimum size associated with the specified control. + + The control for which to retrieve the minimum size. + The minimum size for the specified control. + + Take a look at the LayoutManager class documentation for information on the + different ways in which the manager obtains and you can specify the preferred and minimum size information + for a child component. + + + + + Returns the minimum size provided with a call to SetMinimumSize. + + The control whose minimum size is to be known. + The size, if any provided, or the current control size. + + Unlike GetMinimumSize, this does not throw an event or look for IProvideLayoutInformation + in the child controls. + Calling this will in turn call SetMinimumSize with the current control size, if there is no size available. + + + + + Associates a minimum size with the specified control. + + The control to associate the minimum size with. + The minimum size of the control. + + Take a look at the LayoutManager class documentation for information on the + different ways in which the manager obtains, and you can specify, the preferred and minimum size information + for a child component. + + + + + Indicates whether the MinimumSize property is a value other than Rectangle.Empty. + + + + + Removes any custom minimum size set for the specified control. + + + + + Returns the dynamic preferred or minimum size of a child component. + + The child control. + The type of size required, preferred or minimum. + A reference value through which the size should be returned to the caller. + True to indicate a dynamic size was found and that the size argument has a valid value. False otherwise. + + This function will first check if the child control has an + interface and if so returns the size provided by that interface. + If not, it throws a to obtain the dynamic size. The handlers, + if any, for that event may provide the dynamic size which will be returned. + If none of the above cases succeeds then False will be returned. + + + + + Raises the event. + + A that contains the event data. + + The OnProvideLayoutInformation method also allows derived classes to handle the event + without attaching a delegate. This is the preferred technique for + handling the event in a derived class. + Note to Inheritors: When overriding OnProvideLayoutInformation in a derived + class, be sure to call the base class's OnProvideLayoutInformation method so that + registered delegates receive the event. + + + + + The handler for the container's ControlAdded event. + + The container into which a control was added. + An ControlEventArgs that contains the event data. + + This is an easy way for the derived classes to know when a child gets added to the ContainerControl. + + + + + The handler for the container's ControlRemoved event. + + The container into which a control was added. + An ControlEventArgs that contains the event data. + + This is an easy way for the derived classes to know when a child gets removed from the ContainerControl. + + + + + Adds a child component to the layout list with the specified constraints. + + The control to add to the list. + The associated constraints. + + The type of constraints to be passed varies based on the layout manager. + The for example expects a string type while the expects + a type. The and the do not expect anything + which means you can specify NULL. Take a look at the individual layout manager's documentation + for the type of constraints expected. The individual managers also provide custom type safe methods + to let you specify the appropriate constraints. + + You can also pass a derived class as the first argument because + it has an implicit type-conversion operator that will provide its corresponding + control object (a place-holder control that allows the LayoutItemBase to seamlessly participate + in the layout framework). In VB, use the method. + + + + + + Removes a child component from the layout list. + + The control to be removed. + + + You can also pass a LayoutItemBase derived class as the first argument because + it has an implicit type-conversion operator that will provide its corresponding + control object (a place-holder control that allows the LayoutItemBase to participate + in the layout framework seemlessly). In VB, use the LayoutItemBase.ToControl method. + + + + + + Removes any references to the container control and handlers for events in that + control. Will also remove references to the child control. + + + Will be called when the user sets the ContainerControl to NULL and from Dispose. + Make sure to call the base class to perform normal operations when you override + this method. + + + + + Returns the minimum size for the ContainerControl. + + A size value representing the minimum size required. + + This value is calculated based on the minimum size requirement for the child controls. + + + + + Returns the preferred size for the ContainerControl. + + A size value representing the preferred size. + + This value is calculated based on the preferred size requirement for the child controls. + + + + + Triggers a layout of the child components. + + + Use this when you want to manually trigger a layout. This will automatically + be called by the framework when is True and a Layout event occurs on the . + + + + + Returns the child components that participate in the layout. + + + The child control list. + + + The order of child controls in the returned list will take into account the + property value. + + + + + Returns the layout bounds within which to perform layout. + + The Rectangle specifying the layout bounds. + + This takes into account the value, if not empty. + If empty, the bounds are calculated based on the Container Control's ClientRectangle + and the margins specified. + + + + + Indicates the Visible state of the child control or LayoutItemBase. + + The control whose visibility is to be determined. + The visibility state. + + Use this instead of checking the Visible property of the control directly, because + if this control is a place-holder control for a LayoutItemBase, the Visibility + state will be stored elsewhere. + + + + + Indicates whether the layout manager is in a state where it can start laying out + components. + + True indicates its ready for layout; False otherwise. + + This will return True if it has a valid ContainerControl and at least one child component + to be laid out. + If you override this method, make sure to call the base class. + + + + + Helps transform points from LTR to RTL co-ordinates and vice versa. + + + + + The MaskedEditBox control provides restricted data input as well + as formatted data output. This control supplies visual cues about + the type of data being entered or displayed. + + + The MaskedEditBox is derived from + and is fully compatible with the textbox control. + + The MaskedEditBox control generally behaves as a textbox control with + enhancements for optional masked input and formatted output. If you do + not use an input mask, the MaskedEditBox control behaves much like a + textbox. + + + If you define an input mask using the Mask property, each character + position in the MaskedEditBox control maps to either a placeholder + of a specified type or a literal character. Literal characters, or + literals, can give visual cues about the type of data being used. + For example, the parentheses surrounding the area code of a telephone + number are literals: (919). + + + If you attempt to enter a character that conflicts with the input mask, + the control generates a ValidationError event. The input mask prevents + you from entering invalid characters into the control. + + + The MaskedEditBox control provides full support for the Windows Forms + designer and you can just drag-and-drop the control and set the properties. + + + The MaskedEditBox control provides full support for data binding. The + property has to be set to + when the MaskedEditBox's property is bound to a + DataColumn that only accepts numerical data. + + + The property provides the ability to break down the MaskedEditBox's content into different data groups. + The data groups can be defined through the designer and is defined by the length of the data group. For example, a mask of type + (###) ### - #### Ext 9999 representing a telephone number can be broken down into 3 data groups with the names "AreaCode", "PhoneNumber" + and "Extension" by setting the group lengths to be 5, 11, 9. You can access the DataGroups and the values they hold through an index based accessor or + name based accessor. + + + + + + // InitializeComponent + // Create the Masked edit box control: + this.maskedEditBox1 = new MaskedEditBox(); + + // Specifies if the prompt character can be entered: + this.maskedEditBox1.AllowPrompt = false; + + // The mask string: + this.maskedEditBox1.Mask = ">?<????????????"; + + // The max length is set based on the mask: + this.maskedEditBox1.MaxLength = 13; + + // The clip mode specifies if the literals are included: + this.maskedEditBox1.ClipMode = ClipModes.IncludeLiterals; + + // The date time format: + this.maskedEditBox1.TimeSeparator = ':'; + this.maskedEditBox1.DateSeparator = '-'; + + // The number format: + this.maskedEditBox1.DecimalSeparator = '.'; + this.maskedEditBox1.ThousandSeparator = ','; + + // Add the MaskedEditBox control to the form: + this.Controls.Add(this.maskedEditBox1); + + + + + + Indicates whether TextBox content is modified, when Mask is used. + + + + + The mask string that specifies the mask behavior. + + + + + The mask string to be displayed in the masked edit textbox. + + + + + The display string with the masks replaced. + + + + + The prompt character. + + + + + The prompt character when the control is in passive mode. + + + + + The padding character. + + + + + String for holding undo buffer. + + + + + String for holding redo buffer. + + + + + The insert mode. + + + + + Indicates whether the prompt character can input in a mask. + position + + + + + The static internal list of mask characters. + + + + + Used internally for holding the special masks that don't take up a + mask position in the string. + + + + + How to apply case sensitivity. + + + + + NumberFormatInfo object for handling globalization. + + + + + DateFormatInfo object for handling globalization. + + + + + The usage mode for the MaskedEditBox. + + + + + Indicaqtes whether the control has been clicked. + + + + + The maximum value that the control can take. + + + + + The minimum value that the control can take. + + + + + Internal variable to track if the control is setting the Text property + to a different value internally. In this case, the TextChanged event will + not be raised. This solves the problem with the TextChanged event being + fired even when the user has not made any changes. + + + + + The text that will be used to initailize the MaskedEdit. + + + + + The mask string for initialization. + + + + + The MaxLength for initialization. + + + + + Date separator value set during initialization. + + + + + Used to differentiate when the actual display string is different + from the internal display string (primarily because the prompt character + can be set to NULL). + + + + + SortedList with mappings of literal and mask characters between display + and internal strings. + + + + + Indicating whether the control use sequentially display mask's characters. + + + + + ValidationError event will be raised when an unacceptable + character is encountered as input. + + + This event can be handled and you can do your processing based + on the information provided. The ValidationErrorEventArgs object + will provide the invalid text that was input and also the position + within that text where the error occurred. + + + + + Used whenever the NULL character is the PromptCharacter. + + + + + Used whenever the NULL character is the PromptCharacter. + + + + + Internally holds the last used prompt character. + + + + + Manages the state of the MaskedEditBox. + + + + + MaskSatisfied event will be raised when the required fields in + a mask have been satisfied after new text has been entered / the + text changes. + + + This event will be raised only when there are entries that + require input have been filled. This even can be used to move + to another control after the mask rules have been satisfied. + + + + + Handle this event to provide custom behavior to any of the + mask characters. + + This event is raised for each valid mask position that is + being filled. In the event that the event is not handled (by + setting the Handled property of the event information), the + normal logic will be used for validating input. + + + + The ClipMode to use when returning the contents of the textbox + (with or without literals). + + + + + The integer value to offset the mask characters by. + + + + + The context menu for the textbox. + + + + + Menu items. + + + + + Menu items. + + + + + Menu items. + + + + + Menu items. + + + + + Menu items. + + + + + Menu items. + + + + + Indicates whether the locale default values have to be used for the + NumberFormatInfo object. + + + + + The data groups collection. + + + + + The internal data groups collection. + + + + + The currently selected culture. + + + + + Modifier for the culture. + + + + + List of cultures that we consider to be RightToLeft. + + + + + Indicates whether the UseUserOverride value is to be set when creating + the CultureInfo. + + + + + Use this to check that the Focused property doesn't get + set when we handle OnEnter. + + + + + Internal bool to tell the FormattedText method to return just the Text without + any padding. This is used when there is a NULL prompt as the base.Text call fails + when the Text property returns a value longer (?) than the one being set. + + + + + Indicates whether the cursor is to be positioned near the decimal + when the control receives focus. + + + + + Hashtable to hold positions. + + + + + To enable KeyPress and KeyDown events to be handled + normally. + + + + + Pulls the Character on the next data position on delete, pays caution to the mask. + + + + + Input mode. + + + + + Support for culture initialization. + + + + + Gets or sets a value indicating whether the control should enable its Accessibility support. + + + + + Property changed event handler. + + + + + This method raises the ValidationError event. + + The text that was input. + The start position of the error. + + See the method for more information. + + + + + This method raises the MaskSatisfied event. + + + See the method for more information. + + + + + Invokes the ValidationError event. + A ValidationErrorEventArgs that contains the event data. + + The OnValidationError method also allows derived classes to handle the event + without attaching a delegate. This is the preferred technique for + handling the event in a derived class. + + Inheritors: When overriding OnValidationError in a derived + class, be sure to call the base class's OnValidationError method so that + registered delegates receive the event. + + + + + + + Invokes the MaskSatisfied event. + An EventArgs that contains the event data. + + The OnMaskSatisfied method also allows derived classes to handle the event + without attaching a delegate. This is the preferred technique for + handling the event in a derived class. + + Inheritors: When overriding OnMaskSatisfied in a derived + class, be sure to call the base class's OnMaskSatisfied method so that + registered delegates receive the event. + + + + + + + Creates an object of type MaskedEditBox and initializes it. + + + The default Mask is initialized to an empty string and this will + result in the MaskedEditBox acting the same as a text box initially. + + + + + Signals the object that the initialization is completed. + + + + + Static constructor for initialization. + + + + + Initializes the context menu. + + + + + Sets the internal state of the control. + + The new state of the control. + + + + Sets the internal state of the control. + + The new state of the control. + Indicates whether the display is to be updated. + + + + Handles the popup menu. + + The context menu. + The event information. + + + + Sets the Mask for the MaskedEditBox with the given mask string + + Masked String + + + + Handles the Undo menu click. + + The undo menu. + The event data. + + + + Handles the Cut menu. + + Cut menu. + The event data. + + + + Handles the Copy menu. + + Copy menu. + The event data. + + + + Handles the Paste menu. + + Paste menu. + The event data. + + + + Handles the Delete menu. + + Delete menu. + The event data. + + + + Handles the Select All menu. + + Select All menu. + The event data. + + + + Invoke to initialize the masked edit control after + setting its properties. + + + + + Internal helper function for getting mask characters + that rely on globalized settings. + + The MaskCharType value. + Char representing the globalized value. + + + + Cleans up any resources being used. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Indicates whether TextBox content is modified, when Mask is used. + + + + + Use this property to define the mask string for the MaskedEditBox + control. + + + + The control can + distinguish between numeric and alphabetic characters for + validation, but cannot check for valid content, such as the + correct month or time of day. + + + MaskDescription + Empty String(Default) No mask. Acts like a text box. + ##-???-##Medium date (US). Example: 17-Apr-02 + ##-##-##Short date (US). Example: 04-17-02 + ##:## ??Medium time. Example: 10:14 PM + ##:##Short time. Example: 22:14 + + + The input mask can consist of the following characters. + + + + Mask characterDescription + #Digit placeholder. + .Decimal placeholder. The actual character used is the one specified as the decimal placeholder in your international settings. This character is treated as a literal for masking purposes. + ,Thousands separator. The actual character used is the one specified as the thousands separator in your international settings. This character is treated as a literal for masking purposes. + :Time separator. The actual character used is the one specified as the time separator in your international settings. This character is treated as a literal for masking purposes. + /Date separator. The actual character used is the one specified as the date separator in your international settings. This character is treated as a literal for masking purposes. + \Treat the next character in the mask string as a literal. This allows you to include the '#', &, 'A', and '?' characters in the mask. This character is treated as a literal for masking purposes. + &Character placeholder. Valid values for this placeholder are ANSI characters in the following ranges: 32-126 and 128-255. + >Convert all the characters that follow to uppercase. + <Convert all the characters that follow to lowercase. + AAlphanumeric character placeholder (entry required). For example: a, z, A Z, 0, or 9. + aAlphanumeric character placeholder (entry optional). + 9Digit placeholder (entry optional). For example: 0, 9. + CCharacter or space placeholder (entry optional). This operates exactly like the & placeholder, and ensures compatibility with Microsoft Access. + ?Letter placeholder. For example: a z or A Z. + LiteralAll other symbols are displayed as literals; that is, as themselves. + + + + + + + Indicates whether the cursor is to be positioned at the decimal separator (if any) when the + control receives focus. + + The value will be False by default. + + + + Adjusts the MaxLength property based on the Mask string. + + + + + Returns the last mask character. + + + + + + Internal helper function to set the maximum length. + + The new mask length. + + + + Gets / sets the display string. + + + + + Raises the PropertyChanged event. + + The argument for the PropertyChanged event. + + + + Overrides and prevents the event from being raised if the control is + being initialized. + + The event args. + + + + Gets / sets the character that will be used instead of mask characters when + the mask position has not been filled. + + + The default value for the prompt character is set to '-'. + + + + + Gets / sets the integer version of the PromptCharacter. + + + This will not be visible through the designer. Can be set through code. + This will be persisted by the designer. + + + + + Gets / sets the character that will be used instead of mask characters when + the mask position has not been filled when the Text property is accessed. + + + The default value for the prompt character is set to '-'. + + + + + Gets / sets the integer version of the PaddingCharacter. + + + This will not be visible through the designer. Can be set through code. + This will be persisted by the designer. + + + + + Gets / sets the usage mode for the MaskedEditBox. + + + The UsageMode defines the behavior of the MaskedEditBox + to accomodate specialized input for numbers. + + + + + Gets / sets the input mode of the + control. + + + The InputMode defines the behavior of the MaskedEditBox + to accommodate specialized input for numbers etc. + + + + + Pulls the next data position on delete, pays attention to the mask. + + + + + Gets / sets the culture that is to be used for formatting the currency display. + + + + + Gets / sets the mode for the cultures. + + + + + Gets / sets the character that will be used instead of mask characters when + the mask position has not been filled (when the control does not have the focus). + + + The default value for the prompt character is set to '\0'. + + + + + Gets / sets the integer version of the PassivePromptCharacter. + + + This will not be visible through the designer. Can be set through code. + This will be persisted by the designer. + + + + + Returns the text in the MaskedEditBox control, excluding literal + characters of the input mask. + + + For example if the content of the MaskedEditBox is + 99-222-9999, the mask is ##-###-###, + the ClipText will return 992229999. + + + + + Returns the clip text. + + The starting position for the selection. + The end position for the selection. + Returns the clip text. + + + + The MaskedEditBox can be defined to hold multiple data groups. + + + The DataGroups can be added through the designer. DataGroups are + defined by the length of the group. The value of the group can be + accessed by the index of the group or through the name of the group. + + A MaskedEditBox with a mask (###) ###-#### Ext 9999 representing a + US phone number and extension can be defined to have 3 groups - + representing the AreaCode, PhoneNumber, and Extension. The groups would + have lengths of 5, 11 and 9 in that order. + + + The DataGroup's value is affected by the property. + + + + + + Overloaded. Returns the value of a DataGroup as a string. + + + + + Returns the value of a DataGroup as a string. + + + + + Returns the value for the DataGroup. + + The current data group collection. + The index of the DataGroup. + The current clipmode. + A string with the value of the DataGroup. + + + + Returns the text for the DataGroup. + + The current data group collection. + The index of the DataGroup. + The full text. + The text for the DataGroup. + + + + Returns the offset for the DataGroup from the beginning of the string. + + The current data group collection. + The index of the DataGroup. + The offset for the current DataGroup. + + + + Returns the formatted text with the formatting. + + + For example, if the text in the MaskedEditBox is (999)999-9999, the + FormattedText property will give (999)999-9999. + + + + + Gets / sets the format of the text that will be returned by the MaskedEditBox + control. The nature of the formatting is set through the type. + + + See the type for the possible values and more information. + + + + + Gets / sets the character to use when a thousands separator position is specified. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + Indicates whether the ThousandSeparator should not be serialized if + the UseLocaleDefault property is set. + + True if the + + + + Resets the value to the culture specific value. + + + + + Gets / sets the character to use when a date separator position is specified. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + Indicates whether the DateSeparator should not be serialized if + the UseLocaleDefault property is set. + + + + + + Resets the value to the culture specific value. + + + + + Gets / sets the character to use when a time separator position is specified. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + Indicates whether the TimeSeparator should not be serialized if + the UseLocaleDefault property is set. + + + + + + Resets the value to the culture specific value. + + + + + Indicates whether the individual globalization property changes + are to be ignored. If set to True, the individual values will + be ignored and the locale default will be used. + + + + + Gets / sets the character to use when a decimal separator position is specified. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + Indicates whether the DecimalSeparator should not be serialized if + the UseLocaleDefault property is set. + + True if the + + + + Resets the value to the culture specific value. + + + + + Gets / sets the provides the + necessary globalization information for the properties that rely on these + settings. + + + This value is initially set from the + and can be changed based on your requirements. + + + + + Gets / sets the provides the + necessary globalization information for the properties that rely on the datetime + settings. + + + This value is initially set from the + and can be changed based on your requirements. + + + + + Indicates whether the prompt character can be allowed to be entered as an + input character. + + + Set the value to True if the prompt character can be entered by user. + + + + + If the mask string is empty, we do not apply any rules. + This helper function checks whether the mask is active. + + True if the mask is active; False otherwise. + + + + Indicates whether the Undo operation is possible at this time. + + + The MaskedEditBox maintains its own undo mechanism and hence + needs to implement this method to be compatible with the Undo + mechanism. + + + + + Gets / sets the Maximum Value that can be set through the MaskedEditBox. + + + This value is enforced only if the property + is set to . The mask string + should be set to contain numeric characters. All literal characters + will be ignored while computing the value of the contents of the + MaskedEditBox. The default value is set to . + + + + + Indicates whether the MaxValue property should be serialized. + + True if the value is not equal to . + + + + Resets the value to the default. + + + + + Resets BackColor of the control to its default value. + + + + + Gets / sets the Minimum Value that can be set through the MaskedEditBox. + + + This value is enforced only if the property + is set to . The mask string + should be set to contain numeric characters. All literal characters + will be ignored while computing the value of the contents of the + MaskedEditBox. The default value is set to . + + + + + Indicates whether the MinValue property should be serialized. + + True if the value is not equal to . + + + + Resets the value to the default. + + + + + Resets the MaskedEditBox control to its initial position. + + + Invoke this method when you need to reinitialize the MaskededitBox. + The Mask property will not be lost because of calling this method. + + + + + Refreshes the display based on the current display + characteristics. + + + Changes made to the Mask property or any other property that affects the + display of the formatted string will be picked up by invoking this method. + + + + + Returns the valid mapped position. + + The index in the full string. + The valid mapped position. + + + + Gets / sets the adjusted SelectionStart when the PromptCharacter or PassivePromptCharacter + is NULL. + + + + + Gets / sets the adjusted SelectionLength when the PromptCharacter or PassivePromptCharacter + is NULL. + + + + + Gets or sets a value indicating whether the control use sequentially display mask's characters. + + + + + Handles character deletion as MS MaskedTextBox. + + + + + + + + + + + + Returns the adjusted position when there is a NULL prompt. + + The current position. + The adjusted position. + + + + Indicates whether the in parameter is a literal character. + + The character to check. + True if the input character is a mask character. + + All characters that are accepted as input are subjected to + this check. + + + + + Looks up the mask character in the mask list and returns the + index so that the masking logic knows what to do with it. + + The character to be identified. + The index to the mask in the MaskedEditBox.maskList collection. + + This is a helper method that takes a character and looks up the character + in the list of recognized mask characters and returns the result. + + + + + Overrides the method. + + The event data. + + This method is overriden in order to refresh the display between the passive + and active prompt characters. + + + + + Helps to apply the ControlName settings in control. + + Name of the Control. + + + + Overrides the OnClick method. + + + Position the cursor when the user clicks inside the control. + + The event data. + + + + Overrides the method. + + The event data. + + This method is overriden in order to refresh the display between the passive + and active prompt characters. + + + + + Applies RightToLeft based on the current culture. + + + + + Extracts the mask values from the mask string that was input by the user and initializes + the internal variables that will be used in applying the mask logic. + + The mask string input by the user. + The extracted mask string.] + + The mask string is split up into three different types of + characters for applying the masking logic - they are literals, special + masks (> and <) and other masks. + + > and < are treated as special masks because they do not occupy a + position by themselves but dictate the formatting of other adjoining characters. + + + + + + Refreshes the display with the current prompt character. + + + This method changes the display based on the new prompt character by replacing + the old prompt character with the new prompt character. + + + + + Applies the masking rules and prepares the display string + based on the mask string. + + The mask string. + The display string. + + You will not need to call this method directly. It is invoked by + by methods that need to refresh the display. + + + + + Moves the cursor position depending on the action. + + The current position of the cursor. + The direction which the cursor needs to be moved. + Boolean value specifying if there is selected text. + The position of the cursor after setting it. + + The MaskedEditBox control automatically adjusts its cursor position when + there is a change in the content of the text box. + + + + + This method is a helper method for getting the next available data entry + position. + + The current position. Checks from here onward. + Returns the next available position. + + + + Returns the index of the first empty position before the current position. + + Index of the first empty position. + + + + This method is a helper method for getting the next available data entry position(backward). + + The current position. Checks from here backward. + The next available position(backward). + + + + Returns the previous data entry position. + + The current position. + Indicates whether the new position has to be unfilled. + The new position. + + + + Sets the cursor and also selects text for the specified + length based on the parameters passed in. + + The beginning position for the selection. + The length of the selection. + + + + Returns the current PromptCharacter. + + The current prompt character. + + + + Inserts a new character into the displayed text. + + The start position to insert the character. + The new character to be inserted. + Indicates whether the display is to be updated. + The changed text. + + + + Inserts a new character into the displayed text. + + The current display text. + The start position to insert the character. + The new character to be inserted. + Indicates whether the display is to be updated. + The changed text. + + + + Applies the special masks to the current character - this is for the + upper case and lower case masks that are not part of the mask string. + + + + + + + + This method is invoked when the decimal key is pressed. + + True if the key is handled; False otherwise. + + The defined behavior for this key is to jump to the position immediately + after the decimal position. + + + + + Applies group alignment. + + + + + Applies the alignment logic and moves characters within the group if possible. + In the case that there is a NULL PromptCharacter, the DisplayString should be + adjusted before invoking this method for aligning. This method will assume that + the number of characters in the MaskString will be equal to the number of + characters in the DisplayString. SpecialMasks will have to be considered separately + in the case that they exist within a group. + + The current data groups collection. + The index of the group. + + + + Use this everywhere except in RefreshPromptCharacter. + + + + + Returns the first empty position. + + The start position. + The first empty position. + + + + Intercepts the Key messages. + + The message data. + True if the key is handled; False otherwise. + + + + Overrides to suppress KeyPress. Only the KeyPress event is raised - no other + processing is done. + + The message. + True if the message is a KeyPress; otherwise the base class handles this. + + + + Removes the text selected or specified by the parameters. + + The current string to be modified. + The start position of the selection. + The end position of the selection. + The modified string. + + + + Removes the text selected or specified by the parameters within a group. In this case, + a group is defined as an area separated by a DecimalSeparator, Date Separator or + Time Separator. + + The current string to be modified. + The start position of the selection. + The end position of the selection. + The modified string. + + + + Removes the selected text. + + The start position of the selection. + The end position of the selection. + The modified string. + + + + Indicates whether the backspace key has been pressed. + + + + + + Adjusts the DisplayString for internal manipulations when the PromptCharacter/ + PassivePromptCharacter is NULL. + + + + + Indicates whether the delete key has been pressed. + + + + + + Handles a character input. + + The character that was input. + True if the character was successfully inserted. + + + + Changes the character case according to the casingType passed in and + returns the character with the correct casing. Use with the special masks + for upper case and lower case. + + The current character. + The casing change to be applied. + + + + + Positions the cursor next to a decimal separator if present. + + + + + Positions the cursor at the first data position. + + + + + Applies the current CharacterCasing settings in effect for this + textbox. + + The current character. + The casing change to be applied. + The changed character. + + + + Raises the MaskCustomValidate event. + + The event data. + + + + Indicates whether the character is valid for this position based on the + mask. + + The current position. + The current character. + True if the character is acceptable; False otherwise. + + + + Returns the decimal value of the displayed text. + + The currently displayed text. + The decimal value. + + + + Returns the numeric text. + + The current text. + The numeric text. + + + + Sets external text from the + clipboard to the MaskedEditBox. + + The text to be pasted. + The beginning position. + Indicates whether the text is to be inserted. + Indicates whether to ignore prompt characters. + True if the text was set successfully; False otherwise. + + + + Internal helper for getting the PromptCharacter. + + The prompt character. + + + + Internal helper for getting the PassivePromptCharacter. + + The passive prompt character. + + + + This method will Undo the previous operation. + + + The MaskedEditBox maintains its own undo mechanism. + + + + + Copies the content of the MaskEditBox to the clipboard. + + + The ClipMode property dictates what gets copied. + For example, if the content of MaskedEditBox is (919)481 1974, the + following will be the strings copied to the clipboard depending + on the ClipMode property: + + ClipModes.IncludeLiterals - (919)481 1974 + ClipModes.ExcludeLiterals - 9194811974 + + + + + + Handles the pasting of data from the clipboard into the + MaskededitBox control. + + + The method takes into account the nature of the text in the clipboard + and tries to normalize the text. It will accomodate as much as possible + depending on the current length of the text and the total length allowed. + If text with acceptable and unacceptable characters are found in the + clipboard, the unacceptable data is omitted when the data is inserted. + + + + + Cuts data from the MaskedEditBox and pastes it into + the clipboard. + + + The MaskedEditBox deletes the selected text in this case and then + copies the deleted text to the clipboard. The ClipMode property dictates + whether the literal characters are copied to the clipboard or not. + + + + + Clears the mask edit back to its initial state. + + + + + + + Sets the text property of the MaskedEditBox without raising the + TextChanged event. + + The new text string. + + This method is provided as an alternative to being able to + set the Text property through the designer. + + + + + Overrides the property. + + + This method is overriden in order to intercept and normalize + external text that is not in a format acceptable to the + MaskedEditBox. + This property value will not be persisted in the designer. Set the Text property + after initialization through code or use the SetInitialText method to set the + value without raising the TextChanged event. + + + + + Internal helper function to directly set the base control Text property. + + The new value. + + + + The UseUserOverride parameter for CultureInfo. + + + + + See property. The MaskedEditBox does + not support multiline controls. + + + + + See property. The MaskedEditBox does + not support multiline controls. + + + + + See property. The MaskedEditBox does + not support multiline controls. + + + + + See property. The MaskedEditBox does + not support multiline controls. + + + + + Overrides method. + + The event data. + + Raises the event when there is unacceptable + text in the control. + + + + + Validates the control. + + Specifies if the validation error is to be raised. + + + + Returns the display string when the current prompt character is NULL. + + The internal text. + The new display string. + + + + Gets length of the clean text, text without , + and characters. + + + + + Provides information about a control that can be used by an accessibility application. + + + + + MaskedEditBox + + + + + Constructor + + The RibbonControlAdv instance. + + + + Bounds of the Control + + The accessible object bounds. + + + + Gets the role for the RibbonControlAdv. This is used by accessibility programs. + + + + + Gets or sets the accessible object name + + The accessible object name. + + + + Gets the description of the RibbonControlAdvAccessibility + + A string describing the RibbonControlAdvAccessibility. + + + + Retrieves the child object at the specified screen coordinates. + + The horizontal screen coordinate. + The vertical screen coordinate. + An RibbonControlAdvAccessibility that represents the child object at the given screen coordinates. + This method returns the calling object if the object itself is at the location specified. + Returns null if no object is at the tested location. + + + + This class is used to send event data for a + event. + + + The required pieces of information for the event + are the invalid text and the position of the error text within the invalid text. + + + + + The invalid text. + + + + + The start position of the error. + + + + + Creates an object of type ValidationErrorArgs. + + The invalid text that would have resulted if this error had not been intercepted. + The index position with the invalid text where the change occurred. + + + + Returns the invalid text as it would have been if the error had not intercepted it. + + + + + Returns the location of the invalid input within the + invalid text. + + + + + The DataGroup that will specify the behavior and formatting of a + DataGroup within the MaskedEditBox control. + + + + + The text of the column header. + + + + + The minimum width for the column header. + + + + + The name of the Datagroup. + + + + + The string value of the DataGroup. + + + + + Collection of datagroups. + + + + + Gets / sets the collection of datagroups. + + + + + Overloaded. Initializes an object of type MaskedEditDataGroupInfo. + + + The MaskedEditDataGroupInfo class holds the information needed to intialize + a data group for the control. + + + + + Initializes an object of type MaskedEditDataGroupInfo. + + The name of the DataGroup. + The DataGroup size. + The DataGroup alignment. + + + + PropertyChanged event handler. + + + + + Raises the PropertyChanged event. + + + + + + Gets / sets the size of the DataGroup. + + + + + Returns the value of the DataGroup. + + + + + Gets / sets the name of the DataGroup. + + + + + Gets / sets the alignment of the DataGroup. + + + + + Collection of objects. Used in the + property of the + control. + + The MaskedEditDataGroupInfoCollection is a set of objects + each of which hold information required to create a data group in a + . + + + + Gets / sets the owner of this collection. + + + + + Gets / sets the Indexer property for the MaskedEditDataGroupInfoCollection class. + + Get the object based on the index + in the collection. + + + + Gets / sets the Indexer property for the MaskedEditDataGroupInfoCollection class. + + Get the object based on the index + in the collection. + + + + Returns the index based on the name. + + The name of the data group. + Index value. + + + + Inserts the into the collection + at the specified index. + + The zero-based index at which the item is to be inserted. + The to be inserted. + + + + Overrides OnInsert. + + + + + Overrides OnInsertComplete. + + + + + Overloaded. Creates an instance of the MaskedEditDataGroupInfoCollection class. + + The control that + contains this collection. + + + + Creates an instance of the MaskedEditDataGroupInfoCollection class. + + + + + Adds one object to the collection. + + The object to be added. + The count of the list items. + + + + Removes objects from the + collection. + + The MaskedEditDataGroupInfo object to remove. + + + + Indicates whether the collection contains a specific + MaskedEditDataGroupInfo entry. + + The MaskedEditDataGroupInfo to locate in the DataGroups. + True if the MaskedEditDataGroupInfo entry is found in the collection; false otherwise. + + + + Copies all the elements of the current one-dimensional array to the specified one-dimensional array + starting at the specified destination array index. + + The array. + The index. + + + + Returns the value of the DataGroup. + + String value of the DataGroup. + + + + Provides data for an event that can be handled by a subscriber and overrides the events default behavior. + + + + + Feedback. + + + + + Values based on which event handler can set return values. + + + + + Overloaded. Initializes a new instance of the MaskCustomValidationArgs class with the Handled property set to False. + + + + + Initializes a new instance of the SyncfusionHandledEventArgs class with the Handled and Accepted + properties set to the given value. + + + + + + + + + + + + + Indicates whether the event has been handled and no further processing of the event should happen. + + + + + Indicates whether the event has been handled and no further processing of the event should happen. + + + + + Returns the current position. It will be a valid mask position. + + + + + Returns the current character. + + + + + Returns the current Mask Character. + + + + + Represents a method that handles a event of a + . + + + + + Specifies the internal state of the MaskedEditBox. + + + + + Normal State. + + + + + Edit State. + + + + + Initial State. + + + + + The clipping mode to be used by the control + when returning the text content of the control. + + + + + Include all literals in the data that is + returned. + + + + + Exclude all literals in the data that is returned. + + + + + Specifies different modes of input + for the MaskedEditBox control. + + + + + In this input mode, all input is entered in Overtype mode. + The INSERT key will not have any effect in this mode. + + + + + Operates in Insert mode and when the INSERT key is pressed, + changes to Overtype mode. + + + + + The clipping mode to be used by the control + when returning the text content of the control. + + + + + Treat as a normal masked edit that does not have any + special constraints with respect to the content. + + + + + Treat the contents of the MaskedEditBox as numeric. + + + + + Enumeration for the kind of case sensitivity to be applied + at a particular point of data input. + + + + + Convert to lower case or upper case depending on the mask. + + + + + Change to lower case only. + + + + + Change to upper case only. + + + + + The various valid masks supported by the control. + + + + + Digit placeholder '#'. Numeric and white space + + + + + Decimal placeholder '.' The actual character used is the + one specified as the decimal placeholder in your + international settings. This character is treated + as a literal for masking purposes. + + + + + Thousands separator ',' The actual character used is the + one specified as the thousands separator in your + international settings. This character is treated as a + literal for masking purposes. + + + + + Time separator ':' The actual character used is the one + specified as the time separator in your international + settings. This character is treated as a literal for masking + purposes. + + + + + Date separator '/' The actual character used is the one + specified as the date separator in your international + settings. This character is treated as a literal for + masking purposes. + + + + + Escape '\' Treat the next character in the mask string as a literal. + This allows you to include the '#', &, 'A', and '?' + characters in the mask. This character is treated as a + literal for masking purposes. + + + + + Character placeholder & Valid values for this placeholder + are ANSI characters in the following ranges: 32-126 and 128-255. + + + + + Uppercase > Convert all the characters that follow to uppercase. + + + + + Lowercase < Convert all the characters that follow to lowercase. + + + + + Alphanumeric character placeholder 'A' + (entry required). For example: a z, A Z, or 0 9. + + + + + Alphanumeric character placeholder (entry optional)'a' + + + + + Digit placeholder (entry optional). For example: 0 9. '9' + + + + + Character or space placeholder (entry optional) 'C' + This operates exactly like the & placeholder, and + ensures compatibility with Microsoft Access. + + + + + Letter placeholder. For example: a z or A Z '?' + + + + + Letter placeholder. For example: a z or A Z 'y' + + + + + Hexadecimal placeholder. For example: A9 EF + + + + + Hexadecimal placeholder. For example: A9EF + + + + + Provides the list of modes in which the MaskedEditBox can operate + when it does not have the focus. + + + + + Include all literals in the data that is + returned. + + + + + Exclude the literal characters. + + + + + The clipping mode to be used by the control + when returning the text content of the control. + + + + + Do not apply any alignment. + + + + + Left aligned. + + + + + Right aligned. + + + + + Center aligned. + + + + + The delegate for handling the ValidationError event. + + + Refer to the event for more information. + + + + + The ValidationErrorEventArgs class is used to send event data for a + event. + + + The required pieces of information for the event + are the invalid text and the position of the error text within the invalid text. + + + + + The invalid text. + + + + + The start position of the error. + + + + + The error message. + + + + + Overloaded. Creates an object of type ValidationErrorArgs. + + The invalid text that would have resulted if this error had not been intercepted. + The index position with the invalid text where the change occurred. + + + + Creates an object of type ValidationErrorArgs. + + The invalid text that would have resulted if this error had not been intercepted. + The index position with the invalid text where the change occurred. + The error message. + + + + Returns the invalid text as it would have been if the error had not intercepted it. + + + + + Returns the location of the invalid input within the + invalid text. + + + + + Returns the error message. + + + + + Provides information about a control that can be used by an accessibility application. + + + + + DoubleTextBox + + + + + Constructor + + The RibbonControlAdv instance. + + + + Bounds of the Control + + The accessible object bounds. + + + + Gets the role for the RibbonControlAdv. This is used by accessibility programs. + + + + + Gets or sets the accessible object name + + The accessible object name. + + + + Gets the description of the RibbonControlAdvAccessibility + + A string describing the RibbonControlAdvAccessibility. + + + + Retrieves the child object at the specified screen coordinates. + + The horizontal screen coordinate. + The vertical screen coordinate. + An RibbonControlAdvAccessibility that represents the child object at the given screen coordinates. + This method returns the calling object if the object itself is at the location specified. + Returns null if no object is at the tested location. + + + + Provides information about a control that can be used by an accessibility application. + + + + + IntegerTextBox + + + + + Constructor + + The RibbonControlAdv instance. + + + + Bounds of the Control + + The accessible object bounds. + + + + Gets the role for the RibbonControlAdv. This is used by accessibility programs. + + + + + Gets or sets the accessible object name + + The accessible object name. + + + + Gets the description of the RibbonControlAdvAccessibility + + A string describing the RibbonControlAdvAccessibility. + + + + Retrieves the child object at the specified screen coordinates. + + The horizontal screen coordinate. + The vertical screen coordinate. + An RibbonControlAdvAccessibility that represents the child object at the given screen coordinates. + This method returns the calling object if the object itself is at the location specified. + Returns null if no object is at the tested location. + + + + Summary description for SpecialCultureValues. + + + Modifier for the currently selected culture. + + + + + No modifier for the selected culture. + + + + + Use the current culture on the system. + + + + + Use the current UI culture. + + + + + Use the current InstalledCulture. + + + + + Summary description for NumberClipModes. + + + The clipping mode to be used by the control + when returning the text content of the control. + + + + + Include all literals in the data that is + returned. + + + + + Exclude all literals in the data that is returned. + + + + + Summary description for CurrencyClipModes. + + + The clipping mode to be used by the control + when returning the text content of the control. + + + + + Include all literals in the data that is + returned. + + + + + Exclude all literals in the data that is returned. + + + + + Extends the class to handle numeric input + and validation. + + + The NumberTextBoxBase class is not to be used directly. Defines the base class for + controls that provide specific formatting and validation for different data types. + + + + + The NumberFormatInfo object that will specify the + localized attributes for displaying the currency + value. + + + + + Forecolor to be used when the value is negative. + + + + + Gets or sets a value indicating whether to overrite the immediate text. + + + + + Specifies when the MinMax Validation Need to be performed. + + + + + Specifies the Action To be Performed when Validation Fails + + + + + Forecolor to be used when the value is positive. + + + + + Forecolor to be used when the value is zero. + + + + + Indicates whether the current value is negative. + + + + + The clip mode specifies the kind of data to be returned + when copied to the clip board. + + + + + The context menu for the text box. + + + + + Menu items. + + + + + Menu items. + + + + + Menu items. + + + + + Menu items. + + + + + Menu items. + + + + + Menu items. + + + + + String for holding undo buffer. + + + + + String for holding redo buffer. + + + + + Internal variable to suppress TextChanged event. + + + + + The currently selected culture. + + + + + Indicates whether the special culture values need to be applied. + + + + + Array of cultures that require RightToLeft by default. + + + + + The UseUserOverride value to be passed in when creating CultureInfo objects. + + + + + The NULL string value. + + + + + Indicates whether the control is in NULL state. + + + + + The IFormatProvider for formatting NULL entries. + + + + + + + + + + Indicates whether the NULL String should be used. + + + + + Indicates whether an operation is to be rolled back because of an error. + + + + + Support for culture initialization. + + + + + Support for NumberFormatInfo initialization. + + + + + Indicates whether to allow the KeyPress event to be raised but no other action to be taken + by the base class. + + + + + Indicates whether to allow the KeyDown event to be raised but no other action to be taken + by the base class. + + + + + Indicates whether the current value can be held in numeric form or has + been 'dirtied' by user input. + + + + + Used when the NegativeSign is keyed in when the value is zero. + + + + + Indicates whether the control is to listen to the + event and refresh the culture. (Only if the SpecialCultureValue is set to CurrentCulture.) + + + + + + + + + + This will be set to True when the negative key is input with the entire contents of the + textbox selected. + + + + + Custom backcolor that will be used when the control is Read-only. + + + + + Gets or Sets the BackGroundColor of the control. + + + + + Event raised when NULL State is to be set based on a value. + + + + + Event raised when a Key is to be validated. This validation is performed before any of the + NumberTextBox's own validation of the input character. + + + + + Overloaded. Creates an object of type NumberTextBox. + + + The NumberTextBox object will be initialized with the default values + for the display and data properties. You need to set any specific + values. + + + + + Implementation of the interface. + + + + + Update culture based on LCID. + + A Boolean that denotes whether to use the user-selected culture settings (true) + or the default culture settings (false). + CurrentCulture if LCID is not available. + + + + Initialize the context menu. + + + + + + + + + + If the Min Max values are not met, the Validating event will be handled and cancelled if this property is set to true. + + + + + Occurs when the input text is invalid for the current state of the control. + + + + This event can be handled and you can do your processing based + on the information provided. The ValidationErrorEventArgs object + will provide the invalid text that was input and also the position + within that text where the error occurred. + + + The ValidationError event is raised when: + 1. The event is raised (if there is invalid input). + 2. Invalid key characters are input. + 3. Invalid values are set through the Text property. + + + + + Console.WriteLine("ValidationError in currencyTextBox1 InvalidText" + e.InvalidText); + Console.WriteLine("ValidationError in currencyTextBox1 StartPosition" + e.StartPosition ); + + + + + This method raises the ValidationError event. + + The text that was input. + The start position of the error. + + See the method for more information. + + + + + Invokes the ValidationError event. + A ValidationErrorEventArgs that contains the event data. + + + The OnValidationError method also allows derived classes to handle the event + without attaching a delegate. This is the preferred technique for + handling the event in a derived class. + + Inheritors: When overriding OnValidationError in a derived + class, be sure to call the base class's OnValidationError method so that + registered delegates receive the event. + + + + + Overrides method. + + The event data. + + Raises the event when there is unacceptable + text in the control. + + + + + Validates the control. + + Indicates whether the validation error is to be raised. + + + + Gets or sets the culture that is to be used for formatting the numeric display. + + + + + Refreshes and reapplies the culture specific settings. + + + Call this function when there has been a change in the CurrentCulture of the + application. + + + + + Gets or sets the mode for the cultures. + + + + + Indicates whether the Culture property is to be refreshed when the culture changes. + + + + + The UseUserOverride parameter for CultureInfo. + + + The NumberTextBoxBase control has several properties that expose culture-specific + information. These properties use a object for + handling the culture specific information. This property is used in the creation + of the NumberFormatInfo object. + + + + + Indicates whether the NULLString property will be used. + + + + + + + + + + Gets or sets a value indicating whether control's elements are aligned to + support locales using right-to-left fonts. + + + + + Resets the property to its default value. + + + + + Resets the property to its default value. + + + + + Gets or sets the back color. (overridden property) + + + + + Gets or sets the NumberFormatInfo object that will be used for formatting the + number value. + + + This property will not be exposed to the developer. This is only meant + to be an accessor for use within the control. The developer will be able + to access the properties of the NumberFormatInfo through the individual + properties exposed. + + + + + Gets or sets the sign that is to be used to indicate a negative value. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + Indicates whether the NegativeSign should not be serialized if the value is the same as the one for the + current culture. + + True if the property should be serialized; otherwise False. + + + + Resets the value to the culture specific value. + + + + + Returns a copy of the current NumberFormatInfo. + + + + + + Gets or sets the forecolor when the current value is negative. + + + You can customize the look and provide feedback to the user by defining + a different color for the negative numbers. + + + + + Indicates whether NegativeColor property value should be serialized. + + + + + Resets NegativeColor property to default value. + + + + + Gets or sets the forecolor when the current value is zero. + + + You can customize the look and provide feedback to the user by defining + a different color for displaying zero. + + + + + Indicates whether ZeroColor property value should be serialized. + + + + + Resets ZeroColor property to default value. + + + + + Gets or sets the forecolor when the current value is positive. + + + You can customize the look and provide feedback to the user by defining + a different color for the positive numbers. + + + + + Indicates whether PositiveColor property value should be serialized. + + + + + Resets ResetPositiveColor property to default value. + + + + + Returns the NumberFormatInfo object for the NULL display. + + + + + Gets or sets the NULL string to be displayed. + + + + + Gets or sets the NULL string to be displayed. + + + + + Occurs when the property is changed. + + + + + Raises the event. + + A that contains the event data. + + + + Occurs when the property is changed. + + + + + Wrapper property around the selected value. Use this property if you + want to be able to set the value of the control to NULL. + + + + + Gets or set the default value. + + + + + Gets or sets a value indicating whether to overrite the immediate text when the text cannot be inserted. + Effective when MinMaxValidation is set to OnKeyPress. + + + + + Specifies when the MinMax Validation Need to be performed. + + + + + Overrides the MaxLength property. This has no effect on this EditControl as it does not honor MinValue and MaxValue properties. + + + The control does not honor the + MaxLength property. Set the and + properties. + + + + + Specifies the action to be performed when validation fails, Effective only if MinMaxValidation is set to OnLostFocus + + + + + Indicates whether the field is Null(NullString) or Not. + + when this is True and is True the field will be assigned with + + + + Indicates the NULLState of the control. + + + + + Sets the control's forecolor depending on whether the + current value is negative. + + + See the and + properties. + + + + + Takes the incoming text, formats it based on the + rules and settings prevailing currently and sets + the display accordingly. + Returns the length of the new text after setting the + display. + + + + + + + Takes the incoming text, formats it based on the + rules and settings prevailing currently and sets + the display accordingly. + Returns the length of the new text after setting the + display. + + + + + + + Formats the given text according to the current setting. + + + + + + + + + + + + + + Gets or Sets the BackGroundColor of the control. + + + + + Resets the ControlBackColor property to its default value. + + + + + Resets the ControlBackColor property to its default value. + + + + + Color to be used for the Backcolor when the control is Read-only. + + + + + Resets ReadOnlyBackColor property to default value. + + + + + Determines whether to include or exclude the literal characters in the input mask when doing a copy command. + + + This property is used when copying to the clipboard and also the + property. + + When databinding the Text property, it is advisable to have the ClipMode + set to in cases where + the data source does not accept the formatted text. + + + + + + Returns the clipped text without the formatting. + + + For example, if the text in the CurrencyTextBox is $45,000.00, the + ClipText property will give 45000.00. + + + + + Gets the clip text. + + + + + + + Occurs when the property is changed. + + + + + Raises the event. + + A that contains the event data. + + + + Returns the formatted text with the formatting. + + + For example, if the Text in the CurrencyTextBox is $45,000.00, the + FormattedText property will give $45,000.00. + + + + + Occurs when the property is changed. + + + + + Raises the event. + + A that contains the event data. + + + + Indicates whether the Undo operation is possible at this time. + + + The NumberTextBox maintains its own undo mechanism and hence + needs to implement this method to be compatible with the Undo + mechanism. + + + + + Handles the Context popup. + + The context menu. + + + + + Handles the Undo menu click. + + The undo menu. + The event data. + + + + Handles the Cut menu. + + Cut menu. + The event data. + + + + Handles the Copy menu. + + Copy menu. + The event data. + + + + Handles the Delete menu. + + Delete menu. + The event data. + + + + Handles the Select All menu. + + Select All menu. + The event data. + + + + Handles the Paste menu. + + Paste menu. + The event data. + + + + This method will Undo the previous operation. + + + This method is invoked when the Undo context menu item is + clicked or the shortcut (CTRL+Z) is clicked. You can override + this method to provide your own implementation for Undo. + + + + + Selects all text in the text box. + + + This method is called when the menu item "Select All" or its + shortcut (CTRL+A) is used. This method overrides the base + implementation in . + Override this method to provide your own implementation for + SelectAll. + + + + + Pastes the data in the clipboard into the NumberTextBox control. + + + The data will be formatted before being pasted into the text box. + + + + + Copies the content of the NumberTextBox to the clipboard. + The ClipMode property dictates what gets copied. + + + If the text of the control is $56,000.12, this is the content + that will be copied to the clipboard based on whether the ClipMode + is set to or + . + + IncludeFormatting - $56,000.12 + ExcludeFormatting - 56000.12 + + + + + + Cuts the selected data to the clipboard. + + + The selected text in the CurrencyTextBox will be deleted and the content + will be copied to the clipboard. + + + + + Deletes the current selection of the text box. + + + This method is invoked by the ContextMenu "Delete" menu item of the + text box through the "Del" shortcut or by selecting the menu item. + If you want to override the default behavior of this method, derive + and override this method to provide your own implementation. + + + + + The NumberTextBox accepts numeric digits only. This method checks + for numeric input. + + The character to be checked. + True if the character is valid; false otherwise. + + + + Overloaded. Override this method to provide an implementation for parsing + a negative value. + + The text to be parsed. + True if the value is negative; false otherwise. + + + + Override this method to provide an implementation for parsing + a negative value. + + The text to be parsed. + True if the value is negative; false otherwise. + + + + Sets the start position to value passed and sets the + SelectionLength to be zero. + + The start of the selection. + + + + Returns the first data position which is the index within the current + string content of the edit control at which data can be + inserted. + + The index of the first possible data position. + + + + Returns the next valid position for receiving data input. + + The position to start seeking from. + Indicates whether the start position is after the decimal separator. + Indicates whether the backspace key has been pressed. + The index in the string that is valid for input. + + + + Overloaded. Returns the position of the decimal separator taking into account + the CurrencySymbol. + + The text in which to look for the decimal separator. + The decimal separator's position. + + + + Returns the position of the decimal separator taking into account + the CurrencySymbol. + + The text in which to look for the decimal separator. + The decimal separator's position. + + + + Returns the previous valid data position for text input. + + The position to seek from. + + + + + Overloaded. Override this to return DecimalSeparator in NumberTextBox. + + + + + Override this to return DecimalSeparator in NumberTextBox. + + + + + Overloaded. Override this to return GroupSeparator in NumberTextBox. + + + + + Override this to return GroupSeparator in NumberTextBox. + + + + + Deletes the currently selected text. + + The content of the text box after deletion. + + + + Deletes the currently selected text. + + The content of the text box after deletion. + + + + Returns the first data position that can take valid input. + + The start position to seek from. + The index of the first valid position. + + + + Checks if the text can be inserted subject to the constraints. + + The current content of the text box. + The text to be inserted. + The length of the acceptable string to be inserted. + + + + + + + + + + + Indicates whether the given value meets the minimum and maximum value considerations. + + + + + + + + Checks whether the NullSring Value is with in the Min Max Values + + + True if it is in range else false + override this method to check the nullString is in range by parsing it to respective Type + + + Double doubleVal; + bool isNumber = Double.TryParse(currentTextValue, out doubleVal); + if (isNumber) + { + return CheckForMinMax(doubleVal.ToString(),true); + } + else + return true; + + + + + + Inserts a string into the textbox at the current position. + The string data will be parsed for valid numeric data and + only the valid characters will be accepted. + + The string to be inserted. + Paste and Text properties will be treated differently for validation. + True if the operation succeeds. + + This method attempts to insert the text passed in as the parameter into + the NumberTextBox subject to the constraints imposed by the other + attributes of the NumberTextBox such as the maximum length of a + the string etc. + + + + + Concat modified text. + + + + + + + + + Overrides OnTextChanged. + + The event data. + + + + Checks the length of the decimal part of the text box content. + + The input raw text string. + The checked string. + + + + Returns the count of zeros at the beginning of the string. This is + needed as we will have to compensate for this once a valid + number appears after it for repositioning the cursor. + + + + + + + + Indicates whether the start position is after the decimal separator. + + The current text. + The start position to seek for. + + + + + + + + + + + + + + + + + This method overrides the method + and handles the key messages that are of interest to the NumberTextBox. + + The message that is to handled. + True if the key message is handled; false otherwise. + + + + Overrides to suppress KeyPress. Only the KeyPress event is raised - no other + processing is done. + + The message. + True if the message is a KeyPress; otherwise the base class handles this. + + + + Handles the backspace key. + + True if the key was accepted and the action performed; false otherwise. + + The backspace key results in one character being removed in front of the + current selection if the selection is empty or deletion of the selection if the + selection is not empty. + + + + + Invoked when a character key is pressed. + + The character to be inserted. + True if the insert was successful; false otherwise. + + Character entry is accepted if the character is a valid digit. This + method invokes the InsertString method to insert the character into + the CurrencyTextBox. + + + + + When the start position is in the number part and there is only a zero, the cursor should be moved. + + + + + + + + Invoked when the Delete key is pressed. + + True if the key is handle; false otherwise. + + This method performs the action of removing the selected text when the + delete key was pressed and also positioning the cursor appropriately. + + + + + This property defines the behavior when the contents of the TextBox is fully selected and the negative + key is pressed by the user. + If the value is set to True - The current value is not changed at all. The next key stroke is taken to be a + new value and the entire contents of the TextBox is replaced by the negative value of the key stroke character + entered. Example: If the current value of the TextBox is 1.00 and all the text is selected and the user presses + the -ve key followed by the key 5 - the value is -5.00 + If the value is set to False - The current value is changed to the negative value immediately. Example: If the current value of the TextBox is 1.00 and all the text is selected and the user presses + the -ve key the value is -1.00 + + + + + Invoked when the negative key is pressed. + + True if the key is handled; false otherwise. + + The defined behavior for this key is to toggle the sign (negativity) + of the content of the NumberTextBox. + + + + + Decimal typing mode. Use if NullString is true; + + + + + Decimal digits position. Use for typing in decimal mode. + + + + + Invoked when the decimal key is pressed. + + True if the key is handled; false otherwise. + + The defined behavior for this key is to jump to the position immediately + after the decimal position. + + + + + Invoked for positioning the cursor at the right position after + something has changed. + + The number of valid numbers before the point. + Indicates whether the point comes after the decimal separator. + Indicates whether the direction is backwards. + + + + Need all select OnMouseDown. + + + + + + + + Specifies if the text should be selected when the control gets the focus. + + + + + Gets or sets SelectedText. (overridden property) + + + + + Please use NegativeColor, ZeroColor and PositiveColor properties instead of ForeColor property. + + + + + The delegate for handling the SetNULL event. + + + Refer to the event for more information. + + + + + Provides data about a and + events of a , , + , or . + + + + + Initializes a new with event data. + + The NULL value. + + + + Returns the NULL value. + + + + + The delegate for handling the KeyValidate event. + + + Refer to the event for more information. + + + + + Cancellable event for + of , , + , or . + + + + + Returns the character key that was input by the user. + + + + + Returns the changed string that will be set as the text of the text box if this event is not cancelled. + + + + + Returns the unformatted changed string that will be set as the text of the text box if this event is not cancelled. + + + + + provides new value and old value after the validation. + + + + + + + + + + Initializes a new instance of the class. + + The new value. + The old value. + + + + Gets the new value. + + The new value. + + + + Gets the old value. + + The old value. + + + + Used to pass state between PrepareXXX and CompleteXXX methods during key processing. This allows for + raising the KeyValidate event to cancel any key. + + + + + Keeps the focus on the control if the validation fails + + + + + Sets NullString to the the control if the validation fails + + + + + Sets MinValue if Value is less than MinValue or MaxValue if greater thas MaxValue if the Validation fails + + + + + Extends the class to handle numeric input + and validation. + + + + The NumericTextBox is not to be used directly. + + + + + + For initialization of culture-related values. Needed when SpecialCultureValue is + not the default value. Since the base class will reset the Culture property during + ISupportInitialize.EndInit, we will have to hold these values and set them on the + correct cultureinfo / numberformatinfo. + + + + + Overloaded. Creates an object of type NumericTextBox. + + + The NumericTextBox object will be initialized with the default values + for the display and data properties. You need to set any specific + values. + + + + + + + + + + Gets or sets the maximum number of digits for the decimal portion of the number. + + + If the number requires two decimal points to accommodate the smallest + denomination and this property will have the value 2 in this case. If there + is a need to have a different value based on the locale, it will be + automatically changed if the property + is True. + + + + + Indicates whether the NumberDecimalDigits should not be serialized if the UseLocaleDefault property is set. + + + + + Resets the value to the culture specific value. + + + + + Gets or sets the decimal separator character that will be used for the display. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + Indicates whether the NumberDecimalSeparator should not be serialized if the UseLocaleDefault property is set. + + + + + Resets the value to the culture specific value. + + + + + Gets or sets the separator to be used for grouping digits. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + Indicates whether the NumberGroupSeparator should not be serialized if + the UseLocaleDefault property is set. + + + + + + Resets the value to the culture specific value. + + + + + Gets or sets the grouping of NumberDigits in the NumberTextBox. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + Indicates whether the NumberGroupPattern should not be serialized if + the UseLocaleDefault property is set. + + + + + + Resets the value to the culture specific value. + + + + + Gets or sets the pattern to use when the value is negative. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + Indicates whether the NumberNegativePattern should not be serialized if + the UseLocaleDefault property is set. + + + + + + Resets the value to the culture specific value. + + + + + Gets or sets a value indicating whether to delete selection when number is changed to negative. + + + true if [delete selection on negative]; otherwise, false. + + + + + Extends the class to handle percentage input + and validation. + + + The PercentTextBox is derived from the textbox and provides all the functionality + of a textbox and adds additional functionality of its own. + + Collecting percentage input in a consistent format requires validation + that needs to be built into the application when using the Windows Forms textbox control. + The PercentTextBox includes all this logic into its methods and properties + and makes it easy for the developer and the end user to collect and enter percentage data. + + The PercentTextBox is also closely tied to the globalization settings of the + operating system for pecentage-related properties. Please refer to the + + class for a detailed explanation of globalization and percent-related attributes. + + The PercentTextBox has full support for the Windows Forms designer and you can + just drag-and-drop and set properties on the control just as you would with the + Windows Forms textbox. + + The PercentTextBox also raises a event when + inappropriate data is entered into the control. + + All clipboard functions such as copy, paste, and cut are also supported with + special accomodations for percent-related issues. + + + Represents the class to apply the theme for control. + + + + + + + + Specifies the control is in edit mode. + + + + + The minimum value. + + + + + The maximum value. + + + + + The internal value string. + + + + + + + + Indicates whether the mode has to be automatically switched + when the control receives focus. + + + + + The initial double value set in InitializeComponent. + + + + + The double value when the control gets the focus. Used when validating. + + + + + The double value that is set through the DoubleValue property. + + + + + For initialization of culture-related values. Needed when SpecialCultureValue is + not the default value. Since the base class will reset the culture property during + ISupportInitialize.EndInit, we will have to hold these values and set them on the + correct cultureinfo / numberformatinfo. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The negative patterns. + + + + + Occurs when the property is changed. + + + + + Overloaded. Creates an object of type PercentTextBox. + + + The PercentTextBox object will be initialized with the default values + for the display and data properties. You need to set any specific + values. + + + + + Clean up any resources being used. + + + + + + Raises the System.Windows.Forms.Control.EnabledChanged event. + + An System.EventArgs that contains the event data. + + + + + + + Overrides . + + + + + + + + + + + + + + + + + + Gets / sets the percent symbol to be used in the PercentTextBox. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + Indicates whether the PercentSymbol should not be serialized if the value is the same + as the one for the current culture. + + True if the value is different from the value for the current culture. + + + + Gets or sets a value indicating whether the control should enable its Accessibility support. + + + + + Resets the value to the culture specific value. + + + + + Gets / sets the pattern to use when the value is positive. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + Indicates whether the PercentPositivePattern should not be serialized if + the UseLocaleDefault property is set. + + + + + + Resets the value to the culture specific value. + + + + + + + + + + Gets / sets the maximum number of digits for the decimal portion of the percentage. + + + If there is a need to have a different value based on the locale, it will be + automatically changed if the property + is True. + + + + + Indicates whether the PercentDecimalDigits should not be serialized if + the UseLocaleDefault property is set. + + True if the + + + + Resets the value to the culture specific value. + + + + + Gets / sets the decimal separator character that will be used for the display. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + Indicates whether the PercentDecimalSeparator should not be serialized if + the UseLocaleDefault property is set. + + + + + + Resets the value to the culture specific value. + + + + + Gets / sets the separator to be used for grouping digits. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + Indicates whether PercentGroupSeparator should not be serialized if + the UseLocaleDefault property is set. + + + + + + Resets the value to the culture specific value. + + + + + Gets / sets the grouping of PercentDigits in the PercentTextBox. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + Indicates whether the PercentGroupPattern should not be serialized if + the UseLocaleDefault property is set. + + + + + + Resets the value to the culture specific value. + + + + + Gets / sets the pattern to use when the value is negative. + + + This value is initially set from the + and can be changed based on your requirements or based on the locale. + + + + + The negative patterns. + + + + + Indicates whether the PercentNegativePattern should not be serialized if + the UseLocaleDefault property is set. + + + + + + Resets the value to the culture specific value. + + + + + Overrides the method. + + The event data. + + Saves the current DoubleValue so that it can be compared + during validation. The DoubleValueChanged and TextChanged event + will only be raised if the value is different during validation. + Also switches mode if the property is set. + + + + + Overrides the method. + + + + + + Indicates whether the PercentTextBox should allow editing in numeric mode + when it receives focus. + + + + + Formats the given text according to the current setting. + + + + + + + + + + + + + + + + + + Override this to return PercentDecimalSeparator in PercentTextBox. + + + + + + + Override this to return PercentGroupSeparator in PercentTextBox. + + + + + + + Overrides . + + The text to be parsed. + True if the value is negative; false otherwise. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets / sets the maximum value that can be set through the PercentTextBox. + + + + + + Indicates whether the MaxValue property should be serialized. + + True if the value is not equal to . + + + + Resets the value to the default. + + + + + Gets / sets the minimum value that can be set through the PercentTextBox. + + + + + + Indicates whether the MinValue property should be serialized. + + True if the value is not equal to . + + + + Resets the value to the default. + + + + + + + + + + + Validates the control. + + Indicates whether the validation error is to be raised. + + + + + + + + + Overrides the base behavior to implement support for NumberMode. In this mode, the + base behavior of formatting each key is not followed. The key is validated internally to check for + Max and Min conditions and then displayed as is without the formatting. The key will be ignored if + the supressKeyPress value is not set to False. This is set to False when a valid key press is encountered. + + + + + + + + + + + + + + + + + + + + + + + Invoked when the negative key is pressed. + + True if the key is handled; false otherwise. + + The defined behavior for this key is to toggle the sign (negativity) + of the content of the CurrencyTextBox. + + + + + + + + + + Gets / sets the double value of the control. This will be formatted and + displayed. + + + + + + + + + + + + + + + + + + Gets / sets the percent value of the control. This will be formatted and + displayed. + + + + + Wrapper property around the selected value. Use this property if you + want to be able to set the value of the control to NULL. + + + + + Occurs when the property is changed. + + + + + Raises the event. + + A that contains the event data. + + + + Overrides the Text property of . + + + This property is overriden in order to normalize the data that is set + to the Text property and format it as needed. The method + is used to format the data. + + + + + Indicates whether to serialize the Text property + if it is null or quals NullString + + + + + + Restores the CurrencyNumberDigits to the MaximumLength. + + + + + + + + + Gets or sets the NULL string to be displayed. + + + + + Returns the formatted text with the formatting. + + + For example, if the Text in the CurrencyTextBox is $45,000.00, the + FormattedText property will give $45,000.00. + + + + + Returns the clipped text without the formatting. + + + For example, if the Text in the CurrencyTextBox is $45,000.00, the + ClipText property will give 45000.00. + + + + + Raises the event. + + A that contains the event data. + + + + Overrides OnTextChanged. + + The event data. + + + + + + + + + + + + + + + + + + + + + + + + Pastes the data in the clipboard into the PercentTextBox control. + + + The data will be formatted before being pasted into the text box. + + + + + It contains the value of the property. + + + + + Helps to apply the ThemeName settings in control + + ThemeName + + + + Helps to override the ThemeName property settings + + ThemeName + + + + Helps to override the OnGotFocus events + + An System.EventArgs that contains the event data. + + + + Helps to draw text border of control + + + + + + + + values are edited as percentage values. + + + + + values are edited as double values and then displayed using percentage formatting. + + + + + Provides information about a control that can be used by an accessibility application. + + + + + PercentTextBox + + + + + Constructor + + The RibbonControlAdv instance. + + + + Bounds of the Control + + The accessible object bounds. + + + + Gets the role for the RibbonControlAdv. This is used by accessibility programs. + + + + + Gets or sets the accessible object name + + The accessible object name. + + + + Gets the description of the RibbonControlAdvAccessibility + + A string describing the RibbonControlAdvAccessibility. + + + + Retrieves the child object at the specified screen coordinates. + + The horizontal screen coordinate. + The vertical screen coordinate. + An RibbonControlAdvAccessibility that represents the child object at the given screen coordinates. + This method returns the calling object if the object itself is at the location specified. + Returns null if no object is at the tested location. + + + + Represents a class to define the style for the control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Holds instance of a class. + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + Holds instance of a class + + + + Gets the default style value for the control. + + + + + Gets or sets the value used to draw the fore color of the + control when text value is negative. + + The value is used to fill the fore color of the textbox. + + + + Gets or sets the value used to draw the fore color of the + control when text value is zero. + + The value is used to fill the fore color of the textbox. + + + + Gets or sets the value used to draw the back color of the + control when text value is read only. + + The value is used to fill the back color of the textbox. + + + + Overridden to create a product-specific identity object for the sub object. + + + StyleInfoProperty descriptor for this sub object. + + + Identity for the sub object. + + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Implements a class that provide the identity information of + using . + + + + + Maintains the PercentTextBox for create the identity. + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Represents a class that provides style identity information for nested objects of the + class. + + + + + Initializes a new instance of the class. + + + The that owns this sub-object. + + + The descriptor for this expandable + sub-object. + + + + + Gets or sets a value indicating whether the Text is changed in ValueChanged event + + + + + Gets or sets a value indicating whether the ValueChanged event was handled. + + + + + Interface used to customize the appearance and ProgressStyle of the ProgressBarAdv. + + + + + Draws the background of the ProgressBar. + + The object to draw the background. + Indicates whether the background is segmented. + + + + Draws the border of the ProgressBar. + + The object to draw the border. + The of the border. + + + + Draws the foreground of the ProgressBar. + + The object to draw background of the Progress. + The provide the control bounds. + The provides the progress rectangle. + + + + Draws the specified text string at the specified location. + + The object to draw the text. + The to draw in. + + + + Update the Renderer. + + Provides data for the Paint event. + The is helps to draw the progress. + + + + Default ProgressBarAdv Renderer + + + + + Initialize the ProgressBarAdv + + + + + Gets the ProgressBarAdv + + + + + Constructor of the Renderer class + + ProgressBarAdv + + + + Update the Renderer. + + Provides data for the Paint event. + The used to draw the progress + + + + Draws the background of the ProgressBar. + + The object to draw the background. + Indicates whether the background is segmented. + + + + Draws the foreground of the ProgressBar. + + The object to draw the progress. + The to draw the progress. + The used to draw the background of the progress + + + + Draws the border of the ProgressBar. + + The object to the border. + The of the border. + + + + Draws the specified text string at the specified location. + + The object to the text. + The of the ProgressBarAdv + + + + Gets or sets a value indicating whether the DrawWaitingCustomRender event was handled. + + + + + Gets the bounding rectangle. + + + + + Gets the Graphics used to paint. + + + + + The ProgressBarEx type will soon be replaced with the ProgressBarAdv for consistency in + control naming in our library. + Please replace all occurrences of ProgressBarEx with ProgressBarAdv in your application. + + + + + ProgressBarAdv Designer + + + + + Designer ActionList collection + + + + + Initializes a new instance of the CheckBoxAdvDesigner class + + + + + Gets a value indication the designer action + + + + + ProgressBar Coded UI Accessiblity + + + + + Variable to hold ProgressBarAdv instance + + + + + Constructor + + + + + Gets the AccessibleRole + + + + + Gets the Description + + + + + Gets the name + + + + + Gets the Value + + + + + This class represents renderer class for Office2016 color support + + + + + Gets the ProgressBarAdv back color + + + + + Gets the ProgressBarAdv fore color + + + + + Gets the ProgressBarAdv border color + + + + + Gets the ProgressBarAdv font color + + + + + Gets the ProgressBarAdv progress font color + + + + + Constructor for renderer class + + + + + + + This class represents the rendered class for Office2016Colorful theme + + + + + Gets the ProgressBarAdv back color for Office2016 colorful theme + + + + + Gets the ProgressBarAdv fore color for Office2016 colorful theme + + + + + Gets the ProgressBarAdv border color for Office2016 colorful theme + + + + + Gets the ProgressBarAdv font color for Office2016 colorful theme + + + + + Gets the ProgressBarAdv progress font color for office2016colorful theme + + + + + This class represents the rendered class for Office2016Black theme + + + + + Gets the ProgressBarAdv back color for Office2016 Black theme + + + + + Gets the ProgressBarAdv fore start color for Office2016 Black theme + + + + + Gets the ProgressBarAdv border color for Office2016 Black theme + + + + + Gets the ProgressBarAdv font color for Office2016 Black theme + + + + + Gets the ProgressBarAdv progress font color for Office2016 Black theme + + + + + This class represents the rendered class for Office2016White theme + + + + + Gets the ProgressBarAdv back color for Office2016 White theme + + + + + Gets the ProgressBarAdv fore start color for Office2016 White theme + + + + + Gets the ProgressBarAdv border color for Office2016 White theme + + + + + Gets the ProgressBarAdv font color for Office2016 White theme + + + + + Gets the ProgressBarAdv progress font color for Office2016 White theme + + + + + This class represents the rendered class for Office2016DarKGray theme + + + + + Gets the ProgressBarAdv back color for Office2016 DarkGray theme + + + + + Gets the ProgressBarAdv fore start color for Office2016 DarkGray theme + + + + + Gets the ProgressBarAdv border color for Office2016 DarkGray theme + + + + + Gets the ProgressBarAdv font color for Office2016 DarkGray theme + + + + + Gets the ProgressBarAdv progress font color for Office2016 DarkGray theme + + + + + This enum represents the ProgressBarAdv foreground style + + + + + The foreground of the ProgressBar will be drawn with a constant color. + + + + + The foreground of the ProgressBar will be drawn with a gradient brush. + + + + + The foreground of the ProgressBar will be drawn with a multiple gradient brush. + + + + + The foreground of the ProgressBar will be drawn with a vertical tube-like gradient brush. + + + + + The foreground of the ProgressBar will be drawn with an image. + + + + + The foreground of the ProgressBar will be drawn by the system. + + + + + The foreground of the ProgressBar will be drawn with a moving gradient line. + + + + + The foreground of the ProgressBar will be drawn by Metro. + + + + + The foreground of the ProgressBar will be drawn by using the CustomRender class which is inherited from "IProgressBarRenderer" interface. + + + + + This option represents the Office2016Colorful foreground style + + + + + This option represents the Office2016White foreground style + + + + + This option represents the Office2016Black foreground style + + + + + This option represents the Office2016DarkGray foreground style + + + + + This enum represents the ProgressBarAdv text styles + + + + + The text of the ProgressBar will be a percentage value. Ex: 75% + + + + + The text of the ProgressBar will be the value of the format: ProgressBar / the maximum value. Ex 75/200 + + + + + The text of the ProgressBar will be asked through the ValueChanged event. + + + + + This enum represents the ProgressBarAdv background styles + + + + + The background is drawn with an image. + + + + + The background is drawn with a gradient brush. + + + + + The background is drawn with a vertical gradient brush. + + + + + The background is drawn with a vertical tube-like gradient brush. + + + + + The background is drawn with a multiple gradient brush. + + + + + The background is drawn by the system. + + + + + This option represents the Office2016Colorful background style + + + + + This option represents the Office2016Black background style + + + + + This option represents the Office2016White background style + + + + + This option represents the Office2016DarkGray background style + + + + + The background is drawn with the Backcolor. + + + + + + + + Initializes a new instance of the class. + + The instance subclasses . + + + + + + + Invokes the default window procedure associated with this window. + + A that is associated with the current Windows message. + + + + + + + + + + + + + + + + + + + + + + Instance of TextBoxExt + + + + + Initializes a new instance of the class. + + + + + Glyph for representation. + + + + + Initializes a new instance of the class. + + The bounds. + The cursor. + The related component. + The designer. + + + + Indicates whether a mouse click at the specified point should be handled by the . + + A point to hit test. + + A if the is associated with ; otherwise, null. + + + + + Initializes the designer with the specified component. + + The to associate the designer with. This component must always be an instance of, or derive from, . + + + + Gets the design-time action lists supported by the component associated with the designer. + + + + The design-time action lists supported by the component associated with the designer. + + + + + Releases the unmanaged resources used by the and optionally releases the managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Gets the selection rules that indicate the movement capabilities of a component. + + + + A bitwise combination of values. + + + + + Returns a representing the bounds of this control. + + A value that specifies the selection state. + + A . + + + + + Raises the TextAlignChanged event. + + The TextBox control that sends the event. + The event data. + + + + Raises the TextChanged event. + + The TextBox control that sends the event. + The event data. + + + + Raises the ForeColorChanged event. + + The TextBox control that sends the event. + The event data. + + + + Raises the CharacterCasingChanged event. + + The TextBox control that sends the event. + The event data. + + + + Raises the BackColorChanged event. + + The TextBox control that sends the event. + The event data. + + + + Provides information about a control that can be used by an accessibility application. + + + + + TextBoxExt + + + + + Constructor + + The RibbonControlAdv instance. + + + + Bounds of the Control + + The accessible object bounds. + + + + Gets the role for the RibbonControlAdv. This is used by accessibility programs. + + + + + Gets or sets the accessible object name + + The accessible object name. + + + + Gets the description of the RibbonControlAdvAccessibility + + A string describing the RibbonControlAdvAccessibility. + + + + Retrieves the child object at the specified screen coordinates. + + The horizontal screen coordinate. + The vertical screen coordinate. + An RibbonControlAdvAccessibility that represents the child object at the given screen coordinates. + This method returns the calling object if the object itself is at the location specified. + Returns null if no object is at the tested location. + + + + Specifies the information required by the class to enable auto appending + in a control. + + + Take a look at for a usage example. + + + + + + Indicates whether to turn on AutoAppend. + + True to turn on auto appending; False to turn off. + + Take a look at for a usage example. + + + + + Gets / sets the Category Name to which the contents of the list belong to. + + The category name. + + Take a look at for a usage example. + + + + + Gets / sets the IList into which new entries will be appended. + + A reference to an IList instance. + + Take a look at for a usage example. + + + + + Gets / sets the desired maximum number of items in the list. + + The maximum count. + If the count exceeds the maximum count, then AutoAppend will keep + discarding the older entries. + Take a look at for a usage example. + + + + + Creates a new instance of this class and initializes it with these values. + + Indicates whether to turn on AutoAppend; False if not. + The Category to which the contents in this control belong to. + The reference to an IList which will get the new items entered by the user. + The maximum number of items in the list. + + + + The AutoAppend class provides choice-list auto-append capabilities for editable combo boxes, etc. + + + + Often editable combo boxes in your applications can benefit from reusing + previously user supplied entries in their choice-list, as in IE's address bar combo box and + in the "Find" combo box in VS.NET. + + + The AutoAppend class will easily enable this functionality in an associated combo box. + In fact, this class is more abstract in that + it can take any control and an IList reference and enable "AutoAppend" logic on + them as described below. + + + Associate your control with this class through the structure. + The structure will let you associate a control with an IList + reference and a Category string to an AutoAppend instance. + + Once you set up this association, the AutoAppend instance listens to the Validated event + thrown by the control + and inserts the new entry on top of the supplied IList or if + already in the list, moves the entry to top of the list. When the control gets disposed, + it persists these entries in the registry in a key based on the corresponding Category string. + The next time the control is created and associated, the AutoAppend instance will pick up + the persisted information corresponding to the Category and apply that information + to the IList instance. + + + Persistance is done in the registry under the HKLU key making the entries specific to the + user and global to the machine (usable across applications). Due to the previous behavior, + the very first instantiation of the above control will set the control's text and the IList + to be empty. + + Note: Also make sure your control's Dispose() gets called before the ApplicationExit event + thrown by the Application object. Otherwise, the control's state will not be persisted. This + would normally be the case, unless the control gets "orphaned" (detached from the parent control) and the + Dispose method never gets called until it is garbage collected. + + You can make any number of associations with one AutoAppend instance. + + + This is how you would associate a combo box with an instance of the AutoAppend class: + + this.autoAppend = new AutoAppend(); + this.autoAppend.SetAutoAppend(this.comboBox1, new AutoAppendInfo(true, "HttpAddress", this.comboBox1.Items, 30)); + // To disassociate call this: + this.autoAppend.SetAutoAppend(this.comboBox1, new AutoAppendInfo(false, String.Empty, null, 30)); + + + + + + Creates a new instance of the AutoAppend class. + + + + + This member overrides Object.Finalize. + + + + + Releases all setup associations. + + + This will also persist the exisiting information before releasing the associations. + + + + + Override this to release the unmanaged resources used by the control and optionally releases the managed resources. + + True to release both managed and unmanaged resources; False to release only unmanaged resources. + + + + Returns the AutoAppendInfo associated with a control. + + The control whose AutoAppend info is required. + The corresponding AutoAppendInfo value. If this control is not associated + yet, then an AutoAppendInfo with its AutoAppend value set to False will be returned. + + + + Associates a control with this instance by providing its AutoAppendInfo. + + The control in which to AutoAppend. + The AutoAppendInfo. + + Calling this will enable behavior in the control. Take a look at the AutoAppend + class reference for detailed information on this behavior. + To disassociate a control from the AutoAppend instance, call this method with the + AutoAppendInfo's AutoAppend value set to False. + + + + + Forces an entry into the control's AutoAppend list. + + The control whose AutoAppend list is to be updated. + The value that is to be appended to the list. + + The AutoAppend instance automatically inserts entries into the list when the user + enters a new value and leaves the control (when Validated will be fired). + However, you might want new entries to be added when, for example, the user hits + the Enter key. You do so by calling this method with the new value which will + insert the new value into the list. + + + + + An advanced combo box control. + + + + This advanced combo box control provides a lot of improvements over the standard + control. The improvements are as follows: + + + Plug in any derived class as the list for the list portion of the combo box + using the property. + + + Provides a mode for regular, flat or themed drawing. + + + Written using native .NET controls, this control lets you customize everything in the combo box from the textbox to the drop-down window. + + + + + This control requires the plugged in ListControl to implement the Items property returning + a valid instance. The ListControl can + optionally implement an IndexFromPoint method that will take a single argument of type and + a TopIndex property of type int. The semantics of these above properties and methods are similar to + that of a 's implementation. + + Implementing IndexFromPoint and TopIndex will enable QuickSelection capability for the combo box, wherein + the user can click on the drop-down button and start selecting items in the list, all this + without releasing the mouse. + + + + + + Indicating whether the control uses AutoComplete. + + + + + Creates a new instance of the ComboBoxBase class. + + + + Initializing this ComboBoxBase also requires you to set the + property of this combo box. + + + + + + Gets or sets the that will be used in the drop-down portion. + + A derived instance. + + + Take a look at the class description for more information + on requirements and usage of this list control. + + + + + + This will be used in the drop-down portion. + + + + + Indicates whether the selection in the list control should be updated + with the new text entered by the user when the control loses focus. + + This property is typically used only when the list mode is set to editable (DropDown). + + + + Gets a value indicating whether the control uses AutoComplete. + + + + + Occurs when the user clicks in the list box in the drop-down to let you + cancel the subsequent drop-down close. + + + + + Raises the DropDownCloseOnClick event. + + A that contains the event data. + Raising an event invokes the event handler + through a delegate. For more information, see Raising + an Event. The OnDropDownCloseOnClick method also + allows derived classes to handle the event without + attaching a delegate. This is the preferred technique + for handling the event in a derived class. + Note to Inheritors: When overriding OnDropDownCloseOnClick + in a derived class, be sure to call the base class's + OnDropDownCloseOnClick method so that registered + delegates receive the event. + + + + + Occurs when the selected Index of list is about to be changed. + Can be canceled to avoid selection of the specific item. + + + + + Risen by method. + + + + + Fires event. + + + + + Returns the text representation of the specified item in PopUpControl. + + The index. + + + + Indicate whether ListControl contains item with such index. + + The index. + True - if there is such item, otherwise - false. + + + + Called to find a matching item in the attached given + the prefix of the item. + + The prefix string. + Indicates whether to change the selection in the list when a match occurs. + The index within each list item-string, where the search begins. + Indicates whether to ignore case. + The index of the matching item; -1 otherwise. + + + + Returns the interface representing the item's + collection of the attached . + + An IList interface. + + The base class version looks for the "Items" property in the attached ListControl. + + + + + Moves the current selection in the attached . + + Indicates whether to move up. + + + + Raises the Validating event. + + + + + Called to update selection before validate. + + + This is useful when you enable auto completion + in the text area and force the list box's SelectedValue to be updated to the + latest text value in this control's Validated event. + + + + + Called before the popup gets dropped down. + + + + + Sets the popup text. + + The value. + Compares the new PopUpText and resets if a match is not found. + + + + Handles the PopupCloseType of PopUpContainer based on SelectedIndex. + + + + + Indicates whether the attached ListControl has an "IndexFromPoint" + method. + + True if such a method is available; False otherwise. + + This control relies on the attached ListControl providing this method + to support quick-selection mode. This is the mode where the user can click on the + drop-down arrow and start selecting in the drop-down list even before mouse up. + + + + + Returns the index of the item at the specified point. + + A in screen coordinates. + The zero based index; -1 if the point is not over an item. + + + + Called when a new gets attached + to this ComboBoxBase using the property. + + + When you override this method, make sure to call the base class for proper initialization. + + + + + Called when an attached is being + detached from this combo. + + Indicates whether this method is called from Dispose. + + + + Called when the user clicks on the associated list box. + + The MouseEventArgs from the list box's MouseUp event. + + + + Processes the mouse move over the PopupControl. + + + + + Processes mouse move over the list. + + The control source of the MouseMove event. + The event args of the MouseMove event. + + This method moves the selection of the attached in some + cases when the mouse moves over it and also to change the Top Index of the list control appropriately + when QuickSelection is on. + + + + + Indicates whether the supplied text is a valid entry in the attached . + + The text to validate. + True if valid; False otherwise. + + + + Correct popup control location. + + + + + + + Provides information about a control that can be used by an accessibility application. + + + + + ComboBoxBase + + + + + Constructor + + The RibbonControlAdv instance. + + + + Bounds of the Control + + The accessible object bounds. + + + + Gets the role for the RibbonControlAdv. This is used by accessibility programs. + + + + + Gets or sets the accessible object name + + The accessible object name. + + + + Gets the description of the RibbonControlAdvAccessibility + + A string describing the RibbonControlAdvAccessibility. + + + + Retrieves the child object at the specified screen coordinates. + + The horizontal screen coordinate. + The vertical screen coordinate. + An RibbonControlAdvAccessibility that represents the child object at the given screen coordinates. + This method returns the calling object if the object itself is at the location specified. + Returns null if no object is at the tested location. + + + + Handles a cancelable mouse-click event. + + + + + Provides data for a cancelable mouse click event. + + + + + Creates a new instance of the MouseClickCancelEventArgs. + + The point in screen coordinates where the click occurred. + True to cancel the event; False otherwise. + + + + Returns the point in screen coordinates where the click occurred. + + + + + + + + + + ComboDropDown Designer + + + + + Designer ActionList collection + + + + + Initializes a new instance of the CheckBoxAdvDesigner class + + + + + Gets a value indication the designer action + + + + + The ComboBoxExt type will soon be replaced with the ComboBoxBase for consistency in + control naming in our library. + Please replace all occurrences of ComboBoxExt with ComboBoxBase in your application. + + + + + CheckBoxAdvActionList class. + + + + + Initializes a new instance of the CheckBoxAdvActionList class. + + Represents component + + + + Overrridden InitializeActionList. + + + + + Gets or sets Name. + + + + + Gets or sets Readonly. + + + + + Gets or sets Readonly. + + + + + Gets or sets the Text + + + + + Gets or sets the visual style. + + The style. + + + + Gets or sets the Office2007 color scheme. + + The Office2007 color scheme. + + + + Gets or sets the Office2010 color scheme. + + The Office2010 color scheme. + + + + Gets or sets the Border style. + + The style. + + + + Gets or sets the Dropdown style. + + The style. + + + + Specifies the appearance of the control. + + + + This enumeration is used by the property. + + + Use and + to determine + if Themes are on during run-time. + + + + + + The control and the button appear flat. + + + + + The control and the button appear three-dimensional. + + + + + The appearance is determined by the user's operating system. + + + If XP, then themes will be used to draw this control. For other operating systems, + the behavior will be that of the style. This + setting will also use XP Themes to draw the combo when an XP Theme is loaded in the OS. + + + + + This class used for additional handling messages, that are sent + to DropDown's child controls. + + + + + ComboDropDown control, listen to messages for. + + + + + Default Constructor. + + + + + + Fired when IME messages are received + + + + + Default windows message for gesture support. + + + + + Default windows message for Mouse captured. + + + + + Default size of the control + + + + + User Size changed + + + + + Default font style of the control + + + + + Font which stored after changed in design + + + + + Indicates whether to perform case sensitive search. + + + + + The width of the drop-down button. + + + + + Collects the boolean value if Control is selected by Touch or Mouse control. + + + + + Indicates whether theme BackColor is painted or ignored and BackColor of control is painted. + + + + + Cached BackColor of ComboBox. + + + + + Cached BackColor of ComboBox. + + + + + Indicates whether to suppress the DropDown Event + + + + + Used to draw office 2007 scroller. + + + + + Used to draw office 2007 backcolors in ActiveMode when DropDownList style set. + + + + + Used to draw metro backcolors in ActiveMode when DropDownList style set. + + + + + + Office 2007 color scheme. + + + + + Office 2010 color scheme. + + + + + Metro color scheme. + + + + + Default size of the control + + + Variable to detect whether the event has been hooked. + + + + + Variable to detect whether the click event has been hooked. + + + + + Creates a new instance of the ComboDropDown class. + + + + + To show/display the touch keyboard + + + + + + To hide the touch keyboad. + + + + + Overridden. See . + + + + + + Gets a value indicating whether this instance is initializing. + + + + + Called once to create a + that will host the drop-down list. + + A new instance of a . + + Override this method to provide a custom implementation of the PopupControlContainer. + + + + + + Called to initialize the drop-down container. + + + + This method is called once to initialize the drop-down container that hosts the + drop-down list. Use the property to get a reference to + the from inside an override of this method. + + + Make sure to call the base class when you override this method for default initialization. + + + + + + + Called once to create a + for the editable text portion of the combo. + + A new instance of a . + + Override this method to provide a custom implementation of a text box. + + + + + + Called once to create a + for the drop-down button portion of the combo. + + A new instance of a . + + Override this method to provide a custom implementation of a DropDownButton. + + + + + + Called to initialize the used in the drop-down button portion of the combo. + + + + This method is called once to initialize the DropDownButton used to draw the + drop-down portion of the combo. + + + Make sure to call the base class when you override this method for default initialization. + + + + + + + Called to initialize the used in the editable text portion. + + + + This method is called once to initialize the text box used to draw the + editable portion of the combo. Use the property to get a reference to + the text box from inside a override of this method. + + + Make sure to call the base class when you override this method for default initialization. + + + + + + + Releases all resources used by the control. + + + + + + Indicates whether to suppress the DropDown Event + + + + + Gets or sets a value indicating whether [use office2007 colors in active mode]. + + + true if [use office2007 colors in active mode]; otherwise, false. + + + + + Gets or sets a value indicating whether [use metro colors in active mode]. + + + true if [use metro colors in active mode]; otherwise, false. + + + + + Gets or sets the value for the control. + + + + + + Indicates whether the search in autocomplete is case-sensitive. + + + + + Specifies whether the control is focused. (overridden property) + + + + + Gets or sets a value indicating whether control's elements are aligned to + support locales using right-to-left fonts. + + + + + This property defines the autocomplete behavior in DropDownList mode. + + This property is used when the DropDownStyle is set to DropDownList only. + + + + The that will be used in the drop-down portion. + + A derived instance. + + + + Updates the attached 's parent-child relationship. + + + If in ComboBoxStyle.Simple mode, the base class implementation + parents the Popup Control to the combo itself. Otherwise, it parents the + to the Popup Control. + + + + + Gets or sets the back color. (overridden property) + + + + + Indicates whether users should be forced to enter numbers. + + True to force numbers; False otherwise. + + + + Indicates whether the text in the edit portion can be changed. + + If True, the edit portion is not editable by the user; False otherwise. + + + + Specifies the ComboBoxBase control modifies the case of characters as they are typed. + + + One of the enumeration values that specifies whether the ComboBoxBase control modifies the case of characters. The default is CharacterCasing.Normal. + + + + + Indicates whether the control will ignore the theme`s background color and draw the BackColor instead. + + + + + Gets or sets the alignment of text in this control. + + + One of the enumeration + values that specifies how text is aligned in the control. + The default is HorizontalAlignment.Left. + + + You can use this property to align the text within a ComboBoxBase + to match the layout of text on your form. For example, if your controls + are all located on the right side of the form, you can set the TextAlign + property to HorizontalAlignment.Right and the text will be aligned + along the right side of the control instead of the default left alignment. + + + + + Gets or sets the ContextMenu. (overridden property) + + + + + Gets or sets the ForeColor. (overridden property) + + + + + Resets the property to its default value. + + + + + + + + + Gets or sets the 3D border style for the control. + + + This property is used only when BorderStyle is Fixed3D. + + + + + Gets or sets the border sides for which you want the 3D border style applied. + + + This property is used only when BorderStyle is Fixed3D. + + + + + Gets or sets the flat style appearance of the combo box control. + + + One of the values. The default value is Standard. + + + + When you specify and the application is run + in Windows XP, themes will be used to draw this control. + + + Use and + to determine + if themes are on during run-time. + + + + + + Gets or sets an advanced appearance and behavior for this control. + + One of the values. + Default is VisualStyle.Default. + + When a non-default style is specified here, it will override the + other settings of the control such as and . + The is used to draw the borders for the office styles, when + the control is not active. + + The Office2003 style behaves the same as OfficeXP in non-XP systems. + + + + + + + + + + + Indicates whether the combo box is displaying its drop-down portion. + + True if the drop-down portion is displayed; False otherwise. The default is False. + + + + Returns the used to host the drop-down list. + + + + + + + + Returns the used to draw the editable text portion of the combo. + + + + + Returns the used to draw the drop-down portion of the combo. + + + + + Gets or sets the height of the drop-down button. + + + + + Gets or sets the height of the edit portion. + + + + + Indicates whether the Height property of the control can be changed. + + True to prevent height change; False otherwise . + + Note that this property will be frequently set and reset within the control layout. + You can use this temporarily to force a particular height on the control. + + + + + Gets or sets the text associated with this control. + + + When in DropDownList mode, setting this property will also validate the + new value against the attached popup control. + + + + + Gets or sets the maximum number of characters allowed in the editable portion of a combo box. + + The maximum number of characters the user can enter. + Default value is 32767. + + + + Gets or sets the drop-down's width. + + + + The value provided here will be used to determine the width of the drop-down portion. + If you do not set a value explicitly, the width of this control will be used as the preferred width. + + To reset your settings on this property, call the method. + + + + + Resets the property's value to its default. + + + + + Indicates whether the property's value is the default. + + True if the value is not the default; false otherwise. + + + + Gets or sets the style of the combo box. + + + One of the values. + The default is . + + + The DropDownStyle property controls the interface that is presented + to the user. You can enter a value that allows for a simple drop-down list box, + where the list always displays a drop-down list box, where the text portion is + not editable and you must select an arrow to view the drop-down, + or the default drop-down list box where the text portion is editable and the + user must press the arrow key to view the list. + + + + + Gets or sets the color with which the flat border should be drawn. + + + A color value. Default is SystemColors.ControlDark. + + + This is also the color used to draw the border when the + property is set to OfficeXP or Office2003. + + + + + Specifies the BackgroundImage.(overridden property) + + + + + Gets or sets background image layout. + + + + + Gets or sets a value indicating if quick selection on mouse move is on. + + + + + Gets or sets a value indicating to show the Gray BackColor on ReadOnly is set. + + + + + Gets or sets a value to have effect of BackColor + + + + + Get or Set of Skin Manager Interface + + + + + Gets or sets office 2007 color theme. + + + + + Gets or sets office 2010 color theme. + + + + + + + + Metrocolor. + + + + + Gets or sets the metrocolor. + + + + + Serialize metrocolor. + + + + + Resets the metrocolor. + + + + + Gets color table for Office2007 visual style. + + + + + Gets color table for Office2010 visual style. + + + + + Update the renderer for Office2016 style. + + + + + Gets or sets a value indicating whether selection changing can be done using mouse wheel rotation. + + + true if seelction can be changed using mouse wheel; otherwise, false. + + + Instead of handling mouse wheel event and handling it, user can set this bool property as per the needs. + This property is used to work when the dropdown is not shown and changing selection through mouse wheel. + + + + + + + + + + + + + + Updates the property based on the PopupControl's selected value. + + Indicates whether the event should be fired if the text is changed. + True if the event was fired; False otherwise. + You normally do not have to call this method. However when you + programmatically update the SelectedValue of a plug in the list control, + you might have to call this method to update the combo's text based on that new value. + + + + Indicates whether another change was made except text changing + in control. + + True if changes were detected; false otherwise. + + + + Fired when BorderSides are changed. + + + + + Occurs when border's 3D style is changed. + + + + + Raises the BorderSidesChanged event. + + An EventArgs that contains the event data. + Raising an event invokes the event handler + through a delegate. For more information, see Raising + an Event. The OnBorderSidesChanged method also + allows derived classes to handle the event without + attaching a delegate. This is the preferred technique + for handling the event in a derived class. + Note to Inheritors: When overriding OmBorderSidesChanged + in a derived class, be sure to call the base class's + OnBorderSidesChanged method so that registered + delegates receive the event. + + + + + Raises the Border3DStyleChanged event. + + An EventArgs that contains the event data. + Raising an event invokes the event handler + through a delegate. For more information, see Raising + an Event. The OnBorder3DStyleChanged method also + allows derived classes to handle the event without + attaching a delegate. This is the preferred technique + for handling the event in a derived class. + Note to Inheritors: When overriding OnBorder3DStyleChanged + in a derived class, be sure to call the base class's + OnBorder3DStyleChanged method so that registered + delegates receive the event. + + + + + Occurs before the drop-down portion is shown. + + + + + Raises the Drop-Down event. + + An EventArgs that contains the event data. + Raising an event invokes the event handler + through a delegate. For more information, see Raising + an Event. The OnDropDown method also + allows derived classes to handle the event without + attaching a delegate. This is the preferred technique + for handling the event in a derived class. + Note to Inheritors: When overriding OnDropDown + in a derived class, be sure to call the base class's + OnDropDown method so that registered + delegates receive the event. + + + + + Occurs when the user selects a new text for the combo in one of many possible ways. + + + This event will be fired for the following cases: + + + + When the user selects a new item in the list box by clicking or pressing Enter. + + + + + When the user Tabs out of the combo after changing the current text and Validation was successful. + + + + + + + + Raises the SelectionChangeCommitted event. + + An EventArgs that contains the event data. + Raising an event invokes the event handler + through a delegate. For more information, see Raising + an Event. The OnSelectionChangeCommitted method also + allows derived classes to handle the event without + attaching a delegate. This is the preferred technique + for handling the event in a derived class. + Note to Inheritors: When overriding OnSelectionChangeCommitted + in a derived class, be sure to call the base class's + OnSelectionChangeCommitted method so that registered + delegates receive the event. + + + + + Raises the event. + + + The event will be fired usually when + the user commits selection change. You could use this method to raise an event manually for a + custom scenario. + + + + + Occurs when the of the combo changes. + + + + + Raises the DropDownStyleChanged event. + + An EventArgs that contains the event data. + Raising an event invokes the event handler + through a delegate. For more information, see "Raising + an Event". The DropDownStyleChanged method also + allows derived classes to handle the event without + attaching a delegate. This is the preferred technique + for handling the event in a derived class. + Note to Inheritors: When overriding OnDropDownStyleChanged + in a derived class, be sure to call the base class's + OnDropDownStyleChanged method so that registered + delegates receive the event. + + + + + Occurs when the property of the combo changes. + + + + + Raises the ReadOnlyChanged event. + + An EventArgs that contains the event data. + Raising an event invokes the event handler + through a delegate. For more information, see "Raising + an Event". The ReadOnlyChanged method also + allows derived classes to handle the event without + attaching a delegate. This is the preferred technique + for handling the event in a derived class. + Note to Inheritors: When overriding OnReadOnlyChanged + in a derived class, be sure to call the base class's + OnReadOnlyChanged method so that registered + delegates receive the event. + + + + + + + + Performs auto complete in the text area. + + The arguments of the KeyPress event. + + + + Check whether the ComboBox is ComboDropDown or ComboBoxAdv + + + + + Check whether the ComboBox is ComboDropDown or ComboBoxAdv + + + + + Event will be triggered when TextBox lost its Focus + + + + + + + Event will be triggered while clicking on the TextBox control of the ComboBox. + + + + + + + + Verifies whether new text is allowed to be entered from native message. + + The message. + True if the message is handled. + + + + + + + + + + + + + + + + Forwards the key message to the attached . + + The message id. + The first message parameter. + The second message parameter. + + + + Called when the popup is closed. + + + + + Updates the attached popup control based on the current property. + + + Call this method to update the popup list box, for example, with the latest text + value that the user might have entered. This is useful when you enable auto completion + in the text area and force the list box's SelectedValue to be updated to the + latest text value in this control's Validated event. + + + + + Called before the popup gets dropped down. + + + + + Shows the drop-down. + + + + + Hides the drop-down list box. + + + + + + + + + + + + Forces laying out of the combo elements within the next Paint Message handler. + + True to force; False to prevent layout. + + + + Indicates whether the layout method needs to be called to layout the combo + elements. + + + Internal method. You will not have to call this property explicitly. + + + + + Determines the heights of certain portions of this control. + + A object. + A reference variable through which to return the height for the text area. + + + Make sure to call the base class when you override this method. + + + This method expects you to return a height for the text area through the reference variable, + set the height of this control (if not in ComboBoxStyle.Simple mode) and the height + of the drop-down button (). + + + + + + Updates the internal textbox's bounds and visibility based on the . + + The height of the text area. + + + + Returns the width for the combo box drop-down button. + + The button width. + + + + Returns the width for the combo box drop-down button when office style is on. + + The button width. + + + + Updates the bounds of the drop-down button bounds. + + + Sets the bounds based on the value returned by the + method. + + + + + Updates the attached 's bounds. + + + The base class updates the PopupControl's bounds and visibility based on the + settings. + + + + + Overloaded. The bounds for the control that is associated with this popup when in DropDownStyle.Simple mode. + + The height of the combo control. + The bounds for the embedded control. + + + + The bounds for the control that is associated with this popup when in DropDownStyle.Simple mode. + + The bounds for the embedded control. + + + + + + + Called from the Paint event handler to draw the text portion. + + The from the Paint event. + + This method calls the method + to draw the edit portion only when in ComboBoxStyle.DropDownList mode + or when in design-mode. + + + + + Called from to draw the text area when in ComboBoxStyle.DropDownList mode. + + The from the Paint event. + The background color for the highlight. + The text color for the highlight. + Indicates whether to draw a focus rectangle. + + + + Called from the Paint event handler to draw the drop-down button. + + The from the Paint event. + + + + Called from the Paint event handler to draw the edit portion's border and background. + + The from the Paint event. + + This method calls the method with the appropriate + dimension to draw the border around the text portion. + + + + + Draws the border and background of the control. + + The context. + The within which to draw. + + + This method is used to draw the border around the text area (when called from + method) and around the list box area (when in + ComboBoxStyle.Simple mode and called from the method). + + This method uses themes to draw if necessary or calls and + to draw the background and border. + + + + + Draws the unthemed border of this control. + + The context. + The within which to draw. + + Called by to draw the border when + not in themes mode. + + + + + Gets or sets the BorderColor for metro style + + + + + Serialize MetroBorderColor. + + + + + Reset the MetroBorderColor. + + + + + Draws the unthemed background of this control. + + The context. + The within which to draw. + + Called by to draw the background when + not in themes mode. + + + + + Called from the Paint event handler to draw the list portion. + + The from the Paint event. + + This method draws the list portion when in ComboBoxStyle.Simple mode. + + + + + Refreshes the BackColor of the control after changing 'IgnoreThemeBackground' property. + + Value of 'IgnoreThemeBackground' property. + + + + Creates new instance of the scrollersFrame. + + + + + Attaches scrollersFrame to the PopupControl. + + + + + Detaches scrollersFrame from the PopupControl. + + + + + Inits the scrollers frame. + + + + + + + + Processes mouse moves on the combo-box and textbox area. + + The event args of the MouseMove event. + Indicates whether this was called due to mouse move in the text area or combo. + + + + Gets the Isactive state + + + + + + + + + + + + + + Sends the specified message to the default windows procedure. + + + + + + + + + Moves the current selection in the attached . + + Indicates whether to move up. + + + + Fired when the ThemesEnabled property changes. + + + + + + + + Called while form is deactivated + + + + + + + Raises the ThemeChanged event. + + An EventArgs that contains the event data. + + The OnThemeChanged method also allows derived classes to handle the event + without attaching a delegate. This is the preferred technique for + handling the event in a derived class. + Note to Inheritors: When overriding OnThemeChanged in a derived + class, be sure to call the base class's OnThemeChanged method so that + registered delegates receive the event. + + + + + Indicates whether themes are enabled for this control. + + + + + Gets/Sets Control size before touch enabled + + + + + Gets or sets value to enable or disable the Touchmode to the controls. + + Scale factor will be updated automatically if scalefactor is equal to 1 + + + + + + + Scale the control based on the scale factor passed in the argument. + + value to scale the factor based upon. + + + + Font chnaged + + + + + + + + + Fired when an IMe message is received. + + Event sender. + Event data. + + + + Provides information about a control that can be used by an accessibility application. + + + + + ComboDropDown + + + + + Constructor + + The RibbonControlAdv instance. + + + + Bounds of the Control + + The accessible object bounds. + + + + Gets the role for the RibbonControlAdv. This is used by accessibility programs. + + + + + Gets or sets the accessible object name + + The accessible object name. + + + + Gets the description of the RibbonControlAdvAccessibility + + A string describing the RibbonControlAdvAccessibility. + + + + Retrieves the child object at the specified screen coordinates. + + The horizontal screen coordinate. + The vertical screen coordinate. + An RibbonControlAdvAccessibility that represents the child object at the given screen coordinates. + This method returns the calling object if the object itself is at the location specified. + Returns null if no object is at the tested location. + + + + Class that represents the drop-down portion of a . + + + + + Creates an instance of the DropDownButton class. + + The control that is using this class to draw the drop-down portion. + + + + Gets/Sets Metro Arrow Color + + + + + Reset MetroArrowColor + + + + + To serialize MetroArrowColor + + + + + + Gets the touchmode value. + + + + + Fired when the user performs a mouse down in the drop-down area. + + + + + Raises the MouseDown event. + + An EventArgs that contains the event data. + Raising an event invokes the event handler + through a delegate. For more information, see Raising + an Event. The MouseDown method also + allows derived classes to handle the event without + attaching a delegate. This is the preferred technique + for handling the event in a derived class. + Note to Inheritors: When overriding OnMouseDown + in a derived class, be sure to call the base class's + OnMouseDown method so that registered + delegates receive the event. + + + + + Indicates whether themes is currently enabled for this control. + + This property doesn't check whether themes are currently enabled in the OS. + + + + Invalidates the specified portion in the underlying control. + + The area to invalidate. + + + + Indicates whether owner control is active. + + + true if this instance is control active; otherwise, false. + + + + + Call this method from the control's OnPaint method. + + The Graphics context using which to draw the button. + + + + + + + + + + + + Cancels any mouse tracking. + + + + + Call this method from the control's OnMouseMove to inform this class of mouse move events. + + The MouseEventArsg in the OnMouseMove method. + Indicates whether the full control bounds should be considered + part of the button. Useful in a combo in list mode. + + + + Call this method from the control's OnMouseLeave to inform this class of mouse leave events. + + The EventArsg in the OnMouseLeave method. + + + + Call this method from the control's OnMouseDown to inform this class of mouse down events. + + The MouseEventArsg in the OnMouseDown method. + Indicates whether the full control bounds should be considered + part of the button. Useful in a combo in list mode. + + + + Call this method from the control's OnMouseUp to inform this class of mouse up events. + + The MouseEventArsg in the OnMouseUp method. + + + + Set the bounds for the dropdown button. You typically should do this from the control's Layout event / method. + + + + + Indicates whether the button is active. Will be referred to when drawn hot with office style. + + + + + Indicates whether the drop-down is showing. Will be referred to when drawn hot with office style. + + + + + Indicates whether the button should be drawn hot. + + + + + Gets or sets the ComboFlatStyle with which to draw. + + + + + Gets or sets the VisualStyle with which to draw. + + + + + Gets color table for Office2007 visual style. + + + + + Gets color table for Office2007 visual style. + + + + + Gets color table for Metro visual style. + + + + + Indicates whether the buttons should be drawn enabled. + + + + + Indicates whether the button is currently pushed. + + + + + Gets or sets a value indicating whether invalidating of owner control is suspended. + + + + + The Class that represents the TextBox placed inside the ComboBox + + + + + Constructor + + + + + Gets or sets a value indicating whether the height of the TextBoxExt automatically + adjusts when the font assigned to the control is changed. + + true if the height of the control automatically adjusts when the font is changed; otherwise, false. The default is true. + + + + Provides information about a control that can be used by an accessibility application. + + + + + ComboText + + + + + Constructor + + The RibbonControlAdv instance. + + + + Bounds of the Control + + The accessible object bounds. + + + + Gets the role for the RibbonControlAdv. This is used by accessibility programs. + + + + + Gets or sets the accessible object name + + The accessible object name. + + + + Gets the description of the RibbonControlAdvAccessibility + + A string describing the RibbonControlAdvAccessibility. + + + + Retrieves the child object at the specified screen coordinates. + + The horizontal screen coordinate. + The vertical screen coordinate. + An RibbonControlAdvAccessibility that represents the child object at the given screen coordinates. + This method returns the calling object if the object itself is at the location specified. + Returns null if no object is at the tested location. + + + + ComboDropDown Designer + + + + + Designer ActionList collection + + + + + Initializes a new instance of the CheckBoxAdvDesigner class + + + + + Gets a value indication the designer action + + + + + CheckBoxAdvActionList class. + + + + + Initializes a new instance of the CheckBoxAdvActionList class. + + Represents component + + + + Overrridden InitializeActionList. + + + + + Gets or sets Name. + + + + + Gets or sets Readonly. + + + + + Gets or sets Readonly. + + + + + Gets or sets the Text + + + + + Gets or sets the visual style. + + The style. + + + + Gets or sets the Office2007 color scheme. + + The Office2007 color scheme. + + + + Gets or sets the Office2010 color scheme. + + The Office2010 color scheme. + + + + Gets or sets the Border style. + + The style. + + + + Gets or sets the Dropdown style. + + The style. + + + + Summary description for ComboDropDownWeakContainer. + + + + + Provides data for the event. + + + + + The last selected index for the edited row in the list. + + + + + Creates a new instance of the ListBoxTextChangingEventArgs class. + + The new text after the change. + Last selected index. + + + + Creates a new instance of the ListBoxTextChangingEventArgs class. + + The new text after the change. + + + + Returns the new text for the edited row in the list. + + + + + Gets the last selected index for the edited row in the list. + + + + + Handles the event. + + The source of the event. + A that contains the event data. + + + + A that provides you an editable + with a and + on the current row. + + + + During design-time (and in code) you can access the list box, text box and button components of this + control using the , and + properties. You can add certain items to the list and set some properties on the textbox and button. + + + The event is thrown when the user clicks the button + and event is thrown when the user completes editing an item. + + + + + + Holds ScrollerFrame for ListBox + + + + + Holds MetroColorTable for ScrollerFrame + + + + + The used by the control. + + + + + The used by the control. + + + + + The used by the control. + + + + + Index of the item, that is being edited. + + + + + + Required designer variable. + + + + + Default size of the control + + + + + Default height of the ListBoxItem + + + + + Default height of the ListBoxItem + + + + + Fired when the user clicks on the button. + + + + + Fired when the user completes editing a row. + + + + + Raised before a list item is edited. + + + + + Raised when a list item is to be drawn. + + + + + Creates a new instance of the control. + + + + + Gets/Sets Control size before touch enabled + + + + + Gets or sets value to enable or disable the Touchmode to the controls. + + Scale factor will be updated automatically if scalefactor is equal to 1 + + + + + + + Scale the control based on the scale factor passed in the argument. + + value to scale the factor based upon. + + + + + + + + Returns the associated with this control. + + + To access the list box to add items to it. + + + + + Gets or sets a value indicating whether the control should enable its Accessibility support. + + + + + Returns the associated with this control. + + + Represents the textbox used in the editable current row. + + + + + Returns the associated with this control. + + + Represents the button drawn at the right of the current row. + + + + + Indicates whether you want the button to be shown to the right while editing. + + True if button should be shown; False otherwise. Default is True. + + + + Gets the theme colors for the Visual style. + + + + + Holds the Visual Style of EditableList + + + + + Gets or sets the Visual Style for the EditableList + + + + + Represents the Variable assiged with the default value. + + + + + Gets or Sets the colorschemes for the EditableList. + + + + + Represents the property to set the Style. + + + + + Reset the Style + + + + + + Serializes the Style + + + + + + Represents the Variable with Bool Contraint. + + + + + Gets or Sets whether to draw focus when item is selected. + + + + + Indicates whether the current row is being edited. + + + True to indicate its being edited; False otherwise. + + + + + Gets or sets the list box text alignment. + + + + + Gets or sets an advanced appearance for the EditableList. + + + + + Indicates, whether property value should be serialized. + + + + + Resets the property to the default value. + + + + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Called just before a row goes into editing mode. + + + + + Called just after a row comes out of editing mode. + + + + + Raises the ItemChanging event. + + A that contains the event data. + Raising an event invokes the event handler + through a delegate. For more information, see Raising + an Event. The OnItemChanging method also + allows derived classes to handle the event without + attaching a delegate. This is the preferred technique + for handling the event in a derived class. + Note to Inheritors: When overriding OnItemChanging + in a derived class, be sure to call the base class's + OnItemChanging method so that registered + delegates receive the event. + + + + + Raises the BeforeListItemEdit event. + + An that contains the event data. + Raising an event invokes the event handler + through a delegate. For more information, see Raising + an Event. The OnBeforeListItemEdit method also + allows derived classes to handle the event without + attaching a delegate. This is the preferred technique + for handling the event in a derived class. + Note to Inheritors: When overriding OnBeforeListItemEdit + in a derived class, be sure to call the base class's + OnBeforeListItemEdit method so that registered + delegates receive the event. + + + + + Raises the ButtonClick event. + + An EventArgs that contains the event data. + Raising an event invokes the event handler + through a delegate. For more information, see Raising + an Event. The OnButtonClick method also + allows derived classes to handle the event without + attaching a delegate. This is the preferred technique + for handling the event in a derived class. + Note to Inheritors: When overriding OnButtonClick + in a derived class, be sure to call the base class's + OnButtonClick method so that registered + delegates receive the event. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + Occurs when theme name of the has changed. + + + + + Gets or sets the theme name of the EditableList control. + + + + + Gets or sets a value indicating whether a theme style + has been applied to the control. + + The default value is true. + + + + Gets or sets a value indicating whether control elements styles can be overridden by theme style settings. + + Default value is false. + + By default, the control's element styles will not be overridden by theme style settings if the style is set in sample level. + If this property is enabled, element style will be overridden by theme style settings event if it is set in sample level. + This property should be enabled or disabled before calling the ThemeName property of the control. + + + + + Gets or sets the BaseTheme name of the theme + + + + + Gets a value indicating whether the visual style based theme is applied to the control and + also indicates whether the theme files are referred from external assemblies or not. + + Return true, if the visual style based theme is applied to the control. Otherwise returns false. + + + + Gets the name of the control. + + + + + Gets the active theme name of the CheckBoxAdv control. + + Returns the active theme name. + + + + Gets or sets the value used to customize the appearance of the . + + + This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control. + + + + + Raises the event when themename changed. + + The sender value. + A contains the event data. + + + + Updates the Style renderers of EditableList Control based on applied Theme. + + + + + Draws the ListBox and Button colors + + + + + + Draws the Background Color using renderer file + + + + + + + Draws the text. + + The instance containing the event data. + + + + Provides information about a control that can be used by an accessibility application. + + + + + EditableList + + + + + Constructor + + The RibbonControlAdv instance. + + + + Bounds of the Control + + The accessible object bounds. + + + + Gets the role for the RibbonControlAdv. This is used by accessibility programs. + + + + + Gets or sets the accessible object name + + The accessible object name. + + + + Gets the description of the RibbonControlAdvAccessibility + + A string describing the RibbonControlAdvAccessibility. + + + + Retrieves the child object at the specified screen coordinates. + + The horizontal screen coordinate. + The vertical screen coordinate. + An RibbonControlAdvAccessibility that represents the child object at the given screen coordinates. + This method returns the calling object if the object itself is at the location specified. + Returns null if no object is at the tested location. + + + + FolderBrowser Designer + + + + + Designer ActionList collection + + + + + Initializes a new instance of the CheckBoxAdvDesigner class + + + + + Gets a value indication the designer action + + + + + Overrides the font property. + + + + + Gets/Sets whether to draw focus when item is selected. + + + + + Draws the Background Color using renderer file + + + + + + + Draws the text. + + The instance containing the event data. + + + + Represents the variable to store the Back color. + + + + + Represents the variable to store Style change state. + + + + + represents if stylechanged is true. + + + + + + Method to Draw Item. + + + + + + + + + + + Represents the class to define the style of ListItems. + + + + + Maintains the default style of the . + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + The store. + + + + Gets the default value. + + + + + Gets or sets the item background color of the ListItem. + + + + + Gets or sets the pressed item background color of the ListItem. + + + + + Gets or sets the hover item background color of the ListItem. + + + + + Gets or sets the disabled item background color of the ListItem. + + + + + Gets or sets the item forecolor of the ListItem. + + + + + Gets or sets the pressed item forecolor of the ListItem. + + + + + Gets or sets the hover item forecolor of the ListItem. + + + + + Gets or sets the disabled item forecolor of the ListItem. + + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Represents the class holds the plain data for a style object excluding identity information. + + + + + Provides information about the control's ItemBackColor property. + + + + + Provides information about the control's PressedItemBackColor property. + + + + + Provides information about the control's HoverItemBackColor property. + + + + + Provides information about the control's DisabledItemBackColor property. + + + + + Provides information about the control's ItemForeColor property. + + + + + Provides information about the PressedItemForeColor property. + + + + + Provides information about the control's HoverItemForeColor property. + + + + + Provides information about the control's DisabledItemForeColor property. + + + + + Maintains the static data. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Populates the SerializationInfo store with the name, type, and value of each piece of information it wants to serialize + Describes the source and destination of a given serialized stream, and provides an additional caller-defined context. + + + + Overridden to get the static data source. + + + + + Implements the class that provide the identity information of + using . + + + + + Initializes a new instance of the class. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + CheckBoxAdvActionList class. + + + + + Initializes a new instance of the CheckBoxAdvActionList class. + + Represents component + + + + Gets or sets Name. + + + + + Gets or sets the Text + + + + + Gets or sets the border style. + + The style. + + + + Gets or sets the auoscroll. + + The style. + + + + Gets or sets listbox text alignment + + The style. + + + + Editablelistrenderer Class contains all the color properties which are required for Office 2016 Colorful theme. + + + + + Represents the Color values for Back color during Normal state in Office 2016 Colorful + + + + + Represents the Color values for Fore color during Normal state in Office 2016 Colorful + + + + + Represents the Color values for Back color during Selected state in Office 2016 Colorful + + + + + Represents the Color values for Back color during Normal state in Office 2016 Colorful + + + + + Represents the Color values for Back color for Button in Office 2016 Colorful + + + + + Gets the value of Back color in normal state + + + + + Gets the value of Text color in normal state + + + + + Gets the value of Back color when selected + + + + + Gets the value of Text color when selected + + + + + Gets the value of Back color for want button + + + + + Gets the color table according to the theme. + + + + + + + Office2016 Black EditableRenderer class is inherited from the Editablelistrenderer class + + + + + Represents the Color values for Back color during Normal state in Office 2016 Black + + + + + Represents the Color values for Fore color during Normal state in Office 2016 Black + + + + + Represents the Color values for Back color during Selected state in Office 2016 Black + + + + + Represents the Color values for Back color during Normal state in Office 2016 Black + + + + + Represents the Color values for Back color for Button in Office 2016 Black + + + + + Gets the value of Back color in normal state + + + + + Gets the value of Text color in normal state + + + + + Gets the value of Back color when selected + + + + + Gets the value of Text color when selected + + + + + Gets the value of Back color for want button + + + + + Office2016 White EditableRenderer class is inherited from the Editablelistrenderer class + + + + + Represents the Color values for Back color during Normal state in Office 2016 White + + + + + Represents the Color values for Fore color during Normal state in Office 2016 White + + + + + Represents the Color values for Back color during Selected state in Office 2016 White + + + + + Represents the Color values for Back color during Normal state in Office 2016 White + + + + + Represents the Color values for Back color for Button in Office 2016 White + + + + + Gets the value of Back color in normal state + + + + + Gets the value of Text color in normal state + + + + + Gets the value of Back color when selected + + + + + Gets the value of Text color when selected + + + + + Gets the value of Back color for want button + + + + + Office2016 DarkGray EditableRenderer class is inherited from the Editablelistrenderer class + + + + + Represents the Color values for Fore color during Normal state in Office 2016 DarkGray + + + + + Represents the Color values for Fore color during Normal state in Office 2016 DarkGray + + + + + Represents the Color values for Back color during Selected state in Office 2016 DarkGray + + + + + Represents the Color values for Back color during Normal state in Office 2016 DarkGray + + + + + + Represents the Color values for Back color for Button in Office 2016 DarkGray + + + + + Gets the value of Back color in normal state + + + + + Gets the value of Text color in normal state + + + + + Gets the value of Back color when selected + + + + + Gets the value of Text color when selected + + + + + Gets the value of Back color for want button + + + + + Represents the class to define the style of control. + + + + + Maintains the default style of the . + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Holds instance of a class. + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + The store. + + + + Gets the default value. + + + + + Gets or sets the border color of the textbox. + + + + + Gets or sets the background color of the . + + + + + Gets or sets style for ListItems of the control. + + + + + Gets or sets the disabled background color of the . + + + + + Gets or sets the button background color of the . + + + + + Gets or sets the button forecolor of the . + + + + + Gets or sets the button border color of the . + + + + + Gets or sets the value used to draw the button border of the . + + + + + Gets or sets the value used to draw the pressed button border of the . + + + + + Gets or sets the pressed button forecolor of the . + + + + + Gets or sets the hover button forecolor of the . + + + + + Overridden to create a product-specific identity object for the sub object. + + + StyleInfoProperty descriptor for this sub object. + + + Identity for the sub object. + + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Represents the class holds the plain data for a style object excluding identity information. + + + + + Provides information about the BorderColor property. + + + + + Provides information about the BackColor property. + + + + + Provides information about the ButtonBackColor property. + + + + + Provides information about the ButtonForeColor property. + + + + + Provides information about the property. + + + + + Provides information about the DisabledBackColor property. + + + + + Provides information about the ButtonBorderColor property. + + + + + Provides information about the ButtonBorderThickness property. + + + + + Provides information about the PressedButtonBorderThickness property. + + + + + Provides information about the SelectedButtonForeColor property. + + + + + Provides information about the HoverButtonForeColor property. + + + + + Maintains the static data. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Populates the SerializationInfo store with the name, type, and value of each piece of information it wants to serialize + Describes the source and destination of a given serialized stream, and provides an additional caller-defined context. + + + + Overridden to get the static data source. + + + + + Implements the class that provide the identity information of + using . + + + + + Maintains the EditableList for create the identity. + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + + Initializes a new instance of the class. + + + The that owns this sub-object. + + + The descriptor for this expandable + sub-object. + + + + + CheckBoxAdvActionList class. + + + + + Initializes a new instance of the CheckBoxAdvActionList class. + + Represents component + + + + Gets or sets the options style. + + The style. + + + + Gets or sets the start location + + The style. + + + + Start gradient color. + + + + + End gradient color. + + + + + Gradient style. + + + + + Get or set start gradient color. + + + + + Get or set end gradient color. + + + + + Get or set gradient style. + + + + + Occurs when this class changed. + + + + + Occurs when start color changed. + + + + + Occurs when end color changed. + + + + + Occurs when gradient mode changed. + + + + + Draw control background. + + Graphics for paint. + Rectangle it sketch. + + + + Draw control background. + + Graphics for paint. + Rectangle it sketch. + + + + Create gradient brush. + + Rectangle it sketch. + Gradient brush. + + + + + + + Occurs when start color changed. + + + + + Occurs when end color changed. + + + + + Occurs when gradient mode changed. + + + + + + + + + + + + + + String format outputing text. + + + + + This component style. + + + + + Skip all evants if QuietMode runing. + + + + + User icon size thumbnail. + + + + + User icon as default mode. + + + + + User icon as select mode. + + + + + Order of the drawing button. + + + + + User name. + + + + + User help. + + + + + Active mode as mouse overhead component. + + + + + Select mode as user password enter. + + + + + GraphicsPath for rectangle in user icon. + + + + + GraphicsPath for rectangle in user TextBox. + + + + + Images List. image can be choosed from this list and be displayed as + menu item icon. + + + + + Image index from image list. + + + + + Image index from image list. + + + + + Regions user icon. + + + + + Neeeded recalculate layout graphics element. + + + + + Regions for user name. + + + + + Regions for user help. + + + + + Collection of Buttons + + + + + Button to enter password. + + + + + TextBox for password enter. + + + + + TextBox layout. + + + + + Icon button password enter. + + + + + Text Rendering Hint. + + + + + Auto hide text box as control lost focus. + + + + + Auto reset password as text box show. + + + + + Get or set component style. + + + + + Get or set user icon size. + + + + + Get or set image list user icons. + + + + + Get or set user icon index from image list. + + + + + Get or set user icon index from image list. + + + + + Get or set default user icon. + + + + + Get or set select user icon. + + + + + Get or set user icon as select mode. + + + + + Get or set user name. + + + + + Get or set user help. + + + + + True - do not raise any events, otherwise False. + + + + + Get active mode as mouse overhead component. + + + + + Get select mode. + + + + + Get password box. + + + + + Get or set Text Rendering Hint. + + + + + Get or set auto hide text box as control lost focus. + + + + + Get or set auto reset password as text box show. + + + + + Collection of buttons. + + + + + Occurs when quiet mode changed. + + + + + Occurs when thumbnail size changed. + + + + + Occurs when default icon changed. + + + + + Occurs when select icon changed. + + + + + Occurs when user name changed. + + + + + Occurs when help string changed. + + + + + Occurs when image list changed. + + + + + Occurs when default image index changed. + + + + + Occurs when password box changed. + + + + + Occurs when button enter icon changed. + + + + + Occurs when when user enter password. + + + + + Occurs when text rendering hint changed. + + + + + Occurs when auto hide text box changed. + + + + + Occurs when auto reset password changed. + + + + + Constructor this component. + + + + + + + + + + Begin initialize. + + + + + Begin initialize. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Occurs when quiet mode changed. + + + + + Occurs when thumbnail size changed. + + + + + + Occurs when default icon changed. + + + + + + Occurs when select icon changed. + + + + + + Occurs when user name changed. + + + + + + Occurs when help string changed. + + + + + + Occurs when image list changed. + + + + + + Occurs when default image index changed. + + + + + + Occurs when password box changed. + + + + + Occurs when button enter icon changed. + + + + + + + + Occurs when user enter password. + + + + + Occurs when component style changed. + + + + + + + Occurs when text rendering hint changed. + + + + + Occurs when text box create. + + + + + Occurs when text box initialize. + + + + + Text box constructor. + + + + + Occurs when auto hide text box changed. + + + + + Occurs when auto reset password changed. + + + + + Draw rounded rectangle. + + X - coordinate of rectangle. + Y - coordinate of rectangle. + Width rectangle. + Heigth rectangle. + Radius evening-out. + GraphicsPath rounded rectangle. + + + + Calculate layout graphics element. + + + + + Calculate user name layout. + + + + + + + + + Calculate user help layout. + + + + + + + + + Calculate text box layout. + + + + + + + Calculate buttons layout. + + + + + + + Get user icon for drawing this time. + + + + + Draw icon shadow. + + Graphics for paint. + + + + Retrieves object at the specified screen coordinates. + + The horizontal screen coordinate. + The vertical screen coordinate. + Retrieves the child object at the specified screen coordinates. + + + + Retrieves object at the specified screen coordinates. + + Screen coordinate + Retrieves object at the specified screen coordinates. + + + + Mirror RectangleF for RigthToLeft representation. + + RectangleF as mirror. + + + + Mirror Region for RigthToLeft representation. + + Region as mirror. + + + + + Mirror GraphicsPath for RigthToLeft representation. + + GraphicsPath as mirror. + + + + Mirror all graphics element for RigthToLeft representation. + + + + + + Button name. + + + + + Backgroundcolor color of the highlighted button. + + + + + Backgroundcolor color of the pressed button. + + + + + Represent bounds of the button. + + + + + Transparent color of the button's image. + + + + + Index of the button. + + + + + Shows type of the button. + + + + + Indicate whether the button is enabled. + Default value is true. + + + + + Indicate whether the button is Visible. + Default value is true. + + + + + Name of the button. + + + + + Represent button's image. + Default value is null. + + + + + Indicate button's state. + + + + + Gets or set button bounds. + + + + + Gets or sets transparent image color. + + + + + Gets or sets index of the button. + + + + + Gets or sets type of the button. + + + + + Gets or sets if button is enabled. + + + + + Gets or sets if button is Visible. + + + + + Gets or sets button's name. + + + + + Gets or sets image of the button. + + + + + Gets or sets button' state. + + + + + Draws grayed image. + + + + + Class component style. + + + + + Skip events for quiet mode. + + + + + User name text font for active mode. + + + + + User name text color for default mode. + + + + + User name text color for active mode. + + + + + User name text font for default mode. + + + + + Background gradient style. + + + + + Gradient style rectangle in user icon for default mode. + + + + + Gradient style rectangle in user icon for active mode. + + + + + User name text font for active mode. + + + + + User help text font for default mode. + + + + + User name text color for active mode. + + + + + User name text color for default mode. + + + + + Radius rounded rectangle in icon. + + + + + Radius rounded icons. + + + + + Draw shadow rectangle in icon. + + + + + Shadow size at pixel. + + + + + Get or set user name text font for default mode. + + + + + Get or set user name text font for active mode. + + + + + Get or set help name text color for active mode. + + + + + Get or set help name text color for default mode. + + + + + Get or set background gradient style. + + + + + Get or set gradient style rectangle in user icon for default mode. + + + + + Get or set gradient style rectangle in user icon for active mode. + + + + + User name text font for default mode. + + + + + Get or set User name text font for active mode. + + + + + Get or set user name text color for active mode. + + + + + Get or set user name text color for default mode. + + + + + Get or set radius rounded rectangle in icon. + + + + + Get or set radius rounded icons. + + + + + Get or set draw shadow rectangle in icon. + + + + + Get or set shadow size at pixel. + + + + + True - do not raise any events, otherwise False. + + + + + Occurs when quiet mode changed. + + + + + Occurs when StyleGradientObject changed. + + + + + Occurs when active font changed. + + + + + Occurs when RectColorDefault �hanged. + + + + + Occurs when RectColorActive �hanged. + + + + + Occurs when user name color default changed. + + + + + Occurs when user name color active changed. + + + + + Occurs when font changed. + + + + + Occurs when background start color changed. + + + + + Occurs when background end color changed. + + + + + Occurs when background gradient changed. + + + + + Occurs when active user help font changed. + + + + + Occurs when default user help font changed. + + + + + Occurs when user help color active changed. + + + + + Occurs when user help color default changed. + + + + + Occurs when RectRadius changed. + + + + + Occurs when icon radius changed. + + + + + Occurs when draw shadow changed. + + + + + Occurs when shadow size changed + + + + + Constructor this class. + + + + + Draw image rounded rectangle. + + Graphics for paint. + GraphicsPath rounded rectangle. + Active mode. + + + + Draw control background. + + Graphics for paint. + Rectangle it sketch. + + + + Occurs when quiet mode changed. + + + + + Occurs when active font changed. + + + + + + Occurs when RectColorDefault �hanged. + + + + + + Occurs when RectColorActive �hanged. + + + + + + Occurs when user name color default changed. + + + + + + Occurs when user name color active changed. + + + + + + Occurs when font changed. + + + + + Occurs when background start color changed. + + + + + Occurs when background end color changed. + + + + + Occurs when background gradient changed. + + + + + Occurs when active user help font changed. + + + + + Occurs when default user help font changed. + + + + + Occurs when user help color active changed. + + + + + Occurs when user help color default changed. + + + + + Occurs when RectRadius changed. + + + + + Occurs when icon radius changed. + + + + + Occurs when draw shadow changed. + + + + + Occurs when shadow size changed + + + + + Occurs when StyleGradientObject changed. + + + + + + + Renderer in colorful style. + + + + + Sets the ForeColor of the + + + + + Sets the ForeColor of the listbox in + + + + + Sets the ForeColor of the listbox in + + + + + Gets the MetroColor of the + + + + + Gets the MetroFore color of the + + + + + Gets the TabPanelBackground color of the + + + + + Gets the color table of the . + + + + + + + Renderer in black theme style. + + + + + Sets the ForeColor of the + + + + + Sets the ForeColor of the list box in + + + + + Sets the BackColor of the list box in + + + + + Sets the MetroColor of the + + + + + Sets the TabPanelBackground color of the + + + + + Sets the MetroFore of the + + + + + Renderer in white theme style. + + + + + Gets the ForeColor of the + + + + + Gets the ForeColor of the listbox in + + + + + Gets the BackColor of the list box in + + + + + Gets the MetroColor of the + + + + + Gets the TabPanelBackground color of the + + + + + Gets the MetroForeColor of the + + + + + Renderer in dark gray style. + + + + + Gets the ForeColor of the + + + + + Gets the ForeColor of the listbox in + + + + + Gets the BackColor of the listbox in + + + + + Gets the MetroColor of the + + + + + Gets the TabPanelBackground color of the + + + + + Gets the MetroForeColor of the + + + + + Represents the class to define the style for control. + + + + + Maintains the default style of the . + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + The style object that contains the original data. + + + + + Initializes a new instance of the class. + + + A that holds data for this + . + All changes in this style object will be saved in the + object. + + + + + Initializes a new instance of the class. + + + The identity. + + + + + Initializes a new instance of the class. + + + The identity. + + + A that holds data for this + . + All changes in this style object will be saved in the + object. + + + + + Gets the default ColorTabControlStyleInfo value. + + + + + Gets or sets the border color of ColorTabControl + + The value is used to set the border of the ColorTabControl. + + + + Gets or sets the background color of ColorTabControl + + The value is used to fill the background of the ColorTabControl. + + + + Gets or sets the background color of ColorTabControl + + The value is used to fill the background of the TabItem. + + + + Gets or sets the background color of ColorTabControl in selected state. + + The value is used to fill the background of the ColorTabControl in selected state. + + + + Gets or sets the fore color of the ColorTabControl. + + The value is used to set fore color of ColorTabControl. + + + + Gets or sets the fore color of control in selected state. + + The value is used to set fore color of ColorTabControl. + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Represents the class holds the plain data for a style object excluding identity information. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Maintains the static data. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Populates the SerializationInfo store with the name, type, and value of each piece of information it wants to serialize + Describes the source and destination of a given serialized stream, and provides an additional caller-defined context. + + + + Overridden to get the static data source. + + + + + Creates a copy of the current object. + + A duplicate of the current object. + + + + Represents the class to define the style for control. + + + + + Maintains the default style of the . + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + The style object that contains the original data. + + + + + Initializes a new instance of the class. + + + A that holds data for this + . + All changes in this style object will be saved in the + object. + + + + + Initializes a new instance of the class. + + + The identity. + + + + + Initializes a new instance of the class. + + + The identity. + + + A that holds data for this + . + All changes in this style object will be saved in the + object. + + + + + Gets the default ColorPaletteStyleInfo value. + + + + + Gets or sets the PressedBorder color of the color item. + + The value is used to set border color for color item. + + + + Gets or sets the Border color of the color item. + + The value is used to set border color for color item. + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Represents the class holds the plain data for a style object excluding identity information. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Maintains the static data. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Populates the SerializationInfo store with the name, type, and value of each piece of information it wants to serialize + Describes the source and destination of a given serialized stream, and provides an additional caller-defined context. + + + + Overridden to get the static data source. + + + + + Creates a copy of the current object. + + A duplicate of the current object. + + + + Represents the class to define the style for control. + + + + + Maintains the default style of the . + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + The style object that contains the original data. + + + + + Initializes a new instance of the class. + + + A that holds data for this + . + All changes in this style object will be saved in the + object. + + + + + Initializes a new instance of the class. + + + The identity. + + + + + Initializes a new instance of the class. + + + The identity. + + + A that holds data for this + . + All changes in this style object will be saved in the + object. + + + + + Gets the default ColorListStyleInfo value. + + + + + Gets or sets the back color of the list item. + + The value is used to set back color for list item. + + + + Gets or sets the border color of the color palette in list item. + + The value is used to set border color for color palette in list item. + + + + Gets or sets the fore color of the list item. + + The value is used to set fore color for list item. + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Represents the class holds the plain data for a style object excluding identity information. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Maintains the static data. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Populates the SerializationInfo store with the name, type, and value of each piece of information it wants to serialize + Describes the source and destination of a given serialized stream, and provides an additional caller-defined context. + + + + Overridden to get the static data source. + + + + + Creates a copy of the current object. + + A duplicate of the current object. + + + + Represents the class to define the style for control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Holds instance of a class. + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + Holds instance of a class + + + + Gets the default style value for the control. + + + + + Gets or sets the value of the + control. + + + + + Gets or sets the BackColor of + + The value is used to set BackColor of the control. + The default value is null. + + + + Gets or sets the ForeColor of the + control. + + The value is used to set ForeColor of the control. + The default value is null. + + + + Gets or sets style for ColorPalette of the control. + + + + + Gets or sets style for ListBox of the control. + + + + + Gets or sets style for ColorTabControl of the control. + + + + + Overridden to create a product-specific identity object for the sub object. + + + StyleInfoProperty descriptor for this sub object. + + + Identity for the sub object. + + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Provides storage for the object. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + Represents a class that provides style identity information for nested objects of the + class. + + + + + Initializes a new instance of the class. + + + The that owns this sub-object. + + + The descriptor for this expandable + sub-object. + + + + + Implements the class that provide the identity information of + using . + + + + + Maintains the SplitButton for create the identity. + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Represents a standard interface for selecting colors. + + + The ColorUIControl implements a palette type visual interface for selecting colors at + run-time similar to the color picker drop-down provided by the Visual Studio.NET environment. + The ColorUIControl class offers a selection of colors divided into three color groupings arranged as + tabs. The three color groupings are the SystemColors consisting of the colors defined + within the class, the StandardColors consisting of the colors defined within + and a CustomColors providing a customizable color palette. + The ColorUIControl control can be used either as a regular control hosted within a parent container + or it can be used as a drop-down control in combination with the control. + + + + The following code creates a ColorUIControl, sets the color groups and adds an event handler + for the ColorUIControl.ColorSelected event: + + + private void InitializeColorUIControl() + { + // Create the ColorUIControl. + Syncfusion.Windows.Forms.ColorUIControl clrUIControl = new Syncfusion.Windows.Forms.ColorUIControl(); + + // Set the ColorGroups to be displayed + clrUIControl.ColorGroups = ( Syncfusion.Windows.Forms.ColorUIGroups.CustomColors| + Syncfusion.Windows.Forms.ColorUIGroups.StandardColors| + Syncfusion.Windows.Forms.ColorUIGroups.SystemColors ); + + // Set the initially selected group and color. + clrUIControl.SelectedColorGroup = Syncfusion.Windows.Forms.ColorUISelectedGroup.SystemColors; + clrUIControl.SelectedColor = SystemColors.ControlDark; + + // Provide a handler for the ColorUIControl.ColorSelected event. + clrUIControl.ColorSelected += new EventHandler(this.OnColorSelected); + } + + // Handler for the ColorUIControl.ColorSelected event. + private void OnColorSelected(object sender, System.EventArgs e) + { + Color clrselected = (sender as ColorUIControl).SelectedColor; + } + + + Private Sub InitializeColorUIControl() + + ' Create an instance of the ColorUIControl. + Me.clrUIControl = New Syncfusion.Windows.Forms.ColorUIControl() + + ' Set the color groups to be shown. + Me.clrUIControl.ColorGroups = Syncfusion.Windows.Forms.ColorUIGroups.CustomColors Or Syncfusion.Windows.Forms.ColorUIGroups.StandardColors + + ' Set the initially selected group. + Me.clrUIControl.SelectedColorGroup = Syncfusion.Windows.Forms.ColorUISelectedGroup.CustomColors + + ' Subscribe to the ColorUIControl.ColorSelected event. + AddHandler Me.clrUIControl.ColorSelected, New System.EventHandler(AddressOf clrUIControl_ColorSelected) + + End Sub + + ' Handler for the ColorUIControl.ColorSelected event. + Private Sub clrUIControl_ColorSelected(ByVal sender As Object, ByVal e As System.EventArgs) + + Dim clrselected As Color = Me.clrUIControl.SelectedColor + + End Sub 'clrUIControl_ColorSelected + + + + + + Gets or sets the value used to customize the appearance of the . + + + This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control. + + + + + Helps to apply the ControlName settings in control + + ControlName + + + + Default size of the control + + + + + + + User tab page. + + + + + User colors palette. + + + + + User custom colors. + + + + + User custom colors collection. + + + + + User colors collection. + + + + + Enable stretch custom colors panel on resize. + + + + + Enable stretch user colors panel on resize. + + + + + Specifies an advanced appearance this control. + + + + + + + + + + + + + + Specifies a value to show / hide the user selection color swatches. + + + + + Specifies TabControl item height + + + + + Design the property values into class. + + + + + Color array. + + + + + Control for invalidate if color array was chenged. + + + + + Gets or sets the color value of index. + + + + + Gets a value indicating whether access to the is synchronized. + + + + + Gets a count value. + + + + + Copies the element of the to an , starting at a particular index. + + + + + Gets an object that can be used to synchronize access to the . + + + + + Returns the enumerator that iterates through the item collection. + + + + + + Gets or sets a flag value. + + + + + Gets or sets the theme forecolor of the ColorUI. + + + + + Gets or sets the theme color of the ColorUI. + + + + + Gets or sets a value to show or hide the user selection color swatches. + + + + + Gets or sets custom color to scroller. + + + + + Gets or sets enable stretch custom colors panel on resize. + + + + + Gets or sets an advanced appearance for the ColorUI. + + + + + Update the colors when the style is changed. + + + + + Get or Set of Skin Manager Interface + + + + + Gets or sets enable stretch user colors panel on resize. + + + + + Gets user custom colors. + + ColorGroups must be UserColors for use this property. + + + + Gets user colors. + + ColorGroups must be UserColors for use this property. + + + + Gets or sets the text displayed on the user colors tab. + + + + + The ColorSelected event occurs when a color is selected from one of the palettes in the . + + + + + Gets or sets the color tabpages to be displayed by the control. + + A value. The default is ColorUIGroups.All. + + + + Gets or sets the tab associated with this color group the selected tab. + + A value. + + + + Resets the property to its default value. + + + + + Gets or sets the text displayed on the custom colors tab. + + A String value. + + + + Resets the property to its default value. + + + + + Gets or sets the text displayed on the standard colors tab. + + A String value. + + + + Resets the property to its default value. + + + + + Gets or sets the text displayed on the system colors tab. + + A String value. + + + + Resets the property to its default value. + + + + + Gets or sets the current selected color. + + A value. + + + + Resets the property to its default value. + + + + + Gets or sets the border style of the control. + + A value. The default is BorderStyle.Fixed3D. + + + + Overridden. See . + + + + + Initialize a new instance of the class. + + + + + Gets the . + + + + + Gets or sets Control size before touch enabled. + + + + + Overrides the Font property. + + + + + Gets or sets value to enable or disable the Touchmode to the controls. + + Scale factor will be updated automatically if scalefactor is equal to 1 + + + + + + + + + + + + + Scale the control based on the scale factor passed in the argument. + + value to scale the factor based upon. + + + + Takes the given color and looks for an instance in the ColorValues table. + + + + + Retrieves an array of color constants for the given object. + + + + + Overridden. See . + + + + + + + + + Creates a new accessibility object in . + + Returns a new System.Windows.Forms.AccessibleObject for the + + + + Overridden. See . + + + + + Raises the event. + + A value that contains the event data. + + + + Paints a representative value of the given object to the provided canvas. + + The instance containing the event data. + + + + Paints a representative value of the given object to the provided canvas. + + The value to paint. + Gets the System.Drawing.Graphics object with which painting should be done. + Gets the rectangle that indicates the area in which the painting should be done. + + + + Overridden. See . + + + + + Displays the colorUI control as a drop-down component. + + + + + Displays the control as a drop-down component. + + The initially selected color. + + + + Ends the color display drop-down. + + + + + Returns an array of standard colors. + + + + + Retrieves the array of custom colors for our use. + + + + + Returns an array of system colors. + + + + + Overrides the base class font property. + + + + + Assigns the value for Oldvalue + + + + + Assigns the scale factor + + + + + + + + + + + + + + + + + + + + + + + + + Update the control style. + + + + + Raises the System.Windows.Forms.Control.Paint event. + + A System.Windows.Forms.PaintEventArgs that contains the event data. + + + + Paints the background of the control. + + A System.Windows.Forms.PaintEventArgs that contains information about the control to paint + + + + Raises the System.Windows.Forms.Control.GotFocus event. + + An System.EventArgs that contains the event data. + + + + Create a new instance of the ColorPalette class with the specified a colorUI. + + Provides a standard interface for selecting colors. + Retrieves the array of custom colors. + + + + Gets standard colors array; + + + + + Stretch color cell on resize. + + + + + Gets or sets stretch color cell on resize. + + + + + Gets custom colors array. + + + + + Gets or sets the current selected colors. + + + + + Initialize a new instance of the ColorPaletteAccessibleObject class. + + + + + + Overridden. See . + + It contains that index value. + + + + + Overridden. See . + + + + + Overridden. See + + + + + Gets the object name. + + + + + Gets a parent of an object. + + + + + Gets the role of colorcell. + + + + + Gets the value of an object. + + + + + Initialize a new instance of the CustomColorDialog class. + + + + + Represents the comparison between standard colors. + + It contains that first color value. + It contains that another color value. + + + + + Represens the comparison between system color. + + It contains that first color value. + It contains that another color value. + + + + + + Represents a helper class for Net core. + + + + + Helper class for handling corner radius of control region. + + + + + Initializes a new instance of the class. + + The owner control. + + + + Gets or sets corner radius. + + Radius has to be not less than zero or half of minimum dimension (width or height) of control. + If radius is zero, region has rectangular appearance. + + + + + Gets the graphics path for region border. + + + + + Updates and sets control's region. + + + + + Retrieves the minimal size of the owner control. + + Current minimal size. + + + + + + + + + + + + + + + + UseVisualStyle is true + + + + + UseVisualStyle is false + + + + + value for UseVisualStyle inherits from parent + + + + + Specifies the appearance of the button. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies the state of the button. + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies ButtonAdv border style. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Provides the design time functionality for control. + + + + + + + + + + + + + + + + Design the property values into the class. + + + + This should be called WindowsXPColorAndLayoutScheme. + Specifies the layout and colors for buttons and combo box buttons. + + + + + + + + + + + + + + + + + + + + + + + Defines the different colors that will be used to define the 3 Windows XP + color schemes supported. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Defines the different colors that are used to define the Office 2003 look and feel. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Defines the different colors that are used to define the Office XP look and feel. + + + + + + + + + + + Gets Bordercolorwhite + + + + + Gets Bordercolordarkgray + + + + + Gets Bordercolorblack + + + + + Gets Bordercolorcolorful + + + + + Basic class for all renderers. ButtonRenderer provides the basic plumbing that is needed by all renderers. + + You can derive from ButtonRenderer to create your own renderers. + + + + + + + + + + + + + + + + + + + True - class is disposed, otherwise False. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies region for drawing + + + + + Sets vista color scheme for the control. + + + + + Sets office 2010 color scheme for the control. + + + + + Sets Metro color scheme for the control. + + + + + This function does much of the rendering. In the base , it does not + do anything. + + + The graphics object to use. + + + + + Draws text on ButtonAdv with specified color + + + The graphics object to use. + + Color of the text + + + + Draws background image, image and text + + + The graphics object to use. + + + + + + + + + + + + + + + + + + + + + + + + + Helper function to get an image from within embedded resources. + + The resource name to get. + An image; NULL if the image is not available. + + The class can take an image based on the + property. This helper function + loads the images based on the resource name. + + + + + Gets the button type images for new theme + + + + + + + + True if button has state , otherwise False. + + + + + True if button has state , otherwise False. + + + + + True if button has state , otherwise False. + + + + + + + + + + + + + + + + + Renders an background image. + + The graphics object to use. + BackgroundImage to render. + The layout of background image. + The bounds of the control. + The rectangle to draw on it. + Offset of location of the image when layout is tile. + The rightToLeft property of the control. + + + + Renders an image. Delegates to the class. + + The graphics object to use. + The bounds to be used when rendering the image. + Image to render. + + + + Renders an inverted triangle. Delegates to the class. + + The graphics object to use. + The bounds to be used when rendering the shape. + The brush to be used for filling the interior of the rendered triangle. + The pen to be used for stroking the triangle. + + + + Renders a triangle. Delegates to the class. + + The graphics object to use. + The bounds to be used when rendering the shape. + The brush to be used for filling the interior of the rendered triangle. + The pen to use for stroking the triangle. + + + + + + + Represents the class for drawing style option of the control. + + + + + + + + + + + + + + + + + + + + + + + + Initialize the Button Appearance. + + + + + Gets/ Sets the Button Appearance. + + + + + + + + + + + + + + + + + + + Default constructor + + + + + Constructor with variables initialization. + + + + + + + + + Render button in classic style + + + + + + + + + + + + + Defines the different colors that will be used to define the 3 Windows XP + color schemes supported. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for Office2000ButtonRenderer. + + + + + + + + + + + + + + + + + + + Office2003 button style rendering. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents renderer of the Office 2007 style for ButtonAdv. + + + + + Default radius truncation coreners of the control. + + + + + Angle for vertical gradient brush. + + + + + Width for brush. + + + + + + + + + + Blend for selected control. + + + + + Blend for control. + + + + + Blend for pressed control. + + + + + Blend for disabled control. + + + + + The color scheme that the renderer will render. + + + + + Current color table. + + + + + Initialize all drawing objects + + + + Make class cleanup + + + + + Sets vista color scheme for the control. + + + + + Gets rounded path for control. + + + + + Gets rectangle for background. + + + + + Gets rectangle for internal border. + + + + + Gets vertical gradient brush. + + + + + Draws background. + + + + + Draws border. + + + + + + + + + + + + + + + + + + + + + Draws background for control when it don't press and mouse don't over it. + + + + + Draws background for control when it pressed. + + + + + Draws background for control when mouse over it. + + + + + Draws background for disable control. + + + + + Fill rectangle with gradient. + + + + + Fill rectangle with gradient for pressed control. + + + + + Fill rectangle with gradient for selected control. + + + + + Fill rectangle with gradient for disabled control. + + + + + + + + + Specifies region for drawing + + + + + Draws text on ButtonAdv with specified color + + + The graphics object to use. + + Color of the text + + + + Represents renderer of the Office 2007 style for ButtonAdv. + + + + + Default radius truncation coreners of the control. + + + + + Angle for vertical gradient brush. + + + + + Width for brush. + + + + + + + + + + Blend for selected control. + + + + + Blend for control. + + + + + Blend for pressed control. + + + + + Blend for disabled control. + + + + + The color scheme that the renderer will render. + + + + + Current color table. + + + + + Initialize all drawing objects + + + + Make class cleanup + + + + + Sets vista color scheme for the control. + + + + + Gets rounded path for control. + + + + + Gets rectangle for background. + + + + + Gets rectangle for internal border. + + + + + Gets vertical gradient brush. + + + + + Draws background. + + + + + Draws border. + + + + + + + + + + + + + + + + + + + + + Draws background for control when it don't press and mouse don't over it. + + + + + Draws background for control when it pressed. + + + + + Draws background for control when mouse over it. + + + + + Draws background for disable control. + + + + + Fill rectangle with gradient. + + + + + Fill rectangle with gradient for pressed control. + + + + + Fill rectangle with gradient for selected control. + + + + + Fill rectangle with gradient for disabled control. + + + + + + + + + Specifies region for drawing + + + + + Draws text on ButtonAdv with specified color + + + The graphics object to use. + + Color of the text + + + + Summary description for OfficeXPButtonRenderer. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Show or Hide the prefix character + + + + + Summary description for RenderingHelper. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Calculates rectangle to draw on it backgroundImage, depending on imageLayout + + Bounds of the control + Background image of the control + Image layout of the background image + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + WindowsXP button Renderer. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The color scheme that the renderer will render. + + + + + + + + + + + + + Sets the rectangles and paths used to draw the XP button when the size of the button is set. + + Set drawing bounds. + + + + + + + + + + + + + + + + Sets WindowsXP color scheme for the control. + + + + + Set the color scheme for the button based on the current XP Scheme and + the IsComboButton property. + + + + + + + + + + + + Calculates bounds for helper rectangles. + + + + + + + + + + + + + + + + + + + + + + + + + + Renders ButtonAdv using visual styles. + + + + + + + + + + + + + + + + + + Extends List{T} with events. + + Type of collection elements. + + + + + + + + + + + + + + + + + + + Gets or sets the element at the specified index. + + + + + + + + + + + + + Add method. + + + + + + + Determines the index of a specific item in the list. + + + + + + + Inserts an item to the list at the specified index. + + + + + + + Removes the first occurrence of a specific object from the collection. + + + + + + Removes item at the specified index. + + + + + + Determines whether the list contains a specific value. + + + + + + + Removes all items from the list. + + + + + + + + + + + Adds an item to the list. + + + + + + + Removes all items from the list. + + + + + Determines whether the list contains a specific value. + + + + + + + Determines the index of a specific item in the list. + + + + + + + Inserts an item to the list at the specified index. + + + + + + + Gets a value indicating whether the list has a fixed size. + + + + + Gets a value indicating whether the list is read-only. + + + + + Removes the first occurrence of a specific object from the list. + + + + + + Removes item at the specified index. + + + + + + Gets or sets the element at the specified index. + + + + + + + Copies the elements of the ICollection to an Array, starting at a particular Array index. + + + + + + + Gets the number of elements contained in the ICollection. + + + + + Gets a value indicating whether access to the collection is synchronized + + + + + Gets an object that can be used to synchronize access to the collection. + + + + + Performs additional custom processes before inserting a new element into the collection. + + + + TRUE to insert object + + + + Performs additional custom processes when removing an element from the collection. + + + + TRUE to remove object + + + + Fires ItemAdded event. + + + + + + + Fires ItemRemoved event. + + + + + + + + + + + + + + + + + Fired when new item is added to the collection. + + + + + Fired when item is removed from collection. + + + + + Event arguments for ObservableList events. + + Type of items in InnerList. + + + + Underlying item. + + + + + Creates and initializes new instance of ListItemEventArgs. + + Underlying item. + + + + + + Reference on parent control + + + Reference on parent control/container. + + + Typed version of indexer. + + + + + + + + + + Initializes new instance of ControlsCollectionBase class + + Reference on parent control. Can not be NULL. + + + + Initializes new instance of ControlsCollectionBase class + + Reference on parent control. Can not be NULL. + Attach event handler to ConfigureControl event on initialize. + + + Occurs when collection changed. + + + + + + + + + Add Control object to collection. + + + + + + + + + + + Removes control from collection. + + + + + + Insert control in position with index value is index. + + + + + + + + + + + + + + Includes/exclude controls from parent controls collection. + + If true - excludes, else includes controls in parent controls collection. + + + + + + + + + + + + + + + + + + + + + + Message class that contains reference on control that + required configuration. + + + Storage of control reference. + + + Get reference on Control. + + + Default constructor. + + + + + + + + + We specify that only buttons can be created in design time in collection. + In runtime developer will have more freedom. + + + Default constructor. + + + + Allow creation only of buttons in designe time. + Allowed types for creation. + + + + Implements a drop-down button control for selecting colors. + + + The ColorPickerButton class is a button-type control that pops-up an instance of the Syncfusion + when clicked. This class derives from the Windows Forms Button class and + hence can be used in place of a regular button control. The ColorPickerButton's ColorUIControl component + can be accessed through the property. + + + + + + The ColorSelected event occurs when a color is selected from the drop-down . + + + + + Gets a reference to the drop-down ColorUIControl. + + A reference to the instance. + + + + Overrides the base class font property. + + + + + Gets or sets a value indicating whether the control should enable its Accessibility support. + + + + + Gets or sets the size of the drop-down . + + A Size value. + + + + Gets or sets the visibility drop down. + + True if the drop-down is visible; False otherwise. By default, it is False. + + + + Gets or sets the touchmode of is enable. + + + + + Gets or sets a value whether is set as the backcolor. + + True if the SelectedColor is used; False otherwise. By default, it is False. + + + + Gets or sets a value whether is set as the text. + + True if the SelectedColor is used; false otherwise. By default, it is False. + + + + Gets or sets the current selected color. + + A color value. + + + + + + + Resets the property to its default value. + + + + + Gets or sets the tab associated with this colorgroup in the drop-down . + + A value. The default is ColorUIGroups.All. + + + + Gets or sets the tab associated with this colorgroup as the selected tab in the drop-down . + + A value. + + + + Gets or sets the text displayed on the drop-down 's custom colors tab. + + A String value. + + + + + + + Resets the property to its default value. + + + + + Gets or sets the text displayed on the drop-down 's standard colors tab. + + A String value. + + + + + + + Resets the property to its default value. + + + + + Gets or sets the text displayed on the drop-down 's system colors tab. + + A String value. + + + + + + + Resets the property to its default value. + + + + + Gets a reference to the that will contain the . + + A reference to the instance. + + + + Creates a new instance of the class. + + + + + Gets/Sets if Dropdown opened using Touch Gesture + + + + + Process touch gestures + + Gesture messages + true/false + + + + Overridden. See . + + + + + Sets the font to ColorUI control + + + + + Creates a new accessibility object in . + + Returns a new System.Windows.Forms.AccessibleObject for the + + + + Creates a default instance of a . + + The instance. + + + + Returns the name of the control. + + + + + Initializes the drop-down container. Adds a . + + + + + + + + + + Called when the drop-down has been closed. + + + + + + + + Overridden. See . + + + + + Defines the constant that specify constants that define the color groups for the ColorPicker controls. + + + The ColorUIGroup's enumeration is used for specifying the color tab pages to be + displayed in the and the controls. +

This enumeration has a FlagsAttribute that allows a combination of its member values.

+ + + + + None of the color groups are displayed. + + + + + Displays the custom colors group. + + + + + Displays the standard colors group. + + + + + Displays the system colors group. + + + + + Displays all color groups, but not displays UserColors groups. + + + + + Displays the user colors group. + + + + + Displays all color groups. + + + + + Defines the constant that specify the selected color group in the ColorPicker controls. + + + The ColorUISelectedGroup enumeration is used for specifying the selected color group in the + and the controls. + + + + + No color group is selected. + + + + + The custom colors group is selected. + + + + + The standard colors group is selected. + + + + + The system colors groups is selected. + + + + + The user colors groups is selected. + + + + + Defines the constant which specifies the possible source of ColorUI Style. + + + + + Classic appearance. + + + + + Office2010 like appearance. + + + + + Office2016 colorful appearance. + + + + + Office2016 white theme appearance. + + + + + Office2016 black theme appearance. + + + + + Office2016 dark gray appearance. + + + + + Metro-like appearance. + + + + + Design the property values into class. + + + + + Designer ActionList collection + + + + + Initialize a new instance of the ColorUIDesigner class. + + + + + Gets a value indication the designer action. + + + + + Provides support for the method that returns a . + + + + + Returns a that is associated with the current object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Empty attributes array for optimization. + + + Hide default constructor. Allow to see it only inheritors. + + + + Overloaded. Looks for bindable properties in each of the component objects + and create a new PD entry for it. It then creates a brand new PDC combining the PDs of + the originalList and the new entries and returns the new PDC. + + The originalList consists of the PDC of the parent control. + The lookupObjects list consists of the array of instances of the component classes. + A collection of property descriptors. + + + + Looks for bindable properties in each of the component objects + and create a new PD entry for it. It then creates a brand new PDC combining the PDs of + the originalList and the new entries and returns the new PDC. + + The originalList consists of the PDC of the parent control. + The lookupObjects list consists of the array of instances of the component classes. + A collection of property descriptors. + + + + HSL color space. + + + + + + + + + + + + + + + + + + + Method converts Color defined in RGB values to HSL color space. + + Hue value. + Saturation value. + Luminance value. + + + + + + + + + + + + + Method converts Color defined in HSL values to RGB color space. + + Hue value. + Saturation value. + Luminance value. + + + + + Gets or sets hue component of a color space. + + + + + Gets or sets saturation component of a color space. + + + + + Gets or sets luminance component of a color space. + + + + + Hue component of a color space. + + + + + Saturation component of a color space. + + + + + Luminance component of a color space. + + + + + HSV color space. + + + + + + + + + + + + + + + + + + + Method converts Color defined in RGB values to HSL color space. + + Hue value. + Saturation value. + Luminance value. + + + + + + + + + + + + + Method converts Color defined in HSV values to RGB color space. + + + + + + Gets or sets hue component of a color space. + + + + + Gets or sets saturation component of a color space. + + + + + Gets or sets value component of a color space. + + + + + Hue component of a color space. + + + + + Saturation component of a color space. + + + + + Value component of a color space. + + + + + + + + Inflate offset for drawing selection rectangle. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Methods recalculate top left and right bottom points + using Graphics matrix settings. This method required when we will + draw on Graphics created from HDC that does not have applied transformations. + Very useful when used ControlPaint class for drawing. + reference on Graphics + rectangle to recalculate. + Transformed rectangle. + Methods will work fine only in limited cases. If on graphics applied + rotations then in most cases will be wrong calculated rectangle. + + Rectangle rcBorders = ControlDrawing.Transform( g, this.Bounds ); + ControlDrawing.DrawBorderInternal( g, rcBorders, this.BorderStyle, this.Border3DStyle, this.BorderSingle, this.BorderColor, this.BorderSides ); + + + + Methods recalculate point using Graphics matrix settings. + This method required when we will draw on Graphics created from HDC + that does not have applied transformations. Very useful when used + ControlPaint class for drawing. + reference on Graphics + Point to recalculate. + Transformed point. + + + + Method allow to draw borders according to specified styles. + + Reference on Graphics. + Output rectangle. + border style. + 3D border style. + border style in single mode. + border color in single mode. + sides that have to be drawn by methods. + True - fix known bug in method, otherwise leave + old code (for compatibility only). + + + + Returns the width required to draw the text specified using the font specified. + + A object. + The text that is to be drawn. + The using which to draw. + True - we use RTL, otherwise normal drawing. + Width required. + + + Measure string with limit by width. + + + + + -1 - apply single line mode for measuring, values greater zero + enables multiline measuring mode. + + + + + Represents a class that provides support to get the current DPI value and calculate the values based on the current DPI values. + + + + + Indicates the logpixel. + + + + + Stores the current dpi value. + + + + + Stores the current device units. + + + + + Gets the image file from given assembly based on the DPI scaling factor. + If the DPI scaling is greater than 175 then returns the high DPI image, otherwise returns the default image. + + The used to read the image file. + The string contains the folder path. + The string value represents the name of the image file. + The imageName must contains the extension like AddNewRowIcon.png or AddNewRowIcon.bmp + Returns the image file from specified folder path. + + + + Gets an equivalent value based on the current DPI value. + + The float value. + Returns the value based on DPI value. + + + + Gets the current DPI value of the device. + + Returns the current DPI value of the device. + + + + Represents the class to define the style for control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + The store. + + + + Gets the default style value for the control. + + + + + Gets or sets the value of the + control. + + + + + Gets or sets the background color of the control. + + The value is used to fill the background of the GroupViewItem. + + + + Gets or sets the background color of the control in selected state. + + The value is used to fill the background of the GroupViewItem. + + + + Gets or sets the hover background color of the control in selected state. + + The value is used to fill the background of the GroupViewItem. + + + + Gets or sets the hover foreground color of the control in selected state. + + + + + Gets or sets the hover border color of the control in selected state. + + + + + Gets or sets the background color of the control in mouse hover state. + + + + + Gets or sets the border color of the control. + + + + + Gets or sets the border thickness of the control. + + + + + Gets or sets the border color of the control in mouse hover state. + + + + + Gets or sets the border color of the control in selected state. + + + + + Gets or sets the border color of the control in disabled state. + + + + + Gets or sets the background color of the control in the disabled state. + + + + + Gets or sets the foreground color value of the control. + + + + + Gets or sets the foreground color of the control in hover state. + + + + + Gets or sets the foreground color of the control in selected state. + + + + + Gets or sets the foreground value of the control in disabled state. + + + + + Gets or sets the tooltip background color value of the control. + + + + + Gets or sets the tooltip foreground color value of the control in disabled state. + + + + + Gets or sets the tooltip border color value of the control in disabled state. + + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Implements the class that provide the identity information of + using . + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Provides storage for the object. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + Represents the class to define the style for control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Holds instance of a class. + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + Holds instance of a class + + + + Gets the default style value for the control. + + + + + Gets or sets the value used to draw the background of the + control in default state. + + The value is used to draw the background of the control. + The default value is null. + + + + Gets or sets the value used to draw the border of the + control. + + The value is used to draw the border of the control. + The default value is null. + + + + Gets or sets the borderthickness of control. + + + + + + Gets or sets the value used to draw the background color of the + scroll button in control. + + The value used to draw the background color of the scroll button. + The default value is null. + + + + Gets or sets the value used to draw the background color of the + scroll button in control in hover state. + + The value used to draw the background color of the scroll button. + The default value is null. + + + + Gets or sets the value used to draw the background color of the + scroll button in control in pressed state. + + The value used to draw the background color of the scroll button. + The default value is null. + + + + Gets or sets the value used to draw the foreground color of the + scroll button in control. + + The value used to draw the foreground color of the scroll button. + The default value is null. + + + + Gets or sets the value used to draw the foreground color of the + scroll button in control in hover state. + + + + + Gets or sets the value used to draw the foreground color of the + scroll button in control in selected state. + + + + + Gets or sets the value used to draw the border color of the + scroll button in control. + + The value used to draw the border color of the scroll button. + The default value is null. + + + + Gets or sets the value used to draw the hover border color of the + scroll button in control. + + The value used to draw the border color of the scroll button. + The default value is null. + + + + Gets or sets the value used to draw the pressed border color of the + scroll button in control. + + The value used to draw the border color of the scroll button. + The default value is null. + + + + Gets or sets the borderthickness used to draw the border of the scroll button in control. + + + + + Gets or sets style for of the control. + + + + + Overridden to create a product-specific identity object for the sub object. + + + StyleInfoProperty descriptor for this sub object. + + + Identity for the sub object. + + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Implements the class that provide the identity information of + using . + + + + + Maintains the GroupView for create the identity. + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Represents the class which provides storage for the object. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + Represents a class that provides style identity information for nested objects of the + class. + + + + + Initializes a new instance of the class. + + + The that owns this sub-object. + + + The descriptor for this expandable + sub-object. + + + + + Represents the class to define the style for CollapseButton present in control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + The store. + + + + Gets the default style value for the GroupBarCollapseButton present in control. + + + + + Gets or sets the collapse button background color of the stack mode . + + + + + Gets or sets the collapse button background color of the stack mode in hover state. + + + + + Gets or sets the collapse button fore color of the stack mode . + + + + + Gets or sets the collapse button fore color of the stack mode in hover state. + + + + + Gets or sets the collapse image value of the stack mode control. + + + + + Gets or sets the expand image value of the stack mode control. + + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Implements the class that provide the identity information of + using . + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Provides storage for the object. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + Represents the class to define the style for collapsed state of control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + The store. + + + + Gets the default style value for collapsed state of control. + + + + + Gets or sets the background color of the navigation pane of control. + + + + + Gets or sets the background color of navigation pane of control in selected state. + + + + + Gets or sets the background color of navigation pane of control in hover state. + + + + + Gets or sets the border color of navigation pane of control. + + + + + Gets or sets the foreground color of navigation pane of control. + + + + + Gets or sets the foreground color of navigation pane of control in hover state. + + + + + Gets or sets the foreground color of navigation pane of control in selected state. + + + + + Gets or sets the value of the + navigation pane of control. + + + + + Gets or sets item style for collapsed state view of the control. + + + + + Overridden to create a product-specific identity object for the sub object. + + + StyleInfoProperty descriptor for this sub object. + + + Identity for the sub object. + + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Implements the class that provide the identity information of + using . + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Provides storage for the object. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + Represents the class to define the style for control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + The store. + + + + Gets the default style value for the control. + + + + + Gets or sets the value of the + control. This property is not applicable for collapsed GroupBarItem. + + + + + Gets or sets the background color of the control. + + + + + Gets or sets the background color of the control in selected state. + + + + + Gets or sets the background color of the control in mouse hover state. + + + + + Gets or sets the border color of the control. + + + + + Gets or sets the border thickness of the control. + + + + + Gets or sets the background color of the control in the disabled state. + + + + + Gets or sets the foreground color of the control. This property is not applicable for collapsed GroupBarItem. + + + + + Gets or sets the foreground color of the control in hover state. This property is not applicable for collapsed GroupBarItem. + + + + + Gets or sets the foreground color of the control. This property is not applicable for collapsed GroupBarItem. + + + + + Gets or sets the foreground color of the control in disabled state. This property is not applicable for collapsed GroupBarItem. + + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Implements the class that provide the identity information of + using . + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Provides storage for the object. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + Represents the class to define the style for control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Holds instance of a class. + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + Holds instance of a class + + + + Gets the default style value for the control. + + + + + Gets or sets the value used to draw the background of the + control in default state. + + The value is used to draw the background of the control. + The default value is null. + + + + Gets or sets the value used to draw the border of the + control. + + The value is used to draw the border of the control. + The default value is null. + + + + Gets or sets the int value used to draw the border thickness of the + control. + + The int value is used to draw the border of the control. + The default value is null. + + + + Gets or sets style for of the control. + + + + + Gets or sets style for stack mode container of the control. + + + + + Gets or sets style for collapsed state container of the control. + + + + + Gets or sets style for collapsed state container of the control. + + + + + Overridden to create a product-specific identity object for the sub object. + + + StyleInfoProperty descriptor for this sub object. + + + Identity for the sub object. + + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Implements the class that provide the identity information of + using . + + + + + Maintains the GroupBar for create the identity. + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Represents the class which provides storage for the object. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + Represents a class that provides style identity information for nested objects of the + class. + + + + + Initializes a new instance of the class. + + + The that owns this sub-object. + + + The descriptor for this expandable + sub-object. + + + + + Represents the class to define the style for GroupBarOptionButton present in control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + The store. + + + + Gets the default style value for the GroupBarOptionButton present in control. + + + + + Gets or sets the option button background color value of the stack mode control. + + + + + Gets or sets the option button background color value of the stack mode control in hover state. + + + + + Gets or sets the option button foreground color value of the stack mode control. + + + + + Gets or sets the option button foreground color value of the stack mode control in hover state. + + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Implements the class that provide the identity information of + using . + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Provides storage for the object. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + Represents the class to define the style for stacked mode of control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + The store. + + + + Gets the default style value for the stacked mode of > control. + + + + + Gets or sets the header background color of the stack mode control. + + + + + Gets or sets the header foreground color of the control. + + + + + Gets or sets the value of the + header of stack mode control. + + + + + Gets or sets the background color of the splitter of stack mode . + + + + + Gets or sets the foreground color of the splitter of stack mode . + + + + + Gets or sets style for collapse/expand button of the stacked mode control. + + + + + Gets or sets style for option button of the stacked mode control. + + + + + Gets or sets the collapse panel backcolor color value of the stack mode control. + + + + + Gets or sets style for collapsed of the stacked mode control. + + + + + Overridden to create a product-specific identity object for the sub object. + + + StyleInfoProperty descriptor for this sub object. + + + Identity for the sub object. + + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Implements the class that provide the identity information of + using . + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Provides storage for the object. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + Represents the class to define the style for ToolTip present in control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + The store. + + + + Gets the default style value for the ToolTip present in control. + + + + + Gets or sets the value of the ToolTip present in control. + + + + + Gets or sets the background color of the ToolTip present in control. + + + + + Gets or sets the border color value of the ToolTip present in control. + + + + + Gets or sets the foreground color value of the ToolTip present in control. + + + + + Gets or sets the bool value indicates whether to show shadow of the ToolTip present in control. + + + + + Gets or sets the border thickness of the ToolTip present in control. + + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Implements the class that provide the identity information of + using . + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Provides storage for the object. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + Defines the constant that specify the alignment of the check box. + + + + + Specifies that the check box will be left aligned. + + + + + Specifies that the check box will be right aligned. + + + + + Specifies the state of Controls + + + + + The Control has its normal appearance. + + + + + The Control appears pressed. + + + + + The mouse hover on the Control. + + + + + The focus state of the Control. + + + + + Defines the constants that specifies the mode of the caption bar height on maximized state. + + + + + Specifies that the caption bar height will be reduced when form is maximized. + + + + + Specifies that the caption bar height will be retained same when form is maximized. + + + + + Represents the method that will handle the event. + + A sender contains the control. + A that contains the event data. + + + + Provides data for the event. + + + + + The theme name. + + + + + Initializes a new instance of the class. + + Name of the theme. + + + + Gets the name of the theme. + + + + + This class helps to register and render icon font in a Windows Forms application from *.ttf file. + + + + + Holds private/custom font collection. + + + + + Holds private/custom font collection. + + + + + Holds FontFamilies collection + + + + + Holds icon font unicode. + + + + + Helps to register the private/custom icon fonts in the system memory for rendering in Windows Forms. + + + + + Helps to retrieve the icon font as string from its unicode for drawing purpose. + + Holds the icon font unicode. + + + + + Helps to dispose the instances used in IconFontHelper class. + + + + + Represents the class that manages the localization for syncfusion controls. + + + + + Holds the resource manager of the + + + + + Initializes new instance of . + + + + + Gets the assembly of the project. + + Returns assembly of the project. + + + + Gets the default namespace of the referred project. + + Control assembly default namespace. + + + + Gets the localized ResourceManager. + + The assembly from where the resource needs to be looked up. + The namespace of the control. + Returns the resource manager. + + + + Gets the localized text. + + String that has to be localized. + Control object + The localized string. + + + + Gets the localized text. + + String that has to be localized. + The localized string. + + + + Gets the localized text. + + Current UI culture. + String that has to be localized. + Control name. + The localized string + + + + Sets the resource manager based on the assembly and namespace. + It can be used to get the values from the application resource files + when the assembly name and the namespace of the control or application is different. + + The control assembly. + The namespace of the control. + + + + + + + Insance of . + + + + + + + + + + + Represents a ToolTip window that displays a brief description about a control when user rests the mouse on that control. + + + This sample shows how to set tooltip text for a control. + + SfToolTip sfToolTip = new SfToolTip(); + sfToolTip.SetToolTip(this.button1, "Sample Tooltip"); + + + + This sample shows how to set for a control to show as a tooltip. + + SfToolTip sfToolTip = new SfToolTip(); + ToolTipInfo tooltipInfo1 = new ToolTipInfo(); + ToolTipItem toolTipItem1 = new ToolTipItem(); + toolTipItem1.Text = "Tooltip item 1 text"; + ToolTipItem toolTipItem2 = new ToolTipItem(); + toolTipItem2.Text = "Tooltip item 2 text"; + toolTipInfo.Items.AddRange(new ToolTipItem[] { toolTipItem1, toolTipItem2}); + sfToolTip.SetToolTipInfo( this.button2, toolTipInfo); + + + + + + The collection of controls registered for tooltip with their ToolTipInfo. + + + + + The collection of controls registered for tooltip with text. + + + + + The timer for initial delay. + + + + + The timer for popup delay. + + + + + The information to be shown in tooltip for show method. + + + + + The tooltip item to be shown in tooltip for show method. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The container in which the SfToolTip component has to be added. + + + + Occurs when the tooltip is showing. + + + The event is raised whenever a ToolTip is displaying, + either by calling method or implicitly called by v. + The class contains all the information needed to customize the , including the location, . + This event can be canceled. + + + + + Occurs when the tooltip is shown. + + + The event is raised whenever a ToolTip is displayed, + either by calling method or implicitly called by v. + + + + + Occurs before drawing the tooltip item. + + + By using the event, the appearance of the can be customized. + The class contains all the information needed to paint the , including the ToolTip text, the Rectangle, and the Graphics object on which the drawing should be done. + This event can be canceled. + + + + + Occurs when theme name of the has changed. + + + + + Gets or sets the time that passes before the ToolTip appears. + + + By using property, you can shorten or lengthen the time that the ToolTip waits before displaying a ToolTip window. + + + + + Gets or sets the period of time the ToolTip remains visible if the pointer is stationary on a control. + + + The period of time, in milliseconds, that the ToolTip remains visible when the pointer is stationary on a control. The default value is 5000. + + + By using property, you can shorten or lengthen the time that the ToolTip window is displayed when the pointer is on a control. + + + + + Gets or sets a value indicating whether shadow should be drawn for the ToolTip. + + + + + Gets or sets the tooltip window for the . + + + + + Gets or sets the active associated control with the tooltip. + + + + + Gets or sets the value of the to customize the appearance of the tooltip. + + + + + Gets or sets a value indicating whether the location of the ToolTip can be adjusted respective to the screen bounds. + + + + + Gets the of the Control. + + An object of control. + Returns the of the control. + + + + Associates the with the specified control. + + The control to associate with the . + The to be + displayed when the pointer is on the control. + + + + Associates the with the specified control. + + The control to associate with the . + The tooltip text to be displayed when the pointer is on the control. + + + + Gets the tooltip text of the Control. + + An object of control. + Returns the tooltip text of the control. + + + + Disables the ToolTip for the specified control. + + The control for which the ToolTip has to be disabled. + + + + Hides the ToolTip, if it is being displayed. + + + + + Shows the ToolTip with the at the specified relative position. + + to be displayed as ToolTip. + A point in which the ToolTip to be displayed. + + + + Shows the ToolTip with the at the specified relative position. + + to be displayed as ToolTip. + The horizontal offset position in which the ToolTip has to be displayed. + The vertical offset position in which the ToolTip has to be displayed. + + + + Shows the ToolTip with the at the specified relative position for a specified duration. + + to be displayed as ToolTip. + The horizontal offset position in which the ToolTip has to be displayed. + The vertical offset position in which the ToolTip has to be displayed. + The period of time that the ToolTip should remain visible. + + + + Shows the ToolTip with the at the specified relative position for a specified duration with specified initial delay. + ToolTip location will be adjusted with respect to the screen bounds, if adjustToScreenBounds value is true. + + to be displayed as ToolTip. + A point in which the ToolTip to be displayed. + The period of time that passes before the ToolTip appears. + The period of time that the ToolTip should remain visible. + Specifies whether to adjust the ToolTip location respective to the screen bounds. + + + + Shows the ToolTip with the at the specified relative position for a specified duration. + + to be displayed as ToolTip. + A point in which the ToolTip to be displayed. + The period of time that the ToolTip should remain visible. + + + + Shows the ToolTip with the tooltip text at the specified relative position. + + The text to be displayed as tooltip. + A point in which the ToolTip to be displayed. + + + + Shows the ToolTip with the tooltip text at the specified relative position. + + The text to be displayed as tooltip. + The horizontal offset position in which the ToolTip has to be displayed. + The vertical offset position in which the ToolTip has to be displayed. + + + + Shows the ToolTip with the tooltip text for the specified duration at the specified relative position. + + The text to be displayed as tooltip. + The horizontal offset position in which the ToolTip has to be displayed. + The vertical offset position in which the ToolTip has to be displayed. + The period of time that the ToolTip should remain visible. + + + + Shows the ToolTip with the tooltip text for the specified duration at the specified relative position. + + The text to be displayed as tooltip. + A point in which the ToolTip to be displayed. + The period of time that the ToolTip should remain visible. + + + + Shows the ToolTip with the tooltip text at the cursor position. + + The text to be displayed as tooltip. + + + + Shows the ToolTip with the at the cursor position. + + to be displayed as ToolTip. + + + + Helps to apply the ControlName settings in control + + The ControlName. + Returns the control name. + + + + Helps to apply the ThemeName settings in control + + The ThemeName. + + + + Specifies whether this object can provide its extender properties to the specified object. + + The Object to receive the extender properties. + true if this object can provide extender properties to the specified object; otherwise, false. + + + + Raises the event. + + An object of + that contains event data. + + + + Raises the event. + + An object of + that contains event data. + + + + Raises the event. + + An object of + that contains event data. + + + + Specifies whether this object can provide its extender properties to the specified object. + + The Object to receive the extender properties. + true if this object can provide extender properties to the specified object; otherwise, false. + + + + Raises the and event when theme name changed. + + The sender value. + A contains the event data. + + + + Releases the unmanaged resources used by the Component and optionally releases the managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Determines whether the extended property for ToolTip should be serialized or not. + + An object of component. + Returns true when it need to be serialized otherwise return false. + + + + Determines whether the extended property for ToolTip should be serialized or not. + + An object of component. + Returns true when it need to be serialized otherwise return false. + + + + Occurs when the mouse pointer leaves the control. + + The sender that contains the control from which the mouse pointer leaves. + A that contains the event data. + + + + Occurs when the mouse pointer rests on the control. + + The sender that contains the control in which the mouse pointer is hovered. + A that contains the event data. + + + + Occurs when the mouse down event of the control occurs. + + The sender that contains the control in which the mouse down is occurred. + A that contains the event data. + + + + Modifies the tooltip if any information is changed. + + A that contains the event data. + + + + Occurs when the popup delay timer interval has elapsed and the timer is enabled. + + The sender that contains the for tooltip popup delay. + A that contains the event data. + + + + Occurs when the initial delay timer interval has elapsed and the timer is enabled. + + The sender that contains the for tooltip initial delay. + A that contains the event data. + + + + Occurs when the Visible property value changes. + + The sender that contains the tooltip form. + A that contains the event data. + + + + Represents a BaseComponent with VisualStyle based theme customization settings. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + Occurs when theme name of the control has changed. + + + + + Gets or sets the theme name of the control. + + + The default value is null. + + + The theme will be applied only when the particular theme for this control has included the Themes assembly. + + + + + Gets or sets a value indicating whether control elements styles can be overridden by theme style settings. + + Default value is false. + + By default, the control's element styles will not be overridden by theme style settings if the style is set in sample level. + If this property is enabled, element style will be overridden by theme style settings event if it is set in sample level. + This property should be enabled or disabled before calling the ThemeName property of the control. + + + + + Gets or sets the Base Theme name of the theme + + + + + Gets or sets a value indicating whether a theme settings + can be applied to the control. + + The default value is true. + + This property must be initialized before applying the VisualTheme /> + + + + + Gets the name of the control. + + + + + Gets or sets the VisualTheme of the control. + + + + + Gets a value indicating whether the visual style based theme is applied to the control and + also indicates whether the theme files are referred from external assemblies or not. + + Return true, if the visual style based theme is applied to the control. Otherwise returns false. + + + + Raises the event when theme name changed. + + The sender value. + A contains the event data. + + + + Gets the active theme name of the control. + + Returns the active theme name. + + + + Helps to override the ThemeName property settings + + ThemeName + + + + Helps to override the ThemeName property settings + + ThemeName + + + + Helps to override the CanApplyTheme property settings + + CanApplyTheme + + + + Helps to override the CanOverriderStyle property settings + + CanOverriderStyle + + + + Represents a BaseControl with VisualStyle based theme customization settings. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + Occurs when theme name of the control has changed. + + + + + Gets or sets the theme name of the control. + + + The default value is null. + + + This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control. + + + + + Gets or sets a value indicating whether control elements styles can be overridden by theme style settings. + + Default value is false. + + By default, the control's element styles will not be overridden by theme style settings if the style is set in sample level. + If this property is enabled, element style will be overridden by theme style settings event if it is set in sample level. + This property should be enabled or disabled before calling the ThemeName property of the control. + + + + + Gets or sets the Base Theme name of the theme + + + + + Gets or sets a value indicating whether a theme settings + can be applied to the control. + + The default value is true. + + This property must be initialized before applying the VisualTheme /> + + + + + Gets the name of the control. + + + + + Gets or sets the VisualTheme of the control. + + + + + Gets a value indicating whether the visual style based theme is applied to the control and + also indicates whether the theme files are referred from external assemblies or not. + + Return true, if the visual style based theme is applied to the control. Otherwise returns false. + + + + Raises the event when theme name changed. + + The sender value. + A contains the event data. + + + + Gets the active theme name of the control. + + Returns the active theme name. + + + + Helps to override the ThemeName property settings + + ThemeName + + + + Helps to override the ThemeName property settings + + ThemeName + + + + Helps to override the CanApplyTheme property settings + + CanApplyTheme + + + + Helps to override the CanOverriderStyle property settings + + CanOverriderStyle + + + + Class for Custom Button + + + + + Gets/Sets if this is Custom Buttons + + + + + Class for MessageBoxMetroStyleFormAdv + + + + + Lock Window update function + + + + + Gets the horizontal padding + + + + + Gets the vertical padding + + + + + detailButtonSpace control using for increase the space in flow layout panel inbetween the detail button and message box buttons in while resizing. + + + + + Enumeration for system defined strings + + + + + Holds the height of the before the detail view is collapsed. + + + + + Holds the height of the before the detail view expand. + + + + + Holds the Button height + + + + + + + Custom Button Collection + + + + + Defines the CustomButton ForeColor + + + + + Defines the CustomButton BackColor + + + + + Variable for buttons panel + + + + + Variable for ok ButtonAdv + + + + + Variable for cancel ButtonAdv + + + + + Variable for yes ButtonAdv + + + + + Variable for ignore ButtonAdv + + + + + Variable for retry ButtonAdv + + + + + Variable for abort ButtonAdv + + + + + Variable for no ButtonAdv + + + + + Variable for no ButtonAdv + + + + + Variable for no ButtonAdv + + + + + Gets MessageBoxButtons + + + + + Gets Custom MessageBox Buttons + + + + + Gets MessageBoxIcon + + + + + Gets MessageBoxDefaultButton + + + + + Gets MessageBoxOptions + + + + + Variable for owner + + + + + Variable for CancelEventHandler + + + + + Static variable for buttons + + + + + Static variable for s_buttonNames + + + + + Static variable for System defined strings + + + + + Constructor for MessageBoxMetroStyleFormAdv + + + + + Constructor for MessageBoxMetroStyleFormAdv + + + + + Method to set same width for all Buttons in the MessageBoxAdv + + Collection of buttons + Greater width + + + + + Method to calculate the height of the panel of MessageBoxAdv + + Panel height + + + + Initializes the new instance for MessageBoxMetroStyleFormAdv class. + + owner window + text + form caption + buttons + form icon + default button + options + to show helpbutton + click event data + image + sizing image + + + + Variable which indicates whether custom buttons are already initialized or not + + + + + Initializes the new instance for MessageBoxMetroStyleFormAdv class. + + owner window + text + form caption + buttons + form icon + default button + options + to show helpbutton + click event data + image + sizing image + + + + Initializes the new instance for MessageBoxMetroStyleFormAdv class. + + owner window + text + form caption + buttons + form icon + default button + options + to show helpbutton + click event data + + + + Initialization of button names + + + + + Custom Button Initialization + + + + + Click Event for Custom Buttons + + + + + Button Initialization + + + + + Returns the button for the dialog + + + + + + Initialize image which is used in MessageBoxAdv + + + + + + + Icon Initialization + + Icon + + + + Initialize the TextAlign + + + + + Helps to apply the Font Settings to Custom Buttons + + + + + Helps to apply the Font Settings to built buttons + + + + + Custom Button Size initialization + + + + + + + + Size initialization + + + + + Gets or sets whether the image is showing + + + + + Method to get the button + + + + + + + Sets the padding for the buttons + + + + + + + Returns the client size + + + Size + + + + Returns the Button width + + + + + + Returns the Button width + + + + + + Returns the system defined strings + + + + + + + Gets the button operations + + + + + Raises the event. + + An that contains the event data. + + + + Method to set the cursor position + + + + + Raises the event. + + An that contains the event data. + + + + Raises the event. + + An that contains the event data. + + + + Raises the event. + + An that contains the event data. + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Validate the messagebox height in while initialize the control + + + + + Handle the size of the message box while closing and expanding the details view. + + + + + Class for Office2010StyleMessageBoxAdv + + + Class for Office2010StyleMessageBoxAdv. + + + + + Initializes the new instance for Office2010StyleMessageBoxAdv class + + + + + Method to set same width for all Buttons in the MessageBoxAdv + + Collection of buttons + Greater width + + + + + Method to calculate the height of the panel of MessageBoxAdv + + Panel height + + + + Initializes the new instance for Office2010StyleMessageBoxAdv class + + + + + Lock Window update function + + + + + Gets the horizontal padding + + + + + Gets the vertical padding + + + + + Enumeration for system defined strings + + + + + Holds the height of the before the detail view is collapsed. + + + + + Holds the height of the before the detail view expand. + + + + + detailButtonSpace control using for increase the space in flow layout panel inbetween the detail button and message box buttons in while resizing. + + + + + Holds the Button height + + + + + String variable for details text + + + + + Variable for no ButtonAdv + + + + + Variable for no ButtonAdv + + + + + + Custom Button Collection + + + + + Variable for content panel + + + + + Variable for buttons panel + + + + + Variable for ok ButtonAdv + + + + + Variable for cancel ButtonAdv + + + + + Variable for yes ButtonAdv + + + + + Variable for ignore ButtonAdv + + + + + Variable for retry ButtonAdv + + + + + Variable for abort ButtonAdv + + + + + Variable for no ButtonAdv + + + + + Variable for PictureBox + + + + + Variable for Label + + + + + Gets MessageBoxButtons + + + + + Gets Custom MessageBox Buttons + + + + + Gets MessageBoxIcon + + + + + Gets MessageBoxDefaultButton + + + + + Gets MessageBoxOptions + + + + + Variable for owner + + + + + Variable for CancelEventHandler + + + + + Static variable for buttons + + + + + Static variable for s_buttonNames + + + + + Static variable for System defined strings + + + + + Initializes the new instance for MessageBoxMetroStyleFormAdv class. + + owner window + text + form caption + buttons + form icon + default button + options + to show helpbutton + click event data + image + sizing image + + + + Variable which indicates whether custom buttons are already initialized or not + + + + + Initializes the new instance for Office2010StyleMessageBoxAdv. + + owner window + text + form caption + buttons + form icon + default button + options + to show helpbutton + click event data + image + sizing image + + + + Method to change the arrow color of the image. + + the bitmap of image after changing the arrow color + + + + Initializes the new instance for Office2010StyleMessageBoxAdv. + + owner window + text + form caption + buttons + form icon + default button + options + to show helpbutton + click event data + + + + Custom Button Initialization + + + + + Click Event for Custom Buttons + + + + + Custom Button Size initialization + + + + + Returns the Button width + + + + + + Initialization of button names + + + + + Button Initialization + + + + + Returns the button for the dialog + + Return value of a dialog box. + + + + Initialize image which is used in MessageBoxAdv + + Image which is used in MessageBoxAdv + Width of the Button + + + + Icon Initialization + + Icon + + + + Initialize the TextAlign + + + + + Size initialization + + + + + Gets or sets whether the image is showing + + + + + Helps to apply the Font Settings to Custom Buttons + + + + + Helps to apply the Font Settings to built buttons + + + + + + + + Method to get the button + + Specifies identifiers to indicate the return value of a dialog box. + ButtonAdv + + + + Sets the padding for the Button + + Size of the Button + Width of the Button + + + + Returns the client size + + Size of the Text + Size + + + + Returns the Button width + + Width of the Button + + + + Returns the system defined strings + + Specifies identifiers to indicate the return value of a dialog box. + String value + + + + Gets the button operations + + + + + Raises the event. + + An that contains the event data. + + + + Method to set the cursor position + + + + + Raises the event. + + An that contains the event data. + + + + Raises the event. + + An that contains the event data. + + + + Raises the event. + + An that contains the event data. + + + + This will be called in a "pure .net app". + + Implements a Windows message. + true to filter the message and stop it from being dispatched; false to allow + the message to continue to the next filter or control. + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Occurs when the mouse pointer leaves the control + + The sender that contains the control in which the mouse pointer is leaved + that contains the event data. + + + + Occurs when the mouse pointer rests on the control. + + The sender that contains the control in which the mouse pointer is hovered + that contains the event data. + + + + Validate the messagebox height in while initialize the control + + + + + Handle the size of the message box while closing and expanding the details view. + + + + + Class for ButtonAdv with Border customization + + + + + Constructor + + + + + Variable to define whether this is Custom Button + + + + + Gets/Sets whether this is Custom Button + + + + + Instance to hold the BorderColor + + + + + Gets/Sets option to customize the BorderColor + + + + + Paint Overrides + + + + + + Class for Office2013StyleMessageBoxAdv + + + Class for Office2013StyleMessageBoxAdv. + + + + + Initializes the new instance for Office2010StyleMessageBoxAdv class + + + + + Initializes the new instance for Office2013StyleMessageBoxAdv class + + + + + Method to set same width for all Buttons in the MessageBoxAdv + + Collection of buttons + Greater width + + + + + Method to calculate the height of the panel of MessageBoxAdv + + Panel height + + + + Initializes the new instance for Office2013StyleMessageBoxAdv. + + owner window + text + form caption + buttons + form icon + default button + options + to show helpbutton + click event data + image + sizing image + + + + Initializes the new instance for Office2013StyleMessageBoxAdv. + + owner window + text + form caption + buttons + form icon + default button + options + to show helpbutton + click event data + + + + Gets the horizontal padding + + + + + Gets the vertical padding + + + + + detailButtonSpace control using for increase the space in flow layout panel inbetween the detail button and message box buttons in while resizing. + + + + + Enumeration for system defined strings + + + + + Holds the height of the before the detail view is collapsed. + + + + + Holds the height of the before the detail view expand. + + + + + Holds the Button height + + + + + + + Custom Button Collection + + + + + Defines the CustomButton ForeColor + + + + + Defines the CustomButton BackColor + + + + + Variable for ok ButtonAdv + + + + + Variable for cancel ButtonAdv + + + + + Variable for yes ButtonAdv + + + + + Variable for ignore ButtonAdv + + + + + Variable for retry ButtonAdv + + + + + Variable for abort ButtonAdv + + + + + Variable for no ButtonAdv + + + + + Variable for Label + + + + + Gets MessageBoxButtons + + + + + Gets Custom MessageBox Buttons + + + + + Gets MessageBoxIcon + + + + + Gets MessageBoxDefaultButton + + + + + Gets MessageBoxOptions + + + + + Variable for owner + + + + + Variable for CancelEventHandler + + + + + Variable which indicates whether custom buttons are already initialized or not + + + + + Static variable for buttons + + + + + Static variable for s_buttonNames + + + + + Static variable for System defined strings + + + + + CustomButtons Mouse Down + + + + + + + Occurs when the mouse pointer leaves the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer enters the control. + + sender object + EventArgs which contains EventData + + + + Initialization of button names + + + + + Custom Button Initialization + + + + + Click Event for Custom Buttons + + + + + Button Initialization + + + + + Returns the button for the dialog + + Returns value of the Dialog Box + + + + Initialize image which is used in MessageBoxAdv + + Image which is used in MessageBoxAdv + Size of the Image + + + + Icon Initialization + + Icon + + + + CustomButtons Mouse Down + + + + + Custom Button Size initialization + + + + + Size initialization + + + + + Gets or sets whether the image is showing + + + + + Helps to apply the Font Settings to Custom Buttons + + + + + + + + Helps to apply the Font Settings to built buttons + + + + + Method to get the button + + Specifies identifiers to indicate the return value of a dialog box. + ButtonAdv + + + + Sets the padding for the Button + + Size of the Button + Width of the Button + + + + Returns the client size + + Size of the Text + Size + + + + Returns the Button width + + + + + + Returns the Button width + + + + + + Returns the system defined strings + + Specifies identifiers to indicate the return value of a dialog box. + String value + + + + Gets the button operations + + + + + Raises the event. + + An that contains the event data. + + + + Method to set the cursor position + + + + + Raises the event. + + An that contains the event data. + + + + Raises the event. + + An that contains the event data. + + + + Raises the event. + + An that contains the event data. + + + + Initializes the s_office2013theme variable. + + + + + Gets or sets the Office2013 color theme. + + + + + This will be called in a "pure .net app". + + Implements a Windows message. + true to filter the message and stop it from being dispatched; false to allow + the message to continue to the next filter or control. + + + + Required designer variable. + + + + + Clean up any resources being used. + + True if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Validate the messagebox height in while initialize the control + + + + + Handle the size of the message box while closing and expanding the details view. + + + + + Initializes the bordercolor variable. + + + + + Occurs when the control is redrawn. + + Object sender + PaintEventArgs which contains EventData + + + + Occurs when the control is redrawn. + + Object sender + PaintEventArgs which contains EventData + + + + Occurs when the control is redrawn. + + Object sender + PaintEventArgs which contains EventData + + + + Occurs when the control is redrawn. + + Object sender + PaintEventArgs which contains EventData + + + + Occurs when the control is redrawn. + + Object sender + PaintEventArgs which contains EventData + + + + Occurs when the control is redrawn. + + Object sender + PaintEventArgs which contains EventData + + + + Occurs when the control is redrawn. + + Object sender + PaintEventArgs which contains EventData + + + + Occurs when the mouse pointer is over the control and a mouse button is pressed. + + Object sender + MouseEventArgs which contains Event Data + + + + Occurs when the mouse pointer is over the control and a mouse button is pressed. + + Object sender + MouseEventArgs which contains Event Data + + + + Occurs when the mouse pointer is over the control and a mouse button is pressed. + + Object sender + MouseEventArgs which contains Event Data + + + + Occurs when the mouse pointer is over the control and a mouse button is pressed. + + Object sender + MouseEventArgs which contains Event Data + + + + Occurs when the mouse pointer is over the control and a mouse button is pressed. + + Object sender + MouseEventArgs which contains Event Data + + + + Occurs when the mouse pointer is over the control and a mouse button is pressed. + + Object sender + MouseEventArgs which contains Event Data + + + + Occurs when the mouse pointer is over the control and a mouse button is pressed. + + Object sender + MouseEventArgs which contains Event Data + + + + Occurs when the mouse pointer is over the control and a mouse button is pressed. + + Object sender + MouseEventArgs which contains Event Data + + + + Occurs when the control is redrawn. + + Object sender + PaintEventArgs which contains EventData + + + + Occurs when the mouse pointer leaves the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer enters the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer leaves the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer enters the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer leaves the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer enters the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer leaves the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer enters the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer leaves the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer enters the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer leaves the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer enters the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer leaves the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer enters the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer leaves the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer enters the control. + + sender object + EventArgs which contains EventData + + + + Class for Office2016StyleMessageBoxAdv. + + + Class for Office2013StyleMessageBoxAdv. + + + + + Initializes the new instance for Office2016StyleMessageBoxAdv class. + + + + + Initializes the new instance for Office2016StyleMessageBoxAdv class. + + + + + Method to calculate the height of the panel of MessageBoxAdv + + Panel height + + + + Initializes the new instance for Office2016StyleMessageBoxAdv. + + owner window + text + form caption + buttons + form icon + default button + options + to show helpbutton + click event data + image + sizing image + + + + Initializes the new instance for Office2013StyleMessageBoxAdv. + + owner window + text + form caption + buttons + form icon + default button + options + to show helpbutton + click event data + + + + Gets the horizontal padding + + + + + Gets the vertical padding + + + + + detailButtonSpace control using for increase the space in flow layout panel inbetween the detail button and message box buttons in while resizing. + + + + + Enumeration for system defined strings + + + + + Holds the height of the before the detail view is collapsed. + + + + + Holds the height of the before the detail view expand. + + + + + Holds the Button height + + + + + + + Custom Button Collection + + + + + Defines the CustomButton ForeColor + + + + + Defines the CustomButton BackColor + + + + + Variable for ok ButtonAdv + + + + + Variable for cancel ButtonAdv + + + + + Variable for yes ButtonAdv + + + + + Variable for ignore ButtonAdv + + + + + Variable for retry ButtonAdv + + + + + Variable for abort ButtonAdv + + + + + Variable for no ButtonAdv + + + + + Variable for Label + + + + + Gets MessageBoxButtons + + + + + Gets Custom MessageBox Buttons + + + + + Gets MessageBoxIcon + + + + + Gets MessageBoxDefaultButton + + + + + Gets MessageBoxOptions + + + + + Variable for owner + + + + + Variable for CancelEventHandler + + + + + Variable which indicates whether custom buttons are already initialized or not + + + + + Static variable for buttons + + + + + Static variable for s_buttonNames + + + + + Static variable for System defined strings + + + + + CustomButtons Mouse Down + + + + + + + Occurs when the mouse pointer leaves the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer enters the control. + + sender object + EventArgs which contains EventData + + + + Initialization of button names + + + + + Custom Button Initialization + + + + + Click Event for Custom Buttons + + + + + Method to set same width for all Buttons in the MessageBoxAdv + + Collection of buttons + Greater width + + + + + Button Initialization + + + + + Returns the button for the dialog + + Returns value of the Dialog Box + + + + Initialize image which is used in MessageBoxAdv + + Image which is used in MessageBoxAdv + Size of the Image + + + + Icon Initialization + + Icon + + + + CustomButtons Mouse Down + + + + + Custom Button Size initialization + + + + + Size initialization + + + + + Gets or sets whether the image is showing + + + + + Helps to apply the Font Settings to Custom Buttons + + + + + Helps to apply the Font Settings to built buttons + + + + + + + + Method to get the button + + Specifies identifiers to indicate the return value of a dialog box. + ButtonAdv + + + + Sets the padding for the Button + + Size of the Button + Width of the Button + + + + Returns the client size + + Size of the Text + Size + + + + Returns the Button width + + + + + + Returns the Button width + + + + + + Returns the system defined strings + + Specifies identifiers to indicate the return value of a dialog box. + String value + + + + Gets the button operations + + + + + Raises the event. + + An that contains the event data. + + + + Method to set the cursor position + + + + + Raises the event. + + An that contains the event data. + + + + Raises the event. + + An that contains the event data. + + + + Raises the event. + + An that contains the event data. + + + + Initializes the s_office2016theme variable. + + + + + Gets or sets the Office2016 color theme. + + + + + This will be called in a "pure .net app". + + Implements a Windows message. + true to filter the message and stop it from being dispatched; false to allow + the message to continue to the next filter or control. + + + + Required designer variable. + + + + + Clean up any resources being used. + + True if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Validate the messagebox height in while initialize the control + + + + + Handle the size of the message box while closing and expanding the details view. + + + + + Initializes the bordercolor variable. + + + + + Occurs when the control is redrawn. + + Object sender + PaintEventArgs which contains EventData + + + + Occurs when the control is redrawn. + + Object sender + PaintEventArgs which contains EventData + + + + Occurs when the control is redrawn. + + Object sender + PaintEventArgs which contains EventData + + + + Occurs when the control is redrawn. + + Object sender + PaintEventArgs which contains EventData + + + + Occurs when the control is redrawn. + + Object sender + PaintEventArgs which contains EventData + + + + Occurs when the control is redrawn. + + Object sender + PaintEventArgs which contains EventData + + + + Occurs when the control is redrawn. + + Object sender + PaintEventArgs which contains EventData + + + + Occurs when the mouse pointer is over the control and a mouse button is pressed. + + Object sender + MouseEventArgs which contains Event Data + + + + Occurs when the mouse pointer is over the control and a mouse button is pressed. + + Object sender + MouseEventArgs which contains Event Data + + + + Occurs when the mouse pointer is over the control and a mouse button is pressed. + + Object sender + MouseEventArgs which contains Event Data + + + + Occurs when the mouse pointer is over the control and a mouse button is pressed. + + Object sender + MouseEventArgs which contains Event Data + + + + Occurs when the mouse pointer is over the control and a mouse button is pressed. + + Object sender + MouseEventArgs which contains Event Data + + + + Occurs when the mouse pointer is over the control and a mouse button is pressed. + + Object sender + MouseEventArgs which contains Event Data + + + + Occurs when the mouse pointer is over the control and a mouse button is pressed. + + Object sender + MouseEventArgs which contains Event Data + + + + Occurs when the mouse pointer is over the control and a mouse button is pressed. + + Object sender + MouseEventArgs which contains Event Data + + + + Occurs when the control is redrawn. + + Object sender + PaintEventArgs which contains EventData + + + + Occurs when the mouse pointer leaves the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer enters the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer leaves the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer enters the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer leaves the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer enters the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer leaves the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer enters the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer leaves the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer enters the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer leaves the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer enters the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer leaves the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer enters the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer leaves the control. + + sender object + EventArgs which contains EventData + + + + Occurs when the mouse pointer enters the control. + + sender object + EventArgs which contains EventData + + + + It contains the value of the property. + + + + + Gets the default style values for + + + + + Gets or sets the font for DetailsView. + + + + + Gets or sets the background color for TitleBar. + + + + + Gets or sets the background color for TitleBar. + + + + + Gets or sets the fore color for TitleBar. + + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + It contains the value of the property. + + + + + Gets the default style values for + + + + + Gets or sets the Font for TitleBar. + + + + + Gets or sets the background color for TitleBar. + + + + + Gets or sets the fore color for TitleBar. + + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Holds instance of a class. + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + Holds instance of a class + + + + Gets the default style value for + + + + + Gets or sets the Font for MessageBoxAdv. + + + + + Gets or sets fore color for MessageBoxAdv. + + + + + Gets or sets the background color for MessageBoxAdv. + + + + + Gets or sets the border color for MessageBoxAdv. + + + + + Gets or sets the value for styles. + + + + + Gets or sets the value for styles. + + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + Displays a message box with Office2007 style that can contain text, buttons, and symbols that inform and instruct the user. + + + + + It contains the value of the property. + + + + + + Gets or sets the value used to customize the appearance of the . + + + This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control. + + + + + Gets or sets the theme name of the control. + + + The default value is null. + + + This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control. + + + + + Initializes the s_office10theme variable. + + + + + Initializes the m_CaptionAlign variable. + + + + + Initializes the m_Size variable. + + + + + holds to Details Text + + + + + Variable for Style + + + + + Variable to notify MessageBox is Opened or not, Should be open only one MessageBoxAdv at a time. + + + + + Specifies the style in which controls will appear and behave. + + + + + Default appearance + + + + + Office2010Form appearance + + + + + Office2013 appearance + + + + + Metro appearance + + + + + Office2016 appearance + + + + + Specifies the title alignment of MessageBoxAdv. + + Default caption alignment is Left. + + This property is not applicaple when enabling ApplyAeroTheme property in Default Style. + + + + + Specifies the Maximum Size of MessageBoxAdv. + + + + + Variable to specify the Shadow effect of the MessageBox. + + + + + Specifies the Shadow effect of the MessageBox. + + + + + + Variable to specify the Layout of the MessageBoxAdv. + + + + + Gets or sets a value indicating whether control's elements are aligned to Right-To-Left or Left-To-Right Layout + + + + + + Variable to specify the Font for Button options + + + + + Gets or sets the Button option Font + + + + + Variable to specify the Font for Message information. + + + + + Gets or sets the Message Font + + + + + Gets or sets the Message Font + + + + + Gets or sets the Caption Font + + + + + Gets or sets the Details Font + + + + + Gets or sets the Details Font + + + + + Variable to specify the default backcolor of the MessageBoxAdv. + + + + + Specifies the default backcolor of the MessageBoxAdv. + + + + + Helps to specify whether the MessageBoxStyle is changed at sample level or not. + + + + + Gets or sets a value indicating the style used for drawing the control + + + + + Gets or sets value to determine whether can be resized. + + + + + Variable for MetroColorTable + + + + + Color table to customize the buttons,captions and text color in MessageBoxAdv + + + + + Gets or sets the Office2007 theme, which is used to show message boxes. + + The Office2007 theme. + + + + Gets or sets the Office2010 color theme. + + + + + Initializes the s_office2013theme variable. + + + + + Gets or sets the Office2013 color theme. + + + + + Initializes the s_Office2016Theme variable. + + + + + Gets or sets the Office2016 color theme. + + + + + Gets or sets whehter to apply AeroTheme in Default MessageBoxStyle. + + + + + Gets or sets whehter to apply AeroTheme in Default MessageBoxStyle. + + + + + Displays a message box with specified text. + + The text to display in the message box. + + One of the values. + + + + + Displays a message box with specified text and caption. + + The text to display in the message box. + The text to display in the title bar of the message box. + + One of the values. + + + + + Displays a message box in front of the specified object and with the specified text. + + The owner. + The text. + + One of the values. + + + + + Displays a message box with specified text, caption, and buttons. + + The text to display in the message box. + The text to display in the title bar of the message box. + One of the values that specifies which buttons to display in the message box. + + One of the values. + + + + + Displays a message box in front of the specified object and with the specified text and caption. + + An implementation of that will own the modal dialog box. + The text to display in the message box. + The text to display in the title bar of the message box. + + One of the values. + + + + + Displays a message box with specified text, caption, buttons, and icon. + + The text to display in the message box. + The text to display in the title bar of the message box. + One of the values 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 a message box with specified text, caption, buttons, and icon. + + The text to display in the message box. + The text to display in the title bar of the message box. + One of the values that specifies which buttons to display in the message box. + The image used instead of system icon. + Size of the image. If empty, original image size is used. + + One of the values. + + + + + Displays a message box in front of the specified object and with the specified text, caption, and buttons. + + The owner. + The text to display in the message box. + The caption. + One of the values that specifies which buttons to display in the message box. + + One of the values. + + + + + To Show MessageBoxAdv + + Form + MessageBoxAdv Text + MessageBoxAdv Caption + Custom Buttons Collection + Image to be displayed in MessageBoxAdv + Size of the Image + Selected Button Index + + + + To Show MessageBoxAdv + + MessageBoxAdv Text + MessageBoxAdv Caption + Custom Buttons Collection + Image to be displayed in MessageBoxAdv + Size of the Image + Selected Button Index + + + + To Show MessageBoxAdv + + Form + MessageBoxAdv Text + MessageBoxAdv Caption + Custom Buttons Collection + Icon to be displayed in MessageBoxAdv + Selected Button Index + + + + To Show MessageBoxAdv + + MessageBoxAdv Text + MessageBoxAdv Caption + Custom Buttons Collection + Icon to be displayed in MessageBoxAdv + Selected Button Index + + + + To Show MessageBoxAdv + + MessageBoxAdv Text + MessageBoxAdv Caption + Custom Buttons Collection + + + + To Show MessageBoxAdv + + Form + MessageBoxAdv Text + MessageBoxAdv Caption + Custom Buttons Collection + + + + To calculate the Index + + Parent Form + Message Text + Message Caption + Custom Buttons Collection + MessageIcon + Default Button + MessageBoxAdv Option + To show the help option + + + + + To calculate the Index + + Parent Form + Message Text + Message Caption + Custom Buttons Collection + MessageIcon + Default Button + MessageBoxAdv Option + To show the help option + To get the CancelEventHandler + + + + To display the MessageBoxAdv + + Parent Form + MessageBoxAdv Text + MessageBoxAdv Caption + Custom Buttons + MessageBoxAdv Icons + MessageBoxAdv Default Button + MessageBoxAdv Option + To show / hide the Help option + HelpButtonClickEventHandler + Image to be displayed in MessageBoxAdv + Size of image to be displayed in MessageBoxAdv + + + + + Method to get the image from specifed folder + + Image to retrive from the folder + Bitmap image + + + + Method to get the width of the button + + ButtonAdv + Graphics variable + Width of the button + + + + Displays a message box with the specified text, caption, buttons, icon, and default button. + + The text to display in the message box. + The text to display in the title bar of the message box. + One of the values 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 a message box with the specified text, caption, buttons, icon, and default button. + + The text to display in the message box. + The text to display in the title bar of the message box. + One of the values that specifies which buttons to display in the message box. + The image used instead of system icon. + Size of the image. If empty, original image size is used. + One of the values that specifies the default button for the message box. + + One of the values. + + + + + Displays a message box in front of the specified object and with the specified text, caption, buttons, and icon. + + The owner. + The text. + The caption. + The buttons. + The icon. + + One of the values. + + + + + Displays a message box in front of the specified object and with the specified text, caption, buttons, and icon. + + The owner. + The text. + The caption. + The buttons. + The image used instead of system icon. + Size of the image. If empty, original image size is used. + + One of the values. + + + + + Displays a message box with the specified text, caption, buttons, icon, default button, and options. + + The text to display in the message box. + The text to display in the title bar of the message box. + One of the values 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 that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults. + + One of the values. + + + + + Displays a message box with the specified text, caption, buttons, icon, default button, and options. + + The text to display in the message box. + The text to display in the title bar of the message box. + One of the values that specifies which buttons to display in the message box. + The image used instead of system icon. + Size of the image. If empty, original image size is used. + One of the values that specifies the default button for the message box. + One of the values that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults. + + One of the values. + + + + + Displays a message box in front of the specified object and with the specified text, caption, buttons, icon, and default button. + + The owner. + The text to display in the message box. + The caption. + One of the values that specifies which buttons to display in the message box. + The icon. + One of the values that specifies the default button for the message box. + + One of the values. + + + + + Displays a message box in front of the specified object and with the specified text, caption, buttons, icon, and default button. + + The owner. + The text to display in the message box. + The caption. + One of the values that specifies which buttons to display in the message box. + The image used instead of system icon. + Size of the image. If empty, original image size is used. + One of the values that specifies the default button for the message box. + + One of the values. + + + + + Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button. + + The text to display in the message box. + The text to display in the title bar of the message box. + One of the values 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 that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults. + true to show the Help button; otherwise, false. The default is false. + + One of the values. + + + + + Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button. + + The text to display in the message box. + The text to display in the title bar of the message box. + One of the values that specifies which buttons to display in the message box. + The image used instead of system icon. + Size of the image. If empty, original image size is used. + One of the values that specifies the default button for the message box. + One of the values that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults. + true to show the Help button; otherwise, false. The default is false. + + One of the values. + + + + + Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button, using the specified Help file. + + The text to display in the message box. + The text to display in the title bar of the message box. + One of the values 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 that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults. + The help button click handler. + + One of the values. + + + + + Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button, using the specified Help file. + + The text to display in the message box. + The text to display in the title bar of the message box. + One of the values that specifies which buttons to display in the message box. + The image used instead of system icon. + Size of the image. If empty, original image size is used. + One of the values that specifies the default button for the message box. + One of the values that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults. + The help button click handler. + + One of the values. + + + + + Displays a message box in front of the specified object and with the specified text, caption, buttons, icon, default button, and options. + + The owner. + The text. + The caption. + The buttons. + The icon. + One of the values the specifies the default button for the message box. + The options. + + One of the values. + + + + + Displays a message box in front of the specified object and with the specified text, caption, buttons, icon, default button, and options. + + The owner. + The text. + The caption. + The buttons. + The image used instead of system icon. + Size of the image. If empty, original image size is used. + One of the values the specifies the default button for the message box. + The options. + + One of the values. + + + + + + + + + + + + + + + + + + + + + + + + + Class for VisualStyle based theme. + + + + + Holds the Button height + + + + + + + Custom Button Collection + + + + + Defines the CustomButton ForeColor + + + + + Defines the CustomButton BackColor + + + + + Variable for ok ButtonAdv + + + + + Variable for cancel ButtonAdv + + + + + Variable for yes ButtonAdv + + + + + Variable for ignore ButtonAdv + + + + + Variable for retry ButtonAdv + + + + + Variable for abort ButtonAdv + + + + + Variable for no ButtonAdv + + + + + Variable for Label + + + + + Gets MessageBoxButtons + + + + + Gets Custom MessageBox Buttons + + + + + Gets MessageBoxIcon + + + + + Gets MessageBoxDefaultButton + + + + + Gets MessageBoxOptions + + + + + Variable for owner + + + + + detailButtonSpace control using for increase the space in flow layout panel inbetween the detail button and message box buttons in while resizing. + + + + + Holds the height of the before the detail view is collapsed. + + + + + Holds the height of the before the detail view expand. + + + + + Variable for CancelEventHandler + + + + + Variable which indicates whether custom buttons are already initialized or not + + + + + Static variable for buttons + + + + + Static variable for s_buttonNames + + + + + Static variable for System defined strings + + + + + Gets the horizontal padding + + + + + Gets the vertical padding + + + + + Enumeration for system defined strings + + + + + Initializes the new instance for Office2016StyleMessageBoxAdv. + + owner window + text + form caption + buttons + form icon + default button + options + to show helpbutton + click event data + image + sizing image + + + + Initializes the new instance for VisualStyleMessageBoxAdv. + + owner window + text + form caption + buttons + form icon + default button + options + to show helpbutton + click event data + + + + Method to calculate the height of the panel of MessageBoxAdv + + Panel height + + + + Initialization of button names + + + + + Custom Button Initialization + + + + + Click Event for Custom Buttons + + + + + Method to set same width for all Buttons in the MessageBoxAdv + + Collection of buttons + Greater width + + + + + Button Initialization + + + + + Returns the button for the dialog + + Returns value of the Dialog Box + + + + Initialize image which is used in MessageBoxAdv + + Image which is used in MessageBoxAdv + Size of the Image + + + + Icon Initialization + + Icon + + + + CustomButtons Mouse Down + + + + + Gets or sets whether the image is showing + + + + + Custom Button Size initialization + + + + + Size initialization + + + + + Helps to apply the Font Settings to Custom Buttons + + + + + Helps to apply the Font Settings to built buttons + + + + + + + + Method used to set location for close button. + + + + + Method to get the button + + Specifies identifiers to indicate the return value of a dialog box. + ButtonAdv + + + + Sets the padding for the Button + + Size of the Button + Width of the Button + + + + Returns the client size + + Size of the Text + Size + + + + Returns the Button width + + + + + + Returns the Button width + + + + + + Returns the system defined strings + + Specifies identifiers to indicate the return value of a dialog box. + String value + + + + Gets the button operations + + + + + Raises the event. + + An that contains the event data. + + + + Method to set the cursor position + + + + + Raises the event. + + An that contains the event data. + + + + Raises the event. + + An that contains the event data. + + + + Raises the event. + + An that contains the event data. + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Validate the messagebox height in while initialize the control + + + + + Handle the size of the message box while closing and expanding the details view. + + + + + Initializes the bordercolor variable. + + + + + Advanced caption image for Metro form + + + + + location for CaptionImage + + + + + image for CaptionImage + + + + + size for CaptionImage + + + + + backcolor for CaptionImage + + + + + Font for CaptionImage + + + + + forecolor for CaptionImage + + + + + Constructor for FormCaptionImage + + + + + + + + + + + Mouse move delegate for CaptionImage + + + + + Mouse move event for CaptionImage + + + + + Mouse leave delegate for CaptionImage + + + + + Mouse leave event for CaptionImage + + + + + Mouse enter delegate for CaptionImage + + + + + Mouse enter event for CaptionImage + + + + + Mouse down delegate for CaptionImage + + + + + + Mouse down delegate for CaptionImage + + + + + Mouse up delegate for CaptionImage + + + + + + Mouse up delegate for CaptionImage + + + + + Mouse move event for CaptionImage + + + + + Mouse leave event for CaptionImage + + + + + Mouse enter event for CaptionImage + + + + + Mouse down event for CaptionImage + + + + + Mouse up event for CaptionImage + + + + + Gets/sets the value for location + + + + + Gets/Sets the value for Image + + + + + Gets/Sets the value for CaptionImage size + + + + + Gets/Sets the value for backcolor + + + + + Gets or Sets the instance name + + + + + Gets/Sets the value for forecolor + + + + + Indicates whether the current value of the backcolor property is to be serialized. + + + + + Resets the BackColor. + + + + + Indicates whether the current value of the forecolor property is to be serialized. + + + + + Resets the BackColor. + + + + + Indicates whether the current value of the Size property is to be serialized. + + + + + Resets the Size. + + + + + Indicates whether the current value of the image property is to be serialized. + + + + + Resets the image. + + + + + Indicates whether the current value of the location property is to be serialized. + + + + + Resets the location. + + + + + Collection of Images used in the Form Caption + + + + + Constructor for CaptionImageCollection + + + + + Gets the index of for the CaptionImage + + + + + Returns whether the list contains the CaptionImage type + + + + + Adds the CaptionImage type to the list + + + + + Removes the CaptionImage type from the list + + + + + Inserts the CaptionImage type into the list + + + + + Returns the index of the CaptionImage type + + + + + searches the name in the list + + + + + Overrides the oninsert method + + + + + Gets the unique name + + + + + Mouse Move events for caption image + + + + + Constructor for ImageMouseLeaveEventArgs + + Owner for the events + Image for caption image + BackColor for caption image + Location for caption image + Size of the caption image + ForeColor for caption image + Mouse points in X-co ordinate + Mouse points in Y-co ordinate + + + + Owner for the events + + + + + ForeColor for caption image + + + + + Gets/Sets the value for forecolor + + + + + Size of the caption image + + + + + Gets/Sets the value for size + + + + + BackColor for caption image + + + + + Gets/Sets the value for backcolor + + + + + Location for the caption image + + + + + Gets/Sets the value for Location + + + + + Constructor for ImageMouseEnterEventArgs + + Owner for the events + Image for caption image + BackColor for caption image + Location for caption image + Size of the caption image + ForeColor for caption image + Mouse points in X-co ordinate + Mouse points in Y-co ordinate + + + + Owner for the events + + + + + ForeColor for caption image + + + + + Gets/Sets the value for forecolor + + + + + Size of the caption image + + + + + Gets/Sets the value for size + + + + + BackColor for caption image + + + + + Gets/Sets the value for backcolor + + + + + Location for the caption image + + + + + Gets/Sets the value for Location + + + + + Constructor for ImageMouseMoveEventArgs + + Owner for the events + Image for caption image + BackColor for caption image + Location for caption image + Size of the caption image + ForeColor for caption image + Mouse points in X-co ordinate + Mouse points in Y-co ordinate + + + + Owner for the events + + + + + ForeColor for caption image + + + + + Gets/Sets the value for forecolor + + + + + Size of the caption image + + + + + Gets/Sets the value for size + + + + + BackColor for caption image + + + + + Gets/Sets the value for backcolor + + + + + Location for the caption image + + + + + Gets/Sets the value for Location + + + + + Mouse Up events for caption image + + + + + Constructor for ImageMouseUpEventArgs + + Owner for the events + Image for caption image + BackColor for caption image + Font for caption image + Location for caption image + Size of the caption image + ForeColor for caption image + Mouse points in X-co ordinate + Mouse points in Y-co ordinate + + + + Owner for the events + + + + + ForeColor for caption image + + + + + Gets/Sets the value for forecolor + + + + + Size of the caption image + + + + + Gets/Sets the value for size + + + + + BackColor for caption image + + + + + Gets/Sets the value for backcolor + + + + + Location for the caption image + + + + + Gets/Sets the value for Location + + + + + Mouse Down events for caption image + + + + + Constructor for ImageMouseDownEventArgs + + Owner for the events + Image for caption image + BackColor for caption image + Location for caption image + Size of the caption image + ForeColor for caption image + Mouse points in X-co ordinate + Mouse points in Y-co ordinate + + + + Owner for the events + + + + + Image for caption image + + + + + Gets/Sets the value for Image + + + + + ForeColor for caption image + + + + + Gets/Sets the value for forecolor + + + + + Size of the caption image + + + + + Gets/Sets the value for size + + + + + BackColor for caption image + + + + + Gets/Sets the value for backcolor + + + + + Location for the caption image + + + + + Gets/Sets the value for Location + + + + + Advanced caption label for Metro form + + + + + value for label text + + + + + value for label location + + + + + value for label size + + + + + value for label backcolor + + + + + value for label font + + + + + value for label forecolor + + + + + constructor for CaptionLabel + + + + + constructor for CaptionLabel + label + + + + + Gets/Sets the value for Label text + + + + + Mouse move delegate for CaptionLabel + + + + + Mouse move event for CaptionLabel + + + + + Mouse leave delegate for CaptionLabel + + + + + Mouse leave event for CaptionLabel + + + + + Mouse enter delegate for CaptionLabel + + + + + Mouse enter event for CaptionLabel + + + + + Mouse down delegate for CaptionLabel + + + + + Mouse down event for CaptionLabel + + + + + Mouse up delegate for CaptionLabel + + + + + Mouse up event for CaptionLabel + + + + + Mouse move event invoking + + + + + Mouse enter event invoking + + + + + Mouse leave event invoking + + + + + Mouse down event invoking + + + + + Mouse up event invoking + + + + + Gets/Sets the value for label location + + + + + Gets/Sets the value for label size + + + + + Gets/Sets the value for label backcolor + + + + + Gets/Sets the value for label font. + + + + + Gets or Sets the instance label name + + + + + + + + + + Specifies the owner of the label + + + + + Gets or Sets the Forecolor of the CaptionLabel. + + + + + Indicates whether the current value of the backcolor property is to be serialized. + + + + + Resets the BackColor. + + + + + Indicates whether the current value of the forecolor property is to be serialized. + + + + + Resets the BackColor. + + + + + Indicates whether the current value of the font property is to be serialized. + + + + + Resets the BackColor. + + + + + Indicates whether the current value of the Size property is to be serialized. + + + + + Resets the Size. + + + + + Indicates whether the current value of the location property is to be serialized. + + + + + Resets the location. + + + + + Indicates whether the current value of the text property is to be serialized. + + + + + Resets the Text. + + + + + Collection of Labels used in the Form Caption + + + + + Constructor for CaptionLabelCollection + + + + + Gets the index of for the label + + + + + Returns whether the list contains the label type + + + + + Adds the label type to the list + + + + + Removes the label type from the list + + + + + Inserts the label type into the list + + + + + Returns the index of the label type + + + + + searches the name in the list + + + + + Overrides the oninsert method + + + + + Gets the unique name + + + + + Mouse Move events for caption label + + + + + Constructor for LabelMouseMoveEventArgs + + Owner for the events + BackColor for caption label + Font for caption label + Text for caption label + Location for caption label + Size of the caption label + ForeColor for caption label + Mouse points in X-co ordinate + Mouse points in Y-co ordinate + + + + Owner for the events + + + + + ForeColor for caption label + + + + + Gets/Sets the value for forecolor + + + + + Size of the caption label + + + + + Gets/Sets the value for size + + + + + BackColor for caption label + + + + + Gets/Sets the value for backcolor + + + + + Font for caption label + + + + + Gets/Sets the value for Font + + + + + Text for caption label + + + + + Gets/Sets the value for Text + + + + + Location for the caption label + + + + + Gets/Sets the value for Location + + + + + Constructor for LabelMouseLeaveEventArgs + + Owner for the events + BackColor for caption label + Font for caption label + Text for caption label + Location for caption label + Size of the caption label + ForeColor for caption label + Mouse points in X-co ordinate + Mouse points in Y-co ordinate + + + + Owner for the events + + + + + ForeColor for caption label + + + + + Gets/Sets the value for forecolor + + + + + Size of the caption label + + + + + Gets/Sets the value for size + + + + + BackColor for caption label + + + + + Gets/Sets the value for backcolor + + + + + Font for caption label + + + + + Gets/Sets the value for Font + + + + + Text for caption label + + + + + Gets/Sets the value for Text + + + + + Location for the caption label + + + + + Gets/Sets the value for Location + + + + + Constructor for LabelMouseEnterEventArgs + + Owner for the events + BackColor for caption label + Font for caption label + Text for caption label + Location for caption label + Size of the caption label + ForeColor for caption label + Mouse points in X-co ordinate + Mouse points in Y-co ordinate + + + + Owner for the events + + + + + ForeColor for caption label + + + + + Gets/Sets the value for forecolor + + + + + Size of the caption label + + + + + Gets/Sets the value for size + + + + + BackColor for caption label + + + + + Gets/Sets the value for backcolor + + + + + Font for caption label + + + + + Gets/Sets the value for Font + + + + + Text for caption label + + + + + Gets/Sets the value for Text + + + + + Location for the caption label + + + + + Gets/Sets the value for Location + + + + + Mouse Up events for caption label + + + + + Constructor for LabelMouseUpEventArgs + + Owner for the events + BackColor for caption label + Font for caption label + Text for caption label + Location for caption label + Size of the caption label + ForeColor for caption label + Mouse points in X-co ordinate + Mouse points in Y-co ordinate + + + + Owner for the events + + + + + ForeColor for caption label + + + + + Gets/Sets the value for forecolor + + + + + Size of the caption label + + + + + Gets/Sets the value for size + + + + + BackColor for caption label + + + + + Gets/Sets the value for backcolor + + + + + Font for caption label + + + + + Gets/Sets the value for Font + + + + + Text for caption label + + + + + Gets/Sets the value for Text + + + + + Location for the caption label + + + + + Gets/Sets the value for Location + + + + + Mouse Down events for caption label + + + + + Constructor for LabelMouseDownEventArgs + + Owner for the events + BackColor for caption label + Font for caption label + Text for caption label + Location for caption label + Size of the caption label + ForeColor for caption label + Mouse points in X-co ordinate + Mouse points in Y-co ordinate + + + + Owner for the events + + + + + ForeColor for caption label + + + + + Gets/Sets the value for forecolor + + + + + Size of the caption label + + + + + Gets/Sets the value for size + + + + + BackColor for caption label + + + + + Gets/Sets the value for backcolor + + + + + Font for caption label + + + + + Gets/Sets the value for Font + + + + + Text for caption label + + + + + Gets/Sets the value for Text + + + + + Location for the caption label + + + + + Gets/Sets the value for Location + + + + + Normal font weight + + + + + Maintains the value indicating whether the caption height should retain or not. + + + + + Stores the value indicating whether the caption height has been initialized or not. + + + + + Value to store the title padding. + + + + + + + + + + Gets/sets if to disable Office2007 look and feel. + + + + + Gets or sets the value indicating whether the caption bar of the form should retain its default height when form is maximized or not. + + + + + Gets or Sets Mouse over color for CaptionButtons + + + + + Gets or Sets the value for CaptionBarColor BorderColor MetroColor + + + + + To Reset the CaptionBarBrush + + + + + Indicates whether to serialize CaptionBarBrush + + + + + Gets or Sets the value for CaptionBarColor + + + + + Gets/Sets the value for CaptionVerticalAlignment + + + + + Gets or Sets the value for CaptionBarColor BorderColor + + + + + Gets/Sets the value for CaptionButtonColor + + + + + Hover Color for CaptionButton + + + + + Gets/Sets the value for CaptionButtonHoverColor + + + + + Gets or Sets value for CaptionBarHeight + + + + + Gets/Sets touch enabled + + + + + Gets/Sets touch enabled + + + + + Gets or Set the valur for BorderThickness + + + + + Gets/sets if to Force the OS Aero theme look and feel when Office2007Visual style is enabled. + + + If DisableOffice2007Style is set to true then the ordinary form drawn will still have the aero theme applied + as the default frame is drawn in the base. + + + + + + + + + + + + + + + + + + + + Gets or sets the font of the form's title. + + Don't rename this property. Name is important for CodeDomSerialization order. + + + + Gets or sets the color for caption in titlebar + + + + + Gets or sets the alignment of of the form's title. + + + + + Gets or Set Value to Drop Shadow to the form + + + + + Gets or sets a value indicating whether the rounded corners are enabled. + + The default value is false. + This option is only in effect with Windows 11. + + + + + + + + + + + + + + + + + + + + + + + + Gets the value used to adjust the titlebar. + + + + + Updates the title padding. + + Updates to retain the title bar height in maximized state. + + + + + + + + + + + + + + To Hold the CaptionButtons visibility + + + + + Gets / Sets whether to hide the CaptionButtons, when displayed in Secondary Monitor + + + + + Hold to apply the Multi Monitor appearance + + + + + Gets / Sets whether to apply the Multi Monitor appearance + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the value indicating whether the current operating system is windows7 or not. + + + + + Gets / set the value to enable the MaximizeBox + + + + + Reset the value of the ShowMaximizeBox + + + + + Serializing the value of the ShowMaximizeBox + + + + + + Gets or sets the visibility of the inner border of the Form. + + + + + Serializing the value of the ShowMinimizeBox + + + + + + Reset the value of the ShowMinimizeBox + + + + + Reset the value of the ShowMinimizeBox + + + + + Gets / set the value to enable the MinimizeBox + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies whether current selected Office2007 scheme background color is used to fill form's backround is used. + If false is used. + + + + + + + + + + + + + + + applies the scaling + + + + + + applies the scaling + + + + + + Method to determine whether the operating system is Windows 11. + + true if the operating system is Windows 11; otherwise false. + + + + Apply rounded corners for the form. + + The handle to the window + Corner style for the round corners + + + + To define whether the customization needs to be applied + + + + + Raises the System.Windows.Forms.Form.Shown event. + + Event args that contains the event data + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Occurs when Form Location is changed + + + + + + + + + + + + + + + + + + + + + + + Helper method to raise the mouse enter event. + + + + + + + + + + + + + + + + + Calculates the non client area of the form + + reference message + retruns true if the method returns combiantion of values + returns false if the method return zero + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Helper method to raise caption image hover events. + + + + + Helper method to raise the caption image mouse move events. + + + + + + + + + + + + + + + + + + + Handles the mouse events of CaptionImage or CaptionLabels. + + + + + Handles the mouse events of CaptionImage or CaptionLabels. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Style of CaptionBar is updated while detaching the MetroForm from TabbedMDIManager. + + + + + Helps to update the Bounds + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + pt - coordinates of the cursor. The coordinates are relative to the upper-left corner of the screen. + + + + + + + pt - coordinates of the cursor. The coordinates are relative to the upper-left corner of the screen. + + + + + + + + + + + + + + + + + + + Gets/Sets the label for form caption + + + + + Gets/Sets the CaptionImage for form caption + + + + + Method to draw the caption label. + + Graphics object + Rectangle to draw caption label + Metroform in which caption image should drawn. + Mdi caption height. + + + + + + + + + + + Paint the caption bar background + + Graphics Object. + Caption Bar rectangle. + Height of the Mdi caption bar. + Width of the caption bar. + Value for the adjustment. + Caption bar Height. + Color to fill the caption bar. + MetroForm. + + + + + + + + + + + Draws the icon for MDIChild. + + Graphics Object. + Rectangle to draw mdiform icon. + Value to adjust icon. + Form to load the Icon + + + + + + + + + + + Disabling the controlbox highlights + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets Image for a button by specific ID. + + Button ID that indicates Image. + + + + + Gets system command by specific buttonID. + + Button ID that indicates system command. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Invalidates client area if MetroScheme back color is used. + + + + + Occurs when property is changed. + + + + + Variable to maintain the visibility of the inner border of the Form. + + + + + variable to check whether the mouse is moved over the caption image + + + + + + + + + + + + + + + + + + + + + + + + + Selected system button. (SB__MAX - no button is selected) + + + + + Pressed system button. (SB__MAX - no button is pressed) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + CaptionText Color + + + + + location for label in caption + + + + + CaptionImage Collection + + + + + LabelCollection + + + + + BorderColor to highlights the ControlBox + + + + + Value for show/hide the highlights + + + + + Indicates whether to allow rounded corners or not. + + + + + This Event will be triggered, when CaptionBar is painted and it is used to customize the CaptionBar. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets border width of the Office2007Form instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Border width of the Office2007Form instance. + + + + + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Provides information about a control that can be used by an accessibility application. + + + + + MetroForm + + + + + Constructor + + The RibbonControlAdv instance. + + + + Bounds of the Control + + The accessible object bounds. + + + + Gets the role for the RibbonControlAdv. This is used by accessibility programs. + + + + + Gets or sets the accessible object name + + The accessible object name. + + + + Gets the description of the RibbonControlAdvAccessibility + + A string describing the RibbonControlAdvAccessibility. + + + + Gets the state of this accessible object. + + + + + Gets the description of what the object does or how the object is used. + + The description of what the object does or how the object is used. + + + + Gets the parent of an accessible object. + + An RibbonControlAdvAccessibility that represents the parent of an accessible object, or null if there is no parent object. + + + + Gets or sets the value of an accessible object. + + + + + Retrieves the object that has the focus. + + >An RibbonControlAdvAccessibility that specifies the currently focused child. + This method returns the calling object if the object itself is focused. Returns null if no object has focus. + + + + Vertical Alignment + + + + + Top + + + + + Center + + + + + + + + + + Normal font weight + + + + + constructor for Office2010form with empty arguments + + + + + Indicates whether to enable dpiaware or not. + + + + + Variable to Gets or Set Value to Drop Shadow to the form. + + + + + Gets or sets the managed color table value. + + + + + Gets or Sets whether to enable Drop Shadow to the Office2010form + + + + + Gets or sets a value indicating whether the rounded corners are enabled. + + The default value is false. + This option is only in effect with Windows 11. + + + + Gets or sets a value indicating whether dpi aware should be enabled or not. + + + + + Reset the value of the DropShadow + + + + + Serializing the value of the DropShadow + + + + + + Gets the CreateParams for the Office2007 form. + + + + + Gets/sets if to disable Office2010 look and feel. + + + + + Gets/sets if to Force the OS Aero theme look and feel when Office2010Visual style is enabled. + + + If DisableOffice2010Style is set to true then the ordinary form drawn will still have the aero theme applied + as the default frame is drawn in the base. + + + + + Gets or Sets the AutoScroll value + + + + + Gets or sets the Office2010 colorscheme + + + + + Gets or sets the font of the form's title. + + Don't rename this property. Name is important for CodeDomSerialization order. + + + + Gets or sets the color for caption in titlebar + + + + + Gets or Sets the CaptionBar Height. + + + + + Gets or sets the alignment of of the form's title. + + + + + Gets the colortable for Office2010 + + + + + Gets the value for IsActive + + + + + Gets whether right to left has been set + + + + + Gets or Sets the Selected button + + + + + Gets the value indicating whether the current operating system is windows7 or not. + + + + + Gets or Sets the pressed button + + + + + Gets or Sets the highlighted button + + + + + To Hold the CaptionButtons visibility + + + + + Gets / Sets whether to hide the CaptionButtons, when displayed in Secondary Monitor + + + + + Hold to apply the Multi Monitor appearance + + + + + Gets / Sets whether to apply the Multi Monitor appearance + + + + + Gets the Maximize button + + + + + Gets the Minimize button + + + + + Gets the layout + + + + + Gets the caption height value + + + + + Gets/Sets touch enabled + + + + + Gets/Sets touch enabled + + + + + applies the scaling + + + + + + applies the scaling + + + + + + Method to determine whether the operating system is Windows 11. + + true if the operating system is Windows 11; otherwise false. + + + + Apply rounded corners for the form. + + + + + Gets the value of title height + + + + + Gets whether the form is minimized + + + + + Gets whether the form is maximized + + + + + Gets whether the form is sizable + + + + + + Gets the screen rectangle + + + + + Gets the area to be painted + + + + + Gets the value of Isvisible property + + + + + Specifies whether current selected Office2010 scheme background color is used to fill form's backround is used. + If false is used. + + + + + Gets the caption font + + + + + Gets the system font + + + + + Gets the closebox value + + + + + Gets the closebox + + + + + + + To define whether the customization needs to be applied + + + + + Raises the System.Windows.Forms.Form.Shown event. + + Event args that contains the event data + + + + + + + + + + + + + + + + + + + + + + + + + + + Occurs when Form Location is changed + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + pt - coordinates of the cursor. The coordinates are relative to the upper-left corner of the screen. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + To customize the image size + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets Image for a button by specific ID. + + Button ID that indicates Image. + + + + + + + + + + Gets system command by specific buttonID. + + Button ID that indicates system command. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Invalidates client area if Office2010Scheme back color is used. + + + + + Occurs when property is changed. + + + + + Determines whether CaptionBarHeight has been modified. + + True if CaptionBarHeight is changed; False otherwise. + + + + Resets the CaptionBarHeight back to its default value. + + + + + + + + + + + + + + + + + + + + + + + + + Selected system button. (SB__MAX - no button is selected) + + + + + Pressed system button. (SB__MAX - no button is pressed) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Holds the value for Caption Height + + + + + CaptionText Color + + + + + Indicates whether to allow rounded corners or not. + + + + + DPI Scaling + + + + + DeviceCap + + + + + Defines whether the DPI setting is enabled. + + + + + Defines the dpi scaling + + + + + To retrieve DPI Value + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets border width of the Office2010Form instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Border width of the Office2010Form instance. + + + + + + + + + + + + + + + + + + + + + Constructor for CaptionManager + + + + + + Provides information about a control that can be used by an accessibility application. + + + + + Office2010Form + + + + + Constructor + + The RibbonControlAdv instance. + + + + Bounds of the Control + + The accessible object bounds. + + + + Gets the role for the RibbonControlAdv. This is used by accessibility programs. + + + + + Gets or sets the accessible object name + + The accessible object name. + + + + Gets the description of the RibbonControlAdvAccessibility + + A string describing the RibbonControlAdvAccessibility. + + + + Retrieves the number of children in the accessible object. + + Number of Child. + + + + Retrieves the accessible child corresponding to the index. + + Index + Child specified to the index + + + + Retrieves the child object at the specified screen coordinates. + + The horizontal screen coordinate. + The vertical screen coordinate. + An RibbonControlAdvAccessibility that represents the child object at the given screen coordinates. + This method returns the calling object if the object itself is at the location specified. + Returns null if no object is at the tested location. + + + + Represents the class to define the style of control. + + + + + Maintains the default style of the . + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + The store. + + + + Gets the default value. + + + + + Gets or sets the value used to draw the border of the + control. + + + + + Gets or sets the value for the + control. + + + + + Gets or sets the background color of the control. + + + + + Gets or sets the fore color value of the control. + + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Represents the class holds the plain data for a style object excluding identity information. + + + + + Provides information about the control's BorderColor property. + + + + + Provides information about the control's Font property. + + + + + Provides information about the control's ForeColor property. + + + + + Provides information about the control's BackColor property. + + + + + Maintains the static data. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Populates the SerializationInfo store with the name, type, and value of each piece of information it wants to serialize + Describes the source and destination of a given serialized stream, and provides an additional caller-defined context. + + + + Overridden to get the static data source. + + + + + Implements the class that provide the identity information of + using . + + + + + Maintains the CheckBoxAdv for create the identity. + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + This class represents the information to be displayed in the ToolTip. + + + Summary description for ToolTipAdv. + + + Tooltip occurs if the TreeViewAdv control's width is shorter than the text length of some of the nodes and when the mouse pointer is hovered on + top of the texts of these nodes, a filled rectangle is displayed.The name of the tooltipAdv depends upon the text of the TreeNodeAdv. + By default tooltips will display ,if the user leaves the mouse pointer stationary over the node(whose text Length is greater than the width + of the tree)for a short period. + This example describes how to display Tooltips for the images's associated with the TreeNodeAdv. + The tooltips for the images ,associated with the nodes can be displayed by using Syncfusion.Windows.Forms.ToolTipAdv along with handling + treeViewAdv's MouseHoverEvent .The tooltips for the images are displayed in the same way as the tooltips for the nodes.Here PointToClient and + PointToNode methods are used in the treeViewAdv. + + private void treeViewAdv1_MouseHover(object sender, System.EventArgs e) + { + TreeNodeAdv node=new TreeNodeAdv(); + Point p=this.treeViewAdv1.PointToClient(Control.MousePosition); + node=this.treeViewAdv1.PointToNode(p); + Point mouseLoc=Control.MousePosition; + mouseLoc.Offset(10,10); + if(node==this.treeViewAdv1.Nodes[0]) + { + this.toolTipAdv1.ShowPopup(mouseLoc); + } + if(node==this.treeViewAdv1.Nodes[1]) + { + this.toolTipAdv2.ShowPopup(mouseLoc); + } + if(node==this.treeViewAdv1.Nodes[2]) + { + this.toolTipAdv3.ShowPopup(mouseLoc); + } + if(node==this.treeViewAdv1.Nodes[3]) + { + this.toolTipAdv4.ShowPopup(mouseLoc); + } + } + + Private Sub treeViewAdv1_MouseHover(ByVal sender As Object, ByVal e As System.EventArgs) + Dim node As TreeNodeAdv = New TreeNodeAdv() + Dim p As Point=Me.treeViewAdv1.PointToClient(Control.MousePosition) + node=Me.treeViewAdv1.PointToNode(p) + Dim mouseLoc As Point=Control.MousePosition + mouseLoc.Offset(10,10) + If node Is Me.treeViewAdv1.Nodes(0) Then + Me.toolTipAdv1.ShowPopup(mouseLoc) + End If + If node Is Me.treeViewAdv1.Nodes(1) Then + Me.toolTipAdv2.ShowPopup(mouseLoc) + End If + If node Is Me.treeViewAdv1.Nodes(2) Then + Me.toolTipAdv3.ShowPopup(mouseLoc) + End If + If node Is Me.treeViewAdv1.Nodes(3) Then + Me.toolTipAdv4.ShowPopup(mouseLoc) + End If + End Sub + + This example describes the way for completely disabling the Tooltips in the TreeViewAdv and the way for disabling of tooltips for + some particular nodes. + The tooltip for some of the nodes which have HelpText can be disabled by handling ToolTipControl_BeforePopup event.Here in the treeViewAdv, for + some of the nodes e.Cancel property is set to true by getting the node's position in ToolTipControl's BeforePopup event handler in which the + tooltips for the respective nodes are disabled .The tooltips for the same nodes can be enabled by setting the e.Cancel=false in ToolTipControl's + BeforePopup Event. + + private void ToolTipControl_BeforePopup(object sender, CancelEventArgs e) + { + Point pt=this.treeViewAdv1.PointToClient(new Point(MousePosition.X,MousePosition.Y)); + TreeNodeAdv node=this.treeViewAdv1.GetNodeAtPoint(pt); + if(node!=null) + { + if(node.Text=="Node1" || node.Text=="Node3"||node.Text=="Node5"||node.Text=="Node7") + { + e.Cancel=true; + } + } + } + + Private Sub ToolTipControl_BeforePopup(ByVal sender As Object, ByVal e As CancelEventArgs) + Dim pt As Point=Me.treeViewAdv1.PointToClient(New Point(MousePosition.X,MousePosition.Y)) + Dim node As TreeNodeAdv=Me.treeViewAdv1.GetNodeAtPoint(pt) + If Not node Is Nothing Then + If node.Text="Node1" OrElse node.Text="Node3" OrElse node.Text="Node5" OrElse node.Text="Node7" Then + e.Cancel=True + End If + End If + End Sub + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + Occurs when theme name of the has changed. + + + + + This value used to customize the apperance of the + + + + + Get or Set of Skin Manager Interface + + + + + Gets or sets the theme name of the ToolTipAdv control. + + + + + Gets or sets a value indicating whether a theme style + has been applied to the control. + + The default value is true. + + + + Gets or sets a value indicating whether control elements styles can be overridden by theme style settings. + + Default value is false. + + By default, the control's element styles will not be overridden by theme style settings if the style is set in sample level. + If this property is enabled, element style will be overridden by theme style settings event if it is set in sample level. + This property should be enabled or disabled before calling the ThemeName property of the control. + + + + + Gets or sets the BaseTheme name of the theme + + + + + Gets the name of the control. + + + + + Gets the active theme name of the ToolTipAdv control. + + Returns the active theme name. + + + + Gets or sets the value used to customize the appearance of the . + + + This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control. + + + + + Gets a value indicating whether the visual style based theme is applied to the control and + also indicates whether the theme files are referred from external assemblies or not. + + Return true, if the visual style based theme is applied to the control. Otherwise returns false. + + + + Raises the event when themename changed. + + The sender value. + A contains the event data. + + + + Updates the Style renderers of ToolTipAdv Control based on applied Theme. + + + + + + + + + + + + + + + + + + + + Required designer variable. + + + + + + + + The background color, gradient and other styles can be set through + this property. + + + The ToolTipAdv control provides this property to enable specialized + custom gradient backgrounds. + + + + + Gets / sets the 2D border style. + + + + + Gets / sets the style of the 3D border. + + + + + Gets / sets the border style of the panel. + + + + + Gets or sets the maximum width of the tooltip control. It wraps text that flows beyond the + restricted width.To allow text to flow in a single line, set restricted width to zero. + + + + + Indicates if cursor of host control is used. + + + + + Indicates whether to ignore all keys. + + True to ignore all keys; False otherwise. Default is False. + + When the popup is showing, it will "swallow" all the WM_KEYDOWN and WM_CHAR + messages. To prevent it, set this property to True. + + + + + + + + + + + + Clean up any resources being used. + + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + + + + + + + + + + + + + + + + + + + + + + Raises the before popup event, when popup is about to be shown + + + + + + Raised when the size of the label's text is changed + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Interface to create an Office 2010 color table. + + + + + Color table for Office 2010 like scroll bars. + + + + + Color references for Office2010. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Constructor for Office2010 color table which is used to register the color style of each theme. + + + + + Used internally + + + + + Specifies the ScrollerGradientBegin color of the Office2010 scroll bars + + + + + Specifies the ScrollerGradientEnd color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonGradientBegin color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonGradientEnd color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonGradientSelectedBegin color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonGradientSelectedEnd color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonGradientPressedBegin color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonGradientPressedEnd color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonBorderDark color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonBorderLight color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonBorderSelectedDark color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonBorderSelectedLight color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonBorderPressedDark color of the Office2010 scroll bars + + + + + Specifies the ArrowButtonBorderPressedLight color of the Office2010 scroll bars + + + + + Specifies the ArrowGradientBegin color of the Office2010 scroll bars + + + + + Specifies the ArrowGradientEnd color of the Office2010 scroll bars + + + + + Specifies the ArrowGradientNormalBegin color of the Office2010 scroll bars + + + + + Specifies the ArrowGradientNormalEnd color of the Office2010 scroll bars + + + + + Specifies the ThumbLinesGradientBegin color of the Office2010 scroll bars + + + + + Specifies the ThumbLinesGradientEnd color of the Office2010 scroll bars + + + + + Specifies the ThumbPressedBackgroundGradientBegin color of the Office2010 scroll bars + + + + + Specifies the ThumbPressedBackgroundGradientEnd color of the Office2010 scroll bars + + + + + Specifies the ScrollerBorderBegin color of the Office2010 scroll bars + + + + + Specifies the ScrollerBorderEnd color of the Office2010 scroll bars + + + + + Specifies the ScrollerGripDark color of the Office2010 scroll bars + + + + + Specifies the ScrollerGripLight color of the Office2010 scroll bars + + + + + Specifies the ScrollerGripBackGround color of the Office2010 scroll bars + + + + + Specifies the color of the Office2010 scroll bars + + + + Get the Alpha blended color. + Source color + destination color + alpha color + returns the alpha blended color + + + + Retrieves color table according to style and scheme. + + Office2010 style. + Office2010 color scheme. + Color table. + + + + Registers color table within internal collection. + + Office2010 style. + Office2010 scheme. + Color table itself. + + + + Updates the styles of the scrollbars related to Office2010 colors. + + base color. + + + + Updates the Office2010 scrollbar color schemes. + + Custom scrollbar draw style. + Office2010 color scheme. + + + + Applies colors for managed scheme. + + Custom scrollbar draw style. + Base color for the managed theme. + + + + Applies scheme for managed theme. + + Container form. + Custom scrollbar draw style. + Office2010 color scheme. + + + + Applies managed colors + + base color . + + + + Called when is risen. + + base color for managed theme. + + + + Initialize scroll bar color fields. + + Scroll bar color references. + + + + Office 2010 color array. + + + + + Registered color tables. + + + + + + + + Constructor for color Table key. + + Custom scrollbar draw style. + Office2010 color scheme. + + + + Compare the color table keys through . + + Object of the ColorTableKey. + Returns 1 if color key is less. Otherwise returns 0. + + + + Compares the color table keys. + + A color table key. + returns true if passed one is less. Otherwise return false + + + + Interface to create a Office2010 color table. + + returns office2010 color table + + + + Provides attributes and methods for Office2010 blue color table. + + + + + Used internally + + + + + Interface to create an office2010 blue color table. + + returns office2010 blue color table. + + + + Provides attributes and methods for Office2010 Silver color table. + + + + + Used internally + + + + + Initialize scroll bar color fields for silver color. + + Scroll bar color references. + + + + Interface to create an office2010 Silver color table. + + returns office2010 silver color table + + + + Provides attributes and methods for Office2010 Black color table. + + + + + Used internally + + + + + Initialize scroll bar color fields for black color. + + Scroll bar color references. + + + + Interface to create an office2010 Black color table. + + returns Office2010 black color table + + + Provides renderer for Office2010 theme. + + + + Scroll Bar min thumb length for lines. + + + + + Scroll thumb line length. + + + + + Enumeration for scroll bar fields. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Office2010 color table. + + + + + Blended background color. + + + + + Blended background black color. + + + + + Blended arrow button. + + + + + Blended selected arrow button. + + + + + Blended arrow button silver and black selected colors. + + + + + Blend for thumb background. + + + + + Bitmap for scroll images + + + + + Constructor for Office2010 renderers. + + + + + Initialize new instance of Office2010Renderer + + custom scrollbar. + Color Table. + + + + Draws arrow button of scroll. If theme is disabled than draw classic scroll. + + graphics for arrow buttons. + Arrow bounds. + type of the scroll button. + Scroll button state. + + + + Draws background of scroll. If theme is disabled than draw classic scroll. + + graphics for arrow buttons background. + arrow button background bounds + Button state. + + + + Draws thumb for scroll. If theme is disabled than draw classic scroll. + + graphics for scroll thumb. + scroll thimb bounds. + Button state. + + + Draw scroll bar background. + graphics for scroll bar backgrounds. + scroll background bounds. + + + Draw pushed scroll background. + Graphics for pushed scroll background + Scroll bounds. + + + Draw scroll bar arrow background. + Graphics for Arrow background. + Arrow bounds. + type of the scroll button. + Button state. + + + Draw scroll thumb background. + Graphics for thumb background. + Scroll thumb bounds. + Button state. + + + Draw scroll arrow. + Graphics for scroll arrow. + Arrow bounds. + type of scroll button. + Button state. + + + Draw scroll lines + Graphics. + Scroll bounds. + true if the scroll bar is vertical scrollbar. + + + + Get the horizontal scroll background brush. + + ScrollBar width. + scroll begin color. + scroll bar end color. + Returns the gradient brush. + + + + Get the Vertical scroll background brush. + + ScrollBar height. + scroll begin color. + scroll bar end color. + Returns the gradient brush. + + + + gets the vertical scroll brush. + + bounds. + Gradient top color. + Gradient bottom color. + Returns the Linear gradient brush. + + + + gets the vertical scroll brush. + + top of the scroll bar rectangle + Height of the scroll bar rectangle + Gradient top color. + Gradient bottom color. + Returns the Linear gradient brush. + + + + gets the horizontal scroll brush. + + bounds. + Gradient top color. + Gradient bottom color. + the Linear gradient brush. + + + + gets the rounded polygon. + + Bounds. + Radius of the polygon. + the edge points. + + + Right office arrow. + the bitmap. + Arrow width. + Arrow height. + + + Left office arrow. + the bitmap. + Arrow width. + Arrow height. + + + Down office arrow. + the bitmap. + Arrow width. + Arrow height. + + + Up office arrow. + the bitmap. + Arrow width. + Arrow height. + + + Right Normal office arrow. + the bitmap. + Arrow width. + Arrow height. + + + Left Normal office arrow. + the bitmap. + Arrow width. + Arrow height. + + + Down Normal office arrow. + the bitmap. + Arrow width. + Arrow height. + + + Up Normal office arrow. + the bitmap. + Arrow width. + Arrow height. + + + Vertical thumb lines. + the bitmap of the scroll thumb. + + + Horizontal thumb lines. + the horizontal thumb lines' Bitmap. + + + + + + + + + + Indicates whether scroll is vertical or horizontal + + + + + + + + + + + + + + + + Indicates whether scrollBar is vertical or horizontal. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Draws arrow button of scroll. If theme is disabled than draw classic scroll. + + + + + + + + + Draws background of scroll. If theme is disabled than draw classic scroll. + + + + + + + + Draws thumb for scroll. If theme is disabled than draw classic scroll. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Right office arrow. + + + + + + Left office arrow. + + + + + + Down office arrow. + + + + + + Up office arrow. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Retrieves color table according to style and scheme. + + Office2007 style. + Office2007 color scheme. + Color table. + + + + Registers color table within internal collection. + + Office2007 style. + Office2007 scheme. + Color table itself. + + + + + + + + + + + + + + + + Applies colors for managed scheme. + + Container form. + Base color for the managed theme. + + + + + + + + + + + Called when is risen. + + + + + + + + + + + + + + Registered color tables. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initialize new instance of Office2007Renderer + + + + + + + Draws arrow button of scroll. If theme is disabled than draw classic scroll. + + + + + + + + + Draws background of scroll. If theme is disabled than draw classic scroll. + + + + + + + + Draws thumb for scroll. If theme is disabled than draw classic scroll. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Right office arrow. + + + + + + Left office arrow. + + + + + + Down office arrow. + + + + + + Up office arrow. + + + + + + Right Normal office arrow. + + + + + + Left Normal office arrow. + + + + + + Down Normal office arrow. + + + + + + Up Normal office arrow. + + + + + + Vertical thumb lines. + + + + Horizontal thumb lines. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + WindowsXP Blue Style renderer implementation. + + + + Blend for the default and selected arrow button. + + + + + Blend for the pushed arrow button. + + + + + Blend for the thumb. + + + + + Blend for the thumb with height < 17. + + + + + Blend for the border of arrow button. + + + + + Blend for the background. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initialize new instance of WindowsXPRenderer + + + + + + Draws arrow button of scroll. If theme is disabled than draw classic scroll. + + + + + + + + + Draws background of scroll. If theme is disabled than draw classic scroll. + + + + + + + + Draws thumb for scroll. If theme is disabled than draw classic scroll. + + + + + + + + Gets path that represents left and top lines. + + + + + + + + Gets path that represents bottom and right lines. + + + + + + + + Fills background with specified colors and gradient. + + Graphics object to use. + Bounds of the background. + Start color of the gradient. + End color of the gradient. + + + + Draws default background. + + Graphics object to use. + Bounds of background. + + + + Draws pushed background. + + Graphics object to use. + Bounds of background. + + + + Draws default arrow button. + + Graphics object to use. + Bounds of the arrow button. + + + + Draws selected arrow button. + + Graphics object to use. + Bounds of the arrow button. + + + + Draws pushed arrow button. + + Graphics object to use. + Bounds of the arrow button. + + + + Draws default thumb. + + Graphics object to use. + Bounds of the thumb. + + + + Draws selected thumb. + + Graphics object to use. + Bounds of the thumb. + + + + Draws pushed thumb. + + Graphics object to use. + Bounds of the thumb. + + + + Draws rounded path for the rectangle of thumb with specified color. + + The graphics object to use. + Bounds of the arrow button. + Color to draw. + Color to draw. + + + + Draws rounded path for the rectangle of arrow button with specified color. + + The graphics object to use. + Bounds of the arrow button. + Color to draw. + Color to draw. + + + WindowsXP OliveGreen Style renderer implementation. + + + + Blend for the default and selected arrow button. + + + + + Blend for the default and selected arrow button. + + + + + Blend for the thumb. + + + + + Blend for the background. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initialize new instance of WindowsXPRenderer + + + + + Draws arrow button of scroll. If theme is disabled than draw classic scroll. + + + + + + + + + Draws background of scroll. If theme is disabled than draw classic scroll. + + + + + + + + Draws thumb for scroll. If theme is disabled than draw classic scroll. + + + + + + + + Fills background with specified colors and gradient. + + Graphics object to use. + Bounds of the background. + Start color of the gradient. + End color of the gradient. + + + + Draws default background. + + Graphics object to use. + Bounds of background. + + + + Draws pushed background. + + Graphics object to use. + Bounds of background. + + + + Draws default arrow button. + + Graphics object to use. + Bounds of the arrow button. + + + + Draws selected arrow button. + + Graphics object to use. + Bounds of the arrow button. + + + + Draws pushed arrow button. + + Graphics object to use. + Bounds of the arrow button. + + + + Draws default thumb. + + Graphics object to use. + Bounds of the thumb. + + + + Draws selected thumb. + + Graphics object to use. + Bounds of the thumb. + + + + Draws pushed thumb. + + Graphics object to use. + Bounds of the thumb. + + + + Draws rounded path for the rectangle of arrow button with specified color. + + The graphics object to use. + Bounds of the arrow button. + Color to draw. + + + WindowsXP Silver Style renderer implementation. + + + + Blend for the default and selected arrow button. + + + + + Blend for the pushed arrow button. + + + + + Blend for the thumb. + + + + + Blend for the pushed thumb. + + + + + Blend for the background. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initialize new instance of WindowsXPRenderer + + + + + Draws arrow button of scroll. If theme is disabled than draw classic scroll. + + + + + + + + + Draws background of scroll. If theme is disabled than draw classic scroll. + + + + + + + + Draws thumb for scroll. If theme is disabled than draw classic scroll. + + + + + + + + Fills background with specified colors and gradient. + + Graphics object to use. + Bounds of the background. + Start color of the gradient. + End color of the gradient. + + + + Draws default background. + + Graphics object to use. + Bounds of background. + + + + Draws pushed background. + + Graphics object to use. + Bounds of background. + + + + Draws default arrow button. + + Graphics object to use. + Bounds of the arrow button. + + + + Draws pushed arrow button. + + Graphics object to use. + Bounds of the arrow button. + + + + Draws default thumb. + + Graphics object to use. + Bounds of the thumb. + + + + Draws pushed thumb. + + Graphics object to use. + Bounds of the thumb. + + + + Draws borders for the arrow buttons and thumbs. + + The graphics object to use. + Bounds of the arrow button. + + + + Draws internal borders for the arrow buttons and thumbs. + + The graphics object to use. + Bounds of the arrow button. + + + + Renderer for VisualStyle based theme + + + + + Initializes a new instance of the class. + + The parent control + + + + Initializes a new instance of the class. + + The parent control. + The metro color table. + + + + Draws background of scroll. If theme is disabled than draw classic scroll. + + The graphics. + The bounds of background. + The scroll button state. + + + + Draws pushed background. + + The graphics. + The bounds of background. + + + + Draws scroll background. + + The graphics. + The scroll bounds. + + + + Draws arrow button of scroll. If theme is disabled than draw classic scroll. + + The graphics. + The bounds of arrow. + The scroll button type. + The scroll button state. + + + + Draws arrow background. + + The graphics. + The arrow backgroud bounds. + The scroll button type. + The scroll button state. + + + + Draws scrollbar arrow + + The graphics. + The bounds of the arrow. + The scroll button type. + The scroll button state. + + + + Draws scroll thumb. If theme is disabled than draw classic scroll. + + + + + + + + Draws scroll thumb background. + + The graphics. + The bounds of thumb. + The scroll button state. + + + + Method to calculate the center point to place the Thumb exactly at the center position inside the Scrollbar. + + + + + + + Implements the functionalities that provides a StyleInfoBase object for ScrollBarStyleInfo properties in a ScrollBar. + + + + + Holds the default style info of the scrollbar. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + A that holds the identity for this + . + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + A that holds data for this object. + All changes in this style object will be saved in the object. + + + + + Gets the default style for the ScrollBarStyleInfo object. + + + + + Gets or sets the background color for the arrow button. + + + This is applicable for both the Min and Max buttons. + + + + + Gets a value indicating whether the property has been modified for the current object. + + + + + Gets or sets the background color for the arrow button in hovering state. + + + + + Gets a value indicating whether the property has been modified for the current object. + + + + + Gets or sets the background color for the arrow button in pressed state. + + + + + Gets a value indicating whether the property has been modified for the current object. + + + + + Gets or sets the foreground color for the arrow button. + + + This will set the background color for the arrow which is shown in the arrow button. + This is applicable for both the Min and Max buttons. + + + + + Gets a value indicating whether the property has been modified for the current object. + + + + + Gets or sets the foreground color for the arrow button in hovering state. + + + + + Gets a value indicating whether the property has been modified for the current object. + + + + + Gets or sets the foreground color for the arrow button in pressed state. + + + + + Gets a value indicating whether the property has been modified for the current object. + + + + + Gets or sets the background color for the scrollbar. + + + + + Gets a value indicating whether the property has been modified for the current object. + + + + + Gets or sets the background color for the thumb. + + + + + Gets a value indicating whether the property has been modified for the current object. + + + + + Gets or sets the background color for the thumb in hovering state. + + + + + Gets a value indicating whether the property has been modified for the current object. + + + + + Gets or sets the background color for the thumb in pressed state. + + + + + Gets a value indicating whether the property has been modified for the current object. + + + + + Gets or sets the border background color for the arrow button. + + + + + Gets a value indicating whether the property has been modified for the current object. + + + + + Gets or sets the border background color for the arrow button in hover state. + + + + + Gets a value indicating whether the property has been modified for the current object. + + + + + Gets or sets the border background color for the arrow button in pressed state. + + + + + Gets or sets the border background color for the arrow button in disabled state. + + + + + Gets a value indicating whether the property has been modified for the current object. + + + + + Gets a value indicating whether the property has been modified for the current object. + + + + + Gets a value indicating whether the property has been modified for the current object. + + + + + Gets or sets a value for ThumbBorderColor. + + + + + Gets a value indicating whether the property has been modified for the current object. + + + + + Gets or sets a value for ThumbBorderColor in hover state. + + + + + Gets a value indicating whether the property has been modified for the current object. + + + + + Gets or sets a value for ThumbBorderColor in pressed state. + + + + + Gets or sets a value for ThumbBorderColor in disabled state. + + + + + Gets a value indicating whether the property has been modified for the current object. + + + + + Gets or sets a value for ThumbDisabledColor. + + + + + Gets a value indicating whether the property has been modified for the current object. + + + + + Gets or sets the value for ArrowButtonDisabledForeColor. + + + + + Gets a value indicating whether the property has been modified for the current object. + + + + + Gets or sets the value for ArrowButtonDisabledBackColor. + + + + + Gets a value indicating whether the property has been modified for the current object. + + + + + Makes an exact copy of the current object. + + The new owner style object for the copied object. + The identifier for this object. + A copy of the current object registered with the new owner style object. + + + + Gets the default value for the ScrollBarStyleInfo. + + Returns the default value for the ScrollBarStyleInfo object. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Contains the collection of properties. + + + + + Gets the value for the ArrowButton BackColor property. + + + + + Gets the value for the ArrowButton hover BackColor property. + + + + + Gets the value for the ArrowButton pressed BackColor properly. + + + + + Gets the value for the ArrowButton ForeColor property. + + + + + Gets the value for the ArrowButton hover ForeColor property. + + + + + Gets the value for the ArrowButton pressed ForeColor property. + + + + + Gets the value for the ScrollBarBackColor property. + + + + + Gets the value for the ThumbColor property. + + + + + Gets the value for the ThumbHoverColor property. + + + + + Gets the value for the ThumbPressedColor property. + + + + + Gets the value for the ThumbWidth property. + + + + + Gets the value for the ArrowButtonBorderColor property. + + + + + Gets the value for the ArrowButtonHoverBorderColor property. + + + + + Gets the value for the ArrowButtonDisabledBorderColor property. + + + + + Gets the value for the ArrowButtonPressedBorderColor property. + + + + + Gets the value for the ThumbBorderColor property. + + + + + Gets the value for the ThumbHoverBorderColor property. + + + + + Gets the value for the ThumbPressedBorderColor property. + + + + + Gets the value for the ThumbDisabledBorderColor property. + + + + + Gets the value for ThumbDisabledColor property. + + + + + Gets the value for ArrowButtonDisabledForeColor property. + + + + + Gets the value for ArrowButtonDisabledBackColor property. + + + + + Holds the static data for the Scrollbar style info store. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Provides the static data of the ScrollBarStyleInfo. + + + + + + Creates an exact copy of the current object. + + Copied object. + + + + Initializes the , if is null. + + + + + + Contains the list of properties that are used to customize the appearance of the scroll control. + + + This contains the elements that are available in the scroll control. i.e. Horizontal scrollbar, Vertical scrol bar and SizeGripper. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A that holds data for this object. + All changes in this style object will be saved in the object. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + A that holds data for this object. + All changes in this style object will be saved in the object. + + + + + Initializes a new instance of the class. + + + A to create the identity for ScrollBars. + + + + + Gets the default style of the . + + + + + Gets or sets the for the horizontal scrollbar of the scroll control. + + + + + Gets or sets the for the vertical scrollbar of the scroll control. + + + + + Gets or sets the for the size grip of the scroll control. + + + + + Determines whether HorizontalScrollBar has been modified and its contents should be serialized at design-time. + + True if contents were changed; False otherwise. + + + + Determines whether VerticalScrollBar has been modified and its contents should be serialized at design-time. + + True if contents were changed; False otherwise. + + + + Override this method to create a product-specific identity object for a sub object. + + An identity object for a sub object of this style. + + The following code is an example how scroll bar creates ScrollerVisualStyleInfoSubObjectIdentity: + + public override StyleInfoSubObjectIdentity CreateSubObjectIdentity(StyleInfoProperty sip) + { + return new ScrollerVisualStyleInfoSubObjectIdentity(this, sip); + } + + + The . + + + + Provide the default style of the . + + Default style object. + + + + Disposes the unused resources. + + Specifies whether to dispose both managed and unmanaged resources or only the unmanaged resources. + + + + Determines whether SizeGrip has been modified and its contents should be serialized at design-time. + + True if contents were changed; False otherwise. + + + + Defines a class that provides style identity information for nested objects of the VisualStyleInfo class of the control. + + + + + Initializes a new instance of the class and associates it with a specified. + + The that owns this sub-object. + The descriptor for this expandable sub-object. + + + + Provides storage for the object. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + Contains the static data of the SizeGripStyleInfo class. + + + + + Gets the value of BackColor property. + + + + + Holds the static data of the size grip style info. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data for the SizeGripStyleInfo. + + + + + + Creates an exact copy of the current object. + + Copied object. + + + + Initializes the , if is null. + + + + + + Implements the class that provide an identity information of using + . + + + + + Maintains the SfScrollContol for create the identity. + + + + + Initializes a new instance of the class. + + + Control to create an identity for ScrollBars(HorizontalScrollBar/VerticalScrollBar). + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Implements the functionalities that holds all information stored for a SizeGrip of the scroll control. + + + ScrollBarSizeGripStyleInfo provides user-friendly access to all properties stored + in ScrollBarSizeGripStyleInfoStore. + + + + + Holds the default style info of the Scrollbar size grip. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + A that holds data for this object. + All changes in this style object will be saved in the object. + + + + + Gets the default value for the SizeGripStyleInfo. + + + + + Gets or sets the BackColor for the SizeGrip. + + + + + Gets a value indicating whether the BackColor property has been modified or not. + + + + + Makes an exact copy of the current object. + + The new owner style object for the copied object. + The identifier for this object. + A copy of the current object registered with the new owner style object. + + + + Gets the default style of the SizeGrip. + + Returns the default style. + + + + Interface for SkinManager + + + + + Holds the option for the VisualTheme + + + + + Managed visual theme. + + + + + Office 2007 style blue theme. + + + + + Office 2007 style silver theme. + + + + + Office 2007 style black theme. + + + + + Office 2010 style blue theme. + + + + + Office 2010 style silver theme. + + + + + Office 2010 style black theme. + + + + + Metro theme. + + + + + Office 2016 style colorful theme. + + + + + Office 2016 style black theme. + + + + + Office 2016 style white theme. + + + + + Office 2016 style dark gray theme. + + + + + Office 2019 style colorful theme. + + + + + High contrast tyle black theme. + + + + + Applies and manages the themes for the controls and components which are derived from the and + + + + + It stores the value of the property. + + + + + It stores the value of the property. + + + + + It helps to notify the Theme changes to all controls, when is modified. + + + + + It stores the value of the property. + + + + + This property helps to know, if the is loaded in Form. + + + + + It stores the VisualStyle settings applied in . + + + + + Gets or sets the to apply the theme settings + + + + + Gets or sets a name of the theme to be applied to . + + + + + Gets / sets the VisualTheme to be applied to controls and components loaded in Application. + + + + + Constructor + + + + + + Loads the assembly to register the theme XML configured files. + + An assembly that has the theme XML configuration file. + + + + Sets the theme to given control and its inner controls which are derived from + + The to set the theme. + to be applied to the control + + This method will set the theme to controls which is derived from + + + + + Sets the theme to given control and its inner controls which are derived from the and + + The to set the theme. + A name of the theme to be set to control. + + This method will set the theme to controls which is derived from and + + + + + Sets the theme to given component and its inner controls which are derived from the + + The to set the theme. + A name of the visualTheme to be set to control. + + This method will set the theme to controls which is derived from + + + + + + Sets the theme to given controls and its inner controls which are derived from the and + + The to set the theme. + A name of the theme to be set to control. + + This method will set the theme to controls which is derived from the + + + + + Iterates the Forms loaded in Application and sets the theme to its inner controls which are derived from the and + + + + + Sets the theme to given Component which are derived from the and + + The to set the theme. + A name of the theme to be set to control. + + This method will set the theme to controls which is derived from and + + + + + Sets the theme to given Control which are derived from the and + + The to set the theme. + A name of the theme to be set to control. + + This method will set the theme to controls which is derived from and + + + + + Sets the theme to given Component and its inner controls which are derived from the and + + The to set the theme. + A name of the theme to be set to control. + + This method will set the theme to controls which is derived from and + + + + + Occurs when new control is added to the control which has the theme settings that is set by the . + + The sender. + A that contains events data. + + + + Occurs when new control is added to the control which has the theme settings that is set by the . + + The sender. + A that contains events data. + + + + Occurs when any control is removed from the control which has the theme settings that is set by the . + + The sender. + A contains events data. + + + + Wires the and + events of the given control and its child controls. + + The control. + + + + Unwires the and + events of the given controls. + + The control. + + + + Releases all resources used by the class. + + True to release both managed and unmanaged resources; + false to release only unmanaged resources. + + + + + Specifies the relative alignment of a popup child about its parent. + + + + + The child will be aligned to the parent's top-left corner + and drawn upwards and to the right of the parent's left border. + + + + + The child will be aligned to the parent's top-right corner + and drawn upwards and to the left of the parent's right border. + + + + + The child will be aligned to the parent's top-right corner + and drawn downwards and to the right of the parent. + + + + + The child will be aligned to the parent's bottom-right corner + and drawn upwards and to the right of the parent. + + + + + The child will be aligned to the parent's bottom-left corner + and drawn downwards and to the right of the parent's left border. + + + + + The child will be aligned to the parent's bottom-right corner + and drawn downwards and to the left of the parent's right border. + + + + + The child will be aligned to the parent's top-left corner + and drawn downwards and to the left of the parent. + + + + + The child will be aligned to the parent's bottom-left corner + and drawn downwards and to the right of the parent. + + + + + Does not indicate any of the above alignments. + + + + + A generic interface for any control that wants to participate + in the Popup framework. + + + + + Returns the popup's control parent. + + + If such a control exists, then the Popup framework will use + it in its popup activation logic. + + + + + Indicates whether a specified control is part of the + popup hierarchy. + + A control instance. + True indicates this query should + be passed to the IPopupParent, if any; False indicates you + should not query the popup parent. + True if the control is part of the Popup hierarchy; + False otherwise. + + + + Specifies the way in which a popup was closed. + + + This information is usually provided in a + PopupControlContainer's event. + You can use it to determine, in some cases, whether or not + to use the updated data in a popup. + + + + + The user wants the changes made in the popup to be applied. + + + + + The user canceled the popup and expects the changes, if any, to be ignored. + + + + + The popup was deactivated due to the user clicking in some + other window, a different application getting focus, etc. + + + + + A generic interface that defines a popup parent, that will + control the alignment of a popup, etc. + + Any object / control that wants to act as a popup's parent + and participate in the popup framework should implement this interface. + Take a look at the PopupsInDepth sample under the Tools\Samples\Editors Package\PopupControlContainer\Advanced + folder for an implementation of this interface. + + + + Will be called to indicate that the popup child was closed + in the specified mode. + + The child that was closed. + A value. + + + + Returns the location for popup, given the preferred relative + alignments. + + + This method allows you to provide 8 different preferred positions for + your popup, in any order. + Different preferred positions are necessary because some positions + may not be ideal for the popup as there may not be enough screen space + for the popup when shown in that position. + The popup will first call this method with prevAlignment set to + . You should then return a location and + designate this location as one of the 8 positions in the + enumeration using the newAlignment reference. + The popup will then check if there is enough space in the screen + to draw at this location. If not, it will call this method again with + prevAlignment set to newAlignment from the previous call. + + This goes on until you return a location that the popup finds acceptable. + However, if you run out of locations before the popup can find an acceptable location, + then you should set newAlignment to . The popup will then assume + that you don't have any more positions to supply and do the best it can + with the supplied location. + + + The previous alignment. + The new alignment designated for the returned location. + + An ideal location for popup designated by one of the values in + newAlignment. Or returns a Point.Empty and set newAlignment to + if you do not intend to provide multiple preferred locations. + + + + + Returns a line (defined by 2 points) in screen co-ordinates that indicates the + border overlap between the child and parent. + + The preferred alignment selected using the + method. + + If a valid line is provided, the popup child in that + area will be drawn in an overlap style. + + + An array of 2 points representing a line (in screen co-ordinates) + where the overlap takes place. NULL if no overlap is desired. + + + + + Indicates whether control's elements should be rendered right-to-left. + + + + + Defines a generic interface which when implemented will allow + that object / control to participate in the popup framework. + + + This interface should be implemented by an object / control that + acts like a popup window and wants to participate in the popup framework. + + + + + Hides the popup window. + + The PopupCloseType value that indicates + the mode in which this popup should be closed. + + + + Indicates whether a popup is currently active / open. + + True if it is open; False otherwise. + + + + Returns the parent. + + An instance of the interface. + + The Popup framework can handle a hierarchy of popups (like + in a menu) for which it requires each popup child to provide + a reference to its popup parent. + + + + + Represents the method that will handle the event. + + The source of the event. + A PopupClosedEventArgs that contains the event data. + + + + Provides data for the event. + + + + + Creates an instance of the PopupClosedEventArgs class. + + A PopupCloseType value. + + + + Returns the PopupCloseType value indicating the way in which + the popup was closed. + + + + + Implement this interface to provide context menu location in your control when + the context menu is invoked by a keyboard key. + + Used by the XPMenus framework (when using PopupMenus in Essential Tools) to determine the context menu location + for a control. + + + + Returns a point in client coordinates of the control. + + + This method will be called when the context menu is being + invoked due to a key like Shift + F10. The control that implements this + interface should then return a point in client coordinates of the + control where the context menus should be shown. + If the control were a + TreeView for example, it should then return a location beside the current + selected node. + + + + + Summary description for MessageFilterEntryHelperWeakContainer. + + + + + HookProc used for catch mouse messages. + + + + + + HookProc used for catch mouse messages. + + + + + + HookProc used for catch mouse messages. + + + + + + HookProc used for catch mouse messages. + + + + + + Provides information, whether popup is ignoring + working area of the display before showing. + This interface should be implemented by classes, + that contain ot use popups. + + + + + Indicates whether derived class ignores working area of the display before showing popup windows. + + + + + Provides a FindParentForm method that returns the parent form. Use this interface + instead of Control.FindForm when you want to support nested windowless grid as used + in GridGroupingControl. See also of the + class. + + + + + Returns the parent form of the control. Use this + instead of Control.FindForm when you want to support nested windowless grid as used + in GridGroupingControl. See also of the + class. + + The parent form. + + + + Provides a FindFormHelper.FindForm(Control) method that supports the IFindParentForm interface. Use this instead of calling + Control.FindForm. + + + + + Provides a FindFormHelper.FindForm(Control) method that you can use instead of calling + Control.FindForm. + + + + + Defines an interface that a can take and parent itself to. + + + + provides a default implementation that should be useful for all + practical purposes. + + + + + + Gets / sets the this container is parented to. + + + An instance of the class. + + + If this is a control, you would set it to be a child of + the and position it appropriately in the set property. + + + + + Provides the appropriate location to the popup given the alignment preferences. + + + + This method is usually called to determine whether the open popup should be closed + due to some action in a different control. If this different control is a "related" control, + the popup framework will not close the popup. + + + + + + + + + A generic window that can be used for drop-down behavior, with WS_EX_TOOLWINDOW and CS_SAVEBITS styles. + + + Internally used by the PopupHost class. + + + + + The top level form-derived class that hosts a + when it is dropped-down. + + + You will normally not have to use this class or refer to + an instance of this class. An instance of this class will + be automatically generated by the which + will then set this as its parent when is called on it. + + However, you can for example access an instance of this + class from the PopupControlContainer and change certain properties. + + + You can include a shadow in your popups by setting the NeedShadow property. + + + + + + Creates a new instance of the PopupHost class. + + + + + Overridden. See . + + + + + + Indicates whether a shadow should + be drawn around the popup window. + + True if a shadow is needed; False otherwise. + + + + Gets / sets the PopupControlContainer that this PopupHost + will host. + + + An implementation of the interface. + + + + + Returns a value indicating + the current alignment of the popup window. + + + A value. + + + + + Gets / sets the overlap border color with which this top-level form should be drawn. + + A color value. + + This color will be used by this form only when the is set to None. + The form will draw a custom single-line border with this color and also draw + the overlapped look, if overlapped borders are available. + + + + + Ignore working area when menu begin popup. + + + + + Gets or sets ignore working area when menu begin popup. + + + + + Overridden. See . + + + + + + Overridden. See . + + + + + + Overridden. See . + + + + + + Shows the popup. + + + + + Updates popup host visibility and z-order. + + + + + Computes size and position of popup. + + + + + Hides the popup. + + + + + A panel-derived class that will let you design custom popups + within a form's designer. + + + To design a custom popup, drag-and-drop it off the toolbox + into a form during design-time. Then populate it with + appropriate controls just like you would any other panel. + You can mark it as invisible (Visible = false) so that it + will not interfere with the form's layout mechanism. It's also recommended that + you unparent it from the design-time parent in your form constructor code, as shown in the sample code below. + + When you are ready to popup, call this class's method. This will show + the popup at the specified location. + + + There are different configurations in which you can use this + PopupControlContainer. + + When you specify a Parent Control using + and pass a Point.Empty location to + , the popup location will be dynamically determined + based on the 's bounds and the screen area. + + + For even more control over the alignment and positioning + of the popup, you should implement an interface + and assign that to the property (this you would + do instead of the above PopupControl-based alignment.). + + + + When the popup is showing, the PopupControlContainer, + in the ProcessDialogKey override will look for Alt, Enter, Tab, Esc, F4, + and F2 keys and either cancel or close the popup. If you want + to prevent this, then set to False. You should + then make sure to close the popup manually whenever appropriate using + . + The PopupControlContainer also fires the , (after popup) + and events that you can handle. You could for example + set the focus on a control within the PopupControlContainer in the + popup event handler. + + + The following example has a PopupControlContainer that gets shown when the + user does an Alt+DownArrow on a text box. + + public Form1() + { + InitializeComponent(); + // It's recommended that you keep the PopupControlContainer unparented by + // any control on the form (which will be the default case as set up during design-time). + // Otherwise, the Form won't close sometimes after dropping down this popup! + this.popupControlContainer1.Parent.Controls.Remove(this.popupControlContainer1); + } + #region Windows Form Designer generated code + private void InitializeComponent() + { + System.Resources.ResourceManager resources = new System.Resources.ResourceManager(typeof(Form1)); + this.popupControlContainer1 = new Syncfusion.Windows.Forms.PopupControlContainer(); + this.cancel = new System.Windows.Forms.Button(); + this.OK = new System.Windows.Forms.Button(); + this.popupTextBox = new System.Windows.Forms.TextBox(); + this.label1 = new System.Windows.Forms.Label(); + this.sourceTextBox = new System.Windows.Forms.TextBox(); + this.groupBox1 = new System.Windows.Forms.GroupBox(); + this.dropDownBtn = new System.Windows.Forms.Button(); + this.mainMenu1 = new System.Windows.Forms.MainMenu(); + this.menuItem1 = new System.Windows.Forms.MenuItem(); + this.menuItem2 = new System.Windows.Forms.MenuItem(); + this.popupControlContainer1.SuspendLayout(); + this.groupBox1.SuspendLayout(); + this.SuspendLayout(); + // + // popupControlContainer1 + // + this.popupControlContainer1.BorderStyle = System.Windows.Forms.BorderStyle.FixedSingle; + this.popupControlContainer1.Controls.AddRange(new System.Windows.Forms.Control[] { + this.cancel, + this.OK, + this.popupTextBox}); + this.popupControlContainer1.Location = new System.Drawing.Point(80, 128); + this.popupControlContainer1.Name = "popupControlContainer1"; + this.popupControlContainer1.Size = new System.Drawing.Size(120, 128); + this.popupControlContainer1.TabIndex = 0; + this.popupControlContainer1.Visible = false; + this.popupControlContainer1.Popup += new System.EventHandler(this.popupControlContainer1_Popup); + this.popupControlContainer1.CloseUp += new Syncfusion.Windows.Forms.PopupClosedEventHandler(this.popupControlContainer1_CloseUp); + this.popupControlContainer1.BeforePopup += new System.ComponentModel.CancelEventHandler(this.popupControlContainer1_BeforePopup); + // + // cancel + // + this.cancel.Anchor = (((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Bottom) + | System.Windows.Forms.AnchorStyles.Left) + | System.Windows.Forms.AnchorStyles.Right); + this.cancel.Location = new System.Drawing.Point(64, 96); + this.cancel.Name = "cancel"; + this.cancel.Size = new System.Drawing.Size(48, 24); + this.cancel.TabIndex = 2; + this.cancel.Text = "Cancel"; + this.cancel.Click += new System.EventHandler(this.cancelButton_Click); + // + // OK + // + this.OK.Anchor = (((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Bottom) + | System.Windows.Forms.AnchorStyles.Left) + | System.Windows.Forms.AnchorStyles.Right); + this.OK.Location = new System.Drawing.Point(8, 96); + this.OK.Name = "OK"; + this.OK.Size = new System.Drawing.Size(48, 24); + this.OK.TabIndex = 1; + this.OK.Text = "OK"; + this.OK.Click += new System.EventHandler(this.OK_Click); + // + // popupTextBox + // + this.popupTextBox.Multiline = true; + this.popupTextBox.Name = "popupTextBox"; + this.popupTextBox.Size = new System.Drawing.Size(118, 90); + this.popupTextBox.TabIndex = 0; + this.popupTextBox.Text = ""; + // + // label1 + // + this.label1.Font = new System.Drawing.Font("Microsoft Sans Serif", 10F, System.Drawing.FontStyle.Bold, System.Drawing.GraphicsUnit.Point, ((System.Byte)(0))); + this.label1.Location = new System.Drawing.Point(16, 56); + this.label1.Name = "label1"; + this.label1.Size = new System.Drawing.Size(256, 64); + this.label1.TabIndex = 1; + this.label1.Text = "Associate a PopupControlContainer with this TextBox. And also transfer data back " + + "and forth between the popup and the TextBox."; + // + // sourceTextBox + // + this.sourceTextBox.Location = new System.Drawing.Point(40, 128); + this.sourceTextBox.Name = "sourceTextBox"; + this.sourceTextBox.Size = new System.Drawing.Size(200, 20); + this.sourceTextBox.TabIndex = 2; + this.sourceTextBox.Text = "Alt+DownArrow for popup"; + this.sourceTextBox.KeyDown += new System.Windows.Forms.KeyEventHandler(this.textBoxPopupParent_KeyDown); + // + // groupBox1 + // + this.groupBox1.Controls.AddRange(new System.Windows.Forms.Control[] { + this.dropDownBtn}); + this.groupBox1.Location = new System.Drawing.Point(8, 32); + this.groupBox1.Name = "groupBox1"; + this.groupBox1.Size = new System.Drawing.Size(280, 128); + this.groupBox1.TabIndex = 3; + this.groupBox1.TabStop = false; + this.groupBox1.Text = "PopupControlContainer demo"; + // + // dropDownBtn + // + this.dropDownBtn.Image = ((System.Drawing.Bitmap)(resources.GetObject("dropDownBtn.Image"))); + this.dropDownBtn.Location = new System.Drawing.Point(240, 96); + this.dropDownBtn.Name = "dropDownBtn"; + this.dropDownBtn.Size = new System.Drawing.Size(26, 20); + this.dropDownBtn.TabIndex = 0; + this.dropDownBtn.Click += new System.EventHandler(this.dropDownBtn_Click); + // + // mainMenu1 + // + this.mainMenu1.MenuItems.AddRange(new System.Windows.Forms.MenuItem[] { + this.menuItem1}); + // + // menuItem1 + // + this.menuItem1.Index = 0; + this.menuItem1.MenuItems.AddRange(new System.Windows.Forms.MenuItem[] { + this.menuItem2}); + this.menuItem1.Text = "Help"; + // + // menuItem2 + // + this.menuItem2.Index = 0; + this.menuItem2.Text = "About Syncfusion"; + this.menuItem2.Click += new System.EventHandler(this.menuItem2_Click); + // + // Form1 + // + this.AutoScaleBaseSize = new System.Drawing.Size(5, 13); + this.ClientSize = new System.Drawing.Size(292, 273); + this.Controls.AddRange(new System.Windows.Forms.Control[] { + this.sourceTextBox, + this.label1, + this.popupControlContainer1, + this.groupBox1}); + this.Icon = ((System.Drawing.Icon)(resources.GetObject("$this.Icon"))); + this.Menu = this.mainMenu1; + this.Name = "Form1"; + this.Text = "Custom Popups Dialog"; + this.popupControlContainer1.ResumeLayout(false); + this.groupBox1.ResumeLayout(false); + this.ResumeLayout(false); + + } + #endregion + + [STAThread] + public static void Main() + { + Application.Run(new Form1()); + } + + #region OpenClosePopup + private void textBoxPopupParent_KeyDown(object sender, System.Windows.Forms.KeyEventArgs e) + { + // Using this unconventional if statement syntax to avoid "and" symbol (documentation restriction, please ignore). + + // If user pressed key down, then show the popup. + if(e.Alt) + if(e.KeyCode == Keys.Down) + if(!this.popupControlContainer1.IsShowing()) + { + // Let the popup align around the source textBox. + this.popupControlContainer1.ParentControl = this.sourceTextBox; + // Passing Point.Empty will align it automatically around the above ParentControl. + this.popupControlContainer1.ShowPopup(Point.Empty); + + e.Handled = true; + } + // Escape should close the popup. + if(e.KeyCode == Keys.Escape) + if(this.popupControlContainer1.IsShowing()) + this.popupControlContainer1.HidePopup(PopupCloseType.Canceled); + } + + private void OK_Click(object sender, System.EventArgs e) + { + this.popupControlContainer1.HidePopup(PopupCloseType.Done); + } + + private void cancelButton_Click(object sender, System.EventArgs e) + { + this.popupControlContainer1.HidePopup(PopupCloseType.Canceled); + } + #endregion OpenClosePopup + + #region PopupEvents + private void popupControlContainer1_BeforePopup(object sender, System.ComponentModel.CancelEventArgs e) + { + // Set the text to be edited with the text in the form text box. + this.popupTextBox.Text = this.sourceTextBox.Text; + } + + private void popupControlContainer1_Popup(object sender, System.EventArgs e) + { + // Set the focus on the text box inside the popup after it is open. + this.popupTextBox.Focus(); + this.popupTextBox.SelectionStart = 0; + this.popupTextBox.SelectionLength = 0; + } + + private void popupControlContainer1_CloseUp(object sender, Syncfusion.Windows.Forms.PopupClosedEventArgs args) + { + // Transfer data from the popup. + if(args.PopupCloseType == PopupCloseType.Done) + { + this.sourceTextBox.Text = this.popupTextBox.Text; + } + // Set focus back to textbox. + if(args.PopupCloseType == PopupCloseType.Done + || args.PopupCloseType == PopupCloseType.Canceled) + this.sourceTextBox.Focus(); + } + #endregion PopupEvents + + + + + + Default size of the control + + + + + Indicates whether the control is in design-mode. + + + + + + + + Gets or sets the value for the control. + + + + + Indicates whether the popup should send a kill focus message + to the control with focus when the popup was shown. + + True to send a KillFocus message; False otherwise. Default value + is False. + + Faking focus is only necessary when the + doesn't take the focus but you want it to look like it + took the focus. + + When this property is True, a KillFocus message will be + sent to the control that currently has the focus after the + PopupControlContainer is dropped down and a SetFocus message + will be sent to the control with focus when the popup is + closed. + + + Again, you will probably not need this functionality in + most of the cases, since you will probably set the focus + on some control with this PopupControlContainer as soon + as it pops up (from within the popup event handler). + + + + + + Ensures that the property returns a valid PopupHost. + + + + Normally the property will return a non-NULL value only when + the popup was displayed at least once. Calling this method will ensure that the property + returns a non-NULL value. + + + + + + Gets or sets a reference to the PopupHost that will be + used to host this PopupControlContainer when dropped down. + + The PopupHost object that will host this PopupControlContainer. + + PopupHost is the top level form-based control that hosts + this PopupControlContainer when dropped down. + + The PopupControlContainer usually creates a custom + PopupHost when it is asked to drop down. However, you + can provide your own PopupHost if you have a customized + version. + + + You can also get a reference to the + that the PopupControlContainer uses by default and make + changes to it. The PopupControlContainer creates a + default PopupHost when there is no PopupHost supplied + to it, but gets called to show the popup. + Hence, the best place to get the default PopupHost + associated with this PopupControlContainer is in the + handler. Or call to + create the default PopupHost if it is not yet created. + + + + The following example shows how to make the PopupHost's border style resizable to create a resizable popup. + + // The PopupControlContainer's BeforePopup event handler + private void popupControlContainer1_BeforePopup(object sender, System.ComponentModel.CancelEventArgs e) + { + // Create a Popup, that can be resized. + + // Make the popup host's border style resizable. + this.popupControlContainer1.PopupHost.FormBorderStyle = FormBorderStyle.SizableToolWindow; + this.popupControlContainer1.PopupHost.BackColor = this.BackColor; + + // Necessary to set the host's client size every time, especially since the + // popup's Dock style is set to DockStyle.Fill. + if(!(this.popupControlContainer1.PopupHost.Size.Width >= 140)) + this.popupControlContainer1.PopupHost.Size = new System.Drawing.Size(140, 150); + + // So that the popup container will fill the entire popup host when resized. + this.popupControlContainer1.Dock = DockStyle.Fill; + } + + + + + + Gets or sets the discreet location. + + + + + Specifies the PopupControlContainer's control parent. + + A control instance. + + The Parent-Child relationship in this case is NOT similar + to the one in the control hierarchy. + + When you specify a Parent Control via + ParentControl and pass a Point.Empty location to + ShowPopup, the popup location will be dynamically determined + based on the ParentControl bounds and the screen area. + + + + + Specifies the parent. + + An instance that implements . + + When you associate an IPopupParent interface with the PopupControlContainer + you get even more control over the alignment and positioning + of the Popup, (this you would + do instead of the PopupControl based parenting). + When you provide this interface, the alignment and + positioning logic is delegated to this interface. + + + + + Creates a new instance of the . + + + + + Initializes a new instance of the class with a specified container. + + A that represents the container of the . + + Containers are objects that encapsulate and track zero or more components. In this context, containment refers to logical containment, not visual containment. + You can use components and containers in a variety of scenarios, including scenarios that are both visual and not visual. + Note to Implementers: To be a container, the class must implement the IContainer interface, which supports methods for adding, removing and retrieving components. + Unlike other controls, a is not a direct child of your form (though this is the case during design-time). + This requires you to explicitly dispose of this control before the form gets destroyed. + With this constructor override, the automatically plugs itself into a form's + default component-containment pattern (through the IContainer member) during design-time. If you create this class in code, then you have to set it up manually. + The implementation simply adds the instance into the container. + + + + + + + + Indicates whether to ignore dialog keys. + + True to ignore dialog keys; False if not to. Default is False. + + When the popup is showing, the PopupControlContainer + in the ProcessDialogKey override will look for Alt, Enter, Tab, Esc, F4, + and F2 keys and either cancel or close the popup. If you want + to prevent this, set IgnoreDialogKey = False. You should + then listen for the above keys and make sure to close the popup manually whenever appropriate using + HidePopup. + + + + + Indicates whether to ignore all mouse messages. + + True to ignore all mouse messages; False otherwise. Default is False. + + When the popup is showing it will "swallow" all the mouse messages that are sent to + controls not in the popup-hierarchy. When showing, the popup will also listen to + mouse messages to determine if the popup should be closed (for mouse down + outside the popup-hierarchy, for example). + + To prevent this behavior, set this property to True. + When set to True, the popup will close only when you call + the method or when a new popup gets shown. + + + + + Indicates whether to ignore all keys. + + True to ignore all keys; False otherwise. Default is False. + + When the popup is showing, it will "swallow" all the WM_KEYDOWN and WM_CHAR + messages. To prevent it, set this property to True. + + + + + Gets preferred location. + + + + + + + + Shows the popup at the specified location. + + A point in screen coordinates. + Can be Point.Empty. + + A popup's position is determined as follows. + First, if an interface is associated (using + the property), then it is queried for the preferred + position. If there is no such interface, the location + specified in the method call is used. If ShowPopup + was called with Point.Empty, then the 's bounds are used + to determine an appropriate position to drop-down. + This will throw a followed by a event. + Use to hide the popup in code. + + When the popup is closed either programmatically or by the user, + the event will be thrown that will indicate + whether the popup was closed or canceled. + + + + + + Hides a popup that is open. + + + This method will hide the popup with the mode. + + + + + This method is called from the BarManager class when the parent form is deactivated. + It checks whether the user clicked inside a child control of this PopupControlContainer. + If this is not the case (e.g. user clicked on another window on the desktop) then the popup gets hidden. + + + + + Occurs before a popup is closed. + + + + + Hides a popup with the specified mode. + + A PopupCloseType value. + + + + Overridden. See . + + + + + + + Specifies whether the drop down need to be closed on pressing tab on the last item and shift tab on the first item in the drop down. + + + + + Overridden. . + + + + + + Sets focus on the popup parent control. + + + + + Focuses first visible parent. + + + + + Specifies whether the control is in set focus. + + + + + + gets or sets the touchmode + + + + + + + + + + + + + applies the scaling + + + + + font changed + + + + + + + + + Gets or sets the current popup child in the popup hierarchy. + + An instance of interface. + When you want to show a parent-child hierarchy of popups, + call this property on the parent popup before showing the child popup. + + + + // While the parent PopupControlContainer is showing, you might want to show another child + // PopupControlContainer. You can do so as follows: + // Set up parent-child relationship. + parentPopupControlContainer.CurrentPopupChild = childPopupControlContainer; + childPopupControlContainer.PopupParent = parentPopupControlContainer; + + // Now show the child popup. + childPopupControlContainer.ShowPopup(); + + + + + + Get the parent control of the popupcontrol container. + + The control + Returns the popup of the parent control + + + + Checks whether the control is a related control. + + + + + + + + Indicates whether the popup is currently dropped down. + + True indicates popup is dropped down; False otherwise. + + + + Occurs when a popup is closed. + + + Handling this event will tell you whether the popup was + closed or canceled by the user. This, in some cases, will then let you + know whether or not you should accept changes in the popup. + + + + + Occurs when the popup is about to be shown. + + + You may choose to cancel drop-down in this handler. + This is also a good place, for example, to access the PopupControlContainer's + PopupHost and make changes to it. + + + + + Occurs after the popup has been dropped down and made visible. + + This is a good place, for example, to set the + focus on a control in the popup. + + + + Raises the BeforePopup event. + + A CancelEventArgs that contains the event data. + + The OnBeforePopup method also allows derived classes to handle the event + without attaching a delegate. This is the preferred technique for + handling the event in a derived class. + Note to Inheritors: When overriding OnBeforePopup in a derived + class, be sure to call the base class's OnBeforePopup method so that + registered delegates receive the event. + + + + + Raises the event. + + A instance containing + data pertaining to this event. + + The OnCloseUp method also allows derived classes to handle the event + without attaching a delegate. This is the preferred technique for + handling the event in a derived class. + Note to Inheritors: When overriding OnCloseUp in a derived + class, be sure to call the base class's OnCloseUp method so that + registered delegates receive the event. + + + + + Raises the event. + + An EventArgs instance containing + data pertaining to this event. + + The OnPopup method also allows derived classes to handle the event + without attaching a delegate. This is the preferred technique for + handling the event in a derived class. + Note to Inheritors: When overriding OnPopup in a derived + class, be sure to call the base class's OnPopup method so that + registered delegates receive the event. + + + + + Accessibility class to provide Coded UI support. + + + + + Variable for PopupControlContainer. + + + + + Constructor. + + PopupControlContainer + + + + Bounds of the Control + + + + + Gets the role for the PopupControlContainer. This is used by accessibility programs. + + + + + Gets or sets the accessible object name + + + + + Gets the description of the Control.ControlAccessibleObject + + + + + Gets the state of the accessible object. + + + + + Gets the description of what the object does or how the object is used. + + + + + Gets the parent of an accessible object. + + + + + Gets or sets the value of an accessible object. + + + + + Retrieves the object that has the focus. + + + + + + Retrieves the currently selected child. + + Child + + + + Retrieves the child object at the specified screen coordinates. + + The horizontal screen coordinate + The vertical screen coordinate + An System.Windows.Forms.AccessibleObject that represents the child object + at the given screen coordinates. + + + + Suspends applying filters by tag. + + + + + + Resumes applying filters by tag. + + + + + + Utility to help you filter messages in both a .NET and Native app. + + The interface that will receive messages for filtering in a .NET app. + Specifies whether or not this filter should be inserted on top (with highest priority). + + + + Gets/sets whether to disable release hook or not + + + + + Implement this interface in a class if the class embeds one or more + edit controls (text boxes, combo boxes). Implementing this interface + provides a way for external classes to access the embedded edit + control(s). + + + + + Returns the active edit control (text box, combo box). + + The IEditControlsEmbedListener based auto complete control. + + The implementation of this method will let the AutoComplete + control provide a link back to it so that it can be informed + of any changes in the active edit control. + + This is used when there are more than one edit controls on one + composite control. In this case, the AutoComplete control + will be informed when there is a change in focus between + the different edit controls. This is assuming that the AutoComplete + control is not able to sense the change in focus. + + + + + + The BorderPanel is a control that can be used to wrap other controls inside improving its visual appearance. + + + + + Required designer variable. + + + + + Gets / sets the background information of the border. + + + + + Gets / sets the color of the background of the inner surface. + + + + + Gets / sets the sizes of the sides of the border. + + + + + Gets / sets the control to be displayed inside the panel. + + + + + Gets / sets the round corner radii of the inner surface. + + + + + Gets / sets the width of the border of the inner surface. + + + + + Gets / sets the width of the border. + + + + + Gets / sets the round corner radii of the outer shape. + + + + + Gets / sets the height state of the inner surface. + + + + + Gets / sets the height state of the outer surface. + + + + + Cleans up any resources being used. + + + + + Required method for designer support - do not modify + the contents of this method with the code editor. + + + + + Indicates the states of the two borders of the BorderPanel. + + + + + Holds information about the rounded corners of the BorderPanel. + + + + + The default settings of the panel. + + + + + Gets / sets the BottomRight round corner radius. + + + + + Gets / sets the BottomLeft round corner radius. + + + + + Gets / sets the TopRight round corner radius. + + + + + Gets / sets the TopLeft round corner radius. + + + + + Gets / sets all the other values to the specified value. + + + + + Holds information about the sides of the borders of the BorderPanel. + + + + + The default dimension settings. + + + + + Gets / sets all the other members to the specified value. + + + + + Gets / sets the bottom border side's width. + + + + + Gets / sets the right border side's width. + + + + + Gets / sets the left border side's width. + + + + + Gets / sets the top border side's width. + + + + Subclass window that allowing attaching of + message filters classes into Message processing. + + + Value that represent invalid window handle. + + + Reference on message filter instance. + + + Gets and Sets reference on message filter instance. + + + Default constructor that subclass window by it handle automatically. + Window Handle. + + + Override of WndProc function. + Reference on message processed by Window. + + + + SR provides localized access to string resources specific + from the assembly manifest Syncfusion.Windows.Forms.Localization.SR.resources + + + + + Gets the localized text. + + Current UI culture. + String that has to be localized. + Control name. + The localized string + + + + Gets the localized text. + + String that has to be localized. + The localized string + + + + Gets the localized text. + + String that has to be localized. + Control name. + The localized string + + + + Gets the localized text. + + String that has to be localized. + Control name. + The localized string + + + + Gets the localized text. + + Current UI culture. + String that has to be localized. + The localized string + + + + Gets the localized object. + + Current UI culture. + String that has to be localized. + The localized object + + + + Gets the localized object. + + String that has to be localized. + The localized object + + + + Gets the localized boolean object. + + Current UI culture. + String that has to be localized. + The localized boolean object + + + + Gets the localized boolean object. + + String that has to be localized. + The localized boolean object + + + + Gets the localized byte object. + + Current UI culture. + String that has to be localized. + The localized byte object + + + + Gets the localized byte object. + + String that has to be localized. + The localized byte object + + + + Gets the localized char object. + + Current UI culture. + String that has to be localized. + The localized char object + + + + Gets the localized char object. + + String that has to be localized. + The localized char object + + + + Gets the localized double object. + + Current UI culture. + String that has to be localized. + The localized double object + + + + Gets the localized double object. + + String that has to be localized. + The localized double object + + + + Gets the localized float object. + + Current UI culture. + String that has to be localized. + The localized float object + + + + Gets the localized float object. + + String that has to be localized. + The localized float object + + + + Gets the localized int object. + + String that has to be localized. + The localized int object + + + + Gets the localized int object. + + Current UI culture. + String that has to be localized. + The localized int object + + + + Gets the localized long object. + + String that has to be localized. + The localized long object + + + + Gets the localized long object. + + Current UI culture. + String that has to be localized. + The localized long object + + + + Gets the localized short object. + + Current UI culture. + String that has to be localized. + The localized short object + + + + Gets the localized short object. + + String that has to be localized. + The localized short object + + + + Specifies the category in which the property or event will be displayed in a visual designer. + + + This is a localized version of CategoryAttribute. The localized string will be loaded from the + assembly manifest Syncfusion.Windows.Forms.Localization.SR.resources + + + + + Specifies a description for a property or event. + + + This is a localized version of DescriptionAttribute. The localized string will be loaded from the + assembly manifest Syncfusion.Windows.Forms.Localization.SR.resources + + + + + Defines a interface. + + + + + Provides static methods and properties to localize the UI. + + + + + ResourceIdentifiers contains resource Ids specific to the Syncfusion.Shared.Base assembly. + + + + + Color table to customize the buttons,captions and text color in MessageBoxAdv + + + + + Default constructor for MetroStyleColorTable + + + + + Variable for CaptionBarColor + + + + + Gets/sets the captionbarcolor + + + + + Variable for CaptionForeColor + + + + + Gets/sets the captionforecolor. + + + + + Variable for closeButtonColor + + + + + Gets/sets the CloseButton color of MessageBoxAdv. + + + + + Variable for closeButtonHoverColor + + + + + Gets/sets the CloseButtonHoverColor. + + + + + Variable for BackColor + + + + + Gets/sets the backcolor. + + + + + variable for ForeColor + + + + + Gets/sets the forecolor. + + + + + Variable for BorderColor + + + + + Gets/sets the bordercolor + + + + + Variable for OKButtonBackColor + + + + + Gets/sets the OKButtonBackColor + + + + + Variable for OKButtonForeColor + + + + + Gets/sets the OKButtonForeColor + + + + + Variable for Details Button ForeColor + + + + + Gets/sets the Details Button ForeColor + + + + + Variable for Details Button BackColor + + + + + Gets/sets the Details Button BackColor + + + + + Variable for YesButtonBackColor + + + + + Gets/sets the YesButtonBackColor. + + + + + Variable for YesButtonForeColor + + + + + Gets/sets the YesButtonForeColor. + + + + + Variable for AbortButtonBackColor + + + + + Gets/sets the AbortButtonBackColor. + + + + + Variable for AbortButtonForeColor + + + + + Gets/sets the AbortButtonForeColor. + + + + + Variable for RetryButtonBackColor + + + + + Gets/sets the RetryButtonBackColor + + + + + Variable for RetryButtonForeColor + + + + + Gets/sets the RetryButtonForeColor + + + + + Variable for IgnoreButtonBackColor + + + + + Gets/sets the IgnoreButtonBackColor. + + + + + Variable for IgnoreButtonForeColor + + + + + Gets/sets the IgnoreButtonForeColor. + + + + + Variable for NoButtonBackColor + + + + + Gets/sets the NoButtonBackColor. + + + + + Variable for NoButtonForeColor + + + + + Gets/sets the NoButtonForeColor. + + + + + Variable for CancelButtonBackColor + + + + + Gets/sets the CancelButtonBackColor + + + + + Variable for CancelButtonForeColor + + + + + Gets/sets the CancelButtonForeColor + + + + + To serialize CaptionBarColor + + captionBarColor + + + + Reset CaptionBarColor + + + + + To serialize CaptionForeColor + + captionForeColor + + + + Reset CaptionForeColor + + + + + To serialize CloseButtonColor + + closeButtonColor + + + + Reset CloseButtonColor + + + + + To serialize CloseButtonHoverColor + + closeButtonHoverColor + + + + Reset CloseButtonHoverColor + + + + + To serialize BackColor + + backColor + + + + Reset BackColor + + + + + To serialize ForeColor + + foreColor + + + + Reset ForeColor + + + + + To serialize BorderColor + + borderColor + + + + Reset BorderColor + + + + + To serialize OKButtonBackColor + + okbuttonbackcolor + + + + Reset OKButtonBackColor + + + + + To serialize OKButtonForeColor + + okbuttonforecolor + + + + Reset OKButtonForeColor + + + + + To serialize YesButtonBackColor + + yesbuttonbackcolor + + + + Reset YesButtonBackColor + + + + + To serialize YesButtonForeColor + + yesbuttonforecolor + + + + Reset YesButtonForeColor + + + + + To serialize AbortButtonBackColor + + abortbuttonbackcolor + + + + Reset AbortButtonBackColor + + + + + To serialize AbortButtonForeColor + + abortbuttonforecolor + + + + Reset AbortButtonForeColor + + + + + To serialize IgnoreButtonBackColor + + ignorebuttonbackcolor + + + + Reset IgnoreButtonBackColor + + + + + To serialize IgnoreButtonForeColor + + ignorebuttonforecolor + + + + Reset IgnoreButtonForeColor + + + + + To serialize RetryButtonBackColor + + retrybuttonbackcolor + + + + Reset RetryButtonBackColor + + + + + To serialize RetryButtonForeColor + + retrybuttonforecolor + + + + Reset RetryButtonForeColor + + + + + To serialize NoButtonBackColor + + nobuttonbackcolor + + + + Reset NoButtonBackColor + + + + + To serialize NoButtonForeColor + + nobuttonforecolor + + + + Reset NoButtonForeColor + + + + + To serialize CancelButtonBackColor + + cancelbuttonbackcolor + + + + Reset CancelButtonBackColor + + + + + To serialize CancelButtonForeColor + + cancelbuttonforecolor + + + + Reset CancelButtonForeColor + + + + + Holds the height of the before the detail view is collapsed. + + + + + Holds the height of the before the detail view expand. + + + + + Holds the Button height + + + + + + Custom Button Collection + + + + + + Variable which indicates whether custom buttons are already initialized or not + + + + + detailButtonSpace control using for increase the space in flow layout panel inbetween the detail button and message box buttons in while resizing. + + + + + Method to set same width for all Buttons in the MessageBoxAdv + + Collection of buttons + Greater width + + + + + Method to calculate the height of the panel of MessageBoxAdv + + Panel height + + + + Initializes the new instance for MessageBoxMetroStyleFormAdv class. + + owner window + text + form caption + buttons + form icon + default button + options + to show helpbutton + click event data + image + sizing image + + + + Custom Button Initialization + + + + + Click Event for Custom Buttons + + + + + Custom Button Size initialization + + + + + + + + Returns the Button width + + + + + + Helps to apply the Font Settings to Custom Buttons + + + + + Helps to apply the Font Settings to built buttons + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Validate the messagebox height in while initialize the control + + + + + Handle the size of the message box while closing and expanding the details view. + + + + + Normal font weight + + + + + Maintains the value indicating whether the caption height should retain or not. + + + + + Constructor for Office2007form with empty arguments + + + + + Variable to Gets or Set Value to Drop Shadow to the form. + + + + + Gets or sets the managed color table value. + + + + + Indicates whether to enable dpiaware or not. + + + + + Value to store the title padding. + + + + + Indicates whether to allow rounded corners or not. + + + + + + Gets or sets a value indicating whether dpi aware should be enabled or not. + + + + + Gets or Sets whether to enable Drop Shadow to the Office2007form + + + + + Gets or sets a value indicating whether the rounded corners are enabled. + + The default value is false. + This option is only in effect with Windows 11. + + + + Reset the value of the DropShadow + + + + + Serializing the value of the DropShadow + + + + + + Gets the CreateParams for the Office2007 form. + + + + + Gets/sets if to disable Office2007 look and feel. + + + + + Gets/sets if to Force the OS Aero theme look and feel when Office2007Visual style is enabled. + + + If DisableOffice2007Style is set to true then the ordinary form drawn will still have the aero theme applied + as the default frame is drawn in the base. + + + + + Gets or Sets the AutoScroll value + + + + + Gets or sets the Office2007 ColorScheme + + + + + + + + + + Gets or Sets the CaptionBar Height. + + + + + Gets or sets the font of the form's title. + + Don't rename this property. Name is important for CodeDomSerialization order. + + + + Gets or sets the color for caption in titlebar + + + + + Gets or sets the alignment of of the form's title. + + + + + Gets the ColorTable for Office2007 + + + + + + + + + + Gets whether right to left has been set + + + + + Gets or Sets the Selected button + + + + + Gets or Sets the pressed button + + + + + Gets or Sets the highlighted button + + + + + To Hold the CaptionButtons visibility + + + + + Gets / Sets whether to hide the CaptionButtons, when displayed in Secondary Monitor + + + + + Hold to apply the Multi Monitor appearance + + + + + Gets / Sets whether to apply the Multi Monitor appearance + + + + + Gets the Maximize button + + + + + Gets the Minimize button + + + + + Gets the layout + + + + + Gets the caption height value + + + + + Gets/Sets touch enabled + + + + + Gets/Sets touch enabled + + + + + applies the scaling + + + + + + Gets the value indicating whether the current operating system is windows7 or not. + + + + + Updates the title padding. + + Updates to retain the title bar height in maximized state. + + + + applies the scaling + + + + + + Method to determine whether the operating system is Windows 11. + + true if the operating system is Windows 11; otherwise false. + + + + Apply rounded corners for the form. + + The handle to the window + Corner style for the round corners + + + + Gets the value of title height + + + + + Gets whether the form is minimized + + + + + Gets whether the form is maximized + + + + + Gets whether the form is sizable + + + + + + Gets the screen rectangle + + + + + Gets the area to be painted + + + + + Gets the value of Isvisible property + + + + + Specifies whether current selected Office2007 scheme background color is used to fill form's backround is used. + If false is used. + + + + + Gets the caption font + + + + + Gets the system font + + + + + Gets the closebox value + + + + + Gets the closebox + + + + + + + To define whether the customization needs to be applied + + + + + Raises the System.Windows.Forms.Form.Shown event. + + Event args that contains the event data + + + + + + + + + + + + + + + + + + + + + + + + + + + Occurs when Form Location is changed + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + pt - coordinates of the cursor. The coordinates are relative to the upper-left corner of the screen. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + To customize the image size + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets Image for a button by specific ID. + + Button ID that indicates Image. + + + + + Gets system command by specific buttonID. + + Button ID that indicates system command. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Invalidates client area if Office2007Scheme back color is used. + + + + + Occurs when property is changed. + + + + + + Resets the CaptionBarHeight back to its default value. + + + + + + + + + + + + + + + + + + + + + + + + + Selected system button. (SB__MAX - no button is selected) + + + + + Pressed system button. (SB__MAX - no button is pressed) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Holds the value for Caption Height + + + + + + + + + + + + + + + CaptionText Color + + + + + DPI Scaling + + + + + DeviceCap + + + + + Defines whether the DPI setting is enabled. + + + + + Defines the dpi scaling + + + + + To retrieve DPI Value + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets border width of the Office2007Form instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Border width of the Office2007Form instance. + + + + + Constructor for CaptionManager + + + + + + Provides information about a control that can be used by an accessibility application. + + + + + Office2007Form + + + + + Constructor + + The RibbonControlAdv instance. + + + + Bounds of the Control + + The accessible object bounds. + + + + Gets the role for the RibbonControlAdv. This is used by accessibility programs. + + + + + Gets or sets the accessible object name + + The accessible object name. + + + + Gets the description of the RibbonControlAdvAccessibility + + A string describing the RibbonControlAdvAccessibility. + + + + Retrieves the number of children in the accessible object. + + Number of Child. + + + + Retrieves the accessible child corresponding to the index. + + Index + Child specified to the index + + + + Retrieves the child object at the specified screen coordinates. + + The horizontal screen coordinate. + The vertical screen coordinate. + An RibbonControlAdvAccessibility that represents the child object at the given screen coordinates. + This method returns the calling object if the object itself is at the location specified. + Returns null if no object is at the tested location. + + + + Specifies the arrow button that should be shown in an arrow bar. + + + + + Don't show buttons. + + + + + Show up and down buttons. + + + + + Show up, down, move first and move last buttons. + + + + + This control is used by and + to display arrow buttons. + + + + + + + + + + + + + + Initializes a new . + + + + + Occurs when the user clicks on an arrow button. + + + + + Raises the event. + + An that contains the event data. + + + + Occurs when Arrow button is changed. + + + + + Indicates whether themes are enabled for this control. + + + + + Fired when the ThemesEnabled property changes. + + + + + + + + Raises the ThemeChanged event. + + An EventArgs that contains the event data. + + The OnThemeChanged method also allows derived classes to handle the event + without attaching a delegate. This is the preferred technique for + handling the event in a derived class. + Note to Inheritors: When overriding OnThemeChanged in a derived + class, be sure to call the base class's OnThemeChanged method so that + registered delegates receive the event. + + + + + + + + Occurs when the specified button was clicked or the mouse is pressed down on the button. + + The source of the event. + + + + Initializes the the arrow bar. + + + + + Gets or sets the number of Milliseconds to wait before firing scroll event. + + + + + Gets or sets the Shortest interval for firing scroll event. + + + + + Gets or sets the arrow buttons to be shown in an arrow bar. + + + + + Gets or sets the buttons to show enabled. Other buttons are disabled. + + + + + Gets or sets the color of arrows in enabled buttons. + + + + + Resets to default. + + + + + Gets or sets the color of arrows in disabled buttons. + + + + + Resets to default. + + + + + Returns an array with buttons to show when is . + + + + + Returns an array with buttons to show when is . + + + + + Returns an array with buttons to show when is . + + + + + An identifier for various arrow buttons in a . + + + + + None. + + + + + The "previous item" button. + + + + + The "next item" button. + + + + + The "first item" button. + + + + + The "last item" button. + + + + + The "AddNew item" button for items in a table. + + + + + All buttons. + + + + + Helper routines for drawing arrow buttons. + + + + + Calculates coordinates for a centered rectangle. + + The existing bounds. + The size of the rectangle to be centered. + A rectangle inside the specified bounds. + + + + Paints the specified bitmap substituting black pixels with a new color. + + A Graphics object used to draw the bitmap. + A Rectangle which contains the boundary data of the rectangle. + A Point that specifies pixel to offset the bitmap from its origin point. + The Bitmap to be drawn on the screen. + The new color used to substitute black pixels. + A Rectangle which contains the boundary data of the drawn bitmap. + + The PaintIcon routine + will substitute black pixels of the original bitmap and draw them with the + specified forecolor. The bitmap is centered inside the specified bounds. + Use the offset if you want to display a "pressed button" state. If the button is + pressed, specify offset = new Point(1, 1). + + + + + Loads the bitmap from manifest and paints it substituting black pixels with a new color. + + A Graphics object used to draw the bitmap. + A Rectangle which contains the boundary data of the rectangle. + The type of button to draw. + A Point that specifies pixels to offset the bitmap from its origin point. + The new color used to substitute black pixels. + A Rectangle which contains the boundary data of the drawn bitmap. + + The DrawArrow routine + will substitute black pixels of the original bitmap and draw them with the + specified forecolor. The bitmap is centered inside the specified bounds. + Use the offset if you want to display a "pressed button" state. If the button is + pressed, specify offset = new Point(1, 1). + + + + + Draw the arrows in VisualStyle based theme. + Loads the bitmap from manifest and paints it substituting black pixels with a new color. + + A Graphics object used to draw the bitmap. + A Rectangle which contains the boundary data of the rectangle. + The type of button to draw. + A Point that specifies pixels to offset the bitmap from its origin point. + The new color used to substitute black pixels. + A Rectangle which contains the boundary data of the drawn bitmap. + + The DrawArrow routine + will substitute black pixels of the original bitmap and draw them with the + specified forecolor. The bitmap is centered inside the specified bounds. + Use the offset if you want to display a "pressed button" state. If the button is + pressed, specify offset = new Point(1, 1). + + + + + An interface for hosting objects and + receiving clicks from these buttons. + + + + + Gets / sets the color of arrows in enabled buttons. + + + + + Gets / sets the color of arrows in disabled buttons. + + + + + This is a specialized version of the that draws an arrow. Used by in + and . + + + + + Initializes a new . + + + Initializes a new and specifies the for the button. + + Specifies the arrow to be drawn in the button. + + + + Initializes a new and specifies the for the button and owner. + + The owner of this button. + Specifies the arrow to be drawn in the button. + + + + Initializes a new and specifies the for the button, owner, and ToolTip. + + The owner of this button. + Specifies the arrow to be drawn in the button. + The ToolTip for this button. + + + + Returns the arrow to draw. + + + + + + + + + + + + + + Provides event data for the event of + a , or + object. + + + + + Initializes a new object with event data. + + Specifies the arrow button that was clicked. + + + + Gets / sets the arrow button that was clicked. + + + + + Handles the event. + + + + + Returns the values of a record navigation bar. + + + + + Returns the minimum record. + + + + + Returns the maximum record. + + + + + Indicates whether adding new records is enabled. + + + + + To capture the ESC key. + + + + + The record navigation bar displays arrow buttons and current record fields. + + + + + Occurs when the current record is changing. + + + + + Occurs when the current record is changed. + + + + + Initializes a new . + + + + + Gets or sets the value for the control. + + + + + + + + Initializes the record field textbox. + + True if focus should be set to the textbox. + + + + + + + + + + + + + + + + Forces the control to invalidate its client area and immediately redraw itself and any child controls. + + + + + + + + + + + Indicates whether the step for increasing the record position should be increased + when the user holds down the mouse on a record navigation button for a longer period. + + + + + Sets the current record position to first record. + + + + + Sets the current record position to the next record. + + + + + Sets the current record position to the previous record. + + + + + Sets the current record position to the last record. + + + + + Occurs when the specified button was clicked or the mouse is pressed down on the button. + + The source of the event. + + + + + + + + + + + + + + + + Sets the current record position. + + + Sets the current record position. + + The new record index. + Indicates whether record should be applied to text box even if + is not changed. + + + + Sets the current record position and lets you specify if + and events should be raised. + + The new record index. + Indicates whether record should be applied to text box even if + is not changed. + Specifies if + and events should be raised. + + + + Gets or sets the current record position. + + + + + Thread safe method that applies all settings at once. + + The minimum record position. + The maximum record position. + The label to be displayed before the record field text box. + Indicates whether adding new records is enabled. + The current record position. + + + + Gets or sets the minimum record position. + + + + + Gets or sets the maximum record position. + + + + + Indicates whether adding new records is enabled. + + + + + Gets or sets . + + + + + Gets or sets the label to be displayed before the record field textbox. + + + + + Gets or sets an optional maximum label (e.g. "of 1000"). + + + + + Gets or sets the textbox where users can enter record indexes manually. + + + + + + + + Raises the event. + + The new record index. + + + + + + + Raises the event. + + The new record index. + + + + Calculates corrected Y location of numbers. + + Grapchics object. + Output text. + Corrected Y coordinate. + + + + RecordNavigationBar Action List class for SmartTag. + + + + + Initializes the action list to be added. + + + + + Gets/Sets the name of the control + + + + + Label to be displayed before the record field textbox + + + + + Specifies arrow button to be shown in an arrow bar + + + + + Designer class for RecordNavigation bar + + + + + Collection of designer action list object. + + + + + Collection of designer action list object. + + + + + Provides data about a and events of a . + + + + + Initializes a new . + + The record index. + + + + Gets / sets the record index. + + + + + Handles a event of a . + + + + + Handles a event of a . + + + + + A RecordNavigationControl is a splitter frame with a on the bottom left scrollbar. + + + + + Occurs when the current record is changed. + + + + + Occurs when the current record is changing. + + + + + Occurs when the user clicks an arrow button. + + + + + Raises the event. + + An that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Initializes a new . + + + + + + + + + + + + + + + + + Returns the with record information and scroll buttons. + + + + + + + + + + + Forces the control to invalidate its client area and immediately redraw itself and any child controls. + + + + + Gets / sets the current record position. + + + + + Gets or sets the minimum record position. + + + + + Resets to default. + + + + + Gets or sets the maximum record position. + + + + + Resets to default. + + + + + Indicates whether adding new records is enabled. + + + + + Resets to default. + + + + + Gets or sets the label to be displayed before the record field textbox. + + + + + Gets or sets an optional maximum label (e.g. "of 1000"). + + + + + Gets / sets the number of Milliseconds to wait before repeatedly firing scroll event. + + + + + Gets / sets the shortest interval for firing scroll event. + + + + + Gets or sets the arrow button that should be shown in an arrow bar. + + + + + Resets the property to its default value. + + + + + Gets or sets the backcolor of the navigation bar. + + + + + Resets the property to its default value. + + + + + Gets or sets the width of the navigation bar. + + + + + Gets or sets the color of arrows in enabled buttons. + + + + + Resets the property to its default value. + + + + + Gets or sets the color of arrows in disabled buttons. + + + + + Resets the property to its default value. + + + + + + + + + + + Occurs when the user drags the splitter bar. + + The source of the event. + The current horizontal position in pixels. + The current vertical position in pixels. + + + + Provides the control name. + + + + + Gets or sets the value used to customize the appearance of the . + + + This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control. + + + + + RecordNavigationControl Action List class for SmartTag. + + + + + Initializes the action list to be added. + + + + + Gets/Sets the name of the control + + + + + Specifies the style for the RecordNavigationControl + + + + + Specifies arrow button to be shown in an arrow bar + + + + + Specifies the splitter behavior of the control + + + + + Sets the Office like scroll bars + + + + + A designer for the . + + + + + Initializes a new . + + + + + + + + + + + Collection of designer action list object. + + + + + Collection of designer action list object. + + + + + RecordNavigationScrollBar is a with a scrollbar contained in one control. + displays this control in the bottom left corner of the frame. + + + + + + + + Initializes a new with a shared scroll bar control. + + The control that either hosts a scrollbar (a ) or is itself a scrollbar. + + + + + + + + + + + + + Gets / sets the preferred width of this control. + + + + + + + + Handles the NcPaint event of an ScrollControl object. + + + + + Provides data for the NCPaint event of an ScrollControl object. + + + + + Initializes a new instance of the NCPaintEventArgs class. + + + + + + + + + + Gets or sets bounds an ScrollControl. + + + + + Gets or sets bounds of an ScrollControl in screen coordinates. + + + + + Gets or sets clipping region of an ScrollControl. + + + + + + + + + + + Bounds an ScrollControl. + + + + + Bounds of an ScrollControl in screen coordinates. + + + + + Clipping region of an ScrollControl. + + + + + + + + + + + + + + + + + + + Retrieves Office2010 scroll bars + + + + Office2016 style + + + + + Metro style + + + + + Characterize zone which contain mouse down position. + Order of enum's elements can not be changed, because ScrollBarCustomDraw + uses enum's indexes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Characterize Office2010 scroll bar color scheme. + + + + Office2010 blue. + + + Office2010 silver. + + + Office2010 black. + + + Office2010 default color. + + + + Defines the constants that specify color schemes for the Office 2016 theme. + + + + Office2016 black. + + + Office2016 white. + + + Office2016 dark gray. + + + Office2016 colorful color. + + + + Characterize MS-Office scroll bars. + + + + Office2007 Scrollbars. + + + Office2010 Scrollbars. + + + Metro Scrollbars. + + + Office2016 Scrollbars + + + Ordinary Scrollbars. + + + + Characterize zone which contain mouse position. + Order of enum's elements can not be changed, because ScrollBarCustomDraw + uses enum's indexes. + + + + + + + + + + + + + + + + + + + + + + + Specifies the layout and colors for scrollbars. + + + + + + + + + + + + + + Specifies behaviour of size gripper for scrollable frame controls. + + + + + Gripper is visible when both horizontal and vertical scrollbars are visible. + + + + + Gripper is always visible. + + + + + Gripper is always hidden. + + + + + Represents a standard Windows horizontal scroll bar. + + + Most controls that need scroll bars already provide them and do not require this + control. This is true of a multi-line control, + a and a , + for example. + You can use this control to implement scrolling in containers that do not provide their + own scroll bars, such as a or for user input of numeric data. + The numeric data may be displayed in a control or utilized in code. + The and properties + determine the range of values the user can select. The property determines the effect of + clicking within the scroll bar but outside the scroll box. The property determines the effect of + clicking the scroll arrows at each end of the control. + + + + + + + Constructor. + + + + + + + Returns the parameters needed to create the handler. Inheriting classes + can override this to provide extra functionality. They should not, + however, forget to call base.getCreateParams() first to get the structure + filled up with the basic info. + + + + + + + + + + Implements the basic functionality of a scroll bar control. + + + To adjust the value + range of the scroll bar control, + set the and + properties. + To adjust the distance the scroll box moves, set the and properties. To + adjust the starting point of the scroll box, set the property when the + control is initially displayed. + + The scroll box is sometimes + referred to as the "thumb". + + + + + + + + + + + Creates the handler. Overridden to help set up scrollbar information. + + + + + + + + + + + Indicates whether the associated control should scroll while the user is dragging a scrollbar thumb. + + + + + Indicates whether the parent control should show ScrollTips while the user is dragging a scrollbar thumb. + + + checks this property to determine if ScrollTips should be displayed. + + + + + + + + + + + Indicates whether the scroll bar is currently in thumb drag mode. + + + + + Gets / sets the effect of clicking within the scroll bar but outside the scroll box. + + + + + Gets / sets the maximum range of the scroll bar. Default is 100. + + + + + Gets / sets the minimum range of the scroll bar. Default is zero. + + + + + Gets / sets the effect of clicking the scroll arrows at each end of the control. + + + + + Gets / sets the starting value of the scroll bar. + + + + + Gets / sets the background color of this scrollbar. + + + + + Resets the backcolor of the scroll bar. + + + + + Gets / sets the scroll bar style. Default is Flat style. + + + + + Represents a standard Windows vertical scroll bar. + + + Most controls that need scroll bars already provide them + and do not require this control. This is true of a multi-line + control, a + and a , for example. + You can use this control to implement scrolling in + containers that do not provide their own scroll bars, such as + a or for user input + of numeric data. The numeric data may be displayed in a control or utilized in + code. The and + properties determine the range of values the user can select. The property + determines the effect of clicking within the scroll bar but outside the scroll + box. The property + determines the effect of clicking the scroll arrows at each end of the control. + + + + + + + Constructor. + + + + + + + Returns the parameters needed to create the handler. Inheriting classes + can override this to provide extra functionality. They should not, + however, forget to call base.getCreateParams() first to get the structure + filled up with the basic info. + + + + + + + + + + + + + + + + + + + + + + + + + Flag, if true than controls visivble in other case not visible. + + + + + Default size of the horizontal scroolbar. + + + + + + + + + + + Initializes a new instance of the class. + + The owner. + + + + Initializes a new instance of the class. + + + + + Occurs when control size changed. + + + + + + Used for validating visibility of the ControlsAfter and ControlsBefore + + + TODO: place correct comment here + + + + + Reset horizontal scrollbar to default height. + + + + + Gets dockStyle for controls which situated before scroll. + + + + + + Gets dockStyle for controls which situated after scroll. + + + + + + Gets value by cursor position + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Calculates bounds of thumb for scroll control. + + + + + Calculating bounds for leftThumb and rightThumb zones for scroll. + + + + + + + + + + + + + + + + + + + + Provides a property that lets you toggle support for Intelli-Mouse panning. + + + + + Toggles support for Intelli-Mouse panning. When the user presses the middle mouse button and drags the mouse, + the window will scroll. + + + The latest Intelli-Mouse drivers have also built-in . + + + + Implements support for Intelli-Mouse panning. When the user presses the middle mouse button and drags the mouse, + the window will scroll. has built-in support for this call. You only have + to enable . + + + The following code enables support for IntelliMouseDragScroll: + + public bool EnableIntelliMouse + { + get + { + return imm != null and imm.Enabled; + } + set + { + if (value != EnableIntelliMouse) + { + if (imm == null) + { + imm = new IntelliMouseDragScroll(this, true); + imm.AllowScrolling = ScrollBars.Both; + imm.DragScroll += new IntelliMouseDragScrollEventHandler(IntelliMouseDragScrollEvent); + } + imm.Enabled = value; + } + } + } + + void IntelliMouseDragScrollEvent(object sender, IntelliMouseDragScrollEventArgs e) + { + int dy = e.Dy; + int dx = e.Dx; + + this.disableAutoScroll = true; + if (Math.Abs(dy) > Math.Abs(dx)) + { + VScrollBar.SendScrollMessage(dy > 0 ? ScrollEventType.SmallIncrement : ScrollEventType.SmallDecrement); + } + else + { + HScrollBar.SendScrollMessage(dx > 0 ? ScrollEventType.SmallIncrement : ScrollEventType.SmallDecrement); + } + this.disableAutoScroll = false; + } + + + + + + Occurs when the user has dragged the mouse outside the scrolling bitmap. + + + + + Returns the active object, if any. + + + + + Gets / sets the scrolling direction. + + + + + Indicates whether the user is dragging. + + + + + Initializes the object. + + The control to add this functionality to. + + + + Initializes the object. + + The control to add this functionality to. + True if should listen for MouseDown event; + False if dragging should be started manually by calling StartDrag. + + + + Indicates whether to toggle the Intelli-Mouse feature on or off. + + + + + + + + Starts the IntelliMouse dragging at the given screen coordinates. + + Screen coordinates, e.g. Control.MousePosition. + + + + Stops the Intelli-Mouse dragging. + + + + + Returns the bitmap from manifest. Red background in bitmap will be made transparent. + + + + + + + Returns the cursor to be displayed. + + + + + Handles the DragScroll event of an IntelliMouseDragScroll object. + + + + + Provides data for the DragScroll event of an IntelliMouseDragScroll object. + + + + + Initializes a new instance of the IntelliMouseDragScrollEventArgs class. + + The distance in pixels the mouse pointer has been moved horizontally. + The distance in pixels the mouse pointer has been moved vertically. + + + + Gets / sets the distance in pixels the mouse pointer has been moved horizontally. + + + + + Gets / sets the distance in pixels the mouse pointer has been moved vertically. + + + + + Set this to True if you scrolled and do not want default scrolling behavior. + + + + + Implement this interface if you want to add support for shared scrollbars. + + + + + Returns a scrollbar object that implements a horizontal scrollbar. + + + + + Returns a scrollbar object that implements a vertical scrollbar. + + + + + Indicates whether the specified control is activated. + + + + + Handles the MouseWheelZoom events. + + + + + Provides data for the MouseWheelZoom event. + + + + + Initializes a with a given delta. + + The number of rows or columns to scroll. + + + + Returns the number of rows or columns to scroll. + + + + + True if scroll bar is currently in thumb drag mode. + + + + + Indicates whether the associated control should scroll while the user is dragging a scrollbar thumb. + + + + + Indicates whether the parent control should show ScrollTips while the user is dragging a scrollbar thumb. + + + Checks this property to determine if ScrollTips should be displayed. + + + + + + + + + + + Gets / sets a value to be added to or subtracted from to the Value property when the scroll box is moved a large distance. + + + + + Gets / sets the upper limit of values of the scrollable range. + + + + + Gets / sets the lower limit of values of the scrollable range. + + + + + Gets / sets a value to be added to or subtracted from to the Value property when the scroll box is moved a small distance. + + + + + Gets / sets a numeric value that represents the current position of the scroll box on the scroll bar control. + + + + Base class for scrollers control that support visual styles. + + + + + + Key for LargeChangeChanged event. + + + Key for MaximumChanged event. + + + Key for MinimumChanged event. + + + Key for SmallChangeChanged event. + + + Key for ValueChanged event. + + + Key for VisualStyleChanged event. + + + Key for ColorSchemeChanged event. + + + Key for ThemeEnabledChanged event. + + + + Used by threading timer. + + + + + A value to be added to or subtracted from the System.Windows.Forms.ScrollBar.Value + property when the scroll box is moved a large distance. + + + + + Cached m_largeChange + + + + + The upper limit of values of the scrollable range. + + + + + The lower limit of values of the scrollable range. + + + + + A value to be added to or subtracted from the Syncfusion.Windows.Forms.ScrollBarCustomDraw.Value + property when the scroll box is moved a small distance. + + + + + A numeric value that represents the current position of the + scroll box on the scroll bar control. + + + + + Visual style of the ScrollBarCustomDraw. + + + + + Indicates whether to use visual styles. + + + + + Indicates whether thumb is disabled. + + + + + Indicates whether minimum arrow is disabled. + + + + + Indicates whether maximum arrow is disabled. + + + + + Collection of controls that locates above the minimum arrow. + + + + + Collection of controls that locates under the maximum arrow. + + + + + True - say control to keep System settings instead of user defined, otherwise False. + + + + + Renderer which draws the control. + + + + + Array of rectangles that represents regions of the ScrollBarCustomDraw. + + + + + Used when user holds the arrow button clicked. + + + + + Position where was last click. + + + + + Zone where was last click . + + + + + Zone where mouse is over. + + + + + Cached m_selectedZone. + + + + + Zone where is mouse position. + + + + + False if all states is default? in other case value is false. + + + + + Color scheme that used in Rendering. + + + + + Color scheme that used in Rendering. + + + + + Color scheme for Office2016 that used in Rendering. + + + + + Color scheme for Office2010 that used in Rendering. + + + + + Instance of ContextMenu provider. + + + + + To avoid compile error CS0197 in VS2002. + + + + + To prevent validation controls visibility in + and in . + + + + + Indicates whether scrollbar should be refreshed on each value change. + If set to false, scrollbar is invalidated only and therefore is visually refreshed after processing all scrolling messages. + + + + + Scroll bar's owner. + + + + + Metro color table for metro visual style. + + + + + Office2016 black color table for Office2016 visual style. + + + + + Office2016 white color table for Office2016 visual style. + + + + + Office2016 darkgray color table for Office2016 visual style. + + + + + Office2016 colorful color table for Office2016 visual style. + + + + + Gets or sets a value to be added to or subtracted from the System.Windows.Forms.ScrollBar.Value + property when the scroll box is moved a large distance. + + + + + Gets or sets the upper limit of values of the scrollable range. + + + + + Gets or sets the lower limit of values of the scrollable range. + + + + + Gets or sets a value to be added to or subtracted from the Syncfusion.Windows.Forms.ScrollBarCustomDraw.Value + property when the scroll box is moved a small distance. + + + + + Gets or sets a numeric value that represents the current position of the + scroll box on the scroll bar control. + + + + + Gets or sets the text associated with this control. + + + + + Visual style of the ScrollBarCustomDraw. + + + + + Gets or sets a value that indicates whether to use visual styles. + + + + + Gets or sets a value that indicates whether thumb is disabled. + + + + + Gets or sets a value that indicates whether minimum arrow is disabled. + + + + + Gets or sets a value that indicates whether maximum arrow is disabled. + + + + + Collection of controls that locates above the minimum arrow. + + + + + Collection of controls that locates under the maximum arrow. + + + + + True - say control to keep System settings instead of user defined, otherwise False. + + + + + Gets or sets the renderer which draws the control. + + + + + Returns the value that indicates whether RightToLeft is RightToLeft.Yes + + + + + Hide Controls collection from CodeDom serialization. + + + + + Gets or sets the metro color table. + + + + + Gets or sets the color table for Office2016 Black theme scrollbar. + + + + + Gets or sets the color table for Office2016 white theme scrollbar. + + + + + Gets or sets the color table for Office2016 dark gray theme scrollbar. + + + + + Gets or sets the color table for Office2016 colorful theme scrollbar. + + + + + Apply Office2016Black color settings for scrollbar. + + + + + Apply Office2016DarkGray color settings for scrollbar. + + + + + Apply Office2016White color settings for scrollbar. + + + + + Apply Office2016Colorful color settings for scrollbar. + + + + + Gets or sets whether the Office color scheme should be Silver or Blue or Black. + + + + + Gets or sets whether the Metro color scheme should be user defined color. + + + + + Gets or sets whether the Office2010 color scheme should be Silver or Blue or Black. + + + + + Gets or sets whether the Office2016 color scheme should be Black or White or DarkGray or Colorful. + + + This is applicable for both the horizontal and vertical scrollbar. + + + + + Gets / sets the menu provider object that will implement the 's contextmenu. + + + The ScrollBarCustomDraw control automatically initializes this property depending on the presence + of the Syncfusion Essential Tools library. If Essential Tools is available, then the menu provider + object will be an instance of the + type. If not, the class is used for + implementing the standard .NET context menu.

The ScrollersFrame's automatic initialization + should suffice for most applications and you should explicitly set this property only when you + want to override the default menu provider assignment.

 + A implementation; the default + is . + + + + Gets or sets value indicating whether scrollbar should be refreshed on each value change. + If set to false, scrollbar is invalidated only and therefore is visually refreshed after processing all scrolling messages. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + The owner. + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + + + + Initialize the context menu. + + + + + + + + + + + + + + Override. Force recalculation of Scroller elements. + Layout arguments. + To force Layout logic call . + + + + Forces the laying out of combobox elements. + + + Advanced method. You do not have to call this directly. + + + + If outside code will work with collection instead + of our collections and , + then this method will help us in synchronization. + + + + If outside code will work with collection instead + of our collections and , + then this method will help us in synchronization. + + + + + Overridden. See . + + + + + + Occurs when control size changed. + + The event data. + + + + Reset control Width or Heigh to system settings + + + + + Raises the OnLargeChangeChanged event. + + The event data. + + + + Raises the OnSmallChangeChanged event. + + The event data. + + + + Raises the OnMaximumChanged event. + + The event data. + + + + Raises the OnMinimumChanged event. + + The event data. + + + + Raises the OnVisualStyleChanged event. + + The event data. + + + + + Raises the OnMinimumChanged event. + + The event data. + + + + Raises the OnValueChanged event. + + The event data. + + + + Used for validating visibility of the ControlsAfter and ControlsBefore + + + + + + Overridden. See . + + + + + + Redraws scroll control when RightToLeft is changed. + + + + + + Overridden. See . + + + + + + Overridden. See . + + + + + + Overridden. See . + + + + + + Overridden. See . + + + + + + Occurs when mouse down and cursor change position. + + + + + + + Gets min button. Possible variants: Left or Down. + + + + + + Gets max button. Possible variants: Right or Up. + + + + + + Defines pressed zone. + + + + + + + + Recalculates bounds of the ScrollBarCustomDraw. + + + + + Recalculates bounds of the arrow buttons. + + + + + Recalculates bounds of the thumb. + + + + + If scroll contain all controls than controls is visible, in other case value is false. + + + + + + Gets DockStyle of afterControls. + + + + + + Gets DockStyle of beforeControls. + + + + + + used for calculates thumb offset. + + + + + + + + + + + + + + + + + + Utility API that open to user opportunity to destroy handle in runtime. + Very usefull for runtime resource cleanup. + + + + + Sets small change if value is less than large change; otherwise sets small change to large change. + + Value to set. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Method accumulate width and height of the controls in + specified collection. + + Method accumulate width and height of the controls in + specified collection. + collection of controls. + Accumulated values. + + + + Excludes/includes controls in collection. + + If true - excludes, else includes controls in collection. + + + + + + + + X coordinate of mouse. + Y coordinate of mouse. + + + + Sets value, but OnValueChanged don't raise. + + + + + + Dispose controls of ScrollBarCustomDraw. + + Collection of controls to be disposed. + + + + Creates and displays the context menu for the control. + + + + + + Used to raise the mouse event + + The args contains the MouseEventArgs data + + + + Used to raise the mouse event + + The args contains the MouseEventArgs data + + + + Used to raise the mouse event + + The args contains the MouseEventArgs data + + + Design time helper class. Do not allow resizing of scrollers + when set KeepSystmeMetrics property to TRUE value. + + + Typed version of control reference extracting. + + + Override selection rule only in case of KeepSystemMetrics value set to True. + + + + Defines an interface that provides all properties to configure a scrollbar. + + + + + Gets or sets a value to be added to or subtracted from the value of the property when the scroll box is moved a large distance. + + + + + Gets or sets the upper limit of values of the scrollable range. + + + + + Gets or sets the lower limit of values of the scrollable range. + + + + + Gets or sets the value to be added to or subtracted from the value of the property when the scroll box is moved a small distance. + + + + + Gets or sets a numeric value that represents the current position of the scroll box on the scroll bar control. + + + + + Gets or sets a number that represents the current position of the scroll box on the scroll bar control. + + + + + Updates the scrollbar with latest changes to current position and scrollable range. + + + + + Enables or disables thumbtrack feature for the scrollbar. + + + + + Indicates whether the scrollbar is in thumb drag mode. + + + + + Indicates whether ScrollTips should be shown for the scrollbar. + + + + + Defines an interface that provides all properties to configure a scrollbar. + + + + + Gets / sets a value to be added to or subtracted from the value of the property when the scroll box is moved a large distance. + + + + + Gets / sets the upper limit of values of the scrollable range. + + + + + Gets / sets the lower limit of values of the scrollable range. + + + + + Gets / sets the value to be added to or subtracted from the value of the property when the scroll box is moved a small distance. + + + + + Gets / sets a numeric value that represents the current position of the scroll box on the scroll bar control. + + + + + Gets / sets a number that represents the current position of the scroll box on the scroll bar control. + + + + + Gets / sets a number that represents the current position of the scroll box on the scroll bar control. + + + + + Returns a reference to a scrollbar contained in a user control. + + + Splittercontrol and Workbookcontrol check for the IScrollBarContainer to get the + scrollbar. This enables you to replace the shared scrollbar with any user control + that also has a scrollbar. An example is the . + + + + + Gets / sets the contained scrollbar in a user control. + + + + + ScrollbarWrapper manages scrollbars for a control and hides details about the scrollbar + from the control that utilizes ScrollBarWrapper. This allows you to replace the concrete + ScrollBar with , , + or any custom scrollbar implementation. + + + + + Occurs when the scroll box has been + moved by either a mouse or keyboard action. + + + + + Occurs when the property has changed, either by a + event or programmatically. + + + + + Overloaded. Initializes a new instance of the class. + + The parent control. + The scrollbar type: horizontal or vertical. + + + + Initializes a new instance of the class. + + The parent control. + The scrollbar type: horizontal or vertical. + The scrollbar object to be managed by this instance. + + + + The style info of the scrollbar. + + + + + Gets or sets the with settings that control the appearance of the scroll bar. + + + + + Implements the method and releases all managed resource for this object. + + + + + Indicates whether the control should scroll while the user is dragging a scrollbar's thumb. + + + + + Indicates whether the parent control should show ScrollTips while the user is dragging a scrollbar thumb. + + + Checks this property to determine if ScrollTips should be displayed. + + + + + Gets / sets a reference to the scrollbar that is contained in this wrapper class. + + + + + Copies all information to another object. + + The to receive all copied information. + + + + True if this is a Reflecting scrollbar; False if it is a simple scrollbar. + + + + + True if this is a flat scrollbar; False if it is a simple scrollbar. + + + + + True if scroll bar is currently in thumb drag mode. + + + + + True if this is a Reflecting scrollbar; False if it is a simple scrollbar. + + + + + Raises the event. + + . + An that contains the event data. + + + + Suspends updating the scrollbar until is called. + + + + + Resumes updating the scrollbar after a call. + + + + + Indicates whether updating is locked. See . + + + + + Fetches scrollbar information from the managed scrollbar object and updates the information + in the object. + + + + + Applies scrollbar information to the managed scrollbar object based on the information + in the current object. + + + + + Gets / sets a value to be added to or subtracted from the value of the property when the scroll box is moved a large distance. + + + + + Gets / sets the upper limit of values of the scrollable range. + + + + + Gets / sets the lower limit of values of the scrollable range. + + + + + Gets / sets the value to be added to or subtracted from the value of the property when the scroll box is moved a small distance. + + + + + Gets / sets a numeric value that represents the current position of the scroll box on the scroll bar control. + + + + + Gets / sets a number that represents the current position of the scroll box on the scroll bar control. + + + + + Call this for reflected scrollbars from your parent control's method if you + want to support reflected scrollbars (those window scrollbars that you enable with WS_VSCROLL and + WS_HSCROLL window styles). + + The that was passed as argument to . + + + + Sends or emulates a scroll event. + + + + + + Returns a reference to the parent control. + + + + + Gets / sets ScrollButton highlighted state. + + + + + + + + + + + + + + Blend 30% of menu selection color. + + + + + Gets / sets for correctly GradientBrush creation, so that background + is same as Parent's background. + + + + + + + + + + + + + + + + + It contains the value of the property. + + + + + Gets or sets the value used to customize the appearance of the . + + + This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control. + + + + + Helps to apply the ControlName settings in control + + ThemeName + + + + Helps to apply the CanOverriderStyle settings in control + + CanOverriderStyle + + + + Helps to apply the CanApplyTheme settings in control + + CanApplyTheme + + + + Helps to apply the ThemeName settings in control + + ThemeName + + + + Represents the class to define the style of control. + + + + + Maintains the default style of the . + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + The store. + + + + Gets the default ScrollButtonsStyleInfo value. + + + + + + + + + + + + + + + + + + + Provide the default style of the . + + Default style object. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Represents the class holds the plain data for a style object excluding identity information. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Maintains the static data. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Populates the SerializationInfo store with the name, type, and value of each piece of information it wants to serialize + Describes the source and destination of a given serialized stream, and provides an additional caller-defined context. + + + + Overridden to get the static data source. + + + + + Implements the class that provide the identity information of + using . + + + + + Maintains the ScrollButtons for create the identity. + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + This interface provides properties for accessing a vertical and horizontal + and an method. + + + + + Returns a reference to an object with vertical scrollbar settings of the control. + + + + + Returns a reference to an object with horizontal scrollbar settings of the control. + + + + + Updates scrollbars to reflect recent changes in scroll position, minimum and maximum scroll position values. + + + + + Provides support for method. + + + + + Indicates whether this control contains focus. Override this method if you + want to show drop-down windows and indicate the control has not lost focus when + the drop-down is shown. + + True if the control or any child control has focus; false otherwise. + + + + A ScrollTip window is a top-level window that gives feedback about the + current scroll position when the user grabs a scrollbar thumb and drags it. + + + + + + + + + + + Initializes a new . + + + + + + + + + + Raises the event and refreshes the contents of the window. + + The with event data. + + + + + + + + + + + + Gets / sets the border style of the control. + + + + Gets / sets the text layout information for the text in the ScrollTip. + + + + + Returns the optimal size for the window to fit the given text. + + The text that should fit into the window. + A with the window size of the ScrollTip. + + + + Specifies the current ScrollTip state when a event was raised. + + + + + The user has grabbed the thumb. The ScrollTip should be shown. + + + + + The user has released the thumb. The ScrollTip should be hidden. + + + + + The user is dragging the thumb. The ScrollTip text should be updated. + + + + + Handles the event. + + + + + + + + Provides data for the event. + + + + + + + + Constructs a object. + + The exception that was cached. + + + + Returns the exception that was cached. + + + + + Handles the ScrollTip event. + + + + + + + + Provides data for the event. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns the scrollbar that is the source of this event. + + + + + Returns a value that specifies the user action that led to this event. + + + + + Returns the new scroll position. + + + + + Gets / sets the text to display in the ScrollTip. You can change this text in your event handler during + a Scroll action. + + + + + Gets / sets the size of the ScrollTip window. You can adjust the scroll window size in your event handler + when handling a ThumbTrack action. + + + + + Gets / sets the location of the ScrollTip window. You can adjust the scroll window size in your event handler + when handling a ThumbTrack action. + + + + + Gets / sets the font to be used for the ScrollTip text. You can adjust the scroll window size in your event handler + when handling a ThumbTrack or Scroll action. + + + + + Gets / sets the text color to be used for the ScrollTip text. You can adjust the scroll window size in your event handler + when handling a ThumbTrack or Scroll action. + + + + + Gets / sets the backcolor to be used for the ScrollTip text. You can adjust the scroll window size in your event handler + when handling a ThumbTrack or Scroll action. + + + + + Gets / sets the border style to be used for the ScrollTip text. You can adjust the scroll window size in your event handler + when handling a ThumbTrack action. + + + + + Gets / sets the text layout information for the text in the ScrollTip. + + + + + BeginUpdateOptions details which drawing operations should be performed during a batch of updates. + + + + + The control suspends any drawing and invalidation and will do a complete refresh when EndUpdate is called. + + + + + Regions that need to be redrawn afterward should be marked invalid by calling the controls Invalidate method. + + + + + ScrollWindow will scroll the window. + + + + + Scrollbars should be synchronized with the current scroll position. + + + + + Allows invalidating regions, scrolling and synchronizes the scrollbar thumb. + + + + + Contains data for the WindowScrolling and WindowScrolled event. + + + ScrollWindow will raise a WindowScrolling event before it scrolls the window and a WindowScrolled event after the scrolling. + + + + + + + + + + + + + + + + + + + + Initializes a new . + + The horizontal scroll distance in pixel. + The vertical scroll distance in pixel. + The bounds of the rectangle that is scrolled. + Clipping rectangle. + The rectangle that was scrolled into view. + + + + Returns the horizontal scroll distance in pixels. + + + + + Returns the vertical scroll distance in pixels. + + + + + Returns the bounds of the rectangle that is scrolled. + + + + + Returns the Clipping rectangle. + + + + + Returns the rectangle that was scrolled into view. + + + + + + + + + + Handles the scroll window event. + + + + + + + + Provides a global hook for exceptions that have been cached inside the framework and gives you + the option to provide specialized handling of the exception. You can also temporarily suspend and resume + caching exceptions. + + + The Syncfusion framework notifies about exceptions that + are cached by calling or . + The method will raise the + event. By handling the event, your code can analyze the exception that was cached + and optionally let it bubble up by rethrowing the exception. + Your code can also temporarily suspend and resume caching exceptions. This is useful if you want to provide your + own exception handling. Just call to disable handling exceptions and + to resume caching exceptions. + You also have the options to disable caching exceptions altogether by setting to True. + Note: All static settings for this class are thread local. + + + // The following example demonstrates temporarily suspending exception caching when calling a base class version + // of a method. + protected override void OnMouseDown(MouseEventArgs e) + { + ExceptionManager.SuspendCatchExceptions(); + try + { + base.OnMouseDown(e); + ExceptionManager.ResumeCatchExceptions(); + } + catch (Exception ex) + { + ExceptionManager.ResumeCatchExceptions(); + // Notify exception manager about the catched exception and + // give it a chance to optionally rethrow the exception if necessary + // (e.g. if this OnMouseDown was called from another class that + // wants to provide its own exception handling). + if (!ExceptionManager.RaiseExceptionCatched(this, ex)) + throw ex; + // handle exception here + MessageBox.Show(ex.ToString()); + } + } + + + // This code sample shows how exceptions are handled within the framework: + try + { + CurrentCell.Refresh(); + } + catch (Exception ex) + { + TraceUtil.TraceExceptionCatched(ex); + if (!ExceptionManager.RaiseExceptionCatched(this, ex)) + throw ex; + } + + + + + + + + + + + + + + + + + + + + Occurs when an exception was cached within the framework and was notified. + + + + + Lets you disable caching exceptions altogether by setting to True. + + + + Temporarily suspends caching exceptions. + + + + + Temporarily resumes caching exceptions. + + + + + Indicates whether exceptions should be cached or if they should bubble up. + calls this method. + + + + + + Raises the event. + + + Raises the event. If caching exceptions has been disabled + by a call or if has been set to True, + the exception is rethrown. + + A that contains the event data. + + + + + + Raises the event. If caching exceptions has been disabled + by a call or if has been set to True, + the exception is rethrown. + + A that was cached. + + + + + + Specifies the acceleration behavior for scrollbars. + + + + + Disable scrollbar acceleration. + + + + + Default, moderate acceleration after the user scrolled 60 increments. + + + + + Acceleration after the user scrolled 20 increments. + + + + + Immediate acceleration after the user scrolled 4 increments. + + + + + Specifies the type of autoscrolling, either scrollbar acceleration or mouse dragging outside window bounds. + + + + + The user held down a scrollbar button. + + + + + The user has dragged the mouse outside the autoscroll bounds. + + + + + The user is moving the mouse over the control during OLE drag-and-drop operation. + + + + + Handles the event. + + + + + + + + Provides data for the event which is called + when accelerated scrollbar scrolling or mouse drag-scrolling starts. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns the type of autoscrolling, either scrollbar acceleration or mouse dragging outside window bounds. + + + + + Returns the scroll bar direction: vertical, horizontal, or both. + + + + + Gets / sets the interval that is initially assigned to the timer for recurring scrolling. + + + + + Gets / sets the interval step that the timer should be decreased from time to time. + + + + + Gets / sets the minimum interval for the fastest scroll speed. + + + + + + + + Defines a base class for custom controls that support scrolling behavior. + + + The ScrollControl class acts as a base class for controls that require the + ability to scroll. To allow a control to display scrollbars as needed, + set the AutoScroll property to True. To select which scrollbars should be visible, + set the VScroll and HScroll properties. + You can also associate stand-alone scrollbars with the ScrollControl. The VertScrollBar + and HorizScrollBar properties allow you to associate external scrollbars. This is of benefit + if you want to share one scrollbar with a parent control. For example, if the ScrollControl + is a view inside a workbook or dynamic splitter frame. + ScrollControl supports automatic scrolling when the user drags the mouse. In a grid + when the user starts selecting cells the user can drag the mouse outside the grid + area and the grid will automatically scroll. To enable auto scrolling, override the + OnMouseDown event in your derived control and initialize the AutoScrolling, AutoScrollBounds + and InsideScrollBounds properties. + When the user scrolls your control and holds down the mouse on the down or up arrow + of the scrollbar, the scrolling speed will accelerate. + The FixRenderOrigin method will ensure correct initialization of the rendering origin + for brushes and patterns. You can call FixRenderOrigin from your control's OnPaint method. + ScrollControl supports scrolling with the mouse wheel and also cooperates fine with + with the IntelliMouseDragScroll class. + If you want to provide context information about your control and change the cursor on + the fly while the user moves the mouse, set the OverrideCursor property to the cursor + you want to show. Instead, you can also implement IMouseController and add the object + to MouseControllerDispatcher. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Internal only. + + + + + Internal only. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Indicates the shared behavior of the vertical scrollbar + + + + + Indicate the shared behavior of the horizontal scrollbar + + + + + Holds the style info collection for the scroll control elements. + + + + + The SizeGripStyle behavior has been changed after version 6.1. + For old behavior set this to true. Default value is false. + + + + + Indicates whether the time the first time the control is drawn should be optimized + by calling OnPaint before the control is made visible and so that all relevant code for drawing + has been jitted (Just in Time) + + + + + Gets / sets the cursor that is displayed when the mouse pointer is over the control. + + A object. + + + + Disables or specifies the direction for automatic scrolling when the user drags + the mouse cursor out of the scrolling area. + + ScrollBars.None will disable scrolling.ScrollBars.Horizontal will enable horizontal scrolling.ScrollBars.Vertical will enable vertical scrolling.ScrollBars.Horizontal|ScrollBars.Vertical will enable both horizontal and vertical scrolling. + + + + Lets you check or specify the setting if the window should be scrolled when ScrollWindow is called. + + If DisableScrollWindow is True, any calls to the ScrollWindow method will simply invalidate the affect region. The rendering origin will + still be recorded correctly and WindowScrolling and WindowScrolled events will be raised.If DisableScrollWindow is False, the ScrollWindow will scroll the contents of the control. + DisableScrollWindow will return True if BeginUpdate was called without the BeginUpdateOptions.ScrollWindow option. + + + + + + + + Indicates whether the control should scroll while the user is dragging a scrollbar thumb. + + + + + Indicates whether the control should scroll while the user is dragging a vertical scrollbar thumb. + + + + + Indicates whether the control should scroll while the user is dragging a horizontal scrollbar thumb. + + + + + Indicates whether the control should show ScrollTips while the user is dragging a vertical scrollbar thumb. + + + + + Indicates whether the control should show ScrollTips while the user is dragging a horizontal scrollbar thumb. + + + + + Gets or sets a size grip that should be drawn at the bottom-right corner if both scrollbars + are visible. + + + + + Indicates whether a size grip can be drawn inside the SizeBox and if the + of the parent form is allowed to be changed. + + + + + Indicates whether the size box should always be drawn when both scrollbars are visible. This + property differs from such that the control will not + check the docking state and parent form to determine whether to show the size box. + Note: Another better solution is drawing NonClientArea + ourselves. See SizeGripStyle which implements this newer solution. + + + Showing the size box works around a problem with .NET controls because by + default the area at the bottom right is not drawn and that can cause + drawing glitches. Note: Another better solution is drawing the NonClientArea + ourselves. See SizeGripStyle which implements this newer solution. + + + + + Indicates whether the size box should be drawn when both scrollbars are visible + and the control is not a docked window in an MDIChild window. Note: Another better solution is drawing the NonClientArea + ourselves. See SizeGripStyle which implements this newer solution. + + + Showing the size box works around a problem with .NET controls because by + default the the area at the bottom right is not drawn and that can cause + drawing glitches. Note: Another better solution is drawing NonClientArea + ourselves. See SizeGripStyle which implements this newer solution. + + + + + Indicates whether the control is currently scrolling and the user drags + the mouse outside the inner scrolling area. + + + + + Returns a reference to an object with vertical scrollbar settings of the control. + + + + + Returns a reference to an object with horizontal scrollbar settings of the control. + + + + + Internal only. Toggles thumb track mode. See ScrollBarWrapper.IsThumbTracking for a public getter for this state. + + + + + Indicates whether the scroll control can increase the + property while doing accelerated scrolling. If this is True, the + will be set to 3 after 40 rows and to 5 after 80 rows. + + + By default the scroll control will increase the scrolling step after a while. Set this to + False if you want to enforce scrolling only one row at a time even with accelerated scrolling. + + + + + Gets or sets the outer scrolling area. Typically the client area of the control. + + + + + Returns the inside scrolling area. The control will scroll if the user drags + the mouse outside this area. + + + + + Gets or sets the default margins for the scrolling area when the user moves the mouse to the + margin between InsideScrollBounds and AutoScrollBounds. + + + + + Returns a reference to the for this control. Can be NULL. + + + + + Gets or sets the text to be displayed in the ScrollTip window with a place holder for scroll position . For example, " Position {0} " + + + + + Immediately changes the shown cursor. + + + + + Indicates whether the control is handling a event. + + + + + Indicates whether the method has been called. and resets this flag. + + + + + Indicates whether the method has been called. and resets this flag. + + + + + Indicates whether has been called. resets this flag. + + + + + Indicates whether has been called. resets this flag. + + + + + Indicates whether has been called. resets this flag. + + + + + ScrollControlMouseController checks this to see if it should cancel + existing mouse operation and call ScrollControlMouseController.CancelMode + when a UICuesChanged event is sent. That can happen when user activates + another application or simply when styles for a child window have changed. + + + + + Returns the Pane information. + + + + + Lets you override the scroll behavior for rolling the mouse wheel. Default is SystemInformation.MouseWheelScrollLines. + + + + + Indicates whether the control should perform one scroll command (faster) or + if it should perform multiple scroll commands with smaller increments (smoother) + when user rolls mouse wheel. + + + + + Gets or sets the multiplier for mouse wheel scrolling. + + + + + Gets or sets the multiplier for mouse wheel scrolling. + + + + + Enables shared scrollbars. Use this if the control is not embedded in a container control + that implements IScrollBarFrame and you want to provide your own scrollbars. + + + + Gets / sets the border style of the control. + + + + Indicates whether the horizontal scroll bar is visible. + + if the horizontal scroll bar is + visible; otherwise. + + + + + + Indicates whether the vertical scroll bar is visible. + + if the vertical scroll bar is + visible; otherwise. + + + + + + Indicates whether the splitter control has closed the pane with this control. + + + + + MouseControllerDispatcher coordinates mouse events among competing mouse controllers. Based on + the position of the mouse and context of the control every registered controller's HitTest method + is called to determine the best controller for the following mouse action. This controller will then + receive mouse events. + + + See for more information. + + + + + Returns a reference to the active mouse controller that is receiving MouseDown, MouseMove, MouseUp messages when the user + has pressed a mouse button. + + + + + + + + + Toggles support for using the control inside a dynamic splitter window and sharing scrollbars + with the parent window. + + + + + Indicates whether the splitter control is closing the pane with this control. + + + + + Toggles support for Intelli-Mouse panning. When the user presses the middle mouse button and drags the mouse, + the window will scroll. + + + + + + + + + + + When you call BeginUpdate(), the control by default does not handle WM_PAINT messages. Only + once you call EndUpdate they will be processed. If this causes problems in your application, you can + set this static property to True. In such cases, WM_PAINT messages will be simply discarded and + any invalid regions will be validated. + + + There is a problem with the default implementation of BeginUpdate. If a screen region is marked + invalid, the WndProc will be repeatedly called with WM_PAINT at the the top of the WndProc + until EndUpdate is called. This can cause your application to freeze if another window gets created + or if you make a web service call and WndProc messages need to be processed. + Setting DiscardPaintMessagesAfterBeginUpdate to True will help avoid these scenarios. + + + + + Returns true if object is executing method call. + + + + + Property MousePosition (Point) - cached Control.MousePosition. The variable is set + before any WM_MOUSE* messages being processed. + + + + + Gets or sets the acceleration behavior for scrollbars. + + + + + Indicates whether OnMouseMove should be called from OnDragOver. + + + + + + Gets or sets the control's size. Size is overridden here to prevent Code Generation in Designer. + + + + + + Gets or sets the control's bounds. Size is overridden here to prevent Code Generation in Designer. + + + + + Gets or sets the TabIndex. + TabIndex is overridden here to prevent Code Generation in Designer. + + + + Returns the settings for the current BeginUpdate option. + + + + + + + + Indicates whether BeginUpdate() has been called and the painting for a control is suspended. + + + + + Indicates whether there are updates pending for the control when painting is suspended by BeginUpdate. + + + + + Determines if EnableDoubleBufferSurface method was called and double buffering + using the DoubleBufferSurface is enabled. The DoubleBufferSurface buffering + is different from the automatic .NET double buffering and also a bit slower but + it reduces flicker if lots of scrolling is used and gdi drawing for individual cells + in a grid. + + + + + Returns the DoubleBufferSurface if EnableDoubleBufferSurface() was called. Otherwise + the method returns null. + + + + + Indicates whether is internally called. + + + + + Gets or sets a style of the ScrollControl components. + + + + + Occurs when both and occur. + + + + + Occurs when the property has been changed. + + + + + Occurs when vertical scrollbar is moved. + + + + + Occurs when horizontal scrollbar is moved. + + + + + Occurs when the user presses the mouse wheel and drags the mouse. + + + Set of + to True if you provide customized scrolling in your event handler. + + + + + The ShowContextMenu event occurs when the user right-clicks inside + the control. + + + + You can cancel showing a content menu when + you assign True to . + + + + + + Occurs when accelerated scrollbar scrolling or mouse drag-scrolling starts. + + + + + Occurs when the splitter control has closed the pane with this control. + + + + + Occurs when the splitter control is closing the pane with this control. + + + + + Occurs when the user is dragging the scrollbar thumb. + + + + + Occurs when scrollbars are hidden or shown. + + + + + Occurs when the user holds the Control Key and rolls the mouse wheel. + + + + + Occurs when the value has changed. + + + + + Occurs when has been called the first time or + has been called the last time. + + + + + Occurs after the window has been scrolled. + + + + + Occurs while the window is being scrolled. + + + + + Occurs before a is raised and allows you to cancel the mouse event. + + + + + Occurs after a is raised. + + + + + Occurs before a is raised and allows you to cancel the mouse event. + + + + + Occurs after a event is raised and after auto-scrolling. + + + + + Occurs before a is raised and allows you to cancel the mouse event. + + + + + Occurs after a event is raised. + + + + + Occurs when the window receives a WM_CANCELMODE message. + + + WM_CANCELMODE is sent to cancel certain modes, such as mouse capture. + For example, the system sends this message to the active window when a + dialog box or message box is displayed. Certain functions also send this + message explicitly to the specified window regardless of whether it is the + active window. For example, the EnableWindow function sends this message + when disabling the specified window. + + + + + Occurs when the AutoScrolling property is changed. + + + If you want to prevent autoscrolling, you should handle this event + and reset the AutoScrolling property to ScrollBars.None. + + + + + Initializes a new instance of . + + + + + Disposes the control. + + + + + + + + + + Raises a CancelMode for the active mouse controller for this control. + + holds a collection of mouse controllers. + + + + + + + + + + + + + + + + + + + + + Indicates whether serialize property value or not. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Offsets the point. + + + + + + + Returns PointToClient(LastMousePosition). + + + + + + Returns a value indicating the context at a given mouse position. + + + Returns a value indicating the context at a given mouse position. + + The mouse position in client coordinates. + A value indicating the context at a given mouse position; zero if no context found. + + Any Mouse Controller needs to implement the IMouseController interface. + In its implementation of MouseController.HitTest the mouse controller determines whether it + wants to handle the mouse events for the current mouse position. + MouseControllerDispatcher will call HitTest for each Mouse Controller that has been registered with + Add(IMouseController). The Mouse Controller that wins the vote will be returned together with the + context value its HitTest implementation returned. + + + + + Returns a value indicating the context at a given mouse position. + + The mouse position in client coordinates. + Indicates which mouse button was pressed. + A value indicating the context at a given mouse position; 0 if no context found. + + + + + Returns a value indicating the context at a given mouse position. + + The mouse position in client coordinates. + Indicates which mouse button was pressed. + A place holder where the controller is returned that won the vote. + A value indicating the context at a given mouse position; 0 if no context found. + + + + + Returns a value indicating the context at a given mouse position. + + The mouse position in client coordinates. + Indicates which mouse button was pressed. + Specifies the number of times the mouse button was pressed and released. + A place holder where the controller is returned that won the vote. + A value indicating the context at a given mouse position; 0 if no context found. + + + + + Overridden. Changes to show or hide scrollbars and also consider the control's + setting. + + + + + + + + + + + + + + + + + + + + + + Handles the WM_SETCURSOR message + + + + + + + + + + + + + + + + + + + + + + + Initialize the last vertical scroll value. + + + + + Initialize the last horizontal scroll value. + + + + + Used to save the touch start position. + + + + + Used to check the touch mode is enabled or not. + + + + + Used to check touch on the Horizontal scroll bar or not. + + + + + Used to check touch on the Vertical scroll bar or not. + + + + + Used to save the object for MultiTouch to configure the touch. + + + + + Gets or sets the touch mode. + + + + + Used to disable the Gesture. + + + + + Decode the touch messages to do corresponding operations + + windows touch messages + return true when the message properly handled otherwise it will be false + + + + Gets or sets the color table for Office2016 Black theme scrollbar. + + + + + Gets or sets the color table for Office2016 white theme scrollbar. + + + + + Gets or sets the color table for Office2016 Dark gray theme scrollbar. + + + + + Gets or sets the color table for Office2016 colorful theme scrollbar. + + + + + Applies the color table for scrollbars. + + + + + Apply the color settings for Office2016 scrollbar. + + Scrollbar visual styles + + + + Apply Office2016Black color settings for scrollbar. + + + + + Apply Office2016DarkGray color settings for scrollbar. + + + + + Apply Office2016White color settings for scrollbar. + + + + + Apply Office2016Colorful color settings for scrollbar. + + + + + Gets or sets the Office2016 Scrollbars + + + + + Toggles between standard and Office2007 scrollbars. + + + + + Raises the event. + + A that contains the event data. + + + + Get or Set of Skin Manager Interface + + + + + Gets or sets the style of Office2007 scroll bars. + + + + + Raises the event. + + Event data. + + + + Occurs when the property has changed. + + + + + Raises the event. + + Event data. + + + + Occurs when the property has changed. + + + + + Raises the event. + + Event data. + + + + Occurs when the property has changed. + + + + + Raises the event + + Office scrollbar type + + + + Provides the data about event of a . + + + + + Initializes a new . + + The record index. + + + + Gets or sets the Office scroll bars + + + + + Occurs when the property has changed. + + + + + Occurs when the property has changed. + + + + + Gets the rectangle that represents the client area of the control. If custom + scroll bars (ScrollBarCustomDraw, Office2007 style) are shown in the client area, then + this method will remove the area occupied by the scrollbars. + + + + + Gets or sets the height and width of the client area of the control. If custom + scroll bars (ScrollBarCustomDraw, Office2007 style) are shown the client area, then + this method will remove the area occupied by the scrollbars. + + + + + Gets or sets the Office like scrollbars. + + + + + Checks whether current theme is VisualStyle based theme or not. + + + + + Helps to set the scrollbars based on visual style. + + + + + + Apply the color scheme for Office2016 scrollbar. + + + + + Gets or sets the style of MS Office2010 scroll bars. + + + + + Gets or sets the style of Office2016 theme for scrollbars. + + + This is applicable for both the horizontal and vertical scrollbar. + + + + + + + + + + Handles mouse wheel processing for our scrollbars. + + + + + + Raises the event. + + An that contains the event data. + + + + Raises the event. + + An that contains the event data. + + + + Raises the event. + + An that contains the event data. + + + + Fires the ScrollbarsVisibleChanged event. + + A that contains the event data. + + + + Override this method to implement zooming in your derived control. + + The event data. + + + + Raises the event. + + A that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Initially save the current scrollbar values when begin the panning operation + + Touch begin position + return true + + + + Adjust the HScrollBar and VScrollBar values based on current touch position + + Current touch position + Used to decide the doing swipe operation or pan operation + + + + + After panning operation completes save the current scroll bar values + + touch end position + return true + + + + + + + + + + + + + + + + + + + Raises the event. + + A that contains the event data. + + + + + + + + + + + + + + + + + Handles the of the horizontal scrollbar. + + The source of the event. + An that contains the event data. + + + + Handles the of the vertical scrollbar. + + The source of the event. + An that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Listens for the horizontal scrollbar's scroll event. + + + A that contains data about the control. + + + A that contains the event data. + + + + + Listens for the vertical scrollbar's scroll event. + + + A that contains data about the control. + + + A that contains the event data. + + + + + Raises the ShowContextMenu event when the user right-clicks inside + the control. + + You can cancel showing a content menu when + you assign True to . + + + + + + Raises the event. + + An that contains the event data. + + + + Raises the event. + + + + + + Method calculate new client area size. If you want to increase Non-Client + area for control and draw on it then this is method especially for you. + + Rectangle of the control client area. + + + + Raises the event. + + A that contains the event data. + + + + Factory method that creates a for displaying ScrollTips. + + + + + + + + + + + Raises the event. + + An that contains the event data. + + + + Raises the event. + + A that contains the event data. + + The event handler for this event can check + to determine if or + was called. + + + + + Overridden. See the event. + + An that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + Raises the event. + + A that contains the event data. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Raises the event. + + An that contains the event data. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Raises the event. This method is called when the control + or any child control gets focus and this control did not have focus before. + + + Inheriting classes should override this method instead of overriding + because is also called when child controls get focus and it + is not called when focus is moved within child controls of this control. + + + + + Raises the event. This method is called when the control + or any child control loses focus and the new focused control is not a child of this control. + + + Inheriting classes should override this method instead of overriding + because is also called when child controls lose focus and it + is not called when focus is moved within child controls of this control. + + + + + This method is called if the control's notification occurs + while handling a event. This typically occurs if a + message box is displayed from a event handler. + + + + + Minimizes the time the first time the control is drawn. Calling + OnPaint before the control is made visible ensures that all relevant code for drawing + has been jitted. + + + + + Raises the event. + + An that contains the event data. + + + + + + + + + + + + + + + + + + + + + + + + + + Given a component, this retrieves the that it is parented to; + NULL if it is not parented to any . + + + The component to check. + + + A that the component is parented to; NULL if + no such interface exists. This will return the component if it + is an instance of . + + + + + Given a component, this retrieves the that it is parented to; + NULL if it is not parented to any . + + + The component to check. + + + An that the component is parented to; NULL if + no such interface exists. This will return the component if it + is an instance of . + + + + + Delegates the MouseWheelEvent from a child control. + + A MouseEventArgs that holds event data. + + public class GridTextBox: RichTextBox + { + private GridTextBoxCell parent; + protected override void OnMouseWheel(MouseEventArgs e) + { + parent.Grid.ProcessMouseWheel(e); + } + } + + + + + Invalidate the vertical scrollbar + + + + + Invalidate the horizontal scrollbar + + + + + + + + The scrollbar height and width will be increased, when the DPI of system is increased. + + + ScrollBarCustomDraw + + + + Gets or sets the boolean value for enhanching the apperance settings for DpiAware enabled Application. + + + + + Displays / hides the horizontal and vertical autoscrollbars. This will + also adjust the values of formState to reflect the new state. + + + True if the horizontal scrollbar should be displayed. + + + True if the vertical scrollbar should be displayed. + + + True if the form needs to be layed out again. + + + + + Resets the property. + + + + + Raises the specified mouse event and catches any exception. If an exception is caught, NotifyCancelMode + is called. Returns False if event should be ignored by the grid. + + A that contains the event data. + A delegate that handles the event. + False if CancelMouseEventArgs.Cancel is True; True otherwise + + + + + + + + Method force to invalidate Non Client area of control. + + + Invalidate specified rectangle in Non Client area. + Rectangle to Invalidate. + + + Invalidate and wait till area update on Non Client area. + + + + Method draws non-client area of an ScrollControl. + + EventArgs with Non-client info for drawing. + + + + + + + + + + + Raises a event. + + + + + + Increases small change of the ScrollBar. + + + + + + + + + + + + + Resets the property to its default value. + + + + + Starts the AutoScroll timer. + + The scrollbar to be automatically scrolled. + The event to be sent to this scrollbar. + + + + Starts the AutoScroll timer. + + + Starts the AutoScroll timer. + + The message to be sent to the current control. + + + + + + + Starts the AutoScroll timer. + + The message to be sent to the current control. + The initial interval for sending messages. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Call this method from your control's OnPaint method to ensure correct + rendering origin for brushes and patterns. + + The graphics object. + + + + Updates scrollbars to reflect recent changes in scroll position, minimum and maximum scroll position values. + + + + + Call this method to check if you should do any update calculations for the view in your control and to notify scroll control + that the control's content needs to be updated. + + True if you should invalidate areas that need to be redrawn; False if a complete Refresh for the control is pending + and therefore invalidating the view is not necessary. + + + + Call this method to check if you should do any update calculations for the view in your control and to notify scroll control + that the control's content needs to be updated. + + If markPaintPending is True, ScrollControl will assume the control needs to be repainted in a subsequent EndUpdate call. + True if you should Invalidate regions to be repainted in your control. It will return False if a complete Refresh of + the control is pending and you don't need to invalidate individual regions of your control. + + + + Suspends the painting of the control until the method is called. + + + When many paints are made to the appearance of a control, you should invoke the + BeginUpdate method to temporarily freeze the drawing of the control. This results + in less distraction to the user and a performance gain. After all updates have + been made, invoke the EndUpdate method to resume drawing of the control. + + + + + Suspends the painting of the control until the method is called. + + Specifies the painting support during the BeginUpdate, EndUpdate batch. + When many paints are made to the appearance of a control, you should invoke the + BeginUpdate method to temporarily freeze the drawing of the control. This results + in less distraction to the user and a performance gain. After all updates have + been made, invoke the EndUpdate method to resume drawing of the control. + Pass BeginUpdateOptions if you do not want to do a complete Refresh of the control and instead + want to have certain regions of your control be invalidated or scroll the contents of control. + If you call BeginUpdate() and then later EndUpdate(), the control will know if a paint is pending and only + refresh the control if a paint is pending. Calling ShouldPrepareUpdate, Invalidate or a WM_PAINT message during + the BeginUpdate EndUpdate block will signal the control that a paint is pending. + + + + + + + Calls for both scrollbars. + + + + + Calls for both scrollbars. + + + + + Resumes the painting of the control suspended by calling the BeginUpdate method. + + + When many paints are made to the appearance of a control, you should invoke the + BeginUpdate method to temporarily freeze the drawing of the control. This results + in less distraction to the user and a performance gain. After all updates have + been made, invoke the EndUpdate method to resume drawing of the control. + + + + + + Cancels any prior calls. + + + + + + Resumes the painting of the control suspended by calling the BeginUpdate method. + + + When many paint are made to the appearance of a control you should invoke the + BeginUpdate method to temporarily freeze the drawing of the control. This results + in less distraction to the user, and a performance gain. After all updates have + been made, invoke the EndUpdate method to resume drawing of the control. + + + + + + Scrolls the contents of the control similar to the ScrollWindow Windows API. + + + The method will raise a WindowScrolling event before the contents are scrolled and a WindowScrolled event after + the contents have been scrolled. + If DisableScrollWindow is True, any calls to the ScrollWindow method will simply invalidate the affect region. The rendering origin will + still be recorded correctly and WindowScrolling and WindowScrolled events will be raised.If DisableScrollWindow is False, ScrollWindow will scroll the contents of the control. + + + + + + + + + + + + + + + + + Discards paint messages. + + + + + + + + + + + + + + + + Indicates whether this control contains focus. Override this method if you + want to show drop-down windows and indicate the control has not lost focus when + the drop-down is shown. + + True if the control or any child control has focus; false otherwise. + + + + + + + + + + + + + + + + Checks if the control is visible and a window handle has been created. + If it has not been drawn before, it calls . + + Set this True if you want to force a call to + even if the control is not visible and / or + no window handle has been created. + + + + Enables the DoubleBufferSurface for this control. The DoubleBufferSurface buffering + is different from the automatic .NET double buffering and also a bit slower but + it reduces flicker if lots of scrolling is used and gdi drawing for individual cells + in a grid. + + + + + + + + + Forces the assigned styles to be reapplied to the control. + + + + + Delegate for ScrollControlMouseDown, OnBeforeMouseMove and ScrollControlMouseUp methods. + + + + + + + + + + + + + + + + + + + Internal Variable for ScrollControl + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Apply the scrollbar background color for scroll control. + + Graphics for scroll control + Bacground color for scroller background. + Border color for scroll control + + + + Handles a cancellable event. + + The source of the event. + An that contains the event data. + + + + + + Provides data about the cancellable event. + + + ShowContextMenuEventArgs is a custom event argument class used by the + event when the user right-clicks inside + the control. + + You can cancel showing a context menu when + you assign True to . + + + + + + + Initializes a new object. + + The mouse location in screen coordinates. + + + + Returns the mouse location in screen coordinates. + + + + + Custom scrollbars with various VisualStyles and provision to add buttons to it. + + + + + + + The scroll bar itself. + + + The top or right arrow button. + + + The page up or page right region. + + + The scroll box (thumb). + + + The page down or page left region. + + + The bottom or left arrow button. + + + + + + + To check whether the ScrollersFrame is applied properly, when parent is DockHost + + + + Subclasser that helps us to monitor control changes. + + + Reference on control to which we attach scrollers. + + + + + + + + + + + + + + + + + + + + + Color scheme that used in Rendering. + + + Color scheme that used in Rendering. + + + Color scheme that used in Rendering. + + + Office2016 color scheme that used in Rendering. + + + Gripper visibility behavior. + + + + win8 style scroll behavior + + + + + Indicates if a Parent control is in dragging mode. + + + + + Indicates if left mouse button is pressed. + + + + + Enables delayed scrollbar updates. Default value is true. + + + + + + + + Collection of all attached controls and corresponding components. + + + + + LargeIcon View Scroller Increment Value + + + + + SmallIcon View Scroller Increment Value + + + + + Tile View Scroller Increment Value + + + + + Details View Scroller Increment Value + + + + + List View Scroller Increment Value + + + + + Specifies the visual style for the ScrollerFrame. + + + + Reference on control to which we assign our custom scrollers. + + + Reference on configurable Horizontal Scroller control. + + + Reference on configurable Vertical Scroller control. + + + + Gets or sets visibility of size gripper. + + + + + Holds Metro thumb size + + + + + Gets/Sets the size of Metro Scroller Thumb + + + + + Gets or sets a style of the ScrollFrame components. + + + + + Holds whether to show Metro Arrow Button + + + + + Gets/Sets whether to display Metro scroller buttons + + + + + Gets or Sets whether to set the win 8 style scroll behavior + + + + + + + + + + + + + + True - horizontal scroller is visible to user, otherwise False. + + + True - vertical scroller is visible to user, otherwise False. + + + Specifies the style of appearance. + + + + Applies the color table based on the scrollbar styles. + + Get the scroll control details + Get the scrollbar styles. + + + + Gets or sets custom color to MetroScroller. + + + + + Gets or sets the custom color for Office2016 black scrollbar. + + + + + Gets or sets the custom color for Office2016 white scrollbar. + + + + + Gets or sets the custom color for Office2016 colorful scrollbar. + + + + + Gets or sets the custom color for Office2016 dark gray scrollbar. + + + + + Apply Office2016 black color settings for scrollbar. + + + + + Apply Office2016DarkGray color settings for scrollbar. + + + + + Apply Office2016White color settings for scrollbar. + + + + + Apply Office2016Colorful color settings for scrollbar. + + + + + Get or Set of Skin Manager Interface + + + + + Gets or sets whether the Metro color scheme should be User defined colors. + + + + + Gets or sets Office2016 color scheme for horizontal and vertical scrollbars. + + + + + Gets or sets whether the Office color scheme should be Silver or Blue or Black. + + + + + Gets or sets whether the Office color scheme should be Silver or Blue or Black. + + + + + Gets or sets the value to be added to or subtracted from the Value property when the horizontal scroll box is moved a small distance. + + + + + Gets or sets the value to be added to or subtracted from the Value property when the vertical scroll box is moved a small distance. + + + + + Gets or sets whether delayed scrollbar updates must be updated. + + + + + Gets or sets value indicating whether scrollbar should be refreshed on each value change. + If set to false, scrollbar is invalidated only and therefore is visually refreshed after processing all scrolling messages. + + + + Horizontal scroller instance. + + + Vertical scroller instance. + + + Size gripper control instance. + + + + Required designer variable. + + + + Default constructor. + + + Component oriented constructor. Mostly used by Windows Forms + designer. + reference on container that will control + class life time. + + + + Clean up any resources being used. + + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Indicates whether the current value of the OfficeColorScheme property is to be serialized. + + + + + + Resets the office color scheme. + + + + + Indicates whether the current value of the OfficeColorScheme property is to be serialized. + + + + + + Indicates whether the current value of the Office2010ColorScheme property is to be serialized. + + a boolean value. + + + + Resets the office color scheme. + + + + + Resets the office2010 color scheme. + + + + Method called when parent control create own window handle. + reference on parent control. + Event arguments. + + + Method called when control destroy own window handle. + reference on parent control. + Event arguments. + + + Method called when detected parent RightToLeft property value changes. + reference on parent control. + Event arguments. + + + + To check whether the ScrollersFrame is applied properly, when parent is DockHost + + + + + + + + + Method called when detected changes in parent-child hierarchy. + reference on parent control. + Event arguments. + + + Method attach scroller frame to the specified control. Previously + attaches to the controls will be released. + Reference on windows forms control. Can not be NULL. + + + + Occurs when the theme name is changed. + + The theme name. + + + + Overridden to gets the control name of the scroll frame. + + The control name. + Returns the name of the control. + + + + To update the Small Increment speed when ScrollersFrame is attached with ListView control + + + + + Gets or Sets custom renderer to customize the scroll bars + + + + Detach scrollers frame from previously attached control. + + + Refresh scroller frames internal settings and repaint. + + + Internal scrollers attaching algorithm. + + + Internal scrollers detaching algorithm. + + + Reflect Right to Left settings from parent control with respect to internal logic. + change RTL before SetParent calls. RTL force re-creation of the scroller handle!!! + + + Method reassign parents for scrollers when needed. + + + Method synchronize settings with parent wihdow and scrollers. + + + + If parent is being dragged, scrollers get invisible. + + + + + Method synchronize our scrollers with parent scollers. By parameter + specified source of data. + + True - source is window, otherwise False. + + + Method updates enable states from structs specified by user. + Horizontal scroller struct. + Vertical scroller struct. + + + + Utility method. Copy settings value to scrollbar control. + + reference on scroller instance. + Window WIN32 API struct settings of which we reflect. + + + Vise versa operation to method. + Destination of settings reflection. + ScrollBra instance which settings we reflect. + + + + Method create special container windows that will host attached control. + + NOT implemented. Reserved for future enhancements. But can be overrided + and implemented by user. + + + Method process WM_NSCALCSIZE message. + + + + + Method process WM_WINDOWPOSCHANGED message. + + + + + Method process WM_STYLECHANGED message. + + + + + + Method process a WM_MOVE message. + + + + + + Method process a WM_MOUSEMOVE message. + + + + + Method filter parent control messages and according to + them set scroller frame settings. + Windows message. + True - allow forward of message, otherwise False. + + + + Updates visibility of gripper. + + + + + Gets visibility of the size gripper. + + true if gripper should be shown; otherwise false. + + + + + + + + + Verifies if is owned by attched to control. + + Control to verify. + + + + + Special Size Gripper class that supports RTL. + + + Publish for user Handle destroy functionality. Usefull for resource + cleanup in runtime. + + + + + + + + Size gripper advanced. + + + + + + + + + + + Instance of ScrollersFrame. + + + + + Indicates whether grip marking should be drawn. If set to false, just background is filled. + + + + + Gets or sets value indicating whether grip marking should be drawn. If set to false, just background is filled. + + + + Default constructor. + reference on scroller frame. Can not be NULL. + + + Implemented visual styles support. + Paint event arguments. + + + + Releases the unmanaged resources used by the and its child controls and optionally releases the managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + + + + + + + + Design time change of property visibility. Office 2007 visual style support. + + + Show/Hide OfficeColorScheme property for user in runtime. + + + + + + Class Attaching better design time support for FM2.0 and higher. + In older version class have no influences on design time. + + + + + + + Designer helper lass. Do not allow attaching of root + components by . + + + Default constructor. + + + + Method filter that chech is attaching allowed or not. + filter context. + property value that requesting check operation. + True - if attaching allowed, otherwise False. + + + + ProgressBarAdv Designer + + + + + Designer ActionList collection + + + + + Initializes a new instance of the CheckBoxAdvDesigner class + + + + + Gets a value indication the designer action + + + + + + + + + + + Distance from thumb Y position to mouse down Y position. + + + + + Flag, if true than controls visivble in other case not visible. + + + + + Default size of the vertical scroolbar. + + + + + + + + Initializes a new instance of the class. + + The owner. + + + + Initializes a new instance of the class. + + + + + Occurs when control size changed. + + + + + + Used for validating visibility of the ControlsAfter and ControlsBefore + + + + + + Reset vertical scrollbar to default width. + + + + + Gets dockStyle for controls which situated before scroll. + + + + + + Gets dockStyle for controls which situated after scroll. + + + + + + Gets value by cursor position + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Calculating bounds for leftThumb and rightThumb zones for scroll. + + + + + + + + + + + + + + + + + + + + + + + Angle for horizontal gradient brush. + + + + + Angle for vertical gradient brush. + + + + + Angle for vertical gradient brush. + + + + + Width for brush. + + + + + Height for brush. + + + + + Default radius truncation corners. + + + + + Count of lines on the thumb. + + + + + Height of lines on the thumb. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The color scheme that the renderer will render. + + + + + + + + The color scheme that the renderer will render. + + + + + Initialize new instance of WindowsXPRenderer + + + + + + Initialize new instance of WindowsXPRenderer + + + + + + Draws arrow button of scroll. If theme is disabled than draw classic scroll. + + + + + + + + + Draws background of scroll. If theme is disabled than draw classic scroll. + + + + + + + + Draws thumb for scroll. If theme is disabled than draw classic scroll. + + + + + + + + Sets WindowsXP color scheme for the control. + + + + + + Sets the color scheme for the button based on the current XP Scheme. + + + + + Initializes edges of specified rectangle. + + Bounds of the rectangle. + + + + + + + + Gets rounded path with specified radius for the rectangle. + + + + + + + + Gets vertical gradient brush. + + + + + + + + + Gets horizontal gradient brush. + + + + + + + + + Gets gradient brush with 53 angle. + + + + + + + + + Draws background lines. + + Graphics object to use. + Bounds of the background. + Color of the lines. + + + + Draws shadow for the arrow button. + + The graphics object to use. + Bounds of the arrow button. + + + + + + + Draws shadow for the thumb. + + The graphics object to use. + Bounds of the thumb. + + + + + Draws middle lines on the thumb. + + Graphics object to use. + Bounds of the thumb. + + + + + + Fill Rectangle with ControlLightLight color. + + Graphics objects to use. + Bounds of the rectangle. + + + + Draws disabled arrowButton. + + Graphics object to use. + Bounds of the button. + Type of the button. + + + + Draws disabled background. + + Graphics object to use. + Bounds of the button. + + + + Draws disabled thumb. + + Graphics object to use. + Bounds of the thumb. + + + + Draws up arrow on the button. + + The graphics object to use. + Bounds of the button. + + + + + + Draws two lines in specified points. + + + + + + + + + + Rotate shape on specified angle around center p. + + Array of points that represents shape to rotate. + Angle in radians to rotate. + Point to rotate around. + + + + The metro renderer for scrollbar + + + + + Initializes a new instance of the class. + + The parent control + + + + Initializes a new instance of the class. + + The parent control. + The metro color table. + + + + Draws background of scroll. If theme is disabled than draw classic scroll. + + The graphics. + The bounds of background. + The scroll button state. + + + + Draws pushed background. + + The graphics. + The bounds of background. + + + + Draws scroll background. + + The graphics. + The scroll bounds. + + + + Indicates whether scrollBar style is EnableOffice2013Style + + + + + Draws scroll thumb. If theme is disabled than draw classic scroll. + + + + + + + + Draws scroll thumb background. + + The graphics. + The bounds of thumb. + The scroll button state. + + + + Method to calculate the center point to place the Thumb exactly at the center position inside the Scrollbar. + + + + + + + Draws arrow button of scroll. If theme is disabled than draw classic scroll. + + The graphics. + The bounds of arrow. + The scroll button type. + The scroll button state. + + + + Draws arrow background. + + The graphics. + The arrow backgroud bounds. + The scroll button type. + The scroll button state. + + + + Draws scrollbar arrow + + The graphics. + The bounds of the arrow. + The scroll button type. + The scroll button state. + + + + Returns the pushed or checked state right arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the pushed or checked state right arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the pushed or checked state left arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the pushed or checked state left arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the pushed or checked state down arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the pushed or checked state down arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the pushed or checked state up arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the pushed or checked state up arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the normal right arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the normal left arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the normal down arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Returns the normal up arrow. + + The width of the arrow. + The height of the arrow. + The bitmap. + + + + Metro color table. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the scroll bar background color. + + + + + Gets or sets the normal state thumb color. + + + + + Gets or sets the checked state thumb color. + + + + + Gets or sets the pushed state thumb color. + + + + + Gets or sets the Thumb Normal Border color + + + + + Gets or sets the Thumb Checked Border color + + + + + Gets or sets the pushed state Thumb Pushed Border. + + + + + Gets or sets the pushed state Thumb Pushed Border. + + + + + Gets or sets the Arrow Normal Border color + + + + + Gets or sets the Arrow Checked Border color + + + + + Gets or sets the Arrow Pushed Border color + + + + + Gets or sets the inactive state thumb color. + + + + + Gets or sets the normal state arrow color. + + + + + Gets or sets the checked state arrow color. + + + + + Gets or sets the pushed state arrow color. + + + + + Gets or sets the normal state Arrow Background Color. + + + + + Gets or sets the pushed state Arrow Pushed Background color. + + + + + Gets or sets the inactive state arrow color. + + + + + Provides event data for the various ProvidePersistenceID events. + + + + + Gets / sets a unique ID. + + + + + Represents a method that lets you specify a unique ID usually distinguishing different + instances of a control type. + + + + + ButtonBar is a base class for displaying several buttons in one bar. It is used by + and . + + + + + Occurs when a WM_CANCELMODE is received. + + + + + Occurs when is changed. + + + + + Occurs before the event is raised. + + + + + Raises the event. + + A that contains the event data. + + + + Initializes a new button bar. + + + + + + + + Suspends updating the bar. + + + + + Resumes updating the bar. + + + Resumes updating the bar and refreshes it. + + + + + Resumes updating the bar and optionally refreshes it. + + Indicates whether button bar should be refreshed; if False button will only be refreshed when it is marked dirty. + + + + Indicates whether was called. + + + + + + + + + + + + + + + + + + + + Raises the event. + + Event data. + + + + Forces the control to invalidate its client area and immediately redraw itself and any child controls. + + + + + + + + Returns the default size of the control. + + + + + Returns the bounds for the button bar. + + A indicating where the bar should be drawn. + + + + Gets or sets a that holds an array of buttons. + + + + + Creates an instance of the and initializes it with the layout information. + + The initialized . + + + + Indicates whether ToolTips are being shown for tabs that have ToolTips set on them. + + + + + + + + Reinitializes and hides ToolTips. + + + + + Gets or sets the button look for the arrow buttons. + + + + + Raises the event. + + Event data. + + + + Specifies the look of the arrow buttons should be drawn. + + + + + Draw normal buttons. + + + + + Draw flat buttons. + + + + + Used by the to allow its content to create a control if it implements this interface. + + + + + Creates a new . + + A new instance. + + + + Provides a method to create a copy of an existing splitter pane or window. + + + + + Creates a copy of an existing splitter pane or window. + + The row in a . + The column in a . + A reference to the parent control, e.g a splitter frame. + A new instance of a control. + + + + Defines split behavior for a . + + + + + No dynamic splitter. + + + + + Split rows vertically. + + + + + Split columns horizontally. + + + + + Allow both splitting the view vertically and horizontally. + + + + + Defines an interface for a control that supports splitting the view into + several row panes and column panes. + + + Both and + implement this interface. This gives client controls a one stop interface + to get all splitter functionality no matter if they are embedded inside + a or inside a . + + + + + Gets / sets a value indicating what split behavior is supported. Rows, Columns or Both. + + + + + Returns the number of visible row panes. + + + + + Returns the number of visible column panes. + + + + + Indicates whether the rows were split at the given y coordinate. + + The vertical position in percentages of the splitter control's height. + True if rows were split successfully; False if they were already split or the operation aborted. + + + + Indicates whether the columns were split horizontally at the specified x coordinate. + + The horizontal position in percentages of the splitter control's width. + True if columns were split successfully; False if they were already split or the operation aborted. + + + + Deletes the splitter panes at the specified row. + + The zero-based index for the splitter pane row. + + + + Deletes the splitter panes at the specified column. + + The zero-based index for the splitter pane column. + + + + Returns the splitter pane at the specified row and column. + + The zero-based index for the splitter pane row. + The zero-based index for the splitter pane column. + The control at the pane. + + + + Returns the row and column index for a child pane. + + The control to search for. + A placeholder where the row is returned. + A placeholder where the column is returned. + True if the control is a pane; False if the control was not a child pane. + + + + Gets / sets the active pane in the splitter control. + + + + + Sets the active pane in the splitter control specified by row and column. + + The zero-based index for the splitter pane row. + The zero-based index for the splitter pane column. + + + + Indicates whether there is a next or previous pane that can be activated. + + True if previous pane should be activated; False if next pane should be activated. + True if activating next or previous pane is good; False if already at last or first pane. + + + + Activates the next or previous pane. + + True if previous pane should be activated; False if next pane should be activated. + + + + Occurs when the property has changed. + + + + + Occurs when the vertical splitter position has changed. + + + + + Occurs when the horizontal splitter position has changed. + + + + + Occurs when the splitter layout has changed. + + + + + Provides a property support for using the control + inside a dynamic splitter window and sharing scrollbars + with the parent window. + + + + + Toggles support for using the control inside a dynamic splitter window and sharing scrollbars + with the parent window. + + + + + Indicates that the splitter control is closing the pane with this control. + + + + + Indicates that the splitter control has closed the pane with this control. + + + + + Indicates whether the splitter control is closing the pane with this control. + + + + + Indicates whether the splitter control has closed the pane with this control. + + + + + An interface for hosting objects and + receiving clicks from these buttons. + + + + + Occurs when the specified button is clicked or the mouse is pressed down on the button. + + The source of the event. + + + + Specifies the current state of the button. + + + + + Button is in normal state. + + + + + Button is disabled. + + + + + Mouse is hovering over button. + + + + + Button is pushed. + + + + + Button is checked. + + + + + Button is considered a drop target of a drag-and-drop operation. + + + + + A mask for the drawing state of the button without behavioral options (without Checked, DropTarget). + + + + + + + + + + + + + + + + + InternalButton are buttons that are displayed inside a . + + + + + + + + + + + + + + + + + + + + + + + Style of the control. + + + + + Color table for Office2007 visual style. + + + + + Specifies office 2007 color scheme. + + + + + Initializes a new . + + + Initializes a new . + + + + + Initializes a new with a specified size. + + The initial size of the button. + + + + Initializes a new with a cookie. + + The cookie for the button. + + + + Initializes a new with an owner and cookie. + + The owner of the button. + The cookie for the button. + + + + Initializes a new with a owner, cookie and ToolTip text. + + The owner of the button. + The cookie for the button. + The ToolTip text. + + + + Initializes a new with a owner, cookie, ToolTip text and size. + + The owner of the button. + The cookie for the button. + The ToolTip text. + The initial size of the button. + + + + Initializes a new with a owner, cookie, ToolTip text, size and a value that + indicates whether this control should look like a button or if just a centered text should be drawn. + + The owner of the button. + The cookie for the button. + The ToolTip text. + The initial size of the button + A value indicating if this should look like a button or if just a centered text should be drawn. + + + + + + + + + + Returns the preferred size of button. + + The maximum allowed size. + The preferred size based on text, button type. + + + + Recalculates the best size for the button and resizes it. + + + + + Gets or sets the visual style of the control. + + + + + Gets or sets the visual style of the control. + + + + + + + + + + Gets or sets office 2007 color scheme. + + + + + Gets color table for Office2007 visual style. + + + + + Gets / sets the owner of this button. + + + + + Some external state (e.g. button type or command id). + + + + + Gets / sets the ToolTip text for this button. + + + + + Gets / sets the bounds of this button. + + + + + Gets / sets the size of this button. + + + + + + + + Indicates whether button is hidden. + + + + + Indicates whether this button supports repeated clicking when the user holds down the mouse button. + + + + + Indicates whether it is a Dirty flag. + + + + + Indicates the Enabled state. + + + + + Indicates the Hovered state. + + + + + Indicates the Pushed state. + + + + + Indicates the Checked state. + + + + + Indicates the DragTarget state. + + + + + The for this button. + + True if flat button; False if normal button. + The . + + + + Reinitializes and hides the ToolTip. + + + + + Initializes ToolTip area at the specified bounds. + + + + + + Calculates coordinates for a centered rectangle. + + The existing bounds. + The size of the rectangle to be centered. + A rectangle inside the specified bounds. + + + + Paints the button. + + A Graphics object used to draw the bitmap. + A Rectangle which contains the boundary data of the rectangle. + True if flat looking button; False if normal. + A Rectangle which contains the boundary data of the parent bar rectangle. + + + + Called when is changed. + + + + + Called when is changed. + + + + + Called when state is changed. + + + + + Called when is changed. + + + + + Helper class for . Manages items. + + + + + Initializes an and attaches it to a control. + + The parent control. + + + + + + + Called when a button is clicked. + + The that was clicked. + + Called by OnMouseDownEvent. + + + + + Called from parent control to draw this bar. + + A Graphics object. + + + + Checks if mouse is over a button and returns the zero-based button index or -1. + + X-coordinate of mouse pointer. + Y-coordinate of mouse pointer. + Zero-based button index; -1 if not over a button. + + + + Initializes ToolTips boundaries. + + + + + Reinitializes and hides ToolTips. + + + + + Recalculates boundaries of child buttons. + + True if ToolTips should be initialized too. + + + + Cancels current action. + + + + + Repaints only if marked dirty. + + + + + + + + + + + + + + + + + + + + Gets / sets the button array. + + + + + Indicates whether a button is currently pressed. + + + + + Gets / sets the boundaries of this bar. + + + + + Gets / sets the default size for buttons in this bar. + + + + + Indicates whether it is flat look for buttons. + + + + + Indicates whether any button is dirty or sets all buttons dirty. + + + + + Indicates whether any button is enabled or sets all buttons enabled / disabled. + + + + + Indicates whether any button is in hovered state. + + + + + Resets hovered state for all buttons. + + + + + Indicates whether any button is in pushed state. + + + + + Resets pushed state for all buttons. + + + + + Gets / sets the delay until the button starts firing click events + when the user holds down the mouse button. + + + + + Gets / sets the minimum delay between clicks when scrolling is accelerated. + + + + + Gets/Sets whether AddNewButton needs to drawn in TabBar + + + + + Draw the AddNewSymbol and Ellipsis in VisualStyle based theme. + + + + + Provides notification methods when the user drags the vertical + or horizontal splitter bar. + + + + + Occurs when the user drags the splitter bar. + + The source of the event. + The current horizontal position in pixels. + The current vertical position in pixels. + + + + Occurs after the user moves the splitter bar. + + The source of the event. + + + + Repaints the splitter bar. + + The source of the event. + + + + Gets / sets the cursor to display. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies office 2007 color scheme. + + + + + Style of the control. + + + + + Color table for Office2007 visual style. + + + + + Default splitter value. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets the visual style of the tabBarSplitterControl. + + + + + Gets or sets the style for Splitter. + + + + + + + + + + Gets or sets office 2007 color scheme. + + + + + Gets color table for Office2007 visual style. + + + + + + + + Draw splitterBar in VisualStyle based theme. + + + + + Improve the Tabbarsplittersontrol appearance to draw the dotted icon in splitterbar. + + To handle the graphics objects. + Position to draw the dottedrectangle. + Vertical splitter bar position value in percentage. + Horizontal splitter bar position value in percentage. + + + + Draw the Dotted icon on Horizontal splitter button. + + To handle the graphic objects. + Position of the dotted rectangle. + Dotted rectangle fore color. + + + + Draw the Dotted icon on Vertical splitter button. + + To handle the graphic objects. + Position of the dotted rectangle. + Dotted rectangle fore color. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Interface for Spreadsheet Tabpage + + + + + Gets the bool value + + + + + Handles the or the events. + + + + + Provides event data for the + or the event. + + + + + Returns the control inside the specified pane. + + + + + Returns the zero-based row number of the pane. + + + + + Returns the zero-based column number of the pane. + + + + + Returns a reference to the control at the top-left pane. + + + + + Defines an interface that provides methods for creating and hiding controls for + a splitter pane inside a . + + + + + Creates a new control for the specified splitter pane. + + A parent control. Can be a . + The row in a . + The column in a . + The control in the first splitter pane. + A new instance of a control. + + + + Hides / disposes the control for the specified splitter pane. + + A parent control. Can be a . + The row in a . + The column in a . + The control in the splitter pane that should be hidden. + + + + This is the default implementation of the and manages + creating and hiding of controls for + a splitter pane inside a . + + + You can get or replace this object with the property + of a control. + + + + Creates a new control for the specified splitter pane. + + A parent control. Can be a . + The row in a . + The column in a . + The control in the first splitter pane. + A new instance of a control. + + + + Hides / disposes the control for the specified splitter pane. + + A parent control. Can be a . + The row in a . + The column in a . + The control in the splitter pane that should be hidden. + + + + A splitter control provides support for dynamic splitting of the viewable area. + + + The controls shown inside the splitter control must implement + the interface. Additionally, these controls need to have built-in logic + that allows displaying one set of data in different views. + The interface should be implemented if scrollbars of the child + pane should be shared with the parent splitter frame. + The controls in the pane should also implement . This allows the control + to create new panes and initialize them when an additional row or column is opened in the splitter control. + If a control does not implement , the splitter control will call the + of the . + Essential Grid's GridControlBase is a control that provides all of this logic and can be dropped into a + splitter control and be dynamically split by an end user. + also provides part of the logic to be used inside a splitter frame, but + you still need to implement the logic for displaying one set of data in different views in your derived controls. + + See the SplitterControlDemo and TabBarSplitterControlDemo samples for examples on how to use + in a form. + + + + + Occurs when the window receives a WM_CANCELMODE message. + + + WM_CANCELMODE is sent to cancel certain modes, such as mouse capture. + For example, the system sends this message to the active window when a + dialog box or message box is displayed. Certain functions also send this + message explicitly to the specified window regardless of whether it is the + active window. For example, the EnableWindow function sends this message + when disabling the specified window. + + + + + Occurs when the property has changed. + + + + + Occurs when the vertical splitter position has changed. + + + + + Occurs when the horizontal splitter position has changed. + + + + + Occurs when the splitter layout has changed. + + + + + Occurs when the property has changed. + + + + + Occurs when the property has changed. + + + + + Occurs when the property has changed. + + + + + Occurs when the property has changed. + + + + + Occurs when the property has changed. + + + + + Occurs when the property has changed. + + + + + Occurs when the property has changed. + + + + + Occurs when the ThemesEnabled property changes. + + + + + Default size of the control + + + + + Return the bool value if BaseThemeName is Office2019Colorful or HighContrastBlack. + + + + + + Initializes a new splitter control. + + + + + Gets/Sets Control size before touch enabled + + + + + Gets or sets value to enable or disable the Touchmode to the controls. + + Scale factor will be updated automatically if scalefactor is equal to 1 + + + + + + + Scale the control based on the scale factor passed in the argument. + + value to scale the factor based upon. + + + + Font changed + + + + + + + + + Returns the number of visible row panes. + + + + + Returns the number of visible column panes. + + + + + Indicates whether the rows were split at the given y coordinate. + + The vertical position in percentages of the splitter control's height. + True if rows were split successfully; False if they were already split or the operation aborted. + + + + Indicates whether the columns were split horizontally at the specified x coordinate. + + The horizontal position in in percentages of the splitter control's width. + True if columns were split successfully; False if they were already split or the operation aborted. + + + + Deletes the splitter panes at the specified row. + + The zero-based index for the splitter pane row. + + + + Deletes the splitter panes at the specified column. + + The zero-based index for the splitter pane column. + + + + Returns the splitter pane at the specified row and column. If there is no pane found at the + specified row and column a pane will be created on demand with a call to . + + The zero-based index for the splitter pane row. + The zero-based index for the splitter pane column. + The control at the pane. + + + + Returns the splitter pane at the specified row and column. If there is no pane found at the + specified row and column a null reference will be returned. + + The zero-based index for the splitter pane row. + The zero-based index for the splitter pane column. + The control at the pane. + + + + Disposes the specified pane. + + The zero-based index for the splitter pane row. + The zero-based index for the splitter pane column. + + + + Creates a new control for the specified splitter pane. + + The zero-based index for the splitter pane row. + The zero-based index for the splitter pane column. + The control in the first splitter pane. + A new instance of the control. + + + + + + + Occurs after the control to be displayed in a new pane has been created. Use this + event to implement additional initialization for the new control. + + + PaneCreated is an ideal hook to add handler for events in the new control. + + + + + Raises the event. + + A that contains the event data. + + + + Occurs after a row or column is hidden and before the control that is displayed in the pane + is disposed. Use this event to implement additional clean up for the control before + is called. + + + PaneClosing is an ideal hook to unwire event handlers from the control. + + + + + Raises the event. + + A that contains the event data. + + + + Returns the row and column indices for a child pane. + + The control to search for. + A placeholder where the row is returned. + A placeholder where the column is returned. + True if the control is a pane; False if the control was not a child pane. + + + + Gets or sets the active pane in the splitter control. + + + + + Sets the active pane in the splitter control specified by row and column. + + The zero-based index for the splitter pane row. + The zero-based index for the splitter pane column. + + + + Indicates whether there is a next or previous pane that can be activated. + + True if previous pane should be activated; False if next pane should be activated. + True if activating next or previous pane is good; False if already at last or first pane. + + + + Returns the default size of the control. + + + + + + + + Activates the next or previous pane. + + True if previous pane should be activated; False if next pane should be activated. + + + + + + + + + + Gets or sets the border style of the Splitter Control. + + + + + Overridden method. + + + + + + Returns the scrollbar for the specified control. + + The control for which you want to get the scrollbar. + + + + + Indicates whether the scrollbar belongs to the active pane. + + The control associated with the scrollbar. + Specifies the vertical or horizontal scrollbar. + True if active; False otherwise. + + + + + ScrollControl checks IsActive to find out if it is the target of a HScroll event. + + protected virtual void OnHScroll(object sender, ScrollEventArgs se) + { + try + { + IScrollBarFrame sbf = GetScrollBarFrameOfComponent(this); + if (sbf != null && !sbf.IsActive(this, ScrollBars.Horizontal)) + return; + }} + + + + + + Returns the horizontal scrollbar associated with the control. + + A child pane. + The scrollbar for the pane. + + + + Returns the vertical scrollbar associated with the control. + + A child pane. + The scrollbar for the pane. + + + + + + + Raises the event. + + A that contains the event data. + + + + Handles the WM_SETCURSOR message. + + + + + + + + + Raises the ThemeChanged event. + + An EventArgs that contains the event data. + + The OnThemeChanged method also allows derived classes to handle the event + without attaching a delegate. This is the preferred technique for + handling the event in a derived class. + Note to Inheritors: When overriding OnThemeChanged in a derived + class, be sure to call the base class's OnThemeChanged method so that + registered delegates receive the event. + + + + + Indicates whether themes are enabled for this control. + + + + + Indicates whether ToolTips are being shown for tabs that have ToolTips set on + them. + + + + + Raises the event. + + Event Data. + + + + + + + Reinitializes and hides ToolTips. + + + + + + + + + + + Gets or sets the button look for the arrow buttons. + + + + + Raises the event. + + Event data. + + + + holds information about the current vertical and horizontal split positions. + + + + + Returns either an that has a reference to a scrollbar or creates a scrollbar. + + Indicates horizontal or vertical scrollbar. + The zero-based row or column index of the scrollbar. + A control that is derived from or implements . + + + + Creates a scrollbar for the specified row or column index. + + Indicates horizontal or vertical scrollbar. + The zero-based row or column index of the scrollbar. + A . + + + + + + + + + + Indicates whether the specified control is activated . + + The to be activated. + True if the control is successfully activated; false otherwise. + + The control must be a child of the container control. + + + + + Gets or sets the Active control. + + + + + Indicates whether the method has been called. and resets this flag. + + + + + Indicates whether the method has been called. and resets this flag. + + + + + Indicates whether has been called. resets this flag. + + + + + Indicates whether has been called. resets this flag. + + + + + Indicates whether has been called. resets this flag. + + + + + + + + + + + + + + + + + + + + + + + Occurs when both and occur. + + + + + Raises the event. + + An that contains the event data. + + + + Indicates whether this control contains focus. If + implements , the + method is called on the . + + True if the control or any child control has focus; False otherwise. + + + + Raises the event. This method is called when the control + or any child control gets focus and this control did not have focus before. + + + Inheriting classes should override this method instead of overriding + because is also called when child controls gets focus and it + is not called when focus is moved within child controls of this control. + + + + + Cancels any prior calls for child controls that implement . + + + + + Raises the event. This method is called when the control + or any child control loses focus and the new focused control is not a child of this control. + + + Inheriting classes should override this method instead of overriding + because is also called when child controls lose focus and it + is not called when focus is moved within child controls of this control. + + + + + This method is called if the control's notification occurs + while handling a event. This typically occurs if a + message box is displayed from a event handler. + + + + + + + + Gets or sets a value indicating what split behavior is supported. Rows, Columns or Both. + + + + + Resets the property to its default value. + + + + + Raises the event. + + Event data. + + + + Gets or sets the horizontal splitter position in percentages of the splitter control's width. + + + + + Raises the event. + + Event data. + + + + Gets or sets the vertical splitter position in percentages of the splitter control's height. + + + + + Raises the event. + + + + + + Forces the control to invalidate its client area and immediately redraw itself and any child controls. + + + + + + + + Gets or sets the that holds information about current vertical and horizontal split positions. + + + + + Raises the event. + + Event data. + + + + Occurs when the user drags the splitter bar. + + The source of the event. + The current horizontal position in pixels. + The current vertical position in pixels. + + + + Occurs after the user moves the splitter bar. + + The source of the event. + + + + + + + Gets or sets the border style of the RecordNavigationControl. + + + + + Occurs when property has changed. + + + + + Raises the event. + + A that contains the event data. + + + + Toggles between standard and flat scrollbars. + + + + + Raises the event. + + A that contains the event data. + + + + Gets or sets the style of flat scrollbars. + + + + + Gets or sets the size factor of this tab bar + + + + + Raises the event. + + Event data. + + + + Gets or sets the Backcolor for flat scrollbars. + + + + + Raises the event. + + + + + + Resets the to default. + + + + + Gets or sets the Office2016Scrollbar. + + + + + Toggles between standard and Office2007 scrollbars. + + + + + Raises the event. + + A that contains the event data. + + + + Get or Set of Skin Manager Interface + + + + + Gets or sets the style of Office2007 scroll bars + + + + + Raises the event. + + Event data. + + + + Occurs when the property has changed. + + + + + Raises the event. + + Event data. + + + + Occurs when the property has changed. + + + + + Raises the event. + + Event data. + + + + Occurs when the property has changed. + + + + + Raises the event + + Office scrollbar type + + + + Provides the data about event of a . + + + + + Initializes a new . + + The record index. + + + + Gets or sets the Office scroll bars + + + + + Gets or sets the Office like scrollbars. + + + + + Reset the GridOfficeScrollBars + + + + + + Serializes the GridOfficeScrollBars + + + + + + Gets or sets the style of Office2010 scroll bars. + + + + + Gets or sets the style of Office2016 scroll bars. + + + + + Gets/Sets the Style of the Splitter control + + + + + + Reset the Style of the Splitter control + + + + + + Serializes the Style of the Splitter control + + + + + + Occurs when the style changes + + + + + Toggles support for using the control inside a dynamic splitter window and sharing scrollbars + with the parent window. + + + + + + + + Toggles visibility of the vertical scrollbar. + + + + + Toggles visibility of the Horizontal scrollbar. + + + + + Occurs when the property has changed. + + + + + Raises the event. + + A that contains the event data. + + + + Occurs when the property has changed. + + + + + Raises the event. + + A that contains the event data. + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + Gets or sets the BaseTheme name of the theme + + + + + Gets or sets a value indicating whether a theme settings + can be applied to the control. + + The default value is true. + + This property must be initialized before applying the VisualTheme /> + + + + + Gets or sets a value indicating whether control elements styles can be overridden by theme style settings. + + Default value is false. + + By default, the control's element styles will not be overridden by theme style settings if the style is set in sample level. + If this property is enabled, element style will be overridden by theme style settings event if it is set in sample level. + This property should be enabled or disabled before calling the ThemeName property of the control. + + + + + Gets the name of the control. + + + + + Gets or sets the theme name of the control. + + + The default value is null. + + + This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control. + + + + + Gets a value indicating whether the visual style based theme is applied to the control and + also indicates whether the theme files are referred from external assemblies or not. + + Return true, if the visual style based theme is applied to the control. Otherwise returns false. + + + + Gets or sets the value used to customize the appearance of the . + + + This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control. + + + + + Occurs when theme name of the control has changed. + + + + + Gets the active theme of control. + + + + + + Raises the event when theme name changed. + + The sender value. + A contains the event data. + + + + Specifies the style Control + + + + + Specifies the Default style of the control + + + + + Specifies the Metro style of the Control + + + + + Specifies the Office2016 style of the Control + + + + + holds information about the current vertical and horizontal split positions. + + + + + Gets / sets the horizontal splitter position in pixels. + + + + + Gets / sets the vertical splitter position in pixels. + + + + + Specifies the style with which some controls will appear and behave. + + + Every control that incorporates these styles will define the styles differently, + so take a look at the individual control for more information. + + + + + Classic appearance. + + + + + Office XP-like appearance. + + + + + Office 2003-like appearance. + + + + + Visual Studio 2005-like appearance. + + + + + Office 2007-like appearance. + + + + + Office 2007 Outlook-like appearance. + + + + + Office 2010-like appearance. + + + + + Visual Studio 2010-like appearance. + + + + + Metro-like appearance. + + + + + Office2016 Colorful + + + + + Office2016 White + + + + + Office2016 Black + + + + + Office2016 DarkGray + + + + + Provides static properties to access the colors used by different components in the XPMenus framework. + + + + The primary objective of this class is to let you specify custom colors for the different + regions of the XPMenus components. When no colors are provided, this class returns the default + colors usually synthesized from the System Colors. If you have to reset a property that you set before, + simply set it to be Color.Empty; the next time the property is queried, it will return the default color. + + + If you are a consumer of the colors in this class, then note that the colors returned + by properties in this class need to be reinitialized when the system color changes. + This class doesn't listen to the system color change event, instead it expects the consumer to notify it + when the system color changes. To avoid redundant updates by multiple consumers, a unique notification pattern + is recommended. + + + To notify system color changes, you should listen to the + event and call the method. The SysColorsChanged method will let you specify whether to + update the colors immediately or later with a call to . You should + choose to update immediately if you will use the new colors to update certain properties in your control (Backcolor, for example). + On the other hand, if you use the colors within and only within your Paint event, then update the colors later in + the beginning of your Paint method with a call to UpdateMenuColors. Note that the + UpdateMenuColors method will actually update the colors only if necessary, letting you call it multiple times + without performance hit. + + + There is also a event that gets fired whenever colors + are updated, either due to change in System Colors (notified using the above pattern) or when a custom color is set on any of the properties. + + + + + + Initializes default colors based on SystemColors. + + + Calling this will not affect the custom colors set using the properties. + + + + + Fired when the colors have changed either because of change in system colors or + when a custom color is specified using one of the properties. + + + Take a look at the class reference for this class for information on how to notify + this class regarding system color changes. + + + + + Initializes the default colors. + + + + + Call this method to indicate that the system colors have changed. + + Indicates whether to update colors immediately or later with a call to . + + Take a look at the MenuColors class reference for the recommended system color change notification pattern. + + + + + Gets / sets the selected color for a menu item in a toolbar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the selected text color for an item in a toolbar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the background color of a drop-down menu. + + + The default value is derived from a System Color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the color for the left aligned strip in a drop-down menu where images and check boxes are shown. + + + The default value is derived from a System Color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the selected-pressed color for a menu item in a toolbar. + + The default value is derived from a System Color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the selected color for a checked menu item in a toolbar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the border color for a selected menu item in a toolbar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the border color for a drop-down menu. + + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the background color for a toolbar / commandbar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the background color for the main-menu bar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the background color for the Status Bar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the Caption background color for a floating toolbar / commandbar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the Backcolor for the expanded, + left-aligned menu strip region. This is the region you see when a partial menu + gets expanded to show all the menu items. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the alpha-blend factor to use to shade the inactive menu item's icons. (255 for no alpha-blending; 0 will completely hide the item) + + A value in the range 1 to 255; -1 will reset to default value. Default is 175. + + 255 will draw the icon without any alpha blending; 1 will almost hide the icons. This setting will be ignored when XPThemes is turned on. + + + + + Gets / sets the text color base for the text in the disabled menu items. + + The default value is derived from a system color. + + When you specify a custom color, ControlPaint.LightLight will be applied on it before using that color. + + + + + Gets / sets the text color base for the text in the disabled toolbar items. + + The default value is derived from a system color. + + + + Gets / sets the text color of the menu and toolbar items. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color, the next time it is queried. + + + + + Gets / sets the active text color of the menu and toolbar items. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Initializes default colors based on SystemColors. + + + Calling this will not affect the custom colors set using the properties. + + + + + Fired when the colors have changed either because of change in system colors or + when a custom color is specified using one of the properties. + + + Take a look at the class reference for this class for information on how to notify + this class regarding system color changes. + + + + + Initializes the default colors. + + + + + Gets a value indicating whether themed colors are used. + + true if themed colors are used, false otherwise. + + + + gets/sets color of right auto hide panel. + + + + + Gets/sets color of left AH panel. + + + + + Gets or sets the color of the panel. + + + + + Gets or sets the color of the border. + + + + + Gets or sets the color of the inner border. + + + + + Gets or sets the color of the tab item. + + + + + Gets or sets the color for border of the DropDownBarItem. + + + + + Gets or sets the light color of the DropDownBarItem. + + + + + Gets or sets the dark color of the DropDownBarItem. + + + + + Gets or sets the color for border of the menu. + + + + + Gets or sets the color for separator of the menu. + + + + + Gets or sets the color for border selected item of the menu. + + + + + Gets or sets the color for selected item of the menu. + + + + + Gets or sets the dark color for column of the menu. + + + + + Gets or sets the light color for column of the menu. + + + + + Gets or sets the color for check mark of the menu. + + + + + Gets or sets the color for selected check mark of the menu. + + + + + Gets or sets the background color of the menu. + + + + + Gets or sets border color of the BarItem. + + + + + Gets or sets border color of the pressed BarItem. + + + + + Gets or sets border color of the checked BarItem. + + + + + Gets or sets light color of the checked BarItem. + + + + + Gets or sets dark color of the checked BarItem. + + + + + Gets or sets light color of the BarItem. + + + + + Gets or sets dark color of the BarItem. + + + + + Gets or sets light color of the pressed BarItem. + + + + + Gets or sets dark color of the pressed BarItem. + + + + + Gets or sets color of the separator BarItem. + + + + + Gets or sets light color of the DockBar. + + + + + Gets or sets dark color of the DockBar. + + + + + Gets or sets light color for dropdown button of the CommandBar. + + + + + Gets or sets dark color for dropdown button of the CommandBar. + + + + + Gets or sets dark color of the CommandBar. + + + + + Gets or sets light color of the CommandBar. + + + + + Gets or sets color for border of the CommandBar. + + + + + Gets or sets light color for highlight dropdown button of the CommandBar. + + + + + Gets or sets dark color for highlight dropdown button of the CommandBar. + + + + + Gets or sets light color for pressed dropdown button of the CommandBar. + + + + + Gets or sets dark color for pressed dropdown button of the CommandBar. + + + + + Gets or sets color for pressed dropdown button of the floating CommandBar. + + + + + Gets or sets border color for pressed dropdown button of the floating CommandBar. + + + + + Gets or sets light color of the floating CommandBar. + + + + + Gets or sets dark color of the floating CommandBar. + + + + + Gets or sets color for light border of the floating CommandBar. + + + + + Gets or sets background color of the floating CommandBar. + + + + + Gets or sets color for border of the floating CommandBar. + + + + + Gets or sets color for caption text of the floating CommandBar. + + + + + Initializes default colors based on SystemColors. + + + Calling this will not affect the custom colors set using the properties. + + + + + Fired when the colors have changed either because of change in system colors or + when a custom color is specified using one of the properties. + + + Take a look at the class reference for this class for information on how to notify + this class regarding system color changes. + + + + + + + + + + + + + + + Fired when the colors have changed either because of change in system colors or + when a custom color is specified using one of the properties. + + + Take a look at the class reference for this class for information on how to notify + this class regarding system color changes. + + + + + Call this method to indicate that the system colors have changed. + + Indicates whether to update colors immediately or later with a call to . + + Follow the same system color change notification pattern as explained in the class reference. + + + + + Gets / sets the selected color for a menu item in a drop-down menu. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the pressed-selected color for a menu item in a toolbar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the background color of a selected check box in the drop-down menu margin or a checked item in the toolbar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the background color of a check box in the drop-down menu margin or a checked item in the toolbar. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the border color of a menu item selection in the drop-down menus and toolbars. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the border color of a drop-down menu. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the left-gradient color of the drop-down menu margin. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the right-gradient color of the drop-down menu margin. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the left-gradient color of the drop-down menu margin of the expanded menu items. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the right-gradient color of the drop-down menu margin of the expanded menu items. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the right-gradient color of docked bars. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the left-gradient color of docked bars. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the color of the gripper. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the light-gradient border color of bars. + + + + + Gets or sets the dark-gradient border color of bars. + + + + + Gets or sets the light-gradient color of menu item for hot-tracking. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the dark-gradient color of menu item for hot-tracking. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the light-gradient color of quick customize button when it is pressed. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the dark-gradient color of quick customize button when it is pressed. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the caption background color of floating bars. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the color for the floating command bar item which is pressed. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the light-gradient color of quick customize dropdown button. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the dark-gradient color of quick customize dropdown button. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the light-gradient highlight color of groupBarItem. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the dark-gradient highlight color of groupBarItem. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the light-gradient color of selected groupBarItem. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the dark-gradient color of selected groupBarItem. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the light-gradient highlight color of selected groupBarItem. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the dark-gradient highlight color of selected groupBarItem. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the light-gradient color of groupBar header. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets or sets the dark-gradient color of groupBar header. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Gets / sets the color of the text in a GroupBar item. + + + + + Gets / sets the highlight color to be used for the selected text of the GroupBar item. + + + + + Gets / sets the color of the separator line between the bar items. + + The default value is derived from a system color. + + Setting this property to Color.Empty will actually reset the previous set color and + make this property return the default color the next time it is queried. + + + + + Used for drawing the tabControlAdv tabPanel background. + + + + + Used for drawing the active tabPage. + + + + + Used for drawing the active tabPage. + + + + + Used for drawing the inactive tabPage. + + + + + Used for drawing the inactive tabPage. + + + + + Used for drawing the highlighted tabPage. + + + + + Used for drawing the highlighted tabPage. + + + + + Used for drawing the borders of tabPages. + + + + + Used for drawing the borders of tabPages. + + + + + Used for drawing the borders of tabPages. + + + + + Initializes colors based on Windows XP color scheme. + + + + + Provides colors for Office2007 visual style. + + + + + Colors for blue colorscheme of the Office2007 visual style. + + + + + Colors for silver colorscheme of the Office2007 visual style. + + + + + Colors for black colorscheme of the Office2007 visual style. + + + + + + + + + + Default colorscheme for office2007 visual style. + + + + + Base color for managed scheme. + + + + + Gets or sets a value indicating whether managed color is alive or not. + + + + + Gets or sets default colors for Office2007 visual style. + + + + + Gets or sets default colorscheme for office2007 visual style. + + + + + + + + + + + + + + + Arguments class for event. + + + + + Initializes instance. + + Container form. + Base color for the managed theme. + + + + Container form. + + + + + Base color for the managed theme. + + + + + Gets color table for Office2007 visual style. + + + + + Applies colors for managed scheme. + + Container form. + Base color for the managed theme. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets the color for border of the menu. + + + + + Gets or sets the color for separator of the menu. + + + + + Gets or sets the dark color for highlighted item of the menu. + + + + + Gets or sets the light color for highlighted item of the menu. + + + + + Gets or sets the border color for highlighted item of the menu. + + + + + Gets or sets the dark color for column of the menu. + + + + + Gets or sets the separator color for column of the menu. + + + + + Gets or sets the light color for arrow of the menu item. + + + + + Gets or sets the dark color for arrow of the menu item. + + + + + Gets or sets the color for check mark of the menu. + + + + + Gets or sets the background color for check mark of the menu. + + + + + Gets or sets the color for border check mark of the menu. + + + + + Gets or sets the border color for TextBox item of the menu. + + + + + Gets or sets the background color for TextBox item of the menu. + + + + + Gets or sets the color for ComboButton of the menu. + + + + + Gets or sets the color for ComboButton of the menu. + + + + + Gets or sets the color for ComboButton of the menu. + + + + + Gets or sets the color for ComboButton of the menu. + + + + + Gets or sets the light color for highlighted ComboButton of the menu. + + + + + Gets or sets the dark color for highlighted ComboButton of the menu. + + + + + Gets or sets the color for arrow ComboButton of the menu. + + + + + Gets or sets the background color of the menu. + + + + + Gets or sets light color for dropdown button of the CommandBar. + + + + + Gets or sets dark color for dropdown button of the CommandBar. + + + + + Gets or sets dark color of the CommandBar. + + + + + Gets or sets light color of the CommandBar. + + + + + Gets or sets color for border of the CommandBar. + + + + + Gets or sets background color of the DockBar. + + + + + Gets or sets light color for highlight dropdown button of the CommandBar. + + + + + Gets or sets dark color for highlight dropdown button of the CommandBar. + + + + + Gets or sets light color for pressed dropdown button of the CommandBar. + + + + + Gets or sets dark color for pressed dropdown button of the CommandBar. + + + + + Gets or sets color for highlighted dropdown button of the floating CommandBar. + + + + + Gets or sets border color for highlighted dropdown button of the floating CommandBar. + + + + + Gets or sets color for pressed dropdown button of the floating CommandBar. + + + + + Gets or sets border color for pressed dropdown button of the floating CommandBar. + + + + + Gets or sets border color for pressed close button of the floating CommandBar. + + + + + Gets or sets color for pressed close button of the floating CommandBar. + + + + + Gets or sets light color of the floating CommandBar. + + + + + Gets or sets dark color of the floating CommandBar. + + + + + Gets or sets color for light border of the floating CommandBar. + + + + + Gets or sets background color of the floating CommandBar. + + + + + Gets or sets color for border of the floating CommandBar. + + + + + Gets or sets color for caption text of the floating CommandBar. + + + + + Gets or sets color for separator line of the CommandBar. + + + + + Gets or sets color for pressed border of the BarItem. + + + + + Gets or sets color for highlighted border of the BarItem. + + + + + Gets or sets light color for background of the BarItem. + + + + + Gets or sets dark color for background of the BarItem. + + + + + Gets or sets light color for background of the DropDownBarItem. + + + + + Gets or sets dark color for background of the DropDownBarItem. + + + + + Gets or sets color for border of the DropDownBarItem. + + + + + Gets or sets light color for background of the checked BarItem. + + + + + Gets or sets dark color for background of the checked BarItem. + + + + + Gets or sets color for border of the checked BarItem. + + + + + Gets or sets color for flash of the checked BarItem. + + + + + Gets or sets color for flash of the pressed BarItem. + + + + + Gets or sets color for flash of the selected BarItem. + + + + + Gets or sets back color for the TextBoxBarItem. + + + + + Gets or sets color for border of the TextBoxBarItem. + + + + + Gets or sets color for border of the highlight TextBoxBarItem. + + + + + Gets or sets light color for ComboButton of the ComboBoxBarItem. + + + + + Gets or sets dark color for ComboButton of the ComboBoxBarItem. + + + + + Gets or sets light color for ComboButton of the pressed ComboBoxBarItem. + + + + + Gets or sets dark color for ComboButton of the pressed ComboBoxBarItem. + + + + + Gets or sets light color for ComboButton of the highlighted ComboBoxBarItem. + + + + + Gets or sets dark color for ComboButton of the highlighted ComboBoxBarItem. + + + + + Gets or sets border color for ComboButton of the ComboBoxBarItem. + + + + + Gets or sets border color for ComboButton of the pressed ComboBoxBarItem. + + + + + Gets or sets border color for ComboButton of the highlighted ComboBoxBarItem. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the arrow start color for UpDownButtons. + + + + + Gets the arrow end color for UpDownButtons. + + + + + Gets the border color for UpDownButtons in normal state. + + + + + Gets the background color for UpDownButtons in normal state. + + + + + Gets the background start color for UpDownButtons in normal state. + + + + + Gets the background end color for UpDownButtons in normal state. + + + + + Gets the border color for UpDownButtons in hot state. + + + + + Gets the inner border start color for UpDownButtons in hot state. + + + + + Gets the inner border end color for UpDownButtons in hot state. + + + + + Gets the border color for UpDownButtons in pressed state. + + + + + Gets the inner border start color for UpDownButtons in pressed state. + + + + + Gets the inner border end color for UpDownButtons in pressed state. + + + + + Gets the background start color for UpDownButtons in disabled state. + + + + + Gets the background end color for UpDownButtons in disabled state. + + + + + Gets the border color for UpDownButtons in disabled state. + + + + + Gets the background top start color for UpDownButtons in hot state. + + + + + Gets the background top end color for UpDownButtons in hot state. + + + + + Gets the background bottom start color for UpDownButtons in hot state. + + + + + Gets the background bottom end color for UpDownButtons in hot state. + + + + + Gets the background top start color for UpDownButtons in pressed state. + + + + + Gets the background top end color for UpDownButtons in pressed state. + + + + + Gets the background bottom start color for UpDownButtons in pressed state. + + + + + Gets the background bottom end color for UpDownButtons in pressed state. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initialize colors general for all colorscheme of the Office2007 visual style. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Provides colors for blue colorscheme of the Office2007 visual style. + + + + + Initialize colors for Blue colorscheme of the Office2007 visual style. + + + + + Provides colors for silver colorscheme of the Office2007 visual style. + + + + + Initialize colors for Silver colorscheme of the Office2007 visual style. + + + + + Provides colors for black colorscheme of the Office2007 visual style. + + + + + Initialize colors for Black colorscheme of the Office2007 visual style. + + + + + Gets a value indicating whether themed colors are used. + + true if themed colors are used, false otherwise. + + + + gets/sets color of right auto hide panel. + + + + + Gets/sets color of left AH panel. + + + + + Gets or sets the color of the panel. + + + + + Gets or sets the color of the border. + + + + + Gets or sets the color of the inner border. + + + + + Gets or sets the color of the tab item. + + + + + Gets or sets the color for border of the DropDownBarItem. + + + + + Gets or sets the light color of the DropDownBarItem. + + + + + Gets or sets the dark color of the DropDownBarItem. + + + + + Gets or sets the color for border of the menu. + + + + + Gets or sets the color for separator of the menu. + + + + + Gets or sets the color for border selected item of the menu. + + + + + Gets or sets the color for selected item of the menu. + + + + + Gets or sets the color for column of the menu. + + + + + Gets or sets the color for check mark of the menu. + + + + + Gets or sets the color for selected check mark of the menu. + + + + + Gets or sets the color for check mark border of the menu. + + + + + Gets or sets the color for selected check mark border of the menu. + + + + + Gets or sets the background color of the menu. + + + + + Gets or sets border color of the BarItem. + + + + + Gets or sets border color of the pressed BarItem. + + + + + Gets or sets border color of the checked BarItem. + + + + + Gets or sets light color of the checked BarItem. + + + + + Gets or sets dark color of the checked BarItem. + + + + + Gets or sets light color of the BarItem. + + + + + Gets or sets dark color of the BarItem. + + + + + Gets or sets light color of the pressed BarItem. + + + + + Gets or sets dark color of the pressed BarItem. + + + + + Gets or sets light color for highlight dropdown button of the CommandBar. + + + + + Gets or sets dark color for highlight dropdown button of the CommandBar. + + + + + Gets or sets light color for pressed dropdown button of the CommandBar. + + + + + Gets or sets dark color for pressed dropdown button of the CommandBar. + + + + + Gets or sets light color for CombobBox button. + + + + + Gets or sets dark color for CombobBox button. + + + + + Gets a value indicating whether themed colors are used. + + true if themed colors are used, false otherwise. + + + + gets/sets color of right auto hide panel. + + + + + Gets/sets color of left AH panel. + + + + + Gets or sets the color of the panel. + + + + + Gets or sets the color of the border. + + + + + Gets or sets the color of the inner border. + + + + + Gets or sets the color of the tab item. + + + + + Gets or sets the color for border of the DropDownBarItem. + + + + + Gets or sets the light color of the DropDownBarItem. + + + + + Gets or sets the dark color of the DropDownBarItem. + + + + + Gets or sets the color for border of the menu. + + + + + Gets or sets the color for separator of the menu. + + + + + Gets or sets the color for border selected item of the menu. + + + + + Gets or sets the color for selected item of the menu. + + + + + Gets or sets the color for column of the menu. + + + + + Gets or sets the color for check mark of the menu. + + + + + Gets or sets the color for selected check mark of the menu. + + + + + Gets or sets the color for check mark border of the menu. + + + + + Gets or sets the color for selected check mark border of the menu. + + + + + Gets or sets the background color of the menu. + + + + + Gets or sets border color of the BarItem. + + + + + Gets or sets border color of the pressed BarItem. + + + + + Gets or sets border color of the checked BarItem. + + + + + Gets or sets light color of the checked BarItem. + + + + + Gets or sets dark color of the checked BarItem. + + + + + Gets or sets light color of the BarItem. + + + + + Gets or sets dark color of the BarItem. + + + + + Gets or sets light color of the pressed BarItem. + + + + + Gets or sets dark color of the pressed BarItem. + + + + + Gets or sets light color for highlight dropdown button of the CommandBar. + + + + + Gets or sets dark color for highlight dropdown button of the CommandBar. + + + + + Gets or sets light color for pressed dropdown button of the CommandBar. + + + + + Gets or sets dark color for pressed dropdown button of the CommandBar. + + + + + Gets or sets light color for CombobBox button. + + + + + Gets or sets dark color for CombobBox button. + + + + + Provides colors for blue colorscheme of the Office2010 visual style. + + + + + Initialize colors for Blue colorscheme of the Office2010 visual style. + + + + + Provides colors for silver colorscheme of the Office2010 visual style. + + + + + Initialize colors for Silver colorscheme of the Office2010 visual style. + + + + + Provides colors for black colorscheme of the Office2010 visual style. + + + + + Initialize colors for Black colorscheme of the Office2010 visual style. + + + + + Provides colors for Office2010 visual style. + + + + + Colors for blue colorscheme of the Office2010 visual style. + + + + + Colors for silver colorscheme of the Office2010 visual style. + + + + + Colors for black colorscheme of the Office2010 visual style. + + + + + + + + + + Gets or sets a value indicating whether managed color is alive or not. + + + + + Default colorscheme for office2010 visual style. + + + + + Base color for managed scheme. + + + + + Gets or sets default colors for Office2010 visual style. + + + + + Gets or sets default colorscheme for office2010 visual style. + + + + + + + + + + + + + + + Arguments class for event. + + + + + Initializes instance. + + Container form. + Base color for the managed theme. + + + + Container form. + + + + + Base color for the managed theme. + + + + + Gets color table for Office2010 visual style. + + + + + Applies colors for managed scheme. + + Container form. + Base color for the managed theme. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets the color for border of the menu. + + + + + Gets or sets the color for separator of the menu. + + + + + Gets or sets the dark color for highlighted item of the menu. + + + + + Gets or sets the light color for highlighted item of the menu. + + + + + Gets or sets the border color for highlighted item of the menu. + + + + + Gets or sets the dark color for column of the menu. + + + + + Gets or sets the separator color for column of the menu. + + + + + Gets or sets the light color for arrow of the menu item. + + + + + Gets or sets the dark color for arrow of the menu item. + + + + + Gets or sets the color for check mark of the menu. + + + + + Gets or sets the background color for check mark of the menu. + + + + + Gets or sets the color for border check mark of the menu. + + + + + Gets or sets the border color for TextBox item of the menu. + + + + + Gets or sets the background color for TextBox item of the menu. + + + + + Gets or sets the color for ComboButton of the menu. + + + + + Gets or sets the color for ComboButton of the menu. + + + + + Gets or sets the color for ComboButton of the menu. + + + + + Gets or sets the color for ComboButton of the menu. + + + + + Gets or sets the light color for highlighted ComboButton of the menu. + + + + + Gets or sets the dark color for highlighted ComboButton of the menu. + + + + + Gets or sets the color for arrow ComboButton of the menu. + + + + + Gets or sets the background color of the menu. + + + + + Gets or sets light color for dropdown button of the CommandBar. + + + + + Gets or sets dark color for dropdown button of the CommandBar. + + + + + Gets or sets dark color of the CommandBar. + + + + + Gets or sets light color of the CommandBar. + + + + + Gets or sets color for border of the CommandBar. + + + + + Gets or sets background color of the DockBar. + + + + + Gets or sets light color for highlight dropdown button of the CommandBar. + + + + + Gets or sets dark color for highlight dropdown button of the CommandBar. + + + + + Gets or sets light color for pressed dropdown button of the CommandBar. + + + + + Gets or sets dark color for pressed dropdown button of the CommandBar. + + + + + Gets or sets color for highlighted dropdown button of the floating CommandBar. + + + + + Gets or sets border color for highlighted dropdown button of the floating CommandBar. + + + + + Gets or sets color for pressed dropdown button of the floating CommandBar. + + + + + Gets or sets border color for pressed dropdown button of the floating CommandBar. + + + + + Gets or sets border color for pressed close button of the floating CommandBar. + + + + + Gets or sets color for pressed close button of the floating CommandBar. + + + + + Gets or sets light color of the floating CommandBar. + + + + + Gets or sets dark color of the floating CommandBar. + + + + + Gets or sets color for light border of the floating CommandBar. + + + + + Gets or sets background color of the floating CommandBar. + + + + + Gets or sets color for border of the floating CommandBar. + + + + + Gets or sets color for caption text of the floating CommandBar. + + + + + Gets or sets color for separator line of the CommandBar. + + + + + Gets or sets color for pressed border of the BarItem. + + + + + Gets or sets color for highlighted border of the BarItem. + + + + + Gets or sets light color for background of the BarItem. + + + + + Gets or sets dark color for background of the BarItem. + + + + + Gets or sets light color for background of the DropDownBarItem. + + + + + Gets or sets dark color for background of the DropDownBarItem. + + + + + Gets or sets color for border of the DropDownBarItem. + + + + + Gets or sets light color for background of the checked BarItem. + + + + + Gets or sets dark color for background of the checked BarItem. + + + + + Gets or sets color for border of the checked BarItem. + + + + + Gets or sets color for flash of the checked BarItem. + + + + + Gets or sets color for flash of the pressed BarItem. + + + + + Gets or sets color for flash of the selected BarItem. + + + + + Gets or sets back color for the TextBoxBarItem. + + + + + Gets or sets color for border of the TextBoxBarItem. + + + + + Gets or sets color for border of the highlight TextBoxBarItem. + + + + + Gets or sets light color for ComboButton of the ComboBoxBarItem. + + + + + Gets or sets dark color for ComboButton of the ComboBoxBarItem. + + + + + Gets or sets light color for ComboButton of the pressed ComboBoxBarItem. + + + + + Gets or sets dark color for ComboButton of the pressed ComboBoxBarItem. + + + + + Gets or sets light color for ComboButton of the highlighted ComboBoxBarItem. + + + + + Gets or sets dark color for ComboButton of the highlighted ComboBoxBarItem. + + + + + Gets or sets border color for ComboButton of the ComboBoxBarItem. + + + + + Gets or sets border color for ComboButton of the pressed ComboBoxBarItem. + + + + + Gets or sets border color for ComboButton of the highlighted ComboBoxBarItem. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the arrow start color for UpDownButtons. + + + + + Gets the arrow end color for UpDownButtons. + + + + + Gets the border color for UpDownButtons in normal state. + + + + + Gets the background color for UpDownButtons in normal state. + + + + + Gets the background start color for UpDownButtons in normal state. + + + + + Gets the background end color for UpDownButtons in normal state. + + + + + Gets the border color for UpDownButtons in hot state. + + + + + Gets the inner border start color for UpDownButtons in hot state. + + + + + Gets the inner border end color for UpDownButtons in hot state. + + + + + Gets the border color for UpDownButtons in pressed state. + + + + + Gets the inner border start color for UpDownButtons in pressed state. + + + + + Gets the inner border end color for UpDownButtons in pressed state. + + + + + Gets the background start color for UpDownButtons in disabled state. + + + + + Gets the background end color for UpDownButtons in disabled state. + + + + + Gets the border color for UpDownButtons in disabled state. + + + + + Gets the background top start color for UpDownButtons in hot state. + + + + + Gets the background top end color for UpDownButtons in hot state. + + + + + Gets the background bottom start color for UpDownButtons in hot state. + + + + + Gets the background bottom end color for UpDownButtons in hot state. + + + + + Gets the background top start color for UpDownButtons in pressed state. + + + + + Gets the background top end color for UpDownButtons in pressed state. + + + + + Gets the background bottom start color for UpDownButtons in pressed state. + + + + + Gets the background bottom end color for UpDownButtons in pressed state. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initialize colors general for all colorscheme of the Office2010 visual style. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Colors for silver colorscheme of the metro visual style. + + + + + Colors for black colorscheme of the metro visual style. + + + + + Colors for blue colorscheme of the metro visual style. + + + + + Colors for blue colorscheme of the metro visual style. + + + + /// + Colors for blue colorscheme of the metro visual style. + + + + + Colors for blue colorscheme of the metro visual style. + + + + + Colors for blue colorscheme of the metro visual style. + + + + + Colors for blue colorscheme of the metro visual style. + + + + + Colors for blue colorscheme of the metro visual style. + + + + + + + Base color for managed scheme. + + + + + Gets or sets default colors for metro visual style. + + + + + Gets or sets default colorscheme for metro visual style. + + + + + + + + + + + + + + + Arguments class for event. + + + + + Initializes instance. + + Container form. + Base color for the managed theme. + + + + Container form. + + + + + Base color for the managed theme. + + + + + Gets color table for Metro Color. + + + + + Applies colors for managed scheme. + + Container form. + Base color for the managed theme. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initialize colors general for all colorscheme of the Metro visual style. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Provides colors for Magenta colorscheme of the Metro visual style. + + + + + Initialize colors for Magenta colorscheme of the Metro visual style. + + + + + Provides colors for Orange colorscheme of the Metro visual style. + + + + + Initialize colors for Blue colorscheme of the Metro visual style. + + + + + Provides colors for Teal colorscheme of the Metro visual style. + + + + + Initialize colors for Teal colorscheme of the Metro visual style. + + + + + Provides colors for Brown colorscheme of the Metro visual style. + + + + + Initialize colors for Brown colorscheme of the Metro visual style. + + + + + Provides colors for Lime colorscheme of the Metro visual style. + + + + + Initialize colors for Lime colorscheme of the Metro visual style. + + + + + Provides colors for Purple colorscheme of the Metro visual style. + + + + + Initialize colors for Purple colorscheme of the Metro visual style. + + + + + Provides colors for Pink colorscheme of the Metro visual style. + + + + + Initialize colors for Pink colorscheme of the Metro visual style. + + + + + Provides colors for Blue colorscheme of the Metro visual style. + + + + + Initialize colors for Blue colorscheme of the Metro visual style. + + + + + Provides colors for Red colorscheme of the Metro visual style. + + + + + Initialize colors for Red colorscheme of the Metro visual style. + + + + + Provides colors for Green colorscheme of the Metro visual style. + + + + + Initialize colors for Green colorscheme of the Metro visual style. + + + + + Specifies that this object supports . + + + + + Specifies to use. + + + + + Enables rendering with . + + + + + Specifies that this object supports . + + + + + Specifies to use. + + + + + Enables rendering with . + + + + + Specifies that this object supports . + + + + + Specifies to use. + + + + + Enables rendering with . + + + + + Draws a themed button. + + + + + Value for reduce ClientRectangle. + + + + + Value for shift image rectangle. + + + + + Image for draw foreground. + + + + + Indicate wether the image for button + is stretched or shrunk to fit the size of the button. + + + + + Indicates whether mouse positionin is over control. + + + + + Gets or sets image for draw foreground. + + + + + Indicates whether mouse positionin is over control. + + + + + Indicate wether the image for button + is stretched or shrunk to fit the size of the button. + + + + + Occurs when is changed. + + + + + Occurs when is changed. + + + + + + + + Gets / sets the flatcolor of the themed button. + + + + + Gets or sets the visual style of the themed button. + + + + + Indicates the Office2007 theme used for drawing the control. + + + + + Indicates the Office2010 theme used for drawing the control. + + + + + Indicates whether to draw the button text. + + + + + Gets / sets the text alignment. + + + + + Gets / sets the checked state. + + + + + Gets / sets the default button state. + + + + + Initializes a new object. + + + + + Draws the text. + + The graphics object. + + + + Draws the button themed. + + Graphics object. + The button state. + The checked state. + + + + Draws the button without themes. + + Graphics object. + The button state. + The checked state. + + + + Draws the styled button without themes. + + Graphics object. + The button state. + The checked state. + + + + Draws a themed check button. + + + + + Indicates the checked state of the button. + + + + + MetroColor + + + + + Gets or setsthe metrocolor. + + + + + Disposes all resources. + + + + + + Initializes a new object. + + + + + + + + + + + Implement this interface in a derived class to start supporting themes. + + + + + Indicates whether themes are enabled. + + + + + A implementing the interface. + + + + + Fired when the ThemesEnabled property changes. + + + + + + + + Raises the ThemeChanged event. + + An EventArgs that contains the event data. + + The OnThemeChanged method also allows derived classes to handle the event + without attaching a delegate. This is the preferred technique for + handling the event in a derived class. + Note to Inheritors: When overriding OnThemeChanged in a derived + class, be sure to call the base class's OnThemeChanged method so that + registered delegates receive the event. + + + + + Indicates whether themes are enabled for this control. + + + + + Manages the theme handle given a control and exposes some basic themed Drawing methods. + + + + The bound to this class can either implement the + interface or pass on the WM_THEMECHANGED message + to this class with a call to the method. + + + + + Creates a new instance of the class. + + Pointer to a string that contains a semicolon-separated list of classes, as expected + in the OpenThemeData API. + + + The bound to this class can either implement the + interface or pass on the WM_THEMECHANGED message + to this class with a call to the method. + This is necessary in order that this class can refresh its handles when themes + settings are updated. + + You can get the part and state ids required for the DrawXXX methods from the tmschema.h file (that comes with + Platform SDK) or refer to the undocumented and incomplete ThemeParts and ThemeStates classes + in our shared library (in the ThemeDefines.cs file). + + + + + Creates a new instance of the class. + + Pointer to a string that contains a semicolon-separated list of classes, as expected + in the OpenThemeData API. + Owning component. + + + The bound to this class can either implement the + interface or pass on the WM_THEMECHANGED message + to this class with a call to the method. + This is necessary in order that this class can refresh its handles when themes + settings are updated. + + You can get the part and state ids required for the DrawXXX methods from the tmschema.h file (that comes with + Platform SDK) or refer to the undocumented and incomplete ThemeParts and ThemeStates classes + in our shared library (in the ThemeDefines.cs file). + If owning component is not null, automatically unregisters itself from + on component disposing. + + + + + Overridden. See . + + + + + + Returns the current theme handle used to render the parts. + + + + + Called to create a theme handle, given the specified control and classList. + + + + + Closes the currently open theme handle. + + + + + Closes the current theme handle. + + + + + Closes the current theme handle and tries to open a new one. + + + + + Overloaded. Draws the specified theme background. + + A object. + An integer specifying the part. + An integer specifying the state. + The background . + + See for information on how to get the part and state IDs. + This method uses the VisibleClipRegion in the Graphics object to obtain the clip rect. + + + + + Draws the specified theme background. + + A object. + An integer specifying the part. + An integer specifying the state. + The background . + The clip rect to be used. + + See for information on how to get the part and state IDs. + Use this function to provide custom clip bounds. + + + + + Overloaded. Draws the specified theme text. + + A object. + An integer specifying the part. + An integer specifying the state. + The text to be drawn. + The layout bounds within which to draw. + Refers to the DrawThemeText function in the Windows API. + Refers to the DrawThemeText function in the Windows API. + + + + Draws the specified theme text. + + A object. + An integer specifying the part. + An integer specifying the state. + The text to be drawn. + The layout bounds within which to draw. + Refers to the DrawThemeText function in the Windows API. + Refers to the DrawThemeText function in the Windows API. + + + + Returns the size for the specified part. + + A object. + An integer specifying the part. + An integer specifying the state. + The size type. + The requested size. + + + + Calculates the size and location of the specified text when rendered in the theme font. + + A object. + An integer specifying the part. + An integer specifying the state. + The text to draw. + The layout bounds. + See GetThemeTextExtent method documentation in Windows API. + The rectangle representing the extent. + + + Cached version of themed controls instances. Class will + return NULL instead of instance if OS does not support XP Themes. + + + Thread synchronization object. Used for instance clear and create + operations locks. + + + Edit control. + + + Button control. + + + Tree control. + + + + + + + + + + + + Reset static class cache. All internal static resources will be released. + Operation is thread safe. + + + + Specifies the theme size type requested using . + + + + + Requesting the minimum size. + + + + + Requesting the size of the theme part that will best fit the available space. + + + + + Requesting the size that the theme manager uses to draw a part. + + + + + Draws a themed scroll button. + + + + + Gets / sets the type of scroll arrow. + + + + + Initializes a new object. + + + + + Disposes all resources being used. + + + + + + + + + + + + Returns the color for paint control background. + + + + + + + Implement this interface to support skins across the Grid. Exposes some themed drawing methods. + + + + + Draws the Header skins. + + A object. + A object that represents the drawing area. + The current state of the header. + + + + Returns the Header Border Colors. + + The bottom border color + The right border color + The gradient start color for the header interior + The gradient end color for the header interior + + + + + Returns the SortIcon interior + + The brush used to fill the sort icon + The pen used to draw the sort icon + + + + + Returns the backcolor and header interior for GroupDropArea. + + The back color for GroupDropArea + The top border color for GroupDropArea header + The left border color for GroupDropArea header + + + + + Draws the PushButton skins + + A object. + A object that represents the drawing area. + The current state of the button. + + + + Draws the ComboBox skins + + A object. + A object that represents the drawing area. + The current state of the combo button. + + + + Draws the SpinButton skins + + A object. + A object that represents the drawing area. + An integer that represents the type of the button. + The current state of the spin button. + + + + Draws the CheckBox skins + + A object. + A object that represents the drawing area. + The current state of the checkbox + Specifies whether the button is tri-stated. + + + + Draws the CheckBox skins + + A object. + A object that represents the drawing area. + The current state of the checkbox + Specifies whether the button is tri-stated. + Specifies whether the button is intermediate state + + + + Draws the RadioButton skins + + A object. + A object that represents the drawing area. + The current state of the radio button + + + + Gets the current VisualStyles. + + + + + Gets the current theme name. + + + + + Returns the Header Border styles. + + The bottom border color of header. + The bottom border weight. + returns the weight and color of bottom border. + + + + Header style color of Grid + + Header color + hover color + pressed color + true + + + + header style text color + + Normal text color + hover text color + pressed text color + true + + + + Gets the current VisualStyles. + + + + + Implements the Metro look and feel + + + + + Creates a new instance of class. + + The current visual style. + + + + Creates a new instance of class. + + The current theme name. + + + + Draws the header skins + + A object. + A object that represents the drawing area. + The current state of the header. + + + + Returns the Header Border Colors. + + The bottom border color + The right border color + The gradient start color for the header interior + The gradient end color for the header interior + + + + + Returns the Header Border styles. + + The bottom border color of header. + The bottom border weight. + returns the weight and color of bottom border. + + + + Returns the SortIcon interior + + The brush used to fill the sort icon + The pen used to draw the sort icon + + + + + Returns the backcolor and header interior for GroupDropArea. + + The back color for GroupDropArea + The top border color for GroupDropArea header + The left border color for GroupDropArea header + + + + + Header style color of Grid + + Header color + hover color + pressed color + + + + + Draws the PushButton skins + + A object. + A object that represents the drawing area. + The current state of the button. + + + + Draws the ComboBox skins + + A object. + A object that represents the drawing area. + The current state of the combo button. + + + + Draws the SpinButton skins + + A object. + A object that represents the drawing area. + An integer that represents the type of the button. + The current state of the spin button. + + + + Draws the CheckBox skins + + A object. + A object that represents the drawing area. + The current state of the checkbox + Specifies whether the button is tri-stated. + + + + Draws the CheckBox skins + + A object. + A object that represents the drawing area. + The current state of the checkbox + Specifies whether the button is tri-stated. + Specifies Whether the button is Intermediate state + + + + Draws the RadioButton skins + + A object. + A object that represents the drawing area. + The current state of the radio button + + + + Gets the current VisualStyles. + + + + + Gets the current theme name. + + + + + Implements the skin collection for ofice2016 theme(Black, White, DarkGray and Colorful). + + + + + Initialize a new instance of class. + + + + + Intialize the skin collection based on the grid visual styles. + + + + + Draws the ComboBox skins + + A object. + A object that represents the drawing area. + The current state of the combo button. + + + + Draws the SpinButton skins + + A object. + A object that represents the drawing area. + An integer that represents the type of the button. + The current state of the spin button. + + + + Draws the ComboBox skins + + A object. + A object that represents the drawing area. + The current state of the combo button. + + + + Describes the Office2016 theme colors. + + + + + Initialize a new instance of the class. + + + + + Represents a class that holds the default colors for the Office 2016 Colorful theme. + + + + + Initialize a new instance of the class. + + + + + Represents a class that holds the default colors for the Office 2016 Black theme. + + + + + Initialize a new instance of the class. + + + + + Represents a class that holds the default colors for the Office 2016 White theme. + + + + + Initialize a new instance of the class. + + + + + Represents a class that holds the default colors for the Office 2016 DarkGray theme. + + + + + Initialize a new instance of the class. + + + + + Implement the SkinCollection for GridMetroColors + + + + + Collecction initialize + + + + + get / set Header color collection + + + + + get / set Header text color collection + + + + + get /set grop drop area color + + + + + get / set sort icon color collection + + + + + get / set collection of check box color + + + + + get/ set combo box color collection + + + + + get / set spin button color collection + + + + + get /set push button color collection + + + + + get or set radio button color collection + + + + + gets or sets header botom border color + + + + + Gets/Sets the header botom border weight. + + + + + Specifies the weight of a header bottom border class. + None option is used to Show / hide the bottom border. + + + + + A line with 0.25 point. + + + + + A line with 0.5 point. + + + + + A line with 1 point. + + + + + A line with 1.5 points. + + + + + A line with 2.0 points. + + + + + A line with 3.0 points. + + + + + This hide the header bottom border. + + + + + Collectionn of Header color + + + + + Get / set the Header Color in normal mode + + + + + Get / set the Header Color in mouse Hover + + + + + Get / set the header Color in mouse pressed + + + + + Collection of Header text color + + + + + grt /set normal header text color + + + + + get / set hover text color of header + + + + + get /set header pressed color + + + + + Collection of sort icon color + + + + + Get / set the sort icon Color in normal + + + + + Get / set the sort icon Color in hover + + + + + Collection of Check box Color + + + + + Get / set the border color of checkbox + + + + + Get / set the back color of check box + + + + + Get / set the check marker color + + + + + Collection of GridCombobox color + + + + + Get / set the combobox + + + + + Get / set the combobox NormalBorderColor + + + + + Get / set the hoverBackColor + + + + + Get / set the HoverBorderColor + + + + + Get / set the pressedBackColor + + + + + Get / set the presedBorderColor + + + + + Collection of Grid spin button colors + + + + + Get / set spin button normal back color + + + + + Get / set spin button normal border color + + + + + Get / set spin button hover back color + + + + + Get / set spin button hover border color + + + + + Get / set spin button pressed back color + + + + + Get / set spin button pressed border color + + + + + Collection of grid push button colors + + + + + Get / set normal push button color + + + + + Get / set bush button hover color + + + + + Get / set push button back color + + + + + Collection of radio button color + + + + + Get / set radio button color + + + + + Get / set radio button checked color + + + + + collection of Group drop area color + + + + + Get / set group srop area back color + + + + + Get / set grid gropu drop are border top color + + + + + Get / set group drop area border left color + + + + + Implements the Office 2010 look and feel + + + + + Creates a new instance of class. + + The current visual style. + + + + Draws the header skins + + A object. + A object that represents the drawing area. + The current state of the header. + + + + Returns the Header Border Colors. + + The bottom border color + The right border color + The gradient start color for the header interior + The gradient end color for the header interior + + + + + Returns the Header Border styles. + + The bottom border color of header. + The bottom border weight. + returns the weight and color of bottom border. + + + + Returns the SortIcon interior + + The brush used to fill the sort icon + The pen used to draw the sort icon + + + + + Returns the backcolor and header interior for GroupDropArea. + + The back color for GroupDropArea + The top border color for GroupDropArea header + The left border color for GroupDropArea header + + + + + Header style color of Grid + + Header color + hover color + pressed color + + + + + Draws the PushButton skins + + A object. + A object that represents the drawing area. + The current state of the button. + + + + Draws the ComboBox skins + + A object. + A object that represents the drawing area. + The current state of the combo button. + + + + Draws the SpinButton skins + + A object. + A object that represents the drawing area. + An integer that represents the type of the button. + The current state of the spin button. + + + + Draws the CheckBox skins + + A object. + A object that represents the drawing area. + The current state of the checkbox + Specifies whether the button is tri-stated. + + + + Draws the CheckBox skins + + A object. + A object that represents the drawing area. + The current state of the checkbox + Specifies whether the button is tri-stated. + Specifies whether the button is intermediate state + + + + Draws the RadioButton skins + + A object. + A object that represents the drawing area. + The current state of the radio button + + + + Gets the current VisualStyles. + + + + + Gets the current theme name. + + + + + Implements the Office 2007 Blue look and feel. + + + + + Creates a new instance of class. + + The current visual style. + + + + Draws the header skins + + A object. + A object that represents the drawing area. + The current state of the header. + + + + Returns the Header Border Colors. + + The bottom border color + The right border color + The gradient start color for the header interior + The gradient end color for the header interior + + + + + Returns the SortIcon interior + + The brush used to fill the sort icon + The pen used to draw the sort icon + + + + + Returns the backcolor and header interior for GroupDropArea. + + The back color for GroupDropArea + The top border color for GroupDropArea header + The left border color for GroupDropArea header + + + + + Draws the PushButton skins + + A object. + A object that represents the drawing area. + The current state of the button. + + + + Draws the ComboBox skins + + A object. + A object that represents the drawing area. + The current state of the combo button. + + + + Draws the SpinButton skins + + A object. + A object that represents the drawing area. + An integer that represents the type of the button. + The current state of the spin button. + + + + Draws the CheckBox skins + + A object. + A object that represents the drawing area. + The current state of the checkbox + Specifies whether the button is tri-stated. + + + + Draws the CheckBox skins + + A object. + A object that represents the drawing area. + The current state of the checkbox + Specifies whether the button is tri-stated. + Specifies whether the button is intermediate state + + + + Draws the RadioButton skins + + A object. + A object that represents the drawing area. + The current state of the radio button + + + + Gets the current VisualStyles. + + + + + Gets the current theme name. + + + + + Implements the Office 2007 Black look and feel + + + + + Creates a new instance of class. + + The current visual style. + + + + Draws the header skins + + A object. + A object that represents the drawing area. + The current state of the header. + + + + Returns the Header Border Colors. + + The bottom border color + The right border color + The gradient start color for the header interior + The gradient end color for the header interior + + + + + Returns the SortIcon interior + + The brush used to fill the sort icon + The pen used to draw the sort icon + + + + + Returns the backcolor and header interior for GroupDropArea. + + The back color for GroupDropArea + The top border color for GroupDropArea header + The left border color for GroupDropArea header + + + + + Draws the PushButton skins + + A object. + A object that represents the drawing area. + The current state of the button. + + + + Draws the ComboBox skins + + A object. + A object that represents the drawing area. + The current state of the combo button. + + + + Draws the SpinButton skins + + A object. + A object that represents the drawing area. + An integer that represents the type of the button. + The current state of the spin button. + + + + Draws the CheckBox skins + + A object. + A object that represents the drawing area. + The current state of the checkbox + Specifies whether the button is tri-stated. + + + + Draws the CheckBox skins + + A object. + A object that represents the drawing area. + The current state of the checkbox + Specifies whether the button is tri-stated. + Specifies whether the button is intermediate state + + + + Draws the RadioButton skins + + A object. + A object that represents the drawing area. + The current state of the radio button + + + + Gets the current visual style. + + + + + Gets the current theme name. + + + + + Implements the Office 2007 Silver look and feel + + + + + Creates a new instance of class. + + The current visual style. + + + + Draws the header skins + + A object. + A object that represents the drawing area. + The current state of the header. + + + + Returns the Header Border Colors. + + The bottom border color + The right border color + The gradient start color for the header interior + The gradient end color for the header interior + + + + + Returns the SortIcon interior + + The brush used to fill the sort icon + The pen used to draw the sort icon + + + + + Returns the backcolor and header interior for GroupDropArea. + + The back color for GroupDropArea + The top border color for GroupDropArea header + The left border color for GroupDropArea header + + + + + Draws the PushButton skins + + A object. + A object that represents the drawing area. + The current state of the button. + + + + Draws the ComboBox skins + + A object. + A object that represents the drawing area. + The current state of the combo button. + + + + Draws the SpinButton skins + + A object. + A object that represents the drawing area. + An integer that represents the type of the button. + The current state of the spin button. + + + + Draws the CheckBox skins + + A object. + A object that represents the drawing area. + The current state of the checkbox + Specifies whether the button is tri-stated. + + + + + + A object. + A object that represents the drawing area. + The current state of the checkbox + Specifies whether the button is tri-stated. + Specifies whether the button is in intermediate state + + + + Draws the RadioButton skins + + A object. + A object that represents the drawing area. + The current state of the radio button + + + + Gets the current visual style. + + + + + Gets the current theme name. + + + + + Implements the Office 2003 look and feel + + + + + Creates a new instance of class. + + The current visual style. + + + + Dispose the resources being used. + + + + + + Draws the header skins + + A object. + A object that represents the drawing area. + The current state of the header. + + + + Returns the Header Border Colors. + + The bottom border color + The right border color + The gradient start color for the header interior + The gradient end color for the header interior + + + + + Returns the SortIcon interior + + The brush used to fill the sort icon + The pen used to draw the sort icon + + + + + Returns the backcolor and header interior for GroupDropArea. + + The back color for GroupDropArea + The top border color for GroupDropArea header + The left border color for GroupDropArea header + + + + + Draws the PushButton skins + + A object. + A object that represents the drawing area. + The current state of the button. + + + + Draws the ComboBox skins + + A object. + A object that represents the drawing area. + The current state of the combo button. + + + + Draws the SpinButton skins + + A object. + A object that represents the drawing area. + An integer that represents the type of the button. + The current state of the spin button. + + + + Draws the CheckBox skins + + A object. + A object that represents the drawing area. + The current state of the checkbox + Specifies whether the button is tri-stated. + + + + Draws the CheckBox skins + + A object. + A object that represents the drawing area. + The current state of the checkbox + Specifies whether the button is tri-stated. + Specifies whether the button is intermediate state + + + + Draws the RadioButton skins + + A object. + A object that represents the drawing area. + The current state of the radio button + + + + Gets the current VisualStyle. + + + + + Gets the current theme name. + + + + + Implements the SystemTheme for grid components. + + + + + Disposes all resources being used. + + + + + + Creates a new instance of class. + + The current visual style. + + + + Draws the header skins + + A object. + A object that represents the drawing area. + The current state of the header. + + + + Returns the Header Border Colors. + + The bottom border color + The right border color + The gradient start color for the header interior + The gradient end color for the header interior + + + + + Returns the SortIcon interior + + The brush used to fill the sort icon + The pen used to draw the sort icon + + + + + Returns the backcolor and header interior for GroupDropArea. + + The back color for GroupDropArea + The top border color for GroupDropArea header + The left border color for GroupDropArea header + + + + + Draws the PushButton skins + + A object. + A object that represents the drawing area. + The current state of the button. + + + + Draws the ComboBox skins + + A object. + A object that represents the drawing area. + The current state of the combo button. + + + + Draws the SpinButton skins + + A object. + A object that represents the drawing area. + An integer that represents the type of the button. + The current state of the spin button. + + + + Draws the CheckBox skins + + A object. + A object that represents the drawing area. + The current state of the checkbox + Specifies whether the button is tri-stated. + + + + Draws the CheckBox skins + + A object. + A object that represents the drawing area. + The current state of the checkbox + Specifies whether the button is tri-stated. + Specifies whether the button is intermediate state + + + + Draws the RadioButton skins + + A object. + A object that represents the drawing area. + The current state of the radio button + + + + Gets the current VisualStyle. + + + + + Gets the current theme name. + + + + + Specifies the VisualStyle with which various components across the grid will appear and behave. + + + + + Represents the colors for Office2003 style. + Provides static members to access the colors used by different grid elements. + + + + + Represents the colors for Office2007 style. + Provides static members to access the colors used by different grid elements. + + + + + Gets an array of colors used for Office2007Blue style. + + + + + Gets an array of colors used to represent Hot State color. + + + + + Gets an array of colors used to represent Pressed State color. + + + + + Represents the colors for Office2010style. + Provides static members to access the colors used by different grid elements. + + + + + Gets an array of colors used to represent Hot State color. + + + + + Gets an array of colors used to represent Pressed State color. + + + + + Specifies the VisualStyle with which various components across the grid will appear and behave. + + + + + Provides some information regarding themes support and state in the OS. + + + + + + + + + + + + + + + + + + + + + + + Returns the theme file name with the path. + + + + + Returns the current theme color scheme name. + + + + + Indicates whether the default blue theme is on. + + + + + Indicates whether the Olive Green theme is on. + + + + + Indicates whether the Silver theme is on. + + + + + Indicates whether this OS has themes support built-in. + + True if themes are supported; False otherwise. + This property returns True for Windows XP and later versions. + + + + Indicates whether themes are enabled in the current OS. + + + + + Indicates whether the current application is themed. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Used to unwire the ThemeChangeListenerForm class. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies that this object subscribes to event. + + + + + Class for automatic subscription management of event. + + + + + Initializes a new instance of the class. + + The target. + + + + Handles theme change. + + The sender. + The instance containing the event data. + + + + Gets or sets the object (the target) referenced by the current object. + + + null if the object referenced by the current object has been garbage collected; otherwise, a reference to the object referenced by the current object. + + + The reference to the target object is invalid. This exception can be thrown while setting this property if the value is a null reference or if the object has been finalized during the set operation. + + + + + A form-derived class that can be derived to create custom top-level + windows like ToolTips, a splash window, etc. + + + + + Creates a new instance of the TopLevelWindow class. + + + + + Shows the window as the top-level window without activating it. + + + + + Overridden to ignore Win32Exception. + + + + + Provides data for a cancelable mouse event. + + + + + Initializes a new with data from a . + + The data for this event. + + + + The data for this event. + + + + + + + + Handles a cancelable mouse event. + + + + + DelayedWaitCursor listens to OperationFeedback events and changes + the cursor if a certain number of ticks have elapsed since the start + of the operation. + + + + + Overloaded. Initializes a new instance. + + + + + Initializes a new instance. + + An object that implements the interface. + + + Adds an that this object will listen to and + provide user feedback for. + + + + + Overriden. Displays a wait cursor. + + An that contains the event data. + + + + DelayedStatusDialog listens to OperationFeedback events and displays + a modeless status dialog if a certain number of ticks have elapsed since the start + of the operation. + + + + + Overloaded. Initializes a new instance. + + + + + Initializes a new instance. + + An object that implements the interface. + + + Adds an that this object will listen to and + provide user feedback for. + + + + + + + + The progress percentage value to be used for displaying a dialog bar. A dialog bar + is displayed when the operation's progress in percentage is less than the specified value + at the time progress should be displayed. + + + Typical values are 25 for + and 75 for . + + In this example, if the operation takes longer than two seconds and after two seconds + only 10% of the operation have completed, a dialog is displayed. If on the other side + after two seconds more than 25% have been completed and less than 75%, a wait cursor is displayed. + If more than 75% have been completed, no visual feedback at all will be given. + + + + + + The progress percentage value to be used for displaying a wait cursor. A wait cursor + is shown when the operation's progress in percentage is less than the specified value + at the time progress should be displayed. + + + is ignored if + is false. + + Typical values are 25 for + and 75 for . + + In this example, if the operation takes longer than two seconds and after two seconds + only 10% of the operation have completed, a dialog is displayed. If on the other side + after two seconds more than 25% have been completed and less than 75%, a wait cursor is displayed. + If more than 75% have been completed, no visual feedback at all will be given. + + + + + + Indicates whether wait cursors should be shown. + + + is ignored if + is False. + + + + + Overriden. Displays a dialog or wait cursor during progress and closes the dialog when operation is finished. + + An that contains the event data. + + + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + + + + + + + + + + + + Cursor of the parent object. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Parent control supporting Drag operation. + + + + + Indicates whether shift value is calculated. + + + + + + + + + + + Handles the WM_SETCURSOR message. + + + + + + + + + Gets / sets the parent control supporting drag operation. + + + + + Interface for implementing by parent control supporting Drag operation. + Methods of this interface invoke corresponding drag methods of parent control. + + + + + The FolderBrowser component provides a convenient and easy to use object oriented wrapper for the + Win32 Shell folder browser API. + + + The FolderBrowser class completely abstracts the various complex Shell API functions, + structures and callback routines required for invoking the folder selection dialog and allows + you to work with a more .NET-centric programming model consisting of aptly named properties, methods and + events. Most convenient of all, you no longer need to allocate PIDLs as specifying + the location of the rootfolder; browsing is now a simple task of setting the + FolderBrowser.StartLocation property from one of the values provided in the FolderBrowserFolder + enumeration. Using the FolderBrowser class to browse the Shell folders is simple and + to the .NET developer a completely familiar issue of instantiating the FolderBrowser + component, setting the appropriate properties and events on it and invoking the + method. For more detailed information on the Shell APIs refer + to the Platform SDK documentation on the SHBrowseForFolder method. + + + The following code creates an instance of the FolderBrowser component, sets the folder dialog start location + and styles and invokes the FolderBrowser.ShowDialog() method: + + + private void ShowFolderBrowserDialog() + { + // Create the FolderBrowser component: + this.folderBrowser1 = new Syncfusion.Windows.Forms.FolderBrowser(); + + // Initialize the FolderBrowser component: + this.folderBrowser1.Description = "Syncfusion FolderBrowser"; + this.folderBrowser1.StartLocation = Syncfusion.Windows.Forms.FolderBrowserFolder.Desktop; + this.folderBrowser1.Style = + ( Syncfusion.Windows.Forms.FolderBrowserStyles.RestrictToFilesystem | + Syncfusion.Windows.Forms.FolderBrowserStyles.BrowseForComputer ); + + // Provide a handler for the FolderBrowserCallback validation event: + this.folderBrowser1.FolderBrowserCallback += new Syncfusion.Windows.Forms.FolderBrowserCallbackEventHandler(this.folderBrowser1_BrowseCallback); + + // Display the folderbrowser dialog: + if (this.folderBrowser1.ShowDialog() == DialogResult.OK) + this.selectedFolder = this.folderBrowser1.DirectoryPath; + } + + // Event handler for the FolderBrowser.FolderBrowserCallback validation event. + // This handler is functionally equivalent of the Win32 BrowseCallbackProc callback function: + private void folderBrowser1_BrowseCallback(object sender, Syncfusion.Windows.Forms.FolderBrowserCallbackEventArgs e) + { + this.label1.Text = String.Format("Event: {0}, Path: {1}", e.FolderBrowserMessage, e.Path); + + if (e.FolderBrowserMessage == FolderBrowserMessage.ValidateFailed) + { + e.Dismiss = e.Path != "NONE"; + } + } + + + + + Occurs when an event within the folder browser dialog triggers a call to the validation callback. + + + + + + + + Gets or sets the options for the folder browser dialog. + + A value. + + + + Retrieves the location of the selected folder. + + A String value. + + + + Gets or sets the start location for the folder browser dialog. + + + The StartLocation property is the functional equivalent of the Win32 PIDLs. + + A value. + + + + Gets or sets custom start location for showing dialog. + + + + + Gets or sets selected location for showing dialog. + + + + + Gets or sets the text displayed above the tree control in the folder browser dialog. + + A String value. + + + + Overloaded. Creates a new instance of the component. + + + + + Creates a new instance of the and initializes it with the container. + + An object implementing IContainer that will host this instance + of the FolderBrowser component. + + + + Validates the procedure. + + + + + + + + + + Raises the event. + + A value that contains the event data. + + + + Overloaded. Displays the folder browser dialog with a default owner. + + DialogResult.OK if the user clicks OK in the folder dialog; DialogResult.Cancel otherwise. + + + + Displays the folder browser dialog with the specified owner. + + A top-level window that will serve as the owner for the dialog. + DialogResult.OK if the user clicks OK in the folder dialog; DialogResult.Cancel otherwise. + + + + Defines constants used by the component. + + + The FolderBrowserMessage enumeration specifies constants that define the event that + triggered the event to occur. + + + + + Indicates that the browse dialog box has finished initializing. + + + + + Indicates that the selection has changed. + + + + + Indicates that the user typed an invalid name into the edit box. + + + + + Handles the component's event. + + The source of the event. + A value that contains the event data. + + + + Specifies constants that defines the folderbrowser dialog state. + + + Enumeration used for setting the folderbrowser dialog's state from the event handler. + For detailed information on the folder browser callback function, refer to the Platform SDK + documentation on the BrowseCallbackProc function. + + + + + Default State. + + + + + Enables the OK button. + + + + + Disables the OK button. + + + + + Specifies a path to expand in the Browse dialog box. The path can be set through the + FolderBrowserCallbackEventArgs.BrowseCallbackText property. + + + + + Sets the text to be displayed on the OK button. The text can be set through the + FolderBrowserCallbackEventArgs.BrowseCallbackText property. + + + + + Selects the specified folder. The folder's path can be set through the + FolderBrowserCallbackEventArgs.BrowseCallbackText property. + + + + + Sets the text to be displayed on the OK button. The text can be set through the + FolderBrowserCallbackEventArgs.BrowseCallbackText property. This state is inapplicable + with the new dialog style. + + + + + FolderBrowser Designer + + + + + Designer ActionList collection + + + + + Initializes a new instance of the CheckBoxAdvDesigner class + + + + + Gets a value indication the designer action + + + + + Provides data for the component's FolderBrowserCallback event. + + + The event occurs when an event within the folder browser dialog + triggers a call to the validation callback. Handling this event allows you to implement the + functional equivalent of the BrowseCallbackProc application-defined callback function. + The FolderBrowserCallbackEventArgs properties provide information specific to the event. + + + + + Initializes a new instance of the class. + + A NativeWindow value that represents the window handle of the folderbrowser dialog. + A value that identifies the event. + A String value that specifies the valid / invalid folder name. + + + + Returns the window handle of the browse dialog box. + + A NativeWindow value. + + + + Returns the valid / invalid folder name. + + A String value. + + + + Returns a value identifying the event. + + A value. + + + + Indicates whether the dialog is either dismissed or retained depending on this value. + + + + + Gets / sets the folder browser dialog's state. + + A value. + + + + Gets / sets the contextual string depending upon the value of the property. + + A String value. + + + + Specifies constants that define the location of the root folder in the folder browser dialog. + + + The FolderBrowserFolder enumeration specifies the location of the root folder from which + the component will start browsing. Only the specified folder + and folders beneath it in the namespace hierarchy will appear in the dialog. This + enumerator provides a simple way to set the ITEMIDLIST structure (PIDL) for the folder + browser dialog. For more information on the functional significance of these values + please refer to the Platform SDK documentation on the Shell API and the CSIDL Values. + + + + + Windows desktop virtual folder that is the root of the name space. + + + + + Virtual folder that represents the Internet. + + + + + File system directory that contains the user's program groups. + + + + + Virtual folder that contains icons for Control Panel applications. + + + + + Virtual folder that contains installed printers. + + + + + File system directory that serves as a common repository for documents. + + + + + File system directory that serves as a common repository for the user's favorite items. + + + + + File system directory that corresponds to the user's Startup program group. + + + + + File system directory that contains the user's most recently used documents. + + + + + File system directory that contains Send To menu items. + + + + + Virtual folder that contains the objects in the user's Recycle Bin. + + + + + File system directory that contains Start Menu items. + + + + + Virtual folder that contains the objects in the user's My Documents folder. + + + + + File system directory that serves as a common repository for music files. + + + + + File system directory that serves as a common repository for video files. + + + + + File system directory used to physically store file objects on the desktop. + + + + + My Computer virtual folder that contains everything on the local computer: storage devices, printers and Control Panel. + + + + + Network Neighborhood virtual folder that represents the root of the network namespace hierarchy. + + + + + A file system folder that contains the link objects that can exist in the My Network Places virtual folder. + + + + + Virtual folder that contains fonts. + + + + + File system directory that serves as a common repository for document templates. + + + + + My Pictures folder. + + + + + Program files folder + + + + + File system directory that contains documents that are common to all users. + + + + + File system directory that contains administrative tools for all users. + + + + + File system directory used to store administrative tools for an individual user. + + + + + Virtual folder that contains network and dial-up connections. + + + + + My Music folder for all users. + + + + + My Pictures folder for all users. + + + + + My Video folder for all users. + + + + + System resource directory. + + + + + Localized resource directory. + + + + + Folder containing links to OEM specific applications for all users. + + + + + File system folder used to hold data for burning to a CD. + + + + + Computers Near Me folder. + + + + + Use custom start folder (). + + + + + Combine this flag with the desired CSIDL_ value to indicate per-user initialization. + + + + + Combine this flag with the desired CSIDL_ value to force a non-alias version of the PIDL. + + + + + Combine this flag with the desired CSIDL_ value to return an unverified folder path. + + + + + Combine this flag with the desired CSIDL_ value to force the creation of the associated folder. + + + + + Mask for all possible CSIDL flag values. + + + + + Specifies constants that define the styles for the folder browser dialog. + + + The enumeration specifies the options for the folder browser dialog. + For more detailed information, refer to the Platform SDK documentation on the + Win32 BROWSEINFO structure. + This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values. + + + + + Restricts selection to file system directories. + + + + + Excludes network folders below the domain level. + + + + + Includes a status area in the dialog box. The status text can be specified in the FolderBrowserCallback event handler. + This style does not apply to the new style dialog. + + + + + Returns only file system ancestors. + + + + + Displays a textbox control in the folder browser dialog. + + + + + Typing an invalid name in the textbox will trigger the FolderBrowser's FolderBrowserCallback event. + + + + + Uses the new resizable folder selection dialog. + + + + + Adds a usage hint to the folder dialog. Valid only with the NewDialogStyle flag. + + + + + Displays URLs. The NewDialogStyle and BrowseForEverything values must be set along + with this flag. + + + + + Displays only computers. + + + + + Displays only printers. + + + + + Displays files as well as folders. + + + + + Displays shareable resources existing on remote systems. + + + + + Displays administrative shares existing on remote systems. + + + + + Implements a list box that can be displayed in a drop-down window for + a combo box or dropdown menus. It lets you select items and scroll the + listbox without setting the focus to the listbox. + + + + + Initializes a new control. + + + + + Handles the event of an internal + timer that is started when the user has pressed the mouse down. + + The source of the event.> + The with event data. + + + + + + + + + + + + + + + + Sends WM_SETREDRAW message to the window. + + + + + + Implements the list box that can be displayed in a drop-down window for + a combo box. Handles autoscrolling and resize to fit contents. + + + + + Initializes a new control. + + + + + Handles the event of an internal + timer that is started when the user has pressed the mouse down. + + The source of the event.> + The with event data. + + + + + + + Overloaded. Calculates optimal width for this list box based on current items. + + The width in pixels large enough so that no item text needs to be clipped. + + + + Calculates optimal width for this list box based on current items using a + provided object. + + The width in pixels large enough so that no item text needs to be clipped. + + + + + + + + + + + + + + + + Gets / sets the preferred number of visible rows. + + + + + + + + ICancelModeProvider provides an interface for the CancelMode event. + + + + + Occurs when the window receives a WM_CANCELMODE message. + + + WM_CANCELMODE is sent to cancel certain modes, such as mouse capture. + For example, the system sends this message to the active window when a + dialog box or message box is displayed. Certain functions also send this + message explicitly to the specified window regardless of whether it is the + active window. For example, the EnableWindow function sends this message + when disabling the specified window. + + + + + IMouseController defines the interface for mouse controllers to be used with MouseControllerDispatcher. + + + Any mouse controller needs to implement the IMouseController interface. + In its implementation of MouseController.HitTest, the mouse controller should determine whether your + controller wants to handle the mouse events based current context. + See MouseControllerDispatcher for further discussion. + + + + + Returns the name of this mouse controller. + + + + + Returns the cursor to be displayed. + + + + + MouseHoverEnter is called when this controller signaled in HitTest that it wants to handle mouse events. MouseHoverEnter + is called before the MouseHover is called for the first time. + + + + + MouseHover is called when this controller signaled in HitTest that it wants to handle mouse events. MouseHover + is called after MouseHoverEnter. + + + + + MouseHoverLeave is called when hovering ends either because user dragged mouse out of the hit-test area or + when context changes (e.g. user pressed the mouse button). + + + + + MouseDown is called when this controller signaled in HitTest that it wants to handle mouse events and the + user pressed the mouse button. + + + MouseDown is called and this controller will become the active controller and receive all subsequent mouse messages + until the mouse button is released or the mouse operation is cancelled. + + + + + + MouseMove is called for the active controller after a MouseDown message when the user moves the mouse pointer. + + + + + + MouseUp is called for the active controller after a MouseDown message when the user releases the mouse button. + + + + + + CancelMode is called for the active controller after a MouseDown message when the mouse operation is cancelled. + + + + + HitTest is called to determine whether your controller wants to handle the mouse events based current context. + + + The current winner of the vote is specified through the controller parameter. Your implementation of HitTest + can decide if it wants to override the existing vote or leave it. + + + + + + + + Defines an interface for classes that support a BeginUpdate / EndUpdate pattern. + + + + + Suspends updating the component. An internal counter will be increased if called multiple times. + + + + + Resumes updating the component. If was called multiple times, an internal counter is decreased. + + + + + Indicates whether was called. + + + + + The IContextMenuProvider interface provides Essential Studio controls with a high-level API for creating and + working with context menus. Subscribing to this interface allows the Essential Studio controls to + seamlessly switch between the standard .NET and the + classes depending on whether the + Essential Tools library is available or not. + + + + + + + + Creates a new instance of the context menu object managed by this provider. + + + If the provider contains a previously initialized context menu, then the existing menu will be disposed + before creating the new menu. + + + + + Gets the Menu items count. + + + + + + Indicates whether "Add or Remove buttons" is needed. + + + + + + Sets the visual style for the context menu. + + A value. + + + + Creates a new top-level menu item. + + A value representing the menu item. + The that will handle the menu item Click event. + + + + Creates a new menu item and adds it to the specified parent menu item. + + A value representing the parent menu item. + A value representing the menu item. + The that will handle the menu item Click event. + + + + Sets the menu item image. + + A value representing the menu item. + The containing the image. + The zero-based image index. + + + + Sets a shortcut key for the menu item. + + A value representing the menu item. + The key for the menu item. + + + + Returns the menu item's shortcut key. + + A value representing the menu item. + A key value. + + + + Sets the menu item's Checked property to the specified value. + + A value representing the menu item. + The boolean value to be set. + + + + Gets the menu item's Checked property. + + A value representing the menu item. + A boolean value. + + + + Sets the menu item's Enabled property to the specified value. + + A value representing the menu item. + The boolean value to be set. + + + + Indicates the state of the menu item's Enabled property. + + A value representing the menu item. + A boolean value. + + + + Inserts or removes a separator before the specified menu item's position. + + A value representing the menu item. + True to insert a new separator; False to remove an existing separator. + + + + Removes the specified context menu item. + + A value representing the menu item. + + + + Displays the context menu at the specified position. + + A object that specifies the control with which this context menu is associated. + A object that specifies the coordinates at which to display the menu. + + + + Disposes the context menu associated with this provider. + + + + + Clears all menu items. + + + + + Occurs when menu is popped up. + + + + + Occurs when menu is collapsed. + + + + + The ContextMenuItem class is used by the Essential Studio menu providers - classes implementing the + interface - for providing information to the context menu + command handler about the menu item that triggered the Click event. + + + + + + + Returns the menu provider instance. + + A instance. + + + + Returns the text representing the context menu item. + + A value. + + + + Creates an instance of the class. + + A instance representing the menu provider. + A value representing the context menu item. + + + + Factory class for creating the context menu provider. If the Syncfusion Essential Tools library is present, the MenuProviderFactory will + create an instance of the type and if not it returns an instance of + the class. + + + + + + Creates the standard or XPMenus context menu provider. + + A instance. + + + + The StandardMenusProvider class implements the interface and + serves as the menu provider for the standard .NET context menus. Controls that have a + object set as their menu provider will display a instance. + + + + + + + Gets context menu instance. + + + + + Creates an instance of the class. + + + + + Gets the ContextMenu items Count. + + + + + + Indicates whether "Add or Remove buttons" is needed. + + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Overridden. See . + + + + + Clears all menu items. + + + + + Occurs when menu is popped up. + + + + + Occurs when menu is collapsed. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + MouseControllerDispatcher coordinates mouse events among competing mouse controllers. Based on + the position of the mouse and context of the control every registered controller's HitTest method + is called to determine the best controller for the following mouse action. This controller will then + receive mouse events. + + + Any Mouse Controller needs to implement the IMouseController interface. + In its implementation of MouseController.HitTest, the mouse controller should determine whether your + controller wants to handle the mouse events based current context. + MouseControllerDispatcher will call HitTest for each Mouse Controller that has been registered with + Add(IMouseController). The Mouse Controller that wins the vote will receive all Mouse hovering events + like MouseHoverEnter, MouseHover and MouseHoverLeave as long as its HitTest method indicates that it wants to + handle the mouse event. A MouseHoverLeave notification is guaranteed after MouseHoverEnter has been called. + When the user presses the mouse, a MouseDown will be sent to the controller. All subsequent mouse events + will then go to that specific controller until the user releases the mouse or the mouse operations is cancelled. + A call to either MouseUp or CancelMode is guaranteed after a controller MouseDown method was called. + Mouse controllers are registered by calling the Add method. + If the control that MouseControllerDispatcher should be associated with is derived from ScrollControl, + you should use ScrollControllMouseControllerDispatcher because it will automatically hook itself up + with mouse events from ScrollControl. + Otherwise if you want to attach MouseControllerDispatcher to a different type of Control, you need to + delegate mouse events to MouseControllerDispatcher. MouseControllerDispatcher provides ProcessXYZ methods + for every mouse event that should be forwarded. Simply call these methods from your mouse event handlers in + your control. + + + + + Indicates that the active controller has changed. + + + Active controller is the controller that is receiving MouseDown, MouseMove and MouseUp messages when the user + has pressed a mouse button. + + + + Initializes a new MouseControllerDispatcher object and associates it with the parent control. + + + + + + Resets the dispatcher and calls Dispose for any registered mouse controller and unregisters all mouse controllers. + + + + + + Registers a mouse controller. + + + + + + Removes a mouse controller. + + + + + + Indicates whether a mouse controller has previously been registered. + + + + + + + Search a mouse controller by comparing with the name returned from IMouseController.Name. + + + + + + + Returns a reference to the active mouse controller that is receiving MouseDown, MouseMove and MouseUp messages when the user + has pressed a mouse button. + + + + + Changes the active controller and raises an ActiveControllerChanged event. + + + + + + Returns the controller that currently receives mouse hovering messages. + + + + + Sets the controller that will receive mouse hovering messages. If the controller is changed, + MouseHoverLeave and MouseHoverEnter calls are made. + + + + + + + Raises the event. + + A that contains the event data. + + + + HitTest loops through all controllers and calls HitTest on each of them. Only one mouse controller + can get voted to receive mouse messages. + + + HitTest loops through all controllers and call HitTest on each of them. Only one mouse controller + can get voted to receive mouse messages. + + The point in client coordinates to be hit tested. + The result identifying the hit-test context. + + The current result of the vote gets passed to the next mouse controller. If a controller wants + to handle mouse events, it can decide based on the existing vote if it has higher priority for it + to handle mouse messages than the existing vote. + + + + + HitTest loops through all controllers and call HitTest on each of them. Only one mouse controller + can get voted to receive mouse messages. + + The point in client coordinates to be hit tested. + The mouse button that is pressed. + The result identifying the hit-test context. + + + + + HitTest loops through all controllers and call HitTest on each of them. Only one mouse controller + can get voted to receive mouse messages. + + The point in client coordinates to be hit tested. + The mouse button that is pressed. + A placeholder where a reference to the winning + is returned. + The result identifying the hit-test context. + + + + + Returns the last HitTest value returned that was non-zero. Check this property + if you need to make decision on your mouse controller's HitTest. + + + + + HitTest loops through all controllers and call HitTest on each of them. Only one mouse controller + can get voted to receive mouse messages. + + The point in client coordinates to be hit tested. + The mouse button that is pressed. + 1 for single-click; 2 for double click. + A placeholder where a reference to the winning + is returned. + The result identifying the hit-test context. + + + + + Property AllowDoubleClickTimer (bool). + + + + + Call this method from your control's MouseMove handler. + + + + + + Returns the cursor to be displayed. + + + + + Call this method from your control MouseDown handler. + + + + + + Call this method from your control's MouseUp handler. + + + + + + Call this method from your control's CancelMode handler. + + + + + Returns a reference to the associated control. + + + + + + + + Enables support for mouse tracking. + + + Specify the bounds where the mouse tracking should start. As soon as the user moves the mouse + over the specified region, MouseControllerDispatcher will simulate a mouse down event. When the user presses + any mouse button MouseControllerDispatcher will simulate a mouse up and resets the mouse tracking mode. After + the initial click on a mouse button, mouse processing will work as usual. + Mouse tracking lets you easily simulate the behavior of windows combo boxes. + + This example enables Mouse Tracking after the drop-down has been shown. + + public override void DropDownContainerShowedDropDown(object sender, EventArgs e) + { + this.ListControlPart.grid.MouseControllerDispatcher.TrackMouse = + this.ListControlPart.grid.RangeInfoToRectangle(GridRangeInfo.Rows( + this.ListControlPart.grid.TopRowIndex, + this.ListControlPart.grid.RowCount)); + } + + + + + + Resets support for mouse tracking. + + Call this method after a user interaction that should switch the control back into + normal mouse behavior. For example, when the control gets the focus or when the user clicks a scrollbar. + + + + + Indicates that the value of the TrackMouse property has changed. + + + + + Raises the event. + + A that contains the event data. + + + + ScrollControllMouseControllerDispatcher is a specialized version of MouseControllerDispatcher + that automatically wires itself up with a ScrollControl. + + + If the control that MouseControllerDispatcher should be associated with is derived from ScrollControl, + you should use ScrollControllMouseControllerDispatcher because it will automatically hook itself up + with mouse events from ScrollControl. + No initialization is necessary. + You can register MouseControllers with: + + resizeCellsController = new GridResizeCellsMouseController(this); + MouseControllerDispatcher.Add(resizeCellsController); + + See ScrollControl.MouseControllerDispatcher property. + + + + + Initializes a object and associates it with a . + + The this object is associated with. + + + + + + + Provides designer-like context menu support for the PropertyGrid during run-time. + + +

This derived menu has a "Reset" menu item, which automatically + provides the property-resetting service with the ContextMenu of + a during run-time. It also + includes a "Description" menu item to let you show / hide the description portion of the property grid. + Just as in the VS.NET property grid.

+

+ To use this component, just create it passing the PropertyGrid in the constructor. + The context menu will then start appearing for that PropertyGrid. There is no + design-time support for this component. +

+ + + + + Creates a new instance of the PropertyGridContextMenu. + + The to which + this will be made a context menu. + + + + + + + + + + + + + Sets / resets the specified styles on the control. + + The control on which to set / reset the styles. + The style to set / reset. + Indicates whether to set / reset the style. True to set, False to reset. + This method uses reflection to call the protected SetStyle + method on the specified control. + + + + Makes the specified control and all its parent controls the ActiveControl of its parent container. + + The control that needs to be made the ActiveControl of its parent. + + + + Returns the first PropertyGrid encountered in the container control's controls collection. Will recur. + + The instance to a ContainerControl. + A PropertyGrid instance, if found; NULL otherwise. + + + + Updates the designer generated datasource full path to a different one based + on the provided info. + + The Connection object whose ConnectionString will be updated. + The directory name that will be sought after up in the exe's hierarchy (typically the "Data" dir). + A file in the above directory (typically an .mdb file). + + The designer generated path to the "Data" directory could have been changed if the user + installed the product to a non-default directory. + This routine will parse up the dir hierarchy from the exe file and try to find + the "Data" dir and use it instead. + + + + + Finds a file of the given name in the current directory or sibling "Data" directory. + If file is not found, the parent folder is checked until the file is found. This method + is used by our samples when they load data from a separate "Data" folder. + + The name of the "Data" folder. + The filename to be searched. + The full path of the file that was found; an empty string is returned if file is not found. + + + + Returns the preferred size to be used for an empty cell. + + The context of the canvas. + The to be used. + The of the string "Wg;". + + + + Gets / sets the string used when doing a resize to fit for cells with empty text. + + + + + Defines a mechanism for letting others know that you let others cancel your operation. + + + The class relies on this interface. + + + + + To let you know that any current operation should be cancelled. + + + + + A listener class that will listen to and notify Escape key press. + + + As soon as you create this class, it starts listening for the Esc key press using Application.AddMessageFilter. + As soon as it encounters the Escape key, it notifies the source (ICanCancel implementor) and + stops listening to further Escape presses. The Release method will make it stop listening at any point. + + + + + Creates a new instance of the CancelListener class. + + The instance that will be notified on Escape key press. + + + + Makes this instance stop listening for Escape key press. + + + + + + + + + + + Wrapper class for setting the current 's . + + + + + Event raised when the ThreadCulture is changed or the system settings + changed the culture. + + + + + Handles the CultureChanged event raised by the settings form. + + The settings form. + The event data. + + + + Sets the current thread's CurrentCulture. + + The culture to be set. + + + + Raises the CultureChanged event. + + The previous culture's LCID. + The new culture's LCID. + + + + Raises the event. + + Object raising the event. + The event data. + + + + The form used for listening to the WM_SETTINGCHANGE messages. + + + + + Static constructor for ThreadCultureSystem class. + + + + + Form derived class that is registered to receive WM_SETTINGCHANGE messages. + + + + + Event raised when the form senses that the culture has been changed. + + + + + Overrides to handle the WM_SETTINGCHANGE + message. + + The message. + + + + Overrides to always set the location to be + outside the screen bounds. + + + + + Raises the event. + + The event data. + + + + Handles the locale changed event. + + + + + Provides data for the event. + + + + + Returns the LCID of the new culture that has been applied. + + + + + Returns the LCID of the previous culture. + + + + + Returns the reason for the CultureChange. + + + + + CultureChangedReason is used by the to denote + what action initiated the culture change. + + + + + A System level setting change resulted in the culture change. + + + + + Thread level culture change resulted in the culture change. + + + + + Specifies information about the originating action of SheetMoved event. + + + + + None specified. + + + + + Sheet was moved. + + + + + Sheet was inserted. + + + + + Sheet was removed. + + + + + All sheets were removed. + + + + + Handles a event of a . + + + + + Provides data about a event of a . + + + + + Initializes a SheetMovedEventArgs with event data. + + The sheet index. + The destination sheet index. + The originating action for this event. + + + + Returns the sheet index. + + + + + Returns the destination sheet index. + + + + + Returns the originating action for this event. + + + + + Handles a and events of a . + + + + + Provides data about a and events of a . + + + + + Initializes a new with event data. + + The selected index. + The tab associated with the index. + + + + Returns the selected index. + + + + + Returns the tab associated with the index. + + + + + An interface for hosting objects and + receiving clicks from these buttons. + + + + + Returns Graphics object, font and delta between tabs. + + Graphics object. + Font. + Delta between tabs. + + + + Returns , brush, text color, font and delta between tabs. + + Tab object. + Brush for drawing the tab background. + Text color. + Font used to draw text. + Delta between tabs. + + + + Disposes any temporary drawing object. + + + + + Returns the image list that these tabs get images from. + + + + + Indicates the visual style of the tabBar. + + + + + Indicates the visual style of the tabBar. + + + + + InternalTab draws tabs inside a in a . + + + + + Renderer used to draw the tab. + + + + + Initializes a new . + + + Initializes a new . + + + + + Gets or sets the visibility of the control. + + + + + Gets or sets the visibility of the control. + + + + + Initializes a new with a label. + + The label to display in the tab. + + + + Initializes a new with a cookie. + + The cookie associated with this tab. + + + + Initializes a new with a cookie and a label. + + The cookie associated with this tab. + The owner of this tab. + + + + + + + + + + Gets / sets the label to display in the tab. + + + + + Gets / sets the index of the image to display in this tab. + + + + + Gets the region that contains the tab bounds. + + + + + Gets the renderer that renders the tab. + + + + + + + + Recalculates the best size for the button and resizes it. + + + Recalculates the best size for the button and resizes it. + + Graphics object. + Font. + Delta between tabs. + + + + + + + Creates and initializes a bitmap for this tab. + + The size of the bitmap. + Indicates the flat look status. + The bitmap where the button is drawn into. + + When you drag a tab, this function is called to create the dragging button image. + + + + + + + + An interface for hosting objects. + + + + + Indicates whether the specified tab is being dragged. + + The tab index. + Current target. + True if tab can be dropped; False otherwise. + + + + Indicates that a tab has been dragged. + + The tab index. + Current target + + + + Indicates whether the scroll button has been pressed. + + Indicates which type of arrow button. + The number of pixels to scroll. + True if scrolled; False otherwise. + + + + Scrolling finished. + + + + + Gets / sets the cursor to display. + + + + + Provides data about a or events of a . + + + + + Initializes a . + + The original tab index. + The destination tab index. + + + + Gets / sets the original tab index. + + + + + Gets / sets the destination tab index. + + + + + Class to Draw the AddNewPage rectangle in TabBar + + + + + Gets/Sets the Hover color for AddButton. + + + + + Resets the PlusHoverColor + + + + + ShouldSerialize the AddButtonHoverColor. + + + + + + To Draw Add symbol in TabBarPage. + + + + + + + Draws the AddNewSymbol in VisualStyle based theme. + + + + + Handles the or events of an + + + + + Specifies scroll behavior for a tab bar. + + + + + Scroll pixels. + + + + + Scroll tabs. + + + + + Helper class for . Manages items. + + + + + Occurs when a tab has been moved. + + + + + Occurs before a tab is moved. + + + + + Holds the MouseHover value + + + + To check whether the tab is double clicked. + + + + To draw the Plus symbol near the Tab Bounds + + + + + To Get the bounds of the AddNewPage button. + + + + + Initializes an and attaches it to a control. + + The parent control. + + + + + + + Called from parent control to draw this bar. + + A Graphics object. + The delta in pixels between tabs. + + + + Called when a button is clicked. + + The that was clicked. + + Called by OnMouseDownEvent. + + + + + + + + + + + + + + + + + Checks if mouse is over a button and returns the zero-based button index or -1. + + X-coordinate of mouse pointer. + Y-coordinate of mouse pointer. + Zero-based button index; -1 if not over a button. + + + + + + + Repaints only if marked dirty. + + + + + Returns the index for the specified button. + + The button to search. + + + + Returns the index for a button with the specified cookie. + + The cookie to search for. + + + + Cancels current action. + + + + + + + + + + + Indicates whether a button is currently pressed. + + + + + + + + + + + + + + Scrolls a specified tab into view. + + + Scrolls a specified tab into view. + + The tab that should be made visible. + + + + Scrolls a specified tab into view. + + The index of the tab that should be made visible. + + + + Returns a value that indicates which buttons to show enabled. Other buttons are disabled. + + + + + + + + + + + Scrolls the tabs in the specified direction. + + + Scrolls the tabs in the specified direction. + + The direction to scroll. + + + + Overloaded. Scrolls the tabs in the specified direction with the specified number of pixels. + + The direction to scroll. + The pixels to scroll. + + + + Scrolls the tabs in the specified direction with the number of pixels. + + The direction to scroll. + The pixels to scroll. + Indicates whether scrolling should abort when last button is visible and you scroll further. + + + + Gets / sets the button list. + + + + + Gets / sets the boundaries of this bar. + + + + + Indicates the flat look status for buttons. + + + + + Initializes ToolTips boundaries. + + + + + Reinitializes and hides ToolTips. + + + + + Indicates whether any button is dirty or sets all buttons dirty. + + + + + Indicates whether any button is enabled or sets all buttons enabled / disabled. + + + + + Indicates whether any button is in hovered state. + + + + + Resets hovered state for all buttons. + + + + + Indicates whether any button is in pushed state. + + + + + Resets pushed state for all buttons. + + + + + Indicates whether any button is in checked state. + + + + + Resets checked state for all buttons. + + + + + Indicates whether any button is in DragTarget state or sets DragTarget state for the specified index. + + + + + Resets DragTarget state for all buttons. + + + + + Gets / sets the scroll behavior of this tab bar: pixel or tabs. + + + + + Gets / sets the current tab. + + + + + Refreshes the current tab and optionally scrolls it into view. + + True if current tab should be scrolled into view. + + + + Gets / sets the total logical width of this button bar including all buttons. If the logical + width is greater than the actual width, the tab bar lets the user scroll it. + + + + + Gets / sets the current scroll position. + + + + + Indicates whether the user is in the process of dragging a tab. + + + + + A collection OF items. + + + + + Initializes a and associates it with an owner. + + The owner. + + + + Adds an array of InternalTab into the list. + + An InternalTab array. + Available to enable serialization using AddRange in designer. + + + + Gets / sets the at the specified index. + + + + + Adds an to the list. + + The to be added. + The index of the added value. + + + + Inserts an at the specified index. + + The to be added. + The index of the added value. + + + + Returns the index of the specific tab. + + The tab to search for. + The index of the tab; -1 if not found. + + + + Indicates whether the specified object is a member of this collection. + + The object to search for. + True if is a member; False otherwise. + + + + Removes an from the collection. + + The to be removed. + + + + Copies the collection objects to a one-dimensional instance beginning at the + specified index. + + + Copies the collection objects to a one-dimensional instance beginning at the + specified index. + + + The one-dimensional that is the destination of the values copied from the collection. + + The index of the array at which to begin inserting. + + + + Copies the collection objects to a one-dimensional instance beginning at the + specified index. + + + The one-dimensional that is the destination of the values copied from the collection. + + The index of the array at which to begin inserting. + + + + + + Gets metro highight color + + + + + Gets or sets metrohighlight color + + + + + Gets metronormal color. + + + + + Gets or sets metro normal color. + + + + + + + + + Office2016Colorful Renderer + + + + + Holds the Visualstyle + + + + + Constructor + + + + + + + + Gets highight color + + + + + Gets or sets highlight color + + + + + Gets normal color. + + + + + Gets or sets normal color. + + + + + + Gets the color of PushedTabBackColor + + + + + + Gets the color of NormalTabBackColor + + + + + + Gets the border color of PushedTab + + + + + + Gets the bottom line color of PushedTab + + + + + + Gets the border color of PushedTab + + + + + + Gets the SeparatorLine Color + + + + + + Gets the Background Color + + + + + + Gets the ThumbNormal Color + + + + + + Gets the ThumbHoverColor + + + + + + Gets the ThumbPushedColor + + + + + + Gets the ThumbNormal Border Color + + + + + + Gets the Scrollers Background Color + + + + + + Gets the Arrow Color + + + + + + Gets the NormalTabFore Color + + + + + + Gets the HoverTabFore Color + + + + + + Gets the PushedTabFore Color + + + + + + Gets the InternalArrow Color + + + + + + Gets the InternalArrow HoverColor + + + + + + Gets the InternalArrowHover BackColor + + + + + + Gets the AddTabButtonColor + + + + + + Gets the AddTabButtonHoverColor + + + + + + Gets the DottedIconColor + + + + + Override + + + + + + + Override + + + + + + + + + Static method has VisualStyles + + + + + + + Gets the correcsponding render for Office2016 themes. + + + + + Office2016WhiteTabsRenderer + + + + + Constructor + + + + + + + + Gets normal color. + + + + + Gets or sets normal color. + + + + + + Gets the color of PushedTabBackColor + + + + + + Gets the color of NormalTabBackColor + + + + + + Gets the border color of PushedTab + + + + + + Gets the bottom line color of PushedTab + + + + + + Gets the border color of PushedTab + + + + + + Gets the SeparatorLine Color + + + + + + Gets the Background Color + + + + + + Gets the ThumbNormal Color + + + + + + Gets the ThumbHoverColor + + + + + + Gets the ThumbPushedColor + + + + + + Gets the ThumbNormal Border Color + + + + + + Gets the Scrollers Background Color + + + + + + Gets the Arrow Color + + + + + + Gets the NormalTabFore Color + + + + + + Gets the HoverTabFore Color + + + + + + Gets the PushedTabFore Color + + + + + + Gets the InternalArrow Color + + + + + + Gets the InternalArrow HoverColor + + + + + + Gets the InternalArrowHover BackColor + + + + + + Gets the AddTabButtonColor + + + + + + Gets the AddTabButtonHoverColor + + + + + + Gets the DottedIconColor + + + + + Office2016DarkGrayTabsRenderer + + + + + Contructor + + + + + + + + Gets normal color. + + + + + Gets or sets normal color. + + + + + + Gets the color of PushedTabBackColor + + + + + + Gets the color of NormalTabBackColor + + + + + + Gets the border color of PushedTab + + + + + + Gets the bottom line color of PushedTab + + + + + + Gets the border color of PushedTab + + + + + + Gets the SeparatorLine Color + + + + + + Gets the Background Color + + + + + + Gets the ThumbNormal Color + + + + + + Gets the ThumbHoverColor + + + + + + Gets the ThumbPushedColor + + + + + + Gets the ThumbNormal Border Color + + + + + + Gets the Scrollers Background Color + + + + + + Gets the Arrow Color + + + + + + Gets the NormalTabFore Color + + + + + + Gets the HoverTabFore Color + + + + + + Gets the PushedTabFore Color + + + + + + Gets the InternalArrow Color + + + + + + Gets the InternalArrow HoverColor + + + + + + Gets the InternalArrowHover BackColor + + + + + + Gets the AddTabButtonColor + + + + + + Gets the AddTabButtonHoverColor + + + + + + Gets the DottedIconColor + + + + + Office2016DarkGrayTabsRenderer + + + + + Constructor + + + + + + + + Gets normal color. + + + + + Gets or sets normal color. + + + + + + Gets the color of PushedTabBackColor + + + + + + Gets the color of NormalTabBackColor + + + + + + Gets the border color of PushedTab + + + + + + Gets the bottom line color of PushedTab + + + + + + Gets the border color of PushedTab + + + + + + Gets the SeparatorLine Color + + + + + + Gets the Background Color + + + + + + Gets the ThumbNormal Color + + + + + + Gets the ThumbHoverColor + + + + + + Gets the ThumbPushedColor + + + + + + Gets the ThumbNormal Border Color + + + + + + Gets the Scrollers Background Color + + + + + + Gets the Arrow Color + + + + + + Gets the NormalTabFore Color + + + + + + Gets the HoverTabFore Color + + + + + + Gets the PushedTabFore Color + + + + + + Gets the InternalArrow Color + + + + + + Gets the InternalArrow HoverColor + + + + + + Gets the InternalArrowHover BackColor + + + + + + Gets the AddTabButtonColor + + + + + + Gets the AddTabButtonHoverColor + + + + + + Gets the DottedIconColor + + + + + Blend used to draw the tab. + + + + + Blend used to draw the tab. + + + + + Blend used to draw the tab. + + + + + + + + + + + + A control for creating Tabbed Dialogs or Excel workbook type + windows. This control provides a row of tabs that the + user can select from one at a time. After each selection, a notification + is provided that allows for changing of UI. + The tab bar can share the row with an associated scrollbar. The + user can adjust the width of the tab bar and increase the scrollbar's + size by dragging a splitter found in the middle of the row. + + + + + Default size of the control + + + + + Indicates whether TabBar is mouse pointed or not + + + + + Specifies AddNewPageButton Image rendering bound + + + + + Holds the TabBarSplitter Visualastyle + + + + + Occurs after the selected tab index has changed. + + + + + Creates the ToolTip. + + + + + Creates the text box during edit + + + + + Occurs before the selected tab index is changing. + + + + + + + + + + + Specifies office 2007 color scheme. + + + + + Style of the control. + + + + + Color table for Office2007 visual style. + + + + + To get the Bounds of the AddNewButton. + + + + + Initializes a new . + + + Initializes a new . + + + + + Initializes a new with a scrollbar. + + The scrollbar to be displayed to the right of the tab bar. + + + + Indicates whether edit custom control lost its focus. + + + + + Gets or sets value to enable or disable the Touchmode to the controls. + + Scale factor will be updated automatically if scalefactor is equal to 1 + + + + + + + Scale the control based on the scale factor passed in the argument. + + value to scale the factor based upon. + + + + + + + + Class to derive the TextBox to Edit + + + + + Assign the text to the TabBar + + + + + Enable the edit mode in TabBarPage + + + + + To Specify EditOnTabPage to be serialized or not + + + + + Occurs when the user clicks on a tab. + + The tab that was clicked. + + Sets the . + + + + + Occurs when a tab is dragged by the user. You can set e.Cancel = True + to prevent dragging a tab. + + + + public Form1() + { + InitializeComponent(); + this.tabControl1.Bar.DraggingTab += new TabMovedEventHandler(Bar_DraggingTab); + } + private void Bar_DraggingTab(object sender, TabMovedEventArgs e) + { + Console.WriteLine("Bar_DraggingTab {0}, {1}", e.Tab, e.DestTab); + e.Cancel = true; // Do not allow dragging the tab + } + + + + + + Raises the event. + + A that contains the event data. + + + + Occurs when the users drags the splitbar. + + The source of the event. + The current horizontal position in pixels. + The current vertical position in pixels. + + + + Occurs after the user moved the splitter bar. + + The source of the event. + + + + Occurs when the property has changed. + + + + + Raises the event. + + Event data. + + + + Repaints the splitter bar. + + The source of the event. + + + + + + + Handles the WM_SETCURSOR message. + + + + + + + + + + + + + + + Gets/Sets whether to show/hide AddNewButton Image + + + + + Gets/Sets the Hover color for AddButton. + + + + + Resets the AddButtonHoverColor + + + + + ShouldSerialize the AddButtonHoverColor. + + + + + + Gets/Sets AddNewTabBarOption Image in TabBarSplitterControl + + + + + Gets/Sets TabBarPage which is being mouse pointed + + + + + + + + + + + + + + Calculates the boundaries of the tab bar (both tabs and arrows) within the current control. + + The boundaries of the tab bar. + + Will return unless overriden in derived class. + + + + + Calculates the boundaries of the tab bar child (without arrow bar) within the current control. + + The size of the tab bar. + The boundaries of the inner tab bar. + + + + Calculates the boundaries of the arrow bar within the current control. + + The boundaries of the arrow bar. + + + + + + + Creates the inner tab bar that displays the tabs. + + The for the inner tabs. + + + + + + + Gets / sets the delta used for drawing the tabs. + + + + + Gets / sets the scroll behavior of this tab bar: pixel or tabs. + + + + + Gets / sets the inner tab bar that displays the tabs. + + + + + Gets or sets a that holds an array of buttons. + + + + + Gets or sets a that holds an array of buttons. + + + + + Creates an instance of the and initializes it with the layout information. + + The initialized . + + + + + + + Gets / sets the width of the tab bar relative to the width of the client bounds. + + + + + Gets / sets the index of the currently selected tab in the strip, if there + is one. If the value is -1, there is currently no selection. If the + value is 0 or greater, then the value is the index of the currently + selected tab. + + + + + Enables / disables the resizing of tab bar. + + + + + Returns the list of tabs displayed in the tab bar. + + + + + Gets or sets the visual style of the tabBar. + + + + + Gets or sets the visual style of the tabBar. + + + + + + + + + + Gets or sets office 2007 color scheme. + + + + + Gets color table for Office2007 visual style. + + + + + + + + + + + + Finds and returns the tab that holds the specified item as cookie. + + + + + Removes the tab that holds the specified item as cookie. + + + + + + + + Removes all tabs. + + + + + Returns the imageList the control points at. This is where tabs that have imageIndex + set will get their images from. + + + An image list control. + + + + + Occurs when the has changed. + + + + + Raises the event. + + A that contains the event data. + + + + Gets / sets the cookie of the current selected tab or sets the tab with the specified cookie. + + + + + Indicates whether ToolTips are being shown for tabs that have ToolTips set on + them. + + + + + Returns the number of tabs in the strip. + + + + + + + + Raises the event. + + The new tab index. + The object for the tab. + False if cancelled; True if successful. + + + + Raises the event. + + The new tab index. + The object for the tab. + + + + + + + + Provides design-time functionality for the . + + + provides a way to add and remove + tabs at design-time, as well as tab hit testing logic at design-time. + + + + + + + + + + + + + + + + + Called when the current selection changes. Here we check to + see if the newly selected component is one of our tabs. If it + is, we make sure that the tab is the currently visible tab. + + + + + Called when the tab property changes. We just set a flag here to + indicate to the later index changed event that the change was the + result of a property change, so there is no need to update the + selection. + + + + + Called when the selected tab changes. This accesses the design + time selection service to surface the new tab as the current + selection. + + + + + Accessor method for the property on + . + + + The selected index. + + + This property is shadowed at design-time. + + + + + TabPage implements a single page of a tab bar control. It is essentially + a panel that can host other child controls. The TabBarSplitterControl will + display the text property of this control as a label in the associated tab. + + + + + Occurs when the property has changed. + + + + + Occurs when the property has changed. + + + + + Occurs when the vertical splitter position has changed. + + + + + Occurs when the horizontal splitter position has changed. + + + + + Occurs when the splitter layout has changed. + + + + + The size of the GESTURECONFIG. + + + + + The size of the GESTUREINFO. + + + + + The starting Gesture points + + + + + The ending gesture point. + + + + + Initialize the last vertical scroll value. + + + + + Initialize the last horizontal scroll value. + + + + + Handles the gesture information. + + The Messagge + + + + Back color for TabBarPage Tab. + + + + + + + + Returns the parent splitter frame. + + + + + Returns the number of visible row panes. + + + + + Holds TabBar back color + + + + + To Reset TabBarColor + + + + + Indicate whether to serialize TabBarColor + + + + + Returns the number of visible column panes. + + + + + Indicates whether we can split the rows at the given y coordinate. + + The vertical position in percentages of the splitter control's height. + True if rows were split successfully; False if they were already split or the operation aborted. + + + + Indicates whether we can split the columns horizontally at the specified x coordinate. + + The horizontal position in percentages of the splitter control's width. + True if columns were split successfully; False if they were already split or the operation aborted. + + + + Occurs after the control to be displayed in a new pane has been created. Use this + event to implement additional initialization for the new control. + + + PaneCreated is an ideal hook to add handler for events in the new control. + + + + + Raises the event. + + A that contains the event data. + + + + Occurs after a row or column is hidden and before the control that is displayed in the pane + is disposed. Use this event to implement additional clean up for the control before + is called. + + + PaneClosing is an ideal hook to unwire event handlers from the control. + + + + + Raises the event. + + A that contains the event data. + + + + Closes the specified pane. + + The zero-based index for the splitter pane row. + The zero-based index for the splitter pane column. + + + + Closes the splitter panes at the specified row. + + The zero-based index for the splitter pane row. + + + + Closes the splitter panes at the specified column. + + The zero-based index for the splitter pane column. + + + + Indicates whether the scrollbar belongs to the active pane. + + The control associated with the scrollbar. + Specifies the vertical or horizontal scrollbar. + True if active; False otherwise. + + + + + ScrollControl checks IsActive to find out if it is target of a HScroll event + + protected virtual void OnHScroll(object sender, ScrollEventArgs se) + { + try + { + IScrollBarFrame sbf = GetScrollBarFrameOfComponent(this); + if (sbf != null && !sbf.IsActive(this, ScrollBars.Horizontal)) + return; + }} + + + + + + Returns the splitter pane at the specified row and column. If there is no pane found at the + specified row and column a pane will be created on demand with a call to . + + The zero-based index for the splitter pane row. + The zero-based index for the splitter pane column. + The control at the pane. + + + + Returns the splitter pane at the specified row and column. If there is no pane found at the + specified row and column a null reference will be returned. + + The zero-based index for the splitter pane row. + The zero-based index for the splitter pane column. + The control at the pane. + + + + Returns the row and column index for a child pane. + + The control to search for. + A placeholder where the row is returned. + A placeholder where the column is returned. + True if the control is a pane; False if the control was not a child pane. + + + + Gets / sets the active pane in the splitter control. + + + + + Sets the active pane in the splitter control specified by the row and column indices. + + The zero-based index for the splitter pane row. + The zero-based index for the splitter pane column. + + + + Indicates whether there is a next or previous pane that can be activated. + + True if previous pane should be activated; False if next pane should be activated. + True if activating next or previous pane is good; False if already at last or first pane. + + + + Activates the next or previous pane. + + True if previous pane should be activated; False if next pane should be activated. + + + + Occurs when the user drags the splitterbar. + + The source of the event. + The current horizontal position in pixels. + The current vertical position in pixels. + + + + Occurs after the user has moved the splitter bar. + + The source of the event. + + + + Repaints the splitter bar. + + The source of the event. + + + + Handles the WM_SETCURSOR message. + + + + + + + + + + + + + + + + + + Initializes a new TabBarPage. + + + Constructs a TabBarPage with text for the tab. + + + The text for this tab. + + + + + Initializes a new TabBarPage. + + + + + + + + Given a component, this retrieves the tab page that it is parented to or + NULL if it is not parented to any tab page. + + + The component to check. + + + A TabBarPage that the component is parented to or NULL if + no such page exists. This will return the component if it + is an instance of TabBarPage. + + + + + + + + + + + + + + Enables / disables this page in a . + + + + + Gets or set the value indicating whether the TabBarPage is enabled or not + + + + + + + + + + + + + + + + + Gets / sets the ToolTip text for the tab that will appear when the mouse hovers + over the tab and the TabBarSplitterControl's showToolTips property is True. + + + + + Sets the Maximum width for the TabBarPage + + + + + Raises the event. + + Event data. + + + + Gets or sets the visibility of the control. + + + + + Gets or sets the visibility of the control. + + + + + Gets / sets a value indicating what split behavior is supported. Rows, columns or both. + + + + + Raises the event. + + Event data. + + + + Gets / sets the horizontal splitter position in percentages of the splitter control's width. + + + + + Raises the event. + + Event data. + + + + Gets / sets the vertical splitter position in percentages of the splitter control's height. + + + + + Raises the event. + + + + + + Gets / sets the that holds information about current vertical and horizontal split positions. + + + + + Raises the event. + + Event data. + + + + + + + Raises the ThemeChanged event. + + An EventArgs that contains the event data. + + The OnThemeChanged method also allows derived classes to handle the event + without attaching a delegate. This is the preferred technique for + handling the event in a derived class. + Note to Inheritors: When overriding OnThemeChanged in a derived + class, be sure to call the base class's OnThemeChanged method so that + registered delegates receive the event. + + + + + + + + Indicates whether themes are enabled for this control. + + + + + Fired when the ThemesEnabled property changes. + + + + + Activates a specified control. + + The being activated. + True if the control is successfully activated; False otherwise. + + The control must be a child of the container control. + + + + + + + + Indicates whether the method has been called. and resets this flag. + + + + + Indicates whether the method has been called. and resets this flag. + + + + + Indicates whether the has been called. resets this flag. + + + + + Indicates whether both has been called. resets this flag. + + + + + Indicates whether both has been called. resets this flag. + + + + + + + + + + + + + + + + + + + + + + + Occurs when both and occurs. + + + + + Raises the event. + + An that contains the event data. + + + + Indicates whether this control contains focus. If + implements , the + method is called on the . + + True if the control or any child control has focus; False otherwise. + + + + Raises the event. This method is called when the control + or any child control gets focus and this control did not have focus before. + + + Inheriting classes should override this method instead of overriding + because is also called when child controls get focus and it + is not called when focus is moved within child controls of this control. + + + + + Raises the event. This method is called when the control + or any child control loses focus and the newly focused control is not a child of this control. + + + Inheriting classed should override this method instead of overriding + because is also called when child controls lose focus and it + is not called when focus is moved within child controls of this control. + + + + + This method is called if the control's notification occurs + while handling a event. This typically occurs if a + message box is displayed from a event handler. + + + + + + + + Creates a new TabBarPageControlCollection. + + + The owner of this collection. This is the control whose child + controls we are to represent. + + + + + Adds a child control to this control. The control becomes the last control + in the child control list. If the control is already a child of another + control, it is first removed from that control. The tab page overrides + this method to ensure that child tab pages are not added to it, as these + are illegal. + + The child control to be added. + If the specified control is a toplevel control or if a circular control reference would result. + + + + Gets / sets the icon displayed on the tab. + + An Icon value. + + + + Gets or sets back color for TabBarPage Tab. + + + + + Provides design-time functionality for + controls. + + + + + + + + + + + + + + TabBarPageAdding Event DelegateHandler + + + + + TabBarPageAdding event arguement class + + + + + TabBarPageAdding event arguement class initializer + + + + + LabelEditing Event DelegateHandler + + + + + LabelEditing event arguement class + + + + + LabelEdit ends event arguement class initializer + + + + + Gets the TabBarText + + + + + Cancel args + + + + + Cancel the selection + + + + + LabelEditing Event DelegateHandler + + + + + LabelEditing event arguement class + + + + + LabelEdit ends event arguement class initializer + + + + + Gets the TabBarText + + + + + TabBarMouseEventArgs event delegate handler + + + + + TabBarMouseEventArgs class + + + + + Holds button instances. + + + + + Gets the Mouse Button + + + + + Holds TabBarPage which is selected. + + + + + Gets the selected TabBarPage. + + + + + Holds bar location. + + + + + Gets the TabBounds bounds. + + + + + TabBarSelectionArgs class initializer + + + + + Gets Mouse Pointer Location + + + + + Provides functionality for displaying several controls + in an Excel-like workbook control. Each might optionally + support splitting its view with a dynamic splitter frame. + + + + + Variable for TabBar page is in EditMode + + + + + Reset the Office2013Style on StyleChange + + + + + Lock Window On style Change + + + + + + + Default size of the control + + + + + Specifies office 2007 color scheme. + + + + + Style of the control. + + + + + Color table for Office2007 visual style. + + + + + Used to move the TabBarPage in TabBarSplitterControl + + + + + Occurs after the active page has changed. + + + + + Occurs before the active page is changed. + + + + + Occurs when the TabBarPage is show or Hide or Add or Remove. + + + + + Occurs when Mouse pointer rest on TabBarPage bounds + + + + + Occurs when Mouse pointer leave TabBarPage bounds + + + + + Occurs when Mouse pointer leave TabBarPage bounds + + + + + Occurs after edting the TabBarPage. + + + + + Occurs before edting the TabBarPage. + + + + + Triggers mouse down occurs on TabBar + + + + + Initializes a new . + + + + + Gets or sets a value indicating whether the control should enable its Accessibility support. + + + + + Gets or sets value to enable or disable the Touchmode to the controls. + + Scale factor will be updated automatically if scalefactor is equal to 1 + + + + + + + Scale the control based on the scale factor passed in the argument. + + value to scale the factor based upon. + + + + + + + + + + + + + + + + Overridden method of refresh. + + + + + Returns the tab bar. + + + + + Overridden method of Tostring() + + + + + + Called when the user is dragging a tab. + + The source of the event. + Event data. + + + + Called when the user finishes dragging a tab. + + The source of the event. + Event data. + + + + Indicates whether Icons should be displayed in the tabs. + + + + + Gets the Office16themes Colors + + + + + Gets or sets the visual style of the tabBarSplitterControl. + + + + + + + + + + Gets or sets office 2007 color scheme. + + + + + Gets color table for Office2007 visual style. + + + + + Gets or sets office 2007 style scroll bars. (overridden property) + + + + + Get or Set of Skin Manager Interface + + + + + Gets or sets office 2007 scroll bars colorScheme. (overridden property) + + + + + + + + + + To raise TabBarPageAdding Event + + + + + + To raise LabelEditEnds Event + + + + + + Cancels the editable state of the Tabpage. + + + + + To raise LabelEditBegin Event + + + + + + To raise TabBarMouseDown Event + + + + + + Gets or sets the index of the active page. + + + + + Specifies the color with which the ActivePageBorder bottom border should be drawn. + + + + + Indicates whether to Serialize ActivePageBorderColor API + + + + + + Resets the ActivePageBorderColor. + + + + + Gets or sets whether to show/hide the Seperator in MetroStyle + + + + + Indicates whether to Serialize ShowMetroSeperator + + + + + + Resets the ShowMetroSeperator. + + + + + Gets or sets value to enable or disable the EnableOffice2013Style in MetroStyle + + + + + Indicates whether to Serialize EnableOffice2013Style API + + + + + + Resets the EnableOffice2013Style. + + + + + Gets or sets the currently visible TabBarPage. + + + + + Raises the event. + + Event data. + + + + Raises the event. + + Event data. + + + + Gets or sets the number of milliseconds to wait before repeatedly firing scroll event. + + + + + Gets or sets the color of the arrows in the enabled buttons. + + + + + Resets to default. + + + + + Gets or sets the color of the arrows in the disabled buttons. + + + + + Resets to default. + + + + + + + + + + + + CurrencyEdit + + + + + Constructor + + The RibbonControlAdv instance. + + + + Bounds of the Control + + The accessible object bounds. + + + + Gets the role for the RibbonControlAdv. This is used by accessibility programs. + + + + + Gets or sets the accessible object name + + The accessible object name. + + + + Gets the state for the . + + + + + Gets the description of the TabBarSplitterAccessibilityObject + + A string describing the TabBarSplitterAccessibilityObject. + + + + Retrieves the child object at the specified screen coordinates. + + The horizontal screen coordinate. + The vertical screen coordinate. + An TabBarSplitterAccessibilityObject that represents the child object at the given screen coordinates. + This method returns the calling object if the object itself is at the location specified. + Returns null if no object is at the tested location. + + + + Returns the list of TabBarPages displayed in the TabBar. Each TabBarPage + will have a tab associated with it. + + + + + Creates the . + + The new . + + + + + + + + + + + + + + + + + + + + + + Move the Tabbarpage with respect to given pages. + + + + + + + Move Tabbarpage with respect to given index. + + + + + + + Hides the . + + + + + + Activates the next or previous page. + + True if previous pane should be activated; False if next pane should be activated. + + + + + + + + + + + + + Gets or sets the delta used for drawing the tabs. + + + + + Gets or sets the scroll behavior of this tab bar: pixel or tabs. + + + + + Gets or sets the size factor with that TabBar size to be increased + + + + + Gets/Sets whether to display AddNewPageTabBarPage Option or not + + + + + Enable the edit mode when Double Click on TabBarPage + + + + + To reset LabelEdit + + + + + To Specify LabelEdit to be serialized or not + + + + + Enable the edit mode in Selected TabBar + + + + + To reset EditOnTab + + + + + To Specify EditOnTab to be serialized or not + + + + + Gets/Sets background image for AddNewTabBarPageButton + + + + + Gets/Sets the Hover color for AddButton. + + + + + Resets the AddButtonHoverColor + + + + + ShouldSerialize the AddButtonHoverColor. + + + + + + Gets or sets the width of the tab bar relative to the width of the client bounds. + + + + + Enables or disables the resizing of tab bar. + + + + + + + + + + + + + + + Gets or sets the arrow buttons to be shown in an arrow bar. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + Provides the control name. + + + + + Gets or sets the theme name of the control. + + + The default value is null. + + + This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control. + + + + + Gets a value indicating whether the visual style based theme is applied to the control and + also indicates whether the theme files are referred from external assemblies or not. + + Return true, if the visual style based theme is applied to the control. Otherwise returns false. + + + + Apply the theme settings. + + Current theme name + + + + Gets or sets the value used to customize the appearance of the . + + + This ThemeStyle settings will be applied only when the VisualStyleBased theme has been applied to the control. + + + + + A collection of objects. + + + You can access this collection with the of a . + + + + + Initializes a new and + associates it with a . + + The that manages this collection. + + + + Returns an enumerator that lets you enumerate through the list of items. + + An enumerator. + + + + Returns the number of pages. + + + + + Removes an item at the specified index. + + The item index. + + + + Returns False. + + + + + Clears all entries from the list. + + + + + Inserts a at the specified index. + + The index where the page should be inserted. + The page to be inserted. + + + + Gets / sets the at the specified index. + + + + + Adds a to the collection. + + The page to be added. + + + + Adds an array of to this collection. + + The pages to be added. + + + + Indicates whether the specified belongs to this collection. + + The page to be tested. + True if page belongs to collection; False otherwise. + + + + Returns the index of the specified page to be queried. + + The page to look up. + The zero-based index of the page; -1 if not found. + + + + Removes a page from the collection. + + The page to remove. + + + + Copies the collection objects to a one-dimensional instance beginning at the + specified index. + + + Copies the collection objects to a one-dimensional instance beginning at the + specified index. + + + The one-dimensional that is the destination of the values copied from the collection. + + The index of the array at which to begin inserting. + + + + Specifies the style with which tabBarSplitterControl will appear. + + + + + Default appearance. + + + + + Office 2007-like appearance. + + + + + Metro like appearance. + + + + + Office2016Colorful like appearance. + + + + + Office2016White like appearance. + + + + + Office2016DarkGray like appearance. + + + + + + + Provides design-time functionality for the . + + + provides a way to add and remove + tabs at design-time, as well as tab hit testing logic at design-time. + + + + + Initializes a new TabBarSplitterControlDesigner. + + + + + + Indicates whether the + specified point was within the bounds of the component. + + + + + + + + Given a component, this retrieves the tab page that it is parented to or + NULL if it is not parented to any tab page. + + + The component to check. + + + A TabPage that the component is parented to or NULL if + no such page exists. This will return the component if it + is an instance of TabPage. + + + + + + + + Initializes the designer using the specified component. + + The component to associate this designer with. This must always be an instance of the control. + + + + + Called in response to a verb to add a tab. This adds a new + tab with a default name. + + + + + This is called in response to a verb to remove a tab. It removes + the current tab. + + + + + Called when the current selection changes. Here we check to + see if the newly selected component is one of our tabs. If it + is, we make sure that the tab is the currently visible tab. + + + + + Called when the tab property changes. We just set a flag here to + indicate to the later index changed event that the change was the + result of a property change, so there is no need to update the + selection. + + + + + Called when the selected tab changes. This accesses the design + time selection service to surface the new tab as the current + selection. + + + + + Gets / sets the persisted active page index. + + + + + Indicates whether to draw a grid for the control. + + + if a grid should be drawn; + otherwise. + + + + + + Gets / sets the design-time verbs supported by the component associated with the designer. + + + An array of objects. + + + The verbs returned by this method are typically displayed in a right-click + menu by the design-time environment. The return value may be NULL if the + component has no design-time verbs. When a user selects one of the verbs, the + performVerb() method is invoked with the the corresponding DesignerVerb object. + NOTE: A design-time environment will typically provide a "Properties..." entry + on a component's right-click menu. The getVerbs() method should therefore not + include such an entry in the returned list of verbs. + + + + + This class fully encapsulates the painting logic for a tab in a TabBarSplitterControl. + + + + + + + + + + + + + + Draws text by native GDI API. + + Graphics object which ised for drawing. + Font of the text. + Color of the text. + Bounds of tge text. + Text which has to be drawn. + + + + Implements the methods to draw the navigate buttons in RecordNavigationControl. + + + + + Initializes the instance for class. + + ThemeStyle + + + + Represents the class to define the style for arrow buttons in . + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + The store. + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Gets the default values of instance. + + + + + Gets or sets the background color of the arrow in normal state. + + + + + Gets or sets the background color of the arrow in hover state. + + + + + Gets or sets the background color of the arrow in pushed state. + + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Represents the class to define the style for . + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Holds instance of a class. + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + Holds instance of a class + + + + Overridden to create a product-specific identity object for the sub object. + + + StyleInfoProperty descriptor for this sub object. + + + Identity for the sub object. + + + + + Gets the default style value for the control. + + + + + Gets or sets the for tabs. + + + + + Gets or sets the font style of RecordNavigationBar. + + + + + Gets or sets the back color of RecordNavigationBar. + + + + + Gets or sets the fore color of RecordNavigationBar. + + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Maintains the GridControl for create the identity. + + + + + Initializes a new instance of the class. + + + instance to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Initializes a new instance of the class. + + + The that owns this sub-object. + + + The descriptor for this expandable + sub-object. + + + + + Represents the class to define the style for control. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + The store. + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Overridden to create a product-specific identity object for the sub object. + + StyleInfoProperty descriptor for this sub object. + Identity for the sub object. + + + + Gets the default values of instance. + + + + + Gets or sets the cell background color. + + + + + Gets or sets the splitter forecolor. + + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Provides information about the property. + + + + + Provide the information about the spitter forecolor property. + + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + Initializes a new instance of the class. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Represents the class to define the style for navigate buttons. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + The store. + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Gets the default values of instance. + + + + + Gets or sets the fore color of the arrow in normal state. + + + + + Gets or sets the fore color of the arrow in hover state. + + + + + Gets or sets the fore color of the arrow in pushed state. + + + + + Gets or sets the fore color of the arrow in disabled state. + + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + Initializes a new instance of the class. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Represents the class to define the style for . + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Holds instance of a class. + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + Holds instance of a class + + + + Overridden to create a product-specific identity object for the sub object. + + + StyleInfoProperty descriptor for this sub object. + + + Identity for the sub object. + + + + + Gets the default style value for the control. + + + + + Gets or sets the for the horizontal scrollbar of the scroll control. + + + + + Gets or sets the for the vertical scrollbar of the scroll control. + + + + + Gets or sets the value for styles. + + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines whether HorizontalScrollBar has been modified and its contents should be serialized at design-time. + + True if contents were changed; False otherwise. + + + + Determines whether VerticalScrollBar has been modified and its contents should be serialized at design-time. + + True if contents were changed; False otherwise. + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + Represents a class that provides style identity information for nested objects of the + class. + + + + + Maintains the GridControl for create the identity. + + + + + Initializes a new instance of the class. + + + instance to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Represents a class that provides style identity information for nested objects of the + class. + + + + + Initializes a new instance of the class. + + + The that owns this sub-object. + + + The descriptor for this expandable + sub-object. + + + + + Represents the class to define the style for . + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Holds instance of a class. + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + Holds instance of a class + + + + Overridden to create a product-specific identity object for the sub object. + + + StyleInfoProperty descriptor for this sub object. + + + Identity for the sub object. + + + + + Gets the default style value for the control. + + + + + Gets or sets the for tabs. + + + + + Gets or sets the for tabs. + + + + + Gets or sets the back color of the tab bar. + + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Provides information about the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Maintains the GridControl for create the identity. + + + + + Initializes a new instance of the class. + + + instance to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Initializes a new instance of the class. + + + The that owns this sub-object. + + + The descriptor for this expandable + sub-object. + + + + + Represents the class to define the style for control. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + The store. + + + + Gets the default style value of the class. + + Returns the default style value. + + + + Overridden to create a product-specific identity object for the sub object. + + StyleInfoProperty descriptor for this sub object. + Identity for the sub object. + + + + Gets the default values of instance. + + + + + Gets or sets the font style of the active tab. + + + + + Gets or sets the font style of the active tab. + + + + + Gets or sets the fore color of the DottedIcon. + + + + + Gets or sets the back color of the tab in normal state. + + + + + Gets or sets the back color of the tab in pushed state. + + + + + Gets or sets the border color of the tab. + + + + + Gets or sets the bottom line color of the active tab. + + + + + Gets or sets the seperator line color of the tabs. + + + + + Gets or sets the fore color of the tab in normal state. + + + + + Gets or sets the fore color of the tab in hover state. + + + + + Gets or sets the fore color of the tab in pushed state. + + + + + Gets or sets the back color of the AddTab button. + + + + + Gets or sets the back color of the tab in normal state. + + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + Initializes a new instance of the class. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Constructor + + + + + + Gets the color of PushedTabBackColor + + + + + Gets the border color of PushedTab + + + + + Gets the HoverTabFore Color + + + + + Gets the PushedTabFore Color + + + + + Gets the AddTabButtonHoverColor + + + + + Gets the DottedIconColor + + + + + Override method to draw the TabPage border. + + The Graphics object. + + + + Override + + + + + + + + + + + + + + + + + + + Special graphics for text measuring. + + + + + Default tab font. + + + + + Indent from borders to the text. + + + + + + Returns the parent. + + + + + Bounds of the tab. + + + + + Gets the region which contains tab bounds. + + + + + Gets the tab. + + + + + Text of the tab. + + + + + Font of the active tab. + + + + + Font of the active tab. + + + + + Color used to draw the text of the tab. + + + + + Get special measure graphics that allowing measuring without control creation. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets tab preferred size. + + + + + + + Returns the overlapped size of the tabs. + + + + + + Releases the unmanaged resources used by the Component and optionally releases the managed resources. + + to release both managed and unmanaged resources; to release only unmanaged resources. + See the documentation for the class and its Dispose member. + + + + Measures the text. + + The text to be measured. + The font of the text. + Size of the text. + + + + Draws the text. + + + + + Draw text by native GDI API. + + + + + A form that hosts a . The fills the whole form. + + + + public class NewWorkbookFile : BasicAction + { + int windowCount = 0; + WorkbookModel workbook; + public override void InvokeAction(object sender, EventArgs e) + { + windowCount++; + workbook = new WorkbookModel("Workbook"); + GridModel sheet1 = new GridModel(); + SampleGrid.SetupGridModel(sheet1); + GridModel sheet2 = new GridModel(); + SampleGrid.SetupGridModel(sheet2); + + workbook.Worksheets.Add(new WorksheetModel(workbook, "Sheet 1", sheet1)); + workbook.Worksheets.Add(new WorksheetModel(workbook, "Sheet 2", sheet2)); + + WorkbookForm doc = new WorkbookForm(workbook); + doc.Text = workbook.Name + windowCount; + doc.MdiParent = MainWindow; + doc.Show(); + } + } + + + + + + Overloaded. Initializes a new and associates it with a . + + The view to be displayed in the form. + + + + Initializes a new and associates it with a new default + that is created for the specified . + + The model for the workbook view to be displayed in the form. + + + + Initializes a new . + + + + + Cleans up any resources being used. + + + + + Gets / sets the view that is displayed in the form. + + + + + Raises the ThemeChanged event. + + An EventArgs that contains the event data. + + The OnThemeChanged method also allows derived classes to handle the event + without attaching a delegate. This is the preferred technique for + handling the event in a derived class. + Note to Inheritors: When overriding OnThemeChanged in a derived + class, be sure to call the base class's OnThemeChanged method so that + registered delegates receive the event. + + + + + Indicates whether themes are enabled for this control. + + + + + Fired when the ThemesEnabled property changes. + + + + + Provides the data / model part for an Excel-like Workbook display. A has a + with multiple s to display in the workbook. + + + This class can be serialized into a serialization stream. + Multiple controls can share the same . Each + that is displayed in a is associated with a from the + collection in this object. + + + + + Occurs when the has changed. + + + + + Occurs when the has changed. + + + + + Initializes a new . + + + Initializes a new and sets a name for the workbook. + + The name of this workbook. + + + + Initializes a new from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + + + + Returns the collection with items. + + + + + Gets / sets the active for this model. + + + + + Raises the event. + + Event data. + + + + Gets / sets the name for this workbook. + + + + + Raises the event. + + Event data. + + + + + + + Provides functionality for displaying several controls in an Excel-like workbook. + + + A is associated with a . The + has a collection. For each of the objects in + the collection of the , a + is created and displayed in this . + + + + public class NewWorkbookFile : BasicAction + { + int windowCount = 0; + WorkbookModel workbook; + public override void InvokeAction(object sender, EventArgs e) + { + windowCount++; + workbook = new WorkbookModel("Workbook"); + GridModel sheet1 = new GridModel(); + SampleGrid.SetupGridModel(sheet1); + GridModel sheet2 = new GridModel(); + SampleGrid.SetupGridModel(sheet2); + + workbook.Worksheets.Add(new WorksheetModel(workbook, "Sheet 1", sheet1)); + workbook.Worksheets.Add(new WorksheetModel(workbook, "Sheet 2", sheet2)); + + WorkbookForm doc = new WorkbookForm(workbook); + doc.Text = workbook.Name + windowCount; + doc.MdiParent = MainWindow; + doc.Show(); + } + } + + + + + + Occurs when the view is activated. + + + + + Initializes a new for the specified . + + The which holds data to be displayed in this view. + + + + + + + + + + Returns the which holds data to be displayed in this view. + + + + + Creates the . + + The new . + + + + + + + A collection of items. + + + You access this collection with the property of + a . + + + + + Initializes a new and + associates it with a . + + The that manages this collection. + + + + + + + Provides the data / model part for a worksheet in an Excel-like Workbook display. A is a member of the + collection of a . + + + This class can be serialized into a serialization stream. + Multiple controls can share the same . Each + that is displayed in a is associated with a from the + collection in a . + + + + + Occurs when the is changed. + + + + + Occurs when the is changed. + + + + + Occurs when the property is changed. + + + + + Occurs when the property is changed. + + + + + Initializes a new . + + + Initializes a new and associates it with a . + + The this sheet belongs to. + The name of this sheet. + + + + Initializes a new and associates it with a . + + The this sheet belongs to. + The name of this sheet. + The object with data to be displayed in this control, e.g. a Syncfusion.Windows.Forms.Grid.GridModel + with grid data. The object should implement the interface and be able to create a + object to be displayed as pane in a . will create a + for example. + + + + + Initializes a new from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + + + + Creates the that knows how to display the in a form. + + The to be displayed in the + + + The object should implement interface and be able to create a + object to be displayed as pane in a . will create a + for example. + + + + + Gets / sets the name of this worksheet. + + + + + Raises the event. + + EventArgs.Empty. + + + + Gets / sets the object with data to be displayed in this control, e.g. a Syncfusion.Windows.Forms.Grid.GridModel + with grid data. The object should implement interface and be able to create a + object to be displayed as pane in a . will create a + for example. + + + + + Occurs when the property is changed. + + EventArgs.Empty. + + + + Gets / sets the ToolTip text for the tab that will appear when the mouse hovers + over the tab and the TabBarSplitterControl's showToolTips property is True. + + + + + Raises the event. + + + + + + Indicates whether this worksheet is visible in the parent workbook. + + + + + Raises the event. + + EventArgs.Empty. + + + + Returns the this sheet is associated with. + + + + + Represents a collection of objects. + + + + + Occurs when the order of sheets has been changed. + + + + + Initializes a new instance of the class. + + + Initializes a new instance of the class. + + + + + Initializes a new from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Releases any resources used. + + + + + Initializes a new instance of the class containing the + elements of the specified source collection. + + A with which to initialize the collection. + + + + Initializes a new instance of the class containing the specified array of objects. + + An array of objects with which to initialize the collection. + + + + Gets / sets the at the specified index. + + + + + Returns the index of a sheet with the specified name. + + The name of the sheet to find. + The index of the sheet with the specified name; -1 if not found. + + + + Adds the specified to the collection. + + The to add. + + The index at which the new element was inserted. + + + + + Overloaded. Copies the elements of the specified array to the + end of the collection. + + An array of type containing the objects to add to the collection. + + + + Adds the contents of another to the end of the collection. + + A containing the objects to add to the collection. + + + + Indicates whether the collection contains the specified . + + The to search for in the collection. + + + if the collection contains the specified object; + otherwise. + + + + + Copies the collection objects to a one-dimensional instance beginning at the + specified index. + + + The one-dimensional that is the destination of the values copied from the collection. + + The index of the array at which to begin inserting. + + + + Returns the index in the collection of the specified , if it exists in the + collection. + + The to locate in the collection. + + The index in the collection of the specified object, if found; -1 otherwise. + + + + + Inserts the specified into the collection at the specified index. + + The zero-based index where the specified object should be inserted. + The to insert. + + + + Removes the specified from the collection. + + The to remove from the collection. + + + + Moves a worksheet from one position to another. + + The original index of the worksheet. + The new index of the worksheet. + + + + Called when the order of the worksheet has changed. + + The original index of an affected worksheet. + The new index of an affected worksheet + The reason for the change. + + + + + + + + + + + + + + + + + + + Suspend updating the display. + + + + + Resumes updating the display. + + + + + Indicates whether was called. + + + + + Creates a new empty and names it "Sheet #". + + The this new sheet is added to. + The new . + + + + WorksheetView implements a single page in a . It is essentially a panel that hosts a child control + that is created from the of a . + + + Multiple controls can share the same . Each + that is displayed in a is associated with a from the + collection in a object. + + + + + Initializes a new for an existing and a + that displays this sheet. + + The that manages the data for this view. + The that displays this sheet as a page. + + + + + + + + + + + + + + + + Returns the that displays this sheet as a page. + + + + + Returns the that manages the data for this view. + + + + + A framework independent utility class for the new Nullable type in .NET Framework 2.0 + + + + + Use this method instead of Convert.ChangeType. Makes Convert.ChangeType work with Nullable types. + + + + + + + + Use this method instead of Convert.ChangeType. Makes Convert.ChangeType work with Nullable types. + + + + + + + + + Returns null if value is DBNull and specified type is a Nullable type. Otherwise the value is returned unchanged. + + + + + + + + Returns the underlying type of a Nullable type. For .NET 1.0 and 1.1 this method will always return null. + + + + + + + + + + Special type converter that can convert the associated type to a byte array and vice-versa when + requested by the design-time, for example. + + + + + + + + + + + + + + + + + An abstract class that encapsulates a command to be executed at a later point in time. + + + + + Execute the command this object represents. + + + + + Get a description for the command. + + + + + Still being discussed if they should be included in shared. + + + + + + + + + + + Still being discussed if they should be included in shared. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This is a base class for Disposable. It implements the IDisposable interface + as suggested in the .NET documentation using the Disposable pattern but it does not + implement a finalizer. If you need finalization you need to derive from Disposable + or add a finalizer to your derived class and manually call Dispose from the Finalizer. + + + + + Releases all resources used by the Component. + + + Releases all resources used by the Component. + + + + + Releases the unmanaged resources used by the Component and optionally releases the managed resources. + + to release both managed and unmanaged resources; to release only unmanaged resources. + See the documentation for the class and its Dispose member. + + + + This class provides a base class that implements the IDisposable interface + as suggested in the .NET documentation using the Disposable pattern. + + If you derive from this class, you only need to override the protected + Dispose method and check the disposing parameter. + + + + . + In C# and C++, finalizers are expressed using destructor syntax. + + + + + This is a base class for DisposableWithDisposedProp. It implements the IDisposable interface + as suggested in the .NET documentation using the Disposable pattern but it does not + implement a finalizer. If you need finalization you need to derive from Disposable + or add a finalizer to your derived class and manually call Dispose from the Finalizer. + + + + + Storage for IsDisposed property. True - object is disposed, + otherwise object is still alive and available for user use. + + + + + Allows to detect if object is disposed or not. True indicates object is disposed, + otherwise indicates object is still alive and ready for use. + + + + + Releases all resources used by the Component. + + + Releases all resources used by the Component. + + + + + Releases the unmanaged resources used by the Component and optionally releases the managed resources. + + to release both managed and unmanaged resources; to release only unmanaged resources. + See the documentation for the class and its Dispose member. + + + + This class provides a base class that implements the IDisposable interface + as suggested in the .NET documentation using the Disposable pattern. + + If you derive from this class, you only need to override the protected + Dispose method and check the disposing parameter. + + + + . + In C# and C++, finalizers are expressed using destructor syntax. + + + + + + + + + + + Clear collection and then reset it reference to NULL. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Dispose array items and then clear collection and reset it reference to NULL. + + + + + Gets the value of a property from some object + + Object from which we want to take the value of property + Name of the property from which we want to take value + Type of value? which to return + Value which we want to take + + + + Specifies the expected effect of the change in property of an object / Control. + + + Used by the class. + + + + + The Control needs a repaint due to change in property's value. + + + + + The Control needs to be laid out due to change in a property's value. + + + + + No effect when there is change in a property's value. + + + + + Provides data for the delegate. + + + + + Gets / sets the of this change in property value. + + The . + + + + The old value of the property before it changes. + + + The object representing the old value. This can be cast to + the type of the property. + + + + + The new value of the property after it changes. + + + The object representing the new value. This can be cast to + the type of the property. + + + + + Creates an instance of the SyncfusionPropertyChangedEventArgs class. + + A PropertyChangeEffect value. + The name of the property. + The old value cast into an object. + The new value cast into an object. + + + + Represents the method that will handle the PropertyChanged event of + certain classes. + + The source of the event. + A object that + contains the event data. + + + + A class implements this interface to let it be known that it provides + a event. + + + The class makes use of this interface when the items + in its list implement it. The listens to this event and + forwards the event args using its own event. + + + + + Occurs when one of the object's property changes. + + + This event provides a generic way of notifying changes + in an object's property, along with the old value, new value + and the PropertyChangeEffect. + + + + + Used internally to expose the DesignMode property of certain component-derived + classes. + + + + + Indicates whether the component is in design-mode. + + + + + Indicates the current state of the operation. + + + + + The operation is starting. + + + + + The operation is in progress. + + + + + The operation is finished. + + + + + This class listens to a list of and fires a event + if the operation takes longer than a specified . + + + Derive from this class if you want to add support for displaying status messages in your + status bar. + operates on the same thread + where the long operation takes place. See the class how to + give feedback about the operation on a different thread and allow the user to cancel the + operation by pressing the Cancel button in a dialog. + + + + + + Occurs to indicate the progress of an ongoing operation. + + + + + + + + Adds an that this object will listen to and + provide user feedback for. + + An object that implements the interface. + + + + Removes an from the list of feedback providers. + + An object that implements the interface. + + + + Gets / sets the delay in milliseconds before Progress events about an operation should be raised. + + + + + Raises the event. + + An that contains the event data. + + + + Holds status information about an ongoing operation. + + + + + Initializes the event args. + + The current status of the operation. + The name of the operation. + A textual description for the operation. + The percentage of work the operation completed so far or -1 if the operation + is not able to calculate a meaningful percentage value. + The number of milliseconds that passed since the operation started. + Indicates whether the operation can be canceled by the user. + Indicates whether changes made by the operation can be rolled back if the + operation is canceled by the user. + + + + Returns the percentage of work the operation completed so far; -1 if the operation + is not able to calculate a meaningful percentage value. + + + + + Returns the name of the operation. + + + + + Returns the textual description for the operation. + + + + + Indicates whether the operation can be canceled by the user. + + + + + Indicates whether changes made by the operation can be rolled back if the + operation is canceled by the user. + + + + + Indicates whether the operation should roll back. + + + + + Returns the current status of the operation. + + + + + Returns the number of milliseconds that passed since the operation started. + + + + + Represents the method that will handle the OperationFeedbackEvent event of certain classes. + + The source of the event. + An OperationFeedbackEventArgs object that + contains the event data. + + + + The class that implements the component where operations are operated on should + implement this interface. + + + + + Raises an RaiseOperationFeedbackEvent. + + An OperationFeedbackEventArgs object that + contains the event data. + + + + Returns the stack for nested operations. + + + + + Occurs to indicate the progress of an ongoing operation. + + + + + Use this class when you want to provide feedback during time-consuming operations or + if you want the user to be able to abort an operation. + + + You need to implement IOperationFeedbackProvider in your class. + + // interface IOperationFeedbackProvider + public event OperationFeedbackEventHandler OperationFeedback; + Stack feedbackStack = new Stack(); + void IOperationFeedbackProvider.RaiseOperationFeedbackEvent(OperationFeedbackEventArgs e) + { + if (OperationFeedback != null) + OperationFeedback(this, e); + } + Stack IOperationFeedbackProvider.FeedbackStack + { + get { return feedbackStack; } + } + + + When you implement an operation that you want to be cancellable or where + you want to show feedback (e.g. display percentage in status bar) you + do this by creating an OperationFeedback object inside a using statement. + + Example: + + using (OperationFeedback op = new OperationFeedback(this)) + { + op.Name = "Cell"; + op.Description = "Command Description"; + op.AllowCancel = true; + op.AllowNestedProgress = true; + op.AllowNestedFeedback = false; + while (n++ != 100) + { + if (op.ShouldCancel()) + return; + + op.PercentComplete = n; + } + } + + It is also supported in nest operations in case your method calls other + routines that also use OperationFeedback. AllowNestedProgress will disable + OperationFeedback and OperationProgress / ShouldCancel in nested routines. + AllowNestedFeedback will simply prohibit changing the description. But + the object will still fire OperationProgress events. + + A sample for a consumer is the DelayedWaitCursor class. You can assign a DelayedWaitCursor + to a grid table. The DelayedWaitCursor object will listen to OperationFeedback events and + automatically change the cursor to a wait cursor if operations take more time. + + + + + + + + Initializes a new OperationFeedback object and pushes the object + onto the providers feedback stack. + + Component that implements IOperationFeedbackProvider. + + + + Closes the current operation. Removes the object from FeedbackStack. + + + + + Call this method to signal the start of the operation. If you do not explicitly + call this routine, it will be called automatically the first time Progress or ShouldCancel + is called. + + + + + Call this method to signal the end of the operation. If you do not explicitly + call this routine it will be called automatically when you are using the "using" + statement in C# and / or when Dispose is called. + + + + + Call this method inside a loop from your method that implements the operation. + + + + + Gets / sets the number of series if you have a series of nested operations. + + + If you know the number of operations in advance, you should specify this value. + This allows OperationFeedback to adjust the percentage display to reflect the percentage + in the overall operation. If you have two operations, the first operation will show percentage + from 0 to 50 and the second from 51 to 100. In the original program code for these operations, you + can keep your original calculations (setting percentage from 0 to 100). + OperationFeedback simply divides the percentage by SeriesCount when it fires the Progress event. + + + + + Indicate whether this operation is nested inside another operation. + + + + + Indicates whether nested operations are enabled / disabled. + + + + + Indicates whether calls to Progress or ShouldCancel have any effect. + + + + + Indicates whether the percent complete and description should be shown or discarded + for this operation. + + + + + Indicates whether percentage display and description for nested operations are enabled / disabled. + + + + + Indicates whether the user wants to abort the operation. ShouldCancel will call + Progress. + + + + + Indicates whether cancelling the current operation is enabled / disabled. + + + + + Indicates whether rolling back (undoing) the current operation is enabled / disabled. + + + + + Indicates whether the canceled operation should be rolled back. + + + + + Returns False. + + + + + Gets / sets the short name of the operation. + + + + + Returns the number of ticks elapsed since the operation was started. + + + + + Gets / sets the description of the operation. Use localized string (SR.GetString("...")) if necessary. + + + + + Gets / sets the progress in percentage for the current operation. + + + + + Returns the number of counts of calls to Progress. + + + + + Specifies whether a property should be shown in the ToString result. + + + + + + Specifies that a property should be shown in the ToString result. + This field is Read-only. + + + + + Specifies that a property should not be shown in the ToString result. + This field is Read-only. + + + + + The default value for TracePropertyAttribute. (No) + + + + + Initializes a new instance of the class. + + + if a property should be shown in ToString result; otherwise. The default is . + + + + + + + Overridden. See . + + + + + + + + Indicates whether a property is shown in the ToString result. + + + + + Helper class for creating a string concatenating the string representation of all properties in an object. + + + The static method of this helper class will loop through any property + in a given object and check if the has been set. If it has + been set, the string representation of the property will be appended to the resulting string. + + + + + Indicates whether the has been set for the property. + + A . + True if property has a ; False otherwise. + + + + This method will loop through any property in a given object and append the + string representation of the property if the + has been set. + + + + + This is a base class for events of the Syncfusion libraries. It supports writing + properties in its ToString() method. + + + + + This method will loop through all properties in a derived class and append the + string representation of the property if the + has been set. + + + + + Provides data for a cancellable event. + + + + + Overloaded. Initializes a new instance of the SyncfusionCancelEventArgs class. + + + + + Initializes a new instance of the SyncfusionCancelEventArgs class with the Cancel property set to the given value. + + + + + + + + Provides data for an event that indicates success or failure. + + + + + Overloaded. Initializes a new instance of the SyncfusionSuccessEventArgs class with the Success property set to True. + + + + + Initializes a new instance of the SyncfusionSuccessEventArgs class with the Success property set to the given value. + + Indicates whether an operation was successful. + + + + Indicates whether an operation was successful. + + + + + Provides data for a event that can be handled by a subscriber and overrides the event's default behavior. + + + + + Overloaded. Initializes a new instance of the SyncfusionHandledEventArgs class with the Handled property set to False. + + + + + Initializes a new instance of the SyncfusionHandledEventArgs class with the Handled property set to the given value. + + + + + Indicates whether the event has been handled and no further processing of the event should happen. + + + + + Provides a basic implementation for the ITypeDescriptorContext interface and can be used + together with WindowsFormsEditorService to launch an Editor directly outside a property grid. + + + The grid uses this class to display a collection editor: + + public static DialogResult ShowGridBaseStylesMapDialog(object instance, string propertyName) + { + GridBaseStyleCollectionEditor ce = new GridBaseStyleCollectionEditor(typeof(ArrayList)); + WindowsFormsEditorServiceContainer esc = new WindowsFormsEditorServiceContainer(null); + PropertyDescriptor pd = TypeDescriptor.GetProperties(instance)[propertyName]; + TypeDescriptorContext tdc = new TypeDescriptorContext(instance, pd); + tdc.ServiceProvider = esc; + object v = ce.EditValue(tdc, esc, ((ICloneable) pd.GetValue(instance)).Clone()); + if (esc.DialogResult == DialogResult.OK) + { + pd.SetValue(instance, v); + } + return esc.DialogResult; + } + + + + + + + Initializes a TypeDescriptorContext for the given object and PropertyDescriptor. + + The instance of the property to be edited. + A PropertyDescriptor that contains information about the property. + + + + Gets / sets the associated IServiceProvider. + + An IServiceProvider value. + + + + Provides support for the method that returns a . + + + + + Returns a collection of property descriptors. + + + + + + Provides a basic implementation for the IWindowsFormsEditorService and IServiceProvider interfaces and can be used + together with TypeDescriptorContext to launch an Editor directly outside a property grid. + + + The grid uses this class to display a collection editor. + + public static DialogResult ShowGridBaseStylesMapDialog(object instance, string propertyName) + { + GridBaseStyleCollectionEditor ce = new GridBaseStyleCollectionEditor(typeof(ArrayList)); + WindowsFormsEditorServiceContainer esc = new WindowsFormsEditorServiceContainer(null); + PropertyDescriptor pd = TypeDescriptor.GetProperties(instance)[propertyName]; + TypeDescriptorContext tdc = new TypeDescriptorContext(instance, pd); + tdc.ServiceProvider = esc; + object v = ce.EditValue(tdc, esc, ((ICloneable) pd.GetValue(instance)).Clone()); + if (esc.DialogResult == DialogResult.OK) + { + pd.SetValue(instance, v); + } + return esc.DialogResult; + } + + + + + + + Initializes a WindowsFormsEditorServiceContainer with the given IServiceProvider. + + An IServiceProvider. Can be NULL. + + + + Occurs immediately before the Dialog is displayed. The ControlEventArgs.Control + the form. + + + + + Returns the dialog result of the edit operation. + + + + + Gets / sets the associated IServiceProvider. + + + + + A helper class that provides the options to paints window background based on the information. + + + + + Fills the interior of path based on the value. + + A context. + A context. + A value. + + + + Fills the interior of a path based on the information. + + A context. + A context. + A value. + + + + Fills the interior of a path based on the gradient style and color values. + + A context. + A context. + A value. + A array of the value. + + + + Fills the interior of a rectangle based on the information. + + A context. + A structure that represents the rectangle to fill. + object that determines the characteristics of the fill. + + + + Fills the interior of a rectangle based on the gradient style information. + + A context. + A structure that represents the rectangle to fill. + A value. + A used for the fore color of the gradient fill. + A used for the back color gradient fill. + + + + Fills the interior of a rectangle based on the gradient style information. + + A context + A structure that represents the rectangle to fill. + A value. + An array of used for the gradient fill. + + + + Fills the interior of a rectangle based on the pattern style and color values. + + A context + A structure that represents the rectangle to fill. + A information. + A used for the fore color of pattern fill. + A used for the back color of pattern fill. + + + + Fills the interior of a rectangle based on the color value. + + A context. + A structure that represents the rectangle to fill. + A value. + + + + Fills the interior of a region based on the information. + + A context. + A structure that represents the region to fill. + A object that determines the characteristics of the fill. + + + + Fills the interior of a region based on the gradient style. + + A context. + A structure that represents the region to fill. + A value. + An array of used for the gradient fill. + + + + Fills the interior of a region based on the information. + + A context. + A structure that represents the region to fill. + A value. + A used for the fore color of pattern fill. + A used for the back color of pattern fill. + + + + Fills the interior of a region based on the color value. + + A context. + A structure that represents the region to fill. + A value. + + + Fills a rectangle with gradient style based on the foreColors values. + A context. + A value. + A contains the colors details. + + + Fills a rectangle with gradient style based on the foreColors values. + A context. + A value. + A contains the colors details. + Boolean value indicates to draw in vertical or horizontal. + + + Fills the gradient style to rectangle based on the color values. + A context. + A value. + A contains the first color of gradient fill. + A contains the second color the gradient fill.> + + + Fills the gradient style to rectangle based on the color values. + A context. + A value. + A contains the first color of gradient fill. + A contains the second color the gradient fill.> + Boolean value indicates to draw in vertical or horizontal. + + + Draws a border based on the border style and border color information. + A context. + A value. + A context. + A context. + A context. + A context. + + + Draws a border based on the border style and border color. + A context. + A value. + A context. + A used for the border style. + A context. + A context. + A used for the 3-D border style. + + + + Draws the borders based on the specified styles information. + + A context. + A output rectangle. + A border style. + 3D border style. + Border style in single mode. + Border color in single mode. + Sides that have to be drawn by methods. + True - fix known bug in method, otherwise leave + old code (for compatibility only). + + + + Fills the interior of rectangle based on the information. + + A handle to the device context. + A context. + A context. + + + + Fills the interior of rectangle based on the information. + + A handle to the device context. + A context. + A context. + + + + Fills the gradient style to rectangle based on the color values. + + A handle to the device context. + Rectangle area. + Starting color of the gradient. + Ending color of the gradient. + + + + Fills the gradient style to rectangle based on the color values. + + A handle to the device context. + Rectangle area. + Starting color of the gradient. + Ending color of the gradient. + Boolean value indicates to draw in vertical or horizontal. + + + + Fills the region based on the color information. + + A handle to the device context. + A context. + A context. + + + + Fills the region based on the information. + + A handle to the device context. + A context. + A context. + + + + Fills the interior of a path based on the information. + + A handle to the device context. + A context. + A context. + + + + Fills the interior of a path based on the information. + + A handle to the device context. + A context. + A context. + + + + Draws the line based on the position values. + + A handle to the device context. + A context + Start X position + Start Y position + End X position + End Y position + + + + Draws the rectangle based on the information. + + A handle to the device context. + A context. + Rectangle area. + + + + Converts the ColorRef value into the RGB value. + + The integer value indicates the color value. + Returns the RGB value. + + + + Recalculates the rectangle based on the graphics matrix settings. + + A context. + A context. + Returns the transformed rectangle value. + + + + Converts the value to the value. + + A context. + Returns the value. + + + + Converts the color array to the value. + + A array of the color. + Returns the value. + + + Gets a new instance of the + based on the color values. + A value. + A contains the first color of gradient fill. + A contains the second color the gradient fill.> + Returns a class with the specified points and colors.Returns the value. + + + Returns a new instance of the + based on the color values. + A value. + A contains the first color of gradient fill. + A contains the second color the gradient fill.> + Returns a with the specified points and colors.Returns the value. + + + + Returns the Linear gradient brush value based on the path, gradient style and color collection values. + + The collection of colors used create a brush instance. + The rectangle area used to create a linear gradient brush. + The style of the gradient brush. + Returns the linear gradient brush. + + + + Returns the path gradient brush value based on the given path and color collection. + + The used to initialize the path gradient. + The color collection used to create a path gradient brush. + Returns the path gradient brush. + + + + Holds information on how to fill the background of a window or grid cell. + + + lets you specify a solid back color, gradient or pattern style with both + back and fore color. + + This information can be persisted with serialization. + + You can also convert the information to a string and recreate it from a string. + + is immutable (just like ). You cannot change its values. + Instead you have to create a new object. + + can also be persisted into code when used as a property in a component designer. + + + + + + The separator value. + + + + + The collection of separator values. + + + + + The empty brush value. + + + + + The of the . + + + + + The brush style information of the . + It contains the or + information of the . + + + + + The back color is the first entry in this list and the fore color is the last entry in the list. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified solid back color. + + A used as solid background. + + + + Initializes a new instance of the class with a solid back color and fore color. + + + The fore Color. + + + The back Color. + + + + + Initializes a new instance of the class with a hatch style and pattern colors. + + A . + A used for fore color of the pattern. + A used for back color the pattern. + + + + Initializes a new instance of the class with a hatch style and pattern colors. + + A value. + List of colors. + + + + Initializes a new instance of the class with a hatch style and pattern colors. + + A . + List of colors. + + + + Initializes a new instance of the class with a gradient style and gradient fill colors. + + A . + A used for fore color of the gradient fill. + A used for back color the gradient fill. + + + + Initializes a new instance of the class with a gradient style and gradient fill colors. + + A . + List of gradient fill colors. + + + + Initializes a new instance of the class with a hatch style and pattern colors. + + A . + List of colors. + + + + Initializes a new instance of the class with any BrushStyle. Internal only. + + + The style. + + + The style Info. + + + The fore Color. + + + The back Color. + + + + + Initializes a new instance of the class with a new alpha-blend value and copies other information from a given . + + + The alpha value that should be applied to the fore color and back color of the new brush. + + + A that holds information for this . + + + + + Initializes a new instance of the class and copies its information from a given . + + A that holds information for this . + + + + Initializes a new instance of the class. + + A serialization information. + A contains the information. + + + + Gets a empty . + + + + + Gets a value indicating whether a brush is an empty object. + + + + + Gets the back color. + + + + + Gets the fore color value. + + + + + Gets the colors list.The first entry in this list will be the same as the back color property, + the last entry will be same as the fore color property. + + A reference to the instance. + + + + Gets the pattern style. + + + + + Gets the gradient style. + + + + + Gets the brush style information (solid, gradient or pattern). + + + + + Creates a new object and initializes it from a string. + + A string in the format BrushStyle;Style;ForeColor;BackColor. + A new object. + + + + Clears the information. + + + + + Overloaded. Returns the string representation of the brush in the format BrushStyle;Style;ForeColor;BackColor. + + + The value. + + + + + Returns the string representation of the brush in the format BrushStyle;Style;ForeColor;BackColor. + + Specifies the format for string. NULL for default, "compact" for a compact string, "G" for more descriptive text. + Returns the string value. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Clean up any resources being used. + + + + + Populates a with the data needed to serialize the target object. + + The to populate with data. + The destination for this serialization. + + + + Creates a new object that is a copy of this instance. + + The copy of this will be return. + + + + Serializes the contents of this object into an XML stream. + + Represents the XML stream. + + + + Not implemented and returns NULL. + + Returns a null. + + + + De-serialize the contents of this object from an XML stream. + + Represents the XML stream. + + + + Gets the style of the . + + Returns the information. + + + + Sets the style for the . + + A context. + Returns the value. + + + + Gets the back color value of the . + + Returns the color value. + + + + Sets the back color for . + + A value. + Returns the value. + + + + Gets the pattern style of the . + + Returns the pattern style. + + + + Sets the for . + + The value. + Returns the value. + + + + Gets the of . + + Returns the value. + + + + Sets the of . + + The value. + Returns the value. + + + + Gets the fore color value of the . + + Returns the color value. + + + + Sets the fore color value for . + + A value. + Returns the value. + + + + Initializes the gradient colors based on the foreColor and backColor values. + + A value contains the back color value. + A value contains the fore color value. + + + + Initializes the gradient colors based on the value. + + A context. + + + + Sets the description for the . + + The string value. + Returns the information. + + + + Represents a class that provides options to save list of objects. + + + + + Initializes a new instance of the class. + Overloaded. Creates a new instance of this class. + + + + + Initializes a new instance of the class with some colors. + + An array of color objects + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets or sets the color at the specified index. + + The index value. + Returns the color value. + + + + Overridden. See . + + The zero-based index at which the new elements should be inserted. + The whose elements should be inserted into the + . The collection itself cannot be null, but it can + contain elements that are null. + + + + Overridden. See . + + + + + Overridden. See . + + The zero-based index at which the new elements should be inserted. + The number of elements to remove.> + + + + Populates a with the data needed to serialize the target object. + + The to populate with data. + The destination for this serialization. + + + + Add the color value in collection. + + A value. + + + + Add the array of color values into the collection. + + A array of the objects. + + + + Populates a with the data needed to serialize the target object. + + The to populate with data. + The destination for this serialization. + + + + Provides a user interface that can edit most types of collections at design time. + + + + + Initializes a new instance of the class base on the specified collection type. + + The type of the collection for this editor to edit. + + + + Overridden. See . + + An that can be used to gain additional context information. + A service provider object through which editing services can be obtained. + The object to edit the value of. + The new value of the object. If the value of the object has not changed, this + should return the same object it was passed. + + + + Overridden. See . + + The collection to edit. + An array of objects to set as the collection items. + The newly created collection object or, otherwise, the collection indicated by the editValue parameter. + + + + Prevent deleting items when there are only 2 items (or less) in the collection. + + A value. + true if it is permissible to remove this value from the collection; otherwise, + false. The default implementation always returns true. + + + + Gets the items count in ListBox from the CollectionEditor. + + Returns the items count + + + + Provides a unified way of converting types of values to other types. + + + + + Overridden. See . + + An that provides a format context. + A . If null is passed, the current culture is assumed. + The to convert. + The to convert the value parameter to. + An that represents the converted value. + + + + Overridden. See . + + An that provides a format context. + A that represents the type you want to convert to. + true if this converter can perform the conversion; otherwise, false. + + + + Defines the constants that specify the various brush styles. + + + + + The is an empty object. + + + + + The represents a solid fill. + + + + + The represents a pattern fill. + + + + + The represents a gradient fill. + + + + + Defines the constants that specify various pattern styles. + + + + + A none value. + + + + + A pattern of horizontal lines. + + + + + A pattern of vertical lines. + + + + + A pattern of lines on a diagonal from top-left to bottom-right. + + + + + A pattern of lines on a diagonal from top-right to bottom-left. + + + + + A pattern of cross-cross horizontal and vertical lines. + + + + + A pattern of cross-cross diagonal lines. + + + + + Specifies a 5-percent hatch. The ratio of foreground color to background color is 5:100. + + + + + Specifies a 10-percent hatch. The ratio of foreground color to background color is 10:100. + + + + + Specifies a 20-percent hatch. The ratio of foreground color to background color is 20:100. + + + + + Specifies a 25-percent hatch. The ratio of foreground color to background color is 25:100. + + + + + Specifies a 30-percent hatch. The ratio of foreground color to background color is 30:100. + + + + + Specifies a 40-percent hatch. The ratio of foreground color to background color is 40:100. + + + + + Specifies a 50-percent hatch. The ratio of foreground color to background color is 50:100. + + + + + Specifies a 60-percent hatch. The ratio of foreground color to background color is 60:100. + + + + + Specifies a 70-percent hatch. The ratio of foreground color to background color is 70:100. + + + + + Specifies a 75-percent hatch. The ratio of foreground color to background color is 75:100. + + + + + Specifies a 80-percent hatch. The ratio of foreground color to background color is 80:100. + + + + + Specifies a 90-percent hatch. The ratio of foreground color to background color is 90:100. + + + + + Specifies diagonal lines that slant to the right from top points to bottom points and are spaced 50 percent closer together than BackwardDiagonal, but they are not anti-aliased. + + + + + Specifies 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 anti-aliased. + + + + + Specifies diagonal lines that slant to the right from top points to bottom points, are spaced 50 percent closer together than, and are twice the width of ForwardDiagonal. This hatch pattern is not anti-aliased. + + + + + Specifies diagonal lines that slant to the left from top points to bottom points, are spaced 50 percent closer together than BackwardDiagonal and are twice its width, but the lines are not anti-aliased. + + + + + Specifies 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 anti-aliased. + + + + + Specifies 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 anti-aliased. + + + + + Specifies light vertical lines. + + + + + Specifies light horizontal lines. + + + + + Specifies narrow vertical lines . + + + + + Specifies narrow horizontal lines + + + + + Specifies vertical lines that are spaced 50 percent closer together than Vertical and are twice its width. + + + + + Specifies horizontal lines that are spaced 50 percent closer together than Horizontal and are twice the width of HatchStyleHorizontal. + + + + + Specifies dashed diagonal lines, that slant to the right from top points to bottom points. + + + + + Specifies dashed diagonal lines, that slant to the left from top points to bottom points. + + + + + Specifies dashed horizontal lines. + + + + + Specifies dashed vertical lines. + + + + + Specifies a hatch that has the appearance of confetti. + + + + + Specifies a hatch that has the appearance of confetti and is composed of larger pieces than SmallConfetti. + + + + + Specifies horizontal lines that are composed of zigzags. + + + + + Specifies horizontal lines that are composed of tildes. + + + + + Specifies a hatch that has the appearance of layered bricks that slant to the left from top points to bottom points. + + + + + Specifies a hatch that has the appearance of horizontally layered bricks. + + + + + Specifies a hatch that has the appearance of a woven material. + + + + + Specifies a hatch that has the appearance of a plaid material. + + + + + Specifies a hatch that has the appearance of divots. + + + + + Specifies horizontal and vertical lines, each of which is composed of dots, that cross. + + + + + Specifies forward diagonal and backward diagonal lines, each of which is composed of dots, that cross. + + + + + Specifies a hatch that has the appearance of diagonally-layered shingles that slant to the right from top points to bottom points. + + + + + Specifies a hatch that has the appearance of a trellis. + + + + + Specifies a hatch that has the appearance of spheres laid adjacent to one another. + + + + + Specifies horizontal and vertical lines that cross and are spaced 50 percent closer together than hatch style Cross. + + + + + Specifies a hatch that has the appearance of a checkerboard. + + + + + Specifies a hatch that has the appearance of a checkerboard with squares that are twice the size of SmallCheckerBoard. + + + + + Specifies forward diagonal and backward diagonal lines that cross but are not anti aliased. + + + + + Specifies a hatch that has the appearance of a checkerboard placed diagonally. + + + + + Defines the constants that specify various gradient styles. + + + + + A none value. + + + + + ForwardDiagonal Gradient. + + + + + BackwardDiagonal Gradient. + + + + + Horizontal Gradient. + + + + + Vertical Gradient. + + + + + PathRectangle Gradient. + + + + + PathEllipse Gradient. + + + + + Defines the constants that specify the gesture option for the control. + + + + + Does not allow to configure any touch gestures to control. + + + + + Allows the control to enable all gesture options. + + + + + Allows the control to enable the panning gesture. + + + + + Allows the control to enable the zooming gesture. + + + + + Allows the control to enable the rotate gesture. + + + + + Allows the control to enable the two finger tap gesture. + + + + + Allows the control to enable the press and tap gesture. + + + + + Defines the constants that specify touch panning option for control. + + + + + Does not allow the control to the perform any panning operations. + + + + + Allows the control to enable all panning options. + + + + + Allows the control to perform the panning operation in vertical direction. + + + + + Allows the control to perform the panning operation in horizontal direction. + + + + + Allows the control to perform the panning operation with gutter. + + + + + Allows the control to perform the panning operation with inertia. + + + + + Defines the constants that specify the shadow option to draw the image with shadow. + + + + + Does not allow to draw shadow for the image. + + + + + Allows to draw the shadow in all sides of the image. + + + + + Allows to draw the shadow at bottom and left sides of the image. + + + + + Allows to draw the shadow at top and right sides of the image. + + + + + Allows to draw the shadow at top and left sides of the image. + + + + + Allows to draw the shadow at bottom and right sides of the image. + + + + + Defines the constants that specifies the direction of the triangle. + + + + + A triangle pointing up. + + + + + A triangle pointing down. + + + + + A triangle pointing to the left. + + + + + A triangle pointing to the right. + + + + + Represents a class that provides support to get the current DPI value and calculate the values based on the current DPI values. + + + + + The which is used to calculate the DPI value. + + + + + Gets the used to calculate the DPI value of the device. + + + + + Gets the image file from given assembly based on the DPI scaling factor. + If the DPI scaling is greater than 175 then returns the high DPI image, otherwise returns the default image. + + The used to read the image file. + The string contains the folder path. + The string value represents the name of the image file. + The imageName must contains the extension like AddNewRowIcon.png or AddNewRowIcon.bmp + Returns the image file from specified folder path. + + + + Converts a logical DPI value to it's equivalent device unit DPI value. + + The logical value to convert. + Returns the equivalent device unit DPI value. + + + + Gets the current DPI value of the device. + + Returns the current DPI value of the device. + + + + Represents a class which contains resource manager that provides convenient access to culture-specific resources at run time. + + + + + The loader. + + + + + The resource manager. + + + + + Initializes a new instance of the class. + + + + + Sets the resource manager based on the assembly and namespace. + It can be used to get the values from the application resource files + when the assembly name and the namespace of the control or application is different. + + The control assembly. + The namespace of the control. + + + + Gets the localized string for the current culture. + + The string that need to be localized. + Returns the localized string. + + + + Gets the static object. + + Returns the value. + + + + Gets the localized ResourceManager. + + The assembly of the control. + The namespace of the control. + Returns the resource manager. + + + + Represents a class that provides the native methods. + + + + + The hook process delegates. + + The code + The window parameter. + The handle parameter. + Returns the pointer. + + + + The GetDC function retrieves a handle to a device context (DC) for the client area of a specified window or for the entire screen. + + A handle to the window whose DC is to be retrieved. If this value is NULL, GetDC retrieves the DC for the entire screen. + If the function succeeds, the return value is a handle to the DC for the specified window's client area. + If the function fails, the return value is NULL. + + + + Updates the position, size, shape, content, and translucency of a layered window. + + A handle to a layered window. A layered window is created by specifying WS_EX_LAYERED when creating the window with the CreateWindowEx function. + A handle to a DC for the screen. + A pointer to a structure that specifies the new screen position of the layered window. + Specifies the new size of the layered window. + A handle to a DC for the surface that defines the layered window. + A pointer to a structure that specifies the location of the layer in the device context. + A structure that specifies the color key to be used when composing the layered window. + A pointer to a structure that specifies the transparency value to be used when composing the layered window. + Use flag as the blend function + If the function succeeds, the return value is nonzero. Otherwise zero + + + + This function creates a rectangular region with rounded corners. + + Specifies the x-coordinate of the upper-left corner of the region in device units. + Specifies the y-coordinate of the upper-left corner of the region in device units. + Specifies the x-coordinate of the lower-right corner of the region in device units. + Specifies the y-coordinate of the lower-right corner of the region in device units. + Specifies the width of the ellipse used to create the rounded corners in device units. + Specifies the height of the ellipse used to create the rounded corners in device units. + If the function succeeds, the return value is the handle to the region. Otherwise return NULL + + + + Calls the next hook process. + + The hook. + The code. + The window handle parameter. + The handle parameter. + Returns the pointer. + + + + Sets the windows hook process. + + The hook id. + The process hook. + The pointer value. + The thread id + Returns the pointer value. + + + + The get window process id. + + The handle. + process id. + Returns the integer value. + + + + Unhook the window handle. + + The hook. + Returns the boolean value. + + + + Translate the message. + + The message. + Returns true if translate success. + + + + Dispatch message. + + The message. + Returns integer value. + + + + Peek the message. + + The message. + The handle. + The message minimum. + The maximum message. + The integer value. + Returns boolean value. + + + + Gets the parent of the given handle. + + The handle. + Returns the parent handle. + + + + The system parameter information. + + The action. + The parameter used to get the system information. + The current action parameter, + Window handle. + returns the integer value. + + + + Checks the focus. + + Returns the handle. + + + + Gets the current thread id. + + Returns the current thread id. + + + + Gets the extra information for the mouse event. + + The extra information provided by Windows API. + + + + Gets the system information. + + The index + Returns the index. + + + + Configures the messages that are sent from a window for Windows Touch gestures. + + A handle to the window to set the gesture configuration. + Its a reserved parameter, must be set to 0. + A count of the gesture configuration structures that are being passed. + An array of gesture configuration structures that specify the gesture configuration. + The size of the gesture configuration (GESTURECONFIG) structure. + Returns true if the configuration succeed, otherwise returns false. + + + + Configures the messages that are sent from a window for Windows Touch gestures. + + A handle to the window to set the gesture configuration. + Its a reserved parameter, must be set to 0. + A count of the gesture configuration structures that are being passed. + An array of gesture configuration structures that specify the gesture configuration. + The size of the gesture configuration (GESTURECONFIG) structure. + Returns true if the configuration succeed, otherwise returns false. + + + + Retrieves a GESTUREINFO structure given a handle to the gesture information. + + The Gesture information handle. + A pointer to the Gesture information structure. + If the function succeeds, the return value is nonzero. + + + + Moves the cursor to the specified screen coordinates. + If the new coordinates are not within the screen rectangle set by the most recent ClipCursor function call, the system automatically adjusts the coordinates so that the cursor stays within the rectangle. + + The new x-coordinate of the cursor, in screen coordinates. + The new y-coordinate of the cursor, in screen coordinates. + Returns nonzero if successful or zero otherwise. + + + + Changes the size, position, and Z order of a child, pop-up, or top-level window. These windows are ordered according to their appearance on the screen. The topmost window receives the highest rank and is the first window in the Z order. + + A Handle to the window. + A handle to the window to precede the positioned window in the Z order. + The new position of the left side of the window, in client coordinates. + The new position of the top of the window, in client coordinates. + The new width of the window, in pixels. + The new height of the window, in pixels. + The window sizing and positioning flags. + Returns the boolean value when position has set. + + + + The ScrollWindowEx function scrolls the contents of the specified window's client area. + + Handle to the window where the client area is to be scrolled. + Specifies the amount, in device units, of horizontal scrolling. This parameter must be a negative value to scroll to the left. + Specifies the amount, in device units, of vertical scrolling. This parameter must be a negative value to scroll up. + The portion of the client area to be scrolled. If this parameter is NULL, the entire client area is scrolled. + Contains the coordinates of the clipping rectangle. Only device bits within the clipping rectangle are affected. Bits scrolled from the outside of the rectangle to the inside are painted; bits scrolled from the inside of the rectangle to the outside are not painted. This parameter may be NULL. + Handle to the region that is modified to hold the region invalidated by scrolling. This parameter may be NULL. + Pointer to a RECT structure that receives the boundaries of the rectangle invalidated by scrolling. This parameter may be NULL. + Specifies flags that control scrolling. + Returns the boolean value. + + + + The SetScrollInfo function sets the parameters of a scroll bar, including the minimum and maximum scrolling positions, the page size, and the position of the scroll box (thumb). The function also redraws the scroll bar, if requested. + + Handle to a scroll bar control or a window with a standard scroll bar, depending on the value of the functionBar parameter. + Specifies the type of scroll bar for which to set parameters. This parameter can be one of the following values. + Pointer to a SCROLLINFO structure. Before calling SetScrollInfo, set the size member of the structure to sizeof(SCROLLINFO), set the fMask member to indicate the parameters to set, and specify the new parameter values in the appropriate members. + Specifies whether the scroll bar is redrawn to reflect the changes to the scroll bar. If this parameter is TRUE, the scroll bar is redrawn, otherwise, it is not redrawn. + The return value is the current position of the scroll box. + + + + The GetScrollInfo function retrieves the parameters of a scroll bar, including the minimum and maximum scrolling positions, the page size, and the position of the scroll box (thumb). + + Handle to a scroll bar control or a window with a standard scroll bar, depending on the value of the functionBar parameter. + Specifies the type of scroll bar for which to retrieve parameters. + Pointer to a SCROLLINFO structure. Before calling GetScrollInfo, set the size member to sizeof(SCROLLINFO), and set the fMask member to specify the scroll bar parameters to retrieve. Before returning, the function copies the specified parameters to the appropriate members of the structure. + If the function retrieved any values, the return value is nonzero otherwise the return zero. + + + + The GetScrollBarInfo function retrieves information about the specified scroll bar. + + Handle to a window associated with the scroll bar whose information is to be retrieved. If the idObject parameter is OBJID_CLIENT, hwnd is a handle to a scroll bar control. Otherwise, hwnd is a handle to a window created with WS_VSCROLL and/or WS_HSCROLL style. + Specifies the scroll bar object. This parameter can be one of the following values. + Pointer to a SCROLLBARINFO structure to receive the information. Before calling GetScrollBarInfo, set the cbSize member to sizeof(SCROLLBARINFO). + If the function succeeds, the return value is nonzero. + + + + The GetRegionData function fills the specified buffer with data describing a region. This data includes the dimensions of the rectangles that make up the region. + + A handle to the region. + The size, in bytes, of the lpRgnData buffer. + A pointer to a RGNDATA structure that receives the information. The dimensions of the region are in logical units. If this parameter is NULL, the return value contains the number of bytes needed for the region data. + If the function succeeds and dwCount specifies an adequate number of bytes, the return value is always dwCount. If dwCount is too small or the function fails, the return value is 0. If lpRgnData is NULL, the return value is the required number of bytes. + If the function fails, the return value is zero. + + + + Changes the parent window of the specified child window. + + A handle to the child window. + A handle to the new parent window. If this parameter is NULL, the desktop window becomes the new parent window. If this parameter is HWND_MESSAGE, the child window becomes a message-only window. + + If the function succeeds, the return value is a handle to the previous parent window. + If the function fails, the return value is NULL. To get extended error information, call GetLastError. + + + + + Retrieves a handle to a window that has the specified relationship (Z-Order or owner) to the specified window. + + A handle to a window. The window handle retrieved is relative to this window, based on the value of the uCmd parameter. + The relationship between the specified window and the window whose handle is to be retrieved. This parameter can be one of the following values. + + If the function succeeds, the return value is a window handle. If no window exists with the specified relationship to the specified window, the return value is NULL. To get extended error information, call GetLastError. + + + + + Retrieves information about the specified window. The function also retrieves the 32-bit (DWORD) value at the specified offset into the extra window memory. + + A handle to the window and, indirectly, the class to which the window belongs. + The zero-based offset to the value to be retrieved. Valid values are in the range zero through the number of bytes of extra window memory, minus four; + + If the function fails, the return value is zero. To get extended error information, call GetLastError. + + + + + Retrieves the dimensions of the bounding rectangle of the specified window. The dimensions are given in screen coordinates that are relative to the upper-left corner of the screen. + + A handle to the window. + A pointer to a RECT structure that receives the screen coordinates of the upper-left and lower-right corners of the window. + If the function succeeds, the return value is nonzero, otherwise return zero. + + + + Draws formatted text in the specified rectangle. + + A handle to the device context. + A pointer to the string that specifies the text to be drawn. If the nCount parameter is -1, the string must be null-terminated. + The length, in characters, of the string. If count is -1, then the textString parameter is assumed to be a pointer to a null-terminated string and DrawText computes the character count automatically. + A pointer to a RECT structure that contains the rectangle (in logical coordinates) in which the text is to be formatted. + The method of formatting the text. + If the function succeeds, the return value is the height of the text in logical units, else return zero. + + + + This function fills a rectangle by using the specified brush. This function includes the left and top borders, but excludes the right and bottom borders of the rectangle. + + A handle to the device context. + A pointer to a RECT structure that contains the logical coordinates of the rectangle to be filled. + A handle to the brush used to fill the rectangle. + If the function succeeds, the return value is nonzero else return zero. + + + + The DeleteObject function deletes a logical pen, brush, font, bitmap, region, or palette, freeing all system resources associated with the object. After the object is deleted, the specified handle is no longer valid. + + A handle to a logical pen, brush, font, bitmap, region, or palette. + If the function succeeds, the return value is nonzero, else return zero. + + + + The SelectObject function selects an object into the specified device context (DC). The new object replaces the previous object of the same type. + + A handle to the DC. + A handle to the object to be selected. + If the selected object is not a region and the function succeeds, the return value is a handle to the object being replaced. If the selected object is a region and the function succeeds, the return value is one of the following values. + + + + This method used to fill the gradient. + + A handle to the Device Context. + The array of objects. + The index of the vertex to be selected. + The array of objects. + The index of the object array to be selected. + The Gradient fill mode. + If the function fails, the return value is zero else return non zero value. + + + + The CreatePen function creates a logical pen that has the specified style, width, and color. The pen can subsequently be selected into a device context and used to draw lines and curves. + + The pen style. + The width of the pen, in logical units. If nWidth is zero, the pen is a single pixel wide, regardless of the current transformation. + A color reference for the pen color. + If the function succeeds, the return value is a handle that identifies a logical pen. If the function fails, the return value is NULL. + + + + This function fills a region by using the specified brush. + + A handle to the Device Context. + Handle to the region to be filled. The region's coordinates are presumed to be in logical units. + Handle to the brush to be used to fill the region. + If the function fails, the return value is zero else return non zero value. + + + + This function updates the current position to the specified point and optionally returns the previous position. + + A handle to the Device Context. + The x-coordinate of the upper-left corner of the rectangle. + The y-coordinate of the upper-left corner of the rectangle. + Pointer to a POINT structure that receives the previous current position. If this parameter is a NULL pointer, the previous position is not returned. + If the function fails, the return value is zero else return non zero value. + + + + This function draws a line from the current position up to, but not including, the specified point. + + A handle to the Device Context. + The x-coordinate of the upper-left corner of the rectangle. + The y-coordinate of the upper-left corner of the rectangle. + If the function fails, the return value is zero else return non zero value. + + + + This function creates a logical brush that has the specified style, color, and pattern. + + A pointer to a LOGBRUSH structure that contains information about the brush. + If the function succeeds, the return value identifies a logical brush. + If the function fails, the return value is NULL. + + + + This function creates a logical brush that has the specified solid color. + + The color of the brush. + If the function succeeds, the return value identifies a logical brush. If the function fails, the return value is NULL. + + + + This method used to draws the rectangle. + + A handle to the Device Context. + The left position of rectangle. + The top position of rectangle. + The right position of rectangle. + The bottom position of rectangle. + If the function succeeds, the return value is nonzero, else return zero. + + + + Creates a new image (icon, cursor, or bitmap) and copies the attributes of the specified image to the new one. + If necessary, the function stretches the bits to fit the desired size of the new image. + + A handle to the image to be copied. + The type of image to be copied. This parameter can be one of the following values. + The desired width, in pixels, of the image. If this is zero, then the returned image will have the same width as the original hImage. + The desired height, in pixels, of the image. If this is zero, then the returned image will have the same height as the original hImage. + This parameter can be one or more of the following values. + If the function succeeds, the return value is the handle to the newly created image. + If the function fails, the return value is NULL. + + + + This function displays an image and applies a visual effect to indicate a state, such as a disabled or default state. + + A handle to the device context to draw in. + A handle to the brush used to draw the image, if the state specified by the fuFlags parameter is DSS_MONO. This parameter is ignored for other states. + A pointer to an application-defined callback function used to render the image. This parameter is required if the image type in fuFlags is DST_COMPLEX. It is optional and can be NULL if the image type is DST_TEXT. + For all other image types, this parameter is ignored. + Information about the image. The meaning of this parameter depends on the image type. + The Information about the image. The meaning of this parameter depends on the image type. + The horizontal location, in device units, at which to draw the image. + The vertical location, in device units, at which to draw the image. + The width of the image, in device units. + The height of the image, in device units. + The image type and state. This parameter can be one of the following type values. + If the function fails, the return value is zero else return non zero value. + + + + Destroys an icon and frees any memory the icon occupied. + + A handle to the icon to be destroyed. The icon must not be in use. + If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. + + + + This function retrieves the dimensions of the tightest bounding rectangle that can be drawn around the current visible area on the device. + + A handle to the Device Context. + A pointer to a RECT structure that is to receive the rectangle dimensions, in logical units. + If the function succeeds, the return value specifies the clipping box's complexity and can be one of the following values. + + + + This function creates a new clipping region from the intersection of the current clipping region and the specified rectangle. + + A handle to the Device Context. + The x-coordinate, in logical units, of the upper-left corner of the rectangle. + The y-coordinate, in logical units, of the upper-left corner of the rectangle. + The x-coordinate, in logical units, of the lower-right corner of the rectangle. + The y-coordinate, in logical units, of the lower-right corner of the rectangle. + The return value specifies the new clipping region's type and can be one of the following values. + + + + Draws an image list item in the specified device context. + The function uses the specified drawing style and blends the image with the specified color. + + A handle to the image list + The index of the image to draw. + A handle to the destination device context. + The x-coordinate at which to draw within the specified device context. + The y-coordinate at which to draw within the specified device context. + The width of the portion of the image to draw relative to the upper-left corner of the image. + If width and height parameters are zero, the function draws the entire image. + The function does not ensure that the parameters are valid. + The height of the portion of the image to draw, relative to the upper-left corner of the image. + If width and height parameters are zero, the function draws the entire image. + The function does not ensure that the parameters are valid. + The background color of the image. + The foreground color of the image. + The drawing style and, optionally, the overlay image. + If the function fails, the return value is zero else return non zero value. + + + + This function selects a region as the current clipping region for the specified device context. + + A handle to the device context. + A handle to the region to be selected. + The return value specifies the region's complexity and can be one of the following values. + + + + This function creates a memory device context (DC) compatible with the specified device. + + A handle to an existing DC. If this handle is NULL, the function creates a memory DC compatible with the application's current screen. + If the function succeeds, the return value is the handle to a memory DC. If the function fails, the return value is NULL. + + + + This function retrieves the device context (DC) for the entire window, including title bar, menus, and scroll bars. + A window device context permits painting anywhere in a window, + because the origin of the device context is the upper-left corner of the window instead of the client area. + + A handle to the window with a device context that is to be retrieved. + If the function succeeds, the return value is a handle to a device context for the specified window. + If the function fails, the return value is NULL, indicating an error or an invalid windows handle parameter. + + + + Sends the specified message to a window or windows. + The SendMessage function calls the window procedure for the specified window and does not return until the window procedure has processed the message. + + A handle to the window whose window procedure will receive the message. + The message to be sent. + Additional message-specific information. + A Additional message-specific information. + The return value specifies the result of the message processing; it depends on the message sent. + + + + Sends the specified message to a window or windows. + The SendMessage function calls the window procedure for the specified window and does not return until the window procedure has processed the message. + + A handle to the window whose window procedure will receive the message. + The message to be sent. + Additional message-specific information. + A Additional message-specific information. + The return value specifies the result of the message processing; it depends on the message sent. + + + + Sends the specified message to a window or windows. + The SendMessage function calls the window procedure for the specified window and does not return until the window procedure has processed the message. + + A handle to the window whose window procedure will receive the message. + The message to be sent. + Additional message-specific information. + A Additional message-specific information. + The return value specifies the result of the message processing; it depends on the message sent. + + + + This function creates a bitmap compatible with the device that is associated with the specified device context. + + A handle to a device context. + The bitmap width, in pixels. + The bitmap height, in pixels. + If the function succeeds, the return value is a handle to the compatible bitmap (DDB). + If the function fails, the return value is NULL. + + + + Places (posts) a message in the message queue associated with the thread that created + the specified window and returns without waiting for the thread to process the message. + + A handle to the window whose window procedure is to receive the message. + The message to be posted. + Additional message-specific information. + A Additional message-specific information. + If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. + + + + This function sets the text color for the specified device context to the specified color. + + A handle to the device context. + The color of the text. + If the function succeeds, the return value is a color reference for the previous text color as a COLORREF value. + If the function fails, the return value is CLR_INVALID. + + + + This function sets the fore color for the specified device context to the specified color. + + A handle to the device context. + The background mode. + If the function succeeds, the return value specifies the previous background mode. + If the function fails, the return value is zero. + + + + Loads the specified module into the address space of the calling process. + The specified module may cause other modules to be loaded. + + The name of the module. + This can be either a library module or an executable module (an .exe file). + If the function succeeds, the return value is a handle to the module. + If the function fails, the return value is NULL. + + + + This function disables or enables drawing in the specified window. Only one window can be locked at a time. + + The window in which drawing will be disabled. If this parameter is NULL, drawing in the locked window is enabled. + + If the function succeeds, the return value is nonzero. + If the function fails, the return value is zero, indicating that an error occurred or another window was already locked. + + + + + This function posts messages when the mouse pointer leaves a window or hovers over a window for a specified amount of time. + + A pointer to a TRACKMOUSEEVENT structure that contains tracking information. + Returns zero if the function fails. Otherwise return non zero value + + + + This function creates a new clipping region that consists of the existing clipping region minus the specified rectangle. + + A handle to the device context. + The x-coordinate, in logical units, of the upper-left corner of the rectangle. + The y-coordinate, in logical units, of the upper-left corner of the rectangle. + The x-coordinate, in logical units, of the lower-right corner of the rectangle. + The y-coordinate, in logical units, of the lower-right corner of the rectangle. + The return value specifies the new clipping region's complexity + + + + This method performs a bit-block transfer of the color data corresponding to a rectangle of pixels from the specified source device context into a destination device context. + + A handle to the destination device context. + The x-coordinate, in logical units, of the upper-left corner of the destination rectangle. + The y-coordinate, in logical units, of the upper-left corner of the destination rectangle. + The width, in logical units, of the source and destination rectangles. + The height, in logical units, of the source and the destination rectangles. + A handle to the source device context. + The x-coordinate, in logical units, of the upper-left corner of the source rectangle. + The y-coordinate, in logical units, of the upper-left corner of the source rectangle. + A raster-operation code. These codes define how the color data for the source rectangle is to be combined with the color data for the destination rectangle to achieve the final color. + If the function succeeds the return value is nonzero, otherwise zero + + + + This function creates a rectangular region. + + Specifies the x-coordinate of the upper-left corner of the region. + Specifies the y-coordinate of the upper-left corner of the region. + Specifies the x-coordinate of the lower-right corner of the region. + Specifies the y-coordinate of the lower-right corner of the region. + If the function succeeds, the return value is the handle to the region. + If the function fails, the return value is NULL. + + + + This method determines the area within the window where the system permits drawing. + + A handle to the window whose window region is to be set. + A handle to a region.The function sets the window region of the window to this region. + Specifies whether the system redraws the window after setting the window region. + + If the function succeeds, the return value is the handle to the region. + If the function fails, the return value is NULL. + + + + + The DeleteDC function deletes the specified device context (DC). + + A handle to the device context. + + If the function succeeds, the return value is nonzero. + If the function fails, the return value is zero. + + + + + The RedrawWindow function updates the specified rectangle or region in a window's client area. + + A handle to the window to be redrawn. If this parameter is NULL, the desktop window is updated. + A pointer to a RECT structure containing the coordinates, in device units, of the update rectangle. This parameter is ignored if the region Update parameter identifies a region. + A handle to the update region. If both the region Update and Update parameters are NULL, the entire client area is added to the update region. + One or more redraw flags. This parameter can be used to invalidate or validate a window, control repainting, and control which windows are affected by RedrawWindow. + + If the function succeeds, the return value is nonzero. + If the function fails, the return value is zero. + + + + + The Offset Region function moves a region by the specified offsets. + + Handle to the region to be moved. + Specifies the number of logical units to move left or right. + Specifies the number of logical units to move up or down. + + The return value specifies the new region's complexity. + + + + + The Combine region function combines two regions and stores the result in a third region. The two regions are combined according to the specified mode. + + A handle to a new region with dimensions defined by combining two other regions. + A handle to the first of two regions to be combined. + A handle to the second of two regions to be combined. + A mode indicating how the two regions will be combined. + The return value specifies the type of the resulting region. + + + + Calculates the required size of the window rectangle. + + A pointer to a RECT structure that contains the coordinates of the top-left and bottom-right corners of the desired client area. + The window style of the window whose required size is to be calculated. + Indicates whether the window has a menu. + The extended window style of the window whose required size is to be calculated. + If the function succeeds, the return value is nonzero. + + + + Sets the value of Desktop Window Manager (DWM) non-client rendering attributes for a window. + + The handle to the window for which the attribute value is to be set. + A flag describing which value to set, specified as a value of the DWMWINDOWATTRIBUTE enumeration. + This parameter specifies which attribute to set, and the pvAttribute parameter points to an object containing the attribute value. + A pointer to an object containing the attribute value to set. The type of the value set depends on the value of the dwAttribute parameter. + The DWMWINDOWATTRIBUTE enumeration topic indicates, in the row for each flag, what type of value you should pass a pointer to in the pvAttribute parameter. + The size, in bytes, of the attribute value being set via the pvAttribute parameter. + The type of the value set, and therefore its size in bytes, depends on the value of the dwAttribute parameter. + If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error + + + + The BLENDFUNCTION structure controls blending by specifying the blending functions for source and destination bitmaps. + + + + + The source blend operation. + + + + + Must be zero. + + + + + Specifies an alpha transparency value to be used on the entire source bitmap. + The SourceConstantAlpha value is combined with any per-pixel alpha values in the source bitmap. + If you set SourceConstantAlpha to 0, it is assumed that your image is transparent. + Set the SourceConstantAlpha value to 255 (opaque) when you only want to use per-pixel alpha values. + + + + + This member controls the way the source and destination bitmaps are interpreted. + + + + + Used by the TrackMouseEvent function to track when the mouse pointer leaves a window + or hovers over a window for a specified amount of time. + + + + + The size of the TRACKMOUSEEVENT structure, in bytes. + + + + + The services requested. + + + + + A handle to the window to track. + + + + + The hover time-out (if TME_HOVER was specified in dwFlags), in milliseconds. + Can be HOVER_DEFAULT, which means to use the system default hover time-out. + + + + + The Message. + + + + + The handle. + + + + + The message. + + + + + The window parameter. + + + + + The handle parameter + + + + + The time. + + + + + The x position. + + + + + The y position + + + + + Contains information about the size and position of a window. + + + + + A handle to the window. + + + + + he position of the window in Z order (front-to-back position). + + + + + The position of the left edge of the window. + + + + + The position of the top edge of the window. + + + + + The window width, in pixels. + + + + + The window height, in pixels. + + + + + The window position. + + + + + Flags used by the DwmSetWindowAttribute function to specify the rounded corner preference for a window. + + + + + Options used by the DwmGetWindowAttribute and DwmSetWindowAttribute functions. + + + + + This function is an application-defined callback function that renders a complex image for the DrawState function. + + A handle to the Device Context. + Specifies information about the image, which the application passed to DrawState. + This specifies information about the image, which the application passed to DrawState. + The image width, in device units, as specified by the call to DrawState. + The image height, in device units, as specified by the call to DrawState. + If the function succeeds, the return value is TRUE. If the function fails, the return value is FALSE. + + + + Represents a class that provides the native methods for Painting. + + + + + Defines the constants that specify the type of inner and outer edges to draw. + + + + + Raised outer edge. + + + + + Sunken outer edge. + + + + + Raised inner edge. + + + + + Sunken inner edge. + + + + + Combination of BDR_RAISEDOUTER and BDR_SUNKENINNER + + + + + Combination of BDR_SUNKENOUTER and BDR_RAISEDINNER + + + + + Combination of BDR_RAISEDOUTER and BDR_RAISEDINNER. + + + + + Combination of BDR_SUNKENOUTER and BDR_SUNKENINNER. + + + + + Defines the constants that specify the type of border. + + + + + Left side of border rectangle. + + + + + Top of border rectangle. + + + + + Right side of border rectangle. + + + + + Bottom of border rectangle. + + + + + Entire border rectangle. + + + + + If this flag is passed, shrink the rectangle pointed to by the QRC parameter to exclude the edges that were drawn. + If this flag is not passed, then do not change the rectangle pointed to by the QRC parameter. + + + + + Flat border. + + + + + Interior of rectangle to be filled. + + + + + Defines the constants that specify the types of fill options for gradient style. + + + + + In this mode, two endpoints describe a rectangle. The rectangle is defined to have a constant color (specified by the TRIVERTEX structure) for the left and right edges. + GDI interpolates the color from the left to right edge and fills the interior. + + + + + In this mode, two endpoints describe a rectangle. The rectangle is defined to have a constant color (specified by the TRIVERTEX structure) for the top and bottom edges. + GDI interpolates the color from the top to bottom edge and fills the interior. + + + + + In this mode, an array of TRIVERTEX structures is passed to GDI along with a list of array indexes that describe separate triangles. + GDI performs linear interpolation between triangle vertices and fills the interior. Drawing is done directly in 24- and 32-bpp modes. + Dithering is performed in 16-, 8-, 4-, and 1-bpp mode. + + + + + Optional flag. + + + + + Defines the constants that specify the mouse handle types. + + + + + The journal record. + + + + + The journal play back. + + + + + The keyboard. + + + + + The get message. + + + + + The call window process. + + + + + The option + + + + + System message filter. + + + + + The mouse. + + + + + Hardware mode. + + + + + Debug mode. + + + + + The shell mode. + + + + + The fore ground idle mode. + + + + + Call window process. + + + + + Keyboard operations. + + + + + Mouse operations + + + + + Contains the information about the application and used to paint the client area of the window owned by that application. + + + + + Indicates whether the background must be erased. + This value is nonzero if the application should erase the background. + The application is responsible for erasing the background if a window class is created without a background brush. + + + + Left region of the rectangle. + + + Top region of the rectangle. + + + Right region of the rectangle. + + + Bottom region of the rectangle. + + + + Reserved; used internally by the system. + + + + + Reserved; used internally by the system. + + + + reserved value. + + + reserved value. + + + reserved value. + + + reserved value. + + + reserved value. + + + reserved value. + + + reserved value. + + + reserved value. + + + + A handle to the display DC to be used for painting. + + + + + Defines the coordinates of the upper-left and lower-right corners of a rectangle. + + + + + The left coordinate of the rectangle. + + + + + The top coordinate of the rectangle. + + + + + The right coordinate of the rectangle. + + + + + The bottom location of the rectangle. + + + + + Initializes a new instance of the struct. + + The Rectangle that need to convert to the RECT. + + + + Initializes a new instance of the struct. + + The x-coordinate of the upper-left corner of the rectangle. + The y-coordinate of the upper-left corner of the rectangle. + The x-coordinate of the lower-right corner of the rectangle. + The y-coordinate of the lower-right corner of the rectangle. + + + + Gets the width of the RECT. + + + + + Gets the Height of the RECT. + + + + + Convert the RECT to System.Drawing.Rectangle structure. + + The RECT region of the control. + Returns the rectangle. + + + + Return the co-ordinates of the rectangle in a string format. + + The string value of the rectangle region. + + + + Returns the RECT from the given values. + + The x-coordinate of the upper-left corner of the rectangle. + The y-coordinate of the upper-left corner of the rectangle. + The width of the rectangle. + The height of the rectangle. + Returns the new RECT value based on the given values. + + + + Provides the color information and position information. + + + + + The x-coordinate, in logical units, of the upper-left corner of the rectangle. + + + + + The y-coordinate, in logical units, of the upper-left corner of the rectangle. + + + + + The color information at the point of x, y. + + + + + The color information at the point of x, y. + + + + + The color information at the point of x, y. + + + + + The color information at the point of x, y. + + + + + Initializes a new instance of the struct. + + The X position. + The Y position. + The red color value. + The green color value. + The blue color value. + The alpha color value. + + + + Specifies the index of two vertices in the pVertex array in the GradientFill function. + These two vertices form the upper-left and lower-right boundaries of a rectangle. + + + + + The upper-left corner of a rectangle. + + + + + The lower-left corner of a rectangle. + + + + + Initializes a new instance of the struct. + + The top left position. + The bottom right position. + + + + Defines the style, color, and pattern of a physical brush. It is used by the CreateBrushIndirect and ExtCreatePen functions. + + + + + Specifies the brush style. + + + + + Specifies the color in which the brush is to be drawn. If LogBrushStyle is the BS_HOLLOW or BS_PATTERN style, + LogBrushColor is ignored. If LogBrushStyle is BS_DIBPATTERN or BS_DIBPATTERNBT, the low-order word of LogBrushColor specifies + whether the colors members of the BITMAPINFO structure contain explicit red, green, blue (RGB) + values or indices into the currently realized logical palette. + + + + + Specifies a hatch style. The meaning depends on the brush style defined by log brush Style. + + + + + Selects a red, green, blue (RGB) color based on the arguments supplied and the color capabilities of the output device. + + + + + The reserved fields. + + + + + The reserved fields. + + + + + The reserved fields. + + + + + The reserved fields. + + + + + Initializes a new instance of the struct. + + The color value. + + + + Convert the RGB color value to integer value. + + Returns the converted value. + + + + Information that a rich edit control uses to format its output for a particular device. + + + + + A HDC for the device to render to, if EM_FORMATRANGE is being used to send the output to a device. + + + + + An HDC for the target device to format for. + + + + + The area within the page rectangle to render to. + + + + + The entire area of a page on the rendering device. + + + + + The range of characters to format. + + + + + Specifies a range of characters in a rich edit control. + + + + + Character position index immediately preceding the first character in the range. + + + + + Character position immediately following the last character in the range. + + + + + Represents a mouse hook structure. + + + + + The X point + + + + + The y point + + + + + The pointer contains the window handle. + + + + + The hit test code. + + + + + The extra information. + + + + + The mouse hook structure. + + + + + The X position. + + + + + The Y position. + + + + + The mouse data. + + + + + The flags. + + + + + The time + + + + + The extra information. + + + + + Represents a class that provides the native methods for scrolling. + + + + + Defines the constant that used to specifies the scrollbar parameters. + + + + + The range of the scrollbar. + + + + + Page information. + + + + + Scroll position. + + + + + Returns or sets a value that determines whether scroll bars in the RichTextBox control are disabled. + + + + + Returns the position of the scrollbar thumb. + + + + + Specifies all the scrollbar information. + + + + + Defines the constants that used to specify the state of objects in an application UI. + + + + + For the scroll bar itself, indicates the specified vertical or horizontal scroll bar does not exist. + For the page up or page down regions, indicates the thumb is positioned such that the region does not exist. + + + + + For the scroll bar itself, indicates the window is sized such that the specified vertical or horizontal scroll bar is not currently displayed. + + + + + The arrow button or page region is pressed. + + + + + The component is disabled. + + + + + Contains the information about the scroll bar component. + + + + + Specifies the size of the structure. + + + + + Coordinates of the scroll bar as specified in a RECT structure. + + + + + Height or width of the thumb. + + + + + Top/Left position of the thumb. + + + + + Indicates the bottom/right position of the thumb. + + + + + Reserved variable. + + + + + An array of DWORD elements. Each element indicates the state of a scroll bar component. + + + + + Contains the information about the scrollbar parameters that are set by using SetScrollInfo method. + + + + + The size of the scroll info. + + + + + The mask value of the scroll info. + + + + + Specifies the minimum scrolling position. + + + + + Specifies the maximum scrolling position. + + + + + The nPage member contains the page size for a proportional scroll bar. + + + + + This contains the scroll box position, which is not updated while the user drags the scroll box. + + + + + This contains the current position of the scroll box while the user is dragging it. + + + + + Gets the rectangle region for the given offset. + + + + + Cracks the region. + + The pointer to the region. + Returns the RECT array. + + + + Gets the rectangle region. + + The buffer. + The header value. + The count. + Returns the RECT array. + + + + Converts the value to integer. + + The byte array. + The offset value. + Returns the integer value. + + + + Represents a class that provides native methods for Touch support. + + + + + Stores the information about the gesture. + + + + + The size of the structure, in bytes. The caller must set this to sizeof(GESTUREINFO). + + + + + The state of the gesture. + + + + + The identifier of the gesture command. + + + + + handle to window targeted by this gesture. + + + + + Current location of this gesture. These coordinates are always relative to the origin of the screen. + + + + + Internally used identifier for structure. + + + + + Internally used identifier for sequence. + + + + + Arguments for gestures whose arguments fit in 8 BYTES. + + + + + The size, in bytes, of extra arguments that accompany this gesture. + + + + + Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane. + + + + + Gets or sets the x-coordinate of this Point. + + + + + Gets or sets the Y-coordinate value of this Point. + + + + + Converts the x and y coordinate values to the point. + + Returns the point value. + + + + Gets and sets the configuration for enabling gesture messages and the type of this configuration. + + + + + The identifier for the type of configuration that will have messages enabled or disabled. + + + + + Settings related to gesture ID that are to be turned on. + + + + + Settings related to gesture ID that are to be turned off. + + + + + Gets and sets the gesture notification information for enable the gesture. + + + + + The size of the structure. + + + + + Reserved for future use. + + + + + The target window for the gesture notification. + + + + + The location of the gesture in physical screen coordinates. + + + + + A specific gesture instance with gesture messages starting with GID_BEGIN and ending with GID_END. + + + + + Represents a class that provides the options to paint the text and rotated text. + + + + + The flag which is used for drawing the text using the native methods. + + + + + The instance of used to draw the rich text content. + + + + + Draws the text in the specified rectangle based on the value. + + A handle to the device context. + String to measure. + that defines the text format of the string. + that specifies the maximum layout area for the text. + True - we use RTL, otherwise normal drawing. + + + + Draws the text in the specified rectangle based on the and + values. + + A handle to the device context. + String to measure. + that defines the text format of the string. + that specifies the maximum layout area for the text. + The text color. + True - we use RTL, otherwise normal drawing. + + + + Measures the string bounds based on the angle information. + + The actual string size value. + The angle value. + Returns the measured rotated string size value. + + + + Measures the string bounds based on the angle information. + + The graphics. + The string value used to measure the size. + The font value used to calculate the string bounds. + The width value. + A context. + The rotation angle. + Returns the measured string size based on the angle. + + + + Draws the text based on the rotation angle information. + + The graphics. + The String value used to measure the size. + The Font value used to calculate the string bounds. + The Brush information used to draw the string. + The Rectangle value used to draw the rotated string. + A context. + The rotation angle. + + + + Draws the text based on the rotation angle information. + + The graphics. + The string value used to measure the size. + The font value used to calculate the string bounds. + The brush information used to draw the string. + The rectangle value used to draw the rotated string. + A context. + The rotation angle. + + + + Calculates the size of the rich text box based on the font and text values. + + The string value contains rich text. + The preferred size used to draw the rich text. + The value. + A boolean value indicates rich text allows wrap text or not. + A value indicates the right to left mode. + Returns the size of the rich text box. + + + + Draws the rich text on the given graphics based on the text, font, fore color and wrap text mode. + + The graphics context. + The string value contains the rich text content. + The rectangle value used to draw the rich text. + + + + Draws the rich text on the given graphics based on the text, font, fore color and wrap text mode. + + The graphics context. + The string value contains the rich text content. + The rectangle value used to draw the rich text. + The font value used to draw the rich text. + The fore color value used to draw the rich text. + A boolean value indicates rich text allows wrap text or not. + A value indicates the right to left mode. + + + + Calculates the outside rectangle value based on the angle information. + + The actual rectangle value. + The angle value. + Returns the calculated outside rectangle value. + + + + Calculates the center of the rectangle value based on the size information. + + The actual rectangle value. + The size value. + Returns the rectangle value. + + + + Calculates the outside rectangle based on angle value. + + The actual rectangle value. + The angle value. + Returns the calculated outside rectangle value. + + + + Occurs content within the RichTextBox are resized. + + The source of the event. + A that contains the event data. + + + + Returns the rotated point value based on the angle information. + + The Point value. + The angle value. + Returns the calculated point value. + + + + Returns the rotated point value based on the angle and origin point values. + + The point which used to calculate. + The angle. + The origin point. + Returns the calculated point value. + + + + Returns the rotated points for creating the rectangle based on the angle information. + + The actual rectangle value. + The angle which used for calculate. + Returns the array of points. + + + + Returns the rotated points for creating the rectangle based on the angle and origin point values. + + The actual rectangle value. + The angle. + The origin point. + Returns the array point values. + + + + Represents a class that provide options to draw the rich text on the . + + + + + The constant value. + + + + + The constant value for format range. + + + + + The constant value for the transparent range. + + + + + Gets the required creation parameters when the control handle is created. + + + + + Draws the rich text box to the given device context. + + The device context. + The rectangle area to draw the rich text box. + + + + Represents a class that provides the list of window messages that are used in window process callback function. + + + + + One of the fields in GESTUREINFO structure is type of (8 bytes). + The relevant gesture information is stored in lower 4 bytes. This + bit mask is used to get 4 lower bytes from this argument. + + + + + Provides the chance for configure the gestures. + + Handling the WM_GESTURENOTIFY message will change the gesture configuration for the lifetime of the Window, not just for the next gesture. + + + + + + Passes the information about the gesture. + + + + + Indicates all the gestures. + + + + + Indicates generic gesture is begin. + + + + + Indicates generic gesture is end. + + + + + Indicates zoom start, zoom move, or zoom stop. + The first GID_ZOOM command message begins a zoom but does not cause any zooming. + The second GID_ZOOM command triggers a zoom relative to the state contained in the first GID_ZOOM. + + + + + Indicates pan move or pan start. + + + + + Indicates rotate move or rotate start. + + + + + Indicates the two finger tap gesture. + + + + + Indicates the press and tap gesture. + + + + + A gesture is starting. + + + + + Set the gesture is triggered inertia. + + + + + A gesture is finished. + + + + + Indicates all pan gesture. + + + + + Indicates the vertical panning with single finger. + + + + + Indicates the horizontal panning with single finger. + + + + + Limits perpendicular movement to primary direction until a threshold is reached to break out of the gutter. + + + + + Indicates panning with inertia to smoothly slow when pan gestures stop. + + + + + Indicates the window request for the paint. + + + + + Sent to the clipboard owner by a clipboard viewer window when the clipboard contains data in the CF_OWNERDISPLAY format and the clipboard viewer's client area needs repainting. + + + + + The WM_PAINTICON message is sent to a minimized window when the icon is to be painted but only if the application is written for Windows 3.x. + A window receives this message only if a class icon is defined for the window; otherwise, WM_PAINT is sent instead. + + + + + Indicates that the frame must need a paint. + + + + + Indicates the window requests to the redrawn. + + + + + Indicates the invalidate. + + + + + Causes a WM_PAINT message to be posted to the window regardless of whether the window contains an invalid region. + + + + + Causes the window to receive a WM_ERASEBKGND message when the window is repainted. The RDW_INVALIDATE flag must also be specified; otherwise RDW_ERASE has no effect. + + + + + Occurs while validating the entire window. This flag does not affect internal WM_PAINT messages. + + + + + Suppresses any pending internal WM_PAINT messages. This flag does not affect WM_PAINT messages resulting from invalid areas. + + + + + Suppress the pending WM_ERASEBKGND messages. + + + + + Excludes child windows, if any, from the repainting operation + + + + + Includes the child windows in the repainting operation. + + + + + Causes the affected windows (as specified by the RDW_ALLCHILDREN and RDW_NOCHILDREN flags) to receive WM_NCPAINT, WM_ERASEBKGND, and WM_PAINT messages, if necessary, before the function returns. + + + + + Causes the affected windows (as specified by the RDW_ALLCHILDREN and RDW_NOCHILDREN flags) to receive WM_NCPAINT and WM_ERASEBKGND messages, if necessary, before the function returns. + WM_PAINT messages are received at the ordinary time. + + + + + Causes any part of the non-client area of the window that intersects the update region to receive a WM_NCPAINT message. + The RDW_INVALIDATE flag must also be specified; otherwise, RDW_FRAME has no effect. + The WM_NCPAINT message is typically not sent during the execution of RedrawWindow unless either RDW_UPDATENOW or RDW_ERASENOW is specified. + + + + + Causes the window to receive a WM_ERASEBKGND message when the window is repainted. + The RDW_INVALIDATE flag must also be specified; otherwise, RDW_ERASE has no effect. + + + + + Justifies the text to the top of the rectangle + + + + + Aligns text to the left. + + + + + Centers text horizontally in the rectangle. + + + + + Aligns text to the right. + + + + + Centers text vertically. This value is used only with the DT_SINGLELINE value. + + + + + Justifies the text to the bottom of the rectangle. This value is used only with the DT_SINGLELINE value. + + + + + Breaks words. Lines are automatically broken between words if a word would extend past the edge of the + rectangle specified by the rectangle parameter. A carriage return-line feed sequence also breaks the line. + If this is not specified, output is on one line. + + + + + Displays text on a single line only. Carriage returns and line feeds do not break the line. + + + + + Expands tab characters. The default number of characters per tab is eight. The DT_WORD_ELLIPSIS, DT_PATH_ELLIPSIS, and DT_END_ELLIPSIS values cannot be used with the DT_EXPANDTABS value. + + + + + Sets tab stops. Bits 15-8 (high-order byte of the low-order word) of the uFormat parameter specify the number of characters for each tab. The default number of characters per tab is eight. The DT_CALCRECT, DT_EXTERNALLEADING, DT_INTERNAL, DT_NOCLIP, and DT_NOPREFIX values cannot be used with the DT_TABSTOP value. + + + + + Draws without clipping. DrawText is somewhat faster when DT_NOCLIP is used. + + + + + Includes the font external leading in line height. Normally, external leading is not included in the height of a line of text. + + + + + Determines the width and height of the rectangle. If there are multiple lines of text, + DrawText uses the width of the rectangle pointed to by the lpRect parameter and extends the base of the rectangle to bound the last line of text. If the largest word is wider than the rectangle, the width is expanded. If the text is less than the width of the rectangle, the width is reduced. If there is only one line of text, DrawText modifies the right side of the rectangle so that it bounds the last character in the line. In either case, DrawText returns the height of the formatted text but does not draw the text. + + + + + Turns off processing of prefix characters. Normally, DrawText interprets the mnemonic-prefix character as a directive to underscore the character that follows, and the mnemonic-prefix characters as a directive to print a single. By specifying DT_NOPREFIX, this processing is turned off. + + + + + Uses the system font to calculate text metrics. + + + + + Duplicates the text-displaying characteristics of a multi line edit control. Specifically, the average character width is calculated in the same manner as for an edit control, and the function does not display a partially visible last line. + + + + + For displayed text, replaces characters in the middle of the string with ellipses so that the result fits in the specified rectangle. If the string contains backslash (\) characters, DT_PATH_ELLIPSIS preserves as much as possible of the text after the last backslash. + + + + + For displayed text, if the end of a string does not fit in the rectangle, it is truncated and ellipses are added. If a word that is not at the end of the string goes beyond the limits of the rectangle, it is truncated without ellipses. + + + + + Modifies the specified string to match the displayed text. This value has no effect unless DT_END_ELLIPSIS or DT_PATH_ELLIPSIS is specified. + + + + + Layout in right-to-left reading order for bidirectional text when the font selected into the hdc is a Hebrew or Arabic font. The default reading order for all text is left-to-right. + + + + + Truncates any word that does not fit in the rectangle and adds ellipses. + + + + + Prevents a line break at a DBCS (double-wide character string), so that the line breaking rule is equivalent to SBCS strings. For example, this can be used in Korean windows, for more readability of icon labels. This value has no effect unless DT_WORDBREAK is specified. + + + + + Ignores the ampersand prefix character in the text. The letter that follows will not be underlined, but other mnemonic-prefix characters are still processed. + + + + + Draws only an underline at the position of the character following the ampersand prefix character. Does not draw any other characters in the string. + + + + + Occurs when the horizontal scrolling is made on the control or scrollbar. + + + + + Occurs when the window scroll event is occur on the vertical scrollbar. + + + + + Sent to the clipboard owner by a clipboard viewer window when the clipboard contains data in the CF_OWNERDISPLAY format and an event occurs in the clipboard viewer's horizontal scroll bar. The owner should scroll the clipboard image and update the scroll bar values. + + + + + Sent to the clipboard owner by a clipboard viewer window when the clipboard contains data in the CF_OWNERDISPLAY format and an event occurs in the clipboard viewer's vertical scroll bar. The owner should scroll the clipboard image and update the scroll bar values. + + + + + Occurs while the scroll bar is drawn. by handling this message user can customize the background color of the scrollbar. + + + + + Occurs while enable or disable both arrows in scrollbar. + + + + + Occurs when GridScrollPos is called. + + + + + Occurs when GetSCrollRange function is called. + + + + + Sent by an application to retrieve information about the specified scroll bar. + + + + + Occurs when SetScrollPos is called. + + + + + Occurs while setting the min and maximum range of the scroll control. + + + + + Occurs while setting the minimum and maximum position values and to redraw the control. + + + + + Occurs while setting the scroll info. + + + + + Erases the newly invalidated region by sending a WM_ERASEBKGND message to the window when specified with the SW_INVALIDATE flag. + + + + + Invalidates the region identified by the hrgnUpdate parameter after scrolling. + + + + + Scrolls all child windows that intersect the rectangle pointed to by the prcScroll parameter. The child windows are scrolled by the number of pixels specified by the dx and dy parameters. The system sends a WM_MOVE message to all child windows that intersect the prcScroll rectangle, even if they do not move. + + + + + Scrolls using smooth scrolling. Use the HIWORD portion of the flags parameter to indicate how much time, in milliseconds, the smooth-scrolling operation should take. + + + + + The window's vertical scroll bar. + + + + + The window's Horizontal scroll bar. + + + + + A scroll bar control + + + + + The horizontal scroll bar of the specified window. + + + + + The Thumb position of the scroll bar. + + + + + The vertical scroll bar of the specified window. + + + + + Disables the bottom arrow on a vertical scroll bar. + + + + + Disables the left arrow on a horizontal scroll bar. + + + + + Disables the right arrow on a horizontal scroll bar. + + + + + Disables the top arrow on a vertical scroll bar. + + + + + Sets the list-view control first item. + + + + + Scrolls the content of a list-view control. + + + + + Activates the window and displays it as a minimized window. + + + + + Activates the window and displays it as a maximized window. + + + + + Hides the window and activates another window. + + + + + Activates and displays a window. If the window is minimized or maximized, the system restores it to its original size and position. An application should specify this flag when displaying the window for the first time. + + + + + Represents the reflect window message. + + + + + Sent to both the window being activated and the window being deactivated. If the windows use the same input queue, the message is sent synchronously, first to the window procedure of the top-level window being deactivated, then to the window procedure of the top-level window being activated. If the windows use different input queues, the message is sent asynchronously, so the window is activated immediately. + + + + + Sent when a window belonging to a different application than the active window is about to be activated. The message is sent to the application whose window is being activated and to the application whose window is being deactivated. + + + + + Represents the window message Affix first. + + + + + Represents the window message Affix last. + + + + + Used to define private messages, usually of the form WM_APP+x, where x is an integer value. + + + + + Sent to the clipboard owner by a clipboard viewer window to request the name of a CF_OWNERDISPLAY clipboard format. + + + + + Posted to an application when a user cancels the application's journaling activities. The message is posted with a NULL window handle. + + + + + Sent to cancel certain modes, such as mouse capture. For example, the system sends this message to the active window when a dialog box or message box is displayed. Certain functions also send this message explicitly to the specified window regardless of whether it is the active window. For example, the EnableWindow function sends this message when disabling the specified window. + + + + + Sent to the window that is losing the mouse capture. + + + + + Sent to the first window in the clipboard viewer chain when a window is being removed from the chain. + + + + + An application sends the WM_CHANGEUISTATE message to indicate that the UI state should be changed. + + + + + Posted to the window with the keyboard focus when a WM_KEYDOWN message is translated by the TranslateMessage function. The WM_CHAR message contains the character code of the key that was pressed. + + + + + Sent by a list box with the LBS_WANTKEYBOARDINPUT style to its owner in response to a WM_CHAR message. + + + + + Sent to a child window when the user clicks the window's title bar or when the window is activated, moved, or sized. + + + + + An application sends the WM_CHOOSEFONT_GETLOGFONT message to a Font dialog box to retrieve information about the user's current font selections. + + + + + An application sends a WM_CLEAR message to an edit control or combo box to delete (clear) the current selection, if any, from the edit control. + + + + + Sent as a signal that a window or an application should terminate. + + + + + Sent when the user selects a command item from a menu, when a control sends a notification message to its parent window, or when an accelerator keystroke is translated. + + + + + Represents the common action is performed. + + + + + Sent to all top-level windows when the system detects more than 12.5 percent of system time over a 30- to 60-second interval is being spent compacting memory. This indicates that system memory is low. + + + + + Sent to determine the relative position of a new item in the sorted list of an owner-drawn combo box or list box. Whenever the application adds a new item, the system sends this message to the owner of a combo box or list box created with the CBS_SORT or LBS_SORT style. + + + + + Notifies a window that the user clicked the right mouse button (right-clicked) in the window. + + + + + An application sends the WM_COPY message to an edit control or combo box to copy the current selection to the clipboard in CF_TEXT format. + + + + + An application sends the WM_COPYDATA message to pass data to another application. + + + + + Sent when an application requests that a window be created by calling the CreateWindowEx or CreateWindow function. (The message is sent before the function returns.) The window procedure of the new window receives this message after the window is created, but before the window becomes visible. + + + + + The WM_CTLCOLORBTN message is sent to the parent window of a button before drawing the button. The parent window can change the button's text and background colors. However, only owner-drawn buttons respond to the parent window processing this message. + + + + + Sent to a dialog box before the system draws the dialog box. By responding to this message, the dialog box can set its text and background colors using the specified display device context handle. + + + + + An edit control that is not read-only or disabled sends the WM_CTLCOLOREDIT message to its parent window when the control is about to be drawn. By responding to this message, the parent window can use the specified device context handle to set the text and background colors of the edit control. + + + + + Sent to the parent window of a list box before the system draws the list box. By responding to this message, the parent window can set the text and background colors of the list box by using the specified display device context handle. + + + + + Send to owner window before draws the MessageBox. + + + + + A static control, or an edit control that is read-only or disabled, sends the WM_CTLCOLORSTATIC message to its parent window when the control is about to be drawn. By responding to this message, the parent window can use the specified device context handle to set the text foreground and background colors of the static control. + + + + + An application sends a WM_CUT message to an edit control or combo box to delete (cut) the current selection, if any, in the edit control and copy the deleted text to the clipboard in CF_TEXT format. + + + + + The WM_DDE_ACK message notifies a Dynamic Data Exchange (DDE) application of the receipt and processing of the following messages: WM_DDE_POKE, WM_DDE_EXECUTE, WM_DDE_DATA, WM_DDE_ADVISE, WM_DDE_UNADVISE, WM_DDE_INITIATE, or WM_DDE_REQUEST (in some cases). + + + + + A Dynamic Data Exchange (DDE) client application posts the WM_DDE_ADVISE message to a DDE server application to request the server to supply an update for a data item whenever the item changes. + To post this message, call the PostMessage function with the following parameters. + + + + + A Dynamic Data Exchange (DDE) server application posts a WM_DDE_DATA message to a DDE client application to pass a data item to the client or to notify the client of the availability of a data item. + + + + + A Dynamic Data Exchange (DDE) client application posts a WM_DDE_EXECUTE message to a DDE server application to send a string to the server to be processed as a series of commands. The server application is expected to post a WM_DDE_ACK message in response. + + + + + A Dynamic Data Exchange (DDE) client application posts a WM_DDE_FIRST message to a DDE server application to send a string to the server to be processed as a series of commands. The server application is expected to post a WM_DDE_ACK message in response. + + + + + A Dynamic Data Exchange (DDE) client application sends a WM_DDE_INITIATE message to initiate a conversation with a server application responding to the specified application and topic names. Upon receiving this message, all server applications with names that match the specified application and that support the specified topic are expected to acknowledge it. + + + + + A Dynamic Data Exchange (DDE) client application posts a WM_DDE_LAST message to a DDE server application. + + + + + A Dynamic Data Exchange (DDE) client application posts a WM_DDE_POKE message to a DDE server application. A client uses this message to request the server to accept an unsolicited data item. The server is expected to reply with a WM_DDE_ACK message indicating whether it accepted the data item. + + + + + A Dynamic Data Exchange (DDE) client application posts a WM_DDE_REQUEST message to a DDE server application to request the value of a data item. + + + + + A Dynamic Data Exchange (DDE) application (client or server) posts a WM_DDE_TERMINATE message to terminate a conversation. + + + + + A Dynamic Data Exchange (DDE) client application posts a WM_DDE_UNADVISE message to inform a DDE server application that the specified item or a particular clipboard format for the item should no longer be updated. This terminates the warm or hot data link for the specified item. + + + + + Posted to the window with the keyboard focus when a WM_KEYUP message is translated by the TranslateMessage function. WM_DEADCHAR specifies a character code generated by a dead key. A dead key is a key that generates a character, such as the umlaut (double-dot), that is combined with another character to form a composite character. For example, the umlaut-O character (Ö) is generated by typing the dead key for the umlaut character, and then typing the O key. + + + + + Sent to the owner of a list box or combo box when the list box or combo box is destroyed or when items are removed by the LB_DELETESTRING, LB_RESETCONTENT, CB_DELETESTRING, or CB_RESETCONTENT message. The system sends a WM_DELETEITEM message for each deleted item. The system sends the WM_DELETEITEM message for any deleted list box or combo box item with nonzero item data. + + + + + Sent when a window is being destroyed. It is sent to the window procedure of the window being destroyed after the window is removed from the screen. + This message is sent first to the window being destroyed and then to the child windows (if any) as they are destroyed. During the processing of the message, it can be assumed that all child windows still exist. + + + + + Sent to the clipboard owner when a call to the EmptyClipboard function empties the clipboard. + + + + + Notifies an application of a change to the hardware configuration of a device or the computer. + + + + + The WM_DEVMODECHANGE message is sent to all top-level windows whenever the user changes device-mode settings. + + + + + The WM_DISPLAYCHANGE message is sent to all windows when the display resolution has changed. + + + + + Sent to the first window in the clipboard viewer chain when the content of the clipboard changes. This enables a clipboard viewer window to display the new content of the clipboard. + + + + + Sent to the parent window of an owner-drawn button, combo box, list box, or menu when a visual aspect of the button, combo box, list box, or menu has changed. + + + + + Sent when the user drops a file on the window of an application that has registered itself as a recipient of dropped files. + + + + + Sent when an application changes the enabled state of a window. It is sent to the window whose enabled state is changing. This message is sent before the EnableWindow function returns, but after the enabled state (WS_DISABLED style bit) of the window has changed. + + + + + The WM_ENDSESSION message is sent to an application after the system processes the results of the WM_QUERYENDSESSION message. The WM_ENDSESSION message informs the application whether the session is ending. + + + + + Sent to the owner window of a modal dialog box or menu that is entering an idle state. A modal dialog box or menu enters an idle state when no messages are waiting in its queue after it has processed one or more previous messages. + + + + + Notifies an application's main window procedure that a menu modal loop has been entered. + + + + + Sent one time to a window after it enters the moving or sizing modal loop. The window enters the moving or sizing modal loop when the user clicks the window's title bar or sizing border, or when the window passes the WM_SYSCOMMAND message to the DefWindowProc function and the wParam parameter of the message specifies the SC_MOVE or SC_SIZE value. The operation is complete when DefWindowProc returns. + The system sends the WM_ENTERSIZEMOVE message regardless of whether the dragging of full windows is enabled. + + + + + Sent when the window background must be erased (for example, when a window is resized). The message is sent to prepare an invalidated portion of a window for painting. + + + + + Notifies an application's main window procedure that a menu modal loop has been exited. + + + + + Sent one time to a window, after it has exited the moving or sizing modal loop. The window enters the moving or sizing modal loop when the user clicks the window's title bar or sizing border, or when the window passes the WM_SYSCOMMAND message to the DefWindowProc function and the wParam parameter of the message specifies the SC_MOVE or SC_SIZE value. The operation is complete when DefWindowProc returns. + + + + + An application sends the WM_FONTCHANGE message to all top-level windows in the system after changing the pool of font resources. + + + + + Sent to the window procedure associated with a control. By default, the system handles all keyboard input to the control; the system interprets certain types of keyboard input as dialog box navigation keys. To override this default behavior, the control can respond to the WM_GETDLGCODE message to indicate the types of input it wants to process itself. + + + + + Retrieves the font with which the control is currently drawing its text. + + + + + Sent to determine the hot key associated with a window. + + + + + Sent to a window to retrieve a handle to the large or small icon associated with a window. The system displays the large icon in the ALT+TAB dialog, and the small icon in the window caption. + + + + + Sent to a window when the size or position of the window is about to change. An application can use this message to override the window's default maximized size and position, or its default minimum or maximum tracking size. + + + + + Sent by both Microsoft Active Accessibility and Microsoft UI Automation to obtain information about an accessible object contained in a server application. + + + + + Copies the text that corresponds to a window into a buffer provided by the caller. + + + + + Determines the length, in characters, of the text associated with a window. + + + + + Represents the window message that handled first. + + + + + Represents the window message that handled last. + + + + + Indicates that the user pressed the F1 key. If a menu is active when F1 is pressed, WM_HELP is sent to the window associated with the menu; otherwise, WM_HELP is sent to the window that has the keyboard focus. If no window has the keyboard focus, WM_HELP is sent to the currently active window. + + + + + Posted when the user presses a hot key registered by the RegisterHotKey function. The message is placed at the top of the message queue associated with the thread that registered the hot key. + + + + + This message is sent to a minimized window when the background of the icon must be filled before painting the icon. A window receives this message only if a class icon is defined for the window; otherwise, WM_ERASEBKGND is sent. + + + + + Sent to an application when the IME gets a character of the conversion result. + + + + + Sent to an application when the IME changes composition status as a result of a keystroke. A window receives this message through its WindowProc function. + + + + + Sent to an application when the IME window finds no space to extend the area for the composition window. + + + + + Sent by an application to direct the IME window to carry out the requested command. The application uses this message to control the IME window that it has created. To send this message, the application calls the SendMessage function with the following parameters. + + + + + Sent to an application when the IME ends composition. A window receives this message through its WindowProc function. + + + + + Sent to an application by the IME to notify the application of a key press and to keep message order. + + + + + Sent to an application by the IME to notify the application of a key last and to keep message order. + + + + + Sent to an application by the IME to notify the application of a key release and to keep message order + + + + + Sent to an application to notify it of changes to the IME window. + + + + + Sent to an application when the operating system is about to change the current IME. + + + + + Sent to an application when a window is activated. + + + + + Sent immediately before the IME generates the composition string as a result of a keystroke. + + + + + Sent to the dialog box procedure immediately before a dialog box is displayed. Dialog box procedures typically use this message to initialize controls and carry out any other initialization tasks that affect the appearance of the dialog box. + + + + + Sent when a menu is about to become active. It occurs when the user clicks an item on the menu bar or presses a menu key. This allows the application to modify the menu before it is displayed. + + + + + Sent when a drop-down menu or submenu is about to become active. This allows an application to modify the menu before it is displayed, without changing the entire menu. + + + + + Sent to the topmost affected window after an application's input language has been changed. You should make any application-specific settings and pass the message to the DefWindowProc function, which passes the message to all first-level child windows. These child windows can pass the message to DefWindowProc to have it pass the message to their child windows, and so on. + + + + + Posted to the window with the focus when the user chooses a new input language, either with the hotkey (specified in the Keyboard control panel application) or from the indicator on the system taskbar. An application can accept the change by passing the message to the DefWindowProc function or reject the change (and prevent it from taking place) by returning immediately. + + + + + Posted to the window with the keyboard focus when a nonsystem key is pressed. A nonsystem key is a key that is pressed when the ALT key is not pressed. + + + + + This message filters for keyboard messages. + + + + + This message filters for keyboard messages. + + + + + Posted to the window with the keyboard focus when a nonsystem key is released. A nonsystem key is a key that is pressed when the ALT key is not pressed, or a keyboard key that is pressed when a window has the keyboard focus. + + + + + Sent to a window immediately before it loses the keyboard focus. + + + + + Posted when the user double-clicks the left mouse button while the cursor is in the client area of a window. If the mouse is not captured, the message is posted to the window beneath the cursor. Otherwise, the message is posted to the window that has captured the mouse. + + + + + Posted when the user presses the left mouse button while the cursor is in the client area of a window. If the mouse is not captured, the message is posted to the window beneath the cursor. Otherwise, the message is posted to the window that has captured the mouse. + + + + + Posted when the user releases the left mouse button while the cursor is in the client area of a window. If the mouse is not captured, the message is posted to the window beneath the cursor. Otherwise, the message is posted to the window that has captured the mouse. + + + + + Posted when the user double-clicks the middle mouse button while the cursor is in the client area of a window. If the mouse is not captured, the message is posted to the window beneath the cursor. Otherwise, the message is posted to the window that has captured the mouse. + + + + + Posted when the user presses the middle mouse button while the cursor is in the client area of a window. If the mouse is not captured, the message is posted to the window beneath the cursor. Otherwise, the message is posted to the window that has captured the mouse. + + + + + Posted when the user releases the middle mouse button while the cursor is in the client area of a window. If the mouse is not captured, the message is posted to the window beneath the cursor. Otherwise, the message is posted to the window that has captured the mouse. + + + + + An application sends the WM_MDIACTIVATE message to a multiple-document interface (MDI) client window to instruct the client window to activate a different MDI child window. + + + + + An application sends the WM_MDICASCADE message to a multiple-document interface (MDI) client window to arrange all its child windows in a cascade format. + + + + + An application sends the WM_MDICREATE message to a multiple-document interface (MDI) client window to create an MDI child window. + + + + + An application sends the WM_MDIDESTROY message to a multiple-document interface (MDI) client window to close an MDI child window. + + + + + An application sends the WM_MDIGETACTIVE message to a multiple-document interface (MDI) client window to retrieve the handle to the active MDI child window. + + + + + An application sends the WM_MDIICONARRANGE message to a multiple-document interface (MDI) client window to arrange all minimized MDI child windows. It does not affect child windows that are not minimized. + + + + + An application sends the WM_MDIMAXIMIZE message to a multiple-document interface (MDI) client window to maximize an MDI child window. The system resizes the child window to make its client area fill the client window. The system places the child window's window menu icon in the rightmost position of the frame window's menu bar, and places the child window's restore icon in the leftmost position. + The system also appends the title bar text of the child window to that of the frame window. + + + + + An application sends the WM_MDINEXT message to a multiple-document interface (MDI) client window to activate the next or previous child window. + + + + + An application sends the WM_MDIREFRESHMENU message to a multiple-document interface (MDI) client window to refresh the window menu of the MDI frame window. + + + + + An application sends the WM_MDIRESTORE message to a multiple-document interface (MDI) client window to restore an MDI child window from maximized or minimized size. + + + + + An application sends the WM_MDISETMENU message to a multiple-document interface (MDI) client window to replace the entire menu of an MDI frame window, to replace the window menu of the frame window, or both. + + + + + An application sends the WM_MDITILE message to a multiple-document interface (MDI) client window to arrange all of its MDI child windows in a tile format. + + + + + Sent to the owner window of a combo box, list box, list-view control, or menu item when the control or menu is created. + + + + + Sent when a menu is active and the user presses a key that does not correspond to any mnemonic or accelerator key. This message is sent to the window that owns the menu. + + + + + Sent to a menu's owner window when the user selects a menu item. + + + + + Sent when the cursor is in an inactive window and the user presses a mouse button. The parent window receives this message only if the child window passes it to the DefWindowProc function. + + + + + Specify the first mouse message. + + + + + Posted to a window when the cursor hovers over the client area of the window for the period of time specified in a prior call to TrackMouseEvent. + + + + + Posted to a window to get the last mouse position. + + + + + Posted to a window when the cursor leaves the client area of the window specified in a prior call to TrackMouseEvent. + + + + + Posted to a window when the cursor moves. If the mouse is not captured, the message is posted to the window that contains the cursor. Otherwise, the message is posted to the window that has captured the mouse. + + + + + Sent to the focus window when the mouse wheel is rotated. The DefWindowProc function propagates the message to the window's parent. There should be no internal forwarding of the message, since DefWindowProc propagates it up the parent chain until it finds a window that processes it. + + + + + Sent after a window has been moved. + + + + + Sent while window is in moving. + + + + + Sent to a window when its non client area needs to be changed to indicate an active or inactive state. + + + + + Sent when the size and position of a window's client area must be calculated. By processing this message, an application can control the content of the window's client area when the size or position of the window changes. + + + + + Sent prior to the WM_CREATE message when a window is first created. + + + + + Notifies a window that its non client area is being destroyed. The DestroyWindow function sends the WM_NCDESTROY message to the window following the WM_DESTROY message.WM_DESTROY is used to free the allocated memory object associated with the window. + The WM_NCDESTROY message is sent after the child windows have been destroyed. In contrast, WM_DESTROY is sent before the child windows are destroyed. + + + + + Sent to a window in order to determine what part of the window corresponds to a particular screen coordinate. This can happen, for example, when the cursor moves, when a mouse button is pressed or released, or in response to a call to a function such as WindowFromPoint. If the mouse is not captured, the message is sent to the window beneath the cursor. Otherwise, the message is sent to the window that has captured the mouse. + + + + + Posted when the user double-clicks the left mouse button while the cursor is within the non-client area of a window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. + + + + + Posted when the user presses the left mouse button while the cursor is within the non-client area of a window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. + + + + + Posted when the user releases the left mouse button while the cursor is within the non-client area of a window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. + + + + + Posted when the user double-clicks the middle mouse button while the cursor is within the non-client area of a window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. + + + + + Posted when the user presses the middle mouse button while the cursor is within the non-client area of a window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. + + + + + Posted when the user releases the middle mouse button while the cursor is within the non-client area of a window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. + + + + + Posted to a window when the cursor hovers over the non-client area of the window for the period of time specified in a prior call to TrackMouseEvent. + + + + + Posted to a window when the cursor leaves the non-client area of the window specified in a prior call to TrackMouseEvent. + + + + + Posted to a window when the cursor is moved within the non-client area of the window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. + + + + + Posted when the user double-clicks the right mouse button while the cursor is within the non-client area of a window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. + + + + + Posted when the user presses the right mouse button while the cursor is within the non-client area of a window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. + + + + + Posted when the user releases the right mouse button while the cursor is within the non-client area of a window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. + + + + + Sent to a dialog box procedure to set the keyboard focus to a different control in the dialog box. + + + + + Sent to an application when the right or left arrow key is used to switch between the menu bar and the system menu. + + + + + Sent by a common control to its parent window when an event has occurred or the control requires some information. + + + + + Determines if a window accepts ANSI or Unicode structures in the WM_NOTIFY notification message. WM_NOTIFYFORMAT messages are sent from a common control to its parent window and from the parent window to the common control. + + + + + Performs no operation. An application sends the WM_NULL message if it wants to post a message that the recipient window will ignore. + + + + + The WM_PALETTECHANGED message is sent to all top-level and overlapped windows after the window with the keyboard focus has realized its logical palette, thereby changing the system palette. This message enables a window that uses a color palette but does not have the keyboard focus to realize its logical palette and update its client area. + + + + + The WM_PALETTEISCHANGING message informs applications that an application is going to realize its logical palette. + + + + + Sent to a window when a significant action occurs on a descendant window. This message is now extended to include the WM_POINTERDOWN event. When the child window is being created, the system sends WM_PARENTNOTIFY just before the CreateWindow or CreateWindowEx function that creates the window returns. When the child window is being destroyed, the system sends the message before any processing to destroy the window takes place. + + + + + An application sends a WM_PASTE message to an edit control or combo box to copy the current content of the clipboard to the edit control at the current caret position. Data is inserted only if the clipboard contains data in CF_TEXT format. + + + + + The pend that creates first for the drawing. + + + + + The pend that creates last for the drawing. + + + + + Notifies applications that the system, typically a battery-powered personal computer, is about to enter a suspended mode. + + + + + Notifies applications that a power-management event has occurred. + + + + + The WM_PRINT message is sent to a window to request that it draw itself in the specified device context, most commonly in a printer device context. + + + + + The WM_PRINTCLIENT message is sent to a window to request that it draw its client area in the specified device context, most commonly in a printer device context. + Unlike WM_PRINT, WM_PRINTCLIENT is not processed by DefWindowProc. A window should process the WM_PRINTCLIENT message through an application-defined WindowProc function for it to be used properly. + + + + + Notifies the hook procedure of a Page Setup dialog box, PagePaintHook, that the dialog box is about to draw the envelope-stamp rectangle of the sample page. + + + + + Notifies a PagePaintHook hook procedure of the coordinates of the sample page rectangle in the Page Setup dialog box. The dialog box sends this message when it is about to draw the contents of the sample page. + + + + + Notifies the hook procedure of a Page Setup dialog box, PagePaintHook, that the dialog box is about to draw Greek text inside the margin rectangle of the sample page. + + + + + Notifies the hook procedure of a Page Setup dialog box, PagePaintHook, that the dialog box is about to draw the margin rectangle of the sample page. + + + + + Notifies a PagePaintHook hook procedure of the coordinates of the margin rectangle in the sample page. A Page Setup dialog box sends this message when it is about to draw the contents of the sample page. + + + + + Notifies a PagePaintHook hook procedure that the Page Setup dialog box is about to draw the contents of the sample page. The hook procedure can use this message to carry out initialization tasks related to drawing the contents of the sample page. + + + + + Notifies the hook procedure of a Page Setup dialog box, PagePaintHook, that the dialog box is about to draw the return address portion of an envelope sample page. + + + + + Sent to a minimized (iconic) window. The window is about to be dragged by the user but does not have an icon defined for its class. An application can return a handle to an icon or cursor. The system displays this cursor or icon while the user drags the icon. + + + + + The WM_QUERYENDSESSION message is sent when the user chooses to end the session or when an application calls one of the system shutdown functions. If any application returns zero, the session is not ended. The system stops sending WM_QUERYENDSESSION messages as soon as one application returns zero. + After processing this message, the system sends the WM_ENDSESSION message with the wParam parameter set to the results of the WM_QUERYENDSESSION message. + + + + + The WM_QUERYNEWPALETTE message informs a window that it is about to receive the keyboard focus, giving the window the opportunity to realize its logical palette when it receives the focus. + + + + + Sent to an icon when the user requests that the window be restored to its previous size and position. + + + + + An application sends the WM_QUERYUISTATE message to retrieve the UI state for a window. + + + + + Sent by a computer-based training (CBT) application to separate user-input messages from other messages sent through the WH_JOURNALPLAYBACK procedure. + + + + + Indicates a request to terminate an application, and is generated when the application calls the PostQuitMessage function. This message causes the GetMessage function to return zero. + + + + + Posted when the user double-clicks the right mouse button while the cursor is in the client area of a window. If the mouse is not captured, the message is posted to the window beneath the cursor. Otherwise, the message is posted to the window that has captured the mouse. + + + + + Posted when the user presses the right mouse button while the cursor is in the client area of a window. If the mouse is not captured, the message is posted to the window beneath the cursor. Otherwise, the message is posted to the window that has captured the mouse. + + + + + Posted when the user releases the right mouse button while the cursor is in the client area of a window. If the mouse is not captured, the message is posted to the window beneath the cursor. Otherwise, the message is posted to the window that has captured the mouse. + + + + + Sent to the clipboard owner before it is destroyed, if the clipboard owner has delayed rendering one or more clipboard formats. For the content of the clipboard to remain available to other applications, the clipboard owner must render data in all the formats it is capable of generating, and place the data on the clipboard by calling the SetClipboardData function. + + + + + Sent to the clipboard owner if it has delayed rendering a specific clipboard format and if an application has requested data in that format. The clipboard owner must render data in the specified format and place it on the clipboard by calling the SetClipboardData function. + + + + + Sent to a window if the mouse causes the cursor to move within a window and mouse input is not captured. + + + + + Sent to a window after it has gained the keyboard focus. + + + + + Sets the font that a control is to use when drawing text. + + + + + Sent to a window to associate a hot key with the window. When the user presses the hot key, the system activates the window. + + + + + Associates a new large or small icon with a window. The system displays the large icon in the ALT+TAB dialog box, and the small icon in the window caption. + + + + + Sets the text of a window. + + + + + A message that is sent to all top-level windows when the SystemParametersInfo function changes a system-wide setting or when policy settings have changed. + + + + + Sent to a window when the window is about to be hidden or shown. + + + + + Sent to a window after its size has changed. + + + + + Sent to the clipboard owner by a clipboard viewer window when the clipboard contains data in the CF_OWNERDISPLAY format and the clipboard viewer's client area has changed size. + + + + + Sent to a window that the user is resizing. By processing this message, an application can monitor the size and position of the drag rectangle and, if needed, change its size or position. + + + + + The WM_SPOOLERSTATUS message is sent from Print Manager whenever a job is added to or removed from the Print Manager queue. + + + + + Sent to a window after the SetWindowLong function has changed one or more of the window's styles. + + + + + Sent to a window when the SetWindowLong function is about to change one or more of the window's styles. + + + + + Posted to the window with the keyboard focus when a WM_SYSKEYDOWN message is translated by the TranslateMessage function. It specifies the character code of a system character key — that is, a character key that is pressed while the ALT key is down. + + + + + The WM_SYSCOLORCHANGE message is sent to all top-level windows when a change is made to a system color setting. + + + + + A window receives this message when the user chooses a command from the Window menu (formerly known as the system or control menu) or when the user chooses the maximize button, minimize button, restore button, or close button. + + + + + Sent to the window with the keyboard focus when a WM_SYSKEYDOWN message is translated by the TranslateMessage function. WM_SYSDEADCHAR specifies the character code of a system dead key — that is, a dead key that is pressed while holding down the ALT key. + + + + + Posted to the window with the keyboard focus when the user presses the F10 key (which activates the menu bar) or holds down the ALT key and then presses another key. It also occurs when no window currently has the keyboard focus; in this case, the WM_SYSKEYDOWN message is sent to the active window. The window that receives the message can distinguish between these two contexts by checking the context code in the lParam parameter. + + + + + Posted to the window with the keyboard focus when the user releases a key that was pressed while the ALT key was held down. It also occurs when no window currently has the keyboard focus; in this case, the WM_SYSKEYUP message is sent to the active window. The window that receives the message can distinguish between these two contexts by checking the context code in the lParam parameter. + + + + + Sent to an application that has initiated a training card with Windows Help. The message informs the application when the user clicks an authorable button. An application initiates a training card by specifying the HELP_TCARD command in a call to the WinHelp function. + + + + + A message that is sent whenever there is a change in the system time. + + + + + Posted to the installing thread's message queue when a timer expires. The message is posted by the GetMessage or PeekMessage function. + + + + + An application sends a WM_UNDO message to an edit control to undo the last operation. When this message is sent to an edit control, the previously deleted text is restored or the previously added text is deleted. + + + + + An application sends the WM_UPDATEUISTATE message to change the UI state for the specified window and all its child windows. + + + + + Used to define private messages for use by private window classes, usually of the form WM_USER+x, where x is an integer value. + + + + + Sent to all windows after the user has logged on or off. When the user logs on or off, the system updates the user-specific settings. The system sends this message immediately after updating the settings. + + + + + Sent by a list box with the LBS_WANTKEYBOARDINPUT style to its owner in response to a WM_KEYDOWN message. + + + + + Sent to a window whose size, position, or place in the Z order has changed as a result of a call to the SetWindowPos function or another window-management function. + + + + + Sent to a window whose size, position, or place in the Z order is about to change as a result of a call to the SetWindowPos function or another window-management function. + + + + + An application sends the WM_WININICHANGE message to all top-level windows after making a change to the WIN.INI file. The SystemParametersInfo function sends this message after an application uses the function to change a setting in WIN.INI. + + + + + The window is an overlapped window. An overlapped window has a title bar and a border. Same as the WS_TILED style. + + + + + The windows is a pop-up window. This style cannot be used with the WS_CHILD style. + + + + + The window is a child window. A window with this style cannot have a menu bar. This style cannot be used with the WS_POPUP style. + + + + + The window is initially minimized. Same as the WS_ICONIC style. + + + + + The window is initially visible. + This style can be turned on and off by using the ShowWindow or SetWindowPos function. + + + + + The window is initially disabled. A disabled window cannot receive input from the user. To change this after a window has been created, use the EnableWindow function. + + + + + Clips child windows relative to each other; that is, when a particular child window receives a WM_PAINT message, the WS_CLIPSIBLINGS style clips all other overlapping child windows out of the region of the child window to be updated. If WS_CLIPSIBLINGS is not specified and child windows overlap, it is possible, when drawing within the client area of a child window, to draw within the client area of a neighboring child window. + + + + + Excludes the area occupied by child windows when drawing occurs within the parent window. This style is used when creating the parent window. + + + + + The window is initially maximized. + + + + + The window has a title bar (includes the WS_BORDER style). + + + + + The window has a thin-line border. + + + + + The window has a border of a style typically used with dialog boxes. A window with this style cannot have a title bar. + + + + + The window has a vertical scroll bar. + + + + + The window has a horizontal scroll bar. + + + + + The window has a window menu on its title bar. The WS_CAPTION style must also be specified. + + + + + The window has a sizing border. Same as the WS_SIZEBOX style. + + + + + The window is a control that can receive the keyboard focus when the user presses the TAB key. Pressing the TAB key changes the keyboard focus to the next control with the WS_TABSTOP style. + + + + + The window has a minimize button. Cannot be combined with the WS_EX_CONTEXTHELP style. The WS_SYSMENU style must also be specified. + + + + + The window has a maximize button. Cannot be combined with the WS_EX_CONTEXTHELP style. The WS_SYSMENU style must also be specified. + + + + + The window has a double border; the window can, optionally, be created with a title bar by specifying the WS_CAPTION style in the dwStyle parameter. + + + + + The window is a MDI child window. + + + + + The window is intended to be used as a floating toolbar. A tool window has a title bar that is shorter than a normal title bar, and the window title is drawn using a smaller font. A tool window does not appear in the taskbar or in the dialog that appears when the user presses ALT+TAB. If a tool window has a system menu, its icon is not displayed on the title bar. However, you can display the system menu by right-clicking or by typing ALT+SPACE. + + + + + The window has a border with a sunken edge. + + + + + The title bar of the window includes a question mark. When the user clicks the question mark, the cursor changes to a question mark with a pointer. If the user then clicks a child window, the child receives a WM_HELP message. The child window should pass the message to the parent window procedure, which should call the WinHelp function using the HELP_WM_HELP command. The Help application displays a pop-up window that typically contains help for the child window. + WS_EX_CONTEXTHELP cannot be used with the WS_MAXIMIZEBOX or WS_MINIMIZEBOX styles. + + + + + The window has generic "right-aligned" properties. This depends on the window class. This style has an effect only if the shell language is Hebrew, Arabic, or another language that supports reading-order alignment; otherwise, the style is ignored. + + + + + The window has generic left-aligned properties. This is the default. + + + + + If the shell language is Hebrew, Arabic, or another language that supports reading-order alignment, the window text is displayed using right-to-left reading-order properties. For other languages, the style is ignored. + + + + + If the shell language is Hebrew, Arabic, or another language that supports reading order alignment, the vertical scroll bar (if present) is to the left of the client area. For other languages, the style is ignored. + + + + + The window itself contains child windows that should take part in dialog box navigation. If this style is specified, the dialog manager recursive into children of this window when performing navigation operations such as handling the TAB key, an arrow key, or a keyboard mnemonic. + + + + + The window has a three-dimensional border style intended to be used for items that do not accept user input. + + + + + Forces a top-level window onto the task-bar when the window is visible. + + + + + The window is a layered window. This style cannot be used if the window has a class style of either CS_OWNDC or CS_CLASSDC. + + + + + The window should be placed above all non-topmost windows and should stay above them, even when the window is deactivated. To add or remove this style, use the SetWindowPos function. + + + + + The window has a border with a raised edge. + + + + + The window has a border with a raised edge. + + + + + If the shell language is Hebrew, Arabic, or another language that supports reading order alignment, the horizontal origin of the window is on the right edge. Increasing horizontal values advance to the left. + + + + + Sizes the window. + + + + + Moves the window. + + + + + Minimizes the window. + + + + + Maximizes the window. + + + + + Closes the window. + + + + + Retrieves the window menu as a result of a mouse click. + + + + + Retrieves the window menu as a result of a keystroke. For more information, see the Remarks section. + + + + + Restores the window to its normal position and size. + + + + + Changes the cursor to a question mark with a pointer. If the user then clicks a control in the dialog box, the control receives a WM_HELP message. + + + + + Selects the default item; the user double-clicked the window menu. + + + + + Activates the window associated with the application-specified hot key. The lParam parameter identifies the window to activate. + + + + + This message enables or disables the OK button for the Browse For Folder dialog box. + + + + + This message indicates that the selection in the dialog box changed. + + + + + This message sets the status text in the Browse For Folder dialog box. + + + + + Sets the text that is displayed on the dialog box's OK button. + + + + + Specifies the path of a folder to expand in the Browse dialog box. The path can be specified as a Unicode string or a PIDL. + + + + + The dialog box has finished initializing. + + + + + This message indicates that the selection in the dialog box changed. + + + + + The user typed an invalid name into the dialog's edit box. A nonexistent folder is considered an invalid name. + + + + + An IUnknown interface is available to the dialog box. + + + + + The retrieved handle identifies the window of the same type that is highest in the Z order. + + + + + The retrieved handle identifies the window of the same type that is lowest in the Z order. + + + + + The retrieved handle identifies the window below the specified window in the Z order. + + + + + The retrieved handle identifies the window above the specified window in the Z order. + + + + + The retrieved handle identifies the specified window's owner window, if any. For more information, see Owned Windows. + + + + + The retrieved handle identifies the child window at the top of the Z order, if the specified window is a parent window; otherwise, the retrieved handle is NULL. The function examines only child windows of the specified window. It does not examine descendant windows. + + + + + The retrieved handle identifies the enabled popup window owned by the specified window (the search uses the first such window found using GW_HWNDNEXT); otherwise, if there are no enabled popup windows, the retrieved handle is that of the specified window. + + + + + Sets a new address for the window procedure. + You cannot change this attribute if the window does not belong to the same process as the calling thread. + + + + + Index to change the parent of a child window. + + + + + Sets a new window style. + + + + + Sets a new extended window style. + + + + + Sets a new identifier of the child window. The window cannot be a top-level window. + + + + + Enables the drop shadow effect on a window. + + + + + Copies the source rectangle directly to the destination rectangle. + + + + + Returns a DC that corresponds to the window rectangle rather than the client rectangle. + + + + + Returns a DC from the cache, rather than the OWNDC or CLASSDC window. Essentially overrides CS_OWNDC and CS_CLASSDC. + + + + + The clipping region identified by hrgnClip is intersected with the visible region of the returned DC. + + + + + Allows drawing even if there is a LockWindowUpdate call in effect that would otherwise exclude this window. Used for drawing during tracking. + + + + + Uses the visible region of the parent window. The parent's WS_CLIPCHILDREN and CS_PARENTDC style bits are ignored. The origin is set to the upper-left corner of the window identified by hWnd. + + + + + Excludes the visible regions of all sibling windows above the window identified by hWnd. + + + + + Excludes the visible regions of all child windows below the window identified by hWnd. + + + + + The clipping region identified by hrgnClip is excluded from the visible region of the returned DC. + + + + + Creates the intersection of the two combined regions. + + + + + Creates the union of two combined regions. + + + + + Creates the union of two combined regions except for any overlapping areas. + + + + + Combines the parts of hrgnSrc1 that are not part of hrgnSrc2. + + + + + Creates a copy of the region identified by hrgnSrc1. + + + + + Gets the formatting rectangle of an edit control. + + + + + Gets information about the character closest to a specified point in the client area of an edit control. + + + + + A WM_KEYUP, WM_KEYDOWN, WM_SYSKEYUP, or WM_SYSKEYDOWN message is in the queue. + + + + + A WM_MOUSEMOVE message is in Queue. + + + + + A mouse-button message (WM_LBUTTONUP, WM_RBUTTONDOWN, and so on). + + + + + A posted message (other than those listed here) is in the queue. + + + + + A WM_TIMER message is in the queue. + + + + + A WM_PAINT message is in the queue. + + + + + A message sent by another thread or application is in the queue. + + + + + A WM_HOTKEY message is in the queue. + + + + + A posted message (other than those listed here) is in the queue. + + + + + A raw input message is in the queue. For more information, see Raw Input. + + + + + A WM_MOUSEMOVE message or mouse-button message (WM_LBUTTONUP, WM_RBUTTONDOWN, and so on). + + + + + An input message is in the queue. + + + + + An input, WM_TIMER, WM_PAINT, WM_HOTKEY, or posted message is in the queue. + + + + + Any message is in the queue. + + + + + The state of the specified object is signaled. + + + + + The time-out interval elapsed, and the object's state is non-signaled. + + + + + A constant used to specify an infinite waiting period, for threading methods that accept an Int32 parameter. + + + + + Retains the current size (ignores the cx and cy parameters). + + + + + Retains the current position (ignores X and Y parameters). + + + + + Retains the current Z order (ignores the hWndInsertAfter parameter). + + + + + Does not redraw changes. If this flag is set, no repainting of any kind occurs. This applies to the client area, the non-client area (including the title bar and scroll bars), and any part of the parent window uncovered as a result of the window being moved. When this flag is set, the application must explicitly invalidate or redraw any parts of the window and parent window that need redrawing. + + + + + Does not activate the window. If this flag is not set, the window is activated and moved to the top of either the topmost or non-topmost group (depending on the setting of the hWndInsertAfter parameter). + + + + + Applies new frame styles set using the SetWindowLong function. Sends a WM_NCCALCSIZE message to the window, even if the window's size is not being changed. If this flag is not specified, WM_NCCALCSIZE is sent only when the window's size is being changed. + + + + + Displays the window. + + + + + Hides the window. + + + + + Discards the entire contents of the client area. If this flag is not specified, the valid contents of the client area are saved and copied back into the client area after the window is sized or repositioned. + + + + + Does not change the owner window's position in the Z order. + + + + + Prevents the window from receiving the WM_WINDOWPOSCHANGING message. + + + + + Retrieves the bounding rectangle of the Windows task bar. + + + + + Retrieves the size of the work area on the primary display monitor. + + + + + Bottom edge. + + + + + Left edge. + + + + + Right edge. + + + + + Top edge. + + + + + Provides a representation of an object so it can be displayed as an embedded object inside of a container. + This value is typically specified for compound document objects. + The presentation can be provided for the screen or printer. + + + + + Represents the transparent or irregular parts of on object, typically parts that are expensive or impossible to clip out. + Objects may or may not support this aspect. + + + + + Represents the opaque, easy to clip parts of an object. Objects may or may not support this aspect. + + + + + Represents the bits per pixel. + + + + + Represents the adding of pixel in horizontal. + + + + + Represents the adding of pixel in vertical. + + + + + Represents the planes. + + + + + Activates the window, and does not discard the mouse message. + + + + + Activates the window, and discards the mouse message. + + + + + Does not activate the window, and does not discard the mouse message. + + + + + Does not activate the window, but discards the mouse message. + + + + + On the screen background or on a dividing line between windows (same as HTNOWHERE, except that the DefWindowProc function produces a system beep to indicate an error). + + + + + On the screen background or on a dividing line between windows. + + + + + In a client area. + + + + + In a title bar. + + + + + In a window menu or in a Close button in a child window. + + + + + In a size box (same as HTSIZE). + + + + + In a menu. + + + + + In a Minimize button. + + + + + In a Maximize button. + + + + + In the lower-left corner of a border of a re-sizable window (the user can click the mouse to resize the window diagonally). + + + + + In the lower-right corner of a border of a re-sizable window (the user can click the mouse to resize the window diagonally). + + + + + In the lower corner of a border of a re-sizable window (the user can click the mouse to resize the window diagonally). + + + + + In the right corner of a border of a re-sizable window (the user can click the mouse to resize the window diagonally). + + + + + In the top corner of a border of a re-sizable window (the user can click the mouse to resize the window diagonally). + + + + + In the top-left corner of a border of a re-sizable window (the user can click the mouse to resize the window diagonally). + + + + + In the top-right corner of a border of a re-sizable window (the user can click the mouse to resize the window diagonally). + + + + + In the left corner of a border of a re-sizable window (the user can click the mouse to resize the window diagonally). + + + + + In the border of a window that does not have a sizing border. + + + + + In a Close button. + + + + + In a Help button. + + + + + Places the window at the top of the Z order. + + + + + Places the window at the bottom of the Z order. If the hWnd parameter identifies a topmost window, the window loses its topmost status and is placed at the bottom of all other windows. + + + + + Places the window above all non-topmost windows. The window maintains its topmost position even when it is deactivated. + + + + + Places the window above all non-topmost windows (that is, behind all topmost windows). This flag has no effect if the window is already a non-topmost window. + + + + + The left mouse button is down. + + + + + The right mouse button is down. + + + + + The middle mouse button is down. + + + + + The CTRL key is down. + + + + + The middle mouse button is down. + + + + + Indicates the deactivated. + + + + + Activated by some method other than a mouse click (for example, by a call to the SetActiveWindow function or by use of the keyboard interface to select the window). + + + + + Activated by a mouse click. + + + + + A Notification is delivered as a WM_MOUSELEAVE message. + If the mouse is not over the specified window or area, + a leave notification is generated immediately and no further tracking is performed. + + + + + If the mouse is hover on or leave from the non client areas + a notification is delivered as WM_NCMOUSEHOVER and WM_NCMOUSELEAVE messages. + + + + + The constant value for scroll. + + + + + Specifies the change in the ListProperty. Used by Changing and Changed events of strong typed collections. + + + + + An item is appended. + + + + + An item is removed. + + + + + An item is inserted. + + + + + An item is moved. + + + + + The whole collection is changed. + + + + + An item is replaced. + + + + + A nested property of an item is changed. + + + + + Defines the constants that specifies the style of the tooltip. + + + + + Indicates that the tooltip should be drawn as regular rectangle. + + + + + Indicates that the tooltip should be drawn as balloon. + + + + + Defines the constants that specifies the options of image alignment. + + + + + Image is aligned at the left. + + + + + Image is aligned at the right. + + + + + Defines the constants that specifies the location of the tooltip. + + + + + Indicates that the tooltip will be shown in its mouse position. If ToolTipStyle is Balloon, will be shown in TopRight of mouse position. Otherwise, BottomRight of the mouse position. + + + + + Indicates that the tooltip should be shown in TopLeft of the mouse position. + + + + + Indicates that the tooltip should be shown in TopRight of the mouse position. + + + + + Indicates that the tooltip should be shown in TopCenter of the mouse position. + + + + + Indicates that the tooltip should be shown in BottomLeft of the mouse position. + + + + + Indicates that the tooltip should be shown in BottomRight of the mouse position. + + + + + Indicates that the tooltip should be shown in BottomCenter of the mouse position. + + + + + Indicates that the tooltip should be shown in RightCenter of the mouse position. + + + + + Indicates that the tooltip should be shown in LeftCenter of the mouse position. + + + + + Defines the constants that specifies the type of auto scrolling. + + + + + An user has dragged the mouse outside the auto scroll bounds. + + + + + An user is moving the mouse over the control during OLE drag-and-drop operation. + + + + + Defines the constants that specifies auto scrolling direction. + + + + + No auto scrolling. + + + + + Only horizontal auto scrolling. + + + + + Only vertical auto scrolling. + + + + + Both horizontal and vertical auto scrolling. + + + + + Defines the constants that specifies the scrollbar regions. + + + + + Sets no region. + + + + + Indicates the minimum button region. + + + + + Indicates the Maximum button region. + + + + + Indicates the Thumb region. + + + + + Indicates the up or left rectangle of the scrollbar thumb. + + + + + Indicates the right or bottom rectangle of the scrollbar thumb. + + + + + Defines the length of the scrollbar regions. + + + + + Specifies the state of a button. + + + + + The button has its normal appearance. + + + + + The button appears pressed. + + + + + The button is inactive. + + + + + The mouse hover on the button. + + + + + The focus state of the button. + + + + + Represents the class that provides the accessibility object for the SfForm. + + + + + Specifies the SfForm for the accessibility object. + + + + + Initializes a new instance of the class. + + The SfForm. + + + + Gets the AccessibleRole of the . + + + + + Gets the AccessibleName of the . + + + + + Gets the accessibility object of the parent. + + + + + Gets the AccessibleDescription of the . + + + + + Gets the bounds of the . + + + + + Overridden to update the child count of the SfForm. + + Returns the child count of the Form. + + + + Overridden to return the inner elements of the form. + + The index of the child. + Returns the accessibility object of the child. + + + + Represents the class that provides the accessibility object for the SfForm TitleBar. + + + + + Specifies the parent form of the title bar. + + + + + Initializes a new instance of the class. + + The parent of the title bar. + + + + Gets the AccessibleRole of the . + + + + + Gets the AccessibleName of the . + + + + + Gets the accessibility object of the parent. + + + + + Gets the AccessibleDescription of the . + + + + + Gets the bounds of the . + + + + + Gets the child count of the form. + + Returns the count of the accessibility object. + + + + Gets the child accessibility object of the TitleBar. + + The index of the child. + Returns the accessibility object of the child control with the given index. + + + + Represents the class that provides the accessibility object for the SfForm TitleBar. + + + + + Specifies the parent for the Title bar. + + + + + Specifies the index of the child. + + + + + Initializes a new instance of the class. + + The parent form of the title bar. + The index of the child. + + + + Gets the AccessibleRole of the . + + + + + Gets the AccessibleName of the . + + + + + Gets the accessibility object of the parent. + + + + + Gets the AccessibleDescription of the . + + + + + Gets the bounds of the . + + + + + Provides storage for the object. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + Represents the class that defines the MDI style information for the control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + A that holds data for this object. + All changes in this style object will be saved in the object. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Gets the default style of the MDI form. + + + + + Gets or sets the background color of the MDI form titlebar. + + + + + Gets or sets the backcolor for the MDI form icon. + + + + + Gets or sets the horizontal alignment of the MDI form title bar icon. + + The default value is left. + + + + Gets or sets the vertical alignment of the MDI form title bar icon. + + The default value is center. + + + + Gets or sets the fore color of the MDI form close button. + + + + + Gets or sets the fore color of the MDI form maximize button. + + + + + Gets or sets the fore color of the MDI form minimize button. + + + + + Gets or sets the fore color of the MDI form help button. + + + + + Gets or sets the hover fore color for the MDI form close button. + + + + + Gets or sets the hover fore color for the MDI form maximize button. + + + + + Gets or sets the hover fore color for the MDI form minimize button. + + + + + Gets or sets the hover fore color for the MDI form help button. + + + + + Gets or sets the hover back color for the MDI form close button. + + + + + Gets or sets the hover back color for the MDI form maximize button. + + + + + Gets or sets the hover back color for the MDI form minimize button. + + + + + Gets or sets the hover back color for the MDI help button. + + + + + Gets or sets the pressed fore color of the MDI form close button. + + + + + Gets or sets the pressed fore color of the MDI form maximize button. + + + + + Gets or sets the pressed fore color of the MDI form minimize button. + + + + + Gets or sets the pressed fore color of the MDI form help button. + + + + + Gets or sets the pressed background color of the MDI form close button. + + + + + Gets or sets the pressed background color of the MDI form maximize button. + + + + + Gets or sets the pressed background color of the MDI form minimize button. + + + + + Gets or sets the pressed background color of the MDI form help button. + + + + + Gets or sets the image for the MDI form close button. + + The default value is null. + + + + Gets or sets the hover image for the MDI form close button. + + The default value is null. + + + + Gets or sets the pressed image for the MDI form close button. + + The default value is null. + + + + Gets or sets the image for the MDI form maximize button. + + The default value is null. + + + + Gets or sets the hover image for the MDI form maximize button. + + The default value is null. + + + + Gets or sets the pressed image for the MDI form maximize button. + + The default value is null. + + + + Gets or sets the image for the MDI form minimize button. + + The default value is null. + + + + Gets or sets the hover image for the MDI form minimize button. + + The default value is null. + + + + Gets or sets the pressed image for the MDI form minimize button. + + The default value is null. + + + + Gets or sets the image for the MDI form help button. + + The default value is null. + + + + Gets or sets the hover image for the MDI form help button. + + The default value is null. + + + + Gets or sets the pressed image for the MDI form help button. + + The default value is null. + + + + Gets or sets the height of the MDI form title bar. + + + + + Gets or sets the size of the MDI form close button. + + + + + Gets or sets the size of the MDI form maximize button. + + + + + Gets or sets the size of the MDI form minimize button. + + + + + Gets or sets the size of the MDI form help button. + + + + + Determines a value that indicates whether to serialize the CloseButtonSize property or not. + + returns true if serialized; Otherwise false + + + + Determines a value that indicates whether to serialize the MaximizeButtonSize property or not. + + returns true if serialized; Otherwise false + + + + Determines a value that indicates whether to serialize the MinimizeButtonSize property or not. + + returns true if serialized; Otherwise false + + + + Determines a value that indicates whether to serialize the HelpButtonSize property or not. + + returns true if serialized; Otherwise false + + + + Makes an exact copy of the current object. + + The new owner style object for the copied object. + The identifier for this object. + A copy of the current object registered with the new owner style object. + + + + Provide the default style of the MDI form. + + Default style object. + + + + Provides storage for the object. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + + + + + Represents the class to define the style for control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Gets the default style of the form. + + + + + Gets or sets the style information of the MDI form. + + + + + Gets or sets the style information of the caption bar. + + + + + Gets or sets the back color of the control. + + + + + Gets or sets the fore color of the control. + + + + + Gets or sets the selected state border of the control. + + + The width of the active state border and inactive state border should be same. + + + + + Gets or sets the inactive state border of the control. + + + The width of the active state border and inactive state border should be same. + + + + + Gets or sets the opacity of the form's shadow in selected state. + + The value should be from 0 to 255. + + + + Gets or sets the opacity of the form's shadow in normal state. + + The value should be from 0 to 255. + + + + Gets or sets the active state border of the control. + + + + + Gets or sets the inactive state border of the control. + + + + + Override this method to create a product-specific identity object for a sub object. + + An identity object for a sub object of this style. + + The following code is an example how Essential form creates FormVisualStyleInfoSubObjectIdentity: + + public override StyleInfoSubObjectIdentity CreateSubObjectIdentity(StyleInfoProperty sip) + { + return new FormVisualStyleInfoSubObjectIdentity(this, sip); + } + + + The . + + + + Provide the default style of the form. + + Default style object. + + + + Defines a class that provides style identity information for nested objects of the VisualStyleInfo class of the control. + + + + + Initializes a new instance of the class and associates it with a specified. + + The that owns this sub-object. + The descriptor for this expandable sub-object. + + + + Implements the class that provide the identity information of + using . + + + + + Maintains the SfDataGrid for create the identity. + + + + + Initializes a new instance of the class. + + + to create an identity. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + A instance of + + Returns the . + + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Represents the class that defines the title bar style information for the control. + + + + + It contains the value of the property. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class and associates it with an existing . + + A that holds the identity for this . + A that holds data for this object. + All changes in this style object will be saved in the object. + + + + + Initializes a new instance of the class and associates it with an existing . + + A that holds the identity for this . + + + + Gets the default style of the TitleBar bar. + + + + + Gets or sets a value indicating whether rich text can be provided as caption or not. + + The default value is false. + + + this.Style.TitleBar.AllowRichText = true; + // Set rich text for the Form.Text property. + this.Text = "{\\rtf\\ansi \\b Form1}"; + + + + + + Gets or sets the pressed fore color of the close button. + + + + + Gets or sets the pressed fore color of the maximize button. + + + + + Gets or sets the pressed fore color of the minimize button. + + + + + Gets or sets the pressed fore color of the help button. + + + + + Gets or sets the pressed background color of the close button. + + + + + Gets or sets the pressed background color of the maximize button. + + + + + Gets or sets the pressed background color of the minimize button. + + + + + Gets or sets the pressed background color of the help button. + + + + + Gets or sets the hover fore color for the close button. + + + + + Gets or sets the hover fore color for the maximize button. + + + + + Gets or sets the hover fore color for the minimize button. + + + + + Gets or sets the hover fore color for the help button. + + + + + Gets or sets the hover back color for the close button. + + + + + Gets or sets the hover back color for the maximize button. + + + + + Gets or sets the hover back color for the minimize button. + + + + + Gets or sets the hover back color for the help button. + + + + + Gets or sets the fore color of the close button. + + + + + Gets or sets the fore color of the maximize button. + + + + + Gets or sets the fore color of the minimize button. + + + + + Gets or sets the fore color of the help button. + + + + + Gets or sets the foreground color of the TitleBar. + + + + + Gets or sets the background color of the TitleBar. + + + + + Gets or sets the bottom border color of the TitleBar. + + + + + Gets or sets the height of the TitleBar. + + + + + Gets or sets the padding for the . + + + + + Gets or sets the backcolor for the icon + + + + + Gets or sets the horizontal alignment of the title bar icon. + + The default value is left. + + + + Gets or sets the vertical alignment of the title bar icon. + + The default value is center. + + + + Gets or sets the horizontal alignment of the title bar text. + + The default value is left. + + + + Gets or sets the vertical alignment of the title Bar text. + + The default value is center. + + + + Gets or sets the image for the close button. + + The default value is null. + + + + Gets or sets the hover image for the close button. + + The default value is null. + + + + Gets or sets the pressed image for the close button. + + The default value is null. + + + + Gets or sets the image for the maximize button. + + The default value is null. + + + + Gets or sets the hover image for the maximize button. + + The default value is null. + + + + Gets or sets the pressed image for the maximize button. + + The default value is null. + + + + Gets or sets the image for the minimize button. + + The default value is null. + + + + Gets or sets the hover image for the minimize button. + + The default value is null. + + + + Gets or sets the pressed image for the minimize button. + + The default value is null. + + + + Gets or sets the image for the help button. + + The default value is null. + + + + Gets or sets the hover image for the help button. + + The default value is null. + + + + Gets or sets the image to the caption bar. + + The default value is null. + + + + Gets or sets the location to the caption image. + + + + + Gets or sets the pressed image for the help button. + + The default value is null. + + + + Gets or sets the size of the close button. + + + + + Gets or sets the size of the maximize button. + + + + + Gets or sets the size of the minimize button. + + + + + Gets or sets the size of the help button. + + + + + Gets or sets the Font used to display text in the title bar. + + + + this.Style.TitleBar.Font = new Font("Segoe UI", 15, FontStyle.Bold); + + + + + + Gets a value indicating whether Font has been initialized for the TitleBar. + + + + + Determines a value that indicates whether to serialize the Font property or not. + + returns true if serialized; Otherwise false + + + + Determines a value that indicates whether to serialize the CloseButtonSize property or not. + + returns true if serialized; Otherwise false + + + + Determines a value that indicates whether to serialize the MaximizeButtonSize property or not. + + returns true if serialized; Otherwise false + + + + Determines a value that indicates whether to serialize the MinimizeButtonSize property or not. + + returns true if serialized; Otherwise false + + + + Determines a value that indicates whether to serialize the HelpButtonSize property or not. + + returns true if serialized; Otherwise false + + + + Makes an exact copy of the current object. + + The new owner style object for the copied object. + The identifier for this object. + A copy of the current object registered with the new owner style object. + + + + Provide the default style of the TitleBar bar. + + Default style object. + + + + Determines a value that indicates whether to serialize the property or not. + + returns true if serialized; Otherwise false + + + + Determines a value that indicates whether to serialize the property or not. + + returns true if serialized; Otherwise false + + + + Determines a value that indicates whether to serialize the property or not. + + returns true if serialized; Otherwise false + + + + Provides storage for the object. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + It contains the value of the property value. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets the static data value of the class. + + + + + Initializes the , if is null. + + Returns the property value. + + + + Represents a store which holds the properties of the object. + + + + + Provides information about the BorderColor property. + + + + + Provides information about the BorderThickness property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the BeakBackColor property. + + + + + Provides the StaticData of the . + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Provides the StaticData of the . + + + + + Initializes the StaticData, if is null. + + Returns the StaticData. + + + + Implements the functionalities that holds all information stored for a . + + + + + The default ToolTipStyleInfo. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A that holds the identity for this . + + + + Initializes a new instance of the class. + + A that holds the identity for this . + A that holds data for this object. + All changes in this style object will be saved in the object. + + + + + Gets the default style of the . + + + + + Gets or sets the foreground color of the . + + + + + Gets or sets the background color of the . + + + + + Gets or sets the font of the . + + + + + Gets or sets the TextAlignment of the . + + + + + Gets or sets the GradientBrush of the , + if is true. + + + + + Gets or sets the separator color of the to draw separator, + if is true. + + + + + Gets or sets the separator style of the to draw separator, + if is true. + + + + + Gets or sets the separator pattern of the to draw separator, + if is true, + when is set as Custom. + + + + + Gets or sets the alignment of the image on the . + + + If the has both the text and image and is set, + the image will be positioned based on the alignment settings and text will be positioned just opposite alignment. + i.e. if an image is aligned to left, text will be aligned to right position. + + + + + Gets or sets the size of the . + + + + + Gets or sets the offset space between the image and text of the tooltip item. + + + + + Gets a value indicating whether the + property has been modified for the current object. + + + + + Gets a value indicating whether the + property has been modified for the current object. + + + + + Gets a value indicating whether the + property has been modified for the current object. + + + + + Gets a value indicating whether the + property has been modified for the current object. + + + + + Gets a value indicating whether the + property has been modified for the current object. + + + + + Gets a value indicating whether the + property has been modified for the current object. + + + + + Gets a value indicating whether the + property has been modified for the current object. + + + + + Gets a value indicating whether the + property has been modified for the current object. + + + + + Gets a value indicating whether the + property has been modified for the current object. + + + + + Gets a value indicating whether the + property has been modified for the current object. + + + + + Gets a value indicating whether the + property has been modified for the current object. + + + + + Gets or sets the border color of the ToolTipInfo. + + + + + Gets or sets the beak back color of the ToolTipInfo. + + + + + Makes an exact copy of the current object. + + The new owner style object for the copied object. + The identifier for this object. + A copy of the current object registered with the new owner style object. + + + + Override this method to create a product-specific identity object for a sub object. + + An identity object for a sub object of this style. + + The following code is an example how Essential Grid creates GridStyleInfoSubObjectIdentity: + + public override StyleInfoSubObjectIdentity CreateSubObjectIdentity(StyleInfoProperty sip) + { + return new GridStyleInfoSubObjectIdentity(this, sip); + } + + + The . + + + + Gets the default style of the . + + Default style of the . + + + + Determines whether the + property should be serialized or not. + + Returns true when it need to be serialized otherwise return false. + + + + Determines whether the + property should be serialized or not. + + Returns true when it need to be serialized otherwise return false. + + + + Determines whether the + property should be serialized or not. + + Returns true when it need to be serialized otherwise return false. + + + + Determines whether the + property should be serialized or not. + + Returns true when it need to be serialized otherwise return false. + + + + Provides style identity information for nested expandable objects of the ToolTipVisualStyle class. + + + + + Initializes a new instance of the class. + + The that owns this sub-object. + The descriptor for this expandable sub-object. + + + + Represents a window or dialog box that makes up an application's user interface with options to customize its appearance. + + + + + Indicates the close button of the form. + + + + + Indicates the maximize/restore button of the form. + + + + + Indicates the minimize button of the form. + + + + + Indicates the help button of the form. + + + + + Indicates the close button for the maximized MDI child. + + + + + Indicates the restore button of the maximized MDI child. + + + + + Indicates the minimize button of the maximized MDI child. + + + + + Indicates the help button of the maximized MDI child. + + + + + Indicates the scaling value for 100% dpi + + + + + Indicates the scaling value for 125% dpi + + + + + Indicates the scaling value for 150% dpi + + + + + Indicates the scaling value for 175% dpi + + + + + Indicates the scaling value for 200% dpi + + + + + Indicates the scaling value for 225% dpi + + + + + Indicates the scaling value for 250% dpi + + + + + Indicates the scaling value for 275% dpi + + + + + Indicates the scaling value for 300% dpi + + + + + It stores the value of property. + + + + + It stores the height of the title bar. + + + + + It stores the height of the mdi parent's title bar. + + + + + It stores the value of the Style property. + + + + + To track the mouse event. + + + + + Represents the width between the border and the client area in DesignMode + + + + + Represents the instance of the class. + + + + + Used to set bound for the form. + + + + + It stores the update count value. + + + + + It stores the TitleBarTextControl. + + + + + Represents the form shadow window. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + Maintains the value indicating whether the title height should retain or not. + + + + + Value to store the title padding. + + + + + Value to indicate whether the form is disposed or not. + + + + + Indicates whether to allow rounded corners or not. + + + + + Initializes a new instance of the class. + + + + + Sends the specified message to a window or windows. + The SendMessage function calls the window procedure for the specified window and does not return until the window procedure has processed the message. + + A handle to the window whose window procedure will receive the message. + The message to be sent. + Additional message-specific information. + A Additional message-specific information. + The return value specifies the result of the message processing; it depends on the message sent. + + + + + Gets or sets padding within the form. + + + + + Gets or sets the control to be displayed in the title bar of the form instead of the title bar text. + + + + //Loads a Button control to the title bar of the form. + TitleBarTextControl = new Button(); + //Sets the text for the TitleBarTextControl. + TitleBarTextControl.Text = "Control1"; + + + Form.Text property value will be displayed on the title bar only when this property value is equal to null. + The default value is null. + + + + Gets the value used to customize the appearance of the form. + + + + + Gets or sets a value indicating whether the close button is displayed in the caption bar of the form. + + The default value is true. + + + + Gets or sets a value indicating the size of the form icon. + + + + + Gets or sets a value indicating whether the tooltip for the title bar button is enabled. + + The default value is true. + + + + Gets or sets a value indicating whether the rounded corners are enabled. + + The default value is false. + This option is only in effect with Windows 11. + + + + Gets or sets the back color of the form. + + + + + Gets or sets the fore color of the form. + + + + + Gets a value indicating whether the visual style based theme is applied to the control and + also indicates whether the theme files are referred from external assemblies or not. + + Return true, if the visual style based theme is applied to the control. Otherwise returns false. + + + + Gets or sets a value indicating whether the accessibility is enabled for the Form or not. + + + + + Gets or sets the instance of the TitleBar. + + + + + Gets or sets the initial width of the TitleBarTextControl. + + + + + Gets or sets a value indicating whether the form is active or not. + + + + + Gets the value indicating whether the current operating system is Windows11 or not. + + + + + Gets or sets the caption bar button on which the mouse pointer is hovered. + + + + + Gets the value indicating whether the current operating system is windows7 or not. + + + + + Occurs when theme name of the has been changed. + + + + + Gets or sets a value indicating whether a theme style settings can be applied to the control. + + The default value is true. + + + + Gets or sets the theme name of the . + + + + + Gets or sets a value indicating whether control elements styles can be overridden by theme style settings. + + Default value is false. + + By default, the control's element styles will not be overridden by theme style settings if the style is set in sample level. + If this property is enabled, element style will be overridden by theme style settings event if it is set in sample level. + This property should be enabled or disabled before calling the ThemeName property of the control. + + + + + Gets or sets the base theme name of the . + + + + + Gets or sets the VisualTheme of the . + + + + + Gets or sets the visual theme, which holds the applied from . + + + + + Gets the name of the control. + + + + + Gets the active theme name of the . + + Returns the active theme name. + + + + Gets the control name. + + + + + Raises the event. + + The sender value. + A contains the event data. + + + + Suspends the painting of the control until the method is called. + + + + //Call BeginUpdate() to ensure the form is painted only once. + this.BeginUpdate(); + //Change the appearance of the form. + this.Style.TitleBar.ForeColor = Color.Red; + this.Style.TitleBar.BackColor = Color.SkyBlue; + //Call EndUpdate() when finish changing the appearance of the form. + this.EndUpdate(); + + + + + + Resumes the painting of the control suspended by calling the method. + + + + //Call BeginUpdate() to ensure the form is painted only once. + this.BeginUpdate(); + //Change the appearance of the form. + this.Style.TitleBar.ForeColor = Color.Red; + this.Style.TitleBar.BackColor = Color.SkyBlue; + //Call EndUpdate() when finish changing the appearance of the form. + this.EndUpdate(); + + + + + + Gets the height of the title bar. + + Returns the height of the caption bar + + + + Gets the height of the mdichild title bar. + + Returns the height of the mdi caption bar + + + + Gets the size of the close button. + + Returns the size of the close button + + + + Gets the size of the maximum button. + + Returns the size of the maximum button + + + + Gets the size of the minimum button. + + Returns the size of the minimum button + + + + Gets the size of the help button + + Returns the size of the help button + + + + Gets the size of the mdi close button + + Returns the size of the mdi close button + + + + Gets the size of the mdi maximum button + + Returns the size of the mdi maximum button + + + + Gets the size of the mdi minimum button + + Returns the size of the minimum button + + + + Get the size of the mdi help button + + Returns the size of the help button + + + + Refresh the form to update the appearance. + + + + + Method to determine whether the operating system is Windows 11. + + true if the operating system is Windows 11; otherwise false. + + + + Occurs when the form handle is created. + + The that contains the event data. + + + + Processes Windows messages. + + Windows message. + + + + Set the specified bound for the form. + + The Left property value of the form. + The Top property value of the form. + The Width property value of the form. + The Height property value of the form. + Specifies the bounds of the form. + + + + Sets the client size of the form. This will adjust the bounds of the form to make the client size the requested size. + + Requested width of the client region. + Requested height of the client region. + + + + Raises the System.Windows.Forms.Form.Load event. + + Event Arguments. + + + + Raises the System.Windows.Forms.Form.Shown event. + + Event args that contains the event data + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Overridden to set the accessibility object for the SfForm. + + Returns the accessibility object of the SfForm. + + + + Updates the title padding. + + Updates to retain the title bar height in maximized state. + + + + Invalidate the frame + + + + + Sets the text of a window. + + Received window message. + + + + Process the WM_NCACTIVATE Windows message. + Occurs when the form is activated or deactivated. + + Received window message. + + + + Process the WM_NCHITTEST Windows message. + To determine what part of the window corresponds to a particular screen coordinate + + Received window message. + + + + Determines the area on the form corresponding to the specified point. + + Specifies the cursor position. + Returns a value that indicates the mouse hit position. + + + + Process the WM_NCLBUTTONDBLCLK Windows message. + Occurs when the left mouse button is double clicked while the cursor is on the non client area of the form. + + Received window message. + + + + Process the WM_NCMOUSELEAVE Windows message + Occurs when the cursor leaves the non client area of the form. + + Received window message. + + + + Process the WM_NCMOUSEMOVE Windows message + Occurs when the cursor is moved within the non client area of the form. + + Received window message. + + + + Process the WM_NCLBUTTONDOWN Windows message + Occurs when the left mouse button is pressed while the cursor is on the non client area of the form. + + Received window message. + + + + Process the WM_NCLBUTTONUP Windows message + Occurs when the left mouse button is released while the cursor is on the non client area of the form. + + Received window message. + + + + Process the WM_NCPaint Windows message + To draw the title bar, border lines and background of the form. + + Received window message. + + + + Draw the non-client area of the form. + + Graphics object + Window rectangle + + + + Draw the border for the form with specified color and thickness. + + Graphics object. + Rectangle to draw border. + + + + Draw the region excluding the caption bar and client area of the form. + + Graphics object + Window rectangle. + + + + Process the WM_NCCALCSIZE Windows message + Calculates the size and position of the form's client area. + + Received window message. + + + + Calculate the client region of the form. + + Window rectangle. + Form border thickness. + Title bar height of the form.param> + Returns the client rectangle of the form. + + + + Calculate the client region of the form. + + Window rectangle. + Window rectangle of the parent form. + Form border thickness. + Returns the client rectangle of the child form. + + + + Process the WM_WINDOWPOSCHANGED Windows message + Occurs when the size, position or place of the form is changed. + + Received window message. + + + + Clip the required visible region within the window rectangle. + + Window Handle. + + + + To get the ID of the button present in the specified point. + + Specifies the cursor position. + Returns button ID. + + + + Get the cursor position. + + Returns the cursor position. + + + + Redraw the button when its state changed. + + Graphics object + + + + Apply rounded corners for the form. + + The handle to the window + Corner style for the round corners + + + + Represents the class that provides the shadow effect for the . + + + + + Represents an instance of class. + + + + + represents the shadow bitmap. + + + + + Represents the width of form shadow. + + + + + Initializes a new instance of the class. + + Base form for which the shadow should be provided. + + + + Returns a that contains the required creation parameters + when the handle to the control is created. + + + + + Set location of the ShadowForm. + + Sender object. + Event arguments. + + + + Draw the shadowForm and clip the region belongs to the Base Form from the ShadowForm. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Processes Windows messages. + + Windows message. + + + + Provide the shadow like appearance for the background window. + + Bitmap created from the background window. + + + + Represents the class that draws the title bar of the form. + + + + + Rectangle to draw the close button of the caption bar. + + + + + Rectangle to draw the maximize/restore button of the caption bar. + + + + + Rectangle to draw the minimize button of the caption bar. + + + + + Rectangle to draw the help button of the caption bar. + + + + + Rectangle used to draw the title bar icon of the form. + + + + + Rectangle to draw the MDI close button of the caption bar. + + + + + Rectangle to draw the MDI maximize button of the caption bar. + + + + + Rectangle to draw the MDI minimize button of the caption bar. + + + + + Rectangle to draw the MDI help button of the caption bar. + + + + + Rectangle used to draw the MDI icon on the caption bar. + + + + + Rectangle used to draw the title bar text. + + + + + Rectangle that holds the close icon of the caption bar. + + + + + Rectangle used to draw the maximize icon of the caption bar. + + + + + Rectangle used to draw the restore up icon of the caption bar of minimized mdi child. + + + + + Rectangle that specifies the area in the caption bar that contains MDI buttons and icon. + + + + + Represents an instance of class. + + + + + Initializes a new instance of the class. + + Instance of class. + + + + Gets the value indicating the rectangle to draw the close button. + + + + + Gets the value indicating the rectangle to draw the maximize button. + + + + + Gets the value indicating the rectangle to draw the minimize button. + + + + + Gets the value indicating the rectangle to draw the help button. + + + + + Gets the value indicating the rectangle to draw the form icon. + + + + + Gets the value indicating the rectangle to draw the mdi close button. + + + + + Gets the value indicating the rectangle to draw the mdi maximize button. + + + + + Gets the value indicating the rectangle to draw the mdi minimize button. + + + + + Gets the value indicating the rectangle to draw the mdi help button. + + + + + Clean up the unmanaged resources + + + + + Draw the caption bar of the form. + + Graphics object. + Caption rectangle. + + + + Draw the close button of the caption bar. + + Graphics object + Caption button BackColor + Caption ButtonColor + Button image + + + + Draw the help button button of the caption bar. + + Graphics object + Caption button BackColor + Caption ButtonColor + Button image + + + + Draw the minimize button button of the caption bar. + + Graphics object + Caption button BackColor + Caption ButtonColor + Button image + + + + Draw the maximize button button of the caption bar. + + Graphics object + Caption button BackColor + Caption ButtonColor + Button image + + + + Draw the buttons on the caption bar. + + Graphics object + Caption Rectangle + + + + Draw MDI Help button on the caption bar. + + Graphics object. + ForeColor of the MDI help button. + MDI help button image. + + + + Draw MDI close button on the caption bar. + + Graphics object. + ForeColor of the MDI close button. + MDI close button image. + + + + Draw the MDI maximize button on the caption bar. + + Graphics object. + BackColor of the MDI maximize button. + ForeColor of the MDI maximize button. + MDI maximize button image. + + + + Draw the MDI minimize button on the caption bar. + + Graphics object. + ForeColor of the MDI minimize button. + MDI minimize button image. + + + + Draw the MDI buttons on the caption bar. + + Graphics object. + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Calculate the rectangle to draw the close button. + + Title bar rectangle. + Form border width. + Button Width. + Button height. + Button Y position. + Returns the rectangle to draw the close button. + + + + Calculate the rectangle to draw the maximize button. + + Close button rectangle. + Button width. + Button Height. + Button Y position. + Returns the rectangle to draw the maximize button. + + + + Calculate the rectangle to draw the minimize button. + + Maximize button rectangle. + Button width. + Button height. + Button Y position. + Returns the rectangle to draw the minimize button. + + + + Calculate the rectangle to draw the help button. + + Minimize button rectangle. + Button width. + Button height. + Button Y position. + Returns the rectangle to draw the help button. + + + + Calculate the rectangles to draw the mdi buttons. + + Title bar rectangle. + + + + Calculate the rectangle to draw the title bar of the form. + + Window rectangle. + Height of the title bar. + Returns the rectangle to draw the title bar of the form. + + + + Draw the form icon on the caption bar. + + Graphics object. + Rectangle to draw the form icon. + + + + Calculate the rectangle to draw the title bar icon. + + Title bar rectangle. + Returns the rectangle to draw the title bar icon. + + + + Calculate the rectangle to draw the mdi icon. + + + + + Fill the caption bar with the color specified by CaptionBackColor property. + + Graphics object. + Caption bar rectangle. + Caption bar backcolor. + + + + Draw the text in the caption bar + + Graphics object. + Caption bar rectangle. + + + + Calculate the rectangle to draw the title bar text. + + Title bar rectangle. + Returns the rectangle to draw the title bar text. + + + + Draw the caption image in the caption bar. + + Graphics object + Height of the caption bar. + + + + Draws the rich text on the given graphics. + + Graphics object. + The string value contains the rich text content. + The rectangle value used to draw the rich text. + + + + Represents a window as a tooltip. + + + + + The const for balloon size. + + + + + The object of component. + + + + + The height of the balloon. + + + + + The width of the balloon. + + + + + The value indicating whether shadow should be drawn for the ToolTip. + + + + + Initializes a new instance of the class. + + The object of SfToolTip. + + + + Gets or sets a value indicating whether the tooltip is shown through show method or not. + + + + + Gets or sets the location in which the tooltip to be shown. + Maintained temporarily to change the balloon drawing when the tooltip is clipped in screen bounds case. + + + + + Gets or sets the ToolTipInfo to be shown in the tooltip. + + + + + Gets or sets the point in which the tooltip is to be shown. + + + + + Gets or sets a value indicating whether shadow should be drawn for the ToolTip. + + + + + Gets or sets a value indicating whether the location of the tooltip is changed in tooltip showing event. + + + + + Gets a value indicating whether the window will be activated when it is shown. + + + Overridden to return true to avoid activating the tooltip. If not, parent form will lost focus when the tooltip is activated. + + + + + Gets the required creation parameters when the control handle is created. + + + Overridden to set the tooltip window's extended style as TopMost. + If not, tooltip will not be shown in front as we are not activating the tooltip window. + + + + + Gets the location of the ToolTip based on provided ToolTipLocation option. + + The cursor position. + Returns the Location of the tooltip to be shown. + + + + Adjusts the point respective to the Screen bounds. + + The location of the ToolTip which is to be adjusted with screen bounds. + Returns the adjusted position of the ToolTip. + + + + Raises the Layout event. + + A that contains the event data. + + + + Raises the Paint event. + + A that contains the event data. + + + + Occurs when the Visible property value changes. + + An EventArgs that contains the event data. + + This method is called when the Visible property of the tool tip form is changed. + It is called after the Visible property is set and before the form is shown or hidden. + + + + + Draws the background appearance of the . + + An object that graphics data. + The rectangle of the . + An object. + + + + Gets the based on the + property of the + + An object. + Returns the . + + + + Checks whether valid image is available in or not. + + An object. + true if valid image is available, otherwise false. + + + + Gets the image size of the . + + An object. + Returns the specified size if ImageSize is set, otherwise returns the size of the image itself. + + + + Sets the location of the . + + The current size of the tooltip. + The object of ToolTipItem. + The location in which the tooltip is to be shown. + The value indicating that the separator for previous item is enabled or not. + + + + Gets the GraphicsPath based on the tooltip location for balloon drawing. + + Value indicating to get graphics path based on region updating. + Returns the GraphicsPath for balloon drawing. + + + + Gets the GraphicsPath of the ballon beak area. + + Returns the GraphicsPath of the ballon beak area. + + + + Draws the appearance of the . + + An object that graphics data. + The rectangle of the . + An object. + The value indicating that the separator for previous item is enabled or not. + + + + Draws the ToolTip text of the . + + An object that graphics data. + The rectangle of the . + An object. + The value indicating that the separator for previous item is enabled or not. + + + + Draws the separator line of the , + if is true. + + An object that graphics data. + The rectangle of the . + An object. + + + + Draws the ToolTip image of the . + + An object that graphics data. + The rectangle of the . + An object. + The value indicating that the separator for previous item is enabled or not. + + + + Gets the rectangle of . + + The rectangle of the . + An object. + The value indicating that the separator for previous item is enabled or not. + Returns the rectangle of the . + + + + Gets the rectangle of the . + + The rectangle of the . + An object. + The value indicating that the separator for previous item is enabled or not. + Returns the rectangle of the . + + + + Used by Changing and Changed events of strong typed collections. + + The sender that contains the object of . + An object of that contains event data. + + + + Represents a class used by Changed event of strong typed collections. + + + + + The changed type of the List property. + + + + + The index. + + + + + The item object. + + + + + The property name. + + + + + The tag object. + + + + + Initializes a new instance of the class. + + ListPropertyChangedType value. + Index in which the list gets affected. + Item which affects the collection. + Property in which the collection gets affected. + + + + Initializes a new instance of the class. + + ListPropertyChangedType value. + Index in which the list gets affected. + Item which affects the collection. + Property in which the collection gets affected. + Tag for additional information. + + + + Gets the type in which the list changed. + + + + + Gets the index of the item that is changed. + + + + + Gets the reference to the affected item. + + + + + Gets the name of the affected property. + + + + + Gets the . + + If tag is EventArgs, then it returns the Tag casted to EventArgs. + + + + Gets or sets a tag. + + + + + Represents the method that will handles the event. + + The sender that contains the v. + An object that contains event data. + + + + Represents the method that will handles the event. + + The Sender that contains the v. + An object that contains event data. + + + + Represents the method that will handle the event. + + The sender that contains the v. + An object that contains event data. + + + + Provides data about the cancelable event when the tooltip is showing. + + + To abort the showing of tooltip, set to True. + + To change the of the tooltip, + use the property. + + To change the location of the tooltip, use the property. + + In order to set the location or ToolTipInfo of the tooltip, then the must be set to true. + + + + + The ToolTipInfo of the tooltip. + + + + + The location of the tooltip. + + + + + The control which shows the tooltip. + + + + + Initializes a new instance of the class. + + The control which shows the tooltip. + The of the tooltip to be shown. + The location of the that the tooltip is set to be shown. + + + + Gets a control which shows the tooltip. + + + + + Gets or sets the specified of the tooltip. + + + + + Gets or sets the location that the tooltip is to be shown. + + + + + Provides data sbout the event after the tooltip is shown. + + + The of the tooltip can be from property. + + The location that the tooltip was shown can be get from property. + + + + + The control which shown the tooltip. + + + + + The ToolTipInfo displayed in the tooltip. + + + + + The location that the tooltip was shown. + + + + + Initializes a new instance of the class. + + The control which shown the tooltip. + The of the tooltip shown. + The location that the tooltip was shown. + + + + Gets a control which shown tooltip. + + + + + Gets the of the shown tooltip. + + + + + Gets the location that the tooltip was shown. + + + + + Provides data about the event on drawing the tooltip item. + + + To abort the default drawing of the tooltip item, set property to true. + + + + + The graphics of the tooltip control. + + + + + The rectangle of the tooltip item. + + + + + The tooltip item. + + + + + Initializes a new instance of the class. + + An object that contains graphics data of tooltip. + The rectangle of the tooltip item. + An object. + + + + Gets the graphics of the tooltip. + + + + + Gets the rectangle of the tooltip item. + + + + + Gets the to be drawn. + + + + + Represents a class that contains the information to be displayed in the ToolTip. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + An object of ToolTipInfo. + + + + Gets or sets the . + + + + + Gets or sets the BorderColor of the v. + + + + + Gets or sets the Minimum width of the v. + + + If is lesser than + , then the value of + will be considered as a maximum width for the ToolTip. + + + + + Gets or sets the Maximum width of the v. + + + If is lesser than + , then the value of + will be considered as a maximum width for the ToolTip. + + + + + Gets or sets a value indicating whether v + elements are aligned to support locales using right-to-left fonts. + + + + + Gets or sets the location of the ToolTip based on the mouse pointer. + + + If the Balloon tooltip style is enabled, the balloon beak will be shown near to the mouse pointer based on the corresponding tooltip location. + + + + + Gets or sets the style of the ToolTip. + + + + + Gets or sets the border thickness of the tooltip. + + + + + Gets or sets the beak background color of the balloon tooltip. + + + By default, beak back color will not be applied based on the corresponding ToolTip item's back color. + Beak back color can be applied manually based on the corresponding ToolTip item. + + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Releases the unmanaged resources used by the collection and optionally releases the managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Determines whether the + property should be serialized or not. + + Returns true when it need to be serialized otherwise return false. + + + + Determines whether the + property should be serialized or not. + + Returns true when it need to be serialized otherwise return false. + + + + Determines whether the + property should be serialized or not. + + Returns true when it need to be serialized otherwise return false. + + + + Determines whether the + property should be serialized or not. + + Returns true when it need to be serialized otherwise return false. + + + + Implements a type converter for . + + + + + Returns whether this converter can convert the object to the specified type, using the specified context. + + An that provides a format context. + A that represents the type you want to convert to. + true if this converter can perform the conversion; otherwise, false. + + + + Converts the given value object to the specified type, using the specified context and culture information. + + An that provides a format context. + A . If null is passed, the current culture is assumed. + The to convert. + The to convert the value parameter to. + An that represents the converted value. + + + + Represents a class that maintains the information of the . + + + + + Initializes a new instance of the class. + + + + + Gets or sets the ToolTip text of the . + + + + + Gets or sets the with settings that control the appearance of the . + + + + + Gets or sets a value indicating whether gradient background drawing + for the should be enabled or not. + + + The gradient brush can be set to the tooltip item by using the property + which is available in the property. + + + + + Gets or sets a value indicating whether separator line between the + should be enabled or not. + + + If the is enabled for the tooltip item, the line will be drawn to the bottom of that tooltip item. + The separator line cannot be drawn for the last tooltip item. + + + + + Gets or sets the image of the tooltip item. + + + + + Gets or sets the of the tooltip item. + + + If the is specified, the tooltip will not consider the image from ImageList collection. + + ImageList collection will be only considered when is not specified. + + + + + Gets or sets the zero-based index of an image in a + collection to be displayed in a tooltip item. + + + + + Gets or sets a control to be added on the . + + + If the control is set to the tooltip item, the text, image and other customization cannot be applied to the tooltip item. + The assigned control only will be displayed in the tooltip item. + + + + + Gets or sets the padding of the tooltip item. + + + The padding is applicable for entire tooltip item i.e. tooltip item's image, text and control will be drawn based on the padding. + + + + + Gets or sets the size of the . + + + + + Gets or sets the text size of the . + + + + + Gets or sets the name of the tooltip item. + + + + + Overriden. To return a string which represents the object instance. + + Returns a string which represents the objecr instance. + + + + Determines whether the + property should be serialized or not. + + Returns true when it need to be serialized otherwise return false. + + + + Determines whether the + property should be serialized or not. + + Returns true when it need to be serialized otherwise return false. + + + + Represents the editor for Image of the tooltip item. + + + + + Gets the editor style used by the EditValue method. + + An that can be used to gain additional context information. + A value that indicates the style of editor used by the EditValue method. + If the does not support this method, then it will return None. + + + + Edits the specified object's value using the editor style indicated by the + method. + + An that can be used to gain additional context information. + An that this editor can use to obtain services. + The object to edit. + The new value of the object. If the value of the object has not changed, this should return the same object it was passed. + + + + Represents a collection of . + + + + + The list of ToolTipItem. + + + + + Initializes a new instance of the class. + + + + + Occurs after a property in the collection is changed. + + + + + Gets a value indicating whether the has a fixed size. + + + + + Gets a value indicating whether the is read-only. + + + + + Gets the number of elements actually contained in the . + + + + + Gets a value indicating whether access to the is synchronized. + + + + + Gets an object that can be used to synchronize access to the Collection. + + + + + Gets or sets the at the specified index. + + The index of the element to get or set. + The element at the specified index. + + + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. + The element at the specified index. + + + + Adds the in the + . + + An object of . + Returns the index in which the item is added. + + + + Adds the range of in the + . + + Collection of objects. + + + + Inserts the in the specified index. + + The index in which the element has to be inserted. + An object of . + + + + Inserts the range of in the specified index. + + The index in which the range of elements has to be inserted. + Collection of objects. + + + + Removes the from the + . + + An object of . + + + + Removes the at the specified index from the + . + + The index of the element to be removed. + + + + Removes the range of from the + . + + Collection of objects. + + + + Gets the index of the in the + . + + An object of . + Returns the index of the . + + + + Removes all the elements from the . + + + + + Determines whether an element exists in the . + + An object of . + true if item is found; otherwise, false. + + + + Overriden. To return the count of the collection. + + Returns the count of the collection. + + + + Copies the elements of the collection to an Array, starting at a particular index. + + The one-dimentioanl Array that is the destination of the elements copied from Collection. + Index in array at which copying begins. + + + + Returns an enumerator that iterates through a . + + An IEnumerator object that can be used to iterate through + the . + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Determines whether the contains a specific value. + + The object to locate in the . + true if the value is found in the ; otherwise, false. + + + + Determines the index of a specific item in the . + + The object to locate in the . + The index of value if found in the list; otherwise, -1. + + + + Inserts an item to the at the specified index. + + The zero-based index at which value should be inserted. + The object to insert into the . + + + + Removes the first occurrence of a specific object from the . + + The object to remove from the . + + + + Adds an item to the . + + The object to add to the . + The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection. + + + + Releases the unmanaged resources used by the collection and optionally releases the managed resources. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Raises the changed event of . + + An object of that contains event data. + + + + Provides a user interface that can edit collections of tooltip items at design-time. + + + + + Initializes a new instance of the class. + + The type of the collection for this editor to edit. + + + + Gets the data type that this collection contains. + + The data type of the items in the collection. + + + + Indicates whether multiple collection items can be selected at once. + + true if it multiple collection members can be selected at the same time; otherwise, false. By default, this returns true. + + + + Implements a type converter for . + + + + + Returns whether this converter can convert the object to the specified type, using the specified context. + + An that provides a format context. + A that represents the type you want to convert to. + true if this converter can perform the conversion; otherwise, false. + + + + Converts the given value object to the specified type, using the specified context and culture information. + + An that provides a format context. + A . If null is passed, the current culture is assumed. + The to convert. + The to convert the value parameter to. + An that represents the converted value. + + + + Provide a user interface for representing and editing the values of objects. + + + + + Gets the editor style used by the EditValue method. + + An that can be used to gain additional context information. + A value that indicates the style of editor used by the EditValue method. + If the does not support this method, then it will return None. + + + + Edits the specified object's value using the editor style indicated by the + method. + + An that can be used to gain additional context information. + An that this editor can use to obtain services. + The object to edit. + The new value of the object. If the value of the object has not changed, this should return the same object it was passed. + + + + Provides a window for editing the objects. + + + Provides a window for editing the objects. + + + + + The property grid for showing the properties of ToolTipInfo. + + + + + Initializes a new instance of the class. + + An object of . + An object of . + + + + Gets or sets the ToolTipInfo of the editor form. + + + + + Initializes the design surface of the ToolTipEditorForm with related ToolTipInfo. + + An object of . + An object of . + + + + Occurs when OK button in the ToolTipEditorForm is clicked. + + The sender that contains the OK button. + An object of that contains event data. + + + + Occurs when Cancel button in the ToolTipEditorForm is clicked. + + The sender that contains the Cancel button. + An object of that contains event data. + + + + Required designer variable. + + + + + The design panel of the ToolTipEditorForm. + + + + + The button panel of the ToolTipEditorForm. + + + + + The Cancel button of the ToolTipEditorForm. + + + + + The Ok button of the ToolTipEditorForm. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Represents the class to define the FontFamily settings for the Controls + + + + + It contains the value of the property. + + + + + It contains the value of the property. + + + + + Gets or sets the FontFamily used to display text in the Control. + + + + FontHelper.FontFamily = new FontFamily("Times New Roman"); + + + + + + Handles the refresh operation for all open forms in the application. + + + + + Gets or sets a value indicating whether control FontFamily can be overridden by settings. + + Default value is false. + + By default, the control's Font will not be overridden by settings if the Font is set in sample level. + If this property is enabled, control's Font will be overridden by settings event if it is set in sample level. + This property should be enabled or disabled before applying the property. + + + + + Represents the CustomAttribute class used to validate the property information that needs to be displayed in Theme Studio + + + + + It contains the value of + + + + + Initialize the instance of + + + + + + Initialize the instance of + + + + + Gets / Sets whether the marked property can be displayed in Theme Studio. + + + + + Provides the functionalities for the control to provide theme support. + + + + + Occurs when theme is changed. + + + + + Gets or sets the name of the theme. + + + + + Gets the name of the control. + + + + + Gets or sets the Base ThemeName of the theme + + + + + Gets or sets a value indicating whether the theme should be applied to the control. + Default value is true. + + + If true, will be applied to control. + Otherwise will be applied to control. + + + + + Gets or sets a value indicating whether control elements styles can be overridden by theme style settings. + + + By default, the control's element styles will not be overridden by theme style settings if the style is set in sample level. + If this property is enabled, element style will be overridden by theme style settings event if it is set in sample level. + This property should be enabled or disabled before calling the ThemeName property of the control. + + + + + Gets a value indicating whether the visual style based theme is applied to the control and + also indicates whether the theme files are referred from external assemblies or not. + + Return true, if the visual style based theme is applied to the control. Otherwise returns false. + + + + Gets the name of the active theme that is currently applied to the control. + + + + + A helper class that provides the functionality to merge the styles from the XML configuration to the element style. + + + + + Gets or sets the themes collection. + + + + + Gets or sets the assemblies to read the image resources. + + + + + Loads the assembly to register the theme XML configured files. + + An assembly that has the theme XML configuration file. + + + + Reads the control tag elements. + + The . + The object that needs to be merged. + The xml reader. + + + + Combines the styles defined in the XML document to the target style. + + The + The target object to combine. + + + + Combines the styles defined in the XML document to the target style. + + Name of control + The target object to combine. + + + + Helps to retrieve the Theme resource stream + + ThemeName of the Control + Control name. + Stream + + + + Reads the control tag elements. + + Name of the control. + The object that needs to be merged. + The xml reader. + + + + Reads the properties tag elements. + + The object that needs to be merged. + The xml reader. + + + + Reads the Attributes of the Elements tags of the control. + + The object that needs to be merged. + The xml reader. + + + + Sets the style objects properties from the XML attribute. + + The object that needs to be merged. + The property to set the property value of object. + The XmlReader. + + + + Reads the element tag attributes. + + The object that needs to be merged. + The xml reader. + + + + Reads the Attributes of the Elements. + + The object that needs to be merged. + The xml reader. + + + + Reads the Attributes of the Elements. + + The object that needs to be merged. + The xml reader. + + + + Read the inner elements of the XmlReader. + + The style info object. + The XmlReader. + + + + Read the font attributes of inner elements in the XmlReader. + + The object that needs to be merged. + The xml reader. + + + + Helps to retrieve the Theme resource stream + + ThemeName of the Control + Control + Stream + + + + Reads the properties tag elements. + + The . + The xml reader. + + + + Reads the element tag attributes. + + The . + The object that needs to be merged. + The xml reader. + + + + Reads the Attributes of the Elements. + + The . + The object that needs to be merged. + The object. + The xml reader. + + + + Reads the Attributes of the Elements. + + The . + The object that needs to be merged. + The xml reader. + + + + Read the inner elements of the XmlReader. + + The provider. + The style info object. + The XmlReader. + + + + Reads the Attributes of the Elements tags of the control. + + The . + The object that needs to be merged. + The xml reader. + + + + Read the font attributes of inner elements in the XmlReader. + + The . + The object that needs to be merged. + The xml reader. + + + + Sets the style objects properties from the XML attribute. + + The . + The object that needs to be merged. + The property to set the property value of object. + The XmlReader. + + + + Gets the Font + + The attribute value + The font + + + + Gets the color. + + The attribute value. + The color. + + + + Gets the brush. + + The attribute value. + The brush. + + + + Checks whether given string is Hex color code or not. + + The Hex color code string. + True if given string is Hex color code otherwise false. + + + + Gets the image from the XML configured file. + + The provider. + The image resource file name. + Name of the theme. + An image. + + + + Get the image from given assembly. + + The used to get the image. + The string value contains the image name. + Returns the image. + + + + Helps to retrieve whether the applied Theme is built-in or VisualStyle based theme. + + IThemeProvider + Whether the applied theme is VisualStyle based theme or not + + + + Extends ArrayList by throwing events when Collection changes, an + item's property changes, etc. + + + This class lets you know through the event + when an item gets added or deleted from the ArrayList or + when an exisiting item is replaced by a new item at a position. + It will also listen for property change notifications from the + items in the list, provided the items implement the + interface and forward them using the event. + + + + + + + + + + + + + + Overridden. See . + + + + + Indicates whether the collection is Read-only. + + True to make the collection Read-only; False otherwise. Default is False. + When set to True, the property will return True + and exisiting items in the list cannot be replaced. + + + + Indicates whether the collection should be made fixed size. + + True to make the collection fixed size; False otherwise. Default is False. + When set to True, the property will return True + and no new elements can be added to the list. + + + + + + + + + + + + Indicates whether firing event is suspended. + + True indicates firing the event is suspended; False otherwise. + + + + Will be thrown when the Collection has changed due to the addition or removal of one + or more items. + + + + + Will be thrown if the items in the Collection implement interface + and when their property changes. + + + + + Overloaded. Creates a new instance of the ArrayListExt class. + + + + + Creates a new instance of the ArrayListExt class and inserts + the items specified in an array into the ArrayList. + + An array of objects. + + + + Raises the event. + + + A object containing data + pertaining to this event. + + The method also allows derived classes to handle the event + without attaching a delegate. This is the preferred technique for + handling the event in a derived class. Note to Inheritors: When overriding OnCollectionChanged in a derived + class, be sure to call the base class's OnCollectionChanged method so that + registered delegates receive the event. + + + + Called when an item is being added, removed, moved or when an exisiting item is + replaced by a new item. + + This method does not fire a corresponding event. + + + + Raises the event. + + The source of the event. + The object that contains + data pertaining to this event. + The method also allows derived classes to handle the event + without attaching a delegate. This is the preferred technique for + handling the event in a derived class. Note to Inheritors: When overriding in a derived + class, be sure to call the base class's method so that + registered delegates receive the event. + + + + Called when an item gets removed from the list. + + The object that got removed from the list. + This provides you a convenient place where you can + perform operations pertaining to the removal of an object + from the list. Make sure to call the base class when you override + this function.The base class will call the event with appropriate parameters. + + + + Called when an object gets added to the list. + + The object that got added to the list. + This provides you a convenient place where you can + perform operations pertaining to the addition of an object + to the list. Make sure to call the base class when you override + this function.The method will call the method with appropriate parameters. + + + + + + + + + Call this method to force a event. + + The args for the above mentioned event. + This method is useful when after suspending and resuming events in this list, + you might want to fire the CollectionChanged event for some specific changes. + + + + Overridden. See . + + + + + + + Overridden. See . + + + + + + + Overridden. See . + + + + + + + Overridden. See . + + + + + Overridden. See + + + + + Overridden. See . + + + + + + + Sorts the elements in the entire System.Collections.ArrayList + using the System.IComparable implementation of each element. + + + + + + + + Reverse range of items in collection from position specified by index + parameter and length specified by count parameter. + + range start position. + range length. + + + + Allows you to move one or more items in the collection from + one position to another. + + The beginning index of the range of items to move. + The destination index where the items will be moved to. + The number of elements in the range to be moved. + + If the above indices are not within the list's count, this + method will return without performing any operation. + For example, say a list contains the following elements: + A, B, C, D, E, F. Then the following call:list.Move(2, 4, 2); will result in the following array: A, B, E, F, C, D. + + + + Will suspend the and events + temporarily. + + Call when you are ready to receive events again. + The / calls are useful when you + are performing a series of operations that will result in + multiple changes in the collection, throwing multiple events. + In such cases, you could use these methods to have a single event thrown + at the end of the series of operations.Note that there is no one-to-one correspondence between + and . could be called + more than once but a single subsequent call will + resume throwing events. + + + + Starts throwing the and + events. + + True will throw a event; False will not. + Call this method after calling a method to resume + throwing the and events.Note that there is no one-to-one correspondence between + SuspendEvents and ResumeEvents. SuspendEvents could be called + more than once but a single subsequent ResumeEvents call will + resume throwing events. + + + + A list deriving from with a strongly-typed indexer of type int. + + + + + Overloaded. Creates a new instance of the class. + + + + + Creates a new instance of the class and inserts + the items specified in an array into the , without + support for visual inheritance. + + An array of integers. + + + + Creates a new instance of the with support for + visual inheritance provided based on the specified parent's design state. + + A reference to the interface + that typically contains this collection. + + + + Custom indexer of type int. See for more information. + + + + + Lets you add an array of integers into the list. + + An integer array. + Available to enable serialization using AddRange in designer. + + + + Overridden. See . + + Object 1. + Object 2. + True if identical; False otherwise. + + + + A list deriving from with a strongly-typed indexer of type int. + + + + + Overloaded. Creates a new instance of the IntList class. + + + + + Creates a new instance of the IntList class and inserts + the items specified in array into the IntList. + + An array of integers. + + + + Custom indexer of type int. See for more information. + + + + + Lets you add an array of integers into the list. + + An integer array. + Available to enable serialization via AddRange in designer. + + + + + + + + + + + + + + An derived class that supports creating "visually inheritable lists". + + + A "visually inheritable list" is one that keeps track of and persists in code, + the incremental changes applied on the list in a derived class's designer. + + You should typically not use the methods and properties exposed by this class in + your code. The properties are meant to be used during design-time to store the + incremental changes done at design-time. + + + + + + + + + + + + + + + + + Overloaded. Creates a new instance of the without any support + for visual inheritance. + + + + + Creates a new instance of the class and inserts + the items specified in the array into the VisuallyInheritableList without any + support for visual inheritance. + + An array of objects. + + + + Creates a new instance of the with support for + visual inheritance provided based on the specified parent's design state. + + A reference to the interface + that typically contains this collection. + + This list keeps track of the incremental changes happening in a designer by + following the parent's property. + + + + + + + + + + + + + + Gets / sets the associated parent. + + + + + Gets / sets the incremental changes done at design-time. + + + + + Indicates whether to continue applying incremental-changes done in the + previous design-time invocation. + + True to continue; False otherwise. + + This method is called if it seems like items were removed in the base class + since the last invoke of this design-time. + + + + + Called to apply the changes made in the previous design-time invoke. + + A list specifying the new positions based on the positions of the exisiting items + set in the base class. + + + + Returns a list representing the incremental changes made at design-time. + + A list representing the new position of the items based on the position of the items in the base class. + This list will be provided in a call to + to reapply the changes done during this design-time. + + + + Compares two objects for equality. + + Object 1. + Object 2. + True if identical; False otherwise. + The base class version uses the "==" operator to perform the + comparison. This could be overridden to support boxed types (int, for example), + where 2 integers should be compared based on their value rather than the boxed object instance. + + + + + Overridden. See . + + + + + + + + + + + + + + + + + + + + + + + + + + An ArrayListExt instance that will enforce the type of objects that can be added to the array during runtime. + + Specifies the type of objects that can be added to the array. + + + + An indexer of the specified template type. + + The index of the object in the list that you want to retrieve. + The object at the specified index. + + + + An IBindingList that wraps a DataTable and provides optimized access to the rows of the datatable. Assign + this list to a grid as DataSource to improve performance when inserting records into an existing + table with many records. + + + + + The underlying DataTable. + + + + + Initializes a new object and attaches it to the wrapped DataTable. + + The DataTable to be wrapped. + + + + Not implemented. + + + + + + Always True. + + + + + Not implemented. + + + + + Not implemented. Returns -1. + + + + + + + + Always False. + + + + + Always False. + + + + + Always True. + + + + + Always False. + + + + + Not implemented. + + + + + Broadcasts the event. + + + + + Always True. + + + + + Not implemented. + + + + + Adds a new row (calling DataTable.NewRow) and returns the new object. + + + + + + Always True. + + + + + Not implemented. + + + + + + Always False. + + + + + Returns the element at the zero-based index. + Setting is not supported and will throw an exception since the collection is Read-only. + + + + + Removes the element at the specified index of the collection. + + The zero-based index of the element to remove. + + + + Inserts an element into the collection at the specified index. + + The zero-based index at which the element should be inserted. + The element to insert. The value must not be a NULL reference (Nothing in Visual Basic). + + + + Removes the specified row object from the collection. + + The element to remove from the collection. If the value is NULL or the element is not contained + in the collection, the method will do nothing. + + + + Always False, the method is not implemented yet. + + + + + Removes all elements from the collection. + + + + + Always -1, the method is not implemented. + + + + + Adds a row object to the end of the collection. + + The element to be added to the end of the collection. The value must not be a NULL reference (Nothing in Visual Basic). + The zero-based collection index at which the value has been added. + + + + Always False since this collection has no fixed size. + + + + + Not implemented. + + + + + Returns the number of elements contained in the collection. + + + + + Copies the entire 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 ArrayList. The array must have zero-based indexing. + The zero-based index in an array at which copying begins. + + + + Not implemented. + + + + + Returns an enumerator. + + + + + + Returns a PropertyDescriptorCollection that represents the DataTable.Columns collection. + + + + + + + Returns DataTable.TableName. + + + + + + + A custom PropertyDescriptor that is used within a to access + a DataColumn. + + + + + Initializes a new PropertyDescriptor and attaches it to a DataColumn. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns the DataColumn. + + + + + Specifies the change in the ListProperty. Used by OnChanging and OnChanged events of strong typed collections. + + + + + An item is appended. + + + + + An item is removed. + + + + + An item is inserted. + + + + + An item is moved. + + + + + The whole collection is changed. + + + + + An item is replaced. + + + + + A nested property of an item is changed. + + + + + Used by OnChanging and OnChanged events of strong typed collections. + + + + + Initializes the ListPropertyChangedEventArgs. + + + + + + + + + Initializes the ListPropertyChangedEventArgs. + + + + + + + + + + Returns the type in which the list changed. + + + + + Returns the index of the item that is changed. + + + + + Returns a reference to the affected item. + + + + + Returns the names of the affected property. + + + + + If tag is EventArgs, then it returns the Tag casted to EventArgs. + + + + + Gets / sets a tag. + + + + + Used by OnChanging and OnChanged events of strong typed collections. + + + + + Provides helper routines for exploring properties in a collection. Essential Grid uses + this routine to find out about columns and relations to be displayed in the grid when + a collection is specified as datasource. + + + + + Checks IBindingList.SortDirection. + + + + + + + Checks IBindingList.SortProperty. + + The list to check. + + + + + Calls IBindingList.ApplySort. + + List to be sorted. + + + + + + Checks IBindingList.SupportsSorting. + + + + + + + Checks IBindingList.AllowRemove for IBindingList or IList.IsReadOnly and IList.IsFixedSize for IList collections. + + + + + + + Indicates whether the property represents a relation or nested collection. + + + + + + + Compares the two PropertyDescriptorCollection and indicates whether they are equal. + + + + + + + + Returns the PropertyDescriptorCollection for the relation or nested collection. + + + + + + + Overloaded. Returns the PropertyDescriptorCollection for the relation or nested collection. + + + + + + + Returns the PropertyDescriptorCollection for the relation or nested collection. + + + + + Returns the PropertyDescriptorCollection for the relation or nested collection. + + + + + Indicates whether the specified PropertyDescriptor has nested properties. + + The PropertyDescriptor to be checked. + True if nested properties are found; False otherwise. + + + + Indicates whether the specified Type has nested properties. + + The Type to be checked. + True if nested properties are found; False otherwise. + + + + Lets you register additional types that should return false when is called. + + + + + + + + + + + + + + Returns the or DataTable of the + + + + + + + Returns the of the if it + is a DataColumnPropertyDescriptor. + + + + + + + Determines and returns the DataTable object for the given list. + + + + + + + Returns the or DataTable of the + + + + + + + Returns the properties for the specified type. + + + + + + + Returns the type of the items in the list if the list is strong-typed. + + + + + + + Returns the type of the items in the list if the list is strong-typed. + + + + + + + Returns the properties for the object. + + + + + + + Returns the value for the ValueMember of the specified item. + + The row item. + The list + The name of the value member + The value of the ValueMember. + + + + Implements a two-dimensional table that holds an of rows. Each row + is an of objects. + + +

This is a memory efficient way to represent a table where values can remain empty. Only rows + that actually contain data will allocate an and the array only holds + as many objects as the specific row contains columns.

+

When you access data that are out of range, an empty () object will be returned. + If you set data that are out of range, an exception will be thrown. If you set data for + a row that is empty, the row will be allocated before the value is stored.

+

SFTable provides methods that let you insert, remove or rearrange columns or rows + in the table.

+ + + + + + Initializes a new instance of the class from the specified instances + of the and classes. + + An instance of the class containing the information required to serialize the new instance. + An instance of the class containing the source of the serialized stream associated with the new instance. + This constructor implements the interface for the class. + + + + Implements the ISerializable interface and returns the data needed to serialize the . + + A SerializationInfo object containing the information required to serialize the object. + A StreamingContext object containing the source and destination of the serialized stream. + + + + Initializes a new instance of the + class. + + + Initializes a new instance of the + class that is empty. + + + + + Initializes a new instance of the + class and optional copies of data from an existing table. + + + + + Creates a deep copy of the . + + + A deep copy of the . + + + + + Removes all elements from the . + + + + + Returns the from all rows. + + + + + Creates and returns a new . + + A new + + + + Creates a collection of cells for a row. + + An or derived object for the cell collection. + + + + Gets / sets the number of rows contained in the . + + + If you decrease the row count, the rows in the will be removed. + + + + + Gets / sets the number of columns contained in the . + + + If you decrease the column count, the last columns in each row will be removed. + + + + + Inserts a specified number of empty rows in the at a given row index. + + The zero-based row index of the first row to be inserted. + The number of rows to be added. + not used. + + + + Inserts a specified number of empty columns for each row in the at a given column index. + + The zero-based column index of the first column to be inserted. + The number of columns to be inserted. + not used. + + + + Removes a specified number of rows from the at a given row index. + + The zero-based row index of the first row to be removed. + The number of rows to be removed. + not used. + + + + Removes a specified number of columns for each row in the at a given column index. + + The zero-based column index of the first column to be removed. + The number of columns to be removed. + not used. + + + + Rearranges rows in the . + + The zero-based index of the first row to be moved. + The number of rows in the range to be moved. + The new starting index for the range. The zero-based index is based on the original array. + + + SFTable array = new SFTable(); + array.RowCount = 5; + array.ColCount = 1; + array[0,0] = 0; + array[1,0] = 1; + array[2,0] = 2; + array[3,0] = 3; + array.MoveRows(0, 2, 3); + // results in new order: 2, 0, 1, 3 + + + + + + Rearranges columns in the . + + The zero-based index of the first column to be moved. + The number of columns in the range to be moved. + The new starting index for the range. The zero-based index is based on the original array. + + + SFTable array = new SFTable(); + array.ColCount = 5; + array.RowCount = 1; + array[0,0] = 0; + array[0,1] = 1; + array[0,2] = 2; + array[0,3] = 3; + array.MoveCols(0, 2, 3); + // results in new order: 2, 0, 1, 3 + + + + + + Indicates whether an element is at the specified coordinates in the . + + The zero-based row index. + The zero-based column index. + + + if an element exists at the specified coordinates in the ; + otherwise. + + + + + Gets / sets an element at the specified coordinates in the . + + The zero-based row index. + The zero-based column index. + + If you query for an element and the coordinates are out of range, an empty () object will be returned. + If you set an element and the the coordinates are out of range, an exception is thrown. + + + + + Extends ArrayList with MoveRange, InsertRange and RemoveRange methods. The Item property + will grow the array on demand or return NULL if an index is out of range. + + + + + Overloaded. Initializes a new instance of the + class that is empty and has the default initial capacity. + + + + + Initializes a new instance of the class that contains elements copied from the specified + collection and has the same initial capacity as the number of elements copied. + + The whose elements are copied to the new list. + + + + Overridden. Creates a deep copy of the . + + + A deep copy of the . + + + + + Rearranges the values in the . + + The zero-based index of the first value to be moved. + The number of values in the range to be moved. + The new starting index for the range. The zero-based index is based on the original array. + + + SFArrayList array = new SFArrayList(); + array[0] = 0; + array[1] = 1; + array[2] = 2; + array[3] = 3; + array.MoveRange(0, 2, 3); + // results in new order: 2, 0, 1, 3 + + + + + + Enlarges the array if needed. + + The size to be checked. If the array has less elements, empty () objects will be appended + at the end of the array. + + + + Removes a range of values from the . + + The zero-based index of the first value to be removed. + The number of values in the range to be removed. + + + SFArrayList array = new SFArrayList(); + array[0] = 0; + array[1] = 1; + array[2] = 2; + array[3] = 3; + array.RemoveRange(1, 2); + // results in new order: 0, 3 + + + + + + Inserts a specified number of () values in the at a given index. + + The zero-based index of the first value to be inserted. + The number of values in the range to be added. + + + SFArrayList array = new SFArrayList(); + array[0] = 0; + array[1] = 1; + array[2] = 2; + array[3] = 3; + array.InsertRange(1, 2); + // results in new order: 0, null, null, 2, 3 + + + + + + Gets / sets the element at the specified index. + In C#, this property is the indexer for the class. + + The zero-based index of the element to get / set. + + The element at the specified index. + When querying the value and the index is out of range, an empty () object will be returned. + When setting the value and the index is out of range the array will be enlarged. See + + + + + + + + + + + Used by TreeTable to balance the tree with algorithm based on Red-Black tree. + + + + + Red. + + + + + Black. + + + + + A branch or leaf in the tree. + + + + + Gets / sets the parent branch. + + + + + returns the position in the tree. + + + + + Returns the number of child nodes (+1 for the current node). + + + + + Indicates whether leaf is empty. + + + + + Indicates whether this is a leaf. + + + + + Returns the tree level of this node. + + + + + Returns the minimum value (of the leftmost leaf) of the branch in a sorted tree. + + + + + Walk up parent branches and reset counters. + + + + + + Walk up parent branches and reset summaries. + + + + + + A branch with left and right leaves or branches. + + + + + Gets / sets the left node. + + + + + Sets the left node. + + The new node. + Indicates whether tree-table is in add-mode. + Indicates whether tree-table is sorted. + + Call this method instead of simply setting property if you want + to avoid the round-trip call to check whether the tree is in add-mode + or if tree-table is sorted. + + + + + Gets / sets the right node. + + + + + Sets the right node. + + The new node. + Specifies if tree-table is in add-mode. + + Call this method instead of simply setting property if you want + to avoid the round-trip call to check whether the tree is in add-mode + or if tree-table is sorted. + + + + + Returns the left branch cast to ITreeTableBranch. + + + + + + Returns the right branch cast to ITreeTableBranch. + + + + + + Gets / sets the Red-Black tree color. + + + + + Returns the position in the tree table of the specified child node. + + + + + + + Sets this object's child node Count dirty and + marks parent nodes' child node Count dirty. + + + + + Sets this object's child node Count dirty and steps + through all child branches and marks their child node Count dirty. + + + + + Sets this object's child node Minimum dirty and + marks parent nodes' child node Minimum dirty. + + + + + Sets this object's child node Minimum dirty and steps + through all child branches and marks their child node Minimum dirty. + + + + + A leaf with value and optional sort key. + + + + + Returns the sort key of this leaf. + + + + + Gets / sets the value attached to this leaf. + + + + + Creates a branch that can hold this entry when new leaves are inserted into the tree. + + + + + + + A branch or leaf in the tree. + + + + + Gets / sets the tree this node belongs to. + + + + + Gets / sets the parent branch. + + + + + Returns the position in the tree. + + + + + Returns the minimum value (of the most-left leaf) of the branch in a sorted tree. + + + + + Indicates whether leaf is empty. + + + + + Indicates whether this is a leaf. + + + + + Returns the number of child nodes (+1 for the current node). + + + + + Returns the tree level of this node. + + + + + Returns the Debug / text information about the node. + + + + + Returns the Debug / text information about the node. + + + + + Walks up parent branches and reset counters. + + + + + + Walks up parent branches and reset summaries. + + + + + + A branch in a tree. + + + + + Initializes a new branch. + + + + + + Returns the minimum value (of the most-left leaf) of the branch in a sorted tree. + + + + + + Gets / sets Red-Black tree algorithm helper. + + + + + Returns the left node cast to ITreeTableBranch. + + + + + + Returns the right node cast to ITreeTableBranch. + + + + + + Gets / sets the left leaf or branch. + + + + + Sets the left node. + + The new node. + Indicates whether tree-table is in add-mode. + Indicates whether tree-table is sorted. + + Call this method instead of simply setting property if you want + to avoid the round-trip call to check whether the tree is in add-mode + or if tree-table is sorted. + + + + + Gets / sets the right tree or branch. + + + + + Sets the right node. + + The new node. + Indicates whether tree-table is in add-mode. + + Call this method instead of simply setting property if you want + to avoid the round-trip call to check whether the tree is in add-mode + or if tree-table is sorted. + + + + + Returns the position in the tree table of the specific child node. + + + + + + + Returns the number of child nodes (+1 for the current node). + + + + + + Indicates whether this is a leaf. + + + + + + Sets this object's child node count dirty and + walks up parent nodes and marks their child node count dirty. + + + + + Sets this object's child node count dirty and steps + through all child branches and marks their child node count dirty. + + + + + Sets this object's child node minimum dirty and + marks parent nodes' child node minimum dirty. + + + + + Sets this object's child node minimum dirty and steps + through all child branches and marks their child node minimum dirty. + + + + + A leaf in the tree with value and optional sort key. + + + + + Releases the unmanaged resources used by the Component and optionally releases the managed resources. + + to release both managed and unmanaged resources; to release only unmanaged resources. + See the documentation for the class and its Dispose member. + + + + Gets / sets the value attached to this leaf. + + + + + Returns the sort key of this leaf. + + + + + Returns the minimum value (of the most-left leaf) of the branch in a sorted tree. + + + + + + Returns the number of child nodes (+1 for the current node). + + + + + + Creates a branch that can hold this entry when new leaves are inserted into the tree. + + + + + + + Returns the Debug / text information about the node. + + + + + + Indicates whether this is a leaf. + + + + + + An empty node. + + + + + Tree table interface definition. + + + + + Indicates whether this is a sorted tree. + + + + + A comparer used by sorted trees. + + + + + Returns the root node. + + + + + Indicates whether BeginInit was called. + + + + + Optimizes insertion of many elements when tree is initialized for the first time. + + + + + Ends optimization of insertion of elements when tree is initialized for the first time. + + + + + Optimized access to a subsequent entry. + + + + + + + Optimized access to a previous entry. + + + + + + + This object owns a . + + + + + Returns a reference to an inner tree table. + + + + + + A tree table. + + + + + + + + + + + + + + + + + + + + Releases the unmanaged resources used by the Component and optionally releases the managed resources. + + to release both managed and unmanaged resources; to release only unmanaged resources. + See the documentation for the class and its Dispose member. + + + + Gets / sets the comparer used by sorted trees. + + + + + Gets / sets the tag that can be associated with this object. + + + + + Initializes a new . + + + + + + Indicates whether tree is sorted. + + + + + Gets / sets the root node. + + + + + Gets / sets an item at the specified index. + + + + + Sets the node at the specified index. + + Index value where the node is to be inserted. + Value of the node that is to be inserted. + + + + Optimized access to the previous entry. + + + + + + + Optimized access to a subsequent entry. + + + + + + + Inserts a node at the specified index. + + Index value where the node is to be inserted. + Value of the node to insert. + + + + Removes the specified node. + + Node value to look for and remove. + + + + Resets the cache. + + + + + Indicates whether the node belongs to this tree. + + Node value to search for. + True if node belongs to this tree; false otherwise. + + + + Returns the position of a node. + + Node value to look for. + Index of the node if found. + + + + Appends a node. + + Node value to append. + + + + + Indicates whether BeginInit was called. + + + + + Optimizes insertion of many elements when tree is initialized for the first time. + + + + + Ends optimization of insertion of elements when tree is initialized for the first time. + + + + + Adds a node into a sorted tree. + + Node value to add. + + + + + Adds a node in a sorted tree only if no node with the same value has not been added yet. + + + Node value to add. + + + + + Finds a node in a sorted tree. + + + + + + + Finds a node in a sorted tree that matches the specified key. + + The key to search. + The node; NULL if not found. + + + + Finds the node in a sorted tree is just one entry ahead of the + node with the specified key. It searches for the largest possible + key that is smaller than the specified key. + + The key to search. + The node; NULL if not found. + + + + Indicates whether the tree is Read-only. + + + + + Gets / sets the item with the specified index. + + Index value of the item. + + + + + Removes a node at the specified position. + + + + + + Inserts a node at the specified index. + + + + + + + Removes the node with the specified value. + + + + + + Indicates whether the node belongs to this tree. + + + + + + + Clears all nodes in the tree. + + + + + Returns the index of the specified node. + + + + + + + Adds the specified node to the tree. + + + + + + + Indicates whether the nodes can be added or removed. + + + + + Not supported. + + + + + Returns the number of leaves. + + + + + Returns the number of leaves. + + + + + Copies the element from this collection into an array. + + The destination array. + The starting index in thedestination array. + + + + Copies the elements from this collection into an array. + + The destination array. + The starting index in the destination array. + + + + Not implemented. + + + + + Returns an enumerator. + + + + + + Returns a . + + + + + + Strongly typed enumerator for . + + + + + Initializes a new . + + + + + + Resets the enumerator. + + + + + Returns the current enumerator. + + + + + Returns the current node. + + + + + Indicates whether to move to the next node. + + + + + + An object that holds an . + + + + + Gets a reference to the . + + + + + A collection of objects + that are internally using a . + + + + + Overloaded. Initializes a new . + + + + + Initializes a new . + + + + + Initializes a new . + + + + + Indicates whether BeginInit was called. + + + + + Optimizes insertion of many elements when tree is initialized for the first time. + + + + + Ends optimization of insertion of elements when tree is initialized for the first time. + + + + + Gets / sets an at a specific position. + + + + + Indicates whether object belongs to this collection. + + The value of the object. + True if object belongs to the collection; false otherwise. + + + + Returns the position of a object in the collection. + + The value of the object. + The position of the object. + + + + Copies the contents of the collection to an array. + + Destination array. + Starting index of the destination array. + + + + Returns a strongly typed enumerator. + + A strongly types enumerator. + + + + Inserts an object at the specified index. + + Index value where the object is to be inserted. + Value of the object to insert. + + + + Appends an object. + + The value of the object to append. + + + + + Removes the object. + + The value of the object to remove. + + + + Indicates whether tree is Read-only. + + + + + Gets / sets the item at the specified index. + + Index of the item. + The item at the specified index. + + + + Removes a node at the specified index. + + Index value of the node to remove. + + + + Inserts the object at the specified index. + + Index value of the object to insert. + Value of the object to insert. + + + + Removes the specified object. + + Value of the object to remove. + + + + Indicate whether the specified object belongs to this collection. + + Object value to look for. + True if object belongs to the collection; false otherwise. + + + + Clears all nodes in the tree. + + + + + Returns the index of the specified object. + + Value of the object. + Index value of the object. + + + + Adds the specified object to the collection. + + Value of the object to add. + + + + + Indicates whether the nodes can be added or removed. + + + + + Not supported. + + + + + Returns the number of objects in this collection. + + + + + Copies elements to destination array. + + Destination array. + Starting index of the destination array. + + + + Returns an enumerator. + + Enumerator. + + + + A strongly typed enumerator for the . + + + + + Initializes the . + + + + + + Resets the enumerator. + + + + + Returns the current enumerator. + + + + + Returns the current object. + + + + + Indicates whether to move to the next object in the collection. + + + + + + Interface definition for a node that has counters and summaries. + + + + + The total of this node's counter and child nodes. + + + + + The cumulative position of this node. + + + + + Marks all counters dirty in this node and child nodes. + + if set to true notify counter source. + + + + Interface definition for an object that has counters. + + + + + Returns the counter object with counters. + + + + + + Marks all counters dirty in this object and child nodes. + + if set to true notify counter source. + + + + Marks all counters dirty in this object and parent nodes. + + + + + Interface definition for a counter object. + + + + + Combines this counter object with another counter and returns a new object. A cookie can specify + a specific counter type. + + The other. + The cookie. + + + + + Compares this counter with another counter. A cookie can specify + a specific counter type. + + The other. + The cookie. + + + + + Indicates whether the counter object is empty. A cookie can specify + a specific counter type. + + The cookie. + + true if the specified cookie is empty; otherwise, false. + + + + + Returns the integer value of the counter. A cookie specifies + a specific counter type. + + The cookie. + + + + + Gets the Counter Kind. + + The kind. + + + + Default counter cookies for identifying counter types. + + + + + All counters. + + + + + Visible Counter. + + + + + A counter that counts objects that are marked "Visible". + + + + + Returns an empty TreeTableVisibleCounter that represents zero visible elements. + + + + + Initializes a with a specified number of visible elements. + + The visible count. + + + + The Counter Kind. + + + + + Returns the visible count. + + + + + Returns the integer value of the counter. A cookie specifies + a specific counter type. + + The cookie. + + + + + Combines one tree object with another and returns the new object. + + The other. + The cookie. + + + + + Factory method creates a new counter object of the same type as this object. + + + + + + Called to combine the values of two counter objects. Results are saved back into this counter object. + A cookie can filter the operation to a limited set of counter types. + + The x. + The y. + The cookie. + + + + Combines the counter values of this counter object with the values of another counter object + and returns a new counter object. + + The other. + The cookie. + + + + + Compares this counter with another counter. A cookie can specify + a specific counter type. + + The other. + The cookie. + + + + + Indicates whether the counter object is empty. A cookie can specify + a specific counter type. + + The cookie. + + true if the specified cookie is empty; otherwise, false. + + + + + Returns a that represents the current . + + + A that represents the current . + + + + + A tree table branch with a counter. + + + + + Initializes a new . + + + + + + Returns the tree this branch belongs to. + + + + + Gets / sets the parent branch. + + + + + Returns the cumulative counter position object of a child node with all counter values. + + The node. + + + + + Returns the left branch node cast to ITreeTableCounterNode. + + + + + + Returns the right branch node cast to ITreeTableCounterNode. + + + + + + Returns the total of this node's counter and child nodes (cached). + + + + + Returns the cumulative position of this node. + + + + + Invalidates the counter bottom up. + + if set to true notify counter source. + + + + Marks all counters dirty in this node and child nodes. + + if set to true notify counter source. + + + + A tree leaf with value, sort key and counter information. + + + + + Returns the tree this leaf belongs to. + + + + + Gets / sets the parent branch. + + + + + Creates a branch that can hold this entry when new leaves are inserted into the tree. + + + + + + + Returns the cumulative position of this node. + + + + + Returns the value as . + + + + + Indicates whether the counter was set dirty. + + True if dirty; False otherwise. + + + + Returns the total of this node's counter and child nodes. + + + + + Reset cached counter. + + + + + Invalidates the counter bottom up. + + if set to true notify counter source. + + + + Marks all summaries dirty in this node and child nodes. + + if set to true notify counter source. + + + + A balanced tree with entries. + + + + + Initializes a new . + + + + + + + Ends optimization of insertion of elements when tree is initialized for the first time. + + + + + Marks all counters dirty. + + + + + + Returns the total of all counters in this tree. + + + + + Returns the starting counter for this tree. + + + + + Overloaded. Returns an entry at the specified counter position. A cookie defines the type of counter. + + The search position. + The cookie. + + + + + Returns an entry at the specified counter position. A cookie defines the type of counter. + + The search position. + The cookie. + Indicates if the leftmost entry should be returned if multiple tree elements have the + same searchPosition. + + + + + Gets the entry at counter position. + + The start. + The search position. + The cookie. + + + + + Gets the entry at counter position. + + The start. + The search position. + The cookie. + if set to true prefer left most. + + + + + Returns the subsequent entry in the collection for which the specific counter is not empty. + A cookie defines the type of counter. + + The current. + The cookie. + + + + + Returns the previous entry in the collection for which the specific counter is not empty. + A cookie defines the type of counter. + + The current. + The cookie. + + + + + Returns the next entry in the collection for which CountVisible counter is not empty. + + The current. + + + + + Returns the previous entry in the collection for which CountVisible counter is not empty. + + The current. + + + + + Gets / sets a TreeTableWithCounterEntry. + + + + + Inserts a object at the specified index. + + The index. + The value. + + + + Removes an object from the tree. + + The value. + + + + Indicates whether an entry belongs to the tree. + + The entry. + + true if tree contains the specified entry; otherwise, false. + + + + + Returns the position of an object in the tree. + + The value. + + + + + Appends an object. + + The value. + + + + + Copies the elements of this tree to an array. + + The array. + The index. + + + + Returns a strongly typed enumerator. + + + + + + A strongly typed enumerator for the collection. + + + + + Initializes a new . + + + + + + Returns the current object. + + + + + An object that counts objects that are marked "Visible". It implements + the ITreeTableCounterSource interface and creates a . + + + + + Initializes the object with visible count. + + The visible count. + + + + Marks all counters dirty in this object and parent nodes. + + + + + Returns the counter object with counters. + + + + + + Marks all counters dirty in this object and child nodes. + + if set to true notify counter source. + + + + Interface definition for a summary object. + + + + + Combines this summary information with another object's summary and returns a new object. + + The other. + + + + + Interface definition for a node that has one or more summaries. + + + + + Indicates whether node has summaries. + + + + + Returns an array of summary objects. + + The empty summaries. + + + + + Marks all summaries dirty in this node and child nodes. + + if set to true notify entry summary. + + + + Provides a method. + + + + + Gets an array of summary objects. + + + + + Interface definition for an object that has summaries. + + + + + Returns an array of summary objects. + + An array of empty summary objects. + Returns True if summaries were recalculated; False if already cached. + An array of summary objects. + + + + Marks all summaries dirty in this object and child nodes. + + + + + Marks all summaries dirty in this object and parent nodes. + + + + + Marks all summaries dirty in this object only. + + + + + A tree table branch with a counter. + + + + + Initializes a new . + + + + + + Returns the tree this branch belongs to. + + + + + Gets / sets the parent branch. + + + + + Returns the left branch node cast to ITreeTableSummaryNode. + + + + + + Returns the right branch node cast to ITreeTableSummaryNode. + + + + + + Indicates whether this node has summaries. + + + + + Returns an array of summary objects. + + The empty summaries. + + + + + Walks up parent branches and reset summaries. + + + + + + Marks all summaries dirty in this node and child nodes. + + if set to true notify counter source. + + + + A tree leaf with value and summary information. + + + + + Returns the tree this leaf belongs to. + + + + + Gets / sets the parent branch. + + + + + Creates a branch that can hold this entry when new leaves are inserted into the tree. + + + + + + + Indicates whether the node has summaries. + + + + + Returns an array of summary objects. + + The empty summaries. + + + + + Called from when called the first time after summaries were invalidated. + + The empty summaries. + + + + + Returns the value as . + + + + + Walks up parent branches and reset summaries. + + + + + + Marks all summaries dirty in this node and child nodes. + + if set to true notify summary array source. + + + + A balanced tree with entries. + + + + + Initializes a new . + + + + + + Marks all summaries dirty. + + if set to true notify summaries source. + + + + Indicates whether the tree has summaries. + + + + + Returns an array of summary objects. + + + + + Gets / sets a TreeTableWithSummaryEntry. + + + + + Inserts a object at the specified index. + + + + + + + Removes an object from the tree. + + + + + + Indicates whether an object belongs to the tree. + + + + + + + Returns the index of an object in the tree. + + + + + + + Appends an object. + + + + + + + Copies the elements of this tree to an array. + + + + + + + Returns a strongly typed enumerator. + + + + + + A strongly typed enumerator for the collection. + + + + + Initializes a new . + + + + + + Returns the current object. + + + + + Provides the base class for a strongly typed collection of key-and-value pairs. + + + This class is very similar to the + class. The main difference is that this version allows you to set the InnerHashtable. + only provides a Read-only property for the + InnerHashtable. + + + + Initializes a new . + + + Initializes a new . + + + + + Initializes a new and associates it with a . + + The inner collection that will hold entries of this collection. + + + + Clears the contents of the instance. + + + + + Copies the elements to a one-dimensional at the specified index. + + The one-dimensional that is the destination of the objects copied from the instance. The must have zero-based indexing. + The zero-based index in an at which copying begins. + + + + Returns a that can iterate through the instance. + + + A for the instance. + + + + + Returns the enumerator. + + Enumerator. + + + + Performs additional custom processes before clearing the contents of the instance. + + + + + Returns the element with the specified key and value in the + instance. + + The key of the element to get. + The current value of the element associated with . + + A containing the element with the specified key and + value. + + + + + Performs additional custom processes before inserting a new element into the + instance. + + The key of the element to insert. + The value of the element to insert. + + + + Performs additional custom processes before removing an element from the instance. + + The key of the element to remove. + The value of the element to remove. + + + + Performs additional custom processes before setting a value in the instance. + + The key of the element to locate. + The old value of the element associated with . + The new value of the element associated with . + + + + Performs additional custom processes when validating the element with the specified key and value. + + The key of the element to validate. + The value of the element to validate. + + + + Adds the element with the specified key and value to the instance. + + + + + + + Returns the list of keys contained in the instance. + + + + + Returns the list of values contained in the instance. + + + + + Removes the number of elements contained in the + instance. + + + + + Removes the list of elements contained in the instance. + + + + + Gets / sets the list of elements contained in the instance. + + + + + Indicates whether + the is Read-only. + + + + + Indicates whether the has a fixed size. + + + + + Indicates whether access to + the is synchronized (thread-safe). + + + + + Gets an object that can be used to + synchronize access to the . + + + + + If the static DesignerPersistance.IsPersisting property gets set, then deriving from this type will do the following: + It will return a custom property descriptor for the properties it contains that will return property values + after checking the ShouldSerializeXXX impl. This is useful while serializing web pages in the designer - as the + web designer doesn't check for ShouldSerializeXXX, by default. + + + + + Provides predefined switches for enabling / disabling trace + output or code instrumentation in the Syncfusion shared library. + + + + General switch for Shared Library. + + + + Returns the General Tracing level for the Grid Library. + + + + Enable Tracing for the Styles. + + + Enable Tracing for the Shared Serialization. + + + Enable Tracing for the ScrollControl. + + + Enable Tracing for Timer Start and Stop + + + Enable Tracing for Timer Start and Stop. + + + Enable Tracing for BeginUpdate and EndUpdate methods calls + + + Enable Tracing for MouseController. + + + Enable Tracing for OperationFeedback. + + + Enable Tracing for BrushPaint drawing methods. + + + Enable Tracing for ArrowButtonBar events. + + + Enable Tracing for ButtonBar events. + + + Enable Tracing for RecordNavigationBar events. + + + Enable Tracing for RecordNavigationControl events. + + + Enable Tracing for SplitterControl events. + + + Enable Tracing for TabBar events. + + + Enable Tracing for TabBarSplitterControl events. + + + Enable Tracing for MouseControllerDispatcher events. + + + Enable Tracing for ScrollControl events. + + + Enable Tracing for Focus events. + + + + Provides various diagnostic utilities for tracing methods, exception and more. + + + + + + + + + + + Writes a trace log for the given exception together with information where the exception was caught. + + An Exception. + + + + Indicates whether a given procedure is being called by another procedure. + + The method to be looked up in the stack trace. + True if method was found; false otherwise. + + + if (TraceUtil.IsCalledFrom(typeof(Form1).GetMethod("Form1_Load", BindingFlags.NonPublic|BindingFlags.Instance))) + Debugger.Break(); + + + + + + Writes a trace log of the current stack. + + + Writes a trace log of the current stack. + + + + + Writes a trace log with information about current class and method name and + string representations of any method arguments if the condition is true. + + Indicates whether to skip or write the log. + An array of method arguments. + The number of levels to check in call stack. + The following method shows typical usage of this diagnostic method. + + private void OnTimerElapsed(object source, ElapsedEventArgs e) + { + TraceUtil.TraceCalledFromIf(Switches.Timers.TraceVerbose, 3); + } + + + + + + Writes a trace log of the current stack. + + The number of method on the stack to trace. + + + + Writes a trace log with information about current class and method name and + string representations of any method arguments. + + An array of method arguments. + + + + Writes a trace log with information about current class and method name and + string representations of any method arguments if the condition is true. + + Indicates whether to skip or write the log. + An array of method arguments. + The following method shows typical usage of this diagnostic method. + + private void OnTimerElapsed(object source, ElapsedEventArgs e) + { + TraceUtil.TraceCurrentMethodInfoIf(Switches.Timers.TraceVerbose); + } + + + + + + Provides a diagnostic utility for measuring performance. + + The following example display a message box with performance info. + + private void button1_Click(object sender, System.EventArgs e) + { + int rows = (int) this.numericUpDown1.Value; + this.gridControl1.theData = new VirtGrid.VirtData(rows, 20); + this.gridControl1.Refresh(); + using (Syncfusion.Diagnostics.MeasureTime.Measure("gridControl1.TopRowIndex = 500000")) + { + this.gridControl1.TopRowIndex = 5000000; + } + MessageBox.Show(Syncfusion.Diagnostics.MeasureTime.DumpTimes()); + } + + + + + + Returns the time since Reset in microseconds. + + + + + Insert this before a code block that should be measured. + + + + + Ends the code block that should be measured and increments the associated performance counter. + + + + + Prints all performance counters into a string and sorts it by ids. All counters will be reset afterwards. + + + + + Provides support for capturing an ActiveX or Windows Forms control to a bitmap. + + + + + Captures the contents of an ActiveX control to a bitmap using the IViewObject interface. + + + Captures the contents of an ActiveX control to a bitmap using the IViewObject interface. + + The ActiveX control. + The bitmap with the display contents of the ActiveX control. + + The control must have an implementation of the IViewObject interface. + + + + + Captures the contents of an ActiveX control to a bitmap using the IViewObject interface. + + The ActiveX control. + Indicates whether IViewObject2 interface should be used if available. + The bitmap with the display contents of the ActiveX control. + + + + + Indicates whether there are issues with WM_PRINT and it is not properly supported by the framework. + The property is available to provide a workaround for issues with GenericControlCell and early Whidbey builds. Default is false. + + + + + if (Environment.Version.Major >= 2) + ActiveXSnapshot.ForceWmPaintInPrintWindow = true; + + + + + + + Captures the contents of a Windows Forms control using the WM_PRINT message. + + The control to be captured. + The bitmap with the display contents of the Windows Forms control. + + + + Captures the contents of a Windows Forms control using the WM_PRINTCLIENT message. + + The control to be captured. + The bitmap with the display contents of the Windows Forms control. + + + + Captures the contents of a Windows Forms control using the WM_PRINTCLIENT or WM_PRINT message. + + The control to be captured. + WM_PRINT or WM_PRINTCLIENT. + Flags used for the WM_PRINT message. + The size of the window. + The bitmap with the display contents of the Windows Forms control. + + + + Temporarily resizes the control without updating the screen. Call + to switch the control back to regular behavior. + + The target control. + The new size. + The saved bounds of the control. + + + + Ends temporary resizing of a control after you called . + + The target control. + The saved bounds of the control. + + + + Sends a WM_LBUTTONDOWN and WM_LBUTTONUP message to the control at the specified client coordinates. + + The target control. + The client coordinates where to simulate the click. + + + + Utility class comes handy when you need to perform simple + animations in your control. + + + The method in this class allows you to specify the + number of animation positions (0 to N), the direction of animation + (whether animation is from 0 towards N or from N towards 0), and + the speed (X) at which animation is performed. + + When the method is called, the current animation position + is set ( property) which gets reduced (or + incremented based on the direction of animation) every X time + interval specified in the method call, until it reaches + the other extreme of the Animation position range. Every time + the value changes, an event + is thrown. Upon reaching the last animation position, an + event is thrown. + + + + + + Creates an instance of the AnimationHelper class. + + + + + Returns the maximum animation position specified in the + method. + + + An integer value indicating the maximum animation position. + + + + + Returns the current animation position once animation is started. + + An integer value some where in between (including) + 0 and . + + + + Indicates whether Animation is on. + + True indicates Animation is on; False otherwise. + + + + + Indicates in which direction animation is performed. + + True indicates animation is towards ; + False indicates animation is towards zero. + + + + Indicates whether more animation positions are to be drawn to complete this animation. + + True indicates there is more to come; False otherwise. + + + + Defines the animation range: 0 to maxPosition; specifies the + direction of animation: 0 to maxPositon or maxPosition to 0; + specifies the interval at which animation should be performed: interval, + and starts animation. + + The integer value indicating + the max position of animation. + The direction of animation. + The frequency at which animation is performed. + + This class uses a to trigger + the event, which means events will + be thrown within the same thread as this method call. + + + + + Allows you to stop animation abruptly (if it is currently on). + This will then throw the event. + + + + + Triggers to force drawing next animation position. + + + You can optionally use this method to force animation not waiting for the timer to break. + + + + + Will be thrown as the property changes + during animation. + + + After calling , you should listen to this event to + repaint your control for each new animation position. + + + + + This will be called when animation is complete or when + is called. + + + + + Holds information on how to fill the background of a window or grid cell. + + + BrushInfo lets you specify a solid backcolor, gradient or pattern style with both + back and forecolor. + + This information can be persisted with serialization. + + You can also convert the information to a string and recreate it from a string. + + BrushInfo is immutable (just like ). You cannot change its values. + Instead you have to create a new BrushInfo object. + + BrushInfo can also be persisted into code when used as a property in a component designer. + + shows how to fill a rectangle using + information. + + + + + An empty BrushInfo. + + + + + Overloaded. Initializes a new empty instance of BrushInfo. + + + + + Initializes a new instance of BrushInfo with the specified solid backcolor. + + A used as solid background. + + + + Initializes a new instance of BrushInfo with a solid backcolor and forecolor. + + + + + Initializes a new instance of BrushInfo with a hatch style and pattern colors. + + A . + A used for the pattern. + A used for the pattern. + + + + Initializes a new instance of BrushInfo with a hatch style and pattern colors. + + A . + List of colors. + + + + Initializes a new instance of BrushInfo with a hatch style and pattern colors. + + A . + List of colors. + + + + Initializes a new instance of BrushInfo with a gradient style and gradient fill colors. + + A . + A used for the gradient fill. + A used for the gradient fill. + + + + Initializes a new instance of BrushInfo with a gradient style and gradient fill colors. + + A . + List of gradient fill colors. + + + + Initializes a new instance of BrushInfo with a hatch style and pattern colors. + + A . + List of colors. + + + + Initializes a new instance of BrushInfo with any BrushStyle. Internal only. + + + + + Initializes a new instance of BrushInfo with a new alpha-blend value and copies other information from a given BrushInfo. + + The alpha value that should be applied to the forecolor and backcolor of the new brush. + A BrushInfo that holds information for this BrushInfo. + + + + Initializes a new instance of BrushInfo and copies its information from a given BrushInfo. + + A BrushInfo that holds information for this BrushInfo. + + + + Creates a new BrushInfo object and initializes it from a string. + + A string in the format BrushStyle;Style;ForeColor;BackColor. + A new BrushInfo object. + + + + Overloaded. Returns the string representation of the brush in the format BrushStyle;Style;ForeColor;BackColor. + + + + + Returns the string representation of the brush in the format BrushStyle;Style;ForeColor;BackColor. + + + + + + + Returns the string representation of the brush in the format BrushStyle;Style;ForeColor;BackColor. + + Specifies the format for string. NULL for default, "compact" for a compact string, "G" for more descriptive text. + + + + + Returns the string representation of the brush in the format BrushStyle;Style;ForeColor;BackColor. + + Specifies the format for string. NULL for default, "compact", for a compact string or "G" for more descriptive text. + + The IFormatProvider to use to format the value. + -or- + A reference to obtain the numeric format information from the current locale setting + of the operating system. + + + + + + Overridden. Compares two BrushInfo object and indicates whether they are equal. + + The to compare with the current . + True if the specified Object is equal to the current ; false otherwise. + + + + + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Creates a new BrushInfo with the same style but with only black and white colors. + + A new object with the same style and black and white colors. + + + + Returns a string id that you can use to store the BrushInfo in a HashTable. + + A string with compact identitiy information about the BrushInfo. + + + + Returns a string description of the BrushInfo. See . + + + + + Indicates whether this is an empty object. + + + + + Returns the backcolor. + + + + + Returns the forecolor. + + + + + Returns the gradient colors. + + A reference to the instance. +

This color list will be used to specify the + or the depending on the + selected.

+

The first entry in this list will be the same as the property and + the last entry (not the 2nd) will be the same as the property.

+

+ Note that this list is Read-only. +

+ + + + + Returns the pattern style. + + + + + Returns the gradient style. + + + + + Returns the brush style (solid, gradient or pattern). + + + + + Serializes the contents of this object into an XML stream. + + Represents the XML stream. + + + + Not implemented and returns NULL. + + + + + + Deserializes the contents of this object from an XML stream. + + Represents the XML stream. + + + + A list of colors returned by the property + in the type. + + + When returned by the property, this list will + be made Read-only. + + + + + Overloaded. Creates a new instance of this class. + + + + + Creates a new instance of this class with some colors. + + An array of colors. + + + + Initializes a new from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Returns the color at the specified index. + + + + + Provides a way to convert to a string and from a string. + + + + + + + + + + + + + + + + + + + + + + + Paints window background using information. + + + + + Overloaded. Fills the interior of a rectangle using information. + + A context. + structure that represents the rectangle to fill. + object that determines the characteristics of the fill. + + + + Fills the interior of a rectangle using information. + + A context. + Structure that represents the rectangle to fill. + Object that determines the characteristics of the fill. + + + + Fills the interior of a rectangle with a gradient. + + A context. + Structure that represents the rectangle to fill. + . + A used for the gradient fill. + A used for the gradient fill. + + + + Fills the interior of a rectangle with a gradient. + + A context + Structure that represents the rectangle to fill. + . + A used for the gradient fill. + A used for the gradient fill. + + + + Fills the interior of a rectangle with a gradient. + + A context + Structure that represents the rectangle to fill. + . + An array of used for the gradient fill. + + + + Fills the interior of a rectangle with a gradient. + + A context + Structure that represents the rectangle to fill. + . + An array of used for the gradient fill. + + + + Fills the interior of a rectangle with a pattern. + + A context + Structure that represents the rectangle to fill. + . + A used for the pattern fill. + A used for the pattern fill. + + + + Fills the interior of a rectangle with a pattern. + + A context + Structure that represents the rectangle to fill. + . + A used for the pattern fill. + A used for the pattern fill. + + + + Fills the interior of a rectangle with a solid color. + + A context. + Structure that represents the rectangle to fill. + A . + + + + Fills the interior of a rectangle with a solid color. + + A context. + Structure that represents the rectangle to fill. + A . + + + + Overloaded. Fills the interior of a region using information. + + A context. + Structure that represents the region to fill. + object that determines the characteristics of the fill. + + + + Fills the interior of a region with a gradient. + + A context. + Structure that represents the region to fill. + . + A used for the gradient fill. + A used for the gradient fill. + + + + Fills the interior of a region with a gradient. + + A context. + structure that represents the region to fill. + . + An array of used for the gradient fill. + + + + Fills the interior of a region with a pattern. + + A context. + Structure that represents the region to fill. + . + A used for the pattern fill. + A used for the pattern fill. + + + + Fills the interior of a region with a solid color. + + A context. + Structure that represents the region to fill. + A . + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Specifies the BrushStyle used by . + + + + + The is an empty object. + + + + + The represents a solid fill. + + + + + The represents a pattern fill. + + + + + The represents a gradient fill. + + + + + Conversion methods for a to and from a string. + + + + + ColorFromString parses a string previously generated with ColorToString and returns a color. + + String generated with ColorToString. + + Color value that was encoded in parseStr. + + + + + + ColorToString creates a string from a color. All information such as + knownColor and name in the color structure will be preserved. + + + + + A string that can be passed as parameter to ColorFromString. + + + + + + + + + + Implement this method and draw your NonClient area using the passed in parameters. + + The PaintEventArgs using this to draw the non client area. + The control's window bounds into which to draw. Left and Top are usually zero. + The control's bounds in screen co-ordinates. + + HRgn (as IntPtr) that excludes the region you just drew in the displayRect. + + + + + + + + + + + + + Call this method to help you prepare for non client painting. This method will in turn + call your INonClientPaintingSupport.NonClientPaint implementation. + + The control in which we will be drawing. + The INonClientPaintingSupport implementation to which we will delegate the final non client drawing. + The WM_NCPAINT message. + + + + + + + + + + + + + + + + + Paints a rectangular area with the given colors in Office2007 style. + + A object. + A object that represents the drawing area. + The border color. + The top gradient start color. + The top gradient end color. + The bottom gradient start color. + The bottom gradient end color. + The bottom line color. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Adjusts the specified forecolor's brightness based on the specified backcolor and preferred contrast. + + The forecolor to adjust. + The backcolor for reference. + Preferred contrast level. + + This method checks if the current contrast in brightness between the 2 colors is + less than the specified contrast level. If so, it brightens or darkens the forecolor appropriately. + + + + + Draws an image using the ImageList, taking into account the Graphics.ClipBounds. + + The Graphics object into which to draw. + The ImageList containing the image. + The index of the image. + The rectangle into which to draw. + + This method will use ImageList_DrawEx to draw the image (to use the transparency info in the embedded images). + We use the PInvoke rather than ImageList.Draw because, the Draw method + uses the PaintEventArgs.ClipRectangle rather than g.ClipBounds (both + can be different) and here we force the ClipBounds on the DC. +

+ Also, you do not have to use this method if your images will never be + drawn clipped (in that case just use ImageList.Draw). +

+ + + + Draws specified image to graphics context. + If image size is less than maxWidth, maxHeight parameters, it will be drawn + without any changes, otherwise - it will be scaled proportionally to those values. + + Graphics context. + Image object which must be drawing. + X coordinate of the destination location. + Y coordinate of the destination location. + Maximum width of the image. + Maximum height of the image. + + + + Converts the HSB value to RGB. + + Hue. + Saturation. + Brightness. + Red. + Green. + Blue. + + This does not seem to yield accurate results, but very close. + + + + + Enumeration of Panose Font Family Types. These can be used for + determining the similarity of two fonts or for detecting non-character + fonts like WingDings. + + + + + Any + + + + + No Fit + + + + + Text and Display + + + + + Script + + + + + Decorative + + + + + Pictorial + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the for the specified font. + + A graphics object to use when detecting the Panose + family. + The font to check. + The Panose font family type. + + + + + + + + + + + + + + + + + + + + + + + Gets / sets the ImageList to wrap around. + + + + + Gets/ sets the base directory from which the images will be added. + + + This helps to maintain a relative path in the SourceFiles list. + + + + + + + + + + + Returns the source of the images in the underlying ImageList. + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + The type of the collection to edit. + + + Creates an instance of the specified type in the collection. + The type of the image to insert in the collection. + + + + + + + + + + + Apply functionality to choose alpha-blended icon and correctly change it to bitmap. + + + + + Stores info about drawing icons. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Utility class for mirroring graphics output if needed. + + + + + + Value of advanced graphics state. + + + + + Mode of transformation matrix multiplication. + + + + + Graphics object for target context. + + + + + Temporary virtual Graphics object. + + + + + Temporary bitmap object. + + + + + Target rectangle. + + + + + Rectangle of virtual temporary area. + + + + + Target graphics path. + + + + + Indicates whether image must be mirrored. + + + + + Indicates whether OS supports needed API functions. + + + + + Holds old value of source graphics mode. + + + + + Holds old value of source graphics transformation. + + + + + Handle wrapper of graphics object. + + + + + Handle of graphics object. + + + + + Returns virtual graphics context object. + + + + + Returns virtual rectangle. + + + + + Returns virtual Graphics path object. + + + + + Indicates whether additional bitmap is needed. + + + + + Private constructor. + + + + + Overloaded. Creates a new mirror object for drawing mirrored images. + + Source graphics object. + Source graphics path object. + If True mirror output; False otherwise. + + + + Creates a new mirror object for drawing mirrored images. + + Source graphics object. + Source rectangle structure. + If True mirror output; False otherwise. + + + + Overloaded ctor.. as a workaround for Themed Mirrored rendering issue. + + Creates a new mirror object for drawing mirrored images. + + Source graphics object. + Source rectangle structure. + If True mirror output; False otherwise. + False as a workaround when drawing themed mirrored graphics. + + + + Disposes all resources, but first paints all data + from the buffer to source device context. + + + + + Initializes an object. + + Source graphics object. + Source rectangle structure. + If True mirror output; False otherwise. + + + + Checks OS Version for API functions support. + Need NT 3.1 or later. + + True if current OS is NT 3.1 or later; False otherwise. + + + + Transforms graphics. + + + + + Restores graphics to its previous state. + + + + + Flushes all drawing data to destination if needed. + + + + + Class does 2D ratio and offset tranformation for object using property. + + Transform is done in constructor and reverted in Dispose() method. + + + Supposed to be used with keyword. + + + + + + + + + + + + + + + + + + + + + + Class does 2D mirroring for X axis for . + + Transform is done in constructor and reverted in Dispose() method. + + + Supposed to be used with keyword. + + + + + + + + + + + + + + + + Class does 2D mirroring for Y axis for . + + Transform is done in constructor and reverted in Dispose() method. + + + Supposed to be used with keyword. + + + + + + + + + + + + + + + + Specifies the Gradient style used by the . + + + + + None. + + + + + ForwardDiagonal Gradient. + + + + + BackwardDiagonal Gradient. + + + + + Horizontal Gradient. + + + + + Vertical Gradient. + + + + + PathRectangle Gradient. + + + + + PathEllipse Gradient. + + + + + Provides a for the enumeration. + + + + + + + + + + + Provides data for the event of + a instance. + + + The event lets you apply custom settings for the Graphics object, before + other routines draw to the object. + + + + + + + + Initializes a new empty . + + + Initializes a new with a object. + + The graphics object. + + + + Initializes a new empty . + + + + + Returns the window graphics object. + + + + + Represents a method that handles a event of + a instance. + + + + + Implements an interface that returns a graphics context when needed and raises a + event to initialize the graphics object. + + + + + Creates and returns a cached graphics object. + + + + + Called after a new object was created and gives the handler + a chance to initialize the graphics context. + + + + + Returns a graphics context when needed and raises a + event to initialize the graphics object. + + + + + Called after a new object was created and gives the handler + a chance to initialize the graphics context. + + + + + Initializes a new empty . + + + Initializes a new with a object. + + The Graphics object that will be used. + The event will not be fired when this type + is instantiated via this constructor. + + + + Initializes a new with a object. + + The control that will be used for creating the graphics object. + + + + Initializes a new empty . + + + + + + + + Creates and returns a cached graphics object. + + + + + Raises the event. + + A that contains the event data. + + + + + + + + + + IconPaint is a helper class for drawing and caching bitmaps from a resource manifest with a given forecolor. + + + The bitmaps are loaded from the manifest and cached. The PaintIcon routine + will substitute black pixels of the original bitmap and draw them with a + specified forecolor. + + + + + The bitmap cache. + + + + + The manifest to load from. The bitmaps should be saved in the Resources + tree in the Visual Studio project with the build action set to "Embedded Resource". + + + + + The assembly to load from. The bitmaps should be saved in the Resources + tree in Visual Studio project with the build action set to "Embedded Resource". + + + + + Initializes a new object with manifestPrefix and a reference to the assembly + to load bitmaps from. You should save this object in a static variable. + + The manifest to load from. The bitmaps should be saved in the Resources + tree in the Visual Studio project with the build action set to "Embedded Resource". + The assembly to load from. The bitmaps should be saved in the Resources + tree in Visual Studio project with the build action set to "Embedded Resource". + + + + Loads bitmap from manifest. + + The bitmap name. + Reference to bitmap; NULL if bitmap failed to load. + + + + Returns bitmap from cache or loads bitmap from manifest on first use. + + The bitmap name. + Reference to bitmap; NULL if bitmap failed to load. + + + + Calculates coordinates for a centered rectangle. + + The existing bounds. + The size of the rectangle to be centered. + A rectangle inside the specified bounds. + + + + Paints the specified bitmap substituting black pixels with a new color. + + A Graphics object used to draw the bitmap. + A Rectangle which contains the boundary data of the rectangle. + A Point that specifies pixels to offset the bitmap from its origin point. + The bitmap to be drawn on the screen. + The new color used to substitute black pixels. + A Rectangle which contains the boundary data of the drawn bitmap. + + The PaintIcon routine + will substitute black pixels of the original bitmap and draw them with the + specified forecolor. The bitmap is centered inside the specified bounds. + Use the offset if you want to display a "pressed button" state. If the button is + pressed, specify offset = new Point(1, 1). + + + + + Loads the bitmap from the manifest and paints it substituting black pixels with a new color. + + A Graphics object used to draw the bitmap. + A Rectangle which contains the boundary data of the rectangle. + A Point that specifies pixel to offset the bitmap from its origin point. + The name of the bitmap. + The new color used to substitute black pixels. + A Rectangle which contains the boundary data of the drawn bitmap. + + The PaintIcon routine + will substitute black pixels of the original bitmap and draw them with the + specified forecolor. The bitmap is centered inside the specified bounds. + Use the offset if you want to display a "pressed button" state. If the button is + pressed, specify offset = new Point(1, 1). + + + + + Specifies the pattern style used in + + + + + None. + + + + + + A pattern of horizontal lines. + + + + + + + A pattern of vertical lines. + + + + + + + A pattern of lines on a diagonal from top-left to bottom-right. + + + + + + A pattern of lines on a diagonal from + top-right to bottom-left. + + + + + + A pattern of criss-cross horizontal and vertical lines. + + + + + + + A pattern of criss-cross diagonal lines. + + + + + + Specifies a 5-percent hatch. The ratio of foreground color to background color is 5:100. + + + + + Specifies a 10-percent hatch. The ratio of foreground color to background color is 10:100. + + + + + Specifies a 20-percent hatch. The ratio of foreground color to background color is 20:100. + + + + + Specifies a 25-percent hatch. The ratio of foreground color to background color is 25:100. + + + + + Specifies a 30-percent hatch. The ratio of foreground color to background color is 30:100. + + + + + Specifies a 40-percent hatch. The ratio of foreground color to background color is 40:100. + + + + + Specifies a 50-percent hatch. The ratio of foreground color to background color is 50:100. + + + + + Specifies a 60-percent hatch. The ratio of foreground color to background color is 60:100. + + + + + Specifies a 70-percent hatch. The ratio of foreground color to background color is 70:100. + + + + + Specifies a 75-percent hatch. The ratio of foreground color to background color is 75:100. + + + + + Specifies a 80-percent hatch. The ratio of foreground color to background color is 80:100. + + + + + Specifies a 90-percent hatch. The ratio of foreground color to background color is 90:100. + + + + + Specifies diagonal lines that slant to the right from top points to bottom points and are spaced 50 percent closer together than BackwardDiagonal, but they are not antialiased. + + + + + Specifies 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. + + + + + Specifies diagonal lines that slant to the right from top points to bottom points, are spaced 50 percent closer together than, and are twice the width of ForwardDiagonal. This hatch pattern is not antialiased. + + + + + Specifies diagonal lines that slant to the left from top points to bottom points, are spaced 50 percent closer together than BackwardDiagonal and are twice its width, but the lines are not antialiased. + + + + + Specifies 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. + + + + + Specifies 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. + + + + + Specifies light vertical lines. + + + + + Specifies light horizontal lines. + + + + + Specifies narrow vertical lines . + + + + + Specifies narrow horizontal lines + + + + + Specifies vertical lines that are spaced 50 percent closer together than Vertical and are twice its width. + + + + + Specifies horizontal lines that are spaced 50 percent closer together than Horizontal and are twice the width of HatchStyleHorizontal. + + + + + Specifies dashed diagonal lines, that slant to the right from top points to bottom points. + + + + + Specifies dashed diagonal lines, that slant to the left from top points to bottom points. + + + + + Specifies dashed horizontal lines. + + + + + Specifies dashed vertical lines. + + + + + Specifies a hatch that has the appearance of confetti. + + + + + Specifies a hatch that has the appearance of confetti and is composed of larger pieces than SmallConfetti. + + + + + Specifies horizontal lines that are composed of zigzags. + + + + + Specifies horizontal lines that are composed of tildes. + + + + + Specifies a hatch that has the appearance of layered bricks that slant to the left from top points to bottom points. + + + + + Specifies a hatch that has the appearance of horizontally layered bricks. + + + + + Specifies a hatch that has the appearance of a woven material. + + + + + Specifies a hatch that has the appearance of a plaid material. + + + + + Specifies a hatch that has the appearance of divots. + + + + + Specifies horizontal and vertical lines, each of which is composed of dots, that cross. + + + + + Specifies forward diagonal and backward diagonal lines, each of which is composed of dots, that cross. + + + + + Specifies a hatch that has the appearance of diagonally-layered shingles that slant to the right from top points to bottom points. + + + + + Specifies a hatch that has the appearance of a trellis. + + + + + Specifies a hatch that has the appearance of spheres laid adjacent to one another. + + + + + Specifies horizontal and vertical lines that cross and are spaced 50 percent closer together than hatch style Cross. + + + + + Specifies a hatch that has the appearance of a checkerboard. + + + + + Specifies a hatch that has the appearance of a checkerboard with squares that are twice the size of SmallCheckerBoard. + + + + + Specifies forward diagonal and backward diagonal lines that cross but are not antialiased. + + + + + Specifies a hatch that has the appearance of a checkerboard placed diagonally. + + + + + Provides a for the enumeration. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Convert between inches and twips (1/1440 inch, used by Win32 API calls). + + Value in inches. + Value in twips. + + + + Helper routines for drawing rotated text. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents a class that contains the properties for customizing the styles of the check box. + + + + + Maintains the default style of the currentcell to read. + + + + + Maintains the default style of the CurrentCellStyleInfo. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The that need to be initialized. + + + + Initializes a new instance of the class. + + The . + + + + Initializes a new instance of the class. + + . + + + + Initializes a new instance of the class. + + . + The . + + + + Gets the default style of the . + + + + + Gets or sets the size of the check box. + + + + + Gets or sets the border color of the unchecked state check box. + + + + + Gets or sets the back color of the unchecked state check box. + + + + + Gets or sets the back color of the checked state check box. + + + + + Gets or sets the border color of the checked state check box. + + + + + Gets or sets the tick color of the checked state check box. + + + + + Gets or sets the color of the indeterminate state check box. + + + + + Gets or sets the border color of the indeterminate state check box. + + + + + Gets or sets the back color of the indeterminate state check box. + + + + + Gets or sets a value indicating the alignment of the check box. + + + + + Gets a value indicating whether padding has been initialized for the control. + + + + + Makes an exact copy of the current object. + + The new owner style object for the copied object. + The identifier for this object. + A copy of the current object registered with the new owner style object. + + + + Retrieves the default style of the current cell. + + Returns the default style of the current cell. + + + + Determines a value indicating whether to serialize property. + + True if the property was modified; Otherwise False. + + + + Implements the data store for the object. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Provides information about the property. + + + + + Maintains the static data for the CheckBoxCellStyleInfo. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Populates the SerializationInfo store with the name, type, and value of each piece of information it wants to serialize + Describes the source and destination of a given serialized stream, and provides an additional caller-defined context. + + + + Overridden to gets the static data. + + + + + Overridden to create the exact copy of the current instance. + + Returns the copied object. + + + + Initializes the , if is null. + + + + + + Represents the base class for visual styles to define the elements style. + + + + + Initializes a new instance of the class and associates it with an existing . + + + + + Initializes a new instance of the class and associates it with an existing . + + A that holds data for this object. + All changes in this style object will be saved in the object. + + + + + Initializes a new instance of the class and associates it with an existing and . + + A that holds the identity for this . + A that holds data for this object. + All changes in this style object will be saved in the object. + + + + + Updates the styles from the XML configured file to the target style. + + The control that is defined with the . + + + + Provide the default style of the . + + Default style object. + + + + Provides storage for the object. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Gets a Static data must be declared static in derived classes (this avoids collisions + when StyleInfoStore is used in the same project for different types of style + classes). + + + + + Provides style identity information for nested expandable objects of the GridStyleInfo and TreeStyleInfo classes. + + + + + Creates a new object and associates it with a . + + The that owns this subobject. + The descriptor for this expandable subobject. + + + + + + + + + + Looks for an entry that contains the given key, null is returned if the + key is not found. + + + + + A routine used by enumerators that need a sorted map + + + + + A routine used by enumerators to iterate through the map + + + + + A routine used to iterate through all the entries in the map + + + + + Promotes the key/value pairs in the current collection to the next larger + and more complex storage model. + + + + + Size of this data store + + + + + A simple class to handle a single key/value pair + + + + + A simple class to handle a single object with 3 key/value pairs. The pairs are stored unsorted + and uses a linear search. Perf analysis showed that this yielded better memory locality and + perf than an object and an array. + + + This map inserts at the last position. Any time we add to the map we set _sorted to false. If you need + to iterate through the map in sorted order you must call Sort before using GetKeyValuePair. + + + + + A simple class to handle a single object with 6 key/value pairs. The pairs are stored unsorted + and uses a linear search. Perf analysis showed that this yielded better memory locality and + perf than an object and an array. + + + This map inserts at the last position. Any time we add to the map we set _sorted to false. If you need + to iterate through the map in sorted order you must call Sort before using GetKeyValuePair. + + + + + A simple class to handle an array of between 6 and 12 key/value pairs. It is unsorted + and uses a linear search. Perf analysis showed that this was the optimal size for both + memory and perf. The values may need to be adjusted as the CLR and Avalon evolve. + + + + + FrugalMapIterationCallback + + + + + Allows you to specify a custom name for the StaticData field + in a . + + + + + Specifies the default field name as "staticDataStore". + + + + + Initializes a new instance of the class. + + + + + + + + + + + + + + Returns the field name in the class + that identifies the static data store. + + + + + Provides data for the event. + + + + + Initializes the object with the property that has changed. + + Identifies the property that has changed. + + + + Returns the property that has changed. + + + + + Handles the event. + + The source of the event. + A that contains the event data. + + + + + + + Defines an interface implemented both by and + that allows you to check the state of the object, read and write specific property and execute + style operations with the . method. + + + + + Indicates whether the style is empty. + + + + + Indicates whether any properties for this object have changed since it was applied last time. + + + + + Compares all properties with another style object and indicates whether + the current set of initialized properties is a subset of + the other style object. + + The other style to compare with. + True if this style object is a subset of the other style object. + + + + Applies changes to a style object as specified with . + + The style object to be applied on the current object. + The actual operation to be performed. + + + + Merges two styles. Resets all properties that differ among the two style object + and keeps only those properties that are equal. + + The other style object this style object should merge with. + + + + Returns the object that holds all the data for this style object. + + + + + Parses a given string and applies the results to affected properties in this style object. + + The string to be interpreted. + + consumes strings previously generated with + a method call. + + + + + Indicates whether a specific property has been initialized for the current object. + + A that identifies the property to operate on. + + + + Queries the value for a specific property that has been initialized for the current object. + + A that identifies the property to operate on. + + + + defines an interface for classes + used as sub-objects in a . + + + implements this interface. + + + + + Returns a unique identifier for this sub object in the owner style object. + + + + + Returns a reference to the owner style object. + + + + + Returns the data for this object. This is the StyleInfoStore from the constructor. + + + + + Makes an exact copy of the current object. + + The new owner style object for the copied object. + The identifier for this object. + A copy of the current object and registered with the new owner style object. + + + + Provides a wrapper object for the object with type + safe access to all properties stored in the style object. + + Style objects provide a very user friendly way to modify data. It is very much like in Excel VBA. + For example, to change the bold setting for a cell, you simply call grid[5,2].Font.Bold = True. + + + The is a wrapper around the . + It provides type safe accessor properties to modify data of the underlying + data store and can hold temporary information about the style object that + does not need to be persisted. + + In Essential Grid for the example, the GridStyleInfo class holds extensive identity + information about a style object such as cached base styles, row and column index, + a reference to the grid model, and more. This is all the information that can be discarded + when the style is no longer used (because maybe the cell is not visible anymore). Only + the part needs to be kept alive. + + Style objects only exist temporarily and will be created as a weak reference in a + volatile data store. Once Garbage Collection kicks in smart style objects that are not + referenced any more will be garbage collected. The volatile data cache can also be + cleared manually. + + Because Style objects know their identity they can notify their owner of changes or + load base style information when the user interacts with the style object. This allows + you to make changes to a style object directly, such as Cell.Font.Bold = True; + + Style objects support property inheritance from parent styles, e.g. in a grid a cell + can inherit properties from a parent row, column, table or a collection of names styles + in a base styles map. + + Style objects support subobjects. Subobjects can support inheritance (e.g. a Font.Bold + can be inherited). Immutable subobjects like BrushInfo don't support inheritance of + individual properties. + + allows you to register any number of properties but keeps the data + very memory efficient. Only properties that are actually used for a style + object will be allocated for an object. The StyleObjectStore handles the storage of the object. + For short integers, enums and Boolean values, the data will be stored in a BitVector32 + structure to save even more memory. + + Programmers can derive their own style classes from + and add type-safe (and intellisense) + supported custom properties to the style class. If you write, for example, your own + SpinButton class that needs individual properties, simply add a �CellSpinButtonInfo� + class as subobject. If you derive CellSpinButtonInfo from StyleInfoSubObjectBase, + your new object will support property inheritance from base styles. + + Style objects can be written into a string (see ) and later be recreated + using the method. When writing the string you have the option to show + default values (use the �d� format). Subobjects will be identified with a dot + �.�, e.g. �Font.Bold� + + Style object support several operations how to combine information from two styles. Style operations + include: apply changes, apply initialized properties, override initialized properties, exclude properties. + See the method. + + Style objects integrate with . The property grid + displays values that belong to a style object in bold. Values that are inherited from parent + styles will be displayed as default values. The user can select several cells in a grid and + the operation will show common settings in the property grid as bold. + + Style objects support BeginUpdate, EndUpdate mechanism. This allows users to batch several operations + on a style object into one transaction. + + + The following example shows how you can use the GridFontInfo class in Essential Grid: + + standard.Font.Facename = "Helvetica"; + model[1, 3].Font.Bold = true; + string faceName = model[1, 3].Font.Facename; // any cell inherits standard style + Console.WriteLIne(faceName); // will output "Helvetica" + Console.WriteLIne(model[1, 3].Font.Bold); // will output "true" + Console.WriteLIne(model[1, 3].Font.HasFaceName); // will output "False" + + + + + + + + Serializes the contents of this object into an XML stream. + + Represents the XML stream. + + + + Not implemented and returns NULL. + + + + + + Deserializes the contents of this object from an XML stream. + + Represents the XML stream. + + + + + + + Gets / sets the identity information for the current . + + + + + + + + + + + The object that holds all the data for this style object. + + + + + Sets the object that holds all the data for this style object. + + + + + + + + + Gets or sets a value indicating whether this instance should cache values for resolved base style properties. + + true if instance should cache values; otherwise, false. + + + + Clears the cache. + + + + + Occurs when a property in the style object or in a sub object is changed. + + + + + A list of listeners that will be referenced using a WeakReference. The + listeners must implement the interface. When + this style object method is called it + will then loop through all objects in this list and call each objects + method. + + + + + Occurs before a property in the style object or in a sub object is changed. + + + + + Overloaded. Initializes a new style object with no identity and data initialized. + + + + + Initalizes a new object and associates it with an existing . + + A that holds data for this object. + All changes in this style object will be saved in the object. + + + + + Initalizes a new object and associates it with an existing and . + + A that holds the identity for this . + A that holds data for this object. + All changes in this style object will be saved in the object. + + + + + Initalizes a new object and associates it with an existing and . + + A that holds the identity for this . + A that holds data for this object. + All changes in this style object will be saved in the object. + if set to true the style the resulting value of a property when inherited from a basestyle + so that the property does not have to be evaluated multiple times when called repeatedly. + + + + Releases all resources used by the component. + + + + + Releases all resources used by the component. + + + + + Indicates whether two style objects are equal. Identity is left out with this comparison, + only the data () are compared. + + The other style object to compare the current object with. + True if both objects have equal data; false otherwise. + + + + Compares two objects for equality. Works also with NULL references. + + The first object to compare. + The second object to compare. + True if both objects are equal. + + + + Returns a hash code which is based on values inside the . + + An integer hash code. + + + + Overloaded. Creates a formatted string for this style object. This string can + later be consumed by . + + A string with formatted style information. + + Style objects can be formatted into a string that can be consumed + by to recreate style information. + + When writing the string, you have the option to show default values + (use the �d� format). + Subobjects will be identified with a period ".", e.g. "Font.Bold". + + + + + Creates a formatted string for this style object. This string can + later be consumed by . You can specify + "d" as format if you want to write out default values inherited from a base style. + + Use "d" if default values should be included; "G" and NULL are default. + A string with formatted style information. + + Style objects can be formatted into a string that can be consumed + by to recreate style information. + + When writing the string you have the option to show default values + (use the "d" format) or not. + Subobjects will be identified with a period ".", e.g. "Font.Bold". + + + + + Creates a formatted string for this style object. This string can + later be consumed by . You can specify + "d" as format if you want to write out default values inherited from a base style. + + Use "d" if default values should be included; "G" and NULL are default. + A string with formatted style information. + An to be used + for the operation. Can be NULL. + + Style objects can be formatted into a string that can be consumed + by to recreate style information. + + When writing the string you have the option to show default values + (use the "d" format) or not. + Subobjects will be identified with a period ".", e.g. "Font.Bold". + + + + + Parses a given string and applies it's results to affected properties in this style object. + + The string to be parsed. + + consumes strings previously generated with + a method call. + + + + + Suspends raising events until is called + and will not change the state of this object. + + + + + Resumes raising events and resets the state of this object. + + + + + Suspends raising events until is called. + + + + + Suspends raising events and if changes were + made before the call, it will raise a changed + notification immediately. + + + + + Indicates whether was called for this object. + + + + + Override this method to return a default style object for your derived class. + + A default style object. + + You should cache the default style object in a static field. + + + + + Override this method to create a product-specific identity object for a sub object. + + An identity object for a subobject of this style. + + The following code is an example how Essential Grid creates GridStyleInfoSubObjectIdentity: + + public override StyleInfoSubObjectIdentity CreateSubObjectIdentity(StyleInfoProperty sip) + { + return new GridStyleInfoSubObjectIdentity(this, sip); + } + + + + + + Locates the in the list of base styles that + provides a specific property. + + Identifies the property to look for. + The style store object that has the specified property. + + + + Locates the base style that has the specified property and returns its instance. + + Identifies the property to look for. + The style object that has the specified property. + + + + + + + Notifies the associated identity object that a specific property + was changed and raises a event. + + Identifies the property to look for. + + + + Notifies the associated identity object that a specific property + will be changed and raises a event. + + Identifies the property to look for. + + + + Indicates whether the style is empty. + + + + + Indicates whether any properties for this object have changed since it was applied last time. + + + + + Compares all properties with another style object and indicates + whether the current set of initialized properties is a subset of + the other style object. + + The other style to compare with. + True if this style object is a subset of the other style object. + + + + Copies properties from another style object. This method raises Changing and Changed + notifications if the other object differs. (ModifyStyle does not raise these events). + + The style object to be applied on the current object. + + + + Applies changes to a style object as specified with . + + The style object to be applied on the current object. + The actual operation to be performed. + + + + Applies changes to a style object as specified with . + + The style object to be applied on the current object. + + + + Merges two styles. Resets all properties that differ among the two style objects + and keeps only those properties that are equal. + + The other style object this style object should merge with. + + + + Indicates whether the specified property has been initialized for the current object. + + A that identifies the property to operate on. + + + + Indicates whether the specified property has been modified for the current object. + + A that identifies the property to operate on. + + + + Marks the specified property as uninitialized for the current object. + + A that identifies the property to operate on. + + + + + + + Queries the value for the specified property that has been initialized for the current object + or locates it in a base style. + + A that identifies the property to operate on. + + + + Gets the default value from a base style. + + The sip. + + + + + Queries the value for the specified property that has been initialized for the current object + or locates it in a base style. + + A that identifies the property to operate on. + + + + Overloaded. Initializes the value for the specified property. + + A that identifies the property to operate on. + The value to be saved for the property. + + + + Initializes the value for the specified property. + + A that identifies the property to operate on. + The value to be saved for the property. + + + + Specifies whether a property should be serialized. + + + + + + Specifies that a property should be serialized. + This field is Read-only. + + + + + Specifies that a property should not be serialized. + This field is Read-only. + + + + + The default setting for this attribute. + + + + + Initializes a new instance of the class. + + + if a property should be serialized; otherwise. The default is . + + + + + + + + + + + + + Indicates whether a property is shown in the ToString result. + + + + + Indicates whether the has been set for the property. + + A + True if property has a ; False otherwise. + + + + Specifies whether a property should be cloned. + + + + + + Specifies that a property should be cloned if the assigned object implements ICloneable. + This field is Read-only. + + + + + Specifies that a property should never be cloned even if the assigned object implements ICloneable + This field is Read-only. + + + + + The default setting for this attribute. + + + + + Initializes a new instance of the class. + + + if a property should be should be cloned if the assigned object implements ICloneable; otherwise. The default is + + + + + + + + + + + + + Indicates whether a property should be cloned if the assigned object implements ICloneable. + + + + + Indicates whether the has been set for the property. + + A + True if property has a ; false otherwise. + + + + Specifies whether a property should be disposed. + + + + + + Specifies that a property should be disposed if the assigned object implements IDisposeable. + This field is Read-only. + + + + + Specifies that a property should never be disposed even if the assigned object implements IDisposeable + This field is Read-only. + + + + + The default setting for this attribute. + + + + + Initializes a new instance of the class. + + + if a property should be should be disposed if the assigned object implements IDisposeable; otherwise. The default is + + + + + + + + + + + + + Indicates whether a property should be disposed if the assigned object implements IDisposeable. + + + + + Indicates whether the has been set for the property. + + A . + True if property has a ; false otherwise. + + + + Indicates whether the has been set for the property. + + A . + True if property has a ; false otherwise. + + + + Implement this interface if you want to assign this class to a object's + property and you need to control whether the object should be cloned. + + + This interface is only considered if the of + of the is True. + (This is the default.) + + + + + + + Clones this object. + + A reference to a clone of this object. + + + + Disposes this object. + + + + + Returns True if this object should be cloned if you assign it to a object's + property; false otherwise. + + True if this object should be cloned if you assign it to a object's + property; false otherwise. + + + + Returns True if this object should be disposed if it is reset in a object's + property; false otherwise. + + True if this object should be disposed if it is reset in a object's + property; false otherwise. + + + + Implements the method which is called from + of a + if the object is in + collection. + + + + + Called from of a + object. + + The instance containing the event data. + + + + Provides a type converter to convert expandable objects to and from various + other representations. + + + + + Indicates whether this object supports properties using the + specified context. + + + + + Indicates whether this converter can + convert an object to the given destination type using the specified context. + + + + + Converts the given value object to + the specified destination type using the specified context and arguments. + + + + + Returns a collection of properties for + the type of array specified by the value parameter using the specified context and + attributes. + + + + + A form that displays a with Apply and OK buttons. + + + + + Initializes a new with an object whose properties should be displayed. + + The object for which properties should be displayed. + + + + Returns the apply button. You should set up a listener for a Click event. + + + + + Cleans up any resources being used. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + This is an abstract base class that provides identity information + for objects. + + + + + Gets / sets another identity object to be used for determining base styles. + GetBaseStyle will call InnerIdentity.GetBaseStyle if this object is not NULL. + + + + + Loops through all base styles until it finds a style that has a specific property initialized. + + + A that identifies the property to operate on. + A that has the property initialized. + + + + Gets or sets a value indicating whether this object is disposable. + + + true if this object is disposable; otherwise, false. + + + + + Releases all resources used by the component. + + + + + Loops through all base styles until it finds an expandable + that has one or more properties initialized. + + The style object. + A that identifies the property to operate on. + A that has the property initialized. + + + + Returns an array with base styles for the specified style object. + + The style object. + An array of style objects that are base styles for the current style object. + + + + Occurs when a property in the has changed. + + The instance that has changed. + A that identifies the property to operate on. + + + + Occurs before a property in the is changing. + + The instance that is changed. + A that identifies the property to operate on. + + + + + + + Clears the style objects from the storage. + + + + + Provides a unique identifier for a property in a style object and stores + information about the associated property. + + + is allocated once on the global heap for each + property in a style object. Type safe wrappers make + use of StyleInfoProperty to query, set or reset specific properties. + + Holds information about the property: PropertyType, Name, how to load and save + its state in StyleInfoStore, attributes, etc. + + + + + The type of the component this property is bound to. + + + + + The type of the property. + + + + + The name of the property. + + + + + Represents a method that creates a Subobject of this type and associates it with a parent style object. + + + + + Indicates whether this is an object derived from . + + + + + Indicates whether this object supports being serialized. The value can be set + with a in your class implementation. + + + + + Indicates whether this object should call ICloneable.Clone when an assigned object implements + the ICloneable or interface. The value can be set + with a in your class implementation. + + + + + Indicates whether this object should call ICloneable.Clone when an assigned object implements + the IDisposable or interface. The value can be set + also with a in your class implementation. + + + + + If property is marked with Browsable(true), custom attribute of this flag allows you + to specify whether the property should appear in PropertyGrid. If property is marked + with Browsable(false), then this setting will have no effect. Default is true. + + + + + Indicates whether type information should be included when is called. Use + this if PropertyType is System.Obbject and you want to be able to parse written values. + An example is GridStyleInfo.CellValue. Default is false. + + + + + Indicates whether type information should be converted to Base64 if associated + Type converter supports converting value to and from Base64. An example is a bitmap assigned to GridStyleInfo.CellValue. + If IsConvertibleToBase64String is true, then the grid will convert the bitmap to a Base64 string + and write out the information in the GridStyleInfo.ToString() method and also in the WriteXml method. Default is false. + + + + + Defines how to serialize property when style data is serialized to or from an XML stream + with . + + + + + Returns the of this property. + + Property info of this property. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Handles parse requests for this property. + + + + + Handles formatting requests for this property. + + + + + Method to dispose StyleInfoProperty object + + + + + Initializes a new StyleInfoProperty. + + + + + + + + Formats a given value that is of the same type as the . + + The value to be formatted. + A string with formatted text. + calls this method. + + The event lets you customize the formatting of this property but care + should be taken that the formatted text can be consumed by the + method. + + + + + Overloaded. Parses a given value that is of the same type as the . + + The string to be parsed. + An object of the same type as the created from the parsed string information. + + calls this method. + + The event lets you customize the parsing of this property. + + + + + Parses a given value and converts it to a requested . + + The string to be parsed. + The for the resulting object. + A format provider. + An object of type "resultType" created from the parsed string information. + + The event lets you customize the parsing of this property. + + + + + Handles requests to serialize this property to an XML stream during an + operation of the + class. + + + This event allows you to implement a different serialization mechanism if many style objects + reference and share the same object, (e.g. if you assign a DataSet to + several objects DataSource property). With such a scenario, you could write out an + identifier and when the property is deserialized from an XML stream, you could + reconstruct a reference to a datasource object based on the identifier. + + + + + Handles requests to deserialize this property from an XML stream during an + operation of the + class. + + + This event allows you to implement a different serialization mechanism if many style objects + reference and share the same object, (e.g. if you assign a DataSet to + several objects DataSource property). With such a scenario, you could write out an + identifier and when the property is deserialized from an XML stream you could + reconstruct a reference to a datasource object based on the identifier. + + + + + Defines how to serialize property when style data is serialized to or from an XML stream. + with . + + + + + Default. Serialize as string when type is simple. Using XmlSerializer for complex types + or properties where the actual type is not known at compile-time (e.g. CellValue). + + + + + Skip this property. Do not serialize. + + + + + Serialize this property as string using and + . + + + + + Serialize this property using . + + + + + Provides data for the and events. + + + The is used to format and unformat values represented by + a property in a object. The Format event occurs whenever a property + is written out as string and the Parse event occurs whenever the value is read back in from a string. + + If you handle this event, store the resulting value into and + set to True. + + + + + Initializes a new instance of the class. + + An Object that contains the value of the current property. + The Type of the value. + + + + Gets / sets the value of the object. + + + + + Returns the data type of the desired value. + + + The DesiredType property enables you to check the type of the property that the value is being converted to. + + + + + Handles the or event. + + + + + Handles the event of . + + + + + Provides data for the event. + + + The is used to serialize a property of a + object. The WriteXml event occurs whenever a property + is serialized to an XML stream during an operation + of the class. + + If you handle this event, you set to True. + Handling this event allows you to customize the way the object is serialized or skip + serialization. + + This event allows you to implement a different serialization mechanism if many style objects + reference and share the same object, (e.g. if you assign a DataSet to + several objects' DataSource property). With such a scenario, you could write out a + identifier and when the property is deserialized from an XML stream, you could + reconstruct a reference to a datasource object based on the identifier. + + + + + Initializes a new object. + + The for the XML stream. + The style object that is being serialized. + The property that is being serialized. + + + + Returns the for the XML stream. + + + + + Returns the style object that is being serialized. + + + + + Returns the property that is being serialized. Call of + the to get the value for this property. + + + + + Handles the event of . + + + + + Provides data for the event. + + + The is used to deserialize a property of a + object. The ReadXml event occurs whenever a property + is deserialized from an XML stream during an + operation of the class. + + If you handle this event, you set to True. + Call of + the to save the value for this property into the style object. + Handling this event allows you to customize the way the object is deserialized or skip + serialization. + + This event allows you to implement a different serialization mechanism if many style objects + reference and share the same object, (e.g. if you assign a DataSet to + several objects DataSource property). With such a scenario, you could write out an + identifier and when the property is deserialized from an XML stream you could + reconstruct a reference to a datasource object based on the identifier. + + + + + Initializes a new object. + + The for the XML stream. + The style object that is deserialized. + The property that is being deserialized. + + + + Returns the for the XML stream. + + + + + Returns the style object that is deserialized. + + + + + Returns the property that is being deserialized. Call of + the to save the value for this property into the style object. + + + + + + Indicates whether the component will allow its value to be reset. + + The component to reset. + + True if the component supports resetting of its value. + + + + + + + Retrieves the value of the property for the given component. This will + throw an exception if the component does not have this property. + + The component. + + The value of the property. This can be cast + to the property type. + + + + + + + Resets the value of this property on the specified component to the default value. + + The component whose property is to be reset. + + + + + + Sets the value of this property on the specified component. + + The component whose property is to be set. + The new value of the property. + + + + + + Indicates whether this property should be persisted. A property is + to be persisted if it is marked as persistable through a + PersistableAttribute and if the property contains something other + than the default value. Note, however, that this method will + return True for design-time properties as well, so callers + should also check to see if a property is design-time only before + persisting to run-time storage. + + The component on which the property resides. + + True if the property should be persisted to either + design-time or run-time storage. + + + + + + Retrieves the type of the component this PropertyDescriptor is bound to. + + + The type of component. + + + + + + Retrieves the display name of the property. This is the name that will + be displayed in a property browser. This will be the same as the property + name for most properties. + + + A string containing the name to display in the property browser. + + + + + + + Indicates whether the property can be written to. + + + True if the property can be written to. + + + + + + + Retrieves the data type of the property. + + + A class representing the data type of the property. + + + + + + provides conversion routines for values + to convert them to another type and routines for formatting values. + + + + + Converts value from one type to another using an optional . + + + Converts value from one type to another using an optional . + + The original value. + The target type. + A used to format or parse the value. + The new value in the target type. + + + + Converts value from one type to another using an optional . + + The original value. + The target type. + A used to format or parse the value. + Indicates whether exceptions should be avoided or catched and return value should be DBNull if + it cannot be converted to the target type. + The new value in the target type. + + + + Converts value from one type to another using an optional . + + The original value. + The target type. + A used to format or parse the value. + Format string. + Indicates whether exceptions should be avoided or catched and return value should be DBNull if + it cannot be converted to the target type. + The new value in the target type. + + + + Overloaded. Parses the given text using the resultTypes "Parse" method or using a type converter. + + The text to parse. + The requested result type. + A used to format or parse the value. Can be NULL. + The new value in the target type. + + + + Parses the given text using the resultTypes "Parse" method or using a type converter. + + The text to parse. + The requested result type. + A used to format or parse the value. Can be NULL. + A format string used in a call. Right now + format is only interpreted to enable roundtripping for formatted dates. + + The new value in the target type. + + + + Parse the given text using the resultTypes "Parse" method or using a type converter. + + The text to parse. + The requested result type. + A used to format or parse the value. Can be NULL. + A format string used in a call. Right now + format is only interpreted to enable roundtripping for formatted dates. + + Indicates whether DbNull should be returned if value cannot be parsed. Otherwise an exception is thrown. + The new value in the target type. + + + + Parse the given text using the resultTypes "Parse" method or using a type converter. + + The text to parse. + The requested result type. + A used to format or parse the value. Can be NULL. + A string array holding permissible formats used in a call. Right now + formats is only interpreted to enable roundtripping for formatted dates. + + Indicates whether DbNull should be returned if value cannot be parsed. Otherwise an exception is thrown. + The new value in the target type. + + + + Generates display text using the specified format, culture info and number format. + + The value to format. + The value type on which formatting is based. The original value will first be converted to this type. + The format like in ToString(string format). + The for formatting the value. + The for formatting the value. + The string with the formatted text for the value. + + + + Indicates whether should trim whitespace characters from + the end of the formatted text. + + + + + Returns a representative value for any given type. Is useful to preview the + result of a format in . See + + The . + A value with the specified type. + + + + Overloaded. Parses the given string including type information. String can be in format %lt;type> 'value' + + + + + + + + Parses the given string including type information. String can be in format %lt;type> 'value' + + + + Indicates whether TypeConverter should be checked whether the type to be + parsed supports conversion to/from byte array (e.g. an Image) + + + + + Indicates whether the TypeConverter associated with the type supports conversion to/from a byte array (e.g. an Image). + If that is the case the string is converted to a byte array from a base64 string. + + + + + + + + + Overloaded. Formats the given value as string including type information. String will be in format %lt;type> 'value' + + + + + + + Formats the given value as string including type information. String will be in format %lt;type> 'value' + + + Indicates whether TypeConverter should be checked whether the type to be + parsed supports conversion to/from byte array (e.g. an Image) + + + + + Indicates whether the TypeConverter associated with the type supports conversion to/from a byte array (e.g. an Image). + If that is the case the string is converted to a base64 string from a byte array. + + + + + + + Returns the type name. If type is not in mscorlib, the assembly name is appended. + + + + + + + Returns the type from the specified name. If an assembly name is appended the list of currently loaded + assemblies in the current AppDomain are checked. + + + + + + + Indicates whether string is null or empty. + + + + + + + StyleInfoPropertyGrid is a that will reset a specific property when the user right-clicks on the item. + + + + + + + + Holds all StyleInfoProperties used by derived classes. + This should go in a product specific StaticData. + The concrete Style class could provide a static memory StaticData that belongs + to the process and library. + + + + + Method to dispose static data object internally for disposing Chart styles. + + + + + Gets type of StyleInfo which is parent of store with current staticdata + + + + + Returns a collection with objects. + + + + + Initializes a new object with information about the parent style class. + + + Will be used to access the PropertyInfo and its custom attributes for a property. + + + + + + + + + + + + + + Indicates whether properties have been registered. Returns True if not registered; False otherwise. + + + + + Registers a for the specified property. + + + Registers a for the specified property. + + The type of the property. + The name of the property. + The StyleInfoProperty with information about the property. + + + + Registers a for the specified property. + + The type of the property. + The name of the property. + Specifies options for the property. + The StyleInfoProperty with information about the property. + + + + Registers a for the specified property. + + The type of the property. + The name of the property. + The maximal possible Int16 value for the property. + The StyleInfoProperty with information about the property. + + + + Registers a for the specified property. + + The type of the property. + The name of the property. + The maximal possible Int16 value for the property. + Indicates whether this StyleInfoProperty should be registered as a member of the BitArray and not to allocate + an object reference. + The StyleInfoProperty with information about the property. + + + + Registers a for the specified property. + + The type of the property. + The name of the property. + The maximal possible Int16 value for the property. + Indicates whether this StyleInfoProperty should be registered as a member of the BitArray and not to allocate + an object reference. + Specifies options for the property. + The StyleInfoProperty with information about the property. + + + + Registers a for the specified property. + + The type of the property. + The name of the property. + The maximal possible Int16 value for the property. + Indicates whether this StyleInfoProperty should be registered as a member of the BitArray and not to allocate + an object reference. + Specifies options for the property. + The component type that hosts the property. + The StyleInfoProperty with information about the property. + + + + Provides storage for the object. + + + You cannot instantiate a class directly. You have + to derive a concrete class from this class that you can instantiate. + In derived classes of , you always need to + implement a / + pair. The holds all the data that are specific + to the style object and should be persisted. + The is a wrapper around the . + It provides type safe accessor properties to modify data of the underlying + data store and can hold temporary information about the style object that + does not need to be persisted. + + In Essential Grid for example, the GridStyleInfo class holds extensive identity + information about a style object such as cached base styles, row and column index, + a reference to the grid model and more. These are all the information that can be discarded + when the style is no longer used (because maybe the cell is not visible anymore). Only + the part needs to be kept alive. + + allows you to register any number of properties but keeps the data + very memory efficient. Only properties that are actually used for a style + object will be allocated for an object. The StyleObjectStore handles the storage of objects. + For short integers, enums and Boolean values the data will be stored in a BitVector32 + structure to save even more memory. + + See the overview for for further discussion about style objects. + + + + + + + Searches the with the given name. + + The name of the property to look for. + A that is associated with the specified name. + + + + Returns a collection with objects. + + + + + Static data must be declared static in derived classes (this avoids collisions + when StyleInfoStore is used in the same project for different types of style + classes). + + + + + Initializes a new from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + Initializes an empty . + + + + + Creates an exact copy of the current object. + + A with same data as the current object. + + + + The class checks this property + to find out about the sort order of the properties in this . + + + + + Copies all properties to another . + + The target to copy all properties to. + + + + Releases all the resources used by the component. + + + + + + + + + + + + + + Resets all "Changed" bits that mark certain properties as modified. + + + + + Clears out all properties for this . + + + + + Indicates whether a specific property has been initialized for the current object. + + A that identifies the property to operate on. + + + + Indicates whether a specific property has been modified for the current object. + + A that identifies the property to operate on. + + + + Marks a specific property as modified or unmodified for the current object. + + A that identifies the property to operate on. + The new value. + + + + Marks a specific property as uninitialized for the current object. + + A that identifies the property to operate on. + + + + Queries the value for a specific property that has been initialized for the current object. + + A that identifies the property to operate on. + + + + Queries the value for a specific property that has been initialized for the current object. + + A that identifies the property to operate on. + + + + Overloaded. Initializes the value for a specific property. + + A that identifies the property to operate on. + The value to be saved for the property. + + + + Initializes the value for a specific property. + + A that identifies the property to operate on. + The value to be saved for the property. + + + + Gets sip from current storage by sip from another store + + + + + + + Checks SIP belonging to current store. If current store doesn't contain SIP than returns SIP from current store with identical PropertyName. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Indicates whether this is an empty object and no properties have been initialized. + + + + + Indicates whether any properties have been changed. + + + + + Compares all properties with another style object and determines + if the current set of initialized properties is a subset of + the other style object. + + The other style to compare with. + True if this style object is a subset of the other style object. + + + + Applies changes to a style object as specified with . + + The style object to be applied on the current object. + The actual operation to be performed. + + + + Applies changes to a style object as specified with . If a property is modified + its Changed flag is set so that the parent style object can identify modified properties in a subsequent Changed notification. + + The style object to be applied on the current object. + The actual operation to be performed. + + + + Merges two styles. Resets all properties that differ among the two style objects + and keeps only those properties that are equal. + + The other style object this style object should merge with. + + + + Applies changes to a style object as specified with + + The other style object this style object should inherit with. + Style operation + + + + Modifieds property from different stores + + + + + + + + Assigns property with sipInfo from style + + + + + + + if sipSrc is different store with current store than find StyleInfoProperty in current store with identical PropertyName and reset property + + sip from some store + + + + Modifies expanded property + + sip from another storage + style source + operation + + + + Allows customization of serializing the StyleInfoProperty. Returns True if you override + this method and do not want default serialization behavior for this property. + + + + + Allows customization of serializing the StyleInfoProperty. Returns True if you override + this method and do not want default serialization behavior for this property. + + + + + Serializes all properties of this object to XML. + + + + + Registers the XmlSerializer for a specific type. This XmlSerializer will + be used when a object of the specified type is read back in from an xml stream. + You can for example register an "ImageHolder" serializer for a custom ImageHolder type + and have that serializer be used when GridStyleInfo.CellValue contains an ImageHolder object. + + + + + + XmlSerializer imageHolderSerializer = new XmlSerializer(typeof(object), new Type[] { typeof(ImageHolder) }); + GridStyleInfoStore.RegisterXmlSerializer(typeof(ImageHolder), imageHolderSerializer); + + + + + + Serializes all properties of this object from XML. + + + + + + + + Specifies the options for style properties. + + + + + None. + + + + + The property supports serialization. + + + + + The property should be cloned when the parent style object is copied. + + + + + The property should be disposed when the parent style object is disposed. + + + + + The property should be disposed when the parent style object is disposed + and cloned when the parent style object is copied. + + + + + All of the above. + + + + + is an abstract base class for classes + to be used as subobjects in a . + + + is derived from + and thus provides the same easy way to provide properties that can inherit values + from base styles at run-time. + The difference is that supports this inheritance + mechanism as a subobject from a . A subobject needs to + have knowledge about its parent object and be able to walk the base styles from the + parent object. + Examples for implementation of are the font and border + classes in Essential Grid. + Programmers can derive their own style classes from + and add type-safe (and Intelli-sense) + supported custom properties to the style class. If you write your own + SpinButton class that needs individual properties, simply add a "CellSpinButtonInfo" + class as subobject. If you derive CellSpinButtonInfo from StyleInfoSubObjectBase, + your new object will support property inheritance from base styles. + + See the overview for for further discussion about style objects. + + The following example shows how you can use the GridFontInfo class in Essential Grid: + + standard.Font.Facename = "Helvetica"; + model[1, 3].Font.Bold = true; + string faceName = model[1, 3].Font.Facename; // any cell inherits standard style + Console.WriteLIne(faceName); // will output "Helvetica" + Console.WriteLIne(model[1, 3].Font.Bold); // will output "true" + Console.WriteLIne(model[1, 3].Font.HasFaceName); // will output "False" + + + + + + Overloaded. Initializes a new object and associates it with an existing . + + A that holds data for this object. + All changes in this style object will be saved in the object. + + + + + Initializes a new object and associates it with an existing . + + A that holds the identity for this . + A that holds data for this object. + All changes in this style object will be saved in the object. + + + + + Returns the with identity information about this object. + + + + + Releases all the resources used by the component. + + + + + Returns a unique identifier for this subobject in the owner style object. + + + + + Returns the data for this object. This is the StyleInfoStore from the constructor. + + + + + Returns a reference to the owner style object. + + + + + + + + Locates the base style that has the specified property and returns its instance. + + Identifies the property to look for. + The style object that has the specified property. + + + + Makes an exact copy of the current object. + + The new owner style object for the copied object. + The identifier for this object. + A copy of the current object registered with the new owner style object. + + + + Provides style identity information for subobjects. + + + + + Releases all the resources used by the component. + + + + + Returns the owner style of the subobject. + + + + + Returns the identifier of the subobject in the owner object. + + + + + Instantiates a new for a + given owner and . + + The owner style of the sub object. + The identifier of the subobject in the owner object. + + + + Returns an array with base styles for the specified style object. + + The style object. + + An array of style objects that are base styles for the current style object. + + + + + StyleModifyType defines style operations for . + + + + + Copies all initialized properties. + + + + + Copies only properties that have not been initialized in the target style object. + + + + + Copies all properties and resets properties in the target style. + + + + + Resets properties in the target style that have been marked as initialized in the source style. + + + + + Clears out all properties. + + + + + Copies and resets all properties in the target style when the property has been marked as changed in the source style. + + + + + Provides some utility methods regarding the runtime. + + + + + Returns the major runtime version. + + + + + Returns the minor runtime version. + + + + + This class will provide more information that the .Net equivalent ignored. + + + + + Indicates whether menu access keys are always underlined. + + + + + Indicates whether the current application is a .Net application. + + True if .Net; false otherwise. + + By default, this method will automatically determine whether or not the current active + app is a .Net app or a native app. However, to speed up performance (by a fraction of a second), + you can set this value appropriately at the beginning of your app. Note that + an incorrect setting would cause unforeseen behavior. + + + + + Indicates whether the component is used inside developer studio. + + + + + For the scroll bar itself, indicates the specified vertical or horizontal scroll bar does not exist. + For the page up or page down regions, indicates the thumb is positioned such that the region does not exist. + + + + + For the scroll bar itself, indicates the window is sized such that the specified vertical or horizontal scroll bar is not currently displayed. + + + + + The arrow button or page region is pressed. + + + + + The component is disabled. + + + + + Flags used by the DwmSetWindowAttribute function to specify the rounded corner preference for a window. + + + + + Options used by the DwmGetWindowAttribute and DwmSetWindowAttribute functions. + + + + + Sets the value of Desktop Window Manager (DWM) non-client rendering attributes for a window. + + The handle to the window for which the attribute value is to be set. + A flag describing which value to set, specified as a value of the DWMWINDOWATTRIBUTE enumeration. + This parameter specifies which attribute to set, and the pvAttribute parameter points to an object containing the attribute value. + A pointer to an object containing the attribute value to set. The type of the value set depends on the value of the dwAttribute parameter. + The DWMWINDOWATTRIBUTE enumeration topic indicates, in the row for each flag, what type of value you should pass a pointer to in the pvAttribute parameter. + The size, in bytes, of the attribute value being set via the pvAttribute parameter. + The type of the value set, and therefore its size in bytes, depends on the value of the dwAttribute parameter. + If the function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error + + + + Computes the string size that should be passed to a typical Win32 call. + This will be the character count under NT and the ubyte count for Win95. + + + The string whose size to compute. + + + The count of characters or bytes, depending on what the pinvoke + all wants + + + + + Interop call to get the LCID of the current culture. + + + + + Native Matrix Object. + + + + + Sets the advanced graphics mode. + + Handler to device context. + New graphics mode. + If the function succeeds, the return value is the old graphics + mode. If the function fails, the return value is zero. + + + + Changes the world transformation for a device context using + the specified mode. + + Handler to device context. + Transformation data. + Modification mode. + If the function succeeds, the return value is nonzero. + If the function fails, the return value is zero. + + + + Sets a two-dimensional linear transformation between world space and + page space for the specified device context. + + Handler to the device context. + Pointer to an XFORM structure that contains the transformation data. + TRUE if success; false otherwise. + + + + The NativeMethodsHelper class is a wrapper over some Interop calls that are exposed using static methods + in this class. + + + + + Keeps track of the number of times Suspend and Resume redraw window is called for a particular window. + + + + + Sends the WM_SETREDRAW to the handle of the Control to prevent drawing of the control. + + The handle of the control that is to be suspended. + + + + Resumes redrawing of the window. + + + + + Resumes redrawing of the window. + + + + + + + Sends the WM_SETREDRAW message to a window to allow changes in that window to be redrawn + or to prevent changes in that window from being redrawn. + + Handle to the native window. + Indicates the redraw state. + If this parameter is true, the content can be redrawn after a change. + If this parameter is false, the content cannot be redrawn after a change. + Forces redraw of the window using . + Works only if bRedraw is true. + + + + Overload of + Forcefully redraws window if redraw is enabled. + + + + + Defines constants for specifying the persistence medium to be used for serialization. + + + The SerializeMode enumeration defines constants for specifying the persistence medium. + This enum is used by the class as well as by several other + Syncfusion components. + + + + + The IsolatedStorage is used for reading / writing the state information. + + + + + A Binary file is used for reading / writing the state information. + + + + + A .XML file is used for reading / writing the state information. + + + + + The Win32 WindowsRegistry is used for reading / writing the state information. + + + + + An externally provided Stream is used for reading / writing the state information in an XML format. + + + + + An externally provided Stream is used for reading / writing the state information in a binary format. + + + + + Provides a mechanism for coordinating the serialization behavior of multiple components. + + + The AppStateSerializer class is a serialization utility that allows multiple components + in an application to access a common disk I/O medium for state persistence. Using + the same storage medium for persisting the state information across components, without overtly + tying them together, helps avoid the file clutter that is bound to occur by components + using distinct files. Though primarily developed for use by Syncfusion products, the + AppStateSerializer is generic enough to be availed of by other components as well. + + The AppStateSerializer supports serializing into the system's Isolated Storage, Windows Registry, an XML file, + a binary file or to an externally provided Stream. Take a look at the enumeration for more information on + these different supported modes. + + + To use the services of this class, you can create a new instance or use the global Singleton instance. + These two usage patterns are explained below: + + + 1) Using the Singleton: The AppStateSerializer class provides you a singleton instance + (through the ) using which you can persist all your + app. info into a single medium. This singleton, by default, is configured to persist in the + Isolated Storage (with the scope IsolatedStorageScope.Assembly|IsolatedStorageScope.Domain|IsolatedStorageScope.User). + This usage pattern is akin to creating an instance of this class and using the same instance to persist + all your app information. But, note that this Singleton is also used by the Controls and Components in + Essential Tools to persist their information. The default Storage medium of this Singleton instance + can also be customized using the static method. In short, use + the Singleton whenever you want all your persistence information to be stored in a single medium (along + with the persistence information of the Controls and Components in Essential Tools). + + + 2) Using an instance: As an alternative you could create a custom instance + of this class, configuring it to use one of the above storage mediums and persist + one or more information into it. You can use this in tandem with the above Singleton instance + if you wish. Make sure to call method when you are done writing into the serializer. + + + In both the above cases use the + method's and + to persist or depersist from the storage medium set for that instance. + + + Note that the AppStateSerializer class uses "Simple" type names (not strongly typed) to + serialize types. This is necessary to enable usage of persisted information across different + but compatible versions of an assembly. This will however cause the deserialization + process to convert the serialized data to the type from the latest version of the assembly installed in the GAC, + instead of the version that your app is linking to. You can overcome this by + using the method. + + + + + Serializing using an instance: + + // To Save + AppStateSerializer serializer = new AppStateSerializer(SerializeMode.XMLFile, "myfile"); + serializer.SerializeObject("MyLabel", mydata); + serializer.PersistNow(); + // To Load + AppStateSerializer serializer = new AppStateSerializer(SerializeMode.XMLFile, "myfile"); + object loadedObj = serializer.DeserializeObject("MyLabel"); + if(loadedObj != null && loadedObj is MyData) + { + MyData myData = (MyData)loadedObj; + } + + + + Serializing using Singleton: + + // To Save + AppStateSerializer.GetSingleton().SerializeObject("MyLabel", mydata, true); + // To Load + object loadedObj = AppStateSerializer.GetSingleton().DeserializeObject("MyLabel"); + + + + + + + Gets or sets the value to serialize or deserialize the properties based on either current UI culture or invariant culture. + Default value is null. + + + This is applicable only for Grid Control. + + + + + Gets or sets a bool value to indicate whether the exception should throw while reading the file from stream or not. + + + true if it should throw the exception to handle it while reading the file stream; otherwise, false. + + + + + Returns the persistence mode set for the . + + A value. + + + + Returns the persistence path set for the . + + + The persistence path is contextual and is interpreted based on the property value. + + An object of type varying based on the the SerializationMode. + + + + Returns the IsolatedStorageScope used by the . + + An value. + + This property is used only if the mode is set to SerializeMode.IsolatedStorage. + + + + + Indicates whether serialization and deserialization is enabled. + + True to enable serialization; false otherwise. This property is set to True by default. + + This property allows you to temporarily enable / disable serialization. + + + + + + Returns the version of the application (got through the Application.ProductVersion property) + whose state has now been deserialized. + + The version as string if available. String.Empty otherwise. + This gives you some information about the state of the deserialized information - + as to which version of the application it belonged to. + + + + Overloaded. Creates an instance of the AppStateSerializer class. + + The in which to create. + The persistence path to be used for this mode. See remarks for more info. + + The persistpath argument should be based on the property, as follows: + + SerializeMode.XMLFileA string representing the file name (an .XML suffix will be added) in which to store. + SerializeMode.BinaryFileA string representing the file name (a .bin suffix will be added) in which to store. + SerializeMode.WindowsRegistryA under which to persist. + SerializeMode.IsolatedStorageA string representing the file name (a .bin suffix will be added) in which to store within the Isolated Storage. + SerializeMode.ExternalStreamAn instance of a derived class with Read, Write, and Seek capability. + + + If using the IsolatedStorage mode, then the default isolated storage scope (Domain | Assembly | User) will be used. + Use the three argument constructor to specify a custom scope. + + + + + + Creates an instance of the AppStateSerializer class. + + The in which to create. + The persistence path to be used for this mode. See remarks for more info. + The to be used if the mode is set to SerializeMode.IsolatedStorage. + + The persistpath argument should be based on the property, as follows: + + SerializeMode.XMLFileA string representing the file name (an .XML suffix will be added) in which to store. + SerializeMode.BinaryFileA string representing the file name (a .bin suffix will be added) in which to store. + SerializeMode.WindowsRegistryA under which to persist. + SerializeMode.IsolatedStorageA string representing the file name (a .bin suffix will be added) in which to store within the Isolated Storage. + SerializeMode.ExternalStreamAn instance of a derived class with Read, Write, and Seek capability. + + + The scope parameter will be referred to if using the IsolatedStorage mode. + + + + + + Returns a reference to the unique instance. + + The AppStateSerializer instance. + + This method will be removed in a future version. Please use the GetSingleton method instead. + + + + + Returns a reference to the unique instance. + + The AppStateSerializer instance. + + + + Controls the binding of an assembly name to a specific . + + The assembly name string. + The corresponding Assembly to bind to. + + + The AppStateSerializer class, by default, uses "Simple" assembly names (not strongly typed) to serialize types. This + renders the deserialization process unpredictable because the resultant type of an object after + deserialization is dependent upon the latest version of that assembly installed in the GAC, if any. + This will usually result in casting errors during the deserialization process when the app is linking to an older version of the + assembly and when a newer version of the assembly is installed in the GAC. + + + This method allows you to overcome this limitation by associating a "Simple" assembly name with a + specific . + + + + + This example will bind the + assembly that the app is linking to, to the "Simple" assembly name. Do this from the static + constructor of the class that uses the AppStateSerializer + class: + + static MyType() + { + AppStateSerializer.SetBindingInfo("MyNameSpace.MyType", typeof(MyType).Assembly); + } + + + + + + + Binds a type in the specified assembly to the same type in a different assembly. Typically useful + in supporting backward compatibility. + + The assembly name string. + The type name string. + The corresponding Assembly to bind to. + + + This method is useful when you renamed your assembly and you want to map the old types to the + new types in the new assembly. If you didn't rename the assembly, then just consider using the + method. + + + + + + Binds the oldtypename type to the newtypename type. This method comes in handy when serialized types have + undergone a name change and backward compatibility is to be retained. + + The old name of the type. + The new name of the type. + + + + Sets the persistence mode and persistence path for the singleton instance of . + + The singleton's parameters can only be changed before it gets created. + It gets created in the first call to the method. + You can force the serializer to clear its serialization map by using the + method. + + This method will be removed in a future version. Please use the InitializeSingleton method instead. + + + A value. + An object that represents the persistence medium. + The IsolatedStorageScope to be used. + + + + Overloaded. Sets the persistence mode and persistence path for the singleton instance of . + + The singleton's parameters can only be changed before it gets created. + It gets created in the first call to method. + You can force the serializer to clear its serialization map by using the + method. + + A value. + An object that represents the persistence medium. + The IsolatedStorageScope to be used. Referred only when the mode is IsolatedStorage. + + + + Sets the persistence mode and persistence path for the singleton instance of . + + + The singleton's parameters can only be changed before it gets created. + It gets created in the first call to the method. + You can force the serializer to clear its serialization map by using the + method. + + If the mode is set to Isolated Storage, then the default isolated storage scope will be used. + + The persistpath argument should be based on the property, as follows: + + SerializeMode.XMLFileA string representing the file name (an .XML suffix will be added) in which to store. + SerializeMode.BinaryFileA string representing the file name (a .bin suffix will be added) in which to store. + SerializeMode.WindowsRegistryA under which to persist. + SerializeMode.IsolatedStorageA string representing the file name (a .bin suffix will be added) in which to store within the Isolated Storage. + SerializeMode.ExternalStreamAn instance of a derived class with Read, Write and Seek capability. + + + + + + public Form1() + { + // To make the singleton use an XML file: + AppStateSerializer.InitializeSingleton(SerializeMode.XMLFile, "GlobalState"); + + InitializeComponent(); + } + + + A value. + An object that represents the persistence medium. + + + + Clears the serialization map and deletes the persistent store. + + If the persistent store is an external stream, then FlushSerializer just clears the + serialization map and returns without affecting the stream. + + + + + + Overloaded. Writes the object to persistent storage under the specified tag. + + A descriptor tag for the object. + The object to be persisted. If NULL, an existing object is removed from the serialization map. + + If the is False, then this method will not serialize. + + + + + Writes the object to persistent storage under the specified tag. + + A descriptor tag for the object. + The object to be persisted. Use NULL to remove an existing object from the serialization map. + When this parameter is True, the object is serialized only at + the point when it is being written to the persistent storage medium. This usually + happens only when the serializer is being finalized. + + If the is False, then this method will not serialize. + + + + + Deserializes the object from the persistent store. + + The object descriptor. + The deserialized object. + + If the is False, then this method will not deserialize. + + + + + Overloaded. Serializes the object to the specified persistence medium. + + A value describing the persistence medium. + Represents the persistence medium. + A string descriptor for the object. + The object to be serialized. Use NULL to delete the object's store. + + If is False, then this method will not serialize. + + This method has been replaced and will be removed form a future version. + Instead, create a new instance of the AppStateSerializer class (with the mode and persist path) + and then use the and + methods to persist information. Make sure to call when done persisting. + + + + + + Serializes the object to Isolated Storage. + + The name of the IsolatedStorageFile. + The IsolatedStorageScope to be used. + A string descriptor for the object. + The object to be serialized. Use NULL to delete the object's store. + + If is False, then this method will not serialize. + + This method has been replaced and will be removed form a future version. + Instead, create a new instance of the AppStateSerializer class (with the mode and persist path) + and then use the and + methods to persist information. Make sure to call when done persisting. + + + + + + Overloaded. Deserializes an object from the specified persistent store. + + A value describing the persistence medium. + Represents the persistence medium. + A string descriptor for the object. + The deserialized object. + + If is False, then this method will not deserialize. + + This method has been replaced and will be removed form a future version. + Instead, create a new instance of the AppStateSerializer class (with the mode and persist path) + and then use the and . + + + + + + Deserializes an object from Isolated Storage. + + The name of the IsolatedStorageFile. + The IsolatedStorageScope to be used. + A string descriptor for the object. + The deserialized object. + + If is False, then this method will not deserialize. + + This method has been replaced and will be removed form a future version. + Instead, create a new instance of the AppStateSerializer class (with the mode and persist path) + and then use the and . + + + + + + Occurs just before the contents of the are persisted. + + + + + Writes the 's contents to the persistent storage. + + + If is False, then this method will not persist. + + + + + A structure that represents a location in the registry. + + + This is a simple structure that refers to a Registry location + through the root RegistryKey and the subkey. + + + + + Creates a new instance of the RegistryEntry class and + initializes it with the root RegistryKey and subkey. + + The root RegistryKey. + The subkey string. + + + + Gets / sets the root RegistryKey. + + A RegistryKey value. + + + + Gets /sets the subkey under the root RegistryKey. + + A string value representing the subkey. + + + + Encapsulates a type's name and exposes it to the class. + + + + + Occurs when the TypeFullName property has changed. + + + + + Gets / sets the type's full name. + + + + + Initializes a new . + + + Creates a new TypeName class with empty type name. + + + + + Creates a new TypeName class and sets its type name. + + The full name of the type. + + + + Lets you specify a list of s and invoke a member in those types. + + + + This class is used in Essential Tools to load certain types in memory. + + + Once you add the types to load into this list, you can call the + method to specify a member in those types to invoke and then also call + later to repeat the invoke. + + + + + + Gets / sets the indexer for this list. + + Specifies the object at this index. + + + + + + + + + + Returns the number of arguments to be used in the method call when invoked. + + + This will be zero if invoking a property. Call + to reset this property. + + + + + Returns the argument at the specified index, that will be used during invoking. + + The argument index. + The argument at the specified index. NULL if index is out of range. + + + + Returns the static member name to invoke. + + + + + Call this method to provide information for the member invoke. + + + + + + + + + + Take a look at method for information + on these parameters. This method will also call . + + + + + Invokes the member specified using on the + specified types in this list. + + + + + Invokes the member specified using on the + specified types in this list. + + + + + Invokes the member on each type. + + The on which to invoke. + + + + Fired when a type to invoke is not found. + + + + + + Handles the event. + + The source of the event. + A that contains the event data. + + + + Provides data for the event. + + + + + Creates a new instance of the TypeNotFoundEventArgs. + + The that was not found. + + + + Returns the that was not found. + + + + + + This component lets you load custom types into the design time. + + + You can specify the static member name you want invoked through the InvokeMemberName property. This will load the types and + invoke the specified member every time you load the designer. + + + + + Initializes a new . + + + Creates a new instance of the TypeLoader class. + + + + + Creates a new instance of the TypeLoader class and adds itself to the container specified. + + The container to add to. + + + + Returns the static member name to invoke. + + + Call + to reset this property. + + + + + Handler for the event. + + The sender of this event. + Data for this event. + + If in design mode, this method shows a message box with appropriate information. + + + + + Specifies the containing the list of s + to load. + + + + + Gets or sets the assiciated with this dialog. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required designer variable. + + + + + Gets or sets the assiciated with this dialog. + + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required designer variable. + + + + + Gets or sets the assiciated with this dialog. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Gets or sets the assiciated with this dialog. + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Cannot create default instance of SpellCheckerDialog. + + + + + Handles this event to change the text while double clicking the item in LBox_Suggestions. + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Cannot create default instance of SpellCheckerDialog. + + + + + Handles this event to change the text while double clicking the item in LBox_Suggestions. + + + + + + + Required designer variable. + + + + + Clean up any resources being used. + + true if managed resources should be disposed; otherwise, false. + + + + Required method for Designer support - do not modify + the contents of this method with the code editor. + + + + + Utility class for performing soundex algorithm. + + + + + Initializing the soundex object. + + + + + Return the soundex code for a given string. + + + + + Transform the A-Z alphabetic characters to the appropriate soundex code. + . + String + Soundex code for the given word. + + + + + Compute Levenshtein distance. + + String 1 + String 2 + Distance between the two strings. + The larger the number, the bigger the difference. + + + + + Gets the next word from the alphabet list. + + + + + + Specifies the path of the dictionary. + + + + + Specifies the path of the custom dictionary. + + + + + ArrayList to hold the wrong words. + + + + + Specifies whether to ignore internet address during spell check. + + + + + Specifies to ignore email address during spell check. + + + + + Specifies to ignore html tags during spell check. + + + + + Specifies to ignore file names during spell check. + + + + + Specifies to ignore words in mixed case during spell check. + + + + + Specifies to ignore words in upper case during spell check. + + + + + Specifies to ignore words with number during spell check. + + + + + Specifies to ignore words repeated words during spell check. + + + + + Allows to customize the number of suggestions to be displayed in the suggestion list. + + + + + Specifies to ignore special symbols during spell check. + + + + + Stream that contains the dictionary. + + + + + SpellCheckerDialog. + + + + + Gets/Sets the status of the dialog window + + + + + Gets or Sets a value specifying whether to ignore repeated words during spell check. + + + + + Gets or Sets a value specifying whether to ignore words in mixed case during spell check. + + + + + Gets or Sets a value specifying whether to ignore words in upper case during spell check. + + + + + Gets or Sets a value specifying whether to ignore words with number during spell check. + + + + + Gets or Sets a value specifying the number of suggestions to be displayed in the suggestion list. + + + + + Gets or Sets a value specifying whether to ignore special symbols during spell check. + + + + + Gets or Sets a value specifying whether to ignore file names during spell check. + + + + + Gets or Sets a value specifying whether to ignore internet address during spell check. + + + + + Gets or Sets a value specifying the path of the dictionary. + + + + + Gets or Sets a value specifying the path of the custom dictionary. + + + + + Gets or Sets a value specifying whether to ignore email address during spell check. + + + + + Gets or Sets a value specifying whether to ignore html tags during spell check. + + + + + Holds the list of misspelled words. + + + + + Gets/Sets the value to indendify the type of the SpellChecker. + + + + + Holds the string of the change all. + + + + + Gets or sets the stream that contains the dictionary. + + + + + Get or Set of Skin Manager Interface + + + + + Serializing the ChangeAllText property + + + + + + Serializing the IsSpreadsheetLikeSpellChecker property + + + + + + Serializing the CloseReason property + + + + + + Determines whether VisualStyle has been modified and its contents should be serialized at design-time. + + True if VisualStyle were changed; False otherwise. + + + + Resets the VisualStyle back to its default value. + + + + + Determines whether MetroColor has been modified and its contents should be serialized at design-time. + + True if MetroColor were changed; False otherwise. + + + + Resets the MetroColor back to its default value. + + + + + Reset the ChangeAllText property + + ChangeAllText + + + + Serializing the Reset property + + IsSpreadsheetLikeSpellChecker + + + + Performs the spell check operation. + + + + + Converts the dictionary entries to array list. + + + + + Converts the dictionary entries to array list. + + + + + Gets the items from the dictionary list. + + + + + Gets the items from the dictionary list. + + + + + Gets the Soundex code. + + + + + Checks for the Upper case. + + + + + Checks for the Upper case. + + + + + Checks for the First letter captial. + + + + + Checks for the First letter captial. + + + + + Finds the casing for the given word. + + + + + + Generates the word list by deleting a single alphabet and interchanging the adjacent alphabets every time + + + + + Splits the retrieved sentence into words. + + + + + Checks whether the word is present in the dictionary. + + + + + Checks the dictinary, to identify the misspelled words. + + ArrayList + wrongWords + + + + + Checks the dictionary to generate the suggestion list. + + ArrayList + String + suggest_list + + + + + Chnages the string in the suggestion list as per the casing in the Error word + + + + + + Gets the suggestion list generated using the Soundex Alogrithm. + + ArrayList + String + + + + To customize the number of suggestions to be displayed. + + ArrayList + errror_string + + + + + Raised when there is an exception in the . + + + + + Raises the events. + + + + + + Checks the text of the for misspellings with . + + IEditor whose text is to be checked for misspellings. + + + + Shows the . + + Form that owns this dialog. + + + + Shows the . + + Form that owns this dialog. + + + + Deletes the contents of the dictionary file by overwritting. + + File path whose content to be deleted. + + + + Deletes the specified word from the customdictionary. + + Specifies the path of the dictionay file. + Specifies the word to be deleted. + + + + Writes the specified word to the dictionary. + + Specifies the path of the dictionay file. + Specifies the word to be added to the dictionary. + + + + Overwrites the specified wordlist to the dictionary. + + Specifies the path of the dictionay file. + List of words to overrite the dictionary. + + + + Defines a interface that provides methods to interact with the editor. + + + + + Gets or sets the whose is to be spell checked. + + + + + Gets or sets the current misspelled word. + + + + + Selects the word specified by the index. + + Zero based index of the word on the Text. + length of the word to be selected. + + + + Gets or sets the Text to be spell checked by the + + + + + Implements interface to interact with instance of . + + + + + Initializes a new instance of class that hosts the control. + + + + + + Gets or sets the whose is to be spell checked. + + + + + Gets or sets the current misspelled word. + + + + + Selects the word specified by the index. + + Zero based index of the word on the Text. + length of the word to be selected. + + + + Gets or sets the Text to be spell checked by the + + + + + Interface for XmlSerializationReader children. + + + + + Returns deserialized object. + + Deserialized object. + + + + Interface for XmlSerializationWriter children. + + + + + Serializes given object. + + + + + Inherits XmlSerializer and uses manual Xml reader and writer. + + + + + Serialization reader. Used in overriden CreateReader() method. + + + + + Serialization writer. Used in overriden CreateWriter() method. + + + + + Creates new instance of SerialiserWrapper. + + Serialization reader. + Serialization writer. + + + + Forces using of manual reader. + + Xml serialization reader to use. + + + + Forces using of manual writer. + + Xml serialization writer to use. + + + + Serialization. + + + + + + + Deserialization. + + + + + + + Class for managing custom Xml serializers. + + + + + Gets serializer for given type. + + Type to get serializer for. + Custom serializer instance or standard XmlSerializer instance if it canot be found. + + + + Creates files with code of XmlSerializationReader and XmlSerializationWriter derived classes + for manual serialization of sepcified types. + + + + + Temporary subdirectory for storing temporary files. + + + + + Mask for searching .cs files. + + + + + String that should be removed from created code. + + + + + Initial namespace. + + + + + Place in code where writer base type is defined. + + + + + Place in code where reader base type is defined. + + + + + Expression for implementing IXmlSerializationWriter. + + + + + Expression for implementing IXmlSerializationReader. + + + + + Name of Xml reading method in reader class. + + + + + Name of Xml writing method in reader class. + + + + + Initial name of reader class. + + + + + Initial name of writer class. + + + + + Ouput path to store .cs files. + + + + + Namespace of output classes. + + + + + List of names of types to create serializer classes for. + + + + + XmlSerializer.tempAssembly field info. + + + + + XmlSerializer.methodIndex field info. + + + + + TempAssembly.methods field info. + + + + + TempAssembly.TempMethod.readMethod field info. + + + + + TempAssembly.TempMethod.writeMethod field info. + + + + + Creates new instance of XmlSerializersCreator. + + Ouput path to store .cs files. + Namespace of output classes. + List of names of types to create serializer classes for. + + + + Static constructor. Initializes data for reflexion. + + + + + API function for setting value to environment variable. + + Name of variable. + New value. + True if succeeded, otherwise false. + + + + Creates needed files with required classes. + + + + + Gets names of Xml reading and writing methods from given Xml serializer. + + Xml serializer instance to extract data from. + Array of two strings with required names. + + + + Changes classes names and saves code to files. + + Generated text with code. + Name of type to create serializers for. + Path to the directory where result files should be stored. + + + + Adds interfaces implementation to code. + + String with code to modifie. + String with corrected code. + + + diff --git a/ZZPDFTest/bin/Debug/Syncfusion.XlsIO.Base.dll b/ZZPDFTest/bin/Debug/Syncfusion.XlsIO.Base.dll new file mode 100644 index 00000000..bd4f4edc Binary files /dev/null and b/ZZPDFTest/bin/Debug/Syncfusion.XlsIO.Base.dll differ diff --git a/ZZPDFTest/bin/Debug/Syncfusion.XlsIO.Base.xml b/ZZPDFTest/bin/Debug/Syncfusion.XlsIO.Base.xml new file mode 100644 index 00000000..1bd0e643 --- /dev/null +++ b/ZZPDFTest/bin/Debug/Syncfusion.XlsIO.Base.xml @@ -0,0 +1,309098 @@ + + + + Syncfusion.XlsIO.Base + + + + + Performs the parsing operation of Array formulas. + + + + + To check the index of "_" in a string(formula). + + + + + The operators which are involved in array formula. If these operators are not + present in formula, then formula must be returned without parsing. + + + + + Length in each splitted range of array formula. + + + + + Gets or sets the ArrayRecordPostion method from XlsIO side to get the position + of the cell in the array. + + + + + Initialize the object for parsing operations. + + An instance of . + + + + Gets or sets the instance of . + + + + + To split the strings based on the pattern involving operators(-,+,*,/,&). + For example:"A1:B1 * C1:D1" will be splitted as "A1:B1" and "C1:D1" which will + be stored separately in string array. + + The string to be splitted into string array. + String array. + + + + To calculate the height and width of the passed argument. Based on the argument's type of + cell reference or constants, they are calculated separately and if any of the width/height is less than + max height/width, correspondingly range is increased/decreased for range.The minimum width/height is + maintained. + + A string passed to compute maximum height/width. + The height determined for array. + The width determined for array. + The minimum height. + The minimum width. + The string with altered height/width. + + + + Resize range based on the max height and max width of the array and stored in a list + which needs to be parsed. For example: "A1:B3*C1:C2" will be resized based on the + height of "2"(value of smaller row count but not 1) and width of "2"(Value of smaller column count but not 1). + The arguments splitted from GetCellsFromArgs method, will be of the mentioned length of 4. Hence "A1:B3" will be + splitted and be first argument in the list and "C1:C2" will be splitted as the next argument in the list. + This list will be passed for making expressions in Parse method as "A1*C1,B1*C1,A2*C2,B2*C2". + + The formula array which needs to be adjusted and parsed. + The parsed formula string in original format. + The string array. + + + + A method that splits the formula based on the operators. + For example: if the argument is passed as "(A1:B2+C1:D2)" which will be parsed + as "A1+C1,B1+D1,A2+C2,B2+D2". + + The formula passed in with operator. + The parsed formula string in original format. + Splitted formula based on logic. + + + + A method that parses the array formula and return it as normal formula for computation. + For example if the formula is passed as "{=SUM(A1:B1*C1:D1)}", then it will be parsed + and returned as SUM(A1*C1,B1*D1). + + The array formula to be parsed. + The normal formula for parsing in CalcEngine. + + + + A method that invokes for computation of LEN,ROW,COLUMN methods in array formula. + For example if the formula SUM(ROW(A1:A5)) then it should be parsed as SUM({1,2,3,4,5})(excel behavior) + and if the formula is ROW(A1:A5), based on the required cell, the corresponding row index is returned. + + The formula's argument. + The formula name. + The computation level of the formula. + A string which holds the computed value with curly braces. + + + + The function to check if the given formula is multi cell array or not. + For example: if the formula is "{A1:B1 * C1:D1}", then it is a multi cell array + whereas, if the formula is "SUM(A1:B1*C1:D1), then it is not a multi cell array. + + The formula which is passed to check. + True; if it is multicell array;else False. + + + + To parse the multi cell array, that is to get the positon of the array record and returning + the particular formula for the given cell. + For example: if the parsed formula is "A1*C1,B1*D1,A2*C2,B2*D2",then based on the given cell if + the index is 2, then resultant formula is "B1*D1" whereas if the index is "-1", then error + messages is returned. + + formula to be parsed. + The parsed formula string in original format. + Formula required for given cell. + + + + Parsing the one/multi dimensional array constants in formula. For Eg: parsing of + {1,2,3} or {1;2;3} or {1,2;3,4}. It also parses the multi dimensional array with constants + such as {1,2}*{3,4}. + + Formula to be parsed. + The formula/value which needs to be displayed. + + + + If passed formula contains operators involving expressions with commas, then it will + be parsed by splitting the arg's based on comma and storing in the list. For eg: if the + passed argument is "{1*2,3*4,4*5}, then based on the cell's index, particular expression + will be returned + + The formula for parsing. + The height of the arg. + The width of the arg. + Expression/Value based on the formula. + + + + For parsing the horizontal arrays. (i.e) the formula which is separated by + commas, for eg: {1,2,3}. + + Formula to be parsed. + The value based on position of cell. + + + + For parsing the vertical arrays. (i.e) the formula which is separated by + semi colon, for eg: {1;2;3}. + + Formula to be parsed. + The value based on position of cell. + + + + Getting the height in which the array formula will arrange the values of selected range. + Smaller height of the given expression should be preferred but if the smaller value is 1, then the + height of another expression should be considered. + For example:"A1:B3*C1:D2" in which, the smaller height 2 will be considered and returned. + + Splitted strings from original formula. + The height required for array formula. + + + + Getting the width in which the array formula will arrange the values of selected range. + Smaller width of the given expression should be preferred but if the smaller value is 1, then the + width of another expression should be considered. + For example:"A1:B3*C1:E2" in which, the smaller width is 2 will be considered and returned. + + Splitted strings from original formula. + The width required for array formula. + + + + To get the position of the cell in the array formula applied range. + if the cell like "A5" is passed with height and width, then it finds the exact + postion in the selected range "A4:D7" from XlsIO side and returns it. + + The height of the array record. + The width of the array record + The position of the cell. + + + + To Compute the length of the given argument, based on the computational level. + For example if the formula SUM(LEN(A1:A3)), the computation level is greater than 1, + hence it should be parsed as SUM({LEN(A1),LEN(A2),LEN(A3)})(excel behavior) + and if the formula is LEN(A1:A3), the computation level is 1, then + the corresponding length of the cell is returned. + + Passed argument for computation. + Computational level. + Computed result. + + + + To Compute the row index of the given argument, based on the computational level. + For example if the formula SUM(ROW(A1:A3)), the computation level is greater than 1, + hence it should be parsed as SUM({ROW(A1),ROW(A2),ROW(A3)})(excel behavior) + and if the formula is ROW(A1:A3), the computation level is 1, then + the corresponding row index of the cell is returned. + + Passed argument for computation. + Computational level. + Computed result. + + + + To Compute the column index of the given argument, based on the computational level. + For example if the formula SUM(COLUMN(A1:C1)), the computation level is greater than 1, + hence it should be parsed as SUM({COLUMN(A1),COLUMN(B1),COLUMN(C1)})(excel behavior) + and if the formula is COLUMN(A1:C3), the computation level is 1, then + the corresponding column index of the cell is returned. + + Passed argument for computation. + Computational level. + Computed result. + + + + To compute the IF fomrula based on the computation level. + If the computation level is greater than zero and the formula is "IF(G3:G30="",0,1) get the value and perform logical test for each cell and return the array structure value(“1,1,1,1,1,1,0,0,0,1”). + + Passed argument for computation. + Computational level. + Computed result. + + + + To compute the IF fomrula based on the computation level. + + CellRange + Tokens("=",">",">=") + The criteria used to determine which cells to add. + the parsed criteria is number is set as true.otherwise false. + Computational level. + The length of parsed range. + Computed result. + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Delegate defined to access the method GetArrayRecordPosition for + getting position of the cell. + + Row index of the cell. + Column index of the cell. + The height required for the selected range. + The width required for the selected range. + The method containing the four integer parameters. + + + + CalcEngine encapsulates the code required to parse and compute formulas. Hashtable + properties maintain a Formula Library of functions as well as a list + of dependent cells. + + You can add and remove library functions. + + + + + Used to store the value as double + + + + + Used to store the value as double + + + + + Used to store the value as double + + + + + used to calculate the row in Table. + + + + + used to calculate the header in Table. + + + + + used to calculate the total in Table. + + + + + used to calculate the data in Table + + + + + used to calculate all in Table + + + + + This field holds equivalent double value of 1904(DateTime). + + + + + Returns the number of days since 01 Jan 1900. + + Year, month, and day. + Number of days. + + + + Returns the number of days since 01 Jan 1900. + + Text containing a date. + Number of days. + + + + Returns the day of the serial number date. + + Serial number date. + Day of the given date. + + + + Number of days between 2 dates using 360 day year. + + Serial number date1, serial number date1 and method. + Days between the dates. + + + + returns the fraction of the year represented by the number of whole days between two given dates + + startDate, endDate, basis (optional) + returns the fraction of the year + + + + Returns the number of days between two dates. + + startDate, endDate + Returns the number of days + + + + returns the date of given date after the specific month + + startDate, months + returns the date + + + + Returns the last date of the date after the specific month of given date. + + startDate, month + return the date. + + + + Returns the week number of a specific date + + serial_number,start_day of week (optional) + 1 or omitted - Sunday + 2 Monday + 11 Monday + 12 Tuesday + 13 Wednesday + 14 Thursday + 15 Friday + 16 Saturday + 17 Sunday + 21 Monday + returns the week number + + + + Returns ISO week number of the year for a given date + + date + returns ISO week number + + + + returns the date of the given date after the number of working days + + startDate, days, holidays (optional) + returns the date + + + + Returns the value of ComputeNetworkDays + + arguments + + + + + Returns the number of whole workdays between two dates, week end and holidays are not consider as working days + + start_date, end_date,weekend (optional), holidays (optional) + return the work days + + + + Returns the serial number of the given date before or after a specified number of workdays + + startDate, days, weekend (optional) , holidays (optional) + return the serial number of specific date. + + + + Returns the hour of the given time. + + Given time. + Hour of given time. + + + + Returns the minute of the given time. + + Given time. + Minute of given time. + + + + Returns the second of the given time. + + Given time. + Second of given time. + + + + Returns the month of the given date. + + given time + Month of given date. + + + + Returns the current date and time as a date serial number. + + Parameter Ignored. + Current date and time as serial number. + + + + Returns the current date as a date serial number. + + Parameter Ignored. + Current date as date serial number. + + + + Returns a fraction of a day. + + Hour, minute, and second. + Fraction of a day. + + + + Returns a fraction of a day. + + Time as a text string. + Fraction of a day. + + + + Day of the week. + + Serial number date1 and return_type. + Days between the dates. + + + + Returns the year of the given date. + + Given date. + Month of given date. + + + + Returns the number of days or months or years between two dates. + + Start date, end date and unit. + The number of days, months, or years between two dates. + + + + Calculates the Output to the concerned base. + + Data to be converted. + Base of the Given Data + Base to be obtained. + The data concerning to the base in 'to' parameter + + + + Computes the Binary value for the given Decimal Number. + + Data to be converted. + Returns the calculated Binary value. + + + + Computes the Octal value for the given Decimal Number. + + data to be converted. + Returns the calculated Octal value. + + + + Computes the Hexadecimal value for the given Decimal Number. + + Data to be converted. + Returns the calculated Hexadecimal value. + + + + Computes the Octal Number for the given binary NUmber. + + Input BinaryNumber + The resultant Octal Number + + + + Computes the Decimal Number for the given binary NUmber. + + Input BinaryNumber + The resultant Decimal Number + + + + + + + + + + + Computes the Binary value for the given Hexadecimal Data. + + Data to be converted. + Returns the calculated Binary value. + + + + Computes the Octal Equivalent for the given Hexadecimal value + + Data to be converted. + The calculated Octal value for the given. + + + + Computes the Decimal Equivalent for the given Hexadecimal value + + Data to be converted. + The calculated Decimal value for the given. + + + + Computes the Binary value for the given Octal Number. + + Data to be converted. + Returns the calculated Binary value. + + + + Calculates the Hexadecimal equivalent value for the given Octal value + + Data to be converted. + The Converted Hexadecimal value. + + + + Computes the Decimal Equivalent for the given Octal value + + The Value to be converted to Decimal + The calculated value for the given + + + + Gets the Real part of the given Complex number. + + Given complex number. + Real part of the given complex Number. + + + + Gets the Imaginary part of the given Complex number. + + Given complex number. + Imaginary part of the given complex Number. + + + + Returns the absolute value (modulus) of a complex number in x + yi or x + yj text format. + + Input Complex Number + The absolute value (modulus) of given complex number + + + + Computes the Product of the given Complex Numbers + + Input Complex Numbers + The multiplied result of the two complex numbers. + + + + Obtains the complex number for the given real and imaginary part. + + Given real and Imaginary part. + The complex number derived from the real and imaginary part. + + + + Computes the sum of two complex number. + + Parameter that is used for performing sum + The calculated sum of the numbers + + + + Computes the Difference of two complex number. + + Parameter that is used for performing Subtraction + The calculated difference of the numbers + + + + Returns the complex conjugate of a complex number in x + yi or x + yj text format. + + Input Complex Number + The complex conjugate of a complex number in x + yi or x + yj text format. + + + + Computes the Division of the given Complex Numbers + + Input Complex Numbers + The Divided result of the two complex numbers. + + + + Returns the Square Root of the given Complex Number. + + Input Complex Number + The Square Root of the given Complex Number. + + + + Returns the argument (theta), an angle expressed in radians + + Input Complex Number + The argument (theta), an angle expressed in radians + + + + Returns the IMSin of the given Complex Number. + + Input Complex Number + The IMSin of the given Complex Number. + + + + Returns the Hyperbolic Sine value of the given Complex Number. + + Input Complex Number + The Hyperbolic Sine Value of the given Complex Number. + + + + Returns the IMCSC of the given Complex Number. + + Input Complex Number + The IMCSC of the given Complex Number. + + + + Returns the IMCos of the given Complex Number. + + Input Complex Number + The IMCos of the given Complex Number. + + + + Returns the IMSEC of the given Complex Number. + + Input Complex Number + The IMSEC of the given Complex Number. + + + + Returns the IMTan of the given Complex Number. + + Input Complex Number + The IMTan of the given Complex Number. + + + + Returns the IMCot of the given Complex Number. + + Input Complex Number + The IMCot of the given Complex Number. + + + + Returns the IMCSCH of the given Complex Number. + + Input Complex Number + The IMCSCH of the given Complex Number. + + + + Returns the Hyperbolic Cos value of the given Complex Number. + + Input Complex Number + The Hyperbolic Cos Value of the given Complex Number. + + + + Returns the IMTanH of the given Complex Number. + + Input Complex Number + The IMTanH of the given Complex Number. + + + + Returns the IMCotH of the given Complex Number. + + Input Complex Number + The IMCotH of the given Complex Number. + + + + Returns the IMSecH of the given Complex Number. + + Input Complex Number + The IMSecH of the given Complex Number. + + + + Returns the LOG10 value of the given Complex Number. + + Input Complex Number + The Log10 of the given Complex Number. + + + + Returns the Log2 of the given Complex Number. + + Input Complex Number + The Log2 of the given Complex Number. + + + + Returns the LOG value of the given Complex Number. + + Input Complex Number + The Log of the given Complex Number. + + + + Returns the Exponent of the given Complex Number. + + Input Complex Number + The Exponent of the given Complex Number. + + + + Returns the power of the given Complex Number. + + Input Complex Number + The power of the given Complex Number. + + + + Computes the Difference of two complex number. + + Parameter that is used for performing Subtraction + The difference of two complex numbers in x + yi or x + yj text format. + + + + Computes the Bit OR of the given two numbers. + + Input Numbersfor which the OR operations has to be performed. + Bit OR value of the given two numbers. + + + + Computes the Bit XoR of the given two numbers. + + Input Numbersfor which the OR operations has to be performed. + Bit OR value of the given two numbers. + + + + Computes the Bit AND of the given two numbers. + + Input Numbersfor which the AND operations has to be performed. + Bit AND value of the given two numbers. + + + + Computes the Bit Left Shift of the given number. + + Input Numbersfor which the OR operations has to be performed. + Bit Left Shift value of the given number. + + + + Computes the Bit Right Shift of the given number. + + Input Numbersfor which the Bit Right Shift operations has to be performed. + Bit Right Shift value of the given number. + + + + Returns the error function . + + Input Number + The error function. + + + + Returns the Complement of error function . + + Input Number + The Complement of error function. + + + + Returns the error function . + + Input Number + The error function. + + + + Return the value of the ComputeBesselI + + arguments + + + + + Return the value of besseli0 + + value + + + + + Returns the BesselJ function of order n of the specified number. + + Input Number + The BesselJ of the Number. + + + + Returns the Bessel function of order 1 of the specified number. + + + + + + + Returns the Bessel function of order 0 of the specified number. + + + + + + + Returns the BesselY function of order n of the specified number. + + Input Number + The BesselY of the Number. + + + + Returns the Bessel function of the second kind, of order 0 of the specified number. + + + + + + + Returns the Bessel function of the second kind, of order 1 of the specified number. + + + + + + + Returns the value of ComputebesselK + + arguments list + + + + + Returns the value of ComputeConversion + + arguments list + + + + + Clears all look up caches used in HLookUp and VLookUp calculations so they will be recreated the + next time one of these functions is used. + + + + + Returns the value of Clearsheet + + Icalcdata + + + + Use this method to reset internal error strings if you make changes to . + + + + + This method used to find the sheet id of the parsed grid. + + Intsance of ICalcData + The sheet id of the grid + + + + Used to find the determinant internally for matrix function + + double array + array length + double value + + + + Returns the Probabilitydistribution of the normal distribution. + + Value at which the distribution is evaluated. + Mean of the distribution. + Standard deviation of the distribution. + + + + find the cofactor of matrix + + + array length + return the inverse matrix + return success state + + + + To find the inverse of matrix + + matrix + cofactor matrix + matrix length + Inveser matrix + Inverse Matrix + + + + Chi-squared probability density function. + + The value at which the PDF is evaluated. + Degress of freedom, or number independent standard normal distributions. + + + + + Returns the inverse of the CDF of the normal distribution. + + Cumulative probability of the distribution. 0 <= p >= 1. + Mean of the distribution. + Standard deviation of the distribution. + + + + Returns the inverse of the CDF of the standard normal distribution. + + Cumulative probability of the distribution. p is between 0 and 1. + + + + Computes the net present value an investment. + + Delimited string containing the rate as percentage per period + and a list of invested values. + Net present value. + + + + Computes the payment for a loan. + + Delimited string containing the rate as percentage per period, + number of periods, present value, future value, and payment type (0 = end of period, 1 = start of period). + Payment amount. + + + + Computes the principal payment for a period. + + Delimited string containing the rate as percentage per period, the period, + number of periods, present value, future value, and payment type (0 = end of period, 1 = start of period). + Principal payment. + + + + Computes the present value of an investment. + + Delimited string containing the rate as percentage per period, + number of periods, payment per period, future value, and payment type (0 = end of period, 1 = start of period). + Present value. + + + + Compute the effective annual interest rate. + + the nominal annual interest rate and the number of compounding periods per year + The effective annual interest rate. + + + + Computes the internal rate of return of a series of cash flows. + + Delimited string containing a range of cells and an initial guess. + Internal rate of return. + + This IRR calculation uses Newton's method to approximate a root of + f(r) = Sum( values[i]/(1+r)^i) = 0 + where the Sum index is i = 1 to the number of values. The algorithm returns a value if + the relative difference between root approximations is less than 1e-7. It fails if this + accuracy is not attained in 20 iterations. + + + + + Computes the straight-line depreciation of an asset per period. + + Delimited string containing the cost, + salvage value, and life. + Depreciation of the asset. + + + + Computes the sum of years digits depreciation of an asset per period. + + Delimited string containing the cost, + salvage value, life, and period. + Depreciation for the requested period. + + + + Computes the variable declining balance of an asset. + + Delimited string containing the initial cost, + salvage value, life of asset, period of calculation, and factor. + Variable declining balance. + + + + Converts a number to text using currency format. + + Number and the number of digits. + Currency format string. + + + + Converts a number to text using currency format. + + Number and the number of digits. + Currency format string. + + + + Returns the weighted average of the present value of the cash flows + + Number and the number of digits + Number of years + + + + Calculates the accrued interest of a security that pays interest at maturity. + + Number and the number of digits + Accrued interest + + + + Calculates the equivalent interest rate for the growth of an investment. + + Investment periods, present and future value of the investments. + Returns the equivalent interest. + + + + Returns the future value of an initial principal after applying a series of compound interest rates. + + Number and the number of digits + Number of future value + + + + Returns the interest rate for a fully invested security. + + Number and the number of digits + Rate of interest + + + + Returns the discount rate for a security. + + Number and the number of digits + Rate of Discount + + + + Computes the future value of an investment. + + Delimited string containing the rate as percentage per period, + number of periods, payment per period, present value, and payment type (0 = end of period, 1 = start of period). + Future value of the investment. + + + + Computes the interest payment for a period. + + Delimited string containing the rate as percentage per period, the period, + number of periods, present value, future value, and payment type (0 = end of period, 1 = start of period). + Interest payment. + + + + Computes the internal rate of return of a series of cash flows. + + Delimited string containing a range of cells and an initial guess. + Internal rate of return. + + This IRR calculation uses Newton's method to approximate a root of + f(r) = Sum( values[i]/(1+r)^i) = 0 + where the Sum index is i = 1 to the number of values. The algorithm returns a value if + the relative difference between root approximations is less than 1e-5. It fails if this + accuracy is not attained in 20 iterations. + + + + + Computes the internal rate of return for a schedule of possibly non-periodic cash flows. + + A list of two or three arguments. The first argument contains a range of cash flows, the second argument + contains a list of corresponding date serial number values, and the third argument contains an initial guess at the return value. + The internal rate of return. + The computation uses a root finding algorithm. If the algorithm does not converge to a result within 100 iterations, + an error is returned. The convergence requirement is an absolute error of 0.000001. The first date must be the earliest date, + and the dates must be date serial numbers. Also, there must be at least one positive cash flow and at least one negative cash + flow in the cash flow values. + + + + + Computes the extended internal rate of return for a schedule of possibly non-periodic cash flows. + + Which contains the non periodic cashflows. + Which contains the details about the investment days of non-periodic cash flows. + Which denotes the inital guess value. + + Returns the xiir calculation value. + + + + + Computes the extended internal rate of return for a schedule of possibly non-periodic cash flows. + + Which contains the non periodic cashflows. + Which contains the details about the investment days of non-periodic cash flows. + Which denotes the guess value. + + Returns the xiir calculation value. + + + + + Computes the Net Present Value for a schedule of possibly non-periodic cash flows. + + Which contains the non periodic cashflows. + Which contains the details about the investment days of non-periodic cash flows. + Which denotes the guess value. + + Returns the Net Present Value. + + + + + Computes the Net Present Dervative Value for a schedule of possibly non-periodic cash flows. + + Which contains the non periodic cashflows. + Which contains the details about the investment days of non-periodic cash flows. + Which denotes the guess value. + + Returns the Net Present Dervative Value. + + + + + Computes the simple interest payment. + + Delimited string containing the rate as percentage per period, the period, + number of periods, and present value. + Simple interest payment. + + + + Computes the modified internal rate of return of a series of cash flows. + + Delimited string containing a range of cells, + finance interest rate, and a reinvested interest rate. + Modified internal rate of return. + + + + Computes the number of periods an investment. + + Delimited string containing the rate as percentage per period, + payment per period, present value, future value, and payment type (0 = end of period, 1 = start of period). + Number of periods. + + + + Computes the declining balance of an asset. + + Delimited string containing the initial cost, + salvage value, life of asset, period of calculation, and months in the initial year. + Declining balance. + + + + Computes the double declining balance of an asset. + + Delimited string containing the initial cost, + salvage value, life of asset, period of calculation, and factor. + Double declining balance. + + + + Returns the cumulative interest paid for an investment period with a constant interest rate. + + Number and the number of digits + Number of interest rate + + + + Calculates the accrued interest of a security in the case of periodic payments. + + Number and the number of digits + Accrued interest + + + + Returns the cumulative principal paid for an investment period with a constant interest rate. + + Number and the number of digits + Cumulative principal value + + + + Returns the amount received at maturity for a fully invested security. + + Number and the number of digits + Received amount + + + + This function computes the nominal interest rate based on the effective annual interest rate and the number of compounding periods per year. + + + A comma-separated string containing two values. The format should be: effective_rate, npery. + + effective_rate: The effective annual interest rate as a decimal (e.g., 0.053543 for 5.3543%). + npery: The number of compounding periods per year as an integer (e.g., 4 for quarterly compounding). + + + + A string representing the nominal interest rate. If the input is invalid or cannot be parsed, an error message is returned. + + + The nominal interest rate is calculated using the formula: + + nominalRate = npery * (Math.Pow(1 + effectRate, 1.0 / npery) - 1) + + where effectRate is the effective annual interest rate and npery is the number of compounding periods per year. + The method checks that the effective annual interest rate is positive and that the number of compounding periods is at least 1. + If the inputs are invalid (e.g., non-numeric values, negative rates, or invalid period counts), an appropriate error message is returned. + + + + + This function calculates the Modified Duration (MDuration) of a security, similar to the MDuration function in Excel. + This measure indicates how sensitive the bond's price is to changes in interest rates, adjusted for the bond's yield and the frequency of its coupon payments. + + + A comma-separated string of arguments. The format should be: settlement_date, maturity_date, coupon_rate, yield_rate, frequency, [basis]. + + settlement_date: The date when the bond is purchased (format: DATE function or serial number). + maturity_date: The date when the bond matures (format: DATE function or serial number). + coupon_rate: The annual coupon rate of the bond as a decimal (e.g., 0.08 for 8%). + yield_rate: The annual yield of the bond as a decimal (e.g., 0.09 for 9%). + frequency: The number of coupon payments per year (e.g., 1 for annual, 2 for semiannual, 4 for quarterly). + basis: Optional. The day count basis to use (0 for US 30/360, 1 for Actual/Actual, 2 for Actual/360, 3 for Actual/365, 4 for European 30/360). + + + + A string representing the modified duration of the bond, rounded to a reasonable number of decimal places. + If any input is invalid (e.g., incorrect date format, negative rates, or invalid frequency), an error message is returned. + + + + + Calculates the modified duration of a bond given its parameters. + + The bond's settlement date. + The bond's maturity date. + The bond's annual coupon rate. + The bond's annual yield. + The number of coupon payments per year. + The day count basis for the bond's interest calculation. + The modified duration of the bond as a string. + + + + This function computes the number of periods required for an investment to reach a specified future value based on the given interest rate and present value. + + + A comma-separated string of arguments. The format should be: rate, present_value, future_value. + + rate: The interest rate per period as a decimal (e.g., 0.025 for 2.5%). + present_value: The current value of the investment. + future_value: The desired future value of the investment. + + + + A string representing the number of periods required to reach the future value, rounded to two decimal places. + If any input is invalid (e.g., negative values or non-numeric inputs), an error message is returned. + + + + + This function computes the next coupon date after the settlement date for a bond and returns the date as a serial date number. + + + A comma-separated string of arguments. The format should be: settlement_date, maturity_date, frequency, [basis]. + + settlement_date: The date when the bond is purchased (format: DATE function or serial number). + maturity_date: The date when the bond matures (format: DATE function or serial number). + frequency: The number of coupon payments per year (e.g., 1 for annual, 2 for semiannual, 4 for quarterly). + basis: Optional. The day count basis to use (0 for US 30/360, 1 for Actual/Actual, 2 for Actual/360, 3 for Actual/365, 4 for European 30/360). + + + + A string representing the next coupon date after the settlement date, formatted as a serial date number. + If any input is invalid (e.g., incorrect date format, invalid frequency, or if the settlement date is on or after the maturity date), an error message is returned. + + + + + Checks and parses the input arguments for COUP functions. + + A string containing the arguments: settlement date, maturity date, frequency, and optionally, the basis. + Outputs the parsed settlement date. + Outputs the parsed maturity date. + Outputs the parsed coupon payment monthBetweenCoupon + Outputs the parsed day count basis (0-4). + Returns an error message if arguments are invalid, otherwise an empty string. + + + + This function computes the previous coupon date before the settlement date for a bond and returns the date as a serial date number. + + + A comma-separated string of arguments. The format should be: settlement_date, maturity_date, frequency, [basis]. + + settlement_date: The date when the bond is purchased (format: DATE function or serial number). + maturity_date: The date when the bond matures (format: DATE function or serial number). + frequency: The number of coupon payments per year (e.g., 1 for annual, 2 for semiannual, 4 for quarterly). + basis: Optional. The day count basis to use (0 for US 30/360, 1 for Actual/Actual, 2 for Actual/360, 3 for Actual/365, 4 for European 30/360). + + + + A string representing the previous coupon date before the settlement date, formatted as a serial date number. + If any input is invalid (e.g., incorrect date format, invalid frequency, or if the settlement date is on or after the maturity date), an error message is returned. + + + + + This function computes the number of days from the beginning of the coupon period to the settlement date for a bond. + + + A comma-separated string of arguments. The format should be: settlement_date, maturity_date, frequency, [basis]. + + settlement_date: The date when the bond is purchased (format: DATE function or serial number). + maturity_date: The date when the bond matures (format: DATE function or serial number). + frequency: The number of coupon payments per year (e.g., 1 for annual, 2 for semiannual, 4 for quarterly). + basis: Optional. The day count basis to use (0 for US 30/360, 1 for Actual/Actual, 2 for Actual/360, 3 for Actual/365, 4 for European 30/360). + + + + A string representing the number of days from the beginning of the coupon period to the settlement date. + If any input is invalid (e.g., incorrect date format, invalid frequency, or if the settlement date is on or after the maturity date), an error message is returned. + + + + + Computes the number of days in the coupon period that contains the settlement date. + + The settlement date. + The maturity date. + The coupon frequency (1, 2, or 4). + The day count basis (0 to 4). + A string representing the number of days in the coupon period. + + + + Calculates the number of days between two dates based on the 30/360 day count convention. + + The start date. + The end date. + The day count basis: 0 for US (NASD) 30/360, 4 for European 30/360. + The number of days between the start and end dates, adjusted according to the specified 30/360 basis. + + + + This function computes the number of days from the settlement date to the next coupon date for a bond. + + + A comma-separated string of arguments. The format should be: settlement_date, maturity_date, frequency, [basis]. + + settlement_date: The date when the bond is purchased (format: DATE function or serial number). + maturity_date: The date when the bond matures (format: DATE function or serial number). + frequency: The number of coupon payments per year (e.g., 1 for annual, 2 for semiannual, 4 for quarterly). + basis: Optional. The day count basis to use (0 for US 30/360, 1 for Actual/Actual, 2 for Actual/360, 3 for Actual/365, 4 for European 30/360). + + + + A string representing the number of days from the settlement date to the next coupon date. + If any input is invalid (e.g., incorrect date format, invalid frequency, or if the settlement date is on or after the maturity date), an error message is returned. + + + + + This function calculates the total number of days in the coupon period that contains the settlement date for a bond. + + + A comma-separated string of arguments. The format should be: settlement_date, maturity_date, frequency, [basis]. + + settlement_date: The date when the bond is purchased (format: DATE function or serial number). + maturity_date: The date when the bond matures (format: DATE function or serial number). + frequency: The number of coupon payments per year (e.g., 1 for annual, 2 for semiannual, 4 for quarterly). + basis: Optional. The day count basis to use (0 for US 30/360, 1 for Actual/Actual, 2 for Actual/360, 3 for Actual/365, 4 for European 30/360). + + + + A string representing the total number of days in the coupon period that contains the settlement date. If any input + is invalid (e.g., incorrect date format, invalid frequency, or if the settlement date is on or after the maturity date), + an error message is returned. + + + + + This function calculates the number of coupons payable between the settlement date and the maturity date. + + + A string containing the input arguments separated by commas. The format should be: "settlement, maturity, frequency, [basis]" + + + settlement: The settlement date of the security, represented as a date string. + + + maturity: The maturity date of the security, represented as a date string. + + + frequency: The number of coupon payments per year (1 for annual, 2 for semi-annual, 4 for quarterly). + + + basis [optional]: The day count basis to use (0 = US (NASD) 30/360, 1 = Actual/actual, 2 = Actual/360, 3 = Actual/365, 4 = European 30/360). If omitted, the default is 0. + + + + + A string representing the number of coupons payable between the settlement date and maturity date, rounded up to the nearest whole coupon. + Returns an error message if the input arguments are invalid or if an error occurs during the calculation. + + + + + + Check and parse the input arguments for Treasury bill formula. + + + + + This function computes the linear depreciation (AMORLINC) for an asset over each accounting period. + + + A comma-separated string containing the input arguments in the following format: "cost, datePurchased, firstPeriod, salvage, period, rate, [basis]". + + + cost: The initial cost of the asset. + + + datePurchased: The date the asset was purchased, provided in "yyyy-MM-dd" format. + + + firstPeriod: The end date of the first depreciation period, provided in "yyyy-MM-dd" format. + + + salvage: The expected salvage value of the asset at the end of its useful life. + + + period: The total number of periods over which the asset will be depreciated. + + + rate: The depreciation rate applied for each period. + + + + basis [optional]: The day count basis to use + (0 = US (NASD) 30/360, + 1 = Actual/actual, + 2 = Actual/360, + 3 = Actual/365, + 4 = European 30/360). + If omitted, the default is 0. + + + + + + A string representing the calculated depreciation for the specified period. If the input parameters are invalid, an error message is returned. + + + + + + This function calculates the price discount of a security based on its settlement date, maturity date, discount rate, redemption value, and day count basis. + + + A comma-separated containing the input arguments in the format: "settlement, maturity, discount, redemption, [basis]" + + + settlement: The settlement date of the security, represented as a date string (yyyy-MM-dd) or serial number. + + + maturity: The maturity date of the security, represented as a date string (yyyy-MM-dd) or serial number. + + + discount: The discount rate of the security, represented as a decimal value (e.g., 0.05 for 5%). Must be greater than 0. + + + redemption: The redemption value of the security, represented as a decimal value. Must be greater than 0. + + + + basis [optional]: The day count basis to use + (0 = US (NASD) 30/360, + 1 = Actual/actual, + 2 = Actual/360, + 3 = Actual/365, + 4 = European 30/360). + If omitted, the default is 0. + + + + + + A string representing the calculated price discount. Returns an error message if the input arguments are invalid or if an error occurs during the calculation. + + + + + Parses and validates input arguments for both yield and price discount methods. + + Input arguments as a string. + Array of parsed argument values. + The settlement date of the security. + The maturity date of the security. + Price or discount value, depending on the calculation. + The redemption value of the security. + The day count basis to use. + Indicates whether the method is calculating yield (true) or price (false). + Returns an error string if any issues are encountered; otherwise, returns an empty string. + + + + Determine number of days between two dates based on the day count basis. + + + + + Get the year basis for day count. + + + + + This function calculates the price per $100 face value for a Treasury bill based on the settlement date, maturity date, and discount rate. + + + A comma-separated string containing the input arguments in the format: "settlement, maturity, discount". + + + + settlement: The Treasury bill's settlement date in "yyyy-MM-dd" format. + This is the date the T-bill is purchased. + + + + + maturity: The Treasury bill's maturity date in "yyyy-MM-dd" format. + This is the date the T-bill matures, and the face value is repaid. + + + + + discount: The T-bill's discount rate expressed as a percentage + (e.g., 5.5 for 5.5%). + + + + + + A string representing the calculated price per $100 face value for the Treasury bill + If input parameters are invalid or calculation errors occur, an error message will be returned. + + + + + This function calculates and returns the yield for a Treasury bill based on the settlement date, maturity date, and price per $100 face value. + + + A comma-separated string containing the input arguments in the format: "settlement, maturity, pr". + + + + settlement: The settlement date of the Treasury bill in "yyyy-MM-dd" format. + This is the date on which the T-bill is purchased by the buyer. + + + + + maturity: The maturity date of the Treasury bill in "yyyy-MM-dd" format. + This is the date on which the T-bill expires and its face value is paid to the holder. + + + + + pr: The price of the Treasury bill per $100 face value, represented as a numeric value. + + + + + + A string representing the calculated yield of the Treasury bill as a percentage. + If the input arguments are invalid or an error occurs during calculation, an appropriate error message is returned. + + + + + This function Computes and returns the price per $100 face value of a security that pays periodic interest. + + + A comma-separated string containing the numeric input values for which the price is to be calculated. + The format should be: "settlement, maturity, rate, yld, redemption, frequency, [basis]". + + + + settlement: The settlement date of the security in "yyyy-MM-dd" format. + This is the date after the issue date when the security is traded to the buyer. + + + + + maturity: The maturity date of the security in "yyyy-MM-dd" format. + This is the date on which the security expires, and its face value is paid to the holder. + + + + + rate: The annual coupon rate of the security, represented as a decimal value + (e.g., 0.05 for 5%). + + + + + yld: The annual yield of the security, represented as a decimal value + (e.g., 0.04 for 4%). + + + + + redemption: The redemption value of the security per $100 face value, typically + represented as 100 or another numeric value. + + + + + frequency: The number of coupon payments per year. Use: + + 1 for annual payments + 2 for semiannual payments + 4 for quarterly payments + + + + + + basis [optional]: The day-count basis to use for the calculation. Valid values are: + + 0 = US (NASD) 30/360 (default) + 1 = Actual/Actual + 2 = Actual/360 + 3 = Actual/365 + 4 = European 30/360 + + If omitted, the default is 0 (30/360). + + + + + + A string representing the price per $100 face value of a security that pays periodic interest. + If the input values are invalid or if an error occurs during the calculation, an appropriate + error message is returned. + + + + + Parses and validates input arguments for yield and price calculations. + Extracts dates, rates, and other parameters, ensuring they meet the required constraints. + Returns an error message string if validation fails, or an empty string upon success. + + Array of input argument strings. + Output: Annual coupon rate as a percentage. + Output: Price of the bond. + Output: Redemption value of the bond. + Output: Number of coupon payments per year (1, 2, or 4). + Output: Day count basis (0 to 4). + Output: Serial number representing the settlement date. + Output: Serial number representing the maturity date. + + An empty string if validation succeeds, or an error message string if it fails. + + + + + Calculates the price of a bond when the number of coupons is greater than one. + Incorporates periodic coupon payments, discounting, and redemption value. + + Number of days from the beginning of the coupon period to the settlement date. + Total number of days in the coupon period. + Annual coupon rate as a percentage. + Yield to maturity as a percentage. + Redemption value of the bond. + Number of coupon payments per year. + Number of remaining coupon payments. + The computed bond price. + + + + Computes the power of a number with optimization for near-integer exponents. + Reduces computation time by checking if the exponent is close to an integer. + + Base number. + Exponent value. + The computed power of the base number raised to the given exponent. + + + + This function calculates the yield of a security that pays periodic interest. + + + A comma-separated string containing the input arguments in the format: "settlement, maturity, rate, price, redemption, frequency, [basis]". + + + + settlement: The settlement date of the security, specified in "yyyy-MM-dd" format or as a serial number. This is the date when the security is traded to the buyer. + + + + + maturity: The maturity date of the security, specified in "yyyy-MM-dd" format or as a serial number. This is the date when the security expires, and its face value is paid to the holder. + + + + + rate: The annual coupon rate of the security, expressed as a decimal (e.g., 0.05 for 5%). + + + + + price: The price of the security per $100 face value, typically a numeric value. + + + + + redemption: The redemption value of the security per $100 face value, typically a numeric value. + + + + + frequency: The number of coupon payments per year. Acceptable values are: + + 1 for annual payments. + 2 for semi-annual payments. + 4 for quarterly payments. + + + + + + basis (optional): The day count basis used for the calculation. Defaults to 0 (NASD 30/360). Acceptable values are: + + 0: NASD 30/360. + 1: Actual/Actual. + 2: Actual/360. + 3: Actual/365. + 4: European 30/360. + + + + + + + A string representing the calculated yield of the security as a percentage. If the input parameters are invalid, an error message is returned. + + + + + Calculates the yield for a bond with less than one coupon payment remaining. + + The calculated yield. + + + + Estimates the yield of a security using an iterative approach for cases with more than one coupon payment. + + + + + This function calculates the annual yield of a security that pays interest at maturity based on its settlement date, maturity date, issue date, coupon rate, price, and day count basis. + + + A comma-separated string containing the input arguments in the following format: "settlement, maturity, issue, rate, price, [basis]". + + + + settlement: The settlement date of the security, specified in "yyyy-MM-dd" format or as a serial number. This is the date when the security is traded to the buyer. + + + + + maturity: The maturity date of the security, specified in "yyyy-MM-dd" format or as a serial number. This is the date when the security expires, and its face value is paid to the holder. + + + + issue: The issue date of the security, specified in "yyyy-MM-dd" format or as a serial number. This is the date when the security is first issued. + + + rate: The annual coupon rate of the security, represented as a decimal value (e.g., 0.05 for 5%).This value must be greater than 0. + + + price: The price of the security per $100 face value. This value must be greater than 0. + + + + basis [optional]: The day count basis to use for the calculation. Defaults to 0 (US NASD 30/360) if omitted. Acceptable values are: + (0 = US (NASD) 30/360, + 1 = Actual/actual, + 2 = Actual/360, + 3 = Actual/365, + 4 = European 30/360). + + + + + + A string representing the calculated yield value at the maturity date. If the input arguments are invalid, an error message is returned. + + + + + This method parses the input arguments for YIELDMAT and PRICEMAT functions and extracts the required values. + + Returns an error string if validation fails, or an empty string if successful. + + + + Calculates the price of a security that pays interest at maturity, based on its settlement date, maturity date, issue date, coupon rate, yield, and day count basis. + + + A comma-separated string containing the input arguments in the following format: "settlement, maturity, issue, rate, yield, [basis]". + + + + settlement: The settlement date of the security. + This is the date when the security is traded to the buyer. + It should be provided as a date string in "yyyy-MM-dd" format or as a serial number. + + + + + maturity: The maturity date of the security. + This is the date when the security expires, and its face value is paid to the holder. + It should be provided as a date string in "yyyy-MM-dd" format or as a serial number. + + + + + issue: The issue date of the security. + This is the date when the security was first issued. + It should be provided as a date string in "yyyy-MM-dd" format or as a serial number. + + + + + rate: The annual coupon rate of the security, represented as a decimal value (e.g., 0.05 for 5%). + This value must be greater than 0. + + + + + yield: The annual yield of the security, represented as a decimal value (e.g., 0.06 for 6%). + This value must be greater than 0. + + + + + basis [optional]: The day count basis to use for the calculation. + Defaults to 0 (US NASD 30/360) if omitted. + Acceptable values are: + + 0 = US (NASD) 30/360 + 1 = Actual/actual + 2 = Actual/360 + 3 = Actual/365 + 4 = European 30/360 + + + + + + + A string representing the calculated price of the security. + If the input arguments are invalid, an error message is returned. + + + + + This function calculates the yield discount of a security based on its settlement date, maturity date, price, redemption value, and day count basis. + + + A comma-separated string containing the input arguments in the following format: "settlement, maturity, price, redemption, [basis]". + + + + settlement: The settlement date of the security. + This is the date when the security is traded to the buyer. + It should be provided as a date string in "yyyy-MM-dd" format or as a serial number. + + + + + maturity: The maturity date of the security. + This is the date when the security expires, and its face value is paid to the holder. + It should be provided as a date string in "yyyy-MM-dd" format or as a serial number. + + + + + price: The price of the security, represented as a decimal value per $100 face value. + This value must be greater than 0. + + + + + redemption: The redemption value of the security, represented as a decimal value per $100 face value. + This value must be greater than 0. + + + + + basis [optional]: The day count basis to use for the calculation. + Defaults to 0 (US NASD 30/360) if omitted. + Acceptable values are: + + 0 = US (NASD) 30/360 + 1 = Actual/actual + 2 = Actual/360 + 3 = Actual/365 + 4 = European 30/360 + + + + + + + A string representing the calculated annual yield discount. If the input arguments are invalid, an error message is returned. + + + + + This function calculates the Net Present Value (NPV) of a series of cash flows occurring at irregular intervals using a specified discount rate. + + + A comma-separated string of arguments in the format: rate, values, dates. + + + rate: The discount rate applied to the cash flows.It is used to discount future cash flows to their present value. + + + + values: A series of cash flow amounts corresponding to the payment dates. + The first payment is optional and typically represents a cost or initial investment, and should be negative if it is a payment. + All subsequent payments are discounted based on a 365-day year. + The series must include at least one positive value (income) and one negative value (expense). + + + + + dates: A series of dates corresponding to the cash flow payments. + The first date represents the starting point of the cash flow schedule.Subsequent dates must occur after the first date, although they can be in any order.. + + + + + + Returns the calculated Net Present Value (NPV) as a string based on the provided discount rate, cash flows, and payment dates. + If an error occurs, such as invalid input format or mismatched values and dates, an error message is returned. + + + + + This method compute and return the Values and Dates array.If error string finds retrun error string. + + + + + Computes and populates a values array based on the provided input string. + If an error is encountered during processing, an error string is returned. + + + The input string to be processed. + + + A reference to a list where valid numeric values will be added. + + + A reference to a string where the error message will be set if the input string is invalid. + + + + + Computes and populates a values array based on the provided input string. + If an error is encountered during processing, an error string is returned. + + + The input string to be processed. + + + A reference to a list where valid numeric values will be added. + + + A reference to a string where the error message will be set if the input string is invalid. + + + + + This function calculates the price per $100 face value of a security that has an odd (short or long) last coupon period. + + + A comma-separated string containing the input arguments in the format: + "settlement, maturity, issue, rate, yld, redemption, frequency, [basis]". + + + + settlement: The settlement date of the security, specified in "yyyy-MM-dd" format or as a serial number. + This is the date the buyer purchases the security. + + + + + maturity: The maturity date of the security, specified in "yyyy-MM-dd" format or as a serial number. + This is the date the security expires. + + + + + last_interest: The security's last coupon date, specified in "yyyy-MM-dd" format or as a serial number. + This is the date of the most recent coupon payment prior to the settlement date. + + + + + rate: The annual coupon rate of the security, expressed as a percentage (e.g., 5% is represented as 5.0). + + + + + yld: The annual yield of the security, expressed as a percentage (e.g., 5% is represented as 5.0). + + + + + redemption: The redemption value of the security per $100 face value. + Typically, this is 100 if the security is redeemed at par. + + + + + frequency: The number of coupon payments per year. Valid values are: + + 1: Annual payments. + 2: Semi-annual payments. + 4: Quarterly payments. + + + + + + basis (optional): The day count basis for the calculation. Defaults to 0 (NASD 30/360). Valid values are: + + 0: NASD 30/360. + 1: Actual/Actual. + 2: Actual/360. + 3: Actual/365. + 4: European 30/360. + + + + + + + A string representing the calculated price of the security with an odd last period. + Returns an error message if the input parameters are invalid or if validation fails. + + + + + Parses and validates input arguments for the ODDLPRICE and ODDLYIELD functions. + + A string containing the input arguments for ODDLPRICE or ODDLYIELD. + Returns an error message if validation fails, or an empty string if successful. + + + + Calculates the non-negative day difference between two dates using a day count basis, with additional logic for day count convention. + + The positive difference in days between start and end dates as a double. + + + + Calculates the non-negative difference in days between two dates based on the specified day count basis. + + The positive difference in days between start and end dates as a double. + + + + This function calculates the yield of a security with an odd (short or long) last coupon period. + + + A comma-separated string containing the input arguments in the format: + "settlement, maturity, issue, rate, yld, redemption, frequency, [basis]". + + + + settlement: The settlement date of the security, specified in "yyyy-MM-dd" format or as a serial number. + This is the date the buyer purchases the security. + + + + + maturity: The maturity date of the security, sepcified in "yyyy-MM-dd" format or as a serial number. + This is the date the security expires. + + + + + issue: The issue date of the security, sepcified in "yyyy-MM-dd" format or as a serial number. + This is the date the security was originally issued. + + + + + rate: The annual coupon rate of the security, expressed as a percentage (e.g., 5% is represented as 5.0). + + + + + pr: The price of the security per $100 face value, expressed as a percentage (e.g., a price of $95 is represented as 95.0). + + + + + redemption: The redemption value of the security per $100 face value. + Typically, this is 100 if the security is redeemed at par. + + + + + frequency: The number of coupon payments per year. Valid values are: + + 1: Annual payments. + 2: Semi-annual payments. + 4: Quarterly payments. + + + + + + basis (optional): The day count basis for the calculation. Defaults to 0 (NASD 30/360). Valid values are: + + 0: NASD 30/360. + 1: Actual/Actual. + 2: Actual/360. + 3: Actual/365. + 4: European 30/360. + + + + + + + A string representing the computed yield of the security with an odd last period. + Returns an error message if the input parameters are invalid or if validation fails. + + + + + This function calculates the depreciation for an asset using the AMORDEGRC method, an accelerated depreciation approach. + The method applies a declining balance approach where the depreciation rate increases based on the asset's lifespan. + + + A comma-separated string containing the input arguments in the format: "cost, purchaseDate, firstPeriodEndDate, salvageValue, period, rate, [basis], [lifetime]". + + + + cost: The initial cost of the asset. + + + + + purchaseDate: The date of purchase, sepcified in "yyyy-MM-dd" format or as a serial number. + + + + + firstPeriodEndDate: The end date of the first period, sepcified in "yyyy-MM-dd" format or as a serial number. + + + + + salvageValue: The salvage value of the asset at the end of its useful life. + + + + + period: The period for which depreciation is to be calculated (e.g., the number of years). + + + + + rate: The depreciation rate of the asset. + + + + + basis (optional): The day count basis to use for the calculation. Defaults to 0 (NASD 30/360). Acceptable values are: + + 0: NASD 30/360. + 1: Actual/Actual. + 2: Actual/360. + 3: Actual/365. + 4: European 30/360. + + + + + + lifetime (optional): The total lifetime of the asset in periods. If omitted, it defaults to the standard asset lifetime. + + + + + + A formatted string containing the calculated depreciation value for the specified period. If the input parameters are invalid, an error message is returned. + + + + + Performs the AMORDEGRC depreciation calculation for an asset based on cost, dates, salvage value, depreciation period, and rate. + + String representation of the calculated depreciation amount. + + + + Determines the depreciation coefficient based on the asset's lifetime. + + Depreciation coefficient as a multiplier (1.0, 1.5, 2.0, or 2.5). + + + + Adjusts the date to ensure proper handling of the first period depreciation based on the day count basis. + + The adjusted date. + + + + Calculates the AMORDEGRC depreciation for a given period. + + The depreciation value for the specified period. + + + + This function calculates the price per $100 face value of a security with an odd first period + + + A comma-separated string containing the input arguments in the format: + "settlement, maturity, issue, first_coupon, rate, yld, redemption, frequency, [basis]". + + + + settlement: The settlement date of the security, in "yyyy-MM-dd" format or as a serial number. + + + + + maturity: The maturity date of the security, in "yyyy-MM-dd" format or as a serial number. + + + + + issue: The issue date of the security, in "yyyy-MM-dd" format or as a serial number. + + + + + first_coupon: The date of the first coupon payment, in "yyyy-MM-dd" format or as a serial number. + + + + + rate: The annual coupon rate of the security. + + + + + yld: The annual yield of the security. + + + + + redemption: The redemption value of the security per $100 face value. + + + + + frequency: The number of coupon payments per year. Acceptable values are: + + 1 for annual payments. + 2 for semi-annual payments. + 4 for quarterly payments. + + + + + + basis (optional): The day count basis to use for the calculation. Defaults to 0 (NASD 30/360). Acceptable values are: + + 0: NASD 30/360. + 1: Actual/Actual. + 2: Actual/360. + 3: Actual/365. + 4: European 30/360. + + + + + + + A formatted string of the calculated price of the security with an odd first period. If the input parameters are invalid, an error message is returned. + + + + + Parses and validates input arguments for the ODDFPRICE and ODDFYIELD formulae. + + + + + Calculates the odd first coupon price for a bond based on the given parameters. + + + + + Calculates the adjustment factors for the odd first coupon period in a bond price calculation. + + A function that calculates cumulative adjustment values for principal and interest components. + + + + Aggregates values over a specified range, applying a collector function to accumulate results. + + An array containing the accumulated results. + + + + Calculates an aggregated result by applying a specified function to a range of integers, + accumulating the result as a double value. The function iterates from the specified start to end values, + using a seed value as the initial result and aggregating using the provided collector function. + + The final accumulated result as a double after applying the collector function across the specified range. + + + + Generates a sequence of integers between a specified start and end, inclusive. + + An IEnumerable containing integers from start to end. + + + + Calculates the number of coupon periods between two dates based on the specified interval in months. + + The number of coupon periods between startDate and endDate. + + + + This function calculates the yield of a security that has an odd (short or long) first period. + + + A comma-separated string containing the input arguments in the format: "settlement, maturity, issue, first_coupon, rate, yld, redemption, frequency, [basis]". + + + + settlement: The settlement date of the security, in the provided format "yyyy-MM-dd" or as a serial number. + + + + + maturity: The maturity date of the security, in the provided format "yyyy-MM-dd" or as a serial number. + + + + + issue: The issue date of the security, in the provided format "yyyy-MM-dd" or as a serial number. + + + + + first_coupon: The date of the first coupon payment, in the provided format "yyyy-MM-dd" or as a serial number. + + + + + rate: The annual coupon rate of the security. + + + + + pr: The annual price of the security. + + + + + redemption: The redemption value of the security per $100 face value. + + + + + frequency: The number of coupon payments per year. Acceptable values are: + + 1 for annual payments. + 2 for semi-annual payments. + 4 for quarterly payments. + + + + + + basis (optional): The day count basis to use for the calculation. Defaults to 0 (NASD 30/360). Acceptable values are: + + 0: NASD 30/360. + 1: Actual/Actual. + 2: Actual/360. + 3: Actual/365. + 4: European 30/360. + + + + + + + A formatted string of the calculated yield of the security with an odd first period. If the input parameters are invalid, an error message is returned. + + + + + Finds the root of a function using a combination of Newton's and Bisection methods. + + + + + Determines bounds that contain a root of the given function by expanding outward from an initial guess. + + + + + this function used to obtain the address of a cell in a worksheet, given specified row and column numbers + + The argList contain the row and column postion and type of reference + Address of the given row and column + + + + Return the information about cell + + content, reference + Cell information + + + + Returns the current operation environment information + + Type + environment information + + + + Returns the interger value for the datatype of given text + + text + integer value + + + + Return the value of ComputeIsFormula + + arguments + + + + + Returns a horizontal table look up value. + + Contains search value, table, return index and match properties. + Matching value found in the table. + For example, =HLOOKUP("Axles",A1:C4,2,TRUE) looks for the exact + match for Axles in A1:C1 and returns the corresponding value in A2:C2. + + + + + Finds the index a specified value in a lookup_range. + + look_value, lookup_range, match_type + The relative index of the lookup_value in the lookup_range. + + Lookup_range should be a either a single row range or a single column range. + If match_type is 0, the relative index of the first exact match (ignoring case) + in the specified range is returned. If match_type is 1, the values in the range + should be in ascending order, and the index of the largest value less than or + equal to the lookup_value is returned. If match_type is -1, the values in the range + should be in descending order, and the index of the smallest value greater than or + equal to the lookup_value is returned. + + + + + Below method is used to returns the cellrange while the lookup vector is cellrange and result vector is cell(eg:=LOOKUP(2,D7:I7,A1)). + + lookup vectors value. + result vectors value. + The default value is false.True when the resultant vector range from GetResultRange is modified. + Returns the cellrange of result vector. + + + + Calculate multiple range lookup with logical operators and retruns calculated lookup range. + + + Calculated lookup range + + + + Returns a value from result table either from a one-row or one-column range or from an array + + Lookup Value, lookup range, result range + Matching value found in the table + + + + To get the result value of lookup formula. + + ResultVector cell range. + lookup value + Set to true if the resultant vector range from is modified or not. + column index. + lookup arguments list. + lookup vector list + Returns the result value of lookup formula. + + + + Returns true Matching value found in the lookup otherwise false. + + >Contains search value + The value you want to look up. + + + + + Returns a vertical table look up value. + + Contains search value, table, return index and match properties. + Matching value found in the table. + For example, =VLOOKUP("Axles",A1:C4,2,TRUE) looks for the exact + match for Axles in A1:A4 and returns the corresponding value in B1:B4. + + + + + Returns the left so many characters in the given string. + + Contains the string and the number of characters. + A left sub string.. + + + + Returns the length of the given string. + + Contains the string. + An integer length. + + + + Returns a substring of the given string. + + Contains the original string, start position of the substring, + and the number of characters in the substring. + A substring. + + + + Returns the right so many characters in the given string. + + Contains the string and the number of characters. + A right substring. + + + + Returns True if the ParseArgumentSeparator character is included in a string. + + The string to be searched. + True or False. + + + + Returns an array of strings from an argument list. + + A delimited argument list. + Array of strings from an argument list. + + + + Returns a single character string. + + List of strings to be concatenated. + A single string. + + + + Returns the reference specified by a text string. References are immediately evaluated to display their contents. + Syntax: INDIRECT(CellRefString, [IsA1Style]) + + Cell reference string. + Cell reference. + + + + Replaces the old text with new in text based on matching. + + Text to be changed. + Text to replace. + Text to be replaced with old_text + The instance to replace + + + + + In a given string, this method substitutes an occurrence of one string with another string. + + A list of 3 or 4 arguments: the original string, the search string, the + replacement string, and optionally, an integer representing the occurrence to be replaced. + + The modified string. + + + + Returns a quoted string from a date or number. + + Value to be converted to a string. + Quoted string. + + + + The TEXTJOIN function combines the text from multiple ranges and/or strings, and includes a delimiter you specify between each text value that will be combined. If the delimiter is an empty text string, this function will effectively concatenate the ranges. + + A text string, or array of strings, such as a range of cells. + A single string. + + + + The CONCAT function combines the text from multiple ranges and/or strings, but it doesn't provide the delimiter or IgnoreEmpty arguments. + + Text item to be joined. A string, or array of strings, such as a range of cells. + A single string. + + + + Returns a number. + + A date or number string. + A number in the given string. + + + + Returns the remainder after dividing one number by another. + + Two numbers in a list. + The remainder. + + + + Truncates a number to an integer. + + Value and number of digits. + Truncated value. + + + + To Peroform arithmetic operations of range. + + + + + To Peroform SumProduct default arithmetic operations. + + values of Array + Sum of the products. + + + + Returns the sum of the products of corresponding values. + + Two cell ranges. + Sum of the products. + + + + Converts a number to text using currency format. + + Number and the number of digits. + Currency format string. + + + + Rounds a number to the specified number of decimals, formats the number + in decimal format using a period and commas, and return the result as text. + + + Number, number of digits, a flag that prevents from include + commas in the returned text. + + Formatted number as string. + + + + Returns the value at the specified index from a list of values. + + A string of the form "Index, Value1, Value2,..." in which the term 'Index' denotes the index of the value to be retrieved. + The selected value. + + + + Converts text to lowercase. + + Value to convert. + Converted string. + + + + Converts text to uppercase. + + Value to convert. + Converted string. + + + + Returns the string or text referred by the given value. + + value to find the referred text - Required + Returns the referred text + + + + Returns the column index of the passed in cell reference. + + Contains zero or one argument. If no argument is passed, returns the column index of the + location of this Column function call, otherwise returns the column index of the passed in cell reference. + The column index. + + + + Returns the row index of the passed in cell reference. + + Contains zero or one argument. If no argument is passed, returns the row index of the + location of this Row function cell, otherwise returns the row index of the passed in cell reference. + The row index. + + This method doesn't return an array of row numbers as the array formula entry is not supported in engine. It is another usecase of this library function. + + + + + Returns a number converted from the provided value. + + Value to be converted. + A number in string format or an error string. + + + + Returns the error value(#N/A). Used internally. + + empty string. + error value. + + + + Returns the error value (#N/A - value not available). + + error value. + + + + Returns a number corresponding to the predefined error values(#NULL!, #VALUE!, #REF!, #NAME?, #NUM!, #N/A, "#GETTING_DATA). Returns #N/A if not or any value enclosed within double quotes. + + + + + Removes all leading and trailing white-space characters. + + Value to trim. + + The string that remains after all leading and trailing white-space characters + were removed. + + + + + Determines whether the value is a logical value. + + Value to be tested. + True if the value is a logical value, False otherwise. + + + + Determines whether the value is the #NA error value. + + Value to be tested. + True if the value is the #NA error value, False otherwise. + + + + Returns True is the string denotes an error except #N/A. + + Value to be tested. + True if the value is an error except #N/A, false otherwise. + + + + Determines whether the value is empty string. + + Value to be tested. + True if the value is empty, False otherwise. + + + + Determines whether the value is string or not. + + Value to be tested. + True if the value is a string, false otherwise. + + + + Determines whether the value is not a string. + + Value to be tested. + True if the value is not a string, false otherwise. + + + + Returns True is the string denotes an error. + + String to be tested. + True if the value is an error. + + + + Checks whether the value is a reference or not. + + value or reference + TRUE or FALSE + + + + Returns the And of all values treated as logical values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. Each item in the list is considered True if it is nonzero + and False if it is zero. + A string holding the And of all values listed in the argument. + + + + The IFS function checks whether one or more conditions are met and returns a value that corresponds to the first TRUE condition. IFS can take the place of multiple nested IF statements, and is much easier to read with multiple conditions. + + A string holding [Something is True1, Value if True1, [Something is True2, Value if True2],…[Something is True127, Value if True127] + Returns a value that corresponds to the first TRUE condition + + + + The SWITCH function evaluates an expression against a list of values and returns the result corresponding to the first matching value. If there is no match, an optional default value may be returned. + + A string holding expression, value1, result1, [default or value2, result2],…[default or value3, result3] + Returns the result corresponding to the first matching value + + + + Returns the inclusive Or of all values treated as logical values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. Each item in the list is considered True if it is nonzero + and False if it is zero. + A string holding the Or of all values listed in the argument. + + + + Flips the logical value represented by the argument. + + + The argument is + treated as a logical expression with a non-zero value considered True and a zero value considered False. + + A string holding either a single argument consisting of a + cell reference, formula, or number. + + Returns 0 if the argument evaluates to a non-zero value. Otherwise, it returns 1. + + + + Returns a range that is the offset of the reference range by rows and cols. + + reference, rows, cols, [height], [width] + A range offset. + The returned range is the range passed in through the reference variable offset + by the number of rows in the rows variable and number of columns in the cols variable. If height and + width are present in the argument list, they determine the number of rows and columns + in the returned range. Otherwise, the dimensions of the returned range match the input range. + + + + + Returns the logical value True. + + Empty string. + Logical True value string. + + + + Returns the logical value False. + + Empty string. + Logical False value string. + + + + Returns the exclusive OR of all values treated as logical values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. Each item in the list is considered True if it is nonzero + and False if it is zero. + A string holding the exclusive OR of all values listed in the argument. + + + + Returns a value you specify if a formula evaluates to #N/A + otherwise, returns the result of the formula. + + String to be tested. + Returns the computed value. + + + + Computes angle whose cosine is the argument. + + A cell reference, formula, or number. + A string holding an angle whose cosine is the argument. + + + + Returns the Arabic value of Raman numeric + + + + + + + Returns the area of the passed in cell reference range + + Contains one argument - reference + area of the passed in cell reference. + + + + Computes angle whose sine is the argument. + + A cell reference, formula, or number. + A string holding an angle whose sine is the argument. + + + + The inverse of Sinh. + + The given value. + Result of ASinh(value). + + + + Computes angle whose tangent is the argument. + + A cell reference, formula, or number. + A string holding the tangent of the argument. + + + + The ArcTangent of the x and y values. + + x_value and y_value. + Angle whose tangent is y_value/x_value. + + + + The inverse of Tanh. + + |Value| < 1. + Result of ATanh(value). + + + + Computes the smallest whole number greater than or equal to the argument. + + A cell reference, formula, or number. + A string holding the smallest whole number greater than or equal to the argument. + + + + Returns the RoundUp of the given number to the given significance + + Number, significance, mode + RoundUp number + + + + Returns the number of columns of the passed in cell reference. + + Contains one argument - reference + number of columns. + + + + The number of combinations of a given number of items. + + Number, number_items. + The number of combinations. + + + + Returns the value of ComputeCombinA + + arguments + + + + + Computes the natural logarithm of the value in the argument. + + A cell reference, formula, or number. + A string holding the natural logarithm of the value in the argument. + + + + Computes the base 10 logarithm of the value in the argument. + + A cell reference, formula, or number. + A string holding the base 10 logarithm of the value in the argument. + + + + Computes e raised to the value of the argument. + + A cell reference, formula, or number. + A string holding the e raised to the value of the argument. + + + + Returns the square root of product of given number with PI. + + Number + Sqrtpi value of given number + + + + Computes the square root of the argument. + + A cell reference, formula, or number. + A string holding the square root of the argument. + + + + Computes the absolute value of the argument. + + A cell reference, formula, or number. + A string holding the absolute value of the argument. + + + + Computes the cosine of the argument. + + A cell reference, formula, or number. + A string holding the cosine of the argument. + + + + The inverse of Cosh. + + Value >= 1. + Result of ACosh(value). + + + + Returns an evenly distributed random number >= 0 and < 1. + + Ignored. Can be empty. + + A string holding the random number. + + + + + Computes the tangent the argument. + + A cell reference, formula, or number. + A string holding the tangent of the argument. + + + + Computes the hyperbolic tangent of the argument. + + A cell reference, formula, or number. + A string holding the hyperbolic tangent of the argument. + + + + Checks if value of S mets the Criteria or Not. + + Operator + Cell + The String value to be compared + True if Value of S equals Criteria Otherwise False + + + + Checks if value of S mets the Criteria or Not. + + Operator + Cell + The double value to be compare + True if Value of S mets Criteria Otherwise returns False + + + + Sums the cells specified by some criteria. + + The criteria range, the criteria, and the sum range. + A string holding the sum. + + + + Below method used to find the row,col index when the start row or start column is -1. + + Start row of the range. + End row of the range. + Start column of the range. + End column of the range. + + + + Used to compute the value + + arguments + + + + + Returns the arccotangent of a number. + + A cell reference or number + A string containing the arccotangent of a number + + + + Returns the hyperbolic arccotangent of a number. + + A cell reference or number + A string containing the hyperbolic arccotangent of a number + + + + Returns the archyperbolic secant of an angle. + + A cell reference or a number + A string containing the archyperbolic secant of an angle + + + + Retuns the number into text for the given radix base + + + + + + + Computes the hyperbolic cosine of the argument. + + A cell reference, formula, or number. + A string holding the hyperbolic cosine of the argument. + + + + Returns the hyperbolic cosine of a number. + + A cell reference or a number + A string containing the hyperbolic cosine of a number + + + + Returns the cotangent of an angle. + + A cell reference or a number + A string containing the cotangent of an angle + + + + Returns the cosecant of an angle + + a cell reference or number + A string containing the cosecant of an angle + + + + Returns the hyperbolic cosecant of an angle. + + + A string containing the hyperbolic cosecant of an angle + + + + Returns the decimal number of the given text to the given base. + + text,base + Decimal number. + + + + Converts radians into degrees. + + Value in radians. + Degrees for the given radians. + + + + Rounds up to larger in magnitude even number. + + Number to be rounded. + Rounded even value. + + + + Factorial of a given number. + + The given value, x. + Factorial of x. + + + + Returns the Double factorial value for given number. + + number to find FactDouble + FactDouble of given number. + + + + Computes the largest whole number less than or equal to the argument. + + A cell reference, formula, or number. + A string holding the largest whole number less than or equal to the argument. + + + + Returns the Calculated Floor value for the given Input. + + + + + + Return the value of ComputeFormulaText + + arguments + + + + + Returns the largest integer that divide the given numbers without any reminders. + + number1,number2,... + Returns the GCD value of given arguments + + + + Create a shortcut for the link / path + + link,name + shortcut name + + + + Returns the integer value. + + Number to be truncated. + An integer. + + + + Determines whether the value is even or not. + + Value to be tested. + True, if the value is even, false otherwise. + + + + Determines whether the string contains a number or not. + + String to be tested. + True if the string is a number. + + + + Determines whether the value is odd or not. + + Value to be tested. + True, if the value is odd, false otherwise. + + + + returns the smallest positive integer that is a multiple of all given values. + + Number1,Number2,... + The LCM value of given aruments + + + + Computes the natural logarithm of the value in the argument. + + A cell reference, formula, or number. + A string holding the natural logarithm of the value in the argument. + + + + Returns the number of columns of the passed in cell reference. + + Contains one argument - reference + number of columns. + + + + Returns the Inverse of Matrix. + + Matrix + Inverse matrix + + + + Returns the number of columns of the passed in cell reference. + + Contains one argument - reference + number of columns. + + + + Returns the number of columns of the passed in cell reference. + + Contains one argument - reference + number of columns. + + + + Determines the number rounded to the given multiple. + + Number, Multible both are required + Mround value of given number + + + + Determines the Multinominal value of given range of numbers. + + Given numbers + Multinominal value of given range of numbers. + + + + Returns the number of columns of the passed in cell reference. + + Contains one argument - reference + number of columns. + + + + Rounds up to larger in magnitude odd number. + + Number to be rounded. + Rounded odd value. + + + + Returns the number pi. + + Ignored. Can be empty. + A string holding the number pi. + + + + Returns a specified number raised to the specified power. + + String containing two parameters separated by commas: + the first being base number, + the second being the exponent. + A string holding the value of the base number raised to the exponent. + + + + Returns the product of the arguments in the list. + + List of arguments. + Product of the arguments. + + + + Returns the integer portion of division function. + + numerator, denominator to find the quotient + returns integer value. + + + + Converts degrees into radians. + + Value in degrees. + Radians for the given degrees. + + + + Returns the arabic numeral to roman in TEXT format + + Number, Form for style of roman text. + 0 or omitted Classic. + 1 More concise. + 2 More concise. + 3 More concise. + 4 Simplified. + TRUE Classic. + FALSE Simplified. + + Retuns the Roman string of given numeric value based on the style form + + + + Rounds a number to a specified number of digits. + + Number and number of digits. + Rounded number. + + + + Rounds a number to a specified number of digits. + + Number and number of digits. + Rounded number. + + + + Rounds a number to a specified number of digits. + + Number and number of digits. + Rounded number. + + + + Returns the number of rows of the passed in cell reference. + + Contains one argument. + number of rows. + + + + Returns the secant of an angle. + + A cell reference, or number. + A string conaining the secant of an angle + + + + Returns the hyperbolic secant of an angle. + + A cell reference, or number + A string containing the hyperbolic secant of an angle. + + + + return the sheet number of the given value + + SheetName or cell or named range + sheet number + + + + return the sheet number of the given values + + SheetName or cell or named range + sheet number + + + + Returns a number indicating the sign of the argument. + + A cell reference, formula, or number. + A string holding a number representing the sign of the argument. + + + + Computes the sine of the argument. + + A cell reference, formula, or number. + A string holding the sine of the argument. + + + + Computes the hyperbolic sine of the argument. + + A cell reference, formula, or number. + A string holding the hyperbolic sine of the argument. + + + + Returns the sum of all values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the sum of all values listed in the argument. + + + + Returns the sum of all the cells in a range which is statisfy the given multible criteria + + range of cells, criteria1, average_range1,... + returns the sum value of the cells. + + + + Returns the sum of the square of all values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the sum of the squares of all values listed in the argument. + + + + Returns the sum of the differences of squares of the two ranges. + + x_range and y_range. + A string holding sum of the differences of squares. + + + + Returns the sum of the sums of squares of the two ranges. + + x_range and y_range. + A string holding sum of the sums of squares. + + + + Returns the sum of the squares of the differences between two ranges. + + x_range and y_range. + A string holding sum of the squares of the differences. + + + + Returns the vertical range of cells as a horizontal range, or vice versa + + Cell refrences + value + + + + Returns the value of computeTruncate + + arguments + + + + + Returns a random integer number between the specified two numbers. + + StartNumber, EndNumber + Random numberbetween two value + + + + Return the value of ComputeSeriessum + + arguments + + + + + Searches a range or an array, and then returns the item corresponding to the first match it finds. + If no match exists, then XLOOKUP can return the closest (approximate) match. + + + A string containing the arguments separated by commas. + The format should be: "lookup_value, lookup_array, return_array, if_not_found, match_mode, search_mode". + + lookup_value: The value to search for. + lookup_array: The array or range of cells to search within. + return_array: The array or range of cells from which to return a value. + if_not_found: The value to return if no match is found. + + match_mode: [Optional] The match type (default is 0): + + 0 for exact match (default) + -1 for exact match or next smaller item + 1 for exact match or next larger item + 2 for wildcard match + + + + search_mode: [Optional] The search mode (default is 1): + + 1 for search from first to last (default) + -1 for search from last to first + 2 for binary search ascending + -2 for binary search descending + + + + + The item corresponding to the first match it finds. If no match exists, then XLOOKUP can return the closest (approximate) match. + + + + Calculate and retrun the matched value based on match mode and search mode + + The value to search + The range or array where to search. + The range or array from which to return values. + The value to return if no match is found. If omitted, an #N/A error is returned. + The match type to perform: + The direction of search + The matched value + + + + + Returns the range of cells as an array by scanning column wise + + cell range + array of cells + + + + Convert multi criteria lookup range to single range + + multicriteria lookup range + return calculated lookup range + + + + Match the lookup value and return the index based on match mode + + the matched index + + + + Calculate and get the matchMode value from the argument + + argument + the matchMode value + + + + Calculate and get the SearchMode value from the argument + + argument + the SearchMode value + + + + Validate argument type for the possible cases for error string + + argument + >The formula's argument typ + + + + + Returns the relative position of an item in an array or range of cells. + + + A string containing the arguments separated by commas. + The format should be: "lookup_value,lookup_array,match_mode,search_mode". + + lookup_value: The value to search for. + lookup_array: The array or range of cells to search within, provided as a comma-separated string of values. + + match_mode: [Optional] The match type (default is 0): + + 0 for exact match (default) + -1 for exact match or next smallest item + 1 for exact match or next largest item + 2 for wildcard match + + + + search_mode: [Optional] The search mode (default is 1): + + 1 for search from first to last (default) + -1 for search from last to first + 2 for binary search ascending + -2 for binary search descending + + + + + The relative position of an item in an array or range of cells. + + + + + Sort the lookup array in DescendingOrder + + the array in DescendingOrder + + + + Sort the lookup array in AscendingOrder + + the array in AscendingOrder + + + + Match the lookup value and return the index based on match mode + + the matched index + + + + check and match the lookup value when its contains "?" + + TTrue when match or false + + + + Rounds a number down to the nearest integer or to the nearest multiple of significance. + + + A string containing the arguments separated by commas. + The format should be: "number, significance, mode". + + + number: The number to be rounded down. + + + significance: [optional] The multiple to which you want to round. + + + mode: [optional] The direction (toward or away from 0) to round negative numbers. + + + + A number rounded down to the nearest integer or to the nearest multiple of significance. + + + + Validate and retrun the argument as double value. + + + + + Calculate array format argument value. + + + Return calculated array format argument value for interior and direct FloorMath formula + + + + convert string values(number,sign,mode) to double value + + + + + convert string values(number,sign) to double value + + + + + Calculated FloorMath value for the given Input. + + Return round a number down to the nearest integer or to the nearest multiple of significance. + + + + Computes and returns a number that is rounded down to the nearest integer or to the nearest multiple of significance. + + + A string containing the arguments separated by commas. + The format should be: "number, significance". + + + number: The value to be rounded. + + + significance: [optional] The multiple to which the number is to be rounded. + + + + A number that is rounded down to the nearest integer or to the nearest multiple of significance. Regardless of the sign of the number, the number is rounded down. However, if the number or the significance is zero, zero is returned. + + + + Returns the Calculated FloorPrecise value for the given Input. + + + + + Returns the Calculated CeilingPrecise value for the given Input. + + + + + Calculate array format argument value. + + + Return calculated array format argument value for interior and direct FloorPrecise formula. + + + + Calculate array format argument value. + + + calculated array format argument value for interior and direct IsoCeiling formula. + + + + Calculate array format argument value. + + + calculated array format argument value for interior and direct CeilingPrecise formula. + + + + Computes and returns a number that is rounded up to the nearest integer or to the nearest multiple of significance. + + + A string containing the arguments separated by commas. + The format should be: "number, significance". + + + number: The value to be rounded. + + + significance: [optional] The multiple to which the number is to be rounded. The default value is 1. + + + + A number that is rounded up to the nearest integer or to the nearest multiple of significance. Regardless of the sign of the number, the number is rounded up. However, if the number or the significance is zero, zero is returned. This follows the ISO 8601 standard. + + + + Computes and returns a number that is rounded up to the nearest integer or to the nearest multiple of significance. + + + A string containing the arguments separated by commas. + The format should be: "number, significance". + + + number: The value to be rounded. + + + significance: [optional] The multiple to which the number is to be rounded. The default value is 1. + + + + A number that is rounded up to the nearest integer or to the nearest multiple of significance. Regardless of the sign of the number, the number is rounded up. However, if the number or the significance is zero, zero is returned. + + + + This function appends arrays vertically and in sequence to return a larger array. + + + A string containing the arguments separated by commas. + The format should be: "array1,[array2],..." + + array1, array2, ...: The arrays to append. + + + A single array that has as many columns as all of the source arrays combined and as many rows as the tallest of the source arrays. + + + + This function appends arrays horizontally and in sequence to return a larger array. + + + A string containing the arguments separated by commas. + The format should be: "array1,[array2],..." + + array1, array2, ...: The arrays to append. + + + A single array that has as many columns as all of the source arrays combined and as many rows as the tallest of the source arrays. + + + + Validate the argument for VStack and HStack formula and return array list. + + + + + Compute and return appended array as string value for VStack and HStack formula. + + + + + Compute and append array vertically and return array as string value. + + + + + Compute and append array horizontally and return array as string value. + + + + + This function computes and returns the value of the density function for a standard normal distribution. + + A string representing the numeric input for which PHI is to be calculated. + + A formatted string representing the calculated PHI value. + If the input is invalid, an error message is returned indicating the type of error. + + + + + This function converts a specified monetary amount from one currency to another using predefined Euro conversion rates. + The Euro is used as an intermediary currency for conversions between non-Euro currencies. + + + A comma-separated string containing the input arguments in the format: + "amount, sourceCurrency, targetCurrency, [fullPrecision], [triangulationPrecision]". + + + + amount: The numeric value to be converted. + This value must be a valid floating-point number. + + + + + sourceCurrency: The three-character ISO currency code for the source currency. + This must represent a valid currency included in the predefined Euro conversion table. + + + + + targetCurrency: The three-character ISO currency code for the target currency. + This must represent a valid currency included in the predefined Euro conversion table. + + + + + fullPrecision (optional): A boolean value indicating whether the result should use full precision. + If omitted, the default value is false, meaning the result will be rounded. + + + + + triangulationPrecision (optional): An integer specifying the precision for intermediate Euro calculations. + If omitted, the default value is 3. Values less than 3 are invalid. + + + + + + A string representing the converted amount in the target currency. If the input parameters are invalid, an error message is returned. + + + + + Converts a given monetary amount from one currency to another using predefined Euro conversion rates. + + + The converted monetary amount as double value. + If the conversion is invalid (e.g., unsupported currency codes), the method returns double.NaN. + + + + + Returns the sample covariance between two arrays. + Arrays should be of equal length, and contain more than one element. + + + + + + + Returns the mean of an array. + + Array of data for which we are calculating the mean. + + + + Returns the mean of an array. + + Array of data for which we are calculating the mean. For time series, the last element (index = n-1), is the most recent. + In most applications, the decay factor is between 0 and 1. Weigth on the last element in array is 1.0, the 2nd to last element d, 3rd to last d^2, ... + + + + Returns the inverse of the sum of a geometric series of length n, who's first element is 1. + For decay factor d, S = 1 + d + d^2 + ... + d^(n-1). Return 1/S. + + Decay factor Typically between -1 adn +1. + Number of elements in the geometric series, must be positive. + + + + + Calculates the natural logarithm of gamma function. + + + + + + + Returns the average deviation of all values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the average deviation of all values listed in the argument. + + + + Returns the simple average of all values (including text) listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the simple average of all values listed in the argument. + + + + Returns the average of all the cells in a range which is statisfy the given multible criteria + + range of cells, criteria1, average_range1,... + returns the average value of the cells. + + + + Below method used to find the criteria value which is combined with tokens. + + Criteria value with tokens. + Tokens + The criteria value splited from tokens. + + + + Below method used to find whether the criteria is matched with the Tokens "=",">",">=" or not. + + CellRange + Tokens("=",">",">=") + The criteria used to determine which cells to add. + true criteria match or false. + + + + Returns the chi-squared distribution. + + x, degrees of freedom. + The chi-squared distribution. + + + + Returns the growth estimate using the exponential curve y = b * m^x that best fits the given points. Only the first two Excel parameters are used. + + Y_range, x_range. + returns estimated value. + + + + Returns the m and b value used in exponential curve y = b * m^x. + + The set of y-values required in y = b*m^x + The set of x-values in y = b*m^x + output of b + output of m + returns calculated b value. + + + + Returns the natural logarithm of the gamma function. + + The value to be evaluated. + The natural logarithm of the gamma function. + + + + Calculates the statistics for a straight line that explains the relationship between the independent variable and one or more dependent variables + + Parsed range. + an array describing the line. The function uses the least squares method to find the best fit for your data. + + + + Returns the inverse of the chi-squared distribution. + + x, degrees of freedom. + The inverse of the chi-squared distribution. + + + + Returns the Chi Test for independence. + + Actual_range, expected_range. + Result of Chi Test: y-intercept. + + + + Returns the normal distribution. + + x, mean, standarddev, cumulative. + The normal distribution. + + Cumulative should be either + True if you want to return the value of the distribution function or False + if you want to return the value of the density function. The distribution value + is computed interactively using Trapezoidal Rule to six to seven significant digits + or 20 iteration maximum. + + + + + Returns the standard normal cumulative distribution function. The distribution has a mean of 0 (zero) and a standard deviation of one. + Syntax: NORMSDIST(z) + + Z is the value for which you want the distribution. + Standard normal cumulative distribution. + + + + Returns the inverse of normal distribution. + + P, mean, standard deviation. + Returns x such that normal distribution at x is p. + + P should be between 0 and 1. + + + + + Enabled only when ExcelLikeComputations property is set to true. + + + Computes the inverse normal cumulative distribution for the given probability. + + probability + a double value. + + + + Returns the inverse of the standard normal cumulative distribution. The distribution has a mean of zero and a standard deviation of one. + Syntax: NORMSINV(p) + + p is a probability corresponding to the normal distribution. + Inverse of standard normal cumulative distribution. + + p should be between 0 and 1. + + + + + Returns a confidence interval radius. + + Alpha, standard deviation, size. + Returns x such that normal distribution at x is p. + + P should be between 0 and 1. + + + + + Returns the correlation coefficient of the two sets of points. + + range1, range2. + Correlation coefficient. + + + + Returns the count of all values (including text) listed in the argument to + evaluate to a number. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the count of all numerical values listed in the argument. + + + + Returns the count of all values (including text) listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the count of all values listed in the argument. + + + + Returns the count of blank cells listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the count of blank cells listed in the argument. + + + + Counts the cells specified by some criteria. + + The criteria range, the criteria. + Number of cells meeting the criteria. + + + + Calculates the CountIF and CountIFS formula + + The criteria range, the criteria + If true, calculate CountIF formula. Else calculate CountIFS formula. + Number of cells meeting the criteria. + + + + The COUNTIFS function applies criteria to cells across multiple ranges and counts the number of times all criteria are met. + + The criteria range, the criteria. + Number of cells meeting the criteria + + + + Returns the covariance between the two sets of points. + + range1, range2. + The covariance. + + + + Returns the smallest value for which the cumulative binomial distribution is greater than or equal to a criterion value. + + Number of trials, probability, alpha. + Returns the critical value. + + + + Returns the exponential distribution. + + x, lambda, cumulative. + The exponential distribution. + + Cumulative should be either + True if you want to return the value of the distribution function or False + if you want to return the value of the density function. + + + + + Returns the F (Fisher) probability distribution. + + x, degreesfreedom1, degreesfreedom2. + Returns the F probability distribution. + + + + Returns the inverse of F distribution. + + p, degreesfreedom1, degreesfreedom2. + Returns x such that F distribution at x is p. + + P should be between 0 and 1. + + + + + Returns the Fisher transformation of the input variable. + + Input variable x. + Fisher transformation of x. + + X should be between -1 and 1. + + + + + Returns the inverse of Fisher transformation. + + Input variable y. + The value x such that the Fisher transformation y is x. + + + + Returns a forecasted value based on two sets of points using least square fit regression. + + x, rangex, rangey. + Forecasted value. + + + + Returns the kurtosis of the passed in values. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + The kurtosis of the data. + + + + Returns the Kth largest value in the range. + + range, k. + Kth largest value. + + + + Returns the lognormal distribution. + + x, mean, standarddev. + The lognormal distribution. + + + + Returns the inverse of the lognormal distribution. + + p, mean, standarddev. + Returns the value x where the lognormal distribution of x is p. + + + + Returns the maximum value of all values listed in the argument including logical values. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the maximum value of all values listed in the argument. + True is treated as 1; False is treated as 0. + + + + + Returns the median value in the range. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + Median value. + + + + Returns the minimum value of all values listed in the argument including logical values. + + A string holding a list (separated by commas) of: + cell references, + formulas, or numbers. + A string holding the minimum value of all values listed in the argument. + True is treated as 1; False is treated as 0. + + + + + Returns the most frequent value in the range. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + The most frequent value. + + + + Returns the negative binomial distribution. + + Number of failures, success threshold, probability, cumulative. + The negative binomial distribution. + + + + Returns the Pearson product moment correlation coefficient. + + Range1, range2. + Pearson product. + + + + Returns the percentile position in the range. + + Range, k. + Percentile position. + K is a value between 0 and 1. + + + + Returns the percentile position in the ranges. + This method used only for contional formatting to calculate the percentile value. + When the argument contains more no of cell reference. + + Ranges, k. + Percentile position. + K is a value between 0 and 1. + + + + Returns the percentage rank in the range. + + Range, x, significant digits. + Percentile position. + Significant digits are optional, defaulting to 3. + + + + The number of permutations of n items taken k at the time. + + n, k + The number of combinations. + + + + Returns the Poisson distribution. + + x, mean, cumulative + Returns the exponential distribution. + + Cumulative should be either + True if you want to return the value of the distribution function or False + if you want to return the value of the density function. + + + + + Returns the probability that a value in the given range occurs. + + xrange1, prange2, lowerbound, upperbound. + The probability. + + + + Returns the quartile position in the range. + + Range, q. + Percentile position. + Q is 0, 1, 2, 3, 4. + + + + Returns the rank of x in the range. + + X, range, order. + Rank of x. + + + + Returns the square of the Pearson product moment correlation coefficient. + + Range1, range2. + Square of the Pearson product. + + + + Returns the skewness of a distribution. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + Skewness of a distribution. + + + + Returns the slope of the least square fit line through the given points. + + Y_range, x_range. + Y-intercept for the given points. + + + + Returns the kth smallest value in the range. + + Range, k. + Kth smallest value. + + + + Returns a normalized value. + + X, mean, stddev. + Normalized value. + + + + Returns the sample standard deviation. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + The sample standard deviation. + + + + Returns the sample standard deviation. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + The sample standard deviation. + Treats True as 1; False as 0. + + + + + Returns the sample standard deviation. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + The sample standard deviation. + Treats True as 1; False as 0. + + + + + Returns the population standard deviation. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + The population standard deviation. + + + + Returns the population standard deviation. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + The population standard deviation. + Treats True as 1; False as 0. + + + + + Returns the standard error of the least square fit line through the given points. + + Y_range, x_range. + Standard error. + + + + Returns the mean of the range after removing points on either extreme. + + Range, percent. + Kth smallest value. + + + + Returns sample variance of the listed values. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + The sample variance. + + + + Returns sample variance of the listed values. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + The sample variance. + True is treated as 1; False is treated as 0. + + + + + Returns population variance of the listed values. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + The population variance. + + + + Returns population variance of the listed values. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + The population variance. + True is treated as 1; False is treated as 0. + + + + + Returns the Weibull distribution. + + X, alpha, beta, cumulative. + The Weibull distribution. + + + + Returns the one-tailed probability value of a Z test. + + Range, mu, sigma. + Kth smallest value. + + + + Calculate muti range and return cell value + + contains multi cell range(eg:A1:A100) + + + + Returns the maximum value of all values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the maximum value of all values listed in the argument. + + + + The MINIFS function returns the minimum value among cells specified by a given set of conditions or criteria. + + range of cells, criteria1, average_range1,... + returns the Minimum value of the cells. + + + + The MAXIFS function returns the maximum value among cells specified by a given set of conditions or criteria. + + range of cells, criteria1, average_range1,... + returns the Maximum value of the cells. + + + + Returns the subtotal of input range(s). + + A list of cell references(seperated by commas) + Subtotal of range(s) + + + + Returns the minimum value of all values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the minimum value of all values listed in the argument. + + + + Returns the simple average of all values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + A string holding the simple average of all values listed in the argument. + + + + Returns the harmonic mean of all values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + The harmonic mean all values listed in the argument. + + + + Returns the hypergeometric distribution. + + Number of sample successes, number of sample, number of population successes, number of population. + Returns the gamma distribution. + + + + Returns the hypergeometric distribution. + + Number of sample successes, number of sample, number of population successes, number of population. + Returns the gamma distribution. + + + + Conditionally computes one of two alternatives depending upon a logical expression. + + + The first argument is + treated as a logical expression with a non-zero value considered True and a zero value considered False. + The value of only one of the alternatives is computed depending upon the logical expression. + + A string holding a list of three arguments. + + Returns a string holding the second argument if the first argument is True (non-zero). Otherwise, it returns a string holding the third argument. + + + + Returns a value you specify if a formula evaluates to an error + otherwise, returns the result of the formula. + + String to be tested. + Retuns the error string + + + + Returns the y-intercept of the least square fit line through the given points. + + y_range, x_range. + y-intercept for the given points. + + + + Returns the binomial distribution. + + Number of successes, number of trials, probability, cumulative. + The binomial distribution. + + + + Returns the skewness of a distribution based on a population a characterization of the degree of asymmetry of a distribution around its mean. + + numbers or names, arrays, or reference that contain numbers + Skewness of a distribution. + + + + Returns population covariance, the average of the products of deviations for each data point pair in two data sets. + + range1, range2. + The covarianceP + + + + Returns the sample covariance, the average of the products of deviations for each data point pair in two data sets. + + range1, range2. + The covariances + + + + Returns the percentile position in the range. + + Range, k. + Percentile position. + K is a value between 0 and 1. + + + + Returns the percentage rank Exc in the range. + + Range, x, significant digits. + Percentile position. + Significant digits are optional, defaulting to 3. + + + + Returns the percentile position in the range. + + Range, k. + Percentile position. + K is a value between 0 and 1. + + + + Returns the percentage rank Inc in the range. + + Range, x, significant digits. + Percentile position. + Significant digits are optional, defaulting to 3. + + + + Returns the sample standard deviation. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + The sample standard deviation. + Treats True as 1; False as 0. + + + + + Returns sample variance of the listed values. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + The sample variance. + + + + Calculates variance based on the entire population (ignores logical values and text in the population). + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + The sample variance. + + + + Returns the number of permutations for a given number of objects (with repetitions) that can be selected from the total objects. + + n, k + The number of combinations. + + + + Returns the normal distribution for the specified mean and standard deviation. + + x, mean, standarddev, cumulative. + The normal distribution. + + Cumulative should be either + True if you want to return the value of the distribution function or False + if you want to return the value of the density function. + + + + + Returns the inverse of the normal cumulative distribution for the specified mean and standard deviation. + + P, mean, standard deviation. + Returns x such that normal distribution at x is p. + + P should be between 0 and 1. + + + + + Returns the standard normal cumulative distribution function. The distribution has a mean of 0 (zero) and a standard deviation of one. + Syntax: NORMSDIST(z) + + Z is the value for which you want the distribution. + Standard normal cumulative distribution. + + + + Returns the PDF of the standard normal distribution. + + Value at which the distribution is evaluated. + + + + Returns the CDF of the standard normal distribution. + + Value at which the distribution is evaluated. + + + + Returns the PDF of the standard normal distribution. + + Value at which the distribution is evaluated. + + + + Returns the CDF of the standard normal distribution. + + Value at which the distribution is evaluated. + + + + Returns the inverse of the CDF of the standard normal distribution. + + Cumulative probability of the distribution. p is between 0 and 1. + + + + Returns the inverse of the standard normal cumulative distribution. The distribution has a mean of zero and a standard deviation of one. + Syntax: NORMSINV(p) + + p is a probability corresponding to the normal distribution. + Inverse of standard normal cumulative distribution. + + p should be between 0 and 1. + + + + + Calculates the Weibull Probability Density Function or the Weibull Cumulative Distribution Function for a supplied set of parameters. + + x, alpha, beta, cumulative. + Returns the calculated weibull distribution. + + cumulative = A logical argument which denotes the type of distribution to be used + TRUE = Weibull Cumulative Distribution Function + FALSE = Weibull Probability Density Function + + + + + Returns the exponential distribution. + + x, lambda, cumulative. + The exponential distribution. + + Cumulative should be either + True if you want to return the value of the distribution function or False + if you want to return the value of the density function. + + + + + Used to calculate the inverse of gamma cummulative distribution + + + + + + + + + Used to calculate the inverse gamma distribution at inital stage. + + + + + + + + + + + + + + Used to calculate the inverse gamma distribution at middle stage. + + + + + + + + + + + + + + Used to calculate the inverse gamma distribution at final stage. + + + + + + + + + + + + + + Used to calculate the upper incomplete integral of inverse gamma function. + + + + + + + + Used to calculate the lower incomplete integral of gamma function. + + + + + + + + Used to calculate the upper incomplete integral of gamma function. + + + + + + + + Used to calculate the CDF(Cummulative Distribution Function) of Gamma distribution. + + Alpha + Beta + + + + + + Used to calculate the PDF(Probability Distribution Function) of Gamma distribution. + + Alpha + Beta + + + + + + Returns the gamma distribution. + + X, alpha, beta, cumulative. + The gamma distribution. + + X, alpha, and beta should be positive real numbers. Cumulative should be either + True if you want to return the value of the distribution function or False + if you want to return the value of the density function. The distribution value + is computed interactively using Trapezoidal Rule to six to seven significant digits + or 20 iteration maximum. + + + + + Returns the inverse of gamma distribution. + + p, alpha, beta + Returns x such that gamma distribution at x is p. + + P, alpha, and beta should be positive real numbers, with p between 0 and 1. + + + + + Returns the geometric mean of all values listed in the argument. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + The geometric mean all values listed in the argument. + + + + Returns the gamma distribution. + + X, alpha, beta, cumulative. + The gamma distribution. + + X, alpha, and beta should be positive real numbers. Cumulative should be either + True if you want to return the value of the distribution function or False + if you want to return the value of the density function. The distribution value + is computed interactively using Trapezoidal Rule to six to seven significant digits + or 20 iteration maximum. + + + + + Returns the inverse of gamma distribution. + + p, alpha, beta + Returns x such that gamma distribution at x is p. + + P, alpha, and beta should be positive real numbers, with p between 0 and 1. + + + + + Returns the natural logarithm of the gamma function. + + The value to be evaluated. + The natural logarithm of the gamma function. + + + + Returns the Student's t-distribution. + + x, degreesfreedom1. + Returns the Student's t-distribution. + + + + Returns the inverse of the CDF of the Student's t distribution. + For k = 3, and 5+ the solution is an approximation. + + Cumulative probability of the distribution. p is between 0 and 1. + Degrees of freedom. + + + + Returns the PDF of Student's t distribution. + + Value at which the distribution is evaluated. + Degrees of freedom. + + + + Returns the CDF of Student's t distribution. + + Value at which the distribution is evaluated. + Degrees of freedom. + + + + Returns the inverse of F distribution. + + p, degreesfreedom1, degreesfreedom2. + Returns x such that F distribution at x is p. + + P should be between 0 and 1. + + + + + Returns the smallest value for which the cumulative binomial distribution is greater than or equal to a criterion value. + + Number of trials, probability, alpha. + Returns the critical value. + + + + Returns the inverse of the lognormal distribution. + + p, mean, standarddev. + Returns the value x where the lognormal distribution of x is p. + + + + Returns the lognormal distribution. + + x, mean, standarddev. + The lognormal distribution. + + + + Returns a confidence interval radius. + + Alpha, standard deviation, size. + Returns x such that normal distribution at x is p. + + P should be between 0 and 1. + + + + + Returns the chi-squared distribution. + + x, degrees of freedom. + The chi-squared distribution. + + + + Returns the F probability distribution. + + x, degreesfreedom1, degreesfreedom2. + Returns the F probability distribution. + + + + Returns the PDF of the F distribution. + + Value at which the distribution is evaluated. + Degrees of freedom for numerator chi-sqared distribution. k1 > 0. + Degrees of freedom for denominator chi-sqared distribution. k2 > 0. + + + + Returns the CDF of the F distribution. + + Value at which the distribution is evaluated. + Degrees of freedom for numerator chi-sqared distribution. + Degrees of freedom for denominator chi-sqared distribution. + + + + Euler integral. + + + + + Integral from 0 to infinity of e^(-t) * t^(z-1) dt + + If z > 143 the return value will exceed the double.MaxValue. The function will throw an exception. + + + + To get the CDF of the beta distribution. + + + + + + + + Euler integral. + + + + + Returns the F (Fisher) probability distribution. + + x, degreesfreedom1, degreesfreedom2. + Returns the F probability distribution. + + + + Returns the chi-squared distribution. + + x, degrees of freedom. + The chi-squared distribution. + + + + Returns the inverse of the chi-squared distribution. + + x, degrees of freedom. + The inverse of the chi-squared distribution. + + + + Returns the Chi Test for independence. + + Actual_range, expected_range. + Result of Chi Test: y-intercept. + + + + Returns the inverse of the chi-squared distribution. + + x, degrees of freedom. + The inverse of the chi-squared distribution. + + + + Returns the binomial distribution. + + Number of successes, number of trials, probability, cumulative. + The binomial distribution. + + + + Returns the one-tailed probability value of a Z test. + + Range, mu, sigma. + Kth smallest value. + + + + Returns the rank of x in the range. + + X, range, order. + Rank of x. + + + + Returns the rank of x in the range. + + X, range, order. + Rank of x. + + + + The Irwin-Hall distribution results from the sum on n independent standard uniform variables + + The value at which to evaluate the distribution. + + + + The Irwin-Hall distribution results from the sum on n independent standard uniform variables + + The value at which to evaluate the distribution. + The number of standard uniform variables. + + + + Returns the number of possible combinations of k objects from a set of n object. The order of the chosen objects does not matter. + + Number of objects + Number of objects chosen + + + + Returns n! + 0! = 1,otherwise n! = n * (n-1) * (n-2) * ... * 2 * 1, + + + + + Returns the PDF of the uniform distribution. + + Number of successes, number of trials, probability, cumulative. + The binomial distribution. + + + + Returns the PDF of the uniform distribution. + + Value at which the distribution is evaluated. + Minimum value of the distribution. + Maximum value of the distribution. + + + + Returns the quartile position in the range. + + Range, q. + Percentile position. + Q is 0, 1, 2, 3, 4. + + + + Returns the quartile position in the range. + + Range, q. + Percentile position. + Q is 0, 1, 2, 3, 4. + + + + Returns the negative binomial distribution. + + Number of failures, success threshold, probability, cumulative. + The negative binomial distribution. + + + + Returns the Poisson distribution. + + x, mean, cumulative + Returns the exponential distribution. + + Cumulative should be either + True if you want to return the value of the distribution function or False + if you want to return the value of the density function. + + + + + Compares the given two values + + Two Numbers to be compared. + Returns the result of the comparision in the form of 0 or 1 + + + + Compares the given two values + + Two Numbers to be compared. + Returns the result of the comparision in the form of 0 or 1 + + + + Returns the sum of the squares of the mean deviations. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + Sum of the squares of the mean deviation. + + + + Returns the average of all the cells in a range which is statisfy the given single criteria + + range of cells, criteria, average_range + returns the average value of the cells. + + + + Return the value of ComputeConfidenceT + + arguments + + + + + Returns the inverse of F distribution. + + p, degreesfreedom1, degreesfreedom2. + Returns x such that F distribution at x is p. + + P should be between 0 and 1. + This method is deprecated. Please use the instead. + + + + + Returns the inverse of the CDF of the F distribution. + For k = 3, and 5+ the solution is an approximation. + + Cumulative probability of the distribution. p is between 0 and 1. + Degrees of freedom for numerator chi-sqared distribution. + Degrees of freedom for denominator chi-sqared distribution. + + + + Returns the inverse of the CDF of the normal distribution. + + Cumulative probability of the distribution. 0 <= p >= 1. + Mean of the distribution. + Standard deviation of the distribution. + + + + Returns a vertical array of the most frequently occurring, or repetitive values in an array or range of data. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + The most frequent value. + + + + Returns the most frequent value in the range. + + A string holding a list (separated by commas) of + cell references, + formulas, or numbers. + + The most frequent value. + + + + Returns the Student's t-distribution. + + x, degreesfreedom1. + Returns the Student's t-distribution. + + + + Returns the beta distribution. + + x, degreesfreedom1, degreesfreedom2. + Returns the beta distribution. + + + + Returns the Beta cumulative density function. + + Value of the random variable for which the CDF is beign evaluated. x is between 0 and 1. + First shape parameter. + Second shape parameter. + + + + + Returns the Beta probability density function. + + Value of the random variable for which the PDF is beign evaluated. x is between 0 and 1. + Number of trials. + Number of times the event occurs in n trials. + + + + + Calculates the standard normal cumulative distribution function (Gauss) for a given z-value. + This function returns the probability that a value from a standard normal distribution (with a mean of 0 and a standard deviation of 1) is less than or equal to the given z-value. + + + A string containing the arguments separated by commas. The format should be: + "z" + + z: The z-value for which you want to compute the cumulative distribution. + + + + The probability that a value from a standard normal distribution is less than or equal to the given z-value. + + + The Gauss function is used in statistics to determine the likelihood of a value falling within a specific range of a normal distribution. + This can be particularly useful in hypothesis testing or probability estimation scenarios. + + + + + Computes the gamma function for the specified input. + + A string representing the input number for which the gamma function will be calculated. + A string representing the result of the gamma function calculation. + + The gamma function is an extension of the factorial function to real and complex numbers. + + + + + Calculate and return the gamma function value. + + + + + Computes the sample variance for a set of numbers. + + + A string containing a comma-separated list of numbers for which the sample variance will be calculated. + + + A string representing the sample variance of the provided numbers. + + + The sample variance is a measure of the dispersion of data points in a sample, and is calculated by taking the average of the squared deviations from the mean. + + + + + This function calculates how often values occur within a range of values, and then returns a vertical array of numbers. + + + A string containing two arguments separated by a comma. the format should be: data_array, bins_array. + + data_array: The range or array of data values you want to count. + bins_array: The range or array of intervals to group the data values into. + + + + A formatted string with the frequency counts separated by semicolons, or an error message if the input is invalid. + + + + + Calculates the frequency counts of numeric and date values from the provided source and bin arrays. + Text and blank values are ignored during processing. + + An array of strings representing the source and bin data ranges. + A string representing the frequency counts separated by semicolons. + + + + This function computes the probability of a specific outcome or a range of outcomes in a binomial distribution. + + + A comma-separated string containing the input arguments in the format: + "trials, probability_s, number_s, [number_s2]". + + + + trials: The number of independent trials. + This value must be a non-negative integer. (e.g., 0, 1, 2, ...). + + + + + probability_s: The probability of success for each trial, represented as a decimal value. + This value must be a number between 0 and 1 (inclusive). + + + + + number_s: The specific number of successes for which to calculate the probability. + This must be an integer between 0 and trials. + + + + + number_s2 (optional): The upper limit for a range of successes. + If provided, the function calculates the probability for successes between number_s and number_s2 (inclusive). + This value must be an integer greater than or equal to number_s and less than or equal to trials. + + + + + + A string representing the calculated probability for the specified number of successes or success range in the binomial distribution. + If the input parameters are invalid, an error message is returned. + + + + + This function calculates the cumulative Beta probability density function, which evaluates proportions or probabilities over a specified range. + + + A comma-separated string containing the input arguments in the format: "x, alpha, beta, [A], [B]". + + + x: The value at which to evaluate the Beta distribution. Must lie within the interval [A, B]. If A and B are omitted, the default range is [0, 1]. + + + alpha: A positive shape parameter of the Beta distribution, determining its skewness. + + + beta: A positive shape parameter of the Beta distribution, determining its skewness. + + + A: (Optional) The lower bound of the interval. Defaults to 0 if omitted. + + + B: (Optional) The upper bound of the interval. Defaults to 1 if omitted. + + + + + A string representing the calculated cumulative Beta probability density function at the specified value x. Returns an error message if the input arguments are invalid or if x is outside the interval [A, B]. + + + + + This function calculates and returns the t-value corresponding to the given two-tailed probability for the Student's t-distribution. It is commonly used to find critical t-values in hypothesis testing. + + + A comma-separated string containing the input arguments in the format: "Probability, Deg_freedom". + + Probability: The cumulative probability for both tails of the distribution. This value must be a decimal between 0 and 1 (exclusive). + Deg_freedom: The degrees of freedom, typically the sample size minus 1. + This must be a positive integer. + + + + A string representing the t-value corresponding to the specified two-tailed probability and degrees of freedom. + Returns an error message if the input arguments are invalid. + + + + + + Retrieves two arrays of string values parsed from the input argument string. + Validates the inputs and checks for errors before computation. + + The first array of strings parsed from the input arguments. + The second array of strings parsed from the input arguments. + The input argument string containing comma-separated values for two arrays. + A string indicating validation error if any, or an empty string if successful. + Thrown if the number of arguments is incorrect and exceptions are rethrown. + + + + Calculates the F-test p-value based on two arrays of double values representing two data sets. + Assumes that input validation has already been performed by GetValuesOfFTest. + + The first array of doubles representing the first data set. + The second array of doubles representing the second data set. + The p-value of the F-test for the two data sets. + + + + + This function computes and returns the critical t-value for a two-tailed Student's t-distribution based on a specified probability and degrees of freedom. + + + A comma-separated string containing the input arguments in the format: probability, deg_freedom. + + Probability: The cumulative probability for the two-tailed Student's t-distribution. This value must be between 0 and 1 (exclusive of 0 and 1). + Deg_freedom: The number of degrees of freedom that defines the distribution.It must be a positive integer. + + + A string representing the t-value corresponding to the given two-tailed probability and degrees of freedom. + If the input is invalid, an error message or exception may be returned. + + + + + This function computes the critical value (inverse) of the F-distribution for a specified cumulative probability and degrees of freedom. + It is typically used in hypothesis testing or analysis of variance (ANOVA). + + + A comma-separated string containing the input arguments in the format: "p, degreesFreedom1, degreesFreedom2". + + + + p: The cumulative probability for which the F value is to be calculated. This value must be a number between 0 and 1 (exclusive of 0 and 1). + + + + + degreesFreedom1: The degrees of freedom for the numerator. This must be a positive integer. + + + + + degreesFreedom2: The degrees of freedom for the denominator.This must be a positive integer. + + + + + + A string representing the critical F value such that the cumulative probability of the F-distribution equals p. + If the input parameters are invalid, an error message is returned. + + + + + Calculates the inverse of the F-distribution for the given probability and degrees of freedom. + Uses a binary search approach to find the value corresponding to the specified cumulative probability. + + The cumulative probability for which the F value is to be calculated. Must be between 0 and 1. + The degrees of freedom for the numerator. + The degrees of freedom for the denominator. + The F value corresponding to the given cumulative probability. + + + + Calculates the cumulative distribution function (CDF) of the F-distribution. + This computes the probability that a random variable from the F-distribution is less than or equal to a given value. + + The F value for which the cumulative probability is calculated. + The degrees of freedom for the numerator. + The degrees of freedom for the denominator. + The cumulative probability corresponding to the given F value. + + + + This function computes a linear trend line based on a given set of dependent y-values and, optionally, independent x-values, and returns predicted values along the trend line. + This function can also calculate predictions for new X values if provided. + + + A comma-separated string containing the input arguments in the format: "knownY, [knownX], [newX], [const]". + + + knownY: A set of dependent y-values for which a trend line will be calculated.These values must be provided as a comma-separated string.. + + + knownX [optional]: A set of independent x-values corresponding to knownY. These values must be provided as a comma-separated string.If omitted, x-values are assumed to be a sequence starting from 1. + + + newX [optional]: A set of new x-values for which corresponding y-values are to be predicted. These values must be provided as a comma-separated string. If omitted, predictions are made for the given knownX. + + + const [optional]: A boolean value indicating whether the regression line should include a y-intercept.If true (default), the intercept is included. If false, the intercept is forced to be 0. + + + + A comma-separated string of predicted y-values along the trend line. If an error occurs, such as invalid input or mismatched data sets, an error message is returned.. + + + + Calculate and retrun the y-values along that line for the array of new_x's. + + + + + Get the argument values for Trend function and return error string for invalid arguments. + + + + + Adds an intercept column to a matrix, where the intercept column is filled with ones. + + + The input matrix to which the intercept column will be added. A 2D array with dimensions [rows, columns]. + + + A new 2D array with the same number of rows as the input matrix and one additional column. + The first column of the result is filled with ones (intercept column), followed by the original matrix columns. + + + + + Computes the transpose of a given matrix. + + + The input matrix to be transposed. A 2D array where elements are rearranged + such that rows become columns and columns become rows. + + + A 2D array representing the transposed matrix. The resulting matrix will have + dimensions [columns of the input matrix, rows of the input matrix]. + + + + + + Computes the inverse of a square matrix using the Gaussian elimination method. + + + The input matrix to be inverted. It must be a square matrix (same number of rows and columns). + + + a 2D array representing the inverse of the input matrix. If the matrix is singular or non-invertible, + an exception may be thrown due to division by zero or numerical instability. + + + + + Converts a single-column matrix into a one-dimensional vector (array). + + + The input matrix, which must have exactly one column. + + + a one-dimensional array containing the elements of the input matrix's single column. + + + + + Generates an identity matrix of the specified size. + + The size of the identity matrix (number of rows and columns). + + a square 2D array representing the identity matrix, where all diagonal elements are 1, + and all off-diagonal elements are 0. + + + + + Converts a one-dimensional vector (array) into a column matrix. + + The input vector to be converted. + + a 2D array representing the column matrix where each element of the + input vector becomes a row in the single-column matrix. + + + + + Calculate and return double values for xValues,yValues and newXValues. + + + + + + Calculate and return the Student's t-Test probability value. + + + + + Calculates the variance of a dataset. + + A list of double values representing the dataset. + The mean of the dataset. + The variance of the dataset. + + + + Computes the cumulative distribution function (CDF) for Student's t-distribution. + + The t-statistic for which to compute the CDF. + The degrees of freedom associated with the t-distribution. + + A double value representing the cumulative probability associated with the given t-statistic + and degrees of freedom. + s + + + + This function calculates and returns the probability (percentage points) for the Student's t-distribution, given a numeric t-value (x), degrees of freedom, and number of tails. + This function is typically used in hypothesis testing to determine the significance of results. + + + A string containing three arguments separated by commas, in the format: x, deg_freedom, tails. + + X: A numeric value representing the t-statistic (calculated from a statistical test). + Deg_freedom: An integer representing the degrees of freedom, typically calculated as the sample size minus 1. + Tails: Specifies whether to calculate the one-tailed or two-tailed distribution. + Use Tails = 1 for a one-tailed test and Tails = 2 for a two-tailed test. + + + + A string representing the probability (as percentage points) associated with the given inputs:x (t-value), deg_freedom, and the specified number of tails. + This value helps in determining the significance level during hypothesis testing. + + + + + This function computes and returns the two-tailed probability for the Student's t-distribution. + This function calculates the probability of observing a t-value as extreme as the given t-value (in either tail),for a specified degrees of freedom. + + + A string containing two arguments separated by commas, in the format: X, deg_freedom. + + X: The numeric t-value at which to evaluate the distribution. This represents the test statistic. + Deg_freedom: An integer representing the degrees of freedom, usually calculated as the sample size minus 1. + + + + A string representing the two-tailed probability associated with the specified t-value and degrees of freedom. + The result indicates the likelihood of observing a t-value as extreme as X, in both tails of the distribution. + The two-tailed t-distribution is commonly used in hypothesis testing where the alternative hypothesis tests for a difference in either direction (e.g., not equal to a specified value). + Input values should be in the correct format and range to avoid calculation errors. + + + Input: "2.5, 10" + Output: "0.0254" (depending on implementation and precision, result represents a probability). + + + + + This function computes and returns the right-tailed probability for the Student's t-distribution. + This function calculates the probability of observing a t-statistic greater than the given t-value (X), for a specified degrees of freedom. + + + A string containing two arguments separated by commas, in the format: X, deg_freedom. + + X: The numeric t-value at which to evaluate the distribution.This represents the test statistic. + Deg_freedom: An integer representing the degrees of freedom, usually calculated as the sample size minus 1. + + + + A string representing the right-tailed probability (as a percentage) associated with the specified t-value and degrees of freedom. + This value indicates the likelihood of observing a t-value greater than X.The right-tailed t-distribution is commonly used in hypothesis testing for one-sided tests where the alternative hypothesis specifies a direction (e.g., greater than a given value). + Input values should adhere to the expected format and range for accurate results. + Input: "2.5, 10" + Output: "0.0127" (depending on the implementation and precision; result represents a probability). + + + + + This method compute the actual T-distribution probability value by using numeric value and the number of degrees of freedom. + + + + + This method computes the incomplete beta function, which is part of the distribution's calculation, using series and logarithmic expressions. + + + + + This method computes a series used to approximate the incomplete beta function for values of a and b. + + + + + This function computes and returns the fraction expansion of the incomplete beta function + + + + + This function predicts a future value along a linear trend based on existing data using linear regression. + Calculates the forecasted value for a specified independent variable, x,based on the relationship between the provided dependent (known_y's) and independent (known_x's) data sets. + + + A comma-separated string containing three arguments in the format: x, known_y's, known_x's. + + x: The independent variable (data point) for which the prediction is to be made. + known_y's: A space-separated string representing an array or range of dependent values (the values to predict). + known_x's: A space-separated string representing an array or range of independent values corresponding to known_y's. + + + + A string representing the predicted value for the specified x, or an error message if the input is invalid or the calculation cannot be performed. + + + + + Return the value of TranslateText + + value + language + + + This method is deprecated. + + + + + Return the numeric code for first char of text + + text + numeric code + + + + Finds the first occurrence of one string in another string. + + Conatins two or three arguments. The first argument is the string + to find. The second string is the string that is being searched. The third argument + is the start location in the second string for the search. + The location of the found string. + + + + Returns the left so many characters in the given string. + + Contains the string and the number of characters. + A left sub string.. + + + + Used to compute the JIS function + + arguments + + + + + Returns the length of the given string. + + Contains the string. + An integer length. + + + + Returns a substring of the given string. + + Contains the original string, start position of the substring, + and the number of characters in the substring. + A substring. + + + + Returns the right so many characters in the given string. + + Contains the string and the number of characters. + A right substring. + + + + Convert the text to number + + text, + decimal separator,group separator + + + + Returns the text like first letter with upper letter in each word + + Text + proper text + + + + Replace the part of the text with a new text from orginal text + + Text,Start index, Number of char to replace, new text + replaced string + + + + Returns the number of repeated text + + text, repeated count + text + + + + Returns the number of the starting position of the first string from the second string. + + first strring, second string and starting position + index of the string + + + + Returns the Unicode char for the respective numeric value + + Number + unicode char + + + + Returns the corresponding number code for the first char of string. + + text + numeric code + + + + Returns the character whose number code is specified in the argument. + + The number used to retrieve the character. + The character string. + + + + Retuns the text removing the first 32 nonprintable characters(ranging from 0 to 31) in 7-bit ASCII code. + + Text or range holding text including nonprintable characters + Text without nonprintable characters(first 32) + + + + Returns whether or not the two arguments passed in are exactly the same. + + A string holding two arguments (separated by commas) of + cell references, strings, + formulas, or numbers. + True if the arguments are exactly the same ignoring formats, false other wise. + + + + Finds the first occurrence of one string in another string. + + Conatins two or three arguments. The first argument is the string + to find. The second string is the string that is being searched. The third argument + is the start location in the second string for the search. + The location of the found string. + The location count starts at 1. If the third argument is missing, it defaults to 1. + If the first string does not appear in the second string, #VALUE! is returned. The searches are done + in a case sensitive manner. + + + + + Returns the value at a specified row and column from within a given range. + + look_range, row, col + The value. + + Only the array form of this function is supported. + + + + + Returns the number of the starting position of the first string from the second string. + + first strring, second string and starting position + index of the string + + + + Find and return list of unique elements for two dimentional array elements. + + return list of unique elements. + + + + + Validate and return the error string for TextBefore/TextAfter formula. + + validated argument + + + + This function returns text that occurs after given character or string. + + + A string containing the arguments separated by commas. + The format should be: "text,delimiter,instance_num, match_mode, match_end, if_not_found". + + textThe text you are searching within. Wildcard characters not allowed. + delimiterThe text that marks the point after which you want to extract. + instance_num[Optional] The instance of the delimiter after which you want to extract the text.(default is 1). + match_mode[Optional] Determines whether the text search is case-sensitive. The default is case-sensitive. + + 0 - Case sensitive. + 1 - Case insensitive. + + + match_end[Optional] Treats the end of text as a delimiter. By default, the text is an exact match. + + 0 - Don't match the delimiter against the end of the text. + 1 - Match the delimiter against the end of the text. + + + if_not_found[Optional] Value returned if no match is found. By default, #N/A is returned. + + + The text that occurs after given character or string. + + + + Validate and get the argument for TextAfter/TextBefore formula. + + + + + This function returns text that occurs text that occurs before a given character or string + + + A string containing the arguments separated by commas. + The format should be: "text,delimiter,instance_num, match_mode, match_end, if_not_found" + + textThe text you are searching within. Wildcard characters not allowed. + delimiterThe text that marks the point after which you want to extract. + instance_num[Optional] The instance of the delimiter after which you want to extract the text.(default is 1). + match_mode[Optional] Determines whether the text search is case-sensitive. The default is case-sensitive. + + 0 - Case sensitive. + 1 - Case insensitive. + + + match_end[Optional] Treats the end of text as a delimiter. By default, the text is an exact match. + + 0 - Don't match the delimiter against the end of the text. + 1 - Match the delimiter against the end of the text. + + + if_not_found[Optional] Value returned if no match is found. By default, #N/A is returned. + + + The text that occurs before a given character or string. + + + + Find index to returns text when delimiter is character and instance_num is negative that appears after a given character. + + The text you are searching within + The text that marks the point after which you want to extract. + The instance of the delimiter after which you want to extract the text.By default, instance_num = 1 + The index to returns text that appears after a given character. + + + + Find index to returns text when delimiter is word and instance_num is negative that appears after a given character. + + The text you are searching within + The text that marks the point after which you want to extract. + The instance of the delimiter after which you want to extract the text.By default, instance_num = 1. + The index to returns text that appears after a given word. + + + + Find index to returns text when delimiter is word and instance_num is positive that appears after a given character. + + The text you are searching within. + The text that marks the point after which you want to extract. + The instance of the delimiter after which you want to extract the text.By default, instance_num = 1. + The index to returns text that appears after a given word. + + + + Find index to returns text when delimiter is character and instance_num is positive that appears after a given character. + + The text you are searching within + The text that marks the point after which you want to extract. + The instance of the delimiter after which you want to extract the text.By default, instance_num = 1. + The index to returns text that appears after a given character. + + + + This function returns text from any specified value. It passes text values unchanged, and converts non-text values to text. + + + A string containing the arguments separated by commas. + The format should be: "value, format" + + valueThe value to return as text. + formatThe format of the returned data.[optional] + + 0 - Concise format that is easy to read. The text returned will be the same as the text rendered in a cell that has general formatting applied. + 1 - Strict format that includes escape characters and row delimiters. Generates a string that can be parsed when entered into the formula bar. Encapsulates returned strings in quotes except for Booleans, Numbers and Errors. + + + + + Text from any specified value + + + + Returns the text from any specified value. + + The value to return as text. + The format of the returned data. + + + + Calculate array format argument value. + + Return calculated array format argument value for interior and direct VALUETOTEXT formula. + + + + This function returns text from any specified array/range. It passes text values of array unchanged, and converts non-text values to text. + + + A string containing the arguments separated by commas. + The format should be: "array, format" + + arrayThe array to return as text. + formatThe format of the returned data.[optional] + + 0 - Concise format that is easy to read. + The text returned will be the same as the text rendered in a cell that has general formatting applied. + + 1 - Strict format that includes escape characters and row delimiters. + Generates a string that can be parsed when entered into the formula bar. + Encapsulates returned strings in quotes except for Booleans, Numbers and Errors. + + + + + + Text from the specified array/range. + + + + Calculates the final string of the specified condition in the formula from the sepcified range of cells. + + an array of text values from any specified range. + + + + Converts a flat list of cell data into a structured list of rows and columns. + + List of cell data. + Number of columns in the data. + Structured data as a list of lists. + + + + Returns the text from any specified value. + + The value to return as text. + The format of the returned data. + string value after checking with the conditions. + + + + + Validates the argument list and extracts the range, ignore, and scanByColumn values. + + Output parameter that holds the value to be ignored. + Output parameter that indicates whether to scan by column. + Output parameter that holds the range value. + The argument list string to be parsed and validated. + + Returns an error string if there is any validation error, otherwise returns an empty string. + + Thrown when there is an invalid number of arguments or invalid argument value. + + + + Converts the values of a given array range to a single column/row format. + + The range of the array to be converted. + A value indicating whether to ignore certain cells (e.g., blanks or errors). + A boolean indicating whether to scan the range by columns (true) or by rows (false). + A string representing the values of the array converted to a single column/row, separated by the defined separator. + + + + Checks the conditions of the given cell value in the array based on specified criteria. + + The value of the cell to be checked. + A value indicating whether to ignore certain cells (e.g., blanks or errors). + A list to which the cell value will be added if it meets the conditions. + A boolean indicating whether the cell value was added to the list. + + + + Retrieves the totalnumber of columns, totalnumber of rows, and array values from the given array/range. + + Output parameter for the total number of columns. + Output parameter for the total number of rows. + Output parameter for the list of array values. + Input arguments, including range or array values. + + + + + Returns specified columns from an array or range. + + + A string containing the array or range and the column indexes separated by commas. + The format should be: array, col_num1, [col_num2], ... + + + array: The source array or range. + + + col_num1: An integer specifying the first column to return. + + + [col_num2]: [optional] Index numbers of additional columns to return. + + + + A formatted string representing the specified columns from the array or range. + + + + Returns the row/column indexes as a string array from the argument. + + The arguments specifying the range and indexes to choose. + The total number of columns in the range. + The total number of rows in the range. + A boolean indicating whether the indexes are for columns (true) or rows (false). + An output parameter that will contain the computed indexes as an integer array. + A string indicating any error that occurred during the computation; otherwise, an empty string. + + + + Computes and returns a formatted string of column or row values from a range based on specified indexes. + + The range of the array to be processed. + An array of indexes specifying the columns or rows to be chosen. + The total number of columns in the range. + The total number of rows in the range. + A list of the values in the array. + A boolean indicating whether the indexes are for columns (true) or rows (false). + A formatted string representing the chosen column or row values, separated by the defined separator. + + + + Returns specified rows from an array or range. + + + A string containing the array or range and the row indexes separated by commas. + The format should be: array, row_num1, [row_num2], ... + + + array: The source array or range. + + + row_num1: An integer specifying the first row to return. + + + [row_num2]: [optional] Index numbers of additional rows to return. + + + + A formatted string representing the specified rows from the array or range. + + + + Converts a flat list of cell data into a structured list of columns. + + List of cell data + Number of columns in the data + Structured data as a list of lists by columns + + + + This function generates a list of sequential numbers in an array. + + + A string containing the arguments separated by commas. + The format should be: "rows, columns, start, step". + + rows: The number of rows to fill. + columns: The number of columns to fill. If omitted, defaults to 1 column. + start: The starting number in the sequence. If omitted, defaults to 1. + + step: The increment for each subsequent value in the sequence. It can be positive or negative. + + If positive, subsequent values increase, creating an ascending sequence. + If negative, subsequent values decrease, producing a descending sequence. + If omitted, the step defaults to 1. + + + + + Generates and returns an array of sequential numbers. + + + + Generate an array of sequential number + + Generate and return an array of sequential number + + + + This function splits text strings by using column and row delimiters. + + + A string containing the arguments separated by commas. + The format should be: "text, col_delimiter, row_delimiter, ignore_empty, match_mode, pad_with". + + text: The text you want to split. + col_delimiter: The text that marks the point where to spill the text across columns. + row_delimiter [optional]: The text that marks the point where to spill the text down rows. + + ignore_empty [optional]: Specifies whether to ignore empty values or not. Defaults to FALSE. + + FALSE (default) - create empty cells for consecutive delimiters without a value in-between. + TRUE - ignore empty values, i.e., don't create empty cells for two or more consecutive delimiters. + + + + match_mode [optional]: Determines case-sensitivity for the delimiter. Enabled by default. + + 0 (default) - case-sensitive. + 1 - case-insensitive. + + + pad_with [optional]: A value to use in place of missing values in two-dimensional arrays. The default is a #N/A error. + + + Splitted text strings by using column and row delimiters. + + + + Compute and return delimters when delimter contains multiple character{",",";"}. + + delimters when contains multiple character. + + + + splits text strings by a given row and column delimiter across columns or/and rows. + + the text to split + a character(s) that indicates where to split the text across rows. + a character(s) that indicates where to split the text across columns. + specifies whether to ignore empty values or not. + determines case-sensitivity for the delimiter. + a value to use in place of missing values in two-dimensional arrays. + maxColumn count. + list of splitted text. + + + + splits text strings by a column delimiter across columns. + + + + + This function retrieves a specified subset of values from a given array or range based on the number of rows and/or columns provided. + + + A string containing the arguments separated by commas in the following format: + + + array: The array or range from which to retrieve values. + + + + rows: [Optional] The number of rows to return. + A positive value returns rows from the start of the array, while a negative value returns rows from the end. + If omitted, columns must be provided. + + + columns: [Optional] The number of columns to return. + A positive integer returns columns from the start of the array, while a negative integer returns columns from the end. + If omitted, rows must be provided. + + + + A formatted string containing the subset of values from the specified array or range. If the input is invalid, an appropriate error message is returned. + + + + Retrieves values from the given range based on the specified rows and columns. + + The range of cells. + The number of rows to retrieve. + The number of columns to retrieve. + A string containing the retrieved values, separated by a specified separator. + + + + This function removes the specified number of rows and/or columns from the start or end of an array or range. + + + A string containing the arguments separated by commas. The format should be: array, rows, [columns]. + + + + array: The array or range from which values are to be removed. + + + + + rows: [Optional] The number of rows to remove. A positive value removes rows from the start of the array, + and a negative value removes rows from the end of the array. If omitted, columns must be provided. + + + + + columns: [Optional] The number of columns to remove. A positive integer removes columns from the start of the array, + and a negative integer removes columns from the end of the array. If omitted, rows must be provided. + + + + + + A formatted string representing the array after removing the specified rows and/or columns. + If the inputs are invalid, an error message is returned. + + + + + Drops specified rows and/or columns from the array. + + Input range or array. + Number of rows to drop. + Number of columns to drop. + Total number of rows in the array. + Total number of columns in the array. + List of array values. + Resultant string after dropping specified rows and/or columns. + + + + This function expands or pads an array to specified row and column dimensions. + + + A string containing the arguments separated by commas. + The format should be: "array, rows, columns, pad_with". + + array: The array to expand. + rows: The number of rows in the expanded array. If missing, rows will not be expanded. + columns: The number of columns in the expanded array. If missing, columns will not be expanded. + pad_with: The value with which to pad. The default is #N/A. + + + An expanded or padded array with the specified row and column dimensions. + + + + Compute and return the expanded arraay based on pad_with and rows and cols argument. + + + + + This function computes the vector (one-dimensional array) and returns the wrapped values. + + + The input arguments as a single string separated by commas. + The format is: vector, wrap_count, [pad_with] + + + vector: The source one-dimensional array or range. + + + wrap_count: The maximum number of values per row. + + + pad_with [optional]: The value to pad the last row with if there are insufficient items to fill it. + If omitted, the missing values will be padded with #N/A (default). + + + + A string representing the wrapped rows or an error message. + + + + Wraps the rows or columns of an array based on the specified wrap count and padWith. + + The vector of values to be wrapped. + The count at which to wrap the rows or columns. + The value to pad with if necessary. + A boolean indicating whether to wrap rows (true) or columns (false). + A string representing the wrapped rows or columns. + + + + This function computes the vector (one-dimensional array) and returns the wrapped values. + + + The input arguments as a single string separated by commas. + The format is: vector, wrap_count, [pad_with] + + vector: The source one-dimensional array or range. + wrap_count: The maximum number of values per column. + pad_with [optional]: The value to pad the last column with if there are insufficient items to fill it. + If omitted, the missing values will be padded with #N/A (default). + + + A string representing the wrapped columns or an error message. + + + + Checks for error strings in the given arguments and extracts the range, wrap count, and pad width. + + The input arguments as a single string. + The extracted range of values. + The extracted wrap count. + The extracted pad width. + A string representing any error found, or an empty string if no errors are found. + + + + This function sorts the contents of an array or range by columns or rows in ascending or descending order. + + + A string containing the arguments separated by commas. The format should be: "array, sort_index, sort_order, by_col". + + + + array: The array or range to be sorted. + + + + + sort_index [Optional]: The column or row index on which to base the sorting. If omitted, the first column or row is used. + + + + + sort_order [Optional]: Defines the sort order. If omitted, the default is ascending order. + + 1 or omitted - Ascending order (default). + -1 - Descending order. + + + + + + by_col [Optional]: A logical value indicating the direction of sorting. If omitted, the default is to sort by rows. + + FALSE or omitted - Sort by row (default). + TRUE - Sort by column. + + + + + + A string representing the sorted array. + + + + Compute and sort the values from array or range + + Array values specified as a range + Sort index is a column index from the range or array values + Sorting order (1 for ascending, -1 for descending) + Scan by column (true/false) + String of the sorted values + + + + Sorts the structured data by the specified row index and order. + + Structured data as a list of lists + Index of the row to sort by + Order to sort by (1 for ascending, -1 for descending) + Sorted structured data + + + + Sorts the structured data by the specified column and order. + + Structured data as a list of lists + Index of the column to sort by + Order to sort by (1 for ascending, -1 for descending) + Sorted structured data + + + + Compares two values for sorting based on the specified sort order. + + The first value to compare. + The second value to compare. + The sort order (1 for ascending, -1 for descending). + An integer indicating the relative order of the values. + + + + This function sorts the contents of a range or array based on the values in corresponding ranges or arrays. + + + A string containing the arguments separated by commas. + The format should be: "array, by_array1, sort_order1, by_array2, sort_order2,…". + + + array: The array or range to sort. + + + by_array1: The array or range to sort by. + + + sort_order1: The order to use for sorting. Default is ascending. + + 1 for ascending. + -1 for descending. + + + + + A sorted range or array. + + + + Retrieves the values of the specified arrays and performs sorting based on the provided criteria. + + An array of strings representing the arguments for the SORTBY function. + A list of strings representing the sort orders for each byArray. + A list of strings representing the byArrays used for sorting. + A string representing the sorted values. + + + + Performs the sorting for the SORTBY function. + + A list of strings representing the values of the initial array or range. + A list of strings representing the byArrays used for sorting. + A list of strings representing the sort orders for each byArray. + The number of columns in the initial array or range. + A string representing the sorted values. + + + + This function is used to filter a range of data based on the criteria that you specify. + + + The input arguments as a single string, separated by commas. + The format is: array, include, [if_empty] + + + array: The source range or array of values to filter. + + + include: The criteria for filtering, provided as a Boolean array or a condition that results in a Boolean array (e.g., B2:B13=B2"). + + + if_empty [optional]: The value to return if no entries meet the criteria. If omitted, a default error message is returned. + + + + A string representing the filtered values based on the criteria, or an error message if the arguments are invalid or if an error occurs. + + + + This method used to calculate the criteria for Filter formula using include argument and retrun the calculated string. + + + + + This method filters the given array based on specified criteria and returns the results as a formatted string. + + The array to filter. + The criteria for filtering the array. + Additional conditions or logical operators for filtering. + Value to return if no items match the criteria. + Number of columns in the array for filtering. + True if includeArray is horizontal, false if vertical. + A formatted string with the filtered results. + + + + This method converts a numeric value to its equivalent Thai text and adds the currency unit "Baht" for the integer part, and "Satang" for the fractional part if applicable. + + + A string representing a number, a reference to a cell containing a number, or a formula that evaluates to a number. This number will be converted to Thai text with a "Baht" suffix. + + + A string representing the given number in Thai text, followed by "Baht" for the whole number part and "Satang" for the fractional part. + If the input number is zero, it returns "ศูนย์บาทถ้วน". If the input is invalid, it returns an error message. + + + + + Converts the integer part of a number into its equivalent Thai text representation. + + The integer part of the number to convert. + Array of Thai words for ones (1-9). + Array of Thai words for tens (10, 20, etc.). + Array of Thai words for higher units (hundred, thousand, etc.). + A string representing the integer in Thai text. + + + + Return the XML content of the given document + + web link + XML data + + + + Returns the encode url of the given text + + text + returns the EncodeURL + + + + Filter the value from XML document + + XML content + value + + + + Field that turns on/off processing of the ICalcData.ValueChanged event. + + + + + Used to store the number + + + + + Used to store the big number as double + + + + + Used to store the value as double + + + + + This field will be set as true, if the 1904 date system is enabled in Excel. + + + + + Set the boolean as true + + + + + The constructor. + + + + + The constructor. + + The ICalcData from the underlying grid. + + + + Gets or sets whether the formula is array formula or not. + + + + + Gets or sets the instance of . + + + + + Gets or sets the instance of + + + + + Used to store the registed values + + + + + The list of error strings which are used within the Essential Calculate internally. Users can make changes to this internal error strings. + Default settings by assigning the new strings to the corresponding position.ReloadErrorStrings should be invoked to reset or modify the internal error strings. + + + + + A method that checks the possible cases for error string(invalid arguments for formula). + + The arguments of formula. + The formula's argument type. + Returns the Error string if formula has invalid arguments + + + + Below method has been used to find the negative values(ex formula:=LARGE({6,23,-5,2.3}, 2)). + + string contains negative values(eg:-2,-2,-2) or possitve value. + True if the values are number.else false. + + + + Returns true when Namedarange is in the scope and returns cellRange based on scope. + + NamedRange + CellRange + True when Namedarange is in the scope.else false. + + + + This method check "\"in the string and removes if the string contains "\"\. + + input string. + returns The parsed string value without the "\"\ + + + + A method that parses the text in a formula passed in. + + The text formula to be parsed. + A string holding a parsed representation of the formula. + + + + A method that parses and computes the string formula passed in. + + The text formula to be parsed and computed. + A string holding the computed value. + + + + Below method used to find the parsed formula contains external workbook reference or not. + + Parsed string + true, when its contains external referenceworkbook.Else returns false. + + + + Below method has been used to find the external workbook Token. + + Parsed string. + true, if the string contain external workbook sheet Token.Else returns false. + + + + Accepts an unparsed formula string and replaces any sheet references with corresponding tokens. + + The unparsed formula string. + + This is an advanced method that lets you replace sheet names with corresponding tokens. You may have need of + this method if you are adding your own functions to the function library. + + + + + Tokenizes all library references. + + + Accepts a string such as Sin(A1+A2) and tokenizes it into + bqSIN[A1A2a]b which serves as input to ComputedValue. + + Formula to be tokenized. + + + + A method that adds a function to the function library. + + The name of the function to be added. + The function to be added. + True if successfully added, otherwise False. + + LibraryFunction is a delegate that defines the signature of functions that + you can add to the function library. + + public delegate string LibraryFunction(string args); + + + + + + A method that removes a function from the function library. + + The name of the function to be removed. + True if successfully removed, otherwise False. + + + + Creates and initially loads the function library with the supported functions. + + + + + CreateSheetFamilyID is a method to create familyID for a sheet. + + Sheet family ID. + + Essential Calculate supports multisheet references within a family of ICalcData objects. To use + this functionality, you use this method to get a unique identifier for + the family. Then in the RegisterGridAsSheet method that you call to add ICalcData objects + to this family, you pass this unique identifier to mark the ICalcData objects as belonging + to this family. You can only cross reference ICalcData objects within the same family. + + + + + RegisterGridAsSheet is a method that registers an ICalcData object so it can be referenced in a formula from another ICalcData object. + + The reference name used to refer to this ICalcData object from formulas in other ICalcData objects. + + The ICalcData from the ICalcData object being registered. + + /// An integer previously created with a call + to CalcEngine.CreateSheetFamilyID. This number is used to identify + the ICalcData objects as belonging to a particular family of ICalcData objects. You can only reference + ICalcData objects from within the same family. + + + Essential Calculate supports multisheet references with its formulas. For example, if you + have two ICalcData objects, then you can reference cells from the first ICalcData object + in the second ICalcData object. For this to work, both ICalcData objects need to be registered using this method. + The syntax for using a sheet reference as part of a formula is to prefix a cell reference + with the sheet reference name followed by an exclamation point. + The formula "= sheet1!A1 + sheet2!C3" would add the value is cell A1 for + the ICalcData object whose reference name is sheet1 to the value from cell C3 in the ICalcData object + whose reference name is sheet2. + + Use this code to use cross sheet references: + + //Register three ICalcData objects so cell can be referenced across ICalcData objects: + int sheetfamilyID = CalcEngine.CreateSheetFamilyID(); + myCalcEngine.RegisterGridAsSheet("summary", calcData1, sheetfamilyID); + myCalcEngine.RegisterGridAsSheet("income", calcData2, sheetfamilyID); + myCalcEngine.RegisterGridAsSheet("expenses", calcData3, sheetfamilyID); + .... + //Sample formula usage for cells in calcData1, the 'summary' data source. + //This code sums ups some cells from calcData3, the 'expenses' data source + //and calcData2, the 'income' data source. + //Sum the range B2:B8 from expenses: + string sumExpenses = "= Sum(expenses!B2:expenses!B8)"; + //Sum the range B2:B4 from income: + string sumIncome = "= Sum(income!B2:income!B4)"; + + + 'Register three ICalcData objects so cell can be referenced across ICalcData objects: + Dim sheetfamilyID As Integer = CalcEngine.CreateSheetFamilyID(); + myCalcEngine.RegisterGridAsSheet("summary", calcData1, sheetfamilyID) + myCalcEngine.RegisterGridAsSheet("income", calcData2, sheetfamilyID) + myCalcEngine.RegisterGridAsSheet("expenses", calcData3, sheetfamilyID) + .... + 'Sample formula usage for cells in calcData1, the 'summary' data source. + 'This code sums ups some cells from calcData3, the 'expenses' data source + 'and calcData2, the 'income' data source. + 'Sum the range B2:B8 from expenses: + Dim sumExpenses As String = "= Sum(expenses!B2:expenses!B8)" + 'Sum the range B2:B4 from income: + Dim sumIncome As String = "= Sum(income!B2:income!B4)" + + + + + + Unregisters a grid so it can no longer be referenced in a formula from another grid. + + The reference name used to refer to this grid from formulas in other grids. + + The grid model. + + + + Change the sheet name of with the given name. + + Name of the sheet. + The ICalcData object. + + + + Triggers a calculation for any value depending upon the given cell. + + The cell. + + + + Returns the GridSheetFamilyItem for the specified model. If there was no item registered for + the model, a new item is created and cached. + + The grid model. + The GridSheetFamilyItem for the specified model. + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Return the value of arraybounds as boolean + + current cell + height + width + firstrowindex + firstcolumnindex + lastrowindex + lastcolumnindex + + + + + A method to retrieve the row index from a cell reference. + + String holding a cell reference such as C21 or AB11. + An integer with the corresponding row number. + + + + A method that gets the column index from a cell reference passed in. + + String holding a cell reference such as C21 or AB11. + An integer with the corresponding column number. + + + + Determines whether the arg is a valid cell name. + + Cell name. + True is the arg is a valid cell name, false otherwise. + + + + To check whether the row index can be obtained from the arguments + + + + + A method to split the arguments using argument seperator. + + arguments to split. + argument seperator used to split. + A string array. + + + + Removes outer quote marks from a string with no inner quote marks. + + The string with possible outer quote marks. + The string with any outer quote marks removed. + This is a utility method that removes outer quotes on a string. + + + + Returns an array of argument strings from a single string where the arguments are delimited by . + + Contains the argument list. + A string array of arguments. + This method properly preserves any quoted strings that contain the character. + + + + Tests whether a string is NULL or empty. + + String to be tested. + True is passed in string is null or empty, otherwise False. + + + + Given a string, it returns a string that is passed through the FormulaParsing event + to allow any listener to modify it. + + A string that is to be potentially parsed. + + + + Accepts a possible parsed formula and returns the calculated value + without quotes. + + The argument to be adjusted. + + This method is useful in custom functions if you want to allow + your custom functions to handle parsed formulas as arguments. In + this case, calling this method at the beginning of your custom function + will allow you custom function to work only with computed values, and not + have to handle parsed formulas directly. + + + + + Call this method to clear whether an exception was raised during the computation of a library function. + + + + + Returns the value of specified cell in a Grid. + + Cell address + If true, compute the formula and returns calculated result. + Else, simply returns the value of the cell. + value of the cell + + + + Conditionally gets either the formula value or the cell + value depending upon whether the requested cell is a FormulaCell. + + Row index of the requested cell. + Column index of the requested cell. + String holding either the cell value or the computed formula value. + + + + Computes the exact date value when the input string is based on time span. + + value to be converted into date. + computed date for the time. + returns true if the value can be converted to date time. + + + + Conditionally gets either the formula value or the cell + value depending upon whether the requested cell is a FormulaCell. + + The ICalcData object holding the requested cell. + Row index of the requested cell. + Column index of the requested cell. + String holding either the cell value or the computed formula value. + + + + Returns the value of specified cell in a Grid. + + The ICalcData object holding the requested cell. + Row index of the requested cell. + Column index of the requested cell. + If true, compute the formula and returns calculated result. + Else, simply returns the value of the cell + the value of the cell. + + + + A Virtual method to compute the value based on the argument passed in. + + + This method takes the argument and checks whether it is a + parsed formula, a raw number, or a cell reference like A21. + The return value is a string that holds the computed value of + the passed in argument. + + A parsed formula, raw number, or cell reference. + A string with the computed number in it. + + + + A method that retrieves a string array of cells from the range passed in. + + + Converts arguments in these forms to a string array of individual cells: + A1,A2,B4,C1,...,D8 + A1:A5 + A1:C5 + + String containing a cell range. + String array of cells. + + + + A method that retrieves a string array of cells from the range passed in. + + + Converts arguments in these forms to a string array of individual cells: + A1,A2,B4,C1,...,D8 + A1:A5 + A1:C5 + + String containing a cell range. + default value is true. + String array of cells if findCellsFromRange is true.otherwise return cell reference. + + + + This method recalculates any formula cells in the specified range. + + The calculations for non-visible formula cells are performed the next time + cell are actually displayed. If you want the calculation performed immediately + on cells (visible or not), call the two argument overload of RecalculateRange, + passing the forceCalculations argument as True. + GridRangInfo object that specifies the cells to be recalculated. + ICalcData object that holds the data to be recalculated. + + + + An overridden method to display information on the cell currently being calculated. + + String with information on the cell currently being calculated. + + + + Conditionally gets either the formula value or the cell + value depending upon whether the requested cell is a FormulaCell. + + The alphanumeric cell label, like A1, or EE14. + String holding either the cell value or the computed formula value. + + + + Conditionally gets either the formula value or the cell + value depending upon whether the requested cell is a FormulaCell. + + Row index of the requested cell. + Column index of the requested cell. + String holding either the cell value or the computed formula value. + + + + Evaluates a parsed formula. + + A string holding a valid parsed formula. + The computed value of the formula. + The string passed into this function must be previously parsed + using ParseFormula. + + + + Compute the NestedIF formulas using the old code structure of CalcEngine. + + formula to execute / compute + + + + Compute the NestedIF formulas using new parse and compute technique. + + formula to execute / compute + + + + This method is used to retrieve the exact results from a cell reference based on the cell formula. + + This parameter represents the Parameter of IF formulas it can be either logical true or logical false. + This parameter represents the result of the IF formulas parameter. + Returns zero if the cell reference does not have any formula; otherwise, it returns the value of the formula in the cell reference. + + + + A method that computes a parsed formula. + + The parsed formula to be computed. + A string holding the computed value. + + + + This method retrieves the value in the requested cell reference using fresh computations + for any cells that affect the value of the requested cell. + + A cell reference like: Sheet5!B14 + A freshly computed value for the cell. + + + + PullUpdatedValue is a method used to recompute the cells that are referred to compute the requested value. + + Integer identifying the ICalcData object. + The row in the ICalcData object. + The column in the ICalcData object. + + + + A method that increases the calculation level of the CalcEngine. + + Every formula has a calculation ID level associated with it. Every time + a formula is retrieved, its calculation ID level is compared with the CalcEngine + ID level. If they do not agree, the formula is recomputed. Calling UpdateCalcID + will force any formula to be recomputed the next time it is retrieved. + + + + + Refresh is a method that recalculates any cell that depends upon the passed in cell. + + A cell such as A21 or EE31. + + + + Returns the amount received at maturity for a fully invested security. + + Number and the number of digits + Received amount + + + + Counts the nonblank cells in a field (column) of records in a list or database that match conditions that you specify. + + Number and the number of digits + Received amount + + + + Averages the values in a field (column) of records in a list or database that match conditions you specify. + + Number and the number of digits + Received amount + + + + Extracts a single value from a column of a list or database that matches conditions that you specify. + + Number and the number of digits + Received amount + + + + Returns the largest number in a field (column) of records in a list or database that matches conditions you that specify. + + Number and the number of digits + Received amount + + + + Returns the smallest number in a field (column) of records in a list or database that matches conditions that you specify. + + Number and the number of digits + Received amount + + + + Returns the smallest number in a field (column) of records in a list or database that matches conditions that you specify. + + Number and the number of digits + Received amount + + + + Estimates the variance of a population based on a sample by using the numbers in a field (column) of records in a list or database that match conditions that you specify. + + Number and the number of digits + Received amount + + + + Calculates the variance of a population based on the entire population by using the numbers in a field (column) of records in a list or database that match conditions that you specify. + + Number and the number of digits + Received amount + + + + Estimates the standard deviation of a population based on a sample by using the numbers in a field (column) of records in a list or database that match conditions that you specify. + + Number and the number of digits + Received amount + + + + Calculates the standard deviation of a population based on the entire population by using the numbers in a field (column) of records in a list or database that match conditions that you specify. + + Number and the number of digits + Received amount + + + + Adds the numbers in a field (column) of records in a list or database that match conditions that you specify + + Number and the number of digits + Received amount + + + + Used to get the data from arguments + + Arguments + + + + + This field is enable when the criteria is double. + + + + + Returns the archyperbolic cosecant of an angle. + + A cell reference or a cell or a number + A string containing the archyperbolic cosecant of an angle + + + + Returns the full product of two 32-bit numbers. + + The two 32 bit numbers. + A string containing the product of two 32 bit numbers. + + + + Calculates the quotient of two 64-bit signed integers and also returns the remainder in an output parameter. + + + returns the quotient of two 64-bit signed integers. + + + + Returns the remainder resulting from the division of a specified number by another specified number. + + contains a divisor and dividend + Returns the remainder. + + + + replaces part of a text string, based on the number of characters, with a different text string + + Text in which is want to replace, The position of the character in old_text., The number of characters in old_text + returns replaced text + + + + Returns the row index of the passed in cell reference. + + Contains zero or one argument. If no argument is passed, returns the row index of the + location of this Row function cell, otherwise returns the row index of the passed in cell reference. + The row index. + + This method doesn't return an array of row numbers as the array formula entry is not supported in engine. It is another usecase of this library function. + This method is deprecated. Please use the instead. + + + + + Returns the m parameter of the exponential curve y = b * m^x that best fits the given points. Only the first two Excel parameters are used. + + Y_range, x_range. + returns m parameter. + + + + Returns the b value from the exponential curve y = b * m^x. + + Y_range, x_range. + returns calculated b value. + + + + Returns the most recent points from an array (the points with the highest index values). + For functions with a decay factor, the weight on the last element in the array is the highest. + In many applications this corresponds with the assumption that the last element in the array represents the most recent data point. + + Array from which the data points will be selected. + The number of data points to be returned. + + + + + Returns the mean of an array. + + Array of data for which we are calculating the mean. For time series, the last element (index = n-1), is the most recent. + In most applications, the decay factor is between 0 and 1. Weigth on the last element in array is 1.0, the 2nd to last element d, 3rd to last d^2, ... + Window length. Method uses the most recent n points, n = length. + + + + Returns the weighted averages of the values in valueArray using the corresponding weights in weightArray. + + array of values for which we are computing the weighted average + array of weights used in computing the weighted average + + + + Returns the CDF of the uniform distribution. + + Value at which the distribution is evaluated. + Minimum value of the distribution. + Maximum value of the distribution. + + + + Returns the half-life of a geometric series of length n, who's first element is 1. + For decay factor d, 1 + d + d^2 + ... + d^(h-1) = 0.5 * [1 + d + d^2 + ... + d^(n-1)] + + Decay factor Typically between -1 adn +1. + Number of elements in the geometric series, must be positive. + + + + + Returns the sum of a geometric series of length n, who's first element is 1. + For decay factor d, S = 1 + d + d^2 + ... + d^(n-1) + + Decay factor Typically between -1 adn +1. + Number of elements in the geometric series, must be positive. + + + + + Returns the sum of an infinite geometric series who's first element is 1. + For decay factor d, S = 1 + d + d^2 + ... + + Decay factor. Typically between -1 adn +1. + + + + + Returns the sample covariance between two arrays. + Arrays should be of equal length, and contain more than one element. + + + + In most applications, the decay factor is between 0 and 1. Weigth on the last element in arrays is 1.0, the 2nd to last element d, 3rd to last d^2, ... + + + + Recalculates every cell that depends upon any cell in the passed-in range. + + For example, if range is RangeInfo(1,1,2,2), and cells (5,6) and + (12,17) hold formulas that reference the cells in the range, then cells (5,6) + and (12,17) will be re-computed as the result of this call. + RangeInfo object to be refreshed. + + + + Clears any variable names registered with the CalcEngine. + + + + + Registers a list of variable names so you can use it within formulas. + + List of names. + + + + Swaps variable names for tokens. + + The formula holding variable names. + The formula with tokens. + + + + Return the value of besseli1 + + value + + + + + Return the value of the besselk1 + + value + + + + + Return the value of besselk0 + + value + + + + + A method to get submatrix for matrix function used internally. + + double Array - Matrix + Matix rows + Columns + Matrix + + + + Return the value of between strings + + source string + start + end + + + + + Gets the text of any formula at the given row and column of the ICalcData object. + + The ICalcData object. + The one-based row in the grd object. + The one-based col in the grd object. + String containing the text of the formula. + If the data item at row and column is not a formula, the + return value is an empty string. + + + + Retrieves the current CalcEngine calculation level ID. + + Current calculation level ID. + + + + A method to reset the cached ICalcData object IDs. + + + + + Resets the internal sheet token marker to 0. + + + When RegisterGridAsSheet is called to add a ICalcData object to a CalcEngine, + this newly added sheet is associated with an integer used in tokenizing formulas. + This sheetID integer is required in the PullUpdatedValue method to specify the ICalcData + object being accessed. The GetSheetID method allows you to retrieve a sheetID given + an ICalcData object. This internal sheet token marker is a static member of CalcEngine, + and is incremented each time a new ICalcData object is registered with the CalcEngine + using RegisterGridAsSheet. + + + + + Return the value of HandleIteration + + value + formula + + + + + Adds a named range to the NamedRanges collection. + + The name of the range to be added. + The range to be added. + True if successfully added, otherwise False. + + The range should be a string such as A4:C8. + + + + + Removes a range from the NamedRanges collection. + + The name of the range to be removed. + True if successfully removed, otherwise False. + + + + Replaces NamedRanges with their values. + + + Accepts a string such as Sin(SumRange) and tokenizes it into + bqSIN[A1A4a]b which serves as input to ComputedValue. + + argList containing named ranges. + + + + Get the cell Range for table NameRange + + Formula or NamedRange + cell range string + + + + Get the first row Index of Cell Range + + Cell Range to find index + get the top row index + + + + This method is used to check the given text is Namedrange or not. + + Parsed string. + returns the CellRange value if the parsed text is NamedRange + + + + Below method used to intersect the NamedRanges when the parsed formula contains space. + + A string holding a valid parsed formula. + The intersected NamedRanges value. + If the namerange intersects, returns true, else false. + + + + Find the next table formula or table Range end index i.e last index of '[' + + formula to find index + location of start index to search the char '[' + locatio of end index + + + + Gets the weekend type + + + + + Gets or sets whether dates can be used as operands in calculations. The default value is false. + + + + + Gets / sets whether the engine throws an exception when + parsing fails with an unknown function error. + + + + + The List holds the formats of a Chinese Language. + + + + + Gets or sets whether lookup tables used in the VLookUp and HLookUp functions are cached. + + + Depending upon your use case, caching look up tables can greatly speed up calculations involving HLookUp + and VLookUp. If you make multiple calls to these functions passing in the same look up tables, and if these + look up tables are relatively static (don't dynamically change as the look ups are taking place), then caching + these tables will likely improve performance. + + + + + Occurs whenever a string needs to be tested to determine whether it should be treated as a formula string and parsed, + or be treated as a non-formula string. This event allows for preprocessing the unparsed formula. + + This event may be raised more than once in the processing of a string into a formula. + + + + + Occurs whenever an unknown function is encountered during the parsing of a formula. + + This event may be raised more than once in the parsing of a formula. + + + + + Occurs whenever an UpdateNamedRange function is encountered during the parsing of a formula. + + This event may be raised more than once in the parsing of a formula. + + + + + Occurs when the formula computes the values. + + This event may be raised more than once in the computation of a formula. + + + + + Occurs whenever an ExternalFormula function is encountered during the parsing of a formula. + + This event may be raised more than once in the parsing of a formula. + + + + + Occurs whenever an ExternalFormula function is encountered during the parsing of a formula. + + This event may be raised more than once in the parsing of a formula. + + + + + Occurs whenever an ExternalFormula function is encountered during the parsing of a formula. + + This event may be raised more than once in the parsing of a formula. + + + + + Gets of sets whether the CalcEngine treats nonempty strings as zeros when they are + encountered during calculations. + + + The default value is true meaning that if a nonempty string is encountered during an arithmetic operation, it will be treated as zero. + + + + + This property is used to return the cell ranges for print area calculation. + + + + + Specifies the maximum number of recursive calls that can be used to compute a cellvalue. + + This property comes into play when you have a calculated formula cell that depends on + another calculated formula that depends on another calculated formula and so on. If the number of + 'depends on another formula' exceeds MaximumRecursiveCalls, you will see a Too Complex message + displayed in the cell. The default value is 100, but you can set it higher or lower depending upon + your expected needs. The purpose of the limit is to avoid a circular reference locking up your + application. + + + + + Indicates whether formulas are immediately calculated as dependent cells are changed. + + Use this property to suspend calculations while a series of changes + are made to dependent cells either by the user or programmatically. When the changes are + complete, set this property to False, and then call Engine.RecalculateRange to recalculate + the affected range. See the sample in GridCellFormulaModel.CalculatingSuspended. + + + + + A read-only property that gets a collection holding the current library functions. + + + This property gives you direct access to all library functions. + The function name serves as the hash key and the function delegate + serves as the hash value. + The function name should contain only letters, digits or an underscore. + You should use the method to add functions + to this collection. Do not use the Add method inherited from Hashtable. + The reason is that the hash key needs to be strictly upper case even though + formula syntax is case insensitive with respect to functions names. + Using the AddFunction method makes sure the hash key is properly set. + + + + + A property that gets/sets whether strings concatenated using the '&' operator should be + returned inside double quote marks. + + + + + A property that is used to identify whether the exception thrown or not while calculating the value. + + + + + Gets any Exception raised during the computation of a library function + provided RethrowLibraryComputationExceptions is set true. + + + Use the method to set this property + to null to indicate that there is no pending library exception within the engine. + + + + + Gets / sets whether the engine Rethrows any exception + raised during the computation of a library function. + + The default value is false. + + + + A property that gets or sets the calculations of the computations to mimic the computations of Excel. + + + + + Gets or sets the maximum calculation stack depth. + + + The default is 50. This is the number of recursive calls that can be made during calculations. + + + + Gets or sets a string array that hold the reserved strings + that will be used for the OR, AND, XOR, IF, THEN, ELSE and NOT logical operators. + + Here is the code that you can use to define this string array. This code + shows the default strings that are used. Note that the string must include a leading + and trailing blank, and must be lower case. In formulas that use these operators, + the formulas themselves are case agnostic. + + engine.ReservedWordOperators = new string[] + { + " or ", //0 + " and ", //1 + " xor ", //2 + " if ", //3 + " then ", //4 + " else ", //5 + " not " //6 + }; + + + + + + A static property that gets/sets character by which string starts with, can be treated as formula. + + + + + Enables / disables using row = 0 in formulas to represent the current row. + + + When this property is set True, entering zero as a row in a formula is + interpreted to be the current row. Using the current row notation allows + you to sort a column in the grid and maintain the relative formula. + After sorting, you do have to call engine.RecalculateRange to allow the + relative formulas to reset themselves. + + + + + Below property is used to find the active function name. + + + + + Gets the cell that is being calculated by the Engine. + + You can use this properly within your custom functions to + identify the item in the ICalcData object being computed. + + + + + Gets or sets whether IF function calculations should specifically avoid + computing the non-used alternative. + + + The default value is false for code legacy consistency. When AllowShortCircuitIFs + is set true, only the necessary alternative of an IF function is computed. To support + this behavior, a change in how nested IF function calculations are done is necessary. + The default way of calculating nested functions is inside-out, with the inner most + functions being computed to a value before the next outer function is evaluated. To + support short circuiting IF functions, nested IF functions need to be computed from + the outside-in to know what alternative needs to be evaluated. This outside-in calculation + pattern only applies to IF functions, and only when AllowShortCircuitIFs is true. + + + + + Gets or sets whether FormulaInfo.calcID is tested before + computing a formula during a call to + + When a value changes, then the Refresh method is called on any other + formula that had a dependency on the changed value. During the Refresh call, + the default behavior is to recompute all formulas (AlwaysComputeDuringRefresh = true). + If you are using to strictly control when new values + should be used, then you should set this property to false. For example, if you are + only using exclusively to retrieve computed values, + then setting AlwaysComputeDuringRefresh = false + may be more efficient as it will only recompute the value once during the calculations. + + + + A property that gets/sets whether Formula returns its FormulaValue instead of repeated calculation + + Use this property to return the FormulaValue when a cell contain more depency cells. + + + + + Gets or sets whether Invalid Formula is returned when the calculation stack is not fully exhausted during a calculation. + + + If you enter a formula like "=(1+2)(9+8)", Essential Calculate will compute this formula as 17, ignoring the dangling + 3 value on its calculation stack. If you want this situation flagged as a Invalid Formula, set this CheckDanglingStack property + to true. The default value is false for backward compatibility purposes. + + + + + Used with row ranges to possibly provide the upperlimit on the number of columns in the ICalcData object. + + + Essential Calculate supports column ranges of the form 2:4 as in =SUM(2:4) to represent all cells in rows + 2, 3 and 4 from a ICalcData object. To get a value for the number of columns, the CalcEngine first checks to + see if the ICalcData object supports the ISheetData interface. If this interface is supported, the column + count used to determine the range is obtained through this interface. If the ICalcData object does not support + ISupportColumnCount, then the value of ColumnMaxCount is used provided ColumnMaxCount > 0. If not, the fixed value 50 + is used. + + + + + Gets or sets whether the IF function implementation is called when is true. + The default behavior is to not call the IF Function code in the library, but instead, work directly with the + IF clauses. + + + + + Gets or sets whether must be called on every cells whenever + the is triggered. + The default value is false. + + + When a value changes, then the Refresh method is called recursively every time + the grid_ValuChanged is called. Setting this ForceRefreshCall to false will call + Refresh for only those cells where the calculated value is actually modified. + + + + + A read-only property that gets the collection of FormulaInfo objects being used by the CalcEngine. + + + + + Gets or sets whether leading zeros are preserved in a call to . + + + If the value of arg is "0123" or a cell reference like A1 where A1 holds 0123, then the default behavior + is for GetValueFromArg(arg) to return 123, stripping away any leading zeros. If you want calls to + GetValueFromArg to preserve the leading zeros, then set GetValueFromArgPreserveLeadingZeros to true. + + + + + Gets or sets the maximum number of iterative calls that can be made on a cell. + will be set to true when you set IterationMaxCount to any value other than zero. + + + Essential Calculate supports an iterative process to solve equations of the + form x=f(x). Here you should think of x as being a cell reference like B2 for example. Setting + IterationMaxCount to some value other than zero allows the engine to iteratively compute + f(x) using the previous iteration's calculated value for x. The initial value is either 0 + or the last saved value for a formula in that cell (if the calculation has been performed previously). + The iterations continue until either the iteration count exceeds IterationMaxCount, or two + successive iteration return values have a relative difference less than IterationMaxTolerance. + For example, to have an initial value of 1, you can enter a formula =1 into the cell, and then + enter the self referencing formula into the same cell. This will make the iterative calculations start + at 1 instead of 0. + must be set to true in order for the Iterative Calculation + support to function For this reason, ThrowCircularException will be automatically set to true + when you set a non-zero value to IterationMaxCount. + The default value is 0 indicating that iterative calculation support is turned off. + + + + + Gets or sets the success tolerance used by the CalcEngine's iterative calculation support. + + + Essential Calculate supports an iterative process to solve equations of the + form x=f(x). Here you should think of x as being a cell reference like B2 for example. Setting + IterationMaxCount to some value other than zero allows the engine to iteratively compute + f(x) using the previous iteration's calculated value for x. The initial value is either 0 + or the last saved value for a formula in that cell (if the calculation has been performed previously). + The iterations continue until either the iteration count exceeds IterationMaxCount, or two + successive iteration return values have a relative difference less than IterationMaxTolerance. + The default value is 0.001. + + + + + Gets or sets a value indicating whether editing a cell’s value will update dependent cells.  + + The default value is False. + + If enabled, editing a cell's value will not update dependent cells based on the edited value. + + + + + Used with column ranges to possibly provide the upperlimit on the number of rows in the ICalcData object. + + + Essential Calculate supports column ranges of the form A:D as in =SUM(A:D) to represent all cells in columns + A, B, C and D from a ICalcData object. To get a value for the number of rows, the CalcEngine first checks to + see if the ICalcData object supports the ISheetData interface. If this interface is supported, the row + count used to determine the range is obtained through this interface. If the ICalcData object does not support + ISupportRowCount, then the value of RowMaxCount is used provided RowMaxCount > 0. If not, the fixed value 50 + is used. + + + + + Gets or sets whether OR, AND, XOR and IF THEN ELSE logical + operators are supported. + + + The default value is false for backward compatibility. + + + + + Gets or sets whether ranges can be used as binary operands. + + + If this property is true, Essential Calculate recognizes ranges such + as B1:B5 and A4:E4 as operands of binary operators. So, if you + set the formula = A1:A5 + B1:B5 into cell C4, the calculation + will retrieve the values in A4 and B4 to be used in place of the + corresponding ranges A1:A5 and B1:B5. Note that such ranges must + either have one column wide or one row tall. This fact is used to + make the corresponding lookup determined by where the host cell that holds + the formula is located. This host cell + must either be in the same row or column as some cell in range. + + The default value is false. + + + + + Gets or sets whether sheet range notation is supported. + + + Excel supports sheet range notation such as + = SUM( sheet1:sheet3!A1 ) + Sum( sheet1:sheet3!B1:B4 ). + For backward compatibility with earlier versions that did + not support this sheet range notation, you can set + this SupportsSheetRanges false. + + This implementation replaces a sheet range (sheet1:sheet3!B1:B4) with + list of ranges (sheet1!B1:B4,sheet2!B1:B4,sheet3!B1:B4). + + + + + Gets / sets whether the CalcQuick should throw an exception when a circular calculation is encountered. + + If this property is True, the CalcQuick will throw an exception + when it detects a circular calculation. If ThrowCircularException is False, then + no exception is thrown and the calculation will loop recursively until Engine.MaximumRecursiveCalls + is exceeded. + + + + + A property that gets / sets whether the CalcEngine should track dependencies. + + If you are using the CalEngine in a manner where you always + call PullUpdatedValue to access the computations, then setting UseDependencies + to False will make things more efficient as any requested computed value will + be fully computed every time it is retrieved. In this situation, the CalcEngine + does not need to track dependencies. + + + + + For internal use. + + + + + Gets or sets a value indicating whether [preserve formula]. + + true if [preserve formula]; otherwise, false. + + + + A static property that gets/sets character to be recognized by the parsing code as the delimiter for arguments in a named formula's argument list + + + + + A static property that gets/sets the character to be recognized by the parsing engine as decimal separator for numbers. + + + + + A static property that gets/sets the character to be recognized by the parsing engine as decimal separator for date. + + + + + A property that gets/sets list of # error strings recognized by Excel. + + + + + A read-only property that gets a mapping between a cell and a list of formula cells that depend on it. + + + The key is the given cell, and the value is a ArrayList of cells containing + formulas that reference this cell. + + Here is code that will list formula cells affected by changing the given cell. + + public void DisplayAllAffectedCells() + { + CalcEngine engine = ((GridFormulaCellModel)this.gridControl1.CellModels["FormulaCell"]).Engine; + foreach(object o in engine.DependentCells.Keys) + { + string s1 = o as string; + Console.Write(s1 + " affects "); + ArrayList ht = (ArrayList) engine.DependentCells[s1]; + foreach(object o1 in ht) + { + string s2 = o1 as string; + Console.Write(s2 + " "); + } + Console.WriteLine(""); + } + } + + + Public Sub DisplayAllAffectedCells() + Dim engine As GridCalcEngine = CType(Me.gridControl1.CellModels("FormulaCell"), GridFormulaCellModel).Engine + Dim o As Object + For Each o In engine.DependentCells.Keys + Dim s1 As String = CStr(o) + Console.Write((s1 + " affects ")) + Dim ht As ArrayList = CType(engine.DependentCells(s1), ArrayList) + Dim o1 As Object + For Each o1 In ht + Dim s2 As String = CStr(o1) + Console.Write((s2 + " ")) + Next o1 + Console.WriteLine("") + Next o + End Sub 'DisplayAllAffectedCells + + + + + + A read-only property that gets a mapping between a formula cell and a list of cells upon which it depends. + + + The key is the given formula cell and the value is a Hashtable of cells that this + formula cell references. + + Here is code that will lists formula cells affected by changing a given cell: + + public void DisplayAllFormulaDependencies() + { + GridCalcEngine engine = ((GridFormulaCellModel)this.gridControl1.CellModels["FormulaCell"]).Engine; + foreach(object o in engine.DependentFormulaCells.Keys) + { + string s1 = o as string; + Console.Write(s1 + " depends upon "); + Hashtable ht = (Hashtable) engine.DependentFormulaCells[s1]; + foreach(object o1 in ht.Keys) + { + string s2 = o1 as string; + Console.Write(s2 + " "); + } + Console.WriteLine(""); + } + } + + + Public Sub DisplayAllFormulaDependencies() + Dim engine As GridCalcEngine = CType(Me.gridControl1.CellModels("FormulaCell"), GridFormulaCellModel).Engine + + Dim o As Object + For Each o In engine.DependentFormulaCells.Keys + Dim s1 As String = CStr(o) + Console.Write((s1 + " depends upon ")) + Dim ht As Hashtable = CType(engine.DependentFormulaCells(s1), Hashtable) + Dim o1 As Object + For Each o1 In ht.Keys + Dim s2 As String = CStr(o1) + Console.Write((s2 + " ")) + Next o1 + Console.WriteLine("") + Next o + End Sub 'DisplayAllFormulaDependencies + + + + + + A property that gets/sets the current named ranges. + + + + + Delegate used to define functions that you add to the function library. + + Resultant value. + + + + Specifies the options for checking the formula error strings. + + + + + Formula contains null arguments. For Example:PI,RANDOM...etc + + + + + Formula contains range argument. For example:MEDIAN,...etc + + + + + Formula contains two text arguments with Number argument. For example:FIND,SEARCH...etc + + + + + Formula contains number and text arguments. For example:LEFT,RIGHT...etc + + + + + Formula contains number arguments only. For example:ABS,ROUND,ROUNDDOWN,LOG...etc + + + + + Formula contains text arguments only. For example:ARABIC,CLEAN...etc + + + + + Formula contains Date argument. For example:DISC,...etc + + + + + Compares 2 strings based on their length. + + 0, if both strings are equal; positive value if second string is greater; neagative value if first string is greater. + + + + An event handler that represents the method to handle the + event. + + The source of the event. + A that contains the event data. + + + + A class containing data for the ICalcData.ValueChanged event. + + + + + The constructor. + + One-based row index for the value. + One-based col index for the value. + the value at the specified row,col. + + + + A property that gets/sets One-base column index. + + + + + A property that gets/sets One-based row index. + + + + + A property that gets/sets the value. + + + + + Used for CalcEngineHelper + + + + + Returns a DateTime equivalent to the specified OLE Automation Date. + + An OLE Automation Date value. + An object that represents the same date and time as d. + + + + Converts the value of this instance to the equivalent OLE Automation date. + + + A double-precision floating-point number that contains an OLE Automation date equivalent to the value of this instance. + + + + Specifies options for caching look up tables in HLookUp and VLookUp functions. + + + + + No caching is done. + + + + + Tables will be cached only for VLookUp. + + + + + Tables will be cached only for HLookUp. + + + + + Tables will be cached for both VLookUp and HLookUp. + + + + + Tables will be optimized for searching for exact matches. Set this flag if you expect your searches to find exact matches. + + + + + RangeInfo represents a rectangle array of cells that may contain formulas, strings, or numbers + that may be referenced by other formulas. + + + + + Constructs a RangeInfo instance with the given top, left, bottom and right values. + + Top row index of this range. + Left column index of this range. + Bottom row index of this range. + Right column index of this range. + The range values must be one-based indexes. + + + + A method to retrieve a range based on the numeric arguments passed in. + + Top row index of this range. + Left column index of this range. + Bottom row index of this range. + Right column index of this range. + A RangeInfo object. + The range values must be one-based indexes. + + + + GetAlphaLabel is a method that retrieves a string value for the column whose numerical index is passed in. + + Number index such as 1, 5, 27. + Corresponding alphabets label like A, E, AA. + + + + A property that gets/sets the bottom row index of this range. + + + + + A property that gets/sets the left column index of this range. + + + + + A property that gets/sets the right row index of this range. + + + + + A property that gets/sets the top row index of this range. + + + + + ICalcData defines the minimal interface that a data object must support in order to use + this formula engine. + + + + + A method that gets the data value from the specified row and column. + + 1-based index specifying the row index of the requested value. + + 1-based index specifying the column index of the requested data. + The data value at the given row and column index. + + + + A method that sets the data value to the specified row and column. + + The value. + One-based index specifying the row index of the value. + One-based index specifying the column index of the value. + + + + A method that wires the ParentObject after the CalcEngine object is created or when a + RegisterGridAsSheet call is made. + + This method is a callback to the ParentObject so it can have a chance + to subscribe to any change events it may need to implement ValueChanged properly. + + + + + Event for value changed + + + + + Used in conjunction with . + + + Essential Calculate supports column ranges of the form A:D as in =SUM(A:D) to represent all cells in columns + A, B, C and D from a ICalcData object. To get a value for the number of rows, the CalcEngine first checks to + see if the ICalcData object supports the ISheetData interface. If this interface is supported, the row + count used to determine the range is obtained through this interface. If the ICalcData object does not support + ISheetData, then the value of is used provided RowMaxCount > 0. + and the index of first and last rows and columns + is used. + + + + + Get the idex of the first row in UsedRange + + index of first row + + + + get the index of the last row in UsedRange + + index of last row + + + + Gets the row count. + + Number of rows + + + + Gets the first column index. + + Index of first column + + + + Gets the last column index / column count. + + Index of last column + + + + Gets the column count. + + Number of columns + + + + Performs the calculation of LINEST formula. + + + + + Gets or sets the instance of . + + + + + Initialize the object for parsing operations. + + An instance of . + + + + + This method is used to split the range and logical value when the range contains logical value. + + Range with logical value(ex:\u0092C1:C3\"1,2\"m\u0092) + Spilt the range ex("C1:C3") + Split the logical value ex("\"1,2\"m") + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Denotes the different error types. + + + + + Denotes no error + + + + + Denotes missing right quote + + + + + Denotes mismatched parentheses + + + + + Denotes that it cannot compare different types + + + + + Denotes that it's a unknown operator + + + + + Denotes that it's not a valid formula + + + + + Denotes that exception has raised + + + + + This class encapsulates the support for computing filter values and expressions. + + + + + Initializes a new instance of the FilterHelper class. + + + + + Adds a filter expression. + + The name of filter expression. + A string holding a well-formed logical expression. + + + + Removes a filter expression. + + The name of the filter expression to be removed. + Returns true if the expression was successfully removed; otherwise, false. + + + + Clears all filter expressions. + + + + + Gets or sets value to indicate whether the expression should be treated in a case-sensitive manner. The default value is true. + + + + + Gets the number of filter expressions contained in this helper class. + + + + + Gets the particular filter expression in the order it was added. + + The index of desired filter expression. + The filter expression. + + + + This class encapsulates the information needed to define a filter. + + + + + Initializes a new instance of the FilterExpression class. + + + + + Initializes a new instance of the FilterExpression class with the field name of a PivotItem. + + Field name of the PivotItem. + + + + Initializes a new instance of the FilterExpression class with the field name, field header and expression of a PivotItem. + + Field name of the PivotItem. + Field header of the PivotItem. + Logical expression defining the filter. + + + + Initializes a new instance of the FilterExpression class with the field name, field header, expression and format of a PivotItem. + + Field name of the PivotItem. + Field header of the PivotItem. + Logical expression defining the filter. + Format of the filter expression. + + + + Initializes a new instance of the FilterExpression class with the field name and expression of a PivotItem. + + Field name of the PivotItem. + Logical expression defining the filter. + + + + Use this method to retrieve the computed value of this expression on an object. + + The object to be evaluated. + Used to provide the support for calculation. + Represents the boolean value. + The computed value. + + The first time this method is called, a delegate for the FilterExpression is created, and then this delegate + call is passed into the component. Subsequent calls to this method just result into the existing delegate call. + + + + + Used to calculate the value. + + + + + Gets or sets the field name of the PivotItem. + + + + + Gets or sets the format of the filter expression. + + + + + Gets or sets the field header. + + + + + Gets or sets the field caption. + + + + + Evaluates the given value. + + + + + Gets the last error that was logged during the compilation and calculation phase. + + + + + Gets a descriptive string for the last occurred error. + + + + + Gets or sets the name of this filter expression. + + + + + Gets or sets the well-formed logical expression that defines this filter expression. + + + + + Gets or sets other information related to filter expression. + + Filter expression information + + + + Gets or sets whether the expression should be treated in a case-sensitive manner. + + + + + Gets the compiled expression. + NOTE: + 1) The logical operators AND, OR, NOT must be sandwiched between blanks, and either all caps, no caps, or first cap only. + 2) To use column names as AND, OR, NOT, they must be included in [] bracket. + 3) For any other column name, the brackets are optional. + + The ItemSource. + if set to true [case sensitive]. + The formula. + The error. + Delegate. + + + + Gets the dynamic value. + + ItemSource object. + Property name of the object. + An object + + + + Gets the double value of the PivotItem. + + ItemSource object. + Property name of the object. + A double value. + + + + To check in the list of objects using binary search. + + Object to check. + Binary search list. + List of binary objects. + + + + Pass in a string containing a left or right part, and get an expression back. + + + + + Replaces strings in formulas with tokens so that the string remains immutable during parsing. + + The formula with quoted strings. + Error code if any. + A string that represents the formula with quoted strings replaced by tokens. + + + + Gets or sets a collection of property types associated with an expando object/dynamic object available in .NET Framework 4.0. + + + + + Gets or sets the list of separated items using list separator ','. + + + + + Gets the compiled expression. + NOTE: + 1) The logical operators AND, OR, NOT must be sandwiched between blanks, and either all caps, no caps, or first cap only. + 2) To use column names as AND, OR, NOT, they must be included in [] bracket. + 3) For any other column name, the brackets are optional. + + The ItemSource. + if set to true [case sensitive]. + The formula. + The error. + Delegate. + + + + Gets the dynamic value. + + ItemSource object. + Property name of the object. + An object + + + + Gets the double value. + + ItemSource object. + Property name of the object. + A double value. + + + + This method is used to check the list of objects greater than -1 using binary search. + + This parameter is used pass the objects to check. + Using this parameter we can add list of string. + List of binary objects greater than -1. + + + + Pass in a string containing left or right part, and get an expression back. + + + + + Replaces strings in formulas with tokens so that the string remains immutable during parsing. + + The formula with quoted strings. + Error code if any. + A string that represents the formula with quoted strings replaced by tokens. + + + + Gets or sets a collection of property types associated with an expando object/dynamic object available in .NET Framework 4.0. + + + + + This property is used to split the list of items using this special character ','. + + + + + Controls whether a summary calculation is to be displayed for all levels or only for the inner-most level. + + + + + Indicates to display the summary at all Pivot levels. + + + + + Indicates to display the summary at only the inner most Pivot level. + + + + + Enumerates the summary types available for calculations in the Pivot control. If you use the value "Custom" in a ComputationInfo object, then you are required to explicitly set the ComputationInfo.Summary value. + + + + + Computes the sum of double or integer values. + + + + + Computes the simple average of double or integer values. + + + + + Computes the maximum of double or integer values. + + + + + Computes the minimum of double or integer values. + + + + + Computes the standard deviation of double or integer values. + + + + + Computes the variance of double or integer values. + + + + + Computes the count of double or integer values. + + + + + Computes the sum of decimal values. + + + + + Computes the sum of integer values. + + + + + Specifies that you are using a custom SummaryBase object to define the calculation. + + + + + Displays the common value if all the values to be aggregated are the same, and displays a + if the values to be aggregated are not all the same. + + + + + Computes the sum of values. + + + + + Computes the average of values. + + + + + Computes the maximum of values. + + + + + Computes the minimum of values. + + + + + Computes the count of integer values. + + + + + Computes the standard deviation of values if data set contains a sample of the population. + + + + + Computes the standard deviation of values if data set contains a complete population. + + + + + Computes the variance of values if data set contains a sample of the population. + + + + + Computes the variance of values if data set contains a complete population. + + + + + Calculation type defines the view for a particular computational object (or value field). + + + + + Remove the custom calculations and restore to original values. + + + + + Displays a value cell as a percentage of grand total of all value cells of PivotEngine. + + + + + Displays all value cells in each column as a percentage of its corresponding column total. + + + + + Displays all value cells in each row as a percentage of its corresponding row total. + + + + + Displays a value cell as a percentage of parent column item values. + + + + + Displays a value cell as a percentage of parent row item values. + + + + + Displays a value cell as a percentage of BaseField (Parent Row/Column Total). + + + + + Displays a value cell as an index value based on PivotEngine generation. + + + + + Displays a calculation based on a well formed algebraic expression involving other calculations. + + + + + Displays values as a percentage of the value of the BaseItem in the BaseField. + + + + + Displays values as the difference from the value of the BaseItem in the BaseField. + + + + + Displays values as the percentage difference from the value of the BaseItem in the BaseField. + + + + + Displays the value of successive items in the BaseField as a running total. + + + + + Calculates the value of successive items in the BaseField that are displayed as a running total as a percentage. + + + + + Displays the rank of selected values in a specific field, listing the smallest item in the field as 1 and each larger value will have a higher rank value. + + + + + Displays the rank of selected values in a specific field, listing the largest item in the field as 1 and each smaller value will have a higher rank value. + + + + + Displays the subtotals based on the distinct values of BaseItem defined for calculation item. + + + + + Used to provide a list of display option. + + + + + Fully present in the PivotEngine but not seen in the display. + + + + + Fully present in the PivotEngine but visible only in the calculation region. + + + + + Fully present in the PivotEngine but visible only in the interior summary region. + + + + + Fully present in the PivotEngine but visible only in the GrandTotal region. + + + + + Fully present in the PivotEngine and completely available for display. + + + + + Use this interface to enable shortcut calculations to adjust a summary when an underlying + value changes. The idea is to avoid re-computing the summary from scratch. For example, if + your summary computes the total of a set of values, you can quickly adjust this computed + total when a value changes by subtracting the old value and adding the new value without + having to re-compute the total from scratch. Not all types of calculations lend themselves + to this shortcut behavior. + + + + + Adjusts the summary for a change in one of its underlying values. + + The new value of the changed field. + + + + Adjusts the summary for a change in one of its underlying values. + + The old value of the changed field. + + + + This class holds the information needed for the calculations that appear in a Pivot control. For each calculation seen, there is an associated + PivotComputationInfo object that is added to the PivotComputationInfo collection. + + + + + Performs certain manipulations with data using summary type. + + + + + Returns a object of the specified . + + The SummaryType. + A SummaryBase object. + + + + Converts to string + + Calculation name displayed in the PivotTable. + + + + Returns a sorted list of computation names based on the enumerations. + + A list of computation names. + + + + This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the to the class. + + + An that describes the XML representation of the object that is produced by the method and consumed by the method. + + + + + Generates an object from its XML representation. + + The stream from which the object is deserialized. + + + + Converts an object into its XML representation. + + The stream to which the object is serialized. + + + + Event denoting whether the property is changed. + + + + + Gets or sets whether this calculation column can be sorted when + RowPivotsOnly is true in the PivotEngine. + + + + + Gets or sets whether this calculation column can be filtered when + RowPivotsOnly is true in the PivotEngine. + + + + + Gets or sets whether this calculation column only displays the subtotals for top column + + + + + Gets or sets whether this calculation column should be hyperlinked when RowPivotsOnly is true in the PivotEngine. + + + + + Gets or sets the name of the property to be used in this calculation. + + + + + Gets or sets the title you want to see in the header for this item. + + + + + Gets or sets the title you want to see in the header for this item. + + + + + Gets or sets a description for this calculation. + + + + + Gets or sets whether the aggregation result should appear only for the innermost level. + + + + + This is used to specify a custom string in the PivotComputation column instead of the original cell value. + To use this, we must set SummaryType as DisplayIfDiscreteValuesEqual. + + + + + Gets or sets what needs displayed in the PivotTable if more than one calculation is included in the Pivot control. + + + + + Gets or sets value to enable/disable grouping for this PivotItem. Default value is true. + + + + + Gets or sets the object that is used to define this calculation. This value is automatically set + when you specify any non-custom value of . If you specify SummaryType.Custom, then you are required + to set Summary to be an instance of your custom SummaryBase derived object. + + + + + Gets or sets the SummaryType enumeration for this calculation. Setting it to any value other than "Custom" + will properly set the summary. + + + + + This is used to display or hide the computation values in PivotEngine based on the option provided. + + + + + Gets or sets the calculation type for this computation object. + + + + + Gets or sets the value of base field for calculations. + + + + + Gets or sets the value of base item for calculations. + + + + + Gets or sets a formula that defines the value as an algebraic expression of other computations where these + computations are referenced by their enclosed within square brackets. + + + For example, if the value of formula is "[AvgPrice]-[AvgCost]", then there should be two other computations whose names are + AvgPrice and AvgCost, and the value displayed for this computation should be the difference between those two values. + + + + + Used internally for formula calculation types. + + + + + Gets or sets the value of field type. + + + + + Gets or sets the format string used to format this calculation results in the Pivot control. Default format string is #.##. + + + + + Gets or sets the default value to be used when this summary calculation gets null value. + + + + + This is an abstract class that defines the necessary functionality to do PivotCalculations. + + + + + Use this method to combine a value from an object in the Pivot control data source with the accumulation values held in this instance. + + The value to be included in the computation. + + + + Resets all internal values so the calculations begins as new. + + + + + Returns the calculation value. + + The calculation value. + + + + Provides a new instance of this SummaryBase object. + + New instance of this SummaryBase. + + + + Use this method to combine another SummaryBase object with the accumulation values held in this instance. + + The other SummaryBase object. + + + + Gets or sets whether the Pivot control should display null value as blank instead of 0 (which is the default behavior). + + + + + Computes the count of double or integer values. + + + + + Converts data to string. + + string + + + + Combines different values into one. + + + + + Combines the summaries into one. + + SummaryBase + + + + Resets the value of the variables. + + + + + Obtains the count value. + + Count + + + + Gets the instance of the class. + + Total summary value + + + + Gets to adjust for the new value. + + Object + + + + Gets to adjust for the old value. + + Object + + + + This class is used to compute the minimum of double or integer values. + + + + + Converts the value to string. + + + + + Combines different values together. + + Object + + + + Combines the different summaries into one. + + SummaryBase + + + + Resets the value of the variables. + + + + + Obtains the minimum value. + + + + + Gets the instance of type DoubleMinSummary. + + DoubleMinSummary + + + + This class is used to compute the maximum of double or integer values. + + + + + Converts the value to string + + string + + + + Combines the different values together for maximum summary. + + + + + Combines the different summaries together. + + + + + Resets the value of the variables. + + + + + Obtains the maximum value. + + + + + Returns the instance of type DoubleMaxSummary. + + + + + This class is used to compute the standard deviation of double or integer values. + + + + + Converts data to string. + + + + + Combines the different values together. + + + + + Combines the different summaries together. + + + + + Resets the value of the variables. + + + + + Obtains the standard deviation value. + + + + + Returns the instance of type DoubleStDevSummary. + + + + + This class is used to compute the variance of double or integer values. + + + + + Converts data to string. + + + + + Combines different values together. + + + + + Combines the different summaries together. + + + + + Resets the value of the variables. + + + + + Obtains the variance value. + + + + + Returns the instance of type DoubleVarianceSummary. + + + + + This class is used to compute the average of double or integer values. + + + + + Converts data to string. + + + + + + Combines different values together. + + + + + + Combines different summaries into one. + + SummaryBase + + + + Resets the value of the variables. + + + + + Obtains the average value. + + Average value. + + + + Returns the instance of type DoubleAverageSummary. + + DoubleAverageSummary + + + + Gets to adjust for the new value. + + Object + + + + Gets to adjust for the old value. + + Object + + + + This class is used to compute the sum of double or integer values. + + + + + Returns the string for the concerned data. + + string + + + + Combines different values together. + + + + + + Combines different summaries into one. + + SummaryBase + + + + Resets the value of the variables. + + + + + Obtains the sum/total value. + + Sum/total value. + + + + Returns the instance of type DoubleTotalSummary. + + DoubleTotalSummary + + + + Gets to adjust for the new value. + + Object + + + + Gets to adjust for the old value. + + Object + + + + This class is used to compute the sum of integer values. + + + + + Converts to the string type. + + + + + + Combines different values together. + + Object + + + + Combines different Summary into one. + + SummaryBase + + + + Resets the value of the variables. + + + + + Obtains the sum/total value. + + Sum/total value. + + + + Returns the instance of type IntTotalSummary. + + + + + + Gets to adjust for the new value. + + Object + + + + Gets to adjust for the old value. + + Object + + + + This class is used to computes the sum of decimal values. + + + + + Converts the data to string. + + + + + + Combines the different values together. + + Object. + + + + Combines the summaries together. + + SummaryBase + + + + Resets the value of the variables. + + + + + Obtains the sum/total value. + + Sum/total value. + + + + Returns the instance of type DecimalTotalSummary. + + DecimalTotalSummary + + + + Gets to adjust for the new value. + + Object + + + + Gets to adjust for the old value. + + Object + + + + Displays the aggregated value in the PivotComputation column, if all the values are aggregated to be same + else the value in PadString property is displayed. + + + + + Displays if the discrete values are equal. + + + + + Combines the different values together. + + Object + + + + Resets the value for the variables. + + + + + Obtains the resultant value. + + + + + + Returns the instance of type DisplayIfDiscreteValuesEqual. + + + + + + Combines the different summaries into one. + + + + + + Returns the padded string + + + + + Displays the sum of values + + + + + Converts to the string type + + + + + + Combines different values together + + object + + + + Combines different Summary + + SummaryBase + + + + Resets the variable + + + + + Obtains the result + + + + + + Obtains the instance of Sum. + + Sum + + + + Displays the Average of values + + + + + Converts the data to string type + + + + + + Merges the values. + + + + + + Combines the different summaries into one. + + SummaryBase + + + + Resets the total and count. + + + + + Gets the result. + + result + + + + Gets the instance of the object. + + Average + + + + Displays the maximum value of given values + + + + + Converts the value to string type + + string + + + + Combines the different values together for maximum summary. + + + + + Combines the different summaries together. + + + + + Resets the value of the variables. + + + + + Obtains the maximum value. + + + + + Returns the instance of type Max. + + + + + Displays the minimum value of given values + + + + + Converts the value to string type + + string + + + + Combines the different values together for minimum summary. + + + + + Combines the different summaries together. + + + + + Resets the value of the variables. + + + + + Obtains the minimum value. + + + + + Returns the instance of type Min. + + + + + Displays the Variance of given values + + + + + Converts data to string. + + + + + Combines the different values together. + + + + + Combines the different summaries together. + + + + + Resets the value of the variables. + + + + + Obtains the variance of given value. + + + + + Returns the instance of type Variance. + + + + + Displays the VarianceP of given values + + + + + Converts data to string. + + + + + Combines the different values together. + + + + + Combines the different summaries together. + + + + + Resets the value of the variables. + + + + + Obtains the variance population of given value. + + + + + Returns the instance of type VarianceP. + + + + + Displays the standard deviation of given values + + + + + Converts data to string. + + + + + Combines the different values together. + + + + + Combines the different summaries together. + + + + + Resets the value of the variables. + + + + + Obtains the standard deviation value. + + + + + Returns the instance of type StDev. + + + + + Displays the standard deviation population of given values + + + + + Converts data to string. + + + + + Combines the different values together. + + + + + Combines the different summaries together. + + + + + Resets the value of the variables. + + + + + Obtains the standard deviation population value. + + + + + Returns the instance of type StDevP. + + + + + Event handler for the event. + + The PivotEngine raising the event. + The event arguments. + + + + Enumerates the possible Pivot cell types. + + + + + Cell holds a summary value. + + + + + Cell is a row/column header that holds an expander. + + + + + Cell is a row/column header that does not holds an expander. + + + + + Cell is the top left portion of the PivotTable. + + + + + Cell is a row/column header that marks a total row or column. + + + + + Cell is a header cell holding a calculation name. + + + + + Row header cell. + + + + + Column header cell. + + + + + Grand total cell. + + + + + Specifies the layout for the Pivot control. + + + + + Sub-totals will be shown after the details. + + + + + Sub-totals will be shown before the details. + + + + + Grid Layout will be like excel. + + + + + Information on what changes have occurred in the Pivot Schema. + + + + + No specific information available about the change. The entire engine should be populated to ensure the change is properly reflected. + + + + + Indicate the engine's property has changed. + + + + + Indicate that the engine should refresh because of a new row being added. + + + + + Indicate that the engine should re-populate based on selected calculation type. + + + + + Indicate that the engine should re-populate the headers based on field headers. + + + + + Enum holding the field types. + + + + + Gets whether the field is Property. + + + + + Gets whether the field is Expression. + + + + + Gets whether the field is Unbound. + + + + + This class encapsulates pivoting calculation support. To use it, first populate the and + collections to define the properties being pivoted. Then you populate the + collection to define the values you would like to see populated. + + + + + List that holds the sorted column indexes. + + + + + List that holds column indexes. + + + + + Value that indicates the maximum number of rows should be displayed. + + + + + Used to fill/re-fill the ItemProperties with newly added/updated fields. + + + + + Adds a to the Pivot Schema of this Engine. + + The filter expression. + + + + Inserts a to the Pivot Schema for this Engine at a specified index. + + The index position. + The filter expression. + + + + Removes a from the Pivot Schema for the engine. + + The filter expression. + + + + Clears all filter expressions from the Pivot Schema for the engine. + + + + + Finds a in by its name. + + The name of the desired filter expression. + The filter expression. + + + + Gets the object associated with a particular cell + in the PivotTable. The PivotCellInfo object contains value and formatted text properties information. + + Row index of the cell. + Column index of the cell. + if set to true [should calculate total]. + A PivotCellInfo object that contains information about the cell contents. + + + + When "EnableOnDemandCalculations" is true, calling this method will ensure that all the summary calculations are fully computed. + This is used internally. + + + + + When is true, this method will compute all summary calculation for the first row that has not been calculated yet. + + Returns true if all the rows have their summary calculation completed; otherwise, false. + + + + Adds the field to "AllowedFields" property. + + FieldInfo + + + + Returns the collection of objects which are currently used in the Grid. + + List of filter items collection. + Collection of objects currently used. + + + + Returns the row and column PivotValues at the specified cell index. + + The row index of Pivot values. + The column index of Pivot values. + Name of the PivotField at the specified row and column index. + List of values at the specified row and column index. + + + + Returns the collection of raw items for specified rows and columns in the Grid. + + The row index. + The column index. + Collection of raw items. + + + + Removes the allowed field from Grid. + + The field to remove. + + + + Contains the default properties for the items in the DataSource. + + + + + Clears the allowed fields in the Pivot control. + + + + + Suspends calculations as PivotItems are added or removed from either RowPivots or ColumnPivots + collections or when PivotCalculations are added or removed from the PivotCalculations collection. + + + By default, calculations are always suspended. Once you have populated all the appropriate collections + to define your PivotTable, you can call method to tell the engine to generate the PivotTable + contents that you can access by indexing the engine. + + + + + Resumes calculations after a call to suspend computations without re-setting the PivotTable. + + + + + Resumes calculations after a call to suspend computations with the option of re-setting the PivotTable. + + Returns true if the PivotTable should be recomputed; otherwise, false. + + + + Resumes calculations after a call to "SuspendComputations" method with an option of re-setting the PivotTable. + + Returns true if the PivotTable should be recomputed; otherwise, false. + Returns true if the Pivot control should be refreshed; otherwise, false. + + + + Using this method we can populate the values of the current PivotTable. + + + Once you have populated the PivotColumns, PivotRows and PivotCalculations collections, you + call this method to actually populate this engine with the PivotCalculations. After this call, + you can then access information on the contents of any cell by indexing the engine object. The + indexers are zero based. + + + + + Resets the PivotTable and its collections. + + + + + Method to dispose the PivotEngine resources in order to release the unmanaged memory. + + + + + Adds calculation to the PivotCalculations collection. + + The calculation field. + + + + Inserts calculation at a specified index. + + Index to insert the calculation field. + The calculation field. + + + + Removes calculation from the PivotCalculations collection. + + The calculation field. + + + + Adds PivotItem to the PivotRows collection. + + The item to be added. + + + + Inserts a PivotItem to the PivotRows collection at a specified index. + + The index to insert PivotItem into PivotRows. + The PivotItem. + + + + Removes a PivotItem from the PivotRows collection. + + The item to be removed. + + + + Adds a PivotItem to the PivotColumns collection. + + The item to be added. + + + + Inserts a PivotItem to the PivotColumns collection at a specified index. + + The index to insert PivotItem into PivotColumns. + The item to be added. + + + + Removes a PivotItem from the PivotColumns collection. + + The item to be removed. + + + + Returns the list of raw values. + + The row index. + the column index. + The raw items. + + + + Populates the value cells. + + + + + Updates the calculated value based on the "CalculationType" of the computation object. + + The row index. + The column index. + The new value. + Name of the field. + The formatted text. + + + + Calculated the cell value based on the formula given to the computation. + + The row index. + The column index. + The column index from pivot engine. + The pivot computation information. + + + + Generates the covered ranges of each column header cell. + + + + + Generates the covered ranges of grand total cell. + + + + + Generates the covered ranges of each row header cell. + + + + + Re-arrange the PivotValues for column when grid layout is TopSummary. + + + + + Re-arrange the PivotValues for row when GridLayout is TopSummary. + + + + + Checks whether the column is summary column or not. + + Index of the column. + Returns true if it's summary column; otherwise, false. + + + + Checks whether the column is summary column or not. + + Index of the column. + The argument to be passed by reference. + Returns true if it's summary column; otherwise, false. + + + + Checks whether the column is summary column or not, when on-demand operation is performed. + + Index of the column. + The argument to be passed by reference. + Returns true if it's summary column; otherwise, false. + + + + Checks whether the column is summary column or not, when GridLayout is TopSummary. + + Index of the column. + Returns true if it's summary column; otherwise, false. + + + + Checks whether the row is summary row or not, when GridLayout is TopSummary. + + Index of the row. + Returns true if it's summary row; otherwise, false. + + + + Checks whether the row is summary row or not. + + Index of the row. + The argument to be passed by reference. + Returns true if it's summary row; otherwise, false. + + + + Checks whether the row is summary row or not, when on-demand operation is performed. + + Index of the row. + The argument to be passed by reference. + Returns true if it's summary row; otherwise, false. + + + + Checks whether the row at the specified index is summary row or not. + + Index of the row. + Returns true if it's summary row; otherwise, false. + + + + Adds a comparer for the specific PivotItem. + + Property type of the PivotItem. + + + + Gets the sort direction of a particular column, even if the column has been moved from its initial position. This is used only when "RowPivotsOnly" is set to true. + + + + + Clears all the sorted order in Grid. + + + + + Clears the sort at the specified index. + + The specified index. + + + + Returns the sorted columns count. + + Column count. + + + + Returns the original position of the column in the PivotCalculations collection. + This is only used when "RowPivotsOnly" is set to true. + + The current position of the column in the display. + Returns the original position of the column as determined + by its position in the PivotCalculations collection. + + + + Checks whether a column at the given index, in the display, is sorted or not. + + The index of the column in the display. + Returns true if sorted; otherwise, false. + + + + Checks whether a column at the given index is filterable. This is used only when "RowPivotsOnly" is set to true. + + The index of the column in the display. + Returns true if the column can be filtered; otherwise, false. + + + + Checks whether a column at the given index is sortable. This is used only when "RowPivotsOnly" is set to true. + + The index of the column in the display. + Returns true if the column can be sorted, otherwise, false. + + + + Returns the field name at a given column even if the column has been moved from its original + position. This is used only when "RowPivotsOnly" is set to true. + + The index of the column. + The field name at the specified index. + + + + This method is used internally within the Syncfusion library code to adjust column indexes. + + Old index position. + New index position. + + + + Sort different values by calculation based on column index. + + The column index. + + + + Sort different values by calculation based on column index and multi-column sorting. + + The column index. + Returns true if multi-column sorting operation is done; otherwise, false. + + + + Sort different values by calculation based on column index, multi-column sorting and sort direction. + + The column index. + Returns true if multi-column sorting operation is done; otherwise, false. + Specifies the sort direction. + + + + Performs sorting operation in column header. + + The index of column header. + + + + This method will re-compute all the summaries ignoring certain summary row whose index is + in "HiddenRowIndexes". + + + + + Gets the hidden rows key values. + + Count of the hidden PivotRows. + + + + Gets the un-indexed "PivotCellInfo". + + Row index. + Column index. + PivotCellInfo + + + + Raises the event. + + The event argument. + + + + Raises the event. + + The event argument. + + + + To be maintain the row summary's index and returns the bool value. + + Denotes the row index. + + + + To be maintain the column summary's index and returns the bool value. + + Denotes the column index. + + + + Initialize the summary if the keys are not available in . + + Specify the index of the row. + Specify the index of the column. + + + + Generates the covered ranges of each row header cell. + + + + + Event raised whenever the Pivot Schema of the Engine is changed. + + + + + Event triggered when the property of the cell is changed. + + + + + Gets or sets the item property info. + + + + + Gets or sets the IndexEngine. IndexEngine provides a way to access the object from the PivotEngine class in-order to perform the on-demand process. + + + + + Gets or sets a delegate that returns a property value for a given object. + + + If this member is null, the IndexEngine will use reflection to obtain property values from objects in + the . NOTE: Usually a well written delegate can provide values more efficiently + than using reflection. For performance improvements, you will want to provide a well written delegate for + this property. + + + + + Gets or sets a value to indicate whether the data should be loaded in an optimized way to render huge data with less time consumption. + + + Setting this property indicates that the PivotEngine should populate the data based on combining the population logics used in both PivotEngine and IndexEngine. + There is no need to set the properties "UseIndexedEngine" and "EnableOnDemandCalculations" is true when using the property "EnableDataOptimization". + This feature will work significantly with less time consumption to populate and the render the values even using large pivots. + + + + + Gets or sets whether an optimized algorithm that relies on indexing the raw + data used to compute the Pivot information. + + Setting this property indicates that the PivotEngine should use a newer way of computing + the Pivot information. This technique requires more memory but will work significantly quicker + for Pivots that have a large number of cells. For smaller Pivots, there is no gain in performance + with this newer technique. + + + + + + Gets or sets the formatted total value for the sub-total/grand total cells. + + + + + Gets or sets the edited cells information. + + + + + Gets or sets whether the DataSource is a collection of dynamic objects supported in the .NET Framework 4.0. + + + + + Gets or sets value to show/hide grand totals. + + + Default value is true. + + + + + Gets or sets value to indicate whether sub-totals should be shown at the top or bottom. + + + Default value is Normal. + + + + + Gets or sets a value to indicate whether calculation header should be shown/hidden when there is a single calculation. + The default value is false. This property does not affect the settings when "UseIndexedEngine" is set to true. + + + + + When setting the EnableOnDemandCalculations property to true, it allows the UI to trigger the summary calculations + during the application idle cycles. + + + This means that the summaries in the Pivot control may be fully populated when the user does something like sort/filter a PivotItem + which avoids a delay. If EnableOnDemandCalculations is false, setting this property has no effect. + + + + + Gets or sets whether the calculations are postponed until the value is requested through the Indexer on PivotEngine. The default value is false. + + + The default calculation behavior is for all the value cells to be populated during the call to PivotEngine.Calculate. When EnableOnDemandCalculations + is set true, then the calculations are postponed until there is an initial request for a calculated value. At that time, the calculation is completed + and stored. Subsequent requests for a value return the stored value instead of redoing the calculations. + + Setting the EnableOnDemandCalculations allows the initial display of a large pivot table as only the visible cells will need to be calculated. This + speed up in initial display, does come at the cost of a slight degradation in first-time scrolling performance as the cells that are newly made visible + through the scrolling require a calculation to be completed. This setting is not available when RowPivotsOnly is false. + + + + + Gets or sets whether PivotGrid control should hide the sub-totals in engine level when setting the property ShowSubTotals to false. + + + The default value is false. + + + + + Gets or sets whether PivotGrid control should show the summaries of child nodes when setting property ShowSubTotalsForChildren to true. + + + The default value is false. + + + + + Gets or sets whether the Pivot control should display null value as blank instead of 0. + + + The default value is false. + + + + + Gets the number of rows in the PivotTable. + + + + + Gets the number of columns in the PivotTable. + + + + + Gets a list of objects that specify + the cells that need to be covered. + + + + + Gets a list holding values that + specify any filters that need to be applied to this PivotTable. + + + + + Gets a dictionary of SummaryBase computations available in the PivotEngine. + + + + + Gets the underlying object collection represented in the PivotEngine. + + + + + Gets or sets the values of the hidden rows. + + + + + Gets or sets the different hidden row groups. + + + + + Gets or sets the different hidden column groups. + + + + + Gets or sets value indicating whether to Pivot only rows and calculations. + + Turning this property "ON", enables the PivotGrid control to appear like a flat Grid in which rows and calculations will be displayed as value columns. + + + + Gets or sets a collection of row based PivotItems. + + + + + Gets or sets a collection of column based PivotItems. + + + + + Gets or sets a collection of PivotComputations. + + + + + Gets or sets a value to indicate whether the description is to be displayed in the header cell + when more than one calculation is being used. The default behavior is to use + the "FieldName". + + + + + If you apply a filter which filters out all items in the underlying data source, then this + "EmptyPivot" property will be set true. The RowCount and ColumnCount will + be set to one, and the Engine[0, 0] will hold the value. + + + + + Gets or sets the string that appears when no items are present in a Pivot result. + + + + + Gets or sets the prefix string in the collection-wide totals that appear below and to the right of the PivotTable. + + + + + Gets or sets whether the formatted text of the columns, which has percentage calculation type, must apply with given format or default percentage format #,##% + + + + + Gets or sets a value indicating whether to ignore insignificant white space from the formatted text in rows and columns. + + + + + This property enables the Pivot control to perform loading operations asynchronously on a background thread. + + + + + Gets or sets whether underlying raw values are cached as the Pivot is being built. If these values are cached, + then GetRawItemsFor method calls do not require traversing the underlying data to complete. + + + + + Gets or sets whether the calculations should appear as rows/columns in the PivotGrid. By default the calculations is displayed as columns. + + + + + Gets or sets a value indicating whether to show an empty cell or not, when the value is null. + By default, the value is true. + + + + + Gets or sets data source for this PivotTable. This object should be either + an IEnumerable List or a DataTable. + + + + + Used internally. Gets or sets an IEnumerable List that is used as the data source for the + PivotTable. The default behavior is to initialize this list from DataSource. + + + + + Gets or sets the type of the objects in the DataSource. This property is initialized directly from the DataSource. + + + + + Gets or sets a collection of property descriptors for the items in the DataSource. This property is initialized directly from the DataSource. + + + + + Gets a collection of FieldInfo objects that hold the field names that you want to make visible in the engine. + The names can be either public property names of the underlying data objects or they can be expression field. + + + If your data contains fields that you do not want exposed to the pivoting process, + then add the names of the properties you want to include to this list. All other + fields will be excluded. + + If you leave this collection empty, the default behavior will be to make all public + properties available for use in the pivot table. + + To add an expression field, set the FieldInfo.FieldType to FieldsType.Expression and set FieldInfo.Expression + to be a string holding a well formed expression defining the value that should appear in this field. + + + + Gets or sets value to check whether the values of the PivotTable are populated or not. + + + + + Gets or sets value to check whether the PivotEngine is loading in the background. + + + + + Gets or sets the collection of filter items. + + + + + Gets or sets the collection of objects which are currently used in the Grid. + + + + + Gets or sets the boolean value indicating whether the computation need to happen. + It is handled in suspend and resume computation method. + + + + + Gets or sets the sort direction of Pivot values. The sort direction could be either ascending/descending. + + + + + Gets the object associated with a particular cell + in the PivotTable. The PivotCellInfo object contains value and formatted text properties information. + + Row index of the cell. + Column index of the cell. + A PivotCellInfo object that contains information about the cell contents. + + + + This class used for sorting the Pivoted row/column. + + + + + Initializes a new instance of the class. + + The sort direction. + + + + Compares the sort direction of the PivotFields using key. + + The key to compare sort directions. + The key to compare sort directions. + + + + Class that holds the properties which is used to handle single sort and multi sort in Grid. + + + + + Gets or sets the row index + + + + + Gets or sets the collection of row indexes. + + + + + Gets or sets the size of the Grid cell range. + + + + + This method is used to compare the sort directions. + + The first object to compare. + The second object to compare. + + A signed integer that indicates the relative values of and , as shown in the following table.Value meaning less than zero is less than . zero equals . Greater than zero is greater than . + + + + + Initializes the default sort direction as ascending. + + + + + This is used to assign the default comparer if the PivotFields comparer is null. + + The comparer. + The sort direction of the comparer. + + + + This is used to compare the PivotFields and populate the values. + + + + + Class that holds different Grid constants. + + + + + Variable that holds all the values in filter. + + + + + Holds the holds "Total" string. + + + + + Class that holds different filter items. + + + + + Initializes a new instance of the class. + + + + + To accept the changes in Engine. + + + + + To reject the changes in Engine. + + + + + To compare the filter items using key. + + + + + Converts the data to string datatype. + + + + + Event that is triggered when the property of the cell is changed. + + + + + Gets or sets the key for the filter item. + + + + + Gets or sets the bool value for the selected option. + + + + + Gets or sets a value indicating whether the filter item is "(All)" in the FilterPopUp window. + + + Returns true if the filter item is "(All)"; otherwise, false. + + + + + Gets or sets the bool value for the selected state. + + + + + Gets or sets the bool value for the changed state. + + + + + Class that holds the collection of objects that are filtered. + + + + + Initializes a new instance of the class. + + + + + Returns the respective location to add the filter item. + + Filter item. + Location to add the filter item. + + + + Accept the changes in the filter items collection. + + + + + Rejects the changes in filter items collection. + + + + + Method used to set the name of the filter item. + + Name of the filter item. + + + + Add filter item in the collection. + + Filter item. + + + + To get the filter expression for DataView source. + + Filter expression. + + + + To get the filter expression from IEnumerable source. + + + + + Returns key of the filter item, if the filter items are selected else returns empty string. + + + + + Returns the filter expression for the filter items collection from IEnumerable source. + + + + + Gets or sets the filter property. + + + + + Gets or sets the property with all the filter items. + + + + + Gets or sets the comparer of all PivotFields in the Pivot control. + + + + + Gets or sets the content for the name property. + + + + + Gets or sets the header value for the PivotItem. + + + + + Gets or sets the caption value for the PivotItem. + + + + + Gets or sets the format for the PivotItem. + + + + + Gets or sets the value to show/hide sub-totals for the PivotItem. Default value is true. + + + + + Gets or sets the value to enable/disable grouping for the filter item. Default value is true. + + + + + Gets or sets the filtered values. + + + + + Used to store the row header and column header values as BinaryList. + + + + + Method that returns an integer value after performing insertion. + + IComparable object + Object + + + + Enacapulates the information needed to define a PivotItem, for either a row/column Pivot. + + + A PivotItem is a property in the underlying data objects + that is used to group the data in a PivotTable. You can add PivotItems to both the + PivotColumns and PivotRows collection in a mutually exclusive manner. + + + + Event triggered when the property of the PivotItem is changed. + + + + + Gets or sets the summary type for calculations use. + + + + + Gets or sets the summary for calculations use. + + + + + Gets or sets whether the sub-total of PivotItems can be shown or hidden. + + + + + Gets or sets whether this calculation column can be sorted when + "RowPivotsOnly" is set to true in the PivotEngine. + + + + + Gets or sets the width of PivotItems to set the column width of RowHeaders + Its's only applicable for PivotItems which are added in PivotRows + + + + + Gets or sets whether this calculation column can be filtered when + "RowPivotsOnly" is set to true in the PivotEngine. + + + + + Gets or sets whether the PivotItem should be hyperlinked when "RowPivotsOnly" is set to true in the PivotEngine. + + + + + Gets or sets the property's mapping name. + + + + + Gets or sets the title you want to see in the header of this PivotItem. + + + + + Gets or sets the title you want to see in the header of this PivotItem. + + + + + Gets or sets the string that you want to append to the PivotItem's summary cells. + + + + + Gets or sets the format for the PivotItem. + + + + + Gets or sets the IComparer object used for sorting. If this value is null, then sorting is done assuming that this field is IComparable. + + + + + Gets or sets the value to enable/disable grouping for this PivotItem. Default value is true. + + + + + Class used to hold the properties of each hidden group. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class and it contains the properties needed for the hidden group. + + + + + Constructor that holds the information needed for hidden group. + + Hidden group starts with. + Hidden group ends with. + The level of hidden group. + Name of the hidden group. + The total header of hidden group. + + + + Converts the hidden group start and end values into string format. + + + + + Clones the specified hidden group. + + + + + Gets or sets where the HiddenGroup starts with. + + + + + Gets or sets where the HiddenGroup ends with. + + + + + Gets or sets the level of HiddenGroup. + + + + + Gets or sets the name of HiddenGroup. + + + + + Gets or sets the total header of HiddenGroup. + + + + + Class which has a method to determine whether the specified item is in the hidden group collection. + + + + + Determines whether the specified item is in the collection. + + The hidden group collection. + Specific hidden group item. + + + + This class is primarily for internal use. It is used to generate the rows and columns that hold summaries of PivotCalculations. + + + + + Compare the summary fields using the keys. + + + + + Gets or sets the row index of this item. + + + + + Gets or sets the column index of this item. + + + + + Gets or sets the list of calculations in the PivotItem. + + + + + Gets or sets row/column key values for an indexed look-up of this item. + + + + + This class defines a set of four integers that define a covered range in the zero-based coordinate system of a PivotTable. + + + + + Initializes a new instance of the class. + + + + + Constructor to define the range of covered cells. + + Top index of the cell. + Left index of the cell. + Bottom index of the cell. + Right index of the cell. + + + + Converts the covered cell ranges into string format. + + + + + Gets or sets the top index. + + + + + Gets or sets the left index. + + + + + Gets or sets the bottom index. + + + + + Gets or sets the right index. + + + + + This class provides an information about a specific cell in a PivotTable. + + + + + Value indicates the row index of the particular cell value. + + + + + Value indicates the column index of the particular cell value. + + + + + Initializes a new instance of the class. + + + + + Returns the formatted text. + + + + + Method to dispose the pivot cell information + + + + + Gets the double value of the cell. + + + + + Gets or sets the value in the cell. + + + + + Gets or sets any covered range associated with this cell. + + + + + Gets or sets the cell type of this cell. + + + + + Gets or sets the key associated with this cell. + + + + + Gets or sets the formatted text displayed in this cell. + + + + + Gets or sets the format for the cells. + + + + + Gets or sets the name of the cell. + + + + + Gets or sets the summary for the cell. + + + + + Gets or sets the parent cell. + + + + + Gets or sets the unique text. + + + + + Gets the RawValues of the particular PivotCellInfo. + + + + + Gets the information from the Pivot control. + + + + + Initializes a new instance of the PivotCellInfos class. + + + + + Constructor accepting the row and column count. + + Total number of rows in the Pivot control. + Total number of columns in the Pivot control. + + + + Gets the length of the value at specified index. + + + + + Gets or sets the rowIndex and colIndex of the pivot cell. + + + + + Event argument for the event. + + + + + Gets or sets regarding the schema information changed. + + + + + Gets or sets whether to override the defer layout update settings. + + + + + Gets the information about the PiovtFields. + + + + + Returns the name of each field in the property descriptor collection based on the object type. + + + + + Returns the hash code for the given value. + + + + + Compares the value with other values using the name of the field. + + + + + Gets and sets the field type. + + + + + Gets and sets the name of the field. + + + + + Gets and sets the expression associated with the field. + + + + + Gets and sets the format of the field. + + + + + Class that illustrates the expression field support along with filtering in PivotEngine. + + + + + A constructor that initializes the attributes of "ExpressionPropertyDescriptor" object. + + Name of the expression field. + Attributes. + Expression. + Format. + An object that holds attributes to compute filter values and expressions. + + + + When overridden in a derived class, returns whether re-setting an object changes its value. + + The component to test re-setting capability. + + Retuens true if re-setting the component changes its value; otherwise, false. + + + + + Gets the value of the concerned data and returns the values based on the format associated with it. + + + + + Resets the value based on expression. + + + + + 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. + + The component with the property to be examined for persistence. + + Returns true if the property should be persisted; otherwise, false. + + + + + Gets or sets the expression. + + + + + Gets or sets the logical expression for filtering. + + + + + Gets or sets a format associated with the value of this expression. + + + + + Checks whether the data is read-only. + + + + + Returns the object datatype. + + + + + When overridden in a derived class, gets the type of the component this property is bound to. + + + + + Class that holds the methods for setting the value for the variable. + + + + + Initializes a new instance of the class. + + Name of the member. + An array of type that contains the member attributes. + + + + When overridden in a derived class, returns whether re-setting an object changes its value. + + The component to test for reset capability. + + Returns true if re-setting the component changes its value; otherwise, false. + + + + + When overridden in a derived class, gets the current value of the property on a component. + + The component with the property, for which, to retrieve the value. + + The value of a property for a given component. + + + + + 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. + + The component with the property to be examined for persistence. + + Returns true if the property should be persisted; otherwise, false. + + + + + When overridden in a derived class, gets a value indicating whether this property is read-only. + + + + + When overridden in a derived class, gets the type of the property. + + + + + When overridden in a derived class, gets the type of the component this property is bound to. + + + + + Compare for DateTime objects. + + object. + object. + integer + + + + Use to get the property value without using reflection. + + + + + Enumeration provides option to select row type. + + + + + When no type is set for the Row. + + + + + When type is set for Row as Summary. + + + + + Index Engine is used to load the collection of data faster than the PivotEngine. + It makes use of the "EnableOnDemandCalculations" property. + Unlike the PivotEngine, it loads the entire collection of data by including all the values in the list irrespective of Row and Column headers. + + + + + + + + + + + Initializes a new instance of the class IndexEngine. + + The PivotEngine. + + + + Initializes the new instance of the class IndexEngine. + + The PivotEngine. + Returns delegate value. + + + + Initializes a new instance of the IndexEngine class. + + + + + Call this method to have the IndexEngine create the index information for the current + content reflected in , , + and . + + Returns true if indexing was completed; otherwise, false. + + After successfully executing this method, you can access the Pivot contents using an zero-based + row, column indexer on this IndexEngine. + + + + + Call this method to have the IndexEngine create index information for the current + content reflected in , , + and . + + If you want this method to return before all the rows are populated, parameter should be set to true. + Returns true if indexing was completed; otherwise, false. + + If onDemand is true, the IndexEngine will return when the number of rows given in + has been loaded. After this method returns, the rest of the rows will be loaded on demand + as you index this IndexEngine using row and column indexes. Anytime you index this IndexEngine, + if your row request exceeds , additional rows are populated until it is + possible to return your requested value. + + + + + + + Sorts the value by the calculated value. + + The index of the column. + + + + Gets the total number of unique slices under this given ListIndexInfo object. + + The parent ListIndexInfo object. + The number of rows or columns that are contained by this ListIndexInfo item. + + Given an outer row node, the GetCount value for this node is the number of child nodes that are contained + under this outer node. This method uses recursions to iterate through all children contained + at any level under this outer node. Summing up all the GetCounts for all the outer nodes will give + you the total number of all nodes. + + + + + This is used if the GetValue delegate is not set as part of the caller. + + + + + Gets the index of the last row that has been loaded when you are using on-demand loading. + + + You do on-demand loading by passing a true value when you use the IndexEngine method to populate + the IndexEngine. When this is done, IndexEngine will return after loading the number of rows + indicated . The rest of the rows will be populated on-demand + as your code requests a row higher than this property. + + + + + Gets or sets the number of rows that are initially loaded when you are using on-demand loading. + + + You do on-demand loading by passing a true value when you use the IndexEngine method to populate + the IndexEngine. When this is done, IndexEngine will return after loading the number of rows + indicated by this property. The rest of the rows will be populated on-demand as your code requests + a row higher than . + + + + + Gets or sets a delegate that returns a property value for a given object. + + + If this member is null, the IndexEngine will use reflection to obtain property values from objects in + the . Note usually, a well written delegate can provide values more efficiently + than using reflection. For performance improvements, you will want to provide a well written delegate for + this property. + + + + + Gets the PivotRows used in this Pivot. + + + + + Gets the PivotColumns used in this Pivot. + + + + + Gets the PivotCalculations used in this Pivot. + + + If the IndexEngine is created using a PivotEngine, then this PivotCalculations is + the PivotEngine. PivotCalculations collection from the associated PivotEngine. + + + + + Gets a list holding values that + specify any filter that need to be applied to this PivotTable. + + + + + Gets or sets data source for this PivotTable. This object should be either + an IEnumerable List, or a DataTable. + + + + + Gets a list of objects that specify + the cells that need to be covered. + + + + + Gets or sets whether the formatted text of the columns which has percentage calculation type, must be applied with given format or default percentage format #,##% + + + + + Gets the number of rows in the Pivot. + + + + + Gets the number of columns in the Pivot. + + + + + Gets the number of columns that holds the row header information to the left of the numerical + values in the Pivot. + + + + + Gets the number of rows that holds the column header information above the numerical + values in the Pivot. + + + + + Gets or sets the sorting direction of the items in the Pivot control. + + + + + Gets the PivotCell information that holds the details being displayed + by the Pivot at the given row and column. + + The row index (zero-based). + The column index (zero-based). + The PivotCellInfo associated with the cell pointed to by the row and column. + + Note that this indexer will return a null value if the row and column values pick out a cell + that is not visible due to being part of a covered cell. + + + + + + + + + + + + + + + + + Sort the Pivot Row/Column headers using index. + + The comparer assigned to the PivotFields. + + + + Compares the Pivot Row/Column and populate the Pivot values based on the comparer assigned. + + + + + Class used to compare and sort the given collection. + + + + + Constructor that holds the information needed to perform comparison operation while sorting the PivotFields. + + + + + Compares the different objects and populate the Pivot values based on the comparer assigned. + + + + + Class that holds primarily the information on one row in a PivotTable. Additionally, these + calls can be used to hold information on the row/column header structures. + + + + + Gets the type of the variable. + + + + + Converts the data to string type. + + Combined String + + + + Compares the different values based on display. + + Holds information on row/column headers. + Return 0 if display is null else return -1. + + + + Gets and sets the RowType. + + + + + Get the information about the parent row/column headers in the PivotTable. + + + + + Default size of autofilter arrow width. + + + + + Default size of autofilter font size. + + + + + This text should be added to value of the header of the table to equal the width of the dropdown symbol. + + + + + Indicates the application object of this class. + + + + + Intializes the AutoFit Manager + + + + + + + + + + Intializes the AutoFit Manager + + worksheet parent object + + + + Measures to fit column. + + The graphics. + The first row. + The last row. + The first column. + The last column. + + + + Measure the number of spaces need to be added. + + Number of Spaces + + + + Measures the character ranges. + + The graphics. + The style with text. + The param num. + The rect F. + + + + + Get Indent level + + Indent value + + + + Measures the character ranges. + + The graphics. + The style. + The STR text. + The num. + The rect F. + + + + + Sorts the text to fit. + + The list. + The font impl. + The STR text. + + + + Collection of DisplayText with matching fonts. + This class used to improve the AutoFitToColumn method + Performance. + + + + + Class used for setting chart elements layout + + + + + This is the base class for all Implementation's classes. + + + + + Represents parent application. + + + + + Gets the application object. + + + + + Gets the parent object. + + + + + Reference to Application object. + + + + + Reference to parent Object. + + + + + Counter which can be used for calculating references. + + + + + Flag which indicates if the object was disposed or not. + + + + + Default constructor. Object cannot be constructed without setting Application + and parent references. + + + + + Main class constructor. Application and Parent properties are set. + + Reference to Application instance. + + Reference to the Parent object which will host this object + + + If specified application or parent is null. + + + + + Destructor. Call dispose method of current object. + + + + + This method is used to find parent with specific type. + + Parent type to locate. + The found parent or NULL if parent was not found. + + When there is cycle in object tree. + + + + + This method is used to find parent with specific type. + + Parent type to locate. + Indicates whether to search subtypes. + The found parent or NULL if parent was not found. + + When there is cycle in object tree. + + + + + This method is used to find parent with specific type. + + Start object for search operation. + Parent type to locate. + The found parent or NULL if parent was not found. + + + + This method is used to find parent with specific type. + + Start object for search operation. + Parent type to locate. + Indicates whether to search subtypes. + The found parent or NULL if parent was not found. + + + + Finds parent objects. + + Array of parents type. + Returns array of found parent objects. + + + + Find parent of object. + + Array of parents type. + Returns found parent object. + + + + Sets parent of the object. + + New parent for this object. + + + + Sets parent of the object. + + New parent for this object. + + + + Checks whether object was disposed and throws exception if it was. + + + + + Increase the quantity of reference. User must use this method when + new wrapper on object is created or reference on object stored. + + New state of Reference count value. + + + + Decrease quantity of Reference. User must call this method + when freeing resources. + + New state of Reference count value. + + + + Dispose object and free resources. + + + + + Method which can be overridden by users to take any specific actions when + object is disposed. + + + + + Reference to Application which hosts all objects. Read-only. + + + + + Reference to Parent object. Read-only. + + + + + Reference to Application which hosts all objects. Read-only. + + + + + Get quantity of instance references. + + + + + Provides layout options for plot area, legend and text area elements of the chart. + + + + + Gets or sets manual layout options for the chart element. The Layout and ManualLayout options both are same. + + + To know more about charts refer this link. + + The following code illustrates the use of ManualLayout property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Manually positioning plot area + chart.PlotArea.Layout.ManualLayout.Height = 300; + chart.PlotArea.Layout.ManualLayout.Width = 430; + chart.PlotArea.Layout.ManualLayout.Top = 40; + chart.PlotArea.Layout.ManualLayout.Left = 10; + chart.PlotArea.Layout.ManualLayout.LayoutTarget = LayoutTargets.inner; + chart.PlotArea.Layout.ManualLayout.LeftMode = LayoutModes.edge; + chart.PlotArea.Layout.ManualLayout.TopMode = LayoutModes.factor; + + //Manually positioning legent area + chart.Legend.Layout.ManualLayout.Height = 160; + chart.Legend.Layout.ManualLayout.Width = 120; + chart.Legend.Layout.ManualLayout.Top = 30; + chart.Legend.Layout.ManualLayout.Left = 220; + chart.Legend.Layout.ManualLayout.LeftMode = LayoutModes.edge; + chart.Legend.Layout.ManualLayout.TopMode = LayoutModes.factor; + + //Manually positioning text Area + chart.ChartTitleArea.Text = "Sample Chart"; + chart.ChartTitleArea.Layout.ManualLayout.Height = 20; + chart.ChartTitleArea.Layout.ManualLayout.Width = 30; + chart.ChartTitleArea.Layout.ManualLayout.Top = 0; + chart.ChartTitleArea.Layout.ManualLayout.Left = 150; + chart.ChartTitleArea.Layout.ManualLayout.LeftMode = LayoutModes.edge; + chart.ChartTitleArea.Layout.ManualLayout.TopMode = LayoutModes.factor; + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the layout target for the plot area. The LayoutTarget property values are from . + + + The layout option is supported only for plot area. To know more about charts refer this link. + + The following code illustrates the use of LayoutTarget property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Manually positioning plot area + chart.PlotArea.Layout.Height = 300; + chart.PlotArea.Layout.Width = 430; + chart.PlotArea.Layout.Top = 40; + chart.PlotArea.Layout.Left = 10; + + //sets the layout target for the plot area + chart.PlotArea.Layout.LayoutTarget = LayoutTargets.inner; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a value indicating how to interpret the of this manual layout. The LeftMode property values are from . + + + To know more about charts refer this link. + + The following code illustrates the use of LeftMode property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Manually positioning plot area + chart.PlotArea.Layout.LeftMode = LayoutModes.edge; //sets a value of Leftmode for plot area + chart.PlotArea.Layout.Height = 300; + chart.PlotArea.Layout.Width = 430; + chart.PlotArea.Layout.Top = 40; + chart.PlotArea.Layout.Left = 10; + + //Manually positioning legent area + chart.Legend.Layout.LeftMode = LayoutModes.edge; //sets a value of Leftmode for legent area + chart.Legend.Layout.Height = 160; + chart.Legend.Layout.Width = 120; + chart.Legend.Layout.Top = 30; + chart.Legend.Layout.Left = 220; + + //Manually positioning text Area + chart.ChartTitleArea.Layout.LeftMode = LayoutModes.edge; //sets a value of Leftmode for text area + chart.ChartTitleArea.Text = "Sample Chart"; + chart.ChartTitleArea.Layout.Height = 20; + chart.ChartTitleArea.Layout.Width = 30; + chart.ChartTitleArea.Layout.Top = 0; + chart.ChartTitleArea.Layout.Left = 150; + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a value indicating how to interpret the of this manual layout. The TopMode property values are from . + + + To know more about charts refer this link. + + The following code illustrates the use of TopMode property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Manually positioning plot area + chart.PlotArea.Layout.TopMode = LayoutModes.factor; //sets a value of topmode for plot area + chart.PlotArea.Layout.Height = 300; + chart.PlotArea.Layout.Width = 430; + chart.PlotArea.Layout.Top = 40; + chart.PlotArea.Layout.Left = 10; + + //Manually positioning legent area + chart.Legend.Layout.TopMode = LayoutModes.factor; //sets a value of topmode for legent area + chart.Legend.Layout.Height = 160; + chart.Legend.Layout.Width = 120; + chart.Legend.Layout.Top = 30; + chart.Legend.Layout.Left = 220; + + //Manually positioning text Area + chart.ChartTitleArea.Layout.TopMode = LayoutModes.factor; //sets a value of topmode for text area + chart.ChartTitleArea.Text = "Sample Chart"; + chart.ChartTitleArea.Layout.Height = 20; + chart.ChartTitleArea.Layout.Width = 30; + chart.ChartTitleArea.Layout.Top = 0; + chart.ChartTitleArea.Layout.Left = 150; + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the left (x location) of the chart element as a fraction of width of the chart. + + If is factor, then the position is relative to the + default position for the chart element. To know more about charts refer this link. + + The following code illustrates the use of Left property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Manually positioning plot area + chart.PlotArea.Layout.Left = 10; //sets a value of left position for plot area + chart.PlotArea.Layout.Height = 300; + chart.PlotArea.Layout.Width = 430; + chart.PlotArea.Layout.Top = 40; + + //Manually positioning legent area + chart.Legend.Layout.Left = 220; //sets a value of left position for legent area + chart.Legend.Layout.Height = 160; + chart.Legend.Layout.Width = 120; + chart.Legend.Layout.Top = 30; + + //Manually positioning text Area + chart.ChartTitleArea.Layout.Left = 150; //sets a value of left position for text area + chart.ChartTitleArea.Text = "Sample Chart"; + chart.ChartTitleArea.Layout.Height = 20; + chart.ChartTitleArea.Layout.Width = 30; + chart.ChartTitleArea.Layout.Top = 0; + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the top of the chart element as a fraction of height of the chart. + + + If is factor, then the position is relative to the + default position for the chart element. To know more about charts refer this link. + + The following code illustrates the use of Top property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Manually positioning plot area + chart.PlotArea.Layout.Top = 40; //sets a value of Top position for plot area + chart.PlotArea.Layout.Height = 300; + chart.PlotArea.Layout.Width = 430; + chart.PlotArea.Layout.Left = 10; + + //Manually positioning legent area + chart.Legend.Layout.Top = 30; //sets a value of Top position for legent area + chart.Legend.Layout.Height = 160; + chart.Legend.Layout.Width = 120; + chart.Legend.Layout.Left = 220; + + //Manually positioning text Area + chart.ChartTitleArea.Layout.Top = 0; //sets a value of Top position for text area + chart.ChartTitleArea.Text = "Sample Chart"; + chart.ChartTitleArea.Layout.Height = 20; + chart.ChartTitleArea.Layout.Width = 30; + chart.ChartTitleArea.Layout.Left = 150; + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a value indicating how to interpret the + of this manual layout. The WidthMode property values are from . + + + To know more about charts refer this link. + + The following code illustrates the use of WidthMode property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Manually positioning plot area + chart.PlotArea.Layout.WidthMode = LayoutModes.factor; //sets a value of Width mode for plot area + chart.PlotArea.Layout.Height = 300; + chart.PlotArea.Layout.Width = 430; + chart.PlotArea.Layout.Top = 40; + chart.PlotArea.Layout.Left = 10; + + //Manually positioning legent area + chart.Legend.Layout.WidthMode = LayoutModes.factor; //sets a value of Width mode for legent area + chart.Legend.Layout.Height = 160; + chart.Legend.Layout.Width = 120; + chart.Legend.Layout.Top = 30; + chart.Legend.Layout.Left = 220; + + //Manually positioning text Area + chart.ChartTitleArea.Layout.WidthMode = LayoutModes.factor; //sets a value of Width mode for text area + chart.ChartTitleArea.Text = "Sample Chart"; + chart.ChartTitleArea.Layout.Height = 20; + chart.ChartTitleArea.Layout.Width = 30; + chart.ChartTitleArea.Layout.Top = 0; + chart.ChartTitleArea.Layout.Left = 150; + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a value indicating how to interpret the of this manual layout. The HeightMode property values are from . + + + To know more about charts refer this link. + + The following code illustrates the use of HeightMode property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Manually positioning plot area + chart.PlotArea.Layout.HeightMode = LayoutModes.edge; //sets a value of Height mode for plot area + chart.PlotArea.Layout.Height = 300; + chart.PlotArea.Layout.Width = 430; + chart.PlotArea.Layout.Top = 40; + chart.PlotArea.Layout.Left = 10; + + //Manually positioning legent area + chart.Legend.Layout.HeightMode = LayoutModes.edge; //sets a value of Height mode for legent area + chart.Legend.Layout.Height = 160; + chart.Legend.Layout.Width = 120; + chart.Legend.Layout.Top = 30; + chart.Legend.Layout.Left = 220; + + //Manually positioning text Area + chart.ChartTitleArea.Layout.HeightMode = LayoutModes.edge; //sets a value of Height mode for text area + chart.ChartTitleArea.Text = "Sample Chart"; + chart.ChartTitleArea.Layout.Height = 20; + chart.ChartTitleArea.Layout.Width = 30; + chart.ChartTitleArea.Layout.Top = 0; + chart.ChartTitleArea.Layout.Left = 150; + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the width/right of the chart element as a fraction of width of the chart, + based on . + + + To know more about charts refer this link. + + The following code illustrates the use of Width property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Manually positioning plot area + chart.PlotArea.Layout.Width = 430; //sets a value of Width for plot area + chart.PlotArea.Layout.Height = 300; + chart.PlotArea.Layout.Top = 40; + chart.PlotArea.Layout.Left = 10; + + //Manually positioning legent area + chart.Legend.Layout.Width = 120; //sets a value of width for legent area + chart.Legend.Layout.Height = 160; + chart.Legend.Layout.Top = 30; + chart.Legend.Layout.Left = 220; + + //Manually positioning text Area + chart.ChartTitleArea.Layout.Width = 30; //sets a value of Width mode for text area + chart.ChartTitleArea.Text = "Sample Chart"; + chart.ChartTitleArea.Layout.Height = 20; + chart.ChartTitleArea.Layout.Top = 0; + chart.ChartTitleArea.Layout.Left = 150; + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the height/bottom of the chart element as a fraction of height of the chart, + based on . + + + To know more about charts refer this link. + + The following code illustrates the use of Height property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Manually positioning plot area + chart.PlotArea.Layout.Height = 300; //sets a value of Height for plot area + chart.PlotArea.Layout.Width = 430; + chart.PlotArea.Layout.Top = 40; + chart.PlotArea.Layout.Left = 10; + + //Manually positioning legent area + chart.Legend.Layout.Height = 160; //sets a value of Height for legent area + chart.Legend.Layout.Width = 120; + chart.Legend.Layout.Top = 30; + chart.Legend.Layout.Left = 220; + + //Manually positioning text Area + chart.ChartTitleArea.Layout.Height = 20; //sets a value of Height for text area + chart.ChartTitleArea.Text = "Sample Chart"; + chart.ChartTitleArea.Layout.Width = 30; + chart.ChartTitleArea.Layout.Top = 0; + chart.ChartTitleArea.Layout.Left = 150; + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Parent chart. + + + + + Parent object + + + + + Chart interface + + + + + ChartShape interface + + + + + Manual layout + + + + + Creates chart and sets its Application and Parent + properties to specified values. + + Application object for the chart. + Parent object for the chart. + + + + Creates chart and sets its Application and Parent + properties to specified values. + + Application object for the chart. + Parent object for the chart. + Indicates whether we should set defaults for fill and border properties. + + + + Creates chart and sets its Application and Parent + properties to specified values. + + Application object for the chart. + Parent object for the chart. + Indicates is auto size. + Indicates is interior is gray. + Indicates whether we should set defaults for fill and border properties. + + + + Creates and parses current object. + + Application object for the chart. + Parent object for the chart. + Records storage. + Position in storage. + + + + Searches for all necessary parent objects. + + + + + Parses frame. + + Array with frame records. + Position of the frame records. + + + + Checks whether specified record is begin. + + Record to check. + True if this is begin; false otherwise. + + + + Parses single record. + + Record to parse. + Number of not closed begin record. + + + + Saves chart frame as biff records. + + OffsetArrayList that will get biff records. + + + + Serializes single record. + + OffsetArrayList that will get biff records. + Record to serialize. + + + + Unwraps record. + + Record to unwrap. + Unwrapped record. + + + + Set variable to the default state. + + Indicates whether MS Excel should calculate size of the frame. + Indicates is default interior is gray. + + + + Returns parent workbook. Read-only. + + + + + Return the parent object. Read-only. + + + + + Gets or sets manual layout options for the chart element. + + + + + Gets or sets the layout target for the plot area. + + + + + Gets or sets a value indicating how to interpret the + of this manual layout. + + + + + Gets or sets a value indicating how to interpret the + of this manual layout. + + + + + Gets or sets the left (x location) of the chart element as a fraction of width of the chart. + + If is factor, then the position is relative to the + default position for the chart element. + + + + Gets or sets the top of the chart element as a fraction of height of the chart. + + + If is factor, then the position is relative to the + default position for the chart element. + + + + + Gets or sets a value indicating how to interpret the + of this manual layout. + + + + + Gets or sets a value indicating how to interpret the + of this manual layout. + + + + + Gets or sets the width/right of the chart element as a fraction of width of the chart, + based on . + + + + + Gets or sets the height/bottom of the chart element as a fraction of height of the chart, + based on . + + + + + Indicates whether the manual layout is initialized or not + + + + + Class used for setting chart elements layout manually + + + + + Represent the chart manual layout + + + + + Gets or sets the layout target for the plot area. The LayoutTarget property values are from . + + + The layout option is supported only for plot area. To know more about charts refer this link. + + The following code illustrates the use of LayoutTarget property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the layout target for the plot area + chart.PlotArea.Layout.ManualLayout.LayoutTarget = LayoutTargets.inner; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a value indicating how to interpret the + of this manual layout. The LeftMode property values are from . + + + To know more about charts refer this link. + + The following code illustrates the use of LeftMode property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Manually positioning plot area + chart.PlotArea.Layout.ManualLayout.LeftMode = LayoutModes.edge; //sets a value of Leftmode for plot area + chart.PlotArea.Layout.ManualLayout.Height = 300; + chart.PlotArea.Layout.ManualLayout.Width = 430; + chart.PlotArea.Layout.ManualLayout.Top = 40; + chart.PlotArea.Layout.ManualLayout.Left = 10; + + //Manually positioning legent area + chart.Legend.Layout.ManualLayout.LeftMode = LayoutModes.edge; //sets a value of Leftmode for legent area + chart.Legend.Layout.ManualLayout.Height = 160; + chart.Legend.Layout.ManualLayout.Width = 120; + chart.Legend.Layout.ManualLayout.Top = 30; + chart.Legend.Layout.ManualLayout.Left = 220; + + //Manually positioning text Area + chart.ChartTitleArea.Layout.ManualLayout.LeftMode = LayoutModes.edge; //sets a value of Leftmode for text area + chart.ChartTitleArea.Text = "Sample Chart"; + chart.ChartTitleArea.Layout.ManualLayout.Height = 20; + chart.ChartTitleArea.Layout.ManualLayout.Width = 30; + chart.ChartTitleArea.Layout.ManualLayout.Top = 0; + chart.ChartTitleArea.Layout.ManualLayout.Left = 150; + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a value indicating how to interpret the + of this manual layout. The TopMode property values are from . + + + To know more about charts refer this link. + + The following code illustrates the use of TopMode property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Manually positioning plot area + chart.PlotArea.Layout.ManualLayout.TopMode = LayoutModes.factor; //sets a value of topmode for plot area + chart.PlotArea.Layout.ManualLayout.Height = 300; + chart.PlotArea.Layout.ManualLayout.Width = 430; + chart.PlotArea.Layout.ManualLayout.Top = 40; + chart.PlotArea.Layout.ManualLayout.Left = 10; + + //Manually positioning legent area + chart.Legend.Layout.ManualLayout.TopMode = LayoutModes.factor; //sets a value of topmode for legent area + chart.Legend.Layout.ManualLayout.Height = 160; + chart.Legend.Layout.ManualLayout.Width = 120; + chart.Legend.Layout.ManualLayout.Top = 30; + chart.Legend.Layout.ManualLayout.Left = 220; + + //Manually positioning text Area + chart.ChartTitleArea.Layout.ManualLayout.TopMode = LayoutModes.factor; //sets a value of topmode for text area + chart.ChartTitleArea.Text = "Sample Chart"; + chart.ChartTitleArea.Layout.ManualLayout.Height = 20; + chart.ChartTitleArea.Layout.ManualLayout.Width = 30; + chart.ChartTitleArea.Layout.ManualLayout.Top = 0; + chart.ChartTitleArea.Layout.ManualLayout.Left = 150; + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the left (x location) of the chart element as a fraction of width of the chart. + + If is factor, then the position is relative to the + default position for the chart element. To know more about charts refer this link. + + The following code illustrates the use of Left property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Manually positioning plot area + chart.PlotArea.Layout.ManualLayout.Left = 10; //sets a value of left position for plot area + chart.PlotArea.Layout.ManualLayout.Height = 300; + chart.PlotArea.Layout.ManualLayout.Width = 430; + chart.PlotArea.Layout.ManualLayout.Top = 40; + + //Manually positioning legent area + chart.Legend.Layout.ManualLayout.Left = 220; //sets a value of left position for legent area + chart.Legend.Layout.ManualLayout.Height = 160; + chart.Legend.Layout.ManualLayout.Width = 120; + chart.Legend.Layout.ManualLayout.Top = 30; + + //Manually positioning text Area + chart.ChartTitleArea.Layout.ManualLayout.Left = 150; //sets a value of left position for text area + chart.ChartTitleArea.Text = "Sample Chart"; + chart.ChartTitleArea.Layout.ManualLayout.Height = 20; + chart.ChartTitleArea.Layout.ManualLayout.Width = 30; + chart.ChartTitleArea.Layout.ManualLayout.Top = 0; + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the top of the chart element as a fraction of height of the chart. + + + If is factor, then the position is relative to the + default position for the chart element. To know more about charts refer this link. + + The following code illustrates the use of Top property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Manually positioning plot area + chart.PlotArea.Layout.ManualLayout.Top = 40; //sets a value of Top position for plot area + chart.PlotArea.Layout.ManualLayout.Height = 300; + chart.PlotArea.Layout.ManualLayout.Width = 430; + chart.PlotArea.Layout.ManualLayout.Left = 10; + + //Manually positioning legent area + chart.Legend.Layout.ManualLayout.Top = 30; //sets a value of Top position for legent area + chart.Legend.Layout.ManualLayout.Height = 160; + chart.Legend.Layout.ManualLayout.Width = 120; + chart.Legend.Layout.ManualLayout.Left = 220; + + //Manually positioning text Area + chart.ChartTitleArea.Layout.ManualLayout.Top = 0; //sets a value of Top position for text area + chart.ChartTitleArea.Text = "Sample Chart"; + chart.ChartTitleArea.Layout.ManualLayout.Height = 20; + chart.ChartTitleArea.Layout.ManualLayout.Width = 30; + chart.ChartTitleArea.Layout.ManualLayout.Left = 150; + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a value indicating how to interpret the + of this manual layout. The WidthMode property values are from . + + + To know more about charts refer this link. + + The following code illustrates the use of WidthMode property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Manually positioning plot area + chart.PlotArea.Layout.ManualLayout.WidthMode = LayoutModes.factor; //sets a value of Width mode for plot area + chart.PlotArea.Layout.ManualLayout.Height = 300; + chart.PlotArea.Layout.ManualLayout.Width = 430; + chart.PlotArea.Layout.ManualLayout.Top = 40; + chart.PlotArea.Layout.ManualLayout.Left = 10; + + //Manually positioning legent area + chart.Legend.Layout.ManualLayout.WidthMode = LayoutModes.factor; //sets a value of Width mode for legent area + chart.Legend.Layout.ManualLayout.Height = 160; + chart.Legend.Layout.ManualLayout.Width = 120; + chart.Legend.Layout.ManualLayout.Top = 30; + chart.Legend.Layout.ManualLayout.Left = 220; + + //Manually positioning text Area + chart.ChartTitleArea.Layout.ManualLayout.WidthMode = LayoutModes.factor; //sets a value of Width mode for text area + chart.ChartTitleArea.Text = "Sample Chart"; + chart.ChartTitleArea.Layout.ManualLayout.Height = 20; + chart.ChartTitleArea.Layout.ManualLayout.Width = 30; + chart.ChartTitleArea.Layout.ManualLayout.Top = 0; + chart.ChartTitleArea.Layout.ManualLayout.Left = 150; + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a value indicating how to interpret the of this manual layout. The HeightMode property values are from . + + + To know more about charts refer this link. + + The following code illustrates the use of HeightMode property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Manually positioning plot area + chart.PlotArea.Layout.ManualLayout.HeightMode = LayoutModes.edge; //sets a value of Height mode for plot area + chart.PlotArea.Layout.ManualLayout.Height = 300; + chart.PlotArea.Layout.ManualLayout.Width = 430; + chart.PlotArea.Layout.ManualLayout.Top = 40; + chart.PlotArea.Layout.ManualLayout.Left = 10; + + //Manually positioning legent area + chart.Legend.Layout.ManualLayout.HeightMode = LayoutModes.edge; //sets a value of Height mode for legent area + chart.Legend.Layout.ManualLayout.Height = 160; + chart.Legend.Layout.ManualLayout.Width = 120; + chart.Legend.Layout.ManualLayout.Top = 30; + chart.Legend.Layout.ManualLayout.Left = 220; + + //Manually positioning text Area + chart.ChartTitleArea.Layout.ManualLayout.HeightMode = LayoutModes.edge; //sets a value of Height mode for text area + chart.ChartTitleArea.Text = "Sample Chart"; + chart.ChartTitleArea.Layout.ManualLayout.Height = 20; + chart.ChartTitleArea.Layout.ManualLayout.Width = 30; + chart.ChartTitleArea.Layout.ManualLayout.Top = 0; + chart.ChartTitleArea.Layout.ManualLayout.Left = 150; + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the width/right of the chart element as a fraction of width of the chart, + based on . + + + To know more about charts refer this link. + + The following code illustrates the use of Width property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Manually positioning plot area + chart.PlotArea.Layout.ManualLayout.Width = 430; //sets a value of Width for plot area + chart.PlotArea.Layout.ManualLayout.Height = 300; + chart.PlotArea.Layout.ManualLayout.Top = 40; + chart.PlotArea.Layout.ManualLayout.Left = 10; + + //Manually positioning legent area + chart.Legend.Layout.ManualLayout.Width = 120; //sets a value of width for legent area + chart.Legend.Layout.ManualLayout.Height = 160; + chart.Legend.Layout.ManualLayout.Top = 30; + chart.Legend.Layout.ManualLayout.Left = 220; + + //Manually positioning text Area + chart.ChartTitleArea.Layout.ManualLayout.Width = 30; //sets a value of Width mode for text area + chart.ChartTitleArea.Text = "Sample Chart"; + chart.ChartTitleArea.Layout.ManualLayout.Height = 20; + chart.ChartTitleArea.Layout.ManualLayout.Top = 0; + chart.ChartTitleArea.Layout.ManualLayout.Left = 150; + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the height/bottom of the chart element as a fraction of height of the chart, + based on . + + + To know more about charts refer this link. + + The following code illustrates the use of Height property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Manually positioning plot area + chart.PlotArea.Layout.ManualLayout.Height = 300; //sets a value of Height for plot area + chart.PlotArea.Layout.ManualLayout.Width = 430; + chart.PlotArea.Layout.ManualLayout.Top = 40; + chart.PlotArea.Layout.ManualLayout.Left = 10; + + //Manually positioning legent area + chart.Legend.Layout.ManualLayout.Height = 160; //sets a value of Height for legent area + chart.Legend.Layout.ManualLayout.Width = 120; + chart.Legend.Layout.ManualLayout.Top = 30; + chart.Legend.Layout.ManualLayout.Left = 220; + + //Manually positioning text Area + chart.ChartTitleArea.Text = "Sample Chart"; + chart.ChartTitleArea.Layout.ManualLayout.Height = 20; //sets a value of Height for text area + chart.ChartTitleArea.Layout.ManualLayout.Width = 30; + chart.ChartTitleArea.Layout.ManualLayout.Top = 0; + chart.ChartTitleArea.Layout.ManualLayout.Left = 150; + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Parent chart. + + + + /// + Parent object + + + + + Layout target for the plot area. + + + + + Left mode of manual layout. + + + + + Top mode of manual layout. + + + + + Left (x location) of the chart element. + + + + + Top of the chart element. + + + + + dX value. + + + + + dY value. + + + + + Width mode of manual layout. + + + + + Height mode of manual layout. + + + + + Width of chart element. + + + + + Height of chart element. + + + + + xTL value. + + + + + yTL value. + + + + + xBR value. + + + + + yBR value. + + + + + byte value used as flag and boolean property for the values + + + + + Creates chart and sets its Application and Parent + properties to specified values. + + Application object for the chart. + Parent object for the chart. + + + + Creates chart and sets its Application and Parent + properties to specified values. + + Application object for the chart. + Parent object for the chart. + Indicates whether we should set defaults for fill and border properties. + + + + Creates chart and sets its Application and Parent + properties to specified values. + + Application object for the chart. + Parent object for the chart. + Indicates is auto size. + Indicates is interior is gray. + Indicates whether we should set defaults for fill and border properties. + + + + Creates and parses current object. + + Application object for the chart. + Parent object for the chart. + Records storage. + Position in storage. + + + + Searches for all necessary parent objects. + + + + + Set variable to the default state. + + Indicates whether MS Excel should calculate size of the frame. + Indicates is default interior is gray. + + + + Return the parent object. Read-only. + + + + + Gets or sets the chart attached label layout record. + + + + + Gets or sets the chart plot area layout record. + + + + + Gets or sets the layout target for the plot area. + + + + + + Gets or sets a value indicating how to interpret the + of this manual layout. + + + + + Gets or sets the left (x location) of the chart element as a fraction of width of the chart. + + If is factor, then the position is relative to the + default position for the chart element. + + + + Gets or sets the top of the chart element as a fraction of height of the chart. + + + If is factor, then the position is relative to the + default position for the chart element. + + + + + Gets or sets the dx value + + + + + Gets or sets the dy value + + + + + Gets or sets a value indicating how to interpret the + of this manual layout. + + + + + + Gets or sets the width/right of the chart element as a fraction of width of the chart, + based on . + + + + + Gets or sets the height/bottom of the chart element as a fraction of height of the chart, + based on . + + + + + Gets or sets the xTL value + + + + + Gets or sets the yTL value + + + + + Gets or sets the xBR value + + + + + Gets or sets the yBR value + + + + + Returns the flag options for this class. + + + + + Represents rich text string in the workbook. + + + + + Common wrapper code. Implements BeginUpdate and EndUpdate methods. + + + + + This interface describes methods for optimized object update. + + + + + This should be called before several updates. + + + Invoking this method improves the performance. + + + + + This method should be called after several updates. + + + Invoking this method improves the performance. + + + + + Supports cloning, which creates a new instance of a class + with the same value as an existing instance. + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Number of begin update calls that have no corresponding end update. + + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object. + + + + + Creates a copy of the current object. + + Parent object for the new object. + A copy of the current object. + + + + Returns number of begin update calls that have no corresponding end update. Read-only. + + + + + Represents rich text of the chart title. + + + + + Sets the specified font formatting for the specified range of characters in chart title. + + First character of the range. + Last character of the range. + Font to set. + + To know more about charts refer this link. + + The following code illustrates how to use the SetFont method. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Create a font style for RichText + IFont font = chart.ChartTitleArea; + font.Color = ExcelKnownColors.Orange; + font.FontName = "Broadway"; + + //Create a RichTextString object + chart.ChartTitleArea.Text = "Sample Chart"; + IChartRichTextString richText = chart.ChartTitleArea.RichText; + + //Sets the specified font formatting for the specified range of characters in chart title + richText.SetFont(0, 5, font); + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets object for the specified formatting run. + + Formatting run to return its font + Returns a font of RichText + + To know more about charts refer this link. + + The following code illustrates how to use the GetFont method. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + Syncfusion.XlsIO.Parser.Biff_Records.Charts.ChartAlrunsRecord.TRuns[] runs = sheet.Charts[0].ChartTitleArea.RichText.FormattingRuns; + + //Gets IFont object for the specified formatting run + IFont font = sheet.Charts[0].ChartTitleArea.RichText.GetFont(runs[1]); + if (font != null) + { + //Your code here + } + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets the chart title text. Read-only. + + + To know more about charts refer this link. + + The following code illustrates use of Text property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Create a font style for RichText + IFont font = chart.ChartTitleArea; + font.Color = ExcelKnownColors.Orange; + font.FontName = "Broadway"; + + //Set the rich text font + chart.ChartTitleArea.Text = "Sample Chart"; + IChartRichTextString richText = chart.ChartTitleArea.RichText; + richText.SetFont(0, 5, font); + + //Get the RichText length or count + int richTextLength = chart.ChartTitleArea.RichText.Text.Length; + if (richTextLength != 0) + { + //Your code here + } + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets the formatting runs of the chart title. Read-only. + + + To know more about charts refer this link. + + The following code illustrates use of FormattingRuns property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //Gets the formatting runs of the chart title + int length = sheet.Charts[0].ChartTitleArea.RichText.FormattingRuns.Length; + if(length != 0) + { + //Your code here + } + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Low level text object. + + + + + Parent workbook. + + + + + Indicates whether string is read-only. + + + + + Represents the parent object + + + + + Represents the chart text area + + + + + Initializes new instance of the RichTextString. + + Application object for the RichTextString. + Parent object for the RichTextString. + + + + Initializes new instance of the RichTextString. + + Application object for the RichTextString. + Parent object for the RichTextString. + Indicates whether string is read-only. + + + + Initializes new instance of the RichTextString. + + Application object for the RichTextString. + Parent object for the RichTextString. + Indicates whether string is read-only. + Indicates whether to create inner TextWithFormat. + + + + Initializes new instance of the RichTextString. + + Application object for the RichTextString. + Parent object for the RichTextString. + Text to wrap. + + + + Searches for all necessary parent objects. + + + + + Sets font for range of characters. + + First character of the range. + Last character of the range. + Font to set. + + + + Gets font for the specified formatting run. + + Formatting run to return its font + + + + Adds font to all required collections.. + + Font to add. + Font index in the collection. + + + + Gets the formatting runs of rich-text + + + + + Gets or sets the chart text area + + + + + Gets the text + + + + + Returns parent object. Read-only. + + + + + Returns parent application object. Read-only. + + + + + Class to hold Xml collection. + + + + + Map information element name. + + + + + Selection namespace attribute name. + + + + + Collection of XmlMap object. + + + + + Represent parent workbook. + + + + + Create an instance of XmlMapCollection. + + Parent workbook object. + + + + Added the XML document to the workbook using file path. + + Represents the XML file + + + + Adds the XML map to the workbook based on the specified XML data stream. + + Stream data of the xml file. + Returns TRUE if the XML is valid. + The stream should be passed as file stream to bind the xml + + + + Add XmlMap object to the collection. + + XML stream + Destination sheet + Starting row + Starting column + Returns TRUE if the XML is valid. + + + + Checks whether given root element string exists in the collection. + + Root element as string + True if root element string exists. + + + + Checks whether given name string exists in the collection. + + Name element as string + True if Name string exists. + + + + Parse and intialize mapping information. + + XML reader. + + + + Parses the map databinding. + + XML reader. + XmlMap information. + + + + To get XmlMap object from the collection by schema id. + + Schema id + Returns XmlMap object if schema id found. Return null as default. + + + + Serilaize the mapping information. + + Xml writer. + + + + Dispose the collection. + + + + + Returns XmlMap object from its collection for the given index. Read-Only. + + Zero-based index value. + + + + Returns the number of XmlMap object in the collection. Read-Only Integer. + + + + + Class represent Date filter for a column. + + + + + Common interface for all filter type, except custom filter. + + + + + Specifies the type of filter. Read-Only. + + + + + Relative date filter type used. + + + + + Represents type of filter. + + + + + Relative date filter type used. + + + + + Class represent DateTime filter for a column + + + + + Common interface for all combination filter type. + + + + + Specifies the combination filter type(either Text or DateTime). + + + + + Represent Date and Time. + + + + + Represents datetime grouping type. + + + + + Represent Date and Time. Read-Only. + + + + + Represents datetime grouping type. + + + + + Represents type combination filter. + + + + + Represents the event settings to export data to a data table + + + + + Represents the row index of Excel document. + + + + + Represents the column index of Excel document. + + + + + Represents the column index of data table. + + + + + Represents the cell value of Excel document. + + + + + Represents the ExportDataTableEventOption. + + + + + Represents the cell range. + + + + + Represents the column type of Data table. + + + + + Represents the value of data table. + + + + + Constructor of ExportDataTableEventArgs class. + + + + + Gets the column index of the data table that is beign updated. + + + + + System type that gets the column type of the data table. Read only. + + + + + Gets the Excel cell range. + + + + + Gets the Excel row index that is being exported to the data table. + + + + + Gets the column index of the data table that is being updated. + + + + + Gets the Excel cell value that is being exported to the data table. + + + + + Gets or sets a value in the data table. + + + + + Gets or sets the export data table event action. + + + + + Font color. + + + + + Border collapse. + + + + + Font family. + + + + + Font size. + + + + + Background color. + + + + + All border. + + + + + Top border. + + + + + Bottom border. + + + + + Right border. + + + + + Left border. + + + + + Text align. + + + + + Width of table. + + + + + Specifies Font color. + + + + + Specifies background color. + + + + + Specifies font family. + + + + + Specifies font size. + + + + + Specifies all border. + + + + + Specifies top border. + + + + + Specifies bottom border. + + + + + Specifies left border. + + + + + Specifies right border. + + + + + Specifies border collapse. + + + + + Initializes a HTMLToExcelConverter instance. + + + + + Parses HTML table from HTML content. + + HTML text. + Worksheet to export data into. + Specifies the row in the worksheet. + Specifies the column in the worksheet. + + + + Converts the CSS style to Cell Style. + + Css Style + IStyle instance + + + + Converts text format into Cell Style. + + Text Format + IStyle instance. + Cell Range + + + + Gets HTML alignment equal Excel horizontal alignment + + alignment value + Horizontal Alignment + + + + Gets HTML alignment equal Excel vertical alignment + + alignment value + Vertical Alignment + + + + Parses border style from CSS style string. + + Border + Border properties in CSS. + IBorder + + + + Parse CSS style. + + XmlNode of CSS + Dictionary + + + + Parse table row in HTML. + + XML node + Worksheet to export data into. + Worksheet row. + Worksheet column. + Dictionary of CSS styles. + HTML table row index. + + + + Parse table column in HTML. + + XML Node + Worksheet to export data. + Row + Column + + + + Parses the style. + + Style node. + + + + Applies textformat to style. + + Text format. + Cell Style. + + + + Represents a writer that provides JSON data. + + + + + Gets or sets a value indicating how JSON text output should be formatted. + + + + + Represents whether the JSON will be written in Schema format. + + + + + Gets or sets how many IndentChars to write for each level in the hierarchy when Formatting is set to JsonFormatting.Indented. Default value is 2. + + + + + Gets or sets which character to use for indenting when Formatting is set to JsonFormatting.Indented. Default character is blank space (' '). + + + + + Writes the beginning of a JSON object. + + + + + Writes the end of a JSON array. + + + + + Writes the beginning of a JSON array. + + + + + Writes the end of a JSON array. + + + + + Writes the property name of a name/value pair on a JSON object. + + Name to be written + + + + Writes a String value. + + Value to be written + + + + Get spaces for writer + + + + + + Initializes a new instance of the JsonWriter class using the specified StreamWriter. + + Stream writter + + + + Initializes a new instance of the JsonWriter class using the specified stream. + + StreamWriter stream + + + + Releases unmanaged and - optionally - managed resources. + + + + + Gets or sets a value indicating how JSON text output should be formatted. + + + + + Represents whether the JSON will be written in Schema format. + + + + + Gets or sets how many IndentChars to write for each level in the hierarchy when Formatting is set to JsonFormatting.Indented. + + + + + Gets or sets which character to use for indenting when Formatting is set to JsonFormatting.Indented + + + + + Summary description for IEncryptor. + + + + + Decrypts DataProvider and writes result back into it. + + Provider to decrypt. + Offset to the first byte to decrypt. + Number of bytes to decrypt. + Position of the record in the stream. + + + + Decrypts byte array and writes result back into it. + + Array to decrypt. + Offset to the first byte to decrypt. + Number of bytes to decrypt. + + + + Sets information required to decrypt. + + Unique document id. + Encrypted document id. + Digest used to verify the entered password. + Password to use for verification and decryption. + True if password was verified and method succeeded. + + + + represents Constant read length + + + + + Represents the pass length + + + + + Represents block size + + + + + Represents starting position + + + + + Represents byte max value + + + + + Represents VerifierHash + + + + + Represents Verifier + + + + + Represents salt + + + + + represents password + + + + + Represents StateVector with null value + + + + + represents internal x vector + + + + + represents internal y vector + + + + + represents block number + + + + + represents key + + + + + Write byte + + + + + Indicates whether S vector should consist pre value + + + + + Generates the key + + + + + + + + + Verifies the password. + + True if password was verified. + + + + Combines the give arrays. + + + + + + + creates Decryption for provided data + + + + + + + + create Decryption for provided data + + + + + + + + + + Decrypt the buffer + + + + + + + + + + Creates S vector array when S vector is null + + + + + + Decryption member + + + + + + + + + Set the encryption value of the sheet + + + + + + + + + + + + Represents State vector + + + + + represents Key. + + + + + Indicates whether bytes needs to be write or not + + + + + Indicates whether the record already decrypted or not + + + + + Bullet class + + + + + Typeface value + + + + + Panose + + + + + Pitch family + + + + + Char set + + + + + Bullet character + + + + + Gets bullet type for the character. + + Bullet char + BulletType + + + + Sets bullet character for the type. + + Bullet char + BulletType + + + + Specifies the typeface attribute value. + + + + + Specifies the panose attribute value. + + + + + Specifies the pitchfamily attribute value. + + + + + Specifies the typeface charset value. + + + + + Specifies the bullet character. + + + + + + Gets the Bullet type + + + + + Bullet type enum + + + + + Default run properties. + + + + + Bold + + + + + Italic + + + + + Underline + + + + + Font size + + + + + Strike through + + + + + Indicates whether the font is bold. + + + + + Indicates whether the font is underline. + + + + + Indicates whether the font is italic. + + + + + Specifies the font size. + + + + + Specifies the strike through type + + + + + Strike type enum for level styles. + + + + + Level properties + + + + + Run properties + + + + + Text alignment + + + + + Default tab size + + + + + East Asian line break + + + + + Font alignment + + + + + Indent value + + + + + Latin line break + + + + + Left Margin + + + + + Right Margin + + + + + Indicates whether the text is right to left + + + + + Run properties of the current level. + + + + + Text alignment type + + + + + Default tab size + + + + + East asian break. + + + + + Font alignment type. + + + + + Indent level. + + + + + Latin Break. + + + + + Left margin. + + + + + Right margin. + + + + + Indicates whether the text is right to left direction. + + + + + Level properties text align types. + + + + + Level properties font align types. + + + + + Outline Wrapper for Outline. Redirects the properties to the Outline + + + + + Contains outline information about. + + + + + Outline level. + + + + + Indicates whether object is collapsed. + + + + + Indicates whether object is hidden. + + + + + Index of extended format. + + + + + Row or column index. + + + + + Contains outline information about. + + + + + First Index of the row/column. + + + + + Last index of the row/column. + + + + + Indicates the Outline object + + + + + Indicates the Grouped range + + + + + Indicates the ExcelGroupBy type + + + + + Represents the outline first index + + + + + Represents the outline last index + + + + + + Represents the Outline range + + + + + Represents the Group by enumeration + + + + + Represents the Outline Level + + + + + Represents Is Collapsed property of IOutline + + + + + Represents Is Hidden property of IOutline + + + + + Represents the Extended format index of outline object + + + + + Represents the index value + + + + + Returns or sets the First Row/Column index for the Outline + + + + + Returns or sets the Last Row/Column index for the Outline + + + + + Returns or sets the IOutline object + + + + + Returns or sets the index value + + + + + Returns or sets the IRange value for a specified outline + + + + + Returns or sets the Excel Group by Enum value + + + + + Returns or sets the Extended format index value for an outline range + + + + + Returns or sets the IsHidden value for an outline + + + + + Returns or sets the IsCollapsed value for an outline + + + + + Returns or sets the outline level value for an outline + + + + + + This class contains utility methods, that cannot be logically placed in any other class. + + + + + Represents the outline levels dictionary collection + + + + + Represents the outline level order + + + + + + + + + + Adds the row level group. + + + + + Adds the row level group. + + + + + Ungroup the row level. + + + + + Ungroup the column level. + + + + + Adds the column level. + + + + + Adds the column level. + + + + + Inserts the levels as per key. + + + + + Returns or sets the outline dictionary collection + + + + + Adds the level into collection as per key. + + + + + This is the base class for all collections. + + + + + CollectionBase + + + + + + List with collection items. + + + + + Initializes a new instance of the class with the default initial capacity. + + + + + Initializes a new instance of the class with the specified capacity. + + The number of elements that the new list can initially store. + + + + Removes all objects from the System.Collections.CollectionBase instance. + + + + + Inserts an element into the list at the specified index. + + The zero-based index at which item should be inserted. + The object to insert. The value can be null for reference types. + + + + Returns an enumerator that iterates through this instance. + + An enumerator for this instance. + + + + Performs additional custom processes when clearing the contents of this instance. + + + + + Performs additional custom processes after clearing the contents of this instance. + + + + + Performs additional custom processes before inserting a new element into this instance. + + The zero-based index at which to insert value. + The new value of the element at index. + + + + Performs additional custom processes after inserting a new element into this instance. + + The zero-based index at which to insert value. + The new value of the element at index. + + + + Performs additional custom processes when removing an element from this instance. + + The zero-based index at which value can be found. + The value of the element to remove from index. + + + + Performs additional custom processes after removing an element from this instance. + + The zero-based index at which value can be found. + The value of the element to remove from index. + + + + Performs additional custom processes before setting a value in this instance. + + The zero-based index at which oldValue can be found. + The value to replace with newValue. + The new value of the element at index. + + + + Performs additional custom processes after setting a value in this instance. + + The zero-based index at which oldValue can be found. + The value to replace with newValue. + The new value of the element at index. + + + + Removes the element at the specified index of this instance. + + The zero-based index of the element to remove. + + + + Gets the index of the item + + + + + + + Adds the item. + + + + + + Checks whether the list contains the item. + + + + + + + Copies the array to specified index. + + + + + + + Removes the specified item. + + + + + + + Gets or sets the number of elements that the System.Collections.CollectionBase can contain. + + + + + Gets the number of elements contained in the System.Collections.CollectionBase instance. + + + + + Gets the list of elements in the instance. + + + + + Gets the list of elements in the instance. + + + + + Gets or sets the list of elements in the instance. + + + + + + + Gets if the collection is read-only. + + + + + An Application object that represents the Excel application. + + + + + The parent object for the specified object. + + + + + If True, events will not be raised; if False, events will be raised. + + + + + Default constructor. To prevent class creation by default constructor. + + + + + Creates collection and sets its Application and Parent values. + + + Application object that represents the Excel application. + + Parent object of this collection. + + + + This method raises the Changed event. + + + + + OnClear is invoked before Clear behavior. + + + + + OnClear is invoked after Clear behavior. + + + + + Performs additional processes before inserting + a new element into the collection. + + The zero-based index at which to insert value. + The new value of the element at index. + + + + Performs additional processes after inserting + a new element into the collection. + + The zero-based index at which to insert value. + The new value of the element at index. + + + + Performs additional processes before removing + an element from the collection. + + + The zero-based index at which the value can be found. + + + The value of the element to remove from index. + + + + + Performs additional processes after removing + an element from the collection. + + The zero-based index at which the value can be found. + The value of the element to remove from index. + + + + Performs additional processes before setting + a value in the collection. + + + The zero-based index at which oldValue can be found. + + The value to replace with newValue. + The new value of the element at index. + + + + Performs additional processes after setting a value in the collection. + + The zero-based index at which oldValue can be found. + The value to replace with newValue. + The new value of the element at the index. + + + + Method used to find parent within a specific type. + + Parent type to search. + Found parent if was parent was found or NULL otherwise. + + When there is cycle in object tree. + + + + + Method used to find parent within a specific type. + + Parent type to search. + Indicates whether to look into subclasses. + Found parent if was parent was found or NULL otherwise. + + When there is cycle in object tree. + + + + + Sets parent object for class. + + Parent object for sets. + + + + Creates copy of the collection. + + Parent object for the new collection. + A copy of the collection. + + + + Enlarges internal storage if necessary. + + Required size. + + + + Clear max values from dictionary. + + + + + Generates default name. + + Names collection. + Start string. + Returns string with new name. + + + + Generates default name. + + Names collection. + Start string. + Returns string with new name. + + + + Generates ID. + + Shape collection. + Returns new id. + + + + Generate default name. + + Start string. + Collection with names. + Returns new name. + + + + Changes name. + + Hash table with names + + + + + Read-only. An Application object that represents the Excel application. + + + + + Read-only. The parent object for the specified object. + + + + + Gets / sets whether class can raise events. + + + + + Application object. Read-only. + + + + + Gets maximum value collection + + + + + Change in the collection. + + + + + Raised by class before real cleaning of collection. + + + + + Raised by class after collection clean process. + + + + + Raised by class before item will be added into the collection. + + + + + Raised by class after item is added to the collection. + + + + + Raised by class before real item is removed from the collection. + + + + + Raised by class after item is removed from the collection storage + + + + + Raised by class before item is replaced in the collection. + + + + + Raised by class after item is replaced in the collection. + + + + + Delegate for Clear event. + + + + + Delegate for Change event. + + + + + Delegate for Set event. + + + + + Represents a collection of parameters collection. + + + + + Adds a parameter to the collection. + + Returns the newly added instance. + + To add a condition to the parameter we use method. It adds and returns a new parameter + object, that we can use to set and get parameter and properties. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Save and Dispose. + workbook.SaveAs("QueryTables.xlsx"); + workbook.Close(); + } + + + + + + Removes the parameter from the collection. + + Index of the parameter to be removed. + + The following code illustrates how to remove a particular condition from the parameter collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Save and Dispose. + workbook.SaveAs("QueryTables.xlsx"); + workbook.Close(); + } + + + + + + + Gets the number of parameters in the query table. Read-only. + + + returns the number of conditions applied. Here for example, we check value + before and after applying three conditions. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Save and Dispose. + workbook.SaveAs("QueryTables.xlsx"); + workbook.Close(); + } + + //Output will be + //3 + + + + + + Gets a parameter of the specified index from the collection. Read-only. + + + The following code illustrates how to access the first condition from . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Save and Dispose. + workbook.SaveAs("QueryTables.xlsx"); + workbook.Close(); + } + + + + + + Creates and add a new query table parameter to the collection. + + Name of the parameter + Data type of the parameter + Created parameter + + + + Creates a new query table parameter. + + Name of the parameter + Data type of the parameter + Created parameter + + + + Clones query table parameters collection. + + Parent object. + Returns cloned object. + + + + Dispose the parameters collection. + + + + + Represents the parameter used in a query table. + + + + + Represents the parameter used in a query table. + + + + + Set parameter type and value. + + + + + Gets or sets the data type of the query parameter. + + + + + Gets or sets the parameter type. + + + + + Returns the phrase that prompts the user for a parameter value in a parameter query. + + + + + The parameter value. + + + + + Returns a Range object that represents the cell that contains the value of the specified query parameter. + + + + + Returns or sets the name of the object. + + + + + True if the specified query table is refreshed whenever you change the parameter value of a parameter query. + + + + + Occurs while refresh the table whenever the parameter type is set as prompt. + + + + + Represents the data type of query parameter. + + + + + Represents the parameter type. + + + + + Represents the phrase that prompts the user for a parameter value in a parameter query. + + + + + Represents the parameter value. + + + + + Represents a Range object that represents the cell that contains the value of the specified query parameter. + + + + + Represents the name of the object. + + + + + True if the specified query table is refreshed whenever you change the parameter value of a parameter query. + + + + + Represents a Range address that represents the cell that contains the value of the specified query parameter. + + + + + byte value used as flag to maintains the value type + + + + + Initializes new instance of the query table parameter. + + Application object for the new shape. + Parent object for the new shape. + + + + Initializes new instance of the query table parameter. + + Application object for the new shape. + Parent object for the new shape. + Name of the parameter + Data type of the parameter + + + + Set parameter type and value. + + Parameter type. + Parameter value. + + + + Raise the prompt event. + + + True if the parameter value is set + + + + Clones query table parameter. + + Parent object. + Returns cloned object. + + + + Dispose the parameter. + + + + + Occurs while refresh the table whenever the parameter type is set as prompt. + + + + + Gets or sets the data type of the query parameter. + + + + + Gets or sets the parameter type. + + + + + Returns the phrase that prompts the user for a parameter value in a parameter query. + + + + + The parameter value. + + + + + Returns a Range object that represents the cell that contains the value of the specified query parameter. + + + + + Returns or sets the name of the object. + + + + + True if the specified query table is refreshed whenever you change the parameter value of a parameter query. + + + + + Represents a Range address that represents the cell that contains the value of the specified query parameter. + + + + + byte value used as flag to maintains the value type + + + + + Event delegate for UpdateNamedRange event. + + The CalcEngine. + The for this event. + + + + The event args for the UpdateNamedRange event, which is raised whenever the CalcEngine calculate the intersection range of two named range . + + + + + Gets or sets the value of the parameter. + + + + + Add the filter column filter to filter collections + + + + + + Get the filter column filter based on Index. + + + + + + + Range to which auto filter is applied + + + + + adding the pivot filter + + + + + + property of range to whcih filter is applied + + + + + get the pivot Filter based on Index + + + + + + + + + + + + Represents the pivot cell format + + + + + Represents Pivot Cell Format + + + + + Gets or sets the background color from predefined colors (). + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.BackColor = ExcelKnownColors.Red; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets and sets the back ground RGB color. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.BackColorRGB = System.Drawing.Color.FromArgb(255, 255, 0, 0); + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets and sets the pattern style from pivot cell format. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.PatternStyle=ExcelPattern.DarkVertical; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets RGB color to pattern. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.PatternStyle = ExcelPattern.DarkVertical; + cellFormat.PatternColorRGB = System.Drawing.Color.FromArgb(255, 255, 0, 0); + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the pattern color from predefined colors (). + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.PatternStyle = ExcelPattern.DarkVertical; + cellFormat.PatternColor = ExcelKnownColors.Green; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets the Font color from predefined colors (). + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.FontColor=ExcelKnownColors.Red; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets RGB color to font. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.FontColorRGB=System.Drawing.Color.FromArgb(255, 0, 0, 255); + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets RGB color to font. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.FontSize = 14; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets RGB color to font. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.FontName = "Arial"; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets a boolean value indicating whether the font is bold. + + Default value is false. + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.Bold = true; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets a boolean value indicating whether the font is italic. + + Default value is false. + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.Italic = true; + + workbook.SaveAs("PivotFormat.xlsx"); + + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets the underline type from the pivot cell format. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.Underline =ExcelUnderline.Single; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets a boolean value indicating whether the font is Strike. + + Default value is false. + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.StrikeThrough=true; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets the Top Border color from predefined colors (). + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.TopBorderStyle=ExcelLineStyle.Thick; + cellFormat.TopBorderColor=ExcelKnownColors.Green; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets RGB color to Top border. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.TopBorderStyle=ExcelLineStyle.Thick; + cellFormat.TopBorderColorRGB=System.Drawing.Color.FromArgb(255, 0, 255, 0); + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets the Top border line style. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.TopBorderStyle=ExcelLineStyle.Thick; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets the Horizontal Border color from predefined colors (). + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.HorizontalBorderStyle=ExcelLineStyle.Thick; + cellFormat.HorizontalBorderColor=ExcelKnownColors.Green; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets RGB color to horizontal border. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.HorizontalBorderStyle=ExcelLineStyle.Thick; + cellFormat.HorizontalBorderColorRGB=System.Drawing.Color.FromArgb(255, 0, 255, 0); + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets the Horizontal border line style. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.HorizontalBorderStyle = ExcelLineStyle.Thick; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets the Vertical Border color from predefined colors (). + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.VerticalBorderStyle=ExcelLineStyle.Thick; + cellFormat.VerticalBorderColor=ExcelKnownColors.Green; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets RGB color to Vertical border. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.VerticalBorderStyle=ExcelLineStyle.Thick; + cellFormat.VerticalBorderColorRGB=System.Drawing.Color.FromArgb(255, 0, 255, 0); + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets the Vertical border line style. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.VerticalBorderStyle = ExcelLineStyle.Thick; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets the bottom border color from predefined colors (). + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.BottomBorderStyle=ExcelLineStyle.Thick; + cellFormat.BottomBorderColor=ExcelKnownColors.Green; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets RGB color to bottom border. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.BottomBorderStyle=ExcelLineStyle.Thick; + cellFormat.BottomBorderColorRGB=System.Drawing.Color.FromArgb(255, 0, 255, 0); + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets the bottom border line style. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.BottomBorderStyle=ExcelLineStyle.Thick; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets the right border color from predefined colors (). + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.RightBorderStyle=ExcelLineStyle.Thick; + cellFormat.RightBorderColor=ExcelKnownColors.Green; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets RGB color to right border. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.RightBorderStyle=ExcelLineStyle.Thick; + cellFormat.RightBorderColorRGB=System.Drawing.Color.FromArgb(255, 0, 255, 0); + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets the right border line style. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.RightBorderStyle=ExcelLineStyle.Thick; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets the left border color from predefined colors (). + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.LeftBorderStyle=ExcelLineStyle.Thick; + cellFormat.LeftBorderColor=ExcelKnownColors.Green; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets RGB color to left border. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.LeftBorderStyle=ExcelLineStyle.Thick; + cellFormat.LeftBorderColorRGB=System.Drawing.Color.FromArgb(255, 0, 255, 0); + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets the left border line style. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.LeftBorderStyle=ExcelLineStyle.Thick; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Horizontal alignment. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + //Set alignment + cellFormat.HorizontalAlignment = ExcelHAlign.HAlignRight; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Indent level. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + //Set indent level + cellFormat.IndentLevel = 2; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Vertical alignment. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + //Set alignment + cellFormat.VerticalAlignment = ExcelVAlign.VAlignCenter; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets the diagonal border color from predefined colors (). + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.DiagonalBorderStyle=ExcelLineStyle.Thick; + cellFormat.DiagonalBorderColor=ExcelKnownColors.Green; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets the diagonal border color (). + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.DiagonalBorderStyle = ExcelLineStyle.Thick; + cellFormat.DiagonalBorderColorRGB=System.Drawing.Color.FromArgb(255, 0, 255, 0); + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets / sets line style of the diagonal border. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.DiagonalBorderStyle=ExcelLineStyle.Thick; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Text direction, the reading order for far east versions. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + //Set reading order + cellFormat.ReadingOrder = ExcelReadingOrderType.RightToLeft; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + True - Indicates that text is wrapped at right border. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + //Set wrap text + cellFormat.WrapText = true; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + True- Indicates that the contents are shrunk to fit into cell. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + //Set shrink to fit + cellFormat.ShrinkToFit = true; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Indicates whether cell with this XF is locked. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + + //Set FormulaHidden + cellFormat.FormulaHidden = true; + + //Set locked + cellFormat.Locked = true; + + //Enable sheet protection + worksheet.Protect("", ExcelSheetProtection.All); + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Indicates whether formula is hidden. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + + //Set FormulaHidden + cellFormat.FormulaHidden = true; + + //Set locked + cellFormat.Locked = true; + + //Enable sheet protection + worksheet.Protect("", ExcelSheetProtection.All); + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Text rotation angle: + 0 Not rotated + 1-90 1 to 90 degrees counterclockwise + 91-180 1 to 90 degrees clockwise + 255 Letters are stacked top-to-bottom, but not rotated. + + + Thrown when value is more than 0xFF. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + //Set rotation + cellFormat.Rotation = 40; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets number format index of the conditional format rule. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + //Set number format index + cellFormat.NumberFormatIndex = 5; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Gets or sets number format of the conditional format rule. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + //Set number format + cellFormat.NumberFormat = "#,##0.00_);[Red](#,##0.00)"; + + workbook.SaveAs("PivotFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + } + + + + + + Conditional format color. Read-only. + + + + + Conditional format background color. Read-only. + + + + + Conditional format top border color. Read-only. + + + + + Conditional format bottom border color. Read-only. + + + + + Conditional format left border color. Read-only. + + + + + Conditional format right border color. Read-only. + + + + + Gets pivot cell format horizontal border color object. Read-only. + + + + + Gets pivot cell format vertical border color object. Read-only. + + + + + Get/set DiagonalUpBorder color. + + + + + Conditional format font color. Read-only. + + + + + True if Number format is present. False otherwise. + + + + + + Flag for cell protection (cell locked and formula hidden). + + + + + True if background color is present. otherwise, False. + + + + + True if the pivot cell format contains border formatting. otherwise, False. + + + + + True if the pivot cell format contains font color present. otherwise, Flase. + + + + + True if top border line style and color is modified. otherwise, False. + + + + + True if bottom border line style and color is modified. otherwise, False. + + + + + True if right border line style and color is modified. otherwise, False. + + + + + True if left border line style and color is modified. otherwise, False. + + + + + True if bottom border line style and color is modified. otherwise, False. + + + + + True if Horizontal border line style and color is modified. otherwise, False. + + + + + True if diagonal border line style and color is modified. otherwise, False. + + + + + True if the pivot cell format contains font formatting. otherwise, False. + + + + + True if the pivot cell format contains pattern formatting. otherwise, False. + + + + + True if the pivot cell format contains pattern format present. otherwise, Flase. + + + + + Parent pivot format. + + + + + Color object that stores pivot cell format background color. + + + + + Represent the fill pattern style. + + + + + Color object that stores pivot cell format color. + + + + + Color object that stores pivot cell format font color color. + + + + + Represent the font size. + + + + + Represent the font name. + + + + + Set the font style to bold or not. + + + + + Set the font style to italic or not. + + + + + Gets or sets the underline type for the conditional format. + + + + + Set the strike through to font or not. + + + + + Color object that stores pivot cell format top border color. + + + + + set the line style of the top border. + + + + + Color object that stores pivot cell format bottom border color. + + + + + set the line style of the bottom border. + + + + + Color object that stores pivot cell format right border color. + + + + + Set the line style of the right border. + + + + + Color object that stores pivot cell format left border color. + + + + + Set the line style of the left border. + + + + + Color object that stores pivot cell format diagonal border color. + + + + + Set the diagonal border line style. + + + + + Check the top border modified or not. + + + + + Check the bottom border modified or not. + + + + + Check the left border modified or not. + + + + + Check the right border modified or not. + + + + + Check the diagonal border modified or not. + + + + + Check the border format present or not. + + + + + Check the font color present or not. + + + + + Check the font format present or not. + + + + + Check the fill pattern back color modified or not. + + + + + Check the pattern format present or not. + + + + + Check the pattern Color modified or not. + + + + + Check the vertical border modified or not + + + + + Check the Horizontal border modified or not. + + + + + Color object that stores pivot cell format vertical border color. + + + + + Color object that stores pivot cell format horizontal border color. + + + + + Set the vertical border line style. + + + + + Set the horizontal border line style. + + + + + Horizontal alignment. + + + + + Indent level. + + + + + Vertical alignment. + + + + + Text rotation angle: + + + + + Text direction, the reading order for far east versions. + + + + + True - Indicates that text is wrapped at right border. + + + + + True- Indicates that the contents are shrunk to fit into cell. + + + + + Indicates whether cell with this XF is locked. + + + + + Indicates whether formula is hidden. + + + + + Represents the pivot table worksheet. + + + + + Number format index. + + + + + True if record contains number format. + + + + + Flag for horizontal and vertical alignment, text wrap, indentation, + orientation, rotation, and text direction. If False, the attribute + of parent style is used. + + + + + Flag for cell protection (cell locked and formula hidden). + + + + + Constructor to set the pivot cell format to set the parent pivot cell formats. + + + + + + Represent this method remove the pivot cell format in pivot cell format list. + + + + + Clone the pivot cell format and set the parent. + + pivot cell formats object + Clone pivot cell format + + + + Dispose the pivot cell format reference value. + + + + + Equals the pivot cell format object. + + pivot cell format object + True, If two pivot cell format is equal, Otherwise false. + + + + This method should be called after any changes. + Sets Saved property of the parent workbook to False. + + + + + Initializes color objects. + + + + + Update the top border color. + + + + + Update the bottom border color + + + + + Update the back color. + + + + + Update pattern Color. + + + + + Update left border color. + + + + + Update the right border Color. + + + + + Update the diagonal border Color. + + + + + Update the font Color. + + + + + Update the border style present. + + + + + Update the font format present. + + + + + Update the pattern format present. + + + + + Update the vertical border color. + + + + + Update the horizontal border color. + + + + + Gets and sets the pivot cell formats. + + + + + Gets or sets the pattern background color from predefined colors (). + + + + + Gets or sets the pattern background color (). + + + + + Gets or sets the fill pattern style. + + + + + Gets or sets the pattern background color from predefined colors (). + + + + + Gets or sets the color (). + + + + + Gets or sets the font color from predefined colors (). + + + + + Gets or sets the pattern background color (). + + + + + Represent the font size. + + + + + Represent the font name. + + + + + True if the bold is present font otherwise, False. + + + + + True if the italic is present font otherwise, False. + + + + + Gets or sets the underline type for the conditional format. + + + + + True if the strike through is present font otherwise, False. + + + + + Gets or sets the top border color from predefined colors (). + + + + + Gets or sets the top border color (). + + + + + Gets and sets the top border line style. + + + + + Gets and sets the vertical border color. + + + + + Gets or sets the vertical border color (). + + + + + Gets and sets the vertical border line style. + + + + + Gets and sets the horizontal border color. + + + + + Gets or sets the Horizontal border color (). + + + + + Gets and sets the Horizontal border line style. + + + + + Gets or sets the bottom border color from predefined colors (). + + + + + Gets or sets the bottom color (). + + + + + Gets or sets the bottom border line style. + + + + + Gets or sets the top right color from predefined colors (). + + + + + Gets or sets the right border color (). + + + + + Gets or sets the right border line style. + + + + + Gets or sets the left border color from predefined colors (). + + + + + Gets or sets the left border color (). + + + + + Gets or sets the left border line style. + + + + + True if top border line style and color is modified. otherwise, False. + + + + + True if bottom border line style and color is modified. otherwise, False. + + + + + True if right border line style and color is modified. otherwise, False. + + + + + True if left border line style and color is modified. otherwise, False. + + + + + True if diagonal border line style and color is modified. otherwise, False. + + + + + True if the pivot cell format contains font formatting. otherwise, False. + + + + + True if the pivot cell format contains pattern formatting. otherwise, False. + + + + + True if the pivot cell format contains pattern format present. otherwise, Flase. + + + + + True if background color is present. otherwise, False. + + + + + True if the pivot cell format contains border formatting. otherwise, False. + + + + + True if the pivot cell format contains font color present. otherwise, Flase. + + + + + Gets pivot cell format font color object. Read-only. + + + + + Gets pivot cell format color object. Read-only. + + + + + Gets pivot cell format back color object. Read-only. + + + + + Gets pivot cell format top border color object. Read-only. + + + + + Gets pivot cell format bottom border color object. Read-only. + + + + + Gets pivot cell format horizontal border color object. Read-only. + + + + + Gets pivot cell format vertical border color object. Read-only. + + + + + Gets pivot cell format right border color object. Read-only. + + + + + Gets table style eleement left border color object. Read-only. + + + + + True if bottom border line style and color is modified. otherwise, False. + + + + + True if Horizontal border line style and color is modified. otherwise, False. + + + + + Horizontal alignment. + + + + + Indent level. + + + + + Vertical alignment. + + + + + Get/set DiagonalUpBorder color. + + + + + Gets or sets the diagonal border color from predefined colors (). + + + + + Gets or sets the diagonal border color (). + + + + + Gets / sets line style of the diagonal border. + + + + + Text direction, the reading order for far east versions. + + + + + True - Indicates that text is wrapped at right border. + + + + + True- Indicates that the contents are shrunk to fit into cell. + + + + + Indicates whether cell with this XF is locked. + + + + + Indicates whether formula is hidden. + + + + + Text rotation angle: + 0 Not rotated + 1-90 1 to 90 degrees counterclockwise + 91-180 1 to 90 degrees clockwise + 255 Letters are stacked top-to-bottom, but not rotated. + + + Thrown when value is more than 0xFF. + + + + + Gets or sets number format index of the conditional format rule. + + + + + Gets or sets number format of the conditional format rule. + + + + + True if Number format is present. False otherwise. + + + + + + Flag for cell protection (cell locked and formula hidden). + + + + + Represents the pivot cell format wrapper + + + + + Parent pivot format + + + + + Array that contains all cells. + + + + + Represents the pivot table worksheet. + + + + + Constructor to set the pivot cell format Wrapper from pivot cell formats collection. + + pivot formats collection + pivot cell formats collection + + + + Represent this method remove the pivot cell format in pivot cell format list. + + + + + Dispose the pivot cell format reference value. + + + + + Equals the pivot cell format object. + + pivot cell format object + True, If two pivot cell format is equal, Otherwise false. + + + + This method should be called after any changes. + Sets Saved property of the parent workbook to False. + + + + + Gets or sets the pattern background color from predefined colors (). + + + + + Gets or sets the pattern background color (). + + + + + Gets or sets the fill pattern style. + + + + + Gets or sets the pattern background color from predefined colors (). + + + + + Gets or sets the color (). + + + + + Gets or sets the font color from predefined colors (). + + + + + Gets or sets the pattern background color (). + + + + + Represent the font size. + + + + + Represent the font Name. + + + + + True if the bold is present font otherwise, False. + + + + + True if the italic is present font otherwise, False. + + + + + Gets or sets the underline type for the conditional format. + + + + + True if the strike through is present font otherwise, False. + + + + + Gets or sets the top border color from predefined colors (). + + + + + Gets or sets the top border color (). + + + + + Gets and sets the top border line style. + + + + + Gets and sets the vertical border color. + + + + + Gets or sets the vertical border color (). + + + + + Gets and sets the vertical border line style. + + + + + Gets and sets the horizontal border color. + + + + + Gets or sets the Horizontal border color (). + + + + + Gets and sets the Horizontal border line style. + + + + + Gets or sets the bottom border color from predefined colors (). + + + + + Gets or sets the bottom color (). + + + + + Gets or sets the bottom border line style. + + + + + Gets or sets the top right color from predefined colors (). + + + + + Gets or sets the right border color (). + + + + + Gets or sets the right border line style. + + + + + Gets or sets the left border color from predefined colors (). + + + + + Gets or sets the left border color (). + + + + + Gets or sets the left border line style. + + + + + True if top border line style and color is modified. otherwise, False. + + + + + True if bottom border line style and color is modified. otherwise, False. + + + + + True if right border line style and color is modified. otherwise, False. + + + + + True if left border line style and color is modified. otherwise, False. + + + + + True if diagonal border line style and color is modified. otherwise, False. + + + + + True if the pivot cell format contains font formatting. otherwise, False. + + + + + True if the pivot cell format contains pattern formatting. otherwise, False. + + + + + True if the pivot cell format contains pattern format present. otherwise, Flase. + + + + + True if background color is present. otherwise, False. + + + + + True if the pivot cell format contains border formatting. otherwise, False. + + + + + True if the pivot cell format contains font color present. otherwise, Flase. + + + + + Gets pivot cell format font color object. Read-only. + + + + + Gets pivot cell format color object. Read-only. + + + + + Gets pivot cell format back color object. Read-only. + + + + + Gets pivot cell format top border color object. Read-only. + + + + + Gets pivot cell format bottom border color object. Read-only. + + + + + Gets pivot cell format horizontal border color object. Read-only. + + + + + Gets pivot cell format vertical border color object. Read-only. + + + + + Gets pivot cell format right border color object. Read-only. + + + + + Gets table style eleement left border color object. Read-only. + + + + + True if bottom border line style and color is modified. otherwise, False. + + + + + True if Horizontal border line style and color is modified. otherwise, False. + + + + + Horizontal alignment. + + + + + Indent level. + + + + + Vertical alignment. + + + + + Get/set DiagonalUpBorder color. + + + + + Gets or sets the diagonal border color from predefined colors (). + + + + + Gets or sets the diagonal border color (). + + + + + Gets / sets line style of the diagonal border. + + + + + Text direction, the reading order for far east versions. + + + + + True - Indicates that text is wrapped at right border. + + + + + True- Indicates that the contents are shrunk to fit into cell. + + + + + Indicates whether cell with this XF is locked. + + + + + Indicates whether formula is hidden. + + + + + Text rotation angle: + 0 Not rotated + 1-90 1 to 90 degrees counterclockwise + 91-180 1 to 90 degrees clockwise + 255 Letters are stacked top-to-bottom, but not rotated. + + + Thrown when value is more than 0xFF. + + + + + Gets or sets number format index of the conditional format rule. + + + + + Gets or sets number format of the conditional format rule. + + + + + True if Number format is present. False otherwise. + + + + + + Flag for cell protection (cell locked and formula hidden). + + + + + Filter operator of the custom filter + + + + + String value of the customer filters + + + + + Property for filter operator of the custom filter. + + + + + Property for string value of the custom filter. + + + + + Relative date filter type used. + + + + + Relative date filter type used. + + + + + adding the pivot filter + + + + + + get the pivot Filter based on Index + + + + + + + Get the count of the custom filters. + + + + + Represents an item in PivotTable field. The items are the individual data entries in a field category. + + + + + Gets or sets a Boolean value indicating the visibility of pivot field item. + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use a Visible property in pivot field item. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + IPivotField pivotField = pivotTable.Fields[1]; + + //Sets a Boolean value indicating the visibility of pivot field item. + pivotField.Items[0].Visible = false; + + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets position of the field (first, second, third and so on). + + To know more about Pivot Tables refer this link. + + + The following code illustrates setting the position of Pivot field item. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + IPivotField pivotField = pivotTable.Fields[1]; + + //Sets position of the field + pivotField.Items[0].Position = 2; + + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the text of the field item. + + + The following code illustrates setting the text of Pivot field item. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + IPivotField pivotField = pivotTable.Fields[1]; + + //Sets the text of the field item. + pivotField.Items[0].Text = "SampleText"; + + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Member for setting the visibility of each field item. + + + + + Parent(field) of item . + + + + + Represents the item name. + + + + + Represents the item attributes. + + + + + + Gets or sets the name of the field item. + + + + + Get/set the parent of the items (ie. Field) + + + + + Get /set the visibity of each item of field + + + + + + Gets or sets the item attributes. + + + + + Parent(field) of item . + + + + + Represents the item name. + + + + + Represents the current field index. + + + + + Represents the current index of item collection. + + + + + Represents the inner items. + + + + + Indicates whether this is subtotal or not. + + + + + Initializes new instance of the pivot inner item. + + Name of the instance. + Parent of the instance. + + + + Initializes new instance of the pivot inner item. + + List of PivotInnerItem that the index find from. + Name of the PivotInnerItem. + Returns the PivotInnerItem index + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Parent(field) of item . + + + + + Represents the item name. + + + + + Represents the current field index. + + + + + Represents the current field index. + + + + + Represents the inner items. + + + + + Indicates whether this is subtotal or not. + + + + + Represents the pivot area reference. + + + + + Represents the inner items. + + + + + Represents the current index of item collection. + + + + + Represents the current child index . + + + + + Initializes new instance of the Reference. + + + + + Initializes new instance of the Reference. + + Current index of the reference. + Pivot area reference. + + + + Represents the pivot area reference. + + + + + Represents the inner items. + + + + + Represents the current index . + + + + + Represents the current child index . + + + + + Represents a collection of in a PivotTable field. + + + + + Gets the from the collection with the specified index. Read-only. + + Index of the required item. + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use a index property in pivot field item. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + IPivotField pivotField = pivotTable.Fields[1]; + + //Gets the field item from the collection with the specified index + pivotField.Items[0].Visible = false; + + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the from the collection based on the specified text. Read-only. + + The text value in the required item. + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use a FilterText property in pivot field item. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + IPivotField pivotField = pivotTable.Fields[1]; + + //Gets the field item from the collection based on the specified text + pivotField.Items["Andrew"].Position = 4; + + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the count of field items in the collection. Read-only. + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use a Count property in pivot field item collections. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + IPivotField pivotField = pivotTable.Fields[1]; + + //Gets the count of field items in the collection + int pivotItemCount = pivotField.Items.Count; + if(pivotItemCount > 0) + { + //Your Code Here + } + + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Adding the pivot filter item. + + Field of the item. + Cache field value of the item. + Text value of the item. + + + + Adds the pivot filter item to the collection. + + PivotField to whih the item belongs to. + Pivot field item value. + Item attributes for the pivot field item. + + + + Gets position of the given pivot field item among the pivot field items collection. + + Pivot field item in the field. + Position of the item among the pivot field items collection. + + + + Sets position of the given pivot field item among the pivot field items collection. + + Pivot field item in the field. + + + + Clears the pivot field item collection. + + + + + get the pivot items based on index + + + + + + + Get the field items based on filter text + + + + + + + Represents a collection of in the pivot table. + + + + + Adds a to the collection. + + Returns an object. + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to add filter using add method in the pivot field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotField field = pivotTable.Fields[1]; + field.PivotFilters.Add(PivotFilterType.ValueBetween, field, "50", "80"); + + //Adds filter to the pivot field + field.PivotFilters.Add(); + field.PivotFilters[0].Value1 = "1"; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Adds filter with Value/Label based on the specified filter values. + + Type of the filter. + Data field to which filter is applied (Data Field must not be null for Value filter). + Filter value 1. + Filter value 2. + Returns an object. + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to add filter using add method in the pivot field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotField field = pivotTable.Fields[1]; + + //Adds filter with Value/Label based on the specified filter values + field.PivotFilters.Add(PivotFilterType.ValueBetween, field, "50", "80"); + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Remove the filters from a pivot field. + + + The following code illustrates how to remove pivot filters from a pivot field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + IPivotTable pivotTable = worksheet.PivotTables[0]; + //Apply page field filter + IPivotField pageField = pivotTable.Fields[0]; + + //Remove Pivot filters + pageField.PivotFilters.Remove(); + + //Save and dispose + workbook.SaveAs("Output.xlsx"); + workbook.Close(); + } + + + + + + Gets from the collection with the specified index. Read-only. + + Index of the IPivotFiter. + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to add filter using add method in the pivot field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotField field = pivotTable.Fields[1]; + field.PivotFilters.Add(PivotFilterType.ValueBetween, field, "50", "80"); + field.PivotFilters.Add(); + + //Sets the value for filter + field.PivotFilters[0].Value1 = "1"; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the Parent of the filter. Read-only. + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use Parent property in the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotField field = pivotTable.Fields[1]; + + //Gets the Parent field of the filter + IPivotField parent = field.PivotFilters.Parent; + if(parent != null) + { + //Your Code Here + } + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Pivot value (or) Label filter + + + + + + + + + + Adding the pivot value (or) label filter to pivot field. + + Type of the pivot filter. + Datafield to which pivot filter is applied. + Value 1 of the pivot filter. + value 2 of the pivot filter. + + + + + Check whether values is Integer. + + + + + + + Get operator method of pivot filter + + + + + + + Get value method of pivot filter + + + + + + + Get dynamic filter type of pivot filter + + + + + + + Remove the filters from a pivot field. + + + + + Property for ValueLabel filter + + + + + + + + + + Zero-based index indicating the AutoFilter column to which this filter information applies + + + + + Flag indicating whether the AutoFilter button for this column is hidden. + + + + + Flag indicating whether the filter button is visible. + + + + + Custom filter. + + + + + Filter column type filter. + + + + + Top 10 filter + + + + + Dynamic filter + + + + + Zero-based index indicating the AutoFilter column to which this filter information applies + + + + + Flag indicating whether the AutoFilter button for this column is hidden. + + + + + Flag indicating whether the filter button is visible. + + + + + Custom filter + + + + + Filter Column Filter + + + + + Top 10 filter + + + + + Dynamic filter + + + + + Represents a pivot filter which is applied to . + + + + + Gets or sets the formula for the calculated field. + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use Value1 property in the pivot field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotField field = pivotTable.Fields[1]; + field.PivotFilters.Add(PivotFilterType.ValueBetween, field, "50", "80"); + field.PivotFilters.Add(); + + //Sets the value for filter + field.PivotFilters[0].Value1 = "1"; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Pivot Filter collection. + + + + + Assign pivot filter items. + + + + + + Updates the pivot field items from its cache field. + + The pivotField whose fields are to be updated. + The pivot table with the pivot field. + The pivot filter value. + + + + Represents pivot format. + + + + + Represents the Format pivot area. + + + + + Represents the Pivot Cell Format. + + + + + Represents the parent pivot formats. + + + + + Represents the parent pivot table. + + + + + Clone the corresponding pivot format. + + Parent of pivot format. + Clone pivot format object + + + + Represents the Format pivot area. + + + + + Represents the Pivot Cell Format. + + + + + Represents the parent pivot table. + + + + + Represents pivot formats collection. + + + + + Add the pivot format to the collection. + + + + + + Add the pivot format to the collection. + + + + + + Check if the pivot format exists in the collection. + + + True if the pivot format exists in the collection, Otherwise False. + + + + Check if the pivot format exists in the collection and the return the index of the format. + + + Return the index of the pivot format. + + + + Clone the corresponding pivot formats. + + Parent of pivot formats. + Clone pivot formats object + + + + Returns the parent pivot table. + + + + + Returns a single pivot format from the collection. + + + + + Returns the pivot format collection. + + + + + Specifies the description of the pivot filter. + + + + + Specifies the evaluation order of the pivot filter + + + + + Specifies the index of the field to which this pivot filter belongs. + + + + + Specifies the unique identifier of the pivot filter as assigned by the PivotTable + + + + + Specifies the string value "1" used by label pivot filters. + + + + + Specifies the string value "2" used by label pivot filters. + + + + + Pivot filter type. + + + + + Specifies the index of the measure field + + + + + Specifies the index of the measure Hier field + + + + + adding the pivot filter + + + + + + Specifies the description of the pivot filter. + + + + + Specifies the evaluation order of the pivot filter + + + + + Specifies the index of the field to which this pivot filter belongs. + + + + + Specifies the index of the measure field + + + + + Specifies the index of the measure Hier field + + + + + Specifies the unique identifier of the pivot filter as assigned by the PivotTable + + + + + Specifies the string value "1" used by label pivot filters. + + + + + Specifies the string value "2" used by label pivot filters. + + + + + Pivot filter type + + + + + get the pivot Filter based on Index + + + + + + + + + + + + Remove the filter from filter collections of pivot table. + + + + + + adding the pivot filter + + + + + + get the pivot Filter based on Index + + + + + + + + + + + + Represents the layout of the pivot table. + + + + + + + + + + Maximum Row Count + + + + + Maximum Column Count + + + + + + + + + + + + + Inner list of pivot value collection + + pivot value row index + list of pivot value for particular row index + + + + Class used for rendering the Pivot Table style in the PDF page. + + + + + Represents the worksheet object + + + + + The actual cell value in the range which is used to perform the comparison for this filter. + + + + + Value of the top 10 filter. + + + + + Flag indicating whether or not to filter by percent value of the column + + + + + Flag indicating whether or not to filter by top order + + + + + The actual cell value in the range which is used to perform the comparison for this filter. + + + + + Property for specifying the value of the top 10 filter. + + + + + Flag indicating whether or not to filter by percent value of the column + + + + + Flag indicating whether or not to filter by top order + + + + + Specifies the cell type in the pivot table. + + + + + None. + + + + + Row header. + + + + + Column header. + + + + + Grand total for rows. + + + + + Sub total for rows. + + + + + Sub total for Columns. + + + + + Grand total for Columns. + + + + + Value cell. + + + + + Enumeration values representing various pivot table parts. + + + + + Represents the whole table. + + + + + Represents labels for the page fields. + + + + + Represents values for the page fields. + + + + + Represents the first column stripe. + + + + + Represents the second column stripe. + + + + + Represents the first row stripe. + + + + + Represents the second row stripe. + + + + + Represents the first column of the pivot table. + + + + + Represents the header row of the pivot table. + + + + + Represents the first cell in the header row of the pivot table. + + + + + Represents first subtotal column in the pivot table. + + + + + Represents second subtotal column in the pivot table. + + + + + Represents the third subtotal column in the pivot table. + + + + + Represents a blank row in the pivot table. + + + + + Represents first subtotal row in the pivot table. + + + + + Represents second subtotal row in the pivot table. + + + + + Represents the third subtotal row in the pivot table. + + + + + Represents the first column sub-heading in the pivot table. + + + + + Represents the second column sub-heading in the pivot table. + + + + + Represents the third column sub-heading in the pivot table. + + + + + Represents the first row sub-heading in the pivot table. + + + + + Represents the second row sub-heading in the pivot table. + + + + + Represents the third row sub-heading in the pivot table. + + + + + Represents the Grand Total column in the pivot table. + + + + + Represents the Grand Total row in the pivot table. + + + + + Represents no part of pivot table. + + + + + Represents a collection of Pivot values in the pivot table. + + + + + Specify the immediate row header for any pivot value. + + + + + Specify the immediate column header for any pivot value + + + + + Specifies the cell type. + + + + + Specifies the Value + + + + + + + + + + Pivot value collections + + + + + Gets or sets the style for the pivot table part. + + + + + Gets or sets the immediate row header for any pivot value. + + + + + gets or sets the immediate column header for any pivot value. + + + + + Gets or sets the the cell type. + + + + + Gets or sets the pivot table value. + + + + + Represents the extended format record of the pivot table cell. + + + + + Represents pivot value filter or pivot label filter object. + + + + + Gets the first filter value of the pivot table. + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use first value property in the pivot table filters. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotField field = pivotTable.Fields[1]; + IPivotValueLableFilter pivotLabelValue = field.PivotFilters.Add(PivotFilterType.ValueBetween, field, "50", "80"); + + //Gets the first filter value of the pivot table + string value1 = pivotLabelValue.Value1; + if(value1 != string.Empty) + { + //Your Code Here + } + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the second filter value of the pivot table. + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use second value property in the pivot table filters. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotField field = pivotTable.Fields[1]; + IPivotValueLableFilter pivotLabelValue = field.PivotFilters.Add(PivotFilterType.ValueBetween, field, "50", "80"); + + //Gets the second filter value of the pivot table + string value2 = pivotLabelValue.Value2; + if(value2 != string.Empty) + { + //Your Code Here + } + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets data field using to which the filter is applied. Read-only. + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use DataField property in the pivot table filters. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotField field = pivotTable.Fields[1]; + IPivotValueLableFilter pivotLabelValue = field.PivotFilters.Add(PivotFilterType.ValueBetween, field, "50", "80"); + + //Gets data field to which the filter is applied + IPivotField filterField = pivotLabelValue.DataField; + if(pivotLabelValue != null) + { + //Your Code Here + } + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the of the pivot filter applied to the data field. Read-only. + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use filter Type property in the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotField field = pivotTable.Fields[1]; + IPivotValueLableFilter pivotLabelValue = field.PivotFilters.Add(PivotFilterType.ValueBetween, field, "50", "80"); + + //Gets type of the pivot filter applied to the data field + PivotFilterType filterType = pivotLabelValue.Type; + if(filterType == PivotFilterType.ValueBetween) + { + //Your Code Here + } + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Values 1 of the pivot filter + + + + + Value 2 of the pivot filter + + + + + Types of the filter applied to pivot filter. + + + + + Field to which filter is applied + + + + + Value 1 of the pivot filter. + + + + + Value 2 of the pivot filter. + + + + + Type of the pivot filter applied to pivot table. + + + + + Fiedl to which pivot filter is applied. + + + + + Represents the Autoshape. + + + + + Class used for Shape Implementation. + + + + + Represents a shape. + + + + + Removes this from collection. + + + The following code illustrates how to remove a from the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 100); + worksheet.Shapes.AddAutoShapes(AutoShapeType.Cube, 5, 5, 20, 100); + + //Remove a shape + worksheet.Shapes[0].Remove(); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Scales the shape. + + Width scale in percents. + Height scale in percents. + + The following code illustrates how to scale a shape after adding it. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 100); + + //Set scaling + shape.Scale(50, 50); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Height of the shape. + + + The following code illustrates how to set and get shape's height using Height property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shapes + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 70); + IComboBoxShape comboBox = worksheet.Shapes.AddComboBox(); + + //Set dimensions + comboBox.Left = 140; + comboBox.Top = 150; + comboBox.Height = 20; + comboBox.Width = 100; + + //Get dimensions + Console.WriteLine(shape.Width); + Console.WriteLine(shape.Height); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //70 + //20 + + + + + + Gets or sets the height of the Shape expressed in decimal units. + + + The following code illustrates how to set and get shape's height using Height property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shapes + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 70); + IComboBoxShape comboBox = worksheet.Shapes.AddComboBox(); + + //Set dimensions + comboBox.Left = 140; + comboBox.Top = 150; + comboBox.HeightDouble = 20.77; + comboBox.Width = 100; + + //Get dimensions + Console.WriteLine(shape.Width); + Console.WriteLine(shape.Height); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //70 + //20 + + + + + + Shape id. + + + The following code illustrates how to access Id property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shapes + IShape checkBox = worksheet.Shapes.AddCheckBox(); + + //Set dimensions + checkBox.Left = 150; + checkBox.Top = 150; + checkBox.Width = 70; + checkBox.Height = 20; + + //Get ID + Console.WriteLine(checkBox.Id); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //0 + + + + + + Left position of the shape. + + + The following code illustrates how to set and get left side spacing for the shape using Left property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shapes + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 70); + IComboBoxShape comboBox = worksheet.Shapes.AddComboBox(); + + //Set dimensions + comboBox.Left = 140; + comboBox.Top = 150; + comboBox.Height = 20; + comboBox.Width = 100; + + //Get dimensions + Console.WriteLine(shape.Width); + Console.WriteLine(shape.Height); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //70 + //20 + + + + + + Gets or sets the left position of the Shape expressed in decimal units. + + + The following code illustrates how to set and get left side spacing for the shape using Left property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shapes + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 70); + IComboBoxShape comboBox = worksheet.Shapes.AddComboBox(); + + //Set dimensions + comboBox.LeftDouble = 149.87; + comboBox.Top = 150; + comboBox.Height = 20; + comboBox.Width = 100; + + //Get dimensions + Console.WriteLine(shape.Width); + Console.WriteLine(shape.Height); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //70 + //20 + + + + + + Name of the shape. + + + The following code illustrates how to access Name property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shapes + IShape checkBox = worksheet.Shapes.AddCheckBox(); + + //Set dimensions + checkBox.Left = 150; + checkBox.Top = 150; + checkBox.Width = 70; + checkBox.Height = 20; + + //Get name + Console.WriteLine(checkBox.Name); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //CheckBox1 + + + + + + Top position of the shape. + + + The following code illustrates how to set and get top spacing for the shape using Top property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shapes + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 70); + IComboBoxShape comboBox = worksheet.Shapes.AddComboBox(); + + //Set dimensions + comboBox.Left = 140; + comboBox.Top = 150; + comboBox.Height = 20; + comboBox.Width = 100; + + //Get dimensions + Console.WriteLine(shape.Width); + Console.WriteLine(shape.Height); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //70 + //20 + + + + + + Gets or sets the top position of the Shape expressed in decimal units. + + + The following code illustrates how to set and get top spacing for the shape using Top property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shapes + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 70); + IComboBoxShape comboBox = worksheet.Shapes.AddComboBox(); + + //Set dimensions + comboBox.Left = 140; + comboBox.TopDouble = 150.66; + comboBox.Height = 20; + comboBox.Width = 100; + + //Get dimensions + Console.WriteLine(shape.Width); + Console.WriteLine(shape.Height); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //70 + //20 + + + + + + Width of the shape. + + + The following code illustrates how to set and get the width of the shape using Width property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shapes + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 70); + IComboBoxShape comboBox = worksheet.Shapes.AddComboBox(); + + //Set dimensions + comboBox.Left = 140; + comboBox.Top = 150; + comboBox.Height = 20; + comboBox.Width = 100; + + //Get dimensions + Console.WriteLine(shape.Width); + Console.WriteLine(shape.Height); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //70 + //20 + + + + + + Gets or sets the width of the Shape expressed in decimal units. + + + The following code illustrates how to set and get the width of the shape using Width property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shapes + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 70); + IComboBoxShape comboBox = worksheet.Shapes.AddComboBox(); + + //Set dimensions + comboBox.Left = 140; + comboBox.Top = 150; + comboBox.Height = 20; + comboBox.WidthDouble = 99.99; + + //Get dimensions + Console.WriteLine(shape.Width); + Console.WriteLine(shape.Height); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //70 + //20 + + + + + + Shape type. + + + The following code illustrates how to access ShapeType property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Get shape type + Console.WriteLine(shape.ShapeType); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //AutoShape + + + + + + Indicates whether shape is visible. + + + The following code illustrates how to set visibility of the shape. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Set shape visibility + shape.IsShapeVisible = false; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Alternative text. + + + The following code illustrates how to set AlternativeText for the shape. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Set alternate text + shape.AlternativeText = "Rectangle Shape"; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Indicates whether shape must be moved with cells. + + + By default IsMoveWithCell property is set to "true" so the shape will be moving along the cell if the cell's width is increased or decreased. + Here for example, we set IsMoveWithCell to "false". + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 70); + + //Set move with cells + shape.IsMoveWithCell = false; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Indicates whether shape must be sized with cells. + + + By default IsSizeWithCell property is set to "false" so the shape's size will is not changed if the cell's height and width are changed. + Here for example, we set IsSizeWithCell to "true". + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 70); + + //Set size with cells + shape.IsSizeWithCell = true; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Represents fill properties. Read-only. + + + The following code illustrates how to access Fill property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Set fill + IFill fill = shape.Fill; + + //Set fill color + fill.ForeColorIndex = ExcelKnownColors.Red; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Represents line format properties. Read-only. + + + The following code illustrates how to access Line property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Set line format + IShapeLineFormat lineFormat = shape.Line; + + //Set line color + lineFormat.ForeColorIndex = ExcelKnownColors.Red; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets macro associated with this shape + + + + + Gets the Shadow of the shape + + + The following code illustrates how to access Shadow property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Set shadow + IShadow shadow = shape.Shadow; + + //Set shadow properties + shadow.Distance = 40; + shadow.Size = 150; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets the Three dimensional format of the shape. + + + The following code illustrates how to access ThreeD property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Set 3D format + IThreeDFormat format = shape.ThreeD; + + //Set material + format.Material = Excel2007ChartMaterialProperties.TranslucentPowder; + + //Save and dispose + workbook.SaveAs("Shapes3D.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the rotation of the shape, in degrees. + + + The following code illustrates how to set ShapeRotation property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Set shape rotation + shape.ShapeRotation = 35; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Returns a object that contains the + alignment and anchoring properties for the specified shape. Read-only. + + + The following code illustrates how to access TextFrame property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Set text frame + ITextFrame textFrame = shape.TextFrame; + + //Set text range + ITextRange textRange = textFrame.TextRange; + + //Set text + textRange.Text = "Sample"; + + //Set alignment + textFrame.HorizontalAlignment = ExcelHorizontalAlignment.Right; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Get object that represents the for the shape. + + + To know more about HyperLinks refer Hyperlinks on Shapes. + + + The following code illustrates how to set and access HyperLink in Shapes. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Add hyperlink + IHyperLink hyperLink = worksheet.HyperLinks.Add(shape, ExcelHyperLinkType.Url, "http://www.syncfusion.com", "Syncfusion"); + + //Set hyperlink + IHyperLink link = shape.Hyperlink; + + //Get address + Console.Write(link.Address); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //http://www.syncfusion.com + + + + + + Implement objects that contains Name. + + + + + Gets or sets the name of the object. + + + + + Represents alpha constant, that represents index in ExcelKnownColors structures. + + + + + Value of SizeTextToFitShape option when it is set to false. + + + + + Value of SizeTextToFitShape option when it is set to true. + + + + + Value of NoFillHitTest option. + + + + + Offset for full column. + + + + + Offset for full row. + + + + + Represents default line weight. + + + + + Represents default transparency mull. + + + + + Represents default transparency mull multiplied by 100. + + + + + Represents default line weight mull. + + + + + Represents maximum shape width and height in pixel. + + + + + Represents minimum shape width and height in pixel. + + + + + Default foreground color. + + + + + Default background color. + + + + + Represents default parent types. + + + + + Fill options. + + + + + Represent the shape start x position inside the chart. + + + + + Represent the shape start y position inside the chart. + + + + + Represent the shape to x position inside the chart. + + + + + Represent the shape to y position inside the chart. + + + + + Represent the shape X position inside the chart. + + + + + Represent the shape Y position inside the chart. + + + + + Represent the shape width inside the chart. + + + + + Represent the shape height inside the chart. + + + + + Indicates if this shape support shape color-line options. + + + + + Indicate if comments is valid or not + + + + + Indicate if left value is set. + + + + + Name of the shape. + + + + + Name of assigned Macro Name + + + + + Alternative text. + + + + + Shape's record. + + + + + Parent workbook for the shape. + + + + + Type of the shape. + + + + + Shape record. + + + + + Client anchor record. + + + + + Preset Geometry element specifies when a preset geometric shape should be used instead of a custom geometric shape. + + + + + Parent shapes collection. + + + + + OBJ record. + + + + + Shape's options. + + + + + Absolute coordinates of the shape in pixels. + + + + + Represents fill properties. + + + + + Represents shape line format. + + + + + Indicates is parse or serialize Line fill properties. + + + + + This object contains not parsed xml data. + + + + + This object contains not parsed type stream data. + + + + + Preserved relation to the image. + + + + + Preserved relation id. + + + + + Indicates whether we have to update absolute positions after setting TopRow, + BottomRow, LeftColumn, RightColumn. + + + + + Indicates whether shape is vml shape or not. + + + + + Id of this shape. + + + + + Macrolink of this shape + + + + + Tokens containing reference to the associated macro. + + + + + Visibility of the shape. + + + + + Represents Shadow + + + + + Represents the 3D features + + + + + Represens the Child Shapes in the Group. + + + + + Child Client anchor record. + + + + + Unknown record. + + + + + Preserves the Style properties. + + + + + Preserves the Style properties as string value. + + + + + FormulaMacro maintain as stream + + + + + Indicates the whether the shape has the borders. + + + + + Stream to preserve the Slicers graphic frame + + + + + Anchor type + + + + + Stream to preserve the ExtLst of picture. + + + + + Get object that represents the hyperlink for the shape. + + + + + Dictionary to have preserved streams of shape properties + + + + + Indicates whether custom geometry will be used for this shape. + + + + + + + Represents the group frame of the shape. + + + + + Indicates whether the group shape contains fill. + + + + + Indicates whether the group shape contains line. + + + + + Indicates whether the shape is slicer shape or not. + + + + + Indicates whether extent tag is present or not. + + + + + Serialize FOPTE structure. + + Parent collection. + Structure id to serialize. + Array of byte - main byte of structure. + + + + Serialize FOPTE structure. + + Parent collection. + Structure id to serialize. + Array of byte - main byte of structure. + Represents additional data. + Represents if valid + + + + Serialize FOPTE structure. + + Parent collection. + Structure id to serialize. + Represents UInt value of structure. + + + + Serialize FOPTE structure. + + Parent collection. + Structure id to serialize. + Represents int value of structure. + Represents additional data. + Represents if valid + + + + Indicates whether text frame should be autosized. + + + + + Initializes new instance of the shape. + + Application object for the new shape. + Parent object for the new shape. + + + + Initializes new instance of the shape. + + Application object for the new shape. + Parent object for the new shape. + Current object to clone. + + + + Initializes new instance of the shape. + + Application object for the new shape. + Parent object for the new shape. + Array of records that contains the record for new shape. + Index of the records for new shape. + + + + Initializes new instance of the shape. + + Application object for the new shape. + Parent object for the new shape. + Shape container record that describes the new shape. + + + + Initializes new instance of the shape. + + Application object for the new shape. + Parent object for the new shape. + Shape container record that describes the new shape. + Parse options. + + + + Initializes new instance of the shape. + + Application object for the new shape. + Parent object for the new shape. + Record that describes the new shape. + + + + Initializes new instance of the shape. + + Application object for the new shape. + Parent object for the new shape. + Record that describes the new shape. + Parse options. + + + + Creates default fill and line formatting options. + + + + + Parses shape container record. + + + + + Parses shape container record. + + Parse options. + + + + Parses client data record. + + Record to parse. + Parse options. + + + + Parses all unknown records (should be overridden in child classes). + + Record to parse. + Parse options. + + + + Parses options. + + Options to parse. + + + + Parses fill options. + + Represents single fill option + Returns true if parsed correctly. + + + + Parses option record. + + Record to parse. + Value indicating fill option. + + + + Parses shape record. + + Record to parse. + + + + Parses client anchor record. + + Record to parse. + + + + Searches for all necessary parent objects. + + + + + Change the parent for the shape. + + + + + Raises events. + + + + + Suppress events. + + + + + Parses shape group record. + + Record to parse. + + + + Parses shape group container. + + Container to parse. + + + + Parses child anchor record. + + Record to parse. + + + + Parses Unknown record. + + Record to parse. + + + + Converts option value to color. + + Option to convert. + Corresponding color value. + + + + Gets single byte by index for forte structure. + + Represents current FORTE structure. + Byte index. + Returns single byte by index. + + + + Extracts shape name from option. + + Option that contains shape name. + Name extracted. + + + + Extracts all necessary option. + + Represents option holder. + + + + Extract necessary option. + + Option to extract. + Value indicating extracted option. + + + + Removes this shape from the collection. + + + + + Scales the shape. + + Width scale in percent. + Height scale in percent. + + + + Detaches events and disposes current object. + + + + + Serializes shape into shape group container. + + Shape group container that will receive shape data. + + + + Serializes shape into shape group container. + + Shape group container that will receive shape data. + + + + Serializes shape record (MsofbtSp) into shape group container. + + Shape group container that will receive shape data. + + + + Serializes shape record (MsofbtSp) into shape group container. + + Shape group container that will receive shape data. + + + + Serializes mso options. + + Represents mso container. + + + + Serialize mso options. + + Represents option record. + Returns option record, initialized by option values. + + + + Serialize transparency option. + + Represents option storage. + Transparency value. + + + + Serializes shape's options. + + Parent record for options record. + Options record. + + + + Serializes SizeTextToFitShape option. + + MsofbtOPT record to which text ID will be added. + + If options argument is NULL. + + + + + Serializes HitTest option. + + MsofbtOPT record to which text ID will be added. + + If options argument is NULL. + + + + + Serialize shape's options. + + Options record. + Option ID. + Option value. + + + + Serialize shape's options. + + Options record. + Option ID. + Option value. + Record with option. + + + + Serialize shape's options sorted by option id. + + Options record. + Option ID. + Option value. + + + + Serializes shape visibility. + + Option holder. + + + + Serializes shape name. + + Option holder. + + + + Serializes shape name. + + Options object to store name in. + Option id to store name in. + Name to serialize. + + + + Create default shape options. + + Record with option. + + + + Sets all fill fopte structure to default value. + + Represents option holder. + + + + Serialize comment shadow. + + Represents option holder. + + + + Gets border thickness + + + + + + Get border color + + Color + + + + Get fill color. + + Color + + + + Gets the default fill color for the shape from style. + + Preserved flag to be checked. + Xml tag to create reader. + Shape for which fill color should be obtained. + color + + + + Get color from style element. + + AutoshapeImpl + Preserved flag to be checked. + Stream tage name + xml tag to the create reader + Fill or border color. + + + + Check whether color is empty or not. + + RGB Color object to check. + Returns true if color is empty. + + + + Generates default shape name and sets it. + + + + + This method is called when removing shapes from the collection. + + + + + Sets object with value. + + Value to be set. + + + + Creates a clone of the current shape and adds it to the parent shapes collection. + + New parent for the shape object. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Indicates whether we should add created + shape into all necessary parent collections. + A copy of the current shape. + + + + Creates a clone of the current shape. + + New parent for the shape object. + A copy of the current shape. + + + + Copies settings from another shape object. + + Shape to copy settings from. + Dictionary with new worksheet names. + Dictionary with new font indexes. + + + + Checks whether it is possible insert row or column into iIndex. + + Index of row or column to insert. + Number of rows or columns to insert. + Indicates whether rows or columns are inserted. + Maximum possible index. + True if it is possible to insert row or column. + + + + Returns lower bound of the shape. + + Indicates whether lower row or lower column must be returned. + Lower bound of the shape. + + + + Returns upper bound of the shape. + + Indicates whether upper row or upper column must be returned. + Upper bound of the shape. + + + + Removes row or column. + + Index of row or column to remove. + Number of rows or columns to remove. + Indicates whether rows or columns are removed. + + + + This method should be called after rows or columns were inserted. + + Index of row or column to insert. + Number of rows or columns to insert. + Indicates whether rows or columns are inserted. + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + Sets shape name without updating parent shapes collection. + + Name to set. + + + + Registers shape in all required sub collections. + + + + + Indicates is can copy current shape. + + Represents source range dimension. + Represents destination range dimension. + Gets new position of shape. + Returns true if can copy; otherwise - false. + + + + Copies / moves shape in range copy / move. + + Represents destination sheet. + Represents position of . + Indicates is copy. + Returns copied moved shape. + + + + Copy comments options. + + Represents source shape. + Represents dictionary with font indexes. + + + + Prepares shape for serialization. We should fill all not prepared fields + like m_shape in this method. + + + + + This method is called inside of PrepareForSerialization to make shape-dependent preparations. + + + + + Updates macro information. + + + + + Sets instance value for the shape. + + Instance to set. + + + + Sets option with value. + + Represents shape option. + Represents value to be set. + + + + Updates indexes to named ranges. + + New indexes. + + + + Updates indexes to named ranges. + + New indexes. + + + + Updates left column and offset values correspondingly + to X-coordinate changes. + + + + + Clears the Shape Offsets. + + Clears the offset if True. + + + + Update right column + + + + + + Updates right column and offset values correspondingly + to left column or offset or width changes. + + + + + Updates top row and offset values correspondingly + to Y-coordinate changes. + + + + + Updates bottom row of the shape. + + + + + Updates width of the shape. + + + + + Updates Height of the shape. + + + + + Converts offset value into pixels. + + Width of row or column. + Offset in row or column. + Indicates whether it is column offset. + Offset value in pixels. + + + + Converts offset value into pixels. + + Width or Height. + Offset in row or column. + Indicates whether it is column offset. + Offset value in pixels. + + + + Converts pixels into offset value. + + Index to the current row or column. + Size in pixels. + Indicates whether iCurRowColumn is column index should. + Size of the row / column in pixels. + + + + Converts pixels into offset value. + + Index to the current row or column. + Size in pixels. + Indicates whether iCurRowColumn is column index should. + Size of the row / column in pixels. + + + + Converts pixels into offset value. + + Index to the current row or column. + Size in pixels. + Indicates whether iCurRowColumn is column index should. + Size of the row / column in pixels. + + + + Returns width of the area. + + Column index. + Column offset. + Second column index. + Offset in the second column. + Indicates whether offsets are in pixels. + Width in pixels of the specified area. + + + + Returns height of the specified area. + + The first row. + Offset in the first row. + The second row. + Offset in the second row. + Indicates whether offsets are in pixels. + Height in pixels of the specified area. + + + + Converts width offset into pixels and checks if it is out of range. + + Width of the target column. + Offset in the target column. + + Indicates whether offset is in pixels (True) or in the units + relative to width of the column (False). + + Offset in pixels. + + If resulting offset is more that column width. + + + + + Converts width offset into pixels and checks if it is out of range. + + Height of the target row. + Offset in the target row. + + Indicates whether offset is in pixels (True) or in the units + relative to height of the row (False). + + Offset in pixels. + + If resulting offset is more than row height. + + + + + Converts pixels into column width offset. + + Represents pixel. + Width of the target column. + Value in column width. + + + + Converts pixels into height offset. + + Pixels to convert. + Represents target row height. + Offset in terms of Row height. + + + + Converts pixels into height offset. + + Pixels to convert. + Represents target row height. + Offset in terms of Row height. + + + + Evaluates top left position of the shape. + + + + + Evaluates left position. + + + + + Evaluates Right Position. + + + + + Evaluates top position. + + + + + Sets client anchor record. + + Represents anchor. + + + + This method is called when left column was changed. + + + + + This method is called when top row was changed. + + + + + Indicates whether specified row / column index is before shape. + + Row / column index. + Indicates whether it is row or column index. + True if specified row / column index is before shape. + + + + Indicates whether specified row / column index is in the middle of the shape. + + Row / column index. + Indicates whether it is row or column index. + True if specified row / column index is before shape. + + + + Indicates whether it is last row or column index + + Row / column index. + Indicates whether it is row or column index. + Value indicating whether it is last row or column index. + + + + Increases and updates both begin and end of the shape. + + Number of inserted rows / columns. + Indicates whether rows where inserted. + + + + Increases and updates end of the shape. + + Number of inserted rows / columns. + Indicates whether rows where inserted. + + + + Gets count of rows \ columns that is above shape. + + Represents start index. + Represents count of rows \ columns. + Indicates is in row. + Returns count of rows \ columns above shape. + + + + Gets count of rows inside. + + Represents first index. + Represents count. + Indicates is row or column. + Returns count of inside. + + + + Indicates is when remove or insert use top\left row\column. + + Represents start index of remove \ insert. + Represents count. + Indicates is in row. + If true - use first row\column; otherwise - false. + + + + Updates row \ column indexes. + + Count to update. + Indicates is update row indexes or column. + + + + Updates first row/column indexes. + + Indicates is in row. + Represents count. + + + + Updates shape that include not size and not move flags. + + Indicates is row or column to update. + Row or column index. + Number of inserted/removed rows/column. + + + + Updates inside row/column indexes. + + Represents count. + Indicates is in row. + + + + Updates last row\column indexes. + + Indicates is row or column. + + + + Updates record. + + Represents client anchor. + + + + Parses line and fill objects. + + Options holder. + + + + Updates mso object. + + Represents mso object to update. + Returns true if updated otherwise - false. + + + + Clones line and fill objects. + + Shape to be cloned. + + + + Column width change event. + + Represents sender object + Represents value changed event. + + + + Leaves bottom right corner of the shape. + + + + + This method should be called after any change in font of "Normal" style. + + Event sender. + Event arguments. + + + + This method should be called after row height changes. + + Event sender. + Event arguments. + + + + Checks the Left Offset. + + + + + Update GroupFrame for the shape.. + + Event sender. + Event arguments. + + + + Update GroupFrame for the shape.. + + Event sender. + Event arguments. + + + + Update the GroupFrame position. + + left position of the group frame + top position of the group frame + width position of the group frame + height position of the group frame + + + + Get the updated child shape positions. + + Group shape rectangle. + The group shape rotation. + The child shape rectangle to be updated. + The updated child shape rectangle. + + + + Get Shape Rotations. + + Group Shape. + Flip count. + + + + Get the updated the rectangle from the Matrix. + + Group Shape. + The shape rectangle. + The updated rectangle. + + + + Creates the from points array. + + The points. + The rectangle. + + + + Gets the transformation matrix for the AutoShape. + + Rectangle bounds of the AutoShape. + Rotation angle to be applied. + Horizontal flip. + Vertical flip. + Transformed matrix value in which shape will be rendered. + + + + Gets the transformation matrix for the AutoShape. + + Rectangle bounds of the AutoShape. + Rotation angle to be applied. + Horizontal flip. + Vertical flip. + Transformed matrix value in which shape will be rendered. + + + + Update the shape bounds based on ShapeRotation. + + Current Rectangle bound values of the AutoShape. + Rotation angle of the shape. + Updated Rectangle bounds of the AutoShape. + + + + Set postions for the shape. + + X-coordinate. + Y-coordinate. + Extenstion Width. + Extenstion Height. + + + + Set Left postion for the shape. + + double value to set. + + + + Set Top postion for the shape. + + double value to set. + + + + Set Height for the shape. + + double value to set. + + + + Set Height for the shape. + + double value to set. + + + + Set the group shape property value to all the inner shapes. + + Property value to set. + Property name. + + + + Gets or sets the height of the shape. + + + + + Gets or sets the height of the Shape expressed in decimal units. + + + + + Gets Shape ID. + + + + + Gets the chart3 D properties. + + The chart3 D properties. + + + + Gets or sets the value indicating if comment has proper row column values + + + + + Gets the shadow properties. + + The shadow properties. + + + + Gets or sets the value indicating if Left value is set. + + + + + Gets or sets the value of the shape has extent tag or not + + + + + Gets or set x coordinate of upper left corner of shape. + + + + + Gets or sets the left position of the Shape expressed in decimal units. + + + + + Gets or sets name of the shape. + + + + + Gets or sets the Y coordinate of the shape + + + + + Gets or sets the top position of the Shape expressed in decimal units. + + + + + Gets or sets width of the shape. + + + + + Gets or sets the width of the Shape expressed in decimal units. + + + + + Gets or sets shape type + + + + + Gets or set a value indicating whether shape is visible + + + + + Gets or sets alternative text of the shape + + + + + Gets or set a value indicating whether shape can move with cell + + + + + Gets or sets a value indicating whether shape can size with cell. + + + + + Represents fill properties. Read-only. + + + + + Represents line format properties. Read-only. + + + + + Preset Geometry element specifies when a preset geometric shape should be used instead of a custom geometric shape. + + + + + Gets or sets the macro name. + + + + + True if the size of the specified object is changed automatically + to fit text within its boundaries. Read/write Boolean. + + + + + Gets / sets xml data stream. + + + + + Gets or sets xml type stream. + + + + + Indicates whether this is vml shape or not. + + + + + Gets or sets macro-command that is called when action happens. + + + + + Gets or sets the Image relation id + + + + + Gets or sets the image relation + + + + + Returns or sets the rotation of the shape, in degrees. + + + + + + Returns a TextFrame object that contains the + alignment and anchoring properties for the specified shape. Read-only. + + + + + FormulaMacro Stream + + + + + Get object that represents the hyperlink for the shape. + + + + + Preserve the style as stream for further processing. + + + + + Gets and sets the shape x position inside the chart. + + + + + Gets and sets the shape y position inside the chart. + + + + + Gets and sets the shape width inside the chart. + + + + + Gets and sets the shape height inside the chart. + + + + + Gets and sets shape start x position inside the chart. + + + + + Gets and sets shape start y position inside the chart. + + + + + Gets and sets shape to x position inside the chart. + + + + + Get and sets shape to y position inside the chart. + + + + + Stream to preserve the Slicers graphic frame + + + + + Indicates the whether the shape has the borders. + + + + + Parent workbook. Read-only. + + + + + Parent workbook. Read-only. + + + + + Parent shapes collection. Read-only. + + + + + Parent worksheet. Read-only. + + + + + OBJ record. Read-only. + + + + + Client anchor. Read-only. + + + + + Top row for the shape. + + + + + Left column for the shape. + + + + + Bottom row for the shape. + + + + + Right column for the shape. + + + + + Top row offset for the shape. + + + + + Left column offset for the shape. + + + + + Bottom row offset for the shape. + + + + + Right column offset for the shape. + + + + + Gets or sets object id. + + + + + Returns internal shapes record. Read-only. + + + + + Returns inner sp record. Read-only. + + + + + Indicates whether it is short version of the shape + (without obj and maybe some other properties). + + + + + Returns number of shapes contained by this shape (1 means no sub shapes). Read-only. + + + + + Indicates whether we have to update absolute positions after setting TopRow, + BottomRow, LeftColumn, RightColumn. + + + + + Returns instance value. Read-only. + + + + + Indicates whether fill item was created. Read-only. + + + + + Indicates whether the group shape contains fill. + + + + + Indicates whether the group shape contains line. + + + + + Indicates whether line item was created. Read-only. + + + + + Gets / sets shape id. + + + + + Returns internal shape record, creates new one if necessary. Read-only. + + + + + Indicates whether this control is an ActiveX Control. + + + + + Preserves the Shape style properties. + + + + + Preserves the Shape style properties as string value. + + + + + We find the anchor type. + + + + + gets and sets the extlst of the picture,which intends to get preserved. + + + + + Represents whether the shape is slicer or not. + + + + + Represents the parent group shape. + + + + + Indicates whether the shape is group shape. + + + + + Gets stream of preserved elements in shape properties + + + + + Indicates whether custom geometry will be used for this shape. + + + + + Represents the shape frame of the shape. + + + + + Represents the group frame of the shape. + + + + + Gets shape options. + + + + + Represens the Child Shapes in the Group. + + + + + Child Client Anchor Record. + + + + + Extended the ShapeImpl class to support AutoShape. + + + + + Gets or set a value indicating whether shape can move with cell + + + + + Gets or sets a value indicating whether shape can size with cell. + + + + + Indicates whether shape fill color is preserved or not. + + + + + Indicates whether autoshape has noFill or not. + + + + + Indicates whether autoshape has group fill or not. + + + + + Instantiates the ShapeExt with the Shape Type. + + Type of the AutoShape. + Represents the Worksheet object. + + + + Updates the shape id. + + + + + + Updates the Placement Value for the shape. + + + + + Indicates whether autoshape has group fill or not. + + + + + Indicates whether shape fill color is preserved or not. + + + + + Indicates whether autoshape has noFill or not. + + + + + Gets the Extended ShapeImpl class to support AutoShape. + + + + + Specifies a vertical flip. When true, this attribute defines that the group is flipped + vertically about the center of its bounding box + + + + + Specifies a horizontal flip. When true, this attribute defines that the shape is flipped + horizontally about the center of its bounding box + + + + + Represents the Text Frame. + + + + + + Represents the Shape's Description. + + + + + Represents the Shape's unique id. + + + + + Represents the name of the Shape. + + + + + Represents the Shape Rotation. + + + + + Represents the fill. + + + + + Represents the Line Format. + + + + + Indicates whether the shape is hidden. + + + + + Represents the shape title. + + + + + Gets or set a value indicating whether shape can move with cell + + + + + Gets or sets a value indicating whether shape can size with cell. + + + + + Initializes new instance of the shape. + + Parent shape. + + + + Serializes row-column anchor point. + + XmlWriter to serialize into. + Tag name to use. + Column index. + Offset inside column. + Row index. + Offset inside row. + Parent worksheet. + Xml namespace to use. + + + + Serializes XY anchor point + + XmlWriter to serialize into. + Tag name to use. + X coordinate (will be divided by 1000 in the current implementation). + Y coordinate (will be divided by 1000 in the current implementation). + Xml namespace to use. + + + + Represents the size information of the shape. + + + + + Represents the Current worksheet instance. + + + + + Intializes the members. + + Current Worksheet object. + + + + Clones current object. + + Parent object. + Returns cloned object. + + + + Represents different text direction. + + + + + Represents the horizontal text direction + + + + + Rotates the text by 90 degrees + + + + + Rotates the text by 270 degrees + + + + + Rotates the text from left to right + + + + + Rotates the text from right to left + + + + + Represents different horizontal alignments + + + + + Represents Left horizontal alignment setting for the shapes. + + + + + Represents Center horizontal alignment setting for the shapes. + + + + + Represents Right horizontal alignment setting for the shapes. + + + + + Represents LeftMiddle horizontal alignment setting for the shapes. + + + + + Represents CenterMiddle horizontal alignment setting for the shapes. + + + + + Represents RightMiddle horizontal alignment setting for the shapes. + + + + + Represents different vertical alignments + + + + + Represents Top vertical alignment setting for the shapes. + + + + + Represents Middle vertical alignment setting for the shapes. + + + + + Represents Bottom vertical alignment setting for the shapes. + + + + + Represents TopCentered vertical alignment setting for the shapes. + + + + + Represents MiddleCentered vertical alignment setting for the shapes. + + + + + Represents BottomCentered vertical alignment setting for the shapes. + + + + + Represents different vertical overflow types. + + + + + Represents a overflow type of vertical overflow. + + + + + Represents a ellipsis type of vertical overflow. + + + + + Represents a clip type of vertical overflow. + + + + + Represents different horizontal overflow types. + + + + + Represents a Overflow type of horizontal types. + + + + + Represents a Clip type of horizontal types. + + + + + Represents Cross Filter type of the slicer + + + + + Hide the unfiltered items from the slicer. + + + + + Differentiate the filtered items and unfiltered items. + + + + + Display the unfiltered items at the last. + + + + + There is no difference between the filtered and unfiltered data. + + + + + Represents Slicer style + + + + + Represents the SlicerStyleLight1 style + + + + + Represents the SlicerStyleLight2 style + + + + + Represents the SlicerStyleLight3 style + + + + + Represents the SlicerStyleLight4 style + + + + + Represents the SlicerStyleLight5 style + + + + + Represents the SlicerStyleLight6 style + + + + + Represents the SlicerStyleOther1 style + + + + + Represents the SlicerStyleOther2 style + + + + + Represents the SlicerStyleDark1 style + + + + + Represents the SlicerStyleDark2 style + + + + + Represents the SlicerStyleDark3 style + + + + + Represents the SlicerStyleDark4 style + + + + + Represents the SlicerStyleDark5 style + + + + + Represents the SlicerStyleDark6 style + + + + + Represent columns in the Text frame. + + + + + + Gets or sets the number of the text frame columns. + + + + + Gets or sets the spacing point of the text frame columns. + + + + + Gets the value for the given . + + value to convert to . + parsed value for the input . + + + + Initializes new instance of the serializator. + + Auto shape. + Auto shape. + + + + Extended the ShapeImp to add support for the Autoshape. + + + + + Shape guide dictionary to hold the path information of the autoshapes. + + + + + List to hold the path information of the free form shape. + + + + + Represents custom geometry or not.(If shape is free form shape this is true). + + + + + Initializes new instance of the shape extension. + + Auto shape type. + WorksheetBaseImpl. + + + + Clones current object. + + Parent object. + Returns cloned object. + + + + Shape guide dictionary to hold the path information of the autoshapes. + + + + + List to hold the path information of the free form shape. + + + + + Represents custom geometry or not.(If shape is free form shape this is true). + + + + + Initializes new instance of the shape property serializator. + + Auto shape. + string attribute. + + + + Stores and serialize the chart / shape style entries + + + + + attribute used as prefix + + + + + autoshape parent + + + + + Name space used on serialization + + + + + mods enum value for the style element + style entry is not provided + + + + + It specifies a reference to a line style within the style matrix. + must be initialized for chartStyle + + + + + It specifies a multiplier to apply to the line width. + + + + + It reference to an effect style within the style matrix. + must be initialized for chartStyle + + + + + It specifies a reference to a fill style within the style matrix. + must be initialized for chartStyle + + + + + It specifies a reference to a themed font. + must be initialized for chartStyle + + + + + It specifies visual shape properties associated with this StyleEntry + + + + + It specifies the default text character properties for a text body associated with this StyleEntry. + + + + + It specifies the body properties for a text body associated with this StyleEntry + + + + + Default constructor + + + + + Constructor used for auto shape + + input shape + input attribute + + + + Constructor used for chart style + + input attribute value + input namespace value + input style modifier enum value + + + + Serialize the Style or font reference for entry + + input XML writer + input style entry reference + style entry reference name + boolean value indicates whether thr reference is font or not + + + + Serialize the input color and its values + + input XML writer + color model type + color value string + luminance modulation value + luminance offset 1 value + luminance offset 2 value + shade value on color + + + + Serialize the shape properties current object + + input XML writer + + + + Serialize the Default run paragraph properties + + input XML writer + + + + Serialize the current shape style and its member + + input XML writer + input parent element of chart style + + + + Gets / Sets the value of member StyleElementMod + + + + + Gets / Sets the line reference style entry + + + + + Gets / Sets the line width of style entry + + + + + Gets / Sets the effect reference of style entry + + + + + Gets / Sets the Fill reference of style entry + + + + + Gets / Sets the Font reference of style entry + + + + + Gets / Sets the shape properties of style entry + + + + + Gets / Sets the Default paragraph run properties of style entry + + + + + Gets / Sets the text body properties of style entry + + + + + Stores the information required for each style entries + lineRef, fillRef, effectRef, fontRef, + + + + + Style entry Index + integer for lineRef, fillRef, effectRef style elements + enum integer value for fontRef style elements + + + + + Color model value + + + + + Its stores the value of color respect to color model + hexa color or schema color information + + + + + luminace modulation value for scheme color + + + + + luminance offset value 1 for scheme color + + + + + luminance offset value 2 for scheme color + + + + + stores the shade value + + + + + Initialize the member with its values + + Index value + colorModel value + color value + luminance modulation value + luminance offset 1 value + luminance offset value 2 + shade value of color + + + + Gets / Sets the value of member index + + + + + Gets / Sets the value of member ColorModelType + + + + + Gets / Sets the value of member ColorValue + + + + + Gets / Sets the value of member LumModValue + + + + + Gets / Sets the value of member LumOffValue1 + + + + + Gets / Sets the value of member LumOffValue2 + + + + + Gets / Sets the value of member Shade value + + + + + Stores the information of shape properties of style entry + + + + + Indicates whether the options are enabled. Bit position + 0-Shape fill + 1-Line fill + 2-line width (if set to 0, no fill) + 3-line cap + 4-line cmpd + 5-line align + + + + + enum indicates the fill type of shape s + + + + + indicates the line width + + + + + shape fill color model value + + + + + Its stores the value of shape fill color respect to color model + hexa color or schema color information + + + + + luminace modulation value for scheme color of shape fill + + + + + luminance offset value 1 for scheme color of shape fill + + + + + luminance offset value 2 for scheme color of shape fill + + + + + Color model value + + + + + Its stores the value of border color respect to color model + hexa color or schema color information + + + + + luminace modulation value for scheme color of border + + + + + luminance offset value 1 for scheme color of border + + + + + luminance offset value 2 for scheme color of border + + + + + Specifies the compound line type to be used for the underline stroke. + + + + + Indicates that lines joined together have a round join. + + + + + Specifies the ending caps that should be used for this line. + + + + + Specifies the alignment to be used for the underline stroke. + + + + + Default constructor + + + + + Gets / Sets the shapefillType member + + + + + Gets / Sets the Border Weight member + + + + + Gets / Sets the ShapeFillColorModel member + + + + + Gets / Sets the ShapeFillColorValue member + + + + + Gets / Sets the ShapeFill Luminance Modulation member + + + + + Gets / Sets the shapefill luminace offset 1 member + + + + + Gets / Sets the shapefill luminace offset 2 member + + + + + Gets / Sets the Border Fill ColorModelType member + + + + + Gets / Sets the BorderFill Color member + + + + + Gets / Sets the BorderFill Luminance Modulation member + + + + + Gets / Sets the borderFill Luminace Offset Value1 member + + + + + Gets / Sets the borderFill Luminace Offset Value2 member + + + + + Gets / Sets the shapeLineStyle member + + + + + Gets / Sets the BorderIsRound member + + + + + Gets / Sets the LineCap member + + + + + Gets / Sets the IsInsetPen member + + + + + Get the options enabled flags + + + + + Clones current object. + + Parent object. + Returns cloned object. + + + + Represents the text frame + + + + + Returns a TextFrame object that contains the + alignment and anchoring properties for the specified shape. Read-only. + + + + + Gets or sets overflow of the text frame[Used internally]. + + + + + Gets or sets wrap text in the text frame + + + The following code illustrates how to set WrapTextInShape property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 70); + + //Set text frame + ITextFrame textFrame = shape.TextFrame; + + //Set text + textFrame.TextRange.Text = "Sample Text in shape"; + + //Set clip + textFrame.TextHorzOverflowType = TextHorzOverflowType.Clip; + + //Set wrap + textFrame.WrapTextInShape = false; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets autosize in the text frame + + + The following code illustrates how to set IsAutoSize property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Set text frame + ITextFrame textFrame = shape.TextFrame; + + //Set text + textFrame.TextRange.Text = "Sample"; + + //Set auto size + textFrame.IsAutoSize = true; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets left margin of the text frame + + + The following code illustrates how to set the left margin for the text inside the shape using MarginLeftPt property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 70); + + //Set text frame + ITextFrame textFrame = shape.TextFrame; + + //Set margin + textFrame.MarginLeftPt = 14; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets top margin of the text frame + + + The following code illustrates how to set the top margin for the text inside the shape using TopMarginPt property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 70); + + //Set text frame + ITextFrame textFrame = shape.TextFrame; + + //Set margin + textFrame.TopMarginPt = 14; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets right margin of the text frame + + + The following code illustrates how to set the right margin for the text inside the shape using RightMarginPt property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 70); + + //Set text frame + ITextFrame textFrame = shape.TextFrame; + + //Set margin + textFrame.RightMarginPt = 14; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets bottom margin of the text frame + + + The following code illustrates how to set the bottom margin for the text inside the shape using BottomMarginPt property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 70); + + //Set text frame + ITextFrame textFrame = shape.TextFrame; + + //Set margin + textFrame.BottomMarginPt = 14; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets auto margin of the text frame + + + The following code illustrates how to access IsAutoMargin property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 70); + + //Set text frame + ITextFrame textFrame = shape.TextFrame; + + //Set margin + textFrame.MarginLeftPt = 14; + + //Check IsAutoMargins + Console.Write(textFrame.IsAutoMargins); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //False + + + + + + Gets or sets vertical text overflow in the text frame. + + + By default is set to TextVertOverflowType property. Here for example, we set + to TextVertOverflowType. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Set text frame + ITextFrame textFrame = shape.TextFrame; + + //Set text range + ITextRange textRange = textFrame.TextRange; + + //Set text + textRange.Text = "Sample Sample Sample Sample Sample Sample Sample"; + + //Set overflow type + textFrame.TextVertOverflowType = TextVertOverflowType.Ellipsis; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets horizontal text overflow in the text frame. + + + By default is set to TextHorzOverflowType property. Here for example, we set + to TextHorzOverflowType. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 70); + + //Set text frame + ITextFrame textFrame = shape.TextFrame; + + //Set text + textFrame.TextRange.Text = "Sample Text in shape"; + + //Set clip + textFrame.TextHorzOverflowType = TextHorzOverflowType.Clip; + + //Set wrap + textFrame.WrapTextInShape = false; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets horizontal alignment in the text frame. + + + By default is set to HorizontalAlignment. Here for example, we set + to HorizontalAlignment property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Set text frame + ITextFrame textFrame = shape.TextFrame; + + //Set text range + ITextRange textRange = textFrame.TextRange; + + //Set text + textRange.Text = "Sample"; + + //Set alignment + textFrame.HorizontalAlignment = ExcelHorizontalAlignment.Left; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets vertical alignment in the text frame. + + + By default is set to VerticalAlignment. Here for example, we set + to VerticalAlignment property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Set text frame + ITextFrame textFrame = shape.TextFrame; + + //Set text range + ITextRange textRange = textFrame.TextRange; + + //Set text + textRange.Text = "Sample"; + + //Set alignment + textFrame.VerticalAlignment = ExcelVerticalAlignment.Bottom; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets text direction of the text frame. + + + By default is set to TextDirection. Here for example, we set + to TextDirection property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 100, 30); + + //Set text frame + ITextFrame textFrame = shape.TextFrame; + + //Set text range + ITextRange textRange = textFrame.TextRange; + + //Set text + textRange.Text = "Sample"; + + //Set text direction + textFrame.TextDirection = TextDirection.RotateAllText90; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets text range of the text frame. + + + The following code illustrates how to set by accessing TextRange property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Set text frame + ITextFrame textFrame = shape.TextFrame; + + //Set text range + ITextRange textRange = textFrame.TextRange; + + //Set text + textRange.Text = "Sample text"; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Clones current object. + + Parent object. + Returns cloned object. + + + + Gets or sets if the text overflows + + + + + Gets the test range + + + + + Gets or sets the warp text in shape + + + + + Gets or sets the left margin pt + + + + + Gets or sets the top margin pt + + + + + Gets or sets the right margin pt + + + + + Gets or sets the bottom margin pt + + + + + Gets or sets if the text frame has auto margins + + + + + Gets or sets if the text frame has auto size + + + + + Gets or sets the vertical overflow type of the text + + + + + Gets or sets the horizontal overflow type of the text + + + + + Gets or sets the horizontal alignment + + + + + Gets or sets the vertical alignment + + + + + Gets the text direction + + + + + Gets / Sets the text body properties + + + + + Represents the text range + + + + + Returns the TextRange object that represents the text in the object. Read-only. + + + + + Gets or sets the text property of the text range. + + + The following code illustrates how to set Text inside the . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Set text frame + ITextFrame textFrame = shape.TextFrame; + + //Set text range + ITextRange textRange = textFrame.TextRange; + + //Set text + textRange.Text = "Sample text"; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Text of the comment. Read-only. + + + The following code illustrates how to set RichText inside the . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Set text frame + ITextFrame textFrame = shape.TextFrame; + + //Set text range + ITextRange textRange = textFrame.TextRange; + + //Set rich text + IRichTextString richText = textRange.RichText; + richText.Text = "Sample"; + + //Create font + IFont font = workbook.CreateFont(); + font.Color = ExcelKnownColors.Red; + + //Apply rich text format + richText.SetFont(0, 5, font); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Initializes variables. + + + + + Clones current object. + + Parent object. + Returns cloned object. + + + + Gets or sets the Text of the RichText string + + + + + Comment text. + + + + + Class that stores that text body properties + + + + + text vertical overflow type + + + + + text horizontal overflow type + + + + + text direction enum + + + + + left margin point of text + + + + + top margin point of text + + + + + right margin point of text + + + + + bottom margin of text + + + + + boolean value indicates whether the text to be wrapped in text + + + + + struct type of columns + + + + + vertical alignment of text + + + + + horizontal alignment of text + + + + + Boolean value indicates whether the text is to be auto sized + + + + + Boolean value indicates whether margin is automatically generated + + + + + boolean value indicates whether the text to be preset wrapped in text + + + + + Get the anchor position from text direction and alignment + + input text Direction of the text body + input text body vertical alignment + input text body horizontal alignment + output anchor + + + + Update the anchor value. + + Text direction + vertical alignment + horizontal alignment + alignment string + true + + + + Get the string formatted text direction from enum + + input text direction enum + output string formatted text direction + + + + Get Left margin value of text body + + converted left margin value + + + + Set Left margin value of text body + + converted left margin value + + + + Get Top margin value of text body + + converted Top margin value + + + + Set Top margin value of text body + + converted Top margin value + + + + Get Right margin value of text body + + converted right margin value + + + + Set Right margin value of text body + + converted right margin value + + + + Get Bottom margin value of text body + + converted Bottom margin value + + + + Set Bottom margin value of text body + + converted Bottom margin value + + + + Get anchor position value of text body from current object properties + + anchor position value + + + + Serializes the text body properties attributes + + input XML writer + prefix of the element + namespace of the element + + + + Gets / Sets the TextVertOverflowType member + + + + + Gets / Sets the TextHorzOverflowType member + + + + + Gets / Sets the TextDirection member + + + + + Gets / Sets the LeftMarginPt member + + + + + Gets / Sets the TopMarginPt member + + + + + Gets / Sets the RightMarginPt member + + + + + Gets / Sets the BottomMarginPt member + + + + + Gets / Sets the WrapTextInShape member + + + + + Gets / Sets the VerticalAlignment member + + + + + Gets / Sets the HorizontalAlignment member + + + + + Gets / Sets the IsAutoSize member + + + + + Gets / Sets the IsAutoMargins member + + + + + Gets / Sets the number of column + + + + + Gets / Sets the spacingPt of column + + + + + Gets / Sets the PresetWrapTextInShape member + + + + + Represents the group shape in a worksheet. + + + + + Represents the group shape in a worksheet. + + + + + Returns the array of individual shapes in the specified . + + + The following code illustrates how to get items from group shape. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("GroupShapes.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IShapes shapes = worksheet.Shapes; + IShape[] groupItems = (shapes[0] as IGroupShape).Items; + + //Save and dispose + workbook.SaveAs("GroupShapes.xlsx"); + workbook.Close(); + } + + + + + + Inner shapes collection. + + + + + Represents vetical flip of the shape. + + + + + Represents horizontal flip of the shape + + + + + Represents preserved elements of the group shape. + + + + + Initializes new instance of the group shape. + + Application object for the new group shape. + Parent object for the new group shape. + + + + Creates a clone of the current group shape. + + A copy of the current current shape. + + + + Layout the group shape and inner shapes. + + + + + Layout the group shape and inner shapes. + + Group shape to layout. + + + + Set updated child offset for group shape. + + + + + Remove the shape from group shape. + + shape to remove + + + + Returns the array of individual shapes in the specified . + + + + + Gets or Sets vetical flip + + + + + Gets or Sets vetical flip + + + + + Represents preserved elements of the group shape. + + + + + This class represent the scenarios. + + + + + Represents the collection of What-If analysis scenarios in the worksheet. + + + + + Creates a What-If analysis scenario and adds it to the What-If analysis scenarios collection for the current worksheet. + + Represent the name of the scenario + Represent the changingCell address of the scenario + Represent the value of the scenario + Returns the created instance of + + The following code illustrates how to add the scenario in the scenarios collection of the worksheet. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("ScenarioManager.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add a new scenario to the worksheet. + IScenarios scenarios = sheet1.Scenarios; + IScenario scenario1 = scenarios.Add("Scenario1", sheet.Range["C4"], 100); + + workbook.SaveAs("ScenarioManager.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + + Creates a new worksheet that contains a summary report for the What-If analysis scenarios on the specified worksheet. + + Represent the resultantCell range for the scenarios + + The following code illustrates how to create a new worksheet that contains a summary report for the scenarios on the specified worksheet. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("ScenarioManager.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add the scenarios in worksheet + IScenarios scenarios = sheet1.Scenarios; + IScenario scenario1 = scenarios.Add("scenario1", sheet.Range["C4"], 100); + IScenario scenario2 = scenarios.Add("scenario2", sheet.Range["C4"], 200); + IScenario scenario3 = scenarios.Add("scenario3", sheet.Range["C4"], 300); + + //Create a summary for the worksheet + worksheet.Scenarios.CreateSummary(sheet.Range["C9"]); + + workbook.SaveAs("ScenarioManager.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + + Gets the scenario from the What-If analysis scenarios collection based on Index. + + Represent the index of the scenatrio + Returns the created instance of + + Following code illustrates how to get scenario from scenarios collection based on Index. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("ScenarioManager.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IScenarios scenarios = worksheet.Scenarios; + IScenario scenario = worksheet.Scenarios[0]; + + workbook.SaveAs("ScenarioManager.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets the scenario from from the What-If analysis collection based on scenario name. + + Represent the name of the scenatrio + Returns the created instance of + + Following code illustrates how to get scenario from scenarios collection based on scenario name. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("ScenarioManager.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IScenarios scenarios = worksheet.Scenarios; + IScenario scenario = worksheet.Scenarios["ScenarioName"]; + + workbook.SaveAs("ScenarioManager.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets the Resultant cell range for the What-If analysis scenario. + + Returns the created instance of + + Following code illustrates how to get resultant cells range for the worksheet. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("ScenarioManager.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IScenarios scenarios = worksheet.Scenarios; + + //Get the changnig cells range for the scenario + IRange resultantcellRange = scenarios.ResultantCells; + + workbook.SaveAs("ScenarioManager.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets the number of the What-If analysis scenarios in scenarios collection. + + + Following code illustrates how to get number of scenario in the scenarios collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("ScenarioManager.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IScenarios scenarios = worksheet.Scenarios; + int count = worksheet.Scenarios.Count; + + workbook.SaveAs("ScenarioManager.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Represent the parent worksheet + + + + + Represent the Last changing scenario + + + + + true if it shows a scenario + + + + + Represent the Last changing scenario index + + + + + Represent the resultant cells for scenarios. + + + + + Constructor for scenarios object + + Represents the parent worksheet + Represents the parent application + + + + Create a scenario and add it to the scenarios collection for the current worksheet. + + Represent the name of the scenario + Represent the changingCell address of the scenario + Represent the value of the scenario + Returns the created instance of + + + + Create a scenario and add it to the scenarios collection for the current worksheet. + + Represent the name of the scenario + Represent the changingCell address of the scenario + Represent the value of the scenario + Returns the created instance of + The comment for the scenario, including the author's name and date, can be generated from the built-in document properties.The default value for the "Locked" function of the scenario is true.The default value for the "Hidden" function of the scenario is false. + when scenario name must be same + + + + Creates a new worksheet that contains a summary report for the scenarios on the specified worksheet. + + Represent the resultantCells range for the scenarios + + + + Represent the range of the changing cells + + Represent the current worksheet + Represent the start row from where the changing cell are to be updated + Represent the starting row from where the changing cell values are to be updated + Represent the start column from where the changing cell values are to be updated + Represent the starting column from where the current changing cell values are to be updated + + + + Stores the changing cell values to be listed in the scenario summary worksheet + + Represent the current worksheet + Represent the scenario + Represent the starting row from where the values are to be updated + Represent the starting column from where the values are to be updated + Represent the range of the values + + + + Represent the range of the result cells + + Represent the current worksheet + Represent the starting row from where the result cell values are to be updated + Represent the starting column from where the result cell values are to be updated + Represent the starting column from where the current result cell values are to be updated + Represent the result cell range + + + + Stores the Resultant cell values + + Represent the worksheet + Represent the scenario + Represent the starting row from where the result cell values are to be updated + Represent the starting column from where the result cell are to be updated + >Represent the result cell range + + + + Stores the changing cells name manager + + Represent the current worksheet + Represent the starting row from where the changing cell names are to be updated + Represent the starting column from where the changing cell names are to be updated + + + + Stores the resultant cells name manager + + Represent the worksheet + Represent the starting row from where the reusltant cell names are to be updated + Represent the starting column from where the reusltant cell names are to be updated + Represent the resultant cell range + + + + + Clone the scenarios + + Represent the parent worksheet + Represent the application + + + + + Dispose the scenarios. + + + + + Gets the number of scenario in scenarios collection. + + + + + Gets the scenario from scenarios collection based on Index. + + Represent the index of the scenatrio + Returns the created instance of + + + + Gets the scenario from scenarios collection based on scenario name. + + Represent the name of the scenatrio + Returns the created instance of + + + + Gets the Resultant cell range for the scenario + + Returns the created instance of + + + + Represent the worksheet in which the scenarios are present + + + + + True if the scenario is shown. + + + + + Gets or sets the last changing cell values + + + + + Gets or sets the last chaning cell value index + + + + + This class represent the scenario + + + + + Represents What-If analysis scenario in the worksheet. + + + + + + Deletes the current scenario from What-If analysis scenarios collection. + + + Following code illustrates how to delete the current scenario from scenarios collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("ScenarioManager.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add new scenarios to the worksheet. + IScenarios scenarios = sheet1.Scenarios; + IScenario scenario1 = scenarios.Add("Scenario1", sheet.Range["B3:B9"], 100); + IScenario scenario2 = scenarios.Add("Scenario2", sheet.Range["B3:B9"], 200); + + //Delete the scenarios + scenario2.Delete(); + + workbook.SaveAs("ScenarioManager.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Applies the scenario values to the worksheet and shows the updated cell values. + + + Following code illustrates how to show the scenario by inserting its values on the worksheet. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("ScenarioManager.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Adding new scenarios to the worksheet. + IScenarios scenarios = sheet1.Scenarios; + IScenario scenario1 = scenarios.Add("Scenario1", sheet.Range["B3:B9"], 100); + IScenario scenario2 = scenarios.Add("Scenario2", sheet.Range["B3:B9"], 200); + + //Delete the scenarios + scenario2.Show(); + + workbook.SaveAs("ScenarioManager.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + + Gets or sets the comment associated with the What-If analysis scenario. + + + Following code illustrates how to get or set the comment associated with the scenario + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("ScenarioManager.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Adding a new scenario to the worksheet. + IScenarios scenarios = sheet1.Scenarios; + IScenario scenario1 = scenarios.Add("Scenario1", sheet.Range["C4"], 100); + + //Set the comment for the scenario + scenario1.Comment = "New comment"; + + workbook.SaveAs("ScenarioManager.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets a boolean value indicating whether the What-If analysis scenario is hidden or not. + + + True if the scenario is hidden. Otherwise false. + + + Following code illustrates shows true if the scenario is hidden. The default value is false + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("ScenarioManager.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Adding a new scenario to the worksheet. + IScenarios scenarios = sheet1.Scenarios; + IScenario scenario1 = scenarios.Add("Scenario1", sheet.Range["C4"], 100); + + //Set the scenario as hidden + scenario1.Hidden = true; + + workbook.SaveAs("ScenarioManager.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets the index of the What-If analysis scenario in the scenarios collection. + + + Following code illustrates how to get the scenario index for scenarios collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("ScenarioManager.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Adding a new scenario to the worksheet. + IScenarios scenarios = sheet1.Scenarios; + IScenario scenario1 = scenarios.Add("Scenario1", sheet.Range["C4"], 100); + + //Get the scenario index for scenarios collection. + int index = scenario1.Index; + + workbook.SaveAs("ScenarioManager.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets a boolean value indicating whether the What-If analysis scenario is locked or not. Default value is true. + + + True if the scenario is locked. Otherwise false. + + + Following code illustrates shows true if the object is locked. False if the object can be modified when the sheet is protected + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("ScenarioManager.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Adding a new scenario to the worksheet. + IScenarios scenarios = sheet1.Scenarios; + IScenario scenario1 = scenarios.Add("Scenario1", sheet.Range["C4"]); + + //Set the scenario as locked + scenario1.Locked = true; + + workbook.SaveAs("ScenarioManager.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the What-If analysis scenario name. + + + Following code illustrates how to get or set the scenario name. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("ScenarioManager.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Adding a new scenario to the worksheet. + IScenarios scenarios = sheet1.Scenarios; + IScenario scenario1 = scenarios.Add("Scenario1", sheet.Range["C4"]); + + //Set a name to the scenario + scenario1.Name = "Scenario2"; + + workbook.SaveAs("ScenarioManager.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + + Represent the changing cell range + + + + + Represent the parent for scenario + + + + + Represent the values of the scenario + + + + + Represent the comment for the scenario + + + + + True if the object is locked; False if the object can be modified when the sheet is protected. + + + + + Represent the index of the scenario + + + + + True if the scenario is hidden. The default value is False. + + + + + Represent the names of the scenario + + + + + Constructor for scenario object + + Represent the scenario collection + + + + Constructor for scenario object + + Represent the name of the scenario + Represent the changingCell address of the scenario + Represent the value of the scenario + Represent the comment associated with the scenario + True if the object is locked. False if the object can be modified when the sheet is protected. + True if the scenario is hidden. The default value is False. + + + + + Delete the current scenario from scenarios collection. + + + + + Shows the scenario by inserting its values on the worksheet. + + + + + Clones the scenario + + + + + + + Dispose the scenario elements. + + + + + Gets or sets the parent for the scenarios + + + + + + Gets or sets the comment associated with the scenario + + + + + Gets or sets a boolean value indicating whether the scenario is hidden or not. Default value is false. + + + True if the scenario is hidden. Otherwise false. + + + + + Gets the scenario index from the scenarios collection + + + + + Gets or sets a boolean value indicating whether the scenario is locked or not. Default value is true. + + + True if the scenario is locked. Otherwise false. + + + + + Gets or sets the name of the scenario + + + + + Gets the list of values for the changing cells of the scenario + + A scenario is limited to have maximum of 32 changing cells, each with its associated value. + + + + This class represents Slicer. + + + + + Represents the Slicer in a worksheet + + + + + Gets or sets the name of the slicer in the worksheet. + + + Following code illustrates how to get and change the slicer name. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + string name = slicer.Name; + slicer.Name = "Sample Slicer"; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the caption of the slicer in the worksheet. + + + Following code illustrates how to get and change the slicer Caption. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + string name = slicer.Caption; + slicer.Caption = "Sample"; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the vertical position of the slicer, in points. + + + Following code illustrates how to set the Top position of the slicer. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + slicer.Top = 100; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the horizontal position of the slicer, in points. + + + Following code illustrates how to set the Left position of the slicer. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + slicer.Left = 300; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the height of the slicer, in points. + + + Following code illustrates how to set the Height of the slicer. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + slicer.Height = 200; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the width of the slicer, in points. + + + Following code illustrates how to set the Width of the slicer. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + slicer.Width = 150; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the height of the slicer, in pixel. + + + Following code illustrates how to set the Height of the slicer. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + slicer.Height = 200; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the width of the slicer, in pixel. + + + Following code illustrates how to set the Width of the slicer. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + slicer.Width = 150; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the width, in points, of each column in the slicer. + + + Following code illustrates how to set the Width of the slicer button. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + slicer.SlicerItemWidth = 80; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the height, in points, of each row in the slicer. + + + Following code illustrates how to set the Height of the slicer button. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + slicer.SlicerItemHeight = 0.4; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the width, in pixel, of each column in the slicer. + + + Following code illustrates how to set the Width of the slicer button. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + slicer.SlicerItemWidth = 80; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the height, in pixel, of each row in the slicer. + + + Following code illustrates how to set the Height of the slicer button. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + slicer.SlicerItemHeight = 0.4; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the number of columns in the slicer. + + + Following code illustrates how to gets or sets the Number of columns in the slicer. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + slicer.NumberOfColumns = 2; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Indicates whether the slicer caption need to be visible or not. + + + Following code illustrates how to change the DisplayHeader option of the slicer. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + slicer.DisplayHeader = false; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the slicer style + + + Following code illustrates how to change the slicer style. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + slicer.SlicerStyle = ExcelSlicerStyle.SlicerStyleDark2; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets the parent table of the slicer. Read only. + + + Following code illustrates how to get the source table of the slicer. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + IListObject table1 = slicer.SourceTable; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets the slicer cahce of the slicer + + + Following code illustrates how to get the Slicer Cache of the slicer. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicerCache cache = worksheet.Slicers[0].SlicerCache; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Name of the slicer. + + + + + Name of the table column from which the slicer is created. + + + + + Caption of the slicer. + + + + + Top position of the slicer + + + + + Left position of the slicer + + + + + Height of the slicer + + + + + Width of the slicer + + + + + Height of the slicer in pixels + + + + + Width of the slicer in pixels + + + + + Slicer button Width + + + + + Slicer button Height + + + + + Slicer button Width in pixels + + + + + Slicer button Height in pixels + + + + + Number of slicer items present in the line. + + + + + Represents the number of levels in the slicer + + + + + Indicates whether the slicer header is present or not. + + + + + Indicates slicer style + + + + + Indicates source table of the slicer + + + + + Indicates source pivot table of the slicer + + + + + Indicates slicer cache of the slicer + + + + + Indicates slicer worksheet + + + + + Indicates slicer collection + + + + + Indicates whether the slicer is pivot slicer or not + + + + + Indicates column index of the table from that the slicer is created. + + + + + Indicates slicer cache name + + + + + Used to store the slicer as the stream + + + + + Constructor of slicer to create the slicer. + + Source table from which the slicer created + Indicates column index of the table from that the slicer is created. + Top position of the slicer + Left position of the slicer + Slicer collection of the worksheet + Source pivot table from which the slicer created + + + + Constructor of slicer to create the slicer. + + Slice name + Slicer Cache + Slicer Caption + Row height of the slicer + Worksheet in which the slicer is present + + + + Clone the corresponding slicer elements. + + Parent of slicer object. + Clone slicer elements object + + + + Dispose the slicer elements. + + + + + Name of the slicer. + + + + + Name of the table column from which the slicer is created. + + + + + Indicates slicer cache of the slicer + + + + + Caption of the slicer. + + + + + Top position of the slicer + + + + + Left position of the slicer + + + + + Height of the slicer + + + + + Width of the slicer + + + + + Height of the slicer in pixels + + + + + Width of the slicer in pixels + + + + + Slicer button Width + + + + + Slicer button Height + + + + + Slicer button Width in pixels + + + + + Slicer button Height in pixels + + + + + Number of slicer items present in the each line. + + + + + Indicates whether the slicer header is present or not. + + + + + Indicates slicer style + + + + + Indicates source table of the slicer + + + + + Indicates source pivot table of the slicer + + + + + Indicates slicer worksheet + + + + + Indicates whether the slicer is pivot slicer or not + + + + + Indicates column index of the table from that the slicer is created. + + + + + Indicates slicer collection + + + + + Indicates slicer cache name + + + + + Represents the number of levels in the slicer + + + + + Used to store the slicer as the stream + + + + + This class represents Slicer Cache. + + + + + Represents the slicer cache of the slicer. + + + + + Gets or sets the cross filter type of the slicer + + + Following code illustrates how to get and change the CrossFilterType of the Slicer. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + slicer.SlicerCache.CrossFilterType = SlicerCrossFilterType.HideItemsWithNoData; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Indicates whether the custom list is used for sorting. + + + Following code illustrates how to set the Custom list sorting. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + slicer.SlicerCache.UseCustomListSorting = true; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets the name of the cache field. + + + Following code illustrates how to get the Name of the cache field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + string Name = slicer.SlicerCache.SourceName; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Indicates whether the items in the slicer is sorted in the ascending order. + + + Following code illustrates how to get or set the sort order. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + slicer.SlicerCache.IsAscending = true; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets the items of the slicer cache + + + Following code illustrates how to get or set the sort order. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + ISlicerCacheItems cacheItems = slicer.SlicerCache.SlicerCacheItems; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Represents the slicer cross filter type + + + + + Represents the custom list sorting + + + + + Represents the column name + + + + + Represents the sort order of the slicer items + + + + + Represents the slicer cache items + + + + + Represents the slicer + + + + + Represents the table index of the slicer + + + + + Represents the pivot table index of the slicer + + + + + Represents the column index of the slicer + + + + + Represents the slicer cahce name + + + + + Represents the slicer is created from pivot table or not + + + + + Represents the source pivot table name of the slicer + + + + + Represents the pivot slicer items + + + + + Represents the pivot slicer items selected property value + + + + + Represents the pivot slicer item is fileter property value + + + + + Represents the pivot slicer cache as a stream + + + + + Represents the slicer cache as a stream + + + + + Constructor of the slicer cache + + Source table from which the slicer created + Indicates column index of the table from that the slicer is created. + + + + Constructor of the slicer cache + + Source table from which the slicer created + Indicates column index of the table from that the slicer is created. + Source pivot table from which the slicer created + + + + Constructor of the slicer cache + + Slice cache name + Source name of the slicer cache. + Table id from which the slicer created + Column index of the table from which the slicer is created + Sort order of the slicer items. + Cross filter type of the slicer + + + + Constructor of the slicer cache + + Slicer sheet id + Source pivot table name of the slicer. + Slicer cache name + Source name of the slicer cache + Sort order of the slicer items. + Cross filter type of the slicer + Xml reader of the slicer + + + + Add the slicer cahce items + + Represents the slicer cache item collection + + + + Clone the corresponding slicer cache elements. + + Parent of slicer object. + Clone slicer cache elements object + + + + Dispose the slicer cache elements. + + + + + Represents the slicer cache items + + + + + Represents the slicer cross filter type + + + + + Represents the custom list sorting + + + + + Represents the column name + + + + + Represents the slicer cahce name + + + + + Represents the source pivot table name of the slicer + + + + + Represents the sort order of the slicer items + + + + + Represents the table index of the slicer + + + + + Represents the pivot table index of the slicer + + + + + Represents the column index of the slicer + + + + + Represents the slicer is created from pivot table or not + + + + + Represents the pivot slicer items + + + + + Represents the pivot slicer items selected property value + + + + + Represents the pivot slicer item is fileter property value + + + + + This class represents Slicer Cache Item. + + + + + Respresents the slicer item of the slicer + + + + + Indicates whether the slicer item is selected or not. + + + Following code illustrates how to find whether the slicer item is selected or not. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + bool selected = slicer.SlicerCache.SlicerCacheItems[0].IsSelected; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets the item text of the slicer. + + + Following code illustrates how to gets the label text of the slicer. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + string value = slicer.SlicerCache.SlicerCacheItems[0].Value; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Represents the slicer item is selected or not. + + + + + Represents the slicer item value. + + + + + Represents the slicer item row + + + + + Represents the slicer item column + + + + + Represents the slicer item source table + + + + + Represents the slicer item source pivot table + + + + + Represents the slicer pivot item + + + + + Represents the slicer cache item collection + + + + + Represents the slicer cahce item + + Represents the slicer cache item value + Represents the pivot slicer cache item index + Represents the slicer cache item is selected or not + Represents the slicer cache item row + Represents the slicer cache item column + Represents the slicer table + Represents the slicer pivot table + + + + Clone the corresponding slicer cache item elements. + + Parent of slicer cache items object. + Clone slicer cache item object + + + + Dispose the slicer cache item elements. + + + + + Represents the slicer item is selected or not. + + + + + Represents the slicer item value. + + + + + Represents the slicer pivot item + + + + + Represents the slicer item row + + + + + This class represents Slicer Cache Item collection. + + + + + Respresents the slicer item collection of the slicer + + + + + Gets or sets the the number of items present in the slicer. + + + Following code illustrates how to get the count of the slicer items. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + int count = slicer.SlicerCache.SlicerCacheItems.Count; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets the slicer cache item object based on the given index. + + + Following code illustrates how to access the slicer cache items. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + ISlicerCacheItems cacheItems = slicer.SlicerCache.SlicerCacheItems; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Indicates slicer worksheet + + + + + Indicates slicer Cache + + + + + Indicates slicer cache items + + + + + Constructor of slicer cahce item collection + + Represents the slicer cache + Represents the parrent application + + + + Add the slicer item into the slicer item collection + + Source table of the slicer + Column index of the slicer + Source pivot table of the slicer + Column name of the slicer + + + + Sort the slicer items + + + + + Clone the corresponding slicer cache items. + + Parent of slicer cache object. + Clone slicer cache items + + + + Dispose the slicer elements. + + + + + Indicates slicer items count + + + + + Gets the slicer cache item from slice cahce collection. + + Index of the slicer cache item. + Related slicer item + + + + This class is represents the slicer collection + + + + + Respresents the slicer collection of the worksheet + + + + + Creates a slicer using the provided column index of the table + + Represents the table object. + Represents the column index of the table. + Represents the top row for the slicer. + Represents the left column for the slicer + Returns an index of the slicer + + The following code illustrates how a slicer can be created in a worksheet using the given table in the worksheet. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + IListObject table = worksheet.ListObjects[0]; + + //Add a new slicer to the worksheet. + int index= worksheet.Slicers.Add(table, 2, 3, 5); + + ISlicerCacheItems cacheItems = worksheet.Slicers[0].SlicerCache.SlicerCacheItems; + int itemscount = cacheItems.Count; + ISlicerCacheItem item = cacheItems[0]; + string value = item.Value; + Item. IsSelected = false; + + //Name of the slicer + ISlicer slicer = worksheet.Slicers[0]; + string name = slicer.Name; + slicer.Name = "Sample Slicer"; + + //Caption name of the slicer + slicer.Caption = "Product Details"; + + //Displays the header + slicer.DisplayHeader = true; + slicer.SlicerStyle= ExcelSlicerStyle.SlicerStyleDark1; + slicer.Top = 20; + slicer.Left = 200; + + //Height and width of the slicer + slicer.Width = 90; + slicer.Height = 90; + //Height and width of the buttons inside the slicer + slicer.SlicerItemHeight = 30; + slicer.SlicerItemWidth = 30; + + //Number of columns inside the slicer + slicer.NumberOfColumns = 2; + + slicer.SlicerCache.CrossFilterType = SlicerCrossFilterType.HideItemsWithNoData; + slicerCache.IsAscending = true; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Removes a specified slicer from the slicer collection. + + Slicer to be removed + + Following code illustrates how to remove a slicer from the worksheet. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + + //Remove the slicer from the worksheet + worksheet.Slicers.Remove(slicer); + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Removes a slicer at specified index from the slicer collection + + Index of the slicer to be removed + + Following code illustrates how to remove a slicer from the worksheet. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + + //Remove the slicer from the worksheet + worksheet.Slicers.RemoveAt(0); + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets the number of slicers in the worksheet. + + + Following code illustrates how to get the slicer count from the worksheet. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + int count = worksheet.Slicers.Count; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Returns the slicer object based on the given index. + + + Following code illustrates how to get slicer object based on the given index. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Slicer.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + ISlicer slicer = worksheet.Slicers[0]; + + workbook.SaveAs("Slicer.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Slicers Constant + + + + + Slicer Constant + + + + + Slicer name Constant + + + + + Slicer Cache + + + + + Slicer Caption + + + + + Row Height Constant + + + + + Column count Constant + + + + + Style Constant + + + + + Show Caption Constant + + + + + Indicates slicer worksheet + + + + + Add the slicer into the sheet + + Represents the slicer source table + Represents the column index + Represents the slicer top row position + Represents the slicer left position + Slicer id + + + + Add the slicer into the sheet + + Represents the slicer + Slicer id + + + + Remove the slicer from the sheet + + Represents the slicer + + + + Remove the slicer from the sheet + + Represents the index of the slicer + + + + Find the worksheet of the slicer + + Represents the parent worksheet + Represents the parrent application + + + + Clone the corresponding slicer collection elements. + + Represents the parent worksheet + Represents the parrent application + Clone slicer collection elements object + + + + Dispose the slicer elements. + + + + + Indicates slicers count in the worksheet + + + + + Gets the slicer from slicer collection. + + Index of the slicer. + Related slicer + + + + This class represents the mention feature of threaded comment + + + + + Represents the Id of the mentioned person + + + + + Represents the Id of the mentioned threaded comment + + + + + Represents the start index position of the mention + + + + + Represents the Length of the mention + + + + + Represents the parent threaded comment to which the mention object belongs + + + + + Constructor to create mention object + + represents the parent threaded comment to which the mention belongs + + + + Clone each mention of a threaded comment + + threaded comment clone + cloned mention + + + + Gets or sets the Id of the mentioned person + + + + + Gets or sets the Id of the mentioned threaded comment + + + + + Gets or set the start index position of the mention + + + + + Gets or sets the length of the mention + + + + + This class represents the threaded comment for range. + + + + + Represents the threaded comment for range. + + + + + Adds a reply for existing threaded comment with the specified text. + + Reply threaded comment text + Optional. The creation time of the threaded comment + Returns the created instance of . If the thread is resolved, reply threaded comment cannot be created and returns null + + The reply threaded comment is created by mapping with author name from built-in document properties + + + The following code illustrates how to add reply to a threaded comment with text. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add threaded comment + IThreadedComment threadedComment = worksheet["C2"].AddThreadedComment("Hello","User"); + + //Add reply with text + threadedComment.AddReply("reply thread"); + + //Add reply with text and creation time + DateTime date = new DateTime(2020, 11, 22, 2, 22, 23); + threadedComment.AddReply("Text", date); + + //Save and dispose + workbook.SaveAs("ThreadedComments.xlsx"); + workbook.Close(); + } + + + + + + Adds a reply for existing threaded comment with the specified text and author. + + Reply threaded comment text + The author of the reply threaded comment + Optional. The creation time of the threaded comment + Returns the created instance of . If the thread is resolved, reply threaded comment cannot be created and returns null + + The following code illustrates how to add reply to a threaded comment with text and author. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add threaded comment + IThreadedComment threadedComment = worksheet["C2"].AddThreadedComment("Hello","User"); + + //Add reply with text and author + threadedComment.AddReply("reply thread", "User"); + + //Add reply with text, author and creation time + DateTime date = new DateTime(2020, 11, 22, 2, 22, 23); + threadedComment.AddReply("Text", "User", date); + + //Save and dispose + workbook.SaveAs("ThreadedComments.xlsx"); + workbook.Close(); + } + + + + + + Deletes the threaded comment from the parent threaded comment. + + + The following code illustrates how to Delete a threaded comment. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add threaded comment + IThreadedComment threadedComment = worksheet["C2"].AddThreadedComment("Hello","User"); + + //Delete the threaded comment from the collection. + threadedComment.Delete(); + + //Save and dispose + workbook.SaveAs("ThreadedComments.xlsx"); + workbook.Close(); + } + + + + + + Gets the author of the created threaded comment. + + The author of the . + + The following code illustrates how to access Author property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add threaded comment + IThreadedComment threadedComment = worksheet["C2"].AddThreadedComment("Hello","User"); + + //Get author + string author = threadedComment.Author; + + //Save and dispose + workbook.SaveAs("ThreadedComments.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the text of the threaded comment. + + The text of the + + The following code illustrates how to access Text property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add threaded comment + IThreadedComment threadedComment = worksheet["C2"].AddThreadedComment("Hello","User"); + + //Set text + threadedComment.Text = "Modified"; + + //Get Text + string text = threadedComment.Text; + + //Save and dispose + workbook.SaveAs("ThreadedComments.xlsx"); + workbook.Close(); + } + + + + + + Gets the creation time of the threaded comment. + + The creation time of the + + The following code illustrates how to access CreatedTime property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add threaded comment + IThreadedComment threadedComment = worksheet["C2"].AddThreadedComment("Hello","User"); + + //Get Created time + DateTime dateTime = threadedComment.CreatedTime; + + //Save and dispose + workbook.SaveAs("ThreadedComments.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating whether this threaded comment is resolved or not. + + True if threaded comment is marked as resolved. By default, false. + + The following code illustrates how to access IsResolved property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add threaded comment + IThreadedComment threadedComment = worksheet["C2"].AddThreadedComment("Hello","User"); + + //Add reply threaded comment + threadedComment.AddReply("sample text", "User"); + + //Resolve the thread + threadedComment.IsResolved = true; + + //Save and dispose + workbook.SaveAs("ThreadedComments.xlsx"); + workbook.Close(); + } + + + + + + Gets the collection of replies from the current threaded comment. + + The collection of threaded comment replies, or null if the current threaded comment has no replies. + + The following code illustrates how to access Replies property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add threaded comment + IThreadedComment threadedComment = worksheet["C2"].AddThreadedComment("Hello","User"); + + //Add reply threaded comment + threadedComment.AddReply("sample text", "User"); + + //Access the reply threaded comment + threadedComment.Replies[0].Text = "Modified text"; + + //Save and dispose + workbook.SaveAs("ThreadedComments.xlsx"); + workbook.Close(); + } + + + + + + Gets the row index of threaded comment. + + The row index of the + + The following code illustrates how to access RowIndex property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add threaded comment + IThreadedComment threadedComment = worksheet["C2"].AddThreadedComment("Hello","User"); + + //Get the row index of the threaded comment. + int rowIndex = threadedComment.RowIndex; + + //Save and dispose + workbook.SaveAs("ThreadedComments.xlsx"); + workbook.Close(); + } + + + + + + Gets the column index of threaded comment. + + The column index of the + + The following code illustrates how to access ColumnIndex property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add threaded comment + IThreadedComment threadedComment = worksheet["C2"].AddThreadedComment("Hello","User"); + + //Get the column index of the threaded comment. + int columnIndex = threadedComment.ColumnIndex; + + //Save and dispose + workbook.SaveAs("ThreadedComments.xlsx"); + workbook.Close(); + } + + + + + + The author of the threaded comment + + + + + Refers to the text of the threaded comment + + + + + The created time of the threaded comment + + + + + True if the thread is resolved. If not, false. Not applicable for reply threaded comment. + + + + + The row index of the (threaded) commented cell + + + + + The column index of the (threaded) commented cell + + + + + represents the threaded comment id property + + + + + Represents the Id of the parent threaded comment + + + + + Reference on worksheet to which the threaded comment is added. + + + + + The associated comment object for a threaded comment object + + + + + Represents the collection to which this threaded comment belongs. + + + + + Represents the reply threaded comment collection to this threaded comment + + + + + Represents the list of mentions to this threaded comment + + + + + Represent store the paragraph extLst element stream. + + + + + Represents the person Id of the threaded comment + + + + + True if the threaded comment has hyperlink.If not, false. + + + + + Constructor to create threaded comment object + + The author of the threaded comment + Threaded comment text + threaded comment creation time + row index of the cell that has the threaded comment + column index of the cell that has the threaded comment + id of the threaded comment + parent id of the reply threaded comment + collection to which the threaded comment belongs + comment created to support threaded comment. Not applicable for reply threaded comment + Worksheet to which the threaded comment belongs + + + + Constructor to create threaded comment object + + parent worksheet of the threaded comment + + + + Adds a reply for existing threaded comment with the specified text. + + Reply threaded comment text + Optional. The creation time of the threaded comment + Returns the created instance of . If the thread is resolved, reply threaded comment cannot be created and returns null + + The reply threaded comment is created by mapping with author name from built-in document properties + + + + + Adds a reply for existing threaded comment with the specified text and author. + + Reply threaded comment text + The author of the reply threaded comment + Optional. The creation time of the threaded comment + Returns the created instance of . If the thread is resolved, reply threaded comment cannot be created and returns null + + + + Delete the threaded comment from existing threaded comments. + + + + + Removes mentioned persons from the person dictionary + + person dictionary + + + + Clone threaded comment + + parent cloned sheet + cloned threaded comments collection + cloned threaded comment + + + + Dispose threaded comment object. + + + + + Gets the author of the created threaded comment. + + The author of the . + + + + Gets or sets the text of threaded comment. + + The text of the + + + + Gets the creation time of the threaded comment. + + The creation time of the + + + + Gets or sets the person Id of the threaded comment + + + + + Gets or sets a boolean value indicating whether this threaded comment is resolved or not. Default value is false. + + True if threaded comment is marked as resolved. Otherwise false. + + + + Gets the collection of threaded comments that are replies to the current threaded comment. + + The collection of threaded comment replies, or null if the current threaded comment has no replies. + + + + Gets the row index of threaded comment. + + The row index of the + + + + Gets the column index of threaded comment. + + The column index of the + + + + Gets or sets the threaded comment Id + + + + + Gets or sets the parent Id if the threaded comment is a reply + + + + + Gets or set the associate comment for a threaded comment + + + + + Gets the list of mentions that this threaded comment has + + + + + Represents the collection to which this threaded comment belongs. + + + + + Gets and sets the paragraph extLst element stream. + + + + + Gets and sets a boolean value indicating whether the threaded comment has a hyperlink. + Returns true if it has a hyperlink, otherwise false. + + + + + This class represents the threaded comment collection for a worksheet. + + + + + Represents the threaded comment collection for a worksheet. + + + + + Removes all the existing threaded comments from the threaded comments collection. + + + The following code illustrates how to clear the threaded comments collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add threaded comment + IThreadedComment threadedComment = worksheet["C2"].AddThreadedComment("Hello","User"); + + //Get the threaded comments collection + IThreadedComments threadedComments = worksheet.ThreadedComments. + + //Removes all the threaded comments from the collection + threadedComments.Clear(); + + //Get the threaded comments count. + int count = threadedComments.Count; //Count is 0 + + //Save and dispose + workbook.SaveAs("ThreadedComments.xlsx"); + workbook.Close(); + } + + + + + + Gets the threaded comment from the threaded comments collection based on the specified index. + + The index of the threaded comment in the collection. + The at the specified index. + + The following code illustrates how to access a threaded comment from the collection using a specific index. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add threaded comment + IThreadedComment threadedComment = worksheet["C2"].AddThreadedComment("Hello","User"); + + //Get the threaded comments collection + IThreadedComments threadedComments = worksheet.ThreadedComments. + + //Access the threaded comment from the threaded comment collection by index + string text = threadedComments[0].Text; + + //Save and dispose + workbook.SaveAs("ThreadedComments.xlsx"); + workbook.Close(); + } + + + + + + Gets the threaded comment from the threaded comments collection based on the specified row and column index. + + The row index of the threaded comment + The column index of the threaded comment + The at the specified row and column index, or null if the threaded comment is not found. + + The following code illustrates how to access a threaded comments from the collection using row and column index.. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add threaded comment + IThreadedComment threadedComment = worksheet["C2"].AddThreadedComment("Hello","User"); + + //Get the threaded comments collection + IThreadedComments threadedComments = worksheet.ThreadedComments. + + //Access the threaded comment from the threaded comment collection by row and column index + string text = threadedComments[3, 2].Text; + + //Save and dispose + workbook.SaveAs("ThreadedComments.xlsx"); + workbook.Close(); + } + + + + + + Gets the number of threaded comments in the threaded comment collection. + + The number of threaded comments in the collection. + + The following code illustrates how to get the Count of IThreadedComments. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add threaded comment + IThreadedComment threadedComment = worksheet["C2"].AddThreadedComment("Hello","User"); + + //Get the threaded comments collection + IThreadedComments threadedComments = worksheet.ThreadedComments. + + //Get the threaded comments count + int count = threadedComments.Count; + + //Save and dispose + workbook.SaveAs("ThreadedComments.xlsx"); + workbook.Close(); + } + + + + + + Indicates the worksheet where the threaded comment collection is present + + + + + Constructor to create threaded comments collection object + + worksheet to which the threaded comment collection belongs + application to which the threaded comment collection belongs + + + + Removes all the existing threaded comments from the threaded comments collection. + + + + + Clone threaded comments + + Cloned worksheet + Application + IThreadedComments + + + + Dispose threaded comments collction + + + + + Gets the threaded comments from the threaded comments collection based on the specified index. + + The index of the threaded comment in the collection. + The at the specified index. + + + + Gets the threaded comments from the threaded comments collection based on the specified row and column index. + + The row index of the threaded comment + The column index of the threaded comment + The at the specified row and column index, or null if the threaded comment is not found. + + + + Get the threaded comment from the collection based on the threaded comment id. + + threaded comment Id + Returns the threaded comment as IThreadedComment + + + + Gets the number of threaded comments in the threaded comment collection. + + The number of threaded comments in the collection. + + + + This class represents the person who authored threaded comments. + + + + + Represents the display name of the person + + + + + Represents the Id of the person + + + + + Represents the user Id of the person + + + + + Represents the provider of the person's information + + + + + Represents the number of existing threaded comments created by the person + + + + + Represents the parent workbook of the person object + + + + + Constructor to create a person object + + Display name of the Person + id of the person + userId of the person + provider ID of the person + + + + Constructor to create a person object + + parent workbook of the person object + + + + Clone person + + parent workbook + cloned person + + + + Gets or sets the display name of the person + + + + + Gets or sets the Id of the person + + + + + Gets or sets the user Id of the person + + + + + Gets or sets provider of the person's information + + + + + Gets or set the number of existing threaded comments created by the person + + + + + Indicates whether the current row inserted is grand total row. + + + + + Incidates to replace existing subtotal + + + + + Indicates to insert pageBreaks + + + + + Indicates to insert GrandTotal to below data + + + + + Indicates to group rows + + + + + ConsolidationFunction enumeration + + + + + TotalList of columns to be added + + + + + Current row + + + + + Zero based index of column + + + + + Total colulmn Count + + + + + Record Table + + + + + Column Names + + + + + TotalString + + + + + GrandTotalString + + + + + Height of the row + + + + + ExcelVersion + + + + + Bloack size of the rows + + + + + worksheet + + + + + Horizontal PageBreaks collection + + + + + First row index + + + + + First column index + + + + + Last row index + + + + + Las column index + + + + + No of subTotals + + + + + Create a SubTotal Object + + WorkSheet + + + + Collects all the formulas in the worksheet. + + Worksheet + + + + Creates SubTotal for the Specified Ranges + + FirstRow + FirstColumn + LastRow + LastColumn + GroupBy + ConsolidationFunction + TotalList + Replace + InsertPageBreaks + SummaryBelowData + + + + Retruns corresponding column index above the subtotal formula + + + + + + + Check whether the current row contains SubTotal Formula + + RowIndex + Returns true if row contains SubTotal Formula + + + + Check whether the current row contains SubTotal Formula + + RowStorage + + + + + Updates row value where subtotal is applied. + + row index - one based + + + + Creates the Total row below the data + + A boolean variable indicating if the number format of + the subtotal row is to be updated. + + + + Creates the Total row above the data + + A boolean variable indicating if the number format of + the subtotal row is to be updated. + + + + Class used for Table style rendering in the pdf page. + + + + + Collection of List object ranges and their respective borders and bordercolors. + + + + + Collection of built in styles bordercolors. + + + + + Collection of font colors of listobjects. + + + + + Collection of Dark built in styles for the Last and first column. + + + + + Collection of double border built in styles. + + + + + Collection of list object ranges and their font colors. + + + + + Collection of Light buit in Styles for the Row and column stripes. + + + + + Sheet List objects. + + + + + Collection of Medium styles for the column stripes. + + + + + Collection of Medium built in Styles for the Last and first column that has border settings. + + + + + Collection of Medium built in Styles for the Last and first column that has no border settings. + + + + + Collection of built in styles that has top border as solid. + + + + + List object built in style. + + + + + Indicates whether the Column Stripes are shown. + + + + + Indicates whether First Column is shown. + + + + + List Object Header color + + + + + Indicates whether Header Row is shown. + + + + + Indicates whether Last Column is shown. + + + + + Indicates whether the Row stripes are shown. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The sheet list objects. + + + + Applies the styles. + + The sheet. + The font color collection. + Range collection with the borders and their respective colors + + + + Initializes the light style. + + + + + Initializes the borders. + + + + + Initializes the color fonts. + + + + + Initializes the double borders. + + + + + Initializes the top solid. + + + + + Initializes the column settings. + + + + + Initializes the medium style. + + + + + Apply related table tyle element and range to set the border, font and back ground color and format. + + Current work sheet from work book + Table style element object + Related table range + True, If table style element total row is applied, Other wise false. + FirstColumnStripeStyle stripe size + SecondColumnStripeStyle stripe size + FirstRowStripeStyle stripe size + SecondRowStripeStyle stripe size + + + + custom table style element in whole table element range to get and set the border, back ground and font color, format. + + current sheet in work book + whole table element range + custom table style element + + + + Custom table style elements range get and set the border, back ground and font color, format. + + current sheet in work book + whole table element range + custom table style element + + + + Custom table style in first column stripe element range to set the border, back ground and font color and format. + + + + + + SecondColumnStripeStyle stripe size + + + + Custom table style in second column stripe element range to set the border, back ground and font color and format. + + + + + + FirstColumnStripeStyle stripe size + + + + Custom table style in first row stripe element range to set the border, back ground and font color and format. + + + + + + SecondRowStripeStyle strip size + + + + Custom table style in second row stripe element range to set the border, back ground and font color and format. + + + + + + firstRowStripeStyle strip size + + + + Draws the table style. + + The worksheet. + The built in style. + The list object location. + if set to true [show totals]. + + + + Renders the style to the total part of the table. + + The worksheet. + The listobject location. + The border style. + Color of the border. + if set to true [entire row]. + Color of the background. + The solid style. + if set to true [show totals]. + Color of the font. + if set to true [bold font]. + + + + Apply text color. + + Text color. + The Range. + + + + + Apply borders and line style in table. + + Apply border color and line style range + custom table style element + + + + Apply Whole table style element borders. + + Current sheet in work book + Apply Border color and line style range + sustom table style element + + + + Apply Font Color and format in table. + + Font Range + Custom table style element + + + + Apply back ground color and format. + + Apply back ground color and format range + custom table style element + + + + Renders the style to the header part of the table. + + The Worksheet. + The header range. + The header border style. + Color of the border. + if set to true [entire row]. + Color of the background. + The solid line style. + Color of the font. + + + + Renders the style to the content part of the table. + + The Worksheet. + The header range. + The content border style. + Color of the border. + if set to true [entire row]. + First color of the Background. + Second color of the Background. + The solid line style. + Color of the font. + if set to true [show totals]. + + + + Applies the background color. + + Color of the background. + Cells. + + + + Applies the border. + + The Worksheet. + The border range. + The solid style. + The border style. + Color of the border. + if set to true [entire row]. + + + + Apply border to cell. + + The cell. + Excel border index. + Solid style. + Solid style first. + Solid style second. + Border color. + + + + Applies the border to the first and last column of the table. + + The Worksheet. + The border range. + The solid style. + The border style. + Color of the border. + if set to true [entire row]. + + + + Applies the cell top border. + + The Worksheet. + The border range. + The solid style. + Color of the border. + + + + Applies the first and last column style. + + The Worksheet. + The content range. + Color of the font. + First color of the bg. + if set to true [show totals]. + IRange Object + + + + Checks the style. + + + Returns true if the built in style is within the this.lastColumn and first column list else false will be returned. + + + + + Enumeration of the Border Styles. + + + + + Represents that no ExcelBorderIndex is set. + + + + + Represents that Top ExcelBorderIndex is set. + + + + + Represents that Bottom ExcelBorderIndex is set. + + + + + Represents that Left ExcelBorderIndex is set. + + + + + Represents that Right ExcelBorderIndex is set. + + + + + Represents that both Top and Bottom ExcelBorderIndex is set. + + + + + Represents that both Left and Right ExcelBorderIndex is set. + + + + + Represents that all ExcelBorderIndex is set. + + + + + Enumeration of the Solid style in Borders + + + + + Represents the No Solidstyle. + + + + + Represents the solid style for the Top ExcelBorderIndex. + + + + + Represents the solid style for the Bottom ExcelBorderIndex. + + + + + Represents the solid style for the Right ExcelBorderIndex. + + + + + Represents the solid style for the Left ExcelBorderIndex. + + + + + Represents the solid style for both Top and Bottom ExcelBorderIndex. + + + + + Represents the solid style for both Right and Left ExcelBorderIndex. + + + + + Represents the warning details with type and description. + + + + + Warning description. + + + + + Warning type + + + + + Initializes a new instance of the class. + + + + + Specifies the description for the warning. + + + + + Specifies the type of the warning. + + + + + This class represents slicer parsing. + + + + + Extracts specified list object from XmlReader. + + XmlReader to get table from. + Worksheet to put extracted table into. + + + + This class is used for Slicer serialization. + + + + + This method serializes specified slicer + + XmlWriter to serialize shape settings into. + Represents the slicer collection. + + + + Represents the Warning details for the unsupported and substituted elements. + + + + + Shows the warning in the workbook. + + WarningInfo instance with the warning description and type. + + + + Indicates whether to cancel the current process. + + + + + Class that holds XmlMap information. + + + + + Schema element name. + + + + + Id attribute name. + + + + + Map element name. + + + + + Name attribute name. + + + + + Root element attribute name. + + + + + Schema id attribute name. + + + + + Show import export validation errors attribute name. + + + + + Autofit attribute name. + + + + + Append attribute name. + + + + + Preserve sort AFLayout attribute name. + + + + + Preserve format attribute name. + + + + + Preserve DataBinding Element name. + + + + + Preserve FileBinding attribute name. + + + + + Preserve DataBindingLoadMode attrbute name. + + + + + Sheet where XmlMap imports the data. + + + + + Name of the XmlMap object. + + + + + Id of the XML schema. + + + + + Root element of XML document. + + + + + XML schema stream. + + + + + XmlMap Id. + + + + + Xml connection ID. + + + + + Denotes whether a DataBinding element is read from XML. + + + + + Extracts XML data from the stream and import to the sheet. + + XML stream. + Workbook object. + Sheet object to import data. + Starting row. + Starting column. + Count of XmlMaps in the workbook. + True if data imports to the sheet, else False. + + + + Column attributes of a table fetched from XML schema. + + Column of a table. + XML schema where the data type of column is preserved. + Represents the column in the Data table + Returns True if data have sub-element path, False otherwise. + + + + Recursion method used to find the sub element path from the root element. + + Element path from the root element. + Table column. + Values collection. + Represents the column in the Data table + + + + Convert the XML stream to schema element. + + XML stream. + Returns XML schema if the data is valid. Default null. + + + + Parse XML schema from the file. + + XML reader. + + + + Serializes schema in the file. + + xml writer. + + + + Serializes XmlMapping information. + + Xml writer. + + + + Dispose the object. + + + + + Name of the XmlMap object. + + + + + Sheet where XmlMap imports the data. + + + + + Id of the XML schema. + + + + + Root element of XML document. + + + + + XML schema stream. + + + + + XmlMap Id. + + + + + Represents Excel2013 Serializator + + + + + Class used for Excel 2007 Serialization. + + + + + Class used for Excel 2007 Serialization. + + + + + Maximum allowed formula length. + + + + + File heading. + + + + + Namespace with ContentTypes items. + + + + + Namespace for hyperlink. + + + + + Namespace for relation tags/attributes. + + + + + Namespace for relation tags/attributes for Strict Open Xml spreadsheet format document. + + + + + Main xml namespace. + + + + + Dynamic array namespace + + + + + Namespace for threaded comments. + + + + + Name of the relation type that indicates that part contains worksheet data. + + + + + Name of the relation type that indicates that part contains macrosheet data. + + + + + Name of the relation type that indicates that part contains intlmacrosheet data. + + + + + Name of the relation type that indicates that part contains chartsheet data. + + + + + Name of the relation type that indicates that part contains dialogsheet data. + + + + + Name of the relation type that indicates that part contains extended document properties. + + + + + Name of the relation type that indicates that part contains core properties. + + + + + Name of the relation type that indicates that part contains the Sparkline properties. + + + + + Represents the X15 Namespace + + + + + Name of the relation type that indicates that part contains the list properties. + + + + + Pivot Field URi + + + + + The URi is constant and used for pivor table definition extension list. + + + + + Extern List URi + + + + + Slicer Cache extersion URi + + + + + Worksheet slicer extersion URi + + + + + Slicer cache extersion URi + + + + + Slicer cache filter URi + + + + + Slicer drawing URi + + + + + Meta data Extension Uri + + + + + Slicer URi + + + + + Slicer extersion URi + + + + + X14 Namespace Attibute + + + + + Hide values row attribute + + + + + Main Microsoft Namespace + + + + + Main Microsoft Namespace Attribute + + + + + Main XM Namespace + + + + + Main XM Namespace Attribute + + + + + x14 PivotTable Definition Attribute + + + + + Uri for the Sparkline properties. + + + + + MC prefix + + + + + MC Namespace + + + + + Prefix for core properties namespace. + + + + + Name of the relation type that indicates dublin core part. + + + + + Prefix for dublin core namespace. + + + + + Name of the relation type that indicates dublin core terms part. + + + + + Prefix for dublin core terms namespace. + + + + + Name of the relation type that indicates DCMIType part. + + + + + Prefix for DCMIType namespace. + + + + + Name of the relation type that indicates XSI part. + + + + + Prefix for XSI namespace. + + + + + Name of the relation type that indicates that part contains custom properties. + + + + + Name of the relation type that indicates DocPropsVTypes namespace + + + + + OleObject Content Type + + + + + OleObject File Extension + + + + + Prefix for DocPropsVTypes namespace. + + + + + Prefix for relation namespace. + + + + + Prefix for Sparkline namespace. + + + + + Prefix for X15 namespace. + + + + + Prefix for X namespace. + + + + + Prefix for xda namespace + + + + + Prefix for list namespace. + + + + + Prefix for Chart 15. + + + + + Prefix for Microsoft Main Namespace. + + + + + Name of the xml tag that stores content types definitions. + + + + + Name of the xml attribute with part extension. + + + + + Name of the xml tag that stores default type name. + + + + + Name of the xml tag that stores content type string. + + + + + Name of the xml tag that stores type override. + + + + + Name of the xml attribute that stores part name. + + + + + Name of the xml tag that defines the structure of the workbook. + + + + + Name of the xml tag that represents the collection of sheets in the workbook. + + + + + Name of the xml tag that represents the fileSharing of the workbook. + + + + + Name of the xml attribute that stores the readOnly value. + + + + + Name of the xml tag that defines a sheet in this workbook. + + + + + Name of the xml attribute that stores sheet name. + + + + + Default worksheet path format + + + + + Relation id format + + + + + Name of the xml attribute that stores unique sheet id. + + + + + Name of the xml attribute that stores relation id. + + + + + Name of the xml attribute that stores relation id, + it is used in .rels file (starts with capital letter). + + + + + Name of the xml attribute that specifies the visible state of this sheet. + + + + + This element defines the collection of properties the application uses + to record calculation status and details. + + + + + Calculation ID + + + + + Calculation Mode + + + + + Tab Selected + + + + + Manual Calc Mode Value + + + + + Auto No Table Calc Mode Value + + + + + Default delimiter between worksheet rows. + + + + + Indicates the book window is hidden, but can be shown by the user via the user interface. + + + + + Indicates the sheet is hidden and cannot be shown in the user interface (UI). + This state is only available programmatically. + + + + + Indicates the sheet is visible. + + + + + Name of the xml tag that holds relationships data. + + + + + Name of the xml tag that holds relationship data. + + + + + Name of the xml attribute that holds relationship type. + + + + + Name of the xml attribute that holds relationship target. + + + + + Name of the xml attribute that holds relationship target mode. + + + + + Name of relationship external target mode. + + + + + Name of the xml tag that contains merged cells data. + + + + + Name of the count attribute. + + + + + Name of the defaultTableStyle. + + + + + Name of the defaultPivotStyle. + + + + + Name of the xml tag that contains single merge region's data. + + + + + Name of the ref attribute. + + + + + Name of the xml tag that contains all defined named ranges. + + + + + Name of the xml tag that contains single defined named range. + + + + + Name of the name attribute. + + + + + Name of the source name attribute. + + + + + Name of the comment attribute. + + + + + Name of the attribute that stores sheet id for named range. + + + + + Name of the xml tag that contains all styles settings (fonts, number formats, fills, etc.) inside. + + + + + Name of the xml tag that contains slicer list + + + + + Name of the xml tag that contains slicer + + + + + Name of the xml tag that contains slicer caches + + + + + Name of the xml tag that contains slicer cache + + + + + Name of the xml tag that contains all fonts settings inside. + + + + + Name of the xml tag that contains all font settings inside. + + + + + Name of the xml tag that indicates that font is bold. + + + + + Name of the xml tag that indicates that font is italic. + + + + + Name of the xml tag that stores font underline settings. + + + + + Name of the value attribute. + + + + + Name of the xml tag that stores font underline settings. + + + + + Name of the xml tag that indicates that font has strike settings. + + + + + Name of the xml tag that represents font name. + + + + + Name of the xml tag that contains color settings. + + + + + Name of the indexed attribute in the color tag. + + + + + Name of the xml attribute that represents index into the theme colors collection. + + + + + Name of the xml attribute that represents the tint value applied to the color. + + + + + Name of the rgb attribute in the color tag. + + + + + Name of the default color attribute. + + + + + Name of the xml tag that stores indexed color values. + + + + + Name of the xml tag that stores color settings. + + + + + Name of the xml tag that stores rgb color. + + + + + Name of the xml tag that stores MacOSShadow settings. + + + + + Name of the xml tag that stores font vertical alignment settings. + + + + + Name of the xml tag that stores font family settings. + + + + + Name of the xml tag that stores font charset settings. + + + + + Name of the xml tag that represents number formats. + + + + + Name of the xml tag that represents single number format. + + + + + Name of the xml attribute that defines number format id. + + + + + Name of the xml attribute that defines number format string. + + + + + Name of the xml tag that represents fills collection. + + + + + Name of the xml tag that represents single fill object. + + + + + Name of the xml tag that represents pattern fill object. + + + + + Name of the xml tag that represents gradient-style cell fill. + + + + + Name of the xml attribute that represents type of gradient fill. + + + + + This gradient fill is of linear gradient type. + + + + + This gradient fill is of path gradient type. + + + + + Name of the xml attribute that represents angle of the linear gradient - vertical, horizontal, diagonal. + + + + + Name of the xml attribute that specifies in percentage format (from the top to the bottom) the + position of the bottom edge of the inner rectangle (color 1). + + + + + Name of the xml attribute that specifies in percentage format (from the left to the right) the + position of the left edge of the inner rectangle (color 1). + + + + + Name of the xml attribute that specifies in percentage format (from the left to the right) the + position of the right edge of the inner rectangle (color 1). + + + + + Name of the xml attribute that specifies in percentage format (from the top to the bottom) the + position of the top edge of the inner rectangle (color 1). + + + + + Name of the xml tag name that represents one of a sequence of two or more gradient stops, constituting this gradient fill. + + + + + Name of the xml attribute that represents position information for this gradient stop. + + + + + Name of the xml attribute that defines pattern. + + + + + Name of the xml tag that represents background color. + + + + + Name of the xml tag that represents foreground color. + + + + + Name of the xml tag that stores all border collections inside. + + + + + Name of the xml tag that stores single border collection. + + + + + Name of the xml attribute that represents border style. + + + + + Name of the xml tag that stores border color. + + + + + This is the root element of Sheet Parts that are of type 'worksheet'. + + + + + Name of the xml tag that stores worksheet dimension. + + + + + Name of the xml tag that stores sheet data. + + + + + Name of the xml tag that stores the scenarios + + + + + Name of the xml tag that stores the scenario + + + + + Name of the xml tag that shows the index value of the current scenario + + + + + Name of the xml tag that shows the index value of the current scenario + + + + + Name of the xml tag that stores the resultant cell range + + + + + Name of the xml tag that stores the name of the scenario + + + + + Name of the xml tag that stores the scenario to locked + + + + + Name of the xml tag that stores the scenario to hidden + + + + + Name of the xml tag that stores the count of the scenario + + + + + Name of the xml tag that stores the user name of the author + + + + + Name of the xml tag that stores the inputcell of the scenario + + + + + Name of the xml tag that stores the value of the scenario + + + + + Name of the xml tag that stores cell in the worksheet. + + + + + Name of the xml attribute that represents the cell metadata record associated with this cell. + + + + + Name of the xml attribute that represents boolean value to show phonetic information. + + + + + Name of the xml attribute that represents an A1 style reference to the location of this cell. + + + + + Name of the xml attribute that represents the index of this cell's style. + + + + + Name of the xml attribute that represents an enumeration representing the cell's data type. + + + + + Name of the xml attribute that represents index of the value metadata + record associated with this cell's value. + + + + + Name of xml tag that represents formula. + + + + + Name of xml tag that represents cell value. + + + + + Name of xml tag that represents rich text. + + + + + Name of xml tag that represents rich text run properties. + + + + + Name of xml tag that represents rich text run font name. + + + + + Name of the xml tag that stores all column settings. + + + + + Name of the xml tag that stores column settings range. + + + + + Name of the xml attribute that stores minimum column index of the column range. + + + + + Name of the xml attribute that stores maximum column index of the column range. + + + + + Name of the xml attribute that stores width of each column from column range. + + + + + Name of the xml attribute that stores style of each column from column range. + + + + + Name of the xml attribute that indicates whether column width differs from the default one. + + + + + + + + + + Name of xml tag that represents row. + + + + + Name of xml attribute that represents row index. + + + + + Name of xml attribute that represents row height in point size. + + + + + Name of xml attribute that shows whether row is visible or not. + + + + + Name of xml attribute that shows whether row style should be applied or not. + + + + + Name of xml attribute that shows whether row height has been manually set or not. + + + + + Name of xml attribute that shows whether row has been collapsed or not. + + + + + Name of xml attribute that shows whether value of the descent attribute. + + + + + Name of xml attribute that represents outlining level of the row. + + + + + Name of xml attribute that represents thick bottom flag. + + + + + Name of xml attribute that represents thick top flag. + + + + + Name of xml attribute that represents formula type. + + + + + True indicates that this formula is an array formula and the entire array shall be + calculated in full. If false the individual cells of the array shall be calculated as needed. + + + + + Name of xml attribute that represents shared formula group index. + + + + + Name of xml attribute that represents range of cells which the formula applies to. + + + + + Name of the xml tag that holds list of all comment authors. + + + + + Name of the xml tag that holds single author name. + + + + + Name of the xml tag that holds all comment notes. + + + + + Name of the xml tag that holds single comment note. + + + + + Name of the xml tag that stores comment text. + + + + + Name of the xml tag that stores all comment notes settings. + + + + + Name of the xml tag that stores all threaded comments + + + + + Name of the xml tag that stores a threaded comment + + + + + Name of the xml tag that stores all mentions of threaded comments in the worksheet + + + + + Name of the xml tag tag that stores a mention from a threaded comment + + + + + Name of the xml tag tag that stores person id of a threaded comment + + + + + Name of the xml tag tag that stores dT of a threaded comment + + + + + Name of the xml tag that stores parent Id of a threaded comment + + + + + Name of the xml tag that stores done attribute name of a threaded comment + + + + + Name of the xml tag tag that stores person Id of a threaded comment mention + + + + + Name of the xml tag tag that stores mention Id of a threaded comment mention + + + + + Name of the xml tag tag that stores start index attribute of a threaded comment mention + + + + + Name of the xml tag tag that stores lenth attribute of a threaded comment mention + + + + + Name of the xml attribute that stores comment author id. + + + + + Defines default cell data type. + + + + + Name of the xml tag that stores extended formats for named styles. + + + + + Name of the xml tag that stores extended formats for cell formats. + + + + + Name of the xml tag that stores extended formats for differential formats. + + + + + Name of the xml tag that stores table styles. + + + + + Name of the xml tag that stores table style. + + + + + Name of the xml tag that stores table style element. + + + + + Name of the xml tag that stores table style name. + + + + + Name of the xml attribute that represents type of the table style element. + + + + + Size of the xml tag. + + + + + Name of the xml tag that stores pivot value. + + + + + Name of the xml attribute that represents an index to a dxf element in the Styles Part indicating which cell formatting to + apply when the conditional formatting rule criteria is met. + + + + + Name of the xml tag that stores single extended format settings. + + + + + Name of the xml attribute that represents font id. + + + + + Name of the xml attribute that represents fill id. + + + + + Name of the xml attribute that represents border id. + + + + + Name of the xml attribute that represents extended format index. + + + + + Name of the xml tag that stores named cell styles settings. + + + + + Name of the xml tag that stores single named cell style settings. + + + + + Name of the xml attribute that stores built in style id. + + + + + Name of the xml attribute that define the customized buildinstyles. + + + + + Indicates that this formatting is for an outline style. + + + + + Name of the xml attribute indicating whether the alignment formatting + specified for this xf should be applied. + + + + + Name of the xml attribute indicating whether the border formatting + specified for this xf should be applied. + + + + + Name of the xml attribute indicating whether the font formatting + specified for this xf should be applied. + + + + + Name of the xml attribute indicating whether the number formatting + specified for this xf should be applied. + + + + + Name of the xml attribute indicating whether the fill formatting + specified for this xf should be applied. + + + + + Name of the xml attribute indicating whether the protection formatting + specified for this xf should be applied. + + + + + Name of the xml tag that hold all style's alignment information. + + + + + Name of the xml tag that hold all style's protection information. + + + + + Name of the xml attribute that stores style indent level settings. + + + + + Name of the xml attribute that specifies the type of horizontal alignment in cells. + + + + + Name of the xml attribute indicating if the cells justified or distributed + alignment should be used on the last line of text. + + + + + Name of the xml attribute that holds reading order settings. + + + + + Name of the xml attribute that holds shrink to fit option. + + + + + Name of the xml attribute that holds text rotation value. + + + + + Name of the xml attribute that holds wrap text option. + + + + + Name of the xml attribute that specifies the type of vertical alignment in cells. + + + + + Name of the xml attribute that indicates whether cell is hidden. + + + + + Name of the xml attribute that indicates whether cell is locked. + + + + + Default value for FormulaHidden value. + + + + + Default value for Locked value. + + + + + Name of the xml attribute that stores value indicating whether the text + string in a cell should be prefixed by a single quote mark. + + + + + Name of the xml attribute that indicates whether diagonalDown border is present. + + + + + Name of the xml attribute that indicates whether diagonalUp border is present. + + + + + Name of the xml tag that represents person list + + + + + Name of the xml tag that stores person list + + + + + Name of the xml tag that represents metadata + + + + + Name of the xml tag that represents metadata types + + + + + Name of the xml tag that represents metadata type + + + + + Name of the xml tag that represents future metadata + + + + + Name of the xml tag that represents bk tag + + + + + Name of the xml tag that represents dynamicArrayProperties + + + + + Name of the xml tag that represents cell metadata + + + + + Name of the xml attrbute that represents display name attribute of person tag + + + + + Name of the xml attribute that represents providerId attribute of person tag + + + + + Name of the xml attribute that represents userId attribute of person tag + + + + + Name of the xml tag that represents shared string table. + + + + + Name of the xml attribute that represents the total count of unique strings in the SST. + + + + + Name of the xml tag that represents individual string in SST. + + + + + Name of the xml tag that represents the text content shown as part of a string. + + + + + Name of the xml tag that represents rich text run. + + + + + Root items for data preserving. + + + + + Attribute to specify string spacing. + + + + + Xml prefix. + + + + + Value specifying white space preservation in a string. + + + + + Represents Number data type. + + + + + Represents string data type. + + + + + Represents boolean data type. + + + + + Represents error. + + + + + Represents formula. + + + + + Represents inline string + + + + + Represents Font scheme. + + + + + Represents sorting state. + + + + + Represents case sensitive in sorting. + + + + + Represents sorting condition. + + + + + Represents sorting order of sorting condition. + + + + + Represents sorting option of sorting condition. + + + + + Represents cell color of sorting condition. + + + + + Represents font color of sorting condition. + + + + + Name of the xml tag that represents the root level complex type associated with a shared style sheet (or theme). + + + + + Name of the xml tag that represents the root level complex type associated with a shared style sheet (or theme) overrided. + + + + + Name of the xml tag that represents the theme formatting options for the theme and is the workhorse of the theme. + + + + + Name of the xml tag that represents a set of colors which are referred to as a color scheme. + + + + + Name of the xml attribute name that the actual color value, expressed as a sequence of hex digits RRGGBB. + + + + + Name of the xml tag that represents a color bound to predefined operating system elements. + + + + + Name of the xml attribute that represents the system color value. + + + + + Name of the xml attribute that represents the color value that was last computed by the generating application. + + + + + Name of the xml tag that represents a single dxf record, expressing incremental formatting to be applied. + + + + + Name of the xml tag that represents a collection of phonetic properties that affect the display of phonetic text. + + + + + Name of the xml tag that represents phonetic text + + + + + Name of the xml tag that represents a collection of hyperlinks. + + + + + Name of the xml tag that represents a single hyperlink. + + + + + Name of the xml attribute that represents display string, if different from string in string table. + + + + + Name of the xml attribute that represents relationship Id in this sheet's relationships part, + expressing the target location of the resource. + + + + + Name of the xml attribute that represents location within target. + + + + + Name of the xml attribute that represents cell location of hyperlink on worksheet. + + + + + Name of the xml attribute that represents additional text to help the user understand more about the hyperlink. + + + + + Name of the xml tag that represents sheet level properties. + + + + + Page setup properties of the worksheet. + + + + + Flag indicating whether the Fit to Page print option is enabled. + + + + + Name of the xml tag that represents background color of the sheet tab. + + + + + Name of the xml tag that represents sheet outline properties. + + + + + Name of the xml tag that represents Summary Row below property of sheet outline + + + + + Name of the xml tag that represents Summary column right property of sheet outline + + + + + Name of the xml tag that represents Background sheet image. + + + + + Represent file hyperlink string prefix. + + + + + Represent http hyperlink string prefix. + + + + + Name of the xml tag that stores sheet format properties. + + + + + Name of the xml attribute that stores rows are hidden by default. + + + + + Name of the xml attribute that stores default row height setting. + + + + + Name of the xml attribute that stores default col width setting. + + + + + Name of the xml attribute that stores base column width setting + + + + + Name of the xml attribute that stores thickBottom setting + + + + + Name of the xml attribute that stores thickTop setting + + + + + Name of the xml attribute that stores outlineLevelCol setting + + + + + Name of the xml attribute that stores outlineLevelRow setting + + + + + Name of the xml tag that specifies the collection of workbook views. + + + + + Name of the xml tag that specifies a single Workbook view. + + + + + Name of the xml attribute that specifies an unsignedInt that contains the index to the active sheet in this book view. + + + + + Name of the xml attribute that specifies a boolean value that indicates whether to group dates + when presenting the user with filtering options in the user interface. + + + + + Name of the xml attribute that specifies the index to the first sheet in this book view. + + + + + Name of the xml attribute that specifies a boolean value that indicates whether the book window is minimized. + + + + + Name of the xml attribute that specifies a boolean value that indicates whether + to display the horizontal scroll bar in the user interface. + + + + + Name of the xml attribute that specifies a boolean value that indicates whether + to display the sheet tabs in the user interface. + + + + + Name of the xml attribute that specifies a boolean value that indicates whether to display the vertical scroll bar. + + + + + Name of the xml attribute that specifies ratio between the workbook tabs bar and the horizontal scroll bar. + + + + + Name of the xml attribute that specifies visible state of the book window. + + + + + Name of the xml attribute that specifies the height of the workbook window. + + + + + Name of the xml attribute that specifies the width of the workbook window. + + + + + Name of the xml attribute that specifies the X coordinate for the upper left corner of the book window. + + + + + Name of the xml attribute that specifies the Y coordinate for the upper left corner of the book window. + + + + + Name of the xml tag that represents horizontal page break information. + + + + + Name of the xml tag that represents vertical page break information + + + + + Name of the xml attribute that represents number of breaks in the collection. + + + + + Name of the xml attribute that represents number of manual breaks in the collection. + + + + + Name of the xml tag that represents individual row or column breaks; + + + + + Name of the xml attribute that represents zero-based row or column Id of the page break. + Breaks occur above the specified row and left of the specified column. + + + + + Name of the xml attribute that represents manual Break flag. + '1' means the break is a manually inserted break. + + + + + Name of the xml attribute that represents zero-based index of end row or column of the break. + For row breaks, specifies column index; for column breaks, specifies row index. + + + + + Name of the xml attribute that represents zero-based index of start row or column of the break. + For row breaks, specifies column index; for column breaks, specifies row index. + + + + + Worksheet/chartsheet views collection. + + + + + This element specifies a chart sheet view. + + + + + Flag indicating whether this sheet should display zero values. + + + + + Zero-based index of this workbook view, pointing to a workbookView + element in the bookViews collection. + + + + + String used to serialize sheet zooming + + + + + String used to serialize sheet view + + + + + String used to serialize sheet zooming + + + + + String used to serialize Page break preview layout. + + + + + String used to serialize Normal layout. + + + + + String used to serialize boolean True value. + + + + + String used to serialize boolean False value. + + + + + String used to serialize Sparkline Column type. + + + + + String used to serialize Sparkline WinLoss type. + + + + + String used to serialize Display of Empty Cells as gaps. + + + + + String used to serialize Display of Empty Cells as zero. + + + + + String used to serialize Display of Empty Cells as Continued lines. + + + + + String used to serialize Vertical Axis type as custom. + + + + + String used to serialize Vertical Axis type as same. + + + + + Flag indicating whether this sheet should display gridlines. + + + + + Flag indicating whether the sheet is in 'right to left' display mode. + When in this mode, Column A is on the far right, Column B ;is one column + left of Column A, and so on. Also, information in cells is displayed in + the Right to Left format. + + + + + Flag indicating whether this sheet gridline is modified by user + + + + + String used to specify the color of grid line + + + + + This collection is used to reference binary parts containing arbitrary user-defined data. + + + + + The custom property element provides a mechanism to store name/value pairs + of arbitrary user-defined data. The name is stored in the attribute name, + the arbitrary data is stored in the binary part referenced by the relationshipId. + + + + + A collection of ignored errors, by cell range. + + + + + A single ignored error type for a range of cells. + + + + + + + + + + + + + + + Attribute used to store range reference. + + + + + This element defines properties that track which version of the application + accessed the data and source code contained in the file. + + + + + Specifies the incremental public release of the application. + For example, betas, service packs, and versions. + + + + + Name of the xml tag that represents last edited + + + + + Name of the xml tag that represents lowest edited + + + + + This xml element stores the details of WorkbookPr. + + + + + This element stores information about the Date format to be used. + + + + + This element stores information about the Precision to be followed. + + + + + Specifies the application name. + + + + + Value of the application name attribute. + + + + + Flag indicating whether the panes in the window are locked due to workbook protection. + This is an option when the workbook structure is protected. + + + + + Name of the xml tag that represents funtion groups + + + + + Xml attribute containing sheet codename. + + + + + Attribute for showing or hiding the fields list of pivot table in workbook + + + + + Xml Tags and Attributes containing Sheet Sparklines. + + + + + Name of the xml tag that represents extension list + + + + + Name of the xml tag that represents extension + + + + + Name of the xml tag that represents Calculate On Open + + + + + Attribute to show two-dimenssional data table + + + + + Attribute to show one-dimentional data table is a row or column + + + + + Attribute to represent first input cell for data table. + + + + + Attribute to represent first input cell for data table. + + + + + First visible character. + + + + + Name of the xml tag that represents transition evaluation + + + + + Flag indicating whether this sheet should display row and column headers. + + + + + Properties Constant + + + + + DocumentManagement Constalt + + + + + PC prefix + + + + + P prefix + + + + + Properties NameSpace + + + + + PartnerControls NameSpace + + + + + Default Theme Version + + + + + Represent the connections + + + + + Represent the connections + + + + + Represents ODBC File + + + + + Represents DataBase Name + + + + + Represents DataBase Type + + + + + Refreshed Version Attribute + + + + + BackGround Attribute + + + + + Save Data + + + + + DataBase Property Tag + + + + + Command Text Attribute + + + + + Command Type Attribute + + + + + Connection Id Attribute + + + + + Source File + + + + + Description Tag + + + + + Interval + + + + + Save password + + + + + Only use connection file + + + + + Background refresh + + + + + Credentials + + + + + Deleted + + + + + Text Properties + + + + + Represent the WebProperties + + + + + xml + + + + + url + + + + + Represent the Olap Property + + + + + Indicating whether cell has pivot button + + + + + Name of the xml tag that specifies the collection of custom workbook views. + + + + + Name of the xml tag that specifies single custom workbook view. + + + + + Represent the Parameters Property + + + + + Represent the Parameter Property + + + + + Represent the Parameter type + + + + + Represent the Sql type + + + + + Represents parameter prompt attribute. + + + + + Represents parameter boolean attribute. + + + + + Represents parameter cell attribute. + + + + + Represents parameter double attribute. + + + + + Represents parameter double attribute. + + + + + Represents parameter string attribute. + + + + + Represents parameter string attribute. + + + + + Represents the prefixe for Slicer cache definition + + + + + Represents the table slicer cache attribute + + + + + Represents the table id attribute + + + + + Represents the column id attribute + + + + + Represents the sort order attribute + + + + + Represents the cross filter type attribute + + + + + Represents the cross filter type attribute + + + + + Represents the pivot table attribute + + + + + Represents the sheet tab attribute + + + + + Represents the data attribute + + + + + CustomXmlParts Constants + + + + + Custom Xml Name + + + + + Custom Xml properties name + + + + + Custom xml relation + + + + + Data store item + + + + + Item Id Attribute + + + + + Custom Xml Schema References + + + + + Custom Xml Schema Reference + + + + + Custom Xml Uri Attribute + + + + + Xml Item Name + + + + + Xml Properties Name + + + + + Custom Xml Namespace + + + + + Item properties prefix + + + + + Custom Xml Item ID + + + + + Item Properties Uri + + + + + Custom Xml Item Properties Relation + + + + + XML namespace used for standard XML attributes, such as xml:space. + + + + + Name of the XML attribute that specifies whether to preserve whitespace. + + + + + Sequence of error types (must be in the same order as in ErrorTagsSequence). + + + + + String that formulas for Ole images. + + + + + String for the BorderColor of OleObject Image + + + + + Sequence of error xml attribute names corresponding to error types defined in ErrorsSequence. + + + + + Chars with codes less than 0x20 which are allowed to be used inside xml strings. + + + + + Parent workbook. + + + + + Formula utils. + + + + + Record extractor. + + + + + Collection with vml shapes seriliazators. + + + + + Object represent the current thread object + + + + + Collection with header/footer vml shapes seriliazators. + + + + + Collection with shape serializators. + + + + + Conditional formats list. + + + + + Sorting data list. + + + + + Color Filter Fill style + + + + + Filter Index for Color filter + + + + + Sorting data list for AutoFilters. + + + + + Sorting data list for TableFilters. + + + + + List of Sheet names. + + + + + Special characters can use in the sheet name. + + + + + Global index maintain for worksheet's custom properties + + + + + Initializes a new instance of the Excel2007Serializator class. + + Parent workbook. + + + + Dispose + + + + + Serialize content types. + + XmlWriter to save into. + + Dictionary which is used to identify content type and stores default types. + Key - file extension (string), Value - content type (string). + + + Dictionary which is used to identify content type and stores type overrides. + Key - part name, Value - content type (string). + + + + + Serializes workbook part (workbook.xml content) into XmlWriter. + + XmlWriter to serialize workbook properties into. + Stream that contains additional workbook information that + wasn't parsed on load and that is placed before sheets. + Stream that contains additional workbook information that + wasn't parsed on load and that is placed after named ranges. + Workbook views collection. + Workbook relations. + Dictionary that will contain pivot cache files + (key - cache object, value - cache file name). + Stream containing functionGroups tag data. + Custom workbook view collection + + + + Serializes Calculation property + + + + + + Serializes the workbookPr element + + + + + + Serializes file version tag. + + XmlWriter to serialize into. + + + + Serializes file sharing tag. + + XmlWriter to serialize sharing into. + + + + Serializes workbook protection options. + + XmlWriter to serialize protection into. + + + + Serializes merged cells. + + XmlWriter to save into. + Object to serialize. + + + + Serializes named ranges into specified writer. + + XmlWriter to save named ranges into. + + + + + Serializes styles collection into specified XmlWriter. + + XmlWriter to serialize styles into. + Stream that contains Dxfs formatting tags. + Dictionary with new XF indexes. + + + + Extracts color filter dxf stream and adds it to the internal stream list. + + Filter Collection from which stream is to be extracted. + Temporary stream to hold the extracted dxf stream. + Index of the dxf stream. + + + + Serializes relations collection into specified xml writer. + + Writer to serialize into. + Relations to serialize. + + + + Serializes single worksheet object. + + XmlWriter to serialize into. + Worksheet to serialize. + Stream with xml text starting from the + beginning of worksheet to sheetData or cols tag. + Stream with conditional formatting. + Dictionary with new XF indexes, key - old index, value - new index. + + + + Serializes Data table into sheet. + + XmlWriter to serialize into. + Worksheet to serialize. + + + + Serialize cells. + + XmlWriter to serialize into. + Worksheet to serialize. + DataTable with desired data. + Row of the first cell where DataTable should be imported. + Column of the first cell where DataTable should be imported. + Lastrow of the cell where DataTable should be imported. + LastColumn of the cell where DataTable should be imported. + Represents shared string collection. + Current row of the dataTable + Serialize row index + If true the column header should imported. + + + + Serialize Extensions + + + + + + + Serializes controls additional information. + + XmlWriter to serialize into. + Worksheet to serialize. + + + + Update Anchors value in control stream. + + XmlNode element + Boolean value use the update the values. + Current wrok sheet + + + + Get the relate shapeImpl. + + Child node + Shape collection + + + + + Get the child node. + + Xml node + control string + + + + + Write Alternate Content Footer + + + + + + Write Alternate Cotent Header + + + + + + Write Alternate Content Controls Header + + + + + + Serializes protection options if necessary. + + XmlWriter to serialize into. + Worksheet to get protection options from. + + + + Serializes single protection option. + + XmlWriter to serialize protection into. + Name of the attribute to serialize. + Flag that corresponds to the attribute. + Default value. + Current protection settings. + + + + Serializes single protection option. + + XmlWriter to serialize protection into. + Name of the attribute to serialize. + Flag that corresponds to the attribute. + Default value. + Current protection settings. + + + + Serializes ignore errors options. + + XmlWriter writer to serialize options into. + Worksheet to serialize options for. + + + + Serializes single error indicator. + + XmlWriter to serialize into. + Error indicator to serialize. + + + + Serializes all required attributes for error indicator option. + + XmlWriter to serialize into. + Ignore error value. + + + + Converts cell list of the error indicator into string. + + Error indicator to get list for. + String representation of cell list for specified error indicator. + + + + Serializes custom worksheet properties if necessary. + + XmlWriter to serialize into. + Worksheet to serialize. + + + + Serializes worksheet custom property + + XmlWriter to serialize into. + Worksheet to serialize. + Represents custom document property. + + + + Writes property data into specified item. + + Parent worksheet. + Zip archive item to write property value into. + Property to get data from. + + + + Returns worksheet stream that contains its conditional formats. + + Sheet index. + Stream with conditional formats. + + + + Returns worksheet stream that contains its Sortind data. + + Sheet index. + Stream with Sorting data. + + + + Returns worksheet stream that contains its Sortind data. + + AuoFilters sheet index. + Stream with Sorting data. + + + + Returns the worksheet stream that contains color filter data + + index of the Stream to be returned. + Serialized color Stream. + + + + Returns worksheet stream that contains its Sortind data. + + AuoFilters sheet index. + Stream with Sorting data. + + + + Serializes comment notes part (authors, text and parent cell address). + + XmlWriter to serialize into. + Worksheet to get comments from. + + + + Serialize threaded comments + + XmlWriter to serialize into. + Worksheet to get comments from. + + + + Serialize threaded comments + + + + + Serialize threaded comments mentions + + XmlWriter to serialize into + List of mentions to be serialized + + + + Serializes vml shapes. + WARNING: this method doesn't check whether there are any shapes to serialize or not. + + XmlWriter to serialize into. + Shapes to serialize. + Parent worksheet data holder. + Dictionary with all known vml shapes serializators. + + + + Serializes drawings. + + XmlWriter to serialize into. + Shapes to serialize. + Parent worksheet data holder. + + + + This method serializes specified shape into specified writer. + + XmlWriter to serialize shape settings into. + Shape to serialize. + Parent worksheet data holder. + + + + This method serializes specified group shape into specified writer. + + XmlWriter to serialize shape settings into. + Group shape to serialize. + Parent worksheet data holder. + + + + This method serializes specified group shape properties. + + XmlWriter to serialize shape settings into. + Group shape to serialize. + Parent worksheet data holder. + + + + Checks whether the shapes has alternate content + + + + + + + Serialize Link Item + + + + + + + + Serializes external workbook into specified XmlWriter. + + XmlWriter to serialize into. + External workbook to serialize. + Collection with external link item relations. + + + + Serializes dde object link into specified XmlWriter. + + XmlWriter to serialize into. + External workbook to serialize. + Collection with external link item relations. + + + + Serializes external workbook into specified XmlWriter. + + XmlWriter to serialize into. + External workbook to serialize. + Collection with external link item relations. + + + + Serializes external worksheets data set. + + XmlWriter to serialize into. + External workbook to serialize. + + + + Serializes external sheet names. + + XmlWriter to serialize into. + External workbook to serialize. + + + + Serializes all external names from the external workbook. + + XmlWriter to serialize named ranges into. + External workbook to get named ranges from. + + + + Serializes single external name. + + Writer to serialize name into. + Name to serialize. + + + + Serializes drawings (images and other shapes). + + XmlWriter to serialize into. + Worksheet to serialize. + + + + Serializes part of the worksheet that contains information about + vml shapes (legacydrawing tag). + + XmlWriter to serialize into. + Worksheet to serialize. + + + + Serializes the OLE. + + The writer. + The sheet. + + + + Serialize Ole object. + + The writer + The sheet + Ole object + True if serialize the objecPr, otherwise not serialize + + + + Serialize ObjectPr. + + The writer + The sheet + Ole object + + + + Serialize Ole object anchor. + + The writer + The sheet + Ole object + + + + Serializes part of the worksheet that contains information about + vml shapes (legacydrawing tag). + + XmlWriter to serialize into. + Worksheet to serialize. + + + + Serializes comments list (following comment settings: note, cell address, author id). + + XmlWriter to serialize into. + Worksheet to get comments from. + Dictionary with all used authors: key - author name, value - author id. + + + + Serialize single comment settings into specified writer. + + Writer to serialize into. + Comment to serialize. + Dictionary containing author name. + + + + Serializes list of authors for comments collection. + + XmlWriter to serialize into. + Worksheet to get comments from. + Dictionary with authors: key - author name, value - author id. + + + + Serializes worksheet's dimension. + + XmlWriter to serialize into. + Worksheet to serialize dimension of. + + + + Serializes worksheet's view properties. + + XmlWriter to serialize into. + Worksheet to serialize. + + + + Serializes active cell. + + Writer to write selection information into. + Worksheet to get active cell from. + + + + Serializes pane record. + + XmlWriter to serialize into. + Worksheet to serialize pane for. + + + + Serializes stream. + + XmlWriter to serialize into. + Data to be serialized. + + + + Serializes stream data. + + XmlWriter to serialize into. + Data to be serialized + Root name of the data. + + + + Serializes dialog stream data. + + XmlWriter to serialize into. + Data to be serialized + + + + Serializes single relation object. + + XmlWriter to serialize into. + Relation key. + Relation object. + + + + Serializes sheets collection into workbook part. + + Writer to serialize into. + + + + Serializes single sheet entry inside of sheets tag from workbook part. + + XmlWriter to serialize into. + TabSheet to serialize. + + + + Serializes single sheet entry inside of sheets tag from workbook part. + + XmlWriter to serialize into. + Dialogsheet to serialize. + + + + Serializes sheets entry inside of sheets tag from workbook part. + + XmlWriter to serialize into. + macrosheet and intlmacrosheet to serialize. + + + + Generates free sheetId. + + Extracted sheet id. + + + + Converts MergeRegion into string representing range. + + Region to convert. + Converted value. + + + + Serializes named range into specified XmlWriter. + + XmlWriter to serialize named range into. + Named range to serialize. + + + + Gets the index of the local sheet. + + The sheet. + + + + + Checks the name of the sheet. + + The STR name value. + + + + + Serializes fonts collection into specified XmlWriter. + + XmlWriter to serialize fonts into. + + + + Serialize single font object into specified XmlWriter. + + XmlWriter to serialize fonts into. + Font to serialize. + Element tag name to serialize font for. + + + + Serializes font color object. + + XmlWriter to serialize into. + Name of the tag to use. + Color object to serialize. + + + + Serializes number formats collection into XmlWriter. + + XmlWriter to serialize into. + + + + Serialize single instance of number format into XmlWriter. + + Writer to save number format into. + Number format to serialize. + + + + Gets customized currency format string of user input format string, in accordance with MS Excel behavior + + Number format string. + Customized currency format string. + + + + Serializes fills into specified writer. + + XmlWriter to save fills into. + Array with fill indexes, index in array means extended format index, value means fill index. + + + + Serializes single fill object into specified XmlWriter. + + XmlWriter to serialize into. + Object to serialize. + + + + Serializes single pattern fill object into specified XmlWriter. + + XmlWriter to serialize into. + Object to serialize. + + + + Serializes single gradient fill object into specified XmlWriter. + + XmlWriter to serialize into. + Object to serialize. + + + + Serializes single cf gradient fill object into specified XmlWriter. + + XmlWriter to serialize into. + Object to serialize. + + + + + Serializes single degree gradient fill object into specified XmlWriter. + + XmlWriter to serialize into. + Object to serialize. + + + + Serializes single cf degree gradient fill object into specified XmlWriter. + + XmlWriter to serialize into. + Object to serialize. + + + + + Serializes single from corner or from center gradient fill object into specified XmlWriter. + + XmlWriter to serialize into. + Object to serialize. + + + + Serializes single Cf from corner or from center gradient fill object into specified XmlWriter. + + XmlWriter to serialize into. + Object to serialize. + + + + + Serializes stop color for gradient fill object into specified XmlWriter. + + XmlWriter to serialize into. + Stop position attribute value. + Represents Color. + + + + Converts specified pattern into string that can be understood by MS Excel 2007. + + Pattern to convert. + Converted value. + + + + Serializes borders into specified XmlWriter. + + XmlWriter to save borders into. + Border indexes. + + + + Serializes color into XmlWriter. + + XmlWriter to serialize color into. + Name of the color tag. + Color value. + + + + Serializes rgb color value. + + XmlWriter to serialize into. + Xml tag name to use for color serialization. + Color to serialize. + + + + Serializes theme color into XmlWriter. + + XmlWriter to serialize color into. + Name of the color tag. + Color value. + + + + Serializes color into XmlWriter. + + XmlWriter to serialize color into. + Name of the color tag. + Color value. + + + + Serializes borders collection into specified XmlWriter. + + XmlWriter to serialize borders into. + Borders collection to serialize. + + + + Serializes single border entry inside BordersCollection. + + XmlWriter to serialize border into. + Border to serialize. + + + + Gets border. + + Represents Border line type + Border extracted. + + + + Gets Border line style. + + Border line style to be extracted for. + Extracted line style. + + + + Serializes extended formats used by named styles. + + XmlWriter to serialize into. + Index to fill objects (position in array - xf index, + value - fill index). + Index to border objects (position in array - xf index, + value - border index). + Dictionary containing extended format indexes. + + + + Serialize extended formats that are responsible for cell format (do not have names). + + XmlWriter to serialize into. + Index to fill objects (position in array - xf index, + value - fill index). + Index to border objects (position in array - xf index, + value - border index). + Dictionary with new parent indexes. + Dictionary containing extended format indexes. + + + + Serializes single extended format. + + XmlWriter to serialize into. + Array with fill indexes. + Array with border indexes. + Format to serialize. + Dictionary with new parent indexes. + Default value for ApplyAlignment, ApplyBorder, etc. + + + + Serializes alignment options if necessary. + + XmlWriter to serialize into. + ExtendedFormat to serialize. + + + + Checks whether specified extended format has default alignment options. + + Extended format to check. + True if extended format has default alignment options. + + + + Checks whether specified extended format has default alignment options. + + Extended format to check. + True if extended format has default alignment options. + + + + Serializes protection options if necessary. + + XmlWriter to serialize into. + ExtendedFormat to serialize. + + + + Serializes all named styles. + + XmlWriter to serialize into. + Dictionary with new extended format indexes. + Key - index in our collection of extended formats, value - index in the cellStyleXfs block. + + + + Serializes single named style object. + + XmlWriter to serialize into. + Style object to serialize. + Dictionary with new extended format indexes. + Key - index in our collection of extended formats, value - index in the cellStyleXfs block. + + + + Serializes dictionary where key and value are strings. + + XmlWriter to serialize into. + Dictionary to serialize. + Tag name for single entry. + Attribute name for key. + Attribute name for value. + File name preprocessor that allows user to change item names. + + + + Lower first letter in the string. + + String to process. + New string with the first letter in lower case. + + + + Upper first letter in the string. + + String to process. + New string with the first letter in upper case. + + + + Serializes attribute if it differs from default value. + + XmlWriter to serialize into. + Attribute name. + Attribute value. + Default value. + + + + Serielaize bool value + + + + + + + + Serializes attribute if it differs from default value. + + XmlWriter to serialize into. + Attribute name. + Attribute value. + Default value. + + + + Serializes attribute if it differs from default value. + + XmlWriter to serialize into. + Attribute name. + Attribute value. + Default value. + + + + Serializes attribute if it differs from default value. + + XmlWriter to serialize into. + Attribute name. + Attribute value. + Default value. + Namespace of the attribute that is being serialized. + + + + Serializes attribute if it differs from default value. + + XmlWriter to serialize into. + Attribute name. + Attribute value. + Default value. + + + + Serializes attribute if it differs from default value. + + XmlWriter to serialize into. + Attribute name. + Attribute value. + Default value. + + + + Serializes element if it differs from default value. + + XmlWriter to serialize into. + Element name. + Element value. + Default value. + + + + Serializes element if it differs from default value. + + XmlWriter to serialize into. + Element name. + Element value. + Default value. + Element prefix. + + + + Serializes element if it differs from default value. + + XmlWriter to serialize into. + Element name. + Element value. + Default value. + + + + Serializes single sheet. + + Writer to serialize into. + Sheet to serialize. + + + + Serializes single sheet. + + Writer to serialize into. + Sheet to serialize. + + + + Serializes sheet data. + + XmlWriter to serialize into. + Cell record collection. + Dictionary with new extended format indexes. + Key - index in our collection of extended formats, value - index in the cellStyleXfs block. + + + + Serializes the scenarios + + XmlWriter to serialize + Represent the scenarios of the worksheet + sheet to serialize + + + + + Serializes the scenario + + XmlWriter to serialize + Represent the scenario of the worksheet + sheet to serialize + + + + Serializes specified attributes if necessary. + + XmlWriter to serialize. + Collection with attributes to serialize. + Key - attribute name, value - attribute value. + + + + Serializes single row. + + XmlWriter to serialize into. + Row to serialize. + Cell record collection. + Row index. + Dictionary with new extended format indexes. + Key - index in our collection of extended formats, value - index in the cellStyleXfs block. + + + + Serializes cells. + + XmlWriter to serialize into. + Current row. + Cell record collection. + Dictionary with new extended format indexes. + Key - index in our collection of extended formats, value - index in the cellStyleXfs block. + + + + Serializes cells, which are not represented by Blank, MulBlank and MulRK records. + + XmlWriter to serialize into. + Record to serialize. + Row storage enumerator. + Cell record collection. + Dictionary with new extended format indexes. + Key - index in our collection of extended formats, value - index in the cellStyleXfs block. + + + + Serialize blank cell. + + XmlWriter to serialize into. + Row index. + Column index. + Extended format index. + Dictionary with new extended format indexes. + Key - index in our collection of extended formats, value - index in the cellStyleXfs block. + + + + Serializes MulBlank record. + + XmlWriter to serialize into. + MulBlank record to serialize. + Dictionary with new extended format indexes. + Key - index in our collection of extended formats, value - index in the cellStyleXfs block. + + + + Serialize MulRKRecord cell values. + + XmlWriter to serialize into. + MulRK record. + Dictionary with new extended format indexes. + Key - index in our collection of extended formats, value - index in the cellStyleXfs block. + + + + Serializes array formula. + + XmlWriter to serialize into. + Formula array record. + + + + Serializes formula. + + XmlWriter to serialize into. + Formula record. + Cell record collection. + + + + Serializes DataTable formula. + + XmlWriter to serialize into. + Cell Formula. + + + + Serializes cell value. + + XmlWriter to serialize into. + Record to get value from. + Cell type. + + + + Serializes formula value. + + XmlWriter to serialize into. + Formula record to serialize from. + Cell type. + Row storage enumerator. + + + + Defines cell data type to serialize. + + Biff record. + String representation of the cell type. + Extracted Cell data type. + + + + Serialize Person into specified XmlWriter + + + + + + Serializes metadata into specified XmlWriter + + writer to serialize + + + + Serializes shared string table into specified XmlWriter. + + XmlWriter to save SST into. + + + + Serializes slicer cache + + XmlWriter to save Slicer cahce. + Represents the slicer. + Slicer work sheet. + + + + Serializes pivot slicer cache + + XmlWriter to save Slicer cahce. + Represents the slicer. + Slicer work sheet. + + + + Serializes string item into specified XmlWriter. + + XmlWriter to save string item into. + Rich text or string object to serialize. + + + + Replaces characters with codes less then 0x20. + + Text to replace chars in. + + + + + Ignores the hexa string with the hexa code before serialize + + string to ignore the hexa string + ignored hexa string + + + + Checks whether specified string is hexadecimal number. + + + + + + + Serializes rich text run into specified XmlWriter. + + XmlWriter to save rich text into. + Rich text run to serialize. + + + + Serializes rich text run single entry. + + XmlWriter to save rich text into. + Fonts collection. + String to serialize. + Font index. + + + + Serializes colors settings. In the current implementation it serializes palette if necessary. + + Writer to serialize into. + + + + Serializes palette. + + XmlWriter to serialize palette into. + + + + Determines whether palette contains default colors. + + True if all colors have default value; false otherwise. + + + + Serializes column settings. + + XmlWriter to serialize into. + Worksheet that stores column settings. + Dictionary with modified style indexes. + + + + Serialize single ColumnInfoRecord into specified XmlWriter. + + Writer to serialize into. + Record to serialize. This value can be null, + in this case no data will be serialized. + Dictionary with modified style indexes. + Default column width. + Parent worksheet. + Last index in the sequence of the same columns. + + + + Checks whether columns after iColumnIndex have the same settings and + returns the last number in the sequence. + + Worksheet to search in. + Column index to start searching from. + Last index in the sequence of the same columns. + + + + Serializes data validations. + + XmlWriter to serialize data validations. + Data validation table. + + + + Serializes data validation collection. + + XmlWriter to serialize data validation collection. + Data validation table. + + + + Serializes data validation. + + XmlWriter to serialize data validation. + Data validation implementation. + + + + Returns DV type name. + + Data validation type. + DV type name. + + + + Returns DV error style name. + + Data validation error style. + DV error style. + + + + Returns DV compare operator type name. + + Data validation compare operator. + DV compare operator type name. + + + + Serializes auto filters. + + XmlWriter to serialize auto filters. + Auto filters collection. + + + + Serializes auto filters. + + XmlWriter to serialize auto filters. + Auto filters collection. + Slicer source table + + + + Serializes filter column. + + XmlWriter to serialize filter column. + Auto filter to serialize. + Indices of merged column headers in AutoFilters + + + + Serializes Color Filter to Stream + + Writer object to serialize the color filter stream into. + + + + Serializes Icon Filter + + Writer object to serialize Icon Filter into. + Icon Filter to be serialzed. + + + + Serializes the alternate content of Icon Filter. + + Writer object to serialize icon filter into. + Icon Filter to be serialzed. + + + + Serializes filters. + + XmlWriter to serialize filters. + AutoFilter + + + + Serializes filter. + + XmlWriter to serialize filter. + Condition value. + + + + Serializes auto filter top ten value. + + XmlWriter to serialize top ten. + Auto filter implementation. + + + + Serializes custom filters. + + XmlWriter to serialize custom filters. + Auto filter implementation. + + + + Serializes custom filter. + + XmlWriter to serialize custom filters. + Auto filter condition. + + + + Returns auto filter condition operator name. + + Filter condition. + Auto filter condition operator name. + + + + Gets the active pane. + + The pane record. + + + + + Returns auto filter condition value. + + Filter condition. + Auto filter condition value. + + + + Serializes conditional formats and corresponding Dxf styles for this formats. + + XmlWriter to serialize formats into. + XmlWriter to serialize Dxf styles into. + Conditional formatting. + Current Dxf index. + Currents CF priority. + + + + Serializes conditional format and corresponding Dxf style for this format. + + XmlWriter to serialize format into. + XmlWriter to serialize Dxf style into. + Represents Condition. + Current Dxf index. + Currents CF priority. + Number of rules or priorities in the range. + + + + Serializes color scale of conditional format. + + XmlWriter to serialize into. + Represents color scale. + + + + Serializes icon set. + + XmlWriter to serialize into. + Icon set to serialize. + Check if the iconset have extension lists. + Check if the iconset have custom iconset. + + + + Serializes data bar. + + XmlWriter to serialize into. + Data bar to serialize. + + + + Serializes conditional value object. + + XmlWriter to serialize into. + Object to serialize. + Check is iconset. + + + + Serializes conditional value object. + + XmlWriter to serialize into. + Object to serialize. + Check if is iconset. + Check it has extension lists. + Check the iconset is custom. + + + + Serializes Custom iconset object. + + + + + + + + Returns CF comparison operator string name. + + Excel comparison operator. + CF comparison operator string name. + + + + Return the CF time period string name + + Time period type + Time period string name + + + + Returns CF type string name. + + Excel CF type. + CF type string name. + + + + Serializes Dxf styles and conditional formatting. + + Dxf stream. + Conditional formatting. + Stream containing conditional formats. + + + + Serialize the dxfs styles and table styles. + + Stream of the dxfs styles + Table styles object + Index of the DxfId + + + + + Serialize the dxfs styles and table styles. + + Stream of the dxfs styles + Table styles object + Index of the DxfId + + + + + Serializes the Custom format elements of the pivot table fields. + + Xml writer to serialize the custom formats into. + pivot table to serialize the filters + + + + Serializes Dxf styles and Sorting and Color Filter. + + Dxf stream. + SortState + AutoFilter Object to extract ColorFilter + Dxf Index of the serialized color Object + Stream containing Sorting data or Color Object. + + + + Serializes Dxf style. + + XmlWriter to serialize style into. + Conditional format. + + + + Serialize the Dxf styles. + + XmlWriter + Table style element object + + + + Serializes Dxf style. + + XmlWriter to serialize style into. + Sorting Field. + + + + Serialize the Dxf styles. + + XmlWriter + Table style element object + + + + Serializes Dxf number format. + + XmlWriter to serialize number format + Represents Condition. + + + + Serializes Dxf number format. + + XmlWriter to serialize number format + Represents Condition. + + + + Serializes Dxf style borders. + + XmlWriter to serialize borders into. + Represents Condition. + + + + Serialize the Dxf style borders. + + XmlWriter + Table style element object + + + + Serialize the Dxf style borders. + + XmlWriter + Table style element object + + + + Serializes Dxf border. + + XmlWriter to serialize border into. + Border index. + Line style. + Represents Color. + + + + Serializes Dxf style fill. + + XmlWriter to serialize fill into. + Represents Condition. + + + + Serialize the Dxf Style Fill. + + XmlWriter + Table style element object + + + + Serializes Dxf style fill. + + XmlWriter to serialize fill into. + Represents SortField. + + + + Serialize the Dxf Style Fill. + + XmlWriter + Table style element object + + + + Serializes Dxf style font. + + XmlWriter to serialize font into. + Represents Condition. + + + + Serialize the Dxf style Font. + + XmlWriter + Table style element object + + + + Serializes Dxf style font. + + XmlWriter to serialize font into. + Represents SortField. + + + + Serializes alignment options if necessary. + + XmlWriter to serialize into. + Pivot cell format to serialize. + + + + Serializes protection options if necessary. + + XmlWriter to serialize into. + ExtendedFormat to serialize. + + + + Serialize the Dxf style Font. + + XmlWriter + Table style element object + + + + Serialize the table styles Attributes. + + XmlWriter + Count of table style in collection + + + + Serialize the dxfs styles and table style. + + XmlWriter + Table style object + XmlWriter of stream Dxfs + Index of the DxfsId + + + + Serialize the table style Attributes. + + + + + + + + Serialize the table style element and dxfs styles. + + XmlWriter + Table style element + XmlWriter of stream dxfs + Index of the DxfId + + + + Serialize the table style attributes. + + XmlWriter + Type of table style element + + + + Serialize the table style attributes. + + XmlWriter + Type of table style element + + + + Serialize the table style attributes of dxfId. + + XmlWriter + Index of the DxfId + + + + Serializes hyperlinks. + + XmlWriter to serialize hyperlinks. + Worksheet with hyperlinks collection. + + + + Serializes single hyperlink. + + XmlWriter to serialize hyperlink into. + Hyperlink to serialize. + Relations collection. + + + + Serializes all print settings (margins, header, footer, etc.). + + XmlWriter to serialize into. + Worksheet to get values from. + + + + Serializes print options. + + XmlWriter to serialize print options into. + PageSetup object to get print options from. + + + + Serializes page margins. + + XmlWriter to serialize into. + Object that stores all necessary margin values. + Object that provides xml tag/attribute names used + for page setup serialization. + + + + Validate whether Page margins are fit into the Page + + + + + + Serialize PageSetup tag. + + XmlWriter to serialize into. + Object to get necessary settings from. + + + + Serializes header and footer. + + XmlWriter to serialize into. + Object that stores required header/footer strings. + + + + Converts page setup PrintComments option into string representation used by Excel 2007. + + Value to convert. + Converted value. + + + + Converts page setup PrintErrors option into string representation used by Excel 2007. + + Value to convert. + Converted value. + + + + Converts address string to Excel 2007 type. + + Address string to convert. + Converted string. + + + + Serializes worksheet properties. + + XmlWriter to serialize properties into. + Worksheet to get properties from. + + + + Serializes background image. + + XmlWriter to serialize image into. + Worksheet to get image from. + + + + Serializes extended document properties. + + XmlWriter to serialize extended properties into. + + + + Serialize App version + + + + + + Serializes core properties into XmlWriter. + + XmlWriter to serialize core properties into. + + + + Serializes created and modified datetime element into XmlWriter. + + XmlWriter to serialize into. + Element tag name. + Date time value. + + + + Serializes custom properties into XmlWriter. + + XmlWriter to serialize properties into. + + + + Serializes Document Management of the ContentType Properties into XmlWriter. + + XmlWriter to serialize properties into. + + + + Serializes custom property into XmlWriter. + + XmlWriter to serialize into. + Custom property to serialize. + Custom property id. + + + + Serializes workbook views. + + XmlWriter to serialize into. + Workbook views collection. + + + + Serializes workbook view. + + XmlWriter to serialize into. + Workbook view. + + + + Changes or adds attribute value. + + Workbook view. + Attribute to make changes. + New value for attribute. + + + + Serializes external references. + + XmlWriter external links must be serialized into. + This writer should already contain some workbook data. + Workbook relation collection. + + + + Serializes single external link. + + External workbook object to serialize. + XmlWriter to write into. + Workbook relations. + + + + Serializes worksheet horizontal and vertical pagebreaks. + + XmlWriter to serialize into. + Worksheet to serialize page breaks for. + + + + Serializes the Color Filter Dxf to stream. + + XmlWriter to serialize into + XmlWriter to serialize dxf into + color filter object to get color from. + dxfid index + + + + Serializes data sorter. + + XmlWriter to serialize into. + XmlWriter to serialize dxf into. + DataSorter to serialize into. + dxfid index. + + + + Serializes data sorter. + + XmlWriter to serialize into. + XmlWriter to serialize dxf into. + DataSorter to serialize into. + Sorting Field to serialize into. + dxfid index. + + + + Serializes worksheet horizontal pagebreaks. + + XmlWriter to serialize into. + Sheet horizontal pagebreaks. + + + + Serializes worksheet vertical pagebreaks. + + XmlWriter to serialize into. + Sheet vertical pagebreaks. + + + + Serializes single pagebreak. + + XmlWriter to serialize into. + Row/column of pagebreak. + Start row/column. + End row/column. + Pagebreak type. + + + + Extracts extent settings from reader and converts them into pixels. + + Writer to save extent data into. + Size of the shape in pixels. + + + + Serialize connections + + + + + + Serialize connection + + + + + + + Serialize the parameter. + + XmlWriter to write data. + Query table parameter collection + + + + Serialize the parameter collection. + + XmlWriter to write data. + Query table parameter to write. + + + + Serialize DataBase Property + + + + + + + Serialize Database property + + + + + + + Serialize Web property + + + + + + + Check whether the sheet have special characters + + Name of the sheet + return true if the sheet name have special characters + + + + Serializes Custom Workbook views. + + XmlWriter to write data. + List of Custom WorkBook view + + + + Serializes Custom Workbook view. + + XmlWriter to write data. + Dictionary with attributes and value + + + + Serializes conditional value object. + + XmlWriter to serialize into. + Object to serialize. + whether it is iconset conditional format + whether the conditional format value is min point + + + + Serialize Combination filters. + + XML Writer. + Combination filter object. + + + + Serialize Date Filter. + + XML Writer. + DateTime Filter + + + + Serialize Dynamic Date Filter. + + XML Writer + Dynamic Filter + + + + Gets Dictionary with serializators that can be used to serialize header/footer vml shapes. Read-only. + + + + + Gets Dictionary with serializators that can be used to serialize vml shapes. Read-only. + + + + + Gets version that is supported by this serializator. + + + + + Represents the cell's data type. + + + + + Cell containing a date. + + + + + Cell containing a boolean. + + + + + Cell containing an error. + + + + + Cell containing an (inline) rich string. + + + + + Cell containing a number. + + + + + Cell containing a shared string. + + + + + Cell containing a formula string. + + + + + Represents type of formula. + + + + + Formula is an array entered formula. + + + + + Formula is a data table formula. + + + + + Formula is a regular cell formula. + + + + + Formula is part of a shared formula. + + + + + Uri for data bar properties + + + + + Uri for data bar ext properties + + + + + Represents Excel2010Serializator for workbook + + + + + + Serialize Extensions + + + + + + + Serializes the sparkline groups. + + The writer. + The sheet. + + + + Serializes the sparkline group. + + The writer. + The sheet. + The sparkline group. + + + + Serializes the sparklines. + + The writer. + The sheet. + The sparklines. + + + + Serializes the sparkline. + + The writer. + The sheet. + The sparkline. + + + + Serialize App version + + + + + + Check whether the sheet has conditional formats or not. + + input worksheet object + output value indicates whether the stream preserved or not + the boolean value indicates whether the cf applied or not. + + + + Serializes conditional formattings. + + The writer. + The sheet. + + + + Serializes conditional value object. + + XmlWriter to serialize into. + Object to serialize. + + + + Serializes rgb color value. + + XmlWriter to serialize into. + Xml tag name to use for color serialization. + Color to serialize. + + + + Serializes conditional value object. + + XmlWriter to serialize into. + Object to serialize. + whether it is iconset conditional format + whether the conditional format value is min point + + + + Gets version that is supported by this serializator. + + + + + Initializes Excel2013Serializator for workbook + + + + + + Serialize App Version + + + + + + Gets version that is supported by this serializator. + + + + + Excel2016 Serializator + + + + + Excel2016Serializator to serialize workbook + + + + + + Serialize App Version + + + + + + Gets version that is supported by this serializator. + + + + + Class used for Excel 2019 and above Serialization. + + + + + Constructor of the XlsxSerializator class with parameter Excel workbook + + + + + Serializes element if it differs from default value. + + XmlWriter to serialize into. + + + + Gets version that is supported by this serializator. + + + + + Serializes the pivot engine. + + + + + Populates the specifed pivot table. + + Source worksheet for the pivot table. + The pivot table which is to be populated. + + + + + Column name updated for Filters + + Column Name + updated column string + + + + Set pivot table general option in pivot engine values. + + Pivot Engine + Pivot Table + + + + Renders the pivot table values. + + PivotEngine object. + Sheet in which the pivot table is present. + The pivot table which is to be rendered. + + + + Renders the pivot table outline form. + + PivotEngine object. + Sheet in which the pivot table is present. + The pivot table which is to be rendered. + + + + Adds values row in Pivot table layout + + boolean value which indicates whether the value is present or not + column position + maximum row + maximum column + pivot sheet + pivot table + values row + + + + Modifies the layout for outline form. + + Pivot Layout + Pivot table + Pivot engine + + + + Renders the pivot table tabular form. + + PivotEngine object. + Sheet in which the pivot table is present. + The pivot table which is to be rendered. + + + + Set tabular specific styles for tabular form. + + Pivot Layoout + + + + Set styles for subtotal rows based on subtotal index. + + Pivot Layout + + + + Renders the pivot table compact form. + + PivotEngine object. + Sheet in which the pivot table is present. + The pivot table which is to be rendered. + + + + Replaces the delimiter in grand total. + + The target object in which replacement is to be done. + The old delimiter. + + The target object after the replacement. + + + + AutoFits the pivot table. + + Range in which the pivot table is located. + The pivot table which is to be autofitted. + + + + + + + + + + + + + + + + + + + + + + + + + Set pivot format to pivot layout. + + Pivot table layout to be updated. + Pivot table. + + + + Apply pivot table format to the cell style + + pivot table cell range + pivot table extended format + + + + + + + + + + + + + + + + + + Pivot Engine Comparer class. + + + + + Initializes a new instance of CustomComparer class. + + The object to compare. + The object to be compared with. + Boolean vaue indicating the comaprison results. + + + + This serializator use to serialize shapes in DrawingML 2007 format, + when shape is not supported, but it was extracted from Excel 2007 + document and we can preserve it. + + + + + This is general interface for classes that are responsible for shape serialization. + + + + + False Attribute + + + + + True Attribute + + + + + This method serializes specified shape into specified writer. + + XmlWriter to serialize shape settings into. + Shape to serialize. + Parent worksheet data holder. + + + + This method serializes general shape settings (shape type) into specified XmlWriter. + + XmlWriter to write shape type into. + Type of the shape that is going to be serialized. + + + + Generates anchor from the shape and converts it into string representation for Excel 2007 format. + + Shape to get anchor data from. + Generated anchor string. + + + + Serializes client data tag of the shape. + + XmlWriter to serialize into. + Shape to serialize. + + + + Serializes additional tag into ClientData tag. + + XmlWriter to serialize into. + Shape to serialize for. + + + + Serialize the fill style of textbox + + XmlWriter to serialize into. + Shape to serialize style for + Parent worksheet data holder. + Resource relation collection + + + + Serialize Solid fill of textbox + + Xmlwriter to serialize into + textbox shape for serialize + + + + Serialize the Gradient Fill + + XmlWriter to serialize into. + Shape to serialize style for + + + + Serialize Texture Fill + + XmlWriter to serialize into. + textBox Shape to serialize style for + Parent worksheet data holder. + Resource relation collection + + + + Serialize pattern Fill + + XmlWriter to serialize into. + textBox Shape to serialize style for + Parent worksheet data holder. + Resource relation collection + + + + Serialize Picture Fill + + XmlWriter to serialize into. + textBox Shape to serialize style for + Parent worksheet data holder. + Resource relation collection + + + + Serialize user Picture + + XmlWriter to serialize into. + textBox Shape to serialize style for + Parent worksheet data holder. + Resource relation collection + + + + Serilaize common Gradient fill attribute + + XmlWriter to serialize into. + textBox Shape to serialize style for + + + + Serialize Common fill attributes + + XmlWriter to serialize into. + textBox Shape to serialize style for + + + + Seialize Line for the Shape + + XmlWriter to serialize into. + textBox Shape to serialize style for + Parent worksheet data holder. + Resource relation collection + + + + Serialize Pattern Line + + XmlWriter to serialize into. + textBox Shape to serialize style for + Parent worksheet data holder. + Resource relation collection + + + + double degree value to string value with some calculations + + degree in double + + + + + Generate Hexdecimal color from the Color + + color object + + + + + Get the String value from the resource + + Excel Gradient Preset + + + + + Enum pattern to string + + enum pattern to string + execel equalent name + + + + opacity double to string with some calculations + + opacity to convert + opacity in excel format + + + + Remove Preceding zeroes in the color + + string color to remove zeroes + removed preceding zeroes + + + + Get the Excel matching Dash Style + + dashstyle to string + dashstyle to excel format + + + + Get the line style from the dictionary + + linestyle to string + line style in excel format + + + + Returns if the color is empty + + + + + + + Clears the variables in inherited classes if any. + + + + + This method serializes specified shape into specified writer. + + XmlWriter to serialize shape settings into. + Shape to serialize. + Parent worksheet data holder. + + + + Serialize the XML data stream for shape. + + XmlWriter to write shape type into. + Stream to write. + + + + This method serializes general shape settings (shape type) into specified XmlWriter. + + XmlWriter to write shape type into. + Type of the shape that is going to be serialized. + + + + Returns editAs attribute value. + + Shape to get settings from. + String value of editAs attribute for the shape. + + + + Serializes anchor point. + + XmlWriter to serialize into. + Name of the tag for anchor point. + Column index. + Offset inside column. + Row index. + Offset inside row. + Parent worksheet. + Xml namespace to use. + + + + + Serializes XY anchor point + + XmlWriter to serialize into. + Tag name to use. + X coordinate (will be divided by 1000 in the current implementation). + Y coordinate (will be divided by 1000 in the current implementation). + Xml namespace to use. + + + + Converts XY Anchor coordinate into string value for serialization. + + Coordinate to convert. + Converted value. + + + + Serializes Transform2D tag (xfrm). + + XmlWriter to serialize into. + Namespace for main (outer) tag. + Namespace for subtags (inner). + X coordinate of the form. + X coordinate of the form. + Width of the form. + Height of the form. + + + + Serializes the form. + + The writer. + The XML outer namespace. + The XML inner namespace. + The x. + The y. + The cx. + The cy. + The shape. + + + + Serializes the form. + + The writer. + The XML outer namespace. + The XML inner namespace. + The picture for which the tranformation is to be serialized. + + + + Serializes non visual canvas properties. + + XmlWriter to serialize into. + Shape to serialize properties for. + Object that stores data of the parent worksheet. + Xml namespace to use. + + + + Serializes prstGeom xml tag. + + XmlWriter to serialize into. + + + + Serializes shape's fill. + + XmlWriter to serialize into. + Shape to serialize fill for. + FileDataHolder object. + Drawing relations. + + + + Serializes line settings. + + XmlWriter to serialize into. + Line to serialize. + Parent workbook. + + + + Serialize the borders edge join. + + Xml writer + Line format + + + + A hash code for the current Object without taking cell list into account. + + The Object to compare with the current Object. + + + + + Returns the pivot reference collection. + + + + + Returns the count of pivot reference collection. + + + + + Returns a single pivot reference from the collection. + + + + + Represents collection of calculated fields in the pivot table. + + + + + Represents collection of calculated fields in the pivot table. + + + + + Adds calculated to the pivot table based on the specified formula. + + Represents the name of the calculated pivot field. + Represents the formula of the calculated pivot field. + Returns the calculated . + + To know more about Pivot Tables refer this link. + + The following code illustrates the use Add method in pivot calculated field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark1"; + sheet.Range["D1"].Text = "Mark2"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Number = 87; + sheet.Range["D3"].Number = 68; + sheet.Range["D4"].Number = 98; + sheet.Range["D5"].Number = 45; + sheet.Range["D6"].Number = 70; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + + //Add calculated field to the pivot table with specified formula + IPivotField field = pivotTable.CalculatedFields.Add("AverageMark", "(Mark1+Mark2)/2"); + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the number of calculated fields in the pivot table. Read-only. + + + To know more about Pivot Tables refer this link. + + The following code illustrates how to get count of calculated fields in the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + + int calculatedFieldCount = pivotSheet.PivotTables[0].CalculatedFields.Count; + if(calculatedFieldCount > 0) + { + //Your Code Here + } + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets a with the specified index from the collection. Read-only. + + Zero-based index of the item to get. + + To know more about Pivot Tables refer this link. + + The following code illustrates the use of index property in pivot calculated field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark1"; + sheet.Range["D1"].Text = "Mark2"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Number = 87; + sheet.Range["D3"].Number = 68; + sheet.Range["D4"].Number = 98; + sheet.Range["D5"].Number = 45; + sheet.Range["D6"].Number = 70; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + pivotTable.CalculatedFields.Add("Average", "(Mark1+Mark2)/2"); + + //Gets a pivot field with the specified index + IPivotField field = pivotTable.CalculatedFields[0]; + field.Name = "AverageMark"; + field.Subtotals = PivotSubtotalTypes.Average; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets a with the specified name from the collection. Read-only. + + Calculated Field Name + + To know more about Pivot Tables refer this link. + + The following code illustrates the use of name as index in pivot calculated field collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark1"; + sheet.Range["D1"].Text = "Mark2"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Number = 87; + sheet.Range["D3"].Number = 68; + sheet.Range["D4"].Number = 98; + sheet.Range["D5"].Number = 45; + sheet.Range["D6"].Number = 70; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + pivotTable.CalculatedFields.Add("Average", "(Mark1+Mark2)/2"); + + //Gets a pivot field with the specified name + IPivotField field = pivotTable.CalculatedFields["Average"]; + field.Name = "AverageMark"; + field.Subtotals = PivotSubtotalTypes.Average; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Initializes a new instance of pivot calculated fields collection with the specified pivot table. + + Pivot table from which the calculated fields are extracted. + + + + Adds calculated field to the pivot table based on the specified formula. + + Represents the name of the calculated pivot field. + Represents the formula of the calculated pivot field. + Returns the calculated pivot field. + + Following code snippet illustrates how to add a pivot calculated field to the pivot table. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + // Create Pivot cache with the given data range + IPivotCache cache = workbook.PivotCaches.Add(worksheet["A1:H50"]); + //Create "PivotTable1" with the cache at the specified range + IPivotTable pivotTable = worksheet.PivotTables.Add("PivotTable1", worksheet["A1"], cache); + //Add Pivot table fields (Row and Column fields) + pivotTable.Fields[2].Axis = PivotAxisTypes.Row; + pivotTable.Fields[6].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + + //Add data field + IPivotField field = pivotTable.Fields[5]; + pivotTable.DataFields.Add(field, "Sum", PivotSubtotalTypes.Sum); + + + + + + Update pivot table fields + + current pivot table + new calculated cachefield + pivot table field + + + + Gets a pivot field with the specified index from the collection. Read-only. + + Zero-based index of the item to get. + + + + Gets a pivot field with the specified name from the collection. Read-only. + + Calculated Field Name + + + + Represents an item within a PivotTable field which uses a formula + TODO: Need to create support for pivot item. + + + + + Represents a calculated pivot field item within a Pivot field of pivot table + TODO: need to add properties. + + + + + Specifies the formula of the calculated item + + + + + Specifies the formula of the calculated item + + + + + Specifies the pivotField with which this calculated item is associated. + + + + + Specifies the pivot field index with + which this calculated item is associated + + + + + Represents the calculated field area + + + + + Initializes the pivot calculated item + + + + + + Gets or sets the formula for the calculated item. + + + + + Gets the calculated field area. Read-only. + + + + + Represents the cache field + + + + + Represents the collection of calculated pivot field items in pivot table. + + + + + Pivot calculated items + + + + + Add the specified calculated item to pivot calculated items collection. + + item to add to the pivot field. + + + + Represents the setting for the pivot table in the worksheet. + + + + + Represents the setting for the pivot table in the worksheet. + + + + + + Gets or sets a Boolean value indicating whether asterisk must be displayed next to totals. + + + True if an asterisk (*) is displayed next to each subtotal and grand total value in the specified PivotTable report. False otherwise. To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the ShowAsteriskTotals property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets Boolean value to asterisk must be displayed next to totals + pivotOption.ShowAsteriskTotals = true; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the string to be displayed in column header of pivot table in compact layout mode. + + If ColumnHeaderCaption is not assigned, the string "Column Labels" will be set as default. To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the ColumnHeaderCaption property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets the string to be displayed in column header + pivotOption.ColumnHeaderCaption = "City"; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the string to be displayed in Row header of pivot table in compact layout mode. + + If RowHeaderCaption is not assigned, the string "Row Labels" will be set as default. To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the RowHeaderCaption property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets the string to be displayed in Row header + pivotOption.RowHeaderCaption = "Name"; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether the "custom lists" option is offered when sorting this PivotTable. The default value is True. + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the ShowCustomSortList property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets boolean value to indicating whether the custom lists option is offered when sorting this PivotTable + pivotOption.ShowCustomSortList = false; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether the field list must be showed or not. Default value of ShowFieldList is true. + + + False to disable the display of field list for the PivotTable. True otherwise. To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the ShowFieldList property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets boolean value to field list must be showed or not + pivotOption.ShowFieldList = false; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether the data area of the PivotTable is editable. + True to disable the alert for when the user overwrites values in the data area of the PivotTable. False otherwise. + This allows the user to change data values that previously could not be changed. To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the IsDataEditable property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[0].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets the boolean value to the data area of the PivotTable is editable + pivotOption.IsDataEditable = true; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether field properties are enabled or not. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the EnableFieldProperties property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[0].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets the boolean value to field properties are enabled or not. + pivotOption.EnableFieldProperties = true; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the indentation increment for compact axis so as to set the Report Layout to Compact Form. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the Indent property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[0].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets the indentation for compact axis of the Report Layout + pivotOption.Indent = 9; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the string displayed in cells that contain errors when the DisplayErrorString property is True. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to use the ErrorString property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Formula = "=ASIN(C4:C5)"; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets the string displayed in cells that contain errors + pivotOption.ErrorString = "#ERROR#"; + pivotOption.DisplayErrorString = true; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether custom error string in cells that contain errors must be shown or not. + + + Use the ErrorString property to set the custom error string. This property is particularly useful for suppressing divide-by-zero errors when calculated fields are pivoted. To know more about Pivot Tables refer this link. + + + Following code illustrates how to use the DisplayErrorString property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Formula = "=ASIN(C4:C5)"; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + pivotOption.ErrorString = "#ERROR#"; + + //Sets the string displayed in cells that contain errors + pivotOption.DisplayErrorString = true; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether the label must be merged or not. + True if the specified PivotTable report’s outer-row item, + column item, subtotal, and grand total labels use merged cells. False otherwise. To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the MergeLabels property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets boolean value to the label must be merged or not + pivotOption.MergeLabels = true; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the number of page fields in each column or row in the PivotTable report. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the PageFieldWrapCount property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[0].Axis = PivotAxisTypes.Page; + pivotTable.Fields[1].Axis = PivotAxisTypes.Page; + pivotTable.Fields[3].Axis = PivotAxisTypes.Page; + pivotTable.Fields[2].Axis = PivotAxisTypes.Row; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets the number of page fields in each column + pivotOption.PageFieldWrapCount = 2; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the in which page fields are added to the PivotTable report’s layout. + + The default value is . To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the PageFieldsOrder property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets the page field order are added to the PivotTable report’s layout + pivotOption.PageFieldsOrder = PivotPageAreaFieldsOrder.OverThenDown; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether custom string in cells that contain null value must be shown or not. + + Use the NullString property to set the custom null string. The default value is True. To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the DisplayNullString property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets boolean value to cells that contain null value must be shown or not + pivotOption.DisplayNullString = true; + pivotOption.NullString = "null"; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the string displayed in cells that contain null values when the DisplayNullString property is True. + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the NullString property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets the string displayed in cells that contain null values + pivotOption.NullString = "null"; + pivotOption.DisplayNullString = true; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether to preserve the format. The default value is True. + + + True if formatting is preserved when the report is refreshed or recalculated by operations such as pivoting, sorting, or changing page field items. False otherwise. To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the PreserveFormatting property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets the boolean value to preserve the format + pivotOption.PreserveFormatting = true; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether tool-tips should been shown or not.The default value is True. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the ShowTooltips property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets the boolean value to tool-tips should been shown or not + pivotOption.ShowTooltips = false; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether filter buttons and PivotField captions for rows and columns are displayed in the grid or not.The default value is True. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the DisplayFieldCaptions property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets the boolean value to PivotField captions for rows and columns are displayed or not + pivotOption.DisplayFieldCaptions = false; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether to set print titles based on pivot table or not. The default value is false. + + + The row print titles are set to the rows that contain the PivotTable report’s column field items. The column print titles are set to the columns that contain the row items. To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the PrintTitles property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets the boolean value to set print titles based on pivot table or not + pivotOption.PrintTitles = true; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether PivotTable report is saved with the workbook or not. The default value is true. + + For OLAP data sources, this property is always set to False. To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the IsSaveData property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets the boolean value to set PivotTable report is saved with the workbook or not + pivotOption.IsSaveData = false; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the pivot table settings. + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the RowLayout property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[0].Axis = PivotAxisTypes.Row; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets the pivot table PivotTable Row Layout settings + pivotOption.RowLayout = PivotTableRowLayout.Tabular; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether to toggle the display of drill indicators in the PivotTable. + + True if drill indicators are displayed in the PivotTable. False Otherwise. To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the ShowDrillIndicators property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[0].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets the boolean value to display of drill indicators in the PivotTable + pivotOption.ShowDrillIndicators = true; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a value indicating whether the values row is displayed in the pivot table. The default value is False. + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the ShowValuesRow property of the pivot table option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[0].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotTableOptions pivotOption = pivotTable.Options; + + //Sets the boolean value to show values row in the PivotTable + pivotOption.ShowValuesRow=true; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Indent maximum value + + + + + + + + This property specifies the layout setting + + + + + Parent of this settings + + + + + Pivot table extented options + + + + + Pivot Table extented Defintion info + + + + + Specifies a boolean value that indicates whether an asterisks should be displayed in + subtotals and totals + + + + + Specifies the string to be displayed in column header in compact mode + + + + + Specifies the string to be displayed in Row header in compact mode + + + + + Specifies a boolean value that indicates whether new fields should have their compact + flag set to true. + + + + + Specifies a boolean value that indicates whether the field next to the data field in the + PivotTable should be displayed in the same column of the spreadsheet + + + + + Specifies the version of the application that created the cache + + + + + Specifies the version of the application that updated the cache + + + + + Specifies the mini version of the application that updated the cache + + + + + Specifies a boolean value that indicates whether the "custom lists" option is offered + when sorting this PivotTable + + + + + Specifies the name of the value area field header in the PivotTable. This caption is shown + when the PivotTable when two or more fields are in the values area. + + + + + Specifies a boolean value that indicates whether the user is allowed to edit the cells in + the data area of the PivotTable. + + + + + Specifies a boolean value that indicates whether fields in the PivotTable are sorted in + non-default order in the field list. + + + + + Specifies a boolean value that indicates whether the user is prevented from displaying + PivotField properties. + + + + + indicates whether fields in the PivotTable are sorted in + non-default order in the field list. + + + + + Specifies a boolean value that indicates whether calculated members should be shown in + the PivotTable view. + + + + + Specifies the indentation increment for compact axis and can be used to set the Report + Layout to Compact Form. + + + + + Specifies a boolean value that indicates whether new fields should have their outline + flag set to true. + + + + + Specifies a boolean value that indicates whether data fields in the PivotTable should be + displayed in outline form. + + + + + Specifies a boolean value that indicates whether the fields of a PivotTable can have + multiple filters set on them. + + + + + Specifies a boolean value that indicates whether the in-grid drop zones should be + displayed at runtime, and whether classic layout is applied. + + + + + Returns or sets the order in which page fields + are added to the PivotTable report’s layout + + + + + True if formatting is preserved when the report is refreshed or recalculated by + operations such as pivoting, sorting, or changing page field items. + + + + + True, if tooltips displayed for the pivot table cell. + + + + + Indicates whether drills are shown. + + + + + Controls whether or not filter buttons and PivotField captions for rows + and columns are displayed in the grid. + + + + + True if the print titles for the worksheet are set based on the PivotTable report. + False if the print titles for the worksheet are used. + + + + + Specifies the string to be displayed for grand totals. + + + + + Specifies a boolean value that indicates whether the values Row in pivottable shown or not + + + + + Indicates whether values row added or not + + + + + Initializes pivot table options + + + + + + + + Set repeat labels to all the pivot fields. + + Value to set to the repeat all item labels in all pivot fields. + + + + True if legacy table autoformat alignment properties are applied. False otherwise. Read/Wrire Boolean. + + + + + Gets or sets a value indicating whether the values row is added in the pivot table layout. The default value is False. + + + + + True to apply legacy table autoformat border properties. False otherwise. Read/Write Boolean. + + + + + True to apply legacy table autoformat number format properties. False otherwise. Read/Write Boolean. + + + + + True to apply legacy table autoformat pattern properties. False otherwise. Read/Write Boolean. + + + + + Gets or sets a Boolean value indicating if width/height autoformat is applied. False otherwise. Read/Write Boolean. + + + + + True if legacy table autoformat is applied to the pivot table. False otherwise. Read/Write Boolean. + + + + + True to apply legacy table autoformat font properties. False otherwise. Read/Write Boolean. + + + + + Gets or sets a value indicating whether the values row is displayed in the pivot table. The default value is False. + + + + + Gets or sets a Boolean value indicating whether asterisk must be displayed next to totals. + + + True if an asterisk (*) is displayed next to each subtotal and grand total + value in the specified PivotTable report. False otherwise. + + + + Gets or sets the string to be displayed in column header of pivot table in compact layout mode. + + If ColumnHeaderCaption is not assigned, the string "Column Labels" will be set as default + + Following code illustrates how to access the ShowFieldList property of the pivot table option. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + // Create Pivot cache with the given data range + IPivotCache cache = workbook.PivotCaches.Add(worksheet["A1:H50"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + IPivotTableOptions options = pivotTable.Options; + // Enable header captions + options.ColumnHeaderCaption = "Units"; + + + + + + Gets or sets the string to be displayed in Row header of pivot table in compact layout mode. + + If RowHeaderCaption is not assigned, the string "Row Labels" will be set as default + + Following code illustrates how to access the ShowFieldList property of the pivot table option. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + // Create Pivot cache with the given data range + IPivotCache cache = workbook.PivotCaches.Add(worksheet["A1:H50"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + IPivotTableOptions options = pivotTable.Options; + // Enable header captions + options.RowHeaderCaption = "Date"; + + + + + + Gets or sets the pivot table row layout settings. + + + + + Gets or sets the application version that created the cache. + + + + + Gets or sets the application version that updated the cache. + + + + + Gets or sets the minimum version of the application that updated the cache. + + + + + Gets or sets a Boolean value indicating whether the "custom lists" option is offered + when sorting this PivotTable. The default value is True. + + + + + Gets or sets the name of the value area field header in the PivotTable. + + + + + Gets or sets the position for the field representing multiple data field in the PivotTable, + whether that field is located in the row area or column area. + + + + + Gets or sets a Boolean value indicating whether the field list must be showed or not. + + False to disable the display of field list for the PivotTable. True otherwise. + + + Following code illustrates how to access the ShowFieldList property of the pivot table option. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + // Create Pivot cache with the given data range + IPivotCache cache = workbook.PivotCaches.Add(worksheet["A1:H50"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + IPivotTableOptions options = pivotTable.Options; + options.ShowFieldList = true; + + + + + + Gets or sets a Boolean value indicating whether the data area of the PivotTable is editable. + True to disable the alert for when the user overwrites values in the data area of the PivotTable. False otherwise. + This allows the user to change data values that previously could not be changed. + + + + + Gets or sets a Boolean value indicating whether field properties are enabled or not. + + + + + Gets or sets a Boolean value indicating whether fields in the PivotTable are sorted in + default order in the field list. + + + + + Gets or sets a Boolean value indicating whether to show calculated members in + the PivotTable view. + + + + + Gets or sets the indentation increment for compact axis so as to set the Report + Layout to Compact Form. + + + + + Gets or sets a Boolean value that indicates whether new fields should have their outline + flag set to true. + + + + + Gets or sets a Boolean value that indicates whether data fields in the PivotTable should be + displayed in outline form. + + + + + Gets or sets a Boolean value that indicates whether the fields of a PivotTable can have + multiple filters set on them. + + + + + Gets or sets a Boolean value that indicates whether the in-grid drop zones should be + displayed at runtime, and whether classic layout is applied. + + + + + Gets or sets the string displayed in cells that contain errors + when the DisplayErrorString property is True. + + + + + Gets or sets a Boolean value indicating whether custom error string in cells + that contain errors must be shown or not. + + + Use the ErrorString property to set the custom error string. + This property is particularly useful for suppressing divide-by-zero errors when calculated fields are pivoted. + + + + + Gets or sets a Boolean value indicating whether custom string in cells + that contain null value must be shown or not. + + Use the NullString property to set the custom null string. The default value is True. + + + + Gets or sets a Boolean value indicating whether the label must be merged or not. + True if the specified PivotTable report’s outer-row item, + column item, subtotal, and grand total labels use merged cells. False otherwise . + + + + + Gets or sets the number of page fields in each column + or row in the PivotTable report. + + + + + Gets or sets the order in which page fields + are added to the PivotTable report’s layout. The default value is + + + + + Gets or sets the string displayed in cells that contain null + values when the DisplayNullString property is True. + + + + + Gets or sets a Boolean value indicating whether to preserve the format. The default value is True. + + + True if formatting is preserved when the report is refreshed or recalculated by operations such as pivoting, sorting, or changing page field items. False otherwise. + + + + + Gets or sets a Boolean value indicating whether tool-tips should been shown or not.The default value is True. + + + + + Gets or sets a Boolean value indicating whether to toggle the display of drill indicators in the PivotTable. + + True if drill indicators are displayed in the PivotTable. False Otherwise. + + + + Gets or sets a Boolean value indicating whether filter buttons and PivotField + captions for rows and columns are displayed in the grid or not.The default value is True. + + + + + True if the print titles for the worksheet are set based on the PivotTable report. + False if the print titles for the worksheet are used. Read/Write Boolean. + + + The row print titles are set to the rows that contain the PivotTable report’s column field items. + The column print titles are set to the columns that contain the row items. + + + + + Gets or sets a Boolean value indicating whether PivotTable report is saved with the workbook or not. + + For OLAP data sources, this property is always set to False. + + + + Return the maximum indent value + + + + + Gets or sets the string to be displayed for grand totals. + + + + + Class wich reads Rich Text. + + + + + Specifies the group start character. + + + + + Specifies the group end character. + + + + + Specifies the control start character. + + + + + Specifies the space character. + + + + + Specifies the carriege return character. + + + + + Specifies the new line character. + + + + + Specifies the semiColon character. + + + + + Carriage return followed by line feed character: "\x000d\x000a" or "\r\n". + Commonly used in text files for + paragraph breaks. + + + + + Tab string: "\x0009" or "\t". + + + + + Microsoft Windows code page + + + + + Specifies the non breaking hyphen character + + + + + Specifies the soft hyphen character + + + + + Specifies the non breaking space character + + + + + Represents the Rtf Text. + + + + + Represents the WorksheetImpl. + + + + + Represents the Range to store the RTF Text. + + + + + Represents the RichTextString class Object. + + + + + Represents the Application. + + + + + Represents the workbook. + + + + + Represents the RtfLexer class object. + + + + + Represents the RtfReader class object. + + + + + Represents the current token. + + + + + Represents the previous token. + + + + + Represents the previous token key. + + + + + Represents the previous token value. + + + + + Represents the previous control string. + + + + + Represents the font name. + + + + + Represents the current table type. + + + + + Represents the font table. + + + + + Represents the color table. + + + + + Represents the stack. + + + + + Represents the picture stack. + + + + + Represents the destination stack. + + + + + Represents the header footer stack. + + + + + Represents the current rtf font. + + + + + Represents the base rtf font. + + + + + Represents the current rtf font number. + + + + + Represents the current rtf font charset. + + + + + Represents the current rtf font ID. + + + + + Represents the current token type. + + + + + Represents the previous token type. + + + + + Represents the color table. + + + + + Represents the bold. + + + + + Represents the italic. + + + + + Represents the underline. + + + + + Represents the strikethrough. + + + + + Represents the subscript. + + + + + Represents the superscript + + + + + Represents the empty paragraph count. + + + + + Indicates whether current token is picture. + + + + + Indicates whether current token is documentation information. + + + + + Indicates whether current token is shape picture. + + + + + Indicates whether current token is List text. + + + + + Indicates whether current token is bookmark start. + + + + + Indicates whether current token is bookmark end. + + + + + Indicates whether current token is header. + + + + + Indicates whether current token is footer. + + + + + Indicates whether current token is custom properties. + + + + + Represents the current style ID. + + + + + Represents the tab collection. + + + + + Represents the tab count. + + + + + Represents the accent character. + + + + + Represents the background collection stack. + + + + + Represents the background collection. + + + + + Represents the current style name. + + + + + Represents the list level stack. + + + + + Indicates whether token is list level. + + + + + Represents the unicode count stack. + + + + + Represents the unicode count. + + + + + Represents the current color index. + + + + + Represents the tab format stack. + + + + + Represents the rtf colloection stack. + + + + + Represents the shape instruction stack. + + + + + Indicates whether token is shape instruction. + + + + + Represents the object stack. + + + + + Indicates whether token is object. + + + + + Represents the drawing field name. + + + + + Represents the drawing field value. + + + + + Represents the field result group stack. + + + + + Represents the field instruction group stack. + + + + + Represents the field group stack. + + + + + Represents the form field data stack. + + + + + Represents the current field group data. + + + + + Represents the default code page. + + + + + Indicates whether token is wrap polygon. + + + + + Indicates whether token is comment range start. + + + + + Indicates whether token is comment reference. + + + + + Represents the comment group collection. + + + + + Represents the token . + + + + + Represents the group. + + + + + Represents the group order. + + + + + Initializes the RichTextReader for the worksheet + + + + + + Parse each token from the rtf + + + + + Check whether this current group contains pn list related tokens + retrun the bool value + + current object of group class + + + + + Closes this instance. + + + + + Add font to the font table collection + + + + + Add color to the color table + + + + + Parse Control start + + + + + Seperate the annotaion sting from token. + + + + + + + Gets whether the group is a nested group + + + + + + Parse group start + + + + + Parse Group End + + + + + Remove Delimiter space from the document text + + + + + + + Parse document element + + + + + Parse control word from the rtf file + + + + + + Skip the group. + + + + + Parse font table + + + + + + + + Parse color table + + + + + + + + Parse Formatting controls + + + + + + + + Parse special characters + + + + + + Check whether the accent character need to be omitted + + + + + + Parses Accented character + + + + + + + + Get the code page for the current Font character set + + + + + + Determines whether current code page is single byte encoding. + + + true if [is single byte]; otherwise, false. + + + + + Get Font Character Set + + + + + + Determine Whether the code page is supported for Encoding + + + + + + + Get the code page is supported for Encoding + + + + + + + Sort Tab Collection based on Tab position + + + + + Seperate Token keyword from the token Value + + + + + + + Apply font color for the current text + + + + + + Sets the parsed element flag. + + The token. + + + + Parses this instance. + + + + + Appends RTF string + + RTF string + + + + Sets the RTF. + + The row. + The column. + The text. + + + + Sets the RTF. + + The text. + + + + Uppdate the RTF Text. + + + + + Creates rich text string. + + + + + Checks whether the control word is destination control word + + + + + Gets whether the group is form field group + + + + + Gets whether the group is field group + + + + + Get's or set's the Default code page of the document + + + + + Represents the group for RTF string. + + + + + Represents the child elments collection. + + + + + Get Groups's object from the childElements collection + Set Groups's object into collection + + + + + Represents token for RTF string. + + + + + Represents value of token + + + + + Gets/Sets the value of token + + + + + Represents the Tab format for RTF string. + + + + + Represents tab position + + + + + Gets and Sets the tab position + + + + + Represents the RTF color. + + + + + Represents Red component value of RGB color + + + + + Represents Green component value of RGB color + + + + + Represents Blue component value of RGB color + + + + + Gets and Sets the Red component value + + + + + Gets and Sets the green component value + + + + + Gets and Sets the blue component value + + + + + Specifies the group start character. + + + + + Represents the Rtf Data. + + + + + Represents the system encoding. + + + + + Represents the current position in data buffer. + + + + + Represents the data buffer length. + + + + + Read a single character + + + + + + Reads the image bytes from the stream + + + + + + Closes this instance. + + + + + Gets the encoding. + + + + + Gets and Sets the current position in data buffer. + + + + + Gets and Sets the data buffer length. + + + + + Specifies the group start character. + + + + + Specifies the group end character. + + + + + Specifies the control start character. + + + + + Specifies the space character. + + + + + Specifies the white space character. + + + + + Specifies the new line character. + + + + + Specifies the semicolon character. + + + + + Specifies the double quotation character. + + + + + Specifies the back quotation character. + + + + + Specifies the open parenthesis character. + + + + + Specifies the close parenthesis character. + + + + + Specifies the ambersion character. + + + + + Specifies the percentage character. + + + + + Specifies the dollar sign character. + + + + + Specifies the hash character. + + + + + Specifies the At symbol character. + + + + + Specifies the Exclamation character. + + + + + Specifies the plus character. + + + + + Specifies the caret character. + + + + + Specifies the open bracket character. + + + + + Specifies the close bracket character. + + + + + Specifies the forward slash character. + + + + + Specifies the question mark character. + + + + + Specifies the greater than character. + + + + + Specifies the lesser than character. + + + + + Specifies the comma character. + + + + + Specifies the vertical bar character. + + + + + Specifies the colon character. + + + + + Represents Rtf table type. + + + + + Represents Rtf reader. + + + + + Represents Rtf token. + + + + + Represents Rtf previous character. + + + + + Represents the imagebytes. + + + + + Represents the read new character. + + + + + Represents the rtf token type. + + + + + Represents the new character. + + + + + Represents the comment start range. + + + + + Represents the comment count. + + + + + Represents the previous token. + + + + + Represents the comment start range token key. + + + + + Represents the comment tag mark. + + + + + Represents the delimeters. + + + + + Reads the Next token from the stream + + + + + + Reads control word + + + + + + Generates commnet information + + + + + + Reads Document element + + + + + + + Closes this instance. + + + + + Gets and Sets the imagebytes + + + + + Gets and Sets CommentRange start id + + + + + Gets/Sets Rtf table type + + + + + Gets/Sets Rtf token type + + + + + This class contains constants used for Encryption Info parsing/serialization + in Excel 2010 SpreadsheetML format. + + + + + Represents the Salt Size attribute. + + + + + Represents the Salt Size attribute. + + + + + Represents the Block Size attribute. + + + + + Represents the KeyBits attribute. + + + + + Represents the HashSize attribute. + + + + + Represents the CipherAlgorithm attribute. + + + + + Represents the cipher Chaining used to encrypt the data is AES. + + + + + Represents the hashing algorithm used in the Encryption. + + + + + Represents the encrypted copy of the randomly generated value used when generating the encryption key. + + + + + Represents the encrypted copy of the hash value that is generated during the creation of the encryption key. + + + + + Represents the iterations count on the hash of the password. + + + + + Represents the password verification Hash input. + + + + + Represents the password verifcation hash value. + + + + + Represents the Intermediate key used to Encrypt and Decrypt the data. + + + + + Represents the Encryption tags namespace. + + + + + Represents the password encryption attribute tags namespace. + + + + + Represents the attributes used to encrypt and decrypt the data. + + + + + Represents the cryptographic attributes used to encrypt the data. + + + + + Represents the Data Integrity attributes used to help ensure + that the integrity of the encrypted data. + + + + + Represents the attributes used to generate the encrypting key. + + + + + Represents the attributes used to generate the encrypting keys. + + + + + Represents the attributes used to generate the encrypting key. + + + + + Represents the Prefix p. + + + + + Represents the Xmlns attribute + + + + + Represents the Uir attribute. + + + + + Represents the cryptographic attributes used to encrypt the data. + + + + + Represents a randomly generated Salt Value size. + + + + + Represents the block size used to encrypt each block of data. + + + + + Represents the Key size. + + + + + Represents the Compute Hash Size. + + + + + Represents the cipher algorithm used to encrypt the data + + + + + Represents the chaining mode to encrypt the data. + + + + + Represents that the hashing algorithm used to hash the data. + + + + + Represents a randomly generated value used when generating the encryption key + + + + + Parses the cryptographic attributes used to encrypt the data. + + XmlReader to read from. + + + + Serializes the cryptographic attributes used to encrypt the data. + + Writer to writes into. + + + + Represents a randomly generated value used when generating the encryption key + + + + + Represents the Data Integrity attributes used to help ensure + that the integrity of the encrypted data. + + + + + Represents the encrypted copy of the randomly generated value used when generating the encryption key. + + + + + Represents the encrypted copy of the hash value that is generated during the creation of the encryption key. + + + + + Parse Data Integrity attributes. + + XmlReader to Read from. + + + + Serializes the Data Integrity attributes. + + Writer to writes into. + + + + Represents the encrypted copy of the randomly generated value used when generating the encryption key. + + + + + Represents the encrypted copy of the hash value that is generated during the creation of the encryption key. + + + + + Represents the attributes used to generate the encrypting key. + + + + + Default Spin Count to iterations on the hash of the password. + + + + + Represents the Default hash size in bytes. + + + + + Represents the Default cipher used to encrypt the data is AES. + + + + + Represents the Default chaining mode used for encrypting. + + + + + Represents the Default hashing algorithm used in the Encryption. + + + + + Represents the default key length in bits. + + + + + Represents the SHA512 hashing algorithm used in the Encryption + + + + + Represents the iterations count on the hash of the password. + + + + + Represents a randomly generated Salt Value size. + + + + + Represents the block size used to encrypt each block of data. + + + + + Represents the Key size. + + + + + Represents the Compute Hash Size. + + + + + Represents the cipher algorithm used to encrypt the data + + + + + Represents the chaining mode to encrypt the data. + + + + + Represents that the hashing algorithm used to hash the data. + + + + + Represents a randomly generated value used when generating the encryption key + + + + + Represents the password verification Hash input. + + + + + Represents the password verifcation hash value. + + + + + Represents the Intermediate key used to Encrypt and Decrypt the data. + + + + + Parses the attributes which is used to generate the encrypting key. + + Xml Reader to read from. + + + + Serializes the attributes which used to generate the encrypting key. + + Xml Writer to write into. + + + + Represents the Compute Hash Size. + + + + + Represents the iterations count on the hash of the password. + + + + + Represents the block size used to encrypt each block of data. + + + + + Represents the Key size. + + + + + Represents a randomly generated value used when generating the encryption key + + + + + Represents the password verifcation hash value. + + + + + Represents the password verification Hash input. + + + + + Represents the Intermediate key used to Encrypt and Decrypt the data. + + + + + Represents the Hash Algorithm used to Encrypt and Decrypt the data. + + + + + This class used to decrypt data using Excel 2010 encryption with AES 128 + encryption algorithm with CBC Mode and SHA-1 hashing algorithm. + + + + + This class is responsible for decryption of Excel 2007 files. + + + + + Size of the decryption block. + + + + + Dataspace map. + + + + + Encryption info. + + + + + Compound storage that should be decrypted. + + + + + Array containing key data. + + + + + Decrypts internal storage storage. + + Decrypted stream. + + + + Prepares decryptor for actual decryption. + + Compound storage to get required data from. + + + + Checks whether storage contains encrypted data. + + Storage to check. + True if storage is encrypted. + + + + Checks whether password is correct. + + Password to check. + True if password verification succeeded. + + + + Verifies password. + + Password to check. + Verifier object. + Encryption key. + + + + Decrypts specified buffer. + + + + + + + + Extracts transform data from the storage. + + Storage to get data from. + + + + Extracts dataspace map from the storage. + + Storage to get data from. + + + + Extracts TransformInfo from the storage. + + Storage to get data from. + + + + Compound storage that should be decrypted. + + + + + Decrypts internal storage storage. + + Decrypted stream. + + + + Checks whether password is correct. + + Password to check. + True if password verification succeeded. + + + + Verifies password. + + Password to check. + Verifier object. + Encryption key. + + + + Get the Encryption/Decryption Key from the encrypted data. + + Encrypted key in byte array. + Password in byte array. + Salt Value in byte array. + The number of times to iterate the password hash when creating the key. + Represent the size of the key. + Key to encrypt and decrypt the Encrypted Package. + + + + Get the password verifier hash. + + Encrypted the verifier hash. + Password in byte array. + Salt Value in byte array. + The number of times to iterate the password hash when creating the key + Represent the size of the key. + Decrypted Verifier hash. + + + + Get the password verifier hash value. + + Encrypted the verifier hash. + Password in byte array. + Salt Value in byte array. + The number of times to iterate the password hash when creating the key + Represent the size of the key. + Decrypted Verifier hash value. + + + + Get the Data Integrity verifier HmacKey. + + Encrypted Hmac Key. + Key to Decrypt the Hmac key. + Salt Value in byte array. + Represents the hash size to compute. + Hmac Key. + + + + Get the Data Integiryt verifier HMac Value. + + Encrypted Hmac Value. + Key to Decrypt the Hmac key. + Salt Value in byte array. + Hmac Value. + + + + Ensures the Data Integrity of the Encrypted Package. + + Encrypted data. + Key to Decrypt the Hmac key. + Salt Value in byte array. + Hmac Key to Compute Hmac hash. + Hmac Value to Compare. + Hash Algorithm to hash the value + True, if the data is in original structure. + + + + This class used to encrypt data using Excel 2010 encryption with AES 128 + encryption algorithm with CBC Mode and SHA-1 hashing algorithm. + + + + + This class used to encrypt data using Excel 2007 encryption with AES 128 + encryption algorithm and SHA-1 hashing algorithm. + + + + + Key length. + + + + + Default version. + + + + + Default flags. + + + + + Encryption algorithm id (AES-128). + + + + + Hashing algorithm id (SHA-1). + + + + + Provider type. + + + + + Default CSP name. + + + + + Encrypts specified stream. + + Data to encrypt. + Password to use. + Root storage to put encrypted data into. + + + + Preparse data spaces structures inside specified storage. + + Storage to put DataSpaces inside. + + + + Serializes VersionInfo stream inside specified storage. + + Storage to serialize VersionInfo into. + + + + Serializes transformation info. + + Storage to serialize into. + + + + Serializes dataspace info. + + Storage to serialize into. + + + + Serializes DataSpaceMap stream. + + Storage to place stream into. + + + + Fills in EncryptionInfor record and stores it at appropriate stream. + + Root storage. + Encryption password. + Encryption key. + + + + Creates random salt. + + Desired salt length. + Array with random data. + + + + Encrypts specified buffer. + + Data to encrypt. + Encryption key. + Encrypted data. + + + + Encrypt specified stream. + + Stream to encrypt. + Encryption key. + Output stream. + + + + Default Segment Size to encrypt. + + + + + Excel 2010 Version identifier. + + + + + Version Flag. + + + + + Key to Encrypt the data. + + + + + Encrypts specified stream. + + Data to encrypt. + Password to use. + Root storage to put encrypted data into. + + + + Encrypt the Stream with the given Key. + + Stream data to encrypt. + Key to encrypt data. + Salt value in byte array. + + + + + Preparse data spaces structures inside specified storage. + + Storage to put DataSpaces inside. + + + + Creates the Key with the given password. + + Password in byte array. + Salt Value in byte array. + Iteration count to generate the key. + Intermediate Key to encrypt the data. + + + + Creates the Data Integrity Verifier Hash Input. + + Random values in byte array. + Password in byte array. + SaltValue in byte array. + Iteration count to generate the key. + DataIntegrity verifier hash input. + + + + Creates the Data Integrity Verifier Hash Value. + + Random values in byte array. + Password in byte array. + SaltValue in byte array. + Iteration count to generate the key. + DataIntegrity verifier hash Value. + + + + Creates the Key to Encrypt the data. + + Password in byte array. + Salt Value in byte array. + Block Key to Generate vector. + The number of times to iterate the password hash when creating the key. + + + + + + Fills in EncryptionInfo record and stores it at appropriate stream. + + Root storage. + Encryption password. + Encryption key. + + + + Fills in Data Integrity info record and stores it at appropriate stream. + + Encypted Package. + Key to Encrypt the Hmac Input and Value. + Salt value in byte array. + Represents the SHA1 hash size. + Represents the EncyptionInfo. + + + + This class contains utility methods used by Excel 2010 security implementation. + + + + + Represents the SHA1 Hash Algorithm. + + + + + Represents the SHA256 Hash Algorithm. + + + + + Represents the SH512 Hash Algorithm. + + + + + Encrypt the Data in AES-128 algorithm with CBC mode. + + Plain data to encrypt. + Key to Encrypt the data. + Vector to encrypt the data. + The number of bytes used to encrypt one block of data + + + + + Decrypt the data in AES-128 algorithm with CBC mode. + + + + + + + + + + + Creates the Key to Decrypt and Encrypt the Data. + + password in byte array. + Salt Value in bytes. + Block Key in bytes. + Loop count to compute Hash. + Creates the key with the size. + Hash Algorithm used. + + + + + Generate Vecotor with the block key with integer. + + Salt Value in byte array. + unsinged integer as block Key. + Hash Algorithm used. + Vector in byte array. + + + + Generates the Vector. + + Salt value in byte array. + Block key value in byte array. + Hash Algorithm used. + Vector in byte array. + + + + Compute SHA Hash according to the algorithm used. + + Input to compute hash. + Hash Algorithm used. + + + + + XOR the two byte array. + + First byte. + Second byte. + + + + + Tries to pad or Truncate the given byte array. + + Byte array to pad or Truncate based on the length. + Represents the limit of the array. + Value to pad upto the length. + + + + + Gets HashAlgorithm from the Algorithm name + + Algorithm used + + + + + Verify the Worksheet and Workbook proctected Password + + password as string + name of the algorithm + Salt value + Hash Value + number of spin count + + + + + This class used to Sort the Range. + + + + + Represents the sort of range. + + + + + Sorts the range based on the sort fields. + + + To sort the s in the collection sort method is used. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C7"].CellStyleName = "CurrencyFormat"; + + //Create sorter + IDataSort sorter = workbook.CreateDataSorter(); + + //Set sort range + sorter.SortRange = worksheet["A1:C7"]; + + //Add sortfield + ISortField sortField = sorter.SortFields.Add(1, SortOn.Values, OrderBy.Ascending); + + //Perform sort + sorter.Sort(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Datasort.xlsx"); + workbook.Close(); + } + + + + + + Indicates whether to perform case sensitive sort. + + + By default, the sorter is case insensitive. If similar texts with different casing are to be sorted then the sorter treats both the texts + same. But if we set IsCaseSensitive property to "true" then it sorts and arranges texts in lower case to upper case order. Here for example, + we set same texts twice with first letters vary in casing, then set IsCaseSensitive to "true" and sort. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Fruits"; + worksheet["A2"].Text = "banana"; + worksheet["A3"].Text = "Cherry"; + worksheet["A4"].Text = "Banana"; + worksheet["A5"].Text = "Apple"; + worksheet["A6"].Text = "cherry"; + worksheet["A7"].Text = "apple"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create sorter + IDataSort sorter = workbook.CreateDataSorter(); + + //Set Range + sorter.SortRange = worksheet["A1:C7"]; + + //Add sortfield + ISortField sortField = sorter.SortFields.Add(0, SortOn.Values, OrderBy.Ascending); + + //Set case sensitive + sorter.IsCaseSensitive = true; + + //Perform sort + sorter.Sort(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Datasort.xlsx"); + workbook.Close(); + } + + + + + + Indicates whether the range has header. + + + If HasHeader property is set to "true", then the first row within the sorter range is ignored and the same will be treated as column name. By default HasHeader is + set to "true". Here for example, we set HasHeader property to "false". So the sorter sorts all the rows within the given range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A2"].Text = "banana"; + worksheet["A3"].Text = "Cherry"; + worksheet["A4"].Text = "Banana"; + worksheet["A5"].Text = "Apple"; + worksheet["A6"].Text = "cherry"; + worksheet["A7"].Text = "apple"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create sorter + IDataSort sorter = workbook.CreateDataSorter(); + + //Set Range + sorter.SortRange = worksheet["A2:C7"]; + + //Add sortfield + ISortField sortField = sorter.SortFields.Add(0, SortOn.Values, OrderBy.Ascending); + + //Set case sensitive + sorter.HasHeader = false; + + //Perform sort + sorter.Sort(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Datasort.xlsx"); + workbook.Close(); + } + + + + + + Represents the sort orientation. + + + In some cases data in worksheet may be given in left to right format instead of top to bottom. For this case sorter can be used to sort by + setting Orientation to . By default it is . Here for example, + we load data in rows instead of columns and use the sorter to sort the data. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["B1"].Text = "Alfreds Futterkiste"; + worksheet["C1"].Text = "Antonio Moreno Taqueria"; + worksheet["D1"].Text = "Around the Horn"; + worksheet["E1"].Text = "Bon app"; + worksheet["F1"].Text = "Eastern Connection"; + worksheet["G1"].Text = "Ernst Handel"; + worksheet["A2"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["C2"].Number = 5079.6; + worksheet["D2"].Number = 1267.5; + worksheet["E2"].Number = 1418; + worksheet["F2"].Number = 4728; + worksheet["G2"].Number = 943.89; + worksheet["A3"].Text = "Qtr2"; + worksheet["B3"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["D3"].Number = 1062.5; + worksheet["E3"].Number = 756; + worksheet["F3"].Number = 4547.92; + worksheet["G3"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create sorter + IDataSort sorter = workbook.CreateDataSorter(); + + //Set Range + sorter.SortRange = worksheet["A1:G3"]; + + //Add sortfield + ISortField sortField = sorter.SortFields.Add(1, SortOn.Values, OrderBy.Ascending); + + //Set orientation + sorter.Orientation = SortOrientation.LeftToRight; + + //Perform sort + sorter.Sort(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Datasort.xlsx"); + workbook.Close(); + } + + + + + + Represents the Collection. + + + is used to add, remove and get from collection. Here for example, we add + to collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C7"].CellStyleName = "CurrencyFormat"; + + //Create sorter + IDataSort sorter = workbook.CreateDataSorter(); + + //Set sort range + sorter.SortRange = worksheet["A1:C7"]; + + //Add sortfield + ISortField sortField = sorter.SortFields.Add(1, SortOn.Values, OrderBy.Ascending); + + //Perform sort + sorter.Sort(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Datasort.xlsx"); + workbook.Close(); + } + + + + + + Represents the sort range. + + + The following code illustrates how to set range for sorter. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C7"].CellStyleName = "CurrencyFormat"; + + //Create sorter + IDataSort sorter = workbook.CreateDataSorter(); + + //Set sort range + sorter.SortRange = worksheet["A1:C7"]; + + //Add sortfield + ISortField sortField = sorter.SortFields.Add(1, SortOn.Values, OrderBy.Ascending); + + //Perform sort + sorter.Sort(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Datasort.xlsx"); + workbook.Close(); + } + + + + + + Represents the algorithm to sort. + + + By default the alogrithm to perform sorting is . Here for example, we set + to Algorithm property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create sorter + IDataSort sorter = workbook.CreateDataSorter(); + + //Set Range + sorter.SortRange = worksheet["A1:C7"]; + + //Add sortfield + ISortField sortField = sorter.SortFields.Add(1, SortOn.Values, OrderBy.Ascending); + + //Set algorithm + sorter.Algorithm = SortingAlgorithms.MergeSort; + + //Perform sort + sorter.Sort(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Datasort.xlsx"); + workbook.Close(); + } + + + + + + Indicates whether to perform case sensitive sort. + + + + + Indicates whether the range has header. + + + + + Represents the sort orientation. + + + + + Represents the SortFields Collection. + + + + + Represents the sort range. + + + + + Represents the algorithm to sort. + + + + + Represents the parent object workbook. + + + + + Represents the parent object worksheet. + + + + + Represents the instance of the ISortingAlorithm type. + + + + + Represents the parent object. + + + + + Initialization. + + Represents the parent object. + + + + Sorts the range based on the sort fields. + + + + + Sorts the range with the given parameter. + + Column indexes to sort. + Represents the sort order. + Colors to sort by. + + + + Arranges the similar object based on the reference index. + + sorted data + + + + Gets the data from the range to sort. + + Range to sort. + Represents the column Data Type + Columns index to sort. + Data in object array to sort. + + + + Returns appopriate value for the range with empty values + + Value of the range + Sorting order + + + + + Gets the data from the range to sort in column wise. + + Range to sort. + Represents the row datatypes. + Row indexes to sort. + data in object array to sort. + + + + Gets the value based on the column type. + + Cell range to get the value. + Type of the column. + value based on the column type. + + + + Swaps the Range based on the List. + + Range to sort. + Represents the sorted data. + + + + Swaps the Range based on the List. + + Range to sort. + Represents the sorted data. + + + + Swaps the Range based on the List. + + Range to sort. + Represents the sorted data. + Start row to swap the range data. + + + + Swaps the Range based on the List. + + Range to sort. + Represents the sorted data. + Start row to swap the range data. + + + + Gets the cell type. + + Range to get the cell type. + Type of the cell. + + + + Updates the Sort Range for DataSorter + + Range to filter. + + + + Represents the instance of the ISortingAlorithm type. + + + + + Indicates whether to perform case sensitive sort. + + + + + Indicates whether the range has header. + + + + + Represents the sort orientation. + + + + + Represents the SortFields Collection. + + + + + Represents the sort range. + + + + + Represents the algorithm to sort. + + + + + Represents the worksheet of DataSorter. + + + + + This class used to sort the Data using the HeapSort algorithm. + + + + + Parent of the sorting classes. + + + + + Represents the Algorithm to be perform sorting. + + + + + Sorts the integer type data with the specified column index. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the Float values with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the Date type values with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the string type values with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the based on the types with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the Integer type values in Descending order with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the Float type values in Descending order with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the Datea type values in Descending order with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the string type values in Descending order with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Range object to sort. + + + + + Data to sort. + + + + + + Represents the Column/Row Types. + + + + + Represents the sorting order of each column/Row. + + + + + Represents the current top position of Row/column with color. + + + + + Represents the current bottom position of the Row/Column with color. + + + + + Represents the colors to find. + + + + + Intialiazes the sorting algorithm atributes. + + Data to sort. + Type of the each column. + Sorting order of each column. + Colors to find. + + + + Sorts the data with the specified column index. + + Left index of the data. + Right index of the data to sort. + column index of the data. + + + + Extracts the single row from the Data. + + Index of the row to extract. + Row value in object array. + + + + Extracts the single colum form the data. + + Row index to extract. + Column values in object array. + + + + Swaps the row. + + first row index. + second row index. + + + + Swpas the array content. + + Left array content. + Right array content. + + + + Swaps the column content. + + First column Index. + Second column index. + + + + Swaps the column content. + + Left array content. + Right array content. + + + + Sorts the integer type data with the specified column index. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the Float values with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the Date type values with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the string type values with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the based on the types with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the Integer type values in Descending order with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the Float type values in Descending order with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the Datea type values in Descending order with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the string type values in Descending order with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Represents the sortable data. + + + + + Range object to sort. + + + + + Initializes the Heap sorting attributes. + + Data to sort. + Represents the type of the column. + Sorting order of the column. + Colors to sort. + + + + Sorts the data using HeapSort Algorithm. + + Start index of the data. + End index of the data. + + + + Sorts the data based on the types. + + left index of the data. + Right data of the index. + column Index to sort. + + + + Creates the heap tree to sort. + + Represents the posiont of the heap. + length the data. + Sots based on this column. + + + + Sorts integer value using HeapSort. + + Represents the root element in the heap. + Represents the length of the heap. + Represents the column index of the data to sort. + + + + Creates the heap tree to sort. + + Represents the posiont of the heap. + length the data. + Sots based on this column. + + + + Sorts float value using HeapSort. + + Represents the root element in the heap. + Represents the length of the heap. + Represents the column index of the data to sort. + + + + Creates the Date Heap. + + Represents the posiont of the heap. + Represents the length of the heap. + Represents the column index of the data to sort. + + + + Sorts the Date type value. + + Represents the root element in the heap. + Represents the length of the heap. + Represents the column index of the data to sort. + + + + Creates the Heap with the string. + + Represents the posiont of the heap. + Represents the length of the heap. + Represents the column index of the data to sort. + + + + Sorts the string type. + + Represents the root element in the heap. + Represents the length of the heap. + Represents the column index of the data to sort. + + + + Creates the Float Heap in Descending order. + + Represents the posiont of the heap. + Represents the length of the heap. + Represents the column index of the data to sort. + + + + Sorts the integer value in descending order. + + Represents the root element in the heap. + Represents the length of the heap. + Represents the column index of the data to sort. + + + + Creates the Float Heap in Descending order. + + Represents the posiont of the heap. + Represents the length of the heap. + Represents the column index of the data to sort. + + + + Sorts the Float value in descending order. + + Represents the root element in the heap. + Represents the length of the heap. + Represents the column index of the data to sort. + + + + Create the Heap with the Date type in Descending order. + + Represents the posiont of the heap. + Represents the length of the heap. + Represents the column index of the data to sort. + + + + Sorts the Date value in descending order. + + Represents the root element in the heap. + Represents the length of the heap. + Represents the column index of the data to sort. + + + + Create the Heap with the String type in Descending order. + + Represents the posiont of the heap. + Represents the length of the heap. + Represents the column index of the data to sort. + + + + Sorts the String value in descending order. + + Represents the root element in the heap. + Represents the length of the heap. + Represents the column index of the data to sort. + + + + Range object to sort. + + + + + This class used to sort the Data using the InsertionSort algorithm. + + + + + Sorts the int value in Ascending order. + + + + + + + + Sorts the Float value in Ascending order. + + + + + + + + Sort values in Ascending order. + + + + + + + + Sorts the int value in Ascending order. + + + + + + + + Sort Methods based on types. + + Represents the left index of the data. + Represents the right index of the data. + Sots based on this column. + + + + Sorts the Int values in Descending order. + + Represents the left index of the data. + Represents the right index of the data. + Sots based on this column. + + + + Sorts the float values in Descending order. + + Represents the left index of the data. + Represents the right index of the data. + Sots based on this column. + + + + Sorts the float values in Descending order. + + Represents the left index of the data. + Represents the right index of the data. + Sots based on this column. + + + + Sorts the float values in Descending order. + + Represents the left index of the data. + Represents the right index of the data. + Sots based on this column. + + + + Sorts the Data using InsertionSort Algorithm. + + Represents the left index of the data. + Represents the right index of the data. + + + + Range object to sort. + + + + + Represents category in the chart. + + + + + Represents category in the chart. + + + + + True if the user filters out category. otherwise False. + + + By default all the categories in the chart are shown because this property is set to "false". Here for example, we filter out + first category from the chart and it will not be shown in the chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart categories collection + IChartCategories categories = chart.Categories; + + //Get chart first category + IChartCategory category = categories[0]; + + //Filter out the first category + category.IsFiltered = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the category name. Read only. + + + The following code illustrates how to access the element from object and display its name. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart categories collection + IChartCategories categories = chart.Categories; + + //Get chart category by index + IChartCategory category = categories[1]; + + //Displaying the name of the category object + Console.WriteLine("Name of the second category is:" + category.Name); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + + + // Output will be + //Name of the second category is:Feb + + + + Gets the category label for the chart. Read only. + + + The following code illustrates how to access the from object and display its category labels address. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart categories collection + IChartCategories categories = chart.Categories; + + //Get chart second category + IChartCategory category = categories[1]; + + //Displaying the labels address of the category object + Console.WriteLine("Category labels address is:" + category.CategoryLabel.AddressLocal); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + + + // Output will be + // Category labels address is:A1:C1 + + + + Gets the category values. Read only. + + Returns the first series values of the chart category + + The following code illustrates how to access the from object and display its value address. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart categories collection + IChartCategories categories = chart.Categories; + + //Get chart second category + IChartCategory category = categories[1]; + + //Displaying the first series values of the category object + Console.WriteLine("Category value address is:" + category.Values.AddressLocal); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + + + // Output will be + // Category value address is:B2:B3 + + + + Represents a Boolean value indicating if the category filter is customized. + + + + + Initializes a new instance of class with the + specified application and parent objects. + + + + + + + Clone the chart category + + chart category object + + + + True if the user filters out a series. otherwise False. + + + + + Gets the category label for the chart. Read only. + + + + + Gets the category values. Read only. + + + + + Gets the category name. Read only. + + + + + Represents a collection of chart categories. + + + + + Represents a collection of chart categories. + + + + + Gets the number of elements in the collection. Read-only. + + + The following code illustrates how to get number of elements in the object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart categories collection + IChartCategories categories = chart.Categories; + + //Displaying the number of categories in the chart + Console.WriteLine("Number of categories in the chart is:" + categories.Count.ToString()); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + + + // Output will be + // Number of categories in the chart is:3 + + + + Gets a single category object with the specified index. + + + The following code illustrates how to access the element by index from the object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart categories collection + IChartCategories categories = chart.Categories; + + //Get chart category by index + IChartCategory category = categories[1]; + + //Displaying the name of the category object + Console.WriteLine("Name of the second category is:" + category.Name); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + + + // Output will be + //Name of the second category is:Feb + + + + Gets a single category object with the specified name. + + + The following code illustrates how to access the element by name from the object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart categories collection + IChartCategories categories = chart.Categories; + + //Get chart category by name + IChartCategory category = categories["Jan"]; + + //Checking whether the category is filtered + Console.WriteLine("Is Jan category is filtered:" + category.IsFiltered); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + + + // Output will be + // Is Jan category is filtered:False + + + + Initializes a new instance of class. + + Application object for the collection. + Parent object for the collection. + + + + Adds the specified series to this collection. + + Series that should be added to the collection. + The added serie. + + + + Removes the serie with the specified name from this collection. + + Name of the serie to be removed. + + + + Adds a new serie with the specified serie type and name to this collection. + + Name of the serie to be added. + Serie type for the serie. + The added Serie. + + + + Adds a new serie with the specified serie type to this collection. + + The Serie type to be added. + The added serie. + + + + Adds a new serie to this collection. + + The added serie. + + + + Performs additional operations before the Clear method. + + + + + Clone current instance. + + Parent object. + Returns cloned instance. + + + + Returns array of entered records. + + Si record index. + Returns array of entered records. + + + + Adds a new serie with the specified name to this collection. + + Name of the serie. + The added serie. + + + + Gets array by si index. + + Si index. + Returns array of arrays by si index. + + + + Adds a new serie with the specified range of category labels and category values to this collection. + + Category labels for the serie to be added. + Category values for the serie to be added. + The added serie. + + + + Gets a single category object with the specified index. + + + + + Gets a single category object with the specified name. + + + + + This class used to sort the data using MergeSort. + + + + + Initailize the sort data attributes. + + Represents the data to sort. + Represents the datatype of each column. + Represents the sort order. + Represents the color to sort. + + + + Sort based on their types. + + Represents the Data To Sort. + Represents the column index. + Sorted Data. + + + + Gets the specified range from the array. + + Array of data to get the range. + start index. + end index. + object array. + + + + Adds the source content to the destination array content from the start index. + + Destination array. + Source Array. + Start Index. + + + + Sort the data in Ascending order. + + Represents the array of data to sort. + Represents the column Index. + Sorted Data. + + + + Sort the data in Ascending order. + + Represents the array of data to sort. + Represents the column Index. + Sorted Data. + + + + Sort the data in Ascending order. + + Represents the array of data to sort. + Represents the column Index. + Sorted Data. + + + + Sort the data in Ascending order. + + Represents the array of data to sort. + Represents the column Index. + Sorted Data. + + + + Sort the data in Decending order. + + Represents the array of data to sort. + Represents the column Index. + Sorted Data. + + + + Sort the data in Decending order. + + Represents the array of data to sort. + Represents the column Index. + Sorted Data. + + + + Sort the data in Decending order. + + Represents the array of data to sort. + Represents the column Index. + Sorted Data. + + + + Sort the data in Decending order. + + Represents the array of data to sort. + Represents the column Index. + Sorted Data. + + + + Sort the data using MergeSort. + + Represents the left position of the data. + Represents the right psoition of the data. + + + + Range object to sort. + + + + + This class used to sort the data using QuickSort3. + + + + + Initailize the sort data attributes. + + Represents the data to sort. + Represents the datatype of each column. + Represents the sort order. + Represents the color to sort. + + + + Sorts the data in Ascending sort. + + Represents the left index of the data. + Represents the right index of the data. + Represents the column index of the data. + + + + Sorts the data in Ascending sort. + + Represents the left index of the data. + Represents the right index of the data. + Represents the column index of the data. + + + + Sorts the data in Ascending sort. + + Represents the left index of the data. + Represents the right index of the data. + Represents the column index of the data. + + + + Sorts the data in Ascending sort. + + Represents the left index of the data. + Represents the right index of the data. + Represents the column index of the data. + + + + Sorts the data in Decending sort. + + Represents the left index of the data. + Represents the right index of the data. + Represents the column index of the data. + + + + Sorts the data in Decending sort. + + Represents the left index of the data. + Represents the right index of the data. + Represents the column index of the data. + + + + Sorts the data in Decending sort. + + Represents the left index of the data. + Represents the right index of the data. + Represents the column index of the data. + + + + Sorts the data in Decending sort. + + Represents the left index of the data. + Represents the right index of the data. + Represents the column index of the data. + + + + Sorts the data with the specified column index using QuickSort3 + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the data using QuickSort algorithm. + + Represents the left index of the data. + Represents the right index of the data. + + + + Internal quicksort method that makes recursive calls. + Uses median-of-three partitioning and a cutoff of 10. + + An array of Comparable items. + low the left-most index of the subarray. + high the right-most index of the subarray. + + + + Method to swap to elements in an array. + + an array of objects.. + low the left-most index of the subarray. + high the right-most index of the subarray. + + + + Internal insertion sort routine for subarrays + + an array of objects.. + low the left-most index of the subarray. + high the right-most index of the subarray. + + + + Compares the number in string format as a number + + Current value + Comparing value + + + + + Compares two array objects. + + First Array Objects. + Second Array Objects. + + + + Range object to sort. + + + + + Represents the sort Field attributes. + + + + + Represents the sort field based on which sorting is performed. + + + + + Sets sorting priority. + + integer priority value. 0 represents high priority. + + To know more about sorting refer Data Sorting. + + + If more than one is used then we can set priority for a particular . The following code illustrates + how priority can be set for a . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Set colors + worksheet["C2:C3"].CellStyle.Color = System.Drawing.Color.Red; + worksheet["C4:C5"].CellStyle.Color = System.Drawing.Color.Blue; + worksheet["C6:C7"].CellStyle.Color = System.Drawing.Color.Green; + + //Create sorter + IDataSort sorter = workbook.CreateDataSorter(); + + //Set sort range + sorter.SortRange = worksheet["A1:C7"]; + + //Add sortfield + ISortField sortField = sorter.SortFields.Add(1, SortOn.Values, OrderBy.Ascending); + ISortField sortField2 = sorter.SortFields.Add(2, SortOn.CellColor, OrderBy.Descending); + + //Set sortfiled color + sortField2.Color = System.Drawing.Color.Green; + + //Set priority + sortField2.SetPriority(0); + + //Perform sort + sorter.Sort(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Datasort.xlsx"); + workbook.Close(); + } + + + + + + Represents the column to be sorted on. + + + The following code illustrates how the the column to be sorted can be set using the Key property. Here for example, we set 2 to the Key property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Set colors + worksheet["C2:C3"].CellStyle.Color = System.Drawing.Color.Red; + worksheet["C4:C5"].CellStyle.Color = System.Drawing.Color.Blue; + worksheet["C6:C7"].CellStyle.Color = System.Drawing.Color.Green; + + //Create sorter + IDataSort sorter = workbook.CreateDataSorter(); + + //Set sort range + sorter.SortRange = worksheet["A1:C7"]; + + //Add sortfield + ISortField sortField = sorter.SortFields.Add(0, SortOn.Values, OrderBy.Ascending); + + //Set sortfield properties + sortField.SortOn = SortOn.CellColor; + sortField.Order = OrderBy.Descending; + sortField.Key = 2; + sortField.Color = System.Drawing.Color.Green; + + //Perform sort + sorter.Sort(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Datasort.xlsx"); + workbook.Close(); + } + + + + + + Represents the sort by in the range. + + + To know more about sorting refer Data Sorting. + + Sorting can be done based on or or . Here for example, + we set to SortOn property to sort cells based on cell color. + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Set colors + worksheet["C2:C3"].CellStyle.Color = System.Drawing.Color.Red; + worksheet["C4:C5"].CellStyle.Color = System.Drawing.Color.Blue; + worksheet["C6:C7"].CellStyle.Color = System.Drawing.Color.Green; + + //Create sorter + IDataSort sorter = workbook.CreateDataSorter(); + + //Set sort range + sorter.SortRange = worksheet["A1:C7"]; + + //Add sortfield + ISortField sortField = sorter.SortFields.Add(0, SortOn.Values, OrderBy.Ascending); + + //Set sortfield properties + sortField.SortOn = SortOn.CellColor; + sortField.Order = OrderBy.Descending; + sortField.Key = 2; + sortField.Color = System.Drawing.Color.Green; + + //Perform sort + sorter.Sort(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Datasort.xlsx"); + workbook.Close(); + } + + + + + + Represents the sort order. + + + To know more about sorting refer Data Sorting. + + + Value set to Order property determines the sorting order. and are only applicable + if is set to or . We can either use or + if is set . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Set colors + worksheet["C2:C3"].CellStyle.Color = System.Drawing.Color.Red; + worksheet["C4:C5"].CellStyle.Color = System.Drawing.Color.Blue; + worksheet["C6:C7"].CellStyle.Color = System.Drawing.Color.Green; + + //Create sorter + IDataSort sorter = workbook.CreateDataSorter(); + + //Set sort range + sorter.SortRange = worksheet["A1:C7"]; + + //Add sortfield + ISortField sortField = sorter.SortFields.Add(0, SortOn.Values, OrderBy.Ascending); + + //Set sortfield properties + sortField.SortOn = SortOn.CellColor; + sortField.Order = OrderBy.Descending; + sortField.Key = 2; + sortField.Color = System.Drawing.Color.Green; + + //Perform sort + sorter.Sort(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Datasort.xlsx"); + workbook.Close(); + } + + + + + + Represents the color to sort. Throws exception when SortOn type is Values. + + + To know more about sorting refer Data Sorting. + + + If property is set or , then the Color property should be + set. Here for example, we set green from to the Color property to sort the cells based on CellColor. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Set colors + worksheet["C2:C3"].CellStyle.Color = System.Drawing.Color.Red; + worksheet["C4:C5"].CellStyle.Color = System.Drawing.Color.Blue; + worksheet["C6:C7"].CellStyle.Color = System.Drawing.Color.Green; + + //Create sorter + IDataSort sorter = workbook.CreateDataSorter(); + + //Set sort range + sorter.SortRange = worksheet["A1:C7"]; + + //Add sortfield + ISortField sortField = sorter.SortFields.Add(0, SortOn.Values, OrderBy.Ascending); + + //Set sortfield properties + sortField.SortOn = SortOn.CellColor; + sortField.Order = OrderBy.Descending; + sortField.Key = 2; + sortField.Color = System.Drawing.Color.Green; + + //Perform sort + sorter.Sort(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Datasort.xlsx"); + workbook.Close(); + } + + + + + + Represents the column to be sorted on. + + + + + Represents the sort by in the range. + + + + + Represents the sort order. + + + + + Represents the color to sort. Throws exception when SortOn type is Values. + + + + + Parent class object. + + + + + Initialize the sort field. + + + + + + Sets sorting priority. + + integer priority value. 0 represents high priority. + + + + Represents the column to be sorted on. + + + + + Represents the sort by in the range. + + + + + Represents the sort order. + + + + + Represents the color to sort. Throws exception when SortOn type is Values. + + + + + Represents the sort Field collection. + + + + + Represents the sort field collections based on which sorting is performed. + + + + + Adds the SortField in the collection. + + Column Index to sort the data. + To sort the data based on. + To order the sorted data. + Returns the Added . + + The Add method adds to the collection and returns it. The following code illustrates + how can be added to collection using Add method. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create sorter + IDataSort sorter = workbook.CreateDataSorter(); + + //Set range + sorter.SortRange = worksheet["A1:C7"]; + + //Add sortfield + ISortField sortField = sorter.SortFields.Add(0, SortOn.Values, OrderBy.Ascending); + + //Perform sort + sorter.Sort(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Datasort.xlsx"); + workbook.Close(); + } + + + + + + Removes the in the collection with the . + + Sort field Key to remove. + + The following code illustrates how a can be removed from collection by specfiying it's . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Set colors + worksheet["C2:C3"].CellStyle.Color = System.Drawing.Color.Red; + worksheet["C4:C5"].CellStyle.Color = System.Drawing.Color.Blue; + worksheet["C6:C7"].CellStyle.Color = System.Drawing.Color.Green; + + //Create sorter + IDataSort sorter = workbook.CreateDataSorter(); + + //Set range + sorter.SortRange = worksheet["A1:C7"]; + + //Add sortfield + ISortField sortField = sorter.SortFields.Add(1, SortOn.Values, OrderBy.Ascending); + ISortField sortField2 = sorter.SortFields.Add(2, SortOn.CellColor, OrderBy.Descending); + + //Remove sortfield + sorter.SortFields.Remove(2); + + //Perform sort + sorter.Sort(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Datasort.xlsx"); + workbook.Close(); + } + + + + + + Removes the specified from the collection. + + Sort Field to remove from the collection. + + The following code illustrates how a can be removed from collection by passing it as a + parameter. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Set colors + worksheet["C2:C3"].CellStyle.Color = System.Drawing.Color.Red; + worksheet["C4:C5"].CellStyle.Color = System.Drawing.Color.Blue; + worksheet["C6:C7"].CellStyle.Color = System.Drawing.Color.Green; + + //Create sorter + IDataSort sorter = workbook.CreateDataSorter(); + + //Set range + sorter.SortRange = worksheet["A1:C7"]; + + //Add sortfield + ISortField sortField = sorter.SortFields.Add(1, SortOn.Values, OrderBy.Ascending); + ISortField sortField2 = sorter.SortFields.Add(2, SortOn.CellColor, OrderBy.Descending); + + //Remove sortfield + sorter.SortFields.Remove(sortField2); + + //Perform sort + sorter.Sort(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Datasort.xlsx"); + workbook.Close(); + } + + + + + + Represents the field count. + + + To get the number of in the collection Count property can be used. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C7"].CellStyleName = "CurrencyFormat"; + + //Set colors + worksheet["C2:C3"].CellStyle.Color = System.Drawing.Color.Red; + worksheet["C4:C5"].CellStyle.Color = System.Drawing.Color.Blue; + worksheet["C6:C7"].CellStyle.Color = System.Drawing.Color.Green; + + //Create sorter + IDataSort sorter = workbook.CreateDataSorter(); + + //Set range + sorter.SortRange = worksheet["A1:C7"]; + + //Add sortfield + ISortField sortField = sorter.SortFields.Add(1, SortOn.Values, OrderBy.Ascending); + ISortField sortField2 = sorter.SortFields.Add(2, SortOn.CellColor, OrderBy.Descending); + + //Perform sort + sorter.Sort(); + + //Check sortfield count + Console.WriteLine(sorter.SortFields.Count); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Datasort.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //2 + + + + + + Returns single item from the collection. + + Gets the item based on the . + with the given . + + The following code illustrates how can be accessed from collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Set colors + worksheet["C2:C3"].CellStyle.Color = System.Drawing.Color.Red; + worksheet["C4:C5"].CellStyle.Color = System.Drawing.Color.Blue; + worksheet["C6:C7"].CellStyle.Color = System.Drawing.Color.Green; + + //Create sorter + IDataSort sorter = workbook.CreateDataSorter(); + + //Set range + sorter.SortRange = worksheet["A1:C7"]; + + //Add sortfield + ISortField sortField = sorter.SortFields.Add(1, SortOn.Values, OrderBy.Ascending); + ISortField sortField2 = sorter.SortFields.Add(2, SortOn.CellColor, OrderBy.Descending); + + //Set sortfiled color + sorter.SortFields[1].Color = System.Drawing.Color.Green; + + //Set priority + sorter.SortFields[1].SetPriority(0); + + //Perform sort + sorter.Sort(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Datasort.xlsx"); + workbook.Close(); + } + + + + + + Adds the SortField in the collection. + + Column Index to sort the data. + To sort the data based on. + To order the sorted data. + Added sort field. + + + + Removes the sortField in the collection. + + Sort Field to remove from the collection. + + + + Remvoes the Sort Field in the collection. + + Field index to remove. + + + + Remvoes the last Sort Field in the collection. + + Field index to remove. + + + + Sets the priority of the column to sort. + + + + + + + Finds the SortField by Key. + + Key to find. + index of the SortField. + + + + Finds the last SortField by Key. + + Key to find. + index of the SortField. + + + + Sort the data based on the style. + + + + + Initializes the Style sorting attributes. + + Data to sort. + Represents the type of the column. + Sorting order of the column. + Colors to sort. + + + + Sort the data based on specified column. + + + + + + + + Sort the data based on the Style. + + + + + + + + Sorts the data based on cell color. + + Left index of the data. + Right index of the data. + Column index of the data to sort. + + + + Compares the color. + + First color object. + Second color object. + + + + + Sorts by cell color and align bottom. + + + + + + + + Moves the Style to top. + + source index. + Moves to destination index. + + + + Moves the Style to top. + + source index. + Moves to destination index. + + + + Sorts the integer type data with the specified column index. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the Float values with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the Date type values with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the string type values with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the based on the types with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the Integer type values in Descending order with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the Float type values in Descending order with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the Datea type values in Descending order with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + Sorts the string type values in Descending order with the specified column. + + Represents the start index of the data. + Represents the end index of the data. + Reprsents the columnindex of the data. + + + + This class represents the marker attributes. + + + + + + Represents the header Names of the Property. + + + + + Represents the number format of the property. + + + + + Indicates whether to exclude the property or not. + + + + + Initializes a new instance of the class. + + Name of the header. + + + + Initializes a new instance of the class with specified exclude option. + + if set to true [exclude]. + + + + Initializes a new instance of the class with specified exclude option, header name and number format values. + + Indicates whether to exclude the property. + Name of the header. + The number format of the property. + + + + Initializes a new instance of the class with specified exclude option and number format value. + + Indicates whether to exclude the property. + The number format. + + + + Initializes a new instance of the class with specified header name and number format values. + + Name of the header. + The number format of the property. + + + + Indicates whether to exclude the property or not. + + + + + Represents the header Names of the Property. + + + + + Represents the number format of the property. + + + + + XLSB data holder. + + + + + Name of the zip item with content types description. + + + + + Name of the directory with relations. + + + + + Extension for relations file. + + + + + Path to the top relations. + + + + + Xml files extension. + + + + + Relations default extension. + + + + + Binary item extension. + + + + + Default name of the workbook part. + + + + + Default name of the CustomXml Parts + + + + + Default name of the shared strings part. + + + + + Default name of the styles part name. + + + + + Default name of the themes part name. + + + + + Path format for the worksheet part. + + + + + Default name of the extended properties part. + + + + + Default name of the core properties part. + + + + + Default name of the custom properties part. + + + + + Format for relation id generation. + + + + + The number format indexes that are always serialized. + + + + + Workbook + + + + + Top-level relations. + + + + + Workbook-level relations. + + + + + Specifies style relation id. + + + + + Specifies shares string relation id. + + + + + ZipArchive + + + + + Dictionary which is used to identify content type and stores default types. + Key - file extension (string), Value - content type (string). + + + + + Dictionary which is used to identify content type and stores type overrides. + Key - part name, Value - content type (string). + + + + + Items that must be removed after parsing complete. + + + + + Excel 2007 parser. + + + + + Shared strings part name. + + + + + Styles part name. + + + + + Cell formats. + + + + + Initialize XlsbDataHolder + + + + + Initialize XlsbDataHolder + + Workbook + Archive + + + + Parse xlsb document + + Theme colors + Stream + + + + Parses sheet. + + stream to get data from. + Sheet to parse. + Absolute path to the parent worksheet item. + This stream will receive xml text starting just + after "worksheet" tag to "col" or "sheetData" tag. + This stream contains conditional formatting. + List with new style indexes (index - old + style index, value - new one). + Dictionary with archive items to remove after parsing. + + + + Parses sheet views. + + Stream to get data from. + Worksheet to place extracted data into. + + + + Parses sheet format properties. + + Stream to get data from. + Worksheet to put data. + + + + Extracts sheet data from reader and insets it into worksheet. + + Stream to get data from. + Worksheet to put data into. + List with new style indexes (index - old style index, value - new one). + + + + Parses rows from the document. + + Stream to get data from. + Worksheet to put data. + List with new style indexes (index - old style index, value - new one). + + + + Parses cells from the document. + + Stream to get data. + Worksheet to put data. + Row index. + List with new style indexes. + + + + Parses column collection from the stream. + + Stream to get data. + Worksheet to put data. + List with new style indexes + + + + Parses column from the column collection. + + Stream to get data. + Worksheet to put data. + List with new style indexes + + + + Parses workbook theme colors. + + Theme colors. + + + + Parse worksheets from the archive. + + Shared string index. + + + + Parses shared strings table. + + XmlReader to get data from. + Dictionary with updated string indexes. + + + + Parses string item. + + XmlReader to get data from. + Added string index. + + + + Parse the record length + + Stream to get data + Return the record position + + + + Returns single zip item based on the relation and parent path. + + Relation that points to the archive item. + Path to the parent item. + Path to the desired item. + Requested zip item. + + + + Parse styles. + + Style document stream. + + + + + Parses style from the stream. + + Stream to get data from. + XF Indexes list. + + + + + Parse cell styles. + + Stream to get data from. + Named style indexes. + + + + + Extracts cell formats from specified Stream. + + Stream to get data from. + List with updated font indexes, index - font index + in the file, value - font index in our document (we can change indexes during parsing). + List with extracted fill objects. + List with extracted borders. + List with updated parent indexes, index - xfId in + the xml document, value - xf index in our internal collection. + List with indexes of created extended formats. + + + + Extracts named styles from specified Stream. + + Stream to get data from. + List with updated font indexes, index - font index + in the file, value - font index in our document (we can change indexes during parsing). + List with extracted fill objects. + List with extracted borders. + List with indexes of created extended formats. + + + + Extracts single extended format from the Stream. + + Stream to get data from. + List with updated font indexes, index - font index + in the file, value - font index in our document (we can change indexes during parsing). + List with extracted fill objects. + List with extracted borders. + List with updated parent indexes. + Created ExtendedFormat object. + + + + Extracts border objects from Stream. + + Stream to get data from. + List with new borders indexes. + + + + Parse border properties. + + Stream to get data from. + Border collection. + + + + Parse fill collection. + + Stream to get data. + List of Fill + + + + Parse fill properties. + + Stream to get data. + + + + Parse font collection. + + Stream to get data. + List of font indexes. + + + + Extracts font object from specified Stream. + + stream to read font data from. + List to add new font index into. + + + + Parse number format collection. + + Stream to read data. + + + + + Extracts single number format entry from specified Stream. + + Stream to read data. + + + + Parse Workbook part. + + Stream to read data. + Relation collection. + Xlsb data holder. + Workbook path. + + + + Parse Named range. + + Stream to read data. + + + + Parse external reference. + + Stream to read data. + + + + Parse sheet options. + + Stream to read data. + Relation collection. + File Data holder + WorkbookPath + + + + Parses sheet entry from workbook item. + + Stream to extract data from. + Workook's relations collection. + FileDataHolder that stores document data. + Absolute path in zip archive to the parent workbook. + + + + Parses all document properties. + + + + + Parses archive item by content type. Removes relation for this item and the item itself. + + Content type. + + + + Returns XmlReader for corresponding content type. + + Content type. + Name of the item that has specified content type. + Item name. + + + + Tries to find path to the item by content type. + + Content type to locate. + First occurrence of the item with specified content type. + + + + Tries to find path to the item by content type inside default types. + + Content type to locate. + First occurrence of the item with specified content type. + + + + Tries to find path to the item by content type inside overridden types. + + Content type to locate. + First occurrence of the item with specified content type. + + + + Gets relations. + + Item name to get corresponding relation. + Extracted relation + + + + Parser color object + + Input stream + Color object + + + + Serializes color + + Stream + Color object + + + + Serialize Workbook. + + file name + Workbook + Excel save type + + + + Save document + + File name + Excel + + + + Empty archive + + + + + Save document in Xlsb format. + + Stream to write data. + + + + Save document + + + + + Saves top level relation in zip. + + + + + Save content types. + + + + + Saves all document properties. + + + + + Saves archive item, adds corresponding record into content type and relation collections. + + Part name value. + Content type value. + Relation type value. + + + + Saves archive item by part name into zip archive item. + + Item part name. + + + + Fills default content types. + + + + + Save workbook. + + + + + Serializes relations collection. + + Name of the parent + Represents relations + + + + Save shared strings. + + + + + Serialize string item. + + Stream to write data. + string + + + + Save styles. + + XFIndexes + + + + Serialize cell styles + + Stream to write data. + Cell styles. + + + + Serialize cell style. + + Stream to write data. + Style + XFIndexes. + + + + Serialize CellXFs collection. + + Stream to write data. + Fill Indexes + Border Indexes + Parent XF indexes. + + + + + Serialize Cell Xf collection. + + Stream to write data. + Fill indexes. + Border indexes. + + + + + Serialize Extended format. + + Stream to write data. + Fill indexes. + Border indexes. + Extended format. + Indicates whether it is cell style xf + + + + Serialize borders. + + Stream to write data. + + + + + Serialize border collection. + + Stream to write data. + Border collection. + + + + Serialize border. + + Stream to write data. + Border + + + + Serialize Fill collection. + + Stream to write data. + + + + + Serialize fill. + + Stream to write data. + Fill Impl + + + + Serialize font collection. + + Stream to write data. + + + + Serializes number formats collection into XmlWriter. + + XmlWriter to serialize into. + + + + Serialize number format. + + Stream to write data. + Format record. + + + + Serialize Font. + + Stream to write data. + Font + + + + Save worksheets. + + List of style indexes. + Relations + + + + Save worksheet data. + + Worksheet + Archive item name + List of styles + Relations. + + + + Serialize columns. + + Stream to write data. + Styles + Worksheet + + + + + Serialize column. + + Stream to write data. + Column record. + Styles + Default width + Worksheet + + + + + Updates archive item + + Worksheet to add + Worksheet name to add + + + + Serialize sheet data. + + Stream to write data. + Worksheet + Style indexes. + + + + Serialize row. + + Stream to write data. + Row storage + Cell records. + Row index + Style indexes. + + + + Read specific bit value. + + Byte value. + Bit position. + + + + + Read specific bits value. + + Byte value to which to read bit. + starting bit position. + starting bit position. + + + + Write specific bits value. + + Byte value to which to write bit. + Value + starting bit position. + starting bit position. + + + + Write specific bit value. + + Byte value to which to write bit. + Value + Bit position. + + + + + Serialize cell. + + Stream to write data. + Biff record. + Row storage enumerator + Cell records. + List of styles. + + + + Serialize simple formula. + + Stream to write data. + Formula record. + Cell type. + Rowstorage enumerator. + Row index. + Columnn index + Style index + + + + Save workbook.bin + + + + + Serializes named ranges into specified writer. + + XmlWriter to save named ranges into. + + + + Serialize named range. + + Stream to write data. + NameImpl + + + + Gets the index of the local sheet. + + The sheet. + + + + + Serialize document into stream. + + Stream to write data. + Workbook + + + + Generates free sheetId. + + Extracted sheet id. + + + + Archive items to be removed. + + + + + XF indexes. + + + + + Gets Excel 2007 parser. + + + + + Workbook + + + + + Begin workbook record. + + + + + Worksheets collection begin record. + + + + + WorksheetRecord + + + + + Worksheet collection end record. + + + + + Named range + + + + + Workbook end record. + + + + + Begin worksheet record. + + + + + Sheet properties + + + + + Sheet Dimension + + + + + Sheet views begin + + + + + Sheet view begin + + + + + Active cell record. + + + + + Sheet view end. + + + + + Sheet views end. + + + + + Columns begin + + + + + Column record. + + + + + Columns End. + + + + + Begin sheet data record. + + + + + Row record + + + + + Blank record. + + + + + Number record. + + + + + Error + + + + + Boolean record. + + + + + Double + + + + + Label + + + + + String record + + + + + Formula number record. + + + + + Formula string record. + + + + + Formula boolean record. + + + + + Error formula record. + + + + + End Worksheet record. + + + + + End Worksheet record. + + + + + Begin shared strings table record. + + + + + End shared strings table record. + + + + + String record + + + + + Begin style sheet record. + + + + + Begin number format collection record. + + + + + Number format record. + + + + + End number format collection. + + + + + Begin font collection record. + + + + + Font record + + + + + End font collection record. + + + + + Begin fill collection record. + + + + + Fill record. + + + + + End fill collection record. + + + + + Begin border collection record. + + + + + Border record. + + + + + End border collection record. + + + + + Begin CellStyleXfs collection record. + + + + + Cell style XF record. + + + + + End CellStyleXfs collection record. + + + + + Begin CellXfs collection record. + + + + + End CellXfs collection record. + + + + + Begin Cell styles collection record. + + + + + Cell style record. + + + + + End Cell styles collection record. + + + + + End style sheet record. + + + + + Drawing Record + + + + + The begin record defines the start of a block of records for a (Graphing) + data object. This record is matched with a corresponding EndRecord. + + + + + + + + + + + Summary description for IBiffStorage. + + + + + Size of the required storage space. Read-only. + + + + + Save record data to stream. + + Writer that will receive record data. + Object that provides access to the data. + Object to encrypt data. + Position in the output stream. Used to increase performance. + Size of the record. + If writer is NULL. + + If m_iLength of internal record data array is less than zero. + + + + + Returns type code of the biff storage. Read-only. + + + + + Returns code of the biff storage. Read-only. + + + + + Indicates whether data array is required by this record. + + + + + Indicates record position in stream. This is a utility member of class and + is used only in the serialization process. Does not influence the data. + + + + + Default size of the inner collections. + + + + + Maximum size of a record. + + + + + Maximum size of a record with header. + + + + + Size of the records header. + + + + + Number of bits in byte. + + + + + Number of bits in short. + + + + + Number of bits in int. + + + + + Used to optimize reflection typed extracting. + TBiffRecord - to - ReflectionCachePair + + + + + + + + + + Skips begin - end block and sub blocks. + + Record storage. + Position in storage. + Returns index after skipping. + + + + Code of the Biff record. + + + + + Length of the Biff record data. + + + + + Indicates whether m_data array need to be Infilled before usage. + + + + + Gets value with all bits that do not correspond + to the specified mask to zero. + + Unsigned Int16 value. + Bit mask. + + Value with all bits that do not correspond + to the specified mask to zero. + + + + + Sets value with all bits that correspond to the specified + mask of zero to the same values as in the value. + + Variable that bits of which will be set. + Bit mask. + Value from which bit values will be taken. + + + + Gets value with all bits that do not correspond + to the specified mask to zero. + + Unsigned Int32 value. + Bit mask. + + Value with all bits that do not correspond + to the specified mask to zero. + + + + + Sets value with all bits that correspond to the specified + mask to zero to the same values as in value. + + Variable that bits of which will be set. + Bit mask. + Value from which bit values will be taken. + + + + Default constructor, gets code value using reflection and attributes. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Read / initialize constructor. + + BinaryReader from which record data should be read. + Size of the read item. + + When specified reader is NULL. + + + + + Reserved for record's internal data array iReserve bytes. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Read from stream record data. + + Stream with record data. + Object that provides access to the data. + Object that should be used to parse encrypted records. + Temporary buffer needed for some operations. + Size of the record data. + If reader is NULL. + + If stream is not big enough for data (end of stream + reached and all data was not read). + + + If record code is zero. + + + + + Save record data to stream. + + Writer that will receive record data. + Object that provides access to the data. + Object to encrypt data. + Position in the output stream. Used to increase performance. + Size of the record. + If writer is NULL. + + If m_iLength of internal record data array is less than zero. + + + + + Method which updates the fields of record which contain stream offset + or other data. This method must be called before save operation. + + Array with all records. + + When not overridden in descendant class. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Array that contains record's data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + Returns size of the required storage space. + + Excel version. + Size of the required storage space. + + + + Checks offset and length of the array. + + Array to check. + Start offset. + Length of the data. + + + + Get array of bytes from internal record data. + + + Offset of first byte of data to get. + Length of required array. + Array of bytes from internal record data. + + If offset is less than zero or more than internal record data array size + or length is less than zero or more than internal record data array size + or length plus offset is more than internal record data array size. + + + + + Gets single byte from internal record data using GetBytes. + + Source byte array. + Offset of byte to get. + Single byte from internal record data. + + + + Gets ushort from internal record data using GetBytes. + + Source byte array. + Offset in bytes of ushort to get. + Ushort from internal record data. + + + + Gets short from internal record data using GetBytes. + + Source byte array. + Offset in bytes of short to get. + Short from internal record. + + + + Gets int from internal record data using GetBytes. + + Source byte array. + Offset in bytes of int to get. + Int from internal record. + + + + Gets uint from internal record data using GetBytes. + + Source byte array. + Offset in bytes of uint to get. + Uint from internal record data. + + + + Gets long from internal record data using GetBytes. + + Source byte array. + Offset in bytes of long to get. + Long from internal record data. + + + + Gets ulong from internal record data using GetBytes. + + Source byte array. + Offset in bytes of ulong to get. + Ulong from internal record data. + + + + Gets float from internal record data using GetBytes. + + Source byte array. + Offset in bytes of float to get. + Float from internal record data. + + + + Gets double from internal record data using GetBytes. + + Source byte array. + Offset in bytes of double to get. + Double from internal record data. + + + + Gets single bit from internal record data using GetBytes. + + Source byte array. + Offset of the byte that contains needed bit. + Position of bit in the byte. + True if specified bit is set to 1; otherwise False. + + bitPos argument should be not less than zero and not more than 7. + + + + + Gets single bit from internal record data using GetBytes. + + Source memory block. + Offset of the byte that contains needed bit. + Position of bit in the byte. + True if specified bit is set to 1; otherwise False. + + bitPos argument should be not less than zero and not more than 7. + + + + + Gets string from internal record data using GetBytes, + and it increases the offset by string size in bytes. + + Source byte array. + Offset of starting byte. + Retrieved string. + + if Offset + iStrLen is out of data array + + + + + Gets string from internal record data using GetBytes + and it increases offset by string size in bytes. + + Source byte array. + Offset of starting byte. + Length of the string. + Retrieved string. + + if Offset + iStrLen is out of data array + + + + + Gets string from internal record data using GetBytes. + + Source byte array. + Offset of starting byte. + Retrieved string. + + if Offset + iStrLen is out of data array + + + + + Gets string from internal record data using GetBytes. + + Source byte array. + Offset of starting byte. + Length of the string. + Retrieved string. + + if Offset + iStrLen is out of data array + + + + + Gets string from internal record data using GetBytes. + + Source byte array. + Offset of starting byte. + Length of the string. + Gets bytes count that this string occupies in the data array. + Flags that represent is bytes count available. + Retrieved string. + + + + Detect type of string and extracts it. + + Source byte array. + Record data offset. + Position of next object. + Length of string record. + Array of rich formatting values. + Array of unknown FarEast data. + Extracted string. + + + + Gets TAddr structure from internal record data. + + Source byte array. + Offset in bytes of TAddr structure to get. + Retrieved TAddr structure. + + + + Extract the Reverse-Polish Notation formula from the data array. + + Source byte array. + Offset to the RPN data. + Length of the data. + Extracted RPN data. + + + + Searches for the next break. + + List of breaks. + Number of elements in the list. + Current break position. + Start index in the array. + Next break. + + + + Sets ushort in internal record data array using SetBytes method. + + Byte array list. + Offset to the required value. + New value for the specified ushort. + + + + Sets one bit in specified byte in internal record data array. + + Array where byte is located.. + Offset of the byte in the data array. + Bit position in the byte. + Value of bit. + + If bitPos is less than zero or more than 7. + + + + + Sets short in internal record data array using SetBytes method. + + Array where value should be placed located. + Offset to the required value. + New value for the specified short. + + + + Sets int in internal record data array using SetBytes method. + + Array where value should be placed located. + Offset to the required value. + New value for the specified int. + + + + Sets uint in internal record data array using SetBytes method. + + Array where value should be placed located. + Offset to the required value. + New value for the specified uint. + + + + Sets double in internal record data array using SetBytes method. + + Array where value should be placed. + Offset to the required value. + New value for the specified double. + + + + Sets string in internal record data array using SetBytes method + without string length, updates offset parameter (adds string length). + + Array where value should be placed located. + Offset to the string. + Value of the string. + + + + Sets string in internal record data array using SetBytes method. + The String length is saved in one byte. + + Array where value should be placed located. + Offset to the string. + Value of the string. + + + + Sets bytes in internal record data array values. + + Buffer to copy bytes into. + Offset in internal record data array to start from. + Array of bytes to set. + Position in value array to the data that will be set. + Length of the data. + If value array is NULL. + + If pos or length would be less than zero or their sum would be more + than size of value array. + + + If internal record data array is too small for receiving value array + and AutoGrowData is False. + + + + + Sets one bit in specified ushort. + + Offset of the byte in the internal record data array. + Value of bit. + Bit position in the byte. + + If bitPos is less than zero or more than 7. + + + + + Sets one bit in specified uint. + + Offset of the byte in the internal record data array. + Value of bit. + Bit position in the byte. + + If bitPos is less than zero or more than 7. + + + + + Return size in bytes for string with 16-bit length field. + + String to measure. + Indicates whether string should be compressed or not. + Size in bytes for string with 16-bit length field. + + + + Clears data. + + + + + Compares two Biff records. + + Biff record that should be compared with this Biff record. + True if this instance and extFormat contain the same data. + + + + Copies data from the current Biff record to the specified Biff record. + + Biff record that will receive data from the current record. + + When this record and parameter have different types. + + + + + Checked typeCode. + + TypeCode to check. + + + + + + + + + + + + + + + + + + + + + + + Sets record code. + + Code to set. + + + + Clone current Record. + + Returns memberwise clone on current object. + + + + Combines several byte arrays into one. + + Length of combined array. + List that contains byte arrays to combine. + Combined array. + + + + + + + + + + + + + + Copies string data into array of bytes without string length field. + + Destination array. + Offset to the string. + Value of the string. + Size of the string in bytes. + + + + Sets string in internal record data array using SetBytes method. + The String length is saved in two bytes + + Destination array. + Offset to the string. + Value of the string. + + + + Returns value of the single bit from byte. + + Byte to get bit value from. + Bit index. + Value of the single bit from byte. + + + + Returns value of the single bit from byte. + + Int16 to get bit value from. + Bit index. + Value of the single bit from byte. + + + + Returns value of the single bit from byte. + + UInt16 to get bit value from. + Bit index. + Value of the single bit from byte. + + + + Returns value of the single bit from byte. + + Byte to get bit value from. + Bit index. + Value of the single bit from byte. + + + + Returns value of the single bit from UInt32. + + UInt32 to get bit value from. + Bit index. + Value of the single bit from byte. + + + + Sets one bit in specified Int32. + + Int32 to set bit. + Bit position in the byte + Value of bit + + If bitPos is less than zero or more than 7 + + Value after + + + + Reads data array from another data array. + + Source array. + Source offset. + Destination array. + Updated source offset. + + + + Read-only. Will get record type if known; + otherwise it will get TBIFFRecord.Unknown. + + + + + Read-only. Returns integer value which is the unique identifier + of Biff record. + + + + + Gets / sets length of internal data array. + + + + + Read-only. Returns record data. + + + + + If True, the array will automatically grow when the offset limit + is reached. This is required when the real record size is not known for an + Infill operation. Will throw exception on buffer offset overrun + when set to False. Default value is False. + + + + + Indicates record position in stream. This is a utility member of class and + is used only in the serialization process. Does not influence the data. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Maximum memory size for internal buffer. + + + + + Indicates whether record needs to infill internal data array. + + + + + Indicates whether record needs internal data array + or if it can be cleaned. Read-only. + + + + + Indicates whether record allows shorter data. Read-only. + + + + + Indicates whether record need decoding when file is encoded or not. Read-only. + + + + + Returns offset in the data array where encoded/decoded data should start. Read-only. + + + + + + + + + + Minimum size of the record. + + + + + + A bit that specifies whether the containing record specifies a range of cells. + It MUST be one of the following. + 0 - The containing record does not specify a range of cells. + 1 - The containing record specifies a range of cells. + + + + + A bit that specifies whether to alert the user of possible problems when saving the file. + + + + + Range of cells associated with the containing record. + + + + + Type of the conditional formatting: + + 01H = Compare with current cell value + (the comparison specified below is used) + + 02H = Evaluate a formula (condition is met + if formula evaluates to a value not equal to 0) + + 03H = Color scale + 04H = Data bar + 05H = Filter + 06H = Icon set + + + + + Comparison operator: + 00H = No comparison (only valid for formula type, see above) + 01H = Between + 02H = Not between + 03H = Equal + 04H = Not equal + 05H = Greater than + 06H = Less than + 07H = Greater or equal + 08H = Less or equal + + + + + Size of the formula data for first value or formula. + + + + + Size of the formula data for second value or formula + (sz2, used for second part of �Between� and �Not between� + comparison, this field is 0 for other comparisons). + + + + + Formula data for first value or formula (RPN token array without size field): + + + + + Formula data for second value or formula (RPN token array without size field): + + + + + + + + + + + + + + + An integer that specifies the length of the formula. + + + + + Formula data (RPN token array without size field): + + + + + + + + + + An integer that specifies the size of the structure in bytes. + If greater than zero, it MUST be the total byte count of dfxn and xfext. Otherwise it MUST be zero. + + + + + Size of the Extended Properties. + + + + + Set of properties applied to the XF format + + + + + A bit that specifies whether, when a cell fulfills the condition corresponding to this rule, + the lower priority conditional formatting rules that apply to this cell are evaluated. + + + + + An integer that specifies the priority of the rule. + Rules that apply to the same cell are evaluated in increasing order of ipriority. + + + + + An integer that specifies the template from which the rule was created. + + 0x0000 Cell value + 0x0001 Formula + 0x0002 Color scale formatting + 0x0003 Data bar formatting + 0x0004 Icon set formatting + 0x0005 Filter + 0x0007 Unique values + 0x0008 Contains text + 0x0009 Contains blanks + 0x000A Contains no blanks + 0x000B Contains errors + 0x000C Contains no errors + 0x000F Today + 0x0010 Tomorrow + 0x0011 Yesterday + 0x0012 Last 7 days + 0x0013 Last month + 0x0014 Next month + 0x0015 This week + 0x0016 Next week + 0x0017 Last week + 0x0018 This month + 0x0019 Above average + 0x001A Below Average + 0x001B Duplicate values + 0x001D Above or equal to average + 0x001E Below or equal to average + + + + + An integer that specifies the size of the rgbTemplate Parmeters field in bytes. + + + + + CFEx Default parameter. + + + + + Reserved. + + + + + DXFN structure. + + + + + CFEx filter template parameter. + + + + + CFEx Text template parameter. + + + + + CFEx Date template parameter. + + + + + CFEx Average template parameter. + + + + + Data bar. + + + + + Icon set. + + + + + Color scale. + + + + + Check whtether the record is parsed. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Parse structure of template parameter. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Serves as a hash function for a particular type, suitable for use in + hashing algorithms and data structures like a hash table. + + A hash code for the current Object. + + + + A hash code for the current Object without taking cell list into account. + + The Object to compare with the current Object. + + + + + An integer that specifies the template from which the rule was created. + + + + + Comparison operator: + 00H = No comparison (only valid for formula type, see above) + 01H = Between + 02H = Not between + 04H = Not equal + 05H = Greater than + 06H = Less than + 03H = Equal + 07H = Greater or equal + 08H = Less or equal + + + + + Size of the formula data for first value or formula. Read-only. + + + + + Size of the formula data for second value or formula + (sz2, used for second part of "Between" and "Not between" + comparison, this field is 0 for other comparisons). Read-only. + + + + + Parsed first formula string. + + + + + Parsed second formula string. + + + + + Returns bytes of the first formula. Read-only. + + + + + Returns bytes of the second formula. Read-only. + + + + + Parsed formula string. + + + + + Returns bytes of the formula. Read-only. + + + + + A bit that specifies whether, when a cell fulfills the condition corresponding to this rule, + the lower priority conditional formatting rules that apply to this cell are evaluated. + + + + + An integer that specifies the priority of the rule. + + + + + An integer that specifies the template from which the rule was created. + 0x0000 Cell value + 0x0001 Formula + 0x0002 Color scale formatting + 0x0003 Data bar formatting + 0x0004 Icon set formatting + 0x0005 Filter + 0x0007 Unique values + 0x0008 Contains text + 0x0009 Contains blanks + 0x000A Contains no blanks + 0x000B Contains errors + 0x000C Contains no errors + 0x000F Today + 0x0010 Tomorrow + 0x0011 Yesterday + 0x0012 Last 7 days + 0x0013 Last month + 0x0014 Next month + 0x0015 This week + 0x0016 Next week + 0x0017 Last week + 0x0018 This month + 0x0019 Above average + 0x001A Below Average + 0x001B Duplicate values + 0x001D Above or equal to average + 0x001E Below or equal to average + + + + + Color Scale implementation class. + + + + + Data var. + + + + + Icon set. + + + + + True if the record parsed. + + + + + CF12 Color Scale class. + + + + + CF12 Data bar class. + + + + + CF12 Icon set class. + + + + + CF12 Top10 class. + + + + + CF12 Above Average class. + + + + + Set of properties applied to the XF format. + + + + + Color scale. + + + + + Minimum size of the structure. + + + + + Undefined. + + + + + Interpolation point count. + + + + + Gradient point count. + + + + + Minimum or the maximum of the interpolation curve is used instead of the cell value. + + + + + Color scale formatting applies to the background of the cells. + + + + + clamp and background. + + + + + List of Conditional format interpolation curve. + + + + + List of Conditional format gradient curve. + + + + + Default constructor. + + + + + Copy color scale. + + + + + Parse structure of template parameter. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Calculate Num value. + + + + + Update criteria. + + + + + Convert Color object to unsigned integer. + + + + + Convert unsigned integer to Color object. + + + + + Convert ARGB to RGBA. + + + + + Convert ARGB to RGBA. + + + + + Interpolation curve. + + + + + Gradient Item. + + + + + Gets the Default Record Size + + + + + Gets the ColorScale + + + + + Data bar. + + + + + Minimum size of the structure. + + + + + Undefined. + + + + + Specifies whether the data bars are drawn starting from the right of the cell. + + + + + Specifies whether the numerical value of the cell appears in the cell along with the data bar. + + + + + Minimum percent length of data bar. + + + + + Maximum percent length of data bar. + + + + + Type of color. + + + + + Color value. + + + + + Tint and shade. + + + + + CFVO structure. + + + + + CFVO structure. + + + + + Default constructor. + + + + + Copy data bar. + + + + + Convert ARGB to RGBA. + + + + + Parse structure of template parameter. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Convert Color object to unsigned integer. + + + + + Convert unsigned integer to Color object. + + + + + Convert ARGB to RGBA. + + + + + Type of color. + + + + + Color value. + + + + + Tint and shade. + + + + + Min CFVO. + + + + + Max CFVO. + + + + + Data bar implementation class. + + + + + Icon set. + + + + + Minimum size of the structure. + + + + + Undefined. + + + + + Specifies the number of items in the icon set.. + + + + + integer that specifies the icon set that represents the cell values. + + + + + Specifies whether only the icon will be displayed in the sheet and that the cell value will be hidden. + + + + + specifies whether the order of the icons in the set is reversed. + + + + + List of CF icon MultiState. + + + + + Default constructor. + + + + + Copy IconSet. + + + + + Parse structure of template parameter. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Calucate IsIconOnly and reverse order byte. + + + + + Size of the required storage space. Read-only. + + + + + Update Icon Set from IIconSet. + + + + + Update criteria. + + + + + Specifies the icon set that represents the cell values. + + + + + List of CF icon MultiState. + + + + + Default minimum structure size. + + + + + Data bar implementation class. + + + + + Conditional Formatting Value Object (CFVO). + + + + + Minimum size of the structure. + + + + + Specifies how the CFVO value is determined. + + + + + Specifies length of the formula. + + + + + Formula data (RPN token array without size field): + + + + + + + + + + Specifies a static value used to calculate the CFVO value. + + + + + Gets or sets the formula value in Ref3DPtg type. + + + + + Default constructor. + + + + + Parse structure of template parameter. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + CFVO type. + + + + + Size of the formula data. Read-only. + + + + + Parsed formula string. + + + + + Returns bytes of the formula. Read-only. + + + + + CFVO type. + + + + + CFVO value. + + + + + Gets or sets the formula value in Ref3DPtg type. + + + + + Specifies one control point in the interpolation curve. + + + + + Minimum size of the structure. + + + + + Specifies the numerical value of this control point. + + + + + CFVO. + + + + + Default constructor. + + + + + Parse structure of template parameter. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Specifies the numerical value of this control point. + + + + + CFVO. + + + + + Specifies one control point in the gradient curve. + + + + + The numerical value of the control point. + + + + + Type of color. + + + + + Color value. + + + + + Tint and shade. + + + + + Default constructor. + + + + + Parse structure of template parameter. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + The numerical value of the control point. + + + + + Type of color. + + + + + Color value. + + + + + Tint and shade. + + + + + Specifies the threshold value associated with an icon. + + + + + Minimum size of the structure. + + + + + cfvo. + + + + + Whether cell value equal to threshold. + + + + + Undefined. + + + + + Default constructor. + + + + + Parse structure of template parameter. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + CFVO. + + + + + Whether cell value equal to threshold. + + + + + The begin record defines the start of a block of records for a (Graphing) + data object. This record is matched with a corresponding EndRecord. + + + + + The begin record defines the start of a block of records for a (Graphing) + data object. This record is matched with a corresponding EndRecord. + + + + + Minimum size of the record. + + + + + Size of the fixed part. + + + + + Subitem size. + + + + + Need to redraw the conditional format ON status. + + + + + Need to redraw the conditional format OFF status. + + + + + Number of following CF records. + + + + + 1 = Conditionally formatted cells need recalculation or redraw. + + + + + Index of the record. + + + + + Cell range address of the range enclosing all + conditionally formatted ranges. + + + + + Number of conditionally formatted cells. + + + + + Cell range address list of all conditionally formatted ranges. + + + + + Check whether the rule parsed. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserves for record's internal data array iReserve bytes. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Extracts list of cells from the internal data array. + + Data provider to extract cell list from. + Position of the list in the internal data array. + + + + Size of the required storage space. Read-only. + + + + + Adds cell to the cells list. + + Cell to add to the list. + + + + Clone current record. + + Returns clone of the current object. + + + + Number of following CF records. + + + + + 1 = Conditionally formatted cells need recalculation or redraw. + + + + + Index of this record. + + + + + Cell range address of the range enclosing all + conditionally formatted ranges. + + + + + Number of conditionally formatted cells. Read-only. + + + + + Returns list with all conditionally formatted ranges. Read-only. + + + + + Read-only. Minimum possible size of the record. + + + + + Check whether the rule is parsed or not. + + + + + Minimum size of the record. + + + + + Size of the record If the record follow CF12. + + + + + CF12 record. + + + + + Header of this record. + + + + + Specifies whether the containing record specifies a range of cells. + + + + + Specifies whether to alert the user of possible problems when saving the file. + + + + + Cell range address of the range enclosing all + conditionally formatted ranges. + + + + + A boolean that specifies the type of rule this record extends. + Must be one of the following. + 0 - This record extends a rule specified by a CF record and MUST NOT be followed by a CF12 record. + 1 - This record extends a rule specified by a CF12 record and MUST be followed by the CF12 record it extends. + + + + + An integer that specifies which CondFMTRecord record is being extended. + + + + + An integer that specifies a zero based index of CF Record. + + + + + Comparison operator: + 00H = No comparison (only valid for formula type, see above) + 01H = Between + 02H = Not between + 03H = Equal + 04H = Not equal + 05H = Greater than + 06H = Less than + 07H = Greater or equal + 08H = Less or equal + + + + + An integer that specifies the template from which the rule was created. + 0x0000 Cell value + 0x0001 Formula + 0x0002 Color scale formatting + 0x0003 Data bar formatting + 0x0004 Icon set formatting + 0x0005 Filter + 0x0007 Unique values + 0x0008 Contains text + 0x0009 Contains blanks + 0x000A Contains no blanks + 0x000B Contains errors + 0x000C Contains no errors + 0x000F Today + 0x0010 Tomorrow + 0x0011 Yesterday + 0x0012 Last 7 days + 0x0013 Last month + 0x0014 Next month + 0x0015 This week + 0x0016 Next week + 0x0017 Last week + 0x0018 This month + 0x0019 Above average + 0x001A Below Average + 0x001B Duplicate values + 0x001D Above or equal to average + 0x001E Below or equal to average + + + + + An integer that specifies the priority of the rule. + Rules that apply to the same cell are evaluated in increasing order of ipriority. + + + + + A byte that specify the active condition and stop Iftrue option. + + + + + A Boolean that specifies whether cell formatting data is part of this record extension. + Must be one of the following + 0 - No formatting data in this record extension. + 1 - Formatting data is part of this record extension. + + + + + An integer that specifies the size of the structure in bytes. + If greater than zero, it MUST be the total byte count of dfxn and xfext. Otherwise it MUST be zero. + + + + + Size of the Extended Properties. + + + + + Set of properties applied to the XF format + + + + + An integer that specifies the size of the rgbTemplate Parmeters field in bytes. + + + + + Reserved. + + + + + CFEx Default parameter. + + + + + DXFN Structure. + + + + + CFEx filter template parameter. + + + + + CFEx Text template parameter. + + + + + CFEx Date template parameter. + + + + + CFEx Average template parameter. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserves for record's internal data array iReserve bytes. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Parse structure of template parameter. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Serves as a hash function for a particular type, suitable for use in + hashing algorithms and data structures like a hash table. + + A hash code for the current Object. + + + + A hash code for the current Object without taking cell list into account. + + The Object to compare with the current Object. + + + + + Clone current Record. + + Returns memberwise clone on current object. + + + + Cell range address of the range enclosing all + conditionally formatted ranges. + + + + + A boolean that specifies the type of rule this record extends. + + + + + An integer that specifies which CondFmt record is being extended. + + + + + An integer that specifies a zero based index of CF Record. + + + + + Comparison operator: + 00H = No comparison (only valid for formula type, see above) + 01H = Between + 02H = Not between + 04H = Not equal + 05H = Greater than + 06H = Less than + 03H = Equal + 07H = Greater or equal + 08H = Less or equal + + + + + An integer that specifies the template from which the rule was created. + 0x0000 Cell value + 0x0001 Formula + 0x0002 Color scale formatting + 0x0003 Data bar formatting + 0x0004 Icon set formatting + 0x0005 Filter + 0x0007 Unique values + 0x0008 Contains text + 0x0009 Contains blanks + 0x000A Contains no blanks + 0x000B Contains errors + 0x000C Contains no errors + 0x000F Today + 0x0010 Tomorrow + 0x0011 Yesterday + 0x0012 Last 7 days + 0x0013 Last month + 0x0014 Next month + 0x0015 This week + 0x0016 Next week + 0x0017 Last week + 0x0018 This month + 0x0019 Above average + 0x001A Below Average + 0x001B Duplicate values + 0x001D Above or equal to average + 0x001E Below or equal to average + + + + + An integer that specifies the priority of the rule. + + + + + A bit that specifies whether, when a cell fulfills the condition corresponding to this rule, + the lower priority conditional formatting rules that apply to this cell are evaluated. + + + + + A Boolean that specifies whether cell formatting data is part of this record extension. + + + + + An integer that specifies the size of the structure in bytes. + + + + + Properties count. + + + + + Set of properties applied to the XF format. + + + + + Read-only. Maximum possible size of the record. + + + + + Check whether the rule is parsed or not. + + + + + Gets/Sets CF12 record. + + + + + CF12 Top10 class. + + + + + CF12 Above Average class. + + + + + Represents CFEx Filter Parameter + + + + + Specifies whether the top or bottom items are displayed with the conditional formatting. + + + + + Specifies whether a percentage of the top or bottom items are displayed with the conditional formatting, + or whether a set number of the top or bottom items are displayed with the conditional formatting. + + + + + Specifies how many values are displayed with the conditional formatting. + + + + + Top10 implementation. + + + + + Initializes CFEx Filter Parameter + + + + + Copy Filter. + + + + + Clone current Record. + + Returns memberwise clone on current object. + + + + Serves as a hash function for a particular type, suitable for use in + hashing algorithms and data structures like a hash table. + + A hash code for the current Object. + + + + A hash code for the current Object without taking cell list into account. + + The Object to compare with the current Object. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Top or bottom items are displayed with rule. + + + + + Percentage of the top or bottom items are displayed with the rule. + + + + + Specifies how many values are displayed with the rule. + + + + + Top10 implementation. + + + + + CFEx Text Template Parameter + + + + + Specifies the type of text rule. + + + + + Initializes CFEx Template Parameter + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Type of text rule. + + + + + CFEx Date Template Parameter + + + + + Specifies the type of date comparison. + + + + + Initializes CFEx Date Template Parameter + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Type of date comparison operator. + + + + + CFEx Average Template Parameter + + + + + Specifies the number of standard deviations above or below the average for the rule. + + + + + Above Average implementation. + + + + + Initializes CFEx Average Template Parameter + + + + + Copy Average Template Parameters. + + Specifies the conditional formatting rule type. + + + + Clone current Record. + + Returns memberwise clone on current object. + + + + Serves as a hash function for a particular type, suitable for use in + hashing algorithms and data structures like a hash table. + + A hash code for the current Object. + + + + A hash code for the current Object without taking cell list into account. + + The Object to compare with the current Object. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Number of standard deviations of average. + + + + + Above Average implementation. + + + + + Represents DXFN + + + + + Size of the first block of reserved bytes in the font block. + + + + + Size of the second block of reserved bytes in the font block. + + + + + Size of the third block of reserved bytes in the font block. + + + + + Mask for font posture bit. + + + + + Mask for font cancellation (strikethrough) bit. + + + + + Mask for font style modification bit. + + + + + Mask for font cancellation modification bit. + + + + + Mask for left border line style bits. + + + + + Mask for right border line style bits. + + + + + Mask for top border line style bits. + + + + + Mask for bottom border line style bits. + + + + + Mask for left border color bits. + + + + + Mask for right border color bits. + + + + + Mask for top border color bits. + + + + + Mask for bottom border color bits. + + + + + Start bit of left border color bits. + + + + + Start bit of right border color bits. + + + + + Start bit of top border color bits. + + + + + Start bit of bottom border color bits. + + + + + Mask for fill pattern bits. + + + + + Mask for pattern color bits. + + + + + Mask for pattern backcolor bits. + + + + + Start bit of fill pattern bits. + + + + + Start bit of fill pattern back color bits. + + + + + Size of the font block. + + + + + Size of the border block. + + + + + Size of the pattern block. + + + + + Size of the number format block. + + + + + Default color index. + + + + + Option flags + + + + + Not used + + + + + False if left border style and color are modified. + + + + + False if right border style and color are modified. + + + + + False if top border style and color are modified. + + + + + False if bottom border style and color are modified. + + + + + False if pattern style is modified. + + + + + False if pattern color is modified. + + + + + False if pattern background color is modified. + + + + + False if the number format is modified. + + + + + True if record contains number format. + + + + + True if record contains font formatting block. + + + + + True if record contains border formatting block. + + + + + True if record contains pattern formatting block. + + + + + True if record contains the user defined number format. + + + + + Font height. + + + + + Font options. + + + + + Font weight (100-1000, only if font - style = 0). + Standard values are 0190H (400) for normal text + and 02BCH (700) for bold text. + + + + + Escapement type (only if font - esc = 0): + 0000H = None; 0001H = Superscript; 0002H = Subscript + + + + + Underline type (only if font - underl = 0): + 00H = None + 01H = Single + 02H = Double + 21H = Single accounting + 22H = Double accounting + + + + + Font color index or FFFFFFFFH to preserve the cell font color: + + + + + Option flags for modified font attributes: + + + + + 0 = Escapement type modified + + + + + 0 = Underline type modified: + + + + + Border line styles: + + + + + Border line colour indexes: + + + + + Fill pattern style: + + + + + Fill pattern color indexes: + + + + + Unused + + + + + Unsigned integer that specifies the identifier of the number format. + + + + + Unsigned integer that specifies the size of the user defined number format. + + + + + Unsigned integer that specifies character count of the number format string. + + + + + Boolean that specifies whether the characters are in double byte character or not. + + + + + Number format string value. + + + + + Constructor. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Parses font block if it is present in the conditional format. + + Object that provides access to the data. + + Offset to the font block data in the internal data array. + + + + + Parses border block if it is present in the conditional format. + + Object that provides access to the data. + + Offset to the border block data in the internal data array. + + + + + Parses pattern block if it is present in the conditional format. + + Object that provides access to the data. + + Offset to the pattern block data in the internal data array. + + + + + Parses number format block if it is present in the conditional format. + + Object that provides access to the data. + + Offset to the number format block data in the internal data array. + + + + + Parses user defined number format block if it is present in the conditional format. + + Object that provides access to the data. + + Offset to the number format block data in the internal data array. + + + + + Writes font block into internal data array + if it is present in the conditional format. + + Object that provides access to the data. + + Offset where font block should be written. + + + + + Writes border block into internal data array + if it is present in the conditional format. + + Object that provides access to the data. + + Offset where border block should be written. + + + + + Writes pattern block into internal data array + if it is present in the conditional format. + + Object that provides access to the data. + + Offset where pattern block should be written. + + + + + Writes number format block into internal data array + if it is present in the conditional format. + + Object that provides access to the data. + + Offset where number format block should be written. + + + + + Writes number format block into internal data array + if it is present in the conditional format. + + Object that provides access to the data. + + Offset where number format block should be written. + + + + + Size of the required storage space. Read-only. + + + + + Serves as a hash function for a particular type, suitable for use in + hashing algorithms and data structures like a hash table. + + A hash code for the current Object. + + + + Size of the record. + + + + + Specifies the future record. + + + + + Specifies the zoom value in percentage for layout view. + + + + + Specifies whether sheet is in page layout view. + + + + + Specifies whether application displays 'Ruler' + + + + + Specifies whether the margins between pages are hidden in the Page Layout view. + + + + + Default constructor + + + + + Parse the pagelayout view. + + + + + Serialize the page layout view. + + + + + Size of the required storage space. Read-only. + + + + + Specified the zoom value in percentage for layout view. + + + + + Secifies whether sheet is in page layout view. + + + + + Specifies whether the margins between pages are hidden in the Page Layout view. + + + + + Specifies whether application displays 'Ruler' + + + + + This record specifies the plot area layout information for attached label + + + + + Correct record size. + + + + + Specifies the future record type header + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + If the checksum is incorrect, the layout information specified in this record must be ignored + + + + + + A boolean value indicating whether the inner plot area is the layout target. + + + + + Gets or sets xTL value + + + + + Gets or sets yTL value + + + + + Gets or sets xBR value + + + + + Gets or sets yBR value + + + + + Gets or sets WX Layout Mode + + + + + Gets or sets WY Layout Mode + + + + + Gets or sets WWidth Layout Mode + + + + + Gets or sets WHeight Layout Mode + + + + + Gets or sets the value of X + + + + + Gets or sets the value of Y + + + + + Gets or sets the value of Dx + + + + + Gets or sets the value of Dy + + + + + This record specifies the layout information for attached label + + + + + Correct record size. + + + + + Specifies the future record type header + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + If the checksum is incorrect, the layout information specified in this record must be ignored + + + + + + Gets or sets WX Layout Mode + + + + + Gets or sets WY Layout Mode + + + + + Gets or sets WWidth Layout Mode + + + + + Gets or sets WHeight Layout Mode + + + + + Gets or sets X value + + + + + Gets or sets Y value + + + + + Gets or sets Dx value + + + + + Gets or sets Dy value + + + + + Specifies the automatic layout type of the legend. + Used to only to store the information on parsed document + + + + + Specifies the Header structure of this record + + + + + Specifies wheather the workbook checks the Compability of earlier version + + + + + Specifies wheather the workbook checks the Compability of earlier version + + + + + The begin record defines the start of a block of records for a (Graphing) + data object. This record is matched with a corresponding EndRecord. + + + + + Minimum size of the record. + + + + + Subitem size. + + + + + Need to redraw the conditional format ON status. + + + + + Need to redraw the conditional format OFF status. + + + + + Future Header + + + + + Future header attribute. + + + + + Cell range address of the range enclosing all + conditionally formatted ranges. + + + + + Number of following CF12 records. + + + + + 1 = Conditionally formatted cells need recalculation or redraw. + + + + + Index of condFMT12 record + + + + + Number of conditionally formatted cells. + + + + + Cell range address list of all conditionally formatted ranges. + + + + + Check whether the rule parsed. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserves for record's internal data array iReserve bytes. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Extracts list of cells from the internal data array. + + Data provider to extract cell list from. + Position of the list in the internal data array. + + + + Size of the required storage space. Read-only. + + + + + Adds cell to the cells list. + + Cell to add to the list. + + + + Clone current record. + + Returns clone of the current object. + + + + Number of following CF12 records. + + + + + 1 = Conditionally formatted cells need recalculation or redraw. + + + + + Index of the record. + + + + + Bounds of the set of cells to which the rules are applied. + + + + + Number of conditionally formatted cells. Read-only. + + + + + Returns list with all conditionally formatted ranges. Read-only. + + + + + Check whether the rule is parsed or not. + + + + + Specifies the default width for columns that have no specific width set. + + + + + Correct size of the record. + + + + + Column width in characters, using the width of the zero character + with default font (first font record in the file). + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Column width in characters, using the width of the zero character + with default font (first font record in the file). + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record specifies the number of XF records contained in this file and that contains a checksum of the data in those records. + This record MUST exist if and only if there are XFExt records in the file. + + + + + Header of this record + + + + + Specifies the number of XF records + + + + + Specifies the Checksum of the record + This checksum is used to detect whether the XF records in the file were modified by an + application that does not support the formatting feature extensions in XFExt records. + + + + + current parent workbook + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Get the size + + + + + Serves as a hash function for a particular type, suitable for use + in hashing algorithms and data structures like a hash table. + + A hash code for the current Object. + + + + Clone current Record. + + Returns memberwise clone on current object. + + + + Specifies the number of XF records + + + + + CRC checksum + + + + + Represents Extended XF Record + + + + + Start length of Extended XF Record + + + + + Header of this record + + + + + Specifies the index of XF record which is extended + + + + + Property count + + + + + Set of properties applied to the XF format + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for the record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Initialize the variables + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Get the size + + + + + Serves as a hash function for a particular type, suitable for use + in hashing algorithms and data structures like a hash table. + + A hash code for the current Object. + + + + Compares with Extended XF format record. + + Param to compare. + Returns compare results. + + + + Copies data from the current Biff record to the specified Biff record. + + Biff record that will receive data from the current record. + + + + Copies data from the current ExtendedXF record to the specified + ExtendedXF record. + + ExtendedXF record that will receive data from + the current record. + + + + Clone current Record. + + Returns memberwise clone on current object. + + + + + + + + + Specifies the index of XF record which is extended + + + + + Properties count + + + + + Set of properties applied to the XF format + + + + + Represents Extended Property + + + + + Maximum tint value. + + + + + Type of the Extended property + + + + + Size of the Extended property + + + + + Type of the stored color. + + + + + Color value. + + + + + Tint and shade. + + + + + Reserved. + + + + + Font Scheme. + + + + + Text indentation level. + + + + + Gradient type. + + + + + Gradient angle. + + + + + Left coordinate of the inner rectangle. + + + + + Right coordinate of the inner rectangle. + + + + + Top coordinate of the inner rectangle. + + + + + Bottom coordinate of the inner rectangle. + + + + + No. of items in the gradstops. + + + + + Gradient color value. + + + + + Gradient position. + + + + + Gradient tint. + + + + + List of gradient stops. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Parse Full Color + + + + + + + + + Serialize Full Color + + + + + + + + + Parse the gradient. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + Serialize the gradient. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Type of the Extended property + + + + + Size of the color Record + + + + + Color type + + + + + Color value + + + + + Tint value + + + + + Reserved must be ignored. + + + + + Font Sheme. + + + + + Text Indentation level. + + + + + Set of gradstops. + + + + + Represenst Gradient Stops + + + + + Type of the stored color. + + + + + Gradient color value. + + + + + Gradient position. + + + + + Gradient tint. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + This structure specifies a future record type header. + + + + + Type of the following data: + + + + + Option Attribute Flags + + + + + Type of the following data: + + + + + Describes single pivot field group in the pivot table. + + + + + Represents the pivot field group in pivot field. + + + + + + Gets or sets the start date for pivot field grouping. + + The following code illustrates how to get pivot field group and use it for date time grouping. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Input.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create Pivot cache with the given data range + IPivotCache cache = workbook.PivotCaches.Add(worksheet["A1:C8"]); + + //Create "PivotTable1" with the cache at the specified range + IPivotTable pivotTable = worksheet.PivotTables.Add("PivotTable1", worksheet["A1"], cache); + + //Get the pivot group field from pivot field. + IPivotFieldGroup fieldGroup = pivotTable.Fields[0].FieldGroup; + + //Set the pivot field group start date. + fieldGroup.StartDate = new DateTime(2023,5,20); + + workbook.SaveAs("Output.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the end date for pivot field grouping. + + The following code illustrates how to get pivot field group and use it for date time grouping. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Input.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create Pivot cache with the given data range + IPivotCache cache = workbook.PivotCaches.Add(worksheet["A1:C8"]); + + //Create "PivotTable1" with the cache at the specified range + IPivotTable pivotTable = worksheet.PivotTables.Add("PivotTable1", worksheet["A1"], cache); + + //Get the pivot group field from pivot field. + IPivotFieldGroup fieldGroup = pivotTable.Fields[0].FieldGroup; + + //Set the pivot field group end date. + fieldGroup.EndDate = new DateTime(2023,10,3); + + workbook.SaveAs("Output.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the grouping interval for pivot field group.This property only applicable for PivotFieldGroupType days. + + The following code illustrates how to get pivot field group and use it for date time grouping. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Input.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create Pivot cache with the given data range + IPivotCache cache = workbook.PivotCaches.Add(worksheet["A1:C8"]); + + //Create "PivotTable1" with the cache at the specified range + IPivotTable pivotTable = worksheet.PivotTables.Add("PivotTable1", worksheet["A1"], cache); + + //Get the pivot group field from pivot field. + IPivotFieldGroup fieldGroup = pivotTable.Fields[0].FieldGroup; + + //To add date-time groups. + fieldGroup.GroupBy = PivotFieldGroupType.Days; + + //sets the group interval for days. Only when the field is grouped on days. + fieldGroup.GroupInterval = 3; + + workbook.SaveAs("Output.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Represents the PivotCacheFieldImpl Object + + + + + Represents the range grouping properties. + + + + + Represents the discrete range grouping properties. + + + + + Represents wheather the fieldGroup contains the date time + + + + + Represents wheather the fieldGroup contains the number + + + + + Specifies the parent index of this field + + + + + Represents wheather the fieldGroup contains the missing attribute + + + + + Represents the grouping is enabled or not. + + + + + Initializes new instance of pivot field group with the specified parent field index. + + Base field for the group. + Parent field index of the group. + + + + Initializes new instance of pivot field group. + + Base field for the group. + + + + Add values into pivot range group names + + + + + + Fills the discrete group with the specified property indexes and group names. + + Field indexes. + Field group names. + + + + Groups the pivot field on the specified group type. + + + + + + Adds a new cache field and creates a field group of the specified grouping type. + + The pivot cache to add the field to. + The cache field to be added. + The pivot cache field associated with the new cache field. + The grouping type for the new cache field. + A list of items to associate with the new cache field. + The newly created cache field object with the specified pivot field grouping type. + + + + Creates a new pivot cache field with the specified grouping type and updates the PivotItemOptions for associated items. + + The pivot table to which the field is added. + The pivot cache field to create or modify. + The grouping type for the field. + A list of items to associate with the field. + The PivotItemOptions to apply to the items. + + + + Adds a cache field to the pivot field list based on the axis type of the parent field and updated the field orders. + + The pivot table where the field is being added. + The cache field to be added. + The pivot item options associated with the cache field. + The list of pivot field group types. + The index at which the field should be added. + The number of items to add for the cache field. + + + + Reorders related date-time field groups for a specific cache field within a pivot table's axes. + + The pivot table in which the reordering is performed. + The index of the cache field requiring reordering. + + + + Checks whether the list contains any pivot field group type greater than the specified group type. + + The list of pivot field group types to check. + The pivot field group type to compare against. + True if there is a pivot field group type in the list greater than the specified group type; otherwise, false. + + + + Removes specified date time grouping from the field group type. + + The pivot field group type from which specific time intervals will be removed. + + + + Checks if the specified grouping type should be removed from the field list or removed from the PivotCacheField and updates it accordingly. + + The pivot table where the operation is performed. + A dictionary containing field indices and their associated grouping types. + The grouping type to be checked and potentially removed. + The index of the cache field. + The index of the field to be removed. + A boolean indicating whether to order the elements. + + + + Removes a specific grouping field from the pivot table's field list and associated data structures. + + The pivot table from which the field is removed. + The grouping type of the field to be removed. + A dictionary containing field indices and their associated grouping types. + The index of the cache field. + The index of the last field to be removed. + + + + Gets or sets the grouping is enabled or not. + + + + + Gets or sets the index of the parent field. + + + + + Represents the index of the PivotCacheField. Read-only. + + + + + Gets or sets the base of this field. + + + + + Gets the collection of range grouping properties. Read-only. + + + + + Gets or sets the start date for pivot field grouping. + + + + + Gets or sets the end date for pivot field grouping. + + + + + Gets or sets the order of the first pivot field item in the pivot field group. + + + + + Gets or sets the order of the last pivot field item in the pivot field group. + + + + + Gets or sets the pivot field group type for the pivot field group. + + + + + Gets or sets the grouping interval for pivot field group. + + + + + Gets the collection of pivot range group names in the field group. Read-only. + + + + + Gets the collection of pivot discrete group names in the field group. Read-only. + + + + + Gets or sets the collection of items indexes in a field group. + + + + + True if the field group is a Dircrete group. False otherwise. Read-only. + + + + + Gets or set a Boolean value that indicates whether the application uses the source data to + set the ending range value. + + + + + Gets or sets a Boolean value that indicates whether we use source data to set the beginning + range value. + + + + + Gets or sets a Boolean value indicating wheather the fieldGroup contains the date time. + + + + + Gets or sets a Boolean value indicating wheather the fieldGroup contains number. + + + + + Gets or sets a Boolean value indicating wheather the fieldGroup contains missing attribute. + + + + + Represents the Grouping of Field with the range + + + + + Represents the collection of items in a field group. + + + + + Specifies a boolean value that indicates whether the application uses the source data to + set the ending range value. + + + + + Specifies a boolean value that indicates whether we use source data to set the beginning + range value. + + + + + Specifies the ending value for date grouping if autoEnd is false. + + + + + Specifies the ending value for numeric grouping if autoEnd is false. + + + + + Specifies the grouping the field item by + + + + + Specifies the grouping interval for numeric range grouping. Specifies the number of days + to group by in date range grouping. + + + + + Specifies the starting value for date grouping if autoStart is false. + + + + + Specifies the starting value for numeric grouping if autoStart is false. + + + + + Represents the collection of items in a field group. + + + + + Specifies a boolean value that indicates whether the application uses the source data to + set the ending range value. + + + + + Specifies a boolean value that indicates whether we use source data to set the beginning + range value. + + + + + Specifies the ending value for date grouping if autoEnd is false. + + + + + Specifies the ending value for numeric grouping if autoEnd is false. + + + + + Specifies the grouping the field item by + + + + + Specifies the grouping interval for numeric range grouping. Specifies the number of days + to group by in date range grouping. + + + + + Specifies the starting value for date grouping if autoStart is false. + + + + + Specifies the starting value for numeric grouping if autoStart is false. + + + + + Represents the collection of items in a field group. + + + + + Represents the collection of item indexes + + + + + Represents the collection of items in a field group. + + + + + Represents the collection of item indexes + + + + + Represents pivot area. + + + + + The region of the PivotTable to which this rule applies. + + + + + Flag indicating whether any indexes refer to fields or items in the Pivot cache and not the + view. + + + + + Flag indicating whether any indexes refer to fields or items in the Pivot cache and not the + view. + + + + + Flag indicating whether only the data values (in the data area of the view) for an item + selection are selected and does not include the item labels. + + + + + Index of the field that this selection rule refers to. + + + + + Position of the field within the axis to which this rule applies. + + + + + Flag indicating whether the column grand total is included. + + + + + Flag indicating whether the row grand total is included. + + + + + Flag indicating whether only the item labels for an item selection are selected and does + not include the data values (in the data area of the view). + + + + + A Reference that specifies a subset of the selection area. Points are relative to the top + left of the selection area. + + + + + Flag indicating whether the rule refers to an area that is in outline mode. + + + + + Indicates the type of selection rule. + + + + + Pivot Area references + + + + + Flag indicating whether the pivotArea is added for sorting. + + + + + Flag indicating whether the collapsed levels are subtotals in the pivot area. + + + + + Represent pivot area range address + + + + + Represent internal reference collection + + + + + Represents the parent pivot table. + + + + + Initializes the PivotArea + + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + A hash code for the current Object without taking cell list into account. + + The Object to compare with the current Object. + + + + + Gets or sets the region of the PivotTable to which this rule applies. + + + + + Gets or sets a flag indicating whether any indexes refer to fields or items in the Pivot cache and not the + view. + + + + + Gets or sets a flag indicating whether any indexes refer to fields or items in the Pivot cache and not the + view. + + + + + Gets or sets a flag indicating whether only the data values (in the data area of the view) for an item + selection are selected and does not include the item labels. + + + + + Gets or sets the index of the field that this selection rule refers to. + + + + + Gets or sets the position of the field within the axis to which this rule applies. + + + + + Gets or sets a flag indicating whether the column grand total is included. + + + + + Gets or sets a flag indicating whether the row grand total is included. + + + + + Gets or sets a flag indicating whether only the item labels for an item selection are selected and does + not include the data values (in the data area of the view). + + + + + + Gets or sets a flag indicating whether the rule refers to an area that is in outline mode. + + + + + Gets or sets the type of the selection rule. + + + + + Pivot Area references + + + + + First Index of the Reference + + + + + Flag indicating whether the pivotArea is added for sorting. + + + + + Flag indicating whether the collapsed levels are subtotals in the pivot area. + + + + + Represent pivot area range address + + + + + Represent internal reference collection + + + + + Represents the parent pivot table. + + + + + Represents a set of selected fields and selected items within those fields + + + + + Represents the Subtotal type + + + + + Specifies a boolean value that indicates whether the item is referred to by position rather + than item index. + + + + + Specifies the number of item indexes in the collection of indexes + + + + + Specifies the index of the field to which this filter refers. A value of -2 indicates the 'data' + field. + + + + + Specifies a boolean value that indicates whether the item is referred to by a relative + reference rather than an absolute reference + + + + + Specifies a boolean value that indicates whether this field has selection. This attribute is + used when the PivotTable is in Outline view. + + + + + Represents the indexes of the selected fileds + + + + + Specifies a boolean value that indicates whether this field has subtotal. + + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + A hash code for the current Object without taking cell list into account. + + The Object to compare with the current Object. + + + + + Check whether two list values are eqaul or not. + + + + + + + + Represents the Subtotal type + + + + + Specifies a boolean value that indicates whether the item is referred to by position rather + than item index. + + + + + Specifies the number of item indexes in the collection of indexes + + + + + Specifies the index of the field to which this filter refers. A value of -2 indicates the 'data' + field. + + + + + Specifies a boolean value that indicates whether the item is referred to by a relative + reference rather than an absolute reference + + + + + Specifies a boolean value that indicates whether this field has selection. This attribute is + used when the PivotTable is in Outline view. + + + + + Represents the indexes of the selected fileds + + + + + First index in the indexes + + + + + Specifies a boolean value that indicates whether this field has subtotal. + + + + + Represents the conditional formatting defined in the PivotTable. + + + + + Specifies the priority of PivotTable conditional formatting rule + + + + + Specifies the scope of PivotTable conditional formatting rule. + + + + + This simple type defines the values for the Top N conditional formatting evaluation for the PivotTable + + + + + Area in which the conditional format applied + + + + + Represents a single item in PivotTable field. + + + + + Specifies boolean value that indicates whether the pivotItemOptions properties has true, defulat false. + + + + + Specifies a boolean value that indicates whether the approximate number of child items + for this item is greater than zero. + + + + + Specifies a boolean value that indicates whether this item has been expanded in the + PivotTable view. + + + + + Specifies a boolean value that indicates whether attribute hierarchies nested next to + each other on a PivotTable row or column will offer drilling "across" each other or not + + + + + Specifies a boolean value that indicates whether this item is a calculated member + + + + + Specifies a boolean value that indicates whether the item is hidden. + + + + + Specifies a boolean value that indicate whether the item has a missing value. + + + + + Specifies the user caption of the item. + + + + + Specifies a boolean value that indicates whether the item has a character value. + + + + + Specifies a boolean value that indicates whether the details are hidden for this item. + + + + + Specifies the type of the item. Value of 'default' indicates a grand total as the last row + item value + + + + + Initializes the pivot item options + + + + + Gets and sets a boolean value that indicates whether the pivotItemOptions properties has true, defulat false. + + + + + Gets or sets a Boolean value that indicates whether the pivot filed item has child items. + + + + + Gets or sets a Boolean value indicating whether this item is expanded in the + PivotTable view. + + + + + Gets or sets a Boolean value that indicates whether attribute hierarchies nested next to + each other on a PivotTable row or column will offer drilling "across" each other or not. + + + + + Gets or sets a Boolean value indicating whether this item is a calculated item. + + + + + True if the item is hidden. False Otherwise. + + + + + True if the item has a missing value. False otherwise. + + + + + Gets or sets the user caption of the item. + + + + + True if the item has a character value. False Otherwise. + + + + + Gets or sets a Boolean value that indicates whether the details for this item are hidden. + + + + + Gets or sets the type of the item. Value of 'default' indicates a grand total as the last row + item value. + + + + + This class is repsonsible for parse pivot cache part + + + + + Default regular expression options. + + + + + Parse pivot cache definition. + + XmlReader to parse from + Cache to parse. + Current workbook. + path of the parent + Relation id to the pivot cache records. + + + + Creates the Cache Record Reader from the relation part + + corresponding pivot cache record id + parent path + workbook of the pivot cache + relations collection of the pivot cache records + XmlReader of the Pivot cache record + + + + Parse cache source. + + XmlReader to Parse from. + Cache to parse. + Parent book of the cache + relation collection of the cache source + + + + Parsing the consolidation source of the pivottable + + + + + + + + + Parses the pivot cache worksheet source + + XmlReader for parse + cache to preserve the data + parent book of the cache + relation collection of the worksheet source + + + + Gets the table named range matching the given string. + + The string to be searched in table named ranges. + The table containg the named ranges. + The workbook object. + The table named range that matches with given string. + + + + Parses the pivot cache external worksheet source + + XmlReader for parse + cache to preserve the data + parent book of the cache + relation collection of the worksheet source + + + + Parse cache fields. + + XmlReader to parse from. + Fields collection. + + + + Parse cache Cache Field. + + XmlReader to parse from. + Field to serialize. + + + + Parse the Pivot Cache Field values + + XmlReader to parse from. + Field to Pares shared items + + + + Parse pivot cache definition. + + XmlReader to parse from. + Cache to Parse. + + + + Parse Cache Record Rows + + XmlReader to parse + cache to parse + Rows Count + + + + Parse cache single row from the records + + XmlReader to parse + cache to parse the records + current row index to parse + parsed row records + + + + Rule describing a PivotTable selection. + + XmlReader to parse + Pivot Area to parse + + + + Parsses the Pivot Area selection reference + + Xml Readers to read tags + pivot area to parse References + + + + Get internal reference from parent. + + Parent internal reference. + Reference count. + Collection of internal reference list. + + + + Get internal reference from parent. + + Parent internal reference. + Collection of internal reference. + + + + Parse Pivot Area Reference + + Xml Reader to read tags + Pivot Area reference + + + + Parse the pivot cache extension + + Xml Reader to read tags. + Pivot cache to parse. + + + + Parse Pivot cache hiearachy + + Xml Reader to read tags. + Pivot cache to parse. + + + + Parse Pivot Key Performance Indicators (KPIs) defined in the OLAP. + + Xml Reader to read tags. + Pivot cache to parse. + + + + Parse PivotTable OLAP dimension collection. + + Xml Reader to read tags. + Pivot cache to parse. + + + + Parses the PivotTable OLAP measure group - Dimension maps + + Xml Reader to read tags. + Pivot cache to parse. + + + + Parses the PivotTable OLAP Dimension maps. + + Xml Reader to read tags. + Pivot cache to parse. + + + + Moves to attribute and parse int attribute + + XmlReader to parse from + attribute name to parse + parsed int value + + + + Moves to attribute and parse int attribute + + XmlReader to parse from + attribute name to parse + parsed int value + + + + Moves to attribute and parse bool value + + XmlReader to parse from + attribute to parse + bool value + + + + Moves to attribute and parse bool value + + XmlReader to parse from + attribute to parse + bool value + + + + Moves to attribute and parse string value + + XmlReader to parse from + attribute to parse + string value + + + + This class is repsonsible for parse hte pivot table part + + + + + Index of the data m_bRefreshOnLoad. + + + + + Parse Extern List of Pivot table Definition + + Xml reader to extract from. + + + + + Parse Extension of Pivot table Definition + + Xml reader to extract from + + + + + + Parse chart formats of the pivot chart that is associated with this PivotTable. + + Xml reader to extract from. + + + + + Parse the Pivot custom formats styles. + + + + + Parse the dxfs styles to store list. + + Return file data holder, used for parse the dxfs collection + + + + Parse pivot custom formats collection. + + Xml reader to extract from. + >PivotTable to serialize pivot custom formats for. + List of dxf in the workbook. + + + + Parse pivot custom format. + + Xml reader to extract from. + >PivotTable to serialize pivot custom formats for. + >Dxf id to be extracted. + + + + Parsing pivot filters of pivot tables + + + + + + + Parsing pivot filter of filter collections + + + + + + + Parsing autofilter of pivot table + + + + + + + Parsing filter column filter of pivot table filter + + + + + + + Parsing custom filter type of pivot table. + + + + + + + Parsing custom filter of custom filter collection of pivot filter. + + + + + + + Parsing filter column filter of pivot filter + + + + + + + Parsing Top 10 filter of pivot filter. + + + + + + + Parse dynamic filter. + + Reader to get data from. + Dynamic filter collection to put data into. + + + + Serializes pivot table location. + + XmlWriter to serialize location into. + Pivot table to serialize location for. + + + + Parse pivot fields. + + XmlReader to Parse fields from. + Pivot table to serialize fields for. + + + + Serializes single pivot m_bRefreshOnLoad. + + XmlWriter to serialize pivot m_bRefreshOnLoad into. + Field to serialize. + + + + Parse the extension list in pivot field + + XmlReader to parse from. + pivot field object. + + + + Parse the extension in the pivot field extension list. + + XmlReader to parse from. + pivot field object. + + + + Parse the attributes in the pivot field's extension + + XmlReader to parse from. + pivot field object. + + + + Parse the Sorting scope of the pivot field + + XmlReader to parse from. + pivot field object. + + + + Serializes subtotal value. + + XmlWriter to serialize into. + Subtotal type to serialize. + + + + Serializes data fields. + + XmlWriter to serialize fields into. + PivotTable to serialize data fields for. + + + + Parses the data Field of the pivot table + + XmlWriter to serialize data m_bRefreshOnLoad into. + Field to serialize. + + + + Parses the condition formats of the pivot table. + + XmlReader to parses from. + extract the pivot table . + + + + Parses the OLAP hierarchies associated with the PivotTable. + + XmlReader to parses from. + extract the pivot table . + + + + Parses references to OLAP hierarchies on the row axis of a PivotTable. + + XmlReader to parses from. + extract the pivot table . + + + + Parses references to OLAP hierarchies on the column axis of a PivotTable. + + XmlReader to parses from. + extract the pivot table . + + + + This class represents value-index pair and used to sort pivot m_bRefreshOnLoad values. + + + + + This structure specifies the clipboard format of the picture-type. + + + + + Base class for all obj subrecords. + + + + + Size of the header data. + + + + + Type of the subrecord. + + + + + Length of the subrecord's data. + + + + + Private constructor. To prevent creation without parameters. + + + + + Initializes new instance. + + Type of the subrecord. + + + + Initializes new instance. + + Type of the subrecord. + Length of the subrecord's data. + Array that contains subrecord's data. + + + + Parses byte array. + + Array to parse. + + + + Fills array with binary representation of the subrecord. + + Object that provides access to the data. + Offset in the buffer to copy data to. + + + + Serializes record's data. + + Provider to serialize into. + Offset to start serialization from. + + + + Size of the required storage space. Read-only. + + + + + Clones current objects. + + Returns instance of cloned object. + + + + Type of the subrecord. + + + + + Length of the subrecord's data. + + + + + Correct record size. + + + + + Represents the windows clipboard format of the data associated with the picture. + + + + + Internal data array. + + + + + Initializes new instance of subrecord. + + Type of the subrecord. + Length of the subrecord's data. + Buffer that contains subrecord's data. + + + + Parses byte array. + + Array to parse. + + + + Fills array with binary representation of the subrecord. + + Object that provides access to the data. + Offset in the buffer to copy data to. + + + + Clones current objects. + + + Returns instance of cloned object. + + + + + Size of the required storage space. Read-only. + + + + + Represents the windows clipboard format of the data associated with the picture. + + + + + ActiveX control Structure. + + + + + Correct record size. + + + + + Indicates whether this control is an ActiveX control. + + + + + Internal data array. + + + + + Initializes new instance of subrecord. + + Type of the subrecord. + Length of the subrecord's data. + Buffer that contains subrecord's data. + + + + Parses byte array. + + Array to parse. + + + + Fills array with binary representation of the subrecord. + + Object that provides access to the data. + Offset in the buffer to copy data to. + + + + Clones current objects. + + Returns instance of cloned object. + + + + Size of the required storage space. Read-only. + + + + + Indicates whether this control is an ActiveX control. + + + + + Vba project class + + + + + Vba Project constuctor. + + Parent + + + + Constructor + + Parent + Vba project root storage + + + + Parses the Vba Storage + + Vba storage + + + + Parse dir stream + + Vba root storage + + + + Parse Module Stream + + + + + + Parse Project stream + + Vba root storage + + + + Parses the designer module. + + Vba root storage + + + + Saves the Vba project into compound storage + + Vba root storage + + + + Serializes Vba project + + Vba root storage + + + + Creates Vba Project stream + + Root storage + + + + Creates Dir stream + + + + + Creates module stream + + + + + Creates project stream. + + Root storage + + + + Creates project wm stream + + Root storage + + + + Serialize designer storages. + + Root storage + + + + Specifies the Parent for the Vba project + + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + + Looks up a localized string similar to 0 #825600;8520f #ffa800;18350f #825600;28180f #ffa800;38011f #825600;47186f #ffa800;57016f #825600;1 #ffa800. + + + + + Looks up a localized string similar to 0 #ccf;11796f #9cf;23593f #96f;39977f #c9f;53740f #9cf;1 #ccf. + + + + + Looks up a localized string similar to 0 white;10486f #1f1f1f;11796f white;27525f #636363;34734f #cfcfcf;43254f #cfcfcf;49807f #1f1f1f;51773f white;1 #7f7f7f. + + + + + Looks up a localized string similar to 0 #cbcbcb;8520f #5f5f5f;13763f #5f5f5f;41288f white;43909f #b2b2b2;45220f #292929;53740f #777;1 #eaeaea. + + + + + Looks up a localized string similar to 0 #5e9eff;26214f #85c2ff;45875f #c4d6eb;1 #ffebfa. + + + + + Looks up a localized string similar to 0 #fc9fcb;8520f #f8b049;13763f #f8b049;41288f #fee7f2;43909f #f952a0;45220f #c50849;53740f #b43e85;1 #f8b049. + + + + + Looks up a localized string similar to 0 #000082;19661f #66008f;42598f #ba0066;58982f red;1 #ff8200. + + + + + Looks up a localized string similar to 0 #fff200;29491f #ff7a00;45875f #ff0300;1 #4d0808. + + + + + Looks up a localized string similar to 0 #8488c4;34734f #d4deff;54395f #d4deff;1 #96ab94. + + + + + Looks up a localized string similar to 0 #e6dcac;7864f #e6d78a;19661f #c7ac4c;29491f #e6d78a;50463f #c7ac4c;1 #e6dcac. + + + + + Looks up a localized string similar to 0 #fbe4ae;8520f #bd922a;13763f #bd922a;41288f #fbe4ae;43909f #bd922a;45220f #835e17;53740f #a28949;1 #fae3b7. + + + + + Looks up a localized string similar to 0 #dcebf5;5243f #83a7c3;8520f #768fb9;13763f #83a7c3;34079f white;36700f #9c6563;38011f #80302d;46531f #c0524e;61604f #ebdad4;1 #55261c. + + + + + Looks up a localized string similar to 0 black;13107f #000040;.5 #400040;.75 #8f0040;58982f #f27300;1 #ffbf00. + + + + + Looks up a localized string similar to 0 #d6b19c;19661f #d49e6c;45875f #a65528;1 #663012. + + + + + Looks up a localized string similar to 0 #ddebcf;.5 #9cb86e;1 #156b13. + + + + + Looks up a localized string similar to 0 black;26214f #0a128c;45875f #181cc7;57672f #7005d4;1 #8c3d91. + + + + + Looks up a localized string similar to 0 #03d4a8;.25 #21d6e0;.75 #0087e6;1 #005cbf. + + + + + Looks up a localized string similar to 0 #ffefd1;42598f #f0ebd5;1 #d1c39f. + + + + + Looks up a localized string similar to 0 #39f;10486f #0cc;30802f #99f;39322f #2e6792;46531f #33c;53084f #1170ff;1 #069. + + + + + Looks up a localized string similar to 0 #a603ab;13763f #0819fb;22938f #1a8d48;34079f yellow;47841f #ee3f17;57672f #e81766;1 #a603ab. + + + + + Looks up a localized string similar to 0 #f39;.25 #f63;.5 yellow;.75 #01a78f;1 #36f. + + + + + Looks up a localized string similar to 0 #000082;8520f #0047ff;18350f #000082;28180f #0047ff;38011f #000082;47186f #0047ff;57016f #000082;1 #0047ff. + + + + + Looks up a localized string similar to 0 white;4588f #e6e6e6;20972f #7d8496;30802f #e6e6e6;55706f #7d8496;1 #e6e6e6. + + + + + Looks up a localized string similar to 0 #fbeac7;11796f #fee7f2;23593f #fac77d;39977f #fba97d;53740f #fbd49c;1 #fee7f2. + + + + + FormulaInfo maintains information on a single formula object. + + + + + A property that gets/sets the text of the initial formula. + + + + + A property that gets/sets the last computed value of this formula. + + + + + A property that gets/sets the formula as a parsed string. + + + + + Event delegate for ExternalFormulaEventArgs event. + + The CalcEngine. + The for this event. + + + + The event args for the ExternalFormulaEventArgs event, which is raised whenever the CalcEngine calculate external reference formula. + + + + + Event delegate for ExternalFormulaEventArgs event. + + The CalcEngine. + The for this event. + + + + The event args for the ExternalFormulaEventArgs event, which is raised whenever the CalcEngine is trying to get external worksheet from external reference formula. + + + + + Event delegate for ExternalFormulaEventArgs event. + + The CalcEngine. + The for this event. + + + + The event args for the ExternalFormulaEventArgs event, which is raised whenever the CalcEngine is trying to get external named range address from external reference formula. + + + + + Event delegate for the FormulaParsing event + + + + + Used by the event, FormulaParsingEventArgs holds a reference + to the string that is to be parsed. The FormulaParsing event allows the listener to preprocess + the string that is being parsed. + + + Please note that this event may be raised more than once as a string is parsed. + + Here is code snippets that show how to tell a engine to also treat any text in a formula cell + that begins with a minus(-) or a plus(+) as formulas. The default behavior is to treat only text beginning + with equal(=) as formulas. + + //subscribe to the event before any formulas are loaded into the grid... + Engine.FormulaParsing += new FormulaParsingEventHandler(Engine_FormulaParsing); + + //Here is the handler code that adds an = if necessary so any string beginning with +, - or = + //is treated as a formula. + void Engine_FormulaParsing(object sender, FormulaParsingEventArgs e) + { + //allow cells starting with + and - to be treated as formula cells. + if (e.Text.StartsWith("-")) + e.Text = "=" + e.Text; + else if (e.Text.StartsWith("+")) + e.Text = "=" + e.Text.Substring(1); + } + + + + + + Holds a reference to the string that is to be parsed.. + + The formula that is to be parsed. + + + + Default constructor. + + + + + A property that gets/sets the formula about to be parsed. + + + + + Event delegate for UnknownFunction event. + + The CalcEngine. + The for this event. + + + + The event args for the UnknownFunction event which is raised whenever the CalcEngine encounters a function + that is does not know. + + + + + Gets the name of the unknown function. + + + + + Gets the location of the missing function. + + + + + Event delegate for UpdateNamedRange event. + + The CalcEngine. + The for this event. + + + + The event args for the UpdateNamedRange event, which is raised whenever the CalcEngine calculate the intersection range of two named range . + + + + + Represents the method that will handle FormulaComputed event. + + Source of this event. + An instance of that contains the event data. + + + + Represents a class which holds the properties of FormulaComputed event. + + + + + Initializes a new instance of the FormulaComputedEventArgs class. + + Currently calculated formula. + The CalculatedValue for the formula. + The currently calculating cell address. + Returns true if the currently calculating formula is interior formula;else false. + + + + Gets the currently calculated formula name. + + + + + Gets or sets the value for the calculated formula. + + + + + Gets the currently calculated formula's cell reference. + + + + + Gets the value whether the currently calculated formula is interior formula or not. + + Returns true if the currently calculated formula is interior formula;else false. + + + + Gets the value whether to handle the calculation of the formula. + + To handle the calculation of the formula. + + + + The CustomComparer class provides a mechanism for comparing two strings based on a custom comparison logic. + It implements the interface to allow sorting or ordering operations on collections + of strings using the specified comparison logic. + + + This class is particularly useful when you need to perform custom sorting or ordering of strings in a collection, + such as a list or array. The comparison logic is provided via a delegate, which + allows flexibility in defining how two strings should be compared. + + + + + Initializes a new instance of the class with the specified comparison logic. + + A delegate that defines the logic for comparing two strings. + + + + Compares two strings and returns a value indicating whether one is less than, equal to, or greater than the other. + + The first string to compare. + The second string to compare. + + A signed integer that indicates the relative values of and : + + Less than zero: is less than . + Zero: equals . + Greater than zero: is greater than . + + + + + + Encapsulates the properties that are needed to support multiple families of crossed-referenced grids. + This class is for internal use only. + + + + + Holds mapping from parent object to sheet token. + + + + + Holds mapping from sheet token to parent object. + + + + + Holds mapping from parent object to sheet name. + + + + + Holds mapping from sheet name to parent object. + + + + + A class that allows you to quickly add calculation support for controls on a form, or usercontrol. + + + To use CalcQuick, you instantiate an instance of the class. Then just by indexing the + class object with string names to identify a formula object, you can have calculation support + in your form. Alternatively, you can add a collection of Control-derived objects and the + CalcQuick object will bind the Control.Text property allowing you to use the Control/Name property + to reference other controls in a formula. + + + Here is code that uses three TextBoxes, the first showing a value for an angle in degrees, + and the other two displaying the sine and cosine of this angle. In this code, the calculations + are done on the click of a button: + + CalcQuick calculator = null; + private void AngleForm_Load(object sender, System.EventArgs e) + { + //TextBox Angle = new TextBox(); + this.Angle.Name = "Angle"; + this.Angle.Text = "30"; + //cosTB = new TextBox(); + this.cosTB.Name = "cosTB"; + this.cosTB.Text = "= cos([Angle] * pi() / 180) "; + //sinTB = new TextBox(); + this.sinTB.Name = "sinTB"; + this.sinTB.Text = "= sin([Angle] * pi() / 180) "; + // Instantiate the CalcQuick object: + this.calculator = new CalcQuick(); + } + // Perform a manual calculation: + private void ComputeButton_Click(object sender, System.EventArgs e) + { + // Let the calculator know the values/formulas + // by using an indexer on the calculator object. + // Here we are using the TextBox.Name as the indexer key + // provided to the calculator object. This is not required. + // The only restriction for the indexer key values is that they + // be unique nonempty strings: + this.calculator["Angle"] = this.Angle.Text; + this.calculator["cosTB"] = this.cosTB.Text; + this.calculator["sinTB"] = this.sinTB.Text; + // Mark the calculator dirty: + this.calculator.SetDirty(); + // Now as the values are retrieved from the calculator, they + // will be the newly calculated values: + this.cosTB.Text = this.calculator["cosTB"]; + this.sinTB.Text = this.calculator["sinTB"]; + } + + + Dim calculator As CalcQuick = Nothing + Private Sub AngleForm_Load(sender As Object, e As System.EventArgs) + 'TextBox Angle = new TextBox(); + Me.Angle.Name = "Angle" + Me.Angle.Text = "30" + 'cosTB = new TextBox(); + Me.cosTB.Name = "cosTB" + Me.cosTB.Text = "= cos([Angle] * pi() / 180) " + + 'sinTB = new TextBox(); + Me.sinTB.Name = "sinTB" + Me.sinTB.Text = "= sin([Angle] * pi() / 180) " + + 'Instantiate the CalcQuick object: + Me.calculator = New CalcQuick() + End Sub 'AngleForm_Load + + 'Perform a manual calculation: + Private Sub ComputeButton_Click(sender As Object, e As System.EventArgs) + 'Let the calculator know the values/formulas + 'by using an indexer on the calculator object. + 'Here we are using the TextBox.Name as the indexer key + 'provided to the calculator object. This is not required. + 'The only restriction for the indexer key values is that they + 'be unique nonempty strings: + Me.calculator("Angle") = Me.Angle.Text + Me.calculator("cosTB") = Me.cosTB.Text + Me.calculator("sinTB") = Me.sinTB.Text + + 'Mark the calculator dirty: + Me.calculator.SetDirty() + + 'Now as the values are retrieved from the calculator, they + 'will be the newly calculated values: + Me.cosTB.Text = Me.calculator("cosTB") + Me.sinTB.Text = Me.calculator("sinTB") + End Sub 'ComputeButton_Click + + Here is code that uses the same three TextBoxes as above, but this time + the code is set up to automatically compute things as you change the + value in the Angle TextBox. There is no longer a need for a button handler + to trigger setting / getting values. + + CalcQuick calculator = null; + + private void AngleForm_Load(object sender, System.EventArgs e) + { + //TextBox Angle = new TextBox(); + this.Angle.Name = "Angle"; + this.Angle.Text = "30"; + + //cosTB = new TextBox(); + this.cosTB.Name = "cosTB"; + this.cosTB.Text = "= cos([Angle] * pi() / 180) "; + + //sinTB = new TextBox(); + this.sinTB.Name = "sinTB"; + this.sinTB.Text = "= sin([Angle] * pi() / 180) "; + + // Instantiate the CalcQuick object: + this.calculator = new CalcQuick(); + } + + // Perform a manual calculation: + private void ComputeButton_Click(object sender, System.EventArgs e) + { + // Let the calculator know the values/formulas + // by using an indexer on the calculator object. + // Here we are using the TextBox.Name as the indexer key + // provided to the calculator object. This is not required. + // The only restriction for the indexer key values is that they + // be unique nonempty strings: + this.calculator["Angle"] = this.Angle.Text; + this.calculator["cosTB"] = this.cosTB.Text; + this.calculator["sinTB"] = this.sinTB.Text; + + // Mark the calculator dirty: + this.calculator.SetDirty(); + + // Now as the values are retrieved from the calculator, they + // will be the newly calculated values: + this.cosTB.Text = this.calculator["cosTB"]; + this.sinTB.Text = this.calculator["sinTB"]; + } + + + Dim calculator As CalcQuick = Nothing + + Private Sub AngleForm_Load(sender As Object, e As System.EventArgs) + 'TextBox Angle = new TextBox(); + Me.Angle.Name = "Angle" + Me.Angle.Text = "30" + + 'cosTB = new TextBox(); + Me.cosTB.Name = "cosTB" + Me.cosTB.Text = "= cos([Angle] * pi() / 180) " + + 'sinTB = new TextBox(); + Me.sinTB.Name = "sinTB" + Me.sinTB.Text = "= sin([Angle] * pi() / 180) " + + 'Instantiate the CalcQuick object: + Me.calculator = New CalcQuick() + End Sub 'AngleForm_Load + + 'Perform a manual calculation: + Private Sub ComputeButton_Click(sender As Object, e As System.EventArgs) + 'Let the calculator know the values/formulas + 'by using an indexer on the calculator object. + 'Here we are using the TextBox.Name as the indexer key + 'provided to the calculator object. This is not required. + 'The only restriction for the indexer key values is that they + 'be unique nonempty strings: + Me.calculator("Angle") = Me.Angle.Text + Me.calculator("cosTB") = Me.cosTB.Text + Me.calculator("sinTB") = Me.sinTB.Text + + 'Mark the calculator dirty: + Me.calculator.SetDirty() + + 'Now as the values are retrieved from the calculator, they + 'will be the newly calculated values: + Me.cosTB.Text = Me.calculator("cosTB") + Me.sinTB.Text = Me.calculator("sinTB") + End Sub 'ComputeButton_Click + + + + + + Returns the value as false + + + + + Default constructor: + + Use this constructor when you want to have + several CalcQuick objects that access the same + static members of the CalcEngine. + + + + + Constructor that resets the CalcEngine object. + + + Indicates whether the static members of the CalcEngine class will be cleared. + + + + A method to reset all the keys registered with CalcQuickBase object. + + + + + Creates the object used by this CalQuick object. + + Returns an instance of a CalcEngine object. + You can override this method and return a derived CalcEngine object use + by the derived CalcQuick object. + + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + A method that parses and computes a well-formed algebraic expression passed in. + + The text of the formula. + The computed value. + You would use this method if you have a formula string which + contains only constants or library function references. Such formulas + do not depend upon other values. If you have registered a variable through + an indexer, then that variable can be used in a formula expression passed into this + method. This method will return the Exception text if an exception is thrown + during the computation. + + + + + A method that returns the formula string associated with the key passed in from a FormulaInfo object. + + The Hashtable key associated with the FormulaInfo object. + The formula string may be the empty string if no formula is stored with this key. + + + + A method to get the value of the cell referred. For internal CalcQuick use only. + + Row index. + Column index. + (row, col) data. + + CalcQuick does not expose a (row, col) data access model. + But since CalcEngine requires such a model, CalcQuick uses + a row, col access model internally, but only exposes the + formula Key model to access values. + + + + + Initializes any structures needed by this instance. + + + Indicates whether the static members of the CalcEngine class will be cleared. + + + + A method that parses and computes a well-formed algebraic expression passed in. + + The text of the formula. + The computed value. + You would use this method if you have a formula string which + contains only constants or library function references. Such formulas + do not depend upon other values. If you have registered a variable through + an indexer, then that variable can be used in a formula expression passed into this + method. + + + + + A method that recompute any formulas stored in the CalcQuick instance. + + + This method only has is used when AutoCalc is False. It loops through + all FormulaInfo objects stored in the CalcQuick object and recomputes + any formulas. + + + + + A method to force all calculations to be performed the next time the CalcQuick object is + accessed with an indexer requesting the value. + + + Each FormulaInfo object contained in the CalcQuick instance + has a calculation index that is checked any time the computed value is needed. If this index + is current, no calculation is done, and the last computed value is returned. If this index + is not current, the calculation is redone before the value is returned. Calling this method + guarantees that no FormulaInfo object's calculation indexes will be current. + + + + + A method to set value to the specified cell. For internal CalcQuick use only. + + + + + Loops through and updates all formula items that depend + on the FormulaInfo object pointed to by the key. + + Identifies FormulaInfo object that triggered the update. + + + + A method that wires the ParentObject after the CalcQuick object is created. For internal CalcQuick use only. + + + + + Get the idex of the first row in UsedRange + + index of first row + + + + get the index of the last row in UsedRange + + index of last row + + + + This API supports the .NET Framework infrastructure and is not intended to be used directly from your code + + + + + + Gets the first column index. + + Index of first column + + + + Gets the last column index / column count. + + Index of last column + + + + This API supports the .NET Framework infrastructure and is not intended to be used directly from your code + + + + + + For internal CalcQuick use only. + + + + + Occurs when one of the FormulaInfo objects being + maintained by the CalcQuick instance has changed. + + + + + A property that gets/sets the auto calculation mode of the CalcQuick. + + + By default, the CalcQuick will not update other values when you change + a FormulaInfo object. By default, you explicitly call SetDirty() + of the CalcQuick instance to force calculations to be done the next time + they are required. Setting AutoCalc to True tells the CalcQuick to maintain + the dependency information necessary to automatically update + dependent formulas when values that affect these formulas change. + + + + + Gets or sets whether formulas should be checked for syntax during key substitutions. Default is true. + + + Prior to version 4.4, no syntax checking was performed during the initial parsing process of substituting + for keys (variable names enclosed in square brackets). This early syntax checking support has been added to + catch cases where a keys was not preceded (or followed) properly in the formula. This CheckKeys property + is available for backward compatibility. To maintain the exact parsing algorithm found in versions + prior to 4.4, set this property to false. + + + + + Maintains a set of modified flags indicating whether + any control has had a value changed. + + + + + Maintains a collection of FormulaInfo objects. + + + This Hashtable serves as the data store for the + CalcQuick instance. The keys are the strings used + to identify formulas and the values are FormulaInfo + objects that hold the information on each formula or value. + + + + + Determines whether the CalcEngine object of this CalcQuick should be disposed on disposing this object. + Default value is true. + + + + + A read-only property that gets the reference to the CalcEngine object being used by this CalcQuick instance. + + + + + A property that gets/sets character by which string starts with, are treated as + formulas when indexing a CalcQuick object. + + If you use the technique of indexing the CalcQuick object + to set a varaible value, then you indicate that the value should be a + formula by starting the string with this character. If you do not want + to require your formulas to start with this character, then you will not + be able to use the indexing technique. Instead, you will have to call + ParseAndCompute directly to handle formulas not starting with this + character. + + + + Maintains a mapping between the string key and the row + used in a CalcSheet to identify a FormulaInfo object. + + + + + Maintains a mapping between the string key and a + vector of numbers entered using a brace expression. + + + + + Maintains a mapping between the string key and the control + which is being used to identify a FormulaInfo object. + + + + + Maintains a mapping between the row used in a CalcSheet + and the string key used to identify a FormulaInfo object. + + + + + Gets / sets formula values for CalcQuick. + + The indexer used to identify the formula. + + Using an indexer on the CalcQuick instance is the primary method + of setting a value to be used in a CalcQuick object. The string + used as the indexer is the key that you use to reference this formula + value in other formulas used in this CalcQuick instance. + + + + + Gets / sets whether the CalcQuick should throw an exception when a circular calculation is encountered. + + If this property is True, the CalcQuick will throw an exception + when it detects a circular calculation. If ThrowCircularException is False, then + no exception is thrown and the calculation will loop recursively until Engine.MaximumRecursiveCalls + is exceeded. + + + + + An event handler that represents the method to handle the event. + + + This event is raised whenever an indexer is used on the CalcQuick object to assign + it a value or when a value is assigned as the result of a calculation being done. + + + + + Event argument class for the event. + + + + + The only constructor for QuickValueSetEventArgs. + + This is the object that is used as the key value in the Hashtable to + identify the formula information. It is also the string you use in formulas (enclosed in brackets) + to reference a formula from another formula. + New value being assigned. + Indicates the reason the event is being raised. See FormulaInfoSetAction. + + + + The reason the event was raised. + + + + + A property that gets/sets the Hashtable lookup object for the FormulaInfo object being changed. + + + + + A property that gets/sets the new value being set. + + + + + Flags the reason that quickValueSet was raised. + + When QuickValueSet event is raised, it passes an + argument of FormulaInfoSetAction to indicate what was being assigned + to the CalcQuick object using an indexer. + + + + A formula (string starting with FormulaCharacter) was assigned. + + + + + Something other than a formula was assigned. + + + + + A calculated value was assigned. + + + + + Typed Hashtable returning FormulaInfo objects. + + + + + Gets or sets the FormulaInfo with the specified obj. + + The key to identify the given FormulaInfo. + FormulaInfo + + + + CalcSheet represents a single worksheet in a workbook. + + + A CalcSheet plays the role of an Excel Worksheet. It maintains its own internal data object + to hold FormulaInfo objects used by the CalcEngine in its calculation work. The CalcSheet accesses + the raw data / formulas that you want to use in the calculations via the ICalcData interface. + + + + + Default constructor. + + + + + Constructor that initializes an internal object array to + hold data. + + Number of rows in the data object. + Number of columns in the data object. + + + + Constructor used during serialization. + + + + + Creates a CalcSheet from a delimited text file + created by WriteSheetToFile. + + The file name. + A CalcSheet instantiated with the file content. + + + + Supports serialization. + + Serialization information. + Describes source and destination of the given stream.. + + + + Returns the value at the row and column. + + One-based row index. + One based column index. + The cell value. + + + + Raises the CalculatedValueChanged event. + + Includes the row, col, and value of the change. + This event should be raised any time a value changes. + + + + Raises the ValueChanged event. + + Includes the row, col, and value of the change. + This event should be raised any time a value changes. + + + + Creates a CalcSheet object from the content of a StreamReader. + + The StreamReader. + The newly created CalcSheet object. + + + + A Virtual method to save the value through the ICalcData.SetValueRowCol implementation method + and raise the ValueChanged event. + + The row index, one-based. + The column index, one-based. + The value. + + + + A Virtual method to set a value at a given row and column. + + Value to be set. + One-based row index. + One-based column index. + + + + A Virtual method that can be used to handle subscribing to any base object events necessary for implementing the + ValueChanged event. + + For example, when implementing ICalcData on a DataGrid-derived object, + you need to know when something in the DataGrid changes so you can raise the + required ICalcData.ValueChanged event. In WireParentObject, the DataGrid can + subscribe to its DataSource's change event to handle this requirement. If the + DataSource is a DataTable, then the DataTable.ColumnChanged event can fulfill + the requirement. + + + + Get the idex of the first row in UsedRange + + index of first row + + + + get the index of the last row in UsedRange + + index of last row + + + + This API supports the .NET Framework infrastructure and is not intended to be used directly from your code + + + + + + Gets the first column index. + + Index of first column + + + + Gets the last column index / column count. + + Index of last column + + + + This API supports the .NET Framework infrastructure and is not intended to be used directly from your code + + + + + + Writes a delimited file. + + The output file name. + The static Delimiter member specifies the field delimiter. + Rows are delimited by Environment.NewLine characters. + This method serializes formulas instead of computed values. To + write a file containing computed values, use the WriteValuesToFile method. + + + + Writes this CalcSheet object to the given StreamWriter. + + The StreamWriter. + Indicates whether to serialize formulas (False) + or computed values (True). + + + + Writes this CalcSheet object with formulas serialized to the given StreamWriter. + + The StreamWriter. + + + + Serializes the data with computed values to a delimited + text file. + + The file name. + The static Delimiter member specifies the field delimiter. + Rows are delimited by Environment.NewLine characters. + This method serializes computed values instead of formulas. To + write a file containing formulas, use the WriteSheetToFile method. + + + + This event is raised in SetValueRowCol. + + + + + This event should be raised by the implementer of ICalcData whenever a value changes. + + + + + Gets / sets a flag that indicates whether to compute dependent values + as cells change. + + + + + A read-only property that gets the column count. + + + + + Gets / sets the field delimiter for the + WriteSheetToFile method. + + The default value is tab. + + + + A read-only property that gets the CalcEngine object used by this CalcSheet. + + + + + Enables or disables saving changes within the CalcSheet. + + + + + A property that gets / sets the name used to refer to this sheet. + + + + + A read-only property that gets the row count. + + + + + Gets / sets a value through the ICalcData.GetValueRowCol + and ICalcData.SetValueRowCol implementation methods. + + The row index. + The column index. + + + + Calls SecurityPermission.Demand to find out if SecurityPermission is available. + + True if SecurityPermission is available. + + + + CalcWorkbook holds a collection of objects. + + + + + ArrayList of strings holding the CalcSheets names. + + + + + Initializes a new instance of the CalcWorkbook class. + + The calc sheets. + Hashtable of key, value pairs for Namedrange values. + + + + Initializes a new from a serialization stream. + + An object that holds all the data needed to serialize or deserialize this instance. + Describes the source and destination of the serialized stream specified by info. + + + + A Virtual method to calculate all formulas in this workbook. + + + + + Removes all formulas in the given CalcSheet. + + The CalcSheet. + + + + Implements the ISerializable interface and returns the data needed to serialize the workbook. + + A SerializationInfo object containing the information required to serialize the cell model. + A StreamingContext object containing the source and destination of the serialized stream. + + + + A method that gets the integer ID of a CalcSheet. + + The CalcSheet name. + The integer ID. + + + + Creates a CalcWorkbook from a file written using WriteSSS. + + Pathname of the file. + A CalcWorkbook object. + + + + Writes a tab-delimited file holding the Workbook information. + + The pathname of the file to be written. + + + + Gets or sets an Arraylist of CalcSheet objects used in this workbook. + + + + + Array of CalcSheets objects used in this workbook. + + + + + Gets/Sets the CalcEngine object. + + + The setter only sets once, and only if InitCalcWorkbook has been called + with a zero CalcSheet count. + + + + + Number of CalcSheets in this workbook. + + + + + Gets / sets a CalcSheet object with the given name. + + The sheet name. + + + + Gets / sets a CalcSheet object with the given index. + + The sheet index. + + + + Wrapper ArrayList that holds a collection of CalcSheets. + + + + + Default constructor. + + + + + Creates an CalcSheetList instance owned by the given workbook with the given CalcSheet list. + + list of CalcSheets + The Workbook + + + + A method that adds a new CalcSheet. + + The CalcSheet to be added. + The index of the added CalcSheet. + + + + Not supported. + + + + + Not supported. + + + + + Returns the index for a CalcSheet. + + The name of the CalcSheet. + The index of the CalcSheet. + + + + A method that removes a CalcSheet. + + The CalcSheet to be removed. + + + + Removes a CalcSheet. + + The index of the CalcSheet to be removed. + + + + The CalcSheets in this collection. + + Returns a CalcSheet[]. + + + + Gets or sets the CalcSheet at the given index. + + The sheet index. + + + + Gets or sets the CalcSheet with a given name. + + The sheet name. + + + + + Contains utility methods for object cloning. + + + + + Clones int array. + + Array to clone + Returns cloned array. + + + + Clones ushort array. + + Array to clone. + Returns cloned array. + + + + Clones string array. + + Array to clone. + Returns cloned array. + + + + Clones object array. + + Array to clone. + Returns cloned array. + + + + Clones object that implements ICloneable interface. + + Object to clone. + A clone of the object. + + + + Clones byte array. + + Array to clone. + Return cloned array. + + + + Clone Dictionary. + + Dictionary to clone + Returns a copy of the Dictionary. + + + + Clone Dictionary. + + Dictionary to clone + Returns a copy of the Dictionary. + + + + Creates copy of the stream. + + Stream to copy. + Created stream. + + + + Summary description for DocumentPropertyImpl. + + + + + Represents single document property. + + + + + Indicates whether property is built-in. Read-only. + + + + + Returns property id for built-in properties. Read-only. + + + + + Returns property name. Read-only. + + + + + Gets / sets property value. + + + + + Gets / sets boolean value. + + + + + Gets / sets integer value. + + + + + Gets / sets 4-bytes signed integer value. + + + + + Gets / sets double value. + + + + + Gets / sets string value. + + + + + Gets / sets DateTime value. + + + + + Gets / sets TimeSpan value. + + + + + Returns or sets the source of a linked custom document property. Read/write String. + + + + + True if the value of the custom document property is linked to the content + of the container document. False if the value is static. Read/write Boolean. + + + + + Start index for Id2 PropVariant property. + + + + + Start year for FILETIME structure. + + + + + Property id. + + + + + Property name. + + + + + Property value. + + + + + Property type. + + + + + The source of a linked custom document property. Read/write String. + + + + + True if the value of the custom document property is linked to the content + of the container document. False if the value is static. Read/write Boolean. + + + + + Default constructor. + + + + + Initializes new instance of the class. + + Property name. + Property value. + + + + Initializes new instance of the class. + + Property id. + Property value. + + + + Initializes new instance of the document property. + + Variant that contains property data. + + Indicates whether property is from document summary or not (only for + built-int properties). + + + + Detects type of the string. + + String value to check. + Detected string type. + + + + Copies document property data into PropVariant. + + Destination object. + PropertyId for custom properties. + True if was able to fill variant; false otherwise. + + + + Converts propertyId into correct index. + + PropertyId to convert. + [out] Indicates whether this is document summary property of simply document property. + Correct property index. + + + + Tries to detect and set property type. + + + + + Sets value of LinkSource property. + + Variant that contains value to set. + + + + Saves property into IPropertyStorage. + + Storage to save into. + Property variant used as buffer. + Property id for custom properties. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Creates copy of the internal value. + + + + + Indicates whether property is built-in. Read-only. + + + + + Returns / sets property id for built-in properties. + + + + + Returns property name. Read-only. + + + + + Gets / sets property value. + + + + + Gets / sets boolean value. + + + + + Gets / sets integer value. + + + + + Gets / sets 4-bytes signed integer value. + + + + + Gets / sets double value. + + + + + Gets / sets string value. + + + + + Gets / sets DateTime value. + + + + + Gets / sets TimeSpan value. + + + + + Gets / sets Blob value. + + + + + Gets or sets clipboard data value. + + + + + Gets / sets array of strings. + + + + + Gets / sets array of objects. Supported object types are string and Int32. + + + + + Gets / sets document property type. + + + + + Returns or sets the source of a linked custom document property. Read/write String. + + + + + True if the value of the custom document property is linked to the content of the container document. False if the value is static. Read/write Boolean. + + + + + Internal name of the document property. + + + + + Property IDs for the SummaryInformation Property Set. + + + + + Title document property Id. + + + + + Subject document property Id. + + + + + Author document property Id. + + + + + Keywords document property Id. + + + + + Comments document property Id. + + + + + Template document property Id. + + + + + LastAuthor document property Id. + + + + + Revnumber document property Id. + + + + + EditTime document property Id. + + + + + LastPrinted document property Id. + + + + + CreationDate document property Id. + + + + + LastSaveDate document property Id. + + + + + PageCount document property Id. + + + + + WordCount document property Id. + + + + + CharCount document property Id. + + + + + Thumbnail document property Id. + + + + + ApplicationName document property Id. + + + + + Ssecurity document property Id. + + + + + Category Id. + + + + + Target format for presentation (35mm, printer, video, and so on) id. + + + + + ByteCount Id. + + + + + LineCount Id. + + + + + ParCount Id. + + + + + SlideCount Id. + + + + + NoteCount Id. + + + + + HiddenCount Id. + + + + + MmclipCount Id. + + + + + ScaleCrop property Id. + + + + + HeadingPair Id. + + + + + DocParts Id. + + + + + Manager Id. + + + + + Company Id. + + + + + LinksDirty Id. + + + + + The character count with space + + + + + Enumeration with all supported property types. + + + + + Indicates a Boolean value. + + + + + Indicates an integer value. + + + + + Indicates a 4-bytes signed integer value. + + + + + Indicates a 2-bytes signed interger value. + + + + + Indicates a 4-bytes unsigned interger value. + + + + + Indicates a wide string terminated by a null. + + + + + Indicates a string terminated by a null. + + + + + Indicates a FILETIME value. + + + + + Indicates length prefixed bytes. + + + + + Indicates a simple, counted array. + + + + + Indicates an object. + + + + + Indicates a double value. + + + + + Indicates an empty value. + + + + + Indicates null value. + + + + + Indicates clipboard data. + + + + + Indicates an array of strings. + + + + + Indicates an array of strings. + + + + + Indicates an array of objects. Supported types are string and integer values. + + + + + This interface represents stream in the compound file. + + + + + Name of the stream. + + + + + Initializes new instance of the compound stream object. + + Name of the stream. + + + + Copies stream content into another stream object. + + Stream to copy data into. + + + + Returns name of the stream. + + + + + This interface gives access to compound file functionality. + + + + + Flushes content into internal buffer. + + + + + Saves compound file into stream + + Stream to save data into. + + + + Saves compound file into file. + + Name of the file to save into. + + + + Returns root storage object for this file. + + + + + This interface represents storage object in the compound file. + + + + + Creates new stream inside this storage. + + Name of the stream to create. + Created stream object. + + + + Opens existing stream inside this storage. + + Name of the stream to open. + + + + + Removes existing stream from this storage. + + Name of the stream to remove. + + + + Determines whether storage contains specified stream. + + Name of the stream to check. + true if storage contains specified stream. + + + + Creates new substorage inside this one. + + Name of the storage to create. + Created storage object. + + + + Opens existing substorage inside this one. + + Name of the storage to open. + Created storage object. + + + + Removes exisiting substorage from this one. + + Name of the storage to remove. + + + + Determines whether this storage contains substorage with specified name. + + Name of the storage to check. + true if storage contains substorage with specified name. + + + + Commits changes. + + + + + Inserts copy of the storage and all subitems inside current storage. + + Storage to copy. + + + + Inserts copy of the stream inside current storage. + + Stream to copy. + + + + Returns all stream names that are placed inside this stream. + + + + + Returns all storage names that are placed inside this stream. + + + + + Returns name of the storage. + + + + + This exception should be thrown when lock or share violation has occured. + Usually this happens when user tries to create storage on file opened by somebody else. + + + + + Default message. + + + + + Message for exception message with record code. + + + + + Initializes a new instance of the class with default error message. + + + + + Initializes a new instance of the class with a specified error message. + + Error message. + + + + Initializes a new instance of the Exception 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. + If the innerException parameter is not a NULL reference + (Nothing in Visual Basic), the current exception is raised + in a catch block that handles the inner exception. + + + + + Special wrapper class that allows users to control access to stream + and cache data. + + + + + Default buffer allocation size. + + + + + Underlying stream. Close sets _s to NULL. + + + + + Shared read / write buffer. Allocated on first use. + + + + + Read pointer within shared buffer. + + + + + Number of bytes read in buffer from _s. + + + + + Write pointer within shared buffer. + + + + + Length of internal buffer if it is allocated. + + + + + Stream position when the buffer is read. + + + + + Default constructor. Hidden to class users. + + + + + Initialize class by stream and DefaultBufferSize == 4096. + + Stream which our class must wrap. + + + + Initialize class by instance of stream and user defined cache size. + + Stream which our class must wrap. + User defined cache size. + Stream does not support Read and Write operations. + BufferSize is equal or less than zero. + + + + Reads data from the stream. If data is cached, the class will not call wrapped + stream and will simply return a copy of cached data. + + Output buffer. + Offset in output buffer where data from stream must be placed. + Count of bytes which class must return. + Quantity of read bytes. + + + + Reads a byte from the underlying stream. Returns an int (byte cast to an int) + or -1 if it is the end of the stream. + + Read byte. + + + + Writes portion of data into a wrapped stream. Data will be cached if it is possible. + It will then be saved to the wrapped stream on Flush. + + Array containing data. + Offset to the beginning of the portion of data. + Number of bytes in the portion of data. + + If array or stream is NULL. + + + If offset or count is less than zero. + + + If array does not contain the required element count. + + + + + Write one byte of information into stream. + + Value which must be written. + + If stream is NULL. + + + If can't write into stream. + + + + + On any Seek operation, data not written from cache will be + flushed to the wrapped stream. Using the Position property is better as + it is optimized for cache use. + + New offset of stream. + Start point of seek operation. + Current position. + + If stream is NULL. + + + If can't seek in the stream. + + + + + Saves all the data from cache and closes the stream. + + + + + Flushes data and resets the cache. + + + When stream is NULL. + + + + + The file is read in blocks, but a user could read 1 byte + from the buffer and write it. At that point, the Operating System's file + pointer is out of sync with the stream's position. Hence, all write + functions should call this function to preserve the position in the file. + + + + + Since Write is buffered, any time the buffer fills up + or the buffer switches to reading and there is dirty data + (_writePos > 0), this function must be called. + + + + + Sets length of wrapped stream. + + New length of stream. + + When value is less than zero. + + + When stream is NULL. + + + Cannot seek or cannot write into stream. + + + + + Indicates whether data can be read from the wrapped stream. + True if data can be read. + + Class instance was disposed. + + + + Indicates whether data can be written to wrapped stream. + + Class instance was disposed. + + + + Indicates whether the wrapped stream supports Seek operations. + + Class instance was disposed. + + + + Gets length of the wrapped stream. When this property is accessed, the data + that is not written to the stream is first flushed. + + Class instance was disposed. + + + + Gets the current position of stream. Position can be different from the value in wrapped + stream, because wrapped stream will point to the last byte of the + cached data. When this property is set, the data that is not written is flushed to the stream. + + Class instance was disposed. + Wrapped stream does not support seek operation. + + + + Get reference of stream wrapped by BufferStreamEx. + + + + + This is compound file implementation based on standard COM-objects. + + + + + Root storage. + + + + + Represents the locking bytes. + + + + + Default constructor. Creates native compound file in memory. + + + + + Creates new instance of the compound file based on the specified stream. + + Stream to extract data from. + + + + Creates new instance of the compound file based on the file name and open flags. + + Name of the file to parse. + Storage options. + + + + Flushes all internal buffers. + + + + + Cretes storage on ILockBytes. + + Created storage. + + + + Saves internal ILockBytes into stream. + + Stream to save into. + + + + Opens specified stream. + + Stream to open. + + + + Saves compound file into stream + + Stream to save data into. + + + + Saves compound file into file. + + Name of the file to save into. + + + + Frees all allocated resources. + + + + + Returns root storage object for this file. + + + + + Summary description for ILockBytes. + + + + + The ReadAt method reads a specified number of bytes + starting at a specified offset from the beginning of the byte array object. + + Specifies the starting point from the beginning + of the byte array for reading data. + Pointer to the buffer into which the byte array is read. + The size of this buffer is contained in cb. + Specifies the number of bytes of data to attempt to read + from the byte array. + Pointer to a ULONG where this method writes the actual + number of bytes read from the byte array. You can set this pointer to NULL + to indicate that you are not interested in this value. In this case, this + method does not provide the actual number of bytes that were read. + S_OK - Indicates that the specified number of bytes were read, or the + maximum number of bytes were read to the end of the byte array. + E_FAIL - Data could not be read from the byte array. + E_PENDING - Asynchronous Storage only: Part or all of the data to be + read is currently unavailable. + STG_E_ACCESSDENIED - The caller does not have permission to access the byte array. + STG_E_READFAULT - The number of bytes to be read does not equal the number of bytes + that were actually read + + + + The WriteAt method writes the specified number of bytes starting at a specified offset + from the beginning of the byte array. + + Specifies the starting point from + the beginning of the byte array for the data to be written. + Pointer to the buffer containing the data to be written. + Specifies the number of bytes of data to attempt to write into + the byte array. + Pointer to a location where this method specifies the + actual number of bytes written to the byte array. You can set this pointer to + NULL to indicate that you are not interested in this value. In this case, this + method does not provide the actual number of bytes written. + S_OK - Indicates that the specified number of bytes were written. + E_FAIL - A general failure occurred during the write operation. + E_PENDING - Asynchronous Storage only: Part or all of the data to be + written is currently unavailable. + STG_E_ACCESSDENIED - The caller does not have enough permissions for writing + this byte array. + STG_E_WRITEFAULT - The number of bytes to be written does not equal the number + of bytes that were actually written. + STG_E_MEDIUMFULL - The write operation was not completed because there is no + space left on the storage device. The actual number of bytes written is still + returned in pcbWritten. + + + + The Flush method ensures that any internal buffers maintained by the ILockBytes + implementation are written out to the underlying physical storage. + + S_OK - The flush operation was successful. + STG_E_ACCESSDENIED - The caller does not have permission to access the byte array. + STG_E_MEDIUMFULL - The flush operation is not completed because there is no space + left on the storage device. + E_FAIL - General failure writing data. + STG_E_TOOMANYFILESOPEN - Under certain circumstances, the Flush method executes + a download-and-closeto flush, which can lead to a return value of + STG_E_TOOMANYFILESOPEN if no file handles are available. + STG_E_INVALIDHANDLE - An underlying file has been prematurely closed, or the + correct floppy disk has been replaced by an invalid one. + + + + The SetSize method changes the size of the byte array. + + Specifies the new size of the byte array as a number of bytes. + S_OK - The size of the byte array was successfully changed. + STG_E_ACCESSDENIED - The caller does not have permission to access the byte array. + STG_E_MEDIUMFULL - The byte array size is not changed because there is no + space left on the storage device. + + + + The LockRegion method restricts access to a specified range of bytes in the byte array. + + Specifies the byte offset for the beginning of the range. + Specifies, in bytes, the length of the range to be restricted. + Specifies the type of restrictions being requested on + accessing the range. This parameter uses one of the values from the LOCKTYPE enumeration. + S_OK - The specified range of bytes was locked + STG_E_INVALIDFUNCTION - Locking is not supported at all or the specific type of lock + requested is not supported. + STG_E_ACCESSDENIED - Access denied because the caller has insufficient permission, + or another caller has the file open and locked. + STG_E_LOCKVIOLATION - Access denied because another caller has the file open and locked. + STG_E_INVALIDHANDLE - An underlying file has been prematurely closed, or the + correct floppy disk has been replaced by an invalid one + + + + The UnlockRegion method removes the access restriction on a previously + locked range of bytes. + + Specifies the byte offset for the beginning of the range. + Specifies, in bytes, the length of the range that is restricted. + Specifies the type of access restrictions previously + placed on the range. This parameter uses a value from the LOCKTYPE enumeration. + S_OK - The byte range was unlocked. + STG_E_INVALIDFUNCTION - Locking is not supported at all or the specific type + of lock requested is not supported. + STG_E_LOCKVIOLATION The requested unlock cannot be granted. + + + + + The Stat method retrieves a STATSTG structure containing information for + this byte array object. + + Pointer to a STATSTG structure in which this method + places information about this byte array object. The pointer is NULL if + an error occurs. + Specifies whether this method should supply the + pwcsName member of the STATSTG structure through values taken from the + STATFLAG enumeration. If the STATFLAG_NONAME is specified, the pwcsName + member of STATSTG is not supplied, thus saving a memory-allocation operation. + The other possible value, STATFLAG_DEFAULT, indicates that all members of the + STATSTG structure be supplied. + S_OK - The STATSTG structure was successfully returned at + the specified location. + E_OUTOFMEMORY - The STATSTG structure was not returned due to a lack of memory + for the name member in the structure. + STG_E_ACCESSDENIED - The STATSTG structure was not returned because the caller + did not have access to the byte array. + STG_E_INSUFFICIENTMEMORY - The STATSTG structure was not returned, due to + insufficient memory. + STG_E_INVALIDFLAG - The value for the grfStateFlag parameter is not valid. + STG_E_INVALIDPOINTER - The value for the pStatStg parameter is not valid. + + + + + Implementation of compound stream based on standard COM object. + + + + + + + + + + Stream position. + + + + + Initializes new instance of the stream object. + + COM stream to use. + Name of the stream. + + + + Reads a sequence of bytes from the current stream and advances the position + within the stream by the number of bytes read. + + An array of bytes. When this method returns, the buffer contains + the specified byte array with the values between offset and (offset + count - 1) + replaced by the bytes read from the current source. + The zero-based byte offset in buffer at which to begin storing + the data read from the current stream. + The maximum number of bytes to be read from the current stream. + The total number of bytes read into the buffer. This can be less + than the number of bytes requested if that many bytes are not currently + available, or zero (0) if the end of the stream has been reached. + + + + Writes a sequence of bytes to the current stream and advances the current position + within this stream by the number of bytes written. + + An array of bytes. This method copies length bytes from buffer to the current stream. + The zero-based byte offset in buffer at which to begin copying bytes to the current stream. + The number of bytes to be written to the current stream. + + + + Sets the position within the current stream. + + A byte offset relative to the origin parameter. + A value of type SeekOrigin indicating the reference point used to obtain the new position. + The new position within the current stream. + + + + Sets the length of the current stream. + + The desired length of the current stream in bytes. + + + + Clears all buffers for this stream and causes any buffered data to be + written to the underlying device. + + + + + Releases the unmanaged resources used by the Stream and optionally releases the managed resources. + + true to release both managed and unmanaged resources; + false to release only unmanaged resources. + + + + Checks whether offset and length can be fit inside specified buffer. + + Buffer to check. + Offset to check. + Length to check. + + + + Gets the length in bytes of the stream. + + + + + Gets or sets the position within the current stream. + + + + + Gets a value indicating whether the current stream supports reading. + + + + + Gets a value indicating whether the current stream supports writing. + + + + + Gets a value indicating whether the current stream supports seeking. + + + + + The STGTY enumeration values are used in the type member of the STATSTG + structure to indicate the type of the storage element. + + + + + Indicates that the storage element is a storage object. + + + + + Indicates that the storage element is a stream object. + + + + + Indicates that the storage element is a byte-array object. + + + + + Indicates that the storage element is a property storage object. + + + + + The STREAM_SEEK enumeration values specify the origin from which to + calculate the new seek-pointer location. + + + + + The new seek pointer is an offset relative to the beginning of + the stream. In this case, the dlibMove parameter is the new seek + position relative to the beginning of the stream. + + + + + The new seek pointer is an offset relative to the current seek + pointer location. In this case, the dlibMove parameter is the + signed displacement from the current seek position. + + + + + The new seek pointer is an offset relative to the end of the stream. + In this case, the dlibMove parameter is the new seek position + relative to the end of the stream. + + + + + The LOCKTYPE enumeration values indicate the type of locking requested + for the specified range of bytes. + + + + + If this lock is granted, the specified range of bytes can be opened + and read any number of times, but writing to the locked range is + prohibited except for the owner who granted this lock. + + + + + If this lock is granted, writing to the specified range of bytes is + prohibited except by the owner granted this lock. + + + + + If this lock is granted, no other LOCK_ONLYONCE lock can be obtained + on the range. Usually this lock type is an alias for some other lock + type. Thus, specific implementations can have additional behavior + associated with this lock type. + + + + + The STGM enumeration values are used in the IStorage, IStream, and + IPropertySetStorage interfaces. These elements are often combined + using an OR operator. + + + + + Indicates that the object is read-only, meaning that modifications + cannot be made. + + + + + STGM_WRITE lets you save changes to the object, but does not permit + access to its data. + + + + + STGM_READWRITE allows you to both access and modify an object's data. + + + + + Specifies that subsequent openings of the object are not denied read + or write access. If no flag from the sharing group is specified, + this flag is assumed. + + + + + Prevents others from subsequently opening the object in STGM_READ mode. + It is typically used on a root storage object. + + + + + Prevents others from subsequently opening the object for STGM_WRITE + or STGM_READWRITE access. + + + + + Prevents others from subsequently opening the object in any mode. In + transacted mode, sharing of STGM_SHARE_DENY_WRITE or STGM_SHARE_EXCLUSIVE + can significantly improve performance since they don't require snapshotting. + + + + + Opens the storage object with exclusive access to the most recently + committed version. + + + + + Indicates that an existing storage object or stream should be removed + before the new one replaces it. + + + + + Creates the new object while preserving existing data in a stream + named "Contents". + + + + + Causes the create operation to fail if an existing object with the + specified name exists. + + + + + In direct mode, each change to a storage or stream element is + written as it occurs. + + + + + In transacted mode, changes are buffered and written only if an + explicit commit operation is called. + + + + + In transacted mode, a temporary scratch file is usually used to + save modifications until the Commit method is called. + + + + + This flag is used when opening a storage object with STGM_TRANSACTED + and without STGM_SHARE_EXCLUSIVE or STGM_SHARE_DENY_WRITE. + + + + + STGM_SIMPLE is a mode that provides a much faster implementation of + a compound file in a limited, but frequently used case. + + + + + The STGM_DIRECT_SWMR supports direct mode for single-writer, + multireader file operations. + + + + + Indicates that the underlying file is to be automatically destroyed + when the root storage object is released. + + + + + The STGFMT enumeration values specify the format of a storage object + and are used in the StgCreateStorageEx and StgOpenStorageEx functions + in the STGFMT parameter. + + + + + Indicates that the file must be a compound file. + + + + + Indicates that the file must not be a compound file. + + + + + Indicates that the system will determine the file type and use the + appropriate structured storage or property set implementation. + + + + + Indicates that the file must be a compound file and is similar to + the STGFMT_STORAGE flag, but indicates that the compound-file form + of the compound-file implementation must be used. + + + + + Error code which StgOpenStorage method can return after execution. + + + + + Success code. + + + + + Filed. + + + + + Access Denied. + + + + + File already exists. + + + + + File could not be found. + + + + + There is insufficient memory available to complete operation. + + + + + Invalid flag error. + + + + + Unable to perform requested operation. + + + + + Attempted an operation on an invalid object. + + + + + The name is not valid. + + + + + Invalid pointer error. + + + + + A lock violation has occurred. + + + + + The compound file was not created with the STGM_SIMPLE flag. + + + + + The compound file was produced with a newer version of storage. + + + + + The compound file was produced with an incompatible version of storage. + + + + + The path could not be found. + + + + + A share violation has occurred. + + + + + There are insufficient resources to open another file. + + + + + The STGC enumeration constants specify the conditions for performing + the commit operation in the IStorage::Commit and IStream::Commit methods. + + + + + You can specify this condition with STGC_CONSOLIDATE or some + combination of the other three flags in this list of elements. + + + + + The commit operation can overwrite existing data to reduce overall + space requirements. + + + + + Prevents multiple users of a storage object from overwriting each + other's changes. + + + + + Commits the changes to a write-behind disk cache, but does not save + the cache to the disk. + + + + + Microsoft Windows 2000/XP: Indicates that a storage should be + consolidated after it is committed, resulting in a smaller file on disk. + + + + + Property IDs for the SummaryInformation Property Set. + + + + + Title Id. + + + + + Subject Id. + + + + + Author Id. + + + + + Keywords Id. + + + + + Comments Id. + + + + + Template Id. + + + + + LastAuthor Id. + + + + + Revnumber Id. + + + + + EditTime Id. + + + + + LastPrinted Id. + + + + + Create_dtm Id. + + + + + LastSave_dtm Id. + + + + + Pagecount Id. + + + + + Wordcount Id. + + + + + Charcount Id. + + + + + Thumbnail Id. + + + + + Appname Id. + + + + + Doc_security Id. + + + + + Property IDs for the DocSummaryInformation Property Set. + + + + + Category Id. + + + + + PresFormat Id. + + + + + ByteCount Id. + + + + + LineCount Id. + + + + + ParCount Id. + + + + + SlideCount Id. + + + + + NoteCount Id. + + + + + HiddenCount Id. + + + + + MmclipCount Id. + + + + + Scale Id. + + + + + HeadingPair Id. + + + + + DocParts Id. + + + + + Manager Id. + + + + + Company Id. + + + + + LinksDirty Id. + + + + + Reserved global Property IDs. + + + + + PID_DICTIONARY Id. + + + + + PID_CODEPAGE Id. + + + + + PID_FIRST_USABLE Id. + + + + + PID_FIRST_NAME_DEFAULT Id. + + + + + PID_LOCALE Id. + + + + + PID_MODIFY_TIME Id. + + + + + PID_SECURITY Id. + + + + + PID_BEHAVIOR Id. + + + + + PID_ILLEGAL Id. + + + + + PID_MIN_READONLY Id. + + + + + PID_MAX_READONLY Id. + + + + + PRSPEC property ids. + + + + + INVALID Id. + + + + + LPWSTR Id. + + + + + PROPID Id. + + + + + The STATSTG structure contains statistical information about an open storage, + stream, or byte-array object. + + + + + Pointer to a NULL-terminated Unicode string containing the name. + Space for this string is allocated by the method called and freed by the caller + + + + + Indicates the type of storage object. This is one of the + values from the STGTY enumeration. + + + + + Specifies the size in bytes of the stream or byte array. + + + + + Indicates the last modification time for this storage, stream, or byte array. + + + + + Indicates the creation time for this storage, stream, or byte array. + + + + + Indicates the last access time for this storage, stream or byte array. + + + + + Indicates the access mode specified when the object was opened. + This member is only valid in calls to Stat methods. + + + + + Indicates the types of region locking supported by the stream or byte array. + See the LOCKTYPE enumeration for the values available. + This member is not used for storage objects. + + + + + Indicates the class identifier for the storage object; set to CLSID_NULL for new storage objects. + This member is not used for streams or byte arrays. + + + + + Indicates the current state bits of the storage object; that is, the value most + recently set by the IStorage::SetStateBits method. + This member is not valid for streams or byte arrays. + + + + + Reserved for future use. + + + + + Structure that is used by STG API. + + + + + Structure that is used by STG API. + + + + + uint parameter. + + + + + uint parameter. + + + + + OLECHAR parameter. + + + + + Macros for parsing the OS Version of the Property Set Header. + + + + + Time in UTC when this property set was last accessed. + + + + + CLSID associated with this property set, specified when the property set was initially created + and possibly modified thereafter with IPropertyStorage::SetClass. If not set, the value will be CLSID_NULL. + + + + + Time in UTC when this property set was created. + + + + + Os vorsion. + + + + + FMTID of the current property set, specified when the property set was initially created. + + + + + Flag values of the property set, as specified in IPropertySetStorage::Create. + + + + + Time in Universal Coordinated Time (UTC) when the property set was last modified. + + + + + + The STATPROPSTG structure contains data about a single property in a property set. + This data is the property ID and type tag, and the optional string name that may be associated with the property. + + + + + A wide-character null-terminated Unicode string that contains the optional string name + associated with the property. May be NULL. + + + + + A 32-bit identifier that uniquely identifies the property within the property set. + All properties within property sets must have unique property identifiers. + + + + + The property type. + + + + + The PROPSPEC structure is used by many of the methods of IPropertyStorage to specify a + property either by its property identifier (ID) or the associated string name. + + + + + Indicates the union member used. This member can be one of the following values. + + + + + Specifies the value of the property ID. Use either this value or the following lpwstr, not both. + + + + + This enumeration is used in VARIANT, TYPEDESC, OLE property sets, and safe arrays. + + + + + Variable type is not specified. + + + + + Variable type is 4-byte signed INT. + + + + + Variable type is date. + + + + + Variable type is binary string. + + + + + Variable type is Boolean; True=-1, False=0. + + + + + Variable type is VARIANT FAR*. + + + + + Variable type is int. + + + + + Variable type is LPSTR. + + + + + Variable type is LPWSTR + + + + + Variable type is FILENAME string. + + + + + Variable type is binary VECTOR. + + + + + The IEnumSTATSTG interface enumerates an array of STATSTG structures. + These structures contain statistical data about open storage, stream, or byte array objects. + IEnumSTATSTG has the same methods as all enumerator interfaces: Next, Skip, Reset, and Clone. + + + + + The Next method retrieves a specified number of STATSTG structures, + that follow subsequently in the enumeration sequence. + If there are fewer than the requested number of STATSTG structures left + in the enumeration sequence, it retrieves the remaining STATSTG structures. + + The number of STATSTG structures requested. + An array of STATSTG structures returned. + The number of STATSTG structures retrieved in the rgelt parameter. + S_OK - The number of STATSTG structures returned equals the number + specified in the celt parameter. + S_FALSE - The number of STATSTG structures returned is less than the number + specified in the celt parameter. + + + + The Skip method skips a specified number of STATSTG structures in the enumeration sequence. + + The number of STATSTG structures to skip. + S_OK - The specified number of STATSTG structures were successfully skipped. + S_FALSE - The number of STATSTG structures skipped is less than the celt parameter. + + + + The Reset method resets the enumeration sequence to the beginning of the STATSTG structure array. + + S_OK - The enumeration sequence was successfully reset to the + beginning of the enumeration. + + + + The Clone method creates a new enumerator that contains the same enumeration state as + the current STATSTG structure enumerator. Using this method, a client can record a + particular point in the enumeration sequence and then return to that point at a later time. + The new enumerator supports the same IEnumSTATSTG interface. + + A pointer to the variable that receives the IEnumSTATSTG interface pointer. + If the method is unsuccessful, the value of the ppenum parameter is undefined. + E_INVALIDARG - The ppenum parameter is NULL. + E_OUTOFMEMORY - Insufficient memory. + E_UNEXPECTED - An unexpected exception occurred. + + + + For more information, refer to documentation on MSDN for interface with the same name. + + + + + Reads a specified number of bytes from the stream object into memory starting + at the current seek pointer. + + [out] Pointer to the buffer into which the stream data is read. + [in] Specifies the number of bytes of data to attempt to read + from the stream object. + [out] Pointer to a ULONG variable that receives the actual + number of bytes read from the stream object. You can set this pointer to NULL to + indicate that you are not interested in this value. In this case, this method + does not provide the actual number of bytes read. + + S_OK + Data was successfully read from the stream object. + S_FALSE + The data could not be read from the stream object. + E_PENDING + Asynchronous storage only: Part or all of the data to be read is currently unavailable. For more information, see IFillLockBytes and Asynchronous Storage. + STG_E_ACCESSDENIED + The caller does not have enough permissions for reading this stream object. + STG_E_INVALIDPOINTER + One of the pointer values is not valid. + STG_E_REVERTED + The object has been invalidated by a revert operation above it in the transaction tree. + + + + + Writes a specified number of bytes into the stream object starting at the + current seek pointer. + + [in] Pointer to the buffer containing the data that is to be + written to the stream. A valid pointer must be provided for this parameter even + when cb is zero. + [in] The number of bytes of data to attempt to write into the + stream. Can be zero. + [out] Pointer to a ULONG variable where this method + writes the actual number of bytes written to the stream object. The caller can + set this pointer to NULL, in which case this method does not provide the actual + number of bytes written. + + S_OK + The data was successfully written to the stream object. + E_PENDING + Asynchronous Storage only: Part or all of the data to be written is currently + unavailable. For more information, see IFillLockBytes and Asynchronous Storage. + STG_E_MEDIUMFULL + The write operation was not completed because there is no space left on the storage + device. + STG_E_ACCESSDENIED + The caller does not have enough permissions for writing to this stream object. + STG_E_CANTSAVE + Data cannot be written for reasons other than improper access or insufficient space. + STG_E_INVALIDPOINTER + One of the pointer values is not valid. The pv parameter must contain a valid pointer + even if cb is zero. + STG_E_REVERTED + The object has been invalidated by a revert operation above it in the transaction tree. + STG_E_WRITEFAULT + The write operation was not completed due to a disk error. This value is also returned + when this method attempts to write to a stream that was opened in simple mode (using + the STGM_SIMPLE flag). + + + + + Changes the seek pointer to a new location relative to the beginning of + the stream, the end of the stream, or the current seek pointer. + + [in] Displacement to be added to the location indicated by + the dwOrigin parameter. If dwOrigin is STREAM_SEEK_SET, this is interpreted as an + unsigned value rather than a signed value. + [in] Specifies the origin for the displacement specified in + dlibMove. The origin can be the beginning of the file, the current seek pointer, + or the end of the file. See the STREAM_SEEK enumeration for the values. + [out] Pointer to the location where this method writes + the value of the new seek pointer from the beginning of the stream. You can set this + pointer to NULL to indicate that you are not interested in this value. In this case, + this method does not provide the new seek pointer. + + S_OK + The seek pointer has been successfully adjusted. + E_PENDING + Asynchronous Storage only: Part or all of the stream's data is currently unavailable. + For more information, see IFillLockBytes and Asynchronous Storage. + STG_E_INVALIDPOINTER + Indicates that the [out] parameter plibNewPosition points to invalid memory, because + plibNewPosition is not read. + STG_E_INVALIDFUNCTION + The dwOrigin parameter contains an invalid value or the dlibMove parameter contains + a bad offset value. For example, the result of the seek pointer is a negative offset + value. + STG_E_REVERTED + The object has been invalidated by a revert operation above it in the transaction tree. + + + + + Changes the size of the stream object. + + [in] Specifies the new size of the stream as a number + of bytes. + + + + + Copies a specified number of bytes from the current seek pointer in the stream to + the current seek pointer in another stream. + + [in] Pointer to the destination stream. The stream pointed to + by pstm can be a new stream or a clone of the source stream. + [in] Specifies the number of bytes to copy from the source + stream. + [out] Pointer to the location where this method writes the + actual number of bytes read from the source. You can set this pointer to NULL to + indicate that you are not interested in this value. In this case, this method + does not provide the actual number of bytes read. + [out] Pointer to the location where this method writes + the actual number of bytes written to the destination. You can set this pointer + to NULL to indicate that you are not interested in this value. In this case, + this method does not provide the actual number of bytes written. + + + + + Ensures that any changes made to a stream object open in transacted mode + are reflected in the parent storage. If the stream object is open in direct + mode, IStream::Commit has no effect other than flushing all memory buffers + to the next-level storage object. The COM compound file implementation of + streams does not support opening streams in transacted mode. + + [in] Controls how the changes for the stream + object are committed. See the STGC enumeration for a definition of these + values. + + + + + Discards all changes that have been made to a transacted stream since the + last call to IStream::Commit. + + + + + + Restricts access to a specified range of bytes in the stream. Supporting + this functionality is optional since some file systems do not provide it. + + + + + + + + + Removes the access restriction on a range of bytes previously restricted + with IStream::LockRegion. + + + + + + + + + Retrieves the STATSTG structure for this stream. + + + + + + + + Creates a new stream object that references the same bytes as the original + stream but provides a separate seek pointer to those bytes. + + + + + + + Call the methods of IStorage to manage substorages or streams within the current storage. + This management includes creating, opening, or destroying substorages or streams, + as well as managing aspects such as time stamps, names, and so forth. + + + + + The CreateStream method creates and opens a stream object with the specified + name contained in this storage object. All elements within a storage objects, + both streams and other storage objects, are kept in the same name space. + + A pointer to a wide character null-terminated Unicode + string that contains the name of the newly created stream. The name can be used + later to open or reopen the stream. The name must not exceed 31 characters in + length, not including the string terminator. The 000 through 01f characters, + serving as the first character of the stream/storage name, are reserved for use by OLE. + This is a compound file restriction, not a structured storage restriction. + Specifies the access mode to use when opening the newly + created stream. For more information and descriptions of the possible values, + see STGM Constants. + Reserved for future use; must be zero. + Reserved for future use; must be zero. + On return, pointer to the location of the new IStream interface pointer. + This is only valid if the operation is successful. + When an error occurs, this parameter is set to NULL. + + S_OK - The new stream was successfully created. + E_PENDING - Asynchronous Storage only: Part or all of the + necessary data is currently unavailable. For more information, + see IFillLockBytes and Asynchronous Storage. + STG_E_ACCESSDENIED - Not enough permissions to create stream. + STG_E_FILEALREADYEXISTS - The name specified for the stream already exists in the storage + object and the grfMode parameter includes the value STGM_FAILIFTHERE. + STG_E_INSUFFICIENTMEMORY - The stream was not created due to a lack of memory. + STG_E_INVALIDFLAG - The value specified for the grfMode parameter is not a valid STGM Constants value. + STG_E_INVALIDFUNCTION - The specified combination of flags in the grfMode parameter is not supported; + for example, when this method is called without the STGM_SHARE_EXCLUSIVE flag. + STG_E_INVALIDNAME - Invalid value for pwcsName. + STG_E_INVALIDPOINTER - The pointer specified for the stream object was invalid. + STG_E_INVALIDPARAMETER - One of the parameters was invalid. + STG_E_REVERTED - The storage object has been invalidated by a revert operation + above it in the transaction tree. + STG_E_TOOMANYOPENFILES - The stream was not created because there are too many open files. + + + + + The OpenStream method opens an existing stream object within this storage + object in the specified access mode. + + A pointer to a wide character null-terminated Unicode + string that contains the name of the stream to open. The 000 through 01f + characters, serving as the first character of the stream/storage name, are + reserved for use by OLE. This is a compound file restriction, not a structured + storage restriction. + Reserved for future use; must be NULL. + Specifies the access mode to be assigned to the open stream. + For more information and descriptions of possible values, see STGM Constants. + Other modes you choose must at least specify STGM_SHARE_EXCLUSIVE when calling this + method in the compound file implementation. + Reserved for future use; must be zero. + A pointer to IStream pointer variable that receives the + interface pointer to the newly opened stream object. If an error occurs, *ppstm must be set to NULL. + + S_OK - The stream was successfully opened. + E_PENDING - Asynchronous Storage only: Part or all of the stream data is currently unavailable. + STG_E_ACCESSDENIED - Not enough permissions to open stream. + STG_E_FILENOTFOUND - The stream with specified name does not exist. + STG_E_INSUFFICIENTMEMORY - The stream was not opened due to a lack of memory. + STG_E_INVALIDFLAG - The value specified for the grfMode parameter is not a valid STGM Constants value. + STG_E_INVALIDFUNCTION - The specified combination of flags in the grfMode parameter is not supported; + for example, when this method is called without the STGM_SHARE_EXCLUSIVE flag. + STG_E_INVALIDNAME - Invalid value for pwcsName. + STG_E_INVALIDPOINTER - The pointer specified for the stream object was not valid. + STG_E_INVALIDPARAMETER - One of the parameters was not valid. + STG_E_REVERTED - The storage object has been invalidated by a revert operation above it in the transaction tree. + STG_E_TOOMANYOPENFILES - The stream was not opened because there are too many open files. + + + + + The CreateStorage method creates and opens a new storage object nested within this storage + object with the specified name in the specified access mode. + + A pointer to a wide character null-terminated Unicode string that + contains the name of the newly created storage object. The name can be used later to + reopen the storage object. The name must not exceed 31 characters in length, not + including the string terminator. The 000 through 01f characters, serving as the + first character of the stream/storage name, are reserved for use by OLE. This is a + compound file restriction, not a structured storage restriction. + A value that specifies the access mode to use when opening + the newly created storage object. For more information and a description of possible values + Reserved for future use; must be zero. + Reserved for future use; must be zero. + A pointer, when successful, to the location of the IStorage pointer to + the newly created storage object. This parameter is set to NULL if an error occurs. + + S_OK - The storage object was created successfully. + E_PENDING - Asynchronous Storage only: Part or all of the necessary data is currently unavailable. + STG_E_ACCESSDENIED - Not enough permissions to create storage object. + STG_E_FILEALREADYEXISTS - The name specified for the storage object already exists in the + storage object and the grfMode parameter includes the flag STGM_FAILIFTHERE. + STG_E_INSUFFICIENTMEMORY - The storage object was not created due to a lack of memory. + STG_E_INVALIDFLAG - The value specified for the grfMode parameter is not a valid STGM Constants value. + STG_E_INVALIDFUNCTION - The specified combination of flags in the grfMode parameter is not supported. + STG_E_INVALIDNAME - Not a valid value for pwcsName. + STG_E_INVALIDPOINTER - The pointer specified for the storage object was not valid. + STG_E_INVALIDPARAMETER - One of the parameters was not valid. + STG_E_REVERTED - The storage object has been invalidated by a revert operation above it in the transaction tree. + STG_E_TOOMANYOPENFILES - The storage object was not created because there are too many open files. + STG_S_CONVERTED - The existing stream with the specified name was replaced with a new storage object + containing a single stream called CONTENTS. The new storage object will be added. + + + + + The OpenStorage method opens an existing storage object with the specified name in the specified access mode. + + A pointer to a wide character null-terminated Unicode string that + contains the name of the storage object to open. The 000 through 01f characters, + serving as the first character of the stream/storage name, are reserved for use by + OLE. This is a compound file restriction, not a structured storage restriction. + It is ignored if pstgPriority is non-NULL. + Must be NULL. A non-NULL value will return STG_E_INVALIDPARAMETER. + Specifies the access mode to use when opening the storage object. + For descriptions of the possible values, see STGM Constants. + Other modes you choose must at least specify STGM_SHARE_EXCLUSIVE when calling this method. + Must be NULL. A non-NULL value will return STG_E_INVALIDPARAMETER. + Reserved for future use; must be zero. + When successful, pointer to the location of an IStorage pointer to + the opened storage object. This parameter is set to NULL if an error occurs. + + S_OK - The storage object was opened successfully. + E_PENDING - Asynchronous Storage only: Part or all of the storage's data is currently unavailable. + STG_E_ACCESSDENIED - Not enough permissions to open storage object. + STG_E_FILENOTFOUND - The storage object with the specified name does not exist. + STG_E_INSUFFICIENTMEMORY - The storage object was not opened due to a lack of memory. + STG_E_INVALIDFLAG - The value specified for the grfMode parameter is not a valid STGM Constants value. + STG_E_INVALIDFUNCTION - The specified combination of flags in the grfMode parameter is not supported. + STG_E_INVALIDNAME - Not a valid value for pwcsName. + STG_E_INVALIDPOINTER - The pointer specified for the storage object was not valid. + STG_E_INVALIDPARAMETER - One of the parameters was not valid. + STG_E_REVERTED - The storage object has been invalidated by a revert operation above it in the transaction tree. + STG_E_TOOMANYOPENFILES - The storage object was not created because there are too many open files. + STG_S_CONVERTED - The existing stream with the specified name was replaced with a new storage + object containing a single stream called CONTENTS. In direct mode, the new storage is + immediately written to disk. In transacted mode, the new storage is written to a + temporary storage in memory and later written to disk when it is committed. + + + + + The CopyTo method copies the entire contents of an open storage object to another storage object. + + The number of elements in the array pointed to by rgiidExclude. + If rgiidExclude is NULL, then ciidExclude is ignored. + An array of interface identifiers (IIDs) that either the caller + knows about and does not want copied or that the storage object does not support but whose + state the caller will later explicitly copy. + A string name block (refer to SNB) that specifies a block of storage + or stream objects that are not to be copied to the destination. These elements are not created + at the destination. If IID_IStorage is in the rgiidExclude array, this parameter is ignored. + This parameter may be NULL. + Pointer to the open storage object into which this storage object is to be copied. + + S_OK - The storage object was successfully copied. + E_PENDING - Asynchronous Storage only: Part or all of the data to be copied is currently unavailable. + STG_E_ACCESSDENIED - The destination storage object is a child of the source storage object. + STG_E_INSUFFICIENTMEMORY - The copy was not completed due to a lack of memory. + Otherwise - Error code. + + + + + The MoveElementTo method copies or moves a substorage or stream from this storage + object to another storage object. + + Pointer to a wide character null-terminated Unicode string + that contains the name of the element in this storage object to be moved or copied. + IStorage pointer to the destination storage object. + Pointer to a wide character null-terminated unicode string + that contains the new name for the element in its new storage object. + Specifies whether the operation should be a move (STGMOVE_MOVE) + or a copy (STGMOVE_COPY). See the STGMOVE enumeration. + S_OK - The storage object was successfully copied or moved. + Otherwise error code. + + + + + The Commit method ensures that any changes made to a storage object open in transacted + mode are reflected in the parent storage. + + Controls how the changes are committed to the storage object. + + S_OK - Changes to the storage object were successfully committed to the parent level. + If STGC_CONSOLIDATE was specified, the storage was successfully consolidated, + or the storage was already too compact to consolidate further + Otherwise error code. + + + + + The Revert method discards all changes that have been made to the storage object since the last commit operation. + + + S_OK - The revert operation was successful. + Otherwise error code. + + + + + The EnumElements method retrieves a pointer to an enumerator object that can be used + to enumerate the storage and stream objects contained within this storage object. + + Reserved for future use; must be zero. + Reserved for future use; must be zero. + Reserved for future use; must be zero. + Pointer to IEnumSTATSTG* pointer variable that receives the + interface pointer to the new enumerator object. + + S_OK - The enumerator object was successfully returned. + Otherwise error code. + + + + + The DestroyElement method removes the specified storage or stream from this storage object. + + Pointer to a wide character null-terminated Unicode string that + contains the name of the storage or stream to be removed. + + S_OK - The element was successfully removed. + Otherwise error code. + + + + + The RenameElement method renames the specified substorage or stream in this storage object. + + Pointer to a wide character null-terminated Unicode string that + contains the name of the substorage or stream to be changed. + Pointer to a wide character null-terminated unicode string that + contains the new name for the specified substorage or stream. + S_OK - The element was successfully renamed. + Otherwise error code. + + + + The SetElementTimes method sets the modification, access, and creation times of the + specified storage element, if the underlying file system supports this method. + + The name of the storage object element whose times are to be modified. + If NULL, the time is set on the root storage rather than one of its elements. + Either the new creation time for the element or NULL + if the creation time is not to be modified. + Either the new access time for the element or NULL if the + access time is not to be modified. + Either the new modification time for the element or NULL + if the modification time is not to be modified. + + S_OK - The time values were successfully set. + Otherwise error code. + + + + + The SetClass method assigns the specified class identifier (CLSID) to this storage object. + + The CLSID that is to be associated with the storage object. + S_OK - The CLSID was successfully assigned. + Otherwise error code. + + + + + The SetStateBits method stores up to 32 bits of state information in this storage object. + This method is reserved for future use. + + Specifies the new values of the bits to set. No legal values are + defined for these bits; they are all reserved for future use and must not be used by applications. + A binary mask indicating which bits in grfStateBits are significant in this call. + S_OK - The state information was successfully set. + Otherwise error code. + + + + + The Stat method retrieves the STATSTG structure for this open storage object. + + On return, pointer to a STATSTG structure where this + method places information about the open storage object. This parameter is NULL if an error occurs. + Specifies that some of the members in the STATSTG structure + are not returned, thus saving a memory allocation operation. + Values are taken from the STATFLAG enumeration. + + S_OK - The STATSTG structure was successfully returned at the specified location. + Otherwise error code. + + + + + The IEnumSTATPROPSETSTG interface iterates through an array of STATPROPSETSTG structures. + + + + + The Next method retrieves a specified number of STATPROPSETSTG structures that follow + subsequently in the enumeration sequence. + + The number of STATPROPSETSTG structures requested. + An array of STATPROPSETSTG structures returned. + The number of STATPROPSETSTG structures retrieved in the rgelt parameter. + + + + The Skip method skips a specified number of STATPROPSETSTG structures in the enumeration sequence. + + The number of STATPROPSETSTG structures to skip. + + + + The Reset method resets the enumeration sequence to the beginning of the STATPROPSETSTG structure array. + + + + + The Clone method creates an enumerator that contains the same enumeration state as the current + STATPROPSETSTG structure enumerator. Using this method, a client can record a particular point + in the enumeration sequence and then return to that point later. + + A pointer to the variable that receives the IEnumSTATPROPSETSTG interface pointer. + + + + The IEnumSTATPROPSTG interface iterates through an array of STATPROPSTG structures + + + + + The Next method retrieves a specified number of STATPROPSTG structures, that follow subsequently + in the enumeration sequence. + + The number of STATPROPSTG structures requested. + An array of STATPROPSTG structures returned. + The number of STATPROPSTG structures retrieved in the rgelt parameter. + + + + The Skip method skips the specified number of STATPROPSTG structures in the enumeration sequence. + + The number of STATPROPSTG structures to skip. + + + + The Reset method resets the enumeration sequence to the beginning of the STATPROPSTG structure array. + + + + + The Clone method creates an enumerator that contains the same enumeration state as the current + STATPROPSTG structure enumerator + + A pointer to the variable that receives the IEnumSTATPROPSTG interface pointer. + + + + + + + + + The vt + + + + + The int PTR + + + + + The byte value + + + + + The int value + + + + + The bool value + + + + + The file time + + + + + The double value + + + + + The short value + + + + + The int PTR2 + + + + + The IPropertyStorage interface manages the persistent properties of a single property set. + Persistent properties consist of information that can be stored persistently in a + property set, such as the summary information associated with a file. + + + + + The ReadMultiple method reads specified properties from the current property set. + + The numeric count of properties to be specified in the rgpspec array. + An array of PROPSPEC structures specifies which properties are read. + Properties can be specified either by a property ID or by an optional string name. + Caller-allocated array of a PROPVARIANT structure that, on return, + contains the values of the properties specified by the corresponding elements in the rgpspec array. + + + + The WriteMultiple method writes a specified group of properties to the current property set. + If a property with a specified name or property identifier already exists, it is replaced, + even when the old and new types for the property value are different. + + The number of properties set. The value of this parameter can be set to zero; + An array of the property IDs (PROPSPEC) to which properties are set. + An array (of size cpspec) of PROPVARIANT structures that contain the property values to be written. + The minimum value for the property IDs that the method must assign if the + rgpspec parameter specifies string-named properties for which no property IDs currently exist. + + + + The DeleteMultiple method deletes as many of the indicated properties as exist in this property set. + + The numerical count of properties to be deleted. The value of this parameter can + legally be set to zero, however that defeats the purpose of the method as no properties are thereby + deleted, regardless of the value set in rgpspec. + Properties to be deleted. A mixture of property identifiers and string-named + properties is permitted. There may be duplicates, and there is no requirement that properties be + specified in any order. + + + + The ReadPropertyNames method retrieves any existing string names for the specified property IDs. + + The number of elements on input of the array rgpropid. + The value of this parameter can be set to zero. + An array of property IDs for which names are to be retrieved. + A caller-allocated array of size cpropid of LPWSTR members. + On return, the implementation fills in this array. + + + + The WritePropertyNames method assigns string names to a specified array of property IDs in the current property set. + + The size on input of the array rgpropid. Can be zero. + However, making it zero causes this method to become non-operational. + An array of the property IDs for which names are to be set. + Array of new names to be assigned to the corresponding property + IDs in the rgpropid array. These names may not exceed 255 characters (not including the NULL terminator). + + + + The DeletePropertyNames method deletes specified string names from the current property set. + + The size on input of the array rgpropid. If 0, no property names are deleted. + Property identifiers for which string names are to be deleted. + + + + The IPropertyStorage::Commit method saves changes made to a property storage + object to the parent storage object. + + The flags that specify the conditions under which the commit is to be performed. + + + + The Revert method discards all changes to the named property set since it was last opened or + discards changes that were last committed to the property set. + + + + + The Enum method creates an enumerator object designed to enumerate data of type STATPROPSTG, + which contains information on the current property set. + + Pointer to IEnumSTATPROPSTG pointer variable that receives the interface + pointer to the new enumerator object. + + + + The SetTimes method sets the modification, access, and creation times of this property set, + if supported by the implementation. Not all implementations support all these time values. + + Pointer to the new creation time for the property set. May be NULL, + indicating that this time is not to be modified by this call. + Pointer to the new access time for the property set. May be NULL, + indicating that this time is not to be modified by this call. + Pointer to the new modification time for the property set. May be + NULL, indicating that this time is not to be modified by this call. + + + + The SetClass method assigns a new CLSID to the current property storage object, and + persistently stores the CLSID with the object. + + New CLSID to be associated with the property set. + + + + The Stat method retrieves information about the current open property set. + + Pointer to a STATPROPSETSTG structure, which contains + statistics about the current open property set. + + + + The IPropertySetStorage interface creates, opens, deletes, and enumerates property set + storages that support instances of the IPropertyStorage interface. + + + + + The Create method creates and opens a new property set in the property set storage object. + + The FMTID of the property set to be created. For information about + FMTIDs that are well-known and predefined in the Platform SDK, see Predefined Property Set + Format Identifiers. + A pointer to the initial class identifier CLSID for this property set. + May be NULL, in which case it is set to all zeroes. + The values from PROPSETFLAG Constants. + An access mode in which the newly created property set is to be opened, + taken from certain values of STGM_Constants, as described in the following Remarks section. + A pointer to the output variable that receives the IPropertyStorage interface pointer. + + + + The Open method opens a property set contained in the property set storage object. + + The format identifier (FMTID) of the property set to be opened. + For more information about well-known and predefined FMTIDs in the Platform SDK + The access mode in which the newly created property set is to be + opened. These flags are taken from STGM Constants. + A pointer to the IPropertyStorage pointer variable that receives + the interface pointer to the requested property storage subobject. + + + + The Delete method deletes one of the property sets contained in the property set storage object. + + FMTID of the property set to be deleted. + + + + The Enum method creates an enumerator object which contains information on the + property sets stored in this property set storage. + + Pointer to IEnumSTATPROPSETSTG pointer variable that + receives the interface pointer to the newly created enumerator object. + + + + Class provide access to STG API functions. + + + + + To prevent user from creation of this class instances. + + + + + StgOpenStorage opens an existing root storage object in the file system. You + can use this function to open compound files but you cannot use it to open + directories, files, or summary catalogs. Nested storage objects can only be + opened using their parents' IStorage::OpenStorage method. + + [in] Pointer to the path of the NULL-terminated + Unicode string file containing the storage object to open. This parameter + is ignored if the pstgPriority parameter is not NULL. + Most often NULL. If not NULL, this parameter is + used instead of the pwcsName parameter to specify the pointer to the + IStorage interface on the storage object to open. It points to a previous + opening of a root storage object, most often one that was opened in priority + mode. After the StgOpenStorage function returns, the storage object specified + in the pstgPriority parameter on function entry is not valid and can no + longer be used. Instead, use the storage object specified in the ppStgOpen + parameter. + Specifies the access mode to use to open the + storage object. + If not NULL, pointer to a block of elements in + the storage that are to be excluded as the storage object is opened. The + exclusion occurs regardless of whether a snapshot copy happens on the open. + May be NULL. + Indicates reserved for future use; must be zero. + [out] Pointer IStorage* pointer variable that receives + the interface pointer to the opened storage. + + S_OK + Indicates that the storage object was successfully opened. + STG_E_FILENOTFOUND + Indicates that the specified file does not exist. + STG_E_ACCESSDENIED + Access denied because the caller does not have enough permissions, or another caller + has the file open and locked. + STG_E_LOCKVIOLATION + Access denied because another caller has the file open and locked. + STG_E_SHAREVIOLATION + Access denied because another caller has the file open and locked. + STG_E_FILEALREADYEXISTS + Indicates that the file exists but is not a storage object. + STG_E_TOOMANYOPENFILES + Indicates that the storage object was not opened because there are too many open files. + STG_E_INSUFFICIENTMEMORY + Indicates that the storage object was not opened due to inadequate memory. + STG_E_INVALIDNAME + Indicates a non-valid name in the pwcsName parameter. + STG_E_INVALIDPOINTER + Indicates a non-valid pointer in one of the parameters: snbExclude, pwcsName, + pstgPriority, or ppStgOpen. + STG_E_INVALIDFLAG + Indicates a non-valid flag combination in the grfMode parameter. + STG_E_INVALIDFUNCTION + Indicates STGM_DELETEONRELEASE specified in the grfMode parameter. + STG_E_OLDFORMAT + Indicates that the storage object being opened was created by the Beta 1 storage + provider. This format is no longer supported. + STG_E_NOTSIMPLEFORMAT + Indicates that the STGM_SIMPLE flag was specified in the grfMode parameter and the + storage object being opened was not written in simple mode. + STG_E_OLDDLL + The DLL being used to open this storage object is a version of the DLL that is older + than the one used to create it. + STG_E_PATHNOTFOUND + Specified path does not exist. + STG_E_SHAREVIOLATION + Access denied because another caller has the file open and locked. + + + + + Opens an existing root storage object in the file system. You can use this function + to open compound files and regular files. To create a new file, use the + StgCreateStorageEx function. + + [in] Pointer to the path of the NULL-terminated Unicode + string file containing the storage object. This string size must not exceed + MAX_PATH characters. + [in] Specifies the access mode to open the new storage object. + For more information, see the STGM enumeration. If the caller specifies transacted + mode together with STGM_CREATE or STGM_CONVERT, the overwrite or conversion takes + place when the commit operation is called for the root storage. If IStorage::Commit + is not called for the root storage object, previous contents of the file will be + restored. STGM_CREATE and STGM_CONVERT cannot be combined with the STGM_NOSNAPSHOT + flag, because a snapshot copy is required when a file is overwritten or converted + in the transacted mode. + [in] Specifies the storage file format. For more information, + see the STGFMT enumeration. + [in] Depends on the value of the stgfmt parameter. + STGFMT_DOCFILE should be zero (0) or FILE_FLAG_NO_BUFFERING. + [in, out] Pointer to a STGOPTIONS structure that contains + information about the storage object being opened. The pStgOptions parameter is + valid only if the stgfmt parameter is set to STGFMT_DOCFILE. + [in] Reserved for future use; must be zero. + [in] Specifies the Guid of the interface pointer to return. + [out] Address of an interface pointer variable that + receives a pointer for an interface on the storage object being opened; contains + NULL if operation failed. + + S_OK + Indicates that the storage object was successfully opened. + STG_E_INVALIDPOINTER + Indicates a non-valid pointer in the ppObjectOpen parameter. + STG_E_INVALIDPARAMETER + Indicates a non-valid value for the grfAttrs, reserved1, reserved2, grfMode, or + stgfmt parameters. Can occur if the FILE_FLAG_NO_BUFFERING flag is specified for + grfAttrs but the sector size of the file is not an integer multiple of the + underlying disk's sector size. + E_NOINTERFACE + Indicates that the specified interface is not supported. + STG_E_INVALIDFLAG + Indicates a non-valid flag combination in the grfMode pointer (includes both + STGM_DELETEONRELEASE and STGM_CONVERT flags). + STG_E_INVALIDNAME + Indicates a non-valid name in the pwcsName parameter. + STG_E_INVALIDFUNCTION + Indicates that the grfMode is set to STGM_DELETEONRELEASE. + STG_E_LOCKVIOLATION + Access denied because another caller has the file open and locked. + STG_E_SHAREVIOLATION + Access denied because another caller has the file open and locked. + STG_E_UNIMPLEMENTEDFUNCTION + Indicates that the StgOpenStorageEx function is not implemented by the operating + system. In this case, use the StgOpenStorage function instead. + STG_E_INCOMPLETE + Indicates that the file could not be opened because it is on a high-latency device. + This can only occur if the parameter is IID_IPropertySetStorage, and the + stgfmt parameter is STGFMT_FILE. + STG_E_ACCESSDENIED + Indicates that the file could not be opened because the underlying storage device + does not allow such access to the current user. When opening the storage object + in transacted mode (STGM_TRANSACTED), this error may also indicate that a temporary + file could not be created in the temporary directory as specified by the + GetTempPath function. The GetTempPath function retrieves the path of the directory + designated for temporary files. + + + + + StgCreateDocfile creates a new compound file storage object using the COM-provided + compound file implementation for the IStorage interface. + + [in] Pointer to a NULL-terminated Unicode string name for the + compound file being created. It is passed uninterpreted to the file system. This can + be a relative name or NULL. If NULL, a temporary compound file is allocated with a + unique name. + [in] Specifies the access mode to use when opening the new + storage object. For more information, see the STGM enumeration. If the caller + specifies transacted mode together with STGM_CREATE or STGM_CONVERT, the overwrite + or conversion takes place when the commit operation is called for the root storage. + If IStorage::Commit is not called for the root storage object, previous contents of + the file will be restored. STGM_CREATE and STGM_CONVERT cannot be combined with + the STGM_NOSNAPSHOT flag, because a snapshot copy is required when a file is + overwritten or converted in the transacted mode. + [in] Reserved for future use; must be zero. + [out] Pointer to the location of the IStorage pointer to + the new storage object. + + S_OK - Indicates that the compound file was successfully created. + STG_E_ACCESSDENIED - Access denied because the caller does not have enough permissions + or another caller has the file open and locked. + STG_E_FILEALREADYEXISTS + Indicates that the compound file already exists and grfMode is set to STGM_FAILIFTHERE. + STG_E_INSUFFICIENTMEMORY + Indicates that the compound file was not created due to inadequate memory. + STG_E_INVALIDFLAG + Indicates a non-valid flag combination in the grfMode parameter. + STG_E_INVALIDNAME + Indicates a non-valid name in the pwcsName parameter. + STG_E_INVALIDPOINTER + Indicates a non-valid pointer in the pwcsName parameter or the ppStgOpen parameter. + STG_E_LOCKVIOLATION + Access denied because another caller has the file open and locked. + STG_E_SHAREVIOLATION + Access denied because another caller has the file open and locked. + STG_E_TOOMANYOPENFILES + Indicates that the compound file was not created due to a lack of file handles. + STG_S_CONVERTED + Indicates that the specified file was successfully converted to storage format. + + + + + The StgCreatePropSetStg function creates a property set storage object from a specified storage object. + + Pointer to the storage object that contains or is to + contain one or more property sets. + Reserved for future use; must be zero. + Pointer to IPropertySetStorage* pointer variable that receives the + interface pointer to the property-set storage object. + S_OK - The property set storage object was successfully created. + + + + The StgCreatePropSetStg function creates a property set storage object from a specified storage object. + + Pointer to the storage object that contains or is to + contain one or more property sets. + Reserved for future use; must be zero. + Pointer to IPropertySetStorage* pointer variable that receives the + interface pointer to the property-set storage object. + S_OK - The property set storage object was successfully created. + + + + The CreateILockBytesOnHGlobal function creates a byte array object, using global memory + as the physical device, which is intended to be the compound file foundation. + + The memory handle allocated by the GlobalAlloc function. + A flag that specifies whether the underlying handle for + this byte array object should be automatically freed when the object is released. + The address of ILockBytes pointer variable that receives the interface + pointer to the new byte array object. + S_OK - The byte array object was created successfully. + + + + The StgCreateDocfileOnILockBytes function creates and opens a new compound file + storage object on top of a byte-array object provided by the caller. + + A pointer to the ILockBytes interface on the underlying + byte-array object on which to create a compound file. + Specifies the access mode to use when opening the new compound file. + For more information, see STGM Constants. + Reserved for future use; must be zero. + A pointer to the location of the IStorage pointer on the new storage object. + + S_OK - Indicates that the compound file was successfully created. + Otherwise error code. + + + + + The StgOpenStorageOnILockBytes function opens an existing storage object that does not reside in a + disk file, but instead has an underlying byte array provided by the caller. + + ILockBytes pointer to the underlying byte array object that contains the + storage object to be opened. + Most often NULL. If not NULL, this parameter is used instead of the + plkbyt parameter to specify the storage object to open. In this case, it points to the IStorage + interface on a previously opened root storage object, most often one that was opened in priority mode. + Specifies the access mode to use to open the storage object. + Can be NULL. If not NULL, this parameter points to a block of elements in this + storage that are to be excluded as the storage object is opened. This exclusion occurs independently of + whether a snapshot copy happens on the open. + Indicates reserved for future use; must be zero. + Points to the location of an IStorage pointer to the opened storage on successful return. + S_OK - The storage object was successfully opened. + Otherwise error code. + + + + + The GlobalAlloc function allocates the specified number of bytes from the heap. + Windows memory management does not provide a separate local heap and global heap. + + Memory allocation attributes. + Number of bytes to allocate. + + If the function succeeds, the return value is a handle to the newly + allocated memory object. If the function fails, the return value is NULL. + To get extended error information, call GetLastError. + + + + + + + + + + + + + + + + + + + + + Flags for GlobalAlloc function. + + + + + Allocates fixed memory. The return value is a pointer. + + + + + Allocates movable memory. Memory blocks are never moved in physical memory, + but they can be moved within the default heap. + + + + + Initializes memory contents to zero. + + + + + NO Discard memory. + + + + + Storage API wrapper classes provide access to storage data from .NET code. + + + + + Open storage in read-only mode. + + + + + Open storage stream in read-only mode. + + + + + Create a new stream in storage. + + + + + Open storage or stream in ReadWrite mode. + + + + + Default buffer size for stream copying. + + + + + Options to open storage in read-only mode. Used to open already opened file. + + + + + Reference in COM interface which provides access to stream in storage. + + + + + Reference in COM interface which provide access to storage. + + + + + True if class was disposed; otherwise False. + + + + + True if stream supports read operation; otherwise False. + + + + + True stream supports write operation; otherwise False. + + + + + True if stream supports seek operation; otherwise False. + + + + + True if stream opened in Transaction mode and on Flush method call + class must commit transaction; otherwise False. + + + + + Length of stream data. + + + + + List of streams names provided by storage. + + + + + List of storage names found in current storage. + + + + + File name of storage. + + + + + Stream name. + + + + + Sub-storage name opened by class. + + + + + Storage Mode: Open or Create. + + + + + Stream Mode: Open or Create. + + + + + Current stream position, used for optimization. Allows users + to skip Seek operations if required. + + + + + Represents the locking bytes. + + + + + Closes the stream. + + + + + Commit changes. + + + + + Commit changes. + + Commit code. + + When commit operation fails. + + + + + Discards all changes that have been made to the storage object + since the last commit operation. + + + + + Seek in stream. + + New offset. + Start point for Seek operation. + Current position. + + When seek operation fails. + + + + + Set stream length. + + New stream length + + When SetLength operation fails. + + + + + Read data from stream. + + Output stream. + Offset in output buffer. + Quantity of bytes to read. + Quantity of read bytes. + + When buffer is NULL. + + + When offset or count is less than zero. + + + When there are not enough items in the buffer. + + + When Read operation fails. + + + + + Write data to stream. + + Buffer with data. + Offset in input buffer from which data started. + Quantity of bytes which must be written. + + When buffer is NULL. + + + When offset or count is less than zero. + + + When there are not enough items in the buffer + or stream is in Read-only mode. + + + When Write operation fails. + + + + + To prevent class creation by default constructor. + + + + + Open storage/compound file. + + File name of storage. + Mode which must be used for open operation. + + When fileName is NULL. + + + Couldn't open the storage + + + + + Open storage and one stream of it. + + File name of storage. + Flags that are used for storage open. + Stream name. + Flags which used for stream in storage open. + + + + Open storage and its stream in Read-only mode. + + File name. + Stream name. + + + + Open storage in Read-only mode but do not open stream. To open + special stream, use OpenStream methods. + + Storage file name. + + + + Inherit stream storage and opens its stream in Read-only mode. + + Storage of stream. + Stream name to open. + + + + Inherit stream storage and opensits streams with the user specified flags. + + Storage to inherit. + Stream name. + Stream open flags. + + + + Open or create stream specified by user name. + + Inherited storage. + Stream name. + True to create stream; otherwise open. + + + + Inherit storage and open or create in it stream with spcified user name + + Inherited storage. + Stream name. + Stream open / create flags. + True to create stream; otherwise open. + + + + Create a new instance of StgStream. + + Base stream. + Flags for create stream. + + + + Create a new instance of StgStream by defoult flag. + + Base stream. + + + + Dispose stream. Close stream, release references on COM interfaces, and + free resources. + + + + + Open stream in Read-only mode. + + Stream name. + + + + Open stream from storage with specified flags. + + Stream name. + Stream open flags. + + When streamName is NULL. + + + When the specified stream could not be found in the storage. + + + When it was not possible to open the stream. + + + + + Opens sub storage. + + Storage name to open. + Returns stream of opened storage. + + + + Opens sub storage. + + Storage name to open. + Open flags. + Returns stream of opened storage. + + + + Creates sub storage. + + Storage name to Create. + Returns stream of opened storage. + + + + Creates sub storage. + + Storage name for create. + Create flags. + Returns stream for created storage. + + + + Create stream in opened storage with specified name. + + Stream name. + + + + Create stream in storage with specified name and flags. + + Stream name. + Stream flags. + + When its not possible to create stream. + + + + + Saves internal ILockBytes into stream. + + Stream to save into. + + + + Searches for stream name in the streams array ignoring case. + + Stream name to locate. + Name of the stream in the storage. + + + + Indicates whether storage contains required stream. + + Stream to search. + True if stream was found. + + + + Indicates whether storage contains required substorage. + + Storage to search. + True if stream was found. + + + + Removes the specified storage or stream from this storage object. + + Name of the storage or stream to be removed. + + 0 - The element was successfully removed. + Otherwise error code. + + + + + Copies one storage into another. + + Source stream. + Destination stream. + + + + Method to create new storage and return StgStream class for it. + + Storage file name. + Reference on instance which knows how to work with it. + + When compound file couldn't be created. + + + + + Cretes storage on ILockBytes. + + Created storage. + + + + Check storage availability. + + + If storage is NULL. + + + + + Check stream availability. + + + When stream is NULL. + + + + + Calculate stream length. + + Returns length of currently open stream. + + + + Returns list of streams stored in storage. + + List of stream names. + + When elements of the storage couldn't be enumerated . + + + When it is possible to get IEnumSTATSTG interface reference from storage. + + + + + Return list of sub-storages found in current storage. + + List of found storages. + + + + Calculates subItems names. + + + + + Adds data. + + Item to add. + Collection to add. + + + + Adds data as stream type. + + Item to add. + Collection where adding is. + + + + Adds data as all type. + + Item to add. + Collection where adding is. + + + + Calculates subItems. + + SubItem event handler. + User data. + + + + Indicates if stream supports Read operation. Read-only. + + + + + Indicates if stream supports Seek operation. Read-only. + + + + + Indicates if stream supports Write operation. Read-only. + + + + + Indicates if stream is opened in Transaction mode. Read-only. + + + + + Length of stream. Read-only. + + + + + Gets / sets current position of stream. + + + + + Gets list of stream names found in storage. Read-only. + + + + + Gets the array of string thet is a storages. + + + + + Reference in COM interface which provide access to storage. + + + + + Reference in COM interface which provide access to stream in storage. + + + + + Get name of stream opened by the class. + + + + + Get name of sub storage opened by the class. + + + + + Gets the IlockBytes interface that represen the locked bytes. + + + + + Gets the file name. + + + + + Delegate that represents subItem name event. + + + + + Compound storage implementation based on standard COM-object. + + + + + Default storage name. Used for root storage, others should assign some other value. + + + + + + + + + + Collection with storage names. + + + + + Collection with stream names. + + + + + Name of the storage. + + + + + Calculates subItems names. + + + + + Adds data. + + Item to add. + Collection to add. + + + + Adds data as stream type. + + Item to add. + Collection where adding is. + + + + Adds data as all type. + + Item to add. + Collection where adding is. + + + + Calculates subItems. + + SubItem event handler. + User data. + + + + Initializes new instance of the class. + + Name of the file to open. + Storage options. + + + + Initializes new instance of the storage. + + Root substorage. + + + + Initializes new instance of te storage. + + Root substorage. + Name of the storage. + + + + Destructor. + + + + + Creates new stream inside this storage. + + Name of the stream to create. + Created stream object. + + + + Opens existing stream inside this storage. + + Name of the stream to open. + + + + + Removes existing stream from this storage. + + Name of the stream to remove. + + + + Determines whether storage contains specified stream. + + Name of the stream to check. + true if storage contains specified stream. + + + + Creates new substorage inside this one. + + Name of the storage to create. + Created storage object. + + + + Opens existing substorage inside this one. + + Name of the storage to open. + Created storage object. + + + + Removes exisiting substorage from this one. + + Name of the storage to remove. + + + + Determines whether this storage contains substorage with specified name. + + Name of the storage to check. + true if storage contains substorage with specified name. + + + + Commits changes. + + + + + Inserts copy of the storage and all subitems inside current storage. + + Storage to copy. + + + + Inserts copy of the stream inside current storage. + + Stream to copy. + + + + + + + + + Returns internal COM storage. This property will be removed after implementing + some document properties reading. + + + + + Returns all stream names that are placed inside this stream. + + + + + Returns all storage names that are placed inside this stream. + + + + + Returns name of the storage. + + + + + Delegate that represents subItem name event. + + + + + The PropVariant is used for defining the type tag and + the value of a property in a property set. + + + + + Represents the property data. + + + + + Sets property value. + + Value to set. + Type of the property to set. + + + + Gets property value. + + + + + Sets type of the variant. Write-only. + + + + + Name of the property. + + + + + Gets property id. + + + + + Offset to the type of the PropVariant. + + + + + Offset to the first int of the data. + + + + + Size of the integer. + + + + + Mask to get type of property or each element of the arrya (if property contains an array). + + + + + Bit mask for lower int value. + + + + + Bit mask for higher int value. + + + + + Number of bits in every integer value. + + + + + Difference in ticks of FILETIME and DateTime. + + + + + Bit mask for LinkToContent property of the DocumentProperty class. + + + + + Size of the native windows PROPVARIANT structure. + + + + + Offset to the second int of the data. + + + + + Array of IntPtr that should be freed on dispose using Marshal.FreeCoTaskMem. + + + + + Array of IntPtr that should be freed on dispose using Marshal.FreeHGlobal. + + + + + Pointer to the PropVariant. + + + + + Specifies a property by its property identifier (ID). + + + + + Array of PropVariants that will be disposed in Dispose method. + + + + + If True, then memory for the structure was allocated by + this class and should be freed on Dispose; + otherwise, memory was not allocated by this class and should not be freed. + + + + + Default constructor. + + + + + Creates PropVariant with data pointed by ptr. + + + + + + Reads data from IPropertyStorage. + + Property description. + IPropertyStorage to read data from. + Indicates whether property is built-in or not. + + + + Returns array of strings. + + + + + Converts IntPtr to the string. + + Value to convert. + Converted string. + + + + Parses not unicode string. + + Pointer to the sring to parse. + + + + + Returns an array of objects. + + + + + Fills PropVariant with array of strings. + + + + + Fills PropVariant with array of objects. + + + + + Sets Blob property value. + + Value to set. + + + + Sets property name. + + Name to set. + + + + Sets property value. + + Value to set. + Type of the property to set. + + + + Frees all allocated resources. + + + + + Frees resuources allocated for property name storage. + + + + + + + + + + + Writes variant to the property storage. + + + Property storage that will receive PropVariant value. + + + + + Reads information from the storage. + + Property information. + Storage to read from. + Indicates whether property is built-in. + + + + Reads information from the storage. + + Storage to read from. + Indicates whether property is built-in. + + + + Performs tasks associated with freeing, releasing, + or resetting unmanaged resources. + + + + + Finilizer. + + + + + Gets or sets the int16. + + The int16. + + + + Fills PropVariant with integer value. + + + + + Fills PropVariant with integer value. + + + + + Gets / sets PropVariant memory. + + + + + ID of the property that will be written into property storage. + + + + + Same as PropId. + + + + + Fills PropVariant with FILETIME value. + + + + + Fills PropVariant with bool value. + + + + + Fills PropVariant with string value. + + + + + Fills PropVariant with string value. + + + + + Fills PropVariant with FILETIME value. + + + + + Fills PropVariant with double value. + + + + + Gets / sets property name. + + + + + Returns value of the property. Read-only. + + + + + Indicates whether it is property or just link to source of some property. Read-only. + + + + + Returns id of the parent property. Read-only. + + + + + Gets property id. + + + + + Sets first integer value of the variant. Write-only. + + + + + Sets second integer value of the variant. Write-only. + + + + + Sets type of the variant. Write-only. + + + + + Represents the clipboard data. + + + + + Clipboard format. + + + + + Clipboard data. + + + + + Createas copy of the current object. + + A copy of the current object. + + + + Saves clipboard data into stream. + + Stream to write data into. + Size of the written data. + + + + Extracts data from the stream. + + Stream to get data from. + + + + .Net compound file implementation. + + + + + Name of the root entry. + + + + + Source stream. + + + + + File header. + + + + + + + + + + + + + + + + + + + + Root storage. + + + + + Short stream. + + + + + Stream containing items described by minifat. + + + + + MiniFAT. + + + + + Indicates whether substreams should maintain their own stream or should write + directly into the file's stream. + + + + + + + + + + Writes directory structure into file. + + Destination path. + Directory to write. + + + + Writes storage to specified path + + Destination path. + Storage to write. + + + + Writes stream into file + + Destination path. + Stream name. + Parent storage object. + + + + Default constructor. + + + + + Default constructor. + + + + + Default constructor. + + + + + + + + + + + Initializes internal variables. + + + + + + + + + + + + + + + + + + + + + Sets stream data for directory entry. + + Directory entry to update stream data for. + Stream to set. + + + + Sets entrie's long stream. + + Entry to update data for. + Data to set. + + + + Sets entrie's short stream. + + Entry to update data for. + Data to set. + + + + Writes stream data into compound file main stream + + Main stream to write into. + Start sector to write. + Stream to write. + Fat object. + + + + Here we have to allocate required sectors number. + + Entry to allocate sectors for. + Number of already allocated sectors. + Number of required sectors. + FAT object. + + + + Allocates sectors. + + Start sector in the chain. + Number of already allocated sectors. + Number of required sectors. + Fat object. + Start sector of the added chain. + + + + Gets offset to the sector. + + Zero-based sector index. + Sector shift (2^sectorShift = sector size). + Offset to the required sector. + + + + Gets offset to the sector. + + Zero-based sector index. + Sector shift (2^sectorShift = sector size). + Size of the header. + Offset to the required sector. + + + + Checks whether stream header belongs to compound file. + + Stream to check. + True if stream probably contains compound file data. + + + + Allocates new directory entry. + + Name of the stream. + Entry type. + Created directory entry. + + + + Marks item as free. + + Directory entry to be removed/freed. + + + + Reads data from internal stream. + + Entry to read data from. + Position inside entry stream. + Buffer that will cotain read data. + Size of the data to read. + Number of actually read bytes. + + + + Writes data into internal stream. + + Entry to write data into. + Position inside entry stream. + Buffer containing data to write. + Offset inside buffer to the data to write. + Size of the data to write. + + + + Saves compound file into stream. + + Stream to save data into. + + + + Writes internal stream into specified one. + + Destination stream to write into. + + + + Saves mini stream data. + + + + + Serializes directory entries. + + + + + Saves compound file into file. + + Name of the file to save into. + + + + Performs application-defined tasks associated with freeing, + releasing, or resetting unmanaged resources. + + + + + + + + + + + + + + + Returns root storage. + + + + + + + + + + + + + + + Returns base stream. Read-only. + + + + + Gets or sets value indicating whether substreams should maintain their own stream + or should write directly into the file's stream. + + + + + Returns root storage object for this file. + + + + + This is exception thrown when experiencing problems with compound file. + + + + + Default exception message. + + + + + Default constructor. + + + + + Initializes new instance of the exception. + + Exception message. + + + + + + + + + RBTree with child elements. + + + + + + + + + + Initializes new instance of the storage. + + Parent file. + Name of the new storage. + Index to the directory entry that stores storage information. + + + + Initializes new instance of the storage. + + Parent compound file object. + Entry that describes current storage. + + + + + + + + + + Creates new stream. + + Name of the stream to create. + Created stream. + + + + Opens stream. + + Name of the stream to open. + Opened stream or null if there is no such stream. + + + + Removes stream from the storage, if it contains stream with such name. + + Stream name to delete. + + + + Checks whether storage contains stream with specified name. + + Name of the stream to check. + True if storage has stream with such name; false otherwise. + + + + Opens existing storage. + + Name of the storage to open. + Opened storage item or null if it was impossible to open it. + + + + Removes substorage from existing storage. + + Name of the storage to remove. + + + + + + + + + Checks whether this storage contains substorage with specified name. + + Name to check. + True if there is such storage; false otherwise. + + + + + + + + + Returns directory entry id that corresponds to the specified node. + + + + + + + Returns name of the storage. + + + + + Returns directory entry for this stream. + + + + + .Net implementation of the compound stream. + + + + + Parent file item. + + + + + Directory entry of this stream. + + + + + Stream with data. If it is null, then data hasn't been read yet or stream is closed. + + + + + Initializes new instance of the stream. + + Parent file object. + Entry that describes this stream item. + + + + + + + + + Reads a sequence of bytes from the current stream and advances the position + within the stream by the number of bytes read. + + An array of bytes. When this method returns, the buffer + contains the specified byte array with the values between offset and + (offset + count - 1) replaced by the bytes read from the current source. + The zero-based byte offset in buffer at which to begin + storing the data read from the current stream. + The maximum number of bytes to be read from the current stream. + The total number of bytes read into the buffer. This can be less than + the number of bytes requested if that many bytes are not currently available, + or zero (0) if the end of the stream has been reached. + + + + writes a sequence of bytes to the current stream and advances the current + position within this stream by the number of bytes written. + + An array of bytes. This method copies count bytes + from buffer to the current stream. + The zero-based byte offset in buffer at which to + begin copying bytes to the current stream. + The number of bytes to be written to the current stream. + + + + Sets the position within the current stream. + + A byte offset relative to the origin parameter. + A value of type SeekOrigin indicating the reference + point used to obtain the new position. + The new position within the current stream. + + + + Sets the length of the current stream. + + The desired length of the current stream in bytes. + + + + Causes any buffered data to be written to the underlying compound file. + + + + + Releases the unmanaged resources used by the Stream and optionally releases the managed resources. + + true to release both managed and unmanaged resources; + false to release only unmanaged resources. + + + + Returns directory entry for this stream. + + + + + Gets the length in bytes of the stream. Read-only. + + + + + Gets or sets the position within the current stream. + + + + + Gets a value indicating whether the current stream supports reading. + + + + + Gets a value indicating whether the current stream supports seeking. + + + + + Gets a value indicating whether the current stream supports writing. + + + + + This is wrapper over compound stream object. Simply redirects all calls to it + with one exception - it doesn't dispose underlying stream object. + + + + + Wrapped stream object. + + + + + Initializes new instance of the wrapper. + + Object to wrap. + + + + Causes any buffered data to be written to the underlying compound file. + + + + + Reads a sequence of bytes from the current stream and advances the position + within the stream by the number of bytes read. + + An array of bytes. When this method returns, the buffer + contains the specified byte array with the values between offset and + (offset + count - 1) replaced by the bytes read from the current source. + The zero-based byte offset in buffer at which to begin + storing the data read from the current stream. + The maximum number of bytes to be read from the current stream. + The total number of bytes read into the buffer. This can be less than + the number of bytes requested if that many bytes are not currently available, + or zero (0) if the end of the stream has been reached. + + + + Sets the position within the current stream. + + A byte offset relative to the origin parameter. + A value of type SeekOrigin indicating the reference + point used to obtain the new position. + The new position within the current stream. + + + + Sets the length of the current stream. + + The desired length of the current stream in bytes. + + + + writes a sequence of bytes to the current stream and advances the current + position within this stream by the number of bytes written. + + An array of bytes. This method copies count bytes + from buffer to the current stream. + The zero-based byte offset in buffer at which to + begin copying bytes to the current stream. + The number of bytes to be written to the current stream. + + + + + + + + + + Gets a value indicating whether the current stream supports reading. + + + + + Gets a value indicating whether the current stream supports seeking. + + + + + Gets a value indicating whether the current stream supports writing. + + + + + Gets the length in bytes of the stream. Read-only. + + + + + Gets or sets the position within the current stream. + + + + + Number of items in the file header. + + + + + List of all fat sector ids. + + + + + List with used Dif sectors. + + + + + Default constructor. + + + + + + + + + + + + Adds required number of DIF sectors. + + Number of sectors to add. + FAT object. + + + + + + + + + This class represents directory structure in the compound file. + + + + + List of directory entries. + + + + + Default constructor. + + + + + Initializes new instance of the directory. + + Data to parse. + + + + Searches for empty entry index. + + Index of the first empty directory entry. + + + + Adds new entry to the collection or replaces existing empty entry with this one. + + Entry to add. + + + + Saves directory entries into specified stream. + + Stream to save directory into. + + + + Returns list of directory entries. + + + + + Represents single directory entry in the compound file. + + + + + Size of a single directory entry. + + + + + Size of the stream name field. + + + + + Entry name. + + + + + Entry type. + + + + + Entry "color" in red-black tree. + + + + + Id of the left-sibling. + + + + + Id of the right-sibling. + + + + + Id of the child acting as the root of all the children of thes element (if entry type if Storage). + + + + + Storage CLSID. + + + + + User flags of this storage. + + + + + Create time-stamp for a storage. + + + + + Modify time-stamp for a storage. + + + + + Starting stream sector. + + + + + Stream size. + + + + + Reserved. Must be zero. + + + + + Entry id. + + + + + Last sector id. + + + + + Initializes new instance of the entry. + + Name of the new entry. + Type of the new entry. + Id of the new entry. + + + + Initializes new instance of the entry. + + Data of the new entry. + Offset to the entry data. + Entry id. + + + + Writes directory entry data inside specified stream. + + Stream to write data into. + + + + Entry name. + + + + + Entry type. + + + + + Entry "color" in red-black tree. + + + + + Id of the left-sibling. + + + + + Id of the right-sibling. + + + + + Id of the child acting as the root of all the children of thes element (if entry type if Storage). + + + + + Storage CLSID. + + + + + User flags of this storage. + + + + + Create time-stamp for a storage. + + + + + Modify time-stamp for a storage. + + + + + Starting stream sector. + + + + + Stream size. + + + + + Reserved. Must be zero. + + + + + Returns entry id. Read-only. + + + + + Possible entry types. + + + + + Invalid entry. + + + + + Entry is storage. + + + + + Entry is stream. + + + + + Root entry. + + + + + Document properties enumerator. + + + + + Offset to the first section. + + + + + List of all sections. + + + + + Default constructor. + + + + + Initializes new instance of the enumerator. + + Stream to parse. + + + + Extracts sections data from the stream. + + + + + + Extracts header information from the stream. + + + + + + Saves all sections into stream. + + Stream to save sections into. + + + + Extracts header information from the stream. + + + + + + Saves collection into stream. + + + + + + Returns list lf all sections. + + + + + This class represents FAT object in the compound file. + + + + + + + + + + List with free sectors. + + + + + Sector size. + + + + + + + + + + Default constructor. + + + + + Default constructor. + + + + + Initializes new instance of the fat. + + Parent compound file object. + Stream to extract fat from. + DIF object to help in parsing + File header object. + + + + Gets data of the compound file substream. + + Stream with compound file data. + First sector of the stream to get. + Parent compound file object. + + + + + Gets index of the next sector in the chain. + + Index of the current sector in the chain. + Next sector in the chain. + + + + Closes sectors chain by marking all those sectors as free starting from specified one. + + + + + + Enlarges existing sectors chain. + + Last sector in the chain that requires enlargment. + Number of sectors to add. + Index of the chain start (used when chain wasn't created before). + + + + Frees specified sector. + + Sector to free. + + + + Allocates required number of new sectors. + + Start sector index. + Number of sectors to allocate. + First sector in the new part of the chain. + + + + Allocates required number of free sectors. + + Start sector index (this value points to the last used sector after this operation). + Number of sectors to allocate. + First sector in the new part of the chain + + + + Saves fat data into stream. + + Stream to write fat data into. + DIF object to update after writing. + File header. + + + + Allocates required number of fat sectors. + + Number of sectors that must be allocated. + DIF structure that contains info about fat sectors sequence. + + + + Fills single fat sector. + + Index in the fat to start writing from. + Sector to fill. + First item that wasn't saved inside sector. + + + + Allocates new sector of the specified sector type. + + Sector type to allocate. + Allocated sector index. + + + + Adds single sector to the stream. + + Index of the added sector. + + + + Writes fat data directly into a stream. + + Stream to write data into. + Size of the sector to use for writing. + + + + Evaluates sector offset. + + Zero-based sector index to evaluate offset for. + Offset to the sector start. + + + + Evaluates number of sectors in the sector chain starting from the specified sector. + + Starting sector of the entry to enumerate. + Number of sectros in the sector chain. + + + + Sector size. + + + + + This class represents compound file header. + + + + + Size of the header. + + + + + Signature size. + + + + + Default (and the only supported) signature. + + + + + File signature. + + + + + Class id. + + + + + Minor version of the format. + + + + + Major version of the dll/format. + + + + + Byte order, 0xFFFE for Intel byte-ordering. + + + + + Size of sectors in power-of-two (typically 9). + + + + + Size of mini-sectors in power-of-two (typically 6). + + + + + Reserved, must be zero. + + + + + Reserved, must be zero. + + + + + Reserved, must be zero. + + + + + Number of sectors in the FAT chain. + + + + + First sector in the directory chain. + + + + + Signature used for transactioning, must be zero. + + + + + Maximum size for mini-streams. Typically 4096 bytes. + + + + + First sector in the mini-FAT chain. + + + + + Number of sectors in the mini-FAT chain. + + + + + First sector in the DIF chain. + + + + + Number of sectors in the DIF chain. + + + + + First 109 fat sectors. + + + + + Default constructor. + + + + + Initializes new instance of the file header and extracts data from the stream. + + Stream to extract header data from. + + + + Saves header into specified stream. + + Stream to write header into. + + + + Checks whether starting bytes of the stream are the same as signature of the compound file. + + Stream to check. + True if stream contains required signature. + + + + Checks whether signature is supported. + + + + + Checks whether signature is supported. + + Data to compare with default signature. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Size of the sector. Read-only. + + + + + Minor version of the format. + + + + + Major version of the dll/format. + + + + + Byte order, 0xFFFE for Intel byte-ordering. + + + + + Size of sectors in power-of-two (typically 9). + + + + + Size of mini-sectors in power-of-two (typically 6). + + + + + Reserved, must be zero. + + + + + Reserved, must be zero. + + + + + Reserved, must be zero. + + + + + Number of sectors in the FAT chain. + + + + + First sector in the directory chain. + + + + + Signature used for transactioning, must be zero. + + + + + Maximum size for mini-streams. Typically 4096 bytes. + + + + + First sector in the mini-FAT chain. + + + + + Number of sectors in the mini-FAT chain. + + + + + First sector in the DIF chain. + + + + + Number of sectors in the DIF chain. + + + + + First 109 fat sectors. + + + + + This comparer is used to compare item names inside storage. + + + + + Compares two objects 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. + + Less than zero if x is less than y. + Zero if x equals y. + Greater than zero if x is greater than y. + + + + + Compares two objects 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. + + Less than zero if x is less than y. + Zero if x equals y. + Greater than zero if x is greater than y. + + + + + Suitable Node colors used for 2-3-4 nodes detection. + + + + + Red color of node. + + + + + Black color of node. + + + + + Node class used for proper storing of data in the Map Collection. + + + + + Reference on left branch. + + + + + Reference on right branch. + + + + + Reference on parent branch. + + + + + Color of node branch. + + + + + Is current node Nil element or not? + + + + + Key part of stored in node data. + + + + + Value part of stored in node data. + + + + + Create red colored Tree node. + + Reference on left branch. + Reference on parent branch. + Refernce on right branch. + Key value of node. + Value part of node. + + + + Main constructor of class. + + Reference on left branch. + Reference on parent branch. + Refernce on right branch. + Key value of node. + Value part of node. + Color of node. + + + + Reference on left branch. + + + + + Reference on right branch. + + + + + Reference on parent branch. + + + + + Color of node branch. + + + + + Is current node Nil element or not? + + + + + Key part of stored in node data. + + + + + Value part of stored in node data. + + + + + Is current node set to red color? + + + + + Is current node set to black color? + + + + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + Create collection with specified comparer for Key values. + + Comparer for key values. + + + + Create Empty node for collection. + + + + + Clear collection. + + + + + Add item into collection. + + Key part. + Value. + + + + Check whether collection contains specified key. + + True if node with specified key is found; otherwise False. + Key for check. + + + + Remove from collection item with specified key. + + Key to identify item. + + + + TODO: place correct comment here + + + TODO: place correct comment here + + + + + Get minimum value for specified branch. + + Branch start node. + Reference on minimum value node. + + + + Get maximum value for specified branch. + + Branch start node. + Reference on maximum value node. + + + + Go to to next item in collection. + + Start node. + Reference on next item in collection or this.Empty if nothing found. + + + + Get previous item from collection. + + Start node. + Rererence on previous item in collection. + + + + Find node in collection by key value (search in lower side). + + Key of node to find. + Reference on found node, otherwise this.Empty value. + + + + Find node in collection by key value (search in upper side). + + Key of node to find. + Reference on found node, otherwise this.Empty value. + + + + Rotate branch into left side. + + Branch start node. + + + + Rotate branch into right side. + + Branch start node. + + + + Erase node from collection. + + Item to erase. + + + + Insert item into collection. + + Add into left side of tree or right. + Node for placement. + Key part of node. + Value part of node. + + + + Returns enumerator. + + Returns enumerator of current interface. + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + Bit mask for LinkToContent property of the DocumentProperty class. + + + + + Initializes new isntance of the PropertyData. + + + + + Initializes new instance of the property data. + + Id for the new property.. + + + + Extracts property data from the stream. + + Stream to get data from. + + + + Extracts property data from the stream. + + Stream to get data from. + + + + Determines whether [is valid property]. + + + + + + Extracts vector data from the stream. + + + + + + + + Extracts vector data from the stream. + + + + + + + + Creates array of the specified type. + + Item type. + Number of elements in the array. + Created array object. + + + + Extracts single value from the stream. + + + + + + + + + Extracts single value from the stream. + + + + + + + + + Gets DateTime object data from the stream. + + Stream to get data from. + Buffer used to extract blob parts. + Extracted DateTime data. + + + + Gets blob data from the stream. + + Stream to get blob data from. + Buffer used to extract blob parts. + Blob data. + + + + Gets clipboard data from the stream. + + Stream to get data from. + Buffer that can be used to extract clipboard data parts. + Clipboard data. + + + + Gets object value from the stream. + + Stream to get data from. + Maximum size of the data to extract. + Extracted object. + + + + Gets object value from the stream. + + Stream to get data from. + Maximum size of the data to extract. + Extracted object. + + + + Writes object into the stream. + + Stream to write data into. + Object to write. + Size of the written data. + + + + Writes property data into the stream. + + Stream to write data into. + Number of written bytes. + + + + Serializes names dictionary. + + Stream to serialize into. + Dictionary to serialize. + Size of the serialized data. + + + + Serializes vector data. + + + + + + + + Serializes single value into the stream. + + Stream to serialize into. + Value to serialize. + Value type. + Size of the written data. + + + + Serializes blob data. + + Stream to write blob into. + Blob value to write. + Size of the written data. + + + + Sets property value. + + Value to set. + Type of the property to set. + + + + Indicates whether it is property or just link to source of some property. Read-only. + + + + + Returns id of the parent property. Read-only. + + + + + GEts or sets property id. + + + + + Offset to the section header. + + + + + Section id. + + + + + Section size. + + + + + Contains all section properties. + + + + + Code page of the section. + + + + + Initializes new instance of the section. + + + + + + + Extracts properties from the stream. + + Stream to get section from. + + + + Parses dictionary based on the internal variables value. + + Stream to get dictionary from. + Dictionary to fill if necessary. + + + + Parses property names. + + Stream to get property data from. + Information about dictionary placement inside stream. + Parsed dictionary. + + + + Parses special properties (they shouldn't be visible to user and they contain some information). + + + + + + + + + Parses property names based on previously stored internal information. + + Stream to get data from. + Parsed dictionary. + + + + Saves section into stream. + + Stream to save section into. + + + + Prepares property name dictionary. + + Dictionary with property names. Key - property id, value - property name. + + + + Offset to the section header. + + + + + Section id. + + + + + Section size. + + + + + Properties count. + + + + + Gets list of all properties. + + + + + Contains constants that defines all known sector types. + + + + + Represents the stream helper. + + + + + Size of the Int32 in bytes. + + + + + Size of the Int162 in bytes. + + + + + Size of the Double in bytes. + + + + + Reads Int16 value from the stream. + + Stream to get data from. + Temporary buffer to put extracted bytes into. + Extracted Int32 value. + + + + Reads Int32 value from the stream. + + Stream to get data from. + Temporary buffer to put extracted bytes into. + Extracted Int32 value. + + + + Reads Double value from the stream. + + Stream to get data from. + Temporary buffer to put extracted bytes into. + Extracted Double value. + + + + Writes Int16 value from the stream. + + Stream to get data from. + Value to write. + Size of the written data. + + + + Writes Int32 value from the stream. + + Stream to write data into. + Value to write. + Size of the written data. + + + + Reads Double value from the stream. + + Stream to get data from. + Temporary buffer to put extracted bytes into. + Extracted Double value. + + + + Gets ASCII string from the stream starting from the current position. + + Stream to get data from. + Approximate string size. + Extracted string. + + + + Gets ASCII string from the stream starting from the current position. + + Stream to get data from. + Approximate string size. + Extracted string. + + + + Extracts unicode string from the stream. + + + + + + + + Gets ASCII string from the stream starting from the current position. + + Stream to get data from. + Approximate string size. + Extracted string. + + + + Writes unicode string into steram. + + Stream to write data into. + Value to write. + Size of the written data in bytes. + + + + Writes string into stream using specified encoding. + + Stream to write data into. + Value to write. + Encoding to use. + Size of the written data in bytes. + + + + Adds padding if necessary. + + + + + + + Removes last zero character from the string if it is present. + + Value to check. + String after removal. + + + + This is wrapper over compound stream object. Simply redirects all calls to it + with one exception - it doesn't dispose underlying stream object. + + + + + Wrapped storage object. + + + + + Initializes new instance of the wrapper. + + Object to wrap. + + + + Frees all allocated resources. + + + + + Creates new stream inside this storage. + + Name of the stream to create. + Created stream object. + + + + Opens existing stream inside this storage. + + Name of the stream to open. + + + + + Removes existing stream from this storage. + + Name of the stream to remove. + + + + Determines whether storage contains specified stream. + + Name of the stream to check. + true if storage contains specified stream. + + + + Creates new substorage inside this one. + + Name of the storage to create. + Created storage object. + + + + Opens existing substorage inside this one. + + Name of the storage to open. + Created storage object. + + + + Removes exisiting substorage from this one. + + Name of the storage to remove. + + + + Determines whether this storage contains substorage with specified name. + + Name of the storage to check. + true if storage contains substorage with specified name. + + + + Commits changes. + + + + + Returns all stream names that are placed inside this stream. + + + + + Returns all storage names that are placed inside this stream. + + + + + Returns name of the storage. + + + + + Returns directory entry for this stream. + + + + + .Net implementation of the compound stream. + + + + + Stream position. + + + + + Initializes new instance of the stream. + + Parent file object. + Entry that describes this stream item. + + + + + + + + + Reads a sequence of bytes from the current stream and advances the position + within the stream by the number of bytes read. + + An array of bytes. When this method returns, the buffer + contains the specified byte array with the values between offset and + (offset + count - 1) replaced by the bytes read from the current source. + The zero-based byte offset in buffer at which to begin + storing the data read from the current stream. + The maximum number of bytes to be read from the current stream. + The total number of bytes read into the buffer. This can be less than + the number of bytes requested if that many bytes are not currently available, + or zero (0) if the end of the stream has been reached. + + + + writes a sequence of bytes to the current stream and advances the current + position within this stream by the number of bytes written. + + An array of bytes. This method copies count bytes + from buffer to the current stream. + The zero-based byte offset in buffer at which to + begin copying bytes to the current stream. + The number of bytes to be written to the current stream. + + + + Sets the position within the current stream. + + A byte offset relative to the origin parameter. + A value of type SeekOrigin indicating the reference + point used to obtain the new position. + The new position within the current stream. + + + + Sets the length of the current stream. + + The desired length of the current stream in bytes. + + + + Causes any buffered data to be written to the underlying compound file. + + + + + Gets the length in bytes of the stream. Read-only. + + + + + Gets or sets the position within the current stream. + + + + + Creates ODS converter with the workbook. + + The workbook to be converted to ODS format. + + + + Convert XlsIO fonts to ODF fonts. + + + + + Converts given XLS/XLSX file to ODS. + + Name of the output file. + + + + Converts given XLS/XLSX file to ODS. + + Name of the output file. + + + + Maps fonts, cell styles, page setup and master styles between XLS/XLSX and ODS formats. + + + + + Converts XlsIO styles to ODF styles and serializes the same. + + + + + Converts and serializes inline styles to ODF styles. + + + + + Converts sheet properties. + + + + + + + Maps fonts, inline styles and sheet data between XLS/XLSX and ODS formats. + + + + + Converts number formats to ODF styles. + + + + + Converts named styles to ODF styles. + + The ODF styles collection. + + + + + Convert single style to ODF style. + + The format record for a single style. + The ODF style to be populated. + + + + + Populated ODF styles with paragraph properties. + + + + + + + Maps XlsIO text alignment to ODF text alignment. + + value. + Equivalent value. + + + + Maps XlsIO text alignment to ODF text alignment. + + value. + Equivalent value. + + + + Maps XlsIO style name to default ODF style name. + + + The modified ODF style name. + + + + Converts XlsIO column style to ODF table column style. + + The column info record. + The ODF table column. + The ODF style collection. + The ODF table column mapped with style name. + + + + Converts XlsIO row style to ODF table row style. + + The row storage record. + The ODF table row. + The ODF style collection. + The ODF table column populated with row style. + + + + Converts XlsIO sheet to ODF table style. + + The worksheet to be converted. + The ODF tabe to be populated. + The ODF style collection. + + + + + Populates ODF table column properties. + + The column record. + Populated table column properties of ODF table column style. + + + + Populates ODF table row properties. + + The row storage record. + Populated table row properties of ODF table row style. + + + + Populates table cell properties in ODF table cell style. + + The format record. + The ODF table cell style to be populated. + + + + Populates text properties in ODF table cell style. + + The format record. + The ODF table cell style to be populated. + + + + Maps XlsIO underline style to ODF underline style of type . + + The text properties of single ODF table cell. + Undreline style of type . + + + + Maps page layout styles and master page styles. + + + + + Populates page layout properties in ODF page layout style. + + The page setup class. + The ODF page layout. + + + + Gets ODF column styles from XlsIO column collection. + + The worksheet in which the columns are present. + The equivalent ODF table. + The ODF style collection. + + + + COnverts XlsIO sheet data to ODF table content. + + The ODF style collection to include row and column styles. + + + + Gets ODS comment from XlsIO comment object. + + The sheet in which the comment is present. + The comment to be converted. + The table cell in which the comment is to be set. + The style collection of the sheet to hold the comment styles. + + + + Gets content style for the comment. + + The comment shape for which style is to be extracted. + The style object for the comment shape. + + + + Adds a span of specified text and style to the specified paragraph. + + The span text. + The sapn style. + Paragraph to which the span is to be added. + + + + Maps graphic fill properties between XlsIO and ODS. + + Fill type in XlsIO. + Fill type in ODS. + + + + Gets style for span elements in the comment text. + + Font index of the span. + Default font for the comemnt text. + + + + + Populate ODF styles with paragraph properties. + + + + + + + Gets cell type of ODF cell. + + The cell index of XlsIO range. + The ODF table cell. + The worksheet in which the range is present. + The cell collection. + The row in which the cell is present. + + + + Loads default ODF row style. + + The ODF style collection. + The worksheet to populate default ODF row style. + + + + Loads default ODF column style. + + The ODF style collection. + The worksheet to populate default ODF column style. + + + + Serializes populated ODF tables. + + Collection of ODF tables. + + + + Gets ODF table cell style name. + + The cell position. + The ODF style collection. + The oDF table cell. + + + + Populates page layout properties in ODF page layout style. + + The page setup class. + The ODF page layout. + + + + Populates header footer styles in ODF page layout. + + The page setup class. + The ODF page layout. + + + + Populates ODF master page from page setup. + + The page setup class. + The ODF page layout. + + + + Populates header footer in master page. + + The page setup class. + The ODF page layout. + + + + Populates ODF border line styles. + + The ODF border. + Border line style of type . + ODF border line style of type + + + + Updates the used range considering comments. + + Represents the worksheet. + The updated used range's last column. + + + + Dispose the ExcelToODSConverter. + + + + + Generate default name. + + Start string. + Collection with names. + Returns new name. + + + + Field type is not Specifies. + + + + + Specifies Addins. + + + + + Offset subsequent text within a line to the left, right, up or down. + + + + + Prompt the user for text to assign to a bookmark. + + + + + The name of the document's author from Summary Info. + + + + + Insert an automatic number. + + + + + Insert an automatic number in legal format. + + + + + Insert an automatic number in outline format. + + + + + Insert an AutoText entry. + + + + + Insert text based on style. + + + + + Insert a delivery point barcode. + + + + + The comments from Summary Info. + + + + + Compares two values. + + + + + The date the document was created. + + + + + Specifies data. + + + + + Insert data from an external database. + + + + + Specified Today`s Date. + + + + + Specified Type as FieldDDE. + + + + + Specified Type as FieldDDEAuto. + + + + + Insert the value of the property. + + + + + Insert the value of the document variable. + + + + + The total document editing time. + + + + + Specifies OLE embedded object. + + + + + Specified Empty Field. + + + + + Specifies Field Expression. + + + + + The document's name. + + + + + The size on disk of the active document. + + + + + Prompt the user for text to insert in the document. + + + + + Specifies FieldType as FootnoteRef. + + + + + Specifies Check box control. + + + + + Specifies Drop Down box control. + + + + + Specifies Text control. + + + + + Calculates the result of an expression. + + + + + Specifies FieldGlossary. + + + + + Specifies GoToButton control. + + + + + Specifies HTMLActiveX control. + + + + + Specifies Hyperlink control. + + + + + Evaluate arguments conditionally. + + + + + Specifies FieldType as Import. + + + + + Specifies FieldType as Export. + + + + + Insert a picture from a file. + + + + + Insert text from a file. + + + + + Create an index. + + + + + Mark an index entry. + + + + + Data from Summary Info. + + + + + The keywords from Summary Info. + + + + + Name of user who last saved the document. + + + + + Linked OLE2 object. + + + + + Insert an element in a list. + + + + + Run a macro. + + + + + Insert a mail merge field. + + + + + The number of the current merge record. + + + + + Merge record sequence number. + + + + + Go to the next record in a mail merge. + + + + + Conditionally go to the next record in a mail merge. + + + + + Insert the number of a footnote or endnote. + + + + + The number of characters in the document. + + + + + The number of pages in the document. + + + + + The number of words in the document. + + + + + Represents an ActiveX control such as a command button etc. + + + + + Insert the number of the current page. + + + + + Insert the number of the page containing the specified bookmark. + + + + + Download commands to a printer. + + + + + The date the document was last printed. + + + + + Stores data for documents converted from other file formats. + + + + + Insert literal text. + + + + + Insert the text marked by a bookmark. + + + + + Create an index, table of contents, table of figures, and/or table of authorities by using multiple documents. + + + + + Insert the number of times the document has been saved. + + + + + The date the document was last saved. + + + + + Insert the number of the current section. + + + + + Insert the total number of pages in the section. + + + + + Insert an automatic sequence number. + + + + + Assign new text to a bookmark. + + + + + Conditionally skip a record in a mail merge. + + + + + Insert the text from a like-style paragraph. + + + + + The document's subject from Summary Info. + + + + + The document's Subscriber from Summary Info. + + + + + Insert a special character + + + + + The name of the template attached to the document. + + + + + The current time. + + + + + The document's title from Summary Info. + + + + + Create a table of authorities. + + + + + Make a table of authorities entry. + + + + + Create a table of contents. + + + + + Make a table of contents entry. + + + + + Address from Tools Options User Info. + + + + + Initials form Tools Options User Info. + + + + + Name from Tools Options User Info. + + + + + Specifies FieldType as Shape. + + + + + Specifies FieldType as BIDIOUTLINE. + + + + + Specifies AddressBlock + + + + + Specifies FieldType as Unknown. + + + + + Tab stop leader + + + + + No leader. + + + + + Dotted leader. + + + + + Hyphenated leader. + + + + + Single line leader. + + + + + Heavy line leader. + + + + + Specifies paragraph text is aligned to the left. + + + + + Specifies paragraph text is aligned to the center. + + + + + Specifies paragraph text is aligned to the right. + + + + + Specifies paragraph text is aligned to both left and right. + + + + + Specifies paragraph characters are distributed to fill the entire width of the paragraph. + + + + + Specifies paragraph uses medium-length Kashida, if the language is Arabic. In other languages, paragraph text is justified with a medium character compression ratio. + + + + + Specifies paragraph uses longer length Kashida, if the language is Arabic. In other languages, paragraph text is justified with a high character compression ratio. + + + + + Specifies paragraph uses small length Kashida, if the language is Arabic. In other languages, paragraph text is justified with a high character compression ratio. + + + + + Specifies paragraph text is justified with Thai distributed justification, if the language is Thai. In other languages, text is justified with a low character compression ratio. + + + + + Specifies the text wrap style. + + + + + In line with text. + + + + + Top and bottom. + + + + + Wraps text around the shape. Line continuation is on the opposite side of the shape. + + + + + Places shape in front of text. + + + + + Tight. + + + + + Through. + + + + + Places shape behind text. + + + + + Represents the caption angle type. + + + + + Fixed caption angle type. + + + + + Free caption angle type. + + + + + Represents the caption escape direction. + + + + + Horizontal caption escape direction. + + + + + Vertical caption escape direction. + + + + + Auto caption escape direction. + + + + + Represents the caption type. + + + + + Straight line caption type. + + + + + Angled line caption type. + + + + + Angled connector line caption type. + + + + + Represents the color mode. + + + + + Greyscale color mode. + + + + + Mono color mode. + + + + + Watermark color mode. + + + + + Represents the draw aspect. + + + + + Content draw aspect. + + + + + Thumbnail draw aspect. + + + + + Icon draw aspect. + + + + + Print view draw aspect. + + + + + Represents drawing fill type. + + + + + No fill. + + + + + Solid fill. + + + + + Bitmap fill. + + + + + Gradient fill. + + + + + Hatch fill. + + + + + Represents reference point for image. + + + + + Top left. + + + + + Top. + + + + + Top right. + + + + + Left. + + + + + Center. + + + + + Right. + + + + + Bottom left. + + + + + Bottom. + + + + + Bottom right. + + + + + Represents measure align type. + + + + + Autmatic measure align. + + + + + Left outside measure align. + + + + + Inside measure align. + + + + + Right outside measure align. + + + + + Represents vertical measure align. + + + + + Automatic vertical measure align. + + + + + Above vertical measure align. + + + + + Below vertical measure align. + + + + + Center vertical measure align. + + + + + Represents shadow. + + + + + Visible shadow. + + + + + Hidden shadow. + + + + + Represents stroke. + + + + + No stroke. + + + + + Dash stroke. + + + + + Solid stroke. + + + + + Represents stroke line join. + + + + + Miter join. + + + + + Round join. + + + + + Bevel join. + + + + + Middle join. + + + + + No join. + + + + + Inherited join. + + + + + Represents text area horizontal alignment. + + + + + Left align. + + + + + Center align. + + + + + Right align. + + + + + Justify. + + + + + Represents text area vertical alignment. + + + + + Top align. + + + + + Middle align. + + + + + Bottom align. + + + + + Justify. + + + + + Represents measure units. + + + + + Auto. + + + + + Millimeter (mm). + + + + + Centimeter (cm). + + + + + Meter (m). + + + + + Kilometer (km). + + + + + Point (pt). + + + + + Pica (pc). + + + + + Inch (inch). + + + + + Feet (ft). + + + + + Mile (mi). + + + + + Represents how fill property paints the shape. + + + + + if the result is zero then the point is outside the path. Otherwise, it is inside. + + + + + If this number is odd, the point is inside; if even, the point is outside. + + + + + Represents the shape to be used at the end of open subpaths when they are stroked. + + + + + Butt shape. + + + + + Square shape. + + + + + Round shape. + + + + + Closing the instance + + + + + Gets/Sets the Continuous section Textbody first item + + + + + Gets/Sets the Continuous section Textbody last item + + + + + Gets/Sets the section style name for the OTextbodyItem + + + + + Gets/Sets the list level number for the Paragraph + + + + + Gets the HeaderFooterContent child items + + + + + Gets or sets the name of the object. + + + + + Gets the Even page footer + + + + + Gets the First page header content + + + + + Gets the First page footer content + + + + + Collection of all the styles in the workbook. + + + + + Adds specified style into this collection. + + Style that must be added. + + + + Collection of all the styles in the workbook. + + + + + Adds specified style into this collection. + + Style that must be added. + + + + Adds specified style into this collection. + + Style that must be added. + + + + Gets/Sets the current page layout columns count + + + + + Gets/Sets the current page layout columns gap + + + + + Collection of all the styles in the workbook. + + + + + Adds specified style into this collection. + + Style that must be added. + + + + First visible character. + + + + + Chars with codes less than 0x20 which are allowed to be used inside xml strings. + + + + + Saves the document to ODS format. + + + + + + Serializes doument manifest which specifies the files in the arhive. + + + + + Serializes the mimetype value. + + + + + Serializes meta data file. + + + + + Checks whether specified string is hexadecimal number. + + + + + + + + This class holds the name of the Syncfusion.XlsIO.Base assembly and provides a helper + routine that helps with resolving types when loading a serialization stream and when + the framework probes for assemblies by reflection. + + + + + The full name of this assembly without version information: "Syncfusion.XlsIO" + + + + + A reference to the for the XlsIO assembly. + + + + + The root namespace of this assembly. Used internally for locating resources within the assembly. + + + + + This delegate helps with resolving types and can be used as a eventhandler + for a event. + + The source of the event. + The event data with information about the type. + A reference to the assembly where the type is located. + + Use this handler when reading back types from a serialization stread + saved with an earlier version of this assembly. + + + + public static GridModel LoadSoap(Stream s) + { + try + { + AppDomain.CurrentDomain.AssemblyResolve += new ResolveEventHandler(GridAssembly.AssemblyResolver); + SoapFormatter b = new SoapFormatter(); + b.AssemblyFormat = FormatterAssemblyStyle.Simple; + GridModel t = b.Deserialize(s) as GridModel; + t.Modified = false; + return t; + } + finally + { + AppDomain.CurrentDomain.AssemblyResolve -= new ResolveEventHandler(GridAssembly.AssemblyResolver); + } + } + + + + + + This class gives access to the XlsIO IApplication interface. + + + + + Storage of XlsIO Application object which provides an IApplication interface + + + + + Indicates if the class was disposed. + TRUE - If the class was disposed, otherwise FALSE + + + + + TRUE - Throw exception when object is disposed and it's data was + not saved, otherwise FALSE + + + + + Default constructor. + + + + + Destructor. + + + + + Releases all resources used by this XlsIO object. + + + Thrown when ThrowNotSavedOnDestoy property is set to TRUE and XlsIO + object data was not saved. + + + + + Checks whether license is valid. + + + + + Interface to the XlsIO Application which gives + access to all supported functions. + + + + + Dispose will throw an ExcelWorkbookNotSavedException when the workbook is not saved + and this property is set to TRUE. Default value is FALSE. + + + + + Checks whether security permission can be granted. Read-only. + + + + + Exception that will be thrown when the user tries to dispose XlsIO + application without saving it. + + + + + + Creates new ExcelWorkbookNotSavedException. + + Text that showed after rising. + + + + Initializes a new instance of the Exception 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. + If the innerException parameter is not a null reference + (Nothing in Visual Basic), the current exception is raised + in a catch block that handles the inner exception. + + + + + Represents config xls class. + + + + + + Creates xls config object. + + + + + Gets Copyright string. Read-only. + + + + + Specifies the display format for a property. + + + + + Initializes a new instance of the class using the display format. + + The display format. + + + + Get or set the number format for data. + + + + The display format. + + + + + Class used for format parsing. + + + + + Constant Exponential symbol + + + + + constant Hash Symbol + + + + + List with all known format tokens. + + + + + Regular expression for checking if specified switch argument present in numberformat. + + + + + Initializes a new instance of the FormatParserImpl class. + + Represents current application. + Represents parent object. + + + + Parses format string. + + String to parse. + Collection with parsed tokens. + + + + Class used for Format Section. + + + + + Return this value when element wasn't found. + + + + + Thousand separator. + + + + + Minus sign. + + + + + Default round off digit. + + + + + Default fraction token. + + + + + Maximum month token length. + + + + + Table for token type detection. Value in TokenType arrays must be sorted. + + + + + Break tokens when locating hour token. + + + + + Break tokens when locating second token. + + + + + Possible digit tokens in the millisecond token. + + + + + Date Tokens + + + + + Time Tokens + + + + + Array of tokens. + + + + + Indicates whether format is prepared. + + + + + Position of decimal separator. + + + + + Position of E/E+ or E- signs in format string. + + + + + Last digit. + + + + + Indicates whether there are groups after last digit. + + + + + Number of digits in decimal fraction part. + + + + + Number of digits in integer part of number. + + + + + Number of digits after scientific(E) sign. + + + + + Position where fraction sign '/' was met for the first time. + + + + + Indicates whether number format contains fraction sign. + + + + + Start of the fraction numerator group. + + + + + End of the fraction denumerator group. + + + + + Length of the denumerator. + + + + + + Fixed base value in fraction format. + + + + + + End position of the decimal value. + + + + + Condition token. + + + + + Culture token. Used to display values. + + + + + Section format type. + + + + + Indicates whether we digits must be grouped. + + + + + Indicates whether more than one decimal point was met in the format string. + + + + + Indicates whether we should use system + + + + + Indicates whether we should use system Time settings + + + + + Indicates whether the milli second format having the value + + + + + Initializes a new instance of the FormatSection class. + + Represents current application. + Represents parent object. + + + + Initializes a new instance of the FormatSection class based on array of tokens. + + Represents current application. + Represents parent object. + Array of section's tokens. + + + + Prepares format if necessary. + + + + + Checks whether digits must be grouped. + + True if digits must be grouped, otherwise returns false. + + + + Prepares tokens and sets iternal position pointers. + + + + + Prepares insignificant digits that are present in decimal fraction part of this section. + + + + + Searches for corresponding hour token. + + Start index to search. + Corresponding hour token. + + + + Applies format to the value. + + Value to apply format to. + String representation of the value. + + + + Applies format to the value. + + Value to apply format to. + String representation of the value. + + + + Applies format to the value. + + + + + Applies format to the value. + + Value to apply format to. + Indicates whether to show reserved symbols. + String representation of the value. + + + + Applies format to the value. + + Value to apply format to. + Indicates whether to show reserved symbols. + Current cell + String representation of the value. + + + + Apply round off the given number based column width. + + string value. + Current cell + round off the number based on column width. + + + + Gets fraction base value from the number format string. + + The fraction base value. + + + + Updated denominator string format in fraction number format. + + The denominator string to be manipulated. + The manipulated denominator string. + + + + The string is formatted based on number of fraction digits. + + The string to be formatted to fraction. + The formatted string. + + + + Round the input value and avoid double imprecision calculation in core + + the fraction part + the decimal part + the value indicates the numer of fraction digits + the rounded value + + + + Applies format to the value. + + Value to apply format to. + Indicates whether to show reserved symbols. + String representation of the value. + + + + Assigns position to the variable and checks if it wasn't assigned + before (throws ForamtException if it was). + + Variable to assign. + Current position. + + + + Applies part of the format tokens to the value. + + Value to apply format to. + Indicates whether to show reserved symbols. + Start format token. + End format token. + Indicates whether token index should be increased after each step. + String representation of the value. + + + + Applies part of the format tokens to the value. + + Value to apply format to. + Indicates whether to show reserved symbols. + Start format token. + End format token. + Indicates whether token index should be increased after each step. + Indicates whether to group digit tokens. + Indicates whether we should add negative sign before first digit token. + String representation of the value. + + + + Applies thousand separator for exponential formats. + + Exponential string + Exponential string that have thousand separator + + + + Applies digit token to the value. + + Represents a digit token to apply. + Digit index. + Represents Start index of the range. + Represents Value to apply digit token to. + Represents digit counter. + Represents the StringBuilder to add value to. + Boolean value indicating direction of the apply cycle. + Boolean value indicating whether we should show hidden symbols. + Boolean value indicating whether digits are grouped. + Value of the digit count. + + + + Applies digit token to the value. + + Digit index. + Represents start index. + Represents digit counter. + Represents result of token string. + Represents the StringBuilder to add value to. + Boolean value indicating direction of the apply cycle. + Boolean value indicating whether digits are grouped. + Number of digits. + + + + Adds value to a StringBuilder. + + The StringBuilder to add value to. + Indicates whether we should call append method or insert. + Value to add. + + + + Checks whether iPos is inside range of correct values. + + End token index. + Indicates whether position is increasing each cycle. + Current position. + Value indicating whether iPos in inside of range of valid values. + + + + Locates last digit of the decimal fraction. + + Value of last decimal digit. + + + + Locates last group symbols. + + Start index to search. + Value indicating whether groups are present after last decimal digit. + + + + Applies last groups tokens. + + Value to apply to. + Indicates whether to show hidden symbols (reserved place). + + + + Prepares value for format application. + + Value to apply to. + Indicates whether to show hidden symbols (reserved place). + + + + Calculates number of fraction digits. + + Number of fraction digits. + + + + Calculates number of digits in the integer part of format string. + + Number of digits in the integer part of format string. + + + + Calculates number of digits in the specified range. + + Start index of the range. + End index of the range. + Number of digits in the specified range. + + + + Searches for block of digits that correspond to the fraction. + + + + + Searches for start of the group of digits. + + Start position to search. + Direction of the search: true - from left to right, false - from right to left. + Position of the start of the group. + + + + Indicates whether range contains any digits. + + Start range index. + End range index. + Value indicating whether range contains any digits. + + + + Indicates whether range contains any significant digits. + + Start range index. + End range index. + Value indicating whether range contains any digits. + + + + Checks whether value value meets the condition. + + Value to check. + True if value meets the condition; otherwise returns False. + + + + Tries to detect format type. + + + + + Checks whether section contains only specified token types. + + Array with possible tokens. + Value indicating whether the section contains only specified token types. + + + + Check whether this token is really minute token and substitutes it by Month if necessary. + + Token index to check. + + + + Searches for required time token. + + Start token index. + Types of tokens that could stop search process. + Indicates whether we have to increase token index on each iteration. + Types of token to search. + Index of the found token or -1 if token was not found. + + + + Sets to all second tokens. + + + + + Indicates whether type of specified token is in the array of tokens. + + Array of tokens to check. + Token type to locate. + True if token type is in the array of possible tokens. + + + + Splits value into integer and decimal parts. + + Value to split. + Return fraction value. + Integer value. + + + + Rounds value. + + Represents value to be rounded. + Rounded Value. + + + + Creates a new object that is a copy of the current instance. + + Represents parent object. + A new object that is a copy of this instance. + + + + Indicate whether the format string in time format + + + + + Indicate whether the format string in date format + + + + + Returns single token from the section. Read-only. + + + + + Gets the number of tokens in the section. + + + + + Gets a value indicating whether section contains condition. Read-only. + + + + + Gets the section type. + + + + + Gets the culture used for conversion. Read-only. + + + + + Gets a value indicating whether number format contains fraction sign. Read-only. + + + + + Gets a value indicating whether section contains E/E+ or E- signs in format string. + + + + + Gets or Set the boolean if milli second format having the value. + + + + + Gets a value indicating whether thousand separator is present in number format. Read-only. + + + + + Gets the number of digits after "." sign. Read-only. + + + + + Gets the number of digits after scientific(E) sign. Read-only. + + + + + Class used for Section Collection. + + + + + Two many sections error message. + + + + + Maximum number of sections in "conditional mode". + + + + + Maximum number of secionts in "non-conditional mode"; + + + + + Index of section with positive number format. + + + + + Index of section with negative number format. + + + + + Index of section with positive number format. + + + + + Index of section with positive number format. + + + + + Indicates whether format contains conditions. + + + + + Initializes a new instance of the FormatSectionCollection class to prevent creation without arguments. + + Represents current application. + Represents parent object. + + + + Initializes a new instance of the FormatSectionCollection class. + + Represents current application. + Represents parent object. + List to parse. + + + + Returns format type for a specified value. + + Value to get format type for. + Format type for the specified value. + + + + Returns format type for a specified value. + + Value to get format type for. + Format type for the specified value. + + + + Splits array of tokens by SectionSeparator. + + List to parse. + + + + Applies format to the value. + + Value to apply format to. + Indicates whether to show reserved symbols. + String representation of the value. + + + + Applies format to the value. + + Value to apply format to. + Indicates whether to show reserved symbols. + Current cell + String representation of the value. + + + + Applies format to the value. + + Value to apply format to. + Indicates whether to show reserved symbols. + String representation of the value. + + + + Returns section for formatting with specified index. + + Section index. + Format section that should be to the value. + + + + Returns section that corresponds to the specified value. + + Value to search section for. + If section is found then returns it, otherwise returns Null. + + + + Searches for section that should be used for zero number formatting. + + Section that should be used for zero number formatting. + + + + Returns text section. + + Text format section. + + + + Indicate whether the format string in time format + + + + + Indicate whether the format string in date format + + + + + Creates a new object that is a copy of the current instance. + + Represents parent object. + A new object that is a copy of this instance. + + + + This class is used to apply conditional formatting to the cells. + + + + + This object is used to evaluate formula. + + + + + Object that is used to compare two string objects. + + + + + CF applied range. + + + + + Conditional format rectangle collection. + + + + + Indicates whether the worksheet calculation is enabled or not. + + + + + Difference between current cell column and first range column. + + + + + Difference between current cell row and first range row. + + + + + First range from conditional format applied multi range. + + + + + Differnece between first range row and least row for conditional format using multi range. + + + + + Contains calculated values for the conditional format formulas. + + + + + Contains formulas for the conditional formats. + + + + + Contains cell index for top10 conditional format. + + + + + Contains cell index and cell values for top10 and AboveAverage conditional formatting. + + + + + Contains average and standard deviation of AboveAverage conditional formatting range. + + + + + Represent the minimum value of conditional format applied range. + + + + + Represent the maximum value of conditional format applied range. + + + + + Indicates whether the conditional format applied range have negative value or not. + + + + + Indicates whether the color scale conditional format color has applied or not. + + + + + CF applied range. + + CF range + + + + Setting conditional format rectangle collection. + + CF range + + + + Applies cf to the specified cell and format if necessary. + + Cell to check condition for. + ExtendedFormat to apply to. + Modified extended format or null if no modifications required. + + + + Applies cf number format to the specified cell and format if necessary. + + Cell to check condition for. + ExtendedFormat to apply to. + Modified extended format or null if no modifications required. + + + + Applies cf to the specified cell and format if necessary with improved performance. + + + + + Check and applies condition if necessary. + + Format to check and apply. + Cell to check condition for. + ExtendedFormat to apply to. + Modified extended format or null if no modifications required. + + + + Update the conditional format range. + + Conditional format applied range rectange top. + Conditional format applied range rectange left. + Conditional format applied range rectange bottom. + Conditional format applied range rectange right. + Worksheet used range last row. + Worksheet used range last colum + Last row in conditional format applied range. + Last column in conditional format applied range + + + + Checks and applies condition if value is Duplicate or Unique. + + Format to check and apply. + Cell to check condition for. + ExtendedFormat to apply to. + Modified extended format or null if no modifications required. + + + + Checks and applies condition if value is Duplicate or Unique. + + Format to check and apply. + Cell to check condition for. + return the boolean value is true.cell is duplicate otherwise cell is unique + + + + Checks and applies condition if condition type is Value. + + Format to check and apply. + Cell to check condition for. + ExtendedFormat to apply to. + Modified extended format or null if no modifications required. + + + + Checks whether cell value is between value1 and value2. + + Cell to check. + The first value to compare. + The second value to compare. + True if cell value is between value1 and value2. + + + + Checks whether cell value is equal to value. + + Cell to check. + Value to check. + True if cell value is equal to value. + + + + Checks whether cell value is greater than value. + + Cell to check. + Value to check. + True if cell value is greater than value. + + + + Checks whether cell value is greater than or equal to value. + + Cell to check. + Value to check. + True if cell value is greater than or equal to value. + + + + Checks whether cell value is less than value. + + Cell to check. + Value to check. + True if cell value is less than value. + + + + Checks whether cell value is less than or equal to value. + + Cell to check. + Value to check. + True if cell value is greater than or equal to value. + + + + Checks whether cell value is not between value1 and value2. + + Cell to check. + The first value to compare. + The second value to compare. + True if cell value is not between value1 and value2. + + + + Checks whether cell value is not equal to value. + + Cell to check. + Value to check. + True if cell value is not equal to value. + + + + Compares cell value and specified value. + + Cell to check. + Value to check. + Int.MinValue if was unable to compare, 0 if equal, 1 if greater, -1 if less. + + + + Checks and applies condition if condition type is Formula. + + Format to check and apply. + Cell to check condition for. + ExtendedFormat to apply to. + Modified extended format or null if no modifications required. + + + + Checks and applies condition if condition type is Formula. + + Format to check and apply. + Cell to check condition for. + ExtendedFormat to apply to. + Conditional format first formula + Modified extended format or null if no modifications required. + + + + Update the conditional format formula. + + Conditional format + Current cell + ExtendedFormat + Formula string + updated formula string + + + + Checks if the contional format formula has error Ptg. + + Array of Ptgs from parsed formula + True if the array has an error Ptg. Otherwise False. + + + + Checks and applies condition if condition type is SpecificText. + + Format to check and apply. + Cell to check condition for. + ExtendedFormat to apply to. + Modified extended format or null if no modifications required. + + + + Checks if the cell contains the specified text + + The cell to which conditional format is applied + The text to be compared with the cell's text + True if the cell contains the specified text + + + + Checks if the cell does not contain the specified text + + The cell in which conditional format is applied + The text to be compared with the cell's text + True if the cell does not contain the specified text + + + + Checks if the cell has text beginning with the specified text + + The cell in which conditional format is applied + The text to be compared with the cell's text + True if the cell's text begins with the specified text + + + + Checks if the cell has text ending with the specified text + + The cell in which conditional format is applied + The text to be compared with the cell's text + + + + + Checks and applies condition if value is in Top10 list. + + Format to check and apply. + Cell to check condition for. + ExtendedFormat to apply to. + Modified extended format or null if no modifications required. + + + + Checks and applies condition if value is in AboveAverage. + + Format to check and apply. + Cell to check condition for. + ExtendedFormat to apply to. + Modified extended format or null if no modifications required. + + + + Check and apply condition for time period conditional format. + + Format to check and apply. + Cell to check condition for + ExtendedFormat to apply to + Modified extended format or null if no modifications required. + + + + Get all cell values for Top10 and AboveAverage CF rule. + + Format to check and apply. + Cell to check condition for. + + + + Extract the Top10 cells from entire range. + + Format to check and apply. + Cell to check condition for. + + + + Computes and returns the Standard Deviation of the given cell values. + + The array containing the cell values. + The standard deviation of the given cell values. + + + + Computes and returns the Average of the given cell values. + + The array containing the cell values. + The Average of given cell values. + + + + Computes and returns Variance of the given values. + + The array containing the cell values. + The Average cell values. + The variance of the given cell values. + + + + Applies condition settings to specified Extended format. + + Condition to apply. + ExtendedFormat to apply settings to. + + + + + Applies condition settings to specified Extended format. + + Icon name to be set for the format. + IconSet to be set for te format. + IconId to be set for the format. + ExtendedFormat to apply settings to. + True if only icon is displayed for the format. False otherwise. + The updated extended format. + + + + Updates font settings. + + Conditional format to get settings from. + Extended format to update. + + + + Updates font settings. + + Conditional format to get settings from. + Extended format to update. + + + + Update fill settings. + + Conditional format to get settings from. + Extended format to update. + + + + Updates pattern color if necessary. + + Conditional format to get settings from. + Extended format to update. + + + + Updates background color if necessary. + + Conditional format to get settings from. + Extended format to update. + + + + Updates font color if necessary. + + Conditional format to get settings from. + Extended format to update. + + + + Updates pattern format if necessary. + + Conditional format to get settings from. + Extended format to update. + + + + Updates font format if necessary. + + Conditional format to get settings from. + Extended format to update. + + + + Updates border format if necessary. + + Conditional format to get settings from. + Extended format to update. + + + + Gets the image for icon sets. + + Represents current cell. + Represents the Icon Set object. + Icon Sets format range. + Extended format of the cell. + + + + Maps custom icon name with id to the icon set image. + + ustom icon name folowwed by id. + The icon set image. + + + + Checks for invalid conditional type for icon sets. + + Condition value for an icon criteria. + True if the icon set has highest/lowest conditional value type. False otherwise. + + + + Get the condition value and check the operator of condition. + + Current cell. + Icon Set condition. + Icon set format range. + If true, the operator is greaterThan, else greater than equalto. + + + + Get the conditional value for different format types for conditional formats. + + Indicates the current cell. + Conditional value for conditional format objects (IconSets). + Indicates the selected range for conditional format. + Returns the value if present in the condition object. Otherwise returns 0. + Returns true if value present in the condition object otherwise returns false. + + + + Gets the minimum value from the selected range for conditional formats. + + urrent cell. + Indicates the selected range. + Returns the minimum value. + + + + Gets the maximum value from the selected range for conditional formats. + + Current cell. + Indicates the selected range. + Returns the maximum value. + + + + Gets the image of icon from the resources. + + Name of the condiitonal format icon. + + + + + Check and apply conditional formatting if as Color scale. + + Represents current cell. + Represents the Color Scale Set object. + Color scale format range. + Extended format of the cell. + + + + Get the condition value and check the operator of condition. + + Current cell. + Icon Set condition. + Icon set format range. + If true, the operator is greaterThan, else greater than equalto. + + + + Get the conditional value for different format types for conditional formats. + + Indicates the current cell. + Conditional value for conditional format objects. + Indicates the selected range for conditional format. + Returns the value if present in the condition object. Otherwise returns 0. + Returns true if value present in the condition object otherwise returns false. + + + + Applies condition settings to specified Extended format. + + Color to apply. + ExtendedFormat to apply settings to. + The updated extended format. + + + + Blend the colors based on the calculated percentage values + + Percentage increase + Indicates the start color + Indicates the end color + Color + + + + Determine the value of colorRGB in the range + + Indicates the start color + Indicates the end color + Fraction value + Color + + + + Determine the single value of color RGB. + + Start color value of R or G or B + End color value of R or G or B + Fraction value + value of R 0r G or B + + + + Gets the image for Databar + + Represents current cell. + Represents the databar object. + Databar Sets format range. + Extended format of the cell. + + + + Get the condition value and check the operator of condition. + + Current cell. + Icon Set condition. + Icon set format range. + If true, the operator is greaterThan, else greater than equalto. + + + + Get the conditional value for different format types for conditional formats. + + Indicates the current cell. + Conditional value for conditional format objects (IconSets). + Indicates the selected range for conditional format. + Returns the value if present in the condition object. Otherwise returns 0. + Returns true if value present in the condition object otherwise returns false. + + + + Get or Set the indicates whether the color scale conditional format color has applied or not. + + + + + Get or Set the indicate whether the conditional format applied range have negative value or not. + + + + + Get or Set the minimum value for conditional format applied range. + + + + + Get or Set the maximum value for conditional format applied range. + + + + + Contains calculated values for the conditional format formulas. + + + + + Indicates whether the worksheet calculation is enabled or not. + + + + + Gets and sets the difference between first range row and least row for conditional format using multi range. + + + + + Gets and sets the conditional format using multirange. + + + + + Gets and sets the difference between current cell column and first range column value. + + + + + Gets and sets the difference between current cell row and first range row value. + + + + + Contains cell index for top10 conditional format. + + + + + Contains cell index for top10 conditional format. + + + + + Contains average and standard deviation of AboveAverage conditional formatting range. + + + + + Represents worksheet's OptionButton collection. + + + + + This interface represents OptionButton collection inside single worksheet. + + + + + Adds new to the collection. + + One-based row index of the top-left corner of the new item. + One-based column index of the top-left corner of the new item. + Height in pixels of the new item. + Width in pixels of the new item. + Newly added item. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add option button + IOptionButtonShape optionButton = worksheet.OptionButtons.AddOptionButton(1, 1, 20, 100); + + //Set text + optionButton.Text = "Option"; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds a width default dimension + + OptionButton Shape + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add option button + IOptionButtonShape optionButton = worksheet.OptionButtons.AddOptionButton(); + + //Set dimensions + optionButton.Top = 1; + optionButton.Left = 1; + optionButton.Width = 100; + optionButton.Height = 20; + + //Set text + optionButton.Text = "Option"; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds a with default size. + + One-based row index of the top-left corner of the new item. + One-based column index of the top-left corner of the new item. + Returns options button. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add option button + IOptionButtonShape optionButton = worksheet.OptionButtons.AddOptionButton(1, 1); + + //Set dimensions + optionButton.Width = 100; + optionButton.Height = 20; + + //Set text + optionButton.Text = "Option"; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Returns number of in the collection. + + + The following code illustrates how to access the Count property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add option button + worksheet.OptionButtons.AddOptionButton(1, 1, 20, 100); + worksheet.OptionButtons.AddOptionButton(5, 5, 20, 100); + + //Get count + Console.Write(worksheet.OptionButtons.Count); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //2 + + + + + + Returns single from the collection. + + Item's index to get. + Single item from the collection. + + The following code illustrates how to access a from the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add option button + worksheet.OptionButtons.AddOptionButton(1, 1, 20, 100); + + //Set text + worksheet.OptionButtons[0].Text = "Option"; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets single from the collection. + + Name of the item to get. + Single item from the collection. + + The following code illustrates how to access a from the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add option button + worksheet.OptionButtons.AddOptionButton(1, 1, 20, 100); + + //Set text + worksheet.OptionButtons[0].Name = "OptionButton1"; + + //Get width + Console.Write(worksheet.OptionButtons["OptionButton1"].Width); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //100 + + + + + + Average width + + + + + Average height + + + + + Parent worksheet. + + + + + Initializes new instance of the collection. + + Application object for the new instance. + Parent object for the new instance. + + + + Adds new item to the collection. + + OptionButton to add. + + + + Adds default event. + + OptionButton to add event. + + + + Raise when the check state changed + + OptionButton + event object + + + + Raise when the Linkeed cell changed + + OptionButton + event object + + + + Prepares option button for serialization. We should change the option button + checked status based on the group. + + + + + Get the Option Button collection based on the groups. + + Collection of option buttons. + + + + Adds new OptionButton to the collection. + + Top row for the new shape. + Left column for the new shape. + Height in pixels of the new shape. + Width in pixels of the new shape. + Newly created TextBox object. + + + + Adds Option button default Dimension + + returns option button shape + + + + Adds the Shape with default size + + Top row for the new shape. + Left column for the new shape + + + + + Returns single item from the collection. + + Index of the item to get. + Single item from the collection. + + + + Gets single item from the collection. + + Name of the item to get. + Single item from the collection. + + + + Represnts the implementation of custom xml part + + + + + Represent the custom xml part in excel + + + + + Deletes the object. + + A CustomXmlPart cloned object. + + + + Returns the index number of the object within the collection of similar + objects. Read-only Long. + + + + + Returns or sets the name of the object. Read / write String. + + + + + Returns or sets the name of the object, in the language of the user. + Read / write String for Name. + + + + + Parent workbook for this object. + + + + + Parent worksheet for this object. + + + + + Index of the Name object in the Workbook's CustomXml Parts collection. + + + + + Creates new CustomXml object. + + Application object for the new CustomXml object. + Parent object for the new CustomXml object. + Name of the new Customxml object. + Current index. + + + + Creates new CustomXml object. + + Application object for the new CustomXml object. + Parent object for the new CustomXml object. + Name of the new CustomXml object. + Current index. + Indicates whether CustomXml object is local. + + + + Creates a new CustomXml object. + + Application object for the new CustomXml object. + Parent object for the new CustomXml object. + + + + Creates a new CustomXml object. + + Application object for the new CustomXml object. + Parent object for the new CustomXml object. + Name of the new CustomXml object. + Schemas to be added + Range that will be associated with the specified name. + + + + + + Creates a new CustomXml object. + + Application object for the new CustomXml object. + Parent object for the new CustomXml object. + Name of the new CustomXml object. + Xml Data in byte Array + + + + Creates a new CustomXmlPart object. + + Application object for the new CustomXmlPart object. + Parent object for the new CustomXmlPart object. + ID of the new CustomXmlPart object. + schemas of the customxml data + + + + + + Creates a new customxml object. + + Application object for the new customxml object. + Parent object for the new customxml object. + ID of the new customxml object. + Xml Data in byte array + + + + + + Dispose + + + + + create new clone object + + + + + Sets index of the named range and raise event. + + New index. + + + + Sets index of the named range. + + New index. + Indicates whether events should be raised. + + + + Sets parent workbook and worksheet. + + + When parent workbook or worksheet cannot be found. + + + + + XmlData in Byte array + + + + + Unique ID for Xml Data + + + + + Xml Schemas collection for CustomXml data + + + + + Represents the inplementation of custom xml part collection + + + + + Represents custom xml part collection in excel. + + + + + Defines a new name. + + Name for the new Name object. + Returns a Name object. + + + + Defines a new name. + + ID for the new Name object. + Returns a Name object. + + + + + Defines a new name. + + Name object to add. + + + + Removes the element at the specified index of the collection. + + The zero-based index of the element to remove. + + + + Checks whether the Name object is present in the collection or not + + Name object to check whether it is present or not. + A custom xml part collection cloned object. + + + + Checks whether the Name object is present in the collection or not + + Name object to check whether it is present or not. + A custom xml part for the corresponding ID. + + + + Returns the number of objects in the collection. Read-only Long. + + + + + Returns the parent object for the specified object. + + + + + Dictionary with CustomXml data, key - property name/id, value - property value. + + + + + Parent workbook for the collection. + + + + + Parent workbook for the collection. + + + + + Default constructor. + + + + + Creates new instance of clone object + + + + + Returns CustomXmlPart for corresponding id + + + + + Removes specified name from the collection. + + Name of the object to remove. + + + + Clear all items in the collections + + + + + Adds new CustomXmlpart to the collections + + + + + Cretes new CustomXmlParts through specified arugments + + + + + Creates new instance of CusomXmlPart from ID + + + + + Adds into list and hashtable, for local named ranges. + + Name to add. + Indicates is adds in global names hash. + + + + Performs additional processes after inserting a new element into the collection. + + The zero-based index at which to insert value. + The new value of the element at the index. + + + + Sets parent workbook value. + + + When parent workbook cannot be found. + + + + + Removes specified name from the collection. + + Name of the object to remove. + + + + CustomXmlPart Count + + + + + Retruns CustomXmlPart at corresponding index positions + + + + + Represents the collection count + + + + + Represents the custom xml schema collection + + + + + A collection of all the Name objects in the application or + workbook. Each Name object represents a defined name for a + range of cells. + + + + + Defines a new name. + + Name for the new Name object. + Returns a Name object. + + + + Defines a new name. + + Name for the new Name object. + Range that will be associated with the name. + + + + Defines a new name. + + Name object to add. + A custom xml schema collection cloned object. + + + + Defines a new name. + + Name object to add. + Index of the corresponding value in custom xml schema collection. + + + + Removes Name object from the collection. + + Name of the object to remove from the collection. + + + + Removes the element at the specified index of the collection. + + The zero-based index of the element to remove. + + + + Returns the number of objects in the collection. Read-only Long. + + + + + Returns a single Name object from a Names collection. + + + + + Adds the value into collection + + + + + + Clears the items in collection + + + + + Defines a new name. + + + + + + Gets the index of value + + + + + + + Removes the item from collection + + + + + + Removes the item at specified index in the collection + + + + + + Gets the Enumerator + + + + + + Gets the count of xml schema items + + + + + Gets or sets the item in specified index + + + + + + + Represents the meta properties implementation + + + + + Represents meta properties in excel + + + + + Checks whether the Name object is present in the collection or not + + Name object to check whether it is present or not. + Returns corresponding meta property based on internal name + + + + Gets the Metaproperty of the corresponding index from the collection. + + + + + + + Returns number of elements in the collection. Read-only. + + + + + Returns Xml Schema + + + + + Returns Xml Schema + + + + /// + Returns Xml Schema + + + + + Creates new empty collection. + + Application object for the collection. + Parent object for the new collection. + + + + Triggered when new items are added to collection + + + + + Checks whether collection contains named range. + + Name of the named range to search. + True if collection contains such named range; otherwise returns False. + + + + Checks whether collection contains named range. + + Name of the named range to search. + True if collection contains such named range; otherwise returns False. + + + + ItemName + + + + + ItemName + + + + + SchemaXml + + + + + Represents the meta property implementation + + + + + Represents a defined name for a range of cells. Names can be + either built-in names such as Database, Print_Area, and + Auto_Open or custom names. + + + + + Gets or sets value for the meta property. + + + + + Gets the name of the meta property. + + + + + Gets or sets the value of meta property + + + + + Gets or sets the name of meta property + + + + + Represents chart shadow object + + + + + Represents shadow in the chart + + + + + Customs the outer shadow styles. + + Value from . + Transparency of the Shadow accepts the values between(0-100). + Size of the Shadow accepts the values between(0-200). + Blur level of the Shadow accepts the values between(0-100). + Angle or Direction of the Shadow accepts the values between(0-359). + Distance of the Shadow accepts the values between(0-200). + if set to true [custom shadow style]. + + To know more about charts refer this link. + + The following code illustrates how to use the CustomShadowStyles method with . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Customs the outer shadow styles + chart.ChartArea.Shadow.CustomShadowStyles(Excel2007ChartPresetsOuter.OffsetBottom, 70, 90, 71, 50, 60, true); + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Customs the inner shadow styles. + + Value from . + Transparency of the Shadow accepts the values between(0-100). + Blur level of the Shadow accepts the values between(0-100). + Angle or Direction of the Shadow accepts the values between(0-359). + Distance of the Shadow accepts the values between(0-200). + if set to true [custom shadow style]. + + To know more about charts refer this link. + + The following code illustrates how to use the CustomShadowStyles method with . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Customs the inner shadow styles + chart.ChartArea.Shadow.CustomShadowStyles(Excel2007ChartPresetsInner.InsideCenter, 70, 71, 50, 60, true); + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Customs the perspective shadow styles. + + Value from . + Transparency of the Shadow accepts the values between(0-100). + Size of the Shadow accepts the values between(0-200). + Blur level of the Shadow accepts the values between(0-100). + Angle or Direction of the Shadow accepts the values between(0-359). + Distance of the Shadow accepts the values between(0-200). + if set to true [i custom shadow style]. + + To know more about charts refer this link. + + The following code illustrates how to use the CustomShadowStyles method with . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Customs the perspective shadow styles + chart.ChartArea.Shadow.CustomShadowStyles(Excel2007ChartPresetsPrespective.Below, 70, 90, 71, 50, 60, true); + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the shadow outer presets. + + The shadow outer presets. + + To know more about charts refer this link. + + The following code illustrates the use of ShadowOuterPresets property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the shadow outer presets + chart.ChartArea.Shadow.ShadowOuterPresets = Excel2007ChartPresetsOuter.OffsetBottom; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the shadow inner presets. + + The shadow inner presets. + + To know more about charts refer this link. + + The following code illustrates the use of ShadowInnerPresets property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the shadow inner presets + chart.ChartArea.Shadow.ShadowInnerPresets = Excel2007ChartPresetsInner.InsideDiagonalTopLeft; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the shadow prespective presets. + + The shadow prespective presets. + + To know more about charts refer this link. + + The following code illustrates the use of ShadowPrespectivePresets property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the shadow prespective presets + chart.ChartArea.Shadow.ShadowPrespectivePresets = Excel2007ChartPresetsPrespective.Below; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a value indicating whether this instance has custom shadow style. + + + true if this instance has custom shadow style; otherwise, false. + + + To know more about charts refer this link. + + The following code illustrates the use of HasCustomShadowStyle property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //True value indicating whether this instance has custom shadow style. + chart.ChartArea.Shadow.CustomShadowStyles(Excel2007ChartPresetsInner.InsideCenter, 70, 71, 50, 60, true); + bool hasCustomShadow = chart.ChartArea.Shadow.HasCustomShadowStyle; + if(hasCustomShadow) + { + //your code here + } + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the transparency of Shadow. + + The transparency. + + To know more about charts refer this link. + + The following code illustrates the use of Transparency property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the transparency of Shadow + chart.ChartArea.Shadow.Transparency = 50; + chart.ChartArea.Shadow.ShadowPrespectivePresets = Excel2007ChartPresetsPrespective.Below; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the size of Shadow. + + The size. + + To know more about charts refer this link. + + The following code illustrates the use of Size property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the size of Shadow + chart.ChartArea.Shadow.Size = 111; + chart.ChartArea.Shadow.ShadowPrespectivePresets = Excel2007ChartPresetsPrespective.Below; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the blur of Shadow. + + The blur. + + To know more about charts refer this link. + + The following code illustrates the use of Blur property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the blur of Shadow + chart.ChartArea.Shadow.Blur = 42; + chart.ChartArea.Shadow.ShadowPrespectivePresets = Excel2007ChartPresetsPrespective.Below; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the angle of Shadow. + + The angle. + + To know more about charts refer this link. + + The following code illustrates the use of Angle property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the angle of Shadow + chart.ChartArea.Shadow.Angle = 120; + chart.ChartArea.Shadow.ShadowPrespectivePresets = Excel2007ChartPresetsPrespective.Below; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the distance of Shadow. + + The distance. + + To know more about charts refer this link. + + The following code illustrates the use of Distance property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the distance of Shadow. + chart.ChartArea.Shadow.Distance = 86; + chart.ChartArea.Shadow.ShadowPrespectivePresets = Excel2007ChartPresetsPrespective.Below; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the color of the shadow. + + The color of the shadow. + + To know more about charts refer this link. + + The following code illustrates the use of ShadowColor property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the blur of Shadow + chart.ChartArea.Shadow.ShadowColor = System.Drawing.Color.Red; + chart.ChartArea.Shadow.ShadowPrespectivePresets = Excel2007ChartPresetsPrespective.Below; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Class used for Shadowformat Implementation + + + + + Object of WorkbookImpl + + + + + Indicates whether customshadowstyle is set or not + + + + + Represents the Transparency of the Shadow,the values are between(0-100) + + + + + Represents the Size of the Shadow,the values are between(0-200) + + + + + Represents the Blurradius of the Shadow,the values are between(0-100) + + + + + Object of ChartMarkerFormatRecord to get Shadow color + + + + + Represents the Direction of the Shadow,the values are between(0-359) + + + + + Represents the Distance of the Shadow,the values are between(0-200) + + + + + Represents the Shadow Color + + + + + Represents the indicate whether shadow properties has changed or not. + + + + + Creates the shadow and sets its Application and Parent + properties to specified values. + + Application object for the shadow. + Parent object for the shadow. + + + + Initializes the colors. + + + + + Shadows the color changed. + + + + + Searches for all necessary parent objects. + + + + + Represents if chart serie data format is formatted + + + + + Set the group shape property value to all the inner shapes. + + Property value to set. + Property name. + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + + A new object that is a copy of this instance. + + + + + Clone current Record. + + Parent object. + Returns clone of current object. + + + + Customs the outer shadow styles. + + + + + + + + + + + Customs the inner shadow styles. + + + + + + + + + + Customs the perspective shadow styles. + + + + + + + + + + + Represents the stream for preserving the glow information. + + + + + Specifies the radius of blur to apply to the edges of the shape. + + + + + Gets the shadow format. + + The shadow format. + + + + Get or set the indicate whether shadow properties has changed or not. + + + + + Gets or sets the shadow outer presets. + + The shadow outer presets. + + + + Gets or sets the shadow inner presets. + + The shadow inner presets. + + + + Gets or sets a value indicating whether this instance has custom shadow style. + + + true if this instance has custom shadow style; otherwise, false. + + + + + Gets or sets the shadow prespective presets. + + The shadow prespective presets. + + + + Gets or sets the transparency of Shadow. + + The transparency. + + + + Gets or sets the size of Shadow. + + The size. + + + + Gets or sets the blur of Shadow. + + The blur. + + + + Gets or sets the angle of Shadow. + + The angle. + + + + Gets or sets the shadow color + + + + + Gets or sets the distance of Shadow. + + The distance. + + + + Gets / Sets the stream value to the glow member. + + + + + Gets / Sets the Soft Edge Radius member value. + + + + + This class represents option button form control. + + + + + This is base class for text box shapes such as TextBox and Comment. + + + + + Represents default formatting run size. + + + + + Value of text direction property. + + + + + Horizontal alignment of the text. + + + + + Vertical alignment of the text. + + + + + Text rotation. + + + + + Indicates whether comment text is locked. + + + + + Comment text. + + + + + Length of text. + + + + + Length of formatting runs. + + + + + Shape filling color. + + + + + Represents the RTFReader + + + + + Represents worksheet + + + + + Color Object. + + + + + Represents the text contains default horizontal alignment + + + + + Initializes new instance of the class. + + Application object for the new item. + Parent object for the new item. + + + + Extracts comment from MsofbtSpContainer. + + Application object for the current object. + Parent object for the current object. + Container that represents comment. + Parse options. + + + + Creates a clone of the current shape. + + New parent for the shape object. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Indicates whether we should add created + shape into all necessary parent collections. + A copy of the current shape. + + + + Sets text to the specified TextWithFormat value. + + RTF text to set. + + + + Creates ClientTextBox record corresponding to this shape. + + Parent record for ClientTextBox. + Extracted Textbox record. + + + + Creates ClientTextBox record corresponding to this shape. + + Parent record for ClientTextBox. + Extracted Textbox record. + + + + dds continue records that stores text formatting of the comment shape. + + Record to put formatting into. + Record that stores text settings. + + + + Adds continue records that stores text of the comment shape. + + MsofbtClientTextBox record that stores comment settings. + + + + Parses TextObjectRecord. + + Record to parse. + If textObject is NULL. + + + + Parses two continue records. First contains text, second is formatting runs. + + Comment text. + Comment formatting runs. + Parse options. + + When textRecord or formattingRecord is NULL. + + + + + Serializes formatting runs. + + Array that contains formatting runs in binary format. + + + + Converts short form of formatting runs into long form. + + Formatting runs to convert. + Long for of formatting runs. + + + + Initializes variables. + + + + + Parses ClientTextBox record. + + Record to parse. + Parse options. + + + + Copies data from another comment shape. + + Text shape to copy from. + Dictionary with new font indexes. + + + + Creates default shape options. + + Record containing default options. + + + + Serializes text direction. + + MsofbtOPT record to which text ID will be added. + + If options argument is NULL. + + + + + Serializes comment's options. + + Parent record for options. + All options in MsofbtOPT record. + + + + Parses all unknown for ShapeImpl records. + + Record to parse. + Parse options. + + + + Dispose TextBoxShape + + + + + Horizontal alignment of the text. + + + + + Represents the text contains default horizontal alignment + + + + + Vertical alignment of the text. + + + + + Text rotation. + + + + + Indicates whether comment text is locked. + + + + + Comment text. + + + + + Gets or sets text box text. + + + + + Gets inner rich text string object. Read-only. + + + + + Shape filling color. + + + + + Gets or sets the unknown body properties + + + + + Color Object. + + + + + This interface represents TextBox form control shape. + + + + + This interface represents TextBox form control shape. + + + + + This interface represents TextBox form control. + + + + + Horizontal alignment of the text. + + + By default is set to HAlignment. Here for example, we set + to HAlignment property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add textbox + ITextBox textbox = worksheet.TextBoxes.AddTextBox(5, 5, 40, 100); + + //Set text + textbox.Text = "Text"; + + //Set alignment + textbox.HAlignment = ExcelCommentHAlign.Left; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Vertical alignment of the text. + + + By default is set to VAlignment. Here for example, we set + to HAlignment property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add textbox + ITextBox textbox = worksheet.TextBoxes.AddTextBox(5, 5, 200, 100); + + //Set text + textbox.Text = "Text"; + + //Set alignment + textbox.VAlignment = ExcelCommentVAlign.Center; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Text rotation. + + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add textbox + ITextBox textbox = worksheet.TextBoxes.AddTextBox(5, 5, 200, 100); + + //Set text + textbox.Text = "Text"; + + //Set rotation + textbox.TextRotation = ExcelTextRotation.Clockwise; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Indicates whether comment text is locked. + + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add textbox + ITextBox textbox = worksheet.TextBoxes.AddTextBox(5, 5, 40, 100); + + //Set text + textbox.Text = "Text"; + + //Set locked + textbox.IsTextLocked = false; + + //Set sheet protection + worksheet.Protect("", ExcelSheetProtection.All); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Text of the comment. Read-only. + + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add textbox + ITextBox textbox = worksheet.TextBoxes.AddTextBox(5, 5, 20, 100); + + //Set rich text + IRichTextString richText = textbox.RichText; + + //Set font + IFont font = workbook.CreateFont(); + font.Color = ExcelKnownColors.Red; + + //Set text + richText.Text = "Text"; + + //Apply format + richText.SetFont(0, 3, font); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Text of the comment. + + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add textbox + ITextBox textbox = worksheet.TextBoxes.AddTextBox(5, 5, 40, 100); + + //Set text + textbox.Text = "Text"; + + //Set alignment + textbox.HAlignment = ExcelCommentHAlign.Center; + textbox.VAlignment = ExcelCommentVAlign.Center; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Indicates whether option button is checked. + + + By default, is set to CheckState property. Here for example, we add two + and set to CheckState. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add option buttons + IOptionButtonShape optionButton1 = worksheet.OptionButtons.AddOptionButton(); + IOptionButtonShape optionButton2 = worksheet.OptionButtons.AddOptionButton(); + + //Set text + optionButton1.Text = "Option1"; + optionButton2.Text = "Option2"; + + //Set dimensions + optionButton1.Left = 60; + optionButton1.Top = 40; + optionButton1.Width = 100; + optionButton1.Height = 30; + + optionButton2.Left = 160; + optionButton2.Top = 40; + optionButton2.Width = 100; + optionButton2.Height = 30; + + //Set linked cell + optionButton1.LinkedCell = worksheet["$C$7"]; + + //Set state + optionButton1.CheckState = ExcelCheckState.Checked; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Indicates whether option button is first button. Read Only + + + The following code illustrates how to access IsFirstButton property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add option buttons + IOptionButtonShape optionButton1 = worksheet.OptionButtons.AddOptionButton(); + IOptionButtonShape optionButton2 = worksheet.OptionButtons.AddOptionButton(); + + //Set text + optionButton1.Text = "Option1"; + optionButton2.Text = "Option2"; + + //Set dimensions + optionButton1.Left = 60; + optionButton1.Top = 40; + optionButton1.Width = 100; + optionButton1.Height = 30; + + optionButton2.Left = 160; + optionButton2.Top = 40; + optionButton2.Width = 100; + optionButton2.Height = 30; + + //Set linked cell + optionButton1.LinkedCell = worksheet["$C$7"]; + + //Set state + optionButton1.CheckState = ExcelCheckState.Checked; + + //Check IsFirstButton + Console.WriteLine(optionButton1.IsFirstButton); + Console.WriteLine(optionButton2.IsFirstButton); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + //False + + + + + + Gets or sets value indicating whether 3D shadow is present. + + + The following code illustrates how to set Display3DShading property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add option buttons + IOptionButtonShape optionButton1 = worksheet.OptionButtons.AddOptionButton(); + IOptionButtonShape optionButton2 = worksheet.OptionButtons.AddOptionButton(); + + //Set text + optionButton1.Text = "Option1"; + optionButton2.Text = "Option2"; + + //Set dimensions + optionButton1.Left = 60; + optionButton1.Top = 40; + optionButton1.Width = 100; + optionButton1.Height = 30; + + optionButton2.Left = 160; + optionButton2.Top = 40; + optionButton2.Width = 100; + optionButton2.Height = 30; + + //Set linked cell + optionButton1.LinkedCell = worksheet["$C$7"]; + + //Set state + optionButton1.CheckState = ExcelCheckState.Checked; + + //Set 3D Shading + optionButton1.Display3DShading = true; + optionButton2.Display3DShading = true; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Indicates the cell in which the option button points to + + + The following code illustrates how to set LinkedCell for . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add option buttons + IOptionButtonShape optionButton1 = worksheet.OptionButtons.AddOptionButton(); + IOptionButtonShape optionButton2 = worksheet.OptionButtons.AddOptionButton(); + + //Set text + optionButton1.Text = "Option1"; + optionButton2.Text = "Option2"; + + //Set dimensions + optionButton1.Left = 60; + optionButton1.Top = 40; + optionButton1.Width = 100; + optionButton1.Height = 30; + + optionButton2.Left = 160; + optionButton2.Top = 40; + optionButton2.Width = 100; + optionButton2.Height = 30; + + //Set linked cell + optionButton1.LinkedCell = worksheet["$C$7"]; + + //Set state + optionButton1.CheckState = ExcelCheckState.Checked; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Correct shape instance. + + + + + Correct shape version. + + + + + Static variable to represent a linked cell value + + + + + Static variable to represent index of objects + + + + + Indicates whether option button is checked. + + + + + Stores formula link value. + + + + + Indicates whether option button is firstbutton. + + + + + Indicates whether option button is firstbutton. + + + + + Indicates whether option button is firstbutton. + + + + + Indicates whether the event invokes are not + + + + + Represents the Option button index. + + + + + Initialize new instance of the text box shape. + + Application object for the new shape. + Parent object for the new shape. + + + + Initializes new instance of the option button shape. + + Application object for the new shape. + Parent object for the new shape. + Shape's container. + Parsing options. + + + + Initializes new instance of the option button shape. + + Application object for the new shape. + Parent object for the new shape. + Shape's container. + Parsing options. + + + + Initializes shape items. + + + + + This method is called inside of PrepareForSerialization to make shape-dependent preparations. + + + + + Serializes current shape. + + Container that will receive this comment. + + + + Finds the Sub records of option button + + + + + + + + Serializes comment's options. + + Parent record for options. + All options in MsofbtOPT record. + + + + Creates default options. + + MsofbtOPT record + + + + Parses client data record. + + Record to parse. + Parse options. + + + + Creates a clone of the current shape. + + New parent for the shape object. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Indicates whether we should add created + shape into all necessary parent collections. + A copy of the current shape. + + + + Raise when Check state Changed + + + + + Invoke Event + + + + + Represents the Option button index. + + + + + Represents the Next Button in the Group. + + + + + Get object that represents the hyperlink for the shape. + + + + + Horizontal alignment of the text. + + + + + Vertical alignment of the text. + + + + + Text rotation. + + + + + Rich Text + + + + + Indicates whether check box is checked. + + + + + Gets or sets formula link value. + + + + + indicates whether the option button is first button in the group + + + + + Gets or sets value indicating whether 3D shadow is present. + + + + + Raise when Linked Cell Value Changed + + + + + ThreeD format implementation + + + + + Represents the three-dimensional chart format. + + + + + Gets or sets the bevel top. The bevel top property value from . + + The bevel top. + + To know more about charts refer this link. + + The following code illustrates the use of BevelTop property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the bevel top value + chart.ChartArea.ThreeD.BevelTop = Excel2007ChartBevelProperties.Slope; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the bevel bottom. The bevel bottom property value from . + + The bevel bottom. + + To know more about charts refer this link. + + The following code illustrates the use of BevelBottom property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Column_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + chart.IsSeriesInRows = false; + + //sets the bevel bottom value + chart.Series[0].SerieFormat.ThreeD.BevelBottom = Excel2007ChartBevelProperties.Convex; + chart.Series[0].SerieFormat.ThreeD.BevelBottomHeight = 16; + chart.Series[0].SerieFormat.ThreeD.BevelBottomWidth = 7; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the material. The material property value from . + + The material. + + To know more about charts refer this link. + + The following code illustrates the use of Material property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the material value + chart.ChartArea.ThreeD.Material = Excel2007ChartMaterialProperties.TranslucentPowder; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the lighting. The lighting property value from . + + The lighting. + + To know more about charts refer this link. + + The following code illustrates the use of Lighting property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the lighting value + chart.ChartArea.ThreeD.Lighting = Excel2007ChartLightingProperties.Sunrise; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the bevel top height. This property used to adjust the height of property. + + The bevel top height. + + To know more about charts refer this link. + + The following code illustrates the use of BevelTopHeight property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + chart.ChartArea.ThreeD.BevelTop = Excel2007ChartBevelProperties.Slope; + + //sets the bevel top height value + chart.ChartArea.ThreeD.BevelTopHeight = 16; + chart.ChartArea.ThreeD.BevelTopWidth = 7; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the bevel top width. This property used to adjust the width of property. + + The bevel top width. + + To know more about charts refer this link. + + The following code illustrates the use of BevelTopWidth property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + chart.ChartArea.ThreeD.BevelTop = Excel2007ChartBevelProperties.Slope; + + //sets the bevel top width value + chart.ChartArea.ThreeD.BevelTopWidth = 7; + chart.ChartArea.ThreeD.BevelTopHeight = 16; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the bevel bottom height. This property used to adjust the height of property. + + The bevel bottom height. + + To know more about charts refer this link. + + The following code illustrates the use of BevelBottomHeight property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Column_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + chart.IsSeriesInRows = false; + chart.Series[0].SerieFormat.ThreeD.BevelBottom = Excel2007ChartBevelProperties.Convex; + + //sets the bevel bottom height value + chart.Series[0].SerieFormat.ThreeD.BevelBottomHeight = 16; + chart.Series[0].SerieFormat.ThreeD.BevelBottomWidth = 7; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the bevel bottom width. This property used to adjust the width of property. + + The bevel bottom width. + + To know more about charts refer this link. + + The following code illustrates the use of BevelBottomWidth property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Column_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + chart.IsSeriesInRows = false; + chart.Series[0].SerieFormat.ThreeD.BevelBottom = Excel2007ChartBevelProperties.Convex; + + //sets the bevel bottom width value + chart.Series[0].SerieFormat.ThreeD.BevelBottomWidth = 7; + chart.Series[0].SerieFormat.ThreeD.BevelBottomHeight = 16; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Class used for Shadowformat Implementation + + + + + Bevel top height value + + + + + Bevel top width value + + + + + Bevel bottom height value + + + + + Bevel bottom width value + + + + + byte value used as flag and boolean property for the values + + + + + Represents whether shape properties changed or not + + + + + Creates the shadow and sets its Application and Parent + properties to specified values. + Intialize the ShadowData object + + Application object for the shadow. + Parent object for the shadow. + + + + Searches for all necessary parent objects. + + + + + Returns the chart material type. + + + + + + Represents if chart serie data format is formatted + + + + + Set the group shape property value to all the inner shapes. + + Property value to set. + Property name. + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + + A new object that is a copy of this instance. + + + + + Clone current Record. + + Parent object. + Returns clone of current object. + + + + Represents whether shape properties are changed or not + + + + + Gets or sets the bevel top. + + The bevel top. + + + + Gets or sets the bevel bottom. + + The bevel bottom. + + + + Gets or sets the material. + + The material. + + + + Gets or sets the lighting. + + The lighting. + + + + Get or Set BevelT height + + Integer Number + The value ranges from 0 to 1584 + + + + Get or Set BevelB height + + Integer Number + The value ranges from 0 to 1584 + + + + Get or Set BevelT Width + + Integer Number + The value ranges from 0 to 1584 + + + + Get or Set BevelB height + + Integer Number + The value ranges from 0 to 1584 + + + + Indicates whether the 3D setting is default or not. + + returns true if 3D setiing is default otherwise fasle. + + + + Boolean value indicates whether the bevel top width set or not. + + + + + Boolean value indicates whether the bevel top height set or not. + + + + + Boolean value indicates whether the bevel bottom width set or not. + + + + + Boolean value indicates whether the bevel bottom height set or not. + + + + + Boolean value indicates whether the bevel bottom set or not. + + + + + Boolean value indicates whether the bevel top set or not. + + + + s + Boolean value indicates whether the material set or not. + + + + + Represents worksheet's textbox collection. + + + + + This interface represents CheckBoxes collection inside single worksheet. + + + + + Adds new to the collection. + + One-based row index of the top-left corner of the new item. + One-based column index of the top-left corner of the new item. + Height in pixels of the new item. + Width in pixels of the new item. + Newly added item. + + The following code illustrates how to Add a object to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add combobox + ICheckBoxShape checkbox = worksheet.CheckBoxes.AddCheckBox(1, 1, 20, 100); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Returns number of objects in the collection. + + + The following code illustrates how to access Count property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add combobox + worksheet.CheckBoxes.AddCheckBox(1, 1, 20, 100); + worksheet.CheckBoxes.AddCheckBox(5, 5, 20, 100); + + //Check count + Console.Write(worksheet.CheckBoxes.Count); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //2 + + + + + + Returns single from the collection. + + Item's index to get. + Single item from the collection. + + The following code illustrates how to access a from the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add combobox + worksheet.CheckBoxes.AddCheckBox(1, 1, 20, 100); + worksheet.CheckBoxes.AddCheckBox(5, 5, 20, 100); + + //Set name + worksheet.CheckBoxes[0].Name = "CheckBox1"; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets single from the collection. + + Name of the item to get. + Single item from the collection. + + The following code illustrates how to access a from the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add combobox + worksheet.CheckBoxes.AddCheckBox(1, 1, 20, 100); + + //Set name + worksheet.CheckBoxes[0].Name = "CheckBox1"; + + //Get width + Console.Write(worksheet.CheckBoxes["CheckBox1"].Width); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //100 + + + + + + Parent worksheet. + + + + + Initializes new instance of the collection. + + Application object for the new instance. + Parent object for the new instance. + + + + Adds new item to the collection. + + Checkbox to add. + + + + Adds new textbox to the collection. + + Top row for the new shape. + Left column for the new shape. + Height in pixels of the new shape. + Width in pixels of the new shape. + Newly created TextBox object. + + + + Returns single item from the collection. + + Index of the item to get. + Single item from the collection. + + + + Gets single item from the collection. + + Name of the item to get. + Single item from the collection. + + + + This class represents collection of all combo box inside single worksheet. + + + + + This interface represents collection of all combo box inside single worksheet. + + + + + Adds new to the collection. + + One-based row index of the top-left corner of the new item. + One-based column index of the top-left corner of the new item. + Height in pixels of the new item. + Width in pixels of the new item. + Newly added item. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add combobox + IComboBoxShape combobox = worksheet.ComboBoxes.AddComboBox(1, 1, 20, 100); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Returns number of in the collection. + + + The following code illustrates how to access Count property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add combobox + IComboBoxShape combobox1 = worksheet.ComboBoxes.AddComboBox(1, 1, 20, 100); + IComboBoxShape combobox2 = worksheet.ComboBoxes.AddComboBox(5, 5, 20, 100); + + //Get count + Console.Write(worksheet.ComboBoxes.Count); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //2 + + + + + + Returns single from the collection. + + Item's index to get. + Single item from the collection. + + The following code illustrates how to access a from the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add combobox + worksheet.ComboBoxes.AddComboBox(1, 1, 20, 100); + worksheet.ComboBoxes.AddComboBox(5, 5, 20, 100); + + //Set name + worksheet.ComboBoxes[0].Name = "ComboBox1"; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets single item from the collection. + + Name of the item to get. + Single item from the collection. + + The following code illustrates how to access a from the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add combobox + worksheet.ComboBoxes.AddComboBox(1, 1, 20, 100); + + //Set name + worksheet.ComboBoxes[0].Name = "ComboBox1"; + + //Get width + Console.Write(worksheet.ComboBoxes["ComboBox1"].Width); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //100 + + + + + + Parent worksheet. + + + + + Adds new item to the collection. + + One-based row index of the top-left corner of the new item. + One-based column index of the top-left corner of the new item. + Height in pixels of the new item. + Width in pixels of the new item. + Newly added item. + + + + Initializes new instance of the collection. + + Application object for the new collection. + Parent object for the new collection. + + + + Adds new item to the collection. + + Combobox to add. + + + + Gets single item from the collection. + + Name of the item to get. + Single item from the collection. + + + + Contains a condition and the formatting attributes + applied to the cell, if the condition is met. + Used for multiple-cells range. + + + + + Represents data validation for a worksheet range. + + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + IDataValidation validation = sheet.Range["A3"].EntireColumn.DataValidation; + validation.BeginUpdate(); + validation.DataRange = sheet.Range["D1:D56"]; + validation.IsEmptyCellAllowed = true; + validation.IsListInFormula = false; + validation.EndUpdate(); + + + + + + Gets or sets the title of the prompt box. The prompt box title can be edit based on the validation. + + + To know more about PromptBoxTitle property refer this link. + + The following code illustrates the use of PromptBoxTitle property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["C3"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["C1"].Text = "Data Validation List in C3"; + worksheet.Range["C1"].AutofitColumns(); + + // DataValidation in Worksheet Range + IDataValidation dataValidation = worksheet.Range["C3"].DataValidation; + dataValidation.ListOfValues = new string[] { "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" }; + dataValidation.PromptBoxTitle = "Sample"; // Title of PromptBox + dataValidation.PromptBoxText = "Data validation for list"; + dataValidation.ShowPromptBox = true; + dataValidation.PromptBoxHPosition = 25; + dataValidation.PromptBoxVPosition = 30; + dataValidation.IsPromptBoxPositionFixed = true; + dataValidation.IsPromptBoxVisible = true; + dataValidation.IsListInFormula = true; + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the text in the prompt box. The prompt box text can be edit based on the validation. + + + To know more about PromptBoxText property refer this link. + + The following code illustrates the use of PromptBoxText property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["C3"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["C1"].Text = "Data Validation List in C3"; + worksheet.Range["C1"].AutofitColumns(); + + // DataValidation in Worksheet Range + IDataValidation dataValidation = worksheet.Range["C3"].DataValidation; + dataValidation.ListOfValues = new string[] { "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" }; + dataValidation.PromptBoxTitle = "Sample"; + dataValidation.PromptBoxText = "Data validation for list"; // Text of PromptBox + dataValidation.ShowPromptBox = true; + dataValidation.PromptBoxHPosition = 25; + dataValidation.PromptBoxVPosition = 30; + dataValidation.IsPromptBoxPositionFixed = true; + dataValidation.IsPromptBoxVisible = true; + dataValidation.IsListInFormula = true; + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the title of the error dialog. The errorbox title can be edit based on validation or user's needs. + + + To know more about ErrorBoxTitle property refer this link. + + The following code illustrates the use of ErrorBoxTitle property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["A2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["C2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["E2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["A1"].Text = "Text Vaidation"; + worksheet.Range["C1"].Text = "Time Vaidation"; + worksheet.Range["E1"].Text = "Number Vaidation"; + worksheet.Range["A1"].AutofitColumns(); + worksheet.Range["C1"].AutofitColumns(); + worksheet.Range["E1"].AutofitColumns(); + + // Data validation for text length + IDataValidation dataValidation = worksheet.Range["A2"].DataValidation; + dataValidation.AllowType = ExcelDataType.TextLength; + dataValidation.CompareOperator = ExcelDataValidationComparisonOperator.GreaterOrEqual; + dataValidation.FirstFormula = "5"; + dataValidation.ShowErrorBox = true; + dataValidation.ErrorBoxText = "Text length should be greater than or equal to 5"; + dataValidation.ErrorBoxTitle = "ERROR"; //Error box title for text length validation + dataValidation.ErrorStyle = ExcelErrorStyle.Warning; + + // Date Validation for Time + IDataValidation dataValidation2 = worksheet.Range["C2"].DataValidation; + dataValidation2.AllowType = ExcelDataType.Time; + dataValidation2.CompareOperator = ExcelDataValidationComparisonOperator.Between; + dataValidation2.FirstFormula = "10:00"; + dataValidation2.SecondFormula = "12:00"; + dataValidation2.ShowErrorBox = false; + dataValidation2.ErrorBoxText = "Time between 10:00 and 12:00 'o Clock"; + dataValidation2.ErrorBoxTitle = "Alert"; //Error box title for time validation + dataValidation2.ErrorStyle = ExcelErrorStyle.Info; + + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the error message in the error dialog. The user being alerted whenever enters an invalid data. The errorbox text can be edit based on the validation. + + + The data validation error message will be shown whenever the user enters invalid data. To know more about ErrorBoxText property refer this link. + + The following code illustrates the use of ErrorBoxText property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["A2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["C2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["E2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["A1"].Text = "Text Vaidation"; + worksheet.Range["C1"].Text = "Time Vaidation"; + worksheet.Range["E1"].Text = "Number Vaidation"; + worksheet.Range["A1"].AutofitColumns(); + worksheet.Range["C1"].AutofitColumns(); + worksheet.Range["E1"].AutofitColumns(); + + // Data validation for text length + IDataValidation dataValidation = worksheet.Range["A2"].DataValidation; + dataValidation.AllowType = ExcelDataType.TextLength; + dataValidation.CompareOperator = ExcelDataValidationComparisonOperator.GreaterOrEqual; + dataValidation.FirstFormula = "5"; + dataValidation.ShowErrorBox = true; + dataValidation.ErrorBoxText = "Text length should be greater than or equal to 5"; //Error message for text length validation + dataValidation.ErrorBoxTitle = "ERROR"; + dataValidation.ErrorStyle = ExcelErrorStyle.Warning; + + // Date Validation for Time + IDataValidation dataValidation2 = worksheet.Range["C2"].DataValidation; + dataValidation2.AllowType = ExcelDataType.Time; + dataValidation2.CompareOperator = ExcelDataValidationComparisonOperator.Between; + dataValidation2.FirstFormula = "10:00"; + dataValidation2.SecondFormula = "12:00"; + dataValidation2.ShowErrorBox = false; + dataValidation2.ErrorBoxText = "Time between 10:00 and 12:00 'o Clock"; //Error message for time validation + dataValidation2.ErrorBoxTitle = "ERROR"; + dataValidation2.ErrorStyle = ExcelErrorStyle.Info; + + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the value or expression associated with the data validation. Firstformula must important to validate data in CompareOperator property. + + + This can be a constant value, a string value, a cell reference, or a formula. To know more about FirstFormula property refer this link. + + The following code illustrates the use of FirstFormula property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["A2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["C2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["E2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["A1"].Text = "Text Vaidation"; + worksheet.Range["C1"].Text = "Time Vaidation"; + worksheet.Range["E1"].Text = "Number Vaidation"; + worksheet.Range["A1"].AutofitColumns(); + worksheet.Range["C1"].AutofitColumns(); + worksheet.Range["E1"].AutofitColumns(); + + // Data validation for text length + IDataValidation dataValidation = worksheet.Range["A2"].DataValidation; + dataValidation.AllowType = ExcelDataType.TextLength; + dataValidation.CompareOperator = ExcelDataValidationComparisonOperator.GreaterOrEqual; + dataValidation.FirstFormula = "5"; //DataValidation Value for First Formula + + // Date Validation for Time + IDataValidation dataValidation2 = worksheet.Range["C2"].DataValidation; + dataValidation2.AllowType = ExcelDataType.Time; + dataValidation2.CompareOperator = ExcelDataValidationComparisonOperator.Between; + dataValidation2.FirstFormula = "10:00"; //DataValidation Value for First Formula + dataValidation2.SecondFormula = "12:00"; + + //Data validation for number + IDataValidation dataValidation3 = worksheet.Range["E2"].DataValidation; + dataValidation3.AllowType = ExcelDataType.Integer; + dataValidation3.CompareOperator = ExcelDataValidationComparisonOperator.NotBetween; + dataValidation3.FirstFormula = "0"; //DataValidation Value for First Formula + dataValidation3.SecondFormula = "10"; + + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the first formula's DateTime value. FirstDateTime must important to validate data in CompareOperator property. + + + Value of the property must be a DateTime. To know more about FirstDateTime property refer this link. + + The following code illustrates the use of FirstDateTime property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["E1"].Text = "Enter the Date in E3"; + worksheet.Range["E1"].AutofitColumns(); + worksheet.Range["E3"].CellStyle.Color = System.Drawing.Color.LightGray; + + // DataValidation in Worksheet Range + IDataValidation dateValidation = worksheet.Range["E3"].DataValidation; + dateValidation.AllowType = ExcelDataType.Date; + dateValidation.CompareOperator = ExcelDataValidationComparisonOperator.Between; + dateValidation.FirstDateTime = new DateTime(2003, 5, 10); // FirstDateTime Formula sample value. + dateValidation.SecondDateTime = new DateTime(2004, 5, 10); + dateValidation.ShowErrorBox = true; + dateValidation.ErrorBoxText = "Enter Value between 10/5/2003 to 10/5/2004"; + dateValidation.ErrorBoxTitle = "ERROR"; + dateValidation.PromptBoxText = "Data validation for date"; + dateValidation.ShowPromptBox = true; + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the value or expression associated with the second part of the data validation. Second formula used only when CompareOperator have a value "Between"/"NotBetween"; + + + This can be a constant value, a string value, a cell reference, or a formula. The value must be greater than or equal to the value. To know more about SecondFormula property refer this link. + + The following code illustrates the use of SecondFormula property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["C2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["E2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["C1"].Text = "Time Vaidation"; + worksheet.Range["E1"].Text = "Number Vaidation"; + worksheet.Range["C1"].AutofitColumns(); + worksheet.Range["E1"].AutofitColumns(); + + // Date Validation for Time + IDataValidation dataValidation2 = worksheet.Range["C2"].DataValidation; + dataValidation2.AllowType = ExcelDataType.Time; + dataValidation2.CompareOperator = ExcelDataValidationComparisonOperator.Between; + dataValidation2.FirstFormula = "10:00"; + dataValidation2.SecondFormula = "12:00"; //DataValidation Value for Second Formula + + //Data validation for number + IDataValidation dataValidation3 = worksheet.Range["E2"].DataValidation; + dataValidation3.AllowType = ExcelDataType.Integer; + dataValidation3.CompareOperator = ExcelDataValidationComparisonOperator.NotBetween; + dataValidation3.FirstFormula = "0"; + dataValidation3.SecondFormula = "10"; //DataValidation Value for Second Formula + + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets second formula's DateTime value. SecondDateTime must important to validate data in CompareOperator property. + + + Value of the property must be a DateTime. To know more about SecondDateTime property refer this link. + + The following code illustrates the use of SecondDateTime property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["E1"].Text = "Enter the Date in E3"; + worksheet.Range["E1"].AutofitColumns(); + worksheet.Range["E3"].CellStyle.Color = System.Drawing.Color.LightGray; + + // DataValidation in Worksheet Range + IDataValidation dateValidation = worksheet.Range["E3"].DataValidation; + dateValidation.AllowType = ExcelDataType.Date; + dateValidation.CompareOperator = ExcelDataValidationComparisonOperator.Between; + dateValidation.FirstDateTime = new DateTime(2003, 5, 10); + dateValidation.SecondDateTime = new DateTime(2004, 5, 10); // SecondDateTime Formula sample value. + dateValidation.ShowErrorBox = true; + dateValidation.ErrorBoxText = "Enter Value between 10/5/2003 to 10/5/2004"; + dateValidation.ErrorBoxTitle = "ERROR"; + dateValidation.PromptBoxText = "Data validation for date"; + dateValidation.ShowPromptBox = true; + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the data type validation for a range. AllowType is allows the data with restricted Datatypes or Rules using enumeration. + + + Specifies the type of validation test to be performed in conjunction with values. To know more about AllowType property refer this link. + + The following code illustrates the use of AllowType property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["A2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["C2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["E2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["A1"].Text = "Text Vaidation"; + worksheet.Range["C1"].Text = "Time Vaidation"; + worksheet.Range["E1"].Text = "Number Vaidation"; + worksheet.Range["A1"].AutofitColumns(); + worksheet.Range["C1"].AutofitColumns(); + worksheet.Range["E1"].AutofitColumns(); + + // Data validation for text length + IDataValidation dataValidation = worksheet.Range["A2"].DataValidation; + dataValidation.AllowType = ExcelDataType.TextLength; // Allows the data with restricted Datatypes/Rules + dataValidation.CompareOperator = ExcelDataValidationComparisonOperator.GreaterOrEqual; + dataValidation.FirstFormula = "5"; + + // Date Validation for Time + IDataValidation dataValidation2 = worksheet.Range["C2"].DataValidation; + dataValidation2.AllowType = ExcelDataType.Time; // Allows the data with restricted Datatypes/Rules + dataValidation2.CompareOperator = ExcelDataValidationComparisonOperator.Between; + dataValidation2.FirstFormula = "10:00"; + dataValidation2.SecondFormula = "12:00"; + + //Data validation for number + IDataValidation dataValidation3 = worksheet.Range["E2"].DataValidation; + dataValidation3.AllowType = ExcelDataType.Integer; // Allows the data with restricted Datatypes/Rules + dataValidation3.CompareOperator = ExcelDataValidationComparisonOperator.NotBetween; + dataValidation3.FirstFormula = "0"; + dataValidation3.SecondFormula = "10"; + + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the comparison operation to perform. CompareOperator for Data Validation works with enumeration and two formula values. + + + Comparison operator between Two formula values. To know more about CompareOperator property refer this link. + + The following code illustrates the use of CompareOperator property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["A2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["C2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["E2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["A1"].Text = "Text Vaidation"; + worksheet.Range["C1"].Text = "Time Vaidation"; + worksheet.Range["E1"].Text = "Number Vaidation"; + worksheet.Range["A1"].AutofitColumns(); + worksheet.Range["C1"].AutofitColumns(); + worksheet.Range["E1"].AutofitColumns(); + + // Data validation for text length + IDataValidation dataValidation = worksheet.Range["A2"].DataValidation; + dataValidation.AllowType = ExcelDataType.TextLength; + dataValidation.CompareOperator = ExcelDataValidationComparisonOperator.GreaterOrEqual; //Comparison operation for Data Validation + dataValidation.FirstFormula = "5"; + + // Date Validation for Time + IDataValidation dataValidation2 = worksheet.Range["C2"].DataValidation; + dataValidation2.AllowType = ExcelDataType.Time; + dataValidation2.CompareOperator = ExcelDataValidationComparisonOperator.Between; //Comparison operation for Data Validation + dataValidation2.FirstFormula = "10:00"; + dataValidation2.SecondFormula = "12:00"; + + //Data validation for number + IDataValidation dataValidation3 = worksheet.Range["E2"].DataValidation; + dataValidation3.AllowType = ExcelDataType.Integer; + dataValidation3.CompareOperator = ExcelDataValidationComparisonOperator.NotBetween; //Comparison operation for Data Validation + dataValidation3.FirstFormula = "0"; + dataValidation3.SecondFormula = "10"; + + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + True if formula contains list of values. otherwise False. + + + Default value for IsListInFormula is false. Mostly the IsListInFormula property used for internal purpose. To know more about IsListInFormula property refer this link. + + The following code illustrates the use of IsListInFormula property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["C3"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["C1"].Text = "Data Validation List in C3"; + worksheet.Range["C1"].AutofitColumns(); + + // DataValidation in Worksheet Range + IDataValidation dataValidation = worksheet.Range["C3"].DataValidation; + dataValidation.ListOfValues = new string[] { "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" }; + + //True if dataValiadation's ListOfValues property has a value + if(dataValidation.IsListInFormula) + { + //Your code here + } + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + True if empty values are permitted by the range data validation. otherwise False. + + + To know more about IsEmptyCellAllowed property refer this link. + + The following code illustrates the use of IsEmptyCellAllowed property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["A2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["A1"].Text = "Select the Day in A2"; + worksheet.Range["A1"].AutofitColumns(); + worksheet.Range["D1"].Text = "Days in a Week"; + worksheet.Range["D2"].Text = "Monday"; + worksheet.Range["D3"].Text = "Tuesday"; + worksheet.Range["D4"].Text = "Wednesday"; + worksheet.Range["D5"].Text = "Thursday"; + worksheet.Range["D6"].Text = "Friday"; + worksheet.Range["D7"].Text = "Saturday"; + worksheet.Range["D8"].Text = "Sunday"; + worksheet.Range["D1"].AutofitColumns(); + + // DataValidation in Worksheet Range + IDataValidation validation = worksheet.Range["A2"].DataValidation; + validation.DataRange = worksheet.Range["D2:D8"]; + validation.IsEmptyCellAllowed = true; // Set true to allow Empty cells. + validation.IsSuppressDropDownArrow = false; + + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + True if the drop down arrow is invisible. otherwise False. + + + To know more about IsSuppressDropDownArrow property refer this link. + + The following code illustrates the use of IsSuppressDropDownArrow property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["A2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["A1"].Text = "Select the Day in A2"; + worksheet.Range["A1"].AutofitColumns(); + worksheet.Range["D1"].Text = "Days in a Week"; + worksheet.Range["D2"].Text = "Monday"; + worksheet.Range["D3"].Text = "Tuesday"; + worksheet.Range["D4"].Text = "Wednesday"; + worksheet.Range["D5"].Text = "Thursday"; + worksheet.Range["D6"].Text = "Friday"; + worksheet.Range["D7"].Text = "Saturday"; + worksheet.Range["D8"].Text = "Sunday"; + worksheet.Range["D1"].AutofitColumns(); + + // DataValidation in Worksheet Range + IDataValidation validation = worksheet.Range["A2"].DataValidation; + validation.DataRange = worksheet.Range["D2:D8"]; + validation.IsEmptyCellAllowed = true; + validation.IsSuppressDropDownArrow = false; //True if the drop down arrow is invisible. + + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + True if prompt box is shown. otherwise False. Default value is True. + + + PromptBox shows whenever you click the Datavalidation cell. To know more about ShowPromptBox property refer this link. + + The following code illustrates the use of ShowPromptBox property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["C3"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["C1"].Text = "Data Validation List in C3"; + worksheet.Range["C1"].AutofitColumns(); + + // DataValidation in Worksheet Range + IDataValidation dataValidation = worksheet.Range["C3"].DataValidation; + dataValidation.ListOfValues = new string[] { "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" }; + dataValidation.PromptBoxTitle = "Sample"; + dataValidation.PromptBoxText = "Data validation for list"; + dataValidation.ShowPromptBox = true; //True if prompt box is shown + dataValidation.PromptBoxHPosition = 25; + dataValidation.PromptBoxVPosition = 30; + dataValidation.IsPromptBoxPositionFixed = true; + dataValidation.IsPromptBoxVisible = true; + dataValidation.IsListInFormula = true; + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + True if error dialog is shown. otherwise False. Default value is True. + + + The data validation error message will be shown whenever the user enters invalid data. To know more about ShowErrorBox property refer this link. + + The following code illustrates the use of ShowErrorBox property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["A2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["C2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["E2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["A1"].Text = "Text Vaidation"; + worksheet.Range["C1"].Text = "Time Vaidation"; + worksheet.Range["E1"].Text = "Number Vaidation"; + worksheet.Range["A1"].AutofitColumns(); + worksheet.Range["C1"].AutofitColumns(); + worksheet.Range["E1"].AutofitColumns(); + + // Data validation for text length + IDataValidation dataValidation = worksheet.Range["A2"].DataValidation; + dataValidation.AllowType = ExcelDataType.TextLength; + dataValidation.CompareOperator = ExcelDataValidationComparisonOperator.GreaterOrEqual; + dataValidation.FirstFormula = "5"; + dataValidation.ShowErrorBox = true; //Value set as true. + dataValidation.ErrorBoxText = "Text length should be greater than or equal to 5"; + dataValidation.ErrorBoxTitle = "ERROR"; + dataValidation.ErrorStyle = ExcelErrorStyle.Warning; + + // Date Validation for Time + IDataValidation dataValidation2 = worksheet.Range["C2"].DataValidation; + dataValidation2.AllowType = ExcelDataType.Time; + dataValidation2.CompareOperator = ExcelDataValidationComparisonOperator.Between; + dataValidation2.FirstFormula = "10:00"; + dataValidation2.SecondFormula = "12:00"; + dataValidation2.ShowErrorBox = false; //Value set as false. + dataValidation2.ErrorBoxText = "Time between 10:00 and 12:00 'o Clock"; + dataValidation2.ErrorBoxTitle = "ERROR"; + dataValidation2.ErrorStyle = ExcelErrorStyle.Info; + + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets Horizontal position of the prompt box. + + + Default value for PromptBoxHPosition is 0. Mostly the PromptBoxHPosition property used for internal purpose. To know more about PromptBoxHPosition property refer this link. + + The following code illustrates the use of PromptBoxHPosition property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["C3"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["C1"].Text = "Data Validation List in C3"; + worksheet.Range["C1"].AutofitColumns(); + + // DataValidation in Worksheet Range + IDataValidation dataValidation = worksheet.Range["C3"].DataValidation; + dataValidation.ListOfValues = new string[] { "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" }; + dataValidation.PromptBoxTitle = "Sample"; + dataValidation.PromptBoxText = "Data validation for list"; + dataValidation.ShowPromptBox = true; + dataValidation.PromptBoxHPosition = 25; // Set the promptBox horizontal position. + dataValidation.PromptBoxVPosition = 30; + dataValidation.IsPromptBoxPositionFixed = true; + dataValidation.IsPromptBoxVisible = true; + dataValidation.IsListInFormula = true; + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets Vertical position of the prompt box. + + + Default value for PromptBoxVPosition is 0. Mostly the PromptBoxVPosition property used for internal purpose. To know more about PromptBoxVPosition property refer this link. + + The following code illustrates the use of PromptBoxVPosition property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["C3"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["C1"].Text = "Data Validation List in C3"; + worksheet.Range["C1"].AutofitColumns(); + + // DataValidation in Worksheet Range + IDataValidation dataValidation = worksheet.Range["C3"].DataValidation; + dataValidation.ListOfValues = new string[] { "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" }; + dataValidation.PromptBoxTitle = "Sample"; + dataValidation.PromptBoxText = "Data validation for list"; + dataValidation.ShowPromptBox = true; + dataValidation.PromptBoxHPosition = 25; + dataValidation.PromptBoxVPosition = 30; // Set the promptBox vertical position. + dataValidation.IsPromptBoxPositionFixed = true; + dataValidation.IsPromptBoxVisible = true; + dataValidation.IsListInFormula = true; + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + True if prompt box is visible. otherwise False. + + + Default value for IsPromptBoxVisible is false. Mostly the IsPromptBoxVisible property used for internal purpose. To know more about IsPromptBoxVisible property refer this link. + + The following code illustrates the use of IsPromptBoxVisible property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["C3"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["C1"].Text = "Data Validation List in C3"; + worksheet.Range["C1"].AutofitColumns(); + + // DataValidation in Worksheet Range + IDataValidation dataValidation = worksheet.Range["C3"].DataValidation; + dataValidation.ListOfValues = new string[] { "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" }; + dataValidation.PromptBoxTitle = "Sample"; + dataValidation.PromptBoxText = "Data validation for list"; + dataValidation.ShowPromptBox = true; + dataValidation.PromptBoxHPosition = 25; + dataValidation.PromptBoxVPosition = 30; + dataValidation.IsPromptBoxPositionFixed = true; + dataValidation.IsPromptBoxVisible = true; //True if prompt box is visible + dataValidation.IsListInFormula = true; + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + True if prompt box position is fixed. otherwise False. + + + Default value for IsPromptBoxPositionFixed is false. Mostly the IsPromptBoxPositionFixed property used for internal purpose. To know more about IsPromptBoxPositionFixed property refer this link. + + The following code illustrates the use of IsPromptBoxPositionFixed property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["C3"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["C1"].Text = "Data Validation List in C3"; + worksheet.Range["C1"].AutofitColumns(); + + // DataValidation in Worksheet Range + IDataValidation dataValidation = worksheet.Range["C3"].DataValidation; + dataValidation.ListOfValues = new string[] { "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" }; + dataValidation.PromptBoxTitle = "Sample"; + dataValidation.PromptBoxText = "Data validation for list"; + dataValidation.ShowPromptBox = true; + dataValidation.PromptBoxHPosition = 25; + dataValidation.PromptBoxVPosition = 30; + dataValidation.IsPromptBoxPositionFixed = true; //True if prompt box position is fixed + dataValidation.IsPromptBoxVisible = true; + dataValidation.IsListInFormula = true; + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the type of error. Using enumeration we can change the Style/Type of an ErrorBox in ErrorStyle property. + + + To know more about ErrorStyle property refer this link. + + The following code illustrates the use of ErrorStyle property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["A2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["C2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["E2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["A1"].Text = "Text Vaidation"; + worksheet.Range["C1"].Text = "Time Vaidation"; + worksheet.Range["E1"].Text = "Number Vaidation"; + worksheet.Range["A1"].AutofitColumns(); + worksheet.Range["C1"].AutofitColumns(); + worksheet.Range["E1"].AutofitColumns(); + + // Data validation for text length + IDataValidation dataValidation = worksheet.Range["A2"].DataValidation; + dataValidation.AllowType = ExcelDataType.TextLength; + dataValidation.CompareOperator = ExcelDataValidationComparisonOperator.GreaterOrEqual; + dataValidation.FirstFormula = "5"; + dataValidation.ShowErrorBox = true; + dataValidation.ErrorBoxText = "Text length should be greater than or equal to 5"; + dataValidation.ErrorBoxTitle = "ERROR"; + dataValidation.ErrorStyle = ExcelErrorStyle.Warning; //Warning Type error box + + // Date Validation for Time + IDataValidation dataValidation2 = worksheet.Range["C2"].DataValidation; + dataValidation2.AllowType = ExcelDataType.Time; + dataValidation2.CompareOperator = ExcelDataValidationComparisonOperator.Between; + dataValidation2.FirstFormula = "10:00"; + dataValidation2.SecondFormula = "12:00"; + dataValidation2.ShowErrorBox = false; + dataValidation2.ErrorBoxText = "Time between 10:00 and 12:00 'o Clock"; + dataValidation2.ErrorBoxTitle = "Alert"; + dataValidation2.ErrorStyle = ExcelErrorStyle.Info; //Information Type error box + + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets Array of possible values. The values of ListOfValues property must be in string format. + + + This property should be used when the values in the Data Validation list are entered manually. To know more about ListOfValues property refer this link. + + The following code illustrates the use of ListOfValues property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["C3"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["C1"].Text = "Data Validation List in C3"; + worksheet.Range["C1"].AutofitColumns(); + + // DataValidation in Worksheet Range + IDataValidation dataValidation = worksheet.Range["C3"].DataValidation; + // Sample list of values in string format + dataValidation.ListOfValues = new string[] { "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday" }; + dataValidation.PromptBoxTitle = "Sample"; + dataValidation.PromptBoxText = "Data validation for list"; + dataValidation.ShowPromptBox = true; + dataValidation.PromptBoxHPosition = 25; + dataValidation.PromptBoxVPosition = 30; + dataValidation.IsPromptBoxPositionFixed = true; + dataValidation.IsPromptBoxVisible = true; + dataValidation.IsListInFormula = true; + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the Range of possible values. The list of DataRange cell values are set as dropdown list of DataValidation Range. + + + In Output of an excel the list of DataRange cell values are in dropdown list of DataValidation Range. To know more about DataRange property refer this link. + + The following code illustrates the use of DataRange property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["A2"].CellStyle.Color = System.Drawing.Color.LightGray; + worksheet.Range["A1"].Text = "Select the Day in A2"; + worksheet.Range["A1"].AutofitColumns(); + worksheet.Range["D1"].Text = "Days in a Week"; + worksheet.Range["D2"].Text = "Monday"; + worksheet.Range["D3"].Text = "Tuesday"; + worksheet.Range["D4"].Text = "Wednesday"; + worksheet.Range["D5"].Text = "Thursday"; + worksheet.Range["D6"].Text = "Friday"; + worksheet.Range["D7"].Text = "Saturday"; + worksheet.Range["D8"].Text = "Sunday"; + worksheet.Range["D1"].AutofitColumns(); + + // DataValidation in Worksheet Range + IDataValidation validation = worksheet.Range["A2"].DataValidation; + validation.DataRange = worksheet.Range["D2:D8"]; //DataRange for Data Validation + validation.IsEmptyCellAllowed = true; + validation.IsSuppressDropDownArrow = false; + + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Holds first formula tokens. + + + + + Holds second formula tokens. + + + + + Parent range + + + + + List with cached data validation. + + + + + Initializes a new instance of class with specified parent range. + + Parent object for the format. + + + + Copies data validation settings from the first cell to the rest of the range. + + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Iterates through all cells. + + Method to call for each cell. + + + + Iterates through all data validations using cells. + + Method to call for each data validation. + Value to pass to the data validation method. + + + + Iterates through all cached data validation objects. + + Method to call for each data validation. + Value to pass to the data validation method. + + + + Sets PromptBoxTitle in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets PromptBoxText in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets ErrorBoxTitle in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets ErrorBoxText in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets FirstFormula in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets FirstDateTime in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets SecondFormula in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets SecondDateTime in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets AllowType in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets CompareOperator in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets IsListInFormula in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets IsEmptyCellAllowed in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets IsSuppressDropDownArrow in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets ShowPromptBox in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets ShowErrorBox in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets PromptBoxHPosition in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets PromptBoxVPosition in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets IsPromptBoxVisible in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets IsPromptBoxPositionFixed in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets ErrorStyle in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets ListOfValues in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets DataRange in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets FirstFormulaTokens in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Sets SecondFormulaTokens in the specified data validation. + + Data validation to set value for. + Value to set. + + + + Gets or sets the title of the prompt box. + + + + + Gets or sets the text in the prompt box. + + + + + Gets or sets the title of the error dialog. + + + + + Gets or sets the error message in the error dialog . + + + + + Gets or sets the value or expression associated with the data validation. + + + + + Gets or sets the first formula's DateTime value. + + + + + Gets or sets the value or expression associated with the second part of the data validation. + + + + + Gets or sets second formula's DateTime value. + + + + + Gets or sets the data type validation for a range. + + + + + Gets or sets the comparison operation to perform. + + + + + True if formula contains list of values. otherwise False. + + + + + True if empty values are permitted by the range data validation. otherwise False. + + + + + True if the drop down arrow is invisible. otherwise False. + + + + + True if prompt box is shown. otherwise False. Default value is True. + + + + + True if error dialog is shown. otherwise False. Default value is True. + + + + + Gets or sets Horizontal position of the prompt box. + + + + + Gets or sets Vertical position of the prompt box. + + + + + True if prompt box is visible. otherwise False. + + + + + True if prompt box position is fixed. otherwise False. + + + + + Gets or sets the type of error. + + + + + Gets or sets Array of possible values. + + + This property should be used when the values in the Data Validation list are entered manually. + + + + + Gets or sets the Range of possible values. + + + + + Application object for this object. + + + + + Parent object for this object. + + + + + + + + + + + + + + + Delegate specified method that receives cell's coordinates to process. + + One-based row index. + One-based column index. + + + + Method to process single data validation. + + Data validation object to process. + Additional value. + + + + Wrapper over class. + + + + + + + + + + Parent range. + + + + + Old DataValidationImpl. Should be not null between OnBeforeWrapperChange + and OnAfterWrapperChange. + + + + + Number variable + + + + + Initializes a new instance of the class. + + + + + This should be called before several updates to the object will take place. + + + Invoking this method improves the performance for large block of Data Validation. + + + + + This method should be called after several updates to the object took place. + + + Invoking this method improves the performance for large block of Data Validation. + + + + + + + + + + + + + + + + + + + + Gets or sets the title of the prompt box. + + + + + Gets or sets the text in the prompt box. + + + + + Gets or sets the title of the error dialog. + + + + + Gets or sets the error message in the error dialog . + + + + + Gets or sets the value or expression associated with the data validation. + + + + + Gets or sets the first formula's DateTime value. + + + + + Gets or sets the value or expression associated with the second part of the data validation. + + + + + Gets or sets second formula's DateTime value. + + + + + Gets or sets the data type validation for a range. + + + + + Gets or sets the comparison operation to perform. + + + + + True if formula contains list of values. otherwise False. + + + + + True if empty values are permitted by the range data validation. otherwise False. + + + + + True if the drop down arrow is invisible. otherwise False. + + + + + True if prompt box is shown. otherwise False. Default value is True. + + + + + True if error dialog is shown. otherwise False. Default value is True. + + + + + Gets or sets Horizontal position of the prompt box. + + + + + Gets or sets Vertical position of the prompt box. + + + + + True if prompt box is visible. otherwise False. + + + + + True if prompt box position is fixed. otherwise False. + + + + + Gets or sets the type of error. + + + + + Gets or sets Array of possible values. + + + This property should be used when the values in the Data Validation list are entered manually. + + + + + Gets or sets the Range of possible values. + + + + + Holds first formula tokens. + + + + + Holds second formula tokens. + + + + + Application object for this object. + + + + + Parent object for this object. + + + + + Helper class to perform excel to html conversion. + + + Excel To Html Conversion is not supported in WinRT, Windows Phone, Universal, Portable and Silverlight platforms. + + + + + Represents the object of Excel sheet conditional formatting . + + + + + Represents that the last cell of the row is not empty. + + + + + Represents internal CF list + + + + + Represents TableStyleRenderer class + + + + + Represents table border color list + + + + + Represents table font color list + + + + + Initializes a new instance of the class. + + + + + Converts the specified stream. + + The stream. + The book. + The output directory path. + The saveoption. + + + + Converts to the specified stream. + + The stream. + The book. + The saveoption. + + + + Converts the specified stream. + + The stream. + The sheet. + The output directory path. + The saveoption. + + + + Builds the main page. + + The book. + The directory. + The saveoption. + + + + Builds the scripts. + + The book. + + + + Builds the tab page. + + The book. + + + + Builds the tab page. + + The book. + The output directory path. + + + + Builds the styles. + + The sheet. + + + + Builds the common styles. + + XML Writer. + + + + Gets the common styles. + + XML Writer. + + + + Builds the styles. + + The book. + The save option. + The m_writer. + + + + Writes the document start. + + + + + Writes the document end. + + + + + Gets the styles. + + The sheet. + The save option. + + + + + Gets the script. + + The book. + + + + + Gets the script. + + The book. + + + + + Gets the styles. + + The sheet. + The save option. + + + + + Gets the style. + + Extended format. + Cell. + Has ConditionalFormats. + + + + + Modified the font family, If present some of font family + + Font family + + + + + Normalizes the color. + + The color. + + + + + Gets the border styles. + + The result. + The key no position. + + + + + Gets the border style from index. + + Cell borders. + Cell border index. + + + + + Gets the width of the border. + + The border. + + + + + Gets the dash style. + + The border. + + + + + Builds the borders. + + The result. + + + + + Gets the image styles. + + The sheet. + The builder. + + + + Gets the shape style. + + The shape. + Class id. + + + + Gets the column width for an excel worksheet + + The sheet. + Column index. + + + + + Gets the maximum width value + + The width collection. + + + + + Writes the content of the sheet. + + The sheet. + The output directory path. + The saveoption. + + + + Draw the converted Base64 value of the IconSet. + + Base64 value of the IconSet + Width of the cell. + Height of the cell. + Horizontal alignment of the value in the cell. + Style name created for the value in the cell. + + + + Gets the css class name. + + Cell. + Extented format. + Cell Merged. + Display text. + + + + To Find the HorizontalAlignment + + The migrant range. + + + + + To write the style in HTML conversion + + Migrant range + + + + Sets the Hyperlink for the cell. + + The cell value + + + + Returns the hyperlink. + + It's represent cell formula + + + + + Normalizes the string. + + The value. + The result. + The count. + Width of the columns. + The column number + The sheet. + The saveoption. + + + + Writes the width of the cell. + + The result. + The writer. + Width of the columns. + The column Number. + The row. + The sheet. + The saveoption. + + + + + Writes the image. + + The sheet. + The writer. + The output directory path. + The saveoption. + + + + Converts Chart to Image + + The Chart + + + + Converts Chart to Image Stream + + The Chart + + + + Writes the chart. + + The sheet. + The writer. + The output directory path. + The saveoption. + The Chart. + The imageName + + + + Gets the extension. + + The format. + + + + + Writes the image. + + The sheet. + The writer. + The output directory path. + The saveoption. + + + + Gets the name of the column. + + The i column. + + + + + Builds the HTML files. + + The book. + The output directory path. + The saveoption. + + + + Checking for the sheets have the charts and pictures and store in the collection + + + + + Get the shape style + + Input shape + boolean value indicates whether to calculate row offset or not + the shape style + + + + Calculate the offset value from row/column offset from input values + + Input shape where the offset to be calculated + the current row/column of the shape + the current offSetValue of the shape + the constant value respect to row or column + the calculated offset in the cell + + + + Write the charts and pictures in the worksheet, when they are not in used range + + the input worksheet + the output image path of the shapes + the HTML save options + + + + Write the charts and pictures in the worksheet in particular cell index + + the input cell index of the image + the input worksheet + the output image path of the shapes + the HTML save options + + + + Get the extended columns count respect to shapes in the sheet + + input worksheet + the extened columns count + + + + Check for the shapes in the merged regions if it ,write them + + the input worksheet + the merged cell infor object + the first row of the merged cell + the first column of the merged cell + the input path for shapes + the HTML save options + + + + Get the merged region offset for the shape + + the parent sheet + the start cell index of the worksheet + the shape row position + the shape column position + Boolean value indicates whether the offset from top or left + + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Gets the XmlWriter settings. + + + + + Gets the writer. + + The writer. + + + + Gets the column width getter. + + + + + Represents the conversion mode. + + + + + Shape Information + + + + + Utility class for measuring the size of the string. + + + + + + + + + + object + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the image path. + + The image path. + + + + Gets or sets the input text mode + + Useful to convert sheet data based on either DisplayText or Value + + + + GetText enumeration + + + + + DisplayText + + + + + Value + + + + + Initialise stack for maintaining Html styles. + + + + + Represent format text. + + + + + Indicate preservation break for invalid styles or not. + + + + + Indicate the current tag is Span or not. + + + + + Loads the XHtml. + + The HTML tags. + + + + Remove unwanted quotes in html string. + + Html string + String + + + + Replace unwanted quotes in given HTML string + + HTml string + Regex + HTML string + + + + Prepares the HTML string. + + The HTML string. + + + + Replace constants by Unicode. + + The HTML tags. + + + + + + Replace HTML break tags have diffrent combination. + + The HTML tags. + + + + + Replace HTML Special Character's EntityNames by EntityNumbers. + + The HTML Tags. + + + + + Replace HTML Symbol's EntityNames by EntityNumbers. + + The HTML Tags. + + + + + Replace HTML Character's EntityNames by EntityNumbers. + + The HTML Tags. + + + + + Replace HTML Math Symbol's EntityNames by EntityNumbers. + + The HTML Tags. + + + + + Replace HTML Greek Letter's EntityNames by EntityNumbers. + + The HTML Tags. + + + + + Replace HTML Other EntityNames by EntityNumbers. + + The HTML Tags. + + + + + Insert HTML start element based on XHtml validation type. + + The HTML tags. + + + + + Parse the HTML tags. + + The HTML tags. + Rich-text range. + + + + Traverses the child nodes. + + The nodes. + Rich-text range. + Represent the Paragaraph tag. + + + + Parses the tags. + + The node. + Rich-text range. + + + + Appends the HTML text. + + The HTML tag. + Rich-text range. + + + + Check whether the tag is empty tag. + + The HTML tag. + + + + + Parse heading tag. + + Rich-text string range. + The HTML tag. + + + + Get color value. + + Get RGB values. + + + + + Get font name. + + Get font name. + + + + + Gets the attribute value. + + The HTML tag. + Name of the attribute. + + + + + Traverse text within the tag. + + The HTML tag. + Rich-text string range. + + + + Applies the formatting. + + Font style. + + + + Prese the hyperlink tag and attributes. + + Hyperlink tag. + Rich-text string range. + + + + Ensures the style. + + The HTML tag attributes. + + + + + Adds the style. + + + + + + Parses the style. + + Style attribute. + + + + Get foramt. + + Text format. + Attribute name. + Attribute values. + The HTML tag. + + + + Leaves the style. + + if the style is present, set to true. + + + + Gets the current format. + + The current format. + + + + Get or set indicate whether current tag is span + + + + + Creating Dictinary. + + + + + Initialize Dictinary. + + + + + Clones this instance. + + + + + + Checks whether dictionary contains the key. + + + + + + + Determines whether the specified property key has value. + + + + + + + Add key in dictionary. + + Key of text format. + Value. + + + + Set the values for the properties. + + Set key for text. + Set tha value for key + + + + Specifies text alignment + + + + + Specifies horizantal alignment + + + + + Specifies vertical alignment + + + + + Specifies display + + + + + Specifies superscript + + + + + Specifies subscript + + + + + Specifies bold format. + + + + + Specifies italic format. + + + + + Specifies underline format. + + + + + Specifies strike format. + + + + + Specifies font color of the text. + + + + + Specifies the font size. + + + + + Specifies the font family. + + + + + Specifies the back color. + + + + + Contains the font attributes (font name, font size, + color, and so on) for an object. + + + + + Summary description for IInternalExtendedFormat. + + + + + Contains the font attributes (font name, size, + color, and so on) for an object. + + + + + Returns object for this extended format. + + + The following code illustrates how to access Borders property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set border + style.Borders.Color = ExcelKnownColors.Blue; + style.Borders.LineStyle = ExcelLineStyle.Thick; + + //Set style + worksheet["C2"].CellStyle = style; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set border + format.Borders.Color = ExcelKnownColors.Red; + format.Borders.LineStyle = ExcelLineStyle.Thick; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets / Sets index of fill background color. Obsolete, will be removed in next release. + + + Use instead of this property. + + + + + Gets / Sets fill background color. Obsolete, will be removed in next release. + + + Use instead of this property. + + + + + Gets / Sets index of fill foreground color. Obsolete, will be removed in next release. + + + Use instead of this property. + + + + + Gets / Sets fill foreground color. Obsolete, will be removed in next release. + + + Use instead of this property. + + + + + Gets / Sets fill pattern. + + + By default fill pattern will be set to so patterns will not be visbile. Here for example, we set to + fill pattern. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set pattern + style.FillPattern = ExcelPattern.VerticalStripe; + + //Set pattern color + style.PatternColorIndex = ExcelKnownColors.Red; + + //Set style + worksheet["C2"].CellStyle = style; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set pattern + format.FillPattern = ExcelPattern.VerticalStripe; + + //Set pattern color + format.PatternColorIndex = ExcelKnownColors.Red; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets object for this extended format. Read-only. + + + The following code illustrates how to access property and set to the . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["E2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set font + IFont font = style.Font; + + //Set bold + font.Bold = true; + + //Set style + worksheet["C2"].CellStyle = style; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set font + IFont formatFont = format.Font; + + //Set bold + formatFont.Bold = true; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + True if formula is hidden. + + + This property will work only if the sheet proetction is enabled. + + + The following code illustrates how to set visibility for the formula applied to a cell. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load values + worksheet["B2"].Value = worksheet["C2"].Value = "10"; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["D2"].CellStyle = style; + + //Set formula + worksheet["D2"].Formula = "B2+C2"; + + //Set FormulaHidden + style.FormulaHidden = true; + + //Set locked + style.Locked = true; + + //Get extended format + IExtendedFormat format = worksheet["D3"].CellStyle; + + //Set formula + worksheet["D3"].Formula = "B2+C2"; + + //Set FormulaHidden + format.FormulaHidden = true; + + //Set locked + format.Locked = true; + + //Enable sheet protection + worksheet.Protect("", ExcelSheetProtection.All); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Horizontal alignment. + + + The following code illustrates how to set horizontal alignment to the data in the cell. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["E2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set alignment + style.HorizontalAlignment = ExcelHAlign.HAlignRight; + + //Set style + worksheet["C2"].CellStyle = style; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set alignment + format.HorizontalAlignment = ExcelHAlign.HAlignRight; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + True if the style includes the AddIndent, HorizontalAlignment, + VerticalAlignment, WrapText, and Orientation properties. + Read / write Boolean. + + + The following code illustrates how to exclude alignment related settings for a specific object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["E2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set alignment + style.HorizontalAlignment = ExcelHAlign.HAlignRight; + + //Set color + style.ColorIndex = ExcelKnownColors.Red; + + //Set include alignment + style.IncludeAlignment = false; + + //Set style + worksheet["C2"].CellStyle = style; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set alignment + format.HorizontalAlignment = ExcelHAlign.HAlignRight; + + //Set color + format.ColorIndex = ExcelKnownColors.Red; + + //Set include alignment + format.IncludeAlignment = false; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + True if the includes the Color, ColorIndex, LineStyle, + and Weight border properties. Read / write Boolean. + + + The following code illustrates how to exclude related settings for a specific object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set border + style.Borders.Color = ExcelKnownColors.Blue; + style.Borders.LineStyle = ExcelLineStyle.Thick; + + //Set color + style.ColorIndex = ExcelKnownColors.Red; + + //Set include border + style.IncludeBorder = false; + + //Set style + worksheet["C2"].CellStyle = style; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set border + format.Borders.Color = ExcelKnownColors.Red; + format.Borders.LineStyle = ExcelLineStyle.Thick; + + //Set color + format.ColorIndex = ExcelKnownColors.Blue; + + //Set include border + format.IncludeBorder = false; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + True if the style includes the Background, Bold, Color, + ColorIndex, FontStyle, Italic, Name, OutlineFont, Shadow, + Size, Strikethrough, Subscript, Superscript, and Underline + font properties. Read / write Boolean. + + + The following code illustrates how to exclude related settings for a specific object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["E2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set font + IFont font = style.Font; + + //Set bold + font.Bold = true; + + //Set include font + style.IncludeFont = false; + + //Set style + worksheet["C2"].CellStyle = style; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set font + IFont formatFont = format.Font; + + //Set bold + formatFont.Bold = true; + + //Set include font + format.IncludeFont = false; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + True if the includes the NumberFormat property. + Read / write Boolean. + + + The following code illustrates how to exclude NumberFormat for a specific object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set values + worksheet["C2"].Value = "1200.40"; + worksheet["E2"].Value = "1200.40"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set number format index + style.NumberFormat = "# ?/?"; + + //Set include number format + style.IncludeNumberFormat = false; + + //Set modified style + worksheet["C2"].CellStyle = style; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set number format index + format.NumberFormat = "# ?/?"; + + //Set include number format + format.IncludeNumberFormat = false; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + True if the includes the Color, ColorIndex, + InvertIfNegative, Pattern, PatternColor, and PatternColorIndex + interior properties. Read / write Boolean. + + + The following code illustrates how to exclude pattern related settings for a specific object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["E2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set pattern and color + style.FillPattern = ExcelPattern.ThinHorizontalCrosshatch; + + //Set pattern color + style.PatternColorIndex = ExcelKnownColors.Blue; + + //Set include pattern + style.IncludePatterns = false; + + //Set style + worksheet["C2"].CellStyle = style; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set pattern and color + format.FillPattern = ExcelPattern.ThinHorizontalCrosshatch; + + //Set pattern color + format.PatternColorIndex = ExcelKnownColors.Blue; + + //Set include pattern + format.IncludePatterns = false; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + True if the style includes the FormulaHidden and Locked protection + properties. Read / write Boolean. + + + The following code illustrates how to set IncludeProtection property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load values + worksheet["B2"].Value = "10"; + worksheet["C2"].Value = "20"; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["B2"].CellStyle = style; + + //Set locked + style.Locked = false; + + //Set IncludeProtection + style.IncludeProtection = false; + + //Get extended format + IExtendedFormat format = worksheet["C2"].CellStyle; + + //Set locked + format.Locked = false; + + //Set IncludeProtection + format.IncludeProtection = false; + + //Enable sheet protection + worksheet.Protect("", ExcelSheetProtection.All); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or set Indent level. + + + The following code illustrates how to set indent level for a . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["E2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set indent level + style.IndentLevel = 2; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set indent level + format.IndentLevel = 2; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + If true then first symbol in cell is apostrophe. + + + The following code illustrates how to access IsFirstSymbolApostrophe property of a . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set text + worksheet["C2"].Text = @"'12345"; + + //Access extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set text + worksheet["E2"].Text = @"'12345"; + + //Save + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + + //Open worksheet + IWorkbook book = application.Workbooks.Open("CellFormats.xls"); + IWorksheet sheet = book.Worksheets[0]; + + //Get style + IStyle customStyle = sheet["C2"].CellStyle; + + //Get extended format + IExtendedFormat extendedFormat = sheet["E2"].CellStyle; + + //Check first symbol is apostrophe or not + Console.Write(customStyle.IsFirstSymbolApostrophe); + Console.Write(extendedFormat.IsFirstSymbolApostrophe); + + //Save and dispose + book.SaveAs("CellFormats.xlsx"); + book.Close(); + Console.ReadKey(); + } + //Output will be + //True + //True + + + + + + True if cell is locked. + + + The following code illustrates how to set Locked for a . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load values + worksheet["B2"].Value = worksheet["C2"].Value = "10"; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["D2"].CellStyle = style; + + //Set formula + worksheet["D2"].Formula = "B2+C2"; + + //Set FormulaHidden + style.FormulaHidden = true; + + //Set locked + style.Locked = true; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set formula + worksheet["E2"].Formula = "B2+C2"; + + //Set FormulaHidden + format.FormulaHidden = true; + + //Set locked + format.Locked = true; + + //Enable sheet protection + worksheet.Protect("", ExcelSheetProtection.All); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + For far east languages. Supported only for format. Always 0 for US. + + + The following code illustrates how to set JustifyLast property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set style + IStyle style = worksheet["C2"].CellStyle; + + //Set justify last + style.JustifyLast = true; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set justify last + format.JustifyLast = true; + + //Save and Dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the number format code for the object. Read / write String. + + + To know more about number formats refer Apply Number Formats. + + + The following code illustrates how to set number format for the . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Value = "1200.40"; + worksheet["E2"].Value = "1340.40"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set number format + style.NumberFormat = "#,##0.00_);[Red](#,##0.00)"; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set number format + format.NumberFormat = "#,##0.00_);[Red](#,##0.00)"; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets / Sets format index. + + + To know more about number formats refer Apply Number Formats. + + + By default, XlsIO holds 36 number format types that can be applied by just setting NumberFormatIndex. Here for example, we set number format in the 5th index + to apply. To get more customization we can use to set number formatting string. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Value = "1200.40"; + worksheet["E2"].Value = "1234.40"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set number format index + style.NumberFormatIndex = 5; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set number format index + format.NumberFormatIndex = 5; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the format code for the object as a string in the + language of the user. Read / write String. + + + The following code illustrates how to set NumberFormatLocal property of a . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Value = "1200.40"; + worksheet["E2"].Value = "1234.40"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set number format + style.NumberFormatLocal = "$###.##"; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set number format + format.NumberFormatLocal = "$###.##"; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Returns object that describes number format. Read-only. + + + The following code illustrates how to access using NumberFormatSettings property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Value = "1200.40"; + worksheet["E2"].Value = "1200.45"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set number format index + style.NumberFormat = "#,##0.00"; + + //Set number format settings + INumberFormat numberFormat = style.NumberFormatSettings; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set number format index + format.NumberFormat = "#,##0.00"; + + //Set number format settings + INumberFormat extendedNumberFormat = format.NumberFormatSettings; + + //Check number format decimal places + Console.WriteLine(numberFormat.DecimalPlaces); + Console.WriteLine(extendedNumberFormat.DecimalPlaces); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //2 + //2 + + + + + + Text direction, the reading order for far east versions. + + + The following code illustrates how to set ReadingOrder property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set style + IStyle style = worksheet["C2"].CellStyle; + + //Set justify last + style.JustifyLast = true; + + //Set reading order + style.ReadingOrder = ExcelReadingOrderType.RightToLeft; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set justify last + format.JustifyLast = true; + + //Set reading order + format.ReadingOrder = ExcelReadingOrderType.RightToLeft; + + //Save and Dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Text rotation angle: + 0 Not rotated + 1-90 1 to 90 degrees counterclockwise + 91-180 1 to 90 degrees clockwise + 255 Letters are stacked top-to-bottom, but not rotated. + + Thrown when value is more than 0xFF. + + The following code illustrates how to set Rotation for . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["E2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set rotation + style.Rotation = 60; + + //Set style + worksheet["C2"].CellStyle = style; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set rotation + format.Rotation = 40; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + True - shrink content to fit into cell. + + + The following code illustrates how to set ShrinkToFit property for . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add text + worksheet["C2"].Text = "This is a sample text"; + worksheet["E2"].Text = "This is a sample text"; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set shrink to fit + style.ShrinkToFit = true; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set shrink to fit + format.ShrinkToFit = true; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Vertical alignment. + + + By default is set to VerticalAlignment. Here for example, we set to + VerticalAlignment. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["C5"].Text = "Sample"; + + //Set row height + worksheet["C2"].RowHeight = 25; + worksheet["C5"].RowHeight = 25; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set alignment + style.VerticalAlignment = ExcelVAlign.VAlignCenter; + + //Set style + worksheet["C2"].CellStyle = style; + + //Get extended format + IExtendedFormat format = worksheet["C5"].CellStyle; + + //Set alignment + format.VerticalAlignment = ExcelVAlign.VAlignCenter; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + True - Text is wrapped at right border. + + + To know more about text wrapping refer Apply Wrap Text. + + + The following code illustrates how to set WrapText property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "This is a Sample text"; + worksheet["C5"].Text = "This is a Sample text"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set wrap text + style.WrapText = true; + + //Set style + worksheet["C2"].CellStyle = style; + + //Get extended format + IExtendedFormat format = worksheet["C5"].CellStyle; + + //Set wrap text + format.WrapText = true; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the color of the interior pattern as an index into the current color palette. + + + The following code illustrates how to set a color from enumeration to the pattern of the . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["E2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set pattern + style.FillPattern = ExcelPattern.VerticalStripe; + + //Set pattern color + style.PatternColorIndex = ExcelKnownColors.Red; + + //Set style + worksheet["C2"].CellStyle = style; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set pattern + format.FillPattern = ExcelPattern.VerticalStripe; + + //Set pattern color + format.PatternColorIndex = ExcelKnownColors.Red; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the color of the interior pattern as a RGB Color value. + + + The following code illustrates how to set a RGB color to the pattern of the . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["E2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set pattern + style.FillPattern = ExcelPattern.VerticalStripe; + + //Set pattern color + style.PatternColor = System.Drawing.Color.Red; + + //Set style + worksheet["C2"].CellStyle = style; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set pattern + format.FillPattern = ExcelPattern.VerticalStripe; + + //Set pattern color + format.PatternColor = System.Drawing.Color.Red; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the color from enumeration to the . + + + The following code illsutrates how to set a color from enumeration to the ColorIndex property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set color + style.ColorIndex = ExcelKnownColors.Red; + + //Set style + worksheet["C2"].CellStyle = style; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set color + format.ColorIndex = ExcelKnownColors.Red; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the RGB color to cell. + + + The following code illustrates how to set RGB color to Color property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set color + style.Color = System.Drawing.Color.Red; + + //Set style + worksheet["C2"].CellStyle = style; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set color + format.Color = System.Drawing.Color.Red; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets value indicating whether format was modified, compared to parent format. + + + The following code illustrates how to set IsModified property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set style + IStyle style = worksheet["C2"].CellStyle; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Check IsModified + Console.WriteLine(style.IsModified); + Console.WriteLine(format.IsModified); + + //Save and Dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //False + //False + + + + + + Returns true if the Cell has . + + + The following code ilustrats how to access HasBorder property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["E2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set border + style.Borders.Color = ExcelKnownColors.Blue; + style.Borders.LineStyle = ExcelLineStyle.Thick; + + //Set style + worksheet["C2"].CellStyle = style; + + //Get extended format + IExtendedFormat format = worksheet["E2"].CellStyle; + + //Set border + format.Borders.Color = ExcelKnownColors.Blue; + format.Borders.LineStyle = ExcelLineStyle.Thick; + + //Check border + Console.WriteLine(style.HasBorder); + Console.WriteLine(format.HasBorder); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + //True + + + + + + Starts updating process. + + + + + Ends updating process. + + + + + Get/set BottomBorder color. + + + + + Get/set TopBorder color. + + + + + Get/set LeftBorder color. + + + + + Get/set RightBorder color. + + + + + Get/set DiagonalUpBorder color. + + + + + Gets / sets line style of the left border. + + + + + Gets / sets line style of the right border. + + + + + Gets / sets line style of the top border. + + + + + Gets / sets line style of the bottom border. + + + + + Gets / sets line style of the diagonal border. + + + + + Gets / sets line style of the diagonal border. + + + + + Indicates whether DiagonalUp line is visible. + + + + + Indicates whether DiagonalDown line is visible. + + + + + Parent workbook. + + + + + Summary description for IXFIndex. + + + + + Gets format index in m_book.InnerFormats. + + + + + Parent index that indicates that extended format doesn't have any parent format. + + + + + Indicates that text is drawn from top to bottom. + + + + + Maximum tint value. + + + + + Weight of the bold font. + + + + + Weight of the normal font. + + + + + Conditional Formats applied flag + + + + + ExtendedFormatRecord that contains information about font and format indexes, + borders, colors, etc. + + + + + + Parent workbook. + + + + + Position of this format in m_book.InnerExtFormats. + + + + + ShapeFill implementation that contains gradient fill effects. + + + + + + + + + + + + + + + Represent the cell-border + + + + + Indicating whether cell has pivot button + + + + + Incidates the cell has vertical text. + + + + + Indicates if the extended format is used in the woekbook. + + + + + Conditional Format Priority + + + + + Indicates whether this extended format is created for pivot inline format. + + + + + Represents the data bar color + + + + + Represents the priority of data bar codnitional format. + + + + + This method should be called after any changes. + Sets Saved property of the parent workbook to False. + + + + + Copies all data from this XF into another. + + Format to copy into. + + + + Creates child format if this format is for named style and registers it in workbook. + + Child format. + + + + Creates child format if this format is for named style. + + Defines whether to register format in workbook. + Child format. + + + + Updates the include properties in current formats + + Parent index. + XF format record. + XF format recordS. + + + + + + + + + + + Synchronizes properties with parent record. + + + + + Copies borders from source format. + + Format to copy border settings from. + + + + Copies patterns from source format. + + Format to copy pattern settings from. + + + + Starts updating process. + + + + + Ends updating process. + + + + + Sets application and parent fields. + + Application object for the format. + Parent object for the format. + + + + Recovers ExtendedFormatImpl from the stream. + + Application object for the format. + Parent object for the format. + + Reader that contains ExtendedFormatRecord for + the new extended format. + + + + + Recovers ExtendedFormatImpl records from Biff Records array and position + of ExtendedFormatRecord in it. + + Application object for the XF. + Parent object for the XF. + Array of Biff Records. + Position of ExtendedFormatRecord. + + + + Recovers ExtendedFormatImpl records from Biff Records + List and position of ExtendedFormatRecord in it. + + Application object for the XF. + Parent object for the XF. + List of Biff Records. + Position of ExtendedFormatRecord in List. + + + + Gets information about extended format from specified format. + + Application object for the XF. + Parent object for the XF. + Format that contains all needed information. + + + + Gets information about extended format from specified format. + + Application object for the XF. + Parent object for the XF. + Format that contains all needed information. + + + + Searches for all necessary parent objects. + + + + + Recover from the stream. + + Reader with XF data. + + + + Recovers ExtendedFormat from array of Biff Records and position of + ExtendedFormatRecord in it. + + Array of Biff Records. + Position of ExtendedFormatRecord in the array. + + + + Parses ExtendedFormatRecord + + Record to parse. + + When font index in format record is larger than size + of the inner font collection of the parent workbook. + + + + + Parses ExtendedFormatRecord + + Record to parse. + + When font index in format record is larger than size + of the inner font collection of the parent workbook. + + + + + Updates values from parent format and initializes colors if necessary. + + + + + Updates values from current format. + + + + + Updates values from current format + + Source extended format record to copy from + + + + Initializes color objects. + + + + + Updates color field in the record. + + + + + Updates pattern color in the record. + + + + + Updates top border color in the record. + + + + + Updates bottom border color in the record. + + + + + Updates left border color in the record. + + + + + Updates right border color in the record. + + + + + Updates diagonal border color in the record. + + + + + Adds format records into records array. + + Array that will receive format information. + + + + Checks the record to see if everything is proper and corrects + it if necessary. + + + + + Adds Extended XF format records into records array. + + Array that will receive format information. + + + + Copy Colors. + + + + + Compares the current instance with another object of the same type. + + Object to compare with this instance. + + Less than zero - This instance is less than obj. + Zero - This instance is equal to obj. + Greater than zero - This instance is greater than obj. + + + + + + + + + + + + Compares formats without comparing indexes. + + Format to compare. + 0 if formats are equal. + + + + Serves as a hash function for a particular type, suitable for use + in hashing algorithms and data structures like a hash table. + + A hash code for the current Object. + + + + 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. + + + + + Copies one extended format into another. + + Destination format. + Source format. + Indicates whether we should change corresponding + Include... flag(s) after copying data. + + + + Copies alignment of one XFormat into another. + + Destination format. + Source format. + Indicates whether we should change corresponding + Include... flag(s) after copying data. + + + + Copies borders of one XFormat into another. + + Destination format. + Source format. + Indicates whether we should change corresponding + Include... flag(s) after copying data. + + + + Copies font of one XFormat into another. + + Destination format. + Source format. + Indicates whether we should change corresponding + Include... flag(s) after copying data. + + + + Copies number format of one XFormat into another. + + Destination format. + Source format. + Indicates whether we should change corresponding + Include... flag(s) after copying data. + + + + Copies patterns of one XFormat into another. + + Destination format. + Source format. + Indicates whether we should change corresponding + Include... flag(s) after copying data. + + + + Copies protection of one XFormat into another. + + Destination format. + Source format. + Indicates whether we should change corresponding + Include... flag(s) after copying data. + + + + Copies color settings from specified format object. + + + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of the current instance. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of the current instance. + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Clears the format + + + + + Checks the record for borders and updates hasBorder + + The record to be checked + + + + Get / set font index. + + + + + Gets format index in m_book.InnerFormats. + + + + + Get / set Format index. + + + + + Get / set fill pattern. + + + + + Get / set fill background color. + + + + + Get / set fill background color. + + + + + Get / set fill foreground color. + + + + + Get / set fill foreground color. + + + + + Horizontal alignment. + + + + + Indent level. + + + + + Indicates whether formula is hidden. + + + + + Indicates whether cell with this XF is locked. + + + + + For far east languages. Supported only for format. Always 0 for US. + + + + + Returns or sets the format code for the object. Read/write String. + + + + + Returns or sets the format code for the object as a string in the + language of the user. Read/write String. + + + + + Returns object that describes number format. Read-only. + + + + + True- Indicates that the contents are shrunk to fit into cell. + + + + + True - Indicates that text is wrapped at right border. + + + + + Vertical alignment. + + + + + Flag for horizontal and vertical alignment, text wrap, indentation, + orientation, rotation, and text direction. If False, the attribute + of parent style is used. + + + + + Flag for border lines. + If False, the attribute of parent style is used. + + + + + Flag for font. + If False, the attribute of parent style is used. + + + + + Flag for number format. + If False, the attribute of parent style is used. + + + + + Flag for background area style. + If False, the attribute of parent style is used. + + + + + Flag for cell protection (cell locked and formula hidden). + If False, the attribute of parent style is used. + + + + + Gets font object for this extended format. Read-only. + + + + + + + + + + If true then first symbol in cell is apostrophe. + + + + + Returns or sets the color of the interior pattern as an index into the current color palette. + + + + + Returns or sets the color of the interior pattern as an Color value. + + + + + Returns or sets the color of the interior pattern as an Color value. + + + + + Returns or sets the color of the interior. The color is specified as + an index value into the current color palette. + + + + + Returns or sets the cell shading color. + + + + + Returns or sets the cell shading color. + + + + + Gets value indicating whether format was modified, compared to parent format. + + + + + List of extended property. + + + + + Text direction, the reading order for far east versions. + + + + + Text rotation angle: + 0 Not rotated + 1-90 1 to 90 degrees counterclockwise + 91-180 1 to 90 degrees clockwise + 255 Letters are stacked top-to-bottom, but not rotated. + + + Thrown when value is more than 0xFF. + + + + + Incidates whether the cell is a vertical text + i.e. rotation of 255 degree is considered as vertical text + + + + + Type of the extended format. + + + + + Conditional Format priority + + + + + Gets or sets the data bar color. + + + + + Gets or sets the priority for data bar conditional format. + + + + + Conditional Format styles flag + + + + + Gets / sets gradient object. + + + + + Get / set index for this record in Workbook.InnerExtFormats collection. + + + + + Read-only. Returns ExtendedFormatRecord with + information about this format. + + + + + Read-only. Returns ExtendedXFormat with information about this format. + + + + + Index of the parent extended format. + + + + + Returns parent workbook. + + + + + Returns parent collection. Read-only. + + + + + Get/set BottomBorder color. + + + + + Get/set TopBorder color. + + + + + Get/set LeftBorder color. + + + + + Get/set RightBorder color. + + + + + Get/set DiagonalUpBorder color. + + + + + Gets / sets line style of the left border. + + + + + Gets / sets line style of the right border. + + + + + Gets / sets line style of the top border. + + + + + Gets / sets line style of the bottom border. + + + + + Gets / sets line style of the diagonal border. + + + + + Gets / sets line style of the diagonal border. + + + + + Indicates whether DiagonalUp line is visible. + + + + + Indicates whether DiagonalDown line is visible. + + + + + Indicates whether this format is child format. + + + + + Indicates whether color is default. Read-only. + + + + + Indicates whether pattern color is default. Read-only. + + + + + Returns record from parent format if possible, otherwise just returns format record. Read-only. + + + + + Returns parent format if possible, otherwise just returns this format. Read-only. + + + + + Gets number format object. + + + + + Gets or sets whether border is present + + + + + Indicating whether cell has pivot button + + + + + Indicates whether this extended format is created for pivot inline format. + + + + + + + + + + + + + + + Returns color of the top border. Read-only. + + + + + Returns color of the bottom border. Read-only. + + + + + Returns color of the left border. Read-only. + + + + + Returns color of the right border. Read-only. + + + + + Returns color of the diagonal border. Read-only. + + + + + Default data bar direction + + + + + Default data bar color. + + + + + Font settings. + + + + + Holds the Name of the applied IconSet. + + + + + Holds the id of the Icon from the applied Iconset. + + + + + Holds the Name of the applied IconSet. + + + + + Represents the icon set image. + + + + + True if only the icon is to be displayed. False otherwise. + + + + + Indicates DataBarPercent + + + + + Indicates data bar has gradient fill or not. + + + + + Represents the data bar cell value. + + + + + Represents the direction of the data bar. + + + + + Represents whether the data bar has extension list or not + + + + + Represents the GUID for the data bar extension list + + + + + Represents the border color of the data bar. + + + + + Represents whether the data bar has a border. + + + + + Returns or sets a Boolean value that specifies if the value in the cell + is displayed if the data bar conditional format is applied to the range. + + + + + Represents the axis color of the data bar. + + + + + Represents the negative border color of the data bar. + + + + + Represents the negative fill color of the data bar. + + + + + Represents whether the data bar has a negative bar color + that is different from the positive bar color. + + + + + Represents whether the data bar has a negative border color + that is different from the positive border color. + + + + + The color of the bars in a data bar conditional format. + + + + + Checkes wether the conditional format has databar in it. + + + + + Checkes wether the conditional format has iconset in it. + + + + + Repesents the minimum value in data bar conditional format. + + + + + Repesents the maximum value in data bar conditional format. + + + + + Initializes new instance of the format. + + Object to copy settings from. + + + + Updates icon set values in the new format. + + Extended format to be updated. + + + + Returns object that stores font settings. Read-only. + + + + + Property to access the Id of the Icon in the IconSet. + + + + + Property to access IconSetType applied. + + + + + Holds the IconName for internal processing. + + + + + Gets or sets the icon ste image. + + + + + Gets or sets the direction of the data bar. + + + + + Gets or sets the axis color of the data bar. + This element MUST exist if and only if axisPosition does not equal "none". + + + + + Gets or sets the minimum value of the data bar. + + + + + Returns or sets the boolean value if the conditional format contains databar. + + + + + Returns or sets the boolean value if the conditional format contains iconset. + + + + + Gets or sets the axis color of the data bar. + This element MUST exist if and only if axisPosition does not equal "none". + + + + + Gets or sets the negative border color of the data bar. + This element MUST exist if and only if negativeBarBorderColorSameAsPositive equals "false" and border equals "true". + + + + + Represents whether the data bar has a negative bar color + that is different from the positive bar color. + + + + + Represents whether the data bar has a negative border color + that is different from the positive border color. + + + + + Gest or sests the negative fill color of the data bar. + This element MUST exist if and only if negativeBarColorSameAsPositive equals "false". + + + + + Returns or sets a Boolean value that specifies if the value in the cell + is displayed if the data bar conditional format is applied to the range. + + + + + Gets or Sets the bool value if negative bar is present. + + + + + Gets or sets the border color of the data bar. + This element MUST exist if and only if border equals "true". + + + + + Gets whether the data bar has a border + + + + + Get/set DataBarPercent + + + + + Gets or sets databar has gradient fill or not. + + + + + Gets or sets databar cell value. + + + + + True if only the icon is to be displayed. False otherwise. + + + + + Bit converter + + + + + Double to int64 + + + + + + + int64 to double + + + + + + + This class contains some extensions to DateTime class. + + + + + This class contains some extension to the Color class in (SILVERLIGHT). + + + + + Contains black color. + + + + + Contains white color. + + + + + Contains empty color. + + + + + Contains red color. + + + + + Contains blue color. + + + + + Contains dark gray color. + + + + + Contains yellow color. + + + + + Contains cyan color. + + + + + Contains magenta color. + + + + + Contains gray color. + + + + + Chart foreground color. + + + + + Chart background color. + + + + + Chart neutral color. + + + + + Converts Int32 value into Color. + + Value to convert. + Converted value. + + + + Get the color from name + + + + + + + Represents the Math operation + + + + + Truncate the double value + + + + + + + Represents a cell, a row, a column, collection of cells or a 3-D Range. + + + + + Activates the cell. + + Returns the active cell. + + The following code illustrates how to activate a Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + // Activates 'F1' cell. + worksheet.Range["F1"].Activate(); + + workbook.SaveAs("Activate.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Activates the cell and its worksheet. + + True to set as top left cell. + Returns the active cell. + + The following code illustrates how to activate a Range with scroll flag. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + // Activates 'F1' cell. + worksheet.Range["F1"].Activate(true); + + workbook.SaveAs("Activate.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Groups the Range by row/column. + + + Represents to expand the group by rows/columns. + + Returns the Range after grouping. + + The following code illustrates how to group the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Group Rows + worksheet.Range["A4:A6"].Group(ExcelGroupBy.ByRows); + + //Group Columns + worksheet.Range["C1:F1"].Group(ExcelGroupBy.ByColumns); + + workbook.SaveAs("Grouping.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Groups the Range by row/column with collapse flag. + + + Represents to expand the group by rows/columns. + + Indicates whether group should be collapsed. + Returns the Range after grouping. + + The following code illustrates how to group the Range with collapse flag. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Group Rows + worksheet.Range["A1:A3"].Group(ExcelGroupBy.ByRows, true); + + //Group Columns + worksheet.Range["A1:B1"].Group(ExcelGroupBy.ByColumns, false); + + workbook.SaveAs("Grouping.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Creates subtotals for the Range. + + Column index based on which grouping should be done. + Represents a consolidation function to be applied. + List of column indexes on which subtotal is calculated. + + The following code illustrates how to subtotal the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set the range for subtotaling + IRange range = worksheet.Range["C3:G12"]; + + //Perform subtotals for the Range with every change in first column + //and subtotals to be included for specified list of columns + range.SubTotal(0, ConsolidationFunction.Sum, new int[] { 2, 3, 4 }); + + workbook.SaveAs("Subtotal.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + + Creates subtotals for the Range with the specified formatting flags. + + Column index based on which grouping should be done + Represents a consolidation function to be applied. + List of column indexes on which subtotal is calculated. + Indicates whether existing SubTotal must be replaced. + Indicates whether page break must be inserted. + Indicates whether SummaryBelowData to be shown + + The following code illustrates how to subtotal the Range with formats. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set the range for subtotaling + IRange range = worksheet.Range["C3:G12"]; + + //Perform subtotals for the range with every change in first column + //and subtotals to be included for specified list of columns + range.SubTotal(0, ConsolidationFunction.Sum, new int[] { 2, 3, 4 }, false, true, true); + + workbook.SaveAs("Subtotal.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + + Creates subtotals for the Range with multiple group by columns and the specified formatting flags. + + Column indexes based on which grouping is done. Given in the order of subtotal levels + Represents a consolidation function to be applied. + List of columns on which subtotal is calculated + Replaces Existing SubTotal + Inserts PageBreaks + SummaryBelowData to be shown + + The following code illustrates how to subtotal the Range with formats. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set the range for subtotaling + IRange range = worksheet.Range["C3:G12"]; + + //Perform subtotals for the range with every change in first column + //and subtotals to be included for specified list of columns + range.SubTotal( new int[] { 1, 2 }, ConsolidationFunction.Sum, new int[] { 2, 3, 4 }, false, true, true); + + workbook.SaveAs("Subtotal.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + + Returns sum of numeric cells in the range. + + + The following code illustrates how to find the sum of numeric cells in the range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set value to cells + worksheet.Range["A1:A3"].Value = "10"; + + //Returns Sum of numeric cells in the range. + double sum = worksheet.Range["A1:A3"].Sum(); + + workbook.SaveAs("Sum.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns sum of numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + The following code illustrates how to find the sum of numeric cells in the range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set value to cells + worksheet.Range["A1:A3"].Value = "10"; + + //Returns Sum of numeric cells in the range. + double sum = worksheet.Range["A1:A3"].Sum(true); + + workbook.SaveAs("Sum.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns average of numeric cells in the range. + + + The following code illustrates how to find the average of numeric cells in the range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set value to cells + worksheet.Range["A1:A3"].Value = "10"; + + //Returns average of numeric cells in the range. + double average = worksheet.Range["A1:A3"].Average(); + + workbook.SaveAs("Average.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns average of numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + The following code illustrates how to find the average of numeric cells in the range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set value to cells + worksheet.Range["A1:A3"].Value = "10"; + + //Returns average of numeric cells in the range. + double average = worksheet.Range["A1:A3"].Average(true); + + workbook.SaveAs("Average.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns minumum value from numeric cells in the range. + + + The following code illustrates how to find the minumum value from numeric cells in the range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set value to cells + worksheet.Range["A1"].Value = "10"; + worksheet.Range["A2"].Value = "20"; + worksheet.Range["A3"].Value = "30"; + + //Returns minumum value from Numeric cells in the given range. + double minimum = worksheet.Range["A1:A3"].Min(); + + workbook.SaveAs("Min.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns minumum value from numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + The following code illustrates how to find the minumum value from numeric cells in the range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set value to cells + worksheet.Range["A1"].Value = "10"; + worksheet.Range["A2"].Value = "20"; + worksheet.Range["A3"].Value = "30"; + + //Returns minumum value from Numeric cells in the range. + double minimum = worksheet.Range["A1:A3"].Min(true); + + workbook.SaveAs("Min.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns maximum value from numeric cells in the range. + + + The following code illustrates how to find the maximum value from numeric cells in the range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set value to cells + worksheet.Range["A1"].Value = "10"; + worksheet.Range["A2"].Value = "20"; + worksheet.Range["A3"].Value = "30"; + + //Returns maximum value from numeric cells in the range. + double maximum = worksheet.Range["A1:A3"].Max(); + + workbook.SaveAs("Max.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns maximum value from numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + The following code illustrates how to find the maximum value from numeric cells in the range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set value to cells + worksheet.Range["A1"].Value = "10"; + worksheet.Range["A2"].Value = "20"; + worksheet.Range["A3"].Value = "30"; + + //Returns maximum value from Numeric cells in the given range. + double maximum = worksheet.Range["A1:A3"].Max(); + + workbook.SaveAs("Max.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Trim the empty rows at top and bottom of the range, the empty columns at left and right of the range. + + Returns the range after trim. + /// + The following code illustrates how to Trim the empty rows at top and bottom of the range, the empty columns at left and right of the range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set value to cells + worksheet.Range["B1"].Value = "10"; + worksheet.Range["B2"].Value = "20"; + worksheet.Range["B3"].Value = "30"; + + //Returns the range after trim the given range. + IRange trim = worksheet.Range["A1:B3"].Trim(); + + workbook.SaveAs("Trim.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Combines the contents of the selected cells in a new larger cell. + + + To know more about merging refer Merging and Un-Merging Cells. + + + The following code illustrates how to merge the Range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["A1"].Text = "Merged cell"; + + //Merge cells + worksheet["A1:B1"].Merge(); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Combines the contents of the selected cells in a new larger cell with clear option flag. + + Clears the Merged cell. + + The following code illustrates how to merge the Range with clear option. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["A1"].Text = "Merged cell"; + worksheet["B1"].Text = "sample"; + + //Merge cells + worksheet["A1:B1"].Merge(true); + + //Unmerge cells + worksheet["A1:B1"].UnMerge(); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Ungroups the Range. + + Represents to expand the group by rows/columns. + Returns the Range after ungrouping. + + The following code illustrates how to ungroup the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Ungroup Rows + worksheet.Range["A1:A3"].Ungroup(ExcelGroupBy.ByRows); + + //Ungroup Columns + worksheet.Range["C1:F1"].Ungroup(ExcelGroupBy.ByColumns); + + workbook.SaveAs("Ungrouping.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Separates merged cells into individual cells. + + + To know more about merging refer Merging and Un-Merging Cells. + + + The following code illustrates how to UnMerge the merged cells. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["A1"].Text = "Merged cell"; + + //Merge cells + worksheet["A1:B1"].Merge(); + + //Unmerge cells + worksheet["A1:B1"].UnMerge(); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Keep rows and columns visible in the Range while the rest of the worksheet scrolls. + + + The following code illustrates how to freeze a pane in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Applying Freeze Pane to the sheet by specifying a cell. + sheet.Range["B2"].FreezePanes(); + + workbook.SaveAs("Freeze.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Clears content in the Range. + + + The following code illustrates how to clear the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + // Clears the Range �A4� . + sheet.Range["A4"].Clear(); + + workbook.SaveAs("ClearRange.xlsx"); + workbook.Version = ExcelVersion.Excel2013; + workbook.Close(); + excelEngine.Dispose(); + + + + + + Clears content and formats in the Range. + + True to clear format. + + The following code illustrates how to clear the Range with formats. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["D2"].Text = "text"; + worksheet["C3"].Text = "in"; + worksheet["D3"].Text = "cell"; + + //Set border + worksheet["C2:D3"].BorderInside(); + + //Clear format + worksheet["C2:D3"].Clear(true); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Clears the Range with the specified . + + Represents the clear options. + + The following code illustrates how to clear the Range with clear options. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + // Clears the Range �A4� with its clear options. + sheet.Range["A4"].Clear(ExcelClearOptions.ClearAll); + + workbook.SaveAs("ClearRange.xlsx"); + workbook.Version = ExcelVersion.Excel2013; + workbook.Close(); + excelEngine.Dispose(); + + + + + + Clears the Range and shifts the cells Up or Left. + + Shifts the cells to the specified direction. + + The following code illustrates how to clear the Range with specified direction. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + // Clearing a Range �A4� with move options. + sheet.Range["A4"].Clear(ExcelMoveDirection.MoveLeft); + + workbook.SaveAs("ClearRange.xlsx"); + workbook.Version = ExcelVersion.Excel2013; + workbook.Close(); + excelEngine.Dispose(); + + + + + + Clears the Range with the specified and . + + Shifts the cells to the specified direction. + Copies the cells with the specified copy Range options. + + The following code illustrates how to clear the Range with specified direction and copy Range options. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + // Clearing a Range �A4� with copy Range and move options. + sheet.Range["A4"].Clear(ExcelMoveDirection.MoveLeft,ExcelCopyRangeOptions.All); + + workbook.SaveAs("ClearRange.xlsx"); + workbook.Version = ExcelVersion.Excel2013; + workbook.Close(); + excelEngine.Dispose(); + + + + + + Moves cells to the specified Range (without updating formulas). + + Represents the destination Range to move. + + The following code illustrates how to move the Range. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + // Moving a Range �A1� to �A5�. + IRange source = sheet.Range["A1"]; + IRange destination = sheet.Range["A5"]; + source.MoveTo(destination); + + workbook.Version = ExcelVersion.Excel2013; + workbook.SaveAs("MoveRange.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + + Copies the Range to the specified Range (without updating formulas). + + Represents the destination Range to copy. + Returns the copied Range. + + The following code illustrates how to copy the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + // Copying a Range �A1� to �A5�. + IRange source = sheet.Range["A1"]; + IRange destination = sheet.Range["A5"]; + source.CopyTo(destination); + + workbook.Version = ExcelVersion.Excel2013; + workbook.SaveAs("CopyRange.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Copies the Range to the specified destination Range with copy options. + + Represents the destination Range to copy. + Represents the copy Range options. + Returns the copied Range. + + The following code illustrates how to copy the Range with copy options. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + // Copying a Range �A1� to �A5�. + IRange source = sheet.Range["A1"]; + IRange destination = sheet.Range["A5"]; + source.CopyTo(destination, ExcelCopyRangeOptions.All); + workbook.Version = ExcelVersion.Excel2013; + workbook.SaveAs("CopyRange.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Copies the Range to the specified destination Range with copy options. + + Represents the destination Range to copy. + Represents if the pasteLinkOptions implement or not . + Returns the copied Range. + + The following code illustrates how to copy the Range with pasteLink options. + + ExcelEngine engine = new ExcelEngine(); + IApplication application = engine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + IRange source = worksheet["A1:D5"]; + IRange destination = worksheet["E10"]; + // Copy range as link from source to destination + source.CopyTo(destination, true); + workbook.Version = ExcelVersion.Excel2013; + workbook.SaveAs("CopyRange.xlsx"); + workbook.Close(); + engine.Dispose(); + + + + + + Copies the Range to the specified destination Range with copy options and skip blanks option. + + Represents the destination Range to copy. + Represents the copy Range options. + Skip blank cells while copying the range from source to destination. + Returns the copied Range. + + This method can be used to prevent copying blank cells in the destination range. If "true", + then blank cells are not copied from source range. + + + The following code illustrates how to copy the Range with skip blanks option. + + using(ExcelEngine engine = new ExcelEngine()) + { + //Create worksheet + IApplication application = engine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load Data + worksheet["A1"].Value = "A"; + worksheet["A3"].Value = "B"; + worksheet["A5"].Value = "C"; + worksheet["A7"].Value = "D"; + worksheet["B1"].Value = "E"; + worksheet["B2"].Value = "F"; + worksheet["B4"].Value = "G"; + worksheet["B6"].Value = "H"; + + //Apply styles + worksheet["A1:A7"].CellStyle.ColorIndex = ExcelKnownColors.Yellow; + + //Skip blanks while copying + worksheet["A1:A7"].CopyTo(worksheet["B1"], ExcelCopyRangeOptions.All, true); + + workbook.SaveAs("SkipBlanks.xlsx"); + workbook.Close(); + } + + + + + + Returns intersection of the Range with specified Range. + + Range to be intersected. + Returns the intersection Range;if there is no intersection, NULL is returned. + + The following code illustrates how to perform intersectwith in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Merging cells + IRange range = worksheet.Range["A16:C16"]; + IRange commonRange = worksheet.Range["B16:D16"].IntersectWith(range); + workbook.SaveAs("Intersection.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Merges the range with specified range and returns merged range. + + Range to be merged with. + Returns a merged range; if the Range is unable to merge, null is returned. + + The following code illustrates how to check whether two ranges are mergable or not. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Merge + worksheet["A2:B2"].Merge(); + + //Get mergable range + IRange mergableRange = worksheet["A2"].MergeArea.MergeWith(worksheet["C2"]); + + //Check mergable Area + if (mergableRange != null) + Console.Write("Mergable!"); + else + Console.Write("Not Mergable!"); + + //Save and Dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //Mergable! + + + + + + Changes the height of the rows in the range to achieve the best fit. + + + To know more about resizing rows and columns refer Auto-Fit Rows or Columns. + This method is supported on Windows Forms, WPF, ASP.NET, ASP.NET MVC, WinRT, WP, Universal and UWP,Xamarin and NetStandard platforms only. + + The following code shows how to auto-size row height to its cell content. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Auto-fit rows + worksheet.Range["A2"].Text = "Fit the content to row"; + worksheet.Range["A2"].WrapText = true; + worksheet.Range["A2"].AutofitRows(); + + //Save and dispose + workbook.SaveAs("AutoFit.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Changes the width of the columns in the range to achieve the best fit. + + + To know more about resizing rows and columns refer Auto-Fit Rows or Columns. + This method is supported on Windows Forms, WPF, ASP.NET, ASP.NET MVC, WinRT, WP, Universal and UWP,Xamarin and NetStandard platforms only. + + The following code shows how to auto-size row height to its cell content. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Auto-fit columns + worksheet.Range["B4"].Text = "Fit the content to column"; + worksheet.Range["B4"].AutofitColumns(); + + //Save and dispose + workbook.SaveAs("AutoFit.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Adds a comment. If the cell has threaded comment, returns null. + + Returns a comment shape. + + The following code illustrates how to insert Comments in the Range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + // Adding comments to a cell. + ICommentShape comment = sheet.Range["A1"].AddComment(); + comment.Text= "Comments"; + + // Add Rich Text Comments. + IRange range = sheet.Range["A6"]; + range.AddComment().RichText.Text = "RichText"; + IRichTextString rtf = range.Comment.RichText; + + // Formatting first 4 characters. + IFont redFont = workbook.CreateFont(); + redFont.Bold = true; + redFont.Color = ExcelKnownColors.Red; + rtf.SetFont(0, 3, redFont); + + //Save and dispose + workbook.SaveAs("Comments.xlsx"); + workbook.Close(); + } + + + + + + Returns the first occurrence cell with the specified string value and . + + Value to found. + Flag that represent type of search. + Returns the first cell with a specified string value, or null if value was not found. + + The following code illustrates how to find the first occurrence of the specified string value in the range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find First with string + IRange result = sheet["A2:K100"].FindFirst("Simple text", ExcelFindType.Text); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the first occurrence cell with the specified double value and . + + Value to found. + Flag that represent type of search. + Returns the first cell with a specified double value, or null if value was not found. + + The following code illustrates how to find the first occurrence of the specified double value in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find First with number + IRange result = sheet["A2:K100"].FindFirst(100.32, ExcelFindType.Number); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the first occurrence cell with the specified bool value. + + Value to be found. + Returns the first cell with a specified bool value, or null if value was not found. + + The following code illustrates how to find the first occurrence of the specified bool value in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find First with bool + IRange result = sheet["A2:K100"].FindFirst(true); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the first occurrence cell with the specified DateTime value. + + Value to be found. + Returns the first cell with a specified DateTime value, or null if value was not found. + + The following code illustrates how to find the first occurrence of the specified DateTime value in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find First with DateTime + IRange result = sheet["A2:K100"].FindFirst(DateTime.Now); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the first occurrence cell with the specified TimeSpan value. + + Value to be found. + Returns the first cell with a specified TimeSpan value, or null if value was not found. + + The following code illustrates how to find the first occurrence of the specified TimeSpan value in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find First with TimeSpan + IRange result = sheet["A2:K100"].FindFirst(TimeSpan.MinValue); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the cells with a specified string value and . + + Value to be found. + Represents type of the value to be found. + Returns the cells with a specified string value, or null if value was not found. + + The following code illustrates how to find the cells with specified string value in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find all with string + IRange[] results = sheet["A2:K100"].FindAll("Simple text", ExcelFindType.Text); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the cells with a specified double value and . + + Value to be found. + Represents type of the value to be found. + Returns the cells with a specified double value, or null if value was not found. + + The following code illustrates how to find the cells with specified double value in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find All with number + IRange[] results = sheet["A2:K100"].FindAll(100.32, ExcelFindType.Number); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the cells with a specified bool value. + + Value to be found. + Returns the cells with a specified bool value, or null if value was not found. + + The following code illustrates how to find the cells with specified bool value in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find all with bool + IRange[] results = sheet["A2:K100"].FindAll(true); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the cells with a specified DateTime value. + + Value to be found. + Returns the cells with a specified DateTime value, or null if value was not found. + + The following code illustrates how to find the cells with specified DateTime value in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find all with DateTime + IRange[] results = sheet["A2:K100"].FindAll(DateTime.Now); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the cells with a specified TimeSpan value. + + Value to be found. + Returns the cells with a specified TimeSpan value, or null if value was not found. + + The following code illustrates how to find the cells with specified TimeSpan value in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find All with Timespan + IRange[] results = sheet["A2:K100"].FindAll(TimeSpan.MinValue); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Replaces the string with the specified string value. + + The string to be replaced. + The string to replace all occurrences of oldValue. + The following code snippet illustrates how to replace the string with another string. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:A3"].Value = "Find"; + string oldValue = "Find"; + string newValue = "NewValue"; + sheet.Range["A1:A3"].Replace(oldValue, newValue); + string fileName = "Replace.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Replaces the string with the specified string value based on the given . + + The string to be replaced. + The string to replace all occurrences of oldValue. + Specifies the find options for the oldValue. + The following code snippet illustrates how to replace the string with another string. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:A3"].Value = "Find"; + string oldValue = "Find"; + string newValue = "NewValue"; + sheet.Range["A1:A3"].Replace(oldValue, newValue, ExcelFindOptions.MatchCase); + string fileName = "Replace.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Replaces the string with the specified double value. + + The string to be replaced. + The double value to replace all occurrences of oldValue. + The following code snippet illustrates how to replace the string value with double. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:A3"].Value = "Ten"; + string oldValue = "Ten"; + sheet.Range["A1:A3"].Replace(oldValue,10.0); + string fileName = "Replace.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Replaces the string with the specified DateTime value. + + The string to be replaced. + The datetime value to replace all occurrences of oldValue. + The following code illustrates how to replace the string value with datetime. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:A3"].Value = "Find"; + string oldValue = "Find"; + DateTime dateTime = DateTime.Now; + sheet.Range["A1:A3"].Replace(oldValue,dateTime); + string fileName = "Replace.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Replaces the string with the specified array of string values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + The following code snippet illustrates how to replace the string with array of string values. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Value = "Find"; + string oldValue = "Find"; + string[] newValues = { "X values", "Y values" }; + sheet.Range["A1:A3"].Replace(oldValue, newValues, true); + string fileName = "Replace.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Replaces the string with the specified array of int values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + The following code snippet illustrates how to replace the string with array of int values. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Value = "Find"; + string oldValue = "Find"; + int[] newValues = { 1, 2 }; + sheet.Range["A1:A3"].Replace(oldValue, newValues, true); + string fileName = "Replace.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Replaces the string with the specified array of double values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + The following code snippet illustrates how to replace the string with array of double values. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Value = "Find"; + string oldValue = "Find"; + double[] newValues = { 1.00, 3.00 }; + sheet.Range["A1:A3"].Replace(oldValue, newValues, true); + string fileName = "Replace.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Replaces the string with the specified datatable. + + The string to be replaced. + Data table with new data. + Indicates whether field name must be shown. + The following code snippet illustrates how to replace the string value with data table. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Value = "AB2"; + //Create the data table + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("Dosage", typeof(int)); + table.Rows.Add(1); + // Replace the value with data table. + sheet.Range["A1:A3"].Replace("AB2", table, true); + string fileName = "Replace.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Replaces the string with the specified datacolumn. + + The string to be replaced. + DataColumn with new data. + Indicates whether field name must be shown. + + The following code snippet illustrates how to replace the string value with data column. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Value = "AB2"; + //Create the data table + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("Dosage", typeof(int)); + table.Rows.Add(1); + System.Data.DataColumn dataColumn = table.Columns[0]; + // Replace the value with data column. + sheet.Range["A1:A3"].Replace("AB2", dataColumn, true); + string fileName = "Replace.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Applies border around the Range. The default line style is . + + + The following code illustrates how to apply border around the Range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["D2"].Text = "text"; + worksheet["C3"].Text = "in"; + worksheet["D3"].Text = "cell"; + + //Set border + worksheet["C2:D3"].BorderAround(); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Applies border around the Range with the specified . + + Represents border line style. + + The following code illustrates how to apply border around the Range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["D2"].Text = "text"; + worksheet["C3"].Text = "in"; + worksheet["D3"].Text = "cell"; + + //Set border + worksheet["C2:D3"].BorderAround(ExcelLineStyle.Thick); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Applies border around the Range with the specified and . + + Represents border line style. + Represents border color. + + The following code illustrates how to apply border around the Range with color from structure. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["D2"].Text = "text"; + worksheet["C3"].Text = "in"; + worksheet["D3"].Text = "cell"; + + //Set border + worksheet["C2:D3"].BorderAround(ExcelLineStyle.Thick, System.Drawing.Color.Red); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Applies border around the Range with the specified and . + + Represents border line style. + Represents border color. + + The following code illustrates how to apply border around the Range with . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["D2"].Text = "text"; + worksheet["C3"].Text = "in"; + worksheet["D3"].Text = "cell"; + + //Set border + worksheet["C2:D3"].BorderAround(ExcelLineStyle.Thick, ExcelKnownColors.Red); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Applies border inside the Range. The default line style is . + + + The following code illustrates how to apply border inside the Range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["D2"].Text = "text"; + worksheet["C3"].Text = "in"; + worksheet["D3"].Text = "cell"; + + //Set border + worksheet["C2:D3"].BorderInside(); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Applies border inside the Range with the specified . + + Represents border line style. + + The following code illustrates how to apply border inside the Range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["D2"].Text = "text"; + worksheet["C3"].Text = "in"; + worksheet["D3"].Text = "cell"; + + //Set border + worksheet["C2:D3"].BorderInside(ExcelLineStyle.Thick); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Applies border inside the Range with the specified and . + + Represents border line style. + Represents border color. + + The following code illustrates how to apply border inside the Range with color from structure. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["D2"].Text = "text"; + worksheet["C3"].Text = "in"; + worksheet["D3"].Text = "cell"; + + //Set border + worksheet["C2:D3"].BorderInside(ExcelLineStyle.Thick, System.Drawing.Color.Red); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Applies border inside the Range with the specified and . + + Represents border line style. + Represents border color. + + The following code illustrates how to apply border around the Range with ExcelKnownColors. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["D2"].Text = "text"; + worksheet["C3"].Text = "in"; + worksheet["D3"].Text = "cell"; + + //Set border + worksheet["C2:D3"].BorderInside(ExcelLineStyle.Thick, ExcelKnownColors.Red); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Applies no border in the Range. + + + The following code illustrates how to remove borders in the Range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Set borders + IBorders borders = worksheet["C2"].Borders; + + //Set border color + borders[ExcelBordersIndex.EdgeTop].Color = ExcelKnownColors.Red; + borders[ExcelBordersIndex.EdgeBottom].Color = ExcelKnownColors.Blue; + + //Set line style + borders[ExcelBordersIndex.EdgeTop].LineStyle = ExcelLineStyle.Thick; + borders[ExcelBordersIndex.EdgeBottom].LineStyle = ExcelLineStyle.Thick; + + //Remove borders + worksheet["C2"].BorderNone(); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Collapses the group by rows/columns. + + + Represents to collapse the group by rows/columns. + + + The following code illustrates how to collapse the group in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Collapse group + worksheet.Range["A5:A15"].CollapseGroup(ExcelGroupBy.ByRows); + + workbook.SaveAs("CollapseGroup.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Expands the group by rows/columns. + + Represents to expand the group by rows/columns. + + The following code illustrates how to expand the group in the Range. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Expand group with flag set to expand parent + worksheet.Range["A5:A15"].ExpandGroup(ExcelGroupBy.ByRows); + + workbook.SaveAs("ExpandGroup.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + + Expands the group by row/column with collapse option. + + + Represents to expand the group by rows/columns. + + Represent the collapses options. + + The following code illustrates how to perform ExpandGroup in the Range with collapse option. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Expand group with flag set to expand parent + worksheet.Range["A5:A15"].ExpandGroup(ExcelGroupBy.ByRows, ExpandCollapseFlags.ExpandParent); + + workbook.SaveAs("ExpandGroup.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + + Gets the dependent cells which refer to other cells. + + Returns the dependent cells or null if value was not found. + The following code illustrates how to get the dependent cells from the worksheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetDependents(); + + string fileName = "Dependents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the dependent cells which refer to other cells. + + Indicates whether to check from other worksheets. + Returns the dependent cells with a specified bool value or null if value was not found. + The following code illustrates how to get the dependents cells from all the worksheets. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetDependents(true); + + string fileName = "Dependents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the direct dependent cells which refer to other cells. + + Returns the direct dependent cells or null if value was not found. + The following code illustrates how to get the direct dependent cells from the worksheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetDirectDependents(); + + string fileName = "Dependents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the direct dependent cells which refer to other cells. + + Indicates whether to check from other worksheets. + Returns the direct dependent cells with a specified bool value or null if value was not found. + The following code illustrates how to get the direct dependents cells from all the worksheets. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetDirectDependents(true); + + string fileName = "Dependents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the precedent cells which are referred by a formula in another cell. + + Returns the precedent cells or null if value was not found. + The following code illustrates how to get the precedent cells from the worksheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetPrecedents(); + + string fileName = "Precedents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the precedent cells which are referred by a formula in another cell. + + Indicates whether to check from other worksheets. + Returns the precedent cells with a specified bool value or null if value was not found. + The following code illustrates how to get the precedent cells from all the worksheets. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetPrecedents(true); + + string fileName = "Precedents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the direct precedent cells which are referred by a formula in another cell. + + Returns the direct precedent cells or null if value was not found. + The following code illustrates how to get the direct precedent cells from the worksheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetPrecedents(); + + string fileName = "Precedents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the direct precedent cells which are referred by a formula in another cell. + + Indicates whether to check from other worksheets. + Returns the direct precedent cells with a specified bool value or null if value was not found. + The following code illustrates how to get the direct precedent cells from all the worksheets. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetPrecedents(true); + + string fileName = "Precedents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns an object that represents a range or cell that is offset from the specified range or cell. + + The number of rows (positive, negative, or 0 (zero)) by which the range is to be offset + + The number of columns (positive, negative, or 0 (zero)) by which the range is to be offset + + + Use the Offset method to access the cell range of the same size as the current range which is shifted by the specified number of rows and columns. + + Returns a range which is shifted by the specified number of rows and columns. + + + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = engine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + IRange range = worksheet.Range[5,6]; + var offset = range.Offset(-3,-1); + var address2 = offset.AddressLocal; + workbook.SaveAs("output.xlsx"); + } + + + + + + Resizes the specified range a object that represents the resized range. + + The number of rows in the new range. + The number of columns in the new range. + + Use the Resize method to change the size of range by specified rows and columns from the current range. + + Returns the resized range. + + + + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = engine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + IRange range = worksheet.Range[5,6]; + var resize = range.Resize(1000,2000); + var address = resize.AddressLocal; + workbook.SaveAs("output.xlsx"); + } + + + + + + Creates a threaded comment for the current cell with the specified text. + + Threaded comment text + Optional. The creation time of the threaded comment + Returns the created instance of . If the cell already contains comment(note) then threaded comment cannot be inserted and returns null + + The threaded comment created by mapping with author name from built-in document properties + + + The following code illustrates how to add threaded comment with text. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add threaded comment with text + IThreadedComment threadedComment = worksheet["C2"].AddThreadedComment("sample text"); + + //Add threaded comment with text and creation time + DateTime date = new DateTime(2020, 11, 22, 2, 22, 23); + IThreadedComment threadedComment = worksheet["C1"].AddThreadedComment("Text", date); + + //Save and dispose + workbook.SaveAs("ThreadedComments.xlsx"); + workbook.Close(); + } + + + + + + Creates a threaded comment for the current cell with the specified text and author. + + Threaded comment text + The author of the threaded comment text + Optional. The creation time of the threaded comment + Returns the created instance of . If the cell already contains comment(note) then threaded comment cannot be inserted and returns null + + The following code illustrates how to add threaded comment with text and author. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add threaded comment with text and author + IThreadedComment threadedComment = worksheet["C2"].AddThreadedComment("sample text", "User"); + + //Add threaded comment with text, author and creation time + DateTime date = new DateTime(2020, 11, 22, 2, 22, 23); + IThreadedComment threadedComment = worksheet["C1"].AddThreadedComment("Text", "User", date); + + //Save and dispose + workbook.SaveAs("ThreadedComments.xlsx"); + workbook.Close(); + } + + + + + + Gets the Range reference in macro language. Read-only. + + + The following code illustrates how to access Address property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + string address = sheet.Range[3, 4].Address; + + workbook.SaveAs("Address.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the Range reference in language of the user. Read-only. + + + The following code illustrates how to access AddressLocal property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + string address = sheet.Range[1, 2].AddressLocal; + + workbook.SaveAs("AddressLocal.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the Range reference along with its sheet name in format "'Sheet1'!$A$1". Read-only. + + + The following code illustrates how to access AddressGlobal property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[2]; + string address = sheet.Range[4, 3].AddressGlobal; + + workbook.SaveAs("AddressGlobal.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the Range reference along with sheet name using R1C1-style notation. Read-only. + + + The following code illustrates how to access AddressR1C1 property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + string address = sheet.Range[1, 1].AddressR1C1; + + workbook.SaveAs("AddressR1C1.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the Range reference using R1C1-style notation. Read-only. + + + The following code illustrates how to access AddressR1C1Local property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + string address = sheet.Range[1, 1].AddressR1C1Local; + + workbook.SaveAs("AddressR1C1Local.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets or sets boolean value in the Range. + + + The following code illustrates how to set and access Boolean property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range[2, 4].Boolean = true; + bool boolean = sheet.Range[2, 4].Boolean; + + workbook.SaveAs("Boolean.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets a collection that represents the borders of a style + in the Range. Read-only. + + Borders including a Range defined as part of a + conditional format will be returned. + + The following code illustrates how to access Borders property of the Range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Set borders + IBorders borders = worksheet["C2"].Borders; + + //Set border color + borders[ExcelBordersIndex.EdgeTop].Color = ExcelKnownColors.Red; + borders[ExcelBordersIndex.EdgeBottom].Color = ExcelKnownColors.Blue; + + //Set line style + borders[ExcelBordersIndex.EdgeTop].LineStyle = ExcelLineStyle.Thick; + borders[ExcelBordersIndex.EdgeBottom].LineStyle = ExcelLineStyle.Thick; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets a object that represents the cells in the Range. Read-only. + + + The following code illustrates how to access Cells property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + IRange[] cells = sheet["A1:E8"].Cells; + foreach (IRange Range in cells) + { + // Do some manipulations + } + + workbook.SaveAs("Cells.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the column index of the first column in the Range which is a one based index. Read-only. + + + The following code illustrates how to access Column property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + int firstColumn = sheet["E1:R3"].Column; + + workbook.SaveAs("Column.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets column group level of the Range. Read-only. + + + -1 - not all column in the Range have same group level. + 0 - No grouping, + 1 - 7 - group level. + + + + + Gets or sets the width of all columns in the specified range, measured in points. + + + Gets Double.MinValue if the rows in the specified Range + aren't all the same width. + + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["A1"].Text = "This cell contains sample text"; + + //Set column width + worksheet["A1"].ColumnWidth = 25; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets the number of cells in the Range. Read-only. + + + + + Gets or sets DateTime value in the Range. + + + Gets DateTime.MinValue if not all cells in the Range have same DateTime value. + + + The following code illustrates how to set and access DateTime property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range[2, 4].DateTime = DateTime.Now; + DateTime dateTime = sheet.Range[2, 4].DateTime; + + workbook.SaveAs("DateTime.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets cell value with its number format. Read-only. + + While accessing DisplayText for Range of cells, it gets DisplayText of the first cell + If a range contains a formula, must be invoked to get the calculated value of the formula + + + The following code illustrates how to access DisplayText property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + IRange range= sheet.Range[3, 1]; + range.Value = "1/1/2015"; + range.NumberFormat = "dd-MMM-yyyy"; + string displayText = range.DisplayText; + + workbook.SaveAs("DisplayText.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets a object that represents the cell at the end of the Range. + + + + + Gets a object that represents the entire column (or + columns) in the Range. Read-only. + + + + + Gets a object that represents the entire row (or + rows) in the Range. Read-only. + + + + + Gets or sets error value in the Range. + + + + + Gets or sets the formula in A1-style notation and in + macro language for the Range. + + + + + Gets or sets sets the array formula of a range which can perform multiple calculations on one or more of the items in an array. + + + The following code illustrates how to set and access FormulaArray property of the range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Assign array formula + sheet.Range["A1:D1"].FormulaArray = "{1,2,3,4}"; + + //Adding a named range for the range A1 to D1 + sheet.Names.Add("ArrayRange", sheet.Range["A1:D1"]); + + //Assign formula array with named range + sheet.Range["A2:D2"].FormulaArray = "ArrayRange+100"; + + string fileName = "FormulaArray.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets or sets the formula array for the Range, using R1C1-style notation. + + + + + Gets or sets a Boolean value indicating whether the formula will be hidden when the worksheet is protected. + + + True if the formula will be hidden when the worksheet is protected. + False if at least part of formula in the Range is not hidden. + + + + + Gets or sets formula DateTime value in the Range. + + + Gets DateTime.MinValue if not all cells in the Range have same FormulaDateTime value. + + + + + Gets or sets the formula for the Range, using R1C1-style notation. + + + + + Gets or sets the calculated value of the formula as a boolean. + + + + + Gets or sets the error value of the formula as a string. + + + + + Gets a Boolean value indicating whether Range has data validation. Read-only. + + If Range is not single cell, then gets true only if all cells have data validation. + + + + Gets a Boolean value indicating whether Range contains bool value. Read-only. + + + The following code illustrates how to set and access HasBoolean property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + + //Assigning Value2 property of the Range + sheet["A3"].Value2 = false; + + // Checking Range types. + bool isboolean = sheet["A3"].HasBoolean; + + workbook.SaveAs("HasBoolean.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets a Boolean value indicating whether Range contains DateTime value. Read-only. + + + The following code illustrates how to set and access HasDateTime property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + + //Assigning Value2 property of the Range + sheet["A1"].Value2 = DateTime.Now; + + // Checking Range types. + bool isDateTime = sheet["A1"].HasDateTime; + + workbook.SaveAs("HasDateTime.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets a Boolean value indicating whether Range contains formula. Read-only. + + True if all cells in the Range contain formulas; False if + at least one of the cells in the Range doesn't contain a formula. + + + + + Gets a Boolean value indicating whether Range contains array-entered formula. Read-only. + + + + + Gets a Boolean value indicating whether Range contains number. Read-only. + + + The following code illustrates how to set and access Value2 property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + + //Assigning Value2 property of the Range + sheet["A2"].Value2 = 45; + + // Checking Range types. + bool isNumber = sheet["A2"].HasNumber; + + workbook.SaveAs("HasNumber.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets a Boolean value indicating whether cell contains formatted rich text string. + + + The following code illustrates how to access HasRichText property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set rich text + IRichTextString richText = worksheet["C2"].RichText; + + //Set text + richText.Text = "Sample"; + + //Set font + IFont font = style.Font; + + //Set color + font.Color = ExcelKnownColors.Red; + + //Set rich text font + richText.SetFont(0, 5, font); + + //Check HasRichText + Console.Write(worksheet["C2"].HasRichText); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + + + + + + Gets a Boolean value indicating whether Range contains string. Read-only. + + + + + Gets a Boolean value indicating whether Range has default style. False means default style. + Read-only. + + + The following code illustrates how to access HasStyle property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set color + style.ColorIndex = ExcelKnownColors.Red; + + //Set style + worksheet["C2"].CellStyle = style; + + //Check HasStyle + Console.Write(worksheet["C2"].HasStyle); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + + + + + + Gets or sets the horizontal alignment for the specified object. + + + By default is set to cells. Here for example, we set to align the + cell contents to right. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["A1"].Text = "Test"; + + //Set alignment + worksheet["A1"].HorizontalAlignment = ExcelHAlign.HAlignRight; + + //Set row height + worksheet["A1"].RowHeight = 30; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets hyperlinks in the Range. Read-only. + + + The following code illustrates how to access Borders property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + + // Creating a Hyperlink for a Website. + IHyperLink hyperlink = sheet.HyperLinks.Add(sheet.Range["C5"]); + hyperlink.Type = ExcelHyperLinkType.Url; + hyperlink.Address = "http://www.syncfusion.com"; + hyperlink.ScreenTip = "To know more About SYNCFUSION PRODUCTS go through this link"; + + workbook.SaveAs("Hyperlinks.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets or sets the indent level for cell or Range. + + It can be from 0 to 15 for Excel 97-2003 and 250 for Excel 2007-2013. + + The following code illustrates how to set indent level for a . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Set indent level + worksheet["C2"].IndentLevel = 2; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets a Boolean value indicating whether the Range is blank. Read-only. + + + + + Gets a Boolean value indicating whether cell type is boolean. Read-only. + + + + + Gets a Boolean value indicating whether Range contains error value. Read-only. + + + + + Gets a Boolean value indicating whether Range is grouped by column. Read-only. + + + + + Gets a Boolean value indicating whether Range is grouped by row. Read-only. + + + + + Gets a Boolean value indicating whether cell is initialized. Read-only. + + + + + Gets the column index of the last column in the Range which is a one based index. Read-only. + + + + + Gets the row index of the last row in the Range which is a one based index. Read-only. + + + + + Gets or sets number value that is contained by Range. + + + When Range value is not a number. + + + + + Gets or sets format of cell which is similar to Style.NumberFormat property. + + + Gets NULL if all cells in the specified Range don't have the same number format. + + + The following code illustrates how to set NumberFormat property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["C2"].Value = "3100.23"; + + //Set number format + worksheet["C2"].NumberFormat = "#,##0.##"; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets the row index of the first row in the Range which is a one based index. Read-only. + + + + + Gets row group level. Read-only. + + + -1 - Not all rows in the Range have same group level. + 0 - No grouping, + 1 - 7 - Group level. + + + + + Gets or sets the height of all the rows in the range, measured in points. + + + Gets Double.MinValue if the rows in the specified Range aren't all the same height. Maximum Row height can be 409 + value, minimum is zero. + + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["A1"].Text = "Test"; + + //Set alignment + worksheet["A1"].VerticalAlignment = ExcelVAlign.VAlignTop; + + //Set row height + worksheet["A1"].RowHeight = 30; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets an array of objects that represent the rows in the Range. Read only. + + + The following code illustrates how to access Columns property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + IRange[] rows = sheet["A1:E8"].Rows; + foreach (IRange row in rows) + { + // Do some manipulations + } + + workbook.SaveAs("Rows.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets an array of objects that represent the columns in the Range. + Read only. + + + The following code illustrates how to access Columns property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + IRange[] columns = sheet["A1:E8"].Columns; + foreach (IRange column in columns) + { + // Do some manipulations + } + + workbook.SaveAs("Columns.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets a object that represents the style of the + Range. + + + To know more about setting styles refer Set Default Style for row/column. + + + The following code illustrates how to access using CellStyle property of the Range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("BorderStyle"); + + //Set color + style.ColorIndex = ExcelKnownColors.Red; + + //Set style + worksheet["C2"].CellStyle = style; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets name of the object that represents style of the + Range. + + + The following code illustrates how to access CellStyleName property of the Range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set color + style.ColorIndex = ExcelKnownColors.Red; + + //Set style + worksheet["C2"].CellStyle = style; + + //Check Style name + Console.Write(worksheet["C2"].CellStyleName); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //CustomStyle + + + + + + Gets or sets string value of the Range. + + + + + Gets or sets time value of the Range. + + + + + Gets or sets the value of the Range. Does not support FormulaArray value. + + + + Sets different data types values as a string, + Value property parses the input string to determine its type which leads performance delay. + + + The only difference between the Value2 property and the Value property + is that the Value2 property does not use the Currency and Date data types. + Also, it does not support FormulaArray value. + + + + The following code illustrates how to set and access Value property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + IRange range= sheet.Range[3, 1]; + range.Value = "1/1/2015"; + range.NumberFormat = "dd-MMM-yyyy"; + string displayText = range.DisplayText; + + workbook.SaveAs("Value.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the calculated value of a formula in the Range. Read-only. + + To compute a formula, it is mandatory to enable calculate engine by + invoking EnableSheetCalculations method of worksheet object. It is also recommend to disable + calculate engine once all formula are computed by invoking DisableSheetCalculations method of worksheet object + + Following code illustrates how to access a calculated value. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx", ExcelOpenType.Automatic); + IWorksheet sheet = workbook.Worksheets[0]; + + //Initializes Calculate Engine to perform calculation + sheet.EnableSheetCalculations(); + + //Returns the calculated value of a formula using the most current inputs + string calculatedValue = sheet["C1"].CalculatedValue; + //Formula calculation is disabled for the sheet. + sheet.DisableSheetCalculations(); + + workbook.SaveAs("Formula.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets or sets the cell value. + + + + Sets different data types values as a object. + Value2 first checks whether the specified object has the type known for it (DateTime, TimeSpan, Double, Int). + If yes, then it uses the corresponding typed properties (DateTime, TimeSpan, and Number). + Otherwise, it calls Value property with String data type. + + + The only difference between the Value2 property and the Value property + is that the Value2 property does not use the Currency and Date data types. + Also, it does not support FormulaArray value. + + + + The following code illustrates how to set and access Value2 property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + + //Assigning Value2 property of the Range + sheet["A1"].Value2 = DateTime.Now; + sheet["A2"].Value2 = 45; + sheet["A3"].Value2 = false; + + // Checking Range types. + bool isDateTime = sheet["A1"].HasDateTime; + bool isNumber = sheet["A2"].HasNumber; + bool isboolean = sheet["A3"].HasBoolean; + + workbook.SaveAs("Value2.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets or sets the vertical alignment of the Range. + + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["A1"].Text = "Test"; + + //Set alignment + worksheet["A1"].VerticalAlignment = ExcelVAlign.VAlignTop; + + //Set row height + worksheet["A1"].RowHeight = 30; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets the object in which belongs to the Range. Read-only. + + + + + Gets or sets cell range by row and column index. Row and column indexes are one-based. + + + + + Get cell Range. Row and column indexes are one-based. Read-only. + + + + + Gets cell Range. Read-only. + + + + + Gets cell Range with R1C1Notation flag. Read-only. + + + + + Gets the collection of conditional formats in the Range. + Read-only. + + + The following code illustrates how to set and access Value2 property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + // Applying conditional formatting to "A1" + IConditionalFormats condition = sheet.Range["A2"].ConditionalFormats; + IConditionalFormat condition1 = condition.AddCondition(); + + // Represents conditional format rule that the value in target Range should be between 10 and 20 + condition1.FormatType = ExcelCFType.CellValue; + condition1.Operator = ExcelComparisonOperator.Between; + condition1.FirstFormula = "10"; + condition1.SecondFormula = "20"; + sheet.Range["A1"].Text = "Enter a number between 10 and 20"; + + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + Gets a object that represents the data validation associated with the cell. Read-only. + + + The following code illustrates how to access DataValidation property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + + //Data validation for number + IDataValidation validation = sheet.Range["A3"].DataValidation; + validation.AllowType = ExcelDataType.Integer; + + //Value between 0 to 10 + validation.CompareOperator = ExcelDataValidationComparisonOperator.Between; + validation.FirstFormula = "0"; + validation.SecondFormula = "10"; + + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets or sets string value evaluated by formula. + + + + + Gets or sets number value evaluated by formula. + + + + + Gets a Boolean value indicating whether Range has formula bool value. Read-only. + + + + + Gets a Boolean value indicating whether Range has formula error value. Read-only. + + + + + Gets a Boolean value indicating whether Range has formula value formatted as DateTime. Read-only. + + + + + Gets a Boolean value indicating whether Range has formula number value. Read-only. + + + + + Gets a Boolean value indicating whether Range has formula string value. Read-only. + + + + + Gets a object that represents the comment associated with the range. Read-only. + + + The following code illustrates how to insert Comments property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + // Adding comments to a cell. + sheet.Range["A1"].AddComment().Text = "Comments"; + + // Add Rich Text Comments. + IRange range = sheet.Range["A6"]; + range.AddComment().RichText.Text = "RichText"; + IRichTextString rtf = range.Comment.RichText; + + // Formatting first 4 characters. + IFont redFont = workbook.CreateFont(); + redFont.Bold = true; + redFont.Color = ExcelKnownColors.Red; + rtf.SetFont(0, 3, redFont); + + workbook.SaveAs("Comments.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the threaded comment associated with the cell. + + The object + + The following code illustrates how to access ThreadedComment property of IRange + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Access threaded comment from IRange + IThreadedComment threadedComment = worksheet["C2"].ThreadedComment; + + if(threadedComment != null) + string text = threadedComment.Text; + + //Save and dispose + workbook.SaveAs("ThreadedComments.xlsx"); + workbook.Close(); + } + + + + + + Gets string with rich text formatting in the Range. Read-only. + + + The following code illustrates how to set rich text formatting in the range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set rich text + IRichTextString richText = worksheet["C2"].RichText; + + //Set text + richText.Text = "Sample text"; + + //Set font + IFont font = style.Font; + + //Set color + font.Color = ExcelKnownColors.Red; + + //Set rich text font + richText.SetFont(0, 5, font); + + //Set color + font.Color = ExcelKnownColors.Blue; + + //Set rich text font + richText.SetFont(6, 10, font); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets a Boolean value indicating whether Range is a part of merged Range. Read-only. + + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["A1"].Text = "Sample text in cell"; + + //Set merge + worksheet["A1:B1"].Merge(); + + //Check merge + Console.Write(worksheet["A1:B1"].IsMerged); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + + + + + + Gets a object that represents the merged Range to which the cell or Range belongs. Read-only. + + If the specified cell isn�t in a merged Range, this property gets NULL. + + The following code illustrates how to access MergeArea property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["D2"].Text = "text"; + worksheet["C3"].Text = "in"; + worksheet["D3"].Text = "cell"; + + //Merge + worksheet["C2:D3"].Merge(); + + //Check merge area + Console.Write(worksheet["C2"].MergeArea.AddressLocal); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //C2:D3 + + + + + + Gets or sets wrap text of the Range. + + While applying wraptext to rows/columns in Excel, autofit is done for rows/columns everytime when data is added. But in XlsIO, autofit of rows/columns are not done like Excel because of performance considerations. To achieve Excel behavior, the autofit can be invoked manually. + + The following code illustrates how to set WrapText property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["A1"].Text = "This cell contains sample text"; + + //Set wrap text + worksheet["A1"].WrapText = true; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets a Boolean value indicating whether Range has external formula. Read-only. + + + + + Gets or sets ignore error options for formula auditing. If not single cell gets concatenated flags. + + + + + Gets a Boolean value indicating whether all values in the Range are preserved as strings. + + + + + Gets or sets built in style in the Range. + + + The following code illustrates how to set BuiltInStyle to a range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Set built in style + worksheet["C2"].BuiltInStyle = BuiltInStyles.Accent3; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets HTML string. + + + + + Interface that contains method for to take native ptg. + + + + + Gets ptg of current range. + + Returns native ptg. + + + + Represents a combined Range. + + + + + Gets new address of range. + + Dictionary with Worksheet names. + String that sets as a worksheet name. + Returns string with new name. + + + + Clones current IRange. + + Parent object. + Dictionary with new names. + Parent workbook. + Returns clone of current instance. + + + + Clears conditional formats. + + + + + Returns array that contains information about range. + + Rectangles that describes range + + + + Returns number of rectangles returned by GetRectangles method. + + Number of rectangles returned by GetRectangles method. + + + + Number of cells in the range. Read-only. + + + + + Gets address global in the format required by Excel 2007. + + + + + Gets name of the parent worksheet. + + + + + Parent worksheet. + + + + + + + + + + + + + + + + + + + + Creates Subtotal for the corresponding ranges + + GroupBy + ConsolidationFunction + TotalList + + + + Creates SubTotal for the corresponding Ranges + + GroupByGroupBy + ConsolidationFunction + TotalList + Replace exisiting SubTotal + Insert PageBreaks + SummaryBelowData + + + + Creates SubTotal for the corresponding Ranges + + Columns to GroupBy + ConsolidationFunction + TotalList + Replace exisiting SubTotal + Insert PageBreaks + SummaryBelowData + + + + Returns sum of numeric cells in the range. + + + + + Returns sum of numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + + + Returns average of numeric cells in the range. + + + + + Returns average of numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + + + Returns minumum value from numeric cells in the range. + + + + + Returns minumum value from numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + + + Returns maximum value from numeric cells in the range. + + + + + Returns maximum value from numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + + + Trim the empty rows at top and bottom of the range, the empty columns at left and right of the range. + + Returns the range after trim. + + + + Copies the Range to the specified destination Range with copy options and skip blank option. + + Represents the destination Range to copy. + Represents the copy Range options. + Represents the skip blank cells in the source. + Returns the copied Range. + + + + Copies this range into another location using pasteLinkOptions. + + Destination range. + Check to implement the pasteLink option. + Method not implement error. + + + + Creates a threaded comment for the current cell with the specified text. + + Threaded comment text + Optional. The creation time of the threaded comment + Returns the created instance of . + + + + Creates a threaded comment for the current cell with the specified text and author. + + Threaded comment text + The author of the threaded comment text + Optional. The creation time of the threaded comment + Returns the created instance of . + + + + Replaces the string with the specified string value. + + The string to be replaced. + The string to replace all occurrences of oldValue. + + + + Replaces the string with the specified string value based on the given . + + The string to be replaced. + The string to replace all occurrences of oldValue. + Specifies the find options for the oldValue. + + + + Replaces the string with the specified double value. + + The string to be replaced. + The double value to replace all occurrences of oldValue. + + + + Replaces the string with the specified DateTime value. + + The string to be replaced. + The datetime value to replace all occurrences of oldValue. + + + + Replaces the string with the specified array of string values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces the string with the specified array of int values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces the string with the specified array of double values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces the string with the specified datatable. + + The string to be replaced. + Data table with new data. + Indicates whether field name must be shown. + + + + Replaces the string with the specified datacolumn. + + The string to be replaced. + DataColumn with new data. + Indicates whether field name must be shown. + + + + Gets the dependent cells which refer to other cells. + + Returns the dependent cells or null if value was not found. + + + + Gets the dependent cells which refer to other cells. + + Indicates whether to check from other worksheets. + Returns the dependent cells with a specified bool value or null if value was not found. + + + + Gets the precedent cells which are referred by a formula in another cell. + + Returns the precedent cells or null if value was not found. + + + + Gets the precedent cells which are referred by a formula in another cell. + + Indicates whether to check from other worksheets. + Returns the precedent cells with a specified bool value or null if value was not found. + + + + Gets the direct dependent cells which refer to other cells. + + Returns the direct dependent cells or null if value was not found. + + + + Gets the direct dependent cells which refer to other cells. + + Indicates whether to check from other worksheets. + Returns the direct dependent cells with a specified bool value or null if value was not found. + + + + Gets the direct precedent cells which are referred by a formula in another cell. + + Returns the direct precedent cells or null if value was not found. + + + + Gets the direct precedent cells which are referred by a formula in another cell. + + Indicates whether to check from other worksheets. + Returns the direct precedent cells with a specified bool value or null if value was not found. + + + + Returns a Range object that represents a range thats offset from the specified range. + + The number of rows (positive, negative, or 0 (zero)) by which the range is to be offset + The number of columns (positive, negative, or 0 (zero)) by which the range is to be offset + + + + + Resizes the specified range + + The number of rows in new range + The number of columns in new range + + + + + Initializes new instance of the class. + + Parent external worksheet. + First row. + First column. + + + + Initializes new instance of the class. + + Parent external worksheet. + First row. + First column. + Last row. + Last column. + + + + Returns an enumerator that iterates through the Range. + + + + + + Returns the calculated value of a formula using the most current inputs. + + + + + Get the threaded comment. + + + + + Gets address global in the format required by Excel 2007. + + + + + Gets name of the parent worksheet. + + + + + Gets or sets HTML string. + + + + + Gets or sets a value indicating whether this instance is num reference for chart axis. + + + true if this instance is num reference; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is a string reference for chart axis. + + + true if this instance is string reference; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is multi reference for chart axis. + + + true if this instance is multi reference; otherwise, false. + + + + + Get the conditional format formula values. + + Formula ptg array + Current worksheet + Formula + + + + + Check given tokens having forumula or not + + Formula ptg array + True, if given tokens is formula, false otherwise + + + + Represent the string value which are for LineStyle + + + + + + This class is responsible for shape id's reservation. + + + + + Size of the single id's segment. + + + + + Dictionary that contains information about reserved id's. + key - segment start + value - id of the collection that reserved current segment. + + + + + Dictionary that contains information about number of reserved id's. + key - segment start + value - number of reserved sectors. + + + + + Number of sectors (key) and first id (value) reserved by some collection. + + + + + Maximum reserved id. + + + + + Additional shapes. + + + + + Evaluates start of the segment containing specified id. + + Id to get segment start for. + + + + + Checks whether segment with specified it is already reserved. + + Id to check. + + + + + Checks whether segment with specified id is free. + + Id to check. + Number of segments to check. + True if all segments are free. + + + + Gets index of the collection which reserved specified id. + + Id to check. + Index of the collection which reserved id, or 0 if it is not reserved. + + + + Tries to reserve segment or segments containing specified ids for the specified collection. + + Start id to reserve. + Last id to reserve. + Collection owning those ids + True if reservation succeeded. + + + + Increases number of reserved shapes in the segment. + + Id that belongs to the segment to increase number for. + + + + Checks whether specified id range is reserved by specified shape collection. + + Start id to check. + End id to check. + Collection id to check. + True if all ids are reserved by the specified collection. + + + + Frees segment that contains specified id. + + Id used to detect segment start. + + + + Frees segments sequence if they belong to specified collection. + + Id to detect first segment. + Collection to free segments for. + + + + Frees all segments allocated by the collection. + + Collection id. + + + + Allocates specified number of segments. + + Ids count to allocate. + Collection id. + shapes. + Index to the first allocate id. + + + + Returns number of reserved ids by specified collection. + + Collection index. + Number of reserved ids. + + + + Gets number of reserved shapes inside specified sector. + + Id that belongs to the segment that is being investigated. + Number of reserved ids inside sector. + + + + Registers any number of additional shapes required by collection. + + Collection index. + Number of additional shapes to add. + + + + Gets number of additional shapes reserved by collection. + + Collection index. + Number of additional shapes. + + + + Gets maximum accessed shape id. + + + + + Abstract class which represents data structures. + + + + + Size of the File Character position. + + + + + Number of bytes in formatted disk page. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Reads the int16. + + The data array. + The offset. + + + + + Reads the int32. + + The data array. + The offset. + + + + + Reads the int64. + + The data array. + The offset. + + + + + Reads the int16. + + The data array. + The offset. + + + + + Reads the int32. + + The data array. + The offset. + + + + + Reads the array of bytes. + + The data array. + The length. + The offset. + + + + + Saves the specified int16 value in the data array. + + The arr data. + The offset. + + + + Saves the specified uint16 value in the data array. + + The arr data. + The offset. + + + + Saves the specified int32 value in the data array. + + The arr data. + The offset. + + + + Saves the specified int64 value in the data array. + + The destination. + The offset. + The value. + + + + Saves the specified uint32 value in the data array. + + The arr data. + The offset. + + + + Saves the bytes byte array. + + The destination array. + The offset. + The bytes. + + + + Gets the size of the structure. + + The length. + + + + Length of compObject stream + + + + + This MUST be a CompObjHeader structure. + + + + + This MUST be a LengthPrefixedAnsiString structure that contains a display + name of the linked object or embedded object + + + + + This MUST be a ClipboardFormatOrAnsiString structure that contains the + Clipboard Format of the linked object or embedded object. If the MarkerOrLength + field of the ClipboardFormatOrAnsiString structure contains a value other than + 0x00000000, 0xffffffff, or 0xfffffffe, the value MUST NOT be greater than 0x00000190. + Otherwise the CompObjStream structure is invalid + + + + + If present, this MUST be a LengthPrefixedAnsiString structure. If the Length field of + the LengthPrefixedAnsiString contains a value of 0 or a value that is greater than + 0x00000028, the remaining fields of the structure starting with the String field + of the LengthPrefixedAnsiString MUST be ignored on processing. + + + + + If this field is present and is NOT set to 0x71B239F4, + the remaining fields of the structure MUST be ignored on processing + + + + + This MUST be a LengthPrefixedUnicodeString structure that contains a display name + of the linked object or embedded object. + + + + + This MUST be a ClipboardFormatOrUnicodeString structure that contains a Clipboard + Format of the linked object or embedded object. If the MarkerOrLength field of the + ClipboardFormatOrUnicodeString structure contains a value other than 0x00000000, + 0xffffffff, or 0xfffffffe, the value MUST NOT be more than 0x00000190. Otherwise, + the CompObjStream structure is invalid + + + + + This MUST be a LengthPrefixedUnicodeString. The String field of the LengthPrefixedUnicodeString + can contain any arbitrary value and MUST be ignored on processing. + + + + + Initializes a new instance of the class. + + The comp stream. + + + + Initializes a default instance of the class. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Saves data to STG stream. + + The STG stream. + + + + Writes the zero byte array. + + The stream. + Length of the byte. + + + + Writes the length prefixed string. + + The stream. + The data. + + + + Gets the size of the structure. + + The length. + + + + Gets the type of the object. + + The type of the object. + + + + Gets the type of the object. + + The type of the object. + + + + + + + + + This can be set to any arbitrary value and MUST be ignored on processing. + + + + + This can be set to any arbitrary value and MUST be ignored on processing. + + + + + This can be set to any arbitrary value and MUST be ignored on processing. + + + + + Initializes a new instance of the class. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Saves to STG stream. + + The stream. + + + + Gets the size of the structure. + + The length. + + + + + + + + + + + + + + Initializes a new instance of the class. + + The comp stream. + + + + Initializes a default instance of the class. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Saves the data to stream. + + The STG stream. + + + + Gets the size of the structure. + + The length. + + + + Represents the Ole Object implementation + + + + + Represent the Ole object shapes. + + + + + Gets or sets the location. + + The location. + + The following code illustrates how to set the Location property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream + System.Drawing.Image image = System.Drawing.Image.FromFile("image.png"); + + //Add ole object + IOleObject oleObject = worksheet.OleObjects.Add("Shapes.xlsx", image, OleLinkType.Embed); + + //Set height and width + oleObject.Shape.Height = 150; + oleObject.Shape.Width = 150; + + //Set location + oleObject.Location = worksheet["C7"]; + + //Save and dispose + workbook.SaveAs("OLEObjects.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the size. + + The size. + + The following code illustrates how to access Size property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream + System.Drawing.Image image = System.Drawing.Image.FromFile("image.png"); + + //Add ole object + IOleObject oleObject = worksheet.OleObjects.Add("Shapes.xlsx", image, OleLinkType.Embed); + + //Get image size + Console.WriteLine(oleObject.Size.Height); + Console.WriteLine(oleObject.Size.Width); + + //Save and dispose + workbook.SaveAs("OLEObjects.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //{Prints given image's height} + //{Prints given image's width} + + + + + + Gets or sets the picture. + + The picture. + + The following code illustrates how to access Picture property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream + System.Drawing.Image image = System.Drawing.Image.FromFile("image.png"); + + //Add ole object + IOleObject oleObject = worksheet.OleObjects.Add("Shapes.xlsx", image, OleLinkType.Embed); + + //Get picture's height and width + Console.WriteLine(oleObject.Picture.Height); + Console.WriteLine(oleObject.Picture.Width); + + //Save and dispose + workbook.SaveAs("OLEObjects.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //{Given image's height} + //{Given image's width} + + + + + + Gets or sets picture shape object that defines look and position of the OleObject inside parent worksheet. + + + The following code illustrates how to set and of the by accessing Shapes property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream + System.Drawing.Image image = System.Drawing.Image.FromFile("image.png"); + + //Add ole object + IOleObject oleObject = worksheet.OleObjects.Add("Shapes.xlsx", image, OleLinkType.Embed); + + //Set height and width + oleObject.Shape.HeightDouble = 150; + oleObject.Shape.WidthDouble = 150; + + //Save and dispose + workbook.SaveAs("OLEObjects.xlsx"); + workbook.Close(); + } + + + + + + Gets the name of an OLE object. + + + The following code illustrates how to access Name property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream + System.Drawing.Image image = System.Drawing.Image.FromFile("image.png"); + + //Add ole object + IOleObject oleObject = worksheet.OleObjects.Add("Shapes.xlsx", image, OleLinkType.Embed); + + //Get name + Console.WriteLine(oleObject.Name); + + //Save and dispose + workbook.SaveAs("OLEObjects.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //Picture0 + + + + + + Gets or sets a value indicating whether [display as icon]. + + true if [display as icon]; otherwise, false. + + The following code illustrates how to set DisplayAsIcon property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream + System.Drawing.Image image = System.Drawing.Image.FromFile("image.png"); + + //Add ole object + IOleObject oleObject = worksheet.OleObjects.Add("Shapes.xlsx", image, OleLinkType.Embed); + + //Set display as icon + oleObject.DisplayAsIcon = true; + + //Save and dispose + workbook.SaveAs("OLEObjects.xlsx"); + workbook.Close(); + } + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + byte array represents the native data + + + + + byte array represents the file + + + + + compound object stream used to store the ole object data + + + + + Ole stream used to store ole object data + + + + + Object info stream used to store the ole object information + + + + + Dictionary collection used to store the location + + + + + boolean value indicates whether the oleobject is contains the stream + + + + + Stream used tp store the ole object streams + + + + + size value used to set the size of ole object icon + + + + + Boolean value indicates whether the icon is enabled or not. + + + + + Enum value represents the OleObject display behavior + + + + + Ole Object shape + + + + + stores the ole object shape id + + + + + Store the ole object fall back shape id + + + + + Store the default size value. + + + + + Store the move with cell value. + + + + + Store the size with cells value. + + + + + Store the object pr relation id. + + + + + the ole object type + + + + + Boolean value indicates whether the oleobject is stored in a stream + + + + + the parent worksheet object + + + + + Excel 2007 content type. + + + + + Excel 2007 relation type. + + + + + The ole object type about the embedded data + + + + + Ole object storage name + + + + + ole object type about the embedded data in string + + + + + ole object ole file name + + + + + ole object file name + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + file Path to be linked + The parent worksheet. + Type of the OLE link. + + + + Initializes a new instance of the class. + + Name of the file. + The image. + + + + Initializes a new instance of the class. + + Name of the file. + The image. + Type of the OLE link. + + + + Creates the Ole object + + + + + + + + OLEs from file. + + Name of the file. + The image. + + + + + OLEs from stream. + + The stream. + The image. + The extension. + + + + + Initializes a new instance of the class. + + The stream. + The image. + The extension. + + + + Gets the name of the stream file. + + The read value. + The extension. + + + + + Sets the file. + + Name of the file. + + + + + Extracts the OLE data. + + Name of the file. + + + + Copies the stream. + + The input. + The output. + + + + Checks the name of the file. + + Name of the file. + + + + Sets the OLE file. + + Name of the file. + Name of the storage. + + + + Sets the OLE file. + + Name of the file. + Name of the storage. + The file bytes. + + + + Creates the OLE obj container. + + The file path. + Name of the olestorage. + + + + Saves the specified object pool. + + The object pool. + The data path. + Name of the storage. + + + + + Creates the or get obj pool. + + The name. + + + + + Writes the OLE stream. + + The root STG. + The data path. + + + + Writes the obj info stream. + + The root STG. + + + + Gets the OLE container. + + + + + + Writes the comp obj stream. + + The root STG. + + + + Writes the package. + + The root STG. + The data path. + + + + Contains the stream. + + The stream names. + The name. + + + + + Gets index of external workbook referenced by this ole object. + + + + + + Gets and sets the fall back shapeId. + + + + + Gets and sets the default size value. + + + + + Gets and sets the move with cells value. + + + + + Gets and sets size with cell value. + + + + + Gets and sets the objectPr relation id + + + + + Gets or sets the location. + + The location. + + + + Gets or sets the size. + + The size. + + + + Gets or sets the picture. + + The picture. + + + + Gets or sets a value indicating whether [display as icon]. + + true if [display as icon]; otherwise, false. + + + + Gets or sets the type of the OLE. + + The type of the OLE. + + + + Gets or sets a value indicating whether this instance is stream. + + true if this instance is stream; otherwise, false. + + + + Gets or sets the index of the OLE sheet. + + The index of the OLE sheet. + + + + Gets or sets a value indicating whether this instance is container. + + + true if this instance is container; otherwise, false. + + + + + Gets or sets the container. + + The container. + + + + Gets or sets the file native data. + + The file native data. + + + + Gets or sets the type of the object. + + The type of the object. + + + + Gets the locate. + + The locate. + + + + Gets or sets the name of the file. + + The name of the file. + + + + Gets or sets the name of the storage. + + The name of the storage. + + + + Gets or sets the type of the OLE object. + + The type of the OLE object. + + + + Gets or sets the dv aspect. + + The dv aspect. + + + + Gets or sets the shape ID. + + The shape ID. + + + + Gets or sets the shape R id. + + The shape R id. + + + + Gets shape associated with this ole object. + + + + + Gets the name of an OLE object. + + + + + Gets or sets xlsx content type. + + + + + Gets or sets xlsx relation type. + + + + + Used to preserve OleObjects for add copy method + + + + + Set the Ole storage name + + + + + + Ole Storage name + + + + + Ole Storage Streams + + + + + Get the Ole storage stream names + + + + + Represents the Ole objects implementation + + + + + Represents the Ole objects shape collections. + + + + + Adds new ole object to the collection. + + File name. + File image. + Link type. + Returns a Ole object + + This method is not supported in UWP, ASP.NET Core and Xamarin. + + + The following code illustrates how to add an to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream + System.Drawing.Image image = System.Drawing.Image.FromFile("image.png"); + + //Add ole object + IOleObject oleObject = worksheet.OleObjects.Add("Shapes.xlsx", image, OleLinkType.Embed); + + //Save and dispose + workbook.SaveAs("OLEObjects.xlsx"); + workbook.Close(); + } + + + + + + Store the Requries value in choice. + + + + + Parent worksheet. + + + + + Initializes new instance of the collection. + + Parent worksheet. + + + + Adds the specified OLE. + + The OLE. + + + + Adds new ole object to the collection. + + File name. + File image. + Link type. + + + + Sets the OLE object. + + The OLE. + + + + Gets and sets the requries value + + + + + Class performs converting string to OleObjectType enum and vice versa. + + + + + Converts the string to "OleObjectType" + + The OLE type STR. + + + + + Converts the string to "OleObjectType" + + The OLE type STR. + + + + + Gets the GUID for specified type of object. + + The type. + + + + + Gets the GUID for specified type of object. + + The type. + + + + + Gets the name of the OLE file. + + + + + + Gets the next file id. + + + + + + Adds the specified file name. + + Name of the file. + + + + Used to preserve OleObjects for add copy method + + + + + Collection of Ole storage + + + + + List of the names of Ole storages + + + + + List of the stream names of Ole Storages + + + + + + + + + + + + + + + + + + + + This MUST be set to 0x00000001 or 0x00000002. If this field has a value of 1, the OLEStream + structure MUST be for a linked object. If this field has a value of 0, then the OLEStream + structure MUST be for an embedded object. + + + + + This field contains an implementation-specific hint supplied by the application or by a + higher-level protocol that creates the data structure. The hint MAY be ignored on + processing of this data structure. + + + + + This MUST be set to 0x00000000. Otherwise, the OLEStream structure is invalid. + + + + + This MUST be set to the size, in bytes, of the ReservedMonikerStream field. + If this field has a value 0x00000000, the ReservedMonikerStream field MUST NOT be present. + + + + + This MUST be a MONIKERSTREAM structure that can contain any arbitrary value + and MUST be ignored on processing. + + + + + This MUST be set to the size, in bytes, of the RelativeSourceMonikerStream field. + If this field has a value 0x00000000, the RelativeSourceMonikerStream field MUST NOT be present. + + + + + This MUST be a MONIKERSTREAM structure that specifies the relative path to the linked object. + + + + + This MUST be set to the size, in bytes, of the AbsoluteSourceMonikerStream field. + This field MUST NOT contain the value 0x00000000. + + + + + This MUST be a MONIKERSTREAM structure that specifies the full path to the linked object. + + + + + This MUST be the LONG value -1 + + + + + This MUST be the CLSID containing the object class GUID of the creating application. + + + + + This MUST be a LengthPrefixedUnicodeString that can contain + any arbitrary value and MUST be ignored on processing. + + + + + This can contain any arbitrary value and MUST be ignored on processing. + + + + + This MUST be a FILETIME that contains the time + when the container application last updated the RemoteUpdateTime field. + + + + + This MUST be a FILETIME that contains the time + when the container application last checked the update time of the linked object. + + + + + This MUST be a FILETIME that contains the time when the linked object was last updated. + + + + + The type of the link; + + + + + Path to linked file + + + + + Initializes a new instance of the class. + + The comp stream. + + + + Initializes a default instance of the class. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Saves to compound stream. + + The stream. + + + + Saves to stg stream. + + The comp stream. + + + + Writes the zero byte array. + + The STG stream. + Length of the byte. + + + + Writes the length prefixed string. + + The STG stream. + The data. + + + + Gets the size of the structure. + + The length. + + + + + + + + + + + + + + Path to file + + + + + Initializes a new instance of the class. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Gets the short name of the path. + + The path. + The short path. + Short length of the path. + + + + + Save data structure. + + The STG stream. + + + + Gets the size of the structure. + + The length. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Parse the data strucure + + Bytes with data + Offset + + + + Saves the data structure. + + The destination array. + The offset. + Length + + + + Gets the size of the structure. + + The length. + + + + This interface is used to perform some action on demand. + + + + + Performs required operation. + + + + + Parent worksheet. + + + + + Index of the remove row operation. + + + + + Number of rows to remove. + + + + + Initializes new instance of the class. + + Parent worksheet. + Index of the remove row operation. + Number of rows being removed. + + + + Clears necessary rows. + + + + + This class represents combo box object. + + + + + This interface provides access to the combo box shape properties. + + + + + Gets or sets the worksheet range used to fill the specified list box. + + + The following code illustrates how to set the ListFillRange to load the data for the combobox. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["J1"].Value = "1"; + worksheet["J2"].Value = "2"; + worksheet["J3"].Value = "3"; + + //Add combobox + IComboBoxShape combobox = worksheet.ComboBoxes.AddComboBox(2, 2, 20, 100); + + //Add combobox data + combobox.ListFillRange = worksheet["J1:J3"]; + + //Set linked cell + combobox.LinkedCell = worksheet["D2"]; + + //Set selected index + combobox.SelectedIndex = 2; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the worksheet range linked to the control's value. + + + The following code illustrates how to set LinkedCell to display the of combobox. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["J1"].Value = "1"; + worksheet["J2"].Value = "2"; + worksheet["J3"].Value = "3"; + + //Add combobox + IComboBoxShape combobox = worksheet.ComboBoxes.AddComboBox(2, 2, 20, 100); + + //Add combobox data + combobox.ListFillRange = worksheet["J1:J3"]; + + //Set linked cell + combobox.LinkedCell = worksheet["D2"]; + + //Set selected index + combobox.SelectedIndex = 2; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets selected item index of the combo box. + + + The following code illustrates how to set the SelectedIndex property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["J1"].Value = "1"; + worksheet["J2"].Value = "2"; + worksheet["J3"].Value = "3"; + + //Add combobox + IComboBoxShape combobox = worksheet.ComboBoxes.AddComboBox(2, 2, 20, 100); + + //Add combobox data + combobox.ListFillRange = worksheet["J1:J3"]; + + //Set linked cell + combobox.LinkedCell = worksheet["D2"]; + + //Set selected index + combobox.SelectedIndex = 2; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the number of list lines displayed in the drop-down portion of a combo box. + + + The following code illustrates how to set DropDownLines property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["J1"].Value = "1"; + worksheet["J2"].Value = "2"; + worksheet["J3"].Value = "3"; + worksheet["J4"].Value = "4"; + worksheet["J5"].Value = "5"; + + //Add combobox + IComboBoxShape combobox = worksheet.ComboBoxes.AddComboBox(2, 2, 20, 100); + + //Add combobox data + combobox.ListFillRange = worksheet["J1:J5"]; + + //Set selected index + combobox.SelectedIndex = 1; + + //Set droplines + combobox.DropDownLines = 2; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets value indicating whether 3D shadow is present. + + + The following code illustrates how to set Display3DShading property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["J1"].Value = "1"; + worksheet["J2"].Value = "2"; + worksheet["J3"].Value = "3"; + worksheet["J4"].Value = "4"; + worksheet["J5"].Value = "5"; + + //Add combobox + IComboBoxShape combobox = worksheet.ComboBoxes.AddComboBox(2, 2, 20, 100); + + //Add combobox data + combobox.ListFillRange = worksheet["J1:J5"]; + + //Set selected index + combobox.SelectedIndex = 1; + + //Set 3D shading + combobox.Display3DShading = true; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets value selected in combobox. + + + 1-based indexing is used to access the values in combobox list. + + + The following code illustrates how to access SelectedValue property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["J1"].Value = "1"; + worksheet["J2"].Value = "2"; + worksheet["J3"].Value = "3"; + + //Add combobox + IComboBoxShape combobox = worksheet.ComboBoxes.AddComboBox(2, 2, 20, 100); + + //Add combobox data + combobox.ListFillRange = worksheet["J1:J3"]; + + //Set selected index + combobox.SelectedIndex = 1; + + //Get selected value + Console.Write(combobox.SelectedValue); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //1 + + + + + + Shape instance. + + + + + Shape version. + + + + + Default number of drop lines. + + + + + The worksheet range used to fill the specified list box. + + + + + Gets or sets the worksheet range linked to the control's value. + + + + + Gets or sets selected item index of the combo box. + + + + + Number of list lines displayed in the drop-down portion of a combo box. + + + + + Type of the combobox object. + + + + + Indicates whether combo box has 3D shadow. + + + + + Indicates the formula string associated with Macro. + + + + + Initializes new instance of the combo box item. + + Application object for the new combo box object. + Parent object for the new combo box object. + + + + Initializes new instance of the combo box item. + + Application object for the new combo box object. + Parent object for the new combo box object. + Shape's container. + Parsing options. + + + + Parses OBJ subrecords. + + + + + + Parses SbsFormula record. + + Record to parse. + + + + Parses LbsData record. + + Record to parse. + + + + Parses Sbs record. + + Record to parse. + + + + This method is called inside of PrepareForSerialization to make shape-dependent preparations. + + + + + Serializes current shape. + + Container that will receive this comment. + + + + Updates ftLbsData sub record. + + OBJ record to update sub record in. + Indicates whether OBJRecord existed before or it was created from scratch. + + + + Updates ftSbsFormula sub record. + + OBJ record to update sub record in. + Indicates whether OBJRecord existed before or it was created from scratch. + + + + Updates ftSbs sub record. + + OBJ record to update sub record in. + Indicates whether OBJRecord existed before or it was created from scratch. + + + + Updates ftCmo sub record. + + OBJ record to update sub record in. + Indicates whether OBJRecord existed before or it was created from scratch. + + + + Creates a clone of the current shape. + + New parent for the shape object. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Indicates whether we should add created + shape into all necessary parent collections. + A copy of the current shape. + + + + Gets or sets the worksheet range used to fill the specified list box. + + + + + Gets or sets the worksheet range linked to the control's value. + + + + + Gets or sets selected item index of the combo box. + + + + + Gets or sets the number of list lines displayed in the drop-down portion of a combo box. + + + + + Gets type of the combo box object. + + + + + Gets or sets value indicating whether 3D shadow is present. + + + + + Gets value selected in combobox. + + + + + Gets or sets the formula associated with macro. + + + + + Get object that represents the hyperlink for the shape. + + + + + Represents the Sparkline chart. + + + + + Represents the data range of the sparkline. + + The data range. + + if the value.Rows.Length is not equal to 1. + + + + + Represents the reference range of the sparkline. + + The reference range. + + if the value.Rows.length and value.Columns.Length is not equal to 1; + + + + + Gets the column index of a sparkline. + + The column index. + + + + Gets the row index of a sparkline. + + The row index. + + + + Represents the collections of Sparkline chart group. + + + + + Clears the sparkline group. + + The sparkline group range. + This follwing is the example for Clear Method + + ExcelEngine engine=new ExcelEngine(); + + IApplication app= engine.Excel; + + app.DefaultVersion= ExcelVersion.Excel2010; + + IWorkbook wkBook= app.Workbooks.Create(2); + IWorksheet sheet= wkBook.Worksheets[0]; + + ISparklineGroups spGroups= sheet.SparklineGroups; + + //Clears the SparklineGroups from the Specified range. + spGroups.Clear(spGroups[0]); + + wkBook.SaveAs("Sample.xlsx"); + wkBook.Close(); + + + + + + + Adds the SparklineGroup instance. + + The follwoing is the sample for Add method + + ExcelEngine engine=new ExcelEngine(); + + IApplication app= engine.Excel; + + app.DefaultVersion= ExcelVersion.Excel2010; + + IWorkbook wkBook= app.Workbooks.Create(2); + IWorksheet sheet= wkBook.Worksheets[0]; + + ISparklineGroups spGroups= sheet.SparklineGroups; + + //Returns the SparklineGroup instance. + ISparklineGroup spGroup= spGroups.Add(); + + wkBook.SaveAs("Sample.xlsx"); + wkBook.Close(); + + + SparklineGroup instance + + + + Represents the Spraklines in Sprakline chart + + + + + Adds Sparkline instance. + + + The following example demonstrates the Add method. + + ExcelEngine engine=new ExcelEngine(); + + IApplication app= engine.Excel; + + app.DefaultVersion= ExcelVersion.Excel2010; + + IWorkbook wkBook= app.Workbooks.Create(2); + IWorksheet sheet= wkBook.Worksheets[0]; + + ISparklineGroup spGroup= sheet.SparklineGroups.Add(); + + //Initialize the Saprklines + ISparklines sparklines=spGroup.Add(); + + //returns the sparkline object. + ISparkline sparkline=sparklines.Add(); + + wkBook.SaveAs("Sample.xlsx"); + wkBook.Close(); + + + the Sprakline object + + + + Adds the sparkline. + + The data range. + The reference range. + + The following example demonstrates the Add method. + + ExcelEngine engine=new ExcelEngine(); + + IApplication app= engine.Excel; + + app.DefaultVersion= ExcelVersion.Excel2010; + + IWorkbook wkBook= app.Workbooks.Create(2); + IWorksheet sheet= wkBook.Worksheets[0]; + + ISparklineGroup spGroup= sheet.SparklineGroups.Add(); + + //Initialize the Sparklines + ISparklines sparklines=spGroup.Add(); + + //Add the Sparklines data range and reference range. + sparklines.Add(sheet.Range["A1:B2"],sheet.Range["C1"]); + + wkBook.SaveAs("Sample.xlsx"); + wkBook.Close(); + + + + + + Adds the sparkline. + + The data range. + The reference range. + + The following example demonstrates the Add method. + + ExcelEngine engine=new ExcelEngine(); + + IApplication app= engine.Excel; + + app.DefaultVersion= ExcelVersion.Excel2010; + + IWorkbook wkBook= app.Workbooks.Create(2); + IWorksheet sheet= wkBook.Worksheets[0]; + + ISparklineGroup spGroup= sheet.SparklineGroups[0]; + + //Initialize the Sparklines + ISparklines sparklines=spGroup[0]; + + //Add the Sparklines data range and reference range. + sparklines.RefreshRanges(sheet.Range["A1:B2"],sheet.Range["C1"]); + + wkBook.SaveAs("Sample.xlsx"); + wkBook.Close(); + + + + + + Adds the sparkline. + + The data range. + The reference range. + Specifies whether to plot the sparklines from the new data range by row or by column. + + The following example demonstrates the Add method. + + ExcelEngine engine=new ExcelEngine(); + + IApplication app= engine.Excel; + + app.DefaultVersion= ExcelVersion.Excel2010; + + IWorkbook wkBook= app.Workbooks.Create(2); + IWorksheet sheet= wkBook.Worksheets[0]; + + ISparklineGroup spGroup= sheet.SparklineGroups.Add(); + + //Initialize the Sparklines + ISparklines sparklines=spGroup.Add(); + + //Add the Sparklines data range and reference range. + sparklines.Add(sheet.Range["A1:B2"],sheet.Range["C1"],true); + + wkBook.SaveAs("Sample.xlsx"); + wkBook.Close(); + + + + + + Adds the sparkline. + + The data range. + The reference range. + Specifies whether to plot the sparklines from the refreshed data range by row or by column. + + The following example demonstrates the Add method. + + ExcelEngine engine=new ExcelEngine(); + + IApplication app= engine.Excel; + + app.DefaultVersion= ExcelVersion.Excel2010; + + IWorkbook wkBook= app.Workbooks.Create(2); + IWorksheet sheet= wkBook.Worksheets[0]; + + ISparklineGroup spGroup= sheet.SparklineGroups[0]; + + //Initialize the Sparklines + ISparklines sparklines=spGroup[0]; + + //Add the Sparklines data range and reference range. + sparklines.RefreshRanges(sheet.Range["A1:B2"],sheet.Range["C1"],true); + + wkBook.SaveAs("Sample.xlsx"); + wkBook.Close(); + + + + + + Clears the sparkline. + + The sparkline range. + + The following example demonstrates the Clear Method + + ExcelEngine engine=new ExcelEngine(); + + IApplication app= engine.Excel; + + app.DefaultVersion= ExcelVersion.Excel2010; + + IWorkbook wkBook= app.Workbooks.Create(2); + IWorksheet sheet= wkBook.Worksheets[0]; + + ISparklineGroup spGroup= sheet.SparklineGroups.Add(); + + //Initialize the Saprklines + ISparklines sparklines=spGroup.Add(); + + //Clears the Sparkline from the specified range. + sparklines.Clear(sparklines[0] as Sparkline); + + wkBook.SaveAs("Sample.xlsx"); + wkBook.Close(); + + + + + + Represents the Sparkline chart group. + + + + + Adds Sparklines instance. + + + This Example Demostrated how to Add the Sparklines + + ExcelEngine engine=new ExcelEngine(); + + IApplication app= engine.Excel; + + app.DefaultVersion= ExcelVersion.Excel2010; + + IWorkbook wkBook= app.Workbooks.Create(2); + IWorksheet sheet= wkBook.Worksheets[0]; + + ISparklineGroup spGroup= sheet.SparklineGroups.Add(); + + //It returns the Sparklines object + ISparklines spLines= spGroup.Add(); + + wkBook.SaveAs("Sample.xlsx"); + wkBook.Close(); + + + + Sparklines object + + + + Indicates whether to show the sparkline horizontal axis. The horizontal axis appears if the sparkline has data that crosses the zero axis. + + true if [display axis]; otherwise, false. + + + + Indicates whether to show data in hidden rows and columns. + + true if [display hidden RC]; otherwise, false. + + + + Indicates whether the plot data is right to left. + + true if [plot right to left]; otherwise, false. + + + + Indicates whether to highlight the first point of data in the sparkline group. + + true if [show first point]; otherwise, false. + + + + Indicates whether to highlight the last point of data in the sparkline group. + + true if [show last point]; otherwise, false. + + + + Indicates whether to highlight the lowest points of data in the sparkline group. + + true if [show low point]; otherwise, false. + + + + Indicates whether to highlight the highest points of data in the sparkline group. + + true if [show high point]; otherwise, false. + + + + Indicates whether to highlight the negative values on the sparkline group with a different color or marker. + + true if [show negative point]; otherwise, false. + + + + Indicates whether to highlight each point in each line sparkline in the sparkline group. + + true if [show markers]; otherwise, false. + If Sparklinetype is not equal to Line + + + + The VerticalAxisMaximum property represents the Vertical Axis maximum options. + + The VerticalAxisMaximum property gets/sets the m_verticalMaximum member. + + + + The VerticalAxisMinimum property represents the Vertical Axis minimum options. + + The VerticalAxisMinimum property gets/sets the m_verticalMinimum member. + + + + Indicates the sparkline type of the sparkline group. + + The SparklineType property gets/sets the m_sparklineType member. + + + + The HorizontalDateAxis property represents the horizontal axis type as Dateaxis. + + true if [horizontal date axis]; otherwise, false. + + + + Indicates how to display empty cells. + + The DisplayEmptyCellsAs property gets/sets the m_displayEmptyCellsAs data member. + + + + Represents the range that contains the date values for the sparkline data. + + The HorizontalDateAxisRange property gets/sets the m_horizontalDateAxisRange data member. + + ifis not equal to 1 + ifis not equal to 1 + ifis not true + + + + + Gets and sets the color of the horizontal axis in the sparkline group. + + The color of the axis. + + + + Gets and sets the color of the first point of data in the sparkline group. + + The first color of the point. + + + + Gets and sets the color of the highest points of data in the sparkline group. + + The color of the high point. + + + + Gets and sets the color of the last point of data in the sparkline group. + + The last color of the point. + + + + Gets and sets the line weight in each line sparkline in the sparkline group, in the unit of points. + + The line weight value should be between 0 and 1584. + if the value is not between 0 and 1584 + + + + Gets and sets the color of the lowest points of data in the sparkline group. + + The color of the low point. + + + + Gets and sets the color of points in each line sparkline in the sparkline group. + + The color of the markers. + + + + Gets and sets the color of the negative values on the sparkline group. + {get; set; } + The color of the negative point. + + + + Gets and sets the color of the sparklines in the sparkline group. + + The color of the sparkline. + + + + Represents vertical axis of the Sprakline chart. + + + + + Gets or sets the custom Value for the Vertical axis custom option. + + The custom. + If the VaerticalAxisOptions is not equal to Custom + + + + Gets or sets the vertical axis options. + + The vertical axis options. + + + + Represents the Sparline constants + + + + + Uri Attribute + + + + + Sparkline groups tag + + + + + Sparkline group tag + + + + + Sparklines tag + + + + + Sparkline tag + + + + + Color Series tag + + + + + Color negative tag + + + + + Color Axis tag + + + + + Color markers tag + + + + + Color first tag + + + + + Color last tag + + + + + Color high tag + + + + + Color low tag + + + + + Vertical maximum attribute + + + + + Vertical minimum attribute + + + + + Line weight attribute + + + + + Sparkline type attribute + + + + + Date axis attribute + + + + + Display empty cells attribute + + + + + Markers attribute + + + + + High attribute + + + + + Low attribute + + + + + First attribute + + + + + Last attribute + + + + + Negative attribute + + + + + Display axis attribute + + + + + Display hidden attribute + + + + + Vertical maximum axis type attribute + + + + + Vertical minimum axis typr attribute + + + + + Plot right to left attribute + + + + + Represents a Sparkline.The Sparkline object is a member of the Sparklines Collection. + The Sparklines collection contains all the sparkline objects in a worksheet. + + + + + + Represents the data range of the sparkline. + + The data range. + + if the value.Rows.Length is not equal to 1. + + + + + Represents the reference range of the sparkline. + + The reference range. + + if the value.Rows.length and value.Columns.Length is not equal to 1; + + + + + Gets the column index of a sparkline. + + The column index. + + + + Gets the row index of a sparkline. + + The row index. + + + + SparkLines instance. + + + + + Represents a SparklineGroup.The SparklineGroup object is a member of the + SparklineGroups collection.The SparklineGroups collection contains all + the SparklineGroup objects in a workheet. + + + + + SparklineGroup implementation + + + + + + Adds Sparklines instance. + + + This Example Demostrated how to Add the Sparklines + + ExcelEngine engine=new ExcelEngine(); + + IApplication app= engine.Excel; + + app.DefaultVersion= ExcelVersion.Excel2010; + + IWorkbook wkBook= app.Workbooks.Create(2); + IWorksheet sheet= wkBook.Worksheets[0]; + + ISparklineGroup spGroup= sheet.SparklineGroups.Add(); + + //It returns the Sparklines object + ISparklines spLines= spGroup.Add(); + + wkBook.SaveAs("Sample.xlsx"); + wkBook.Close(); + + + + Sparklines object + + + + Indicates whether to show the sparkline horizontal axis. The horizontal axis appears if the sparkline has data that crosses the zero axis. + + true if [display axis]; otherwise, false. + + + + Indicates whether to show data in hidden rows and columns. + + true if [display hidden RC]; otherwise, false. + + + + Indicates whether the plot data is right to left. + + true if [plot right to left]; otherwise, false. + + + + Indicates whether to highlight the first point of data in the sparkline group. + + true if [show first point]; otherwise, false. + + + + Indicates whether to highlight the last point of data in the sparkline group. + + true if [show last point]; otherwise, false. + + + + Indicates whether to highlight the lowest points of data in the sparkline group. + + true if [show low point]; otherwise, false. + + + + Indicates whether to highlight the highest points of data in the sparkline group. + + true if [show high point]; otherwise, false. + + + + Indicates whether to highlight the negative values on the sparkline group with a different color or marker. + + true if [show negative point]; otherwise, false. + + + + Indicates whether to highlight each point in each line sparkline in the sparkline group. + + true if [show markers]; otherwise, false. + If Sparklinetype is not equal to Line + + + + The VerticalAxisMaximum property represents the Vertical Axis maximum options. + + The VerticalAxisMaximum property gets/sets the m_verticalMaximum member. + + + + The VerticalAxisMinimum property represents the Vertical Axis minimum options. + + The VerticalAxisMinimum property gets/sets the m_verticalMinimum member. + + + + Indicates the sparkline type of the sparkline group. + + The SparklineType property gets/sets the m_sparklineType member. + + + + The HorizontalDateAxis property represents the horizontal axis type as Dateaxis. + + true if [horizontal date axis]; otherwise, false. + + + + Indicates how to display empty cells. + + The DisplayEmptyCellsAs property gets/sets the m_displayEmptyCellsAs data member. + + + + Represents the range that contains the date values for the sparkline data. + + The HorizontalDateAxisRange property gets/sets the m_horizontalDateAxisRange data member. + + ifis not equal to 1 + ifis not equal to 1 + ifis not true + + + + + Gets and sets the color of the horizontal axis in the sparkline group. + + The color of the axis. + + + + Gets and sets the color of the first point of data in the sparkline group. + + The first color of the point. + + + + Gets and sets the color of the highest points of data in the sparkline group. + + The color of the high point. + + + + Gets and sets the color of the last point of data in the sparkline group. + + The last color of the point. + + + + Gets and sets the line weight in each line sparkline in the sparkline group, in the unit of points. + + The line weight value should be between 0 and 1584. + if the value is not between 0 and 1584 + + + + Gets and sets the color of the lowest points of data in the sparkline group. + + The color of the low point. + + + + Gets and sets the color of points in each line sparkline in the sparkline group. + + The color of the markers. + + + + Gets and sets the color of the negative values on the sparkline group. + + The color of the negative point. + + + + Gets and sets the color of the sparklines in the sparkline group. + + The color of the sparkline. + + + + The SparklineGroups represents the collection of SparklineGroup objects. + + + + + Represnts the implementaion of SparklineGroups + + + + + + Clears the sparkline group. + + The sparkline group range. + This follwing is the example for Clear Method + + ExcelEngine engine=new ExcelEngine(); + + IApplication app= engine.Excel; + + app.DefaultVersion= ExcelVersion.Excel2010; + + IWorkbook wkBook= app.Workbooks.Create(2); + IWorksheet sheet= wkBook.Worksheets[0]; + + ISparklineGroups spGroups= sheet.SparklineGroups; + + //Clears the SparklineGroups from the Specified range. + spGroups.Clear(spGroups[0] as ISparklineGroup); + + wkBook.SaveAs("Sample.xlsx"); + wkBook.Close(); + + + + + + + Adds the SparklineGroup instance. + + The follwoing is the sample for Add method + + ExcelEngine engine=new ExcelEngine(); + + IApplication app= engine.Excel; + + app.DefaultVersion= ExcelVersion.Excel2010; + + IWorkbook wkBook= app.Workbooks.Create(2); + IWorksheet sheet= wkBook.Worksheets[0]; + + ISparklineGroups spGroups= sheet.SparklineGroups; + + //Returns the SparklineGroup instance. + ISparklineGroup spGroup= spGroups.Add(); + + wkBook.SaveAs("Sample.xlsx"); + wkBook.Close(); + + + SparklineGroup instance + + + + Represents the sparklines.The Sparklines object is a member of the SparklineGroup collection. + The SparklineGroup collection contains all the Sparklines object of the worksheet. + + + + + Adds Sparkline instance. + + + The following example demonstrates the Add method. + + ExcelEngine engine=new ExcelEngine(); + + IApplication app= engine.Excel; + + app.DefaultVersion= ExcelVersion.Excel2010; + + IWorkbook wkBook= app.Workbooks.Create(2); + IWorksheet sheet= wkBook.Worksheets[0]; + + ISparklineGroup spGroup= sheet.SparklineGroups.Add(); + + //Initialize the Saprklines + ISparklines sparklines=spGroup.Add(); + + //returns the sparkline object. + Sparkline sparkline=sparklines.Add(); + + wkBook.SaveAs("Sample.xlsx"); + wkBook.Close(); + + + the Saprkline object + + + + Adds the sparkline. + + The data range. + The reference range. + + The following example demonstrates the Add method. + + ExcelEngine engine=new ExcelEngine(); + + IApplication app= engine.Excel; + + app.DefaultVersion= ExcelVersion.Excel2010; + + IWorkbook wkBook= app.Workbooks.Create(2); + IWorksheet sheet= wkBook.Worksheets[0]; + + ISparklineGroup spGroup= sheet.SparklineGroups.Add(); + + //Initialize the Sparklines + ISparklines sparklines=spGroup.Add(); + + //Add the Sparklines data range and reference range. + sparklines.Add(sheet.Range["A1:B2"],sheet.Range["C1"],true); + + wkBook.SaveAs("Sample.xlsx"); + wkBook.Close(); + + + + + + Adds the sparkline. + + The data range. + The reference range. + + The following example demonstrates the Add method. + + ExcelEngine engine=new ExcelEngine(); + + IApplication app= engine.Excel; + + app.DefaultVersion= ExcelVersion.Excel2010; + + IWorkbook wkBook= app.Workbooks.Create(2); + IWorksheet sheet= wkBook.Worksheets[0]; + + ISparklineGroup spGroup= sheet.SparklineGroups[0]; + + //Initialize the Sparklines + ISparklines sparklines=spGroup[0]; + + //Add the Sparklines data range and reference range. + sparklines.RefreshRanges(sheet.Range["A1:B2"],sheet.Range["C1"]); + + wkBook.SaveAs("Sample.xlsx"); + wkBook.Close(); + + + + + + Adds the sparkline. + + The data range. + The reference range. + Specifies whether to plot the sparklines from the new data range by row or by column. + + The following example demonstrates the Add method. + + ExcelEngine engine=new ExcelEngine(); + + IApplication app= engine.Excel; + + app.DefaultVersion= ExcelVersion.Excel2010; + + IWorkbook wkBook= app.Workbooks.Create(2); + IWorksheet sheet= wkBook.Worksheets[0]; + + ISparklineGroup spGroup= sheet.SparklineGroups.Add(); + + //Initialize the Sparklines + ISparklines sparklines=spGroup.Add(); + + //Add the Sparklines data range and reference range. + sparklines.Add(sheet.Range["A1:B2"],sheet.Range["C1"],true); + + wkBook.SaveAs("Sample.xlsx"); + wkBook.Close(); + + + + + + Adds the sparkline. + + The data range. + The reference range. + + The following example demonstrates the Add method. + + ExcelEngine engine=new ExcelEngine(); + + IApplication app= engine.Excel; + + app.DefaultVersion= ExcelVersion.Excel2010; + + IWorkbook wkBook= app.Workbooks.Create(2); + IWorksheet sheet= wkBook.Worksheets[0]; + + ISparklineGroup spGroup= sheet.SparklineGroups[0]; + + //Initialize the Sparklines + ISparklines sparklines=spGroup[0]; + + //Add the Sparklines data range and reference range. + sparklines.RefreshRanges(sheet.Range["A1:B2"],sheet.Range["C1"],true); + + wkBook.SaveAs("Sample.xlsx"); + wkBook.Close(); + + + + + + Clears the sparkline. + + The sparkline range. + + The following example demonstrates the Clear Method + + ExcelEngine engine=new ExcelEngine(); + + IApplication app= engine.Excel; + + app.DefaultVersion= ExcelVersion.Excel2010; + + IWorkbook wkBook= app.Workbooks.Create(2); + IWorksheet sheet= wkBook.Worksheets[0]; + + ISparklineGroup spGroup= sheet.SparklineGroups.Add(); + + //Initialize the Saprklines + ISparklines sparklines=spGroup.Add(); + + //Clears the Sparkline from the specified range. + sparklines.Clear(sparklines[0] as Sparkline); + + wkBook.SaveAs("Sample.xlsx"); + wkBook.Close(); + + + + + + Updates the sparklines. + + The data range. + The reference range. + if set to true [is vertical]. + + + + Represents Sparkline Vertical Axis + + + + + Gets or sets the custom Value for the Vertical axis custom option. + + The custom. + If the VaerticalAxisOptions is not equal to Custom + + + + Gets or sets the vertical axis options. + + The vertical axis options. + + + + Represents a table on a worksheet. + + + The ListObject object is a member of the collection. The collection contains all the list objects on a worksheet. + Use the property of the to return a collection. + + + + + Updates the table's data range which is similar to refreshing table in Excel. + + + This method is only supported in Windows Forms, Windows Presentation Foundation, Web Forms and MVC platforms. + + + Following code illustrates how to refresh the table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set Connection string for DataSource + string ConnectionString = "OLEDB;Provider=Microsoft.JET.OLEDB.4.0;Password=\"\";User ID=Admin;Data Source=AccessDB.mdb"; + + //Add a connection to the workbook + IConnection Connection = workbook.Connections.Add("Connection1", "Sample connection with MsAccess", ConnectionString, "", ExcelCommandType.Sql); + + //Add a QueryTable to sheet object + IListObject table = worksheet.ListObjects.AddEx(ExcelListObjectSourceType.SrcQuery, Connection, worksheet.Range["A1"]); + + //Set Command Text for the Connection + table.QueryTable.CommandText = "Select * from tbltest"; + + //Set connection description + Connection.Description = "Sample Connection"; + + // Import data to the sheet from the database + table.Refresh(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + This method is not supported in WinRT, Windows Phone, Universal, Portable and Silverlight platforms. + + + + + Gets and sets the table style name. + + + + + Gets or sets the name of the table. + + + Following code illustrates how to access Name property of the table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C6"]); + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Get Table Name + Console.WriteLine(table1.Name); + + //Set Table Name + table1.Name = "Products"; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C6"].CellStyleName = "CurrencyFormat"; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //Table1 + + + + + + Gets or sets the location of the table in a worksheet. + + + The following code illustrates how table range can be set and accessed. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C6"]); + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Print Table Range + Console.WriteLine(table1.Location.AddressLocal.ToString()); + + //Add Data + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B7"].Number = 943.89; + worksheet["C7"].Number = 349.6; + + //Set Table Range + table1.Location = worksheet.Range["A1:C7"]; + + //Get Table Range + Console.WriteLine(table1.Location.AddressLocal.ToString()); + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C7"].CellStyleName = "CurrencyFormat"; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //A1:C6 + //A1:C7 + + + + + + Gets collection of columns in the table. Read-only. + + + The following code illustrates how to access Columns property of the table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C7"]); + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Total row + table1.ShowTotals = true; + table1.Columns[0].TotalsRowLabel = "Total"; + table1.Columns[1].TotalsCalculation = ExcelTotalsCalculation.Sum; + table1.Columns[2].TotalsCalculation = ExcelTotalsCalculation.Sum; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Gets index of the table in a worksheet. Read-only. + + + The following code illustrates how to access the index of the table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C7"]); + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Total row + table1.ShowTotals = true; + table1.Columns[0].TotalsRowLabel = "Total"; + table1.Columns[1].TotalsCalculation = ExcelTotalsCalculation.Sum; + table1.Columns[2].TotalsCalculation = ExcelTotalsCalculation.Sum; + + //Print Table index + Console.WriteLine(table1.Index); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //2 + + + + + + Gets or sets the built-in style for the table. + + + To customize the table layout built-in styles from enumeration can be applied to tables. Here for example, we + set to property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C7"]); + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Total row + table1.ShowTotals = true; + table1.Columns[0].TotalsRowLabel = "Total"; + table1.Columns[1].TotalsCalculation = ExcelTotalsCalculation.Sum; + table1.Columns[2].TotalsCalculation = ExcelTotalsCalculation.Sum; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Gets the parent worksheet object. Read-only. + + + The following code illustrates how the parent worksheet can be accessed. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C7"]); + + //Get parent worksheet's name + Console.WriteLine(table1.Worksheet.Name); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //Sheet1 + + + + + + Gets or sets the display name for the table. + + + If the of the table is not set it will be set using the value from property. Here for example, we + get the and print it to console. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C6"]); + + //Get Table display name + Console.WriteLine(table1.DisplayName); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //Table1 + + + + + + Gets number of totals rows in the table. Read-only. + + + The following code illustrates how to get the totals rows count. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C7"]); + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Apply AutoFit + worksheet["A1:D8"].AutofitColumns(); + + //Check totals row count + Console.WriteLine(table1.TotalsRowCount); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //0 + + + + + + Gets or sets a Boolean value indicating whether the Total row is visible. + + + By default property is set to "False". To add an additional row to display the sum or average of values in the column + in the table has to be set to "True". Here for example, We enable it by setting it to "True" and show the sum of values + in second and third columns in the totals row. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C7"]); + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Total row + table1.ShowTotals = true; + table1.Columns[0].TotalsRowLabel = "Total"; + table1.Columns[1].TotalsCalculation = ExcelTotalsCalculation.Sum; + table1.Columns[2].TotalsCalculation = ExcelTotalsCalculation.Sum; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether row stripes should be present. + + + property is set to "True" by default. This allows table to show alternate shades of color present in the + table style. Here for example, We set to "False" and set to "True" + to enable table formatting in columns only. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["C1"].Text = "Products"; + worksheet["C2"].Text = "Alfreds Futterkiste"; + worksheet["C3"].Text = "Antonio Moreno Taqueria"; + worksheet["C4"].Text = "Around the Horn"; + worksheet["C5"].Text = "Bon app"; + worksheet["C6"].Text = "Eastern Connection"; + worksheet["C7"].Text = "Ernst Handel"; + worksheet["D1"].Text = "Qtr1"; + worksheet["D2"].Number = 744.6; + worksheet["D3"].Number = 5079.6; + worksheet["D4"].Number = 1267.5; + worksheet["D5"].Number = 1418; + worksheet["D6"].Number = 4728; + worksheet["D7"].Number = 943.89; + worksheet["E1"].Text = "Qtr2"; + worksheet["E2"].Number = 162.56; + worksheet["E3"].Number = 1249.2; + worksheet["E4"].Number = 1062.5; + worksheet["E5"].Number = 756; + worksheet["E6"].Number = 4547.92; + worksheet["E7"].Number = 349.6; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["C1:E7"]); + + //Set Row Column Stripe Visiblity + table1.ShowTableStyleRowStripes = false; + table1.ShowTableStyleColumnStripes = true; + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["D2:E8"].CellStyleName = "CurrencyFormat"; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether column stripes should be present. + + + Similar to and , and + properties are used to alter first and last rows of the table. + + + By default is set to "False", So formatting is applied only to table rows. Here for example, We set + to "True" and to "False" to change the default formatting of + the table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["C1"].Text = "Products"; + worksheet["C2"].Text = "Alfreds Futterkiste"; + worksheet["C3"].Text = "Antonio Moreno Taqueria"; + worksheet["C4"].Text = "Around the Horn"; + worksheet["C5"].Text = "Bon app"; + worksheet["C6"].Text = "Eastern Connection"; + worksheet["C7"].Text = "Ernst Handel"; + worksheet["D1"].Text = "Qtr1"; + worksheet["D2"].Number = 744.6; + worksheet["D3"].Number = 5079.6; + worksheet["D4"].Number = 1267.5; + worksheet["D5"].Number = 1418; + worksheet["D6"].Number = 4728; + worksheet["D7"].Number = 943.89; + worksheet["E1"].Text = "Qtr2"; + worksheet["E2"].Number = 162.56; + worksheet["E3"].Number = 1249.2; + worksheet["E4"].Number = 1062.5; + worksheet["E5"].Number = 756; + worksheet["E6"].Number = 4547.92; + worksheet["E7"].Number = 349.6; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["C1:E7"]); + + //Set Row Column Stripe Visiblity + table1.ShowTableStyleRowStripes = false; + table1.ShowTableStyleColumnStripes = true; + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["D2:E8"].CellStyleName = "CurrencyFormat"; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether last column format is present. + + + If table's property is set, then the table's last column format can be enabled by setting "true" to + property. By default it is "false". Here for example, we set to "true" to enable the format for the last column. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["C1"].Text = "Products"; + worksheet["C2"].Text = "Alfreds Futterkiste"; + worksheet["C3"].Text = "Antonio Moreno Taqueria"; + worksheet["C4"].Text = "Around the Horn"; + worksheet["C5"].Text = "Bon app"; + worksheet["C6"].Text = "Eastern Connection"; + worksheet["C7"].Text = "Ernst Handel"; + worksheet["D1"].Text = "Qtr1"; + worksheet["D2"].Number = 744.6; + worksheet["D3"].Number = 5079.6; + worksheet["D4"].Number = 1267.5; + worksheet["D5"].Number = 1418; + worksheet["D6"].Number = 4728; + worksheet["D7"].Number = 943.89; + worksheet["E1"].Text = "Qtr2"; + worksheet["E2"].Number = 162.56; + worksheet["E3"].Number = 1249.2; + worksheet["E4"].Number = 1062.5; + worksheet["E5"].Number = 756; + worksheet["E6"].Number = 4547.92; + worksheet["E7"].Number = 349.6; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["C1:E7"]); + + //Set Column Visiblity + table1.ShowFirstColumn = true; + table1.ShowLastColumn = true; + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["D2:E8"].CellStyleName = "CurrencyFormat"; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether first column format is present. + + + If table's property is set, then the table's first column format can be enabled by setting "true" to + property. By default it is "false". Here for example, we set to "true" to enable the format for the first column. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["C1"].Text = "Products"; + worksheet["C2"].Text = "Alfreds Futterkiste"; + worksheet["C3"].Text = "Antonio Moreno Taqueria"; + worksheet["C4"].Text = "Around the Horn"; + worksheet["C5"].Text = "Bon app"; + worksheet["C6"].Text = "Eastern Connection"; + worksheet["C7"].Text = "Ernst Handel"; + worksheet["D1"].Text = "Qtr1"; + worksheet["D2"].Number = 744.6; + worksheet["D3"].Number = 5079.6; + worksheet["D4"].Number = 1267.5; + worksheet["D5"].Number = 1418; + worksheet["D6"].Number = 4728; + worksheet["D7"].Number = 943.89; + worksheet["E1"].Text = "Qtr2"; + worksheet["E2"].Number = 162.56; + worksheet["E3"].Number = 1249.2; + worksheet["E4"].Number = 1062.5; + worksheet["E5"].Number = 756; + worksheet["E6"].Number = 4547.92; + worksheet["E7"].Number = 349.6; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["C1:E7"]); + + //Set Column Visiblity + table1.ShowFirstColumn = true; + table1.ShowLastColumn = true; + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["D2:E8"].CellStyleName = "CurrencyFormat"; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether to hide/display header row. + + + The following code illustrates how to hide the header row of the table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["C1"].Text = "Products"; + worksheet["C2"].Text = "Alfreds Futterkiste"; + worksheet["C3"].Text = "Antonio Moreno Taqueria"; + worksheet["C4"].Text = "Around the Horn"; + worksheet["C5"].Text = "Bon app"; + worksheet["C6"].Text = "Eastern Connection"; + worksheet["C7"].Text = "Ernst Handel"; + worksheet["D1"].Text = "Qtr1"; + worksheet["D2"].Number = 744.6; + worksheet["D3"].Number = 5079.6; + worksheet["D4"].Number = 1267.5; + worksheet["D5"].Number = 1418; + worksheet["D6"].Number = 4728; + worksheet["D7"].Number = 943.89; + worksheet["E1"].Text = "Qtr2"; + worksheet["E2"].Number = 162.56; + worksheet["E3"].Number = 1249.2; + worksheet["E4"].Number = 1062.5; + worksheet["E5"].Number = 756; + worksheet["E6"].Number = 4547.92; + worksheet["E7"].Number = 349.6; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["C1:E7"]); + + //Set Header Visiblity + table1.ShowHeaderRow = false; + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["D2:E8"].CellStyleName = "CurrencyFormat"; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the alternative text title. + + + The following code illustrates how to set the alternative text title for the table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["C1"].Text = "Products"; + worksheet["C2"].Text = "Alfreds Futterkiste"; + worksheet["C3"].Text = "Antonio Moreno Taqueria"; + worksheet["C4"].Text = "Around the Horn"; + worksheet["C5"].Text = "Bon app"; + worksheet["C6"].Text = "Eastern Connection"; + worksheet["C7"].Text = "Ernst Handel"; + worksheet["D1"].Text = "Qtr1"; + worksheet["D2"].Number = 744.6; + worksheet["D3"].Number = 5079.6; + worksheet["D4"].Number = 1267.5; + worksheet["D5"].Number = 1418; + worksheet["D6"].Number = 4728; + worksheet["D7"].Number = 943.89; + worksheet["E1"].Text = "Qtr2"; + worksheet["E2"].Number = 162.56; + worksheet["E3"].Number = 1249.2; + worksheet["E4"].Number = 1062.5; + worksheet["E5"].Number = 756; + worksheet["E6"].Number = 4547.92; + worksheet["E7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["D2:E8"].CellStyleName = "CurrencyFormat"; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["C1:E7"]); + + //Set the alternative text title + table1.AlternativeText = "Title"; + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + + Gets or sets the alternative text description. + + + The following code illustrates how to set the alternative text description for the table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["C1"].Text = "Products"; + worksheet["C2"].Text = "Alfreds Futterkiste"; + worksheet["C3"].Text = "Antonio Moreno Taqueria"; + worksheet["C4"].Text = "Around the Horn"; + worksheet["C5"].Text = "Bon app"; + worksheet["C6"].Text = "Eastern Connection"; + worksheet["C7"].Text = "Ernst Handel"; + worksheet["D1"].Text = "Qtr1"; + worksheet["D2"].Number = 744.6; + worksheet["D3"].Number = 5079.6; + worksheet["D4"].Number = 1267.5; + worksheet["D5"].Number = 1418; + worksheet["D6"].Number = 4728; + worksheet["D7"].Number = 943.89; + worksheet["E1"].Text = "Qtr2"; + worksheet["E2"].Number = 162.56; + worksheet["E3"].Number = 1249.2; + worksheet["E4"].Number = 1062.5; + worksheet["E5"].Number = 756; + worksheet["E6"].Number = 4547.92; + worksheet["E7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["D2:E8"].CellStyleName = "CurrencyFormat"; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["C1:E7"]); + + //Set the alternative text description + table1.Summary = "Description"; + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Gets the query table object bound with the table. + + + Following code illustrates how to access the Query table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set Connection string for DataSource + string ConnectionString = "OLEDB;Provider=Microsoft.JET.OLEDB.4.0;Password=\"\";User ID=Admin;Data Source=AccessDB.mdb"; + + //Add a connection to the workbook + IConnection Connection = workbook.Connections.Add("Connection1", "Sample connection with MsAccess", ConnectionString, "", ExcelCommandType.Sql); + + //Add a QueryTable to sheet object + IListObject table = worksheet.ListObjects.AddEx(ExcelListObjectSourceType.SrcQuery, Connection, worksheet.Range["A1"]); + + //Set Command Text for the Connection + table.QueryTable.CommandText = "Select * from tbltest"; + + //Set connection description + Connection.Description = "Sample Connection"; + + // Import data to the sheet from the database + table.Refresh(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Gets the type or source of the table. + + + The following code illustrates how the table type can be accessed. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C7"]); + + //Print table type to Console + Console.WriteLine(table1.TableType.ToString()); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //worksheet + + + + + + Gets the collection in the table. Read-only. + + + The following code illustrates how collection in table can be accessed. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["C1"].Text = "Products"; + worksheet["C2"].Text = "Alfreds Futterkiste"; + worksheet["C3"].Text = "Antonio Moreno Taqueria"; + worksheet["C4"].Text = "Around the Horn"; + worksheet["C5"].Text = "Bon app"; + worksheet["C6"].Text = "Eastern Connection"; + worksheet["C7"].Text = "Ernst Handel"; + worksheet["D1"].Text = "Qtr1"; + worksheet["D2"].Number = 744.6; + worksheet["D3"].Number = 5079.6; + worksheet["D4"].Number = 1267.5; + worksheet["D5"].Number = 1418; + worksheet["D6"].Number = 4728; + worksheet["D7"].Number = 943.89; + worksheet["E1"].Text = "Qtr2"; + worksheet["E2"].Number = 162.56; + worksheet["E3"].Number = 1249.2; + worksheet["E4"].Number = 1062.5; + worksheet["E5"].Number = 756; + worksheet["E6"].Number = 4547.92; + worksheet["E7"].Number = 349.6; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["C1:E7"]); + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["D2:E8"].CellStyleName = "CurrencyFormat"; + + IAutoFilters filters = table1.AutoFilters; + IAutoFilter filter = filters[0]; + filter.AddTextFilter("Bon app"); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets Boolean to indicate whether the AutoFilter will be displayed. Default value is TRUE. + + + By default property is set to "true". If it is set to "false" after applying filter within table, then it clears + the filter applied. Here for example, we set a text filter within the table and set "false" to property to clear + the applied text filter. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C7"].CellStyleName = "CurrencyFormat"; + + //Create table + IListObject table = worksheet.ListObjects.Create("Table", worksheet["A1:C7"]); + + //Add filter + IAutoFilters filters = table.AutoFilters; + IAutoFilter filter = filters[0]; + filter.AddTextFilter("Ernst Handel"); + + //Clear filter + table.ShowAutoFilter = false; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Name of the list object. + + + + + Location of the list object. + + + + + + + Index of the list object. + + + + + Built-in table style index. + + + + + Display name. + + + + + Parent worksheet object. + + + + + Count of rows with totals. + + + + + Indicates whether row stripes are shown. + + + + + Indicates whether column stripes are shown. + + + + + A Boolean indicating whether the totals row has ever been shown in the past for this table. + + + + + Row shift. + + + + + Custom table style name. + + + + + A Boolean indicating whether the First Columns are shown. + + + + + A Boolean indicating whether the Last Columns are shown. + + + + + A Boolean indicating whether the Header Row is shown. + + + + + Query table for External connection. + + + + + Represent the Table Type + + + + + A zero based integer index indicating which format to apply to the data area of the table + + + + + A zero based integer index indicating what border formatting to apply to the header row of the table + + + + + A zero based integer index indicating which format to apply to the header row of the table + + + + + A zero based integer index indicating what border formatting to apply to the borders of the table + + + + + A zero based integer index indicating what border formatting to apply to the totals row of the table + + + + + A zero based integer index indicating which format to apply to the totals row of the table + + + + + A Boolen indicating whether the table is modified. + + + + + Represents the filter collection + + + + + Gets or sets the alternative text title. + + + + + Gets or sets the alternative text description. + + + + + Represents the slicers present in the table + + + + + Initializes new instance of the list object. + + Name to set. + Location of the new object. + New object's index. + + + + Creates copy of the current object. + + Parent worksheet for the new object. + Dictionary with modified worksheet names. + Copy of the current object. + + + + Generates unique table name. + + Workbook to generate unique name for. + Starting name. + Unique name of the table. + + + + Splits name into two parts - string part and index part. + + Name to split. + String part. + Index part. + + + + Checks whether list object with specified name exists in the specified workbook. + + Workbook to check. + Name to check. + True if list object was found. + + + + List Object has been Refreshed. + + + + + Using Sql connection for list object has been refreshed + + Sql Server conntion + Sql query + Connection have password + + + + Get the server name from registry key + + Data source name + Database name to get + Return server name + + + + Get the server name from registry key + + Data source name + RegisterKey + Sub RegisterKey + Server name to get + Database name to get + Return server name + + + + update the format in table based on sql properties. + + Current DataTable + + + + Adds the ListObject name to workbook named ranges for enabling CalcEngine to calculate table formulas + + + + + Check for the listObject name, if available add the duplicate with list object name only + + key to be searched in name collection + the parent workbook of the name collection + + + + Updates the name of the columns in the List Object + + + + + Checks whether the name is valid for the table. + + Table name + + + + Gets the slicers present in the table + + + + + Gets or sets name of the list object. + + + + + Gets or sets list object's location. + + + + + Gets or sets location of list object's data. + + + + + Gets collection of all columns of the list object. + + + + + Gets index of the current list object. + + + + + Gets or sets the built-in table style for the specified ListObject object. + + + + + Gets parent worksheet object. + + + + + Gets or sets list object name. + + + + + Gets number of rows with totals. + + + + + Gets or sets a boolean indicating whether the totals row has ever been shown in the past for this table. + + + + + Gets or sets the alternative text title. + + + + + Gets or sets the alternative text description. + + + + + Indicates whether row stripes are shown. + + + + + Indicates whether column stripes are shown. + + + + + /// Gets or sets a table style name. + + + + + Indicate whether table is modified + + + + + /// Gets or sets a value indicating whether [show first column]. + + + + + Gets or sets a value indicating whether [show last column]. + + + + + Gets or sets a value indicating whether [show header row]. + + + + + Gets or sets a value indicating whether the Total row is visible. + + + + + Represent the Table Type + + + + + A zero based integer index indicating which format to apply to the data area of the table + + + + + A zero based integer index indicating what border formatting to apply to the header row of the table + + + + + A zero based integer index indicating which format to apply to the header row of the table + + + + + A zero based integer index indicating what border formatting to apply to the borders of the table + + + + + A zero based integer index indicating what border formatting to apply to the totals row of the table + + + + + A zero based integer index indicating which format to apply to the totals row of the table + + + + + + + Represents Table Style + + + + + Delete the table style from table styles list collection. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyle tableStyle1 = tableStyles.Add("Table style 5"); + tableStyle.Delete(); + workbook.SaveAs("CustomTableStyle.xlsx"); + + workbook.Close(); + } + + + + + + Clone the table style and return. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyle tableStyle1 = tableStyles.Add("Table style 5"); + ITableStyle tableStyleClone = tableStyle.Clone(); + workbook.SaveAs("CustomTableStyle.xlsx"); + + workbook.Close(); + } + + + + + + Clone the table style to add the table styles list collection and return. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyle tableStyle1 = tableStyles.Add("Table style 5"); + ITableStyle tableStyleDuplicate = tableStyle.Duplicate(); + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Clone the table style to add the table styles list collection and return. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + string name = "Table Style 4"; + + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyle tableStyle1 = tableStyles.Add("Table style 5"); + ITableStyle tableStyleDuplicate= tableStyle.Duplicate(name); + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets the table style name. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyle tableStyle1 = tableStyles.Add("Table style 5"); + string tableStyleName = tableStyles[0].Name; + workbook.SaveAs("CustomTableStyle.xlsx"); + + workbook.Close(); + } + + + + + + Create the table style elements object and return. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyle tableStyle1 = tableStyles.Add("Table style 5"); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + workbook.SaveAs("CustomTableStyle.xlsx"); + + workbook.Close(); + } + + + + + + Name of the table style. + + + + + Create table Style Elements object. + + + + + Parent table styles. + + + + + Constructor of table style to set the table style name and parent table Styles. + + Table style name + Parent table styles + + + + Constructor of table style to set the parent table styles + + + + + + Equals the table style object. + + Table style object + True, If table style object is exist form table styles collection, otherwise False. + + + + Equals the table style name. + + Table style name + True, If table style name is equal, otherwise False. + + + + Delete the Corresponding table style from table style list collection. + + + + + Clone the table style and add the table styles list collection. + + Clone table style + + + + Clone the table style and add the table style list collection. + + Name for the table style. + Clone table style + + + + Clone the corresponding table style. + + Clone table style. + + + + Clone the corresponding table style. + + Parent table styles + Clone table style. + + + + Dispose the table style reference field. + + + + + Gets or sets the table style name. + + + + + Gets or sets the table style elements object. + + + + + Gets or sets the table styles. + + + + + Represents Table Style Element + + + + + Delete the table style element from table style elements list collection. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.LeftBorderStyle=ExcelLineStyle.Thin; + tableStyleElement.LeftBorderColor=ExcelKnownColors.Red; + tableStyleElement.BackColor=ExcelKnownColors.Blue; + tableStyleElement.Clear(); + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Clone the table style element and return. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.LeftBorderStyle=ExcelLineStyle.Thin; + tableStyleElement.LeftBorderColor=ExcelKnownColors.Red; + tableStyleElement.BackColor=ExcelKnownColors.Blue; + ITableStyleElement tableStyleElementClone = tableStyleElement.Clone(); + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets the table style element type from related table style element. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + ExcelTableStyleElementType tableStyleElementType= tableStyleElements[0].TableStyleElementType; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the table style element row and column strip size. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumnStripe); + tableStyleElement.BackColor = ExcelKnownColors.Blue; + tableStyleElement.StripeSize = 2; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the background color from predefined colors (). + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.BackColor=ExcelKnownColors.Blue; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets and sets the back ground RGB color. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.BackColorRGB = System.Drawing.Color.FromArgb(255, 255, 0, 0); + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets and sets the pattern style from table style element. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.PatternStyle=ExcelPattern.DarkVertical; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets RGB color to pattern. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.PatternStyle = ExcelPattern.DarkVertical; + tableStyleElement.PatternColorRGB = System.Drawing.Color.FromArgb(255, 255, 0, 0); + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the pattern color from predefined colors (). + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.PatternStyle = ExcelPattern.DarkVertical; + tableStyleElement.PatternColor = ExcelKnownColors.Green; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the Font color from predefined colors (). + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.FontColor=ExcelKnownColors.Red; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets RGB color to font. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.FontColorRGB=System.Drawing.Color.FromArgb(255, 0, 0, 255); + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating whether the font is bold. + + Default value is false. + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.Bold = true; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating whether the font is italic. + + Default value is false. + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.Italic = true; + workbook.SaveAs("CustomTableStyle.xlsx"); + + workbook.Close(); + } + + + + + + Gets or sets the underline type from the table style element. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.Underline =ExcelUnderline.Single; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating whether the font is Strike. + + Default value is false. + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.StrikeThrough=true; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the Top Border color from predefined colors (). + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.TopBorderStyle=ExcelLineStyle.Thick; + tableStyleElement.TopBorderColor=ExcelKnownColors.Green; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets RGB color to Top border. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.TopBorderStyle=ExcelLineStyle.Thick; + tableStyleElement.TopBorderColorRGB=System.Drawing.Color.FromArgb(255, 0, 255, 0); + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the Top border line style. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.TopBorderStyle=ExcelLineStyle.Thick; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the Horizontal Border color from predefined colors (). + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.HorizontalBorderStyle=ExcelLineStyle.Thick; + tableStyleElement.HorizontalBorderColor=ExcelKnownColors.Green; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets RGB color to horizontal border. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.HorizontalBorderStyle=ExcelLineStyle.Thick; + tableStyleElement.HorizontalBorderColorRGB=System.Drawing.Color.FromArgb(255, 0, 255, 0); + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the Horizontal border line style. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.HorizontalBorderStyle = ExcelLineStyle.Thick; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the Vertical Border color from predefined colors (). + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.VerticalBorderStyle=ExcelLineStyle.Thick; + tableStyleElement.VerticalBorderColor=ExcelKnownColors.Green; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets RGB color to Vertical border. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.VerticalBorderStyle=ExcelLineStyle.Thick; + tableStyleElement.VerticalBorderColorRGB = System.Drawing.Color.FromArgb(255, 0, 255, 0); + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the Vertical border line style. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.VerticalBorderStyle = ExcelLineStyle.Thick; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the bottom border color from predefined colors (). + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.BottomBorderStyle=ExcelLineStyle.Thick; + tableStyleElement.BottomBorderColor=ExcelKnownColors.Green; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets RGB color to bottom border. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.BottomBorderStyle=ExcelLineStyle.Thick; + tableStyleElement.BottomBorderColorRGB = System.Drawing.Color.FromArgb(255, 0, 255, 0); + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the bottom border line style. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.BottomBorderStyle=ExcelLineStyle.Thick; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the right border color from predefined colors (). + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.RightBorderStyle=ExcelLineStyle.Thick; + tableStyleElement.RightBorderColor=ExcelKnownColors.Green; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets RGB color to right border. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.RightBorderStyle=ExcelLineStyle.Thick; + tableStyleElement.RightBorderColorRGB = System.Drawing.Color.FromArgb(255, 0, 255, 0); + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the right border line style. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.RightBorderStyle=ExcelLineStyle.Thick; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the left border color from predefined colors (). + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.LeftBorderStyle=ExcelLineStyle.Thick; + tableStyleElement.LeftBorderColor=ExcelKnownColors.Green; + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets RGB color to left border. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.LeftBorderStyle=ExcelLineStyle.Thick; + tableStyleElement.LeftBorderColorRGB = System.Drawing.Color.FromArgb(255, 0, 255, 0); + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the left border line style. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.LeftBorderStyle=ExcelLineStyle.Thick; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Whole table from table style element type. + + + + + Header row from table style element type. + + + + + Total row table from table style element type. + + + + + First column from table style element type. + + + + + Last column from table style element type. + + + + + First Row Stripe from table style element type. + + + + + Second Row Stripe from table style element type. + + + + + First Column Stripe from table style element type. + + + + + Second column stripe from table style element type. + + + + + First header cell from table style element type. + + + + + Last header cell from table style element type. + + + + + First total cell from table style element type. + + + + + Last total cell from table style element type. + + + + + Gets and sets the table style element coloum and row strip size. + + + + + Represent the table style element type. + + + + + Parent table style elements + + + + + Color object that stores table style element background color. + + + + + Represent the fill pattern style. + + + + + Color object that stores table style element color. + + + + + Color object that stores table style element font color color. + + + + + Set the font style to bold or not. + + + + + Set the font style to italic or not. + + + + + Set the underline to font or not. + + + + + Set the strike through to font or not. + + + + + Color object that stores table style element top border color. + + + + + set the line style of the top border. + + + + + Color object that stores table style element bottom border color. + + + + + set the line style of the bottom border. + + + + + Color object that stores table style element right border color. + + + + + Set the line style of the right border. + + + + + Color object that stores table style element left border color. + + + + + Set the line style of the left border. + + + + + Check the top border modified or not. + + + + + Check the bottom border modified or not. + + + + + Check the left border modified or not. + + + + + Check the right border modified or not. + + + + + Check the border format present or not. + + + + + Check the font color present or not. + + + + + Check the font format present or not. + + + + + Check the fill pattern back color modified or not. + + + + + Check the pattern format present or not. + + + + + Check the pattern Color modified or not. + + + + + Store the Table style element name. + + + + + Check the vertical border modified or not + + + + + Check the Horizontal border modified or not. + + + + + Color object that stores table style element vertical border color. + + + + + Color object that stores table style element horizontal border color. + + + + + Set the vertical border line style. + + + + + Set the horizontal border line style. + + + + + Constructor of the table style element to set the table style element type and parent table style elements. + + + + + + + Constructor of the table style element to set the table style element name and parent table style elements. + + + + + + + Constructor to set the table style element to set the parent table style elements. + + + + + + Represent this method remove the table style element in table style element list. + + + + + Clone the table style element and set the parent. + + Table style elements object + Clone table style element + + + + Clone the table style element and set the parent. + + Clone table style element + + + + Dispose the table style element reference value. + + + + + Equals the table style element object. + + Table style element object + True, If two table style element is equal, Otherwise false. + + + + Equals the table style element type. + + Type of the table style element + True, If table style element type is equal, Otherwise false + + + + Initializes color objects. + + + + + Update the top border color. + + + + + Update the bottom border color + + + + + Update the back color. + + + + + Update pattern Color. + + + + + Update left border color. + + + + + Update the right border Color. + + + + + Update the font Color. + + + + + Update the border style present. + + + + + Update the font format present. + + + + + Update the pattern format present. + + + + + Update the vertical border color. + + + + + Update the horizontal border color. + + + + + Gets and sets other table style element. + + + + + Gets and sets the column and row strip size. + + + + + Gets and sets the table style elements. + + + + + Gets and sets the table style element type. + + + + + Gets or sets the pattern background color from predefined colors (). + + + + + Gets or sets the pattern background color (). + + + + + Gets or sets the fill pattern style. + + + + + Gets or sets the color (). + + + + + Gets or sets the pattern background color from predefined colors (). + + + + + Gets or sets the font color from predefined colors (). + + + + + Gets or sets the pattern background color (). + + + + + True if the bold is present font otherwise, False. + + + + + True if the italic is present font otherwise, False. + + + + + True if the underline present font otherwise, False. + + + + + True if the strike through is present font otherwise, False. + + + + + Gets or sets the top border color from predefined colors (). + + + + + Gets or sets the top border color (). + + + + + Gets and sets the top border line style. + + + + + Gets and sets the vertical border color. + + + + + Gets or sets the vertical border color (). + + + + + Gets and sets the vertical border line style. + + + + + Gets and sets the horizontal border color. + + + + + Gets or sets the Horizontal border color (). + + + + + Gets and sets the Horizontal border line style. + + + + + Gets or sets the bottom border color from predefined colors (). + + + + + Gets or sets the bottom color (). + + + + + Gets or sets the bottom border line style. + + + + + Gets or sets the top right color from predefined colors (). + + + + + Gets or sets the right border color (). + + + + + Gets or sets the right border line style. + + + + + Gets or sets the left border color from predefined colors (). + + + + + Gets or sets the left border color (). + + + + + Gets or sets the left border line style. + + + + + True if top border line style and color is modified. otherwise, False. + + + + + True if bottom border line style and color is modified. otherwise, False. + + + + + True if right border line style and color is modified. otherwise, False. + + + + + True if left border line style and color is modified. otherwise, False. + + + + + True if the table style element contains font formatting. otherwise, False. + + + + + True if the table style element contains pattern formatting. otherwise, False. + + + + + True if the table style element contains pattern format present. otherwise, Flase. + + + + + True if background color is present. otherwise, False. + + + + + True if the table style element contains border formatting. otherwise, False. + + + + + True if the table style element contains font color present. otherwise, Flase. + + + + + Gets table style element font color object. Read-only. + + + + + Gets table style element color object. Read-only. + + + + + Gets table style element back color object. Read-only. + + + + + Gets table style element top border color object. Read-only. + + + + + Gets table style element bottom border color object. Read-only. + + + + + Gets table style element horizontal border color object. Read-only. + + + + + Gets table style element vertical border color object. Read-only. + + + + + Gets table style element right border color object. Read-only. + + + + + Gets table style eleement left border color object. Read-only. + + + + + True if bottom border line style and color is modified. otherwise, False. + + + + + True if Horizontal border line style and color is modified. otherwise, False. + + + + + Represents Table Style Elements + + + + + Create the table style element object to add the table style elements list collection and return by using table style element type. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + string name = "Table Style 4"; + + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + If check the this table style element is already exist in table style element list collection to return related table style element, else this table style element is add to table style element list collection and return. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElement.BackColor=ExcelKnownColors.Blue; + ITableStyleElement tableStyleElementClone=tableStyleElement.Clone(); + + MemoryStream stream=new MemoryStream(); + workbook.SaveAs(stream); + stream.Position=0; + workbook= application.Workbooks.Open(stream); + ITableStyles tableStyles1=workbook.TableStyles; + ITableStyle tableStyle1 = tableStyles1.Add("Table Style"); + ITableStyleElements tableStyleElements1=tableStyle1.TableStyleElements; + ITableStyleElement tableStyleElement1=tableStyleElements1.Add(tableStyleElementClone); + workbook.Close(); + } + + + + + + True if table style element is exist in table style elements list collection. otherwise, False + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + bool check = tableStyleElements.Contains(tableStyleElement); + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + True if table style element is exist in table style elements list collection. otherwise, False + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + bool check = tableStyleElements.Contains(ExcelTableStyleElementType.FirstColumn); + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Remove the table style element from table style elements list collection by using table style element object. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElements.Remove(tableStyleElement); + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Remove the table style element from table style elements list collection using index value. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + tableStyleElements.RemoveAt(0); + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets the table style element from table style elements list collection by using table style element type. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements= tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.HeaderRow); + tableStyleElement.BackColor=ExcelKnownColors.Red; + ITableStyleElement tableStyleElement1 = tableStyleElements[ExcelTableStyleElementType.HeaderRow]; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets the table style element from table style elements list collection by using index value. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements= tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.HeaderRow); + tableStyleElement.BackColor=ExcelKnownColors.Red; + ITableStyleElement tableStyleElement1 = tableStyleElements[0]; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Gets the table style Element count from table style elements list collection. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.FirstColumn); + int count=tableStyleElements.Count; + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Parent table style + + + + + Constructor of the table style elements to set parent table style. + + Parent table style object + Application object + + + + Create table style object to add table style elements list collection. + + Type of the table style element + Related table style element + + + + Equals the table style element from table style elements list collection. + + Table style element object. + True, If table style element is exist from table style elements collection, Otherwise false. + + + + Add the table style element object to table style elements list collection. + + Table style element object. + + + + + Remove the corresponding table style element from table style element list collection. + + Table style Element object. + + + + Remove the corresponding table style element from table style element list collection. + + Remove the table style based on index + + + + Clone the corresponding table style elements. + + Parent of table Style object. + Clone table style elements object + + + + Dispose the table style elements reference field. + + + + + Check the table style element is exist from table style elements list collection. + + Table style element object + True, If table style element is exist from table style element list collection, Otherwise false. + + + + Check the table style element type is exist from table style elements list collection table style element. + + Type of the Table Style element + True, If table style element type is exist from table style element list collection table style element, Otherwise false + + + + Add the table style element from table style elements list collection. + + Name of the table style element + + + + + Gets the table style element count from table style elements list collection. + + + + + Gets the table style element from table style elements list collection. + + Type of the table style element + Related table style element + + + + Gets the table style element from table style elements list collection. + + Index of table style elements list collection. + Related table style element + + + + Represents Table Styles + + + + + Create table style class object to set the table style name and add the table style list Collection and return table style. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook =application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyle tableStyle1 = tableStyles.Add("Table style 5"); + + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Check this table style is already exist or not. This table style was not exists from table style list collection, Add this table style to table styles list collection and return. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyleElements tableStyleElements = tableStyle.TableStyleElements; + ITableStyleElement tableStyleElement = tableStyleElements.Add(ExcelTableStyleElementType.HeaderRow); + tableStyleElement.BackColor=ExcelKnownColors.Red; + ITableStyle tableStyleClone= tableStyle.Clone(); + + MemoryStream stream = new MemoryStream(); + workbook.SaveAs(stream); + stream.Position=0; + IWorkbook workbook1 = application.Workbooks.Open(stream); + ITableStyles tableStyles1 = workbook1.TableStyles; + ITableStyle tableStyle1 = tableStyles1.Add(tableStyleClone); + + workbook.Close(); + } + + + + + + True, If tabl style is exist in table styles collection. otherwise, False. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyle tableStyle1 = tableStyles.Add("Table style 5"); + bool check=tableStyles.Contains(tableStyle); + workbook.SaveAs("CustomTableStyle.xlsx"); + + workbook.Close(); + } + + + + + + True, If tabl style name is exist in table styles collection. otherwise, False. + + Name of the table style + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyle tableStyle1 = tableStyles.Add("Table style 5"); + bool check=tableStyles.Contains(name); + workbook.SaveAs("CustomTableStyle.xlsx"); + + workbook.Close(); + } + + + + + + Remove the table style from table Style list Collection using table style object. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyle tableStyle1 = tableStyles.Add("Table style 5"); + tableStyles.Remove(tableStyle); + workbook.SaveAs("CustomTableStyle.xlsx"); + + workbook.Close(); + } + + + + + + Remove the table style from table Style list Collection by using index value. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyle tableStyle1 = tableStyles.Add("Table style 5"); + tableStyles.RemoveAt(0); + workbook.SaveAs("CustomTableStyle.xlsx"); + + workbook.Close(); + } + + + + + + Gets the table style from table style list collection by using table style name. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyle tableStyle1 = tableStyles.Add("Table style 5"); + ITableStyle tableStyle2=tableStyles[name]; + workbook.SaveAs("CustomTableStyle.xlsx"); + + workbook.Close(); + } + + + + + + Gets the table style from table style list collection by using index value. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyle tableStyle1 = tableStyles.Add("Table style 5"); + ITableStyle tableStyle2=tableStyles[0]; + workbook.SaveAs("CustomTableStyle.xlsx"); + + workbook.Close(); + } + + + + + + Gets the table style count from table styles list collection. + + + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + string name = "Table Style 4"; + ITableStyles tableStyles = workbook.TableStyles; + ITableStyle tableStyle = tableStyles.Add(name); + ITableStyle tableStyle1 = tableStyles.Add("Table style 5"); + int count=tableStyles.Count; + workbook.SaveAs("CustomTableStyle.xlsx"); + workbook.Close(); + } + + + + + + Maintain the parent work book + + + + + Gets and sets the default table style. + + + + + Gets and sets the default pivot table style. + + + + + Constructor of the table styles and set the workbook impl and application + + current work book for table styles. + Application object + + + + Create table style object to add the table style list collection by using table style name. + + Name of the table style. + + + + + Remove the corresponding table style object from table styles list collection. + + Table style object + + + + Remove the corresponding table style object from table styles list collection. + + Index of the table style + + + + Add the table style object to table style list collection. + + Table style object + Related table style object + + + + True, If table style is exists from table styles list collection, Otherwise false. + + Table style object + Condition is true, return true, Otherwise false. + + + + True, If table style name is exists from table styles list collection table style, Otherwise false. + + Name of the table style + Condtion is true, return true, otherwise false. + + + + Dispose the table styles reference field. + + + + + Clone the table styles. + + Parent workbook + Application + + + + + Gets table style object from table styles list collection + + Name of the table style. + Related table style object + + + + Gets the table style object from table styles list collection. + + + + + + Get the parent work book. + + + + + Gets and sets the default table style. + + + + + Gets and sets the default pivot table style. + + + + + Gets the count of the table style from table style list collection. + + + + + Represents a column in the table. + + + + + Gets or sets the name of the column. + + + If table was created using data in worksheet then Column name will be set automatically if it is available within the range. We can get or set + column name using property. Here for example, We create table using the data in the range "C1:E7" and print + first column's name, id and index using , and + respectively to console. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["C1"].Text = "Products"; + worksheet["C2"].Text = "Alfreds Futterkiste"; + worksheet["C3"].Text = "Antonio Moreno Taqueria"; + worksheet["C4"].Text = "Around the Horn"; + worksheet["C5"].Text = "Bon app"; + worksheet["C6"].Text = "Eastern Connection"; + worksheet["C7"].Text = "Ernst Handel"; + worksheet["D1"].Text = "Qtr1"; + worksheet["D2"].Number = 744.6; + worksheet["D3"].Number = 5079.6; + worksheet["D4"].Number = 1267.5; + worksheet["D5"].Number = 1418; + worksheet["D6"].Number = 4728; + worksheet["D7"].Number = 943.89; + worksheet["E1"].Text = "Qtr2"; + worksheet["E2"].Number = 162.56; + worksheet["E3"].Number = 1249.2; + worksheet["E4"].Number = 1062.5; + worksheet["E5"].Number = 756; + worksheet["E6"].Number = 4547.92; + worksheet["E7"].Number = 349.6; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["C1:E7"]); + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Print Column Name, ID, Index + Console.WriteLine("Column Name " + table1.Columns[0].Name); + Console.WriteLine("Column ID " + table1.Columns[0].Id); + Console.WriteLine("Column Index " + table1.Columns[0].Index); + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["D2:E8"].CellStyleName = "CurrencyFormat"; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + + + + + + Gets column index of current column. Read-only. + + + The following code illustrates how the index of a particular column can be accessed using property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["C1"].Text = "Products"; + worksheet["C2"].Text = "Alfreds Futterkiste"; + worksheet["C3"].Text = "Antonio Moreno Taqueria"; + worksheet["C4"].Text = "Around the Horn"; + worksheet["C5"].Text = "Bon app"; + worksheet["C6"].Text = "Eastern Connection"; + worksheet["C7"].Text = "Ernst Handel"; + worksheet["D1"].Text = "Qtr1"; + worksheet["D2"].Number = 744.6; + worksheet["D3"].Number = 5079.6; + worksheet["D4"].Number = 1267.5; + worksheet["D5"].Number = 1418; + worksheet["D6"].Number = 4728; + worksheet["D7"].Number = 943.89; + worksheet["E1"].Text = "Qtr2"; + worksheet["E2"].Number = 162.56; + worksheet["E3"].Number = 1249.2; + worksheet["E4"].Number = 1062.5; + worksheet["E5"].Number = 756; + worksheet["E6"].Number = 4547.92; + worksheet["E7"].Number = 349.6; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["C1:E7"]); + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Print Column's Index + Console.WriteLine("Column Index " + table1.Columns[0].Index); + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["D2:E8"].CellStyleName = "CurrencyFormat"; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + + + + + + Gets column id of current column. Read-only. + + + The following code illustrates how the of a particular column can be accessed using the property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["C1"].Text = "Products"; + worksheet["C2"].Text = "Alfreds Futterkiste"; + worksheet["C3"].Text = "Antonio Moreno Taqueria"; + worksheet["C4"].Text = "Around the Horn"; + worksheet["C5"].Text = "Bon app"; + worksheet["C6"].Text = "Eastern Connection"; + worksheet["C7"].Text = "Ernst Handel"; + worksheet["D1"].Text = "Qtr1"; + worksheet["D2"].Number = 744.6; + worksheet["D3"].Number = 5079.6; + worksheet["D4"].Number = 1267.5; + worksheet["D5"].Number = 1418; + worksheet["D6"].Number = 4728; + worksheet["D7"].Number = 943.89; + worksheet["E1"].Text = "Qtr2"; + worksheet["E2"].Number = 162.56; + worksheet["E3"].Number = 1249.2; + worksheet["E4"].Number = 1062.5; + worksheet["E5"].Number = 756; + worksheet["E6"].Number = 4547.92; + worksheet["E7"].Number = 349.6; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["C1:E7"]); + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Print Column ID + Console.WriteLine("Column ID " + table1.Columns[0].Id); + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["D2:E8"].CellStyleName = "CurrencyFormat"; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + + + + + + Gets or sets the function used for totals calculation. + + + is used to set formula in the last row for the column specified. Here for example, We set + to "True" to enable totals and set for second and third columns + to get sum of values in the respective columns. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C7"]); + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Total row + table1.ShowTotals = true; + table1.Columns[0].TotalsRowLabel = "Total"; + table1.Columns[1].TotalsCalculation = ExcelTotalsCalculation.Sum; + table1.Columns[2].TotalsCalculation = ExcelTotalsCalculation.Sum; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the label for the totals row. + + + property is used to set text in the last row of the column specfied. This will be displayed only if the + property is set to "true". Here for example, We set a string "Total" to the first column's property to indicate that + it's adjacent cell holds sum of the values of it's column. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C7"]); + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Total row + table1.ShowTotals = true; + table1.Columns[0].TotalsRowLabel = "Total"; + table1.Columns[1].TotalsCalculation = ExcelTotalsCalculation.Sum; + table1.Columns[2].TotalsCalculation = ExcelTotalsCalculation.Sum; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the calculated formula value. + + + If we want to set a column to hold results of calculation using data from some other columns in a table then we can make use of + property. Here for example, we set a formula to third column to hold the sum of first and second column's data. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + worksheet["D1"].Text = "Sum"; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:D8"].CellStyleName = "CurrencyFormat"; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:D7"]); + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Set formula + table1.Columns[3].CalculatedFormula = "=sum([@" + table1.Columns[1].Name + "]+[@" + table1.Columns[2].Name + "])"; + + //Apply AutoFit + worksheet["A1:D8"].AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Gets query table field id associated with this column. Read-only. + + + If table is added using method then query is used to fetch data + for table. Here for example, We create table with data queried from MS Access DB file. The created table's field id can be accessed using + property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set Connection string for DataSource + string ConnectionString = "OLEDB;Provider=Microsoft.JET.OLEDB.4.0;Password=\"\";User ID=Admin;Data Source=AccessDB.mdb"; + + //Add a connection to the workbook + IConnection Connection = workbook.Connections.Add("Connection1", "Sample connection with MsAccess", ConnectionString, "", ExcelCommandType.Sql); + + //Add a QueryTable to sheet object + IListObject table = worksheet.ListObjects.AddEx(ExcelListObjectSourceType.SrcQuery, Connection, worksheet.Range["A1"]); + + //Set Command Text for the Connection + table.QueryTable.CommandText = "Select * from tbltest"; + + //Set connection description + Connection.Description = "Sample Connection"; + + // Import data to the sheet from the database + table.Refresh(); + + //Get Query table field ID + Console.WriteLine(table.Columns[1].QueryTableFieldId); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //2 + + + + + + Default regular expression options. + + + + + Indicates whether the column contains array formula + + + + + XML mapping id. + + + + + Sub-element path. + + + + + Represents Xml column unique name. + + + + + Column datatype. + + + + + Initializes new instance of the class. + + Column name. + Column index. + Parent table object. + + + + Find Column Index. + + Listobject Range. + + + + Sets Name + + + + + Set Total row function. + + Function to set. + + + + Set Total row label. + + Label to set. + + + + Set calculated formula. + + formula to set. + + + + Updated all the table formulas. + + Old cell value. + New cell value. + + + + Creates a copy of the current column. + + New parent table for the column + + + + + Adds the ListObject column name to named ranges for enabling CalcEngine to calculate table formulas + + + + + Indicate whether column name is modified + + + + + Gets or sets name of the column. + + + + + Gets column index. + + + + + Gets or sets function used for totals calculation. + + + + + Get the total cell for the column. + + + + + Get the header cell for the column. + + + + + Gets or sets ccolumn id. + + + + + Gets calculated formula value. + + + + + Calculated formula Ptgs array. + + + + + Gets parent workbook. + + + + + Gets query table field id associated with this column. + + + + + XML mapping id. + + + + + Sub-element path. + + + + + Column datatype. + + + + + Gets or sets Xml column unique name. + + + + + Indicates whether the column contains array formula + + + + + Represents collection of table in the worksheet. + + + + + Represents collection of in the worksheet. + + + + + Creates a table with specified name and its data range. Adds it to the collection. + + Represents the name of the table. + Represents the data range of the table. + Returns a with the specified name and range. + + To know more about tables refer Working with Tables + + + To create table using data from external sources method can be used. + The following code illustrates how a table can be created in a worksheet using data in the worksheet. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create table + IListObject table1 = worksheet.ListObjects.Create("Table1", worksheet["A1:C7"]); + + //Apply builtin style + table1.BuiltInTableStyle = TableBuiltInStyles.TableStyleMedium9; + + //Total row + table1.ShowTotals = true; + table1.Columns[0].TotalsRowLabel = "Total"; + table1.Columns[1].TotalsCalculation = ExcelTotalsCalculation.Sum; + table1.Columns[2].TotalsCalculation = ExcelTotalsCalculation.Sum; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Creates a query table with specified connection and its source type. Adds it to the collection. + + Represents connection source type. + Represents the connection of the table. + Represents destination Range for the query table. + Returns a with the specified connections. + + To know more about importing data to table refer + Create a Table from External Connection + + + The following code illustrates how a table can be created using data from external connection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set Connection string for DataSource + string ConnectionString = "OLEDB;Provider=Microsoft.JET.OLEDB.4.0;Password=\"\";User ID=Admin;Data Source=AccessDB.mdb"; + + //Add a connection to the workbook + IConnection Connection = workbook.Connections.Add("Connection1", "Sample connection with MsAccess", ConnectionString, "", ExcelCommandType.Sql); + + //Add a QueryTable to sheet object + IListObject table = worksheet.ListObjects.AddEx(ExcelListObjectSourceType.SrcQuery, Connection, worksheet.Range["A1"]); + + //Set Command Text for the Connection + table.QueryTable.CommandText = "Select * from tbltest"; + + //Set connection description + Connection.Description = "Sample Connection"; + + // Import data to the sheet from the database + table.Refresh(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Removes a table from the worksheet. + + ListObject to be removed + true if table is successfully removed; otherwise, false. + + Following code illustrates how to remove a table from the worksheet. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets["Database"]; + + IListObjects listObjects = worksheet.ListObjects; + + IListObject table = listObjects[0]; + + listObjects.Remove(table); + + workbook.SaveAs("output.xlsx"); + } + + + + + + Removes a table from the worksheet at the specified index. + + Index of the ListObject to be removed + + Following code illustrates how to remove a table from the worksheet from using specified index. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets["Database"]; + + IListObjects listObjects = worksheet.ListObjects; + + listObjects.RemoveAt(0); + + workbook.SaveAs("output.xlsx"); + } + + + + + + Initializes a new instance of ListObjectCollection class. + + Sheet to which this collection belongs to. + + + + Creates a table with specified name and its data range. Adds it to the collection. + + Represents the name of the table. + Represents the data range of the table. + Returns a List object with the specified name and range. + + Following code illustrates how to create a table. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx", ExcelOpenType.Automatic); + IWorksheet worksheet = workbook.Worksheets[0]; + + // Create Table with data in the given range + IListObject table = worksheet.ListObjects.Create("Table1", worksheet["A1:C8"]); + + string fileName = "Output.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Check the list object range is overlab the another table or pivot table + + Range in which the IListObject is present. + + + + Checks whether the range is appropriate. + + + + + + + Creates copy of the current collection. + + Parent worksheet for the new collection. + Created collection. + + + + Creates a query table with specified connection and its source type. Adds it to the collection. + + Represents connection source type. + Represents the connection of the table. + Represents destination Range for the query table. + Returns a List object with the specified connections. + + Following code illustrates how to create a table with an external connections. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + // Database path + string dataPath = Path.GetFullPath(@"c:\company\DB\TestDB.mdb"); + + // Connection string for DataSource + string ConnectionString = "OLEDB;Provider=Microsoft.JET.OLEDB.4.0;Password=\"\";User ID=Admin;Data Source=" + dataPath; + + // Adding a connection to the workbook + IConnection Connection = workbook.Connections.Add("Connection1", "Sample connection with MsAccess", ConnectionString, "", ExcelCommandType.Sql); + // Adding a QueryTable to sheet object + worksheet.ListObjects.AddEx(ExcelListObjectSourceType.SrcQuery, Connection, worksheet.Range["A1"]); + // Command Text for the Connection + worksheet.ListObjects[0].QueryTable.CommandText = "Select * from tblTest"; + // The Query performs Asynchronous action + worksheet.ListObjects[0].QueryTable.BackgroundQuery = true; + // The Query Table is refreshed when the Workbook is opened + worksheet.ListObjects[0].QueryTable.RefreshOnFileOpen = true; + // Represents the connection description + Connection.Description = "Sample Connection"; + // Import data to the sheet from the database + worksheet.ListObjects[0].Refresh(); + // Auto-fits the columns + worksheet.UsedRange.AutofitColumns(); + + string fileName = "Output.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Adds the table name to the defined names in the workbook. + + Table object. + + + + Removes a table from the worksheet. + + ListObject to be removed + true if table is successfully removed; otherwise, false. + + Following code illustrates how to remove a table from the worksheet. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets["Database"]; + + IListObjects listObjects = worksheet.ListObjects; + + IListObject table = listObjects[0]; + + listObjects.Remove(table); + + workbook.SaveAs("output.xlsx"); + } + + + + + + Removes a table from the worksheet at the specified index. + + Index of the ListObject to be removed + + Following code illustrates how to remove a table from the worksheet from using specified index. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets["Database"]; + + IListObjects listObjects = worksheet.ListObjects; + + listObjects.RemoveAt(0); + + workbook.SaveAs("output.xlsx"); + } + + + + + + Returns table object with the given name. Read-only. + + Name of the table. + Table object with the given name. + + + + Represents Worksheet Helper + + + + + Indicates if there is formula record. + + Worksheet to get data for. + Represents row index. + Represents column index. + Indicates whether cell contains formula record. + + + + Returns row from the collection or creates one if necessary. + + Worksheet to get row from. + Zero-based row index. + Indicates whether to create row if it doesn't exist. + Desired row object. + + + + Gets row information. + + One-based row index. + Row information. + + + + Updates FirstColumn and LastColumn indexes. + + Column that was accessed. + + + + Updates FirstRow and LastRow indexes. + + Row to access. + + + + This class is responsible for combo box parsing. + + + + + This class is responsible for vml shape and shape type parsing. + + + + + Extracts shape type settings from the reader and creates shape with default settings. + + XmlReader to get general shape settings from. + Parent worksheet for the shape. + + Shape with default settings without adding it to any collection. + + + + + Parses shape and adds it to all necessary shapes collections. + + XmlReader to get shape from. + Default shape that must be cloned to get resulting shape. + Corresponding relations collection. + Path to the parent item (item which holds all these xml tags). + + + + Saves current node into stream. + + Reader to get node from. + Stream with current node's data. + + + + Saves current node into stream. + + Reader to get node from. + Stream with current node's data. + + + + Reads node from the stream and writes it into XmlWriter. + + Writer to write node into. + Stream to get node from. + + + + Reads node from the stream and writes it into XmlWriter. + + Writer to write node into. + Stream to get node from. + + + + Parses shape's anchor. + + XmlReader to get anchor information from. + Shape to set anchor to. + + + + Splits style into properties dictionary. + + Value to split. + Dictionary with properties, key - property name, value - property value. + + + + Creates shape with default settings + + Worksheet Shape Collection + Shape with default settings + + + + Parse the Path list of the free form geometry (Custom geometry). + + XmlReader to extract data from. + Path list to add the extracted data to. + + + + Parse elements in the free form shape's path list. + + XmlReader to extract data from. + Path to set the extract data to. + + + + Parse path point information from the free form shape's path list. + + XmlReader to extract data from. + Path element list to preserve the extracted data to. + + + + Extracts shape type settings from the reader and creates shape with default settings. + + XmlReader to get general shape settings from. + Parent worksheet for the shape. + + Shape with default settings without adding it to any collection. + + + + + Parses shape and adds it to all necessary shapes collections. + + XmlReader to get shape from. + Default shape that must be cloned to get resulting shape. + Corresponding relations collection. + Path to the parent item (item which holds all these xml tags). + + + + Parses client data tag and all its internal tags. + + Reader to get necessary values from. + Shape to parse client data for. + + + + Registers shape in all necessary collections. + + Shape to register. + + + + Creates shape with default settings + + Worksheet Shape Collection + Shape with default settings + + + + Class used to parse option button in Excel 2007 xml format. + + + + + Class used to parse Textbox. + + + + + Hold the Enum shape line style and excel + line style representation + + + + + hold the enum dash style and excel + dash style representation + + + + + Adds list of Shape line style + + + + + Adds the list of shape dash style + + + + + Gradient center shadding option is parsed and serailized by the + "GradientRadial" attribute value, this is not in Enum ExcelGradientStyle + so this property hold this value temporarly + + + + + Parses shape and adds it to all necessary shapes collections. + + XmlReader to get shape from. + Default shape that must be cloned to get resulting shape. + Corresponding relations collection. + Path to the parent item (item which holds all these xml tags). + + + + Parses text box name and divisions + + Reader to get data from. + Text box to parse. + + + + Parses division element + + Reader to get data from. + Text box to parse. + + + + Extracts single formatting run (text + font) from the reader. + + Reader to get text data from. + Text box shape to put extracted data into. + + + + Checks the font element. + + The font reader. + + + + + Registers shape in all necessary collections. + + Shape to register. + + + + Parses client data tag and all its internal tags. + + Reader to get necessary values from. + Shape to parse client data for. + + + + Tries to parse unknown client data tag. + + Reader to get data from. + Shape to put data into. + + + + Extracts boolean value from the reader. When element is empty - default value is used. + + XmlReader to get value from. + Default value to use. + Value containing parsed boolean value if there is any or default one if tag is empty. + + + + This method parses fill color types + + XmlReader to parse fill color from. + TextBox to set fill color to. + relation Collection of the item + path of the item + + + + Parse the solid color + + XmlReader to parse fill color from. + TextBox to set fill color to. + + + + Parse the Graident fills One Color,Two Color and Presets + + XmlReader to parse fill color from. + TextBox to set fill color to. + + + + This method parses Texture fill attribute. + + XmlReader to extract fill color from. + TextBox to set fill color to. + relation Collection of the item + path of the item + + + + This method parses Pattern fill attribute. + + XmlReader to extract fill color from. + TextBox to set fill color to. + relation Collection of the item + path of the item + + + + This method parses Picture fill attribute. + + XmlReader to extract fill color from. + TextBox to set fill color to. + relation Collection of the item + path of the item + + + + Parse Gradient Shading, Variants and Transparency + + XmlReader to parse fill color from. + TextBox to set fill color to. + + + + Parse the border Line of the shape + + XmlReader to parse fill color from. + TextBox to set fill color to. + relation Collection of the item + path of the item + + + + Parse Pattern Line + + XmlReader to parse fill color from. + TextBox to set fill color to. + relation Collection of the item + path of the item + + + + Parses style attribute of the comment shape. + + Reader to get attribute data from. + Comment shape to set values to. + + + + Parses style properties. + + Textbox to put properties into. + String representation of the style properties + (key - property name, value - property value). + + + + Parses TextDirection property comment style property. + + TextBox to set TextRotation for. + Dictionary with comment properties. + + + + Checks whether the given color is indexed or not + + color + color representation + + + + Extract the string color to ColorObject + + color + colorobject from string + + + + Indicates whether the string is Hexadecimal or not. + + Hexadecimal string. + Returns true if the string is Hexadecimal + + + + Extract the opacity double value from string value + + opacity value in string + double value from excel opacity + + + + Removes char at the first or last of the given string + + source string + indicates whether remove char at last or first + remove character at given position + + + + Extract the Gradient Color Type + + reader to parse + enum gradient color + + + + Extract the darkness or lightness value of one color gradient + for one color2 attribute contains darkness or lightness value + + string color2 attribute value + degree double from string + + + + Extract the preset value from the resource file. + + preset in excel format + preset in Enum + + + + Extract the Pattern value from the resource file. + + + + + + + Extract the Shading Variants + + focus is an angle in string + Variant in Enum + + + + Extract the Texture Name from the title string + + Texture name in string + texture in enum + + + + Extract the Pattern Name + + Patterns color string + pattern in enum + + + + Extract Dash style from enum + + dash style to enum + dash style in enum + + + + Exctract the line style from enum + + line style to extract + line style in enum + + + + Gradient center shadding option is parsed and serailized by the + "GradientRadial" attribute value, this is not in Enum ExcelGradientStyle + so this property hold this value temporarly + + + + + Extracts shape type settings from the reader and creates shape with default settings. + + XmlReader to get general shape settings from. + Parent worksheet for the shape. + Shape with default settings without adding it to any collection + + + + Tries to parse unknown client data tag. + + Reader to get data from. + Shape to put data into. + + + + Registers shape in all necessary collections. + + Shape to register. + + + + Creates shape with default settings + + Worksheet Shape Collection + Shape with default settings + + + + This class is used for vml form controls parsing. + + + + + Dictionary of all found shape types. Key - shape type id, value - shape type stream. + + + + + Dictinary with all supported shape parsers. Key - shape type, Value - shape parser to parse shape. + + + + + Initializes static members. + + + + + Extracts shape type settings from the reader and creates shape with default settings. + + XmlReader to get general shape settings from. + Parent worksheet for the shape. + + Shape with default settings without adding it to any collection. + + + + + Parses shape and adds it to all necessary shapes collections. + + XmlReader to get shape from. + Default shape that must be cloned to get resulting shape. + Corresponding relations collection. + Path to the parent item (item which holds all these xml tags). + + + + Creates shape with default settings + + Worksheet Shape Collection + Shape with default settings + + + + This class is responsible for table parsing. + + + + + Extracts specified list object from XmlReader. + + XmlReader to get table from. + Worksheet to put extracted table into. + + + + Extracts extension list from the table. + + XmlReader to get data from. + Table to put extracted data into. + + + + Extracts extension from the table. + + XmlReader to get data from. + Table to put extracted data into. + + + + Extracts autofilter part of the table. + + XmlReader to get data from. + Table to put extracted data into. + + + + Extracts table style settings. + + XmlReader to get style settings from. + Table to put extracted style settings into. + + + + Extracts all columns of the table. + + XmlReader to get columns data from. + List with columns to serializes. + + + + Extracts single column. + + XmlReader to get data from. + Columns collection to put extracted column into. + Extracted column. + + + + Get XmlMapping properties from the table column. + + XML reader. + Table column object. + + + + Extracts single query field. + + XmlReader to get data from + Table column to which the query field is bound with + Query table associated with the query field + + + + + Represents the TextSettings + + + + + Font name. + + + + + Underline style. + + + + + Font size. + + + + + Value indicating whether font is bold. + + + + + Value indicating whether text + + + + + Value indicating whether text is striked. + + + + + Language used to display text. + + + + + Font color. + + + + + Represents the baseline properties + default -1, it was non negative on chart style + + + + + Has Latin + + + + + Has Complex Scripts + + + + + Has East and Asian Font + + + + + Actual Font + + + + + Show Title Bold + + + + + Specifies the minimum font size at which character kerning occurs for this text run. + default -1, it was non negative on chart style + + + + + Specifies the spacing between characters within a text run. + default -1, it was non negative + + + + + Represents File Version + + + + + Application Name + + + + + Build Version + + + + + Last Edited + + + + + Lowest Edited + + + + + Code Name + + + + + This class is responsible for combo box serialization in Excel 2007 format. + + + + + This method serializes specified shape into specified writer. + + XmlWriter to serialize shape settings into. + Shape to serialize. + Parent worksheet data holder. + + + + This method serializes general shape settings (shape type) into specified XmlWriter. + + XmlWriter to write shape type into. + Type of the shape that is going to be serialized. + + + + Serializes client data. + + XmlWriter to serialize data into. + Shape to serialize client data for. + + + + Class used for serializing Option button. + + + + + Class used for serializing text box. + + + + + Default shape style constant. + + + + + This method serializes general shape settings (shape type) into specified XmlWriter. + + XmlWriter to write shape type into. + Type of the shape that is going to be serialized. + + + + Serializes subnodes of the shapetype description. + + Writer to serialize into. + + + + This method serializes specified shape into specified writer. + + XmlWriter to serialize shape settings into. + Shape to serialize. + Parent worksheet data holder. + + + + Serializes attributes of the shape tag if necessary. + + XmlWriter to serialize into. + Shape to serialize for. + + + + Serializes subnodes of the shape tag. + + XmlWriter to serialize into. + Shape to serialize for. + + + + Serializes shadow settings. + + XmlWriter to serialize into. + Shape to serialize for. + + + + Serialize internal part of the div object. + + XmlWriter to serialize into. + Shape to serialize. + + + + Serializes style attribute for the text box shape. + + Writer to serialize into. + Shape to serialize style attribute for. + + + + Serializes shape's style. + + XmlWriter to serialize into. + Shape to serialize style for. + + + + Adds required style properties to the list in the format 'name':'value'. + + List to add properties to. + Shape to prepare styles for. + + + + Serialize client Additional Data + + XmlWriter to serialize into. + Shape to serialize style for. + + + + Gets instance of the shape object. Read-only. + + + + + Gets string representation of the shape type. Read-only. + + + + + Serializes additional tag into ClientData tag. + + XmlWriter to serialize into. + Shape to serialize for. + + + + Serialize internal part of the div object. + + XmlWriter to serialize into. + Shape to serialize. + + + + Serializes subnodes of the shapetype description. + + Writer to serialize into. + + + + + + XmlWriter to serialize fill color from. + shae to set fill color to. + relation Collection of the item + path of the item + + + + Returns instance number of supported shape object. Read-only. + + + + + Returns string representation of the shape type. Read-only. + + + + + Vml Bitmap Serializator + + + + + This class is responsible for header/footer image serialization. + + + + + Collection of picture item along with its BlipID. + + + + + Initializes a new instance of HFimageSerializator Class. + + + + + Removes all the items of the dictionary. + + + + + String that formulas for HF images. + + + + + This method serializes specified shape into specified writer. + + XmlWriter to serialize shape settings into. + Shape to serialize. + Parent worksheet data holder. + + + + Gets width of the shape. + + + + + + + Gets height of the shape. + + + + + + + This method serializes general shape settings (shape type) into specified XmlWriter. + + XmlWriter to write shape type into. + Type of the shape that is going to be serialized. + + + + Serializes imageData xml tag. + + XmlWriter to serialize into. + Shape to get data to serialize from. + Parent worksheet data holder. + + + + This method is used to serialize picture item. + + Shape to serialize. + String value containing relation id. + Parent worksheet data holder. + Relation id for the serialized shape + + + + This method is used to serialize picture item. + + Shape to serialize. + String value containing relation id. + Parent worksheet data holder. + Relation id for the serialized shape + + + + Serialize + + + + + + + + + Serialize Additional Client Data + + + + + + + This method is used to serialize picture item. + + Shape to serialize. + String value containing relation id. + Parent worksheet data holder. + Relation id for the serialized shape + + + + Contains dictionary with supported serializator types. + + + + + + + + Type of the shape that is going to be serialized. + + + + This class is responsible for table object serialization in Excel 2007 xml format. + + + + + Serializes specified list object inside XmlWriter. + + XmlWriter to serialize into. + Table to serialize. + + + + Serializes the table extension list. + + XmlWriter to serialize into. + Table to serialize. + + + + Serializes autofilter part of the table. + + XmlWriter to serialize into. + Table to serialize. + + + + Serializes table style settings. + + XmlWriter to serialize style settings into. + Table to serializes style settings for. + + + + Serializes all columns of the table. + + XmlWriter to serialize into. + List with columns to serializes. + + + + Serializes single column. + + XmlWriter to serializes into. + Column to serialize. + + + + This class contains unique pair of shape instance and shape type. + + + + + Represents internal worksheet object. It can be internal or external. + + + + + Represents a worksheet in a workbook. + + + + + Represents worksheet and chartsheet tab in Excel. + + + + + Activates the sheet which is equivalent to clicking the sheet's tab. + + + Following code illustrates how to activate a sheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + ITabSheet sheet = workbook.Worksheets[1]; + + // Activates the sheet + sheet.Activate(); + + workbook.SaveAs("Activate.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Selects the tab sheet. + + + Following code illustrates how to select the sheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + ITabSheet sheet = workbook.Worksheets[1]; + + // Selects the sheet + sheet.Select(); + + workbook.SaveAs("Select.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Removes the selection from the sheet. + + + Following code illustrates how to remove the selection from the sheet + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + ITabSheet sheet = workbook.Worksheets[1]; + + // Removes the selection from the sheet. + sheet.Unselect(); + + workbook.SaveAs("Unselect.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Protects a sheet with specified password so that it cannot be modified. + + Represents a password to protect with. + + Following code illustrates how to protect the sheet + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + ITabSheet sheet = workbook.Worksheets[0]; + + // Protect the sheet + sheet.Protect("Syncfusion"); + + workbook.SaveAs("Protect.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Protects a sheet with specified password and so that it cannot be modified. + + Represents a password to protect. + Represents sheet protection option. + + Following code illustrates how to protect the sheet with Excel sheet protection option. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + ITabSheet sheet = workbook.Worksheets[0]; + + // Protect the sheet + sheet.Protect("Syncfusion"); + + workbook.SaveAs("Protect.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Removes protection from a sheet. This method has no effect if the sheet or workbook isn't protected. + + Password to unprotect. + + Following code illustrates how to remove the protection from the sheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + ITabSheet sheet = workbook.Worksheets[0]; + + // Unprotect the sheet + sheet.Unprotect("Syncfusion"); + + workbook.SaveAs("UnProtect.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets or sets the tab color of the sheet. + + + + + Gets or sets the tab color RGB of the sheet. + + + + + Gets a charts collection in the sheet. Read-only. + + + + + Gets the collection in the sheet. Read-only. + + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add picture + worksheet.Pictures.AddPicture("Image.png"); + + //Get picture + IPictureShape picture = worksheet.Pictures[0]; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets the parent workbook of the sheet. Read-only. + + + + + Gets the collection in the sheet. Read-only. + + + The following code illustrates how to access the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shapes + worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 5, 5, 40, 100); + + //Check count + Console.Write(worksheet.Shapes.Count); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //2 + + + + + + Gets or sets a Boolean value indicating whether sheet is displayed right to left. + + + + + Gets a Boolean value indicating whether tab of the sheet is selected. Read-only. + + + + + Gets the index number of the sheet within the tabsheets collection. Read-only. + + + + + Gets or sets the name of the sheet. + + + + + Gets or sets the control visibility of sheet to end user. + + + + + Gets a collection with all inside the sheet. Read-only. + + + The following code illustrates how to access collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add textbox + ITextBoxShape textbox1 = worksheet.TextBoxes.AddTextBox(1, 1, 20, 100); + ITextBoxShape textbox2 = worksheet.TextBoxes.AddTextBox(5, 5, 20, 100); + + //Set name + textbox1.Name = "TextBox1"; + textbox2.Name = "TextBox2"; + + //Get count + Console.Write(worksheet.TextBoxes.Count); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //2 + + + + + + Gets the collection with all inside the sheet. Read-only. + + + The following code illustrates how to access collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add combobox + worksheet.CheckBoxes.AddCheckBox(1, 1, 20, 100); + worksheet.CheckBoxes.AddCheckBox(5, 5, 20, 100); + + //Check count + Console.Write(worksheet.CheckBoxes.Count); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //2 + + + + + + Gets the collection with all inside the sheet. Read-only. + + + The following code illustrates how to access the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add option button + worksheet.OptionButtons.AddOptionButton(1, 1, 20, 100); + worksheet.OptionButtons.AddOptionButton(5, 5, 20, 100); + + //Get count + Console.Write(worksheet.OptionButtons.Count); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //2 + + + + + + Gets the collection with all inside the sheet. Read-only. + + + The following code illustrates how to access the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add combobox + IComboBoxShape combobox1 = worksheet.ComboBoxes.AddComboBox(1, 1, 20, 100); + IComboBoxShape combobox2 = worksheet.ComboBoxes.AddComboBox(5, 5, 20, 100); + + //Get count + Console.Write(worksheet.ComboBoxes.Count); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //2 + + + + + + Gets the name used by macros to access workbook items. Read-only. + + + + + Gets a Boolean value indicating whether content in the sheet is protected. Read-only. + + + + + Gets a Boolean value indicating whether drawing objects in the sheet is protected. Read-only. + + + + + Gets a Boolean value indicating whether scenarios in the sheet is protected. Read-only. + + + + + Gets protected options. Read-only. For sets protection options use "Protect" method. + + + + + Gets a Boolean value indicating whether sheet is protected with a password. Read-only. + + + + + Gets or sets the value that represents zoom factor of document. Value must be in range from 10 till 400. + + + + + Enables the calculation support. + + Enabling this method will initialize objects and retrieves calculated values of formulas in a worksheet. + + The following code illustrates how to enable the sheet calculation. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.EnableSheetCalculations(); + + + + + + Disables the calculation support in this workbook and disposes of the associative objects. + + The following code illustrates how to disable the sheet calculation. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.DisableSheetCalculations(); + + + + + + Copies worksheet data to the clipboard. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Clears the worksheet data, formats and merged cells. + + + + + Clears the worksheet data. + + + + + Checks whether the specified cell is initialized or accessed. + + One-based row index. + One-based column index. + True if the cell is initialized or accessed by the user; otherwise, False. + The following code illustrates if the specified cells contains a value. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["A1"].Text = "Hello"; + worksheet.Contains(1, 1); + workbook.Version = ExcelVersion.Excel2013; + workbook.SaveAs("Output.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Creates a new instance of the . + + New instance of ranges collection. + The following code illustrates how to creates a RangeCollection. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Range["B3"].Number = 53.75; + worksheet.Range["B4"].Number = 52.85; + worksheet.Range["B5"].Number = 59.77; + worksheet.Range["B6"].Number = 96.15; + worksheet.Range["F1"].Number = 26.72; + worksheet.Range["F2"].Number = 33.71; + IRanges rangesOne = worksheet.CreateRangesCollection(); + rangesOne.Add(worksheet.Range["B3:B6"]); + rangesOne.Add(worksheet.Range["F1:F2"]); + + + + + + Creates a named ranges with the specified named range's value as a name for the specified range. + + Existing named ranged. + Address of the named range to be created. + True if the named range values are vertically placed in the sheet. + This method is used to access the discontinuous ranges. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + IName name = sheet.Names.Add("B1name",sheet["B1:D1"]); + sheet["B1"].Value = "B2name"; + sheet["C1"].Value = "C2name"; + sheet["D1"].Value = "D2name"; + sheet.CreateNamedRanges("B1name", "B2:D2", true); + + + + + + Create an instance of that can be used for template markers processing. + + Object that can be used for template markers processing. + + + + Returns True if the specified column is visible to end user. + + One-based column index. + True if column is visible; otherwise, False. + + + + Shows the specified column. + + Index at which the column should be hidden. + True - Column is visible; False - hidden. + + + + Hides the specified column. + + One-based column index. + + + + Hides the specified row. + + One-based row index. + + + + Returns True if the specified row is visible to end user. + + One-based row index. + True if row is visible; otherwise, False. + + + + Shows or Hides the specified row. + + Index at which the row should be hidden. + True - Row is visible; False - hidden. + + + + Shows or Hides the specified range. + + Range specifies the particular range to show / hide. + True - Row is visible; False - hidden. + + + + Shows or Hides the collection of range. + + Ranges specifies the range collection. + True - Row is visible; False - hidden. + + + + Shows or Hides an array of range. + + Ranges specifies the range array. + True - Row is visible; False - hidden. + + + + Inserts an empty row in the specified row index. + + Index at which new row should be inserted. + + + + Inserts an empty rows in the specified row index based on row count. + + Index at which new row should be inserted. + Number of rows to insert. + + + + Inserts an empty row in the specified row index with specified based on row count. + + Index at which new row should be inserted. + Number of rows to insert. + Insert options. + + + + Inserts an empty column for the specified column index. + + Index at which new column should be inserted. + + + + Inserts an empty column in the specified column index based on column count. + + Index at which new column should be inserted. + Number of columns to insert. + + + + Inserts an empty column in the specified column index with specified based on column count. + + Index at which new column should be inserted. + Number of columns to insert. + Insert options. + + + + Removes the specified row. + + One-based row index. + + + + Removes the specified number of rows from the given index. + + One-based row index. + Number of rows. + + + + Removes the specified column. + + One-based column index. + + + + Removes the specified number of columns from the given index. + + One-based column index. + Number of columns to remove. + + + + Imports an array of into a worksheet with specified alignment. + + + To know more about ImportArray refer this link + + Array of object. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + True if array should be imported vertically; False - horizontally. + Number of imported elements. + The following code illustrates how to Imports an array of into a worksheet with specified alignment. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize the Object Array + object[] array = new object[4] { "Total Income", "Actual Expense", "Expected Expenses", "Profit" }; + + //Import the Object Array to Sheet + worksheet.ImportArray(array, 1, 1, true); + + workbook.SaveAs("ImportArray.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Imports an array of values into a worksheet. + + + To know more about ImportArray refer this link + + Array of string value. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + True if array should be imported vertically; False - horizontally. + Number of imported elements. + The following code illustrates how to Imports an array of values into a worksheet with the specified row and column. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize the string Array + string[] arrayString = new string[4] { "Total Income", "Actual Expense", "Expected Expenses", "Profit" }; + + //Import the string Array to Sheet + worksheet.ImportArray(arrayString, 1, 1, true); + + workbook.SaveAs("ImportArray.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Imports an array of integer values into a worksheet. + + + To know more about ImportArray refer this link + + Array of int value. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + True if array should be imported vertically; False - horizontally. + Number of imported elements. + The following code illustrates how to Imports an array of integer values into a worksheet with the specified row and column. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize the integer Array + int[] arrayInt = new int[4] {1000, 2000, 3000, 4000}; + + //Import the integer Array to Sheet + worksheet.ImportArray(arrayInt, 1, 1, true); + + workbook.SaveAs("ImportArray.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Imports an array of values into a worksheet. + + + To know more about ImportArray refer this link + + Array of double value. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + True if array should be imported vertically; False - horizontally. + Number of imported elements. + The following code illustrates how to Imports an array of values into a worksheet with the specified row and column. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize the double Array + double[] arrayDouble = new double[4] { 344.0045, 345.0045, 346.0045, 347.0045 }; + + //Import the double Array to Sheet + worksheet.ImportArray(arrayDouble, 1, 1, true); + + workbook.SaveAs("ImportArray.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Imports an array of values into a worksheet. + + + To know more about ImportArray refer this link + + Array of datetime value. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + True if array should be imported vertically; False - horizontally. + Number of imported elements. + The following code illustrates how to Imports an array of values into a worksheet with the specified row and column. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize the DateTime Array + DateTime[] arrayDate = new DateTime[4] { DateTime.Parse("06:45"), DateTime.Parse("08:30"), DateTime.Parse("09:40"), DateTime.Parse("10:30") }; + + //Import the DateTime Array to Sheet + worksheet.ImportArray(arrayDate, 1, 1, true); + + workbook.SaveAs("ImportArray.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Imports data from a two-dimensional array of into a worksheet. + + + To know more about ImportArray refer this link + + Two-dimensional array of object. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + Number of imported rows. + The following code illustrates how to Imports a two-dimensional array of into a worksheet with the specified row and column. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize the Object Array + object[,] arrayTwoDimen = new object[3, 2] { { "AND", "OR" }, { "NAND", "XOR" },{ "NOR", "NOT" } }; + + //Import the Object Array to Sheet + worksheet.ImportArray(arrayTwoDimen, 1, 1); + + workbook.SaveAs("ImportArray.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Imports data from class objects into a worksheet with specified row and column. + + IEnumerable objects with desired data. + First row from where the data should be imported. + First column from where the data should be imported. + TRUE if class properties names must be imported. FALSE otherwise. + Number of imported rows. + To know more about ImportData refer this link + The following code illustrates how to Imports data from class objects into a worksheet with the specified row and column. + + using Syncfusion.XlsIO; + using System.Collections.Generic; + + class Example + { + static void Main() + { + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //The list of data is get from GetSalesReports method. Here GetSalesReports and Report are sample method and sample class. + IList<Report> reports = GetSalesReports(); + + //Import the data to worksheet + worksheet.ImportData(reports, 2, 1, false); + + workbook.SaveAs("ImportFromDT.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + public static List<Report> GetSalesReports() + { + List<Report> reports = new List<Report>(); + reports.Add(new Report("Andy Bernard", "45000", "58000")); + reports.Add(new Report("Jim Halpert", "34000", "65000")); + reports.Add(new Report("Karen Fillippelli", "75000", "64000")); + reports.Add(new Report("Phyllis Lapin", "56500", "33600" )); + reports.Add(new Report("Stanley Hudson", "46500", "52000")); + return reports; + } + } + public class Report + { + public string SalesPerson { get; set; } + public string SalesJanJun { get; set; } + public string SalesJulDec { get; set; } + + public Report(string name, string janToJun, string julToDec) + { + SalesPerson = name; + SalesJanJun = janToJun; + SalesJulDec = julToDec; + } + } + + + + + + Imports data from class objects into a worksheet with specified row and column along with import data options. + + IEnumerable object with desired data. + Import data options for when importing nested collection data. + Number of imported rows. + To know more about ImportData refer this link + The following code illustrates how to Imports data from class objects into a worksheet with the specified row and column. + + using Syncfusion.XlsIO; + using System.Collections.Generic; + + class Example + { + static void Main() + { + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //The list of data is get from GetFamilyDataList method. Here GetFamilyDataList and Family are sample method and sample class. + IList<Family> families = GetFamilyDataList(); + + //Import the data to worksheet + ExcelImportDataOptions importDataOptions = new ExcelImportDataOptions(); + importDataOptions.FirstRow = 1; + importDataOptions.FirstColumn = 1; + importDataOptions.IncludeHeader = true; + importDataOptions.IncludeHeaderParent = true; + importDataOptions.NestedDataLayoutOptions = ExcelNestedDataLayoutOptions.Merge; + importDataOptions.NestedDataGroupOptions = ExcelNestedDataGroupOptions.Collapse; + importDataOptions.CollapseLevel = 2; + + worksheet.ImportData(families, importDataOptions); + + workbook.SaveAs("ImportNestedData.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + private static IList<Family> GetFamilyDataList() + { + List<Family> list = new List<Family>(); + + // Create an object for the Husband class + Family f1 = new Family("Thomas Hardy", 50, "Catherine Dewey", 48); + + f1.Children = new List<Child>(); + f1.Children.Add(new Child("Thomas Anderson", 24)); + f1.Children.Add(new Child("Rachel Dawes", 18)); + f1.Children.Add(new Child("Dom Cobb", 25)); + + // Create another object for the Husband class + Family f2 = new Family("Philip Cramer", 54, "Maria Larsson", 50); + + f2.Children = new List<Child>(); + f2.Children.Add(new Child("Bernadette Maryann", 26)); + f2.Children.Add(new Child("Zack Johnson", 23)); + f2.Children.Add(new Child("Sheldon Cooper", 25)); + + list.Add(f1); + list.Add(f2); + return list; + } + } + + public class Family + { + private String m_HusbandName; + public String HusbandName + { + get { return m_HusbandName; } + set { m_HusbandName = value; } + } + private int m_HusbandAge; + public int HusbandAge + { + get { return m_HusbandAge; } + set { m_HusbandAge = value; } + } + private List<Child> m_Children; + public List<Child> Children + { + get { return m_Children; } + set { m_Children = value; } + } + + private string m_WifeName; + public string WifeName + { + get { return m_WifeName; } + set { m_WifeName = value; } + } + + private int m_WifeAge; + public int WifeAge + { + get { return m_WifeAge; } + set { m_WifeAge = value; } + } + public Family(string husbandName, int husbandAge, string wifeName, int wifeAge) + { + m_HusbandName = husbandName; + m_HusbandAge = husbandAge; + m_WifeName = wifeName; + m_WifeAge = wifeAge; + } + } + public class Child + { + private string m_name; + public string Name + { + get { return m_name; } + set { m_name = value; } + } + private int m_age; + public int Age + { + get { return m_age; } + set { m_age = value; } + } + public Child(string name, int age) + { + this.m_name = name; + this.m_age = age; + } + } + + + + + + Imports data from a into a worksheet. + + + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward. + To know more about ImportDataColumn refer this link + + DataColumn with desired data. + TRUE if column name must be imported. FALSE - Not imported. + First row from where the data should be imported. + First column from where the data should be imported. + Number of imported rows. + The following code illustrates how to Imports data from a into a worksheet with the specified row and column. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + System.Data.DataTable table = SampleDataTable(); + System.Data.DataColumn column = table.Columns[2]; + worksheet.ImportDataColumn(column, true, 1, 1); + workbook.SaveAs("ImportFromDC.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + System.Data.DataTable SampleDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add four DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + return table; + } + + + + + + Imports data from a into a worksheet. + + + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward. + To know more about ImportDataColumn refer this link + + DataColumn with desired data. + TRUE if column name must be imported. FALSE - Not imported. + First row from where the data should be imported. + First column from where the data should be imported. + + Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + + Number of imported rows. + The following code illustrates how to Imports data from a into a worksheet with the specified row and column. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + System.Data.DataTable table = SampleDataTable(); + System.Data.DataColumn column = table.Columns[2]; + worksheet.ImportDataColumn(column, true, 1, 1); + workbook.SaveAs("ImportFromDC.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + System.Data.DataTable SampleDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add four DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + return table; + } + + + + + + Imports data from Microsoft into worksheet. + + + This method is only supported in Windows Form platform. + To know more about ImportDataGrid refer this link + + DataGrid with datasource. + Represents the first row of the worksheet to import. + Represents the first column of the worksheet to import. + TRUE if header must be imported. FALSE otherwise. + TRUE if row style must be imported. FALSE otherwise. + The following code illustrates how to Imports data from Microsoft into worksheet with the specified row and column. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize DataGrid control + System.Windows.Forms.DataGrid dataGrid = new System.Windows.Forms.DataGrid(); + dataGrid.DataSource = GetDataTable(); + + //Import data from DataGrid control + worksheet.ImportDataGrid(dataGrid, 1, 1, true, true); + + workbook.SaveAs("ImportDataGrid.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + System.Data.DataTable GetDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add four DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + return table; + } + + + + + + Imports data from Microsoft into worksheet. + + + This method is supported in ASP.NET Web Forms only. + To know more about ImportDataGrid refer this link + + DataGrid with datasource. + Represents the first row of the worksheet to import. + Represents the first column of the worksheet to import. + TRUE if header must be imported. FALSE otherwise. + TRUE if row style must be imported. FALSE otherwise. + The following code illustrates how to Imports data from MS into worksheet with the specified row and column. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set value to the DataSource of DataGrid web control + System.Windows.Forms.DataGrid dataGrid = new System.Windows.Forms.DataGrid(); + dataGrid.DataSource = GetDataTable(); + dataGrid.DataBind(); + + //Import data from DataGrid control + worksheet.ImportDataGrid(dataGrid, 1, 1, true, true); + + workbook.SaveAs("ImportDataGrid.xlsx", ExcelSaveType.SaveAsXLS, Response, ExcelDownloadType.PromptDialog); + workbook.Close(); + excelEngine.Dispose(); + } + + System.Data.DataTable GetDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add four DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + return table; + } + + + + + + Imports data from Microsoft into worksheet. + + + This method is supported in ASP.NET Web Forms only. + To know more about ImportDataGrid refer this link + + GridView with datasource. + Represents the first row of the worksheet to import. + Represents the first column of the worksheet to import. + TRUE if header must be imported. FALSE otherwise. + TRUE if row style must be imported. FALSE otherwise. + The following code illustrates how to Imports data from MS into worksheet with the specified row and column. + + using Syncfusion.XlsIO; + using System; + using System.Data; + + public partial class Sample : System.Web.UI.Page + { + protected void Page_Load(object sender, EventArgs e) + { + GridView(); + } + + public void GridView() + { + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set value to the DataSource of GridView web control + gridView.DataSource = GetDataTable(); + gridView.DataBind(); + + //Import data from DataGrid control + worksheet.ImportGridView(gridView, 1, 1, true,true); + + workbook.SaveAs("ImportGridView.xlsx", ExcelSaveType.SaveAsXLS, Response, ExcelDownloadType.PromptDialog); + workbook.Close(); + excelEngine.Dispose(); + } + + static DataTable GetDataTable() + { + // Here we create a three columns + DataTable table = new DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add four DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + return table; + } + } + + + + + + Imports data from Microsoft into worksheet. + + + This method is only supported in Windows Form platform. + To know more about ImportDataGridView refer this link + + DataGridView with datasource. + Represents the first row of the worksheet to import. + Represents the first column of the worksheet to import. + TRUE if header must be imported. FALSE otherwise. + TRUE if row style must be imported. FALSE otherwise. + The following code illustrates how to Imports data from Microsoft into worksheet with the specified row and column. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize DataGridView control + System.Windows.Forms.DataGridView dataGridView = new System.Windows.Forms.DataGridView(); + + //Get the data from GetDataTable method. + dataGridView.DataSource = GetDataTable(); + + //Import data from DataGridView control + worksheet.ImportDataGridView(dataGridView, 1, 1, true, true); + + workbook.SaveAs("ImportDataGridView.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + System.Data.DataTable GetDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add four DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + return table; + } + + + + + + Imports data from a into a worksheet with specified row and column. + + + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward.. + To know more about ImportDataTable refer this link + + DataTable with desired data. + TRUE if column names must be imported. FALSE otherwise. + First row from where the data should be imported. + First column from where the data should be imported. + Number of imported rows. + The following code illustrates how to Imports data from a into a worksheet with specified row and column. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize DataTable and data get from SampleDataTable method + System.Data.DataTable table = SampleDataTable(); + + //Import data from DataTable + worksheet.ImportDataTable(table, true, 1, 1); + + workbook.SaveAs("ImportDataTable.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + System.Data.DataTable SampleDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add four DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + return table; + } + + + + + + Imports data from a into a worksheet with the specified row and column along with save option. + + + We request you to use this method to improve performance and reduce memory consumption while dealing with large data. + To know more about ImportDataTable refer this link. + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward. + + Data Table with desired data. + First row from where the data should be imported. + First column from where the data should be imported. + TRUE if data table must be serialized directly on save. + Number of imported rows. + The following code illustrates how to Imports data from a into a worksheet with the specified row and column along with save option. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize DataTable and data get from SampleDataTable method + System.Data.DataTable table = SampleDataTable(); + + //Import data from DataTable + worksheet.ImportDataTable(table, 1, 1, true); + + workbook.SaveAs("ImportDataTable.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + System.Data.DataTable SampleDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add four DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + return table; + } + + + + + + Imports data from a into a worksheet with the specified row and column along with save option. + + + We request you to use this method to improve performance and reduce memory consumption while dealing with large data. + To know more about ImportDataTable refer this link. + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward. + + Data Table with desired data. + First row from where the data should be imported. + First column from where the data should be imported. + TRUE if data table must be serialized directly on save. + TRUE if column names must be imported. + Number of imported rows. + The following code illustrates how to Imports data from a into a worksheet with the specified row and column along with save option. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize DataTable and data get from SampleDataTable method + System.Data.DataTable table = SampleDataTable(); + + //Import data from DataTable + worksheet.ImportDataTable(table, 1, 1, true, true); + + workbook.SaveAs("ImportDataTable.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + System.Data.DataTable SampleDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add four DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + return table; + } + + + + + + Imports data from a into a worksheet with specified row and column along with the preserve type. + + + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward. + To know more about ImportDataTable refer this link + + DataTable with desired data. + True if column names must be imported. FALSE otherwise. + First row from where the data should be imported. + First column from where the data should be imported. + + Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + + Number of imported rows. + The following code illustrates how to Imports data from a into a worksheet with specified row and column along with the preserve type. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize DataTable and data get from SampleDataTable method + System.Data.DataTable table = SampleDataTable(); + + //Import data from DataTable + worksheet.ImportDataTable(table, true, 1, 1, true); + + workbook.SaveAs("ImportDataTable.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + System.Data.DataTable SampleDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add four DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + return table; + } + + + + + + Imports data from a into a worksheet with the specified range. + + + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward. + To know more about ImportDataTable refer this link + + DataTable with desired data. + True if column names must be imported. FALSE otherwise. + First row from where the data should be imported. + First column from where the data should be imported. + Maximum number of rows to import. + Maximum number of columns to import. + Number of imported rows. + The following code illustrates how to Imports data from a into a worksheet with the specified range. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize DataTable and data get from SampleDataTable method + System.Data.DataTable table = SampleDataTable(); + + //Import data from DataTable + worksheet.ImportDataTable(table, true, 1, 1, 5, 2); + + workbook.SaveAs("ImportDataTable.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + System.Data.DataTable SampleDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add Ten DataRows. + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + table.Rows.Add(5, "Snacks", "Andrew"); + table.Rows.Add(6, "Perfume", "Thomos"); + table.Rows.Add(7, "Biscuit", "Stephen"); + table.Rows.Add(8, "Cake", "Jones"); + table.Rows.Add(9, "Fruit", "Yabes"); + table.Rows.Add(10, "vegetable", "Marsion"); + return table; + } + + + + + + Imports data from a into a worksheet with specified range along with preserve type. + + + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward. + To know more about ImportDataTable refer this link + + DataTable with desired data. + True if column names must be imported. FALSE otherwise. + First row from where the data should be imported. + First column from where the data should be imported. + Maximum number of rows to import. + Maximum number of columns to import. + + Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + + Number of imported rows. + The following code illustrates how to Imports data from a into a worksheet with specified range along with preserve type. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize DataTable and data get from SampleDataTable method + System.Data.DataTable table = SampleDataTable(); + + //Import data from DataTable + worksheet.ImportDataTable(table, true, 1, 1, 5, 2 , true); + + workbook.SaveAs("ImportDataTable.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + System.Data.DataTable SampleDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add Ten DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + table.Rows.Add(5, "Snacks", "Andrew"); + table.Rows.Add(6, "Perfume", "Thomos"); + table.Rows.Add(7, "Biscuit", "Stephen"); + table.Rows.Add(8, "Cake", "Jones"); + table.Rows.Add(9, "Fruit", "Yabes"); + table.Rows.Add(10, "vegetable", "Marsion"); + return table; + } + + + + + + Imports data from into the specified named range of current worksheet. + + + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward. + To know more about ImportDataTable refer this link + + Data Table with desired data. + + Represents named range . Bounds of data table should not greatfull than bounds of named range. + i.e., Example NamedRange["A1:F6"] have a 6 Rows and 6 Columns. Also we should have DataTable rows and columns also same or less than named range. + + TRUE if column names must be imported. FALSE otherwise. + Number of imported rows. + The following code illustrates how to Imports data from into a worksheet with specified named range. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize named range + IName namedRange = worksheet.Names.Add("SampleInfo"); + namedRange.RefersToRange = worksheet.Range["A1:F6"]; + + //Initialize DataTable and data get from SampleDataTable method + System.Data.DataTable table = SampleDataTable(); + + //Import data from DataTable + worksheet.ImportDataTable(table, namedRange, true); + + workbook.SaveAs("ImportDataTable.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + System.Data.DataTable SampleDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add four DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + return table; + } + + + + + + Imports data from into the specified named range of current worksheet with row and column offset. + + + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward. + To know more about ImportDataTable refer this link + + Data Table with desired data. + + Represents named range . Bounds of data table should not greatfull than bounds of named range. + i.e., Example NamedRange["A1:F6"] have a 6 Rows and 6 Columns. Also we should have DataTable rows and columns also same or lessthan named range. + + TRUE if column names must also be imported. FALSE otherwise. + Represents row offset into named range to import. + Represents column offset into named range to import. + Number of imported rows. + The following code illustrates how to Imports data from into the specified named range of current worksheet with row and column offset. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize named range + IName namedRange = worksheet.Names.Add("SampleInfo"); + namedRange.RefersToRange = worksheet.Range["A1:F6"]; + + //Initialize DataTable and data get from SampleDataTable method + System.Data.DataTable table = SampleDataTable(); + + //Import data from DataTable + worksheet.ImportDataTable(table, namedRange, true, 1, 3); + + workbook.SaveAs("ImportDataTable.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + System.Data.DataTable SampleDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add four DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + return table; + } + + + + + + Imports data from into the specified named range of current worksheet with row and column offset. + + + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward. + To know more about ImportDataTable refer this link + + DataTable with desired data. + + Represents named range using enumeration. Bounds of data table should not greatfull than bounds of named range. + i.e., Example NamedRange["A1:F6"] have a 6 Rows and 6 Columns. Also we should have DataTable rows and columns also same or lessthan named range. + + TRUE if column names must be imported. FALSE otherwise. + Represents row offset into named range to import. + Represents column offset into named range to import. + Maximum number of rows to import. + Maximum number of columns to import. + Number of imported rows. + The following code illustrates how to Imports data from into the specified named range of current worksheet with row and column offset also with maximum rows and columns. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize named range + IName namedRange = worksheet.Names.Add("SampleInfo"); + namedRange.RefersToRange = worksheet.Range["A1:F16"]; + + //Initialize DataTable and data get from SampleDataTable method + System.Data.DataTable table = SampleDataTable(); + + //Import data from DataTable + worksheet.ImportDataTable(table, namedRange, true, 1, 1, 5, 2); + + workbook.SaveAs("ImportDataTable.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + System.Data.DataTable SampleDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add Ten DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + table.Rows.Add(5, "Snacks", "Andrew"); + table.Rows.Add(6, "Perfume", "Thomos"); + table.Rows.Add(7, "Biscuit", "Stephen"); + table.Rows.Add(8, "Cake", "Jones"); + table.Rows.Add(9, "Fruit", "Yabes"); + table.Rows.Add(10, "vegetable", "Marsion"); + return table; + } + + + + + + Imports data from into the specified named range of current worksheet with row and column offset along with preserve type option. + + + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward. + To know more about ImportDataTable refer this link + + DataTable with desired data. + + Represents named range using enumeration. Bounds of data table should not greatfull than bounds of named range. + i.e., Example NamedRange["A1:F6"] have a 6 Rows and 6 Columns. Also we should have DataTable rows and columns also same or lessthan named range. + + TRUE if column names must be imported. FALSE otherwise. + Represents row offset into named range to import. + Represents column offset into named range to import. + Maximum number of rows to import. + Maximum number of columns to import. + + Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + + Number of imported rows. + The following code illustrates how to Imports data from into the specified named range of current worksheet with row and column offset also with maximum rows and columns. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize named range + IName namedRange = worksheet.Names.Add("SampleInfo"); + namedRange.RefersToRange = worksheet.Range["A1:F16"]; + + //Initialize DataTable and data get from SampleDataTable method + System.Data.DataTable table = SampleDataTable(); + + //Import data from DataTable + worksheet.ImportDataTable(table, namedRange, true, 1, 1, 5, 2, true); + + workbook.SaveAs("ImportDataTable.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + System.Data.DataTable SampleDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add ten DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + table.Rows.Add(5, "Snacks", "Andrew"); + table.Rows.Add(6, "Perfume", "Thomos"); + table.Rows.Add(7, "Biscuit", "Stephen"); + table.Rows.Add(8, "Cake", "Jones"); + table.Rows.Add(9, "Fruit", "Yabes"); + table.Rows.Add(10, "vegetable", "Marsion"); + return table; + } + + + + + + Imports data from into worksheet from the specified row and column. + + + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward. + To know more about ImportDataReader refer this link + + The or object which contains data. + TRUE if column names must be imported. FALSE otherwise. + First row from where the data should be imported. + First column from where the data should be imported. + Number of imported rows. + The following code illustrates how to Imports data from into worksheet from the specified row and column. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize DataTable and get data from SampleDataTable method + System.Data.DataTable table = SampleDataTable(); + + //Create IDataReader using Datatable + System.Data.IDataReader reader = table.CreateDataReader(); + + //Import data from DataReader + worksheet.ImportDataReader(reader, true, 1, 1); + + workbook.SaveAs("ImportDataReader.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + System.Data.DataTable SampleDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add Ten DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + table.Rows.Add(5, "Snacks", "Andrew"); + table.Rows.Add(6, "Perfume", "Thomos"); + table.Rows.Add(7, "Biscuit", "Stephen"); + table.Rows.Add(8, "Cake", "Jones"); + table.Rows.Add(9, "Fruit", "Yabes"); + table.Rows.Add(10, "vegetable", "Marsion"); + return table; + } + + + + + + Imports data from into worksheet from the specified row and column along with save option. + + + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward. + To know more about ImportDataReader refer this link + + The or object which contains data. + First row from where the data should be imported. + First column from where the data should be imported. + TRUE if data must be serialized directly on save. + Number of imported rows. + The following code illustrates how to Imports data from into worksheet from the specified row and column. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize DataTable and get data from SampleDataTable method + System.Data.DataTable table = SampleDataTable(); + + //Create IDataReader using Datatable + System.Data.IDataReader reader = table.CreateDataReader(); + + //Import data from DataReader + worksheet.ImportDataReader(reader, 1, 1,true); + + workbook.SaveAs("ImportDataReader.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + System.Data.DataTable SampleDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add Ten DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + table.Rows.Add(5, "Snacks", "Andrew"); + table.Rows.Add(6, "Perfume", "Thomos"); + table.Rows.Add(7, "Biscuit", "Stephen"); + table.Rows.Add(8, "Cake", "Jones"); + table.Rows.Add(9, "Fruit", "Yabes"); + table.Rows.Add(10, "vegetable", "Marsion"); + return table; + } + + + + + + Imports data from into worksheet from the specified row and column along with the preserve type. + + + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward. + To know more about ImportDataReader refer this link + + The or object which contains data. + TRUE if column names must be imported. FALSE otherwise. + First row from where the data should be imported. + First column from where the data should be imported. + + Indicates whether XlsIO should preserve column types from DataReader. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + Number of imported rows. + The following code illustrates how to Imports data from into worksheet from the specified row and column. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize DataTable and get data from SampleDataTable method + System.Data.DataTable table = SampleDataTable(); + + //Create IDataReader using Datatable + System.Data.IDataReader reader = table.CreateDataReader(); + + //Import data from DataReader + worksheet.ImportDataReader(reader,true, 1, 1,true); + + workbook.SaveAs("ImportDataReader.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + System.Data.DataTable SampleDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add Ten DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + table.Rows.Add(5, "Snacks", "Andrew"); + table.Rows.Add(6, "Perfume", "Thomos"); + table.Rows.Add(7, "Biscuit", "Stephen"); + table.Rows.Add(8, "Cake", "Jones"); + table.Rows.Add(9, "Fruit", "Yabes"); + table.Rows.Add(10, "vegetable", "Marsion"); + return table; + } + + + + + + Imports data from into the specified named range of current worksheet. + + + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward. + To know more about ImportDataReader refer this link + + The or object which contains data. + + Represents named range using enumeration. Bounds of data table should not greatfull than bounds of named range. + i.e., Example NamedRange["A1:F6"] have a 6 Rows and 6 Columns. Also we should have DataTable rows and columns also same or lessthan named range. + + TRUE if column names must be imported. FALSE otherwise. + Number of imported rows. + The following code illustrates how to Imports data from into worksheet. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize named range + IName namedRange = worksheet.Names.Add("SampleInfo"); + namedRange.RefersToRange = worksheet.Range["A1:F6"]; + + //Initialize DataTable and get data from SampleDataTable method + System.Data.DataTable table = SampleDataTable(); + + //Create IDataReader using Datatable + System.Data.IDataReader reader = table.CreateDataReader(); + + //Import data from DataReader + worksheet.ImportDataReader(reader, namedRange, true); + + workbook.SaveAs("ImportDataReader.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + System.Data.DataTable SampleDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add four DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + return table; + } + + + + + + Imports data from a into worksheet with the specified row and column. + + + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward. + To know more about ImportDataView refer this link + + DataView with desired data. + TRUE if column names must also be imported. FALSE otherwise. + First row from where the data should be imported. + First column from where the data should be imported. + Number of imported rows. + The following code illustrates how to Imports data from a into worksheet with the specified row and column. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize DataTable and data get from SampleDataTable method + System.Data.DataTable table = SampleDataTable(); + + //Initialize dataview of datatable + System.Data.DataView view = table.DefaultView; + + //Import data from DataView + worksheet.ImportDataView(view, true, 1, 1); + + workbook.SaveAs("ImportDataView.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + System.Data.DataTable SampleDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add four DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + return table; + } + + + + + + Imports data from a into a worksheet with the specified range and preserve type. + + + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward. + To know more about ImportDataView refer this link + + DataView with desired data. + TRUE if column names must be imported. FALSE otherwise. + + First row from where the data should be imported. + + + First column from where the data should be imported. + + + Indicates whether XlsIO should preserve column types from DataReader. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + Number of imported rows. + The following code illustrates how to Imports data from a into worksheet with the specified row and column. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize DataTable and data of DataTable get from SampleDataTable method + System.Data.DataTable table = SampleDataTable(); + + //Initialize dataview of datatable + System.Data.DataView view = table.DefaultView; + + //Import data from DataView + worksheet.ImportDataView(view, true, 1, 1, true); + + workbook.SaveAs("ImportDataView.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + System.Data.DataTable SampleDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add four DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + return table; + } + + + + + + Imports data from a into a worksheet with specified row, column and preserve type. + + + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward. + To know more about ImportDataView refer this link + + Data View with desired data. + TRUE if column names must be imported. FALSE otherwise. + + First row from where the data should be imported. + + + First column from where the data should be imported. + + Maximum number of rows to import. + Maximum number of columns to import. + Number of imported rows. + The following code illustrates how to Imports data from a into worksheet with the specified row and column. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize DataTable and data get from SampleDataTable method + System.Data.DataTable table = SampleDataTable(); + + //Initialize dataview of datatable + System.Data.DataView view = table.DefaultView; + + //Import data from DataView + worksheet.ImportDataView(view, true, 1, 1, 5, 2); + + workbook.SaveAs("ImportDataView.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + System.Data.DataTable SampleDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add Ten DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + table.Rows.Add(5, "Snacks", "Andrew"); + table.Rows.Add(6, "Perfume", "Thomos"); + table.Rows.Add(7, "Biscuit", "Stephen"); + table.Rows.Add(8, "Cake", "Jones"); + table.Rows.Add(9, "Fruit", "Yabes"); + table.Rows.Add(10, "vegetable", "Marsion"); + return table; + } + + + + + + Imports data from a into a worksheet with specified range and preserve type. + + + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward. + To know more about ImportDataView refer this link + + DataView with desired data. + TRUE if column names must also be imported. FALSE otherwise. + + First row from where the data should be imported. + + + First column from where the data should be imported. + + Maximum number of rows to import. + Maximum number of columns to import. + Indicates whether XlsIO should try to preserve types in Data Table, i.e. if it is set to False (default) and in Data Table we have in + string column value that contains only numbers, it would be converted to number. + Number of imported rows. + The following code illustrates how to Imports data from a into worksheet with the specified row and column. + + using(ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Initialize DataTable and data get from SampleDataTable method + System.Data.DataTable table = SampleDataTable(); + + //Initialize dataview of datatable + System.Data.DataView view = table.DefaultView; + + //Import data from DataView. + worksheet.ImportDataView(view, true, 1, 1, 5, 2, true); + + workbook.SaveAs("ImportDataView.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + System.Data.DataTable SampleDataTable() + { + // Here we create a three columns + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("ID", typeof(int)); + table.Columns.Add("Item", typeof(string)); + table.Columns.Add("Name", typeof(string)); + + // Here we add Ten DataRows + table.Rows.Add(1, "Soap", "David"); + table.Rows.Add(2, "Paste", "Sam"); + table.Rows.Add(3, "Cream", "Christoff"); + table.Rows.Add(4, "Powder", "Janet"); + table.Rows.Add(5, "Snacks", "Andrew"); + table.Rows.Add(6, "Perfume", "Thomos"); + table.Rows.Add(7, "Biscuit", "Stephen"); + table.Rows.Add(8, "Cake", "Jones"); + table.Rows.Add(9, "Fruit", "Yabes"); + table.Rows.Add(10, "vegetable", "Marsion"); + return table; + } + + + + + + Import XML document with specified cell position to the worksheet using file path. + + FilePath of the speciifed xml file. + Row where the data to be imported. + Column where the data to be imported. + + + + Imports XML data into a worksheet at the specified row and column from a given XML data stream. + + Stream data of the xml file. + Row where the data to be imported. + Column where the data to be imported. + The stream should be passed as file stream to bind the xml + + + + Removes panes from a worksheet. + + + + + Exports worksheet data in the specified row and column into a . + + + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward. + To know more about ExportDataTable refer this link. + + Row of the first cell from where DataTable should be exported. + Column of the first cell from where DataTable should be exported. + Maximum number of rows to export / upto number of rows. + Maximum number of columns to export / upto number of columns. + Export options using enumeration. + DataTable with worksheet data. + The following code illustrates how to exports worksheet data into a with the specified row and column. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx", ExcelOpenType.Automatic); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Import Data From Excel to DataTable + System.Data.DataTable dataTable = worksheet.ExportDataTable(1,1,40,4, ExcelExportDataTableOptions.ComputedFormulaValues); + + // Using dataGrid/gridControls you can view the exported DataTable's data + System.Windows.Forms.DataGrid dataGrid1 = new System.Windows.Forms.DataGrid(); + dataGrid1.DataSource = dataTable; + + workbook.Close(); + excelEngine.Dispose(); + + + + + + Exports worksheet data in the specified row and column into a DataTable based on the export options. + + When exportDataOption is null or the value of the ColumnTypeDeductionRow property in a row is less than or equal to 0, then By default the second row from the export range is used for detecting the column types. And the default value will be exported in the data table if the cell value does not match with the column type. + Row of the first cell from where DataTable should be exported. + Column of the first cell from where DataTable should be exported. + Maximum number of rows to export / upto number of rows. + Maximum number of columns to export / upto number of columns. + Export options using enumeration. + Export data options using enumeration. + DataTable with worksheet data. + The following code illustrates how to exports worksheet data into a with the specified row and column. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx", ExcelOpenType.Automatic); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Import Data From Excel to DataTable + ExcelExportDataOptions exportDataOptions = new ExcelExportDataOptions(); + exportDataOptions.ColumnTypeDetectionRow = 2; + System.Data.DataTable dataTable = worksheet.ExportDataTable(1,1,40,4, ExcelExportDataTableOptions.ComputedFormulaValues,exportDataOptions); + + // Using dataGrid/gridControls you can view the exported DataTable's data + System.Windows.Forms.DataGrid dataGrid1 = new System.Windows.Forms.DataGrid(); + dataGrid1.DataSource = dataTable; + + workbook.Close(); + excelEngine.Dispose(); + + + + + + Exports worksheet data in the specified range into a . + + + This method is supported in ASP.NET Core, Xamarin, and UWP platforms from .NET Standard 2.0 onward. + To know more about ExportDataTable refer this link. + + Used range of worksheet to be export using Interface. + Export options using enumeration. + DataTable with worksheet data. + The following code illustrates how to exports worksheet data into a with the specified . + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx", ExcelOpenType.Automatic); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Import Data From Excel to DataTable + System.Data.DataTable customersTable = worksheet.ExportDataTable(worksheet.UsedRange, ExcelExportDataTableOptions.ColumnNames| ExcelExportDataTableOptions.PreserveOleDate); + + //Using dataGrid/gridControls you can view the exported DataTable's data + System.Windows.Forms.DataGrid dataGrid1 = new System.Windows.Forms.DataGrid(); + this.dataGrid1.DataSource = customersTable; + + workbook.Close(); + excelEngine.Dispose(); + + + + + + Exports worksheet data into a DataTable with the specified data range based on the export options. + + When exportDataOption is null or the value of the ColumnTypeDeductionRow property in a row is less than or equal to 0, then By default the second row from the export range is used for detecting the column types. And the default value will be exported in the data table if the cell value does not match with the column type. + Used range of worksheet to be export using Interface. + Export options using enumeration. + Export data options using enumeration. + DataTable with worksheet data. + The following code illustrates how to exports worksheet data into a with the specified . + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx", ExcelOpenType.Automatic); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Import Data From Excel to DataTable + ExcelExportDataOptions exportDataOptions = new ExcelExportDataOptions(); + exportDataOptions.ColumnTypeDetectionRow = 2; + System.Data.DataTable customersTable = worksheet.ExportDataTable(worksheet.UsedRange, ExcelExportDataTableOptions.ColumnNames| ExcelExportDataTableOptions.PreserveOleDate, exportDataOptions); + + //Using dataGrid/gridControls you can view the exported DataTable's data + System.Windows.Forms.DataGrid dataGrid1 = new System.Windows.Forms.DataGrid(); + this.dataGrid1.DataSource = customersTable; + + workbook.Close(); + excelEngine.Dispose(); + + + + + + Exports worksheet data into the of CLR Objects. + + + Class property name or for a property must match with any one of the cell value in firstRow parameter to bind and export data. + To know more about ExportData refer this link. + + Row of the first cell should be exported. + Column of the first cell should be exported. + Upto lastRow of data want to be export. + Upto lastColumn of data want to be export. + T is a generic type argument. The type argument for this particular class can be any type recognized by the compiler and it must have a parameterless constructor. + List of CLRObjects with worksheet data. + The following code illustrates how to exports worksheet data into a of CLR objects. + + using Syncfusion.XlsIO; + using System.Collections.Generic; + + class Example + { + static void Main() + { + ExcelEngine engine = new ExcelEngine(); + IApplication application = engine.Excel; + application.DefaultVersion = ExcelVersion.Excel2016; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + // Export the matching data and Get the list of CLR objects + List<Report> clrObjects= worksheet.ExportData<Report>(1, 1, 40, 3); + + workbook.Close(); + engine.Dispose(); + } + } + public class Report + { + public string SalesPerson { get; set; } + public string SalesJanJun { get; set; } + public string SalesJulDec { get; set; } + + public Report() + { + + } + } + + + + + + Exports worksheet data into the of CLR Objects. + + + Class property name or for a property must match with any one of the cell value in firstRow parameter to bind and export data. + To know more about ExportData refer this link. + + Row of the first cell should be exported. + Column of the first cell should be exported. + Upto lastRow of data want to be export. + Upto lastColumn of data want to be export. + Property names mapping collection. You should give headers as key and properties names as value to the dictionary. + T is a generic type argument. The type argument for this particular class can be any type recognized by the compiler and it must have a parameterless constructor. + List of CLRObjects with worksheet data. + The following code illustrates how to exports worksheet data into a of CLR objects. + + using Syncfusion.XlsIO; + using System.Collections.Generic; + + class Example + { + static void Main() + { + ExcelEngine engine = new ExcelEngine(); + IApplication application = engine.Excel; + application.DefaultVersion = ExcelVersion.Excel2016; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + // Export the matching data and Get the list of CLR objects + Dictionary<string, string> mappingProperties = new Dictionary<string, string>(); + mapping.Add("Sales Person", "SalesPerson"); + mapping.Add("Sales JanuaryJune", "SalesJanJun"); + mapping.Add("Sales JulyDecember", "SalesJulDec"); + + List<Report> clrObjects= worksheet.ExportData<Report>(1, 1, 40, 3, mappingProperties); + + workbook.Close(); + engine.Dispose(); + } + } + public class Report + { + public string SalesPerson { get; set; } + public string SalesJanJun { get; set; } + public string SalesJulDec { get; set; } + + public Report() + { + + } + } + + + + + + Intersects two ranges. + + First range to intersect. + Second range to intersect. + Intersection of two ranges or NULL if there is no range intersection. + + When range1 or range2 is NULL. + + + + + Merges two ranges. + + First range to merge. + Second range to merge. + Merged ranges or NULL if is not able to merge ranges. + + When range1 or range2 is NULL. + + + + + Changes the height of the specified row to achieve the best fit. + + One-based row index. + The following code illustrates how to Auto-fit the row. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["C2"].Value = "Sample text"; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set font + IFont font = style.Font; + + //Set font size + font.Size = 18; + + //Set style + worksheet["C2"].CellStyle = style; + + //Set auto fit + worksheet.AutofitRow(2); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Changes the width of the specified column to achieve the best fit. + + One-based column index. + The following code illustrates how to Auto-fit the column. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["A1"].Text = "Sample text in cell"; + + //Set auto fit + worksheet.AutofitColumn(1); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Replaces string with the specified string value. + + The string to be replaced. + The string to replace all occurrences of oldValue. + The following code snippet illustrates how to replace the string with another string. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + string oldValue = "Find"; + string newValue = "NewValue"; + sheet.Replace(oldValue, newValue); + + + + + + Replaces string with the specified string value based on the given . + + The string to be replaced. + The string to replace all occurrences of oldValue. + Specifies the find options for the oldValue. + The following code snippet illustrates how to replace the string with another string. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + string oldValue = "Find"; + string newValue = "NewValue"; + sheet.Replace(oldValue, newValue, ExcelFindOptions.MatchCase); + + + + + + Replaces string with the specified double value. + + The string to be replaced. + The double value to replace all occurrences of oldValue. + The following code snippet illustrates how to replace the string value with double. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + string oldValue = "Ten"; + sheet.Replace(oldValue,10.0); + + + + + + Replaces string with the specified DateTime value. + + The string to be replaced. + The datetime value to replace all occurrences of oldValue. + The following code illustrates how to replace the string value with datetime. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + string oldValue = "Find"; + DateTime dateTime = DateTime.Now; + sheet.Replace(oldValue,dateTime); + + + + + + Replaces specified string with the specified array of string values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + The following code snippet illustrates how to replace the string with array of string values. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + string oldValue = "Find"; + string[] newValues = { "X values", "Y values" }; + sheet.Replace(oldValue, newValues, true); + + + + + + Replaces specified string with the specified array of int values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + The following code snippet illustrates how to replace the string with array of int values. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + string oldValue = "Find"; + int[] newValues = { 1, 2 }; + sheet.Replace(oldValue, newValues, true); + + + + + + Replaces specified string with the specified array of double values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + The following code snippet illustrates how to replace the string with array of double values. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + string oldValue = "Find"; + double[] newValues = { 1.00, 3.00 }; + sheet.Replace(oldValue, newValues, true); + + + + + + Replaces the string with the specified datatable value. + + The string to be replaced. + Data table with new data. + Indicates whether field name must be shown. + The following code snippet illustrates how to replace the string value with data table. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + //Create the data table + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("Dosage", typeof(int)); + table.Rows.Add(1); + // Replace the value with data table. + sheet.Replace("AB2", table, true); + + + + + + Replaces string with the specified datacolumn value. + + The string to be replaced. + Data table with new data. + Indicates whether field name must be shown. + + The following code snippet illustrates how to replace the string value with data column. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + // create the data table + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("Dosage", typeof(int)); + table.Rows.Add(1); + System.Data.DataColumn dataColumn = table.Columns[0]; + // Replace the value with data column. + sheet.Replace("AB2", dataColumn, true); + + + + + + Removes worksheet from parent worksheet collection. + + + + + Moves worksheet to the specified index. + + New index of the worksheet. + + + + Converts the specified column width from points to pixels. + + Width in points. + Column width in pixels. + + + + Converts the specified column width from pixels to points. + + Width in pixels. + Width in points. + + + + Sets column width for the specified column. + + One-based column index. + Width to set. + + The following code illustrates how to set width for a column. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set column width + worksheet.SetColumnWidth(2, 160); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Sets column width in pixels for the specified column. + + One-based column index. + Width in pixels to set. + + The following code illustrates how to set width for a column. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set column width + worksheet.SetColumnWidthInPixels(2, 160); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Sets column width in pixels to the given number of columns from the specified column index. + + Start Column index + No of Column to be set width + Value in pixel to set + + The following code illustrates how to set width for columns. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set column width + worksheet.SetColumnWidthInPixels(2, 4, 160); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Sets row height for the specified row. + + One-based row index. + Height to set. + + The following code illustrates how to set height for a row. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set row height + worksheet.SetRowHeight(3, 45); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Sets row height in pixels for the specified row. + + One-based row index. + Value in pixels to set. + + The following code illustrates how to set height for a row. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set row height + worksheet.SetRowHeightInPixels(3, 150); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Sets row height in pixels to the given number of rows from the specified row index. + + Starting row index. + No of Row to be set width. + Value in pixels to set. + + The following code illustrates how to set height for a row. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set row height + worksheet.SetRowHeightInPixels(3, 4, 150); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Returns the width of the specified column. + + One-based column index. + Width of the specified column. + + The following code illustrates how to get the column width for a particular column. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["A1"].Text = "Sample text in cell"; + + //Set auto fit + worksheet.AutofitColumn(1); + + //Get column width + Console.WriteLine(worksheet.GetColumnWidth(1)); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //17.70701325 + + + + + + Returns the width of the specified column in pixels. + + One-based column index. + Width in pixels of the specified column. + + The following code illustrates how to get the column width for a particular column. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["A1"].Text = "Sample text in cell"; + + //Set auto fit + worksheet.AutofitColumn(1); + + //Get column width + Console.WriteLine(worksheet.GetColumnWidthInPixels(1)); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //129 + + + + + + Returns the height of the specified row. + + One-based row index. + + Returns height of the specified row. + Otherwise returns StandardHeight. + + + The following code illustrates how to get the row height for a particular row. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["C2"].Value = "Sample text"; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set font + IFont font = style.Font; + + //Set font size + font.Size = 18; + + //Set style + worksheet["C2"].CellStyle = style; + + //Set auto fit + worksheet.AutofitRow(2); + + //Get row width + Console.WriteLine(worksheet.GetRowHeight(2)); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //21.95 + + + + + + Returns the height of the specified row in pixels. + + One-based row index. + + Returns height of the specified row in pixels. + Otherwise returns StandardHeight. + + + The following code illustrates how to get the row height for a particular row. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["C2"].Value = "Sample text"; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set font + IFont font = style.Font; + + //Set font size + font.Size = 18; + + //Set style + worksheet["C2"].CellStyle = style; + + //Set auto fit + worksheet.AutofitRow(2); + + //Get row width + Console.WriteLine(worksheet.GetRowHeightInPixels(2)); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //29 + + + + + + Returns the first occurrence of the specified string value with the specified . + + Value to search. + Type of value to search. + Returns the first cell with a specified string value, or null if value was not found. + The following code illustrates how to find the first occurrence of the specified string value. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find First with string + IRange results = sheet.FindFirst("Hello World", ExcelFindType.Text); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the first occurrence of the specified string value with the specified and . + + Value to search. + Type of value to search. + Way to search the value. + Returns the first cell with a specified string value and specified find options , or null if value was not found. + The following code illustrates how to find the first occurrence of the specified string value with specified Excel find option. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find First with string and specified find option. + IRange results = sheet.FindFirst("Hello World", ExcelFindType.Text,ExcelFindOptions.MatchCase); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the first occurrence that starts with the specified string value. + + Value to search. + Type of value to search. + Returns the first occurrence that starts with the specified string value, or null if value was not found. + The following code illustrates how to find the first occurrence that starts with the specified string value. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find String Starts with specified string + IRange result = sheet.FindStringStartsWith("Hello", ExcelFindType.Text); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the first occurrence that starts with the specified string value which ignores the case. + + Value to search. + Type of value to search. + true to ignore case wen comparing this string to the value;otherwise,false + Returns the first occurrence that starts with the specified string value, or null if value was not found. + The following code illustrates how to find the first occurrence that starts with the specified string value. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find String Starts with specified string + IRange result = sheet.FindStringStartsWith("Hello", ExcelFindType.Text, true); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the first occurrence that ends with the specified string value. + + Value to search. + Type of value to search. + Returns the first occurrence that ends with the specified string value, or null if value was not found. + The following code illustrates how to find the first occurrence that ends with the specified string value which ignores the case. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find String Ends with specified string + IRange result = sheet.FindStringEndsWith("world", ExcelFindType.Text); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the first occurrence that ends with the specified string value which ignores the case. + + Value to search. + Type of value to search. + True to ignore case when comparing this string to the value; otherwise, False. + Returns the first occurrence that ends with the specified string value, or null if value was not found. + The following code illustrates how to find the first occurrence that ends with the specified string value which ignores the case. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find String Ends with specified string + IRange result = sheet.FindStringEndsWith("world", ExcelFindType.Text, true); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the first occurrence of the specified double value with the specified . + + Value to search. + Type of value to search. + Returns the first cell with a specified double value, or null if value was not found. + The following code illustrates how to find the first occurrence of the specified double value. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find First with number + IRange result = sheet.FindFirst(100.32, ExcelFindType.Number); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the first occurrence of the specified bool value. + + Value to search. + Returns the first cell with a specified bool value, or null if value was not found. + The following code illustrates how to find the first occurrence of the specified bool value. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find First with bool + IRange result = sheet.FindFirst(true); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the first occurrence of the specified DateTime value. + + Value to search. + Returns the first cell with a specified DateTime value, or null if value was not found. + The following code illustrates how to find the first occurrence of the specified DateTime value. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find First with DateTime + IRange result = sheet.FindFirst(DateTime.Now); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the first occurrence of the specified TimeSpan value. + + Value to search. + Returns the first cell with a specified TimeSpan value, or null if value was not found. + The following code illustrates how to find the first occurrence of the specified TimeSpan value. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find First with Timespan + IRange result = sheet.FindFirst(TimeSpan.MinValue); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the cells of the specified string value with the specified . + + Value to search. + Type of value to search. + Returns the cells with a specified string value, or null if value was not found. + The following code illustrates how to find the cells with specified string value. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find all with string + IRange[] results = sheet.FindAll("Hello World", ExcelFindType.Text); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the cells of the specified string value with the specified and . + + Value to search. + Type of value to search. + Way to search. + + Returns the cells with a specified string value and specified find options , or null if value was not found. + + The following code illustrates how to find the cells with specified string value with specified Excel find option. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find all with string and specified find option. + IRange[] results = sheet.FindAll("Hello World", ExcelFindType.Text, ExcelFindOptions.MatchCase); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the cells of the specified double value with the specified . + + Value to search. + Type of value to search. + All found cells, or Null if value was not found. + The following code illustrates how to find the cells with specified double value. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find All with number + IRange[] results = sheet.FindAll(100.32, ExcelFindType.Number); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the cells of the specified bool value. + + Value to search. + Returns the cells with a specified bool value, or null if value was not found. + The following code illustrates how to find the cells with specified bool value. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find all with bool. + IRange[] results = sheet.FindAll(true); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the cells of the specified DateTime value. + + Value to search. + Returns the cells with a specified DateTime value, or null if value was not found. + The following code illustrates how to find the cells with specified DateTime value. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find all with DateTime + IRange[] results = sheet.FindAll(DateTime.Now); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the cells of the specified TimeSpan value. + + Value to search. + Returns the cells with a specified TimeSpan value, or null if value was not found. + The following code illustrates how to find the cells with specified TimeSpan value. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find All with Timespan + IRange[] results = sheet.FindAll(TimeSpan.MinValue); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Saves worksheet with specified file name using separator. Used only for CSV files. + + File to save. + Denotes separator for the CSV file types. + The following code illustrates how to saves the worksheet with separator. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.SaveAs("newFile.csv", ","); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Saves worksheet using separator with specified file name and encoding. Used only for CSV files. + + File to save. + Denotes separator for the CSV file types. + Encoding to use. + The following code illustrates how to saves the worksheet with encoding. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.SaveAs("newFile.csv", ",",Encoding.ASCII); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Saves worksheet as stream using separator. Used only for CSV files. + + Stream to save. + Denotes separator for the CSV file types. + The following code illustrates how to saves the worksheet as stream with separator. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + Stream stream = new MemoryStream(); + sheet.SaveAs(stream, ","); + + + + + + Saves worksheet as stream using separator with specified encoding. Used only for CSV files. + + Stream to save. + Denotes separator for the CSV file types. + Encoding to use. + The following code illustrates how to saves the worksheet as stream with encoding. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + Stream stream = new MemoryStream(); + sheet.SaveAs(stream, ",",Encoding.ASCII); + + + + + + Sets the default column style for the specified column. + + One-based column index. + Default style. + + The following code illustrates how to set the default style for a column. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set color + style.ColorIndex = ExcelKnownColors.Red; + + //Set default style + worksheet.SetDefaultColumnStyle(2, style); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Sets the default column style for the specified starting and ending column. + + Starting column index. + Ending column index. + Default style. + + The following code illustrates how to set the default style for columns. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set color + style.ColorIndex = ExcelKnownColors.Red; + + //Set default style + worksheet.SetDefaultColumnStyle(2, 5, style); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Sets the default row style for the specified row. + + One-based row index. + Default style. + + The following code illustrates how to set the default style for a row. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set color + style.ColorIndex = ExcelKnownColors.Red; + + //Set default style + worksheet.SetDefaultRowStyle(2, style); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Sets the default row style for the specified starting and ending row. + + Starting row index. + Ending row index. + Default style. + + The following code illustrates how to set the default style for rows. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set color + style.ColorIndex = ExcelKnownColors.Red; + + //Set default style + worksheet.SetDefaultRowStyle(2, 5, style); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Returns the default column style for the specified column. + + One-based column index. + Default column style for the specified column or null if style wasn't set. + + The following code illustrates how to get default column style. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set color + style.ColorIndex = ExcelKnownColors.Red; + + //Set default style + worksheet.SetDefaultRowStyle(2, style); + + //Get default style + IStyle defaultStyle = worksheet.GetDefaultColumnStyle(3); + + //Set color + defaultStyle.ColorIndex = ExcelKnownColors.Blue; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Returns default row style for the specified row. + + One-based row index. + Default row style for the specified row or null if style wasn't set. + + The following code illustrates how to get default row style. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set color + style.ColorIndex = ExcelKnownColors.Red; + + //Set default style + worksheet.SetDefaultColumnStyle(2, style); + + //Get default style + IStyle defaultStyle = worksheet.GetDefaultRowStyle(3); + + //Set color + defaultStyle.ColorIndex = ExcelKnownColors.Blue; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Frees range object. + + Range to remove from internal cache. + + + + Frees range object for the specified row and column. + + One-based row index of the range object to remove from internal cache. + One-based column index of the range object to remove from internal cache. + + + + Sets value for the specified cell. + + One-based row index. + One-based column index. + Value to set. + + + + Sets number for the specified cell. + + One-based row index. + One-based column index. + Value to set. + + + + Sets boolean value for the specified cell. + + One-based row index. + One-based column index. + Value to set. + + + + Sets text for the specified cell. + + One-based row index. + One-based column index. + Text to set. + + + + Sets formula for the specified cell. + + One-based row index. + One-based column index. + Formula to set. + + + + Sets error for the specified cell. + + One-based row index. + One-based column index. + Error to set. + + + + Blanks the specified cell. + + One-based row index. + One-based column index. + + + + Sets formula number value for the specified cell. + + One-based row index. + One-based column index. + Represents formula number value. + + + + Sets formula error value for the specified cell. + + One-based row index. + One-based column index. + Represents formula error value. + + + + Sets formula bool value for the specified cell. + + One-based row index. + One-based column index. + Represents formula bool value. + + + + Sets formula string value for the specified cell. + + One-based row index. + One-based column index. + Represents formula string value. + + + + Returns string value from the specified row and column. + + One-based row index. + One-based column index. + String contained by the cell. + + + + Returns number value from the specified row and column. + + One-based row index. + One-based column index. + Number contained by the cell. + + + + Returns formula value from specified row and column. + + One-based row index. + One-based column index. + Indicates whether R1C1 notation should be used. + Returns formula string. + + + + Returns error value from the specified row and column. + + One-based row index. + One-based column index. + Returns error value or null. + + + + Returns bool value from the specified row and column. + + One-based row index. + One-based column index. + Returns found bool value. If cannot found returns false. + + + + Returns formula bool value from the specified row and column. + + One-based row index. + One-based column index. + True if bool value is found. otherwise False. + + + + Returns formula error value from the specified row and column. + + One-based row index. + One-based column index. + Returns error value or null. + + + + Returns formula number value from the specified row and column. + + One-based row index. + One-based column index. + Number contained by the cell. + + + + Returns formula string value from the specified row and column. + + One-based row index. + One-based column index. + String contained by the cell. + + + + Converts the specified range into image. Default image type is Bitmap. + + First row index. One-based. + First column index. One-based. + Last row index. One-based. + Last column index. One-based. + Converted Image for the specified range. + Subscript/Superscript,RTF,Shrink to fit,Shapes (except TextBox shape and Image),Charts and + Chart Worksheet and Complex conditional formatting features are not supported in Worksheet + to image conversion. Gradient fill is partially supported + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + // Converts the Range(R1C1 to R10C20) in worksheet to image. + System.Drawing.Image img = sheet.ConvertToImage(1, 1, 10, 20); + img.Save("Sample.png", System.Drawing.Imaging.ImageFormat.Png); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Converts the specified range into image with the specified type. + + First row index. One-based. + First column index. One-based. + Last row index. One-based. + Last column index. One-based. + Type of the image to create. + Stream to be converted to an image. It is ignored if null. + Converted Image for the specified range. + Subscript/Superscript,RTF,Shrink to fit,Shapes (except TextBox shape and Image),Charts and + Chart Worksheet and Complex conditional formatting features are not supported in Worksheet + to image conversion. Gradient fill is partially supported + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + MemoryStream stream = new MemoryStream(); + // Converts the Range(R1C1 to R10C20) in worksheet to image. + sheet.ConvertToImage(1, 1, 10, 20, ImageType.Metafile, stream); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Saves worksheet with specified filename. + + File to save. + + The following code snippets illustrates how to save as html to the specified file name. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.SaveAsHtml("Output.html"); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Saves worksheet as stream. + + Stream to save. + + The following code snippets illustrates how to save as html as stream. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + Stream stream = new MemoryStream(); + sheet.SaveAsHtml(stream); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Saves worksheet with specified filename and . + + File to save. + Save Options + + The following code snippets illustrates how to save as html to the specified file name and save option. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.SaveAsHtml("Output.html",HtmlSaveOptions.Default); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Saves worksheet as stream with the specified . + + Stream to save. + Save Options + + The following code snippets illustrates how to save as html as stream with Save option. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + Stream stream = new MemoryStream(); + sheet.SaveAsHtml(stream,HtmlSaveOptions.Default); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Converts the specified range into Metafile. + + First row index. One-based. + First column index. One-based. + Last row index. One-based. + Last column index. One-based. + Enhanced MetaFile, to render the image in meta file format. + Stream to be converted to an image. It is ignored if null. + Converted Image for the specified range. + Subscript/Superscript,RTF,Shrink to fit,Shapes (except TextBox shape and Image),Charts and + Chart Worksheet and Complex conditional formatting features are not supported in Worksheet + to image conversion. Gradient fill is partially supported + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + MemoryStream stream = new MemoryStream(); + // Converts the Range(R1C1 to R10C20) in worksheet to image. + sheet.ConvertToImage(1, 1, 10, 20, System.Drawing.Imaging.EmfType.EmfOnly, stream); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Converts the specified range into image along with Metafile. + + First row index. One-based.. + First column index. One-based. + Last row index. One-based. + Last column index. One-based. + Type of the image to create. + Stream to be converted to an image. It is ignored if null. + Enhanced MetaFile, to render the image in meta file format. + Converted Image for the specified range. + Subscript/Superscript,RTF,Shrink to fit,Shapes (except TextBox shape and Image),Charts and + Chart Worksheet and Complex conditional formatting features are not supported in Worksheet + to image conversion. Gradient fill is partially supported + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + MemoryStream stream = new MemoryStream(); + // Converts the Range(R1C1 to R10C20) in worksheet to image. + sheet.ConvertToImage(1, 1, 10, 20, ImageType.Metafile, stream, System.Drawing.Imaging.EmfType.EmfOnly); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Calculate all the formulas in worksheet. + + The following code illustrates how to calculate all the formulas in the worksheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Formulas.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + // Calculate all the formulas in the worksheet. + worksheet.Calculate(); + + workbook.SaveAs("Calculation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Filters or copies data from a list based on a criteria range.. + + Whether filter in the place or copy to another place. + The filter range. + The criteria range. + The destination range for the copied rows if ExcelFilterAction is FilterCopy. Otherwise, this argument is ignored. + True to filter unique records; Otherwise filters all the records that meet the criteria. The default value is False. + + + + Imports HTML table of a HTML file into worksheet from the specified row and column. + + Specifies the HTML file. + Specifies the starting row index. + Specifies the starting column index. + + The following code illustrates how to convert HTML table to Excel. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + + sheet.ImportHtmlTable("HTMLtable.html", 1, 1); + + workbook.SaveAs("HTMLToExcel.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Imports HTML table of a file stream into worksheet from the specified row and column. + + Specifies the HTML filestream. + Specifies the starting row index + Specifies the starting column index + + The following code illustrates how to convert HTML table to Excel. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + FileStream html = new FileStream("HTMLtable.html", FileMode.Open, FileAccess.ReadWrite); + + sheet.ImportHtmlTable(html, 1, 1); + + workbook.SaveAs("HTMLToExcel.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Imports tables from HTML document into Excel worksheet from the specified row and column with HTML import options. + + Specifies the HTML file. + Specifies the starting row index. + Specifies the starting column index. + Specifies the html import options. + + The following code illustrates how to convert HTML table to Excel. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Xlsx; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + + sheet.ImportHtmlTable("HTMLtable.html", 1, 1, HtmlImportOptions.DetectFormulas); + + workbook.SaveAs("HTMLToExcel.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Imports HTML table of a file stream into worksheet from the specified row and column. + + Specifies the HTML filestream. + Specifies the starting row index + Specifies the starting column index + Specifies the html import options. + + The following code illustrates how to convert HTML table to Excel. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Xlsx; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + FileStream html = new FileStream("HTMLtable.html", FileMode.Open, FileAccess.ReadWrite); + + sheet.ImportHtmlTable(html, 1, 1, HtmlImportOptions.DetectFormulas); + + workbook.SaveAs("HTMLToExcel.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets or sets the a object associated with implementation. + + + + + Event raised when an unknown function is encountered. + + + + + Gets the collection of slicers present in the worksheet. + + + + + Gets the scenarios in the current worksheet. + + The following code illustrates how to get the scenarios for the current worksheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Xlsx; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IScenarios scenarios = sheet.Scenarios; + + + + + + Gets the auto filters collection in the worksheet. Read-only. + + + + + Gets the used cells in the worksheet. Read-only. + + + + + Gets or sets a value that indicates whether page breaks (both automatic and manual) + on the worksheet are displayed. + + + + + Gets the index number of the worksheet within the collection of + worksheet. Read-only. + + + + + Gets all the merged ranges in the worksheet. Read-only. + + The following code illustrates how to get the merged ranges. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Merge cells + worksheet["C2:D2"].Merge(); + worksheet["F3:G3"].Merge(); + + //Get merged ranges + IRange[] mergedRanges = worksheet.MergedCells; + + //Get merged range count + Console.Write(mergedRanges.Length); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //2 + + + + + + Gets a Names collection that represents + the worksheet-specific names (names defined with the "WorksheetName!" + prefix) in the worksheet. Read-only. + + + + + Gets a object that contains all the page setup settings + for the specified object. Read-only. + + + + + Gets a Range object that represents a cell or a range of cells in the worksheet. + + + + + Gets a Range object that represents the rows in the specified worksheet. Read-only. + + + + + Gets a Range object that represents all the columns in the specified worksheet. Read-only. + + + + + Gets or sets the standard (default) height of all the rows in the worksheet, + in points. + + The following code illustrates how to get the standard height. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Text"; + + //Set standard height + worksheet.StandardHeight = 40; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the standard (default) height option flag. + + + Which defines that standard (default) row height and book default font height do not match. + + + + + Gets or sets the standard (default) width of all the columns in the + worksheet. + + The following code illustrates how to get the standard width. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Text"; + + //Set standard width + worksheet.StandardWidth = 80; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets the worksheet type. Read-only ExcelSheetType. + + + + + Gets a Range object that represents the used range on the + specified worksheet. Read-only. + + The following code illustrates how to get used range on the specified worksheet. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["B2"].Text = "Text"; + worksheet["J5"].Text = "Text"; + + //Set Color + worksheet["J3"].CellStyle.ColorIndex = ExcelKnownColors.Red; + + //Get used range + Console.Write(worksheet.UsedRange.AddressLocal); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //B2:J5 + + + + + + Gets or sets the value that represents zoom factor of document. Value must be in range from 10 till 400. + + The following code illustrates how to set zoom level of the sheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.Zoom = 200; + + + + + + Gets or sets the position of vertical split in the worksheet. + + + Position of the vertical split (px, 0 = No vertical split): + Unfrozen pane: Width of the left pane(s) (in twips = 1/20 of a point) + Frozen pane: Number of visible columns in left pane(s) + + + + + Gets or sets the position of horizontal split in the worksheet. + + + Position of the horizontal split (by, 0 = No horizontal split): + Unfrozen pane: Height of the top pane(s) (in twips = 1/20 of a point) + Frozen pane: Number of visible rows in top pane(s) + + + + + Gets or sets the first visible row index. + + + + + Gets or sets the first visible column index. + + + + + Gets or sets index of the active pane. + + + + + True if zero values to be displayed. otherwise, False. + + + + + True if grid lines are visible. otherwise, False. + + + The following code illustrates how to set visibility for grid lines. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set grid line visibility + worksheet.IsGridLinesVisible = false; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the color of the Grid line in the worksheet. + + The following code illustrates how to set the grid line color. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set grid lines color + worksheet.GridLineColor = ExcelKnownColors.Red; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + True if row and column headers are visible. otherwise, False. + + + + + Gets a that represents the vertical page + breaks on the sheet. Read-only. + + + + + Gets a that represents the horizontal + page breaks in the worksheet. Read-only. + + + + + True if all values in the worksheet are preserved as strings. otherwise, False. + + The following code illustrates if the values in the worksheet are preserved as strings. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.IsStringsPreserved = true; + worksheet["A1"].Value = "10"; + worksheet["A2"].Value = "Test"; + worksheet["A3"].Value = "=SUM(1+1)"; + + + + + + Gets the collection in the worksheet. + + + The following code illustrates how to access the collection in the worksheet. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + // Adding comments to a cell. + ICommentShape comment1 = sheet.Range["A1"].AddComment(); + ICommentShape comment2 = sheet.Range["B1"].AddComment(); + + //Set comment text + comment1.Text= "Comment1"; + comment2.Text= "Comment2"; + + //Check count + Console.Write(sheet.Comments.Count); + + //Save and dispose + workbook.SaveAs("Comments.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //2 + + + + + + Gets the threaded comments collection for a current worksheet. + + The collection. + + The following code illustrates how to access ThreadedComments property of IWorksheet + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add threaded comment + IThreadedComment threadedComment = worksheet["C2"].AddThreadedComment("Hello","User"); + + //Get the threaded comments collection + IThreadedComments threadedComments = worksheet.ThreadedComments. + + //Get the threaded comments count + int count = threadedComments.Count; + + //Save and dispose + workbook.SaveAs("ThreadedComments.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets cell range by row and column index. Row and column indexes are one-based. + + One-based row index. + One-based column index. + + + + Get cell Range. Row and column indexes are one-based. Read-only. + + First row index. One-based. + First column index. One-based. + Last row index. One-based. + Last column index. One-based. + + + + Gets cell Range. Read-only. + + + + + Gets cell Range with R1C1Notation flag. Read-only. + + + + + Gets a hyperlink collections in the worksheet. Read-only. + + + + + Gets all not empty or accessed cells. Read-only. + + + WARNING: This property creates Range object for each cell in the worksheet + and creates new array each time user calls to it. It can cause huge memory + usage especially if called frequently. + + The following code illustrates how to get the used cells range of a sheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + IRange[] usedCellsRange = sheet.UsedCells; + + + + + + Gets a collection of custom properties of the worksheet. Read-only. + + + + + Indicates whether all created range objects should be cached or not. + + + + + Defines whether freezed panes are applied. + + + + + Gets split cell range. + + + + + Gets or sets the top visible row of the worksheet. + + The following code illustrates how to get the top visible row. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + int topVisibleRow = sheet.TopVisibleRow; + + + + + + Gets or sets the left visible column of the worksheet. + + The following code illustrates how to get the left visible column. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + int leftVisibleColumn = worksheet.LeftVisibleColumn; + + + + + + Gets or sets whether used range should include cells with formatting. + + + There are two different algorithms to create UsedRange object: + 1) Default. This property = true. The cell is included into UsedRange, + even data is empty (maybe some formatting + changed, maynot be - cell was accessed and record was created). + 2) This property = false. In this case XlsIO tries to remove empty rows and + columns from all sides to make UsedRange smaller. + + + The following code illustrates how to set UsedRangeIncludesFormatting property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Text"; + + //Add format + worksheet["D3"].CellStyle.ColorIndex = ExcelKnownColors.Red; + + //Set used range includes formatting + worksheet.UsedRangeIncludesFormatting = false; + + //Get used range + Console.Write(worksheet.UsedRange.AddressLocal); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //C2 + + + + + + Gets a collection of pivot tables in the worksheet. Read-only. + + + + + Gets a collection of list objects in the worksheet. Read-only. + + + + + Gets or sets the view setting of the worksheet. + + The following code illustrates how to set the view of the sheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.View = SheetView.PageLayout; + + + + + + Gets collection in the worksheet. + + This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + The OLE objects. + + The following code illustrates how to access the collection in the worksheet to add a new . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream + System.Drawing.Image image = System.Drawing.Image.FromFile("image.png"); + + //Add ole object + IOleObject oleObject = worksheet.OleObjects.Add("Shapes.xlsx", image, OleLinkType.Embed); + + //Save and dispose + workbook.SaveAs("OLEObjects.xlsx"); + workbook.Close(); + } + + + + + + Gets whether the OLE object is present in the worksheet. Read-only. + + This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + True if this instance is OLE object; otherwise, False. + + + The following code illustrates how to access the collection in the worksheet to add a new . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream + System.Drawing.Image image = System.Drawing.Image.FromFile("image.png"); + + //Add ole object + IOleObject oleObject = worksheet.OleObjects.Add("Shapes.xlsx", image, OleLinkType.Embed); + + //Check HasOleObject + Console.Write(worksheet.HasOleObject); + + //Save and dispose + workbook.SaveAs("OLEObjects.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + + + + + + Gets the sparkline groups. + + The sparkline groups. + The following code illustrates how to get the Spark line groups from the sheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + //A new Sparkline group is added to the sheet sparklinegroups + ISparklineGroup sparklineGroup = sheet.SparklineGroups.Add(); + + //Set the Sparkline group type as line + sparklineGroup.SparklineType = SparklineType.Line; + + //Set to display the empty cell as line + sparklineGroup.DisplayEmptyCellsAs = SparklineEmptyCells.Line; + + //Sparkline group style properties + sparklineGroup.ShowFirstPoint = true; + sparklineGroup.FirstPointColor = System.Drawing.Color.Green; + sparklineGroup.ShowLastPoint = true; + sparklineGroup.LastPointColor = System.Drawing.Color.DarkOrange; + sparklineGroup.ShowHighPoint = true; + sparklineGroup.HighPointColor = System.Drawing.Color.DarkBlue; + sparklineGroup.ShowLowPoint = true; + sparklineGroup.LowPointColor = System.Drawing.Color.DarkViolet; + sparklineGroup.ShowMarkers = true; + sparklineGroup.MarkersColor = System.Drawing.Color.Black; + sparklineGroup.ShowNegativePoint = true; + sparklineGroup.NegativePointColor = System.Drawing.Color.Red; + + //set the line weight + sparklineGroup.LineWeight = 0.3; + //The sparklines are added to the sparklinegroup. + ISparklines sparklines = sparklineGroup.Add(); + + //Set the Sparkline Datarange + IRange dataRange = sheet.Range["D6:G17"]; + //Set the Sparkline Reference range + IRange referenceRange = sheet.Range["H6:H17"]; + + //Create a sparkline with the datarange and reference range + sparklines.Add(dataRange, referenceRange); + + ISparklineGroups sparkline = sheet.SparklineGroups; + + + + + + Gets the DataSorter. + + The sparkline groups. + The following code illustrates how to get the DataSorter from the sheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sorting.xlsx"); + + //Create DataSorter for worksheet. + IDataSort sheetSort = workbook.Worksheets[0].DataSorter; + + //Adding Sort range for worksheet + sheetSort.SortRange = workbook.Worksheets[0].UsedRange; + + //Adding Sorting fields for DataSorter. + sheetSort.SortFields.Add(1, SortOn.Values, OrderBy.Ascending); + + //Perform Sorting for worksheet range. + sheetSort.Sort(); + + workbook.SaveAs("SortedExcel.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + + Event to choose an action while exporting data from Excel to data table. + + + + + Occurs when the value of a cell changes. + + + + + Indicates whether cell contains array-entered formula. + + Cell index to check. + True if cell contains array-entered formula. + + + + Gets object that is clone of current worksheet in the specified workbook. + + Dictionary with update worksheet names. + New workbook object. + Object that is clone of the current worksheet. + + + + Get default row height in pixel. + + + + + Gets or sets one-based index of the first row of the worksheet. + + + + + Gets or sets one-based index of the first column of the worksheet. + + + + + Gets or sets one-based index of the last row of the worksheet. + + + + + Gets or sets one-based index of the last column of the worksheet. + + + + + Gets collection of cell records. Read-only. + + + + + Gets parent workbook. Read-only. + + + + + Gets excel version. + + + + + Style wrapper for multicell range. Redirects all + properties and method calls to the range styles. + + + + + Represents a style description for a range. The Style object contains + all style attributes (font, number format, alignment, and so on) as + properties. There are several built-in styles, including Normal, + Currency, and Percent. Using the Style object is a fast and efficient + way to change several cell-formatting properties on multiple cells at + the same time. + For the Workbook object, the Style object is a member of the Styles + collection. The Styles collection contains all the defined styles for + the workbook + + + + + True if the is a built-in . Read-only Boolean. + + + The following code illustrates how to check whether a is a built-in or not. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Check style built in + Console.WriteLine(workbook.Styles[6].BuiltIn); + Console.WriteLine(workbook.Styles[0].BuiltIn); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //False + //True + + + + + + Returns or sets the name of the object. Read-only String. + + + The following code illustrates how to access the name of the object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Check style name + Console.WriteLine(workbook.Styles[6].Name); + Console.WriteLine(workbook.Styles[0].Name); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //CustomStyle + //Normal + + + + + + Indicates whether is initialized (differs from Normal style). + Read-only. + + + By default if the style is created using method, then the style will be created based on the Normal style + which is the default style. If the created style is modified then will be set to "true". + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Check style initialized or not + Console.WriteLine(style.IsInitialized); + + //Set rich text + IRichTextString richText = worksheet["C2"].RichText; + + //Set text + richText.Text = "Sample"; + + //Set font + IFont font = style.Font; + + //Set color + font.Color = ExcelKnownColors.Red; + + //Set rich text font + richText.SetFont(0, 5, font); + + //Check style initialized or not + Console.Write(style.IsInitialized); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //False + //True + + + + + + Returns interior object for this extended format. + + + The following code illustrates how to access 's interior object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set interior + Syncfusion.XlsIO.Interfaces.IInterior interior = style.Interior; + + //Set color + interior.ColorIndex = ExcelKnownColors.Red; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Array that contains all cells. + + + + + Parent workbook. + + + + + Application. + + + + + Creates object that will contain all styles that are used by range. + + Range from which styles must be taken. + + + + Creates object that will contain all styles that are used by range. + + Range from which styles must be taken. + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object. + + + + + Detect whether the cell styles can be applied for the range. + + + + + For far east languages. Supported only for format. Always 0 for US. + + + + + Returns or sets the format code for the object as a string in the + language of the user. Read / write String. + + + + + Gets format index in m_book.InnerFormats. + + + + + Indicates whether style has border. Read-only Boolean. + + + + + Returns a Borders collection that represents the borders of a + style or a range of cells (including a range defined as part of + a conditional format). + + + + + True if the style is a built-in style. Read-only Boolean. + + + + + Gets / sets fill pattern. + + + + + Gets / sets index of fill background color. + + + + + Gets / sets fill background color. + + + + + Gets / sets index of fill foreground color. + + + + + Gets / sets fill foreground color. + + + + + Returns a Font object that represents the font of the specified + object. Read-only. + + + + + True if the formula will be hidden when the worksheet is protected. + Read/write Boolean. + + + + + Returns or sets the horizontal alignment for the specified object. + For all objects, this can be one of the following ExcelHAlign constants. + Read/write ExcelHAlign. + + + + + True if the style includes the AddIndent, HorizontalAlignment, + VerticalAlignment, WrapText, and Orientation properties. + Read/write Boolean. + + + + + True if the style includes the Color, ColorIndex, LineStyle, + and Weight border properties. Read/write Boolean. + + + + + True if the style includes the Background, Bold, Color, + ColorIndex, FontStyle, Italic, Name, OutlineFont, Shadow, + Size, Strikethrough, Subscript, Superscript, and Underline + font properties. Read/write Boolean. + + + + + True if the style includes the NumberFormat property. + Read/write Boolean. + + + + + True if the style includes the Color, ColorIndex, + InvertIfNegative, Pattern, PatternColor, and PatternColorIndex + interior properties. Read / write Boolean. + + + + + True if the style includes the FormulaHidden and Locked protection + properties. Read / write Boolean. + + + + + Returns or sets the indent level for the style. Read/write. + + + + + Indicates whether style is initialized (differs from Normal style). + Read-only. + + + + + True if the object is locked, False if the object can be + modified when the sheet is protected. Read/write Boolean. + + + + + Returns or sets the name of the object. Read-only String. + + + + + Returns or sets the format code for the object. Read / write String. + + + + + Gets / sets index of the number format. + + + + + Returns object that describes number format. Read-only. + + + + + Text rotation angle: + 0 Not rotated + 1-90 1 to 90 degrees counterclockwise + 91-180 1 to 90 degrees clockwise + 255 Letters are stacked top-to-bottom, but not rotated. + int.MinValue - different rotation angle for different ranges. + + Thrown when value is more than 0xFF. + + + + True if text automatically shrinks to fit in the available + column width. Read/write Boolean. + + + + + Returns or sets the vertical alignment of the specified object. + Read/write ExcelVAlign. + + + + + True if Microsoft Excel wraps the text in the object. + Read/write Boolean. + + + + + Text direction, the reading order for far east versions. + + + + + If true then first symbol in cell is apostrophe. + + + + + Returns or sets the color of the interior pattern as an index into the current color palette. + + + + + Returns or sets the color of the interior pattern as an Color value. + + + + + Returns or sets the color of the interior. The color is specified as + an index value into the current color palette. + + + + + Returns or sets the cell shading color. + + + + + Returns Interior object that represents the interior of the specified + object. Read-only. + + + + + Gets value indicating whether format was modified, compared to parent format. + + + + + Returns number of begin update calls that have no corresponding end update. Read-only. + + + + + Returns array of ranges that contain styles. Read-only. + + + + + Specifies a boolean value that indicates whether the application will + refresh the cache when the workbook has been opened. + + + + + Specifies the name of the end-user who last refreshed the cache. + + + + + Specifies the date when the cache was last refreshed. + + + + + Specifies the version of the application that created the cache. + + + + + Specifies the version of the application that last refreshed the cache. + + + + + Specifies the earliest version of the application that is required to refresh the cache. + + + + + Specifies the number of records in the cache. + + + + + Represents the description of data source whose data is stored in the pivot cache. + + + + + Specifies the cache type. + + + + + Indicates that the cache contains data that + consolidates ranges. + + + + + Indicates that the cache contains data from an + external data source. + + + + + Indicates that the cache contains a scenario summary + report + + + + + Indicates that the cache contains worksheet data. + + + + + Represents the location of the source of the data that is stored in the cache. + + + + + Specifies the reference that defines a cell range that is the source of the data. + + + + + Specifies the name of the sheet that is the source for the cached data. + + + + + Represents the collection of field definitions in the source data. + + + + + Specifies the number of fields in the cache. + + + + + Represent a single field in the PivotCache. + + + + + Specifies the name of the cache field. + + + + + Represents the PivotTable root element for non-null PivotTables. + + + + + This element enumerates pivot cache definition parts used by pivot tables and formulas in this workbook. + + + + + This element represents a cache of data for pivot tables and formulas in the workbook. + + + + + Specifies the unique identifier for the pivot cache for this workbook in the pivot cache part. + + + + + Specifies the pivot cache Id for pivot cache definition parts used by pivot tables. + + + + + Specifies the name of the value area field header in the PivotTable. + + + + + Specifies the version of the application that last updated the PivotTable view. + + + + + Specifies a boolean value that indicates whether calculated members should be shown + in the PivotTable view. This attribute applies to PivotTables from OLAP-sources only. + + + + + Specifies a boolean value that indicates whether auto formatting has + been applied to the PivotTable view. + + + + + Specifies a boolean value that indicates whether PivotItem names should + be repeated at the top of each printed page. + + + + + Specifies the indentation increment for compact axis and can be used to + set the Report Layout to Compact Form. + + + + + Specifies a boolean value that indicates whether new fields should have + their outline flag set to true. + + + + + Specifies a boolean value that indicates whether data fields in the + PivotTable should be displayed in outline form. + + + + + Specifies a boolean value that indicates whether the fields of a PivotTable + can have multiple filters set on them. + + + + + Represents the collection of fields that appear on the PivotTable. + + + + + Represents a single field in the PivotTable. + + + + + Represents the fill down label to show repeated items in pivot table rows and columns. + + + + + Represents whether the pivot field should be ignored or not. + + + + + Specifies a boolean value that indicates whether to show all items for this field. + + + + + Represents location information for the PivotTable. + + + + + Specifies the first row of the PivotTable header, relative to the top + left cell in the ref value. + + + + + Specifies the first row of the PivotTable data, relative to the top left cell in the ref value. + + + + + Specifies the first column of the PivotTable data, relative to the top left cell in the ref value. + + + + + Represents the pivotCacheDefinition part. This part defines each field + in the source data, including the name, the string resources of the + instance data (for shared items), and information about the type of + data that appears in the field. + + + + + Represents the collection of row fields for the PivotTable. + + + + + Represents the collection of items in row axis of the PivotTable. + + + + + Represents the collection of fields that are on the column axis of the PivotTable. + + + + + Represents the collection of column items of the PivotTable. + + + + + Specifies the index to the number format applied to this data field. + + + + + Represent information on style applied to the PivotTable. + + + + + Specifies a boolean value that indicates whether to show row headers for the table. + + + + + Specifies a boolean value that indicates whether to show column headers for the table. + + + + + Specifies a boolean value that indicates whether to show row + stripe formatting for the table. + + + + + Specifies a boolean value that indicates whether to show column stripe + formatting for the table. + + + + + Specifies a boolean value that indicates whether to show the last column. + + + + + Specifies a boolean value that indicates whether grand totals should be + displayed for the PivotTable columns. + + + + + Specifies a boolean value that indicates whether grand totals should be + displayed for the PivotTable rows. + + + + + Specifies a boolean value that indicates whether drill indicators should be hidden. + + + + + Represents the collection of unique items for a field in the PivotCacheDefinition. + + + + + Specifies a boolean value that indicates that this field contains text values. + The field may also contain a mix of other data type and blank values. + + + + + Specifies a boolean value that indicates whether this field contains a text value. + + + + + Specifies a boolean value that indicates whether this field contains numeric values. + + + + + Specifies a boolean value that indicates whether this field contains integer values. + + + + + Specifies a boolean value that indicates that the field contains at least one date. + + + + + Specifies a boolean value that indicates that the field contains at + least one value that is not a date. + + + + + Specifies a boolean value that indicates whether this field contains a blank value. + + + + + Specifies a boolean value that indicates wheter this field contains a long Text. + + + + + Specifies a boolean value that indicates whether to suppress display of pivot field. + + + + + Represents a generic field that can appear either on the column or the row region of the PivotTable. + + + + + Specifies the index to a pivotField item value. + + + + + Represents the collection of items in the row or column region of the PivotTable. + + + + + GrandTotal constant + + + + + Row Labels of pivot table + + + + + Specifies the type of the item. + + + + + constant + + + + + Represents an array of indexes to cached member property values. + + + + + Represents the collection of items in the data region of the PivotTable. + + + + + Represents a field from a source list, table, or database that contains data that is summarized in a PivotTable. + + + + + Specifies the index to the field (<r>) in the pivotCacheRecords part that this data item summarizes. + + + + + Specifies the index to the base field when the ShowDataAs calculation is in use. + + + + + Specifies the index to the base item when the ShowDataAs calculation is in use. + + + + + Specifies the aggregation function that applies to this data field. + + + + + Specifies the custom text that is displayed for the subtotals label. + + + + + Specifies the region of the PivotTable that this field is displayed. + + + + + Specifies a boolean value that indicates whether this field appears in the + data region of the PivotTable. + + + + + Represents the collection of items in a PivotTable field. + + + + + Represents a single item in PivotTable field. + + + + + Specifies the type of this item. A value of 'default' indicates the subtotal or total item. + + + + + Indicates the pivot item represents the default type for this PivotTable. + The default pivot item type is the "total" aggregate function. + + + + + Represents the collection of records in the PivotCache. + + + + + Represents a single record of data in the PivotCache. + + + + + Represents a numeric value in the PivotTable. + + + + + Represents a character value in a PivotTable. + + + + + Represents a value that was not specified. + + + + + Represents a date-time value in the PivotTable. + + + + + Represents a boolean value for an item in the PivotTable. + + + + + Unified date time format. + + + + + Specifies the value of the item. + + + + + Specifies a boolean value that indicates whether to apply the 'Average' + aggregation function in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether to apply the 'countA' + aggregation function in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether to apply the 'count' + aggregation function in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether to apply the 'max' + aggregation function in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether to apply the 'min' + aggregation function in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether to apply 'product' + aggregation function in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether to apply the 'stdDevP' + aggregation function in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether to use 'stdDev' + in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether apply the 'sum' + aggregation function in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether to apply the 'varP' + aggregation function in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether to apply the 'variance' + aggregation function in the subtotal of this field. + + + + + Specifies a boolean value that indicates whether the default subtotal + aggregation function is displayed for this field. + + + + + Specifies a boolean value that indicates whether the application should query and + retrieve records asynchronously from the cache. + + + + + Specifies a boolean value that indicates whether the user can refresh the cache. + + + + + Specifies a boolean value that indicates whether the cache needs to be refreshed. + + + + + Specifies a boolean value that indicates whether the application will apply optimizations + to the cache to reduce memory usage + + + + + Specifies a boolean value that indicates whether the pivot records are saved with the + cache. + + + + + Specifies whether the cache's data source supports attribute drilldown + + + + + Specifies whether the cache's data source supports subqueries. + + + + + Specifies a boolean value that indicates whether the cache is scheduled for version + upgrade. + + + + + Specifies a boolean value that indicates whether this field came from the source + database + + + + + Specifies the formula for the calculated field + + + + + Represents the collection of properties for a field group. + + + + + Specifies a boolean value that indicates whether an asterisks should be displayed in + subtotals and totals + + + + + Specifies the string to be displayed in column header in compact mode. This attribute + depends on whether the application implements a compact mode for displaying + PivotTables in the user interface. + + + + + Specifies the compact new fileds + + + + + Specifies the display compact Data + + + + + This attribute indicates the wheater to auto sort pivot table or not + + + + + This attribute represents the multiple fields in the data region + is located in the row area or the column area + + + + + This attribute represents the position for the field which representing multiple data field in the PivotTable + + + + + this attribute indicates whether to disable the PivotTable field list. + + + + + This attribute that indicates whether the user is allowed to edit the cells in + the data area of the PivotTable. + + + + + This attribute that indicates whether the user is prevented from drilling down + on a PivotItem or aggregate value. + + + + + indicates whether the user is prevented from displaying + PivotField properties. + + + + + This attribute that indicates whether the user is prevented from displaying + the PivotTable wizard. + + + + + This attribute Specifies the string to be displayed in cells that contain errors. + + + + + this attribute that indicates whether fields in the PivotTable are sorted in + non-default order in the field list. + + + + + Specifies the display name + + + + + Specifies the number of columns per page for this PivotTable that the filter area will + occupy. + + + + + Specifies the number of rows per page for this PivotTable that the filter area will occupy. + + + + + Specifies a boolean value that indicates whether the approximate number of child items + for this item is greater than zero. + + + + + Specifies a boolean value that indicates whether this item has been expanded in the + PivotTable view. + + + + + Specifies a boolean value that indicates whether attribute hierarchies nested next to + each other on a PivotTable row or column will offer drilling "across" each other or not. + + + + + Specifies a boolean value that indicates whether this item is a calculated member. + + + + + Specifies a boolean value that indicates whether the item is hidden. + + + + + Specifies the user caption of the item. + + + + + Specifies a boolean value that indicates whether the item has a character value. + + + + + Specifies a boolean value that indicates whether the details are hidden for this item. + + + + + Specifies a boolean value that indicate whether the item has a missing value. + + + + + Specifies the type of this item. A value of 'default' indicates the subtotal or total item. + + + + + Specifies the base of this field, + + + + + Specifies the parent of this field, + + + + + Represents the collection of discrete grouping properties for a field group + + + + + Represents the collection of items in a field group. + + + + + Represents the collection of range grouping properties. + + + + + Specifies a boolean value that indicates whether the application uses the source data to + set the ending range value. + + + + + Specifies a boolean value that indicates whether we use source data to set the beginning + range value. + + + + + Specifies the ending value for date grouping if autoEnd is false. + + + + + Specifies the ending value for numeric grouping if autoEnd is false. + + + + + Specifies the grouping. + + + + + Specifies the grouping interval for numeric range grouping. Specifies the number of days + to group by in date range grouping + + + + + Specifies the starting value for date grouping if autoStart is false. + + + + + Specifies the starting value for numeric grouping if autoStart is false. + + + + + Specifies a boolean value that indicates whether an "AutoShow" filter is applied to this + field. + + + + + Specifies a boolean value that indicates whether the field can be removed from the + PivotTable. + + + + + Specifies a boolean value that indicates whether the field can be dragged to the column + axis. + + + + + Specifies a boolean value that indicates whether the field can be dragged to the data + region. + + + + + Specifies a boolean value that indicates whether the field can be dragged to the page + region + + + + + Specifies a boolean value that indicates whether the field can be dragged to the row axis + + + + + Specifies a boolean value that indicates whether new items that appear after a refresh + should be hidden by default. + + + + + Specifies a boolean value that indicates whether manual filter is in inclusive mode. + + + + + Specifies a boolean value that indicates whether to insert a blank row after each item. + + + + + Specifies a boolean value that indicates whether to insert a page break after each item. + + + + + Specifies the number of items showed per page in the PivotTable. + + + + + Specifies a boolean value that indicates whether field has a measure based filter. + + + + + Specifies a boolean value that indicates whether the field can have multiple items + selected in the page field. + + + + + Specifies a boolean value that indicates whether to hide drop down buttons on PivotField + headers + + + + + Specifies a boolean value that indicates whether to show the property as a member + caption. + + + + + Specifies a boolean value that indicates whether to show the member property value in a + tooltip on the appropriate PivotTable cells. + + + + + Specifies the type of sort that is applied to this field. + + + + + Specifies the unique name of the member property to be used as a caption for the field + and field items. + + + + + Represents an item within a PivotTable field that uses a formula + + + + + Represents an item within a PivotTable field that uses a formula + + + + + Represents a set of selected fields and selected items within those fields + + + + + Represents a set of selected fields and selected items within those fields + + + + + Flag indicating whether any indexes refer to fields or items in the Pivot cache + + + + + Flag indicating whether the column grand total is included. + + + + + Flag indicating whether only the data values + + + + + Position of the field within the axis to which this rule applies. + + + + + Flag indicating whether the row grand total is included + + + + + Flag indicating whether only the item labels for an item selection + are selected and does + not include the data values + + + + + Flag indicating whether the Collapsed levels are subtotals. + + + + + A Reference that specifies a subset of the selection area. + + + + + Specifies a boolean value that indicates whether the + item is referred to by position rather than item index. + + + + + Specifies a boolean value that indicates whether the item is + referred to by a relative reference rather than an absolute reference + + + + + Specifies a boolean value that indicates whether this field has selection + + + + + Pivot Area tag + + + + + Pivot Area Type + + + + + Represents the collection of conditional formats applied to a PivotTable + + + + + Represents the conditional formatting defined in the PivotTable. + + + + + Specifies a boolean value that indicates whether the in-grid drop zones should be + displayed at runtime, and whether classic layout is applied. + + + + + Specifies a boolean value that indicates how the page fields are laid out + when there are multiple PivotFields in the page area. + + + + + Specifies a boolean value that indicates whether to show error messages in cells + + + + + Specifies a boolean value that indicates + whether to show a message in cells with no value. + + + + + Specifies a boolean value that indicates whether to + show a message in cells with no value. + + + + + Specifies a boolean value that indicates whether the formatting applied by + the user to the PivotTable cells is discarded on refresh. + + + + + Specifies a boolean value that indicates whether tooltips should be + displayed for PivotTable data cells. + + + + + + + + + + Specifies a boolean value that indicates whether row or column titles that span multiple + cells should be merged into a single cell. + + + + + Specifies the number of page fields to display before starting another row or column. + + + + + Represents the collection of filters that apply to this PivotTable. + + + + + Specifies the description of the pivot filter. + + + + + Specifies the evaluation order of the pivot filter. + + + + + Specifies the index of the measure field. + + + + + Specifies the index of the measure cube field. + + + + + Indicates whether the AutoFilter button for this column is hidden + + + + + Flag indicating whether the filter button is visible. + + + + + Specifies the element for Auto filter. + + + + + Specifies the element for filter column + + + + + Specifies the attributes for operator which is applied in pivot filter. + + + + + Specifies the string value "1" used by label pivot filters. + + + + + Zero-based index indicating the AutoFilter column to which this filter information applies. + + + + + Specifies the string value "2" used by label pivot filters. + + + + + Specifies the unique identifier of the pivot filter as assigned by the PivotTable. + + + + + Specifies the element for Custom filters. + + + + + Specifies the element for Custom filter + + + + + Attribute specifying whether and operator is used. + + + + + Top or bottom value to use as the filter criteria. + + + + + Flag indicating whether to filter by blank. + + + + + The actual cell value in the range which is used to perform the comparison for this filter. + + + + + Flag indicating whether or not to filter by percent value of the column. + + + + + Flag indicating whether or not to filter by top order + + + + + Specifies the element for Top 10 filter + + + + + Specifies the element for Dynamic filter + + + + + Represents the collection of filter that apply to this PivotFilters. + + + + + Represents the collection of custom formats apply to the pivot table. + + + + + Represents the custom format in the pivot table. + + + + + Represents the collection of formats applied to PivotChart. + + + + + Specifies the string to be displayed in row header in compact mode. + + + + + Represents the sorting scope for the PivotTable. + + + + + Represents a Error value in a PivotTable. + + + + + Represents the collection of OLAP hierarchies in the PivotCache. + + + + + Represents the collection of Key Performance Indicators (KPIs) + defined on the OLAP server and stored in the PivotCache. + + + + + Represents the collection of PivotTable OLAP dimensions. + + + + + Represents a PivotTable OLAP measure group. + + + + + Represents the PivotTable OLAP measure group - Dimension maps. + + + + + Represents the collection of OLAP hierarchies associated with the PivotTable. + + + + + Represents the collection of references to OLAP hierarchies on the row axis of a PivotTable. + + + + + Represents the collection of references to OLAP hierarchies on the column axis of a PivotTable. + + + + + Specifies the hierarchy that this field is part of. + + + + + Specifies the hierarchy level that this field is part of. + + + + + Represents the Pivot Field Captions. + + + + + Specifies a boolean value that indicates whether sort is applied to this field in the datasource. + + + + + Specifies a boolean value that indicates the drill state of the attribute hierarchy in an + OLAP-based PivotTable. + + + + + Specifies a boolean value that indicates whether all items in the field are expanded. + Applies only to OLAP PivotTables. + + + + + Indicates whether the pivot cache has missing items. + + + + + Specifies the hierarchy level that this page field is part of. + + + + + Specifies a boolean value that indicates whether this field Member Property + database + + + + + Specifies the string to be displayed for grand totals. + + + + + Specifies a boolean value that indicate whether the item has tuple cache. + + + + + Specifies a string to display the selected value. + + + + + Specifies a string to display the filter value. + + + + + Constructor used to prevent from creating instances of this class. + + + + + This class is repsonsible for pivot cache serialization in Excel 2007 format. + + + + + Default application version. + + + + + Serializes pivot cache definition. + + XmlWriter to serialize into. + Cache to serialize. + Current workbook. + Relation id to the pivot cache records. + + + + Serializes cache fields. + + Writer to serialize into. + Fields collection. + + + + Serializes cache field. + + Writer to serialize into. + Field to serialize. + + + + Serializes field shared items. + + XmlWriter to serialize shared items into. + Field to serialzie shared items for. + + + + Serializes cache source. + + XmlWriter to serialize into. + Cache to serialize. + + + + Serializes the pivot table scenario + + XmlWriter to serialize into. + pivot cache + + + + Serializes the pivot cache worksheet source + + Xml writer to Serialize + cache to serialized the data + + + + Serializes pivot cache External Source + + XmlWriter to serialize into. + Cache to serialize. + + + + Serializes pivot cache consolidation Source + + XmlWriter to serialize into. + Cache to serialize. + + + + Serializes pivot cache definition. + + XmlWriter to serialize into. + Cache to serialize. + + + + Serializes pivot cache value. + + XmlWriter to serialize value into. + Value to serialize. + + + + Serialize Calculated items of Cache field + + xml writer to write items + calculated item to write + + + + Serialize the Calculated Item of Cache Field + + Xml writer to write + item to write + + + + Serialize the Calculated Pivot item which the formula applies to + + xml writer to serialize into + area to serialize + + + + Serialize the pivot area references + + Xml Writer to serialize into + references to seralize to + + + + Serialize the Pivot area reference + + XMl Writer to Serialize into + reference to serialize + + + + Serializes field group + + Xml writer to serialize into + field to serialize group + + + + Serializes field group + + Xml writer to serialize into + field to serialize group + + + + Serializes the Field group items + + + + + + + Serialize the Field Group Range Properties + + Xml writer to serialize into + field group to serialize + + + + Serializes the Filed Group discrete property + + Xml writer to serialize into + Feild Group + + + + Serialize cache olap hierarchy collections + + xml writer to write items + cache item to serialize. + + + + Serialize pivot cache extension + + xml writer to write items + cache item to serialize. + + + + Serializes Pivot Key Performance Indicators (KPIs) defined in the OLAP. + + xml writer to write items + cache item to serialize. + + + + Serializes PivotTable OLAP dimension collection. + + xml writer to write items + cache item to serialize. + + + + Serializes the PivotTable OLAP measure group - Dimension maps. + + xml writer to write items + cache item to serialize. + + + + Serializes the PivotTable OLAP Dimension maps. + + xml writer to write items + cache item to serialize. + + + + collects the item index of calculated item + + field contains caluclated item + + + + Serializes attribute if it differs from default value. + + XmlWriter to serialize into. + Attribute name. + Attribute value. + Default value. + + + + Index of the data field. + + + + + Serializes pivot table object in xml format. + + XmlWriter to serialize into. + Pivot table to serialize. + + + + Serialize the row items of pivottableDefinition.xml + + + + + + + + Serialize the column items of PivottableDefinition.xml + + + + + + + + Serializes the Extern List of Pivot table Definition. + + Xml writer to serialize the chart formats into. + pivot table to serialize the filters + + + + Serializes the Chart format elements associated with the pivot table fields. + + Xml writer to serialize the chart formats into. + pivot table to serialize the filters + + + + Serializes the Custom format elements of the pivot table fields. + + Xml writer to serialize the custom formats into. + pivot table to serialize the filters + + + + Serializes the filters elements of the pivot table fields. + + Xml writer to serialize the fileter into. + pivot table to serialize the filters + + + + Serialize the filter of the pivot filters. + + XmlWriter to serialize the pivot table into. + pivot table object to serialize. + + + + Serialize the filter of the pivot filters. + + XmlWriter to serialize the pivot table into. + pivot table object to serialize. + + + + Serialize the filter of the pivot filters. + + XmlWriter to serialize the pivot table into. + pivot table object to serialize. + + + + Serialize the Custom filters of the Filter Column. + + XmlWriter to serialize the pivot table into. + pivot table object to serialize. + + + + Serialize the custom filter of the custom filters. + + XmlWriter to serialize the pivot table into. + pivot table object to serialize. + + + + Serialize the color filter of the Filter Column. + + XmlWriter to serialize the pivot table into. + pivot table object to serialize. + + + + Serialize the custom filter of the custom filters. + + XmlWriter to serialize the pivot table into. + pivot table object to serialize. + + + + Serialize the dynamic filter of the custom filters. + + XmlWriter to serialize the pivot table into. + dynamic filter of pivot table to serialize. + + + + Serialize the conditional Formats of the pivot table. + + XmlWriter to serialize the pivot table into. + pivot table object to serialize. + + + + Serializes pivot style. + + XmlWriter to serialize pivot style into. + Pivot table to serialize style for. + + + + Serializes row fields. + + XmlWriter to serialize row fields into. + Pivot table to serialize row fields for. + + + + Serailizes column fields. + + XmlWriter to serialize into. + Pivot table to serialize column fields for. + + + + Serializes fields (row or column). + + XmlWriter to serialize fields into. + Pivot table to serialize fields for. + Field axis to detect fields to serialize. + Tag name for the fields to use. + Tag for single field. + Indicates whether to add field used for data fields. + + + + Checks the is equal. + + The LST fields. + The copy indexs. + + + + Serializes column items. + + XmlWriter to serialize into. + List of field indexes to serialize. + Name of the main xml tag that will contain serialized fields. + Parent pivot table. + + + + Serializes data fields. + + XmlWriter to serialize fields into. + PivotTable to serialize data fields for. + + + + Return the Number Format Index Field. + + + + + + + + Serializes subtotal value. + + XmlWriter to serialize into. + Subtotal type to serialize. + + + + Serializes pivot fields. + + XmlWriter to serialize fields into. + Pivot table to serialize fields for. + + + + Serializes single pivot field. + + XmlWriter to serialize pivot field into. + Field to serialize. + + + + Serializes extension list of the pivot field. + + XmlWriter to serialize into. + PivotField to serialize. + + + + Serializes subtotal flags as set of pivot field attributes. + + XmlWriter to serialize into. + Subtotal options to serialize. + + + + Serializes single subtotal flag if necessary. + + XmlWriter to serialize into. + Subtotal options to serialize. + Single subtotal option to check. + Default option value. + Attribute name to store option value if necessary. + + + + Serializes data field special attributes. + + XmlWriter to serialize data field into. + Field to serialize. + + + + Serializes ordinary (not data) field special attributes. + + XmlWriter to serialize into. + Field to serialize. + + + + Gets the pivot field item value. + + DataType of the field item. + String value of the field item. + Item value converted to appropriate data type. + + + + Serializes the sorting scope of the pivot field. + + XmlWriter to serialize into. + pivot field obj + + + + Serializes subtotal items. + + XmlWriter to serialize into. + Subtotal values to serialize. + + + + Serializes subtotal items. + + XmlWriter to serialize into. + Subtotal values to serialize. + + + + Sorts field values. + + Cache field to sort items for. + Sorted list with field values: key - field value, value - item index. + + + + Sorts field values. + + Cache field to sort items for. + Custom sort list based on which sorting is to be done. + List with field values: key - field value, value - item index. + + + + Sorts field values. + + Pivot filed to sort items for. + Custom sort list based on which sorting is to be done. + List with field values: key - field value, value - item index. + + + + Sorts field values. + + Pivot filed to sort items for. + List with field values: key - field value, value - item index. + + + + Sorts pivot inner items. + + Pivot inner items. + Pivot table. + List with field values: key - field value, value - item index. + + + + Serializes pivot table location. + + XmlWriter to serialize location into. + Pivot table to serialize location for. + + + + Serializes the OLAP hierarchies associated with the PivotTable. + + Xml writer to serialize the chart formats into. + pivot table to serialize the filters + + + + Serializes references to OLAP hierarchies on the row axis of a PivotTable. + + Xml writer to serialize the chart formats into. + pivot table to serialize the filters + + + + Serializes references to OLAP hierarchies on the column axis of a PivotTable. + + Xml writer to serialize the chart formats into. + pivot table to serialize the filters + + + + This class represents value-index pair and used to sort pivot field values. + + + + + This class represents custom comparer to sort pivot field values based on custom sort list. + + + + + Represents the memory cache for a PivotTable report. + + + + + Gets the index number of the pivot cache within . Read-only. + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use Index property in PivotCache. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + + //Gets the pivot cache's index number + int cacheIndex = cache.Index; + if(cacheIndex >= 0) + { + //Your Code Here + } + + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets a value from that identifies the type of item being published. Read-only. + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use SourceType property in PivotCache. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + + //Gets a value that identifies the type of item being published + ExcelDataSourceType cacheSourceType = cache.SourceType; + if(cacheSourceType == ExcelDataSourceType.Worksheet) + { + //Your Code Here + } + + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the data source for the PivotTable report. Read-only. + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use SourceRange property in PivotCache. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + + //Gets the data source range for the Pivot cache + IRange cacheSourceRange = cache.SourceRange; + if(cacheSourceRange != null) + { + //Your Code Here + } + + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Represents the collection of memory caches from the PivotTable reports in a workbook. + + + + + Adds a new PivotTable cache to a collection. + + that contains data to cache. + Returns a . + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to add a cache to PivotCaches collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + + //Adds a new PivotTable cache to a PivotCaches collection + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets number of pivot cache items in the collection. Read-only. + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to get a Count of pivot cache collections. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("SamplePivot.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + + //Gets number of pivot cache items in the collection + int pivotCachesCount = workbook.PivotCaches.Count; + if(pivotCachesCount > 0) + { + //Your Code Here + } + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets a with the specified index from the collection. Read-only. + + Zero-based index of the cache to return. + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use index property in PivotCache collections. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + + //Gets a pivot cache value from the index of the collection + ExcelDataSourceType cacheSourceType = workbook.PivotCaches[0].SourceType; + if(cacheSourceType == ExcelDataSourceType.Worksheet) + { + //Your Code Here + } + + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Represents a data field in pivot table report. + + + + + Set the previous value to BaseItem. + + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use a SetPreviousBaseItem method in pivot data field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + IPivotDataField pivotDataField = pivotTable.DataFields[0]; + pivotDataField.ShowDataAs = PivotFieldDataFormat.Difference; + pivotDataField.BaseField = 1; + pivotDataField.BaseItem = 2; + + //Set the previous value to base item + pivotDataField.SetPreviousBaseItem(); + + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Set the next value to BaseItem. + + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use a SetNextBaseItem method in pivot data field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + IPivotDataField pivotDataField = pivotTable.DataFields[0]; + pivotDataField.ShowDataAs = PivotFieldDataFormat.Difference; + pivotDataField.BaseField = 1; + pivotDataField.BaseItem = 2; + + //Set the next value to base item + pivotDataField.SetNextBaseItem(); + + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets name of the data field. + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use a Name property in pivot data field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + IPivotDataField pivotDataField = pivotTable.DataFields[0]; + + //Sets name of the data field + pivotDataField.Name = "SUM Marks"; + + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the function used for data field. + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use a Subtotal property in pivot data field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + IPivotDataField pivotDataField = pivotTable.DataFields[0]; + + //Sets the subtotal function used for data field + pivotDataField.Subtotal = PivotSubtotalTypes.Average; + + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the indicating how the pivot data is shown. + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use a ShowDataAs property in pivot data field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + IPivotDataField pivotDataField = pivotTable.DataFields[0]; + + //Sets the pivot table format indicating how the pivot data is shown + pivotDataField.ShowDataAs = PivotFieldDataFormat.PercentageOfTotal; + + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the base item for a custom calculation. + + Valid only for data fields. To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use a BaseItem property in pivot data field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + IPivotDataField pivotDataField = pivotTable.DataFields[0]; + pivotDataField.ShowDataAs = PivotFieldDataFormat.Difference; + + //Sets the base item for a custom calculation + pivotDataField.BaseItem = 2; + pivotDataField.BaseField = 1; + + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the base field for a custom calculation. + + Valid only for data fields. To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use a BaseField property in pivot data field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + IPivotDataField pivotDataField = pivotTable.DataFields[0]; + pivotDataField.ShowDataAs = PivotFieldDataFormat.Difference; + + //Sets the base field for a custom calculation + pivotDataField.BaseField = 1; + pivotDataField.BaseItem = 2; + + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the number format for the pivot data field. + + The following code snippet illustrates how to use a NumberFormat property in pivot data field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:C6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[0].Axis = PivotAxisTypes.Column; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + + //Sets number format for the pivot data field + pivotTable.DataFields[0].NumberFormat = "#,##0_);(#,##0)"; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Represents the collection of data fields from the PivotTable reports in a workbook. + + + + + Adds a new data field to the collection. + + The parent field to use. + The name for the new data field. + The subtotal function for the new data field. + Returns a . + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to add a pivot data field to the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + + //Adds a new data field to the PivotDataField collection + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets a with the specified index from the collection. Read-only. + + Zero-based index of the data field to return. + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use a index property in pivot data field collections. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + + //Gets a pivot data field with the specified index from the collection + IPivotDataField pivotDataField = pivotTable.DataFields[0]; + pivotDataField.Name = "SUM Marks"; + pivotDataField.Subtotal = PivotSubtotalTypes.Average; + + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets a with the specified name from the collection. Read-only. + + Pivot data field name + + The following code illustrates how to get the pivot table data field by data field name. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + + //Gets a pivot data field with the specified name from the collection + IPivotDataField pivotDataField = pivotTable.DataFields["Sum of Marks"]; + pivotDataField.Name = "SUM Marks"; + pivotDataField.Subtotal = PivotSubtotalTypes.Average; + + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the number of data fields in this collection. Read-only. + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use a Count property of the pivot field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("SamplePivot.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + + //Gets the number of data fields in this collection + int pivotDataFieldsCount = pivotSheet.PivotTables[0].DataFields.Count; + if(pivotDataFieldsCount > 0) + { + //Your Code Here + } + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Represents a field in a PivotTable report. + + + + + Sorts pivot field items in the given order. + + Array of strings to be sorted. + + To know more about Pivot Tables refer this link. + + + The following code illustrates sorting of pivot field items based on custom set of strings. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField pivotField = pivotTable.Fields[1]; + + //Sorts pivot field items in the given order + pivotField.Sort(new string[5] { "Breto", "Marson", "Jack", "Andrew", "Sam" }); + + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Sorts pivot row or column values in the given sort type. + + Type of sort that is applied to this field. + Row or Column number of the pivot table that the sort is applied to. + + The following code illustrates sorting of pivot row and column values based on sort type. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + + IWorkbook workbook = application.Workbooks.Open(@"PivotData.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + IPivotTable pivotTable = worksheet.PivotTables[0]; + + //Pivot table row sorting. + IPivotField columnField = pivotTable.ColumnFields[0]; + columnField.AutoSort(PivotFieldSortType.Ascending, 1); + + //Pivot table column sorting. + IPivotField rowField = pivotTable.RowFields[0]; + rowField.AutoSort(PivotFieldSortType.Descending, 1); + + workbook.SaveAs("Output.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets or sets the name of the pivot field. + + + To know more about Pivot Tables refer this link. + + The following code illustrates the use of Name property in pivot field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:C6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + + //Sets the name of the pivot field + pivotTable.Fields[0].Name = "StudentID"; + + pivotTable.Fields[0].Axis = PivotAxisTypes.Column; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the of pivot field. + + + To know more about Pivot Tables refer this link. + + The following code illustrates how to sets the field axis in pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:C6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + + //Sets the axis of the pivot field + pivotTable.Fields[0].Axis = PivotAxisTypes.Column; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the in current pivot field. + + + To know more about Pivot Tables refer this link. + + The following code illustrates how to get pivot field group and use it for date time grouping. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Input.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create Pivot cache with the given data range + IPivotCache cache = workbook.PivotCaches.Add(worksheet["A1:C8"]); + + //Create "PivotTable1" with the cache at the specified range + IPivotTable pivotTable = worksheet.PivotTables.Add("PivotTable1", worksheet["A1"], cache); + + //Get the pivot group field from pivot field. + IPivotFieldGroup fieldGroup = pivotTable.Fields[0].FieldGroup; + + //Set the pivot field group type. + fieldGroup.GroupBy = PivotFieldGroupType.Months; + + //Set the pivot field group start date. + fieldGroup.StartDate = new DateTime(2023,5,20) + + //Set the pivot field group end date. + fieldGroup.EndDate = new DateTime(2023,10,3); + + workbook.SaveAs("Output.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + } + + + + + + Gets or sets the Filter value of Page fields. + + + To know more about Pivot Tables refer this link. + + + + + Gets or sets the number format for the pivot field. + + + To know more about Pivot Tables refer this link. + + The following code illustrates how to use the number format in pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:C6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + + //Sets number format for the pivot field + pivotTable.Fields[2].NumberFormat = "#,##0_);(#,##0)"; + + pivotTable.Fields[0].Axis = PivotAxisTypes.Column; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the used for pivot field. + + + To know more about Pivot Tables refer this link. + + The following code illustrates how to use Subtotals property in pivot field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 88; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + + //Sets the subtotal function used for pivot field + pivotTable.Fields[1].Subtotals = PivotSubtotalTypes.Count; + + pivotTable.Fields[0].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating whether the subtotal is positioned at the top. The default value is True. + + + To know more about Pivot Tables refer this link. + + The following code illustrates how to use ShowSubtotalAtTop property in pivot field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 88; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + + //Sets the subtotal function used for pivot field + pivotTable.Fields[1].ShowSubtotalAtTop = false; + + pivotTable.Fields[0].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating if user can drag field to row area. + The default value is True. + + + To know more about Pivot Tables refer this link. + + The following code illustrates how to use CanDragToRow property in pivot field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + + //Sets a Boolean value indicating if user can drag field to row area + pivotTable.Fields[0].CanDragToRow = false; + + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating if user can drag field to column area. + The default value is True. + + + To know more about Pivot Tables refer this link. + + The following code illustrates how to use CanDragToColumn property in pivot field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + + //Sets a Boolean value indicating if user can drag field to column area + pivotTable.Fields[0].CanDragToColumn = false; + + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating if user can drag field to page area. + The default value is True. + + + To know more about Pivot Tables refer this link. + + The following code illustrates how to use CanDragToPage property in pivot field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + + //Sets a Boolean value indicating if user can drag field to page area + pivotTable.Fields[0].CanDragToPage = false; + + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating if user can remove field from view. + The default value is True. + + + To know more about Pivot Tables refer this link. + + The following code illustrates how to use CanDragOff property in pivot field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + + //Sets a Boolean value indicating if user can remove field from view + pivotTable.Fields[0].CanDragOff = false; + + pivotTable.Fields[0].Axis = PivotAxisTypes.Page; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating if a blank row is inserted + after the specified row field in a PivotTable report. + + + To know more about Pivot Tables refer this link. + + The following code illustrates how to use ShowBlankRow property in pivot field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 88; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + + //Sets a Boolean value to insert a blank row after the specified row field + pivotTable.Fields[1].ShowBlankRow = true; + + pivotTable.Fields[0].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating if the specified field can be dragged to the data position. + The default value is True. + + + To know more about Pivot Tables refer this link. + + The following code illustrates how to use CanDragToData property in pivot field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + + //Sets a Boolean value indicating if user can drag field to data position + pivotTable.Fields[0].CanDragToData = false; + + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets a Boolean value indicating if this field is formula field. Read-only. + + + To know more about Pivot Tables refer this link. + + The following code illustrates how to use IsFormulaField property in pivot field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark1"; + sheet.Range["D1"].Text = "Mark2"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Number = 87; + sheet.Range["D3"].Number = 68; + sheet.Range["D4"].Number = 98; + sheet.Range["D5"].Number = 45; + sheet.Range["D6"].Number = 70; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotField field = pivotTable.CalculatedFields.Add("AverageMark", "(Mark1+Mark2)"); + field.Formula = "(Mark1+Mark2)/2"; + + //Gets a Boolean value indicating if this field is formula field + bool isFormula = field.IsFormulaField; + if(isFormula) + { + //Your Code Here + } + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the formula for the calculated field. + + + To know more about Pivot Tables refer this link. + + The following code illustrates how to use Formula property in pivot field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark1"; + sheet.Range["D1"].Text = "Mark2"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Number = 87; + sheet.Range["D3"].Number = 68; + sheet.Range["D4"].Number = 98; + sheet.Range["D5"].Number = 45; + sheet.Range["D6"].Number = 70; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotField field = pivotTable.CalculatedFields.Add("AverageMark", "(Mark1+Mark2)"); + + //Sets the formula for the calculated field + field.Formula = "(Mark1+Mark2)/2"; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the collection for the pivot field. Read-only. + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use PivotFilters property in the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + IPivotField field = pivotTable.Fields[1]; + + //Adds filter with Value/Label based on the specified filter values + field.PivotFilters.Add(PivotFilterType.ValueBetween, field, "50", "80"); + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets which are the individual data entries in a field category. + Read-only. + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use a Items property in pivot field item. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + + //Gets the field item from the collection based on the specified text + IPivotField pivotField = pivotTable.Fields[1]; + pivotField.Items["Andrew"].Position = 4; + + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the position of the field (first,second,third and so on) among all the fields in its Axis (Row,Column,Page,Data). + + + To know more about Pivot Tables refer this link. + + The following code illustrates how to use Position property in pivot field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + pivotTable.Fields[0].Axis = PivotAxisTypes.Row; + + //Sets the position of the field + pivotTable.Fields[0].Position = 1; + pivotTable.Fields[1].Position = 0; + + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether newly added pivot table items should be tracked when manual filtering is applied to pivot field. If a Boolean value is true newly added items are included into the manual layout of the pivot table. + + + To know more about Pivot Tables refer this link. + + The following code illustrates how to use IncludeNewItemsInFilter property in pivot field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 88; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + + //Sets a Boolean value to include the newly added items in manual layout + pivotTable.Fields[1].IncludeNewItemsInFilter = true; + + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + + Get or set a Boolean value indicating whether the Quarters and Years fields are applied to a date field or not. + + + To know more about Pivot Tables refer this link. + + The following code illustrates how to use EnableQuartersandYears property in pivot field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Date"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Value = "7/23/2014"; + sheet.Range["A3"].Value = "1/13/2015"; + sheet.Range["A4"].Value = "8/1/2016"; + sheet.Range["A5"].Value = "6/15/2017"; + sheet.Range["A6"].Value = "5/30/2018"; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 88; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[0].Axis = PivotAxisTypes.Row; + + //Get or set the Quarters and Years fields for a date field in a pivot table. + pivotTable.Fields[0].EnableQuartersAndYears = true; + + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Represents a collection of in the pivot table. + + + + + Gets the number of pivot fields in the pivot table. + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use a Count property of the pivot field. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("SamplePivot.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + + //Gets the number of pivot fields in the pivot table + int pivotFieldCount = pivotSheet.PivotTables[0].Fields.Count; + if(pivotFieldCount > 0) + { + //Your Code Here + } + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the from the collection with the specified index. Read-only. + + Item index to return. + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use a index property in pivot field collections. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + + //Gets the pivot field from the collection with the specified index + IPivotField pivotField = pivotTable.Fields[2]; + pivotField.NumberFormat = "#,##0_);(#,##0)"; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the from the collection with the specified name. Read-only. + + Name of the item to return. + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use a name as index in pivot field collections. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + + //Gets the pivot field from the collection with the specified name + IPivotField pivotField = pivotSheet.PivotTables[0].Fields["Mark(Out of 100)"]; + pivotField.NumberFormat = "#,##0_);(#,##0)"; + pivotTable.Fields["Student Name"].Axis = PivotAxisTypes.Row; + pivotTable.Fields["Student City"].Axis = PivotAxisTypes.Column; + + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Represents a PivotTable on a worksheet. + + + + + Clears all the fields, deletes all filtering and sorting applied to the PivotTable. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to clear the all fields, filters and sorting using ClearTable method. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:C6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[0].Axis = PivotAxisTypes.Column; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + + //Clears all the fields, deletes all filtering and sorting applied to the PivotTable + pivotTable.ClearTable(); + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Get cell format for the given pivot range. + + Pivot range to get the cell format. + Pivot cell format + + Following code snippet illustrates how to get pivot cell format from the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:C6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[0].Axis = PivotAxisTypes.Column; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + + //Get the cell format for "A1" pivot range. + IPivotCellFormat cellFormat = pivotTable.GetCellFormat("A1"); + cellFormat.BackColor = ExcelKnownColors.Red; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Draws a layout for the pivot table. + + This property is not supported in UWP, Xamarin and ASP.NET Core platforms. To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to layout a pivot table similar to MS Excel. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:C6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[0].Axis = PivotAxisTypes.Column; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + + //The following code sample must be included to XlsIO layout the pivot table like MS Excel. + pivotTable.Layout(); + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the pivot table name. This property allows you to Read and Write a pivot table name. + + + To know more about Pivot Tables refer this link. + + The following code illustrates how the use of Name property in pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:C6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + + //Sets the pivot table name + pivotTable.Name = "Sample Pivot Table"; + + pivotTable.Fields[0].Axis = PivotAxisTypes.Column; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the collection of . Read-only. + + + To know more about Pivot Tables refer this link. + + The following code illustrates the use of Fields property in pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:C6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Name = "Sample Pivot Table"; + + //Sets the value for pivot field using index from pivot fields collection + pivotTable.Fields[0].Axis = PivotAxisTypes.Column; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + IPivotField datafield = pivotTable.Fields[2]; + + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the collection of in pivot table. Read-only. + + + To know more about Pivot Tables refer this link. + + The following code illustrates the use of DataFields property in pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:C6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Name = "Sample Pivot Table"; + pivotTable.Fields[0].Axis = PivotAxisTypes.Column; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + IPivotField datafield = pivotTable.Fields[2]; + + //Add the DataField to the Data fields collection + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets value indicating whether the PivotTable contains + row with grand totals for columns (same as RowGrand in VBA). + Default value is true. + + + To know more about Pivot Tables refer this link. + + The following code illustrates how to access the RowGrand property of the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:C6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + + //Sets value indicating whether the PivotTable contains row with grand totals for columns + pivotTable.RowGrand = false; + + pivotTable.Fields[0].Axis = PivotAxisTypes.Column; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets value indicating whether the PivotTable contains + column with grand totals for rows (same as ColumnGrand in VBA). + Default value is true. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the ColumnGrand property of the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:C6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + + //Sets value indicating whether the PivotTable contains column with grand totals for rows + pivotTable.ColumnGrand = false; + + pivotTable.Fields[0].Axis = PivotAxisTypes.Column; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether to toggle the display of + drill indicators in the PivotTable. Default value is true. + + To know more about Pivot Tables refer this link. + + Following code illustrates how to access the ShowDrillIndicators property of the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 88; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[0].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + + //Sets a Boolean value to display of drill indicators in the PivotTable + pivotTable.ShowDrillIndicators = false; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether filter buttons and pivot field + captions for rows and columns are displayed in the grid. + The default value is True. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates use of DisplayFieldCaptions property in the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:C6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + + //Sets a Boolean value to pivot field captions are displayed in the grid + pivotTable.DisplayFieldCaptions = false; + + pivotTable.Fields[0].Axis = PivotAxisTypes.Column; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether labels must be repeated on every page.The default value is True. + + True if row, column, and item labels appear on the first row of each page when + the specified PivotTable report is printed. False if labels are printed only on + the first page. To know more about Pivot Tables refer this link. + + + Following code illustrates use of RepeatItemsOnEachPrintedPage property in the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:C6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + + //Sets a Boolean value indicating whether labels must be repeated on every page + pivotTable.RepeatItemsOnEachPrintedPage = true; + + pivotTable.Fields[0].Axis = PivotAxisTypes.Column; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the of the pivot table. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the BuiltInStyle property of the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:C6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[0].Axis = PivotAxisTypes.Column; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + + //Sets the built-in style of the pivot table + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether the PivotTable contains grand totals for rows. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the ShowRowGrand property of the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:C6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + + //Sets a Boolean value to PivotTable contains grand totals for rows + pivotTable.ShowRowGrand = false; + + pivotTable.Fields[0].Axis = PivotAxisTypes.Column; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether the PivotTable contains grand totals for columns. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the ShowColumnGrand property of the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:C6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + + //Sets a Boolean value indicating whether the PivotTable contains grand totals for columns + pivotTable.ShowColumnGrand = false; + + pivotTable.Fields[0].Axis = PivotAxisTypes.Column; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the index number of the PivotTable cache. Read-only. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the CacheIndex property of the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cacheStuName = workbook.PivotCaches.Add(sheet["A1:C3"]); + IPivotCache cacheStuMark = workbook.PivotCaches.Add(sheet["A1:C4"]); + IPivotCache cacheStuMarkName = workbook.PivotCaches.Add(sheet["A1:C6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cacheStuMarkName); + + //Gets the index number of the PivotTable cache + int pivotCacheIndex = pivotTable.CacheIndex; + if(pivotCacheIndex >= 0) + { + //Your Code Here + } + + pivotTable.Fields[0].Axis = PivotAxisTypes.Column; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets of pivot table location in the worksheet. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the Location property of the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:C6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + + //Sets the pivot table location in the worksheet + pivotTable.Location = pivotSheet["B2"]; + + pivotTable.Fields[0].Axis = PivotAxisTypes.Column; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the of pivot table. Read-only. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the Options property of the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:C6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + + //Gets the pivot table options + IPivotTableOptions pivotTableOptions = pivotTable.Options; + pivotTableOptions.ColumnHeaderCaption = "Student Details"; + pivotTableOptions.RowHeaderCaption = "Student Records"; + + pivotTable.Fields[0].Axis = PivotAxisTypes.Column; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the number of rows per page for this PivotTable that the filter area will occupy. Read-only. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the RowsPerPage property of the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + + //Gets the number of rows per page for this PivotTable + int rowsPerPage = pivotSheet.PivotTables[0].RowsPerPage; + if(rowsPerPage != 0) + { + //Your Code Here + } + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the number of columns per page for this PivotTable that the filter area will occupy. Read-only. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the ColumnsPerPage property of the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + + //Gets the number of columns per page for this PivotTable + int columnPerPage = pivotSheet.PivotTables[0].ColumnsPerPage; + if(columnPerPage != 0) + { + //Your Code Here + } + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the collection of in the pivot table. Read-only. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the CalculatedFields property of the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark1"; + sheet.Range["D1"].Text = "Mark2"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Number = 87; + sheet.Range["D3"].Number = 68; + sheet.Range["D4"].Number = 98; + sheet.Range["D5"].Number = 45; + sheet.Range["D6"].Number = 70; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + + //Gets the collection of calculated fields in the pivot table + IPivotCalculatedFields calculatedFields = pivotTable.CalculatedFields; + calculatedFields.Add("AverageMark", "(Mark1+Mark2)/2"); + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the collection of in the pivot table. Read-only. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the PageFields property of the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 88; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Page; + + //Gets the collection of page fields in the pivot table + IPivotFields pageFields = pivotTable.PageFields; + pageFields[0].CanDragToRow = false; + + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the collection of in the pivot table. Read-only. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the RowFields property of the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 88; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + + //Gets the collection of row fields in the pivot table + IPivotFields rowFields = pivotTable.RowFields; + rowFields[0].CanDragToColumn = false; + + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets the collection of in the pivot table. Read-only. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the ColumnFields property of the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 88; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + + //Gets the collection of row fields in the pivot table + IPivotFields columnFields = pivotTable.ColumnFields; + columnFields[0].CanDragToRow = false; + + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether the PivotTable data fields are shown in rows. + + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to access the ShowDataFieldInRow property of the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 88; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + + //Sets a Boolean value to the PivotTable data fields are shown in rows + pivotTable.ShowDataFieldInRow = true; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the of the pivot table. + + This property is not supported in UWP, Xamarin and ASP.NET Core platforms. To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use PivotEngineValues property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:C6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[0].Axis = PivotAxisTypes.Column; + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + pivotTable.Layout(); + + //Gets the pivot engine of the pivot table + Syncfusion.XlsIO.Implementation.PivotAnalysis.PivotEngine pivotEngine = pivotTable.PivotEngineValues; + if(pivotEngine != null) + { + //Your Code Here + } + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Represents collection of in the worksheet. + + + + + Adds a to the collection. + + Name of the pivot table. + Pivot table location. + Pivot cache of the pivot table. + Returns the pivot table object. + + To know more about Pivot Tables refer this link. + + + Following code illustrates how to add pivot table using Add method. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:C6"]); + + //Adds a pivot table to the collection + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Removes pivot table with specified name from this collection. + + Name of the pivot table to remove. + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use Remove method in the pivot table collections. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("SamplePivot.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + + //Removes pivot table with specified name from this collection + pivotSheet.PivotTables.Remove("PivotTable1"); + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Removes a pivot table with the specified index from this collection. + + Index of the pivot table to remove. + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use RemoveAt method in the pivot table collections. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("SamplePivot.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + + //Removes a pivot table with the specified index from this collection + pivotSheet.PivotTables.RemoveAt(0); + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets a number of pivot tables in the worksheet. + + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use a Count property of the pivot table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("SamplePivot.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + + //Gets a number of pivot tables in the worksheet + int pivotTableCount = pivotSheet.PivotTables.Count; + if(pivotTableCount > 0) + { + //Your Code Here + } + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets a from the collection with the specified index. + + Zero-based index of the pivot table. + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use a index property of the pivot table collections. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("SamplePivot.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + + //Gets a pivot table from the collection with the specified index + IPivotTable pivotTable = pivotSheet.PivotTables[0]; + pivotTable.Name = "Sample Pivot Table"; + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleDark10; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Gets a from the collection with the specified name. + + Name of the pivot table. + To know more about Pivot Tables refer this link. + + + Following code snippet illustrates how to use name property in the pivot table collections. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("SamplePivot.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + + //Gets a pivot table from the collection with the specified name + IPivotTable pivotTable = pivotSheet.PivotTables["PivotTable1"]; + pivotTable.Name = "Sample Pivot Table"; + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleDark10; + + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Class used for optimized row height evaluation. + + + + + List with height of the rows. + + + + + Method used to get size of the measured items. + + + + + Initializes new instance of the class. + + Delegate used to get size of the items. + + + + Returns height of all rows starting from the first one and finishing specified row. + + One-based row index. + Sum of height of all rows till rowIndex (included). + + + + Returns height of all rows starting from the first one and finishing specified row. + + One-based row index. + Sum of height of all rows till rowIndex (included). + + + + Update the column index value in the array. + + + + + Update the Row index value in the array. + + + + + Gets size starting from rowStart and ending rowEnd (both included). + + Index of the first item to measure. + Index of the last item to measure. + Total size starting from rowStart and ending rowEnd (both included). + + + + Evaluates size of the specified item. + + Item's index. + Size of the specified item. + + + + Evaluates size of the specified item. + + Item's index. + Size of the specified item. + + + + Delegate used to get size of the single object by its index. + + Item's index to get size for. + Size of the specified item. + + + + Class used for implementing Advanced Encryption Standard algorithm. + + + + + Initializes a new instance of the Aes class. + + Key size. + Key bytes + + + + Encipher 16 bit input + + 16 bit Input + Output value + + + + Decipher 16-bit input + + + + + + + Dump + + + + + Dump key. + + + + + + Dump two by two. + + + + + + + Possible key sizes. + + + + + 128-bit. + + + + + 192-bit. + + + + + 256-bit. + + + + + Default header size. + + + + + Header length. + + + + + List with transform references. + + + + + Initializes new instance. + + + + + Initializes new instance of DataSpaceDefinition. + + Stream to get data from. + + + + Serializes dataspace definition into the stream. + + Stream to serialize into. + + + + List with transform references. + + + + + Size of the header. + + + + + Map entries. + + + + + Default constructor. + + + + + Initializes new instance of the DataSpaceMap. + + Stream to get data from. + + + + Serializes dataspace map into the steram. + + Stream to serialize into. + + + + Map entries. + + + + + List of the reference components. + + + + + DataSpace name. + + + + + Default constructor. + + + + + Initializes new instance of the map entry. + + Stream to get data from. + + + + Serializes single dataspace map entry into the stream. + + Stream to serialize into. + + + + List of the reference components. + + + + + DataSpace name. + + + + + Component type. + + + + + Component name. + + + + + Initializes new instance of the reference component. + + Component type. + Component name. + + + + Initializes new instance of the component reference. + + Stream to get data from. + + + + Serializes object into stream. + + Stream to serialize into. + + + + Component type. + + + + + Component name. + + + + + Represents Encryption Header + + + + + An EncryptionHeaderFlags structure that specifies properties of the encryption algorithm used. + + + + + Reserved, MUST be 0x00000000. + + + + + A signed integer that specifies the encryption algorithm. + + + + + A signed integer that specifies the hashing algorithm in concert with the Flags.fExternal bit. + + + + + An unsigned integer that specifies the number of bits in the encryption key. + MUST be a multiple of 8. + + + + + An implementation specified value which corresponds to constants accepted by + the specified CSP. MUST be compatible with the chosen CSP. + + + + + Undefined and MUST be ignored. + + + + + MUST be 0x00000000 and MUST be ignored. + + + + + A null-terminated Unicode string that specifies the CSP name. + + + + + Default constructor. + + + + + Initializes new instance of the header and extracts its data from the stream. + + Stream to get data from. + + + + Extracts item's data from the specified stream. + + Stream to get data from. + + + + Serialize item in the specified stream. + + Stream to serialize data into. + + + + An EncryptionHeaderFlags structure that specifies properties of the encryption algorithm used. + + + + + Reserved, MUST be 0x00000000. + + + + + A signed integer that specifies the encryption algorithm. + + + + + A signed integer that specifies the hashing algorithm in concert with the Flags.fExternal bit. + + + + + An unsigned integer that specifies the number of bits in the encryption key. + MUST be a multiple of 8. + + + + + An implementation specified value which corresponds to constants accepted by + the specified CSP. MUST be compatible with the chosen CSP. + + + + + Undefined and MUST be ignored. + + + + + MUST be 0x00000000 and MUST be ignored. + + + + + A null-terminated Unicode string that specifies the CSP name. + + + + + Represents the Encryption Info + + + + + A Version structure where Version.vMajor MUST be 0x0003, and Version.vMinor MUST be 0x0002. + + + + + A copy of the Flags stored in the EncryptionHeader field of this structure. + + + + + An EncryptionHeader structure that specifies parameters used to encrypt data. + + + + + An EncryptionVerifier structure. + + + + + This structure specifies parameters to encrypt the Key. + + + + + This structure specifies parameters to ensure the data integrity. + + + + + This structure specifies parameters to Encrypt the Data. + + + + + Default constructor. + + + + + Initializes new instance. + + Stream to get data from. + + + + Serializes object into stream. + + Stream to serialize into. + + + + This structure specifies parameters to encrypt the Key. + + + + + This structure specifies parameters to ensure the data integrity. + + + + + This structure specifies parameters to Encrypt the Data. + + + + + A Version structure where Version.vMajor MUST be 0x0003, and Version.vMinor MUST be 0x0002. + + + + + A copy of the Flags stored in the EncryptionHeader field of this structure. + + + + + An EncryptionHeader structure that specifies parameters used to encrypt data. + + + + + An EncryptionVerifier structure. + + + + + Transform name. + + + + + Block size. + + + + + Cipher mode. + + + + + Reserved. + + + + + Default constructor. + + + + + Initializes new instance of the class. + + Stream to get data from. + + + + Serializes object into stream. + + Stream to serialize into. + + + + Transform name. + + + + + Block size. + + + + + Cipher mode. + + + + + Reserved. + + + + + Represents the Encryption Verifier + + + + + An array of bytes that specifies the salt value used during password hash + generation. MUST NOT be the same data used for the verifier stored encrypted + in the EncryptedVerifier field. + + + + + MUST be the randomly generated Verifier value encrypted using the algorithm + chosen by the implementation. + + + + + An array of bytes that contains the encrypted form of the hash of the randomly + generated Verifier value. The length of the array MUST be the size of the + encryption block size multiplied by the number of blocks needed to encrypt + the hash of the Verifier. If the encryption algorithm is RC4, the length + MUST be 20 bytes. If the encryption algorithm is AES, the length MUST be 32 bytes. + + + + + Size of the verifier hash. + + + + + Default constructor. + + + + + Initializes new instance of the verifier. + + Stream to get data from. + + + + Extracts object from stream. + + Stream to get data from. + + + + Serializes object into stream. + + Stream to serialize into. + + + + An array of bytes that specifies the salt value used during password hash + generation. MUST NOT be the same data used for the verifier stored encrypted + in the EncryptedVerifier field. + + + + + MUST be the randomly generated Verifier value encrypted using the algorithm + chosen by the implementation. + + + + + An array of bytes that contains the encrypted form of the hash of the randomly + generated Verifier value. The length of the array MUST be the size of the + encryption block size multiplied by the number of blocks needed to encrypt + the hash of the Verifier. If the encryption algorithm is RC4, the length + MUST be 20 bytes. If the encryption algorithm is AES, the length MUST be 32 bytes. + + + + + Gets/sets size of the verifier hash. + + + + + Represents the Alogrithms. + + + + + Represents the SHA1 Hash Algorithm. + + + + + Represents the SHA256 Hash Algorithm. + + + + + Represents the SH512 Hash Algorithm. + + + + + This class contains utility methods used by Excel 2007 security implementation. + + + + + Represents the Excel 2010 encrypted version. + + + + + Number of iterations used for key generation. + + + + + Name of encryption info stream. + + + + + Name of dataspaces storage. + + + + + Name of dataspace map stream. + + + + + Name of the transform primary stream. + + + + + Name of dataspace info storage. + + + + + Name of transform info storage. + + + + + Name of encrypted package stream. + + + + + Reads Int32 value from the stream. + + Stream to get data from. + Temporary buffer to put extracted bytes into. + Extracted Int32 value. + + + + Extracts padded unicode string from a stream. + + Stream to get data from. + Extracted string. + + + + Read zero-terminated string from the stream. + + Stream to get string from. + Extracted string (without trailing zero). + + + + Writes Int32 value into the stream. + + Stream to put data into. + Value to write. + + + + Writes padded unicode string from a stream. + + Stream to get data from. + Value to write. + + + + Writes zero-terminated string into the stream. + + Stream to put string into. + Value to write. + + + + Creates key object based on the salt and password. + + Password to use. + Salt to use. + Required key length. + Array with created key. + + + + Encrypts/decrypts buffer with specified method. + + Data to process. + Method to use. + Size of the encryption block. + Modified (encrypted/decrypted) data. + + + + Combines two arrays into one. + + The first buffer to combine. + The second buffer to combine. + Combined array. + + + + An unsigned integer that specifies the type of transform to be applied. + + + + + An identifier associated with a specific transform. + + + + + The friendly name of the transform. + + + + + The reader version. + + + + + The updater version. + + + + + The writer version. + + + + + Default constructor. + + + + + Initializes new instance of the class. + + Stream to get data from. + + + + Serializes object into stream. + + Stream to serialize into. + + + + An unsigned integer that specifies the type of transform to be applied. + + + + + An identifier associated with a specific transform. + + + + + The friendly name of the transform. + + + + + The reader version. + + + + + The updater version. + + + + + The writer version. + + + + + The functionality for which the DataSpaceVersionInfo structure specifies + version information. MUST be "Microsoft.Container.DataSpaces". + + + + + The reader version of the data spaces structure. + + + + + The updater version of the data spaces structure. + + + + + The writer version of the data spaces structure. + + + + + Default constructor. + + + + + Serializes object into specified stream. + + Stream to serialize into. + + + + The functionality for which the DataSpaceVersionInfo structure specifies + version information. MUST be "Microsoft.Container.DataSpaces". + + + + + The reader version of the data spaces structure. + + + + + The updater version of the data spaces structure. + + + + + The writer version of the data spaces structure. + + + + + This class represents Checkbox form control. + + + + + This interface represents TextBox form control shape. + + + + + Indicates whether check box is checked. + + + By default, is set to CheckState property. Here for example, we + set to CheckState. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + ICheckBoxShape checkbox = worksheet.Shapes.AddCheckBox(); + + //Set checkbox state + checkbox.CheckState = ExcelCheckState.Checked; + + //Set text + checkbox.Text = "Checkbox select"; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Indicates the cell in which the option button points to + + + The following code illustrates how to set LinkedCell for the checkbox. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + ICheckBoxShape checkbox = worksheet.Shapes.AddCheckBox(); + + //Set linked cell + checkbox.LinkedCell = worksheet["C7"]; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Correct shape instance. + + + + + Correct shape version. + + + + + Indicates whether check box is checked. + + + + + Stores formula link value. + + + + + Indicates whether check box button is firstbutton. + + + + + Initialize new instance of the text box shape. + + Application object for the new shape. + Parent object for the new shape. + + + + Initializes new instance of the text box shape. + + Application object for the new shape. + Parent object for the new shape. + Shape's container. + Parsing options. + + + + Initializes shape items. + + + + + This method is called inside of PrepareForSerialization to make shape-dependent preparations. + + + + + Serializes current shape. + + Container that will receive this comment. + + + + Serializes comment's options. + + Parent record for options. + All options in MsofbtOPT record. + + + + Creates default options. + + MsofbtOPT record + + + + Parses client data record. + + Record to parse. + Parse options. + + + + Creates a clone of the current shape. + + New parent for the shape object. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Indicates whether we should add created + shape into all necessary parent collections. + A copy of the current shape. + + + + Horizontal alignment of the text. + + + + + Vertical alignment of the text. + + + + + Text rotation. + + + + + Get object that represents the hyperlink for the shape. + + + + + Indicates whether check box is checked. + + + + + Gets or sets formula link value. + + + + + indicates whether the option button is in 3D shading + + + + + Represents the data base property + + + + + Represent the source data file + + + + + The Query Table is automatically updated when open the workbook + + + + + Define connection command type + + + + + Define the connection commandtext + + + + + It's define th connection string + + + + + It's desine the background query process + + + + + Represent the number of minutes between refreshes + + + + + Save the password for implement the odbc connection + + + + + Represent the connection file + + + + + Represent the enable refresh + + + + + It's defind the server credential + + + + + Represent the source Data File + + + + + The Query Table is automatically updated when open the workbook + + + + + Command Type for specified connection + + + + + Represent the command string for the specified data source + + + + + Define connection information + + + + + Query table performed Asynchronously + + + + + Represent the number of minutes between refreshes + + + + + Password information saved for ODBC connection + + + + + Connection file is always used to establish the connection to the DataSource + + + + + Connection can be refreshed by the user. + + + + + Represent the server credential. + + + + + Represents the external connection + + + + + Represent the connection source + + + + + Delete the connection from connection collection. + + + The following code illustrates how to delete a connnection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set Connection string for DataSource + string ConnectionString = "OLEDB;Provider=Microsoft.JET.OLEDB.4.0;Password=\"\";User ID=Admin;Data Source=AccessDB.mdb"; + + //Add a connection to the workbook + IConnection Connection = workbook.Connections.Add("Connection1", "Sample connection with MsAccess", ConnectionString, "", ExcelCommandType.Sql); + + //Add a QueryTable to sheet object + IListObject table = worksheet.ListObjects.AddEx(ExcelListObjectSourceType.SrcQuery, Connection, worksheet.Range["A1"]); + + //Set Command Text for the Connection + table.QueryTable.CommandText = "Select * from tbltest"; + + //Set connection description + Connection.Description = "Sample Connection"; + + // Import data to the sheet from the database + table.Refresh(); + + //Remove Connection + Connection.Delete(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the connection name. + + + The following code illustrates how the name for the connection can be set and accessed. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set Connection string for DataSource + string ConnectionString = "OLEDB;Provider=Microsoft.JET.OLEDB.4.0;Password=\"\";User ID=Admin;Data Source=AccessDB.mdb"; + + //Add a connection to the workbook + IConnection Connection = workbook.Connections.Add("Connection1", "Sample connection with MsAccess", ConnectionString, "", ExcelCommandType.Sql); + + //Add a QueryTable to sheet object + IListObject table = worksheet.ListObjects.AddEx(ExcelListObjectSourceType.SrcQuery, Connection, worksheet.Range["A1"]); + + //Set Command Text for the Connection + table.QueryTable.CommandText = "Select * from tbltest"; + + // Import data to the sheet from the database + table.Refresh(); + + //Get Name + Console.WriteLine(Connection.Name); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //Connection1 + + + + + + Gets or sets the connection description. + + + The following code illustrates how description for connection can be set and accessed. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set Connection string for DataSource + string ConnectionString = "OLEDB;Provider=Microsoft.JET.OLEDB.4.0;Password=\"\";User ID=Admin;Data Source=AccessDB.mdb"; + + //Add a connection to the workbook + IConnection Connection = workbook.Connections.Add("Connection1", "Sample connection with MsAccess", ConnectionString, "", ExcelCommandType.Sql); + + //Add a QueryTable to sheet object + IListObject table = worksheet.ListObjects.AddEx(ExcelListObjectSourceType.SrcQuery, Connection, worksheet.Range["A1"]); + + //Set Command Text for the Connection + table.QueryTable.CommandText = "Select * from tbltest"; + + // Import data to the sheet from the database + table.Refresh(); + + //Get Description + Console.WriteLine(Connection.Description); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //Sample connection with MsAccess + + + + + + Gets or sets the connection range.read only + + + The following code illustrates how the range of the connection can be accessed. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set Connection string for DataSource + string ConnectionString = "OLEDB;Provider=Microsoft.JET.OLEDB.4.0;Password=\"\";User ID=Admin;Data Source=AccessDB.mdb"; + + //Add a connection to the workbook + IConnection Connection = workbook.Connections.Add("Connection1", "Sample connection with MsAccess", ConnectionString, "", ExcelCommandType.Sql); + + //Add a QueryTable to sheet object + IListObject table = worksheet.ListObjects.AddEx(ExcelListObjectSourceType.SrcQuery, Connection, worksheet.Range["A1"]); + + //Set Command Text for the Connection + table.QueryTable.CommandText = "Select * from tbltest"; + + //Set connection description + Connection.Description = "Sample Connection"; + + // Import data to the sheet from the database + table.Refresh(); + + //Get Range + Console.WriteLine(Connection.Range.AddressLocal.ToString()); + + //Remove Connection + Connection.Delete(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //A1:A2 + + + + + + Gets the oledb connection. + + + If connection type is ODBC then to customize connection properties property can be used. + + + If the connection type is OLEDB we can customize the properties of connection by accessing property. Here for + example, we get the command text and print it to console. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set Connection string for DataSource + string ConnectionString = "OLEDB;Provider=Microsoft.JET.OLEDB.4.0;Password=\"\";User ID=Admin;Data Source=AccessDB.mdb"; + + //Add a connection to the workbook + IConnection Connection = workbook.Connections.Add("Connection1", "Sample connection with MsAccess", ConnectionString, "", ExcelCommandType.Sql); + + //Add a QueryTable to sheet object + IListObject table = worksheet.ListObjects.AddEx(ExcelListObjectSourceType.SrcQuery, Connection, worksheet.Range["A1"]); + + //Set Command Text for the Connection + table.QueryTable.CommandText = "Select * from tbltest"; + + //Set connection description + Connection.Description = "Sample Connection"; + + // Import data to the sheet from the database + table.Refresh(); + + //Get Command Text from OLEDB connection + Console.WriteLine(Connection.OLEDBConnection.CommandText); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //Select * from tbltest + + + + + + Gets the odbc connection. + + + If connection type is ODBC then to customize connection properties property can be used. + + + If the connection type is ODBC we can customize the properties of connection by accessing property. Here for + example, we get the command text and print it to console. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set Connection string for DataSource + string ConnectionString = "ODBC;DSN=MS Access;DBQ=C:\\Company\\DB\\Testing.mdb;DefaultDir=C:\\Company\\DB;FIL=MS Access;MaxBufferSize=2048;PageTimeout=5;"; + + //Add a connection to the workbook + IConnection Connection = workbook.Connections.Add("Connection1", "Sample connection with MsAccess", ConnectionString, "", ExcelCommandType.Sql); + + //Add a QueryTable to sheet object + IListObject table = worksheet.ListObjects.AddEx(ExcelListObjectSourceType.SrcQuery, Connection, worksheet.Range["A1"]); + + //Set Command Text for the Connection + table.QueryTable.CommandText = "Select * from tbltest"; + + //Set connection description + Connection.Description = "Sample Connection"; + + // Import data to the sheet from the database + table.Refresh(); + + //Get Command Text from ODBC connection + Console.WriteLine(Connection.ODBCConnection.CommandText); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //Select * from tbltest + + + + + + Gets the connection id. + + This API is deprecated. Please use the the instead. + + + + Gets the connection id. + + + The following code illustrates how to access the connection id. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set Connection string for DataSource + string ConnectionString = "OLEDB;Provider=Microsoft.JET.OLEDB.4.0;Password=\"\";User ID=Admin;Data Source=AccessDB.mdb"; + + //Add a connection to the workbook + IConnection Connection = workbook.Connections.Add("Connection1", "Sample connection with MsAccess", ConnectionString, "", ExcelCommandType.Sql); + + //Add a QueryTable to sheet object + IListObject table = worksheet.ListObjects.AddEx(ExcelListObjectSourceType.SrcQuery, Connection, worksheet.Range["A1"]); + + //Set Command Text for the Connection + table.QueryTable.CommandText = "Select * from tbltest"; + + //Set connection description + Connection.Description = "Sample Connection"; + + // Import data to the sheet from the database + table.Refresh(); + + //Get Connection ID + Console.WriteLine(Connection.ConnectionId); + + //Remove Connection + Connection.Delete(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //1 + + + + + + Represent the connection password event + + + + + Gets the connection database type. + + + The following code illustrates how to get the connection database type. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook= application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set Connection string for DataSource + string ConnectionString = "OLEDB;Provider=Microsoft.JET.OLEDB.4.0;Password=\"\";User ID=Admin;Data Source=AccessDB.mdb"; + + //Add a connection to the workbook + IConnection Connection = workbook.Connections.Add("Connection1", "Sample connection with MsAccess", ConnectionString, "", ExcelCommandType.Sql); + + //Add a QueryTable to sheet object + IListObject table = worksheet.ListObjects.AddEx(ExcelListObjectSourceType.SrcQuery, Connection, worksheet.Range["A1"]); + + //Set Command Text for the Connection + table.QueryTable.CommandText = "Select * from tbltest"; + + //Set connection description + Connection.Description = "Sample Connection"; + + // Import data to the sheet from the database + table.Refresh(); + + //Get DataBase Type + Console.WriteLine(Connection.DataBaseType.ToString()); + + //Remove Connection + Connection.Delete(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //DataBaseType OLEDB + + + + + + External connection + + + + + + + Represent the connection name + + + + + Represent the connection description + + + + + Represent the connection id + + + + + It's define the connection file + + + + + Represent the source file + + + + + Represent the data base type + + + + + Represent the oledb connection + + + + + Represent the odbc connection + + + + + It's define the refreshed version + + + + + Represent connection is deleted or not + + + + + Represenet the background query + + + + + It's define the connection string + + + + + It's define whether the connection is used or not + + + + + Data base connection string + + + + + It's define the query table range + + + + + Represent the ODBC password + + + + + Olap maintain as Stream + + + + + Ext_Lst maintain as Stream + + + + + Represent textPr as stream + + + + + Represent the parameter collection. + + + + + Delete the connection from the connection collection. + + + + + Event + + + + + + + Dispose the connection + + + + + External connection + + + + + connection password events + + + + + Gets or sets the connection description. + + + + + Gets the connection id. + + This API is deprecated. Please use the the instead. + + + + Gets or sets the connection id. + + + + + Gets or sets the connection file. + + + + + Gets or sets the source file. + + + + + Gets or sets the Database Type. + + + + + Gets or sets the connection name. + + + + + Gets or sets the OLEDB Connection. + + + + + Gets or sets the ODBC connection. + + + + + Gets or sets the refreshed version. + + This API is deprecated. Please use the instead. + + + + Gets or sets the refreshed version. + + + + + Get or sets the value indicating whether the connection is deleted. + + + + + Gets or sets the value indicating whether the Query is asynchronus with DB. + + + + + Gets and sets connection string of respective connection type. + + + + + Gets or sets a value indicating whether the connection for query table exists. + + + + + Gets or sets the Database connection string. + + + + + Gets or sets the connection range. + + + + + Gets or sets the Password of External connection. + + This API is deprecated. Please use the instead. + + + + Gets or sets the Password of External connection. + + + + + Gets or sets the Olap Stream. + + + + + Gets or sets the Ext_Lst Stream + + + + + Represent the parameter collection. + + + + + Represents the collection of external connection + + + + + Represent the connection collection. + + + + + Add the connection to the workbook + + Connection Name + Connection Description + Connection String + Command Text + Command Type + Connection object for these parameters + + + + returns the connection + + + + + + + External connection collection + + + + + + + Connection added to workbook + + + + + Add connection + + + + + + + Add connection frm file + + + + + + + + Check the connection name + + + + + + Create OLEDB connection + + + + + + + + + Create ODBC connection + + + + + + + + + Find the Data source from the connection string + + + + + + + Check the connection string + + + + + + + Find the connection ID + + + + + + Dispose the connection collection + + + + + Represents the ODBC connection + + + + + External Connection + + + + + Constructor + + + + + + Represents the OLEDB connection + + + + + It define the external connection + + + + + Implement the OLEDB Connection for ExternalConnection + + + + + + Define connection information + + + + + Represents the Query table + + + + + Query table implementation + + + + + + + + Represent the external connection + + + + + It's define the database property + + + + + Represent the column width + + + + + It's define the connection availability + + + + + Provides info on queryfields associated with the query table + + + + + Gets or sets the GrowShrinkType + + + + + Delete the query table from the workbook + + + + + Converts Control unicode Character to ASCII . + + String Value. + Modified ASCII String. + + + + Gets the Connection for the Specified QueryTable. + + + + + Gets or sets a value indicating whether the Query Table is automatically updated when open the workbook. + + + + + Gets or sets the GrowShrinkType + + + + + Gets or sets the Command Type for specified connection. + + + + + Gets or sets the command string for the specified data source. + + + + + Gets or sets connection information. + + + + + Gets or sets a value indicating whether the Query table is performed Asynchronously + + + + + Gets or sets the Name of the Query Table. + + + + + Gets the connection ID. Read-Only + + This API is deprecated. Please use the instead. + + + + Gets the connection ID. Read-only + + + + + Gets or sets the Column width for QueryTable. + + + + + Represent the connection state + + + + + Gets or Sets the queryTableRefresh field + + + + + Gets the parameter collection. + + + + + Specifies the number of extra columns included at the left end of the field array that aren't bound to external data + + + + + Specifies the number of extra columns included at the right end of the Table that aren't bound to external data + + + + + Specifies the next available column id in table. + + + + + Specifies the list of fields in query table + + + + + Represents the parent query table object + + + + + Represents the preserveSortFilterLayout + + + + + Initializes a new instance of QueryTableRefresh class + + Represents parent Query table object + + + + Gets or Sets the number of extra columns included at the left end of the field array that aren't bound to external data + + + + + Gets or Sets the number of extra columns included at the right end of the Table that aren't bound to external data + + + + + Gets or sets the list of QueryFields + + + + + Gets or Sets the PreserverSortFilterLayout enable or not. + + + + + Denotes Next available ID for table column allocation + + + + + Represents the unique id for the query field + + + + + Represents the query field column name + + + + + Specifies the unique identifier for the table column if the query table is attached to a table object rather than just a range in the sheet + + + + + Specifies whether this column is a user-defined column or comes from the external data query + User defined columns shall be preserved during data refresh operations + User-defined columns are only supported on query tables that are attached to table objects + + + + + Represents the parent object + + + + + Initializes a new instance of Query table field + + Unique id for the query field + Unique id for the table column if the query table is attached to a table object rather than just a range in the sheet + Represents parent QueryTableRefresh object + + + + Gets or sets the QueryFieldId + + + + + Gets or Sets the query field name + + + + + Gets or Sets the unique identifier for the table column if the query table is attached to a table object rather than just a range in the sheet + + + + + Gets or Sets the databound field + + + + + Represents LogFont structure that defines the attributes of a font. + + + + + Specifies the height, in logical units, of the font's character cell or character. + The character height value (also known as the em height) is the character cell + height value minus the internal-leading value. + + + + + Specifies the average width, in logical units, of characters in the font. + If lfWidth is zero, the aspect ratio of the device is matched against the + digitalization aspect ratio of the available fonts to find the closest match, + determined by the absolute value of the difference. + + + + + Specifies the angle, in tenths of degrees, between the escapement vector + and the x-axis of the device. The escapement vector is parallel + to the base line of a row of text. + + + + + Specifies the angle, in tenths of degrees, between each character's base + line and the x-axis of the device. + + + + + Specifies the weight of the font in the range 0 through 1000. + For example, 400 is normal and 700 is bold. If this value is zero, + a default weight is used. + + + + + Specifies an italic font if set to TRUE. + + + + + Specifies an underlined font if set to TRUE. + + + + + Specifies a strikeout font if set to TRUE. + + + + + Specifies the character set. The following values are predefined. + + + + + Specifies the output precision. The output precision defines how closely + the output must match the requested font's height, width, character + orientation, escapement, pitch, and font type. + + + + + Specifies the clipping precision. The clipping precision defines how + to clip characters that are partially outside the clipping region. + + + + + Specifies the output quality. The output quality defines how carefully + the graphics device interface (GDI) must attempt to match the logical-font + attributes to those of an actual physical font. + + + + + Specifies the pitch and family of the font. The two low-order bits + specify the pitch of the font. Font families describe the look of + a font in a general way. They are intended for specifying fonts when + the exact typeface desired is not available. + + + + + A null-terminated string that specifies the typeface name of the font. + The length of this string must not exceed 32 characters, including + the terminating null character. The EnumFontFamiliesEx function can + be used to enumerate the typeface names of all currently available fonts. + If lfFaceName is an empty string, GDI uses the first font that matches + the other specified attributes. + + + + + Default constructor. + + + + + Contains information about an enumerated font. + + + + + Specifies a LOGFONT structure that contains values defining the font attributes. + + + + + Specifies a null-terminated string specifying the unique name of the font. + For example, ABC Font Company TrueType Bold Italic Sans Serif. + + + + + Specifies a null-terminated string specifying the style of the font. + For example, Bold Italic. + + + + + Specifies a null-terminated string specifying the script, that is, + the character set, of the font. For example, Cyrillic. + + + + + Converts byte array with zero terminated string data into string without ending zero character. + + String data. + Converted string. + + + + Returns font full name without ending zero character. Read-only. + + + + + Returns style name without ending zero character. Read-only. + + + + + Returns a LOGFONT structure that contains values defining the font attributes. Read-only. + + + + + + The EnumFontFamExProc function is an application definedcallback function + used with the EnumFontFamiliesEx function. It is used to process the fonts. + It is called once for each enumerated font. The FONTENUMPROC type defines + a pointer to this callback function. EnumFontFamExProc is a placeholder + for the application definedfunction name. + + + + + Contains some native32 functions used by XlsIO. + + + + + The EnumFontFamiliesEx function enumerates all fonts in the system that + match the font characteristics specified by the LOGFONT structure. + EnumFontFamiliesEx enumerates fonts based on typeface name, character set, or both. + + Handle to the device context. + + Pointer to a LOGFONT structure that contains information about the fonts + to enumerate. The function examines the following members. + + + Pointer to the application definedcallback function. + + + + + + + + This class contains native heap functions. + + + + + This function allocates a block of memory from a heap. The allocated memory is not movable. + + Handle to the heap from which the memory will be allocated. + Heap allocation options. + Number of bytes to be allocated. If the heap specified by + the hHeap parameter is a nongrowable heap, dwBytes must be less than 0x7FFF8. + You create a nongrowable heap by calling the HeapCreate function with a nonzero value. + + + + + Creates a heap object that can be used by the calling process. The function reserves + space in the virtual address space of the process and allocates physical storage for + a specified initial portion of this block. + + The heap allocation options. + The initial size of the heap, in bytes. This value + determines the initial amount of memory that is committed for the heap. + The value is rounded up to the next page boundary. The value must be smaller + than dwMaximumSize. If this parameter is 0, the function commits one page. + The maximum size of the heap, in bytes. + + + + + Destroys the specified heap object. It decommits and releases all the + pages of a private heap object, and it invalidates the handle to the heap. + + A handle to the heap to be destroyed. + If the function succeeds, the return value is nonzero. + + + + Frees a memory block allocated from a heap by the HeapAlloc or HeapReAlloc function. + + A handle to the heap whose memory block is to be freed. + The heap free options. + A pointer to the memory block to be freed. + If the function succeeds, the return value is nonzero. + + + + Reallocates a block of memory from a heap. This function enables you to + resize a memory block and change other memory block properties. + The allocated memory is not movable. + + A handle to the heap from which the memory is to be reallocated. + The heap reallocation options. + A pointer to the block of memory that the function reallocates. + The new size of the memory block, in bytes. A memory + block's size can be increased or decreased by using this function. + If the function succeeds, the return value is a pointer to + the reallocated memory block. + + + + This class contains some Win32 API functions for memory operations. + + + + + The MoveMemory function moves a block of memory from one location to another. + + Pointer to the starting address of the move destination. + Pointer to the starting address of the block of memory to be moved. + Size of the block of memory to move, in bytes. + + + + The RtlZeroMemory routine fills a block of memory with zeros, given a pointer + to the block and the length, in bytes, to be filled. + + Pointer to the memory to be filled with zeros. + Specifies the number of bytes to be zeroed. + + + + The CopyMemory function copies a block of memory from one location to another. + + Pointer to the starting address of the copied block's destination. + Pointer to the starting address of the block of memory to copy. + Size of the block of memory to copy, in bytes. + + + + The CopyMemory function copies a block of memory from one location to another. + + Pointer to the starting address of the copied block's destination. + Pointer to the starting address of the block of memory to copy. + Size of the block of memory to copy, in bytes. + + + + Contains Am Pm Token descriptions. + + + + + Base class for formula tokens. + + + + + Default regular expressions options: + + + + + Part of format. + + + + + Initializes a new instance of the FormatTokenBase class + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Tries to parse format string using regular expression. + + Regular expression to use. + Format string to parse. + Start index. + Position after parsing. + + + + Tries to parse format string using regular expression. + + Regular expression to use. + Format string to parse. + Start index. + Output regular expression match. + Position after parsing. + + + + Applies format to the value. + + Value to format. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Applies format to the value. + + Value to format. + Formatted value. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Searches for string from strings array in the format starting from the specified position. + + Array of strings to check. + String format to search in. + Start index in the format. + Indicates whether to ignore case. + String index or -1 if not found. + + + + This method is called after format string was changed. + + + + + Gets or sets format of the token. + + + + + Gets type of the token. Read-only. + + + + + Start of the token. + + + + + Start of the token. + + + + + Edge between AM and PM symbols. + + + + + AM symbol. + + + + + PM symbol. + + + + + Length of the token. + + + + + Initializes a new instance of the AmPmToken class + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Checks the AMPM is other pattern. + + + + + + + Returns type of the token. Read-only. + + + + + Class used for Asterix Token. + + + + + Default start character. + + + + + Initializes a new instance of the AsterixToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for Character Token. + + + + + Start of the token. + + + + + Initializes a new instance of the CharacterToken class + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for Color Tokens. + + + + + Class used for parsing Brackets. + + + + + Start character of the token. + + + + + End character of the token. + + + + + Initializes a new instance of the InBracketToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Tries to parse format string. + + Format string to parse. + Position of the first bracket. + Position to start parsing at. + Position of the end bracket. + Position after parsed block. + + + + Reserved keyword for color definition in excel number format. + + + + + Minimum possible color index. + + + + + Maximum possible color index. + + + + + Color increment. + + + + + Regex for color selecting. + + + + + Possible color values. + + + + + Color index. + + + + + Initializes a new instance of the ColorToken class + + + + + Tries to parse format string. + + Format string to parse. + Position of the first bracket. + Position to start parsing at. + Position of the end bracket. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Searches for color in the array of known colors. + + Format string. + Start index. + Index in the array of known colors or -1 if color was not found. + + + + Tries to get color number from format string. + + Format string + Index to start looking from. + End index of the token. + Extracted color index or -1 if color was not found. + + + + Returns type of the token. Read-only. + + + + + Class used for Condition Tokens. + + + + + All compare operations. + + + + + Indicates whether token should be formatted using am/pm time format. + + + + + Applied compare operation. + + + + + Initializes a new instance of the ConditionToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position of the first bracket. + Position to start parsing at. + Position of the end bracket. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Checks value with the condition. + + Value to check. + Value that indicates whether the condition is true for the value. + + + + Returns type of the token. Read-only. + + + + + Possible compare operators. + + + + + Class used for Culture Tokens. + + + + + Group in regular expression with locale id. + + + + + Group in regular expression with characters. + + + + + LocaleId value that indicates that we should use system settings instead of provided number format. + + + + + LocaleId value that indicates that we should use system settings instead of provided number format. + + + + + Regular expression for hours part of the format: + + + + + Locale id of the desired culture. + + + + + Character specifying the culture. + + + + + Initializes a new instance of the CultureToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Gets the culture info. Read-only. + + + + + Gets a value indicating whether we should ignore all following format tokens and use system date format. Read-only. + + + + + Gets a value indicating whether we should ignore all following format tokens and use system time format. Read-only. + + + + + Class used for describing Day Tokens. + + + + + Regular expression for minutes part of the format: + + + + + Format string in lower case. + + + + + Initializes a new instance of the DayToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for describing Dollor Tokens. + + + + + Start character of the token. + + + + + End character of the token. + + + + + Dollar character of the token. + + + + + Hypen Character. + + + + + Initializes a new instance of the InBracketToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for describing DecimalSeparatorToken. + + + + + Class used for character token. + + + + + Initializes a new instance of the SingleCharToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Gets format character. Read-only. + + + + + Format character. + + + + + Initializes a new instance of the DecimalPointToken class. + + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Format character. Read-only. + + + + + Returns type of the token. Read-only. + + + + + Class used for describing Digit Tokens. + + + + + Represents the Maximum number digit. + + + MS Excel allows maximum of 15 digit number. If it exceeds adds zero to exceeded number. + + + + + Indicates whether this digit is last in the sequence of digits + and all significant numbers should be displayed. + + + + + Initializes a new instance of the DigitToken class. + + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Gets single digit from number and updates number. + + Number to get digit from. + Extracted digit. + + + + Gets the single digit from Exponential Number. + + Number to get digit from. + Extracted digit. + + + + Returns string representation according to the current format and digit value. + + Value after removing current digit. + Digit to convert into string. + Indicates whether to show hidden symbols. + Converted value. + + + + Gets or sets a value indicating whether this digit is last in the sequence of digits + and all significant numbers should be displayed. Read-only. + + + + + Gets or sets a value indicating whether this digit is last in the sequence of digits. + + + + + Class used for Fraction tokens. + + + + + Format character. + + + + + Initializes a new instance of the FractionToken class. + + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Returns type of the token. Read-only. + + + + + Class used for organizing General Tokens. + + + + + Format string. + + + + + Initializes a new instance of the GeneralToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for 24 hour Token. + + + + + Regular expression for hours part of the format: + + + + + Initializes a new instance of the Hour24Token class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for Hour Token. + + + + + Defined 12hr format. + + + + + Long format. + + + + + Regular expression for hours part of the format: + + + + + Indicates whether token should be formatted using am/pm time format. + + + + + Initializes a new instance of the HourToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Gets or sets a value indicating whether token should be formatted using am/pm time format. + + + + + Class used for Significant Digit Tokens. + + + + + Format character. + + + + + Indicates that we shouldn't show string value if digit is zero. + + + + + Initializes a new instance of the InsignificantDigitToken class. + + + + + Returns string representation according to the current format and digit value. + + Value after removing specified digit. + Digit to convert into string. + Indicates whether to show hidden symbols. + Converted value. + + + + Returns type of the token. Read-only. + + + + + Format character. Read-only. + + + + + Gets or sets a value indicating whether to show string value if digit is zero. + + + + + Class used for MilliSecond Token. + + + + + Long format. + + + + + Represents Dot. + + + + + Default OleDateValue + + + + + Maximum OleDateValue + + + + + Maximum format length. + + + + + Initializes a new instance of the MilliSecondToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for Minute Token. + + + + + Long type of the format. + + + + + Default OleDateValue + + + + + Maximum OleDateValue + + + + + Regular expression for minutes part of the format: + + + + + Initializes a new instance of the MinuteToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + This method is called after format string was changed. + + + + + Returns type of the token. Read-only. + + + + + Class used for organizing Minutes since midnight. + + + + + Regular expression for hours part of the format: + + + + + Initializes a new instance of the MinuteTotalToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for Month Token. + + + + + Short year format. + + + + + Length of the format for full name of the month. + + + + + Length of the format for full name of the month. + + + + + Length of the format for full name of the month. + + + + + Format for long number month representation. + + + + + Regular expression for minutes part of the format: + + + + + Initializes a new instance of the MonthToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + This method is called after format string was changed. + + + + + Returns type of the token. Read-only. + + + + + Class used for Percent Token. + + + + + Format character. + + + + + Initializes a new instance of the PercentToken class. + + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Format character. Read-only. + + + + + Class used for placing reserved digit token. + + + + + Format character. + + + + + String to display when digit is 0 and ShowHiddenSymbols is set to False. + + + + + Initializes a new instance of the PlaceReservedDigitToken class. + + + + + Returns string representation according to the current format and digit value. + + Value after removing specified digit. + Digit to convert into string. + Indicates whether to show hidden symbols. + Converted value. + + + + Returns type of the token. Read-only. + + + + + Format character. Read-only. + + + + + Class used for reserved place format token. + + + + + Start of the token. + + + + + Space symbol. + + + + + En quad Space symbol. + + + + + Initializes a new instance of the ReservedPlaceToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for Scientific Token. + + + + + Short form without plus sign. + + + + + One of the possible formats. + + + + + Used format index. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for Seconds Token. + + + + + Long type of the format. + + + + + Half of possible milliseconds. + + + + + Default OleDateValue + + + + + Maximum OleDateValue + + + + + Regular expression for minutes part of the format: + + + + + Indicates whether number of seconds must be rounded. + + + + + Initializes a new instance of the SecondToken class + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Gets or sets a value indicating whether number of seconds must be rounded. + + + + + Class used for second total token. + + + + + Regular expression for hours part of the format: + + + + + Initializes a new instance of the SecondTotalToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for separator token. + + + + + Default string representation of the separator. + + + + + Initializes a new instance of the SectionSeparatorToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for Significant Digit Token. + + + + + Format character. + + + + + Initializes a new instance of the SignificantDigitToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Returns type of the token. Read-only. + + + + + Format character. Read-only. + + + + + Class used for String Token. + + + + + Regular expression for minutes part of the format: + + + + + Initializes a new instance of the StringToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for Text Token. + + + + + Format character for text token. + + + + + Initializes a new instance of the TextToken class. + + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Format character. Read-only. + + + + + Class used for thousands separator token. + + + + + Format character. + + + + + Indicates whether this separator is placed immediately after last digit token. + + + + + Initializes a new instance of the ThousandsSeparatorToken class. + + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Prepares value to display. + + Value to prepare. + Prepared value. + + + + Format character. Read-only. + + + + + Returns type of the token. Read-only. + + + + + Gets or sets a value indicating whether this separator is placed immediately + after last digit token. Read-only. + + + + + Class used for UnknownToken. + + + + + Initializes a new instance of the UnknownToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for YearToken. + + + + + Short year format. + + + + + Regular expression for minutes part of the format: + + + + + Initializes a new instance of the YearToken class. + + + + + Tries to parse format string. + + Format string to parse. + Position to start parsing at. + Position after parsed block. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Culture used to convert value into text. + Parent section. + Formatted value. + + + + Applies format to the value. + + Value to format. + Indicates whether to put in result hidden symbols. + Formatted value. + + + + Returns type of the token. Read-only. + + + + + Class used for format constants. + + + + + Number of hours in a day. + + + + + Number of minutes in a hour. + + + + + Number of minutes in a day. + + + + + Number of seconds in a minute. + + + + + Number of seconds in a day. + + + + + Represents possible token types. + + + + + Represents unknown format token. + + + + + Represents section format token. + + + + + Represents hour format token. + + + + + Represents hours in 24 hours format format token. + + + + + Represents minute format token. + + + + + Represents total minutes format token. + + + + + Represents second format token. + + + + + Represents total seconds format token. + + + + + Represents year format token. + + + + + Represents month format token. + + + + + Represents day format token. + + + + + Represents string format token. + + + + + Represents reserved place format token. + + + + + Represents character format token. + + + + + Represents am/pm format token. + + + + + Represents color format token. + + + + + Represents condition format token. + + + + + Represents text format token. + + + + + Represents significant digit format token. + + + + + Represents insignificant digit format token. + + + + + Represents place reserved digit format token. + + + + + Represents percent format token. + + + + + Represents scientific format token. + + + + + Represents general format token. + + + + + Represents thousands separator format token. + + + + + Represents decimal point format token. + + + + + Represents asterix format token. + + + + + Represents fraction format token. + + + + + Represents millisecond format token. + + + + + Represents culture token. + + + + + Represents Dollar token. + + + + + Represents common fraction. Used to apply number format to the value. + + + + + Maximum number of digits. + + + + + Maximum accuracy. + + + + + Fraction numerator. + + + + + Fraction denumerator. + + + + + Initializes a new instance of the Fraction class. + + Represents numerator of the fraction. + Represents denominator of the fraction. + + + + Initializes a new instance of the Fraction class. + + Represents numerator of the fraction. + + + + Initializes a new instance of the Fraction class. + + Represents first term of the fraction. + Represents second term of the fraction. + Fraction of the numerator and denominator. + + + + Converts fraction to double value. + + Fraction to convert. + Double value equal to the fraction. + + + + Converts List into fraction. + + List to convert. + Converted value. + + + + Converts long into fraction. + + Value to convert. + Converted value. + + + + Swaps numerator and denumerator. + + Current fraction after reverse. + + + + Converts number to fraction using required digits number. + + Value to convert. + Maximum number of digits. + Optimal fraction. + + + + Returns maximum common divisor of two numbers using Euclid method. + + First number. + Second number. + Maximum common divisor of two numbers. + + + + Returns absolute difference between fraction and double. + + Fraction for difference evaluation. + Double value for difference evaluation. + Evaluated difference. + + + + Adds next number to List with continued fraction. + + List with continued fraction. + Remainder of the fraction. + Remainder after adding next number to the fraction. + + + + Returns string representation of the Fraction. + + String representation of the Fraction. + + + + Gets or sets the fraction numerator. + + + + + Gets or sets the fraction denumerator. + + + + + Gets the number of digits in the denumerator. + + + + + Summary description for AddInFunctionImpl. + + + + + Represents an Custom Addin Function in Excel. + + + + + Returns name of the add-in function. Read-only. + + + + + Index to extern workbook. + + + + + Name index in the extern workbook. + + + + + Parent workbook. + + + + + Creates new instance. + + Current application. + Parent object. + Book index. + Name index. + + + + Searches for all necessary parents. + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Gets / sets book index. + + + + + Name index. + + + + + Returns name of add-in function. + + + + + XlsIO Application interface declaration. + + + + + Represents the Excel application. + + + + + Converts a measurement from centimeters to points + (one point equals 0.035 centimeters). + + Double value in centimeters + Returns the converted double value in points + + + + Converts a measurement from inches to points. + + Double value in inches + Returns the converted double value in points + + + + Saves changes to the active workbook. + + This method is supported on Windows Forms, WPF, ASP.NET, and ASP.NET MVC platforms only. + File name of result file. + + + + Check whether the file version is supported by XlsIO. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + File full path that contains workbook. + Returns True if the file is supported by XlsIO else returns False + + + + Checks whether a given file is in Excel format based on its file path. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + File path that contains workbook. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Xlsx; + + // Checks if the specified file is a valid Excel file. + if(application.IsExcelFile("sample.xlsx)) + { + // Opens the Excel workbook from the stream. + IWorkbook workbook = application.Workbooks.Open("sample.xlsx", ExcelOpenType.Automatic); + IWorksheet sheet = workbook.Worksheets[0]; + + //Convert the sheet to image. + Image image = sheet.ConvertToImage(1, 1, 10, 20); + image.Save("Sample.png", ImageFormat.Png); + + //Close and Dispose + workbook.Close(); + } + } + + Returns true if the file is in excel format else false. + + + + Check whether the file version is supported by XlsIO. + + File stream that contains workbook. + Returns True if the stream is supported by XlsIO else returns False + + + + Checks whether a given stream contains data in Excel format. + + File stream that contains workbook. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Xlsx; + + FileStream stream = new FileStream("sample.xlsx", FileMode.Open); + + // Checks if the content of the stream represents a valid Excel file. + if(application.IsExcelFile(stream)) + { + // Opens the Excel workbook from the stream. + IWorkbook workbook = application.Workbooks.Open("sample.xlsx", ExcelOpenType.Automatic); + IWorksheet sheet = workbook.Worksheets[0]; + + Stream image = new FileStream("Sample.png", FileMode.Create, FileAccess.ReadWrite); + sheet.ConvertToImage(sheet.UsedRange, imageOptions, image); + + //Close and Dispose + workbook.Close(); + } + } + + Returns true if the file is in excel format else false. + + + + Converts units. + + Value to convert. + Form option. + To option. + Returns converted result. + + + + Gets or sets a boolean value indicating whether to add string delimiter for all the text values. Default value is FALSE. + + + + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = engine.Excel; + application.UseStringDelimiter = true; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet["A1"].Text = "Document"; + worksheet["B1"].Value = "6"; + MemoryStream stream = new MemoryStream(); + workbook.SaveAs(stream, ",",Encoding.Unicode); + } + + + + In the above example, cell A1 contains a text value. So, it will be surrounded by string delimiter i.e., double quotes + while saving workbook as CSV document. + + Output of the above code looks like this. + "Document",6 + + + + + Returns a Range object that represents the active cell in the + active window (the window on top) or in the specified window. + If the window isn't displaying a worksheet, this property fails. + Read-only. + + + + + Returns an object that represents the active sheet (the sheet on + top) in the active workbook or in the specified window or workbook. + Returns Nothing if no sheet is active. Read-only. + + + + + Returns a Workbook object that represents the workbook in the active + window (the window on top). Read-only. Returns Nothing if there are + no windows open or if either the Info window or the Clipboard window + is the active window. + + + + + Returns a Workbooks collection that represents all the open workbooks. + Read-only. + + + + + For an Application object, returns a Sheets collection that represents + all the worksheets in the active workbook. For a Workbook object, + returns a Sheets collection that represents all the worksheets in the + specified workbook. Read-only Sheets object. + + + + + Returns a Range object that represents a cell or a range of cells. + + + + + All data entered after this property is set to True will be formatted + with the number of fixed decimal places set by the FixedDecimalPlaces + property. Read/write Boolean. + + + + + Gets or sets a Boolean value to ignore duplicate worksheet name exception by adding a suffix at the end.Default value is FALSE. + + + + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = engine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(3); + + application.IgnoreSheetNameException = true; + + IWorksheet sheet_1 = workbook.Worksheets[0]; + IWorksheet sheet_2 = workbook.Worksheets[1]; + IWorksheet sheet_3 = workbook.Worksheets[2]; + + Console.WriteLine("First sheet name is " + sheet_1.Name); + Console.WriteLine("Second sheet name is " + sheet_2.Name); + Console.WriteLine("Third sheet name is " + sheet_3.Name); + + Console.WriteLine("Set sheet1 to Thired sheet name"); + + sheet_3.Name = "Sheet1"; + + Console.WriteLine("After set the third sheet name is " + sheet_3.Name); + + workbook.SaveAs("Output.xlsx"); + + workbook.Close(); + } + + + Output : + + First sheet name is Sheet1 + Second sheet name is Sheet2 + Third sheet name is Sheet3 + + Set sheet1 to Thired sheet name + + After set the third sheet name is Sheet1_1 + + + + + + True (default) if the system separators of Microsoft Excel are + enabled. Read/write Boolean. + + + + + Returns the Microsoft Excel build number. Read-only. + + + + + Returns or sets the number of fixed decimal places used when + the FixedDecimal property is set to True. Read/write. + + + + + Returns or sets the number of sheets that Microsoft Excel + automatically inserts into new workbooks. Read/write Long. + + + + + Sets or returns the character used for the decimal separator as a + String. Read/write. + + + + + Returns or sets the default path that Microsoft Excel uses when it + opens files. Read/write String. + + This property is supported on Windows Forms, WPF, ASP.NET, ASP.NET MVC, WinRT, WP, Universal and UWP platforms only. + + + + Returns the path separator character ("\"). Read-only String. + + This property is supported on Windows Forms, WPF, ASP.NET, ASP.NET MVC, WinRT, WP, Universal and UWP platforms only. + + + + Sets or returns the character used for the thousands separator + as a String. Read / write. + + + + + Returns or sets the name of the current user. Read/write String. + + + + + For the Application object, always returns "Microsoft Excel". For + the CubeField object, the name of the specified field. For the Style + object, the name of the specified style. Read-only String. + + + + + If this property is set to True, then if some cells have reference + to the same style, changes will influence all these cells. + Default value: False + + + + + This flag controls behavior of workbook save methods. Each flag controls + one aspect of the save code. Can be set one or more flags which will influence + the output produced by the library. + + + + + Returns or sets the standard (default) height of all the rows in the worksheet, + in points. This value is used only for newly created worksheets. + Read/write Double. + + + + + Returns or sets the standard (default) height option flag, which defines that + standard (default) row height and book default font height do not match. + This value is used only for newly created worksheets. Read/write Bool. + + + + + Returns or sets the standard (default) width of all the columns in the + worksheet. This value is used only for newly created worksheets. + Read/write Double. + + + + + Indicates whether to optimize fonts count. This option will + take effect only on workbooks that will be added after setting + this property. + WARNING: Setting this property to True can decrease performance significantly, + but will reduce resulting file size. + + + + + Indicates whether to optimize Import data. This option will + take effect only on Import methods that are available with the worksheet + WARNING: Setting this property to True can decrease memory significantly, + but will increase the performance of data import . + + + + + Gets / sets row separator for array parsing. + + + + + Formula arguments separator. + + + + + Represents CSV Separator. Using for Auto recognize file type. + + + + + Gets or sets the qualifier to put around the results with separator or record delimiter. + + + + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = engine.Excel; + + application.CsvQualifier ="$"; + + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet["A1"].Text = "This"; + worksheet["B1"].Text = "is"; + worksheet["C1"].Text = "a"; + worksheet["D1"].Text = "sample"; + worksheet["E1"].Text = "to"; + worksheet["F1"].Text = "set"; + worksheet["G1"].Text = "qualifier,text"; + MemoryStream stream = new MemoryStream(); + workbook.SaveAs(stream, ",", Encoding.Unicode); + } + + + + In the above example, the CSV qualifier is set as "$" and the separator is (,). So, the G1 cell value + "qualifier,text" will be surrounded by qualifier because it contains the separator while saving workbook as CSV document. + + Output of the above code looks like this. + This,is,a,sample,to,set,$qualifier,text$ + + If the results contain the qualifier, the qualifier is repeated. The Qualifier setting must be different from the Separator and RecordDelimiter settings. The default value is quotation ("). + + + + + Gets or sets the record delimiter to put at the end of each record. + + + + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = engine.Excel; + + application.CsvRecordDelimiter ="$"; + + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet["A1"].Text = "This"; + worksheet["B1"].Text = "is"; + worksheet["C1"].Text = "a"; + worksheet["D1"].Text = "sample"; + worksheet["A2"].Text = "to"; + worksheet["B2"].Text = "set"; + worksheet["C2"].Text = "Record Delimiter"; + MemoryStream stream = new MemoryStream(); + workbook.SaveAs(stream, ",", Encoding.Unicode); + } + + + + In the above example, CSV record delimiter is set as '$'. It will be added at the end of each row while saving workbook as CSV document. + + Output of the above code looks like this. + This,is,a,sample$ + to,set,Record Delimiter$ + + The default value is Carriage Return(CR) and Line Feed(LF). + + + + + Returns or sets the name of the standard font. Read/write String. + + + + + Returns or sets the standard font size, in points. Read/write. + + + + + Indicates is use unsafe code. + + + + + Indicates whether to try fast record parsing. + + + + + Gets / sets memory allocation block for single row. Each row will allocate memory block + that can be divided on this number. Smaller value means smaller memory usage but slower + speed when changing cell's value. Default value is 128. That is enough to allocate 9 string records, + or 9 integer numbers (or floating numbers with 1 or 2 digits after decimal point) or 7 double numbers. + + + + + Indicates whether XlsIO should delete destination file before saving into it. + Default value is TRUE. + + + + + Gets / sets default excel version. This value is used in create methods. + + + + + Indicates whether we should use native storage (standard windows COM object) + or our .Net implementation to open excel 97-2003 files. + + + + + Changes data provider type for all operations after it. + + + + + Compression level for workbooks serialization. + + + + + Indicates whether to preserve the datatypes for the CSV file formats. + + + + + Represents the chart to image converter instance. + + + This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Gets or sets a boolean value which indicates whether the chart caches are enabled or not + Default value is false. + + + If set "true" XlsIO will give parsing and serializing support for chart caches + which lead some performance delay and memory consumption + Some spreadsheet viewer requires chart caches to view the chart + This property is supported on Windows Forms, WPF, ASP.NET, ASP.NET MVC, WinRT, WP, Universal and UWP platforms only. + + + + + Specifies whether to increment the references in formula automatically. Default value is false. + + + + + Specifies whether to remove worksheet reference in formulas on removing and reattaching the worksheet. Default value is TRUE. + + + + + Specifies whether to run Partial trust code. + + + True if to run partial trust code; otherwise, false. + + + + + Specifies whether the range should be accessed from worksheet or within the range object scope.. + + + + + Gets or sets a Boolean value to skip the call of method while accessing row height. Default value is FALSE. + + + + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = engine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + //skip autofit row property is set to true. + application.SkipAutoFitRow = true; + double rowHeight = worksheet.GetRowHeight(1); + + Console.WriteLine("SkipAutoFitRow set to true , result will be"); + Console.WriteLine(rowHeight); + + //skip autofit row property is set to false. + application.SkipAutoFitRow = false; + double afterRowHeight = worksheet.GetRowHeight(1); + + Console.WriteLine("SkipAutoFitRow set to false , result will be"); + Console.WriteLine(afterRowHeight); + + workbook.SaveAs("output.xlsx"); + } + + + Output : + + SkipAutoFitRow set to true , result will be + 40.5 + SkipAutoFitRow set to false , result will be + 36.35 + + + + + + Flag to ignore exception and exclude characters more than 32767 (maximum allowed characters) in a cell text. + + + + using(ExcelEngine engine = new ExcelEngine()) + { + //Instantiate the application object + IApplication application = engine.Excel; + + //Set flag to ignore exception and exclude additional characters + application.ExcludeAdditionalCharacters = true; + + //Open the existing workbook + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + //Access the first worksheet + IWorksheet worksheet = workbook.Worksheets[0]; + + //Save the workbook + workbook.SaveAs("Output.xlsx"); + } + + + + + + Get or set maximum rows for CSV file. + + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + + //Instantiate the application object + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Xlsx; + + //Set the maximum rows for CSV file + application.MaximumRowsForCSV = 3000000; + + //Open the existing workbook + IWorkbook workbook = application.Workbooks.Open("Sample.csv"); + + //Access the first worksheet + IWorksheet sheet = workbook.Worksheets[0]; + + //Save the workbook + workbook.SaveAs("Output.csv",","); + } + + + + + + Get or set maximum columns for CSV file. + + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + + //Instantiate the application object + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Xlsx; + + //Set the maximum columns for CSV file + application.MaximumColumnsForCSV = 25000; + + //Open the existing workbook + IWorkbook workbook = application.Workbooks.Open("Sample.csv"); + + //Access the first worksheet + IWorksheet sheet = workbook.Worksheets[0]; + + //Save the workbook + workbook.SaveAs("Output.csv",","); + } + + + + + + + When workbook is read from stream and position of the stream changed, + this event is raised. + + + + + This event is fired when user tries to open password protected workbook + without specifying password. It is used to obtain password. + + + + + This event is fired when user specified wrong password when trying to open + password protected workbook. It is used to obtain correct password. + + + + + This event is fired to substitute an alternate font when a specified font is not installed in the production environment in Excel to PDF/Image conversion. + + This event is supported in Excel to PDF/Image conversion. + + + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = engine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + //Initializes the SubstituteFont event to perform font substitution during ExceltoPDFconversion. + application.SubstituteFont += new SubstituteFontEventHandler(SubstituteFont); + + IWorksheet worksheet = workbook.Worksheets[0]; + ExcelToPdfConverter converter = new ExcelToPdfConverter(workbook); + PdfDocument doc = new PdfDocument(); + doc = converter.Convert(); + doc.Save("PDF.pdf"); + workbook.SaveAs("output.xlsx"); + } + void SubstituteFont(object sender, SubstituteFontEventArgs args) + { + // Sets the alternate font when a specified font is not installed in the production environment. + if (args.OriginalFontName == "Wingdings Regular") + args.AlternateFontName = "Bauhaus 93"; + else + args.AlternateFontName = "Times New Roman"; + } + + + + + + + Width of the zero character. + + + + + Build number. + + + + + Default font size. + + + + + Default quantity of decimal digits after separator. + + + + + Default sheets in the new workbook. + + + + + Default font name. + + + + + Name of the object "Microsoft Excel". + + + + + Name of the switch. + + + + + Switch description. + + + + + Argument separator. + + + + + Row separator. + + + + + Represents size of biff file header. + + + + + Represents xml header. + + + + + Represents xml header. + + + + + Represents default buffer size for auto recognize. + + + + + Represents the default max column width supported by MS Excel. + + + + + Represents Default TSV Separator. + + + + + Represents Default CSV Separator. + + + + + Path separator. + + + + + Represents default header for .xls and .xlt files. + + + + + Defined custom list for sorting. + + + + + Array of Proportions. + + + + + Minimum cell size. + + + + + Represents the Graphic. + + + + + Switch indicating whether to show debug information. + + + + + Flag for debug message. + + + + + All types in the assembly (in order to increase performance). + + + + + Parent object + + + + + Indicates is debug info enabled. + + + + + XlsIO Static Members. + + + + + + + + + + Returns font height for Calibri and Tahoma. + + + + + Indicates whether seprator value is changed or not. + + + + + Indicates whether to add string delimiter for text values. + + + + + Use this NumberFormatChar to check the Unicodes. + + + + + Default styles names. Index means outline level value. + + + + + Table with paper sizes. + + + + + Range representing active cell of the active worksheet of the active workbook. + + + + + Active worksheet. + + + + + Active TabSheet. + + + + + Active workbook. + + + + + Collection of all workbooks in the application. + + + + + All data entered after this field is set to True will be formatted + with the number of fixed decimal places set by the FixedDecimalPlaces + property. + + + + + Gets or sets a Boolean value to ignore duplicate worksheet name exception by adding a suffix at the end.Default value is FALSE. + + + + + True (default) if the system separators of Microsoft Excel are + enabled. + + + + + Standard font size, in points. + + + + + Number of fixed decimal places used when the FixedDecimal + property is set to True. + + + + + The number of sheets that Microsoft Excel automatically + inserts into new workbooks. + + + + + The character used for the decimal separator as a String. + + + + + Name of the standard font. + + + + + The character used for the thousands separator as a String. + + + + + The name of the current user. + + + + + If this value is True and if some cells have reference + to the same style, changes will influence all these cells. + False otherwise + + + + + Storage of SkipExtendedRecords property value. + + + + + Standard row height - height of the rows that do not have specified row height. + + + + + Standard (default) height option flag, which defines that standard (default) + row height and book default font height do not match. + + + + + Standard column width. + + + + + Indicates whether to optimize fonts count. This option will + take effect only on workbooks that will be added after setting + this property. + WARNING: Setting this property to True can decrease performance significantly, + but will reduce resulting file size. + + + + + Indicates whether to optimize Import data. This option will + take effect only on Import methods that are available with the worksheet + WARNING: Setting this property to True can decrease memory significantly, + but will increase the performance of data import . + + + + + Row separator for array parsing. + + + + + Formula arguments separator. + + + + + Represents CSV Separator. + + + + + Represents CSV Qualifier. + + + + + Represents CSV Record Delimiter. + + + + + Indicates whether to try fast record parsing. + + + + + Memory allocation block for single row. + + + + + Indicates whether XlsIO should delete destination file before saving into it. + Default value is TRUE. + + + + + Represents the Fallback font class. + + + + + Represents the Graphic. + + + + + Default excel version for new workbooks. + + + + + + + + + + Indicates whether evaluation license expired. + + + + + Indicates whether the dafault font is changed or not. + + + + + Specifies whether to increment the references in formula automatically. Default value is false. + + + + + Specifies whether to remove worksheet reference in formulas on removing and reattaching the worksheet. Default value is TRUE. + + + + + Gets or sets a boolean value which indicates whether the chart caches are enabled or not + Default value is false. + + + If set "true" XlsIO will give parsing and serializing support for chart caches + which lead some performance delay and memory consumption + Some spreadsheet viewer requires chart caches to view the chart + + + + + Indicates whether the partial trust code is enabled or not. + + + + + Specifies the Range Indexer mode. + + + + + Indicates whether workbook is in parsing process. + + + + + Added to lock a object in multi threading. + + + + + + Flag to ignore exception and exclude characters more than 32767 (maximum allowed characters) in a cell text. + + + + + Flag to denote whether ignoring exception and excluding characters more than 32767 (maximum allowed characters) in a cell text is explicitly set. + + + + + Represents Maximum Rows for CSV file. + + + + + Represents Maximum Columns for CSV file.. + + + + + Specifies whether the excel open type is CSV. Default value is false. + + + + + Static constructor. + + + + + Default constructor. + + + + + Initiliaze the Custom List collections + + + + + This method initializes inner collections of workbooks. + + + + + Initialize the font height for Calibri and Tahoma fonts. + + + + + Converts a measurement from centimeters to points + (one point equals 0.035 centimeters). + + Value in centimeters to convert. + Converted value. + + + + Check whether the file version is supported by XlsIO. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + File full path that contains workbook + + + + + Checks whether a given file is in Excel format based on its file path. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + File path that contains workbook. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Xlsx; + + // Checks if the specified file is a valid Excel file. + if(application.IsExcelFile("sample.xlsx)) + { + // Opens the Excel workbook from the stream. + IWorkbook workbook = application.Workbooks.Open("sample.xlsx", ExcelOpenType.Automatic); + IWorksheet sheet = workbook.Worksheets[0]; + + //Convert the sheet to image. + Image image = sheet.ConvertToImage(1, 1, 10, 20); + image.Save("Sample.png", ImageFormat.Png); + + //Close and Dispose + workbook.Close(); + } + } + + Returns true if the file is in excel format else false. + + + + Check whether the file version is supported by XlsIO. + + File stream that contains workbook + + + + + Checks whether a given stream contains data in Excel format. + + File stream that contains workbook. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Xlsx; + + FileStream stream = new FileStream("sample.xlsx", FileMode.Open); + + // Checks if the content of the stream represents a valid Excel file. + if(application.IsExcelFile(stream)) + { + // Opens the Excel workbook from the stream. + IWorkbook workbook = application.Workbooks.Open("sample.xlsx", ExcelOpenType.Automatic); + IWorksheet sheet = workbook.Worksheets[0]; + + Stream image = new FileStream("Sample.png", FileMode.Create, FileAccess.ReadWrite); + sheet.ConvertToImage(sheet.UsedRange, imageOptions, image); + + //Close and Dispose + workbook.Close(); + } + } + + Returns true if the file is in excel format else false. + + + + Gets file type based on stream data. + + Represents data stream. + Represents type of the file for open operation. + Returns defined open type (cannot return automatic). + + + + Get the name of the storage in case Insensitive + + Compound storage + stream name + + + + + Detects is csv or xml file type. + + Represents data stream. + MemoryStream with data from the file that will be used for file type detection. + Represents start position in stream. + Parsed workbook if detected or null. + + + + Indicates is surrogate value. + + Value for search. + Represents current separator. + Indicates is compare with separator content, or not. + + + + + Converts a measurement from inches to points. + + Value in inches. + Converted value in points. + + + + Saves changes to the active workbook. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + File name of result file. + + + + Creates a new Workbook. + + Parent object for the new workbook. + Excel version. + Newly created workbook. + + + + Creates a new Workbook. + + Parent object for the new workbook. + Stream to read. + Current separator + Number of first row to write. + Number of first column to write. + Excel version. + Filename is used to generate worksheet name + Created workbook. + + + + Creates a new Workbook. + + Parent object for the new workbook. + Stream with workbook's data. + Excel version. + Newly created workbook. + + + + Creates a new Workbook. + + Parent object for the new workbook. + Stream with workbook's data. + Parse options. + Excel version. + Newly created workbook. + + + + Creates a new Workbook. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Parent object for the new workbook. + Name of the file with workbook. + Parse options. + Indicates whether to open workbook in read-only mode. + Password to decrypt. + Excel version. + Newly created workbook. + + + + Creates the workbook. + + Parent object for the new workbook. + Stream with workbook's data. + Parse options. + Indicates whether to open workbook in read-only mode. + Password to decrypt. + Excel version. + Newly created workbook. + + + + Creates a new Workbook. + + Parent object for the new workbook. + Number of sheets in the new workbook. + Excel version. + Newly created workbook. + + + + Creates a new Workbook. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Parent object for the new workbook. + Name of the file with workbook. + Excel version. + Newly created workbook. + + + + Creates a new Workbook. + + Parent object for the new workbook. + Name of the file with workbook. + Parse options. + Excel version. + Newly created workbook. + + + + Creates a new Worksheet. + + Parent object for the new worksheet. + Newly created worksheet. + + + + Creates a new Worksheet. + + Parent object for the new worksheet. + Reader with worksheet data. + Parse options. + Indicates whether to skip parsing. + + Dictionary with new extended format indexes used in ignore styles mode. + + Object used to decrypt encrypted records. + Newly created worksheet. + + + + Creates a new Range. + + Parent object for the new range. + Newly created range. + + + + Creates new range for a single cell. + + Parent object for the new range. + Column index for the new range. + Row index for the new range. + Newly created range. + + + + Creates a new Range. + + Parent object for the new range. + Array of BiffRecordRaws that contains range data. + Index of the range record. + Newly created range. + + + + Creates a new Range. + + Parent object for the new range. + Array of BiffRecordRaws that contains range data. + Index of the range record. + Indicates whether cell styles should be ignored. + Newly created range. + + + + Creates a new Range. + + Parent object for the new range. + Array of BiffRecordRaws that contains range data. + Index of the range record. + Indicates whether cell styles should be ignored. + Newly created range. + + + + Creates a new Range. + + Parent object for the new range. + First column of the range. + First row of the range. + Last column of the range. + Last row of the range. + Newly created range. + + + + Creates a new Range. + + Parent object for the new range. + Range record to parse. + Indicates whether styles should be ignored. + Newly created range. + + + + Creates a new Style. + + Parent object for the new style object. + Name of the new style. + Newly created style. + + + + Creates a new Style. + + Parent object for the new style object. + Name of the new style. + Base style for this style. + Newly created style. + + + + Creates a new Style. + + Parent object for the new style object. + Style record with style information. + Newly created style. + + + + Creates a new Style. + + Parent object for the new style object. + Name of the new style.> + Indicates whether built in style should be created. + + + + + Creates new font. + + Parent object for the new font. + Newly created font. + + + + Method creates a font object based on native font and register it in the workbook. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Parent object for the new font. + Native font to get settings from. + Newly created font. + + + + Creates new font. + + Base font for the new one. + Newly created font. + + + + Creates new font. + + Parent object for the new font. + Font record that contains font information. + Newly created font. + + + + Creates new font. + + Parent object for the new font. + Font object that contains font information. + Newly created font. + + + + This method should be called before creating font. + Sets default font name and size. + + + + + Creates clipboard provider. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Created provider. + + + + + Creates a new chart. + + + The created chart object. + + + + Creates a chart series object. + + + The created chart series object. + + + + Creates new instance of RangesCollection. + + Parent object for the collection. + Newly created collection. + + + + Initializes new hyperlink. + + Parent object for the new hyperlink. + Newly created hyperlink. + + + + Initializes new hyperlink. + + Parent object for the new hyperlink. + Hyperlink range. + Newly created hyperlink. + + + + Initializes new hyperlink. + + Parent object for the new hyperlink. + Hyperlink shape. + Newly created hyperlink. + + + + Initialize new ComentsRange. + + Parent Range for the new CommentRange. + Newly created ComentsRange. + + + + Initialize new CommentShapeImpl. + + Parent object for the new CommentShapeImpl. + Newly created CommentShapeImpl. + + + + Initialize new CommentShapeImpl. + + Parent object for the new CommentShapeImpl. + Indicates is parse comment fill line options. + Newly created CommentShapeImpl. + + + + Initialize new CommentShapeImpl. + + Parent object for the new CommentShapeImpl. + Parent MsofbtSpContainer for the new CommentShapeImpl. + Newly created CommentShapeImpl. + + + + Initialize new CommentShapeImpl. + + Parent object for the new CommentShapeImpl. + Parent MsofbtSpContainer for the new CommentShapeImpl. + Parse options. + Newly created CommentShapeImpl. + + + + Initialize new DataValidationArrayImpl. + + Parent object for the new DataValidationArrayImpl. + Newly created DataValidationArrayImpl. + + + + Initialize new DataValidationWrapper. + + Parent Range for the new DataValidationWrapper. + Parent DataValidationImpl for the new DataValidationWrapper. + Newly created DataValidationWrapper. + + + + Initialize new DataValidationImpl. + + Parent object for the new DataValidationImpl. + Newly created DataValidationImpl. + + + + Initialize new DataValidationImpl. + + Parent object for the new DataValidationImpl. + Base DVRecord for the new DataValidationImpl. + Newly created DataValidationImpl. + + + + Creates collection with specified argument. + + + + + + + Creates ConditionalFormats collection from array of BiffRecords. + + Parent object for the collection. + Main conditional format record. + Array of CFRecords with conditional formats. + + + + Creates ConditionalFormats collection from array of BiffRecords. + + Parent object for the collection. + Main conditional format12 record. + Array of CF12Records with conditional formats. + + + + Creates object that can be used for template markers processing. + + Parent object for the new instance. + Object that can be used for template markers processing. + + + + Creates intptr data provider. + + New instance of created data provider. + + + + + + + + + + Creates compound file based on stream object. + + Stream to create compound file for. + Created compound file object. + + + + Creates compound file object from file. + + Name of the file to open. + Storage flags to use. + Created compound file object. + + + + Creates compound file object. + + Created compound file object. + + + + Create image from stream. + + + + + + + Creates new instance of the textbox shape. + + Parent shapes collection. + Created textbox shape. + + + + Creates new instance of the checkbox shape. + + Parent shapes collection. + Created checkbox shape. + + + + Creates new instance of the OptionButton shape. + + Parent shapes collection. + Created OptionButton shape. + + + + Creates new instance of the combobox shape. + + Parent shapes collection. + Created checkbox shape. + + + + Creates the Compressor. + + + + + + + Checks and apply the seperators to the current culture. + (ie.. DecimalSeperator, ThousandSeperators). + + Current Culture with the new Seperators. + + + + Get the current culture; + + Old cultrue + New cultrue + CultureInfo + + + + Set numberical decimal separator. + + NumberFormat + Numberical separator string + + + + Set thousands separator. + + NumberFormat + Thousands separator string + + + + Sets active workbook. + + Workbook that becomes active. + + + + Sets active worksheet. + + Worksheet that becomes active. + + + + Sets active cell. + + Range that becomes active. + + + + Recalculate Array of Proportions. + + Current DPI value. + + + + Converts to pixels. + + Value to convert. + MeasureUnits. + Returns converted result. + + + + Converts from pixel. + + Pixel to convert. + Convert options. + Returns converted result. + + + + Converts units. + + Value to convert. + Form option. + To option. + Returns converted result. + + + + Converts units. + + Value to convert. + Form option. + To option. + Returns converted result. + + + + Raising progress event. + + Position. + Full size. + + + + Raising TypeMismatchOnExport event. + + The source of the event. + object that contains the event data. + + + + Measures string. + + String to measure. + Font to measure. + Rect size. + Returns new size. + + + + + + + + + + + + + + + + + + + + Returns the Parent object of the application. + + Parent object + + + + Check whether the dynamic object have the overriden methods + + input type + the boolean value indicates whether it have overridden methods + + + + + Check the bytes of image with given header + + Header of possible images in byte array + Byte array value of an image + + + + + Gets the font based on given font details. + + Name of the font. + Size of the font. + Style of the font. + Return the alternatefontstream if exist. + The created font name, or substituted font by event. + + + + Creates font based on given font details. + + Name of the font. + Size of the font. + Style of the font. + The created font. + + + + Default style names. + + + + + Gets a Fallback font collection. + + + + + Switch indicating whether to show debug information. Read-only. + + This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Indicates whether debug info is enabled. Read-only. + + + + + Indicates is use unsafe code. Static property. + + + + + Changes data provider type for all operations after it. Static property. + + + + + If True, no changes were made since last save. + + + + + Indicates whether the formula is parsed. + + + + + Returns standard row height in units used by RowRecord. + + + + + Indicates whether evaluation license expired. + + + + + Gets or sets a boolean value indicating whether to add string delimiter for all the text values. Default value is FALSE. + + + + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = engine.Excel; + application.UseStringDelimiter = true; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet["A1"].Text = "Document"; + worksheet["B1"].Value = "6"; + MemoryStream stream = new MemoryStream(); + workbook.SaveAs(stream, ",",Encoding.Unicode); + } + + + + In the above example, cell A1 contains a text value. So, it will be surrounded by string delimiter i.e., double quotes + while saving workbook as CSV document. + + Output of the above code looks like this. + "Document",6 + + + + + Returns a Range object that represents the active cell in the + active window (the window on top) or in the specified window. + If the window isn't displaying a worksheet, this property fails. + Read-only. + + + + + Returns an object that represents the active sheet (the sheet on + top) in the active workbook or in the specified window or workbook. + Returns NULL (Nothing in VB) if no sheet is active. Read-only. + + + + + Returns an object that represents the active tab sheet (the tab sheet on + top) in the active workbook or in the specified window or workbook. + Returns NULL (Nothing in VB) if no sheet is active. Read-only. + + + + + Returns a Workbook object that represents the workbook in the active + window (the window on top). Read-only. Returns NULL (Nothing in VB) if there are + no windows open or if either the Info window or the Clipboard window + is the active window. + + + + + Used without an object qualifier, this property returns an Application + object that represents the Microsoft Excel application. Used with an + object qualifier, this property returns an Application object that + represents the creator of the specified object (you can use this property + with an OLE Automation object to return that object's application). + Read-only. + + + + + Returns a Workbooks collection that represents all the open workbooks. + Read-only. + + + + + For an Application object, returns a Sheets collection that represents + all worksheets in the active workbook. For a Workbook object, + returns a Sheets collection that represents all the worksheets in the + specified workbook. Read-only Sheets object. + + + + + Returns the parent object for the specified object. Read-only. + + + + + Returns a Range object that represents a cell or a range of cells. + Read-only. + + + + + All data entered after this property is set to True will be formatted + with the number of fixed decimal places set by the FixedDecimalPlaces + property. Read/write Boolean. + + + + + + True (default) if the system separators of Microsoft Excel are + enabled. Read/write Boolean. + + + + + Returns or sets the standard font size, in points. Read/write. + + + + + Returns the Microsoft Excel build number. Read-only. + + + + + Returns or sets the number of fixed decimal places used when + the FixedDecimal property is set to True. Read/write. + + + + + Returns or sets the number of sheets that Microsoft Excel + automatically inserts into new workbooks. Read/write Long. + + + + + Sets or returns the character used for the decimal separator as a + String. Read/write. + + + + + Returns or sets the default path that Microsoft Excel uses when it + opens files. Read/write String. + + This property is supported on Windows Forms, WPF, ASP.NET, ASP.NET MVC, WinRT, Windows Phone and Universal platforms only. + + + + Returns the path separator character ("\"). Read-only String. + + This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Returns or sets the name of the standard font. Read/write String. + + + + + Sets or returns the character used for the thousands separator + as a String. Read/write + + + + + Returns or sets the name of the current user. Read/write String. + + + + + For the Application object, it always returns "Microsoft Excel". For + the CubeField object, the name of the specified field. For the Style + object, the name of the specified style. Read-only String. + + + + + When this property is set to True, if some cells have reference + to the same style, changes will influence all these cells. + Default value: FALSE. + + + + + Flags that control behavior of workbook save methods. Each flag controls + one aspect of save code. Can be set one or more flags influencing + the output produced. + + + + + Returns or sets the standard (default) height of all the rows in the worksheet, + in points. Read/write Double. + + + + + Returns or sets the standard (default) height option flag, which defines that + standard (default) row height and book default font height do not match. + Read/write Bool. + + + + + Returns or sets the standard (default) width of all the columns in the + worksheet. Read/write Double. + + + + + Indicates whether to optimize fonts count. This option will + take effect only on workbooks that will be added after setting + this property. + WARNING: Setting this property to True can decrease performance significantly, + but will reduce resulting file size. + + + + + Indicates whether to optimize Import data. This option will + take effect only on Import methods that are available with the worksheet + WARNING: Setting this property to True can decrease memory significantly, + but will increase the performance of data import . + + + + + Gets / sets row separator for array parsing. + + + + + Formula arguments separator. + + + + + Represents CSV Separator. + + + + + Gets or sets the qualifier to put around the results with separator or record delimiter. + + + + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = engine.Excel; + + application.CsvQualifier ="$"; + + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet["A1"].Text = "This"; + worksheet["B1"].Text = "is"; + worksheet["C1"].Text = "a"; + worksheet["D1"].Text = "sample"; + worksheet["E1"].Text = "to"; + worksheet["F1"].Text = "set"; + worksheet["G1"].Text = "qualifier,text"; + MemoryStream stream = new MemoryStream(); + workbook.SaveAs(stream, ",", Encoding.Unicode); + } + + + + In the above example, the CSV qualifier is set as "$" and the separator is (,). So, the G1 cell value + "qualifier,text" will be surrounded by qualifier because it contains the separator while saving workbook as CSV document. + + Output of the above code looks like this. + This,is,a,sample,to,set,$qualifier,text$ + + If the results contain the qualifier, the qualifier is repeated. The Qualifier setting must be different from the Separator and RecordDelimiter settings. The default value is quotation ("). + + + + + Gets or sets the record delimiter to put at the end of each record. + + + + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = engine.Excel; + + application.CsvRecordDelimiter ="$"; + + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet["A1"].Text = "This"; + worksheet["B1"].Text = "is"; + worksheet["C1"].Text = "a"; + worksheet["D1"].Text = "sample"; + worksheet["A2"].Text = "to"; + worksheet["B2"].Text = "set"; + worksheet["C2"].Text = "Record Delimiter"; + MemoryStream stream = new MemoryStream(); + workbook.SaveAs(stream, ",", Encoding.Unicode); + } + + + + In the above example, CSV record delimiter is set as '$'. It will be added at the end of each row while saving workbook as CSV document. + + Output of the above code looks like this. + This,is,a,sample$ + to,set,Record Delimiter$ + + The default value is Carriage Return(CR) and Line Feed(LF). + + + + + Indicates is use unsafe code. + + + + + Indicates whether to try fast record parsing. + + + + + Gets / sets memory allocation block for single row. Each row will allocate memory block + that can be divided on this number. Smaller value means smaller memory usage but slower + speed when changing cell's value. Default value is 128. That is enough to allocate 9 string records, + or 9 integer numbers (or floating numbers with 1 or 2 digits after decimal point) or 7 double numbers. + + + + + Indicates whether XlsIO should delete destination file before saving into it. + Default value is TRUE. + + + + + Gets / sets default excel version. This value is used in create methods. + + + + + Indicates whether we should use native storage (standard windows COM object) + or our .Net implementation to open excel 97-2003 files. + + + + + Changes data provider type for all operations after it. Static property. + + + + + Compression level for workbooks serialization. + + + + + Indicates whether to preserve the datatypes for the CSV file formats. + + + + + Specifies whether to increment the references in formula automatically. Default value is false. + > + + + + Represents the Chart to Image Converter instance. + Returns null if it is not instantiated. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Gets or sets a boolean value which indicates whether the chart caches are enabled or not + Default value is false. + + + If set "true" XlsIO will give parsing and serializing support for chart caches + which lead some performance delay and memory consumption + Some spreadsheet viewer requires chart caches to view the chart. + This method is supported on Windows Forms, WPF, ASP.NET, ASP.NET MVC, WinRT, Windows Phone, Universal and UWP platforms only. + + + + + Specifies whether to run Partial trust code. + + + + + Specifies whether to run Partial trust code. + + + True if to run partial trust code; otherwise, false. + + + + + Specifies whether the range should be accessed from worksheet or within the range object scope.. + + The following code illustrates how to change range indexer mode by this property. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.RangeIndexerMode = ExcelRangeIndexerMode.Relative; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange range = sheet.Range["A5:C7"]; + IRange relativeRange = range[2, 2]; + + string fileName = "RelativeRangeIndexer.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Specifies whether to remove worksheet reference in formulas on removing and reattaching the worksheet. Default value is TRUE. + + + Updates the worksheet reference in formulas while removing the worksheet. Default value is TRUE. Setting UpdateSheetFormulaReference to FALSE while removing the worksheet, will retain the sheet name in the formulas. + If worksheet with same name is created, then the formula will refer the new worksheet with that name. + + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + + // Ignores removal of worksheet reference in the formulas while removing the worksheet. + application.UpdateSheetFormulaReference = false; + + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Formula = "Sheet2!A1"; + workbook.Worksheets["Sheet2"].Remove(); + workbook.Worksheets.Create("Sheet2"); + string formula = sheet.Range["A1"].Formula; + workbook.SaveAs("Output.xlsx"); + workbook.Close(); + } + + + + + + Indicates whether workbook is in parsing process. + + + + + + Returns font height for Calibri and Tahoma. + + + + + Flag to ignore exception and exclude characters more than 32767 (maximum allowed characters) in a cell text. + + + + + Get or set maximum rows for CSV file. + + + + + Get or set maximum columns for CSV file. + + + + + + Progress event handler. + + + + + This event is fired when user tries to open password protected workbook + without specifying password. It is used to obtain password. + + + + + This event is fired when user specified wrong password when trying to open + password protected workbook. It is used to obtain correct password. + + + + + This event is fired to substitute an alternate font when a specified font is not installed in the production environment in Excel to PDF/Image conversion. + + This event is supported for Excel to PDF/Image conversion. + + + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = engine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + //Initializes the SubstituteFont event to perform font substitution during ExceltoPDFconversion. + application.SubstituteFont += new SubstituteFontEventHandler(SubstituteFont); + + IWorksheet worksheet = workbook.Worksheets[0]; + ExcelToPdfConverter converter = new ExcelToPdfConverter(workbook); + PdfDocument doc = new PdfDocument(); + doc = converter.Convert(); + doc.Save("PDF.pdf"); + workbook.SaveAs("output.xlsx"); + } + void SubstituteFont(object sender, SubstituteFontEventArgs args) + { + // Sets the alternate font when a specified font is not installed in the production environment. + if (args.OriginalFontName == "Wingdings Regular") + args.AlternateFontName = "Bauhaus 93"; + else + args.AlternateFontName = "Times New Roman"; + } + + + + + + + Represents the method that handles substitute font event. + + This event is supported for Excel to PDF/Image conversion alone + + + + Represents the substitute font event that occurs during Excel to PDF/Image conversion to substitute the alternate fonts when a specified font is not installed in the production environment. + + This event is supported for Excel to PDF/Image conversion alone + + + + Represents the original font name. + + + + + Represents the substitute font name. + + + + + Represents the substitute font name. + + + + + Initializes a new instance of class for the specified document + with original (missing) font name, and alternate font name. + + Name of the original (missing) font name. + Name of the alternate font name. + + + + Gets the original font name. Read Only. + + The original font is not installed in production environment + The string that specifies the orignal font name. + + + + Gets or sets the alternate font name. + + The string that specifies the alternate font name. + + + + Gets or sets the alternate font stream. + + The stream that specifies the alternate font . + is considered over if the alternate font stream is valid + + + + Summary description for AutoFilterConditionImpl. + + + + + Represents the autofilter conditions for . + + + + + Gets or sets Data type. + + + The following code illustrates how to set datatype for autofilter condition. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set filter range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[0]; + + //Set Is AND or OR + filter.IsAnd = true; + + //Add filter + filter.FirstCondition.ConditionOperator = ExcelFilterCondition.DoesNotBeginWith; + filter.FirstCondition.DataType = ExcelFilterDataType.String; + filter.FirstCondition.String = "A"; + + filter.SecondCondition.ConditionOperator = ExcelFilterCondition.EndsWith; + filter.SecondCondition.DataType = ExcelFilterDataType.String; + filter.SecondCondition.String = "n"; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets Comparison operator. + + + The following code illustrates how to set the operator for filter condition. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set filter range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[0]; + + //Set Is AND or OR + filter.IsAnd = true; + + //Add filter + filter.FirstCondition.ConditionOperator = ExcelFilterCondition.DoesNotBeginWith; + filter.FirstCondition.DataType = ExcelFilterDataType.String; + filter.FirstCondition.String = "A"; + + filter.SecondCondition.ConditionOperator = ExcelFilterCondition.EndsWith; + filter.SecondCondition.DataType = ExcelFilterDataType.String; + filter.SecondCondition.String = "n"; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets String value. + + + The can be used to filter as well as . Here for example, we + set the to filter texts in cells which "A" and + "n". For this we have to set to and + set strings to property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set filter range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[0]; + + //Set Is AND or OR + filter.IsAnd = true; + + //Add filter + filter.FirstCondition.ConditionOperator = ExcelFilterCondition.DoesNotBeginWith; + filter.FirstCondition.DataType = ExcelFilterDataType.String; + filter.FirstCondition.String = "A"; + + filter.SecondCondition.ConditionOperator = ExcelFilterCondition.EndsWith; + filter.SecondCondition.DataType = ExcelFilterDataType.String; + filter.SecondCondition.String = "n"; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Boolean value. Read-only. (Used internally) + + + + + Error code. Read-only. (Used internally) + + + + + Gets or sets Floating-point value. + + + The can be used to filter as well as . Here for example, we + set the to filter numeric data in cells, so we set + to and set and 's + value. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set filter range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[0]; + + //Set Is AND or OR + filter.IsAnd = true; + + //Add filter + filter.FirstCondition.ConditionOperator = ExcelFilterCondition.Greater; + filter.FirstCondition.DataType = ExcelFilterDataType.FloatingPoint; + filter.FirstCondition.Double = 400; + + filter.SecondCondition.ConditionOperator = ExcelFilterCondition.Less; + filter.SecondCondition.DataType = ExcelFilterDataType.FloatingPoint; + filter.SecondCondition.Double = 3000; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Data type. + + + + + Comparison operator. + + + + + String value. + + + + + Boolean value. + + + + + Error code. + + + + + Floating-point value. + + + + + Creates new instance. + + + + + Creates new instance. + + Filters collection. + Current filter. + + + + Disposes the AutoFilter Condition. + + + + + Parse current object. + + Current condition. + + + + Serialize method. + + Current condition. + + + + Clones current instance. + + Parent object. + Returns just cloned object. + + + + Data type. + + + + + Comparison operator. + + + + + String value. + + + + + Boolean value. + + + + + Error code. + + + + + Floating-point value. + + + + + This class represents single autofilter item. + + + + + Represents an Autofilter in an Excel worksheet. + + + + + Add Color Filter with the specified object + + to be filtered. + applied. + + To apply filters within tables in worksheet, we have to set the as child of . The range for + the will be same as the . + + + Color filter can be applied based on or . Here for example, + we apply filter based on . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Apply colors + worksheet["A2:A3"].CellStyle.Color = System.Drawing.Color.Red; + worksheet["A4:A5"].CellStyle.Color = System.Drawing.Color.Blue; + worksheet["A6:A7"].CellStyle.Color = System.Drawing.Color.Green; + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[0]; + + //Add filter + filter.AddColorFilter(System.Drawing.Color.Blue, ExcelColorFilterType.CellColor); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + } + + + + + + Apply Icon Filter with the specfied iconId for the Iconset applied. + + to be filtered from. + IconId to be filtered. + + To apply filters within tables in worksheet, we have to set the as child of . The range for + the will be same as the . + + + Iconsets can be applied by setting conditional formats for data in the worksheet. For the iconsets applied using conditional formats we can apply + to filter a particular icon based on it's id or index. Here for example, we set + using conditional formats and filter the first icon in it. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 144.6; + worksheet["B3"].Number = 579.6; + worksheet["B4"].Number = 267.5; + worksheet["B5"].Number = 418; + worksheet["B6"].Number = 728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C7"].CellStyleName = "CurrencyFormat"; + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[1]; + + //Create conditional formats + IConditionalFormats formats = worksheet["B2:B7"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Type as IconSet + format.FormatType = ExcelCFType.IconSet; + + //Add filter + filter.AddIconFilter(ExcelIconSetType.ThreeArrows, 0); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + } + + + + + + + Apply text filter with the specified string. + + string value need to add in the text filter + + To apply filters within tables in worksheet, we have to set the as child of . The range for + the will be same as the . + + + The following code illustrates how to apply text filter with the specified string. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C7"].CellStyleName = "CurrencyFormat"; + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[0]; + + //Add filter + filter.AddTextFilter("Around the Horn"); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + } + + + + + + + Remove text value in text filter with the specified string. + + Value need to remove from the filter list. + Return true if value is removed, else return false. + + The following code illustrates how to remove a specific text from the text filter's filtered list. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[0]; + + //Add filter + filter.AddTextFilter("Eastern Connection"); + filter.AddTextFilter("Around the Horn"); + filter.AddTextFilter("Bon app"); + + //Remove filter + filter.RemoveText("Around the Horn"); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + } + + + + + + Apply DateTime filter with the specified date time. + + year in the date time. + month in the date time. + day in the date time. + hour in the date time. + mintue in the date time. + Seconds in the date time. + With respective grouping type. + + To apply filters within tables in worksheet, we have to set the as child of . The range for + the will be same as the . + + + The following code illustrates how to apply DateTime filter. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Title"; + worksheet["A2"].Text = "Sales Representative"; + worksheet["A3"].Text = "Sales Agent"; + worksheet["A4"].Text = "Owner"; + worksheet["A5"].Text = "Sales Associate"; + worksheet["A6"].Text = "Sales Representative"; + worksheet["A7"].Text = "Marketing Manager"; + worksheet["B1"].Text = "DOJ"; + worksheet["B2"].DateTime = DateTime.Parse("6/5/2011"); + worksheet["B3"].DateTime = DateTime.Parse("9/5/2011"); + worksheet["B4"].DateTime = DateTime.Parse("10/21/2007"); + worksheet["B5"].DateTime = DateTime.Parse("9/28/2004"); + worksheet["B6"].DateTime = DateTime.Parse("8/28/2007"); + worksheet["B7"].DateTime = DateTime.Parse("8/12/2003"); + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[1]; + + //Add filter + filter.AddDateFilter(2004, 9, 28, 0, 0, 0, DateTimeGroupingType.month); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + } + + + + + + Apply DateTime filter with the specified date time. + + Date with time which need to add. + Type of grouping. + + To apply filters within tables in worksheet, we have to set the as child of . The range for + the will be same as the . + + + The following code illustrates how to apply DateTime filter by passing object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Title"; + worksheet["A2"].Text = "Sales Representative"; + worksheet["A3"].Text = "Sales Agent"; + worksheet["A4"].Text = "Owner"; + worksheet["A5"].Text = "Sales Associate"; + worksheet["A6"].Text = "Sales Representative"; + worksheet["A7"].Text = "Marketing Manager"; + worksheet["B1"].Text = "DOJ"; + worksheet["B2"].DateTime = DateTime.Parse("9/5/2011"); + worksheet["B3"].DateTime = DateTime.Parse("9/5/2011"); + worksheet["B4"].DateTime = DateTime.Parse("10/21/2007"); + worksheet["B5"].DateTime = DateTime.Parse("9/28/2004"); + worksheet["B6"].DateTime = DateTime.Parse("8/28/2007"); + worksheet["B7"].DateTime = DateTime.Parse("8/12/2003"); + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[1]; + + //Add filter + filter.AddDateFilter(new DateTime(2004, 9, 28, 0, 0, 0, 0), DateTimeGroupingType.month); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + Remove specified date time from DateTime filter. + + year in the date time. + month in the date time. + day in the date time. + hour in the date time. + mintue in the date time. + Seconds in the date time. + With respective grouping type. + Return true if value is removed, else return false. + + The following code illustrates how to remove a particular date time from the date time filter's filtered list. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Title"; + worksheet["A2"].Text = "Sales Representative"; + worksheet["A3"].Text = "Sales Agent"; + worksheet["A4"].Text = "Owner"; + worksheet["A5"].Text = "Sales Associate"; + worksheet["A6"].Text = "Sales Representative"; + worksheet["A7"].Text = "Marketing Manager"; + worksheet["B1"].Text = "DOJ"; + worksheet["B2"].DateTime = DateTime.Parse("6/5/2011"); + worksheet["B3"].DateTime = DateTime.Parse("9/5/2011"); + worksheet["B4"].DateTime = DateTime.Parse("10/21/2007"); + worksheet["B5"].DateTime = DateTime.Parse("9/28/2004"); + worksheet["B6"].DateTime = DateTime.Parse("8/28/2007"); + worksheet["B7"].DateTime = DateTime.Parse("8/12/2003"); + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[1]; + + //Add filter + filter.AddDateFilter(2004, 9, 28, 0, 0, 0, DateTimeGroupingType.month); + filter.AddDateFilter(2007, 8, 28, 0, 0, 0, DateTimeGroupingType.month); + filter.AddDateFilter(2011, 9, 5, 0, 0, 0, DateTimeGroupingType.month); + + //Remove filter + filter.RemoveDate(2007, 8, 28, 0, 0, 0, DateTimeGroupingType.month); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + } + + + + + + Remove specified date time from DateTime filter. + + Datetime which need to remove. + With respective grouping type + Return true if value is removed, else return false. + + The following code illustrates how to remove a particular date time from the date time filter's filtered list by passing + object as an argument. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Title"; + worksheet["A2"].Text = "Sales Representative"; + worksheet["A3"].Text = "Sales Agent"; + worksheet["A4"].Text = "Owner"; + worksheet["A5"].Text = "Sales Associate"; + worksheet["A6"].Text = "Sales Representative"; + worksheet["A7"].Text = "Marketing Manager"; + worksheet["B1"].Text = "DOJ"; + worksheet["B2"].DateTime = DateTime.Parse("6/5/2011"); + worksheet["B3"].DateTime = DateTime.Parse("9/5/2011"); + worksheet["B4"].DateTime = DateTime.Parse("10/21/2007"); + worksheet["B5"].DateTime = DateTime.Parse("9/28/2004"); + worksheet["B6"].DateTime = DateTime.Parse("8/28/2007"); + worksheet["B7"].DateTime = DateTime.Parse("8/12/2003"); + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[1]; + + //Add filter + filter.AddDateFilter(new DateTime(2004, 9, 28, 0, 0, 0, 0), DateTimeGroupingType.month); + filter.AddDateFilter(new DateTime(2007, 8, 28, 0, 0, 0, 0), DateTimeGroupingType.month); + filter.AddDateFilter(new DateTime(2011, 9, 5, 0, 0, 0, 0), DateTimeGroupingType.month); + + //Remove filter + filter.RemoveDate(new DateTime(2007, 8, 28, 0, 0, 0, 0), DateTimeGroupingType.month); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + } + + + + + + Apply dynamic date filter based on the specified relative date constant. + + Type dynamic filter + + The following code illustrates how to apply the . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Title"; + worksheet["A2"].Text = "Sales Representative"; + worksheet["A3"].Text = "Sales Agent"; + worksheet["A4"].Text = "Owner"; + worksheet["A5"].Text = "Sales Associate"; + worksheet["A6"].Text = "Sales Representative"; + worksheet["A7"].Text = "Marketing Manager"; + worksheet["B1"].Text = "DOJ"; + worksheet["B2"].DateTime = DateTime.Parse("6/5/2011"); + worksheet["B3"].DateTime = DateTime.Parse("9/5/2011"); + worksheet["B4"].DateTime = DateTime.Parse("10/21/2007"); + worksheet["B5"].DateTime = DateTime.Parse("9/28/2004"); + worksheet["B6"].DateTime = DateTime.Parse("8/28/2007"); + worksheet["B7"].DateTime = DateTime.Parse("8/12/2003"); + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[1]; + + //Add filter + filter.AddDynamicFilter(DynamicFilterType.Quarter3); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + } + + + + + + Remove dynamic date filter if exist. + + Return true if dynamic filter is removed, else return false. + + The following code illustrates how to remove the . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Title"; + worksheet["A2"].Text = "Sales Representative"; + worksheet["A3"].Text = "Sales Agent"; + worksheet["A4"].Text = "Owner"; + worksheet["A5"].Text = "Sales Associate"; + worksheet["A6"].Text = "Sales Representative"; + worksheet["A7"].Text = "Marketing Manager"; + worksheet["B1"].Text = "DOJ"; + worksheet["B2"].DateTime = DateTime.Parse("6/5/2011"); + worksheet["B3"].DateTime = DateTime.Parse("9/5/2011"); + worksheet["B4"].DateTime = DateTime.Parse("10/21/2007"); + worksheet["B5"].DateTime = DateTime.Parse("9/28/2004"); + worksheet["B6"].DateTime = DateTime.Parse("8/28/2007"); + worksheet["B7"].DateTime = DateTime.Parse("8/12/2003"); + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[1]; + + //Add filter + filter.AddDynamicFilter(DynamicFilterType.Quarter3); + + //Remove filter + filter.RemoveDynamicFilter(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + } + + + + + + Removes the Color Filter applied + + + The following code illustrates how to remove the . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Apply colors + worksheet["A2:A3"].CellStyle.Color = System.Drawing.Color.Red; + worksheet["A4:A5"].CellStyle.Color = System.Drawing.Color.Blue; + worksheet["A6:A7"].CellStyle.Color = System.Drawing.Color.Green; + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[0]; + + //Add filter + filter.AddColorFilter(System.Drawing.Color.Blue, ExcelColorFilterType.CellColor); + + //Remove filter + filter.RemoveColorFilter(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + } + + + + + + Removes the Icon Filter applied. + + + The following code illustrates how to remove the . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 144.6; + worksheet["B3"].Number = 579.6; + worksheet["B4"].Number = 267.5; + worksheet["B5"].Number = 418; + worksheet["B6"].Number = 728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[1]; + + //Create conditional formats + IConditionalFormats formats = worksheet["B2:B7"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Type as IconSet + format.FormatType = ExcelCFType.IconSet; + + //Add filter + filter.AddIconFilter(ExcelIconSetType.ThreeArrows, 0); + + //Remove filter + filter.RemoveIconFilter(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + } + + + + + + First condition of autofilter. + + + To know more about filters refer Data Filtering + + + Custom filters can be applied by setting and . To filter particular pattern we can + make use of custom filters. Here for example, we set a custom filter to filter values those does not start with "A" but should end with "N". + For this we set to 's + and to 's and + set to for both coditions. + Also we set "A" and "N" to for and + respectively. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C7"].CellStyleName = "CurrencyFormat"; + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[0]; + + //Add filter + filter.FirstCondition.ConditionOperator = ExcelFilterCondition.DoesNotBeginWith; + filter.FirstCondition.DataType = ExcelFilterDataType.String; + filter.FirstCondition.String = "A"; + + filter.SecondCondition.ConditionOperator = ExcelFilterCondition.EndsWith; + filter.SecondCondition.DataType = ExcelFilterDataType.String; + filter.SecondCondition.String = "n"; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + } + + + + + + Second condition of autofilter. + + + To setup a custom should be used. is optional. + + + The following code illustrates how to set second condition. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C7"].CellStyleName = "CurrencyFormat"; + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[0]; + + //Set Is AND or OR + filter.IsAnd = true; + + //Add filter + filter.FirstCondition.ConditionOperator = ExcelFilterCondition.DoesNotBeginWith; + filter.FirstCondition.DataType = ExcelFilterDataType.String; + filter.FirstCondition.String = "A"; + + filter.SecondCondition.ConditionOperator = ExcelFilterCondition.EndsWith; + filter.SecondCondition.DataType = ExcelFilterDataType.String; + filter.SecondCondition.String = "n"; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + } + + + + + + False indicates that this autofilter was not used; otherwise True. Read-only. + + + The following code illustrates how to access the property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Title"; + worksheet["A2"].Text = "Sales Representative"; + worksheet["A3"].Text = "Sales Agent"; + worksheet["A4"].Text = "Owner"; + worksheet["A5"].Text = "Sales Associate"; + worksheet["A6"].Text = "Sales Representative"; + worksheet["A7"].Text = "Marketing Manager"; + worksheet["B1"].Text = "DOJ"; + worksheet["B2"].DateTime = DateTime.Parse("6/5/2011"); + worksheet["B3"].DateTime = DateTime.Parse("9/5/2011"); + worksheet["B4"].DateTime = DateTime.Parse("10/21/2007"); + worksheet["B5"].DateTime = DateTime.Parse("9/28/2004"); + worksheet["B6"].DateTime = DateTime.Parse("8/28/2007"); + worksheet["B7"].DateTime = DateTime.Parse("8/12/2003"); + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[1]; + + //Check filter applied or not + Console.WriteLine(filter.IsFiltered); + + //Add filter + filter.AddDynamicFilter(DynamicFilterType.Quarter3); + + //Check filter applied or not + Console.WriteLine(filter.IsFiltered); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Tables.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //False + //True + + + + + + True means to use AND operation between conditions, + False to use OR. Read-only. + + + If both the conditions given for should be applied without considering the other condition + should be set to "false". By default is set to "true", so it combines both the conditions and applies the filter. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C7"].CellStyleName = "CurrencyFormat"; + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[0]; + + //Set Is AND or OR + filter.IsAnd = false; + + //Add filter + filter.FirstCondition.ConditionOperator = ExcelFilterCondition.DoesNotBeginWith; + filter.FirstCondition.DataType = ExcelFilterDataType.String; + filter.FirstCondition.String = "A"; + + filter.SecondCondition.ConditionOperator = ExcelFilterCondition.EndsWith; + filter.SecondCondition.DataType = ExcelFilterDataType.String; + filter.SecondCondition.String = "n"; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + } + + + + + + True if the Top 10 AutoFilter shows percentage; (Used internally) + False if it shows items. Read-only. + + + + + True if the first condition is a simple equality. Read-only. + + + The following code illustrates how IsSimple1 property can be used. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C7"].CellStyleName = "CurrencyFormat"; + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[0]; + + //Set Is AND or OR + filter.IsAnd = false; + + //Add filter + filter.FirstCondition.ConditionOperator = ExcelFilterCondition.Equal; + filter.FirstCondition.DataType = ExcelFilterDataType.String; + filter.FirstCondition.String = "Alfreds Futterkiste"; + + filter.SecondCondition.ConditionOperator = ExcelFilterCondition.Equal; + filter.SecondCondition.DataType = ExcelFilterDataType.String; + filter.SecondCondition.String = "Ernst Handel"; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + Console.WriteLine(filter.IsSimple1); + Console.WriteLine(filter.IsSimple2); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + //True + + + + + + True if the second condition is a simple equality. Read-only. + + + The following code illustrates how IsSimple2 property can be used. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C7"].CellStyleName = "CurrencyFormat"; + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[0]; + + //Set Is AND or OR + filter.IsAnd = false; + + //Add filter + filter.FirstCondition.ConditionOperator = ExcelFilterCondition.Equal; + filter.FirstCondition.DataType = ExcelFilterDataType.String; + filter.FirstCondition.String = "Alfreds Futterkiste"; + + filter.SecondCondition.ConditionOperator = ExcelFilterCondition.Equal; + filter.SecondCondition.DataType = ExcelFilterDataType.String; + filter.SecondCondition.String = "Ernst Handel"; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + Console.WriteLine(filter.IsSimple1); + Console.WriteLine(filter.IsSimple2); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + //True + + + + + + True if the Top 10 AutoFilter shows the top items; + False if it shows the bottom items. + + + The following code illustrates how to set the property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Top 10"; + worksheet["A2"].Number = 7; + worksheet["A3"].Number = 1; + worksheet["A4"].Number = 8; + worksheet["A5"].Number = 2; + worksheet["A6"].Number = 3; + worksheet["A7"].Number = 9; + worksheet["A8"].Number = 15; + worksheet["A9"].Number = 19; + worksheet["A10"].Number = 23; + worksheet["A11"].Number = 42; + worksheet["A12"].Number = 5; + worksheet["A13"].Number = 7; + worksheet["A14"].Number = 12; + worksheet["A15"].Number = 16; + worksheet["A16"].Number = 22; + worksheet["A17"].Number = 33; + worksheet["A18"].Number = 25; + worksheet["A19"].Number = 30; + worksheet["A20"].Number = 38; + worksheet["A21"].Number = 6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create filter + IAutoFilters filters = worksheet.AutoFilters; + filters.FilterRange = worksheet["A1:A21"]; + IAutoFilter filter = filters[0]; + + //Set top + filter.IsTop = false; + + //Set top 10 number + filter.Top10Number = 5; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + } + + + + + + True if the condition is a Top 10 AutoFilter. + + + The following code illustrates how Top 10 is set for autofilters. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Top 10"; + worksheet["A2"].Number = 7; + worksheet["A3"].Number = 1; + worksheet["A4"].Number = 8; + worksheet["A5"].Number = 2; + worksheet["A6"].Number = 3; + worksheet["A7"].Number = 9; + worksheet["A8"].Number = 15; + worksheet["A9"].Number = 19; + worksheet["A10"].Number = 23; + worksheet["A11"].Number = 42; + worksheet["A12"].Number = 5; + worksheet["A13"].Number = 7; + worksheet["A14"].Number = 12; + worksheet["A15"].Number = 16; + worksheet["A16"].Number = 22; + worksheet["A17"].Number = 33; + worksheet["A18"].Number = 25; + worksheet["A19"].Number = 30; + worksheet["A20"].Number = 38; + worksheet["A21"].Number = 6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create filter + IAutoFilters filters = worksheet.AutoFilters; + filters.FilterRange = worksheet["A1:A21"]; + IAutoFilter filter = filters[0]; + + //Set top 10 + filter.IsTop10 = true; + + //Set top 10 number + filter.Top10Number = 5; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + } + + + + + + Number of elements to show in Top10 mode. + + + The following code illustrates how to set the property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Top 10"; + worksheet["A2"].Number = 7; + worksheet["A3"].Number = 1; + worksheet["A4"].Number = 8; + worksheet["A5"].Number = 2; + worksheet["A6"].Number = 3; + worksheet["A7"].Number = 9; + worksheet["A8"].Number = 15; + worksheet["A9"].Number = 19; + worksheet["A10"].Number = 23; + worksheet["A11"].Number = 42; + worksheet["A12"].Number = 5; + worksheet["A13"].Number = 7; + worksheet["A14"].Number = 12; + worksheet["A15"].Number = 16; + worksheet["A16"].Number = 22; + worksheet["A17"].Number = 33; + worksheet["A18"].Number = 25; + worksheet["A19"].Number = 30; + worksheet["A20"].Number = 38; + worksheet["A21"].Number = 6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C8"].CellStyleName = "CurrencyFormat"; + + //Create filter + IAutoFilters filters = worksheet.AutoFilters; + filters.FilterRange = worksheet["A1:A21"]; + IAutoFilter filter = filters[0]; + + //Set top + filter.IsTop = false; + + //Set top 10 number + filter.Top10Number = 5; + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + } + + + + + + Returns filter values for combination type ( Text and DateTime) and dynamic type. It returns null, if custom filter is applied. Read-only. + + + The following code illustrates how to access the applied filter using property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Apply colors + worksheet["A2:A3"].CellStyle.Color = System.Drawing.Color.Red; + worksheet["A4:A5"].CellStyle.Color = System.Drawing.Color.Blue; + worksheet["A6:A7"].CellStyle.Color = System.Drawing.Color.Green; + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set range + filters.FilterRange = worksheet["A1:A7"]; + + //Set filter column + IAutoFilter filter = filters[0]; + + //Add filter + filter.AddColorFilter(System.Drawing.Color.Blue, ExcelColorFilterType.CellColor); + + //Get filtered items + Console.WriteLine(filter.FilteredItems.FilterType.ToString()); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //ColorFilter + + + + + + Specifies the type of filter. + + + The following code illustrates how to access the filter type. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C7"].CellStyleName = "CurrencyFormat"; + + //Apply colors + worksheet["A2:A3"].CellStyle.Color = System.Drawing.Color.Red; + worksheet["A4:A5"].CellStyle.Color = System.Drawing.Color.Blue; + worksheet["A6:A7"].CellStyle.Color = System.Drawing.Color.Green; + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[0]; + + //Check filter type + Console.WriteLine(filter.FilterType.ToString()); + + //Add filter + filter.AddColorFilter(System.Drawing.Color.Blue, ExcelColorFilterType.CellColor); + + //Check filter type + Console.WriteLine(filter.FilterType.ToString()); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //CustomFilter + //ColorFilter + + + + + + First condition of autofilter. + + + + + Second condition of autofilter. + + + + + Auto filter record. + + + + + Form control shape implementation. + + + + + Parent collection. + + + + + Type of filter used. + + + + + combination filter with collection of text filters. + + + + + Color Filter + + + + + Icon Filter + + + + + dynamic date filter + + + + + Holds the column index for which filtering is applied. + + + + + Name of the attribute that represents if filter shape should be visible. + + + + + Creates new instance. + + Parent filters collection. + + + + Creates new instance. + + Parent filters collection. + Column index. + Row index. + + + + Creates new instance. + + Parent filters collection. + Base record. + Column index. + Row index. + + + + Creates new instances of condition variables. + + + + + Disposes the AutoFilter. + + + + + Clears content of the autofilter (shape corresponding to autofilter). + + + + + Clone current instance. + + Parent object. + Returns just created object. + + + + To select the range in which the autofilter has to be applied + + + + + To set the top10 filter for filtering values based on IsTop and Top10Number + + + + + To filter values based upon the conditions according to condition operator, datatype and condition value + + Comparison operator + Data Type + Value may be double or string + + + + + To filter values based upon the conditions according to condition operator, condition value and type of the current range value + + Comparison operator + Value may be double or string + Worksheet + Range + isFirstCondition + Type may be double or DateTime or string + + + + To get the result of comparison between two objects based on the condition operator + + Value in the cell + Condition value + Comparison operator + + + + Returns an integer after comparing two objects based on the comparison type. Returns zero when the two values are equal, returns positive value when a is greater than b and returns negative value when a is less than b. + + Value in the cell + Condition value + Type of string comparison + + + + To show/hide rows based on the blanks. + + + + + To show/hide rows based on the non-blanks. + + + + + Apply text filter with the specified string collection. + + IEnumerable collection of string + + + + Add Color Filter with the specified System.Drawing.Color object + + Color to be filtered. + Filter type applied. + + Usage of Color Filter in two scenarios have been shown in the below code snippets. + + + The following code illustrates the filtering cells based on cell color + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("ColorFilter.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.AutoFilters.FilterRange = worksheet["A1:C30"]; + IAutoFilter filter = worksheet.AutoFilters[1]; + filter.AddColorFilter(ExcelColorFilterType.CellColor, System.Drawing.Color.Red); + workbook.SaveAs("FilteredbyColorFilter.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + The following code illustrates the filtering cells based on Font color + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("ColorFilter.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet.AutoFilters.FilterRange = worksheet["A1:C30"]; + IAutoFilter filter = worksheet.AutoFilters[1]; + filter.AddColorFilter(System.Drawing.Color.Red, ExcelColorFilterType.FontColor); + workbook.SaveAs("FilteredbyColorFilter.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Clears the applied color filter in the particular column + + + + + Apply Icon Filter with the specfied iconId for the Iconset applied. + + IconSetType to be filtered from. + IconId to be filtered. + + Usage of Icon Filter in has been shown in the below code snippet. + + + The following code illustrates applying icon filter based on the icon present in the cell. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("IconFilter.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + IConditionalFormats formats = worksheet["B1:B15"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + format.BackColorRGB = System.Drawing.Color.Red; + format.FormatType = ExcelCFType.IconSet; + format.IconSet.IconSet = ExcelIconSetType.ThreeArrows; + worksheet.AutoFilters.FilterRange = worksheet["A1:C30"]; + IAutoFilter filter = worksheet.AutoFilters[1]; + filter.AddIconFilter(ExcelIconSetType.ThreeArrows, 1); + workbook.SaveAs("FilteredBook.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Removes the IconFilter (If applied). + + + + + Removes Color Filter or Icon Filter from the current column when Called. + + + + + Apply text filter with the specified string. + + string value need to add in the text filter + + + + Remove text value in text filter with the specified string. + + String Value that have to remove from the Text filter. + Return true if the value is removed, else false. + + + + + Apply DateTime filter with the specified date time. + + year in the date time. + month in the date time. + day in the date time. + hour in the date time. + mintue in the date time. + Seconds in the date time. + With respective grouping type. + + + + Apply DateTime filter with the specified date time. + + Date with time which need to add. + Type of grouping. + + + + Remove specified date time from DateTime filter. + + year in the date time. + month in the date time. + day in the date time. + hour in the date time. + mintue in the date time. + Seconds in the date time. + With respective grouping type. + Return true if the value is removed, else false. + + + + Remove specified date time from DateTime filter. + + Datetime which need to remove. + With respective grouping type + Return true if the value is removed, else false. + + + + Apply dynamic date filter based on the specified relative date constant. + + Dynamic filer type. + + + + Remove dynamic date filter if exist. + + Return true if the value is removed, else false. + + + + Applying Text filter. + + + + + Initialize CalcEngine + + disableCalcEngine + + + + Applying DateTime filter. + + + + + Applying Dynamic Date filter. + + + + + Parses specified record. + + Record to parse. + Column index. + Row index. + + + + Saves autofilter as biff records. + + Records to be serialized. + + + + First condition of autofilter. Read-only. + + + + + Second condition of autofilter. Read-only. + + + + + Auto filter record. + + + + + False indicates that this autofilter was not used; otherwise True. + + + + + True means to use AND operation between conditions, + False to use OR. + + + + + Returns true if color filter is applied. + + + + + Returns true if Icon Filter is applied. + + + + + True if the Top 10 AutoFilter shows percentage; + False if it shows items. + + + + + True if the first condition is a simple equality. + + + + + True if the second condition is a simple equality. + + + + + True if the Top 10 AutoFilter shows the top items; + False if it shows the bottom items. + + + + + True if the condition is a Top 10 AutoFilter. + + + + + Number of elements to show in Top10 mode. + + + + + Specifies the type of filter. + + + + + Returns filter values for combination type ( Text and DateTime), dynamic and color type. It returns null, if custom filter is applied. Read-only. + + + + + Returns parent worksheet. Read-only. + + + + + Returns shapes collection of the parent worksheet. Read-only. + + + + + Number of AutoFilter drop-down arrows on the sheet. ( One based ) + + + + + If true - than contain non default first condition; otherwise false. Read-only. + + + + + If true - than contain non default second condition; otherwise false. Read-only. + + + + + If filtered to blanks - true. Read-only. + + + + + If filtered to nonblanks - true. Read-only. + + + + + Represents the border of an object. + + + + + Represents the border of an object. + + + + + Returns or sets a color of the border from enumeration. + + + The following code illustrates how to set a color from enumeration to the border. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Set borders + IBorders borders = worksheet["C2"].Borders; + + //Set border color + borders[ExcelBordersIndex.EdgeTop].Color = ExcelKnownColors.Red; + borders[ExcelBordersIndex.EdgeBottom].Color = ExcelKnownColors.Blue; + + //Set line style + borders[ExcelBordersIndex.EdgeTop].LineStyle = ExcelLineStyle.Thick; + borders[ExcelBordersIndex.EdgeBottom].LineStyle = ExcelLineStyle.Thick; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the primary color of the object. + + + The following code illustrates how to access ColorObject and set a color from to the border. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set borders + IBorders borders = worksheet["C2"].Borders; + + //Set color object + ColorObject colorObject = borders[ExcelBordersIndex.EdgeTop].ColorObject; + + //Set color + colorObject.SetIndexed(ExcelKnownColors.Red); + + //Set line style + borders.LineStyle = ExcelLineStyle.Thick; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Sets or gets the RGB color of the border from structure. + + + The following code illustrates how to set a RGB color from structure to the border. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Set borders + IBorders borders = worksheet["C2"].Borders; + + //Set border color + borders[ExcelBordersIndex.EdgeTop].ColorRGB = System.Drawing.Color.Red; + borders[ExcelBordersIndex.EdgeBottom].ColorRGB = System.Drawing.Color.Blue; + + //Set line style + borders[ExcelBordersIndex.EdgeTop].LineStyle = ExcelLineStyle.Thick; + borders[ExcelBordersIndex.EdgeBottom].LineStyle = ExcelLineStyle.Thick; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the line style for the border. Read/write ExcelLineStyle. + + + To know more about borders refer Apply Border Settings. + + + By default is set to so borders are not applied. Here for example, we set + to and borders. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Set borders + IBorders borders = worksheet["C2"].Borders; + + //Set border color + borders[ExcelBordersIndex.EdgeTop].Color = ExcelKnownColors.Red; + borders[ExcelBordersIndex.EdgeBottom].Color = ExcelKnownColors.Blue; + + //Set line style + borders[ExcelBordersIndex.EdgeTop].LineStyle = ExcelLineStyle.Thick; + borders[ExcelBordersIndex.EdgeBottom].LineStyle = ExcelLineStyle.Thick; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + This property is used only by Diagonal borders. For any other border + index property will have no influence. + + + The following code illustrates how to set visibility of the and borders. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["D2"].Text = "text"; + worksheet["C3"].Text = "in"; + worksheet["D3"].Text = "cell"; + + //Set borders + IBorders borders = worksheet["C2:D3"].Borders; + + //Set color + borders.Color = ExcelKnownColors.Red; + + //Set line style + borders.LineStyle = ExcelLineStyle.Thick; + + //Set diagonal line visibility + borders[ExcelBordersIndex.DiagonalDown].ShowDiagonalLine = false; + borders[ExcelBordersIndex.DiagonalUp].ShowDiagonalLine = false; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Maximum color index that requires modification in order to let MS Excel edit styles. + + + + + Increment for color value in order to let MS Excel edit styles. + + + + + Index of the border. + + + + + Extended format that contains this border. + + + + + Creates a class instance and sets its Application and Parent properties. + + Application object for the Border. + Parent object for the Border. + + + + Creates border with specified index. + + Application object for the border. + Parent object for the border. + Index of border that should be created. + + + + Creates border from ExtendedFormat with specified border index. + + Application object for the border. + Parent object for the border. + + ExtendedFormat that contains all information about required border. + + Border index of the 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. + + + + Serves as a hash function for a particular type, suitable for use + in hashing algorithms and data structures like a hash table. + + A hash code for the current object. + + + + Copies all fields from baseBorder except Parent. + + Border that will be copied. + + + + Normalizes border color to let MS Excel edit style. + + + + + Normalizes border color to let MS Excel edit style. + + Color to normalize. + New color value. + + + + Clone current object. + + New extended format. + Cloned border object. + + + + Returns or sets the primary color of the object, as shown in the + following table. Use the RGB function to create a color value. + Read/write Long. + + + + + Returns or sets the primary color of the object, as shown in the + following table. Use the RGB function to create a color value. + Read/write Long. + + + + + Returns or sets the primary color of the object, as shown in the + following table. Use the RGB function to create a color value. + Read/write Color. + + + + + Returns or sets the line style for the border. Read/write ExcelLineStyle. + + + + + This property is used only by Diagonal borders. For any other border + index property will have no influence. + + + + + Returns border index. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + This class represents border for multicell range. + + + + + Cells of the range. + + + + + Border index. + + + + + Parent workbook. + + + + + Creates wrapper for specified range and border index. + + Range for which this wrapper is created. + Border index. + + + + Creates wrapper for specified range and border index. + + Range for which this wrapper is created. + Border index. + + + + Returns or sets the primary color of the object. + Read/write ExcelKnownColors. + + + + + Returns or sets the primary color of the object, as shown in the + following table. Use the RGB function to create a color value. + + + + + Returns or sets the primary color of the object, as shown in the + following table. Use the RGB function to create a color value. + Read/write Long. + + + + + Returns or sets the line style for the border. Read/write ExcelLineStyle. + + + + + This property is used only by Diagonal borders. For any other border + index property will have no influence. + + + + + Worksheet calculation options block. + + + + + Represents the Calculation options in a Excel Workbook. + + + + + Specifies the maximum number of times the formulas should be iteratively calculated. + This is a fail-safe against mutually recursive formulas locking up + a spreadsheet application. + + + + + Defines whether to recalculate before saving. + + + + + Gets / sets maximum change of the result to the exit of an iteration. + + + + + Indicates whether iterations are turned on. + + + + + Indicates whether R1C1 reference mode is turned on. + + + + + Gets/sets calculation mode in Excel. + + + + + Correct records. + + + + + Specifies whether to calculate formulas manually, automatically, or automatically + except for multiple table operations. + + + + + Specifies the maximum number of times the formulas should be iteratively calculated. + This is a fail-safe against mutually recursive formulas locking up + a spreadsheet application. + + + + + Describes which reference mode to use. + + + + + Tells whether to iterate over formula calculations or not + (if a formula is dependent upon another formula's result) + (odd feature for something that can only have 32 elements in a formula). + + + + + Stores the maximum change of the result to the exit of an iteration. + + + + + Defines whether to recalculate before saving (set to 1). + + + + + Initializes new instance and sets application and parent fields. + + Application object for the page setup. + Parent object for the page setup. + + + + Recovers Page setup from the Biff Records array starting from position + + Application object for the page setup. + Parent object for the page setup. + Array of Biff Records that contains all needed records. + Position of PrintHeadersRecord in the array. + + + + Recovers Page setup from the Biff Records array starting from the position specified. + + Biff Records data. + Position of first PageSetup record - PrintHeadersRecord. + Position after extracting calculation options. + + + + Adds all records to OffsetArrayList. + + OffsetArrayList which will get all records. + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Specifies the maximum number of times the formulas should be iteratively calculated. + This is a fail-safe against mutually recursive formulas locking up + a spreadsheet application. + + + + + Specifies the mode of formula value calculations. + + + + + Defines whether to recalculate before saving. + + + + + Gets / sets maximum change of the result to the exit of an iteration. + + + + + Indicates whether iterations are turned on. + + + + + Indicates whether R1C1 reference mode is turned on. + + + + + Summary description for CellDataImpl. + + + + + Cell range. + + + + + Cell record. + + + + + Default constructor. + + + + + Cell range. + + + + + Cell record. + + + + + Summary description for CellStyle. + + + + + This class wraps extended format inside in order to hide from user + creation of new extended formats when user changes any properties + of extended format. + + + + + Extended format with style settings. + + + + + Parent workbook. + + + + + Font wrapper. + + + + + Borders collection. + + + + + Interior wrapper. + + + + + Creates new instance of extended format wrapper. + + + + + Creates new instance of extended format wrapper. + + Parent workbook. + Index of extended format to wrap. + + + + Sets solid fill pattern when changing + + + + + Creates inner extended format. + + Index to extended format to wrap. + + + + Updates inner extended format's font wrapper. + + + + + Searches for all necessary parent objects. + + Parent object. + + + + Sets Saved flag of the parent workbook to the False. + Called when any changes occurred in the style. + + + + + Event handler for font AfterChange event. + + Event sender. + Event arguments. + + + + Event handler for interior AfterChange event. + + Event sender. + Event arguments. + + + + This method is called after changes in NumberFormat. + + + + + + + + + + + + This method is called before reading any value. Can be used + to update wrapped object before read operation. + + + + + Gets style object either from parent or from this instance if it has no parent. + + Parent style object. + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Returns parent workbook. Read-only. + + + + + Gets / Sets fill pattern. + + + + + Gets format index in m_book.InnerFormats. + + + + + Gets / Sets index of fill background color. + + + + + Gets / Sets fill background color. + + + + + Gets / Sets index of fill foreground color. + + + + + Gets / Sets fill foreground color. + + + + + Gets / Sets format index. + + + + + Horizontal alignment. + + + + + True if the style includes the AddIndent, HorizontalAlignment, + VerticalAlignment, WrapText, and Orientation properties. + Read / write Boolean. + + + + + True if the style includes the Color, ColorIndex, LineStyle, + and Weight border properties. Read / write Boolean. + + + + + True if the style includes the Background, Bold, Color, + ColorIndex, FontStyle, Italic, Name, OutlineFont, Shadow, + Size, Strikethrough, Subscript, Superscript, and Underline + font properties. Read / write Boolean. + + + + + True if the style includes the NumberFormat property. + Read / write Boolean. + + + + + True if the style includes the Color, ColorIndex, + InvertIfNegative, Pattern, PatternColor, and PatternColorIndex + interior properties. Read / write Boolean. + + + + + True if the style includes the FormulaHidden and Locked protection + properties. Read / write Boolean. + + + + + Indent level. + + + + + True if formula is hidden. + + + + + True if cell is locked. + + + + + For far east languages. Supported only for format. Always 0 for US. + + + + + Returns or sets the format code for the object. Read / write String. + + + + + Returns or sets the format code for the object as a string in the + language of the user. Read / write String. + + + + + Returns object that describes number format. Read-only. + + + + + Text direction, the reading order for far east versions. + + + + + Text rotation angle: + 0 Not rotated + 1-90 1 to 90 degrees counterclockwise + 91-180 1 to 90 degrees clockwise + 255 Letters are stacked top-to-bottom, but not rotated. + + Thrown when value is more than 0xFF. + + + + True - shrink content to fit into cell. + + + + + Vertical alignment. + + + + + True - Text is wrapped at right border. + + + + + Returns font object for this extended format. + + + + + Returns borders object for this extended format. + + + + + If true then first symbol in cell is apostrophe. + + + + + Returns or sets the color of the interior pattern as an index into the current color palette. + + + + + Returns or sets the color of the interior pattern as an Color value. + + + + + Returns or sets the color of the interior. The color is specified as + an index value into the current color palette. + + + + + Returns or sets the cell shading color. + + + + + Returns interior object for this extended format. + + + + + Gets value indicating whether format was modified, compared to parent format. + + + + + Gets / Sets font index. + + + + + Returns wrapped format. + + + + + Gets or sets whether the extended format has border + + + + + Get/set BottomBorder color. + + + + + Get/set TopBorder color. + + + + + Get/set LeftBorder color. + + + + + Get/set RightBorder color. + + + + + Get/set DiagonalUpBorder color. + + + + + Gets / sets line style of the left border. + + + + + Gets / sets line style of the right border. + + + + + Gets / sets line style of the top border. + + + + + Gets / sets line style of the bottom border. + + + + + Gets / sets line style of the diagonal border. + + + + + Gets / sets line style of the diagonal border. + + + + + Indicates whether DiagonalUp line is visible. + + + + + Indicates whether DiagonalDown line is visible. + + + + + Event is raised after changes in number format. + + + + + Reference to Application which hosts all objects. Read-only. + + + + + Reference to Parent object. Read-only. + + + + + Indicates whether style is build in. Read-only. + + + + + Returns name of the style. Read-only. + + + + + Indicates whether style is initialized (differs from Normal style). + Read-only. + + + + + Parent range. + + + + + Represents whether to get adjacent or not + + + + + Creates new instance of cell style. + + Parent range. + + + + Creates new instance of cell style. + + Parent range. + Index of extended format to wrap. + + + + This method is called before changes in extended format. + + + + + This method is called after changes in extended format. + + + + + Searches for all necessary parent objects. + + Parent object. + + + + This method is called before reading any value. Can be used + to update wrapped object before read operation. + + + + + Gets line style of the left border. + + + + + + + Sets line style of the border. + Border + LineStyle + + + + + Gets line style of the right border. + + + + + + + Gets line style of the top border. + + + + + + + Get line style of the bottom border. + + + + + + + Gets the width of a border line style + + Border Line Style + Width of the line style + + + + Gets line color of the left border. + + + + + + + Gets line color of the right border. + + + + + + + Gets line color of the top border. + + + + + + + Get line color of the bottom border. + + + + + + + Gets left adjecent cell. + + + + + + Gets rigth adjecent cell. + + + + + + Gets top adjecent cell. + + + + + + Gets bottom adjecent cell. + + + + + + Gets relative cell. + + + + + + + + Get/set LeftBorder color. + + + + + Get/set RightBorder color. + + + + + Get/set TopBorder color. + + + + + Get/set BottomBorder color. + + + + + Gets / sets line style of the left border. + + + + + Gets / sets line style of the right border. + + + + + Gets / sets line style of the top border. + + + + + Gets / sets line style of the top border. + + + + + Gets or sets a boolean value + whether to get adjacent or not + + + + + Represents an axis on the chart. + + + + + Represents an axis on the chart. + + + + + Gets or sets number format for the axis values. + + + By default "General" set to . Here for example, we set currency format "$#,##0_);($#,##0)" to + to display value in the as currency. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10000"; + sheet.Range["B2"].Value = "20000"; + sheet.Range["C2"].Value = "30000"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart value axis + IChartAxis chartAxis = chart.PrimaryValueAxis; + + //Set number format + chartAxis.NumberFormat = @"$#,##0_);($#,##0)"; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the type of the axis. Read-only. + + + The following code illustrates how to access the property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10000"; + sheet.Range["B2"].Value = "20000"; + sheet.Range["C2"].Value = "30000"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart value axis + IChartAxis chartAxis = chart.PrimaryValueAxis; + + //Get axis type + Console.Write(chartAxis.AxisType); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + + + + + + Gets or sets the axis title. + + + The following code illustrates how to set for the . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set chart type + chart.ChartType = ExcelChartType.Pareto; + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart category axis + IChartAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set category title + categoryAxis.Title = "Categories"; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the axis text rotation angle. Should be an integer value between -90 and 90. + + + The following code illustrates how to set for . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set secondary axis + IChartAxis chartAxis = chart.PrimaryCategoryAxis; + + //Set text rotation angle + chartAxis.TextRotationAngle = 30; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the area for the axis title. Read-only. + + + The following code illustrates how to set foreground color to 's title area using + property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set chart type + chart.ChartType = ExcelChartType.Pareto; + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart category axis + IChartAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set category title + categoryAxis.Title = "Categories"; + + //Set title area + IChartTextArea titleArea = categoryAxis.TitleArea; + + //Set color + titleArea.FrameFormat.Fill.ForeColorIndex = ExcelKnownColors.Pale_blue; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the font used for axis text display. Read-only. + + + The following code illustrates how to set font color to the 's category labels using + property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart axis + IChartAxis chartAxis = chart.PrimaryCategoryAxis; + + //Set font color + chartAxis.Font.Color = ExcelKnownColors.Red; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the major grid lines for the axis. Read-only. + + + The following code illustrates how to access of and set colors to it. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart axis + IChartAxis chartAxis = chart.PrimaryCategoryAxis; + + //Set visibility + chartAxis.HasMajorGridLines = true; + + //Set grid lines + IChartGridLine gridLine = chartAxis.MajorGridLines; + gridLine.LineProperties.ColorIndex = ExcelKnownColors.Red; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the minor grid lines for the axis. Read-only. + + + The following code illustrates how to access of and set colors to it. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart axis + IChartAxis chartAxis = chart.PrimaryCategoryAxis; + + //Set visibility + chartAxis.HasMinorGridLines = true; + + //Set grid lines + IChartGridLine gridLine = chartAxis.MinorGridLines; + gridLine.LineProperties.ColorIndex = ExcelKnownColors.Red; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating if the axis has minor grid lines. + + + The following code illustrates how to set visibility of of . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart axis + IChartAxis chartAxis = chart.PrimaryCategoryAxis; + + //Set grid lines visibility + chartAxis.HasMinorGridLines = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + + Gets or sets a boolean value indicating if the axis has major grid lines. + + + The following code illustrates how to set visibility of of . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart axis + IChartAxis chartAxis = chart.PrimaryCategoryAxis; + + //Set grid lines visibility + chartAxis.HasMajorGridLines = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + + Gets or sets the type of minor tick mark for the axis. + + + By default is set to . Here for example, we set + to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart category axis + IChartAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set category minor tick type + categoryAxis.MinorTickMark = ExcelTickMark.TickMark_Cross; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the type of major tick mark for the axis. + + + By default is set to . Here for example, we set + to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart category axis + IChartAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set category major tick type + categoryAxis.MajorTickMark = ExcelTickMark.TickMark_Cross; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the chart border. Read-only. + + + The following code illustrates how to set color to 's border using property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set chart type + chart.ChartType = ExcelChartType.Pareto; + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart category axis + IChartAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set category title + categoryAxis.Title = "Categories"; + + //Set border + IChartBorder border = categoryAxis.Border; + + //Set color + border.ColorIndex = ExcelKnownColors.Red; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating whether or not the tick label spacing is automatic. + + + Using and we can alter the appearance. + + + By default property is set to "true" tick label spacing is set automatically. Here for example, we set + to "false". + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Line; + + //Set chart axis + IChartAxis chartAxis = chart.PrimaryCategoryAxis; + + //Set auto spacing + chartAxis.AutoTickLabelSpacing = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the position of tick-mark labels on the axis. + + + By default is set to . Here for example, we + set to property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart category axis + IChartAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set category tick labels position + categoryAxis.TickLabelPosition = ExcelTickLabelPosition.TickLabelPosition_High; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if the axis is visible. otherwise False. + + + The following code illustrates how to set visibility of . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "100"; + sheet.Range["B3"].Value = "200"; + sheet.Range["C3"].Value = "300"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart axis + IChartAxis chartAxis = chart.PrimaryCategoryAxis; + + //Set visibility + chartAxis.Visible = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the alignment for the tick label. + + + Used in older versions of Microsoft office. + + + + + True if data points are plotted from last to first. otherwise False. + + + This property is obsolete. Please use instead of it + + + + + Gets or sets a boolean value indicating whether to plot data points from last to first. + + + The following code illustrates how to plot the data points in reverse order. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "100"; + sheet.Range["B3"].Value = "200"; + sheet.Range["C3"].Value = "300"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart axis + IChartAxis chartAxis = chart.PrimaryCategoryAxis; + + //Set reverse plot order + chartAxis.ReversePlotOrder = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the shadow properties for the axis. Read-only. + + + The following code illustrates how to set , and by accessing + property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart category axis + IChartAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set category title + categoryAxis.Title = "Categories"; + + //Set shadow + IShadow shadow = categoryAxis.Shadow; + shadow.Size = 100; + shadow.Blur = 15; + + //Set color + shadow.ShadowColor = System.Drawing.Color.Red; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the 3D options for the chart. Read-only. + + + Used in older versions of Microsoft office. + + + + + Represents the default number format index. + + + + + Represents index to general format. + + + + + True if chart category label text wrapped, false as default. + + + + + Type of the axis. + + + + + True if this is the primary axis; false if secondary. + + + + + Text area for the axis title. + + + + + Chart tick record for this axis. + + + + + Represents Shadow + + + + + Indicates whether line format is present. + + + + + Represents the beginning of a collection of records + + + + + Represents the shape formatting properties for chart elements + + + + + Represents the end of a collection of records + + + + + Font used for axis drawing. + + + + + Font used to store the default font used with axis drawing. + + + + + Represents major grid. + + + + + Represents minor grid. + + + + + Represents if axis has major gridlines. + + + + + Represents if axis has minor gridlines. + + + + + Represents parent axis. + + + + + Represents format index. + + + + + Represents border axis. + + + + + Represents text direction. + + + + + Represents the text rotation. + + + + + Axis id. + + + + + Inidicates whether axis was deleted. + + + + + Indicates whether tick label spacing value is automatically evaluated. + + + + + Indicates whether TickMarkSpacing has automatic value. + + + + + Stores label alignment setting. + + + + + Represents the 3D features + + + + + Represents the TextArea Paragraph + + + + + Represents the frame format of Axis + + + + + Represents cross value of the axis + + + + + Initializes a new instance of class. + + Application object for the axis. + Parent object for the axis. + + + + Initializes a new instance of class with the specified primary axis type. + + Application object for the axis. + Parent object for the axis. + Type of the new axis. + + + + Initializes a new instance of class with + specified axis type and specified IsPrimary value. + + Application object for the axis. + Parent object for the axis. + Type of the new axis. + + True if primary axis should be created; False otherwise. + + + + + Initializes a new instance of class from array of BiffRecords + with primary axis data. + + Application object for the axis. + Parent object for the axis. + Array of BiffRecords with axis data. + + Position of the first axis record in the data array. + + + + + Initializes a new instance of class from array of BiffRecords + with axis data. + + Application object for the axis. + Parent object for the axis. + Array of BiffRecords with axis data. + + Position of the first axis record in the data array. + + + True if it is primary axis; False otherwise. + + + + + Finds parent objects. + + + + + Extracts the axis from array of BiffRecords. + + Array of BiffRecords with axis data. + + Position of the first axis record in the data array. + + + True if it is primary axis; False otherwise. + + + If specified record is not ChartAxis record + or next record is not Begin record. + + + + + Parses axis line format. + + Array of BiffRecords with axis data. + + Position of the ChartAxisLineFormat record in the data array. + + + + + Extracts extended font record data of the chart axis. + + Record to parse. + + + + Extracts chart walls or floor data. + + Record storage. + Position of the axis record in storage. + + + + Extracts chart format record data. + + Record to parse. + + + + Extracts axis data with specified array of Biff records. + + Represents record data. + Represents records storage. + Represents position in storage. + + + + Parses chart tick record. + + Represents chart tick record. + + + + Serializes axis records. + + OffsetArrayList that will receive all records. + + + + Serializes title of the axis. + + OffsetArrayList that will receive all records. + + + + Serializes the font records used in the chart axis. + + OffsetArrayList that will receive all records. + + + + Serializes the grid lines of chart axis. + + OffsetArrayList that will receive all records. + + + + Serializes the number format records for the axis values. + + Record storage. + + + + Serializes the axis border. + + Record storage. + + + + Serializes the tick record. + + Record storage. + + + + Sets some important variables to the initial state. + + + + + Initializes internal tick record. + + + + + Event handler for color change. + + + + + Sets the specified title area. + + Title area to set. + + + + Creates a copy of current instance with the specified dictionaries of font indexes and + worksheet names. + + Parent object. + Dictionary with new indexes. + Dictionary with new worksheet names. + Cloned object which is a copy of the current object. + + + + Creates a copy of current instance with the specified font wrapper object. + + Font object for the chart axis. + Cloned chart axis which is a copy of the current object. + + + + Sets the axis title. + + Title to set. + + + + Updates surface tick record. + + Represents tick label position value. + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Initializes frame format for the axis. + + + + + Creates frame format for the axis. + + Newly created frame format. + + + + Set the border on this object + + the input border + + + + Set default font and size + + + + + Gets and sets the boolean value to indicate whether the chart category label text is wrapped. False by default. + + + + + Gets the type of the axis. Read-only. + + + + + True if this is primary axis. False if secondary. + + + + + Represents Cross value of the axis + + + + + Gets or sets the axis title. + + + + + Gets or sets the axis text rotation angle. Should be an integer value between -90 and 90. + + + + + True if the axis text rotation angle is autoselected. False otherwise. + + + + + Gets the area for the axis title. Read-only. + + + + + Gets the font used for axis text display. Read-only. + + + + + Gets or Sets the value indicating whether the aixs font settings are applied from the chart default font settings. + + + + + Gets the major grid lines for the axis. Read-only. + + + + + Gets the minor grid lines for the axis. Read-only. + + + + + Gets or sets a boolean value indicating if the axis has minor grid lines. + + + + + Gets or sets a boolean value indicating if the axis has major grid lines. + + + + + True if the axis has numerical values. False otherwise. + + + + + Gets the chart parent axis. Read-only. + + + + + Gets or sets the number format index for the axis values. + + + + + Gets or sets number format for the axis values. + + + + + Gets or sets the type of minor tick mark for the axis. + + + + + Gets or sets the type of major tick mark for the axis. + + + + + Gets the chart border. Read-only. + + + + + Gets or sets the position of tick-mark labels on the axis. + + + + + True if the axis is visible. otherwise False. + + + + + Gets or sets the alignment for the tick label. + + + + + True if data points are plotted from last to first. otherwise False. + + + + + Gets or sets a boolean value indicating whether to plot data points from last to first. + + + + + Gets the axis identifier. + + + + + Gets the parent chart. Read-only. + + + + + Gets or sets a Boolean value indicating whether axis is deleted. + + + + + Gets or sets a boolean value indicating whether or not the tick label spacing is automatic. + + + + + Gets or sets a Boolean value indicating whether or not + the tick label spacing is automatic. Read/write Boolean. + + + + + Gets the shadow properties for the axis. Read-only. + + + + + Gets the shadow Properties. Read-only. + + + + + True if a shadow object is created. False otherwise. + + + + + Gets the 3D options for the chart. Read-only. + + + + + Gets the 3D properties for the chart. + + + + + True if a shadow object + (which includes the 3D properties) is created. + + + + + Gets the frame format of the axis. Read-only. + + + + + True if the axis has a title. False otherwise. + + + + + Gets or sets the paragraph type for the text area paragraph. + + + + + Represents the Default Text Settings + + + + + Gets the text link type for the title area. Read-only. + + + + + Gets the parent workbook. Read-only. + + + + + Represents chart border. + + + + + Represents chart border. Provides Border options for Chart Area and Plot Area. + + + + + Gets or sets the border line color. + + + To know more about charts refer this link. + + The following code illustrates the use of LineColor property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Set line color for chart area border + chart.ChartArea.Border.LineColor = System.Drawing.Color.DarkOrange; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the border line pattern. + + + To know more about charts refer this link. + + The following code illustrates the use of LinePattern property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Set line pattern for plot area border + chart.ChartArea.Border.LinePattern = ExcelChartLinePattern.DashDotDot; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the border line weight. + + + To know more about charts refer this link. + + The following code illustrates the use of LineWeight property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Set line weight for plot area border + chart.ChartArea.Border.LineWeight = ExcelChartLineWeight.Narrow; + chart.ChartArea.Border.LineColor = System.Drawing.Color.DarkOrange; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating if the border has default or custom format. + + + To know more about charts refer this link. + + The following code illustrates the use of AutoFormat property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //True to enable the autoFormat for border + chart.ChartArea.Border.AutoFormat = true; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + True for default border line color as in . otherwise False. + + + To know more about charts refer this link. + + The following code illustrates the use of IsAutoLineColor property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //True to enable default border colour for plot area + chart.ChartArea.Border.IsAutoLineColor = true; + chart.ChartArea.Border.LinePattern = ExcelChartLinePattern.DashDotDot; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the index of the border color in . + + + To know more about charts refer this link. + + The following code illustrates the use of ColorIndex property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Sets the index border colour for plot area + chart.ChartArea.Border.ColorIndex = ExcelKnownColors.Red; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + True to draw tick labels on this axis. otherwise False. + + + To know more about charts refer this link. + + The following code illustrates the use of DrawTickLabels property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //True to draw tick labels on this axis + chart.PrimaryValueAxis.Border.DrawTickLabels = false; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the transparency level of the solid color shaded fill as a floating-point + value from 0.0 (Clear) through 1.0 (Opaque). + + + To know more about charts refer this link. + + The following code illustrates the use of Transparency property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the transparency level of the solid color + chart.ChartArea.Border.Transparency =0.75; + chart.ChartArea.Border.ColorIndex = ExcelKnownColors.Red; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the border line weight as number. Set -1 for Hairline, 0 for Narrow, 1 for Medium, 2 for Wide. + + + To know more about charts refer this link. + + The following code illustrates the use of Weight property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Set line weight for plot area border + chart.ChartArea.Border.Weight = 7.5; + chart.ChartArea.Border.LineColor = System.Drawing.Color.DarkOrange; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Represents chart border. + + + + + Line format. + + + + + Represents parent workbook. + + + + + Represents parent Series format. + + + + + Represents line color. + + + + + Indicates the cap styles of the line + + + + + Represents the default transparency level for the solid type + + + + + Preserve Gradient Stops (Supported in Excel 2007 and higher) + + + + + border edge join type + + + + + Represents whether the color is inverted. false by default + + + + + Gets or sets the border line weight as number. + + + + + Represents whether the chart border line color is changed or not. + + + + + Represents the begin arrow style. + + + + + Represents the end arrow style. + + + + + Represents the begin arrow size. + + + + + Represents the end arrow size. + + + + + Represents the begin arrow length. + + + + + Represents the end arrow length. + + + + + Represents the begin Arrow Width. + + + + + Represents the end arrow width. + + + + + Initializes a new instance of class. + + Represents current application. + Represents parent object. + + + + Initializes a new instance of class with the specified line format record. + + Represents current application. + Represents parent object. + Represents line record. + + + + Initializes a new instance of class with the specified Biff records. + + Represents current application. + Represents parent object. + Represents record storage. + Represents position in storage. + + + + Extracts chart border data from the specified Biff records. + + List of Biff records. + Position in offset. + + + + Serializes the chart border records. + + Records offset. + + + + Finds parent objects. + + + + + Updates internal record for Excel97 file format. + + + + + Creates a copy of current instance. + + Represents parent object. + Returns cloned object. + + + + Check whether the serie Format is available, if it update auto color + Only to be called on auto format is false + + + + + Makes complete copy of the current object and updates its parent. + + Parent object to set. + Cloned object. + + + + Indicates the cap styles of the line + + + + + Gets or sets the border line color. + + + + + Gets or sets the border line pattern. + + + + + Gets or sets the border line weight. + + + + + Gets or sets the border line weight as number. + + + + + preserve fill and gradient stops (Supported in Excel 2007 and higher) + + + + + indicates whether the line filled with gradient fill + + + + + True if the RGB color values are inverted in the binary records else returns false. + + + + + Represents whether the chart border line color is changed or not. + + + + + Border edge join type + + + + + Gets or sets a boolean value indicating if the border has default or custom format. + + + + + True to draw tick labels on this axis. otherwise False. + + + + + True for default border line color as in . otherwise False. + + + + + Gets or sets the index of the border color in . + + + + + Gets the border color. Read-only. + + + + + Gets or sets the transparency level of the solid color shaded fill as a floating-point + value from 0.0 (Clear) through 1.0 (Opaque). + + + + + Gets or sets the line weight string. + + The line weight string. + + + + Gets or sets the series begin arrow type + + + + + Gets or sets the series end arrow type. + + + + + Gets or sets the series begin arrow size. + + + + + Gets or sets the series end arrow size. + + + + + Represents category axis of the chart. + + + + + Class used for Chart Value Axis implementation. + + + + + Represents the chart value axis. + + + + + Minimum value on axis. + + + The following code illustrates how to set and for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart value axis + IChartValueAxis valueAxis = chart.PrimaryValueAxis; + + //Set minimum and maximum value + valueAxis.MinimumValue = -20; + valueAxis.MaximumValue = 60; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Maximum value on axis. + + + The following code illustrates how to set and for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart value axis + IChartValueAxis valueAxis = chart.PrimaryValueAxis; + + //Set minimum and maximum value + valueAxis.MinimumValue = -20; + valueAxis.MaximumValue = 60; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Value of major increment. + + + The following code illustrates how to set major axis increment unit for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart value axis + IChartValueAxis valueAxis = chart.PrimaryValueAxis; + + //Set major unit + valueAxis.MajorUnit = 20; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Value of minor increment. + + + The following code illustrates how to set minor axis increment unit for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart value axis + IChartValueAxis valueAxis = chart.PrimaryValueAxis; + + //Set minor unit + valueAxis.MinorUnit = 8; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Represents the point on the axis another axis crosses it. + + + This property is obsolete. Please use instead of it + + + + + Represents the point on the axis another axis crosses it. + + + The following code illustrates how to set for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart value axis + IChartValueAxis valueAxis = chart.PrimaryValueAxis; + + //Set cross at + valueAxis.CrossesAt = 15; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Automatic minimum selected. + + + The following code illustrates how to access . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart value axis + IChartValueAxis valueAxis = chart.PrimaryValueAxis; + + //Check auto min + Console.Write(valueAxis.IsAutoMin); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + + + + + + Automatic maximum selected. + + + The following code illustrates how to access . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart value axis + IChartValueAxis valueAxis = chart.PrimaryValueAxis; + + //Check auto max + Console.Write(valueAxis.IsAutoMax); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + + + + + + Automatic major selected. + + + The following code illustrates how to access . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart value axis + IChartValueAxis valueAxis = chart.PrimaryValueAxis; + + //Check auto major and minor + Console.WriteLine(valueAxis.IsAutoMajor); + Console.WriteLine(valueAxis.IsAutoMinor); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + //True + + + + + + Automatic minor selected. + + + The following code illustrates how to access . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart value axis + IChartValueAxis valueAxis = chart.PrimaryValueAxis; + + //Check auto major and minor + Console.WriteLine(valueAxis.IsAutoMajor); + Console.WriteLine(valueAxis.IsAutoMinor); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + //True + + + + + + Automatic category crossing point selected. + + + The following code illustrates how to access . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart value axis + IChartValueAxis valueAxis = chart.PrimaryValueAxis; + + //Set cross at + valueAxis.CrossesAt = 15; + + //Check auto cross + Console.Write(valueAxis.IsAutoCross); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //False + + + + + + Logarithmic scale. + + + The following code illustrates how to set for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart value axis + IChartValueAxis valueAxis = chart.PrimaryValueAxis; + + //Set IsLogScale + valueAxis.IsLogScale = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the base of the logarithm when you are using log scales. The default value is 10. + + + The following code illustrates how to set for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart value axis + IChartValueAxis valueAxis = chart.PrimaryValueAxis; + + //Set IsLogScale and log base + valueAxis.IsLogScale = true; + valueAxis.LogBase = 2; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Category axis to cross at maximum value. + + + The following code illustrates how to access . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart value axis + IChartValueAxis valueAxis = chart.PrimaryValueAxis; + + //Set IsMaxCross + valueAxis.IsMaxCross = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Represents custom unit to display. + + + The following code illustrates how to set custom units for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart value axis + IChartValueAxis valueAxis = chart.PrimaryValueAxis; + + //Set display unit + valueAxis.DisplayUnit = ExcelChartDisplayUnit.Custom; + + //Set display unit + valueAxis.DisplayUnitCustom = 5; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the unit label for the specified axis. + + + By default the value axis displays no unit labels since is set to by default. + Here for example, we set to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10000"; + sheet.Range["B2"].Value = "20000"; + sheet.Range["C2"].Value = "30000"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart value axis + IChartValueAxis valueAxis = chart.PrimaryValueAxis; + + //Set display unit + valueAxis.DisplayUnit = ExcelChartDisplayUnit.Hundreds; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if the label is displayed on the specified axis. + + + By default is set to so display unit label will not be shown. Here for example, + we set to property so the display unit label will be visible. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10000"; + sheet.Range["B2"].Value = "20000"; + sheet.Range["C2"].Value = "30000"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart value axis + IChartValueAxis valueAxis = chart.PrimaryValueAxis; + + //Set display unit + valueAxis.DisplayUnit = ExcelChartDisplayUnit.Hundreds; + + //Check display unit label + Console.Write(valueAxis.HasDisplayUnitLabel); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + + + + + + Returns the DisplayUnitLabel object for the specified axis. + Returns Null if the HasDisplayUnitLabel property is set to False. Read-only. + + + The following code illustrates how to set fill foreground color to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10000"; + sheet.Range["B2"].Value = "20000"; + sheet.Range["C2"].Value = "30000"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart value axis + IChartValueAxis valueAxis = chart.PrimaryValueAxis; + + //Set display unit + valueAxis.DisplayUnit = ExcelChartDisplayUnit.Hundreds; + + //Set Display unit label + IChartTextArea unitLabel = valueAxis.DisplayUnitLabel; + + //Set label color + unitLabel.FrameFormat.Fill.ForeColorIndex = ExcelKnownColors.Pale_blue; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Represents logarithmic scale. + + + + + Indicates whether datapoint plot from last to first. + + + + + Represents maximum value. + + + + + Represents minimum value. + + + + + Represents the log base + + + + + Represents array of display units values. + Index - display units index, value - double value. + + + + + Indicates is has display unit label. + + + + + Chart value record. + + + + + Represents log base. Default value is 10. + + + + + Represents custom unit to display. + + + + + Represents display unit. + + + + + Represents display Unit label. + + + + + Indicates whether tick label spacing value is automatically evaluated. + + + + + Represents the indicate whether the chart axis auto cross value change or not. + + + + + Represents the indicate whether the chart axis auto cross value change or not in loading. + + + + + Creates axis object. + + Application object for the axis. + Parent object for the axis. + + + + Creates primary axis of specified type. + + Application object for the axis. + Parent object for the axis. + Type of the new axis. + + + + Creates axis of specified type and specified IsPrimary value. + + Application object for the axis. + Parent object for the axis. + Type of the new axis. + + True if primary axis should be created; otherwise False. + + + + + Extracts primary axis from the array of BiffRecords. + + Application object for the axis. + Parent object for the axis. + Array of BiffRecords with axis data. + + Position of the first axis record in the data array. + + + + + Extracts axis from the array of BiffRecords. + + Application object for the axis. + Parent object for the axis. + Array of BiffRecords with axis data. + + Position of the first axis record in the data array. + + + True if it is primary axis; otherwise False. + + + + + Automatic Minimum + + + + + + + Automatic Maximum + + + + + + + Parses max cross. + + Represents max cross data to parse. + + + + Parses walls or floor. + + Record storage. + Position in storage. + + + + Parses data. + + Represents current record to parse. + Represents records storage. + Represents position in storage. + + + + Parses display unit record. + + Represents record to parse. + + + + Parses display unit label. + + Record storage. + Position in storage. + + + + Serializes axis. + + OffsetArrayList that will receive all records. + + + + Serializes axis. + + OffsetArrayList that will receive all records. + Represents axis type. + + + + Serializes walls or floor. + + Record storage. + + + + Serialize display units. + + Represents records storage. + + + + Initializes internal variables. + + + + + Checks if everything is ok with ChartValueRangeRecord. + + True if check succeeded. + + + + Checks if everything is ok with ChartValueRangeRecord. + + Indicates whether we should throw an exception in the case of check failed. + True if check succeeded. + + + + Clone current object. + + Parent object. + Dictionary with new indexes. + Dictionary with new worksheet names. + Returns cloned object. + + + + Creates display unit label. + + + + + Sets major unit. + + + + + + Sets minor unit. + + + + + + Maximum value on axis. + + + + + Maximum value on axis. + + + + + Value of major increment. + + + + + Value of minor increment. + + + + + Represents the point on the axis another axis crosses it. + + + + + Represents the point on the axis another axis crosses it. + + + + + Automatic minimum selected. + + + + + Automatic maximum selected. + + + + + Represents whether the label spacing is automatic or not + + + + + Automatic major selected. + + + + + Automatic minor selected. + + + + + Automatic category crossing point selected. + + + + + Get or set the indicates whether the chart axis auto cross value change or not. + + + + + Get or set the indicates whether the chart axis auto cross value change or not in loading. + + + + + Logarithmic scale. + + + + + Returns or sets the base of the logarithm when you are using log scales. The default value is 10. + + + + + True if plots data points from last to first. + + + + + Category axis to cross at maximum value. + + + + + Gets or sets the ChartValueRangeRecord. + + + + + Represents custom unit to display. + + + + + Returns or sets the unit label for the specified axis. + + + + + True if the label is displayed on the specified axis. + + + + + Returns the DisplayUnitLabel object for the specified axis. + Returns Null if the HasDisplayUnitLabel property is set to False. Read-only. + + + + + Gets text link for this axis. + + + + + Represents category axis of the chart. + + + + + Gets or sets the number of categories or series between tick-mark labels. + + + This property is obsolete. Please use instead of it + + + + + Gets or sets the number of categories or series between tick-mark labels. + Applies only to category and series axes. Can be a value from 1 through 31999. + + + The following code illustrates how to set for chart axis. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["D1"].Text = "Apr"; + sheet.Range["E1"].Text = "May"; + sheet.Range["F1"].Text = "Jun"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["D2"].Value = "30"; + sheet.Range["E2"].Value = "20"; + sheet.Range["F2"].Value = "10"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:F2"]; + + //Set chart category axis + IChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set tick label spacing + categoryAxis.TickLabelSpacing = 2; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets whether or not the tick label spacing is automatic. + + + The following code illustrates how to access property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["D1"].Text = "Apr"; + sheet.Range["E1"].Text = "May"; + sheet.Range["F1"].Text = "Jun"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["D2"].Value = "30"; + sheet.Range["E2"].Value = "20"; + sheet.Range["F2"].Value = "10"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:F2"]; + + //Set chart category axis + IChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set tick label spacing + categoryAxis.TickLabelSpacing = 2; + + //Check auto spacing + Console.Write(categoryAxis.AutoTickLabelSpacing); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //False + + + + + + Gets or sets the number of categories or series between tick marks. + + + This property is obsolete. Please use instead of it + + + + + Gets or sets the number of categories or series between tick marks. + Applies only to category and series axes. Can be a value from 1 through 31999. + + + The following code illustrates how to set for chart axis. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["D1"].Text = "Apr"; + sheet.Range["E1"].Text = "May"; + sheet.Range["F1"].Text = "Jun"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["D2"].Value = "30"; + sheet.Range["E2"].Value = "20"; + sheet.Range["F2"].Value = "10"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:F2"]; + + //Set chart category axis + IChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set tick mark spacing + categoryAxis.TickMarkSpacing = 2; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True to cut unused plot area. otherwise False. Default for area and surface charts. + + + By default is set to "true" so chart serie will be plotted in between the tick marks. Here for example, we set + to "false" so that chart serie would be plotted on the tick marks. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart category axis + IChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set category axis IsBetween + categoryAxis.IsBetween = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the category labels for the chart. + + + The following code illustrates how to access the category labels range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart category axis + IChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Get category label range + Console.WriteLine(categoryAxis.CategoryLabels.AddressLocal); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //A1:C1 + + + + + + Gets or sets the directly entered category labels for the chart. + + + The following code illustrates how to set category labels directly for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart category axis + IChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set category labels directly + categoryAxis.EnteredDirectlyCategoryLabels = new object[] { "Oct", "Nov", "Dec" }; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the category type. + + + By default is set to . Here for example, we set + to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].DateTime = new System.DateTime(2017, 3, 15); + sheet.Range["B1"].DateTime = new System.DateTime(2017, 9, 17); + sheet.Range["C1"].DateTime = new System.DateTime(2017, 5, 2); + sheet.Range["D1"].DateTime = new System.DateTime(2016, 5, 2); + sheet.Range["E1"].DateTime = new System.DateTime(2015, 5, 2); + sheet.Range["F1"].DateTime = new System.DateTime(2011, 5, 2); + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["D2"].Value = "30"; + sheet.Range["E2"].Value = "20"; + sheet.Range["F2"].Value = "10"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:F2"]; + + //Set chart category axis + IChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set category type + categoryAxis.CategoryType = ExcelCategoryType.Time; + + //Set base unit + categoryAxis.BaseUnit = ExcelChartBaseUnit.Year; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the distance between the labels and the axis line. + The value can be from 0 through 1000. + + + By default the category labels are separated by a distance of "100" from the . Here for example, we set "350" + to to increase the distance to "350" from "100". + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart category axis + IChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set category axis Offset + categoryAxis.Offset = 350; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the base unit for the . + + Setting this property has no visible effect if the property + for the specified axis is set to . The set value is retained, however, and + takes effect when the property is set to . + + The following code illustrates how to set for . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].DateTime = new System.DateTime(2017, 3, 15); + sheet.Range["B1"].DateTime = new System.DateTime(2017, 9, 17); + sheet.Range["C1"].DateTime = new System.DateTime(2017, 5, 2); + sheet.Range["D1"].DateTime = new System.DateTime(2016, 5, 2); + sheet.Range["E1"].DateTime = new System.DateTime(2015, 5, 2); + sheet.Range["F1"].DateTime = new System.DateTime(2011, 5, 2); + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["D2"].Value = "30"; + sheet.Range["E2"].Value = "20"; + sheet.Range["F2"].Value = "10"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:F2"]; + + //Set chart category axis + IChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set category type + categoryAxis.CategoryType = ExcelCategoryType.Time; + + //Set base unit + categoryAxis.BaseUnit = ExcelChartBaseUnit.Year; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True to use automatic base units for the specified category axis. otherwise False. + + + The following code illustrates how to access property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].DateTime = new System.DateTime(2017, 3, 15); + sheet.Range["B1"].DateTime = new System.DateTime(2017, 9, 17); + sheet.Range["C1"].DateTime = new System.DateTime(2017, 5, 2); + sheet.Range["D1"].DateTime = new System.DateTime(2016, 5, 2); + sheet.Range["E1"].DateTime = new System.DateTime(2015, 5, 2); + sheet.Range["F1"].DateTime = new System.DateTime(2011, 5, 2); + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["D2"].Value = "30"; + sheet.Range["E2"].Value = "20"; + sheet.Range["F2"].Value = "10"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:F2"]; + + //Set chart category axis + IChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set category type + categoryAxis.CategoryType = ExcelCategoryType.Time; + + //Set base unit + categoryAxis.BaseUnit = ExcelChartBaseUnit.Year; + + //Check base unit auto or not + Console.Write(categoryAxis.BaseUnitIsAuto); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //False + + + + + + Gets or sets the major unit scale value for the when the of the axis is set to . + + + The following code illustrates how to set major unit scale value for . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].DateTime = new System.DateTime(2017, 3, 15); + sheet.Range["B1"].DateTime = new System.DateTime(2017, 9, 17); + sheet.Range["C1"].DateTime = new System.DateTime(2017, 5, 2); + sheet.Range["D1"].DateTime = new System.DateTime(2016, 5, 2); + sheet.Range["E1"].DateTime = new System.DateTime(2015, 5, 2); + sheet.Range["F1"].DateTime = new System.DateTime(2015, 5, 7); + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["D2"].Value = "30"; + sheet.Range["E2"].Value = "20"; + sheet.Range["F2"].Value = "10"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:F2"]; + + //Set chart category axis + IChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set category type + categoryAxis.CategoryType = ExcelCategoryType.Time; + + //Set major and minor units + categoryAxis.MajorUnitScale = ExcelChartBaseUnit.Year; + categoryAxis.MinorUnitScale = ExcelChartBaseUnit.Month; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the minor unit scale value for the when the of the axis is set to . + + + The following code illustrates how to set minor unit scale value for . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].DateTime = new System.DateTime(2017, 3, 15); + sheet.Range["B1"].DateTime = new System.DateTime(2017, 9, 17); + sheet.Range["C1"].DateTime = new System.DateTime(2017, 5, 2); + sheet.Range["D1"].DateTime = new System.DateTime(2016, 5, 2); + sheet.Range["E1"].DateTime = new System.DateTime(2015, 5, 2); + sheet.Range["F1"].DateTime = new System.DateTime(2015, 5, 7); + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["D2"].Value = "30"; + sheet.Range["E2"].Value = "20"; + sheet.Range["F2"].Value = "10"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:F2"]; + + //Set chart category axis + IChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set category type + categoryAxis.CategoryType = ExcelCategoryType.Time; + + //Set major and minor units + categoryAxis.MajorUnitScale = ExcelChartBaseUnit.Year; + categoryAxis.MinorUnitScale = ExcelChartBaseUnit.Month; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if multi-Level category axis is not allowed. otherwise False. + + + By default + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Text = "Apr"; + sheet.Range["B2"].Text = "May"; + sheet.Range["C2"].Text = "Jun"; + + sheet.Range["A4"].Value = "10"; + sheet.Range["B4"].Value = "20"; + sheet.Range["C4"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "10"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C4"]; + + //Set chart type + chart.ChartType = ExcelChartType.Line; + + //Set NoMultiLevelLabel + chart.PrimaryCategoryAxis.NoMultiLevelLabel = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if bins generated by category values. otherwise False + + Applies only to and charts. + + By default is set to "true" so chart serie are grouped based on category labels. Here for example, we set "false" + to so that chart serie would be grouped automatically. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set chart type + chart.ChartType = ExcelChartType.Pareto; + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart category axis + IChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set bins to automatic + categoryAxis.IsBinningByCategory = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if bins generated are automatic. otherwise False + + Applies only to and charts. + + By default is set to "false" so grouping will be done based on the categories in the . + Here for example, we set to "true" so that chart serie would be grouped automatically. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set chart type + chart.ChartType = ExcelChartType.Pareto; + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart category axis + IChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set bins to automatic + categoryAxis.HasAutomaticBins = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets / Sets the Number of Bins in the axis + + Applies only to and charts. + + The following code illustrates how to set number of bins in the chart axis for and + charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set chart type + chart.ChartType = ExcelChartType.Pareto; + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart category axis + IChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set category axis bins + categoryAxis.NumberOfBins = 2; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Get or Set the number of data points in each range. + + Applies only to and charts. + + The following code illustrates how to set the grouping width for and charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set chart type + chart.ChartType = ExcelChartType.Pareto; + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart category axis + IChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set category axis bin width + categoryAxis.BinWidth = 7; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Get or Set the UnderFlow Bin value + + Applies only to and charts. + + The following code illustrates how to set for and + charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set chart type + chart.ChartType = ExcelChartType.Pareto; + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart category axis + IChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set bin to automatic + categoryAxis.HasAutomaticBins = true; + + //Set bin underflow + categoryAxis.UnderflowBinValue = 12; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Get or Set the OverFlow Bin value + + Applies only to and charts. + + The following code illustrates how to set for and + charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set chart type + chart.ChartType = ExcelChartType.Pareto; + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart category axis + IChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set bin to automatic + categoryAxis.HasAutomaticBins = true; + + //Set bin overflow + categoryAxis.OverflowBinValue = 25; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Error message for not supported property. + + + + + Represents default offset. + + + + + Represents month count. + + + + + Represents the XmlTkValue of multilevel label is enabled in binary file + + + + + Represents the XmlTkValue of automatic tick label is enabled in binary file + + + + + Represents min axis data. + + + + + ChartCatserRangeRecord that describes this axis. + + + + + UnknownRecord that describes label intervals of this axis. + + + + + Represents time scale data. + + + + + Represents category axis type. + + + + + Represents default axis offset. + + + + + Indicates whether tick label spacing value is automatically evaluated. + + + + + Indicates whether multi level label is allowed or not + + + + + Represents to serialize NoMultiLvlLbl attribute or not + + + + + Represents to serialize majorUnitScale is Auto + + + + + Represents to serialize minorUnitScale is Auto + + + + + boolean value used for tick label spacing + + + + + boolean value used for ChartAxisOffsetRecord + + + + + Object that holds the information required for Histogram series + + + + + Represents the date time axis value change or not + + + + + Initializes a new instance of class with the specified + application and parent objects. + + Application object for the axis. + Parent object for the axis. + + + + Initializes a new instance of class + of specified primary axis type. + + Application object for the axis. + Parent object for the axis. + Type of the new axis. + + + + Initializes a new instance of class + of specified type and specified IsPrimary value. + + Application object for the axis. + Parent object for the axis. + Type of the new axis. + + True if primary axis should be created; False otherwise. + + + + + Initializes a new instance of class + with primary axis extracted from array of BiffRecords. + + Application object for the axis. + Parent object for the axis. + Array of BiffRecords with axis data. + + Position of the first axis record in the data array. + + + + + Initializes a new instance of class + with the axis extracted from array of BiffRecords. + + Application object for the axis. + Parent object for the axis. + Array of BiffRecords with axis data. + + Position of the first axis record in the data array. + + + True if it is primary axis; False otherwise. + + + + + Parses data of the specified record. + + Represents record to parse. + Represents records storage. + Represents position in storage. + + + + Parses max cross from the specified record. + + Represents max cross data to parse. + + + + Parses walls or floor from the specified list of + Binary Interchanged File Formats (BIFF) records and the offset. + + Record storage. + Position in storage. + + + + Parses category axis type. + + Represents record for parsing. + + + + Serializes the axis record. + + OffsetArrayList that will receive all records. + + + + Serializes primary standard category axis. + + OffsetArrayList that will receive all records. + + + + Serializes walls or floor of the axis. + + Record storage. + + + + Serialize category axis type. + + Represents record storage. + + + + Initializes internal variables. + + + + + Checks for error free ChartValueRangeRecord. + + Indicates whether we should throw an exception in the case of check failed. + True if check succeeded. + + + + Creates a copy of current instance with the specified parent object, + Font indexes and worksheet names dictionary. + + Parent object. + Dictionary with new indexes. + Dictionary with new worksheet names. + Returns the cloned object. + + + + Gets start chart type only for series type. + + Returns start chart type. + + + + Checks for time scale axis mode. Otherwise rise exception. + + + + + Check the CrtmlFrt record whether it have automatic tick labels and multilevel labels + + input record files to be checked + the boolean value indicates it have automatic tick labels and no multilevel labels + + + + Swap the values from category axis properties + + + + + True if the value axis crosses at the far right category (in a line, bar, + column, scatter, or area chart; 2D charts only). + + + + + Gets or sets the point on the value axis where the category axis crosses it. + Applies only to the value axis. + + + + + Represents the date time axis value change or not + + + + + Represents whether the label spacing is present or not + + + + + Gets or sets whether or not the tick label spacing is automatic. + + + + + Gets or sets the number of categories or series between tick-mark labels. + + + + + Gets or sets the number of categories or series between tick-mark labels. + Applies only to category and series axes. Can be a value from 1 through 31999. + + + + + Gets or sets the number of categories or series between tick marks. + + + + + Gets or sets the number of categories or series between tick marks. + Applies only to category and series axes. Can be a value from 1 through 31999. + + + + + Creates title area. Read-only. + + + + + True to cut unused plot area. otherwise False. Default for area and surface charts. + + + + + True if plots data points from last to first. + + + + + Gets or sets the category labels for the chart. + + + + + Gets or sets the directly entered category labels for the chart. + + + + + Gets or sets the . + + + + + Gets or sets the distance between the labels and the axis line. + The value can be from 0 through 1000. + + + + + Gets or sets the base unit for the category axis. + + Setting this property has no visible effect if the property + for the specified axis is set to Category. The set value is retained, however, and + takes effect when the property is set to Time. + + + + True to use automatic base units for the specified category axis. otherwise False. + + + + + True if use automatic major units for the specified category axis. + + + + + True if use automatic major units for the specified category axis. + + + + + Automatic major selected. + + + + + Automatic minor selected. + + + + + Automatic category crossing point selected. + + + + + Automatic maximum selected. + + + + + Automatic minimum selected. + + + + + Gets or sets the major units for the value axis. + + + + + Value of minor increment. + + + + + Gets or sets the major unit scale value for the category axis + when the of the axis is set to Time. + + + + + Gets or sets the minor unit scale value for the category axis + when the of the axis is set to TimeScale. + + + + + True if multi-Level category axis is not allowed. otherwise False. + + + + + True if bins generated by category values. otherwise False + + Applies only to Histogram and Pareto charts. + + + + True if bins generated are automatic. otherwise False + + Applies only to Histogram and Pareto charts. + + + + Get or set the Number of Bins in the axis + + Applies only to Histogram and Pareto charts.Can be a value from 1 through 31999. + + + + Get or Set the number of data points in each range. + + Applies only to Histogram and Pareto charts. + + + + Get or Set the UnderFlow Bin value + + Applies only to Histogram and Pareto charts. + + + + Get or Set the OverFlow Bin value + + Applies only to Histogram and Pareto charts. + + + + returns an Object that holds the information required for Histogram series + + + + + Returns ChartCatserRangeRecord record. Read-only. + + + + + Indicates is chart bubble or scatter. Using series start type. + + + + + Indicates is category axis type is category. Read-only. + + + + + Represents a collection of chart data labels. + + + + + Represents a collection of chart data labels. + + + + + Represents the Text Area in a chart. + + + + + Contains the font attributes (font name, font size, + color and so on) for an object. + + + + + Generates .Net font object corresponding to the current font. + + Generated .Net font. + + The following code illustrates how .Net font object can be generated using GenerateNativeFont() method. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set font + IFont font = style.Font; + + //Set color + font.Color = ExcelKnownColors.Red; + + //Generate font + System.Drawing.Font nativeFont = font.GenerateNativeFont(); + + //Get native font name + Console.Write(nativeFont.Name); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //Calibri + + + + + + True if the font is bold. Read / write Boolean. + + + The following code illustrates how to set Bold property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set font + IFont font = style.Font; + + //Set bold + font.Bold = true; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the primary color of the object. Read / write ExcelKnownColors. + + + The following code illustrates how a color from enumeration can be set to font. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set font + IFont font = style.Font; + + //Set color + font.Color = ExcelKnownColors.Red; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets / sets font color from the structure. + + + The following code illustrates how to set a color from structure to the font. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set font + IFont font = style.Font; + + //Set color + font.RGBColor = System.Drawing.Color.Red; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + True if the font style is italic. Read / write Boolean. + + + The following code illustrates how to set Italic property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set font + IFont font = style.Font; + + //Set italic + font.Italic = true; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + True if the font is an outline font. Read / write Boolean. + + + The following code illustrates how to set MacOSOutlineFont property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set font + IFont font = style.Font; + + //Set MacOS outline font + font.MacOSOutlineFont = true; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + True if the font is a shadow font or if the object has + a shadow. Read / write Boolean. + + + The following code illustrates how to set MacOSShadow property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set font + IFont font = style.Font; + + //Set MacOS shadow + font.MacOSShadow = true; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the size of the font. Read / write Variant. + + + The following code illustrates how font size can be set. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set font + IFont font = style.Font; + + //Set size + font.Size = 15; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + True if the font is struck through with a horizontal line. + Read / write Boolean + + + The following code illustrates how to set Strikethrough property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set font + IFont font = style.Font; + + //Set strick through + font.Strikethrough = true; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + True if the font is formatted as subscript. + False by default. Read / write Boolean. + + + The following code illustrates how to set Subscript property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set font + IFont font = style.Font; + + //Set subscript + font.Subscript = true; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + True if the font is formatted as superscript. False by default. + Read/write Boolean + + + The following code illustrates how to set Superscript property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set font + IFont font = style.Font; + + //Set superscript + font.Superscript = true; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the type of underline applied to the font. + Read / write ExcelUnderline. + + + By default, is set to Underline for fonts. Here for example, we set + to Underline property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set font + IFont font = style.Font; + + //Set underline + font.Underline = ExcelUnderline.Single; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the font name. Read / write string. + + + The following code illustrates how to set FontName property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set font + IFont font = style.Font; + + //Set font name + font.FontName = "Arial"; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets / sets font vertical alignment. + + + By default, is set to VerticalAlignment for fonts. Here for example, we set + to VerticalAlignment property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set font + IFont font = style.Font; + + //Set alignment + font.VerticalAlignment = ExcelFontVertialAlignment.Superscript; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Indicates whether color is automatically selected. Read-only. + + + The following code illustrates how to access IsAutoColor property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set font + IFont font = style.Font; + + //Set color + font.Color = ExcelKnownColors.Red; + + //Check IsAutoColor + Console.Write(font.IsAutoColor); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //False + + + + + + Get or sets the Area's text in the chart. + + + To know more about charts refer this link. + + The following code illustrates the use of Text property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the Area's text in the chart + chart.ChartTitleArea.Text = "Student Chart"; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + String with rich text formatting in the chart. Read-only. + + + To know more about charts refer this link. + + The following code illustrates the use of RichText property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + chart.ChartTitleArea.Text = "Sample Chart"; + + //Create a font style for RichText + IFont font = chart.ChartTitleArea; + font.Color = ExcelKnownColors.Orange; + font.FontName = "Broadway"; + + //Get the rich text formatting in the chart + IChartRichTextString richText = chart.ChartTitleArea.RichText; + + //Sets the rich text in Text Area + richText.SetFont(0, 5, font); + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Text rotation angle. We can rotate or change the angle of the Area's text. + + + To know more about charts refer this link. + + The following code illustrates the use of RightColumn property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + chart.ChartTitleArea.Text = "Student Chart"; + + //Sets the Text rotation angle + chart.ChartTitleArea.TextRotationAngle = 30; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets the formatting options of the chart for text area. Read-only. Return format of the text area. + + + To know more about charts refer this link. + + The following code illustrates the use of FrameFormat property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Gets the formatting options of the chart for text area + chart.ChartTitleArea.Text = "Sample Chart"; + chart.ChartTitleArea.FrameFormat.Border.LineColor = System.Drawing.Color.Brown; + chart.ChartTitleArea.FrameFormat.Interior.BackgroundColor = System.Drawing.Color.Beige; + chart.ChartTitleArea.FrameFormat.Interior.Pattern = ExcelPattern.Percent25; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Get or sets the Display mode of the background. The chart Text Area's Display mode can be changed using + + + To know more about charts refer this link. + + The following code illustrates the use of BackgroundMode property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + chart.ChartTitleArea.Text = "Student Chart"; + + //sets the Display mode of the background + chart.ChartTitleArea.BackgroundMode = ExcelChartBackgroundMode.Opaque; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + True if background is set to automatic. + + + To know more about charts refer this link. + + The following code illustrates the use of IsAutoMode property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + chart.ChartTitleArea.Text = "Student Chart"; + + //True if background is set to automatic + chart.ChartTitleArea.IsAutoMode = true; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Represents the Layout settings of TextArea. Layout settings are used to specifies the position using . + + + The layout option is supported only for plot area. To know more about charts refer this link. + + The following code illustrates the use of Layout property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + chart.ChartTitleArea.Text = "Student Chart"; + + //Layout settings for TextArea is below + chart.ChartTitleArea.Layout.HeightMode = LayoutModes.edge; + chart.ChartTitleArea.Layout.WidthMode = LayoutModes.edge; + chart.ChartTitleArea.Layout.LeftMode = LayoutModes.edge; + chart.ChartTitleArea.Layout.TopMode = LayoutModes.edge; + chart.ChartTitleArea.Layout.Height = 200; + chart.ChartTitleArea.Layout.Width = 300; + chart.ChartTitleArea.Layout.Left = 180; + chart.ChartTitleArea.Layout.Top = 20; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a value indicating whether this instance is formula. + + + true if this instance is formula; otherwise, false. + + The following code illustrates the use IsFormula property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + sheet.Range["A1"].Text = "Month"; + sheet.Range["B1"].Text = "Product A"; + sheet.Range["C1"].Text = "Product B"; + + sheet.Range["A2"].Text = "Jan"; + sheet.Range["A3"].Text = "Feb"; + sheet.Range["A4"].Text = "Mar"; + sheet.Range["A5"].Text = "Apr"; + sheet.Range["A6"].Text = "May"; + + sheet.Range["B2"].Number = 111; + sheet.Range["B3"].Number = 361; + sheet.Range["B4"].Number = 336; + sheet.Range["B5"].Number = 40; + sheet.Range["B6"].Number = 219; + + sheet.Range["C2"].Number = 182; + sheet.Range["C3"].Number = 283; + sheet.Range["C4"].Number = 406; + sheet.Range["C5"].Number = 449; + sheet.Range["C6"].Number = 337; + + IChartShape chart = sheet.Charts.Add(); + chart.ChartType = ExcelChartType.Line; + chart.DataRange = sheet.Range["A1:C6"]; + + chart.ChartTitleArea.IsFormula = true; + chart.ChartTitle = "='Sheet1'!$A$2"; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating whether to display + series name for data labels. + + + The following code illustrates how to access the and set to shows the serie name. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get the chart serie + IChartSerie serie = chart.Series[0]; + + //Get serie data labels + IChartDataLabels dataLabels = serie.DataPoints.DefaultDataPoint.DataLabels; + + //Set the data label to show the serie name + dataLabels.IsSeriesName = true; + + //Save and Dispose + workbook.SaveAs("chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating whether to display + category name for data labels. + + + The following code illustrates how to access the and set to shows the categories. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get the chart serie + IChartSerie serie = chart.Series[0]; + + //Get serie data labels + IChartDataLabels dataLabels = serie.DataPoints.DefaultDataPoint.DataLabels; + + //Set the data label to show the category names + dataLabels.IsCategoryName = true; + + //Save and Dispose + workbook.SaveAs("chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating whether + to display data label values. + + + The following code illustrates how to access the and set to shows the values. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get the chart serie + IChartSerie serie = chart.Series[0]; + + //Get serie data labels + IChartDataLabels dataLabels = serie.DataPoints.DefaultDataPoint.DataLabels; + + //Set the data label to show the values + dataLabels.IsValue = true; + + //Save and Dispose + workbook.SaveAs("chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating whether to display + percentage value for data labels. + + + The following code illustrates how to access the and set to shows the percentage values. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Pie; + + //Get the chart serie + IChartSerie serie = chart.Series[0]; + + //Get serie data labels + IChartDataLabels dataLabels = serie.DataPoints.DefaultDataPoint.DataLabels; + + //Set the data label to show the percentage values + dataLabels.IsPercentage = true; + + //Save and Dispose + workbook.SaveAs("chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating whether to show + bubble size for data labels. + + + The following code illustrates how to access the and set to shows the bubble sizes. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "1"; + sheet.Range["B3"].Value = "2"; + sheet.Range["C3"].Value = "3"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Bubble; + + //Get the chart serie + IChartSerie serie = chart.Series[0]; + + //Get serie data labels + IChartDataLabels dataLabels = serie.DataPoints.DefaultDataPoint.DataLabels; + + //Set the data label to show the bubble sizes + dataLabels.IsBubbleSize = true; + + //Save and Dispose + workbook.SaveAs("chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the variant representing the separator used for data labels on the chart. + + + The following code illustrates how to access the and set delimiter for data labels. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get the chart serie + IChartSerie serie = chart.Series[0]; + + //Get serie data labels + IChartDataLabels dataLabels = serie.DataPoints.DefaultDataPoint.DataLabels; + + //Set the data label to show the values + dataLabels.IsValue = true; + + //Set the data label to show the series name + dataLabels.IsSeriesName = true; + + //Set '-' symbol as separator for data labels + dataLabels.Delimiter = "-"; + + //Save and Dispose + workbook.SaveAs("chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating whether + data label legend key is visible. + + + The following code illustrates how to access the and set to shows the legend keys. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get the chart serie + IChartSerie serie = chart.Series[0]; + + //Get serie data labels + IChartDataLabels dataLabels = serie.DataPoints.DefaultDataPoint.DataLabels; + + //Set the data label to show the values + dataLabels.IsValue = true; + + //Set the data label to show the legend key + dataLabels.IsLegendKey = true; + + //Save and Dispose + workbook.SaveAs("chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating whether + to display leader lines. + + + The following code illustrates how to access the and set leader lines to show. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Pie; + + //Get the chart serie + IChartSerie serie = chart.Series[0]; + + //Get serie data labels + IChartDataLabels dataLabels = serie.DataPoints.DefaultDataPoint.DataLabels; + + //Set the data label to show the values + dataLabels.IsValue = true; + + //Set data label position to outside + dataLabels.Position = ExcelDataLabelPosition.Outside; + + //Set the data label to show the leader lines + dataLabels.ShowLeaderLines = true; + + //Save and Dispose + workbook.SaveAs("chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the data labels position. + + + The following code illustrates how to access the and set the position for labels. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Pie; + + //Get the chart serie + IChartSerie serie = chart.Series[0]; + + //Get serie data labels + IChartDataLabels dataLabels = serie.DataPoints.DefaultDataPoint.DataLabels; + + //Set the data label to show the values + dataLabels.IsValue = true; + + //Set data label position to outside + dataLabels.Position = ExcelDataLabelPosition.Outside; + + //Save and Dispose + workbook.SaveAs("chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a value indicating whether this instance is formula. + + + true if this instance is formula; otherwise, false. + + The following code illustrates the use IsFormula property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + sheet.Range["A1"].Text = "Month"; + sheet.Range["B1"].Text = "Product A"; + sheet.Range["C1"].Text = "Product B"; + + sheet.Range["A2"].Text = "Jan"; + sheet.Range["A3"].Text = "Feb"; + sheet.Range["A4"].Text = "Mar"; + sheet.Range["A5"].Text = "Apr"; + sheet.Range["A6"].Text = "May"; + + sheet.Range["B2"].Number = 111; + sheet.Range["B3"].Number = 361; + sheet.Range["B4"].Number = 336; + sheet.Range["B5"].Number = 40; + sheet.Range["B6"].Number = 219; + + sheet.Range["C2"].Number = 182; + sheet.Range["C3"].Number = 283; + sheet.Range["C4"].Number = 406; + sheet.Range["C5"].Number = 449; + sheet.Range["C6"].Number = 337; + + IChartShape chart = sheet.Charts.Add(); + chart.ChartType = ExcelChartType.Line; + chart.DataRange = sheet.Range["A1:C6"]; + + chart.Series[0].DataPoints[0].DataLabels.IsFormula = true; + chart.Series[0].DataPoints[0].DataLabels.Text = "='Sheet1'!$A$2"; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating whether to display + value form cells for data labels. + + + The following code illustrates how to access the and set to shows the vale form cells values. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get the chart serie + IChartSerie serie = chart.Series[0]; + + //Get serie data labels + IChartDataLabels dataLabels = serie.DataPoints.DefaultDataPoint.DataLabels; + + //Set the data label to show the value form cells. + dataLabels.IsVlaveFromCells = true; + + //Set the data label to show the value form cells range. + datalabels.ValueFromCellsRange= sheet["F5:H5"]; + + //Save and Dispose + workbook.SaveAs("chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating whether to display + value form cells range for data labels. + + + The following code illustrates how to access the and set to shows the value form cells range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get the chart serie + IChartSerie serie = chart.Series[0]; + + //Get serie data labels + IChartDataLabels dataLabels = serie.DataPoints.DefaultDataPoint.DataLabels; + + //Set the data label to show the value form cells. + dataLabels.IsVlaveFromCells = true; + + //Set the data label to show the value form cells range. + datalabels.ValueFromCellsRange= sheet["F5:H5"]; + + //Save and Dispose + workbook.SaveAs("chart.xlsx"); + workbook.Close(); + } + + + + + + Represents objects that can be saved into list of biff records. + + + + + Saves object into list of biff records. + + List of biff records to save object into. + + + + Summary description for IInternalFont. + + + + + Returns font index. Read-only. + + + + + Returns FontImpl for current font. Read-only. + + + + + Returns textarea's color object. Read-only. + + + + + Gets value indicating whether TextRotation was changed. Read-only. + + + + + Represents the Legend Paragraph + + + + + Represents the Default Fontname + + + + + Represents the Default Language + + + + + Represents the Default size + + + + + Parent chart + + + + + Parent Series. + + + + + Text area. + + + + + Parent data point; + + + + + Represents Excel 2007 layout data + + + + + boolean containing delete value + + + + + Indicats whether to show text properties or not + + + + + Indicats whether to show text size properties or not + + + + + Indicats whether to show text bold properties or not + + + + + Indicates if data labels are linked to source + + + + + Indicates whether to show leader lines or not + + + + + Indicates whether to enables the data labels automatically + + + + + The array stores the cache information + + + + + Indicates whether the font is changed or not + + + + + Initializes new instance of data label and sets its parent and application objects. + + Application object. + Parent object + Data point index. + + + + Searches for all necessary parent objects. + + + + + Generates .Net font object corresponding to the current font. + + Generated .Net font. + + + + Saves object into OffsetArrayList. + + + OffsetArrayList that will receive all records. + + + When specified OffsetArrayList is NULL. + + + + + Fill object link record. + + + + + Update datalabel text. + + ChartDataLabel object + Indicating whether value from cells value display to datalabels. + + + + Updates Series index. + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + New font indexes. + New worksheet names. + A new object that is a copy of this instance. + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Gets or sets a boolean value indicating whether to display + series name for data labels. + + + + + Gets or sets a boolean value indicating whether to display + category name for data labels. + + + + + Gets and sets boolean value indicating whether display to value from cells value to datalabels. + + + + + Gets and sets indicating whether value from cells range in datalables. + + + + + Gets or sets a boolean value indicating whether + to display data label values. + + + + + Gets or sets a boolean value indicating whether to display + percentage value for data labels. + + + + + Indicates if data labels are linked to source. + + + + + Gets or sets a boolean value indicating whether to show + bubble size for data labels. + + + + + Gets or sets the variant representing the separator used for data labels on the chart. + + + + + Gets or sets a boolean value indicating whether + data label legend key is visible. + + + + + Gets or sets a boolean value indicating whether + to display leader lines. + + + + + Gets or sets the data labels position. + + + + + Gets or sets the Chart serie. + + + + + Display mode of the background. + + + + + True if background is set to automatic. + + + + + Area's text. + + + + + Gets rich text. + + + + + Text rotation angle. + + + + + Return format of the text area. + + + + + True if the font is bold. Read / write Boolean. + + + + + Returns or sets the primary color of the object. + Read / write ExcelKnownColors. + + + + + Gets / sets font color. Searches for the closest color in + the workbook palette. + + + + + True if the font style is italic. Read / write Boolean. + + + + + True if the font is an outline font. Read / write Boolean. + + + + + True if the font is a shadow font or if the object has + a shadow. Read / write Boolean. + + + + + Returns or sets the size of the font. Read / write Variant. + + + + + True if the font is struck through with a horizontal line. + Read / write Boolean + + + + + True if the font is formatted as subscript. + False by default. Read / write Boolean. + + + + + True if the font is formatted as superscript. False by default. + Read/write Boolean + + + + + Returns or sets the type of underline applied to the font. Can + be one of the following ExcelUnderlineStyle constants. + Read / write ExcelUnderline. + + + + + Returns or sets the font name. Read / write string. + + + + + Gets / sets font vertical alignment. + + + + + Indicates whether color is automatically selected. Read-only. + + + + + Gets / sets text area. + + + + + Gets corresponding data format. Read-only. + + + + + Gets or sets Excel 2007 layout data + + + + + Gets or sets whether to delete or not. + + + + + Gets value indicating whether TextRotation was changed. Read-only. + + + + + Represents the Legend Paragraph + + + + + Gets or sets a value indicating whether this instance is formula. + + + true if this instance is formula; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is formula. + + + true if this instance is formula; otherwise, false. + + + + + Gets or sets a value indicating whether to show text properties or not + + + + + Gets or sets a value indicating whether to show text size properties or not + + + + + Gets or sets a value indicating whether to show text bold properties or not + + + + + Gets or sets the Text Rotation + + + + + Data labels color. Read-only. + + + + + Returns font index. Read-only. + + + + + Returns FontImpl for current font. Read-only. + + + + + Indicates whether the serie type is pie + + + + + Indicates whether to enable the data labels respect to version. + + + + + Parent Workbook + + + + + Gets / Sets the string array + + + + + Indicates whether the font is changed or not + + + + + Represents data point in the chart. + + + + + Represents data point in the chart. + + + + + Gets the object for the . Read-only. + + + The following code illustrates how to access the for a particular . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set serie + IChartSerie serie = chart.Series[0]; + + //Set data labels value visibility + serie.DataPoints.DefaultDataPoint.DataLabels.IsValue = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets index of the in the collection. + + + The following code illustrates how to access the of a in the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set serie + IChartSerie serie = chart.Series[0]; + + //Get index + Console.WriteLine(serie.DataPoints[0].Index); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + + + + + + Gets or sets the data format. + + + The property is used to set chart serie formats. Here for example, we access and set + to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Line; + + //Set serie format + IChartSerieDataFormat format = chart.Series[0].SerieFormat; + + //Set marker style + format.MarkerStyle = ExcelChartMarkerType.Star; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if the is a default one. otherwise False. Read-only. + + + The following code illustrates how to access the property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set serie format + IChartDataPoints dataPoints = chart.Series[0].DataPoints; + + //Check default Datapoint + Console.WriteLine(dataPoints.DefaultDataPoint.IsDefault); + Console.WriteLine(dataPoints[0].IsDefault); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + //False + + + + + + True if the data point has default marker object. otherwise False. + + + The following code illustrates how to access the property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["D1"].Text = "Apr"; + sheet.Range["E1"].Text = "May"; + sheet.Range["F1"].Text = "Jun"; + sheet.Range["A2"].Value = "5"; + sheet.Range["B2"].Value = "21"; + sheet.Range["C2"].Value = "15"; + sheet.Range["D2"].Value = "12"; + sheet.Range["E2"].Value = "28"; + sheet.Range["F2"].Value = "9"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:F2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Line; + + //Set serie data format + IChartSerieDataFormat format = chart.Series[0].DataPoints.DefaultDataPoint.DataFormat; + + //Set marker style + format.MarkerStyle = ExcelChartMarkerType.Circle; + + //Check default marker + Console.Write(chart.Series[0].DataPoints.DefaultDataPoint.IsDefaultmarkertype); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + + + + + + True if the data point is considered as Subtotals or Totals. otherwise False. + + Applies only to Waterfall charts. + + By default in chart data is plotted as floating columns. If we mark a particular column as total or subtotal + by setting property then that particular column starts from zero in horizontal axis and it won't float. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.WaterFall; + + //Set serie format + IChartSerieDataFormat format = chart.Series[0].SerieFormat; + + //Set SetAsTotal + chart.Series[0].DataPoints[2].SetAsTotal = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Data labels. + + + + + Point index. + + + + + Data format. + + + + + Represents parent chart. + + + + + Represents whether the series has datapoint or not + + + + + Represent whether it's having the seperate seperate marker + + + + + Indicates whether bubbles have a 3-D effect applied to them or not + + + + + Represents the amount the data shall be moved from the center of the pie. + + + + + Represents whether the pie has explosion + + + + + Set the data point as total + Used only in waterfall chart + + + + + Initializes new instance and sets its application and parent objects. + + Application object. + Parent object. + Index of the data point. + + + + Serializes data labels data. + + List to serialize into. + + + + Serializes used data formats. + + List to serialize into. + + + + Sets data labels text area format. + + Text area to set. + + + + Creates data labels object if necessary. + + + + + Creates a new object that is a copy of the current instance. + + Parent object for the cloned object. + New font indexes. + Dictionary with new worksheet names. + A new object that is a copy of this instance. + + + + Updates Series index. + + + + + Changes data format to create ChartStockHighLowClose chart type. + + + + + Changes data format to create ChartStockHighLowClose chart type. + + + + + Changes intimate bubble series. + + Type to change. + + + + Changes intimate bubble series. + + Type to change. + + + + Updates current data format. + + Represents data format for update. + + + + Updates current data labels. + + + + + + Clears data formats. + + Represents format to update. + + + + This method is called during dispose operation. + + + + + Gets the data labels object for the data point. Read-only. + + + + + Gets or sets the data format. + + + + + Gets /sets inner data format. + + + + + Gets index of the point in the points collection. + + + + + Returns data format or null. + + + + + True if the data point is a default one. otherwise False. Read-only. + + + + + Indicates whether data labels object was created for this data point. Read-only. + + + + + Indicates whether the series has datapoint or not. + + + + + True if the data point has default marker object. otherwise False. + + + + + Indicates whether bubbles have a 3-D effect applied to them or not + + + + + Gets or sets the amount the data shall be moved from the center of the pie. + + + + + Gets the boolean value which represents whether the pie has explosion + + + + + True if the data point is considered as Subtotals or Totals. otherwise False. + + Applies only to Waterfall charts. + + + + Represents a collection of data points in the series. + + + + + Represents a collection of data points in the series. + + + + + Gets the default data point. Read-only. + + + To customize the properties of all the in the collection at the same time, we can + use property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set serie + IChartSerie serie = chart.Series[0]; + + //Set data labels value visibility + serie.DataPoints.DefaultDataPoint.DataLabels.IsValue = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the data point with the specified index. Read-only. + + + The following code illustrates how a particular can be accessed from collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set serie + IChartSerie serie = chart.Series[0]; + + //Set data labels value visibility + serie.DataPoints[0].DataLabels.IsValue = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Format for data points without explicit format. + + + + + Collection of used data points, key - int index, value - data point. + + + + + Parent chart series. + + + + + Parent chart + + + + + Initializes new instance of the collection and sets its parent and application properties. + + Application object. + Parent object. + + + + Finds parent objects. + + + + + Finds parent objects for chart common data points + + + + + Serializes data labels data. + + List to serialize into. + + + + Serializes all used data formats. + + List to serialize into. + + + + Creates a new object that is a copy of the current instance. + + Parent object for the cloned object. + Parent workbook. + Dictionary with new font indexes. + Dictionary with new worksheet names. + A new object that is a copy of this instance. + + + + Adds new data point to the collection. + + Data point to add. + + + + Removes all elements from the collection. + + + + + Clear the data points and the formats of the individual and default data points are preserved + + + + + Updates index of the parent Series. + + + + + Clears all series data formats. + + Represents format to update. + + + + Returns an enumerator that iterates through a collection. + + An IEnumerator object that can be used to iterate through the collection. + + + + Check for data labels on data points + + retuns true,if single data point have data labels,otherwise false + + + + This method is called during dispose operation. + + + + + Gets the data point with the specified index. Read-only. + + + + + Gets the default data point. Read-only. + + + + + Indicates whether workbook is loading. Read-only. + + + + + Gets default data format or null. Read-only. + + + + + Returns number of defined (created) data points. Read-only. + + + + + Class used for Chart DataTable implementation. + + + + + Represents the chart data table. + + + + + True if the data table has inline horizontal border. otherwise False. + The default value is True. + + + The following code illustrates how to remove horizontal border for object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Enabling the data table + chart.HasDataTable = true; + + //Get data table of the chart + IChartDataTable dataTable = chart.DataTable; + + //Set false to remove the horizontal border in data table + dataTable.HasHorzBorder = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if the data table has inline vertical border. otherwise False. + The default value is True. + + + The following code illustrates how to remove vertical border for object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Enabling the data table + chart.HasDataTable = true; + + //Get data table of the chart + IChartDataTable dataTable = chart.DataTable; + + //Set false to remove the vertical border in data table + dataTable.HasVertBorder = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if the data table has outline borders. otherwise False. + The default value is True. + + + The following code illustrates how to outline borders of object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Enabling the data table + chart.HasDataTable = true; + + //Get data table of the chart + IChartDataTable dataTable = chart.DataTable; + + //Set false to remove the borders in data table + dataTable.HasBorders = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True to show series keys in the data table. otherwise False. + + + The following code illustrates how to show series keys in the object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Enabling the data table + chart.HasDataTable = true; + + //Get data table of the chart + IChartDataTable dataTable = chart.DataTable; + + //Set true to show series keys in the data table + dataTable.ShowSeriesKeys = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the of the data table. Read-only. + + + The following code illustrates how to get and format the of the object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Enabling the data table + chart.HasDataTable = true; + + //Get data table of the chart + IChartDataTable dataTable = chart.DataTable; + + //Get text area object of the data table + IChartTextArea textArea = chart.DataTable.TextArea; + + //Set text area font color + textArea.Color = ExcelKnownColors.BlueCustom; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + This record stores options for the chart data table. + + + + + Records that were read (if data table was not created but loaded). + + + + + Represents chart text record and sub records. + + + + + Represents data table has shape properties or not. + + + + + This is used to hold data table's shape properties. + + + + + Creates default data table. + + Application object for the new data table. + Parent object for the new data table. + + + + Extracts data table's data from the array of BiffRecords. + + Application object for the new data table. + Parent object for the new data table. + Array of BiffRecords that contains the data table's data. + Position of the ChartData record. + + + + Extracts data table from the array of BiffRecords. + + BiffRecords with data table records. + Position of the ChartData record. + + When specified record is not ChartData record + or when next record is not Begin record. + + + + + Serializes data table. + + + OffsetArrayList that will receive all data table records. + + + When specified OffsetArrayList is NULL. + + + + + Clone current Record. + + Parent object for create new instance. + Returns clone of current object. + + + + True if the data table has horizontal border. otherwise False. + + + + + True if the data table has vertical border. otherwise False. + + + + + True if the data table has borders. otherwise False. + + + + + True to show legend keys in the data table. otherwise False. + + + + + Boolean value indicates whether the text area object is initialized or not. + + + + + Gets the text area of the data table. Read-only. + 9 + + + + Represents up or down bars for the line chart. + + + + + Represents up or down bars for the line chart. + + + + + Provides formatting options for area elements in the chart. + + + + + True if the chart element has interior formatting. otherwise False. Read-only. + + + To know more about charts refer this link. + + The following code illustrates the use of HasInterior property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Create a fill border and set interior value + IChartFillBorder fillBorder = chart.ChartArea; + chart.ChartArea.Interior.ForegroundColor = System.Drawing.Color.AliceBlue; + + //True if the chart element has interior formatting + if (fillBorder.HasInterior) + { + //Your Code Here + } + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + True if the chart element has line formatting. otherwise False. Read-only. + + + To know more about charts refer this link. + + The following code illustrates the use of HasLineProperties property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Create a fill border and set line border value + IChartFillBorder fillBorder = chart.ChartArea; + chart.ChartArea.Border.LineColor = System.Drawing.Color.DarkOrange; + + //True if the chart element has line formatting + if (fillBorder.HasLineProperties) + { + //Your Code Here + } + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + True if the chart element has 3D formatting. otherwise False. Read-only. + + + To know more about charts refer this link. + + The following code illustrates the use of Has3dProperties property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Create a fill border and set 3D formatting value + IChartFillBorder fillBorder = chart.ChartArea; + chart.ChartArea.ThreeD.BevelTop = Excel2007ChartBevelProperties.Slope; + + //True if the chart element has 3D formatting + if (fillBorder.Has3dProperties) + { + //Your Code Here + } + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + True if the chart element has shadow formatting properties. otherwise False. Read-only. + + + To know more about charts refer this link. + + The following code illustrates the use of HasShadowProperties property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Create a fill border and set line border value + IChartFillBorder fillBorder = chart.ChartArea; + chart.ChartArea.Shadow.ShadowOuterPresets = Excel2007ChartPresetsOuter.OffsetBottom; + + //True if the chart element has shadow formatting properties + if (fillBorder.HasShadowProperties) + { + //Your Code Here + } + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets line formatting properties for the chart element. Read-only. + + The following code illustrates the use of LineProperties. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Gets line formatting properties for the chart element + IChartBorder border = chart.PlotArea.Border; + border.LinePattern = ExcelChartLinePattern.DashDotDot; + border.LineColor = System.Drawing.Color.Orange; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets interior formatting properties for the chart element. Read-only. + + The following code illustrates the use of Interior property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Gets interior formatting properties for the chart element + IChartInterior chartInterior = chart.ChartArea.Interior; + chartInterior.BackgroundColor = System.Drawing.Color.Beige; + chartInterior.Pattern = ExcelPattern.DarkDownwardDiagonal; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets fill options for the chart element. Read-only. + + The following code illustrates the use of Fill property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Gets fill options for the chart element + IFill fillChart = chart.ChartArea.Fill; + fillChart.FillType = ExcelFillType.Gradient; + fillChart.BackColor = System.Drawing.Color.FromArgb(205, 217, 234); + fillChart.ForeColor = System.Drawing.Color.White; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets 3D-effect properties for the chart element. Read-only. + + The following code illustrates the use of ThreeD property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Gets 3D-effect properties for the chart element + IThreeDFormat threeDFromat = chart.ChartArea.ThreeD; + threeDFromat.BevelTop = Excel2007ChartBevelProperties.Slope; + threeDFromat.BevelTopHeight = 16; + threeDFromat.BevelTopWidth = 7; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets shadow formatting properties for the chart element. Read-only. + + The following code illustrates the use of Shadow property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Gets shadow formatting properties for the chart element + IShadow shadowChart = chart.ChartArea.Shadow; + shadowChart.ShadowPrespectivePresets = Excel2007ChartPresetsPrespective.Below; + shadowChart.ShadowColor = System.Drawing.Color.Aqua; + shadowChart.Blur = 22; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the gap width of the drop bar in percent (0 to 500%). + + + The following code illustrates how to access and set Gap value for chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Line; + + //Set chart drop bar + IChartDropBar dropBar = chart.Series[0].SerieFormat.CommonSerieOptions.FirstDropBar; + + //Set gap + dropBar.Gap = 90; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Represents interface, that synchronize chart fill color properties and interior colors. + + + + + Represents foreground color. + + + + + Represents background color. + + + + + Represents pattern. + + + + + Represents is automatic format. + + + + + Represents fill properties. + + + + + Represents visible. + + + + + Represents chart drop bar record. + + + + + Represents drop bar line format. + + + + + Represents drop bar area format. + + + + + Represents parent workBook. + + + + + Represents drop bar filling options. + + + + + Represents the 3D features + + + + + Represents Shadow + + + + + Initialize new instance. + + Current application. + Parent object. + + + + Sets parent objects. + + + + + Parses current block of records. + + Offset array list. + Current position in offset array list. + + + + Serializes DropBar. + + OffsetArrayList that will receive all records. + + + + Clones current object. + + Parent object. + Returns cloned object. + + + + This property indicates whether interior object was created. Read-only. + + + + + Represents the Shadow.Read-only + + + + + Gets a value indicating whether this instance has shadow properties. + + + true if this instance has shadow properties; otherwise, false. + + + + + Gets the chart3 D options. + + The chart3 D options. + + + + This property Indicates whether the Shadow object has been created(which includes the 3D properties) + + + + + This property indicates whether border formatting object was created. Read-only. + + + + + Gets or sets the gap width of the drop bar in percent (0 to 500%). + + + + + Returns interior object. Read-only. + + + + + Returns object, that represents line properties. Read-only. + + + + + Represents fill options. Read-only. + + + + + Represents foreground color. + + + + + Represents background color. + + + + + Represents pattern. + + + + + Represents if use automatic format. + + + + + Represents visibility. + + + + + Represent error bars on the chart series. + + Error bars indicate the degree of uncertainty for chart data. Only series in area, bar, column, line, + and scatter groups on a 2-D chart can have error bars. + Only series in scatter groups can have x and y error bars. + + + + + Represent error bars on the chart series. + + Error bars indicate the degree of uncertainty for chart data. Only series in area, bar, column, line, + and scatter groups on a 2-D chart can have error bars. + Only series in scatter groups can have x and y error bars. + + + + + Clears the formats of the error bars. + + + The following code illustrates how to clear the formats of + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + sheet.Range["D2"].Value = "4"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Enabling the Y Error bars + serie.HasErrorBarsY = true; + + //Get Y Error Bars + IChartErrorBars errorBars = serie.ErrorBarsY; + + //Set Error bars border color + errorBars.Border.ColorIndex = ExcelKnownColors.Red; + + //Set error amount to custom + errorBars.Type = ExcelErrorBarType.Custom; + + //Set minus range + errorBars.MinusRange = sheet["D2"]; + + //Check error bar contains formats + Console.WriteLine("Is default line color applied in Error bars:" + errorBars.Border.IsAutoLineColor); + Console.WriteLine("Error bar type:" + errorBars.Type); + + //Clear the Error bar formats + errorBars.ClearFormats(); + + //Check error bar contains formats + Console.WriteLine("Is default line color applied in Error bars:"+ errorBars.Border.IsAutoLineColor); + Console.WriteLine("Error bar type:"+ errorBars.Type); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + + + // Output will be + // Is default line color applied in Error bars:False + // Error bar type:Custom + // Is default line color applied in Error bars:True + // Error bar type:Fixed + + + + Deletes the error bars. + + + The following code illustrates how to delete the + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Enabling the Y Error bars + serie.HasErrorBarsY = true; + + //Get Y Error bars + IChartErrorBars errorBars = serie.ErrorBarsY; + + //Check series contains Error bars + Console.WriteLine("Is serie contains Error bars:" + serie.HasErrorBarsY); + + //Removing the Error bars + errorBars.Delete(); + + //Check series contains Error bars + Console.WriteLine("Is serie contains Error bars:" + serie.HasErrorBarsY); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + + + // Output will be + // Is serie contains Error bars:True + // Is serie contains Error bars:False + + + + Gets the border for the drop bars. Read-only. + + + The following code illustrates how to access and format the for + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Enabling the Y Error bars + serie.HasErrorBarsY = true; + + //Get Y Error Bars + IChartErrorBars errorBars = serie.ErrorBarsY; + + //Set Error bars border color + errorBars.Border.ColorIndex = ExcelKnownColors.Red; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the error bar include type. + + + The following code illustrates how to set include type for + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Enabling the Y Error bars + serie.HasErrorBarsY = true; + + //Get Y Error Bars + IChartErrorBars errorBars = serie.ErrorBarsY; + + //Set negative error only to include + errorBars.Include = ExcelErrorBarInclude.Minus; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating end style for the error bars. + + + The following code illustrates how to remove end style for + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Enabling the Y Error bars + serie.HasErrorBarsY = true; + + //Get Y Error Bars + IChartErrorBars errorBars = serie.ErrorBarsY; + + //Set false to remove the end style + errorBars.HasCap = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the error bar type. + + + The following code illustrates how to set the error bar type for + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Enabling the Y Error bars + serie.HasErrorBarsY = true; + + //Get Y Error Bars + IChartErrorBars errorBars = serie.ErrorBarsY; + + //Set error amount to standard deviation + errorBars.Type = ExcelErrorBarType.StandardDeviation; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the number value for applicable . + + + The following code illustrates how to set the error value for + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Enabling the Y Error bars + serie.HasErrorBarsY = true; + + //Get Y Error Bars + IChartErrorBars errorBars = serie.ErrorBarsY; + + //Set error amount to fixed value + errorBars.Type = ExcelErrorBarType.Fixed; + + //Set error value + errorBars.NumberValue = 3.0; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets object with positive error value for custom error bar. + + + The following code illustrates how to set the plus range for + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + sheet.Range["D2"].Value = "4"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Enabling the Y Error bars + serie.HasErrorBarsY = true; + + //Get Y Error Bars + IChartErrorBars errorBars = serie.ErrorBarsY; + + //Set error amount to custom + errorBars.Type = ExcelErrorBarType.Custom; + + //Set plus range + errorBars.PlusRange = sheet["D2"]; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets object with negative error value for custom error bar. + + + The following code illustrates how to set the minus range for + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + sheet.Range["D2"].Value = "4"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Enabling the Y Error bars + serie.HasErrorBarsY = true; + + //Get Y Error Bars + IChartErrorBars errorBars = serie.ErrorBarsY; + + //Set error amount to custom + errorBars.Type = ExcelErrorBarType.Custom; + + //Set minus range + errorBars.MinusRange = sheet["D2"]; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the object. Read-only. + + + The following code illustrates how to access and format the for + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Enabling the Y Error bars + serie.HasErrorBarsY = true; + + //Get Y Error Bars + IChartErrorBars errorBars = serie.ErrorBarsY; + + //Set Error bars shadow color + errorBars.Shadow.ShadowColor = System.Drawing.Color.Red; + + //Set Error bars shadow outer presets + errorBars.Shadow.ShadowOuterPresets = Excel2007ChartPresetsOuter.OffsetDiagonalTopRight; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the object. Read-only.[Deprecated] + + + + + Represents default value for X error bar. + + + + + Represents default value for Y axis. + + + + + Serialize Series record. + + Represents record holder. + Values number. + + + + Serialize data format records. + + Represents record holder. + Represents border object. + Represents Series index. + Represents Series indexes. + + + + Represents border object. + + + + + Represents error bar record. + + + + + Represents Shadow + + + + + Represents error include. + + + + + Represents parent Series. + + + + + Represents positive range of custom values. + + + + + Represents negative range of custom values. + + + + + Indicates that is on Y axis. + + + + + ChartAI record containing referred range. + + + + + Preserved marker formta record + + + + + Represents the 3D features + + + + + Represents the chart ErrorBar plus range values + + + + + Represents the chart ErrorBar minus range values + + + + + Creates new instance of error bars implementation. + + Application object. + Represents parent object. + Indicates if it's Y axis bar. + + + + Parses new instance of error bars from stream. + + Application object. + Represents parent object. + Represents data holder. + + + + Finds parent objects. + + + + + Clears the formats of the error bars. + + + + + Deletes the error bars. + + + + + Parses error bars object from stream. + + Represents record holder. + + + + Serializes records to biff stream + + Represents record holder. + + + + Serializes AI records. + + Represents records holder. + If true than plus sub bar; otherwise minus. + + + + Serializes single error bar to biff stream. + + Represents record holder. + Indicates if in Y axis. + Indicates if Plus error bar. + Represents Series index. + + + + Gets native PTG. + + Indicates if it plus error bar. + Returns PTG. + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Checks include value. + + Represents include value. + Returns true if class support current inclure; otherwise false. + + + + Clones current object. + + Represents parent object for new cloned instance. + Represents new names. + Returns cloned object. + + + + Gets the border for the drop bars. Read-only. + + + + + Gets or sets the error bar include type. + + + + + Gets or sets a boolean value indicating end style for the error bars. + + + + + Gets or sets the error bar type. + + + + + Gets or sets the number value for applicable . + + + + + Gets or sets a value indicating whether this instance is plus number literal. + + + true if this instance is plus number literal; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is minus number literal. + + + true if this instance is minus number literal; otherwise, false. + + + + + Gets or sets object with positive error value for custom error bar. + + + + + Gets or sets object with negative error value for custom error bar. + + + + + Gets the object. Read-only. + + + + + This property indicates whether the shadow object has been created + + + + + Gets the chart3D options. Read-only. + + + + + This property Indicates whether the Shadow object has been created(which includes the 3D properties) + + + + + If true, error bar is on Y axis; otherwise - on X axis. + + + + + Represents the chart ErrorBar plus range values + + + + + Represents the chart ErrorBar minus range values + + + + + Represents fill format in chart object. + + + + + Represents fill format in shape object. + + + + + Represents fill format. + + + + + Sets user defined picture. + + Path to image. + + + + Sets user defined picture. + + Represents user defined image. + Represents name of user defined image. + + + + Sets user defined texture. + + Represents user defined texture. + Represents name of user defined texture. + + + + Sets user defined texture. + + Path to image. + + + + Sets the specified fill to a pattern. + + Pattern to set. + + + + Sets the specified fill to a preset gradient. + + Represents preset gradient type. + + + + Sets the specified fill to a preset gradient. + + Represents preset gradient type. + Represents gradient style, for preset gradient. + + + + Sets the specified fill to a preset gradient. + + Represents preset gradient type. + Represents gradient style, for preset gradient. + Represents gradient variant for preset gradient. + + + + Sets the specified fill format to a preset texture. + + Represents texture to set. + + + + Sets the specified fill to a two-color gradient. + + + + + Sets the specified fill to a two-color gradient. + + Represents shading shading style. + + + + Sets the specified fill to a two-color gradient. + + Represents shading shading style. + Represents shading variant. + + + + Sets the specified fill to a one-color gradient. + + + + + Sets the specified fill to a one-color gradient. + + Represents shading shading style. + + + + Sets the specified fill to a one-color gradient. + + Represents shading shading style. + Represents shading variant. + + + + Sets the specified fill to a uniform color. + + + + + Represents shape fill type. + + + + + Represents gradient shading style. + + + + + Represents current shading variant. + + + + + Returns or sets the degree of transparency of the specified fill as + a value from 0.0 (opaque) through 1.0 (clear). + + + + + Returns or sets the degree of transparency of the specified fill as + a value from 0.0 (opaque) through 1.0 (clear). + + + + + Represents gradient style. + + + + + Represents gradient pattern + + + + + Represents gradient texture + + + + + Represents background color index. + + + + + Represents foreground color index. + + + + + Represents background color. + + + + + Represents foreground color. + + + + + Represents preset gradient type. + + + + + Gets or Sets the Transparency for specified picture_only. + + + + + Represents user defined picture or texture. Read-only. + + + + + Returns user defined picture of texture name. Read-only. + + + + + Represents if fill style visible. + + + + + Returns the gradient degree of the specified one-color shaded fill as a floating-point + value from 0.0 (dark) through 1.0 (light) + + + + + Returns the transparency level of the specified Solid color shaded fill as a floating-point + value from 0.0 (Clear) through 1.0(Opaque) + + + + + Gets or Sets the TextureVerticalScale for specified fill + + + + + Gets or Sets the TextureHorizontalScale for specified fill + + + + + Represents the offset X for the texture fill + + + + + Represents the offset Y for the texture fill + + + + + Represents Internal Fill + + + + + Represents background color. + + + + + Represents foreground color. + + + + + Represents whether picture is tiled or stretched. + + + + + Preserved Gradient + + + + + Is Gradient Supported + + + + + It's define Alphamodfix for bilp(tranparency) + + + + + It's define the Texture properties + + + + + Texture Horizontal Scale + + + + + Texture OffsetX + + + + + Texture OffsetY + + + + + Alignment + + + + + Tile Flipping + + + + + Interface used to get gradient fill effects. + + + + + Compares with gradient. + + Gradient to compare with. + Zero if gradients are equal. + + + + Sets the specified fill to a two-color gradient. + + + + + Sets the specified fill style with fill to a two-color gradient. + + Represents shading shading style. + Represents shading variant. + + + + Represents background color object. + + + + + Represents background color. + + + + + Represents background color index. + + + + + Represents foreground color object. + + + + + Represents foreground color. + + + + + Represents foreground color index. + + + + + Represents gradient shading style. + + + + + Represents gradient shading variant. + + + + + Represents default vertical shading style. + + + + + Represents default vertical shading style in Excel 2007 generated xls files. + + + + + Represents default diagonal up shading style. + + + + + Represents default diagonal down shading style. + + + + + Represents color constant. + + + + + Represents default value for one color. + + + + + Represents pattern prefix. + + + + + Represents texture prefix. + + + + + Represents preset gradient prefix. + + + + + Represents pattern enum prefix. + + + + + Represents value, that indicate that fill doesn't visible. + + + + + Represents index, that represents default comment color. + + + + + Represents corner gradient style. + + + + + Represents center gradient style. + + + + + Represents default offset. + + + + + Maximum value for such attributes like Alpha, Tint, Shade. + + + + + Represents horizontal angle of fill. + + + + + Represents vertical angle of fill. + + + + + Represents Diagonal up angle of fill. + + + + + Represents Diagonal down angle of fill. + + + + + Represents default shade variant array value. + + + + + Represents default shade third variant array value. + + + + + Represents default shade variant array value. + + + + + Represents additional data for center variants. + + + + + Represents additional data for corner variants. + + + + + Represents array, that indicate, that current picture is bitmap. + + + + + Represents default comment fill color. + + + + + Represents rectangular structure fill from center. + + + + + Represents rectangular structure fill from corner. + + + + + Dictionary to access to resource data. Key - string, resource id, value - byte[], resource data. + + + + + Represents fill type. + + + + + Represents shading style. + + + + + Represents the indicate wheather gradient style change or not. + + + + + Represents current shading variants. + + + + + Represents transparency to. + + + + + Represents transparency from. + + + + + Represents gradient style. + + + + + Represents gradient pattern. + + + + + Represents gradient texture. + + + + + Represents parent book. + + + + + Represents background color index. + + + + + Represents foreground color index. + + + + + Represents preset gradient. + + + + + Represents indicate wheather preset gradient style change or not. + + + + + Represents user defined picture of texture. + + + + + Represents picture name. + + + + + Represents if fill style is visible. + + + + + Represents image index. + + + + + Represents gradient degree. + + + + + Represents picture data to parse. + + + + + Indicates if this instance of object is shape fill. + + + + + Represent the fillrectangle + + + + + Represent the source rectangle + + + + + It's define the alphamodfix value + + + + + Preset gradient. + + + + + Indicates whether gradient is supported. + + + + + It's define the texture attributes + + + + + Specifies whether FillType is Texture + + + + + Represents the multi color gradient stops object. + + + + + Represents the two color gradient stops object. + + + + Represents the one color gradient stops object. + + + + + + Represents the preset color gradient stops object. + + + + + Represents current assembly. + + + + + Represent array, that contain all preset gradient types. + + + + + This collection contains gradient stops collection for preset gradients. + + + + + Initialize all static members. + + + + + Gets picture from resources file by id. + + Represents unique id in resource file. + Returns picture from resource file by unique id. + + + + Parses color. + + Represents parent book. + Color value to parse. + Extracted color. + + + + Parses color. + + Represents parent book. + Color value to parse. + + + + Returns collection of gradient stops that stores specified preset color. + + Gradient preset to return gradient stops collection for. + Corresponding gradient stops collection. + + + + Returns binary data for collection of gradient stops that stores specified preset color. + + Gradient preset to return gradient stops collection for. + Corresponding gradient stops binary data. + + + + Creates new instance of this class. + + Represents current application. + Represents parent object. + + + + Creates new instance of this class. + + Represents current application. + Represents parent object. + Fill type. + + + + Creates new instance of this class. AutoShapeImplementation + + Represents current application. + Represents parent object. + Fill type. + + + + Finds parent objects. + + + + + This method tries to detect gradient color settings (One or Two color gradient). + + Gradient stops to detect gradient color + Detected gradient color or -1 if it is neither one nor two color gradient. + + + + Sets user defined picture. + + Path to image. + This method is not supported in WinRT, Windows Phone, Universal and Portable platforms. + + + + + Sets user defined picture. + + Represents user defined image. + Represents name of user defined image. + + + + Sets user defined texture. + + Path to image. + This method is not supported in WinRT, Windows Phone, Universal and Portable platforms. + + + + + Sets user defined texture. + + Represents user defined texture. + Represents name of user defined texture. + + + + Sets the specified fill to a pattern. + + Pattern to set. + + + + Sets the specified fill to a preset gradient. + + Represents preset gradient type. + + + + Sets the specified fill to a preset gradient. + + Represents preset gradient type. + Represents gradient style, for preset gradient. + + + + Sets the specified fill to a preset gradient. + + Represents preset gradient type. + Represents gradient style, for preset gradient. + Represents gradient variant for preset gradient. + + + + Sets the specified fill format to a preset texture. + + Represents texture to set. + + + + Sets the specified fill to a two-color gradient. + + + + + Sets the specified fill to a two-color gradient. + + Represents shading shading style. + + + + Sets the specified fill to a two-color gradient. + + Represents shading shading style. + Represents shading variant. + + + + Sets the specified fill to a one-color gradient. + + + + + Sets the specified fill to a one-color gradient. + + Represents shading shading style. + + + + Sets the specified fill to a one-color gradient. + + Represents shading shading style. + Represents shading variant. + + + + Sets the specified fill to a uniform color. + + + + + Compares with shape fill impl. + + Shape fill to compare with. + Zero if shape fills are equal. + + + + Parses fill options. + + Record to parse. + Value indicating fill option. + + + + Parses fill type. + + Represents fill type value. + + + + Parses shading style. + + Represents option value byte array. + + + + Parse shading variant. + + Represents variant value. + + + + Parses pattern or texture name. + + Represents addition data, that contain name. + + + + Parses gradient color. + + Represents gradient color value to parse. + + + + Parses preset gradient type. + + Represents data to parse. + + + + Parses picture or user defined texture. + + Represents name of picture. + If true - parses picture otherwise user defined texture. + + + + Parse picture or texture + + + + + + Updates bitmap header to stream. + + Represents memory stream. + Represents bitmap data. + + + + Updates bitmap header to stream. + + Represents memory stream. + Represents bitmap data. + + + + Parses visible property. + + Represents data value. + + + + Serialize fill properties. + + Option holder. + Returns updated option holder. + + + + Serialize gradient as gradient style. + + Option holder. + Returns updated option holder. + + + + Serialize gradient as pattern style. + + Option holder. + Returns updated option holder. + + + + Serialize gradient as picture style. + + Option holder. + Returns updated option holder. + + + + Serialize gradient as solid color style. + + Option holder. + Returns updated option holder. + + + + Serialize fill type. + + Options holder. + Returns updated options holder. + + + + Serialize shading style. + + Represents fopte option. + Serialized option. + + + + Serialize shading variant. + + Options holder. + Returns updated options holder. + + + + Serialize center shad variants. + + Represents options holder. + Returns updated option holder. + + + + Serialize corner shad variants. + + Represents options holder. + Returns updated option holder. + + + + Serialize gradient style. + + Represents options holder. + Returns updated options holder. + + + + Serialize gradient preset type. + + Represents option holder. + Returns updated option holder. + + + + Serialize visible. + + Represents option holder. + Returns updated visible. + + + + Serialize gradient degree to biff stream + + Represents option holder. + Returns updated option holder. + + + + Indicates if fill type is gradient. If not throw NotSupportedException. + the condition (m_preseredGradient.Count>2) is made by considering that gradient stops should be more than two for multicolor type. + here compared with 2 by considering the Excel behaviour. + + + + + Indicates if fill type is user defined texture or picture. If not throw NotSupportedException. + + + + + Indicates if fill type is pattern. If not throw NotSupportedException. + + + + + Indicates if fill type is texture. If not throw NotSupportedException. + + + + + Validates the type of the solid. + + + + + Convert name to byte array. + + Represents name to convert. + Returns converted name in byte array. + + + + Parses gradient degree. + + Represents value to parse. + Returns parsed gradient degree. + + + + Parses corner variants. + + Represents value to parse. + + + + Fills internal collection with preset gradients default data. + + + + + Sets picture to option storage. + + Represents option storage. + Returns updated option storage. + + + + Sets picture to bse collection. + + Image to set. + Represent name of image. + Return index of image. + + + + Serialize transparency to option holder. + + Represents option holder. + Returns updated option holder. + + + + If need changes visible. + + + + + Clones current object. + + Represents parent object. + Returns cloned methods. + + + + Copies filling settings from. + + Object to copy settings from. + + + + Returns true if colors should be placed in inverted order. + + Gradient style. + Gradient variant. + True if colors should be placed in inverted order. + + + + Evaluates whether colors should be placed in inverted order for DiagonalDown gradient style. + + Gradient variant to check. + True if colors should be placed in inverted order. + + + + Evaluates whether colors should be placed in inverted order for the most + of gradient styles (Horizontal, Vertical, DiagonalUp and FromCenter). + + Represents gradient variant. + Value indicating whether colors placed in inverted order. + + + + Detects whether color sequence should be doubled or not. + + Gradient style. + Gradient variant. + True if color sequence should be doubled. + + + + Detects whether color sequence should be doubled for the most of gradient + styles (all except From_Corner). + + Gradient variant. + True if color sequence should be doubled. + + + + Evaluates gradient angle based on gradient style. + + Gradient style. + Gradient angle, or -1 when gradient style is not linear gradient. + + + + Evaluates fillToRect value for gradient. + + Gradient style. + Gradient variant. + Value of the fillToRect rectangle or Rectangle.Empty if gradient style doesn't need it. + + + + Returns gradient type value based on gradient style. + + Gradient style. + Gradient type value that correspond to the specified gradient style. + + + + Set the group shape property value to all the inner shapes. + + Property value to set. + Property name. + + + + Set the group shape fill visible to all the inner shapes. + + + + + Set ColorObject to BackColorObject. + + ColorObject value to set. + + + + Set ColorObject to ForeColorObject. + + ColorObject value to set. + + + + Returns collection of gradient stops that stores gradient fill settings. Read-only. + + + + + Represents whether picture is tiled or stretched. + + + + + Preserved Gradient + + + + + Gets or Sets the fillrect values + + + + + Gets or Sets the sourcerect values + + + + + Gets parsed picture data. + + + + + Gets or sets if the gradient is supported. + + + + + Represents shape fill type. + + + + + Represents gradient shading style. + + + + + Represents current shading variant. + + + + + Returns or sets the degree of transparency of the specified fill as + a value from 0.0 (opaque) through 1.0 (clear). + + + + + Returns or sets the degree of transparency of the specified fill as + a value from 0.0 (opaque) through 1.0 (clear). + + + + + It Gets or Sets the TransparencyColor value + + + + + Returns the transparency level of the specified Solid color shaded fill as a floating-point + value from 0.0 (opaque) through 1.0(transparent) + + + + + + Represents gradient style. + + + + + Represents gradient pattern + + + + + Represents gradient texture + + + + + Represents background color index. + + + + + Represents foreground color index. + + + + + Represents background color. + + + + + Represents foreground color. + + + + + Represents background color. + + + + + Represents foreground color. + + + + + Represents preset gradient type. + + + + + Represents user defined picture or texture. Read-only. + + + + + Returns user defined picture of texture name. Read-only. + + + + + Represents if fill style visible. + + + + + Returns the gradient degree of the specified one-color shaded fill as a floating-point + value from 0.0 (dark) through 1.0 (light) + + + + + Gets or Sets the TextureVerticalScale for specified fill + + + + + Gets or Sets the TextureHorizontalScale for specified fill + + + + + Gets or Sets the offset X for the specified fill + + + + + Gets or Sets the offset Y for the specified fill + + + + + Define Alignment value + + + + + Define TileFlipping value + + + + + Represents gel record. + + + + + It's define the series color with invertifnegative attribute + + + + + Initialize new instance of fill class. + + Represents current application. + Represents parent object. + + + + Initialize new instance of fill class. + + Represents current application. + Represents parent object. + Represents gel record. + + + + Parses current properties. + + + + + Serialize fill properties. + + Represents records to serialize. + + + + Sets picture to option storage. + + Represents option storage. + Returns updated option storage. + + + + Sets picture to bse collection. + + Image to set. + Represent name of image. + Return index of image. + This method is not supported in WinRT, Windows Phone and Silverlight platforms. + + + + + Serialize transparency to option holder. + + Represents option holder. + Returns updated option holder. + + + + Changes if need visible. + + + + + Returns or sets the degree of transparency of the specified fill as + a value from 0.0 (opaque) through 1.0 (clear). + + + + + Returns or sets the degree of transparency of the specified fill as + a value from 0.0 (opaque) through 1.0 (clear). + + + + + Represents foreground color. + + + + + Represents background color. + + + + + Represents if fill format is visible. + + + + + Represent the invert option's + + + + + Represents collection of ChartFormatImpl. + + + + + Represents default array value. + + + + + Represents capacity of array. + + + + + Represents chart types that need secondary axis. + + + + + Key - ZOrder, value - index. + + + + + Represents parent axis. + + + + + Boolean value indicates whether the format is enabled for pareto chart + + + + + Creates new instance of collection. + + Application object. + Parent object. + + + + Sets parent objects. + + + + + Serializes current collection. + + OffsetArrayList that will receive all records. + + + + Adds chart format. + + + + + + + Adds new format. + + Chartformat to add. + Returns just added format. + + + + Checks whether similar format is already present in the collection + and returns it, otherwise it add new format. + + Format that should be placed in the collection. + Format from the collection. + + + + Checks for containing index in collection. + + Index to check. + If contains - returns true; otherwise - false. + + + + Removes formats by instance. + + Removes current instance. + + + + Updates indexes in collection after remove. + + Index of removed format. + + + + Changes Series chart group in all series. + + New index. + Old Index. + + + + Clears current collection. + + + + + Clones current object. + + Parent object. + Returns cloned object. + + + + Sets value by index. + + Index to set. + Value to set. + + + + Updates formats on adding format. + + Index to updates. + + + + Updates formats on removing. + + Index to update. + + + + Gets format by index, and shallow removes current format. + + Format order. + If true - delete current format. + Format by index. + + + + Shallow adds format to collection. + + Format to add. + + + + Returns single format by DrawingZOrder. Read-only. + + + + + If true - this collection represents formats for primary axis; + otherwise - secondary collection. + + + + + Returns true if this collection is primary and contain series that need + secondary axis. + + + + + Gets / Sets the Is Pareto format variable + + + + + Boolean value indicates whether the axis is depends on the bar series + + + + + Boolean value indicates whether the axis is stacked 100 series + + + + + Provides access to the formatting options for chart elements. + + + + + Provides access to the formatting options for chart elements. + + + + + Gets or sets a boolean value indicating whether to vary color for each data point. [Deprecated] + + + Please, use instead of this property. Sorry for inconvenience. + + + + + Gets or sets a boolean value indicating whether to vary color for each data point. + + + The following code illustrates how to set for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart format + IChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + + //Set vary color + format.IsVaryColor = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the space between the bars/columns. Can be a value between - 100 and 100. + + Applies only to 2-D bar and 2-D column charts. + + The following code illustrates how to set for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Stacked; + + //Set chart format + IChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + + //Set overlap + format.Overlap = 20; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + + Gets or sets the angle of the first pie-chart or dough-nut chart slice, in degrees (clockwise from vertical). + Can be a value from 0 through 360. + + Applies only to pie, 3-D pie, and dough-nut charts. + + The following code illustrates how to set for chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Pie; + + //Set chart format + IChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + + //Set first slice angle + format.FirstSliceAngle = 60; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the size of the hole in a chart. + The hole size is expressed as a percentage of the chart size, between 10 and 90 percent. + + The following code illustrates how to set for chart. + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set serie + IChartSerie serie = chart.Series[0]; + + //Set chart type + chart.ChartType = ExcelChartType.Doughnut; + + //Set Doughnut hole size + serie.SerieFormat.CommonSerieOptions.DoughnutHoleSize = 60; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the scale factor for bubbles. Can be an integer value from 0 to 300, + corresponding to a percentage of the default size. + + For chart types other than chart. + + The following code illustrates how to set for chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Value = "50"; + sheet.Range["B1"].Value = "60"; + sheet.Range["C1"].Value = "5"; + sheet.Range["A2"].Value = "1"; + sheet.Range["B2"].Value = "4"; + sheet.Range["C2"].Value = "2"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Bubble_3D; + + //Set chart format + IChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + + //Set bubble scale + format.BubbleScale = 50; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a value indicating what the bubble size represents on a chart. + + + The property can be set to either or . By default + it is set to . Here for example, we set to property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Value = "50"; + sheet.Range["B1"].Value = "60"; + sheet.Range["C1"].Value = "5"; + sheet.Range["A2"].Value = "1"; + sheet.Range["B2"].Value = "4"; + sheet.Range["C2"].Value = "2"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Bubble_3D; + + //Set chart format + IChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + + //Set bubble scale and size represents + format.BubbleScale = 50; + format.SizeRepresents = ExcelBubbleSize.Width; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True to show negative bubbles on bubble chart. otherwise False. + + + By default is set to "false" so negative values will not be plotted in charts. + Here for example, we load negative values to chart value axis and set to "true". + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Value = "50"; + sheet.Range["B1"].Value = "60"; + sheet.Range["C1"].Value = "5"; + sheet.Range["D1"].Value = "20"; + sheet.Range["A2"].Value = "1"; + sheet.Range["B2"].Value = "4"; + sheet.Range["C2"].Value = "2"; + sheet.Range["D2"].Value = "-2"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:D2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Bubble_3D; + + //Set chart format + IChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + + //Set negative bubble visibility + format.ShowNegativeBubbles = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if a radar chart has axis labels. otherwise False. Applies only to radar charts. + + + The following code illustrates how to hide the axis labels of radar charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set chart type + chart.ChartType = ExcelChartType.Radar; + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart format + IChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + + //Set radar label visibility + format.HasRadarAxisLabels = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the way the two sections of either a chart or a + chart are split. + + + By default is set to . Here for example, we set + to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["D1"].Text = "Apr"; + sheet.Range["E1"].Text = "May"; + sheet.Range["F1"].Text = "Jun"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["D2"].Value = "20"; + sheet.Range["E2"].Value = "25"; + sheet.Range["F2"].Value = "15"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:F2"]; + + //Set chart type + chart.ChartType = ExcelChartType.PieOfPie; + + //Set chart format + IChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + + //Set split type + format.SplitType = ExcelSplitType.Value; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the threshold value separating the two sections of either a chart or a chart. + + + The following code illustrates how to set for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["D1"].Text = "Apr"; + sheet.Range["E1"].Text = "May"; + sheet.Range["F1"].Text = "Jun"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["D2"].Value = "20"; + sheet.Range["E2"].Value = "25"; + sheet.Range["F2"].Value = "15"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:F2"]; + + //Set chart type + chart.ChartType = ExcelChartType.PieOfPie; + + //Set chart format + IChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + + //Set split type + format.SplitType = ExcelSplitType.Value; + + //Set split value + format.SplitValue = 20; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the size of the secondary section of either a chart or a chart, + as a percentage of the size of the primary pie. ( 5 - 200 ). + + + The following code illustrates how to set for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["D1"].Text = "Apr"; + sheet.Range["E1"].Text = "May"; + sheet.Range["F1"].Text = "Jun"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["D2"].Value = "20"; + sheet.Range["E2"].Value = "25"; + sheet.Range["F2"].Value = "15"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:F2"]; + + //Set chart type + chart.ChartType = ExcelChartType.PieOfPie; + + //Set chart format + IChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + + //Set second pie size + format.PieSecondSize = 40; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the up bars on the chart. Read-only. + + + Up bars connect points on series one with higher values on the last series in the chart group + (the lines go up from series one). Only 2-D line groups that contain at least two series + can have up bars. This object isn't a collection. Theres no object that represents a single up bar; + you either have up bars turned on for all points in a chart group or you have them turned off. + + + The following code illustrates how to access and set for chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Line; + + //Set chart drop bar + IChartDropBar dropBar = chart.Series[0].SerieFormat.CommonSerieOptions.FirstDropBar; + + //Set gap + dropBar.Gap = 90; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the down bars on the chart. Read-only. + + + Down bars connect points on the first series in the chart group with lower values on the last series + (the lines go down from the first series). Only 2-D line groups that contain at least two series + can have down bars. This object isn't a collection. Theres no object that represents a single down bar; + you either have up bars and down bars turned on for all points in a chart group or you have them turned off. + + + The following code illustrates how to access and set for chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Line; + + //Set chart first drop bar + IChartDropBar dropBar = chart.Series[0].SerieFormat.CommonSerieOptions.FirstDropBar; + + //Set gap + dropBar.Gap = 20; + + //Set chart second drop bar + dropBar = chart.Series[0].SerieFormat.CommonSerieOptions.SecondDropBar; + + //Set gap + dropBar.Gap = 20; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the series line properties for or charts. Read-only. + + + The following code illusrates how to set color to property for chart + using property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["D1"].Text = "Apr"; + sheet.Range["E1"].Text = "May"; + sheet.Range["F1"].Text = "Jun"; + sheet.Range["A2"].Value = "5"; + sheet.Range["B2"].Value = "21"; + sheet.Range["C2"].Value = "15"; + sheet.Range["D2"].Value = "12"; + sheet.Range["E2"].Value = "28"; + sheet.Range["F2"].Value = "9"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:F2"]; + + //Set chart type + chart.ChartType = ExcelChartType.PieOfPie; + + //Set pie series line border + IChartBorder border = chart.Series[0].SerieFormat.CommonSerieOptions.PieSeriesLine; + + //Set color + border.ColorIndex = ExcelKnownColors.Red; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets drop lines or hi-low lines or series lines: + 0 = drop lines + 1 = hi-low lines + 2 = series lines (lines used in Pie of Pie and Bar of Pie charts) + + + The following code illustrates how to set for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Value = "Fruits"; + sheet.Range["B1"].Value = "Joey"; + sheet.Range["C1"].Value = "Mathew"; + sheet.Range["D1"].Value = "Peter"; + sheet.Range["A2"].Value = "Apples"; + sheet.Range["B2"].Value = "5"; + sheet.Range["C2"].Value = "3"; + sheet.Range["D2"].Value = "2"; + sheet.Range["A3"].Value = "Grapes"; + sheet.Range["B3"].Value = "4"; + sheet.Range["C3"].Value = "5"; + sheet.Range["D3"].Value = "2"; + sheet.Range["A4"].Value = "Bananas"; + sheet.Range["B4"].Value = "4"; + sheet.Range["C4"].Value = "4"; + sheet.Range["D4"].Value = "3"; + sheet.Range["A5"].Value = "Oranges"; + sheet.Range["B5"].Value = "2"; + sheet.Range["C5"].Value = "1"; + sheet.Range["D5"].Value = "5"; + sheet.Range["A6"].Value = "Melons"; + sheet.Range["B6"].Value = "2"; + sheet.Range["C6"].Value = "7"; + sheet.Range["D6"].Value = "6"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Data being charted on the X axis will move to the Y axis and vice versa + chart.IsSeriesInRows = false; + + //Set range + chart.DataRange = sheet.Range["A1:D6"]; + + //Set chart type + chart.ChartType = ExcelChartType.Stock_HighLowClose; + + //Set chart format + IChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + + //Set drop line style + format.DropLineStyle = ExcelDropLineStyle.HiLow; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Represents High-low lines of Stock and Line Charts. Read-only. + + + The following code illustrates how to get for Stock and Line charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Value = "Fruits"; + sheet.Range["B1"].Value = "Joey"; + sheet.Range["C1"].Value = "Mathew"; + sheet.Range["D1"].Value = "Peter"; + sheet.Range["A2"].Value = "Apples"; + sheet.Range["B2"].Value = "5"; + sheet.Range["C2"].Value = "3"; + sheet.Range["D2"].Value = "2"; + sheet.Range["A3"].Value = "Grapes"; + sheet.Range["B3"].Value = "4"; + sheet.Range["C3"].Value = "5"; + sheet.Range["D3"].Value = "2"; + sheet.Range["A4"].Value = "Bananas"; + sheet.Range["B4"].Value = "4"; + sheet.Range["C4"].Value = "4"; + sheet.Range["D4"].Value = "3"; + sheet.Range["A5"].Value = "Oranges"; + sheet.Range["B5"].Value = "2"; + sheet.Range["C5"].Value = "1"; + sheet.Range["D5"].Value = "5"; + sheet.Range["A6"].Value = "Melons"; + sheet.Range["B6"].Value = "2"; + sheet.Range["C6"].Value = "7"; + sheet.Range["D6"].Value = "6"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Data being charted on the X axis will move to the Y axis and vice versa + chart.IsSeriesInRows = false; + + //Set range + chart.DataRange = sheet.Range["A1:D6"]; + + //Set chart type + chart.ChartType = ExcelChartType.Stock_HighLowClose; + + //Set chart format + IChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + + //Set drop line style + format.DropLineStyle = ExcelDropLineStyle.HiLow; + + //Initialize border and set high-low lines + IChartBorder border = format.HighLowLines; + border.LineColor = System.Drawing.Color.Yellow; + border.LinePattern = ExcelChartLinePattern.Dash; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Represents Drop lines of Stock, Line and Area Charts. Read-only. + + + The following code illustrates how to get for Stock, Line and Area charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Value = "Fruits"; + sheet.Range["B1"].Value = "Joey"; + sheet.Range["C1"].Value = "Mathew"; + sheet.Range["D1"].Value = "Peter"; + sheet.Range["A2"].Value = "Apples"; + sheet.Range["B2"].Value = "5"; + sheet.Range["C2"].Value = "3"; + sheet.Range["D2"].Value = "2"; + sheet.Range["A3"].Value = "Grapes"; + sheet.Range["B3"].Value = "4"; + sheet.Range["C3"].Value = "5"; + sheet.Range["D3"].Value = "2"; + sheet.Range["A4"].Value = "Bananas"; + sheet.Range["B4"].Value = "4"; + sheet.Range["C4"].Value = "4"; + sheet.Range["D4"].Value = "3"; + sheet.Range["A5"].Value = "Oranges"; + sheet.Range["B5"].Value = "2"; + sheet.Range["C5"].Value = "1"; + sheet.Range["D5"].Value = "5"; + sheet.Range["A6"].Value = "Melons"; + sheet.Range["B6"].Value = "2"; + sheet.Range["C6"].Value = "7"; + sheet.Range["D6"].Value = "6"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Data being charted on the X axis will move to the Y axis and vice versa + chart.IsSeriesInRows = false; + + //Set range + chart.DataRange = sheet.Range["A1:D6"]; + + //Set chart type + chart.ChartType = ExcelChartType.Stock_HighLowClose; + + //Set chart format + IChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + + //Set drop line style + format.DropLineStyle = ExcelDropLineStyle.Drop; + + //Initialize border and set drop lines + IChartBorder border = format.DropLines; + border.LineColor = System.Drawing.Color.Yellow; + border.LinePattern = ExcelChartLinePattern.Dash; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if stock, line or area charts has drop lines + + + The following code illustrates how to set drop lines for Stock, Line and Area charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Value = "Fruits"; + sheet.Range["B1"].Value = "Joey"; + sheet.Range["C1"].Value = "Mathew"; + sheet.Range["D1"].Value = "Peter"; + sheet.Range["A2"].Value = "Apples"; + sheet.Range["B2"].Value = "5"; + sheet.Range["C2"].Value = "3"; + sheet.Range["D2"].Value = "2"; + sheet.Range["A3"].Value = "Grapes"; + sheet.Range["B3"].Value = "4"; + sheet.Range["C3"].Value = "5"; + sheet.Range["D3"].Value = "2"; + sheet.Range["A4"].Value = "Bananas"; + sheet.Range["B4"].Value = "4"; + sheet.Range["C4"].Value = "4"; + sheet.Range["D4"].Value = "3"; + sheet.Range["A5"].Value = "Oranges"; + sheet.Range["B5"].Value = "2"; + sheet.Range["C5"].Value = "1"; + sheet.Range["D5"].Value = "5"; + sheet.Range["A6"].Value = "Melons"; + sheet.Range["B6"].Value = "2"; + sheet.Range["C6"].Value = "7"; + sheet.Range["D6"].Value = "6"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Data being charted on the X axis will move to the Y axis and vice versa + chart.IsSeriesInRows = false; + + //Set range + chart.DataRange = sheet.Range["A1:D6"]; + + //Set chart type + chart.ChartType = ExcelChartType.Stock_HighLowClose; + + //Set chart format + IChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + + //Set drop lines + format.HasDropLines = true; + + //Initialize border and set drop lines + IChartBorder border = format.DropLines; + border.LineColor = System.Drawing.Color.Yellow; + border.LinePattern = ExcelChartLinePattern.Dash; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if stock or line charts has high-low lines + + + The following code illustrates how to set high-low lines for Stock and Line charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Value = "Fruits"; + sheet.Range["B1"].Value = "Joey"; + sheet.Range["C1"].Value = "Mathew"; + sheet.Range["D1"].Value = "Peter"; + sheet.Range["A2"].Value = "Apples"; + sheet.Range["B2"].Value = "5"; + sheet.Range["C2"].Value = "3"; + sheet.Range["D2"].Value = "2"; + sheet.Range["A3"].Value = "Grapes"; + sheet.Range["B3"].Value = "4"; + sheet.Range["C3"].Value = "5"; + sheet.Range["D3"].Value = "2"; + sheet.Range["A4"].Value = "Bananas"; + sheet.Range["B4"].Value = "4"; + sheet.Range["C4"].Value = "4"; + sheet.Range["D4"].Value = "3"; + sheet.Range["A5"].Value = "Oranges"; + sheet.Range["B5"].Value = "2"; + sheet.Range["C5"].Value = "1"; + sheet.Range["D5"].Value = "5"; + sheet.Range["A6"].Value = "Melons"; + sheet.Range["B6"].Value = "2"; + sheet.Range["C6"].Value = "7"; + sheet.Range["D6"].Value = "6"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Data being charted on the X axis will move to the Y axis and vice versa + chart.IsSeriesInRows = false; + + //Set range + chart.DataRange = sheet.Range["A1:D6"]; + + //Set chart type + chart.ChartType = ExcelChartType.Stock_HighLowClose; + + //Set chart format + IChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + + //Set high-low lines + format.HasHighLowLines = true; + + //Initialize border and set high-low lines + IChartBorder border = format.HighLowLines; + border.LineColor = System.Drawing.Color.Yellow; + border.LinePattern = ExcelChartLinePattern.Dash; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if pie of pie or bar of pie charts has series lines + + + The following code illusrates how to set series lines for pie of pie and bar of pie charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["D1"].Text = "Apr"; + sheet.Range["E1"].Text = "May"; + sheet.Range["F1"].Text = "Jun"; + sheet.Range["A2"].Value = "5"; + sheet.Range["B2"].Value = "21"; + sheet.Range["C2"].Value = "15"; + sheet.Range["D2"].Value = "12"; + sheet.Range["E2"].Value = "28"; + sheet.Range["F2"].Value = "9"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:F2"]; + + //Set chart type + chart.ChartType = ExcelChartType.PieOfPie; + + //Set chart format + IChartFormat format = chart.Series[0].SerieFormat.CommonSerieOptions; + + //Set series lines + format.HasSeriesLines = true; + + //Set pie series line border + IChartBorder border = chart.Series[0].SerieFormat.CommonSerieOptions.PieSeriesLine; + + //Set color + border.ColorIndex = ExcelKnownColors.Red; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Id for bar stacked chart type. + + + + + Represents default series number. + + + + + Represents the ChartChartFormatRecord + + + + + Represents the chart format of some series. + + + + + Represents chart 3d record. + + + + + Represents format link record. + + + + + Represents data labels record. + + + + + Represents chart chart line record. + + + + + Represents data format record and subrecords. + + + + + Represents stock chart outer shadow. + + + + + Represents first drop bar record and subrecords. + + + + + Represents second drop bar record and subrecords. + + + + + Represents series list record. + + + + + Parent chart object. + + + + + Parent axis object. + + + + + Represents chart Series line properties object + + + + + Represents chart High-low line properties object + + + + + Represents chart Drop line properties object + + + + + Boolean value indicates whether the format is in chart ex type + + + + + Create new instance. + + Current application. + Parent object. + + + + Finds parent objects. + + + + + Parsing chart chart format. + + Records offset. + Position in offset. + + + + Serialize current object. + + Records offset. + + + + Gets start Series type. + + Type to extract. + Returns start Series type. + + + + Changed chart type. + + Type to change. + Indicates whether we are in the process of series creation. + + + + Sets drop lines or hi-low lines or series lines: + 0 = drop lines + 1 = hi-low lines + 2 = series lines (lines used in Pie of Pie and Bar of Pie charts) + + + + + Sets null for some records. + + + + + Changes for chart stock. + + + + + Changes type for stock high low close type. + + + + + Changes type for stock open high low close type. + + + + + Change type for stock volume high low close type in primary axis. + + + + + Change type for stock volume high low close type in secondary axis. + + + + + Change type for stock volume open high low close type. + + + + + Changes Series type. + + Type to change. + Indicates whether we are in the process of series creation. + + + + Change Series type as one kind of doughnut. + + Type to change. + + + + Change Series type to one kind of bubble. + + Type to change. + Indicates whether we are in the process of series creation. + + + + Updates bubble series. + + Represents series collection. + + + + Change Series type as one kind of surface. + + Type to change. + Indicates whether we are in the process of series creation. + + + + Change Series type as one kind of radar. + + Type to change. + + + + Change Series type as one kind of bar clustered. + + Type to change. + + + + Change Series type as one kind of bar stacked. + + Type to change. + + + + Change Series type as one kind of line. + + Type to change. + + + + Change Series type as one kind of pie. + + Type to change. + + + + Change Series type as one kind of area. + + Type to change. + + + + Change Ticklabelposition value + + value from HasRadarAxisLabels property + + + + Change Series type as one kind of scatter. + + Type to change. + + + + Changes Series type for Cylinder or Pyramid, Cone. + + Type to change. + + + + Clones current object. + + Parent object for clone. + Returns just cloned object. + + + + Equal operator for two chart formats. + + + + + + + + Not Equal operator for two chart formats. + + + + + + + + Initialize the high-low lines,drop bar for stock chart at parsing + + + + + cloning the removed format from collection + + Parent object for clone + format to be cloned + If true clone the dataformat,else clone others + + + + Check on formats and apply the chart type by the formats + + the chart type on formats + + + + Gets or sets a boolean value indicating whether to vary color for each data point. + + + + + Gets or sets a boolean value indicating whether to vary color for each data point. + + + + + Returns data format. Read-only. + + + + + Gets or sets the space between the bars/columns. Can be a value between -100 and 100. + + Applies only to 2-D bar and 2-D column charts. + + + + + True for horizontal bars (bar chart). + False for vertical bars (column chart). + + + + + Stack the displayed values. + + + + + Each category is displayed as a percentage. + + + + + True if this bar has a shadow; otherwise False. + + + + + Stack the displayed values. + + + + + Each category is broken down as a percentage. + + + + + True if this line has a shadow. + + + + + + Gets or sets the size of the hole in a dough-nut chart. + The hole size is expressed as a percentage of the chart size, between 10 and 90 percent. + + + + + True if this pie has a shadow. + + + + + True to show leader lines to data labels. + + + + + Gets or sets the scale factor for bubbles. Can be an integer value from 0 to 300, + corresponding to a percentage of the default size. + + + + + Gets or sets a value indicating what the bubble size represents on a bubble chart. + + + + + True if this a bubble series. + + + + + True to show negative bubbles on bubble chart. otherwise False. + + + + + True if bubble series has a shadow. + + + + + Series in this group are stacked. + + + + + Each category is broken down as a percentage. + + + + + This area has a shadow. + + + + + True if chart contains color fill for surface. + + + + + True if this surface chart has shading. + + + + + True if this radar series has a shadow. + + + + + True if a radar chart has axis labels. otherwise False. Applies only to radar charts. + + + + + 0 = normal pie chart + 1 = pie of pie chart + 2 = bar of pie chart + + + + + True to use default split value; otherwise False. + + + + + Gets or sets the way the two sections of either a pie of pie chart or a bar + of pie chart are split. + + + + + Gets or sets the threshold value separating the two sections of either a pie of pie chart or a bar of pie chart. + + + + + For split = 2, what percentage should go to the other pie / bar. + + + + + Gets or sets the size of the secondary section of either a pie of pie chart or a bar of pie chart, + as a percentage of the size of the primary pie. ( 5 - 200 ). + + + + + Space between the first pie and the second. + + + + + For split = 1, what values should go to the other pie / bar. + + + + + 1 = the second pie / bar has a shadow. + + + + + If true Series has name. + + + + + If true category has name. + + + + + If true has value. + + + + + If true has percentage. + + + + + If true bubble has size. + + + + + Returns delimiter length. + + + + + Represents delimiter. + + + + + Gets or sets drop lines or hi-low lines or series lines: + 0 = drop lines + 1 = hi-low lines + 2 = series lines (lines used in Pie of Pie and Bar of Pie charts) + + + + + Gets or sets drop lines or hi-low lines or series lines: + 0 = drop lines + 1 = hi-low lines + 2 = series lines (lines used in Pie of Pie and Bar of Pie charts) + + + + + Gets the up bars on the line chart. Read-only. + + + Up bars connect points on series one with higher values on the last series in the chart group + (the lines go up from series one). Only 2-D line groups that contain at least two series + can have up bars. This object isnt a collection. There's no object that represents a single up bar; + you either have up bars turned on for all points in a chart group or you have them turned off. + + + + + Gets the down bars on the line chart. Read-only. + + + Down bars connect points on the first series in the chart group with lower values on the last series + (the lines go down from the first series). Only 2-D line groups that contain at least two series + can have down bars. This object isnt a collection. There's no object that represents a single down bar; + you either have up bars and down bars turned on for all points in a chart group or you have them turned off. + + + + + Gets the series line properties for pie of pie or pie of bar charts. Read-only. + + + + + Returns or sets the rotation of the 3-D chart view + (the rotation of the plot area around the z-axis, in degrees).(0 to 360 degrees). + + + + + Indicates whether rotation has default value. + + + + + Returns or sets the elevation of the 3-D chart view, in degrees (-90 to +90 degrees). + + + + + Indicates whether elevation has default value. + + + + + Returns or sets the perspective for the 3-D chart view.( 0 - 100 ) + + + + + Returns or sets the height of a 3-D chart as a percentage of the chart width + (between 5 and 500 percent). + + + + + Returns or sets the depth of a 3-D chart as a percentage of the chart width + (between 20 and 2000 percent). + + + + + Returns or sets the distance between the data series in a 3-D chart, as a percentage of the marker width.( 0 - 500 ) + + + + + True if the chart axes are at right angles, independent of chart rotation or elevation. + + + + + 3D columns are clustered or stacked. + + + + + Gets / Sets the chart type is chart ex or ot + + + + + True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart.. + + + + + True if gridlines are drawn two-dimensionally on a 3-D chart. + + + + + Try to convert m_serieFormat to chartBarRecord. + If can - returns chartBarRecord; otherwise rise exception. Read-only. + + + + + Try to convert m_serieFormat to chartLineRecord. + If can - returns chartLineRecord; otherwise rise exception. Read-only. + + + + + Try to convert m_serieFormat to chartPieRecord. + If can - returns chartPieRecord; otherwise rise exception. Read-only. + + + + + Try to convert m_serieFormat to chartScatterRecord. + If can - returns chartScatterRecord; otherwise rise exception. Read-only. + + + + + Try to convert m_serieFormat to chartAreaRecord. + If can - returns chartAreaRecord; otherwise rise exception. Read-only. + + + + + Try to convert m_serieFormat to chartSurfaceRecord. + If can - returns chartSurfaceRecord; otherwise rise exception. Read-only. + + + + + Try to convert m_serieFormat to chartRadarRecord. + If can - returns chartRadarRecord; otherwise rise exception. Read-only. + + + + + Try to convert m_serieFormat to chartRadarAreaRecord. + If can - returns chartRadarAreaRecord; otherwise rise exception. Read-only. + + + + + Try to convert m_serieFormat to chartBoppopRecord. + If can - returns chartBoppopRecord; otherwise rise exception. Read-only. + + + + + Returns data labels record. Read-only. + + + + + Returns chart data format. Read-only. + + + + + Returns chart chart format. Read-only. + + + + + Returns Chart3d record. Read-only. + + + + + If true then belong to primary axis; otherwise to secondary axis. + + + + + If true - format contains chart chart line record. Read-only. + + + + + If true - format contains line. Read-only. + + + + + If true - format contains drop bar record. Read-only. + + + + + Returns record that represents Series format. Read-only. + + + + + Drawing order (0 = bottom of the z-order). + + + + + Represents type code of major format record type. Read-only. + + + + + If true - Series 3D; otherwise Series 2D. Read-only. + + + + + Returns dataformat or null; Read-only. + + + + + If true - format has marker; otherwise false. Read-only. + + + + + If true - format has line; otherwise false. Read-only. + + + + + If true - format has smoothed line; otherwise false. Read-only. + + + + + Represents High Low line properties. ( For stock and line charts) + + + + + Represents High-low lines of Stock and Line Charts. Read-only. + + + + + Represents Drop lines of Stock, Line and Area Charts. Read-only. + + + + + True if stock, line or area charts has drop lines + + + + + True if stock or line charts has high-low lines + + + + + True if pie of pie or bar of pie charts has series lines + + + + + Gets or sets the outer shadow for stock chart. + + + + + Class provide the options for Box and Whisker series + + + + + It provide the options used for Box and Whisker series + + + + + Indicates whether the show mean line option is enabled + Bit position - 0 + + + + + Indicates whether the show mean marker option is enabled + Bit position - 1 + + + + + Indicates whether the show inner points option is enabled + Bit position - 2 + + + + + Indicates whether the show outlier points option is enabled + Bit position - 3 + + + + + Indicates quartile calculation is exclusive or inclusive + Bit position - 4 + + + + + Gets / Sets the options for the charts + + + + + Class provide the options for Histogram and Pareto Chart axis + + + + + byte value used as flag and boolean property for the values + + + + + Indicates the number of bins in the axis + + + + + Indicates the bin width for axis + + + + + Indicates the overflow bin value + + + + + Indicates the underflow bin value + + + + + Indicates whether the underflow value set or not. + + + + + Reset the member values respect to input value + + Input Bit position changed + + + + Clones the value from input object + + input object + + + + Check for the equals an object + + input another histogram object + the boolean value indicates whether the objects are equal or not. + + + + Get or Set the is Automatic Bin member value + Bit Position - 0 + + + + + Get or Set the isBinning by Category member value + Bit position - 1 + + + + + Get or Set the Bin width member value + flag Bit position - 2 + + + + + Get or Set the number of Bins member value + Flag Bit position - 3 + + + + + Get or Set the overflow bin member value + Flag Bit Position - 4 + + + + + Get or Set the underflow bin member value + Flag Bit position - 5 + + + + + Get or Set the value for interval is closed in left or right + Flag Bit position - 6 + + + + + Byte value shows the options used in this class + + + + + Get or Set the value for automatic value has been used in overflow + Flag Bit position - 7 + Used only in parsed workbook + + + + + Get or Set the value for automatic value has been used in underflow + Used only in parsed workbook + + + + + Represent the borders and layout options of the chart elements. + + + + + Represent the borders and layout options of the chart elements. + + + + + + Gets or sets the rectangle style for the chart element. + + + The RectangleStyle property works on Binary Excel format only. To know more about charts refer this link. + + The following code illustrates use of RectangleStyle property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the rectangle style for the chart element + chart.PlotArea.RectangleStyle = ExcelRectangleStyle.Shadowed; + + workbook.SaveAs("Charts.xls"); + workbook.Close(); + } + + + + + + True if the chart area has rounded corners. otherwise False. + + + This property works only on chart Area. To know more about charts refer this link. + + The following code illustrates use of IsBorderCornersRound property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //True if the chart area has rounded corners + IChartFrameFormat chartArea = chart.ChartArea; + chartArea.IsBorderCornersRound = true; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets the border of the chart element. Read-only. + + + To know more about charts refer this link. + + The following code illustrates use of Border property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //border of the chart element + chart.ChartTitleArea.Text = "Sample Chart"; + chart.ChartTitleArea.FrameFormat.Border.LineColor = System.Drawing.Color.Red; + chart.ChartTitleArea.FrameFormat.Border.LinePattern = ExcelChartLinePattern.DashDotDot; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the layout settings of chart text area. + + + To know more about charts refer this link. + + The following code illustrates use of Layout property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the layout settings of plot area + chart.PlotArea.Layout.Height = 300; + chart.PlotArea.Layout.Width = 430; + chart.PlotArea.Layout.Top = 40; + chart.PlotArea.Layout.Left = 10; + chart.PlotArea.Layout.LayoutTarget = LayoutTargets.inner; + chart.PlotArea.Layout.LeftMode = LayoutModes.edge; + chart.PlotArea.Layout.TopMode = LayoutModes.factor; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Chart frame. + + + + + Represents chart border. + + + + + Represents the 3D features + + + + + Represents chart interior. + + + + + Represents the beginning of a collection of records + + + + + Represents the shape formatting properties for chart elements + + + + + Represents the end of a collection of records + + + + + Represents Shadow + + + + + Represents fill format. + + + + + Parent chart. + + + + + Represents Excel 2007 layout data. + + + + + Plot area layout + + + + + Creates chart and sets its Application and Parent + properties to specified values. + + Application object for the chart. + Parent object for the chart. + + + + Creates chart and sets its Application and Parent + properties to specified values. + + Application object for the chart. + Parent object for the chart. + Indicates whether we should set defaults for fill and border properties. + + + + Creates chart and sets its Application and Parent + properties to specified values. + + Application object for the chart. + Parent object for the chart. + Indicates is auto size. + Indicates is interior is gray. + Indicates whether we should set defaults for fill and border properties. + + + + Creates and parses current object. + + Application object for the chart. + Parent object for the chart. + Records storage. + Position in storage. + + + + Searches for all necessary parent objects. + + + + + Parses frame. + + Array with frame records. + Position of the frame records. + + + + Parses frame. + + Array with frame records. + Position of the frame records. + Position of the frame records. + + + + Checks whether specified record is begin. + + Record to check. + True if this is begin; false otherwise. + + + + Parses single record. + + Record to parse. + Number of not closed begin record. + + + + Saves chart frame as biff records. + + OffsetArrayList that will get biff records. + + + + Serializes single record. + + OffsetArrayList that will get biff records. + Record to serialize. + + + + Unwraps record. + + Record to unwrap. + Unwrapped record. + + + + Set variable to the default state. + + Indicates whether MS Excel should calculate size of the frame. + Indicates is default interior is gray. + + + + Updates known colors. + + Color to update. + Returns updated color. + + + + Clears the plot area. + + + + + Clone current Record. + + Parent object. + Returns clone of current object. + + + + Gets frame record. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + Gets or sets the layout settings of chart text area. + + + + + This property indicates whether interior object was created. Read-only. + + + + + This property indicates whether border formatting object was created. Read-only. + + + + + Gets the border of the chart element. Read-only. + + + + + Represents frame interior. Read-only + + + + + Gets the chart3 D properties. + + The chart3 D properties. + + + + Represents fill gradient format. Read-only. + + + + + This property indicates whether the shadow object has been created + + + + + This property Indicates whether the Shadow object has been created(which includes the 3D properties) + + + + + Gets the shadow properties. + + The shadow properties. + + + + Gets or sets the rectangle style for the chart element. + + + + + Microsoft Excel calculates size. + + + + + Microsoft Excel calculates position. + + + + + True if the chart area has rounded corners. otherwise False. + + + + + Represents chart border. Read-only. + + + + + Represents foreground color. + + + + + Represents background color. + + + + + Represents pattern. + + + + + Represents if use automatic format. + + + + + Represents visibility. + + + + + Contains primary parent axis, secondary parent axis. + + + + + + + + + + + + + + + Represents primary parent axis. + + + + + Represents secondary parent axis. + + + + + Default constructor. + + + + + Creates object and initializes collections. + + Application object. + Parent object for primary collection. + Parent object for secondary collection. + + + + Parses ChartAxisParent record. + + Array of records containing record. + Position of the record to parse. + + When specified record is not ChartAxisParent record. + + + + + Serializes chart axes. + + + OffsetArrayList that will receive all records. + + + + + If can - removes format. + + Format to remove. + + + + Creates format collection. + + Application object. + Parent object for collection. + If true - primary collection; otherwise - secondary. + + + + Changes primary and secondary format collections. + + + + + Helper methods for adding new formats. + + Format to add. + Format order. + Format index. + If true - adds in primary format; otherwise - in secondary. + + + + + Removes format from collection. + + Index to remove. + Order to remove. + If true - removes in primary collection; otherwise - secondary. + + + + Returns collection by parameter. + + If true - returns primary collection; otherwise - secondary. + Returns one of collection. + + + + Clones current instance. + + Parent for primary collection. + Returns just cloned method. + + + + Clones secondary collection. + + Global collection. + Parent object. + + + + Detects chart type. + + Chart series collection. + Returns chart type. + + + + Detects chart type by primary formats only. + + Chart series collection. + Returns chart type. + + + + Clears all format collections. + + + + + Changes not intimate types. + + Type to change. + Current Series type. + Application object. + Chart object. + Returns format for current type. + + + + Change format in axis. + + If true - changes format to primary. otherwise - to secondary. + Format order. + If true - standard add; otherwise - shallow. + Represents new order. + + + + Changes format in axis collection. + + Collection from format gets. + Collection to format sets. + Formats order. + New order to set. + IF true - standard add; otherwise - shallow. + + + + Represents primary format collection. Read-only. + + + + + Represents secondary format collection. Read-only. + + + + + Represent grid lines of the chart. + + + + + Represent grid lines of the chart. + + + + + Clears the chart grid lines. + + + The following code illustrates how to delete the for + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Deleting the major gridlines of value axis + chart.PrimaryValueAxis.MajorGridLines.Delete(); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the grid line border. Read-only. + + + The following code illustrates how to access and format the for + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set value axis minor gridLines to visible + chart.PrimaryValueAxis.HasMinorGridLines = true; + + //Get value axis minor gridlines + IChartGridLine gridLine = chart.PrimaryValueAxis.MinorGridLines; + + //Set minor gridlines broder properties + gridLine.Border.ColorIndex = ExcelKnownColors.Red; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Represents default color index. + + + + + Represents axis line record. + + + + + Represents parent axis. + + + + + Represents Shadow + + + + + Represents parent book. + + + + + Represents chart border. + + + + + Represents the 3D features + + + + + Creates ChartGridLine object. + + Application object. + Parent object. + Represents type of axisline record. + + + + Creates ChartGridLine object. Only for parsing. + + Application object. + Parent object. + Represents records storage. + Represents position in storage. + + + + Finds all parent objects. + + + + + Parses GridLine records. + + Offset array list. + Current position in offset array list. + + + + Serializes Grid lines. + + OffsetArrayList that will receive all records. + + + + Clears the chart grid lines. + + + + + Clones current object. + + Parent object. + Returns cloned object. + + + + Gets line border. Read-only. + + + + + Gets line border. Read-only. + + + + + This property indicates whether line formatting object was created. Read-only. + + + + + Represents the Shadow.Read-only + + + + + This property indicates whether the shadow object has been created + + + + + Gets the chart3 D options. + + The chart3 D options. + + + + This property Indicates whether the Shadow object has been created(which includes the 3D properties) + + + + + This property indicates whether interior object was created. Read-only. + + + + + Returns object, that represents area properties. Read-only. + + + + + Represents fill options. Read-only. + + + + + Gets or sets axis line type. + + + + + Returns parent axis. Read-only. + + + + + Represents a chart sheet in the workbook. + + + + + Base class for all worksheet objects (objects that have own tab in the workbook) + like worksheets and charts. + + + + + Supports parsing, which parses internal records and creates necessary objects. + + + + + Parses internal records. + + + + + Maximum length of the password. + + + + + Default password hash value. + + + + + Min column index. + + + + + Min row index. + + + + + Default tab color. + + + + + Maximum one-based index of the row. + + + + + Maximum one-based index of the column. + + + + + Maximum allowed worksheet name length. + + + + + Values of all options, helps to switch all enum to ExcelSheetProtection.All enum value. + + + + + Records that do not belong to mso part of the worksheet. + + + + + Default tab color. + + + + + Represents a boolean value to parse worksheets on demand + + + + + Represents to parse sheet on demand + + + + + Parent workbook. + + + + + Worksheet's name. + + + + + Indicates whether worksheet was changed and need saving. + + + + + Real worksheet's index in the workbook. + + + + + Starting index for Mso record. + + + + + Current index of the mso drawing object. + + + + + Parse options. + + + + + List with all mso drawing records in the worksheet. + + + + + List in which all records which belong to worksheet are stored. + + + + + Collection with all shapes in the worksheet. + + + + + Charts collection. + + + + + Collection of all pictures in the worksheet. + + + + + True - indicates that record extracted from stream can be used, by this + implementation, otherwise False. + + + + + Zoom of the current window. + + + + + Represents sheet protection record. + + + + + Represents Range Protection Record + + + + + Describes password entered by user to protect worksheet's data. + + + + + Code name. + + + + + Indicates whether worksheet was parsed. + + + + + Indicates whether object is currently being parsed. + + + + + Indicates whether to skip parsing. + + + + + Window two record. + + + + + Pagelayout view record. + + + + + One field from Worksheet dimension records. + + + + + One field from Worksheet dimension records. + + + + + One field from Worksheet dimension records. + + + + + One field from Worksheet dimension records + + + + + Index of the tab color. + + + + + Contains images used in header and footer. + + + + + Worksheet index. + + + + + Represents sheet protection for support old version. Using for parsing. + + + + + BOF record that will be serialized. + + + + + Indicates whether to keep record inside of internal storage. + + + + + Visibility of worksheet. + + + + + Data holder for 2007 Excel. + + + + + Indicates whether worksheet contains some unknown vml shapes. + + + + + Collection with all textboxes. + + + + + Collection with all checkboxes. + + + + + Collection with all OptionButton. + + + + + Collection with all comboboxes. + + + + + Custom height + + + + + + + + + + Collection of worksheet's error indicators. + + + + + Alogrithm name to protect/unprotect worksheet. + + + + + Hash value to ensure the sheet protected password. + + + + + Random generated Salt for the sheet password. + + + + + Spin count to loop the hash algorithm. + + + + + Represents the name of the shared background image + + + + + Stores the sheet layout option values + + + + + Initializes new instance and sets its application and parent properties. + + Application object for the new instance. + Parent object for the new instance. + + + + Initializes new instance and sets its application and parent properties. + + Application object for the new instance. + Parent object for the new instance. + BiffReader to extract data from. + Parse options. + Indicates whether to skip parsing. + + Dictionary with new extended format indexes for ignore styles mode. + + Object used to decrypt encrypted records. + + + + Add a Vba code module to the worksheet. + + + + + + Code name changes event + + sender + Code name + + + + Clears NameChanged event. + + + + + Returns true if visible sheet found. Also sets active sheet index and display tab. + + Workbook objects collection + Object index. + True if visible sheet found + + + + Searches for all necessary parent objects. + + + + + This method is called when Name of the worksheet was changed. + + Event arguments. + + + + This method raises NameChanged event. + + Event arguments. + + + + This method should be called after any changes in the worksheet. + Sets Saved property of the parent workbook to false. + + + + + Initializes all required collections. + + + + + Clear all internal collections but excluding mentioned flags. + + Allows to avoid clearing of some properties. + + + + Makes the current sheet the active sheet. + + Calling this method is equivalent to clicking the + sheet's tab in MS Excel. + + + + Selects current tab sheet. + + + + + Unselects current tab sheet if possible. + + + + + Unselects current tab sheet if possible. + + Indicates whether to allow unselect last sheet. + + + + Protects worksheet with password. + + Protection password. + + If worksheet is already protected. + + + If specified password is null. + + + If length of the password is more than 15 symbols. + + + + + Protects current worksheet. + + Represents password to protect. + Represents params to protect. + + + + Prepares protection options before setting protection. + + + + + + + Unprotects this worksheet without password. + + + + + Unprotects this worksheet using specified password. + + Password to unprotect. + + + + This method is called after RealIndex property change. + + Old index. + + + + Adds sheet tab to the selected tab. + + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + This method should be called immediately after extended format removal. + + Dictionary with updated extended formats. + + + + Creates copy of the current object. + + Parent object for the new object. + Copy of the current object. + + + + Creates copy of the current object and indicates whether we should copy the shapes or not. + + Parent object for the new object. + Indicates whether we should clone shapes or not. + Copy of the current object and indicates whether we should copy the shapes or not + + + + Create copy of the shapes collection inside specified worksheet object. + + Object to put shapes into. + + + + Updates style indexes. + + Array with changed style indexes. + + + + Protects worksheet. + + Password hash to use for protection. + Protection options. + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Method extracts biff records belonging to the worksheet. + + BiffReader that contains worksheet's records. + Parse options. + Indicates whether to skip parsing. + + Dictionary with new extended format indexes for ignore styles mode. + + Object used to decrypt encrypted records. + + + + Prepares protection variables. + + + + + Extracts next record from reader and parses it. + + Reader to extract record from. + Number of BOF records without closing EOF record. + Indicates whether styles information must be skipped. + Parsing options. + + Dictionary with new extended format indexes for ignore styles mode. + + Object used to decrypt encrypted records. + Updated number of BOF records without closing EOF record. + + + + Parses Protect record. + + Record to parse. + + + + Parses Password record. + + Record to parse. + + + + Parse ObjectProtect record. + + Record to parse. + + + + Parse ScenProtect record. + + Record to parse. + + + + Prepares variables to worksheet parsing. + + Parse options. + Indicates whether to skip parsing. + + + + Parse pagelayoutview + + Record to parse. + + + + Parse WindowTwo record. + + Record to parse. + + + + Parses single record. + + Record to parse. + Indicates whether to ignore styles. + + Dictionary with new extended format indexes for ignore styles mode. + + + + + Parses dimensions record. + + Record to parse. + + + + Parses WindowZoom record. + + Record to parse. + + + + Parses sheet layout record. + + Record to parse. + + + + Serializes records. + + Records to be serialized. + + + + Saves all shapes. + + List to save records into. + + + + Saves protection block. + + List to save records into. + + + + Serialize sheet protection. + + Represents record storage. + + + + Serializes header / footer pictures. + + List to save records into. + + + + Serializes WindowTwo record. + + List to save records into. + + + + Serializes page layout view + + List to save records into. + + + + Serializes macros support. + + List to save records into. + + + + Serializes WindowZoom. + + List to save records into. + + + + Serializes sheet layout record. + + List to save records into. + + + + Returns hash value for the password string. + + Password to hash. + Hash value for the password string. + + + + Converts character to 15 bits sequence + + Character to convert. + Array of values indicating 15 bit sequence. + + + + Converts bits array to UInt16 value. + + Array to convert. + Converted UInt16 value. + + + + Rotates (cyclic shift) bits in the array specified number of times + + Array to rotate + Number of times to rotate + Rotated array. + + + + Rounds value. + + Value to be rounded. + Represents degree used to round the given value. + Rounded value. + + + + Parses internal records. + + + + + Parses worksheet's data. + + + + + Parses worksheet's data. + + + + + Parses worksheet's data. + + + + + Extracts MsoDrawing records from internal array. + + Index to the first MsoDrawing record. + Parse options. + + + + Combines all MsoBase records into one array. + + Array of records. + + + + Extracts client data for mso records. + + Array of records. + + + + Combines several byte arrays into one. + + Size of the combined data. + List that contains byte arrays to combine. + Combined array. + + + + Copies all data from another worksheet. + + Parent worksheet. + Dictionary with style names. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Copy flags. + + Dictionary with extended format indexes, key - old index, value - new index. + + + + + Copies preserved header/footer images. + + Source worksheet. + Hash with new WorkSheet names. + Dictionary with new font indexes. + + + + Copies all shapes from a source worksheet. + + Source worksheet. + Hash with new WorkSheet names. + Dictionary with new font indexes. + + + + Copies different sheet options. + + Source sheet. + + + + Checkes whether the code name exist in the workbook + + Name getter + Code name + + + + + Generates unique name for the parent collection + + Name getter. + Proposed name + Generated unique name. + + + + Gets code name of the tabsheet. + + Tabsheet to get name from. + Code name of the tabsheet. + + + + Gets name of the tabsheet. + + Tabsheet to get name from. + Name of the tabsheet. + + + + Copies tab color from another worksheet. + + Worksheet to copy tab color from. + + + + Checks the worksheet for parse on demand load + + + + + Dispose + + + + + Protects the worksheet based on the Excel 2013. + + Password to generate the hash value. + + + + Creates random salt. + + Desired salt length. + Array with random data. + + + + This method is called during dispose operation of chart. + + + + + Worksheet Vba code module + + + + + Returns or sets the name of the object. Read / write String. + + + + + Indicates whether worksheet was saved. + + + + + Returns comments collection for this worksheet. Read-only. + + + + + Returns pictures collection. Read-only. + + + + + Returns embedded charts collection. Read-only. + + + + + Returns shapes collection. Read-only. + + + + + Gets shape collection in the worksheet. + + + + + Returns InnerShapes base collection. + + + + + Header / footer shapes collection. + + + + + Header / footer shapes collection. + + + + + Gets a Comments collection that represents all the comments for the worksheet. + + + + + Gets charts collection in the worksheet. Read-only. + + + + + Gets pictures collection in the worksheet. Read-only. + + + + + This event is raised after code name changed. + + + + + Name used by macros to access workbook items. Read-only. + + + + + Sheet window settings. + + + + + Indicates is current sheet is protected. + + + + + True if objects are protected. Read-only. + + + + + True if the scenarios of the current sheet are protected. Read-only. + + + + + Gets a value indicating whether worksheet is protected with password. + + + + + Indicates whether object was parsed. + + + + + Indicates whether object is currently being parsed. + + + + + Indicates whether worksheet was opened in skip parsing mode. Read-only. + + + + + Indicates whether worksheet type is supported. Read-only. + + + + + Gets parent workbook. Read-only. + + + + + Gets or sets one-based index of the first row of the worksheet. + + + + + Gets or sets one-based index of the first column of the worksheet. + + + + + Gets or sets one-based index of the last row of the worksheet. + + + + + Gets or sets one-based index of the last column of the worksheet. + + + + + Gets or sets the value that represents zoom factor of document. Value must be in range from 10 till 400. + + + + + Gets Tab color object. + + + + + Gets or Sets Tab color. + + + + + Gets or Sets Tab color RGB. + + + + + Gets or sets the color of the Grid line in the worksheet. + + + + + Indicates whether gridline color has default value. + + + + + Get parent workbook of current worksheet. + + + + + Indicates whether worksheet is displayed right to left. + + + + + Return page setup. Read-only. + + + + + Indicates whether tab of this sheet is selected. Read-only. + + + + + Gets the index number of the worksheet within the collection of + worksheet. Read-only. + + + + + Gets protected options. Read-only. To set protection options use "Protect" method. + + + + + Gets protected options. Read-only. For sets protection options use "Protect" method. + + + + + Returnd unprotected options + + + + + Returns internal BOF record. Read-only. + + + + + Controls end user visibility of worksheet. + + + + + Gets / sets worksheet data holder. + + + + + Gets or sets the top visible row of the worksheet. + + + + + Gets or sets the left visible column of the worksheet. + + + + + Describes password entered by user to protect worksheet's data. + + + + + Indicates whether worksheet contains some unknown vml shapes. + + + + + Gets inner textboxes collection. Read-only. + + + + + Gets inner textboxes collection. Read-only. + + + + + Gets inner textboxes collection. Read-only. + + + + + Returns inner checkboxes collection. Read-only. + + + + + Returns inner checkboxes collection. Read-only. + + + + + Returns inner comboboxes collection. Read-only. + + + + + Returns checkboxes collection for this sheet. Read-only. + + + + + Gets inner checkboxes collection in the sheet. Read-only. + + + + + Gets inner option buttons collection in the sheet. Read-only. + + + + + Gets inner combo boxes collection in the sheet. Read-only. + + + + + Indicates whether tabsheet contains any picture. Read-only. + + + + + Indicates whether tabsheet has charts. Read-only. + + + + + Indicates whether worksheet has vml shapes. Read-only. + + + + + Returns number of known vml shapes. Read-only. + + + + + Gets default protection options for the worksheet. + + + + + Indicates whether Protection property is direct (specified items are + protected) or indirect (specified items are unprotected). + + + + + Inidicates whether protection should be serialized. + + + + + Returns sheet protection record. + + + + + Gets or sets IsTransitionEvaluation + + + + + Gets or Sets a boolean value to parse worksheets on demand + + + + + Gets or sets the boolean value to load worksheets on demand + + + + + Alogrithm name to protect/unprotect worksheet. + + + + + Hash value to ensure the sheet protected password. + + + + + Random generated Salt for the sheet password. + + + + + Spin count to loop the hash algorithm. + + + + + This event is raised when name of the worksheet is changed. + + + + + Index of the worksheet in the workbook + (not necessary in Worksheets collection) + + + + + Returns index in the parent ITabSheets collection. Read-only. + + + + + Delegate to be used for getting name information from the worksheet. + + Worksheet to get name from. + Extracted name. + + + + Represents a chart sheet in the workbook. + + + + + Converts the chart to image stream. + + Stream object where the image is streamed. + + The following code illustrates how a chart in the worksheet/workbook can be converted to an image. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart to image converter + application.ChartToImageConverter = new Syncfusion.ExcelChartToImageConverter.ChartToImageConverter(); + application.ChartToImageConverter.ScalingMode = ScalingMode.Best; + + //Save as image + MemoryStream stream = new MemoryStream(); + chart.SaveAsImage(stream); + System.Drawing.Image image = System.Drawing.Image.FromStream(stream); + image.Save("Output.png"); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the chart type. + + + By default the is set to . Here for example, we set + to property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = workbook.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Pyramid_Stacked; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the data range for the chart series. + + + If we want to give data for the chart series directly then we can use and + properties. To know more about giving data directly to series refer + Creating a Chart from directly entered Values. + + + The following code illustrates how to set the data range for the chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = workbook.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True to swap the data in over the axis. Series data is charted on the Y axis by default. + + Data being charted on the X axis will move to the Y axis and vice versa. + + The following code illustrates how to set property for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set IsSeriesInRows + chart.IsSeriesInRows = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the title of the chart. + + + The following code illustrates how to set the title for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set title + chart.ChartTitle = "Sample Chart"; + + //Set position + chart.XPos = 250; + chart.YPos = 30; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the area for chart title. Read-only. + + + To apply formats for chart title area we can use property to access . Here for example, + we access and set . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart area + IChartTextArea textArea = chart.ChartTitleArea; + + //Set text + textArea.Text = "Sample Chart"; + textArea.Size = 20; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the page setup for the chart. Read-only. + + + The following code illustrates how to set paper size. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = workbook.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart page setup + IChartPageSetup pageSetup = chart.PageSetup; + + //Set paper size + pageSetup.PaperSize = ExcelPaperSize.A3TransversePaper; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the X coordinate of upper-left corner of the chart in points (1/72 inch). + + + The following code illustrates how to set X coordinate of upper-left corner of the charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.Height = 300; + chart.Width = 300; + + //Set position + chart.XPos = 250; + chart.YPos = 30; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the Y coordinate of upper-left corner of the chart in points (1/72 inch). + + + The following code illustrates how to set Y coordinate of upper-left corner of the charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.Height = 300; + chart.Width = 300; + + //Set position + chart.XPos = 250; + chart.YPos = 30; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the width of the chart in points (1/72 inch). + + + To know more about resizing chart and chart elements refer Resizing Chart. + + + The following code illustrates how and for the chart can be set. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart height and width + chart.Height = 300; + chart.Width = 300; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the height of the chart in points (1/72 inch). + + + To know more about resizing chart and chart elements refer Resizing Chart. + + + The following code illustrates how and for the chart can be set. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart height and width + chart.Height = 300; + chart.Width = 300; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the collection of the chart. Read-only. + + + The following code illustrates how to access the collection of a chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = workbook.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Chart series + IChartSeries series = chart.Series; + + //Check count + Console.WriteLine(series.Count); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //1 + + + + + + Gets the primary category axis of the chart. Read-only. + + + Charts are plotted using X and Y axes. The Y axes typically have numerical scales, whereas the X axes typically have categorical scales. + Some charts, for example, have axes, and others, like PieChart don't. + Most charts have horizontal axis of type and vertical axis of type + but some, like BarChart, have the opposite. + represents an axis used for categories. Categories can include string, numeric, and date values. + + The following code illustrates how to set the visibility of . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Chart category axis + IChartCategoryAxis categoryAxis = chart.PrimaryCategoryAxis; + + //Set visibility + categoryAxis.Visible = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the primary value axis. Read-only. + + + Charts are plotted using X and Y axes. The Y axes typically have numerical scales, whereas the X axes typically have categorical scales. + Some charts, for example, have axes, and others, like PieChart don't. + Most charts have horizontal axis of type and vertical axis of type + but some, like BarChart, have the opposite. + represents an axis used for series values. + + The following code illustrates how to set visibility of . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Chart value axis + IChartValueAxis valueAxis = chart.PrimaryValueAxis; + + //Set visibility + valueAxis.Visible = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the primary series axis. Read-only. + + This is the depth axis showing the depth of the third dimension in 3D charts. + + The following code illustrates how to set visibility of . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Surface_3D; + + //Chart value axis + IChartSeriesAxis seriesAxis = chart.PrimarySerieAxis; + + //Set visibility + seriesAxis.Visible = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the secondary category axis of the chart. Read-only. + + + The most commonly used charts have a set of primary axes and may have a set of secondary axes. + You can enable and disable this through property. + + + The following code illustrates how to disable and set for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "100"; + sheet.Range["B3"].Value = "200"; + sheet.Range["C3"].Value = "300"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set secondary axis + IChartSerie serie = chart.Series[1]; + serie.UsePrimaryAxis = false; + chart.SecondaryCategoryAxis.Visible = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the secondary value axis of the chart. Read-only. + + + The most commonly used charts have a set of primary axes and may have a set of secondary axes. + You can enable and disable this through property. + + + The following code illustrates how to disable and set for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "100"; + sheet.Range["B3"].Value = "200"; + sheet.Range["C3"].Value = "300"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set secondary axis + IChartSerie serie = chart.Series[1]; + serie.UsePrimaryAxis = false; + chart.SecondaryValueAxis.Visible = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the chart area. Read-only. + + + The following code illustrates how to access using property and set foreground color + for the . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart frame format + IChartFrameFormat frameFormat = chart.ChartArea; + + //Set color + frameFormat.Fill.ForeColor = System.Drawing.Color.Red; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the plot area where the chart data is plotted. Read-only. + + The plot area on a 2-D chart contains the data markers, grid lines, data labels, trend lines, + and optional chart items placed in the chart area. The plot area on a 3-D chart contains all the above items + plus the walls and floor. + The plot area is surrounded by the chart area. + + The following code illustrates how to access using property and set foreground color + for the chart's . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart frame format + IChartFrameFormat frameFormat = chart.PlotArea; + + //Set color + frameFormat.Fill.ForeColor = System.Drawing.Color.Red; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the walls of the 3D chart. Read-only. + + + The following code illustrates how to access using property and set foreground color + for the chart's . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered_3D; + + //Set chart wall or floor + IChartWallOrFloor wall = chart.Walls; + + //Set color + wall.Fill.FillType = ExcelFillType.SolidColor; + wall.Fill.ForeColor = System.Drawing.Color.Red; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the side wall of the 3D chart. Read-only. + + + The following code illustrates how to access using property and set foreground color + for the chart's . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered_3D; + + //Set chart wall or floor + IChartWallOrFloor wall = chart.SideWall; + + //Set color + wall.Fill.FillType = ExcelFillType.SolidColor; + wall.Fill.ForeColor = System.Drawing.Color.Red; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the back wall of the 3D chart. Read-only. + + + The following code illustrates how to access using property and set foreground color + for the chart's . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered_3D; + + //Set chart wall or floor + IChartWallOrFloor wall = chart.BackWall; + + //Set color + wall.Fill.FillType = ExcelFillType.SolidColor; + wall.Fill.ForeColor = System.Drawing.Color.Red; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the floor of the 3D chart. Read-only. + + + The following code illustrates how to access using property and set foreground color + for the chart's . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered_3D; + + //Set chart wall or floor + IChartWallOrFloor wall = chart.Floor; + + //Set color + wall.Fill.FillType = ExcelFillType.SolidColor; + wall.Fill.ForeColor = System.Drawing.Color.Red; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the of the chart. Read-only. + + + By default the visibility of data table is set to "false". Here for example, we set to "true" to enable data table + and set to "false" to hide the borders of data table. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set Chart data table + chart.HasDataTable = true; + IChartDataTable dataTable = chart.DataTable; + + //Set border + dataTable.HasBorders = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if the chart has data table. otherwise False. + + + The following code illustrates how data table can be set for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set Chart data table + chart.HasDataTable = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets legend in the chart. Read-only. + + + This is a key that identifies patterns, colors or symbols associated with the markers of a chart data series. + It shows data series name corresponding to each data marker. + + + The following code illustrates how to access using property and set + to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart legend + IChartLegend legend = chart.Legend; + + //Set legend position + legend.Position = ExcelLegendPosition.Left; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets whether the chart has title. + + + The following code illustrates how to set property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set hasTitle + chart.HasTitle = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if the chart has a legend object. otherwise False. + + + The following code illustrates how to set property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set hasLegend + chart.HasLegend = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the rotation of the 3D chart view + (the rotation of the plot area around the z-axis, in degrees)-(0 to 360 degrees). + + The value of this property must be from 0 to 360, except for 3-D bar charts, + where the value must be from 0 to 44. The default value is 20. Applies only to 3-D charts. + + The following code illustrates how to set for 3-D charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set Chart rotation + chart.Rotation = 10; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the elevation of the 3-D chart view, in degrees (-90 to +90 degrees). + + + The chart elevation is the height at which you view the chart, in degrees. + The default is 15 for most chart types. The value of this property must be between -90 and 90, except + for 3-D bar charts, where it must be between 0 and 44. + + + The following code illustrates how to set for 3-D charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set Chart elevation + chart.Elevation = 50; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the perspective for the 3D chart view (0 to 100). + + This property is ignored if the property is True. + + The following code illustrates how to set for the charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set Chart perspective + chart.Perspective = 70; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the height of a 3D chart as a percentage of the chart width + (5 - 500 percent). + + + The following code illustrates how can be set for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set Chart height percent + chart.HeightPercent = 200; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the depth of a 3D chart as a percentage of the chart width + (20 - 2000 percent). + + + The following code illustrates how to set to a Column 3D chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set Chart depth percent + chart.DepthPercent = 300; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the distance between data series in a 3D chart, as a percentage of marker width ( 0 - 500 ). + + Similar to we can also use to set width between data series in 3D charts. + + The following code illustrates how to set to a Column 3D chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set gap depth + chart.GapDepth = 450; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if the chart axes are at right angles, independent of chart rotation or elevation. otherwise False. + + + The following code illustrates how can be set for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set perspective + chart.Perspective = 90; + + //Set RightAngleAxes + chart.RightAngleAxes = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True to automatically scale the chart. otherwise False. The property must be True. + + Excel scales a 3-D chart so that it is closer in size to the equivalent 2-D chart when this property is enabled. + + The following code illustrates how to set auto scaling for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set height percentage + chart.HeightPercent = 300; + + //Set auto scaling + chart.AutoScaling = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if grid lines are drawn two-dimensionally on a 3-D chart. otherwise False. + + + The following code illustrates how to set for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set wall lines + chart.WallsAndGridlines2D = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating whether the chart has plot area. + + + The following code illustrates how to set the visibility of . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set frame format + chart.ChartArea.IsBorderCornersRound = true; + + //Set HasPlotArea + chart.HasPlotArea = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a value indicating how the blank cells are plotted on chart. + + + If cells within the chart's has no data then those are not plotted in charts. Because by default the + is set to . Here for example, we set + to property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered_3D; + + //Set display as + chart.DisplayBlanksAs = ExcelChartPlotEmpty.Zero; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if only visible cells are plotted. False if both visible and hidden cells are plotted. + + + By default property is set to "true" so only cells which are visible within the chart's + will be plotted in chart. Here for example, we set to "false" so that chart plots all the cells within the chart's + . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Hide column + sheet.Columns[2].ColumnWidth = 0; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set Plot visible only + chart.PlotVisibleOnly = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if the chart is resized to match the size of the chart sheet window. + False if the chart size is not attached to the window size. Applies only to chart sheets. + + + Used in older versions of Microsoft office. + + + + + Gets or sets the pivot source. + + The pivot source + + To know more about pivot tables refer Working with Pivot Tables. + + + The following code illustrates how to set data source for the property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.ImportDataTable(getData(), true, 1, 1); + + //Create pivot table + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D21"]); + IPivotTable pivotTable = sheet.PivotTables.Add("PivotTable", sheet["F1"], cache); + pivotTable.Fields[0].Axis = PivotAxisTypes.Row; + pivotTable.Fields[1].Axis = PivotAxisTypes.Column; + pivotTable.Fields[2].Axis = PivotAxisTypes.Row; + IPivotField field = pivotTable.Fields[3]; + pivotTable.DataFields.Add(field, "Sum", PivotSubtotalTypes.Sum); + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set pivot source + chart.PivotSource = pivotTable; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + System.Data.DataTable getData() + { + System.Data.DataTable dt = new System.Data.DataTable(); + dt.Columns.Add("Region"); + dt.Columns.Add("Employee"); + dt.Columns.Add("Item"); + dt.Columns.Add("Units"); + dt.Rows.Add("Central", "Jones", "Pen Set", 700); + dt.Rows.Add("West", "Kivell", "Binder", 85); + dt.Rows.Add("East", "Gill", "Pen", 58); + dt.Rows.Add("Central", "Jones", "Pen Set", 46); + dt.Rows.Add("West", "Kivell", "Binder", 61); + dt.Rows.Add("Central", "Jones", "Pen", 90); + dt.Rows.Add("West", "Kivell", "Pen Set", 32); + dt.Rows.Add("East", "Gill", "Binder", 79); + dt.Rows.Add("Central", "Jones", "Pen Set", 27); + dt.Rows.Add("Central", "Jones", "Binder", 5); + dt.Rows.Add("East", "Gill", "Pen Set", 41); + dt.Rows.Add("East", "Gill", "Pen Set", 61); + dt.Rows.Add("East", "Gill", "Binder", 9); + dt.Rows.Add("Central", "Jones", "Pen Set", 75); + dt.Rows.Add("West", "Kivell", "Pen Set", 97); + dt.Rows.Add("West", "Kivell", "Pen Set", 86); + dt.Rows.Add("East", "Gill", "Pen Set", 90); + dt.Rows.Add("East", "Gill", "Pen Set", 25); + dt.Rows.Add("East", "Gill", "Binder", 68); + dt.Rows.Add("East", "Gill", "Binder", 19); + return dt; + } + + + + + + Gets or sets the type of the pivot chart. + + The type of the pivot chart. + + The following code illustrates how to set pivot chart type. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.ImportDataTable(getData(), true, 1, 1); + + //Create pivot table + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D21"]); + IPivotTable pivotTable = sheet.PivotTables.Add("PivotTable", sheet["F1"], cache); + pivotTable.Fields[0].Axis = PivotAxisTypes.Row; + pivotTable.Fields[1].Axis = PivotAxisTypes.Column; + pivotTable.Fields[2].Axis = PivotAxisTypes.Row; + IPivotField field = pivotTable.Fields[3]; + pivotTable.DataFields.Add(field, "Sum", PivotSubtotalTypes.Sum); + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set pivot source + chart.PivotSource = pivotTable; + + //Set pivot chart type + chart.PivotChartType = ExcelChartType.Pie; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + System.Data.DataTable getData() + { + System.Data.DataTable dt = new System.Data.DataTable(); + dt.Columns.Add("Region"); + dt.Columns.Add("Employee"); + dt.Columns.Add("Item"); + dt.Columns.Add("Units"); + dt.Rows.Add("Central", "Jones", "Pen Set", 700); + dt.Rows.Add("West", "Kivell", "Binder", 85); + dt.Rows.Add("East", "Gill", "Pen", 58); + dt.Rows.Add("Central", "Jones", "Pen Set", 46); + dt.Rows.Add("West", "Kivell", "Binder", 61); + dt.Rows.Add("Central", "Jones", "Pen", 90); + dt.Rows.Add("West", "Kivell", "Pen Set", 32); + dt.Rows.Add("East", "Gill", "Binder", 79); + dt.Rows.Add("Central", "Jones", "Pen Set", 27); + dt.Rows.Add("Central", "Jones", "Binder", 5); + dt.Rows.Add("East", "Gill", "Pen Set", 41); + dt.Rows.Add("East", "Gill", "Pen Set", 61); + dt.Rows.Add("East", "Gill", "Binder", 9); + dt.Rows.Add("Central", "Jones", "Pen Set", 75); + dt.Rows.Add("West", "Kivell", "Pen Set", 97); + dt.Rows.Add("West", "Kivell", "Pen Set", 86); + dt.Rows.Add("East", "Gill", "Pen Set", 90); + dt.Rows.Add("East", "Gill", "Pen Set", 25); + dt.Rows.Add("East", "Gill", "Binder", 68); + dt.Rows.Add("East", "Gill", "Binder", 19); + return dt; + } + + + + + + Gets or sets a boolean value indicating whether to show all field buttons on a pivot chart. + + + true to show all field buttons; false otherwise. + + + The following code illustrates how to set the visibility of all the field buttons in the pivot chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.ImportDataTable(getData(), true, 1, 1); + + //Create pivot table + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D21"]); + IPivotTable pivotTable = sheet.PivotTables.Add("PivotTable", sheet["F1"], cache); + pivotTable.Fields[0].Axis = PivotAxisTypes.Row; + pivotTable.Fields[1].Axis = PivotAxisTypes.Column; + pivotTable.Fields[2].Axis = PivotAxisTypes.Row; + IPivotField field = pivotTable.Fields[3]; + pivotTable.DataFields.Add(field, "Sum", PivotSubtotalTypes.Sum); + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set pivot source + chart.PivotSource = pivotTable; + + //Set button visibility + chart.ShowAllFieldButtons = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + System.Data.DataTable getData() + { + System.Data.DataTable dt = new System.Data.DataTable(); + dt.Columns.Add("Region"); + dt.Columns.Add("Employee"); + dt.Columns.Add("Item"); + dt.Columns.Add("Units"); + dt.Rows.Add("Central", "Jones", "Pen Set", 700); + dt.Rows.Add("West", "Kivell", "Binder", 85); + dt.Rows.Add("East", "Gill", "Pen", 58); + dt.Rows.Add("Central", "Jones", "Pen Set", 46); + dt.Rows.Add("West", "Kivell", "Binder", 61); + dt.Rows.Add("Central", "Jones", "Pen", 90); + dt.Rows.Add("West", "Kivell", "Pen Set", 32); + dt.Rows.Add("East", "Gill", "Binder", 79); + dt.Rows.Add("Central", "Jones", "Pen Set", 27); + dt.Rows.Add("Central", "Jones", "Binder", 5); + dt.Rows.Add("East", "Gill", "Pen Set", 41); + dt.Rows.Add("East", "Gill", "Pen Set", 61); + dt.Rows.Add("East", "Gill", "Binder", 9); + dt.Rows.Add("Central", "Jones", "Pen Set", 75); + dt.Rows.Add("West", "Kivell", "Pen Set", 97); + dt.Rows.Add("West", "Kivell", "Pen Set", 86); + dt.Rows.Add("East", "Gill", "Pen Set", 90); + dt.Rows.Add("East", "Gill", "Pen Set", 25); + dt.Rows.Add("East", "Gill", "Binder", 68); + dt.Rows.Add("East", "Gill", "Binder", 19); + return dt; + } + + + + + + Gets or sets a boolean value indicating whether to show value field buttons on a pivot chart. + + + true to show value field buttons; false otherwise. + + + The following code illustrates how to set the visibility of value field buttons in pivot chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.ImportDataTable(getData(), true, 1, 1); + + //Create pivot table + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D21"]); + IPivotTable pivotTable = sheet.PivotTables.Add("PivotTable", sheet["F1"], cache); + pivotTable.Fields[0].Axis = PivotAxisTypes.Row; + pivotTable.Fields[1].Axis = PivotAxisTypes.Column; + pivotTable.Fields[2].Axis = PivotAxisTypes.Row; + IPivotField field = pivotTable.Fields[3]; + pivotTable.DataFields.Add(field, "Sum", PivotSubtotalTypes.Sum); + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set pivot source + chart.PivotSource = pivotTable; + + //Set button visibility + chart.ShowValueFieldButtons = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + System.Data.DataTable getData() + { + System.Data.DataTable dt = new System.Data.DataTable(); + dt.Columns.Add("Region"); + dt.Columns.Add("Employee"); + dt.Columns.Add("Item"); + dt.Columns.Add("Units"); + dt.Rows.Add("Central", "Jones", "Pen Set", 700); + dt.Rows.Add("West", "Kivell", "Binder", 85); + dt.Rows.Add("East", "Gill", "Pen", 58); + dt.Rows.Add("Central", "Jones", "Pen Set", 46); + dt.Rows.Add("West", "Kivell", "Binder", 61); + dt.Rows.Add("Central", "Jones", "Pen", 90); + dt.Rows.Add("West", "Kivell", "Pen Set", 32); + dt.Rows.Add("East", "Gill", "Binder", 79); + dt.Rows.Add("Central", "Jones", "Pen Set", 27); + dt.Rows.Add("Central", "Jones", "Binder", 5); + dt.Rows.Add("East", "Gill", "Pen Set", 41); + dt.Rows.Add("East", "Gill", "Pen Set", 61); + dt.Rows.Add("East", "Gill", "Binder", 9); + dt.Rows.Add("Central", "Jones", "Pen Set", 75); + dt.Rows.Add("West", "Kivell", "Pen Set", 97); + dt.Rows.Add("West", "Kivell", "Pen Set", 86); + dt.Rows.Add("East", "Gill", "Pen Set", 90); + dt.Rows.Add("East", "Gill", "Pen Set", 25); + dt.Rows.Add("East", "Gill", "Binder", 68); + dt.Rows.Add("East", "Gill", "Binder", 19); + return dt; + } + + + + + + Gets or sets a boolean value indicating whether to show axis field buttons on a pivot chart. + + + true to show axis field buttons; false otherwise. + + + The following code illustrates how to set visibility of axis field buttons in pivot chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.ImportDataTable(getData(), true, 1, 1); + + //Create pivot table + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D21"]); + IPivotTable pivotTable = sheet.PivotTables.Add("PivotTable", sheet["F1"], cache); + pivotTable.Fields[0].Axis = PivotAxisTypes.Row; + pivotTable.Fields[1].Axis = PivotAxisTypes.Column; + pivotTable.Fields[2].Axis = PivotAxisTypes.Row; + IPivotField field = pivotTable.Fields[3]; + pivotTable.DataFields.Add(field, "Sum", PivotSubtotalTypes.Sum); + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set pivot source + chart.PivotSource = pivotTable; + + //Set button visibility + chart.ShowAxisFieldButtons = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + System.Data.DataTable getData() + { + System.Data.DataTable dt = new System.Data.DataTable(); + dt.Columns.Add("Region"); + dt.Columns.Add("Employee"); + dt.Columns.Add("Item"); + dt.Columns.Add("Units"); + dt.Rows.Add("Central", "Jones", "Pen Set", 700); + dt.Rows.Add("West", "Kivell", "Binder", 85); + dt.Rows.Add("East", "Gill", "Pen", 58); + dt.Rows.Add("Central", "Jones", "Pen Set", 46); + dt.Rows.Add("West", "Kivell", "Binder", 61); + dt.Rows.Add("Central", "Jones", "Pen", 90); + dt.Rows.Add("West", "Kivell", "Pen Set", 32); + dt.Rows.Add("East", "Gill", "Binder", 79); + dt.Rows.Add("Central", "Jones", "Pen Set", 27); + dt.Rows.Add("Central", "Jones", "Binder", 5); + dt.Rows.Add("East", "Gill", "Pen Set", 41); + dt.Rows.Add("East", "Gill", "Pen Set", 61); + dt.Rows.Add("East", "Gill", "Binder", 9); + dt.Rows.Add("Central", "Jones", "Pen Set", 75); + dt.Rows.Add("West", "Kivell", "Pen Set", 97); + dt.Rows.Add("West", "Kivell", "Pen Set", 86); + dt.Rows.Add("East", "Gill", "Pen Set", 90); + dt.Rows.Add("East", "Gill", "Pen Set", 25); + dt.Rows.Add("East", "Gill", "Binder", 68); + dt.Rows.Add("East", "Gill", "Binder", 19); + return dt; + } + + + + + + Gets or sets a boolean value indicating whether to show legend field buttons on a pivot chart. + + + true to show legend field buttons; false otherwise. + + + The following code illustrates how to set visibility of legend field buttons in pivot charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.ImportDataTable(getData(), true, 1, 1); + + //Create pivot table + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D21"]); + IPivotTable pivotTable = sheet.PivotTables.Add("PivotTable", sheet["F1"], cache); + pivotTable.Fields[0].Axis = PivotAxisTypes.Row; + pivotTable.Fields[1].Axis = PivotAxisTypes.Column; + pivotTable.Fields[2].Axis = PivotAxisTypes.Row; + IPivotField field = pivotTable.Fields[3]; + pivotTable.DataFields.Add(field, "Sum", PivotSubtotalTypes.Sum); + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set pivot source + chart.PivotSource = pivotTable; + + //Set button visibility + chart.ShowLegendFieldButtons = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + System.Data.DataTable getData() + { + System.Data.DataTable dt = new System.Data.DataTable(); + dt.Columns.Add("Region"); + dt.Columns.Add("Employee"); + dt.Columns.Add("Item"); + dt.Columns.Add("Units"); + dt.Rows.Add("Central", "Jones", "Pen Set", 700); + dt.Rows.Add("West", "Kivell", "Binder", 85); + dt.Rows.Add("East", "Gill", "Pen", 58); + dt.Rows.Add("Central", "Jones", "Pen Set", 46); + dt.Rows.Add("West", "Kivell", "Binder", 61); + dt.Rows.Add("Central", "Jones", "Pen", 90); + dt.Rows.Add("West", "Kivell", "Pen Set", 32); + dt.Rows.Add("East", "Gill", "Binder", 79); + dt.Rows.Add("Central", "Jones", "Pen Set", 27); + dt.Rows.Add("Central", "Jones", "Binder", 5); + dt.Rows.Add("East", "Gill", "Pen Set", 41); + dt.Rows.Add("East", "Gill", "Pen Set", 61); + dt.Rows.Add("East", "Gill", "Binder", 9); + dt.Rows.Add("Central", "Jones", "Pen Set", 75); + dt.Rows.Add("West", "Kivell", "Pen Set", 97); + dt.Rows.Add("West", "Kivell", "Pen Set", 86); + dt.Rows.Add("East", "Gill", "Pen Set", 90); + dt.Rows.Add("East", "Gill", "Pen Set", 25); + dt.Rows.Add("East", "Gill", "Binder", 68); + dt.Rows.Add("East", "Gill", "Binder", 19); + return dt; + } + + + + + + Gets or sets a boolean value indicating whether to show report filter field buttons on a pivot chart. + + + true to show report filter field buttons; false otherwise. + + + The following code illustrates how to set visibility of report filter field buttons in pivot charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.ImportDataTable(getData(), true, 1, 1); + + //Create pivot table + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D21"]); + IPivotTable pivotTable = sheet.PivotTables.Add("PivotTable", sheet["F1"], cache); + pivotTable.Fields[0].Axis = PivotAxisTypes.Row; + pivotTable.Fields[1].Axis = PivotAxisTypes.Column; + pivotTable.Fields[2].Axis = PivotAxisTypes.Row; + IPivotField field = pivotTable.Fields[3]; + pivotTable.DataFields.Add(field, "Sum", PivotSubtotalTypes.Sum); + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set pivot source + chart.PivotSource = pivotTable; + + //Set button visibility + chart.ShowReportFilterFieldButtons = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + System.Data.DataTable getData() + { + System.Data.DataTable dt = new System.Data.DataTable(); + dt.Columns.Add("Region"); + dt.Columns.Add("Employee"); + dt.Columns.Add("Item"); + dt.Columns.Add("Units"); + dt.Rows.Add("Central", "Jones", "Pen Set", 700); + dt.Rows.Add("West", "Kivell", "Binder", 85); + dt.Rows.Add("East", "Gill", "Pen", 58); + dt.Rows.Add("Central", "Jones", "Pen Set", 46); + dt.Rows.Add("West", "Kivell", "Binder", 61); + dt.Rows.Add("Central", "Jones", "Pen", 90); + dt.Rows.Add("West", "Kivell", "Pen Set", 32); + dt.Rows.Add("East", "Gill", "Binder", 79); + dt.Rows.Add("Central", "Jones", "Pen Set", 27); + dt.Rows.Add("Central", "Jones", "Binder", 5); + dt.Rows.Add("East", "Gill", "Pen Set", 41); + dt.Rows.Add("East", "Gill", "Pen Set", 61); + dt.Rows.Add("East", "Gill", "Binder", 9); + dt.Rows.Add("Central", "Jones", "Pen Set", 75); + dt.Rows.Add("West", "Kivell", "Pen Set", 97); + dt.Rows.Add("West", "Kivell", "Pen Set", 86); + dt.Rows.Add("East", "Gill", "Pen Set", 90); + dt.Rows.Add("East", "Gill", "Pen Set", 25); + dt.Rows.Add("East", "Gill", "Binder", 68); + dt.Rows.Add("East", "Gill", "Binder", 19); + return dt; + } + + + + + + Gets collection of the chart. Read-only. + + Charts are plotted using X and Y axes. X axes typically have categorical scales. + Categories can include string, numeric, and date values. + + The following code illustrates how to access collection of the chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart categories + IChartCategories categories = chart.Categories; + + //Get count + Console.WriteLine(categories.Count); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //3 + + + + + + Gets or sets a value referring to the source level for series names. + + + By default is set to . Here for example, we set to property to use autogenerated series labels. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Text = "Apr"; + sheet.Range["B2"].Text = "May"; + sheet.Range["C2"].Text = "Jun"; + + sheet.Range["A4"].Value = "10"; + sheet.Range["B4"].Value = "20"; + sheet.Range["C4"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "10"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C4"]; + + //Set series in rows + chart.IsSeriesInRows = false; + + //Set chart type + chart.ChartType = ExcelChartType.Line; + + //Set Series name level + chart.SeriesNameLevel = ExcelSeriesNameLevel.SeriesNameLevelNone; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a value referring to the source level for the category labels. + + + By default is set to . Here for example, we set to property to use autogenerated category labels. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set Categories level label + chart.CategoryLabelLevel = ExcelCategoriesLabelLevel.CategoriesLabelLevelNone; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a style value for the chart. + + + By default is set to 0. Here for example, we set property for style change. + + Chart style value must be between 1 to 48. Otherwise argument exception will be thrown. + Style value changes will not affect to 2016 charts. + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set Chart Style + chart.Style = 14; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + INamedObject interface declaration - object with name, + index, and ability to serialize. + + + + + Serializes this object into OffsetArrayList. + + + OffsetArrayList that will receive records of the object. + + + + + Name of the object. + + + + + Index of the object in the collection. + + + + + + + + + + Represent default name for the chart title. + + + + + Represent default name for the first series of the chart. + + + + + Represents the default chart type. + + + + + Represents the prefix for 3D charts. + + + + + Represents the prefix for bar charts. + + + + + Represents the prefix for clustered charts. + + + + + Represents the prefix for contour charts. + + + + + Represents the prefix for exploded charts. + + + + + Represents the prefix for line charts. + + + + + Represents the prefix for charts with markers. + + + + + Represents the prefix for charts with no color. + + + + + Represents the prefix for 100% charts. + + + + + Represents the prefix for charts with smoothed lines. + + + + + Represents the prefix for stacked charts. + + + + + Represents the defined start for area charts. + + + + + Represents the defined start for bar charts. + + + + + Represents the defined start for bubble charts. + + + + + Represents the defined start for column charts. + + + + + Represents the defined start for cone charts. + + + + + Represents the defined start for cylinder charts. + + + + + Represents the defined start for doughnut charts. + + + + + Represents the defined start for line charts. + + + + + Represents the defined start for pie charts. + + + + + Represents the defined start for pyramid charts. + + + + + Represents the defined start for radar charts. + + + + + Represents the defined start for scatter charts. + + + + + Represents the defined start for surface charts. + + + + + Index of the primary axes. + + + + + Si value index. + + + + + Si category index. + + + + + Si bubble index. + + + + + Index of the secondary axes. + + + + + Maximum font count. + + + + + Represents the Defualt Plot Area Top Left X. + + + + + Represents the Default Plot Area Top Left Y. + + + + + Represents the Default Plot Area X Length. + + + + + Represents the Default Plot Area Y Length. + + + + + Represent start types of chart that support data point. + + + + + Represent the charts that support series axis. + + + + + Represent the charts that do not support pivot charts. + + + + + Represent the charts that support data table. + + + + + Represent the charts that support error bars. + + + + + Represent the charts that support trendlines. + + + + + Represent the charts that contain walls or floor. + + + + + Specifies default secondary axis types. + + + + + Represent types of charts that are not 3D. + + + + + Represent types of charts that allow serie change. + + + + + Represent serie types that does not support gridlines. + + + + + Represent serie types that must be in secondary axis. + + + + + Represent serie types that shall be in primary axis. + + + + + Represent chart types that are combination of two different charts. + + + + + Represents array of start serie types sorted by drawing order. + + + + + Represent chart types that can change as intimate types. + + + + + Represent chart start types that does not need plot or walls. + + + + + Represent pivot chart types which need view tag to be rendered. + + + + + Represent 100% charts. + + Here each value in a series is shown as a portion of 100%. + + + + Represent the stacked charts. + + + + + Represent 3D charts. + + + + + Represent line charts. + + + + + Represent bubble charts. + + These are variation of scatter charts in which + the data points are replaced with bubbles. + + + + Represent the charts that can be without category axis. + + + + + Represent charts that need different color for each value. + + + + + Represent exploded charts. + + + + + Charts that need series lines: + + + + + Represent scatter charts. + + + + + Represent charts with smoothed lines. + + + + + Represent stock charts. + + + + + Represent charts with perspective. + + + + + Represent clustered charts. + + + + + Represent charts with plot area (by default). + + + + + Represent the legend types that are displayed vertically. + + + + + Unknown bytes. Needed for data labels serialization. + + + + + Represent the charts with data labels stored in different ways. + + + + + Represent charts with percentage data labels. + + + + + Represents to parse sheet on demand + + + + + Specifies the contents of this attribute contain an integer between -100 and 100. + + + + + Specifies the contents + + + + + Represents whether datetime axis contains string reference + + + + + Represents whether to serialize gapwidth + + + + + If true than chart contain secondary axis. + + + + + Represents if chart in worksheet. + + + + + Chart type. + + + + + Pivot Chart type. + + + + + DataRange for the chart series. + + + + + True if series are in rows in DataRange; + otherwise False. + + + + + True if has data table; + otherwise False. + + + + + Page setup for the chart. + + + + + X coordinate of the upper-left corner + of the chart in points (1/72 inch). + + + + + Y coordinate of the upper-left corner + of the chart in points (1/72 inch). + + + + + Width of the chart in points (1/72 inch). + + + + + Height of the chart in points (1/72 inch). + + + + + Array of the fonts used in the chart. + + + + + Collection of all the series of this chart. + + + + + Collection of all the categories of this chart. + + + + + Chart's data table. + + + + + Chart sheet properties. + + + + + This record stores scale factors for font scaling. + + + + + Position of the plot area bounding box. The plot-area bounding box + includes the plot area, tick marks, and a small border around + the tick marks. + + + + + Chart frame format. + + + + + Frame for plot area. + + + + + Dictionary that contains information about default text. + Key - Object identifier for the text, + Value - List with text records. + + + + + Title area. + + + + + Represents primary parent axis record and subrecords. + + + + + Represents secondary parent axis record and subrecords. + + + + + Represents legend in chart. + + + + + True if has legend; + otherwise False. + + + + + Represents chart walls/back_walls. + + + + + Represents chart side_walls. + + + + + Represents chart floor. + + + + + Represents chart plot area. + + + + + Indicates if we change chart or Series type. + + + + + Indicates if we have a default chart title or not. + + + + + Indicates if we change chart or Series type. + + + + + Represents helper array for parse trends. Use only for parsing. + + + + + Represents list with pivot records; + + + + + WindowZoomRecord that was met inside ChartChartRecord block. + + + + + Relations collection. + + + + + Style index for Excel 2007 chart. + + + + + Stream with extracted pivot formats data. + + + + + + + + + + Dictionary with error bars which requires future reparsing. + + + + + Preserved band formats. + + + + + Pivot source string. + + + + + Since we don't parse pivot tables we can only preserve pivot source using string variable, this should be remove after we start pivot tables parsing. + + + + + represents the format id of the chart + + + + + Indicates the all button fields in a pivot chart. + + + + + Indicates the Axis button in a pivot chart. + + + + + Indicates the value button in a pivot chart. + + + + + Indicates the legend button in a pivot chart. + + + + + Indicates the ExpandCollapseField button in a pivot chart. + + + + + Indicates the filter button in a pivot chart. + + + + + Preserves the Chart's Default Text Property. + TODO: Need to support Chart default text proprety, should be remove after we start to parse. + + + + + Font used for chart drawing. + + + + + Plot area layout + + + + + Collect the filter from category + + + + + Collect the filter from series + + + + + Represents the Excel2013 series name filter + + + + + Represents the Excel2013 category Filter + + + + + Indicates whether the PlotVisOnly attribute exists or not + + + + + Indicates whether the chart is copied from another workbook + + + + + Dictionary with Data Points which has data labels for different chart groups. + + + + + Dictionary with imageCodec which has image raw formats. + + + + + Represents the common category label values. + + + + + Represents the category lable reference as range. + + + + + Indicates whether the chart type is Stock chart + + + + + Indicates whether Radar series type is changed on parsing + + + + + This stream stores xml text with overided themes. + + + + + Contains list of theme colors. + + + + + Boolean value indicates whether the color style element file (colors1.xml) is skipped on parsing + + + + + Boolean value indicates whether the chart style element file (style1.xml) is skipped on parsing + + + + + This stream stores xml text with color mapped override. + + + + + Contains list of series groups in the chart + + + + + Represents the chart is created or parsed + + + + + Represents the show data lables over max value. + + + + + Represents the show Display #N/A as blank. + + + + + short value indicates the chartEx element position + + + + + Boolean value indicates whether the title can be overlay or not + + + + + Boolean value indicates whether the external data need to be updated + Useful only in parsed workbook + + + + + Relation id denotes the external referenced Id + Useful only in parsed workbook + + + + + Initializes a new instance of class. + + Application object for the chart. + Parent object for the chart. + + + + Initializes a new instance of class from biff reader and specified decryptor. + + Application object for the chart. + Parent object for the chart. + BiffReader to extract data from. + Parse options. + Indicates whether to skip parsing. + + Dictionary with new extended format indexes for ignore styles mode. + + Object used to decrypt encrypted records. + + + + Initializes a new instance of class from the array of BiffRecords. + + Application object for the chart. + Parent object for the chart. + Array of BiffRecords with chart's data. + Position of the first chart's record. + Parse options. + + + + Searches for all necessary parent objects. + + + + + Creates chart title object. + + + + + Parses internal records. + + + + + Extracts chart from array of BiffRecords. + + Array of BiffRecords containing chart's data. + Position of the first chart's record. + Parse options. + + + + ParseBinaryData + + SST records + Data Holder + + + + Parses object's records. + + + + + Reparses error bars. + + + + + Parses ordinary chart record. + + Record to parse. + Record position - will be updated during this operation. + + + + Saves all chart records in the internal storage (without first BOF record). + + Array with chart records. + Position to the first chart record. + Array that will get all chart records. + Parse options. + + + + Extracts fonts from the BiffRecords array. + + BiffRecords array containing fonts. + Position of the first font record. + + If specified by parameter record is not ChartFbi record. + + + + + Parses ChartChartReacod and all its subrecords. + + Array of BiffRecords containing chart's data. + Position of the ChartChart record. + + When specified record is not ChartChart record + or the next record is not Begin record. + + + + + Extracts data from ChartChart record. + + Record with data. + + + + Parses ChartPlotGrowth record. + + Record to parse. + + + + Parses ChartSiIndex records. + + Array of records containing ChartSiIndex records. + Position of the first ChartSiIndex record. + + When specified record is not ChartSiIndex record. + + + + + Parses ChartSeries record and its subrecords. + Creates new series in the Series collection. + + Array of records containing ChartSeries data. + Position of the ChartSeries record. + + + + Parses sheet properties. + + Array of records containing sheet properties data. + Position of the ChartShtprops record. + + When specified record is not ChartShtprops record. + + + + + Parses ChartDefaultText record. + + Array of records containing default text data. + Position of the record. + + When specified record is not ChartDefaultText record. + + + + + Gets record of the text data block. + + Array of records containing text data. + Position of the first text record. + List with all text records. + + + + Parses ChartText record and all its subrecords. + + Array of records containing text data. + Position of the record. + ChartTextAreaImpl that represents parsed text area. + + When specified record is not ChartText record + or when next record is not Begin record. + + + + + Parses ChartAxesUsed record. + + Array of records containing record. + Position of the record to parse. + + When specified record is not ChartAxesUsed record. + + + + + Parses ChartAxisParent record. + + Array of records containing record. + Position of the record to parse. + + When specified record is not ChartAxisParent record. + + + + + Parses ChartData table records. + + Array of records containing data table records. + Position of the ChartData record in the data array. + + When specified record is not ChartData record. + + + + + Assigns text area to its owner. + + Text area to assign. + List with unassigned text areas. + + + + Parses chart's plot area and all its sub records. + + Array of records containing plot area data. + + Position of the ChartPlotArea record in the array. + + + When specified record is not ChartPlotArea record. + + + + + Parses chart frame records. + + Array of records containing axes names data. + Position of the ChartFrame record in the array. + + + + Detects the type of the chart. + + + When it is not possible to detect chart type. + + + + + Sets some important variables into initial state. + + + + + Parses ChartFontxRecord. + + Record to parse. + IFont corresponding to the fontx record. + + + + Parses the legend in the chart. + + Record storage. + Position in storage. + + + + Adds series records to subholder from global holder. + + Represents global record holder. + Represents record subholder. + Represents position in global holder + Gets series index for error bar. + Indicates parsing error bars. + If true - parse Series; otherwise - error bars or trend lines. + + + + Reparse trend line legend entries. + + + + + Saves chart into OffsetArrayList. + + + OffsetArrayList that will receive all chart's records. + + + When specified OffsetArrayList is NULL. + + + + + Saves all chart's fonts into OffsetArrayList. + + + OffsetArrayList that will receive all fonts records. + + + + + Saves ChartChart record and all its subrecords. + + + OffsetArrayList that will receive all records. + + Boolean value indicates whether the chart is chartEx or not + + + + Saves DefaultText. + + + OffsetArrayList that will receive all records. + + + + + Serializes chart's axes. + + + OffsetArrayList that will receive all records. + + + + + Serializes sheet properties. + + + OffsetArrayList that will receive all records. + + + + + Serializes ChartSiIndex records. + + + OffsetArrayList that will receive all records. + + + + + Serializes category labels. + + + OffsetArrayList that will receive all records. + + + + + Serializes series values. + + + OffsetArrayList that will receive all records. + + + + + Serializes data table if it is visible. + + + OffsetArrayList that will receive all records. + + + + + Serializes data labels. + + + OffsetArrayList that will receive all records. + + + + + Serializes Series list. + + + OffsetArrayList that will receive all records. + + + + + Serializes ChartSi members. + + OffsetArrayList that will receive all records. + SiIndex record index. + + + + Serialize the chart's legend. + + Represents record list to serialize into. + + + + Serialize chart walls. + + Records collection. + + + + Serialize the chart's floor. + + Records collection. + + + + Serialize plot area to stg stream. + + Represents record storage. + + + + from the data range it detects and assign the series and its values + + input chart type + + + + from given information it creates series and its values + + required rows count used series creation + required columns count used series creation + boolean value indicates whether the series ranges have any space + input series Ranges + input seriesName ranges + output modified serie value ranges + output modified serie named ranges + output axis ranges + the boolean value indicates whether the series in rows or not + + + + Calculate and retruns count of the required cells inside the range + + input migrant range + last index in the column or row wise + index in the column or row wise + constant column or row value + boolean value indicates whether the iteration in row or not + the number of required cells count + + + + Updates chart categories from the specified series collection. + + Series collection. + Boolean value indicating if the chart is from data range. + + + + Updates series filter from the specified series collection. + + Series collection. + + + + Finds the category range in the specified chart range. + + Range of chart values. + Outputted category range values. + Chart values count. + Boolean value indicating if series is in row. + Category range in the specified chart range. + + + + Getting the filter from series and categories + + + + + Filter is assigned to the categories/series. + + + + + Get chart title name + + return chart Title name + + + + Determines if the specified chart type is clustered chart. + + The chart type to check. + True if teh chart type is clustered. False otherwise. + + + + Determines if the chart is 100% in view. + + The type of the chart. + True if the chart is 100%. False otherwise. + + + + Determines if the specified chart type is stacked. + + The chart type to check. + True if the chart is clustered chart. False otherwise. + + + + Determines whether specified chart type is pie chart. + + The chart type to check. + Value indicating whether specified chart type is pie chart. + + + + Creates necessary primary axes. + + Value indicating whether axis is primary. + + + + Initializes all internal collections. + + + + + Checks whether chart support data table. + + + + + Checks whether data table is compatible with specified start type. + + Start type of the chart. + Boolean value indicating whether to throw exception. + True if data table is compatible with specified start type. False otherwise. + + When the chart type is not supported by the data table. + + + + + Initializes collection of default text objects. + + + + + This method is called if DataRange was changed. + + Represents chart type. + + + + Adds default row series to the series collection. + + + + + Adds default column series to the series collection. + + + + + Adds bubble row series to the series collection. + + + + + Adds bubble column series to the series collection. + + + + + Adds scatter row series to the series collection. + + + + + Adds scatter column series to the series collection. + + + + + Adds stock row series without volume to the series collection. + + Number of series to add. + + When data range rows count does not correspond to the specified count. + + + + + Adds stock column series without volume to the series collection. + + Number of series to add. + + When data range columns count does not correspond to the specified count. + + + + + Adds stock row series with volume to the series collection. + + Number of series to add. + + When data range rows count does not correspond to the specified count. + + + + + Adds stock column series with volume to the series collection. + + Number of series to add. + + When data range columns count does not correspond to the specified count. + + + + + Sets format of secondary axes for volume chart type. + + + + + Sets default format for the first stock Series. + + Series to set format. + + + + This method is called when IsSeriesInRows is changed. + + + + + Updates series in bubble chart. + + + + + This method is called when chart type is changed. + + Represents chart type. + Value indicating whether series needs to be created. + + + + Updates tick record in surface chart type. + + + + + Updates tick record in radar chart type. + + + + + Updates chart members on type changing. + + Represents new chart type. + + + + Check whether the input chart type is ChartEx type or not + + input chart type + the boolean value indicates whether the chart type is chart ex + + + + Change the chart to chart ex type + + Indicates the old chart type + input chart type to be modified + boolean value indicates whether the series is created or not + + + + Changes Chart type for one of stock types. + + Type to change. + + + + Returns Chart3D record for this chart. + + Chart3D record for this chart. + + + + This is event handler for ValueRangeChanged of each series of the chart. + + + + + Initializes chart frames. + + + + + Removes the specified chart format. + + Format to remove. + + + + Updates chart title on chart creation. + + + + + Detects start type of the chart. + + Returns null if cann't detect. + + + + Detects data range by series and category axis. + + Returns detected data range or null if cann't detect. + + + + Returns the axis and named range which lies within the data range + + output series named range + output category axis range + the boolean value indicates whether the valid range is available or not + + + + Detects if series in rows or in column. + + Represents data range to be detected. + Returns true if series is in rows; False if series is in columns. + + + + Gets data range that represents series name or category axis. + + Represents data range. + Represents if series in row. + Represents range that contain series value range. + Returns series name or category axis range, if possible; otherwise null. + + + + Gets data range that represents series name or category axis. + + Represents data range. + Represents if series in row. + Skip the first column from series range of scatter chart if the column has numbers + Represents range that contain series value range. + Returns series name or category axis range, if possible; otherwise null. + + + + Validates Series range for min Series count of custom chart type. + + Represents range, that contain Series values. + Represents chart type. + Returns true if can set data range, otherwise false. + + + + Updates series value by data range. + + Represents range, that contain series value. + Represents range, that contain series name. + axis range of the chart + Represents chart type. + Represents index. + boolean value indicates whether series in row or column + + + + Indicates if Series is in data range. + + Represents rec of first Series values. + Represents range of current Series values. + index of this Series in collection. + Represents sheet name. + Returns true if series values is equal. + + + + Gets range, that represents series value range. + + Represents last range. + Represents bubble range. + Represents parent sheet. + Represents name of worksheet in data range. + Returns detected series range. + + + + Gets range, that represents series name values. + + Represents first Series name range. + Represents bubble range. + Represents parent sheet. + Represents sheet name. + Sets out parameter to Series name range. + Value indicating range representing serie name values. + + + + Updates data range rectangle. + + Represents range to update. + Represents rec, that represents current data range. Ref parameter. + Indicates if values is in rows. + Returns true if can update data range; otherwise false. + + + + Detects if series in rows. + + Returns true if series values in row; otherwise - false. + + + + Changes chart type. + + Represents new chart type. + Value indicating whether to create series. + + + + Check and update the needed changes for chart to chartEx or chartEx to chart conversion + + previous chart type + new chart type + Value indicating whether to create series. + + + + Clear the stream which is to be ignored on chartEx and chart conversion + + + + + Prepares protection options before setting protection. + + + + + + + Calculate the serie name range by empty spaces + + Input data range to calculate + Input Data Range without series name range + boolean value indicates whether the chart is Excel 2016 or not + series name range + + + + Calculate and retruns the range after removing the input series name range + + The complete input range to calculate + Input series name range + Input series name range modified + the axis range + + + + + + + + + + + + + + + Update the chart categories by Range + + + + + Creates a copy of current instance. + + Parent object. + Returns clone of current object. + + + + Creates a copy of the current instance with the specified dictionary of worksheet names. + + Hash table with new Worksheet names. + Parent object. + Dictionary with new font indexes. + Cloned object which is a copy of the current object. + + + + Changes primary axis of the chart to secondary. + + If parsing - true; Otherwise false. + + + + Updates scalable font indexes in the chart sheet. + + Dictionary with new indexes. + + + + Updates font indexes in the chart sheet. + + Dictionary with new indexes. + + + + Checks for existing gridlines in chart. + + Returns true if gridlines exist; Otherwise false. + + + + Sets default chart grid lines on chart type or series type changing. + + Represents chart type to change. + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Returns the Boolean value indicates whether the chart is loading on sheet is parsing on demand. + + the boolean value + + + + Converts the chart to image stream. + + Stream object where the image is streamed. + + + + Converts the specified double value into 32-bits fixed-point value. + + Value to convert. + Converted 32-bits fixed-point value. + + + + Converts the specified 32-bits fixed-point value into double. + + Value to convert. + Converted double value. + + + + Creates primary series axis. + + Created axis. + + + + Check for if any series is bubble_3D,Assign SerieFormat + + Chart to be changed + + + + Returns the chart color respect to index on automatic format + + index of the series or data points + total count of series and data points + Indicates whether the parent workbook is binary or not + Indicates whether the color to be taken from color palette only for line,scatter,radar in binary files + the Color of the chart + + + + Get the chart color based on the color index + + input color theme index + the equivalent color based on the theme index + + + + This method is called during dispose operation. + + + + + Indicates the DateTime axis contains a string reference or not. + + + + + Specifies the contents of this attribute contain an integer between -100 and 100. + + + + + Represents whether to serialize gapwidth + + + + + Gets or sets the rotation of the 3D chart view + (the rotation of the plot area around the z-axis, in degrees)-(0 to 360 degrees). + + The value of this property must be from 0 to 360, except for 3-D bar charts, + where the value must be from 0 to 44. The default value is 20. Applies only to 3-D charts. + + + + Gets or sets the elevation of the 3-D chart view, in degrees (–90 to +90 degrees). + + + The chart elevation is the height at which you view the chart, in degrees. + The default is 15 for most chart types. The value of this property must be between -90 and 90, except + for 3-D bar charts, where it must be between 0 and 44. + + + + + Gets or sets the perspective for the 3D chart view (0 to 100). + + This property is ignored if the property is True. + + + + Gets or sets the type of the pivot chart. + + The type of the pivot chart. + + + + Gets or sets the pivot source. + + The pivot source. + + + + Gets or sets name of the preserved pivot source stream. + + + + + Gets or sets the format id of the chart. + + + + + True if the chart has pivot source. False otherwise. + + + + + Gets or sets a boolean value indicating whether to show all field buttons on a pivot chart. + + + true to show all field buttons; false otherwise. + + + + + Gets or sets a boolean value indicating whether to show value field buttons on a pivot chart. + + + true to show value field buttons; false otherwise. + + + + + Gets or sets a boolean value indicating whether to show axis field buttons on a pivot chart. + + + true to show axis field buttons; false otherwise. + + + + + Gets or sets a boolean value indicating whether to show legend field buttons on a pivot chart. + + + true to show legend field buttons; false otherwise. + + + + + Gets or sets a boolean value indicating whether to show ExpandCollapse field buttons on a pivot chart. + + + true to show ExpandCollapse field buttons; false otherwise. + + + + + Gets or sets a boolean value indicating whether to show report filter field buttons on a pivot chart. + + + true to show report filter field buttons; false otherwise. + + + + + Gets or sets the height of a 3D chart as a percentage of the chart width + (5 - 500 percent). + + + + + Gets or sets the depth of a 3D chart as a percentage of the chart width + (20 - 2000 percent). + + + + + Gets or sets the distance between data series in a 3D chart, as a percentage of marker width ( 0 - 500 ). + + + + + True if the chart axes are at right angles, independent of chart rotation or elevation. otherwise False. + + + + + True to automatically scale the chart. otherwise False. The property must be True. + + Excel scales a 3-D chart so that it is closer in size to the equivalent 2-D chart when this property is enabled. + + + + True if grid lines are drawn two-dimensionally on a 3-D chart. otherwise False. + + + + + Gets or sets the . + + + + + Gets or sets a value referring to the source level for series names. + + + + + Gets or sets a value referring to the source level for the category labels. + + + + + Gets or sets the data range for the chart series. + + + + + True to swap the data in over the axis. Series data is charted + on the Y axis by default. + + Data being charted on the X axis will move to the Y axis and vice versa. + + + + Gets or sets the title of the chart. + + + + + Gets the area for chart title. Read-only. + + + + + Gets the font used for title display. Read-only. + + + + + Gets or sets the title of the category axis. + + + + + Gets or sets the title of the value axis. + + + + + Gets or sets the title of the secondary category axis. + + + + + Gets or sets the title of the secondary value axis. + + + + + Gets or sets the title of the series axis. + + + + + Gets the primary category axis of the chart. Read-only. + + + Charts are plotted using X and Y axes. The Y axes typically have numerical scales, whereas the X axes typically have categorical scales. + Some charts, for example, have axes, and others, like PieChart don't. + Most charts have horizontal axis of type and vertical axis of type + but some, like BarChart, have the opposite. + represents an axis used for categories. Categories can include string, numeric, and date values. + + + + Gets the primary value axis. Read-only. + + + Charts are plotted using X and Y axes. The Y axes typically have numerical scales, whereas the X axes typically have categorical scales. + Some charts, for example, have axes, and others, like PieChart don't. + Most charts have horizontal axis of type and vertical axis of type + but some, like BarChart, have the opposite. + represents an axis used for series values. + + + + Gets the primary series axis. Read-only. + + This is the depth axis showing the depth of the third dimension in 3D charts. + + + + Gets the secondary category axis of the chart. Read-only. + + + The most commonly used charts have a set of primary axes and may have a set of secondary axes. + You can enable and disable this through property. + + + + + Gets the secondary value axis of the chart. Read-only. + + + The most commonly used charts have a set of primary axes and may have a set of secondary axes. + You can enable and disable this through property. + + + + + Gets the page setup for the chart. Read-only. + + + + + Gets or sets the X coordinate of upper-left corner + of the chart in points (1/72 inch). + + + + + Gets or sets the Y coordinate of upper-left corner + of the chart in points (1/72 inch). + + + + + Gets or sets the width of the chart in points (1/72 inch). + + + + + Gets or sets the height of the chart in points (1/72 inch). + + + + + Gets the collection of series of the chart. Read-only. + + + + + Gets a collection of categories of the chart. Read-only. + + Charts are plotted using X and Y axes. X axes typically have categorical scales. + Categories can include string, numeric, and date values. + + + + Gets chart format collection in primary axis. + + + + + Gets the chart format collection in secondary axis. + + + + + Gets the chart area. Read-only. + + + + + Gets or sets whether the chart has chart area. + + + + + Gets or sets a boolean value indicating whether the chart has plot area. + + + + + Gets the plot area where the chart data is plotted. Read-only. + + The plot area on a 2-D chart contains the data markers, grid lines, data labels, trend lines, + and optional chart items placed in the chart area. The plot area on a 3-D chart contains all the above items + plus the walls and floor. + The plot area is surrounded by the chart area. + + + + Gets the primary parent axis. Read-only. + + + + + Gets the secondary parent axis. Read-only. + + + + + Gets the walls of the 3D chart. Read-only. + + + + + Gets the side wall of the 3D chart. Read-only. + + + + + Gets the back wall of the 3D chart. Read-only. + + + + + Gets the floor of the 3D chart. Read-only. + + + + + Gets the data table of the chart. Read-only. + + + + + True if the chart has data table. otherwise False. + + + + + Gets legend in the chart. Read-only. + + This is a key that identifies patterns, colors or symbols associated with the markers of a chart data series. + It shows data series name corresponding to each data marker. + + + + + True if the chart has a legend object. otherwise False. + + + + + Gets or sets a value indicating how the blank cells are plotted on chart. + + + + + Gets or sets a value indicating how the displayNaAsblank on chart. + + + + + True if only visible cells are plotted. False if both visible and hidden cells are plotted. + + + + + Gets or sets a value indicating whether to show the PlotVisibleOnly attribute. + + + + + True if the chart is resized to match the size of the chart sheet window. + False if the chart size is not attached to the window size. Applies only to chart sheets. + + + + + Gets a Boolean value indicating whether this chart supports walls and floor. Read-only. + + + + + True if drawing objects in the tab sheet are protected. Read-only. + + + + + True if the scenarios of the current sheet are protected. False otherwise. Read-only. + + + + + Gets protected options. Read-only. + + For setting protection options use "Protect" method. + + + + Gets the plot area layout record. Read-only. + + + + + Represents the common category label values. + + + + + Represents the category lable reference as range + + + + + Represents the chart is created or parsed + + + + + Properties for list of theme colors. + + + + + Gets or sets the chart sheet tab color. + + + + + True if chart has a category axis. False otherwise. Read-only. + + + + + True if chart has a value axis. False otherwise. Read-only. + + + + + True if chart has a series axis. False otherwise. Read-only. + + + + + True if chart is stacked. False otherwise. Read-only. + + + + + True if chart is 100%. False otherwise. Read-only. + + The chart assumes that the values add up to 100%, so all the columns will occupy the entire area. + + + + True if chart is a 3D- chart. False otherwise. Read-only. + + + + + Gets a value indicating whether this instance is 3D pivot chart. + + + true if this instance is 3D pivot chart; false otherwise. Read-only. + + + + + True if chart is a line chart. False otherwise. Read-only. + + + + + True if chart needs data format to be saved. False otherwise. Read-only. + + + + + True if chart needs marker format to be saved. Read-only. + + + + + True if chart is a bar chart. False otherwise. Read-only. + + + + + True if chart is in a pyramid shape. False otherwise. Read-only. + + + + + True if chart is in a conical shape. False otherwise. Read-only. + + + + + True if chart is in a cylinder shape. False otherwise. Read-only. + + + + + True if chart is a bubble chart. False otherwise. Read-only. + + + + + True if chart is a doughnut shaped chart. False otherwise. Read-only. + + + + + True if chart should have a different color for each series value. False otherwise. Read-only. + + + + + True if chart is in in exploded view. False otherwise. Read-only. + + + + + True if the chart has series lines. False otherwise. Read-only. + + + + + True if chart has series lines. False otherwise. Read-only. + + + + + True if chart is a scatter chart. False otherwise. Read-only. + + + + + Gets the default line pattern for the chart. Read-only. + + + + + True if chart has smoothed lines. False otherwise. Read-only. + + + + + True if this is a stock chart. False otherwise. Read-only. + + + + + True if chart needs drop bars to be saved. False otherwise. Read-only. + + + + + True if chart is a stock chart with volume. False otherwise. Read-only. + + + + + True if chart has perspective. False otherwise. Read-only. + + + + + True if the chart is a clustered chart. False otherwise. Read-only. + + + + + True if chart has no plot area. False otherwise. Read-only. + + + + + True if chart is a radar chart. False otherwise. Read-only. + + + + + True if chart is a pie chart. False otherwise. Read-only. + + + + + True if chart has walls. False otherwise. Read-only. + + + + + True if chart has floor. False otherwise. Read-only. + + + + + Gets the serialized axis ids. + + The serialized axis ids. + + + + True if secondary category axis is present. False otherwise. Read-only. + + + + + True if secondary value axis is present. False otherwise. Read-only. + + + + + True if at least one of the secondary axes is present. False otherwise. Read-only. + + + + + True if chart needs special data labels serialization. False otherwise. + Read-only. + + + + + True if chart has percentage data labels. False otherwise. Read-only. + + + + + True if chart has bubble data labels. False otherwise. Read-only. + + + + + True if the chart is manually formatted. False otherwise. + + + + + This record stores scale factors for font scaling. + + + + + Plot are bounding box. Read-only. + + + + + Gets the parent workbook. Read-only. + + + + + Gets the inner chart area. Read-only. + + + + + Gets the inner plot area. Read-only. + + + + + Gets the start serie type of chart. Read-only. + + + + + Page setup for the chart. Read-only. + + + + + Gets the chart options. Read-only. + + + + + Gets the parsing status of chart. Read-only. + + + + + Gets chart format for 3-d charts. Read-only. + + + + + True if the chart or series type is changed. False otherwise. + + + + + Gets or sets the resulting chart type after type change operation. + + + + + Gets the collection of chart relations. Read-only. + + + + + Gets or sets the style index chart. + + + + + Gets a value indicating whether chart floor object is created. False otherwise. + + + + + True if the chart walls are present. False otherwise. Read-only. + + + + + Gets or sets pivot formats stream. + + + + + Gets or sets a Bolean value indicating whether chart sheet is zoom to fit window. + + + + + Gets default protection options for the worksheet. + + + + + Gets a value indicating whether chart is embeded into worksheet. False otherwise. Read-only. + + + + + Gets the font index from the default font records. Read-only. + + + + + Gets or sets preserved band formats for surface chart. + + + + + True if the chart has title. False otherwise. + + + + + True if the chart has title. False otherwise. Read-only. + + + + + Preserves the Chart's Default Text Property. + TODO: Need to support Chart default text proprety, should be remove after we start to parse. + + + + + Gets the font used for axis text display. Read-only. + + + + + Retruns the boolean value indicates whether the font is available + + + + + Gets or sets to specify the title shall not be shown for this chart. + + + + + Boolean value indicates whether the chart title area is null or not. + + + + + Gets or sets the boolean value to load worksheets on demand + + + + + Gets or sets to specify the title shall not be shown for this chart. + + + + + Boolean value indicates whether the chart Data holder is not worksheet's DataHolder.Read-Only + + + + + Properties for list of chart series groups. + + + + + Indicates the position and alignment of chart title + + + + + Indicates the chart title included in chart + + + + + Gets / Sets the Auto update member variable + + + + + Gets / Sets the ChartEx relation Id member variable + + + + + True if the chart type is treemap or sunburst. Otherwise false + + + + + True if the chart type is histogram or pareto. Otherwise false + + + + + Provides the data cache information + Used at parsing + + + + + formula referred for category values + + + + + formula referred for series values + + + + + Array of values used in series values + + + + + Array of values used in categories + + + + + Boolean value indicates category values interpreted in row-wise + + + + + Boolean value indicates series values interpreted in row-wise + + + + + format code used in series values + + + + + format code used in category values + + + + + Copy the current properties to chart serie + + series in which properties to be copied + Parent workbook + + + + Gets/Sets formula referred for category values + + + + + Gets / Sets formula referred for series values + + + + + Gets / SetsArray of values used in series values + + + + + Gets/Sets Array of values used in categories + + + + + Gets / SetsBoolean value indicates category values interpreted in row-wise + + + + + Gets / SetsBoolean value indicates series values interpreted in row-wise + + + + + Gets / Sets the format code for series values + + + + + Gets / Sets the format code for series categories + + + + + Represents chart interior. + + + + + Represents the chart interior. Interior of chart is supported in Chart area and Plot area only. + + + + + Gets or sets the foreground color of the chart. Foreground color values are from . + + + To know more about charts refer this link. + + The following code illustrates the use of ForegroundColor property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the foreground color of the chart + chart.ChartArea.Interior.ForegroundColor = System.Drawing.Color.AliceBlue; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the background color of the chart. Background color values are from . + + + Background color can be visible only if the Interior Pattern is enable. To know more about charts refer this link. + + The following code illustrates the use of BackgroundColor property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the backgroundColor color of the chart + chart.ChartArea.Interior.BackgroundColor = System.Drawing.Color.Red; + chart.ChartArea.Interior.Pattern = ExcelPattern.Angle; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the area pattern. Pattern property values are from . + + + To know more about charts refer this link. + + The following code illustrates the use of Pattern property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the pattern of the chart + chart.ChartArea.Interior.Pattern = ExcelPattern.Angle; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the index of foreground color in . + + + To know more about charts refer this link. + + The following code illustrates the use of ForegroundColorIndex property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the index of foreground color + chart.ChartArea.Interior.ForegroundColorIndex = ExcelKnownColors.Aqua; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the index of background color in . + + + Background color index can be visible only if the Interior Pattern is enable. To know more about charts refer this link. + + The following code illustrates the use of BackgroundColorIndex property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the backgroundColor color of the chart + chart.ChartArea.Interior.BackgroundColorIndex = ExcelKnownColors.Bright_green; + chart.ChartArea.Interior.Pattern = ExcelPattern.Angle; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + True to use automatic format. False to use custom format. + + + To know more about charts refer this link. + + The following code illustrates the use of UseAutomaticFormat property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //True to use automatic format for interior + chart.ChartArea.Interior.UseAutomaticFormat = true; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + True if foreground and background colors are swapped when the data value is negative. otherwise False. + + + The SwapColorsOnNegative property works on Binary Excel format only. To know more about charts refer this link. + + The following code illustrates the use of SwapColorsOnNegative property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = -92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = -55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + chart.IsSeriesInRows = false; + + //True if foreground and background colors are swapped when the data value is negative + chart.Series[0].SerieFormat.Interior.SwapColorsOnNegative = true; + + workbook.SaveAs("Charts.xls"); + workbook.Close(); + } + + + + + + Represents area format record. + + + + + Represents parent book. + + + + + Represents parent Series format. + + + + + Represents series fore color. + + + + + Represents series back color. + + + + + Represents dictionary to convert excelPattern to excelgradient pattern. + key - ExcelPattern, value - ExcelGradientPattern. + + + + + Initialize all static members. + + + + + Creates chart interior instance. + + Represents current application. + Represents parent object. + + + + Creates chart interior instance. + + Represents current application. + Represents parent object. + Represents area record. + + + + Creates new instance of class. + + Represents current application. + Represents parent object. + Represents record storage. + Represents position in storage. + + + + Finds parent objects. + + + + + Finds parent objects. + + Represents chart interior record. + + + + Parsing current object. + + Records offset. + Position in offset. + + + + Serialize current object. + + Records offset. + + + + Updates foreground color. + + + + + Updated background color. + + + + + Initialize interior for frame format. + + Indicate is autosize interior. + Represents is 3d chart. + Indicates is interior is gray. + + + + Initialize interior for frame format. + + Indicate is autosize interior. + Represents is 3d chart. + Indicates is interior is gray. + Indicates is default color is gray_50. + + + + Clones current object. + + Represents parent object. + Returns cloned object. + + + + Makes copy of the current object and update its parent. + + Represents Parent object to set. + Cloned object. + + + + Foreground color (RGB). + + + + + Background color (RGB). + + + + + Gets or sets the foreground color of the chart. + + + + + Gets or sets the background color of the chart. + + + + + Gets or sets the area pattern. + + + + + Gets or sets the index of foreground color in . + + + + + Gets or sets the index of background color in . + + + + + True to use automatic format. False to use custom format. + + + + + True if foreground and background colors are swapped when the data value is negative. otherwise False. + + + + + Represents collection of ChartLegendEntries in chart legend. + + + + + Represents a collection of legend entries in the chart. + + + + + Gets the number of legend entries in the collection. Read-only. + + + To know more about charts refer this link. + + The following code illustrates use of LegendEntries Count property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Gets the count of legend entries. + int legendEntriesCount = chart.Legend.LegendEntries.Count; + if (legendEntriesCount != 0) + { + //Your code here + } + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets the legend entry with the specified index. Read-only. + + + To know more about charts refer this link. + + The following code illustrates use of iIndex property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Create a chartLegend + IChartLegend chartLegend = chart.Legend; + chartLegend.LegendEntries[1].TextArea.Color = ExcelKnownColors.Blue_grey; + chartLegend.LegendEntries[1].TextArea.Size = 10; + chartLegend.LegendEntries[1].TextArea.FontName = "Bernard MT Condensed"; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Represents global storage for legend entries. + Key - entry index; Value - legend entry. + + + + + Represents parent chart. + + + + + Creates new instance of Legend entry collection. + + Represents current application. + Parent object. + + + + Finds all parent objects. + + + + + Adds legend to collection by index. + + Represents index of new entry in collection.( Zero based ) + Returns added entry. + + + + Adds legend to collection by index. + + Represents index of new entry in collection.( Zero based ) + Represents entry to add. + Returns added entry. + + + + Checks for contain changed from default formatting legend entry by index. + + Represents legend entry index. + Returns true if contains otherwise false. + + + + Checks before deleting legend entry. + + Represents index in collection. + If true - can delete; otherwise false. + + + + Updates legend entries collection after removing series. + + Index of legend entry to remove. + + + + Clones current object. + + Parent for cloned object. + Represents list with new font indexes. + Dictionary with new worksheet names. + Returns cloned object. + + + + Clears current collection. + + + + + Adds value to entry indexes. + + Represents start entry index. + Represents value to add. + + + + Represents count of legend entries in collection. Read-only. + + + + + Gets legend entry object by index. Read-only. + + + + + Returns the chartlegendentries collections + + + + + Class used for Chart Legend entries implementation. + + + + + Represents a legend entry in a chart legend. + + + + + Clears the legend entry. + + + To know more about charts refer this link. + + The following code illustrates how to use Clear method for legend. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Create a chartLegend + IChartLegend chartLegend = chart.Legend; + chartLegend.LegendEntries[1].TextArea.Color = ExcelKnownColors.Blue_grey; + chartLegend.LegendEntries[1].TextArea.Size = 10; + chartLegend.LegendEntries[1].TextArea.FontName = "Bernard MT Condensed"; + + //Clear the legend entry + chartLegend.LegendEntries[1].Clear(); + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Deletes the legend entry. + + + To know more about charts refer this link. + + The following code illustrates how to use Delete method for legend. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Create a chartLegend + IChartLegend chartLegend = chart.Legend; + + // Delete the first legend entry out of five entires + chartLegend.LegendEntries[0].Delete(); + + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + True if this entry is deleted. otherwise False. + + + To know more about charts refer this link. + + The following code illustrates use of IsDeleted property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Create a chartLegend + IChartLegend chartLegend = chart.Legend; + chartLegend.LegendEntries[0].Delete(); // Delete the first legend entry outof five entires + + //True if the entry is deleted + bool isDeletedEntry = chartLegend.LegendEntries[0].IsDeleted; + if(isDeletedEntry) + { + //Your Code here + } + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + True if the legend entry is formatted. otherwise False. + + + To know more about charts refer this link. + + The following code illustrates use of IsFormatted property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Create a chartLegend + IChartLegend chartLegend = chart.Legend; + chartLegend.LegendEntries[1].TextArea.Color = ExcelKnownColors.Blue_grey; + + //True if the legend entry is formatted + bool isEntryFromatted = chartLegend.LegendEntries[1].IsFormatted; + if(isEntryFromatted) + { + //Your Code here + } + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets the text area of the legend entry. Read-only. + + + To know more about charts refer this link. + + The following code illustrates use of TextArea property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Create a chartLegend + IChartLegend chartLegend = chart.Legend; + chartLegend.LegendEntries[1].TextArea.Color = ExcelKnownColors.Blue_grey; + chartLegend.LegendEntries[1].TextArea.Size = 10; + chartLegend.LegendEntries[1].TextArea.FontName = "Bernard MT Condensed"; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Represents LegendXN record. + + + + + Represents text of legend entry. + + + + + Represents parent chart legend entry collection. + + + + + Represents index of legend entry in collection. + + + + + Creates new instance of legend entry. + + Application object. + Parent object. + Represents index in collection + + + + Creates new instance of legend entry by parsing from stream. + + Application object. + Parent object. + Represents index in collection. + Represents record holder. + Represents position in stream. + + + + Parses legend entry. + + Record storage. + Position in storage. + + + + Finds parent object for collection. + + + + + Serialize legend entry object. + + Record storage. + + + + Clears the legend entry. + + + + + Deletes the legend entry. + + + + + Clones current object. + + Parent object. + Dictionary with new font indexes. + Dictionary with new worksheet names. + Returns cloned object. + + + + True if this entry is deleted. otherwise False. + + + + + True if the legend entry is formatted. otherwise False. + + + + + Gets the text area of the legend entry. Read-only. + + + + + Legend-entry index. + + + + + Represents index in collection. + + + + + Represents ChartLegend. + + + + + Represents the legend of the chart. + + + + + Clears the chart legend. + + + To know more about charts refer this link. + + The following code illustrates how to use the Clear method for legend of chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //Clears the legend of chart + sheet.Charts[0].Legend.Clear(); + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Deletes the chart legend. + + + To know more about charts refer this link. + + The following code illustrates how to use the Delete method for legend of chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //Delete the legend of chart + sheet.Charts[0].Legend.Delete(); + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Represents object for the legend. + + + To know more about charts refer this link. + + The following code illustrates use of FrameFormat property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets frame fromat for the legend + chart.Legend.FrameFormat.Border.LineColor = System.Drawing.Color.Orange; + chart.Legend.FrameFormat.Border.LinePattern = ExcelChartLinePattern.DashDotDot; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets the text area of the legend. Read-only. + + + To know more about charts refer this link. + + The following code illustrates use of TextArea property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets text area for the legend + chart.Legend.TextArea.Color = ExcelKnownColors.Blue_grey; + chart.Legend.TextArea.Size = 10; + chart.Legend.TextArea.FontName = "Bernard MT Condensed"; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets the X co-ordinate of upper-left corner of the legend. 1/4000 of chart plot. + + + To know more about charts refer this link. + + The following code illustrates use of X co-ordinate of upper-left corner of the legend. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //X co-ordinate of upper-left corner of the legend + chart.Legend.X = -80; + chart.Legend.Y = 30; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets the Y co-ordinate of upper-left corner of the legend. 1/4000 of chart plot. + + + To know more about charts refer this link. + + The following code illustrates use of Y co-ordinate of upper-left corner of the legend. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Y co-ordinate of upper-left corner of the legend + chart.Legend.Y = 30; + chart.Legend.X = -80; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the position of legend on the chart. The position values on the chart from . + + + To know more about charts refer this link. + + The following code illustrates use of Position property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the position of legend on the chart. + chart.Legend.Position = ExcelLegendPosition.Top; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + True if the legend is vertical. False if the legend is horizontal. + + Manual-sized legends always have this bit set to False. For right and left position IsVerticalLegent is true. For Top and Bottom position IsVerticalLegent is false. To know more about charts refer this link. + + The following code illustrates use of IsVerticalLegend property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + chart.Legend.Position = ExcelLegendPosition.Right; + + //True if the legend is vertical + if(chart.Legend.IsVerticalLegend) + { + //Your code here + } + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets the collection of legend entries. Read-only. + + + To know more about charts refer this link. + + The following code illustrates use of LegendEntries property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //Gets the count of legend entries. + int legendEntriesCount = chart.Legend.LegendEntries.Count; + if (legendEntriesCount != 0) + { + //Your code here + } + + //Legent entry text area color + chart.Legend.LegendEntries[0].TextArea.Color = ExcelKnownColors.Blue_grey; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + True to show legend without overlapping the chart. otherwise False. + The default is True. + + Not applicable to Binary files. To know more about charts refer this link. + + The following code illustrates use of IncludeInLayout property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //True to show legend without overlapping the chart + IChartLegend chartLegend = chart.Legend; + chartLegend.IncludeInLayout = true; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the layout options of the legend. + + + To know more about charts refer this link. + + The following code illustrates use of Layout property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.LeftColumn = 5; + chart.RightColumn = 11; + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Cone_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the layout options of the legend + chart.Legend.Layout.Height = 100; + chart.Legend.Layout.Width = 60; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Represents top-left position in pos record. + + + + + Represents chart legend record. + + + + + Represents chart pos record. + + + + + Attached label layout + + + + + Represents chart text record and sub records. + + + + + Represents legend frame format. + + + + + Show legend without overlapping. Default is True. + + + + + Represents parent chart. + + + + + Represents collection of legend entries. + + + + + Represents Excel 2007 layout data + + + + + Represents the TextArea Paragraph + + + + + Represents the legend text properties stream + + + + + Represents the default ChartTextArea settings + + + + + Represents the default ChartTextArea settings + + + + + short value indicates the chartEx element position + + + + + Creates new instance. + + Current application. + Parent object. + + + + Finds all parent objects. + + + + + Parsing current object. + + Records offset. + Position in offset. + + + + The legend text area applied events into the legend properties + + The legend property position + The object of the legend properties events + + + + Serialize current object. + + Represents record to serialize + + + + Saves single record into list of biff records. + + OffsetArrayList that will receive necessary records. + Record to serialize. + + + + Clones current object. + + Parent object. + Array with new font indexes. + Dictionary with new worksheet names. + Returns cloned object. + + + + Clears the chart legend. + + + + + Deletes the chart legend. + + + + + Sets to default position + + + + + Sets legend to custom position. + + + + + Represents object for the legend. + + + + + Gets the text area of the legend. Read-only. + + + + + True to show legend without overlapping the chart. otherwise False. + The default is True. + + Not applicable to Binary files + + + + X-position of upper-left corner. 1/4000 of chart plot. + + + + + Gets the Y co-ordinate of upper-left corner of the legend. 1/4000 of chart plot. + + + + + Gets or sets the position of legend on the chart. + + + + + True if the legend is vertical. False if the legend is horizontal. + + Manual-sized legends always have this bit set to False. + + + + Gets the collection of legend entries. Read-only. + + + + + Represents the Default ChartTextArea Settings + + + + + Gets or Sets the value indicating whether the ChartTextArea settings are applied from the chart default text settings. + + + + + X-size. + + + + + Y-size. + + + + + True if chart contains data table. + + + + + Spacing: + 0 = close + 1 = medium + 2 = open + + + + + Automatic positioning (True if legend is docked). + + + + + Automatic series distribution (True in Microsoft Excel 5.0). + + + + + X positioning is automatic. + + + + + Y positioning is automatic. + + + + + Gets or sets the layout options of the legend. + + + + + Represents the Legend Paragraph + + + + + Return attached label layout record. Read-only + + + + + Indicates the position and alignment of chart legend + + + + + Returns legend record. Read-only. + + + + + Returns position record. Read-only. + + + + + Class allows users to configure Print setting of chart. + + + + + Summary description for PageSetupBaseImpl. + + + + + Base interface for all page setups. + + + + + Indicates whether FirstPageNumber is set to Auto or not. + + + To know more about page settings refer this link. + + The following code illustrates the use of AutoFirstPageNumber property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.Range["A1:D20"].CellStyle.FillBackground = ExcelKnownColors.Aqua; + sheet.Range["F1:R40"].CellStyle.FillBackground = ExcelKnownColors.Light_orange; + sheet.Range["A54:T80"].CellStyle.FillBackground = ExcelKnownColors.Light_blue; + sheet.Range["E1:T30"].CellStyle.Font.Color = ExcelKnownColors.Brown; + sheet.Range["A1:C50"].CellStyle.Font.Color = ExcelKnownColors.Green; + sheet.Range["A54:T90"].CellStyle.Font.Color = ExcelKnownColors.Red; + + //True to set FirstPageNumber as Auto + sheet.PageSetup.AutoFirstPageNumber = true; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + True if elements of the document will be printed in black and white. + Read / write Boolean. + + + To know more about page settings refer this link. + + The following code illustrates the use of BlackAndWhite property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.Range["A1:D20"].CellStyle.FillBackground = ExcelKnownColors.Aqua; + sheet.Range["F1:R40"].CellStyle.FillBackground = ExcelKnownColors.Light_orange; + sheet.Range["A54:T80"].CellStyle.FillBackground = ExcelKnownColors.Light_blue; + sheet.Range["E1:T30"].CellStyle.Font.Color = ExcelKnownColors.Brown; + sheet.Range["A1:C50"].CellStyle.Font.Color = ExcelKnownColors.Green; + sheet.Range["A54:T90"].CellStyle.Font.Color = ExcelKnownColors.Red; + + //True to document will be printed in black and white. + sheet.PageSetup.BlackAndWhite = true; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the size of the bottom margin, in inches. Default value of bottom margin is 0.75. + Read / write Double. + + + To know more about page settings property refer this link. + + The following code illustrates the use of BottomMargin property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + + //sets the size of the bottom margin + sheet.PageSetup.BottomMargin = 0.75; + sheet.PageSetup.FooterMargin = 0.4; + sheet.PageSetup.HeaderMargin = 0.4; + sheet.PageSetup.LeftMargin = 0.75; + sheet.PageSetup.RightMargin = 0.75; + sheet.PageSetup.TopMargin = 0.75; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the center part of the footer. Read / write String. + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page setting refer this link. + + The following code illustrates the use of CenterFooter property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + + //Sets the center part of the footer + sheet.PageSetup.CenterFooter = "Center Footer &G"; + sheet.PageSetup.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + + sheet.PageSetup.CenterHeader = "Center Header &G"; + sheet.PageSetup.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.LeftFooter = "Left Footer &G"; + sheet.PageSetup.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + sheet.PageSetup.LeftHeader = "Left Header &G"; + sheet.PageSetup.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.RightFooter = "Right Footer &G"; + sheet.PageSetup.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + sheet.PageSetup.RightHeader = "Right Header &G"; + sheet.PageSetup.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets / sets image for center part of the footer. + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of CenterFooterImage property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + + //Set image for center part of the footer + sheet.PageSetup.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.CenterFooter = "Center Footer &G"; + + sheet.PageSetup.CenterHeader = "Center Header &G"; + sheet.PageSetup.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.LeftFooter = "Left Footer &G"; + sheet.PageSetup.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + sheet.PageSetup.LeftHeader = "Left Header &G"; + sheet.PageSetup.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.RightFooter = "Right Footer &G"; + sheet.PageSetup.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + sheet.PageSetup.RightHeader = "Right Header &G"; + sheet.PageSetup.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets / set image for center part of the header. + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of CenterHeaderImage property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + + //Set image for center part of the header + sheet.PageSetup.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.CenterHeader = "Center Header &G"; + + sheet.PageSetup.CenterFooter = "Center Footer &G"; + sheet.PageSetup.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.LeftFooter = "Left Footer &G"; + sheet.PageSetup.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + sheet.PageSetup.LeftHeader = "Left Header &G"; + sheet.PageSetup.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.RightFooter = "Right Footer &G"; + sheet.PageSetup.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + sheet.PageSetup.RightHeader = "Right Header &G"; + sheet.PageSetup.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the center part of the header. Read / write String. + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of CenterHeader property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + + //Sets the center part of the header + sheet.PageSetup.CenterHeader = "Center Header &G"; + sheet.PageSetup.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + + sheet.PageSetup.CenterFooter = "Center Footer &G"; + sheet.PageSetup.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.LeftFooter = "Left Footer &G"; + sheet.PageSetup.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + sheet.PageSetup.LeftHeader = "Left Header &G"; + sheet.PageSetup.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.RightFooter = "Right Footer &G"; + sheet.PageSetup.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + sheet.PageSetup.RightHeader = "Right Header &G"; + sheet.PageSetup.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + True if the sheet is centered horizontally on the page when it is + printed. Read / write Boolean. + + + To know more about page settings refer this link. + + The following code illustrates the use of CenterHorizontally property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.Range["A1:D20"].CellStyle.FillBackground = ExcelKnownColors.Aqua; + sheet.Range["F1:R40"].CellStyle.FillBackground = ExcelKnownColors.Light_orange; + sheet.Range["A54:T80"].CellStyle.FillBackground = ExcelKnownColors.Light_blue; + sheet.Range["E1:T30"].CellStyle.Font.Color = ExcelKnownColors.Brown; + sheet.Range["A1:C50"].CellStyle.Font.Color = ExcelKnownColors.Green; + sheet.Range["A54:T90"].CellStyle.Font.Color = ExcelKnownColors.Red; + + //True to print the sheet is centered horizontally + sheet.PageSetup.CenterHorizontally = true; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + True if the sheet is centered vertically on the page when it is + printed. Read / write Boolean. + + + To know more about page settings refer this link. + + The following code illustrates the use of CenterVertically property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.Range["A1:D20"].CellStyle.FillBackground = ExcelKnownColors.Aqua; + sheet.Range["F1:R40"].CellStyle.FillBackground = ExcelKnownColors.Light_orange; + sheet.Range["A54:T80"].CellStyle.FillBackground = ExcelKnownColors.Light_blue; + sheet.Range["E1:T30"].CellStyle.Font.Color = ExcelKnownColors.Brown; + sheet.Range["A1:C50"].CellStyle.Font.Color = ExcelKnownColors.Green; + sheet.Range["A54:T90"].CellStyle.Font.Color = ExcelKnownColors.Red; + + //True to print the sheet is centered vertically + sheet.PageSetup.CenterVertically = true; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Number of copies to print. + + + To know more about page settings refer this link. + + The following code illustrates the use of Copies property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.Range["A1:D20"].CellStyle.FillBackground = ExcelKnownColors.Aqua; + sheet.Range["F1:R40"].CellStyle.FillBackground = ExcelKnownColors.Light_orange; + sheet.Range["A54:T80"].CellStyle.FillBackground = ExcelKnownColors.Light_blue; + sheet.Range["E1:T30"].CellStyle.Font.Color = ExcelKnownColors.Brown; + sheet.Range["A1:C50"].CellStyle.Font.Color = ExcelKnownColors.Green; + sheet.Range["A54:T90"].CellStyle.Font.Color = ExcelKnownColors.Red; + + //Number of Copies to be printed + sheet.PageSetup.Copies = 3; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + True if the sheet will be printed without graphics. + Read / write Boolean. + + + To know more about page settings refer this link. + + The following code illustrates the use of Draft property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.Range["A1:D20"].CellStyle.FillBackground = ExcelKnownColors.Aqua; + sheet.Range["F1:R40"].CellStyle.FillBackground = ExcelKnownColors.Light_orange; + sheet.Range["A54:T80"].CellStyle.FillBackground = ExcelKnownColors.Light_blue; + sheet.Range["E1:T30"].CellStyle.Font.Color = ExcelKnownColors.Brown; + sheet.Range["A1:C50"].CellStyle.Font.Color = ExcelKnownColors.Green; + sheet.Range["A54:T90"].CellStyle.Font.Color = ExcelKnownColors.Red; + + //True to sheet will be printed without graphics + sheet.PageSetup.Draft = true; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the first page number that will be used when + this sheet is printed. If xlAutomatic, Microsoft Excel chooses the + first page number. The default is xlAutomatic. Read / write Long. + + + To know more about page settings refer this link. + + The following code illustrates the use of FirstPageNumber property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.Range["A1:D20"].CellStyle.FillBackground = ExcelKnownColors.Aqua; + sheet.Range["F1:R40"].CellStyle.FillBackground = ExcelKnownColors.Light_orange; + sheet.Range["A54:T80"].CellStyle.FillBackground = ExcelKnownColors.Light_blue; + sheet.Range["E1:T30"].CellStyle.Font.Color = ExcelKnownColors.Brown; + sheet.Range["A1:C50"].CellStyle.Font.Color = ExcelKnownColors.Green; + sheet.Range["A54:T90"].CellStyle.Font.Color = ExcelKnownColors.Red; + + //Set the first page number to be printed + sheet.PageSetup.FirstPageNumber = 1; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the distance from the bottom of the page to the footer, + in inches. Read / write Double. Default value of FooterMargin is 0.3. + + + To know more about page settings refer this link. + + The following code illustrates the use of FooterMargin property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + + //Sets the distance from the bottom of the page to the footer + sheet.PageSetup.FooterMargin = 0.4; + + sheet.PageSetup.BottomMargin = 0.75; + sheet.PageSetup.HeaderMargin = 0.4; + sheet.PageSetup.LeftMargin = 0.75; + sheet.PageSetup.RightMargin = 0.75; + sheet.PageSetup.TopMargin = 0.75; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the distance from the top of the page to the header, + in inches. Read / write Double. The Default value of HeaderMargin is 0.3. + + + To know more about page settings refer this link. + + The following code illustrates the use of HeaderMargin property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + + //Sets the distance from the top of the page to the header + sheet.PageSetup.HeaderMargin = 0.4; + + sheet.PageSetup.BottomMargin = 0.75; + sheet.PageSetup.FooterMargin = 0.4; + sheet.PageSetup.LeftMargin = 0.75; + sheet.PageSetup.RightMargin = 0.75; + sheet.PageSetup.TopMargin = 0.75; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the left part of the footer. Read / write String. + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of LeftFooter property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + + //Sets the left part of the footer + sheet.PageSetup.LeftFooter = "Left Footer &G"; + sheet.PageSetup.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + + sheet.PageSetup.CenterFooter = "Center Footer &G"; + sheet.PageSetup.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.CenterHeader = "Center Header &G"; + sheet.PageSetup.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.LeftHeader = "Left Header &G"; + sheet.PageSetup.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.RightFooter = "Right Footer &G"; + sheet.PageSetup.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + sheet.PageSetup.RightHeader = "Right Header &G"; + sheet.PageSetup.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets / sets image for left part of the footer. + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of LeftFooterImage property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + + //Set image for left part of the footer + sheet.PageSetup.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + sheet.PageSetup.LeftFooter = "Left Footer &G"; + + sheet.PageSetup.CenterFooter = "Center Footer &G"; + sheet.PageSetup.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.CenterHeader = "Center Header &G"; + sheet.PageSetup.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.LeftHeader = "Left Header &G"; + sheet.PageSetup.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.RightFooter = "Right Footer &G"; + sheet.PageSetup.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + sheet.PageSetup.RightHeader = "Right Header &G"; + sheet.PageSetup.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets / sets image for left part of the header. + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings property refer this link. + + The following code illustrates the use of LeftHeaderImage property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + + //Set image for left part of the header + sheet.PageSetup.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.LeftHeader = "Left Header &G"; + + sheet.PageSetup.CenterFooter = "Center Footer &G"; + sheet.PageSetup.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.CenterHeader = "Center Header &G"; + sheet.PageSetup.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.LeftFooter = "Left Footer &G"; + sheet.PageSetup.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + sheet.PageSetup.RightFooter = "Right Footer &G"; + sheet.PageSetup.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + sheet.PageSetup.RightHeader = "Right Header &G"; + sheet.PageSetup.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the left part of the header. Read / write String. + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of LeftHeader property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + + //Sets the left part of the header + sheet.PageSetup.LeftHeader = "Left Header &G"; + sheet.PageSetup.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + + sheet.PageSetup.CenterFooter = "Center Footer &G"; + sheet.PageSetup.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.CenterHeader = "Center Header &G"; + sheet.PageSetup.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.LeftFooter = "Left Footer &G"; + sheet.PageSetup.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + sheet.PageSetup.RightFooter = "Right Footer &G"; + sheet.PageSetup.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + sheet.PageSetup.RightHeader = "Right Header &G"; + sheet.PageSetup.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the size of the left margin, in inches. + Read / write Double. Default value of left margin is 0.7. + + + To know more about page settings refer this link. + + The following code illustrates the use of LeftMargin property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + + //Sets the value for the left margin + sheet.PageSetup.LeftMargin = 0.75; + sheet.PageSetup.BottomMargin = 0.75; + sheet.PageSetup.FooterMargin = 0.4; + sheet.PageSetup.HeaderMargin = 0.4; + sheet.PageSetup.RightMargin = 0.75; + sheet.PageSetup.TopMargin = 0.75; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the order that Microsoft Excel uses to number + pages when printing a large worksheet. Read / write . + + + To know more about page settings refer this link. + + The following code illustrates the use of Order property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:J94"].Text = "PagePrint"; + sheet.Range["K48:M54"].Text = "page"; + + //Sets the order of the worksheets to be printed + sheet.PageSetup.Order = ExcelOrder.DownThenOver; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Portrait or landscape printing mode. Read / write . + + + To know more about page settings refer this link. + + The following code illustrates the use of Orientation property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:J94"].Text = "PagePrint"; + sheet.Range["K48:M54"].Text = "page"; + + //Sets a Portrait or landscape printing mode + sheet.PageSetup.Orientation = ExcelPageOrientation.Portrait; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the size of the paper. Read / write . Default value for size of paper is . + + + To know more about page settings refer this link. + + The following code illustrates the use of PaperSize property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:J94"].Text = "PagePrint"; + sheet.Range["K48:M54"].Text = "page"; + + //Sets the size of the paper + sheet.PageSetup.PaperSize = ExcelPaperSize.A2Paper; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the way of comments are printed with the sheet. + Read / write . We must include cell comments and print with the sheet. + + + To know more about page settings refer this link. + + The following code illustrates the use of PrintComments property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:J94"].Text = "PagePrint"; + sheet.Range["K48:M54"].Text = "page"; + + sheet.Range["A1"].AddComment().Text = "Sample Comments"; //Comment must be added + sheet.Range["A1"].Comment.IsVisible = true; //It is also must for PrintInPlace + + //Sets the way of comments are printed with the sheet + sheet.PageSetup.PrintComments = ExcelPrintLocation.PrintSheetEnd; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or returns an ExcelPrintErrors constant specifying the type of + print error displayed. This feature allows users to suppress the + display of error values when printing a worksheet. Read / write . + + + To know more about page settings refer this link. + + The following code illustrates the use of PrintErrors property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:J94"].Text = "PagePrint"; + sheet.Range["K48:M54"].Text = "page"; + sheet.Range["L1"].Number = 230; + sheet.Range["L2"].Number = 3722; + sheet.Range["L3"].Number = 987; + sheet.Range["L4"].Number = 5678; + sheet.Range["L5"].Formula = "ASIN(L1:L4)"; //Sets the sample formula with error value + sheet.Range["K5"].Text = "Cell Error"; + + //Specifying the type of print error to be displayed + sheet.PageSetup.PrintErrors = ExcelPrintErrors.PrintErrorsNA; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + True if cell notes are printed as end notes with the sheet. Applies + only to worksheets. Read / write Boolean. + + + To know more about page settings refer this link. + + The following code illustrates the use of PrintNotes property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:J94"].Text = "PagePrint"; + sheet.Range["K48:M54"].Text = "page"; + + //True if cell notes are printed as end notes with the sheet + sheet.PageSetup.PrintNotes = true; + sheet.Range["A1"].AddComment().Text = "Sample Comments"; + sheet.Range["A1"].Comment.IsVisible = true; + sheet.PageSetup.PrintComments = ExcelPrintLocation.PrintSheetEnd; //Notes are printed as end notes with the sheet + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the print quality in the dpi. Read / write ushort. + + + To know more about page settings refer this link. + + The following code illustrates the use of PrintQuality property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.Range["A1:D20"].CellStyle.FillBackground = ExcelKnownColors.Aqua; + sheet.Range["F1:R40"].CellStyle.FillBackground = ExcelKnownColors.Light_orange; + sheet.Range["A54:T80"].CellStyle.FillBackground = ExcelKnownColors.Light_blue; + sheet.Range["E1:T30"].CellStyle.Font.Color = ExcelKnownColors.Brown; + sheet.Range["A1:C50"].CellStyle.Font.Color = ExcelKnownColors.Green; + sheet.Range["A54:T90"].CellStyle.Font.Color = ExcelKnownColors.Red; + + //Set the print quality in the dpi + sheet.PageSetup.PrintQuality = 600; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the right part of the footer. Read / write String. + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of RightFooter property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + + //Sets the right part of the footer + sheet.PageSetup.RightFooter = "Right Footer &G"; + sheet.PageSetup.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + + sheet.PageSetup.CenterFooter = "Center Footer &G"; + sheet.PageSetup.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.CenterHeader = "Center Header &G"; + sheet.PageSetup.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.LeftFooter = "Left Footer &G"; + sheet.PageSetup.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + sheet.PageSetup.LeftHeader = "Left Header &G"; + sheet.PageSetup.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.RightHeader = "Right Header &G"; + sheet.PageSetup.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets / sets image for right part of the footer. + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of RightFooterImage property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + + //Set image for right part of the footer + sheet.PageSetup.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + sheet.PageSetup.RightFooter = "Right Footer &G"; + + sheet.PageSetup.CenterFooter = "Center Footer &G"; + sheet.PageSetup.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.CenterHeader = "Center Header &G"; + sheet.PageSetup.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.LeftFooter = "Left Footer &G"; + sheet.PageSetup.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + sheet.PageSetup.LeftHeader = "Left Header &G"; + sheet.PageSetup.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.RightHeader = "Right Header &G"; + sheet.PageSetup.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets / sets image for right part of the header. + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of RightHeaderImage property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + + //Set image for right part of the header + sheet.PageSetup.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + sheet.PageSetup.RightHeader = "Right Header &G"; + + sheet.PageSetup.CenterFooter = "Center Footer &G"; + sheet.PageSetup.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.CenterHeader = "Center Header &G"; + sheet.PageSetup.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.LeftFooter = "Left Footer &G"; + sheet.PageSetup.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + sheet.PageSetup.LeftHeader = "Left Header &G"; + sheet.PageSetup.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.RightFooter = "Right Footer &G"; + sheet.PageSetup.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the right part of the header. Read / write String. + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of RightHeader property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + + //Sets the right part of the header + sheet.PageSetup.RightHeader = "Right Header &G"; + sheet.PageSetup.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + + sheet.PageSetup.CenterFooter = "Center Footer &G"; + sheet.PageSetup.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.CenterHeader = "Center Header &G"; + sheet.PageSetup.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.LeftFooter = "Left Footer &G"; + sheet.PageSetup.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + sheet.PageSetup.LeftHeader = "Left Header &G"; + sheet.PageSetup.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.RightFooter = "Right Footer &G"; + sheet.PageSetup.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the size of the right margin, in inches. + Read / write Double. Default value of right margin is 0.7. + + + To know more about page settings refer this link. + + The following code illustrates the use of RightMargin property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + + //Sets the value for the right margin + sheet.PageSetup.RightMargin = 0.75; + + sheet.PageSetup.BottomMargin = 0.75; + sheet.PageSetup.FooterMargin = 0.4; + sheet.PageSetup.HeaderMargin = 0.4; + sheet.PageSetup.LeftMargin = 0.75; + sheet.PageSetup.TopMargin = 0.75; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the size of the top margin, in inches. + Read / write Double. Default value of top margin is 0.75. + + + To know more about page settings refer this link. + + The following code illustrates the use of TopMargin property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + + //Sets the value of the top margin + sheet.PageSetup.TopMargin = 0.75; + + sheet.PageSetup.BottomMargin = 0.75; + sheet.PageSetup.FooterMargin = 0.4; + sheet.PageSetup.HeaderMargin = 0.4; + sheet.PageSetup.LeftMargin = 0.75; + sheet.PageSetup.RightMargin = 0.75; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a percentage (between 10 and 400 percent) by which + Microsoft Excel will scale the worksheet for printing. Applies only + to worksheets. Read / write ushort. + + + To know more about page settings refer this link. + + The following code illustrates the use of Zoom property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.Range["A1:D20"].CellStyle.FillBackground = ExcelKnownColors.Aqua; + sheet.Range["F1:R40"].CellStyle.FillBackground = ExcelKnownColors.Light_orange; + sheet.Range["A54:T80"].CellStyle.FillBackground = ExcelKnownColors.Light_blue; + sheet.Range["E1:T30"].CellStyle.Font.Color = ExcelKnownColors.Brown; + sheet.Range["A1:C50"].CellStyle.Font.Color = ExcelKnownColors.Green; + sheet.Range["A54:T90"].CellStyle.Font.Color = ExcelKnownColors.Red; + + //Set a percentage to be zoom in print + sheet.PageSetup.Zoom = 200; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets / sets the header and footer margins are aligned with page margins. + + + To know more about page settings refer this link. + + The following code illustrates the use of AlignHFWithPageMargins property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.Range["A1:D20"].CellStyle.FillBackground = ExcelKnownColors.Aqua; + sheet.Range["F1:R40"].CellStyle.FillBackground = ExcelKnownColors.Light_orange; + sheet.Range["A54:T80"].CellStyle.FillBackground = ExcelKnownColors.Light_blue; + sheet.Range["E1:T30"].CellStyle.Font.Color = ExcelKnownColors.Brown; + sheet.Range["A1:C50"].CellStyle.Font.Color = ExcelKnownColors.Green; + sheet.Range["A54:T90"].CellStyle.Font.Color = ExcelKnownColors.Red; + + //True to sets the header and footer margins are aligned with page margins + sheet.PageSetup.AlignHFWithPageMargins = true; + + sheet.PageSetup.LeftMargin = 1.25; + sheet.PageSetup.RightMargin = 1.25; + sheet.PageSetup.CenterFooter = "Center Footer"; + sheet.PageSetup.CenterHeader = "Center Header"; + sheet.PageSetup.LeftFooter = "&D"; + sheet.PageSetup.LeftHeader = "&D"; + sheet.PageSetup.RightFooter = "&T"; + sheet.PageSetup.RightHeader = "&T"; + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets / sets the header and footer of the is different with other pages. + + + To know more about page settings refer this link. + + The following code illustrates the use of DifferentFirstPageHF property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.Range["A1:D20"].CellStyle.FillBackground = ExcelKnownColors.Aqua; + sheet.Range["F1:R40"].CellStyle.FillBackground = ExcelKnownColors.Light_orange; + sheet.Range["A54:T80"].CellStyle.FillBackground = ExcelKnownColors.Light_blue; + sheet.Range["E1:T30"].CellStyle.Font.Color = ExcelKnownColors.Brown; + sheet.Range["A1:C50"].CellStyle.Font.Color = ExcelKnownColors.Green; + sheet.Range["A54:T90"].CellStyle.Font.Color = ExcelKnownColors.Red; + + //True to sets the header and footer of the first page is different with other pages + sheet.PageSetup.DifferentFirstPageHF = true; + + sheet.PageSetup.CenterFooter = "Center Footer"; + sheet.PageSetup.CenterHeader = "Center Header"; + sheet.PageSetup.FirstPage.LeftFooter = "&T"; + sheet.PageSetup.FirstPage.LeftHeader = "&D"; + sheet.PageSetup.FirstPage.RightFooter = "&P"; + sheet.PageSetup.FirstPage.RightHeader = "&D"; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets / sets the header and footer odd pages are differed with even page. + + + To know more about page settings refer this link. + + The following code illustrates the use of DifferentOddAndEvenPagesHF property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.Range["A1:D20"].CellStyle.FillBackground = ExcelKnownColors.Aqua; + sheet.Range["F1:R40"].CellStyle.FillBackground = ExcelKnownColors.Light_orange; + sheet.Range["A54:T80"].CellStyle.FillBackground = ExcelKnownColors.Light_blue; + sheet.Range["E1:T30"].CellStyle.Font.Color = ExcelKnownColors.Brown; + sheet.Range["A1:C50"].CellStyle.Font.Color = ExcelKnownColors.Green; + sheet.Range["A54:T90"].CellStyle.Font.Color = ExcelKnownColors.Red; + + //True to sets the header and footer odd pages are differed with even page + sheet.PageSetup.DifferentOddAndEvenPagesHF = true; + + sheet.PageSetup.CenterFooter = "Center Footer"; + sheet.PageSetup.CenterHeader = "Center Header"; + sheet.PageSetup.EvenPage.LeftFooter = "&T"; + sheet.PageSetup.EvenPage.LeftHeader = "&D"; + sheet.PageSetup.EvenPage.RightFooter = "&P"; + sheet.PageSetup.EvenPage.RightHeader = "&D"; + sheet.PageSetup.HFScaleWithDoc = false; + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets / sets the header and footer are scaled with document scaling. The default value of HFScaleWithDoc property is true. + + + To know more about page settings refer this link. + + The following code illustrates the use of HFScaleWithDoc property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.Range["A1:D20"].CellStyle.FillBackground = ExcelKnownColors.Aqua; + sheet.Range["F1:R40"].CellStyle.FillBackground = ExcelKnownColors.Light_orange; + sheet.Range["A54:T80"].CellStyle.FillBackground = ExcelKnownColors.Light_blue; + sheet.Range["E1:T30"].CellStyle.Font.Color = ExcelKnownColors.Brown; + sheet.Range["A1:C50"].CellStyle.Font.Color = ExcelKnownColors.Green; + sheet.Range["A54:T90"].CellStyle.Font.Color = ExcelKnownColors.Red; + + //sets the header and footer are scaled with document scaling + sheet.PageSetup.HFScaleWithDoc = true; + + sheet.PageSetup.IsFitToPage = true; + sheet.PageSetup.CenterFooter = "Center Footer"; + sheet.PageSetup.CenterHeader = "Center Header"; + sheet.PageSetup.LeftFooter = "&T"; + sheet.PageSetup.LeftHeader = "&D"; + sheet.PageSetup.RightFooter = "&P"; + sheet.PageSetup.RightHeader = "&D"; + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets values for even page. The EvenPage have a values from the properties of . If the input workbook have a even page, we can get the header and footer values from the Evenpage Property. Otherwise the EvenPage property values are null or empty. + + + To know more about page settings refer this link. + + The following code illustrates the use of EvenPage property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //Set value of EvenPage header and footer + sheet.PageSetup.DifferentOddAndEvenPagesHF = true; + sheet.PageSetup.EvenPage.CenterFooter = "Center Footer"; + sheet.PageSetup.EvenPage.CenterHeader = "Center Header"; + sheet.PageSetup.EvenPage.LeftFooter = "&T"; + sheet.PageSetup.EvenPage.LeftHeader = "&D"; + sheet.PageSetup.EvenPage.RightFooter = "&P"; + sheet.PageSetup.EvenPage.RightHeader = "&D"; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets values for first page. The FirstPage have a values from the properties of . If the input workbook have a first page, we can get the header and footer values from the FirstProperty. Otherwise the FirstPage property values are null or empty. + + + To know more about page settings refer this link. + + The following code illustrates the use of FirstPage property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //Set the vales of FirstPage header and footer + sheet.PageSetup.DifferentFirstPageHF = true; + sheet.PageSetup.FirstPage.CenterFooter = "Center Footer"; + sheet.PageSetup.FirstPage.CenterHeader = "Center Header"; + sheet.PageSetup.FirstPage.LeftFooter = "&T"; + sheet.PageSetup.FirstPage.LeftHeader = "&D"; + sheet.PageSetup.FirstPage.RightFooter = "&P"; + sheet.PageSetup.FirstPage.RightHeader = "&D"; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets / sets background image. + + + Except UWP, Xamarin and ASP.NET Core platforms the BackgoundImage property must be . For UWP, Xamarin and ASP.NET Core platforms the BackgoundImage property is . To know more about page settings refer this link. + + The following code illustrates the use of BackgoundImage property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:J94"].Text = "PagePrint"; + + //sets background image + sheet.PageSetup.BackgoundImage = (System.Drawing.Bitmap)System.Drawing.Image.FromFile("D:/WorkSpace/WF-40376-APIs_in_page_settings/Output_Files/nature2.jpg"); + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Value of the top margin by default. + + + + + Value of the bottom margin by default. + + + + + Value of the left margin by default. + + + + + Value of the right margin by default. + + + + + Value of the top margin by default for XML. + + + + + Value of the bottom margin by default for XML. + + + + + Value of the left margin by default for XML. + + + + + Value of the right margin by default for XML. + + + + + Value of the header margin by default for XML. + + + + + Value of the footer margin by default for XML. + + + + + Whether to center between horizontal margins. + + + + + Whether to center between vertical margins. + + + + + Unknown record. This record contains additional information about + system printer. If such record is found, it is stored, otherwise we is skipped. + + + + + Stores print setup options. + + + + + This record contains information about worksheet bottom margin. + + + + + This record contains information about worksheet left margin. + + + + + This record contains information about worksheet right margin. + + + + + This record contains information about worksheet top margin. + + + + + Array of headers: 0 - left header, 1 - center header, 2 - right header. + + + + + Array of footers: 0 - left footer, 1 - center footer, 2 - right footer. + + + + + Parent sheet. + + + + + Contains background image. + + + + + Indicates whether page setup is in FitTo printing mode. + + + + + Dictionary which stores Max paper width + + + + + Dictionary which stores Max paper height + + + + + Stores print setup options. + + + + + Stores page options for even page. + + + + + Stores page options for odd page. + + + + + Stores page options for first page. + + + + + Fills the dictionaries with paper width size and height size + + + + + + Sets application and parent fields. + + Application object for the page setup. + Parent object for the page setup. + + + + Find parent Worksheet. + + + Can't find parent worksheet. + + + + + This function splits header or footer into three parts left, center, and right. + + + Header (footer) string that will be split into + parts: left, center, right. + + Array of split strings. + + + + Function combines header or footer strings array to one format string. + + Array which must contain only 3 elements. + Combined format string. + + When parameter is null. + + + When number of strings in parts is not 3. + + + + + Adds all records to OffsetArrayList. + + OffsetArrayList which will get all records. + + When at least one of the internal records is null. + + + + + Serializes some records before main page setup block. + + OffsetArrayList to serialize into. + + + + Serializes some records after main page setup block. + + OffsetArrayList to serialize into. + + + + Parses page setup. + + Array with biff records. + Starting position. + Position after parsing. + + + + Parses record. + + Record to parse. + True if record was successfully parsed, false otherwise. + + + + Returns record of the specified type from the array of Biff + records and sets its position after the returned record. + + Array of Biff records. + Starting from this position, record must be searched. + Type of the needed record. + Biff record if it was found, null otherwise. + + + + Returns current record from the Biff records array and updates its position by 1. + + Array of Biff records. + + Position of the record in the array that will be returned. + + Current record from array. + + + + Returns record of the specified type from the array of Biff + records and sets its position after the returned record. + + Array of Biff records. + Starting from this position, record must be searched. + Type of the needed record. + Biff record if it was found, null otherwise. + + + + Serializes margin. + + OffsetArrayList to serialize into. + Margin's code. + Margin value. + Default margin value. + + + + This method is called after changes to the page setup. + Sets Saved property of the parent workbook to the False state. + + + + + Clone current Record. + + Parent object for create new instance. + Returns clone of current object. + + + + Size of the required storage space. Read-only. + + + + + Save record data to stream. + + Writer that will receive record data. + Object that provides access to the data. + Object to encrypt data. + Position in the output stream. Used to increase performance. + Size of the record. + If writer is NULL. + + If m_iLength of internal record data array is less than zero. + + + + + Serializes header / footer string. + + Writer to write data into. + Object that gives access to the temporary buffer. + Object to encrypt data. + Record code to serialize (header or footer). + String value to serialize. + Position in the output stream, used to reduce Flush + calls of the writer.BaseStream. + + + + Writes record that contains single UInt16 value into the writer. + + Writer to write value into. + Object that gives access to the temporary buffer. + Object to encrypt data. + Record code to write. + Value to write. + Position in the output stream, used to reduce Flush + calls of the writer.BaseStream. + Size of the written data. + + + + Writes margin record into writer. + + Writer to write margin into. + Object that gives access to the temporary buffer. + Object to encrypt data. + Record code to write. + Margin value. + Default margin value. If value equals to defaultValue, + then record is not written into writer. + Position in the output stream, used to reduce Flush + calls of the writer.BaseStream. + Size of the written data. + + + + Fills stream with some records before main page setup records. + + Writer to write records into. + Object that gives access to the temporary buffer. + Object to encrypt data. + Position in the output stream. Used to increase performance. + Size of the serialized data. + + + + Fills stream with some records after main page setup records. + + Writer to write records into. + Object that gives access to the temporary buffer. + Object to encrypt data. + Position in the output stream. Used to increase performance. + Size of the serialized data. + + + + Dispose Page Setup Base + + + + + Indicates whether fit to page mode is selected. + + + + + Returns or sets the height of the pages that the worksheet will be scaled + to when it is printed. Applies only to worksheets. Read/write Boolean. + + + + + Returns or sets the width of the pages the worksheet will be scaled + to when it is printed. Applies only to worksheets. Read/write Boolean. + + + + + True if paper size, scaling factor, paper orientation (portrait / landscape), + print resolution, and number of copies are not initialized. + + + + + Indicates whether FirstPageNumber is set to Auto or not. + + + + + True if elements of the document will be printed in black and white. + Read/write Boolean. + + + + + Gets or sets the size of the bottom margin, in inches. + Read / write Double. + + + + + Gets or sets the center part of the footer. Read / write String. + Special Formatting symbols: + &P Current page number + &N Page count + &D Current date + &T Current time + &A Sheet name (BIFF5-BIFF8) + &F File name without path + &Z File path without file name (BIFF8X) + &G Picture (BIFF8X) + &B Bold on/off (BIFF2-BIFF4) + &I Italic on/off (BIFF2-BIFF4) + &U Underlining on/off + &E Double underlining on/off (BIFF5-BIFF8) + &S Strikeout on/off + &X Superscript on/off (BIFF5-BIFF8) + &Y Subscript on/off (BIFF5-BIFF8) + &"[FONTNAME]" Set new font [FONTNAME] + &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. + The style [fontstyle] is in most cases one of Regular, Bold, Italic, + or Bold Italic. But this setting is dependent on the used font, it may + differ (localised style names, or Standard, Oblique, ...). (BIFF5-BIFF8) + &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). + If this command is followed by a plain number to be printed in the header, + it will be separated from the font height with a space character. + + + + + Gets / set image for center part of the footer. + + + + + Gets / set image for center part of the header. + + + + + Gets or sets the center part of the header. Read/write String. + Special Formatting symbols: + &P Current page number + &N Page count + &D Current date + &T Current time + &A Sheet name (BIFF5-BIFF8) + &F File name without path + &Z File path without file name (BIFF8X) + &G Picture (BIFF8X) + &B Bold on/off (BIFF2-BIFF4) + &I Italic on/off (BIFF2-BIFF4) + &U Underlining on/off + &E Double underlining on/off (BIFF5-BIFF8) + &S Strikeout on/off + &X Superscript on/off (BIFF5-BIFF8) + &Y Subscript on/off (BIFF5-BIFF8) + &"[FONTNAME]" Set new font [FONTNAME] + &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. + The style [fontstyle] is in most cases one of Regular, Bold, Italic, + or Bold Italic. But this setting is dependent on the used font, it may + differ (localised style names, or Standard, Oblique, ...). (BIFF5-BIFF8) + &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). + If this command is followed by a plain number to be printed in the header, + it will be separated from the font height with a space character. + + + + + True if the sheet is centered horizontally on the page when it is + printed. Read/write Boolean. + + + + + True if the sheet is centered vertically on the page when it is + printed. Read/write Boolean. + + + + + Number of copies to print. + + + + + True if the sheet will be printed without graphics. + Read/write Boolean. + + + + + Gets or sets the first page number that will be used when + this sheet is printed. + + + + + Gets or sets the distance from the bottom of the page to the footer, + in inches. Read/write Double. + + + + + Gets or sets the distance from the top of the page to the header, + in inches. Read/write Double. + + + + + Gets or sets the left part of the footer. Read/write String. + + + Special Formatting symbols: + &P Current page number + &N Page count + &D Current date + &T Current time + &A Sheet name (BIFF5-BIFF8) + &F File name without path + &Z File path without file name (BIFF8X) + &G Picture (BIFF8X) + &B Bold on/off (BIFF2-BIFF4) + &I Italic on/off (BIFF2-BIFF4) + &U Underlining on/off + &E Double underlining on/off (BIFF5-BIFF8) + &S Strikeout on/off + &X Superscript on/off (BIFF5-BIFF8) + &Y Subscript on/off (BIFF5-BIFF8) + &"[FONTNAME]" Set new font [FONTNAME] + &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. + The style [fontstyle] is in most cases one of Regular, Bold, Italic, + or Bold Italic. But this setting is dependent on the used font, it may + differ (localized style names, or Standard, Oblique, ...). (BIFF5-BIFF8) + &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). + If this command is followed by a plain number to be printed in the header, + it will be separated from the font height with a space character. + + + + + Gets or sets the left part of the header. Read/write String. + + + Special Formatting symbols: + &P Current page number + &N Page count + &D Current date + &T Current time + &A Sheet name (BIFF5-BIFF8) + &F File name without path + &Z File path without file name (BIFF8X) + &G Picture (BIFF8X) + &B Bold on/off (BIFF2-BIFF4) + &I Italic on/off (BIFF2-BIFF4) + &U Underlining on/off + &E Double underlining on/off (BIFF5-BIFF8) + &S Strikeout on/off + &X Superscript on/off (BIFF5-BIFF8) + &Y Subscript on/off (BIFF5-BIFF8) + &"[FONTNAME]" Set new font [FONTNAME] + &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. + The style [fontstyle] is in most cases one of Regular, Bold, Italic, + or Bold Italic. But this setting is dependent on the used font, it may + differ (localised style names, or Standard, Oblique, ...). (BIFF5-BIFF8) + &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). + If this command is followed by a plain number to be printed in the header, + it will be separated from the font height with a space character. + + + + + Gets / set image for left part of the footer. + + + + + Gets / set image for left part of the header. + + + + + Gets or sets the size of the left margin, in inches. + Read/write Double. + + + + + Gets or sets the order that Microsoft Excel uses to number + pages when printing a large worksheet. Read / write ExcelOrder. + + + + + Portrait or landscape printing mode. Read/write ExcelPageOrientation. + + + + + Gets or sets the size of the paper. Read / write ExcelPaperSize. + + + + + Gets or sets the way comments are printed with the sheet. + Read/write ExcelPrintLocation. + + + + + Sets or returns an ExcelPrintErrors constant specifying the type of + print error displayed. This feature allows users to suppress the + display of error values when printing a worksheet. Read/write. + + + + + True if cell notes are printed as end notes with the sheet. Applies + only to worksheets. Read/write Boolean. + + + + + Gets or sets the print quality. Read / write ushort. + + + + + Gets or sets the right part of the footer. Read / write String. + + + Special Formatting symbols: + &P Current page number + &N Page count + &D Current date + &T Current time + &A Sheet name (BIFF5-BIFF8) + &F File name without path + &Z File path without file name (BIFF8X) + &G Picture (BIFF8X) + &B Bold on/off (BIFF2-BIFF4) + &I Italic on/off (BIFF2-BIFF4) + &U Underlining on/off + &E Double underlining on/off (BIFF5-BIFF8) + &S Strikeout on/off + &X Superscript on/off (BIFF5-BIFF8) + &Y Subscript on/off (BIFF5-BIFF8) + &"[FONTNAME]" Set new font [FONTNAME] + &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. + The style [fontstyle] is in most cases one of Regular, Bold, Italic, + or Bold Italic. But this setting is dependent on the used font, it may + differ (localised style names, or Standard, Oblique, ...). (BIFF5-BIFF8) + &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). + If this command is followed by a plain number to be printed in the header, + it will be separated from the font height with a space character. + + + + + Gets / set image for right part of the footer. + + + + + Gets or sets the right part of the header. Read / write String. + Special Formatting symbols: + &P Current page number + &N Page count + &D Current date + &T Current time + &A Sheet name (BIFF5-BIFF8) + &F File name without path + &Z File path without file name (BIFF8X) + &G Picture (BIFF8X) + &B Bold on/off (BIFF2-BIFF4) + &I Italic on/off (BIFF2-BIFF4) + &U Underlining on/off + &E Double underlining on/off (BIFF5-BIFF8) + &S Strikeout on/off + &X Superscript on/off (BIFF5-BIFF8) + &Y Subscript on/off (BIFF5-BIFF8) + &"[FONTNAME]" Set new font [FONTNAME] + &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. + The style [fontstyle] is in most cases one of Regular, Bold, Italic, + or Bold Italic. But this setting is dependent on the used font, it may + differ (localised style names, or Standard, Oblique, ...). (BIFF5-BIFF8) + &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). + If this command is followed by a plain number to be printed in the header, + it will be separated from the font height with a space character. + + + + + Gets / set image for right part of the header. + + + + + Returns or sets the size of the right margin, in inches. + Read/write Double. + + + + + Gets or sets the size of the top margin, in points. + Read/write Double. + + + + + Gets or sets a percentage (between 10 and 400 percent) by which + Microsoft Excel will scale the worksheet for printing. Applies only + to worksheets. Read/write ushort. + + + + + Gets / sets background image. + + + + + Returns page width in points. Read-only. + + + + + Returns page width in points. Read-only. + + + + + Gets / sets horizontal resolution in dpi. + + + + + Gets / sets vertical resolution in dpi. + + + + + Gets values for even page + + + + + Gets values for odd page + + + + + Gets values for first page + + + + + Represents full header string. Read/write. + + + + + Gets footer full string. Read/write. + + + + + Indicates whether the header and footer margins are aligned with page margins. Read/Write Boolean. + + + + + True - The header / footer of the first page is different with other pages.False otherwise. + + + + + True - The header/footer odd pages are differed with even page. False otherwise. + + + + + Indicates whether the header and footer are scaled with document scaling.Read/Write Boolean. + + + + + Represents full even header string. Read/Write + + + + + Reoresents full even footer string. Read/Write + + + + + Represents full first header string. Read/Write + + + + + Represents full first footer string. Read/Write + + + + + Returns type code of the biff storage. Read-only. + + + + + Returns code of the biff storage. Read-only. + + + + + Indicates whether data array is required by this record. + + + + + Indicates record position in stream. This is a utility member of class and + is used only in the serialization process. Does not influence the data. + + + + + Set indexes as constants. + + + + + Left part of header or footer formatting. + + + + + Center part of header or footer formatting. + + + + + Right part of header or footer formatting. + + + + + Left part of even header or footer formatting. + + + + + Center part of even header or footer formatting. + + + + + Right part of even header or footer formatting. + + + + + Left part of first header or footer formatting. + + + + + Center part of first header or footer formatting. + + + + + Right part of first header or footer formatting. + + + + + This class contains size of the paper. + + + + + Paper width in points. + + + + + Paper height in points. + + + + + Default constructor. To prevent creation without arguments. + + + + + Initializes new instance of paper size entry. + + Paper width. + Paper height. + Units in which width and height are set. + + + + Represent page setup options for the chart sheet. + + + + + Gets or sets the number of pages tall the worksheet will be scaled + to when it is printed. Applies only to worksheets. + + + + + Gets or sets the number of pages wide the worksheet will be scaled + to when it is printed. Applies only to worksheets. + + + + + Informs how chart should be printed. + + + + + Sets application and parent fields. + + Application object for the page setup. + Parent object for the page setup. + + + + Recovers page setup from the stream and sets its application and parent fields. + The current record in the stream must be the PrintHeadersRecord. + + Application object for the page setup. + Parent object for the page setup. + BiffReader that contains page setup records. + + + + Recovers Page setup from the Biff Records array starting from position. + + Application object for the page setup. + Parent object for the page setup. + Array of Biff Records that contains all needed records. + Position of PrintHeadersRecord in the array. + + + + Recovers Page setup from the Biff Records list starting from position. + + Application object for the page setup. + Parent object for the page setup. + List which contains Biff Records. + Position of PrintHeadersRecord in the array. + + + + Parses record. + + Record to parse. + True if record was successfully parsed, false otherwise. + + + + Recovers page setup from the stream, first record must be PrintHeadersRecord. + + Stream that contains all needed records. + + + + Serializes some records after main page setup block. + + OffsetArrayList to serialize into. + + + + Clone current Record. + + Parent object for create new instance. + Returns clone of current object. + + + + Returns or sets the number of pages tall the worksheet will be scaled + to when it is printed. Applies only to worksheets. Read / write Boolean. + + + + + Returns or sets the number of pages wide the worksheet will be scaled + to when it is printed. Applies only to worksheets. Read / write Boolean. + + + + + Represents ChartParentAxis record and subrecords. + + + + + Represents chartAxisParent record. + + + + + Represents chart pos record. + + + + + Represents chart category axis. + + + + + Represents Chart value axis. + + + + + Represents Chart series axis. + + + + + Represents parent chart. + + + + + Represents formats coll. + + + + + Creates new instance of chart parent axis. + + Application object. + Parent object. + + + + Creates new instance of chart parent axis. + + Application object. + Parent object. + If true - creates primary axis; otherwise - secondary. + + + + Finds all parent objects. + + + + + Parses parent axis impl. + + Record storage. + Position in storage. + + + + Parsers category, value, series axis. + + Records storage. + Position in storage. + + + + Parses chart text. + + Record storage. + Position in storage. + + + + Parses chart format. + + Record storage. + Position in storage. + + + + Serialize current object. + + Record storage to serialize. + + + + Creates global format collection. + + + + + Using for creating secondary axis in Series type change. + + Value indicating whether to create new axis. + + + + Clones current object. + + Parent object. + Dictionary with new font indexes. + Dictionary with new sheet names. + Returns cloned object. + + + + Clears all walls, floor, gridLines. + + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + This method is called during dispose operation. + + + + + Represents chartAxisParent record. + + + + + Returns collection that contain chart format. Read-only. + + + + + If true this axis is primary axis; otherwise false. Read-only. + + + + + Gets or sets ChartCategoryAxis. + + + + + Gets or sets ValueAxis. + + + + + Gets or sets series axis. + + + + + Returns parent chart. Read-only. + + + + + Represents formats collection. Read-only. + + + + + Represents chart plot area object. + + + + + Represents chart plot area record. + + + + + Represents Excel 2007 layout data + + + + + Creates new instance. + + Represents current application + Represents parent object. + + + + Creates new instance. + + Represents current application + Represents parent object. + Represents chart type. + + + + Parses new instance from stg stream. + + Represents current application + Represents parent object. + Represents record storage. + Represents position in storage. + + + + Parses from stg stream. + + Record storage. + Represents position in storage. + + + + Serialize current records to stg stream. + + Represents list of records to serialize into. + + + + Gets or sets Excel 2007 layout data + + + + + Return attached label layout plot area record. Read-only + + + + + ChartSerieDataFormatImpl class. + + + + + Represents formatting options for the series data. + + + + + Gets the area properties of the chart. Read-only. + + + The following code illustrates how to access properties and set color to + property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set interior + IChartInterior interior = chart.Series[0].SerieFormat.AreaProperties; + + //Set color + interior.ForegroundColorIndex = ExcelKnownColors.Red; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the base shape used with the 3-D bar or column chart. + + + By default is set to . Here for example, we set + to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Bar_Stacked_3D; + + //Set Bar shape base + chart.Series[0].SerieFormat.BarShapeBase = ExcelBaseFormat.Circle; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Represents the top shape used with the 3-D bar or column chart. + + + By default is set to . Here for example, we set + to property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Bar_Stacked_3D; + + //Set Bar shape base + chart.Series[0].SerieFormat.BarShapeTop = ExcelTopFormat.Sharp; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the marker fill color. + + + The following code illustrates how to set color to markers in charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Line; + + //Set serie format + IChartSerieDataFormat format = chart.Series[0].SerieFormat; + + //Set marker style + format.MarkerStyle = ExcelChartMarkerType.Circle; + + //Set color + format.MarkerBackgroundColor = System.Drawing.Color.Red; + format.MarkerForegroundColor = System.Drawing.Color.Black; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the marker fill color. + + + The following code illustrates how to set color for markers in charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Line; + + //Set serie format + IChartSerieDataFormat format = chart.Series[0].SerieFormat; + + //Set marker style + format.MarkerStyle = ExcelChartMarkerType.Circle; + + //Set color + format.MarkerBackgroundColor = System.Drawing.Color.Red; + format.MarkerForegroundColor = System.Drawing.Color.Black; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the marker style for a point or series in a line chart, scatter chart, or radar chart. + + + The following code illustrates how marker style can be applied to charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Line; + + //Set serie format + IChartSerieDataFormat format = chart.Series[0].SerieFormat; + + //Set marker style + format.MarkerStyle = ExcelChartMarkerType.Star; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the index of marker fill color from predefined colors (). + + + The following code illustrates how to set a color from enumeration to marker applied. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Line; + + //Set serie format + IChartSerieDataFormat format = chart.Series[0].SerieFormat; + + //Set marker style + format.MarkerStyle = ExcelChartMarkerType.Circle; + + //Set color + format.MarkerBackgroundColorIndex = ExcelKnownColors.Red; + format.MarkerForegroundColorIndex = ExcelKnownColors.Black; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the index of marker fill color from predefined colors (). + + + The following code illustrates how to set a color from enumeration to marker applied. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Line; + + //Set serie format + IChartSerieDataFormat format = chart.Series[0].SerieFormat; + + //Set marker style + format.MarkerStyle = ExcelChartMarkerType.Circle; + + //Set color + format.MarkerBackgroundColorIndex = ExcelKnownColors.Red; + format.MarkerForegroundColorIndex = ExcelKnownColors.Black; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the size of markers. + + + The following code illustrates how to set for applied markers in charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Line; + + //Set serie format + IChartSerieDataFormat format = chart.Series[0].SerieFormat; + + //Set marker style + format.MarkerStyle = ExcelChartMarkerType.Circle; + + //Set marker size + format.MarkerSize = 10; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if the series has auto marker. otherwise False. + + + The following code illustrates how property can be used. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["D1"].Text = "Apr"; + sheet.Range["E1"].Text = "May"; + sheet.Range["F1"].Text = "Jun"; + sheet.Range["A2"].Value = "5"; + sheet.Range["B2"].Value = "21"; + sheet.Range["C2"].Value = "15"; + sheet.Range["D2"].Value = "12"; + sheet.Range["E2"].Value = "28"; + sheet.Range["F2"].Value = "9"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:F2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Line_Markers; + + //Set serie data format + IChartSerieDataFormat format = chart.Series[0].DataPoints.DefaultDataPoint.DataFormat; + + //Check auto marker + Console.Write(format.IsAutoMarker); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + + + + + + Gets or sets the distance of pie slice from center of pie. + + + The following code illustrates how to set property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Pie; + + //Set percent + chart.Series[0].SerieFormat.Percent = 30; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True to draw bubbles with 3D effects. otherwise False. + + + The following code illustrates how property can be used. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Value = "50"; + sheet.Range["B1"].Value = "60"; + sheet.Range["C1"].Value = "5"; + sheet.Range["A2"].Value = "1"; + sheet.Range["B2"].Value = "4"; + sheet.Range["C2"].Value = "2"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Bubble_3D; + + //Set serie format + IChartSerieDataFormat format = chart.Series[0].SerieFormat; + + //Check type + Console.WriteLine(format.Is3DBubbles); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + + + + + + Gets the common series options. Read-only. + + + The following code illustrates how can be set by accessing property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Stacked_3D; + + //Set common serie options + IChartFormat commonSerieOptions = chart.Series[0].SerieFormat.CommonSerieOptions; + + //Set Gap width + commonSerieOptions.GapWidth = 400; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if the marker is supported by this chart/series. otherwise False. Read-only. + + + The following code illustrates how to access the property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "50"; + sheet.Range["B2"].Value = "60"; + sheet.Range["C2"].Value = "5"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Pie; + + //Set serie format + IChartSerieDataFormat format = chart.Series[0].SerieFormat; + + //Check marker support + Console.WriteLine(format.IsMarkerSupported); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //False + + + + + + Gets / Sets the Display label position in Tree map chart + + + For chart by default is set to . Here for example, we set + to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + + sheet.Range["A1"].Text = "Fall"; + sheet.Range["B1"].Text = "Month"; + sheet.Range["C1"].Text = "Total"; + sheet.Range["A2:A4"].Text = "Quarter1"; + sheet.Range["A5:A7"].Text = "Quarter2"; + sheet.Range["B2"].Text = "Jan"; + sheet.Range["B3"].Text = "Feb"; + sheet.Range["B4"].Text = "Mar"; + sheet.Range["B5"].Text = "Apr"; + sheet.Range["B6"].Text = "May"; + sheet.Range["B7"].Text = "Jun"; + sheet.Range["C2"].Value = "10"; + sheet.Range["C3"].Value = "20"; + sheet.Range["C4"].Value = "30"; + sheet.Range["C5"].Value = "35"; + sheet.Range["C6"].Value = "25"; + sheet.Range["C7"].Value = "15"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set chart type + chart.ChartType = ExcelChartType.TreeMap; + + //Set range + chart.DataRange = sheet.Range["A1:C7"]; + + //Set chart format + IChartSerieDataFormat format = chart.Series[0].SerieFormat; + + //Set label option + format.TreeMapLabelOption = ExcelTreeMapLabelOption.Banner; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets / Sets a boolean value indicating whether to display + Connector Lines between data points + + Applies only to Waterfall Charts + + The following code illustrates how to set connector line visibility for chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.WaterFall; + + //Set serie format + IChartSerieDataFormat format = chart.Series[0].SerieFormat; + + //Set visibility + format.ShowConnectorLines = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets / Sets a boolean value indicating whether to display Mean Line in chart + + + The following code illustrates how to set the visibility of mean lines in chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.BoxAndWhisker; + + //Set serie format + IChartSerieDataFormat format = chart.Series[0].SerieFormat; + + //Set visibility + format.ShowMeanLine = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets / Sets a boolean value indicating whether to display Mean Marker in chart. + + + The following code illustrates how to set the visibility of mean markers in chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.BoxAndWhisker; + + //Set serie format + IChartSerieDataFormat format = chart.Series[0].SerieFormat; + + //Set visibility + format.ShowMeanMarkers = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets / Sets a boolean value indicating whether to display Inner Points in chart. + + + The following code illustrates how to set the visibility of inner points in chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.ImportDataTable(GetData(), true, 1, 1); + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set chart type + chart.ChartType = ExcelChartType.BoxAndWhisker; + + //Set range + chart.DataRange = sheet.Range["B1:C17"]; + + //Set serie data format + IChartSerieDataFormat format = chart.Series[0].DataPoints.DefaultDataPoint.DataFormat; + + //Set ShowInnerPoints + format.ShowInnerPoints = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + System.Data.DataTable GetData() + { + System.Data.DataTable dt = new System.Data.DataTable(); + dt.Columns.Add("Book ID"); + dt.Columns.Add("Category"); + dt.Columns.Add("Price"); + dt.Rows.Add("SBA2465", "Children's", 26); + dt.Rows.Add("SBA3222", "Children's", 8); + dt.Rows.Add("SBA2391", "Children's", 9); + dt.Rows.Add("SBA3823", "Children's", 17); + dt.Rows.Add("SBA3197", "Children's", 32); + dt.Rows.Add("SBA1160", "Romance", 34); + dt.Rows.Add("SBA3092", "Romance", 20); + dt.Rows.Add("SBA1016", "Romance", 5); + dt.Rows.Add("SBA3266", "Romance", 12); + dt.Rows.Add("SBA3381", "Romance", 13); + dt.Rows.Add("SBA1870", "Romance", 4); + dt.Rows.Add("SBA2072", "Mystery", 61); + dt.Rows.Add("SBA3969", "Mystery", 15); + dt.Rows.Add("SBA3124", "Mystery", 40); + dt.Rows.Add("SBA3693", "Mystery", 19); + dt.Rows.Add("SBA2543", "Mystery", 72); + return dt; + } + + + + + + Gets / Sets a boolean value indicating whether to display Outlier Points in chart. + + + The following code illustrates how to set the visibility of outlier points in chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.ImportDataTable(GetData(), true, 1, 1); + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set chart type + chart.ChartType = ExcelChartType.BoxAndWhisker; + + //Set range + chart.DataRange = sheet.Range["B1:C17"]; + + //Set serie data format + IChartSerieDataFormat format = chart.Series[0].DataPoints.DefaultDataPoint.DataFormat; + + //Set ShowOutlierPoints + format.ShowOutlierPoints = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + System.Data.DataTable GetData() + { + System.Data.DataTable dt = new System.Data.DataTable(); + dt.Columns.Add("Book ID"); + dt.Columns.Add("Category"); + dt.Columns.Add("Price"); + dt.Rows.Add("SBA2465", "Children's", 26); + dt.Rows.Add("SBA3222", "Children's", 8); + dt.Rows.Add("SBA2391", "Children's", 9); + dt.Rows.Add("SBA3823", "Children's", 17); + dt.Rows.Add("SBA3197", "Children's", 32); + dt.Rows.Add("SBA1160", "Romance", 34); + dt.Rows.Add("SBA3092", "Romance", 20); + dt.Rows.Add("SBA1016", "Romance", 5); + dt.Rows.Add("SBA3266", "Romance", 12); + dt.Rows.Add("SBA3381", "Romance", 13); + dt.Rows.Add("SBA1870", "Romance", 4); + dt.Rows.Add("SBA2072", "Mystery", 61); + dt.Rows.Add("SBA3969", "Mystery", 15); + dt.Rows.Add("SBA3124", "Mystery", 40); + dt.Rows.Add("SBA3693", "Mystery", 19); + dt.Rows.Add("SBA2543", "Mystery", 72); + return dt; + } + + + + + + Gets / Sets whether the Quartile calculation is or . + + Applies only to Charts + + By default for is set to . + Here for example, we set to property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.ImportDataTable(GetData(), true, 1, 1); + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set chart type + chart.ChartType = ExcelChartType.BoxAndWhisker; + + //Set range + chart.DataRange = sheet.Range["B1:C17"]; + + //Set serie data format + IChartSerieDataFormat format = chart.Series[0].DataPoints.DefaultDataPoint.DataFormat; + + //Set quartile calculation type + format.QuartileCalculationType = ExcelQuartileCalculation.InclusiveMedian; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + System.Data.DataTable GetData() + { + System.Data.DataTable dt = new System.Data.DataTable(); + dt.Columns.Add("Book ID"); + dt.Columns.Add("Category"); + dt.Columns.Add("Price"); + dt.Rows.Add("SBA2465", "Children's", 26); + dt.Rows.Add("SBA3222", "Children's", 8); + dt.Rows.Add("SBA2391", "Children's", 9); + dt.Rows.Add("SBA3823", "Children's", 17); + dt.Rows.Add("SBA3197", "Children's", 32); + dt.Rows.Add("SBA1160", "Romance", 34); + dt.Rows.Add("SBA3092", "Romance", 20); + dt.Rows.Add("SBA1016", "Romance", 5); + dt.Rows.Add("SBA3266", "Romance", 12); + dt.Rows.Add("SBA3381", "Romance", 13); + dt.Rows.Add("SBA1870", "Romance", 4); + dt.Rows.Add("SBA2072", "Mystery", 61); + dt.Rows.Add("SBA3969", "Mystery", 15); + dt.Rows.Add("SBA3124", "Mystery", 40); + dt.Rows.Add("SBA3693", "Mystery", 19); + dt.Rows.Add("SBA2543", "Mystery", 72); + return dt; + } + + + + + + Represents None color index. + + + + + Represents marker size mull prefix. + + + + + Represents start color. + + + + + Represents start pie type. + + + + + Represents start doughnut type. + + + + + Represents start surface type. + + + + + Represents start line type. + + + + + Represents start scatter type. + + + + + Represents default line size in marker record. + + + + + Represents default line size in marker record. + + + + + Represents default line color. + + + + + Represents default index for marker record. + + + + + Represents default color in marker record. + + + + + Represents types of chart that support data format properties. + + + + + Main series data format record. + + + + + 3-D data format. + + + + + Pie format. + + + + + Represents the 3D features + + + + + Represents the Chart Shadow + + + + + Marker format. + + + + + Attached label. + + + + + Represents the beginning of a collection of records + + + + + Represents the shape formatting properties for chart elements + + + + + Represents the end of a collection of records + + + + + Attached label layout + + + + + Series format. + + + + + Represents default data point. + + + + + Parent series. + + + + + Parent chart format. + + + + + Parent chart. + + + + + Represents border. + + + + + Represents chart area properties. + + + + + Represents if DataFormat is Formatted. + + + + + Represents fill properties. + + + + + Object that holds marker background color. + + + + + Object that holds marker foreground color. + + + + + Preserved marker gradient data. + + + + + Represents the marker fill transparency + + + + + Represents whether the marker properties exists or not + + + + + Represents whether the Barshape exists or not + + + + + Represents whether the data point is parsed or not + + + + + Represents whether the MarkerColor is Changed or Not + + + + + Indicates whether the MarkerColor is Solid Fill or Not. + + + + + Represents whether the connector lines shown between data points + Used only in waterfall Chart + + + + + It represents the label position in tree map chart + + + + + Object that holds the information required for Box and whisker series + + + + + Object that holds the information required for Histogram series + + + + + Used to store the border width value for the marker + Default value is 0.75 + + + + + Used to check whether automatic color is set for marker. + + + + + Represents whether the color is inverted. false by default + + + + + Creates series and set its Application and Parent + properties to specified values. + + Application object for the chart. + Parent object for the chart. + + + + Initializes marker color variables. + + + + + Searches for all necessary parents. + + + + + Parses data format. + + Array with data format records. + Position of the first data format record. + Position after the last data format record. + + + + Serializes data format. + + Represents record list to serialize into. + + + + Sets default values. + + + + + Sets 3D data format to the default state. + + + + + Sets format fields to Null. + + + + + Clone current instance. + + Parent object. + Return cloned object. + + + + Copy the Back and Fore ground color objects from the seriedataformat + + + + + + Set the default values for the records related to serie formats + + + + + Updates Series index. + + + + + Updates data format in data points. + + + + + Changes data format to create radar chart. + + Type to change. + + + + Changes data format to create scatter chart. + + Type to change. + + + + Changes data format to create line chart. + + Type to change. + + + + Updates bar column properties in series and chartformat points. + + If true updates data format top property; otherwise data format base. + + + + Updates line color for line, radar, skater Series data format. + + Returns updated color index or -1. + + + + Updates color for line, markers and series. + + Represents series to update color. + Represents data point to update color. + Returns updated color index. + + + + Updates series formats for chartformat object. + + + + + Checks for default record. + + Record to check. + Returns true if not equal; otherwise false. + + + + Clears sub data formats on property change. + + + + + Validate marker properties. + + If true than marker properties valid for this chart type; otherwise false. + + + + Indicates whether interior object is supported. Read-only. + + Chart type to check whether interior object is supported. + Value indicating whether interior object is supported. + + + + Indicates whether border object is supported. Read-only. + + Chart type to check whether border is supported. + Vale indicating whether border is supported. + + + + Event handler for marker foreground color change. + + + + + Event handler for marker background color change. + + + + + Compares the data points color format + + Data point to be compared + bool value + + + + + Gets/sets value indicating whether line properties are created. + + + + + Gets a value indicating whether this instance has shadow properties. + + + true if this instance has shadow properties; otherwise, false. + + + + + Gets the chart3 D options. + + The chart3 D options. + + + + This property Indicates whether the Shadow object has been created(which includes the 3D properties) + + + + + Gets/sets value indicating whether interior object was created. + + + + + Gets the shadow. + + + + + Returns object, that represents line properties. Read-only. + + + + + Returns object, that represents area properties. Read-only. + + + + + Represents the base data format. + + + + + Represents the top data format. + + + + + Foreground color: RGB value (high byte = 0). + + + + + Background color: RGB value (high byte = 0). + + + + + Type of marker. + + + + + Index to color of marker border. + + + + + Index to color of marker fill. + + + + + Size of markers. + + + + + Automatic color. + + + + + True = "background = none". + + + + + True = "foreground = none". + + + + + Distance of pie slice from center of pie. + + + + + True if the line series has a smoothed line. + + + + + True to draw bubbles with 3D effects. + + + + + True if this series has a shadow. + + + + + Gets or sets value indicating whether to show label active value. + + + + + Show value as a percent of the total. This bit applies only to pie charts. + + + + + Show category label and value as a percentage (pie charts only). + + + + + Show smoothed line. + + + + + Show category label. + + + + + Show bubble sizes. + + + + + Represents fill options. Read-only. + + + + + Gets value indicating whether chart supports transparency. + + + + + Gets common Series options. Read-only. + + + + + Indicates whether marker is supported by this chart/series. + + + + + Returns object, that represents area properties. Read-only. + + + + + Indicates whether interior object is supported. Read-only. + + + + + Indicates whether border object is supported. Read-only. + + + + + Indicates whether the marker properties exists or not + + + + + Indicates whether the Barshape exists or not + + + + + Gets/ Sets the histogram axis format property for individual series + + + + + Gets or sets a boolean value indicating whether to display + Connector Lines between data points + + Applies only to Waterfall Charts + + + + Gets / Sets the Display label position in Tree map chart + + By Default the Label is overlapped + + + + Gets or sets a boolean value indicating whether to display + Mean Line in Box and Whisker chart + + + + + Gets or sets a boolean value indicating whether to display + Mean Marker in Box and Whisker chart + + + + + Gets or sets a boolean value indicating whether to display + Inner Points in Box and Whisker chart + + + + + Gets or sets a boolean value indicating whether to display + Outlier Points in Box and Whisker chart + + + + + Gets / Sets whether the Quartile calculation is Exclusive or Inclusive + + Applies only to Box and Whisker Charts + + + + Get or Set the isBinning by Category member value + + + + + Get or Set the is Automatic Bin member value + + + + + Get or Set the number of Bins member value + + + + + Get or Set the Bin width member value + + + + + Get or Set the overflow bin member value + + + + + Get or Set the underflow bin member value + + + + + Get or Set the value for interval is closed in left or right + + + + + Returns parent Series. Read-only. + + + + + Returns data format main record. + + + + + Returns pie format record. Read-only. + + + + + Returns marker format main record. Read-only. + + + + + Returns 3dData format main record. Read-only. + + + + + Returns Series format main record. Read-only. + + + + + Returns attached label record. Read-only. + + + + + Return attached label layout record. Read-only + + + + + If line not null - returns true; otherwise - false. Read-only. + + + + + If marker is not null returns marker format main record otherwise null. Read-only. + + + + + If 3dData not Null returns 3DData format main record; otherwise - returns null. Read-only. + + + + + if SerieFormat not Null returns Series format main record; otherwise - returns null. Read-only. + + + + + Returns pie format or null. Read-only. + + + + + Gets or sets Series number. + + + + + If true - format has marker; otherwise false. Read-only. + + + + + If true - format has line; otherwise false. Read-only. + + + + + If true - format has smoothed line; otherwise false. Read-only. + + + + + Gets Series type. Read-only. + + + + + Indicate if data format is formatted. + + + + + Represents parent chart. Read-only. + + + + + Gets object that holds marker background color. + + + + + Gets object that holds marker foreground color. + + + + + Gets or sets the transparency of the line marker. + + The transparency. + + + + Gets or sets the transparency of the line marker fill. + + The transparency. + + + + Gets or sets the marker line stream. + + + + + Gets or sets whether the data point is parsed or not. + If parsed, it will be serialized. + + + + + Indicates whether the MarkerColor is Changed or Not. + + + + + Indicates whether the MarkerColor is Solid Fill or Not. + + + + + Gets / Sets the line width of the marker + Stored on parsing only for Chart to Image Conversion + + + + + Checks whether Automatic color is set for marker. + + + + + Indicates whether the default properties are exist or not. + + + + + True if the RGB color values are inverted in the binary records else returns false. + + + + + Represents foreground color. + + + + + Represents background color. + + + + + Represents pattern. + + + + + Indicates, if automatic format is used for area. + + + + + Represents visibility. + + + + + This class represents ChartSeries object. + + + + + Represents a series in the chart. + + + + + Creates in the specified axis. + + If true - on Y axis; otherwise on X axis. + for the . + + The following code illustrates how to set on Y-axis of a particular . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set error bar + chart.Series[0].ErrorBar(true); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Creates in the specified axis with specified type. + + If true - on Y axis; otherwise on X axis. + Represents type. + for the . + + The following code illustrates how to set with on Y-axis of a + particular . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set error bar + chart.Series[0].ErrorBar(true, ExcelErrorBarInclude.Plus); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Creates of specified . + + If true - on Y axis; otherwise on X axis. + Represents type. + Represents . + for the . + + The following code illustrates how to set with + and on Y-axis of a particular . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set error bar + chart.Series[0].ErrorBar(true, ExcelErrorBarInclude.Plus, ExcelErrorBarType.Percentage); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Creates of specified with the specified number value. + + If true - on Y axis; otherwise on X axis. + Represents type. + Represents . + Represents number value for the applicable . + for the . + The number value is applicable for Percentage, Fixed and StandardDeviation error bar types. + + The following code illustrates how to set with + , and number value of "50" on Y-axis of a particular . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set error bar + chart.Series[0].ErrorBar(true, ExcelErrorBarInclude.Plus, ExcelErrorBarType.Percentage, 50); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Creates custom type. + + If true - on Y axis; otherwise on X axis. + Represents . + Represents . + for the . + + The following code illustrates how an can be created on X-axis with + and . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + sheet.Range["A3"].Value = "1"; + sheet.Range["B3"].Value = "1"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set chart type + chart.ChartType = ExcelChartType.Scatter_Line; + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set error bar + chart.Series[0].ErrorBar(false, sheet.Range["A3"], sheet.Range["B3"]); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a value to specify the series to invert its colors if the value is negative. The default value is true. + + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "-10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.Series[0].SerieType = ExcelChartType.Column_Cluster; + chart.Series[0].InvertIfNegative =true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a value to specify the series to invert its colors if the value is negative. + + + The following code illustrates how to set values for in charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "-10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.Series[0].SerieType = ExcelChartType.Column_Cluster; + chart.Series[0].InvertIfNegative =true; + chart.Series[0].InvertIfNegativeColor= Color.Red; + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the series values. + + + The following code illustrates how to set values for in charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set serie + IChartSerie serie = chart.Series.Add(); + + //Set category labels and values + serie.CategoryLabels = sheet.Range["A1:C1"]; + serie.Values = sheet.Range["A2:C2"]; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets category labels for the series. + + + The following code illustrates how to set category labels for in charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set serie + IChartSerie serie = chart.Series.Add(); + + //Set category labels and values + serie.CategoryLabels = sheet.Range["A1:C1"]; + serie.Values = sheet.Range["A2:C2"]; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets series values of the bubble chart. + + + For bubble chart both horizontal and vertical axes are value axes so for the first value axis we set serie value to property + and the next value axis we make use of property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Value = "50"; + sheet.Range["B1"].Value = "60"; + sheet.Range["C1"].Value = "5"; + sheet.Range["A2"].Value = "1"; + sheet.Range["B2"].Value = "4"; + sheet.Range["C2"].Value = "2"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set serie + IChartSerie serie = chart.Series.Add(ExcelChartType.Bubble); + + //Set values + serie.Values = sheet.Range["A1:C1"]; + + //Set bubble chart range + serie.Bubbles = sheet.Range["A2:C2"]; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the name of the series. + + + The following code illustrates how to access the name of the . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set serie + IChartSerie serie = chart.Series.Add("BarSerie"); + + //Set category labels and values + serie.CategoryLabels = sheet.Range["A1:C1"]; + serie.Values = sheet.Range["A2:C2"]; + + //Get Serie name + Console.Write(serie.Name); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //BarSerie + + + + + + Gets or sets the series name range. + + + The following code illustrates how to access the name range of a particular in the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Width"; + sheet.Range["A2"].Text = "Height"; + sheet.Range["B1"].Value = "50"; + sheet.Range["C1"].Value = "60"; + sheet.Range["D1"].Value = "5"; + sheet.Range["B2"].Value = "1"; + sheet.Range["C2"].Value = "4"; + sheet.Range["D2"].Value = "2"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set chart type + chart.ChartType = ExcelChartType.Bubble; + + //Set range + chart.DataRange = sheet["A1:D2"]; + + //Get name range + Console.Write(chart.Series[0].NameRange.AddressLocal); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //A1 + + + + + + Gets or sets a boolean value indicating whether to use primary axis + for series drawing. False to use secondary axis. + + + The following code illustrates how the secondary axis can be used by disabling primary axis. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "100"; + sheet.Range["B3"].Value = "200"; + sheet.Range["C3"].Value = "300"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set secondary axis + IChartSerie serie = chart.Series[1]; + serie.UsePrimaryAxis = false; + chart.SecondaryCategoryAxis.Visible = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the collection in the series. Read-only. + + + The following code illustrates how to access the collection from . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set data points + IChartDataPoints dataPoints = chart.Series[0].DataPoints; + + //Set data labels value visibility + dataPoints.DefaultDataPoint.DataLabels.IsValue = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the of the series. + + + The following code illustrates how to access the from . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.Line; + + //Set serie format + IChartSerieDataFormat format = chart.Series[0].SerieFormat; + + //Set marker style + format.MarkerStyle = ExcelChartMarkerType.Star; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the series type. + + + property can be used to create a combination chart by adding more series to the charts. Here for example, we create a + chart. By default the will be , here we change it by setting + to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.Series[0].SerieType = ExcelChartType.Line; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the directly entered series values. + + The following code illustrates how series data can be directly given for charts. + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set serie + IChartSerie serie = chart.Series.Add(ExcelChartType.Pie); + + //Set direct values + serie.EnteredDirectlyValues = new object[] { 2000, 1000, 1000 }; + + //Set direct category label + serie.EnteredDirectlyCategoryLabels = new object[] { "Total Income", "Expenses", "Profit" }; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the directly entered category values. + + The following code illustrates how series category labels can be directly given for charts. + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set serie + IChartSerie serie = chart.Series.Add(ExcelChartType.Pie); + + //Set direct values + serie.EnteredDirectlyValues = new object[] { 2000, 1000, 1000 }; + + //Set direct category label + serie.EnteredDirectlyCategoryLabels = new object[] { "Total Income", "Expenses", "Profit" }; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the directly entered series values for chart. + + + The following code illustrates how series data for second value axis of charts can be directly given for charts. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set serie + IChartSerie serie = chart.Series.Add(ExcelChartType.Bubble); + + //Set direct values + serie.EnteredDirectlyValues = new object[] { 10, 20, 30 }; + + //Set bubble chart direct values + serie.EnteredDirectlyBubbles = new object[] { 1, 4, 2 }; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the error bars on Y-axis. Read-only. + + + The following code illustrates how on Y-axis can be accessed. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set chart type + chart.ChartType = ExcelChartType.Scatter_Line; + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set error bar + chart.Series[0].HasErrorBarsY = true; + IChartErrorBars errorBar = chart.Series[0].ErrorBarsY; + + //Set error bar type + errorBar.Type = ExcelErrorBarType.Percentage; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if series contains Y error bars. otherwise False. + + The following code illustrates how property can be used. + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set chart type + chart.ChartType = ExcelChartType.Scatter_Line; + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set error bar + chart.Series[0].HasErrorBarsY = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the error bars on the X-axis. Read-only. + + + The following code illustrates how in X-axis can be accessed. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set chart type + chart.ChartType = ExcelChartType.Scatter_Line; + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set error bar + chart.Series[0].HasErrorBarsX = true; + IChartErrorBars errorBar = chart.Series[0].ErrorBarsX; + + //Set error bar type + errorBar.Type = ExcelErrorBarType.Percentage; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if series contains X error bars. otherwise False. + + + The following code illustrates how property can be used. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set chart type + chart.ChartType = ExcelChartType.Scatter_Line; + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set error bar + chart.Series[0].HasErrorBarsX = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the collection of the series. Read-only. + + + The following code illustrates how collection can be accessed from a particular . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set trend line + IChartTrendLines trendLines = chart.Series[0].TrendLines; + IChartTrendLine trendLine = trendLines.Add(ExcelTrendLineType.Linear); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating whether the series has been filtered out from the chart. + + + By default all the series in the chart are shown because property is set to "false". Here for example, we set first + serie property to "true" so it is filtered out from the chart and it will not be shown in the chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Text = "Apr"; + sheet.Range["B2"].Text = "May"; + sheet.Range["C2"].Text = "Jun"; + + sheet.Range["A4"].Value = "10"; + sheet.Range["B4"].Value = "20"; + sheet.Range["C4"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "10"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C4"]; + + //Set chart type + chart.ChartType = ExcelChartType.Line; + + //Set IsFiltered + chart.Series[0].IsFiltered = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the Pareto line on the Pareto charts. Read-only. + + + The following code illustrates how to set pareto line properties of the chart. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set chart format + chart.ChartType = ExcelChartType.Pareto; + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set pareto line format + IChartFrameFormat format = chart.Series[0].ParetoLineFormat; + format.LineProperties.ColorIndex = ExcelKnownColors.Red; + + //Save the workbook + MemoryStream stream = new MemoryStream(); + workbook.SaveAs(stream); + } + + + + + + + + + + + + + + + + + + Index for format that corresponds to all points in the Series. + + + + + Represents default point number for surface chart type. + + + + + Represents default chart group. + + + + + Represents start radar type. + + + + + Represents true as string. + + + + + Represents false as string. + + + + + Represent the value form cells range values collection in datalabels. + + + + + Values range for the series. + + + + + Category labels for the series. + + + + + Bubble sizes for the series. + + + + + Name of the series. + + + + + Dictionary IndexIdentifier-to-ChartAiRecord + + + + + Index of the chart group this axis belongs to. + + + + + Parent workbook for the series. + + + + + ChartSeries record describing this series. + + + + + Parent chart for the series. + + + + + Parent series collection. + + + + + Index of the series. + + + + + Drawing order of the series. + + + + + Indicates whether series name has default value. + + + + + Data points collection. + + + + + Represents Series type. + + + + + Represents array of number or label records for value range. + + + + + Represents array of number or label records for category range. + + + + + Represents array of number or label records for bubble range. + + + + + Represents array of values for value range. + + + + + Represents array of values for category range. + + + + + Represents array of values for bubble range. + + + + + Represents series name range. + + + + + Represents not default series text for first Series on parsing. + + + + + Represents Y error bar. + + + + + Represents X error bar. + + + + + Represents trend line collection. + + + + + This element specifies the series + to invert its colors if the value is negative. + + + + + Represents the series name cache. + + + + + Represents the string reference formula + + + + + Represents the number reference formula + + + + + Represents the number reference formula + + + + + Preserve the drop lines + + + + + Reprsent the Filter option + + + + + Reprsent the category filter range + + + + + Reprsent the category value Range + + + + + Specifies the kind of grouping for a column, line or area chart + + + + + Represents chart gapWidth for the first series + + + + + Represents chart overlap for the first series + + + + + Represents whether to serialize gapwidth + + + + + Represents the stream for preserving the Extents node + + + + + Represents the invertifnegative color. + + + + + Represents the multi level string cache. + + + + + Represents the multi level cache point count. + + + + + Represents whether the series are reversed. + + + + + Indicates the format index of chart pareto line + Used only in loaded chart + + + + + Indicates whether the pareto line is hidden + + + + + Objects that holds the pareto line settings + + + + + Boolean value indicates category values interpreted in row-wise + + + + + Boolean value indicates series values interpreted in row-wise + + + + + format code used in series values + + + + + format code used in category values + + + + + ShowLeaderLines for the series. + + + + + Border settings for ShowleaderLines. + + + + + Creates series and set its Application and Parent + properties to specified values. + + Application object for the chart. + Parent object for the chart. + + + + Creates series from the array of BiffRecords. + + Application object for the series. + Parent object for the series. + Array of BiffRecords with series data. + Position of the first series record. + + + + Creates error bar object. + + If true - on Y axis; otherwise on X axis. + Return error bar object. + + + + Creates error bar object. + + If true - on Y axis; otherwise on X axis. + Represents include type. + Return error bar object. + + + + Creates error bar object. + + If true - on Y axis; otherwise on X axis. + Represents include type. + Represents error bar type. + Return error bar object. + + + + Creates error bar object. + + If true - on Y axis; otherwise on X axis. + Represents include type. + Represents error bar type. + Represents number value. + Returns error bar object. + + + + Sets custom error bar type. + + If true - on Y axis; otherwise on X axis. + Represents plus range. + Represents minus range. + Returns error bar object. + + + + Parses series data. + + Array of biff records that contains series data. + Position of the ChartSeries record in the array. + + Specified record is not ChartSeries record + or if next record is not Begin record. + + + + + Parses ChartSeries record. + + Record to parse. + + + + Parses ChartAI record. + + Array of BiffRecords that contains ChartAi record. + Position of the record in the data array. + + When specified record is not ChartAi record. + + + When ChartAI record with the same IndexIdentifier was + already added to the collection. + + + + + Parses ChartSertocrt record. + + Array of BiffRecords that contains necessary record. + + Position of the ChartSertocrt record in the data array. + + + + + Parses series title. + + ChartAi record describing chart title. + Array of BiffRecords that contains necessary records. + Position of the ChartAi record in the data array. + + + + Parses legend entry from biff stream. + + Array of BiffRecords that contains ChartAi record. + Position of the record in the data array. + + + + Parses error bars. + + Represents data holder. + + + + Set leader lines. + + bool value to set. + + + + Searches for all needed parent objects. + + + When parents cannot be found. + + + + + Initializes m_hashAI member. + + + + + Initializes all internal collections. + + + + + Sets data format. + + Data format to set. + + + + Return Chart3DDataFormat record for this series. + + Chart3DDataFormat record for this series. + + + + This method is called when the name of the series needs to be changed. + + New name of the series. + + + + Raises ValueRangeChanged event and sets new value to the ValueRange. + + + + + Sets new value to the CategoryRange. + + + + + Sets new value to the BubbleRange. + + + + + Clone current instance. + + Parent object. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Cloned series. + + + + Update the name index of define names + + define name of the range + source workbook of the chart + + + + Gets worksheet name. + + Address of Range. + Returns name of parent worksheet. + + + + Changes axis. + + If true - to primary; otherwise - to secondary. + + + + Returns new series order. + + If true - to primary; otherwise - to secondary. + A new series order. + + + + Add entered record by si index. + + si index. + Record to add. + + + + Gets array by siIndex. + + Si index. + Returns array by si index. + + + + Gets values of entered directly values. + + Record storage. + Returns just created array of values. + + + + Gets type of Entered directly values. + + Array with entered directly values. + If true - type is Number; otherwise label. + + + + Gets array of records by values. + + If true - values type is number; otherwise - string. + Array list with values. + Returns created array with records. + + + + Updates in entered directly values Series index. + + Array to update. + + + + Detects name. + + Returns detected Series name. + + + + Gets series value from Range + + Series range + + + + + Gets relative cell. + + Row + Column + Range + Range + + + + Gets left adjecent cell. + + Range + + + + Gets text range value for Series name that supports cell, or row, or column. + + Range to gets text value. + Value representing text range. + + + + Sets default Series name. + + Represents Series name. + boolean value indicates whether to clear the name range of series + + + + Gets Series name range. + + Returns range, that represents Series name range. Can be null. + + + + Detects Series type. + + Extracted series type. + + + + Detects Series type. + + Detected string representationg of the series type. + + + + Detects Series type. + + Extracted series type. + + + + Detects the type of the series when describing record is ChartBar. + + Series format. + Returns series type. + + + + Gets bar start string. + + Format for detect start string. + Returns start string. + + + + Detects the type of the series when describing record is ChartPie. + + Series format. + Returns series type. + + + + Detects the type of the series when describing record is ChartArea. + + Series format. + Returns series type. + + + + Detects the type of the series when describing record is ChartSurface. + + Series format. + Returns series type. + + + + Detects the type of the series when describing record is ChartBoppop. + + Series format. + Returns series type. + + + + Detects the type of the series when describing record is ChartRadar. + + Series format. + Returns series type. + + + + Detects the type of the series when describing record is Chartline. + + Series format. + Returns series type. + + + + Detects the type of the series when describing record is ChartScatter. + + Series format. + Returns series type. + + + + This method changes series type. + + Series type to change to. + Indicates whether this change happens because of series creation process. + + + + This method changes series type. + + Series type to change to. + Indicates whether this change happens because of series creation process. + + + + Calls before series type changed. + + Type to change. + Indicates whether we are in the process of series creation. + Type of the series + Indicates whether the axis changes + + + + Changes not intimate type. + + Type to change. + + + + Checks is types are intimate. If intimate then change chart type. + + Format to change. + Type to change. + Returns true if changed type. otherwise false. + + + + Changes intimate line series. + + Format to change. + Type to change. + TypeToChange string representation. + + + + Initialize hash table for change intimate line type. + + HashTable to initialize. + + + + Changes series in combination charts. + + Type to change. + + + + Finds intimate format by type. + + Type to find. + Returns found format or null. + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + Updates formulas after copy operation. + + Record with range info to update. + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + Updated range. + + + + Updates formulas after copy operation. + + Formula token to update. + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + Updated token. + + + + Updates formula token when only part of it was moved. + + Original token. + Source worksheet index. + Rectangle with token range. + Source rectangle. + Destination rectangle. + Token after move operation. + + + + Checks whether the source rectangle contains new range. + + Source Rectangle. + Represents Column Value. + Represents Row Value. + True-if the source rectangle contains range;otherwise False. + + + + Partially removes token. + + Token to shrink + Sheet index. + Range rectangle. + Source rectangle. + Destination rectangle. + Token after shrink operation. + + + + Updates error bars. + + Represents current error bar. + Represents error bar to update. + + + + Gets common series format. + + Returns common series format. + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Cheking whether the last series of the chart have the explosion value + + the boolean value whether chart format have explosion value + + + + Update the row wise or column wise members of chart series for chart Ex + + boolean values indicates whether the property of values need to be changed or not. + + + + Serializes series to the OffsetArrayList. + + OffsetArrayList that will receive records. + + When specified OffsetArrayList is NULL. + + + + + Serializes ChartAi records. + + OffsetArrayList that will receive records. + + + + Sets range value into the ChartAi record. + + ChartAi record that will contain specified range. + Range that will be assigned. + ReferenceType that should be written if range is NULL. + + When specified ChartAi record is NULL. + + + + + Fills and serializes ChartSeries record. + + OffsetArrayList that will receive records. + + + + Checks whether number of items inside single series is correct. + + + + + Serializes data labels data. + + List of biff records to serialize into. + + + + Serializes legend entries. + + Record storage. + + + + Serialize series name. + + Represents record storage. + + + + Reparses method. + + + + + Returns range from ChartAi record. + + ChartAi record that contains range. + Parsed range. + + When chartAi is NULL. + + + + + Gets IRange from current ptg. + + Current ptg. + Returns ptg. + + + + This method is called during dispose operation. + + + + + This event is raised when ValueRange was changed. + + + + + Name of the series. + + + + + Series Name range for the series. + + + + + + Values range for the series. + + + + + Category labels for the series. + + + + + Bubble sizes for the series. + + + + + Synonym for Index property. + + + + + Returns data points collection for the chart series. Read-only. + + + + + Returns format of current Series. + + + + + Represents Series type. + + + + + Indicates whether to use primary axis for series drawing. + + + + + Represents value as entered directly. + + + + + Represents category values as entered directly. + + + + + Represents bubble values as entered directly. + + + + + Gets and sets the value form range cells values collection in datalabels. + + + + + Represents Y error bars. Read-only. + + + + + Indicates if Series contains Y error bars. + + + + + Represents X error bars. Read-only. + + + + + Indicates if Series contains X error bars. + + + + + Represents Series trend lines collection. Read-only. + + + + + Gets or sets the value that represents the kind of grouping for a column, line or area chart + + + + + Gets or sets the value of chart gapWidth of first series + + + + + Gets or sets the value of chart overlap of first series + + + + + Represents whether to serialize gapwidth + + + + + Gets the Pareto line on the Pareto charts. Read-only. + + + + + Gets or Set the ShowLeaderLines if true. + + + + + Gets or Set the LeaderLines border settings. + + + + + This holds cache information of multi level category axis. + + + + + This holds multi level cache point count. + + + + + Represents whether the series are reversed. + + + + + Gets or sets a value to specify the series to invert its colors if the value is negative. + + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "-10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.Series[0].SerieType = ExcelChartType.Column_Cluster; + chart.Series[0].InvertIfNegative =true; + chart.Series[0].InvertIfNegativeColor= Color.Red; + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + This event is raised when name of the series changes. + + + + + Represents index of the series. + + + + + Represent series is Filter + + + + + Series drawing/settings order.//Number of the series. + + + + + Index of the chart group. + + + + + Returns parent chart. Read-only. + + + + + Indicates whether series has default title. + + + + + Returns number of points in the series. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + Represent the filtered category label range + + + + + Represent the Filtered Category value + + + + + Returns series start type. Read-only. + + + + + Represents not default series text for first series. Read-only. + + + + + Gets parent series collection. Read - only. + + + + + Represents parent chart. Read - only. + + + + + Gets parent workbook. Read - only. + + + + + Indicates whether this is pie series. + + + + + Gets series name or formula value (not actual string value). + + + + + This element specifies the series + to invert its colors if the value is negative. + + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "-10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.Series[0].SerieType = ExcelChartType.Column_Cluster; + chart.Series[0].InvertIfNegative =true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the string reference formula + + + + + Gets or sets the number reference formula + + + + + Gets or sets the number reference formula + + + + + Gets or sets the chart's drop lines property as stream. + TODO: Need to add parsing support for drop lines. Should be removed after adding parsing support. + + + + + Gets/Sets the series name cache. + + + + + Gets / Sets the pareto line is hidden + + + + + Gets / Sets the series is hidden or not + + + + + Gets / Sets the format index of chart pareto line + Used only in loaded chart + + + + + Gets / SetsBoolean value indicates category values interpreted in row-wise + + + + + Gets / SetsBoolean value indicates series values interpreted in row-wise + + + + + Gets / Sets the format code for series values + + + + + Gets / Sets the format code for series categories + + + + + Class used for Chart Series Axis implementation. + + + + + Represents the chart series Axis. + + + + + Represents the number of categories or series between tick-mark labels.[Deprecated] + + + + + Represents the number of categories or series between tick-mark labels. + + + The following code illustrates how to set for . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_3D; + + //Set tick label spacing + chart.PrimarySerieAxis.TickLabelSpacing = 2; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Represents the number of categories or series between tick marks.[Deprecated] + + + + + Represents the number of categories or series between tick marks. + + + The following code illustrates how to set for . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_3D; + + //Set tick mark spacing + chart.PrimarySerieAxis.TickMarkSpacing = 2; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Specifies maximum spacing value. + + + + + Represents the XmlTkValue of multilevel label is enabled in binary file + + + + + Represents the XmlTkValue of automatic tick label is enabled in binary file + + + + + Catser range record. + + + + + Indicates whether tick label spacing value is automatically evaluated. + + + + + UnknownRecord that describes label intervals of this axis. + + + + + boolean value used for tick label spacing + + + + + Creates axis object. + + Application object for the axis. + Parent object for the axis. + + + + Creates primary axis of specified type. + + Application object for the axis. + Parent object for the axis. + Type of the new axis. + + + + Creates axis of specified type and specified IsPrimary value. + + Application object for the axis. + Parent object for the axis. + Type of the new axis. + + True if primary axis should be created; otherwise False. + + + + + Extracts primary axis from the array of BiffRecords. + + Application object for the axis. + Parent object for the axis. + Array of BiffRecords with axis data. + + Position of the first axis record in the data array. + + + + + Extracts axis from the array of BiffRecords. + + Application object for the axis. + Parent object for the axis. + Array of BiffRecords with axis data. + + Position of the first axis record in the data array. + + + True if it is primary axis; otherwise False. + + + + + Parse max cross. + + Represents MaxCross data. + + + + Parses walls or floors. + + Represents record storage. + Represents position in storage. + + + + Parses data. + + Represents record to parse. + Represents records storage. + Represents position in storage. + + + + Serializes axis. + + OffsetArrayList that will receive all records. + + + + Initializes variables. + + + + + Clone current object. + + Parent object. + Dictionary with new font indexes. + Dictionary with new worksheet names. + Returns cloned object. + + + + Check the CrtmlFrt record whether it have automatic tick labels and multilevel labels + + input record files to be checked + the boolean value indicates it have automatic tick labels and no multilevel labels + + + + Gets or sets whether or not the tick label spacing is automatic. + + + + + Represents the number of categories or series between tick-mark labels. + + + + + Represents the number of categories or series between tick-mark labels. + + + + + Represents the number of categories or series between tick marks. + + + + + Represents the number of categories or series between tick marks. + + + + + Display categories in reverse order. + + + + + Returns title area. Read-only. + + + + + Represents the point on the axis another axis crosses it. + + + + + Value axis crossing: + False if axis crosses mid-category. + True if axis crosses between categories. + + + + + IsLogScale + + + + + Returns or sets the base of the logarithm when you are using log scales. The default value is 10. + + + + + Maximum Value + + + + + Minimum Value + + + + + ChartSeriesCollection - collection of the chart series. + + + + + Represents the collection of chart series. + + + + + Adds a new to collection and Returns it. + + Newly created object. + + The following code illustrates how a can be created and added to collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set serie + IChartSerie serie = chart.Series.Add(); + + //Set category labels and values + serie.CategoryLabels = sheet.Range["A1:C1"]; + serie.Values = sheet.Range["A2:C2"]; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Adds a new to collection and Returns it. + + Type of new . + Newly created object. + + The following code illustrates how a can be created and added to collection by passing + as a parameter. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set serie + IChartSerie serie = chart.Series.Add(ExcelChartType.Bar_Clustered); + + //Set category labels and values + serie.CategoryLabels = sheet.Range["A1:C1"]; + serie.Values = sheet.Range["A2:C2"]; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Adds a new to collection and Returns it. + + Name of the new . + Newly created object. + + The following code illustrates how a can be created and added to collection by passing + type as a parameter. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set serie + IChartSerie serie = chart.Series.Add("BarSerie"); + + //Set category labels and values + serie.CategoryLabels = sheet.Range["A1:C1"]; + serie.Values = sheet.Range["A2:C2"]; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Adds a new to collection and Returns it. + + Name of the new . + Type of new . + Newly created . + + The following code illustrates how a can be created and added to collection by passing + and type as parameters. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set serie + IChartSerie serie = chart.Series.Add("BarSerie", ExcelChartType.Bar_Clustered); + + //Set category labels and values + chart.Series["BarSerie"].CategoryLabels = sheet.Range["A1:C1"]; + chart.Series["BarSerie"].Values = sheet.Range["A2:C2"]; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Removes a from collection. + + Index of the to remove. + + The following code illustrates how to remove a from collection by specfiying it's index. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set serie + IChartSerie serie = chart.Series.Add("BarSerie"); + + //Set category labels and values + serie.CategoryLabels = sheet.Range["A1:C1"]; + serie.Values = sheet.Range["A2:C2"]; + + //Remove Serie + chart.Series.RemoveAt(0); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Removes a from collection. + + name to remove. + + The following code illustrates how to remove a from collection by specfiying it's name. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set serie + IChartSerie serie = chart.Series.Add("BarSerie"); + + //Set category labels and values + serie.CategoryLabels = sheet.Range["A1:C1"]; + serie.Values = sheet.Range["A2:C2"]; + + //Remove Serie + chart.Series.Remove("BarSerie"); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Returns the number of in the collection. Read-only Long. + + + The following code illustrates how to get the number of in the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Check count + Console.Write(chart.Series.Count); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //1 + + + + + + Returns a single object from collection. + + + The following code illustrates how access a in the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C2"]; + + //Set chart type + chart.ChartType = ExcelChartType.WaterFall; + + //Set serie format + IChartSerieDataFormat format = chart.Series[0].SerieFormat; + + //Set visibility + format.ShowConnectorLines = false; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Returns a single object from collection. + + + The following code illustrates how access a in the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set serie + IChartSerie serie = chart.Series.Add("BarSerie", ExcelChartType.Bar_Clustered); + + //Set category labels and values + chart.Series["BarSerie"].CategoryLabels = sheet.Range["A1:C1"]; + chart.Series["BarSerie"].Values = sheet.Range["A2:C2"]; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Start of the default series name. + + + + + Represents parent chart. + + + + + Represents record storage for serialize error bars and trend lines. Use only for serialize. + + + + + Array that helps to serialize trendlines labels. Use only for serialize. + + + + + Represents summary index for error bars and trends. Use only for serialize. + + + + + Represents trend line index. + + + + + Creates collection. + + Application object for the collection. + Parent object for the collection. + + + + Defines a new series. + + Returns a Series object. + + + + Defines a new series. Returns a Series object. + + Name of the new series. + Newly created series object. + + + + Defines a new series. Returns a Series object. + + Type of new series. + Newly created series object. + + + + Defines a new series. Returns a Series object. + + Name of the new series. + Type of new series. + Newly created series object. + + + + Removes Series object from the collection. + + Index of the series to remove. + + + + Removes series by name. + + Series name to remove. + + + + Parses ChartSiIndex records. + + Array of records containing ChartSiIndex records. + Position of the first ChartSiIndex record. + + When specified record is not ChartSiIndex record. + + + + + Serializes collection. + + OffsetArrayList that will receive all records. + + When specified OffsetArrayList is NULL. + + + + + Serializes data labels data. + + List of biff records to serialize into. + + + + Adds series to the collection. + + Series that should be added to the collection. + Series that was added. + + + + Performs additional operations before the Clear method. + + + + + Clone current instance. + + Parent object. + Hash table with new Worksheet names. + Dictionary with new font indexes. + Returns cloned instance. + + + + Clone current instance. + + Parent object. + Returns cloned instance. + + + + Gets count of series that has same chart group index. + + Parameter to check. + Returns count of found series. + + + + Gets series that has same chart group index. + + Parameter to check. + Returns list of found series. + + + + Gets count of series with same type in collection. + + Current type. + Returns count of same types. + + + + Gets count of series with same type in collection. + + Current type. + Returns count of same start types. + + + + Sets for default all series in chart. + + boolean value indicates whether the formats to be preserved or not + + + + Sets for default all series in chart. + + + + + Finds order by series type. + + Type to find. + Returns order. + + + + Updates data points for create one of Pyramid, Cylinder, Cone chart types. + + Base format for update. + Top format for update. + + + + Updates data points for create one of Pyramid, Cylinder, Cone chart types. + + Base format for update. + Top format for update. + + + + Adds record in some collection in some series. + + Collection index. + Record to add. + + + + Returns array of entered records. + + Si record index. + Returns array of entered records. + + + + Gets array by si index. + + Si index. + Returns array of arrays by si index. + + + + Updates series index after remove + + Remove index. + + + + Gets series type by order. + + Current order. + Returns found type. + + + + Clears all series data formats. + + Represents format to update. + + + + Gets default series name. + + Returns default series name. + + + + Gets default series name. + + Represents series index in collections. + Returns default series name. + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + Returns legend offset. + + Represents series index. + Returns legend offset. + + + + Assign trend data label. + + Represents data label. + + + + Clears error bars. + + + + + Puts all series into correct order based on their index. + + Dictionary containing series axis. + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Returns a single Name object from a Names collection. + + + + + Returns a single Name object from a Names collection. + + + + + Represents record storage for serialize error bars and trend lines. Use only for serialize. + + + + + Represents summary index for error bars and trends. Use only for serialize. + + + + + Represents record storage for serialize trend labels. Use only for serialize. Read-only. + + + + + Represents count of trends + series count. + + + + + Represents text area in the chart. + + + + + Indicating whether chartTitlle element parsed or not. + + + + + Indicating whether display value from cells values to datalabels. + + + + + Indicating whether value form cells range in datalabels. + + + + + Text area font. + + + + + Chart text record. + + + + + Parent workbook. + + + + + Text frame. + + + + + Text. + + + + + Object link. + + + + + Data labels record. + + + + + Chart ai record. + + + + + Chart Al Runs record represents the rich text format + + + + + Represents chart position record. + + + + + Attached label layout + + + + + Indicates if current text assign to trend object. + + + + + Represents Excel 2007 layout data + + + + + Represents the TextArea Paragraph + + + + + Indicats whether to show text properties or not + + + + + Indicats whether to show text size properties or not + + + + + Indicats whether to show text bold properties or not + + + + + Represents RTF string. + + + + + Represents Vertical Text Rotation. + + + + + RichTextStream internally used as biff record + + + + + Indicats whether to text is parsed or not + + + + + The array stores the cache information + + + + + Boolean value indicates whether other elements in chart can overlap this text area. + + + + + The list stores the default paragraph properties + + + + + Unwraps specified record. + + Record to unwrap. + Unwrapped record. + + + + Creates objects sets its Application and Parent properties to specified values. + + Application object. + Parent object. + + + + Creates objects sets its Application and Parent properties to specified values. + + Application object. + Parent object. + Text link. + + + + Creates objects sets its Application and Parent properties to specified + values and parses object data. + + Application object. + Parent object. + Array with object's records. + Position of the first object's record in the data array. + + + + Searches for all necessary parent objects. + + + + + Generates .Net font object corresponding to the current font. + + Generated .Net font. + + + + Parses chart text area. + + BiffRecords array to parse. + Starting data position. + Position after parsing. + + + + Parses ChartFontxRecord. + + Record to parse. + + + + Parses single record. + + Record to parse. + Data array with records to parse (used for complex object parsing). + Position in data array after current record. + Position after record parsing. + + + + Extracts RichText XML stream from the record and its length + + RichText stream Record to be extracted + extracted XML stream + + + + parse the binary stream and convert it to XML stream + + the XML reader used to read the stream + the text area element which is to be parsed and assigned + + + + Saves chart text area into OffsetArrayList. + + + OffsetArrayList that will receive all chart's records. + + + When specified OffsetArrayList is NULL. + + + + + Saves chart text area into OffsetArrayList. + + + OffsetArrayList that will receive all chart's records. + + If true - serialize as legend entry text; otherwise false. + + + When specified OffsetArrayList is NULL. + + + + + Saves chart text area into OffsetArrayList. + + + + + + + + Saves fontx record. + + OffsetArrayList that will receive necessary records. + + + + Saves single record into list of biff records. + + OffsetArrayList that will receive necessary records. + Record to serialize. + + + + Creates frame format. + + Newly created frame format. + + + + Initializes frame format. + + + + + Sets internal font according to the font index. + + Font index to set. + + + + Creates data labels object if necessary. + + + + + Clone current record. + + Parent object for create new instance. + Dictionary with new font indexes. + Dictionary with new worksheet names. + Returns clone of current object. + + + + Creates object that is copy of the current instance. + + Parent object for create new instance. + Returns clone of current object. + + + + Updates Series index. + + Index to set. + + + + Updates record for serialize as trend line data label. + + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Attaches all necessary events. + + + + + Detaches all events. + + + + + Event handler for color change. + + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Creates rich text string. + + + + + True if the font is bold. Read / write Boolean. + + + + + Returns or sets the primary color of the object. Read / write ExcelKnownColors. + + + + + Gets / sets font color. If there is at least one free color, + define a new color; if not, search for the closest one in + workbook palette. + + + + + True if the font style is italic. Read / write Boolean. + + + + + True if the font is an outline font. Read / write Boolean. + + + + + True if the font is a shadow font or if the object has + a shadow. Read / write Boolean. + + + + + Returns or sets the size of the font. Read / write Variant. + + + + + True if the font is struck through with a horizontal line. + Read / write Boolean + + + + + Gets or sets the offset value of superscript and subscript + + + + + True if the font is formatted as subscript. + False by default. Read / write Boolean. + + + + + True if the font is formatted as superscript. False by default. + Read/write Boolean + + + + + Returns or sets the type of underline applied to the font. Can + be one of the following ExcelUnderlineStyle constants. + Read / write ExcelUnderline. + + + + + Returns or sets the font name. Read / write string. + + + + + Gets / sets font vertical alignment. + + + + + Gets and sets the indicating wheather chart title element parsed or not. + + + + + Text. + + + + + Gets rich text. + + + + + Return frame format. Read-only. + + + + + Gets object link record. Read-only. + + + + + Text rotation angle. + + + + + Gets value indicating whether TextRotation was changed. Read-only. + + + + + Represents Vertical Text Rotation. + + + + + Returns chart text record. Read-only. + + + + + Gets / sets number format for the text area. + + + + + Gets index to the number format. Read-only. + + + + + Returns ChartAIRecord for the text area (creates it if necessary). Read-only. + + + + + Return ChartAlRunsRecord for the text area (creates if necessary). Read-only. + + + + + Returns true if contain dataLabels otherwise false. Read-only. + + + + + Display mode of the background. + + + + + True if background is set to automatic. + + + + + Indicates if current text assign to trend object. + + + + + Indicates whether color has automatic color. Read-only. + + + + + Gets or sets Excel 2007 layout data + + + + + Returns parent workbook object. + + + + + Represents the TextArea Paragraph + + + + + Gets or sets a value indicating whether to show text properties or not + + + + + Gets or sets a value indicating whether to show text size properties or not + + + + + Gets or sets a value indicating whether to show text bold properties or not + + + + + Gets / Sets the string array + + + + + Gets / Sets the overlay boolean value + + + + + Indicates whether object should be serialized. Read-only. + + + + + Indicates whether text area contains text. + + + + + Gets or sets a value indicating whether this instance is formula. + + + true if this instance is formula; otherwise, false. + + + + + Indicats whether to text is parsed or not + + + + + Gets the font index. + + + + + Gets and sets boolean value indicating whether display to value from cells value to datalabels. + + + + + Gets and sets indicating whether value from cells range in datalables. + + + + + Indicates whether series name is in data labels. + + + + + Indicates whether category name is in data labels. + + + + + Indicates whether value is in data labels. + + + + + Indicates whether percentage is in data labels. + + + + + Indicates whether bubble size is in data labels. + + + + + Indicates whether Leader Lines is in data labels. + + + + + Delimiter. + + + + + Indicates whether legend key is in data labels. + + + + + Represents data labels position. + + + + + Return attached label layout record. Read-only + + + + + Gets or sets value indicating whether to show category label and value as percentage. + + + + + Returns textarea's color object. Read-only. + + + + + Returns font index. Read-only. + + + + + Returns FontImpl for current font. Read-only. + + + + + Represents Trend Line Collection. + + + + + Interface that represents trend line collection. + + + + + Adds a new to collection and Returns it. + + Returns added trend line object. + + The following code illustrates how to access and add new instance of to + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Get chart serie trendlines collection + IChartTrendLines trendLines = serie.TrendLines; + + //Add new trendline instance + IChartTrendLine trendLine = trendLines.Add(); + + //Set trendline name + trendLine.Name = "trendline"; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Adds a new with specified to collection and Returns it. + + Represents type of trend line. + Returns added trend line object. + + The following code illustrates how to access and add new instance of with specified to + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Get chart serie trendlines collection + IChartTrendLines trendLines = serie.TrendLines; + + //Add new trendline instance with logarithmic type + IChartTrendLine trendLine = trendLines.Add(ExcelTrendLineType.Logarithmic); + + //Set trendline name + trendLine.Name = "trendline"; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Removes a from collection. + + Index of the to remove. + + The following code illustrates how to remove by index from + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Get chart serie trendlines collection + IChartTrendLines trendLines = serie.TrendLines; + + //Add trendlines + IChartTrendLine trendLine1 = trendLines.Add(ExcelTrendLineType.Logarithmic); + IChartTrendLine trendLine2 = trendLines.Add(ExcelTrendLineType.Linear); + + Console.WriteLine("Before TrendLines Count is: " + trendLines.Count); + + //Remove the trendline from the collection + trendLines.RemoveAt(0); + + Console.WriteLine("After TrendLines Count is: " + trendLines.Count); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //Before TrendLines Count is: 2 + //After TrendLines Count is: 1 + + + + + + Clears current collection. + + + The following code illustrates how to clear collection + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Get chart serie trendlines collection + IChartTrendLines trendLines = serie.TrendLines; + + //Add trendlines + IChartTrendLine trendLine1 = trendLines.Add(ExcelTrendLineType.Logarithmic); + IChartTrendLine trendLine2 = trendLines.Add(ExcelTrendLineType.Linear); + + Console.WriteLine("Before TrendLines Count is: " + trendLines.Count); + + //Clears the trendlines collection + trendLines.Clear(); + + Console.WriteLine("After TrendLines Count is: " + trendLines.Count); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //Before TrendLines Count is: 2 + //After TrendLines Count is: 0 + + + + + + Gets single trend line by index. Read-only. + + + The following code illustrates how to access from the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Get chart serie trendlines collection + IChartTrendLines trendLines = serie.TrendLines; + + //Add trendlines + trendLines.Add(ExcelTrendLineType.Logarithmic); + trendLines.Add(ExcelTrendLineType.Linear); + + //Accessing the first trendline from collection + IChartTrendLine trendline = trendLines[0]; + + //Set trendline Name + trendline.Name = "TrendLine 1"; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Returns the number of in the collection. Read-only + + + The following code illustrates how to get the number of in the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Get chart serie trendlines collection + IChartTrendLines trendLines = serie.TrendLines; + + //Add trendlines + IChartTrendLine trendLine1 = trendLines.Add(ExcelTrendLineType.Logarithmic); + IChartTrendLine trendLine2 = trendLines.Add(ExcelTrendLineType.Linear); + + Console.WriteLine("Number of TrendLines created is: " + trendLines.Count); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //Number of TrendLines created is: 2 + + + + + + Represents parent series. + + + + + Creates new instance of collection. + + Represents current application. + Represents parent object. + + + + Adds new instance of trend line to collection. + + Returns added trend line object. + + + + Adds new instance of trend line to collection. + + Represents type of trend line. + Returns added trend line object. + + + + Removes trend line object from collection. + + Represents + + + + Serialize all trend lines. + + Represents record holder. + + + + Checks if current trend line supported negative values. + + Represents trend line types. + + + + Adds trend object to trends collection. + + Represents trend object to add. + + + + Checks series type. If current type does not support trendlines throw exception. + + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Clones current object. + + Represents parent object for new cloned instance. + Represents new font indexes. + Dictionary with new worksheet names. + Returns cloned object. + + + + Gets single trend line by index. Read-only + + + + + Indicates whether object was parsed. + + + + + Represents chart trend line. + + + + + Represents ChartTrendLine interface. + + + + + Clears current trend line formats. + + + The following code illustrates how to clear the formats of object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Get chart trendlines collection + IChartTrendLines trendLines = serie.TrendLines; + + //Add trendline + IChartTrendLine trendline = trendLines.Add(); + + //Set RSquared value for trendline + trendline.DisplayRSquared = true; + + //Set trendline border color + trendline.Border.ColorIndex = ExcelKnownColors.Red; + + //Set trendline name + trendline.Name = "trendline 1"; + + //Check trendline before clearing the formats + Console.WriteLine("Before clearing the formats\n------"); + Console.WriteLine("Is default line color applied in trendline:" + trendline.Border.IsAutoLineColor); + Console.WriteLine("Trendline name:" + trendline.Name); + Console.WriteLine("Is R-squared value displayed:" + trendline.DisplayRSquared); + + //Clear the trendline formats + trendline.ClearFormats(); + + //Check trendline after clearing the formats + Console.WriteLine("After clearing the formats\n------"); + Console.WriteLine("Is default line color applied in trendline:" + trendline.Border.IsAutoLineColor); + Console.WriteLine("Trendline name:" + trendline.Name); + Console.WriteLine("Is R-squared value displayed:" + trendline.DisplayRSquared); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + // Output will be + // Before clearing the formats + //------ + //Is default line color applied in trendline:False + //Trendline name:trendline 1 + //Is R-squared value displayed:True + //After clearing the formats + //------ + //Is default line color applied in trendline:True + //Trendline name:Linear (Serie3) + //Is R-squared value displayed:False + + + + + + Represents border object. Read-only. + + + The following code illustrates how to access and format the for + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value2 = 10; + sheet.Range["B2"].Value2 = 20; + sheet.Range["C2"].Value2 = 30; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Add serie + IChartSerie serie = chart.Series.Add(); + + //Set serie Y Values + serie.Values = sheet.Range["A2:C2"]; + + //Set serie X Values + serie.CategoryLabels = sheet.Range["A1:C1"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart trendlines collection + IChartTrendLines trendLines = serie.TrendLines; + + //Add trendline + IChartTrendLine trendline = trendLines.Add(); + + //Set trendline broder properties + trendline.Border.ColorIndex = ExcelKnownColors.Red; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Represents number of periods that the trend line extends backward. + + + The following code illustrates how to set backward forecast value for object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Value2 = -1; + sheet.Range["B1"].Value2 = 0; + sheet.Range["C1"].Value2 = 1; + sheet.Range["A2"].Value2 = 10; + sheet.Range["B2"].Value2 = 20; + sheet.Range["C2"].Value2 = 30; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Add serie + IChartSerie serie = chart.Series.Add(); + + //Set serie Y Values + serie.Values = sheet.Range["A2:C2"]; + + //Set serie X Values + serie.CategoryLabels = sheet.Range["A1:C1"]; + + //Set chart type + chart.ChartType = ExcelChartType.Scatter_Markers; + + //Set X axis minimum and maximum values + chart.PrimaryCategoryAxis.MinimumValue = -2; + chart.PrimaryCategoryAxis.MaximumValue = 2; + + //Get chart trendlines collection + IChartTrendLines trendLines = serie.TrendLines; + + //Add trendline + IChartTrendLine trendline = trendLines.Add(); + + //Set backward forecast value + trendline.Backward = 3; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Represents number of periods that the trend line extends forward. + + + The following code illustrates how to set Forward forecast value for object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Value2 = -1; + sheet.Range["B1"].Value2 = 0; + sheet.Range["C1"].Value2 = 1; + sheet.Range["A2"].Value2 = 10; + sheet.Range["B2"].Value2 = 20; + sheet.Range["C2"].Value2 = 30; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Add serie + IChartSerie serie = chart.Series.Add(); + + //Set serie Y Values + serie.Values = sheet.Range["A2:C2"]; + + //Set serie X Values + serie.CategoryLabels = sheet.Range["A1:C1"]; + + //Set chart type + chart.ChartType = ExcelChartType.Scatter_Markers; + + //Set X axis minimum and maximum values + chart.PrimaryCategoryAxis.MinimumValue = -2; + chart.PrimaryCategoryAxis.MaximumValue = 2; + + //Get chart trendlines collection + IChartTrendLines trendLines = serie.TrendLines; + + //Add trendline + IChartTrendLine trendline = trendLines.Add(); + + //Set forward forecast value + trendline.Forward = 3; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if the equation for the trend line is displayed on the chart. + + + The following code illustrates how to display equation for object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Get chart trendlines collection + IChartTrendLines trendLines = serie.TrendLines; + + //Add trendline + IChartTrendLine trendline = trendLines.Add(); + + //Set equation in trendline + trendline.DisplayEquation = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if the R-squared value of the trend line is displayed on the chart. + + + The following code illustrates how to display RSquared value for object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Get chart trendlines collection + IChartTrendLines trendLines = serie.TrendLines; + + //Add trendline + IChartTrendLine trendline = trendLines.Add(); + + //Set RSquared value for trendline + trendline.DisplayRSquared = true; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Represents point where the trend line crosses the value axis. + + + The following code illustrates how to set intercept value for object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Value2 = 1; + sheet.Range["B1"].Value2 = 2; + sheet.Range["C1"].Value2 = 3; + sheet.Range["A2"].Value2 = 10; + sheet.Range["B2"].Value2 = 20; + sheet.Range["C2"].Value2 = 30; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Add serie + IChartSerie serie = chart.Series.Add(); + + //Set serie Y Values + serie.Values = sheet.Range["A2:C2"]; + + //Set serie X Values + serie.CategoryLabels = sheet.Range["A1:C1"]; + + //Set chart type + chart.ChartType = ExcelChartType.Scatter_Markers; + + //Get chart trendlines collection + IChartTrendLines trendLines = serie.TrendLines; + + //Add trendline + IChartTrendLine trendline = trendLines.Add(); + + //Set intercept value + trendline.Intercept = 10; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + True if the point where the trend line crosses the value + axis is automatically determined by the regression. + + + The following code illustrates how to check whether the object intercept value is automatic or not. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Value2 = 1; + sheet.Range["B1"].Value2 = 2; + sheet.Range["C1"].Value2 = 3; + sheet.Range["A2"].Value2 = 10; + sheet.Range["B2"].Value2 = 20; + sheet.Range["C2"].Value2 = 30; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Add serie + IChartSerie serie = chart.Series.Add(); + + //Set serie Y Values + serie.Values = sheet.Range["A2:C2"]; + + //Set serie X Values + serie.CategoryLabels = sheet.Range["A1:C1"]; + + //Set chart type + chart.ChartType = ExcelChartType.Scatter_Markers; + + //Get chart trendlines collection + IChartTrendLines trendLines = serie.TrendLines; + + //Add trendline + IChartTrendLine trendline = trendLines.Add(); + + //Set intercept value + trendline.Intercept = 10; + + //Check trendline intercept is automatic + Console.WriteLine("Is Trendline Intercept value is automatic:" + trendline.InterceptIsAuto.ToString()); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + // Output will be + // Is Trendline Intercept value is automatic:False + + + + + + Gets or Sets trend line type. + + + The following code illustrates how to set for object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Get chart serie trendlines collection + IChartTrendLines trendLines = serie.TrendLines; + + //Add trendline + IChartTrendLine trendline = trendLines.Add(); + + //Set trendline type + trendline.Type = ExcelTrendLineType.Polynomial; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Represents for Moving Average and Polynomial trend line type order value. + + + The following code illustrates how to set order value for object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value2 = 10; + sheet.Range["B2"].Value2 = 20; + sheet.Range["C2"].Value2 = 30; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Add serie + IChartSerie serie = chart.Series.Add(); + + //Set serie Y Values + serie.Values = sheet.Range["A2:C2"]; + + //Set serie X Values + serie.CategoryLabels = sheet.Range["A1:C1"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart trendlines collection + IChartTrendLines trendLines = serie.TrendLines; + + //Add trendline + IChartTrendLine trendline = trendLines.Add(); + + //Set trendline type + trendline.Type = ExcelTrendLineType.Polynomial; + + //Set trendline order + trendline.Order = 6; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Represents whether the trendline name is default or not. + + + The following code illustrates how to check whether the object name is default or not. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Get chart serie trendlines collection + IChartTrendLines trendLines = serie.TrendLines; + + //Add trendline + IChartTrendLine trendline = trendLines.Add(ExcelTrendLineType.Logarithmic); + + //Set trendline name + trendline.Name = "Trendline 1"; + + //Check trendline name is automatic + Console.WriteLine(trendline.NameIsAuto); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + // False + + + + + + Gets or Sets the name of trend line. + + + The following code illustrates how to access name from object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Get chart serie trendlines collection + IChartTrendLines trendLines = serie.TrendLines; + + //Add trendline + IChartTrendLine trendline = trendLines.Add(ExcelTrendLineType.Logarithmic); + + //Get trendline Name + Console.WriteLine(trendline.Name); + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + // Log. (Serie3) + + + + + + Returns data label. Read-only. + + + To get DataLabel or must be set to true. + Otherwise exception will be thrown. + + + The following code illustrates how to enable and set text for object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart serie + IChartSerie serie = chart.Series[0]; + + //Get chart trendlines collection + IChartTrendLines trendLines = serie.TrendLines; + + //Add trendline + IChartTrendLine trendline = trendLines.Add(); + + //Enable trendline data label by DisplayRSquared + trendline.DisplayRSquared = true; + + //Set data label text + trendline.DataLabel.Text = "y=10*x"; + + //Get trendline data label Text + Console.WriteLine(trendline.DataLabel.Text); + + //Save and Dispose + workbook.SaveAs("Chart.xls"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + // y=10*x + + + + + + Gets the shadow.Read-only. + + + The following code illustrates how to access and format the for + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value2 = 10; + sheet.Range["B2"].Value2 = 20; + sheet.Range["C2"].Value2 = 30; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Add serie + IChartSerie serie = chart.Series.Add(); + + //Set serie Y Values + serie.Values = sheet.Range["A2:C2"]; + + //Set serie X Values + serie.CategoryLabels = sheet.Range["A1:C1"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Get chart trendlines collection + IChartTrendLines trendLines = serie.TrendLines; + + //Add trendline + IChartTrendLine trendline = trendLines.Add(); + + //Set trendline shadow color + trendline.Shadow.ShadowColor = System.Drawing.Color.Red; + + //Set trendline shadow outer presets + trendline.Shadow.ShadowOuterPresets = Excel2007ChartPresetsOuter.OffsetDiagonalTopRight; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets the object. Read-only.[Deprecated] + + + + + Represents max order value for polynomial trend line type. + + + + + Represents name hash table + Key - trend line type, Value - legend string. + + + + + Represents the chart LegendEntry + + + + + Represents main trend line record. + + + + + Represents Shadow + + + + + Represents border object. + + + + + Represents trendline border object + + + + + Represents parent series. + + + + + Represents trend line type. + + + + + Indicates if name is auto. + + + + + Represents custom name. + + + + + Represents text area for data label. + + + + + Represents text area. + + + + + Represents some unique ID. + + + + + Represents the 3D features + + + + + Initialize all static members. + + + + + Creates new instance of object. + + Represents current application. + Represents parent object. + + + + Finds parent objects. + + + + + Creates new instance of trend object by parsing from stream. + + Represents application object. + Represents parent object. + Represents data holder. + Represents position in stream. + Represents parsed legend entry, or null. + + + + Clears current trend line. + + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Parse trend object from stream. + + Represents record holder. + Represents position in storage. + Represents legend entry. + + + + Serialize records to biff stream + + Represents record holder. + + + + Serialize chart ai records. + + Represents record holder. + + + + Serialize legend entry. + + Represents record storage. + + + + Serialize data labels. + + Represents records holder. + + + + Checks some records properties. + + + + + Check if current trend support intercept property, if failed throws exception. + + + + + Check if current trend support backward property, if failed throws exception. + + Represents value. + + + + Changes trend line type. + + Represents new trend line type. + + + + Check if current trend support backward property, if failed throws exception. + + Represents order value. + + + + Updates data labels + + Represents flag for updates. + + + + Updates trend type on parsing. + + + + + Sets current data label. + + Represents data label. + + + + Clones current object. + + Represents parent object for new cloned instance. + Represents new font indexes. + Dictionary with new worksheet names. + Returns cloned object. + + + + Represents LegendEntry object. + + + + + Represents border object. Read-only. + + + + + Represents trendline border object. + + + + + Represents the Shadow.Read-only + + + + + This property indicates whether the shadow object has been created + + + + + Gets the chart3 D options. + + The chart3 D options. + + + + This property Indicates whether the Shadow object has been created(which includes the 3D properties) + + + + + Represents number of periods that the trend line extends backward. + + + + + Represents number of periods that the trend line extends forward. + + + + + True if the equation for the trend line is displayed on the chart. + + + + + True if the R-squared value of the trend line is displayed on the chart. + + + + + Represents point where the trend line crosses the value axis. + + + + + True if the point where the trend line crosses the value + axis is automatically determined by the regression. + + + + + Represents trend line type. + + + + + Represents for Moving Average and Polynomial trend line type order value. + + + + + Indicates if name is default. + + + + + Represents trend line name. + + + + + Returns data label. Read-only. + + + + + Get the ChartTextAreaImpl object + + + + + Represents some unique id. + + + + + Represents chart walls or floor. + + + + + Interface that represents chart wall or floor. + + + + + Gets or Sets the thickness of the walls or floor. + + + The following code illustrates how to set Thickness for + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_3D; + + //Get BackWall + IChartWallOrFloor backwall = chart.BackWall; + + //Set wall thickness + backwall.Thickness = 30; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Gets or Sets the pictureType in walls or floor + + The following code illustrates how to set PictureUnit for + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_3D; + + //Get BackWall + IChartWallOrFloor backwall = chart.BackWall; + + //Set wall Texture to cork image + backwall.Fill.Texture = ExcelTexture.Cork; + + //Set picture unit to stackScale + backwall.PictureUnit = ExcelChartPictureType.stackScale; + + //Save and Dispose + workbook.SaveAs("Chart.xlsx"); + workbook.Close(); + } + + + + + + Represents default line color for walls or plot. + + + + + Represents default color index for walls or plot. + + + + + Represents default line color for floor. + + + + + Represents default foreground color for walls or plot. + + + + + Represents default background color index for walls or plot. + + + + + Represents default value background color index. + + + + + Represents default value foreground color index. + + + + + Indicates if wall or floor object. + + + + + Represents chart interior. + + + + + Represents parent chart + + + + + Represents the Shadow + + + + + Represents the 3D features + + + + + Represents fill properties. + + + + + Indicates if shape properties for the wall or flooe. + + + + + It specifies the thickness of the walls or floor as a percentage of the largest dimension of the plotarea. + + + + + It specifies the pictureformat struct or stretch + + + + + It specifies the picture stack unit + + + + + Creates ChartWallsOrFloor object. + + Application object. + Parent object. + If true - represents walls; otherwise - floor. + + + + Creates ChartWallsOrFloor object. + + Application object. + Parent object. + Indicates if it is walls. + Represents record storage. + Represents position in storage. + + + + Parses walls or floor records. + + Offset array list. + Current position in offset array list. + + + + Serializes wall or floor object. + + OffsetArrayList that will receive all records. + + + + Clears current walls or floor. + + + + + Sets to default floor or walls. + + + + + Sets as default line record in category axis. + + + + + Sets as default line record in value axis. + + + + + Sets as default area record in category axis. + + + + + Sets as default area record in value axis. + + + + + Clones current object. + + Parent object. + Returns cloned object. + + + + Represents chart interior. + + + + + Represents the Shadow.Read-only + + + + + + This property indicates whether the shadow object has been created + + + + + + Indicates whether Shape properties has been created. + + + true if this instance has shape properties; otherwise, false. + + + + + Returns or sets the thickness of the walls or floor as a percentage of the largest dimension of the plot area. + + The thickness. + + + + Gets or Sets the picture format of the walls or floor + + + + + Gets or Sets the picture format of the walls or floor + + + + + Gets the chart3 D options. + + The chart3 D options. + + + + This property Indicates whether the Shadow object has been created(which includes the 3D properties) + + + + + Represents fill properties. Read-only. + + + + + This property indicates whether interior object was created. Read-only. + + + + + Indicates if this object is walls or floor. + + + + + Represents foreground color. + + + + + Represents background color. + + + + + Represents pattern. + + + + + Represents if use automatic format. + + + + + Represents visible. + + + + + Represents frame format each record is wrapped by ChartWrapperRecord. + + + + + Initializes new instance of ChartWrappedFrameFormat. + + Application object. + Parent object. + + + + Checks whether specified record is begin. + + Record to check. + True if this is begin; false otherwise. + + + + Parses single record. + + Record to parse. + Number of not closed begin record. + + + + Unwraps record if necessary. + + Record to unwrap. + Unwrapped record. + + + + Serializes single record. + + OffsetArrayList that will get biff records. + Record to serialize. + + + + Represents chart text area, each record is wrapped into ChartWrappedRecord. + + + + + Unknown bytes. Needed for data labels serialization. + + + + + Unknown end. + + + + + Initializes new instance. + + Application object. + Parent object. + + + + Creates objects sets its Application and Parent properties to specified + values and parses object data. + + Application object. + Parent object. + Array with object's records. + Position of the first object's record in the data array. + + + + Creates objects sets its Application and Parent properties to specified values. + + Application object. + Parent object. + Text link. + + + + Creates frame format. + + Newly created frame format. + + + + Saves single record into list of biff records. + + OffsetArrayList that will receive necessary records. + Record to serialize. + + + + Serializes unknown section. + + + OffsetArrayList that will receive all chart's records. + + Unknown bytes to serialize. + + + + Indicates whether object should be serialized. Read-only. + + + + + Creates Clipboard provider for the Biff8 format. + + + + + ClipboardProvider is an abstract class that facilitates reading from + or writing to the clipboard workbook object. + + + + + Next element in the clipboard providers list. + + + + + Workbook that should be copied to the clipboard. + + + + + Worksheet that should be copied to the clipboard. + + + + + Name of the format that this ClipboardProvider can + read from or write to. + + + + + Default constructor. + + + + + Creates provider for the specified worksheet. + + Worksheet that should be copied to the clipboard. + + + + Creates provider for the specified workbook. + + Workbook that should be copied to the clipboard. + + + + Creates provider for the specified workbook and sets the Next property + to the specified value. + + Workbook that should be copied to the clipboard. + Next clipboard provider. + + + + Creates provider for the specified worksheet and sets the Next property + to the specified value. + + Worksheet that should be copied to the clipboard. + Next ClipboardProvider. + + + + Initializes clipboard provider for the specified workbook. + + Workbook that can be copied to the clipboard. + + + + Initializes clipboard provider for the specified worksheet. + + Worksheet that can be copied to the clipboard. + + + + Sets clipboard's data object to the value returned + by GetForClipboard method. + + + + + Sets clipboard's data object to the value returned + by GetForClipboard method. + + Range to copy to the clipboard. + + + + Reads workbook from the clipboard. + + Workbooks collection to add workbook to. + Workbook that was read if success in reading; otherwise NULL. + + When application is NULL. + + + + + Returns IDataObject (for copying to the clipboard) + that contains data from workbook or worksheet. + + IDataObject for copying to the clipboard. + + + + Returns IDataObject (for copying to the clipboard) + that contains data from workbook or worksheet. + + Range to copy to the clipboard. + IDataObject for copying to the clipboard. + + + + Extracts workbook from the data object. + + Data object that contains workbook data. + Workbooks collection to add workbook to. + Extracted workbook. + + + + Extracts the workbook. + + Data object to extract. + + + + Extracts the workbook. + + Data object to extract. + Range to copy into data object. + + + + Returns next clipboard provider. + + + + + Gets / sets name of the clipboard format. + + + + + Workbook that can be copied to the clipboard. + + + + + Worksheet that can be copied to the clipboard. + + + + + Default name of the format. + + + + + Default constructor. + + + + + Creates provider and sets its Next property to the specified value. + + Next clipboard provider in the provider's list. + + + + Creates provider and sets its Next property to the specified value. + + Worksheet to copy to the clipboard. + Next clipboard provider in the provider's list. + + + + Extracts workbook from the data object. + + Data object that contains workbook data. + Workbooks collection to add workbook to. + Extracted workbook. + + + + Fills the data object. + + DataObject to filling. + + + + Extracts the workbook. + + Data object to extract. + Range to copy into data object. + + + + Returns data for copying into clipboard. + + Clipboard range. + MemoryStream with data to copy into clipboard. + + + + Returns IDataObject (for copying to the clipboard) + that contains data from workbook or worksheet. + + IDataObject for copying to the clipboard. + + This method is not implemented yet. + + + + + Returns IDataObject (for copying to the clipboard) + that contains data from workbook or worksheet. + + Range to copy to the clipboard. + IDataObject for copying to the clipboard. + + This method is not implemented yet. + + + + + DelimiterClipboardProvider - derived from the ClipboardProvider. + Facilitates reading from and writing to the clipboard in unicode text + format when there is a specified string delimiter between worksheet + columns and another delimiter between rows. + + + + + Default format name. + + + + + Default delimiter between worksheet columns. + + + + + Default delimiter between worksheet rows. + + + + + String that will be copied to the clipboard, contains worksheet's data. + + + + + Delimiter between worksheet columns. + + + + + Delimiter between worksheet rows. + + + + + Default constructor - just for getting the workbook from the clipboard. + If data needs to be copied from the clipboard, then the Initialize + method or set Workbook or Worksheet properties should be called. + + + + + Creates provider for the specified worksheet. + + Worksheet that should be copied to the clipboard. + + + + Creates provider for the specified worksheet and + sets the next clipboard provider. + + Worksheet that should be copied to the clipboard. + Next clipboard provider in the list. + + + + Returns IDataObject (for copying to the clipboard) + that contains data from workbook or worksheet. + + IDataObject for copying to the clipboard. + + + + Returns IDataObject (for copying to the clipboard) + that contains data from workbook or worksheet. + + Range to copy. + IDataObject for copying to the clipboard. + + + + Fills internal string that will be copied to the clipboard. + + + + + Fills internal string that will be copied to the clipboard. + + Range to copy to the clipboard. + + + + Extracts workbook from the data object. + + Data object that contains workbook data. + Workbooks collection to add workbook to. + Extracted workbook. + + + + Fills the dataobject. + + Dataobject to extract. + + + + Extracts the workbook. + + Data object to extract. + Range to copy into data object. + + + + Converts string to the worksheet. + + String that should be converted. + Application object for the new worksheet. + Parent object for the new worksheet. + Newly created worksheet with values from the string. + + + + Converts string to the workbook. + + String that should be converted. + Workbooks collection to add workbook to. + Newly created workbook with values from the string. + + + + Converts memory stream data to the workbook. + + MemoryStream that contains data for the workbook. + Workbooks collection to add workbook to. + Newly created workbook with values from the MemoryStream. + + + + Fills a specified sheet with values from the specified string. + + Sheet that should receive data from the string. + String with worksheet data. + + When the sheet is NULL. + + + + + Returns index of the character after string + (sequence of characters inside "" or ''). + + Contains string. + Position of the opening " or '. + Index of the character after closing " or '. + + + + Delimiter between worksheet columns. + + + + + Delimiter between worksheet rows. + + + + + Represents a collection of AddInFunctions. + + + + + Represents a collection of custom Add In functions. + + + + + Adds new function to the collection. + + Name of the file that contains add-in function. + Function to add. + Index of the added function. + + + + Adds new local function to the collection. + + Function to add. + Index of the added function. + + + + Returns a single AddInFunction object from a AddInFunction collection based on index. + + + + + Returns number of elements in the collection. + + + + + Beginning of the file name with add-in function. + + + + + Local workbook index. + + + + + Dictionary with all file names with extern functions. + + + + + Parent workbook. + + + + + Extern workbook with unknown functions. + + + + + Creates a collection and sets its Application and Parent properties. + + Application object for the collection. + Parent object for the collection. + + + + Searches for all necessary parents. + + + + + Adds new add-in function to the collection. + + File with add-in function. + Function name. + Index of the new function. + + + + Adds new local function to the collection. + + Function to add. + Index of the added function. + + + + Adds new local function to the collection. + + External book index. + Name index. + + + + Removes add-in collection with specified index. + + Item to remove. + + + + Indicates whether collection contains workbook with specified name. + + Name to check. + True if collections contains book with specified name. + + + + Represents a copying of add-in functions. + + Add-in function to be copied. + + + + + + + + + + + Gets Add-in function from the collection based on index. + + + + + Represents an array list extension. + + + + + Represents item storage. + + + + + Represents count of elements. + + + + + Creates new instance of ArrayList extension collection. + + + + + Creates new instance of ArrayList extension collection with its count. + + Represents count. + + + + Updates count of storage array. + + Represents count of array to update. + + + + Reduces size of the internal array if necessary. + + Maximum size of the internal array. + + + + Inserts specified number of empty RowStorages into given position. + + Index to insert. + Number of items to insert. + Number of items after index position to preserve. + + + + Get Maximum Row Count + + + + + + Get Row Index in Row Storage Based on the row number + + RowNumber + RowIndex in RowStorage + + + + + Gets value by index. + + + + + Represents an AutoFilter collections + + + + + Represents a collection of Autofilters. + + + + + Range to be filtered. + + + To know more about filters refer Data Filtering. + + + The following code illustrates how to set the range for filters. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C7"].CellStyleName = "CurrencyFormat"; + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set filter range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[0]; + + //Add filter + filter.AddTextFilter("Around the Horn"); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + } + + + + + + Number of columns to be filtered. Read-only. + + + property gets the number of columns present within the range set to . Here for example, We set + range "A1:C7" to property. Since there are only three columns within the range, property returns + three. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C7"].CellStyleName = "CurrencyFormat"; + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set filter range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[0]; + + //Add filter + filter.AddTextFilter("Around the Horn"); + + //Check the filter count + Console.WriteLine(filters.Count); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //3 + + + + + + Gets the DataSorter. + + The DataSorter. + The following code illustrates how to access the DataSorter in AutoFilters. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C7"].CellStyleName = "CurrencyFormat"; + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set filter range + filters.FilterRange = worksheet["A1:C7"]; + + //Create sorter + IDataSort sorter = filters.DataSorter; + + //Add sortfield + ISortField sortField = sorter.SortFields.Add(1, SortOn.Values, OrderBy.Ascending); + + //Perform sort + sorter.Sort(); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filter.xlsx"); + workbook.Close(); + } + + + + + + Returns single autofilter object by column index. Read-only. + + + The following code snippet shows how can be accessed from collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data + worksheet["A1"].Text = "Products"; + worksheet["A2"].Text = "Alfreds Futterkiste"; + worksheet["A3"].Text = "Antonio Moreno Taqueria"; + worksheet["A4"].Text = "Around the Horn"; + worksheet["A5"].Text = "Bon app"; + worksheet["A6"].Text = "Eastern Connection"; + worksheet["A7"].Text = "Ernst Handel"; + worksheet["B1"].Text = "Qtr1"; + worksheet["B2"].Number = 744.6; + worksheet["B3"].Number = 5079.6; + worksheet["B4"].Number = 1267.5; + worksheet["B5"].Number = 1418; + worksheet["B6"].Number = 4728; + worksheet["B7"].Number = 943.89; + worksheet["C1"].Text = "Qtr2"; + worksheet["C2"].Number = 162.56; + worksheet["C3"].Number = 1249.2; + worksheet["C4"].Number = 1062.5; + worksheet["C5"].Number = 756; + worksheet["C6"].Number = 4547.92; + worksheet["C7"].Number = 349.6; + + //Create style for table number format + IStyle style1 = workbook.Styles.Add("CurrencyFormat"); + style1.NumberFormat = "_($* #,##0.00_);_($* (#,##0.00);_($* \" - \"??_);_(@_)"; + + //Apply number format + worksheet["B2:C7"].CellStyleName = "CurrencyFormat"; + + //Create filters collection + IAutoFilters filters = worksheet.AutoFilters; + + //Set filter range + filters.FilterRange = worksheet["A1:C7"]; + + //Set filter column + IAutoFilter filter = filters[0]; + + //Add filter + filter.AddTextFilter("Around the Horn"); + + //Apply AutoFit + worksheet.UsedRange.AutofitColumns(); + + //Save and Dispose + workbook.SaveAs("Filters.xlsx"); + workbook.Close(); + } + + + + + + Name of the named range for autofilter range. + + + + + Name of the named range for autofilter range in MS Excel 2007. + + + + + Range to be filtered. + + + + + Parent worksheet. + + + + + Parent ListObject. + + + + + Top most row in the filter range. + + + + + Left most column in the filter range. + + + + + Bottom most row in the filter range. + + + + + Right most column in the filter range. + + + + + Represents the presence of adjacent non-empty cells. + + + + + + Creates a new instance for AutoFilter collection. + + Excelengine application. + Parent object. + + + + Searches for all needed parents. + + + + + Parses filter records. Must be called after parsing of all names. + + Records to parse + + + + Serializes AutoFilter collection into set of records. + + Place where serialized records will be placed. + + + + Cleared event handler. + + + + + Clones AutoFilter collection. + + Parent object. + Returns cloned object. + + + + Clones ListObject AutoFilter collection. + + Parent object. + Returns cloned object. + + + + Changes Excel versions based on AutoFilter collection. + + Max last row. + Max last column. + Excel version to make conversion into. + + + + Updates internal range object that stores filtered range. + + + + + Updates the Filter Range for AutoFilters + + Range to filter. + + + + Updates internal range object that stores filtered range. + + + + + Includes adjacent non-empty cells in the internal range object that stores filtered range. + + + + + Includes adjacent non-empty cells in the bottom of the internal range object that stores filtered range. + + + + + Initializes the filter range values. + + First row in the filter range + First column in the filter range + Last row in the filter range + Last column in the filter range + + + + Checks for non-empty adjacent cells which are above the existing filter range to find the top most row in the filter range. + + + + + Checks for non-empty adjacent cells which are left to the existing filter range to find the left most column in the filter range. + + + + + Checks for non-empty adjacent cells which are below the existing filter range to find the bottom most row in the filter range. + + + + + Checks for non-empty adjacent cells which are right to the existing filter range to find the right most column in the filter range. + + + + + Checks for any adjacent non-empty cells to a single cell. + + + + + Checks whether the row in the filter range has no empty cells. + + + + + Checks whether the column in the filter range has no empty cells. + + + + + Range to be filtered. + + + + + Returns single autofilter object by column index. Read-only. + + + + + Gets address of filtered range in R1C1 style. Read-only. + + + + + Gets the DataSorter. + + The DataSorter. + The following code illustrates how to get the DataSorter from AutoFilters. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sorting.xlsx"); + + workbook.Worksheets[0].AutoFilters.FilterRange = workbook.Worksheets[0].UsedRange; + + //Create DataSorter for AutoFilters. + IDataSort filterSort = workbook.Worksheets[0].AutoFilters.DataSorter;; + + //Adding Sorting fields for DataSorter. + filterSort.SortFields.Add(1, SortOn.Values, OrderBy.Ascending); + + //Perform Sorting for AutoFilters. + filterSort.Sort(); + + workbook.SaveAs("SortedExcel.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns parent worksheet. Read-only. + + + + + Indicates whether sheet contains filtered range. + + + + + Gets default autofilter named range name. + + + + + Represent a Borders collection. + + + + + A collection of four Border objects that represent the four + borders of a Range or Style object. + + + + + Returns or sets the color from or to all the in the collection. + + + To set color for individual borders, we can use or property. + + + The following code illustrates how to set color from enumeration to all the in the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["D2"].Text = "text"; + worksheet["C3"].Text = "in"; + worksheet["D3"].Text = "cell"; + + //Set borders + IBorders borders = worksheet["C2:D3"].Borders; + + //Set color + borders.Color = ExcelKnownColors.Red; + + //Set line style + borders.LineStyle = ExcelLineStyle.Thick; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets RGB color from or to all the in the collection. + + + The following code illustrates how to set RGB color from structure to all the in the + collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["D2"].Text = "text"; + worksheet["C3"].Text = "in"; + worksheet["D3"].Text = "cell"; + + //Set borders + IBorders borders = worksheet["C2:D3"].Borders; + + //Set color + borders.ColorRGB = System.Drawing.Color.Red; + + //Set line style + borders.LineStyle = ExcelLineStyle.Thick; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Returns the number of objects in the collection. Read-only, Long. + + + The following code illustrates how to access Count property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set borders + IBorders borders = worksheet["C2"].Borders; + + //Check count + Console.Write(borders.Count); + + //Save and Dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //6 + + + + + + Returns a object that represents one of the of either a + of cells or a . + + + The following code illustrates how to access using from the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + worksheet["D2"].Text = "text"; + worksheet["C3"].Text = "in"; + worksheet["D3"].Text = "cell"; + + //Set borders + IBorders borders = worksheet["C2:D3"].Borders; + + //Set color + borders.Color = ExcelKnownColors.Red; + + //Set line style + borders.LineStyle = ExcelLineStyle.Thick; + + //Set diagonal line visibility + borders[ExcelBordersIndex.DiagonalDown].ShowDiagonalLine = false; + borders[ExcelBordersIndex.DiagonalUp].ShowDiagonalLine = false; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the line style for the . Read / write ExcelLineStyle. + + + The following code illustrates how to set LineStyle to all the in the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set borders + IBorders borders = worksheet["C2:D3"].Borders; + + //Set color + borders.Color = ExcelKnownColors.Red; + + //Set line style + borders.LineStyle = ExcelLineStyle.Thick; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Synonym for Borders.LineStyle. Read / write. + + + The following code illustrates how to set Value to all the in the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set borders + IBorders borders = worksheet["C2:D3"].Borders; + + //Set color + borders.Color = ExcelKnownColors.Red; + + //Set line style + borders.Value = ExcelLineStyle.Thick; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Parent workbook. + + + + + Specifies a boolean value that indicate whether the border collection has a empty border + + + + + Creates collection and sets its application and parent properties. + + Application object for this collection. + The parent object for this collection. + Indicates whether null elements must be added to internal array. + + + + Creates collection and sets its application and parent properties. + + Application object for this collection. + The parent object for this collection. + + + + Creates collection taking borders from ExtendedFormatImplWrapper. + + The application object for the collection. + The parent object for the collection. + + ExtendedFormatImplWrapper from where all borders will be taken. + + + + + Checks whether both border collections are equal. + + Object to be compared. + True if both are equal. + + + + Generates hash code for BordersCollection. + + Hash code of the BorderCollection. + + + + Sets the parent for Border Collections. + + + + + + + + + + + + Returns or sets the primary color of the object. + Read / write ExcelKnownColors. + + + + + Returns or sets the primary color of the object. Use the RGB function to create a color value. + Read / write ExcelKnownColors. + + + + + Gets a Border object that represents one of the borders of either a + range of cells or a style. Read-only. + + + + + Gets or sets the line style for the border. + Read / write ExcelLineStyle. + + + + + Synonym for Borders.LineStyle. Read / write ExcelLineStyle. + + + + + Specifies a boolean value that indicate whether the border collection has a empty border + + + + + Represents a borders for range that contains more than one cell. + + + + + Default borders count. + + + + + All cells of the range. + + + + + Parent workbook. + + + + + Application. + + + + + Creates instances for specified range. + + Range for which instance must be created. + + + + Creates instances for specified range and sets its application. + + Range for which instance must be created. + >Application object for this collection. + + + + + + + + + Gets or sets the primary color of the object, as shown in the + following table. Use the RGB function to create a color value. + Read / write ExcelKnownColors. + + + + + Gets or sets the primary color of the object, as shown in the + following table. Use the RGB function to create a color value. + Read / write color. + + + + + Gets a Border object that represents one of the borders of either a + range of cells or a style. + + + + + Gets or sets the line style for the border. Read / write ExcelLineStyle. + + + + + Returns default borders count. + + + + + Synonym for Borders.LineStyle. Read / write Variant. + + + + + Represents the document properties in a MS Excel document. + + + + + Represents user interface for built-in document properties. + + + + + Removes all properties from the collection. + + + + + Indicates whether collection contains specified property. + + Property id. + True if collection contains required property. + + + + Returns single entry from the collection. Read-only. + + + + + Returns single entry from the collection. Read-only. + + + + + Returns number of elements in the collection. Read-only. + + + + + Title document property. + + + + + Subject document property. + + + + + Author document property. + + + + + Keywords document property. + + + + + Comments document property. + + + + + Template document property. + + + + + LastAuthor document property. + + + + + Revnumber document property. + + + + + EditTime document property. + + + + + LastPrinted document property. + + + + + CreationDate document property. + + + + + LastSaveDate document property. + + + + + PageCount document property. + + + + + WordCount document property. + + + + + CharCount document property. + + + + + ApplicationName document property. + + + + + Category. + + + + + Target format for presentation (35mm, printer, video, and so on). + + + + + ByteCount. + + + + + LineCount. + + + + + ParCount. + + + + + SlideCount. + + + + + NoteCount. + + + + + HiddenCount. + + + + + MmclipCount. + + + + + Manager. + + + + + Company. + + + + + Boolean value to indicate whether the custom links are + hampered by excessive noise, for all applications. + + + + + Options for property storage creation. + + + + + Guid for parsing/serialization summary properties. + + + + + Guid for parsing/serialization document properties. + + + + + Dictionary with document properties, key - property name/id, value - property object. + + + + + Dictionary with summary document properties, key - property id, value - property object. + + + + + Creates a new instance for Builtin documentation properties. + + Application object for this collection. + Parent object for this collection. + + + + Indicates whether collection contains specified property. + + Property id. + True if collection contains required property. + + + + Returns dictionary where property must be placed. + + Property id. + Dictionary where property must be placed. + + + + OnClear is invoked after Clear behavior. + + + + + Extract built-in document properties. + + DocumentPropertyCollection to extract properties from. + + + + Reads properties from PropertySection. + + PropertySection to read data from. + Dictionary that will receive new properties. + List to add properties to. + Indicates whether we are reading document summary properties. + Indicates whether property is built-in. + + + + Writes properties into specified property section with values. + + Property sections to be written. + Values to be written. + + + + Converts property into PropertyData structure. + + Property to convert. + Proposed property id. + Converted structure. + + + + Serializes built-in properties. + + IPropertySetStorage to serialize into. + + + + Extract built-in document properties. + + IPropertySetStorage to extract properties from. + + + + Writes properties into IPropertySetStorage. + + IPRopertySetStorage to write properties into. + Storage GUID. + Collection of properties to write. + + + + Reads properties from IPropertySetStorage. + + IPropertySetStorage to read from + Storage GUID. + Dictionary that will receive new properties. + List to add properties to. + Indicates whether we are reading document summary properties. + Indicates whether property is built-in. + + + + OnInsert is invoked after Insert behavior. + + Index to be inserted. + Value to be inserted. + + + + Serializes built-in properties with summary and document. + + Summary section to be serialized. + Document section to be serialized. + + + + Gets single entry from the collection. Read-only. + + + + + Gets single entry from the collection. Read-only. + + + + + Gets or sets title of the document. + + + + + Gets or sets subject of the document. + + + + + Gets or sets author of the document. + + + + + Gets or sets Keywords of the document. + + + + + Gets or sets comments of the document. + + + + + Gets or sets template of the document. + + + + + Gets or sets last author of the document. + + + + + Gets or sets revision number of the document. + + + + + Gets or sets edit time of the document. + + + + + Gets or sets last printed of the document. + + + + + Gets or sets creation date of the document. + + + + + Gets or sets last saved date of the document. + + + + + Gets or sets page count of the document. + + + + + Gets or sets word count of the document. + + + + + Gets or sets character count of the document. + + + + + Gets or sets application name of the document. + + + + + Indicates whether the file has Headpair tag. + + + + + Gets or sets security of the document. + + + + + Gets or sets category of the document. + + + + + Target format for presentation (35mm, printer, video, and so on). + + + + + Gets or sets byte count of the document. + + + + + Gets or sets line count of the document. + + + + + Gets or sets paragraph count of the document. + + + + + Gets or sets slide count of the document. + + + + + Gets or sets note count of the document. + + + + + Gets or sets hidden count of the document. + + + + + Gets or sets Mutlimedia clip count of the document. + + + + + Set to True when scaling of the thumbnail is desired. If not set, cropping is desired. + + + + + Gets or sets Manager of the document. + + + + + Gets or sets company of the document. + + + + + Gets or sets boolean value to indicate whether the custom links are + hampered by excessive noise, for all applications. + + + + + Represents the collection of CellRecord. + + + + + Table with cell records. + + + + + Table with created ranges. + + + + + Parent worksheet. + + + + + Parent workbook. + + + + + Indicates whether we should use ranges cache or not. + + + + + Record extractor to get Biff records from. + + + + + Initializes new instance of the collection. + + Application object for the collection. + Parent object for the collection. + + + + Searches for all necessary parent objects. + + + + + Removes all elements from the IDictionary. + + + + + Adds an element with the provided key and value to the IDictionary. + + The Object to use as the key of the element to add. + The Object to use as the value of the element to add. + + + + Returns an IDictionaryEnumerator for the IDictionary. + + An IDictionaryEnumerator for the IDictionary. + + + + Removes the element from the IDictionary with the specified key of object type. + + The key of the element to remove. + + + + Determines whether the RecordTable contains an element with the specified key of object type. + + The key to locate in the IDictionary. + True if the IDictionary contains an element with the key; otherwise, False. + + + + Returns an IDictionaryEnumerator for the IDictionary. + + An IDictionaryEnumerator for the IDictionary. + + + + Adds an element with the provided key and value to the IDictionary. + + The Object to use as the key of the element to add. + The Object to use as the value of the element to add. + + + + Adds an specified cell to the IDictionary. + + The Object to use as the value of the element to add. + + + + Removes the element from the IDictionary with the specified key of long type. + + The key of the element to remove. + + + + Removes the element from the IDictionary based on the row and column index. + + One-based row index of the cell to remove. + One-based column index of the cell to remove. + + + + Determines whether collection contains row. + + Zero-based row index. + True if the collection contains at least one element with specified row index; otherwise, False. + + + + Determines whether the RecordTable contains an element with the specified key of long type. + + The key to locate in the IDictionary. + True if the IDictionary contains an element with the key; otherwise, False. + + + + Determines whether the RecordTable contains an element with row and column. + + One-based row index of the cell to locate. + One-based column index of the cell to locate. + True if the IDictionary contains an element with the key; otherwise, False. + + + + Copies the elements of the ICollection to an Array, starting at a particular Array index. + + + The one-dimensional Array that is the destination of the elements copied + from ICollection. The Array must have zero-based indexing. + + The zero-based index in array at which copying begins. + + + + Saves all rows into specified OffsetArrayList. + + OffsetArrayList that will receive all rows. + List into which all DBCell record must be placed. + Number of DBCells. + + When records is null. + + + + + Prepares next block of rows. + + OffsetArrayList that will receive all rows. + List to add serialization data into. + Start row index. + Size of the records. + Offset to the first row. + One-based last row index to serialize. + One-based first column index in the worksheet. + One-based last column index in the worksheet. + Destination excel version. + Row index after block saving. + + + + Returns array of all cells in the specified row. + + One-based index of row. + One-based first column in the parent worksheet. + One-based last column in the parent worksheet. + Variable that receives first used column of the row. + Variable that receives last used column of the row. + Destination excel version. + Array of all cells in the specified row. + + When values is null. + + + + + Extracts ranges from the reader. + + Reader to extract ranges from. + Indicates whether to ignore styles. + Dictionary with new XF indexes when bIgnoreStyles is set to true. + Decryptor used to decrypt data if necessary. + + + + Extracts ranges from the reader. + + IndexRecord that contains all required information. + Reader to extract ranges from. + Indicates whether to ignore styles. + Dictionary with new XF indexes when bIgnoreStyles is set to true. + True if parsing succeeded. + + + + Adds record to the collection from BiffRecord with ignore style options. + + Record to add. + Indicates whether to ignore styles. + + + + Adds record to the collection from cell postion format with ignore style options. + + Record to add. + Indicates whether to ignore styles. + + + + Adds MulRKRecord to the records collection. + + Record to add. + Indicates whether to ignore styles. + + + + Adds MulBlankRecord to the records collection. + + Record to add. + Indicates whether to ignore styles. + + + + Adds formula record and its string value. + + Formula record to add. + String value to add. + Indicates whether styles should be ignored. + + + + Indicates whether specified formula is complex + and requires range object to be created for it. + + FormulaRecord to check. + + True if specified formula is complex and requires + range object to be created for it. + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Sets cell range with cell index. + + Cell key. + Range to set. + + + + Sets cell range with row and column index. + + One-based row index. + One-based column index. + Range to set. + + + + Returns cell range based on cell position. + + Cell key. + Corresponding cell range. + + + + Returns cell range based on row and column index. + + One-based row index. + One-based column index. + Corresponding cell range. + + + + Sets cell record based on cell index. + + Cell key. + Cell to set. + + + + Sets cell record based on row and column index. + + One-based row index. + One-based column index. + Cell to set. + + + + Returns cell record based on the key. + + Cell key. + Corresponding cell record. + + + + Returns cell record based on row and column index. + + One-based row index. + One-based column index. + Corresponding cell record. + + + + Clears range in the dictionary that corresponds to the specified range. + + Rectangle to clear. + + + + Copies cells from another worksheet. + + Source cells collection to copy cells from. + + Dictionary with changes in style indexes, + key - old style index, + value - new style index. + + Dictionary with changes in worksheet names. + Dictionary with new extended format indexes. + Dictionary with new name indexes. + Dictionary with new font indexes. + External sheet dictionary. + + + + Returns string value associated with specified cell index. + + Index to cell. + Indicates whether we are interested in correct height or width. + String value associated with specified cell index. + + + + Returns string value associated with specified cell index. + + Index to cell. + Indicates whether we are interested in correct height or width. + String object to fill. + String value associated with specified cell index. + + + + Gets the RTF string in LabelSST of the cell index. + + Cell index. + Indicates whether we are interested in correct height or width. + RTF in the cell index. + + + + Fills rich text string object with string data. + + Record to get data from. + Indicates whether we are interested in correct height or width. + String to fill. + + + + Returns text value. + + Cell index. + Text value if appropriate record was found; otherwise - empty string. + + + + Gets error value by cell index. + + Cell index. + Returns string that represents error value. + + + + Gets bool value by cellindex. + + Cell index. + Returns value by cell index. + If true than value is correct; otherwise incorrect. + + + + Indicates if collection by index contain number. + + Index of record. + Returns true if contain number; otherwise - false. + + + + Indicates if collection by index contain bool or error. + + Index of record. + Returns true if contain bool or error; otherwise - false. + + + + Indicates if collection by index contain number as formula value. + + Index of record. + Returns true if contain number; otherwise - false. + + + + Indicates if collection by index contain bool or error as formula value. + + Index of record. + Returns true if contain number; otherwise - false. + + + + Returns cell value by cell index. + + Cell index. + Cell value if appropriate record was found; otherwise returns double.MinValue. + + + + Returns cell value by cell index without formula value. + + Cell index. + Cell value if appropriate record was found; otherwise returns double.MinValue. + + + + Returns formula value. + + Cell index. + Formula value if appropriate record was found; otherwise double.MinValue. + + + + Sets string formula value. + + Cell index. + String value to set. + + + + Returns string formula value. + + Cell index. + String formula value. + + + + Gets date time by cell index. + + Cell index. + Returns date time or null. + + + + Copies cell into another worksheet. + + Cell to copy. + Formula string value of the cell. + + Dictionary with updated extended format indexes, + or Null if indexes were not updated. + + New cell index + Source workbook. + Dictionary with updated font indexes or Null if indexes were not updated. + Copy options. + True if the cell is copied else false. + + + + Create external workbook for the formula. + + The source workbook. + The destination workbook. + Cell formula array. + + + + Change the Name reference Index + + The source workbook. + The destination workbook. + Cell formula array. + + + + Get or create new external workbook for the formula. + + The source workbook. + The destination workbook. + External workbook index. + returns the get of created external workbook + + + + Get the named range index from workbook. + + The name to get index. + The destination workbook. + The destination worksheet. + returns the index of the named range. + + + + Caches intersection of the two ranges. + + The first range to intersect. + The second range to intersect. + Output intersection rectangle. + RecordTable with intersection. + + + + Returns minimum used row. + + Start column. + End column. + Minimum used row. + + + + Returns maximum used row. + + Start column. + End column. + maximum used row. + + + + Returns minimum used column. + + One-based index of the start row. + One-based index of the end row. + One-based index of the minimum used column. + + + + Returns maximum used column. + + Start row. + End row. + Maximum used column. + + + + Gets formula value by cell index. + + Cell index. + Returns formula value or null. + + + + Gets formula value by cell index with R1C1 notation. + + Cell index. + If true - returns in R1C1 notations. + Returns formula value or null. + + + + Gets formula value by cell index with number format information. + + Cell index. + If true - returns in R1C1 notations. + Represents number info. Can be null. + Returns formula value or null. + + + + Gets string value by cell index. + + Cell Index. + Row index + Column index + Range from which value to be returned + CSV seperator + Returns string value or empty string. + + + + Gets extended format index by cell index. + + Cell index. + Returns extended format index or int.MINVALUE. + + + + Gets extended format index by row and column index. + + One-based row index. + One-based column index + Returns extended format index or int.MinValue if not found. + + + + Gets extended format index of the row. + + One-based row index. + Returns extended format index or int.MinValue if not found. + + + + Gets extended format index of the column. + + One-based column index. + Returns extended format index or int.MinValue if not found. + + + + Gets font by cell index. + + Cell index. + Returns font or null. + + + + Copies style from one cell into another. + + One-based row index of the source cell. + One-based column index of the source cell. + One-based row index of the destination cell. + One-based column index of the destination cell. + + + + Creates new cell without adding it to the collection.. + + One-based row index of the cell to create. + One-based column index of the cell to create. + Record type. + Created cell. + + + + Creates new cell. + + One-based row index of the cell to create. + One-based column index of the cell to create. + Record type. + Created cell. + + + + Gets cell style by cell index. + + Cell index. + Returns cell index. + + + + Returns object containing cell formatting. + + Cell index to get formatting for. + An ojbect containing cell formatting. + + + + Sets number value with default extended format index. + + Represents column index. One-based. + Represents row index. One-based. + Represents number value. + + + + Sets number value in cell index. + + Cell index. + Represents number value. + + + + Sets number value with specified extended format index. + + Represents column index. One-based. + Represents row index. One-based. + Represents number value. + Represents xf index. + + + + Sets boolean value. + + Represents column index. One based + Represents row index. One based. + Represents boolean value. + + + + Sets boolean value in specified cell index. + + Cell index. + Represents boolean value. + + + + Sets boolean value with extended format. + + Represents column index. One-based. + Represents row index. One-based. + Represents boolean value. + Represents xf index. + + + + Sets error value with a string value and default extended format index. + + Represents column index. One based. + Represents row index. One based. + Represents error value. + + + + Sets error value with a string value in cell index. + + Cell index. + Represents error value. + + + + Sets error value with a string value and extended format index. + + Represents column index. One based. + Represents row index. One based. + Represents error value. + Represents xf index. + + + + Sets error value with error code and extended format index. + + Represents column index. One based. + Represents row index. One based. + Represents error code. + Represents xf index. + + + + Sets formula value with extended format index. + + Represents column index. One based. + Represents row index. One based. + Represents formula to set. + Represents extended format index. + + + + Sets formula value with extended format index, number format information and R1C1 notation. + + Represents column index. One based. + Represents row index. One based. + Represents formula to set. + Represents extended format index. + If true - value in R1C1 notation. + Represent number format info, can be null. + + + + Sets formula value with extended format index and R1C1 notation. + + Represents column index. One based. + Represents row index. One based. + Represents formula to set. + Represents extended format index. + If true - value in R1C1 notation. + + + + Sets formula value with extended format index, number format information, + R1C1 notation and parse formula. + + Represents column index. One based. + Represents row index. One based. + Represents formula to set. + Represents extended format index. + If true - value in R1C1 notation. + If true - parse formula. + Represent number format info, can be null. + + + + Sets blank value. + + Represents column index. One based. + Represents row index. One based. + Represents extended format index. + + + + Sets RTF value. + + Represents column index. One based. + Represents row index. One based. + Represents extended format index. + Represents rtf to set. + + + + Sets string value from existing SST collection. + + Represents column index. One based. + Represents row index. One based. + Represents extended format index. + Represents SST index + + + + Sets cell to the non-SST string record (LabelRecord). + + One-based row index. + One-based column index. + Extended format index. + String value to set. + + + + Free's range object. + + One-based row index of the range object to remove from internal cache. + One-based column index of the range object to remove from internal cache. + + + + Removes all data saving cells formatting. + + + + + Sets array formula. + + Record to set. + + + + Returns array record corresponding to the cell + + One-based row index of the cell to get ArrayRecord for. + One-based column index of the cell to get ArrayRecord for. + Corresponding array record. + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + Removes last column from the worksheet. + + One-based column index. + + + + Removes last column from the worksheet. + + One-based column index. + + + + Updates indexes to named ranges from array of new index. + + Parent workbook. + New indexes. + + + + Updates indexes to named ranges from IDictionary. + + Parent workbook. + New indexes. + + + + Replaces all shared formula with ordinary formula. + + + + + Updates string indexes. + + List with new indexes. + + + + Finds the cell positions based on find value of byte type. + + Storage range. + Value to find. + If true - finds first value; otherwise - all values. + If findfirst - true then returns range; otherwise - array with all found values. + List with cell indexes that contains specified value. + + + + Finds the cell positions based on find value of string type with find option. + + Storage range. + Value to find. + If true - finds first value; otherwise - all values. + Way to find + If findfirst - true then returns range; otherwise - array with all found values. + + List with cell indexes that contains specified value. + + + + + Finds the cell positions based on find value of double type. + + Storage range. + Value to find. + If true - finds first value; otherwise - all values. + If findfirst - true then returns range; otherwise - array with all found values. + List with cell indexes that contains specified value. + + + + Finds the cell positions based on find value of byte type. + + Storage range. + Value to find. + Indicates whether we should look for error code or boolean value. + If findfirst - true then returns range; otherwise - array with all found values. + List with cell indexes that contains specified value. + + + + Finds the cell positions which has a given dictionary index. + + Dictionary index to be found. + List with cell indexes that contains specified value. + + + + Caches and removes specified rectangle from the table. + + Source range. + Row delta to add to the resulting table. + Column delta to add to the resulting table. + Output maximum zero-based row index. + Output maximum zero-based column index. + Boolean flag to indicate if a row is moved or inserted. + Cached table. + + + + This method should be called immediately after extended format removal with IDictionary. + + Dictionary with updated extended formats. + + + + This method should be called immediately after extended format removal. + + Array with updated extended formats. + + + + This method updates indexes to the extended formats after version change. + + New restriction for maximum possible XF index. + + + + Sets cell style with extended format index. + + One-based row index. + One-based column index. + Index of the extended format to set. + + + + Sets cell style in specified row and column. + + One-based row index. + Index of the extended format to set. + + + + Looks through all records and calls AddIncrease for each LabelSST record. + + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + + + + + + + + Parses bool or error value from formula value. + + Represents formula record. + Returns value string. + + + + Creates internal cache for range objects. + + + + + Updates sheet references in the formula. + + Formula to update. + Dictionary with new worksheet names. + Source workbook. + + + + Copies string records. + + Source collection with strings to copy. + + + + Returns format applied to the cell. + + Cell index. + Format applied to the cell. + + + + Returns font applied to the cell. + + Cell index. + Font applied to the cell. + + + + Gets new index of an extended format. + + Old index of the extended format. + Dictionary with new extended format indexes. + Copy range options. + New index of the extended format. + + + + Updates LabelSST indexes after SST record parsing. + + Dictionary with indexes to update, key - old index, value - new index. + + + + Fills string object with data. + + String object to fill. + Index in the shared strings table. + + + + Returns cell type. + + One-based row index. + One-based column index. + + + + This method is called when object is about to be disposed. + + + + + Searches for the record of specified type. + + Record type to look for. + One-based index to the row to look at. + One-based index of the column to start looking at. + One-based index of the column to end looking at. + Column index that contains record of the specified type or value beyond iLastCol if not found. + + + + Gets first used row. Read-only. + + + + + Gets last used row. Read-only. + + + + + Gets first used column. Read-only. + + + + + Gets last used column. Read-only. + + + + + Represents parent worksheet. + + + + + Gets or sets table with cell records. Read-only. + + + + + Indicates whether we should use ranges cache or not. Default value if false. + + + + + Gets or sets ExcelVersion of the collection. + + + + + Gets the record extractor of the cell record collection. + + + + + Gets number of elements in the collection. Read-only. + + + + + Gets a value indicating whether the IDictionary has a fixed size. Read-only. + + + + + Gets a value indicating whether the IDictionary is read-only. Read-only. + + + + + Gets an ICollection containing the keys of the IDictionary. Read-only. + + + + + Gets an ICollection containing the values in the IDictionary. Read-only. + + + + + Gets or sets the element with the specified key of object type. + + + + + Gets or sets the element with the specified key of long type. + + + + + Gets or sets the element with the specified one-based row and column indexes. + + + + + Gets a value indicating whether access to the ICollection is synchronized. Read-only. + + + + + Gets an object that can be used to synchronize access to the ICollection. Read-only. + + + + + Collection of the Charts object. + + + + + Represents a collection of charts in the workbook. + + /// The collection contains an object for each chart sheet in the workbook. + Use Charts(index), where index is the chart-sheet index number or name, to return a single object. + + + + Creates a new chart sheet. + + Newly created chart object. + + + + Creates a new chart sheet with the specified name. + + Name of the new chart sheet. + Newly created chart object. + + + + Removes the specified chart sheet from the workbook. + + Name of the object to remove from the collection. + + + + Adds copy of the specified chart to the collection. + + Chart to copy. + + + + Gets the number of charts in the workbook. Read-only. + + + + + Gets a single object with the specified index. + + + + + Gets a single object with the specified name. + + + + + Default start of the chart name. + + + + + Name-to-Chart dictionary. + + + + + Parent workbook. + + + + + Creates chart collection. + + Application object for the collection. + Parent object for the collection. + + + + Creates a new chart. + + Newly created chart object. + + + + Defines a new name. + + Name of the new chart's sheet. + Newly created chart object. + + + + Removes Chart object from the collection. + + Name of the object to remove from the collection. + + + + Adds specified chart to the collection. + + Chart that should be added to the collection. + Added chart object. + + + + Extracts chart object from the BiffReader. + + BiffReader that contains chart data. + Extracted chart. + + + + Extracts chart object from the BiffReader. + + BiffReader that contains chart data. + Parse options. + Indicates whether skip parsing. + + Dictionary with new extended format indexes for ignore styles mode. + + Object used to decrypt encrypted records. + Extracted chart. + + + + Sets all parents. + + + If one of the parent objects cannot be found. + + + + + Moves worksheet inside this collection only. + + Old index in the collection. + New index in the collection. + + + + Event handler for series NameChanged event + + Sender of the event. + Event arguments. + + + + Performs additional operations before Clear method execution. + + + + + Updates chart index after move/insert operation. + + Chart that was changed. + Old sheet index in the TabSheets collection. + + + + + + + + + + + Adds chart into internal collections. + + Chart to add. + + + + This method is called after tabsheet was moved. + + + + + + + Adds copy of the specified chart to the collection. + + Chart to copy. + + + + Returns a single Chart object from a Charts collection. + + + + + Collection stores all comments in the worksheet. + + + + + A collection of cell comments. Each comment is represented by a + Comment object. + + + + + Remove all from the collection. + + + The following code illustrates how to remove all the in the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add comment + worksheet["C2"].AddComment(); + worksheet["E2"].AddComment(); + + //Add text + worksheet.Comments[0].Text = "Comment1"; + worksheet.Comments[1].Text = "Comment2"; + + //Clear comments + worksheet.Comments.Clear(); + + //Save and dispose + workbook.SaveAs("Comments.xlsx"); + workbook.Close(); + } + + + + + + Used without an object qualifier, this property returns an Application + object that represents the Microsoft Excel application. + + + The following code illustrates how to access the from the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add comment + ICommentShape comment = worksheet["C2"].AddComment(); + + //Access application object + Console.Write(comment.Application.DefaultVersion); + + //Save and dispose + workbook.SaveAs("Comments.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //Excel2013 + + + + + + Returns the number of objects in the collection. Read-only Long. + + + The following code illustrates how to access the Count property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add comment + worksheet["C2"].AddComment(); + worksheet["E2"].AddComment(); + + //Get count + Console.Write(worksheet.Comments.Count); + + //Save and dispose + workbook.SaveAs("Comments.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //2 + + + + + + Returns the parent object for the specified object. + + + The following code illustrates how to access the parent of the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add comment + ICommentShape comment = worksheet["C2"].AddComment(); + + //Access parent object + Console.Write(comment.Parent.ToString()); + + //Save and dispose + workbook.SaveAs("Comments.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //Syncfusion.XlsIO.Implementation.Collections.ShapesCollection + + + + + + Returns a single object from the collection. + + + The following code illustrates how to access a from the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add comment + worksheet["C2"].AddComment(); + + //Set text + worksheet.Comments[0].Text = "Comment"; + + //Save and dispose + workbook.SaveAs("Comments.xlsx"); + workbook.Close(); + } + + + + + + Returns single object from the collection by row and column one-based indexes. Read-only. + + + The following code illustrates how to access a from the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add comment + worksheet["C2"].AddComment(); + + //Set text + worksheet.Comments[2, 3].Text = "Comment"; + + //Save and dispose + workbook.SaveAs("Comments.xlsx"); + workbook.Close(); + } + + + + + + Gets single from the collection. + + Name of the item to get. + Single item from the collection. + + The following code illustrates how to access a from the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add comment + ICommentShape comment = worksheet["C2"].AddComment(); + + //Set name + comment.Name = "Comment1"; + + //Set text + worksheet.Comments["Comment1"].Text = "Comment"; + + //Save and dispose + workbook.SaveAs("Comments.xlsx"); + workbook.Close(); + } + + + + + + Default comment width. + + + + + Default comment height. + + + + + Columns count in new comment - 1. + + + + + Rows count in new comment - 1. + + + + + Parent worksheet. + + + + + Dictionary with all comments, + key - cell index (one-based), + value - corresponding comment object. + + + + + + + + + + Creates new instance of the collection and sets its parent and application properties. + + Application object for the collection. + Parent object for the collection. + + + + Remove all from the collection. + + + + + Adds comment to the specified range. + + Range that should be commented. + Newly created comment shape. + + + + Adds comment to the specified range. + + Row of the cell to add comment to. + Column of the cell to add comment to. + Newly created comment shape. + + + + Adds comment to the specified range. + + Row of the cell to add comment to. + Column of the cell to add comment to. + Indicates is parse comment fill line options. + Newly created comment shape. + + + + Adds comment to this collection only. + Should be called from Shapes collection only. + + Comment to add. + + + + Searches for all necessary parent objects. + + + If can't find parent worksheet. + + + + + Removes comment from the collection. + + Comment to remove from the collection. + + + + Removes specified comment only from internal storages (without removing it from shapes collection). + + Comment to remove. + + + + + + + + + OnClear is invoked before Clear behavior. + + + + + Performs additional processes after inserting + a new element into the collection. + + The zero-based index at which to insert value. + The new value of the element at index. + + + + Performs additional processes after removing + an element from the collection. + + The zero-based index at which the value can be found. + The value of the element to remove from index. + + + + OnClear is invoked after Clear behavior. + + + + + Performs additional processes after setting a value in the collection. + + The zero-based index at which oldValue can be found. + The value to replace with newValue. + The new value of the element at the index. + + + + Returns the number of comments in the collection + + + + + Returns single entry from the collection. Read-only. + + + + + Returns single entry from the collection by row and column one-based indexes. Read-only. + + + + + Gets single item from the collection. + + Name of the item to get. + Single item from the collection. + + + + This property indicates whether internal hashtable is invalid and must be filled + once again before accessing. + + + + + Dictionary with all comments, + key - cell index (one-based), + value - corresponding comment object. + + + + + Wrapper over conditional format collection for range. + + + + + Represents a collection of conditional formats. + + + + + Adds a condition format to the collection. + + Returns the newly added instance. + + To add a condition to the conditional formats we use method. It adds and returns a new conditional + format object, that we can use to set and get conditional format criteria and properties. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + IConditionalFormat format2 = formats.AddCondition(); + IConditionalFormat format3 = formats.AddCondition(); + + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Set color. + format.BackColor = ExcelKnownColors.Red; + + format2.FirstFormula = "30"; + format2.SecondFormula = "70"; + format2.Operator = ExcelComparisonOperator.Between; + + //Set color. + format2.BackColor = ExcelKnownColors.Blue; + + format3.FirstFormula = "30"; + format3.SecondFormula = "50"; + format3.Operator = ExcelComparisonOperator.Between; + + //Set color. + format3.BackColor = ExcelKnownColors.Green; + + //Check Count. + Console.WriteLine(formats.Count); + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Removes all the conditional formats in the collection. + + + To remove a particular condition we can use by specifying the index of the conditional format in the collection. + + + The following code illustrates how to set the remove all the conditions applied from the conditional formats collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + + //Add conditions. + IConditionalFormat format = formats.AddCondition(); + IConditionalFormat format2 = formats.AddCondition(); + IConditionalFormat format3 = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Set color. + format.BackColor = ExcelKnownColors.Red; + + //Set Condition. + format2.FirstFormula = "30"; + format2.SecondFormula = "70"; + format2.Operator = ExcelComparisonOperator.Between; + + //Set color. + format2.BackColor = ExcelKnownColors.Blue; + + //Set Condition. + format3.FirstFormula = "30"; + format3.SecondFormula = "50"; + format3.Operator = ExcelComparisonOperator.Between; + + //Set color. + format3.BackColor = ExcelKnownColors.Green; + + //Remove conditions. + formats.Remove(); + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Removes the conditional format at the specified index from the collection. + + Index of the conditional format to be removed. + + The following code illustrates how to remove a particular condition from the conditional formats collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + + //Add conditions. + IConditionalFormat format = formats.AddCondition(); + IConditionalFormat format2 = formats.AddCondition(); + IConditionalFormat format3 = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Set color. + format.BackColor = ExcelKnownColors.Red; + + //Set Condition. + format2.FirstFormula = "30"; + format2.SecondFormula = "70"; + format2.Operator = ExcelComparisonOperator.Between; + + //Set color. + format2.BackColor = ExcelKnownColors.Blue; + + //Set Condition. + format3.FirstFormula = "30"; + format3.SecondFormula = "50"; + format3.Operator = ExcelComparisonOperator.Between; + + //Set color. + format3.BackColor = ExcelKnownColors.Green; + + //Remove condition. + formats.RemoveAt(2); + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + + Gets the number of conditional formats in the collection. Read-only. + + + returns the number of conditions applied. Here for example, we check value + before and after applying three conditions. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + IConditionalFormat format2 = formats.AddCondition(); + IConditionalFormat format3 = formats.AddCondition(); + + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Set color. + format.BackColor = ExcelKnownColors.Red; + + format2.FirstFormula = "30"; + format2.SecondFormula = "70"; + format2.Operator = ExcelComparisonOperator.Between; + + //Set color. + format2.BackColor = ExcelKnownColors.Blue; + + format3.FirstFormula = "30"; + format3.SecondFormula = "50"; + format3.Operator = ExcelComparisonOperator.Between; + + //Set color. + format3.BackColor = ExcelKnownColors.Green; + + //Check Count. + Console.WriteLine(formats.Count); + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + //Output will be + //3 + + + + + + Gets a conditional format of the specified index from the collection. Read-only. + + + The following code illustrates how to access the first condition from . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + + //Add condition. + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. (Access the condition using index). + formats[0].FirstFormula = "60"; + formats[0].SecondFormula = "20"; + formats[0].Operator = ExcelComparisonOperator.Between; + + //Set color. + formats[0].BackColor = ExcelKnownColors.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Wrapped range object. + + + + + Wrapped conditional formats collection. + + + + + List with all wrapped conditions. + + + + + Indicates whether to get the conditional format or not. + + + + + To prevent creation without arguments. + + + + + Creates wrapper for the specified range object. + + Range to wrap conditional formats for. + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object. + + + + + Adds new condition to the collection. + + Newly added condition. + + + + Removes the Condtional Format at the specified range + + + + + Removes the Condtional Format at the Specified Index + + + + + Returns an enumerator that can iterate through a collection. + + An enumerator that can iterate through a collection + + + + Creates conditional formats for read-only mode. + + + + + Creates copy of the current conditional formats collection to enable writing. + + + + + Creates wrappers for all conditions. + + + + + Returns unwrapped condition. + + Condition index. + Unwrapped condition. + + + + Returns number of elements in the collection. Read-only. + + + + + Returns single element from the collection. Read-only. + + + + + Application object for this object. + + + + + Parent object for this object. + + + + + Returns collection of worksheets conditional formats of + the parent worksheet. Read-only. + + + + + Gets the Conditional Formats. + + + + + Gets the range object. + + + + + Collection of conditional formats for the single-cell range. + + + + + Maximum number of conditional formats in the collection. + + + + + Record that contains collection data. + + + + + + + Ranges operations. + + + + + Normal rule count. + + + + + Advanced conditional format rule count. + + + + + Total rule count. + + + + + Index of the rule. + + + + + Specifies the future record. + + + + + Checks whether conditional format is applied in pivot table. + + + + + Checks whether conditional format is copying or not. + + + + + Creates new instance. + + Base application. + Parent object. + + + + Creates new instance. + + Base application. + Parent object. + Collection to clone. + + + + Copy Conditional format. + + Base application. + Parent object. + Collection to clone. + boolean value to copy conditional format + + + + Creates ConditionalFormats collection from array of BiffRecords. + + Application object for the collection. + Parent object for the collection. + Main conditional format record. + Array of CFRecords with conditional formats. + + + + Creates ConditionalFormats collection from array of BiffRecords. + + Application object for the collection. + Parent object for the collection. + Main conditional format12 record. + Array of CF12Records with conditional formats. + + + + Finds parent worksheet. + + + + + Adds new condition to the collection. + + + + + + Removes the Condtional Format at the specified range + + + + + Removes the Condtional Format at the Specified Index + + + + + Adds condition from CFRecord. + + + + + Serializes collection data into OffsetArrayList. + + OffsetArrayList that will get all data. + + + + + + + + + + + Serializes normal conditional formats. + + + + + Serializes advanced conditional formats. + + + + + Adds condition from CFRecord. + + CFRecord that contains condition data. + + + + Adds condition from CF12Record. + + CF12Record that contains condition data. + + + + Adds condition from CFExRecord. + + CFRecord that contains condition data. + + + + Compares this collection to another. + + Collection to compare. + True if collections are equal. + + + + Compares two ConditionalFormats. + + First conditional format to compare. + Second conditional format to compare. + True if they are equal. + + + + Adds cells from the collection. + + Formats collection to get cells from. + + + + Adds cells from the collection. + + Formats collection to get cells from. + + + + Indicates whether collection contains all specified ranges. + + Ranges to check. + True if collection contains all specified ranges. + + + + Indicates whether collection contains intersect ranges. + + Ranges to check. + True if collection contains intersect ranges. + + + + Returns contains count for specified range. + + Range to check. + Contains count + + + + Adds cells from the collection. + + Cells to add to the collection. + + + + Adds range to the collection. + + Range to add. + + + + Adds new cell range to the collection. + + Range to add. + + + + Removes range from the collection of conditional formats. + + Array of ranges to remove. + + + + Removes range from the collection of conditional formats. + + Array of ranges to remove. + + + + Removes all cells from the collection. + + + + + Converts collection to Excel97to03 version (reduces collection capacity to maximum three conditions). + + + + + Creates ConditionaFormats collection containing part of conditional formats. + + Index of the first row to get. + Index of the first column to get. + Number of rows to get. + Number of columns to get. + Indicates whether we should remove original items from the collection. + This value should be added to row index of every CF region. + This value should be added to column index of every CF region. + New parent object. + Created CF collection. + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Updates conditional format formulas. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + Updates conditional format formulas. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + Represents workbook. + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Serves as a hash function for a particular type, suitable for use in + hashing algorithms and data structures like a hash table. + + A hash code for the current Object. + + + + A hash code for the current Object without taking cell list into account. + + The Object to compare with the current Object. + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + calculate and return the Range required in range address format + + boolean value indicate the first cell or enclosing range address required + the Range string required in range address format + + + + Get worksheet. Read only. + + + + + Returns maximum conditional formats number. Depends on current Excel version. + + + + + Indicates whether collection is empty. Read-only. + + + + + Checks whether conditional format is applied in pivot table. + + + + + Checks whether conditional format is copying or not. + + + + + Represents address of cf ranges. + + + + + Represents address of cf ranges in R1C1 notation. + + + + + Cell range address of the range enclosing all + conditionally formatted ranges. + + + + + return all rectanglecellslist for this CF + + + + + Returns all string ranges for this CF. + + + + + Gets list of rectangles describing cells with conditional formatting. + + + + + CondFMT record. + + + + + CondFMT record. + + + + + Specify whether the record is future record. + + + + + Summary description for CustomDocumentProperties. + + + + + Summary description for ICustomDocumentProperties. + + + + + Removes specified object from the collection. + + Property name. + + + + Checks whether collection contains property with specified name. + + Name to check. + True if property is contained by collection; false otherwise. + + + + Removes all elements from the collection. + + + + + Returns single entry from the collection. Creates new entry + if property with specified name is not found. Read-only. + + + + + Returns single entry from the collection. Read-only. + + + + + Returns number of elements in the collection. Read-only. + + + + + Custom guid string. + + + + + Guid used for parsing/serialization of custom properties. + + + + + Dictionary with document properties, key - property name/id, value - property value. + + + + + Default constructor. + + + + + Returns custom property by name. + + Custom property. + Custom property. + + + + Removes specified object from the collection. + + Property name. + + + + Adds element to the collection. + + Property name to add. + Newly created property. + + + + Checks whether collection contains property with specified name. + + Name to check. + True if property is contained by collection; false otherwise. + + + + Serializes built-in properties. + + IPropertySetStorage to serialize into. + + + + Serializes built-in properties. + + IPropertySetStorage to serialize into. + + + + Extract built-in document properties. + + IPropertySetStorage to extract properties from. + + + + Extract custom document properties. + + Collection to extract properties from. + + + + OnClear is invoked after Clear behavior. + + + + + Returns single entry from the collection. Read-only. + + + + + Returns single entry from the collection. Read-only. + + + + + Incapsulates one DValRecord and multiple DVRecords from xls file. + + + + + Single DValRecord from data validation block. + + + + + Parent data validation table. + + + + + Key - DVRecord, value - corresponding DataValidationImpl. + + + + + Represents array list that storage dv data. + + + + + Indicates is delay parsing. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Searches and sets all necessary parents. + + + + + Adds data validation to the collection. + Checks if same data validation exists in the collection, + updates and returns it (if found). + + Data validation to add. + Data validation that was added or that was updated. + + + + Saves collection into list of BiffRecords. + + OffsetArrayList with BiffRecords. + + If records parameter is NULL. + + + + + Creates collection from array. + + Array of Biff records. + Start offset in the array (will be updated after parsing). + Indicates is parse on create or delay for first usage. + + + + + + + + + + + + + + + + Clones current instance. + + Parent object. + Returns new object. + + + + Returns data validation for specified cell. + + Cell index. + Data validation for specified cell. + + + + Updates indexes to named ranges. + + New indexes. + + + + Updates indexes to named ranges. + + New indexes. + + + + Adds new DVRecord to the collection. + + DVRecord to add. + + If dv is NULL. + + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Updates collection. + + Array of Biff records. + Start offset in the array (will be updated after parsing). + Represents count of records in collection. + + + + Adds local data validation record. + + Represents record to add. + Returns new instance of data validation. + + + + Returns data validation records. + + + + + + + + + + + + + + + + + + + + + + + + + Parent workbook. + + + + + Parent worksheet. + + + + + Gets parent table. Read-only. + + + + + Gets DValRecord representing this collection. Read-only. + + + + + Returns single entry from the collection. Read-only. + + + + + Gets number of required shapes objects. + + + + + Key - DVRecord, value - corresponding DataValidationImpl. + + + + + Table of all data validation in the worksheet. + + + + + Parent worksheet. + + + + + Dictionary, key - DValRecord, value - DataValidationCollection. + + + + + Creates DataValidationTable. + + Application object for the collection. + Parent object for the collection. + + + + Creates DataValidationTable. + + Application object for the collection. + Parent object for the collection. + List with data validation records. + Offset to the first data validation record. + + + + Searches for all necessary parents. + + + + + Extracts data validation table from array of records. + + List with data validation records. + Offset to the first data validation record. + + + + Adds new data validation collection. + + Collection to add. + Newly added data validation collection + + + + Adds new data validation to the collection. + + DValRecord to add. + Newly added data validation collection. + + + + Clones current instance. + + Parent object. + Returns clone of current object. + + + + Searches for corresponding data validation. + + Cell index. + Found data validation or null. + + + + Searches for corresponding data validation. + + One-based row index. + One-based column index. + Found data validation or null. + + + + Updates indexes to named ranges. + + New indexes. + + + + Updates indexes to named ranges. + + New indexes. + + + + Removes specified rectangles from the collection. + + Rectangles to remove. + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Gets first Key value pair + + + + + + + Clears all the content. + + + + + Gets parent worksheet. Read-only. + + + + + Gets parent workbook. Read-only. + + + + + Returns single entry from the collection. Read-only. + + + + + Gets number of required shapes objects. + + + + + Summary description for ErrorIndicatorsCollection. + + + + + Dictionary with error indicators. Used to check whether indicator is unique. + + + + + Initializes new instance of the collection. + + Application object for the new collection. + Parent object for the new collection. + + + + Adds new item to collection. + + Error indicator to add. + Added error indicator. + + + + Searches for error indicator that contains all specified ranges. + + Ranges to find error indicator for. + Error indicator if found, else null. + + + + Removes specified range from collection. + + Range to remove. + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Get errorIndicator in collection of worksheet errorIndicators + + Rectangle of the source row and column + return errorIndicator from errorIndicator collection + + + + Represents collection of all extended formats in the workbook. + + + + + Number of default extended formats. + + + + + Dictionary with all formats in the collection. + Key - ExtendedFormatImpl, value - same format. + + + + + Creates collection and sets its Application and Parent values. + + + Application object that represents the Excel application. + + Parent object of this collection. + + + + Adds format into collection. + + Format to add. + + If there is same format in the collection, this method will return it; + otherwise format that was passed as argument will be added. + + + + + Adds format into collection. + + Format to add. + The count is repersent the named style index count + + If there is same format in the collection, this method will return it; + otherwise format that was passed as argument will be added. + + + + + Adds format into collection. + + Format to add. + Format that was added. + + + + Imports single extended format to the collection. + + Format to import. + + Dictionary with new xf indexes, key - old xf index, value - new xf index. + + Index of the new format. + + + + Merges extended formats collection with formats from another collection. + + Collection to get formats from. + Container for new font indexes. + Dictionary with new indexes. + + + + Adds extended formats to the collection. + + Formats to add. + Dictionary with new indexes. + + + + Adds index to the collection. + + Dictionary to add index to. + List with extended formats. + Index to add. + + + + Gather two formats borders. + + First xf indexes to gathered. + End xf indexes to gathered. + Returns gathered two extended formats.. + + + + Removes item at the specified position. + + Item to remove. + + Dictionary with new xf indexes. + key - old index + value - new index. + Only those formats that had parent index set + to xfIndex will be placed in this dictionary. + + + + + Creates copy of the current instance. + + Parent object for the new collection. + Copy of the current instance. + + + + Sets maximum possible count of extended formats in the collections. + Updates ParentIndex and overall number of extended formats if necessary. + + New value of maximum possible extended formats. + + + + + + + + + + + Adds copy of the format to the collection. + + Formats to add. + Updated font indexes. + Dictionary with new format indexes. + Dictionary with new indexes. + + + + Adds copy of the format to the collection. + + Format to add. + Dictionary with new format indexes. + Updated font indexes, key - old index, value - new index. + Dictionary with new format indexes. + + + + Marks the used extended cell styles and their formats in the workbook. + + All the extended formats in the workbook. + The workbook which is to be processed. + + + + Returns array with new font indexes used by specified extended formats. + + List with used extended formats. + Updated font indexes, key - old font index, value - new font index. + + + + Returns hashtable with new format indexes used by specified extended formats. + + List with used extended formats. + Dictionary with new format indexes, key - old format index, value - new format index. + + + + OnClear is invoked after Clear behavior. + + + + + Returns single entry from the collection. Read-only. + + + + + Returns parent workbook object. Read-only. + + + + + Collection of external workbooks in the worksheet. + + + + + Default options of StdDocumnt extern name. + + + + + Sheet index for non-existing sheet. + + + + + This URL is written by MS Excel 2003 when referenced file is closed before saving workbook. + + + + + Parent workbook. + + + + + Dictionary key - extern workbook url, value - corresponding extern workbook. + + + + + Dictionary key - short name of the workbook, value - workbook. + + + + + Creates collection with specified Application and Parent. + + Application object for the collection. + Parent object for the collection. + + + + Parses array of biff records. + + Array to parse. + Offset to collection data. + Offset value after parsing all workbooks. + + + + Extracts extern workbooks from the BiffReader. + + Reader to extract records from. + Object used to decrypt encrypted records. + + + + Serializes collection of external workbooks as biff records. + + OffsetArrayList to serialize into. + + + + Adds workbook into collection. + + Book to add. + Index of the new workbook. + + + + Adds new workbook into collection + + Workbook to add. + Index of the new workbook. + + + + Adds new workbook into collection + + Workbook to add. + Index of the new workbook. + + + + + + + + + + + + + + Adds new workbook into collection + + Workbook to add. + Index of the new workbook. + + + + Inserts SupbookRecord describing this workbook. + + + Index to the SupBookRecord that describes current workbook. + + + + + Checks whether any of books in this collection contains extern name. + + Name to search. + True if name was found; false otherwise. + + + + Checks whether any of books in this collection contains extern name. + + Name to search. + Output extern workbook index. + Output name index. + True if name was found; false otherwise. + + + + Returns index of the extern name. + + Name to search. + Reference index. + Returns index to extern workbook containing required name. + + + + Returns extern workbook with specified short name. + + Short name to find. + + Extern workbook that corresponds to the specified short name; + or Null if there isn't such workbook. + + + + + Sets all necessary parent objects. + + + + + Returns first index of current book in collection. + + Returns first index of current book in collection. + + + + + + + + + + + Copies subbook collection. + + Represents parent subbook collection. + Returns sub book indexes hash. Key - old indexes; Value - new indexes. + + + + Tries to find corresponding workbook or creates new if not found. + + Name of the workbook file. + Path to the workbook. + Found or created extern workbook. + + + + Frees all allocated unmanaged resources. + + + + + Checks whether this collection contains the external workbook. + + External workbook to search. + True if the external workbook was found; false otherwise. + + + + Returns the index of the external workbook from this collection. + + External workbook to search. + Index of the external workbook. + + + + Returns single extern workbook from the collection. + + + + + Returns single extern workbook from the collection. + + + + + Returns parent workbook. Read-only. + + + + + Summary description for ExternNamesCollection. + + + + + Parent extern workbook. + + + + + Hash table with all names. + + + + + Sometimes different applications (not MS Excel) can create duplicated + extern names, we have to remember all of them and after parsing remove it. + + + + + Creates collection with specified Application and Parent. + + Application object for the collection. + Parent object for the collection. + + + + Searches for all necessary parents. + + + + + Adds new name to the collection. + + Name to add. + Index of added extern name. + + + + Adds new name to the collection. + + Name to add. + Index of added extern name. + + + + Adds new name to the collection. + + Name to add. + Index of added extern name. + + + + Checks if collection contains extern name with specified name. + + Name to find. + Boolean value indicating whether collection contains extern name. + + + + + + + + + + Return index to the extern name. + + Name to locate. + Index to the extern name, or -1 if name was not found. + + + + Get new index for extern name (to remove duplicated extern names). + + Name index. + Updated name index. + + + + Creates copy of the collection. + + Parent object for the new collection. + + + + + Adds new item to the collection. + + Name to add. + Index of the added item. + + + + + + + + + + + + + + + + + + Returns extern name. Read-only. + + + + + Returns extern name. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + Summary description for FontsCollection. + + + + + Parent workbook. + + + + + + + + + + Creates collection with specified Application and Parent. + + Application object for the collection. + Parent object for the collection. + + + + Parses font record and adds new font to the collection. + + Font record to parse. + Added font. + + + + Adds font to collection. + + Font to add. + Added font. + + + + Inserts default fonts into collection. + + + + + Searches for all necessary parents. + + + + + Forces add to the collection even if same font is already in the collection. + + Font to add. + + + + Saves fonts collection as a set of biff records. + + OffssetArrayList that will receive biff records. + + + + Indicates whether such font is in collection. + + Font to search. + True if such font is present in the collection, false otherwise. + + + + Merges fonts with fonts from another fonts collection. + + Fonts collection to merge fonts from.. + Dictionary with updated indexes. + + + + Adds fonts range from other fonts collection. + + Collection with font indexes to add. + Collection with fonts to add. + Dictionary with updated fonts indexes: key - old font index, value - new font index. + + + + Adds copy of the font. + + Font to copy. + Index of the new font. + + + + OnClear is invoked after Clear behavior. + + + + + Creates copy of the fonts collection. + + Parent workbook for the new collection. + Copy of this collection. + + + + Returns single font from collection. + + + + + Represents collection of formats in the workbook. + + + + + Represents the Decimal Seprator. + + + + + Represents the Thousand seprator. + + + + + Represents the percentage in decimal numbers. + + + + + Represents the fraction symbol. + + + + + Represents the index of the date format. + + + + + Represents the time separator. + + + + + Represents the Exponenet Symbol. + + + + + Represents the Minus symbol. + + + + + Represents the Currency Symbol. + TODO: support currency based on the Culture. + + + + + Represents the default exponential. + + + + + Index to the first user-defined number format. + + + + + Japan code. + + + + + Maximum number formats count in a workbook. 36 Default + 206 Custom formats. + + + + + Represents the collection of DateFormats. + + + + + Default format strings. + + + + + Default currency format strings. + + + + + Default currency format . + + + + + Index-to-FormatImpl. + + + + + Dictionary. Key - format string, value - FormatImpl. + + + + + Format parser. + + + + + Represent the indexes of the Raw Formats. + + + + + Number Formats Taken. + + + + + Dictionary. Key - currency symbol , value - currency format string. + + + + + Initializes new instance and sets its application and parent objects. + + Application object to set. + Parent object to set. + + + + Parses list of biff records. + + Records to parse. + Offset to the format records. + Position after format records. + + + + Saves formats into list of biff records. + + List to save into. + + + + Adds new format to the collection. + + Format to add. + + + + + + + + + + + + + + + + + Creates copy of the current instance. + + Parent object for the new collection. + Copy of the current instance. + + + + Method that creates format object based on the format string + and registers it in the workbook. + + Format string for the new format record. + Index of created format. + + + + Gets customized datetime format string of user input format string, inaccordance with MS Excel behaviour + + + + + + + Indicate whether given number format as data time or not. + + current index of the separator to be checked + the source character array + True if number format is string, otherwise false + + + + Gets the formatted string (IE replace the month and date token into lower case and left the string token) + + Number formats string. + Replaced lower case string. + + + + Replace the upper case formats into lower case formats for year, month, day, hour, minutes, seconds as per MS Excel behavior. + + Number formats string. + Replaced lower case string. + + + + Determines whether the IDictionary contains an element with the specified format. + + Format to locate in the collection. + True if the collection contains an element with the key; otherwise, False. + + + + Searches for format with specified format string + and creates one if a match is not found. + + String describing needed format. + Found or created format. + + + + Inserts all default formats into list. + + + + + Gets all used formats. + + Array that contains all used format records. + + + + Copies all formats from the source collection. + + Collection to copy formats from. + Dictionary old format index - to - new format index. + + + + Adds format range to the collection. + + Dictionary with format indexes to add. + Source collection. + Dictionary with updated indexes: key - old index, value - new index. + + + + Tries to add format to the collection. + + Format to add. + New format index. + + + + Tries to add format to the collection. + + Format to add. + New format index. + + + + + + Fills the format indexes based on the format types. + + + + + Detects the DateFormat from the string. + + string value to detect. + NumberFormat of the given string. + + + + Detects the Time Format from the string. + + string to detect the format. + Number Format of the given string. + + + + Returns True, if strValue contains the time format with seconds. + + Time format in string. + boolean value + + + + Returns True, if the string format of time contains 12 Hours format. + + Time format in string. + returns boolean. + + + + Detects the Number format. + + number as string to detect the number format. + Number Format of given value. + + + + Try parse the number format of the given value. + + number as string to parse. + NumberFormat of the given value. + + + + Check whether the separator character is in between the date format symbols + + current index of the separator to be checked + the source character array + retuns true if the format is correct, otherwise not + + + + Returns an IDictionaryEnumerator for the IDictionary. + + An IDictionaryEnumerator for the IDictionary. + + + + Removes the element with the specified key from the IDictionary. + + The key of the element to remove. + + + + Determines whether the IDictionary contains an element with the specified key. + + The key to locate in the IDictionary. + True if the IDictionary contains an element with the key; otherwise, False. + + + + Removes all elements from the IDictionary. + + + + + Copies the elements of the collection to an Array, starting at a particular Array index. + + + The one-dimensional Array that is the destination of the elements + copied from ICollection. The Array must have zero-based indexing. + + The zero-based index in array at which copying begins. + + + + Returns single entry from the collection. Read-only. + + + + + Gets or Sets a value indicating whether worksheet contains number formats. + + + + + Returns single entry from the collection by format string. Read-only. + + + + + Returns format parser. Read-only. + + + + + Gets currency format string. Read-only. + + + + + Gets a value indicating whether the IDictionary is read-only. Read-only. + + + + + + + + + + Gets an ICollection containing the keys of the collection. Read-only. + + + + + Gets a value indicating whether the collection has a fixed size. Read-only. + + + + + Gets a value indicating whether access to the collection is synchronized (thread-safe). + + + + + Gets the number of elements contained in the collection. Read-only + + + + + Gets an object that can be used to synchronize access to the collection. + + + + + Summary description for BorderGroup. + + + + + Border index. + + + + + Parent style group. + + + + + Creates new instance of the group. + + Application object for the new group. + Parent object for the new group. + Border index. + + + + Searches for all necessary parent objects. + + + + + Returns single entry from the group. Read-only. + + + + + Returns number of elements in the group. Read-only. + + + + + Returns or sets the primary color of the object. + Read/write Long. + + + + + Returns or sets the primary color of the object. + Read/write Long. + + + + + Returns color of the border. + + + + + Returns or sets the line style for the border. Read/write ExcelLineStyle. + + + + + This property is used only by Diagonal borders. For any other border + index property will have no influence. + + + + + Summary description for BordersGroup. + + + + + Parent style group. + + + + + Creates new instance of the group. + + Application object for the new group. + Parent object for the new group. + + + + Searches for all necessary parent objects. + + + + + Returns single entry from the group. Read-only. + + + + + Returns number of elements in the group. Read-only. + + + + + Returns or sets the primary color of the object. + Read / write ExcelKnownColors. + + + + + Returns or sets the primary color of the object, as shown in the + following table. Use the RGB function to create a color value. + Read / write Color. + + + + + Returns the number of objects in the collection. Read-only, Long. + + + + + Returns a Border object that represents one of the borders of either a + range of cells or a style. + + + + + Returns or sets the line style for the border. Read / write ExcelLineStyle. + + + + + Synonym for Borders.LineStyle. Read / write. + + + + + Summary description for ConditionalFormatsGroup. + + + + + Parent range group. + + + + + Creates new instance of the group. + + Application object for the new group. + Parent object for the new group. + + + + Searches for all necessary parent objects. + + + + + Synchronizes all collections. + + + + + Adds new condition to the collection. + + Newly added condition. + + + + Removes the Condtional Format at the specified range + + + + + Removes the Condtional Format at the Specified Index + + + + + Returns an enumerator that can iterate through a collection. + + An IEnumerator that can iterate through the collection. + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Returns single entry from the group. Read-only. + + + + + Returns number of elements in the group. Read-only. + + + + + Returns number of elements in the collection. Read-only. + + + + + Returns single element from the collection. Read-only. + + + + + Summary description for FontGroup. + + + + + Parent range group. + + + + + Creates new instance of the group. + + Application object for the new group. + Parent object for the new group. + + + + Searches for all necessary parent objects. + + + + + Generates .Net font object corresponding to the current font. + + Generated .Net font. + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Returns single entry from the group. Read-only. + + + + + Returns number of elements in the group. Read-only. + + + + + True if the font is bold. Read / write Boolean. + + + + + Returns or sets the primary color of the object. Read / write ExcelKnownColors. + + + + + Gets / sets font color. Searches for the closest color in + the workbook palette. + + + + + True if the font style is italic. Read / write Boolean. + + + + + True if the font is an outline font. Read / write Boolean. + + + + + True if the font is a shadow font or if the object has + a shadow. Read / write Boolean. + + + + + Returns or sets the size of the font. Read / write Variant. + + + + + True if the font is struck through with a horizontal line. + Read / write Boolean + + + + + True if the font is formatted as subscript. + False by default. Read / write Boolean. + + + + + True if the font is formatted as superscript. False by default. + Read/write Boolean + + + + + Returns or sets the type of underline applied to the font. Can + be one of the following ExcelUnderlineStyle constants. + Read / write ExcelUnderline. + + + + + Returns or sets the font name. Read / write string. + + + + + Gets / sets font vertical alignment. + + + + + Indicates whether color is automatically selected. Read-only. + + + + + Summary description for MigrantRangeGroup. + + + + + Summary description for RangeGroup. + + + + + First row. + + + + + First column. + + + + + Last row. + + + + + Last column. + + + + + Parent group of worksheets. + + + + + Rich text string group. + + + + + Value of End property. + + + + + Style group. + + + + + Creates new instance of the group. + + Application object for the new group. + Parent object for the new group. + + + + Creates new instance of the group. + + Application object for the new group. + Parent object for the new group. + The first row of the range. + The first column of the range. + + + + Creates new instance of the group. + + Application object for the new group. + Parent object for the new group. + The first row of the range. + The first column of the range. + The last row of the range. + The last column of the range. + + + + Creates new instance of the group. + + Application object for the new group. + Parent object for the new group. + String representation of the range. + + + + Creates new instance of the group. + + Application object for the new group. + Parent object for the new group. + String representation of the range. + Indicates is name in R1C1 notation. + + + + Searches for all necessary parent objects. + + + + + Returns range for specific sheet. + + Sheet index in the group. + + + + + Returns a Range object that represents a range thats offset from the specified range. + + The number of rows (positive, negative, or 0 (zero)) by which the range is to be offset + The number of columns (positive, negative, or 0 (zero)) by which the range is to be offset + + + + + Resizes the specified range + + The number of rows in new range + The number of columns in new range + + + + + Activates a single cell, which must be inside the current selection. + To select a range of cells, use the Select method. + + + + + + Activates a single cell, scroll to it and activates the corresponding sheet. + To select a range of cells, use the Select method. + + True to scroll to the cell + + + + + This method groups current range. + + + This parameter specifies whether the grouping should be performed by rows or by columns. + + Current range after grouping. + + + + This method groups current range. + + + This parameter specifies whether grouping should + be performed by rows or by columns. + + Indicates whether group should be collapsed. + Current range after grouping. + + + + Creates Subtotal for the corresponding ranges + + GroupBy + ConsolidationFunction + TotalList + + + + Creates SubTotal for the corresponding Ranges + + GroupByGroupBy + ConsolidationFunction + TotalList + Replace exisiting SubTotal + Insert PageBreaks + SummaryBelowData + + + + Creates SubTotal for the corresponding Ranges + + Columns to GroupBy + ConsolidationFunction + TotalList + Replace exisiting SubTotal + Insert PageBreaks + SummaryBelowData + + + + Returns sum of numeric cells in the range. + + + + + Returns sum of numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + + + Returns average of numeric cells in the range. + + + + + Returns average of numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + + + Returns minumum value from numeric cells in the range. + + + + + Returns minumum value from numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + + + Returns maximum value from numeric cells in the range. + + + + + Returns maximum value from numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + + + Trim the empty rows at top and bottom of the range, the empty columns at left and right of the range. + + Returns the range after trim. + + + + Creates a merged cell from the specified Range object. + + + + + Creates a merged cell from the specified Range object. + + Indicates whether to clear unnecessary cells. + + + + Ungroups current range. + + Indicates type of ungrouping. Ungroup by columns or by rows. + Current range after ungrouping. + + + + Separates a merged area into individual cells. + + + + + Freezes pane at the current range. + + + + + Clear the contents of the Range. + + + + + Clear the contents of the Range with formatting. + + True if formatting should also be cleared. + + + + Clear the contents of the Range and shifts the cells Up or Left + without formula or merged ranges update. + + Cells shift direction Up/Left. + + + + Clears the contents, formats and comments of the cell, based on clear options. + + + + + + Clear the contents of the Range and shifts the cells Up or Left. + + Cells shift direction Up/Left. + Cells shifting options. + + + + Moves the cells to the specified Range (without updating formulas). + + Destination Range. + + + + Moves the cells to the specified Range. + + Destination Range + Indicates whether to update formula after move operation. + + + + Copies the range to the specified destination Range (without updating formulas). + + Destination range. + Range were this range was copied. + + + + Copies this range into another location. + + Destination range. + Indicates whether update formula during copy. + + + + Copies this range into another location. + + Destination range. + Copy range options. + Destination range. + + + + Copies the Range to the specified destination Range with copy options and skip blank option. + + Represents the destination Range to copy. + Represents the copy Range options. + Represents the skip blank cells in the source. + Returns the copied Range. + + + + Returns intersection of this range with the specified one. + + The Range with which to intersect. + Range intersection; if there is no intersection, NULL is returned. + + + + Returns merge of this range with the specified one. + + The Range to merge with. + Merged ranges or NULL if wasn't able to merge ranges. + + + + Autofits all rows in the range. + + + + + Autofits all columns in the range. + + + + + Adds comment to the range. + + Range's comment. + + + + Creates a threaded comment for the current cell with the specified text. + + Threaded comment text + Optional. The creation time of the threaded comment + Returns the created instance of . + + + + Creates a threaded comment for the current cell with the specified text and author. + + Threaded comment text + The author of the threaded comment text + Optional. The creation time of the threaded comment + Returns the created instance of . + + + + This method searches for the first cell with specified string value. + + Value to search. + Flag that represent type of search. + + + + + This method searches for the first cell with specified double value. + + Value to search. + Flag that represent type of search. + First found cell, or Null if value was not found. + + + + This method searches for the first cell with specified bool value. + + Value to search. + First found cell, or Null if value was not found. + + + + This method searches for the first cell with specified DateTime value. + + Value to search. + First found cell, or Null if value was not found. + + + + This method searches for the first cell with specified TimeSpan value. + + Value to search. + First found cell, or Null if value was not found. + + + + This method searches for the all cells with specified string value. + + Value to search. + Flag that represent type of search. + All found cells, or Null if value was not found. + + + + This method searches for the all cells with specified double value. + + Value to search. + Flag that represent type of search. + All found cells, or Null if value was not found. + + + + This method searches for the all cells with specified bool value. + + Value to search. + All found cells, or Null if value was not found. + + + + This method searches for the all cells with specified DateTime value. + + Value to search. + All found cells, or Null if value was not found. + + + + This method searches for the all cells with specified TimeSpan value. + + Value to search. + All found cells, or Null if value was not found. + + + + Replaces the string with the specified string value. + + The string to be replaced. + The string to replace all occurrences of oldValue. + + + + Replaces the string with the specified string value based on the given . + + The string to be replaced. + The string to replace all occurrences of oldValue. + Specifies the find options for the oldValue. + + + + Replaces the string with the specified double value. + + The string to be replaced. + The double value to replace all occurrences of oldValue. + + + + Replaces the string with the specified DateTime value. + + The string to be replaced. + The datetime value to replace all occurrences of oldValue. + + + + Replaces the string with the specified array of string values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces the string with the specified array of int values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces the string with the specified array of double values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces the string with the specified datatable. + + The string to be replaced. + Data table with new data. + Indicates whether field name must be shown. + + + + Replaces the string with the specified datacolumn. + + The string to be replaced. + DataColumn with new data. + Indicates whether field name must be shown. + + + + Copies range to the clipboard. + + + + + Sets around border for current range. + + + + + Sets around border for current range. + + Represents border line. + + + + Sets around border for current range. + + Represents border line. + Represents border color. + + + + Sets around border for current range. + + Represents border line. + Represents border color as ExcelKnownColors. + + + + Sets inside border for current range. + + + + + Sets inside border for current range. + + Represents border line. + + + + Sets inside border for current range. + + Represents border line. + Represents border color. + + + + Sets inside border for current range. + + Represents border line. + Represents border color as ExcelKnownColors. + + + + Sets none border for current range. + + + + + Collapses current group. + + + This parameter specifies whether the grouping should be performed by rows or by columns. + + + + + Expands current group. + + + This parameter specifies whether the grouping should be performed by rows or by columns. + + + + + Expands current group. + + + This parameter specifies whether the grouping should be performed by rows or by columns. + + Additional option flags. + + + + Gets the dependent cells which refer to other cells. + + Returns the dependent cells or null if value was not found. + + + + Gets the dependent cells which refer to other cells. + + Indicates whether to check from other worksheets. + Returns the dependent cells with a specified bool value or null if value was not found. + + + + Gets the precedent cells which are referred by a formula in another cell. + + Returns the precedent cells or null if value was not found. + + + + Gets the precedent cells which are referred by a formula in another cell. + + Indicates whether to check from other worksheets. + Returns the precedent cells with a specified bool value or null if value was not found. + + + + Gets the direct dependent cells which refer to other cells. + + Returns the direct dependent cells or null if value was not found. + + + + Gets the direct dependent cells which refer to other cells. + + Indicates whether to check from other worksheets. + Returns the direct dependent cells with a specified bool value or null if value was not found. + + + + Gets the direct precedent cells which are referred by a formula in another cell. + + Returns the direct precedent cells or null if value was not found. + + + + Gets the direct precedent cells which are referred by a formula in another cell. + + Indicates whether to check from other worksheets. + Returns the direct precedent cells with a specified bool value or null if value was not found. + + + + Returns an enumerator that iterates through the Range. + + + + + + Returns number of ranges in the group. Read-only. + + + + + Returns range from the specified worksheet in the range. Read-only. + + + + + Returns parent workbook object. Read-only. + + + + + Gets or sets HTML string. + + + + + Returns hyperlinks for this range group. + + + + + Returns the range reference in the language of the macro. + Read-only String. + + + + + Returns the range reference for the specified range in the language + of the user. Read-only String. + + + + + Returns range Address in format "'Sheet1'!$A$1". + + + + + Returns the range reference using R1C1 notation. + Read-only String. + + + + + Returns the range reference using R1C1 notation. + Read-only String. + + + + + Gets / sets boolean value that is contained by this range. + + + + + Returns a Borders collection that represents the borders of a style + or a range of cells (including a range defined as part of a + conditional format). + + + + + Returns a Range object that represents the cells in the specified range. + Read-only. + + + + + Returns the number of the first column in the first area in the specified + range. Read-only. + + + + + Column group level. Read-only. + -1 - Not all columns in the range have same group level. + 0 - No grouping, + 1 - 7 - Group level. + + + + + Returns or sets the width of all columns in the specified range. + Read/write Double. + + + + + Returns the number of objects in the collection. Read-only. + + + + + Gets / sets DateTime contained by this cell. Read-write DateTime. + + + + + Returns cell value after number format application. Read-only. + + + + + Returns a Range object that represents the cell at the end of the + region that contains the source range. + + + + + Returns a Range object that represents the entire column (or + columns) that contains the specified range. Read-only. + + + + + Returns a Range object that represents the entire row (or + rows) that contains the specified range. Read-only. + + + + + Gets / sets error value that is contained by this range. + + + + + Returns or sets the object's formula in A1-style notation and in + the language of the macro. Read/write Variant. + + + + + Returns or sets the object's formula in R1C1-style notation and in + the language of the macro. Read/write Variant. + + + + + Represents array-entered formula. + + + + + Returns or sets the object's formula in R1C1-style notation and in + the language of the macro. Read/write Variant. + + + + + True if the formula will be hidden when the worksheet is protected. + False if at least part of formula in the range is not hidden. + + + + + Get / set formula DateTime value contained by this cell. + DateTime.MinValue if not all cells of the range have same DateTime value. + + + + + Indicates whether specified range object has data validation. + If Range is not single cell, then returns true only if all cells have data validation. Read-only. + + + + + Indicates whether range contains bool value. Read-only. + + + + + Indicates whether range contains DateTime value. Read-only. + + + + + Indicates if current range has formula bool value. Read-only. + + + + + Indicates if current range has formula error value. Read-only. + + + + + Indicates if current range has formula value formatted as DateTime. Read-only. + + + + + Indicates if the current range has formula number value. Read-only. + + + + + Indicates if the current range has formula string value. Read-only. + + + + + True if all cells in the range contain formulas; False if + at least one of the cells in the range doesn't contain a formula. + Read-only Boolean. + + + + + Indicates whether range contains array-entered formula. Read-only. + + + + + Indicates whether the range contains number. Read-only. + + + + + Indicates whether cell contains formatted rich text string. + + + + + Indicates whether the range contains String. Read-only. + + + + + Indicates whether range has default style. False means default style. + Read-only. + + + + + Returns or sets the horizontal alignment for the specified object. + Read/write ExcelHAlign. + + + + + Returns or sets the indent level for the cell or range. Can be an integer + from 0 to 15 for Excel 97-2003 and 250 for Excel 2007. Read/write Integer. + + + + + Indicates whether the range is blank. Read-only. + + + + + Indicates whether range contains boolean value. Read-only. + + + + + Indicates whether range contains error value. + + + + + Indicates whether this range is grouped by column. Read-only. + + + + + Indicates whether this range is grouped by row. Read-only. + + + + + Indicates whether cell is initialized. Read-only. + + + + + Returns last column of the range. Read-only. + + + + + Returns last row of the range. Read-only. + + + + + Gets / sets double value of the range. + + + + + Format of current cell. Analog of Style.NumberFormat property. + + + + + Returns the number of the first row of the first area in + the range. Read-only Long. + + + + + Row group level. Read-only. + -1 - Not all rows in the range have same group level. + 0 - No grouping, + 1 - 7 - Group level. + + + + + Returns the height of all the rows in the range specified, + measured in points. Returns Double.MinValue if the rows in the specified range + aren't all the same height. Read / write Double. + + + + + For a Range object, returns an array of Range objects that represent the + rows in the specified range. + + + + + For a Range object, returns an array of Range objects that represent the + columns in the specified range. + + + + + Returns a Style object that represents the style of the specified + range. Read/write IStyle. + + + + + Returns name of the Style object that represents the style of the specified + range. Read/write String. + + + + + Gets / sets string value of the range. + + + + + Gets / sets time value of the range. + + + + + Returns or sets the value of the specified range. + Read/write Variant. + + + + + Returns the calculated value of a formula using the most current inputs. + + + + + Returns or sets the cell value. Read/write Variant. + The only difference between this property and the Value property is + that the Value2 property doesn't use the Currency and Date data types. + + + + + Returns or sets the vertical alignment of the specified object. + Read/write ExcelVAlign. + + + + + Returns a Worksheet object that represents the worksheet + containing the specified range. Read-only. + + + + + Gets / sets cell by row and column index. Row and column indexes are one-based. + + + + + Get cell range. Row and column indexes are one-based. Read-only. + + + + + Get cell range. Read-only. + + + + + Get cell range. Read-only. + + + + + Collection of conditional formats. + + + + + Data validation for the range. + + + + + Gets / sets string value evaluated by formula. + + + + + Gets / sets number value evaluated by formula. + + + + + Gets / sets number value evaluated by formula. + + + + + Returns the calculated value of the formula as a string. + + + + + Comment assigned to the range. Read-only. + + + + + Get the threaded comment. + + + + + String with rich text formatting. Read-only. + + + + + Indicates whether this range is part of merged range. Read-only. + + + + + Returns a Range object that represents the merged range containing + the specified cell. If the specified cell isn't in a merged range, + this property returns NULL. Read-only. + + + + + True if Microsoft Excel wraps the text in the object. + Read/write Boolean. + + + + + Indicates is current range has external formula. Read-only. + + + + + Represents ignore error options. If not single cell returs concatenateed flags. + + + + + Indicates whether all values in the range are preserved as strings. + + + + + Gets/sets built in style. + + + + + Represents range object for the single cell. Coordinates of such object can be changed. + There should be only one such object for single worksheet. + + + + + Resets row and column values. + + One-based row index of the new cell address. + One-based column index of the new cell address. + + + + Assigns integer value to the Merged region. + + Value to be assigned + + + + Assigns double value to the Merged region. + + Value to be assigned + + + + Assigns DateTime value to the Merged region. + + Value to be assigned + + + + Assigns bool value to the Merged region. + + Value to be assigned + + + + Assigns string value to the Merged region. + + Value to be assigned + + + + Returns a Range object that represents a range thats offset from the specified range. + + The number of rows (positive, negative, or 0 (zero)) by which the range is to be offset + The number of columns (positive, negative, or 0 (zero)) by which the range is to be offset + + + + + Resizes the specified range. + + The number of rows in new range + The number of columns in new range + + + + + Returns an enumerator that iterates through the Range. + + + + + + Initializes new instance of the object. + + Application object for the new object. + Parent object for the new object. + + + + Resets row and column values. + + One-based row index of the new cell address. + One-based column index of the new cell address. + + + + Set integer value + + + + + + Set double value + + + + + + Set date time value + + + + + + Set boolean value + + + + + + Set string value + + + + + + Summary description for PageSetupGroup. + + + + + Represents the page setup description. The PageSetup object + contains all page setup attributes (left margin, bottom margin, + paper size, and so on) as properties. + + + + + Returns or sets the height of the pages that the worksheet will be scaled + to when it is printed. Applies only to worksheets. Read/write Boolean. + + + To know more about page setting refer this link. + + The following code illustrates how to fit all rows on one page. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:M20"].Text = "PagePrint"; + sheet.Range["A1:M1"].Text = "Page"; + sheet.Range["C1:C20"].Text = "Page"; + + //Sets the fit to page tall as true. + sheet.PageSetup.FitToPagesTall = 1; + sheet.PageSetup.FitToPagesWide = 0; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the width of the pages the worksheet will be scaled + to when it is printed. Applies only to worksheets. Read/write Boolean. + + + To know more about page settings refer this link. + + The following code illustrates how to fit all columns on one page. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:M20"].Text = "PagePrint"; + sheet.Range["A1:M1"].Text = "Page"; + sheet.Range["C1:C20"].Text = "Page"; + + //Sets the fit to page wide as true. + sheet.PageSetup.FitToPagesWide = 1; + sheet.PageSetup.FitToPagesTall = 0; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + True if cell gridlines are printed on the page. Applies only to + worksheets. + + + To know more about page settings refer this link. + + The following code illustrates the use of PrintGridlines property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:M20"].Text = "PagePrint"; + sheet.Range["A1:M1"].Text = "Page"; + sheet.Range["C1:C20"].Text = "Page"; + + //True to cell gridlines are printed on the page + sheet.PageSetup.PrintGridlines = true; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + True if row and column headings are printed with this page. Applies + only to worksheets. + + + To know more about page settings refer this link. + + The following code illustrates the use of PrintHeadings property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:M20"].Text = "PagePrint"; + sheet.Range["A1:M1"].Text = "Page"; + sheet.Range["C1:C20"].Text = "Page"; + + //True to row and column headings are printed on page + sheet.PageSetup.PrintHeadings = true; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the range to be printed, as a string using A1-style + references in the language of the macro. Read / write . + + + To know more about page settings refer this link. + + The following code illustrates the use of PrintArea property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:M20"].Text = "PagePrint"; + sheet.Range["A1:M1"].Text = "Page"; + sheet.Range["C1:C20"].Text = "Page"; + + //Sets the range to be printed + sheet.PageSetup.PrintArea = "A1:M20"; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the columns that contain the cells to be repeated + on the left side of each page, as a string in A1-style notation + in the language of the macro. Read / write . + + + To know more about page settings refer this link. + + The following code illustrates the use of PrintTitleColumns property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:M20"].Text = "PagePrint"; + sheet.Range["A1:M1"].Text = "Page"; + sheet.Range["C1:C20"].Text = "Page"; + + //Sets the columns to be repeated on the left side of each page + sheet.PageSetup.PrintTitleColumns = "C1:C20"; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the rows that contain the cells to be repeated at + the top of each page, as a string in A1-style notation in the + language of the macro. Read / write . + + + To know more about page settings refer this link. + + The following code illustrates the use of PrintTitleRows property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:M20"].Text = "PagePrint"; + sheet.Range["A1:M1"].Text = "Page"; + sheet.Range["C1:C20"].Text = "Page"; + + //Sets the rows to be repeated at the top of each page + sheet.PageSetup.PrintTitleRows = "A1:M1"; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Indicates whether summary rows will appear below detail in outlines. To enable SummaryRowBelow property the page must be Portrait and property value must be 0 and property must be true. + + + To know more about page settings refer this link. + + The following code illustrates the use of IsSummaryRowBelow property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:M20"].Text = "PagePrint"; + sheet.Range["A1:M1"].Text = "Page"; + sheet.Range["C1:C20"].Text = "Page"; + + //True to summary rows will appear below detail in outlines + sheet.PageSetup.IsSummaryRowBelow = true; + sheet.PageSetup.FitToPagesWide = 0; + sheet.PageSetup.Orientation = ExcelPageOrientation.Portrait; + sheet.PageSetup.IsFitToPage = true; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Indicates whether summary columns will appear right of the detail in outlines. To enable SummaryColumnRight property the page must be Portrait and property value must be 0 and property must be true. + + + To know more about page settings refer this link. + + The following code illustrates the use of IsSummaryColumnRight property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:M20"].Text = "PagePrint"; + sheet.Range["A1:M1"].Text = "Page"; + sheet.Range["C1:C20"].Text = "Page"; + + //True to summary columns will appear right of the detail in outlines + sheet.PageSetup.IsSummaryColumnRight = true; + sheet.PageSetup.Orientation = ExcelPageOrientation.Portrait; + sheet.PageSetup.FitToPagesTall = 0; + sheet.PageSetup.IsFitToPage = true; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Indicates whether fit to page mode is selected. This property used to fit the page content before printing. + + + To know more about page settings refer this link. + + The following code illustrates the use of IsFitToPage property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:M20"].Text = "PagePrint"; + sheet.Range["A1:M1"].Text = "Page"; + sheet.Range["C1:C20"].Text = "Page"; + + // True to fit the content before printing + sheet.PageSetup.IsFitToPage = true; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Parent group of worksheets. + + + + + Initializes new instance and sets its application and parent properties. + + Application object for the new instance. + Parent object for the new instance. + + + + Looks for all necessary parent objects. + + + + + Indicates whether summary rows will appear below detail in outlines. + + + + + Returns or sets the number of pages tall the worksheet will be scaled + to when it is printed. Applies only to worksheets. Read / write int. + + + + + Returns or sets the number of pages wide the worksheet will be scaled + to when it is printed. Applies only to worksheets. Read / write int. + + + + + True if cell gridlines are printed on the page. Applies only to + worksheets. Read / write Boolean. + + + + + True if row and column headings are printed with this page. Applies + only to worksheets. Read / write Boolean. + + + + + Returns or sets the range to be printed, as a string using A1-style + references in the language of the macro. Read / write String. + + + + + Returns or sets the columns that contain the cells to be repeated + on the left side of each page, as a string in A1-style notation + in the language of the macro. Read / write String. + + + + + Returns or sets the rows that contain the cells to be repeated at + the top of each page, as a string in A1-style notation in the + language of the macro. Read / write String. + + + + + Indicates whether summary rows will appear below detail in outlines. + + + + + Indicates whether summary columns will appear right of the detail in outlines. + + + + + Indicates whether fit to page mode is selected. + + + + + True if elements of the document will be printed in black and white. + Read / write Boolean. + + + + + Returns or sets the size of the bottom margin, in inches. + Read / write Double. + + + + + Returns or sets the center part of the footer. Read / write String. + + + + + Gets / set image for center part of the footer. + + + + + Returns or sets the center part of the header. Read / write String. + + + + + Gets / set image for center part of the header. + + + + + True if the sheet is centered horizontally on the page when it is + printed. Read / write Boolean. + + + + + True if the sheet is centered vertically on the page when it is + printed. Read / write Boolean. + + + + + Number of copies to print. + + + + + True if the sheet will be printed without graphics. + Read / write Boolean. + + + + + Returns or sets the first page number that will be used when + this sheet is printed. If xlAutomatic, Microsoft Excel chooses the + first page number. The default is xlAutomatic. Read / write Long. + + + + + Returns or sets the distance from the bottom of the page to the footer, + in inches. Read / write Double. + + + + + Returns or sets the distance from the top of the page to the header, + in inches. Read / write Double. + + + + + Returns or sets the left part of the footer. Read / write String. + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + + + + + Gets / set image for left part of the footer. + + + + + Returns or sets the left part of the header. Read / write String. + + + + + Gets / set image for left part of the header. + + + + + Returns or sets the size of the left margin, in inches. + Read / write Double. + + + + + Returns or sets the order that Microsoft Excel uses to number + pages when printing a large worksheet. Read / write ExcelOrder. + + + + + Portrait or landscape printing mode. Read / write ExcelPageOrientation. + + + + + Returns or sets the size of the paper. Read / write ExcelPaperSize. + + + + + Returns or sets the way comments are printed with the sheet. + Read / write ExcelPrintLocation. + + + + + Sets or returns an ExcelPrintErrors constant specifying the type of + print error displayed. This feature allows users to suppress the + display of error values when printing a worksheet. Read / write. + + + + + True if cell notes are printed as end notes with the sheet. Applies + only to worksheets. Read / write Boolean. + + + + + Returns or sets the print quality. Read / write ushort. + + + + + Returns or sets the right part of the footer. Read / write String. + + + + + Returns or sets the right part of the header. Read / write String. + + + + + Gets / set image for right part of the footer. + + + + + Gets / set image for right part of the header. + + + + + Returns or sets the size of the right margin, in inches. + Read / write Double. + + + + + Returns or sets the size of the top margin, in inches. + Read / write Double. + + + + + Returns or sets a percentage (between 10 and 400 percent) by which + Microsoft Excel will scale the worksheet for printing. Applies only + to worksheets. Read / write ushort. + + + + + Indicates whether the header and footer margins are aligned with page margins. Read/Write Boolean. + + + + + True - The header / footer of the first page is different with other pages.False otherwise. + + + + + True - The header/footer odd pages are differed with even page. False otherwise. + + + + + Indicates whether the header and footer are scaled with document scaling.Read/Write Boolean. + + + + + Gets / sets values for even page. + + + + + Gets / sets values for First page. + + + + + Gets / sets background image. + + + + + Summary description for RichTextStringGroup. + + + + + Represents a Rich Text String that can be used to apply several styles inside a single cell. + + + + + Returns font which is applied to character at the specified position. + + Character index. + Font which is applied to character at the specified position. + Since the object returned by GetFont method is read-only + Argument out of range exception will occur if it is modified. + + Font style can be changed by cloning the font obtained using GetFont method and to be set using + method. + + + The following code illustrates how to access GetFont method. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set text + worksheet["C2"].Text = "Sample text"; + + //Set RichText + IRichTextString richText = worksheet["C2"].RichText; + + //Get font + IFont font = richText.GetFont(1); + + //Get font name + Console.Write(font.FontName); + + //Save and Dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //Calibri + + + + + + Sets font for range of characters. + + First character of the range. + Last character of the range. + Font to set. + + To know more about Rich-Text refer Rich-Text Formatting + + + The following code illustrates how a font can be set to a substring of the RichText. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set rich text + IRichTextString richText = worksheet["C2"].RichText; + + //Set text + richText.Text = "Sample text"; + + //Set font + IFont font = style.Font; + + //Set color + font.Color = ExcelKnownColors.Red; + + //Set rich text font + richText.SetFont(0, 5, font); + + //Set color + font.Color = ExcelKnownColors.Blue; + + //Set rich text font + richText.SetFont(6, 10, font); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Clears string formatting. + + + The following code illustrates how to clear the formatting applied to the RichText. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set rich text + IRichTextString richText = worksheet["C2"].RichText; + + //Set text + richText.Text = "Sample text"; + + //Set font + IFont font = style.Font; + + //Set color + font.Color = ExcelKnownColors.Red; + + //Set rich text font + richText.SetFont(0, 5, font); + + //Set color + font.Color = ExcelKnownColors.Blue; + + //Set rich text font + richText.SetFont(6, 10, font); + + //Clear format + richText.ClearFormatting(); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Clears text and formatting. + + + The following code illustrates how to clear RichText's text and formatting applied. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set text + worksheet["C2"].Text = "Sample text"; + + //Set RichText + IRichTextString richText = worksheet["C2"].RichText; + + //Get font + IFont font = style.Font; + + //Set color + font.Color = ExcelKnownColors.Red; + + //Set format to RichText + richText.SetFont(0, 5, font); + + //Clear RichText + richText.Clear(); + + //Save and Dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Appends rich text string with specified text and font. + + Text to append. + Font to use. + + The following code illustrates how to append RichText to an existing RichText. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set rich text + IRichTextString richText = worksheet["C2"].RichText; + + //Set text + richText.Text = "Sample"; + + //Set font + IFont font = style.Font; + + //Set color + font.Color = ExcelKnownColors.Red; + + //Set rich text font + richText.SetFont(0, 5, font); + + //Set color + font.Color = ExcelKnownColors.Blue; + + //Append text + richText.Append("Text", font); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets / sets text of the string. + + + The following code illustrates how to set Text for the RichText. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set rich text + IRichTextString richText = worksheet["C2"].RichText; + + //Set text + richText.Text = "Sample text"; + + //Set font + IFont font = style.Font; + + //Set color + font.Color = ExcelKnownColors.Red; + + //Set rich text font + richText.SetFont(0, 5, font); + + //Set color + font.Color = ExcelKnownColors.Blue; + + //Set rich text font + richText.SetFont(6, 10, font); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Returns text in rtf format. Read-only. + + + The following code illustrates how to access the RtfText of the RichText. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set rich text + IRichTextString richText = worksheet["C2"].RichText; + + //Set text + richText.Text = "Sample"; + + //Set font + IFont font = style.Font; + + //Set color + font.Color = ExcelKnownColors.Red; + + //Set rich text font + richText.SetFont(0, 5, font); + + //Get rtf text string + Console.Write(richText.RtfText); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //{\rtf1\ansi\ansicpg1252\deff0\deflang1033{\fonttbl{\f0\fnil\fcharset1 Calibri;}}{\colortbl;\red255\green0\blue0;}{\f0\fs22\cf1\u83*\u97*\u109*\u112*\u108*\u101*}} + + + + + + Indicates whether rich text string has formatting runs. Read-only. + + + The following code illustrates how to access IsFormatted property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set rich text + IRichTextString richText = worksheet["C2"].RichText; + + //Set text + richText.Text = "Sample"; + + //Set font + IFont font = style.Font; + + //Set color + font.Color = ExcelKnownColors.Red; + + //Set rich text font + richText.SetFont(0, 5, font); + + //Check IsFormatted + Console.Write(richText.IsFormatted); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + + + + + + Parent group of ranges. + + + + + Represents an RTF string. + + + + + Creates new instance of the group. + + Application object for the new group. + Parent object for the new group. + + + + Searches for all necessary parent objects. + + + + + Returns font which is applied to character at the specified position. + + Character index. + Font which is applied to character at the specified position. + + + + Sets font for range of characters. + + First character of the range. + Last character of the range. + Font to set. + + + + Clears string formatting. + + + + + Appends rich text string with specified text and font. + + Text to append. + Font to use. + + + + Clears text and formatting. + + + + + + + + + + + + + + + Returns single RichTextString from the group. Read-only. + + + + + Returns number of elements in the group. Read-only. + + + + + Gets / sets text of the string. + + + + + Returns text in rtf format. Read-only. + + + + + Indicates whether rich text string has formatting runs. Read-only. + + + + + Summary description for StyleGroup. + + + + + Parent range group. + + + + + Font group. + + + + + Borders group. + + + + + Creates new instance of the group. + + Application object for the new group. + Parent object for the new group. + + + + Searches for all necessary parent objects. + + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object. + + + + + Returns single entry from the group. Read-only. + + + + + Returns number of elements in the group. Read-only. + + + + + Returns parent workbook object. Read-only. + + + + + Returns a Borders collection that represents the borders of a + style or a range of cells (including a range defined as part of + a conditional format). + + + + + True if the style is a built-in style. Read-only Boolean. + + + + + Gets / sets fill pattern. + + + + + Gets / sets index of fill background color. + + + + + Gets / Sets fill background color. + + + + + Gets / sets index of fill foreground color. + + + + + Gets / sets fill foreground color. + + + + + Returns a Font object that represents the font of the specified + object. + + + + + Returns Interior object that represents interior of the specified object. + + + + + True if the formula will be hidden when the worksheet is protected. + Read/write Boolean. + + + + + Returns or sets the horizontal alignment for the specified object. + For all objects, this can be one of the following ExcelHAlign constants. + Read/write ExcelHAlign. + + + + + True if the style includes the AddIndent, HorizontalAlignment, + VerticalAlignment, WrapText, and Orientation properties. + Read/write Boolean. + + + + + True if the style includes the Color, ColorIndex, LineStyle, + and Weight border properties. Read/write Boolean. + + + + + True if the style includes the Background, Bold, Color, + ColorIndex, FontStyle, Italic, Name, OutlineFont, Shadow, + Size, Strikethrough, Subscript, Superscript, and Underline + font properties. Read/write Boolean. + + + + + True if the style includes the NumberFormat property. + Read/write Boolean. + + + + + True if the style includes the Color, ColorIndex, + InvertIfNegative, Pattern, PatternColor, and PatternColorIndex + interior properties. Read / write Boolean. + + + + + True if the style includes the FormulaHidden and Locked protection + properties. Read/write Boolean. + + + + + Returns or sets the indent level for the style. Read/write. + + + + + True if the object is locked, False if the object can be + modified when the sheet is protected. Read/write Boolean. + + + + + Returns or sets the name of the object. Read-only String. + + + + + Returns or sets the format code for the object. Read/write String. + + + + + Returns or sets the format code for the object. Read/write String. + + + + + Gets / sets index of the number format. + + + + + Returns object that describes number format. Read-only. + + + + + Text rotation angle: + 0 Not rotated + 1-90 1 to 90 degrees counterclockwise + 91-180 1 to 90 degrees clockwise + 255 Letters are stacked top-to-bottom, but not rotated. + + Thrown when value is more than 0xFF. + + + + True if text automatically shrinks to fit in the available + column width. Read/write Boolean. + + + + + Returns or sets the vertical alignment of the specified object. + Read/write ExcelVAlign. + + + + + True if Excel wraps the text in the object. + Read/write Boolean. + + + + + Indicates whether style is initialized (differs from Normal style). + Read-only. + + + + + Text direction, the reading order for far east versions. + + + + + If true then first symbol in cell is apostrophe. + + + + + For far east languages. Supported only for format. Always False for US. + + + + + Gets / sets index of fill background color. + + + + + Gets / Sets fill background color. + + + + + Gets / sets index of fill foreground color. + + + + + Returns or sets the cell shading color. + + + + + Gets value indicating whether format was modified, compared to parent format. + + + + + Gets whether borser is present. + + + + + Gets format index in m_book.InnerFormats. + + + + + Represents group of worksheets. + + + + + Represents a worksheet group. + + + + + Adds new worksheet to the collection. + + Worksheet to add. + Index of the added worksheet. + When sheet is Null. + + + + Returns single entry from the collection. Read-only. + + + + + Indicates whether collection is empty. Read-only. + + + + + Number of selected worksheets. + + + + + Parent workbook. + + + + + Page setup. + + + + + Used range. + + + + + Migrant range - row and column of this range object can be changed by user. + + + + + Represents the slicers in the worksheet. + + + + + Represents the scenarios in the worksheet. + + + + + Represents the threaded comments collection in the worksheet + + + + + Creates new instance of the worksheet group. + + Application object for the new group. + Parent object for the new group. + + + + Searches for all necessary parent objects. + + + + + Adds new worksheet to the collection. + + Worksheet to add. + Index of the added worksheet. + When sheet is Null. + + + + Saves worksheet with specified filename. + + File to save. + + + + Saves worksheet as stream. + + Stream to save. + + + + Saves worksheet with specified filename and .. + + File to save. + Save Options + + + + Saves worksheet as stream with the specified . + + Stream to save. + Save Options + + + + Removes worksheet from the collection. + + Worksheet to remove. + When sheet is Null. + + + + Selects single tab sheet. + + Sheet to select. + + + + Creates migrant range. + + + + + Enables the calculation support. + + Enabling this method will initialize objects and retrieves calculated values of formulas in a worksheet. + + + + + Disables the calculation support in this workbook and disposes of the associative objects. + + + + + Returns the formula string if the cell contains a formula, or the value if + the cell cantains anything other than a formula. + + The row of the cell. + The column of the cell. + The formula string or value. + + + + Sets the value of a cell. + + The value to be set. + The row of the cell. + The column of the cell. + + + + Not implemented. + + + + + Raises the event. + + The row of the change. + The column of the change. + The changed value. + + + + Makes the current sheet the active sheet. Equivalent to clicking the + sheet's tab. + + + + + Copies worksheet data to the clipboard. + + + + + Import XML document with specified cell position to the worksheet using file path. + + FilePath of the speciifed xml file. + Row where the data to be imported. + Column where the data to be imported. + + + + Imports XML data into a worksheet at the specified row and column from a given XML data stream. + + Stream data of the xml file. + Row where the data to be imported. + Column where the data to be imported. + The stream should be passed as file stream to bind the xml + + + + + Clears worksheet data. Removes all formatting and merges. + + + + + Clears the worksheet data. + + + + + Checks whether the specified cell is initialized or accessed. + + One-based row index of the cell. + One-based column index of the cell. + Value indicating whether the cell was initialized or accessed by the user. + + + + Filters or copies data from a list based on a criteria range.. + + Whether filter in the place or copy to another place. + The filter range. + The criteria range. + The destination range for the copied rows if ExcelFilterAction is FilterCopy. Otherwise, this argument is ignored. + True to filter unique records; Otherwise filters all the records that meet the criteria. The default value is False. + + + + Creates a new instance of the . + + New instance of ranges collection. + + + + Creates a named ranges with the specified named range's value as a name for the specified range. + + Existing named ranged. + Address of the named range to be created. + True if the named range values are vertically placed in the sheet. + This method is used to access the discontinuous ranges. + + + + Create an instance of that can be used for template markers processing. + + Object that can be used for template markers processing. + + + + Returns True if the specified column is visible to end user. + + One-based column index. + True if column is visible; otherwise, False. + + + + Shows the specified column. + + Index at which the column should be hidden. + True - Column is visible; False - hidden. + + + + Hides the specified column. + + One-based column index. + + + + Hides the specified row. + + One-based row index. + + + + Returns True if the specified row is visible to end user. + + One-based row index. + True if row is visible; otherwise, False. + + + + Shows or Hides the specified row. + + Index at which the row should be hidden. + True - Row is visible; False - hidden. + + + + Shows or Hides the specified range. + + Range specifies the particular range to show / hide. + True - Row is visible; False - hidden. + + + + Shows/ Hides the collection of range. + + Ranges specifies the range collection. + True - Row is visible; false - hidden. + + + + Shows or Hides an array of range. + + Ranges specifies the range array. + True - Row is visible; False - hidden. + + + + Inserts an empty row in the specified row index. + + Index at which new row should be inserted. + + + + Inserts an empty rows in the specified row index based on row count. + + Index at which new row should be inserted. + Number of rows to insert. + + + + Inserts an empty row in the specified row index with specified based on row count. + + Index at which new row should be inserted. + Number of rows to insert. + Insert options. + + + + Inserts an empty column for the specified column index. + + Index at which new column should be inserted. + + + + Inserts an empty column in the specified column index based on column count. + + Index at which new column should be inserted. + Number of columns to insert. + + + + Inserts an empty column with default formatting (without formulas update). + + Index at which new column should be inserted. + Number of columns to insert. + Insert options. + + + + Removes specified row (without updating formulas). + + One-based row index to remove. + + + + Removes specified row (without updating formulas). + + One-based row index to remove. + Number of rows to remove. + + + + Removes the specified column. + + One-based column index. + + + + Removes the specified number of columns from the given index. + + One-based column index. + Number of columns to remove. + + + + Imports an array of objects into a worksheet with specified alignment. + + Array of object. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + True if array should be imported vertically; False - horizontally. + Number of imported elements. + + + + Imports an array of string values into a worksheet. + + Array of string value. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + True if array should be imported vertically; False - horizontally. + Number of imported elements. + + + + Imports an array of integer values into a worksheet. + + Array of int value. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + True if array should be imported vertically; False - horizontally. + Number of imported elements. + + + + Imports an array of double values into a worksheet. + + Array of double value. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + True if array should be imported vertically; False - horizontally. + Number of imported elements. + + + + Imports an array of DateTime values into a worksheet. + + Array of datetime value. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + True if array should be imported vertically; False - horizontally. + Number of imported elements. + + + + Imports an array of objects into a worksheet. + + Array of object. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + Number of imported rows. + + + + Imports data from class objects into a worksheet with specified row and column. + + IEnumerable object with desired data. + First row from where the data should be imported. + First column from where the data should be imported. + TRUE if class properties names must be imported. + Number of imported rows. + + + + Imports data from class objects into a worksheet with specified row and column along with import data options. + + IEnumerable object with desired data. + Import data options for when importing nested collection data. + Number of imported rows. + + + + Imports data from class objects into a worksheet with specified row and column along with import data options. + + IEnumerable object with desired data. + First row from where the data should be imported. + First column from where the data should be imported. + TRUE if class properties names must be imported. + TRUE if parent class properties names must be imported. + Import data options for when importing nested collection data. + Indicates whether XlsIO should preserve column types from Data. + Number of imported rows. + + + + Imports data from DataReader into worksheet from the specified row and column. + + The or object which contains data. + TRUE if column names must be imported. + First row from where the data should be imported. + First column from where the data should be imported. + Number of imported rows. + + This method is not supported in WinRT, Windows Phone, Portable, Universal and Silverlight platforms. + + + + + Imports data from DataReader into worksheet from the specified row and column along with save option. + + The or object which contains data. + First row from where the data should be imported. + First column from where the data should be imported. + TRUE if data must be serialized directly on save. + Number of imported rows. + + This method is not supported in WinRT, Windows Phone, Portable, Universal and Silverlight platforms. + + + + + Imports data from DataReader into worksheet from the specified row and column along with the preserve type. + + The or object which contains data. + TRUE if column names must be imported. + First row from where the data should be imported. + First column from where the data should be imported. + + Indicates whether XlsIO should preserve column types from DataReader. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + Number of imported rows. + + This method is not supported in WinRT, Windows Phone, Portable, Universal and Silverlight platforms. + + + + + + Imports data from a DataColumn into a worksheet. + + DataColumn with desired data. + True if column name must be imported. + Row of the first cell where Data Table should be imported. + Column of the first cell where Data Table should be imported. + Number of imported rows. + + + + Imports data from a DataColumn into a worksheet. + + DataColumn with desired data. + True if column name must be imported. + Row of the first cell where Data Table should be imported. + Column of the first cell where Data Table should be imported. + + Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + + Number of imported rows. + + + + Imports data from MS DataGrid into worksheet. + + DataGrid with datasource. + Represents the first row of the worksheet to import. + Represents the first column of the worksheet to import. + TRUE if header must be imported. FALSE otherwise. + TRUE if row style must be imported. FALSE otherwise. + + + + Imports data from MS DataGrid (web) into worksheet. + + DataGrid with datasource. + Represents the first row of the worksheet to import. + Represents the first column of the worksheet to import. + TRUE if header must be imported. FALSE otherwise. + TRUE if row style must be imported. FALSE otherwise. + + + + Imports data from MS GridView into worksheet. + + GridView with datasource. + Represents the first row of the worksheet to import. + Represents the first column of the worksheet to import. + TRUE if header must be imported. FALSE otherwise. + TRUE if row style must be imported. FALSE otherwise. + + + + Imports data from MS DataGridView into worksheet. + + DataGridView with datasource. + Represents the first row of the worksheet to import. + Represents the first column of the worksheet to import. + TRUE if header must be imported. FALSE otherwise. + TRUE if row style must be imported. FALSE otherwise. + + + + + Imports data from a DataTable into a worksheet with specified row and column along with the preserve type. + + DataTable with desired data. + True if column names must be imported. + First row from where the data should be imported. + First column from where the data should be imported. + + Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + + Number of imported rows. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Imports data from a DataTable into a worksheet with the specified row and column along with save option. + + Data Table with desired data. + First row from where the data should be imported. + First column from where the data should be imported. + TRUE if data table must be serialized directly on save. + Number of imported rows. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Imports data from a DataTable into a worksheet with the specified row and column along with save option. + + Data Table with desired data. + First row from where the data should be imported. + First column from where the data should be imported. + TRUE if data table must be serialized directly on save. + TRUE if column names must be imported. + Number of imported rows. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Imports data from a DataTable into a worksheet with the specified range. + + DataTable with desired data. + True if column names must be imported. + First row from where the data should be imported. + First column from where the data should be imported. + Maximum number of rows to import. + Maximum number of columns to import. + Number of imported rows. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Imports data from a DataTable into a worksheet with specified range along with the specified preserve type. + + DataTable with desired data. + True if column names must be imported. + First row from where the data should be imported. + First column from where the data should be imported. + Maximum number of rows to import. + Maximum number of columns to import. + + Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + + Number of imported rows. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Imports data from DataTable into the specified NamedRange of current worksheet. + + Data Table with desired data. + Represents named range. + TRUE if column names must be imported. + Number of imported rows. + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Imports data from DataTable into the specified NamedRange of current worksheet with row and column offset. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Data Table with desired data. + Represents named range. + TRUE if column names must also be imported. + Represents row offset into named range to import. + Represents column offset into named range to import. + Number of imported rows. + + + + Imports data from DataTable into the specified NamedRange of current worksheet with row and column offset. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + DataTable with desired data. + Represents named range. + TRUE if column names must be imported. + Represents row offset into named range to import. + Represents column offset into named range to import. + Maximum number of rows to import. + Maximum number of columns to import. + Number of imported rows. + + + + Imports data from DataReader into the specified NamedRange of current worksheet with row and column offset. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + DataTable with desired data. + Represents named range. + TRUE if column names must be imported. + Represents row offset into named range to import. + Represents column offset into named range to import. + Maximum number of rows to import. + Maximum number of columns to import. + Number of imported rows. + + + + Imports data from a DataView into worksheet with the specified row and column. + + DataView with desired data. + TRUE if column names must also be imported. + + Row of the first cell where Data View should be imported. + + + Column of the first cell where Data View should be imported. + + Number of imported rows. + + + + Imports data from a DataView into a worksheet with the specified range and preserve type. + + DataView with desired data. + TRUE if column names must be imported. + + Row of the first cell where DataView should be imported. + + + Column of the first cell where DataView should be imported. + + Indicates whether to preserve column types. + Number of imported rows. + + + + Imports data from a DataView into a worksheet with specified row, column and preserve type. + + Data View with desired data. + TRUE if column names must be imported. + + Row of the first cell where DataView should be imported. + + + Column of the first cell where DataView should be imported. + + Maximum number of rows to import. + Maximum number of columns to import. + Number of imported rows. + + + + Imports data from a DataView into a worksheet with specified range and preserve type. + + DataView with desired data. + TRUE if column names must also be imported. + + Row of the first cell where DataView should be imported. + + + Column of the first cell where DataView should be imported. + + Maximum number of rows to import. + Maximum number of columns to import. + Indicates whether XlsIO should try to preserve types in Data Table, i.e. if it is set to False (default) and in Data Table we have in + string column value that contains only numbers, it would be converted to number. + Number of imported rows. + + + + Removes panes from a worksheet. + + + + + Exports worksheet data in the specified row and column into a DataTable. + + Row of the first cell from where DataTable should be exported. + Column of the first cell from where DataTable should be exported. + Maximum number of rows to export. + Maximum number of columns to export. + Export options. + DataTable with worksheet data. + + + + + Exports worksheet data in the specified range into a DataTable. + + Range to export. + Export options. + DataTable with worksheet data. + + + + Exports worksheet data in the specified row and column into a DataTable based on the export Options. + + Range to export. + Export options. + Export data options + DataTable with worksheet data. + + + + + Exports worksheet data into a DataTable only for Pivot engine. + + Range to export. + Export options. + DataTable with worksheet data. + + + + Exports worksheet data in the specified row and column and get as a list of CLR objects. + + Row of the first cell should be exported. + Column of the first cell should be exported. + LastRow is used to find the upto lastRow of data to export. + lastColumn is used to find the upto lastColumn of data to export. + clrObject List with worksheet data. + + + + Exports worksheet data in the specified row and column and get as a list of CLR objects.copyran + + Row of the first cell should be exported. + Column of the first cell should be exported. + LastRow is used to find the upto lastRow of data to export. + lastColumn is used to find the upto lastColumn of data to export. + Property names mapping collection. You should give headers as key and properties names as value to the dictionary. + clrObject List with worksheet data. + + + + Protects worksheet's content with password. + + Password to protect with. + + + + Protects current worksheet. + + Represents password to protect. + Represents params to protect. + + + + Unprotects worksheet's content with password. + + Password to unprotect. + + + + Intersects two ranges. + + First range to intersect. + Second range to intersect. + Intersection of two ranges or NULL if there is no range intersection. + + When range1 or range2 is NULL. + + + + + Merges two ranges. + + First range to merge. + Second range to merge. + Merged ranges or NULL if is not able to merge ranges. + + When range1 or range2 is NULL. + + + + + Changes the height of the specified row to achieve the best fit. + + One-based row index. + + + + Changes the width of the specified column to achieve the best fit. + + One-based column index. + + + + Replaces string with the specified another string value. + + The string to be replaced. + The string to replace all occurrences of oldValue. + + + + Replaces string with the specified string value based on the given . + + The string to be replaced. + The string to replace all occurrences of oldValue. + Specifies the find options for the oldValue. + + + + Replaces string with the specified double value. + + String value to replace. + The string to replace all occurrences of oldValue. + + + + Replaces the string with the specified DateTime value. + + The string to be replaced. + The DateTime to replace all occurrences of oldValue. + + + + Replaces specified string with the specified array of string values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces specified string with the specified array of int values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces specified string with the specified array of double values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces string with the specified datatable value. + + The string to be replaced. + Data table with new data. + Indicates whether field name must be shown. + + + + Replaces string with the specified datacolumn value. + + The string to be replaced. + Data table with new data. + Indicates whether field name must be shown. + + + + Removes worksheet from parent worksheet collection. + + + + + Moves worksheet to the specified index. + + New index of the worksheet. + + + + Converts the specified column width from points to pixels. + + Width in points. + Column width in pixels. + + + + Converts the specified column width from pixels to points. + + Width in pixels. + Width in points. + + + + Sets column width for the specified column. + + One-based column index. + Width to set. + + + + Sets column width in pixels for the specified column. + + One-based column index. + Width in pixels to set. + + + + Sets column width in pixels to the given number of columns from the specified column index. + + Start Column index + No of Column to be set width + Value in pixel to set + + + + Sets row height for the specified row. + + One-based row index. + Height to set. + + + + Sets row height in pixels for the specified row. + + One-based row index. + Value in pixels to set. + + + + Sets row height in pixels to the given number of rows from the specified row index. + + Starting row index. + No of Row to be set width. + Value in pixels to set. + + + + Returns the width of the specified column. + + One-based column index. + Width of the specified column. + + + + Returns the width of the specified column in pixels. + + One-based column index. + Width in pixels of the specified column. + + + + Returns the height of the specified row. + + Otherwise it gets the StandardHeight + One-based row index. + + Returns height of the specified row. + Otherwise returns StandardHeight. + + + + + Returns the height of the specified row in pixels. + + Otherwise it gets the StandardHeight in pixels + One-based row index. + + Returns height of the specified row in pixels. + Otherwise returns StandardHeight. + + + + + Returns the first occurrence of the specified string value with the specified . + + Value to search. + Type of value to search. + Returns the first cell with a specified string value, or null if value was not found. + + + + Returns the first occurrence of the specified string value with the specified and . + + Value to search. + Type of value to search. + Way to search the value. + Returns the first cell with a specified string value and specified find options , or null if value was not found. + + + + Returns the first occurrence that starts with the specified string value. + + Value to search. + Type of value to search. + Returns the first occurrence that starts with the specified string value, or null if value was not found. + + + + Returns the first occurrence that starts with the specified string value which ignores the case. + + Value to search. + Type of value to search. + true to ignore case wen comparing this string to the value;otherwise,false + Returns the first occurrence that starts with the specified string value, or null if value was not found. + + + + Returns the first occurrence that ends with the specified string value. + + Value to search. + Type of value to search. + Returns the first occurrence that ends with the specified string value, or null if value was not found. + + + + Returns the first occurrence that ends with the specified string value which ignores the case. + + Value to search. + Type of value to search. + True to ignore case when comparing this string to the value; otherwise, False. + Returns the first occurrence that ends with the specified string value, or null if value was not found. + + + + Returns the first occurrence of the specified double value with the specified . + + Value to search. + Type of value to search. + Returns the first cell with a specified double value, or null if value was not found. + + + + Returns the first occurrence of the specified bool value. + + Value to search. + Returns the first cell with a specified bool value, or null if value was not found. + + + + Returns the first occurrence of the specified DateTime value. + + Value to search. + Returns the first cell with a specified DateTime value, or null if value was not found. + + + + Returns the first occurrence of the specified TimeSpan value. + + Value to search. + Returns the first cell with a specified TimeSpan value, or null if value was not found. + + + + Returns the cells of the specified string value with the specified . + + Value to search. + Type of value to search. + Returns the cells with a specified string value, or null if value was not found. + + + + Returns the cells of the specified string value with the specified and . + + Value to search. + Type of value to search. + Way to search. + + Returns the cells with a specified string value and specified find options , or null if value was not found. + + + + + Returns the cells of the specified double value with the specified . + + Value to search. + Type of value to search. + All found cells, or Null if value was not found. + + + + Returns the cells of the specified bool value. + + Value to search. + Returns the cells with a specified bool value, or null if value was not found. + + + + Returns the cells of the specified DateTime value. + + Value to search. + Returns the cells with a specified DateTime value, or null if value was not found. + + + + Returns the cells of the specified TimeSpan value. + + Value to search. + Returns the cells with a specified TimeSpan value, or null if value was not found. + + + + Saves worksheet with specified file name using separator. Used only for CSV files. + + File to save. + Current separator. + + + + Saves worksheet using separator with specified file name and encoding. Used only for CSV files. + + File to save. + Current separator. + Encoding to use. + + + + Saves worksheet as stream using separator. Used only for CSV files. + + Stream to save. + Current separator. + + + + Saves worksheet as stream using separator with specified encoding. Used only for CSV files. + + Stream to save. + Current separator. + Encoding to use. + + + + Sets the default column style for the specified column. + + One-based column index. + Default style. + + + + Sets the default column style for the specified starting and ending column. + + Starting column index. + Ending column index. + Default style. + + + + Sets the default row style for the specified row. + + One-based row index. + Default style. + + + + Sets the default row style for the specified starting and ending row. + + Starting row index. + Ending row index. + Default style. + + + + Returns default row style for the specified row. + + One-based row index. + Default row style for the specified row or null if style wasn't set. + + + + Returns the default column style for the specified column. + + One-based column index. + Default column style for the specified column or null if style wasn't set. + + + + Frees range object. + + Range to remove from internal cache. + + + + Frees range object for the specified row and column. + + One-based row index of the range object to remove from internal cache. + One-based column index of the range object to remove from internal cache. + + + + Sets value for the specified cell. + + One-based row index. + One-based column index. + Value to set. + + + + Sets number for the specified cell. + + One-based row index. + One-based column index. + Value to set. + + + + Sets boolean value for the specified cell. + + One-based row index. + One-based column index. + Value to set. + + + + Sets text for the specified cell. + + One-based row index. + One-based column index. + Text to set. + + + + Sets formula for the specified cell. + + One-based row index. + One-based column index. + Formula to set. + + + + Sets error for the specified cell. + + One-based row index. + One-based column index. + Error to set. + + + + Blanks the specified cell. + + One-based row index. + One-based column index. + + + + Sets formula number value for the specified cell. + + One-based row index. + One-based column index. + Represents formula number value. + + + + Sets formula error value for the specified cell. + + One-based row index. + One-based column index. + Represents formula error value. + + + + Sets formula bool value for the specified cell. + + One-based row index. + One-based column index. + Represents formula bool value. + + + + Sets formula string value for the specified cell. + + One-based row index. + One-based column index. + Represents formula string value. + + + + Returns string value from the specified row and column. + + One-based row index. + One-based column index. + String contained by the cell. + + + + Returns number value from the specified row and column. + + One-based row index. + One-based column index. + Number contained by the cell. + + + + Returns formula value from specified row and column. + + One-based row index. + One-based column index. + Indicates whether R1C1 notation should be used. + Returns formula string. + + + + Returns error value from the specified row and column. + + One-based row index. + One-based column index. + Returns error value or null. + + + + Returns bool value from the specified row and column. + + One-based row index. + One-based column index. + Returns found bool value. If cannot found returns false. + + + + Returns formula string value from the specified row and column. + + One-based row index. + One-based column index. + String contained by the cell. + + + + Returns formula number value from the specified row and column. + + One-based row index. + One-based column index. + Number contained by the cell. + + + + Returns formula error value from the specified row and column. + + One-based row index. + One-based column index. + Returns error value or null. + + + + Returns formula bool value from the specified row and column. + + One-based row index. + One-based column index. + True if bool value is found. otherwise False. + + + + Converts the specified range into image. Default image type is Bitmap. + + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Converted Image for the specified range. + Subscript/Superscript,RTF,Shrink to fit,Shapes (except TextBox shape and Image),Charts and + Chart Worksheet and Complex conditional formatting features are not supported in Worksheet + to image conversion. Gradient fill is partially supported + + + + Converts the specified range into image with the specified type. + + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Type of the image to create. + Output stream. It is ignored if null. + Converted Image for the specified range. + Subscript/Superscript,RTF,Shrink to fit,Shapes (except TextBox shape and Image),Charts and + Chart Worksheet and Complex conditional formatting features are not supported in Worksheet + to image conversion. Gradient fill is partially supported + + + + Converts the specified range into Metafile. + + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Metafile EmfType. + Output stream. It is ignored if null. + Converted Image for the specified range. + Subscript/Superscript,RTF,Shrink to fit,Shapes (except TextBox shape and Image),Charts and + Chart Worksheet and Complex conditional formatting features are not supported in Worksheet + to image conversion. Gradient fill is partially supported + + + + Converts the specified range into image along with Metafile. + + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Type of the image to create. + Output stream. It is ignored if null. + Metafile EmfType. + Converted Image for the specified range. + Subscript/Superscript,RTF,Shrink to fit,Shapes (except TextBox shape and Image),Charts and + Chart Worksheet and Complex conditional formatting features are not supported in Worksheet + to image conversion. Gradient fill is partially supported + + + + Calculate all the formulas in worksheet. + + + + + Selects current tab sheet. + + + + + Unselects current tab sheet. + + + + + Event handler for Inserted event. + + Event sender. + Event arguments. + + + + Event handler for Removing event. + + Event sender. + Event arguments. + + + + This method is called before clearing all elements. + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Performs additional operations before the Clear method. + + + + + Imports HTML table of a HTML file into worksheet from the specified row and column. + + Specifies the HTML file. + Specifies the starting row index. + Specifies the starting column index. + + The following code illustrates how to convert HTML table to Excel. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + + sheet.ImportHtmlTable("HTMLtable.html", 1, 1); + + workbook.SaveAs("HTMLToExcel.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Imports HTML table of a file stream into worksheet from the specified row and column. + + Specifies the HTML filestream. + Specifies the starting row index. + Specifies the starting column index. + + The following code illustrates how to convert HTML table to Excel. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + FileStream html = new FileStream("HTMLtable.html", FileMode.Open, FileAccess.ReadWrite); + + sheet.ImportHtmlTable(html, 1, 1); + + workbook.SaveAs("HTMLToExcel.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Imports tables from HTML document into Excel worksheet from the specified row and column with HTML import options. + + Specifies the HTML file. + Specifies the starting row index. + Specifies the starting column index. + Specifies the html import options. + + The following code illustrates how to convert HTML table to Excel. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Xlsx; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + + sheet.ImportHtmlTable("HTMLtable.html", 1, 1, HtmlImportOptions.DetectFormulas); + + workbook.SaveAs("HTMLToExcel.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Imports HTML table of a file stream into worksheet from the specified row and column. + + Specifies the HTML filestream. + Specifies the starting row index. + Specifies the starting column index. + Specifies the html import options. + + The following code illustrates how to convert HTML table to Excel. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Xlsx; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + FileStream html = new FileStream("HTMLtable.html", FileMode.Open, FileAccess.ReadWrite); + + sheet.ImportHtmlTable(html, 1, 1, HtmlImportOptions.DetectFormulas); + + workbook.SaveAs("HTMLToExcel.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Occurs when the value of a cell changes. + + + + + Event to choose an action while exporting data from Excel to data table. + + + + + Event raised when an unknown function is encountered. + + + + + Indicates whether collection is empty. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + Returns the slicers present in the worksheet + + + + + Get the scenarios collection for the current worksheet. + + + + + Get the threaded comments collection for a current worksheet. + + + + + Gets or sets the a object associated with implementation. + + + + + An event raised on the IWorksheet whenever a value changes. + + + + + Gets the auto filters collection in the worksheet. Read-only. + + + + + Get parent workbook of current worksheet. Read-only. + + + + + Gets the used cells in the worksheet. Read-only. + + + + + Gets or sets the view setting of the worksheet. + + + + + Gets the sparkline groups. + + The sparkline groups. + + + + Gets or sets a value that indicates whether page breaks (both automatic and manual) + on the worksheet are displayed. + + + + + Gets whether the OLE object is present in the worksheet. Read-only. + + + True if this instance is OLE object; otherwise, False. + + + + + Gets the index number of the worksheet within the collection of + worksheet. Read-only. + + + + + Gets index in the parent ITabSheets collection. Read-only. + + + + + True if objects are protected. Read-only. + + + + + True if the scenarios of the current sheet are protected. Read-only. + + + + + Gets all the merged ranges in the worksheet. Read-only. + + + + + Returns or sets the name of the object. Read / write String. + + + + + Gets a Names collection that represents + the worksheet-specific names (names defined with the "WorksheetName!" + prefix) in the worksheet. Read-only. + + + + + Name that is used by macros to access the workbook items. + + + + + + Gets a object that contains all the page setup settings + for the specified object. Read-only. + + + + + Gets a Range object that represents a cell or a range of cells in the worksheet. + + + + + Gets a Range object that represents the rows in the specified worksheet. Read-only. + + + + + Gets a Range object that represents all the columns in the specified worksheet. Read-only. + + + + + Gets or sets the standard (default) height of all the rows in the worksheet, + in points. + + + + + Gets or sets the standard (default) height option flag. + + + Which defines that standard (default) row height and book default font height do not match. + + + + + Gets or sets the standard (default) width of all the columns in the + worksheet. + + + + + Gets the worksheet type. Read-only ExcelSheetType. + + + + + Gets a Range object that represents the used range on the + specified worksheet. Read-only. + + + + + Gets or sets the value that represents zoom factor of document. Value must be in range from 10 till 400. + + + + + Control visibility of worksheet to end user. + + + + + Gets or sets the position of vertical split in the worksheet. + + + Position of the vertical split (px, 0 = No vertical split): + Unfrozen pane: Width of the left pane(s) (in twips = 1/20 of a point) + Frozen pane: Number of visible columns in left pane(s) + + + + + Gets or sets the position of horizontal split in the worksheet. + + + Position of the horizontal split (by, 0 = No horizontal split): + Unfrozen pane: Height of the top pane(s) (in twips = 1/20 of a point) + Frozen pane: Number of visible rows in top pane(s) + + + + + Gets or sets the first visible row index. + + + + + Gets or sets the first visible column index. + + + + + Gets or sets index of the active pane. + + + + + True if zero values to be displayed. otherwise, False. + + + + + True if grid lines are visible. otherwise, False. + + + + + Gets or sets the color of the Grid line in the worksheet. + + + + + True if row and column headers are visible. otherwise, False. + + + + + Gets a that represents the vertical page + breaks on the sheet. Read-only. + + + + + Gets a that represents the horizontal + page breaks in the worksheet. Read-only. + + + + + True if all values in the worksheet are preserved as strings. otherwise, False. + + + + + Indicates if the worksheet is password protected. + + + + + Gets a comments collection in the worksheet. + + + + + Gets or sets cell range by row and column index. Row and column indexes are one-based. + + One-based row index. + One-based column index. + + + + Get cell Range. Row and column indexes are one-based. Read-only. + + First row index. One-based. + First column index. One-based. + Last row index. One-based. + Last column index. One-based. + + + + Gets cell Range. Read-only. + + + + + Gets cell Range with R1C1Notation flag. Read-only. + + + + + Gets a hyperlink collections in the worksheet. Read-only. + + + + + Gets all not empty or accessed cells. Read-only. + + + WARNING: This property creates Range object for each cell in the worksheet + and creates new array each time user calls to it. It can cause huge memory + usage especially if called frequently. + + + + + Gets a collection of custom properties of the worksheet. Read-only. + + + + + Gets instance of migrant range. Read-only. + + The IMigrantRange interface can also be used to access a single cell + or group of cells and manipulate it. You can prefer IMigrantRange instead of IRange + while writing large amount of data which is an optimal way. + Row and Column index can be changed by using method. + + + + + Indicates whether all created range objects should be cached or not. + + + + + Gets protected options. Read-only. For sets protection options use "Protect" method. + + + + + Indicates is current sheet is protected. + + + + + Gets or sets the top visible row of the worksheet. + + + + + Gets or sets the left visible column of the worksheet. + + + + + Gets or sets whether used range should include cells with formatting. + + + There are two different algorithms to create UsedRange object: + 1) Default. This property = true. The cell is included into UsedRange, + even data is empty (maybe some formatting + changed, maynot be - cell was accessed and record was created). + 2) This property = false. In this case XlsIO tries to remove empty rows and + columns from all sides to make UsedRange smaller. + + + + + Gets a collection of pivot tables in the worksheet. Read-only. + + + + + Gets a collection of list objects in the worksheet. Read-only. + + + + + Gets a collection of OleObjects in the worksheet. + + The OLE objects. + + + + Defines whether freezed panes are applied. + + + + + Gets split cell range. + + + + + Gets or Sets Tab color. + + + + + Gets / sets tab color. + + + + + Gets charts collection in the worksheet. Read-only. + + + + + Gets pictures collection in the worksheet. Read-only. + + + + + Gets shape collection in the worksheet. + + + + + Indicates whether worksheet is displayed right to left. + + + + + Indicates whether tab of this sheet is selected. Read-only. + + + + + Gets inner textboxes collection. Read-only. + + + + + Gets inner checkboxes collection in the worksheet. Read-only. + + + + + Gets inner option buttons collection in the worksheet. Read-only. + + + + + Returns collection with all comboboxes inside this worksheet. Read-only. + + + + + Summary description for HeaderFooterShapesCollection. + + + + + Summary description for ShapeCollectionBase. + + + + + Default id increment when group changes. + + + + + Shapes count would be rounded to this value. + + + + + Container of all worksheet's shapes. + + + + + Parent worksheet. + + + + + Index of the collection. + + + + + Id of the last shape. + + + + + Id of the first shape. + + + + + + + + + + + + + + + + + Parse options. + + + + Initializes collection. + + + + + Searches for all necessary parent objects. + + + + + Parses shapes group container. + + Container to parse. + Parse options. + + + + Parses shapes group description record. + + Record to parse. + + + + Parses MsoDrawing records. + + Array of MsoDrawing records. + Parse options. + + + + Parses MsofbtDgContainer. + + Container to parse. + Parse options. + + + + Parses MsofbtDg record. + + Record to parse. + + + + Adds shape copy to the collection. + + Shape to copy. + Added shape. + + + + Adds shape copy to shapes collection. + + Shape to copy. + Dictionary with new names of worksheets. + Dictionary with new font indexes. + Added shape. + + + + Update Marco name for the shape. + + Source shape. + Shape to be updated. + Current Macro name + + + + + Adds shape copy to the collection. + + Shape to copy. + Added shape. + + + + Adds shape copy to shapes collection. + + Shape to copy. + Dictionary with new names of worksheets. + List with new font indexes. + Added shape. + + + + Adds new shape to the collection. + + Shape to add. + Newly added shape. + + + + Adds new shape to the collection. + + Shape record to add. + Parse options. + Newly added shape. + + + + Adds the group container shapes. + + Group Shape record to add. + Parse options. + Newly added shape. + + + + Create the group container shapes. + + Group Shape record to create. + Parse options. + Newly created shape. + + + + Adds new child shape to the collection. + + Shape container to add. + Parse options. + Newly added shape. + + + + Adds new shape to the collection. + + Shape container to add. + Parse options. + Newly added shape. + + + + Creates new shape object. + + Object type to create. + Shape container. + Parse options. + Subrecords of the shape's OBJRecord. + Index to the cmo record inside subrecords. + + + + Removes shape from the collection. + + Shape to remove. + + + + Creates copy of the collection. + + Parent object for the new collection. + Copy of the collection. + + + + Registers in the parent worksheet. + + + + + Serializes shapes collection. + + Array of records that will receive all shapes. + + + + Loops each shape in the shape collection for chartEx + + returns the chartEx indexes list + + + + Converts array of records with break indexes into bytes sequence. + + Stream to put resulting data into. + Container. + List with break indexes. + List with records to serialize. + Corresponding byte array. + + + + + + + + + + + + + + Returns parent WorksheetBase. Read-only. + + + + + Returns parent worksheet. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + Returns single shape from the collection by its index. Read-only. + + + + + Returns single shape from the collection by its name or null when cannot find. Read-only. + + + + + Gets or sets the shape layout stream. + + The shape layout stream. + + + + Code of the Biff record in which all data is stored. Read-only. + + + + + Returns shared shape data for all shapes in this collection. Read-only. + + + + + Index of the collection. + + + + + Id of the last shape. + + + + + Id of the first shape. + + + + + + + + + + + + + + + + + Parse options. + + + + Creates new shape object. + + Object type to create. + Shape container. + Parse options. + Subrecords of the shape's OBJRecord. + Index to the cmo record inside subrecords. + + + + Converts array of records with break indexes into bytes sequence. + + Stream to put record data into. + Container. + List with break indexes. + List with records to serialize. + Corresponding byte array. + + + + Adds new shape to the collection. + + Shape container to add. + Parse options. + Newly added shape. + + + + Registers in the parent worksheet. + + + + + Parses record with image data. + + Record to parse. + Parse options. + + + + Sets picture. + + Shape name. + Image to set. + + + + Sets picture. + + Shape name. + Image to set. + Represents new shape blip id index. If set -1 - auto indicate. + + + + Sets picture. + + Shape name. + Image to set. + Represents new shape blip id index. If set -1 - auto indicate. + Indicates is current picture include options. + + + + Code of the Biff record in which all data is stored. Read-only. + + + + + Returns shared shape data for all shapes in this collection. Read-only. + + + + + The collection of horizontal page breaks within the print area. + Each horizontal page break is represented by an HPageBreak object. + + + + + The collection of horizontal page breaks within the print area. + Each horizontal page break is represented by an object. + + + + + Adds a horizontal page break. Returns an object. + + Location of the page break. + which was added. + + To know more about page setting refer this link. + + The following code illustrates how to add a horizontal page break. + + //Create a worksheet. + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + + //Set Horizontal Page Breaks. + sheet.HPageBreaks.Add(sheet.Range["A5"]); + sheet.HPageBreaks.Add(sheet.Range["C18"]); + sheet.HPageBreaks.Add(sheet.Range["H32"]); + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + + + + + + Removes a pagebreak from the specified location. + + Range to remove the page break. + Horizontal page break in location after removing. + + To know more about page setting refer this link. + + The following code illustrates how to Remove a horizontal page break. + + //Create a worksheet. + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //Remove Horizontal Page Breaks. + sheet.HPageBreaks.Remove(sheet.Range["A5"]); + sheet.HPageBreaks.Remove(sheet.Range["A18"]); + sheet.HPageBreaks.Remove(sheet.Range["A32"]); + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + + + + + + Returns page break at the specified row. + + One-based row index. + Page break with corresponding row or null if not found. + + To know more about page setting refer this link. + + The following code illustrates how to get page break with corresponding row. + + //Create a worksheet. + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //Get Page break with corresponding row + IHPageBreak hPageBrk = sheet.HPageBreaks.GetPageBreak(5); + if(hPageBrk != null) + { + //Your code here + } + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + + + + + + Clears horizontal page breaks from HPageBreaks collection. + + + To know more about page setting refer this link. + + The following code illustrates how to clear a horizontal page break. + + //Create a worksheet. + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //clear Horizontal Page Breaks + sheet.HPageBreaks.Clear(); + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + + + + + + Used without an object qualifier, this property returns an + object that represents the Excel . + + The following code illustrates how to access the property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //Property returns an Application object that represents the Excel application + IApplication hPageBreakApplication = sheet.HPageBreaks.Application; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Returns the number of objects in the collection. Read-only. + + The following code illustrates the use of Count property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //Number of objects in the collection + int hPageBreakCount = sheet.HPageBreaks.Count; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Returns a single object from a collection. Read-only. + + + To know more about page setting refer this link. + + The following code illustrates how to get an object from a collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add PageBreaks + sheet.Range["A1:S65"].Text = "PagePrint"; + sheet.HPageBreaks.Add(sheet.Range["A3"]); + sheet.HPageBreaks.Add(sheet.Range["G10"]); + sheet.HPageBreaks.Add(sheet.Range["F24"]); + sheet.HPageBreaks.Add(sheet.Range["C37"]); + + //Get the Horizontal page break location using index + IRange hPageBreakLocation1 = sheet.HPageBreaks[0].Location; + IRange hPageBreakLocation2 = sheet.HPageBreaks[1].Location; + IRange hPageBreakLocation3 = sheet.HPageBreaks[2].Location; + IRange hPageBreakLocation4 = sheet.HPageBreaks[3].Location; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Returns a single object from a collection. Read-only. + + + To know more about page setting refer this link. + + The following code illustrates how to get a object from location. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add PageBreaks + sheet.Range["A1:S65"].Text = "PagePrint"; + sheet.HPageBreaks.Add(sheet.Range["A3"]); + sheet.HPageBreaks.Add(sheet.Range["G10"]); + sheet.HPageBreaks.Add(sheet.Range["F24"]); + sheet.HPageBreaks.Add(sheet.Range["C37"]); + + //Get the Horizontal page break location as index + IRange pageBreakLocation = sheet.HPageBreaks[0].Location; + IRange hPageBreakLocation = sheet.HPageBreaks[pageBreakLocation].Location; + IRange hPageBreakLocation2 = sheet.HPageBreaks[sheet.Range["G10"]].Location; + IParentApplication pageBreakApplication = sheet.HPageBreaks[sheet.Range["F24"]].Application; + object pageBreakParent = sheet.HPageBreaks[sheet.Range["C37"]].Parent; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Returns the parent object for the specified object. + + The following code illustrates the use of Parent property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //Parent object for the specified object + object hPageBreakParent = sheet.HPageBreaks.Parent; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Parent workbook. + + + + + Adds a horizontal page break. Returns an HPageBreak object. Read-only. + + Object after which new page break must be inserted. + HPageBreak which was added. + + If specified object couldn't be found in the collection. + + + + + + + + + + + + Returns page break at the specified row. + + One-based row index. + Page break with corresponding row or null if not found. + + + + Returns index of the page break + + Location of the break to find. + Index of the page break in the collection or -1 if not found. + + + + Clears horizontal page breaks from HPageBreaks collection. + + + + + Creates collection and sets its Application and Parent properties. + + + Application object that represents the Microsoft Excel application. + + The parent object for the specified object. + + + + Looks for all necessary parent objects. + + + + + Parses breaks record. + + Record to parse. + + + + Serializes collection into as set of Biff records. + + OffsetArrayList to serialize into. + + + + Converts collection into biff record. + + Null if collection is empty; created record otherwise. + + + + Creates copy of the collection. + + Parent for new collection. + A clone of the current collection. + + + + Adds page break to the collection. + + Page break to add. + + + + Converts pagebreaks to Excel97to03 version. + + + + + Size of the required storage space. Read-only. + + + + + Save record data to stream. + + Writer that will receive record data. + Object that provides access to the data. + Object to encrypt data. + Position in the output stream. Used to increase performance. + Size of the record. + If writer is NULL. + + If m_iLength of internal record data array is less than zero. + + + + + + + + + + Returns manual breaks count. Read-only. + + + + + Returns type code of the biff storage. Read-only. + + + + + Returns code of the biff storage. Read-only. + + + + + Indicates whether data array is required by this record. + + + + + Indicates record position in stream. This is a utility member of class and + is used only in the serialization process. Does not influence the data. + + + + + Collection of hyperlinks. + + + + + Represents collection of hyperlinks. + + + + + Defines a new hyperlink. + + + Range object that represents the range new hyperlink is attached to. + + A hyperlink in the range + + + + Defines a new hyperlink for the range object. + + Range object. + The type of the hyperlink. + The address of the hyperlink. + The screen tip to be displayed when the mouse pointer is paused over the hyperlink. + Returns hyperlink initialized object. + + + + Defines a new hyperlink. + + + Shape object that represents the new hyperlink is attached to. + + A hyperlink in the shape + + + + Defines a new hyperlink for the shape object. + + Shape object. + The type of the hyperlink. + The address of the hyperlink. + The screen tip to be displayed when the mouse pointer is paused over the hyperlink. + Returns hyperlink initialized object. + + + + Removes HyperLink object from the collection. + + HyperLink index to remove. + + + + Returns the number of objects in the collection. Read-only. + + + + + Returns a single hyperlink object from the collection. Read-only. + + + + + Parent workbook. + + + + + Indicates whether collection is in read-only mode. + + + + + Cell to index dictionary: key - cell index, value - List of hyperlinks. + + + + + Hyperlinks list for Read-only mode. + + + + + Creates collection and sets its Application and Parent values. + + + Application object that represents the Excel application. + + Parent object of this collection. + + + + Creates collection and sets its Application and Parent values. + + + Application object that represents the Excel application. + + Parent object of this collection. + Indicates whether read-only collection should be created. + + + + Searches for all necessary parents. + + + + + Defines a new hyperlink. + + Name object to add. + + + + Defines a new hyperlink for the range object. + + Range object. + The type of the hyperlink. + The address of the hyperlink. + The screen tip to be displayed when the mouse pointer is paused over the hyperlink. + Returns hyperlink initialized object. + + + + Defines a new hyperlink. + + shape object to add. + + + + Defines a new hyperlink for the shape object. + + Shape object. + The type of the hyperlink. + The address of the hyperlink. + The screen tip to be displayed when the mouse pointer is paused over the hyperlink. + Returns hyperlink initialized object. + + + + Removes item at the specified index. + + Item index to remove. + + + + Removes hyperlink at the specified index without clearing its format. + + Item index to remove hyperlink. + + + + Adds new hyperlink to the collection. + + Hyperlink to add. + Index in the collection of the new hyperlink. + + + + Creates collection from IList. + + IList with necessary Biff records. + Start offset in the array. + Index of the first record after hyperlinks records. + + + + Saves collection into list of BiffRecords. + + OffsetArrayList with BiffRecords. + + If records parameter is NULL. + + + + + Creates hyperlink styles if necessary. + + + + + Gets collection of hyperlinks for the specified range. + + Range to get hyperlinks for. + Collection of hyperlinks for the specified range. + + + + + + + + + + + + + + + + Gets last hyperlink by cell index. + + Cell index. + Returns Hyper link if contain; otherwise null. + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Removes the specified hyperlink from the collection. + + Hyperlink link object. + + + + Returns single entry from the collection. Read-only. + + + + + Indicates whether collection is in read-only mode. Read-only. + + + + + Suitable Node colors used for 2-3-4 nodes detection. + + + + + Red color of node. + + + + + Black color of node. + + + + + Node class used for proper storing of data in the Map Collection. + + + + + Reference on left branch. + + + + + Reference on right branch. + + + + + Reference on parent branch. + + + + + Color of node branch. + + + + + Is current node Nil element or not? + + + + + Key part of stored in node data. + + + + + Value part of stored in node data. + + + + + Create red colored Tree node. + + Reference on left branch. + Reference on parent branch. + Reference on right branch. + Key value of node. + Value part of node. + + + + Main constructor of class. + + Reference on left branch. + Reference on parent branch. + Reference on right branch. + Key value of node. + Value part of node. + Color of node. + + + + Reference on left branch. + + + + + Reference on right branch. + + + + + Reference on parent branch. + + + + + Color of node branch. + + + + + Is current node Nil element or not? + + + + + Key part of stored in node data. + + + + + Value part of stored in node data. + + + + + Is current node set to red color? + + + + + Is current node set to black color? + + + + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + Create collection with specified comparer for Key values. + + Comparer for key values. + + + + Create Empty node for collection. + + + + + Clear collection. + + + + + Add item into collection. + + Key part. + Value. + + + + Check whether collection contains specified key. + + True if node with specified key is found; otherwise False. + Key for check. + + + + Remove from collection item with specified key. + + Key to identify item. + + + + TODO: place correct comment here + + + TODO: place correct comment here + + + + + Get minimum value for specified branch. + + Branch start node. + Reference on minimum value node. + + + + Get maximum value for specified branch. + + Branch start node. + Reference on maximum value node. + + + + Go to to next item in collection. + + Start node. + Reference on next item in collection or this.Empty if nothing found. + + + + Get previous item from collection. + + Start node. + Reference on previous item in collection. + + + + Find node in collection by key value (search in lower side). + + Key of node to find. + Reference on found node, otherwise this.Empty value. + + + + Find node in collection by key value (search in upper side). + + Key of node to find. + Reference on found node, otherwise this.Empty value. + + + + Rotate branch into left side. + + Branch start node. + + + + Rotate branch into right side. + + Branch start node. + + + + Erase node from collection. + + Item to erase. + + + + Insert item into collection. + + Add into left side of tree or right. + Node for placement. + Key part of node. + Value part of node. + + + + Returns enumerator. + + Returns enumerator of current interface. + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + + + + + + + + + TODO: place correct comment here + + + + + TODO: place correct comment here + + + + + + + + + + A collection of cell comments. Each comment is represented by a + Comment object. + + + + + Adds a to the collection. + + Picture to add. + Picture name. + Added picture. + + This method is only supported in Windows Forms, WPF, ASP.NET and ASP.NET MVC. + + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Get image + System.Drawing.Image image = System.Drawing.Image.FromFile("image.png"); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(image,"Image"); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds to the collection. + + Picture to add. + Picture name. + Image format to use for picture storing. + Added picture. + + This method is only supported in Windows Forms, WPF, ASP.NET and ASP.NET MVC. + + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Get image + System.Drawing.Image image = System.Drawing.Image.FromFile("image.png"); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(image,"Image", ExcelImageFormat.Jpeg); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds from the specified file to the collection. + + Picture file name. + Added picture. + + This method is only supported in Windows Forms, WPF, ASP.NET and ASP.NET MVC. + + + The following code illustrates how to add a from the specified file to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture("Image.png"); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds from the specified file to the collection. + + Picture file name. + Image format to use for picture storing. + Added picture. + + This method is only supported in Windows Forms, WPF, ASP.NET and ASP.NET MVC. + + + The following code illustrates how to add a from the specified file to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture("Image.png", ExcelImageFormat.Jpeg); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds to the collection. + + Top row of a new picture. + Left column. + Image. + Added picture. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Get image + System.Drawing.Image image = System.Drawing.Image.FromFile("image.png"); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(4, 5, image); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds to the collection. + + Top row of a new picture. + Left column. + Image to add. + Image format to use for picture storing. + Added picture. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Get image + System.Drawing.Image image = System.Drawing.Image.FromFile("image.png"); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(4, 5, image, ExcelImageFormat.Jpeg); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds to the collection. + + Top row of a new picture. + Left column. + Stream with the picture. + Added picture. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream + Stream stream = new FileStream("image.png", FileMode.Open); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, stream); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Creates a from the specified svg, its fallback image stream and adds the to the collection. + + Top row of a new picture. + Left column. + Svg with the picture. + The of fallback image. + Added picture. + + To know more about adding images of type SVG to worksheet refer Adding SVG Images. + + + The following code illustrates how to add a created with to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream from svg + Stream svgStream = new FileStream("image.svg", FileMode.Open); + + //Create image stream from png + Stream stream = new FileStream("image.png", FileMode.Open); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, svgStream, stream); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Creates a from the specified svg, its fallback image stream and adds the to the collection with the provided scaling. + + Top row of a new picture. + Left column. + Svg stream with the picture. + The instance of fallback image. + Width scale in percents. + Height scale in percents. + Added picture. + + To know more about adding images of type SVG to worksheet refer Adding SVG Images. + + + The following code illustrates how to add a created with to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream from svg + Stream svgStream = new FileStream("image.svg", FileMode.Open); + + //Create image stream from png + Stream stream = new FileStream("image.png", FileMode.Open); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, svgStream, stream, 50, 50); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds to the collection. + + Top row of a new picture. + Left column. + Stream with the picture. + Image format to use for picture storing. + Added picture. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream + Stream stream = new FileStream("image.png", FileMode.Open); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, stream, ExcelImageFormat.Jpeg); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds a from the Url specified to the collection. + + Top row of the picture to start with. + Left column of the picture to start with. + Bottom row of the picture to end with. + Right column of the picture to end with. + Url of the picture. + Added picture. + + To know more about adding images from web refer Adding Images from External Link. + + + The following code illustrates how to add a from an url specified to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add image + IPictureShape picture = worksheet.Pictures.AddPictureAsLink(1, 1, 5, 7, "https://cdn.syncfusion.com/content/images/company-logos/Syncfusion_Logo_Image.png"); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds to the collection. + + Top row of a new picture. + Left column. + Name of the shape. + Added picture. + + This method is only supported in Windows Forms, WPF, ASP.NET and ASP.NET MVC. + + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(4, 5, "image.png"); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds to the collection. + + Top row of a new picture. + Left column. + Name of the shape. + Image format to use for picture storing. + Added picture. + + This method is only supported in Windows Forms, WPF, ASP.NET and ASP.NET MVC. + + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(4, 5, "image.png", ExcelImageFormat.Jpeg); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds to the collection. + + Top row of a new picture. + Left column. + Bottom row. + Right column. + Image. + Added picture. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Get image + System.Drawing.Image image = System.Drawing.Image.FromFile("image.png"); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, 30, 8, image); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds to the collection. + + Top row of a new picture. + Left column. + Bottom row. + Right column. + Image to add. + Image format to use for picture storing. + Added picture. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Get image + System.Drawing.Image image = System.Drawing.Image.FromFile("image.png"); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, 30, 8, image, ExcelImageFormat.Jpeg); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds to the collection. + + Top row of a new picture. + Left column. + Bottom row. + Right column. + Stream with the picture. + Added picture. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream + Stream stream = new FileStream("image.png", FileMode.Open); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, 30, 8, stream); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds to the collection. + + Top row of a new picture. + Left column. + Bottom row. + Right column. + Stream with the picture. + Image format to use for picture storing. + Added picture. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream + Stream stream = new FileStream("image.png", FileMode.Open); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, 30, 8, stream, ExcelImageFormat.Jpeg); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds to the collection. + + Top row of a new picture. + Left column. + Bottom row. + Right column. + Name of the shape. + Added picture. + + This method is only supported in Windows Forms, WPF, ASP.NET and ASP.NET MVC. + + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, 30, 8, "image.png"); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds to the collection. + + Top row of a new picture. + Left column. + Bottom row. + Right column. + Name of the shape. + Image format to use for picture storing. + Added picture. + + This method is only supported in Windows Forms, WPF, ASP.NET and ASP.NET MVC. + + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, 30, 8, "image.png", ExcelImageFormat.Jpeg); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds to the collection. + + Top row of a new picture. + Left column. + Image. + Width scale in percents. + Height scale in percents. + Added picture. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Get image + System.Drawing.Image image = System.Drawing.Image.FromFile("image.png"); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, image, 50, 50); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds to the collection. + + Top row of a new picture. + Left column. + Image. + Width scale in percents. + Height scale in percents. + Image format to use for picture storing. + Added picture. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Get image + System.Drawing.Image image = System.Drawing.Image.FromFile("image.png"); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, image, 50, 50, ExcelImageFormat.Jpeg); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds to the collection. + + Top row of a new picture. + Left column. + Stream with the picture. + Width scale in percents. + Height scale in percents. + Added picture. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream + Stream stream = new FileStream("image.png", FileMode.Open); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, stream, 50, 50); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds to the collection. + + Top row of a new picture. + Left column. + Stream with the picture. + Width scale in percents. + Height scale in percents. + Image format to use for picture storing. + Added picture. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream + Stream stream = new FileStream("image.png", FileMode.Open); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, stream, 50, 50, ExcelImageFormat.Jpeg); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds to the collection. + + Top row of a new picture. + Left column. + Name of the shape. + Width scale in percents. + Height scale in percents. + Added picture. + + This method is only supported in Windows Forms, WPF, ASP.NET and ASP.NET MVC. + + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, "image.png", 50, 50); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds to the collection. + + Top row of a new picture. + Left column. + Name of the shape. + Width scale in percents. + Height scale in percents. + Image format to use for picture storing. + Added picture. + + This method is only supported in Windows Forms, WPF, ASP.NET and ASP.NET MVC. + + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, "image.png", 50, 50, ExcelImageFormat.Jpeg); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Returns the number of objects in the collection. Read-only Long. + + + The following code illustrates how to access Count property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add pictures + worksheet.Pictures.AddPicture("image.png"); + worksheet.Pictures.AddPicture("image.png"); + + //Get count + Console.Write(worksheet.Pictures.Count); + + //Save and dispose + workbook.SaveAs("Pictures.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + + + + + + Returns a single object from the collection. + + + To know more about changing the dimensions of the added to refer Positioning and Re-Sizing Pictures. + + + The following code illustrates how to access an object in the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add picture + worksheet.Pictures.AddPicture("image.png"); + + //Set picture + IPictureShape picture = worksheet.Pictures[0]; + + //Set dimension + picture.Left = 3; + picture.Top = 3; + picture.Height = 50; + picture.Width = 50; + + //Save and dispose + workbook.SaveAs("Pictures.xlsx"); + workbook.Close(); + } + + + + + + Gets single from the collection. + + Name of the item to get. + Single item from the collection. + + The following code illustrates how to access a object from the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add picture + worksheet.Pictures.AddPicture("image.png"); + + //Set picture + IPictureShape picture = worksheet.Pictures["image"]; + + //Set dimension + picture.Left = 3; + picture.Top = 3; + picture.Height = 50; + picture.Width = 50; + + //Save and dispose + workbook.SaveAs("OLEObjects.xlsx"); + workbook.Close(); + } + + + + + + Default prefix for picture name. + + + + + Parent worksheet. + + + + + Adds picture to the collection. + + Picture to add. + Picture name. + Added picture. + + + + Adds picture to the collection. + + Picture to add. + Picture name. + Image format to use for picture storing. + Added picture. + + + + Adds picture from the specified file. + + Picture file name. + Added picture. + + + + Adds picture from the specified file. + + Picture file name. + Image format to use for picture storing. + Added picture. + + + + Adds image to the collection. + + Top row of a new picture. + Left column. + Image. + Added picture. + + + + Adds image to the collection. + + Top row of a new picture. + Left column. + Image to add. + Image format to use for picture storing. + Added picture. + + + + Adds image to the collection. + + Top row of a new picture. + Left column. + Stream with the picture. + Added picture. + + + + Adds image to the collection. + + Top row of a new picture. + Left column. + Svg stream with the picture. + The instance of fallback image. + Added picture. + + + + Adds image to the collection. + + Top row of a new picture. + Left column. + Svg stream with the picture. + The instance of fallback image. + Width scale in percents. + Height scale in percents. + Added picture. + + + + Adds image from the given external link. + + Top row of the picture to start with. + Left column of the picture to start with. + Bottom row of the picture to end with. + Right column of the picture to end with. + Url of the picture. + Added picture. + + + + Adds image to the collection. + + Top row of a new picture. + Left column. + Stream with the picture. + Image format to use for picture storing. + Added picture. + + + + Adds image to the collection. + + Top row of a new picture. + Left column. + Name of the shape. + Added picture. + + + + Adds image to the collection. + + Top row of a new picture. + Left column. + Name of the shape. + Image format to use for picture storing. + Added picture. + + + + Adds image to the collection. + + Top row of a new picture. + Left column. + Bottom row. + Right column. + Image. + Added picture. + + + + Adds image to the collection. + + Top row of a new picture. + Left column. + Bottom row. + Right column. + Image to add. + Image format to use for picture storing. + Added picture. + + + + Adds image to the collection. + + Top row of a new picture. + Left column. + Bottom row. + Right column. + Stream with the picture. + Added picture. + + + + Adds image to the collection. + + Top row of a new picture. + Left column. + Bottom row. + Right column. + Stream with the picture. + Image format to use for picture storing. + Added picture. + + + + Adds image to the collection. + + Top row of a new picture. + Left column. + Bottom row. + Right column. + Name of the shape. + Added picture. + + + + Adds image to the collection. + + Top row of a new picture. + Left column. + Bottom row. + Right column. + Name of the shape. + Image format to use for picture storing. + Added picture. + + + + Adds image to the collection. + + Top row of a new picture. + Left column. + Image. + Width scale in percents. + Height scale in percents. + Added picture. + + + + Adds image to the collection. + + Top row of a new picture. + Left column. + Image. + Width scale in percents. + Height scale in percents. + Image format to use for picture storing. + Added picture. + + + + Adds image to the collection. + + Top row of a new picture. + Left column. + Stream with the picture. + Width scale in percents. + Height scale in percents. + Added picture. + + + + Adds image to the collection. + + Top row of a new picture. + Left column. + Stream with the picture. + Width scale in percents. + Height scale in percents. + Image format to use for picture storing. + Added picture. + + + + Adds image to the collection. + + Top row of a new picture. + Left column. + Name of the shape. + Width scale in percents. + Height scale in percents. + Added picture. + + + + Adds image to the collection. + + Top row of a new picture. + Left column. + Name of the shape. + Width scale in percents. + Height scale in percents. + Image format to use for picture storing. + Added picture. + + + + + + + + + + + Removes picture from this collection only. + + Picture to remove. + + + + Adds picture to this collection only. + Should be called from Shapes collection only. + + Picture to add. + + + + + + + Can't find parent worksheet. + + + + + Generate Picture name + + + + + Gets single item from the collection. + + Name of the item to get. + Single item from the collection. + + + + Represents range that references invalid worksheet. + + + + + Parent object. + + + + + Application object. + + + + + First row index. + + + + + Last row index. + + + + + First column index. + + + + + Last column index. + + + + + Returns a Range object that represents a range thats offset from the specified range. + + The number of rows (positive, negative, or 0 (zero)) by which the range is to be offset + The number of columns (positive, negative, or 0 (zero)) by which the range is to be offset + + + + + Resizes the specified range + + The number of rows in new range + The number of columns in new range + + + + + Activates a single cell, scroll to it and activates the corresponding sheet. + To select a range of cells, use the Select method. + + True to scroll to the cell + + + + + Creates Subtotal for the corresponding ranges + + GroupBy + ConsolidationFunction + TotalList + + + + Creates SubTotal for the corresponding Ranges + + GroupByGroupBy + ConsolidationFunction + TotalList + Replace exisiting SubTotal + Insert PageBreaks + SummaryBelowData + + + + Creates SubTotal for the corresponding Ranges + + Columns to GroupBy + ConsolidationFunction + TotalList + Replace exisiting SubTotal + Insert PageBreaks + SummaryBelowData + + + + Returns sum of numeric cells in the range. + + + + + Returns sum of numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + + + Returns average of numeric cells in the range. + + + + + Returns average of numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + + + Returns minumum value from numeric cells in the range. + + + + + Returns minumum value from numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + + + Returns maximum value from numeric cells in the range. + + + + + Returns maximum value from numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + + + Trim the empty rows at top and bottom of the range, the empty columns at left and right of the range. + + Returns the range after trim. + + + + Clears the Content, formats, comments based on clear option. + + + + + + Copies the Range to the specified destination Range with copy options and skip blank option. + + Represents the destination Range to copy. + Represents the copy Range options. + Represents the skip blank cells in the source. + Returns the copied Range. + + + + Copies this range into another location using pasteLinkOptions. + + Destination range. + Check to implement the pasteLink option. + Method not implement error. + + + + Creates a threaded comment for the current cell with the specified text. + + Threaded comment text + Optional. The creation time of the threaded comment + Returns the created instance of . + + + + Creates a threaded comment for the current cell with the specified text and author. + + Threaded comment text + The author of the threaded comment text + Optional. The creation time of the threaded comment + Returns the created instance of . + + + + Replaces the string with the specified string value. + + The string to be replaced. + The string to replace all occurrences of oldValue. + + + + Replaces the string with the specified string value based on the given . + + The string to be replaced. + The string to replace all occurrences of oldValue. + Specifies the find options for the oldValue. + + + + Replaces the string with the specified double value. + + The string to be replaced. + The double value to replace all occurrences of oldValue. + + + + Replaces the string with the specified DateTime value. + + The string to be replaced. + The datetime value to replace all occurrences of oldValue. + + + + Replaces the string with the specified array of string values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces the string with the specified array of int values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces the string with the specified array of double values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces the string with the specified datatable. + + The string to be replaced. + Data table with new data. + Indicates whether field name must be shown. + + + + Replaces the string with the specified datacolumn. + + The string to be replaced. + DataColumn with new data. + Indicates whether field name must be shown. + + + + Gets the dependent cells which refer to other cells. + + Returns the dependent cells or null if value was not found. + + + + Gets the dependent cells which refer to other cells. + + Indicates whether to check from other worksheets. + Returns the dependent cells with a specified bool value or null if value was not found. + + + + Gets the precedent cells which are referred by a formula in another cell. + + Returns the precedent cells or null if value was not found. + + + + Gets the precedent cells which are referred by a formula in another cell. + + Indicates whether to check from other worksheets. + Returns the precedent cells with a specified bool value or null if value was not found. + + + + Gets the direct dependent cells which refer to other cells. + + Returns the direct dependent cells or null if value was not found. + + + + Gets the direct dependent cells which refer to other cells. + + Indicates whether to check from other worksheets. + Returns the direct dependent cells with a specified bool value or null if value was not found. + + + + Gets the direct precedent cells which are referred by a formula in another cell. + + Returns the direct precedent cells or null if value was not found. + + + + Gets the direct precedent cells which are referred by a formula in another cell. + + Indicates whether to check from other worksheets. + Returns the direct precedent cells with a specified bool value or null if value was not found. + + + + Returns an enumerator that iterates through the Range. + + + + + + Gets or sets HTML string. + + + + + Returns the calculated value of a formula using the most current inputs. + + + + + Get the threaded comment. + + + + + Filter operator + + + + + Equal operator of filter + + + + + Greater than operator of filter + + + + + Greater of than equal of filter + + + + + Less than filter of filter + + + + + Less than or equal filter + + + + + Not equal filter + + + + + Filter operator + + + + + Equal operator of filter + + + + + Greater than operator of filter + + + + + Greater of than equal of filter + + + + + Less than filter of filter + + + + + Less than or equal filter + + + + + Not equal filter + + + + + Pivot filter type + + + + + Indicates the "begins with" filter for field captions. + + + + + Indicates the "is between" filter for field captions. + + + + + Indicates the "contains" filter for field captions. + + + + + Indicates the "ends with" filter for field captions. + + + + + Indicates the "equal" filter for field captions. + + + + + Indicates the "is greater than" filter for field captions + + + + + Indicates the "is greater than or equal to" filter for field captions. + + + + + Indicates the "is less than" filter for field captions. + + + + + Indicates the "is less than or equal to" filter for field captions. + + + + + Indicates the "does not begin with" filter for field captions. + + + + + Indicates the "is not between" filter for field captions. + + + + + Indicates the "does not contain" filter for field captions. + + + + + Indicates the "does not end with" filter for field captions. + + + + + Indicates the "not equal" filter for field captions. + + + + + Indicates the "Value between" filter for text and numeric values. + + + + + Indicates the "value equal" filter for text and numeric values. + + + + + Indicates the "value greater than" filter for text and numeric values. + + + + + Indicates the "value greater than or equal to" filter for text and numeric values. + + + + + Indicates the "value less than" filter for text and numeric values. + + + + + Indicates the "value less than or equal to" filter for text and numeric values + + + + + Indicates the "value not between" filter for text and numeric values. + + + + + Indicates the "value not equal" filter for text and numeric values. + + + + + Indicates the "count" filter. + + + + + Indicates the "dateNewerThan" filter. + + + + + Indicates the "yearToDate" filter. + + + + + Indicates the "unknown" filter. + + + + + Indicates the "sum" filter. + + + + + Indicates the "percent" filter. + + + + /// + Indicates the "dateEqual" filter. + + + + /// + Indicates the "dateNewerThanOrEqual" filter. + + + + /// + Indicates the "dateBetween" filter. + + + + /// + Indicates the "dateNotBetween" filter. + + + + /// + Indicates the "dateNotEqual" filter. + + + + /// + Indicates the "dateOlderThan" filter. + + + + /// + Indicates the "dateOlderThanOrEqual" filter. + + + + /// + Indicates the "nextMonth" filter. + + + + /// + Indicates the "thisMonth" filter. + + + + /// + Indicates the "lastMonth" filter. + + + + /// + Indicates the "nextYear" filter. + + + + /// + Indicates the "thisYear" filter. + + + + /// + Indicates the "lastYear" filter. + + + + /// + Indicates the "nextWeek" filter. + + + + /// + Indicates the "thisWeek" filter. + + + + /// + Indicates the "lastWeek" filter. + + + + /// + Indicates the "M1" filter. + + + + /// + Indicates the "M2" filter. + + + + /// + Indicates the "M3" filter. + + + + /// + Indicates the "M4" filter. + + + + /// + Indicates the "M5" filter. + + + + /// + Indicates the "M6" filter. + + + + /// + Indicates the "M7" filter. + + + + /// + Indicates the "M8" filter. + + + + /// + Indicates the "M9" filter. + + + + /// + Indicates the "M10" filter. + + + + /// + Indicates the "M11" filter. + + + + /// + Indicates the "M12" filter. + + + + /// + Indicates the "Q1" filter. + + + + /// + Indicates the "Q2" filter. + + + + /// + Indicates the "Q3" filter. + + + + /// + Indicates the "Q4" filter. + + + + /// + Indicates the "nextQuarter" filter. + + + + /// + Indicates the "thisQuarter" filter. + + + + /// + Indicates the "lastQuarter" filter. + + + + /// + Indicates the "tomorrow" filter. + + + + /// + Indicates the "today" filter. + + + + /// + Indicates the "yesterday" filter. + + + + + Filter type + + + + + Indicates the "caption begins with" filter for text and numeric values + + + + + Indicates the "caption between" filter for text and numeric values + + + + + Indicates the "caption contains" filter for text and numeric values + + + + + Indicates the "caption ends with" filter for text and numeric values + + + + + Indicates the "caption equal" filter for field captions. + + + + + Indicates the "caption greater than" filter for field captions. + + + + + Indicates the "caption greater than or equal to" filter for field captions. + + + + + Indicates the "caption less than" filter for field captions. + + + + + Indicates the "caption less than or equal" filter for field captions. + + + + + Indicates the "caption not begins with" filter for field captions. + + + + + Indicates the "caption not between" filter for field captions. + + + + + Indicates the "caption not contains" filter for field captions. + + + + + Indicates the "caption not ends with" filter for field captions. + + + + + Indicates the "Caption not equal" filter for field captions. + + + + + Indicates the "value between" filter for text and numeric values + + + + + Indicates the "value equal" filter for text and numeric values + + + + + Indicates the "value Greater than " filter for text and numeric values + + + + + Indicates the "value greater than or equal to" filter for text and numeric values + + + + + Indicates the "value less than " filter for text and numeric values + + + + + Indicates the "value less than or equal to" filter for text and numeric values + + + + + Indicates the "value not between" filter for text and numeric values. + + + + + Indicates the "value not equal" filter for text and numeric values. + + + + + Indicates the "count" filter. + + + + + + + Indicates the "unknown" filter. + + + + + Indicates the "sum" filter. + + + + + Indicates the "percent" filter. + + + + + /// + Indicates the "dateNewerThanOrEqual" filter. + + + + /// + Indicates the "dateNotBetween" filter. + + + + /// + Indicates the "dateBetween" filter. + + + + /// + Indicates the "dateNotEqual" filter. + + + + /// + Indicates the "dateOlderThan" filter. + + + + /// + Indicates the "dateOlderThanOrEqual" filter. + + + + /// + Indicates the "nextMonth" filter. + + + + /// + Indicates the "thisMonth" filter. + + + + /// + Indicates the "lastMonth" filter. + + + + /// + Indicates the "nextYear" filter. + + + + /// + Indicates the "thisYear" filter. + + + + /// + Indicates the "lastYear" filter. + + + + /// + Indicates the "nextWeek" filter. + + + + /// + Indicates the "thisWeek" filter. + + + + /// + Indicates the "lastWeek" filter. + + + + /// + Indicates the "M1" filter. + + + + /// + Indicates the "M2" filter. + + + + /// + Indicates the "M3" filter. + + + + /// + Indicates the "M4" filter. + + + + /// + Indicates the "M5" filter. + + + + /// + Indicates the "M6" filter. + + + + /// + Indicates the "M7" filter. + + + + /// + Indicates the "M8" filter. + + + + /// + Indicates the "M9" filter. + + + + /// + Indicates the "M10" filter. + + + + /// + Indicates the "M11" filter. + + + + /// + Indicates the "M12" filter. + + + + /// + Indicates the "Q1" filter. + + + + /// + Indicates the "Q2" filter. + + + + /// + Indicates the "Q3" filter. + + + + /// + Indicates the "Q4" filter. + + + + /// + Indicates the "nextQuarter" filter. + + + + /// + Indicates the "thisQuarter" filter. + + + + /// + Indicates the "lastQuarter" filter. + + + + /// + Indicates the "tomorrow" filter. + + + + /// + Indicates the "today" filter. + + + + /// + Indicates the "yesterday" filter. + + + + + Represents Axis types in the pivot table. + + + + + Represents the None axis type. + + + + + Represents the Row axis type. + + + + + Represents the Column axis type. + + + + + Represents the Page axis type. + + + + + Represents the Data axis type. + + + + + Represents Axis types in the pivot table equivalent to Excel 2007. + + + + + Represents the Row axis type. + + + + + Represents the Column axis type. + + + + + Represents the Page axis type. + + + + + Represents the Data axis type. + + + + + Represents the Subtotal types. + + + + + Represents the None type. + + + + + Represents the Default type. + + + + + Represents the Sum type. + + + + + Represents the Counta type. + + + + + Represents the Average type. + + + + + Represents the Max type. + + + + + Represents the Min type. + + + + + Represents the Product type. + + + + + Represents the Count type. + + + + + Represents the Stdev type. + + + + + Represents the Stdevp type. + + + + + Represents the Var type. + + + + + Represents the Varp type. + + + + + Axis types in Excel 2007 file format notation. + + + + + Represents the Average type. + + + + + Represents the Count type. + + + + + Represents the Counta type. + + + + + Represents the Max type. + + + + + Represents the Min type. + + + + + Represents the Product type. + + + + + Represents the Stdev type. + + + + + Represents the Stdevp type. + + + + + Represents the Sum type. + + + + + Represents the Var type. + + + + + Represents the Varp type. + + + + + Axis types in Excel 2007 file format notation. + + + + + Represents the Average type. + + + + + Represents the Count type. + + + + + Represents the Counta type. + + + + + Represents the Max type. + + + + + Represents the Min type. + + + + + Represents the Product type. + + + + + Represents the Stdev type. + + + + + Represents the Stdevp type. + + + + + Represents the Sum type. + + + + + Represents the Var type. + + + + + Represents the Varp type. + + + + + Represent data types for pivot table cache fields. + + + + + Indicates whether field contains number. + + + + + Indicates whether field contains integer numbers. + + + + + Indicates whether field contains strings. + + + + + Indicates whether field contains blank values. + + + + + Indicates whether field contains dates. + + + + + Indicates whether field contains booleans. + + + + + Indicates whether field contains float numbers. + + + + + Indicates whether filed contains long Text. + + + + + Represents pivot table built in styles equivalent to Excel 2007. + + + + + Represents PivotStyleMedium28 style. + + + + + Represents PivotStyleMedium27 style. + + + + + Represents PivotStyleMedium26 style. + + + + + Represents PivotStyleMedium25 style. + + + + + Represents PivotStyleMedium24 style. + + + + + Represents PivotStyleMedium23 style. + + + + + Represents PivotStyleMedium22 style. + + + + + Represents PivotStyleMedium21 style. + + + + + Represents PivotStyleMedium20 style. + + + + + Represents PivotStyleMedium19 style. + + + + + Represents PivotStyleMedium18 style. + + + + + Represents PivotStyleMedium17 style. + + + + + Represents PivotStyleMedium16 style. + + + + + Represents PivotStyleMedium15 style. + + + + + Represents PivotStyleMedium14 style. + + + + + Represents PivotStyleMedium13 style. + + + + + Represents PivotStyleMedium12 style. + + + + + Represents PivotStyleMedium11 style. + + + + + Represents PivotStyleMedium10 style. + + + + + Represents PivotStyleMedium9 style. + + + + + Represents PivotStyleMedium8 style. + + + + + Represents PivotStyleMedium7 style. + + + + + Represents PivotStyleMedium6 style. + + + + + Represents PivotStyleMedium5 style. + + + + + Represents PivotStyleMedium4 style. + + + + + Represents PivotStyleMedium3 style. + + + + + Represents PivotStyleMedium2 style. + + + + + Represents PivotStyleMedium1 style. + + + + + Represents PivotStyleLight28 style. + + + + + Represents PivotStyleLight27 style. + + + + + Represents PivotStyleLight26 style. + + + + + Represents PivotStyleLight25 style. + + + + + Represents PivotStyleLight24 style. + + + + + Represents PivotStyleLight23 style. + + + + + Represents PivotStyleLight22 style. + + + + + Represents PivotStyleLight21 style. + + + + + Represents PivotStyleLight20 style. + + + + + Represents PivotStyleLight19 style. + + + + + Represents PivotStyleLight18 style. + + + + + Represents PivotStyleLight17 style. + + + + + Represents PivotStyleLight16 style. + + + + + Represents PivotStyleLight15 style. + + + + + Represents PivotStyleLight14 style. + + + + + Represents PivotStyleLight13 style. + + + + + Represents PivotStyleLight12 style. + + + + + Represents PivotStyleLight11 style. + + + + + Represents PivotStyleLight10 style. + + + + + Represents PivotStyleLight9 style. + + + + + Represents PivotStyleLight8 style. + + + + + Represents PivotStyleLight7 style. + + + + + Represents PivotStyleLight6 style. + + + + + Represents PivotStyleLight5 style. + + + + + Represents PivotStyleLight4 style. + + + + + Represents PivotStyleLight3 style. + + + + + Represents PivotStyleLight2 style. + + + + + Represents PivotStyleLight1 style. + + + + + Represents PivotStyleDark28 style. + + + + + Represents PivotStyleDark27 style. + + + + + Represents PivotStyleDark26 style. + + + + + Represents PivotStyleDark25 style. + + + + + Represents PivotStyleDark24 style. + + + + + Represents PivotStyleDark23 style. + + + + + Represents PivotStyleDark22 style. + + + + + Represents PivotStyleDark21 style. + + + + + Represents PivotStyleDark20 style. + + + + + Represents PivotStyleDark19 style. + + + + + Represents PivotStyleDark18 style. + + + + + Represents PivotStyleDark17 style. + + + + + Represents PivotStyleDark16 style. + + + + + Represents PivotStyleDark15 style. + + + + + Represents PivotStyleDark14 style. + + + + + Represents PivotStyleDark13 style. + + + + + Represents PivotStyleDark12 style. + + + + + Represents PivotStyleDark11 style. + + + + + Represents PivotStyleDark10 style. + + + + + Represents PivotStyleDark9 style. + + + + + Represents PivotStyleDark8 style. + + + + + Represents PivotStyleDark7 style. + + + + + Represents PivotStyleDark6 style. + + + + + Represents PivotStyleDark5 style. + + + + + Represents PivotStyleDark4 style. + + + + + Represents PivotStyleDark3 style. + + + + + Represents PivotStyleDark2 style. + + + + + Represents PivotStyleDark1 style. + + + + + Represents the data formats for a field in the PivotTable + + + + + Indicates the field is shown as the "difference from" a value. + + + + + Indicates the field is shown as the "index. + + + + + Indicates that the field is shown as its normal data type. + + + + + Indicates the field is show as the "percentage of". + + + + + Indicates the field is shown as the "percentage difference from" a value. + + + + + Indicates the field is shown as the percentage of column. + + + + + Indicates the field is shown as the percentage of row. + + + + + Indicates the field is shown as percentage of total. + + + + + Indicates Percentage of parent total. + + + + + Indicates Percentage of parent column total. + + + + + Indicates Percentage of parent row total. + + + + + Indicates Rank descending. + + + + + Indicates Percentage of running total. + + + + + Indicates the field is shown as running total in the table. + + + + + Indicates Rank ascending. + + + + + Excel 2007 table built in styles. + + + + + Represents TableStyleMedium28 style. + + + + + Represents TableStyleMedium27 style. + + + + + Represents TableStyleMedium26 style. + + + + + Represents TableStyleMedium25 style. + + + + + Represents TableStyleMedium24 style. + + + + + Represents TableStyleMedium23 style. + + + + + Represents TableStyleMedium22 style. + + + + + Represents TableStyleMedium21 style. + + + + + Represents TableStyleMedium20 style. + + + + + Represents TableStyleMedium19 style. + + + + + Represents TableStyleMedium18 style. + + + + + Represents TableStyleMedium17 style. + + + + + Represents TableStyleMedium16 style. + + + + + Represents TableStyleMedium15 style. + + + + + Represents TableStyleMedium14 style. + + + + + Represents TableStyleMedium13 style. + + + + + Represents TableStyleMedium12 style. + + + + + Represents TableStyleMedium11 style. + + + + + Represents TableStyleMedium10 style. + + + + + Represents TableStyleMedium9 style. + + + + + Represents TableStyleMedium8 style. + + + + + Represents TableStyleMedium7 style. + + + + + Represents TableStyleMedium6 style. + + + + + Represents TableStyleMedium5 style. + + + + + Represents TableStyleMedium4 style. + + + + + Represents TableStyleMedium3 style. + + + + + Represents TableStyleMedium2 style. + + + + + Represents TableStyleMedium1 style. + + + + + Represents TableStyleLight21 style. + + + + + Represents TableStyleLight20 style. + + + + + Represents TableStyleLight19 style. + + + + + Represents TableStyleLight18 style. + + + + + Represents TableStyleLight17 style. + + + + + Represents TableStyleLight16 style. + + + + + Represents TableStyleLight15 style. + + + + + Represents TableStyleLight14 style. + + + + + Represents TableStyleLight13 style. + + + + + Represents TableStyleLight12 style. + + + + + Represents TableStyleLight11 style. + + + + + Represents TableStyleLight10 style. + + + + + Represents TableStyleLight9 style. + + + + + Represents TableStyleLight8 style. + + + + + Represents TableStyleLight7 style. + + + + + Represents TableStyleLight6 style. + + + + + Represents TableStyleLight5 style. + + + + + Represents TableStyleLight4 style. + + + + + Represents TableStyleLight3 style. + + + + + Represents TableStyleLight2 style. + + + + + Represents TableStyleLight1 style. + + + + + Represents TableStyleDark11 style. + + + + + Represents TableStyleDark10 style. + + + + + Represents TableStyleDark9 style. + + + + + Represents TableStyleDark8 style. + + + + + Represents TableStyleDark7 style. + + + + + Represents TableStyleDark6 style. + + + + + Represents TableStyleDark5 style. + + + + + Represents TableStyleDark4 style. + + + + + Represents TableStyleDark3 style. + + + + + Represents TableStyleDark2 style. + + + + + Represents TableStyleDark1 style. + + + + + Represents Empty style. + + + + + Element type of Excel Table Style + + + + + Represents the whole table. + + + + + Represents the first column stripe. + + + + + Represents the second column stripe. + + + + + Represents the first row stripe. + + + + + Represents the second row stripe. + + + + + Represents the first column of the table. + + + + + Represents the last column of the table. + + + + + Represents the header row of the table. + + + + + Represents the total row of the table. + + + + + Represents the first cell in the header row of the table. + + + + + Represents the last cell in the header row of the table. + + + + + Represents the first total cell of the table. + + + + + Represents the last total cell of the table. + + + + + sort orders that can be applied to fields in a PivotTable. + + + + + Indicates the field is sorted in ascending order. + + + + + Indicates the field is sorted in descending order. + + + + + Indicates the field is sorted manually. + + + + + This simple type defines the pivot type for a pivotItem. + + + + + Represents the Average. + + + + + Represent the Blank line in the pivot Table. + + + + + Represent the count aggregate functions. + + + + + Represent the count number aggregate functions. + + + + + Represent the data + + + + + Represent the default type of Pivot Table. + (total aggregate is default) + + + + + Represent the grand total. + + + + + Represent the maximum aggregate function. + + + + + Represent the minimum aggregate function. + + + + + Represent the product functions. + + + + + Represents the "standard deviation" aggregate function. + + + + + Represents the "standard deviation population" aggregate function. + + + + + Represents the "sum" aggregate value. + + + + + Represents the "variance" aggregate value. + + + + + Represents the "variance population" aggregate value. + + + + + This simple type defines the Open Xml Pivot type for a pivotItem. + + + + + Represents the Average. + + + + + Represent the Blank line in the pivot Table. + + + + + Represent the count aggregate functions. + + + + + Represent the count number aggregate functions. + + + + + Represent the data. + + + + + Represent the default type of Pivot Table. + (total aggregate is default) + + + + + Represent the grand total. + + + + + Represent the maximum aggregate function. + + + + + Represent the minimum aggregate function. + + + + + Represent the product functions. + + + + + Represents the "standard deviation" aggregate function. + + + + + Represents the "standard deviation population" aggregate function. + + + + + Represents the "sum" aggregate value. + + + + + Represents the "variance" aggregate value. + + + + + Represents the "variance population" aggregate value. + + + + + Represents data grouping that can be performed on a PivotTable. + + + + + Indicates no auto grouping group + + + + + Indicates a grouping on "hours" for date values. + + + + + Indicates a grouping on "minutes" for date values. + + + + + Indicates a grouping on "months" for date values. + + + + + Indicates a grouping on "quarters" for date values + + + + + Indicates a grouping by numeric ranges for numeric values. + + + + + Indicates a grouping on "seconds" for date values. + + + + + Indicates a grouping on "years" for date values. + + + + + Indicates a grouping on "days" for date values. + + + + + Indicates the type of rule being used to describe an area or aspect of the PivotTable. + + + + + Refers to the whole PivotTable. + + + + + Refers to a field button. + + + + + Refers to something in the data area. + + + + + Refers to no Pivot area. + + + + + Refers to a header or item. + + + + + Refers to the blank cells at the top-left of the PivotTable. + + + + + Refers to the blank cells at the top of the PivotTable, + on its trailing edge + + + + + Refers to the blank cells at the top right of the PivotTable, + on its trailing edge + + + + + Represents the scope of conditional formatting applied in the PivotTable. + + + + + Represents that the conditional formatting is applied to the selected data fields. + + + + + Represents that the conditional formatting is applied to the + selected PivotTable field intersections. + + + + + Represents that the conditional formatting is applied to the + selected cells. + + + + + Represents the possible types that defines the values for the Top N conditional formatting evaluation for the PivotTable. + + + + + Represents Top N conditional formatting is evaluated across the entire scope range. + + + + + Represents Top N conditional formatting is evaluated for each column. + + + + + Represents Top N conditional formatting is not evaluated. + + + + + Represents Top N conditional formatting is not evaluated. + + + + + Represents the Page field area order when there are + multiple page fields in the page area + + + + + The page fields are laid, Down then over order. + + + + + The page fields are laid, over then down order. + + + + + Specifies the pivot table row layout. + + + + + Represents compact row. + + + + + Represents outline row. + + + + + Represents tabular row. + + + + + Summary description for PivotCacheFieldsCollection. + + + + + Initializes new instance of the pivot cache fields collection. + + + + + Reads collection records from the BiffReader. + + BiffReader to get records from. + Number of fields to read. + + + + Saves collection as Biff records. + + OffsetArrayList that should get all collection's records. + + + + Adds new field to the collection. + + Field to add. + Index of the newly added field. + + + + + + + + + + + + + + + + + + Gets the pivot cache fields count + + + + + + Gets the pivot cache field + + + + + + + List of info records. + + + + + Default constructor. + + + + + Extracts pivot cache data from the records array. + + List of records to get data from. + Starting index. + + + + Extracts required data from the records list. + + List of records to get data from. + Starting index. + + + + Saves pivot cache info into OffsetArrayList. + + OffsetArrayList to save data into. + + + + Creates a copy of the current object. + + A copy of the current object. + + + + Gets stream id record. + + + + + Gets or sets stream id described by this pivot cache info. + + + + + Represents the collection of memory caches from the PivotTable reports in a workbook. + + + + + Name of sub-storage in input file which contains pivot table cache data. + + + + + Parent workbook. + + + + + Dictionary with pivot caches. Key - cache id, value - cache. + + + + + List with caches order. + + + + + Initializes a new instance of pivot cache collection. + + + Application object that represents the Excel application. + + Parent object of this collection. + + + + Initializes a new instance of pivot cache collection with the specified cache storage and dectyptor. + + + Application object that represents the Excel application. + + Parent object of this collection. + Pivot caches storage. + Object used to decrypt encrypted records. + + + + Parses pivot caches storage. + + Storage to parse. + Object used to decrypt encrypted records. + + + + Clears all the pivot caches from the collection. + + + + + Serializes the pivot cache. + + Storage to serialize into. + Object that is used to encrypt data. + + + + Adds specified cache item to the collection. + + Item to add. + + + + Adds specified cache item to the collection at the specifed index. + + Item to add. + + + + Searches for the first available pivot cache index. + + Cache to search index for. + Found free index. + + + + Adds a new PivotTable cache to a PivotCaches collection. + + Range that contains data to cache. + Returns a pivot cache. + + Following code snippet illustrates how to add a pivot cache. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + // Create Pivot cache with the given data range + IPivotCache cache = workbook.PivotCaches.Add(worksheet["A1:H50"]); + + + + + + Adds new cache to the collection. + + Name of the stream. + Cache object to add. + + + + Checks whether cache exist in the collection and adds its copy if necessary. + + + + + + + + Removes the Pivot cache from the collection at the specified index. + + + + + + Get Cache indexes + + cache indexes + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Searches for the parent workbook. + + Parent workbook to start searching from. + Found workbook. + + + + Gets the IEnumerable list of pivot cache elements. + + + + + + Returns single entry of pivot cache from the collection. Read-only. + + Item id to return. + An entry from the collection. + + + + Gets a pivot cache with the specified index from the collection. Read-only. + + Zero-based index of the cache to return. + + + + Gets number of pivot cache items in the collection. Read-only. + + + + + Gets the application object. Read-only. + + + + + Gets the parent object. Read-only. + + + + + Gets the ordered list of pivot caches. Read-only. + + + + + Represents pivot table data field. + + + + + Default value for base item previous. + + + + + Default value for base item next. + + + + + Name of the data field. + + + + + Subtotal function used for data field. + + + + + Base field. + + + + + + + + + + + + + + + + + + + + + + + + + Extended view fields record. + + + + + Initializes a new instance of the data field. + + Name of the data field. + Subtotal function. + Parent field. + + + + Set the previous value to BaseItem. + + + + + Set the next value to BaseItem. + + + + + Initializes the show data. + + + + + Initializes the excel2010 data. + + + + + Sets the show data. + + The value. + + + + + Gets the show data. + + The value. + + + + + Determines whether [is excel2010 data]. + + + true if [is excel2010 data]; otherwise, false. + + + + + Creates a new object that is a copy of the current instance. + + Represents parent object. + A new object that is a copy of this instance. + + + + Gets or sets name of the data field. + + + + + Gets or sets the subtotal function used for data field. + + + + + Gets the parent field. Read-only. + + + + + Gets or sets number format index for the pivot data field. + + + + + Gets or sets the number format for the pivot data field. + + + + + Gets or sets the pivot table format indicating how the pivot data is shown. + + + + + Gets or sets the base item for a custom calculation. + + Valid only for data fields. + + + + Gets or sets the base field for a custom calculation. + + Valid only for data fields. + + + + Represents pivot table data fields collection. + + + + + Initializes new instance of pivot table data fields collection. + + Application object for the new instance. + Parent object for the new instance. + + + + Adds a new data field to the PivotDataField collection. + + The parent field to use. + The name for the new data field. + The subtotal function for the new data field. + Returns a pivot data field. + + Following code snippet illustrates how to add a pivot data field to the pivot table. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + // Create Pivot cache with the given data range + IPivotCache cache = workbook.PivotCaches.Add(worksheet["A1:H50"]); + //Create "PivotTable1" with the cache at the specified range + IPivotTable pivotTable = worksheet.PivotTables.Add("PivotTable1", worksheet["A1"], cache); + //Add Pivot table fields (Row and Column fields) + pivotTable.Fields[2].Axis = PivotAxisTypes.Row; + pivotTable.Fields[6].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + + //Add data field + IPivotField field = pivotTable.Fields[5]; + pivotTable.DataFields.Add(field, "Sum", PivotSubtotalTypes.Sum); + + + + + + Gets a pivot data field with the specified index from the collection. Read-only. + + Zero-based index of the data field to return. + + + + Gets a with the specified name from the collection. Read-only. + + Pivot data field name + + The following code illustrates how to get the pivot table data field by data field name. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["D1"].Text = "Student City"; + sheet.Range["A1:D1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + sheet.Range["D2"].Text = "Chennai"; + sheet.Range["D3"].Text = "Bangalore"; + sheet.Range["D4"].Text = "Chennai"; + sheet.Range["D5"].Text = "Mysore"; + sheet.Range["D6"].Text = "Bangalore"; + IPivotCache cache = workbook.PivotCaches.Add(sheet["A1:D6"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[1].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotTable.Fields[2]; + pivotTable.DataFields.Add(datafield, "Sum of Marks", PivotSubtotalTypes.Sum); + + //Gets a pivot data field with the specified name from the collection + IPivotDataField pivotDataField = pivotTable.DataFields["Sum of Marks"]; + pivotDataField.Name = "SUM Marks"; + pivotDataField.Subtotal = PivotSubtotalTypes.Average; + + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleMedium20; + workbook.SaveAs("PivotTables.xlsx"); + workbook.Close(); + } + + + + + + Represents a collection of pivot fields in the pivot table. + + + + + Initializes a new instance of pivot fields collection. + + + + + + + Initializes new instance of the pivot fields collection with the specified parent pivot table.. + + Parent table. + + + + Adds new field based on the cached field. + + Base cache field. + Parent workbook. + + + + Creates a copy of this collection. + + New parent for the created object. + + + + + Gets the pivot field from the collection with the specified index. Read-only. + + Item index to return. + + + + Gets the pivot field from the collection with the specified name. Read-only. + + Name of the item to return. + + + + Represents collection of in the worksheet. + + + + + Initializes a new instance of PivotTableCollection. + + + Application object that represents the Excel application. + + Parent object of this collection. + + + + Parses collection of pivot tables. + + Records with pivot table data. + Offset to the first pivot table record. + Offset to the record after + + + + Saves the collection of pivot tables into OffsetArrayList. + + OffsetArrayList that will get all collection's records. + + + + Adds specified table to the collection. + + Table to add. + + + + Adds a pivot table to the collection. + + Name of the pivot table. + Pivot table location. + Pivot cache of the pivot table. + Returns the pivot table object. + + Following code snippet illustrates how to add a pivot table. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + // Create Pivot cache with the given data rangeS + IPivotCache cache = workbook.PivotCaches.Add(worksheet["A1:H50"]); + //Create "PivotTable1" with the cache at the specified range + IPivotTable pivotTable = worksheet.PivotTables.Add("PivotTable1", worksheet["A1"], cache); + + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Creates copy of the current collection. + + Parent worksheet for the new collection. + Created collection. + + + + Removes pivot table with specified name from this collection. + + Name of the pivot table to remove. + + + + Removes a pivot table with the specified index from this collection. + + Index of the pivot table to remove. + + + + Cleans the cache and worksheet data before remove the Pivot Table + + pivot Table to remove + + + + Clears the pivot table without checks the pivot caches. + + + + + Returns the IEnumerable list of pivot tables in the worksheet. + + + + + + Gets a pivot table from the collection with the specified index. + + Zero-based index of the pivot table. + + + + Gets a pivot table from the collection with the specified name. + + Name of the pivot table. + + + + Gets the parent worksheet of this collection. Read-only. + + + + + Summary description for RangesCollection. + + + + + Represents a collection of ranges. + + + + + Adds new range to the collection. + + Range to add. + + + + Removes range from the collection. + + Range to remove. + + + + Returns the Range by index from the collection. + + + + + Error message for wrong worksheet exception. + + + + + Initilize object for HtmlStringParser. + + + + + Parent worksheet. + + + + + One-based first row index. + + + + + One-based first column index. + + + + + One-based last row index. + + + + + One-based last column index. + + + + + Rich text string. + + + + + Creates new instance of RangesCollection. + + Application object. + Parent object. + + + + Searches for all necessary parents of this collection. + + + If can't find parent of some class. + + + + + Activates a single cell, which must be inside the current selection. + To select a range of cells, use the Select method. + + + + + + Activages a single cell, scroll to it and activates the respective sheet + To select a range of cells, use the Select method. + + True to scroll to the cell + + + + + This method groups current range. + + + This parameter specifies whether the grouping should + be performed by rows or by columns. + + Current range after grouping. + + + + This method groups current range. + + + This parameter specifies whether grouping should + be performed by rows or by columns. + + Indicates whether group should be collapsed. + Current range after grouping. + + + + Creates Subtotal for the corresponding ranges + + GroupBy + ConsolidationFunction + TotalList + + + + Creates SubTotal for the corresponding Ranges + + GroupByGroupBy + ConsolidationFunction + TotalList + Replace exisiting SubTotal + Insert PageBreaks + SummaryBelowData + + + + Creates SubTotal for the corresponding Ranges + + Columns to GroupBy + ConsolidationFunction + TotalList + Replace exisiting SubTotal + Insert PageBreaks + SummaryBelowData + + + + Returns sum of numeric cells in the range. + + + + + Returns sum of numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + + + Returns average of numeric cells in the range. + + + + + Returns average of numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + + + Returns minumum value from numeric cells in the range. + + + + + Returns minumum value from numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + + + Returns maximum value from numeric cells in the range. + + + + + Returns maximum value from numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + + + Trim the empty rows at top and bottom of the range, the empty columns at left and right of the range. + + Returns the range after trim. + + + + Creates a merged cell from the specified Range object. + + + + + Creates a merged cell from the specified Range object. + + Indicates whether to clear unnecessary cells. + + + + Ungroups current range. + + + Indicates type of ungrouping. Ungroup by columns or by rows. + + Current range after ungrouping. + + + + Separates a merged area into individual cells. + + + + + Freezes pane at the current range. + + + + + Clear the contents of the Range. + + + + + Clear the contents of the Range with formatting. + + True if formatting should also be cleared. + + + + Clears the cell based on clear options. + + + + + + Clear the contents of the Range and shifts the cells Up or Left + without formula or merged ranges update. + + Cells shift direction Up/Left. + + + + Clear the contents of the Range and shifts the cells Up or Left. + + Cells shift direction Up/Left. + Cells shifting options. + + + + Moves the cells to the specified Range (without updating formulas). + + Destination Range. + + + + Copies the range to the specified destination Range (without updating formulas). + + Destination range. + Range were this range was copied. + + + + Copies this range into another location. + + Destination range. + Copy range options. + Destination range. + + + + Copies the Range to the specified destination Range with copy options. + + Represents the destination Range to copy. + Represents if the pasteLinkOptions implement or not . + Returns the copied Range. + + The following code illustrates how to copy the Range with pasteLink options. + + ExcelEngine engine = new ExcelEngine(); + IApplication application = engine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + IRange sourceRange1 = sheet.Range["A1:A3"]; + IRange sourceRange2 = sheet.Range["A5"]; + IRange sourceRange3 = sheet.Range["A8:A10"]; + IRange sourceRange4 = sheet.Range["A12:A16"]; + IRange sourceRange5 = sheet.Range["A22:A30"]; + IRange sourceRange6 = sheet.Range["A35:A37"]; + IRange sourceRange7 = sheet.Range["A38"]; + IRanges sourceRanges = sheet.CreateRangesCollection(); + sourceRanges.Add(sourceRange1); + sourceRanges.Add(sourceRange2); + sourceRanges.Add(sourceRange3); + sourceRanges.Add(sourceRange4); + sourceRanges.Add(sourceRange5); + sourceRanges.Add(sourceRange6); + sourceRanges.Add(sourceRange7); + IRange destination = sheet.Range["C1"]; + // Copy range as link from source to destination + sourceRanges.CopyTo(destination, true); + workbook.Version = ExcelVersion.Excel2013; + workbook.SaveAs("CopyRange.xlsx"); + workbook.Close(); + engine.Dispose(); + + + + + + Checks and copies multiple source ranges into one destination for PasteLink and SkipBlank + + Represents the destination Range to copy. + Represents if the pasteLinkOptions implement or not . + Represents the copy Range options. + Represents the skip blank cells in the source. + + + + Copies the Range to the specified destination Range with copy options and skip blank option. + + Represents the destination Range to copy. + Represents the copy Range options. + Represents the skip blank cells in the source. + Returns the copied Range. + + + + Returns intersection of this range with the specified one. + + The Range with which to intersect. + Range intersection; if there is no intersection, NULL is returned. + + + + Returns merge of this range with the specified one. + + The Range to merge with. + Merged ranges or NULL if wasn't able to merge ranges. + + + + Returns a Range object that represents a range thats offset from the specified range. + + The number of rows (positive, negative, or 0 (zero)) by which the range is to be offset + The number of columns (positive, negative, or 0 (zero)) by which the range is to be offset + + + + + Resizes the specified range + + The number of rows in new range + The number of columns in new range + + + + + Autofits all rows in the range. + + + + + Autofits all columns in the range. + + + + + Adds comment to the range. + + Range's comment. + + + + This method searches for the first cell with specified string value. + + Value to search. + Type of value to search. + First found cell, or Null if value was not found. + + + + This method searches for the first cell with specified double value. + + Value to search. + Type of value to search. + First found cell, or Null if value was not found. + + + + This method searches for the first cell with specified bool value. + + Value to search. + First found cell, or Null if value was not found. + + + + This method searches for the first cell with specified DateTime value. + + Value to search. + First found cell, or Null if value was not found. + + + + This method searches for the first cell with specified TimeSpan value. + + Value to search. + First found cell, or Null if value was not found. + + + + This method searches for the all cells with specified DateTime value. + + Value to search. + All found cells, or Null if value was not found. + + + + This method searches for the all cells with specified TimeSpan value. + + Value to search. + All found cells, or Null if value was not found. + + + + This method searches for the all cells with specified string value. + + Value to search. + Type of value to search. + All found cells, or Null if value was not found. + + + + This method searches for the all cells with specified double value. + + Value to search. + Type of value to search. + All found cells, or Null if value was not found. + + + + This method searches for the all cells with specified bool value. + + Value to search. + All found cells, or Null if value was not found + + + + Replaces the string with the specified string value. + + The string to be replaced. + The string to replace all occurrences of oldValue. + + + + Replaces the string with the specified string value based on the given . + + The string to be replaced. + The string to replace all occurrences of oldValue. + Specifies the find options for the oldValue. + + + + Replaces the string with the specified double value. + + The string to be replaced. + The double value to replace all occurrences of oldValue. + + + + Replaces the string with the specified DateTime value. + + The string to be replaced. + The datetime value to replace all occurrences of oldValue. + + + + Replaces the string with the specified array of string values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces the string with the specified array of int values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces the string with the specified array of double values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces the string with the specified datatable. + + The string to be replaced. + Data table with new data. + Indicates whether field name must be shown. + + + + Replaces the string with the specified datacolumn. + + The string to be replaced. + DataColumn with new data. + Indicates whether field name must be shown. + + + + Copies range to the clipboard. + + + + + Sets around border for current range. + + + + + Sets around border for current range. + + Represents border line. + + + + Sets around border for current range. + + Represents border line. + Represents border color. + + + + Sets around border for current range. + + Represents border line. + Represents border color as ExcelKnownColors. + + + + Sets inside border for current range. + + + + + Sets inside border for current range. + + Represents border line. + + + + Sets inside border for current range. + + Represents border line. + Represents border color. + + + + Sets inside border for current range. + + Represents border line. + Represents border color as ExcelKnownColors. + + + + Sets none border for current range. + + + + + Collapses current group. + + + This parameter specifies whether the grouping should be performed by rows or by columns. + + + + + Expands current group. + + + This parameter specifies whether the grouping should be performed by rows or by columns. + + + + + Expands current group. + + + This parameter specifies whether the grouping should be performed by rows or by columns. + + Additional option flags. + + + + Gets the dependent cells which refer to other cells. + + Returns the dependent cells or null if value was not found. + The following code illustrates how to get the dependent cells from the worksheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetDependents(); + + string fileName = "Dependents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the dependent cells which refer to other cells. + + Indicates whether to check from other worksheets. + Returns the dependent cells with a specified bool value or null if value was not found. + The following code illustrates how to get the dependents cells from all the worksheets. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetDependents(true); + + string fileName = "Dependents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the precedent cells which are referred by a formula in another cell. + + Returns the precedent cells or null if value was not found. + The following code illustrates how to get the precedent cells from the worksheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetPrecedents(); + + string fileName = "Precedents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the precedent cells which are referred by a formula in another cell. + + Indicates whether to check from other worksheets. + Returns the precedent cells with a specified bool value or null if value was not found. + The following code illustrates how to get the precedent cells from all the worksheets. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetPrecedents(true); + + string fileName = "Precedents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the direct dependent cells which refer to other cells. + + Returns the direct dependent cells or null if value was not found. + The following code illustrates how to get the direct dependent cells from the worksheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetDirectDependents(); + + string fileName = "Dependents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the direct dependent cells which refer to other cells. + + Indicates whether to check from other worksheets. + Returns the direct dependent cells with a specified bool value or null if value was not found. + The following code illustrates how to get the direct dependents cells from all the worksheets. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetDirectDependents(true); + + string fileName = "Dependents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the direct precedent cells which are referred by a formula in another cell. + + Returns the direct precedent cells or null if value was not found. + The following code illustrates how to get the direct precedent cells from the worksheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetDirectPrecedents(); + + string fileName = "Precedents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the direct precedent cells which are referred by a formula in another cell. + + Indicates whether to check from other worksheets. + Returns the direct precedent cells with a specified bool value or null if value was not found. + The following code illustrates how to get the direct precedent cells from all the worksheets. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetDirectPrecedents(true); + + string fileName = "Precedents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the dependent cells which refer to other cells. + + Indicates whether to check from other worksheets. + Returns the dependent cells with a specified bool value or null if value was not found. + + + + Gets the precedent cells which are referred by a formula in another cell. + + Indicates whether to check from other worksheets. + Returns the precedent cells with a specified bool value or null if value was not found. + + + + Add the range array to result cell collection. + + Precedents/Dependents cells collection. + Precedents/Dependents cell array for single range. + + + + Creates a threaded comment for the current cell with the specified text. + + Threaded comment text + Optional.The creation time of the threaded comment + Returns the created instance of . + + + + Creates a threaded comment for the current cell with the specified text and author. + + Threaded comment text + The author of the threaded comment text + Optional.The creation time of the threaded comment + Returns the created instance of . + + + + Set Style Name for the range collection. + + CellStyleName to be set + + + + Gets new address of range. + + Dictionary with Worksheet names. + String that sets as a worksheet name. + Returns string with new name. + + + + Clones current IRange. + + Parent object. + Dictionary with new names. + Parent workbook. + Returns clone of current instance. + + + + Clears conditional formats. + + + + + Clears conditional formats. + + + + + Returns array that contains information about range. + + Rectangles that describes range + + + + Returns number of rectangles returned by GetRectangles method. + + Number of rectangles returned by GetRectangles method. + + + + Adds new range to the collection. + + Range to add. + + + + Adds range to the collection. + + Range to add. + + + + Removes range from the collection. + + Range to remove. + + + + Evaluates dimensions of the ranges collection. + + + + + Returns SortedListEx that describes used rows / columns. + + Indicates whether information about columns should be returned. + SortedListEx that describes used rows / columns. + + + + Adds new element to the list of used rows / columns. + + List to add entry to. + Row / column index. + Entry to add. + + + + Adds new element to the list of used rows / columns. + + List to add entry to. + Row / column index. + Start index of the new entry. + End index of the new entry. + + + + + + + + + + + Returns array of used rows / columns. + + Indicates whether columns array should be returned. + Array of used rows / columns. + + + + Checks whether collection is disposed. + + + + + + + + + + + Gets ptg of current range. + + Returns native ptg. + + + + Returns an IEnumerator + + + + + + Gets or sets HTML string. + + + + + Returns the range reference in the language of the macro. + Read-only String. + + + + + Returns the range reference for the specified range in the language + of the user. Read-only String. + + + + + Returns the range reference in the language of the macro. + Read-only String. + + + + + Returns the range reference in the language of the macro using R1C1-style reference. + Read-only String. + + + + + Returns the range reference for the specified range in the language + of the user using R1C1 style reference . Read-only String. + + + + + Gets / sets boolean value that is contained by this range. + + + + + Returns a Borders collection that represents the borders of a style + or a range of cells (including a range defined as part of a + conditional format). + + + + + Returns a Range object that represents the cells in the specified range. + For big number of ranges can be very slow operation. Read-only. + + + + + Returns the number of the first column in the first area in the specified + range. Read-only. + + + + + Column group level. Read-only. + -1 - Not all columns in the range have same group level. + 0 - No grouping, + 1 - 7 - Group level. + + + + + Returns or sets the width of all columns in the specified range. + Read/write Double. + + + + + Returns the number of objects in the collection. Read-only. + + + + + Gets / sets DateTime contained by this cell. Read-write DateTime. + + + + + Returns cell value after number format application. Read-only. + + + + + Returns a Range object that represents the cell at the end of the + region that contains the source range. + + + + + Returns a Range object that represents the entire column (or + columns) that contains the specified range. Read-only. + + + + + Returns a Range object that represents the entire row (or + rows) that contains the specified range. Read-only. + + + + + Gets / sets error value that is contained by this range. + + + + + Returns or sets the object's formula in A1-style notation and in + the language of the macro. Read/write Variant. + + + + + Returns or sets the object's formula in R1C1-style notation and in + the language of the macro. Read/write Variant. + + + + + Represents array-entered formula. + Visit http://www.cpearson.com/excel/array.htm for more information. + + + + + Returns or sets the array-entered formula in R1C1-style notation and in + the language of the macro. Read/write Variant. + + + + + True if the formula will be hidden when the worksheet is protected. + False if at least part of formula in the range is not hidden. + + + + + Get / set formula DateTime value contained by this cell. + DateTime.MinValue if not all cells of the range have same DateTime value. + + + + + Indicates whether specified range object has data validation. + If Range is not single cell, then returns true only if all cells have data validation. Read-only. + + + + + Indicates whether range contains bool value. Read-only. + + + + + Indicates whether range contains DateTime value. Read-only. + + + + + Indicates if current range has formula bool value. Read-only. + + + + + Indicates if current range has formula error value. Read-only. + + + + + Indicates if current range has formula value formatted as DateTime. Read-only. + + + + + Gets whether the range has formula number value + + + + + Gets whether the range has formula string value + + + + + True if all cells in the range contain formulas; False if + at least one of the cells in the range doesn't contain a formula. + Read-only Boolean. + + + + + Indicates whether range contains array-entered formula. Read-only. + + + + + Indicates whether the range contains number. Read-only. + + + + + Indicates whether cell contains formatted rich text string. + + + + + Indicates whether the range contains String. Read-only. + + + + + Indicates whether range has default style. False means default style. + Read-only. + + + + + Returns or sets the horizontal alignment for the specified object. + Read/write ExcelHAlign. + + + + + Returns hyperlinks for this ranges collection. + + + + + Returns or sets the indent level for the cell or range. Can be an integer + from 0 to 15 for Excel 97-2003 and 250 for Excel 2007. Read/write Integer. + + + + + Indicates whether the range is blank. Read-only. + + + + + Indicates whether range contains boolean value. Read-only. + + + + + Indicates whether range contains error value. + + + + + Indicates whether this range is grouped by column. Read-only. + + + + + Indicates whether this range is grouped by row. Read-only. + + + + + Indicates whether cell is initialized. Read-only. + + + + + Returns last column of the range. Read-only. + + + + + Returns last row of the range. Read-only. + + + + + Gets / sets double value of the range. + + + + + Format of current cell. Analog of Style.NumberFormat property. + + + + + Returns the number of the first row of the first area in + the range. Read-only Long. + + + + + Row group level. Read-only. + -1 - Not all rows in the range have same group level. + 0 - No grouping, + 1 - 7 - Group level. + + + + + Returns the height of all the rows in the range specified, + measured in points. Returns Double.MinValue if the rows in the specified range + aren't all the same height. Read / write Double. + + + + + For a Range object, returns an array of Range objects that represent the + rows in the specified range. + + + + + For a Range object, returns an array of Range objects that represent the + columns in the specified range. + + + + + Returns a Style object that represents the style of the specified + range. Read/write IStyle. + + + + + Returns name of the Style object that represents the style of the specified + range. Read/write String. + + + + + Gets / sets string value of the range. + + + + + Gets / sets time value of the range. + + + + + Returns or sets the value of the specified range. + Read/write Variant. + + + + + Returns the calculated value of a formula using the most current inputs. + + + + + Returns or sets the cell value. Read/write Variant. + The only difference between this property and the Value property is + that the Value2 property doesn't use the Currency and Date data types. + + + + + Returns or sets the vertical alignment of the specified object. + Read/write ExcelVAlign. + + + + + Returns a Worksheet object that represents the worksheet + containing the specified range. Read-only. + + + + + Gets / sets cell by row and index. + + + + + Get cell range. + + + + + Get cell range. + + + + + Gets cell range. Read-only. + + + + + Collection of conditional formats. + + + + + Data validation for the range. + + + + + + + + + + + + + + + Returns the calculated value of the formula as a boolean. + + + + + Returns the calculated value of the formula as a string. + + + + + Comment assigned to the range. Read-only. + + + + + Get the threaded comment. + + + + + String with rich text formatting. Read-only. + + + + + Indicates whether this range is part of merged range. Read-only. + + + + + Returns a Range object that represents the merged range containing + the specified cell. If the specified cell isn�t in a merged range, + this property returns NULL. Read-only. + + + + + True if Microsoft Excel wraps the text in the object. + Read/write Boolean. + + + + + Indicates is current range has external formula. Read-only. + + + + + Represents ignore error options. If not single cell returs concatenateed flags. + + + + + Indicates whether all values in the range are preserved as strings. + + + + + Gets/sets built in style. + + + + + Gets address global in the format required by Excel 2007. + + + + + Number of cells in the range. Read-only. + + + + + Gets name of the parent worksheet. + + + + + Returns item by index from the collection. + + + + + Implements a two-dimensional table that holds an SFArrayList of rows. Each row + is an SFArrayList of objects. + + +

This is a memory efficient way to represent a table where values can remain empty. Only rows + that actually contain data will allocate an SFArrayList and the array only holds + as many objects as the specific row contains columns.

+

When you access data that are out of range, an empty () object will be returned. + If you set data that are out of range, an exception will be thrown. If you set data for + a row that is empty, the row will be allocated before the value is stored.

+

SFTable provides methods that let you insert, remove or rearrange columns or m_arrRows + in the table.

+ + + + + Number of m_arrRows in the collection. + + + + + Collection of rows. + + + + + First created row. + + + + + Last created row. + + + + + Indicates whether object was disposed. + + + + + This array contains all shared formulas found during parsing. + + + + + Parent workbook. + + + + + Parent worksheet. + + + + + Initializes a new instance of the + class. + + + Initializes a new instance of the + class that is empty. + + Number of rows in the collection. + Parent worksheet object. + + + + Initializes a new instance of the + class and optional copies of data from an existing table. + + Represents record table data. + Indicates is clone. + Parent worksheet object. + + + + + + + + + Object finalizer. + + + + + Creates a deep copy of the . + + + A deep copy of the . + + + + + Creates a deep copy of the . + + Parent worksheet object. + + A deep copy of the . + + + + + Removes all elements from the . + + + + + Creates a collection of cells for a row. + + Zero-based row index. + Row height. + Excel version. + An SFArrayList or derived object for the cell collection. + + + + Indicates whether an element is at the specified coordinates in the . + + The zero-based row index. + The zero-based column index. + + + if an element exists at the specified coordinates in the ; + otherwise. + + + + + Extracts Array record from the collection. + + Cell that contains array-entered formula. + ArrayRecord if there is one; null if cell doesn't contain array-entered formula. + + + + Updates first and last row indexes. + + Zero-based index of the created row. + + + + Sets row. + + Zero-based row index to set. + Row object to set. + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + Removes last column from the worksheet. + + Zero-based column index. + + + + Removes row from the worksheet. + + Zero-based row index to remove. + + + + Updates indexes to named ranges. + + Parent workbook. + New indexes. + + + + Updates indexes to named ranges. + + Parent workbook. + New indexes. + + + + Replaces all shared formula with ordinary formula. + + + + + + Replaces all shared formula with ordinary formula. + + + + + Updates string indexes. + + List with new indexes. + + + + Copies cells from another worksheet. + + Source cells collection to copy cells from. + Source SST dictionary. + Destination SST dictionary. + Dictionary with new extended format indexes. + Dictionary with new worksheet names. + Dictionary with new name indexes. + Dictionary with new font indexes. + + + + Returns found values or null. + + Storage range. + Value for finding. + If true - finds first value; otherwise - all values. + If findfirst - true then returns range; otherwise - array with all found values. + Parent workbook. + + + + + Returns found values or null. + + Storage range. + Value to find. + If true - finds first value; otherwise - all values. + Way to find the value. + If findfirst - true then returns range; otherwise - array with all found values. + The book. + + List with cell indexes that contains specified value. + + + + + Returns found values or null. + + Storage range. + Value for finding. + If true - finds first value; otherwise - all values. + If findfirst - true then returns range; otherwise - array with all found values. + Parent workbook. + + + + + Returns found values or null. + + Storage range. + Value for finding. + Indicates whether we should look for error code or boolean value. + If findfirst - true then returns range; otherwise - array with all found values. + Parent workbook. + + + + + Returns minimum used column. + + Start row. + End row. + Minimum used column. + + + + Returns maximum used column. + + Start row. + End row. + Maximum used column. + + + + Determines whether collection contains row. + + Zero-based row index. + True if the collection contains at least one element with specified row index; otherwise, False. + + + + + + + + + + Caches and removes specified rectangle from the table. + + Source rectangle. + Row delta to add to the resulting table. + Column delta to add to the resulting table. + Output maximum zero-based row index. + Output maximum zero-based column index. + Boolean flag to indicate if a row is moved or inserted. + Cached table. + + + + This method should be called immediately after extended format removal. + + Dictionary with updated extended formats. + + + + This method should be called immediately after extended format removal. + + Array with updated extended formats. + + + + This method updates indexes to the extended formats after version change. + + New restriction for maximum possible XF index. + + + + Updates LabelSST indexes after SST record parsing. + + Dictionary with indexes to update, key - old index, value - new index. + + + + Extracts ranges from the reader. + + Reader to extract ranges from. + Indicates whether to ignore styles. + SSTDictionary of the parent workbook. + Parent worksheet. + Object used to decrypt encrypted records. + + + + Adds shared formula to record table. + + Row index of the cell containing shared formula description. + Column index of the cell containing shared formula description. + Shared formula record to add. + + + + Extracts ranges from the reader. + + Index record + Reader to extract ranges from. + Indicates whether to ignore styles. + SSTDictionary of the parent workbook. + Parent worksheet. + True if parsing was succeeded (this doesn't guarantees records correctness). + + + + Returns row from the collection or creates one if necessary. + + Zero-based row index. + Row height. + Indicates whether to create row if it doesn't exist. + Excel version. + Desired row object. + + + + Ensures that array will be able to handle desired number of rows. + + + + + + + + + + + + + + + + + + + + True if parsing succeeded (this doesn't guarantee data correctness). + + + + Fills RowRecord with data from the stream. + + RowRecord to fill. + Stream to read data from. + Temporary buffer. + Data provider that gives additional access to the temporary buffer. + Record length. + + + + Reads RowStorage data from the stream. + + Corresponding RowRecord. + Stream to read data from. + Size of the data to read. + Temporary buffer. + Strings shared table which can be updated during parsing. + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + Gets bool value by row or column indexes. Without check input parameters. + + One based row index. + One based column index. + If found - returns value; otherwise - 0. + + + + Gets formula bool value by row or column indexes. Without check input parameters. + + One based row index. + One based column index. + If found - returns value; otherwise - 0. + + + + Gets error value by row or column indexes. Without check input parameters. + + One based row index. + One based column index. + If found - returns value; otherwise - null. + + + + Gets the error value. + + The value. + The i row. + + + + + Gets formula error value by row or column indexes. Without check input parameters. + + One based row index. + One based column index. + If found - returns value; otherwise - null. + + + + Gets number value by row or column indexes. Without check input parameters. + + One based row index. + One based column index. + If found - returns value; otherwise - double.NaN. + + + + Gets formula number value by row or column indexes. Without check input parameters. + + One based row index. + One based column index. + If found - returns value; otherwise - double.NaN. + + + + Gets string value by row or column indexes. Without check input parameters. + + One based row index. + One based column index. + Represents sst dictionary. + If found - returns value; otherwise - null. + + + + Gets string value by row or column indexes. Without check input parameters. + + One based row index. + One based column index. + Represents sst dictionary. + If found - returns value; otherwise - null. + + + + Gets array of formula ptg. + + One based row index. + One based column index. + If found - returns ptg array; otherwise - null. + + + + Indicates if there is formula record. + + One based row index. + One based column index. + Indicates whether formula record is contained. + + + + Indicates is contain formula array. + + Zero based row index. + Zero based column index. + If found return true; otherwise - false. + + + + Gets cell type from current column. + + Indicates row. + Indicates column. + Indicates is need to indentify formula sub type. + Returns cell type. + + + + Sets formula value. Use for setting FormulaError, FormulaBoolean, FormulaNumber, FormulaString values. + + One based row index. + One based column index. + Represents value for set. + Represents string record as formula string value. Can be null. + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Return parent Application object. Read-only. + + + + + Return parent Application object. Read-only. + + + + + Returns the SFArrayList from all rows. + + + + + Gets the number of rows contained in the . Read-only. + + + + + Returns zero-based index of the first created row. + + + + + Returns zero-based index of the last created row. + + + + + Gets / sets an element at the specified coordinates in the . + + The zero-based row index. + The zero-based column index. + + If you query for an element and the coordinates are out of range, an empty () object will be returned. + If you set an element and the the coordinates are out of range, an exception is thrown. + + + + + Returns List with shared formulas. Read-only. + + + + + Number of shared formulas. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + Represents enumerator for SFTable + + + + + Table to enumerate. + + + + + One-based current row index. + + + + + SFTable to enumerate. + + + + + Offset inside current row. + + + + + To prevent creation instances of this class without arguments. + + + + + Initializes new instance of the enumerator. + + Table to enumerate. + + + + Sets the enumerator to its initial position, which is before + the first element in the collection. + + + + + Advances the enumerator to the next element of the collection. + + + + + + Moves pointer to the next non-empty row if it is possible. + + True if operation succeeded. + + + + Gets the current element in the collection. + + + + + Gets the key of the current dictionary entry. Read-only. + + + + + Gets the value of the current dictionary entry. Read-only. + + + + + Gets both the key and the value of the current dictionary entry. Read-only. + + + + + Stores single row data and gives functionality to access and modify it. + + + + + Memory block will be divisible of this value. + + + + + Represents MULRK xf indexes period. + + + + + Represents MULBLANK xf indexes period. + + + + + Indicates the dot symbol + + + + + Records that are not simply ICellPositionFormat records but that contains multiple subrecords. + + + + + First record type - record that can contain several sub records, second + record type - type of the single record corresponding to the multi record type. + + + + + Zero-based index of the first column. + + + + + Zero-based index of the last column. + + + + + Size of used data. + + + + + Data provider. + + + + + Storage options. + + + + + Column that is referenced by m_iCurrentOffset. -1 - means that we have no correct offset. + + + + + Offset in the data storage to the record with m_iCurrentColumn. + + + + + Workbook object. + + + + + Represents the row index. + + + + + Represents the cells contains WrapText + + + + + Height of the row, in twips = 1/20 of a point. + + + + + Options flag. + + + + + + + + + + Preserves Table record for datatable support + + + + + Indicate whether the row is hiddem by filters + + + + + Indicate column index of filter which hide the row + + + + + Indicate whether the row is auto fitted or not + + + + + Indicate whether the cell style is applied for the row + + + + + Default constructor. + + + + + + + + Performs application-defined tasks associated with freeing, + releasing, or resetting unmanaged resources. + + + + + Disposes the object + + + + + Disposes this object. + + + + + Represents the x14ac:dyDescent attribute value + + + + + Returns row storage enumerator. + + Record extractor to get Biff records from. + + + + + Sets cell style. + + Zero-based row index. + Zero-based column index. + Index of the extended format to set. + Memory allocation elementary block size. + + + + Creates new record based on the data at the specified position. + + Offset to the record. + + + + + Returns record corresponding to the specified cell. + + Zero-based column index. + Memory allocation elementary block size. + Record corresponding to the specified cell. + + + + Returns record corresponding to the specified cell. + + Zero-based column index. + Memory allocation elementary block size. + Object used to extract records from internal data array. + Record corresponding to the specified cell. + + + + Sets cell data. + + Zero-based column index of the cell. + Cell to set. + Memory allocation elementary block size. + + + + Removes all data saving cells formatting. + + + + + Returns formula string value. + + Zero-based column index. + Value to set. + Memory allocation elementary block size. + + + + Sets array record. + + Zero-based column index. + Record to set. + Memory allocation elementary block size. + + + + Returns array record. + + Offset to the record. + Formula array record. + + + + Returns array record. + + Zero-based column index. + Corresponding array record. + + + + Creates copy of the storage. + + RowStorage with copied data. + + + + + + + + + + Creates copy of the storage. + + RowStorage with copied data. + + + + Creates copy of the storage. + + Zero-based index of the first column to copy. + Zero-based index of the last column to copy. + Memory allocation elementary block size. + RowStorage with copied data. + + + + Creates copy of the storage. + + Source strings table. + Destination strings table + Dictionary with new extended format indexes. + Dictionary with new worksheet names. + New name indexes. + Dictionary with new font indexes. + RowStorage with copied data. + + + + Creates copy of the storage. + + Zero-based index of the first column to copy. + Zero-based index of the last column to copy. + Represents allocation block size. + + + + Updates indexes in the array-entered formula. + + Zero-based column index of the cell with array-entered formula. + Zero-based row index of the array record. + Zero-based column index of the array record. + Memory allocation elementary block size. + + + + Indicates whether row contains record with specified index. + + Zero-based column index to find. + True if required record was found. + + + + Inserts data from another row object. + + Source row data. + Memory allocation elementary block size. + Heap handle that must be used to allocate memory. + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + Memory allocation elementary block size. + Parent workbook. + + + + Update formula after subtotal operation. + + Inserted row indexes. + Current worksheet index. + Source worksheet index. + Destination worksheet index. + Source workbook. + + + + Adds specified values to row and columns indexes. + + Value to add to row index. + Value to add to column index. + Memory allocation elementary block size. + + + + Updates indexes to named ranges. + + Parent workbook. + New indexes. + Memory allocation elementary block size. + + + + Updates indexes to named ranges. + + Parent workbook. + New indexes. + Memory allocation elementary block size. + + + + Replaces all shared formula with ordinary formula. + + Parent workbook. + Shared formula that should be replaced. + + + + Updates string indexes. + + List with new indexes. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Find given value within the given range. + + First column within the range to search. + Last column within the rane to search. + Value to find. + Flags representing where the find value should be looked in. + Error code found. + If true - finds first value; otherwise - all values. + The workbook object. + A list of cell indexes that contains the specified value. + + + + Find given value within the given range. + + First column within the range to search. + Last column within the rane to search. + Value to find. + Flags representing where the find value should be looked in. + Way to find. + Error code found. + If true - finds first value; otherwise - all values. + The workbook object. + The sheet in which the sreach value is to be found. + The wildcard regex to find match for. + A list of cell indexes that contains the specified value. + + + + Checks the string value. + + The first. + The second. + The options. + The book. + The wildcard regex. + Boolean value indicating if the given values match each other according to find criteria. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Moves pointer to the next record. + + Offset of the current record. + Offset to the next record. + + + + This method should be called immediately after extended format removal. + + Dictionary with updated extended formats. + Memory allocation elementary block size. + + + + This method should be called immediately after extended format removal. + + Array with updated extended formats. + Memory allocation elementary block size. + + + + This method updates indexes to the extended formats after version change. + + New restriction for maximum possible XF index. + Index to the default extended format. + + + + Updates LabelSST indexes after SST record parsing. + + Dictionary with indexes to update, key - old index, value - new index. + + + + Appends storage with record's data. + + Record type. + Data length. + Array with required data. + Memory allocation elementary block size. + + + + Appends storage with record's data. + + Record type. + Data length. + Array with required data. + Memory allocation elementary block size. + + + + Appends storage with record's data. + + Data length. + Array with required data. + Memory allocation elementary block size. + + + + Appends storage with record's data. + + Zero-based column index to insert data. + Data length. + Array with required data. + Memory allocation elementary block size. + + + + Appends storage with record's data. + + Records to append. + Temporary buffer for record data. + Indicates whether we have to ignore styles. + Memory allocation elementary block size. + + + + Converts all MultiRK and MultiBlank records into set of RK / Blank records. + + Indicates whether styles must be ignored. + Memory allocation elementary block size. + + + + Compresses data storage - combines several rk/blank records into one MulRK/MulBlank records. + + + + + This method prepares row data, it updates indexes inside SSTDictionary, + sets flags for RK and MultiRK records. + + SSTDictionary to update. + List that will receive all found shared formula records. + + + + + + + + Indicates whether fast parsing is turned on. If it is not then we don't + need to update FirstColumn and LastColumn indexes. + + + + + Creates RowRecord and copies all required data into it. + + Parent workbook. + Created record. + + + + Copies row settings (default style, height and some other settings) from another row storage. + + Storage to copy settings from. + + + + Sets default row options. + + + + + Updates column indexes of the specified row. + + Column index. + Last column index. + + + + + + + Memory allocation block size. + + + + Returns extended format index for the specified column or int.MinValue if not found. + + Zero-based column index. + Extended format index for the specified column or int.MinValue if not found. + + + + Looks through all records and calls AddIncrease for each LabelSST record. + + Dictionary to update. + + + + + + + + + + + Updates columns indexes. + + + + + Iterates through all cells in the row. + + Method to call for each cell. + Data to pass to the calling method. + + + + Sets items with used reference indexes to true. + + Record type to check. + Offset to the record to check. + Array to mark used references in. + + + + Updates reference indexes. + + Represents Biff record type. + Represents offset value. + Data to be updated. + + + + + + + + + + Sets items with used reference indexes to true. + + Represents used items. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Searches for the record of specified type. + + Record type to look for. + Zero-based index of the column to start looking at. + Zero-based index of the column to end looking at. + Column index that contains record of the specified type or value beyond endColumn if not found. + + + + Searches for the first cell in the specified range. + + Zero-based column index to start search at. + Zero-based column index to end search at. + + + + + Gets indexes of the used named range objects. + + Collection to put named range indexes into. + + + + Adds all named range indexes referenced by formula tokens into resulting dictionary. + + Dictionary that will get named range tokens. + Tokens to check. + + + + Inserts records data into data storage. + + Position to insert at. + Array of records to insert. + + + + Sets cell position size to 4 and converts internal data storage. + + + + + Sets cell position size to 4 and converts internal data storage. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Evaluates number of records in this storage. + + Number of records. + + + + Updates all required indexes after copying row into another worksheet. + + Source SST dictionary. + Destination SST dictionary. + Dictionary with new extended format indexes. + Dictionary with new worksheet names. + Dictionary with new name indexes. + Dictionary with new font indexes. + + + + Updates MulRK or MulBlank XF Indexes. + + HashTable with new XF Indexes. + Represents offset on start mull record. + Record length without header. + Indicates whether offset is offset to MulRK record (TRUE) or to MulBlank record (false). + + + + Updates sst records. + + Represents source sst. + Represents destination sst. + Represents offset to add. + + Dictionary with new font indexes. + + + + Updates formula indexes. + + Represents source SST. + Represents destination sst. + Represents offset. + Represents hash table with worksheet names. + Represents dic name indexes. + Represents length + + + + Updates sheet references in the formula. + + Formula to update. + Dictionary with new worksheet names. + Source workbook. + Destination workbook. + True if any changes were made. + + + + Updates named range references in the formula. + + Formula to update. + Dictionary with new name indexes. + True if any changes were made. + + + + Updates sheet references in the formula. + + Formula to update. + Dictionary with new worksheet names. + Source workbook. + Destination workbook. + Represents dictionary with name indexes. + True if any changes were made. + + + + Get new external reference index for the formula. + + The source workbook. + The destination workbook. + The destination workbook. + Cell formula array. + Returns the external reference index for the formula. + + + + Get new external workbook for the formula. + + The source workbook. + The destination workbook. + The destination workbook. + Returns the external workbook for the formula. + + + + Update the named range index for Ptg. + + The token to update name index. + New nameindex collection. + + + + Indicates whether multi- record contains records of the same type as specified one. + + Cell type to check. + Offset to the multi- record. + True if record types are compatible. + + + + Splits record into two parts by removing subrecord with specified column index. + + Offset to the record to split. + Column index to split by. + Memory allocation elementary block size. + Offset to the second part. + + + + Inserts record inside record that contains multiple values. + + Offset to the record to insert into. + Record to insert. + + + + Inserts record data into storage. + + Offset to the record. + Size that could be overwritten by new record. + Size required by new record. + Record to write. + Memory allocation elementary block size. + + + + Inserts record data into storage. + + Offset to the record. + Size that could be overwritten by new record. + Records to write. + Memory allocation elementary block size. + + + + Locates record in the row. + + One-based column index of the record to find. + Indicates whether record was found. + Offset where record should be placed. + + + + Locates record in the row. + + One-based column index of the record to find. + Indicates whether record was found. + Indicates is found multi record or not. + If true returns offset on valid mull rk structure, by current column index. + Otherwise on MulRk record. + Offset where record should be placed. + + + + + + + + + + + + + + + + + Ensures that internal data storage will be able to store specified number of bytes. + + Required data storage size. + Memory allocation elementary block size. + + + + Updates row dimension information. + + Accessed zero-based column index. + + + + Updates row dimension information. + + Accessed zero-based column index. + Cell that was set. + + + + Removes formula string record. + + Zero-based column index. + Old offset to the string record. + + + + Removes formula string record. + + Zero-based column index. + Returns offset to the corresponding FormulaRecord. + Old offset to the string record. + + + + Removes record from the storage. + + Offset to the record to remove. + + + + Moves pointer to the next record. + + Offset of the current record. + Offset to the next record. + + + + Returns offsets, first one (X) is position before start column and the second one (Y) after end column. + + Zero-based index of the start column. + Zero-based index of the end column. + Output start column index. + Output end column index. + Point with evaluated offsets. + + + + Evaluates offset after specified record and satellite records. + + Offset to the record. + Offset after specified record and satellite records. + + + + Creates multi record. + + Type of sub record. + Created record. + + + + Tries to get record for the next column. + + Column index. + Records that corresponds to the column index. + Current record offset. + Indicates whether record is multi- record. + Record corresponding to the + + + + Returns last column index from the multi- record. + + Offset to the record's start. + Last column index from the multi- record. + + + + Sets cell data without trying to create multi record. + + Zero-based column index of the cell. + Cell to set. + Memory allocation elementary block size. + + + + Evaluates size of the data in the compressed state. + + Compressed data size. + + + + Simply skips record. + + User data. + Offset after skipping record data. + + + + Skips RK records. + + User data. + Offset after skipping record data. + + + + Skips RK records. + + User data. + Offset after skipping record data. + + + + Simply skips record. + + User data. + Offset after skipping record data. + + + + Writes RK records into data array. + + User data. + Offset after skipping record data. + + + + Writes Blank records into data array. + + User data. + Offset after skipping record data. + + + + Creates MulRK record based on set of RK records. + + + Class that contains additional information needed to create + MulRK record correctly. + + Number of RK records. + Created record. + + + + Creates MulRK record based on set of RK records. + + Offset to the first RK record. + Number of RK records. + Created record. + + + + Creates MulBlank record based on set of Blank records. + + Offset to the first Blank record. + Number of Blank records. + Created record. + + + + + + + + + + + + + + + + + + + + + + + Creates multi-cell record (MulRK or MulBlank) at the specified offset. + + Offset to the record to create. + Instance of MulBlank record. + Instance of MulRK record. + Record length including header. + Created record or null if there is incorrect record type. + + + + + + + + + + + + Gets row from the record. + + Offset to the record's start. + Zero-based row index. + + + + Sets row for the record. + + Offset to the record's start. + Zero-based row index to set. + + + + Gets column from the record. + + Offset to the record's start. + Zero-based column index. + + + + Sets column for the record. + + Offset to the record's start. + Zero-based column index to set. + + + + Gets last column index from the MulRk or MulBlank record. + + Offset to the record's start. + Record length. + Zero-based column index. + + + + Gets XF index from the record. + + Offset to the record's start. + Indicates whether record is multi record or not. + Zero-based index to the extended format record with style settings. + + + + Sets XF index for the record. + + Offset to the record's start. + Zero-based index to the extended format record with style settings to set. + + + + Sets XF index inside of "multi" record (MulRK or MulBlank). + + Offset to the record's start. + Zero-based index to the extended format record with style settings to set. + Zero-based column index of the cell to set style. + Size of subrecord inside of multi record. + + + + Size of the required storage space. Read-only. + + + + + Save record data to stream. + + Writer that will receive record data. + Object that provides access to the data. + Object to encrypt data. + Position in the output stream. Used to increase performance. + Size of the record. + If writer is NULL. + + + + Gets bool value by column index. Without check input parameters. + + One based column index. + If found - returns boolean value; otherwise - 0. + + + + Gets formula bool value by column index. Without check input parameters. + + One based column index. + If found - returns boolean value; otherwise - 0. + + + + Gets error value by column index. Without check input parameters. + + One based column index. + If found - returns error value; otherwise - null. + + + + Gets formula error value by column index. Without check input parameters. + + One based column index. + If found - returns error value; otherwise - null. + + + + Gets number value. + + Column index. + Returns number value or NaN. + + + + Checks the format. + + The format. + + + + + Gets formula number value. + + Column index. + Returns number value or NaN. + + + + Gets string value. + + Column index. + Represents sst dictionary. + Returns string value or null. + + + + Returns formula string value. + + Zero-based column index. + String result of the formula. + + + + Returns formula string value. + + Offset to record. + Formula string value. + + + + Gets string value. + + Column index. + Returns ptg array or null. + + + + Gets cell type from current column. + + Indicates column. + Indicates is need to indentify formula sub type. + Returns cell type. + + + + To Get the Value by the specific record type. + + + + + + + + + + Gets sub formula type. + + Represents offset on start formula record. + + + + + Indicates if there is formula record. + + Zero based column index. + Indicates whether formula record is contained. + + + + Indicates is contain formula array. + + Zero based column index. + If found return true; otherwise - false. + + + + Gets error string by number. + + Represents number. + Returns error string or null. + + + + Sets the workbook. + + The book. + The i row. + + + + Sets formula value. Use for setting FormulaError, FormulaBoolean, FormulaNumber, FormulaString values. + + Zero based column index. + Represents value for set. + Represents string record as formula string value. Can be null. + Memory allocation elementary block size. + + + + Represents the row index. + + + + + Zero-based index of the first column. Read/write. + + + + + Zero-based index of the last column. Read/write. + + + + + Size of used data. Read-only. + + + + + Size of allocated data. Read-only. + + + + + Gets or sets value indicating whether storage possibly contains Rk or Blank records. + + + + + Gets or sets value indicating whether storage possibly contains MultiRk or MultiBlank records. + + + + + Indicates that storage was disposed. Read-only. + + + + + Zero-based index of the first column. Read/write. + + + + + Returns internal data provider. Read-only. + + + + + Returns size of the cell position block. Read-only. + + + + + + + + + + Gets the DyDescent attribute value of the row. + + + + + Indicate whether the row is auto fitted or not + + + + + Indicate whether the cell style is applied for the row + + + + + Returns type code of the biff storage. Read-only. + + + + + Returns code of the biff storage. Read-only. + + + + + Indicates whether data array is required by this record. Read-only. + + + + + Indicates record position in stream. This is a utility member of class and + is used only in the serialization process. Does not influence the data. + + + + + Height of the row, in twips = 1/20 of a point. + + + + + If the row is formatted, then this is the index to + the extended format record. + + + + + The outline level of this row. + Changes some bits of m_usOptionFlags private member. + + + When value is more than 7. + + + + + Whether or not to collapse this row. + + + + + Whether or not to display this row with 0 height. + + + + + Whether the font and row height are not compatible. + True if they aren't compatible. + + + + + Whether the row has been formatted (even if it has all blank cells). + + + + + True if there is additional space above the row. + + + + + True if there is additional space below the row. + + + + + Undocumented bit flag. If it is set to False, then Excel will + not show row groups. Default value is True. + + + + + Row or column index. + + + + + Indicate whether the row is hidden by the filters or not + + + + + Indicate column index of filter which hide the row + Column index was maintain as one base index + Return zero if it was not hidden or by default + + + + + Storage options. + + + + + None. + + + + + Indicates that storage contains (or can contain) some RK or Blank records. + + + + + Indicates that storage contains (or can contain) some MultiRK or MultiBlank records. + + + + + Indicates that storage was disposed. + + + + + Calls each cell. + + Record type to check. + Offset to the record to check. + Data to be passed. + + + + Data for size evaluation. + + + + + Start offset. + + + + + Used size. + + + + + Data for writing defragmented data. + + + + + Offset to the record data in the old storage. + + + + + Size of the data. + + + + + Delegate used for defragmentation. + + + + + Represents enumerator for RowStorage + + + + + RowStorage to enumerate. + + + + + Offset to current cell. + + + + + Record extractor. + + + + + To prevent creation instances of this class without arguments. + + + + + Initializes new instance of the enumerator. + + RowStorage to enumerate. + Record extractor to get Biff records from. + + + + Sets the enumerator to its initial position, which is before + the first element in the collection. + + + + + Advances the enumerator to the next element of the collection. + + + + + + Returns formula array record from current cell if it exists. + + Formula array record; null - if doesn't exist. + + + + Returns formula string value if formula contains it. + + + + + + Gets the current element in the collection. + + + + + Gets current cell row. + + + + + Gets current cell column. + + + + + Gets current cell extended format. + + + + + Extends List with MoveRange, InsertRange and RemoveRange methods. The Item property + will grow the array on demand or return NULL if an index is out of range. + + + + + Overloaded. Initializes a new instance of the SFArrayList + class that is empty and has the default initial capacity. + + + + + Initializes a new instance of the SFArrayList class that contains + elements copied from the specified collection and has the same initial + capacity as the number of elements copied. + + The whose elements are copied to the new list. + + + + Overridden. Creates a deep copy of the SFArrayList. + + + A deep copy of the SFArrayList. + + + + + Overridden. Creates a deep copy of the SFArrayList. + + Parent object for the new items. + + A deep copy of the SFArrayList. + + + + + Enlarges the array if needed. + + The size to be checked. If the array has less elements, empty () objects will be appended + at the end of the array. + + + + Gets / sets the element at the specified index. + In C#, this property is the indexer for the SFArrayList class. + + The zero-based index of the element to get / set. + + The element at the specified index. + When querying the value and the index is out of range, an empty () object will be returned. + When setting the value and the index is out of range the array will be enlarged. See SFArrayList.EnsureCount + + + + + Implements a two-dimensional table that holds an SFArrayList of rows. Each row + is an SFArrayList of objects. + + +

This is a memory efficient way to represent a table where values can remain empty. Only rows + that actually contain data will allocate an SFArrayList and the array only holds + as many objects as the specific row contains columns.

+

When you access data that are out of range, an empty () object will be returned. + If you set data that are out of range, an exception will be thrown. If you set data for + a row that is empty, the row will be allocated before the value is stored.

+

SFTable provides methods that let you insert, remove or rearrange columns or m_arrRows + in the table.

+ + + + + Number of m_arrRows in the collection. + + + + + Number of columns in the collection. + + + + + Collection of rows. + + + + + Number of cells in the collection. + + + + + Initializes a new instance of the + class. + + + Initializes a new instance of the + class that is empty. + + Number of rows in the collection. + Number of columns in the collection. + + + + Initializes a new instance of the + class and optional copies of data from an existing table. + + Table to copy. + Indicates whether to copy data. + + + + Initializes a new instance of the + class and optional copies of data from an existing table. + + Table to copy. + Indicates whether to copy data. + Parent object for the new items. + + + + Creates a deep copy of the . + + + A deep copy of the . + + + + + Creates a deep copy of the . + + Parent object for the items. + + A deep copy of the . + + + + + Removes all elements from the . + + + + + Creates a collection of cells for a row. + + An SFArrayList or derived object for the cell collection. + + + + Indicates whether an element is at the specified coordinates in the . + + The zero-based row index. + The zero-based column index. + + + if an element exists at the specified coordinates in the ; + otherwise. + + + + + Returns the SFArrayList from all rows. + + + + + Gets the number of rows contained in the . Read-only. + + + + + Gets the number of columns contained in the . Read-only. + + + + + Returns number of cells in the collection. Read-only. + + + + + Gets / sets an element at the specified coordinates in the . + + The zero-based row index. + The zero-based column index. + + If you query for an element and the coordinates are out of range, an empty () object will be returned. + If you set an element and the the coordinates are out of range, an exception is thrown. + + + + + Collection of worksheet's shapes. + + + + + Represents shapes collection in the workbook. + + + + + Adds new to the collection. + + Image to add. + File name with the image. + Image format to use for picture storing. + Newly created picture shape. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Get image + System.Drawing.Image image = System.Drawing.Image.FromFile("image.png"); + + //Add picture shape + IPictureShape picture = worksheet.Shapes.AddPicture(image, "Image1", ExcelImageFormat.Jpeg); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds new to the collection. + + File name with the image. + Newly created picture shape. + + This method is only supported in Windows Forms, WPF, ASP.NET and ASP.NET MVC. + + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add picture shape + IPictureShape picture = worksheet.Shapes.AddPicture("image.png"); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds new Comment shape to the collection. + + Text of the comment. + Indicates is parse comment fill line options. + Newly added shape. + + + + Adds new Comment shape to the collection. + + Text of the comment. + Newly added shape. + + + + Adds new Comment shape with empty comment text to the collection. + + Newly added shape. + + + + Adds new chart shape to the collection. + + Newly added shape. + + + + Adds shape copy to the collection. + + Shape to copy. + Added shape. + + The following code illustrates how to add a copy of the source shape to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Add copy + IShape copiedShape = worksheet.Shapes.AddCopy(shape); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds shape copy to shapes collection. + + Shape to copy. + Dictionary with new names of worksheets. + List with new font indexes. + Added shape. + + + + Adds new to the collection. + + Newly created textbox. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add textbox + ITextBoxShapeEx textbox = worksheet.Shapes.AddTextBox(); + + //Set dimensions + textbox.Top = 1; + textbox.Left = 1; + textbox.Height = 40; + textbox.Width = 300; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds new to the collection. + + Newly created checkbox. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add checkbox + ICheckBoxShape checkbox = worksheet.Shapes.AddCheckBox(); + + //Set dimensions + checkbox.Top = 1; + checkbox.Left = 1; + checkbox.Height = 20; + checkbox.Width = 100; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds new to the collection. + + Newly created checkbox. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add option button + IOptionButtonShape optionButton = worksheet.Shapes.AddOptionButton(); + + //Set dimensions + optionButton.Top = 1; + optionButton.Left = 1; + optionButton.Height = 20; + optionButton.Width = 100; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds new to the collection. + + Newly created checkbox. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add combobox + IComboBoxShape combobox = worksheet.Shapes.AddComboBox(); + + //Set dimensions + combobox.Top = 1; + combobox.Left = 1; + combobox.Height = 20; + combobox.Width = 100; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Adds new to the collection + + AutoShape type + One-based index of the top row of the shape to be placed. + One-based index of the left column of the shape to be placed. + Height of the auto shapes. + Width of the auto shapes. + Returns newly added shape. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Create a for selected items. + + AutoShapeType + Newly created group shape + + The following code illustrates how to ungroup a specified . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("GroupShapes.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IShapes shapes = worksheet.Shapes; + IShape[] groupItems = new IShape[] { shapes[0], shapes[1] }; + + // Create group shape for selected items. + IGroupShape GroupShape = shapes.Group(groupItems); + + //Save and dispose + workbook.SaveAs("GroupShapes.xlsx"); + workbook.Close(); + } + + + + + + Ungroup the specified group shape. + + Group shape to ungroup. + + The following code illustrates how to ungroup a specified . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("GroupShapes.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IShapes shapes = worksheet.Shapes; + + // Ungroup the group shape. + shapes.Ungroup(shapes[0] as IGroupShape); + + //Save and dispose + workbook.SaveAs("GroupShapes.xlsx"); + workbook.Close(); + } + + + + + + Ungroup the group shape and its inner shapes. + + Group shape to ungroup. + Boolean value which indicates whether the inner shapes will be ungrouped. + + The following code illustrates how to ungroup a specified . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("GroupShapes.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + IShapes shapes = worksheet.Shapes; + + // Ungroup the group shape and its inner shapes. + shapes.Ungroup(shapes[0] as IGroupShape, true); + + //Save and dispose + workbook.SaveAs("GroupShapes.xlsx"); + workbook.Close(); + } + + + + + + Returns the number of objects in the collection. Read-only Long. + + + The following code illustrates how to access Count property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Add copy + IShape copiedShape = worksheet.Shapes.AddCopy(shape); + + //Get count + Console.Write(worksheet.Shapes.Count); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //2 + + + + + + Returns single from the collection by its index. + + + The following code illustrates how to access a from the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Add copy + IShape copiedShape = worksheet.Shapes.AddCopy(worksheet.Shapes[0]); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Returns single from the collection by its name or null when cannot find. Read-only. + + + The following code illustrates how to access a from the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 100); + + //Set name + shape.Name = "Shape1"; + + //Add copy + worksheet.Shapes.AddCopy(worksheet.Shapes["Shape1"]); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Default start of the chart shape name. + + + + + Default start of the textbox shape name. + + + + + Default start of the checkbox shape name. + + + + + + Default start of the combobox shape name. + + + + + Default start of the picture shape name. + + + + + Default start of the ole object name. + + + + + Default start of the ole object name. + + + + + Collection that contains all comments on the sheet. + + + + + + + + + + + + + + + + + Parse options. + + + + Initializes collection + + + + + Adds picture. + + Image to adding. + Name of picture. + Image format. + Returns IPicture object that include picture. + + + + Adds picture to the collection by blipId. + + Picture id. + Picture name. + Newly created picture object. + + + + Adds new image to the collection. + + File name with the image. + Newly created picture shape. + This method is not supported in WinRT, Windows Phone, Universal and Portable platforms. + + + + + Adds new Comment shape to the collection. + + Text of the comment. + Newly added shape. + + + + Adds new Comment shape to the collection. + + Text of the comment. + Indicates is parse comment fill line options. + Newly added shape. + + + + Adds comment with empty text to the collection. + + Added comment. + + + + Adds new chart shape to the collection. + + Newly added shape. + + + + Adds new textbox shape to the collection. + + Newly added shape. + + + + Adds new checkbox shape to the collection. + + Newly added shape. + + + + Adds new OptionButton shape to the collection. + + Newly added shape. + + + + Adds new checkbox shape to the collection. + + Newly added shape. + + + + Regenerates combo box names + + + + + Creates new shape to object to this collection. + + Object type to create. + Shape container. + Parse options. + Subrecords of the shape's OBJRecord. + Index to the cmo record inside subrecords. + Created shape. + + + + Adds FormControlShape into collection. + + Newly created shape. + + + + Removes comment from internal collections. + + + + + + Checks whether it is possible insert row or column into iIndex. + + Index of row to insert. + Number of rows to insert. + Indicates whether rows are inserted. + Maximum possible index. + True if it is possible to insert row or column. + + + + Updates shapes position on insert or remove row in worksheet. + + Represents row \ column index. + Represents count. + Indicates is row. + Indicates is remove or insert. + + + + Adds picture to the collection by blipId. + + Picture id. + Picture name. + Newly created picture object. + + + + Adds picture to collections. + + Represents picture to add. + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + Creates copy of the collection. + + Parent object for the new collection. + Copy of the collection. + + + + Copies or moves shape on range copy / move. + + Represents destination sheet for shape. + Represents range dimension. + Represents destination rectangle + Indicates is copy or move. + + + + Removes all shapes that are out of new dimensions. + + Version to set. + + + + Updates indexes to named ranges. + + New indexes. + + + + Updates indexes to named ranges. + + New indexes. + + + + Gets Top based sorted shape list. + + + + + Gets Bottom based sorted shape list. + + + + + Gets Left based sorted shape list. + + + + + Gets Right based Reverse sorted shape list. + + + + + Gets shape by its id. + + Shape's id to locate. + + + + Gets OLE shape by its id. + + Shape's id to locate. + + + + Gets group shape by its child shape id. + + Group shape. + Shape's id to locate. + Extracted shape + + + + Add AutoShapes into collection + + AutoShapeType + TopRow + LeftColumn + Height + Width + + + + + Create a group shape for selected items. + + AutoShapeType + Newly created group shape + + + + Group from selected items. + + GroupShape + AutoShapeType + If true the shape are remove from ShapeCollection, otherwise don't remove + + + + + Ungroup the specified group shape. + + Group shape to ungroup. + + + + Ungroup the group shape and its inner shapes. + + Group shape to ungroup. + Boolean value which indicates whether the inner shapes will be ungrouped. + + + + Ungroup the group shape and its inner shapes. + + Group shape to ungroup. + Boolean value which indicates whether the inner shapes will be ungrouped. + + + + Create a group shape for selected items. + + Group shape to add inner shapes. + Shape array to add in the group shape. + Newly created group shape + + + + Removes group shape from the collection. + + Shape to remove. + + + + Add AutoShapes into collection + + AutoShapeType + TopRow + TopRowOffset + LeftColumn + LeftColumnOffset + Height + Width + + + + + Return the name for the auto shape based on the shape type. + + Auto shape name + No of auto shapes in the sheet + Returns Auto shape name. + + + + Return the default name for the auto shape based on the shape type. + + Auto shape type + Returns string with new name. + + + + Returns collection of all comments in the worksheet. Read-only. + + + + + Returns collection of all comments in the worksheet. Read-only. + + + + + Code of the Biff record in which all data is stored. Read-only. + + + + + Returns shared shape data for all shapes in this collection. Read-only. + + + + + A collection of all the Style objects in the specified or active + workbook. Each Style object represents a style description for a + range. The Style object also contains all style attributes (font, + number format, alignment, and so on) as properties. There are + several built-in styles � including Normal, Currency, and Percent + � which are listed in the Style name box in the Style dialog box + (Format menu). + + + + + A collection of all the Style objects in the specified or active + workbook. Each Style object represents a style description for a + range. The Style object contains all style attributes (font, + number format, alignment, and so on) as properties. There are + several built-in styles including Normal, Currency, and Percent + which are listed in the Style name box in the Style dialog box. + (Format menu). + + + + + Creates a new and adds it to the list of that are + available for the current workbook. Returns a object. + + Name of the newly created . + Prototype for the . + Newly created . + + The following code illustrates how to add a created based on an existing object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Value = "100"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle", workbook.Styles[1]); + + //Set color + style.ColorIndex = ExcelKnownColors.Red; + + //Set style + worksheet["C2"].CellStyle = style; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Creates a new and adds it to the list of that are + available for the current workbook. Returns a object. + + Name of the created . + Newly created . + + To know more about refer Create a Style. + + + The following code illustrates how to create and add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set color + style.ColorIndex = ExcelKnownColors.Red; + + //Set style + worksheet["C2"].CellStyle = style; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Merges the styles from another workbook into the Styles collection. + + Workbook from which all styles will be added. + True - overwrite styles with the same names, otherwise. + Merged collection. + + The following code illustrates how styles can be imported from a source workbook to destination workbook. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create Styles + workbook.Styles.Add("CustomStyle1"); + workbook.Styles.Add("CustomStyle2"); + + //Modify styles + workbook.Styles["CustomStyle1"].ColorIndex = ExcelKnownColors.Red; + workbook.Styles["CustomStyle2"].ColorIndex = ExcelKnownColors.Blue; + + //Create new worksheet + IWorkbook book = application.Workbooks.Create(1); + IWorksheet sheet = book.Worksheets[0]; + + //Check count + Console.WriteLine("Before Merge\nDestination "+book.Styles.Count); + Console.WriteLine("Source "+workbook.Styles.Count); + + //Merge styles + book.Styles.Merge(workbook, true); + + //Check count + Console.WriteLine("After Merge\nDestination "+book.Styles.Count); + Console.WriteLine("Source "+workbook.Styles.Count); + + //Close + workbook.Close(); + book.Close(); + Console.ReadKey(); + } + //Output will be + //Before Merge + //Destination 6 + //Source 8 + //After Merge + //Destination 8 + //Source 8 + + + + + + Merges the styles from another workbook into the Styles collection. + Keep only unique style in collection. + + Workbook from which all styles will be added. + Merged collection. + + The following code illustrates how styles can be imported from a source workbook to destination workbook. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create Styles + workbook.Styles.Add("CustomStyle1"); + workbook.Styles.Add("CustomStyle2"); + + //Modify styles + workbook.Styles["CustomStyle1"].ColorIndex = ExcelKnownColors.Red; + workbook.Styles["CustomStyle2"].ColorIndex = ExcelKnownColors.Blue; + + //Create new worksheet + IWorkbook book = application.Workbooks.Create(1); + IWorksheet sheet = book.Worksheets[0]; + + //Check count + Console.WriteLine("Before Merge\nDestination "+book.Styles.Count); + Console.WriteLine("Source "+workbook.Styles.Count); + + //Merge styles + book.Styles.Merge(workbook); + + //Check count + Console.WriteLine("After Merge\nDestination "+book.Styles.Count); + Console.WriteLine("Source "+workbook.Styles.Count); + + //Close + workbook.Close(); + book.Close(); + Console.ReadKey(); + } + //Output will be + //Before Merge + //Destination 6 + //Source 8 + //After Merge + //Destination 8 + //Source 8 + + + + + + Method return true if collection contains + with specified by user name. + + Name to check. + True - if exists, otherwise False. + + The following code illustrates how to check whether a is present in collection or not. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Check styles count + Console.WriteLine(workbook.Styles.Contains("CustomStyle")); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + + + + + + Removes from the collection. + + name to remove. + + The following code illustrates how to remove a from the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorkbook workbook2 = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create style + IStyle style1 = workbook.Styles.Add("CustomStyle1"); + IStyle style2 = workbook.Styles.Add("CustomStyle2"); + + //Check styles count + Console.WriteLine(workbook.Styles.Count); + + //Removing style + workbook.Styles.Remove("CustomStyle1"); + + //Check styles count + Console.WriteLine(workbook.Styles.Count); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //8 + //7 + + + + + + Used without an object qualifier, this property returns an Application + object that represents the Microsoft Excel application. + + + The following code illustrates how object in the collection can be accessed . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Access application object + Console.WriteLine(style.Application.DefaultVersion); + + //Wait for user input + Console.ReadKey(); + } + //Output will be + //Excel2013 + + + + + + Returns the number of objects in the collection. Read-only, Long. + + + The following code illustrates how to access the number of objects in the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Check styles count + Console.WriteLine(workbook.Styles.Count); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //7 + + + + + + Returns a single object from the collection. + + + The following code illustrates how to access object in the collection using it's index. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Check style name + Console.WriteLine(workbook.Styles[6].Name); + Console.WriteLine(workbook.Styles[0].Name); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //CustomStyle + //Normal + + + + + + Returns a single object from the collection. + + + The following code illustrates how to access object in the collection using it's . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Check style built in + Console.WriteLine(workbook.Styles["CustomStyle"].BuiltIn); + Console.WriteLine(workbook.Styles["Normal"].BuiltIn); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //False + //True + + + + + + Returns the parent object for the specified object. + + + The following code illustrates how to access the parent of a object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Text = "Sample"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set color + style.ColorIndex = ExcelKnownColors.Red; + + //Set style + worksheet["C2"].CellStyle = style; + + //Check styles count + Console.WriteLine(style.Parent); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //Syncfusion.XlsIO.Implementation.WorkbookImpl + + + + + + RB-tree for quick style search operation. + + + + + Collection of all the styles in the workbook. + + + + + Dictionary StyleXFIndex to StyleImpl. + + + + + Parent workbook. + + + + + + + + + + + + + + + Creates the collection and sets its Application and Parent properties. + + The application object for this collection. + The parent object for this collection. + + + + Creates a new style and adds it to the list of styles that are + available for the current workbook. Returns a Style object. + + Name of the newly created style. + Prototype for the style. + Newly created style. + + If name is NULL. + + + When collection already contains style with specified name. + + + + + Creates a new style and adds it to the list of styles that are + available for the current workbook. Returns a Style object. + + Name of the newly created style. + Newly created style. + + + + Merges the styles from another workbook into the Styles collection. + Keep only unique style in collection. + + Workbook from which all styles will be added. + Merged collection. + + + + Merges the styles from another workbook into the Styles collection. + + Workbook from which all styles will be added. + True to overwrite styles with the same names. + Merged collection. + + If specified Workbook is not WorkbookImpl. + + + + + Removes style from the collection. + + Style to remove. + + + + Adds specified style into this collection. + + Style that must be added. + + + + Adds specified style to collection. + + Style to add. + If true and ContainName then replace old name; otherwise add. + + + + Method returns True if collection contains style + with specified by user name. + + Name to check. + True if style exists; otherwise False. + + + + Searches in the collection for style which is same as specified. + + Style to search. + Found style or NULL if no same style exists in list. + + If specified style is NULL. + + + + + Compares two styles. + + The first style to compare. + The second style to compare. + True if styles are the same; otherwise False. + + + + Compare all Border Collections items. + + First border to compare. + Second border to compare. + True if borders are the same; otherwise False. + + + + Compare Border interfaces. + + First border to compare. + Second border to compare. + True if borders are the same; otherwise False. + + + + Merges styles from specified workbook. + + Source workbook. + Merge options. + Dictionary with changed style names, key - old name, value - new name. + + + + Merges styles from specified workbook. + + Source workbook. + Merge options. + Returns dictionary with new font indexes. + Dictionary with new indexes of extended formats. + Dictionary with changed style names, key - old name, value - new name. + + + + Generates default name. + + Name prefix. + Automatically generated unique name. + + + + Generates default name. + + Name prefix. + Dictionary with used names. + Automatically generated unique name. + + + + Creates built in style. + + Name of the style. + Created style. + + + + Returns style corresponding to the index of extended format. + + Index of the extended format to find. + Found style. + + + + Updates style record of each style in the collection according to the xf indexes. + + + + + Searches in collection for style named styleName. + + Style name to search. + Searched style if found; otherwise returns NULL. + + + + Method checks whether the collection contains a style with the specified name. + + Name to check. + True if style exits; otherwise False. + + + + Adds new style to the collection. + + Style to add. + + + + Creates copy of the current instance. + + Parent object for the new collection. + Copy of the current instance. + + + + Performs additional processes after clearing the collection. + + + + + Performs additional processes after inserting a new element into the collection. + + The zero-based index at which to insert value. + The new value of the element at the index. + + + + Performs additional processes after removing an element from the collection. + + The zero-based index at which value can be found. + The value of the element to remove from the index. + + + + Performs additional processes after setting a value in the collection. + + The zero-based index at which oldValue can be found. + The value to replace with newValue. + The new value of the element at the index. + + + + + + + + + + + + + + + + + + Clears hashIndexToStyle member. + + + + + Access the style property ignoring the case, used for Binary stream parsing + + Input style name to be searched + the style + + + + Returns a single object from a collection. Read-only. + + + + + + + + + + Represents worksheet's textbox collection. + + + + + This interface represents TextBoxes collection inside single worksheet. + + + + + Adds new to the collection. Coordinate means + a) in the case of worksheet - row, column - are corresponding row, + column indexes of the top-left corner, width and height are measured in pixels + b) in the case of chart in Excel 97 all coordinates are measured in 1/4000 of the chart width/height + c) in the case of chart in Excel 2007 all coordinates are measured in 1/1000 of the chart width/height + + One-based row index of the top-left corner of the new item. + One-based column index of the top-left corner of the new item. + Height of the new item. + Width of the new item. + Newly added item. + + The following code illustrates how to add a to the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add textbox + ITextBoxShape textbox1 = worksheet.TextBoxes.AddTextBox(1, 1, 20, 100); + ITextBoxShape textbox2 = worksheet.TextBoxes.AddTextBox(5, 5, 20, 100); + + //Set name + textbox1.Name = "TextBox1"; + textbox2.Name = "TextBox2"; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Returns number of items in the collection. + + + The following code illustrates how to access the Count property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add textbox + ITextBoxShape textbox1 = worksheet.TextBoxes.AddTextBox(1, 1, 20, 100); + ITextBoxShape textbox2 = worksheet.TextBoxes.AddTextBox(5, 5, 20, 100); + + //Set name + textbox1.Name = "TextBox1"; + textbox2.Name = "TextBox2"; + + //Get count + Console.Write(worksheet.TextBoxes.Count); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //2 + + + + + + Returns single from the collection. + + Item's index to get. + Single item from the collection. + + The following code illustrates how to access a from the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add textbox + ITextBoxShape textbox1 = worksheet.TextBoxes.AddTextBox(1, 1, 20, 100); + ITextBoxShape textbox2 = worksheet.TextBoxes.AddTextBox(5, 5, 20, 100); + + //Set name + worksheet.TextBoxes[0].Name = "TextBox1"; + worksheet.TextBoxes[1].Name = "TextBox2"; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets single from the collection. + + Name of the item to get. + Single item from the collection. + + The following code illustrates how to access a from the collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add textbox + ITextBoxShape textbox1 = worksheet.TextBoxes.AddTextBox(1, 1, 20, 100); + ITextBoxShape textbox2 = worksheet.TextBoxes.AddTextBox(5, 5, 20, 100); + + //Set name + worksheet.TextBoxes[0].Name = "TextBox1"; + worksheet.TextBoxes[1].Name = "TextBox2"; + + //Get count + Console.Write(worksheet.TextBoxes["TextBox1"].Width); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //100 + + + + + + Parent worksheet. + + + + + Initializes new instance of the collection. + + Application object for the new instance. + Parent object for the new instance. + + + + Adds new item to the collection. + + Textbox to add. + + + + Adds new textbox to the collection. + + Top row for the new shape. + Left column for the new shape. + Height in pixels of the new shape. + Width in pixels of the new shape. + Newly created TextBox object. + + + + Returns single item from the collection. + + Index of the item to get. + Single item from the collection. + + + + Gets single item from the collection. + + Name of the item to get. + Single item from the collection. + + + + A collection of vertical page breaks within the print area. + Each vertical page break is represented by a VPageBreak object. + + + + + A collection of vertical page breaks within the print area. + Each vertical page break is represented by a VPageBreak object. + + + + + Adds a vertical page break. Returns a object. + + Location of the break. + Newly added page break. + + To know more about page setting refer this link. + + The following code illustrates how to add a vertical page break. + + //Create a worksheet. + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + + //Set Vertical Page Breaks. + sheet.VPageBreaks.Add(sheet.Range["A5"]); + sheet.VPageBreaks.Add(sheet.Range["C18"]); + sheet.VPageBreaks.Add(sheet.Range["H32"]); + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + + + + + + Removes a page break from the specified location. + + Range to remove the page break. + Page break in the range. + + To know more about page setting refer this link. + + The following code illustrates how to Remove a vertical page break. + + //Create a worksheet. + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //Remove Vertical Page Breaks. + sheet.VPageBreaks.Remove(sheet.Range["A5"]); + sheet.VPageBreaks.Remove(sheet.Range["A18"]); + sheet.VPageBreaks.Remove(sheet.Range["A32"]); + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + + + + + + Returns page break at the specified column. + + One-based column index. + Page break with corresponding column or null if not found. + + To know more about page setting refer this link. + + The following code illustrates how to get page break with corresponding column. + + //Create a worksheet. + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //Get Page break with corresponding column + IVPageBreak vPageBrk = sheet.VPageBreaks.GetPageBreak(6); + if(vPageBrk != null) + { + //Your code here + } + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + + + + + + Clears vertical page breaks from VPageBreaks collection. + + + To know more about page setting refer this link. + + The following code illustrates how to clear a vertical page break. + + //Create a worksheet. + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //clear Vertical Page Breaks + sheet.VPageBreaks.Clear(); + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + + + + + + Used without an object qualifier, this property returns an + object that represents the Excel . + + The following code illustrates how to access the property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //Property returns an Application object that represents the Excel application + IApplication vPageBreakApplication = sheet.VPageBreaks.Application; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Returns the number of objects in the collection. Read-only. + + The following code illustrates the use of Count property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //Number of objects in the collection + int vPageBreakCount = sheet.VPageBreaks.Count; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Returns a single object from a collection. Read-only. + + + To know more about page setting refer this link. + + The following code illustrates how to get an object from a collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Add PageBreaks + sheet.Range["A1:S65"].Text = "PagePrint"; + sheet.VPageBreaks.Add(sheet.Range["A3"]); + sheet.VPageBreaks.Add(sheet.Range["G10"]); + sheet.VPageBreaks.Add(sheet.Range["F24"]); + sheet.VPageBreaks.Add(sheet.Range["C37"]); + + //Get the Vertical page break location using index + IRange vPageBreakLocation1 = sheet.VPageBreaks[0].Location; + IRange vPageBreakLocation2 = sheet.VPageBreaks[1].Location; + IRange vPageBreakLocation3 = sheet.VPageBreaks[2].Location; + IRange vPageBreakLocation4 = sheet.VPageBreaks[3].Location; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Returns the parent object for the specified object. + + The following code illustrates the use of Parent property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //Parent object for the specified object + object vPageBreakParent = sheet.VPageBreaks.Parent; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Parent workbook. + + + + + Adds a vertical page break. Returns a VPageBreak object. + + Page break location. + Newly added page break. + + When specified object cannot be found in the collection. + + + + + Removes vertical page break. + + Page break location. + Page break that was removed from the collection. + + + + Returns page break at the specified column. + + One-based column index. + Page break with corresponding column or null if not found. + + + + Returns index of the page break + + Location of the break to find. + Index of the page break in the collection or -1 if not found. + + + + Clears Vertical page breaks from VPageBreaks collection. + + + + + Creates collection and sets its Application and Parent properties. + + Application object for this collection. + Parent object for this collection. + + + + Looks for all necessary parent objects. + + + + + Parses breaks record. + + Record to parse. + + + + Serializes collection into as set of Biff records. + + OffsetArrayList to serialize into. + + + + Prepares record. + + Prepared record. + + + + Creates copy of the collection. + + Parent for new collection. + A clone of the current collection. + + + + Adds page break to the collection. + + Page break to add. + + + + Converts pagebreaks to Excel97to03 version. + + + + + Size of the required storage space. Read-only. + + + + + Save record data to stream. + + Writer that will receive record data. + Object that provides access to the data. + Object to encrypt data. + Position in the output stream. Used to increase performance. + Size of the record. + If writer is NULL. + + If m_iLength of internal record data array is less than zero. + + + + + Returns single page break from the collection. + + + + + Returns manual breaks count. Read-only. + + + + + Returns type code of the biff storage. Read-only. + + + + + Returns code of the biff storage. Read-only. + + + + + Indicates whether data array is required by this record. + + + + + Indicates record position in stream. This is a utility member of class and + is used only in the serialization process. Does not influence the data. + + + + + Collection of the Workbook names (NamedRanges). + + + + + A collection of all the Name objects in the application or + workbook. Each Name object represents a defined name for a + range of cells. + + + Below these rules are should be followed, when you're creating a named range in Excel. + 1. The first character of a name must be one of the following characters: + letter, + underscore (_), + backslash (\). + 2. Remaining characters in the name can be + letters, + numbers, + periods, + underscore characters. + 3. The following are not allowed: + Space characters are not allowed as part of a name. + Names can't look like cell addresses, such as A$35 or R2D2. + C, c, R, r - can't be used as names. Excel uses them as selection shortcuts. + 4. Names are not case sensitive. For example, North and NORTH are treated as the same name. + To know more about Named Ranges refer this link. + + + + + This method is used to defines a new name. + + Name for the new Name object. + Returns a Name object. + + To know more about named ranges refer this link. + + The following code illustrates how to use Add method in named range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 88; + + //Create a Named Range using WorkBook + IName namedTitle = workbook.Names.Add("Titles"); + namedTitle.RefersToRange = sheet.Range["A1:C1"]; + + //Create a Named Range using WorkSheet + IName namedData = sheet.Names.Add("Records"); + namedData.RefersToRange = sheet.Range["A2:C3"]; + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + This method is used to defines a new name. + + Name for the new Name object. + Range that will be associated with the name. + Returns a Name object. + + To know more about named ranges refer this link. + + The following code illustrates how to use Add method in named range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 88; + + //Create a Named Range with add method for workbook + IName namedTitle = workbook.Names.Add("NamedTitle", sheet.Range["A1:C1"]); + + //Create a Named Range with add method for worksheet + IName namedData = sheet.Names.Add("NamedData", sheet.Range["A2:C3"]); + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + This method is used to defines a new name. + + Name object to add. + Returns a Name object. + + To know more about named ranges refer this link. + + The following code illustrates how to use Add method in named range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 88; + IName namedStuName = workbook.Names.Add("StudentName", sheet.Range["B1"]); + + //method is defines a new name + IName namedData = sheet.Names.Add(namedStuName); + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Removes Name object from the collection. + + Name of the object to remove from the collection. + + To know more about named ranges refer this link. + + The following code illustrates how to use Remove method in named range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 88; + IName namedStuID = workbook.Names.Add("StudentID", sheet.Range["A1"]); + IName namedStuName = workbook.Names.Add("StudentName", sheet.Range["B1"]); + IName namedStuMark = workbook.Names.Add("StudentMark", sheet.Range["C1"]); + + //Removes Name object from the collection + workbook.Names.Remove("StudentID"); + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Removes the element at the specified index of the collection. + + The zero-based index of the element to remove. + The following code illustrates how to use Remove method in named range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 88; + IName namedStuID = workbook.Names.Add("StudentID", sheet.Range["A1"]); + IName namedStuName = workbook.Names.Add("StudentName", sheet.Range["B1"]); + IName namedStuMark = workbook.Names.Add("StudentMark", sheet.Range["C1"]); + + //Removes Name object from the collection + workbook.Names.RemoveAt(0); + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Checks whether the Name object is present in the collection or not. + + Name object to check whether it is present or not. + True if given name is found in Names collection. + + To know more about Named Ranges refer this link. + + The following code illustrates how to use Contains method in named range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 88; + IName namedStuID = workbook.Names.Add("StudentID", sheet.Range["A1"]); + IName namedStuName = workbook.Names.Add("StudentName", sheet.Range["B1"]); + IName namedStuMark = workbook.Names.Add("StudentMark", sheet.Range["C1"]); + + //Checks whether the Name object is present in the collection or not + bool isContainsNamedRange = workbook.Names.Contains("StudentMark"); + if(isContainsNamedRange) + { + //Your Code Here + } + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Used without an object qualifier, this property returns an + object that represents the Excel application. + + + To know more about named ranges refer this link. + + The following code illustrates use of Application property in named range collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //Gets object that represents the Excel application + IApplication namedApplication = sheet.Names.Application; + if (namedApplication != null) + { + //Your Code here + } + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Returns the number of objects in the collection. + + + To know more about named ranges refer this link. + + The following code illustrates use of Count property in named range collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //Gets the number of objects in the collection + int namedRangesCount = sheet.Names.Count; + if (namedRangesCount != 0) + { + //Your Code here + } + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Returns the parent object for the specified object. + + + To know more about Named Ranges refer this link. + + The following code illustrates use of Parent property in named range collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //Gets the parent object for the specified object + object namedParent = sheet.Names.Parent; + if(namedParent != null) + { + //Your Code Here + } + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Returns a single object from a Names collection. + + + To know more about Named Ranges refer this link. + + The following code illustrates how to get named range using index. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 88; + + //Create a Named Range using WorkBook + IName namedTitle = workbook.Names.Add("NamedTitle"); + + //Returns the index number of the object within the collection of similar objects + workbook.Names[0].Name = "Titles"; + workbook.Names[0].Value = "Sheet1!$A$1:$C$1"; + + //Create a Named Range using WorkSheet + IName namedData = sheet.Names.Add("NamedData"); + + //Returns the index number of the object within the collection of similar objects + sheet.Names[0].Name = "Records"; + sheet.Names[0].Value = "Sheet1!$A$2:$C$3"; + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Returns a single object from a names collection. + + + To know more about Named Ranges refer this link. + + The following code illustrates how to get named range using string. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 88; + + //Create a Named Range using WorkBook + IName namedTitle = workbook.Names.Add("NamedTitle"); + + //Returns a single Name object from a Names collection + workbook.Names["NamedTitle"].Name = "Titles"; //Here Name is changed from NamedTitle to Titles + workbook.Names["Titles"].Value = "Sheet1!$A$1:$C$1"; + + //Create a Named Range using WorkSheet + IName namedData = sheet.Names.Add("NamedData"); + + //Returns a single Name object from a Names collection + sheet.Names["NamedData"].Name = "Records"; //Here Name is changed from NamedData to Records + sheet.Names["Records"].Value = "Sheet1!$A$2:$C$3"; + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Returns parent worksheet of the collection. + + + To know more about named ranges refer this link. + + The following code illustrates use of ParentWorksheet property in named range collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //Gets the number of objects in the collection + IWorksheet namedParentWorksheet = sheet.Names.ParentWorksheet; + if(namedParentWorksheet != null) + { + //Your Code Here + } + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Dictionary Name-to-IName. + + + + + Parent workbook for the collection. + + + + + Flags indicating whether WorkbookNamesCollection changed. + + + + + Creates an empty collection. + + Application object for the collection. + Parent object for the collection. + + + + + + + + + + + Checks whether name of named range contains invalid characters. + + + + + + OnClear is invoked after Clear behavior. + + + + + Defines a new name. Returns a Name object. + + Name of the new collection entry. + Range that will be associated with the name. + Created IName object. + + If the collection already contains object with the same name + or if specified name string is empty. + + + When one of the arguments is NULL. + + + + + Checks the namedRange's name is a valid name based on the + Excel version. + + name to check. + Active workbook. + True, if the name is valid. + + + + Defines a new name. Returns a Name object. + + IName object that must be added to the collection. + Created IName object. + + If the collection already contains object with the same name. + + + + + Removes specified name from the collection. + + Name of the object to remove. + + + + Removes the element at the specified index from the collection. + + The zero-based index of the element to remove. + + + + + + + + + + + + + + + + + + + Name + Indicate whether formula range or not + true/false + + + + Updates named range when inserting row. + + Represents row index. + Represents row count. + Represents sheet for update. + + + + Updates named range when deleting row. + + Represents row index. + Represents sheet for update. + + + + Updates named range when deleting row. + + Represents row index. + Represents sheet for update. + Number of rows to remove. + + + + Updates named ranges after column insertion. + + One-based column index. + Number of columns to insert. + Represents reference sheet name. + + + + Updates named ranges after column removal. + + One-based column index. + Represents reference sheet name. + + + + Updates named ranges after column removal. + + One-based column index. + Represents reference sheet name. + Number of columns to remove. + + + + Defines a new name. Returns a Name object. + + NameRecord describing new Name object. + Newly created Name object. + + If the collection already contains object with the same name. + + + When specified NameRecord is NULL. + + + + + Defines multiple names. + + + Array of Name Records that describes new Name objects. + + + If the collection already contains object with the same name. + + + When array of NameRecords is NULL. + + + + + Saves all NameRecords to the specified OffsetArrayList. + + + OffsetArrayList that will receive all NameRecords. + + + If specified OffsetArrayList is NULL. + + + + + Adds into list and hashtable, for local named ranges. + + Name to add. + + + + Adds into list and hashtable, for local named ranges. + + Name to add. + Indicates is adds in global names hash. + + + + Sorts named range in the order which they must be serialized. + + + + + Returns sorted list with worksheets names. + + Sorted list with worksheets names. + + + + Sorts names by worksheet name. + + List with worksheets names. + Array of new indexes for names. + + + + Searches for named ranges with same name in other worksheets. + + Name to find. + Key for global named ranges. + SortedListEx with found names. + + + + Adds name to the list. + + List to insert name into. + Names collection to search for name. + Name to find. + Parent worksheet name (used as key in the list). + + + + Updates names indexes in formulas. + + New indexes of the named ranges. + + + + Sets index of all named ranges without event raising. + + + + + Forces all named ranges to parse its data. + + + + + Adds local user-defined function. + + Function to add. + Name index of the added function. + + + + Gets name record by index. + + Index of name object in collection. + Returns named record. + + + + Adds copy of global name during worksheet copy. + + Name to copy. + Destination worksheet. + Dictionary with new extern worksheet names. + Dictionary with new worksheet names. + Added name. + + + + Sets reference index in the all tokens. + + Name record to update. + New reference index. + + + + Creates a copy of the current collection. + + Parent object for the new collection. + A copy of the current collection. + + + + Performs additional processes after inserting a new element into the collection. + + The zero-based index at which to insert value. + The new value of the element at the index. + + + + Converts full row or column tokens between versions. + + Version to convert into. + + + + Returns a single Name object from a Names collection. + + + + + Sets parent workbook value. + + + When parent workbook cannot be found. + + + + + Inserts/removes rows/columns from all named ranges in the collection. + + Represents sheet name. + Index of row/column to insert/remove. + Indicates whether we should remove rows or columns. + Indicates whether we are operating with rows. + Number of rows/columns to insert/remove. + + + + Inserts/removes row from all named ranges in the collection. + + + + + + + + + + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Updates the named ranges on moving the ranges + + Destination Range + Source Range + Excel Copy Range Option + + + + Indicates whether the name exist in the workbook + + Name of the named range + + + + Returns a single Name object from a Names collection. + + + + + Returns a single Name object from a Names collection. + + + + + Returns a single Name object from a Names collection by integer index in the API level + + + + + Returns a single Name object from a Names collection by name in the API level + + + + + Returns parent worksheet of the collection. + + + + + Represent the known named ranges count + The name in the formula which has no reference is + unknown named ranges + + + + + Represents the known and unknown named + ranges Count + + + + + set Flags m_bWorkNamesChanged + + + + + + Summary description for WorkbookObjectsCollection. + + + + + Represents a collection of in the worksheet. + + + + + Moves sheet into new location. + + Index of the sheet. + New index to move the sheet. + + + + Moves specified sheet before another sheet. + + The sheet to move. + The sheet to locate new position. + + + + Moves specified sheet after another sheet. + + The sheet to move. + The sheet to locate new position. + + + + Gets the number of in the collection. Read-only. + + + + + Gets the at the specified index. Read-only. + + + + + Dictionary name of the object - to - value. + + + + + Parent workbook. + + + + + Creates a collection and sets its Application and Parent properties. + + Application object for the collection. + Parent object for the collection. + + + + Add new object to the collection. + + Named object to adding. + + + + Moves sheet from one position into another. + + Old sheet index. + New sheet index. + + + + Moves specified tab sheet before another tab sheet. + + The tab sheet to move. + The tab sheet to locate new position. + + + + Moves specified tab sheet after another tab sheet. + + The tab sheet to move. + The tab sheet to locate new position. + + + + Disposes internal data. + + + + + Creates copy of the collection. + + Parent object for the new collection. + A copy of the collection. + + + + Searches for all necessary parents. + + + + + Performs additional processes after inserting a new element into the collection. + + The zero-based index at which to insert value. + The new value of the element at index. + + + + Performs additional processes after setting a value in the collection. + + The zero-based index at which oldValue can be found. + The value to replace with newValue. + The new value of the element at the index. + + + + Performs additional processes after removing an element from the collection. + + The zero-based index at which value can be found. + The value of the element to remove from the index. + + + + OnClear is invoked after Clear behavior. + + + + + This method is called when sheet name was changed. + + Sender of the event. + Event arguments. + + When workbook already contains worksheet with specified name. + + + + + + + + + + + + + + + Parent workbook. + + + + + Returns single entry from the collection. + + + + + + + + + + + + + + + + Old index in the tab sheets collection. + + + + + New index in the tab sheets collection. + + + + + Default constructor. + + + + + Initializes new instance of the event arguments. + + Old index in the tab sheets collection. + New index in the tab sheets collection. + + + + Returns old index in the tab sheets collection. Read-only. + + + + + Returns new index in the tab sheets collection. Read-only. + + + + + + + + + + + A collection of all the Workbook objects that are currently open in + the XlsIO application. + + + + + A collection of all the Workbook objects that are currently open in + the Excel application. + + + + + Create empty workbook. The new workbook becomes the active workbook. + + Interface on instance of created workbook. + + + + Create workbook with specified quantity of empty worksheets. + + Quantity of worksheets to create. + Interface on instance of created workbook. + + + + Create workbook with specified names. + Each worksheet name will be set to corresponding names array element. + + Array of names for each worksheet. + Interface on instance of created workbook. + + + + Creates a new workbook. The new workbook becomes the active workbook. + Returns a Workbook object. + + Added Workbook object. + + + + Creates a new workbook. The new workbook becomes the active workbook. + + Excel version - defines file format (excel 97-2003 or excel 2007). + Added Workbook object. + + + + Creates a new workbook. The new workbook becomes the active workbook. + Returns a Workbook object. + + File that contains required workbook. + Added Workbook object. + + + + Creates a new workbook. The new workbook becomes the active workbook. + Returns a Workbook object. + + File that contains required workbook. + Excel version - defines file format (excel 97-2003 or excel 2007). + Added Workbook object. + + + + Creates a new workbook. The new workbook becomes the active workbook. + Returns a Workbook object. + + File that contains required workbook. + Parse options. + Added Workbook object. + + + + Creates a new workbook. The new workbook becomes the active workbook. + Returns a Workbook object. + + File that contains required workbook. + Parse options. + Excel version - defines file format (excel 97-2003 or excel 2007). + Added Workbook object. + + + + Opens a workbook. + + File name that contains workbook. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Excel version - defines file format (excel 97-2003 or excel 2007). + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Parse options. + Opened workbook. + + + + Opens a Workbook using separator. + + File name to open. + Denotes separator for the CSV file types. + Number of first row to write. + Number of first column to write. + Opened WorkBook. + + + + Opens a Workbook using separator. + + File name to open. + Denotes separator for the CSV file types. + Number of first row to write. + Number of first column to write. + Encoding to use to parse text data. + Opened WorkBook. + + + + Opens a Workbook using separator. + + Stream to open. + Denotes separator for the CSV file types. + Encoding to use to parse text data. + Opened WorkBook. + + + + Opens a Workbook using separator. + + Stream to open. + Denotes separator for the CSV file types. + Encoding to use to parse text data. + Opened WorkBook. + + + + Opens a Workbook using default separator. + + Stream to open. + Encoding to use to parse text data. + Opened WorkBook. + + + + Open new workbook in read-only mode. + + File to open. + Newly created workbook. + + + + Open new CSV file in read-only mode. + + File to open. + String separator. + Newly created workbook. + + + + Open new workbook in read-only mode. + + File to open. + Parse options. + Newly created workbook. + + + + Open new workbook in read-only mode. + + File to open. + Represents open type for open. + Parse options. + Newly created workbook. + + + + Open new workbook in read-only mode. + + File to open. + Parse options. + Indicates is open book in read - only mode. + Password that should be used for decryption. + Newly created workbook. + + + + Opens a workbook. + + File name that contains workbook. + Parse options. + Indicates is open book in read - only mode. + Represents valid password for opening workbook. + Workbook version. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Parse options. + Indicates is open book in read - only mode. + Represents valid password for opening workbook. + Represents type of the file for open operation. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Represents open type for open. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Represents open type for open. + Parse options. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Represents open type for open. + Desired version of the workbook. + Opened workbook. + + + + Read workbook from xml file. + + Full path to xml file. + Xml open type. + Returns opened workbook. + + + + Reads workbook from the stream. + + Stream with workbook's data. + Newly created workbook. + + + + Reads workbook from the stream. + + Stream with workbook's data. + Excel version - defines file format (excel 97-2003 or excel 2007). + Newly created workbook. + + + + Reads workbook from the stream. + + Stream with workbook's data. + Parse options. + Newly created workbook. + + + + Opens a Workbook using separator. + + Stream to open. + Denotes separator for the CSV file types. + Number of first row to write. + Number of first column to write. + Opened WorkBook. + + + + Opens a Workbook using separator. + + Stream to open. + Denotes separator for the CSV file types. + Number of first row to write. + Number of first column to write. + Encoding to use to parse text data. + Opened WorkBook. + + + + Opens a Workbook using separator. + + Stream to open. + Denotes separator for the CSV file types. + Opened WorkBook. + + + + Opens a Workbook using separator. + + Stream to open. + Denotes separator for the CSV file types. + Encoding to use to parse text data. + Opened WorkBook. + + + + Opens a Workbook using default separator. + + Stream to open. + Encoding to use to parse text data. + Opened WorkBook. + + + + Opens the specified stream. + + The stream. + Parse options. + Indicates is open book in read - only mode. + Password that should be used for decryption. + Newly created workbook. + + + + Opens the specified stream. + + The stream. + Parse options. + Indicates is open book in read - only mode. + Represents valid password for opening workbook. + Workbook version. + Opened workbook. + + This method is not supported in WinRT, Windows Phone, Portable, Universal and Silverlight platforms. + + + + + Opens the specified stream. + + The stream. + Parse options. + Indicates is open book in read - only mode. + Represents valid password for opening workbook. + Represents type of the file for open operation. + Opened workbook. + + + + Opens a workbook. + + Stream with workbook's data. + Represents open type for open. + Opened workbook. + + + + Opens a workbook. + + Stream with workbook's data. + Represents open type for open. + Parse options. + Opened workbook. + + + + Opens a workbook. + + Stream with workbook's data. + Represents open type for open. + Desired version of the workbook. + Opened workbook. + + + + Read workbook from file stream. + + File stream. + Xml open type. + Returns opened workbook. + + + + Read workbook from xml stream. + + Xml reader. + Xml open type. + Returns opened workbook. + + + + Closes the object. + + + + + Pastes workbook from clipboard. + + Returns a parent Workbook object + + + + Used without an object qualifier, this property returns an + Application object that represents the Excel application. + + + + + Returns the number of objects in the collection. Read-only Long. + + + + + Returns a single object from a collection. + + + + + Returns the parent object for the specified object. + + + + + Default regular expression options. + + + + + Create workbook with names.Length quantity of worksheets. + Each worksheet name will be set to corresponding names array element. + + Array of names for each worksheet. + Interface on instance of created workbook. + + When names array is NULL. + + + When names does not contain any value. + + + + + Create workbook with specified number of empty worksheets. + + Number of worksheets to create. + Interface on instance of created workbook. + + When sheetsQuantity is less than zero. + + + + + Create new empty workbook and make it active. + + Interface on instance of newly created workbook. + + + + Sets the Application name as Essential XlsIO. + + + + + + Creates a new workbook. The new workbook becomes the active workbook. + Returns a Workbook object. + + Added Workbook object. + + + + Creates a new workbook. The new workbook becomes the active workbook. + + Excel version - defines file format (excel 97-2003 or excel 2007). + Added Workbook object. + + + + Creates a new workbook. The new workbook becomes the active workbook. + Returns a Workbook object. + + File that contains required workbook. + Added Workbook object. + + + + Creates a new workbook. The new workbook becomes the active workbook. + Returns a Workbook object. + + File that contains required workbook. + Excel version - defines file format (excel 97-2003 or excel 2007). + Added Workbook object. + + + + Adds workbook to the collection. + + File to parse. + Parse options. + Created workbook. + + + + Creates a new workbook. The new workbook becomes the active workbook. + Returns a Workbook object. + + File that contains required workbook. + Parse options. + Excel version - defines file format (excel 97-2003 or excel 2007). + Added Workbook object. + + + + Opens a workbook. + + File name that contains workbook. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Version of the excel file format. + Opened workbook. + + + + Opens a Workbook using separator. + + Stream to open. + Denotes separator for the CSV file types. + Number of first row to write. + Number of first column to write. + Opened WorkBook. + + + + Opens a Workbook using separator. + + Stream to open. + Denotes separator for the CSV file types. + Number of first row to write. + Number of first column to write. + Encoding to use to parse text data. + Opened WorkBook. + + + + Opens a Workbook using separator. + + Stream to open. + Denotes separator for the CSV file types. + Number of first row to write. + Number of first column to write. + Name of the file that is being opened. + Opened WorkBook. + + + + Opens a Workbook using separator. + + Stream to open. + Denotes separator for the CSV file types. + Number of first row to write. + Number of first column to write. + Name of the file that is being opened. + Opened WorkBook. + + + + Opens a Workbook using separator. + + File name to open. + Denotes separator for the CSV file types. + Number of first row to write. + Number of first column to write. + Opened WorkBook. + + + + Opens a Workbook using separator. + + File name to open. + Denotes separator for the CSV file types. + Number of first row to write. + Number of first column to write. + Opened WorkBook. + + + + Opens a Workbook using separator. + + Stream to open. + Denotes separator for the CSV file types. + Opened WorkBook. + + + + Opens a Workbook using separator. + + Stream to open. + Denotes separator for the CSV file types. + Opened WorkBook. + + + + Opens a Workbook using separator. + + Stream to open. + Denotes separator for the CSV file types. + Opened WorkBook. + + + + Opens a Workbook using separator. + + Stream to open. + Denotes separator for the CSV file types. + Encoding to use to parse text data. + Opened WorkBook. + + + + Opens a Workbook using default separator. + + Stream to open. + Encoding to use to parse text data. + Opened WorkBook. + + + + Opens a Workbook using separator. + + Stream to open. + Denotes separator for the CSV file types. + Encoding to use to parse text data. + Opened WorkBook. + + + + Opens a Workbook using default separator. + + Stream to open. + Encoding to use to parse text data. + Opened WorkBook. + + + + Opens a workbook. + + File name that contains workbook. + Parse options. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Parse options. + Indicates is open book in read - only mode. + Represents valid password for opening workbook. + Opened workbook. + + This method is not supported in WinRT, Windows Phone, Portable, Universal and Silverlight platforms. + + + + + Opens the specified stream. + + The stream. + Parse options. + Indicates is open book in read - only mode. + Represents valid password for opening workbook. + Opened workbook. + + + + Opens the specified stream. + + The stream. + Parse options. + Indicates is open book in read - only mode. + Represents valid password for opening workbook. + Workbook version. + Opened workbook. + + + + Opens the specified stream. + + The stream. + Parse options. + Indicates is open book in read - only mode. + Represents valid password for opening workbook. + Represents type of the file for open operation. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Parse options. + Indicates is open book in read - only mode. + Represents valid password for opening workbook. + Workbook version. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Parse options. + Indicates is open book in read - only mode. + Represents valid password for opening workbook. + Represents type of the file for open operation. + Opened workbook. + + + + Read workbook from the stream. + + Stream with workbook's data. + Newly created workbook. + + + + Read workbook from the stream. + + Stream with workbook's data. + Version of the excel file format. + Newly created workbook. + + + + Read workbook from the stream. + + Stream with workbook's data. + Version of the excel file format. + Newly created workbook. + + + + Read workbook from the stream. + + Stream with workbook's data. + Parse options. + Newly created workbook. + + + + Opens a workbook. + + File name that contains workbook. + Represents type of the file for open operation. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Represents type of the file for open operation. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Represents type of the file for open operation. + Opened workbook. + + + + Opens a workbook. + + File name that contains workbook. + Represents type of the file for open operation. + Opened workbook. + + + + Opens a workbook. + + Stream with workbook's data. + Represents type of the file for open operation. + Opened workbook. + + + + Opens a workbook. + + Stream with workbook's data. + Represents type of the file for open operation. + Opened workbook. + + + + Opens a workbook. + + Stream with workbook's data. + Represents type of the file for open operation. + Opened workbook. + + + + Opens a workbook. + + Stream with workbook's data. + Represents type of the file for open operation. + Opened workbook. + + + + Opens a workbook. + + Stream with workbook's data. + Represents type of the file for open operation. + Opened workbook. + + + + Read workbook from xml file. + + Path to xml file. + Xml open type. + Returns opened workbook. + + + + Read workbook from xml file. + + Path to xml file. + Xml open type. + Returns opened workbook. + + + + Replaces xml stream with proper process instruciton. + + Current file stream. + + + + + Read workbook from xml stream. + + Xml reader. + Xml open type. + Returns opened workbook. + + + + Open new workbook in read-only mode. + + File to open. + Newly created workbook. + + + + Open new CSV workbook in read-only mode. + + File to open. + Separator to use. + Newly created workbook. + + + + Open new workbook in read-only mode. + + File to open. + Parse options. + Newly created workbook. + + + + Open new workbook in read-only mode. + + File to open. + Parse options. + Newly created workbook. + + + + Closes the object. + + + + + Creates workbook and sets its Application and Parent properties. + + Application object for the collection. + Parent object for the collection. + + + + Copies workbook from the clipboard. + + Pasted workbook. + + + + Version has been detect while adding the workbook + + Represent the file name + return the version + + + + Returns a single object from a collection. + + + + + + + + + + Represents a collection of embedded charts. + + + + + Creates a new chart. + + Newly created chart object. + + + + Removes Chart object from the collection. + + Index of the chart to remove. + + + + Returns the number of objects in the collection. Read-only Long. + + + + + Returns a single Chart object from a Charts collection. + + + + + Returns a single Chart object from the Charts collection. + + Chart name + IChartShape object + + + + Parent worksheet. + + + + + + + + + + + + Adds chart. + + Added chart. + + + + Adds new chart to the collection (doesn't add it to the shapes collection). + + Chart to add. + Added chart. + + + + Adds new chart to the collection. + + Chart to add. + Added chart. + + + + Searched for all necessary parents. + + + If can't find parent worksheet. + + + + + Creates a new chart. + + Newly created chart object. + + + + Remove chart with specified index. + + Index of chart to remove. + + + + Returns a single Chart object from a Charts collection. + + + + + Returns a single Chart object from a Charts collection. + + Chart name + IChartShape object + + + + Summary description for WorksheetConditionalFormats. + + + + + Dictionary with all ConditionalFormats. Used to check whether format is unique. + + + + + List of CFEx Records. + + + + + List of conditional format removed records. + + + + + Indicates whether to get the conditional format or not. + + + + + Initializes new instance of the collection. + + Application object for the new collection. + Parent object for the new collection. + + + + Search for collection that contains all specified ranges. + + + + + + + Add the CF to output CF + + + + + + + + Defines whether collection contains conditional format. + + Conditional formats. + Conditional formats if exists or null. + + + + Adds new item to the collection. + + Item to add. + Object that contains required cells. + + + + Removes range from the collection of conditional formats. + + Array of ranges to remove. + + + + Removes range from the collection of conditional formats. + + Array of ranges to remove. + + + + Copies conditional formats from another formats collection. + + Source collection of conditional formats to copy. + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + + + + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Disposes conditional formats + + + + + Serializes all conditional formats as Biff records. + + OffsetArrayList to serialize records into. + + + + Updates properties from extended conditional formatting record + + CFRecord to be updated + CFExRecord that represents extended properties for the CFRecord + + + + Converts the RGB as Color value. + + RGB Value. + Returns Color value. + + + + Updates conditional format formulas. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + List the conditional format removed collections. + + + + + Indicates whether to get the conditional format or not. + + + + + Represents collection of all custom properties in the worksheet. + + + + + + + + + + + + Default capacity of internal buffers. + + + + + Array which store keys in sorted order. + + + + + Collection stores values. + + + + + Size of collection. + + + + + Version of collection data. + + + + + Default comparer for keys. + + + + + List of keys. + + + + + List of values. + + + + + Default constructor. + + + + + Creates an empty list with the specified initial capacity. + + Initial capacity. + + When initialCapacity is less than zero. + + + + + Creates an empty SortedList with the default initial capacity + and specified comparer. + + + The IComparer is used to determine whether two keys are equal. + + + + + Creates an empty SortedList with the specified initial capacity + and specified comparer. + + Initial capacity. + + The IComparer is used to determine whether two keys are equal. + + + + + Copies the elements from the specified dictionary to a new list + with the same initial capacity as the number of elements copied. + + The IDictionary to copy. + + + + Copies the elements from the specified dictionary to a new list with the same + initial capacity as the number of elements copied and with the specified comparer. + + The IDictionary to copy. + + The IComparer to use to determine whether two keys are equal. + + + When argument d is null. + + + + + Returns a synchronized (thread-safe) wrapper for the SortedList. + + The SortedList to synchronize. + A synchronized (thread-safe) wrapper for the SortedList. + + When list is null. + + + + + Adds an element with the provided key and value to the list. + + The Object to use as the key of the element to add. + The Object to use as the value of the element to add. + + When key is null. + + + When list already contains specified key. + + + + + Removes all elements from the collection. + + + + + Creates a new object that is a copy of the current instance. + + Copy of the current instance. + + + + Clone current instance. + + Returns clone of current object. + + + + Determines whether the list contains an element with the specified key. + + Key of the element to search. + True if list contains specified key. + + + + Determines whether the list contains an element with the specified key. + + Key of the element to search. + True if list contains specified key. + + + + Determines whether the list contains the specified value. + + Value of the element to search. + True if list contains specified value. + + + + Copies all the elements of the SortedListEx to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + If specified array is null. + + + If rank of the array is not 1 or there are not enough elements. + + + If specified arrayIndex is less than zero. + + + + + Gets the value at the specified index of the SortedListEx. + + The zero-based index of the value to get. + The value at the specified index of the SortedListEx. + + When index is less than zero or greater than size of the list. + + + + + Gets the value at the specified name of the SortedListEx. + + The value to get. + The value at the specified index of the SortedListEx. + + When string is null. + + + + + Gets the key at the specified index of the SortedListEx. + + The zero-based index of the key to get. + The key at the specified index of the SortedListEx. + + When index is less than zero or greater than size of the list. + + + + + Gets the keys in the SortedListEx. + + An IList containing the keys in the SortedListEx. + + + + Gets the values in the SortedListEx. + + An IList containing the values in the SortedListEx. + + + + Returns the zero-based index of the specified key. + + The key to locate. + The zero-based index of key, if key is found; otherwise, -1. + + If specified key is null. + + + + + Returns the zero-based index of the first occurrence of the specified value. + + The value to locate (can be NULL). + + The zero-based index of the first occurrence of value, if value is found; + otherwise, -1. + + + + + Removes the element at the specified index. + + The zero-based index of the element to remove. + + When index is less than zero or greater than size of the list. + + + + + Removes the element with the specified key from SortedListEx. + + The key of the element to remove. + + + + Replaces the value at the specific index. + + The zero-based index at which to save value. + The Object to save into. Can be NULL. + + When index is less than zero or greater than size of the list. + + + + + Sets the capacity to the actual number of elements. + + + + + Returns an IEnumerator that can iterate through the SortedListEx. + + An IEnumerator for the SortedListEx. + + + + + + + + + + Inserts element with specified key and value at specified index. + + The zero-based index to insert element at. + The key of the element to insert. + The value of the element to insert. + + + + Ensures that the capacity of this instance is at least the specified value. + + The minimum capacity to ensure. + + + + Adds item + + + + + + + Checks if the dictonary contains the key + + + + + + + Removes key from dictonary + + + + + + TryGetValue from dictonary + + + + + + + + Adds item + + + + + + Checks if the item exists + + + + + + + + + + + + + + + Removes the item + + + + + + + Capacity of internal buffers. + + + + + Size of the collection. Read-only. + + + + + List of keys. Read-only. + + + + + List of values. Read-only. + + + + + Returns True if list is readonly, False otherwise. Read-only. + + + + + Returns True if collection has fixed size, False otherwise. + + + + + Returns True if the collection is synchronized, False otherwise. + + + + + Returns the object that can be used to synchronize access to the collection. + Read-only. + + + + + Gets or sets the value associated with the specified key. + + + + + + + + + + + + + + + + + List for which is this enumerator. + + + + + Key of the current element. + + + + + Values of the current element. + + + + + Index of current element. + + + + + Starting index for the enumerator. + + + + + Ending index for this enumerator. + + + + + Version of collection data. + + + + + True if current element is correct, False otherwise + (before beginning or after end). + + + + + Creates enumerator for specified list, starting from specified index + and with specified count. + + List for which enumerator is being created. + Starting index. + Number of elements to enumerate. + + + + Performs application-defined tasks associated with freeing, releasing, or + resetting unmanaged resources. + + + + + Creates a new object that is a copy of the current instance. + + Copy of the current instance. + + + + Advances the enumerator to the next element of the collection. + + + True if the enumerator was successfully advanced to the next element; + False if the enumerator has passed the end of the collection. + + + When the current version is not equal to the SortedListEx version. + + + + + Sets the enumerator to its initial position, which is before + the first element in the collection. + + + When the current version is not equal to the SortedListEx version. + + + + + Returns key of the current element. Read-only. + + + When the current version is not equal to the SortedListEx version + or if current is false. + + + + + Return DictionaryEntry for the current element. + + + When the current version is not equal to the SortedListEx version + or if current is false. + + + + + The current element in the collection. Read-only. + + + If current is false. + + + + + The current element in the collection. Read-only. + + + If current is false. + + + + + Returns value for the current element. + + + When the current version is not equal to the SortedListEx version + or if current is false. + + + + + + + + + + + + + + + Index of current element. + + + + + Version of collection data. + + + + + + + + + + + + + + + + + + + + + List for which this collection was created. + + + + + Creates KeyList for specified SortedListEx. + + TypedSortedListEx for which KeyList must be created. + + + + Adds an element with the provided key to the list. + + The Object to use as the key of the element to add. + + + + Removes all elements from the collection. + + + + + Determines whether the list contains an element with the specified key. + + Key of the element to search. + True if list contains specified key. + + + + Copies all the elements of the list to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + If array is null or rank of the array is not 1. + + + + + Copies all the elements of the list to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + If array is null or rank of the array is not 1. + + + + + Insert the value at the specific index. + + The zero-based index at which to save value. + The Object to save into. Can be NULL. + + + + Returns an IEnumerator that can iterate through the list. + + An IEnumerator for the list. + + + + Returns an IEnumerator that can iterate through the list. + + An IEnumerator for the list. + + + + Returns the zero-based index of the specified key. + + The key to locate. + The zero-based index of the key, if the key is found; otherwise, -1. + + + + Removes the element with the specified key from list. + + The key of the element to remove. + + + + Removes the element at the specified index from the list. + + The zero-based index of the element to remove. + + + + Size of the collection. Read-only. + + + + + Returns True if list is readonly, False otherwise. Read-only. + + + + + Returns True if collection has fixed size, False otherwise. + + + + + Returns True if the collection is synchronized, False otherwise. + + + + + Returns the object that can be used to synchronize access to the collection. + Read-only. + + + + + Gets or sets the key at the specified index. + + + + + + + + + + List for which this collection was created. + + + + + Array that contain values. + + + + + Creates ValueList for specified SortedListEx. + + List for which ValueList must be created. + + + + Re-read values from the list. + + + + + Adds an element with the provided key to the list. + + Value to add. + + + + Removes all elements from the collection. + + + + + Determines whether the list contains an element with the specified value. + + Value to search. + True if list contains specified value. + + + + Copies all the elements of the list to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + + + Copies all the elements of the list to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + + + Insert the value at the specific index. + + The zero-based index at which to save value. + The Object to save into. Can be NULL. + + + + Returns an IEnumerator that can iterate through the list. + + An IEnumerator for the list. + + + + Returns an IEnumerator that can iterate through the list. + + An IEnumerator for the list. + + + + Returns the zero-based index of the specified value. + + The value to locate. + The zero-based index of the value, if the value is found, otherwise -1. + + + + Removes the specified value from list. + + The value to remove. + + + + Removes the element at the specified index from the list. + + The zero-based index of the element to remove. + + + + Size of the collection. Read-only. + + + + + Returns True if list is readonly, False otherwise. Read-only. + + + + + Returns True if collection has fixed size, False otherwise. + + + + + Returns True if the collection is synchronized, False otherwise. + + + + + Returns the object that can be used to synchronize access to the collection. + Read-only. + + + + + Gets or sets the value at the specified index. + + + + + Returns a CustomProperties object representing the identifier information associated with a worksheet. + + + + + Adds new property to the collection. + + Name of the new property. + Newly created property. + + + + Determines whether collection contains property with a specific name. + + The name of the property to locate. + True if collection contains required element. + + + + Gets single entry from the collection by index based on specified int value. Read-only. + + + + + Gets single entry from the collection by index based on specified string value. Read-only. + + + + + Gets number of elements in the collection. Read-only. + + + + + Default constructor. + + + + + Extracts custom properties from the array of Biff records. + + Array to parse. + Position of the first custom property. + + + + Serializes collection into as set of Biff records. + + OffsetArrayList to serialize into. + + + + Adds new property to the collection. + + Name of the new property. + Newly created property. + + + + Adds new property to the collection. + + Property to add. + Added property. + + + + Adds new property to the collection. + + Property to add. + Added property. + + + + Returns single entry from the collection by index. Read-only. + + + + + Returns single entry from the collection by index. Read-only. + + + + + Summary description for NamesCollection. + + + + + Dictionary Name-to-IName + + + + + Parent workbook for the collection. + + + + + Parent worksheet for the collection. + + + + + Creates new empty collection. + + Application object for the collection. + Parent object for the new collection. + + + + Renames name in Name-to-IName hashtable. + + New name implementation. + Old name. + + + + Adds new named range to the collection. + + Name of the new named range. + Newly added named range. + + + + Defines a new name. + + Name for the new Name object. + Range that will be associated with the Name. + Newly created Name object. + + + + Get existing IName. + + Name for the new Name object. + if nameImpl is true return NameImpl, otherwise return null + + + + Defines a new name. + + Name object to add. + Added Name object. + + If name argument is NULL. + + + + + Defines a new name. + + Name object to add. + Indicates is adds in global names hash. + Added Name object. + + If name argument is NULL. + + + + + Removes Name object from the collection. + + Name of the object to remove. + + + + Removes the element at the specified index from the collection. + + The zero-based index of the element to remove. + + + + Clear collection. + + + + + Checks whether collection contains named range. + + Name of the named range to search. + True if collection contains such named range; otherwise returns False. + + + + Checks whether collection contains named range. + + Name + Indicate whether formula range or not + true/false + + + + Represent the known named ranges count + + + + + Adds a new name only to this collection (without registering it in the workbook names collection). + + Name object to add. + Added Name object. + + If name argument is NULL. + + + + + Defines a new name. + + NameRecord containing info for new Name object. + Name object that was added to the collection. + + If specified NameRecord is NULL. + + + + + Defines a new name. + + NameRecord containing info for new Name object. + Indicates is adds in global names hash. + Name object that was added to the collection. + + If specified NameRecord is NULL. + + + + + Defines range of new names. + + + Array of NameRecords containing info for new Name objects. + + + If array of NameRecords is NULL. + + + + + Fills Names. + + Source names collection. + Dictionary with modified worksheet names. + Flags for filling. + Dictionary, key - old name index, value - new name index. + Represents hash table with new extern sheet indexes. + + + + Updates reference indexes in the name record. + + Name record to update. + Old workbook object. + Dictionary with new worksheet names. + Dictionary with changed extern sheet indexes. + New workbook object. + + + + Sets sheet index. + + Sheet index to set. + + + + Returns existing or creates new name. + + Name to create. + Required name. + + + + Converts full row or column tokens between versions. + + Version to convert into. + + + + Returns a single Name object from a Names collection. + + + + + Sets parent workbook and worksheet for the collection. + + + If the parent workbook or worksheet cannot be found. + + + + + Performs additional processes after inserting a new element into the collection. + + The zero-based index at which to insert value. + The new value of the element at the index. + + + + Returns a single Name object from a Names collection. + + + + + Returns parent worksheet of the collection. + + + + + Represent the known named ranges count + The name in the formula which has no reference is + unknown named ranges + + + + + Returns a single Name object from a Names collection. + + + + + A collection of all the Worksheet objects in the specified or + active workbook. Each Worksheet object represents a worksheet. + + + + + A collection of all the Worksheet objects in the specified or + active workbook. Each Worksheet object represents a worksheet. + + + + + Add a copy of the specified worksheet to the worksheet collection. + + Index of the workbook that should be copied + Returns newly added Worksheet object + + + + Add a copy of the specified worksheet to the worksheet collection. + + Index of the workbook that should be copied + Represents copy options flags. + Returns copied sheet. + + + + Add a copy of the specified worksheet to the worksheet collection. + + + Worksheet to add. It is not necessary; should be worksheet + from this collection. + + Added worksheet. + + + + Adds copy of worksheet. + + Worksheet to copy. + Represents copy flags. + Copy of worksheet that was added. + + + + Add a copy of the specified worksheets to the worksheet collection. + + Worksheets to add. + + + + Adding worksheets collection to current workbook. + + Source worksheets collection. + Represents copy option flags. + + + + Create worksheet with specified name. + + New name of worksheet. Must be unique for collection. + Reference on created worksheet. + + + + Create a new worksheet. + + Reference on created worksheet. + + + + Remove worksheet from collection. + + Reference on worksheet to remove. + + + + Removes specified worksheet from the collection. + + Name of the sheet to remove. + + + + Removes specified worksheet from the collection. + + Index of the sheet to remove. + + + + Returns the first occurrence of the specified string value with the specified . + + Value to search. + Type of value to search. + Returns the first cell with a specified string value, or null if value was not found. + + + + Returns the first occurrence of the specified string value with the specified and . + + Value to search. + Type of value to search. + Way to search the value. + Returns the first cell with a specified string value and specified find options , or null if value was not found. + + + + Returns the first occurrence of the specified double value with the specified . + + Value to search. + Type of value to search. + Returns the first cell with a specified double value, or null if value was not found. + + + + Returns the first occurrence of the specified bool value. + + Value to search. + Returns the first cell with a specified bool value, or null if value was not found. + + + + Returns the first occurrence of the specified DateTime value. + + Value to search. + Returns the first cell with a specified DateTime value, or null if value was not found. + + + + Returns the first occurrence of the specified TimeSpan value. + + Value to search. + Returns the first cell with a specified TimeSpan value, or null if value was not found. + + + + Returns the cells of the specified string value with the specified . + + Value to search. + Type of value to search. + Returns the cells with a specified string value, or null if value was not found. + + + + Returns the cells of the specified string value with the specified and . + + Value to search. + Type of value to search. + Way to search. + + Returns the cells with a specified string value and specified find options , or null if value was not found. + + + + + Returns the cells of the specified double value with the specified . + + Value to search. + Type of value to search. + All found cells, or Null if value was not found. + + + + Returns the cells of the specified bool value. + + Value to search. + Returns the cells with a specified bool value, or null if value was not found. + + + + Returns the cells of the specified DateTime value. + + Value to search. + Returns the cells with a specified DateTime value, or null if value was not found. + + + + Returns the cells of the specified TimeSpan value. + + Value to search. + Returns the cells with a specified TimeSpan value, or null if value was not found. + + + + Adds copy of sheet to collection before chosen sheet. + + Represents worksheet to copy. + Returns copied sheet. + + + + Adds copy of sheet to collection before chosen sheet. + + Represents worksheet to copy. + Represents sheet that, in collection must be after copied sheet. + Returns copied sheet. + + + + Adds copy of sheet to collection after chosen sheet. + + Represents worksheet to copy. + Returns copied sheet. + + + + Adds copy of sheet to collection before chosen sheet. + + Represents worksheet to copy. + Represents sheet that, in collection must be before copied sheet. + Returns copied sheet. + + + + Used without an object qualifier, this property returns an + Application object that represents the Microsoft Excel application. + + + + + Gets the number of objects in the collection. Read-only Long. + + + + + Gets a single object from a collection based on specified int value. Read-only. + + + + + Gets a single object from a collection based on specified string value. Read-only. + + + + + Gets the parent object for the specified object. + + + + + Indicates whether all created range objects should be cached or not. + + + + + Maximum allowed worksheet name length. + + + + + Hash table that contains all worksheets and gives access + to them by worksheet name. + + + + + Parent workbook. + + + + + Indicates whether to use hash for worksheet look up. + + + + + Sheet Name Validator + + + + + Creates a collection and sets its Application and Parent properties. + + Application object for the collection. + Parent object for the collection. + + + + Adds new worksheet into collection. + + Added worksheet. + + + + Removes all references to worksheet from the current collection. + + Worksheet's name to remove. + + + + Moves worksheet inside this collection only. + + Old index in the collection. + New index in the collection. + + + + Updates sheet index after move/insert operation. + + Sheet that was changed. + Old sheet index in the TabSheets collection. + + + + + + + + + + + This method searches for the first cell with specified string value. + + Value to search. + Type of value to search. + First found cell, or Null if value was not found. + + + + This method searches for the first cell with specified string value. + + Value to search. + Type of value to search. + First found cell, or Null if value was not found. + + + + This method searches for the first cell with specified double value. + + Value to search. + Type of value to search. + First found cell, or Null if value was not found. + + + + This method searches for the first cell with specified bool value. + + Value to search. + First found cell, or Null if value was not found. + + + + This method searches for the first cell with specified DateTime value. + + Value to search. + First found cell, or Null if value was not found. + + + + This method searches for the first cell with specified TimeSpan value. + + Value to search. + First found cell, or Null if value was not found. + + + + This method searches for the all cells with specified string value. + + Value to search. + Type of value to search. + All found cells, or Null if value was not found. + + + + This method searches for the all cells with specified string value. + + Value to search. + Type of value to search. + Way to search. + + All found cells, or Null if value was not found. + + + + + This method searches for the all cells with specified double value. + + Value to search. + Type of value to search. + All found cells, or Null if value was not found. + + + + This method searches for the all cells with specified bool value. + + Value to search. + All found cells, or Null if value was not found. + + + + This method searches for the all cells with specified DateTime value. + + Value to search. + All found cells, or Null if value was not found. + + + + This method searches for the all cells with specified TimeSpan value. + + Value to search. + All found cells, or Null if value was not found. + + + + Add worksheet from reader. + + Reader which contains worksheet. + Parse options. + + Indicates whether worksheet should be parsed. + + Dictionary with new extended format indexes used in ignore styles mode. + + Object used to decrypt encrypted records. + Read worksheet. + + + + Adds an empty worksheet. + + Name of the newly created worksheet. + Newly created worksheet. + + + + Add a copy of the specified worksheet to the worksheet collection. + + Index of the workbook that should be copied + Returns copied sheet. + + + + Add a copy of the specified worksheet to the worksheet collection. + + Index of the workbook that should be copied + Represents copy options flags. + Returns copied sheet. + + + + Adds copy of worksheet. + + Worksheet to copy. + Copy of worksheet that was added. + + + + Adds copy of worksheet. + + Worksheet to copy. + Represents copy flags. + Copy of worksheet that was added. + + + + Generates default name. + + Current sheet name. + Returns string with new name. + + + + Adds copy of worksheet. + + Worksheet to copy. + Flags that allows to choose what kind of data should be copied. + Indicates is current sheet is local. + Copy of worksheet that was added. + + + + Returns true, if the sheet contains the ActiveX Control. + + sheet to check ActiveX control. + true, if sheet contains ActiveX control. + + + + Adding worksheets collection to current workbook. + + Source worksheets collection. + + + + Adding worksheets collection to current workbook. + + Source worksheets collection. + Represents copy option flags. + + + + copy the source book external connection to destination book + + The Source Book + The Destination Book + + + + + + + + + + + Adds copy of sheet to collection before chosen sheet. + + Represents worksheet to copy. + Returns copied sheet. + + + + Adds copy of sheet to collection before chosen sheet. + + Represents worksheet to copy. + Represents sheet that, in collection must be after copied sheet. + Returns copied sheet. + + + + Adds copy of sheet to collection after chosen sheet. + + Represents worksheet to copy. + Returns copied sheet. + + + + Adds copy of sheet to collection before chosen sheet. + + Represents worksheet to copy. + Represents sheet that, in collection must be before copied sheet. + Returns copied sheet. + + + + Performs additional processes after inserting a new element into the collection. + + The zero-based index at which to insert value. + The new value of the element at the index. + + + + Performs additional processes after setting a value in the collection. + + The zero-based index at which oldValue can be found. + The value to replace with newValue. + The new value of the element at the index. + + + + Performs additional processes after removing an element from the collection. + + The zero-based index at which value can be found. + The value of the element to remove from the index. + + + + OnClear is invoked after Clear behavior. + + + + + This method is called when sheet name was changed. + + Sender of the event. + Event arguments. + + When workbook already contains worksheet with specified name. + + + + + Creates empty worksheet with specified name. + + New name of worksheet. Must be unique for collection. + Reference on created worksheet. + + When specified name is NULL. + + + + + Creates empty worksheet with automatically generated name. + + Reference on created worksheet. + + + + Remove specified worksheet from workbook collection. + + Reference on worksheet to remove. + + When specified sheet is last sheet in the workbook. + + + + + Removes specified worksheet from the collection. + + Name of the sheet to remove. + + + + Removes specified worksheet from the collection. + + Index of the sheet to remove. + + + + Updates string indexes. + + List with new indexes. + + + + Removes specified worksheet from the collection. + + Index of the sheet to remove. + + + + Adds worksheet into internal collection. + + Worksheet to add. + + + validates the sheet name to avoid the invalid names + + + + Returns a single object from a collection. Read-only. + + + + + Returns a single object from a collection. Read-only. + + + + + Indicates whether all created range objects should be cached. + + + + + Toggles worksheet search algorithm when searching worksheet by name. + + + + + Indicates whether worksheet is displayed right to left. + + + + + Class that represent event args. + + + + + Element index. + + + + + Element value. + + + + + Default constructor. + + + + + Creates new instance of event arguments. + + Changed element index. + Changed element value. + + + + Element index. Read-only. + + + + + Element value. Read-only. + + + + + Represents condition value for colorset condition. + + + + + Represents implementation of single condition value for iconset, databar, colorscale conditions. + + + + + + Represents a condition value for , and conditions. + + + + + Gets or sets a condition value which specifies how the threshold values for a , + and conditional format are determined. + + + By default for IconSets the property is set to . Here for example, + we set to property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "IconSets"; + worksheet["A2"].Number = 105; + worksheet["A3"].Number = 120; + worksheet["A4"].Number = 300; + worksheet["A5"].Number = 240; + worksheet["A6"].Number = 350; + worksheet["A7"].Number = 460; + worksheet["A8"].Number = 170; + worksheet["A9"].Number = 280; + worksheet["A10"].Number = 190; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as IconSet. + format.FormatType = ExcelCFType.IconSet; + IIconSet iconSet = format.IconSet; + + //Set conditions for IconCriteria. + iconSet.IconCriteria[1].Type = ConditionValueType.Percentile; + iconSet.IconCriteria[1].Value = "20"; + iconSet.IconCriteria[1].Operator = ConditionalFormatOperator.GreaterThan; + + iconSet.IconCriteria[2].Type = ConditionValueType.Percentile; + iconSet.IconCriteria[2].Value = "70"; + iconSet.IconCriteria[2].Operator = ConditionalFormatOperator.GreaterThan; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + For DataBars the is set to by default. Here for example, we + set to property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "DataBar"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as DataBar. + format.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = format.DataBar; + + //Set MinPoint for DataBar + dataBar.MinPoint.Value = "30"; + dataBar.MinPoint.Type = ConditionValueType.Percent; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + To set the for refer property. + + + + + Gets or sets the shortest bar or longest bar threshold value for a data bar conditional format. + + + IconSets use list property to set icons, So each object has individual + property. By default the list property holds three objects and those object's property + set "0", "33" and "67" respectively. In our example, we set "20" and "70" to property of second and third objects in + list property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "IconSets"; + worksheet["A2"].Number = 105; + worksheet["A3"].Number = 120; + worksheet["A4"].Number = 300; + worksheet["A5"].Number = 240; + worksheet["A6"].Number = 350; + worksheet["A7"].Number = 460; + worksheet["A8"].Number = 170; + worksheet["A9"].Number = 280; + worksheet["A10"].Number = 190; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as IconSet. + format.FormatType = ExcelCFType.IconSet; + IIconSet iconSet = format.IconSet; + + //Set conditions for IconCriteria. + iconSet.IconCriteria[1].Type = ConditionValueType.Percentile; + iconSet.IconCriteria[1].Value = "20"; + iconSet.IconCriteria[1].Operator = ConditionalFormatOperator.GreaterThan; + + iconSet.IconCriteria[2].Type = ConditionValueType.Percentile; + iconSet.IconCriteria[2].Value = "70"; + iconSet.IconCriteria[2].Operator = ConditionalFormatOperator.GreaterThan; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + For DataBars the default value of property is set to "0". This property is can be changed by getting + or properties. These two properties define the shortest and longest bars of + DataBar. For example, we have set the of to "30". + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "DataBar"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as DataBar. + format.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = format.DataBar; + + //Set MinPoint for DataBar + dataBar.MinPoint.Value = "30"; + dataBar.MinPoint.Type = ConditionValueType.Percent; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + To set the value for refer property. + + + + + Gets or sets the operator for the threshold values in the conditional format. + + + By default is set to and it can be changed to + . In our example, we change the to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "IconSets"; + worksheet["A2"].Number = 105; + worksheet["A3"].Number = 120; + worksheet["A4"].Number = 300; + worksheet["A5"].Number = 240; + worksheet["A6"].Number = 350; + worksheet["A7"].Number = 460; + worksheet["A8"].Number = 170; + worksheet["A9"].Number = 280; + worksheet["A10"].Number = 190; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as IconSet. + format.FormatType = ExcelCFType.IconSet; + IIconSet iconSet = format.IconSet; + + //Set conditions for IconCriteria. + iconSet.IconCriteria[1].Type = ConditionValueType.Percentile; + iconSet.IconCriteria[1].Value = "20"; + iconSet.IconCriteria[1].Operator = ConditionalFormatOperator.GreaterThan; + + iconSet.IconCriteria[2].Type = ConditionValueType.Percentile; + iconSet.IconCriteria[2].Value = "70"; + iconSet.IconCriteria[2].Operator = ConditionalFormatOperator.GreaterThan; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + Similar to IconSets, DataBars also have property set to + by default which can be changed to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "DataBar"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as DataBar. + format.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = format.DataBar; + + //Set MaxPoint for DataBar + dataBar.MaxPoint.Value = "70"; + dataBar.MaxPoint.Type = ConditionValueType.Percent; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + To set the operator for refer property. + + + + Returns or sets one of the constants of the ConditionValueType enumeration + which specifies how the threshold values for a data bar, color scale, + or icon set conditional format are determined. + + + + Returns or sets threshold values for the conditional format. + + + + + Sets the operator for the threshold values in the conditional format. + + + + + Gets or sets the formula value in Ref3DPtg type. + + + + + Equality comparison. + + The first condition to compare. + The second condition to compare. + true if conditions are equal. + + + + Checks whether conditions are not equal. + + The first condition to compare. + The second condition to compare. + true if conditions are not equal. + + + + Initializes new instance of the class. + + Condition type. + Condition value. + + + + Default constructor. + + + + + Creates copy of the condition. + + Copy of the current object. + + + + 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 hash code for this instance. + + A 32-bit signed integer hash code. + + + Gets or sets one of the constants of the ConditionValueType enumeration + which specifies how the threshold values for a data bar, color scale, + or icon set conditional format are determined. + + + + Gets or sets the shortest bar or longest bar threshold value for a data bar conditional format. + + + + + Gets or sets one of the constants of the ConditionalFormatOperator + which specifes operator for the threshold values in the conditional format. + + + + + Gets or sets the formula value in Ref3DPtg type. + + + + + Represents a condition value for color scale conditional format. + + + + + Gets or sets the threshold of a color scale conditional format. + + + The default color scale conditions can be customized by changing , and Properties. + To know more about advanced conditional formatting types refer this link. + + + The criteria for applying ColorScale can be accessed from the Property. Since the default size of the Criteria list + is 2, In our example we access those two objects and set values for . + Here we set each object a color and haven't mentioned any additional condition, So the default conditions will apply shades of these two colors depending + on the values in the cells and set cell colors. + + //Create a worksheet. + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "ColorScale"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as ColorScale. + format.FormatType = ExcelCFType.ColorScale; + IColorScale colorScale = format.ColorScale; + + //Set Color for FormatColorRGB Property. + colorScale.Criteria[0].FormatColorRGB = System.Drawing.Color.White; + colorScale.Criteria[1].FormatColorRGB = System.Drawing.Color.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets or sets the for the color scale conditional format. + + + The property is used to change the of the object. + Default values will be and if the is not set. + If the count is set to 3, then the values will be , and . + In our example we are change the default value of first object in list to and set to 60. + + //Create a worksheet. + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "ColorScale"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as ColorScale. + format.FormatType = ExcelCFType.ColorScale; + IColorScale colorScale = format.ColorScale; + + //Set Type and Value + colorScale.Criteria[0].Type = ConditionValueType.Percent; + colorScale.Criteria[0].Value = "60"; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets or sets the shortest bar or longest bar threshold value for a data + bar conditional format. + + + The default color applied in the color scale can be changed by changing the property. + To know more about the conditional formatting types refer this link. + + + The color bars use Threshold value to set colors to the cells based on the values present in the cells. It can be customized using property. + For default settings, the threshold will be average value of the data present in the cells. Here in our example, we set the threshold value to 80; + + //Create a worksheet. + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "ColorScale"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as ColorScale. + format.FormatType = ExcelCFType.ColorScale; + IColorScale colorScale = format.ColorScale; + + //Set 3 as count for color scale + colorScale.SetConditionCount(3); + + //Change Threshold value for 2nd object in Critera list. + colorScale.Criteria[1].Value = "80"; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets or sets the format operator of condition value for color scale conditional format. + + + To know more about customizing the color scale refer , properties. To check other types of conditional + formatting types refer this link. + + + By default the property is set to , This will set color scale + to the cells above the specified threshold value starting from it. can be used to change the + color scale to set colors above the specified threshold value. + + //Create a worksheet. + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "ColorScale"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as ColorScale. + format.FormatType = ExcelCFType.ColorScale; + IColorScale colorScale = format.ColorScale; + + //Set threshold value and type + colorScale.Criteria[0].Value = "70"; + colorScale.Criteria[0].Type = ConditionValueType.Percent; + + //Set operator to GreaterThan + colorScale.Criteria[0].Operator = ConditionalFormatOperator.GreaterThan; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Color value. + + + + + Initializes new instance of the class. + + Type of the condition. + Value of the object. + Format color. + + + + Default constructor. + + + + + The color assigned to the threshold of a color scale conditional format. + + + + + This object wraps IConditionValue object to ensure correct parent object update. + + + + + Wrapped item. + + + + + Parent object. + + + + + Initiates updates to the object. + + This method should be called before several updates to the object will take place. + + + + Ends updating the object. + + This method should be called after several updates to the object took place. + + + + Initializes new instance of wrapper. + + Object to wrap. + Parent object. + + + + Gets or sets the condition value type + which specifies how the threshold values for a data bar, color scale, + or icon set conditional format are determined. Read-only. + + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + IConditionalFormats conditionalFormats = worksheet.Range["C7:C46"].ConditionalFormats; + IConditionalFormat conditionalFormat = conditionalFormats.AddCondition(); + conditionalFormat.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = conditionalFormat.DataBar; + dataBar.MinPoint.Type = ConditionValueType.LowestValue; + + + + + + Gets or sets the shortest bar or longest bar threshold value for a data bar conditional format. + + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + IConditionalFormats conditionalFormats = worksheet.Range["C7:C46"].ConditionalFormats; + IConditionalFormat conditionalFormat = conditionalFormats.AddCondition(); + conditionalFormat.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = conditionalFormat.DataBar; + dataBar.MinPoint.Value = "0"; + + + + + + Gets or sets the operator + which specifes operator for the threshold values in the conditional format. + + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + IConditionalFormats conditionalFormats = worksheet.Range["C7:C46"].ConditionalFormats; + IConditionalFormat conditionalFormat = conditionalFormats.AddCondition(); + conditionalFormat.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = conditionalFormat.DataBar; + dataBar.MinPoint.Operator = ConditionalFormatOperator.GreaterThanorEqualTo; + + + + + + Gets / sets wrapped object. + + + + + Initializes new instance of the wrapped. + + Object to wrap. + Parent object. + + + + The color assigned to the threshold of a color scale conditional format. + + + + + Returns one of the constants of the XlConditionValueTypes enumeration, + which specifies how the threshold values for a data bar, color scale, + or icon set conditional format are determined. Read-only. + + + + + Returns or sets the shortest bar or longest bar threshold value for a data + bar conditional format. + + + + + Returns or sets one of the constants of the ConditionalFormatOperator enumeration, + which specifes if the threshold is "greater than" or "greater than or equal to" the threshold value. + + + + + Returns wrapped object. + + + + + Represents a condition value for conditions. + + + + + Returns or sets IconSet for individual IconSet criteria. It allows the custom Iconset and works based in the index. + + + Custom IconSet Conditional Formatting allows you to format your data based the IconSet criteria value from . + For example the icon set is initially set to use the icon set, but this IconSet property is used + to override which icons are used for the first or seconde and third criteria. You can set individual icon based on the index of the IconSet Type. + + + The following code illustrates how to use the Custom Iconset. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + // Create icon sets for the data in specified range + IConditionalFormats conditionalFormats = worksheet.Range["H1:K6"].ConditionalFormats; + IConditionalFormat conditionalFormat = conditionalFormats.AddCondition(); + conditionalFormat.FormatType = ExcelCFType.IconSet; + IIconSet iconSet = conditionalFormat.IconSet; + iconSet.IconSet = ExcelIconSetType.FiveBoxes; + IIconConditionValue iconValue1 = iconSet.IconCriteria[0] as IIconConditionValue; + + //Set the Iconset for first IconSet Criteria + iconValue1.IconSet = ExcelIconSetType.FiveArrowsGray; + + iconValue1.Index = 2; + iconValue1.Type = ConditionValueType.Percent; + iconValue1.Value = "25"; + iconValue1.Operator = ConditionalFormatOperator.GreaterThanorEqualTo; + IIconConditionValue iconValue2 = iconSet.IconCriteria[1] as IIconConditionValue; + + //Set the Iconset for second IconSet Criteria + iconValue2.IconSet = ExcelIconSetType.ThreeArrows; + + iconValue2.Index = 0; + iconValue2.Type = ConditionValueType.Percent; + iconValue2.Value = "50"; + iconValue2.Operator = ConditionalFormatOperator.GreaterThan; + IIconConditionValue iconValue3 = iconSet.IconCriteria[2] as IIconConditionValue; + + //Set the Iconset for third IconSet Criteria + iconValue3.IconSet = ExcelIconSetType.FourArrows; + + iconValue3.Index = 1; + iconValue3.Type = ConditionValueType.Percent; + iconValue3.Value = "75"; + iconValue3.Operator = ConditionalFormatOperator.GreaterThanorEqualTo; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets index of the iconset type's individual icon index. + + + Custom IconSet Conditional Formatting allows you to format your IconSet data based the IconSet index criteria. + For example the index is initially set to 0. In , there are three icons, but the Index property represents the first Icon based on the index value. + + + The following code illustrates how to use the Custom Iconset index. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + // Create icon sets for the data in specified range + IConditionalFormats conditionalFormats = worksheet.Range["H1:K6"].ConditionalFormats; + IConditionalFormat conditionalFormat = conditionalFormats.AddCondition(); + conditionalFormat.FormatType = ExcelCFType.IconSet; + IIconSet iconSet = conditionalFormat.IconSet; + iconSet.IconSet = ExcelIconSetType.FiveBoxes; + IIconConditionValue iconValue1 = iconSet.IconCriteria[0] as IIconConditionValue; + iconValue1.IconSet = ExcelIconSetType.FiveArrowsGray; + + //Set the Iconset index for first IconSet Criteria + iconValue1.Index = 2; + + iconValue1.Type = ConditionValueType.Percent; + iconValue1.Value = "25"; + iconValue1.Operator = ConditionalFormatOperator.GreaterThanorEqualTo; + IIconConditionValue iconValue2 = iconSet.IconCriteria[1] as IIconConditionValue; + iconValue2.IconSet = ExcelIconSetType.ThreeArrows; + + //Set the Iconset index for second IconSet Criteria + iconValue2.Index = 0; + + iconValue2.Type = ConditionValueType.Percent; + iconValue2.Value = "50"; + iconValue2.Operator = ConditionalFormatOperator.GreaterThan; + IIconConditionValue iconValue3 = iconSet.IconCriteria[2] as IIconConditionValue; + iconValue3.IconSet = ExcelIconSetType.FourArrows; + + //Set the Iconset index for third IconSet Criteria + iconValue3.Index = 1; + + iconValue3.Type = ConditionValueType.Percent; + iconValue3.Value = "75"; + iconValue3.Operator = ConditionalFormatOperator.GreaterThanorEqualTo; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Initializes new instance of the wrapped. + + Object to wrap. + Parent object. + + + + The color assigned to the threshold of a color scale conditional format. + + + + + Returns one of the constants of the XlConditionValueTypes enumeration, + which specifies how the threshold values for a data bar, color scale, + or icon set conditional format are determined. Read-only. + + + + + Returns wrapped object. + + + + + This object used to store, convert colors. + + + + + Type of the stored color. + + + + + Color value. + + + + + Color Saturation Modulation value + + + + + Color Luminence value + + + + + Color Saturation + + + + + Color Luminence Modulation + + + + + Indicate Scheme color + + + + + Indicate Schema Name + + + + + Indicate Hex color + + + + + Initializes new instance of the color object. + + Color value to initialize. + + + + Initializes new instance of the color object. + + Color value to initialize. + + + + Initializes a new instance of the ColorObject class. + + Represents type of Color. + Represents color value. + + + + Initializes a new instance of the ColorObject class. + + Represents color type. + Represents color value. + Represents tint value. + + + + Returns index for indexed color or the closest color for any other color type. + + Parent workbook + Index for indexed color or the closest color for any other color type. + + + + Sets indexed color. + + Color index to set. + + + + Sets indexed color. + + Color index to set. + + + + Sets indexed color + + The RGB of set color + parent workbook of the palette + Color index to set. + + + + Sets the indexed. + + Color index to set. + if set to true [raise event]. + The book. + + + + Returns RGB Color object that corresponds to this color. + + Parent workbook. + RGB Color object that corresponds to this color. + + + + Sets RGB color value. + + Value to set. + Parent workbook. + + + + Sets RGB color value. + + Value to set. + + + + Conversion operator. + + Value to convert. + Converted item. + + + + Checks whether two instance have the same data. + + First color object to check. + Second color object to check. + True if they have the same data. + + + + Checks whether two instances have different data. + + First color object to check. + Second color object to check. + True if they have different data. + + + + Copies data from another color object. + + Color object to copy data from. + Indicates whether we should call AfterChange method. + + + + Converts current color to closest indexed. + + Parent workbook. + + + + Returns the hash code for this instance. + + A 32-bit signed integer hash code. + + + + Sets indexed color without calling AfterChange event. + + Color index to set. + + + + Creates copy of the current object. + + A copy of the current object. + + + + Normalizes indexed color if necessary. + + + + + Normalizes indexed color if necessary. + + bskip is used to color index of ownPalette or Excel Default Palette + The raiseEvent is true color index is changed if false color index is not changed + + + + Normalizes indexed color if necessary. + + + + + 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. + + + + Sets theme color. + + Theme color index. + Parent workbook. + + + + Sets theme color + + Theme color index. + Parent workbook. + Tint value. + + + + Sets rgb color. + + Rgb color to set. + Parent workbook. + Tint value. + + + + Dispose + + + + + Event called after color change. + + + + + Returns color value (it can be index, rgb color, etc.) + + + + + Gets or sets Tint. + + + + + Indicate Hex color + + + + + Returns type of the stored color. + + + + + Delegate used for after change event. + + + + + This enumeration contains possible color types. + + + + + Automatic color. + + + + + Indexed color. + + + + + RGB color. + + + + + Theme color. + + + + + Color not set + + + + + Represents a color scale conditional formatting rule. + + + + + Sets the number of objects in the collection. Supported values are 2 and 3. + + Number of conditions. + + To know more about advanced conditional formatting Types refer this link. + + + The following code illustrates how to set the condition value count for color scale. + + //Create a worksheet. + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "ColorScale"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as ColorScale. + format.FormatType = ExcelCFType.ColorScale; + IColorScale colorScale = format.ColorScale; + + //Set 3 as count for color scale + colorScale.SetConditionCount(3); + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets a collection of individual objects. Read-only. + + + The default size of the criteria list is 2 and it can be changed using method. To know more about + Conditional formatting Types refer this link. + + + The criteria for applying color scale can be accessed from the Property. + The following code illustrates how to access the objects from the criteria list and change the properties , and + by accessing each criterio from the list. + + //Create a worksheet. + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "ColorScale"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as ColorScale. + format.FormatType = ExcelCFType.ColorScale; + IColorScale colorScale = format.ColorScale; + + //Set 3 as count for color scale + colorScale.SetConditionCount(3); + + //Set Criteria for applying ColorScale + colorScale.Criteria[0].FormatColorRGB = System.Drawing.Color.White; + colorScale.Criteria[0].Type = ConditionValueType.Percentile; + colorScale.Criteria[0].Value = "0"; + + colorScale.Criteria[1].FormatColorRGB = System.Drawing.Color.Red; + colorScale.Criteria[1].Type = ConditionValueType.Percentile; + colorScale.Criteria[1].Value = "50"; + + colorScale.Criteria[2].FormatColorRGB = System.Drawing.Color.Blue; + colorScale.Criteria[2].Type = ConditionValueType.Percentile; + colorScale.Criteria[2].Value = "100"; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Default color sequence for two color gradient. + + + + + Default color sequence for three color gradient. + + + + + A collection of individual IColorConditionValue objects. + + + + + Sets number of IColorConditionValue objects in the collection. Supported values are 2 and 3. + + Number of conditions. + + + + Initializes new instance of the color scale object. + + + + + Updates count of object in the collection. + + Desired number of objects. + + + + Returns a collection of individual IColorConditionValue objects. + The IColorConditionValue object specifies the type, value, and the color + of threshold criteria used in the color scale conditional format. Read-only. + + + + + Parent format. + + + + + Wrapper over condition values. + + + + + Read-only part copy of the criteria collection. + + + + + Sets number of IColorConditionValue objects in the collection. Supported values are 2 and 3. + + Number of conditions. + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Initializes new instance of the wrapper. + + Parent format wrapper. + + + + Updates internal criteria collection. + + + + + + + Adds required number of new wrappers to the criteria collection. + + Number of items to add. + Source collection to wrap. + + + + Updates wrappers inside criteria collection. + + Number of wrappers to update. + + + + Removes wrappers from criteria collection. + + Number of wrappers to remove. + + + + Returns wrapped object. + + Wrapped object. + + + + Returns a collection of individual IColorConditionValue objects. + The IColorConditionValue object specifies the type, value, and the color + of threshold criteria used in the color scale conditional format. Read-only. + + + + + Represnets a single conditional format. Used for single-cell range. + + + Contains a condition and the formatting attributes + applied to the cells, if the condition is met. + + + + + Represents a conditional format. + + The formatting properties are applied if the conditional formatting rule evaluates to True. + + + + Gets or sets the type of the conditional format. + + + By default the is set to . + + + Type of conditional formatting to be applied is based on the value set from enumeration to property. + Here for example, we set to property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].DateTime = DateTime.Today; + worksheet["B3"].DateTime = DateTime.Parse("1/18/2015"); + worksheet["B4"].DateTime = DateTime.Today; + worksheet["B5"].DateTime = DateTime.Today; + worksheet["B6"].DateTime = DateTime.Parse("1/18/2016"); + worksheet["B7"].DateTime = DateTime.Today; + worksheet["B8"].DateTime = DateTime.Today; + worksheet["B9"].DateTime = DateTime.Parse("1/18/2017"); + worksheet["B10"].DateTime = DateTime.Today; + worksheet["B11"].DateTime = DateTime.Today; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType. + format.FormatType = ExcelCFType.TimePeriod; + + //Set TimePeriodType. (Condition) + format.TimePeriodType = CFTimePeriods.ThisMonth; + + //Set NumberFormat. + format.NumberFormat = "d-mmm"; + + //Set color. + format.BackColor = ExcelKnownColors.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets one of the constants of enumeration + which represents the type of the time period. + + The applicable time period in a "date occurring�" conditional formatting rule. + This can be ignored if is not equal to TimePeriod. + + For conditional formatting type we can set the criteria by setting a value from + enumeration to property. Here for example, we set to property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].DateTime = DateTime.Today; + worksheet["B3"].DateTime = DateTime.Parse("1/18/2015"); + worksheet["B4"].DateTime = DateTime.Today; + worksheet["B5"].DateTime = DateTime.Today; + worksheet["B6"].DateTime = DateTime.Parse("1/18/2016"); + worksheet["B7"].DateTime = DateTime.Today; + worksheet["B8"].DateTime = DateTime.Today; + worksheet["B9"].DateTime = DateTime.Parse("1/18/2017"); + worksheet["B10"].DateTime = DateTime.Today; + worksheet["B11"].DateTime = DateTime.Today; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType. + format.FormatType = ExcelCFType.TimePeriod; + + //Set TimePeriodType. (Condition) + format.TimePeriodType = CFTimePeriods.ThisMonth; + + //Set NumberFormat. + format.NumberFormat = "d-mmm"; + + //Set color. + format.BackColor = ExcelKnownColors.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the comparison operator for the conditional format. + + + If conditional formats applied based on the then the should be used to apply + conditional formats based on the value present in the cell. We can choose condition that is required from the + enumeration. + Here for example, we apply borders for the cells which have values between "20" and "60". For we set + to apply conditional formats for the cells with values within the range "20" and "60". + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + + //Set Operator. + format.Operator = ExcelComparisonOperator.Between; + + //Apply Conditional format. + format.BottomBorderStyle = ExcelLineStyle.Thick; + format.LeftBorderStyle = ExcelLineStyle.Thick; + format.TopBorderStyle = ExcelLineStyle.Thick; + format.RightBorderStyle = ExcelLineStyle.Thick; + + //Set Border color. + format.BottomBorderColor = ExcelKnownColors.Red; + format.LeftBorderColor = ExcelKnownColors.Red; + format.TopBorderColor = ExcelKnownColors.Red; + format.RightBorderColor = ExcelKnownColors.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating whether the font is bold. + + + Similar to property, we can use and properties also. + + + To format data in the cells to Bold within the conditional formatting range property can be used. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Set Bold. + format.IsBold = true; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value indicating whether the font is italic. + + + Similar to property, we can use and properties also. + + + To format the data in the cells to Italic within the conditional formatting range property can be used. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Set Color. + format.IsItalic = true; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the font color from predefined colors (). + + + Similar to and properties, cell colors can be set using and properties. + + + To set font color for the text in the cells within the conditional formatting range property can be used. Colors can be + selected from the enumeration which has all the colors that are included in Excel by default. + property can be used to set colors in RGB representation. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Set Color. + format.FontColor = ExcelKnownColors.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the font color. + + + Similar to and properties, cell colors can be set using and properties. + + + To set font color for the text in the cells within the conditional formatting range property can be used. Colors can be + set by creating Color object by specfifying RGB values or can be selected from predefined RGB color objects. + property can be used to set colors that are available from the enumeration. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Set RGB color. + format.FontColorRGB = System.Drawing.Color.FromArgb(255, 0, 0); + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the underline type for the conditional format. + + + Similar to , we can use to strike out values in the cells within conditional formatting range. + + + Data in the cells can be given underline with the help of conditional formats. To give underline property should be set + to any of the value in the enumeration. Here for example, we set to property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Set UnderLine. + format.Underline = ExcelUnderline.Double; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether the font is strike through. + + + Similar to , we can use , and properties to + format the values in the cells within the conditional formatting range. + + + Data in the cells within the conditional formats range can be struck with the help of property. To strike values + in the cells, we have to set the property to True. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Set StrikeThrough. + format.IsStrikeThrough = true; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the left border color from predefined colors (). + + + To set left border color for the cell within conditional formatting range from the enumeration we use + property. RGB color can be applied by using property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Set Border Style. + format.BottomBorderStyle = ExcelLineStyle.Thick; + format.LeftBorderStyle = ExcelLineStyle.Thick; + format.TopBorderStyle = ExcelLineStyle.Thick; + format.RightBorderStyle = ExcelLineStyle.Thick; + + //Set Border color. + format.BottomBorderColor = ExcelKnownColors.Red; + format.LeftBorderColor = ExcelKnownColors.Red; //Set color + format.TopBorderColor = ExcelKnownColors.Red; + format.RightBorderColor = ExcelKnownColors.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the left border RGB color. + + + To set left border color for the cell within conditional formatting range from the RGB colors we use property. + Colors from enumeration can be applied by using property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Apply Conditional format. + format.BottomBorderStyle = ExcelLineStyle.Thick; + format.LeftBorderStyle = ExcelLineStyle.Thick; + format.TopBorderStyle = ExcelLineStyle.Thick; + format.RightBorderStyle = ExcelLineStyle.Thick; + + //Set Border color. + format.BottomBorderColorRGB = System.Drawing.Color.Red; + format.LeftBorderColorRGB = System.Drawing.Color.Red; //Set RGB color. + format.RightBorderColorRGB = System.Drawing.Color.Red; + format.TopBorderColorRGB = System.Drawing.Color.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the left border line style. + + + To change the default line style of left border we set a line style from enumeration to property. + Here for example, we set to property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Set Border Style. + format.BottomBorderStyle = ExcelLineStyle.Thick; + format.LeftBorderStyle = ExcelLineStyle.Thick; //Set LineStyle + format.TopBorderStyle = ExcelLineStyle.Thick; + format.RightBorderStyle = ExcelLineStyle.Thick; + + //Set Border color. + format.BottomBorderColor = ExcelKnownColors.Red; + format.LeftBorderColor = ExcelKnownColors.Red; + format.TopBorderColor = ExcelKnownColors.Red; + format.RightBorderColor = ExcelKnownColors.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the right border color from predefined colors (). + + + To set a color from the enumeration we use property. RGB color can be applied + by using property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Apply Conditional format. + format.BottomBorderStyle = ExcelLineStyle.Thick; + format.LeftBorderStyle = ExcelLineStyle.Thick; + format.TopBorderStyle = ExcelLineStyle.Thick; + format.RightBorderStyle = ExcelLineStyle.Thick; + + //Set Border color. + format.BottomBorderColor = ExcelKnownColors.Red; + format.LeftBorderColor = ExcelKnownColors.Red; + format.TopBorderColor = ExcelKnownColors.Red; + format.RightBorderColor = ExcelKnownColors.Red; //Set color. + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the right border color. + + To set right border color for the cell within conditional formatting range from the RGB colors we use property. + Colors from enumeration can be applied by using property. + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Apply Conditional format. + format.BottomBorderStyle = ExcelLineStyle.Thick; + format.LeftBorderStyle = ExcelLineStyle.Thick; + format.TopBorderStyle = ExcelLineStyle.Thick; + format.RightBorderStyle = ExcelLineStyle.Thick; + + //Set Border color. + format.BottomBorderColorRGB = System.Drawing.Color.Red; + format.LeftBorderColorRGB = System.Drawing.Color.Red; + format.RightBorderColorRGB = System.Drawing.Color.Red; //Set RGB color. + format.TopBorderColorRGB = System.Drawing.Color.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the right border line style. + + + To change the default line style of right border we set a line style from enumeration to property. + Here for example, we set to property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Apply Conditional format. + format.BottomBorderStyle = ExcelLineStyle.Thick; + format.LeftBorderStyle = ExcelLineStyle.Thick; + format.TopBorderStyle = ExcelLineStyle.Thick; + format.RightBorderStyle = ExcelLineStyle.Thick; //Set LineStyle. + + //Set Border color. + format.BottomBorderColor = ExcelKnownColors.Red; + format.LeftBorderColor = ExcelKnownColors.Red; + format.TopBorderColor = ExcelKnownColors.Red; + format.RightBorderColor = ExcelKnownColors.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the top border color from predefined colors (). + + + To set a color from the enumeration we use property. RGB color can be applied + by using property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Apply Conditional format. + format.BottomBorderStyle = ExcelLineStyle.Thick; + format.LeftBorderStyle = ExcelLineStyle.Thick; + format.TopBorderStyle = ExcelLineStyle.Thick; + format.RightBorderStyle = ExcelLineStyle.Thick; + + //Set Border color. + format.BottomBorderColor = ExcelKnownColors.Red; + format.LeftBorderColor = ExcelKnownColors.Red; + format.TopBorderColor = ExcelKnownColors.Red; //Set color + format.RightBorderColor = ExcelKnownColors.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets RGB color to top border. + + + To set top border color for the cell within conditional formatting range from the RGB colors we use property. + Colors from enumeration can be applied by using property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Apply Conditional format. + format.BottomBorderStyle = ExcelLineStyle.Thick; + format.LeftBorderStyle = ExcelLineStyle.Thick; + format.TopBorderStyle = ExcelLineStyle.Thick; + format.RightBorderStyle = ExcelLineStyle.Thick; + + //Set Border color. + format.BottomBorderColorRGB = System.Drawing.Color.Red; + format.LeftBorderColorRGB = System.Drawing.Color.Red; + format.RightBorderColorRGB = System.Drawing.Color.Red; + format.TopBorderColorRGB = System.Drawing.Color.Red; //Set color + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the top border line style. + + + To change the default line style of top border we set a line style from enumeration to property. + Here for example, we set to property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Apply Conditional format. + format.BottomBorderStyle = ExcelLineStyle.Thick; + format.LeftBorderStyle = ExcelLineStyle.Thick; + format.TopBorderStyle = ExcelLineStyle.Thick; //Set LineStyle + format.RightBorderStyle = ExcelLineStyle.Thick; + + //Set Border color. + format.BottomBorderColor = ExcelKnownColors.Red; + format.LeftBorderColor = ExcelKnownColors.Red; + format.TopBorderColor = ExcelKnownColors.Red; + format.RightBorderColor = ExcelKnownColors.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the bottom border color from predefined colors (). + + + To set a color from the enumeration we use property. RGB color can be applied + by using property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Apply Conditional format. + format.BottomBorderStyle = ExcelLineStyle.Thick; + format.LeftBorderStyle = ExcelLineStyle.Thick; + format.TopBorderStyle = ExcelLineStyle.Thick; + format.RightBorderStyle = ExcelLineStyle.Thick; + + //Set Border color. + format.BottomBorderColor = ExcelKnownColors.Red; //Set color + format.LeftBorderColor = ExcelKnownColors.Red; + format.TopBorderColor = ExcelKnownColors.Red; + format.RightBorderColor = ExcelKnownColors.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets RGB color to bottom border. + + To set bottom border color for the cell within conditional formatting range from the RGB colors we use property. + Colors from enumeration can be applied by using property. + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Apply Conditional format. + format.BottomBorderStyle = ExcelLineStyle.Thick; + format.LeftBorderStyle = ExcelLineStyle.Thick; + format.TopBorderStyle = ExcelLineStyle.Thick; + format.RightBorderStyle = ExcelLineStyle.Thick; + + //Set Border color. + format.BottomBorderColorRGB = System.Drawing.Color.Red; + format.LeftBorderColorRGB = System.Drawing.Color.Red; + format.RightBorderColorRGB = System.Drawing.Color.Red; + format.TopBorderColorRGB = System.Drawing.Color.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the bottom border line style. + + + To change the default line style of bottom border we set a line style from enumeration to property. + Here for example, we set to property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Apply Conditional format. + format.BottomBorderStyle = ExcelLineStyle.Thick; //Set LineStyle + format.LeftBorderStyle = ExcelLineStyle.Thick; + format.TopBorderStyle = ExcelLineStyle.Thick; + format.RightBorderStyle = ExcelLineStyle.Thick; + + //Set Border color. + format.BottomBorderColor = ExcelKnownColors.Red; + format.LeftBorderColor = ExcelKnownColors.Red; + format.TopBorderColor = ExcelKnownColors.Red; + format.RightBorderColor = ExcelKnownColors.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the value or expression associated with the conditional format. + + + Relative cell addresses can be used to apply formatting by using and . To know more about R1C1 notation refer + + Using FormulaR1C1 property in Conditional Formats. + + + property is used to set value that is used for setting conditions. applies + conditional formatting based on the condition from enumeration. This requires atleast one value to + apply conditional format. Here for example, we set "60" to property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Apply Conditional format. + format.BottomBorderStyle = ExcelLineStyle.Thick; + format.LeftBorderStyle = ExcelLineStyle.Thick; + format.TopBorderStyle = ExcelLineStyle.Thick; + format.RightBorderStyle = ExcelLineStyle.Thick; + + //Set Border color. + format.BottomBorderColor = ExcelKnownColors.Red; + format.LeftBorderColor = ExcelKnownColors.Red; + format.TopBorderColor = ExcelKnownColors.Red; + format.RightBorderColor = ExcelKnownColors.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the value or expression associated with the conditional format + in R1C1 notation. + + + To know more about refer Using FormulaR1C1 property in Conditional Formats. + + + To apply formatting by comparing the relative cell addresses we can use . Here for example, we compare the adjacent + cell values and apply formatting. can also used along with to add additional condition. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 1; + worksheet["B3"].Number = 2; + worksheet["B4"].Number = 3; + worksheet["B5"].Number = 4; + worksheet["B6"].Number = 5; + worksheet["B7"].Number = 6; + worksheet["B8"].Number = 7; + worksheet["B9"].Number = 8; + worksheet["B10"].Number = 9; + worksheet["B11"].Number = 10; + + //Data to be compared. + worksheet["C2"].Number = 11; + worksheet["C3"].Number = 1; + worksheet["C4"].Number = 3; + worksheet["C5"].Number = 2; + worksheet["C6"].Number = 5; + worksheet["C7"].Number = 3; + worksheet["C8"].Number = 7; + worksheet["C9"].Number = 9; + worksheet["C10"].Number = 19; + worksheet["C11"].Number = 20; + + + //Create instance of IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + + //Add condition. + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType. + format.FormatType = ExcelCFType.Formula; + + //Set Formula. + format.FirstFormulaR1C1 = "=RC>RC[1]"; + + //Set color. + format.BackColor = ExcelKnownColors.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets the value or expression associated with the second part of a conditional format. + + + Relative cell addresses can be used to apply formatting by using and . To know more about R1C1 notation refer + + Using FormulaR1C1 property in Conditional Formats. + + + To set condition like two values are needed. So, we set these values to + and properties. Here for example, we apply conditional formats to the cells that has values between "20" and "60". + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Apply Conditional format. + format.BottomBorderStyle = ExcelLineStyle.Thick; + format.LeftBorderStyle = ExcelLineStyle.Thick; + format.TopBorderStyle = ExcelLineStyle.Thick; + format.RightBorderStyle = ExcelLineStyle.Thick; + + //Set Border color. + format.BottomBorderColor = ExcelKnownColors.Red; + format.LeftBorderColor = ExcelKnownColors.Red; + format.TopBorderColor = ExcelKnownColors.Red; + format.RightBorderColor = ExcelKnownColors.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets the value or expression associated with the second part of a conditional format + in R1C1 notation. + + + To know more about refer Using FormulaR1C1 property in Conditional Formats. + + + To apply formatting by comparing the relative cell addresses we can use . Here for example, we compare the adjacent + cell values and apply formatting. can also used along with to add additional condition. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 1; + worksheet["B3"].Number = 2; + worksheet["B4"].Number = 3; + worksheet["B5"].Number = 4; + worksheet["B6"].Number = 5; + worksheet["B7"].Number = 6; + worksheet["B8"].Number = 7; + worksheet["B9"].Number = 8; + worksheet["B10"].Number = 9; + worksheet["B11"].Number = 10; + + //Data to be compared. + worksheet["C2"].Number = 11; + worksheet["C3"].Number = 1; + worksheet["C4"].Number = 3; + worksheet["C5"].Number = 2; + worksheet["C6"].Number = 5; + worksheet["C7"].Number = 3; + worksheet["C8"].Number = 7; + worksheet["C9"].Number = 9; + worksheet["C10"].Number = 19; + worksheet["C11"].Number = 20; + + + //Create instance of IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + + //Add condition. + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType. + format.FormatType = ExcelCFType.Formula; + + //Set Formula. + format.SecondFormulaR1C1 = "=RC>RC[1]"; + + //Set color. + format.BackColor = ExcelKnownColors.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the pattern foreground color from predefined colors (). + + + property is used to set the foreground color for based on the condition applied. + RGB color can be applied by setting RGB color to property. Here for example, we set to + and to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Set Pattern. + format.FillPattern = ExcelPattern.DarkHorizontal; + + //Set Color. + format.Color = ExcelKnownColors.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or Sets the gradient style for conditional format. + + + property is used to set the gradient style for based on the condition applied. + Gradient variant can be applied by setting the gradient variant to property. Here for example, we set to + and to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "30"; + format.SecondFormula = "70"; + format.Operator = ExcelComparisonOperator.Between; + + //Set Pattern. + format.FillPattern = ExcelPattern.Gradient; + + //Set Gradient Style + format.GradientStyle=ExcelGradientStyle.Diagonal_Up; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or Sets the gradient variant for conditional format. + + + property is used to set the gradient variant for based on the condition applied. + Gradient style can be applied by setting the gradient style to property. Here for example, we set to + and to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "30"; + format.SecondFormula = "70"; + format.Operator = ExcelComparisonOperator.Between; + + //Set Pattern. + format.FillPattern = ExcelPattern.Gradient; + + //Set Gradient Variant + format.GradientVariant=ExcelGradientVariants.ShadingVariants_2"; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the pattern foreground RGB color. + + + property is used to set the foreground RGB color for based on the condition applied. Color from + can be applied by setting color to property. Here for example, we set to + and Red color to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Set Pattern. + format.FillPattern = ExcelPattern.DarkHorizontal; + + //Set RGB color. + format.ColorRGB = System.Drawing.Color.FromArgb(255, 0, 0); + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the background color from predefined colors (). + + + Background color to cells within the conditional formatting range can be set color from enumeration + using property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Set Color. + format.BackColor = ExcelKnownColors.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the background RGB color. + + + Similar to property, we can use property. In we can only select a color + from enumeration . But, in we can create RGB color objects by changing RGB values. + + + property is used to set RGB color to the cell's background, if the conditions of conditional formats get + satisfied. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Set RGB color. + format.BackColorRGB = System.Drawing.Color.FromArgb(255, 0, 0); + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the fill pattern style. + + + To set pattern for cells within the conditional formatting range property can be used. Here for example, we set + to property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Set Pattern. + format.FillPattern = ExcelPattern.DarkHorizontal; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating whether the font is superscript. + + + + + Gets or sets a Boolean value indicating whether the font is subscript. + + + + + True if the conditional format contains font formatting. otherwise, False. + + property is used to check whether the font related formatting has been applied or not. For example, changing + font color is a formatting. Here in our example we check before setting color to font using and after setting it. First + it returns False since color was not initially applied. + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Check font is formatted or not. + Console.WriteLine(format.IsFontFormatPresent); + + //Set Color. + format.FontColor = ExcelKnownColors.Red; + + //Check font is formatted or not. + Console.WriteLine(format.IsFontFormatPresent); + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + //Output will be + //False + //True + + + + + + + True if the conditional format contains pattern formatting. otherwise, False. + + + To check whether the cell's is set or not, We can use the property. Here for example, + We check before and after applying to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Check whether pattern format is present. + Console.WriteLine(format.IsPatternFormatPresent); + + //Set Pattern. + format.FillPattern = ExcelPattern.DarkHorizontal; + + //Check whether pattern format is present. + Console.WriteLine(format.IsPatternFormatPresent); + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + //Output will be + //False + //True + + + + + + True if font color is present. otherwise, False. + + property can be used to check whether the font color is applied or not. If applied it returns + True else returns False. + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Check Font color is present or not. + Console.WriteLine(format.IsFontColorPresent); + + //Set Color. + format.FontColor = ExcelKnownColors.Red; + + //Check Font color is present or not. + Console.WriteLine(format.IsFontColorPresent); + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + //Output will be + //False + //True + + + + + + True if pattern color is present. otherwise, False. + + + We can use property to check whether pattern color is set or not. Here for example, we check whether + pattern color is set or not before setting and after setting to and + to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Check whether pattern color is set or not. + Console.WriteLine(format.IsPatternColorPresent); + + //Set Color. + format.Color = ExcelKnownColors.Red; + format.FillPattern = ExcelPattern.DarkHorizontal; + + //Check whether pattern color is set or not. + Console.WriteLine(format.IsPatternColorPresent); + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + //Output will be + //False + //True + + + + + + True if background color is present. otherwise, False. + + property can be used to check whether the background color is applied or not. Returns True if the pattern color + is modifed else returns False. + Otherwise False. + + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Check Background color is present or not. + Console.WriteLine(format.IsBackgroundColorPresent); + + //Set Color. + format.BackColor = ExcelKnownColors.Red; + + //Check Background color is present or not. + Console.WriteLine(format.IsBackgroundColorPresent); + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + //Output will be + //False + //True + + + + + + True if left border line style is modified. otherwise, False. + + + We use property to check whether the left border is modifed or not. Returns True if the border + is modifed else returns False. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Check whether default border is modified or not. + Console.WriteLine(format.IsBottomBorderModified); + Console.WriteLine(format.IsLeftBorderModified); + Console.WriteLine(format.IsRightBorderModified); + Console.WriteLine(format.IsTopBorderModified); + + //Apply Conditional format. + format.BottomBorderStyle = ExcelLineStyle.Thick; + format.LeftBorderStyle = ExcelLineStyle.Thick; //Set LineStyle + format.TopBorderStyle = ExcelLineStyle.Thick; + format.RightBorderStyle = ExcelLineStyle.Thick; + + //Set Border color. + format.BottomBorderColor = ExcelKnownColors.Red; + format.LeftBorderColor = ExcelKnownColors.Red; //Set color + format.TopBorderColor = ExcelKnownColors.Red; + format.RightBorderColor = ExcelKnownColors.Red; + + //Check whether default border is modified or not. + Console.WriteLine(format.IsBottomBorderModified); + Console.WriteLine(format.IsLeftBorderModified); + Console.WriteLine(format.IsRightBorderModified); + Console.WriteLine(format.IsTopBorderModified); + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + //Output will be + //False + //False + //False + //False + //True + //True + //True + //True + + + + + + True if right border line style is modified. otherwise, False. + + + We use property to check whether the right border is modifed or not. Returns True if the border + is modifed else returns False. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Check whether default border is modified or not. + Console.WriteLine(format.IsBottomBorderModified); + Console.WriteLine(format.IsLeftBorderModified); + Console.WriteLine(format.IsRightBorderModified); + Console.WriteLine(format.IsTopBorderModified); + + //Apply Conditional format. + format.BottomBorderStyle = ExcelLineStyle.Thick; + format.LeftBorderStyle = ExcelLineStyle.Thick; + format.TopBorderStyle = ExcelLineStyle.Thick; + format.RightBorderStyle = ExcelLineStyle.Thick; //Set LineStyle + + //Set Border color. + format.BottomBorderColor = ExcelKnownColors.Red; + format.LeftBorderColor = ExcelKnownColors.Red; + format.TopBorderColor = ExcelKnownColors.Red; + format.RightBorderColor = ExcelKnownColors.Red; //Set color + + //Check whether default border is modified or not. + Console.WriteLine(format.IsBottomBorderModified); + Console.WriteLine(format.IsLeftBorderModified); + Console.WriteLine(format.IsRightBorderModified); + Console.WriteLine(format.IsTopBorderModified); + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + //Output will be + //False + //False + //False + //False + //True + //True + //True + //True + + + + + + True if top border line style is modified. otherwise, False. + + + We use property to check whether the top border is modifed or not. Returns True if the border + is modifed else returns False. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Check whether default border is modified or not. + Console.WriteLine(format.IsBottomBorderModified); + Console.WriteLine(format.IsLeftBorderModified); + Console.WriteLine(format.IsRightBorderModified); + Console.WriteLine(format.IsTopBorderModified); + + //Apply Conditional format. + format.BottomBorderStyle = ExcelLineStyle.Thick; + format.LeftBorderStyle = ExcelLineStyle.Thick; + format.TopBorderStyle = ExcelLineStyle.Thick; //Set LineStyle + format.RightBorderStyle = ExcelLineStyle.Thick; + + //Set Border color. + format.BottomBorderColor = ExcelKnownColors.Red; + format.LeftBorderColor = ExcelKnownColors.Red; + format.TopBorderColor = ExcelKnownColors.Red; //Set color + format.RightBorderColor = ExcelKnownColors.Red; + + //Check whether default border is modified or not. + Console.WriteLine(format.IsBottomBorderModified); + Console.WriteLine(format.IsLeftBorderModified); + Console.WriteLine(format.IsRightBorderModified); + Console.WriteLine(format.IsTopBorderModified); + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + //Output will be + //False + //False + //False + //False + //True + //True + //True + //True + + + + + + True if bottom border line style is modified. otherwise, False. + + + We use property to check whether the bottom border is modifed or not. Returns True if the border + is modifed else returns False. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Check whether default border is modified or not. + Console.WriteLine(format.IsBottomBorderModified); + Console.WriteLine(format.IsLeftBorderModified); + Console.WriteLine(format.IsRightBorderModified); + Console.WriteLine(format.IsTopBorderModified); + + //Apply Conditional format. + format.BottomBorderStyle = ExcelLineStyle.Thick; //Set LineStyle + format.LeftBorderStyle = ExcelLineStyle.Thick; + format.TopBorderStyle = ExcelLineStyle.Thick; + format.RightBorderStyle = ExcelLineStyle.Thick; + + //Set Border color. + format.BottomBorderColor = ExcelKnownColors.Red; //Set color + format.LeftBorderColor = ExcelKnownColors.Red; + format.TopBorderColor = ExcelKnownColors.Red; + format.RightBorderColor = ExcelKnownColors.Red; + + //Check whether default border is modified or not. + Console.WriteLine(format.IsBottomBorderModified); + Console.WriteLine(format.IsLeftBorderModified); + Console.WriteLine(format.IsRightBorderModified); + Console.WriteLine(format.IsTopBorderModified); + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + //Output will be + //False + //False + //False + //False + //True + //True + //True + //True + + + + + + Gets data bar conditional formatting rule. Read-only. + + + Valid only if FormatType is set to DataBar. + + + DataBar can be set by setting to property. To customize the criteria for applying + data bars we have to change properties of interface. Here for example, we set Red color to property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "DataBar"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as DataBar. + format.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = format.DataBar; + + //Set Bar color for DataBar + dataBar.BarColor = System.Drawing.Color.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets icon set conditional formatting rule. Read-only. + + + Valid only if FormatType is set to IconSet. + + + IconSet can be set by setting to property. To customize the criteria for applying + IconSets we have to change properties of interface. Here for example, we set values for + property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "IconSets"; + worksheet["A2"].Number = 105; + worksheet["A3"].Number = 120; + worksheet["A4"].Number = 300; + worksheet["A5"].Number = 240; + worksheet["A6"].Number = 350; + worksheet["A7"].Number = 460; + worksheet["A8"].Number = 170; + worksheet["A9"].Number = 280; + worksheet["A10"].Number = 190; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as IconSet. + format.FormatType = ExcelCFType.IconSet; + IIconSet iconSet = format.IconSet; + + //Set conditions for IconCriteria. + iconSet.IconCriteria[1].Type = ConditionValueType.Percentile; + iconSet.IconCriteria[1].Value = "20"; + iconSet.IconCriteria[1].Operator = ConditionalFormatOperator.GreaterThan; + + iconSet.IconCriteria[2].Type = ConditionValueType.Percentile; + iconSet.IconCriteria[2].Value = "70"; + iconSet.IconCriteria[2].Operator = ConditionalFormatOperator.GreaterThan; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets color scale conditional formatting rule. Read-only. + + + Valid only if FormatType is set to ColorScale. + + + ColorScale can be set by setting to property. To customize criteria for applying color scale + we have to set values for properties in interface. Here for example, we set values for + property and use method. + + //Create a worksheet. + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "ColorScale"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as ColorScale. + format.FormatType = ExcelCFType.ColorScale; + IColorScale colorScale = format.ColorScale; + + //Set 3 as count for color scale + colorScale.SetConditionCount(3); + + //Set Criteria for applying ColorScale + colorScale.Criteria[0].FormatColorRGB = System.Drawing.Color.White; + colorScale.Criteria[0].Type = ConditionValueType.Percentile; + colorScale.Criteria[0].Value = "0"; + + colorScale.Criteria[1].FormatColorRGB = System.Drawing.Color.Red; + colorScale.Criteria[1].Type = ConditionValueType.Percentile; + colorScale.Criteria[1].Value = "50"; + + colorScale.Criteria[2].FormatColorRGB = System.Drawing.Color.Blue; + colorScale.Criteria[2].Type = ConditionValueType.Percentile; + colorScale.Criteria[2].Value = "100"; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets or sets number format of the conditional format rule. + + + Number format for the values in the cells within the conditional formatting range can be set by using property. + Here for example, we set "d-mmm" to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].DateTime = DateTime.Today; + worksheet["B3"].DateTime = DateTime.Parse("1/18/2015"); + worksheet["B4"].DateTime = DateTime.Today; + worksheet["B5"].DateTime = DateTime.Today; + worksheet["B6"].DateTime = DateTime.Parse("1/18/2016"); + worksheet["B7"].DateTime = DateTime.Today; + worksheet["B8"].DateTime = DateTime.Today; + worksheet["B9"].DateTime = DateTime.Parse("1/18/2017"); + worksheet["B10"].DateTime = DateTime.Today; + worksheet["B11"].DateTime = DateTime.Today; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType. + format.FormatType = ExcelCFType.TimePeriod; + + //Set TimePeriodType. (Condition) + format.TimePeriodType = CFTimePeriods.ThisMonth; + + //Set NumberFormat. + format.NumberFormat = "d-mmm"; + + //Set color. + format.BackColor = ExcelKnownColors.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a boolean value that determines if additional formatting rules on the cell should be evaluated + if the current rule evaluates to True. + + + is set to False by default. If we set it to True formatting is applied based on the priority. If a higher priority + rule for particular cells gets satisfied then the preceding rules are not applied for those cells. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Number = 10; + worksheet["B3"].Number = 20; + worksheet["B4"].Number = 30; + worksheet["B5"].Number = 40; + worksheet["B6"].Number = 50; + worksheet["B7"].Number = 60; + worksheet["B8"].Number = 70; + worksheet["B9"].Number = 80; + worksheet["B10"].Number = 90; + worksheet["B11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + IConditionalFormat format2 = formats.AddCondition(); + IConditionalFormat format3 = formats.AddCondition(); + + //Set Condition. + format.FirstFormula = "60"; + format.SecondFormula = "20"; + format.Operator = ExcelComparisonOperator.Between; + + //Set Color. + format.BackColor = ExcelKnownColors.Red; + + //Set StopIfTrue. + format.StopIfTrue = true; + + //Set Condition. + format2.FirstFormula = "30"; + format2.SecondFormula = "70"; + format2.Operator = ExcelComparisonOperator.Between; + + //Set Color. + format2.BackColor = ExcelKnownColors.Blue; + + //Set StopIfTrue. + format2.StopIfTrue = true; + + //Set Condition. + format3.FirstFormula = "30"; + format3.SecondFormula = "50"; + format3.Operator = ExcelComparisonOperator.Between; + + //Set Color. + format3.BackColor = ExcelKnownColors.Green; + + //Set StopIfTrue. + format3.StopIfTrue = true; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the text value used in SpecificText conditional formatting rule. + The default value is null. + + + To apply conditional formats based on the text present in the cells within conditional formatting range, then we set the text we want to apply + formatting to and set to . Here for example, we set "Test" to + and set to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["B1"].Text = "Conditional Formats"; + worksheet["B2"].Text = "Test"; + worksheet["B3"].Text = "Test"; + worksheet["B4"].Text = "Text"; + worksheet["B5"].Text = "Text"; + worksheet["B6"].Text = "Test"; + worksheet["B7"].Text = "Text"; + worksheet["B8"].Text = "Test"; + worksheet["B9"].Text = "Text"; + worksheet["B10"].Text = "Text"; + worksheet["B11"].Text = "Test"; + + //Create instance of IConditionalFormats. + IConditionalFormats formats = worksheet["B2:B11"].ConditionalFormats; + + //Add condition. + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType. + format.FormatType = ExcelCFType.SpecificText; + + //Set color. + format.BackColor = ExcelKnownColors.Red; + + //Set Text. + format.Text = "Test"; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + + + + + + Gets TopBottom conditional formatting rule. Read-only. + + + Valid only if FormatType is set to TopBottom. + + + TopBottom conditional formatting rule can be applied by setting to property. To customize the TopBottom rule + we have to change properties of interface. Here for example, we set values to interface properties. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "Top10"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as TopBottom. + format.FormatType = ExcelCFType.TopBottom; + ITopBottom topBottom = format.TopBottom; + + //Set values the ITopBottom interface properties. + topBottom.Type = ExcelCFTopBottomType.Bottom; + topBottom.Percent = false; + topBottom.Rank = 5; + + //Set color. + format.BackColor = ExcelKnownColors.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets AboveBelowAverage conditional formatting rule. Read-only. + + + Valid only if FormatType is set to AboveBelowAverage. + + + AboveBelowAverage conditional formatting rule can be applied by setting to property. To customize the AboveBelowAverage rule + we have to change properties of interface. Here for example, we set values to interface properties. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "Above Average"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as AboveBelowAverage. + format.FormatType = ExcelCFType.AboveBelowAverage; + IAboveBelowAverage aboveBelowAverage = format.AboveBelowAverage; + + //Set values the IAboveBelowAverage interface properties. + aboveBelowAverage.AverageType = ExcelCFAverageType.AboveStdDev; + aboveBelowAverage.StdDevValue = 1; + + //Set color. + format.BackColor = ExcelKnownColors.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Conditional format color. Read-only. + + + + + Conditional format background color. Read-only. + + + + + Conditional format top border color. Read-only. + + + + + Conditional format bottom border color. Read-only. + + + + + Conditional format left border color. Read-only. + + + + + Conditional format right border color. Read-only. + + + + + Conditional format font color. Read-only. + + + + + Gets or Sets the gradient style for coonditional format. + + + + + Gets or Sets the gradient variant for conditional format. + + + + + Indicates whether pattern style was modified. + + + + + Returns parsed tokens of the first formula. + + + + + Returns parsed tokens of the second formula. + + + + + Represents constant that not contain font color. + + + + + Default Formula for Blank conditional Formatting type + + + + + Default Formula for No Blank conditional Formatting type + + + + + Default Formula for Error conditional Formatting type + + + + + Default Formula for NoError conditional Formatting type + + + + + Default Formula for Begins With Specific Text conditional Formatting type + + + + + Default Formula for Ends With Specific Text conditional Formatting type + + + + + Default Formula for Contains Text Specific Text conditional Formatting type + + + + + Default Formula for NotContains Text Specific Text conditional Formatting type + + + + + Default formula for yesterday's time period type + + + + + Default formula for today's time period ytype + + + + + Default formula for tomorrow's time period type + + + + + Default formula for last seven days time period type + + + + + Default formula for last week time period type + + + + + Default formula for this week time period type + + + + + Default formula for next week time period type + + + + + Default formula for last month time period type + + + + + Default formula for this month time period type + + + + + Default formula for next month time period type + + + + + Represent the indicates whether formula has set or not. + + + + + Record that contains conditional format data. + + + + + CFEx record. + + + + + starting index of dxf record when text rotation is enabled in style. + + + + + CF12 record. + + + + + Parent workbook. + + + + + Color object that stores cf color. + + + + + Color object that stores cf background color. + + + + + Color object that stores cf top border color. + + + + + Color object that stores cf bottom border color. + + + + + Color object that stores cf left border color. + + + + + Color object that stores cf right border color. + + + + + Color object that stores cf font color color. + + + + + Excel Gradient style that stores cf gradient style. + + + + + Excel Gradient variant that stores cf gradient variant. + + + + + Data bar settings. + + + + + Icon set settings. + + + + + Color scale settings. + + + + + Represents the text value. + + + + + Represents the range reference value + + + + + Preserves the conditional formatting custom functions. + + + + + Represents whether the conditional format has extension list or not + + + + + Represents whether the dxf has pattern type none + + + + + Represents the GUID for the conditional format extension list + + + + + Represents the Time Period conditional formatting types. + + + + + Represents the ID of the conditional format extension list CFRule. + + + + + Gets TopBottom conditional formatting rule. Read-only. + + + Valid only if FormatType is set to Top10. + + + + + Gets AboveBelowAverage conditional formatting rule. Read-only. + + + Valid only if FormatType is set to AboveAverage. + + + + + Negative priority. + + + + + Checks whether conditional format is copying or not. + + + + + Checks whether priority of the conditional format is copying or not. + + + + + Initializes a new instance of ConditionalFormat class. + + Application object for the ConditionalFormat. + Parent object for the ConditionalFormat. + + + + Initializes a new instance of ConditionalFormat class from array of BiffRecords. + + Application object for the ConditionalFormat. + Parent object for the ConditionalFormat. + Array of BiffRecords. + Position of the corresponding CFRecord in the array. + + + + Initializes a new instance of ConditionalFormat class from ConditionalFormat Record. + + Application object for the ConditionalFormat. + Parent object for the ConditionalFormat. + CFRecord to parse. + + + + Initializes a new instance of ConditionalFormat class from ConditionalFormat12 Record. + + Application object for the ConditionalFormat. + Parent object for the ConditionalFormat. + CF12Record to parse. + + + + Initializes a new instance of ConditionalFormat class from ConditionalFormat Extension Record. + + Application object for the ConditionalFormat. + Parent object for the ConditionalFormat. + CFExRecord to parse. + + + + Parses Conditional format data from an array of BiffRecords. + + Array of BiffRecords. + Position of the corresponding CFRecord in the array. + + + + Initializes color objects. + + + + + Updates color objects and sets color values to zero (to make comparison correct). + + + + + Sets all color indexes to zero. + + + + + Parses format record. + + + + + Serializes ConditionalFormat records. + + OffsetArrayList that will get all data of conditional format records. + + + + Serializes ConditionalFormat12 records. + + OffsetArrayList that will get all data of ConditionalFormat12 records. + + + + Updates font color inside record. + + + + + Update color value. + + + + + Updates back color value. + + + + + Updates left border color. + + + + + Updates right border color. + + + + + Updates top border color. + + + + + Updates bottom border color. + + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Searches for necessary parents of the conditional format. + + + + + Initializes a new instance of ConditionalFormat class from ConditionalFormat Extension Record. + + CFExRecord to parse. + + + + Update conditional format from extended properties + + Extended properties collectiom + Conditional format to be update + + + + Convert the ptg token to NPtg + + Ptg collection + Boolean value indicating Absolute cell reference + + + + + Gets first or second formula string value from the conditional format. + + Boolean indicating first or second formula + First/second formula string value + + + + Sets the specifed text value for the SpecficText conditional format. + + Excel comparision operator value. + String value to be set. + + + + Sets formula for the specified range in SpecificText conditional format. + + Value for Excel comparision operator. + Range value. + + + + Sets the formula for time period types. + + + + + + + Sets first or second formula value to the conditional format. + + Formula util object. + Formula string. + Boolean value indicating first formula. + + + + Gets first or second formula string value from the conditional format. + + Formula util. + Boolean value indicating first formula. + First/second formula string value. + + + + Gets first or second formula string value from the conditional format. + + Formula util. + Boolean value indicating first formula. + Boolean value indicating if first formula is for serialization + First/second formula string value. + + + + Gets the cell rectangle. + + The parent formats. + + + + + Gets the minimum range. + + The sorted list. + + + + + Initiates updates to the object. + + This method should be called before several updates to the object will take place. + + + + Ends updating the object. + This method should be called after several updates to the object took place. + + + + + Updates color indexes. + + + + + Updates conditional format formulas. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + Updates conditional format formulas. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + Represents workbook. + + + + Check relative conditional format formulas. + + Conditional format formula. + + + + Update named range names + + Conditional format formula. + Represents workbook. + + + + Serves as a hash function for a particular type, suitable for use in + hashing algorithms and data structures like a hash table. + + A hash code for the current Object. + + + + Compares the current Object with the specified object without taking cell list into account. + + The Object to compare with the current Object. + Booleab value indicating if the objects compared are equal. + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Gets or sets the left border color from predefined colors (). + + + + + Gets or sets the left border color (). + + + + + Gets or sets the left border line style. + + + + + Gets or sets the right border color from predefined colors (). + + + + + Gets or sets the right border color (). + + + + + Gets or sets the right border line style. + + + + + Gets or sets the top border color from predefined colors (). + + + + + Gets or sets the top border color (). + + + + + Gets or sets the top border line style. + + + + + Gets or sets the bottom border color from predefined colors (). + + + + + Gets or sets the bottom border color (). + + + + + Gets or sets the bottom border line style. + + + + + Gets or sets the value or expression associated with the conditional format. + + + + + Gets and sets indicates whether formula has set or not. + + + + + Gets or sets the value or expression associated with the conditional format + in R1C1 notation. + + + + + Gets the value or expression associated with the second part of a conditional format. + + + + + Gets the value or expression associated with the second part of a conditional format + in R1C1 notation. + + + + + Gets or sets the type of the conditional format. + + + + + Gets or sets one of the constants of enumeration + which represents the type of the time period. + + + + + Get and Set the ID of the conditional format extension list CFRule + + + + + Gets or sets the comparison operator for the conditional format. + + + + + Gets or sets a boolean value indicating whether the font is bold. + + + + + Gets or sets a boolean value indicating whether the font is italic. + + + + + Gets or sets the font color from predefined colors (). + + + + + Gets or sets the font color (). + + + + + Gets or sets the underline type for the conditional format. + + + + + Gets or sets a Boolean value indicating whether font is struck through. + + + + + Gets or sets a Boolean value indicating whether the font is superscript. + + + + + Gets or sets a Boolean value indicating whether the font is subscript. + + + + + Gets or sets the pattern foreground color from predefined colors (). + + + + + Gets or sets the pattern foreground color. (Color) + + + + + Gets or sets the pattern background color from predefined colors (). + + + + + Gets or sets the pattern background color (). + + + + + Gets or sets the fill pattern style. + + + + + True if the conditional format contains font formatting. otherwise, False. + + + + + True if the conditional format contains border formatting. otherwise, False. + + + + + True if the conditional format contains pattern formatting. otherwise, False. + + + + + True if font color is present. otherwise, False. + + + + + True if pattern color is present. otherwise, False. + + + + + True if background color is present. otherwise, False. + + + + + True if Number format is present. False otherwise. + + + + + Gets or sets a Boolean value indicating whether the Conditional format has Extension list. + + + + + True if left border line style is modified. otherwise, False. + + + + + True if right border line style is modified. otherwise, False. + + + + + True if top border line style is modified. otherwise, False. + + + + + True if bottom border line style is modified. otherwise, False. + + + + + Gets or sets number format index of the conditional format rule. + + + + + Gets or sets number format of the conditional format rule. + + + + + Gets or sets the text value used in SpecificText conditional formatting rule. + The default value is null. + + + + + TODO:The issue with IRange for Conditional cell value type while range having the "Astersik " (*) symbol. the breaking issue id:DefectID_SD15510.xlsx, + The breaks occurs in the FR implementation "SF7880-Support for specific Text conditional formatting" . + Remove this property while fixing the break issue of CF range with Asterisk. + + + + + Gets or sets a boolean value that determines if additional formatting rules on the cell should be evaluated + if the current rule evaluates to True. + + + + + Represents the starting index of formatting record. + + + + + Indicates whether it uses negative priority. + + + + + Indicates whether conditional format is copying or not. + + + + + Represents the priority of the conditional format. + + + + + + Represents the conditionl format template. + + + + + Gets data bar conditional formatting rule. Read-only. + + + Valid only if FormatType is set to DataBar. + + + + + Gets icon set conditional formatting rule. Read-only. + + + Valid only if FormatType is set to IconSet. + + + + + Gets color scale conditional formatting rule. Read-only. + + + Valid only if FormatType is set to ColorScale. + + + + + Gets TopBottom conditional formatting rule. Read-only. + + + Valid only if FormatType is set to Top10. + + + + + Gets AboveBelowAverage conditional formatting rule. Read-only. + + + Valid only if FormatType is set to AboveAverage. + + + + + Gets internal ConditionatFormat record. Read-only. + + + + + Gets internal ConditionalFormat12 record. Read-only. + + + + + Gets internal ConditionalFormatExtension record. Read-only. + + + + + Gets parent workbook. Read-only. + + + + + Gets data bar object. Read-only. + + + + + Represents the range refernce of Conditional formatting + + + + + True if the conditional format contains border formatting. otherwise, False. + + + + + Gets the conditional format foreground color object. Read-only. + + + + + Gets the conditional format background color object. Read-only. + + + + + Gets Conditional format top border color object. Read-only. + + + + + Gets conditional format bottom border color object. Read-only. + + + + + Gets conditional format left border color object. Read-only. + + + + + Gets conditional format right border color object. Read-only. + + + + + Gets Conditional format font color object. Read-only. + + + + + Gets or Sets the Gradient style for conditional format. + + + + + Gets or Sets the Gradient variant for conditional format. + + + + + Indicates whether pattern style was modified. + + + + + Gets parsed tokens of the first formula. + + + + + Gets parsed tokens of the second formula. + + + + + Represents the top or bottom conditional formatting rule. + Applying this rule to a range helps you highlight the top or bottom �n� cells from the selected range + + + + + Represents the top or bottom conditional formatting rule. + Applying this rule to a range helps you highlight the top or bottom �n� cells from the selected range. + + + + + Specifies whether the ranking is evaluated from the top or bottom. + + + + + Specifies whether the rank is determined by a percentage value. + + + + + Specifies the maximum number or percentage of cells to be highlighted for this conditional formatting rule. + + + + + Specifies whether the ranking is evaluated from the top or bottom. + + + + + Specifies whether the rank is determined by a percentage value. + + + + + Specifies the maximum number or percentage of cells to be highlighted for this conditional formatting rule. + + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Compares two instances of the IconSetImpl. + + First object to compare. + Second object to compare. + True if objects are equal. + + + + Checks whether objects are different. + + First object to compare. + Second object to compare. + True if objects are not equal. + + + + Specifies whether the ranking is evaluated from the top or bottom. + + + + + Specifies whether the rank is determined by a percentage value. + + + + + Specifies the maximum number or percentage of cells to be highlighted for this conditional formatting rule. + + + + + Represents the top or bottom conditional formatting rule. + Applying this rule to a range helps you highlight the top or bottom �n� cells from the selected range + + + + + Represents the above or below conditional formatting rule. + Applying this rule to a range helps you highlight the cells which contain values above or below the average of selected range. + + + + + Specifies whether the conditional formatting rule looks for cell values above or below the range average or standard deviation. + + + + + Specifies standard deviation number for AboveBelowAverage conditional formatting rule. + + + Valid only if AverageType is set to AboveStdDev or BelowStdDev. + + + + + Specifies whether the conditional formatting rule looks for cell values above or below the range average or standard deviation. + + + + + Specifies standard deviation number for AboveAverage conditional formatting rule. + + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Compares two instances of the IconSetImpl. + + First object to compare. + Second object to compare. + True if objects are equal. + + + + Checks whether objects are different. + + First object to compare. + Second object to compare. + True if objects are not equal. + + + + Specifies whether the conditional formatting rule looks for cell values above or below the range average or standard deviation. + + + + + Specifies standard deviation number for AboveAverage conditional formatting rule. + + + + + Summary description for ConditionalFormatWrapper. + + + + + Parent conditional formats wrapper. + + + + + Condition index. + + + + + Wrapper over data bar object. + + + + + Wrapper over icon set object. + + + + + Wrapper over color scale object. + + + + + Gets TopBottom conditional formatting rule. Read-only. + + + Valid only if FormatType is set to Top10. + + + + + Gets AboveBelowAverage conditional formatting rule. Read-only. + + + Valid only if FormatType is set to AboveAverage. + + + + + To prevent user from creation instances of this class without arguments. + + + + + Creates new instance of the Conditional Format wrapper. + + Parent formats collection. + Condition index. + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Gets unwrapped condition. + + Unwrapped condition. + + + + Gets or sets the type of the conditional format. + + + + + Gets or sets one of the constants of enumeration + which represents the type of the time period. + + + + + Gets or sets the comparison operator for the conditional format. + + + + + Gets or sets a boolean value indicating whether the font is bold. + + + + + Gets or sets a boolean value indicating whether the font is italic. + + + + + Gets or sets the font color from predefined colors (). + + + + + Gets or sets the font color (). + + + + + Gets or sets the underline type for the conditional format. + + + + + Gets or sets a Boolean value indicating whether font is struck through. + + + + + Gets or sets the left border color from predefined colors (). + + + + + Gets or sets the left border color (). + + + + + Gets or sets the left border line style. + + + + + Gets or sets the right border color from predefined colors (). + + + + + Gets or sets the right border color (). + + + + + Gets or sets the right border line style. + + + + + Gets or sets the top border color from predefined colors (). + + + + + Gets or sets the top border color (). + + + + + Gets or sets the top border line style. + + + + + Gets or sets the bottom border color from predefined colors (). + + + + + Gets or sets the bottom border color (). + + + + + Gets or sets the bottom border line style. + + + + + Gets or sets the value or expression associated with the conditional format. + + + + + Gets or sets the value or expression associated with the conditional format + in R1C1 notation. + + + + + Gets the value or expression associated with the second part of a conditional format. + + + + + Gets the value or expression associated with the second part of a conditional format + in R1C1 notation. + + + + + Gets or sets the pattern foreground color from predefined colors (). + + + + + Gets or sets the pattern foreground color. (Color) + + + + + Gets or sets the pattern background color from predefined colors (). + + + + + Gets or sets the pattern background color (). + + + + + Gets or sets the fill pattern style. + + + + + Gets or sets a Boolean value indicating whether the font is superscript. + + + + + Gets or sets a Boolean value indicating whether the font is subscript. + + + + + True if the conditional format contains font formatting. otherwise, False. + + + + + True if the conditional format contains border formatting. otherwise, False. + + + + + True if the conditional format contains pattern formatting. otherwise, False. + + + + + True if font color is present. otherwise, False. + + + + + True if pattern color is present. otherwise, False. + + + + + True if background color is present. otherwise, False. + + + + + True if Number format is present. False otherwise. + + + + + True if left border line style is modified. otherwise, False. + + + + + True if right border line style is modified. otherwise, False. + + + + + True if top border line style is modified. otherwise, False. + + + + + True if bottom border line style is modified. otherwise, False. + + + + + Gets or sets number format index of the conditional format rule. + + + + + Gets or sets number format of the conditional format rule. + + + + + Gets or sets the text value used in SpecificText conditional formatting rule. + The default value is null. + + + + + Gets or sets a boolean value that determines if additional formatting rules on the cell should be evaluated + if the current rule evaluates to True. + + + + + Represents the conditionl format template. + + + + + Gets data bar conditional formatting rule. Read-only. + + + Valid only if FormatType is set to DataBar. + + + + + Gets icon set conditional formatting rule. Read-only. + + + Valid only if FormatType is set to IconSet. + + + + + Gets color scale conditional formatting rule. Read-only. + + + Valid only if FormatType is set to ColorScale. + + + + + Gets TopBottom conditional formatting rule. Read-only. + + + Valid only if FormatType is set to Top10. + + + + + Gets AboveBelowAverage conditional formatting rule. Read-only. + + + Valid only if FormatType is set to AboveAverage. + + + + + Gets the application for this object. + + + + + Gets the parent for this object. + + + + + Gets the conditional format foreground color object. Read-only. + + + + + Gets the conditional format background color object. Read-only. + + + + + Gets Conditional format top border color object. Read-only. + + + + + Conditional format bottom border color. Read-only. + + + + + Gets conditional format left border color object. Read-only. + + + + + Gets conditional format right border color object. Read-only. + + + + + Gets Conditional format font color object. Read-only. + + + + + Indicates whether pattern style was modified. + + + + + Gets or Sets the gradient style for conditional format. + + + + + Gets or Sets the gradient variant for conditional format. + + + + + Gets parsed tokens of the first formula. + + + + + Gets parsed tokens of the second formula. + + + + + Represents the top or bottom conditional formatting rule. + Applying this rule to a range helps you highlight the top or bottom �n� cells from the selected range + + + + + Wrapped data Top10 object. + + + + + Parent conditional format wrapper. + + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Initializes new instance of the wrapper. + + top10 object to wrap. + Parent conditional format wrapper. + + + + Specifies whether the ranking is evaluated from the top or bottom. + + + + + Specifies whether the rank is determined by a percentage value. + + + + + Specifies the maximum number or percentage of cells to be highlighted for this conditional formatting rule. + + + + + Represents the top or bottom conditional formatting rule. + Applying this rule to a range helps you highlight the top or bottom �n� cells from the selected range + + + + + Wrapped data Top10 object. + + + + + Parent conditional format wrapper. + + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Initializes new instance of the wrapper. + + Above average object to wrap. + Parent conditional format wrapper. + + + + Specifies whether the conditional formatting rule looks for cell values above or below the range average or standard deviation. + + + + + Specifies standard deviation number for AboveAverage conditional formatting rule. + + + + + Represents the implementation of Icon condition value + + + + + Returns or sets one of the constants of the IconConditionValueType enumeration. It specifies how the threshold values for icon set conditional format are determined. + + + + + Returns or sets index of the iconset type's individual icon index. + + + + + Initializes new instance of the class. + + IconSet valus from + Index of the Icon Sets + Type of the condition. + Value of the object. + + + + + Returns or sets IconSet for individual IconSet criteria. It allows the custom Iconset and works based in the index. + + + Custom IconSet Conditional Formatting allows you to format your data based the IconSet criteria value from . + For example the icon set is initially set to use the icon set, but this IconSet property is used + to override which icons are used for the first or seconde and third criteria. You can set individual icon based on the index of the IconSet Type. + + + + + Gets or sets index of the iconset type's individual icon index. + + + Custom IconSet Conditional Formatting allows you to format your IconSet data based the IconSet index criteria. + For example if the index is initially set as 0. In , there are three icons, but the Index property represents first Icon based on the index value. + + + + + + No conditional value. + + + + + Number is used. + + + + + Lowest value from the list of values. + + + + + Highest value from the list of values. + + + + + Percentage is used. + + + + + Formula is used. + + + + + Percentile is used. + + + + + Automatic is used + + + + + Specifies the type of conditions that can be used for Icon sets + + + + + Greater than condition is used [>]. + + + + + Greater Than or Equal to condition is used [>=]. + + + + + Represents a data bar conditional formatting rule. Applying a data bar to a + range helps you see the value of a cell relative to other cells. + + + + + Represents a data bar conditional formatting rule. Applying a data bar to a + range helps you see the value of a cell relative to other cells. + + + + + Gets a object which specifies how the shortest bar is evaluated + for a data bar conditional format. + + + To customize the longest bar of DataBar we have to set values for property. + + + The shortest bar of DataBar is set by defining the property. To do that we have to set values for , + and Properties. Here for example, we set "30" to property + which sets the shortest bar. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "DataBar"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as DataBar. + format.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = format.DataBar; + + //Set MinPoint for DataBar + dataBar.MinPoint.Value = "30"; + dataBar.MinPoint.Type = ConditionValueType.Percent; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets a object which specifies how the longest bar is evaluated + for a data bar conditional format. + + + To customize the longest bar of DataBar we have to set values for property. + + + The longest bar of DataBar is set by defining the property. To do that we have to set values for , + and Properties. Here for example, we set "70" to property + which sets the longest bar. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "DataBar"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as DataBar. + format.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = format.DataBar; + + //Set MaxPoint for DataBar + dataBar.MaxPoint.Value = "70"; + dataBar.MaxPoint.Type = ConditionValueType.Percent; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the color of the bars in a data bar conditional format. + + + To customize the border color of the DataBar we can use property. + + + The default color of the DataBar is (99, 142, 198) in RGB representation. This can be customized usig property. + Here in our example we change the BarColor to Red. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "DataBar"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as DataBar. + format.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = format.DataBar; + + //Set Bar color for DataBar + dataBar.BarColor = System.Drawing.Color.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a value that specifies the length of the longest + data bar as a percentage of cell width. + + + To set minimum length of the DataBar refer property. + + + By default the DataBar's and are set to 100 and 0 respectively. This allows the DataBar + to begin from the starting position zero to the entire cell width. We can customize the appearance of DataBars by changing these two + properties. Here for example, we set the property's value to 80. This sets the DataBars maximum lenght to 80 percent. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "DataBar"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as DataBar. + format.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = format.DataBar; + + //Set maximum percentage. + dataBar.PercentMax = 80; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a value that specifies the length of the shortest + data bar as a percentage of cell width. + + To set maximum length of the DataBar refer property. + + By default the DataBar's and are set to 100 and 0 respectively. This allows the DataBar + to begin from the starting position zero to the entire cell width. We can customize the appearance of DataBars by changing these two + properties. Here for example, we set the property's value to 50. This sets the DataBar's shortest lenght to 50 percent. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "DataBar"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as DataBar. + format.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = format.DataBar; + + //Set minumum percentage. + dataBar.PercentMin = 50; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value that specifies if the value in the cell should be displayed or not. Default value is true. + + + When only graphical representation is enough then we can make use of property to hide the data in the cells. By default + this is set to "True". We can change it to "False" to hide the values in the cells. Here in our example we set the ShowValues property to "False" + to hide the data in the cells. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "DataBar"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as DataBar. + format.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = format.DataBar; + + //Set ShowValue + dataBar.ShowValue = false; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the axis color of the data bar. + + + is not applied by default, it's applied after we set a color. Here in our example, we set Red to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "DataBar"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as DataBar. + format.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = format.DataBar; + + //Set BarAxis color for DataBar. + dataBar.BarAxisColor = System.Drawing.Color.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the border color of the data bar. + + + We can change the color applied to the DataBar also, to change that use property. + + + There will be no borders applied to ColorBars initially. If we want we can apply borders to the DataBars present in the cells by using + property. Here in our example, we set BorderColor to Yellow. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "DataBar"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as DataBar. + format.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = format.DataBar; + + //Set Border color for DataBar + dataBar.BorderColor = System.Drawing.Color.Yellow; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets a Boolean value indicating whether the data bar has a border. + + + Setting color to property makes the to return "True". + + + By default there will be no color set to property, So property will return "False". + If we set color to BorderColor property then the HasBorder property will return "True". Here in our example, we check the HasBorder property + before applying Border color and after applying Border color. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "DataBar"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as DataBar. + format.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = format.DataBar; + + //Before Applying Border color + Console.WriteLine(dataBar.HasBorder); + + //Set Border color for DataBar + dataBar.BorderColor = System.Drawing.Color.Yellow; + + //After Applying Border color + Console.WriteLine(dataBar.HasBorder); + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + Console.Read(); + } + // Output in the console will be + // False + // True + + + + + + Gets or sets a Boolean value indicating whether the data bar has a gradient fill. + + + To know more about conditional formatting type refer this link. + + + is set to "True" by default to provide a rich formatting look to DataBars. To make the DataBars look with plain + unformatted color just like the color fill of cells, we can set this property to "False". + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "DataBar"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as DataBar. + format.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = format.DataBar; + + //Set Gradient fill to false. + dataBar.HasGradientFill = false; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the direction of the data bar. + + + The position of the DataBar will be by default. This can be changed to + or . In our example we set the direction of the DataBar to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "DataBar"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as DataBar. + format.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = format.DataBar; + + //Set Bar Direction + dataBar.DataBarDirection = DataBarDirection.rightToLeft; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the negative border color of the data bar. + + + To change fill color and border color of DataBars use and properties. + + + There will be no borders applied to ColorBars initially. Like property used to set border color for positive values + in the cells property is used to set border color for negative values in the cells. + Here in our example, we set NegativeBorderColor to Yellow. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "DataBar"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = -20; + worksheet["A4"].Number = -30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = -50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = -70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = -90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as DataBar. + format.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = format.DataBar; + + //Set NegativeBorder color for DataBar + dataBar.NegativeBorderColor = System.Drawing.Color.Yellow; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the negative fill color of the data bar. + This element MUST exist if and only if negativeBarColorSameAsPositive equals "false". + + + To customize the border color and fill color of the DataBar we can use and properties. + + + To customize color for DataBar which has negative values in the cells, + we have to set color for and properties. Here in our example, to show Databar + for negative values we are setting red color for property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "DataBar"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as DataBar. + format.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = format.DataBar; + + //Set NegativeBar color for DataBar + dataBar.NegativeFillColor = System.Drawing.Color.Red; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the axis position for the data bar. + + + The position of the DataBar Axis is based on the values present in the cells, It's by default. + If the cells contain positve and negative values then the Axis position will be cell's middle position. If the cells contain either positive or + negative values then the DataBar's axis will be based on the values. Though we have only positive elements loaded, Here we set DataBar axis + to . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "DataBar"; + worksheet["A2"].Number = 10; + worksheet["A3"].Number = 20; + worksheet["A4"].Number = 30; + worksheet["A5"].Number = 40; + worksheet["A6"].Number = 50; + worksheet["A7"].Number = 60; + worksheet["A8"].Number = 70; + worksheet["A9"].Number = 80; + worksheet["A10"].Number = 90; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as DataBar. + format.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = format.DataBar; + + //Set Bar Axis Position. + dataBar.DataBarAxisPosition = DataBarAxisPosition.middle; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Default data bar color. + + + + + Default axis position of data bar + + + + + Default data bar direction + + + + + Default data bar negative fill color. + + + + + Default data bar axis color. + + + + + A ConditionValue object which specifies how the shortest bar is evaluated + for a data bar conditional format. + + + + + A ConditionValue object which specifies how the longest bar is evaluated + for a data bar conditional format. + + + + + The color of the bars in a data bar conditional format. + + + + + Returns or sets a Boolean value that specifies if the extension list is parsed + + + + + A value that specifies the length of the longest + data bar as a percentage of cell width. + + + + + A value that specifies the length of the shortest + data bar as a percentage of cell width. + + + + + Returns or sets a Boolean value that specifies if the value in the cell + is displayed if the data bar conditional format is applied to the range. + + + + + Represents the axis color of the data bar. + + + + + Represents the border color of the data bar. + + + + + Represents the negative border color of the data bar. + + + + + Represents the negative fill color of the data bar. + + + + + Represents whether the data bar has a border. + + + + + Represents the direction of the data bar. + + + + + Represents whether the data bar has a gradient fill. + + + + + Represents whether the data bar has a negative bar color + that is different from the positive bar color. + + + + + Represents whether the data bar has a negative border color + that is different from the positive border color. + + + + + Represents the axis position for the data bar + + + + + Represents whether the data bar has extension list or not + + + + + Represents the GUID for the data bar extension list + + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Serves as a hash function for a particular type. GetHashCode() is suitable + for use in hashing algorithms and data structures like a hash table. + + A hash code for the current object. + + + + A hash code for the current Object without taking cell list into account. + + The Object to compare with the current Object. + + + + + Compares two instances of the DataBarImpl. + + First object to compare. + Second object to compare. + True if objects are equal. + + + + Checks whether objects are different. + + First object to compare. + Second object to compare. + True if objects are not equal. + + + + Returns a ConditionValue object which specifies how the shortest bar is evaluated + for a data bar conditional format. + + + + + Returns a ConditionValue object which specifies how the longest bar is evaluated + for a data bar conditional format. + + + + + Returns or sets a value which specifies the extension list is parsed otherwise + it set false as default. + + + + + Gets/sets the color of the bars in a data bar conditional format. + + + + + Returns or sets a value that specifies the length of the longest + data bar as a percentage of cell width. + + + + + Returns or sets a value that specifies the length of the shortest + data bar as a percentage of cell width. + + + + + Returns or sets a Boolean value that specifies if the value in the cell + is displayed if the data bar conditional format is applied to the range. + + + + + Gets or sets the axis color of the data bar. + This element MUST exist if and only if axisPosition does not equal "none". + + + + + Gets or sets the border color of the data bar. + This element MUST exist if and only if border equals "true". + + + + + Gets or sets the negative border color of the data bar. + This element MUST exist if and only if negativeBarBorderColorSameAsPositive equals "false" and border equals "true". + + + + + Gest or sests the negative fill color of the data bar. + This element MUST exist if and only if negativeBarColorSameAsPositive equals "false". + + + + + Gets whether the data bar has a border + + + + + Gets or sets the direction of the data bar. + + + + + Gets or sets whether the data bar has a gradient fill. + + + + + Represents whether the data bar has a negative bar color + that is different from the positive bar color. + + + + + Represents whether the data bar has a negative border color + that is different from the positive border color. + + + + + Gets or sets the axis position for the data bar + + + + + Gets or sets the value whether the data bar has extension list or not + + + + + Represents a wrapper over data bar conditional formatting rule. Applying + a data bar to a range helps you see the value of a cell relative to other cells. + + + + + Wrapped data bar object. + + + + + Parent conditional format wrapper. + + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Initializes new instance of the wrapper. + + Data bar object to wrap. + Parent conditional format wrapper. + + + + Returns a ConditionValue object which specifies how the shortest bar is evaluated + for a data bar conditional format. + + + + + Returns a ConditionValue object which specifies how the longest bar is evaluated + for a data bar conditional format. + + + + + Gets/sets the color of the bars in a data bar conditional format. + + + + + Returns or sets a value that specifies the length of the longest + data bar as a percentage of cell width. + + + + + Returns or sets a value that specifies the length of the shortest + data bar as a percentage of cell width. + + + + + Returns or sets a Boolean value that specifies if the value in the cell + is displayed if the data bar conditional format is applied to the range. + + + + + Gets or sets the axis color of the data bar. + This element MUST exist if and only if axisPosition does not equal "none". + + + + + Gets or sets the border color of the data bar. + This element MUST exist if and only if border equals "true". + + + + + Gets whether the data bar has a border + + + + + Gets or sets whether the data bar has a gradient fill. + + + + + Gets or sets the direction of the data bar. + + + + + Gets or sets the negative border color of the data bar. + This element MUST exist if and only if negativeBarBorderColorSameAsPositive equals "false" and border equals "true". + + + + + Gest or sests the negative fill color of the data bar. + This element MUST exist if and only if negativeBarColorSameAsPositive equals "false". + + + + + Gets or sets the axis position for the data bar + + + + + Represents data validation for a worksheet range. + + + + + Maximum possible length of the string. + + + + + Number of days that are incorrectly displayed by MS Excel. + + + + + + + + + + Added to lock a object in multi threading. + + + + + + + + + + + + + + + + + + + + Initializes a new instance of class with specified parent value. + + Parent object for the DataValidation. + + + + Initializes a new instance of class with specified parent and DVRecord value. + + Parent object for the DataValidation. + Base DVRecord. + + + + Adds range to the collection with specified data validation. + + Data validation to add. + + + + Adds range to the collection with specified range. + + Range to add. + + + + Adds range to the collection with specified cell address. + + Cell range address. + + + + Adds range to the collection with specified cell address while parsing. + + Cell range address. + + + + Adds range to the collection with specified cell range. + + Cell range to add. + + + + Removes range from collection with specified range. + + Range to remove. + + + + Removes ranges from collection with specified array of rectangles. + + Ranges to remove. + + + + + + + + + + + + + + + Converts DateTime value into tokens array. + + Value to convert. + Converted array. + + + + Tries to convert array of tokens into DateTime value. + + Tokens to convert. + Converted value or DateTime.MinValue if conversion wasn't successful. + + + + Converts formula string to Ptg array. + + Represents formula value. + Object used for formula parsing. + Returns ptg array. + + + + Parses the string formula. + + Represents formula value. + Represents the work sheet. + Object used for formula parsing. + Row value. + Column value. + Returns ptg array. + + + + Register and unregister the function with specified RefNPtg formula type. + + indicates whether the function is RefNPtg supported. + + + + Sets first and second formula values. + + Value to set. + Formula util. + True - first formula, false - second formula. + + + + Sets first and second formula values in Xml Parser + + Value to set. + Formula util. + Cell Range Address + True - first formula, false - second formula. + + + + Defines whether Ptg array represents zero value. + + Parsed formula Ptg array. + True if parsed formula represents zero value, otherwise false. + + + + Updates first formula string based on the formula tokens. + + + + + Updates second formula string based on the formula tokens. + + + + + Gets row and column indexes of the first cell. + + + + + + + Reparses the string formula. + + + + + Returns data validation of the first or second formula's string value. + + Object used for formula parsing. + Is first formula. + First or second formula's string value. + + + + Returns data validation of the first or second formula's string value in R1C1 format. + + Object used for formula parsing. + Is first formula. + First or second formula's string value. + + + + Saves record into specified OffsetArrayList. + + + OffsetArrayList that will receive all the data validation records. + + + When records is null + + + + + Creates a copy of current instance. + + Parent object. + Returns just cloned object. + + + + Sets parent collection object. + + Parent object. + + + + Indicates whether this object contains data validation settings for cell with specified index. + + Cell index to search. + True if this object contains data validation settings for cell with specified index. + + + + Updates indexes to named ranges with specified array of int value. + + New indexes. + + + + Updates indexes to named ranges with specified dictionary. + + New indexes. + + + + This should be called before several updates to the object. + + + Invoking this method improves the performance for large block of Data Validation. + + + + + This method should be called after several updates to the object. + + + Invoking this method improves the performance for large block of Data Validation. + + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Checks whether specified value is inside requested limit. + + Property name. + Property value. + Length limit + + + + Parent workbook. + + + + + Parent worksheet. + + + + + Returns internal CFRecord(CF-Conditional Format). Read-only. + + + + + Gets or sets parent data validation collection. + + + + + Gets ranges of the data validation. + + + + + Gets number of required shapes objects. + + + + + Application object for this object. + + + + + Parent object for this object. + + + + + Gets or sets the title of the prompt box. + + + + + Gets or sets the text in the prompt box. + + + + + Gets or sets the title of the error dialog. + + + + + Gets or sets the error message in the error dialog . + + + + + Gets or sets the value or expression associated with the data validation. + + + + + Gets or sets the first formula's DateTime value. + + + + + Gets or sets the value or expression associated with the second part of the data validation. + + + + + Gets or sets the value associated with the choice part of the data validation. + + + + + Gets or sets second formula's DateTime value. + + + + + Gets or sets the data type validation for a range. + + + + + Gets or sets the comparison operation to perform. + + + + + True if formula contains list of values. otherwise False. + + + + + True if empty values are permitted by the range data validation. otherwise False. + + + + + True if the drop down arrow is invisible. otherwise False. + + + + + True if prompt box is shown. otherwise False. Default value is True. + + + + + True if error dialog is shown. otherwise False. Default value is True. + + + + + Gets or sets Horizontal position of the prompt box. + + + + + Gets or sets Vertical position of the prompt box. + + + + + True if prompt box is visible. otherwise False. + + + + + True if prompt box position is fixed. otherwise False. + + + + + Gets or sets the type of error. + + + + + Gets or sets Array of possible values. + + + This property should be used when the values in the Data Validation list are entered manually. + + + + + Gets or sets the Range of possible values. + + + + + + + + + + + + + + + Gets or sets the value or expression associated with the choice part of the data validation. + + + + + Represents error indicator. + + + + + + + + + + Maximum number of rectangles after split. + + + + + Cell ranges list. + + + + + Default constructor. + + + + + Creates new instance of current class. + + Cell ranges list. + + + + Indicates whether collection contains all specified ranges. + + Ranges to check. + True if collection contains all specified ranges. + + + + Indicates whether collection contains all specified ranges. + + Ranges to check. + Start index in the internal ranges collection to search from. + True if collection contains all specified ranges. + + + + Indicates whether collection contains all specified ranges. + + Ranges to check. + True if collection contains all specified ranges. + + + + Indicates whether collection contains all specified ranges. + + Ranges to check. + Start index in the internal ranges collection to search from. + True if collection contains all specified ranges. + + + + Indicates whether collection contains all specified ranges. + + Ranges to check. + True if collection contains all specified ranges. + + + + Indicates whether collection contains all specified ranges. + + Ranges to check. + Start index in the internal ranges collection to search from. + True if collection contains all specified ranges. + + + + Indicates whether collection contains all specified ranges. + + Ranges to check. + Start index in the internal ranges collection to search from. + True if collection contains all specified ranges. + + + + Indicates whether collection contains all specified ranges. + + Ranges to check. + Start index in the internal ranges collection to search from. + True if collection contains all specified ranges. + + + + Indicates whether collection contains specified range. + + Range to check. + True if collection contains specified range. + + + + Indicates whether collection contains specified range. + + Range to check. + Start index in the internal ranges collection to search from. + True if collection contains specified range. + + + + Returns contains count for specified range. + + Range to check. + Contains count + + + + Adds cells from the collection. + + Cells to add to the collection. + + + + Adds cells from the collection. + + Cells to add to the collection. + + + + Adds range to the collection. + + Range to add. + + + + Adds new cell range to the collection. + + Range to add. + + + + Adds new cell range to the collection. + + Range to add. + + + + Clears internal list. + + + + + Gets part of the cells. + + Rectangle to get new collection for. + Indicates whether to remove cells from the collection. + Number of rows to add to each resulting rectangle. + Number of columns to add to each resulting rectangle. + + + + + Checks whether ranges can be merged. + + Range to add to. + Range to add. + True if operation succeeded. + + + + Removes range from the collection of conditional formats. + + Array of ranges to remove. + + + + Removes range from the collection of conditional formats. + + Array of ranges to remove. + + + + Creates copy of the current object. + + Copy of the current object. + + + + Removes rectangle from the collection. + + Rectangle to remove. + Index after last element that should be checked. + + + + Splits rectangle into several parts after remove specified rectangle. + + Rectangle to split. + Rectangle to remove. + List with splitted rectangle. + + + + Optimize storage + + + + + Set maximum length + + + + + + Gets / sets list of the cells. + + + + + Represents IErrorIndicator interface. + + + + + Represents error indicator ignore options. + + + + + Maximum number of error indicators in the single Excel 2003 record. + + + + + Represents hide options. + + + + + Creates new instance of current class. + + Cell range of this error indicator. + Hide option. + + + + Creates new instance of current class. + + Hide option. + + + + Clones current object. + + Returns cloned object. + + + + Adds cells range list from another error indicator. + + Error indicator to get cells from. + + + + Represents error indicator hide options. + + + + + Is thrown when range is invalid, i.e. when can't copy / move range into new location. + + + + + Default exception message. + + + + + Initializes a new instance of the class with default error message. + + + + + Initializes a new instance of the class with a specified error message. + + Error message. + + + + Initializes a new instance of the Exception 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. + If the innerException parameter is not a NULL reference + (Nothing in Visual Basic), the current exception is raised + in a catch block that handles the inner exception. + + + + + Is thrown when the data array is larger than it should be. + + + + + Initializes a new instance of the class with an empty error message. + + + + + Initializes a new instance of the class with a specified error message. + + Error message. + + + + Initializes a new instance of the Exception 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. + If the innerException parameter is not a NULL reference + (Nothing in Visual Basic), the current exception is raised + in a catch block that handles the inner exception. + + + + + This exception should be thrown when there are problems with formula parsing. + + + + + Default message format. + + + + + Default constructor. + + + + + Initializes a new instance of the class with a specified error message. + + Error message. + + + + Initializes a new instance of the Exception 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. + If the innerException parameter is not a NULL reference + (Nothing in Visual Basic), the current exception is raised + in a catch block that handles the inner exception. + + + + + + + + + + + + + + Is thrown when user tries to modify read-only data. + + + + + Default message. + + + + + Initializes a new instance of the class with an empty error message. + + + + + Initializes a new instance of the class with a specified error message. + + Error message. + + + + Initializes a new instance of the Exception 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. + If the innerException parameter is not a NULL reference + (Nothing in Visual Basic), the current exception is raised + in a catch block that handles the inner exception. + + + + + Is thrown when data array is smaller than it should be. + + + + + Initializes a new instance of the class with an empty error message. + + + + + Initializes a new instance of the class with a specified error message. + + Error message. + + + + Initializes a new instance of the Exception 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. + If the innerException parameter is not a NULL reference + (Nothing in Visual Basic), the current exception is raised + in a catch block that handles the inner exception. + + + + + This exception should be thrown when unexpected record is met in the stream. + + + + + Default message. + + + + + Message for exception message with record code. + + + + + Initializes a new instance of the class with default error message. + + + + + Initializes a new instance of the class with default error message. + + Record code that was met. + + + + Initializes a new instance of the class with a specified error message. + + Error message. + + + + Initializes a new instance of the Exception 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. + If the innerException parameter is not a NULL reference + (Nothing in Visual Basic), the current exception is raised + in a catch block that handles the inner exception. + + + + + Is thrown when some internal data error is found. + + + + + Initializes a new instance of the class with an empty error message. + + + + + Initializes a new instance of the class with a specified error message. + + Error message. + + + + Initializes a new instance of the Exception 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. + If the innerException parameter is not a NULL reference + (Nothing in Visual Basic), the current exception is raised + in a catch block that handles the inner exception. + + + + + Is thrown when biff stream has wrong format. + + + + + Initializes a new instance of the class with an empty error message. + + + + + Initializes a new instance of the class with a specified error message. + + Error message. + + + + Initializes a new instance of the Exception 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. + If the innerException parameter is not a NULL reference + (Nothing in Visual Basic), the current exception is raised + in a catch block that handles the inner exception. + + + + + Thrown when trying to parse an incorrect part of the Biff8 stream. + + + + + Initializes a new instance of the class with an empty error message. + + + + + Initializes a new instance of the class with a specified error message. + + Error message. + + + + Initializes a new instance of the Exception 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. + If the innerException parameter is not a NULL reference + (Nothing in Visual Basic), the current exception is raised + in a catch block that handles the inner exception. + + + + + Represents exception, that occurred during parse excel structure from xml stream. + + + + + Represents default error message. + + + + + Initializes a new instance of the class with default error message. + + + + + Initializes a new instance of the class with a specified error message. + + Error message. + + + + Creates new instance of xml reading exception. + + Represents block of xml nodes where occurred exception. + Represents some description. + + + + Summary description for ExternNameImpl. + + + + + Summary description for INameIndexChangedEventProvider. + + + + + Event for Name index changed + + + + + Extern name record with information about this name. + + + + + Index of the extern name in extern names collection. + + + + + Parent extern workbook. + + + + + Represents the refersTo attribute of the definedName tag + + + + + Sheet id + + + + + + + + + + + + + + Searches for all necessary parents. + + + + + + + + + + + Saves class into OffsetArrayList. + + OffsetArrayList that would receive class data. + + + + Creates copy of the current object. + + Parent object for the new object. + Copy of the current object. + + + + Index of the extern name in extern names collection. + + + + + Returns name of this extern name. Read-only. + + + + + Returns index of the parent extern workbook. Read-only. + + + + + Returns internal record that stores all data. Read-only. + + + + + Represents the refersTo attribute of the definedName tag + + + + + + + + + + Describes external workbook. + + + + + Array of all worksheets in this workbook. Key - index, Value - ExternWorksheet. + + + + + Dictionary key - worksheet name, value - corresponding worksheet. + + + + + Array of all extern names in this workbook. + + + + + Corresponding SupBookRecord. + + + + + Book index. + + + + + Indicates whether it is a DdeLink or not. + + + + + Parent workbook. + + + + + Workbook's short name. + + + + + Program id for ole object links. + + + + + Indicates if the workbook is parsed. + + + + + + + + + + + + Initializes internal variables. + + + + + Inserts default worksheet. + + + + + Searches for all necessary parent objects. + + + + + Parses extern workbook. + + Records array that contains workbook data. + Offset to the workbook data. + Offset after reading all necessary data. + + + + Parses extern workbook. + + Reader with workbook data. + Object used to decrypt encrypted records. + + + + Saves extern workbook as biff records. + + OffsetArrayList to serialize into. + + + + Adds extern worksheet. + + Sheet to add. + + + + Returns index of worksheet in this workbook. + + Sheet name to search for. + Index of the worksheet in the workbook; -1 if worksheet was not found. + + + + Save as html + + + + + + Get new index for extern name (to remove duplicated extern names). + + Name index. + Updated name index. + + + + Creates copy of the current extern workbook. + + Parent for the copy of this extern workbook. + Copy of the current extern workbook. + + + + Gets name of the sheet at specified index. + + Index of the desired worksheet. + Name of the sheet. + + + + Initializes ShortName property. + + + + + Gets file name with extension from the path. + + Url to get name from. + File name without extension from the path. + + + + Gets file name without extension from the path. + + Url to get name from. + File name without extension from the path. + + + + Adds new worksheets to the extern workbook. + + Array that contains worksheet names to add. + + + + Adds new worksheets to the extern workbook. + + Array that contains worksheet names to add. + + + + Adds new worksheet to the collection of worksheets. + + Name of the worksheet to add. + Create worksheet. + + + + + + + + + + Adds external name object to the workbook. + + Name of the named range to add. + + + + + + + + + + + This method is called during dispose operation. + + + + + Returns collection of extern names. Read-only. + + + + + Indicates whether this is workbook is used for internal reference. + + + + + Indicates whether the extern workbook is used as ole link + + + + + Number of sheet names (if external references) or + number of sheets in this document (if internal references). + + + + + Encoded URL without sheet name (for external references). + + + + + Gets / sets index of the workbook. + + + + + Returns parent workbook. Read-only. + + + + + Indicates whether this is a DdeLink or not. + + + + + Returns short name of the workbook. Read-only. + + + + + Indicates whether add-in function names are stored + in EXTERNNAME records following this SUPBOOK record. + + + + + Returns worksheets collection sorted by index. Read-only. + + + + + Gets or sets program id for the ole object. + + + + + Indicates if the workbook is parsed. + + + + + Summary description for ExternWorksheetImpl. + + + + + + + + + + List with sheet records. + + + + + Parent workbook. + + + + + Worksheet name. + + + + + Collection with worksheet's cached cell records. + + + + + First used row. + + + + + First used column. + + + + + Last used row. + + + + + Last used column. + + + + + Additional attributes for sheetData tag. + + + + + Represents the slicers in the worksheet. + + + + + Represents the scenarios in the worksheet. + + + + + Represents the threaded comment collection in the worksheet. + + + + + + + + + + + + Parses extern worksheet. + + Array with worksheet records. + Offset to the worksheet records. + Offset after worksheet reading all worksheet records. + + + + Extracts data from CRN record. + + CRN record to parse. + + + + Parses extern worksheet. + + + Object used to decrypt encrypted records. + + + + + + + + + + Serializes row CRN records. + + Record list to put records into. + + + + Serializes single row into set of CRN records. + + + + + + + Creates copy of the object. + + Parent object for the new object. + Created object that is copy of the current object. + + + + This method is called during dispose operation. + + + + + Caches values from specified range. + + Range to cache data from. + + + + Set cell records for current worksheet. + + Parent object for the new object. + + + + Enables the calculation support. + + Enabling this method will initialize objects and retrieves calculated values of formulas in a worksheet. + + + + + Disables the calculation support in this workbook and disposes of the associative objects. + + + + + Returns the formula string if the cell contains a formula, or the value if + the cell cantains anything other than a formula. + + The row of the cell. + The column of the cell. + The formula string or value. + + + + Sets the value of a cell. + + The value to be set. + The row of the cell. + The column of the cell. + + + + Gets cell type from current column. + + Indicates row. + Indicates column. + Indicates is need to indentify formula sub type. + Returns cell type. + + + + Not implemented. + + + + + Raises the event. + + The row of the change. + The column of the change. + The changed value. + + + + Import XML document with specified cell position to the worksheet using file path. + + FilePath of the speciifed xml file. + Row where the data to be imported. + Column where the data to be imported. + + + + Imports XML data into a worksheet at the specified row and column from a given XML data stream. + + Stream data of the xml file. + Row where the data to be imported. + Column where the data to be imported. + The stream should be passed as file stream to bind the xml + + + + + Saves worksheet with specified filename. + + File to save. + + + + Saves worksheet as stream. + + Stream to save. + + + + Saves worksheet with specified filename and .. + + File to save. + Save Options + + + + Saves worksheet as stream with the specified . + + Stream to save. + Save Options + + + + Copies worksheet data to the clipboard. + + + + + Clears worksheet data. Removes all formatting and merges. + + + + + Clears the worksheet data. + + + + + Checks whether the specified cell is initialized or accessed. + + One-based row index of the cell. + One-based column index of the cell. + Value indicating whether the cell was initialized or accessed by the user. + + + + Creates a new instance of the . + + New instance of ranges collection. + + + + Creates a named ranges with the specified named range's value as a name for the specified range. + + Existing named ranged. + Address of the named range to be created. + True if the named range values are vertically placed in the sheet. + This method is used to access the discontinuous ranges. + + + + Create an instance of that can be used for template markers processing. + + Object that can be used for template markers processing. + + + + Returns True if the specified column is visible to end user. + + One-based column index. + True if column is visible; otherwise, False. + + + + Shows the specified column. + + Index at which the column should be hidden. + True - Column is visible; False - hidden. + + + + Hides the specified column. + + One-based column index. + + + + Hides the specified row. + + One-based row index. + + + + Returns True if the specified row is visible to end user. + + One-based row index. + True if row is visible; otherwise, False. + + + + Shows or Hides the specified row. + + Index at which the row should be hidden. + True - Row is visible; False - hidden. + + + + Shows or Hides the specified range. + + Range specifies the particular range to show / hide. + True - Row is visible; False - hidden. + + + + Shows/ Hides the collection of range. + + Ranges specifies the range collection. + True - Row is visible; false - hidden. + + + + Shows or Hides an array of range. + + Ranges specifies the range array. + True - Row is visible; False - hidden. + + + + Inserts an empty row in the specified row index. + + Index at which new row should be inserted. + + + + Inserts an empty rows in the specified row index based on row count. + + Index at which new row should be inserted. + Number of rows to insert. + + + + Inserts an empty row in the specified row index with specified based on row count. + + Index at which new row should be inserted. + Number of rows to insert. + Insert options. + + + + Inserts an empty column for the specified column index. + + Index at which new column should be inserted. + + + + Inserts an empty column in the specified column index based on column count. + + Index at which new column should be inserted. + Number of columns to insert. + + + + Inserts an empty column with default formatting. + + Index at which new column should be inserted. + Number of columns to insert. + Insert options. + + + + Removes specified row (with formulas update). + + One-based row index to remove. + + + + Removes specified row (with formulas update). + + One-based row index to remove. + Number of rows to remove. + + + + Removes the specified column. + + One-based column index. + + + + Removes the specified number of columns from the given index. + + One-based column index. + Number of columns to remove. + + + + Imports an array of objects into a worksheet with specified alignment. + + Array of object. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + True if array should be imported vertically; False - horizontally. + Number of imported elements. + + + + Imports an array of string values into a worksheet. + + Array of string value. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + True if array should be imported vertically; False - horizontally. + Number of imported elements. + + + + Imports an array of integer values into a worksheet. + + Array of int value. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + True if array should be imported vertically; False - horizontally. + Number of imported elements. + + + + Imports an array of double values into a worksheet. + + Array of double value. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + True if array should be imported vertically; False - horizontally. + Number of imported elements. + + + + Imports an array of DateTime values into a worksheet. + + Array of datetime value. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + True if array should be imported vertically; False - horizontally. + Number of imported elements. + + + + Imports an array of objects into a worksheet. + + Array of object. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + Number of imported rows. + + + + Imports data from class objects into a worksheet with specified row and column. + + IEnumerable object with desired data. + First row from where the data should be imported. + First column from where the data should be imported. + TRUE if class properties names must be imported. + Number of imported rows. + + + + Imports data from class objects into a worksheet with specified row and column along with import data options. + + IEnumerable object with desired data. + Import data options for when importing nested collection data. + Number of imported rows. + + + + Imports data from a DataColumn into a worksheet. + + DataColumn with desired data. + True if column name must be imported. + Row of the first cell where Data Table should be imported. + Column of the first cell where Data Table should be imported. + Number of imported rows. + + + + Imports data from a DataColumn into a worksheet. + + DataColumn with desired data. + True if column name must be imported. + Row of the first cell where Data Table should be imported. + Column of the first cell where Data Table should be imported. + + Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + + Number of imported rows. + + + + Imports data from a DataTable into a worksheet with specified row and column. + + DataTable with desired data. + True if column names must be imported. + First row from where the data should be imported. + First column from where the data should be imported. + Number of imported rows. + + + + Imports data from a DataTable into a worksheet with the specified row and column along with save option. + + Data Table with desired data. + First row from where the data should be imported. + First column from where the data should be imported. + TRUE if data table must be serialized directly on save. + Number of imported rows. + + + + Imports data from a DataTable into a worksheet with the specified row and column along with save option. + + Data Table with desired data. + First row from where the data should be imported. + First column from where the data should be imported. + TRUE if data table must be serialized directly on save. + TRUE if column names must be imported. + Number of imported rows. + + + + Imports data from a DataTable into a worksheet with specified row and column along with the preserve type. + + DataTable with desired data. + True if column names must be imported. + First row from where the data should be imported. + First column from where the data should be imported. + + Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + + Number of imported rows. + + + + Imports data from a DataTable into a worksheet with the specified range. + + DataTable with desired data. + True if column names must be imported. + First row from where the data should be imported. + First column from where the data should be imported. + Maximum number of rows to import. + Maximum number of columns to import. + Number of imported rows. + + + + Imports data from a DataTable into a worksheet with specified range along with the specified preserve type. + + DataTable with desired data. + True if column names must be imported. + + First row from where the data should be imported. + + + First column from where the data should be imported. + + Maximum number of rows to import + Maximum number of columns to import + + Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + + Number of imported rows. + + + + Imports data from DataTable into the specified NamedRange of current worksheet. + + Data Table with desired data. + Represents named range. + TRUE if column names must be imported. + Number of imported rows. + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Imports data from DataTable into the specified NamedRange of current worksheet with row and column offset. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Data Table with desired data. + Represents named range. + TRUE if column names must also be imported. + Represents row offset into named range to import. + Represents column offset into named range to import. + Number of imported rows. + + + + Imports data from a DataTable into a worksheet with specified range along with the specified namedRange. + + DataTable with desired data. + Represents named range. + TRUE if column names must be imported. + Represents row offset into named range to import. + Represents column offset into named range to import. + Maximum number of rows to import. + Maximum number of columns to import. + Number of imported rows. + + + + Imports data from a DataTable into a worksheet with specified range,namedRange along with the specified preserve type. + + DataTable with desired data. + Represents named range. + TRUE if column names must be imported. + Represents row offset into named range to import. + Represents column offset into named range to import. + Maximum number of rows to import. + Maximum number of columns to import. + Indicates whether to preserve column types. + Number of imported rows. + + + + Imports data from DataReader into worksheet from the specified row and column. + + The or object which contains data. + TRUE if column names must be imported. + First row from where the data should be imported. + First column from where the data should be imported. + Number of imported rows. + + This method is not supported in WinRT, Windows Phone, Portable, Universal and Silverlight platforms. + + + + + Imports data from DataReader into worksheet from the specified row and column along with save option. + + The or object which contains data. + First row from where the data should be imported. + First column from where the data should be imported. + TRUE if data must be serialized directly on save. + Number of imported rows. + + This method is not supported in WinRT, Windows Phone, Portable, Universal and Silverlight platforms. + + + + + Imports data from DataReader into worksheet from the specified row and column along with the preserve type. + + The or object which contains data. + TRUE if column names must be imported. + First row from where the data should be imported. + First column from where the data should be imported. + + Indicates whether XlsIO should preserve column types from DataReader. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + Number of imported rows. + + This method is not supported in WinRT, Windows Phone, Portable, Universal and Silverlight platforms. + + + + + Imports data from DataReader into the specified NamedRange of current worksheet. + + The or object which contains data. + Represents named range. + TRUE if column names must be imported. + Number of imported rows. + + This method is not supported in WinRT, Windows Phone, Portable, Universal and Silverlight platforms. + + + + + Imports data from a DataView into worksheet with the specified row and column. + + DataView with desired data. + TRUE if column names must also be imported. + + Row of the first cell where Data View should be imported. + + + Column of the first cell where Data View should be imported. + + Number of imported rows. + + + + Imports data from a DataView into a worksheet with the specified range and preserve type. + + DataView with desired data. + TRUE if column names must be imported. + + Row of the first cell where DataView should be imported. + + + Column of the first cell where DataView should be imported. + + Indicates whether to preserve column types. + Number of imported rows. + + + + Imports data from a DataView into a worksheet with specified row, column and preserve type. + + Data View with desired data. + TRUE if column names must be imported. + + Row of the first cell where DataView should be imported. + + + Column of the first cell where DataView should be imported. + + Maximum number of rows to import. + Maximum number of columns to import. + Number of imported rows. + + + + Imports data from a DataView into a worksheet with specified range and preserve type. + + DataView with desired data. + TRUE if column names must also be imported. + + Row of the first cell where DataView should be imported. + + + Column of the first cell where DataView should be imported. + + Maximum number of rows to import. + Maximum number of columns to import. + Indicates whether XlsIO should try to preserve types in Data Table, i.e. if it is set to False (default) and in Data Table we have in + string column value that contains only numbers, it would be converted to number. + Number of imported rows. + + + + Imports data from MS DataGrid into worksheet. + + DataGrid with datasource. + Represents the first row of the worksheet to import. + Represents the first column of the worksheet to import. + TRUE if header must be imported. FALSE otherwise. + TRUE if row style must be imported. FALSE otherwise. + + + + Imports data from MS DataGrid (web) into worksheet. + + DataGrid with datasource. + Represents the first row of the worksheet to import. + Represents the first column of the worksheet to import. + TRUE if header must be imported. FALSE otherwise. + TRUE if row style must be imported. FALSE otherwise. + + + + Imports data from MS GridView into worksheet. + + GridView with datasource. + Represents the first row of the worksheet to import. + Represents the first column of the worksheet to import. + TRUE if header must be imported. FALSE otherwise. + TRUE if row style must be imported. FALSE otherwise. + + + + Imports data from MS DataGridView into worksheet. + + DataGridView with datasource. + Represents the first row of the worksheet to import. + Represents the first column of the worksheet to import. + TRUE if header must be imported. FALSE otherwise. + TRUE if row style must be imported. FALSE otherwise. + + + + Removes panes from a worksheet. + + + + + Exports worksheet data in the specified row and column into a DataTable. + + Row of the first cell from where DataTable should be exported. + Column of the first cell from where DataTable should be exported. + Maximum number of rows to export. + Maximum number of columns to export. + Export options. + DataTable with worksheet data. + + + + + Exports worksheet data in the specified range into a DataTable. + + Range to export. + Export options. + DataTable with worksheet data. + + + + Exports worksheet data in the specified row and column into a DataTable based on the export Options. + + Range to export. + Export options. + Export data options + + + + + + Exports worksheet data into a DataTable only for pivot engine. + + Range to export. + Export options. + DataTable with worksheet data. + + + + Exports worksheet data in the specified row and column and get as a list of CLR objects. + + Row of the first cell should be exported. + Column of the first cell should be exported. + LastRow is used to find the upto lastRow of data to export. + lastColumn is used to find the upto lastColumn of data to export. + CLR Objects List with worksheet data. + + + + Exports worksheet data in the specified row and column and get as a list of CLR objects.copyran + + Row of the first cell should be exported. + Column of the first cell should be exported. + LastRow is used to find the upto lastRow of data to export. + lastColumn is used to find the upto lastColumn of data to export. + Property names mapping collection. You should give headers as key and properties names as value to the dictionary. + clrObject List with worksheet data. + + + + Protects worksheet's content with password. + + Password to protect with. + + + + Protects current worksheet. + + Represents password to protect. + Represents params to protect. + + + + Unprotects worksheet's content with password. + + Password to unprotect. + + + + Intersects two ranges. + + First range to intersect. + Second range to intersect. + Intersection of two ranges or NULL if there is no range intersection. + + When range1 or range2 is NULL. + + + + + Merges two ranges. + + First range to merge. + Second range to merge. + Merged ranges or NULL if is not able to merge ranges. + + When range1 or range2 is NULL. + + + + + Changes the height of the specified row to achieve the best fit. + + One-based row index. + + + + Changes the width of the specified column to achieve the best fit. + + One-based column index. + + + + Replaces string with the specified another string value. + + The string to be replaced. + The string to replace all occurrences of oldValue. + + + + Replaces string with the specified another string value. + + The string to be replaced. + The string to replace all occurrences of oldValue. + + + + Replaces string with the specified double value. + + The string to be replaced. + The double value to replace all occurrences of oldValue. + + + + Replaces string with the specified DateTime value. + + The string to be replaced. + The DateTime to replace all occurrences of oldValue. + + + + Replaces specified string with the specified array of string values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces specified string with the specified array of int values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces specified string with the specified array of double values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces string with the specified datatable value. + + The string to be replaced. + Data table with new data. + Indicates whether field name must be shown. + + + + Replaces string with the specified datacolumn value. + + The string to be replaced. + Data table with new data. + Indicates whether field name must be shown. + + + + Removes worksheet from parent worksheet collection. + + + + + Moves worksheet to the specified index. + + New index of the worksheet. + + + + Converts the specified column width from points to pixels. + + Width in points. + Column width in pixels. + + + + Converts the specified column width from pixels to points. + + Width in pixels. + Width in points. + + + + Sets column width for the specified column. + + One-based column index. + Width to set. + + + + Sets column width in pixels for the specified column. + + One-based column index. + Width in pixels to set. + + + + Sets column width in pixels to the given number of columns from the specified column index. + + Start Column index + No of Column to be set width + Value in pixel to set + + + + Sets row height for the specified row. + + One-based row index. + Height to set. + + + + Sets row height in pixels for the specified row. + + One-based row index. + Value in pixels to set. + + + + Sets row height in pixels to the given number of rows from the specified row index. + + Starting row index. + No of Row to be set width. + Value in pixels to set. + + + + Returns the width of the specified column. + + One-based column index. + Width of the specified column. + + + + Returns the width of the specified column in pixels. + + One-based column index. + Width in pixels of the specified column. + + + + Returns the height of the specified row. + + Otherwise it gets the StandardHeight + One-based row index. + + Returns height of the specified row. + Otherwise returns StandardHeight. + + + + + Returns the height of the specified row in pixels. + + Otherwise it gets the StandardHeight in pixels + One-based row index. + + Returns height of the specified row in pixels. + Otherwise returns StandardHeight. + + + + + Returns the first occurrence of the specified string value with the specified . + + Value to search. + Type of value to search. + Returns the first cell with a specified string value, or null if value was not found. + + + + Returns the first occurrence of the specified string value with the specified and . + + Value to search. + Type of value to search. + Way to search the value. + Returns the first cell with a specified string value and specified find options , or null if value was not found. + + + + Returns the first occurrence of the specified double value with the specified . + + Value to search. + Type of value to search. + Returns the first cell with a specified double value, or null if value was not found. + + + + Returns the first occurrence of the specified bool value. + + Value to search. + Returns the first cell with a specified bool value, or null if value was not found. + + + + Returns the first occurrence of the specified DateTime value. + + Value to search. + Returns the first cell with a specified DateTime value, or null if value was not found. + + + + Returns the first occurrence of the specified TimeSpan value. + + Value to search. + Returns the first cell with a specified TimeSpan value, or null if value was not found. + + + + Returns the first occurrence that starts with the specified string value. + + Value to search. + Type of value to search. + Returns the first occurrence that starts with the specified string value, or null if value was not found. + + + + Returns the first occurrence that starts with the specified string value which ignores the case. + + Value to search. + Type of value to search. + true to ignore case wen comparing this string to the value;otherwise,false + Returns the first occurrence that starts with the specified string value, or null if value was not found. + + + + Returns the first occurrence that ends with the specified string value. + + Value to search. + Type of value to search. + Returns the first occurrence that ends with the specified string value, or null if value was not found. + + + + Returns the first occurrence that ends with the specified string value which ignores the case. + + Value to search. + Type of value to search. + True to ignore case when comparing this string to the value; otherwise, False. + Returns the first occurrence that ends with the specified string value, or null if value was not found. + + + + Returns the cells of the specified string value with the specified . + + Value to search. + Type of value to search. + Returns the cells with a specified string value, or null if value was not found. + + + + Returns the cells of the specified string value with the specified and . + + Value to search. + Type of value to search. + Way to search. + + Returns the cells with a specified string value and specified find options , or null if value was not found. + + + + + Returns the cells of the specified double value with the specified . + + Value to search. + Type of value to search. + All found cells, or Null if value was not found. + + + + Returns the cells of the specified bool value. + + Value to search. + Returns the cells with a specified bool value, or null if value was not found. + + + + Returns the cells of the specified DateTime value. + + Value to search. + Returns the cells with a specified DateTime value, or null if value was not found. + + + + Returns the cells of the specified TimeSpan value. + + Value to search. + Returns the cells with a specified TimeSpan value, or null if value was not found. + + + + Saves worksheet with specified file name using separator. Used only for CSV files. + + File to save. + Current separator. + + + + Saves worksheet using separator with specified file name and encoding. Used only for CSV files. + + File to save. + Current separator. + Encoding to use. + + + + Save tabsheet using separator. + + Stream to save. + Current separator. + + + + Save tabsheet using separator. + + Stream to save. + Current separator. + Encoding to use. + + + + Sets the default column style for the specified column. + + One-based column index. + Default style. + + + + Sets the default column style for the specified starting and ending column. + + Starting column index. + Ending column index. + Default style. + + + + Sets the default row style for the specified row. + + One-based row index. + Default style. + + + + Sets the default row style for the specified starting and ending row. + + Starting row index. + Ending row index. + Default style. + + + + Returns the default column style for the specified column. + + One-based column index. + Default column style for the specified column or null if style wasn't set. + + + + Returns default row style for the specified row. + + One-based row index. + Default row style for the specified row or null if style wasn't set. + + + + Frees range object. + + Range to remove from internal cache. + + + + Frees range object for the specified row and column. + + One-based row index of the range object to remove from internal cache. + One-based column index of the range object to remove from internal cache. + + + + Sets value for the specified cell. + + One-based row index. + One-based column index. + Value to set. + + + + Sets number for the specified cell. + + One-based row index. + One-based column index. + Value to set. + + + + Sets boolean value for the specified cell. + + One-based row index. + One-based column index. + Value to set. + + + + Sets text for the specified cell. + + One-based row index. + One-based column index. + Text to set. + + + + Sets formula for the specified cell. + + One-based row index. + One-based column index. + Formula to set. + + + + Sets error for the specified cell. + + One-based row index. + One-based column index. + Error to set. + + + + Blanks the specified cell. + + One-based row index. + One-based column index. + + + + Sets formula number value for the specified cell. + + One-based row index. + One-based column index. + Represents formula number value. + + + + Sets formula error value for the specified cell. + + One-based row index. + One-based column index. + Represents formula error value. + + + + Sets formula bool value for the specified cell. + + One-based row index. + One-based column index. + Represents formula bool value. + + + + Sets formula string value for the specified cell. + + One-based row index. + One-based column index. + Represents formula string value. + + + + Returns string value from the specified row and column. + + One-based row index. + One-based column index. + String contained by the cell. + + + + Returns number value from the specified row and column. + + One-based row index. + One-based column index. + Number contained by the cell. + + + + Returns formula value from specified row and column. + + One-based row index. + One-based column index. + Indicates whether R1C1 notation should be used. + Returns formula string. + + + + Returns error value from the specified row and column. + + One-based row index. + One-based column index. + Returns error value or null. + + + + Returns bool value from the specified row and column. + + One-based row index. + One-based column index. + Returns found bool value. If cannot found returns false. + + + + Returns formula bool value from the specified row and column. + + One-based row index. + One-based column index. + True if bool value is found. otherwise False. + + + + Returns formula error value from the specified row and column. + + One-based row index. + One-based column index. + Returns error value or null. + + + + Returns formula number value from the specified row and column. + + One-based row index. + One-based column index. + Number contained by the cell. + + + + Returns formula string value from the specified row and column. + + One-based row index. + One-based column index. + String contained by the cell. + + + + Converts the specified range into image. Default image type is Bitmap. + + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Converted Image for the specified range. + Subscript/Superscript,RTF,Shrink to fit,Shapes (except TextBox shape and Image),Charts and + Chart Worksheet and Complex conditional formatting features are not supported in Worksheet + to image conversion. Gradient fill is partially supported + + + + Converts the specified range into image with the specified type. + + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Type of the image to create. + Output stream. It is ignored if null. + Converted Image for the specified range. + Subscript/Superscript,RTF,Shrink to fit,Shapes (except TextBox shape and Image),Charts and + Chart Worksheet and Complex conditional formatting features are not supported in Worksheet + to image conversion. Gradient fill is partially supported + + + + Converts the specified range into Metafile. + + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Metafile EmfType. + Output stream. It is ignored if null. + Converted Image for the specified range. + Subscript/Superscript,RTF,Shrink to fit,Shapes (except TextBox shape and Image),Charts and + Chart Worksheet and Complex conditional formatting features are not supported in Worksheet + to image conversion. Gradient fill is partially supported + + + + Converts the specified range into image along with Metafile. + + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Type of the image to create. + Output stream. It is ignored if null. + Metafile EmfType. + Converted Image for the specified range. + Subscript/Superscript,RTF,Shrink to fit,Shapes (except TextBox shape and Image),Charts and + Chart Worksheet and Complex conditional formatting features are not supported in Worksheet + to image conversion. Gradient fill is partially supported + + + + Filters or copies data from a list based on a criteria range.. + + Whether filter in the place or copy to another place. + The filter range. + The criteria range. + The destination range for the copied rows if ExcelFilterAction is FilterCopy. Otherwise, this argument is ignored. + True to filter unique records; Otherwise filters all the records that meet the criteria. The default value is False. + + + + Calculate all the formulas in worksheet. + + + + + Makes the current sheet the active sheet. Equivalent to clicking the + sheet's tab. + + + + + Selects current tab sheet. + + + + + Unselects current tab sheet. + + + + + Indicates whether th index has formula array + + + + + + + Gets object that is clone of current worksheet in the specified workbook. + + Dictionary with update worksheet names. + New workbook object. + Object that is clone of the current worksheet. + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Converts HTML table to Excel cells. + + Specified the HTML file. + Row index + Column index + + + + Converts HTML table to Excel cells. + + Specified the HTML filestream. + Row index + Column index + + + + Converts HTML table to Excel cells. + + Specified the HTML file. + Row index + Column index + Specified the html import options + + + + Converts HTML table to Excel cells. + + Specified the HTML filestream. + Row index + Column index + Specified the html import options + + + + Occurs when the value of a cell changes. + + + + + Event to choose an action while exporting data from Excel to data table. + + + + + Event raised when an unknown function is encountered. + + + + + Gets the index number of the worksheet within the collection of + worksheet. Read-only. + + + + + Gets parent extrnal workbook. + + + + + Gets index of the reference to this worksheet. + + + + + + + + + + Returns the slicers present in the worksheet + + + + + Get the scenarios collection for the current worksheet. + + + + + Get the threaded comments collection for a current worksheet. + + + + + Gets or sets the a object associated with implementation. + + + + + An event raised on the IWorksheet whenever a value changes. + + + + + Gets the auto filters collection in the worksheet. Read-only. + + + + + Gets the used cells in the worksheet. Read-only. + + + + + Gets or sets a value that indicates whether page breaks (both automatic and manual) + on the worksheet are displayed. + + + + + Gets the sparkline groups. + + The sparkline groups. + + + + Gets protected options. Read-only. For sets protection options use "Protect" method. + + + + + Indicates is current sheet is protected. + + + + + Gets or sets the view setting of the worksheet. + + + + + True if objects are protected. Read-only. + + + + + True if the scenarios of the current sheet are protected. Read-only. + + + + + Gets whether the OLE object is present in the worksheet. Read-only. + + + True if this instance is OLE object; otherwise, False. + + + + + Gets all the merged ranges in the worksheet. Read-only. + + + + + Gets a Names collection that represents + the worksheet-specific names (names defined with the "WorksheetName!" + prefix) in the worksheet. Read-only. + + + + + Name that is used by macros to access the workbook items. Read-only. + + + + + Gets a object that contains all the page setup settings + for the specified object. Read-only. + + + + + Gets a Range object that represents a cell or a range of cells in the worksheet. + + + + + Gets a Range object that represents the rows in the specified worksheet. Read-only. + + + + + Gets a Range object that represents all the columns in the specified worksheet. Read-only. + + + + + Gets or sets the standard (default) height of all the rows in the worksheet, + in points. + + + + + Gets or sets the standard (default) height option flag. + + + Which defines that standard (default) row height and book default font height do not match. + + + + + Gets or sets the standard (default) width of all the columns in the + worksheet. + + + + + Gets the worksheet type. Read-only ExcelSheetType. + + + + + Gets a Range object that represents the used range on the + specified worksheet. Read-only. + + + + + Gets or sets the value that represents zoom factor of document. Value must be in range from 10 till 400. + + + + + Gets or sets the position of vertical split in the worksheet. + + + Position of the vertical split (px, 0 = No vertical split): + Unfrozen pane: Width of the left pane(s) (in twips = 1/20 of a point) + Frozen pane: Number of visible columns in left pane(s) + + + + + Gets or sets the position of horizontal split in the worksheet. + + + Position of the horizontal split (by, 0 = No horizontal split): + Unfrozen pane: Height of the top pane(s) (in twips = 1/20 of a point) + Frozen pane: Number of visible rows in top pane(s) + + + + + Gets or sets the first visible row index. + + + + + Gets a collection of OleObjects in the worksheet. + + The OLE objects. + + + + Gets or sets the first visible column index. + + + + + Gets or sets index of the active pane. + + + + + True if zero values to be displayed. otherwise, False. + + + + + True if grid lines are visible. otherwise, False. + + + + + Gets or sets the color of the Grid line in the worksheet. + + + + + True if row and column headers are visible. otherwise, False. + + + + + Gets a that represents the vertical page + breaks on the sheet. Read-only. + + + + + Gets a that represents the horizontal + page breaks in the worksheet. Read-only. + + + + + True if all values in the worksheet are preserved as strings. otherwise, False. + + + + + Indicates if the worksheet is password protected. + + + + + Gets a comments collection in the worksheet. + + + + + Gets or sets cell range by row and column index. Row and column indexes are one-based. + + One-based row index. + One-based column index. + + + + Get cell Range. Row and column indexes are one-based. Read-only. + + First row index. One-based. + First column index. One-based. + Last row index. One-based. + Last column index. One-based. + + + + Gets cell Range. Read-only. + + + + + Gets cell Range with R1C1Notation flag. Read-only. + + + + + Gets a hyperlink collections in the worksheet. Read-only. + + + + + Gets all not empty or accessed cells. Read-only. + + + WARNING: This property creates Range object for each cell in the worksheet + and creates new array each time user calls to it. It can cause huge memory + usage especially if called frequently. + + + + + Gets a collection of custom properties of the worksheet. Read-only. + + + + + Indicates whether all created range objects should be cached or not. + + + + + Defines whether freezed panes are applied. + + + + + Gets split cell range. + + + + + Gets/sets top visible row of the worksheet. + + + + + Gets or sets the left visible column of the worksheet. + + + + + Gets or sets whether used range should include cells with formatting. + + + There are two different algorithms to create UsedRange object: + 1) Default. This property = true. The cell is included into UsedRange, + even data is empty (maybe some formatting + changed, maynot be - cell was accessed and record was created). + 2) This property = false. In this case XlsIO tries to remove empty rows and + columns from all sides to make UsedRange smaller. + + + + + Gets a collection of pivot tables in the worksheet. Read-only. + + + + + Gets a collection of list objects in the worksheet. Read-only. + + + + + + Gets instance of migrant range. Read-only. + + The IMigrantRange interface can also be used to access a single cell + or group of cells and manipulate it. You can prefer IMigrantRange instead of IRange + while writing large amount of data which is an optimal way. + Row and Column index can be changed by using method. + + + + + Gets or Sets Tab color. + + + + + Gets / sets tab color. + + + + + Returns charts collection. Read-only. + + + + + Returns pictures collection. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + Returns shapes collection. Read-only. + + + + + Indicates whether worksheet is displayed right to left. + + + + + Indicates whether tab of this sheet is selected. Read-only. + + + + + Returns index in the parent ITabSheets collection. Read-only. + + + + + Gets / sets name of the tab sheet. + + + + + Control visibility of worksheet to end user. + + + + + Returns collection with all textboxes inside this worksheet. Read-only. + + + + + Returns collection with all checkboxes inside this worksheet. Read-only. + + + + + Returns collection with all OptionButton inside this worksheet. Read-only. + + + + + Returns collection with all comboboxes inside this worksheet. Read-only. + + + + + Return default row height in pixel. + + + + + Gets or sets one-based index of the first row of the worksheet. + + + + + Gets or sets one-based index of the first column of the worksheet. + + + + + Gets or sets one-based index of the last row of the worksheet. + + + + + Gets or sets one-based index of the last column of the worksheet. + + + + + Returns collection of cell records. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + Excel version + + + + + Summary description for FillImpl. + + + + + + + + + + + + + + + + + + + + Gradient fill style. + + + + + Gradient fill variant. + + + + + Gradient fill type. + + + + + Represents whether the dxf has pattern type none + + + + + Prevents user from creating such items without arguments. + + + + + Initializes new instance of the fill. + + Parent extended format. + + + + Initializes new instance of the fill. + + + + + + + + Initializes new instance of the fill. + + Represents pattern. + Represents color. + Represents pattern color. + + + + 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. + + + + Serves as a hash function for a particular type, suitable for use + in hashing algorithms and data structures like a hash table. + + A hash code for the current object. + + + + Creates copy of the current object. + + A copy of the current object. + + + + Returns the color of the interior. The color is specified as + an index value into the current color palette. Read-only. + + + + + Returns the color of the interior pattern as an index into the current + color palette. Read-only. + + + + + Returns fill pattern. Read-only. + + + + + Gets / sets gradient style. + + + + + Gets / sets gradient variant. + + + + + Gets / sets fill type. + + + + + Gets /sets as true is dxf pattern as none + + + + + Contains the font attributes (font name, font size, + color, and so on) for an object. + + + + + Weight of the bold font. + + + + + Weight of the normal font. + + + + + + + + + + Font index which is not present in file. + + + + + Multiplier for small bold font. + + + + + Multiplier for bold font. + + + + + Represents last not default color index. + + + + + Minimum of the font size. + + + + + Maximum of the font size. + + + + + + + + + + Wrapped FontRecord. + + + + + Parent workbook. + + + + + Current position of FontImpl class in the InnerFont Collection. + + + + + Font charset. + + + + + Native font object. + + + + + Color object. + + + + + Font's language. + + + + + Paragraph alignment + + + + + Represents whether RTF has paragraph alignment or not + + + + + Creates font and sets its Application and Parent + properties to specified values. + + Application object for the font. + Parent object for the font. + + + + Reads font from the stream. + + Application object for the font. + Parent object for the font. + Reader with font data. + + + + Creates FontImpl from FontRecord. + + Application object for the font. + Parent object for the font. + Record with font data. + + + + Creates FontImpl from FontRecord. + + Application object for the font. + Parent object for the font. + Record with font data. + + + + Creates font using data from baseFont. + + IFont that will be copied. + + When baseFont is not FontImpl and not FontImplWrapper. + + + + + Creates font based on native font and sets its Application and Parent + properties to specified values. + + Application object for the font. + Parent object for the font. + Native font to create from. + + + + Initializes color object. + + + + + Updates font record after color change. + + + + + Updates color with record's data. + + + + + Updates color with basefont's Color Object. + + + + + Initializes parent objects. + + + + + Reads font from the BiffReader. + + BiffReader that contains font data. + + When reader can't extract records anymore or + if current record in the reader is not FontRecord. + + + + + Saves all range cells into OffsetArrayList. + + Array that will receive font record. + + + + Copies data from this instance to another. + + Font impl that will receive data from this font. + + + + This method should be called after any changes. + Sets Saved property of the parent workbook to false. + + + + + Generates .Net font object corresponding to the current font. + + Generated .Net font. + + + + Generates .Net font object corresponding to the current font. + + Desired font size. + Generated .Net font. + + + + Parses native font. + + Font to parse. + + + + Measures the specified string when drawn with this font. + + String to measure. + String size. + + + + Measures the specified string in special way (as close as possible to MS Excel). + + String to measure. + String size. + + + + + + + + + + + + + + + + + + + + + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of the current instance. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of the current instance. + + + + Clones FontImpl. + + Parent object. + Returns cloned object. + + + + Converts size of the font to the twips. + + Size of the font. + Size of the font in twips. + + + + + + + + + + + Updates font indexes in different workbooks. + + Index to update. + Dictionary with new indexes. + Parse options. + Returns new index. + + + + Find and returns the supported font font style by the respective font. + + + + + + + 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. + + + + + Serves as a hash function for a particular type, suitable for + use in hashing algorithms and data structures like a hash table. + + A hash code for the current Object. + + + + Compares the current instance with another object of the same type. + + Object to compare with this instance. + + Less than zero - This instance is less than obj. + Zero - This instance is equal to obj. + Greater than zero - This instance is greater than obj. + + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + True if the font is bold. Read/write Boolean. + + + + + Returns or sets the primary color of the object. Read / write ExcelKnownColors. + + + + + Gets / sets font color. Searches for the closest color in + the workbook palette. + + + + + Gets/Sets the Font Scheme + + + + + True if the font style is italic. Read/write Boolean. + + + + + True if the font is an outline font. Read/write Boolean. + + + + + True if the font is a shadow font or if the object has + a shadow. Read/write Boolean. + + + + + Returns or sets the size of the font in points. Read / write Variant. + + + When size is less than 1 or greater than 409. + + + + + True if the font is struck through with a horizontal line. + Read/write Boolean. + + + + + True if the font is formatted as subscript. + False by default. Read/write Boolean. + + + + + True if the font is formatted as superscript; False by default. + Read/write Boolean. + + + + + Returns or sets the type of underline applied to the font. Can + be one of the following ExcelUnderlineStyle constants. + Read/write ExcelUnderline. + + + + + Returns or sets the font name. Read/write string. + + + + + Gets / sets font vertical alignment. + + + + + Indicates whether color is automatically selected. Read-only. + + + + + Gets or sets the baseline value which indicates whether superscript or subscript + + + + + Returns wrapped FontRecord. Read-only. + + + + + Parent workbook. Read-only. + + + + + Font index in the workbook fonts collection. + + + + + Returns workbook graphics. Read-only. + + + + + Gets/sets font charset. + + + + + Gets or sets the family. + + The family. + + + + Returns color object. + + + + + Gets or sets font's language. + + + + + Gets or sets RTF paragraph alignment + + + + + Returns whether RTF text has paragraph alignment or not + + + + + Check whether the font can be disposed + + + + + + + + + + Returns font index. Read-only. + + + + + Returns current font. Read-only. + + + + + Class that is created when user accesses the + font in a multicell range. Redirects all calls + to the fonts of the individual cells. + + + + + Array that contains all cells of the range. + + + + + Create new instance of object. + + Base range. + + + + Create new instance of object. + + Base range. + + + + Generates .Net font object corresponding to the current font. + + Generated .Net font. + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Detect whether the cell styles can be applied for the range. + + + + + True if the font is bold. Read/write Boolean. + + + + + Returns or sets the primary color of the object. Read / write ExcelKnownColors. + + + + + Gets / sets font color. If there is at least one free color, + define a new color. If not, search for the closest one in + workbook palette. + + + + + True if the font style is italic. Read/write Boolean. + + + + + True if the font is an outline font. Read/write Boolean. + + + + + True if the font is a shadow font or if the object has + a shadow. Read/write Boolean. + + + + + Returns or sets the size of the font. Read/write Variant. + + + + + True if the font is struck through with a horizontal line. + Read/write Boolean + + + + + True if the font is formatted as subscript. + False by default. Read/write Boolean. + + + + + True if the font is formatted as superscript; False by default. + Read/write Boolean. + + + + + Returns or sets the type of underline applied to the font. Can + be one of the following ExcelUnderlineStyle constants. + Read/write ExcelUnderline. + + + + + Returns or sets the font name. Read/write string. + + + + + Gets / sets font vertical alignment. + + + + + Indicates whether color is automatically selected. Read-only. + + + + + Summary description for FontWrapper. + + + + + Wrapped font. + + + + + Font character set. + + + + + Indicates whether font is read-only. + + + + + Indicates whether raise events. + + + + + Indicates whether wrapped font is accessed directly (without creating + new font in OnBeforeChange, OnAfterChange methods). + + + + + Font color object + + + + + Represents the color format + + + + + Represents the Range + + + + + Creates new font wrapper. + + + + + Creates new font wrapper. + + Font to wrap. + + + + Creates new font wrapper. + + Font to wrap. + Indicates whether wrapper should be read-only. + + Indicates whether to call OnBeforeChange and OnAfterChange when any property changes. + + + + + Generates .Net font object corresponding to the current font. + + Generated .Net font. + + + + Update color object + + + + + Returns copy of current object. + + Parent Workbook. + Parent object. + Dictionary with new indexes. + Clone of FontWraper. + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Invokes after change event. + + + + + + True if the font is bold. Read / write Boolean. + + + + + Returns or sets the primary color of the object, as shown in the + following table. Use the RGB function to create a color value. + Read / write Integer. + + + + + Gets / sets font color. Searches for the closest color in + the workbook palette. + + + + + True if the font style is italic. Read / write Boolean. + + + + + True if the font is an outline font. Read / write Boolean. + + + + + True if the font is a shadow font or if the object has + a shadow. Read / write Boolean. + + + + + Returns or sets the size of the font. Read / write Variant. + + + + + True if the font is struck through with a horizontal line. + Read / write Boolean + + + + + Gets or sets the offset value of superscript and subscript + + + + + True if the font is formatted as subscript. + False by default. Read / write Boolean. + + + + + True if the font is formatted as superscript. False by default. + Read/write Boolean + + + + + Returns or sets the type of underline applied to the font. Can + be one of the following ExcelUnderlineStyle constants. + Read / write ExcelUnderline. + + + + + Returns or sets the font name. Read / write string. + + + + + Returns the font character set + + + + + Gets / sets font vertical alignment. + + + + + Indicates whether color is automatically selected. Read-only. + + + + + Application object. + + + + + Parent object. + + + + + Event raised after wrapped font changed. + + + + + Returns font index. Read-only. + + + + + Returns wrapped font. Read-only. + + + + + Indicates whether font is read-only. + + + + + Returns parent workbook. + + + + + Indicates whether wrapped font is accessed directly (without creating + new font in OnBeforeChange, OnAfterChange methods). + + + + + + + + + + Indicates the range. + + + + + Returns index of the wrapped font. Read-only. + + + + + Returns wrapped font. Read-only. + + + + + Represents number format. Responsible for reading, writing, + parsing, applying, checking and other operations with number formats. + + + + + Represents settings of number format. + + + + + Returns format index. Read-only. + + + The following code illustrates how to access the Index of the NumberFormat applied. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Value = "1200.40"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set number format index + style.NumberFormat = "#,##0"; + + //Set number format settings + INumberFormat numberFormat = style.NumberFormatSettings; + + //Get number format index + Console.Write(numberFormat.Index); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //3 + + + + + + Returns format string. Read-only. + + + The following code illustrates how to access the FormatString of the NumberFormat applied. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Value = "1200.40"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set number format index + style.NumberFormat = "#,##0.00"; + + //Set number format settings + INumberFormat numberFormat = style.NumberFormatSettings; + + //Check number format string + Console.Write(numberFormat.FormatString); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //#,##0.00 + + + + + + Returns format type of the first section of this number format. Read-only. + + + The following code illustrates how to access the FormatType of the NumberFormat applied. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Value = "1200.40"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set number format index + style.NumberFormat = "#,##0.00"; + + //Set number format settings + INumberFormat numberFormat = style.NumberFormatSettings; + + //Check number format type + Console.Write(numberFormat.FormatType); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //Number + + + + + + Indicates whether the first section of this number format contains fraction sign. Read-only. + + + The following code illustrates how to access IsFraction property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Value = "1200.40"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set number format index + style.NumberFormat = "# ?/?"; + + //Set number format settings + INumberFormat numberFormat = style.NumberFormatSettings; + + //Check number format is fraction + Console.Write(numberFormat.IsFraction); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + + + + + + Indicates whether first section of this number format contains E/E+ + or E- signs in format string. Read-only. + + + The following code illustrates how to access IsScientific property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Value = "1200.40"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set number format index + style.NumberFormat = "#.##E+##"; + + //Set number format settings + INumberFormat numberFormat = style.NumberFormatSettings; + + //Get number format index + Console.Write(numberFormat.IsScientific); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + + + + + + Indicates whether thousand separator is present in the first section + of this number format. Read-only. + + + The following code illustrates how to access IsThousandOperator property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Value = "1200.40"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set number format index + style.NumberFormat = "#,##0"; + + //Set number format settings + INumberFormat numberFormat = style.NumberFormatSettings; + + //Check number format thousand separator + Console.Write(numberFormat.IsThousandSeparator); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + + + + + + Number of digits after "." sign in the first section of this number format. Read-only. + + + The following code illustrates how to access DecimalPlaces property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["C2"].Value = "1200.40"; + + //Add style + IStyle style = workbook.Styles.Add("CustomStyle"); + + //Set style + worksheet["C2"].CellStyle = style; + + //Set number format index + style.NumberFormat = "#,##0.00"; + + //Set number format settings + INumberFormat numberFormat = style.NumberFormatSettings; + + //Check number format decimal places + Console.Write(numberFormat.DecimalPlaces); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //2 + + + + + + Format record that contains low-level information about format. + + + + + Parsed format. + + + + + Reference to the format parser. + + + + + Reference to the format applier. + + + + + Dictionary to store the Alternate formats + + + + + Initializes new instance of the format. + + Application object for the new format. + Parent object for the new format. + + + + Initializes new instance of the format. + + Application object for the new format. + Parent object for the new format. + Format record that contains low-level information about format. + + + + Initializes new instance of the format. + + Application object for the new format. + Parent object for the new format. + Format index. + Format string. + + + + Searches for all necessary parent objects. + + + + + indicates if the number format is used in the workbook. + + + + + Serializes format into OffsetArrayList. + + OffsetArrayList to serialize into. + + + + Checks whether format is already parsed, if it isn't than parses it. + + + + + Returns the alternate format for the specified format. + + Alternate format for the specified format. + + + + Returns format type for a specified value. + + Value to get format type for. + Format type for the specified value. + + + + Returns format type for a specified value. + + Value to get format type for. + Format type for the specified value. + + + + Applies format to the value. + + Value to apply format to. + String representation of the value according to the number format. + + + + Applies format to the value. + + Value to apply format to. + Indicates whether to show hidden symbols. + String representation of the value according to the number format. + + + + Applies format to the value + + Value to apply format to. + Indicates whether to show hidden symbols + Current cell + String representation of the value according to the number format + + + + Applies CF format to the value. + + Value to apply format to. + Cell Range. + Number format. + String representation of the value according to the CF number format. + + + + Applies format to the value. + + Value to apply format to. + String representation of the value according to the number format. + + + + Applies format to the value. + + Value to apply format to. + Indicates whether to show hidden symbols. + String representation of the value according to the number format. + + + + Indicate whether the format string in time format + + + + + Indicate whether the format string in date format + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Get the Alternate Format + + + + + Returns format index. Read-only. + + + + + Returns format string. Read-only. + + + + + Returns format record that contains low-level information about format. Read-only. + + + + + Returns format type of the first section of this number format. Read-only. + + + + + Indicates whether the first section of this number format contains fraction sign. Read-only. + + + + + Indicates whether first section of this number format contains E/E+ + or E- signs in format string. Read-only. + + + + + Indicates whether thousand separator is present in the first section + of this number format. Read-only. + + + + + Number of digits after "." sign in the first section of this number format. Read-only. + + + + + Gets the number of digits after scientific(E) sign. Read-only. + + + + + indicates if the number format is used in the workbook. + + + + + Parses formula tokens extracted by FormulaTokenizer and converts them into tokens in RPN form. + + + + + Name of if function in uppercase. + + + + + Options value for tAttr token in the case of space token. + + + + + Data value for tAttr token in the case of space token. + + + + + Default options for ExternName that is used as part of DDE link. + + + + + Represents the Abosulte cell references. + + + + + Regex pattern to catch space before +(any digits) + + + + + Replacement string to replace the pattern without space before +(any digits) + + + + + Default regular expression options. + + + + + Converts string into set of tokens. + + + + + Array with tokens in RPN order. + + + + + + + + + + collection of token spaces before operands. + + + + + Parent workbook. + + + + + Indicates whether the lambda function have the last argument or not. + + + + + Collection of function in user defined formulas. + + + + + Initializes new instance of the formula parser. + + Parent workbook object. + + + + Sets formula separators. + + Operand separator to set. + Array rows separator to set. + + + + Parses formula string. + + String to parse. + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Constant arguments required by some parse methods. + + + + Parses expression. + + Subexpression priority. + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Constant arguments required by some parse methods. + + + + + Creates binary operation. + + Type of the token to create. + Space token that can be added before operation if not null, + becomes null after adding to the tokens array. + Created operation. + + + + Parses spaces and creates required tokens. + + + + + + Space token if any was created. + + + + Creates spaces token. + + Number of spaces. + Created space token. + + + + + + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Constant arguments required by some parse methods. + + + + + Updates parsing options if necessary. + + Options to update. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Identifier to parse. + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Constant arguments required by some parse methods. + Created token for the specified identifier. + + + + Parse the tname1 tokenizer + + strToken contains the + + Index of the current argument. + Parsing options. + Constant arguments required by some parse methods. + Created token for the specified identifier. + arguments cannot be empty. + strToken cannot be null reference. + + + + Tries to get named range object based on the formula string. + + + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Location reference index; -1 means local sheet reference. + + + + + Converts location string into reference. + + Location to convert. + Constant arguments required by some parse methods. + Reference index. + + + + + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Constant arguments required by some parse methods. + + + + + Creates Excel 2007 function. + + Resulting formula token. + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Constant arguments required by some parse methods. + True if current string was recognized as formula token. + + + + This function tries to create range (cell or area) based on the formula string and other arguments. + + Identifier string without location part (worksheet, book). + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Constant arguments required by some parse methods. + Resulting token. + Location reference index; -1 means local sheet reference. + True if formula string was parsed as range. + + + + Checks the values has row and column details and return true if string is in row and column value else false. + + Represents the string to be checked. + Represents the string is in R1C1 Notation. + Represents the row + Represents the column + if name has row and column details returns true else false. + + + + Checks the string has char + + + + + + + Checks the string has digit + + + + + + + Tries to create named range object based on the formula string. + + + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Location reference index; -1 means local sheet reference. + + + + + Creates named range token for external name. + + Location reference index. + Name of the named range to create token for. + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Created token. + + + + Creates named range token for local name. + + Location reference index; -1 means local sheet reference. + Name of the named range to create token for. + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Created token. + + + + Checks if the local name is a table formula. + + Local name + Parserparameters + True if it is Table Formula. + + + + Creates named range token. + + Reference index to the token location. + Name index. + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Created name token. + + + + Creates token for local name. + + Name location. + Token + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + + + + + Checks whether specified location is extern. + + Parent workbook. + Location to check. + True if it is extern location. + + + + Creates function token and adds all argument tokens to the internal token array. + + Id of the function to create. + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Constant arguments required by some parse methods. + Created function token. + + + + Creates IF function and adds all argument tokens to the internal token array. + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Constant arguments required by some parse methods. + Space token that must be inserted before IF. + Created function token. + + + + Creates custom functions and adds all argument tokens to the internal token array. + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Constant arguments required by some parse methods. + Created function token. + + + + Evaluates size of the tokens range. + + The first token to measure (included). + The last token to measure (not included). + Arguments required by some parse methods. + Size in bytes of the specified tokens. + + + + Extracts operands from the string. + + Parsing options. + Arguments required by some parse methods. + Parent function id. + + + + + + + + + + + + + Parses error reference. + + + Dictionary with attributes that describes token index that should be used at + special function position ( it can be reference token, value token, or array token ). + + Index of the current argument. + Parsing options. + Parent worksheet. + Reference error Ptg. + + + + Get or set indicates whether the lambda function have the last argument or not. + + + + + + + + + + Gets / sets number format info. + + + + + Contains objects that can be used by some parse methods. + + + + + Instance of the FormulaUtil class - helper class for formula parsing. + + + + + Worksheet that contains cell that is currently parsed. + + + + + + + + + + Indicates whether R1C1 notation should be used. + + + + + Cell row index (it is used when parsing R1C1 and Shared and Array formulas). + + + + + Cell column index (it is used when parsing R1C1 and Shared and Array formulas). + + + + + Workbook that contains cell that is currently parsed. + + + + + Destination excel version. + + + + + Initializes new instance of the parameters. + + Worksheet that contains cell that is currently parsed. + + Indicates whether R1C1 notation should be used. + Cell row index (it is used when parsing R1C1 and Shared and Array formulas). + Cell column index (it is used when parsing R1C1 and Shared and Array formulas). + Instance of the FormulaUtil class - helper class for formula parsing. + Parent workbook. + + + + Converts string into set of tokens. + + + + + Indicates end of formula string. + + + + + Indicates whitespace character. + + + + + Indicates colon character. + + + + + Current character. + + + + + Formula length. + + + + + + + + + + Current formula. + + + + + Start position of the current token. + + + + + Current token TokenType. + + + + + Token type of the previous token. + + + + + Previous character position. + + + + + String builder that contains string representation of the current token. + + + + + Parent workbook. + + + + + Argument separator. + + + + + Number format info. + + + + + Represents whether subtraction is present or not. + + + + + Represents whether the lambda function have last argument or not. + + + + + Represents whether the byrow function or not. + + + + + Default constructor. + + + + + Prepares tokinezer for formula parsing. + + Formula to parse. + + + + To check whether the formula contains LET function. + + string to be checked with formula + return true if it contians the string else returns false + + + + Moves pointer to the next character. + + + + + Moves back to the specified character. + + + + + + Extracts next token from the string. + + + + + Retruns the symbols count inside the quoted string + + formula string to be counted + input symbol + returns the occurences of symbols inside quoted string + + + + + + + + + + + + + + Extracts number token. + + + + + Process '>' character and creates required token. + + + + + Process '<' character and creates required token. + + + + + Appends internal string builder while current character is number. + + + + + Parses identifier, it can be range address, named range of function name. + + + + + Process the text to check r1c1 notation + + text to be processed + processed text + + + + Extracts spaces from the string. + + + + + Parses string token. + + Indicates whether first character is quotation character or not. + + + + Parses error token. + + + + + Extracts string representation of an array token. + + + + + Skips string and adds its value into internal string builder. + + + + + Raises parse exception. + + Exception message. + Inner exception. + + + + Raises parser exception with message that token was unexpected. + + Additional message. + + + + Find the character occurences from a string + + string to be searched + the character to be find + the previous character + the next character + Character Occurences count + + + + Indicates whether subtraction is present or not. + + + + + Returns value of the current token. Read-only. + + + + + Gets / sets argument separator. + + + + + Gets / sets number format info. + + + + + This class provides functionality needed for formula parsing. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Default regular expression options. + + + + + Default index inside named range formula. + + + + + Default reference index. + + + + + Default reference index for array token. + + + + + + + + + + + + + + + + + + + + + + + + + Column of the first cell. + + + + + Column of the second cell. + + + + + Row of the first cell. + + + + + Row of the second cell. + + + + + Worksheet name can be enclosed in this characters. + + + + + Represents the Abosulte cell references. + + + + + Represents the Excel2010 function prefix + + + + + Represents the prefix for the LET functions variable. + + + + + Represents the prefix for the Filter function. + + + + + Name of the sheet name group. + + + + + Name of the book name group. + + + + + Name of the range name group. + + + + + Name of the first row name group. + + + + + Name of the first column name group. + + + + + Name of the path group. + + + + + Name of sheet. + + + + + Default sheet name regular expression. + + + + + + + + + + Array of all open brackets. + + + + + T corresponding close brackets. + + + + + String 'brackets'. + + + + + All known unary operations. + + + + + Plus and minus signs. + + + + + Plus minus signs in sorted storage. + + + + + Gives access to the function name by its id. + + + + + Gives access to the number of parameter needed by the function. + + + + + + Maintains a collection of infinite parameter count function id. + + + + + Provides access to function id by its name. + + + + + Provides access to Dictionary that contains all Reference index + by type of the argument token. + + + + + Provides access to constructor that takes one string argument + by name of the error. + + + + + Dictionary error code to name. + + + + + Dictionary error name to error code. + + + + + Provides access to TokenConstructorAttribute by token code. + This table allows user to rewrite default token classes. + + + + + Represents hash table that get access by token code to PTG. + Key - token code. Value - instance of created PTG. + + + + + Regular expression for checking if specified string is cell reference. + + + + + Regular expression for checking if specified string is cell reference. + + + + + Regular expression for checking if specified string is cell reference. + + + + + Regular expression for checking if specified string is cell range. + + + + + Regular expression for checking if specified string is multiple cell range. + + + + + Regular expression for checking if specified string is full row range. + + + + + Regular expression for checking if specified string is full column range. + + + + + Regular expression for checking if specified string is full row range in R1C1 notation + + + + + Regular expression for checking if specified string is full column range in R1C1 notation. + + + + + Regular expression for checking if specified string is 3D full row range. + + + + + Regular expression for checking if specified string is 3D full column range. + + + + + Regular expression for checking if specified string is cell range in R1C1 notation. + + + + + Regular expression for checking if specified string is cell range in R1C1 notation. + + + + + Regular expression for checking if specified string is cell range in R1C1 notation. + + + + + Regular expression for 3d reference detection. + + + + + Regular expression for 3d reference detection in R1C1 notation. + + + + + Regular expression for 3d cell range detection. + + + + + Regular expression for 3d cell range detection second possible case. + + + + + Regular expression for 3d cell range detection. + + + + + Regular expression for 3d cell range detection second possible case. + + + + + Regular expression for add-in function detection. + + + + + Array of functions that need tAttr with HasSemiVolatile = true before them. + + + + + + + + + + + + + + + Represents number format for parsing double value. + + + + + Parent workbook. + + + + + All known operations for invariant culture. + + + + + Operations with priorities. + + + + + All operations sorted by operation string. + Key - operation string, Value - operation priority. + + + + + + + + + + Array row separator. + + + + + Operands separator. + + + + + Formula parser. + + + + + Indicates whether the lambda function have the last argument count or not. + + + + + Static constructor. It does all necessary preparations, + such as preparing all hashtables for functions, errors + and token constructor. + + + + + Initializes new instance of the formula parsing utility. + + Application object. + Parent object. + + + + Initializes new instance of the formula parsing utility. + + Application object. + Parent object. + Number format information. + Argument separator. + Row separator. + + + + Searches for all necessary parent objects. + + + + + Fills operations with default values. + + + + + Fills internal hashtable that permits to construct + token classes by token code. + + + + + Fills all information about known Excel functions. + + + + + Fills all the information about known miss arguments Excel functions + + + + + Fills all information about known Excel functions. + + + + + Fills information about all known error names. + + + + + Add information about all supported errors from specified type. + + Type that supports some errors. + + + + + + + + + Converts string array into sorted list. + + Array to convert. + Created sorted list. + + + + Converts string to shared formula token array. + + Represents formula string. + Represents first row from cells range. One-based. + Represents first column from cells range. One-based. + Parent worksheet object. + Shared formula tokens. + + + + Converts to shared formula tokens + + + + + + + + + + Converts string to token array. + + + String that should be parsed into Ptg array. + + Token array representing specified string. + + When any error occurs in the specified formula string. + + + + + Converts string to token array. Used when copying worksheets into another workbook. + + + String that should be parsed into Ptg array. + + Parent sheet. + + Dictionary that contains old name of the worksheet as + a key and new name of the worksheet as value. + + Token array representing specified string. + + When any error occurs in the specified formula string. + + + + + Converts string to token array. Used when copying worksheets into another workbook. + + + String that should be parsed into Ptg array. + + Parent sheet. + + Dictionary that contains old name of the worksheet as + a key and new name of the worksheet as value. + + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + Indicates whether R1C1 notation is used. + Token array representing specified string. + + When any error occurs in the specified formula string. + + + + + Converts string to token array. + + String that should be parsed into Ptg array. + Worksheet that contains formula. + Token indexes, indicates whether to use reference token, value token, or array token. + Index in string. + Hash table with worksheet names. + Parse options. + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + Parsed formula. + + When formula string is empty or if there is another error in formula string + or when string consists only of %. + + + + + Returns operand that is placed before unary operation. + + + Formula string that contains operand and unary operation. + + + Index of unary operation in the string. + + Left operand of the specified unary operation. + + + + Returns operand that is placed after unary operation. + + + Formula string that contains operation and operand. + + Index of the operation. + Right operand of the specified unary operation. + + + + Returns right operand for binary operation. + + Formula string. + Index of first operand character. + String with operation. + Right operand for the specified operation. + + + + Extracts function operand from formula string. + + Formula string to extract operand from. + First character of the operand. + Extracted operand. + + + + This method converts FormulaRecord to its string representation. + + FormulaRecord that will be parsed. + String representation of the specified formula. + + + + This method converts FormulaRecord to its string representation. + + FormulaRecord that will be parsed. + Indicates whether formula must be parsed using R1C1 notation. + String representation of the specified formula. + + + + Parses shared formula. + + Formula to parse. + String representation of the specified formula. + + + + Parses shared formula. + + Formula to parse. + Zero-based row index of the cell with shared formula. + Zero-based column index of the cell with shared formula. + String representation of the specified formula. + + + + Parses shared formula. + + Formula to parse. + Zero-based row index of the cell with shared formula. + Zero-based column index of the cell with shared formula. + Indicates whether formula must be parsed using R1C1 notation. + String representation of the specified formula. + + + + Converts array of tokens into string. + + Tokens to convert. + String representation of the specified tokens array. + + + + This method converts array of Ptg to its string representation. + + Ptg array that will be parsed. + First row to convert. + First column to convert. + Indicates whether R1C1 notation must be used. + String representation of the specified Ptg array. + + + + This method converts array of Ptg to its string representation. + + Ptg array that will be parsed. + First row to convert. + First column to convert. + Indicates whether R1C1 notation must be used. + Represents current number info, can be null. + String representation of the specified Ptg array. + + + + This method converts array of Ptg to its string representation. + + Ptg array that will be parsed. + First row to convert. + First column to convert. + Indicates whether R1C1 notation must be used. + Represents current number info, can be null. + Indicates whether to remove worksheet name from 3d tokens. + String representation of the specified Ptg array. + + + + Checks the formula version. + + The PTGS. + The result. + + + + + Splits array. Each string in result represents single row of the array. + + Array string to split. + Separator + Splitted array. + + + + Updates index of the name. + + Token to update. + Array with new named ranges indexes. + + + + Updates index of the name. + + Token to update. + Dictionary with new named ranges indexes. + + + + Updates name indexes. + + Parsed expression to update. + Dictionary with new indexes. + True if at least one of references to named ranges was updated. + + + + Updates name indexes. + + Parsed expression to update. + Array with new indexes. + True if at least one of references to named ranges was updated. + + + + Sets separators. + + Operand separator to set. + Array rows separator to set. + + + + Replaces keys in the list. + + List to replace in. + Old keys to replace. + New keys to replace. + + + + Marks used references. + + Tokens to get used references from. + Array to mark used references in. + + + + Updates reference indexes. + + Tokens to get used references from. + Array with updated indexes. + + + + Converts string that represents constant value to Ptg. + + String that represents constant. + Parent worksheet. + Dictionary with worksheet names + Parse options. + Token corresponding to the specified string. + + + + Converts string that represents constant value to Ptg. + + String that contains constant. + Parent worksheet. + + Dictionary with attributes that describes token index + that should be used at special function position. + + Parameter position. + + + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + Newly created token. + + When specified string is not constant formula token. + + + + + Normalizes sheet name. + + + + + + + Converts byte array to Ptg array. + + Object that provides access to the data. + + Number of bytes to parse (there can be array data + after of all tokens). + + Excel version that was used to infill data provider. + + String representation of the specified byte array that contains tokens. + + + + + Checked whether the record is valid or not + + + + + Converts byte array to Ptg array. + + Object that provides access to the data. + Start position in data array to parse from. + + Number of bytes to parse (there can be array data + after of all tokens). + + + Receives offset of first byte after all tokens' data. + + Excel version that was used to infill data provider. + Converted Ptg array. + + + + Converts token array to corresponding byte array. + + Ptg array that will be converted to byte array. + Excel version that should be used to infill data. + Converted byte array + + + + Converts token array to corresponding byte array. + + Ptg array that will be converted to byte array. + + Length of formula without tArray data if there is tArray in Tokens. + + Excel version that should be used to infill data. + Converted byte array. + + + + Returns left operand for binary operation. + + Formula string. + Index of operation. + Left operand for specified operation. + + + + Searches for position of corresponding bracket. + + String to search. + Position of bracket( "(){}" ). + + Position of corresponding bracket if there is one, otherwise -1. + + + When specified position does not contain bracket. + + + + + Returns operand of the operation. + + + Formula string that contains operation and operands. + + Index of the operation. + Delimiters between operands. + + Search direction (TRUE -right to left, + FALSE - left to right). + + Operand defined by function parameters. + + When a open bracket is found without a corresponding closing bracket. + + + + + Registers function in internal collections. + + + Name of the function that must be registered. + + + Index of the function that must be registered. + + + Array of ReferenceIndexAttribute that contains information + about proper token index. + + + + + Registers function in internal collections. + + + Name of the function that must be registered. + + + Index of the function that must be registered. + + + Array of ReferenceIndexAttribute that contains information + about proper token index. + + + Number of parameters in the function, + -1, for variable parameters. + + + + + Registers function in internal collections. + + + Name of the function that must be registered. + + + Index of the function that must be registered. + + + Number of parameter in the function, + -1, for variable parameters number. + + + + + Registers function in internal collections. + + + Name of the function that must be registered. + + + Index of the function that must be registered. + + + + + This method raises the FormulaEvaluation event. + + Range that caused FormulaEvaluation event. + Object that contains event arguments. + + + + Registers token class (can be user defined). + + Token class that will be registered. + + When class is not derived from Ptg. + + + When parameter type is NULL. + + + + + Registers new function alias. + + New alias name. + Function index. + + + + Updates index of the name. + + Ptg to Update + Old index. + New index. + + + + Searches for the specified object and returns the index of + the first occurrence within the entire one-dimensional array. + + Array to search. + Value to locate in the array. + + The index of the first occurrence of value within the entire array, if found; + otherwise, -1. + + + + Searches for the specified object and returns the index of + the first occurrence within the entire one-dimensional array. + + Array to search. + Value to locate in the array. + + The index of the first occurrence of value within the entire array, if found; + otherwise, -1. + + + + Searches for the specified object and returns the index of + the first occurrence within the entire one-dimensional array. + + Array to search. + Value to locate in the array. + + The index of the first occurrence of value within the entire array, if found; + otherwise, -1. + + + + Searches for the specified object and returns the index of + the first occurrence within the entire one-dimensional array. + + Array to search. + Value to locate in the array. + + The index of the first occurrence of value within the entire array, if found; + otherwise, -1. + + + + Searches for the specified object and returns the index of + the first occurrence within the entire one-dimensional array. + + String to search in. + Start index. + Break strings. + Position of one of the break strings. + + + + Searches for the specified object and returns the index of + the first occurrence within the entire one-dimensional array. + + String to search in. + Start index. + Key is break string. + Position of one of the break strings. + + + + Returns lower bound of strings that have specified first character. + + Sorted array of string to search. + Desired first character. + + Lower bound of the strings that have chFirst as the first character + if there are such strings; otherwise -1. + + + + Returns lower bound of strings that have specified first character. + + Sorted array of string to search. + Desired first character. + + Lower bound of the strings that have chFirst as the first character + if there are such strings; otherwise -1. + + + + Returns lower bound of strings that have specified first character. + + Sorted array of string to search. + Desired first character. + + Lower bound of the strings that have chFirst as the first character + if there are such strings; otherwise -1. + + + + Converts SharedFormula tokens into regular formula tokens. + + Shared formula to convert. + Parent workbook. + Row of the destination formula. + Column of the destination formula. + Converted token array. + + + + Updates formula after move / copy operation. + + Tokens to update. + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + One-based row index. + One-based column index. + Updated tokens array. + + + + Updates formula after move / copy operation. + + Tokens to update. + Value to add to the row index. + Value to add to the column index. + Updated tokens array. + + + + Change the Name reference Index + + The source workbook. + The destination workbook. + Cell formula array. + + + + Pushes operand into stack correctly. + + + + + + + Creates function ptg. + + Formula string that contains function. + Index of bracket after function name. + Parent object. + Parent worksheet. + Dictionary with indexes. + Current index. + Dictionary with new worksheet names. + Parse options. + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + Created function token. + + + + Indicates whether specified string is name of custom function. + + String to check. + Workbook that contains function. + Index to the extern workbook. + Name index. + True if specified string is name of custom function. + + + + Indicates whether specified name is name of local custom function. + + Parent workbook. + Function name. + Resulting name index. + + + + + Checks is custom function. + + Parent Workbook. + Current Match. + Book index. + Name index. + True if it is custom function, otherwise false. + + + + + + + + + + + + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + + + + + + Creates tokens for custom function and its arguments. + + Token reference index. + Formula string. + Bracket index in the formula. + Parent workbook. + Parent worksheet. + Dictionary with worksheet names (key - old name, value - new name). + Parse options. + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + Array of tokens that describes custom function. + + + + Creates tokens for custom function and its arguments. + + Token reference index. + Formula string. + Bracket index in the formula. + + + Parent workbook. + Parent worksheet. + Dictionary with worksheet names (key - old name, value - new name). + Parse options. + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + Array of tokens that describes custom function. + + + + Creates token that describes specified error. + + Formula string that contains error string. + Index of the error name. + Created token that contains error. + + + + Converts operand string into Ptg array. + + Operand string that should be parsed. + Parent workbook. + Parent worksheet. + + + + Parse options. + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + Parsed operand as array of ptg. + + + + Creates unary operation. + + Operation symbol that should be created. + Newly created unary operation. + + + + Return string array of arguments of the operation. + + Formula string. + OperationPtg that is built by OpIndex. + + + + Indicates if specified string is cell name. + + Formula string that will be checked. + Indicates whether R1C1 notation must be used. + String representation of the row. + String representation of the column. + True if parameter is cell name, i.e. "A1", False otherwise. + + + + Returns true, if specified string has cell reference. + + Formula string that will be checked. + True, if paramater has cell reference. + + + + Returns true, if specified string is R1C1 reference. + + Formula string that will be checked. + True, if paramater is R1C1 cell reference. + + + + Indicates if specified string is cell range. + + Formula string that will be checked. + Indicates whether R1C1 notation must be used. + The first cell's row. + The first cell's column. + The second cell's row. + The second cell's column + True if parameter is cell range, i.e. "A1:D1", False otherwise. + + + + + + + + + + + + Indicates if specified strings is 3d cell reference. + + Formula string that will be checked. + Indicates whether R1C1 notation must be used. + Name of the worksheet if succeeded; otherwise - NULL. + String representation of the row part of the cell reference. + String representation of the column part of the cell reference. + + True if parameter is 3d cell reference, i.e. "Sheet1!A1", False otherwise. + + + + + Indicates whether specified string is 3d cell range. + + String that should be checked. + Indicates whether R1C1 notation must be used. + String that initialize by current sheet name. + String representation of the row part of the first cell reference. + String representation of the column part of the first cell reference. + String representation of the row part of the second cell reference. + String representation of the column part of the second cell reference. + True if string is 3d cell range. + + + + Tells whether specified string contains error + at the specified position. + + String that can contain error string. + Index were error. + + True if specified string contains error + at the specified position. + + + + + Indicates whether specified string is name defined in the workbook. + + String to check. + Parent workbook. + IWorksheet implement. + True if specified string is name defined in the workbook; False otherwise. + + + + Searches for corresponding bracket. + + Formula string where bracket was found. + Position of the found bracket. + Array of all possible opening brackets. + Search direction. + Position of the corresponding record. + + If the corresponding bracket is not found. + + + If there is no bracket at the specified bracket position. + + + + + Indicates if specified string contains unary operation + at the specified position. + + Formula string. + Index of unary operation. + Returns true if operation is unary, false otherwise. + + + + Checks whether the specified string contains operation at the specified position. + + Formula string. + Index of operation symbol in the string. + Operation index. + True if operation is in specified location. + + + + Checks whether specified operand is a function call. + + Operand that will be checked. + Position of the opening bracket. + True if operand denotes function call, False otherwise. + + + + Gets string representing error name that started from errorIndex. + + Formula string that contains error name. + Index of the first char of the error. + + String representing error name that started from errorIndex. + + + When starting symbol of the possible error is not '#' + or if can't find such error name. + + + + + + + + + + + + + + Returns index of the token that should be used at + position i by type targetType in function call. + + Target type for which index will be searched. + + Dictionary with indexes. + Position of the function parameter. + Parse options. + Index of the token code. + + + + Creates new Ptg and sets offset to point just after its data. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + Parsed Ptg token. + + When data array is smaller than token that should be stored in it. + + + + + Creates formula token using token code. + + Token code. + Newly created token. + + + + Creates formula token using token code. + + Token code that is used to get constructor and as constructor argument as well. + Newly created token. + + + + Creates token using token id and string representing this token. + + Token id of the token that should be created. + String that will be passed to the token constructor. + Newly created token. + + + + Creates token using token code, token string, and parent workbook. + + Code of the new token. + String representation of the token. + Parent workbook. + Newly created token. + + + + Creates specified token, passes specified parameters to its constructor. + + Code of the token that will be created. + Constructor parameters. + Newly created token. + + + + Creates specified token, passes two integers to its constructor. + + Token to create. + First integer argument. + Second integer argument. + Newly created token. + + + + Creates specified token, passes function index to its constructor. + + Token to create. + Function index. + Newly created token. + + + + Creates token using two string values. + + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + Token to create. + First value. + Second value. + Indicates whether R1C1 notation is used. + Created formula token. + + + + Creates token using two string values. + + Token to create. + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + First value. + Second value. + Third value. + Fourth value. + Indicates whether R1C1 notation is used. + Parent workbook. + Created formula token. + + + + Creates token using two string values. + + Token to create. + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + Worksheet reference index. + First value. + Second value. + Third value. + Fourth value. + Indicates whether R1C1 notation is used. + Parent workbook. + Created formula token. + + + + Removes tokens that are unnecessary. + + + + + + + Puts all right sided unary operations before operand. + + Formula to transform. + Formula after transformation. + + + + Registers function in internal collections. + + + Name of the function that must be registered. + + + Index of the function that must be registered. + + + Array of ReferenceIndexAttribute that contains information + about proper token index. + + + Number of parameters in the function, + -1, for variable parameters. + + + + + Indicates whether specified function is supported just in Excel office 365. + + Function id. + Value indicating whether specified function appeared in Excel office 365. + + + + Indicates whether specified function is supported just in Excel 2016. + + Function id. + Value indicating whether specified function appeared in Excel 2016. + + + + Indicates whether specified function is supported just in Excel 2013. + + Function id. + Value indicating whether specified function appeared in Excel 2013. + + + + Indicates whether specified function is supported just in Excel 2010. + + Function id. + Value indicating whether specified function appeared in Excel 2010. + + + + Indicates whether specified function is supported just in Excel 2007. + + Function id. + Value indicating whether specified function appeared in Excel 2007. + + + + Checks whether any of these tokens has external reference. + + + + + + + Get or set indicates whether the lambda function have the last argument count or not. + + + + + Get the formula parser. + + + + + Event handler that will receive array of Ptg after parsing. + + + + + Returns IDictionary error code - to - name. Read-only. + + + + + Returns IDictionary error name - to - error code. Read-only. + + + + + Returns array row separator. Read-only. + + + + + Returns operands separator. Read-only. + + + + + Gets or sets number format for parsing double value. + + + + + + + + + + Constructor id. + + + + + This class is used in the construction of formula tokens. + + + + + Dictionary key (int) - constructor id, value - ConstructorInfo. + + + + + Token class for which this instance was created. + + + + + Token class for which this instance was created. + + + + + Creates class instance for specified type. + + + Type for which an object will be created. Must be inherited from Ptg class. + + + When specified type is not inherited from Ptg class. + + + When specified type is null. + + + + + Creates token using default constructor. + + Newly created token. + + + + Creates token using string parameter. + + Token type to pass to constructor. + Newly created token. + + + + Creates token using string parameter. + + + String parameter that will be passed to constructor. + + Newly created token. + + + + Creates token using array of bytes and offset + where token data begins. + + Object that provides access to the data. + Offset to the token data. + Arguments required by some parse methods. + Newly created token + + + + This method looks for constructor that takes specified + parameters and invokes it. + + + Parameters that will be passed to the constructor. + + Newly created token. + + + + Creates token using string and parent workbook. + + String representation of the token. + Parent workbook. + Created formula token. + + + + Creates token using two integer values. + + First value. + Second value. + Created formula token. + + + + Creates token using function index. + + Function index. + Created formula token. + + + + Creates token using two string values. + + Row index of the cell that contains new token. + Column index of the cell that contains new token. + First value. + Second value. + Indicates whether R1C1 notation is used. + Created formula token. + + + + Creates token using two string values. + + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + First value. + Second value. + Third value. + Fourth value. + Indicates whether R1C1 notation is used. + Parent workbook. + Created formula token. + + + + Creates token using two string values. + + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + Worksheet reference index. + First value. + Second value. + Third value. + Fourth value. + Indicates whether R1C1 notation is used. + Parent workbook. + Created formula token. + + + + Gets constructor. + + Constructor id. + Constructor with specified id. + + + + Sets constructor. + + Constructor id. + Corresponding ConstructorInfo. + + + + Gets / sets default constructor. + + + + + Gets / sets string constructor. + + + + + Gets / sets ByteArrayOffset constructor. + + + + + Gets / sets StringParent constructor. + + + + + Gets / sets TwoInts constructor. + + + + + Gets / sets FunctionIndex constructor. + + + + + Gets / sets constructor that accepts two strings as arguments. + + + + + Gets / sets constructor that accepts four strings as arguments. + + + + + Gets / sets constructor that accepts three ints, four strings + and a bool as arguments. + + + + + Gets / sets constructor that accepts three ints, four strings + and a bool as arguments. + + + + + This class is used when formula value needs to be + evaluated. Provides range that contains formula that should + be evaluated and Ptg array - parsed formula string. + + + + + Range that raised this event. Read-only. + + + + + Ptg array with formula tokens of the range. + + + + + Default constructor. + + + + + Main constructor. + + Range containing formula. + Formula tokens array. + + + + Range that raised this event. Read-only. + + + + + Ptg array with formula tokens of the range. + + + + + Empty arguments (all properties with default values). Read-only. + + + + + + Delegate that can be used for formula evaluation purposes. + + + + + Summary description for GradientWrapper. + + + + + Wrapped shape fill. + + + + + Creates new gradient wrapper. + + + + + Creates new gradient wrapper. + + Gradient to wrap. + + + + Compares with shape fill impl. + + Shape fill to compare with. + Zero if shape fills are equal. + + + + Sets the specified fill to a two-color gradient. + + + + + Sets the specified fill with style to a two-color gradient. + + Represents shading shading style. + Represents shading variant. + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Validates whether gradient variant is correct for current gradient style. + + Gradient variant to validate. + + + + Represents background color object. + + + + + Represents background color. + + + + + Represents background color index. + + + + + Represents foreground color object. + + + + + Represents foreground color. + + + + + Represents foreground color index. + + + + + + + + + + Represents gradient shading style. + + + + + Returns wrapped gradient. Read-only. + + + + + Event raised after wrapped font changed. + + + + + Summary description for GradientArrayWrapper. + + + + + Array that contains all cells of the range. + + + + + Create new instance of object. + + Base range. + + + + Compares with shape fill impl. + + Gradient to compare with. + Zero if shape fills are equal. + + + + Sets the specified fill to a two-color gradient. + + + + + Sets the specified fill to a two-color gradient. + + Represents shading shading style. + Represents shading variant. + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Represents background color. + + + + + Represents background color. + + + + + Represents background color index. + + + + + Represents foreground color. + + + + + Represents foreground color. + + + + + Represents foreground color index. + + + + + Represents gradient shading style. + + + + + Represents gradient shading variant. + + + + + This class is used to get header / footer shapes from a worksheet. + + + + + This interface is used to get shapes from worksheet. + + + + + Returns a shape collection from the worksheet. + + Worksheet to return sheet data for. + A shape collection from the worksheet. + + + + Default constructor. + + + + + Returns a shape collection from the worksheet. + + Worksheet to return sheet data for. + A shape collection from the worksheet. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Engine for parsing and creation of header/footer strings. + + + + + Represents rich text string in the workbook. + + + + + Zero character. + + + + + Low level text object. + + + + + Represents the RTF string + + + + + Parent workbook. + + + + + Indicates whether string is read-only. + + + + + Represents the parent RTF object. + + + + + All digits without zero. + + + + + + + + + + Default font index. + + + + + Cell index. + + + + + Number format type. + + + + ListStyles + + + Level style properties list + + + + Default style level index. + + + + + Bullet + + + + + Initializes new instance of the RichTextString. + + Application object for the RichTextString. + Parent object for the RichTextString. + + + + Initializes new instance of the RichTextString. + + Application object for the RichTextString. + Parent object for the RichTextString. + Indicates whether string is read-only. + + + + Initializes new instance of the RichTextString. + + Application object for the RichTextString. + Parent object for the RichTextString. + Indicates whether string is read-only. + Indicates whether to create inner TextWithFormat. + + + + Initializes new instance of the RichTextString. + + Application object for the RichTextString. + Parent object for the RichTextString. + Indicates whether string is read-only. + Indicates whether to create inner TextWithFormat. + + + + Initializes new instance of the RichTextString. + + Application object for the RichTextString. + Parent object for the RichTextString. + Indicates whether string is read-only. + >Indicates whether to create inner TextWithFormat. + Logger information for AutoShapes + + + + Initializes new instance of the RichTextString. + + Application object for the RichTextString. + Parent object for the RichTextString. + Text to wrap. + + + + Searches for all necessary parent objects. + + + + + Returns font which is applied to character at the specified position. + + Character index. + Font which is applied to character at the specified position. + + + + Returns font which is applied to character at the specified position. + + Character index. + Font which is applied to character at the specified position. + + + + Sets font for range of characters. + + First character of the range. + Last character of the range. + Font to set. + + + + Clears string formatting. + + + + + Appends rich text string with specified text and font. + + Text to append. + Font to use. + + + + Sub string + + + + + + + Appends the text. + + text to append. + + + + Updates the RTF font. + + + + + Returns font index at the specified position. + + Character index. + Font index. + + + + Returns font by its index. + + Font index. + Font that corresponds to the specified index. + + + + This method is called before any changes made to the rich text string. + + + + + This method is called after any changes made to the rich text string. + + + + + Copies data from another rich text string. + + String to copy data from. + Dictionary with updated font indexes. + + + + Parse rich text string. + + TextWithFormat to parse. + Dictionary with updated font indexes. + Parse options. + + + + Creates a copy of the current object. + + Parent object for the new object. + A copy of the current object. + + + + Clears string and formatting. + + + + + Adds font to all required collections.. + + Font to add. + Font index in the collection. + + + + Sets internal text object that stores rtf string. + + New value for the text object. + + + + Returns font which is applied to character at the specified position. + + Character index. + Font which is applied to character at the specified position. + + + + Returns size of the string part. + + Start position. + End position. + Size of the string part. + + + + Generates text in rtf format. + + Generated text. + + + + Generates text in rtf format. + + Generated text. + + + + Writes formatting run with corresponding text into writer. + + Writer to write text and formatting into. + Index of the formatting run. + First character in the text range. + End position of the text range. + + + + Writes formatting run with corresponding text into writer. + + Writer to write text and formatting into. + Index of the formatting run. + First character in the text range. + End position of the text range. + + + + Adds all used fonts to the rtf text writer. + + RtfTextWriter to write into. + + + + Adds all used fonts to the rtf text writer. + + RtfTextWriter to write into. + + + + Adds single font to the fonts table. + + Font to add. + RtfTextWriter to write into. + + + + Writes text into RtfTextWriter. + + RtfTextWriter to write into. + Font index. + Text value. + + + + Writes text into RtfTextWriter. + + RtfTextWriter to write into. + Font index. + Text value. + + + + Preparing HTML format based on styles in the cell. + + Font styles of current cell. + Current cell range. + + + + + To set the style based on the text. + + Frist Rich-text. + Next Rich-text. + Font style. + Current cell range. + + + + + To set the style based on the text. + + Frist Rich-text. + Next Rich-text. + Font style. + Current cell range. + + + + + Update the special characters in html string + + Display text. + Display text. + + + + Gets / sets text of the string. + + + + + Returns text in rtf format. Read-only. + + + + + Indicates whether rich text string has formatting runs. Read-only. + + + + + Returns parent object. Read-only. + + + + + Returns parent application object. Read-only. + + + + + Specifies the default style level to be used. + + + + + Contains the Level styles + + + + + List of Level style properties. + + + + + Cell index. + + + + + Returns size of the string. Read-only. + + + + + Returns default font. Read-only. + + + + + Returns text object. Read-only. + + + + + Returns parent workbook. Read-only. + + + + + Gets / sets default font index. + + + + + Gets or sets the image RTF. + + The image RTF. + + + + Cell index. + + + + + Specifies the bullet format + + + + + Engine for parsing and creation of header/footer strings. + + + + + Parses text of header/footer part. + + Text of header/footer part. + + + + Returns string in format that is supported by Excel header/footer. + + String in format that is supported by Excel header/footer. + + + + Ampersand character. + + + + + Character that indicates start or end of the underline block. + + + + + Character that indicates start or end of the double underline block. + + + + + Character that indicates start or end of the underline block. + + + + + Character that indicates start or end of the underline block. + + + + + Character that indicates start or end of the underline block. + + + + + Character that indicates start or end of the underline block. + + + + + Separator between font style and face name. + + + + + Value of Bold font style. + + + + + Value of Italic font style. + + + + + Regular font style. + + + + + Space character. + + + + + List with all used fonts. + + + + + Initializes new instance of the RichTextString. + + Application object for the RichTextString. + Parent object for the RichTextString. + + + + Parses text of header/footer part. + + Text of header/footer part. + + + + Returns string in format that is supported by Excel header/footer. + + String in format that is supported by Excel header/footer. + + + + Processes next character after ampersand. + + String to parse. + Builder with current text block. + Character position. + Font of the current text block. + + + + Adds text block to the rtf string. + + Text to add. + Font of the text block. + + + + Adds font to the inner fonts array. + + Font to add. + Index of the added font. + + + + Updates font settings. + + Font to update. + String representation of the font to set. + + + + Searches for required font. + + Font name to look for. + Font style. + + + + This function is used for font enumeration. It is called by EnumFontFamiliesEx function. + + Logical-font data. + Physical-font data. + Type of font. + application-defined data. + 0 when required font was found. + + + + Copies font settings from native .Net font into XlsIO font. + + Source font. + Destination font. + + + + Writes text block. + + String builder to write into. + Start position (included). + End position (not included). + + + + Writes font difference into StringBuilder in header/footer format. + + Builder to write difference into. + Previous font to compare. + Current font to compare. + + + + Writes font name if necessary. + + Builder to write font name settings into. + Previous font to compare. + Font to get settings from. + + + + Writes font underline settings if necessary. + + Builder to write font name settings into. + Previous font to compare. + Font to get settings from. + + + + Writes font superscript/subscript settings if necessary. + + Builder to write font name settings into. + Previous font to compare. + Font to get settings from. + + + + Writes font strikeout settings if necessary. + + Builder to write font name settings into. + Previous font to compare. + Font to get settings from. + + + + Writes font size settings if necessary. + + Builder to write font name settings into. + Previous font to compare. + Font to get settings from. + + + + Returns font by its index. + + Font index. + Font that corresponds to the specified index. + + + + Clears string and formatting. + + + + + This method is called after each change in rich text string. + + + + + Contains data used for font locating. + + + + + Font style to locate. + + + + + Located font data. + + + + + This class contains information about Horizontal Page Break. + + + + + Represents a horizontal page break. The HPageBreak object is + a member of the HPageBreaks collection. + + + + + Used without an object qualifier, this property returns an + object that represents the Excel . + + The following code illustrates how to access the property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + //Get Page break with corresponding row + IHPageBreak hPageBrk = sheet.HPageBreaks.GetPageBreak(5); + + //Property returns an Application object that represents the Microsoft Excel application + IApplication hPageBreakApplication = hPageBrk.Application; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + For the HPageBreak and VPageBreak objects, this property returns or sets + the cell (a Range object) that defines the page-break location. Horizontal + page breaks are aligned with the top edge of the location cell; vertical + page breaks are aligned with the left edge of the location cell. + Read / write . + + + To know more about page setting refer this link. + + The following code illustrates the use of Location property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + //Get Page break with corresponding row + IHPageBreak hPageBrk = sheet.HPageBreaks.GetPageBreak(5); + + //Get the IRange Location + IRange range = hPageBrk.Location; + + //Set the IRange Location + hPageBrk.Location = sheet.Range["F1:S10"]; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Returns the parent object for the specified object. + + The following code illustrates the use of Parent property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + //Get Page break with corresponding row + IHPageBreak hPageBrk = sheet.HPageBreaks.GetPageBreak(5); + + //The parent object for the specified object + object hPageBreakParent = hPageBrk.Parent; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Page break extent. + + + + + Type of the page break. + + + + + Record with horizontal page break. + + + + + Parent worksheet. + + + + + Creates page break and sets its Application and Parent + properties to the specified value. + + Application object for the new page break. + Parent object for the new page break. + + + + Recovers page break from the stream.Since there is no corresponding Biff Record, + this constructor should not be used. + + Application object for the new page break. + Parent object for the new page break. + + + + + Constructs page break using application, parent object, and THPageBreak object. + Always creates manual page break. + + Application object for the page break. + Parent object for the page break. + THPageBreak for create instance. + + + + Constructs page break + + + Application object for the page break. + Page break location. + + + + + + + + + Clones current instance. + + Parent for new instance. + A clone of the current instance. + + + + Read-only. Returns page break extent. + + + + + Location of the page break. + + + + + Type of the page break. + + + + + + + + + + Returns zero-based row index of the break location. Read-only. + + + + + Represents hyperlink object. + + + + + Represents a hyperlink. + + + + + Returns or sets the address of the target document. + + + + + Returns a name of the object. + + + + + Returns a Range object that represents the range the specified hyperlink is attached to. + + + + + Returns or sets the ScreenTip text for the specified hyperlink. + + + + + Returns or sets the location within the document associated with the hyperlink. + + + + + Returns or sets the text to be displayed for the specified hyperlink. + The default value is the address of the hyperlink. + + + + + Returns or sets the object type. + + + + + Get object that represents the shape for the hyperlink. + + + + + Represents the hyperlink attached object name. + + + + + Style for hyperlink. + + + + + Hyper link record. + + + + + Tool tip. + + + + + Parent worksheet. + + + + + Range object that represents the range the specified hyperlink is attached to. + + + + + Get object that represents the shape for the hyperlink. + + + + + Represent the hyperlink applied object name. + + + + + Creates an object and sets its Application and Parent + properties to specified values. + + Application object for the hyperlink. + Parent object for the hyperlink. + + + + Recover hyperlink from Biff records. + + Application object for the hyperlink. + Parent object for the hyperlink. + Array of BiffRecordRaws that contains hyperlink records. + Position of the first hyperlink record. + + + + Creates an object and sets its Application, Parent and Range + properties to specified values. + + Application object for the hyperlink. + Parent object for the hyperlink. + + Range object that represents the range the specified hyperlink is attached to. + + + + + Creates an object and sets its Application, Parent and shape + properties to specified values. + + Application object for the hyperlink. + Parent object for the hyperlink. + + Shape object that represents the shape the specified hyperlink is attached to. + + + + + Searches for all necessary parent objects. + + + + + Recovers hyperlink from array of Biff Records and position in it. + + Array of BiffRecordRaws that contains hyperlink records. + Position of the first hyperlink record. + Position after the last hyperlink record. + + + + Saves hyperlink into OffsetArrayList. + + + OffsetArrayList that will receive all records of the range. + + + + + Sets sub address property. + + Sub address to set. + + + + Sets address property. + + Address to set. + Indicates whether we should set Text property of + the TopLeft cell with this hyperlink. + + + + Clears the hyperlink + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Returns or sets the address of the target document. + + + + + Returns or sets the name of the object. + + + + + Returns/sets a Range object that represents the range the specified hyperlink is attached to. + + + + + Returns or sets the ScreenTip text for the specified hyperlink. + + + + + Returns or sets the location within the document associated with the hyperlink. + + + + + Returns or sets the text to be displayed for the specified hyperlink. + The default value is the address of the hyperlink. + + + + + Returns or sets the object type. + + + + + + + + + + + + + + + + + + + + + + + + + Returns a shape object that specified hyperlink is attached to. + + + + + Represent the hyperlink attached object name. + + + + + Returns top left cell of the range. Read-only. + + + + + Represents a set of icons that are used in an icon set conditional formatting rule. + + + + + Gets collection which represents the set of criteria for + icon set conditional formatting rule. + + + Similar to IconSet conditions DataBars also use objects to set and . + To know more about advanced conditional formatting types refer this link. + + + The objects in the property list sets rules that how the icons should be applied. + Default IconSet has only three icons, so the list will have three objects of type + by default. If we change it to an IconSet which has more icons like then the list size increases to five. + Here for example, we access the default objects in the property list and set , + and properties. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "IconSets"; + worksheet["A2"].Number = 105; + worksheet["A3"].Number = 120; + worksheet["A4"].Number = 300; + worksheet["A5"].Number = 240; + worksheet["A6"].Number = 350; + worksheet["A7"].Number = 460; + worksheet["A8"].Number = 170; + worksheet["A9"].Number = 280; + worksheet["A10"].Number = 190; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as IconSet. + format.FormatType = ExcelCFType.IconSet; + IIconSet iconSet = format.IconSet; + + //Set conditions for IconCriteria. + iconSet.IconCriteria[1].Type = ConditionValueType.Percentile; + iconSet.IconCriteria[1].Value = "20"; + iconSet.IconCriteria[1].Operator = ConditionalFormatOperator.GreaterThan; + + iconSet.IconCriteria[2].Type = ConditionValueType.Percentile; + iconSet.IconCriteria[2].Value = "70"; + iconSet.IconCriteria[2].Operator = ConditionalFormatOperator.GreaterThan; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the type of the icon set conditional formatting. + + + To know more about advanced conditional formatting type refer this link. + + + By default will be applied when IconSet is applied. The default is . + From the name we can say has 3 icons, So the values in the cells are set icons based on their percentage ranges 0 to 33, 33 to 67 and 67 to 100. + where 100 is the maximum value in the conditional formatting range. + Here for example, we load 10 values and apply conditional formatting of as . + we set to property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "IconSets"; + worksheet["A2"].Number = 105; + worksheet["A3"].Number = 120; + worksheet["A4"].Number = 300; + worksheet["A5"].Number = 240; + worksheet["A6"].Number = 350; + worksheet["A7"].Number = 460; + worksheet["A8"].Number = 170; + worksheet["A9"].Number = 280; + worksheet["A10"].Number = 190; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as IconSet. + format.FormatType = ExcelCFType.IconSet; + IIconSet iconSet = format.IconSet; + + //Set IconSet. + iconSet.IconSet = ExcelIconSetType.ThreeFlags; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating if the thresholds for an icon + set conditional format are determined using percentiles. Default value is false. + + + To change the IconSet criteria to apply icons based on the percentile value of the value present in the cells, we can set + property to "True". By default it is set to "False" and the conditions are applied based on percentage values instead of percentile. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "IconSets"; + worksheet["A2"].Number = 105; + worksheet["A3"].Number = 120; + worksheet["A4"].Number = 300; + worksheet["A5"].Number = 240; + worksheet["A6"].Number = 350; + worksheet["A7"].Number = 460; + worksheet["A8"].Number = 170; + worksheet["A9"].Number = 280; + worksheet["A10"].Number = 190; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as IconSet. + format.FormatType = ExcelCFType.IconSet; + IIconSet iconSet = format.IconSet; + + //Set PercentileValues. + iconSet.PercentileValues = true; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating if the order of icons are + reversed for an icon set. Default value is false. + + + To know more about advanced conditional formatting types refer this link. + + + The icons in the IconSet will be applied in a predefined way (from lowest value to highest). This order of applying icons can be reversed setting + property to "True". By default the ReverseOrder property is set to "False". Here for in our example, we set it + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "IconSets"; + worksheet["A2"].Number = 105; + worksheet["A3"].Number = 120; + worksheet["A4"].Number = 300; + worksheet["A5"].Number = 240; + worksheet["A6"].Number = 350; + worksheet["A7"].Number = 460; + worksheet["A8"].Number = 170; + worksheet["A9"].Number = 280; + worksheet["A10"].Number = 190; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as IconSet. + format.FormatType = ExcelCFType.IconSet; + IIconSet iconSet = format.IconSet; + + //Set Order of IconSets. + iconSet.ReverseOrder = true; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets a Boolean value indicating if only the icon is displayed + for an icon set conditional format. Default value is false. + + + To know more about advanced conditional formatting types refer this link. + + + If IconSet is applied then the values in the cells will be shown along with an icon. The values can be made hidden by setting + to "True". + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Load data to Apply Conditional Formatting. + worksheet["A1"].Text = "IconSets"; + worksheet["A2"].Number = 105; + worksheet["A3"].Number = 120; + worksheet["A4"].Number = 300; + worksheet["A5"].Number = 240; + worksheet["A6"].Number = 350; + worksheet["A7"].Number = 460; + worksheet["A8"].Number = 170; + worksheet["A9"].Number = 280; + worksheet["A10"].Number = 190; + worksheet["A11"].Number = 100; + + //Create instance of IConditonalFormat and IConditionalFormats. + IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats; + IConditionalFormat format = formats.AddCondition(); + + //Set FormatType as IconSet. + format.FormatType = ExcelCFType.IconSet; + IIconSet iconSet = format.IconSet; + + //Set ShowIconOnly. + iconSet.ShowIconOnly = true; + + //Save and Dispose. + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + } + + + + + + IconSet maintain as stream + + + + + An IconCriteria collection which represents the set of criteria for + an icon set conditional formatting rule. + + + + + An IconSets collection which specifies the icon set used + in the conditional format. + + + + + A Boolean value indicating if the thresholds for an icon + set conditional format are determined using percentiles. + + + + + A Boolean value indicating if the order of icons is + reversed for an icon set. + + + + + A Boolean value indicating if the iconset is custom. + + + + + A Boolean value indicating if only the icon is displayed + for an icon set conditional format. + + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Compares two instances of the IconSetImpl. + + First object to compare. + Second object to compare. + True if objects are equal. + + + + Checks whether objects are different. + + First object to compare. + Second object to compare. + True if objects are not equal. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Updates criteria collection. + + + + + Get or Set the boolean value if the iconset is custom. + + + + + Returns an IconCriteria collection which represents the set of criteria for + an icon set conditional formatting rule. + + + + + Returns or sets an IconSets collection which specifies the icon set used + in the conditional format. + + + + + Returns or sets a Boolean value indicating if the thresholds for an icon + set conditional format are determined using percentiles. + + + + + Returns or sets a Boolean value indicating if the order of icons is + reversed for an icon set. + + + + + Returns or sets a Boolean value indicating if only the icon is displayed + for an icon set conditional format. + + + + + Get as true if the IconSet has a Custom Iconset. + + + + + IconSet Stream + + + + + Parent format. + + + + + Wrapper over condition values. + + + + + Read-only part copy of the criteria collection. + + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Initializes new instance of the wrapper. + + Parent format wrapper. + + + + Updates internal criteria collection. + + Conditions to update. + + + + Adds required number of new wrappers to the criteria collection. + + Number of items to add. + Source collection to wrap. + + + + Updates wrappers inside criteria collection. + + Number of wrappers to update. + + + + Removes wrappers from criteria collection. + + Number of wrappers to remove. + + + + Returns wrapped icon set. + + Wrapped icon set. + + + + Returns an IconCriteria collection which represents the set of criteria for + an icon set conditional formatting rule. + + + + + Returns or sets an IconSets collection which specifies the icon set used + in the conditional format. + + + + + Returns or sets a Boolean value indicating if the thresholds for an icon + set conditional format are determined using percentiles. + + + + + Returns or sets a Boolean value indicating if the order of icons is + reversed for an icon set. + + + + + Returns or sets a Boolean value indicating if only the icon is displayed + for an icon set conditional format. + + + + + Represent the column header import or not. + + + + + + + + + Indicates whether the data table is imported into worksheet. + + + + + Construct data table. + + DataTable with desired data. + Row of the first cell where DataTable should be imported. + Column of the first cell where DataTable should be imported. + style index of date. + + + + Indicates whether the data table is imported into worksheet. + + + + + + + + + Indicating the FieldNameShown or not + + + + + Summary description for GradientWrapper. + + + + + Interface used to get interior settings. + + + + + Gets or sets the color of the interior pattern as an index into the current color palette. + + + + + Gets or sets the color of the interior pattern as an Color value. + + + + + Gets or sets the color of the interior as an index value. + + + + + Gets or sets the cell shading color. + + + + + Gets gradient object for this extended format. Read-only. + + + + + Gets / Sets fill pattern. + + + + + Extended format. + + + + + Gradient wrapper. + + + + + Creates new interior wrapper. + + + + + Creates new interior wrapper. + + Extended format. + + + + Event handler for gradient AfterChange event. + + Event sender. + Event arguments. + + + + Creates gradient wrapper. + + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Gets or sets the color of the interior pattern as an index into the current color palette. + + + + + Gets or sets the color of the interior pattern as an Color value. + + + + + Gets or sets the color of the interior as an index value. + + + + + Gets or sets the cell shading color. + + + + + Gets gradient object for this extended format. Read-only. + + + + + Gets / Sets fill pattern. + + + + + Event raised after wrapped font changed. + + + + + Returns wrapped interior. Read-only. + + + + + Class that is created when user accesses the interior in a multicell range. + Redirects all calls to the interiors of the individual cells. + + + + + Array that contains all cells of the range. + + + + + Create new instance of object. + + Base range. + + + + This method should be called before several updates to the object will take place. + + + + + This method should be called after several updates to the object took place. + + + + + Returns or sets the color of the interior pattern as an index into the current color palette. + + + + + Returns or sets the color of the interior pattern as an Color value. + + + + + Returns or sets the color of the interior. The color is specified as + an index value into the current color palette. + + + + + Returns or sets the cell shading color. + + + + + Returns gradient object. + + + + + Gets / Sets fill pattern. + + + + + This class contains information about all merged + cells in the parent workbook. + + + + + Parent worksheet. + + + + + Contains all not parsed merge records. + + + + + Indicates whether object was parsed. + + + + + Cell range address list of all merged cells. + + + + + Sets application and parent fields. + + Application object for the new instance. + Parent object for the new instance. + + + + Saves merges into OffsetArrayList. + + OffsetArrayList to save all records into. + + + + Searches for all necessary parents. + + + + + Gets array of custom extended formats that represents custom merged range. + + Returns array of Merged extended formats. + + + + Gets extended format describing region. + + Region to get format for. + Extended format describing region. + + + + Adds new merge to the existing merges. + + Range that should be merged. + + Operation type - Information on what needs to be done if some of + the cells are already merged. + + + + + Adds a new region if it intersects with other regions. + If operation is Leave, the function leaves the old region. Otherwise + it deletes old region. + + Region that will be merged. + + Operation type - tells what should be done if some of + the cells are already merged. + + + + + Adds new region if it intersects with other regions. + + First row to merge. Zero-based. + Last row to merge. Zero-based. + First column to merge. Zero-based. + Last column to merge. Zero-based. + + Operation type - tells what should be done if some of + the cells are already merged. + + + + + Combine merge that contains a specific cell. + + + Range of the cells to be combined. + + + + + Removes merge that contains a specific cell. + + + Range of the cells to be removed. + + + + + Remove the merged region from mergedRegion collection. + + Remove merged region + Cell range + + + + Add merged region to merged region collection. + + New merged region + + + + Clear all merges. + + + + + Adds merge regions from the MergeCellsRecord. + + Record with regions. + + + + Adds merge regions from the MergeCellsRecord. + + + + + Removes row from the collection. + + Row index to remove. + + + + Removes row(s) from the collection. + + Row index to remove. + Number of rows to remove. + + + + Inserts row to the collection. + + Row index to insert. + Number of row to insert. + + + + Removes column from the collection + + Column index to remove. + + + + Removes columns from the collection. + + Column index to remove. + Number of columns to remove + + + + Inserts column into collection. + + + + + + Inserts column into collection + + Column index to insert. + Number of columns to insert. + + + + Removes or inserts one row from merges collection. + + One-based row index to remove or insert. + Indicates whether to remove or insert rows. + Count of row to remove. + + + + Removes or inserts one column from merges collection. + + One-based column index to remove. + Indicates whether to remove or insert rows. + Number of columns to insert or remove. + + + + Moves merges from source range into destination. + + Destination range. + Source range. + Indicates whether we are moving merges (true) or copying (false). + + + + Copy merges to source range to destination. + + Destination range + Source range + Source range merged region + + + + Finds all merged ranges for specific range. + + Range to find merges in. + Indicates whether delete merges from the collection is needed or not. + Merges list. + + + + Caches range's merges. + + Range for which we have to cache merged regions. + List to save merges in. + + + + Caches range's merges. + + Range for which we have to cache merged regions. + List to save merges in. + + + + Checks whether specified region is fully inside range. + + Region to check. + Range to check. + + + + Removes all cached items from this collection. + + Cached items to remove. + + + + Adds cache into collection. + + List with merge regions to add. + Row delta. + Column delta. + + + + Adds dictionary with that describes merge region to the collection. + + + Regions to add, key - top-left cell index, value - bottom-right cell index. + + Row delta. + Column delta. + + + + Finds left top cell of merged region. + + Merged region rectangle. + Left top cell range. + + + + Creates a copy of the current object. + + Parent object for the new object. + A copy of the current object. + + + + Creates copy of the specified list. + + List to clone. + A copy of the specified list. + + + + Sets new dimensions - removes unnecessary items (that are out of bounds) or truncates them. + + New maximum possible row count. + New maximum possible column count. + + + + Finds merged region for specific cell. + + Cell range address. + Merged region that includes specified cell. + + + + Converts rectangle to merged region. + + Rectangle to convert. + Merged region. + + + + Inserts or removes row into the merge region before first row. + + Region to modify after insert/remove row operation. + Indicates whether it is remove operation. + Row index. + Number of rows to insert. + Workbook where operation is performed. + Modified region. + + + + Inserts or removes row into region the merge at the first row. + + Region to modify after insert/remove row operation. + Indicates whether it is remove operation. + Number of rows to insert. + Workbook where operation is performed. + Modified region. + + + + Inserts or removes row into the merge region in the middle or at the end of the range. + + Region to modify after insert/remove row operation. + Indicates whether it is remove operation. + Row index. + Number of rows to insert. + Workbook where operation is performed. + Modified region. + + + + Inserts or removes row after end of the region. + + Region to modify after insert/remove row operation. + Indicates whether it is remove operation. + Number of rows to insert. + Modified region. + + + + Inserts or removes row. + + Region to modify after insert/remove row operation. + Row index. + Indicates whether it is remove operation. + Number of rows to insert. + Workbook where operation is performed. + + + + + Inserts or removes column into the merge region before first column. + + Region to modify after insert/remove column operation. + Indicates whether it is remove operation. + Column index. + Number of columns to insert. + Workbook where operation is performed. + Modified region. + + + + Inserts or removes column into the merge region at the first column. + + Region to modify after insert/remove column operation. + Indicates whether it is remove operation. + Number of columns to insert. + Workbook where operation is performed. + Modified region. + + + + Inserts or removes column into the merge region in the middle or at the end of the range. + + Region to modify after insert/remove column operation. + Indicates whether it is remove operation. + Column index. + Number of columns to insert. + Workbook where operation is performed. + Modified region. + + + + Inserts or removes column after end of the region. + + Region to modify after insert/remove column operation. + Indicates whether it is remove operation. + Number of columns to insert. + Modified region. + + + + + + Region to modify after insert/remove column operation. + Column index. + Indicates whether it is remove operation. + Number of columns to insert. + Workbook where operation is performed. + Modified region. + + + + Ensures that row index is in correct range. + + Row index to check. + Workbook where operation is performed. + Row index from the correct range. + + + + Ensures that column index is in correct range. + + Column index to check. + Workbook where operation is performed. + Column index from the correct range. + + + + Number of merges in the collection. + + + + + Collection of all merged regions. + + + + + Returns single merge region from the collection. + + + + + Summary description for MigrantRangeImpl. + + + + + Represents a cell, a row, a column, collection of cells or a 3-D range. + + + + + + + + + + Row zero-based index. + + + + + Column zero-based index. + + + + + Index of extended format. + + + + + Returns type code. Read-only. + + + + + Default format for date values. + + + + + Default format for time values. + + + + + Default format for date time values. + + + + + Default date time index. + + + + + Default OleDateValue + + + + + Maximum OleDateValue + + + + + Default format for number values. + + + + + Default format for text values. + + + + + General format. + + + + + Format for array-entered formula representation. + + + + + Error message when method that should be called only for single-cell Ranges + was called for Range with multiple cells. + + + + + Default style. + + + + + Index of extended format for normal style. + + + + + Default format for WrapText values. + + + + + Whitspace for the numberformat. + + + + + Open brace for formula. + + + + + Equivalent symbol for formula. + + + + + Ampersand symbol for formula. + + + + + Represents default cell name separator. + + + + + Column section start in the R1C1 reference string. + + + + + Row section start in the R1C1 reference string. + + + + + Opening bracket for relative row / column index in the R1C1 reference mode. + + + + + Closing bracket for relative row / column index in the R1C1 reference mode. + + + + + Local address format in R1C1-style notation. + + + + + Maximum OADate value. + + + + + Represents default number format index. + + + + + Represents first number format index. + + + + + Represents second number format index. + + + + + Number of bits in cell index that holds column value. + + + + + Defines whether to set XF index in SetFormulaArrayRecord method. + + + + + Defines the singleQuote. + + + + + Defines a new line character + + + + + Default percentage number format . + + + + + Default decimal percentage number format . + + + + + Default exponential number format . + + + + + Default culture info time token + + + + + Default time token number format . + + + + + Default regular expressions options: + + + + + Represents the UK culture Name. + + + + + Cell types that can contain date time values. + + + + + Represents auto format types, that contain right horizontal alignment. + + + + + Represents auto format types, that contain number format. + + + + + Minimum supported date time value. + + + + + Minimum supported date time value. + + + + + Represents the list of date time formula. + + + + + Represents the default date separator for all cultures. + + + + + Regular expression for minutes part of the format: + + + + + Regular expression for minutes part of the format: + + + + + Regular expression for minutes part of the format: + + + + + Initilize object for HtmlStringParser. + + + + + Reference on worksheet to which current Range belongs to. + + + + + Reference on workbook to which worksheet and current Range belong to. + + + + + Index of the left column. + + + + + Index of the right column. + + + + + Index of the top row. + + + + + Index of the bottom row. + + + + + + + + + + + + + + + + + + + + This array stores references of all cells that this + Range represents. + + + + + Style wrapper for this Range. + + + + + True - indicates that cells collection was filled before, otherwise False. + + + + + Represents data validation. + + + + + Defines a date separator of current culture + + + + + Defines a time separator of current culture + + + + + Represents RTF string. + + + + + True if it is Entire row. + + + + + True if it is Entire column. + + + + + False if Number format is set in run time + + + + + Represents the OutlineWrapperUtility object + + + + + Number of subtotal in a specific Range + + + + + Indicates whether the range indexer is absolute or relative. + + + + + Indicates whether the row height calculated or not. + + + + + String format for the text to be measured in UpdateText method. + + + + + A boolean variable that indicates if display text of this range is called from AutoFitColumns(). + + + + + A boolean variable indicates if the separator is in CSV format. + + + + + Get DateTime based on culture + + Display text. + The cell value. + The format impl. + + + + + + Checks the OS specific formats. + + The inner number format. + + + + + Create style for Entire row or Entire column. + + + + + Checks if all formula arrays partially contained by this Range + or fully contained by this Range. Read-only. + + Collection of array formula records. + Value indicating whether all formula arrays partially contained by this Range. + + + + Returns number from the style name, i.e. Normal_1 result is 1. + + Style name. + Parsed number. + A boolean indicating whether the 1904 date system is used. + A string representing the formatted date. + + + + Formats a DateTime object into a string based on the specified format, determining whether it is a time or date. + + A double representing the original serial date number. + A DateTime object representing the date and time to format. + A FormatImpl object representing the desired format. + A boolean indicating whether the value is a time. + A boolean indicating whether the value is a date. + A string representing the formatted date or time. + + + + Returns number from the style name, i.e. Normal_1 result is 1. + + Style name. + Parsed number. + + + + Called after changing last column index. + + + + + Called after changing first column index. + + + + + Called after changing last row index. + + + + + Called after changing first row index. + + + + + Called after changing style of the Range. + + Cell type. + + + + Called after changing of value. + + Old value. + New value. + + + + Converts the value of this instance to the equivalent OLE Automation date. + + Input date time value. + A double-precision floating-point number that contains an OLE Automation date equivalent to the value of this instance. + + + + The specified value is detected for fraction value and set to Value property. + + The value assigned to property. + True if the specified value is a fraction. Otherwise False. + + + + sets the time number format based on value. + + Value to check the time format. + + + + Checks whether first symbol is apostrophe and sets appropriate cell style. + + Value to check. + Updated string value. + + + + Converts object to double if possible. + + Object to convert. + Converted value. + + + + Group or ungroup current Range. + + Should we perform operation on rows or columns? + If True then group, otherwise ungroup. + Indicates whether created group should be collapsed. + This Range after grouping / ungrouping. + + + + Updates the group into collection. + + + + + Adds the row/Ccolumn level into collection. + + + + + Ungroup the row/Column level. + + + + + Returns Row outline from collection. + + One-based row index. + Row information. + + + + Creates subtotals for the Range. + + Column index based on which grouping should be done. + Represents a consolidation function to be applied. + List of column indexes on which subtotal is calculated. + + The following code illustrates how to subtotal the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set the Range for subtotaling + IRange range = worksheet.Range["C3:G12"]; + + //Perform subtotals for the Range with every change in first column + //and subtotals to be included for specified list of columns + range.SubTotal(0, ConsolidationFunction.Sum, new int[] { 2, 3, 4 }); + + workbook.SaveAs("Subtotal.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + + Creates subtotals for the Range with the specified formatting flags. + + Column index based on which grouping should be done + Represents a consolidation function to be applied. + List of column indexes on which subtotal is calculated. + Indicates whether existing SubTotal must be replaced. + Indicates whether page break must be inserted. + Indicates whether SummaryBelowData to be shown + + The following code illustrates how to subtotal the Range with formats. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set the Range for subtotaling + IRange range = worksheet.Range["C3:G12"]; + + //Perform subtotals for the Range with every change in first column + //and subtotals to be included for specified list of columns + range.SubTotal(0, ConsolidationFunction.Sum, new int[] { 2, 3, 4 }, false, true, true); + + workbook.SaveAs("Subtotal.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + + Creates subtotals for the Range with multiple group by columns and the specified formatting flags. + + Column indexes based on which grouping is done. Given in the order of subtotal levels + Represents a consolidation function to be applied. + List of columns on which subtotal is calculated + Replaces Existing SubTotal + Inserts PageBreaks + SummaryBelowData to be shown + + The following code illustrates how to subtotal the Range with formats. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set the Range for subtotaling + IRange range = worksheet.Range["C3:G12"]; + + //Perform subtotals for the Range with every change in first column + //and subtotals to be included for specified list of columns + range.SubTotal( new int[] { 1, 2 }, ConsolidationFunction.Sum, new int[] { 2, 3, 4 }, false, true, true); + + workbook.SaveAs("Subtotal.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + + Update row offset for subtotal process. + + + + + Updates formula after subtotal operation. + + + + + Returns Column from collection. + + One-based column index. + Column information. + + + + Sets dimensions of parent worksheet to fit this Range. + + + + + Sets the workbook. + + The book. + + + + Return outline from the dictionary that corresponds to the specified index, + creates new one if necessary. + + + Indicates whether row outline or column outline + should be returned from the collection. + + Collection of outlines. + Index of the needed outline. + + Indicates whether exeption should be thrown when incorrect index passed + or just return Null value. + + Outline from the collection or newly created one. + + + + Returns display text. + + Value representing displayed string. + + + + Parses the number format. + + + + + + Checks the unnecessary char. + + The split format. + + + + + Returns DataTime value of the record. + + DataTime value of the record. + + + + Fills internal BiffRecord with data from specified DateTime. + + DateTime with Range value. + + + + Fills internal BiffRecord with data from specified DateTime. + + DateTime with Range value. + + + + Returns number value from the cell if possible. + + Stored number. + + + + Fills internal BiffRecord with data from specified number. + + Number with Range value. + + + + Fills internal BiffRecord with data from specified number. + + Number with Range value. + + + + Creates correct record that can store specified number. + + Value to store. + Created record with number. + + + + Fills internal BiffRecord with data with specified boolean value. + + Boolean with Range value. + + + + Fills internal BiffRecord with data with specified error value. + + String with error value. + + + + Gets error code by error string. + + Represents error string. + Returns error code. + + + + Sets formula value to the current Range. + + Formula value. + + + + Sets formula value to the current Range. + + Formula value. + + Dictionary with new worksheet names (to copy worksheet's + into workbook's and merging workbooks). + + Indicates whether R1C1-style notation is used. + + + + Copies formula record. + + Record to copy. + + + + Called after any changes in the Range. + Sets Saved property of the parent workbook to false. + + + + + Checks if specified cell has correct row and column index. + + Index of the row of the cell. + Index of the column of the cell. + + When row or column is less than 1 or column is greater than maximum possible column index + (it is 256 for Excel 2003, and 16384 for Excel 2007). + + + + + Searches for specified worksheet in the parent workbook. + + Name of the worksheet to search. + Found worksheet. + + If there is no such worksheet in the parent workbook. + + + + + Reparses formula. + + + + + Moves cell one row up. + + Options for cell copying. + + + + Moves cell one column left. + + Options for cell copying. + + + + Parses LabelSST record. + + Record to parse. + Parsed string without formatting. + + + + Parses . + + Record to parse. + Parsed string value. + + + + Parses with R1C1ReferenceStyle notation flag. + + Record to parse. + + Indicates whether to return formula string in R1C1-style notation. + + Parsed string value. + + + + Sets row height. + + Value to set. + Indicates whether font and row height are not compatible. + + + + Sets row height. + + Value to set. + Indicates whether font and row height are not compatible. + + + + Creates rich text string. + + + + + Tries to create Value2. + + Value2 value. + + + + Detects whether specified value is error or boolean and tries to parse it. + + String to parse. + True if value type was detected and value was parsed correctly. + + + + Sets index in the LabelSST record. + + New index value. + + + + Tries to remove all formula arrays from this Range. + + + Thrown when it's impossible to remove array formula. + + + + + Sets data validation for the Range. + + Data validation to set. + + + + Blanks cell. + + + + + Adds copy of the comment. + + Comment to be added. + + + + Creates a threaded comment for the current cell with the specified text. + + Threaded comment text + Optional. The creation time of the threaded comment + Returns the created instance of . If the cell already contains comment(note) then threaded comment cannot be inserted and returns null + + The threaded comment created by mapping with author name from built-in document properties + + + The following code illustrates how to add threaded comment with text. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add threaded comment with text + IThreadedComment threadedComment = worksheet["C2"].AddThreadedComment("sample text"); + + //Save and dispose + workbook.SaveAs("ThreadedComments.xlsx"); + workbook.Close(); + } + + + + + + Creates a threaded comment for the current cell with the specified text and author. + + Threaded comment text + The author of the threaded comment text + Optional. The creation time of the threaded comment + Returns the created instance of . If the cell already contains comment(note) then threaded comment cannot be inserted and returns null + + The following code illustrates how to add threaded comment with text and author. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add threaded comment with text and author + IThreadedComment threadedComment = worksheet["C2"].AddThreadedComment("sample text", "User"); + + //Save and dispose + workbook.SaveAs("ThreadedComments.xlsx"); + workbook.Close(); + } + + + + + + Sets new parent. + + Parent to set. + + + + Updates named Ranges indexes. + + New indexes. + + + + Creates record and sets Range data in it. + + Record type to create. + Newly created record. + + + + Creates record and sets Range data in it. + + Record type to create. + Newly created record. + + + + Updates Range. + + First row index. + First column index. + Last row index. + Last column index. + + + + Identifies the Date separator + + returns a date seperator + + + + Identifies the time separator + + Returns a time seperator + + + + Parses R1C1 reference. + + Reference to parse. + Range that corresponds to the string. + + + + Parses R1C1 expression + + String to parse. + Represents rectangle of coordinates. + Indicates is it first expression. + Returns rectangle with updated coordinates. + + + + Parses index string in R1C1 style and evaluates absolute row or column index. + + Value to parse. + Indicates whether this is row or column index. + Parsed row or column index. + + + + Converts array-entered formula to string.. + + Indicates whether R1C1-style notation must be used. + String representation of the array-entered formula. + + + + Sets array-entered formula. + + String representation of the formula. + Indicates whether R1C1-style notation is used. + + + + Sets array formula record. + + Formula array record. + + + + Sets array formula record with extended format index. + + Formula array record. + Extended format index. + + + + Updates record with new position and extended format record if necessary. + + Record to update. + Cell to get data from. + XF index to set. + + + + Normalizes row index. + + One-based row index to normalize. + First column. + Last column. + Normalized row index. + + + + Normalizes row index. + + One-based column index to normalize. + First row. + Last row. + Normalized column index. + + + + Searches for corresponding data validation. + + Found data validation or null. + + + + Partially clear Range. + + + + + Sets border to single cell. + + Represents border index. + Represents border line type. + Represents border line color. + + + + Collapses or expands this group. + + Should we perform operation on rows or columns? + Indicates desired group state. If it is True then group should be collapsed, otherwise expanded. + Flag indicating collapse or expand settings. + + + + Collapses or expands group. + + Indicates whether group is collapsed. + Represents start index. + Represents end index. + Represents maximum index. + Indicates whether last index. + Provides outline information. + Flag for expand or collapse setting. + + + + Sets hidden state. + + Represents starting index. + Represents ending index. + Provides Outline information. + Value indicating whether outline is hidden + + + + Expands outlines. + + Represents starting index. + Represents end index. + Provides outline information. + Value indicating whether to include sub groups + Value indicating whether last index + + + + Determines whether parent outline group is visible or not. + + Start index of the child group. + End index of the child group. + Maximum possible outline index. + Method that is used to get outline by index. + True if parent group is visible. + + + + Searches for the first outline with lower level (parent). + + Start index to search from. + Delta to add to outline index after each iteration (direction). + Maximum possible outline index. + Method that is used to get outline by index. + Found outline index with lower level or -1. + + + + Searches for the edge of the group. + + Start index to search from. + Delta to add to the index at each iteration. + Maximum possible outline index. + Method that is used to get outline by index. + Outline level of the group to find edge for. + Index of the parent group start. + + + + Searches for the first visible outline of the required level. + + Start index to search. + End index to search. + Method that is used to get outline by index. + Outline level to check. + Index of the first found visible outline. + + + + Gets the unique values. + + Type of the field. + Gets the list of unique values. + + + + Gets the formula value. + + Type of the field. + Represents the row to fetch the value. + Represents the column to fetch the value. + if set to true [is string]. + Returns the formula value. + + + + Gets the formula value. + + Type of the field. + Represents the row to fetch the value. + Represents the column to fetch the value. + if set to true [is string]. + Returns the formula value. + + + + Get hatch style for hatch brush. + + Pattern type. + returns Hatchstyle value. + + + + Sets auto format pattern. + + Represents pattern color. + Represents first row. + Represents last row. + Represents first column. + Represents last column. + + + + Sets auto format pattern. + + Represents pattern color. + Represents first row. + Represents last row. + Represents first column. + Represents last column. + Represents pattern color. + Represents cell pattern. + + + + Sets auto format patterns. + + Represents auto format type. + + + + Sets auto format pattern for list_1 or list_2 types. + + Indicates if it is list_1 auto format type. + Represents default fore color. + Represents default back color. + + + + Sets auot format alignment. + + Represents auto format type. + + + + Sets auto format alignment. + + Represents align. + Represents first row. + Represents last row. + Represents first column. + Represents last column. + + + + Sets auto format width height. + + Represents auto format type. + + + + Sets auto format number. + + Represents auto format type. + + + + Sets auto format font border. + + Represents auto format type. + Indicates if set font object. + Indicates if set borders. + + + + Sets auto format simple font border. + + Indicates if set font object. + Indicates if set borders. + + + + Sets auto format Classic_1 font and border. + + Indicates if set font object. + Indicates if set borders. + + + + Sets auto format Classic_2 font and border. + + Indicates if set font object. + Indicates if set borders. + + + + Sets auto format Classic_3 font and border. + + Indicates if set font object. + Indicates if set borders. + + + + Sets auto format Accounting_1 font and border. + + Indicates if set font object. + Indicates if set borders. + + + + Sets auto format Accounting_2 font and border. + + Indicates if set font object. + Indicates if set borders. + + + + Sets auto format Accounting_3 font and border. + + Indicates if set font object. + Indicates if set borders. + + + + Sets auto format Accounting_4 font and border. + + Indicates if set font object. + Indicates if set borders. + + + + Sets auto format font. + + Represents font object. + Represents first row. + Represents last row. + Represents first column. + Represents last column. + + + + Creates an new instances of the class with specified and parent objects. + + Represents application object for the Range. + Represents parent object for the Range. + + The parent worksheet or workbook cannot be found. + + + + + Creates an new instances of the class with specified and Parent objects from stream. + + Application object for the Range. + Parent object for the Range. + Stream with Range data. + + + + Creates an new instances of the class from Biff records from its specified position. + + Application object for the Range. + Parent object for the Range. + Array of BiffRecordRaws which contains record for the Range. + Index of record for the Range. + + + + Creates an new instances of the class from Biff records from its specified position as a reference. + + Application object for the Range. + Parent object for the Range. + + Array of BiffRecordRaws which contains record for the Range. + + Index of record for the Range. + + + + Creates an new instances of the class from Biff records from its specified position with ignore style flag. + + Application object for the Range. + Parent object for the Range. + + Array of BiffRecordRaws which contains record for the Range. + + Index of record for the Range. + Indicates whether to ignore styles. + + + + Creates an new instances of the class from collection of Biff records from its specified position with ignore style flag. + + Application object for the Range. + Parent object for the Range. + Array of BiffRecordRaws which contains record for the Range. + Index of record for the Range. + Indicates whether to ignore styles. + + + + Creates an new instances of the class with specified top-left and bottom-right corners. + + Application object for the Range. + Parent object for the Range. + First row of the Range. + Last row of the Range. + First column of the Range. + Last column of the Range. + + + + Creates an new instances of the class with specified row and column. + + Application object for the Range. + Parent object for the Range. + Row index for the Range. + Column index for the Range. + + + + Creates an new instances of the class with specified ,Parent objects and ignore style flag from stream. + + Application object. + Parent object. + Range record. + Indicates whether to ignore styles. + + + + Fill internal collection by references on cells. + + + + + Clears internal cells array. + + + + + Releases the unmanaged resources used by the XmlReader and optionally releases the managed resources. + + + + + Returns true if the style is a built-in style; otherwise, returns false. + + + + + Searches for all necessary parents. + + + + + Recover Region from the stream. + + BiffReader with Range record. + + + + Recover region from array of Biff Records and position in it. + + Array of BiffRecordRaws that contains Range record. + Position of Range record. + + + + Recover region from array of Biff Records and position in it with ignore style flag. + + Array of BiffRecordRaws that contains Range record. + Position of Range record. + Indicates whether to ignore style. + + + + Parses double value accordingly to format string. + + Value to parse. + Parsed value. + + + + Parses . + + BlankRecord to parse. + Blank string. + + + + Reparses . + + Record to reparse. + + + + Parses FormulaRecord. + + FormulaRecord to parse. + List with Biff records. + Position of formula in the list. + + + + Parses . + + BoolErrRecord to parse. + Extracted BoolError record. + + + + Parses RStringRecord. + + RStringRecord to parse. + Blank string. + + + + Adds listener for the NameXIndexChanged event + if there is NameXPtg in the formula. + + Parsed formula. + Workbook index. + Name index. + Indicates whether event handler should be added. + + + + Attaches handler to NameIndexChanged event. + + Workbook with name. + Event handler. + Parsed formula. + Workbook index. + New index. + Indicates whether event handler should be added. + + + + Attaches index changed event handler to extern name collection. + + Parent workbook. + NamexPtg that identifies named Range. + Workbook index. + NamedRange index to attach to. + Event handler. + Dictionary with indexes of named Range that already have attached event. + Indicates whether event handler should be added. + + + + Attaches index changed event handler to local name collection. + + Parent workbook. + NamePtg that identifies named Range. + Workbook index. + New name index. + Event handler + Dictionary with indexes of named Range that already have attached event. + Indicates whether event handler should be added. + + + + Combines book index and name index into one index. + + Book index. + Name index. + Combined index. + + + + This is handler of the NameIndexChanged event + of the formula contained by the Range + + Sender of the event. + Event arguments. + + + + Handler for named Range index changed event for local named Ranges. + + Event sender. + Event arguments. + + + + Handler for named Range index changed event for external named Ranges. + + Event sender. + Event arguments. + + + + Gets the formula for a range + + Row Index + Column index + Formula string + + + + Activates the cell. + + Returns the active cell. + + The following code illustrates how to activate a Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + // Activates 'F1' cell. + worksheet.Range["F1"].Activate(); + + workbook.SaveAs("Activate.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Activates the cell and its worksheet. + + True to set as top left cell. + Returns the active cell. + + The following code illustrates how to activate a Range with scroll flag. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + // Activates 'F1' cell. + worksheet.Range["F1"].Activate(true); + + workbook.SaveAs("Activate.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Groups the Range by row/column with collapse flag. + + + Represents to expand the group by rows/columns. + + Indicates whether group should be collapsed. + Returns the Range after grouping. + + The following code illustrates how to group the Range with collapse flag. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Group Rows + worksheet.Range["A1:A3"].Group(ExcelGroupBy.ByRows, true); + + //Group Columns + worksheet.Range["A1:B1"].Group(ExcelGroupBy.ByColumns, false); + + workbook.SaveAs("Grouping.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Groups the Range by row/column with collapse flag. + + Represents to expand the group by rows/columns. + Indicates whether group should be collapsed. + Indicates whether group should be collapsed. + Returns the Range after grouping. + + + + Groups the Range by row/column. + + + Represents to expand the group by rows/columns. + + Returns the Range after grouping. + + The following code illustrates how to group the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Group Rows + worksheet.Range["A4:A6"].Group(ExcelGroupBy.ByRows); + + //Group Columns + worksheet.Range["C1:F1"].Group(ExcelGroupBy.ByColumns); + + workbook.SaveAs("Grouping.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets list of value from numeric cells in the range. + + Considers numeric value of date formatted cells. + List of value from numeric cells in the range. + + + + Returns sum of numeric cells in the range. + + + The following code illustrates how to find the sum of numeric cells in the range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set value to cells + worksheet.Range["A1:A3"].Value = "10"; + + //Returns Sum of numeric cells in the range. + double sum = worksheet.Range["A1:A3"].Sum(); + + workbook.SaveAs("Sum.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns sum of numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + The following code illustrates how to find the sum of numeric cells in the range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set value to cells + worksheet.Range["A1:A3"].Value = "10"; + + //Returns Sum of numeric cells in the range. + double sum = worksheet.Range["A1:A3"].Sum(true); + + workbook.SaveAs("Sum.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns average of numeric cells in the range. + + + The following code illustrates how to find the average of numeric cells in the range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set value to cells + worksheet.Range["A1:A3"].Value = "10"; + + //Returns average of numeric cells in the range. + double average = worksheet.Range["A1:A3"].Average(); + + workbook.SaveAs("Average.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns average of numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + The following code illustrates how to find the average of numeric cells in the range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set value to cells + worksheet.Range["A1:A3"].Value = "10"; + + //Returns average of numeric cells in the range. + double average = worksheet.Range["A1:A3"].Average(true); + + workbook.SaveAs("Average.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns minumum value from numeric cells in the range. + + + The following code illustrates how to find the minumum value from numeric cells in the range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set value to cells + worksheet.Range["A1"].Value = "10"; + worksheet.Range["A2"].Value = "20"; + worksheet.Range["A3"].Value = "30"; + + //Returns minumum value from Numeric cells in the given range. + double minimum = worksheet.Range["A1:A3"].Min(); + + workbook.SaveAs("Min.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns minumum value from numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + The following code illustrates how to find the minumum value from numeric cells in the range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set value to cells + worksheet.Range["A1"].Value = "10"; + worksheet.Range["A2"].Value = "20"; + worksheet.Range["A3"].Value = "30"; + + //Returns minumum value from Numeric cells in the range. + double minimum = worksheet.Range["A1:A3"].Min(true); + + workbook.SaveAs("Min.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns maximum value from numeric cells in the range. + + + The following code illustrates how to find the maximum value from numeric cells in the range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set value to cells + worksheet.Range["A1"].Value = "10"; + worksheet.Range["A2"].Value = "20"; + worksheet.Range["A3"].Value = "30"; + + //Returns maximum value from numeric cells in the range. + double maximum = worksheet.Range["A1:A3"].Max(); + + workbook.SaveAs("Max.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns maximum value from numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + The following code illustrates how to find the maximum value from numeric cells in the range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set value to cells + worksheet.Range["A1"].Value = "10"; + worksheet.Range["A2"].Value = "20"; + worksheet.Range["A3"].Value = "30"; + + //Returns maximum value from Numeric cells in the given range. + double maximum = worksheet.Range["A1:A3"].Max(); + + workbook.SaveAs("Max.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Trim the empty rows at top and bottom of the range, the empty columns at left and right of the range. + + Returns the range after trim. + /// + The following code illustrates how to Trim the empty rows at top and bottom of the range, the empty columns at left and right of the range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set value to cells + worksheet.Range["B1"].Value = "10"; + worksheet.Range["B2"].Value = "20"; + worksheet.Range["B3"].Value = "30"; + + //Returns the range after trim the given range. + IRange trim = worksheet.Range["A1:B3"].Trim(); + + workbook.SaveAs("Trim.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Combines the contents of the selected cells in a new larger cell. + + + The following code illustrates how to merge the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Merging cells + worksheet.Range["A16:C16"].Merge(); + + workbook.SaveAs("Merging.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Combines the contents of the selected cells in a new larger cell with clear option flag. + + Clears the Merged cell. + + The following code illustrates how to merge the Range with clear option. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Merging cells + worksheet.Range["A16:C16"].Merge(true); + + workbook.SaveAs("Merging.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Updates the Merged region (clears the conditional formats , data validation and copy the styles) + + + + + Applies the first cell format to rest of the cell; + + + + + Ungroups the Range. + + Represents to expand the group by rows/columns. + Returns the Range after ungrouping. + + The following code illustrates how to ungroup the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Ungroup Rows + worksheet.Range["A1:A3"].Ungroup(ExcelGroupBy.ByRows); + + //Ungroup Columns + worksheet.Range["C1:F1"].Ungroup(ExcelGroupBy.ByColumns); + + workbook.SaveAs("Ungrouping.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Separates merged cells into individual cells. + + + The following code illustrates how to perform merging in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Un-Merging merged cells + worksheet.Range["A16:C16"].UnMerge(); + + workbook.SaveAs("UnMerging.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Keep rows and columns visible in the Range while the rest of the worksheet scrolls. + + + The following code illustrates how to freeze a pane in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Applying Freeze Pane to the sheet by specifying a cell. + sheet.Range["B2"].FreezePanes(); + + workbook.SaveAs("Freeze.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Clears content in the Range. + + + The following code illustrates how to clear the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + // Clears the Range �A4� . + sheet.Range["A4"].Clear(); + + workbook.SaveAs("ClearRange.xlsx"); + workbook.Version = ExcelVersion.Excel2013; + workbook.Close(); + excelEngine.Dispose(); + + + + + + Clears content and formats in the Range. + + True to clear format. + + The following code illustrates how to clear the Range with formats. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + // Clears the Range �A4� and its formatting. + sheet.Range["A4"].Clear(true); + + workbook.SaveAs("ClearRange.xlsx"); + workbook.Version = ExcelVersion.Excel2013; + workbook.Close(); + excelEngine.Dispose(); + + + + + + Clears Range completely. + + + + + Clears the Range and shifts the cells Up or Left. + + Shifts the cells to the specified direction. + + The following code illustrates how to clear the Range with specified direction. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + // Clearing a Range �A4� with move options. + sheet.Range["A4"].Clear(ExcelMoveDirection.MoveLeft); + + workbook.SaveAs("ClearRange.xlsx"); + workbook.Version = ExcelVersion.Excel2013; + workbook.Close(); + excelEngine.Dispose(); + + + + + + Clears the Range with the specified and . + + Shifts the cells to the specified direction. + Copies the cells with the specified copy Range options. + + The following code illustrates how to clear the Range with specified direction and copy Range options. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + // Clearing a Range �A4� with copy Range and move options. + sheet.Range["A4"].Clear(ExcelMoveDirection.MoveLeft,ExcelCopyRangeOptions.All); + + workbook.SaveAs("ClearRange.xlsx"); + workbook.Version = ExcelVersion.Excel2013; + workbook.Close(); + excelEngine.Dispose(); + + + + + + clears the cell formats,comments,contents based on clear option. + + + + + + Clears the Range with the specified . + + Represents the clear options. + + The following code illustrates how to clear the Range with clear options. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + // Clears the Range �A4� with its clear options. + sheet.Range["A4"].Clear(ExcelClearOptions.ClearAll); + + workbook.SaveAs("ClearRange.xlsx"); + workbook.Version = ExcelVersion.Excel2013; + workbook.Close(); + excelEngine.Dispose(); + + + + + + clears the comments of the cell. + + + + + Moves cells to the specified Range (without updating formulas). + + Represents the destination Range to move. + + The following code illustrates how to move the Range. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + // Moving a Range �A1� to �A5�. + IRange source = sheet.Range["A1"]; + IRange destination = sheet.Range["A5"]; + source.MoveTo(destination); + + workbook.Version = ExcelVersion.Excel2013; + workbook.SaveAs("MoveRange.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + + Moves the cells to the specified Range. + + Represents a destination Range. + Specifies the options to update formulas and merged Ranges during copy Range. + + + + Copies the Range to the specified Range (without updating formulas). + + Represents the destination Range to copy. + Returns the copied Range. + + The following code illustrates how to copy the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + // Copying a Range �A1� to �A5�. + IRange source = sheet.Range["A1"]; + IRange destination = sheet.Range["A5"]; + source.CopyTo(destination); + + workbook.Version = ExcelVersion.Excel2013; + workbook.SaveAs("CopyRange.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Copies the Range to the specified destination Range with copy options. + + Represents the destination Range to copy. + Represents if the pasteLinkOptions implement or not . + Returns the copied Range. + + The following code illustrates how to copy the Range with pasteLink options. + + ExcelEngine engine = new ExcelEngine(); + IApplication application = engine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + IRange source = worksheet["A1:D5"]; + IRange destination = worksheet["E10"]; + // Copy range as link from source to destination + source.CopyTo(destination, true); + workbook.Version = ExcelVersion.Excel2013; + workbook.SaveAs("CopyRange.xlsx"); + workbook.Close(); + engine.Dispose(); + + + + + + Copies the Range to the specified destination Range with copy options. + + Represents the destination Range to copy. + Represents the copy Range options. + Returns the copied Range. + + The following code illustrates how to copy the Range with copy options. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + // Copying a Range �A1� to �A5�. + IRange source = sheet.Range["A1"]; + IRange destination = sheet.Range["A5"]; + source.CopyTo(destination, ExcelCopyRangeOptions.All); + workbook.Version = ExcelVersion.Excel2013; + workbook.SaveAs("CopyRange.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Copies the Range to the specified destination Range with copy options and skips copying blank cells in the source. + + Represents the destination Range to copy. + Represents the copy Range options. + Represents the skip blank cells in the source. + + + + + Returns intersection of the Range with specified Range. + + Range to be intersected. + Returns the intersection Range;if there is no intersection, NULL is returned. + + The following code illustrates how to perform IntersectWith in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Merging cells + IRange range = worksheet.Range["A16:C16"]; + IRange commonRange = worksheet.Range["B16:D16"].IntersectWith(range); + workbook.SaveAs("Intersection.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Merges the Range with specified Range and returns merged Range. + + Range to be merged with. + Merged Ranges or null if wasn't able to merge Ranges. + + The following code illustrates how to perform MergeWith in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Merging cells + IRange range = worksheet.Range["A16:C16"]; + worksheet.Range["D16"].MergeWith(range); + workbook.SaveAs("Merging.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Adds a comment. returns null if the cell has threaded comment + + Returns a comment shape. + + The following code illustrates how to insert Comments in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + // Adding comments to a cell. + ICommentShape comment = sheet.Range["A1"].AddComment(); + comment.Text= "Comments"; + + // Add Rich Text Comments. + IRange range = sheet.Range["A6"]; + range.AddComment().RichText.Text = "RichText"; + IRichTextString rtf = range.Comment.RichText; + + // Formatting first 4 characters. + IFont redFont = workbook.CreateFont(); + redFont.Bold = true; + redFont.Color = ExcelKnownColors.Red; + rtf.SetFont(0, 3, redFont); + + workbook.SaveAs("Comments.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Adds new comment or returns an old one if was present with parse options. Returns null if the cell has threaded comment. + + Indicates whether to parse comment fill line options. + Returns a comment shape. + + + + Measures size of the string. + + String to measure. + Size of the string. + + + + Changes the height of the rows in the Range to achieve the best fit. + + This method is supported on Windows Forms, WPF, ASP.NET, ASP.NET MVC, WinRT, Windows Phone, Universal, UWP, Xamarin and NetStandard platforms only. + + The following code shows how to auto-size row height to its cell content. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Auto-fit rows + worksheet.Range["A2"].Text = "Fit the content to row"; + worksheet.Range["A2"].WrapText = true; + worksheet.Range["A2"].AutofitRows(); + + workbook.SaveAs("AutoFit.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Changes the width of the columns in the Range to achieve the best fit. + + This method is supported on Windows Forms, WPF, ASP.NET, ASP.NET MVC, WinRT, Windows Phone, Universal, UWP, Xamarin and NetStandard platforms only. + + The following code shows how to auto-size row height to its cell content. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Auto-fit columns + worksheet.Range["B4"].Text = "Fit the content to column"; + worksheet.Range["B4"].AutofitColumns(); + + workbook.SaveAs("AutoFit.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Auto fits the column from specified first to last column. + + The first column. + The last column. + + + + Determines whether the Range is Merged or not. + + The merged cells. + Represents the row. + Represents the column + Whether method called by AutoFitColumn or AutoFitRow + Difference of Merged Range. + + true, if the Range is merged, else false. + + + + + Gets the display text. + + The row. + The column. + The format impl. + + + + + Returns the formula function name. + + + + + Updates the format for formula based display text. + + + + + Gets the number or date time. + + The format impl. + The cell value. + + + + + Gets the current date and time if calculate on open is true. + + + + + Returns a object that represents a range thats offset from the specified range. + + The number of rows (positive, negative, or 0 (zero)) by which the range is to be offset + + The number of columns (positive, negative, or 0 (zero)) by which the range is to be offset + + + Use the Offset method to access the cell range of the same size as the current range which is shifted by the specified number of rows and columns. + + Returns a range which is shifted by the specified number of rows and columns. + + + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = engine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + IRange range = worksheet.Range[5,6]; + var offset = range.Offset(-3,-1); + var address2 = offset.AddressLocal; + workbook.SaveAs("output.xlsx"); + } + + + + + + Resizes the specified range a object that represents the resized range. + + The number of rows in the new range. + The number of columns in the new range. + + Use the Resize method to change the size of range by specified rows and columns from the current range. + + Returns the resized range. + + + + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = engine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + IRange range = worksheet.Range[5,6]; + var resize = range.Resize(1000,2000); + var address = resize.AddressLocal; + workbook.SaveAs("output.xlsx"); + } + + + + + + Updates the display text with space according to the column width. + + + + + Gets text width. + + The text to be calculated. + The cell Font. + Measured width of the given text + + + + Gets format string according to the section. + + The value for the range. + The processed format string based on format section. + + + + + Replaces the string with the specified string value. + + The string to be replaced. + The string to replace all occurrences of oldValue. + The following code snippet illustrates how to replace the string with another string. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:A3"].Value = "Find"; + string oldValue = "Find"; + string newValue = "NewValue"; + sheet.Range["A1:A3"].Replace(oldValue, newValue); + string fileName = "Replace.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Replaces the string with the specified string value based on the given . + + The string to be replaced. + The string to replace all occurrences of oldValue. + Specifies the find options for the oldValue. + The following code snippet illustrates how to replace the string with another string. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:A3"].Value = "Find"; + string oldValue = "Find"; + string newValue = "NewValue"; + sheet.Range["A1:A3"].Replace(oldValue, newValue, ExcelFindOptions.MatchCase); + string fileName = "Replace.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Replaces the string with the specified double value. + + The string to be replaced. + The double value to replace all occurrences of oldValue. + The following code snippet illustrates how to replace the string value with double. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:A3"].Value = "Ten"; + string oldValue = "Ten"; + sheet.Range["A1:A3"].Replace(oldValue,10.0); + string fileName = "Replace.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Replaces the string with the specified DateTime value. + + The string to be replaced. + The datetime value to replace all occurrences of oldValue. + The following code illustrates how to replace the string value with datetime. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:A3"].Value = "Find"; + string oldValue = "Find"; + DateTime dateTime = DateTime.Now; + sheet.Range["A1:A3"].Replace(oldValue,dateTime); + string fileName = "Replace.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Replaces the string with the specified array of string values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + The following code snippet illustrates how to replace the string with array of string values. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Value = "Find"; + string oldValue = "Find"; + string[] newValues = { "X values", "Y values" }; + sheet.Range["A1:A3"].Replace(oldValue, newValues, true); + string fileName = "Replace.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Replaces the string with the specified array of int values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + The following code snippet illustrates how to replace the string with array of int values. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Value = "Find"; + string oldValue = "Find"; + int[] newValues = { 1, 2 }; + sheet.Range["A1:A3"].Replace(oldValue, newValues, true); + string fileName = "Replace.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Replaces the string with the specified array of double values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + The following code snippet illustrates how to replace the string with array of double values. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Value = "Find"; + string oldValue = "Find"; + double[] newValues = { 1.00, 3.00 }; + sheet.Range["A1:A3"].Replace(oldValue, newValues, true); + string fileName = "Replace.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Replaces the string with the specified datatable. + + The string to be replaced. + Data table with new data. + Indicates whether field name must be shown. + The following code snippet illustrates how to replace the string value with data table. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Value = "AB2"; + //Create the data table + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("Dosage", typeof(int)); + table.Rows.Add(1); + // Replace the value with data table. + sheet.Range["A1:A3"].Replace("AB2", table, true); + string fileName = "Replace.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Replaces the string with the specified datacolumn. + + The string to be replaced. + DataColumn with new data. + Indicates whether field name must be shown. + + The following code snippet illustrates how to replace the string value with data column. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Value = "AB2"; + //Create the data table + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("Dosage", typeof(int)); + table.Rows.Add(1); + System.Data.DataColumn dataColumn = table.Columns[0]; + // Replace the value with data column. + sheet.Range["A1:A3"].Replace("AB2", dataColumn, true); + string fileName = "Replace.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the first occurrence cell with the specified string value and . + + Value to found. + Flag that represent type of search. + Returns the first cell with a specified string value, or null if value was not found. + + The following code illustrates how to find the first occurrence of the specified string value in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find First with string + IRange result = sheet["A2:K100"].FindFirst("Simple text", ExcelFindType.Text); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the first occurrence cell with the specified double value and . + + Value to found. + Flag that represent type of search. + Returns the first cell with a specified double value, or null if value was not found. + + The following code illustrates how to find the first occurrence of the specified double value in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find First with number + IRange result = sheet["A2:K100"].FindFirst(100.32, ExcelFindType.Number); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the first occurrence cell with the specified bool value. + + Value to be found. + Returns the first cell with a specified bool value, or null if value was not found. + + The following code illustrates how to find the first occurrence of the specified bool value in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find First with bool + IRange result = sheet["A2:K100"].FindFirst(true); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the first occurrence cell with the specified DateTime value. + + Value to be found. + Returns the first cell with a specified DateTime value, or null if value was not found. + + The following code illustrates how to find the first occurrence of the specified DateTime value in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find First with DateTime + IRange result = sheet["A2:K100"].FindFirst(DateTime.Now); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the first occurrence cell with the specified TimeSpan value. + + Value to be found. + Returns the first cell with a specified TimeSpan value, or null if value was not found. + + The following code illustrates how to find the first occurrence of the specified TimeSpan value in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find First with TimeSpan + IRange result = sheet["A2:K100"].FindFirst(TimeSpan.MinValue); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the cells with a specified string value and . + + Value to be found. + Represents type of the value to be found. + Returns the cells with a specified string value, or null if value was not found. + + The following code illustrates how to find the cells with specified string value in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find all with string + IRange[] results = sheet["A2:K100"].FindAll("Simple text", ExcelFindType.Text); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the cells with a specified double value and . + + Value to be found. + Represents type of the value to be found. + Returns the cells with a specified double value, or null if value was not found. + + The following code illustrates how to find the cells with specified double value in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find All with number + IRange[] results = sheet["A2:K100"].FindAll(100.32, ExcelFindType.Number); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the cells with a specified bool value. + + Value to be found. + Returns the cells with a specified bool value, or null if value was not found. + + The following code illustrates how to find the cells with specified bool value in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find all with bool + IRange[] results = sheet["A2:K100"].FindAll(true); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the cells with a specified DateTime value. + + Value to be found. + Returns the cells with a specified DateTime value, or null if value was not found. + + The following code illustrates how to find the cells with specified DateTime value in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find all with DateTime + IRange[] results = sheet["A2:K100"].FindAll(DateTime.Now); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Returns the cells with a specified TimeSpan value. + + Value to be found. + Returns the cells with a specified TimeSpan value, or null if value was not found. + + The following code illustrates how to find the cells with specified TimeSpan value in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(2); + IWorksheet sheet = workbook.Worksheets[0]; + + //Find All with Timespan + IRange[] results = sheet["A2:K100"].FindAll(TimeSpan.MinValue); + + string fileName = "Find.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Copies Range to the clipboard. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Applies border around the Range. The default line style is . + + + The following code illustrates how to apply border around the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + // Applies border around the Range with default line style. + worksheet.Range["A2:F4"].BorderAround(); + + workbook.SaveAs("Border.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Applies border around the Range with the specified . + + Represents border line style. + + The following code illustrates how to apply border around the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + // Applies border around the Range with specified line style. + worksheet.Range["A2:F4"].BorderAround(ExcelLineStyle.Double); + + workbook.SaveAs("Border.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Applies border around the Range with the specified and . + + Represents border line style. + Represents border color. + + The following code illustrates how to apply border around the Range with color. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + // Applies border around the Range with specified line style and color. + worksheet.Range["A2:F4"].BorderAround(ExcelLineStyle.Double,System.Drawing.Color.Blue); + + workbook.SaveAs("Border.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Applies border around the Range with the specified and . + + Represents border line style. + Represents border color. + + The following code illustrates how to apply border around the Range with ExcelKnownColors. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + // Applies border around the Range with specified line style and ExcelKnownColors. + worksheet.Range["A2:F4"].BorderAround(ExcelLineStyle.Double,ExcelKnownColors.Blue); + + workbook.SaveAs("Border.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the range corresponding to the migrant range with some other row and column indexes. + + + + + Applies border inside the Range. The default line style is . + + + The following code illustrates how to apply border inside the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + // Applies border inside the Range with default line style. + worksheet.Range["A2:F4"].BorderInside(); + + workbook.SaveAs("Border.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Applies border inside the Range with the specified . + + Represents border line style. + + The following code illustrates how to apply border inside the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + // Applies border around the inside with specified line style. + worksheet.Range["A2:F4"].BorderInside(ExcelLineStyle.Double); + + workbook.SaveAs("Border.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Applies border inside the Range with the specified and . + + Represents border line style. + Represents border color. + + The following code illustrates how to apply border inside the Range with color. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + // Applies border inside the Range with specified line style and color. + worksheet.Range["A2:F4"].BorderInside(ExcelLineStyle.Double,System.Drawing.Color.Blue); + + workbook.SaveAs("Border.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Applies border inside the Range with the specified and . + + Represents border line style. + Represents border color. + + The following code illustrates how to apply border around the Range with ExcelKnownColors. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + // Applies border around the Range with specified line style and ExcelKnownColors. + worksheet.Range["A2:F4"].BorderAround(ExcelLineStyle.Double,ExcelKnownColors.Blue); + + workbook.SaveAs("Border.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Applies no border in the Range. + + + The following code illustrates how to remove border in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + // Applies border around the Range with default line style. + worksheet.Range["A2:F4"].BorderNone(); + + workbook.SaveAs("Border.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Sets auto format with default auto format option for Range. + + Represents format to set. + + + + Sets auto format with specified auto format option for Range. + + Represents auto format to set. + Represents auto format options. + + + + Sets cell value. + + Value to be set. + + + + Collapses the group by rows/columns. + + + Represents to collapse the group by rows/columns. + + + The following code illustrates how to collapse the group in the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Collapse group + worksheet.Range["A5:A15"].CollapseGroup(ExcelGroupBy.ByRows); + + workbook.SaveAs("CollapseGroup.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Expands the group by rows/columns. + + Represents to expand the group by rows/columns. + + The following code illustrates how to expand the group in the Range. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Expand group with flag set to expand parent + worksheet.Range["A5:A15"].ExpandGroup(ExcelGroupBy.ByRows); + + workbook.SaveAs("ExpandGroup.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + + Expands the group by row/column with collapse option. + + + Represents to expand the group by rows/columns. + + Represent the collapses options. + + The following code illustrates how to perform ExpandGroup in the Range with collapse option. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Expand group with flag set to expand parent + worksheet.Range["A5:A15"].ExpandGroup(ExcelGroupBy.ByRows, ExpandCollapseFlags.ExpandParent); + + workbook.SaveAs("ExpandGroup.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + + Check for escape sequence added string and removes it + + input string + the string which have removed escape sequences + + + + Check for quotes added to format string. + + input string + The string processed for quotes. + + + + Gets the dependent cells which refer to other cells. + + Returns the dependent cells or null if value was not found. + The following code illustrates how to get the dependent cells from the worksheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetDependents(); + + string fileName = "Dependents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the dependent cells which refer to other cells. + + Indicates whether to check from other worksheets. + Returns the dependent cells with a specified bool value or null if value was not found. + The following code illustrates how to get the dependents cells from all the worksheets. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetDependents(true); + + string fileName = "Dependents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the direct dependent cells which refer to other cells. + + Returns the direct dependent cells or null if value was not found. + The following code illustrates how to get the direct dependent cells from the worksheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetDirectDependents(); + + string fileName = "DirectDependents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the direct dependent cells which refer to other cells. + + Indicates whether to check from other worksheets. + Returns the direct dependent cells with a specified bool value or null if value was not found. + The following code illustrates how to get the direct dependents cells from all the worksheets. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetDirectDependents(true); + + string fileName = "DirectDependents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the precedent cells which are referred by a formula in another cell. + + Returns the precedent cells or null if value was not found. + The following code illustrates how to get the precedent cells from the worksheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetPrecedents(); + + string fileName = "Precedents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the precedent cells which are referred by a formula in another cell. + + Indicates whether to check from other worksheets. + Returns the precedent cells with a specified bool value or null if value was not found. + The following code illustrates how to get the precedent cells from all the worksheets. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetPrecedents(true); + + string fileName = "Precedents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the direct precedent cells which are referred by a formula in another cell. + + Returns the direct precedent cells or null if value was not found. + The following code illustrates how to get the direct precedent cells from the worksheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetDirectPrecedents(); + + string fileName = "DirectPrecedents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the direct precedent cells which are referred by a formula in another cell. + + Indicates whether to check from other worksheets. + Returns the direct precedent cells with a specified bool value or null if value was not found. + The following code illustrates how to get the direct precedent cells from all the worksheets. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("FormulaExcel.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IRange[] results = sheet["A1"].GetDirectPrecedents(true); + + string fileName = "DirectPrecedents.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Get dependents cells from specified worksheet + + Worksheet to get dependents cells. + Indicates whether check other worksheets. + + + + Get reference cells which are used in the range. + + Worksheet to get dependents cells. + Workbook precedents cells collection. + Indicates whether check other worksheets. + + + + Gets the dependent ranges which refer to other cells. + + Indicates whether to check from other worksheets. + Indicates whether to get only direct dependents. + Returns the dependent cells with a specified bool value or null if value was not found. + + + + Gets the precedent cells which are referred by a formula in another cell. + + Indicates whether to check from other worksheets. + Indicates whether to get only direct precendets. + Returns the dependent cells with a specified bool value or null if value was not found. + + + + Get and add named range cells to precedents cells collection. + + source range which Worksheet to get dependents cells. + ReferToRange for the name. + Precedents cells collection. + Workbook precedents cells collection. + List collcetion which contains referred cells by the source range. + Indicates whether check other worksheets. + + + + Get and add named range cells to precedents cells collection. + + source range cell address. + Workbook precedents cells collection. + Precedents cells collection. + + + + Returns new address of Range. + + Dictionary with Worksheet names. + String that sets as a worksheet name. + Returns string with new name. + + + + Creates the copy of current instance. + + Represents a parent object. + Hash table with new names. + Represents a parent workbook. + Returns cloned Range. + + + + Clears conditional formats. + + + + + Clears conditional formats. + + + + + Clears data validations. + + + + + Returns array that contains information about Range. + + Rectangles that describes Range with zero-based coordinates. + + + + Returns number of rectangles returned by GetRectangles method. + + Number of rectangles returned by GetRectangles method. + + + + Update the cell value when calc engine is enabled. + + + + + + + + Returns R1C1 address from cell index. + + Cell index. + Returns R1C1 address. + + + + Returns R1C1 address from cell index. + + Cell index. + Returns R1C1 address. + + + + Converts cell name to cell index. + + Name of the cell. + Cell index of the specified cell. + + When specified cell name is null. + + + When length of the specified cell name is less than 2. + + + When length of the alpha part of the name is less + than 1 or greater than 2. + + + When length of the number part of the name is less + than 1 or greater than 5. + + + + + Converts cell name to row and column index. + + Name of the cell. + Row index. + Column index. + + + + Converts column name into index. + + Name to convert. + Converted value. + + + + Converts column index into string representation. + + Column to process. + String name in excel of the column + + + + Returns cell name by specified column and row index. + + Column index of the cell. + Row index of the cell. + Cell name. + + When firstColumn or firstRow is less than one. + + + + + Returns cell name by specified column and row index with R1C1-style notation flag. + + Column index of the cell. + Row index of the cell. + Indicates whether to use R1C1 reference mode. + Cell name. + + When firstColumn or firstRow is less than one. + + + + + Returns cell name by specified column and row index with R1C1-style notation and separater flag. + + Column index of the cell. + Row index of the cell. + Indicates whether to use R1C1 reference mode. + If true adds '$' separator. + Cell name. + + When firstColumn or firstRow is less than one. + + + + + Returns the Range reference for the specified Range in the language + of the user. + + First row of the Range. + First column of the Range. + Last row of the Range. + Last column of the Range. + The Range reference for the specified Range in the language of the user. + + + + Returns the Range reference for the specified Range in the language + of the user. + + First row of the Range. + First column of the Range. + Last row of the Range. + Last column of the Range. + Indicates whether to use R1C1 reference mode. + The Range reference for the specified Range in the language of the user. + + + + Returns cell name by column and row index with dollar sign. + + Column index of the cell. + Row index of the cell. + Cell name. + + When firstColumn or firstRow is less than one. + + + + + Returns cell index by specified column and row index. + + Column index of the cell. + Row index of the cell. + Cell index. + + When firstRow or firstColumn is less than zero. + + + + + Returns row index from cell index. + + Cell index. + Row index. + + + + Returns column index from cell index. + + Cell index. + Column index. + + + + Extracts worksheet name from Range name. + + Range name to extract from. + Worksheet name. + + + + Helper methods for WrapText Property. + + List of IRange. + Gets WrapText property value. + + + + Helper methods for WrapText Property. + + List of IRange. + Value to set. + + + + Helper methods for WrapText Property. + + List of IRange. + Gets WrapText property value. + + + + Helper methods for CellStyleName Property. + + List of IRange. + Gets CellStyleName property value. + + + + Parses string representation of the Range. + + Range to parse. + Parent workbook. + First row. + First column. + Last row. + Last column. + Number of parts: 1 - one cell, 2 - range of cells. + + + + Finds the minimum and maximum row/column values from among the string representation of cells. + + Cells to find minimum and maximum. + First row. + First column. + Last row. + Last column. + + + + Returns rectangle object, that represents rectangle of Range. + + Represents the Range. + If true than thrown an exception, if Range is null. + Returns rectangle, that represents borders of Range. + + + + Returns rectangle object, that represents rectangle of Range. + + Represents the Range. + If true than thrown an exception, if Range is null. + Returns rectangle, that represents borders of Range. + + + + Get Custom Number format Color value. + + + + + Get the color list from input numberformat + + input number format + default color value + the list of color with its key + + + + Returns the color value from the input value name + + the color name + the output color value + + + + Crops the image with the specified offset. + + Source image to crop. + Left offset to crop from. + Top offset to crop from. + Right offset to crop. + Bottom offset to crop. + Indicates whether the destination image is transparent. + Returns the cropped image for the offsets specified. + + + + Checks whether the pixelFormat is supported or not. + + + True for Supported pixelFormat.Otherwise False. + + + + Called when NumberFormat of the Range changes. + + Event sender. + Event arguments. + + + + Attaches handler to NumberFormatChanged event of parent style. + + + + + Attaches event to cell styles. + + + + + Attaches handler to NumberFormatChanged of the specified wrapper. + + Wrapper to attach event to. + Handler to attach. + + + + Creates style. + + + + + Creates style wrapper. + + Extended format index. + + + + Initializes style wrapper. + + Extended format index. + + + + Sets index of extended format that defines style for this Range. + + Index to set. + + + + Changes style name. + + Name to set. + Style object that corresponds to the name. + + + + Add the XF index in collection for created cell style. + + + + + Returns name of the style, applied to the cell. + + Name of the style, applied to the cell. + + + + Returns WrapText of the style, applied to the cell. + + WrapText of the style, applied to the cell. + + + + Gets format code. + + Value representing number format code + + + + Gets the date time by culture. + + Date in string format. + Result in Datetime. + Returns true, when the date time is culture based. + + + + Updates Range information from record. + + + + + Checks whether formula arrays inside this Range are separated or not. + + Dictionary with records to skip. + True if records are not separated. + + + + Returns customized number format + + Number format string to be customized + Cutomized number format string + + + + Reparse cell if parsing wasn't successful when loading the workbook. + + + + + Returns ptg of range. + + Returns native ptg. + + + + Returns an enumerator that iterates through the Range. + + + + + + Gets or sets HTML string. + + + + + Gets the Range reference in macro language. Read-only. + + + The following code illustrates how to access Address property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + string address = sheet.Range[3, 4].Address; + + workbook.SaveAs("Address.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the Range reference in language of the user. Read-only. + + + The following code illustrates how to access AddressLocal property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + string address = sheet.Range[1, 2].AddressLocal; + + workbook.SaveAs("AddressLocal.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the Range reference along with sheet name using R1C1-style notation. Read-only. + + + The following code illustrates how to access AddressR1C1 property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + string address = sheet.Range[1, 1].AddressR1C1; + + workbook.SaveAs("AddressR1C1.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the Range reference using R1C1-style notation. Read-only. + + + The following code illustrates how to access AddressR1C1Local property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + string address = sheet.Range[1, 1].AddressR1C1Local; + + workbook.SaveAs("AddressR1C1Local.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets or sets boolean value in the Range. + + + The following code illustrates how to set and access Boolean property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range[2, 4].Boolean = true; + bool boolean = sheet.Range[2, 4].Boolean; + + workbook.SaveAs("Boolean.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets a collection that represents the borders of a style + in the Range. Read-only. + + Borders including a Range defined as part of a + conditional format will be returned. + + The following code illustrates how to access Borders property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + IBorders borders = sheet["K3"].Borders; + borders.LineStyle = ExcelLineStyle.Dashed; + + workbook.SaveAs("Borders.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets a object that represents the cells in the Range.Read-only. + + + The following code illustrates how to access Cells property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + IRange[] cells = sheet["A1:E8"].Cells; + foreach (IRange range in cells) + { + // Do some manipulations + } + + workbook.SaveAs("Cells.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets column index of the first column in the Range which is one based index. Read-only. + + + The following code illustrates how to access Column property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + int firstColumn = sheet["E1:R3"].Column; + + workbook.SaveAs("Column.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets column group level of the Range. Read-only. + + + -1 - not all column in the Range have same group level. + 0 - No grouping, + 1 - 7 - group level. + + + + + Gets or sets the width of all columns in the specified Range, measured in points. + + + Gets Double.MinValue if the rows in the specified Range + aren't all the same width. + + + + + Gets the number of objects in the collection. Read-only. + + + + + Gets a Boolean value indicating whether Range has data validation. Read-only. + + If Range is not single cell, then gets true only if all cells have data validation. + + + + Gets a Boolean value indicating whether each cell of the Range has some conditional formatting. Read-only. + + + + + Gets or sets DateTime value in the Range. + + + Gets DateTime.MinValue if not all cells in the Range have same DateTime value. + + + The following code illustrates how to set and access DateTime property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range[2, 4].DateTime = DateTime.Now; + DateTime dateTime = sheet.Range[2, 4].DateTime; + + workbook.SaveAs("DateTime.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets cell value with its number format. Read-only. + + While accessing DisplayText for Range of cells, it gets DisplayText of the first cell + If a range contains a formula, must be invoked to get the calculated value of the formula + + + The following code illustrates how to access DisplayText property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + IRange range= sheet.Range[3, 1]; + range.Value = "1/1/2015"; + range.NumberFormat = "dd-MMM-yyyy"; + string displayText = range.DisplayText; + + workbook.SaveAs("DisplayText.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets a object that represents the cell at the end of the Range. + + + + + True if it is Entire row. + + + + + True if it is Entire Column. + + + + + Gets a object that represents the entire column (or + columns) in the Range. Read-only. + + + + + Gets a object that represents the entire row (or + rows) in the Range. Read-only. + + + + + Gets or sets error value in the Range. + + + + + Gets or sets the formula in A1-style notation and in + macro language for the Range. Read/write Variant. + + + + + Represents array formula which can perform multiple calculations on one or more of the items in an array. + + + The following code illustrates how to set and access FormulaArray property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Assign array formula + sheet.Range["A1:D1"].FormulaArray = "{1,2,3,4}"; + + //Adding a named range for the Range A1 to D1 + sheet.Names.Add("ArrayRange", sheet.Range["A1:D1"]); + + //Assign formula array with named Range + sheet.Range["A2:D2"].FormulaArray = "ArrayRange+100"; + + string fileName = "FormulaArray.xlsx"; + workbook.SaveAs(fileName); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the Formula in the cell as a string. + + + + + Gets the calculated value of the formula as a number. + + + + + Gets or sets the calculated value of the formula as a boolean. + + + + + Gets or sets the error value of the formula as a string. + + + + + Gets formula value. + + + + + Gets or sets a Boolean value indicating whether the formula will be hidden when the worksheet is protected. + + + True if the formula will be hidden when the worksheet is protected. + False if at least part of formula in the Range is not hidden. + + + + + Gets or sets formula DateTime value in the Range. + + + Gets DateTime.MinValue if not all cells in the Range have same FormulaDateTime value. + + + + + Gets or sets the formula for the Range, using R1C1-style notation. + + + + + Gets or sets the formula array for the Range, using R1C1-style notation. + + + + + Gets a Boolean value indicating whether Range contains formula. Read-only. + + True if all cells in the Range contain formulas; False if + at least one of the cells in the Range doesn't contain a formula. + + + + + Gets a Boolean value indicating whether Range contains array-entered formula. Read-only. + + + + + Gets or sets the horizontal alignment for the specified object. + + + + + Gets hyperlinks in the Range. Read-only. + + + The following code illustrates how to access Borders property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + + // Creating a Hyperlink for a Website. + IHyperLink hyperlink = sheet.HyperLinks.Add(sheet.Range["C5"]); + hyperlink.Type = ExcelHyperLinkType.Url; + hyperlink.Address = "http://www.syncfusion.com"; + hyperlink.ScreenTip = "To know more About SYNCFUSION PRODUCTS go through this link"; + + workbook.SaveAs("Hyperlinks.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets or sets the indent level for cell or Range. + + It can be from 0 to 15 for Excel 97-2003 and 250 for Excel 2007-2013. + + + + Gets a Boolean value indicating whether cell type is boolean. + + + + + Gets a Boolean value indicating whether Range contains error value. + + + + + Gets a Boolean value indicating whether Range is grouped by column. Read-only. + + + + + Gets a Boolean value indicating whether Range is grouped by row. Read-only. + + + + + Gets or sets last column of the Range. + + + + + Gets or sets last row of the Range. + + + + + Gets or sets number value that is contained by Range. + + + When Range value is not a number. + + + + + Gets or sets format of cell which is similar to Style.NumberFormat property. + + + Gets NULL if all cells in the specified Range don't have the same number format. + + + The following code illustrates how to set and access NumberFormat property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + IRange range= sheet.Range[3, 1]; + range.Value = "1/1/2015"; + range.NumberFormat = "dd-MMM-yyyy"; + string displayText = range.DisplayText; + + workbook.SaveAs("NumberFormat.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets row index of the first row in the Range. + Read-only.One based index. + + + + + Gets row group level. Read-only. + + + -1 - Not all rows in the Range have same group level. + 0 - No grouping, + 1 - 7 - Group level. + + + + + Gets the height of all the rows in the Range specified, measured in points. + + + Gets Double.MinValue if the rows in the specified Range aren't all the same height. Maximum Row height can be 409 + value, minimum is zero. + + + + + Gets an array of objects that represent the rows in the Range. Read only. + + + The following code illustrates how to access Columns property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + IRange[] rows = sheet["A1:E8"].Rows; + foreach (IRange row in rows) + { + // Do some manipulations + } + + workbook.SaveAs("Rows.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets an array of objects that represent the columns in the Range. + Read only. + + + The following code illustrates how to access Columns property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + IRange[] columns = sheet["A1:E8"].Columns; + foreach (IRange column in columns) + { + // Do some manipulations + } + + workbook.SaveAs("Columns.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets a object that represents the style of the + Range. + + + The following code illustrates how to access CellStyle property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + // Accessing cell style of the Range. + IStyle rangeStyle = sheet["K4"].CellStyle; + rangeStyle.Font.Bold = true; + + workbook.SaveAs("CellStyle.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets name of the object that represents style of the + Range. + + + The following code illustrates how to access CellStyleName property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + // Creating a new style with cell back color, fill pattern and font attribute + IStyle style = workbook.Styles.Add("GreenBoldFillDiagonal"); + style.Color = System.Drawing.Color.LightGreen; + style.FillPattern = ExcelPattern.DarkUpwardDiagonal; + style.Font.Bold = true; + + // Assigning the cell style name to the Range. + sheet["A1"].CellStyleName = "GreenBoldFillDiagonal"; + + workbook.SaveAs("CellStyleName.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets or sets built in style in the Range. + + + + + Gets or sets text contained by the cell. + + + + + Gets or sets TimeSpan contained by the cell. + + + + + Gets or sets the value of the Range. Does not support FormulaArray value. + + + + Sets different data types values as a string, + Value property parses the input string to determine its type which leads performance delay. + + + The only difference between the Value2 property and the Value property + is that the Value2 property does not use the Currency and Date data types. + Also, it does not support FormulaArray value. + + + + The following code illustrates how to set and access Value property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + IRange range= sheet.Range[3, 1]; + range.Value = "1/1/2015"; + range.NumberFormat = "dd-MMM-yyyy"; + string displayText = range.DisplayText; + + workbook.SaveAs("Value.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the calculated value of a formula in the Range. Read-only. + + To compute a formula, it is mandatory to enable calculate engine by + invoking EnableSheetCalculations method of worksheet object. It is also recommend to disable + calculate engine once all formula are computed by invoking DisableSheetCalculations method of worksheet object + + Following code illustrates how to access a calculated value. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx", ExcelOpenType.Automatic); + IWorksheet sheet = workbook.Worksheets[0]; + + //Initializes Calculate Engine to perform calculation + sheet.EnableSheetCalculations(); + + //Returns the calculated value of a formula using the most current inputs + string calculatedValue = sheet["C1"].CalculatedValue; + //Formula calculation is disabled for the sheet. + sheet.DisableSheetCalculations(); + + workbook.SaveAs("Formula.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets or sets the cell value. + + + + Sets different data types values as a object. + Value2 first checks whether the specified object has the type known for it (DateTime, TimeSpan, Double, Int). + If yes, then it uses the corresponding typed properties (DateTime, TimeSpan, and Number). + Otherwise, it calls Value property with String data type. + + + The only difference between the Value2 property and the Value property + is that the Value2 property does not use the Currency and Date data types. + Also, it does not support FormulaArray value. + + + + The following code illustrates how to set and access Value2 property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + + //Assigning Value2 property of the Range. + sheet["A1"].Value2 = DateTime.Now; + sheet["A2"].Value2 = 45; + sheet["A3"].Value2 = false; + + // Checking Range types. + bool isDateTime = sheet["A1"].HasDateTime; + bool isNumber = sheet["A2"].HasNumber; + bool isboolean = sheet["A3"].HasBoolean; + + workbook.SaveAs("Value2.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets or sets a value indicating whether this instance is num reference for chart axis. + + + true if this instance is num reference; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is a string reference for chart axis. + + + true if this instance is string reference; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is multi reference for chart axis. + + + true if this instance is multi reference; otherwise, false. + + + + + Gets or sets the vertical alignment of the Range. + + + + + Gets the object in which belongs to the Range. Read-only. + + + + + Gets or sets cell range by row and column index. Row and column indexes are one-based. + + + + + Get cell Range. Row and column indexes are one-based. Read-only. + + + + + Gets cell Range with R1C1Notation flag. Read-only. + + + + + Gets cell Range with R1C1Notation flag. Read-only. + + + + + Gets the collection of conditional formats in the Range + Read-only. + + + The following code illustrates how to set and access Value2 property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + // Applying conditional formatting to "A1" + IConditionalFormats condition = sheet.Range["A2"].ConditionalFormats; + IConditionalFormat condition1 = condition.AddCondition(); + + // Represents conditional format rule that the value in target Range should be between 10 and 20 + condition1.FormatType = ExcelCFType.CellValue; + condition1.Operator = ExcelComparisonOperator.Between; + condition1.FirstFormula = "10"; + condition1.SecondFormula = "20"; + sheet.Range["A1"].Text = "Enter a number between 10 and 20"; + + workbook.SaveAs("ConditionalFormats.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + Gets a object that represents the data validation associated with the cell . Read-only. + + + The following code illustrates how to access DataValidation property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + + //Data validation for number + IDataValidation validation = sheet.Range["A3"].DataValidation; + validation.AllowType = ExcelDataType.Integer; + + //Value between 0 to 10 + validation.CompareOperator = ExcelDataValidationComparisonOperator.Between; + validation.FirstFormula = "0"; + validation.SecondFormula = "10"; + + workbook.SaveAs("DataValidation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets a Boolean value indicating whether Range has formula bool value. Read-only. + + + + + Gets a Boolean value indicating whether Range has formula error value. Read-only. + + + + + Gets a Boolean value indicating whether Range has formula value formatted as DateTime. Read-only. + + + + + Gets a Boolean value indicating whether Range has formula number value. Read-only. + + + + + Gets a Boolean value indicating whether Range has formula value evaluated as string. Read-only. + + + + + Gets a Boolean value indicating whether the Range is blank. Read-only. + + + + + Gets a Boolean value indicating whether the Range has value or style. Read-only. + + + + + Gets a Boolean value indicating whether Range contains bool value. Read-only. + + + The following code illustrates how to set and access HasBoolean property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + + //Assigning Value2 property of the Range. + sheet["A3"].Value2 = false; + + // Checking Range types. + bool isboolean = sheet["A3"].HasBoolean; + + workbook.SaveAs("HasBoolean.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets a Boolean value indicating whether Range contains DateTime value. Read-only. + + + The following code illustrates how to set and access HasDateTime property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + + //Assigning Value2 property of the Range. + sheet["A1"].Value2 = DateTime.Now; + + // Checking Range types. + bool isDateTime = sheet["A1"].HasDateTime; + + workbook.SaveAs("HasDateTime.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets a Boolean value indicating whether Range contains number. Read-only. + + + The following code illustrates how to set and access Value2 property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + //Assigning Value2 property of the Range. + sheet["A2"].Value2 = 45; + + // Checking Range types. + bool isNumber = sheet["A2"].HasNumber; + + workbook.SaveAs("HasNumber.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets a Boolean value indicating whether Range contains string. Read-only. + + + + + Gets a object that represents the comment associated with the Range. Read-only. + + + The following code illustrates how to insert Comments property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + // Adding comments to a cell. + sheet.Range["A1"].AddComment().Text = "Comments"; + + // Add Rich Text Comments. + IRange range = sheet.Range["A6"]; + range.AddComment().RichText.Text = "RichText"; + IRichTextString rtf = range.Comment.RichText; + + // Formatting first 4 characters. + IFont redFont = workbook.CreateFont(); + redFont.Bold = true; + redFont.Color = ExcelKnownColors.Red; + rtf.SetFont(0, 3, redFont); + + workbook.SaveAs("Comments.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets the threaded comment associated with the cell. + + The object + + The following code illustrates how to access ThreadedComment property of IRange + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Access threaded comment from IRange + IThreadedComment threadedComment = worksheet["C2"].ThreadedComment; + + if(threadedComment != null) + string text = threadedComment.Text; + + //Save and dispose + workbook.SaveAs("ThreadedComments.xlsx"); + workbook.Close(); + } + + + + + + Gets string with rich text formatting in the Range. Read-only. + + + + + Gets a Boolean value indicating whether cell contains formatted rich text string. + + + + + Checks whether Range is a part of merged Range. + + + + + Gets a object that represents the merged Range to which the cell or Range belongs. Read-only. + + If the specified cell isn�t in a merged Range, this property gets NULL. + + + + Gets a Boolean value indicating whether cell is initialized. Read-only. + + + + + Gets a Boolean value indicating whether Range's style differs from default style. + Read-only. + + + + + Gets or sets wrap text of the Range. + Read/write Boolean. + + + + + Gets or sets ignore error options for formula auditing. If not single cell gets concatenated flags. + + + + + Gets a Boolean value indicating whether Range has external formula. Read-only. + + + + + Gets a Boolean value indicating whether all values in the Range are preserved as strings. + + + + + String format for the text to be measured in UpdateText method. + + + + + Indicating whether the range indexer is absolute or relative. + + + + + Gets or sets the row height calculated or not. + + + + + Gets the Application object. + + + + + Gets the Parent object. + + + + + Application object for this object. + + + + + Gets the Range reference along with its sheet name in format "'Sheet1'!$A$1". Read-only. + + + The following code illustrates how to access AddressGlobal property of the Range. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[2]; + string address = sheet.Range[4, 3].AddressGlobal; + + workbook.SaveAs("AddressGlobal.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Gets global address (with $ signs) without worksheet name. + + + + + Gets list of all cells. + + + + + Checks if the Range represents a single cell or Range of cells. Read-only. + + + + + Gets or sets first row of the Range. + + + + + Gets or sets first column of the Range. + + + + + If it is a single cell, then it Gets its name; otherwise Gets NULL. Read-only. + + + + + If single cell, Gets its name; otherwise Gets -1. Read-only. + + + + + Gets type of the cell. Read-only. + + + + + Gets index of extended format. Read-only. + + + + + Sets or gets index of extended format. + + + When method is applied for the Range that contains + more than one cell. + + + + + Converts Range to rk subrecord. Read-only. + + + When cell does not contain rk record. + + + + + Gets parent workbook. Read-only. + + + + + Gets merge region if Range is part of any merge region; otherwise + Gets null. Read-only. + + + + + Gets parent worksheet. Read-only. + + + + + Gets or sets Internal record. + + + + + Gets Dictionary where key is ArrayRecord that at least partially intersects + with this Range. Read-only. + + + + + Checks if all formula arrays partially contained by this Range + are fully contained by this Range. Read-only. + + + + + Gets the number of cells in the Range. Read-only. + + + + + Gets number format object corresponding to this Range. Read-only. + + + + + Gets address global in the format required by Excel 2007. + + + + + Gets RowStorage from row + + + + + Gets a date separator of current culture + + + + + Gets a time separator of current culture + + + + + Get / sets type of the format. + + + + + Read-only. Returns FormatRecord for this Range. + + + + + Indicates whether Range contains number. Read-only. + + + + + Gets name of the parent worksheet. + + + + + Returns extended format for this Range. Read-only. + This property should only be used for reading values. + + + + + Returns type code of the underlying record. Read-only. + + + + + Gets or sets cell column. + + + + + Gets or sets cell row. + + + + + Enumeration that contains all possible cell types for the Range. + + + + + Indicates that range contains NumberRecord. + + + + + Indicates that range contains RKRecord. + + + + + Indicates that range contains LabelSSTRecord. + + + + + Indicates that range contains BlankRecord. + + + + + Indicates that range contains FormulaRecord. + + + + + Indicates that range contains BoolErrRecord. + + + + + Indicates that range contains RStringRecord. + + + + + Indicates that range contains LabelRecord. + + + + + + + + + + Event to change cell value + + + + + + + + + + + + + + Resets row and column values. + + One-based row index of the new cell address. + One-based column index of the new cell address. + + + + Set int value + + + + + + Set double value + + + + + + Set DateTime value + + + + + + Set boolean value + + + + + + Set string value + + + + + + This class contains stores true/false/undefined values for ranges. + + + + + Object that contains ranges with value equal to true. + + + + + Object that contains ranges with value equal to false. + + + + + Returns value for the range object. + + Range to get information about. + Value for the range. + + + + Sets property value for the range. + + Range to set value for. + Value to set. + + + + Clears all ranges. + + + + + Represents named range in the excel. + + + + + Represents a defined name for a range of cells. Names can be + either built-in names such as Database, Print_Area, and + Auto_Open or custom names. + + + Below these rules are should be followed, when you're creating a named range in Excel. + 1. The first character of a name must be one of the following characters: + letter, + underscore (_), + backslash (\). + 2. Remaining characters in the name can be + letters, + numbers, + periods, + underscore characters. + 3. The following are not allowed: + Space characters are not allowed as part of a name. + Names can't look like cell addresses, such as A$35 or R2D2. + C, c, R, r - can't be used as names. Excel uses them as selection shortcuts. + 4. Names are not case sensitive. For example, North and NORTH are treated as the same name. + To know more about Named Ranges refer this link. + + + + + Deletes the Named Range object. + + + To know more about Named Ranges refer this link. + + The following code illustrates how to delete a named range in wokbook and worksheet. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //Deletes the named range object using workbook + workbook.Names[0].Delete(); + + //Deletes the named range object using worksheet + sheet.Names[0].Delete(); + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Returns the index number of the object within the collection of similar + objects. + + + To know more about Named Ranges refer this link. + + The following code illustrates use of Index property in named range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 88; + + //Create a Named Range using workbook + IName namedTitle = workbook.Names.Add("NamedTitle"); + + //Returns the index number of the object within the collection of similar objects + workbook.Names[0].Name = "Titles"; + workbook.Names[0].Value = "Sheet1!$A$1:$C$1"; + + //Create a Named Range using worksheet + IName namedData = sheet.Names.Add("NamedData"); + + //Returns the index number of the object within the collection of similar objects + sheet.Names[0].Name = "Records"; + sheet.Names[0].Value = "Sheet1!$A$2:$C$3"; + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the name of the object. Read / write String. + + + Below these rules are should be followed, when you're creating a named range in Excel. + 1. The first character of a name must be one of the following characters: + letter, + underscore (_), + backslash (\). + 2. Remaining characters in the name can be + letters, + numbers, + periods, + underscore characters. + 3. The following are not allowed: + Space characters are not allowed as part of a name. + Names can't look like cell addresses, such as A$35 or R2D2. + C, c, R, r - can't be used as names. Excel uses them as selection shortcuts. + 4. Names are not case sensitive. For example, North and NORTH are treated as the same name. + To know more about Named Ranges refer this link. + + The following code illustrates use of Name property in named range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 88; + + //Create a Named Range using workbook + IName namedTitle = workbook.Names.Add("NamedTitle"); + namedTitle.RefersToRange = sheet.Range["A1:C1"]; + + //Sets the name of the object + namedTitle.Name = "Titles"; + + //Create a Named Range using worksheet + IName namedData = sheet.Names.Add("NamedData"); + namedData.RefersToRange = sheet.Range["A2:C3"]; + + //Sets the name of the object + namedData.Name = "Records"; + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Returns or sets the name of the object, in the language of the user. + Read / write String for Name. + + + Below these rules are should be followed, when you're creating a named range in Excel. + 1. The first character of a name must be one of the following characters: + letter, + underscore (_), + backslash (\). + 2. Remaining characters in the name can be + letters, + numbers, + periods, + underscore characters. + 3. The following are not allowed: + Space characters are not allowed as part of a name. + Names can't look like cell addresses, such as A$35 or R2D2. + C, c, R, r - can't be used as names. Excel uses them as selection shortcuts. + 4. Names are not case sensitive. For example, North and NORTH are treated as the same name. + To know more about Named Ranges refer this link. + + The following code illustrates use of NameLocal property in named range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 88; + + //Create a Named Range using workbook + IName namedTitle = workbook.Names.Add("NamedTitle"); + namedTitle.RefersToRange = sheet.Range["A1:C1"]; + + //Sets the name of the object + namedTitle.NameLocal = "TitlesLocal"; + + //Create a Named Range using worksheet + IName namedData = sheet.Names.Add("NamedData"); + namedData.RefersToRange = sheet.Range["A2:C3"]; + + //Sets the name of the object + namedData.NameLocal = "RecordsLocal"; + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Gets / sets associated with the Name object. + + + To know more about Named Ranges refer this link. + + The following code illustrates use of RefersToRange property in named range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 88; + + //Create a Named Range using workbook + IName namedTitle = workbook.Names.Add("Titles"); + + //Sets Range associated with the Name object + namedTitle.RefersToRange = sheet.Range["A1:C1"]; + + //Create a Named Range using worksheet + IName namedData = sheet.Names.Add("Records"); + + //Sets Range associated with the Name object + namedData.RefersToRange = sheet.Range["A2:C3"]; + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + For the Name object, a string containing the formula that the name is + defined to refer to. The string is in A1-style notation in the language + of the macro, without an equal sign. + + + To know more about Named Ranges refer this link. + + The following code illustrates use of Value property in named range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 88; + + //Create a Named Range using workbook + IName namedTitle = workbook.Names.Add("Titles"); + + //Sets string containing the formula that the name is defined to RefersToRange + namedTitle.Value = "Sheet1!$A$1:$C$1"; + + //Create a Named Range using worksheet + IName namedData = sheet.Names.Add("Records"); + + //Sets string containing the formula that the name is defined to RefersToRange + namedData.Value = "Sheet1!$A$2:$C$3"; + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Determines whether the object is visible. Read / write Boolean. + + + To know more about Named Ranges refer this link. + + The following code illustrates use of Visible property in named range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 88; + + //Create a Named Range using workbook + IName namedTitle = workbook.Names.Add("Titles"); + namedTitle.RefersToRange = sheet.Range["A1:C1"]; + + //Create a Named Range using worksheet + IName namedData = sheet.Names.Add("Records"); + namedData.RefersToRange = sheet.Range["A2:C3"]; + + //Set name visibility as false. + namedData.Visible = false; + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Indicates whether name is local. + + + To know more about Named Ranges refer this link. + + The following code illustrates use of IsLocal property in named range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 88; + + //Create a Named Range using worksheet + IName namedData = sheet.Names.Add("Records"); + namedData.RefersToRange = sheet.Range["A2:C3"]; + + //Indicates whether name is local + bool isLocal = namedData.IsLocal; + if (isLocal) + { + //Your Code Here + } + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Gets named range Value in R1C1 style. Read-only. + + + To know more about Named Ranges refer this link. + + The following code illustrates use of ValueR1C1 property in named range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 88; + + //Create a Named Range using worksheet + IName namedData = sheet.Names.Add("Records"); + namedData.RefersToRange = sheet.Range["A2:C3"]; + + //Gets named range Value in R1C1 style + string valueR1C1 = namedData.ValueR1C1; + if (valueR1C1 != string.Empty) + { + //Your Code Here + } + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Gets named range RefersTo. Read-only. + + + To know more about Named Ranges refer this link. + + The following code illustrates use of RefersTo property in named range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 88; + + //Create a Named Range using worksheet + IName namedData = sheet.Names.Add("Records"); + namedData.RefersToRange = sheet.Range["A2:C3"]; + + //Gets named range RefersTo + string refersTo = namedData.RefersTo; + if (refersTo != string.Empty) + { + //Your Code Here + } + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Gets named range RefersTo in R1C1 style. Read-only. + + + To know more about Named Ranges refer this link. + + The following code illustrates use of RefersToR1C1 property in named range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 88; + + //Create a Named Range using worksheet + IName namedData = sheet.Names.Add("Records"); + namedData.RefersToRange = sheet.Range["A2:C3"]; + + //Gets named range RefersTo in R1C1 style + string refersToR1C1 = namedData.RefersToR1C1; + if (refersToR1C1 != string.Empty) + { + //Your Code Here + } + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Returns parent . Read-only. + + + To know more about Named Ranges refer this link. + + The following code illustrates use of Worksheet property in named range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + //Gets parent worksheet of named range + IWorksheet namedWorksheet = sheet.Names[0].Worksheet; + if(namedWorksheet != null) + { + //Your Code Here + } + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Returns string representation of the name's scope. Read-only. The Scope property have a separate scope values for Workbook and Worksheet. + + + To know more about Named Ranges refer this link. + + The following code illustrates use of Scope property for named range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 88; + + //Create a Named Range using workbook + IName namedTitle = workbook.Names.Add("NamedTitle"); + namedTitle.RefersToRange = sheet.Range["A1:C1"]; + + //Gets string representation of the name's scope for workbook + string scopeTitle = namedTitle.Scope; + + //Create a Named Range using worksheet + IName namedData = sheet.Names.Add("NamedData"); + namedData.RefersToRange = sheet.Range["A2:C3"]; + + //Gets string representation of the name's scope for worksheet + string scopeData = namedData.Scope; + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Gets/sets the comment associated with the named range. + + + To know more about Named Ranges refer this link. + + The following code illustrates use of Description property for named range. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 88; + + //Create a Named Range using workbook + IName namedTitle = workbook.Names.Add("NamedTitle"); + namedTitle.RefersToRange = sheet.Range["A1:C1"]; + + //Sets the comment associated with the named range + namedTitle.Description = "Sample Workbook Description"; + + //Create a Named Range using worksheet + IName namedData = sheet.Names.Add("NamedData"); + namedData.RefersToRange = sheet.Range["A2:C3"]; + + //sets the comment associated with the named range + namedData.Description = "Sample Worksheet Description"; + + workbook.SaveAs("NamedRange.xlsx"); + workbook.Close(); + } + + + + + + Represents default sheet name separator. + + + + + String format for cell range. + + + + + Represents removed sheet index. + + + + + String representation of the workbook scope value. + + + + + Represents valid symbols. + + + + + Name record with info about this Name object. + + + + + Parent workbook for this object. + + + + + Parent worksheet for this object. + (but NameRecord still must be in Workbook). + + + + + Index of the Name object in the Workbook's Names collection. + + + + + Indicates whether the named range is deleted or not. + + + + + + + + + + + + + + + + + + + + Specifies the comment associated with the named range. + + + + + Specifies if the name is associated with the ListObject i.e. if table name or table column name + + + + + Specifies if the name is associated with the ListObject is deleted i.e. if table name or table column name is deleted. + + + + + Specifies if the name is associated with the Formula. + + + + + Creates a new Name object. + + Application object for the new Name object. + Parent object for the new Name object. + + + + Creates a new Name object. + + Application object for the new Name object. + Parent object for the new Name object. + + NameRecord that contains information about the new Name object. + + + Index of the Name object in the workbook's Names collection. + + + + + Creates a new Name object. + + Application object for the new Name object. + Parent object for the new Name object. + + NameRecord that contains information about the new Name object. + + + + + Creates a new Name object. + + Application object for the new Name object. + Parent object for the new Name object. + Name of the new Name object. + + Range that will be associated with the specified name. + + + + + + Creates new Name object. + + Application object for the new Name object. + Parent object for the new Name object. + Name of the new Name object. + Current index. + + + + Creates new Name object. + + Application object for the new Name object. + Parent object for the new Name object. + Name of the new Name object. + Current index. + Indicates whether name is local. + + + + Creates a new Name object. + + Application object for the new Name object. + Parent object for the new Name object. + Name of the new Name object. + + Range that will be associated with the specified name. + + + + + + + Sets index or global depending on IsLocal property value. + + Indicates whether name should be local. + + + + Copies range to the clipboard. + + + + + Returns a Range object that represents a range thats offset from the specified range. + + The number of rows (positive, negative, or 0 (zero)) by which the range is to be offset + The number of columns (positive, negative, or 0 (zero)) by which the range is to be offset + + + + + Resizes the specified range + + The number of rows in new range + The number of columns in new range + + + + + This method searches for the all cells with specified TimeSpan value. + + Value to search. + All found cells, or Null if value was not found. + + + + This method searches for the all cells with specified DateTime value. + + Value to search. + All found cells, or Null if value was not found. + + + + This method searches for the all cells with specified bool value. + + Value to search. + All found cells, or Null if value was not found. + + + + This method searches for the all cells with specified double value. + + Value to search. + Flag that represent type of search. + All found cells, or Null if value was not found. + + + + This method searches for the all cells with specified string value. + + Value to search. + Flag that represent type of search. + All found cells, or Null if value was not found. + + + + This method searches for the first cell with specified TimeSpan value. + + Value to search. + First found cell, or Null if value was not found. + + + + This method searches for the first cell with specified DateTime value. + + Value to search. + First found cell, or Null if value was not found. + + + + This method searches for the first cell with specified bool value. + + Value to search. + First found cell, or Null if value was not found. + + + + This method searches for the first cell with specified double value. + + Value to search. + Flag that represent type of search. + First found cell, or Null if value was not found. + + + + This method searches for the first cell with specified string value. + + Value to search. + Flag that represent type of search. + + + + + Replaces the string with the specified string value. + + The string to be replaced. + The string to replace all occurrences of oldValue. + + + + Replaces the string with the specified string value based on the given . + + The string to be replaced. + The string to replace all occurrences of oldValue. + Specifies the find options for the oldValue. + + + + Replaces the string with the specified double value. + + The string to be replaced. + The double value to replace all occurrences of oldValue. + + + + Replaces the string with the specified DateTime value. + + The string to be replaced. + The datetime value to replace all occurrences of oldValue. + + + + Replaces the string with the specified array of string values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces the string with the specified array of int values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces the string with the specified array of double values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces the string with the specified datatable. + + The string to be replaced. + Data table with new data. + Indicates whether field name must be shown. + + + + Replaces the string with the specified datacolumn. + + The string to be replaced. + DataColumn with new data. + Indicates whether field name must be shown. + + + + Adds comment to the range. + + Range's comment. + + + + Creates a threaded comment for the current cell with the specified text. + + Threaded comment text + Optional. The creation time of the threaded comment + Returns the created instance of . + + + + Creates a threaded comment for the current cell with the specified text and author. + + Threaded comment text + The author of the threaded comment text + Optional. The creation time of the threaded comment + Returns the created instance of . + + + + Autofits all columns in the range. + + + + + Autofits all rows in the range. + + + + + Returns merge of this range with the specified one. + + The Range to merge with. + Merged ranges or NULL if wasn't able to merge ranges. + + + + Returns intersection of this range with the specified one. + + The Range with which to intersect. + Range intersection; if there is no intersection, NULL is returned. + + + + Copies this range into another location. + + Destination range. + Copy range options. + Destination range. + + + + Copies this range into another location using pasteLinkOptions. + + Destination range. + Check to implement the pasteLink option. + Destination range. + + + + Copies the range to the specified destination Range (without updating formulas). + + Destination range. + Range were this range was copied. + + + + Copies the Range to the specified destination Range with copy options and skip blank option. + + Represents the destination Range to copy. + Represents the copy Range options. + Represents the skip blank cells in the source. + Returns the copied Range. + + + + Moves the cells to the specified Range (without updating formulas). + + Destination Range. + + + + Clear the contents of the Range and shifts the cells Up or Left. + + Cells shift direction Up/Left. + Cells shifting options. + + + + Clears the Content, formats, comments based on clear option. + + + + + + Clear the contents of the Range and shifts the cells Up or Left + without formula or merged ranges update. + + Cells shift direction Up/Left. + + + + Clear the contents of the Range with formatting. + + True if formatting should also be cleared. + + + + Clear the contents of the Range. + + + + + Freezes pane at the current range. + + + + + Separates a merged area into individual cells. + + + + + Ungroups current range. + + Indicates type of ungrouping. Ungroup by columns or by rows. + Current range after ungrouping. + + + + Returns sum of numeric cells in the range. + + + + + Returns sum of numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + + + Returns average of numeric cells in the range. + + + + + Returns average of numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + + + Returns minumum value from numeric cells in the range. + + + + + Returns minumum value from numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + + + Returns maximum value from numeric cells in the range. + + + + + Returns maximum value from numeric cells in the range. + + Considers numeric value of date formatted cells for calculation. + + + + Trim the empty rows at top and bottom of the range, the empty columns at left and right of the range. + + Returns the range after trim. + + + + Creates a merged cell from the specified Range object. + + + + + Creates a merged cell from the specified Range object. + + Indicates whether to clear unnecessary cells. + + + + This method groups current range. + + + This parameter specifies whether grouping should + be performed by rows or by columns. + + Indicates whether group should be collapsed. + Current range after grouping. + + + + This method groups current range. + + + This parameter specifies whether the grouping should be performed by rows or by columns. + + Current range after grouping. + + + + Creates Subtotal for the corresponding ranges + + GroupBy + ConsolidationFunction + TotalList + + + + Creates SubTotal for the corresponding Ranges + + GroupByGroupBy + ConsolidationFunction + TotalList + Replace exisiting SubTotal + Insert PageBreaks + SummaryBelowData + + + + Creates SubTotal for the corresponding Ranges + + Columns to GroupBy + ConsolidationFunction + TotalList + Replace exisiting SubTotal + Insert PageBreaks + SummaryBelowData + + + + Activates a single cell, which must be inside the current selection. + To select a range of cells, use the Select method. + + + + + + Activates a single cell, scroll to it and activates the corresponding sheet. + To select a range of cells, use the Select method. + + True to scroll to the cell + + + + + Sets around border for current range. + + + + + Sets around border for current range. + + Represents border line. + + + + Sets around border for current range. + + Represents border line. + Represents border color. + + + + Sets around border for current range. + + Represents border line. + Represents border color as ExcelKnownColors. + + + + Sets inside border for current range. + + + + + Sets inside border for current range. + + Represents border line. + + + + Sets inside border for current range. + + Represents border line. + Represents border color. + + + + Sets inside border for current range. + + Represents border line. + Represents border color as ExcelKnownColors. + + + + Sets none border for current range. + + + + + Collapses current group. + + + This parameter specifies whether the grouping should be performed by rows or by columns. + + + + + Expands current group. + + + This parameter specifies whether the grouping should be performed by rows or by columns. + + + + + Expands current group. + + + This parameter specifies whether the grouping should be performed by rows or by columns. + + Additional option flags. + + + + Gets the dependent cells which refer to other cells. + + Returns the dependent cells or null if value was not found. + + + + Gets the dependent cells which refer to other cells. + + Indicates whether to check from other worksheets. + Returns the dependent cells with a specified bool value or null if value was not found. + + + + Gets the precedent cells which are referred by a formula in another cell. + + Returns the precedent cells or null if value was not found. + + + + Gets the precedent cells which are referred by a formula in another cell. + + Indicates whether to check from other worksheets. + Returns the precedent cells with a specified bool value or null if value was not found. + + + + Gets the direct dependent cells which refer to other cells. + + Returns the direct dependent cells or null if value was not found. + + + + Gets the direct dependent cells which refer to other cells. + + Indicates whether to check from other worksheets. + Returns the direct dependent cells with a specified bool value or null if value was not found. + + + + Gets the direct precedent cells which are referred by a formula in another cell. + + Returns the direct precedent cells or null if value was not found. + + + + Gets the direct precedent cells which are referred by a formula in another cell. + + Indicates whether to check from other worksheets. + Returns the direct precedent cells with a specified bool value or null if value was not found. + + + + Removes this Name object from the workbook's Names collection. + + + + + Sets parent workbook and worksheet. + + + When parent workbook or worksheet cannot be found. + + + + + Reads information from the NameRecord. + + NameRecord to parse + + When specified NameRecord is NULL. + + + + + This method is called when Value property was changed. + + Old value of the property. + New value of the property. + Is Value in R1C1 style. + + + + Sets name value. + + Parsed expression value to set. + + + + This method raises NameIndexChanged event. + + Event arguments. + + + + Checks for valid name. + + String to check. + If true - valid name; otherwise - not valid. + + + + Sets Value. + + New value of the property. + Is Value in R1C1 style. + + + + Converts full row or column tokens between versions. + + Version to convert into. + + + + A string containing the formula that the name is defined to refer to. + + Formula util to take setting from. + Formula string. + + + + Sets index of the named range and raise event. + + New index. + + + + Sets index of the named range. + + New index. + Indicates whether events should be raised. + + + + Saves named range into list of biff records. + + List of biff records to save into. + + + + This method should be called after worksheet index change. + + New sheet index. + + + + Updates the Renamed names in the named range collection. + + + + + Parses named range. + + + + + Gets ptg of current range. + + Returns native ptg. + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Returns an enumerator that iterates through the Range. + + + + + + Get new address + + + + + + + + Creates a new object that is a copy of the current instance. + + + + + + + + + Clears the conditional formats + + + + + Rectangles in the range + + + + + + Count of rectangles + + + + + + Name record with info about this Name object. + + + + + Indicates whether the named range is deleted or not. + + + + + Index of the Name object in the workbook's Names collection. + + + + + Index of the Name object in the workbook's or Worksheet's Names collection. + + + + + Gets or sets the name of the Name object. + + + + + Same as Name. + + + + + Gets / sets Range associated with the Name object. + + + + + For the Name object, a string containing the formula that the name is + defined to refer to. The string is in A1-style notation in the language + of the macro, without an equal sign. + + + + + Gets/sets the comment associated with the named range. + + + + + Gets/sets named range Value in R1C1 style. Read-only. + + + + + Gets/sets named range RefersTo. Read-only. + + + + + Gets/sets named range RefersToR1C1 in R1C1 style. Read-only. + + + + + Determines whether the object is visible. Read/write Boolean. + + + + + Indicates whether current name is locally defined name. Read-only. + + + + + Returns parent worksheet. Read-only. + + + + + Represents whether the named range belongs to query table + + + + + Represents the sheet index of the name + + + + + Returns string representation of the name's scope. Read-only. + + + + + Gets or sets HTML string. + + + + + Returns the range reference in the language of the macro. + Read-only String. + + + + + Returns the range reference for the specified range in the language + of the user. Read-only String. + + + + + Returns range Address in format "'Sheet1'!$A$1". + + + + + Returns range address in format "$A$1". + + + + + Returns the range reference using R1C1 notation. + Read-only String. + + + + + Returns the range reference using R1C1 notation. + Read-only String. + + + + + Gets / sets boolean value that is contained by this range. + + + + + Returns a Borders collection that represents the borders of a style + or a range of cells (including a range defined as part of a + conditional format). + + + + + Returns a Range object that represents the cells in the specified range. + Read-only. + + + + + Returns the number of the first column in the first area in the specified + range. Read-only. + + + + + Column group level. Read-only. + -1 - Not all columns in the range have same group level. + 0 - No grouping, + 1 - 7 - Group level. + + + + + Returns or sets the width of all columns in the specified range. + Read/write Double. + + + + + Returns the number of objects in the collection. Read-only. + + + + + Gets / sets DateTime contained by this cell. Read-write DateTime. + + + + + Returns cell value after number format application. Read-only. + + + + + Returns a Range object that represents the cell at the end of the + region that contains the source range. + + + + + Returns a Range object that represents the entire column (or + columns) that contains the specified range. Read-only. + + + + + Returns a Range object that represents the entire row (or + rows) that contains the specified range. Read-only. + + + + + Gets / sets error value that is contained by this range. + + + + + Returns or sets the object's formula in A1-style notation and in + the language of the macro. Read/write Variant. + + + + + Represents array-entered formula. + + + + + Returns or sets the formula array for the range, using R1C1-style notation. + + + + + True if the formula will be hidden when the worksheet is protected. + False if at least part of formula in the range is not hidden. + + + + + Get / set formula DateTime value contained by this cell. + DateTime.MinValue if not all cells of the range have same DateTime value. + + + + + Returns or sets the formula for the range, using R1C1-style notation. + + + + + Indicates whether specified range object has data validation. + If Range is not single cell, then returns true only if all cells have data validation. Read-only. + + + + + Indicates whether range contains bool value. Read-only. + + + + + Indicates whether range contains DateTime value. Read-only. + + + + + Indicates if current range has formula bool value. Read-only. + + + + + Indicates if current range has formula error value. Read-only. + + + + + Indicates if current range has formula value formatted as DateTime. Read-only. + + + + + Indicates if current range has formula value formatted as number. Read-only. + + + + + Indicates if current range has formula value formatted as string. Read-only. + + + + + True if all cells in the range contain formulas; False if + at least one of the cells in the range doesn't contain a formula. + Read-only Boolean. + + + + + Indicates whether range contains array-entered formula. Read-only. + + + + + Indicates whether the range contains number. Read-only. + + + + + Indicates whether cell contains formatted rich text string. + + + + + Indicates whether the range contains String. Read-only. + + + + + Indicates whether range has default style. False means default style. + Read-only. + + + + + Returns hyperlinks for this name. + + + + + Returns or sets the horizontal alignment for the specified object. + Read/write ExcelHAlign. + + + + + Returns or sets the indent level for the cell or range. Can be an + integer from 0 to 15. Read/write Integer. + + + + + Indicates whether the range is blank. Read-only. + + + + + Indicates whether range contains boolean value. Read-only. + + + + + Indicates whether range contains error value. + + + + + Indicates whether this range is grouped by column. Read-only. + + + + + Indicates whether this range is grouped by row. Read-only. + + + + + Indicates whether cell is initialized. Read-only. + + + + + Returns last column of the range. Read-only. + + + + + Returns last row of the range. Read-only. + + + + + Gets / sets double value of the range. + + + + + Format of current cell. Analog of Style.NumberFormat property. + + + + + Returns the number of the first row of the first area in + the range. Read-only Long. + + + + + Row group level. Read-only. + -1 - Not all rows in the range have same group level. + 0 - No grouping, + 1 - 7 - Group level. + + + + + Returns the height of all the rows in the range specified, + measured in points. Returns Double.MinValue if the rows in the specified range + aren't all the same height. Read / write Double. + + + + + For a Range object, returns an array of Range objects that represent the + rows in the specified range. + + + + + For a Range object, returns an array of Range objects that represent the + columns in the specified range. + + + + + Returns a Style object that represents the style of the specified + range. Read/write IStyle. + + + + + Returns name of the Style object that represents the style of the specified + range. Read/write String. + + + + + Gets / sets string value of the range. + + + + + Gets / sets time value of the range. + + + + + Returns or sets the value of the specified range. + Read/write Variant. + + + + + Returns the calculated value of a formula using the most current inputs. + + + + + Returns or sets the cell value. Read/write Variant. + The only difference between this property and the Value property is + that the Value2 property doesn't use the Currency and Date data types. + + + + + Returns or sets the vertical alignment of the specified object. + Read/write ExcelVAlign. + + + + + Returns a Worksheet object that represents the worksheet + containing the specified range. Read-only. + + + + + Collection of conditional formats. + + + + + Data validation for the range. + + + + + Gets / sets string value evaluated by formula. + + + + + Gets / sets number value evaluated by formula. + + + + + Returns the calculated value of the formula as a boolean. + + + + + Returns the calculated value of the formula as a string. + + + + + Comment assigned to the range. Read-only. + + + + + Get the threaded comment. + + + + + String with rich text formatting. Read-only. + + + + + Indicates whether this range is part of merged range. Read-only. + + + + + Returns a Range object that represents the merged range containing + the specified cell. If the specified cell isn�t in a merged range, + this property returns NULL. Read-only. + + + + + True if Microsoft Excel wraps the text in the object. + Read/write Boolean. + + + + + Gets / sets cell by row and column index. Row and column indexes are one-based. + + + + + Get cell range. Row and column indexes are one-based. Read-only. + + + + + Get cell range. Read-only. + + + + + Gets cell range. Read-only. + + + + + Indicates is current range has external formula. Read-only. + + + + + Represents ignore error options. If not single cell returs concatenated flags. + + + + + Indicates whether all values in the range are preserved as strings. + + + + + Gets/sets built in style. + + + + + Get NameRecord to which point current object. + + + + + Get worksheet of Name Object. + + + + + Get workbook of Name Object. + + + + + Indicates whether the name is extern name. + + + + + Name region. + + + + + Indicates whether name is built-in or not. + + + + + Returns count of event handlers for NameIndexChanged event. Read-only. + + + + + Indicates whether this is function. + + + + + Gets or sets a value indicating whether this instance is num reference for chart axis. + + + true if this instance is num reference; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is a string reference for chart axis. + + + true if this instance is string reference; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is multi reference for chart axis. + + + true if this instance is multi reference; otherwise, false. + + + + + It's used to identify the common workbook Names + + + + + Utility event. Raised on Name object index property change. + + + + + Number of cells in the range + + + + + Gets address global in the format required by Excel 2007. + + + + + Gets name of the parent worksheet. + + + + + + + + + + Event arguments for NameIndexChanged event. + + + + + Old index. + + + + + New index. + + + + + To prevent creation without parameters. + + + + + Creates new instance of the event arguments. + + Old index. + New index. + + + + Returns old index. Read-only. + + + + + Returns new index. Read-only. + + + + + Represents the description for headers and footers + + + + + Base interface for Page class. + + + + + Gets or sets left part of header. Read/write string + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of LeftHeader property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.PageSetup.DifferentFirstPageHF = true; + + //sets left part of header + sheet.PageSetup.FirstPage.LeftHeader = "Left Header &G"; + sheet.PageSetup.FirstPage.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + + sheet.PageSetup.FirstPage.CenterFooter = "Center Footer &G"; + sheet.PageSetup.FirstPage.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.FirstPage.CenterHeader = "Center Header &G"; + sheet.PageSetup.FirstPage.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.FirstPage.LeftFooter = "Left Footer &G"; + sheet.PageSetup.FirstPage.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + sheet.PageSetup.FirstPage.RightFooter = "Right Footer &G"; + sheet.PageSetup.FirstPage.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + sheet.PageSetup.FirstPage.RightHeader = "Right Header &G"; + sheet.PageSetup.FirstPage.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets center part of header. Read/write string + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of CenterHeader property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.PageSetup.DifferentFirstPageHF = true; + + //sets center part of header + sheet.PageSetup.FirstPage.CenterHeader = "Center Header &G"; + sheet.PageSetup.FirstPage.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + + sheet.PageSetup.FirstPage.LeftHeader = "Left Header &G"; + sheet.PageSetup.FirstPage.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.FirstPage.CenterFooter = "Center Footer &G"; + sheet.PageSetup.FirstPage.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.FirstPage.LeftFooter = "Left Footer &G"; + sheet.PageSetup.FirstPage.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + sheet.PageSetup.FirstPage.RightFooter = "Right Footer &G"; + sheet.PageSetup.FirstPage.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + sheet.PageSetup.FirstPage.RightHeader = "Right Header &G"; + sheet.PageSetup.FirstPage.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets right part of header. Read/write string + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of RightHeader property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.PageSetup.DifferentFirstPageHF = true; + + //sets right part of header + sheet.PageSetup.FirstPage.RightHeader = "Right Header &G"; + sheet.PageSetup.FirstPage.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + + sheet.PageSetup.FirstPage.CenterHeader = "Center Header &G"; + sheet.PageSetup.FirstPage.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.FirstPage.LeftHeader = "Left Header &G"; + sheet.PageSetup.FirstPage.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.FirstPage.CenterFooter = "Center Footer &G"; + sheet.PageSetup.FirstPage.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.FirstPage.LeftFooter = "Left Footer &G"; + sheet.PageSetup.FirstPage.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + sheet.PageSetup.FirstPage.RightFooter = "Right Footer &G"; + sheet.PageSetup.FirstPage.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets left part of footer. Read/write string + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of LeftFooter property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.PageSetup.DifferentFirstPageHF = true; + + //sets left part of footer + sheet.PageSetup.FirstPage.LeftFooter = "Left Footer &G"; + sheet.PageSetup.FirstPage.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + + sheet.PageSetup.FirstPage.RightHeader = "Right Header &G"; + sheet.PageSetup.FirstPage.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + sheet.PageSetup.FirstPage.CenterHeader = "Center Header &G"; + sheet.PageSetup.FirstPage.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.FirstPage.LeftHeader = "Left Header &G"; + sheet.PageSetup.FirstPage.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.FirstPage.CenterFooter = "Center Footer &G"; + sheet.PageSetup.FirstPage.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.FirstPage.RightFooter = "Right Footer &G"; + sheet.PageSetup.FirstPage.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets center part of footer. Read/write string + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of CenterFooter property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.PageSetup.DifferentFirstPageHF = true; + + //sets center part of footer + sheet.PageSetup.FirstPage.CenterFooter = "Center Footer &G"; + sheet.PageSetup.FirstPage.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + + sheet.PageSetup.FirstPage.RightHeader = "Right Header &G"; + sheet.PageSetup.FirstPage.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + sheet.PageSetup.FirstPage.CenterHeader = "Center Header &G"; + sheet.PageSetup.FirstPage.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.FirstPage.LeftHeader = "Left Header &G"; + sheet.PageSetup.FirstPage.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.FirstPage.LeftFooter = "Left Footer &G"; + sheet.PageSetup.FirstPage.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + sheet.PageSetup.FirstPage.RightFooter = "Right Footer &G"; + sheet.PageSetup.FirstPage.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets right part of footer. Read/write string + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of RightFooter property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.PageSetup.DifferentFirstPageHF = true; + + //sets right part of footer + sheet.PageSetup.FirstPage.RightFooter = "Right Footer &G"; + sheet.PageSetup.FirstPage.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + + sheet.PageSetup.FirstPage.CenterFooter = "Center Footer &G"; + sheet.PageSetup.FirstPage.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.FirstPage.RightHeader = "Right Header &G"; + sheet.PageSetup.FirstPage.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + sheet.PageSetup.FirstPage.CenterHeader = "Center Header &G"; + sheet.PageSetup.FirstPage.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.FirstPage.LeftHeader = "Left Header &G"; + sheet.PageSetup.FirstPage.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.FirstPage.LeftFooter = "Left Footer &G"; + sheet.PageSetup.FirstPage.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets image for left part of header. + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of LeftHeaderImage property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.PageSetup.DifferentFirstPageHF = true; + + //sets the image for left part of header + sheet.PageSetup.FirstPage.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.FirstPage.LeftHeader = "Left Header &G"; + + sheet.PageSetup.FirstPage.CenterFooter = "Center Footer &G"; + sheet.PageSetup.FirstPage.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.FirstPage.CenterHeader = "Center Header &G"; + sheet.PageSetup.FirstPage.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.FirstPage.LeftFooter = "Left Footer &G"; + sheet.PageSetup.FirstPage.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + sheet.PageSetup.FirstPage.RightFooter = "Right Footer &G"; + sheet.PageSetup.FirstPage.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + sheet.PageSetup.FirstPage.RightHeader = "Right Header &G"; + sheet.PageSetup.FirstPage.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets image for center part of header. + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of CenterHeaderImage property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.PageSetup.DifferentFirstPageHF = true; + + //sets the image for center part of header + sheet.PageSetup.FirstPage.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.FirstPage.CenterHeader = "Center Header &G"; + + sheet.PageSetup.FirstPage.LeftHeader = "Left Header &G"; + sheet.PageSetup.FirstPage.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.FirstPage.CenterFooter = "Center Footer &G"; + sheet.PageSetup.FirstPage.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.FirstPage.LeftFooter = "Left Footer &G"; + sheet.PageSetup.FirstPage.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + sheet.PageSetup.FirstPage.RightFooter = "Right Footer &G"; + sheet.PageSetup.FirstPage.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + sheet.PageSetup.FirstPage.RightHeader = "Right Header &G"; + sheet.PageSetup.FirstPage.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets image for right part of header. + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of RightHeaderImage property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.PageSetup.DifferentFirstPageHF = true; + + //sets the image for right part of header + sheet.PageSetup.FirstPage.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + sheet.PageSetup.FirstPage.RightHeader = "Right Header &G"; + + sheet.PageSetup.FirstPage.CenterHeader = "Center Header &G"; + sheet.PageSetup.FirstPage.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.FirstPage.LeftHeader = "Left Header &G"; + sheet.PageSetup.FirstPage.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.FirstPage.CenterFooter = "Center Footer &G"; + sheet.PageSetup.FirstPage.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.FirstPage.LeftFooter = "Left Footer &G"; + sheet.PageSetup.FirstPage.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + sheet.PageSetup.FirstPage.RightFooter = "Right Footer &G"; + sheet.PageSetup.FirstPage.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets image for left part of footer. + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of LeftFooterImage property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.PageSetup.DifferentFirstPageHF = true; + + //sets the image for left part of footer + sheet.PageSetup.FirstPage.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + sheet.PageSetup.FirstPage.LeftFooter = "Left Footer &G"; + + sheet.PageSetup.FirstPage.RightHeader = "Right Header &G"; + sheet.PageSetup.FirstPage.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + sheet.PageSetup.FirstPage.CenterHeader = "Center Header &G"; + sheet.PageSetup.FirstPage.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.FirstPage.LeftHeader = "Left Header &G"; + sheet.PageSetup.FirstPage.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.FirstPage.CenterFooter = "Center Footer &G"; + sheet.PageSetup.FirstPage.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.FirstPage.RightFooter = "Right Footer &G"; + sheet.PageSetup.FirstPage.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets image for center part of footer. + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of CenterFooterImage property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.PageSetup.DifferentFirstPageHF = true; + + //sets the image for center part of footer + sheet.PageSetup.FirstPage.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.FirstPage.CenterFooter = "Center Footer &G"; + + sheet.PageSetup.FirstPage.RightHeader = "Right Header &G"; + sheet.PageSetup.FirstPage.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + sheet.PageSetup.FirstPage.CenterHeader = "Center Header &G"; + sheet.PageSetup.FirstPage.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.FirstPage.LeftHeader = "Left Header &G"; + sheet.PageSetup.FirstPage.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.FirstPage.LeftFooter = "Left Footer &G"; + sheet.PageSetup.FirstPage.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + sheet.PageSetup.FirstPage.RightFooter = "Right Footer &G"; + sheet.PageSetup.FirstPage.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets image for right part of footer. + + + &L Left aligns the characters that follow. + &C Centers the characters that follow. + &R Right aligns the characters that follow. + &E Turns double-underline printing on or off. + &X Turns superscript printing on or off. + &Y Turns subscript printing on or off. + &B Turns bold printing on or off. + &I Turns italic printing on or off. + &U Turns underline printing on or off. + &S Turns strikethrough printing on or off. + &D Prints the current date. + &T Prints the current time. + &F Prints the name of the document. + &A Prints the name of the workbook tab. + &P Prints the page number. + &P+number Prints the page number plus the specified number. + &P-number Prints the page number minus the specified number. + && Prints a single ampersand. + & "fontname" Prints the characters that follow in the specified font. Be sure to include the double quotation marks. + &nn Prints the characters that follow in the specified font size. Use a two-digit number to specify a size in points. + &N Prints the total number of pages in the document. + To know more about page settings refer this link. + + The following code illustrates the use of RightFooterImage property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:T100"].Text = "PagePrint"; + sheet.PageSetup.DifferentFirstPageHF = true; + + //sets the image for right part of footer + sheet.PageSetup.FirstPage.RightFooterImage = System.Drawing.Image.FromFile("sample5.jpg"); + sheet.PageSetup.FirstPage.RightFooter = "Right Footer &G"; + + sheet.PageSetup.FirstPage.CenterFooter = "Center Footer &G"; + sheet.PageSetup.FirstPage.CenterFooterImage = System.Drawing.Image.FromFile("sample1.jpg"); + sheet.PageSetup.FirstPage.RightHeader = "Right Header &G"; + sheet.PageSetup.FirstPage.RightHeaderImage = System.Drawing.Image.FromFile("sample6.jpg"); + sheet.PageSetup.FirstPage.CenterHeader = "Center Header &G"; + sheet.PageSetup.FirstPage.CenterHeaderImage = System.Drawing.Image.FromFile("sample2.jpg"); + sheet.PageSetup.FirstPage.LeftHeader = "Left Header &G"; + sheet.PageSetup.FirstPage.LeftHeaderImage = System.Drawing.Image.FromFile("sample4.jpg"); + sheet.PageSetup.FirstPage.LeftFooter = "Left Footer &G"; + sheet.PageSetup.FirstPage.LeftFooterImage = System.Drawing.Image.FromFile("sample3.jpg"); + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Indicates whether the page is EvenPage + + + + + Indicates whether the page is FirstPage + + + + + Parent sheet. + + + + + Page setup for sheet. + + + + + Value of the header string limit + + + + + Value of the footer string limit + + + + + Array of headers: 0 - left header, 1 - center header, 2 - right header. + + + + + Array of footers: 0 - left footer, 1 - center footer, 2 - right footer. + + + + + Name of the shape with header image. + + + + + Name of the shape with footer image. + + + + + + + + + + Initializes new instance of page. + + Worksheet object for the page setup. + + + + This method is called after changes to the page setup. + Sets Saved property of the parent workbook to the False state. + + + + + Clone current instance + + + Copy of current instance + + + + Disposes all the fields used . + + + + + Represents whether the page is Even Page. + + + + + Represents whether the page is First Page. + + + + + Gets or sets the left part of the header. Read/write String. + + + Special Formatting symbols: + &P Current page number + &N Page count + &D Current date + &T Current time + &A Sheet name (BIFF5-BIFF8) + &F File name without path + &Z File path without file name (BIFF8X) + &G Picture (BIFF8X) + &B Bold on/off (BIFF2-BIFF4) + &I Italic on/off (BIFF2-BIFF4) + &U Underlining on/off + &E Double underlining on/off (BIFF5-BIFF8) + &S Strikeout on/off + &X Superscript on/off (BIFF5-BIFF8) + &Y Subscript on/off (BIFF5-BIFF8) + &"[FONTNAME]" Set new font [FONTNAME] + &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. + The style [fontstyle] is in most cases one of Regular, Bold, Italic, + or Bold Italic. But this setting is dependent on the used font, it may + differ (localised style names, or Standard, Oblique, ...). (BIFF5-BIFF8) + &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). + If this command is followed by a plain number to be printed in the header, + it will be separated from the font height with a space character. + + + + + Gets or sets the left part of the footer. Read/write String. + + + Special Formatting symbols: + &P Current page number + &N Page count + &D Current date + &T Current time + &A Sheet name (BIFF5-BIFF8) + &F File name without path + &Z File path without file name (BIFF8X) + &G Picture (BIFF8X) + &B Bold on/off (BIFF2-BIFF4) + &I Italic on/off (BIFF2-BIFF4) + &U Underlining on/off + &E Double underlining on/off (BIFF5-BIFF8) + &S Strikeout on/off + &X Superscript on/off (BIFF5-BIFF8) + &Y Subscript on/off (BIFF5-BIFF8) + &"[FONTNAME]" Set new font [FONTNAME] + &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. + The style [fontstyle] is in most cases one of Regular, Bold, Italic, + or Bold Italic. But this setting is dependent on the used font, it may + differ (localized style names, or Standard, Oblique, ...). (BIFF5-BIFF8) + &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). + If this command is followed by a plain number to be printed in the header, + it will be separated from the font height with a space character. + + + + + Gets or sets the center part of the header. Read/write String. + + + Special Formatting symbols: + &P Current page number + &N Page count + &D Current date + &T Current time + &A Sheet name (BIFF5-BIFF8) + &F File name without path + &Z File path without file name (BIFF8X) + &G Picture (BIFF8X) + &B Bold on/off (BIFF2-BIFF4) + &I Italic on/off (BIFF2-BIFF4) + &U Underlining on/off + &E Double underlining on/off (BIFF5-BIFF8) + &S Strikeout on/off + &X Superscript on/off (BIFF5-BIFF8) + &Y Subscript on/off (BIFF5-BIFF8) + &"[FONTNAME]" Set new font [FONTNAME] + &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. + The style [fontstyle] is in most cases one of Regular, Bold, Italic, + or Bold Italic. But this setting is dependent on the used font, it may + differ (localised style names, or Standard, Oblique, ...). (BIFF5-BIFF8) + &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). + If this command is followed by a plain number to be printed in the header, + it will be separated from the font height with a space character. + + + + + Gets or sets the center part of the footer. Read / write String. + + + Special Formatting symbols: + &P Current page number + &N Page count + &D Current date + &T Current time + &A Sheet name (BIFF5-BIFF8) + &F File name without path + &Z File path without file name (BIFF8X) + &G Picture (BIFF8X) + &B Bold on/off (BIFF2-BIFF4) + &I Italic on/off (BIFF2-BIFF4) + &U Underlining on/off + &E Double underlining on/off (BIFF5-BIFF8) + &S Strikeout on/off + &X Superscript on/off (BIFF5-BIFF8) + &Y Subscript on/off (BIFF5-BIFF8) + &"[FONTNAME]" Set new font [FONTNAME] + &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. + The style [fontstyle] is in most cases one of Regular, Bold, Italic, + or Bold Italic. But this setting is dependent on the used font, it may + differ (localised style names, or Standard, Oblique, ...). (BIFF5-BIFF8) + &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). + If this command is followed by a plain number to be printed in the header, + it will be separated from the font height with a space character. + + + + + Gets or sets the right part of the header. Read / write String. + + + Special Formatting symbols: + &P Current page number + &N Page count + &D Current date + &T Current time + &A Sheet name (BIFF5-BIFF8) + &F File name without path + &Z File path without file name (BIFF8X) + &G Picture (BIFF8X) + &B Bold on/off (BIFF2-BIFF4) + &I Italic on/off (BIFF2-BIFF4) + &U Underlining on/off + &E Double underlining on/off (BIFF5-BIFF8) + &S Strikeout on/off + &X Superscript on/off (BIFF5-BIFF8) + &Y Subscript on/off (BIFF5-BIFF8) + &"[FONTNAME]" Set new font [FONTNAME] + &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. + The style [fontstyle] is in most cases one of Regular, Bold, Italic, + or Bold Italic. But this setting is dependent on the used font, it may + differ (localised style names, or Standard, Oblique, ...). (BIFF5-BIFF8) + &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). + If this command is followed by a plain number to be printed in the header, + it will be separated from the font height with a space character. + + + + + Gets or sets the right part of the footer. Read / write String. + + + Special Formatting symbols: + &P Current page number + &N Page count + &D Current date + &T Current time + &A Sheet name (BIFF5-BIFF8) + &F File name without path + &Z File path without file name (BIFF8X) + &G Picture (BIFF8X) + &B Bold on/off (BIFF2-BIFF4) + &I Italic on/off (BIFF2-BIFF4) + &U Underlining on/off + &E Double underlining on/off (BIFF5-BIFF8) + &S Strikeout on/off + &X Superscript on/off (BIFF5-BIFF8) + &Y Subscript on/off (BIFF5-BIFF8) + &"[FONTNAME]" Set new font [FONTNAME] + &"[FONTNAME],[FONTSTYLE]" Set new font with specified style [FONTSTYLE]. + The style [fontstyle] is in most cases one of Regular, Bold, Italic, + or Bold Italic. But this setting is dependent on the used font, it may + differ (localised style names, or Standard, Oblique, ...). (BIFF5-BIFF8) + &[FONTHEIGHT] Set font height in points ([FONTHEIGHT] is a decimal value). + If this command is followed by a plain number to be printed in the header, + it will be separated from the font height with a space character. + + + + + Gets / set image for left part of the header. + + + + + Gets / set image for left part of the footer. + + + + + Gets / set image for center part of the header. + + + + + Gets / set image for center part of the footer. + + + + + Gets / set image for right part of the header. + + + + + Gets / set image for right part of the footer. + + + + + Stores the whole string value in Header.(left/center/right) + + + + + Stores the whole string value in footer.(left/center/right) + + + + + This Class allows the user to configure Print settings of a document. + + + + + Represents default print area. + + + + + Represents default print title. + + + + + Represents default print area tokens. + + + + + This record contains information as to whether or not the the row/column headers have to be printed. + + + + + This record defines whether or not to print the gridlines. + + + + + This record specifies if the option to print sheet grid lines + (PrintGridlinesRecord)has ever been changed. + + + + + Contains information about the layout of outline symbols. + + + + + Row height for rows with undefined or inexplicitly defined heights. + + + + + This record stores a 16-bit value with Boolean options for the current sheet. + + + + + Parent worksheet for this page setup. + + + + + Represents horizontal page break. + + + + + Represents vertical page break. + + + + + Id of the printer settings part. + + + + + + Size of the required storage space. Read-only. + + Represents Excel version. + + + + Sets application and parent fields. + + Application object for the page setup. + Parent object for the page setup. + + + + Recovers page setup from the stream and sets its Application and Parent fields. + Current record in the stream must be PrintHeadersRecord. + + Application object for the page setup. + Parent object for the page setup. + BiffReader that contains page setup records. + + + + Recovers Page setup from the Biff Records array starting from position + + Application object for the page setup. + Parent object for the page setup. + Array of Biff Records that contains all needed records. + Position of PrintHeadersRecord in the array. + + + + Recovers Page setup from the Biff Records List starting from position. + + Application object for the page setup. + Parent object for the page setup. + List which contains Biff Records. + Position of PrintHeadersRecord in the array. + + + + Find parent worksheet. + + + When can't find parent worksheet. + + + + + Creates necessary records. + + + + + Parses record. + + Record to parse. + True if record was successfully parsed, false otherwise. + + + + Recovers page setup from the stream, first record must be PrintHeadersRecord. + + Stream that contains all needed records. + + + + Skips unknown records. + + Data with records. + Starting position. + + + + Serializes some records before main page setup block. + + OffsetArrayList to serialize into. + + + + Fills stream with some records before main page setup records. + + Writer to write records into. + Object that gives access to the temporary buffer. + Object to encrypt data. + Position in the output stream. Used to increase performance. + Size of the serialized data. + + + + Fills internal guts record with information from Rows + and ColumnInfo records. + + + + + Initialize collections. + + + + + Converts cell range to 3d Range name. + + cell range. + 3d range name. + + + + Converts cell range to Range name. + + cell range. + Indicates Whether Row range or Column range is needed. + Range name. + + + + Parses print area expression. + + Value representing print area. + + + + Parses column print title string and makes appropriate changes to default title named range. + + Column print title string to set. + + + + Parses row print title string and makes appropriate changes to default title named range. + + Row print title string to set. + + + + Extracts print area string. + + Print area string. + + + + Extracts row or column print title from default title named range. + + Defines which print title must be extracted. + Row/column print title string. + + + + Returns global address without sheet name. + + Formula token. + Global address without sheet name. + + + + Creates copy of the current instance. + + Parent for the new instance. + A clone of the current instance. + + + + Dispose Page Setup + + + + + True if cell gridlines are printed on the page. Applies only to + worksheets. Read/write Boolean. + + + To know more about page settings refer this link. + + The following code illustrates the use of PrintGridlines property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1:M20"].Text = "PagePrint"; + sheet.Range["A1:M1"].Text = "Page"; + sheet.Range["C1:C20"].Text = "Page"; + + //True to cell gridlines are printed on the page + sheet.PageSetup.PrintGridlines = true; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + True if row and column headings are printed with this page. Applies + only to worksheets. Read/write Boolean. + + + + + Gets horizontal page break. + + + + + Gets vertical page break. + + + + + Returns or sets the range to be printed, as a string using A1-style + references in the language of the macro. Read/write String. + + + + + Returns or sets the columns that contain the cells to be repeated + on the left side of each page, as a string in A1-style notation + in the language of the macro. Read/write String. + + + + + Returns or sets the rows that contain the cells to be repeated at + the top of each page, as a string in A1-style notation in the + language of the macro. Read/write String. + + + + + Indicates whether fit to page mode is selected. + + + + + Indicates whether summary rows will appear below detail in outlines. + + + + + Indicates whether summary columns will appear right of the detail in outlines. + + + + + Gets / sets default row height. + + + + + Gets / sets default row height option flag. + + + + + Gets / sets relation id to the printer settings part. + + + + + Returns parent worksheet. Read-only. + + + + + Represents single pivot field in the pivot cache. + + + + + Represents the Maximum number of character supported by cache field string value. + + + + + Main field record. + + + + + Type id. + + + + + List with fields data. + + + + + Represents an item within a PivotTable field that uses a formula + + + + + Index in the pivot caches collection. + + + + + Type of the field's data. + + + + + Specifies a boolean value that indicates whether this field came from the source + database + + + + + Specifies the formula for the calculated field + + + + + Represents the field group + + + + + Specifies the caption of the cache field + + + + + Specifies the number format that is applied to all items in the field + + + + + Field group index + + + + + Represents the hierarchy that this field is part of. + + + + + Specifies the hierarchy level that this field is part of. + + + + + Indicates whether the shared items are parsed. + + + + + Represents the Fields items range. + + + + + Represents the list of field items. + + + + + Specifies a boolean value that indicates whether this field has Member Property + database + + + + + Specifies a boolean value that indicates whether this field has mixed type + + + + + Represents the parent field of cache field. + + + + + Initializes a new instance of Pivot cache field. + + + + + Initializes a new instance of pivot cache field and extracts its values from BiffReader. + + Reader to get data from. + + + + Gets item at the specified index. + + Index of the value to get. + Requested value. + + + + Fills field with data. + + Worksheet to get data from. + First row of the source data. + Last row of the source data. + Column index of the source data. + + + + Adds new value to the cache. + + Value to add. + + + + Parses pivot cache field. + + Reader to extract data from. + + + + Serializes pivot cache field into list of Biff records. + + OffsetArrayList to serialize into. + + + + Returns Biff record that corresponds to the specified value. + + Value to get record for. + Created record that contains specified value. + + + + Gets or sets the formula for the calculated field + + + + + Gets or sets a Boolean value indicating whether this field came from the source + database. + + + + + True if the cache field is present in the index list. False otherwise. + + + + + True if the cache field is a double value. False otherwise. + + + + + True if the cache field is a double or int value. False otherwise. + + + + + True if the cache field is a string. False otherwise. + + + + + True if the cache field is unknown. False Otherwise. + + + + + True if the cache field has a long index. False otherwise. + + + + + True if the cache field is unknown2. False Otherwise. + + + + + True if the cache filed is a date. False otherwise. + + + + + Gets the items in the pivot cache field. Read-only. + + + + + Gets or sets teh anme of the pivot cache field. + + + + + Gets or sets the index of this field in the parent collection. + + + + + Gets the type of the field's data. Read-only. + + + + + True if the cache field is formula field. False otherwise. + + + + + Represents the Field group in the Cache Field + + + + + Gets or sets the caption of the cache field. + + + + + Gets or sets the number format that is applied to all items in the field. + + + + + Gets items within a PivotTable field that uses formula. + + + + + Gets or sets the field group index. + + + + + True if the cache field is Field group. False otherwise. + + + + + Represents the hierarchy that this field is part of. + + + + + Specifies the hierarchy level that this field is part of. + + + + + Gets or sets a Boolean value indicating whether the shared items are parsed. + + + + + Represents the Fields items range. + + + + + Gets the field items. + + + + + Specifies a boolean value that indicates whether this field has property field + database + + + + + Specifies a boolean value that indicates whether this field has mixed type + + + + + Gets or sets the parent field. + + + + + Represents a single pivot cache. + + + + + Main cache record. + + + + + Cache data extended record. + + + + + Array of all unparsed cache records. + + + + + Stream with preserved data. + + + + + List with cached fields. + + + + + Indixes to the pivto values. Each item contains indexes to the pivot cache field data for corresponding row. + + + + + Contains source range. + + + + + Contains the name of the pivot cache NamedRange + + + + + Cache index. + + + + + Contains additional information regarding pivot cache. + + + + + Specifies whether the cache's data source supports attribute drilldown. + + + + + Specifies the version of the application that created the cache. This attribute is + application-dependent. + + + + + Specifies the earliest version of the application that is required to refresh the cache. + + + + + Specifies the version of the application that last refreshed the cache. + + + + + Specifies whether the cache's data source supports subqueries + + + + + Specifies a boolean value that indicates whether the cache is scheduled for version + upgrade. + + + + + Preserved XlsIO unsupported elements + + + + + Presreved the Extenal cache source relations + + + + + External cache source relation ID. + + + + + Indicates wheather the pivot cache has records. + + + + + Specifies the preserved cache relations of Consolidation source. + + + + + Stream which preserves the consolidation source of the pivot table. + + + + + Indicates whether the pivot cache has missing items. + + + + + Indicates whether the pivot cache has tuple cache. + + + + + Indicates whether the pivot cache has seriealize or not. + + + + + Indicates whether the pivot cache has slicer or not. + + + + + Initianlizes a new instance of pivot cache class with the specified application and parent objects. + + Reference to Application instance. + + Reference to the Parent object which will host this object + + + If specified application or parent is null. + + + + + Initializes a new instance of pivot cache class with the specified reader to get pivot cache records from. + + Reference to Application instance. + + Reference to the Parent object which will host this object. + + Reader to get pivot cache records from. + Object used to decrypt encrypted records. + + If at least one of arguments is Null. + + + + + Initializes new instance of the cache at the specified range in the worksheet. + + Reference to Application instance. + + Reference to the Parent object which will host this object. + + Range object containing cached data. + + + + Creates cached field. + + Worksheet to create cache for. + First row to get data from. + Last row of the field. + Column index. + + + + Adds the specified array of pivot cache indexes. + + + + + + + Returns the field value based on the specified field and row indexes. + + Field index. + Row index. + Extracted value. + + + + Sets the specified field value at the specified field index. + + + + + + + + Parses pivot cache. + + Records with pivot table cache. + Offset to the first pivot cache record. + Offset to the record after cache records. + + + + Parses data from BiffReader. + + BiffReader with data to parse. + Object used to decrypt encrypted records. + Represent the pivot cache stream code + (helps to preserve unknown pivot cache streams) + + + + Saves pivot cache into OffsetArrayList. + + OffsetArrayList that will get all pivot cache records. + + + + Saves pivot cache into stream using specified encryptor. + + Stream to save into. + Encryptor to use. + + + + Update pivot cache after row/column insert operation. + + + + + + + + + Indicates whether specified insert row/column operation affected pivot cache in some way. + + + + + + + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Creates a new object that is a copy of the current instance with the specified + dictionary containing names in the workbook. + + Parent object for a copy of this instance. + Dictionary containing names in the workbook. + A new object that is a copy of this instance. + + + + Compare preserved data with the specified cache data. + + Pivot cache object with which the preserved data is compared. + True if the preserved data is equal to the specified cache data. False otherwise. + + + + Returns the size of the required storage space. Read-only. + + ExcelVersion of this workbook. + Number of bytes indicating the required storage space. + + + + Saves the pivot cache record data to stream. + + Writer that will receive record data. + Object that provides access to the data. + Object to encrypt data. + Position in the output stream. Used to increase performance. + Size of the record. + If writer is NULL. + + If m_iLength of internal record data array is less than zero. + + + + + Get or set the indicate whether the pivot cache has serialize or not. + + + + + Get or set the indicate whether the pivot cache has slicer or not. + + + + + Gets the stream id of the pivot cache. + + + + + Gets or sets the pivot table cache source type. + + + + + True if the cache is scheduled for version + upgrade. False otherwise. + + + + + Gets or sets the user name who last refreshed pivot cache. + + + + + True if the cache's data source supports subqueries. False otherwise. + + + + + Gets or sets a Boolean value indicating whether the pivot records are saved with the + cache. + + + + + Gets or sets a boolean value indicating whether the application will apply optimizations + to the cache to reduce memory usage. + + + + + Gets or sets a Boolean value indicating whether the user can refresh the cache. + + + + + Gets or sets a Boolean value indicating whether the application should query and + retrieve records asynchronously from the cache. + + + + + Gets or sets the the version of the application that created the cache. This attribute is + application-dependent. + + + + + Gets or sets the earliest version of the application that is required to refresh the cache. + + + + + Gets or sets the version of the application that last refreshed the cache. This attribute + depends on whether the application exposes mechanisms via the user interface whereby + the end-user can refresh the cache. + + + + + Gets or sets a Boolean value indicating whether the cache needs to be refreshed. + + + + + True if the the cache's data source supports attribute drilldown. False otherwise. + + + + + Gets or sets a Boolean value indicating whether the application will refresh the cache. + + + + + Gets or sets refresh date of the cache. + + + + + Gets the number of records inside this cache. + + + + + Gets or sets the stream which preserves the consolidation source of the pivot table. + + + + + Gets or sets the data source for the PivotTable report. + + + + + Gets collection of cache fields. Read-only. + + + + + Gets or sets the cache index. + + + + + Gets or sets additional information regarding pivot cache. + + + + + Preserved XlsIO unsupported elements + + + + + Gets or sets the name of the pivot cache NamedRange. + + + + + True if the pivot cache has named range. False otherwise. + + + + + Gets the calculated item index. Read-only. + + + + + Presreved the Extenal cache source relations + + + + + External cache source relation ID. + + + + + Indicates wheather the pivot cache has records. + + + + + Indicates whether the pivot cache has missing items. + + + + + Indicates whether the pivot cache has tuple cache. + + + + + Gets the type code of this record in the biff storage. Read-only. + + + + + Gets the code of the biff storage. Read-only. + + + + + True if the data array is required by this record. False otherwise. + + + + + Gets the record position in stream. This is a utility member of class and + is used only in the serialization process. Does not influence the data. + + + + + Represents a field in a PivotTable report. + + + + + View field record. + + + + + Extended view fields record. + + + + + View items. + + + + + Cache fields which this field is based on. + + + + + Indicates whether this is data field. + + + + + Represents the parent pivot table. + + + + + Specifies a boolean value that indicates whether the application will display fields + compactly in the sheet on which this PivotTable resides + + + + + Specifies a boolean value that indicates whether the field can be removed from the + PivotTable. + + + + + Specifies a boolean value that indicates whether the field can be dragged to the data + region. + + + + + Specifies a boolean value that indicates whether manual filter is in inclusive mode. + + + + + Specifies a boolean value that indicates whether new items that appear after a refresh + should be hidden by default. + + + + + Specifies a boolean value that indicates whether to insert a blank row after each item. + + + + + Specifies a boolean value that indicates whether to insert a page break after each item. + + + + + Specifies the number of items showed per page in the PivotTable. + + + + + Specifies the index of the item in the pivot cache + + + + + Specifies a boolean value that indicates whether field has a measure based filter. + + + + + Specifies a boolean value that indicates whether the field can have multiple items + selected in the page field. + + + + + Specifies a boolean value that indicates whether the items in this field should be shown + in Outline form. + + + + + Specifies a boolean value that indicates whether to hide drop down buttons on PivotField + headers. + + + + + Specifies a boolean value that indicates whether to show the property as a member + caption. + + + + + Specifies a boolean value that indicates whether to show the member property value in a + PivotTable cell. + + + + + Specifies a boolean value that indicates whether to show the member property value in a + tooltip on the appropriate PivotTable cells. + + + + + Specifies the type of sort that is applied to this field. + + + + + Specifies a boolean value that indicates whether an AutoShow filter applied to this field is + set to show the top ranked values + + + + + Specifies the unique name of the member property to be used as a caption for the field + and field items. + + + + + Represents the item attributes + + + + + Preserves the sorting elements of the field + + + + + Indicates whether all items in the field are expanded. + + + + + Indicates whether sort is applied to this field in the data source. + + + + + Indicates the drill state of the attribute hierarchy in an OLAP-based PivotTable. + + + + + Indicates flexible storage extensions for pivot Field + + + + + Indicates values of filter in page field. + + + + + Pivot Filter collection of pivot fields + + + + + Pivot field items collections + + + + + Specifies the number of items of field set as invisible. + + + + + Indicates Page Field Name + + + + + Indicates Page Field Caption + + + + + Indicates Page Hierarchy Index + + + + + Indicates a Boolean value if the item options are sorted. + + + + + Indicates a Boolean value if the cache field is updated. + + + + + Indicates whether the pivot field should be ignored or not. + + + + + Indicates a Boolean value whether to Show or hide repeated item labels in pivot fields. + + + + + Represent the AutoSort item. + + + + + Represents the autoSortScope pivot area + + + + + Represent the collection of AutoSort Field Value information. + + + + + Indicates whether Quarters and Years fields are enabled or not. + + + + + Creates collection and sets its Application and Parent values. + + Parent workbook. + + + + Initializes new instance of the pivot field. + + Parent workbook. + Cache field that corresponds to this field. + + + + Parses specified data at the offset to extract pivot field. + + Records collection with data. + Offset to the first pivot field record. + Offset to the record after field's records. + + + + Saves pivot table into OffsetArrayList. + + OffsetArrayList that will get all pivot table records. + + + + Adds the specified item at the specified index to the pivot field. + + Index at which the item is to be added. + Pivot field item to be added. + + + + Adds the specified item to the pivot field. + + Index at which the item is to be added. + + + + Gets position of the given pivot field item among the pivot field items collection. + + Pivot field item in the field. + Position of the item among the pivot field items collection. + + + + Sets position of the given pivot field item among the pivot field items collection. + + Pivot field item in the field. + + + + Moves the position of the Row Field among the Row fields. + + + + + + Move the position of the column field among column fields. + + + + + + Moves the position of the data field among the data fields + + + + + + Moves the position of page field among the page fields. + + + + + + + + Loads pivot field items from the cache field. + + Cache field that corresponds to this field. + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Gets the pivot field group in current pivot field. + + + + + Gets or sets flexible storage extensions as stream for pivot Field. + + + + + Gets or sets the position of the field (first,second,third and so on) among all the fields in its Axis (Row,Column,Page,Data). + + + + + Gets or sets the field axis. + + + Following code snippet illustrates how to add a axis to pivot field. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + // Create Pivot cache with the given data range + IPivotCache cache = workbook.PivotCaches.Add(worksheet["A1:H50"]); + //Create "PivotTable1" with the cache at the specified range + IPivotTable pivotTable = worksheet.PivotTables.Add("PivotTable1", worksheet["A1"], cache); + //Add Pivot table fields (Row and Column fields) + pivotTable.Fields[2].Axis = PivotAxisTypes.Row; + pivotTable.Fields[6].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + + + + + + + Gets or sets the Filter value of Page fields. + + + + + True if the item options are sorted, False Otherwise. + + + + + Gets or sets a boolean value indicating if the cache field is updated. + + + + + Gets or sets the name of the pivot field. + + + + + Gets the parent cache field. Read-only. + + + + + True if the pivot field is a data field. False otherwise. + + + + + Gets or sets number format index for the pivot field. + + + + + Gets or sets the number format for the pivot field. + + + + + Gets or sets the subtotal function used for pivot field. + + + + + Gets or sets a boolean value indicating whether the subtotal is positioned at the top. The default value is True. + + + + + Gets or sets the custom text that is displayed for the subtotals label. + + + + + True if the number of top or bottom items for a row, page, or column field in the specified PivotTable report + is enabled. False otherwise. + + + + + Gets or sets a Boolean value indicating if user can drag field to row area. + Read/Write Boolean. The default value is True. + + + + + Gets or sets a Boolean value indicating if user can drag field to column area. + Read/Write Boolean. The default value is True. + + + + + Gets or sets a Boolean value indicating if user can drag field to page area. + Read/Write Boolean. The default value is True. + + + + + True if the user can remove field from view. False otherwise. + + + + + Gets or sets a Boolean value indicating if user can remove field from view. + Read/Write Boolean. The default value is True. + + + + + Gets or sets a Boolean value indicating whether newly added pivot table items should be tracked when + manual filtering is applied to pivot field. Read/Write Boolean. + + + + + + Gets or sets a Boolean value indicating whether newly added pivot table items during + manual filtering to pivot field, should be shown after refresh operation. + + + + + Gets or sets a Boolean value indicating if a blank row is inserted + after the specified row field in a PivotTable report. + Read/Write Boolean. + + + + + True if a page break is inserted after each field. False otherwise. + + + + + Gets or sets the number of items showed per page in the PivotTable. + + + + + Specifies the index of the item in the pivot cache + + + + + Gets or sets a Boolean value indicating whether field has a measure based filter. + + + + + Gets or sets a Boolean value indicating whether the field has multiple items + selected in the page field. + + + + + Gets or sets a Boolean value indicating whether to show all items for this field. + + + + + Gets or sets a Boolean value that indicates whether the items in this field should be shown + in Outline form. + + + + + True if the flag for the specified PivotTable field or PivotTable item is set to "drilled" (expanded, or visible). + False otherwise. + + + + + Gets or sets a Boolean value indicating whether to show the property as a + caption. + + + + + Gets or sets a Boolean value indicating whether to show the item property value in a + PivotTable cell. + + + + + Gets or sets a Boolean value that indicates whether to show the item value in a + tooltip on the appropriate PivotTable cells. + + + + + Gets or sets the type of sort that is applied to this field. + + + + + Gets or sets a Boolean value indicating whether AutoShow filter applied to this field is + set to show the top ranked values. + + + + + Gets or sets the unique name to be used as a caption for the field + and field items. + + + + + Represents the item attributes + + + + + Gets or sets a boolean value indicating whether the application will display fields + compactly in the sheet on which this PivotTable resides. + + + + + Gets or sets a Boolean value indicating if the specified field can be dragged to the data position. + Read/Write Boolean. The default value is True. + + + + + Gets or sets the formula for the calculated field. + + + + + Gets or sets a Boolean value indicating if this field is formula field. Read-only. + + + + + Gets or sets the stream that preserves the sorting elements of the field. + + + + + Indicates whether all items in the field are expanded. + + + + + Indicates whether sort is applied to this field in the data source. + + + + + Indicates the drill state of the attribute hierarchy in an OLAP-based PivotTable. + + + + + Gets the collection for the pivot field. Read-only. + + + + + Gets Pivot field items which are the individual data entries in a field category. + Read-only. + + + + + Property for Page Field Name. + + + + + Property for Page Field Caption. + + + + + Property for Page Field Hierarchy Index. + + + + + Property for pivot table. + + + + + Indicates whether the pivot field should be ignored or not. + + + + + Gets or sets visibility of repeated item labels for the specified pivot field. + + + + + Represent the AutoSort item. + + + + + Represents the autoSortScope pivot area. + + + + + Represent the collection of AutoSort Field Value information. + + + + + Get or set a Boolean value indicating whether the Quarters and Years fields are applied to a date field or not. + + + + + Represents a PivotTable on a worksheet. + + + + + Default starting name of the pivot data field. + + + + + Code of the first record for the pivot table. + + + + + When Pivot table create, updated and refreshed + then Excel 2007 stores this version + + + + + When Pivot table create, updated and refreshed + then Excel 2010 stores this version + + + + + When Pivot table create, updated and refreshed + then Excel 2013 stores this version + + + + + When Pivot table create, updated and refreshed + then Excel 2016 stores this version + + + + + Unknown records that belong to pivot table. + + + + + View definition. + + + + + Fields collection. + + + + + Row / column field ids. + + + + + Collection of all LineItemArray records needed for this pivot table. + + + + + This record contains information about additional features + added to PivotTables in Excel. + + + + + Page item. + + + + + Data items. + + + + + Unknown records that belong to pivot table. + + + + + Parent workbook. + + + + + Collection of pivot table fields. + + + + + Table location. + + + + + Table end location. + + + + + Contains all data fields. + + + + + True if row, column, and item labels appear on the first row of each page when + the specified PivotTable report is printed. False if labels are printed only on + the first page. The default value is True. + + + + + Built-in style. + + + + + Custom Style Name + + + + + Parent worksheet. + + + + + Represents the Pivot Table Options + + + + + Specifies the first column of the PivotTable data, relative to the top left cell in the ref + value + + + + + Specifies the first column of the PivotTable data, relative to the top left cell in the ref + value + + + + + Specifies the first row of the PivotTable header, relative to the top left cell in the ref + value. + + + + + Specifies the number of columns per page for this PivotTable that the filter area will + occupy. + + + + + Specifies the number of rows per page for this PivotTable that the filter area will occupy. + + + + + Specifies a boolean value that indicates whether to show column headers for the table. + + + + + Specifies a boolean value that indicates whether to show column stripe formatting for + the table. + + + + + Specifies a boolean value that indicates whether to show the last column. + + + + + Specifies a boolean value that indicates whether to show row headers for the table. + + + + + Specifies a boolean value that indicates whether to show row stripe formatting for the + table. + + + + + Represents the Pivot table column items in Stream + + + + + Represents the Pivot Table row items in stream + + + + + Represents the pivot table to add the Calculated + Data field in rows + + + + + Preserves the XlsIO unsupported elements + + + + + Returns the calculated field collection represents all + the calculated fields int the specified pivot table. + + + + + Indicates wheather the pivot table modified. + + + + + Represents the column field order. + + + + + Represents the Row fields order + + + + + Variable for pivot engine. + + This method is not supported in WinRT, Windows Phone, Portable and Silverlight Platforms. + + + + + Collection of Filters + + + + + Collection of pivot formats + + + + + Pivot formats stream. + + + + + Row fields inner items collection. + + + + + Column fields inner items collection. + + + + + Initializes a new instance of pivot table. + + + Application object that represents the Excel application. + + Parent object of this collection. + + + + Initializes a new instance of pivot table with the specified cache index and pivot table location. + + + Application object that represents the Excel application. + + Parent object of this collection. + Cache index. + Pivot table location. + + + + Sets parent workbook to the correct value. + + + + + Draws a layout for the pivot table. + + + Following code snippet illustrates how to layout a pivot table similar to MS Excel. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("PivotData.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + + IPivotCache cache = workbook.PivotCaches.Add(worksheet["A1:H50"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.Fields[4].Axis = PivotAxisTypes.Page; + pivotTable.Fields[2].Axis = PivotAxisTypes.Row; + pivotTable.Fields[6].Axis = PivotAxisTypes.Row; + pivotTable.Fields[3].Axis = PivotAxisTypes.Column; + IPivotField datafield = pivotSheet.PivotTables[0].Fields[5]; + pivotTable.DataFields.Add(datafield, "Sum of Units", PivotSubtotalTypes.Sum); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleDark12; + + //The following code sample must be included to XlsIO layout the pivot table like MS Excel. + pivotTable.Layout(); + + workbook.SaveAs("PivotTable.xlsx"); + workbook.Close(); + excelEngine.ThrowNotSavedOnDestroy = false; + excelEngine.Dispose(); + + + This method is not supported in WinRT, Windows Phone, Portable and Silverlight Platforms. + + + + + Get cell format for the given pivot range. + + Pivot range to get the cell format. + Pivot cell format + + + + Parses pivot table. + + Records with pivot table data. + Offset to the first pivot table record. + Offset to the record after table records. + + + + Saves pivot table into OffsetArrayList. + + OffsetArrayList that will get all pivot table records. + + + + Clears all internal collections. + + + + + Gets the collection of pivot fields based on pivot axis. + + axis type. + Pivot fields collection. + + + + Get the Workbook equalent of + Pivot table version + + + + + + Get cell format for the given pivot range. + + Pivot range to get the cell format. + + + + + Get pivot format for the given pivot range. + + Pivot range to get the cell format. + + + + + Update the pivot area by setting required properties + + Pivot area to be updated + column index of the pivot cell + row index of the pivot cell + Pivot table layout + + + + + + Pivot area to be updated. + column index of the pivot cell. + row index of the pivot cell. + Pivot inner item to be updated. + Indicates whether this is column fields operation or not. + Pivot table layout + + + + + Get parent count of given pivot inner item + + Pivot inner item + Parent count + + + + Get current index of PivotInnerItem collection. + + Pivot inner item collection + Pivot inner item + Current index + + + + + Sorts the pivot table by row or column fields. + + List of pivot inner items for or column fields. + Pivot table the sort to be applied. + Row number. + Pivot inner item. + + + + Get pivot inner items for for the pivot fields. + + Pivot table fields + Returns list of pivot inner items collection. + + + + Get the PivotInnerItem for the given line number. + + List of PivotInnerItem for the row or column field. + Current index number. + Column number. + PivotInnerItem to be returned. + Indicates whether the column sort or row sort. + PivotInnerItem. + + + + Add PivotInnerItems of row or column fields items. + + List of PivotInnerItem. + List of pivot row or column fields. + Pivot field index. + + + + Add PivotInnerItems for the speficied pivot field. + + Pivot field. + Parent PivotInnerItem. + Parent pivot field index. + + + + Check the PivotInnerItem. + + Source range. + Migrant range. + PivotInnerItem to be checked. + Row number of the pivot range. + True if the PivotInnerItem exist. Otherwise returns false + + + + Extract references from pivot inner item and it to the pivot area. + + PivotInnerItem to be extracted. + Pivot area to the reference be added. + + + + Apply pivot formats to layout cells + + pivot table layout to be updated. + Collection of ExtendedFormats with cell indexes + + + + Update pivot table layout cells. + + Pivot table layout to be updated. + Pivot formats to be updated. + Pivot format to update pivot cells. + First row index. + First column index. + TOtal rows. + + + + Get extended format from PivotCellFormat + + PivotCellFormat to get extended format. + Returns extended format + + + + Get line number from PivotAreaReferences. + + PivotAreaReferences to get the line number. + PivotInnerItem to get the line number. + Indicates whether the column fields operation are not. + + + + + Get the children count from given PivotInnerItems. + + Collection of PivotInnerItem to get the inner items count. + + + + + Update the row fields list. + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Return to the PageFields , Pivot PageFields, RowFields , ColumnFields values + + object that is a copy of this instance + return a pivot fields + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + This method autofit the tabular layout pivot table only. + Note: Compact layout and outline layout are autofitted by MS Excel itself. + this method should be removed once tabular form layout is supported using Pivot engine layout. + + + + + + Invoke when changes made in the pivo table. + + + + + Clear the data and the format of the pivot table + + + + + Returns the collection of calculated fields in the specified pivot table + + pivot calculated field collection + + + + Clears all the fields, deletes all filtering and sorting applied to the PivotTable. + + + + + Property for pivot filter collections + + + + + Gets or sets the pivot engine of the pivot table. + + This method is not supported in WinRT, Windows Phone, Portable and Silverlight Platforms. + + + + + Gets or sets the index number of the PivotTable cache. Read-only. + + + + + True if the PivotTable report displays a custom error string in cells + that contain errors. False otherwise. Read/Write Boolean. + + + Use the ErrorString property to set the custom error string. + This property is particularly useful for suppressing divide-by-zero errors when calculated fields are pivoted. + + + + + True if the PivotTable report displays a custom string in cells + that contain null values. False otherwise. Read/Write Boolean. + + Use the NullString property to set the custom null string. The default value is True. + + + + Gets or sets value indicating whether the PivotTable contains + column with grand totals for rows (same as ColumnGrand in VBA). + Default value is true. + + + Following code illustrates how to access the ColumnGrand property of the pivot table. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + IPivotCache cache = workbook.PivotCaches.Add(worksheet["A1:H50"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.ColumnGrand = false; + + + + + + True if drilldown into pivot table data is enabled. False otherwise. The default value is True. + + + + + True if the PivotTable Field dialog box is available for the user. False otherwise. The default value is True. + + + + + True if the PivotTable Wizard is available. False otherwise. + The default value is True. + + + + + Gets or sets the string displayed in cells that contain errors + when the DisplayErrorString property is True. + + + + + True if the PivotTable report is recalculated only at the user's request. + The default value is False. + + + + + True if the specified PivotTable report’s outer-row item, + column item, subtotal, and grand total labels use merged cells. + + + + + Gets or sets the pivot table name. + + + + + Gets or sets the string displayed in cells that contain null + values when the DisplayNullString property is True. + + + + + Returns or sets the order in which page fields are added to the PivotTable report’s layout. + + + + + Returns or sets the style used in the bound page field area. + The default value is a null string (no style is applied by default). + + + + + Returns or sets the number of page fields in each column + or row in the PivotTable report. + + + + + Gets or sets value indicating whether the PivotTable contains + row with grand totals for columns (same as RowGrand in VBA). + Default value is true. + + + Following code illustrates how to access the RowGrand property of the pivot table. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + IPivotCache cache = workbook.PivotCaches.Add(worksheet["A1:H50"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.RowGrand = false; + + + + + + Gets cache used by this pivot table. Read-only. + + + + + Gets or sets the pivot table location in the worksheet. + + + + + Gets pivot table end location. Read-only. + + + + + Returns collection of pivot fields. Read-only. + + + + + Gets the collection of pivot fields. Read-only. + + + + + Returns collection of pivot fields. Read-only. + + + + + Gets the collection of data fields in pivot table. Read-only. + + + + + Gets collection of pivot table data fields. Read-only. + + + + + Gets parent workbook. Read-only. + + + + + Gets parent worksheet. Read-only. + + + + + + Gets or sets a Boolean value indicating whether filter buttons and pivot field + captions for rows and columns are displayed in the grid. + The default value is True. + + + + + Gets or sets a Boolean value indicating whether labels must be repeated on every page.The default value is True. + + True if row, column, and item labels appear on the first row of each page when + the specified PivotTable report is printed. False if labels are printed only on + the first page. + + + + + Gets or sets the built-in style of the pivot table. + + + Following code illustrates how to access the BuiltInStyle property of the pivot table. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + IWorksheet pivotSheet = workbook.Worksheets[1]; + IPivotCache cache = workbook.PivotCaches.Add(worksheet["A1:H50"]); + IPivotTable pivotTable = pivotSheet.PivotTables.Add("PivotTable1", pivotSheet["A1"], cache); + pivotTable.BuiltInStyle = PivotBuiltInStyles.PivotStyleDark12; + + + + + + Gets or sets name of custom style for the pivot table. + + + + + Gets or sets a Boolean value indicating whether the PivotTable contains grand totals for rows. + + + + + Gets or sets a Boolean value indicating whether the PivotTable contains grand totals for columns. + + + + + Gets the pivot table options. Read-only. + + + + + Specifies the first column of the PivotTable data, relative to the top left cell in the ref + value + + + + + Specifies the first column of the PivotTable data, relative to the top left cell in the ref + value + + + + + Specifies the first row of the PivotTable header, relative to the top left cell in the ref + value. + + + + + Gets the number of columns per page for this PivotTable that the filter area will occupy. Read-only. + + + + + Gets the number of rows per page for this PivotTable that the filter area will occupy. Read-only. + + + + + Specifies a boolean value that indicates whether to show column headers for the table. + + + + + Specifies a boolean value that indicates whether to show column stripe formatting for + the table. + + + + + Specifies a boolean value that indicates whether to show the last column. + + + + + Specifies a boolean value that indicates whether to show row headers for the table. + + + + + Specifies a boolean value that indicates whether to show row stripe formatting for the + table. + + + + + Represents the Pivot table column items in Stream + + + + + Represents the Pivot Table row items in stream + + + + + Gets or sets a Boolean value indicating whether the PivotTable data fields are shown in rows. + + + + + Gets the application for this object. + + + + + Preserves the XlsIO unsupported elements + + + + + Gets the collection of calculated fields in the pivot table. Read-only. + + + Following code illustrates how to access the CalculatedFields property of the pivot table. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("PivotTable.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + + IPivotTable pivotTable = sheet.PivotTables[0]; + + //Add calculated field to the first pivot table + IPivotField field = pivotTable.CalculatedFields.Add("Percent", "Sales/Total*100"); + + workbook.SaveAs("PivotTable.xlsx"); + workbook.Close(); + excelEngine.ThrowNotSavedOnDestroy = false; + excelEngine.Dispose(); + + + + + + + Gets the collection of page fields in the pivot table. Read-only. + + + + + Returns the collection of Pivot Row field for the specified pivot table. + + + + + Returns the collection of Pivot Page field for the specified pivot table. + + The pivot page fields. + + + + Gets the collection of Row fields in the pivot table. Read-only. + + + + + Gets the collection of column fields in the pivot table. Read-only. + + + + + Represents the pivot table modified. + + + + + Gets the col fields order. + + + + + Gets the Row fields order. + + + + + Collection of pivot formats + + + + + + + + + + Gets or sets the old value. + + The old value. + + + + Gets or sets the new value. + + The new value. + + + + Gets or sets the Range. + + The Range. + + + + Represents the cell formula + + + + + Indicates that this formula needs to be recalculated the next time calculation is performed. + + + + + True if the data table is two-dimentional. + + + + + True if one-dimentional data table is a row, otherwise it's a column. + + + + + Represents type of formula. + + + + + Range of cells which the formula applies to. Only required for shared formula, array formula or data table + + + + + First input cell for data table. Only applies to the data tables array function "TABLE()". + + + + + Second input cell for data table when dt2D is '1'. Only applies to the data tables array function "TABLE()". + + + + + + Gets or sets the text of the cell formula. + + + + + Initializes a new instance of the CellFormula class. + + + + + Initializes a new instance of the CellFormula class with the specified text content. + + Tet to be set. + + + + Indicates that this formula needs to be recalculated the next time calculation is performed. + + + + + True if the data table is two-dimentional. + + + + + True if one-dimentional data table is a row, otherwise it's a column. + + + + + Represents type of formula. + + + + + Range of cells which the formula applies to. Only required for shared formula, array formula or data table + + + + + First input cell for data table. Only applies to the data tables array function "TABLE()". + + + + + Second input cell for data table when dt2D is '1'. Only applies to the data tables array function "TABLE()". + + + + + + Gets or sets the text of the cell formula. + + + + + Summary description for RangeRichTextString. + + + + + Interface for Rich text string wrapper. + + + + + Parent worksheet. + + + + + + + + + + + + + + + + + + Cell index. + + + + + + + + Cell index. + Formatted text object. + + + + This method is called before any changes made to the rich text string. + + + + + This method is called after any changes made to the rich text string. + + + + + Performs application-defined tasks associated with freeing, + releasing, or resetting unmanaged resources. + + + + + Returns default font. Read-only. + + + + + Returns index of the string. + + + + + Parent worksheet. + + + + + + + + + + Parent range. + + + + + Represents an RTF string. + + + + + Private constructor - to prevent user from creating instances without arguments. + + + + + Creates new instance of the RTFStringArray. + + Parent range. + + + + Returns font which is applied to character at the specified position. + + Character index. + Font which is applied to character at the specified position. + + + + Sets font for range of characters. + + First character of the range. + Last character of the range. + Font to set. + + + + Clears string formatting. + + + + + Appends rich text string with specified text and font. + + Text to append. + Font to use. + + + + + + + + + + + + + + Performs application-defined tasks associated with freeing, + releasing, or resetting unmanaged resources. + + + + + + + + + + Gets / sets range of rtftext. + + + + + Gets / sets text of the string. + + + + + Returns text in rtf format. Read-only. + + + + + Indicates whether rich text string has formatting runs. Read-only. + + + + + Application object for this object. + + + + + Parent object for this object. + + + + + + + + + + Parent range. + + + + + Represents an RTF string. + + + + + + + + + + + + Returns font for character at specified position. + + Position of the symbol. + + Font for character at specified position if it is equal for all + cells in the parent range, otherwise NULL is returned. + + + + + Sets font for specified range of characters. + + First character to set font. + Last character to set. + Font to set. + + + + Clears formatting. + + + + + Appends rich text string with specified text and font. + + Text to append. + Font to use. + + + + Clears text and formatting. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Indicates whether rich text string has formatting runs. Read-only. + + + + + Stores created Biff records and allows to get specific record. + + + + + Dictionary with Biff records. Key - Biff record type value. + + + + + Initializes new instance. + + + + + Returns Biff record filled with speciffic values. + + Object that provides access to the data. + Offset to the record's start. + Excel version used for infill. + Extracted record. + + + + Returns empty Biff record. + + Biff record type. + Extracted record. + + + + Rtf text writer used for converting rtf string into rtf format. + + + + + 0 - font index, + 1 - charset, + 2 - font name. + + + + + Font attribute. + + + + + 0 - red component (0-255), + 1 - green, + 2 - blue. + + + + + Underline tags. + + + + + Strike through tags. + + + + + Other tags. + + + + + Array list with all used colors. + + + + + Fonts dictionary. Font - to - font index. + + + + + Colors dictionary. Color - to - color index. + + + + + Indicates whether formatting is enabled. + + + + + Inner text writer. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the image RTF. + + The RTF. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns string that implement current object. + + Returns string that implement current object. + + + + Writes a bool to the text stream. + + Bool param to write. + + + + Writes a character to the text stream. + + Char value to write. + + + + Writes a array of characters to the text stream. + + Array param to write. + + + + Writes a double to the text stream. + + Double param to write. + + + + Writes a int value to the text stream. + + Int value to write. + + + + Writes a long value to the text stream. + + Long value to write. + + + + Writes a object to the text stream. + + Object value to write. + + + + Writes a float value to the text stream. + + Float value to write. + + + + Writes a string to the text stream. + + String to write. + + + + Writes a uint value to the text stream. + + Uint value to write. + + + + Writes out a formatted string, using the same semantics as String.Format. + + The formatting string. + An object to write into the formatted string. + + + + Writes out a formatted string, using the same semantics as String.Format. + + The formatting string. + The object array to write into the formatted string. + + + + Writes out a formatted string, using the same semantics as String.Format. + + The formatting string. + An object to write into the formatted string. + An object to write into the formatted string. + + + + Writes a subarray of characters to the text stream. + + The character array to write data from. + Starting index in the buffer. + The number of characters to write. + + + + Writes a line terminator to the text stream. + + + + + Writes the text representation of a Boolean followed by a line + terminator to the text stream. + + The Boolean to write. + + + + Writes a character followed by a line terminator to the text stream. + + The character to write to the text stream. + + + + Writes an array of characters followed by a line terminator to the text stream. + + The character array from which data is read. + + + + Writes the text representation of a 8-byte floating-point value followed + by a line terminator to the text stream. + + The 8-byte floating-point value to write. + + + + Writes the text representation of a 4-byte signed integer + followed by a line terminator to the text stream. + + The 4-byte signed integer to write. + + + + Writes the text representation of an 8-byte signed + integer followed by a line terminator to the text stream. + + The 8-byte signed integer to write. + + + + Writes the text representation of an object by calling + ToString on this object, followed by a line terminator to the text stream. + + The object to write. + + + + Writes the text representation of a 4-byte floating-point + value followed by a line terminator to the text stream. + + The 4-byte floating-point value to write. + + + + Writes a string followed by a line terminator to the text stream. + + The string to write. + + + + Writes the text representation of a 4-byte unsigned integer followed + by a line terminator to the text stream. + + The 4-byte unsigned integer to write. + + + + Writes out a formatted string and a new line, using the same semantics as Format. + + The formatting string. + The object array to write into format string. + + + + Writes out a formatted string and a new line, using the same semantics as Format. + + The formatted string. + The object to write into the formatted string. + + + + Writes out a formatted string and a new line, using the same semantics as Format. + + The formatting string. + The object to write into the format string. + The object to write into the format string. + + + + Writes a subarray of characters followed by a line terminator to the text stream. + + The character array from which data is read. + The index into buffer at which to begin reading. + The maximum number of characters to write. + + + + Adds new font to the collection. + + Font to add. + Index of the font. + + + + Adds color to the colors table. + + + + + + + Writes fonts table into inner text writer. + + + + + Writes colors table into inner text writer. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Writes the image text. + + The font. + The STR text. + The image. + The align. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Writes the alignment. + + The alignment. + + + + Write end tag for font attributes + + font object for text + + + + + Write underline endtag for the font that contain underline + + font object for text + + + + Write subsuper end tag if the font contain superscript or subscript + + font object for text + + + + + + + + + Returns current Encoding. + + + + + \ul Continuous underline. \ul0 turns off all underlining. + \ulcN Underline color + \uld Dotted underline. + \uldash Dash underline. + \uldashd Dash dot underline. + \uldashdd Dash dot dot underline. + \uldb Double underline. + \ulhwave Heavy wave underline + \ulldash Long dash underline + \ulnone Stops all underlining. + \ulth Thick underline + \ulthd Thick dotted underline + \ulthdash Thick dash underline + \ulthdashd Thick dash dot underline + \ulthdashdd Thick dash dot dot underline + \ulthldash Thick long dash underline + \ululdbwave Double wave underline + \ulw Word underline. + \ulwave Wave underline. + + Elements order is very important. + + + + + Continuous underline. + + + + + Turns off all underlining. + + + + + Dotted underline. + + + + + Dash underline. + + + + + Dash dot underline. + + + + + Dash dot dot underline. + + + + + Double underline. + + + + + Heavy wave underline. + + + + + Long dash underline. + + + + + Stops all underlining. + + + + + Thick underline. + + + + + Thick dotted underline. + + + + + Thick dash underline. + + + + + Thick dash dot underline. + + + + + Thick dash dot dot underline. + + + + + Thick long dash underline. + + + + + Double wave underline. + + + + + Word underline. + + + + + Wave underline. + + + + + Elements order is very important. + + + + + Single is on. + + + + + Single is off. + + + + + Double is on. + + + + + Double is off. + + + + + Elements order is very important. + + + + + Font table begins. + + + + + Font table ends. + + + + + Color table starts. + + + + + Color table ends. + + + + + Bold on. + + + + + Bold off. + + + + + Italic on. + + + + + Italic off. + + + + + Rtf begins. + + + + + Rtf ends. + + + + + Group starts. + + + + + Group ends. + + + + + End of line. + + + + + Foreground color. + + + + + Background color. + + + + + Subscript. + + + + + SuperScript. + + + + + SubScript or SuperScript Off. + + + + + Summary description for IEncryptor. + + + + + Sets information required to encrypt the document. + + Unique document id. + Encryption password. + + + + Encrypts DataProvider and writes result back into it. + + Provider to encrypt. + Offset to the first byte to encrypt. + Number of bytes to encrypt. + Position of the data in the stream. + + + + Encrypts DataProvider and writes result back into it. + + Data to encrypt. + Offset to the first byte to encrypt. + Number of bytes to encrypt. + Position of the data in the stream. + + + + Creates FilPassRecord that corresponds to this document. + This method can only be called after encryption info was set. + + Created record. + + + + Summary description for MD5_CTX. + + + + + + + + + + scratch buffer + + + + + input buffer + + + + + actual digest after MD5Final call + + + + + Initializes a new instance of the class. + + + + + Updates + + The input buf. + The buffer length. + + + + Finals this instance. + + + + + Stores the digest. + + + + + F(x, y, z) + + The x. + The y. + The z. + + + + + G(x, y, z) + + The x. + The y. + The z. + + + + + H(x, y, z) + + The x. + The y. + The z. + + + + + I(x, y, z) + + The x. + The y. + The z. + + + + + ROTATE_LEFT + + The x. + The n. + + + + + FF + + A. + The b. + The c. + The d. + The x. + The s. + The ac. + + + + GG + + A. + The b. + The c. + The d. + The x. + The s. + The ac. + + + + HH + + A. + The b. + The c. + The d. + The x. + The s. + The ac. + + + + II + + A. + The b. + The c. + The d. + The x. + The s. + The ac. + + + + Transforms the specified inn. + + The inn. + + + + Gets or sets the I. + + The I. + + + + Gets or sets the buffer. + + The buffer. + + + + Gets or sets the input buffer. + + The input buffer. + + + + Gets or sets the digest. + + The digest. + + + + Represents an MD5Decryptor. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Last stream position. + + + + + Data provider used to encrypt/decrypt byte arrays. + + + + + Initializes a new instance of the class. + + + + + Checks the password. + + The password. + + + + + Decrypts the stream. + + The stream. + + + + + Decrypts data provider and writes data back into it. + + Provider to decrypt. + Offset to the data. + Size of the data to decrypt. + Record position in the stream position. + + + + Decrypts buffer and puts resulting data back into it. + + Buffer to decrypt. + Offset to the data. + Size of the data to decrypt. + + + + Prepares password. + + Password to convert. + + + + Swaps a and b. + + a. + b. + + + + Prepares the key. + + Key to prepare. + The data. + The length. + + + + Makes the key. + + + The block. + The val context. + + + + Compares memory blocks + + The block1. + The block2. + The length. + + + + + Verifies the password. + + True if password was verified. + + + + + + + + + + + + + + + + + + Decrypts buffer + + An object that gives access to the data storage. + Start offset. + The length. + The key. + + + + Checks whether decryption information was prepared. + Throws ApplicationExcepion if it wasn't. + + + + + + + + + + + + Sets information required to decrypt. + + Unique document id. + Encrypted document id. + Digest used to verify the entered password. + Password to use for verification and decryption. + + + + Sets information required to encrypt the document. + + Unique document id. + Encryption password. + True if password was verified and method succeeded. + + + + Encrypts DataProvider and writes result back into it. + + Provider to encrypt. + Offset to the first byte to encrypt. + Number of bytes to encrypt. + Position of the data in the stream. + + + + Encrypts DataProvider and writes result back into it. + + Data to encrypt. + Offset to the first byte to encrypt. + Number of bytes to encrypt. + Position of the data in the stream. + + + + Creates FilPassRecord that corresponds to this document. + This method can only be called after encryption info was set. + + Created record. + + + + Summary description for Word_key. + + + + + + + + + + + + + + + + + + + + Initializes a new instance of the class. + + + + + Gets or sets the status. + + The status. + + + + Gets or sets the x. + + The x. + + + + Gets or sets the y. + + The y. + + + + This class is used to get shapes collection from a worksheet. + + + + + Default constructor. + + + + + Returns a shape collection from the worksheet. + + Worksheet to return sheet data for. + A shape collection from the worksheet. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Class used for Bitmap shape implementation. + + + + + Represents an Image in a worksheet. + + + + + Removes shape from the collection. + + Removes image that is referenced by this shape from collection too, + if we didn't detect image usage. XlsIO doesn't detect this situation correctly in all cases + if there are shapes in charts in Excel 2007 or if some image shapes are grouped in any excel version. + If you are not sure whether image is referenced in charts or grouped shapes and you are working with + Excel 2007 version, set this argument to true (this could cause file size increase, but will keep + document in the correct state). + + The following code illustrates how to remove a from collection. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add images + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, "image.png"); + IPictureShape picture2 = worksheet.Pictures.AddPicture(1, 15, "image.png"); + + //Remove image + picture.Remove(true); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Gets the Filename, Read only. + + + The following code illustrates how to access the FileName property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream from svg + Stream svgStream = new FileStream("image.svg", FileMode.Open); + + //Create image stream from png + Stream stream = new FileStream("image.png", FileMode.Open); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, svgStream, stream, 50, 50); + + //Check + Console.Write(picture.FileName); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //Picture0 + + + + + + Gets or sets the picture. + + + The following code illustrates how Picture property can be accessed. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream from svg + Stream svgStream = new FileStream("image.svg", FileMode.Open); + + //Create image stream from png + Stream stream = new FileStream("image.png", FileMode.Open); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, svgStream, stream, 50, 50); + + //Check + Console.Write(picture.Picture != null); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + + + + + + Gets or sets the svg data for the picture. + + + The following code illustrates how SvgData property can be accessed. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create image stream from svg + Stream svgStream = new FileStream("image.svg", FileMode.Open); + + //Create image stream from png + Stream stream = new FileStream("image.png", FileMode.Open); + + //Add image + IPictureShape picture = worksheet.Pictures.AddPicture(1, 1, svgStream, stream, 50, 50); + + //Check + Console.Write(picture.SvgData != null); + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //True + + + + + + Instance field value for this shape. + + + + + Represents Blip id. + + + + + Name of the blip file. + + + + + Shape's picture (maybe should be moved to BitmapShape class). + + + + + Represents a bitmap image. + + + + + Stream that contains subnodes of the blip xml node in Excel 2007 format. + + + + + Stream that contains shape properties xml-tag in Excel 2007 format. + + + + + Stream that contains svg data. + + + + + Stream that contains shape properties xml-tag in Excel 2007 format. + + + Value indicating relation id for the Svg image. + + + + + Value indicating Svg picture path. + + + + + Boolean value indicating if the Svg stream is updated. + + + + + Stream that contains srcRect tag if shape was extracted from Excel 2007 file. + + + + + Macro name associated with this shape. + + + + + x-coordinate in the offset + + + + + y-coordinate in the offset + + + + + Specifies the length of the extents rectangle in EMUs. + + + + + Specifies the width of the extents rectangle in EMUs. + + + + + Specifies a vertical flip. When true, this attribute defines that the group is flipped + vertically about the center of its bounding box + + + + + Specifies a horizontal flip. When true, this attribute defines that the shape is flipped + horizontally about the center of its bounding box + + + + + Specifies the external link for the image. + + + + + Specifies the external link for the image. + + + + + + CropOptions of BitmapShape + + + + + Refer in Open XML specification for more details: + TODO: Need to add support transparancy details. + + + + + Represents the AlphaModeFix value. + + + + + Represents the Threshold value. + + + + + Indicates whether the GrayScale is applied in picture. + + + + + Indicates whether the alpha value is used in color change. + + + + + Represents the due tone color collection. + + + + + Represents the color change collection. + + + + + Represents the camera tool property. + + + + + Initializes a new instance of the BitmapShapeImpl class. + + Current application. + Parent object + + + + Initializes a new instance of the BitmapShapeImpl class. + + Current application. + Parent object. + Indicates is shape include options. False supports only for header / footer image. + + + + Initializes a new instance of the BitmapShapeImpl class. + + Current application. + Parent object. + Represents array of records. + Represent index. + + + + Initializes a new instance of the BitmapShapeImpl class. + + Current application. + Parent object. + Represents container. + + + + Checks Blip parse option. + + Represents option. + Value indicating parse option. + + + + Parse the Crop Rectangle + + + + + + Parses blip id option. + + Option to parse. + + + + Parses blip name option. + + Option to parse. + + + + Extract necessary option. + + Option to extract. + value indicating extracted option. + + + + Dispose object. + + + + + Serializes shape. + + Represents Spgr container + + + + This method is called inside of PrepareForSerialization to make shape-dependent preparations. + + + + + Serializes options if necessary. + + Low level shapes container. + + + + Serializes client anchor if necessary. + + Low level shapes container. + + + + Serializes client data if necessary. + + Low level shapes container. + + + + Registers shape in all required sub collections. + + + + + This method is called when shapes is deleted. + + + + + This method is called when shapes is deleted. + + Removes image that is referenced by this shape from collection too, + if we didn't detect image usage. XlsIO doesn't detect this situation correctly in all cases + if there are shapes in charts in Excel 2007 or if some image shapes are grouped in any excel version. + If you are not sure whether image is referenced in charts or grouped shapes and you are working with + Excel 2007 version, set this argument to true (this could cause file size increase, but will keep + document in the correct state). + + + + Removes shape from the collection. + + Removes image that is referenced by this shape from collection too, + if we didn't detect image usage. XlsIO doesn't detect this situation correctly in all cases + if there are shapes in charts in Excel 2007 or if some image shapes are grouped in any excel version. + If you are not sure whether image is referenced in charts or grouped shapes and you are working with + Excel 2007 version, set this argument to true (this could cause file size increase, but will keep + document in the correct state). + + + + Creates a clone of the current shape. + + New parent for the shape object. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Indicates whether we should add created + shape into all necessary parent collections. This argument is ignored. + A copy of the current shape. + + + + Updates mso object. + + Represents mso object to update. + Returns true if updated otherwise - false. + + + + Generates default shape name and sets it. + + + + + Sets Blip id. + + new Blip id + + + + Download image from url + + Url + Image + + + + Used for internal purpose. + + + + + Gets or sets Blip file name + + + + + Gets or sets external link for the image. + + + + + Gets or sets external link for the image. + + + + + Gets or sets Blip id. + + + + + In and above MS Excel 2007 format, this value should be divided by + 1000 to get the left crop percentage of actual image size. + + + + + In and above MS Excel 2007 format, this value should be divided by + 1000 to get the right crop percentage of actual image size. + + + + + In and above MS Excel 2007 format, this value should be divided by + 1000 to get the bottom crop percentage of actual image size. + + + + + In and above MS Excel 2007 format, this value should be divided by + 1000 to get the top crop percentage of actual image size. + + + + + Gets or sets picture. + + + + + Gets or sets stream that contains subnodes of the blip xml node in Excel 2007 format. + + + + + Gets or sets Stream that contains shape properties xml-tag in Excel 2007 format. Obsolete, will be removed in future release. + + + + + Gets or sets Svg data for the picture. + + + + + Gets or sets the relation id for Svg image. + + + + + Gets or sets a boolean value indicating if the Svg stream is updated. + + + + + Gets or sets value indicating Svg picture path. + + + + + Gets stream of preserved elements in shape properties + + + + + Gets or sets stream that contains srcRect tag if shape was extracted from Excel 2007 file. + + + + + Returns instance value. Read-only. + + + + + Gets or sets macro name associated with this shape. + + + + + Gets or sets if the BitmapShape is DDE + + + + + Gets or sets if the BitmapShape is Camera + + + + + Gets or sets the offset X + + + + + Gets or sets the offset Y + + + + + Gets or sets the extents of X + + + + + Gets or sets the extents of Y + + + + + Gets or Sets vetical flip + + + + + Gets or Sets vetical flip + + + + + Get object that represents the hyperlink for the shape. + + + + + Indicates whether the alpha value is used in color change. + + + + + Represents the due tone color collection. + + + + + Represents the color change collection. + + + + + Represents the AlphaModeFix value. + + + + + Represents the Threshold value. + + + + + Indicates whether the GrayScale is applied in picture. + + + + + Represents the Camera tool property. + + + + + Class used for camera tool implementation. + + + + + Represents shape id. + + + + + Name of the camera tool picture. + + + + + Represents cell address. + + + + + Creates a clone of the camera tool. + + New parent for the camera tool object. + A copy of the current camera tool. + + + + Represents shape id. + + + + + Name of the camera tool picture. + + + + + Represents cell address. + + + + + Class used for Chart Shapes. + + + + + Represents an embedded chart in the worksheet. + + + + + Gets or sets the top row of the chart. Default value for top row is 1. + + + To know more about charts refer this link. + + The following code illustrates the use of TopRow property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Column_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the top row of the chart + chart.TopRow = 5; + chart.BottomRow = 20; + chart.LeftColumn = 5; + chart.RightColumn = 13; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the bottom row of the chart. Default value for bottom row is 20. + + + To know more about charts refer this link. + + The following code illustrates the use of BottomRow property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Column_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the bottom row of the chart + chart.BottomRow = 20; + chart.TopRow = 5; + chart.LeftColumn = 5; + chart.RightColumn = 13; + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the left column of the chart. Default value for left column is 1. + + + To know more about charts refer this link. + + The following code illustrates the use of LeftColumn property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Column_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the left column of the chart + chart.LeftColumn = 5; + chart.TopRow = 5; + chart.BottomRow = 20; + chart.RightColumn = 13; + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the right column of the chart. Default value for right column is 10. + + + To know more about charts refer this link. + + The following code illustrates the use of RightColumn property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.Name = "Student Sample Chart"; + chart.ChartType = ExcelChartType.Column_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the right column of the chart + chart.RightColumn = 13; + chart.TopRow = 5; + chart.BottomRow = 20; + chart.LeftColumn = 5; + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the name of the chart. Default value for name of chart is "Chart 1". + + + To know more about charts refer this link. + + The following code illustrates the use of Name property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + sheet.Range["A1"].Text = "Student ID"; + sheet.Range["B1"].Text = "Student Name"; + sheet.Range["C1"].Text = "Mark(Out of 100)"; + sheet.Range["A1:C1"].AutofitColumns(); + sheet.Range["A2"].Number = 1; + sheet.Range["A3"].Number = 2; + sheet.Range["A4"].Number = 3; + sheet.Range["A5"].Number = 4; + sheet.Range["A6"].Number = 5; + sheet.Range["B2"].Text = "Andrew"; + sheet.Range["B3"].Text = "Marson"; + sheet.Range["B4"].Text = "Jack"; + sheet.Range["B5"].Text = "Sam"; + sheet.Range["B6"].Text = "Breto"; + sheet.Range["C2"].Number = 77; + sheet.Range["C3"].Number = 45; + sheet.Range["C4"].Number = 92; + sheet.Range["C5"].Number = 39; + sheet.Range["C6"].Number = 55; + + //Create a Chart + IChartShape chart = sheet.Charts.Add(); + chart.ChartType = ExcelChartType.Column_Clustered_3D; + chart.DataRange = sheet.Range["B2:C6"]; + + //sets the name of the chart. + chart.Name = "Student Sample Chart"; + + workbook.SaveAs("Charts.xlsx"); + workbook.Close(); + } + + + + + + Instance value of MsofbtSp record. + + + + + Version value of MsofbtSp record. + + + + + Version value of MsofbtOPT record. + + + + + Instance value of MsofbtOPT record. + + + + + Lock against grouping option value. + + + + + Value of LineColor option. + + + + + Value of NoLineDrawDash option. + + + + + Value of ShadowObscured option. + + + + + Fore color. + + + + + Back color. + + + + + Chart object. + + + + + Zero-based index of top row. + + + + + Zero-based index of bottom row. + + + + + Zero-based index of left column. + + + + + Zero-based index of right column. + + + + + Parent worksheet. + + + + + Initializes new instance of the shape. + + Application object for the new shape. + Parent object for the new shape. + Cloned object. + Dictionary with new names. + Dictionary with new font indexes. + + + + Initializes new instance of the chart shape. + + Application object for the new shape. + Parent object for the new shape. + + + + Initializes new instance of the chart shape. + + Application object for the new shape. + Parent object for the new shape. + Shape container record that describes new shape. + Flags to create. + + + + Makes the current sheet the active sheet. Equivalent to clicking the + sheet's tab. + + + + + Selects current tab sheet. + + + + + Unselects current tab sheet. + + + + + Protects worksheet's content with password. + + Password to protect with. + + + + Protects current worksheet. + + Represents password to protect. + Represents params to protect. + + + + Unprotects worksheet's content with password. + + Password to unprotect. + + + + Method saves the chart as image. + + stream in where the image is streamed. + + + + Creates a clone of the current shape. + + New parent for the shape object. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Indicates whether we should add created + shape into all necessary parent collections. + A copy of the current shape. + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + Registers shape in all required sub collections. + + + + + This method is called inside of PrepareForSerialization to make shape-dependent preparations. + + + + + Parses client data record. + + Record to parse. + Parse options. + + + + Parses shape group container. + + Group container. + + + + Parses client anchor record. + + Record to parse. + + + + Serializes options. + + Parent record for options. + Create options record. + + + + Creates default options. + + Created MsofbtOPT record. + + + + Searches for all parents + + + + + Converts chart shape into WorksheetBaseImpl. + + Shape to convert. + Converted object. + + + + Disposes the charts elements + + + + + Returns internal chart object. Read-only + + + + + Gets or sets the offset X + + + + + Gets or sets the offset Y + + + + + Gets or sets the extents of X + + + + + Gets or sets the extents of Y + + + + + Get object that represents the hyperlink for the shape. + + + + + Returns or sets the rotation of the 3-D chart view + (the rotation of the plot area around the z-axis, in degrees).(0 to 360 degrees). + + + + + Represents the series name level + + + + + Represents the category name level + + + + + Represents the category collection + + + + + Returns or sets the elevation of the 3-D chart view, in degrees (�90 to +90 degrees). + + + + + Returns or sets the perspective for the 3-D chart view.( 0 - 100 ) + + + + + Returns or sets the height of a 3-D chart as a percentage of the chart width + (between 5 and 500 percent). + + + + + Returns or sets the depth of a 3-D chart as a percentage of the chart width + (between 20 and 2000 percent). + + + + + Returns or sets the distance between the data series in a 3-D chart, as a percentage of the marker width.( 0 - 500 ) + + + + + True if the chart axes are at right angles, independent of chart rotation or elevation. + + + + + True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart.. + + + + + True if gridlines are drawn two-dimensionally on a 3-D chart. + + + + + Returns chart shapes. Read-only. + + + + + Gets or sets the type of the pivot chart. + + The type of the pivot chart. + + + + Gets or sets the pivot source. + + The pivot source. + + + + Gets or sets a value indicating whether [show all field buttons]. + + + true if [show all field buttons]; otherwise, false. + + + + + Gets or sets a value indicating whether [show value field buttons]. + + + true if [show value field buttons]; otherwise, false. + + + + + Gets or sets a value indicating whether [show axis field buttons]. + + + true if [show axis field buttons]; otherwise, false. + + + + + Gets or sets a value indicating whether [show legend field buttons]. + + + true if [show legend field buttons]; otherwise, false. + + + + + Gets or sets a value indicating whether [show report filter field buttons]. + + + true if [show report filter field buttons]; otherwise, false. + + + + + Type of the chart. + + + + + DataRange for the chart series. + + + + + True if series are in rows in DataRange; + otherwise False. + + + + + Title of the chart. + + + + + Gets or sets whether the chart has title. + + + + + Gets title text area. Read-only. + + + + + Title of the category axis. + + + + + Title of the value axis. + + + + + Title of the secondary category axis. + + + + + Title of the secondary value axis. + + + + + Title of the series axis. + + + + + Page setup for the chart. Read-only. + + + + + X coordinate of the upper-left corner + of the chart in points (1/72 inch). + + + + + Y coordinate of the upper-left corner + of the chart in points (1/72 inch). + + + + + Width of the chart in points (1/72 inch). + + + + + Height of the chart in points (1/72 inch). + + + + + Collection of the all series of this chart. Read-only. + + + + + Returns primary category axis. Read-only. + + + + + Returns primary value axis. Read-only. + + + + + Returns primary series axis. Read-only. + + + + + Returns secondary category axis. Read-only. + + + + + Returns secondary value axis. Read-only. + + + + + Returns an object that represents the complete chart area for the chart. Read-only. + + + + + Returns plot area frame format. Read-only. + + + + + Returns chart format collection in primary axis. + + + + + Returns chart format collection in secondary axis. + + + + + Returns picture collection. Valid only for charts with own tab. + + + + + Returns charts collection. Valid only for charts with own tab. + + + + + Gets / sets tab color. + + + + + Indicates whether worksheet is displayed right to left. + + + + + Gets / sets tab color. + + + + + Represents chart walls. Read-only. + + + + + sidewall property.. + + + + + backwall property.. + + + + + Represents chart floor. Read-only. + + + + + Represents charts dataTable object. + + + + + Indicates whether tab of this sheet is selected. Read-only. + + + + + True if the chart has a data table. + + + + + True if the chart has a legend object. + + + + + Represents chart legend. + + + + + Indicates whether chart has plot area. + + + + + Returns index in the parent ITabSheets collection. Read-only. + + + + + Control visibility of worksheet to end user. + + + + + Represents the way that blank cells are plotted on a chart. + + + + + True if only visible cells are plotted. False if both visible and hidden cells are plotted. + + + + + True if Microsoft Excel resizes the chart to match the size of the chart sheet window. + False if the chart size isn't attached to the window size. Applies only to chart sheets. + + + + + Returns collection with all textboxes inside this worksheet. Read-only. + + + + + Returns collection with all checkboxes inside this worksheet. Read-only. + + + + + Returns collection with all option buttons inside this worksheet. Read-only. + + + + + Returns collection with all comboboxes inside this worksheet. Read-only. + + + + + Gets code name of the chart. + + + + + Indicates is current sheet is protected. + + + + + True if objects are protected. Read-only. + + + + + True if the scenarios of the current sheet are protected. Read-only. + + + + + Gets protected options. Read-only. For sets protection options use "Protect" method. + + + + + Indicates if the worksheet is password protected. + + + + + Gets or sets the value that represents zoom factor of document. Value must be in range from 10 till 400. + + + + + Gets or sets the style index chart. + + + + + Class used for comment shapes. + + + + + Represents an Excel comment. + + + + + Represents a cell comment. The Comment object is a member + of the Comments collection. + + + + + Returns or sets the author of the comment. Read-only String. + + + The following code illustrates how to access Author property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add comment + IComment comment = worksheet["C2"].AddComment(); + + //Add text + comment.Text = "Comment"; + + //Get author + Console.Write(comment.Author); + + //Save and dispose + workbook.SaveAs("Comments.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //{Your username will be printed} + + + + + + Determines whether the object is visible. Read / write Boolean. + + + The following code illustrates how to set the visibility of the comment. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add comment + IComment comment = worksheet["C2"].AddComment(); + + //Add text + comment.Text = "Comment"; + + //Set visibility + comment.IsVisible = true; + + //Save and dispose + workbook.SaveAs("Comments.xlsx"); + workbook.Close(); + } + + + + + + Row of the commented cell. Read-only. + + + The following code illustrates how to access the Row property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add comment + IComment comment = worksheet["C2"].AddComment(); + + //Get row + Console.Write(comment.Row); + + //Save and dispose + workbook.SaveAs("Comments.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //2 + + + + + + Column of the commented cell. Read-only. + + + The following code illustrates how to access the Column property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add comment + IComment comment = worksheet["C2"].AddComment(); + + //Get column + Console.Write(comment.Column); + + //Save and dispose + workbook.SaveAs("Comments.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //3 + + + + + + True if the size of the specified object is changed automatically + to fit text within its boundaries. Read/write Boolean. + + + The following code illustrates how to set AutoSize property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add comment + IComment comment = worksheet["C2"].AddComment(); + + //Add text + comment.Text = "Comment"; + + //Set auto size + comment.AutoSize = true; + + //Save and dispose + workbook.SaveAs("Comments.xlsx"); + workbook.Close(); + } + + + + + + Instance value of MsofbtSp record. + + + + + Version value of MsofbtSp record. + + + + + Version value of MsofbtOPT record. + + + + + Instance value of MsofbtOPT record. + + + + + Default offset in the cell of comment frame. + + + + + Represents value for make comment shadowed. + + + + + Represents if comment show always. + + + + + Represents if comment doesn't show always. + + + + + Row of the commented cell. + + + + + Column of the commented cell. + + + + + + Comment's author. + + + + + Object to hold the textbody properties. + + + + + True if the comment is a threaded comment. If not, false. + + + + + Creates new comment with specified Application and Parent objects. + + Application object for the current object. + Parent object for the current object. + + + + Creates new comment with specified Application and Parent objects. + + Application object for the current object. + Parent object for the current object. + Indicates is parse comment fill line options. + + + + Creates new comment with specified text. + + Application object for the current object. + Parent object for the current object. + Text of new comment. + + + + Extracts comment from MsofbtSpContainer. + + Application object for the current object. + Parent object for the current object. + Container that represents comment. + + + + Extracts comment from MsofbtSpContainer. + + Application object for the current object. + Parent object for the current object. + Container that represents comment. + Parse options. + + + + Initialize variables. + + + + + Fills client anchor with default values. + + + + + Disposes the comment shape + + + + + Registers shape in all required sub collections. + + + + + Creates a clone of the current shape. + + New parent for the shape object. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Indicates whether we should add created + shape into all necessary parent collections. + A copy of the current shape. + + + + Serializes current shape. + + Container that will receive this comment. + + + + Serializes NoteRecord. + + Object id for the NoteRecord. + + + + Serializes Text ID. + + MsofbtOPT record to which text ID will be added. + + If options argument is NULL. + + + + + Serializes option with index 344 (this is unknown option). + + MsofbtOPT record to which text ID will be added. + + If options argument is NULL. + + + + + Creates default options. + + MsofbtOPT record. + + + + Serialize comment shadow. + + Represents option holder. + + + + Indicates is can copy current shape. + + Represents source range dimension. + Represents destination range dimension. + Gets new position of shape. + Returns true if can copy; otherwise - false. + + + + Copies / moves shape in range copy / move. + + Represents destination sheet. + Represents position of . + Indicates is copy. + Returns copied moved shape. + + + + Updates shape that include not size and not move flags. + + Indicates is row or column to update. + One-based row or column index. + Number of inserted/removed rows/column. + + + + Removes shapes from collection. + + + + + Create default fill line formats + + + + + Copy comments options. + + Represents source comment. + Represents dictionary with shape indexes. + + + + This method is called inside of PrepareForSerialization to make shape-dependent preparations. + + + + + Parses Note record. + + Object ID of note to parse. + + + + Row of the commented cell. + + + + + Column of the commented cell. + + + + + Indicates whether comment to be shown or hidden. + + + + + Comment's author. + + + + + Returns instance value. Read-only. + + + + + Get object that represents the hyperlink for the shape. + + + + + Gets the text-body properties + + + + + True if the comment is a threaded comment. False, if not + + + + + This class represents comment for multicell range. + + + + + Parent range. + + + + + Represents the rich-text string + + + + + Creates instance for specified range. + + Application object for new object. + Parent range. + + + + Removes this comment. + + + + + Scales all comments in the array. + + Width scale in percents. + Height scale in percents. + + + + Returns or sets the author of the comment. Read-only String. + + + + + Determines whether the object is visible. Read / write Boolean. + + + + + Row of the commented cell. Read-only. + + + + + Column of the commented cell. Read-only. + + + + + Text of the comment. + + + + + Gets or sets text. + + + + + Indicates whether shape must be moved with cells. + + + + + Indicates whether shape must be sized with cells. + + + + + True if the size of the specified object is changed automatically + to fit text within its boundaries. Read/write Boolean. + + + + + Determines whether the object is visible. Read / write Boolean. + + + + + Gets or sets height of comment shape + + + + + Gets or sets the height of the Shape expressed in decimal units. + + + + + Gets Comments range id. + + + + + Gets or sets left position of the comment + + + + + Gets or sets the left position of the Shape expressed in decimal units. + + + + + Gets or sets the comment shape name. + + + + + Gets or sets the Top position of the shape. + + + + + Gets or sets the top position of the Shape expressed in decimal units. + + + + + Gets or set the width of shape. + + + + + Gets or sets the width of the Shape expressed in decimal units. + + + + + Gets shape type. + + + + + Gets or sets alternative text. + + + + + Represents fill properties. Read-only. + + + + + Represents line format properties. Read-only. + + + + + Gets or sets macro associated with this shape + + + + + Gets the chart3 D properties. + + The chart3 D properties. + + + + Gets the shadow properties. + + The shadow properties. + + + + Returns or sets the rotation of the shape, in degrees. + + + + + + Returns a TextFrame object that contains the + alignment and anchoring properties for the specified shape. Read-only. + + + + + Get object that represents the hyperlink for the shape. + + + + + Horizontal alignment of the text. + + + + + Vertical alignment of the text. + + + + + Text rotation. + + + + + Indicates whether comment text is locked. + + + + + Class used for Form control shapes. + + + + + Represents default lock against grouping value. + + + + + + + + + + Represents default value for no line . + + + + + + + + + + + + + + + List box data. + + + + + Initializes new instance of the shape. + + Application object for the new shape. + Parent object for the new shape. + + + + Initializes new instance of the shape. + + Application object for the new shape. + Parent object for the new shape. + Array of records that contains the record for new shape. + Index of the records for new shape. + + + + Initializes new instance of the shape. + + Application object for the new shape. + Parent object for the new shape. + Shape container record that describes the new shape. + + + + Initializes new instance of the shape. + + Application object for the new shape. + Parent object for the new shape. + Record that describes the new shape. + + + + Initializes internal variables. + + + + + Creates a clone of the current shape. + + New parent for the shape object. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Indicates whether we should add created + shape into all necessary parent collections. + A copy of the current shape. + + + + This method is called inside of PrepareForSerialization to make shape-dependent preparations. + + + + + Serializes shape. + + Container to add shape. + + + + Serialize shape options. + + Parent object. + Record with serialized option. + + + + Parses client data. + + Data to parse. + Parse options. + + + + Indicates whether list box arrow has default or selected color. + + + + + Get object that represents the hyperlink for the shape. + + + + + This class represents single gradient stop of the gradient fill. + + + + + Size of the binary data. + + + + + Gradient stop color. + + + + + Stop position. + + + + + Transparency. + + + + + Tint of the color for this gradient stop. + + + + + Shade of the color for this gradient stop. + + + + + Represent the parent shape fill. + + + + + Creates new instance of the GradientStop. + + Gradient stop color. + Gradient stop position. + Gradient stop transparecy. + + + + Creates new instance of the GradientStop. + + Gradient stop color. + Gradient stop position. + Gradient stop transparecy. + Color tint value. + Color shade value. + + + + Initializes new instance of the gradient stop and extracts settings from specified data array.. + + Data to parse. + Offset to start data parsing from. + + + + Serializes gradient stop into specified stream. + + Stream to serialize data into. + + + + Creates copy of the current instance. + + A copy of the current instance. + + + + Checks whether the specified gradient stop is equal to the current + gradient stop without taking transparency into consideration. + + Represents gradient stop. + Value indicating transparency + + + + Get or set the shape fill. + + + + + Gets / sets color of this gradient stop. + + + + + Gets / sets position of this gradient stop. + + + + + Gets / sets transparency of this gradient stop. + + + + + Gets / sets tint of the color for this gradient stop. + + + + + Gets / sets shade of the color for this gradient stop. + + + + + Represents collection of gradient stops. + + + + + Maximum possible gradient position. + + + + + Gradient angle. + + + + + Gradient type. + + + + + This element defines the "focus" rectangle for the center shade, + specified relative to the fill tile rectangle. + + + + + Gradient fill rect element + + + + + Default constructor. + + + + + Initializes new instance of the gradient stops collection and extracts settings from byte array. + + Byte array to parse. + + + + Saves gradient stops into stream in binary format. + + Stream to serialize into. + + + + Parse byte array. + + Array to parse. + + + + Doubles gradient stops in the collection and updates their positions. + + + + + Inverts gradient stops order and updates their positions correctly. + + + + + Shrinks gradient stop. + + Shrinked Gradient stops. + + + + Creates copy of the current instance. + + Copy of the current instance. + + + + Checks whether specified Gradient stops has colors equal to this gradient stops. + + Represents gradient stop + Value indicating whether gradient stop has color. + + + + Gets / sets gradient angle. + + + + + Gets / sets type of the gradient. + + + + + This element defines the "focus" rectangle for the center shade, + specified relative to the fill tile rectangle. + + + + + it's define the tilerect property. + + + + + Returns true if gradient stops are symmetric. Read-only. + + + + + This enumeration specifies all possible gradient types. + + + + + This element specifies a linear gradient. + + + + + Gradient follows a circular path. + + + + + Gradient follows a rectangular path. + + + + + Gradient follows the shape. + + + + + Specifies x-coordinate in the offset + + + + + Specifies y-coordinate in the offset + + + + + Specifies the width of the extents rectangle. + + + + + Specifies the height of the extents rectangle. + + + + + Specifies the rotation of the shape. + + + + + Specifies the x-coordinate in the child shape offset + + + + + Specifies the y-coordinate in the child shape offset + + + + + Specifies the width of the extents rectangle for child shape. + + + + + Specifies the height of the extents rectangle for child shape. + + + + + Specifies the parent shape. + + + + + Initializes new instance of the shape frame. + + Parent shape. + + + + Set offset values for shape frame. + + shape rotation. + X-coordinate in the offset. + Y-coordinate in the offset. + Width of the extents rectangle. + Height of the extents rectangle. + + + + Set child offset values for shape frame. + + X-coordinate in the child offset. + Y-coordinate in the child offset. + Width of the extents rectangle for child shape. + Height of the extents rectangle for child shape. + + + + Creates a clone of the current shape frame. + + A copy of the current shape frame. + + + + Set parent for shape frame.. + + X-coordinate in the child offset. + + + + Close the shape frame. + + + + + Specifies x-coordinate in the offset + + + + + Specifies y-coordinate in the offset + + + + + Specifies the width of the extents rectangle. + + + + + Specifies the height of the extents rectangle. + + + + + Specifies the x-coordinate in the child shape offset + + + + + Specifies the y-coordinate in the child shape offset + + + + + Specifies the width of the extents rectangle for child shape. + + + + + Specifies the height of the extents rectangle for child shape. + + + + + Specifies the rotation of the shape. + + + + + Class used for Shapes Line Format. + + + + + Represents interface for shape line format. + + + + + Represents weight of the line. + + + The following code illustrates how to set Weight property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 100); + + //Set line format + IShapeLineFormat lineFormat = shape.Line; + + //Set weight + lineFormat.Weight = 6; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Represents foreground color. + + + The following code illustrates how to set foreground color to the shape's line format from structure. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 100); + + //Set line format + IShapeLineFormat lineFormat = shape.Line; + + //Set color + lineFormat.ForeColor = System.Drawing.Color.Red; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Represents background color. + + + + + Represents foreground color index. + + + The following code illustrates how to set foreground color to the shape's line format from enumeration. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 100); + + //Set line format + IShapeLineFormat lineFormat = shape.Line; + + //Set color + lineFormat.ForeColorIndex = ExcelKnownColors.Red; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Represents background color index. + + + + + Represents begin arrow head style. + + + The following code illustrates how to set BeginArrowHeadStyle property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Line, 2, 2, 0, 100); + + //Set line format + IShapeLineFormat lineFormat = shape.Line; + + //Set arrow style + lineFormat.BeginArrowHeadStyle = ExcelShapeArrowStyle.LineArrowDiamond; + lineFormat.EndArrowHeadStyle = ExcelShapeArrowStyle.LineArrowStealth; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Represents end arrow head style. + + + The following code illustrates how to set EndArrowHeadStyle property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Line, 2, 2, 0, 100); + + //Set line format + IShapeLineFormat lineFormat = shape.Line; + + //Set arrow style + lineFormat.BeginArrowHeadStyle = ExcelShapeArrowStyle.LineArrowDiamond; + lineFormat.EndArrowHeadStyle = ExcelShapeArrowStyle.LineArrowStealth; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Represents begin arrow head length. + + + The following code illustrates how to set BeginArrowheadLength property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Line, 2, 2, 0, 100); + + //Set line format + IShapeLineFormat lineFormat = shape.Line; + + //Set arrow style + lineFormat.BeginArrowHeadStyle = ExcelShapeArrowStyle.LineArrowDiamond; + + //Set arrow width + lineFormat.BeginArrowheadWidth = ExcelShapeArrowWidth.ArrowHeadWide; + + //Set arrow Length + lineFormat.BeginArrowheadLength = ExcelShapeArrowLength.ArrowHeadLong; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Represents end arrow head length. + + + The following code illustrates how to set EndArrowheadLength property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Line, 2, 2, 0, 100); + + //Set line format + IShapeLineFormat lineFormat = shape.Line; + + //Set arrow style + lineFormat.EndArrowHeadStyle = ExcelShapeArrowStyle.LineArrowStealth; + + //Set arrow width + lineFormat.EndArrowheadWidth = ExcelShapeArrowWidth.ArrowHeadWide; + + //Set arrow Length + lineFormat.EndArrowheadLength = ExcelShapeArrowLength.ArrowHeadLong; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Represents begin arrow head width. + + + The following code illustrates how to set BeginArrowheadWidth property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Line, 2, 2, 0, 100); + + //Set line format + IShapeLineFormat lineFormat = shape.Line; + + //Set arrow style + lineFormat.BeginArrowHeadStyle = ExcelShapeArrowStyle.LineArrowDiamond; + + //Set arrow width + lineFormat.BeginArrowheadWidth = ExcelShapeArrowWidth.ArrowHeadWide; + + //Set arrow Length + lineFormat.BeginArrowheadLength = ExcelShapeArrowLength.ArrowHeadLong; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Represents end arrow head width. + + + The following code illustrates how to set EndArrowheadWidth property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Line, 2, 2, 0, 100); + + //Set line format + IShapeLineFormat lineFormat = shape.Line; + + //Set arrow style + lineFormat.EndArrowHeadStyle = ExcelShapeArrowStyle.LineArrowStealth; + + //Set arrow width + lineFormat.EndArrowheadWidth = ExcelShapeArrowWidth.ArrowHeadWide; + + //Set arrow Length + lineFormat.EndArrowheadLength = ExcelShapeArrowLength.ArrowHeadLong; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Represents the dash style for the specified line. + + + By default is set to DashStyle. Here for example, we set + to DashStyle property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 100); + + //Set line format + IShapeLineFormat lineFormat = shape.Line; + + //Set line style + lineFormat.DashStyle = ExcelShapeDashLineStyle.Dash_Dot_Dot; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Represents line style. + + + By default is set to Style. Here for example, we set + to Style property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 100); + + //Set line format + IShapeLineFormat lineFormat = shape.Line; + + //Set line style + lineFormat.Style = ExcelShapeLineStyle.Line_Thick_Between_Thin; + + //Set line wight + lineFormat.Weight = 5; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Represents line transparency. + + + The following code illustrates how to set Transparency for the shape's line format. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 100); + + //Set line format + IShapeLineFormat lineFormat = shape.Line; + + //Set transparency + lineFormat.Transparency = 0.5; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Represents if line format is visible. + + + The following code illustrates how to set visibility to shape's line format. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add shape + IShape shape = worksheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 20, 100); + + //Set line format + IShapeLineFormat lineFormat = shape.Line; + + //Set visibility + lineFormat.Visible = false; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Represents line pattern. + + + + + Indicates if current line format contain pattern. + + + + + Represents default line weight mull. + + + + + Represents max line weight. + + + + + Represents length of helper parse array. + + + + + Represents helper byte array to parse pattern. + + + + + Indicates whether the border has edge join or not. + + + + + Represents the borders edge join type. + + + + + Represents the value of border miter join. + + + + + Default Style index + + + + + Indicates whether the line uses default width. + + + + + Represents weight of shape line. + + + + + Represents foreground color. + + + + + Represents foreground color. + + + + + Represents parent book. + + + + + Represents begin arrow style. + + + + + Represents end arrow style. + + + + + Represents begin arrow length. + + + + + Represents end arrow length. + + + + + Represents begin arrow width. + + + + + Represents end arrow width. + + + + + Represents dash style. + + + + + Represents line style. + + + + + Represents line transparency. + + + + + Represents is line format visible. + + + + + Represents line pattern. + + + + + Indicate if line format contain pattern. + + + + + Indicates whether border join is round. + + + + + Represent indicating whether line properties having nofill element or not. + + + + + Represent indicating whether line properties having solid element or not. + + + + + Represent the end cap string. + + + + + Initialize new static members. + + + + + Creates new instance of object. + + Current application. + Parent object. + + + + Creates new instance of object. Autoshape Implementation + + Current application. + Parent object. + + + + Finds all parent objects. + + + + + Parses transparency. + + Transparency value to parse. + Returns parsed value. + + + + Serialize transparency. + + Represents option holder. + Represents transparency id. + Represents transparency value. + + + + Serialize color to stream. + + Represents option holder. + Represents color to serialize. + Represents option id to serialize. + + + + Parses fill options. + + Record to parse. + Value indicating extracted option. + + + + Parses arrows options + + Represents option to parse. + Returns true if parsed; otherwise false. + + + + Parses current pattern. + + Represents pattern option. + Returns parsed pattern value. + + + + Parse visible property. + + Represents visible data. + + + + Serialize shape line format as biff format. + + Represents option holder. + + + + Serialize arrow line options. + + Represents options storage. + Returns updated option storage. + + + + Serialize dash style as biff recorded structure. + + Represents option holder. + + + + Serialize line style as biff recorded structure. + + Represents option holder. + + + + Serialize visible property. + + Represents option holder. + + + + Serialize pattern to mso option. + + Represents option holder. + + + + Gets pattern by pattern data. + + Represents patt data. + Returns parsed data. + + + + Set the group shape property value to all the inner shapes. + + Property value to set. + Property name. + + + + Clones current object. + + Represents parent object for new instance. + Returns cloned object. + + + + Represents weight of the line in pts.( 0 - 1584 ) + + + + + Represents foreground color. + + + + + Represents background color. + + + + + Represents foreground color index. + + + + + Represents background color index. + + + + + Represents begin arrow head style. + + + + + Represents end arrow head style. + + + + + Represents begin arrow head length. + + + + + Represents end arrow head length. + + + + + Represents begin arrow head width. + + + + + Represents end arrow head width. + + + + + Represents the dash style for the specified line. + + + + + Represents line style. + + + + + Represents line transparency. + + + + + Represents if line format is visible. + + + + + Represents line pattern. + + + + + Indicates if current line format contain pattern. + + + + + Represent the end cap type string. + + + + + Represent indicating whether line properties having nofil element or not. + + + + + Represent indicating whether line properties having soild element or not. + + + + + Get or set the indicates whether border has edge join or not. + + + + + Get or set the borders edge join type + + + + + Get or set the value of miter border join. + + + + + Default line style index. + + + + + Indicates whether the line uses default width. + + + + + Returns parent workbook. Read-only. + + + + + Indicates whether join is round. + + + + + Gets stream of preserved elements in schemeColor properties. + + + + + This class represents TextBox form control. + + + + + This interface represents TextBox form control shape. + + + + + Text of the comment. + + + The following code illustrates how to set TextLink property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add data + worksheet["C4"].Value = "Text"; + + //Add shape + ITextBoxShapeEx shape = worksheet.Shapes.AddTextBox(); + + //Set dimensions + shape.Top = 40; + shape.Left = 20; + shape.Height = 30; + shape.Width = 70; + + //Set text link + shape.TextLink = "=C4"; + + //Save and dispose + workbook.SaveAs("Shapes.xlsx"); + workbook.Close(); + } + + + + + + Correct shape instance. + + + + + Correct shape version. + + + + + Represents embedded string. + + + + + Represent the indicating wheather fld element have text or not. + + + + + Represents a formula linking to spreadsheet cell data + + + + + indicates whether the text box is auto fit respect to the text + + + + + Indicates whether to allow text editing within this drawing object when the parent worksheet is protected + + + + + Specifies that the generating application should not allow aspect ratio changes for the corresponding connection shape + + + + + Object to hold the textbody properties. + + + + + Represents vertical flip of the textbox + + + + + Represents Horizontal flip of the textbox + + + + + Represent store the paragraph fld element stream. + + + + + Represent indicating whether text box having the line element or not. + + + + + Represent indicating wheather text box is created or not. + + + + + Indicates whether shape fill color is preserved or not + + + + + Indicates whether text box has noFill or not. + + + + + Indicates whether text box has group fill or not. + + + + + Indicates whether text box is slicer shape or not. + + + + + Represents the slicer id of the textbox shape. + + + + + Textbox text transparency value + + + + + Initialize new instance of the text box shape. + + Application object for the new shape. + Parent object for the new shape. + + + + Initializes new instance of the text box shape. + + Application object for the new shape. + Parent object for the new shape. + Shape's container. + Parsing options. + + + + Initializes shape items. + + + + + This method is called inside of PrepareForSerialization to make shape-dependent preparations. + + + + + Serializes current shape. + + Container that will receive this comment. + + + + Creates default shape options. + + Record with default option specified. + + + + Creates a clone of the current shape. + + New parent for the shape object. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Indicates whether we should add created + shape into all necessary parent collections. + A copy of the current shape. + + + + Gets and sets the indicating wheather fld element have text or not. + + + + + Represent indicating wheather text box is created or not. + + + + + Represents whether the shape is slicer or not. + + + + + Represents the slicer id of the textbox shape. + + + + + Represent indicating whether text box having the line element or not. + + + + + Indicates whether shape fill color is preserved or not + + + + + Indicates whether text box has noFill or not. + + + + + Indicates whether text box has group fill or not. + + + + + Gets or sets the 2007 co-ordinates of TextBox + + + + + Gets or sets the field id of TextBox + + + + + Gets or sets the field type of TextBox + + + + + Specifies a formula linking to spreadhseet cell data + + + + + Indicates whether to allow text editing within this drawing object when the parent worksheet is protected + + + + + Specifies that the generating application should not allow aspect ratio changes for the corresponding connection shape + + + + + Gets or sets text box text respect with this value, isautosize updated + + + + + Get object that represents the hyperlink for the shape. + + + + + Text body properties holder to hold the properties of the textbody. + + + + + Represents vertical flip of the textbox shape. + + + + + Represents the horizontal flip of the textbox shape. + + + + + Gets and sets the paragraph fld element stream. + + + + + Gets and sets the Text Transparency Alpha. + + + + + Represents a style description. The Style object contains + all style attributes (font, number format, alignment, and so on) as + properties. There are several built-in styles, including Normal, + Currency, and Percent. Using the Style object is a fast and efficient + way to change several cell-formatting properties on multiple cells at + the same time. + For the Workbook object, the Style object is a member of the Styles + collection. The Styles collection contains all the defined styles for + the workbook. + + + + + First excel 2007 specific style in the styles array. + + + + + Constant indicating that one object is less than another. Used by CompareTo method. + + + + + Constant indicating that one object is equal to another. Used by CompareTo method. + + + + + Constant indicating that one object is larger than another. Used by CompareTo method. + + + + + Build in style index for RowLevel_n styles. + + + + + Build in style index for ColLevel_n styles. + + + + + Style record that describes style. + + + + + StyleExt record that describes style. + + + + + Indicates whether do not to compare name during CompareTo operation. + + + + + Indicates if the style is used in the workbook. + + + + + Initializes new instance of the style. + + Parent workbook. + + + + Initializes new instance of the style. + + Parent workbook. + Style record to parse. + + + + Initializes new instance of the style. + + Parent workbook. + Name of the style to create. + + + + Initializes new instance of the style. + + Parent workbook. + Name of the style to create. + Base style. + + + + Initializes new instance of the style. + + Parent workbook. + Name of the style to create. + Base style. + Indicates whether created style is built in. + + + + Copies default style settings into internal extended format from built-in style. + + Built-in style index. + + + + Saves style into OffsetArrayList. + + OffsetArrayList to save style into. + + + + Updates style record according to the xf indexes. + + + + + This method is called after any changes are made in styles. + + + + + This method is called before any changed are made in styles. + + + + + Creates copy of the current instance. + + Parent object for the new collection. + Copy of the current instance. + + + + + + + + + + A hash code for the current Object without taking cell list into account. + + The Object to compare with the current Object. + + + + + Compares the current instance with another object of the same type. + + An object to compare with this instance. + + A 32-bit signed integer that indicates the relative order of the comparands. + The return value has these meanings: + Value Meaning + Less than zero - This instance is less than obj. + Zero - This instance is equal to obj. + Greater than zero - This instance is greater than obj. + + + + + Gets if the style has border + + + + + Indicates whether style is build in. Read-only. + + + + + Returns name of the style. Read-only. + + + + + Represents actual style name in case of AsciiConversion + + + + + Indicates whether style is initialized (differs from Normal style). + Read-only. + + + + + Returns index of the style's extended format. + + + + + Indicates whether do not to compare name during CompareTo operation. + + + + + Returns style record. Read-only. + + + + + Gets or sets if the style is built in customized + + + + + /Represents if the stylename is encoded, when style name is greater than 256 symbols + + + + + StyleExt record that describes style. + + + + + This event is raised before any changes are made in styles. + + + + + This event is raised after any changes are made in styles. + + + + + This class stores default predefined styles settings. + + + + + Fill settings. + + + + + Font settings. + + + + + Borders information. + + + + + Initializes new instance of the class. + + Fill object. + Font object. + + + + Initializes new instance of the class. + + Fill object. + Font object. + Borders object. + + + + Style options. + + + + + CopyRangeArgument for template marker. Specifies range that should be copied + for each new marker element. + + + + + JumpArgument for marker. Specifies jump position after applying + single template marker element. + + + + + Class used for Marker Argument. + + + + + Argument parts separator. + + + + + Maximum Row Index of the marker variable applied cell + + + + + Initializes a new instance of the MarkerArgument class. + + + + + Tries to parse argument string. + + Argument to parse. + Parsed argument if possible; null otherwise. + + + + Parses regular expression match. + + Match to parse. + Parsed argument of the same type as this instance is. + + + + Applies argument to the marker at the specified position + and to the list of cells with markers. + + Worksheet that contains cell to apply marker argument to. + Previous cell position. + One-based row index of the cell to apply marker argument to. + One-based column index of the cell to apply marker argument to. + List of cells with markers. + Marker options. + + + + Prepares options if necessary. + + Options to prepare. + + + + Creates a new object that is a copy of the current instance. + + Copy of the current instance. + + + + Inserts row int list of cell indexes. + + List with cell indexes. + Starting index. + Row index. + + + + Inserts column int list of cell indexes. + + List with cell indexes. + Starting index. + One-based column index. + + + + Gets/Sets the maximum row index + + + + + Gets regular expression used to check argument. Read-only. + + + + + Gets priority of the argument. Read-only. + + + + + Indicates whether argument is used just to prepare some options before + any values are proceed. Read-only. + + + + + Indicates whether marker should be applies for each marker value. Read-only. + + + + + Indicates whether argument can be present multiple times in single + template marker. Read-only. + + + + + Name of the group in the regular expression for row index. + + + + + Name of the group in the regular expression for column index . + + + + + Copy styles group name. + + + + + Start of the jump argument. + + + + + Value indicating that styles must be copied after jump operation. + + + + + Index of the group in the regular expression to check whether row index is relative. + + + + + Index of the group in the regular expression to check whether column index is relative. + + + + + Argument priority. + + + + + R1C1 cell detection regular expression + + + + + Regular expression to check cell. + + + + + Represents the destination row index. + + + + + Represents the destination column index. + + + + + Determines whether row index is relative or not. + + + + + Determines whether column index is relative or not. + + + + + Determines whether styles must be copied or not. + + + + + Initializes a new instance of the JumpArgument class. + + + + + Initializes a new instance of the JumpArgument class with specified row and column index. + + Destination row index. + Destination column index. + Indicates whether row index is relative. + Indicates whether column index is relative. + + + + Tries to parse the specified argument string. + + Argument to parse. + Parsed argument if possible; null otherwise. + + + + Applies argument to the marker at the specified position + and to the list of cells with markers. + + Worksheet that contains cell to apply marker argument to. + Previous cell position. + One-based row index of the cell to apply marker argument to. + One-based column index of the cell to apply marker argument to. + List of cells with markers. + Marker options. + + + + Evaluates new position of the cell with specified original cell position. + + Original cell position. + Workbook where operation is performed. + Point that contains updated cell position. + + + + Tries to convert string into int value. + + String to parse. + Result integer. + True if conversion succeeded; false otherwise. + + + + Converts regular expressions match into row and column coordinates. + + Value to parse. + Resulting row. + Resulting column. + Indicates whether row index is relative. + Indicates whether column index is relative. + True if parsing succeeded. + + + + Evaluates new position of the cell. + + Original cell position. + Destination row index. + Destination column index. + Indicates whether row index is relative. + Indicates whether column index is relative. + Workbook where operation is performed. + Point that contains updated cell position. + + + + Update the row column value from given merged point value + + input row, column point + + + + Returns priority of the argument. Read-only. + + + + + Indicates whether marker should be applies for each marker value. Read-only. + + + + + /// Start of the copy range argument. + + + + + Default copy options. + + + + + Rectangle used for copy range operations for performance + + + + + Initializes a new instance of the CopyRangeArgument class. + + + + + Destination row index. + + + + + Destination column index. + + + + + Indicates whether row index is relative. + + + + + Indicates whether column index is relative. + + + + + Tries to parse argument string. + + Argument to parse. + Parsed argument if possible; null otherwise. + + + + Applies argument to the marker at the specified position + and to the list of cells with markers. + + Worksheet that contains cell to apply marker argument to. + Previous cell position. + One-based row index of the cell to apply marker argument to. + One-based column index of the cell to apply marker argument to. + List of cells with markers. + Marker options. + + + + Check whether the copyrange rectangle is empty. If not the copy operation will be called + + Input worksheet + Marker options + Point start of the marker applying + + + + Returns priority of the argument. Read-only. + + + + + Indicates whether argument can be present multiple times in single + template marker. Read-only. + + + + + Class used for Direction argument. + + + + + Sorted list with Direction enumeration values, + key - string representation of the current direction. + + + + + Marker direction. + + + + + Initializes static members of the DirectionArgument class. + + + + + Initializes a new instance of the DirectionArgument class. + + + + + Tries to parse argument string. + + String to parse. + Marker direction. + + + + Prepares options if necessary. + + Options to prepare. + + + + Tries and the get direction. + + The marker arguments. + Direction in string + + + + Indicates whether argument is used just to prepare some options before + any values are proceed. Read-only. + + + + + Possible directions. + + + + + Vertical direction. + + + + + Horizontal direction. + + + + + Possible Image vertical positions + + + + + Top position. + + + + + Middle position. + + + + + Bottom position. + + + + + Possible Image Horizontal positions + + + + + Left position. + + + + + Center position. + + + + + Right position. + + + + + Contains settings that are local to a marker and depends on marker arguments. + + + + + Marker direction (horizontal or vertical). + + + + + Current template marker index. + + + + + Workbook where operation takes place. + + + + + Original marker text. + + + + + Boolean value indicates whether the merge has been applied in the process + + + + + Initializes a new instance of the MarkerOptionsImpl class. + + Current workbook. + + + + Gets or sets Marker direction (horizontal or vertical). + + + + + Gets or sets current template marker index. + + + + + Gets workbook where operation takes place. Read-only. + + + + + Gets or sets original marker text. + + + + + Indicates whether the merge copied on insertion + + + + + Class used for Space Argument. + + + + + Priority of the argument. + + + + + Correct marker value. + + + + + Index of the group for copystyles part of the argument. + + + + + It mentions the whether row has to be inserted. + + + + + Regular expression used to check argument. + + + + + Indicates whether styles should be copied. + + + + + Indicates whether cell merges have to be applied each insertion + + + + + Initializes a new instance of the NewSpaceArgument class. + + + + + Parses regular expression match. + + Match to parse. + Parsed argument of the same type as this instance is. + + + + Applies argument to the marker at the specified position + and to the list of cells with markers. + + Worksheet that contains cell to apply marker argument to. + Previous cell position. + One-based row index of the cell to apply marker argument to. + One-based column index of the cell to apply marker argument to. + List of cells with markers. + Marker options. + + + + Applies argument to the marker at the specified position + and to the list of cells with markers. + + Worksheet that contains cell to apply marker argument to. + Previous cell position. + One-based row index of the cell to apply marker argument to. + One-based column index of the cell to apply marker argument to. + List of cells with markers. + Marker options. + the merge point count of the cell + + + + Get the merged range row and column count from given cell info + + input row + input column + input sheet + the merged point count + + + + Returns priority of the argument. Read-only. + + + + + Indicates whether marker should be applies for each marker value. Read-only. + + + + + Regular expression used to check argument. Read-only. + + + + + Read - only property , showing merge is enabled + + + + + Returns the boolean value shows whether the styles has been copied or not. + + + + + boolean value indicates whether row needs to be inserted + + + + + Class used for ImageSize argument. + + + + + Start of the ImageSizeArgument. + + + + + Default Image Width and Height + + + + + Default Priority of an argument + + + + + Initializes a new instance of the ImageSizeArgument class. + + + + + Width Of the Image + + + + + Height Of the Image + + + + + Indicates whether the image width is auto + + + + + Indicates whether the image width is auto + + + + + Tries to parse argument string. + + Argument to parse. + Parsed argument if possible; null otherwise. + + + + Returns the customized width of an image + + + + + Returns the customized height of an image + + + + + Indicates whether marker should be applied for each marker value. Read-only. + + + + + Returns priority of the argument. Read-only. + + + + + Indicates whether the image width is auto. Read-only. + + + + + Indicates whether the image height is auto. Read-only. + + + + + Class used for ImagePosition argument. + + + + + Start of the ImagePositionArgument. + + + + + Default Image Vertical and Horizontal position + + + + + Default Priority of an argument + + + + + Initializes a new instance of the ImagePositionArgument class. + + + + + Horizontal position Of the Image + + + + + Vertical Position Of the Image + + + + + True if the vertical position is set + + + + + True if the horizontal position is set + + + + + Tries to parse argument string. + + Argument to parse. + Parsed argument if possible; null otherwise. + + + + Returns the enum value from a given string + only for vertical and horizontal position enum + + enum variable is passed here as an object + value to be parsed + Parsed argument if possible; null otherwise. + + + + Returns the customized Vertical Position of an image + + + + + Returns the customized horizontal Position of an image + + + + + True if the vertical position is set + + + + + True if the horizontal position is set + + + + + Indicates whether marker should be applies for each marker value. Read-only. + + + + + Returns priority of the argument. Read-only. + + + + + Class used for fit to cell argument + + + + + Priority of the argument. + + + + + Correct marker value. + + + + + Indicates whether the image content to be filled in cell. + + + + + Initializes a new instance of the NewSpaceArgument class. + + + + + Tries to parse argument string. + + Argument to parse. + Parsed argument if possible; null otherwise. + + + + Returns priority of the argument. Read-only. + + + + + Indicates whether marker should be applies for each marker value. Read-only. + + + + + Gives the boolean value to image fitted in cell.Read-Only Property + + + + + Class used for apply import options to the empty cells while importing nested collection objects + + + + + Priority of the argument. + + + + + Default marker value. + + + + + Merge marker value. + + + + + Repeat marker value. + + + + + Merge marker value preservestyle. + + + + + Indicates whether the empty cells can be merged. + + + + + Indicates whether the current object value to be filled in empty cells. + + + + + Indicates whether the empty cells can be merged with preserve style or not. + + + + + Initializes a new instance of the ImportOptionsArgument class. + + + + + Tries to parse argument string. + + Argument to parse. + Parsed argument if possible; null otherwise. + + + + Returns priority of the argument. Read-only. + + + + + Indicates whether marker should be applies for each marker value. Read-only. + + + + + Gives the boolean value to merge the empty cells. + + + + + Gives the boolean value to fill the empty cells with current object value. + + + + + Indicates whether the empty cells can be merged with preserve style or not. + + + + + Class used for group the empty cells while importing nested collection objects + + + + + Priority of the argument. + + + + + Expand group marker value. + + + + + Collapse group marker value. + + + + + Indicates whether the grouping can be collapsed. + + + + + Indicates whether the grouping can be expanded. + + + + + Initializes a new instance of the ImportGroupOptionsArgument class. + + + + + Tries to parse argument string. + + Argument to parse. + Parsed argument if possible; null otherwise. + + + + Returns priority of the argument. Read-only. + + + + + Indicates whether marker should be applies for each marker value. Read-only. + + + + + Gives the boolean value to apply grouping to empty cell and collapse the group. + + + + + Gives the boolean value to apply grouping to empty cell and expand the group. + + + + + Class used for Range Builder. + + + + + List with Rectangles used for range creation. + + + + + Initializes a new instance of the RangeBuilder class. + + + + + Adds cell to the collection for the specified row and column. + + One-based row index of the cell to add. + One-based column index of the cell to add. + + + + Clears collection. + + + + + Returns range object that was built by the current instance. + + Parent worksheet object. + Range object that was built by this instance. + + + + Creates rectangle for the specified row and column. + + One-based row index of the cell. + One-based column index of the cell. + Created rectangle. + + + + Returns single entry from the collection by its index. Read-only. + + + + + Gets number of elements in the collection. Read-only. + + + + + + Class used for TemplateMarker Attribute. + + + + + Represents the processing of a special marker symbol, that appends multiple records from data source into a worksheet. + + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + ITemplateMarkersProcessor marker = workbook.CreateTemplateMarkersProcessor(); + System.Data.DataTable reports = new System.Data.DataTable(); + reports.Columns.Add("SalesPerson"); + reports.Columns.Add("FromDate", typeof(DateTime)); + reports.Columns.Add("ToDate", typeof(DateTime)); + reports.Rows.Add("Andy Bernard", new DateTime(2014, 09, 08), new DateTime(2014, 09, 11)); + reports.Rows.Add("Jim Halpert", new DateTime(2014, 09, 11), new DateTime(2014, 09, 15)); + reports.Rows.Add("Karen Fillippelli", new DateTime(2014, 09, 15), new DateTime(2014, 09, 20)); + reports.Rows.Add("Phyllis Lapin", new DateTime(2014, 09, 21), new DateTime(2014, 09, 25)); + reports.Rows.Add("Stanley Hudson", new DateTime(2014, 09, 26), new DateTime(2014, 09, 30)); + marker.AddVariable("Reports", reports); + marker.ApplyMarkers(); + + + + A template marker is a special marker symbol created in an Excel template + that appends multiple records from a data source into a worksheet. + + + + + Represents the processing of a special marker symbol, that appends multiple records from data source into a worksheet. + + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + ITemplateMarkersProcessor marker = workbook.CreateTemplateMarkersProcessor(); + System.Data.DataTable reports = new System.Data.DataTable(); + reports.Columns.Add("SalesPerson"); + reports.Columns.Add("FromDate", typeof(DateTime)); + reports.Columns.Add("ToDate", typeof(DateTime)); + reports.Rows.Add("Andy Bernard", new DateTime(2014, 09, 08), new DateTime(2014, 09, 11)); + reports.Rows.Add("Jim Halpert", new DateTime(2014, 09, 11), new DateTime(2014, 09, 15)); + reports.Rows.Add("Karen Fillippelli", new DateTime(2014, 09, 15), new DateTime(2014, 09, 20)); + reports.Rows.Add("Phyllis Lapin", new DateTime(2014, 09, 21), new DateTime(2014, 09, 25)); + reports.Rows.Add("Stanley Hudson", new DateTime(2014, 09, 26), new DateTime(2014, 09, 30)); + marker.AddVariable("Reports", reports); + marker.ApplyMarkers(); + + + + + + Applies markers to the parent object. + + + To ignore marker variables in document that are not used in template marker we can use in the + method. + + + To apply the marker with default option we can use method. The default option will be . + If any text with marker variable syntax appears in the workbook this operation will throw exception. For example, Here we use marker variables + %Names and %Numbers. If we didn't add any one of these two variables in template marker and try to run the code, it will throw exception. This + behaviour can be changed by giving the as a parameter in . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Data to be used for Template Marker. + string[] names = new string[] { "A", "B", "C", "D" }; + string[] numbers = new string[] { "1", "2", "3", "4" }; + + //Add marker variables in the worksheet. + worksheet["A1"].Text = "Names"; + worksheet["B1"].Text = "Numbers"; + worksheet["A2"].Text = "%Names"; + worksheet["B2"].Text = "%Numbers"; + + //Create a Template Marker Instance. + ITemplateMarkersProcessor marker = workbook.CreateTemplateMarkersProcessor(); + + //Add variable names from the binding context to Template Marker. + marker.AddVariable("Names", names); + marker.AddVariable("Numbers", numbers); + + //Apply Marker. + marker.ApplyMarkers(); + + //Save and Dispose. + workbook.SaveAs("TemplateMarker.xlsx"); + workbook.Close(); + } + + + + + + Applies markers to the parent object with the specified . + + Marker unknown variable. + + To preserve the document that has marker variables that are not added to template marker we use method. + + + To avoid the marker throwing exception with default option of method we can use or + . The "Skip" just ignores the marker variables that are not added in Template Marker and the "ReplaceBlank" + can be used to clear the marker variable from the document. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Data to be used for Template Marker. + string[] names = new string[] { "A", "B", "C", "D" }; + + //Add marker variables in the worksheet. + worksheet["A1"].Text = "Names"; + worksheet["B1"].Text = "Numbers"; + worksheet["A2"].Text = "%Names"; + worksheet["B2"].Text = "%Numbers"; + + //Create a Template Marker Instance. + ITemplateMarkersProcessor marker = workbook.CreateTemplateMarkersProcessor(); + + //Add variable names from the binding context to Template Marker. + marker.AddVariable("Names", names); + + //Apply Marker. + marker.ApplyMarkers(UnknownVariableAction.Skip); + + //Save and Dispose. + workbook.SaveAs("TemplateMarker.xlsx"); + workbook.Close(); + } + + + + + + Adds a variable to the collection with the specified variable name and value. + + Name of the variable. + Value of the variable. + + To know more about Template Markers refer this link + + + To load the marker from arrays we can use the marker name and source array name in the method. + For example, here we load data from names array to the marker variable %Names. Other than arrays, we can import data from . + Refer this link to know + how to import data from using template markers. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Data to be used for Template Marker. + string[] names = new string[] { "A", "B", "C", "D" }; + string[] numbers = new string[] { "1", "2", "3", "4" }; + + //Add marker variables in the worksheet. + worksheet["A1"].Text = "Names"; + worksheet["B1"].Text = "Numbers"; + worksheet["A2"].Text = "%Names"; + worksheet["B2"].Text = "%Numbers"; + + //Create a Template Marker Instance. + ITemplateMarkersProcessor marker = workbook.CreateTemplateMarkersProcessor(); + + //Add variable names from the binding context to Template Marker. + marker.AddVariable("Names", names); + marker.AddVariable("Numbers", numbers); + + //Apply Marker. + marker.ApplyMarkers(); + + //Save and Dispose. + workbook.SaveAs("TemplateMarker.xlsx"); + workbook.Close(); + } + + + + + + Adds a variable to the collection with the specified name, value and . + + Name of the variable. + Value of the variable. + Marker variable type. + + Using we can enable template marker to detect the "Number Formats" and "Data Types" of objects and apply + formatting depending on that. For example, Here we use FromDate and ToDate as objects of DateTime. Since we used + default date formatting will be applied for the data for those marker variables. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Data to be used for Template Marker. + string[] names = new string[] { "A", "B", "C", "D" }; + string[] numbers = new string[] { "1", "2", "3", "4" }; + + //Add marker variables in the worksheet. + worksheet["A1"].Text = "SalesPerson"; + worksheet["B1"].Text = "FromDate"; + worksheet["C1"].Text = "ToDate"; + worksheet["A2"].Text = "%Reports.SalesPerson"; + worksheet["B2"].Text = "%Reports.FromDate"; + worksheet["C2"].Text = "%Reports.ToDate"; + + //Create a Template Marker Instance. + ITemplateMarkersProcessor marker = workbook.CreateTemplateMarkersProcessor(); + + //Create DataTable for import using Template Marker. + System.Data.DataTable reports = new System.Data.DataTable(); + reports.Columns.Add("SalesPerson"); + reports.Columns.Add("FromDate", typeof(DateTime)); + reports.Columns.Add("ToDate", typeof(DateTime)); + reports.Rows.Add("Andy Bernard", new DateTime(2014, 09, 08), new DateTime(2014, 09, 11)); + reports.Rows.Add("Jim Halpert", new DateTime(2014, 09, 11), new DateTime(2014, 09, 15)); + reports.Rows.Add("Karen Fillippelli", new DateTime(2014, 09, 15), new DateTime(2014, 09, 20)); + reports.Rows.Add("Phyllis Lapin", new DateTime(2014, 09, 21), new DateTime(2014, 09, 25)); + reports.Rows.Add("Stanley Hudson", new DateTime(2014, 09, 26), new DateTime(2014, 09, 30)); + + //Add variable name from the binding context to Template Marker. + marker.AddVariable("Reports", reports, VariableTypeAction.DetectNumberFormat); + + //Apply Marker. + marker.ApplyMarkers(); + + //Save and Dispose. + workbook.SaveAs("TemplateMarker.xlsx"); + workbook.Close(); + } + + + + + + Removes a variable with specified name from the collection. + + Name of the variable. + + If we remove the marker variable from marker and keep the marker variable in document then using will cause exception. + Since the default argument is . To avoid this we can use or + as arguments in method. + + + The variables added in marker can be removed using method. Removing marker variable avoids loading + data that is not required. Here for example, we add marker variables "%Names" and "%Numbers", then we remove "%Numbers" from the marker object. + So the method will import data for the marker "%Names" only and it simply ignores "%Numbers". + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Data to be used for Template Marker. + string[] names = new string[] { "A", "B", "C", "D" }; + string[] numbers = new string[] { "1", "2", "3", "4" }; + + //Add marker variables in the worksheet. + worksheet["A1"].Text = "Names"; + worksheet["B1"].Text = "Numbers"; + worksheet["A2"].Text = "%Names"; + worksheet["B2"].Text = "%Numbers"; + + //Create a Template Marker Instance. + ITemplateMarkersProcessor marker = workbook.CreateTemplateMarkersProcessor(); + + //Add variable names from the binding context to Template Marker. + marker.AddVariable("Names", names); + marker.AddVariable("Numbers", numbers); + + //Remove variable from marker object + marker.RemoveVariable("Numbers"); + + //Apply Marker. + marker.ApplyMarkers(UnknownVariableAction.Skip); + + //Save and Dispose. + workbook.SaveAs("TemplateMarker.xlsx"); + workbook.Close(); + } + + + + + + Checks whether template markers object contains variable with the specified name. + + Name to locate. + Indicates whether the markers contains the variable. + + To check whether a marker variable is present in the marker object we can use this method. + For example, here we add marker variable %Names then we check whether the marker object contains the marker variable. If marker + has the variable then it returns "true". + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Data to be used for Template Marker. + string[] names = new string[] { "A", "B", "C", "D" }; + string[] numbers = new string[] { "1", "2", "3", "4" }; + + //Add marker variables in the worksheet. + worksheet["A1"].Text = "Names"; + worksheet["B1"].Text = "Numbers"; + worksheet["A2"].Text = "%Names"; + worksheet["B2"].Text = "%Numbers"; + + //Create a Template Marker Instance. + ITemplateMarkersProcessor marker = workbook.CreateTemplateMarkersProcessor(); + + //Add variable names from the binding context to Template Marker. + marker.AddVariable("Names", names); + + //Check whether marker contains the variables. + Console.WriteLine(marker.ContainsVariable("Names")); + Console.WriteLine(marker.ContainsVariable("Numbers")); + + //Dispose. + workbook.Close(); + } + //Output for the code will be + //True + //False + + + + + + Adds a conditional format to the Template Marker. + + Represents the range where the conditional format to be applied. + To know more about using conditional formats with Template Markers refer this + link. + To get some additional information about conditional formats and applicable format types + check this link. + + Newly added conditional formats. + + Conditional Formats can be applied to the data imported using template marker. In order to do that we have to create conditonal + formats within the template marker range. Here we import data from and apply conditional format for + each column. For this example the marker variables are in cells "A2", "B2" and "C2" so the conditional formats should use these ranges. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Add marker variables in the worksheet. + worksheet["A1"].Text = "SalesPerson"; + worksheet["B1"].Text = "SalesJanJun"; + worksheet["C1"].Text = "SalesJulDec"; + worksheet["D1"].Text = "Change"; + worksheet["A2"].Text = "%Reports.SalesPerson"; + worksheet["B2"].Text = "%Reports.SalesJanJun"; + worksheet["C2"].Text = "%Reports.SalesJulDec"; + worksheet["D2"].Text = "%Reports.Change"; + + //Create Template Marker Processor + ITemplateMarkersProcessor marker = workbook.CreateTemplateMarkersProcessor(); + + //Create Conditional Formats within the Template Marker range. + IConditionalFormats conditionalFormats = marker.CreateConditionalFormats(worksheet["B2"]); + IConditionalFormat condition = conditionalFormats.AddCondition(); + + + //Set the format type + condition.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = condition.DataBar; + + //Set the constraint + dataBar.MinPoint.Type = ConditionValueType.LowestValue; + dataBar.MinPoint.Value = "0"; + dataBar.MaxPoint.Type = ConditionValueType.HighestValue; + dataBar.MaxPoint.Value = "0"; + + //Set color for Bar + dataBar.BarColor = System.Drawing.Color.FromArgb(156, 208, 243); + //Hide the value in data bar + dataBar.ShowValue = false; + + //Add IconSet as second conditional format for the existing databar. + condition = conditionalFormats.AddCondition(); + condition.FormatType = ExcelCFType.IconSet; + IIconSet iconSet = condition.IconSet; + iconSet.IconSet = ExcelIconSetType.FourRating; + iconSet.IconCriteria[0].Type = ConditionValueType.LowestValue; + iconSet.IconCriteria[0].Value = "0"; + iconSet.IconCriteria[1].Type = ConditionValueType.HighestValue; + iconSet.IconCriteria[1].Value = "0"; + iconSet.ShowIconOnly = true; + + //Create Conditional Formats within the Template Marker range. + conditionalFormats = marker.CreateConditionalFormats(worksheet["C2"]); + + //Color Scale + condition = conditionalFormats.AddCondition(); + condition.FormatType = ExcelCFType.ColorScale; + IColorScale colorScale = condition.ColorScale; + + //Sets 3 - color scale. + colorScale.SetConditionCount(3); + colorScale.Criteria[0].FormatColorRGB = System.Drawing.Color.FromArgb(230, 197, 218); + colorScale.Criteria[0].Type = ConditionValueType.LowestValue; + colorScale.Criteria[0].Value = "0"; + colorScale.Criteria[1].FormatColorRGB = System.Drawing.Color.FromArgb(244, 210, 178); + colorScale.Criteria[1].Type = ConditionValueType.Percentile; + colorScale.Criteria[1].Value = "50"; + colorScale.Criteria[2].FormatColorRGB = System.Drawing.Color.FromArgb(245, 247, 171); + colorScale.Criteria[2].Type = ConditionValueType.HighestValue; + colorScale.Criteria[2].Value = "0"; + + //Create Conditional Formats within the Template Marker range. + conditionalFormats = marker.CreateConditionalFormats(worksheet["D2"]); + + //Icon set + condition = conditionalFormats.AddCondition(); + condition.FormatType = ExcelCFType.IconSet; + iconSet = condition.IconSet; + iconSet.IconSet = ExcelIconSetType.ThreeSymbols; + iconSet.IconCriteria[0].Type = ConditionValueType.LowestValue; + iconSet.IconCriteria[0].Value = "0"; + iconSet.IconCriteria[1].Type = ConditionValueType.HighestValue; + iconSet.IconCriteria[1].Value = "0"; + iconSet.ShowIconOnly = false; + + //Add datatable from GetDataTable method as Template Marker variable "Reports". + marker.AddVariable("Reports", GetDataTable()); + + //Process the markers in the template. + marker.ApplyMarkers(); + + //Save and Dispose. + workbook.SaveAs("TemplateMarker.xlsx"); + workbook.Close(); + } + + //GetDataTable method + System.Data.DataTable GetDataTable() + { + System.Data.DataTable reports = new System.Data.DataTable(); + reports.Columns.Add("SalesPerson"); + reports.Columns.Add("SalesJanJun", typeof(int)); + reports.Columns.Add("SalesJulDec", typeof(int)); + reports.Columns.Add("Change", typeof(int)); + reports.Rows.Add("Andy Bernard", 45000, 58000, 29); + reports.Rows.Add("Jim Halpert", 34000, 65000, 91); + reports.Rows.Add("Karen Fillippelli", 75000, 64000, 15); + reports.Rows.Add("Phyllis Lapin", 56500, 33600, 40); + reports.Rows.Add("Stanley Hudson", 46500, 52000, 12); + return reports; + } + + + + + + Gets or sets the marker prefix. String indicates that the cells contains marker. + + + To know more about template marker variable syntax refer this link. + + + The default template marker prefix is "%". This can be changed by using property. Here for example, we change + the marker prefix to "*" and use this prefix in our template marker variables. To know about + customizing the argument separator refer Property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Data to be used for Template Marker. + string[] names = new string[] { "SalesPerson", "SalesJanJun", "SalesJulDec", "Change" }; + + //Add marker variables in the worksheet. + worksheet["A1"].Text = "*Names;horizontal"; + worksheet["A2"].Text = "*Reports.SalesPerson;vertical"; + worksheet["B2"].Text = "*Reports.SalesJanJun;vertical"; + worksheet["C2"].Text = "*Reports.SalesJulDec;vertical"; + worksheet["D2"].Text = "*Reports.Change;vertical"; + + //Create a Template Marker Instance. + ITemplateMarkersProcessor marker = workbook.CreateTemplateMarkersProcessor(); + + //Change the default prefix to "*". + marker.MarkerPrefix = "*"; + + //Add variable names from the binding context to Template Marker. + marker.AddVariable("Names", names); + marker.AddVariable("Reports", GetDataTable()); + + //Apply Marker. + marker.ApplyMarkers(); + + //Save and Dispose. + workbook.SaveAs("TemplateMarker.xlsx"); + workbook.Close(); + } + + //GetDataTable method + System.Data.DataTable GetDataTable() + { + System.Data.DataTable reports = new System.Data.DataTable(); + reports.Columns.Add("SalesPerson"); + reports.Columns.Add("SalesJanJun", typeof(int)); + reports.Columns.Add("SalesJulDec", typeof(int)); + reports.Columns.Add("Change", typeof(int)); + reports.Rows.Add("Andy Bernard", 45000, 58000, 29); + reports.Rows.Add("Jim Halpert", 34000, 65000, 91); + reports.Rows.Add("Karen Fillippelli", 75000, 64000, 15); + reports.Rows.Add("Phyllis Lapin", 56500, 33600, 40); + reports.Rows.Add("Stanley Hudson", 46500, 52000, 12); + return reports; + } + + + + + + Gets or sets the arguments separator. Default argument separator is ';'. + + + To know more about template marker variable syntax refer this link. + + + The default argument separator for template marker is ';'. We can change this by using Property. + Here for example, we change the default separator to ':' and used this separator in our template marker variables. To know about customizing marker prefix refer property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Data to be used for Template Marker. + string[] names = new string[] { "SalesPerson", "SalesJanJun", "SalesJulDec", "Change" }; + + //Add marker variables in the worksheet. + worksheet["A1"].Text = "%Names:horizontal"; + worksheet["A2"].Text = "%Reports.SalesPerson:vertical"; + worksheet["B2"].Text = "%Reports.SalesJanJun:vertical"; + worksheet["C2"].Text = "%Reports.SalesJulDec:vertical"; + worksheet["D2"].Text = "%Reports.Change:vertical"; + + //Create a Template Marker Instance. + ITemplateMarkersProcessor marker = workbook.CreateTemplateMarkersProcessor(); + + //Change the default separator to ':'. + marker.ArgumentSeparator = ':'; + + //Add variable names from the binding context to Template Marker. + marker.AddVariable("Names", names); + marker.AddVariable("Reports", GetDataTable()); + + //Apply Marker. + marker.ApplyMarkers(); + + //Save and Dispose. + workbook.SaveAs("TemplateMarker.xlsx"); + workbook.Close(); + } + + //GetDataTable method + System.Data.DataTable GetDataTable() + { + System.Data.DataTable reports = new System.Data.DataTable(); + reports.Columns.Add("SalesPerson"); + reports.Columns.Add("SalesJanJun", typeof(int)); + reports.Columns.Add("SalesJulDec", typeof(int)); + reports.Columns.Add("Change", typeof(int)); + reports.Rows.Add("Andy Bernard", 45000, 58000, 29); + reports.Rows.Add("Jim Halpert", 34000, 65000, 91); + reports.Rows.Add("Karen Fillippelli", 75000, 64000, 15); + reports.Rows.Add("Phyllis Lapin", 56500, 33600, 40); + reports.Rows.Add("Stanley Hudson", 46500, 52000, 12); + return reports; + } + + + + + + Default marker prefix. + + + + + Delimiter between property parts. + + + + + Default string for Null value. + + + + + Standard separator between marker arguments. + + + + + Default Image Size Argument index for the list of possible arguments + + + + + Default Image Position Argument index for the list of possible arguments + + + + + Number of rows need to be created + + + + + Default index for FitToCell argument in list of possible arguments + + + + + Checks whether template markers Nestobject in first row + + + + + List with instances of possible argument classes. + + + + + Possible parent types. + + + + + Dictionary of markers in the workbook. + + + + + Dictionary with user-defined variables. + + + + + Marker prefix. String that indicates that cell contains marker. + + + + + Arguments separator. + + + + + Parent workbook object. + + + + + Represents the auto detection of the marker variable. + + + + + Represent the conditional formats in the template marker. + + + + + Collection of CallSite delegates stored with the key [typename_propertyname] for custom dynamic object + + + + + List holds the information of inserted cells + + + + + List that holds the text vertical position data of each range builder + + + + + Initializes static members of the TemplateMarkersImpl class. + + + + + Initializes a new instance of the TemplateMarkersImpl class. + + Application object for the new object. + Parent object for the new object. + + + + Applies markers to the parent object. + + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + ITemplateMarkersProcessor marker = workbook.CreateTemplateMarkersProcessor(); + System.Data.DataTable reports = new System.Data.DataTable(); + reports.Columns.Add("SalesPerson"); + reports.Columns.Add("FromDate", typeof(DateTime)); + reports.Columns.Add("ToDate", typeof(DateTime)); + reports.Rows.Add("Andy Bernard", new DateTime(2014, 09, 08), new DateTime(2014, 09, 11)); + reports.Rows.Add("Jim Halpert", new DateTime(2014, 09, 11), new DateTime(2014, 09, 15)); + reports.Rows.Add("Karen Fillippelli", new DateTime(2014, 09, 15), new DateTime(2014, 09, 20)); + reports.Rows.Add("Phyllis Lapin", new DateTime(2014, 09, 21), new DateTime(2014, 09, 25)); + reports.Rows.Add("Stanley Hudson", new DateTime(2014, 09, 26), new DateTime(2014, 09, 30)); + + //Detects number format in DateTable values. + marker.AddVariable("Reports", reports,VariableTypeAction.DetectNumberFormat); + marker.ApplyMarkers(); + + + + + + Applies markers to the parent object with the specified . + + Marker Unknown Variable. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + ITemplateMarkersProcessor marker = workbook.CreateTemplateMarkersProcessor(); + System.Data.DataTable reports = new System.Data.DataTable(); + reports.Columns.Add("SalesPerson"); + reports.Columns.Add("FromDate", typeof(DateTime)); + reports.Columns.Add("ToDate", typeof(DateTime)); + reports.Rows.Add("Andy Bernard", new DateTime(2014, 09, 08), new DateTime(2014, 09, 11)); + reports.Rows.Add("Jim Halpert", new DateTime(2014, 09, 11), new DateTime(2014, 09, 15)); + reports.Rows.Add("Karen Fillippelli", new DateTime(2014, 09, 15), new DateTime(2014, 09, 20)); + reports.Rows.Add("Phyllis Lapin", new DateTime(2014, 09, 21), new DateTime(2014, 09, 25)); + reports.Rows.Add("Stanley Hudson", new DateTime(2014, 09, 26), new DateTime(2014, 09, 30)); + + //Detects number format in DateTable values. + marker.AddVariable("Reports", reports,VariableTypeAction.DetectNumberFormat); + marker.ApplyMarkers(UnknownVariableAction.Exception); + + + + + + Adds a variable to the collection with the specified variable name and value. + + Name of the variable. + Value of the variable. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + ITemplateMarkersProcessor marker = workbook.CreateTemplateMarkersProcessor(); + System.Data.DataTable reports = new System.Data.DataTable(); + reports.Columns.Add("SalesPerson"); + reports.Columns.Add("FromDate", typeof(DateTime)); + reports.Columns.Add("ToDate", typeof(DateTime)); + reports.Rows.Add("Andy Bernard", new DateTime(2014, 09, 08), new DateTime(2014, 09, 11)); + reports.Rows.Add("Jim Halpert", new DateTime(2014, 09, 11), new DateTime(2014, 09, 15)); + reports.Rows.Add("Karen Fillippelli", new DateTime(2014, 09, 15), new DateTime(2014, 09, 20)); + reports.Rows.Add("Phyllis Lapin", new DateTime(2014, 09, 21), new DateTime(2014, 09, 25)); + reports.Rows.Add("Stanley Hudson", new DateTime(2014, 09, 26), new DateTime(2014, 09, 30)); + marker.AddVariable("Reports", reports); + + + + + + Adds a variable to the collection with the specified name, value and . + + Name of the variable. + Value of the variable. + Marker variable type. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + ITemplateMarkersProcessor marker = workbook.CreateTemplateMarkersProcessor(); + System.Data.DataTable reports = new System.Data.DataTable(); + reports.Columns.Add("SalesPerson"); + reports.Columns.Add("FromDate", typeof(DateTime)); + reports.Columns.Add("ToDate", typeof(DateTime)); + reports.Rows.Add("Andy Bernard", new DateTime(2014, 09, 08), new DateTime(2014, 09, 11)); + reports.Rows.Add("Jim Halpert", new DateTime(2014, 09, 11), new DateTime(2014, 09, 15)); + reports.Rows.Add("Karen Fillippelli", new DateTime(2014, 09, 15), new DateTime(2014, 09, 20)); + reports.Rows.Add("Phyllis Lapin", new DateTime(2014, 09, 21), new DateTime(2014, 09, 25)); + reports.Rows.Add("Stanley Hudson", new DateTime(2014, 09, 26), new DateTime(2014, 09, 30)); + marker.AddVariable("Reports", reports, VariableTypeAction.DetectNumberFormat); + + + + + + Removes a variable with specified name from the collection. + + Name of the Variable. + + + + Applies markers to the specified worksheet. + + Worksheet to apply markers to. + + + + Applies markers to the specified worksheet. + + Worksheet to apply markers to. + Marker Unknown Variable. + + + + Applies markers to the whole workbook. + + Workbook to apply markers to. + + + + Applies markers to the parent object with the specified . + + Workbook to apply markers to. + Marker Unknown Variable. + + + + Checks whether template markers object contains variable with the specified name. + + Name to locate. + Indicates whether the markers contains the variable. + + + + Adds a conditional format to the Template Marker. + + Represents the range where the conditional format to be applied. + The conditional format range should be within the template marker range. + Newly added conditional formats. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create Template Marker Processor + ITemplateMarkersProcessor marker = workbook.CreateTemplateMarkersProcessor(); + IConditionalFormats conditionalFormats = marker.CreateConditionalFormats(worksheet["C6"]); + + //Data Bar + //Apply markers using Formula + IConditionalFormat condition = conditionalFormats.AddCondition(); + + //Set Data bar and icon set for the same cell + //Set the format type + condition.FormatType = ExcelCFType.DataBar; + IDataBar dataBar = condition.DataBar; + + //Set the constraint + dataBar.MinPoint.Type = ConditionValueType.LowestValue; + dataBar.MinPoint.Value = "0"; + dataBar.MaxPoint.Type = ConditionValueType.HighestValue; + dataBar.MaxPoint.Value = "0"; + + //Set color for Bar + dataBar.BarColor = System.Drawing.Color.FromArgb(156, 208, 243); + //Hide the value in data bar + dataBar.ShowValue = false; + + //IconSet + condition = conditionalFormats.AddCondition(); + condition.FormatType = ExcelCFType.IconSet; + IIconSet iconSet = condition.IconSet; + iconSet.IconSet = ExcelIconSetType.FourRating; + iconSet.IconCriteria[0].Type = ConditionValueType.LowestValue; + iconSet.IconCriteria[0].Value = "0"; + iconSet.IconCriteria[1].Type = ConditionValueType.HighestValue; + iconSet.IconCriteria[1].Value = "0"; + iconSet.ShowIconOnly = true; + conditionalFormats = marker.CreateConditionalFormats(worksheet["D6"]); + + //Color Scale + condition = conditionalFormats.AddCondition(); + condition.FormatType = ExcelCFType.ColorScale; + IColorScale colorScale = condition.ColorScale; + + //Sets 3 - color scale. + colorScale.SetConditionCount(3); + colorScale.Criteria[0].FormatColorRGB = System.Drawing.Color.FromArgb(230, 197, 218); + colorScale.Criteria[0].Type = ConditionValueType.LowestValue; + colorScale.Criteria[0].Value = "0"; + colorScale.Criteria[1].FormatColorRGB = System.Drawing.Color.FromArgb(244, 210, 178); + colorScale.Criteria[1].Type = ConditionValueType.Percentile; + colorScale.Criteria[1].Value = "50"; + colorScale.Criteria[2].FormatColorRGB = System.Drawing.Color.FromArgb(245, 247, 171); + colorScale.Criteria[2].Type = ConditionValueType.HighestValue; + colorScale.Criteria[2].Value = "0"; + conditionalFormats = marker.CreateConditionalFormats(worksheet["E6"]); + + //Icon set + condition = conditionalFormats.AddCondition(); + condition.FormatType = ExcelCFType.IconSet; + iconSet = condition.IconSet; + iconSet.IconSet = ExcelIconSetType.ThreeSymbols; + iconSet.IconCriteria[0].Type = ConditionValueType.LowestValue; + iconSet.IconCriteria[0].Value = "0"; + iconSet.IconCriteria[1].Type = ConditionValueType.HighestValue; + iconSet.IconCriteria[1].Value = "0"; + iconSet.ShowIconOnly = false; + + marker.AddVariable("Reports", GetDataTable()); + + //Process the markers in the template. + marker.ApplyMarkers(); + + + //GetDataTable method + System.Data.DataTable GetDataTable() + { + System.Data.DataTable reports = new System.Data.DataTable(); + reports.Columns.Add("SalesPerson"); + reports.Columns.Add("SalesJanJun", typeof(int)); + reports.Columns.Add("SalesJulDec", typeof(int)); + reports.Columns.Add("Change", typeof(int)); + reports.Rows.Add("Andy Bernard", 45000, 58000, 29); + reports.Rows.Add("Jim Halpert", 34000, 65000, 91); + reports.Rows.Add("Karen Fillippelli", 75000, 64000, -15); + reports.Rows.Add("Phyllis Lapin", 56500, 33600, -40); + reports.Rows.Add("Stanley Hudson", 46500, 52000, 12); + return reports; + } + + + + + + Applies markers to the worksheet. + + Worksheet to apply markers to. + All cell indexes with markers. + + + + Checks the class marker in the worksheet. + + The current sheet object. + The unknown variable action. + The array of cell indexes. + The migrant range to apply the indexes. + Indicates whether the sheet contains the class marker. + + + + Checks and applies headers. + + The obj to get the headers. + The current sheet object. + The unknown variable action. + The array of cells indexes. + The migrant range to set the header names. + Indicates whether the markers are applied. + + + + Try and set headers. + + The obj to get the headers. + indicates the name of class + indicates whether the object is dynamic + The current sheet object. + The unknown variable action. + The array of cells indexes. + The migrant range to set the header names. + Indicates whether the markers are applied. + + + + Sets the object header. + + The obj to get the headers. + The marker text. + The current sheet object. + The migrant range to set the header. + The index of the marker cells. + The list of marker arguments. + The marker options. + Indicates whether the object is dynamic + The unknown variable action. + + + + Arrange the row and columns based on the object headers and direction. + + The curretn sheet object. + The migrant range to inser the rows or columns. + The marker options. + Represent the number of row or columns to insert. + indicates whether arrange cells in rows or columns relatives. + + + + Gets the object members info. + + The obj to get the members. + + + + + Applies the condtional format to the given ranges. + + Represents the ranges where the conditional format to be applied. + + + + Updates chart ranges. + + Parent workbook. + Parent worksheet. + List with cells that contained smartmarkers. + List with RangeBuilder instances. + + + + Update reference to the cell with template. + + Parent workbook. + Parent worksheet. + Cell index. + Builder with info about new range. + + + + Updates all charts in the worksheet. + + Worksheet to update. + Worksheet that contains specified cell. + Cell index with cell address to update. + Contains updated range info. + + + + Updates table range. + + Parent worksheet. + List with RangeBuilder instances. + + + + Updates chart ranges after marker application for single chart. + + Chart to update. + Parent worksheet. + Cell index with cell address to update. + Contains updated range info. + + + + Compares range and cell index. + + Range to compare. + Parent worksheet for the second range to compare. + CellIndex of the second range to compare. + True if range is equal to pair of sheet and cell index. + + + + Searches for all strings that contains smart markers. + + Worksheet to search into. + Labels with smart markers. + List with all cell indexes that contains smart markers. + + + + Applies marker that is located in the specified cell. + + Parent worksheet. + List with all cells that contains markers. + Cell index in the list. + Object that defines current cell, where value must be placed. + Range builder with update marker range information. + + + + Applies the text horizontal position to the range and sets the text vertical position into a list + + parent worksheet + List with marker arguments sorted by priority + Range builder that will get resulting range information + + + + Applies the text vertical position to the range + + parent worksheet + list that contains the range builder + + + + Extracts variable name from existing text and removes it from original text. + + Text to parse. + Marker arguments. + Variable name. + + + + Extracts parent name from existing text. + + Text to parse. + Variable name. + + + + Imports variable value. + + Variable name to set. + Text after variable that can allow to access to different properties. + Worksheet that contains cell with marker to process. + Object that defines current cell, where value must be placed. + List with all cells that contain template markers. + List with marker arguments sorted by priority. + Marker options. + Range builder that will get resulting range information. + + + + Detects variable type and sets value. + + Value to set. + Text after variable that can allow to access to different properties. + Worksheet that contains cell with marker to process. + Object that defines current cell, where value must be placed. + List with all cells that contain template markers. + List with marker arguments sorted by priority. + Template marker options. + Range builder that will get resulting range information. + + + + Detects variable type and sets value. + + Value to set. + Text after variable that can allow to access to different properties. + Worksheet that contains cell with marker to process. + Object that defines current cell, where value must be placed. + List with all cells that contain template markers. + List with marker arguments sorted by priority. + Template marker options. + Range builder that will get resulting range information. + + + + Sets simple value. + + Value to set. + Properties of the object to set cell value to. + Worksheet to set cell in. + Object that defines current cell, where value must be placed. + List with all cells that contain template markers. + List with marker arguments sorted by priority. + Marker options. + Range builder that will get resulting range information. + + + + Set the value in the given migrant range + + input value + parent worksheet of range + input migrant range + list of arguments + marker options value + range builder value + variable action type value + input number format + input value type + + + + Check whether the new space argument is in the list. + On initial cells merge is not enabled on image + + input list arguments + the boolean value represents whether merge is applied or not + + + + Detects and get the value type of the each column. + + values of the data columns. + detected number formats. + Detected values Types. + Format Type. + + + + Get the value based on the valueType + + string value. + Type of the given value. + value as object. + + + + Get value, value type and the number format. + + string value. + number format of the value. + Type of the value. + Indicates, whether to detect Number format. + value as object. + + + + Returns next value in the properties chain. + + First value in the chain. + String representation of the properties chain. + Next value. + + + + Get the type and numberformat from the input value + + input value + input attributes of the property + data type of value + numberformat of the input value + + + + Get the reference of the value from input string value + + input object value + input string property name + output boolean value shows the object is expando or not + output boolean value shows the object is custom defined object + the reference of the value + + + + Check whether the property is available in customized dynamic object + + input custom dynamic object + property name to be checked + if property list is empty returns null, otherwise returns boolean + + + + Check whether the dynamic object is empty or not + + object need to be checked + the boolean value indicates input is empty + + + + Sets array value. + + Value to set. + Text after variable that can allow to access to different properties. + Worksheet that contains cell with marker to process. + Object that defines current cell, where value must be placed. + List with all cells that contain template markers. + List with marker arguments sorted by priority. + Template marker options. + Range builder that will get resulting range information. + Indicates whether to preserver marker type and number format. + + + + Sets array value. + + Value to set. + Text after variable that can allow to access to different properties. + Worksheet that contains cell with marker to process. + Object that defines current cell, where value must be placed. + List with all cells that contain template markers. + List with marker arguments sorted by priority. + Marker options. + Range builder that will get resulting range information. + Indicates whether to preserver marker type and number format. + + + + Set the string value in the given range if the conditions are true + + start index of the range inserting + input migrant range + input value to be set + marker options value + boolean value indicates whether the source range has string number format + range builder object + boolean value indicates whether the value set or not + + + + Check if the given object is nested object and get total children count from the object. + + input object value + Properties + collection count to be extract. + Returns true if the collection count is greater than 0; otherwise false + + + + Sets DataSet value. + + Value to import. + Properties chain. + Worksheet that contains cell with marker. + Object that defines current cell, where value must be placed. + List with all cells that contain template markers. + List with marker arguments sorted by priority. + Marker options. + Range builder that will get resulting range information. + Indicates whether to preserver marker type and number format. + + + + Imports DataView into marker position. + + Value to import. + Text with remaining properties chain. + Worksheet to import data table into. + Object that defines current cell, where value must be placed. + List with all cells that contain template markers. + List with marker arguments sorted by priority. + Marker options. + Range builder that will get resulting range information. + Indicates whether to preserver marker type and number format. + + + + Imports DataTable into marker position. + + Value to import. + Text with remaining properties chain. + Worksheet to import data table into. + Object that defines current cell, where value must be placed. + List with all cells that contain template markers. + List with marker arguments sorted by priority. + Marker options. + Range builder that will get resulting range information. + Indicates whether to preserver marker type and number format. + + + + Processes unknown property based on user-defined action. + + Property name. + Defined action. + Text with remaining properties chain. + Worksheet to import data table into. + Object that defines current cell, where value must be placed. + List with all cells that contain template markers. + List with marker arguments sorted by priority. + Marker options. + Range builder that will get resulting range information. + Indicates whether to preserver marker type and number format. + + + + Imports DataColumn into marker position. + + Value to import. + Text with remaining properties chain. + Worksheet to import data table into. + Object that defines current cell, where value must be placed. + List with all cells that contain template markers. + List with marker arguments sorted by priority. + Marker options. + Range builder that will get resulting range information. + Indicates whether to preserver marker type and number format. + + + + Check whether the list of arguments contains the copyrange argument + And call copy range for stored. + + input worksheet + list of marker arguments + the marker options + Start point of the template marker applying + + + + Prepares next cell for markers import. + + Worksheet to import markers into. + Object that defines current cell, where value must be placed. + List with all marker cells. + List with marker arguments sorted by priority. + Marker options. + True if next cell was prepared; false if it weren't and we need to stop importing values. + + + + Prepares next cell for markers import. + + Worksheet to import markers into. + Object that defines current cell, where value must be placed. + List with all marker cells. + List with marker arguments sorted by priority. + Marker options. + Indicates whether the current object is nested collection or not. + Nested collection count. + Indicates whether the current insert row is first or not. + True if next cell was prepared; false if it weren't and we need to stop importing values. + + + + Indicates whether object is array. + + Value to check. + True if object is array, False otherwise. + + + + Indicates whether object is collection. + + Value to check. + True if object is collection, False otherwise. + + + + Indicates whether object is DataSet. + + Value to check. + True if object is collection, False otherwise. + + + + Indicates whether object is DataTable. + + Value to check. + True if object is collection, False otherwise. + + + + + Indicates whether object is DataTable. + + Value to check. + True if object is collection, False otherwise. + + + + Indicates whether specified object contains property with specified name. + + Object to search property in. + Property name to search. + Output property information, null if no property was found. + True if object contains such property. + + + + Gets name of the next property and updates original text removing that property. + + Text that contains property chain. + Next property in the chain. + + + + Peeks name of the next property without updating original text. + + Text that contains property chain. + Next property in the chain. + + + + Parses arguments. + + Arguments string. + Prepared marker options. + List with arguments that should be applied during next cell preparation. + + + + Converts sorted list with template marker arguments into IList. + + Sorted list to convert. + Template marker options. + Converted IList with all arguments. + + + + Inserts default jump attribute if it is necessary. + + Sorted list with arguments. Key - argument priority, value - argument object. + Prepared marker options. + + + + Parses single marker argument. + + Argument to parse. + Newly created marker argument. + + + + Applies template marker arguments. + + Worksheet to import markers into. + One-based row index of the last filled cell. + One-based column index of the last filled cell. + List with all marker cells. + List with arguments. + Marker options. + Indicates whether the current insert row is first row or not. + Indicates whether the current insert row is last row or not. + + + + Check whether the marker has fit to cell argument + + Image to be set. + Worksheet of the cell with image. + Object that defines current cell, where image must be placed. + List with marker arguments sorted by priority. + Boolean value indicates whether the merge applied + boolean value respect to the image which is stretched in the specified range + + + + Sets image on the cell with its given size and given position + + Image to be set. + Worksheet of the cell with image. + Object that defines current cell, where image must be placed. + List with marker arguments sorted by priority. + Boolean value indicates whether the merge applied + + + + Check for any ImagePositonArgument is in the list of arguments + If it is set the position,else assign default value. + + Object that defines picture to be aligned in the specified range + Range of the size + List with marker arguments sorted by priority. + + + + Check the ImageSizeArgument is available in lstArguments + if available returns customized size,else default size + + Image to be set. + List with marker arguments sorted by priority. + Worksheet of the cell with image. + Object that defines current cell, where image must be placed. + size of the image + + + + + Gets or sets the arguments separator. Default argument separator is ';'. + + + + + structure used to store the information of insert-copystyles applied cells + + + + + Parametered Constructor + + boolean value shows style is copied + integer cells count to be inserted + + + + This class represents an Excel Workbook. + + + + + Represents an MS Excel Workbook. + + + + + Creates the Data sorter to sort the data. + + Returns the Data Sorter. + + + + Activates the first window associated with the workbook. + + + + + Adds font to the inner fonts collection. Read-only. + + Font to add. + Added . + + The following code illustrates how to add to the . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Create font + IFont font = workbook.CreateFont(); + + //Add font + workbook.AddFont(font); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Closes the object and saves workbook to the specified file name.If True, all changes will be saved. + + If True, all changes will be saved. + Name of the file. + The following code illustrates how to Closes the object and saves workbook to the specified file name. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.Close(true,"Output.xlsx"); + + + + + + Closes the object. If True, all changes will be saved. + + If True, all changes will be saved. + The following code illustrate how to closes the object with specified bool value. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.Close(true); + + + + + + Closes the object without saving. + + The following code illustrate how to closes the object without saving. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.Close(); + + + + + + Closes the object and saves workbook to the specified file name. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + File name in which workbook will be saved if SaveChanges is true. + + The following code illustrates how to closes the object and saves workbook with specified name. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.Close("Output.xlsx"); + + + + + + Save changes to the specified workbook. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.Save(); + + + + + + Saves workbook with the specified file name. + + Name of the file. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.SaveAs("Output.xls"); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Saves workbook with the specified file name and . + + Name of the file. + Excel save type. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.SaveAs("Output.xls", ExcelSaveType.SaveAsXLS); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Saves workbook with the specified file name and . + + File name to save into. + Xml save type. + + The following code snippet illustrates how to save as Xml. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.SaveAsXml("Output.xml", ExcelXmlSaveType.MSExcel); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Saves workbook with specified file name using separator. Used only for CSV files. + + Path to save. + Denotes separator for the CSV file types. + + The following code snippet illustrates how to save as CSV. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.SaveAs("Output.csv", ","); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Saves workbook with specified file name with given separator and encoding. Used only for CSV files. + + + This overloaded method can be used to apply encoding to the CSV file in particular. The default encoding type is UTF-8. Other encoding types include ASCII, UTF-7, and UTF-32. + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + Path to save the CSV file. + Denotes separator for the CSV file types. + The name of a character encoding that is supported by the .NET Framework. + + + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = engine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet["A1"].Text = "This"; + worksheet["B1"].Text = "is"; + worksheet["C1"].Text = "a"; + worksheet["D1"].Text = "sample"; + worksheet["E1"].Text = "to"; + worksheet["F1"].Text = "set"; + worksheet["G1"].Text = "encoding"; + workbook.SaveAs("Output.csv", ",",Encoding.Unicode); + } + + + + + + Saves as Html to specified file name based on . + + Name of the file. + Save options in html + + The following code snippets illustrates how to save as html to the specified file name. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.SaveAsHtml("Output.html",HtmlSaveOptions.Default); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Saves as Html to the specified stream. + + stream that will receive html data. + + The following code snippets illustrates how to save as html to the specified stream. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + Stream stream = new MemoryStream(); + workbook.SaveAsHtml(stream); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Saves as Html to the specified stream based on . + + stream that will receive html data. + Save options in html + + The following code snippets illustrates how to save as html to the specified stream. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + Stream stream = new MemoryStream(); + workbook.SaveAsHtml(stream,HtmlSaveOptions.Default); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Creates a font object based on native font. + + Native font to get settings from. + returns newly created font. + + The following code illustrates how to create a object based on native . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + IRichTextString richText = worksheet["B2"].RichText; + + //Get font + System.Drawing.Font nativeFont = new System.Drawing.Font(System.Drawing.FontFamily.GenericSerif, 9); + + //Create font + IFont font = workbook.CreateFont(nativeFont); + + //Set color + font.Color = ExcelKnownColors.Red; + + //Set text + richText.Text = "Sample"; + + //Set font + richText.SetFont(0, 5, font); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Replaces string with the specified data table value. + + String value to replace. + Data table with new data. + Indicates whether field name must be shown. + + The following code snippet illustrates how to replace the string value with data table. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + // create the data table + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("Dosage", typeof(int)); + table.Rows.Add(1); + string oldvalue = "AB2"; + // Replace the value with data table. + workbook.Replace(oldvalue, table, true); + + + + + + Replaces string with the specified DataColumn value. + + String value to replace. + Data table with new data. + Indicates whether field name must be shown. + + The following code snippet illustrates how to replace the string value with data table. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + // create the data table + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("Dosage", typeof(int)); + table.Rows.Add(1); + System.Data.DataColumn dataColumn = table.Columns[0]; + string oldvalue = "AB2"; + // Replace the value with data column. + workbook.Replace(oldvalue, dataColumn, true); + + + + + + Creates header or footer engine. + + Returns a new instance of header or footer engine. + + + + Copies workbook to the clipboard. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Save changes to the specified HttpResponse,using separator with the specified and . + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Name of the file in HttpResponse. + Denotes separator for the CSV file types. + HttpResponse that will receive workbook's data. + Download type. + Http content type. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.SaveAs("Output.csv", ",", Response, ExcelDownloadType.PromptDialog, ExcelHttpContentType.CSV); + + + + + + Save changes to the specified HttpResponse,using separator and encoding with the specified and . + + + This overloaded method can be used to apply encoding to the CSV file in particular. The default encoding type is UTF-8. Other encoding types include ASCII, UTF-7, and UTF-32. + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + Name of the file in HttpResponse. + Denotes separator for the CSV file types. + HttpResponse that will receive workbook's data. + Enumeration to specify the download type. + Enumeration to specify the Http content type. + The name of a character encoding that is supported by the .NET Framework. + + + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = engine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet["A1"].Text = "This"; + worksheet["B1"].Text = "is"; + worksheet["C1"].Text = "a"; + worksheet["D1"].Text = "sample"; + worksheet["E1"].Text = "to"; + worksheet["F1"].Text = "set"; + worksheet["G1"].Text = "encoding"; + workbook.SaveAs("Output.csv", ",", Response, ExcelDownloadType.PromptDialog, ExcelHttpContentType.CSV, Encoding.UTF7); + } + + + + + + Save changes to the specified HttpResponse based on . + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Name of the file in HttpResponse. + Type of the Excel file. + HttpResponse that will receive workbook's data. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.SaveAs("Output.xls", ExcelSaveType.SaveAsXLS, Response); + + + + + + Save changes to the specified HttpResponse based on and . + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Name of the file in HttpResponse. + Type of the Excel file. + HttpResponse that will receive workbook's data. + Content type to use. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.SaveAs("Output.xls", ExcelSaveType.SaveAsXLS, Response, ExcelHttpContentType.Excel97); + + + + + + Save changes to the specified HttpResponse based on . + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Name of the file in HttpResponse. + HttpResponse to save in. + Content type to use. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.SaveAs("Output.xls", Response, ExcelHttpContentType.Excel97); + + + + + + Save changes to the specified HttpResponse based on and . + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Name of the file in HttpResponse. + Type of the Excel file. + HttpResponse that will receive workbook's data. + Download type. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.SaveAs("Output.xls", ExcelSaveType.SaveAsXLS, Response, ExcelDownloadType.PromptDialog); + + + + + + Save changes to the specified HttpResponse based on , and . + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Name of the file in HttpResponse. + Type of the Excel file. + HttpResponse that will receive workbook's data. + Download type. + Content type to use. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.SaveAs("Output.xls", ExcelSaveType.SaveAsXLS, Response, ExcelDownloadType.PromptDialog, ExcelHttpContentType.Excel97); + + + + + + Save changes to the specified HttpResponse based on . + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Name of the file in HttpResponse. + HttpResponse that will receive workbook's data. + Download type. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.SaveAs("Output.xls", Response, ExcelDownloadType.PromptDialog); + + + + + + Save changes to the specified HttpResponse based on and . + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Name of the file in HttpResponse. + HttpResponse that will receive workbook's data. + Download type. + Content type to use. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.SaveAs("Output.xls", Response, ExcelDownloadType.PromptDialog, ExcelHttpContentType.Excel97); + + + + + + Create an instance that can be used for template markers processing. + + Returns the Object that can be used for template markers processing. + + + + Marks workbook as final. Read-Only. + + + + + Saves workbook as stream. + + This method is supported on Windows Forms, WPF, ASP.NET, ASP.NET MVC, ASP.NET Core, Blazor, and Xamarin platforms. + Stream that will receive workbook data. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + Stream stream = new MemoryStream(); + workbook.SaveAs(stream); + + + + + + Saves workbook as stream with specified . + + This method is supported on Windows Forms, WPF, ASP.NET, ASP.NET MVC, ASP.NET Core, Blazor, and Xamarin platforms. + Stream that will receive workbook data. + Type of the Excel file. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + Stream stream = new MemoryStream(); + workbook.SaveAs(stream, ExcelSaveType.SaveAsXLS); + + + + + + Saves workbook in xml format with the specified. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + XmlWriter to save into. + Xml save type. + + The following code snippet illustrates how to save as Xml using Xml writer. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + System.Xml.XmlWriter writer = System.Xml.XmlWriter.Create("Output.xml"); + workbook.SaveAsXml(writer, ExcelXmlSaveType.MSExcel); + + + + + + Saves workbook as stream with specified . + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Stream to save into. + Xml save type. + + The following code snippet illustrates how to save the stream as Xml. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + Stream stream = new MemoryStream(); + workbook.SaveAsXml(stream, ExcelXmlSaveType.MSExcel); + + + + + + Saves workbook as stream using separator. Used only for CSV files. + + This method is supported on Windows Forms, WPF, ASP.NET, ASP.NET MVC, ASP.NET Core, Blazor, and Xamarin platforms. + Stream to save. + Denotes separator for the CSV file types. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + Stream stream = new MemoryStream(); + workbook.SaveAs(stream, ","); + + + + + + Saves workbook as stream with given separator and encoding. Used only for CSV files. + + + This overloaded method can be used to apply encoding to the CSV file in particular. The default encoding type is UTF-8. Other encoding types include ASCII, UTF-7, and UTF-32. + + Stream to save the CSV file. + Denotes separator for the CSV file types. + The name of a character encoding that is supported by the .NET Framework. + + + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = engine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet["A1"].Text = "This"; + worksheet["B1"].Text = "is"; + worksheet["C1"].Text = "a"; + worksheet["D1"].Text = "sample"; + worksheet["E1"].Text = "to"; + worksheet["F1"].Text = "set"; + worksheet["G1"].Text = "encoding"; + MemoryStream stream = new MemoryStream(); + workbook.SaveAs(stream, ",",Encoding.Unicode); + } + + + + + + Saves the workbook to a JSON file. + + File name to save into. + + + + Saves the workbook to a JSON file as schema. + + File name to save into. + Indicates whether to save the workbook as JSON in schema type html + + + + Saves the worksheet to a JSON file. + + File name to save into. + Worksheet to save as JSON. + + + + Saves the worksheet to a JSON file as schema. + + File name to save into. + Worksheet to save as JSON. + Indicates whether to save the worksheet as JSON in schema type html + + + + Saves the range to a JSON file. + + File name to save into. + Range to save as JSON. + + + + Saves the range to a JSON file as schema. + + File name to save into. + Range to save as JSON. + Indicates whether to save the range as JSON in schema type html + + + + Saves the workbook to a JSON file stream. + + Stream to save into. + + + + Saves the workbook to a JSON file stream as schema. + + Stream to save into. + Indicates whether to save the workbook as JSON in schema type html + + + + Saves the worksheet to a JSON file stream. + + Stream to save into. + Worksheet to save as JSON. + + + + Saves the worksheet to a JSON file stream as schema. + + Stream to save into. + Worksheet to save as JSON. + Indicates whether to save the worksheet as JSON in schema type html + + + + Saves the range to a JSON file stream. + + Stream to save into. + Range to save as JSON. + + + + Saves the range to a JSON file stream as schema. + + Stream to save into. + Range to save as JSON. + Indicates whether to save the range as JSON in schema type html + + + + Sets the palette color for the given index. + + Index of Color in array. + New color which must be set. + + The following code snippet illustrates how to set palette color. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set palette color + workbook.SetPaletteColor(10, System.Drawing.Color.Red); + + //Set color + worksheet["B2"].CellStyle.Color = workbook.Palette[10]; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Recover palette to default values. + + + The following code snippets illustrates how to reset the palette. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Get colors + System.Drawing.Color[] colors = workbook.Palette; + + //Check color + Console.WriteLine(colors[2].Name); + + //Set color + colors[2] = System.Drawing.Color.Yellow; + + //Reset palette + workbook.ResetPalette(); + + //Check color + Console.WriteLine(workbook.Palette[2].Name); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + Console.ReadKey(); + } + //Output will be + //ffff0000 + //ffff0000 + + + + + + Returns Color object from predefined colors by its index. + + Index from palette array. + RGB Color. + + The following code illustrates how to get the RGB color value for the specified color from enumeration. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Get color + System.Drawing.Color color = workbook.GetPaletteColor(ExcelKnownColors.Red); + + //Set color + worksheet["B2"].CellStyle.Color = color; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets the nearest color with the specified Color structure + from Workbook palette. + + system color. + Returns Color index from workbook palette. + + The following code illustrates how to get the indexed color from for the given color from structure. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Get color + ExcelKnownColors color = workbook.GetNearestColor(System.Drawing.Color.Red); + + //Set color + worksheet["B2"].CellStyle.ColorIndex = color; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets the nearest color with the specified red, green, and blue + color values from Workbook palette. + + Red component of the color. + Green component of the color. + Blue component of the color. + Returns Color index from workbook palette. + + The following code illustrates how to get the indexed color from for the given color from structure. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Get color + ExcelKnownColors color = workbook.GetNearestColor(255, 0, 0); + + //Set color + worksheet["B2"].CellStyle.ColorIndex = color; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Sets the color or Gets nearest color. + + + If there is at least one free color, define a new color; + if not, search for the closest one to the specified Color structure + from Workbook palette. + + System color + Color index from workbook palette. + + The following code illustrates how to get the indexed color from for the given color from structure. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Get color + ExcelKnownColors color = workbook.SetColorOrGetNearest(System.Drawing.Color.Red); + + //Set color + worksheet["B2"].CellStyle.ColorIndex = color; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Sets the color or Gets nearest color with the specified red, green and blue color value. + + + If there is at least one free color, define a new color; + if not, search for the closest one to the specified by red, green, and blue + values color from Workbook palette. + + Red component of the color. + Green component of the color. + Blue component of the color. + Color index from workbook palette. + + The following code snippet illustrates how to set color or get nearest color by red,green and blue. + + workbook.SetColorOrGetNearest(123,45,56); + + + + The following code illustrates how to get the indexed color from for the given color from structure. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Get color + ExcelKnownColors color = workbook.SetColorOrGetNearest(255, 0, 0); + + //Set color + worksheet["B2"].CellStyle.ColorIndex = color; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Creates a object. + + Returns the newly created . + + The following code illustrates how to create object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + IRichTextString richText = worksheet["B2"].RichText; + + //Create font + IFont font = workbook.CreateFont(); + + //Set color + font.Color = ExcelKnownColors.Red; + + //Set text + richText.Text = "Sample"; + + //Set font + richText.SetFont(0, 5, font); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Creates font object based on another font object. + + Base font for the new one. + Returns a newly created font. + + The following code illustrates how to create a using existing . + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + IRichTextString richText = worksheet["B2"].RichText; + + //Get font + IFont defaultFont = worksheet["B2"].CellStyle.Font; + + //Create font + IFont font = workbook.CreateFont(defaultFont); + + //Set color + font.Color = ExcelKnownColors.Red; + + //Set text + richText.Text = "Sample"; + + //Set font + richText.SetFont(0, 5, font); + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Replaces string with the specified another string value. + + The string to be replaced. + The string to replace all occurrences of oldValue. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + string oldValue = "Find"; + string newValue = "NewValue"; + workbook.Replace(oldValue, newValue); + + + + + + Replaces string with the specified string value based on the given . + + The string to be replaced. + The string to replace all occurrences of oldValue. + Specifies the find options for the oldValue. + The following code snippet illustrates how to replace the string with another string. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + string oldValue = "Find"; + string newValue = "NewValue"; + sheet.Replace(oldValue, newValue, ExcelFindOptions.MatchCase); + + + + + + Replaces string with the specified double value. + + The string to be replaced. + The double value to replace all occurrences of oldValue. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + string oldValue = "Find"; + double newValue = 9.00; + workbook.Replace(oldValue, newValue); + + + + + + Replaces string with the specified DateTime value. + + The string to be replaced. + The DateTime to replace all occurrences of oldValue. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + string oldValue = "Find"; + DateTime dateTime = DateTime.Now; + workbook.Replace(oldValue, dateTime); + + + + + + Replaces specified string with the specified array of string values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + string oldValue = "Find"; + string[] newValues = { "X values", "Y values" }; + workbook.Replace(oldValue, newValues, true); + + + + + + Replaces specified string with the specified array of int values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + string oldValue = "Find"; + int[] newValues = { 1, 2 }; + workbook.Replace(oldValue, newValues, true); + + + + + + Replaces specified string with the specified array of double values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + string oldValue = "Find"; + double[] newValues = { 1.00, 3.00 }; + workbook.Replace(oldValue, newValues, true); + + + + + + Returns the first occurrence of the specified string value with the specified . + + Value to search. + Type of value to search. + First found cell, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + string value = "value"; + IRange result = workbook.FindFirst(value, ExcelFindType.Text); + + + + + + Returns the first occurrence of the specified string value with the specified and . + + Value to search. + Type of value to search. + Way to search the value. + First found cell, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + string findvalue = "value"; + IRange result = workbook.FindFirst(findvalue, ExcelFindType.Text, ExcelFindOptions.None); + + + + + + Returns the first occurrence that starts with the specified string value. + + Value to search. + Type of value to search. + First found cell, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + string value = "value"; + IRange result = workbook.FindStringStartsWith(value, ExcelFindType.Text); + + + + + + Returns the first occurrence that starts with the specified string value which ignores the case. + + Value to search. + Type of value to search. + true to ignore case wen comparing this string to the value;otherwise,false + First found cell, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + string value = "value"; + IRange result = workbook.FindStringStartsWith(value, ExcelFindType.Text, true); + + + + + + Returns the first occurrence that ends with the specified string value. + + Value to search. + Type of value to search. + First found cell, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + string value = "value"; + IRange result = workbook.FindStringEndsWith(value, ExcelFindType.Text); + + + + + + Returns the first occurrence that ends with the specified string value which ignores the case. + + Value to search. + Type of value to search. + true to ignore case wen comparing this string to the value;otherwise,false + First found cell, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + string value = "value"; + IRange result = workbook.FindStringEndsWith(value, ExcelFindType.Text, true); + + + + + + Returns the first occurrence of the specified double value with the specified . + + Value to search. + Type of value to search. + First found cell, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + double value = 9.00; + IRange result = workbook.FindFirst(value, ExcelFindType.Number); + + + + + + Returns the first occurrence of the specified bool value. + + Value to search. + First found cell, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IRange result = workbook.FindFirst(true); + + + + + + Returns the first occurrence of the specified DateTime value. + + Value to search. + First found cell, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + DateTime dateTime = DateTime.Now; + IRange result = workbook.FindFirst(dateTime); + + + + + + Returns the first occurrence of the specified TimeSpan value. + + Value to search. + First found cell, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + TimeSpan timeSpan = new TimeSpan(2, 30, 30); + IRange result = workbook.FindFirst(timeSpan); + + + + + + Returns the cells with specified string value. + + Value to search. + Type of value to search. + Returns all found cells, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IRange[] results = workbook.FindAll("Hello World", ExcelFindType.Text); + + + + + + Returns the cells of the specified string value with the specified . + + Value to search. + Type of value to search. + Way to search. + + Returns all found cells, or Null if value was not found. + + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IRange[] results = workbook.FindAll("Hello World", ExcelFindType.Text, ExcelFindOptions.MatchCase); + + + + + + Returns the cells of the specified double value with the specified . + + Value to search. + Type of value to search. + Returns all found cells, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IRange[] results = workbook.FindAll(100.32, ExcelFindType.Number); + + + + + + Returns the cells of the specified bool value. + + Value to search. + Returns all found cells, or Null if value was not found + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IRange[] range = workbook.FindAll(true); + + + + + + Returns the cells of the specified DateTime value. + + Value to search. + Returns all found cells, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IRange[] results = workbook.FindAll(DateTime.Now); + + + + + + Returns the cells of the specified TimeSpan value. + + Value to search. + Return all found cells, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + TimeSpan value = new TimeSpan(2, 30, 30); + IRange[] results = workbook.FindAll(value); + + + + + + Sets separators for formula parsing. + + Arguments separator to set. + Array rows separator to set. + + The following code illustrates how to set separators. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.SetSeparators(',', ';'); + + + + + + Sets protection for workbook. + + Indicates if protect workbook window. + Indicates if protect workbook content. + + The following code snippet illustrates how to protect the workbook. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.Protect(true, true); + + + + + + Sets protection for workbook with specified password. + + Indicates if protect workbook window. + Indicates if protect workbook content. + Password to protect with. + + The following code snippet illustrates how to protect the workbook using password. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.Protect(true, true, "Password"); + + + + + + Unprotects workbook. + + + The following code illustrates how to unprotect a workbook. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + //Unprotects the password. + workbook.Unprotect(); + + + + + + Unprotects workbook using password. + + + Throws ArgumentOutOfRangeException when password is wrong. + + Password to unprotect workbook. + + The following code illustrates how to unprotect a workbook using password. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + //Unprotects the password using password. + workbook.Unprotect("Password"); + + + + + + Creates copy of the current instance. + + Copy of the current instance. + + + + Sets write protection for workbook using password. + + Password to set. + + The following code snippet illustrates how to set write protection password. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.SetWriteProtectionPassword("Password"); + + + + + + Import XML document to the workbook. + + File name of XML document. + + + + Imports XML data into workbook from the specified XML data stream. + + Stream of XML document. + + + + Gets Vba Project in the workbook. + + + The following code snippet illustrates how to get Vba Project from the workbook. + + ExcelEngine engine = new ExcelEngine(); + IWorkbook workbook = engine.Excel.Workbooks.Create(); + IWorksheet sheet = workbook.Worksheets[0]; + + sheet["A1"].Value = "Test"; + + IShape shape = sheet.Shapes.AddAutoShapes(AutoShapeType.Rectangle, 2, 2, 40, 40); + + Syncfusion.Office.IVbaProject project = workbook.VbaProject; + + Syncfusion.Office.IVbaModule module = project.Modules.Add("Test", Syncfusion.Office.VbaModuleType.StdModule); + + module.Code = "Sub ShowMessage()" + "\r\n" + + " MsgBox \"Shape Clicked!\"" + "\r\n" + + "End Sub"; + + shape.OnAction = "Test.ShowMessage"; + + workbook.SaveAs("Output.xlsm"); + + workbook.Close(); + engine.Dispose(); + + + + + + Gets the table styles object. + + + + + Gets an object that represents the active sheet (the sheet on top) in the + active workbook or in the specified window or workbook. Returns Nothing if no sheet is active. Read-only. + + + + + Gets or sets index of the active sheet. + + + + + Gets collection of all workbook's add-in functions. Read-only. + + + + + Gets or sets the author of the comment. + + + + + Gets or sets a value indicating whether to display horizontal scroll bar. + + + This sample shows how to hide horizontal scroll bar. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.IsHScrollBarVisible = false; + + + + + + Gets or sets a value indicating whether to display vertical scroll bar. + + + This sample shows how to hide vertical scroll bar. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.IsVScrollBarVisible = false; + + + + + + Gets collection that represents all the built-in document properties + for the specified workbook. Read-only. + + + The following code snippet illustrates how to get the built in document properties. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + //Get the built in document properties. + IBuiltInDocumentProperties builtInDocumentProperties = workbook.BuiltInDocumentProperties; + + + + + + Name which is used by macros to access the workbook items. + + + + + Gets collection that represents all the custom document properties + for the specified workbook. Read-only. + + + The following code snippet illustrates how to get the custom document properties. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + //Get the document properties. + ICustomDocumentProperties documentProperties = workbook.CustomDocumentProperties; + + + + + + Gets a MetaProperties collection that describes the meta data stored in the workbook. Read-only. + + + + + Gets collection that represents all the Custom Xml parts + for the specified workbook. Read-only. + + + The following code snippet illustrates how to get the custom Xml parts. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + //Get the customXml parts. + ICustomXmlPartCollection CustomXmlparts = workbook.CustomXmlparts; + + + + + + Gets the name of the object, including its path on disk. + + + Returns the name of the object, including its path on disk, as a string. Read-only String.This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + property is used to get the full file name of the workbook. + + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = engine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + string workbookPath = workbook.FullFileName; + workbook.Close(); + } + + + + + + True if the workbook uses the 1904 date system. + + + + + True if the precision to be used as displayed. Read-only. + + + + + True if cell is protected. Read-only. + + + + + True if window is protected. Read-only. + + + + + Gets Names collection. + + + For an Application object, returns a Names collection that represents + all the names in the active workbook. For a Workbook object, returns + a Names collection that represents all the names in the specified + workbook (including all worksheet-specific names). + + + The following code snippet illustrates how to get names. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + INames names = workbook.Names; + + + + + + True if the workbook has been opened as Read-only. Read-only Boolean. + + + + + True if no changes have been made to the specified workbook since + it was last saved. If current value is false then setting it to true cause Save() method call. + + + + + Gets a Styles collection that represents all the styles + in the specified workbook. Read-only. + + + The following code snippet illustrates how to get the Styles. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["B2"].Text = "Text"; + + //Set styles + IStyles styles = workbook.Styles; + + //Set style + IStyle style = styles[0]; + + //Set color + style.ColorIndex = ExcelKnownColors.Red; + + //Apply style + worksheet["B2"].CellStyle = style; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets a Sheets collection that represents all the worksheets + in the specified workbook. Read-only Sheets object. + + + The following code snippet illustrates how to get the worksheets. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheets worksheets = workbook.Worksheets; + + + + + + True if workbook contains VBA macros. Read-only. + + + + + Gets the color from the Excel document color palette. + + + The following code snippet illustrates how to get palette color. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + System.Drawing.Color[] palette = workbook.Palette; + + + + + + Gets the color from the Excel document color palette. + + + The following code illustrates how to access the default colors of excel color palette. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Get colors + System.Drawing.Color[] colors = workbook.Palette; + + //Get color + System.Drawing.Color color = colors[2]; + + //Set color + worksheet["B2"].CellStyle.Color = color; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets index of tab which will be displayed on document open. + + + + + Gets the collection of the chart objects. + + + + + Indicates whether exception should be thrown when unknown + name was found in a formula. + + + The following code snippet illustrates how to gets or sets the ThrowOnUnknownNames. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.ThrowOnUnknownNames = true; + bool isThrowOnUnknownNames = workbook.ThrowOnUnknownNames; + + + + + + Disables loading of macros from document. + + + Excel on file open will simply skip macros and will + work as if document does not contain them. This options works + only when file contains macros (HasMacros property is True). + + + + + Gets or sets the standard font size, in points. + + + The following code illustrates how to set the standard font size for the workbook. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["B2"].Text = "Text"; + + //Set standard font + workbook.StandardFont = "Arial"; + + //Set standard font size + workbook.StandardFontSize = 18; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Gets or sets the name of the standard font. + + + The following code illustrates how to set the standard font for the workbook. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + + //Set text + worksheet["B2"].Text = "Text"; + + //Set standard font + workbook.StandardFont = "Arial"; + + //Set standard font size + workbook.StandardFontSize = 18; + + //Save and dispose + workbook.SaveAs("CellFormats.xlsx"); + workbook.Close(); + } + + + + + + Indicates whether to allow usage of 3D ranges in DataValidation + list property (MS Excel doesn't allow). + + + + + Gets calculation options. Read-only. + + + The following code snippet illustrates how to get the calculation options. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + //Get the calculation options. + ICalculationOptions calculationOptions = workbook.CalculationOptions; + + + + + + Gets or sets row separator for array parsing. + + + The following code snippet illustrates how to get row separator. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + string rowSeparator = workbook.RowSeparator; + + + + + + Gets the formula arguments separator. + + + The following code snippet illustrates how to get the argument separator. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + //Get the chart argumentSeparator. + string argumentSeparator = workbook.ArgumentsSeparator; + + + + + + Gets grouped worksheets. Read-only. + + + The following code snippet illustrates how to get the grouped sheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheetGroup worksheetGroup = workbook.WorksheetGroup; + + + + + + Indicates whether worksheet is displayed right to left. + + + + + True if the tabs are visible. otherwise False. + + + + + Gets collection of tab sheets. Read-only. + + + The following code snippet illustrates how to get the tabsheets. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + ITabSheets tabsheets = workbook.TabSheets; + + + + + + Indicates whether detect string value passed to Value (and Value2) + property as DateTime. Default value is true. + + + Setting this property to false can increase performance. + + + + + Toggles string searching algorithm.Default value is true. + + + If true then Dictionary will be used + to locate string inside strings dictionary. This mode is faster but uses + more memory. If false then each time string is added to strings dictionary + we will have to iterate through it and compare new strings with existing ones. + + + + + True to display a message when the file is opened, recommending that the file be opened as read-only. + + + + + Gets or sets password to encrypt or decrypt document. + + + + + Gets maximum row count for each worksheet in the workbook. Read-only. + + + + + Gets maximum column count for each worksheet in the workbook. Read-only. + + + + + Gets or sets excel version. + + + + + Gets pivot caches collection. Read-only. + + + The following code snippet illustrates how to get pivot caches. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IPivotCaches pivotCaches = workbook.PivotCaches; + + + + + + Gets the workbook connections. Read Only + + + The following code snippet illustrates how to get the connections from the workbook. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + //Gets the workbook connections. + IConnections connections = workbook.Connections; + + + + + + Returns the collection of XmlMap object. Read-Only. + + + + + This event is fired after workbook is successfully saved. + + + + + This event is fired when trying to save to a Read-only file. + + + + + Stream name that represent summary name. + + + + + Stream name that represent document summary name. + + + + + Stream name used by new versions of Excel. + + + + + Old styled name of stream in Excel binary file. + + + + + Name of sub-storage in input file which contains macros of opened file. + + + + + Sub-storage of Macros storage. Used for checks is file format correct + or not. + + + + + Self-referential external reference. + + + + + File name has been excoded. + + + + + Reference to an empty workbook name. + + + + + Represents an MS-DOS drive letter. It is followed by the drive letter. + For example, the formula ='D:\SALES.XLS'!A1 generates this character key + when the dependent workbook is not on the D drive. UNC file names, such as + \\server\share\myfile.xls, generate an @ character after this character key; + this replaces the initial double backslash (\\). + + + + + Indicates that the source workbook is on the same drive as the + dependent workbook (the drive letter is omitted). For example + the formula ='\SALES.XLS'!A1 generates this key when + the dependent workbook is not in the root directory. + + + + + Indicates that the source workbook is in a subdirectory of the current directory. + For example, the formula ='XL\SALES.XLS'!A1 generates the DEF_CHAR_DOWNDIR key. + The subdirectory name precedes the DEF_CHAR_DOWNDIR key, and the file + name follows it. + + + + + Indicates that the source workbook is in the parent directory of the current directory. + For example, the formula ='..\SALES.XLS'!A1 generates the DEF_CHAR_UPDIR key. + + + + + Not used. + + + + + Indicates that the source workbook is in the startup directory + (the Xlstart subdirectory of the directory that contains Excel.exe). + + + + + Indicates that the source workbook is in the alternate startup directory. + + + + + Indicates that the source workbook is in the Library directory. + + + + + Indicates that path is UNC file name (is replaced by \\). + + + + + Start of the UNC network path. + + + + + Indicates that current workbook is not protected. + + + + + Index of the removed sheet. + + + + + Start of the http url string. + + + + + Defines a new line character + + + + + First user-defined color. + + + + + + + + + + + + + + + + + + + + + + + + + Index of the removed sheet. + + + + + Content type for Excel 97. + + + + + Content type for Excel 2000. + + + + + Content type for Excel 2007. + + + + + Content type for CSV. + + + + + Content type for ODS. + + + + + Standard password. + + + + + TextQualifier. + + + + + Default regular expression options. + + + + + Name of the directory's group in regular expressions. + + + + + Name of the book's group in regular expressions. + + + + + Name of the sheet's group in regular expressions. + + + + + Index of worksheet used for workbook references. + + + + + Name prefix for styles in ignore style mode. + + + + + Default theme version on excel workbook 2016 + + + + + Default theme version on excel workbook 2013 + + + + + Default theme version on excel workbook 2007 and 2010 + + + + + + Text for evaluation warning. + + + + + Text for evaluation warning. + + + + + Name of the expired evaluation sheet. + + + + + First chart color index. + + + + + Last chart color index. + + + + + Excel97to2003 entension. + + + + + Excel2007 extension. + + + + + Excel97to2003 template file extension. + + + + + Excel2007 template file extension. + + + + + Excel2007 template file with macro extension. + + + + + Excel2007 Macro file extension. + + + + + ODS entension. + + + + + Excel2007 Xlsb extension. + + + + + Separator between worksheets in the cross-worksheet formula (Sheet1:Sheet3!A1). + + + + + Represents the Difference value of 1904 and 1899 date system format. + + + + + Defines a default script factor. + + + + + Default Palette colors. + + + + + Records that should be stored in m_arrPivotRecords. + + + + + Regular expression for workbook-worksheet pair. + + + + + Regular expression for workbook-worksheet pair with directory name + + + + + + Array with characters that are reserved. + + + + + + + + + + + + + + + Default theme colors. + + + + + Default theme colors on Excel version 2013. + + + + + Collects the workbook's name ranges in a dictionary + + + + + Represent to indicate whether pivot table count in workbook. + + + + + Xlsb Data holder + + + + + Indicates whether it is XLSB. + + + + + Create and store the table styles object. + + + + + Indicates the slicer cache + + + + + Indicates the slicer cache collection + + + + + Formula existing row indexes with sheet. + + + + + Represents the person dictionary that contains all the created person object + + + + + Indicates whether all the formula in the workbook is evaluated. + + + + + Used to store records which belong to the Workbook part. + Temporary array which must be cleaned after read/parse operations. + + + + + Active sheet in the current workbook. + + + + + Denotes whether to display sheet tabs or not. + + + + + Active tab sheet in the current workbook. + + + + + Returns a Sheets collection that represents all the worksheets + in the specified workbook. Read-only Sheets object. + + + + + Styles collection that represents all the styles + in the specified workbook. + + + + + Storage of all Fonts created in a workbook. + + + + + Storage of all ExtendedFormats created in a workbook. + + + + + Storage of NameRecords. + + + + + New value changes for the format Record + + + + + Collection of workbook's formats. + + + + + Storage of BoundSheet records. Is a temporary storage which + after read / parse operations must be cleaned. + + + + + Dictionary which is used for storage of SST strings. + + + + + Collection contains all SupBookRecords. + + + + + Represents the continuity of ExternSheet record + + + + + List of the ranges that should be reparsed. + + + + + Full name of the file where workbook was saved or loaded. + + + + + True if the workbook uses the 1904 date system. + + + + + True if workbook uses Precision + + + + + True if the workbook has been opened as Read-only. + + + + + True if no changes have been made to the specified workbook since + it was last saved. Read / write Boolean. + + + + + + + + + + Indicates whether workbook is in loading state. + + + + + Indicates whether workbook is in saving state. + + + + + True if cells are protected. + + + + + True if window is protected. + + + + + Default name of workbook used by macros. + + + + + True if pivot table Fields lists are hidden + + + + + Indicates default theme version for wokbook. + + + + + True - indicates that current workbook contains macros sub-storage. + + + + + True - indicates that current workbook contains summary information. + + + + + True - indicates that current workbook contains document summary information. + + + + + True - indicate that macros exists in document and they + are disabled, otherwise False. + + + + + Stores current workbook's palette. + + + + + True- indicates that user used custom palette instead of the default. + + + + + Window one record for the workbook. + + + + + Collection of all Name objects defined in the workbook + + + + + Collection of all Chart objects of the workbook. + + + + + Collection of all Dialog sheets of the workbook. + + + + + Collection of all Macrosheets and IntlMacrosheets of the workbook + + + + + Collection of Charts and Worksheets objects. + + + + + One of protection records. + + + + + One of protection records. + + + + + One of protection records. + + + + + + + + + + Data needed by workbook shapes (unique images and other things). + + + + + First unused color (color that wasn't redefined yet). + + + + + Current object id. + + + + + First free shape id. + + + + + + + + + + List of ExtendedXF Format record + + + + + + Stream from which workbook was read. + + + + + + + + + + Indicates whether to allow usage of 3D ranges in DataValidation + list property (MS Excel doesn't allow). + + + + + Collection of extern workbooks. + + + + + Collection of all add-in functions used in this workbook. + + + + + Collection of header / footer pictures. + + + + + Calculation options. + + + + + Collection of pivot caches. + + + + + Workbook level Conditional Priority count. + + + + + Graphics used for string measurement. + + + + + Graphics used for string measurement. + + + + + Represents the destination file path. + + + + + Formula parser. + + + + + Represents group of selected worksheets. + + + + + Indicates whether original worksheet contains duplicated names. + + + + + Collection of built-in document properties. + + + + + Collection of custom document properties. + + + + + Collection of Content Type properties. + + + + + Collection of CustomXmlParts. + + + + + Indicates whether workbook is write protected. + + + + + File sharing record. + + + + + Indicates whether library should try to detect string value passed to Value (and Value2) + property as DateTime. Setting this property to false can increase performance greatly for + such operations especially on .Net Framework 1.0 and 1.1. Default value is true. + + + + + Size of the default character measured using first function. + + + + + Size of the default character measured using second function. + + + + + Password used to encrypt document. + + + + + Encryption type. + + + + + Document id. + + + + + Maximum row count for each worksheet in this workbook. + + + + + Maximum column count for each worksheet in this workbook. + + + + + Maximum possible number of extended formats. + + + + + Maximum possible indent value. + + + + + Current excel version. + + + + + Default XF index. + + + + + File data holder, used to store data for Excel 2007 format. + + + + + Maximum digit width (used to evaluate different column width) + + + + + Workbook's heap handle. + + + + + This field is used to preserve BookExt record. + + + + + This field is used to preserve Theme record. + + + + + Contains list of theme colors. + + + + + Unparsed controls stream. + + + + + Maximum used table index. + + + + + Country code. + + + + + Stream contains custom table styles + + + + + Indicates whether workbook was loaded or it is created. + + + + + Indicates whether the theme colors of the workbook is parsed or not + + + + + Represents the Compatibility record + + + + + Represents the Shared string stream + + + + + Represents whether workbook has Inlinestring. + + + + + Represents the Data sorter. + + + + + Denotes whether is workbook is 'Strick Open Xml spreadsheet'. + + + + + Preserves the pivot cache. + + + + + Store the font indexes. + + + + + Represents the Excel Parse Options. + + + + + Preserves the unique styles cells count. + + + + + Represents the unique styles count. + + + + + Boolean that represent the extended format CRC value status. + + + + + Extended format CRC value. + + + + + Find the beginning version of excel + + + + + + + + + + Preserves the child element in the document management properties. + + + + + Preserves the child element in the document management properties. + + + + + Illegal xml character defined names count. + + + + + Connections collections + + + + + Connection Support for Excel2003 + + + + + Represents to parse sheet on demand + + + + + ReCalculation Identifier. + + + + + Calc Identifier. + + + + + Preserves the DDE type link in workbook + + + + + Alogrithm name to protect/unprotect Workbook. + + + + + Hash value to ensure the workbook protected password. + + + + + Random generated Salt for the workbook password. + + + + + Spin count to loop the hash algorithm. + + + + + Custom date patterns in excel + + + + + Date time pattern for the current culture with custom date pattern + + + + + Indicates whether workbook is converting to Pdf or Image or HTML. + + + + + Contains list of used cell StyleIndex. + + + + + Number of XF records removed. + + + + + Start index of XF record in InnerExtFormats collection. + + + + + Indicates whether Start index of XF record in InnerExtFormats collection is found. + + + + + Indicates whether the unused XF record removed or not. + + + + + Indicates whether the workbook is xml. + + + + + Indicates whether the workbook styles are copied during addCopy. + + + + + Indicates whether the styles are created during copy. + + + + + Indicates whether the version is set. + + + + + Collection of XmlMap object. + + + + + Maintains the precedents cell collection for all cells + + + + + Dictionary to hold processed number format indexes + + + + + Indicates whether the calc engine enabled and disabled on parsing and serializing + + + + + Vba project + + + + + Vba project macro storage. + + + + + Theme line styles + + + + + Represents the name of substitute font used. + + + + + Indicates whether the styles has color palette or not. + + + + + Indicates slicer cache id + + + + + Represents the pivot slicer caches + + + + + Represents the pivot slicer cache id + + + + + Indicates whether slicer properties parsed in the workbook. + + + + + Extension list stream + + + + + Represents the slicer names in the worksheet. + + + + + Represents the lambdaFormulaArgument dictionary that contains all the created lambdaFormulaArgument object + + + + + ExcelSheetType-to-Name. + + + + + Parse the string and tries to retrive the required table + + input name range value + the required table range + + + + returns the required range from given table details + + input table name + boolean value indicates whether the table all values to be returned + boolean value indicates whether the table header values only to be returned + boolean value indicates whether the table first row values to be returned + array having the columns to defind the region + the required range + + + + Gets the table with the given name + + Worksheet + Name of the table + + + + + Clears all pivot caches. + + + + + generates Global Unique Identifier (GUID) + + GUID in string representation + + + + Returns theme color by its index. + + + + + + + Returns theme color by its index on ExcelVersion 2013. + + index value on list of colors + the Color value + + + + Creates extended format record and registers it in workbook. + + Indicates whether to force add to collection. + Newly created extended format. + + + + Creates extended format based on baseFormat and registers it in workbook. + + Base format for the new format. + Indicates whether to force add. + Newly created format. + + + + Creates extended format based on baseFormat without registering it in the workbook. + + Base format for the new format. + Newly created format. + + + + Registers extended format. + + Format to register. + + Format from the collection if there were such format; + otherwise returns format that was added. + + + + + Registers extended format. + + Format to register. + Indicates whether to force format object registration in the collection. + + Format from the collection if there were such format; + otherwise returns format that was added. + + + + + Copies to clipboard the selected worksheet or all worksheets if sheet is NULL. + + Worksheet that would be copied into the clipboard. + + + + Copies workbook and all its worksheets to the clipboard. + + + + + Inserts SupbookRecord describing this workbook. + + + Index to the SupBookRecord that describes current workbook. + + + + + Adds internal sheet reference. + + Name of the sheet that should be referenced. + Index to the sheet in ExternSheetRecord. + + When can't find specified worksheet in this workbook. + + + + + Gets file name with extension from the path. + + Url to get name from. + File name without extension from the path. + + + + Gets create workbook name. + + Workbook to get name from. + Workbook name. + + + + Returns the file name from the full path. + + URL to get file name. + Workbook name. + + + + Adds reference to the extern worksheet. + + + Workbook name (can be null or empty than sheet name is treated as book name. + + Worksheet name. + Index in the ExternSheet record. + + + + Adds internal sheet reference. + + Name of the sheet that should be referenced. + Worksheet to be referenced. + + When can't find specified worksheet in this workbook. + + + + + Adds internal sheet reference. + + Name of the sheet that should be referenced. + Worksheet to be referenced. + + When can't find specified worksheet in this workbook. + + + + + Adds internal sheet reference. + + Name of the sheet that should be referenced. + Worksheet to be referenced. + + When can't find specified worksheet in this workbook. + + + + + This method adds one TREF structure to the list. + + SUPBOOK index. + Index to first SUPBOOK sheet. + Index to last SUPBOOK sheet. + + Index of the old REF structure (if there was one) + or new REF structure. + + + + + Adds incorrect sheet reference. + + Worksheet to be referenced. + + When can't find specified worksheet in this workbook. + + + + + Adds incorrect book reference. + + Worksheet to be referenced. + + When can't find specified worksheet in this workbook. + + + + + Decreases index (in ExternSheet record) of all worksheets with index + that is smaller than specified index. + + + + + + Increases index (in ExternSheet record) of all worksheets with index + that is larger or equal than specified index. + + + + + + This method updates external sheet table when a worksheet was moved. + + Old index of the worksheet. + New index of the worksheet. + + + + Updates active sheet index after move operation. + + Old sheet index. + New sheet index. + + + + Gets sheet index after move operation. + + Current sheet index. + Old index of the sheet that was moved. + New index of the sheet that was moved. + New index for current sheet index. + + + + Returns worksheet name. + + Reference to worksheet. + Returns sheet name. + + + + Returns worksheet name. + + Reference to worksheet. + Returns sheet name. + + + + Returns worksheet name. + + Reference to worksheet. + Returns sheet name. + Indicates whether to throw exception if reference index is out of range. + + + + Get name of the external worksheet by reference. + + + + + Get name of the internal worksheet by reference. + + + + + Returns worksheet by its reference index. + + Reference index of the sheet. + Found worksheet. + + When can't find referenced worksheet. + + + + + Returns worksheet by its reference index. + + Reference index of the sheet. + + Indicates whether to throw exception when can't + find worksheet with specified index. + + Found worksheet. + + When can't find referenced worksheet. + + + + + Check for internal Reference; If external - rise NotSupported exception. + + Ref index. + + + + Indicates whether reference is reference to local worksheet. + + Reference index. + Value that indicates whether reference is reference to local worksheet. + + + + + + + + + + + Inserts reparse into array of object that should be reparsed + when loading will be complete. + + Object that will be reparsed later. + + + + Returns number from the style name, i.e. Normal_1 result is 1. + + Style name. + Parsed number. + + + + Raises argument to the second power. + + Value to be squared. + Squared value. + + + + Calculates distance between two colors. + + First color. + Second color. + Distance between two colors. + + + + Clears collection of references. + + + + + Raises FileSaved event. + + + + + Raises OnReadOnlyFile event. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns reference index by extern workbook index. + + Index of the extern workbook. + Reference index if extern workbook was found; otherwise returns -1. + + + + Returns extern workbook index by reference index. + + Reference index. + Extern workbook index. + + + + Returns external sheet object by reference index. + + Reference index. + External worksheet that corresponds to the specified reference index. + + + + Decodes name encoded in supbook. + + Name to decode. + Decoded name. + + + + + + + + + + Decodes name encoded in supbook. + + Name to decode. + Decoded name. + + + + Modifies record in skip styles mode. + + Record to modify. + Boolean value indicating that record should be added to the array. + + + + Modifies record in skip styles mode. + + Records to modify. + + + + Compares two colors. + + First color to compare. + Second color to compare. + True if colors are equal. + + + + Removes extended format by its index. + + Index to the extended format to remove. + + + + Removes extended format by its index. + + Index to the extended format to remove. + + + + Checks whether protected content is correct. + + Worksheet to check. + True if content is correct. + + + + Optimizes internal references by removing unused ones. + + + + + Updates reference indexes. + + Array with updated indexes. + + + + Updates pivot caches after insert. + + Worksheet where insert operation took place. + + + + Indicates whether this is remove operation. + + + + Get the stack collection of range from ptg array. + + input array of Ptgs + the stack of range + + + + Initialize the PrecedentsCache member. + + + + + Determines whether the start of the main string matches the specified substring. + + The string to check. + The substring to compare to the start of the main string. + + true if the main string starts with the specified substring; otherwise, false. + + + + + Determines whether the end of the main string matches the specified substring. + + The string to check. + The substring to compare to the end of the main string. + + true if the main string ends with the specified substring; otherwise, false. + + + + + Returns true if the last character matches the given character. + + + + + Static constructor. + + + + + Base constructor which must be used when workbook is created + from scratch (maybe clipboard data)and not from file. + + Application object for the workbook. + Parent object for the workbook. + Excel version. + + + + Creates workbook with specific number of worksheets. + + Application object for the workbook. + Parent object for the workbook. + Quantity of empty worksheets to create. + Excel version. + + + + Create Workbook from file. + + Application object for the workbook. + Parent object for the workbook. + Name of the file with workbook. + Excel version. + + When can't find workbook stream in the file. + + + + + Create Workbook from file. + + Application object for the workbook. + Parent object for the workbook. + Name of the file with workbook. + Parse options. + Excel version. + + When can't find workbook stream in the file. + + + + + Create Workbook from file. + + Application object for the workbook. + Parent object for the workbook. + Name of the file with workbook. + Parse options. + Indicates whether to open workbook in read-only mode. + Password to decrypt workbook stream. + Excel version. + + When can't find workbook stream in the file. + + + + + Initializes a new instance of the class. + + Application object for the workbook. + Parent object for the workbook. + Name of the file with workbook. + Parse options. + Indicates whether to open workbook in read-only mode. + Password to decrypt workbook stream. + Excel version. + + When can't find workbook stream in the file. + + + + + Create WorkBook from file. + + Application object for the workbook. + Parent object for the workbook. + Stream to open. + Denotes separator for the CSV file types. + Number of first row to write. + Number of first column to write. + Excel version. + Filename is used to generate worksheet name + + + + Create Workbook from stream. + + Application object for the workbook. + Parent object for the workbook. + Stream that contains workbook's data. + Excel version. + + When specified stream is NULL. + + + + + Create Workbook from stream. + + Application object for the workbook. + Parent object for the workbook. + Stream that contains workbook's data. + Parse options. + Excel version. + + When specified stream is NULL. + + + + + Parses new workbook from xml stream. + + Current application + Parent object. + Xml reader. + Xml open type. + + + + Initializes all internal collections. + + + + + Creates graphics object. + + + + + Fills collection with default formats, extended format, and styles. + + + + + Inserts all default extended formats into special list. Excel has 21 + default formats for each workbook. + + + + + Inserts all default styles into special list. + + + + + Inserts all default styles into special list. + + Styles that were read from file. + + + + Registers default style inside styles collection. + + Style to register. + + + + + + + + + + + + + + + + + + + + + + + Compares two style records. + + First style record to compare. + Second style record to compare. + True if records describe same default style. + + + + Inserts default fonts into special list. + + + + + Disposes internal collections. + + + + + Clears all internal collections. + + + + + Clears the extended formats. + + + + + + + Storage object to extract pivot cache from. + Object used to decrypt encrypted records. + + + + Parse StgStream. + + Storage object to extract data from. + Parse options. + Password to decrypt if necessary. + + + + + + + + + + Searches for the stream name, case-insensitive. + + Storage object to search inside of. + Name of the stream to locate. + Case-sensitive stream name if stream was found; null otherwise. + + + + This method parses stream that holds data in Excel 2007 format (Open XML). + + Stream to parse. + Password to use during for decryption. + + + + Parses specified file. + + File to parse. + Password to use for decryption (null if file is not encrypted). + Excel version. + Parsing options. + + + + Parses specified stream. + + Stream to parse. + Password to use for decryption (null if file is not encrypted). + Excel version. + Parsing options. + + + + Class finalizer. + + + + + Reads workbook from the specified reader. + + BiffReader that contains workbook. + + + + Reads workbook from the specified reader. + + BiffReader that contains workbook. + Parsing options. + + Password - used for decryption.Otherwise this argument is ignored. + + Decryptor used for parsing, if it was created; null otherwise. + + + + Extracts pivot caches information from the workbook pivot records. + + + + + + Recheck the Format Record + + + + + + Normalizes border settings for specified extended format record in some incorrect files. + + ExtendedFormatRecord to process. + + + + Creates decryptor. + + Password that should be used for decryption. + Contains encryption information. + + + + Checks password provided password or asks to provide a password for the first time. + + Provided password; null if there was no password provided. + Resulting decryptor object. + Part of the decryption structure used to check password. + + + + Checks whether document was encrypted with standard password and creates decryptor object if necessary. + + Decryptor to create. + Part of the decryption structure used to check password. + True if file was encrypted with standard password. + + + + check whether apssword is correct or not + + + + + + + + + + + + + + Parses internal sst record. + + SSTRecord to parse. + Parse options. + + + + Prepares fonts, formats and styles collections. + + Indicates whether parsing is made in ignore styles mode. + List with all styles. + Dictionary with new extended format indexes for ignore styles mode. + + + + Prepares extended format records. + + + + + Parses autofilters. + + + + + Method to extract all worksheets from stream. + + BiffReader that contains worksheets. + Parse options. + First worksheet to parse. + Last worksheet to parse. + + Dictionary with new extended format indexes for ignore styles mode. + + Object used to decrypt encrypted records. + + + + Reads worksheet data from the reader without parsing worksheets. + + Reader to read data from. + Parse options. + The first worksheet to parse. + The last worksheet to parse. + Dictionary with new extended format indexes for ignore styles mode. + Object used to decrypt encrypted records. + + + + Prepares named ranges (just create them without parsing). + + + + + Parses set of Name records. + + + + + Parses all worksheets, charts, etc. + + + + + Parses all worksheets, charts, etc. on demand + + + + + Reparses all ranges that were not parsed because of + insufficient data (that weren't loaded when parsing). + + + + + Creates all necessary styles for the workbook. + + Array of all read StyleRecords. + + + + Searches StyleRecord for the specified index of the Extended + Format record in the list. + + List that contains StyleRecord. + Index of the Extended Format. + + Found style index (if it is greater or equal to zero than it is index + from arrStyles array; otherwise it is evaluated as index in arrDefaultStyles + increased by 1 and multiplied by -1. + . + + + + Returns array of default styles. + + Array of StyleRecords with default styles. + + + + Creates style each number format. + + + Dictionary with new extended format indexes. + + + + + Read document properties from StgStream. + + Storage to read properties from. + + + + Reads document properties using native objects. + + Storage to get document properties from. + + + + Read document properties using managed classes. + + Storage to get document properites from. + + + + Parse the slicers in the workbook + + + + + Creates the Data sorter to sort the data.. + + Data Sorter. + + + + Copies to the clipboard whole workbook. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Activates the first window associated with the workbook. + + + + + Closes the object and saves workbook to the specified file name. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + File name in which workbook will be saved if SaveChanges is true. + + The following code illustrates how to closes the object and saves workbook with specified name. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + workbook.Close("Output.xlsx"); + + + + + + Closes the object and saves workbook to the specified file name.If True, all changes will be saved. + + If True, all changes will be saved. + Name of the file. + The following code illustrates how to Closes the object and saves workbook to the specified file name. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + workbook.Close(true,"Output.xlsx"); + + + + + + Closes the object. If True, all changes will be saved. + + If True, all changes will be saved. + The following code illustrate how to closes the object with specified bool value. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + workbook.Close(true); + + + + + + Closes the object without saving. + + The following code illustrate how to closes the object without saving. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + workbook.Close(); + + + + + + Create an instance that can be used for template markers processing. + + Returns the Object that can be used for template markers processing. + + + + Marks workbook as final. Read-Only. + + + + + Saves changes to the specified workbook. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + If file name was not specified before. + + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + workbook.Save(); + + + + + + Saves workbook with the specified file name. + + + Name of the file into which workbook will be saved. + + + When FileName is NULL. + + + When FileName is empty. + + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + workbook.SaveAs("Output.xls"); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Saves workbook with the specified file name and . + + + Name of the file into which workbook will be saved. + + Options for save. + + When FileName is NULL. + + + When FileName is empty. + + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + workbook.SaveAs("Output.xls", ExcelSaveType.SaveAsXLS); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Converts XLS/XLSX file to ODS + + + + + + Short variant of SaveAs method. + + + Name of the file into which workbook will be saved. + + Options for save. + Excel version that should be used. + + When FileName is NULL. + + + When FileName is empty. + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Saves as Html to specified file name based on . + + Name of the file. + Save options in html + + The following code snippets illustrates how to save as html to the specified file name. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + workbook.SaveAsHtml("Output.html",HtmlSaveOptions.Default); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Saves as Html to the specified stream based on . + + stream that will receive html data. + Save options in html + + The following code snippets illustrates how to save as html to the specified stream. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + Stream stream = new MemoryStream(); + workbook.SaveAsHtml(stream,HtmlSaveOptions.Default); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Saves as Html to the specified stream. + + stream that will receive html data. + + The following code snippets illustrates how to save as html to the specified stream. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + Stream stream = new MemoryStream(); + workbook.SaveAsHtml(stream); + + + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Prepares shapes for serialization. + + + + + Registers new shapes (that have no shapeId yet) inside shapeIdReserver. + + IdReserver that helps in the id generation process. + Delegate used to get necessary shapes collection from a TabSheet. + + + + Updates shapes that were added after last save operation. + + IdReserver that helps in the id generation process. + Delegate used to get necessary shapes collection from a TabSheet. + + + + Assigns indexes to the new shapes. + + IdReserver that helps in the id generation process. + Shape collection to process. + + + + Gets number of free indexes inside currently allocated/reserved ids. + + IdReserver that helps in the id generation process. + Shape collection to process. + Number of free indexes inside currently allocated/reserved ids. + + + + Evaluates number of shapes without assigned id. + + Shape collection to check. + Number of shapes without assigned id. + + + + Registers absolutely new shape collections using IdReserver. + + IdReserver that helps in the id generation process. + Delegate used to get necessary shapes collection from a TabSheet. + + + + Allocates and assigns indexes for all shapes inside shape collection. + + IdReserver that helps in the id generation process. + Shape collection to process. + + + + Creates IdReserver based on the current shapes. + + Delegate used to get necessary shapes collection from a TabSheet. + IdReserver filled with current shape id's data. + + + + Re-indexes shape collections if necessary. + + Delegate used to get necessary shapes collection from a TabSheet. + True if there are shapes inside the workbook. + + + + Returns sheet's shapes collection. + + TabSheet to get collection from. + Extracted collection. + + + + Returns header/footer shapes collection. + + TabSheet to get collection from. + Extracted collection. + + + + Saves changes to the specified HttpResponse. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Name of the file in HttpResponse. + HttpResponse to save in. + + + + Saves workbook with specified file name using separator. Used only for CSV files. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Path to save. + Denotes separator for the CSV file types. + + The following code snippet illustrates how to save as CSV. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.SaveAs("Output.csv", ","); + + + + + + Saves workbook with specified file name with given separator and encoding. Used only for CSV files. + + + This overloaded method can be used to apply encoding to the CSV file in particular. The default encoding type is UTF-8. Other encoding types include ASCII, UTF-7, and UTF-32. + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + Path to save the CSV file. + Denotes separator for the CSV file types. + The name of a character encoding that is supported by the .NET Framework. + + + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = engine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet["A1"].Text = "This"; + worksheet["B1"].Text = "is"; + worksheet["C1"].Text = "a"; + worksheet["D1"].Text = "sample"; + worksheet["E1"].Text = "to"; + worksheet["F1"].Text = "set"; + worksheet["G1"].Text = "encoding"; + workbook.SaveAs("Output.csv", ",",Encoding.Unicode); + } + + + + + + Saves workbook as stream using separator. Used only for CSV files. + + Stream to save. + Denotes separator for the CSV file types. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + Stream stream = new MemoryStream(); + workbook.SaveAs(stream, ","); + + + + + + Saves workbook as stream with given separator and encoding. Used only for CSV files. + + + This overloaded method can be used to apply encoding to the CSV file in particular. The default encoding type is UTF-8. Other encoding types include ASCII, UTF-7, and UTF-32. + + Stream to save the CSV file. + Denotes separator for the CSV file types. + The name of a character encoding that is supported by the .NET Framework. + + + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = engine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet["A1"].Text = "This"; + worksheet["B1"].Text = "is"; + worksheet["C1"].Text = "a"; + worksheet["D1"].Text = "sample"; + worksheet["E1"].Text = "to"; + worksheet["F1"].Text = "set"; + worksheet["G1"].Text = "encoding"; + Stream stream = new MemoryStream(); + workbook.SaveAs("Output.csv", ",",Encoding.Unicode); + } + + + + + + Saves active Worksheet using separator. + + Stream to save int. + Denotes separator for the CSV file types. + The name of a character encoding that is supported by the .NET Framework. + + + + Save changes to the specified HttpResponse based on and . + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Name of the file in HttpResponse. + HttpResponse that will receive workbook's data. + Download type. + Content type to use. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xls"); + + workbook.SaveAs("Output.xls", Response, ExcelHttpContentType.Excel97); + + + + + + Save changes to the specified HttpResponse based on . + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Name of the file in HttpResponse. + Type of the Excel file. + HttpResponse that will receive workbook's data. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xls"); + + workbook.SaveAs("Output.xls", ExcelSaveType.SaveAsXLS, Response); + + + + + + Save changes to the specified HttpResponse based on and . + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Name of the file in HttpResponse. + Type of the Excel file. + HttpResponse that will receive workbook's data. + Content type to use. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xls"); + + workbook.SaveAs("Output.xls", ExcelSaveType.SaveAsXLS, Response, ExcelHttpContentType.Excel97); + + + + + + Save changes to the specified HttpResponse based on . + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Name of the file in HttpResponse. + HttpResponse that will receive workbook's data. + Download type. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xls"); + + workbook.SaveAs("Output.xls", Response, ExcelDownloadType.PromptDialog); + + + + + + Saves changes to the specified HttpResponse based on download type and content type. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Name of the file in HttpResponse. + HttpResponse that will receive workbook's data. + Download type. + Content type to use. + + + + Save changes to the specified HttpResponse based on and . + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Name of the file in HttpResponse. + Type of the Excel file. + HttpResponse that will receive workbook's data. + Download type. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xls"); + + workbook.SaveAs("Output.xls", ExcelSaveType.SaveAsXLS, Response, ExcelDownloadType.PromptDialog); + + + + + + Save changes to the specified HttpResponse,using separator with the specified and . + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Name of the file in HttpResponse. + Denotes separator for the CSV file types. + HttpResponse that will receive workbook's data. + Download type. + Http content type. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + workbook.SaveAs("Output.csv", ",", Response, ExcelDownloadType.PromptDialog, ExcelHttpContentType.CSV); + + + + + + Save changes to the specified HttpResponse,using separator and encoding with the specified and . + + + This overloaded method can be used to apply encoding to the CSV file in particular. The default encoding type is UTF-8. Other encoding types include ASCII, UTF-7, and UTF-32. + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + Name of the file in HttpResponse. + Denotes separator for the CSV file types. + HttpResponse that will receive workbook's data. + Enumeration to specify the download type. + Enumeration to specify the Http content type. + The name of a character encoding that is supported by the .NET Framework. + + + using(ExcelEngine engine = new ExcelEngine()) + { + IApplication application = engine.Excel; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet worksheet = workbook.Worksheets[0]; + worksheet["A1"].Text = "This"; + worksheet["B1"].Text = "is"; + worksheet["C1"].Text = "a"; + worksheet["D1"].Text = "sample"; + worksheet["E1"].Text = "to"; + worksheet["F1"].Text = "set"; + worksheet["G1"].Text = "encoding"; + workbook.SaveAs("Output.csv", ",", Response, ExcelDownloadType.PromptDialog, ExcelHttpContentType.CSV, Encoding.UTF7); + } + + + + + + Save changes to the specified HttpResponse based on , and . + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Name of the file in HttpResponse. + Type of the Excel file. + HttpResponse that will receive workbook's data. + Download type. + Content type to use. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xls"); + + workbook.SaveAs("Output.xls", ExcelSaveType.SaveAsXLS, Response, ExcelDownloadType.PromptDialog, ExcelHttpContentType.Excel97); + + + + + + Prepares response before saving. + + + + + + + + + Saves workbook in xml format. + + XmlWriter to save into. + Xml save type. + + + + Saves workbook in xml format with the specified. + + XmlWriter to save into. + Xml save type. + + The following code snippet illustrates how to save as Xml using Xml writer. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + System.Xml.XmlWriter writer = System.Xml.XmlWriter.Create("Output.xml"); + workbook.SaveAsXml(writer, ExcelXmlSaveType.MSExcel); + + + + + + Saves workbook with the specified file name and . + + File name to save into. + Xml save type. + + The following code snippet illustrates how to save as Xml. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + workbook.SaveAsXml("Output.xml", ExcelXmlSaveType.MSExcel); + + + + This method is not supported in WinRT, Windows Phone, Universal and Portable platforms. + + + + + Saves workbook as stream with specified . + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Stream to save into. + Xml save type. + + The following code snippet illustrates how to save the stream as Xml. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + Stream stream = new MemoryStream(); + workbook.SaveAsXml(stream, ExcelXmlSaveType.MSExcel); + + + + + + Returns string that corresponds to contentType. + + Content type for browser. + String that corresponds to contentType. + + + + Saves workbook as stream. + + Stream that will receive workbook data. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + Stream stream = new MemoryStream(); + workbook.SaveAs(stream); + + + + + + Saves workbook as stream with specified . + + Stream that will receive workbook data. + Type of the Excel file. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + Stream stream = new MemoryStream(); + workbook.SaveAs(stream, ExcelSaveType.SaveAsXLS); + + + + + + Converts XLS/XLSX file to ODS stream + + + + + + Saves the workbook to a JSON file. + + File name to save into. + + + + Saves the workbook to a JSON file as schema. + + File name to save into. + Indicates whether to save the workbook as JSON in schema type html + + + + Saves the worksheet to a JSON file. + + File name to save into. + Worksheet to save as JSON. + + + + Saves the worksheet to a JSON file as schema. + + File name to save into. + Worksheet to save as JSON. + Indicates whether to save the worksheet as JSON in schema type html + + + + Saves the range to a JSON file. + + File name to save into. + Range to save as JSON. + + + + Saves the range to a JSON file as schema. + + File name to save into. + Range to save as JSON. + Indicates whether to save the range as JSON in schema type html + + + + Saves the workbook to a JSON file stream. + + Stream to save into. + + + + Saves the workbook to a JSON file stream as schema. + + Stream to save into. + Indicates whether to save the workbook as JSON in schema type html + + + + Saves the worksheet to a JSON file stream. + + Stream to save into. + Worksheet to save as JSON. + + + + Saves the worksheet to a JSON file stream as schema. + + Stream to save into. + Worksheet to save as JSON. + Indicates whether to save the worksheet as JSON in schema type html + + + + Saves the range to a JSON file stream. + + Stream to save into. + Range to save as JSON. + + + + Saves the range to a JSON file stream as schema. + + Stream to save into. + Range to save as JSON. + Indicates whether to save the range as JSON in schema type html + + + + Serialize the JSON using JsonWriter in schema format. + + JSON writer + Worksheet to convert. + + + + Serialize the JSON using JsonWriter in schema format. + + JSON writer + Range to convert. + + + + Serialize the JSON using JsonWriter in non-schema format. + + JSON writer + Range to convert. + + + + Gets names of all worksheets. + + Names of all worksheets. + + + + Returns array odd elements (sheets, charts, etc. ) of which + are workbook's part name and even number of such elements + in the workbook. + + + Array odd elements (sheets, charts, etc. ) of which + are workbook's part name and even number of such elements + in the workbook. + + + + + Returns Dictionary ExcelSheetType - to - number of such + elements in the workbook. + + + Dictionary ExcelSheetType - to - number of such + elements in the workbook. + + + + + Sets the palette color for the given index. + + Index of Color in array. + New color which must be set. + + The following code snippet illustrates how to set palette color. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.SetPaletteColor(0, System.Drawing.Color.Aqua); + + + + + + Copies palette colors to workbook/ + + Workbook to copy palette into. + + + + Recover palette to default values. + + + The following code snippets illustrates how to reset the palette. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + workbook.ResetPalette(); + + + + + + Returns Color object from predefined colors by its index. + + Index from palette array. + RGB Color. + The following code illustrates how to get the color value for the specified excel known color. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + System.Drawing.Color color = workbook.GetPaletteColor(ExcelKnownColors.Aqua); + + + + + + Gets the nearest color with the specified Color structure + from Workbook palette. + + system color. + Returns Color index from workbook palette. + + + + Gets the nearest color to the specified Color structure + from Workbook palette. + + Color to look for. + Start index. + Color index from workbook palette. + + + + Gets the nearest color with the specified red, green, and blue + color values from Workbook palette. + + Red component of the color. + Green component of the color. + Blue component of the color. + Returns Color index from workbook palette. + + + + Sets the color or Gets nearest color. + + + If there is at least one free color, define a new color; + if not, search for the closest one to the specified Color structure + from Workbook palette. + + System color + Color index from workbook palette. + + The following code snippets illustrates how to set color or get nearest color. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + workbook.SetColorOrGetNearest(System.Drawing.Color.Aqua); + + + + + + Sets the color or Gets nearest color with the specified red, green and blue color value. + + + If there is at least one free color, define a new color; + if not, search for the closest one to the specified by red, green, and blue + values color from Workbook palette. + + Red component of the color. + Green component of the color. + Blue component of the color. + Color index from workbook palette. + + The following code snippet illustrates how to set color or get nearest color by red,green and blue. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + workbook.SetColorOrGetNearest(123,45,56); + + + + + + Replaces string with the specified string value. + + The string to be replaced. + The string to replace all occurrences of oldValue. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + string oldValue = "Find"; + string newValue = "NewValue"; + workbook.Replace(oldValue, newValue); + + + + + + + Replaces string with the specified DateTime value. + + The string to be replaced. + The DateTime value to replace all occurrences of oldValue. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + string oldValue = "Find"; + DateTime dateTime = DateTime.Now; + workbook.Replace(oldValue, dateTime); + + + + + + Replaces string with the specified double value. + + The string to be replaced. + The double value to replace all occurrences of oldValue. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + string oldValue = "Find"; + double newValue = 9.00; + workbook.Replace(oldValue, newValue); + + + + + + Replaces specified string with the specified array of string values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + string oldValue = "Find"; + string[] newValues = { "X values", "Y values" }; + workbook.Replace(oldValue, newValues, true); + + + + + + Replaces specified string with the specified array of int values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + string oldValue = "Find"; + int[] newValues = { 1, 2 }; + workbook.Replace(oldValue, newValues, true); + + + + + + Replaces specified string with the specified array of double values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + string oldValue = "Find"; + double[] newValues = { 1.00, 3.00 }; + workbook.Replace(oldValue, newValues, true); + + + + + + Replaces string with the specified DataTable value. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + The string to be replaced. + Data table with new data. + Indicates whether field name must be shown. + + The following code snippet illustrates how to replace the string value with data table. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + // create the data table + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("Dosage", typeof(int)); + table.Rows.Add(1); + string oldvalue = "AB2"; + // Replace the value with data table. + workbook.Replace(oldvalue, table, true); + + + + + + Replaces string with the specified DataColumn value. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + The string to be replaced. + Data table with new data. + Indicates whether field name must be shown. + + The following code snippet illustrates how to replace the string value with data table. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + // create the data table + System.Data.DataTable table = new System.Data.DataTable(); + table.Columns.Add("Dosage", typeof(int)); + table.Rows.Add(1); + System.Data.DataColumn dataColumn = table.Columns[0]; + string oldvalue = "AB2"; + // Replace the value with data column. + workbook.Replace(oldvalue, dataColumn, true); + + + + + + Creates a font object. + + Returns the newly created font. + + + + Creates a font object based on native font. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Native font to get settings from. + returns newly created font. + + The following code illustrates how to create a font object based on native font. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + System.Drawing.Font font = new System.Drawing.Font(System.Drawing.FontFamily.GenericSerif, 9); + workbook.CreateFont(font); + + + + + + Adds font to the inner fonts collection. Read-only. + + Font to add. + + Current font with correct font index, or same font from the collection if was added before. + + + The following code illustrates how to add font in the collections. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + IFont font = workbook.CreateFont(); + workbook.AddFont(font); + + + + + + Creates font object based on another font object. + + Base font for the new one. + Returns a newly created font. + + + + Method that creates font object based on another font object + and registers it in the workbook. + + Base font for the new one. + Indicates whether font should be added to the collection. + Newly created font. + + + + Returns the first occurrence of the specified string value with the specified . + + Value to search. + Type of value to search. + First found cell, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + string value = "value"; + IRange result = workbook.FindFirst(value, ExcelFindType.Text); + + + + + + Returns the first occurrence that starts with the specified string value. + + Value to search. + Type of value to search. + First found cell, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + string value = "value"; + IRange result = workbook.FindStringStartsWith(value, ExcelFindType.Text); + + + + + + Returns the first occurrence that starts with the specified string value which ignores the case. + + Value to search. + Type of value to search. + true to ignore case wen comparing this string to the value;otherwise,false + First found cell, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + string value = "value"; + IRange result = workbook.FindStringStartsWith(value, ExcelFindType.Text, true); + + + + + + Returns the first occurrence that ends with the specified string value. + + Value to search. + Type of value to search. + First found cell, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + string value = "value"; + IRange result = workbook.FindStringEndsWith(value, ExcelFindType.Text); + + + + + + Returns the first occurrence that ends with the specified string value which ignores the case. + + Value to search. + Type of value to search. + true to ignore case wen comparing this string to the value;otherwise,false + First found cell, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + string value = "value"; + IRange result = workbook.FindStringEndsWith(value, ExcelFindType.Text, true); + + + + + + Returns the first occurrence of the specified string value with the specified and . + + Value to search. + Type of value to search. + Way to search the value. + First found cell, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + string findvalue = "value"; + IRange result = workbook.FindFirst(findvalue, ExcelFindType.Text, ExcelFindOptions.None); + + + + + + Returns the first occurrence of the specified double value with the specified . + + Value to search. + Type of value to search. + First found cell, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + double value = 9.00; + IRange result = workbook.FindFirst(value, ExcelFindType.Number); + + + + + + Returns the first occurrence of the specified bool value. + + Value to search. + First found cell, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + IRange result = workbook.FindFirst(true); + + + + + + Returns the first occurrence of the specified DateTime value. + + Value to search. + First found cell, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + DateTime dateTime = DateTime.Now; + IRange result = workbook.FindFirst(dateTime); + + + + + + Returns the first occurrence of the specified TimeSpan value. + + Value to search. + First found cell, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + TimeSpan timeSpan = new TimeSpan(2, 30, 30); + IRange result = workbook.FindFirst(timeSpan); + + + + + + Returns the cells with specified string value. + + Value to search. + Type of value to search. + Returns all found cells, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + IRange[] results = workbook.FindAll("Hello World", ExcelFindType.Text); + + + + + + Returns the cells of the specified string value with the specified . + + Value to search. + Type of value to search. + Way to search. + + Returns all found cells, or Null if value was not found. + + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + IRange[] results = workbook.FindAll("Hello World", ExcelFindType.Text, ExcelFindOptions.MatchCase); + + + + + + Returns the cells of the specified double value with the specified . + + Value to search. + Type of value to search. + Returns all found cells, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + IRange[] results = workbook.FindAll(100.32, ExcelFindType.Number); + + + + + + Returns the cells of the specified bool value. + + Value to search. + Returns all found cells, or Null if value was not found + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + IRange[] range = workbook.FindAll(true); + + + + + + This method searches for the all cells with specified DateTime value. + + Value to search. + All found cells, or Null if value was not found. + + + + Returns the cells of the specified TimeSpan value. + + Value to search. + Return all found cells, or Null if value was not found. + + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + TimeSpan value = new TimeSpan(2, 30, 30); + IRange[] results = workbook.FindAll(value); + + + + + + Sets separators for formula parsing. + + Arguments separator to set. + Array rows separator to set. + + The following code illustrates how to set separators. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + workbook.SetSeparators(',', ';'); + + + + + + Creates header/footer engine. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + New instance of header/footer engine. + + + + Sets protection for workbook. + + Indicates if protect workbook window. + Indicates if protect workbook content. + + The following code snippet illustrates how to protect the workbook. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + workbook.Protect(true, true); + + + + + + Sets protection for workbook with password. + + Indicates if protect workbook window. + Indicates if protect workbook content. + Password to protect with. + + The following code snippet illustrates how to protect the workbook using password. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + workbook.Protect(true, true, "Password"); + + + + + + Unprotects workbook. + + + The following code illustrates how to unprotect a workbook. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + //Unprotects the password. + workbook.Unprotect(); + + + + + + Unprotects workbook using password. + + + Throws ArgumentOutOfRangeException when password is wrong. + + Password to unprotect workbook. + + The following code illustrates how to unprotect a workbook using password. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + //Unprotects the password using password. + workbook.Unprotect("Password"); + + + + + + Creates copy of the current instance. + + Copy of the current instance. + + + + Find the font object style. + + The cell text + The rich text string + RTF Collection + The excel font + + + + + Update the rtf text. + + XlsIO font. + Pdf font collection. + DrawString Collection. + RTF text. + + + + Sets write protection for workbook using password. + + Password to set. + + The following code snippet illustrates how to set write protection password. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + workbook.SetWriteProtectionPassword("Password"); + + + + + + Protects the workbook + + Password to generate the hash value. + + + + Creates random salt. + + Desired salt length. + Array with random data. + + + + Creates copy of the palette. + + Copy of the palette. + + + + Saves workbook data in Excel 2007 format into specified stream. + + Stream to save into. + Represents type of the saving document (on the current + moment supported values are template or ordinary document). + + + + Creates serializator that can be used to serialize workbook into file or stream. + + Version that must be used to serialize workbook. + Created serializator. + + + + This method changes internal styles structure for Excel 97. + + + + + + + + + + + + + + + + + This method checks whether we must change styles model from 2007 into 97 format + (if document (or file) was created by XlsIO we don't need to change styles). + + True if additional styles must be added for Excel 97. + + + + + + + + + + + Converts extended format colors. + + + + + + + Reduces font count based by switching all colors into indexed color mode. + + List with new font indexes. + + + + Reads the complete stream and retruns false if the doument is notvalid. + + Read to get data from. + Separator between cell values. + Encoding scheme for the StreamReader. + boolean value. + + + + Get excel version from file name. + + File name. + Returns ExcelVersion. + + + + Get the Excel save type from file version + + input file name + the save type + + + + Get excel version from stream. + + File name. + Returns ExcelVersion. + + + + Serialize workbook for the clipboard. + + Record's list to serialize into. + Worksheet to serialize. + + + + Serialize clipboard. + + Record's list to serialize into. + Worksheet to serialize. + Clipboard to range. + + + + Sets active worksheet. + + Worksheet that will be activated. + + + + + + + + + + + + + + + + + Updates index of all named ranges. + + Key - old index, value - new index. + + + + Sets Saved flag to the False state. + + + + + Updates string indexes. + + List with new indexes. + + + + Copies externsheets to to another workbook. + + Represents base extern sheets. + Represents dictionary with new sub books indexes. + Dictioanry with new indexes. Key - old index; value - new index. + + + + Looks through all records and calls AddIncrease for each LabelSST record. + + + + + Updates indexes in all records accordingly to the new maximum count property. + + New value of maximum possible XF index. + + + + Indicates whether specified xf index differs from the default one. + + XFIndex to check. + True if there is no difference. + + + + Evaluates maximum digit width of the font for Normal style. + + Maximum digit width of the font for Normal style. + + + + Evaluates maximum digit width of the font for Normal style. + + Maximum digit width of the font for Normal style. + + + + Evaluates maximum digit width of the specified font. + + Font to measure. + Maximum digit width of the specified font. + + + + Gets maximum digit height. + + Font to get digit height for. + Maximum digit height. + + + + Updates width from the rectangle. + + Current rectangle. + Current maximum value. + + + + Updates height from the rectangle. + + Current rectangle. + Current maximum value. + + + + Measures all digits using specified font and calls digitProcessor passing measurement results. + + Font to use. + DigitProcessor to call. + Value returned by digitProcessor after processing all digits. + + + + Converts column width in characters into column width in file. + + Column width in characters. + Column width in file. + + + + Convert column width that is stored in file into pixels. + + Column width in file. + Column width in pixels. + + + + Converts column width in pixels into column width in characters. + + Column width in pixels. + Column width in characters. + + + + Checks cache refer by pivot table in the workbook. + + + + + + + + Delete Connection + + + + + + Removes the unused XF and updates in innerExtFormats collection. + + + + + Adds the used style index into the collection + + + + + Updates the used style index into the collection + + + + + + + + + + + + Byte array values store the individual sheet calcEngine member values. + + + + + Set true flags to the CalcEngine members for the performance, with preserving previous values + + boolean value indicates whether the flags to be true and preserve the flags + + + + CRC checksum calculation + + + + + formula that contains @ symbol + Workbook + returns true if formula does not contains "@" symbol else false + returns the replaced formula + + + + + ReplaceSymbolToStringInFormula method replace the string and returns the formula with @ symbol + + formula that contains the _xlfn.Single string + Workbook + returns the replaced formula + + + + Parses the Vba Project + + + + + + Code name change event + + sender + Code name + + + + Add a Vba code module to the workbooks + + Vba Module + + + + Creates a Vba Project in the workbook. + + + + + Creates a macro storage + + Root storage + Indicates whether this is a Excel binary document + + + + Add list of extended properties into XF extended record. + + + + + Add extended property into list. + + + + + Returns extended property. + + + + + Get extended property type. + + + + + Convert ARGB to RGBA. + + + + + Convert ARGB to RGBA. + + + + + Convert Color object to unsigned integer. + + + + + Convert unsigned integer to Color object. + + + + + Whether a given character is allowed by XML 1.0. + + + + + Remove illegal xml character which is not allowed by XML 1.0. + + + + + Update standartd rowheight when standard font name or size changed. + + + + + Import XML document to the workbook. + + File name of XML document. + + + + Imports XML data into workbook from the specified XML data stream. + + Stream of XML document. + + + + Parse XML mapping. + + XML Reader. + + + + To update the cell scaled width and height. + + scale[0] refers to the cell width. + scale[1] refers to the cell height + + + + To get the cell scaled height. + + The cell font name. + The cell font size. + + + + Method add the watermark if license validation fails. + + input workbook object + + + + Gets the system font from XlsIO font. + + XlsIO font. + New font name for the font object. + returns system font. + + + + Gets the font style. + + XlsIO font. + return font style. + + + + Gets the font style. + + XlsIO font. + return font style. + + + + Gets the font size. + + XlsIO font. + returns font size based on superscript and subscript. + + + + Gets the system font from XlsIO font. + + XlsIO font. + returns system font. + + + + Indicates whether the text is null or whitespace. + + The text. + returns true if the text is null or whitespace otherwise false. + + + + Warning event + + + + + Workbook Vba Code Module + + + + + Contains the macro storage + + + + + + Indicates whether the Vba Project Created + + + + + Represents the pivot slicer caches + + + + + Represents the pivot slicer cache id + + + + + Gets an object that represents the active sheet (the sheet + on top) in the active workbook or in the specified window or + workbook. Returns Nothing if no sheet is active. Read-only. + + + + + Gets an object that represents the active tab sheet (the sheet + on top) in the active workbook or in the specified window or + workbook. Returns Nothing if no sheet is active. Read-only. + + + + + Preserves the DDE type links in workbook + + + + + Gets or sets index of the active sheet. + + + + + Denotes whether to display sheet tabs or not. + + + + + Gets or sets the author of the comment. + + + The following code snippet illustrates how to get the built in document properties. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + //Get the built in document properties. + IBuiltInDocumentProperties builtInDocumentProperties = workbook.BuiltInDocumentProperties; + string author = builtInDocumentProperties.Author; + + + + + + Gets collection that represents all the built-in document properties + for the specified workbook. Read-only. + + + + + This event is raised after code name changed. + + + + + Name which used by macros to access to workbook items. + + + + + Indicates whether pivot table fields option is hidden or not. + + + + + Indicates default theme version for wokbook + + + + + Gets collection that represents all the custom document properties + for the specified workbook. Read-only. + + + The following code snippet illustrates how to get the custom document properties. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + //Get the document properties. + ICustomDocumentProperties documentProperties = workbook.CustomDocumentProperties; + + + + + + Gets a MetaProperties collection that describes the meta data stored in the workbook. Read-only. + + + + + Gets collection that represents all the CustomXmlParts collection + for the specified workbook. Read-only. + + + The following code snippet illustrates how to get the custom Xml parts. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + //Get the customXml parts. + ICustomXmlPartCollection CustomXmlparts = workbook.CustomXmlparts; + + + + + + True if the workbook uses the 1904 date system. + + + + + True if the workbook uses precision. Read-only. + + + + + True if cells are protected. Read-only. + + + + + True if window is protected. Read-only. + + + + + Gets Names collection. + + + For an Application object, returns a Names collection that represents + all the names in the active workbook. For a Workbook object, returns + a Names collection that represents all the names in the specified + workbook (including all worksheet-specific names). + + + The following code snippet illustrates how to get names. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + INames names = workbook.Names; + + + + + + True if the workbook has been opened as Read-only. Read-only Boolean. + + + + + True if no changes have been made to the specified workbook since + it was last saved. If current value is false then setting it to true cause Save() method call. + + + + + Gets a Styles collection that represents all the styles + in the specified workbook. Read-only. + + + The following code snippet illustrates how to get the styles. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + IStyles styles = workbook.Styles; + + + + + + Gets a Sheets collection that represents all the worksheets + in the specified workbook. Read-only Sheets object. + + + The following code snippet illustrates how to get the worksheets. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + IWorksheets worksheets = workbook.Worksheets; + + + + + + Gets the workbook connections. Read Only + + + The following code snippet illustrates how to get the connections from the workbook. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + //Gets the workbook connections. + IConnections connections = workbook.Connections; + + + + + + True if workbook contains Vba macros. Read-only. + + + + + Deleted connections + + + + + Gets a Palette of colors the Excel document can have. + Here is a Table of color indexes their places in the color tool box + provided by XlsIO application: + -------------------------------------------- + | | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | + ---+---------------------------------------- + |0 | 00 | 51 | 50 | 49 | 47 | 10 | 53 | 54 | + |1 | 08 | 45 | 11 | 09 | 13 | 04 | 46 | 15 | + |2 | 02 | 44 | 42 | 48 | 41 | 40 | 12 | 55 | + |3 | 06 | 43 | 05 | 03 | 07 | 32 | 52 | 14 | + |4 | 37 | 39 | 35 | 34 | 33 | 36 | 38 | 01 | + ---+---------------------------------------- + |5 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | + |6 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | + -------------------------------------------- + + + + + + Gets or sets index of tab which will be displayed on document open. + + + + + Gets the collection of the chart objects. + + + + + Indicates whether exception should be thrown when unknown + name was found in a formula. + + + The following code snippet illustrates how to gets or sets the ThrowOnUnknownNames. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + workbook.ThrowOnUnknownNames = true; + bool isThrowOnUnknownNames = workbook.ThrowOnUnknownNames; + + + + + + Gets/Sets value to display horizontal scrollbar + + + This sample shows how to hide horizontal scroll bar. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + workbook.IsHScrollBarVisible = false; + + + + + + Gets/Sets value to display vertical scrollbar + + + This sample shows how to hide vertical scroll bar. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + workbook.IsVScrollBarVisible = false; + + + + + + Disables loading of macros from document. + + + Excel on file open will simply skip macros and will + work as if document does not contain them. This options works + only when file contains macros (HasMacros property is True). + + + + + Gets or sets the standard font size. + + + + + Gets or sets the name of the standard font. + + + + + Indicates whether to allow usage of 3D ranges in DataValidation + list property (MS Excel doesn't allow). + + + + + Gets collection of add-in functions. Read-only. + + + + + Gets calculation options. Read-only. + + + The following code snippet illustrates how to get the calculation options. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + //Get the calculation options. + ICalculationOptions calculationOptions = workbook.CalculationOptions; + + + + + + Gets or sets row separator for array parsing. + + + The following code snippet illustrates how to get row separator. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + string rowSeparator = workbook.RowSeparator; + + + + + + Gets the formula arguments separator. + + + The following code snippet illustrates how to get the argument separator. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + //Get the chart argumentSeparator. + string argumentSeparator = workbook.ArgumentsSeparator; + + + + + + Gets grouped worksheets. Read-only. + + + The following code snippet illustrates how to get the grouped sheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + IWorksheetGroup worksheetGroup = workbook.WorksheetGroup; + + + + + + Indicates whether worksheet is displayed right to left. + + + + + True if the tabs are visible. otherwise False. + + + + + Gets collection with all tabsheets in the workbook. Read-only. + + + The following code snippet illustrates how to get the tabsheets. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + ITabSheets tabsheets = workbook.TabSheets; + + + + + + Indicates whether detect string value passed to Value (and Value2) + property as DateTime. Default value is true. + + + Setting this property to false can increase performance. + + + + + Toggles string searching algorithm.Default value is true. + + + If true then Dictionary will be used + to locate string inside strings dictionary. This mode is faster but uses + more memory. If false then each time string is added to strings dictionary + we will have to iterate through it and compare new strings with existing ones. + + + + + True to display a message when the file is opened, recommending that the file be opened as read-only. + + + + + Gets or sets password to encrypt document. + + + + + Gets maximum row count for each worksheet in the workbook. Read-only. + + + + + Gets maximum column count for each worksheet in the workbook. Read-only. + + + + + Gets maximum possible number of extended formats. Read-only. + + + + + Gets maximum possible indent value. Read-only. + + + + + Maximum columns to import + + + + + Represents the unique styles count. + + + + + Indicates whether slicer properties are parsed in the workbook. + + + + + Extension list stream + + + + + Gets the LambdaFormulaArgument dictionary that contains LambdaFormulaArgument objects + + + + + Get or set indicates whether the styles has color palette or not. + + + + + Gets the person dictionary that contains person objects + + + + + Indicates slicer cache id + + + + + Gets and sets pivot table count in workbook. + + + + + True if the workbook has threaded comments. False if not + + + + + Gets and sets pivot table count in workbook. + + + + + Indicates whether the unused XF record removed or not. + + + + + create and gets the table styles. + + + + + Indicates the slicer cache collection + + + + + Contains formula existing row index with sheet name. It will be used in subtotal process. + + + + + Workbook level Conditional Priority count. + + + + + If palette is defualt or not + + + + + Indicates whether all the formula in the workbook is evaluated. + + + + + Represents the Excel Parse Options. + + + + + gets/ Sets the pivot table last index + + + + + Preserves the pivot cache. + + + + + Store the font indexes. + + + + + /Return file data holder, used to store data for Excel 2007 format. + + + + + Return WorkbookNamesColection from parent WorkBook. + + + + + Return ContententType Properties from the workbook + + + + + Return CustomXmlParts from the workbook + + + + + Returns collection of add-in functions. Read-only. + + + + + Returns name of the file the workbook was saved + in last time or loaded from. + + + + + Collection of all fonts used in the workbook. Read-only. + + + + + Collection of all ExtendedFormats used in the workbook. + + + + + Collection of all formats used in the workbook. Read-only. + + + + + SSTDictionary that contains all strings used in the workbook. Read-only. + + + + + Indicates whether workbook is loading. Read-only. + + + + + Indicates whether workbook is in saving process. Read-only. + + + + + Stores the attributes of the workbook window. Read-only. + + + + + Returns count of charts and worksheets in the workbook. + + + + + + + + + + Gets or sets the SST stream. + + The SST stream. + + + + Gets or sets a value indicating whether this instance has inline strings. + + + true if this instance has inline strings; otherwise, false. + + + + + Gets / sets PasswordRecord. + + + + + + + + + + + + + + + + + + + + First free shape id. + + + + + + + + + + + + + + + Returns collection of named objects owned by the workbook + (worksheet and charts). Read-only. + + + + + + + + + + Worksheets collection. + + + + + Charts collection. + + + + + Dialogsheet collection. + + + + + Macrosheet and IntlMacrosheet collection + + + + + Returns collection of external workbooks. + + + + + Returns calculation options. Read-only. + + + + + Returns workbook graphics. + + + + + Gets or sets the destination file path. + + + + + Returns class for formula parsing. Read-only. + + + + + Returns grouped worksheets. Read-only. + + + + + Indicates whether original file contains duplicated external names. + + + + + Returns data that is shared by all shapes (global options, unique pictures, etc. ). + + + + + Returns data that is shared by all header/footers. + + + + + Gets externSheet record. Read - only. + + + + + Gets / sets internal flag that indicates whether workbook was saved or not. + + + + + + + + + + + + + + + Gets a value indicating whether this Workbook is converted. + + + true if this instance is converted; otherwise, false. + + + + + Beginning version of Excel + + + + + Represents the Data sorter. + + + + + Indicates whether the workbook format is Strict Open XML Spreadsheet. + + + + + Gets / sets excel version. + + + + + Returns index to the default extended format. + + + + + Returns internal array with palette colors. Read-only. + + + + + + + + + + Gets pivot caches collection. Read-only. + + + The following code snippet illustrates how to get pivot caches. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + + IPivotCaches pivotCaches = workbook.PivotCaches; + + + + + + Returns collection of workbook pivot caches. Read-only. + + + + + Gets value indicating whether workbook controls stream or not. Read-only. + + + + + Gets value indicating whether workbook controls stream or not. Read-only. + + + + + Gets or sets maximum used table (list object) index. + + + + + Indicates whether workbook is converting to Pdf or Image or HTML. + + + + + Gets value indicating whether workbook was loaded from file or stream. + + + + + Line Styles in themes.xml + + + + + Specifies wheather the workbook checks the Compability of earlier version + + + + + Gets or sets a value indicating whether the name ranges has apostrophe. + + + true if this instance has apostrophe; otherwise, false. + + + + + Indicates whether book has oleObjects + + This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Indicates whether Ole Objects are copied + + This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + OleStorageCollection of workbook + + + + + Gets or sets boolean value to parse worksheets on demand + + + + + Alogrithm name to protect/unprotect workbook. + + + + + Hash value to ensure the workbook protected password. + + + + + Random generated Salt for the workbook password. + + + + + Spin count to loop the hash algorithm. + + + + + Contains the Date Time patterns od the current culture with date custom format + + + + + Returns the collection of XmlMap object. Read-Only. + + + + + Gets value indicating whether the FileSharing Record is null or not. + + + true When FileSharing record is not null; otherwise, false. + + + + + Maintains the precedents cell collection for all cells + + + + + Gets or sets the dictionary to hold processed number format indexes + + + + + Indicates whether the calc engine enabled and disabled on parsing and serializing + + + + + Gets or sets the substitute font name. + + + + + Represents the slicer names in the worksheet. + + + + + This event is fired after workbook is successfully saved. + + + + + This event is fired when user tries to save into read-only file. + + + + + Gets or sets standard ( default ) row height of all the worksheets. + in points. Double. + + + + + Gets or sets row height in pixels + + + + + Summary description for WorkbookExcel97Serializator. + + + + + Classes that implement this interface are responsible for whole + workbook serialization into stream or into file. + + + + + Saves workbook into specified file. + + Destination file name. + Workbook to save. + Save type. + + + + Saves workbook into stream. + + Stream to save into. + Workbook to save. + Save type (template or ordinary xls). + + + + Maximum password length. + + + + + Followed Hyperlink Style + + + + + Hyperlink Style + + + + + Reserved shape ids. + + + + + Default constructor. + + + + + Saves workbook into specified file. + + Destination file name. + Workbook to save. + Save type. + + + + Saves workbook into stream. + + Stream to save into. + Workbook to save. + Save type (template or ordinary xls). + + + + Saves all workbook records into specified array. + + Array that will receive all workbook records. + Format in which worksheet should be saved. + Object that is used to encrypt data. + Workbook to serialize. + Worksheet that must be serialized when we are + serializing data for clipboard. + Indicates whether we are serializing data + for saving into file or into clipboard. + + + + Saves all workbook records into specified array. + + Array that will receive all workbook records. + Format in which worksheet should be saved. + Object that is used to encrypt data. + Workbook to serialize. + Worksheet that must be serialized when we are + serializing data for clipboard. + Indicates whether we are serializing data + for saving into file or into clipboard. + clipBoard range. + + + + Serializes pivot caches info. + + Records to serialize into. + Worbook to get data from. + + + + Serializes all mso drawings (picture, header/footer images, etc.) if necessary. + + Record's list to serialize into. + Workbook to serialize. + + + + Creates encryptor. + + Encryption type to use. + Workbook to serialize. + Created encryptor. + + + + This function is looking for unused formats and for formats + that have equal data. + + + + + Removes unused or equal fonts from internal lists. Also will be updated styles + and formats which have references on unused or optimized fonts. + + + + + Method remove from list equal styles. + + Workbook to serialize. + + + + Creates BoundSheetRecord that corresponds to the specified worksheet. + + INamedObject the BoundSheetRecord is created for. + Created BoundSheetRecord. + + + + Saves workbook into compound storage. + + Storage to save workbook into. + Indicates whether + Record collection that should be filled during serialization + Object that is used to encrypt data. + Workbook to serialize. + + + + Copies storage subitems. + + Storage to copy into. + Parent workbook. + + + + Copies substorages. + + Storage to copy into. + Storage to copy from. + + + + Copies substreams. + + Storage to copy into. + Storage to copy from. + + + + Serializes all names defined in the workbook. + + OffsetArrayList that will receive all records. + Workbook to serialize names from. + + When specified OffsetArrayList is NULL. + + + + + Fill BoundSheetRecord that corresponds to the specified worksheet. + + Record to fill. + Worksheet the BoundSheetRecord is created for. + + + + Fills BoundSheetRecord that corresponds to the specified worksheet. + + Record to fill. + Chart the BoundSheetRecord is created for. + Created BoundSheetRecord. + + + + Warning Event handler + + Workbook + Warninginfo + + + + Shapes Getter Method + + + + + + + Delegate used for digit size evaluation. + + Rectangle containing current digit size. + Current maximum value. + + + + This class is used to convert worksheet into image. + + + + + Object that helps to get formatting of the cells with conditional formats. + + + + + Indicates the sortedList for conditional formatting + + + + + Represents the final resultant image. + + + + + Represents width after the current column for drawing aligned text. + + + + + Represents width before the current column for drawing aligned text. + + + + + Represents the RightToLeft Worksheet. + + + + + Use this NumberFormatChar to check the Unicodes. + + + + + Converts worksheet into image. + + Worksheet to convert. + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Type of the image to create. + Output stream, if null it is ignored. + Image containing worksheet data. + + + + Converts worksheet into image. + + Worksheet to convert. + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Image containing worksheet data. + + + + Converts worksheet into image. + + Worksheet to convert. + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Metafile EmfType. + Output stream, if null it is ignored. + Image containing worksheet data. + + + + Converts worksheet into image. + + Worksheet to convert. + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Type of the image to create. + Output stream, if null it is ignored. + Image containing worksheet data. + + + + Converts worksheet into image. + + Worksheet to convert. + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Type of the image to create. + Output stream, if null it is ignored. + Metafile EmfType. + Image containing worksheet data. + + + + Converts worksheet into image. + + Worksheet image. + Worksheet that is being converted into image. + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Helper object to get row height faster. + Helper object to get column width faster. + Total image width. + Total image height. + + + + Draws the shapes. + + Array that contains shapes to be rendered + Worksheet that is being converted into image. + Graphics to draw cells at. + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Helper object to get row height faster. + Helper object to get column width faster. + + + + Draw the chart. + + Chart that is being converted into image. + Graphics to draw cells at. + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Helper object to get row height faster. + Helper object to get column width faster. + + + + Draws a shape onto the image. + + Shape to be drawn + Worksheet where the shape is present + graphics to render the shape + + + + Draw Rich text inside the AutoShape. + + RichText object that holds the formatted text. + AutoShape for which text should be rendered. + worksheet where the shape is present + Rectangle bounds of the text to be rendered.. + PdfGraphics object to render the RichText. + + + + Draw the RTf text. + + The cell rectangle. + string format of the text + worksheet where the Rtf text is present + The graphics object + Font collection. + DrawString collection. + Indicating wheather shape or not. + Indicating wheather is wrapText or not + Indicating wheather shape Horizontal Text is overflow or not + Indicating wheather shape vertical Text is overflow or not. + + + + checks and applies fill in shape + + graphicsPath of the textbox + shape for which fill to be applied + pen to draw textbox + graphics to draw textbox + rectangle bounds of the shape + + + + Fills the shape Background + + graphics to apply fill + shape for which fill should be applied + path of the shape on the graphics + fill format of the shape + rectangle of the shape + + + + Get gradient brush for shapes + + path of the shape on the graphics + fill to the shape + shape for which fill should be applied + rectangle of the shape + graphics to apply fill to + Brush + + + + Linear gradient fill implementation + + GradientStops used to find the parsing angle + path of the shape on the graphics + Collection of colors with respective positions + fill to the shape + rectangle of the shape + linearGradientBrush + + + + Radial Gradient Fill implementation + + Path of the shape on the graphics + Collection of colors with respective positions + path of the shape on the graphics + GradientStops used to find the parsing angle + RadialGradientBrush + + + + Get scaled rectangle + + rectangle of the graphics path + scale of the 3d default scale factor + + + + + Draws the background image + + Worksheet that is being converted into image. + Graphics to draw cells at. + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Helper object to get row height faster. + Helper object to get column width faster. + + + + Gets the background image width coordinates. + + The start X. + The start Y. + Width of the image. + Height of the image. + The image coordinates. + The PDF page. + + The collection coordinates and the sizes of Background image width. + + + + + Gets the background height coordinates. + + The start X. + The start Y. + Width of the image. + Height of the image. + The image coordinates. + The PDF page. + + The collection coordinates and the sizes of Background height. + + + + + Draws all required merged regions. + + Worksheet that is being converted into image. + One-based index of the first row to export. + One-based index of the first column to export. + One-based index of the last row to export. + One-based index of the last column to export. + Graphics object to draw at. + Helper object to get row height faster. + Helper object to get column width faster. + Method to call for each found merge. + + + + Draws merged region. + + Worksheet that is being converted into image. + Merged region to draw. + One-based index of the first row of the drawn range that contains part or whole merged range. + One-based index of the first column of the drawn range that contains part or whole merged range. + Graphics to draw at. + Helper object to get row height faster. + Helper object to get column width faster. + + + + Gets coordinates of the merge. + + Worksheet containing merge region. + Merge region to get rectangle for. + One-based index of the first row of the drawn range that contains part or whole merged range. + One-based index of the first column of the drawn range that contains part or whole merged range. + Helper object to get row height faster. + Helper object to get column width faster. + + + + + Draws merged region background. + + Worksheet that is being converted into image. + Merged region to draw. + One-based index of the first row of the drawn range that contains part or whole merged range. + One-based index of the first column of the drawn range that contains part or whole merged range. + Graphics to draw at. + Helper object to get row height faster. + Helper object to get column width faster. + + + + Iterates through all cells and calls specified method for each. + + Worksheet that is being converted into image. + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Graphics to draw cells at. + Helper object to get row height faster. + Helper object to get column width faster. + Method to call for each cell. + + + + Draws separate cell value. + + Worksheet that is being converted into image. + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Graphics to draw cells at. + Helper object to get row height faster. + Helper object to get column width faster. + + + + Adds adjacent cells to the cell's range if necessary. + + Cell to try to add to. + Original rectangle. + Helper object to get column width faster. + Represents first column. + Represents second cell. + Updated rectangle. + + + + Gets updated X position to draw the aligned text. + + Specifies the current cell. + Specifies the bounds for current cell. + Specified the helper to get column width. + Specified the first column for the text. + Specifies the adjacent cell of teh current cell. + Specifies whether to consider previous or next column. + Specifies the worksheet. + Specifies the column width of current cell. + Specified the width required to draw current cell text. + Specifies the updated width to draw the text. + + + + + Draws worksheet gridlines. + + Worksheet that is being converted into image. + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Graphics to draw cells at. + Helper object to get row height faster. + Helper object to get column width faster. + Total image width. + Total image height. + + + + Draw the image. + + The shape. + Image that is being converted into image. + Graphics to draw cells at. + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Helper object to get row height faster. + Helper object to get column width faster. + + + + Draws specified cell object. + + Cell to draw. + Rectangle to draw cell inside (borders). + Bounding rectangle for cell value. + Graphics to draw at. + + + + Draws specified cell object. + + Extended format to use for cell drawing. + Cell to draw. + Rectangle to draw cell inside (borders). + Bounding rectangle for cell value. + Graphics to draw at. + + + + Checks the unicode. + + The unicode text. + + True if the text is an unicode else false will returned. + + + + + Get the text have symbols + + The given text + If text have symbols return true + + + + Checks for Segoe UI symbols characters in the Unicode string + + Input Unicode string + True if the Unicode string contain Segoe UI symbols characters. False otherwise + + + + Checks for Segoe UI Emoji symbols characters in the Unicode string + + Input Unicode string + True if the Unicode string contain Segoe UI Emoji Symbols characters. False otherwise + + + + Checks for Segoe UI Emoji symbols characters in the Unicode string + + Input Unicode string + True if the Unicode string contain Segoe UI Emoji symbols characters. False otherwise + + + + Checks for Segoe UI Emoji symbols characters in the Unicode string + + Input Unicode string + True if the Unicode string contain Segoe UI Emoji symbols characters. False otherwise + + + + Modifies font name so as to render Unicode characters. + + The sting in test for Unicode characters. + The Charset of the font. + The name of the font. + + + + + Gets fall back font to preserve the text in converted Image. + + Represent original Font stream. + Represent original System font. + Represent a input text. + Represent a font style. + Returns a fall back font instance, if it has; otherwise returns original Font. + + + + Check unicode symbols for unicode string. + + string + True, if string value as unicode symbol, otherwise false. + + + + Checks for amharic characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Amharic characters. False otherwise. + + + + Checks for khmer characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Khmer characters. False otherwise. + + + + Checks for thai characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Thai characters. False otherwise. + + + + Checks for sinhala characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Sinhala characters. False otherwise. + + + + Checks for myanmar characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Myanmar characters. False otherwise. + + + + Checks for tamil characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Tamil characters. False otherwise. + + + + Checks for telugu characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Telugu characters. False otherwise. + + + + Checks for punjabi characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Punjabi characters. False otherwise. + + + + Checks for malayalam characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Malayalam characters. False otherwise. + + + + Checks for kannada characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Kannada characters. False otherwise. + + + + Checks for gujarati characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Gujarati characters. False otherwise. + + + + Checks for marathi characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Marathi characters. False otherwise. + + + + Checks for bengali characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Bengali characters. False otherwise. + + + + Checks for odia characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contain Odia characters. False otherwise. + + + + Checks for Latin characters in the Unicode string. + + Input Unicode string. + True if the Unicode string does not contain Latin characters. False otherwise. + + + + Checks for CJK characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contains CJK characters. False otherwise. + + + + Checks for Hebrew or Arabic characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contains Arabic or Hebrew characters. False otherwise. + + + + Checks for Korean characters in the Unicode string. + + Input Unicode string. + True if the Unicode string contains Korean characters. False otherwise. + + + + Gets the font style. + + XlsIO font. + return font style. + + + + Draws IconSet image. + + Represents the graphics object. + The extended format of the cell. + The adjacent cell rect. + The Pdf font in the cell. + The string format of the cell value. + + + + Draws the RTF string (Rich Text Format string) + + Bounding rectangle for cell value. + Cell to draw. + Cell string value + Graphics to draw at. + + + + Draws rotated text. + + Rectangle used for cell drawing. + Cell's format. + Cell to draw. + + Graphics object to draw at. + Represents native font. + Represents brush to fill the interior. + Represents string format. + + + + Aligns the rotated text based on string format. + + string format. + Rotation angle. + returns string format. + + + + Rotates rectangle at coordinates (0,0) and specified size at specified angle. + + Size of the rectangle to rotate. + Angle to rotate at. + Rectangle points after rotation. + + + + Aligns rectangle specified by points inside another rectangle. + + Points to align. + Rectangle to align in. + Horizontal alignment. + Vertical alignment. + Required offset to get correct point for string drawing. + + + + Converts rotation angle into counter-clockwise value. + + Angle to convert. + Converted value. + + + + Updates string for top to bottom text drawing if necessary. + + Value to update. + Rotation angle. + Updated value. + + + + Draws cell background. + + Cell to draw background for. + Cell's rectangle. + Graphics to draw at. + + + + Draws background at the specified position. + + Object containing background settings. + Rectangle specifying coordinates of the drawn background. + Graphics to draw at. + + + + Draw the data bar + + ExtendedFormatStandAlone + percent of the data bar + left of the rectangle + right of the rectangle + top of the rectangle + bottom of the rectangle + x of the rectangle + y of the rectangle + width of the rectangle + height of the rectangle + The sheet + The graphics + the cell range + Return the rectangle in float + + + + Creates brush object based on specified extended format. + + Extended format to get brush for. + Created brush object. + + + + Get Linear Gradient Brush + + The cell gradient fill + The cell rectangle + LinearGradientBrush + + + + Normalizes color - makes it non-transparent. + + Color to normalize. + Non-transparent color (Alpha = 255) based on specified color. + + + + Gets vertical string alignment based on the cell style. + + Style to get data from. + String alignment. + + + + Gets horizontal string alignment based on the cell style. + + Style to get data from. + Cell to get alignment for. + String alignment. + + + + Draws cell borders (including gridlines if necessary). + + Border collection. + Cell's rectangle. + Graphics to draw at. + Represents cell Range to draw border. + + + + Draws specified border. + + + + + + + + + + + + + Draws doubled border. + + + + + + + + + + + + + Draws outer line of the double border. + + Graphics to draw at. + Pen to draw with. + Borders collection containing border that is being drawn. + Border that is being drawn. + X coordinate of the starting point for ordinary border. + Y coordinate of the starting point for ordinary border. + X coordinate of the finishing point for ordinary border. + Y coordinate of the finishing point for ordinary border. + + + + + + + Draws inner line of the double border. + + Graphics to draw at. + Pen to draw with. + Borders collection containing border that is being drawn. + Border that is being drawn. + X coordinate of the starting point for ordinary border. + Y coordinate of the starting point for ordinary border. + X coordinate of the finishing point for ordinary border. + Y coordinate of the finishing point for ordinary border. + + + + + + + Updates delta coordinates for double border drawing, if necessary. + + + + + + + + + + + + + + + + + + + + + + + + + Draws single border at specified position. + + Border to draw. + X coordinate of the first point. + Y coordinate of the first point. + X coordinate of the second point. + Y coordinate of the second point. + Graphics to draw at. + + + + Creates pen for the specified border. + + Border to create pen for. + Created pen. + + + + Gets DashStyle for the pen based on the border settings. + + Border to get DashStyle for. + DashStyle closest to the border line settings. + + + + Evaluates line width based on border settings. + + Border to get data from. + + + + + Creates image of the specified size and type. + + Image width. + Image height. + Type of the image to create. + Stream to save into. + Metafile EmfType. + Created image. + + + + String Format + + + + + Represents left width. + + + + + Represents right width. + + + + + Represent the GDI graphics string format. + + + + + Represent the GDI graphics. + + + + + Represent the text rectangle inside shape. + + + + + Represent the workbookImpl. + + + + + Represent the ChartImpl. + + + + + Create a covertChartShapes object. + + WorkbookImpl + ChartImpl + + + + Draw the shapes and picutre inside the chart. + + Chart stream + chart width + chart height + + + + Draw the shapes. + + Shapes collection inside chart + Graphics + Scale width + Scale height + + + + Draw groupShape inside the chart. + + GroupShapeImpl + Graphics + ScaleWidth + Scaleheight + + + + Draw Image inside the chart. + + ShapeImpl + Image inside chart + Graphics + ScaleWidth + ScaleHeight + + + + Crops the image with the specified offset. + + Source image to crop. + Left offset to crop from. + Top offset to crop from. + Right offset to crop. + Bottom offset to crop. + Indicates whether the destination image is transparent. + Returns the cropped image for the offsets specified. + + + + Apply duotone to the give image. + + Picture shape. + ImageAttributes need to be applied. + Color changed ImageAttributes. + + + + Apply duotone to the give image. + + In where the duotone need to apply. + duotone color informations. + Duotone applied image. + + + + Executes Linear interpolation for Duotone. + + In where the factor is applied. + In where the factor is applied. + Factor value. + Final factorized color. + + + + Create Non-Index image from source image. + + Source Image. + Created Non-Indexed image. + + + + Apply Image transparency. + + In where the transparency need to apply. + Transparency to apply. + + + + Apply recolor to the give image. + + In where the recolor need to apply. + Picture shape. + Recolored image. + + + + Draw the shapes inside the chart. + + ShapeImpl + GDI graphics + Scale width + Scale height + + + + Draw the RotateText. + + Text rectangle area + Text direction type + GDI graphics + + + + Applies rotation for the AutoShape/Textbox. + + Shape for which rotation should be applied. + Rectangle bound values of the Shape. + Rotation angle to apply the rotation. + PdfGraphics to render the Shape. + + + + Updates the bound's of the text inside the AutoShape. + + Rectangle bounds of the text inside the AutoShape. + Rectangle bounds of the AutoShape. + AutoShape for which text bounds should be updated. + + + + Gets the vertical alignment from shape. + + The text box shape. + The pdfVerticalAlignment value + + + + Get rotation angle. + + Text direction in inside shape + Rotation angle + + + + Gets the text alignment from shape. + + The shape. + The PdfTextAlignment value. + + + + Get the anchor position from text direction and alignment + + input text direction of the text body + input text body vertical alignment + input text body horizontal alignment + + + + Draw Rich text inside the AutoShape. + + RichText object that holds the formatted text. + AutoShape for which text should be rendered. + Rectangle bounds of the text to be rendered.. + PdfGraphics object to render the RichText. + + + + Aligns the rotated text based on string format. + + string format. + Rotation angle. + Shape object + returns string format. + + + + Draw the RTf text. + + The cell rectangle. + The cell adjacent rectangle. + The pdf graphics. + Font collection. + DrawString collection. + Indicating wheather shape or not. + Indicating wheather is wrapText or not + Indicating wheather shape Horizontal Text is overflow or not + Indicating wheather shape vertical Text is overflow or not. + + + + Gets the font. + + The font object of the cell. + Name of the font. + The size of the font. + Font object + + + + Gets the text layout's bounds for the AutoShape. + + AutoShape for which the text bounds should be obtained. + Bound value of the shape from which text bounds to be calculated. + Rectangle bound values for the text inside the AutoShape. + + + + Draw the shape and applied the fill color. + + GDI graphics path + ShapeImpl + + GDI grphics + Shape rectangle area + + + + Fills the shape background. + + pdfGraphics to apply fill to. + Shape for which fill should be applied. + Path of the shape on the PdfGraphics. + Fill format of the shape. + + + + Creates image in the meta format. + + Boundary values of the image. + Memorystream to save the image to. + Newly created image stream. + + + + Check whether the AutoShape type is line. + + AutoShape to be checked. + Returns true if the AutoShape is a type of line else returns false. + + + + Check whether shape can be set fill or not. + + Shape to check. + Returns true if fill can be applied to shape else returns false. + + + + Applied the shape rotation. + + GDI graphics + ShapeImpl + shape rectangle area + + + + Gets the lattitude value of the shape from Scene 3D. + + AutoShape for which the lattitude value should be obtained. + Boolean value indicates whether AutoShape is flipped horizontally. + Rotation angle of the AutoShape. + + + + Checked whether the group shape contains Vertical flip. + + Group Shape. + True if the group shape contains flip.. + + + + Checked whether the group shape contains Horizontal flip. + + Group Shape. + True if the group shape contains flip.. + + + + Get Horizontal flip count. + + Group Shape. + Flip count. + Flip count. + + + + Get Vertical flip count. + + Group Shape. + Flip count. + Flip count. + + + + Gets the graphics path for autoshapes. + + Bounds to indicate the size of the autoshape. + PdfPen to draw outlines of the autoshapes. + pdfGraphics object in which autoshapes has to be drawn. + Autoshape for which path should be obtained. + Newly created pdfPath for the autoshape. + + + + Get custom geomentryPath. + + Shape rectangle area + GDI graphich path + ShapeImpl + GDI grphics path + + + + Get geomentry path. + + GDI grphics path + Path element collection + path width + path height + shape rectangle area + + + + Convert EMU to Point. + + EMU value. + Point value. + + + + Get geomentry path y value. + + Path height + Update y value + shape rectangle area + + + + + Get transform matrix. + + Shape rectangle area + Rotation angle + flipV + FlipH + Matrix + + + + Get drark color. + + Fill color + Increase or decrease the color vlaue based on given value. + Fill color + + + + Creates the pen. + + The format of the line. + The Pen object. + + + + Normalizes the color. + + The color. + The Normailzed Color + + + + Create graphics pen. + + ShapeImpl + Shape lineFormat + scaled width + + + + + Gets the custom line head style. + + Head style of the arrow. + Head lenght of the arrow. + Head width of the arrow. + + + + + Gets the custom line style's graphics path. + + Arrow head style of the line. + Arrow head length of the line. + Arrow head width of the line. + Base in set value. + + + + + Gets the Arrow head's style value. + + Arrow head's style. + Graphics path to draw. + Style value to be returned. + Returns true if not drawn else returns false. + + + + Get hatch style. + + Pattern style + HasStyle pattern + + + + Gets the dash style. + + Theformat of the line. + The PdfDashStyle value. + + + + String Format + + + + + + + + + + + + + + + + + + + + + + Get Curved Connector path + + + formulaColl.Add("x2","*/ w adj1 100000"); + formulaColl.Add("x1","+/ l x2 2"); + formulaColl.Add("x3","+/ r x2 2"); + formulaColl.Add("y3","*/ h 3 4"); + + + + + + + + Get Curved Connector path + + + formulaColl.Add("x2","*/ w adj1 100000"); + formulaColl.Add("x1","+/ l x2 2"); + formulaColl.Add("x3","+/ r x2 2"); + formulaColl.Add("y3","*/ h 3 4"); + + + + + + + + Get Bent Connector path + + + formulaColl.Add("x1","*/ w adj1 100000"); + > + + + + + + + Get Bent Connector path + + + formulaColl.Add("x1","*/ w adj1 100000"); + > + + + + + + + Get bend connector 2 path. + + bend connector2 points + + + + Get bend connector 2 path. + + Graphics path for bend connector2 points + + + + Get bend connector4 path. + + Pdf path for bentconnector4 points + + + + Get bent connector5 path. + + Pdf path for bent connector5 points + + + + Get bent connector4 path. + + Graphics path for bent connector4 points + + + + Get bent connector 5 path. + + Graphics path for bent connector5 points + + + + Get curved connector 2 path + + Grpahics path for curved connector 2 points + + + + Get curved connector 4 path. + + Graphics path for curved connector4 points + + + + Get curved connector5 path. + + Graphics path for curved connector5 points + + + + Get curved connector2 path. + + Pdf path for curved connector2 points + + + + Get curved connector 4 path. + + Pdf path for curved connector4 points + + + + Get curved connector 5 path. + + GraphicsPath for curved connector 5 path + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Get Triangle path + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the right arrow path. + + + + + + Gets the left arrow path. + + + + + + Gets down arrow path. + + + + + + Gets the left right arrow path. + + + + + + Gets the curved right arrow path. + + + + + + Gets the curved left arrow path. + + + + + + Gets the curved up arrow path. + + + + + + Gets the curved down arrow path. + + + + + + Gets up down arrow path. + + + + + + Gets the quad arrow path. + + + + + + Gets the left right up arrow path. + + + + + + Gets the bent arrow path. + + + + + + Gets the U trun arrow path. + + + + + + Gets the left up arrow path. + + + + + + Gets the bent up arrow path. + + + + + + Gets the striped right arrow path. + + + + + + Gets the notched right arrow path. + + + + + + Gets the pentagon path. + + + + + + Gets the chevron path. + + + + + + Gets the right arrow callout path. + + + + + + Gets down arrow callout path. + + + + + + Gets the left arrow callout path. + + + + + + Gets up arrow callout path. + + + + + + Gets the left right arrow callout path. + + + + + + Gets the quad arrow callout path. + + + + + + Gets the circular arrow path. + + + + + + Gets the math plus path. + + + + + + Gets the math minus path. + + + + + + Gets the math multiply path. + + + + + + Gets the math division path. + + + + + + Gets the math equal path. + + + + + + Gets the math not equal path. + + + + + + Gets the flow chart alternate process path. + + + + + + Gets the flow chart predefined process path. + + + + + + Gets the flow chart internal storage path. + + + + + + Gets the flow chart document path. + + + + + + Gets the flow chart multi document path. + + + + + + Gets the flow chart terminator path. + + + + + + Gets the flow chart preparation path. + + + + + + Gets the flow chart manual input path. + + + + + + Gets the flow chart manual operation path. + + + + + + Gets the flow chart connector path. + + + + + + Gets the flow chart off page connector path. + + + + + + Gets the flow chart card path. + + + + + + Gets the flow chart punched tape path. + + + + + + Gets the flow chart summing junction path. + + + + + + Gets the flow chart or path. + + + + + + Gets the flow chart collate path. + + + + + + Gets the flow chart sort path. + + + + + + Gets the flow chart extract path. + + + + + + Gets the flow chart merge path. + + + + + + Gets the flow chart online storage path. + + + + + + Gets the flow chart delay path. + + + + + + Gets the flow chart sequential access storage path. + + + + + + Gets the flow chart magnetic disk path. + + + + + + Gets the flow chart direct access storage path. + + + + + + Gets the flow chart display path. + + + + + + Gets the rectangular callout path. + + + + + + Gets the rounded rectangular callout path. + + + + + + Gets the oval callout path. + + + + + + Gets the cloud callout path. + + + + + + Gets the line callout1 path. + + + + + + Gets the line callout2 path. + + + + + + Gets the line callout3 path. + + + + + + Gets the line callout1 accent bar path. + + + + + + Gets the line callout2 accent bar path. + + + + + + Gets the line callout3 accent bar path. + + + + + + Gets the line callout1 no border path. + + + + + + Gets the line callout2 no border path. + + + + + + Gets the line callout3 no border path. + + + + + + Gets the line callout1 border and accent bar path. + + + + + + Gets the line callout2 border and accent bar path. + + + + + + Gets the line callout3 border and accent bar path. + + + + + + + + + + + + + + + + + + + + + Get Path adjust value + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Class used to parse check box in Excel 2007 xml format. + + + + + Extracts shape type settings from the reader and creates shape with default settings. + + XmlReader to get general shape settings from. + Parent worksheet for the shape. + Shape with default settings without adding it to any collection + + + + Tries to parse unknown client data tag. + + Reader to get data from. + Shape to put data into. + + + + Registers shape in all necessary collections. + + Shape to register. + + + + Creates shape with default settings + + Worksheet Shape Collection + Shape with default settings + + + + This class is used for header/footer images parsing. + + + + + Maximum crop value. + + + + + Crop value regex pattern. + + + + + Extracts shape type settings from the reader and creates shape with default settings. + + XmlReader to get general shape settings from. + Parent worksheet for the shape. + + Shape with default settings without adding it to any collection + + + + + Parses shape and adds it to all necessary shapes collections. + + XmlReader to get shape from. + Default shape that must be cloned to get resulting shape. + Corresponding relations collection. + Path to the parent item (item which holds all these xml tags). + + + + Parses style attribute of the comment shape. + + Reader to get attribute data from. + Comment shape to set values to. + + + + Parses style properties. + + Textbox to put properties into. + String representation of the style properties + (key - property name, value - property value). + + + + Parses shape id + + Extracted shapeid or -1 if format was incorrect. + + + + Parses image data. + + XmlReader to get required information from. + Name of the new shape. + Parent worksheet to place new shape into. + Corresponding relations collection. + Path to the parent item. + + + + Creates shape with default settings + + Worksheet Shape Collection + Shape with default settings + + + + Get crop value. + + The cropped string value. + + + + Summary description for UnmanagedArray. + + + + + Memory block that contains array data. + + + + + Size of the memory block. + + + + + Default constructor. + + + + + Initializes new instance of the array. + + Memory size in bytes. + Indicates whether to zero memory. + + + + Frees all allocated resources. + + + + + Disposes this object. + + + + + Returns Int32 value from the array. + + Index of the Int32 value in the array (offset will be 4 * index). + Int32 value from the array. + + + + Returns Int16 value from the array. + + Index of the Int16 value in the array (offset will be 2 * index). + Int16 value from the array. + + + + Returns Byte value from the array. + + Index of the Byte value in the array. + Int32 value from the array. + + + + Sets Int32 value into the array. + + Index of the Int32 value in the array (offset will be 4 * index). + Value to set. + + + + Sets Int16 value into the array. + + Index of the Int16 value in the array (offset will be 2 * index). + Value to set. + + + + Sets Byte value into the array. + + Index of the Byte value in the array. + Value to set. + + + + Resizes current array. + + Desired size in bytes. + Indicates whether to zero memory. + + + + Copies memory from source unmanaged array to current unmanaged array. + + Represents source array. + Returns updated current array. + + + + Clears current array. + + + + + + This class contains utility methods, that cannot be logically placed in any other class. + + + + + Number of days that are incorrectly displayed by MS Excel. + + + + + Excel 2007 maximum row count. + + + + + Excel 2007 maximum column count. + + + + + Excel 97-03 maximum row count. + + + + + Excel 97-03 maximum column count. + + + + + To prevent creation instances of this class. + + + + + Determines if rectangles intersect with each other. + + The first rectangle to test. + The second rectangle to test. + This method returns true if there is any intersection. + + + + + + + + + + + + + Searches for the specified object and returns the index of + the first occurrence within the entire one-dimensional array. + + Array to search. + Value to locate in the array. + + The index of the first occurrence of value within the entire array, if found; + otherwise, -1. + + + + Searches for the specified object and returns the index of + the first occurrence within the entire one-dimensional array. + + Array to search. + Value to locate in the array. + + The index of the first occurrence of value within the entire array, if found; + otherwise, -1. + + + + Searches for the specified object and returns the index of + the first occurrence within the entire one-dimensional array. + + Array to search. + Value to locate in the array. + + The index of the first occurrence of value within the entire array, if found; + otherwise, -1. + + + + Converts DateTime into number. + + Value to convert. + Converted value. + + + + Converts number into DateTime. + + Number to convert. + Converted value. + + + + Creates new cell without adding it to the collection.. + + Zero-based row index of the cell to create. + Zero-based column index of the cell to create. + Record type. + Created cell. + + + + Removes first character from the string. + Warning: this method doesn't performs any argument check for performance purposes. + + Value to remove first character from. + Updated string. + + + + + + + + + + + + Gets maximum row and column count for specific version. + + + + + + + + Copies one stream into another. + + Source stream to copy from. + Destination stream to copy into. + + + + Creates copy of the MemoryStream. + + Source stream to copy. + A copy of the original MemoryStream. + + + + Creates xml reader to read data from the stream. + + Data to read. + Created xml reader. + + + + Creates a XmlReader from data stream. + + Data stream to create reader from. + Xml element tag to return the reader. + Newly created XmlReader from given stream. + + + + Clones and returns list of . + + list to clone. + copy of the input list of . + + + + Creates xml reader to read data from the current stream position. + + Data to read. + Created xml reader. + + + + Creates xml reader to read data from the stream. + + Data to read. + Created xml reader. + + + + Creates xml writer to read data from the stream. + + Data to read. + Created xml writer. + + + + Creates xml writer to read data from the stream. + + Data to read. + Created xml writer. + + + + Creates xml writer to read data from the stream. + + Data to read. + Created xml writer. + + + + This class contains information about Vertical Page Break. + + + + + Represents a vertical page break. The VPageBreak object is a member + of the VPageBreaks collection. + + + + + Used without an object qualifier, this property returns an + object that represents the Excel . + + The following code illustrates how to access the property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + //Get Page break with corresponding column + IVPageBreak vPageBrk = sheet.VPageBreaks.GetPageBreak(5); + + //property returns an Application object that represents the Microsoft Excel application + IApplication vPageBreakApplication = vPageBrk.Application; + + object vPageBreakParent = vPageBrk.Parent; + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + For the HPageBreak and VPageBreak objects, this property returns or + sets the cell (a Range object) that defines the page-break location. + Horizontal page breaks are aligned with the top edge of the location + cell; vertical page breaks are aligned with the left edge of the + location cell. Read / write . + + + To know more about page setting refer this link. + + The following code illustrates the use of Location property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + //Get Page break with corresponding column + IVPageBreak vPageBrk = sheet.VPageBreaks.GetPageBreak(5); + + //Get the IRange Location + IRange range = vPageBrk.Location; + + //Set the IRange Location + vPageBrk.Location = sheet.Range["F1:S10"]; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Returns the parent object for the specified object. + + The following code illustrates the use of Parent property. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create a worksheet. + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sample.xlsx"); + IWorksheet sheet = workbook.Worksheets[0]; + //Get Page break with corresponding row + IVPageBreak vPageBrk = sheet.VPageBreaks.GetPageBreak(5); + + //The parent object for the specified object + object vPageBreakParent = vPageBrk.Parent; + + workbook.SaveAs("PageSetup.xlsx"); + workbook.Close(); + } + + + + + + Record with vertical page break. + + + + + Type of the page break. + + + + + Represents worksheet. + + + + + Creates page break by application and parent objects. + + Application object for the page break. + Parent object for the page break. + + + + Creates page break by application, parent objects and reader. + + Application object for the page break. + Parent object for the page break. + Reader that contains page break record. + + + + Constructs page break by application, parent object, and TVPageBreak object. + Always creates manual page break. + + Application object for the page break. + Parent object for the page break. + Vertical page break. + + + + Initializes new instance of the vertical page break. + + Application object. + Parent object. + Page break location. + + + + Finds parent object. + + + + + Clones current instance. + + Parent for new instance. + A clone of the current instance. + + + + Location of the page break. + + + + + Type of the page break. + + + + + Gets / Sets vertical page break record. + + + + + Returns zero-based column index of the page break. Read-only. + + + + + Get the Macrosheet and IntlMacrosheet + + + + + Get the macrosheet and intlmacrosheet + + Name of the macrosheet and intlmacrosheet + The bool value is consider macrosheet or intlmacrosheet + + + + find the macrosheet or intlmacrosheet + + + + + stream of the macrosheet and intlmacrosheet + + + + + sheet name of the macrosheet and intlmacrosheet + + + + + dataholder of the macrosheet and intlmacrosheet + + + + + Summary description for WorkbookShapeDataImpl. + + + + + Array of blips that should be parsed by MsoMetafilePicture. + + + + + Contains all workbook's pictures. + + + + + Drawing group not parsed records. + + + + + Parent workbook. + + + + + Dictionary, key - image hash (ArrayWrapper), value - MsofbtBSE structure that describes + + + + + Shape getter. + + + + + Last used worksheet shapes collection id. + + + + + Dictionary blip type - to - Instance, RequiredMac, RequiredWin32, subrecord type values. + + + + + Indicates the image item path. + + + + + Preserved Clusters. + + + + + Indexed Pixel Types and not supported image format + + + + + Static constructor. + + + + + Initializes new instance. + + Application object for the new instance. + Parent object for the new instance. + Shape getter to use for retrieving shapes from worksheet. + + + + Searches for all necessary parent objects. + + + + + Parses drawing group record. + + Record to parse. + + + + Parses picture container. + + + + + Dispose + + + + + Serializes MsoDrawingGroupRecord if necessary. + + OffsetArrayList that will receive all records. + Record code for serialization. + + + + Serializes drawing group options. + + Options container. + + + + Serialize default options + + Options to serialize. + + + + Fills MsofbtDgg record. + + Record to fill. + Shape getter. + + + + Adds picture to the storage. + + Picture to add. + Desired image format. + Name of the picture. + Number of pictures after adding new picture (blip id). + + + + Adds picture to the storage. + + Picture to add. + Number of pictures after adding new picture.. + + + + Returns picture record. + + Picture index. + Picture record. + + + + Removes picture from this collection. + + Picture id to remove. + Indicates whether to remove image (not picture + shape) from workbook if we didn't detect any reference to it. + + + + Clears all internal data. + + + + + Creates a new object that is a copy of the current instance. + + Parent object for a copy of this instance. + A new object that is a copy of this instance. + + + + Registers new shapes collection. + + + + + + Clear preserved clusters + + + + + Converts image format into blip type. + + Format to convert. + Returns appropriate image format. + + + + Converts image format into blip type. + + Format to convert. + Desired image format. + + + + + Indicates whether blip is bitmap blip. + + Blip type to check. + True if specified blip is bitmap blip; False otherwise. + + + + Returns BlipParams for picture record. + + MsofbtBSE record to set fields. + BlipParams for picture record. + + + + Get or set the image item path + + + + + List with all pictures. Read-only. + + + + + Indicates whether this mso drawing group has to be serialized. + + + + + Contains information about different properties of image. + + + + + Instance property value. + + + + + ReqMac property value. + + + + + ReqWin32 property value. + + + + + SubRecordType property value. + + + + + + + + + + + + + + Represents worksheet custom property. + + + + + Represents single worksheet custom property. + + + + + Returns the name of the property. + + + + + Gets / sets value of the property. + + + + + Low level record. + + + + + Default constructor. + + + + + Creates new instance of the class. + + Name of the new property. + + + + Creates new instance of the class. + + Low level property data. + + + + Serializes property into list of Biff records. + + OffsetArrayList to serialize into. + + + + Creates a copy of the current object. + + A copy of the current object. + + + + Returns name of the property. Read-only. + + + + + Gets / sets value of the property. + + + + + Represents a worksheet in a workbook. + + + + + Default regular expression options. + + + + + Default character (for width measuring). + + + + + One degree in radians. + + + + + Maximum column width. + + + + + Width of the zero character. + + + + + Default size for the dictionary of ranges. + + + + + Default size of autofilter arrow width. + + + + + Represents indent width. + + + + + + Maximum OleDateValue + + + + + Represents the Carriage Return character. + + + + + Represents the Carriage new line character. + + + + + Represents the Comma character. + + + + + Microsoft Excel. + + + + + Default number format index for date. + + + + + Indicates whether the sheet is created using Addcopy method or not + + + + + Indicates whether this instance has Alernate Content. + + + + + Represents the RTFReader + + + + + Represents threaded comments collection + + + + + Contains the merged cells + + + + + Indicates whether the range contains conditional format or not. + + + + + Contains the named range names. + + + + + Gets the number of slicers present in the worksheet. + + + + + Indicate the shapes are able to copy for sorting + + + + + Stores a collection of merged region identifiers and their statuses. + + + + + Enables the calculation support. + + Enabling this method will initialize objects and retrieves calculated values of formulas in a worksheet. + + + + + Create and update named ranges + + + + + Update external formula. + + + + + Try to Get Identifier of given formula. + + External workbook. + Identifier to get. + Sheet index to get. + the boolean value, indicates whether the Identifier is updated + + + + Try to Get Identifier of given formula. + + Workbook. + Formula to updated. + the boolean value, indicates whether the formula is updated + + + + Checked whether the string is a cell range or not. + + workbook. + string to check. + True if the string is cell range, otherwise false + + + + Gets external worksheet index from the specified external workbook. + + worksheet name to search. + External workbook. + External worksheet index. + + + + Get external worksheet. + + + + + Disables the calculation support in this workbook and disposes of the associative objects. + + + + + Returns the formula string if the cell contains a formula, or the value if + the cell cantains anything other than a formula. + + The row of the cell. + The column of the cell. + The formula string or value. + + + + Gets the position of array record position of the cell. + + Input row + Input column + Height to be considered + Width to be considered + Returns Array Record Position + + + + Gets the position of array record position of the cell. + + Input row + Input column + Height to be considered + Width to be considered + Sheet reference to be considered + Returns Array Record Position + + + + Get the Formula value from the sheet with the given row and column + + input row + input column + the formula value from the cell + + + + Get array formula. + + input row + input column + It's true formula string to array formula, otherwise formula + Formula array ptg + formula string + + + + Sets the value of a cell. + + The value to be set. + The row of the cell. + The column of the cell. + + + + Not implemented. + + + + + Raises the event. + + The row of the change. + The column of the change. + The changed value. + + + + Array with autofilter record types. + + + + + Hyperlink regex pattern for url link. + + + + + Hyperlink regex pattern for mailto. + + + + + Collection of regex pattern and their hyperlink type. + + + + + Represents the slicers in the worksheet. + + + + + Represents the scenarios in the worksheet. + + + + + Represents the slicer caches + + + + + Represents the slicer cache id + + + + + Represents the pivot slicer cache id + + + + + Contains inserted rows for subtotal process. + + + + + Rows moved in subtotal process. + + + + + Contains formula for range + + + + + Represents to parse sheet on demand + + + + + Range that contains all used cells. + + + + + The dictionary holds a records objects, representing each cell. + Holds information about used cells only. + Key - cell index. + Value - corresponding BiffRecordRaw. + + + + + In the dictionary store, where ColumnIndex-to-ColumnInfoRecord. + Column Index is started from 1. + + + + + Indicates whether page breaks should be displayed. + + + + + Object that contains information about page setup, i.e. + paper size, paper orientation, footers, headers, etc. + + + + + Standard column width. + + + + + Object that contains all merged regions of the worksheet. + + + + + Array store containing all selection records. + + + + + + + + + + Collection of all names defined in the worksheet (like named ranges). + + + + + Type of the worksheet. + + + + + Indicates if values are preserved as strings. + + + + + Array of all records for autofilter. + + + + + SortedList with all NoteRecords. + + + + + Notes sorted by cell index, key - cell index, value - note record. + + + + + + + + + + Collection of all data validations in the worksheet. + + + + + Collection of worksheet's autofilters. + + + + + Collection of worksheet's pivot tables. + + + + + Collection of all hyperlinks in the current worksheet. + + + + + Contains all worksheet's sort records. + + + + + Start index for pivot table records. + + + + + Start index for hyperlinks records. + + + + + Start index for conditional formatting records. + + + + + Start index for data validation formatting records. + + + + + Start index of custom properties block. + + + + + DCon records. + + + + + List with all conditional format collections. + + + + + Collection of custom properties. + + + + + Migrant range - row and column of this range object can be changed by user. + + + + + Worksheet's index record. This member is used for parsing only. + + + + + There are two different algorithms to create UsedRange object: + 1) Default. This property = true. The cell is included into UsedRange when + it has some record created for it even if data is empty (maybe some formatting + changed, maybe not - cell was accessed and record was created). + 2) This property = false. In this case XlsIO tries to remove empty rows and + columns from all sides to make UsedRange smaller. + + + + + Indicates to include the CFRange in UsedRange. + + + + + Contains settings of string preservation for ranges. + + + + + Object used for shape coordinates evaluation on loading. + + + + + Represents collection of all list objects in the worksheet. + + + + + List with preserved table object's records. + + + + + To set Ishidden property + + + + + For Zeroheight attribute to enable or disable + + + + + Specifies the number of characters of the maximum digit width of the normal style's font. + + + + + 'True' if rows have a thick bottom border by default. + + + + + 'True' if rows have a thick top border by default. + + + + + Highest number of outline levels for columns in this sheet. + + + + + Default column width of sheet. + + + + + Highest number of outline level for rows in this sheet. + + + + + List of CondFMT records. + + + + + List of CFEx Records. + + + + + List of Outline Wrappers collection + + + + + Represents the Column group outline dictionary collection + + + + + Represents the row group outline dictionary collection + + + + + Indicates whether the merged cell has a wrapped text. + + + + + Represents the Collection of OleObject + + + + + Represents the Collection of SparklineGroups + + + + + Represents the Collection of InlineStrings + + + + + Preserves the External connection setting in the worksheet. + + + + + Preserves the pivot tables. + + + + + Stream to preserve the worksheet slicer + + + + + Represents the Data table export + + + + + Indicates whether the column is inserting in this worksheet. + + + + + Indicates whether the row is inserting in this worksheet. + + + + + Inserting row count in this worksheet. + + + + + Inserting row index in this worksheet. + + + + + Deleting row count in this worksheet. + + + + + Deleting row index in this worksheet. + + + + + Indicates whether the row is deleting in this worksheet. + + + + + Indicates whether the column is deleting in this worksheet. + + + + + + + + + + + returns true when the moverange is made along with updated CF range which is applied outside the UsedRange. + else returns false. + + + + + + + + Represent the Unsupported forumulas. + + + + + Indicates whether current process is subtotal. + + + + + Indicates whether existing subtotal removed. + + + + + Indicates whether subtotal applied worksheet contains array separated formula. + + + + + Represents default XF index. + + + + + Cell address list which to be merged while importing nested collection. + + + + + Range collection which to be merged while importing nested collection. + + + + + Denotes if the document has BaseColWidth property alone. + + + + + Represents collection of Cell Formulas + + + + + Represents collection of auto filter displaytexts + + + + + Slicer ext stream + + + + + Indicates whether the AutoFitPivotTable method is called. + + + + + Indicates whether importing data table for xml mapping. + + + + + Indicates pivot table. + + + + + Indicates pivot table range. + + + + + Static constructor. + + + + + Initializes a new instance of the Worksheet class with specified application and parent properties. + + Application object for the worksheet. + Parent object for the worksheet. + + + + Initializes a new instance of the Worksheet class with specified parsing option along with application and parent properties. + + Application object for the worksheet. + Parent object for the worksheet. + reader object for the worksheet data. + Parse options. + Indicates whether to skip the parsing of data or not. + + Dictionary with new extended format indexes used in ignore styles mode. + + Object used to decrypt encrypted records. + + + + Initializes all inner data such as Comments collection, + Page setup, etc. + + + + + Clear all internal collections. + + + + + Clear all internal collections but excluding mentioned flags. + + Allows to avoid clearing of some properties. + + + + //Updates the style index while copying from one workbook to another workbook. + + Worksheet + Dictionary with new indexes of extended formats. + + + + Copies names from another worksheet. + + Worksheet to copy names from. + Dictionary with new worksheet names. + Dictionary, key - old name index, value - new name index. + Represents hash table with new extern sheet indexes. + + + + Searches for all used named range objects. + + Dictionary where key means named range index. + + + + Change the reference index of name record . + + source workbook. + destination workbook. + Old name. + New name. + + + + Copies row height. + + Source worksheet. + Dictionary with new extended format indexes. + + + + Copies conditional formats. + + Base worksheet. + + + + Copies autofilters. + + Base worksheet. + + + + Copies data validations. + + Base worksheet. + + + + Copies column width. + + Source worksheet. + Array with new extended format indexes. + + + + Returns true if specified column index can be found inside list of columns with default width. + + List of columns with default width (sorted). + Start index in the list. + Column index to check. + True if specified column index can be found inside list if columns. + + + + Updates indexes of extended formats. + + Collection with IOutline elements that should be updated. + Source worksheet. + Dictionary with new extended format indexes. + + + + Updates indexes of extended formats. + + Collection with IOutline elements that should be updated. + Source worksheet. + Dictionary with new extended format indexes. + Indicates whether update default format index. + + + + Updates indexes of extended formats. + + Collection with IOutline elements that should be updated. + Array with new extended format indexes. + + + + Creates columns on update. + + Represents column collection. + Represents new XF indexes. + List of columns that had default column width and were create by this method. + Items in this list are placed in ascending order. + + + + Copies merged regions. + + Source worksheet. + + + + Binds the specified function to an event, so that the function gets called whenever the event fires on the object. + + + + + Unbinds the specified function from the event, so that the function stops receiving notifications when the event fires. + + + + + This method is called during dispose operation. + + + + + Copies page setup from another worksheet. + + Worksheet to copy from. + + + + Imports extended format from anther worksheet. + + Extended format to import. + Source workbook. + Dictionary key - old xf index, value - new xf index. + Index of the new format. + + + + Updates style indexes. + + Array with changed style indexes. + + + + Indicates whether to parseCF or not. + + + + + Clears all pivot tables. + + + + + Sorts the group. + + + + + Adds the outer level group into inner group. + + + + + Merge the group. + + + + + Updates outline levels for row storages in the worksheet. + + + + + Updates outline levels for column records in the worksheet. + + + + + Updates outline level for the specified row/column. + + Row/column index to be updated. + Outline level for the row/column. + Dictionary to store levels as key and corresponding group points as values. + + + + Updates row/column index in all existing group levels. + + Outline level for the row/column. + Row/column index to be updated. + Dictionary to store levels as key and corresponding group points as values. + + + + Gets the Range object that represents the used range on the specified worksheet + + True if UsedRange property is accessed + + + + + Set the standard with in parsing, it does not affect the DefaultColWidht member. + + Represents the Standard Width. + + + + Gets outline levels dictionary collection create outline wrapper collection + + + + + + + + Gets object that is clone of current worksheet in the specified workbook. + + Dictionary with update worksheet names. + New workbook object. + Object that is clone of the current worksheet. + + + + Parses Excel 2007 conditional formatting. + + Workbook file data holder. + + + + Parses worksheet conditional formats in Excel2007 version. + + + + + This method should be called immediately after extended format removal. + + Dictionary with updated extended formats. + + + + This method updates indexes to the extended formats after version change. + + New restriction for maximum possible XF index. + + + + Creates Rtf string for LabelSST record. + + Cell index. + Created rtf string. + + + + Returns found values or null. + + Storage range. + Value for finding. + If true - finds as error; otherwise as bool value. + If true - finds first value; otherwise - all values. + If findfirst - true then returns range; otherwise - array with all found values. + + + + Returns found values or null. + + Storage range. + Value for finding. + Finding flags. + If true - finds first value; otherwise - all values. + If findfirst - true then returns range; otherwise - array with all found values. + + + + Returns found values or null. + + Storage range. + Value for finding. + Range array with found values. + + + + Returns found values or null. + + Storage range. + Value for finding. + If true - finds first value; otherwise - all values. + If findfirst - true then returns range; otherwise - array with all found values. + Range array with found values. + + + + Returns found values or null. + + Storage range. + Value for finding. + If true - finds first value; otherwise - all values. + If findfirst - true then returns range; otherwise - array with all found values. + Range array with found values. + + + + Finds the specified value in the comments of the worksheet. + + Value to search. + The find options based on which search is made. + All found cells containing the comment, or Null if value not found. + + + + Copies worksheet data to the clipboard. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Moves range to new position. + + Destination range. + Source range. + Move options. + + Indicates whether row information such as row height, default style, etc. + must be copied from cache. + + + When source and destination ranges have different sizes. + + + + + moves range to new range with proper updation of CF Range + + Destination range. + Source range. + Move options. + Indicates whether row information such as row height, default style, etc. must be copied from cache. + Represents before move operation. + updated Destination range when CF applied outside usedRange. + updated Source range when CF applied outside usedRange. + + + + Moves range to new position. + + Destination range. + Source range. + Move options. + + Indicates whether row information such as row height, default style, etc. + must be copied from cache. + + Represents before move operation. + + When source and destination ranges have different sizes. + + + + + Moves the table or pivot table to its destination. + + Destination range. + Source range. + Move options. + + + + Checks whether the pivot object range is overlap with another pivot table or table in destination range. + + Destination sheet. + Index of pivot table. + pivot table to be paste in destination range. + + + + Checks whether the list object range is overlap with another table or pivot table in destination range. + + Destination sheet. + Index of table. + Table to be paste in destination range. + + + + Checks whether the given object is overlap in destination range. + + Range in which the IListObject or pivot table object is present. + Index of table or table. + Pivot table or table. + + + + Creates a table range for pasting the table + + List Objects index. + Destination sheet. + Destination range. + Source range. + Table range. + Range for creating table. + + + + Copies range from one range into another with formulas update. + + Destination range. + Source range. + Range into which source was copied. + + + + Copies range from one range into another with paste link options. + + Destination range. + Source range. + Implement pasteLinkoption or not. + Range into which source was copied. + + + + + Copy Values from source range to destination range + + source range worksheet + destination range worksheet + source range row + source range column + destination range row + destination range column + + + + Copies range from one range into another. + + Destination range. + Source range. + Copy options. + Range into which source was copied. + + + + Copies range from one range into another. + + Destination range. + Source range. + Copy options. + Range into which source was copied. + + + + Update the row and column. + + Source range + destination range + True if soure range isEntireColumn, otherwise fasle. + + + + Checks if destination range for paste value has table with header on. + + Destination range for paste value. + Returns table object which has its header in the specified range. + + + + Checks if destination range is table range or not. + + Destination range for paste value. + Returns table object which is intersect with destination range. + + + + Checks if destination range is table range or not. + + Destination range for paste value. + Returns table object which is intersect with destination range. + + + + Checks if destination range is table range or not. + + Destination range for paste value. + Returns table object which is intersect with destination range. + + + + Checks if destination range is entire table range or not. + + Source range of value. + Returns table object with source range. + + + + Copies range without checking range sizes. + + Source range to copy. + Destination range. + Copy options. + + + + Check whether the given named range name is exist in the range. + + Range need to be checked + Named range name + boolean + + + + Copies range without checking range sizes. + + Source range to copy. + Destination range. + Copy options. + A boolean variable indicating if conditional format copy is in progress. + + + + Update the table columns. + + The table to add columns. + Column count to add. + + + + Update the table rows. + + The table to add Rows. + Row count to add. + + + + Get named range names from formula. + + The range. + returns the list of named range names in given range. + + + + Copy sparklines from source range to destination. + + Source range. + Destination range. + Destination worksheet. + Represents is move SparkLines. + + + + Get spaklines from range. + + The Range. + returns list of sparklines from given range. + + + + Removes existing comments from destination range. + + Destination worksheet. + Destination range rectange. + + + + Update the range from merged region. + + Range. + returns the updated range from merged region. + + + + Copies or moves data validations. + + Represents source row index. + Represents source column index. + Represents row count. + Represents column count. + Represents destination row index. + Represents destination column index. + Represents destination sheet. + Represents is move data validations. + + + + Copies or moves conditional formats. + + Represents source row index. + Represents source column index. + Represents row count. + Represents column count. + Represents destination row index. + Represents destination column index. + Represents destination sheet. + Represents is move conditional formats. + + + + Updates priority for the newly copied format and already exixting formats in the destination. + + The destination worksheet for conditional formats. + The formats to be copied to destination worksheet. + A boolean variable indicating if the entire destination range is copied. + + + + Copies the multi cell's CF into single CF. + + Represents formats of destination Sheet. + Represents the destination range. + Represents destination sheet's CF count. + Represents destination sheet. + Represents destination sheet's conditional formats. + + + + Copies or moves Hyperlinks. + + Represents source row index. + Represents source column index. + Represents row count. + Represents column count. + Represents destination row index. + Represents destination column index. + Represents destination sheet. + Represents is move Hyperlinks. + + + + Copies or moves Hyperlinks. + + Represents source row index. + Represents source column index. + Represents destination row index. + Represents destination column index. + Represents destination sheet. + Represents source used range. + Represents destination used range. + Represents destination migrant range. + Represents is move Hyperlinks. + Represents the current row. + Represents the current column. + + + + Remove the Hyperlink from the specific range. + + + + + + Copies or move error indicators. + + Represents source row index. + Represents source column index. + Represents row count. + Represents column count. + Represents destination row index. + Represents destination column index. + Represents destination sheet. + Represents is move error indicators. + + + + Copies cell into another worksheet. + + Cell to copy. + Formula string value of the cell. + + Dictionary with updated extended format indexes, + or Null if indexes were not updated. + + New cell index + Source workbook. + + Dictionary with updated font indexes or Null if indexes were not updated. + + Copy options. + + + + Copies cell into another worksheet. + + Cell to copy. + Formula string value of the cell. + + Dictionary with updated extended format indexes, + or Null if indexes were not updated. + + New cell index + Source workbook. + + Dictionary with updated font indexes or Null if indexes were not updated. + + Copy options. + Source sheet to copy from. + Skip blank cells from being copied to destination. + + + + Copies cells from one range into another. + + One-based index of the source row. + One-based index of the source column. + Number of rows to copy. + Number of columns to copy. + One-based index of the destination row. + One-based index of the destination column. + Destination worksheet. + DictionaryEntry with records and strings intersection part. + Rectangle with intersection information. + Copy options. + + + + Copies cells from one range into another. + + One-based index of the source row. + One-based index of the source column. + Number of rows to copy. + Number of columns to copy. + One-based index of the destination row. + One-based index of the destination column. + Destination worksheet. + DictionaryEntry with records and strings intersection part. + Rectangle with intersection information. + Copy options. + A boolean variable indicating if conditional format copy is in progress. + True, if source range is entire row or column, otherwise fasle. + + + + Removes all formulas in colRemove from internal ArrayFormula collection. + + Formulas to remove. + Indicates whether to clear range before remove operation. + + + + Updates formulas after copy operation. + + Formula to update. + Row offset. + Column offset. + + + + + Updates formulas after copy operation. + + Current worksheet index. + Source worksheet index. + Source rectangle. + Destination worksheet index. + Destination rectangle. + + + + Changes the height of the specified row to achieve the best fit. + + This method is supported on Windows Forms, WPF, ASP.NET, ASP.NET MVC, WinRT, Windows Phone, Universal, UWP, Xamarin and NetStandard platforms only. + Row Index + + + + Changes the width of the specified column to achieve the best fit. + + This method is supported on Windows Forms, WPF, ASP.NET, ASP.NET MVC, WinRT, Windows Phone, Universal, UWP, Xamarin and NetStandard platforms only. + Column index. + + + + Autofits column by checking only the cells in the column that are specified by row range + + This method is supported on Windows Forms, WPF, ASP.NET, ASP.NET MVC, WinRT, Windows Phone, Universal, UWP, Xamarin and NetStandard platforms only. + Column index. + One-based index of the first row to be used for autofit operation. + One-based index of the last row to be used for autofit operation. + + + + Copies all data from another worksheet. + + Parent worksheet. + Dictionary with style names. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Copy flags. + + + + Copies all data from another worksheet. + + Parent worksheet. + Dictionary with style names. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Copy flags. + + Dictionary with new extended format indexes. + + Dictionary with new name indexes. + + + + Copies all data from another worksheet. + + Parent worksheet. + Dictionary with style names. + Dictionary with new worksheet names. + Dictionary with new font indexes. + Copy flags. + + Dictionary with new extended format indexes. + + Dictionary with new name indexes. + Represents collection with extern sheets indexes. + + + + Copies all pivot table objects. + + Worksheet to copy pivot table objects from. + + + + Copies all table objects. + + Worksheet to copy table objects from. + + + + Update CalculatedFormula and TotalsCalculation + + Copied table object collection. + Source of copied table object collection. + + + + + Update the table formula in cells + + + + + + Change the table named range Ptg. + + The source workbook. + The destination workbook. + Named range to change. + Cell formula ptg array. + + + + Change the table named range Ptg. + + The source workbook. + The destination workbook. + Named range to change. + Cell formula ptg array. + + + + Create external workbook for the formula. + + The source workbook. + The destination workbook. + The destination worksheet. + Cell formula array. + + + + Copies error indicators. + + Represents source error indicators. + + + + Copies hyperlinks. + + Source hyperlink collection. + + + + Indicates whether source range can be moved into new location. + + Destination range. + Source range. + True if source range can be moved. + + + + Checks whether it is possible insert row into iRowIndex. + + Index of row to insert. + Number of rows to insert. + Insert options. + True if it is possible to insert row. + + + + Checks whether it is possible to insert column into iRowIndex. + + Index of column to insert. + Number of columns to insert. + Insert options. + True if it is possible to insert column. + + + + Gets range from string value. + + Range value represented in string. + boolean value indicates whether the formula in the input + Extracted Range. + + + + Check whether the string conatins in the error values + + input computed value from calculate base + the list of error strings + the list of formula error strings + the boolean value indicates whether the string is in the list + + + + Check and set the OFFSET function with required parameters + + input formula util class for ptg array + input ptg array + input formula + output formula + + + + Updates indexes to named ranges. + + New indexes. + + + + Updates indexes to named ranges. + + New indexes. + + + + Returns string index of the specified cell. + + Cell index to locate. + String index of the specified cell. + + + + Returns TextWithFormat object corresponding to the specified cell. + + Cell index. + TextWithFormat object corresponding to the specified cell. + + + + Returns TextWithFormat object corresponding to the specified cell. + + Cell index. + Object corresponding to the specified cell. + + + + Returns extended format for specified cell. + + Cell index. + Extended format for specified cell. + + + + Returns extended format for specified cell. + + Cell range + Extended format for specified cell. + + + + Sets string index in the specified cell. + + Cell index to set sst index in. + SST index to set. + + + + Updates string indexes. + + List with new indexes. + + + + Removes merged cells. + + Represent range of merged cells. + + + + Sets active cell + + Cell to activate. + + + + Sets active cell + + Cell to activate. + + + + Gets or sets index of the active pane. + + + + + Gets selection with active cell. + + + + + + Returns active cell. + + Currently active cell. + + + + Tells whether specific FormulaRecord is array-entered formula. + + FormulaRecord to check. + True if it is array-entered formula. + + + + Returns true if the formula record is a array record. + + + + + + + + + Indicates whether cell contains array-entered formula. + + Cell index to check. + True if cell contains array-entered formula. + + + + Returns height from RowRecord if there is a corresponding RowRecord. + Otherwise returns StandardHeight. + + One-based index of the row + Indicates whether to raise events on row autofitting. + + Height from RowRecord if there is corresponding RowRecord. + Otherwise returns StandardHeight. + + + + + Returns height from RowRecord if there is a corresponding RowRecord. + Otherwise returns StandardHeight. + + One-based index of the row + Indicates whether to raise events on row autofitting. + + Height from RowRecord if there is corresponding RowRecord. + Otherwise returns StandardHeight. + + + + + Creates copy of the current object and indicates whether we should copy the shapes or not. + + Parent object for the new object. + Indicates whether we should clone shapes or not. + Copy of the current object. + + + + Looks through all records and calls AddIncrease for each LabelSST record. + + + + + Gets string preservation option for the range. + + Range to get value for. + True if strings are preserved for all cells of the range, + false - if it is not preserved, + null - undefined or different cells have different values. + + + + Sets value indicating whether string should be preserved for range. + + Range to set value for. + Value to set. + + + + Sets items with used reference indexes to true. + + Array to mark used references in. + + + + Updates reference indexes. + + Array with updated indexes. + + + + Creates default pane. + + + + + Copies cell value from sourceCell into destCell. + DOES NOT COPY FORMULAARRAYS (THIS SHOULD BE DONE IN DIFFERENT PLACE). + + Destination cell. + Source cell. + + + + Copies cell value from sourceCell into destCell. + DOES NOT COPY FORMULAARRAYS (THIS SHOULD BE DONE IN DIFFERENT PLACE). + + Destination cell. + Source cell. + Options for coping. + + + + Updates the hyperlinks. + + The source. + The dest. + + + + Gets the column count. + + The source. + The dest. + + + + + Gets the row count. + + The source. + The dest. + + + + + Copies comment from one cell into another. + + Source cell. + Destination cell. + + + + Removes last row from the worksheet. + + Indicates whether to update formulas after row remove. + + + + Removes required number of last rows from the worksheet. + + Indicates whether to update formulas after row remove. + Number of rows to remove. + + + + Removes last column from the worksheet. + + Indicates whether update formulas after removing. + + + + Removes last column from the worksheet. + + Indicates whether update formulas after removing. + Number of columns to remove. + + + + Partially clears cells if necessary. + + Range to clear. + + + + Caches cells from the source range and removes them from it. + + Source range. + Destination range. + Maximum row after moving into destination range. + Maximum column after moving into destination range. + Source records collection. + Boolean flag to indicate if a row is moved or inserted. + Returns hashtable (index-RangeImpl) with all cached cells. + + + + Copies source dictionary into destination. + + Source table. + Destination table. + + Indicates whether row information such as row height, default style, etc. + must be copied from cache. + + + + + Clears range in the dictionary that corresponds to the specified range. + + Dictionary to clear. + Rectangle to clear. + + + + Updates formula array after copy range operation. + + ArrayRecord to update. + Destination worksheet. + Row difference. + Column difference. + + + + Returns record table that should contain cell information. + + One-based row index of the cell. + One-based column index of the cell. + Intersection rectangle. + RecordTable with intersection data. + Another RecordTable that contains cell that are not included into intersection. + RecordTable that should contain cell information. + + + + Adds all necessary styles into collection. + + Start row of the range to copy styles from. + Start column of the range to copy styles from. + Number of rows in the range. + Number of columns in the range. + Destination worksheet. + Dictionary that will get updated indexes. + Dictionary with updated extended format indexes + + + + Clear specified cell. + + Cell to clear. + + + + Sets range values accordingly to an ArrayRecord. + + ArrayRecord that has cells values. + + + + Removes all formulas in colRemove from internal ArrayFormula collection. + + Formula to remove. + Indicates whether to clear range before remove operation. + + + + Creates new ArrayFormula based on specified ArrayFormula. + Used in copy and move range operations. + + Source ArrayFormula. + Destination range. + Source range. + Row (IN THE SOURCE range) of the array formula. + Column (IN THE SOURCE range) of the array formula. + Indicates whether to update formulas. + New array formula. + + + + Checks the source snd destination ranges + + Destination range. + Source Range. + + + + Copies merged regions. + + Destination range. + Source range. + + + + Copies merged regions. + + Destination range. + Source range. + Indicates whether to delete source merges after copy. + + + + Returns note record by object index. + + Object index to find NoteRecord for. + Corresponding NoteRecord, or Null if not found. + + + + Adds note + + Specifies a comment associated with a particular cell + + + + Autofits row by checking only the cells in the row that are specified by column range + + This method is supported on Windows Forms, WPF, ASP.NET, ASP.NET MVC, WinRT, Windows Phone, Universal, UWP, Xamarin and NetStandard platforms only. + Row index. + One-based index of the first column to be used for autofit operation. + One-based index of the last column to be used for autofit operation. + If true then raise events. + + + + Sets inner row height. + + Row index. + Value to set. + If true then bad row height. + Current units. + if true then raise events. + + + + Returns True if row is empty;Checking only for styles. + + One-based row index to check. + True if row is empty. + + + + Returns True if row is empty + + One-based row index to check. + If true - checking for styles and value, otherwise - for value only. + True if row is empty. + + + + Returns True if column is empty. + + One-based column index to check. + True if column is empty. + + + + Indicate if column is empty. + + One-based Column index. + If true - ignore styles. + If true - column is empty. + + + + Parses Range. + + Current Range. + String where parsing is. + Current separator. + Current index of parsing string. + Index of parsed range. + + + + Gets size of string that contain cell found by cellindex. + + Cell to measure. + If true then autofit Rows, otherwise - columns. + Indicates whether rotation must be ignored. + Returns new size of string. + + + + Gets size of string that contain cell found by cellindex. + + Cell index to Autofit. + If true then autofit Rows, otherwise - columns. + Indicates whether rotation must be ignored. + Returns new size of string. + + + + Gets size of string that contain cell found by cellindex. + + Cell index to Autofit. + If true then autofit Rows, otherwise - columns. + RichTextString object to use for text measuring - + to reduce time and memory consumption. + Indicates whether rotation must be ignored. + Returns new size of string. + + + + Updates indent size. + + Represents current size. + Represents extended format. + Returns updated size by indent value. + + + + Updates text width by rotation. + + String size without rotation. + Current rotation. + If true then update height otherwise - width. + Updated width or height. + + + + Gets font by extended format index. + + Record that contain extended format index. + Represents the rotation. Out Parameter. + Returns font, rotation by extended format. + + + + Copies different sheet options. + + Source sheet. + + + + This method is called after RealIndex property change. + + Old value. + + + + This method is called after insert row or column operation is complete + and it fires event handlers if necessary. + + Row or column index to insert at. + Number of inserted rows or columns. + Indicates whether rows were inserted. + + + + Updates fit size by autofilter arrow. + + Represents current size. + Represents extended format. + Represents cell records collection. + Represents cell index. + Returns new size, that contain size of arrow. + + + + Updates size for general alignment for autofilter arrow. + + Represents current size. + Represents rotation. + Represents cells collection. + Represents cell index. + Returns updated size. + + + + Creates migrant range. + + + + + Returns default outline style. + + Dictionary with outlines. + Outline index. + Extracted outline style. + + + + Sets row or column default style. + + Row or column index. + End row or column index. + Style to set. + Collection of outlines that contains style info. + Delegate used for outline creation. + Indicates is in row or column. + XF index that was set. + + + + Sets row or column default style. + + Row or column index. + End row or column index. + Style to set. + Collection of outlines that contains style info. + Delegate used for outline creation. + Indicates is in row or column. + XF index that was set. + + + + Converts style object into XF index that can be assigned to cell or ColumnInfo, Row records. + + Style to convert. + Converted style. + + + + Creates new column record. + + Column index to create record for. + Created row. + + + + Copies conditional formats after row/column insert. + + Row/column index. + Rows/columns count. + Excel insert option. + True if row was inserted, false if column was inserted. + + + + Copies style from above/below/left/right after insert row/column operation. + + Index where insert operation took place. + Number of inserted rows/columns. + Insert options. + Indicates whether rows where inserted. + + + + Copies row and column settings + + Represents source row. + Represents source column. + Represents row or column + Source index + Current index + Insert option + + + + Calculates row or column index from which style must be copied + into inserted area. + + Row or column index whether insert operation was called. + Number of rows/columns to insert. + Insert options. + Update row or column index. + + + + Returns format type for specified column. + + One-based row index for exported cell. + One-based column index for exported cell. + Indicates whether to use default style. + Format type for specified column. + + + + Returns type of the elements based on format type. + + Format type that must be converted into System.Type. + Represents cell's row index. + Represents cell's column index. + Represents maximum numbre of rows to export. + Export options. + Type of the elements based on format type. + + + + Returns type of the elements based on format type. + + Export type that must be converted into System.Type. + Type of the elements based on format type. + + + + Returns cell value. + + One-based row index of the cell to get value from. + One-based column index of the cell to get value from. + Format type. + Indicates whether to export formula values. + Cell value. + + + + Get the formula value. + + Row index + Column index + formula value + + + + Gets value from the cell record. + + Cell to get value from. + String representation of the cell's value. + + + + Updates dictionary with outlines after extended format removal. + + Dictionary to update. + Dictionary with updated extended formats. + + + + Converts minute and seconds to hour. + + + + + + + + Convert seconds into minute and minutes into hour. + + + + + + + + Converts list of cell indexes into ranges array. + + List of cell indexes. + Array with ranges. + + + + Finds value for number. + + Record that represents current cell. + Value for find. + If true - find as number. + If true find as formula value. + Returns cell or null. + + + + Finds bool or error. + + BoolError record that represents current cell. + Value to find. + If true - finds error; otherwise bool + Returns cell or null. + + + + Returns Range which represents specified cell. + + Column index of the cell. + Row index of the cell. + Range which represents specified cell. + + + + Returns Range which represents specified cell. + + Column index of the cell. + Row index of the cell. + Index to extended format for new range. + Range which represents specified cell. + + + + Returns Range which represents specified cell. + + Column index of the cell. + Row index of the cell. + Index to extended format for new range. + Range which represents specified cell. + + + + Converts biff record into range. + + Record to convert. + Created range. + + + + Updates first cell and last cell if necessary. + + Row index. + Column index. + + + + Sets Range which represents specified cell. + + Column index of the cell. + Row index of the cell. + Range which represents specified cell. + + + + Sets cell value. + + Cell index. + Record to set into cell. + + + + Sets cell value. + + One-based column index. + One-based row index. + Record to set into cell. + + + + Returns dimensions of the worksheet. + + Variable that receives index of the first used column. + Variable that receives index of the first used row. + Variable that receives index of the last used column. + Variable that receives index of the last used row. + + + + Calculates dimensions of the specified column. + + Column dimension of which will be calculated. + + Variable that will receive first used row in the specified column. + + + Variable that will receive last used row in the specified column. + + + + + Updates LabelSST indexes after SST record parsing. + + Dictionary with indexes to update, key - old index, value - new index. + + + + Insert into columns. + + Represents column index. + Represents number of columns to be inserted. + Represents insert options. + + + + Remove from column. + + Represents column index. + Represents number of columns to remove. + Insert Options + + + + Updates coordinates for used range, by removing empty rows and columns if necessary. + + First row to start looking from. + First column to start looking from. + Last row to finish looking at. + Last column to finish looking at. + + + + Checks whether row is empty. + + Row index to check. + True if the whole row is empty. + + + + Checks whether column is empty. + + Column index to check. + True if the whole column is empty. + + + + Creates used range. + + Represents first row of the range. + Represents first column of the range. + Represents last row of the range. + Represents last column of the range. + + + + Prepares protection options before setting protection. + + + + + + + Show/hide a row by checking/changing the property HiddenByFilters + + row index the that need to show or hide + Filter applied column + TRUE - show row, FALSE - hide row. + + + + Check the given range's formula is refer to single cell + + index of the row + index of the column + the boolean value indicates whether is refer to single cell + + + + Method extracts biff records belonging to the worksheet. + + BiffReader that contains worksheet's records. + Object used to decrypt encrypted records. + + + + Prepares variables to worksheet parsing. + + + + + Parses single record. + + Record to parse. + Indicates whether to ignore styles information. + Dictionary with new extended format index. + + + + Parses error indicators. + + Represents + + + + Updates duplicated name indexes. + + Represents formula. + + + + Returns new index of the extended format in ignore styles mode. + + Old extended format index. + Dictionary with new extended format indexes. + New index of the extended format. + + + + Method opens excel file using separator. + + Stream to reading. + Denotes separator for the CSV file types. + First row to write. + First column to write. + boolen value for the valid document + + + + Read single cell value plus ending separator or new line character if present. + + Read to get data from. + Separator between cell values. + Builder to store temporary results. + Boolean value for the Valid Document. + Extracted cell value. + + + + Checks whether data inside specified string builder ends with specified string. + + Builder to check. + Separator to locate. + True if it ends with specified value. + + + + Read data from reader until it find specified character. + + Reader to read data from. + Character to locate. + Builder to put extracted data into. + BoolenValue for the ValidDocument. + + + + Calculates number of specified character in the specified string. /// + Value to check. + Character to count. + Number of found characters. + + + + Parse binary data. + + SST dictionary + Xlsb Data holder + + + + Parses worksheet's data. + + + + + Replaces all shared formula with ordinary formula. + + + + + Parses ColumnInfo record. + + Record to parse. + Indicates whether we should ignore styles settings. + + + + Parses row record. + + Record to parse. + Indicates whether we should ignore styles settings. + + + + Parses The DefaultColumnWidth record. + + Record to parse. + + + + Extracts hyperlinks from internal array of biff records. + + + Index to the first hyperlink in the array of biff records, + less then zero if there are no hyperlinks. + + + + + Extracts calculation options. + + Position in the records array after extraction. + + + + Extracts page setup from biff records array + + Start index of the first pagesetup record. + + + + Extracts conditional formats from biff records array + + Position of the first conditional format + + + + Extracts data validation data from internal records array. + + Position of the first data validation record. + + + + Extracts custom properties from the records array. + + Position of the first custom property record. + + + + Creates collection of conditional formats. + + Record that describes formats collection. + + Conditional formats that will be inserted into the collection. + + + + + Creates collection of conditional formats. + + Record that describes formats collection. + + Conditional formats that will be inserted into the collection. + + + + + Returns width from ColumnInfoRecord if there is corresponding ColumnInfoRecord + or StandardWidth if not. + + One-based index of the column. + Width of the specified column. + + + + Converts the specified column width from points to pixels. + + Width in points. + Column width in pixels. + + + + Converts the specified column width from points to pixels in double. + + + + + + + Converts the specified column width from pixels to points. + + Width in pixels. + Width in points. + + + + Filters or copies data from a list based on a criteria range.. + + Whether filter in the place or copy to another place. + The filter range. + The criteria range. + The destination range for the copied rows if ExcelFilterAction is FilterCopy. Otherwise, this argument is ignored. + True to filter unique records; Otherwise filters all the records that meet the criteria. The default value is False. + + + + returns the cloned ptg array from input ptg array + + input ptg array + the cloned ptg array + + + + Read the input ptg and checks whether its valid. + If replace enabled, replace with the current row passed + + input ptg array + filter range to be filtered + boolean value indicates whether the row needs to be replaced + output ptg replaced + the current row to be replaced + the boolean value teh range is valid to be filtered + + + + Check whether the input value is match with the criteria value + + criteria value + input condition to be checked + input filter value + the boolean value, indicates whether the condition satisfied or not + + + + From the input criteria Cell value creates the regex + + input criteria Cell value + condition used + the regex needed + + + + Check with input criteria value and filtering value with the conditions + + input criteria value + input condition + input filter value + input criteria type + input filter value type + + + + + Extracts the comparision operators from the string + + input string value + output string value + the comparision operator from input string + + + + Get text based on cell type. + + Row + Column + + + + + Try to Get intersection range of given names. + + cell range string or named range string + intersection range to be got + the boolean value, indicates whether the given ranges are intersected or not + + + + Check if the string is entire range or not. + + Range string to be checked + The boolean value, indicates whether the given string is entire range + + + + Try to Get intersection range of external ranges. + + External cell range string or named range string + intersection range to be got + the boolean value, indicates whether the given ranges are intersected or not + + + + Add worksheet name to range address. + + range address + range address with sheet name + + + + Get the intersection range. + + named range collection + range address array + intersection range + + + + Returns width displayed by Excel. + + Width written in file. + Width displayed by Excel. + + + + Converts width displayed by Excel to width that should be written into file. + + Width displayed by Excel. + width written into file. + + + + Handler for NameIndexChanged event. + + Event sender. + Event arguments. + + + + Attaches events to Named ranges used in array-entered formulas. + + + + + Attaches events to Named ranges used in array-entered formulas. + + Start index of named ranges. + + + + Parses autofilters. + + + + + Extracts pivot tables from records array. + + Index to the first pivot table record. + + + + Returns record at specified cell index. + + Record's cell index. + Record at specified cell index. + + + + Returns record at specified cell index. + + One-based row index. + One-based column index. + Record at specified cell index. + + + + Extracts next record from reader and parses it. + + Reader to extract record from. + Number of BOF records without closing EOF record. + Indicates whether styles information must be skipped. + Parsing options. + + Dictionary with new extended format indexes for ignore styles mode. + + Object that decrypts data if necessary. + Updated number of BOF records without closing EOF record. + + + + Parses dimensions record. + + Record to parse. + + + + Sets cell at which panes are frozen. + + + + + Creates all necessary selection records. + + + + + Re-indexes selection records. + + Dictionary with currently used selection indexes. + + + + Tries to add next pane index if necessary. + + Dictionary with pane indexes that must be present in the file. + Panes that are absent. + Indexes that are currently present. + Pane index to add. + + + + Gets free index for the selection. + + Start index to try. + Dictionary with used indexes. + Unused index that can be used as pane index. + + + + Clears the worksheet data, formats and merged cells. + + + + + Clears all data. + + + + + Clears the worksheet data. + + + + + Checks whether the specified cell is initialized or accessed. + + One-based row index of the cell. + One-based column index of the cell. + True if the cell was initialized or accessed by the user; otherwise False. + + + + Creates a new instance of the . + + New instance of ranges collection. + + + + Creates a named ranges with the specified named range's value as a name for the specified range. + + Existing named ranged. + Address of the named range to be created. + True if the named range values are vertically placed in the sheet. + This method is used to create named ranges from the discontinuous ranges. + + + + Applying the conidtional formats to the given range. + + The range to apply CF. If range is Null then the conditional formats will be applied for entire worksheet. + SortedList containing ExtendedFormats for each cell within the Conditional Format range. + + + + Apply Conditional Formatting to the entire worksheet. + + Returns a sortedlist containing ExtendedFormats for all the cells within the Conditonal Format range. + + + + From Range Address string the Rectangle bounds calculated and returned. + + input the Range address string + output rectangle bounds + + + + Create an instance of that can be used for template markers processing. + + Object that can be used for template markers processing. + + + + Shows the specified column. + + Index at which the column should be hidden. + True - Column is visible; False - hidden. + + + + Hides the specified column. + + One-based column index. + + + + Hides the specified row. + + One-based row index. + + + + Shows or Hides the specified row. + + Index at which the row should be hidden. + True - Row is visible; False - hidden. + + + + Show/hide a row by checking/changing the property HiddenByFilters + + row index the that need to show or hide + Filter applied column + TRUE - show row, FALSE - hide row. + + + + Shows or Hides the specified range. + + Range specifies the particular range to show / hide. + True - Row is visible; False - hidden. + + + + Shows or Hides the collection of range. + + Ranges specifies the range collection. + True - Row is visible; false - hidden. + + + + Shows or Hides an array of range. + + Ranges specifies the range array. + True - Row is visible; False - hidden. + + + + Returns True if the specified column is visible to end user. + + One-based column index. + True if column is visible; otherwise, False. + + + + Returns True if the specified row is visible to end user. + + One-based row index. + True if row is visible; otherwise, False. + + + + Inserts an empty row in the specified row index. + + Index at which new row should be inserted. + + + + Inserts an empty rows in the specified row index based on row count. + + Index at which new row should be inserted. + Number of rows to insert. + + + + Inserts an empty row in the specified row index with specified based on row count. + + Index at which new row should be inserted. + Number of rows to insert. + Insert options. + + + + Updates the calcualted formula for newly created row inside a table. + + Index at which new row in which calculated formula is to be updated + Parent table + + + + Updates the new calculated column formula with respect to newly created table name + + Calculated formula which has to be updated + Name for updating in calculated formula + Updated calculated column formula + + + + Updates rowoutline level for newly inserted row if the included range is grouped. + + Index at which new row should be inserted. + Number of rows to insert + + + + Inserts an empty column for the specified column index. + + Index at which new column should be inserted. + + + + Inserts an empty column in the specified column index based on column count. + + Index at which new column should be inserted. + Number of columns to insert. + + + + Inserts an empty column with default formatting with specified Inserting options. + + Index at which new column should be inserted + Number of columns to insert. + Insert options. + + + + Updates rowoutline level for newly inserted column if its included range is grouped. + + Index at which new column should be inserted. + Number of columns to insert. + + + + Moves DataValidation of the succeeding cells + + Row / Column to start with + Toggles between insertion of Row or Column + + + + Update data validation object based on insert options. + + Index where row or column was (were) inserted. + Number of inserted rows/columns. + Insert options. + Indicates whether rows were inserted. + + + + Removes specified row (with formula update). + + One-based row index to remove + + + + Removes the specified number of rows from the given index(with formula update). + + One-based row index to remove + Number of rows to delete. + + + + Copies row. + + Zero-based destination row index. + Zero-based source row index. + + + + Removes the specified column. + + One-based column index. + + + + Removes the specified number of columns from the given index. + + One-based column index. + Number of columns to remove. + + + + range of the conditional formats which are applied out of used range is obtained. + + first row of the sheet which contains CF if applied,else the actual usedrange first row + first Column of the sheet which contains CF if applied,else the actual usedrange first column + last row of the sheet which contains CF if applied,else the actual usedrange last row + last column of the sheet which contains CF if applied,else the actual usedrange last column + + + + Returns the width of the specified column in pixels. + + One-based column index. + Width in pixels of the specified column. + + + + Returns width of the specified column in pixels. + + One-based index of the column. + Width in pixels of the specified column. + Otherwise it returns the StandardHeight + + + + Returns width of the specified column in pixels in double value. + + + + + + + + Returns width of the specified hidden column in pixels. + + One-based index of the column. + Width of the specified hidden column in pixels. + + + + Returns height of the specified hidden row in pixels. + + One-based index of the row. + Height of the specified hidden row in pixels. + + + + Returns the height of the specified row. + + Otherwise it gets the StandardHeight + One-based row index. + + Returns height of the specified row. + Otherwise returns StandardHeight. + + + + + Returns the height of the specified row in pixels. + + Otherwise it gets the StandardHeight in pixels + One-based row index. + + Returns height of the specified row in pixels. + Otherwise returns StandardHeight. + + + + + Returns height of the specified row in pixels in Double value. + + + + + + + Return the total column width in pixels from the given column limit + + First column of the sheet + Last column of the sheet + the total column width in pixels + + + + Return the total row height in pixels from the given row limit + + First row of the sheet + Last row of the sheet + the total row height in pixels + + + + Imports an array of objects into a worksheet with specified alignment. + + Array to import. + + Row of the first cell where array should be imported. + + + Column of the first cell where array should be imported. + + + TRUE if array should be imported vertically; FALSE - horizontally. + + Number of imported elements. + + + + Checks the string object is a formula. + + The value. + + + + + Imports an array of objects into a worksheet with specified alignment. + + Array of object. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + True if array should be imported vertically; False - horizontally. + Number of imported elements. + + + + Imports an array of string values into a worksheet. + + Array of string value. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + True if array should be imported vertically; False - horizontally. + Number of imported elements. + + + + Imports an array of integer values into a worksheet. + + Array of int value. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + True if array should be imported vertically; False - horizontally. + Number of imported elements. + + + + Imports an array of double values into a worksheet. + + Array of double value. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + True if array should be imported vertically; False - horizontally. + Number of imported elements. + + + + Imports an array of DateTime values into a worksheet. + + Array of datetime value. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + True if array should be imported vertically; False - horizontally. + Number of imported elements. + + + + Imports an array of objects into a worksheet. + + Array of object. + Row of the first cell where array should be imported. + Column of the first cell where array should be imported. + Number of imported rows. + + + + Imports data from a DataTable into a worksheet with specified row and column. + + DataTable with desired data. + TRUE if column names must be imported. + First row from where the data should be imported. + First column from where the data should be imported. + Number of imported rows. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Imports data from a DataTable into a worksheet with the specified row and column along with save option. + + Data Table with desired data. + First row from where the data should be imported. + First column from where the data should be imported. + TRUE if data table must be serialized directly on save. + Number of imported rows. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Imports data from a DataTable into a worksheet with the specified row and column along with save option. + + Data Table with desired data. + First row from where the data should be imported. + First column from where the data should be imported. + TRUE if data table must be serialized directly on save. + TRUE if column names must be imported. + Number of imported rows. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Imports data from a DataTable into a worksheet with specified row and column along with the preserve type. + + DataTable with desired data. + True if column names must be imported. + First row from where the data should be imported. + First column from where the data should be imported. + + Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + + Number of imported rows. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Imports data from a DataTable into a worksheet with the specified range. + + DataTable with desired data. + True if column names must be imported. + First row from where the data should be imported. + First column from where the data should be imported. + Maximum number of rows to import. + Maximum number of columns to import. + Number of imported rows. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Imports data from a DataTable into a worksheet with specified range along with the specified preserve type. + + DataTable with desired data. + True if column names must be imported. + First row from where the data should be imported. + First column from where the data should be imported. + Maximum number of rows to import. + Maximum number of columns to import. + + Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + + Number of imported rows. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Imports data from a DataTable into worksheet + + DataTable with desired data + TRUE if column names must also be imported + + First row from where the data should be imported. + + + First column from where the data should be imported. + + Maximum number of rows to import + Maximum number of columns to import + Array of columns to import. + + Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + + Number of imported rows + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Imports data from a DataTable into worksheet + + DataTable with desired data + TRUE if column names must also be imported + + First row from where the data should be imported. + + + First column from where the data should be imported. + + Maximum number of rows to import + Maximum number of columns to import + Array of columns to import. + + Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + + Indicates whether to serialize the data table directly. + Number of imported rows + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Replace the string data type value into SST index. + + DataTable with desired data. + Represents shared string collection. + Date time style index. + + + + Imports data from DataTable into the specified NamedRange of current worksheet. + + Data Table with desired data. + Represents named range. + TRUE if column names must be imported. + Number of imported rows. + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Imports data from DataTable into the specified NamedRange of current worksheet with row and column offset. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Data Table with desired data. + Represents named range. + TRUE if column names must also be imported. + Represents row offset into named range to import. + Represents column offset into named range to import. + Number of imported rows. + + + + Imports data from DataTable into the specified NamedRange of current worksheet with row and column offset. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + DataTable with desired data. + Represents named range. + TRUE if column names must be imported. + Represents row offset into named range to import. + Represents column offset into named range to import. + Maximum number of rows to import. + Maximum number of columns to import. + Number of imported rows. + + + + Imports data from DataTable into the specified NamedRange of current worksheet with row and column offset. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + DataTable with desired data. + Represents named range. + TRUE if column names must be imported. + Represents row offset into named range to import. + Represents column offset into named range to import. + Maximum number of rows to import. + Maximum number of columns to import. + Indicates whether to preserve column types. + Number of imported rows. + + + + Imports data from a DataColumn into a worksheet. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + DataColumn with desired data. + TRUE if column name must be imported. + First row from where the data should be imported. + First column from where the data should be imported. + Number of imported rows. + + + + Imports data from a DataColumn into a worksheet. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + DataColumn with desired data. + TRUE if column name must be imported. + First row from where the data should be imported. + First column from where the data should be imported. + + Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + + Number of imported rows. + + + + Imports data from DataReader into worksheet from the specified row and column. + + The or object which contains data. + TRUE if column names must be imported. + First row from where the data should be imported. + First column from where the data should be imported. + Number of imported rows. + + This method is not supported in WinRT, Windows Phone, Portable, Universal and Silverlight platforms. + + + + + Imports data from DataReader into worksheet from the specified row and column along with save option. + + The or object which contains data. + First row from where the data should be imported. + First column from where the data should be imported. + TRUE if data must be serialized directly on save. + Number of imported rows. + + This method is not supported in WinRT, Windows Phone, Portable, Universal and Silverlight platforms. + + + + + Imports data from DataReader into worksheet from the specified row and column along with the preserve type. + + The or object which contains data. + TRUE if column names must be imported. + First row from where the data should be imported. + First column from where the data should be imported. + + Indicates whether XlsIO should preserve column types from DataReader. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + Number of imported rows. + + This method is not supported in WinRT, Windows Phone, Portable, Universal and Silverlight platforms. + + + + + Imports data from DataReader into the specified NamedRange of current worksheet. + + The or object which contains data. + Represents named range. + TRUE if column names must be imported. + Number of imported rows. + + This method is not supported in WinRT, Windows Phone, Portable, Universal and Silverlight platforms. + + + + + Imports array of data columns. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Data columns to import. + Indicates whether to import field names. + Index to the first row. + Index to the first column. + Number of imported rows. + + + + Imports array of data columns. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Data columns to import. + Indicates whether to import field names. + Index to the first row. + Index to the first column. + + Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + + Number of imported rows. + + + + Imports data from MS DataGrid into worksheet. + + DataGrid with datasource. + Represents the first row of the worksheet to import. + Represents the first column of the worksheet to import. + TRUE if header must be imported. FALSE otherwise. + TRUE if row style must be imported. FALSE otherwise. + + + + Sets font style of Winforms grid. + + Represents font style of the grid. + Represents font style of the cell. + + + + Finds the data source type and import the data into worksheet. + + Data source to import. + Represents the first row of the worksheet to import. + Represents the first column of the worksheet to import. + TRUE if header must be imported. FALSE otherwise. + Dataset contains more then one data source, Which data source is need to import in worksheet. + Retrun number of imported rows + + + + Sets font style of web grid. + + Represents font style of the grid. + System grid font style + + + + Imports data from MS DataGrid (Web) into worksheet. + + DataGrid with datasource. + Represents the first row of the worksheet to import. + Represents the first column of the worksheet to import. + TRUE if header must be imported. FALSE otherwise. + TRUE if row style must be imported. FALSE otherwise. + + + + Sets font style of web grid. + + Current cell Range of worksheet + Represents font style of the grid. + DataGrid + TRUE if header must be imported. FALSE otherwise. + + + + Sets border style of web grid. + + Represents border style of the grid cell. + Represents border color of the grid cell. + current worksheet of migrent range + + + + Imports data from MS GridView into worksheet. + + GridView with datasource. + Represents the first row of the worksheet to import. + Represents the first column of the worksheet to import. + TRUE if header must be imported. FALSE otherwise. + TRUE if row style must be imported. FALSE otherwise. + + + + Imports data from MS DataGridView into worksheet. + + DataGridView with datasource. + Represents the first row of the worksheet to import. + Represents the first column of the worksheet to import. + TRUE if header must be imported. FALSE otherwise. + TRUE if row style must be imported. FALSE otherwise. + + + + + Imports data from a DataView into a worksheet with the specified range and preserve type. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + DataView with desired data. + TRUE if column names must be imported. + + Row of the first cell where DataView should be imported. + + + Column of the first cell where DataView should be imported. + + Indicates whether to preserve column types. + Number of imported rows. + + + + Imports data from a DataView into a worksheet with specified row, column and preserve type. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Data View with desired data. + TRUE if column names must be imported. + + Row of the first cell where DataView should be imported. + + + Column of the first cell where DataView should be imported. + + Maximum number of rows to import. + Maximum number of columns to import. + Number of imported rows. + + + + Imports data from a DataView into a worksheet with specified range and preserve type. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + DataView with desired data. + TRUE if column names must also be imported. + + Row of the first cell where DataView should be imported. + + + Column of the first cell where DataView should be imported. + + Maximum number of rows to import. + Maximum number of columns to import. + Indicates whether XlsIO should try to preserve types in Data Table, i.e. if it is set to False (default) and in Data Table we have in + string column value that contains only numbers, it would be converted to number. + Number of imported rows. + + + + Exports worksheet data in the specified row and column into a DataTable. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Row of the first cell from where DataTable should be exported. + Column of the first cell from where DataTable should be exported. + Maximum number of rows to export. + Maximum number of columns to export. + Export options. + DataTable with worksheet data. + + + + Exports worksheet data into a DataTable. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + Row of the first cell from where DataTable should be exported + + + Column of the first cell from where DataTable should be exported + + Maximum number of rows to export + Maximum number of columns to export + Export options. + Data Table with worksheet data + + + + Check the next cell exportType and formatType + + Row of the cell from where DataTable should be exported + Column of the first cell from where DataTable should be exported + first detect column type + Maximum number of rows to export + Export options + return exportType + + + + Exports worksheet data into a DataTable with the specified data range based on the exporting options. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Range to export. + Export options. + Data Table with worksheet data. + + + + Exports worksheet data into a DataTable with the specified data range based on the export options. + + When exportDataOption is null or the value of the ColumnTypeDeductionRow property in a row is less than or equal to 0, then By default the second row from the export range is used for detecting the column types. And the default value will be exported in the data table if the cell value does not match with the column type. + Range to export. + Export options. + Export Data options + Data Table with worksheet Data. + + + + Exports worksheet data in the specified row and column into a DataTable based on the export options. + + When exportDataOption is null or the value of the ColumnTypeDeductionRow property in a row is less than or equal to 0, then By default the second row from the export range is used for detecting the column types. And the default value will be exported in the data table if the cell value does not match with the column type. + Row of the first cell from where DataTable should be exported. + Column of the first cell from where DataTable should be exported. + Maximum number of rows to export. + Maximum number of columns to export. + Export options. + Export Data options. + Data Table with worksheet Data. + + + + Exports worksheet data into a Data Table. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + Range to export. + Export options. + Data Table with worksheet data. + + + + + + Get all the property names from worksheet. + + Type of the class to be exported. + Row of the first cell should be exported. + Column of the first cell should be exported. + LastColumn is used to find the upto lastColumn of data to export. + Collection of column index and names. + Migrant range. + Parent object name. + + + + Get the property value from worksheet. + + Type of the class to be exported. + Current row to be exported. + Current row to be exported. + Collection of column index and names. + Migrant range + Parent object name. + The mismatched CLR Object index. + Inner columns count of nested object. + Property value + + + + Preparing ExportEvent args for TypeMisatchOnExport event. + + Typecode of the current range. + The current range. + The current property. + Celltype of the current range. + The mismatched CLR Object index + Returns the new value of the given property type + + + + Imports data from class objects into a worksheet with specified row and column. + + IEnumerable object with desired data. + First row from where the data should be imported. + First column from where the data should be imported. + TRUE if class properties names must be imported. + Number of imported rows. + + + + Imports data from class objects into a worksheet with specified row and column along with import data options. + + IEnumerable object with desired data. + Import data options. + Number of imported rows. + + + + Imports data from class objects into a worksheet with specified row and column along with import data options and group options. + + IEnumerable object with desired data. + First row from where the data should be imported. + First column from where the data should be imported. + TRUE if class properties names must be imported. + TRUE if parent class properties names must be imported. + Import nested data options for when importing nested collection data. + Grouping options for when importing nested collection data. + The group will be expanded before this level and collapse will be applied from this level. + Indicates whether XlsIO should preserve column types from Data. + Number of imported rows. + + + + Add headers to specified row and column for importing data from class objects into a worksheet. + + First row from where the data should be imported. + First column from where the data should be imported. + TRUE if the object is dynamic object. + Dynamic object property names collection + Dynamic object call site collection + Object property types collection. + Object property informations collection. + The object to be imported to worksheet. + TRUE if parent class properties names must be imported. + Parent object name. + Number of columns are inserted. + + + + Insert object members values to specified row and column when importing data from class objects into a worksheet. + + First row from where the data should be imported. + First column from where the data should be imported. + Enumerator value of the object. + Object property informations collection. + Object property types collection. + TRUE if the object is dynamic object. + Dynamic object call site collection. + Dynamic object property names collection. + Null property indexes collection. + Total number of rows are inserted. + Import data options. + Grouping options for when importing nested collection data. + The current object level in nested object. + The group will be expanded before this level and collapse will be applied from this level. + Indicates whether XlsIO should preserve column types from Data. + Number of rows are inserted for current object. + Number of columns are inserted. + + + + Get the property value and name from the object + + Type of the element + Get the name from the object + Get the property valur from the object + Number of count + Object to get the property value + property value from the object + + + + Get the type code from the object + + Type to get the type code from the object + Type code of the object + + + + Set Repeat LayoutOptions Range values based on the cell type. + + First Row + First Column + Last Row + Last Column + + + + Get the property values from the object. + + object to get property value from. + TRUE if the object is dynamic object. + PropertyInfo to get value from. + Dynamic object call site collection. + Dynamic object property names collection. + Property value. + + + + Check whether the object is dynamic object. + + Object to be checked. + Dynamic object properties collection. + True if the object is dynamic object, Otherwise false. + + + + Set proper property types based on their values. + + Object property informations collection. + Object property types collection. + + + + Imports Data with type preservation, but without checking arguments for correctness. + + Property type code + Property value + Migrant range to import + + + + Imports Data without checking arguments for correctness. + + Property type code + Property value + Migrant range to import + + + + Get the property types and values from the object. + + Property value to be get. + Enumerator value of the object. + Object to get PropertyInfo from. + TRUE if the object is dynamic object. + Object property types collection. + Object property informations collection. + Dynamic object properties collection. + Dynamic object property names collection. + Dynamic object call site collection. + Null property indexes collection. + True if the property is IEnumerable collection, Otherwise false. + + + + Get the property types and values from the object. + + Property value to be get. + TRUE if the object is dynamic object. + Object property types collection. + Object property informations collection. + Dynamic object properties collection. + Dynamic object property names collection. + Dynamic object call site collection. + Null property indexes collection. + True if the current object contains properties, Otherwise false. + + + + Get the property types and values from the dynamic object. + + Enumerator value of the dynamic object. + Object to get PropertyInfo from. + Dynamic object properties collection. + Dynamic object property names collection. + Dynamic object call site collection. + Null property indexes collection. + Property types collction of the dynamic object + + + + Get total children count from the object. + + input object value + collection count to be extract. + Returns true if the collection count is greater than 0; otherwise false + + + + Get the property information from expando objects + + input expando objects + the list of type code from expando object properties + + + + Get the properties list from the object type. + + Type + Properties list + List of Properties + + + + Removes panes from a worksheet. + + + + + Intersects two ranges. + + First range to intersect. + Second range to intersect. + Intersection of two ranges or NULL if there is no range intersection. + + When range1 or range2 is NULL. + + + + + Merges two ranges. + + First range to merge. + Second range to merge. + Merged ranges or NULL if is not able to merge ranges. + + When range1 or range2 is NULL. + + + + + Find a range with the given value. + + Value to find. + Range array that contains the given value. + + + + collect the same value ranges. + + + + + + + + Replaces string with the specified another string value. + + The string to be replaced. + The string to replace all occurrences of oldValue. + + + + Replaces string with the specified another string value based on the . + + The string to be replaced. + The string to replace all occurrences of oldValue. + Specifies the find options for the oldValue. + + + + Replaces string with the specified DateTime value. + + The string to be replaced. + The DateTime to replace all occurrences of oldValue. + + + + Replaces string with the specified double value. + + The string to be replaced. + The double value to replace all occurrences of oldValue. + + + + Replaces specified string with the specified array of string values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces specified string with the specified array of int values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces specified string with the specified array of double values. + + The string to be replaced. + Array of new values. + + Indicates whether array should be inserted vertically. + + + + + Replaces string with the specified datatable value. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + The string to be replaced. + Data table with new data. + Indicates whether field name must be shown. + + + + Replaces string with the specified datacolumn value. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + The string to be replaced. + Data table with new data. + Indicates whether field name must be shown. + + + + Removes worksheet from parent worksheet collection. + + + + + Moves worksheet to the specified index. + + New index of the worksheet. + + + + + + + + + + Sets column width for the specified column. + + One-based column index. + Width to set. + + + + Sets column width in pixels for the specified column. + + One-based column index. + Width in pixels to set. + + + + Sets column width in pixels for the specified column. + + One-based column index. + Width in pixels to set. + Bool value is find autofit or not ,if true autofit or not + + + + Sets column width for the specified column. + + One-based column index. + Width to set. + Bool value is find autofit or not ,if true autofit or not + + + + Sets column width in pixels to the given number of columns from the specified column index. + + Start Column index + No of Column to be set width + Value in pixel to set + + + + Sets row height for the specified row. + + One-based row index. + Height to set. + + + + Sets row height in pixels for the specified row. + + One-based row index. + Value in pixels to set. + + + + Sets row height in pixels to the given number of rows from the specified row index. + + Starting row index. + No of Row to be set width. + Value in pixels to set. + + + + Returns the first occurrence of the specified string value with the specified . + + Value to search. + Type of value to search. + Returns the first cell with a specified string value, or null if value was not found. + + + + Returns the first occurrence that starts with the specified string value. + + Value to search. + Type of value to search. + Returns the first occurrence that starts with the specified string value, or null if value was not found. + + + + Returns the first occurrence that starts with the specified string value which ignores the case. + + Value to search. + Type of value to search. + true to ignore case wen comparing this string to the value;otherwise,false + Returns the first occurrence that starts with the specified string value, or null if value was not found. + + + + Returns the first occurrence that ends with the specified string value. + + Value to search. + Type of value to search. + Returns the first occurrence that ends with the specified string value, or null if value was not found. + + + + Returns the first occurrence that ends with the specified string value which ignores the case. + + Value to search. + Type of value to search. + True to ignore case when comparing this string to the value; otherwise, False. + Returns the first occurrence that ends with the specified string value, or null if value was not found. + + + + Returns the first occurrence of the specified string value with the specified and . + + Value to search. + Type of value to search. + Way to search the value. + Returns the first cell with a specified string value and specified find options , or null if value was not found. + + + + Returns the first occurrence of the specified double value with the specified . + + Value to search. + Type of value to search. + Returns the first cell with a specified double value, or null if value was not found. + + + + Returns the first occurrence of the specified bool value. + + Value to search. + Returns the first cell with a specified bool value, or null if value was not found. + + + + Returns the first occurrence of the specified DateTime value. + + Value to search. + Returns the first cell with a specified DateTime value, or null if value was not found. + + + + Returns the first occurrence of the specified TimeSpan value. + + Value to search. + Returns the first cell with a specified TimeSpan value, or null if value was not found. + + + + Returns the cells of the specified string value with the specified . + + Value to search. + Type of value to search. + Returns the cells with a specified string value, or null if value was not found. + + + + Returns the cells of the specified string value with the specified and . + + Value to search. + Type of value to search. + Way to search. + + Returns the cells with a specified string value and specified find options , or null if value was not found. + + + + + Returns the cells of the specified double value with the specified . + + Value to search. + Type of value to search. + All found cells, or Null if value was not found. + + + + Returns the cells of the specified bool value. + + Value to search. + Returns the cells with a specified bool value, or null if value was not found. + + + + Returns the cells of the specified DateTime value. + + Value to search. + Returns the cells with a specified DateTime value, or null if value was not found. + + + + Returns the cells of the specified TimeSpan value. + + Value to search. + Returns the cells with a specified TimeSpan value, or null if value was not found. + + + + Saves worksheet with specified file name using separator. Used only for CSV files. + + File to save. + Denotes separator for the CSV file types. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Saves worksheet using separator with specified file name and encoding. Used only for CSV files. + + File to save. + Denotes separator for the CSV file types. + Encoding to use. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Saves worksheet as stream using separator. Used only for CSV files. + + Stream to save. + Denotes separator for the CSV file types. + + + + Save tabsheet using separator. + + Stream to save. + Denotes separator for the CSV file types. + Encoding to use. + + + + Saves worksheet as stream using separator with specified encoding. Used only for CSV files. + + Stream to save. + Denotes separator for the CSV file types. + Encoding to use. + + + + Saves worksheet with specified filename. + + File to save. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Saves worksheet as stream. + + Stream to save. + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Saves worksheet with specified filename and . + + File to save. + Save Options + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Saves worksheet as stream with the specified . + + Stream to save. + Save Options + + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + + Sets the default column style for the specified column. + + One-based column index. + Default style. + + + + Sets the default column style for the specified starting and ending column. + + Starting column index. + Ending column index. + Default style. + + + + Sets the default row style for the specified row. + + One-based row index. + Default style. + + + + Sets the default row style for the specified starting and ending row. + + Starting row index. + Ending row index. + Default style. + + + + Sets by row index default style for cell. + + Column index. + Default style index. + + + + Returns the default column style for the specified column. + + One-based column index. + Default column style for the specified column or null if style wasn't set. + + + + Returns default row style for the specified row. + + One-based row index. + Default row style for the specified row or null if style wasn't set. + + + + Frees range object. + + Range to remove from internal cache. + + + + Frees range object for the specified row and column. + + One-based row index of the range object to remove from internal cache. + One-based column index of the range object to remove from internal cache. + + + + Converts the specified range into image. Default image type is Bitmap. + + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Converted Image for the specified range. + Subscript/Superscript,RTF,Shrink to fit,Shapes (except TextBox shape and Image),Charts and + Chart Worksheet and Complex conditional formatting features are not supported in Worksheet + to image conversion. Gradient fill is partially supported. + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Converts the specified range into image with the specified type. + + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Type of the image to create. + Stream to be converted to an image. It is ignored if null. + Converted Image for the specified range. + Subscript/Superscript,RTF,Shrink to fit,Shapes (except TextBox shape and Image),Charts and + Chart Worksheet and Complex conditional formatting features are not supported in Worksheet + to image conversion. Gradient fill is partially supported. + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Converts the specified range into Metafile. + + One-based index of the first row to convert. + One-based index of the first column to convert. + One-based index of the last row to convert. + One-based index of the last column to convert. + Enhanced MetaFile, to render the image in meta file format. + Stream to be converted to an image. It is ignored if null. + Converted Image for the specified range. + Subscript/Superscript,RTF,Shrink to fit,Shapes (except TextBox shape and Image),Charts and + Chart Worksheet and Complex conditional formatting features are not supported in Worksheet + to image conversion. Gradient fill is partially supported. + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Converts the specified range into image along with Metafile. + + One-based index of the first row. + One-based index of the first column. + One-based index of the last row. + One-based index of the last column. + Type of the image to create. + Stream to be converted to an image. It is ignored if null. + Enhanced MetaFile, to render the image in meta file format. + Converted Image for the specified range. + Subscript/Superscript,RTF,Shrink to fit,Shapes (except TextBox shape and Image),Charts and + Chart Worksheet and Complex conditional formatting features are not supported in Worksheet + to image conversion. Gradient fill is partially supported. + This method is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + + + Import XML document with specified cell position to the worksheet using file path. + + FilePath of the speciifed xml file. + Row where the data to be imported. + Column where the data to be imported. + + + + Imports XML data into a worksheet at the specified row and column from a given XML data stream. + + Stream data of the xml file. + Row where the data to be imported. + Column where the data to be imported. + The stream should be passed as file stream to bind the xml + + + + Imports data table without checking arguments for correctness. + + Data table to import. + Index of the first row to import. + Index of the first column to import. + Maximum number of rows to import. + Maximum number of columns to import. + Array of columns to import. + + + + Imports data table with type preservation, but without checking arguments for correctness. + + Data table to import. + Index of the first row to import. + Index of the first column to import. + Maximum number of rows to import. + Maximum number of columns to import. + Array of columns to import. + + + + Imports DataView without checking arguments for correctness. + + DataView to import. + Index of the first row to import. + Index of the first column to import. + Maximum number of rows to import. + Maximum number of columns to import. + + + + Imports DataView with type preservation, but without checking arguments for correctness. + + DataView to import. + Index of the first row to import. + Index of the first column to import. + Maximum number of rows to import. + Maximum number of columns to import. + + + + Converts object value into RangeProperty enum. + + Value to convert. + Column index in DataRowView. + Dictionary to cache results. + Corresponding RangeProperty. + + + + Return the type codes of a properties from the customized dynamic objects + + overrided dynamic object + list of property names + List of call site for properties + index of null values, to identify the type later + the typecodes for each properties + + + + Check whether the string is link address and add the hyperlink for the range. + + input string value need to be checked. + Range the hyperlink to add. + Returns true if the hyperlink is added. + + + + Get the hyperlink type if the string is detected as hyperlink. + + input string value need to be checked. + Returns true if the string value is matched for regex values. + + + + Saves worksheet into specified OffsetArrayList. + + + OffsetArrayList that will receive all of the worksheet's records. + + + When records is null + + + + + Serialize error indicators. + + Represents record storage. + + + + Serializes worksheet if it wasn't parsed. + + Record list to serialize into. + + + + Saves worksheet into specified OffsetArrayList in Clipboard format + + + OffsetArrayList that will receive all worksheet's records + + + When records is null + + + + + Saves worksheet into specified OffsetArrayList in Clipboard format + + OffsetArrayList that will receive all worksheet's records + It's serilize the clipboard, othewise false. + clipboard range + + + + Saves ColumnInfoRecords into specified OffsetArrayList + + + OffsetArrayList that will receive all ColumnInfoRecords + + Number of ColumnInfoRecords + + When records is null + + + + + Saves specified ColumnInfoRecords into specified OffsetArrayList + + + OffsetArrayList that will receive all ColumnInfoRecords + + Index of last column + + When records or values is null + + + + + Serializes conditional formats. + + OffsetArrayList that will receive format records. + + + + Serializes data validation table. + + OffsetArrayList that will receive data validation records. + + + + Compares two DVRecords ignoring ranges information. + + First DVRecord to compare. + Second DVRecord to compare. + TRUE if they are equal; FALSE otherwise. + + + + Merges DVRecords. + + Destination DVRecord. + DVRecord to add regions from. + + + + Saves all shapes. + + List to save records into. + + + + Saves worksheet into specified OffsetArrayList. + + + OffsetArrayList that will receive all of the worksheet's records. + + Indicates whether we need to serialize all records to be able to copy them into clipboard. + Clipboard range + + When records is null + + + + + Raises ColumnWidthChanged event. + + Zero-based column index. + New width value. + + + + Raises RowHeightChanged event. + + Zero-based row index. + New height. + + + + This method is called when normal font changes. + + Event sender. + Event arguments. + + + + Sets formula value in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Value to set. + + + + Tries to convert string into datetime value. + + String to parse. + Converted value. + True if conversion succeeded, false otherwise. + + + + Tries to convert string into datetime value. + + String to parse. + Converted value. + True if conversion succeeded, false otherwise. + + + + Returns range from the formula string + + formula string. + Range referred by formula. + + + + Sets value for the specified cell. + + One-based row index. + One-based column index. + Value to set. + + + + + + Sets number for the specified cell. + + One-based row index. + One-based column index. + Value to set. + + + + Sets boolean value for the specified cell. + + One-based row index. + One-based column index. + Value to set. + + + + Sets text for the specified cell. + + One-based row index. + One-based column index. + Text to set. + + + + Sets formula for the specified cell. + + One-based row index. + One-based column index. + Formula to set. + + + + Sets formula in the specified cell. + + One-based row index of the cell to set value. + One-based column index of the cell to set value. + Formula to set. + Indicates is formula in R1C1 notation. + + + + Sets error for the specified cell. + + One-based row index. + One-based column index. + Error to set. + + + + Blanks the specified cell. + + One-based row index. + One-based column index. + + + + Sets blank record into cell with specified row and column. + + Row index. + Column index. + + + + Sets number record into cell with specified row and column. + + One-based row index. + One-based column index. + Value to set. + Represents xf index. + + + + Sets rk record into cell with specified row and column. + + One-based row index. + One-based column index. + Value to be set. + + + + Sets formula value. + + One based row index. + One based column. + Formula value to set. + Indicates whether range is represented as R1C1 notation. + + + + Sets formula number value for the specified cell. + + One-based row index. + One-based column index. + Represents formula number value. + + + + Sets formula error value for the specified cell. + + One-based row index. + One-based column index. + Represents formula error value. + + + + Sets formula bool value for the specified cell. + + One-based row index. + One-based column index. + Represents formula bool value. + + + + Sets formula string value for the specified cell. + + One-based row index. + One-based column index. + Represents formula string value. + + + + Sets error value. + + Row index. + Column index. + Value representing error name. + Indicates whether to set text. + + + + Sets string to a range. + + Row index + Column index + String value to set. + + + + Removes string from a cell. + + Row index. + Column index. + Index to extended format + + + + Returns index of an extended format for specified cell. + + One-based row index. + One-based column index. + Index to the extended format. + + + + Returns index of an extended format for specified Row. + + One-based row index. + Index to the extended format. + + + + Returns index of an extended format for specified Column. + + first column index. + last column index. + Index to the extended format. + + + + Tries to create Rk record from double value. + + Row index. + Column index. + Double that should be converted to RkRecord. + Created RkRecord if succeeded, null otherwise. + + + + Tries to create Rk record from double value. + + Row index. + Column index. + Double that should be converted to RkRecord. + Represents xf index. + Created RkRecord if succeeded, null otherwise. + + + + Creates record. + + Record to create. + One-based row index. + One-based column index. + Created biff record. + + + + Creates record. + + Record to create. + One-based row index. + One-based column index. + Represents xf index. + Created biff record. + + + + Sets formula number. Use for setting FormulaError, FormulaBoolean, FormulaNumber values. + + One based row index. + One based column index. + Represents value for set. + + + + Sets formula value. Use for setting FormulaError, FormulaBoolean, FormulaNumber, FormulaString values. + + One based row index. + One based column index. + Represents value for set. + Represents string record as formula string value. Can be null. + + + + Returns formula value from specified row and column. + + One-based row index. + One-based column index. + Indicates whether R1C1 notation should be used. + Returns formula string. + + + + Returns formula corresponding to the cell. + + One-based row index of the cell to get value from. + One-based column index of the cell to get value from. + Indicates whether R1C1 notation should be used. + Formula contained by the cell. + + + + Returns formula corresponding to the cell. + + One-based row index of the cell to get value from. + One-based column index of the cell to get value from. + Indicates whether R1C1 notation should be used. + Formula utilities to use for parsing. + Formula contained by the cell. + + + + Returns formula corresponding to the cell. + + Zero-based row index of the cell to get value from. + Zero-based column index of the cell to get value from. + Array with formula tokens. + Indicates whether R1C1 notation should be used. + Formula utilities to use for parsing. + Formula contained by the cell. + + + + Returns formula array. + + Represents formula. + Formula array. + + + + Returns string value corresponding to the cell. + + Cell index to get value from. + String contained by the cell. + + + + Returns string value from the specified row and column. + + One-based row index. + One-based column index. + String contained by the cell. + + + + Returns formula string value from the specified row and column. + + One-based row index. + One-based column index. + String contained by the cell. + + + + Returns number value from the specified row and column. + + One-based row index. + One-based column index. + Number contained by the cell. + + + + Returns formula number value from the specified row and column. + + One-based row index. + One-based column index. + Number contained by the cell. + + + + Returns error value from the specified row and column. + + One-based row index. + One-based column index. + Returns error value or null. + + + + Gets the error value to string. + + The value. + Row index. + Returns error string or null. + + + + Returns formula error value from the specified row and column. + + One-based row index. + One-based column index. + Returns error value or null. + + + + Returns bool value from the specified row and column. + + One-based row index. + One-based column index. + Returns found bool value. If cannot found returns false. + + + + Returns formula bool value from the specified row and column. + + One-based row index. + One-based column index. + True if bool value is found. otherwise False. + + + + Indicates is has array formula. + + Represents row index. + Represents column index. + Indicates is contain array formula record. + + + + Indicates whether tokens array contains array formula reference. + + Tokens to check. + True if it refers to + + + + Gets cell type from current column. + + Indicates row. + Indicates column. + Indicates is need to indentify formula sub type. + Returns cell type. + + + + Indicates is formula in cell is formula to external workbook. + + Represents row index. + Represents column index. + If contain extern formula returns true; otherwise false. + + + + Get the idex of the first row in UsedRange + + index of first row + + + + get the index of the last row in UsedRange + + index of last row + + + + This API supports the .NET Framework infrastructure and is not intended to be used directly from your code + + + + + + Gets the first column index. + + Index of first column + + + + Gets the last column index / column count. + + Index of last column + + + + This API supports the .NET Framework infrastructure and is not intended to be used directly from your code + + + + + + Builds the merged regions. + + + + + + Calculate all the formulas in worksheet. + + The following code illustrates how to calculate all the formulas in the worksheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Formulas.xlsx"); + IWorksheet worksheet = workbook.Worksheets[0]; + + // Calculate all the formulas in the worksheet. + worksheet.Calculate(); + + workbook.SaveAs("Calculation.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Imports HTML table of a HTML file into worksheet from the specified row and column. + + Specifies the HTML file. + Specifies the starting row index. + Specifies the starting column index. + + The following code illustrates how to convert HTML table to Excel. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + + sheet.ImportHtmlTable("HTMLtable.html", 1, 1); + + workbook.SaveAs("HTMLToExcel.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Imports HTML table of a file stream into worksheet from the specified row and column. + + Specifies the HTML filestream. + Specifies the starting row index. + Specifies the starting column index. + + The following code illustrates how to convert HTML table to Excel. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + FileStream html = new FileStream("HTMLtable.html", FileMode.Open, FileAccess.ReadWrite); + + sheet.ImportHtmlTable(html, 1, 1); + + workbook.SaveAs("HTMLToExcel.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Imports tables from HTML document into Excel worksheet from the specified row and column with HTML import options. + + Specifies the HTML file. + Specifies the starting row index. + Specifies the starting column index. + Specifies the html import options. + + The following code illustrates how to convert HTML table to Excel. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Xlsx; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + + sheet.ImportHtmlTable("HTMLtable.html", 1, 1, HtmlImportOptions.DetectFormulas); + + workbook.SaveAs("HTMLToExcel.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Imports HTML table of a file stream into worksheet from the specified row, column and html import options. + + Specifies the HTML filestream. + Specifies the starting row index. + Specifies the starting column index. + Specifies the html import options. + + The following code illustrates how to convert HTML table to Excel. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Xlsx; + IWorkbook workbook = application.Workbooks.Create(1); + + IWorksheet sheet = workbook.Worksheets[0]; + FileStream html = new FileStream("HTMLtable.html", FileMode.Open, FileAccess.ReadWrite); + + sheet.ImportHtmlTable(html, 1, 1, HtmlImportOptions.DetectFormulas); + + workbook.SaveAs("HTMLToExcel.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + Event raised when an unknown function is encountered. + + + + + Occurs when the value of a cell changes. + + + + + Event to choose an action while exporting data from Excel to data table. + + + + + Provides access to the collection of merged region identifiers. + Initializes the collection if it has not been created yet. + + + + + Gets or sets the a object associated with implementation. + + + + + Indicates the shapes can be copied while sorting + + + + + Indicates whether the conditional format is copied or not. + + + + + Gets a value indicating whether this instance has sheet calculation. + + + true if this instance has sheet calculation; otherwise, false. + + + + + Gets and set the Addcopy value of the worksheet + + + true if the sheet is copied using AddCopy method; otherwise, false. + + + + + Gets a value indicating whether this instance has Alernate Content. + + + true if this instance has sheet AlernateContent; otherwise, false. + + + + + An event raised on the IWorksheet whenever a value changes. + + + + + Slicer Ext stream + + + + + Returns true if the AutoFitPivotTable method is called. Otherwise False. + + + + + Gets the Slicers. + + + + + Get the scenarios collection for the current worksheet. + + + + + Gets the threaded comments collection for a current worksheet. + + The collection. + + + + Represents the slicer caches + + + + + Represents the slicer cache id + + + + + Indicates whether current process is subtotal. + + + + + Indicates whether existing subtotal removed. + + + + + Indicates whether subtotal applied worksheet contains array separated formula. + + + + + The dictionary holds a records objects, representing each cell. + Holds information about used cells only. + Key - cell index. + Value - corresponding BiffRecordRaw. + + + + + Contains inserted rows for subtotal process. + + + + + Rows moved in subtotal process. + + + + + Contains formulas for range + + + + + Stream to preserve the worksheet slicer + + + + + returns true when cell contains hyperlinks + + + + + Default column width mentioned in the attribute + + + + + Read-only. Access to merged cells. + + + + + Read-only. Access to column info records. + + + + + Gets or sets the position of vertical split in the worksheet. + + + Position of the vertical split (px, 0 = No vertical split): + Unfrozen pane: Width of the left pane(s) (in twips = 1/20 of a point) + Frozen pane: Number of visible columns in left pane(s) + + + + + Gets or sets the position of horizontal split in the worksheet. + + + Position of the horizontal split (by, 0 = No horizontal split): + Unfrozen pane: Height of the top pane(s) (in twips = 1/20 of a point) + Frozen pane: Number of visible rows in top pane(s) + + + + + Gets or sets the first visible row index. + + + + + Max_Coloumn width + + + + + Gets or sets the first visible column index. + + + + + Worksheet's print area. + + + + + Gets a value indicating selection count of pane. + + + + + Gets data validation collection. + + + + + Gets the auto filters collection in the worksheet. Read-only. + + + + + Collection of all hyperlinks in the current worksheet. + + + + + Collection of all hyperlinks in the current worksheet. + + + + + Gets or sets the view setting of the worksheet. + + + + + Return default row height in pixel. + + + + + Returns inner names collection. Read-only. + + + + + Returns inner data validation table. Read-only. + + + + + Returns collection of cell records. Read-only. + + + + + Returns a PageSetup object that contains all the page setup settings + for the specified object. Read-only. + + + + + Returns collection with all conditional formats in the worksheet. Read-only. + + + + + Gets pain record or null. Read-only. + + + + + Gets array with selection records or null. Read-only. + + + + + Returns collection of the custom properties. Read-only. + + + + + Indicates whether all created range objects should be cached or not. + + + + + Returns all autofilter records. Read-only. + + + + + Returns all DCon records that were met in the source document. Read-only. + + + + + Returns all Sort records that were met in the source document. Read-only. + + + + + Represents error indicators. + + + + + Returns quoted name of the worksheet. + + + + + Gets or sets excel version. + + + + + Returns object used for records creation/extraction from data provider. Read-only. + + + + + + + + + + Indicates whether IsHidden property is set. + + + + + Indicates whether ZeroHeight property has enabled or not. + + + + + Specifies the number of characters of the maximum digit width of the normal style's font. + + + + + 'True' if rows have a thick bottom border by default. + + + + + 'True' if rows have a thick top border by default. + + + + + Highest number of outline levels for columns in this sheet. + + + + + Highest number of outline level for rows in this sheet. + + + + + Highest number of outline level for rows in this sheet. + + + + + Returns the rows outline level count + + + + + Returns the columns outline level count + + + + + Returns or sets the list of outline wrapper collection + + + + + Gets the boolean value indicating whether the row is inserting in this worksheet. + + + + + Gets the boolean value indicating whether the row is deleting in this worksheet. + + + + + Represents collection of Cell Formulas + + + + + Indicates whether worksheet has merged cells. Read-only. + + + + + Gets collection of all list objects in the worksheet. + + + + + Gets default protection options for the worksheet. + + + + + Returns un protected options + + + + + Gets the inline strings. + + The inline strings. + + + + Preserves the External connection setting in the worksheet. + + + + + Preserves the pivot tables. + + + + + Gets or sets the boolean value to load worksheets on demand + + + + + Return or sets the columns outline levels collection + + + + + Returns the row outline levels collection + + + + + Cell address list which to be merged while importing nested collection. + + + + + Range collection which to be merged while importing nested collection. + + + + + Gets or sets cell range by row and column index. Row and column indexes are one-based. + + One-based row index. + One-based column index. + + + + Get cell Range. Row and column indexes are one-based. Read-only. + + First row index. One-based. + First column index. One-based. + Last row index. One-based. + Last column index. One-based. + + + + Gets cell Range. Read-only. + + + + + Gets cell Range with R1C1Notation flag. Read-only. + + + + + Gets or sets index of the active pane. + + + + + Gets the used cells in the worksheet. Read-only. + + + + + Gets a Range object that represents all the columns in the specified worksheet. Read-only. + + + + + Gets or sets a value that indicates whether page breaks (both automatic and manual) + on the worksheet are displayed. + + + + + Gets a collection of OleObjects in the worksheet. + + This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + The OLE objects. + + + + Gets whether the OLE object is present in the worksheet. Read-only. + + This property is supported on Windows Forms, WPF, ASP.NET and ASP.NET MVC platforms only. + + True if this instance is OLE object; otherwise, False. + + + + + Gets the sparkline groups. + + The sparkline groups. + + + + Gets a that represents the horizontal + page breaks in the worksheet. Read-only. + + + + + Gets a hyperlink collections in the worksheet. Read-only. + + + + + True if zero values to be displayed. otherwise, False. + + + + + True if grid lines are visible. otherwise, False. + + + + + True if row and column headers are visible. otherwise, False. + + + + + True if all values in the worksheet are preserved as strings. otherwise, False. + + + + + Gets all the merged ranges in the worksheet. Read-only. + + + + + Gets a Names collection that represents + the worksheet-specific names (names defined with the "WorksheetName!" + prefix) in the worksheet. Read-only. + + + + + Gets a object that contains all the page setup settings + for the specified object. Read-only. + + + + + Gets or sets range indicating first visible row and column. + + + + + Gets a Range object that represents a cell or a range of cells in the worksheet. + + + + + Gets a Range object that represents the rows in the specified worksheet. Read-only. + + + + + Defines whether freezed panes are applied. + + + + + Gets split cell range. + + + + + Gets or sets the standard (default) height of all the rows in the worksheet, + in points. + + Standard Height sets the height for each row if the row contains data. + So To improve performance, set standard height of the worksheet before set value in cells. + + + + + + Gets or sets the standard (default) height option flag. + + + Which defines that standard (default) row height and book default font height do not match. + + + + + Gets or sets the standard (default) width of all the columns in the + worksheet. + + + + + Gets the worksheet type. Read-only ExcelSheetType. + + + + + Gets a Range object that represents the used range on the + specified worksheet. Read-only. + + + + + Gets all not empty or accessed cells. Read-only. + + + WARNING: This property creates Range object for each cell in the worksheet + and creates new array each time user calls to it. It can cause huge memory + usage especially if called frequently. + + + + + Gets a that represents the vertical page + breaks on the sheet. Read-only. + + + + + Indicates whether worksheet is empty. Read-only. + + + + + Gets a collection of custom properties of the worksheet. Read-only. + + + + + Gets instance of migrant range. Read-only. + + The IMigrantRange interface can also be used to access a single cell + or group of cells and manipulate it. You can prefer IMigrantRange instead of IRange + while writing large amount of data which is an optimal way. + Row and Column index can be changed by using method. + + + + + Gets or sets whether used range should include cells with formatting. + + + There are two different algorithms to create UsedRange object: + 1) Default. This property = true. The cell is included into UsedRange, + even data is empty (maybe some formatting + changed, maynot be - cell was accessed and record was created). + 2) This property = false. In this case XlsIO tries to remove empty rows and + columns from all sides to make UsedRange smaller. + + + + + Indicates whether to include CFRange in Used range. + + + + + Gets a collection of pivot tables in the worksheet. Read-only. + + + + + Retruns internal pivot table collection. Read-only. + + + + + Gets a collection of list objects in the worksheet. Read-only. + + + + + Indicates is current sheet is protected. + + + + + Returns ImportDTHelper objects. + + + + + Indicates whether it is importing. + + + + + + Gets the DataSorter. + + The DataSorter. + The following code illustrates how to get the DataSorter from the sheet. + + ExcelEngine excelEngine = new ExcelEngine(); + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Open("Sorting.xlsx"); + + //Create DataSorter for worksheet. + IDataSort sheetSort = workbook.Worksheets[0].DataSorter; + + //Adding Sort range for worksheet + sheetSort.SortRange = workbook.Worksheets[0].UsedRange; + + //Adding Sorting fields for DataSorter. + sheetSort.SortFields.Add(1, SortOn.Values, OrderBy.Ascending); + + //Perform Sorting for worksheet range. + sheetSort.Sort(); + + workbook.SaveAs("SortedExcel.xlsx"); + workbook.Close(); + excelEngine.Dispose(); + + + + + + + Start index for conditional formatting records. + + + + + Gets or sets the default worksheet extended format index. + + + + + Denotes if the document has BaseColWidth property alone. + + + + + This event is raised after column width changed. + + + + + This event is raised after column height changed. + + + + + Gets top left cell of the worksheet. + + + + + + Returns if contains protection + + + + + Event delegate to export data from Excel to data table with the action mentioned. + + + + + Defines which property of IRange should be used. + + + + + Represents range value type. + + + + + Represents Blank type. + + + + + Represents Error type. + + + + + Represents Boolean type. + + + + + Represents Number type. + + + + + Represents Formula type. + + + + + Represents String type. + + + + + Delegate for outline creation. + + + + + This class is used for sorting cell indexes by row. + + + + + Compares two cell indexes by row value + + First cell index to compare + Second cell index to compare + + 0 - if rows are equal; + -1 - when the second row is greater than the first; + 1 - when the first row is greater than the second; + + + + + This class is used for sorting cell indexes by column + + + + + Compares two cell indexes by column value + + First cell index to compare + Second cell index to compare + + 0 - if columns are equal; + -1 - when the second column is greater than the first; + 1 - when the first column is greater than the second; + + + + + This class is used for sorting ranges by row index + + + + + Compares two ranges by row index + + First range to compare + Second range to compare + + 0 - if rows are equal; + -1 - when the second row is greater than the first; + 1 - when the first row is greater than the second; + + + + + This class is used for sorting ranges by column index + + + + + Compares two ranges by column index + + First range to compare + Second range to compare + + 0 - if rows are equal; + -1 - when the second column is greater than the first; + 1 - when the first column is greater than the second; + + + + + + Represents the method that will return array of biff records for MsoDrawing record. + + + + + Event delegate for MissingFunction event. + + The CalcEngine. + The for this event. + + + + The event args for the MissingFunction event which is raised whenever the CalcEngine encounters a function + that is does not know. + + + + + Gets the name of the unknown function. + + + + + Gets the location of the missing function. + + + + + Struct contains X,Y and isParse. + + + + + Merged cells information. + + + + + Reperesents the table span. + + + + + Number of rows. + + + + + Number of columns. + + + + + Reperesents first cell in merged region. + + + + + Reperesents the first cell index. + + + + + Reperesents the table span. + + + + + Number of rows. + + + + + Number of columns. + + + + + Reperesents first cell in merged region. + + + + + Reperesents the first cell index + + + + + Reperesents the table span. + + + + + Represents the default span. + + + + + Represents the row span. + + + + + Represents the column span. + + + + + Summary description for Dxf style implementation. + + + + + Borders collection. + + + + + Fill implementation. + + + + + Font implementation. + + + + + Format implementation. + + + + + Vertical border color. + + + + + Horizontal border color. + + + + + Veritcal Border line style. + + + + + Horizontal border line Style. + + + + + Represent the vertical border format modified or not. + + + + + Represent the Horizontal border format modified or not. + + + + + Indent value. + + + + + Indent options of the Dfx. + + + + + Indent options of the Dfx. + + + + + True indicates shrinking content to fit into cell. + + + + + True indicates that text is wrapped at right border. + + + + + Horizontal alignment options of the Dfx. + + + + + Vertical Alignment options of the Dfx. + + + + + True if cell is locked. + + + + + True if formula is hidden. + + + + + Flag for horizontal and vertical alignment, text wrap, indentation, + orientation, rotation, and text direction. + + + + + Flag for cell protection (cell locked and formula hidden). + + + + + Initializes new instance of the Dxf style. + + + + + Copies all dxf style settings into conditional format. + + Conditional format to copy data into. + + + + Copies all dxf style settings into table style element. + + Table style element object + + + + Copies all dxf style settings into pivot cell format. + + Pivot Cell Format + + + + Copies all dxf style settings into sort field. + + Conditional format to copy data into. + + + + Creates copy of the current object. + + A copy of the current object. + + + + Gets/sets Format record. + + + + + Gets/sets fill. + + + + + Gets/sets font. + + + + + Gets/sets borders. + + + + + Gets and sets the horizontal border color. + + + + + Gets and sets the vertical border line style. + + + + + Gets and sets the horizontal border line style. + + + + + Gets and sets the horizontal border modified or not. + + + + + Gets and sets the vertical border modified or not. + + + + + Horizontal alignment. + + + + + Vertical alignment. + + + + + True means that text is wrapped at right border. + + + + + Gets or sets indent level. + + + + + True means to shrink content to fit into cell. + + + + + Text direction, the reading order for far east versions. + + + + + Text rotation angle: + 0- Not rotated + 1-90- 1 to 90 degrees counterclockwise + 91-180- 1 to 90 degrees clockwise + 255- Letters are stacked top-to-bottom, but not rotated. + + + Thrown when value is more than 0xFF. + + + + + True if cell is locked. + + + + + True if formula is hidden. + + + + + Flag for horizontal and vertical alignment, text wrap, indentation, + orientation, rotation, and text direction. + + + + + Flag for cell protection (cell locked and formula hidden). + + + + + Class used for parsing Excel 2007 workbooks. + + + + + Represents HLS max value. + + + + + Represents RGB max value. + + + + + Represents undefined HLS value. + + + + + Additional progress items + + + + + CarriageReturn ControlCharacters + + + + + LineFeed ControlCharacters + + + + + NullChar ControlCharacters + + + + + BackSpace ControlCharacters + + + + + Tab ControlCharacters + + + + + Content TypeSchema + + + + + Content Type NameSpace + + + + + Xml Schema NameSpace + + + + + Element Name + + + + + Name Attribute + + + + + Display Name Attribute + + + + + Internal Name Attribute + + + + + Ref attribute + + + + + Complex content + + + + + Represents string DoubleEqualSymbol + + + + + 3 Stars + + + + + 3 Triangles + + + + + 5 Boxes + + + + + Parent workbook. + + + + + Formula utils. + + + + + Dictionary with all available shape parsers. Key - shape instance value, + or o:spt value; Value - shape parser. + + + + + Theme colors list. + + + + + Dictionary of theme colors: key - theme color name, value - corresponding color. + + + + + Line styles + + + + + Contains list of ZipArchiveItem for background images + + + + + Parent element name. + + + + + Represents the current worksheet. + + + + + Represent the OutlineWrapperUtility object. + + + + + The number format indexes that are always serialized. + + + + + used to store the current theme colors for parsing + + + + + Regex pattern for decoding a encoded text. + + + + + Initializes new instance of the parser. + + Parent workbook. + + + + Converts theme color name into rgb color value. + + Color name to get rgb color value for. + Rgb color object that corresponds to the theme color. + + + + Converts theme color name into rgb color value. + + Color name to get rgb color value for. + Dictionary that holds theme color name and color. + Rgb color object that corresponds to the theme color. + + + + + + + + + + + + Parses the slicer cache item + + Represent the parent workbook + Represent the Xml reader + + + + Parses the slicer cache item + + Represent the parent workbook + Represent the Xml reader + Represent the slicer cache source name + Represent the slicer cache name + + + + Parses workbook part. + + XmlReader to extract workbook part data from. + Workbook relations. + Object that stores document data. + Absolute path in zip archive to the parent workbook. + Stream that will get all xml tags before worksheets. + Stream that will get all xml tags after named ranges section. + Workbook views collection. + + + + Parses Meta Properties + + File Data Holder + XML Reader + DataStream + Item Name + + + + Parses DocumentManagement Schema Elements + + List of elements in DocumentManagement + Xml Reader + + + + Parses DocumentManagement child Elements + + Xml Reader + + + + Parses workbook part. + + Xml Reader + + + + Gets meta property by name + + property name + Property + + + + Reads management child element + + Xml reader + name + Child count + + + + Parse pivot tables + + + + + Parse worksheets + + + + + + + Extracts pivot caches from the reader. + + Xml reader to get pivot caches data from. + + + + Extracts pivot cache from the reader. + + Xml reader to get data from. + + + + Parses FileSharing tag + + Reader to get data from. + + + + Parses workbook Pr tag and parses Date1904 value + + XmlReader to extract workbook part data from. + + + + Parses calculation tag and reads Precision + + XmlReader to extract workbook part data from. + + + + Extracts workbook protection options. + + XmlReader to extract protection options from. + + + + Parses workbook views. + + Reader to get data from. + Active sheet index. + Display tab index. + Workbook views collection. + + + + Parses workbook view. + + Reader to get data from. + Dictionary where key - attribute name, value - attribute value. + + + + Parses sheet (chart of worksheet). + + Reader to get data from. + Sheet to parse. + Absolute path to the parent worksheet item. + This stream will receive xml text starting just + after "worksheet" tag to "col" or "sheetData" tag. + This stream contains conditional formatting. + List with new style indexes (index - old + style index, value - new one). + Dictionary with archive items to remove after parsing. + + + + Parses worksheet before sheetData tag. + + + + + + + + + Parses sheet views. + + Reader to get data from. + Worksheet to place extracted data into. + + + + Parses single sheet view item. + + XmlReader to get data from. + Worksheet to put extracted data into. + + + + Extracts selection data. + + XmlReader to get data from. + Worksheet to put extracted data into. + + + + Extracts pane objects. + + XmlReader to get data from. + Worksheet to put extracted data into. + + + + Parses pane state. + + WindowTwo record that stores pane state flags. + State value to parse + + + + Extracts chart sheet from XmlReader. + + XmlReader to extract chart sheet data from. + Chart toi fill with data. + + + + Parses drawing associated with chartsheet. + + XmlReader that contains drawing data. + Chart to put extracted data into. + + + + Parse the drawing relations remove fallback items chart found + + input XML reader + input chart + input drawing file path name + data holder of chart + parent drawing relation of chart + + + + + + + + + + + Boolean value indicates whether the chart is chatEx or not. + + + + Extracts default row height from sheet format properties tag. + + XmlReader to get info from. + Worksheet to put settings into. + + + + Extracts Zero row height from sheet format properties tag. + + XmlReader to get info from. + Worksheet to put settings into. + + + + Parse the scenarios + + XmlReader to get data from + Worksheet to put data into + Represeent the scenarios to parse + + + + + + This methods extracts merged cells information from XmlReader. + + Reader to get merge information from. + Parent worksheet. + + + + This methods extracts named ranges from XmlReader. + + Reader to get information from. + + + + Parses styles of the workbook. + + XmlReader to read styles data from. + Stream that will get Dxfs formatting. + + + + Parses shared strings table. + + XmlReader to get data from. + Dictionary with updated string indexes. + + + + Parses string item. + + XmlReader to get data from. + Added string index. + + + + Parses string item. + + XmlReader to get data from. + Added string index. + + + + Parses Vml shapes. + + XmlReader to get data from. + Worksheet to put extracted shapes into. + Corresponding relations collection. + Path to the parent item. + + + + Extracts relations collection from XmlReader. + + Reader to extract data from. + Extracted relations collection. + + + + Extracts sheet data from reader and insets it into worksheet. + + XmlReader to get data from. + Worksheet to put data into. + List with new style indexes (index - old style index, value - new one). + Tag used for cell definition. + Dictionary with all attributes of sheetData tag. + + + + Parse xml document with comments data (author, text). + + XmlReader to get data from. + Worksheet to put extracted comments data into. + + + + Parse xml document with threaded comments + + XmlReader to get data from. + Worksheet to put extracted comments data into. + + + + Parse each threaded comment from the xml file + + XmlReader to get data from. + Worksheet to put extracted comments data into + threaded comment ojbect to store data from each each threaded comment + + + + Parse mentions within a threaded comment + + XmlReader to get data from. + Threaded comment to store mention list + + + + Parse each mention within mentions + + XML reader to get data from + mention to be parsed + + + + This method extracts drawings from specified XmlReader. + + XmlReader to extract data from. + Worksheet to place extracted shapes into. + Absolute path to the drawings. + List that will get relation id of the picture + (used to remove parsed relations after parsing). + Dictionary with archive items to remove after parsing. + + + + This method extracts drawings from specified XmlReader. + + XmlReader to extract data from. + Worksheet to place extracted shapes into. + Absolute path to the drawings. + List that will get relation id of the picture + (used to remove parsed relations after parsing). + Dictionary with archive items to remove after parsing. + + + + This method extracts all xml tags after SheetData tag. + + Reader to get data from. + Sheet to parse. + This stream contains conditional formatting. + Absolute path to the parent worksheet item. + Dictionary with archive items to remove after parsing. + + + + Parses the extensionlist. + + The reader. + The sheet. + + + + Parses the ext. + + The sheet. + The reader. + + + + Parses the slicer list + + The work sheet. + The Xml reader. + + + + Parses the sparkline groups. + + The sheet. + The reader. + + + + Parses the sparkline group. + + The reader. + The sheet. + + + + Parses the sparklines. + + The reader. + The sheet. + + + + + Parses the sparkline. + + The reader. + The sheet. + + + + + Parses the OLE objects. + + The reader. + The sheet. + + + + Parses the fallback. + + The reader. + The sheet. + + + + Parses the Fallback ole object + + The reader. + The sheet. + + + + Parses the OLE object. + + The reader. + The sheet. + The OLE object. + + + + Parses the objectPr. + + The reader. + The sheet. + The OLE object. + + + + Parses the Anchor value. + + The reader. + The sheet. + The OLE object. + + + + Extracts all table parts for the specified worksheet. + + Reader to get table parts from. + Worksheet to put extracted table parts into. + Path to the parent sheet object. + + + + Extracts table part. + + Reader to get table part from. + Worksheet to put extracted table part into. + Path to the parent sheet object. + + + + Extracts controls tag from a reader. + + XmlReader to get data from. + + + + + Parse the alternateContent form controls stream. + + + + + + + Parse choice element from controls stream. + + XmlReader + Current workhseet + + + + parse the control element from controls stream + + XmlReader + Current worksheet + + + + parse the controlPr element form controls stream + + XmlReader + Current worksheet + + + + Parse the anchor values for column, row, rowOffset, column offset. + + XmlReader + Current worksheet + + + + Extracts protection options. + + XmlReader to extract from. + Worksheet to put extracted protection options into. + + + + Checks single protection attribute and updates protection flags as necessary. + + XmlReader to get attribute value from. + Attribute name to check. + Flag value that corresponds to the protection attribute. + Default value of the attribute. + Current protection settings. + Updated protection settings. + + + + Checks single protection attribute and updates protection flags as necessary. + + XmlReader to get attribute value from. + Attribute name to check. + Flag value that corresponds to the protection attribute. + Default value of the attribute. + Current protection settings. + Updated protection settings. + + + + Extracts ignore error options from XmlReader. + + XmlReader to get data from. + Worksheet to put extracted data into. + + + + Extracts ignore error option from a reader. + + XmlReader to extract ignored error settings. + Worksheet to put extracted data into. + + + + Adds error indicator to the corresponding worksheet's collection. + + String representation of the cells with such options. + Ignore error options. + Parent worksheet. + + + + Extracts custom worksheet properties. + + XmlReader to get data from. + Worksheet to put extracted properties into. + + + + Extracts single custom property from specified reader. + + XmlReader to get data from. + Worksheet to put extracted data into. + + + + Gets the parsed XML value. + + The XML value. + + + + + + + + + + + + + Parses header/footer drawings. + + XmlReader to get data from. + Worksheet to put data into. + + + + This method parses Drawings xml tag (shapes). + + XmlReader to get data from. + Worksheet to put extracted data into. + Dictionary with archive items to remove after parsing. + + + + This method parses LegacyDrawings xml tag (vml shapes). + + XmlReader to get data from. + Worksheet to put extracted data into. + + + + Extracts single drawing defined by TwoCellAnchor tag name from the specified XmlReader. + + XmlReader to get shape data from. + Worksheet to put extracted shape into. + Absolute path to the drawings. + Relation ids that were parsed (to remove them from the collection later). + Dictionary with archive items to remove after parsing. + + + + Calculate chart with shapes position. + + Chart impl + chart width + chart height + + + + Parse group shape specified by "grpSp" tag and registers it in required collections. + + XmlReader to get shape data from. + Worksheet to put extracted shape into. + Absolute path to the drawings. + Relation ids that were parsed (to remove them from the collection later). + Created group shape object. + + + + Extracts shape specified by "sp" tag and registers it in required collections. + + XmlReader to get data from. + Parent worksheet. + Stream that will contains xml representation of the shape if necessary. + Absolute path to the drawings. + Created shape object. + + + + Checks and returns of type if AutoShape type is . + + Custom geometry's stream. + Parent Worksheet of the . + XmlReader to extract the properties. + + + + + Check whether the choice denotes chartEx or not + + input XML reader + the boolean value indicates the chartEx choice or not + + + + Parse AutoShape + + + + + + + Parse AutoShape + + AutoshapeImpl + XmlReader + Relation collection + + + + Parse custom geometry path of the freeform shape. + + XmlReader to extract data from. + object to set extracted data to. + + + + This method extracts all xml tags from group shape spPr element. + + Reader to get data from. + Group shape to parse. + + + + Extracts paragraph properties + + XmlReader to get data from. + autoShape to put data into. + + + + Parses the transformation2D of picture + + xmlreader object + picture being parsed + + + + Parses the transformation2D of group shape + + xmlreader object + group shape being parsed + + + + Tries to extract chart object from specified stream with GraphicFrame tag. + + Stream with GraphicFrame tag. + Parent worksheet. + Path to the drawing item. + Boolean value indicates whether the chart is chatEx or not. + Extracted chart shape; or null if chart wasn't located. + + + + Tries to extract chart object from specified stream with GraphicFrame tag. + + Stream with GraphicFrame tag. + Parent worksheet. + Path to the drawing item. + List that will get relation id of the picture. + Extracted chart shape; or null if chart wasn't located. + + + + Extract relation from group shape and remove it form lstRelationIds. + + Stream with GraphicFrame tag. + Picture stream or shape stream. + List that will get relation id of the picture. + + + + + + + + + + + + Extracts extent settings from reader and converts them into pixels. + + Reader to get extent data from. + Size of the shape in pixels. + + + + Parses EditAs attribute. + + Shape to set properties for. + Value to parse + + + + Sets shape anchor. + + Shape to set anchor for. + Rectangle that defines top-left shape's position in Excel 2007 units. + Rectangle that defines bottom-right shape's position in Excel 2007 units. + Width and height of the shape if extent token was present, -1 otherwise. + + + + Sets shape anchor. + + Shape to set anchor for + Rectangle that defines top-left shape's position in Excel 2007 units + Rectangle that defines bottom-right shape's position in Excel 2007 units. + + + + Converts anchor offsets from Excel 2007 units into Excel 97-2003 units (used by XlsIO). + + Rectangle with shape coordinates (left-top or bottom-right corner). + Parent worksheet. + Rectangle with converted values from Excel 2007 coordinates space into Excel 97-2003 coordinates. + + + + Extracts anchor point from the specified XmlReader. + + Reader to get data from. + Rectangle with extracted data. + + + + Parse the row and column emu value is convert to rectangle. + + XmlReader + + + + + Parse picture shape. + + XmlReader to get picture data from. + Worksheet to place extracted shape into. + Absolute path to the drawings. + List that will get relation id of the picture + (used to remove parsed relations after parsing). + Dictionary with archive items to remove after parsing. + + + + This method extracts shape properties from the specified XmlReader. + + XmlReader to get data from. + Shape to put extracted data into. + + + + Extracts blip data from the specified XmlReader. + + Reader to get blip data from. + Shape to put extracted data into. + Worksheet drawings relations collection. + Path to the parent item. + Parent file data holder. + List that will get relation id of the picture + (used to remove parsed relations after parsing). + Dictionary with archive items to remove after parsing. + + + + Parses blip tag and sets appropriate image to the specified shape. + + Reader to get data from. + Shape to put image into. + Collection with all drawings relations. + Path to the parent item (used to resolve related relation path). + Parent file data holder. + List that will get relation id of the picture + (used to remove parsed relations after parsing). + Dictionary with archive items to remove after parsing. + + + + Parses the Blip image. + + Reader to get data from. + Shape to put image into. + Collection with all drawings relations. + Path to the parent item (used to resolve related relation path). + Parent file data holder. + List that will get relation id of the picture + (used to remove parsed relations after parsing). + + + + Parses color change effect. + + Reader to get data from. + Picture shape to be parsed. + + + + Parse the Blip Extension List. + + Reader to get data from. + Shape to put image into. + Collection with all drawings relations. + Path to the parent item (used to resolve related relation path). + Parent file data holder. + List that will get relation id of the picture + (used to remove parsed relations after parsing). + + + + Parse blip image properties. + + Reader to get data from. + Shape to put image into. + Collection with all drawings relations. + Path to the parent item (used to resolve related relation path). + Parent file data holder. + List that will get relation id of the picture + (used to remove parsed relations after parsing). + + + + Read the SVG image data. + + Reader to get data from. + Shape to put image into. + Collection with all drawings relations. + Path to the parent item (used to resolve related relation path). + Parent file data holder. + List that will get relation id of the picture + (used to remove parsed relations after parsing). + + + + This method parses picture properties. + + Reader to extract data from. + Shape to put properties into. + + + + Parses non visual picture canvas properties. + + XmlReader to get data from. + Shape to place extracted data into. + + + + Parses non visual picture canvas extension properties. + + XmlReader to get data from. + Shape to place extracted data into. + + + + Parses shape id + + String shape id to parse. + Extracted shapeid or -1 if format was incorrect. + + + + Parses non visual canvas properties. + + XmlReader to get data from. + Shape to store extracted data. + + + + Parses non visual canvas properties. + + XmlReader to get data from. + Shape to store extracted data. + + + + Parses Click Hyper link properties. + + XmlReader to get data from. + Shape to store extracted data. + + + + Parses commentList tag. + + XmlReader to get data from. + List with comment authors. + Worksheet + + + + This method extracts single comment from the specified reader. + + XmlReader to get comment from. + List of comment authors. + Parent worksheet for the comment. + + + + Extracts authors from the specified reader. + + XmlReader to get list of comment authors from. + List with comment authors. + + + + Extracts shape from the reader. + + XmlReader to get shape settings from. + Dictionary with default shape settings. + Key - shape type, Value - default shape + Corresponding relations collection. + Path to the parent item. + Worksheet shapes Collection + Indicates whether the shape types defined ot not + + + + Extracts shape type from the specified reader. + + XmlReader to get shape type from. + Worksheet that is being currently parsed. + Dictionary that will get default shape for the current shape type. + + + + Extracts shape from the reader if shape type does not exist. + + XmlReader to get shape settings from. + Shape collection to process + Corresponding relations collection. + Path to the parent item. + + + + Parses rich text run. + + XmlReader to get data from. + Index of the added string. + + + + Extracts TextWithFormat from the specified XmlReader. + + XmlReader to get data from. + Tag that means that we have to stop parsing. + Parsed text with format. + + + + + + + + + + + Parses text content. + + XmlReader to get data from. + Parsed string index. + + + + Parses text content. + + XmlReader to get data from. + Parsed string index. + + + + Parses rich text run. + + XmlReader to get data from. + Index of the added string. + + + + Extracts named styles from specified XmlReader. + + XmlReader to get data from. + List with updated font indexes, index - font index + in the file, value - font index in our document (we can change indexes during parsing). + List with extracted fill objects. + List with extracted borders. + List with indexes of created extended formats. + + + + Extracts cell formats from specified XmlReader. + + XmlReader to get data from. + List with updated font indexes, index - font index + in the file, value - font index in our document (we can change indexes during parsing). + List with extracted fill objects. + List with extracted borders. + List with updated parent indexes, index - xfId in + the xml document, value - xf index in our internal collection. + List with indexes of created extended formats. + + + + Parses named style settings (name, etc.). + + XmlReader to get data from. + List with modified indexes to named + style's extended formats. + + + + Converts style name sting to Ascii string + + + + + + + Parses single style object. + + XmlReader to get data from. + List with modified indexes to named + style's extended formats. + + + + Extracts single extended format from the XmlReader. + + XmlReader to get data from. + List with updated font indexes, index - font index + in the file, value - font index in our document (we can change indexes during parsing). + List with extracted fill objects. + List with extracted borders. + List with updated parent indexes. + Created ExtendedFormat object. + + + + Parse alignment and protection properties for extended format + if they are present in the document. + + XmlReader to get data from. + ExtendedFormatRecord to put data into. + + + + Parses alignment settings. + + XmlReader to get alignment data from. + Record to write alignment data into. + + + + Parses protection settings. + + XmlReader to get protection data from. + Record to write protection data into. + + + + Extracts Include (IncludeAlignment, IncludeFont, etc.) attributes from XmlReader. + + XmlReader to get data from. + ExtendedFormat to put data into. + + + + This method extracts font, fill and border settings from specified + XmlReader and sets inside specified ExtendedFormat. + + XmlReader to get data from. + Extended format to put data into. + List with updated font indexes, index - font index + in the file, value - font index in our document (we can change indexes during parsing). + List with extracted fill objects. + List with extracted borders. + + + + Copies border settings from specified borders collection into ExtendedFormatImpl. + + BordersCollection to copy settings from. + Format object to copy into. + + + + Extracts single relation item from the reader and puts it into relations collection. + + XmlReader to extract relation from. + Relations collection that should get extracted value. + + + + Parses sheet options. + + XmlReader to extract sheet options from (name, visibility, relation, etc.). + Workbook relations. + Object that holds document data. + Absolute path in zip archive to the parent workbook. + + + + Parses Extension list + + XmlReader to extract slicer list. + Represents the relation of slicer. + Represents the file holder. + + + + Parses Extension list + + XmlReader to extract slicer list. + Represents the relation of slicer. + Represents the file holder. + + + + Parses sheet entry from workbook item. + + Reader to extract data from. + Workook's relations collection. + FileDataHolder that stores document data. + Absolute path in zip archive to the parent workbook. + + + + Sets sheet visibility. + + Worksheet to set visibility into. + Visibility string value. + + + + + + + + + + + + + Parse the scenario + + XmlReader to get data from + Worksheet to put data into + Represent the scenario to parse + + + + + Parse the scenario value and address + + XmlReader to get data from + Worksheet to put data into + Represent the scenario to parse + Represent the range collection + + + + Extracts single MergeRegion from reader and inserts it into collection inside worksheet. + + XmlReader to get data from. + Worksheet to put data into. + + + + Extracts single MergeRegion from reader and inserts it into collection inside worksheet. + + XmlReader to get data from. + Named range value. + + + + Extracts collection of number formats from specified reader. + + XmlReader to get data from. + + + + Extracts fonts from XmlReader. + + XmlReader to get data from. + List with new font indexes. + + + + Extracts font object from specified XmlReader. + + Reader to read font data from. + List to add new font index into. + + + + Extracts font object from specified XmlReader. + + Reader to read font data from. + Extracted font. + + + + Extracts font settings from specified XmlReader. + + Reader to read font data from. + Font to extract data into. + + + + Parses the family. + + The reader. + + + + + Extracts + + + + + + + Extracts collection of number formats from specified reader. + + XmlReader to get data from. + + + + Extracts single number format entry from specified reader. + + Reader to extract from. + + + + Extracts color from XmlReader. + + XmlReader to get data from. + Extracted color index (on the current moment we support only indexed colors). + + + + Extracts color from XmlReader. + + XmlReader to get data from. + Color object to put extracted values into. + + + + Extracts backgroundcolor from XmlReader. + + XmlReader to get data from. + Color object to put extracted values into. + + + + Applies tint to the specified color. + + Color to apply tint value to. + Tint value to apply. + Color after applying tint value. + + + + Applies tint to the specified color. + + Color to apply tint value to. + Tint value to apply. + The parsed color is updated or not + Color after applying tint value. + + + + Applies tint to the specified color. + + Color to apply tint value to. + Tint value to apply. + Color after applying tint value. + + + + Calculate double value from int. + + + double value + + + + Calculate int value from double. + + + int value. + + + + Converts color to HLS values. + + Color to convert. + Hue value. + Luminance value. + Saturation value. + + + + Converts color to HLS values. + + Color to convert. + Hue value. + Luminance value. + Saturation value. + + + + Converts HLS components to RGB color values and returns Color, according to this values. + + Hue value. + Luminance value. + Saturation value. + + + + + Converts HLS components to RGB color values and returns Color, according to this values. + + Hue value. + Luminance value. + Saturation value. + + + + + Converts Hue value to RGB single component. + + Magic number 1. + Magic number 2. + Hue value. + RGB component value. + + + + Extracts boolean value from the current xml tag. + + XmlReader to get value from. + Name of the attribute where value is stored. + Default value (when there is no attribute specified). + Extracted value. + + + + Extract value of the attribute from reader. + + XmlReader to get data from. + Name of the attribute to extract. + Extracted value; or null if there were no attribute with such name. + + + + Extracts fill objects from XmlReader. + + XmlReader to get data from. + List with all extracted fills. + + + + Extracts single fill object from specified XmlReader. + + XmlReader to read fill data from. + Indicates whether fore and back colors should be swapped. + Extracted Fill object. + + + + Extracts single gradient fill object from specified XmlReader. + + XmlReader to read gradient fill from. + Extracted gradient fill object. + + + + Extracts single path gradient fill object from specified XmlReader. + + XmlReader to read gradient fill from. + Extracted path gradient fill object. + + + + Extracts stop colors from specified XmlReader. + + XmlReader to read stop colors from. + Colors list. + + + + Extracts single linear gradient fill object from specified XmlReader. + + XmlReader to read linear gradient fill from. + Extracted linear gradient fill object. + + + + Sets gradients fill style and variant values according to degree value. + + Fill to set data into. + Degree value. + + + + Extracts attribute value. + + XmlReader to extract attribute value from. + Attribute name. + Attribute double value. + + + + Extracts pattern fill from specified XmlReader. + + XmlReader to get data from. + Indicates whether fore and back colors should be swapped. + Extracted fill object. + + + + Converts specified string in MS Excel 2007 pattern format into pattern value. + + Value to convert. + Converted value. + + + + Extracts border objects from XmlReader. + + XmlReader to get data from. + List with new borders indexes. + + + + Extracts border collection from specified XmlReader. + + XmlReader to get data from + Extracted borders collection + + + + Extracts border collection from specified XmlReader. + + XmlReader to get data from. + Extracted borders collection. + + + + Extracts single border from the XmlReader. + + XmlReader to get data from. + Output - index of the extracted border (left, top, etc.). + Extracted border. + + + + Parses alignment settings. + + XmlReader to get alignment data from. + Pivot cell format to write alignment data into. + + + + Parses protection settings. + + XmlReader to get protection data from. + Pivot cell format to write protection data into. + + + + Extracts row data from reader and inserts it into worksheet. + + XmlReader to get data from. + Worksheet to put data into. + Style hashtable. Key - recovered from xml extended format id, + value - extended format index in workbook collection. + Current row id. + + + + Extracts cell from reader and inserts it into worksheet. + + XmlReader to get data from. + Worksheet to put data into. + Style hashtable. Key - recovered from xml extended format id, + value - extended format index in workbook collection. + + + + Returns type of the cell. + + String representation of the cell type. + + + + + Extracts formula from reader and inserts it into worksheet. + + XmlReader to get data from. + Worksheet to put data into. + Current row index. + Current column index. + Extended format index. + + + + return formula type based on value. + + + + + Extracts and fills palette settings from specified XmlReader. + + XmlReader to get palette from. + + + + + + + + + + Parses columns collection. + + XmlReader to get data from. + Worksheet that will store extracted data. + List with new style indexes. + + + + + + + + + + + + + + + + + Extracts data validation from reader and inserts it into worksheet. + + XmlReader to get data from. + Worksheet to put data into. + + + + Extracts data validation from reader and inserts it into data validation collection. + + XmlReader to get data from. + Data validation collection. + + + + + + + + + + + Detext value of IsStrListExplicit property. + + + + + Parse data sorter information. + + XmlReader to get data from. + Worksheet to put data into. + + + + Parse data sorter information. + + XmlReader to get data from. + Worksheet to put data into. + + + + Parse data sorter information. + + XmlReader to get data from. + DataSoter to get data from. + Worksheet to put data into. + + + + Extracts data validation formula values from reader and inserts it into data validation. + + XmlReader to get data from. + Data validation implementation. + + + + Extracts auto filters from reader and inserts it into worksheet. + + XmlReader to get data from. + Worksheet to put data into. + + + + Extracts auto filters from reader and inserts it into worksheet. + + XmlReader to get data from. + AutoFilter Collection of a worksheet or ListObject to get data into. + + + + Extracts filter column from reader and inserts it into auto filter collection. + + XmlReader to get data from. + Auto filter collection to put data into. + + + + Extracts filters from reader and inserts it into auto filter. + + XmlReader to get data from. + Auto filter to put data into. + + + + Extracts color filter from reader and inserts it to autofilter + + XmlReader to get data from. + Auto filter to put data into. + + + + Extracts Icon Filter and inserts it into AutoFilters Collection. + + XmlReader to get data from. + AutoFilter to put data into. + + + + Extracts auto filter top ten from reader and inserts it into auto filter. + + XmlReader to get data from. + Auto filter to put data into. + + + + Extracts custom filters from reader and inserts it into auto filter. + + XmlReader to get data from. + Auto filter to put data into. + + + + Extracts custom filter from reader and inserts it into auto filter. + + XmlReader to get data from. + Auto filter to put data into. + + + + Return Condition operation + + The default condition + + + + Extract person's information from person.xml file + + XML reader object + parent workbook + + + + Extract each person's information from person.xml file + + XML reader object + parent workbook + + + + Extracts themes. + + XmlReader to get data from. + + + + Parse Theme Elements + + + + + + + Parses the format scheme + + Xml reader + + + + Parses the line styles + + + + + + + Get Font + + + + + + + Skips the white spaces in the XML. + + + + + + Extracts theme colors. + + XmlReader to get data from. + Dictionary that will be filled with theme colors, + key - color name, value - color value. + Returns theme colors list. + + + + Extracts Dxfs collection from XmlReader. + + XmlReader to extract data from. + List of Dxf styles. + + + + Extracts single Dxf style record from XmlReader. + + XmlReader to extract data from. + Dxf style object. + + + + Extracts worksheet conditional formats from XmlReader. + + XmlReader to extract data from. + Worksheet conditional formats. + Dxf styles collection. + + + + Parse the Table styles. + + + + + Parse the dxfs styles to store list. + + Return file data holder, used for parse the dxfs collection + + + + Parse the table styles and attributes. + + Xml reader + List of the dxfs styles + + + + Parse tha table style and attributes. + + Xml reader + Table style object + List of the dxfs style + + + + Parse the table style element and attributes. + + XmlReader + Table style element object + List of the dxfs styles + + + + Updates the usedRange. + + + + + Extracts conditional formats from XmlReader. + + XmlReader to extract data from. + Conditional formats. + Dxf styles collection. + + + + Updates the CRRange in used Range. + + address of conditional format.s + Worksheet. + + + + Parses the Range Reference for Conditional formatting + + XmlReader to extract data from + Conditional format value + + + + Parses conditional formatting rule tag. + + XmlReader to extract data from. + Condition to extract data into. + Dxf styles collection. + + + + Parses conditional formatting rule tag. + + XmlReader to extract data from. + Condition to extract data into. + Dxf styles collection. + Conditional format range address + + + + Extracts conditional formats single condition from XmlReader. + + XmlReader to extract data from. + Condition to extract data into. + Dxf styles collection. + + + + Extracts color scale from the reader. + + XmlReader to get data from. + Color scale to fill. + Parent workbook. + + + + Extracts data bar object from the reader. + + XmlReader to get data from. + Data bar to put extracted data into. + Parent workbook. + + + + Extracts icon set object from the reader. + + XmlReader to get icon set from. + Icon set object to put extracted data into. + Parent workbook. + + + + Extracts conditional format value object from reader. + + XmlReader to get data from. + Parent workbook. + Condition object to put extracted data into. + Extracted object. + + + + Converts string representation of conditional format value object type to corresponding enumeration. + + String value to convert. + Converted enumeration object. + + + + Extract conditional format formulas. + + Reader to get values from. + Conditional format to put extracted formulas into. + + + + Parses print options. + + XmlReader to parse print options from. + PageSetup object to put print options into. + + + + Parses page margins. + + XmlReader to get values from. + Object to put extracted values into. + + + + Serialize PageSetup tag. + + XmlReader to get page setup values from. + Object to put extracted values into. + + + + Parse header footer tags. + + XmlReader to get all necessary data from. + Object that would store all extracted settings. + + + + Converts string into ExcelPrintLocation. + + Value to convert. + Converted value. + + + + Converts string value to ExcelPrintErrors. + + Value to convert. + Converted value. + + + + Extracts hyperlinks from reader and inserts them into worksheet. + + XmlReader to get data from. + Worksheet to put data into. + + + + Extracts hyperlink from reader and inserts it into worksheet. + + XmlReader to get data from. + Worksheet to put data into. + Hyperlinks collection to insert link into. + Relations collection. + + + + Extracts sheet-level properties from reader and inserts it into worksheet. + + XmlReader to get data from. + Worksheet to put data into. + + + + Parses worksheet page setup properties. + + Reader to extract data from. + Object to put extracted data into. + + + + Parses worksheet outline properties. + + Reader to get data from. + Page setup to put data into. + + + + Extracts background image from reader and inserts it into worksheet. + + XmlReader to get data from. + Worksheet to put data into. + Worksheet parent path. + + + + Parses the CustomXmlParts + + XmlReader + Schema Reference + + + + Parses the CustomXmlParts + + XmlReader + Schema Reference + + + + Parses the Each Schemas and added to Schema collections + + XmlReader + Schema Reference + + + + Extracts core properties from reader and inserts it workbook. + + XmlReader to extract core properties from. + + + + Extracts extended properties from reader and inserts it workbook. + + XmlReader to extract extended properties from. + + + + Extracts custom properties from reader and inserts it workbook. + + XmlReader to extract custom properties from. + + + + Extracts custom property from reader and inserts it into custom property implementation. + + XmlReader to extract data from. + Custom property. + + + + Parses external link file. To set URL field we have to have access to + relations, so it is better to do it in some other place. + + XmlReader to get data from. + Item's relations. + + + + Parses external link file. To set URL field we have to have access to + relations, so it is better to do it in some other place. + XmlReader to get data from. + Item's relations. + + + + Parses the OLE object link. + + The reader. + The relations. + + + + + + + + + + + Adds default sheet into the external workbook, if the sheet is empty. + + External Workbook + Realtions + Relation Id + External Workbook + + + + Extracts external names from the reader. + + XmlReader to get data from. + External workbooks to put defined names into. + + + + Extracts single external name from the reader. + + XmlReader to get external name data from. + External workbook to put extracted name into. + + + + Extracts cached external data. + + XmlReader to get data from. + External workbook to put cache into. + + + + Extracts single external worksheet cached data from XmlReader. + + XmlReader to get cached data from. + External workbook to place extracted data into. + + + + Creates external workbook. + + Relations collection that helps to locate external workbook. + Relation id of the target workbook. + Name of the workbook's worksheets. + + + + + Extract names of external worksheets from the reader. + + XmlReader to get data from. + List with extracted names. + + + + Extracts horizontal pagebreaks from reader. + + XmlReader to extract data from. + Worksheet to insert pagebreaks in. + + + + Extracts vertical pagebreaks from reader. + + XmlReader to extract data from. + Worksheet to insert pagebreaks in. + + + + Parses workbook part of the external links description. + + Reader to get data from. + + + + Parses single external link from the workbook. + + Reader to get link information from. + + + + Parse external connection + + + + + + Parse external connection + + + + + + Parse parameters + + + + + + Parse parameter + + + + + + Parse Custom Workbook views + + Reader to get data from. + List of Custom workbook view as Dictionary + + + + Parse dynamic filter. + + Reader to get data from. + Auto filter collection to put data into. + + + + Parse DataBase Property + + + + + + + Parse Web Properties + + + + + + + Dispose + + + + + Creates cell record. + + Cell type. + Record value. + Current cells collection. + Represents column index. + Represents row index. + Represents extended format index. + + + + Sets formula value. + + Worksheet to set formula value into. + Cell type. + Value to set. + Represents row index. + Represents column index. + + + + Sets array formula record into worksheet. + + Worksheet to put data into. + Formula string to insert. + Cell range of the formula. + Extended format index. + + + + Sets shared formula record into worksheet. + + Worksheet to put data into. + Formula string to insert. + Cell range of the formula. + Shared formula group index. + Current row index. + Current column index. + Extended format index. + + + + Converts Excel 2007 data validation type to Excel 97-03. + + Excel 2007 data validation type. + Excel 97-03 data validation type. + + + + Returns DV error style. + + DV error style name. + DV error style. + + + + Returns DV compare operator. + + DV compare operator name. + + + + + Returns DV ranges. + + All ranges for DV. + DV ranges array. + + + + Returns DV or AF range. + + DV or AF range string. + DV range. + + + + Returns excel filter condition. + + Filter condition string name. + Excel filter condition. + + + + Returns excel CF type value. + + CF type sting name. + Defines whether current type is currently supported.| + Excel CF type value. + + + + Returns excel comparison operator. + + Operator string name. + Defines whether current operator is currently supported. + Excel operator value. + + + + Returns the time period type + + + + + + + + Returns xml element value. + + XmlReader to get value from. + Xml element value. + + + + Converts color by applying shade value. + + Color to process. + Shade to apply. + Modified color. + + + + Converts color by applying shade value. + + Color to process. + Shade to apply. + Modified color. + + + + Converts Control unicode Character to ASCII . + + String Value. + Modified ASCII String. + + + + Parse extention list for data bar type + + Xml reader + Conditional format + + + + Parsing extention CFrules for data bar type + + Xml reader + Conditional formats of the sheet + + + + Check extention id with the conditional format + + Id commonly used in extention and conditional format + sheet where the conditional formating applied + Conditional Format for the extention + Conditional format object if the id is available else return null + + + + Parse extention for the Data bar + + Xml reader + Data bar object + workbook where the conditional format is applied + + + + Parses the custom icons. + + Xml reader object. + Icon set object. + + + + Copies fill settings from fill object into extended format. + + Fill to copy from. + Extended format to copy into. + + + + Parse the theme overrided colors from the chart + + Input chart object + the parsed theme colors + + + + Intialize and parse XmlMaps. + + XML reader + + + + Gets FformulaUtil that corresponds to invariant culture. + + + + + Gets the worksheet. + + The worksheet. + + + + Properties store the current theme colors for parsing + + + + + This class is responsible for xml spreadsheets parsing. + + + + + Represents current xml version. + + + + + Represents current xml version. + + + + + Represents current application version. + + + + + Represents current application version enclosed in single quotes. + + + + + Represents current application node name. + + + + + Represents o namespace. + + + + + Represents x namespace. + + + + + Represents ss namespace. + + + + + Represents html namespace. + + + + + Represents xml subscript value. + + + + + Represents xml superscript value. + + + + + Represents rtf bold. + + + + + Represents rtf Italic. + + + + + Represents rtf Underline. + + + + + Represents rtf strikethrough. + + + + + Represents rtf span. + + + + + Represents rtf sub. + + + + + Represents rtf sup. + + + + + Represents rtf font. + + + + + Represents default font size. + + + + + Represents none constant. + + + + + Default font name. Used when font name is not specified. + + + + + Represents current version of xml file + + + + + represent default Xml Version + + + + + Represents style dictionary. + Key - Recovered from xml stream unique id, value - XF index in workbook collection. + + + + + Represents parent workbook. + + + + + Represents array list, that contain formula string to reparse. + + + + + Represents array with formulas to reparse. + + + + + Formula utils. + + + + + Represents dictionary with alignment horizontal types. + + + + + Represents hashtable with alignment vertical types. + + + + + Represents dictionary with number format types. + + + + + Initialize all static collections. + + + + + Initialize new instance of current class. + + Current application. + Parent object for class. + + + + Gets worksheet from xml. + + Xml reader. + Workbook to fill. + Returns new instance of WorkSheet. + + + + Read table from xml. + + Xml reader. + Worksheet to fill. + + + + Reads row from xml stream. + + Xml reader. + Sheet that contain current row. + Represents row index. + Returns updated row index. + + + + Read column info. + + Xml reader. + Represents current worksheet. + Column index. + Returns updated column index. + + + + Read cell from xml stream. + + Xml reader. + Current sheet. + Represents row index. + Represents column index. + + + + Parses hyperlink data. + + XmlReader to get necessary data from. + Worksheet that is being parsed. + Zero-based row index of the cell. + Zero-based column index of the cell. + + + + Reads record from xml stream. + + Xml reader. + Represents cell records collection. + Represents XF index. + Type of the extracted data. + Object to store extracted rtf string inside. + Returns created record. + + + + If can adds merge record to collection. + + XmlReader to get data from. + Current sheet. + Row index.( Zero based ) + Column index.( Zero based ) + Represents XF index. + Number of cells merged across. + + + + Reads styles from xml stream. + + Xml reader. + Current workbook. + + + + Reads custom style from xml stream. + + Xml reader. + Current workbook. + + + + Reads alignment properties from xml stream. + + Xml reader. + XF format to fill. + + + + Reads font properties from xml stream. + + Xml reader. + Represents XF format, which fill from xml stream. + + + + Reads interior from xml stream. + + Xml reader. + Parent XF format. + + + + Reads number format from xml stream. + + Xml reader. + Parent XF format. + + + + Reads protection properties from xml stream. + + Xml reader. + Parent XF format. + + + + Reads borders from xml stream. + + Xml reader. + Current xf format. + + + + Reads border from xml stream. + + Xml reader. + Current extended format. + + + + Reads worksheet options from xml. + + Xml reader. + Worksheet to fill. + + + + Reads DataValidation from xml. + + Xml reader. + Worksheet to fill. + + + + Reads DataValidation from XML + + Xml reader. + Worksheet to fill. + + + + Converts Excel 2007 data validation type to Excel 97-03. + + Excel 2007 data validation type. + Excel 97-03 data validation type. + + + + Returns DV error style. + + DV error style name. + DV error style. + + + + Returns DV ranges. + + All ranges for DV. + DV ranges array. + + + + Gets the Ranges for the data validations or conditional formats + + Ranges in R1C1 format + Worksheet to fill. + + + + Convert Biff record TAddr to Selection record TAddr + + + + + + + Reads the conditional formats + + Xml reader. + Worksheet to fill. + + + + Pareses the conditions + + Xml reader. + ConditonalFormats + Worksheet to fill. + + + + Parses each elements in the condtion + + Xml reader. + ConditonalFormats + Ranges to fill + + + + Parses each elements in the condtion + + + + + + + + Parses Each conditional format settings from JSON string. + + FormattingValues represented in JSON type + CondtionalFormatImpl + + + + Reverses the Array + + Bordersettings + + + + Get the ExcelLineStyle for border + + array of styles + + + + Gets ExcelComparisonOperator + + Operator + ExcelComparisonOperator + + + + Parses worksheet visibility option. + + XmlReader to get option from. + Worksheet to set option to. + + + + Reads page setup from xml. + + Xml reader. + Worksheet to fill. + + + + Reads header/footer from xml. + + Xml reader. + Worksheet to fill. + + + + Reads page setup layout from xml. + + Xml reader. + Worksheet to fill.> + + + + Reads page margins from xml. + + Xml reader. + Worksheet to fill. + + + + Reads panes from xml. + + Xml reader. + Worksheet to fill. + + + + Reads selection pane from xml. + + Xml reader. + Worksheet to fill. + + + + Reads print options from xml. + + Xml reader. + Worksheet to fill. + + + + Reads named ranges from xml stream. + + Xml reader. + Collection of named ranges. + Represents sheet index ( One based ).Zero if global name. + + + + Reads single named range from xml stream. + + Xml reader. + Represents collection, of named ranges. + Represents sheet index ( One based ).Zero if global name. + + + + Reads comment from xml stream. + + Xml reader. + Current comment to fill from xml stream. + Represents default XF index. + + + + Reads comment rtf text. + + Xml reader. + XF index. + Initialize text with format, by read from xml stream rtf properties. + + + + Reads workbook from xml + + Xml reader. + Book to fill. + Returns error code. + + + + Read workbook node. + + Xml reader. + Book to fill. + + + + Gets extended format from xml value. + + Unique id. + Represents parent XF collection. + Name of style. + Parent name. + + + + + Adds format to collection. + + Format to add. + Parent workbook. + Parent XF collections. + Unique xml id of XF format. + Unique xml name of XF format. + + + + Gets color from xml value. + + Represents xml color. + Returns color. + + + + Sets font alignment. + + Represents font alignment. + Current font. + Returns initialized font. + + + + Creates cell record. + + Cell type. + Record value. + Current cells collection. + Represents column index. + Represents row index. + Represents xf index. + Represents Rich Text Format to set. + + + + Gets XF index for current cell. + + Parent sheet. + Value, that represents current xf id. + Returns valid index in Inner ExtFormats collection. + + + + Gets line style by style and weight. + + Represents one of xml line style type. + Represents weight of line. + Returns excel line style. + + + + Reparses names read from xml stream. + + Parent workbook. + + + + Reads rtf from xml stream. + + Xml reader. + Index to XF record. + Represents rtf holder. + Returns read from stream string value. + + + + Updates font reading from xml stream. + + Represents xml reader. + Current font to update. + Local rtf node name. + if true - update endelement. + Returns updated font. + + + + Read rtf font. + + Xml reader. + Font to update. + Returns updated font. + + + + Parse formula from xml stream. + + Current sheet. + One based row index. + One based column index. + Represents string formula in R1C1 style. + Represents XFindex. + String representation of the formula value. + Type of the value in the formula. + + + + Sets formula to the specified cell. + + Parent worksheet. + One-based row index. + One-based column index. + String represetation of the formula. + String representation of the formula value. + Type of the formula value. + + + + Sets formula value. + + Parent worksheet. + One-based row index. + One-based column index. + String representation of the formula value. + Type of the formula value. + + + + Reparse formula. + + Parent workbook. + + + + This class is responsible for vml comment shape parsing. + + + + + Extracts shape type settings from the reader and creates shape with default settings. + + XmlReader to get general shape settings from. + Parent worksheet for the shape. + Shape with default settings without adding it to any collection + + + + Tries to parse unknown client data tag. + + Reader to get data from. + Shape to put data into. + + + + Parses style properties. + + Textbox to put properties into. + String representation of the style properties + (key - property name, value - property value). + + + + Parses visibility options. + + Comment to set visibility for. + Dictionary with comment properties. + + + + Parses autosize options. + + Comment to set visibility for. + Dictionary with comment properties. + + + + Registers shape in all necessary collections. + + Shape to register. + + + + Creates shape with default settings + + Worksheet Shape Collection + Shape with default settings + + + + This class is used to parse text box shape. + + + + + Extracts text box settings from XmlReader. + + TextBox to fill with settings. + XmlReader to get data from. + Parser used to help in parsing process. + + + + Extracts text box settings from XmlReader. + + TextBox to fill with settings. + XmlReader to get data from. + Parser used to help in parsing process. + + + + Parses non visual shape properties. + + Shape to be parsed. + XML reader to extract data from. + Parser used to help in parsing process. + + + + Parses shape properties. + + TextBox to be parsed. + XML reader to extract data from. + Parser used to help in parsing process. + + + + Parses rich text. + + XmlReader to read rich text from. + Parser object that helps to extract data. + TextBox to be parsed. + + + + Parses text area body properties. + + XmlReader to read body properties from. + Text area to put body properties into. + Textbox to be parsed. + + + + Parses text rotation value. + + Rotation value to parse. + TextBox to put extracted value into. + + + + Parses anchor (vertical alignment). + + Anchor value to parse. + TextBox to put extracted value into. + + + + Extracts list styles for a text area. + + XmlReader to extract list styles from. + Text area that will get extracted settings. + + + + Parses level properties in List styles. + + XmlReader + RichText + + + + Parses the Default run properties. + + + + + + + Parses paragraph. + + XmlReader to get paragraph tag from. + Text box that needs its paragraph text to be parsed. + Parser object that helps to extract data. + + + + Parse text field. + + XmlReader to get paragraph tag from. + Text box that needs its paragraph text to be parsed. + Text area to put extracted properties into. + Parser object that helps to extract data. + + + + Extracts paragraph properties + + XmlReader to get data from. + TextBox to put data into. + + + + Parses bullet font. + + Xml reader + Text + + + + Parses paragraph run. + + XmlReader to get paragraph run from. + Text area to put extracted properties into. + Parser object that helps to extract data. + + + + Parses paragraph run. + + XmlReader to extract paragraph tag from. + Text area that will get paragraph run information (formatting and text). + Parser object that helps to extract data. + Font attributes of the paragraph run. + + + + Serialize line properties. + + XmlReader to serialize into. + Chart line properties to serialize. + Indicates whether border is rounded or not + Excel2007Parser to help in extraction process. + + + + Serialize line properties. + + XmlReader to serialize into. + Chart line properties to serialize. + Excel2007Parser to help in extraction process. + + + + This is parser of unknown vml shapes. + + + + + Extracts shape type settings from the reader and creates shape with default settings. + + XmlReader to get general shape settings from. + Parent worksheet for the shape. + Shape with default settings without adding it to any collection + + + + Parses shape and adds it to all necessary shapes collections. + + XmlReader to get shape from. + Default shape that must be cloned to get resulting shape. + Corresponding relations collection. + Path to the parent item (item which holds all these xml tags). + + + + Creates new Unknown shapes serializator. + + Shape instance used to choose correct shape serializator. + XmlReader to get shape from. + Represents current worksheet. + + + + Creates shape with default settings + + Worksheet Shape Collection + Shape with default settings + + + + Adds slash ('/') before the file name if necessary. + + + + + Initializes a new instance of the AddSlashPreprocessor class. + + + + + Somehow converts full path into name that will be stored in the zip archive. + + Name to process. + Converted name. + + + + Class used for representing chart axis scale. + + + + + Represents logarithmic scale. + + + + + Indicates whether datapoint plot from last to first. + + + + + Represents maximum value. + + + + + Represents minimum value. + + + + + Represents the log base. + + + + + Method used to copy the axis scale. + + Represents Chart value axis. + + + + This class is responsible for chart axis serialization. + + + + + Defines text rotation multiplier constant. + + + + + Represents dictionary for TickLabel to Attribute value. + + + + + Represents dictionary for TickMark to Attribute value. + + + + + Initializes static members of the ChartAxisSerializator class. + + + + + Serializes chart axis. + + XmlWriter to serialize into. + Axis to serialize. + + + + Serializes date axis. + + XmlWriter to serialize into. + Axis to serialize. + + + + Convert date unit to string. + + ExcelChartBaseUnit to serialize. + Date unit as string. + + + + Serializes category axis. + + XmlWriter to serialize into. + Axis to serialize. + + + + Serializes value axis. + + XmlWriter to serialize into. + Axis to serialize. + + + + Serializes series axis. + + XmlWriter to serialize into. + Axis to serialize. + + + + Serializes common part of the axis. + + XmlWriter to serialize into. + Axis to serialize. + + + + Returns pair for the specified axis, it is category axis for value axis and vice versa. + + Axis to get pair for. + Pair for the specified axis. + + + + Serializes cross axis. + + XmlWriter to serialize into. + Axis to serialize. + + + + Serializes tick mark. + + XmlWriter to serialize into. + Tag name to use. + Tick mark to serialize + + + + Serializes tick label position. + + XmlWriter to serialize into. + Axis to get tick label position from. + + + + Serializes number format used by the axis. + + XmlWriter to serialize into. + Axis to serialize number format for. + + + + Serializes axis gridlines. + + XmlWriter to serialize into. + Axis to serialize gridlines for. + + + + Serializes single gridline object. + + XmlWriter to serialize into. + Gridlines to serialize. + Name of the xml tag to use. + Parent workbook. + + + + Serializes axis position. + + XmlWriter to serialize into. + Axis to serialize. + + + + Serializes scaling tag and all necessary child tags. + + XmlWriter to serialize into. + Axis to serialize settings for. + + + + Serializes display unit. + + XmlWriter to serialize into. + Value to serialize. + Custom unit value (used only if displayUnit is set to custom). + + + + Serializes text settings. + + XmlWriter to serialize into. + Axis to serialize settings for. + + + + Serializes text settings. + + XmlWriter to serialize into. + + + + Object that gives access to border, interior and fill of the ChartSerieDataFormatImpl. + + + + + Provides access to filling options (border, interior and fill) of some chart object. + + + + + Gets border object. Read-only. + + + + + Gets interior object. Read-only. + + + + + Gets fill object. Read-only. + + + + + Gets Shadow object.Read-only + + + + + Gets the three_ D.Read-only + + + + + Parent data format to get fill objects from. + + + + + Initializes a new instance of the ChartFillObjectGetter class. + + Parent data format. + + + + Gets chart border object. Read-only. + + + + + Gets chart interior object. Read-only. + + + + + Gets chart fill object. Read-only. + + + + + Gets Shadow object.Read-only + + + + + + Gets the three_ D.Read-only + + + + + + Object that gives access to border, interior and fill. + + + + + Border object. + + + + + Interior object. + + + + + Fill object. + + + + + Shadow object + + + + + Three_D object + + + + + Initializes a new instance of the ChartFillObjectGetterAny class. + + Border object to use. + Interior object to use. + Fill object to use. + + + + Gets border object. Read-only. + + + + + Gets chart interior object. Read-only. + + + + + Gets fill object. Read-only. + + + + + Gets Shadow object.Read-only + + + + + + Gets the three_ D.Read-only + + + + + + This class is responsible for charts parsing. + + + + + This element represents end paragraph tag with language attribute. + + + + + This List contains the owner index count. + + + + + Chart Parser + + + + + + Extracts chart from XmlReader. + + XmlReader to serialize into. + Chart to serialize. + Chart item relations. + + + + Parse the stream and set the style id for the chart + + input alternate content stream + the input chart + + + + Parses the Chart default text properties. + + The Xml reader to parse from. + The chart to put the extracted data. + + + + Parses chart body properties + + + + + + + Parses Chart Paragraph Properties + + + + + + + Checks Default Text Settings for the axis. + + + + + Parses the extension list. + + The reader. + The chart. + + + + Parses the extension. + + The reader. + The chart. + + + + Parses the pivot options. + + The reader. + The chart. + + + + Parses the pivot options. + + The reader. + The chart. + + + + Extracts chart print settings from the reader. + + XmlReader to get data from. + Chart to put extracted data into. + Chart relations. + + + + Extracts pivot source. + + XmlReader to get pivot source from. + Chart to put extracted pivot source into. + + + + Parses user shapes. + + XmlReader to serialize into. + Chart to serialize. + Chart item relations. + + + + Parses main chart xml tag. + + XmlReader to extract data from. + Chart to put extracted data into. + Chart's relations. + + + + Parse the Extension list of chart + + input XML reader + Chart to put extracted extension lis info. + + Exception is thrown when reader or chart is null + + + + Parse the Extension element list of chart. + + input XML reader + Chart to put extracted extension element list. + Exception is thrown when reader or chart is null + + + + Parse the Data Display Options of extension. + + input XML reader + Chart to put extracted data display value. + Exception is thrown when reader or chart is null + + + + Parse the chart title / legend attributes for chart Ex + + input XML reader + output isoverlay boolean value + output position value + + + + Extracts pivot formats. + + XmlReader to get pivot formats from. + Chart to put extracted pivot formats into. + + + + Copies 3D settings from Chart3DRecord into chart. + + Chart to copy data into. + Record to copy data from. + + + + Extracts chart legend from XmlReader. + + XmlReader to extract data from. + Chart legend to put extracted data into. + Chart object that stores specified legend. + Chart relations collection. + + + + Convert the chartExLegend position and returns the chart legend position + + position short value + the chart legend position value + + + + Extracts legend entry from specified reader. + + XmlReader to extract legend entry from. + Legend to put extracted legend entry into. + Excel2007Parser object to use if necessary. + + + + Extracts 3-D view options from XmlReader. + + XmlReader to get data from. + Chart to put extracted options into. + Record with 3D view settings. + + + + Serializes error bars. + + XmlReader to extract data from. + Series to put extracted error bars into. + Chart item relations. + + + + Extracts error bar range. + + XmlReader to extract data from. + Represents Workbook. + Extracted range. + + + + Extracts trendlines collection. + + XmlReader to extract data from. + Series to put extracted data into. + Chart item relations. + + + + Extracts trend line. + + XmlReader to extract data from. + Series to put extracted data into. + Chart item relations. + + + + Extracts trend line label settings. + + XmlReader to extract data from. + Data label to serialize. + + + + Serializes surface (wall or floor). + + XmlWriter to serialize into. + Surface to serialize. + Parent data holder. + Drawing's relations. + + + + Extracts plotarea tag from XmlReader. + + XmlReader to get data from. + Chart to put extracted data into. + Chart item relations. + + + + parse the bar chart + + + + + Parses bar chart. + + XmlReader to extract chart from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Parse the Filtered Series + + + + + + + + + + + + Stores extracted axis id inside structures for future use. + + XmlReader to get data from. + Series list. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Parses bar 3D chart. + + XmlReader to extract chart from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts shape of the bar chart. + + XmlReader to extract data from. + First series in the list of series with the + same formatting. + + + + Extracts shape of the bar chart. + + XmlReader to extract data from. + Chart serie data format. + + + + Extracts part of the bar chart that is common for all bar charts. + + XmlReader to extract data from. + Chart to put extracted data into. + Chart item relations. + Indicates whether we are parsing 3D chart. + List that will get extracted series. + First extracted series. + + + + Parse Secondary Axis Filter + + + + + + + + + + + + + When we parsing the categoryfiltered chart, we need to find the filtered category + + + + + + + + + + Calculate the Filtercategroies values + + start row of the range + end row of the range + array of the range filter categorires + chart categories values + categories Lenth position value + catergores position value + + + + Supporting method for Find Filter + + + + + + + + Find the series or category Range + + + + + + + + + Find series in Row or Column. + + + + + + + Converts direction and grouping values into type of bar series. + + Represents direction of bar series. + Represents series grouping value. + Indicates whether we are parsing 3D chart. + Extracted chat type. + + + + Converts direction and grouping values into type of bar series. + + Represents direction of bar series. + Represents series grouping value. + Indicates whether we are parsing 3D chart. + Extracted chat type. + + + + Converts grouping value into type of area series. + + Area series grouping value. + Indicates whether we are parsing 3D chart. + Area chart type that corresponds to grouping and is3D values. + + + + Converts grouping value into type of line series. + + Line series grouping value. + Indicates whether we are parsing 3D chart. + Line chart type that corresponds to grouping and is3D values. + + + + Extracts area3D chart. + + XmlReader to extract data from. + Chart to serialize. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts area chart from XmlReader. + + XmlReader to get data from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts properties common to the area chart. + + XmlReader to extract data from. + Chart to put extracted data into. + Indicates whether we are parsing 3D chart. + Chart item relations. + List that will get extracted series. + + + + This method extracts common properties of the line charts. + + XmlReader to extract data from. + Chart to put extracted data into. + Indicates whether we are parsing 3D chart. + Chart item relations. + List that will get extracted series. + One of the extracted series. + + + + Extracts line3DChart from XmlReader. + + XmlReader to extract line 3d chart from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts line chart. + + XmlReader to extract data from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts bubble chart. + + XmlReader to extract data from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts 2-D surface chart from XmlReader. + + XmlReader to extract data from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts common part of the surface charts. + + XmlReader to extract data from. + Chart to put extracted data into. + Indicates whether we are parsing 3D chart. + Chart item relations. + List that will get extracted series. + + + + Extracts band formats from the stream. + + + + + + + Returns type of the series to create. + + Indicates whether surface is wireframe or not. + Indicates whether we are parsing 3D chart. + Surface chart type. + + + + Extracts radar chart. + + XmlReader to extract data from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts scatter chart. + + XmlReader to extract chart from. + Chart to serialize. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts pie chart. + + XmlReader to extract data from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts 3-D pie chart. + + XmlReader to extract data from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts pie of pie or pie of bar chart. + + XmlReader to extract data from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts stock chart. + + XmlReader to extract from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts hi-low lines or drop lines object from xml reader. + + XmlReader to extract data from. + Series object to extract. + + + + Extracts doughnut chart. + + XmlReader to extract data from. + Chart to put extracted data into. + Chart item relations. + Dictionary with axis id, key - series index, value - axis index (category or value). + + + + Extracts common properties of a pie charts. + + XmlReader to extract data from. + Chart to put extracted data into. + Type of the series to create. + Chart item relations. + List that will get extracted series. + One of the parsed series. + + + + Extracts data lables. + + XmlReader to extract data from. + Parent series. + Chart item relations. + Indiactes whether the series or chartEx series or not + + + + Serializes data label for single data point. + + XmlReader to extract data from. + Chart series to put extracted data into. + Chart item relations. + Boolean value indicates whether the series is chartEx series or not + + + + + Parse the DataLeabels extension lists + + XmlReader to extract data from. + Data labels to put extracted data into. + File Data Holder + Chart item relations. + + + + Parse the DataLables Extension and leaderlines. + + XmlReader to extract data from. + Data labels to put extracted data into. + File Data Holder + Chart item relations. + + + + Parse the DataLables leader lines. + + XmlReader to extract data from. + Data labels to put extracted data into. + File Data Holder + Chart item relations. + + + + Parse the data label visibilty settings for chart series + + input XML reader + Data labels visibilty to be set + + + + Parses single chart series of a bar chart. + + XmlReader to extract series from. + Parent chart object. + Type of the series to create. + Extracted chart series. + Chart item relations. + + + + Parse Series or category name filter + + + + + + + Parse Extension. + + XmlReader + Chart serie + + + + Parse data labels range. + + Xml reader + Chart series. + + + + parse datalabel range cache. + + Xml reader. + Chart series. + + + + Parses single chart series of a surface chart. + + XmlReader to extract series from. + Parent chart object. + Type of the series to create. + Extracted chart series. + Chart item relations. + + + + Extracts single chart series for pie chart. + + XmlReader to extract data from. + Chart to put extracted data into. + Type of the series to extract. + Chart item relations. + Extracted series. + + + + Extracts line series. + + XmlReader to extract data from. + Chart to put extracted series into. + Type of the extracted series. + Chart item relations. + Extracted series. + + + + Extracts scatter series. + + XmlReader to extract series data from. + Chart to put extracted series into. + Type of the series to extract. + Chart item relations. + Extracted series. + + + + Extracts radar series. + + XmlReader to extract data from. + Chart to put extracted data into. + Type of the series to create. + Chart item relations. + Extracted series. + + + + Extracts single chart series for bubble chart. + + XmlReader to extract data from. + Chart to put extracted series into. + Extracted series. + Chart item relations. + + + + Extracts single chart series for area chart. + + XmlReader to extract data from. + Chart to put extracted series into. + Type of the series to extract. + Chart item relations. + Extracted series. + + + + Parses common part of the series. + WARNING: this method doesn't call last Read(), so this call + must be made by parent item after series parsing complete. + + XmlReader to extract data from. + Series to put extracted data into. + Chart item relations. + + + + Parses name of the series. + + XmlReader to extract data from. + Series to put extracted name into. + + + + Indicates whether the text is null or whitespace. + + The text. + returns true if the text is null or whitespace otherwise false. + + + + Parses single data point. + + XmlReader to extract from. + Series to put data point into. + Parent relations. + + + + Extracts series values. + + XmlReader to extract data from. + Series to parse values for. + Array of series values. + Indicates whether axis is ValueAxis or CategoryAxis. + Range referencing series values. + + + + Get the range by given formula + + The parent workbook of the formula + Given formula + + + + + Get the range by given formula + + The parent workbook of the formula + worksheet of parent workbook + formula array to be converted + the range represetnted by the formula tokens + + + + Extracts null reference tag. + + XmlReader to extract data from. + String which is enclosed inside the formula tag. + + + + Filtered Number Reference + + input XML reader + output values parsed + output filtered value reference + output format code + the address + + + + Extracts string reference tag. + + XmlReader to extract data from. + String which is enclosed inside the formula tag. + + + + Filtered series range + + + + + + + + Extracts multi level string reference tag. + + XmlReader to extract data from. + String which is enclosed inside the formula tag. + + + + Parse the multi level string cache of the chart. + + XmlReader to extract the data from. + Chart Series to set the multi level cache data to. + Tag name to start parsing. + + + + + Extracts series marker from XmlReader. + + XmlReader to extract data from. + Series to serialize marker for. + + + + Parser marker fill. + + Reader to get fill information from. + Data format to put extracted marker information into. + Parser to help with color parsing. + + + + Extracts up/down bars. + + XmlReader to extract data from. + chart to put up/down bars into + Series to put up/down bars into. + Chart item relations. + + + + Extracts single drop bar (up or down bar). + + XmlReader to extract data from. + Drop bar to put extracted data into. + Parent file data holder. + Chart item relations. + + + + This method extracts chart data table. + + XmlReader to extract data table from. + Chart to put extracted data into. + + + + Extracts series formatting options. + + XmlReader to extract formatting from. + Series to extract formatting from. + Chart item relations. + + + + Extracts default text formatting. + + XmlReader to extract data from. + Object with text formatting. + Excel2007Parser to use if necessary. + + + + Extracts number or string value from the reader. + + XmlReader to get value from. + Extracted object. + + + + Assign the key as chart group for common data points collection + + chart to be changed + + + + Extracts data lables from chart. + + XmlReader to extract data from. + Parent Chart + Chart item relations. + chart group identified by this values,added to dictionary + + + + Serializes data label for single data point. + + XmlReader to extract data from. + Parent Chart + Chart item relations. + chart group identified by this values,added to dictionary + + + + Parse the invert solid fill format. + + Preserved stream. + Chart serie. + returns the color object. + + + + Class used to parse the chartEx (Excel 2016 charts) + + + + + Extracts chart from XmlReader. + + XmlReader to serialize into. + Chart to serialize. + Chart item relations. + + + + Parse the chart data from the reader + + input XML reader + input chart + input chart relations + the chart data parsed + + + + Parse the external Data attributes and store it in chart + + input XML reader + input chart + + + + Parse the every Data node of collection and returns the list + + input XML reader + input chart + relation + the chart data parsed + + + + Parse the (string/numeric) dimension data + + input XML reader + input cache + + + + Parse the (string/numeric) data values + + input XML reader + input cache + boolean value indicates whether the dimension is string or numeric + + + + Parse the chart element data from the reader + + input XML reader + input chart + input chart relations + Chart serie Index and dataId pair + + + + Parse the chart plot area from the reader + + input XML reader + input chart + input chart relations + excel 2007 parser + Chart serie Index and dataId pair + + + + Parse the chart plot area region from the reader + + input XML reader + input chart + input chart relations + excel 2007 parser + secondary axis Id + The collection of data Id and series index pair + + + + + Parse the pareto line format + + input XML reader + input Pareto Line format + input File Data holder + input chart relations + Returns the axis id integer value + + + + Parse the ChartEx series and set the chart type and format Index + + input XML reader + input chart + output pareto line series + the output series + + + + Parse the chartEx series properties and set the series settings + + input XML reader + input chartEx series + input relation collections + + + + Parse the binning properties for histogram and pareto charts + + input XML reader + input chart serie data format + + + + Parse the chartEx series visibility for series + Box and whisker , waterfall chart + + input XML reader + input Serie Data Format + + + + Parse the chart plot area surface from the reader + + input XML reader + input chart + input chart relations + excel 2007 parser + + + + Parse the chart axes from the reader + + input XML Reader + input secondaryAxis ID + hashCodeList to identify the + Parser used to parse the Axis + input chart + Input File Data Holder + Excel 2007 parser + input chart relations + the hashcode for an axis, which will not be further modified + + + + Parse the Axis element and retruns the required axis + + input axis reader + input Axis Parser + input chart + current parsed axis id + secondary axis id + + + + + Parse the data label visibilty settings for chart series + + input XML reader + Data labels visibilty to be set + + + + Class used for parsing charts. + + + + + Contains chart line pattern values. + + + + + Initializes static members of the ChartParserCommon class. + + + + + Parses text area. + + XmlReader to extract data from. + Text area to put extracted data into. + Parent data holder object. + Chart's relations. + + + + Parses text area. + + XmlReader to extract data from. + Text area to put extracted data into. + Parent data holder object. + Chart's relations. + Default font size. + + + + Parses text area tag. + + XmlReader to extract data from. + Text area to put extracted data into. + Parent data holder object. + Chart's relations. + Default font size. + + + + Extracts default text formatting. + + XmlReader to extract data from. + Object with text formatting. + Excel2007Parser to use if necessary. + + + + Extracts value from XmlReader.. + + XmlReader to extract data from. + Extracted value. + + + + Assigns default value for val attribute. + + LocalName of the current tag. + Assigned value. + + + + Extracts boolean value from xml tag. + + XmlReader to extract data from. + Extracted value. + + + + Extracts int value from xml tag. + + XmlReader to extract data from. + Extracted value. + + + + Extracts double value from xml tag. + + XmlReader to extract data from. + Extracted value. + + + + Extracts Line properties of chart. + + XmlReader to extract data from. + Chart line properties to parse. + Excel2007Parser to help in extraction process. + + + + Extracts pattern fill. + + XmlReader to extract data from. + Fill to put extracted data into. + Excel2007Parser to help in extraction process. + + + + Extracts solid fill. + + Fill object to put extracted transparancy value into. + XmlReader to extract data from. + Object that is used to help in color parsing. + Color object to put extracted color into. + + + + Extracts solid fill. + + XmlReader to extract data from. + Interior to put extracted data into. + Excel2007Parser to help in extraction process. + + + + Extracts solid fill. + + XmlReader to extract data from. + Interior to put extracted data into. + Excel2007Parser to help in extraction process. + + + + Extracts solid fill. + + XmlReader to extract data from. + Object that is used to help in color parsing. + Color object to put extracted color into. + + + + Extracts marker fill transparency. + + XmlReader to extract data from. + Object that is used to help in color parsing. + Color object to put extracted color into. + Set alpha value to the marker fill transparncy property. + + + + Extracts solid fill. + + XmlReader to extract data from. + Object that is used to help in color parsing. + Color object to put extracted color into. + To preserve the shape properties for scheme color + + + + Extracts solid fill. + + XmlReader to extract data from. + Object that is used to help in color parsing. + Color object to put extracted color into. + + + + Parse color object. + + XmlReader to extract data from. + Object that is used to help in color parsing. + Color object to put extracted color into. + Alpha value to be returned. + + + + Extracts solid fill. + + XmlReader to extract data from. + Object that is used to help in color parsing. + To preserve the shape properties for scheme color + Color object to put extracted color into. + + + + Extracts solid fill. + + XmlReader to extract data from. + Object that is used to help in color parsing. + To preserve the shape properties for scheme color + + + + Extracts rgb color. + + XmlReader to extract data from. + Extracted color. + + + + Extracts rgb color. + + XmlReder to extract data from. + Alpha component of the extracted color (0-100000). + Tint part of the extracted color (0-100000) or -1 if no tint part was present. + Shade part of the extracted color (0-100000) or -1 if no shade part was present. + Extracted color. + + + + + Extracts scheme color and converts it into rgb. + + XmlReader to extract data from. + Excel2007Parser to help in extraction process. + Extracted color. + + + + Extracts scheme color and converts it into rgb. + + XmlReader to extract data from. + Output alpha value. + Excel2007Parser to help in extraction process. + Extracted color. + + + + + Get the standard theme colors defined in XlsIO + + input color name + Equivalent color returned from the input color name + + + + Extracts preset color and converts it into rgb. + + XmlReader to extract data from. + Output alpha value. + Excel2007Parser to help in extraction process. + Extracted color. + + + + + Extracts system color and converts it into rgb. + + XmlReader to extract data from. + Output alpha value. + Excel2007Parser to help in extraction process. + Extracted color. + + + + + Update the parsed color. + + XmlReader to extract data from. + Excel2007Parser to help in extraction process. + Output alpha value. + Updated color. + + + + + Round off the Luminance. + + Luminance to be updated. + Updated Luminance. + + + + Round off the saturation. + + Saturation to be updated. + Updated saturation. + + + + Serialize line properties. + + XmlReader to serialize into. + Chart line properties to serialize. + Indicates whether border is rounded or not + Excel2007Parser to help in extraction process. + + + + Parses arrow properties and update in ChartBorderImpl properties. + + The XML reader containing arrow settings attributes. + The ChartBorderImpl object to be updated with arrow settings. + A boolean indicating whether the arrow is a head arrow (true) or tail arrow (false). + + + + Returns the arrow type by checking the value. + + The string representation of the arrow type. + The ExcelShapeArrowStyle representing the arrow type. + + + + Returns teh corresponding ExcelShapeArrowWidthLength for arrow size with the given length and width. + + The string representation of the arrow length. + The string representation of the arrow width. + The ExcelShapeArrowWidthLength representing the arrow size. + + + + Extracts picture fill. + + XmlReader to extract data from. + Fill to put extracted data into. + Chart item relations. + Parent file data holder. + + + + Extracts picture fill. + + XmlReader to extract data from. + Fill to put extracted data into. + Chart item relations. + Parent file data holder. + Relation collection + + + + Extracts text from XmlReader and places it into text area. + + XmlReader to extract data from. + Text area to put extracted data into. + Parser object that helps to extract data. + + + + Parse and returns the formula / value from the reader + + input XML reader + output formula + output value + + + + Extracts layout from XmlReader and places it into text area. + + XmlReader to extract data from. + Layout to put extracted data into. + Parser object that helps to extract data. + + + + Parses manual layout. + + XmlReader to read rich text from. + manualLayout that will get extracted the manual position settings. + Parser object that helps to extract data. + + + + Parse the string cache and used to stores it in array + + XML reader object used to parse + the parsed string array + + + + Parses rich text. + + XmlReader to read rich text from. + Text area that will get extracted rich text. + Parser object that helps to extract data. + + + + Parses text area body properties. + + XmlReader to read body properties from. + Text area to put body properties into. + + + + Extracts list styles for a text area. + + XmlReader to extract list styles from. + Text area that will get extracted settings. + + + + Parses paragraph. + + XmlReader to get paragraph tag from. + Text area that will get paragraph information (formatting and text). + Parser object that helps to extract data. + Default text area that will get default paragraph information. + + + + Parses fld element. + + XmlReader to get paragraph run from. + Text area to put extracted properties into. + Parser object that helps to extract data. + Default text settings. + Default font size + + + + Parses paragraph properties. + + XmlReader to get data from. + + + + Extracts default paragraph properties from the reader. + + Reader to get properties from. + Instance of Excel2007Parser that helps in parsing process. + Default paragraph properties. + + + + Extracts default paragraph properties from the reader. + + Reader to get properties from. + Instance of Excel2007Parser that helps in parsing process. + Default font size. + Default paragraph properties. + + + + Extracts color of the default paragraph. + + + + + + + Parses paragraph run. + + XmlReader to get paragraph run from. + Text area to put extracted properties into. + Parser object that helps to extract data. + Default text settings. + + + + Parses paragraph run. + + XmlReader to extract paragraph tag from. + Text area that will get paragraph run information (formatting and text). + Parser object that helps to extract data. + Default text settings. + + + + + Copying common ChartTitle format after Chart tag + + Represents the ChartTitle area and TextFormats + Represents parsed TextFormats of ChartTitle after chart tag + + + + Extracts gradient stops collection from the specified reader. + + XmlReader to extract data from. + Excel2007Parser to help in extraction process. + Extracted gradient stops. + + + + Extracts gradient stops collection from the specified reader. + + XmlReader to extract data from. + Excel2007Parser to help in extraction process. + Extracted gradient stops. + + + + Get the value of the charts property + + XmlReader to extract from + The reader value of the decimal number + + + + + Extracts gradient path. + + XmlReader to extract from. + Resulting gradient stop collection + + + + Extracts GradientStops collection. + + XmlReader to extract data from. + Parser object that helps to extract data. + Extracted collection. + + + + Extracts single gradient stop settings. + + XmlReader to extract data from. + Excel parser to help in extraction process. + Extracted gradient stop. + + + + Parse the Scheme color. + + + + + + + + Extracts color settings. + + XmlReader to extract data from. + Transparency part of the extracted color (0-100000) or -1 if no transparecy part was present. + Tint part of the extracted color (0-100000) or -1 if no tint part was present. + Shade part of the extracted color (0-100000) or -1 if no shade part was present. + Excel parser to help in extraction process. + Color extracted. + + + + + Converts Excel 2007 gradient stops collection into set of properties used by Excel 97-2003. + + Gradient stops collection to convert. + Fill object to put extracted properties into. + + + + To check the default settings of text area + + Text area to check the default values + + + + Copies color data from gradient stop. + + Color object to copy data into. + Gradient stop to copy color data from. + + + + Extracts shape properties. + + XmlReader to extract data from. + Object that provides access to filling objects. + FileDataHolder of the document that is parsed. + Chart item relations. + + + + Parses the lighting. + + The reader. + The shadow. + The relations. + The holder. + + + + Checks the specified lighttype. + + The lighttype. + + + + + This method tries to get the Bevel properties read from the XML + + Linewidth mentions the Width of the line and represents the 'W' tag + LineHeight mentions the Heigth and represents the 'H' tag + Presetshape mentions the shape of the 3D feature + XmlReader to extract data from. + it returns the Excel2007Chartbevel properties or Noangle will be returned(which means 0) + + + + This method tries to get the material properties + + Material is denotes the type of the Material properties read from the XML + XmlReader to extract data from. + Excel 2007 chartmaterial properties or Noeffect value will be returned(which means 0) + + + + Parses the Shadow Properties + + XmlReader to extract data from. + Shadow object to access the properties + Object that provides access to filling objects. + FileDataHolder of the document that is parsed. + Chart item relations. + Excel 2007 Parser + + + + + + It gets the Blur Radius Tag value + It gets the Sizex Tag value + It gets the Sizey Tag value + It gets the Distance Tag Tag value + It gets the Direction Tag value + It gets the Alignment Tag value + It gets the Rotationwithshape Tag value + Excel 2007 Parser + Shadow object to access the properties + Xml reader to extract data from. + The Excel2007chartpresetsouter value or Noshadow value will be returned(Which means 0) + + + + Checks the specified Custom Outer Shadow . + + The blurval. + The sizex. + The disttag. + The dirtag. + The align. + The rot. + The shadow. + The reader. + The parser. + + + + + Parses the shadow alpha. + + The reader. + The shadow. + + + + Extracts value from XmlReader.. + + XmlReader to extract data from. + Extracted value. + + + + This Method tries to get the value of perspective shadow + + It gets the Blur Radius Tag value + It gets the Sizex Tag value + It gets the Sizey Tag value + It gets the Kx Tag value + It gets the Distance Tag Tag value + It gets the Direction Tag value + It gets the Alignment Tag value + It gets the Rotationwithshape Tag value + the Excel2007Chartpresetsperspective value or NoShadow value will be returned(which means 0) + + + + This method tries to get the Inner shadow values based on the parsed Info + + It gets the Blur Radius Tag value + It gets the Distance Tag Tag value + It gets the Direction Tag value + This returns the Excel2007chartPresetsInner value or No shadow (which means 0) + + + + Checks the Custom Inner Shadow. + + The blurval. + The disttag. + The dirtag. + The shadow. + The reader. + if set to true [Current format has Custom shadow style]. + + + + + This method tries to detect gradient color settings (One or Two color gradient). + + Gradient stops to detect gradient color + Detected gradient color or -1 if it is neither one nor two color gradient. + + + + Detects gradient variant type. + + Gradient stops to detect variant type for. + Already detected gradient style. + Already detected gradient color. + Indicates whether gradient stops for preset + gradient are in inverted order. This argument is used in the case of ExcelGradientColor.Preset. + Detected gradient variant type. + + + + Detects diagonal gradient variant. + + Checks whether gradient stops in the collection are in inverted order or not. + Represents double order variant. + Detected gradient variant. + + + + Detects gradient variant. + + Checks whether gradient stops in the collection are in inverted order or not. + Represents double ordered variant. + Detected gradient variant. + + + + Detects gradient variant for FromCorner gradient style. + + FillToRect used by gradient stops collection. + Detected gradient variant. + + + + Checks whether gradient stops in the collection are in inverted order or not. + + Gradient stops to check. + Gradient color type. + Indicates whether gradient stops for preset + gradient are in inverted order. This argument is used in the case of ExcelGradientColor.Preset. + True if gradient stops are inverted. + + + + Detect Gradient style. + + Gradient stops to check. + Detected Gradient style. + + + + Gets gradient style for rectangular gradient. + + Gradient stops collection to get gradient style for. + Converted gradient style. + + + + Gets gradient style for linear gradient. + + Gradient stops collection to get gradient style for. + Converted gradient style. + + + + Tries to find preset gradient corresponding to the specified collection. + + Gradient stops collection to analyze. + Indicates whether gradient stops are in inverted order. + Preset value or ( ExcelGradientPreset )( -1 ) if there is no corresponding preset value found. + + + + Sets GradientDegree property if necessary. + + Gradient stops to detect degree from. + Detected gradient color. + Fill to set gradient degree for. + + + + Parse the chart title stream + + input chart title stream + input chart text area element + parent data holder for chart + relation collections of chart + + + + This class is responsible for chart object serialization into XmlWriter in Excel 2007 SpreadsheetML format. + + + + + Default Extent X + + + + + Default Extent Y + + + + + Category Filter + + + + + Find Filter + + + + + ChartType + + + + + One argument constructor + + boolean value indicates whether the chart is dummy for chartEx + + + + Default constructor + + + + + Serializes chart inside XmlWriter. + + XmlWriter to serialize into. + Chart to serialize. + Name of the xml file containing chart item. + + + + Serializes the Chart default text properties. + + XmlWriter to serializes into. + chart to get the data to serialize. + + + + Serializes the pivot options. + + The writer. + The chart. + + + + Serializes the pivot options. + + The writer. + The chart. + + + + Serializes pivot source tag if necessary. + + XmlWriter to serilaize into. + Chart to serialize pivot formats tag for. + + + + Serializes pivot source tag if necessary. + + XmlWriter to serilaize into. + Chart to serialize pivot source tag for. + + + + Gets the pivot source. + + The pivot sheet. + The pivot table. + + + + + Serializes shapes. + + XmlWriter to serialize into. + Chart to serialize shapes for. + Name of the xml file containing chart item. + + + + Serializes chart printer settings. + + XmlWriter to serialize into. + Object that stores settings to serialize. + + + + Serializes chart legend. + + XmlWriter to serialize into. + Chart legend to serialize. + Parent chart object. + + + + Serializes single legend entry. + + XmlWriter to serialize legend entry into. + Legend entry to serialize. + Legend entry index. + Parent workbook object. + + + + Serializes view 3D. + + XmlWriter to serialize legend entry into. + Chart to serialize shapes for. + + + + Serializes error bars. + + XmlWriter to serialize into. + Error bars to serialize. + Error bars direction (x or y). + Parent workbook. + + + + Serializes trendlines collection. + + XmlWriter to serialize into. + Trendlines to serialize. + Parent workbook. + + + + Serializes trend line. + + XmlWriter to serialize into. + Trend line to serialize. + Parent workbook. + + + + Serializes trend line label settings. + + XmlWriter to serialize into. + Data label to serialize. + + + + Serializes surface (wall or floor). + + XmlWriter to serialize into. + Surface to serialize. + Name of the top xml tag to use. + Parent chart object. + + + + Serializes plotarea tag and everything inside it. + + XmlWriter to serialize into. + Chart to serialize. + + + + Serialize the data labels only for empty chart + + the input XML writer + + + + Serializes plot area tag for pivot chart. + + + + + + + + Serializes the bar chart. + + XmlWriter to serialize into. + Chart to serialize. + + + + Serializes bar chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized bar series. + + + + Serializes axis id's for bar chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + + + + Serializes the bar3 D chart. + + XmlWriter to serialize into. + Chart to serialize. + + + + Serializes the shape of the bar chart from its type + + XmlWriter to serialize into. + Input Excel chart type + + + + Serialize bar3D chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized 3Dbar series. + + + + Serializes gap depth. + + XmlWriter to serialize into. + Chart to serialize gap depth for. + + + + Serializes the bar shape. + + XmlWriter to serialize into. + The base format. + The top format. + + + + Serializes shape of the bar chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + + + + Serializes part of the bar chart that is common for all bar charts. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized bar series. + + + + Serializes chart series with the same formatting. + + XmlWriter to serialize into. + Chart to get series from. + First series in the list of the series to serialize. + It is used to determine which series should be serialized. + Delegate used to serialize chart series. + Number of serialized series. + + + + serialiae filtered serie + + + + + + + Serilaize filtered series + + + + + + + Serialize Fitered Text + + + + + + + Serialize filtered text values + + + + + + + + serialize filtered category + + + + + + + + serialize filtered values + + + + + + + + Returns the series filter type + + + + + + + Serializes grouping tag. + + XmlWriter to serialize into. + Chart to serialize grouping for. + + + + Serializes the chart grouping. + + XmlWriter to serialize into. + Chart to get series from. + + + + Serializes the area3 D chart. + + XmlWriter to serialize into. + Chart to get series from. + + + + Serializes area3D chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized area3D series. + + + + Serializes the area chart. + + XmlWriter to serialize into. + Chart to get series from. + + + + Serializes area chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized area series. + + + + Serializes properties common to the area chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + This method serializes common properties of the line charts. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized line series. + + + + Serializes the line3 D chart. + + XmlWriter to serialize into. + Chart to serialize. + + + + Serialize line3DChart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized line3D series. + + + + Serializes the line chart. + + XmlWriter to serialize into. + Chart to serialize. + + + + Serializes line chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized line series. + + + + Serialize bubble chart. + + XmlWriter to serialize chart into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized bubble series. + + + + Serializes the surface chart. + + XmlWriter to serialize into. + Chart to serialize. + + + + Serializes 2-D surface chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes the surface3 D chart. + + XmlWriter to serialize into. + Chart to serialize. + + + + Serializes 3-D surface chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes common part of the surface charts. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes preserved band formats if necessary. + + XmlWriter to serialize into. + Chart to serialize. + + + + Serializes main chart tag. + + XmlWriter to serialize into. + Chart to serialize. + Index of the series group to serialize. + Number of the serialized series. + + + + Serializes main chart tag. + + XmlWriter to serialize into. + Chart to serialize. + Index of the series group to serialize. + Number of the serialized series. + + + + Serializes the radar chart. + + XmlWriter to serialize into. + Chart to serialize. + + + + Serializes radar chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes scatter chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes the pie chart. + + XmlWriter to serialize into. + Chart to serialize. + + + + Serializes pie chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes the pie3 D chart. + + XmlWriter to serialize into. + Chart to serialize. + + + + Serializes 3-D pie chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes the of pie chart. + + XmlWriter to serialize into. + Chart to serialize. + + + + Serializes pie of pie or pie of bar chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes stock chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes the doughnut chart. + + XmlWriter to serialize into. + Chart to serialize. + + + + Serializes doughnut chart. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes common properties of pie charts. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with the + same formatting to serialize. + Number of the serialized series. + + + + Serializes data lables. + + XmlWriter to serialize into. + DataLabels to serialize. + Parent series. + + + + Serializes number format. + + XmlWriter to serialize into. + dataLabels of data points which have number format to serialize + + + + Serializes data label for single data point. + + XmlWriter to serialize into. + Data labels to serialize. + Data point index. + Parent chart object. + + + + Serializes data labels settings. + + XmlWriter to serialize into. + Data labels to serialize. + Parent chart. + + + + Serializes default text formatting. + + XmlWriter to serialize into. + Text formatting to serialize. + Parent workbook. + + + + Serializes IsVaryColors option. + + XmlWriter to serialize into. + First series in the list of series with the + same formatting to serialize vary colors option for. + + + + Serializes single chart series for bar chart. + + XmlWriter to serialize into. + Series to serialize. + + + + Serialize the InvertIfNegativeColor. + + Xml writer + Series to serialize. + + + + Find the category filter + + + + + + + To update the filtered value range + + + + + + Check whether any categories in chart is filtered + + Parent chart + + + + + Update the category filterlabel range + + + + + + serialize the filtered category or series name + + + + + + + + Serialize values from cells range. + + Xml writer + Chart series + + + + Serialize datalabel range cache. + + Xml writer + value form cells values. + + + + serilaize the category name + + + + + + + Serializes single chart series for pie chart. + + XmlWriter to serialize into. + Series to serialize. + + + + Serializes error bars. + + XmlWriter to serialize into. + Series to serialize. + + + + Serialize line series. + + XmlWriter to serialize into. + Chart line series to serialize. + + + + Serializes scatter series. + + XmlWriter to serialize into. + Chart scatter series to serialize. + + + + Serializes chart radar series. + + XmlWriter to serialize into. + Chart series to serialize. + + + + Serializes single chart series for bubble chart. + + XmlWriter to serialize into. + Series to serialize. + + + + Serializes single chart series for area chart. + + XmlWriter to serialize into. + Series to serialize. + + + + Serializes common part of the series. + WARNING: this method doesn't call last WriteEndElement(), so this call + must be made by parent item after series serialization complete. + + XmlWriter to serialize into. + Series to serialize. + + + + Serializes single data point. + + XmlWriter to serialize into. + Data point to serialize. + + + + Serializes series category. + + XmlWriter to serialize into. + Series to serialize category labels for. + + + + Serializes series category. + + XmlWriter to serialize into. + Series to serialize category labels for. + + + + Serializes series values. + + XmlWriter to serialize into. + Series to serialize values for. + + + + Serializes series values. + + XmlWriter to serialize into. + Series to serialize values for. + + + + Serializes series values. + + XmlWriter to serialize into. + Range to serialize values for. + Name of the xml tag to use. + + + + Serializes the normal reference. + + The writer. + The range. + The values. + Name of the tag. + + + + Serializes number or string reference. + + + + + + + Gets the string reference. + + The range. + + + + + Serializes number references. + + XmlWriter to serialize into. + Range to serialize values for. + Range values to serialize cache values for. + + + + This function is used for serializing the number cache values. + + This is used for serializing the chart date in XML format. + This is Holding the chart serie type of values. + + + + Serializes string references. + + XmlWriter to serialize into. + Range to serialize values for. + + + + Serializes String references. + + XmlWriter to serialize into. + Range to serialize values for. + + + + This function is used for serializes the string cache values for the current chart serie. + + Used to write the string cache values in XML format. + This is holding the Chart Serie contents. + + + + This is used for serializes the Category type of string Cache values. + + This is used to write the chart serie category values in XMl format. + This is holding the Chart serie contents. + + + + Serializes Multi level string references. + + XmlWriter to serialize into. + Range to serialize values for. + Range values to serialize cache values for. + + + + Serializes multi level string cache. + + XmlWriter to serialize into. + Chart series to get the cache data from. + + + + Serializes the formula if the range is null + + XMLWriter to serialize into + Tag to serialize values for + Formula to serialize for the tag + + + + Serializes chart axes. + + XmlWriter to serialize into. + Chart to serializes axes of. + + + + Serializes the pivot axes. + + XmlWriter to serialize into. + Chart to serialize. + The relations. + + + + Serializes series marker if necessary. + + XmlWriter to serialize into. + Series to serialize marker for. + + + + Serializes series marker if necessary. + + XmlWriter to serialize into. + Series to serialize marker for. + + + + Serializes line with the specified color. + + XmlWriter to serialize into. + Line color. + Parent workbook. + + + + Serializes line with the specified color. + + XmlWriter to serialize into. + Line color. + Parent workbook. + + + + Serializes line with the specified color. + + XmlWriter to serialize into. + Line color. + Parent workbook. + + + + Serializes up/down bars. + + XmlWriter to serialize into. + Chart to serialize. + First series in the list of series with same + formatting to serialize up/down bars for. + + + + Serializes single drop bar (up or down bar). + + XmlWriter to serialize into. + Drop bar to serialize. + Name of the main tag. + Chart to serialize dropbar for. + + + + Serializes chartsheet into specified writer. + + XmlWriter to serialize into. + Chart to serialize. + Id of the drawing relation with chart object.. + + + + Serializes chartsheet drawing part. + + XmlWriter to serialize into. + Chart to serialize drawing for. + Relation id of the drawing part. + + + + Serializes the chart object as absolute anchor + + input XML writer + input chart + input drawing relation id + boolean value indicates whether the chart is sheet or not + + + + Serialize the fall back content for chartEx sheet + + nput XML writer + input relation Id + + + + This method serializes chart data table. + + XmlWriter to serialize into. + Chart to serialize data table for. + + + + Serializes series value that were entered directly. + + XmlWriter to serialize into. + Values to serialize. + + + + Serializes series value that were entered directly. + + XmlWriter to serialize into. + Values to serialize. + Tag name to idendify whether this is category or value. + + + + Converts object into xml string. + + Value to convert. + Converted value. + + + + Serializes data lables. + + XmlWriter to serialize into. + parent chart + data points to be serialized + + + + This delegate is used for series serialization. + + XmlWriter to serialize series into. + Series to serialize. + + + + This class is responsible for chartEx object (all) serialization into XmlWriter in Excel SpreadsheetML format. + + + + + Represents dictionary for TickMark to Attribute value. + + + + + Initialize the members of this class + + + + + Serialize the chart + + input XML writer + input chart + + + + Serialize the chart tag input element + + input XML writer + input chart + input relations + + + + Serializes plotarea tag and everything inside it. + + XmlWriter to serialize into. + Chart to serialize. + input relation collection + + + + Serialize the required axes + + XmlWriter to serialize into. + Chart to serialize. + chart type of the chart + input relation collection + + + + Serialzie the single axis + + input XML writer + input axis to be serialized + input Chart to serialize. + input relation collection + axis Id of the axis + + + + Serialzie the single axis common properties + + input XML writer + input axis to be serialized + input Chart to serialize. + input relation collection + axis Id of the axis + + + + Serialize the axis shape and text properties + + input XML writer + input axis to be serialized + input Chart to serialize. + input relation collection + + + + Serialzie the axis display unit + + input XML writer + input axis to be serialized + input Chart to serialize. + input relation collection + axis Id of the axis + + + + Serialize the chart's every pareto line as series + + input XML writer + input chart + input chartType + + + + Serialize the input serie and everything inside it. + + input XML writer + input chart serie + input chart serie Index for data referring + chart type + input chart + relation collection of the chart + + + + Serialize the input chart serie layout properties + + input XML writer + input chart serie + input chart + relation collection of the chart + + + + Serialize the subtotal data points of the series + + input XML writer + input serie to subtotal serialized + + + + Serialize the bin properties of the chart + + input XML writer + input chart serie data format for binning properties + input chart + + + + Serialize the single chart serie data labels + + input XML writer + input serie to data labels serialized + input chart + input chart relations + + + + Serializes the input data label settings + + input XML writer + input data labels + paret chart of the data labels + chart relation collection + + + + check whether the frame format is formatted or not + + input chart frame format impl + the boolean value + + + + Serializes number format. + + XmlWriter to serialize into. + dataLabels of data points which have number format to serialize + + + + Serialize the data point properties of the chart serie + + input XML writer + input chart serie + + + + Serialize the chart serie name + + input XML writer + input chart serie + + + + Serialize the single chart serie attributes + + input XML writer + input chart serie + chart type of the chart + chart serie index + boolean value indicates whether the pareto line option is serialized or not + + + + Serialize the chart legend + + input XML writer + input chart legend + input chart + + + + Serialize the chart text area properties for text elements + + input XML writer + input chart text area + input chart + input relation collection + default font size for text area + input XML elemet parent + boolean value indicates whether the title is auto + boolean value indicates whether element is chart title + + + + Serialize the chart text element properties for chart title and legend + + input XML writer + input position of element + boolean value indicates the layout of element + + + + Serialize the chart text area Tx and rich + + input XML writer + input chart text area + input chart + default font size for text area + boolean value indicates whether the title serialized as rich text or not + + + + Serialize the chartEx data element + + input XML writer + input chart + + + + Individial series data serialized with this. + + input XML chart + input chart serie + serie index + chart type + + + + Serialize the dimension data for series + + input XML writer + input range + input direct values array + boolean value indicates whether range is in row + number format code + Indeicates whether the range is category or series values + + + + Serializes chart printer settings. + + XmlWriter to serialize into. + Object that stores settings to serialize. + + + + This class contains common code used for charts serialization. + + + + + Key - ExcelChartLinePattern, + Value - pair, where key is Excel 2007 pattern value, value - preset pattern of the pattern fill. + + + + + Jagged Array represents the Outer Shadow Attributes + + + + + Jagged Array represents the Inner Shadow Attributes + + + + + Jagged Array represents the Perspective Shadow Attributes + + + + + Jagged Array represents the 3D Bevel Attributes + + + + + Jagged Array represents the 3D Material Attributes + + + + + Jagged Array represents the 3D Lighting Attributes + + + + + Initializes static members of ChartSerializatorCommon class. + + + + + Serializes frame format. + + XmlWriter to serialize into. + Fill format to serialize. + Parent chart object. + Indicates whether area corners should be rounded. + + + + Serializes frame format. + + XmlWriter to serialize into. + Fill format to serialize. + Parent chart object. + Indicates whether area corners should be rounded. + + + + Serializes frame format. + + XmlWriter to serialize into. + Fill format to serialize. + Parent file data holder. + Chart's relations collection + Indicates whether area corners should be rounded. + + + + This method serailizes the Shadow propeties + + XmlWriter to serialize into. + Shadow format to serialize into + Whether the current format contains the Custom Shadow Style + + + + Serialize the other effectlst data preserved on parsing + + input XML writer + the parent shadow object + + + + Serializes the inner shadow. + + XmlWriter to serialize into. + The jagged array index of the InnerAttributeArry. + if set to true [custom shadow style]. + The ShadowImpl object. + + + + This method Serailizes the Outer Shadow + + XmlWriter to serialize into. + the jagged array index of OuterAttributeArry + if set to true [custom shadow style]. + The ShadowImpl object + + + + This method Serailizes the Outer Shadow + + XmlWriter to serialize into. + the jagged array index of OuterAttributeArry + if set to true [custom shadow style]. + The ShadowImpl object + + + + This method serializes the Perspective shadow properties + + XmlWriter to serialize into. + the jagged array index of PerspectiveAttributeArry + if set to true [custom shadow style]. + The ShadowImpl object + + + + This method Serailizes the 3DProperties + + XmlWriter to serialize into. + ThreeD format + + + + This method serailize the Lighting properties + + XmlWriter to serialize into. + the jagged array index of LightingPropertiesArray + + + + This method serialize the Material properties + + XmlWriter to serialize into. + the jagged array index of MaterialPropertiesArray + + + + This method serialize the Bevel top + + XmlWriter to serialize into. + the jagged array index of bevelpropertiesArray + + + + This method serialize the Bevel top + + XmlWriter to serialize into. + the jagged array index of bevelpropertiesArray + Bevel top Height Value + Bevel top width Value + + + + This method serializes the Bevel Bottom + + XmlWriter to serialize into. + the jagged array index of Bevelproperties Array + + + + This method serializes the Bevel Bottom + + XmlWriter to serialize into. + the jagged array index of Bevelproperties Array + Bevel bottom Height Value + Bevel bottom width Value + + + + Serializes fill object. + + XmlWriter to serialize into. + Fill to serialize. + Parent file data holder. + Chart's relations collection + + + + Serializes text area. + + XmlWriter to serialize into. + Text area to serialize. + Parent workbook. + Chart's relations. + + + + Serialize xml tag that contains value attribute with tag value. + + XmlWriter to serialize into. + Tag name to serialize. + Value to serialize. + + + + Serialize the double value attributes. + + + + + + + + Serialize xml tag that contains value attribute with tag value. + + XmlWriter to serialize into. + Tag name to serialize. + Namespace of the xml tag. + Value to serialize. + + + + Seralize the double value + + + + + + + + + Serialize xml tag that contains value attribute with tag value. + + XmlWriter to serialize into. + Tag name to serialize. + Value to serialize. + + + + Serializes chart line properties. + + XmlWriter to serialize into. + Border to serialize. + Parent workbook. + + + + Serializes pattern fill. + + XmlWriter to serialize into. + Color to serialize. + Indicates whether color is automatic and should be ignored or not. + Preset dash value. + Preset pattern value. + Parent workbook. + + + + Serializes pattern fill. + + XmlWriter to serialize into. + Foreground color. + Indicates whether foreground color is auto and foreColor argument should be ignored. + Background color. + Indicates whether background color is auto and backColor argument should be ignored. + Preset pattern value. + Parent workbook. + + + + Serializes pattern fill. + + XmlWriter to serialize into. + Foreground color. + Indicates whether foreground color is auto and foreColor argument should be ignored. + Background color. + Indicates whether background color is auto and backColor argument should be ignored. + Pattern to serialize. + Parent workbook. + + + + Serializes solid fill. + + XmlWriter to serialize into. + Color that is used for filling. + Indicates whether color is automatic or was manually changed. + Parent workbook. + + + + Serializes solid fill. + + XmlWriter to serialize into. + Color that is used for filling. + Indicates whether color is automatic or was manually changed. + Parent workbook. + returns alpha value + returns shape value + + + + Serializes various shape properties of a picture + + xmlTextWriter object + shape to which shape properties belong to + Shape property node + + + + Serializes rgb color. + + XmlWriter to serialize into. + Color to serialize. + + + + Serializes rgb color. + + XmlWriter to serialize into. + Color index to serialize. + Parent workbook. + + + + Serializes rgb color. + + XmlWriter to serialize into. + Color to serialize. + Alpha component of the color to serialize, 0 - 100000. + + + + Serializes rgb color. + + XmlWriter to serialize into. + Color to serialize. + Alpha component of the color to serialize, 0-100000. + Tint value of the color to serialize, 0-100000. + Shape value of the color to serialize, 0-100000. + + + + Serialize line properties. + + XmlWriter to serialize into. + Chart line properties to serialize. + Indicates whether border is rounded or not + Parent workbook. + + + + Serailize Line Join Type + + XmlWriter to serialize into. + Line Join Type + + + + Serializes picture fill. + + XmlWriter to serialize into. + Picture to serialize. + Parent file data holder object. + Relations collection to add relation to. + Indicates whether image should be tiled. + + + + Serialize the picture with fillrect and source rect. + + + + + Serializes texture fill. + + XmlWriter to serialize into. + Fill object that contains settings to serialize. + Parent file data holder object. + Relations collection to add relation to. + + + + Get the texture picuture. + + Texture name + + + + + Serializes gradient fill. + + XmlWriter to serialize into. + Fill to serialize. + Parent workbook. + + + + Serializes text properties. + + XmlWriter to serialize into. + Text area to serialize text properties for. + + + + Serializes default text formatting. + + XmlWriter to serialize into. + Text formatting to serialize. + Parent workbook. + Font size of the text are element + boolean value indicates whether the text is automatically rotated + text rotation angle + enum text rotation + Input name space required at chart + Run paragraph serialized for chartEx + + + + Serializes text from text area. + + XmlWriter to serialize into. + Text area to serialize values for. + Parent workbook. + + + + Serializes rich text. + + XmlWriter to serialize into. + Text area that contains rich text to serialize. + Parent workbook. + Name of the main xml tag. + + + + Serialize text area body properties. + + XmlWriter to serialize into. + Text area to serialize body properties for. + + + + Serializes list styles for a text area. + + XmlWriter to serialize into. + Text area to serialize list styles for. + + + + Serializes paragraph. + + XmlWriter to serialize paragraph tag into. + Text area that contains paragraph information (formatting and text). + Parent workbook. + + + + Serializing the rich-text formatting + + XmlWriter to serialize paragraph tag into. + Text area that contains paragraph information (formatting and text) of text area. + Parent workbook. + Default font size + + + + Serializing the rich-text formatting + + XmlWriter to serialize paragraph tag into. + Text area that contains paragraph information (formatting and text) of text area. + Parent workbook. + Default font size + Default text area that contains paragraph information (formatting and text) of text area. + Run properties start index. + + + + Serializing the rich-text formatting + + XmlWriter to serialize paragraph tag into. + Text area that contains paragraph information (formatting and text) of data labels. + Parent workbook. + Default font size + + + + Check the serialize fld element. + + Chart data label + Data label text. + fld element type + if serialize the fld return true otherwise false. + + + + Serializes paragraph run. + + XmlWriter to serialize paragraph tag into. + Text area that contains paragraph run information (formatting and text). + Name of the main xml tag. + Parent workbook. + + + + Serializes paragraph run. + + XmlWriter to serialize paragraph tag into. + Text area that contains paragraph run information (formatting and text). + Name of the main xml tag. + Parent workbook. + + + + Serializes string reference settings. + + XmlWriter to serialize into. + Text area to get settings from. + String array used as cache values + + + + Serializes text area layout settings. + + XmlWriter to serialize into. + Text area to serialize layout settings for. + + + + Boolean value indicates whether the element is manual layoutted + + input manual layout object + the boolean value + + + + Serializes text area manual layout settings. + + XmlWriter to serialize into. + Manual layout to serialize manual layout settings for. + + + + This method serialize the Bevel bottom + + XmlWriter to serialize into. + Bevel bottom Height Value + Bevel bottom width Value + + + + This method serialize the Bevel top + + XmlWriter to serialize into. + Bevel top Height Value + Bevel top width Value + + + + Serialize the rich text stream of binary file + + Text Area class to be serialized + parent workbook + Default font size of the workbook + the serialized new rich text stream + + + + This class is responsible for chart axis parsing. + + + + + Default font name. + + + + + Default axis font size. + + + + + Represents dictionary for Ticklabel to Attribute value. + + + + + Represents dictionary for TickMark to Attribute value. + + + + + Represents axis id of the bar series. + + + + + Indicate whether series is bar chart or not + + + + + Initializes static members of the ChartAxisParser class. + + + + + Represents Chart Axis Parser + + + + + + Extracts date axis from XmlReader. + + XmlReader to serialize into. + Axis to serialize. + Chart item relations. + Prognosed type of the chart (or chart part) that is being parsed. + + + + Serializes category axis. + + XmlReader to extract data from. + Axis to serialize. + Chart item relations. + Prognosed type of the chart (or chart part) that is being parsed. + + + + Extracts value axis. + + XmlReader to extract axis from. + Axis to put extracted data into. + Chart item relations. + Prognosed type of the chart (or chart part) that is being parsed. + + + + Extracts series axis data. + + XmlReader to extract data from. + Axis to put extracted data into. + Chart item relations. + Prognosed type of the chart (or chart part) that is being parsed. + + + + Extracts common part of the axis. + + XmlReader to extract data from. + Axis to serialize. + Relations collection for chart item that is being parsed. + Prognosed type of the chart (or chart part) that is being parsed. + + + + Extracts chart axis text properties from the reader. + + XmlReader to get data from. + Axis to put extracted data into. + + + + Extracts text body properties + + XmlReader to get data from. + Axis to put extracted data into. + + + + Extracts vert attribute. + + XmlReader to serialize into. + Extracted vert attribute. + + + + Parses crosses xml tag. + + XmlReader to extract data from. + Axis to put extracted data into. + + + + Parses cross axis tag. + + XmlReader to extract data from. + Axis to put extracted data into. + + + + Extracts tick mark. + + XmlReader to extract data from. + Extracted value. + + + + Extracts tick label position. + + XmlReader to extract data from. + Axis to set tick label position. + + + + Extracts number format used by the axis. + + XmlReader to extract data from. + Axis to put extracted number format into. + + + + Extracts single gridline object. + + XmlReader to extract data from. + Gridlines to put extracted data into. + Parent file data holder. + Chart item relations. + + + + Extracts axis position. + + XmlReader to extract data from. + Axis to serialize. + Extracted Axis position. + + + + Extracts scaling tag and all necessary child tags. + + XmlReader to serialize into. + Extracted Axis scale. + + + + Extracts display unit from XmlReader. + + XmlReader to extract data from. + Axis to put extracted data into. + + + + Extracts built-in display unit. + + XmlReader to get value from. + Value axis to put extracted value into. + + + + Parses additional tags of category axis. + + XmlReader to get data from. + Axis to put data into. + Chart relations. + + + + Parses additional tags of date axis. + + XmlReader to get data from. + Axis to put data into. + Chart relations. + + + + Parses additional tags of value axis. + + XmlReader to get data from. + Axis to put data into. + Chart relations. + + + + Parses additional tags of series axis. + + XmlReader to get data from. + Axis to put data into. + Chart relations. + + + + This class is responsible for chartEx axis parsing + + + + + Select and Parse the chartEx axis from the reader + + input XML reader + input secondaryAxisId + input chart + input chart relation collections + excel 2007 parser + input file data holder + + + + Extracts display unit from XmlReader. + + XmlReader to extract data from. + Axis to put extracted data into. + + + + Parse the Axis attributes return the axis values + + input XML reader + output axis hidden value + output axis id value + + + + Parse the chart axis (category or value scaling element) attributes + + input XML reader + input chart Axis + boolean value indicates whether the axis is value or category + + + + Extracts tick mark. + + XmlReader to extract data from. + Extracted value. + + + + This class contains constants used for autofilter parsing and serialization in Excel 2007 format. + + + + + Name of the xml tag name that represents auto filter settings. + + + + + Name of the xml attribute that represents reference to the cell range to which the AutoFilter is applied. + + + + + Name of the xml tag that identifies a particular column in the AutoFilter range and specifies + filter information that has been applied to this column + + + + + Name of the xml attribute that indicates the AutoFilter column to which this filter information applies. + + + + + Name of the xml tag that indicates the Icon Filter. + + + + + Name of the xml tag that indicates the Color Filter + + + + + Name of the xml attribute tag that specifies the filtering is done based on font color + + + + + Name of the xml tag that specifies the top N (percent or number of items) to filter by. + + + + + Name of the xml attribute that represents top or bottom value to use as the filter criteria. + + + + + Name of the xml attribute that represents flag indicating whether or not to filter by top order. + + + + + Name of the xml attribute that represents the actual cell value in the range + which is used to perform the comparison for this filter. + + + + + Name of the xml attribute that represents flag indicating whether or not to filter by percent value of the column. + + + + + Name of the xml tag that groups filter criteria together. + + + + + Flag indicating whether to filter by blank. + + + + + Name of the xml tag that expresses a filter criteria value. + + + + + Name of the xml attribute that represents filter value used in the criteria. + + + + + Name of the xml tag that represents custom filters criteria. + + + + + Name of the xml attribute that represents flag indicating whether the two criteria have an "and" relationship. + '1' indicates "and", '0' indicates "or". + + + + + Name of the xml tag that represents custom filter criteria. + + + + + Name of the xml attribute name that represents operator used by the filter comparison. + + + + + Name of the attribute that represents if filter shape should be visible. + + + + + Name of the attribute that represents if filter shape should be hidden. + + + + + Name of the xml tag that represents filter with date time. + + + + + Name of the attribute that represents grouping type. + + + + + Name of the attribute that represents year value. + + + + + Name of the attribute that represents month value. + + + + + Name of the attribute that represents day value. + + + + + Name of the attribute that represents hour value. + + + + + Name of the attribute that represents minute value. + + + + + Name of the attribute that represents second value. + + + + + Name of the tag that represent dynamic filter. + + + + + Name of the attribute that represent dynamic filter type. + + + + + Show results which are equal to criteria. + + + + + Show results which are greater than criteria. + + + + + Show results which are greater than or equal to criteria. + + + + + Show results which are less than criteria. + + + + + Show results which are less than or equal to criteria. + + + + + Show results which are not equal to criteria. + + + + + Convert string value to date filter type. + + string value need to convert. + Equalent date filter type. + + + + Convert date filter type to string value. + + date filter type need to convert. + Equalent string value. + + + + Class used for holding border settings. + + + + + Returns or sets the primary color of the object. + Read/write ExcelKnownColors. + + + + + Represents border line style. + + + + + This field is used only by Diagonal borders. For any other + border index property will have no influence. + + + + + Specifies a boolean value that indicate whether the border setting has a empty border + + + + + Initializes a new instance of the BorderSettingsHolder class. + + + + + Creates a shallow copy of the current System.Object. + + A shallow copy of the current System.Object. + + + + Gets or sets the primary color of the object. + Read/write ExcelKnownColors. + + + + + Gets color of the border. + + + + + Gets or sets color of the border. + + + + + Gets or sets the line style for the border. Read/write ExcelLineStyle. + + + + + Gets or sets a value indicating whether to show Diagonal lines. This property is used only by Diagonal borders. For any other border + index property will have no influence. + + + + + Specifies a boolean value that indicate whether the border setting has a empty border + + + + + Application object for this object. + + + + + Parent object for this object. + + + + + This class contains constants used for conditional formatting parsing/serialization + in Excel 2007 SpreadsheetML format. + + + + + Name of the xml tag that defines conditional formattings + + + + + Name of the xml tag that represents conditional formatting. + + + + + Name of the xml tag that represents conditional formatting rule. + + + + + Name of the xml tag that represent Ends With Spefific Text conitional formatting. + + + + + Name of the xml tag that represent Begins With Spefific Text conitional formatting. + + + + + Name of the xml tag that represent Contains Text Spefific Text conitional formatting. + + + + + Name of the xml tag that represent NotContains Text Spefific Text conitional formatting. + + + + + Name of the xml tag that represent contains error conitional formatting. + + + + + Name of the xml tag that represent not Contains Error conitional formatting. + + + + + Name of the xml tag that represent text attribute of Spefific Text conitional formatting. + + + + + Name of the xml attribute that represents type of conditional formatting rule. + + + + + Name of the xml attribute that represents time period type conditional formatting rule. + + + + + Name of the xml attribute that represents time period type attribute name. + + + + + Name of the xml attribute that represents an index to a dxf element in the Styles Part indicating which cell formatting to + apply when the conditional formatting rule criteria is met. + + + + + Name of the xml attribute that represents the operator in a "cell value is" conditional formatting rule. + + + + + Name of the xml tag that defines the border color. + + + + + Name of the xml tag that defines the negative fill color. + + + + + Name of the xml tag that defines the negative border color. + + + + + Name of the xml tag that defines the axis color. + + + + + Name of the xml attribute that represents the border of data bar + + + + + Name of the xml attribute that represents the gradient fill of data bar + + + + + Name of the xml attribute that represents the direction of data bar + + + + + Name of the xml attribute that represents the negative bar color of data bar + + + + + Name of the xml attribute that represents the negative bar border color of data bar + + + + + Name of the xml attribute that represents the axis position of data bar + + + + + Name of the extention list element + + + + + Name of the extention element + + + + + Represents top10 conditional formatting rule. + + + + + Represents aboveAverage conditional formatting rule. + + + + + Represents top10 conditional formatting rule. + + + + + Represents top10 conditional formatting rule. + + + + + Represents aboveAverage conditional formatting rule. + + + + + Today's time period type + + + + + Yesterday's time period type + + + + + Tomorrow's time period type + + + + + Last seven days time period type + + + + + Last week time period type + + + + + This week time period type + + + + + Next week time period type + + + + + Last month period type + + + + + This month period type + + + + + Next month time period type + + + + + Name of the xml tag that represents begin with condition. + + + + + Name of the xml tag that represents between condition. + + + + + Name of the xml tag that represents contains text condition. + + + + + Name of the xml tag that represents ends with condition. + + + + + Name of the xml tag that represents equal condition. + + + + + Name of the xml tag that represents greater than condition. + + + + + Name of the xml tag that represents greater than or equal to condition. + + + + + Name of the xml tag that represents less than condition. + + + + + Name of the xml tag that represents less than or equal to condition. + + + + + Name of the xml tag that represents not between condition. + + + + + Name of the xml tag that represents not contains condition. + + + + + Name of the xml tag that represents not equal condition. + + + + + Name of the xml tag To stop evaluating conditional formatting rules for a cell. + + + + + Name of the xml attribute that represents the priority of this conditional formatting rule. + + + + + Name of the xml tag name that represents a formula whose calculated value specifies the criteria for the conditional + formatting rule. + + + + + Represents conditional formatting rule that compares a cell value to a formula calculated result, using an operator. + + + + + Represents conditional formatting rule that contains a formula to evaluate. + + + + + Represents conditional formatting rule that contains databar. + + + + + Represents conditional formatting rule that contains pivot table. + + + + + Represents conditional formatting rule that contains iconset. + + + + + Represents conditional formatting rule that contains color scale. + + + + + Represents conditional formatting rule highlights cells that are completely blank + + + + + Represents conditional formatting rule highlights cells that are not blank + + + + + Describes a data bar conditional formatting rule. + + + + + Describes the values of the interpolation points in a gradient scale. + + + + + Describes the formula values of ValueObjects. + + + + + Describes the formula values of ValueObjects. + + + + + Describes the custom cf icon. + + + + + Default value for minimum length of the data bar. + + + + + Default value for maximum length of the data bar. + + + + + The maximum length of the data bar, as a percentage of the cell width. + + + + + The minimum length of the data bar, as a percentage of the cell width. + + + + + Indicates whether to show the values of the cells on which this data bar is applied. + + + + + Describes an icon set conditional formatting rule. + + + + + The icon set to display. + + + + + The icon id of custom icon. + + + + + Represents custom conditional formatting. + + + + + Describes a color scale conditional formatting rule. + + + + + Indicates whether the conditional format Range value is unique. + + + + + Indicates whether the conditional format Range value is dublicate. + + + + + Indicates whether the thresholds indicate percentile values, instead of number values. + + + + + If '1', reverses the default order of the icons in this icon set. + + + + + Greater attribute + + + + + Specifies the length of RIGHT or LEFT formula array. + + + + + Represents top10 conditional formatting rule. + + + + + Represents aboveAverage conditional formatting rule. + + + + + Possible value types for ConditionValue. + + + + + Names used in xml as IconSet type (order is important). + + + + + Prevents a default instance of the CF class from being created. + + + + + This class contains constants required for charts parsing and serialization in Excel 2007 format. + + + + + Main charts namespace. + + + + + Namespace of the slicer + + + + + Main charts namespace for Excel 2010 + + + + + Main charts namespace for Excel 2016 + + + + + + Chart style relation namespace for Excel 2013 + + + + + Chart style and color style namespace for charts above version 2013 + + + + + Uri for the pivot chart. + + + + + Uri for the pivot chart for Excel 2016. + + + + + prefix for the Excel 2010 chart tag. + + + + + prefix for the Excel 2016 chart tag. + + + + + This element specifies a category axis. + + + + + This element specifies a value axis. + + + + + This element specifies a series axis. + + + + + This element specifies a date axis. + + + + + Value attribute. + + + + + Some value axis id. + + + + + Some category axis id. + + + + + Some series axis id. + + + + + Some secondary category axis id. + + + + + Some secondary value axis id. + + + + + This element contains additional axis settings. + + + + + This element specifies the logarithmic base for a logarithmic axis. + + + + + This element specifies the maximum value of the axis. + + + + + This element specifies the minimum value of the axis. + + + + + This element specifies the stretching and stacking of the picture on the + data point, series, wall, or floor. + + + + + When specified as a child element of valAx, dateAx, catAx, or serAx, + this element specifies the identifier for the axis. When specified as + a child element of a chart, this element specifies the identifier of + an axis that defines the coordinate space of the chart. + + + + + Specifies that the values on the axis shall be reversed so they go from maximum to minimum. + + + + + Specifies that the axis values shall be in the usual order, minimum to maximum. + + + + + This element specifies the position of the axis on the chart. + + + + + Specifies that the axis shall be displayed at the left of the plot area. + + + + + Specifies that the axis shall be displayed at the right of the plot area. + + + + + Specifies that the axis shall be displayed at the top of the plot area. + + + + + Specifies that the axis shall be displayed at the bottom of the plot area. + + + + + This element specifies major gridlines. + + + + + This element specifies minor gridlines. + + + + + This element specifies number formatting for the parent element. + + + + + This element specifies a string representing the format code to apply. + + + + + Indicates whether number format is applied to the axis. + + + + + This element specifies the position of the tick labels on the axis. + + + + + Specifies the axis labels shall be at the high end of the perpendicular axis. + + + + + Specifies the axis labels shall be at the low end of the perpendicular axis. + + + + + Specifies the axis labels shall be next to the axis. + + + + + Specifies the axis labels are not drawn. + + + + + This element specifies the major tick marks. + + + + + This element specifies the minor tick marks. + + + + + Specifies there shall be no tick marks. + + + + + Specifies the tick marks shall be inside the plot area. + + + + + Specifies the tick marks shall be outside the plot area. + + + + + Specifies the tick marks shall cross the axis. + + + + + This element specifies the ID of axis that this axis crosses. + + + + + This element specifies whether the value axis crosses the category axis between categories. + + + + + Specifies the value axis shall cross the category axis between data markers. + + + + + Specifies the value axis shall cross the category axis at the midpoint of a category. + + + + + This element specifies the distance between major ticks. + + + + + This element specifies the distance between minor tick marks. + + + + + This element specifies the distance of labels from the axis. + + + + + This element specifies how many tick labels to skip between label that is drawn. + + + + + This element specifies how many tick marks shall be skipped before the next one shall be drawn. + + + + + This element specifies whether multi level labels exists or not + + + + + This element specifies the smallest time unit that is represented on the date axis. + + + + + This element specifies the time unit for major tick marks. + + + + + This element specifies the time unit for the minor tick marks. + + + + + This element specifies the chart. + + + + + This element specifies the plot area of the chart. + + + + + This element specifies whether the series form a bar (horizontal) chart or a column (vertical) chart. + + + + + Specifies that the chart is a bar chart - the data markers are horizontal rectangles. + + + + + Specifies that the chart is a column chart - the data markers are vertical rectangles. + + + + + This element specifies the type of grouping for a bar chart. + + + + + Specifies that the chart series are drawn next to each other along the category axis. + + + + + Specifies that the chart series are drawn next to each other along the + value axis and scaled to total 100%. + + + + + Specifies that the chart series are drawn next to each other on the value axis. + + + + + Specifies that the chart series are drawn next to each other on the depth axis. + + + + + This element specifies that each data marker in the series shall have a different color. + + + + + This element specifies a series on a chart. + + + + + This element specifies the index of the containing element. This index + shall determine which of the parent's children collection this element applies to. + + + + + This element specifies the order of the series in the collection. It is 0 based. + + + + + This element specifies the data values which shall be used to define + the location of data markers on a chart. + + + + + This element specifies the data used for the category axis. + + + + + This element specifies a reference to numeric data with a cache of the last values used. + + + + + This element specifies a reference to string data with a cache of the last values used. + + + + + This element specifies a reference to data for the category axis (or for the x-values in a bubble or scatter chart)), + along with a cache of the last values used. + + + + + This element specifies the last numeric data used for a chart. + + + + + This element specifies the last string data used for a chart. + + + + + This element specifies a cache of the labels on the category axis, or the x-values in a bubble or scatter chart. + + + + + This element specifies a reference to source of the data contained in this chart. + + + + + This element specifies overall settings for a single chart, and is the root node for the chart part. + + + + + This element specifies the 3-D area series on this chart. + + + + + This element specifies the 2-D area series on this chart. + + + + + This element contains the 2-D bar or column series on this chart. + + + + + This element contains the 3-D bar or column series on this chart. + + + + + This element contains the 3-D line chart series. + + + + + This element contains the 2-D line chart series. + + + + + This element specifies the space between bar or column clusters, + as a percentage of the bar or column width. + + + + + This element specifies the space between bar or column clusters, + as a percentage of the bar or column width. + + + + + This element specifies how much bars and columns shall overlap on 2-D charts. + + + + + Specifies the chart shall be drawn as a cone, with the base of the cone + on the floor and the point of the cone at the top of the data marker. + + + + + Specifies the chart shall be drawn with truncated cones such that the + point of the cone would be the maximum data value. + + + + + Specifies the chart shall be drawn as a rectangular pyramid, with the + base of the pyramid on the floor and the point of the pyramid at the + top of the data marker. + + + + + Specifies the chart shall be drawn with truncated cones such that the + point of the cone would be the maximum data value. + + + + + Specifies the chart shall be drawn as a cylinder. + + + + + Specifies the chart shall be drawn with a box shape. + + + + + This element specifies the shape of a series or a 3-D bar chart. + + + + + This element contains the bubble series on this chart. + + + + + This element specifies that the bubbles have a 3-D effect applied to them. + + + + + Default bubble scale value. + + + + + This element specifies the scale factor for the bubble chart. This element can be + an integer value from 0 to 300, corresponding to a percentage of the default size. + + + + + This element specifies negative sized bubbles shall be shown on a bubble chart. + + + + + Specifies the area of the bubbles shall be proportional to the bubble size value. + + + + + Specifies the radius of the bubbles shall be proportional to the bubble size value. + + + + + This element specifies how the bubble size values are represented on the chart. + + + + + This element contains the set of 2-D contour charts. + + + + + This element contains the set of 3-D surface series. + + + + + This element specifies the surface chart is drawn as a wireframe. + + + + + This element specifes the band formats + + + + + This element contains the radar chart series on this chart. + + + + + This element specifies what type of radar chart shall be drawn. + + + + + This element contains the scatter chart series for this chart. + + + + + This element specifies the type of lines for the scatter chart. + + + + + This element contains the 2-D pie series for this chart. + + + + + This element contains the 3-D pie series for this chart. + + + + + This element specifies the angle of the first pie or doughnut chart slice, + in degrees (clockwise from up). + + + + + This element contains the doughnut chart series. + + + + + This element specifies the size of the hole in a doughnut chart group. + + + + + This element contains the pie of pie or bar of pie series on this chart. + + + + + Specifies that the chart is pie of pie chart, not a bar of pie chart. + + + + + Specifies that the chart is a bar of pie chart, not a pie of pie chart. + + + + + This element specifies whether this chart is pie of pie or bar of pie. + + + + + This element specifies a value that shall be used to determine which data + points are in the second pie or bar on a pie of pie or bar of pie chart. + + + + + This element specifies the size of the second pie or bar of a pie of pie + chart or a bar of pie chart, as a percentage of the size of the first pie. + + + + + This element specifies how to determine which data points are in the + second pie or bar on a pie of pie or bar of pie chart. + + + + + This element contains the collection of stock chart series. + + + + + This element serves as a root element that specifies the settings for the + data labels for an entire series or the entire chart. It contains child + elements that specify the specific formatting and positioning settings. + + + + + This element specifies the position of the data label. + + + + + This element specifies that the value shall be shown in a data label. + + + + + This element specifies that the category name shall be shown in the data label. + + + + + This element specifies that the percentage shall be shown in a data label. + + + + + This element specifies the bubble size shall be shown in a data label. + + + + + This element specifies that the series name shall be shown in a data label. + + + + + This element specifies legend keys shall be shown in data labels. + + + + + This element specifies Leader Lines shall be shown in data labels. + + + + + This element specifies Leader Lines shall be shown in data labels. + + + + + This element specifies a datalabel range. + + + + + This element specifies a datalabel cache. + + + + + This element specifies a cellRange tag. + + + + + This element specifies a intervallocelle tag. + + + + + This element specfies a seriesName tag. + + + + + This element specifies a value tage. + + + + + This element specifies a value wert tag. + + + + + This element specifies a category name tag. + + + + + This element specifies a percentage tag. + + + + + This element specifies a category x axis tag. + + + + + This element specifies a value y axis tag. + + + + + This element specifies text that shall be used to separate the parts of a data label. + The default is a comma, except for pie charts showing only category name and percentage, + when a line break shall be used instead. + + + + + This element specifies a data marker. + + + + + This element specifies the marker that shall be used for the data points. + + + + + This element specifies the size of the marker in points. + + + + + This element specifies the floor of a 3D chart. + + + + + This element specifies the back wall of the chart. + + + + + This element specifies the side wall. + + + + + This element specifies a title. + + + + + This element specifies a trend line. + + + + + This element specifies the name of the trend line. + + + + + This element specifies the type of the trend line. + + + + + This element specifies the order of the polynomial trend line. + It is ignored for other trend line types. + + + + + This element specifies the period of the trend line for a moving average + trend line. It is ignored for other trend line types. + + + + + This element specifies the number of categories (or units on a scatter + chart) that the trend line extends after the data for the series that is + being trended. On non-scatter charts, the value must be a multiple of 0.5. + + + + + This element specifies the number of categories (or units on a scatter chart) + that the trend line extends before the data for the series that is being trended. + On non-scatter charts, the value shall be 0 or 0.5. + + + + + This element specifies the value where the trend line shall cross the y + axis. This property shall be supported only when the trend line type is + exp, linear, or poly. + + + + + This element specifies that the R-squared value of the trend line is + displayed on the chart (in the same label as the equation). + + + + + This element specifies that the equation for the trend line is displayed + on the chart (in the same label as the R-squared value). + + + + + This element specifies error bars. + + + + + This element specifies the type of the error bars - positive, negative, or both. + + + + + This element specifies the type of values used to determine the length of the error bars. + + + + + This element specifies an end cap is not drawn on the error bars. + + + + + This element specifies a value which is used with the Error Bar Type + to determine the length of the error bars. + + + + + This element specifies the error bar value in the positive direction. + It shall be used only when the errValType is cust. + + + + + This element specifies the error bar value in the negative direction. + It shall be used only when the errValType is cust. + + + + + Specifies that error bars shall be shown in the x direction. + + + + + Specifies that error bars shall be shown in the y direction. + + + + + This element specifies the direction of the error bars. + + + + + This element specifies the 3-D view of the chart. + + + + + This element specifies the amount a 3-D chart shall be rotated in the X direction. + + + + + This element specifies the height of a 3-D chart as a percentage of the + chart width (between 5 and 500). + + + + + This element specifies the amount a 3-D chart shall be rotated in the Y direction. + + + + + This element specifies that the chart axes are at right angles, + rather than drawn in perspective. Applies only to 3-D charts. + + + + + This element specifies the field of view angle for the 3-D chart. + This element is ignored if Right Angle Axes is true. + + + + + This element specifies the depth of a 3-D chart as a percentage of the + chart width (between 20 and 2000 percent). + + + + + This element specifies the legend. + + + + + This element specifies the position of the legend. + + + + + This element specifies that other chart elements shall be allowed to overlap this chart element. + + + + + This element specifies a legend entry. + + + + + This element specifies that the chart element specified by its containing + element shall be deleted from the chart. + + + + + This element specifies how blank cells shall be plotted on a chart. + + + + + This element specifies that only visible cells should be plotted on the chart. + + + + + This element specifies the page margins for a chart. + + + + + Specifies the contents of this attribute will contain the left page margin in inches. + + + + + Specifies the contents of this attribute will contain the right page margin in inches. + + + + + Specifies the contents of this attribute will contain the top page margin in inches. + + + + + Specifies the contents of this attribute will contain the bottom page margin in inches. + + + + + Specifies the contents of this attribute will contain the header margin in inches. + + + + + Specifies the contents of this attribute will contain the footer margin in inches. + + + + + This element specifies the up and down bars. + + + + + This element specifies the up bars on the chart. + + + + + This element specifies the down bars on the chart. + + + + + This element specifies text to use on a chart, including rich text formatting. + + + + + This element contains a string with rich text formatting. + + + + + This is the root element of Sheet Parts that are of type 'chartsheet'. + + + + + Prefix for chart namespace. + + + + + Underline the text with a single line of normal thickness. + + + + + Underline the text with two lines of normal thickness. + + + + + A single strikethrough is applied to the text. + + + + + A double strikethrough is applied to the text. + + + + + Text is not strike through. + + + + + This element specifies how this axis crosses the perpendicular axis. + + + + + This element specifies where on the axis the perpendicular axis crosses. + The units are dependent on the type of axis. + + + + + The category axis crosses at the zero point of the value axis (if possible), + or the minimum value (if the minimum is greater than zero) or the maximum + (if the maximum is less than zero). + + + + + The axis crosses at the maximum value + + + + + This element specifies the x values which shall be used to define the + location of data markers on a chart. + + + + + This element specifies the y values which shall be used to define the + location of data markers on a chart. + + + + + This element specifies the data for the sizes of the bubbles on the bubble chart. + + + + + This element specifies the amount the data point shall be moved from the center of the pie. + + + + + This element specifies series lines for the chart. + + + + + This element specifies the line connecting the points on the chart shall + be smoothed using Catmull-Rom splines. + + + + + This element specifies the label for the trend line. + + + + + This element specifies text for a series name, without rich text formatting. + + + + + This element specifies a text value for a category axis label or a series name. + + + + + This element specifies the high-low lines for the series. + + + + + This element specifies how the chart element is placed on the chart. + + + + + This element specifies how the chart element is placed on the chart manually + + + + + This element specifies the chart layout target + + + + + Represents left element for manual layout + + + + + Represents top element for manual layout + + + + + Represents the x location (left) of the chart element as a + fraction of width of the chart + + + + + Represents the y location (top) of the chart element as a + fraction of width of the chart + + + + + Represents the width or horizontal offset + + + + + Represents the height or a vertical offset + + + + + Represents the layout mode for the width of the element + + + + + Represents the layout mode for the height of the element + + + + + Represents the width of the element + + + + + Represents the height of the element + + + + + This element specifies a single data point. + + + + + This element specifies a data label. + + + + + This element specifies the logarithmic base for a logarithmic axis. + + + + + Default value of the logBase tag. + + + + + This element specifies the scaling value of the display units for the value axis. + + + + + This element specifies the display unit is one of the built in values. + + + + + This element specifies a custom value for the display unit. + + + + + This element specifies a data table. + + + + + This element specifies the horizontal borders shall be shown in a data table. + + + + + This element specifies the vertical border shall be shown in a data table. + + + + + This element specifies the outline shall be shown on a data table. + + + + + This element specifies the legend keys shall be shown in a data table. + + + + + This element specifies drop lines. + + + + + This element contains text properties. + + + + + This element specifies that this axis is a date or text axis based on + the data that is used for the axis labels, not a specific choice. + + + + + This element specifies the rounded corner tag. + + + + + This element specifies the style tag. + + + + + This element specifies the shapes drawn on top of the chart. + + + + + This element specifies that the shape described here to reside within a + chart should be sized based on relative anchor points. + + + + + This element specifies the relative x coordinate that is used to define + the percentage-based horizontal position for a shape within a chart drawing object. + + + + + This element specifies the relative y coordinate that is used to define + the percentage-based vertical position for a shape within a chart drawing object. + + + + + Multiplier for coordinates transform. + + + + + This element specifies a set of numbers used for the parent element. + + + + + This element specifies a set of strings used for the parent element. + + + + + This element contains the number of values in the cache. + + + + + This element specifies data for a particular data point. + + + + + This element specifies the series + to invert its colors if the value is negative. + + + + + Value attribute. + + + + + Pivot source tag + + + + + Pivot formats + + + + + Display units label + + + + + Zoom to fit + + + + + Label alignment + + + + + Print settings + + + + + Transparency value + + + + + Size value + + + + + Blur value + + + + + Angle value + + + + + Distance value + + + + + Bevel value + + + + + Pivot options tag + + + + + Pivot options tag 16 + + + + + Show zone filter tag + + + + + Show zone category tag + + + + + Show expand collapse tag 16 + + + + + Show zone data tag + + + + + Show zone series tag + + + + + Show zone visible tag + + + + + Pivot source name tag + + + + + Chart format id + + + + + Alternate content tag + + + + + Auto title deleted tag + + + + + Represents the standard Number format attribute. + + + + + Formual reference + + + + + Square reference + + + + + Full reference + + + + + C15 tag + + + + + C14 tag + + + + + xml15web + + + + + xml14web + + + + + Filter series uri + + + + + Invert solid fill format uri + + + + + Filtered area series + + + + + Filter bar series + + + + + Filtered line series + + + + + Filtered pie series + + + + + Filtered radar series + + + + + Filtered scatter series + + + + + Filtered surface series + + + + + Filtered bubble series + + + + + Filtered series title + + + + + Filtered category title + + + + + Invert solid fill format + + + + + This element represents color mapping information. + + + + + Name of the extention list element + + + + + Name of the extention element + + + + + Name of the leader lines element + + + + + Value indicates the show data lables over max element. + + + + + Value indicates the show data display options. + + + + + Value indicates the show the diaply #N/A as blank. + + + + + Prevents a default instance of the ChartConstants class from being created. + + + + + This class contains constants required for chartExs parsing and serialization in Excel 2016 format. + + + + + Main chartExs namespace. + + + + + Prefix for chartEx namespace. + + + + + Prefix for chartEx1 namespace for required. + + + + + Namespace used in choice content + + + + + The element specifies the chart data used for chartEx + + + + + The element specifies the data used for chartEx + + + + + The element specifies the text data used for chartEx text + + + + + The element specifies the value used for chartEx value + + + + + The element specifies the chart element position + + + + + The element specifies the chart element alignment + + + + + The element specifies the chart plot area region + + + + + The element specifies the chart axis + + + + + The element specifies the chart series + + + + + The element specifies the plot surface + + + + + The element specifies the chart data point + + + + + The element specifies the chart data labels + + + + + The element specifies the chart data label of single data point + + + + + The element specifies the chart data Id used in series + + + + + The element specifies the chart layout properties used in series + + + + + The element specifies the chart axis Id used in series + + + + + The element specifies the chart data Label position + + + + + The element specifies the data label hidden in setting + + + + + The element specifies the data label visibility setting + The element also specifies the visibility options on box and whisker, waterfall + + + + + The attribute specifies the data label visibility option of series Name + + + + + The attribute specifies the data label visibility option of category Name + + + + + The attribute specifies the data label visibility option of value + + + + + The attribute specifies the layout Id on series + + + + + The attribute specifies the series is hidden or not + + + + + The attribute specifies the owner index on series for refering other series + Pareto line series only + + + + + The attribute specifies the series unique Identifier + + + + + The attribute specifies the format index for series + + + + + The element specifies the parent label layout + + + + + The element specifies the by category option in histogram and pareto chart + + + + + The element specifies the binning option in histogram and pareto chart + + + + + The element specifies the statistics for the box and whisker series + + + + + The element specifies the subtotal for the water fall series + + + + + This attribute specifies the connector line used in Water fall chart + + + + + This attribute specifies the mean line used in Box and Whisker chart + + + + + This attribute specifies the mean marker used in Box and Whisker chart + + + + + This attribute specifies the mean non outliers used in Box and Whisker chart + + + + + This attribute specifies the outliers used in Box and Whisker chart + + + + + This attribute specifies the interval closing in Histogram, Pareto chart + + + + + This attribute specifies the underflow bin value in Histogram, Pareto chart + + + + + This attribute specifies the overflow bin value in Histogram, Pareto chart + + + + + This element specifies the bin width value in Histogram, Pareto chart + + + + + This element specifies the bin count in Histogram, Pareto chart + + + + + This attribute specifies the quartile method used in box and whisker chart + + + + + This value specifies the exclusive quartile method used in box and whisker chart + + + + + This value specifies the inclusive quartile method used in box and whisker chart + + + + + This element speifies the category axis scaling + + + + + This element speifies the value axis scaling + + + + + This attribute specifies the index of element + + + + + This string denotes the automatic value on current property + + + + + This element specifies the display unit axis + + + + + This element specifies the major tick marks. + + + + + This element specifies the minor tick marks. + + + + + Describes the tick marks in the axis + + + + + Describes the type attribute tag + + + + + Describes the Display unit label tag + + + + + Describes the Display unit attribute tag + + + + + This element describes the external data referenced in chartEx + + + + + This attibute specifies whether the work book need to be updated or not + + + + + This element describes the numeric dimension of data + + + + + This element describes the string dimension of data + + + + + This element describes the level of data + + + + + This attibute specifies direction for data dimension + + + + + Value indicates the diemension is column wise + + + + + Value indicates the diemension is row wise + + + + + This class contains the required chart style elements + + + + + It specifies visual and text properties for all elements present on a chart + + + + + It specifies colors used to resolve StyleColor in a ChartStyle. + + + + + Element specifies reference to a line style within the style matrix. + + + + + Element that specifies a multiplier to apply to the line width. + + + + + Element that specifies a reference to a fill style within the style matrix. + + + + + Element that specifies a reference to an effect style within the style + + + + + Element that specifies a reference to a themed font. + + + + + Element that specifies visual shape properties of the part of the chart associated with this CT_StyleEntry. + + + + + Element that specifies the default text character properties for a text body on a chart which is associated with this CT_StyleEntry + + + + + Element that specifies the body properties for a text body on a chart that is associated with this CT_StyleEntry. + + + + + Attribute that specifies the style matrix index of the style referred to. + + + + + Attribute that specifies a list of modifiers for this reference. + + + + + (Accent Color 1) Extra scheme color 1 + + + + + (Accent Color 2) Extra scheme color 2 + + + + + (Accent Color 3) Extra scheme color 3 + + + + + (Accent Color 4) Extra scheme color 4 + + + + + (Accent Color 5) Extra scheme color 5 + + + + + (Accent Color 6) Extra scheme color 6 + + + + + (Background Color 1) Semantic background color + + + + + (Background Color 2) Semantic additional background color + + + + + (Dark Color 1) Main dark color 1 + + + + + (Dark Color 2) Main dark color 2 + + + + + (Followed Hyperlink Color) Followed Hyperlink Color + + + + + (Hyperlink Color) Regular Hyperlink Color + + + + + (Light Color 1) Main Light Color 1 + + + + + (Light Color 2) Main Light Color 2 + + + + + (Style Color) A color used in theme definitions which means to use the color of the style. + + + + + (Text Color 1) Semantic text color + + + + + (Text Color 2) Semantic additional text color + + + + + It specifies a list of transforms that are appended to all colors in a ColorStyle to produce a variation of the color style + + + + + This class stores constants with different content types. + + + + + Bitmap image content type. + + + + + Jpeg image content type. + + + + + Png image content type. + + + + + Emf image content type. + + + + + Gif image content type. + + + + + Wmf image content type. + + + + + Svg image content type. + + + + + Content type for xml files. + + + + + Content type for rels files. + + + + + Content type for workbook item (used in [Content_Types].xml). + + + + + Content type for workbook item that contains macros (used in [Content_Types].xml). + + + + + Content type for macro template item that contains macros (used in [Content_Types].xml). + + + + + Content type for template item that contains macros (used in [Content_Types].xml). + + + + + Content type for calculation chain item. + + + + + Content type of the worksheet. + + + + + Content type of the chartsheet. + + + + + Content type of the dialogsheet. + + + + + Content type of the macrosheet + + + + + Content type of the intlmacrosheet + + + + + Content type of Person + + + + + Content type of meta data + + + + + Content type of the shared strings table. + + + + + Content type of the styles. + + + + + Content type of the vml drawings item. + + + + + Content type of the comments item. + + + + + Content type of the threaded comments item + + + + + Content type for drawings item. + + + + + Content type for chart drawings item. + + + + + Content type for core properties. + + + + + Content type for extended properties. + + + + + Content type for custom properties. + + + + + Content type for extern link item. + + + + + Content type for chart object. + + + + + Content type for chartEx object. + + + + + Content type for worksheet custom property. + + + + + Content type for pivot table. + + + + + Content type for pivot cache definition. + + + + + Content type for pivot cache records. + + + + + Content type for table object. + + + + + Content type for slicer object. + + + + + Content type for slicer cache object. + + + + + Content type for CustomXml Objects + + + + + Connections + + + + + Query table + + + + + Tiff image content type. + + + + + Content type for chart Style object. + + + + + Content type for chart color Style object. + + + + + Vba project content type + + + + + Binary worksheet content type. + + + + + Binary workbook styles content type. + + + + + Binary workbook SST content type. + + + + + Binary workbook content type. + + + + + This class gives access to xml tag/attribute names used for chart object + pagesetup serialization/parsing. + + + + + This class gives access to xml tag/attribute names used for + pagesetup serialization/parsing. + + + + + Gets name of the xml tag that stores margin settings. Read-only. + + + + + Gets name of the xml attribute used to store left margin. Read-only. + + + + + Gets name of the xml attribute used to store right margin. Read-only. + + + + + Gets name of the xml attribute used to store top margin. Read-only. + + + + + Gets name of the xml attribute used to store bottom margin. Read-only. + + + + + Gets name of the xml attribute used to store header margin. Read-only. + + + + + Gets name of the xml attribute used to store footer margin. Read-only. + + + + + Gets tag's namespace. Read-only. + + + + + Boolean value indicates whether the chart is ChartEx or not + + + + + Single pareameter constructor + + Boolean value used for chartEx type set + + + + Default constructor + + + + + Gets name of the xml tag that stores margin settings. Read-only. + + + + + Gets name of the xml attribute used to store left margin. Read-only. + + + + + Gets name of the xml attribute used to store right margin. Read-only. + + + + + Gets name of the xml attribute used to store top margin. Read-only. + + + + + Gets name of the xml attribute used to store bottom margin. Read-only. + + + + + Gets name of the xml attribute used to store header margin. Read-only. + + + + + Gets name of the xml attribute used to store footer margin. Read-only. + + + + + Gets tag's namespace. Read-only. + + + + + This class contains constants required for document properties parsing and serialization in Excel 2007 format. + + + + + Core properties enable users to get and set well-known and common sets of property metadata within packages. + + + + + Represents a categorization of the content of this package. + + + + + Represents the date of creation of the resource. + + + + + Represents an entity primarily responsible for making the content of the resource. + + + + + Represents an explanation of the content of the resource. + + + + + Represents a delimited set of keywords to support searching and indexing. + + + + + Represents the user who performed the last modification. + + + + + Represents the date and time of the last printing. + + + + + Represents the date on which the resource was changed. + + + + + Represents the topic of the content of the resource. + + + + + Represents the name given to the resource. + + + + + Represents Xsi attribute. + + + + + Represents Xsi attribute value. + + + + + Represents date time format structure. + + + + + This element specifies the application properties of a document. + + + + + This element specifies the name of the application that created this document. + + + + + This element specifies the total number of characters in a document. + + + + + This element specifies the name of a company associated with the document. + + + + + MS Excel uses this Tag to represents the xml parts. In our XlsIO, + this tag is used to find the document is generated by MS Excel. + + + + + Tag to represents the file is generated by XlsIO. + + + + + This element specifies the total number of lines in a document when last saved by a conforming producer if applicable. + + + + + This element specifies the name of a supervisor associated with the document. + + + + + This element specifies the total number of sound or video clips that are present in the document. + + + + + This element specifies the number of slides in a presentation containing notes. + + + + + This element specifies the total number of pages of a document if applicable. + + + + + This element specifies the total number of paragraphs found in a document if applicable. + + + + + This element specifies the intended format for a presentation document. + + + + + This element specifies the total number of slides in a presentation document. + + + + + This element specifies the name of an external document template containing format and style information + used to create the current document. + + + + + Total time that a document has been edited. The default time unit is minutes. + + + + + This element specifies the total number of words contained in a document when last saved. + + + + + This element specifies the base string used for evaluating relative hyperlinks in this document. + + + + + Represents default Excel97-03 hyperlink base name. + + + + + Represents Excel97-03 hyperlinks property + + + + + Parent element for the custom file properties part. + + + + + This element specifies a single custom file property. + + + + + Uniquely relates a custom property with an OLE property. + + + + + Uniquely relates a custom property with an OLE property. + + + + + Specifies the name of this custom file property. + + + + + This element specifies a Boolean variant type. + + + + + This element specifies a wide string variant type. + + + + + This element specifies a string variant type. + + + + + This element specifies a date variant type of type date-time as defined in RFC 3339. + + + + + This element specifies a 4-byte signed integer variant type. + + + + + This element specifies a 8-byte real number variant type. + + + + + This element specifies an integer variant type. + + + + + This element specifies a file-time variant type of type date-time. + + + + + Represents App version + + + + + This class contains constants related with external links storing in Excel 2007 format. + + + + + Main namespace for external links file. + + + + + This element is a container for specific types of external links. + + + + + This element represents an external workbook which is supplying data to the current workbook. + + + + + This element is the container for all of the worksheet names in a supporting workbook. + + + + + Name of a worksheet in the supporting workbook. + + + + + This element defines the collection of external references for this workbook. + + + + + This element defines an external reference that stores data for workbook elements. + + + + + Name of the xml attribute that stores sheet name value. + + + + + This element serves as the collection for 1 or more sheetData elements. + + + + + This element is a collection of the defined names associated with the supporting workbook. + + + + + This element contains information about a named range in an external workbook. + + + + + The defined name attribute. + + + + + The dde service attribute. + + + + + The dde topic attribute. + + + + + Name range definition string. + + + + + The index of the worksheet that the named range applies to for named ranges + that are scoped to a particular worksheet rather than the full workbook. + + + + + Cell Tag + + + + + Ole Link + + + + + Dde Link + + + + + Ole Items + + + + + Ole Item + + + + + Dde Items + + + + + Dde Item + + + + + Icon Attribute + + + + + Advise Attribute + + + + + Ole Attribute + + + + + Prefer Picture Attribute + + + + + This class stores all constants connected with page setup settings. + + + + + Print options for the sheet. + + + + + Used in conjunction with gridLinesSet. If both gridLines and gridlinesSet are true, then + grid lines shall print. Otherwise, they shall not (i.e., one or both have false values). + + + + + Used in conjunction with gridLines. If both gridLines and gridLinesSet are true, then + grid lines shall print. Otherwise, they shall not (i.e., one or both have false values). + + + + + Print row and column headings. + + + + + Center on page horizontally when printing. + + + + + Center on page vertically when printing. + + + + + Page margins for a sheet or a custom sheet view. + + + + + Bottom Page Margin in inches. + + + + + Footer Page Margin in inches. + + + + + Header Page Margin in inches. + + + + + Left Page Margin in inches. + + + + + Right Page Margin in inches. + + + + + Top Page Margin in inches. + + + + + Page setup settings for the worksheet. + + + + + Print black and white. + + + + + This attribute specifies how to print cell comments. + + + + + Number of copies to print. + + + + + Print without graphics. + + + + + Specifies how to print cell values for cells with errors. + + + + + Page number for first printed page. If no value is specified, then 'automatic' is assumed. + + + + + Number of vertical pages to fit on. + + + + + Number of horizontal pages to fit on. + + + + + Horizontal print resolution of the device. + + + + + Relationship Id of the devMode printer settings part. + + + + + Orientation of the page. + + + + + Order of printed pages. + + + + + Paper size + + + + + Print scaling. Valid values range from 10 to 400. + + + + + Use firstPageNumber value for first page number, and do not auto number the pages. + + + + + Use the printer�s defaults settings for page setup values and don't use the default values + specified in the schema. For example, if dpi is not present or specified in the XML, the + application shall not assume 600dpi as specified in the schema as a default and instead + shall let the printer specify the default dpi. + + + + + Vertical print resolution of the device. + + + + + Print cell comments as displayed. + + + + + Do not print cell comments. + + + + + Print cell comments at end of document. + + + + + Display cell errors as blank. + + + + + Display cell errors as dashes. + + + + + Display cell errors as displayed on screen. + + + + + Display cell errors as #N/A. + + + + + Header and footer settings. + + + + + Odd header string. + + + + + Odd footer string. + + + + + Header Footer Scales with Document string + + + + + Header Footer Margins align with Document string + + + + + Header Footer Odd/Even pages is different with the document string + + + + + Header Footer first page is different with document string + + + + + Even Header String + + + + + Even Footer String + + + + + First Header String + + + + + First Footer String + + + + + Prevents a default instance of the PageSetup class from being created. + + + + + This class contains constants used for pane parsing/serialization. + + + + + Represents worksheet view pane. + + + + + Horizontal position of the split, in 1/20th of a point; 0 (zero) if none. + If the pane is frozen, this value indicates the number of columns visible + in the top pane. + + + + + Vertical position of the split, in 1/20th of a point; 0 (zero) if none. + If the pane is frozen, this value indicates the number of rows visible + in the left pane. + + + + + Location of the top left visible cell in the bottom right pane (when in Left-To-Right mode). + + + + + The pane that is active. + + + + + Indicates whether the pane has horizontal / vertical splits, + and whether those splits are frozen. + + + + + Panes are frozen, but were not split being frozen. In this state, when the + panes are unfrozen again, a single pane results, with no split. + + + + + Panes are frozen and were split before being frozen. In this state, when + the panes are unfrozen again, the split remains, but is adjustable. + + + + + Panes are split, but not frozen. In this state, the split bars are adjustable by the user. + + + + + Selected or active cell information + + + + + Active cell in the worksheet + + + + + Sequence of References + + + + + Possible values for active pane. + + + + + Bottom left pane, when both vertical and horizontal splits are applied. + This value is also used when only a horizontal split has been applied, + dividing the pane into upper and lower regions. In that case, this value + specifies the bottom pane. + + + + + Bottom right pane, when both vertical and horizontal splits are applied. + + + + + Top left pane, when both vertical and horizontal splits are applied. + This value is also used when only a horizontal split has been applied, + dividing the pane into upper and lower regions. In that case, this value + specifies the top pane. This value is also used when only a vertical split + has been applied, dividing the pane into right and left regions. In that + case, this value specifies the left pane. + + + + + Top right pane, when both vertical and horizontal splits are applied. + This value is also used when only a vertical split has been applied, + dividing the pane into right and left regions. In that case, this value + specifies the right pane. + + + + + Defines constants required for protection parsing/serialization in Excel 2007 format. + + + + + This collection expresses the sheet protection options to enforce when the sheet is protected. + + + + + Specifies the hash of the password required for editing this worksheet. + This protection is optional and may be ignored by applications that choose not + to support this functionality. The hash is generated from an 8-bit wide character. + + + + + Objects are locked when the sheet is protected. + + + + + Scenarios are locked when the sheet is protected. + + + + + Formatting cells is locked when the sheet is protected. + + + + + Formatting columns is locked when the sheet is protected. + + + + + Formatting rows is locked when the sheet is protected. + + + + + Inserting columns is locked when the sheet is protected. + + + + + Inserting rows is locked when the sheet is protected. + + + + + Inserting hyperlinks is locked when the sheet is protected. + + + + + Deleting columns is locked when the sheet is protected. + + + + + Deleting rows is locked when the sheet is protected. + + + + + Selection of locked cells is locked when the sheet is protected. + + + + + Sorting is locked when the sheet is protected. + + + + + Autofilters are locked when the sheet is protected. + + + + + Selection of unlocked cells is locked when the sheet is protected. + + + + + Pivot tables are locked when the sheet is protected. + + + + + Sheet is locked when the sheet is protected. + + + + + Specifies the specific cryptographic hashing algorithm which shall be used along with the + salt attribute and input password in order to compute the hash value. + + + + + Specifies the hash value for the password required to edit this worksheet. + + + + + Specifies the number of times the hashing function shall be iteratively run. + + + + + Specifies the salt which was prepended to the user-supplied password before it was + hashed using the hashing algorithm. + + + + + Specifies the specific cryptographic hashing algorithm which shall be used along with the + salt attribute and input password in order to compute the hash value. + + + + + Specifies the hash value for the password required to edit this workbook. + + + + + Specifies the number of times the hashing function shall be iteratively run. + + + + + Specifies the salt which was prepended to the user-supplied password before it was + hashed using the hashing algorithm. + + + + + Specifies the username to whom which the password is reserved. + + + + + This element specifies options for protecting data in the workbook. Applications + may use workbook protection to prevent anyone from accidentally changing, moving, + or deleting important data. + + + + + Specifies a boolean value that indicates whether structure of workbook is locked. + + + + + Specifies a boolean value that indicates whether the windows that comprise the workbook are locked. + + + + + Specifies the hash of the password required for unlocking this workbook. + + + + + List of protection attribute names in the resulting file. + + + + + List of default values for protection options (order corresponds to ProtectionFlags and ProtectionAttributes). + + + + + List of protection attribute names in the resulting file. + + + + + Protection flags that correspond to ProtectionAttributes (order must be the same). + + + + + List of default values for protection options (order corresponds to ProtectionFlags and ProtectionAttributes). + + + + + Prevents a default instance of the Protection class from being created. + + + + + This class gives access to xml tag/attribute names used for tab sheet. + pagesetup serialization/parsing. + + + + + Gets name of the xml tag that stores margin settings. Read-only. + + + + + Gets name of the xml attribute used to store left margin. Read-only. + + + + + Gets name of the xml attribute used to store right margin. Read-only. + + + + + Gets name of the xml attribute used to store top margin. Read-only. + + + + + Gets name of the xml attribute used to store bottom margin. Read-only. + + + + + Gets name of the xml attribute used to store header margin. Read-only. + + + + + Gets name of the xml attribute used to store footer margin. Read-only. + + + + + Gets tag's namespace. Read-only. + + + + + Xml serializator. Serializes XlsIO workbook into dls xml file format. + + + + + This interface must be implemented by all xml serializators. + + + + + Saves workbook into writer. + + Writer to save workbook into. + Workbook to save. + + + + Root tag for dls format. + + + + + Protection attribute name. + + + + + Default protection value. + + + + + Styles tag in dls format. + + + + + Style tag in dls format. + + + + + Id attribute for style tag. + + + + + Name attribute for style tag. + + + + + Type attribute for style tag. + + + + + Sections tag in dls format. + + + + + Section tag in dls format. + + + + + Break code attribute in section tag. + + + + + Paragraphs tag in dls format. + + + + + Paragraph tag in dls format. + + + + + Items tag in dls format. + + + + + Item tag in dls format. + + + + + Rows tag in dls format. + + + + + Row tag in dls format. + + + + + Cells tag in dls format. + + + + + Cell tag in dls format. + + + + + Width attribute. + + + + + Text tag in dls format. + + + + + Text tag in dls format. + + + + + Columns count attribute in dls format. + + + + + Format tag in dls format. + + + + + Font name attribute in dls format. + + + + + Font size attribute in dls format. + + + + + Bold attribute in dls format. + + + + + Italic attribute in dls format. + + + + + Underline attribute in dls format. + + + + + Text color attribute in dls format. + + + + + Color prefix. + + + + + No underline in dls. + + + + + Single underline in dls. + + + + + Double underline in dls. + + + + + Subscript string in dls. + + + + + Super script in dls. + + + + + No sub/super script in dls. + + + + + SubSuperScript attribute in dls. + + + + + Strikeout attribute in dls. + + + + + Table format tag in dls. + + + + + Start of the character formatting tag. + + + + + Borders tag in dls. + + + + + Border tag in dls. + + + + + Color attribute string. + + + + + Line width attribute string. + + + + + Border type attribute string. + + + + + Border width for None border style. + + + + + Single border type. + + + + + Double border type. + + + + + Dot border type. + + + + + Dash with small gaps border type. + + + + + Dash dot border type. + + + + + Dash-dot-dot border type. + + + + + Thick border type. + + + + + None border type. + + + + + Tag name for page settings block. + + + + + Page height attribute. + + + + + Page width attribute. + + + + + Footer distance attribute. + + + + + Header distance attribute. + + + + + Top margin attribute. + + + + + Bottom margin attribute. + + + + + Left margin attribute. + + + + + Right margin attribute. + + + + + Page break after attribute. + + + + + Orientation attribute. + + + + + Paragraph format tag in dls format. + + + + + Headers-footers section start tag. + + + + + Value of item type for table item. + + + + + Start of even footer. + + + + + Start of even footer. + + + + + Start of even header. + + + + + Start of odd header. + + + + + Row height attribute. + + + + + Shadow color attribute. + + + + + Constant that is added to the column width to preserve place for borders. + + + + + Horizontal alignment attribute. + + + + + Vertical alignment attribute. + + + + + Alignment attribute value for center alignment. + + + + + Alignment attribute value for top alignment. + + + + + Alignment attribute value for bottom alignment. + + + + + Alignment attribute value for middle (center) alignment. + + + + + Alignment attribute value for left alignment. + + + + + Alignment attribute value for right alignment. + + + + + Alignment attribute value for justify alignment. + + + + + Start of first header + + + + + Start of first footer + + + + + True string in dls. + + + + + Excel borders that are supported by DLS. + + + + + Corresponding dls border names. + + + + + Represents dls culture. + + + + + Border width for Hair border style. + + + + + Border width for Thin border style. + + + + + Border width for Medium border style. + + + + + Border width for Thick border style. + + + + + Initializes a new instance of the DLSXmlSerializator class. + + + + + Saves workbook into writer. + + Writer to save workbook into. + Workbook to save. + + + + Serializes all required styles. + + Writer to save workbook into. + Workbook to save. + + + + Serializes all required document properties. + + Writer to save workbook into. + Workbook to save. + + + + Serializes all required sections. + + Writer to save workbook into. + Workbook to save. + + + + Serializes worksheet into xml writer. + + Writer to serialize into. + Worksheet to serialize. + + + + Serializes page settings. + + Writer to save workbook into. + Page setup. + + + + Serializes paragraphs. + + Writer to save worksheet into. + Worksheet to save. + Page width. + + + + Measure page area. + + Print area. + Output available page area size. + Headings size. + + + + Serializes specified range. + + Writer to serialize into. + Range to serialize. + Page size available for export. + Headings size. + Page order. + + + + Writes table format block with empty borders. + + Writer to write into. + + + + Writes borders for heading cells. + + Writer to write borders info into. + + + + Fills size of the next page to serialize. + + Range to serialize. + First row of the previous page; -1 for the first page. + First column of the previous page. + Last row of the previous page. + Last column of the previous page. + Available page size. + Page order. + True if there is next page to serialize; false otherwise. + + + + Returns maximum possible column that can fit into page. + + Parent worksheet. + One-based index of the first column. + Page width. + Last column that fits into page. + + + + Returns maximum possible row23 that can fit into page. + + Parent worksheet. + One-based index of the first row. + Page height. + Last row that fits into page. + + + + Serializes single row into writer. + + Writer to serialize into. + Worksheet that contains required row. + Row index to serialize. + First column to serialize. + Last column to serialize. + Represents Row id. + Headings size. + Row id after serialization. + + + + Serializes headings row into writer. + + Writer to serialize into. + Worksheet that contains required row. + Headings size + First column to serialize. + Last column to serialize. + Represents Row id. + Row id after serialization. + + + + Serializes single cell into xml. + + Writer to serialize into. + Worksheet that contains required cell. + Row index of the cell to serialize. + Column index of the cell to serialize. + Represents Cell id. + + + + Serializes single cell into xml. + + Writer to serialize into. + Represents Cell width. + Cell value to serialize. + Represents Cell id. + + + + Serializes table format. + + Writer to serialize into. + Format to serialize. + + + + Serializes borders collection. + + Writer to serialize into. + Extended format that contains borders to serialize. + + + + Returns string representing vertical alignment in dls format. + + Vertical alignment. + String representing vertical alignment in dls format. + + + + Returns string representing horizontal alignment in dls format. + + Horizontal alignment. + String representing horizontal alignment in dls format. + + + + Returns line width for dls format. + + Border to get width from. + Line width for dls format. + + + + Returns border type for dls format. + + Border to get type from. + Border type for dls format. + + + + Serializes rtf string. + + Writer to serialize into. + RTF string to serialize. + Cell extended format. + + + + Writes text block into XmlWriter. + + Writer to save into. + Text to write. + Font of the text to write. + Represents Item id. + + + + Writes font into xml writer. + + Writer to save font into. + Font to save. + + + + Serializes boolean attribute. + + Writer to serialize into. + Attribute name. + Attribute value. + + + + Converts color into string that is understandable by dls. + + Color to convert. + Color string representation in dls format. + + + + Converts excel underline into string in dls format. + + Underline type to convert. + String corresponding to the underline. + + + + Converts font into SubSuperScript string. + + Font to get settings from. + SubSuperScript string in dls format. + + + + Writes attribute string, converts value into points. + + Writer to write attribute into. + Attribute name. + Value to write. + Units in which value is specified. + + + + Writes attribute string. + + Writer to write attribute into. + Attribute name. + Value to write. + + + + Writes attribute string. + + Writer to write attribute into. + Attribute name. + Value to write. + + + + Serializes header and footer into XmlWriter. + + XmlWriter to serialize into. + Sheet with footer/header to serialize. + Available page width. + + + + Serializes header footer. + + Writer to serialize into. + Header/footer values. + Page width. + + + + Evaluates column width. + + Parent worksheet. + Column index. + Column width in points. + + + + This class contains constants used for data validation parsing / serialization + in Excel 2007 SpreadsheetML format. + + + + + Name of xml tag that represents data validations. + + + + + Name of xml attribute name that represents data validation item count + + + + + Name of xml attribute name that indicates whether all input prompts for the worksheet are disabled. + + + + + Name of xml attribute name that represents the x-coordinate (relative to window) of top-left + corner of the data validation input prompt (textbox). + + + + + Name of xml attribute name that represents the y-coordinate (relative to window) of top-left + corner of the data validation input prompt (textbox). + + + + + Name of xml tag that represents data validation. + + + + + Name of xml tag that represents list of choices + + + + + Name of xml attribute name that represents data validation error message. + + + + + Name of xml attribute name that represents data validation sequence of references. + + + + + Name of xml attribute name that represents data validation type. + + + + + Represents which uses a custom formula to check the cell value. + + + + + Represents which checks for date values satisfying the given condition. + + + + + Represents which checks for decimal values satisfying the given condition. + + + + + Represents which checks for a value matching one of list of values. + + + + + Represents no data validation. + + + + + Represents which checks for text values, whose length satisfies the given condition. + + + + + Represents which checks for time values satisfying the given condition. + + + + + Represrnts which checks for whole number values satisfying the given condition. + + + + + Name of xml attribute name that represents data validation allow blank status. + + + + + Name of xml attribute name that represents data validation message text. + + + + + Name of xml attribute name that represents data validation error style. + + + + + This data validation error style uses an information icon in the error alert. + + + + + This data validation error style uses a stop icon in the error alert. + + + + + This data validation error style uses a warning icon in the error alert. + + + + + Name of xml attribute name that represents data validation title bar text of error alert. + + + + + Name of xml attribute name that represents data validation relational operator used with this data validation. + + + + + Represents value which checks if a value is between two other values. + + + + + Represents value which checks if a value is equal to a specified value. + + + + + Represents value which checks if a value is greater than a specified value. + + + + + Represents value which checks if a value is greater than or equal to a specified value. + + + + + Represents value which checks if a value is less than a specified value. + + + + + Represents value which checks if a value is less than or equal to a specified value. + + + + + Represents value which checks if a value is not between two other values. + + + + + Represents value which checks if a value is not equal to a specified value. + + + + + Name of xml attribute name that represents data validation message text of input prompt. + + + + + Name of xml attribute name that represents data validation title bar text of input prompt. + + + + + Name of xml attribute name that indicates whether to display the dropdown combo box for a list type data validation. + + + + + Name of xml attribute name that indicates whether to display the error alert message. + + + + + Name of xml attribute name that indicates whether to display the input prompt message. + + + + + Name of xml tag name that represents the first formula in the data validation dropdown. + + + + + Name of xml tag name that represents the second formula in the data validation dropdown. + + + + + Represents Range pref. + + + + + Represents Type pref. + + + + + Represents Selected pref. + + + + + Represents Selected pref. + + + + + Represents Selected pref. + + + + + Represents Selected pref. + + + + + Represents Selected pref. + + + + + Represents Selected pref. + + + + + Represents Selected pref. + + + + + Represents Selected pref. + + + + + Represents Value pref. + + + + + Represents Qualifier pref. + + + + + Prevents a default instance of the DV class from being created. + + + + + Class used for find the missing namespace + + + + + store missing namespace prefix. + + + + + store missing namespace index. + + + + + stroe the missing name space and related values. + + + + + Default missing Name space prefix. + + + + + Constructor of the MyNameSpaceManger class. + + Table of atomized string objects + + + + Constructor of the MyNameSpaceManger class. + + Table of atomized string objects + Missing namespace + + + + Adding missing namespace to collection. + + + + + + Gets a value indicating whether the supplied prefix has a namespace defined for the current pushed scope. + + The prefix of the namespace you want to find. + True if there is a namespace defined; otherwise, false + + + + Gets the namespace URI for the specified prefix. + + The prefix of the namespace you want to find. + Return the perfix namespace + + + + Gets and sets the missing namespace Prefix + + + + + Gets and sets the Missing Namees Space index + + + + + The dictionary consists of a collection of namespace names keyed by prefix. + + + + + Class used for holding file data. + + + + + Name of the zip item with content types description. + + + + + Name of the directory with relations. + + + + + Extension for relations file. + + + + + Path to the top relations. + + + + + Xml files extension. + + + + + Relations default extension. + + + + + Binary item extension. + + + + + Default name of the workbook part. + + + + + Default name of the CustomXml Parts + + + + + Default name of the Person part + + + + + Default name of the meta data part + + + + + Default name of the shared strings part. + + + + + Default name of the styles part name. + + + + + Default name of the themes part name. + + + + + Path format for the worksheet part. + + + + + Path format for the chartsheet part. + + + + + Path format for the dialogsheet part. + + + + + Path format for the macrosheet part + + + + + Path format for intlmacrosheet part + + + + + Path format for pictures. + + + + + Default name of the extended properties part. + + + + + Default name of the core properties part. + + + + + Default name of the custom properties part. + + + + + Format for relation id generation. + + + + + Default name format for the external link items. + + + + + Start of the External links item name. + + + + + Start of the worksheet custom property item. + + + + + Default name format for cache definition. + + + + + Default name format for cache records. + + + + + Default name format for pivot table. + + + + + Format to get full path to zip archive item that stores tables. + + + + + Format to get full path to zip archive item that stores slicer. + + + + + Format to get full path to zip archive item that stores slicer cache. + + + + + External connection + + + + + Default path of the XmlMaps. + + + + + Default name of the XmlMaps part name. + + + + + Vba project path + + + + + List which contains items to be removed from ZipArchive. + + + + + worksheet list to be saved + + + + + Dictionary which contains the stream of the emf image file and wmf image file + + + + + Represents Zip Archive. + + + + + Parent workbook. + + + + + Parser to parse data if necessary. + + + + + Dictionary which is used to identify content type and stores default types. + Key - file extension (string), Value - content type (string). + + + + + Dictionary which is used to identify content type and stores type overrides. + Key - part name, Value - content type (string). + + + + + Top-level relations. + + + + + Name of the workbook part. + + + + + Name of the person part. + + + + + Name of meta data part + + + + + Name of the shared strings table part. + + + + + Name of the styles part. + + + + + Connection part. + + + + + Name of the themes part. + + + + + Object used for workbook serialization. + + + + + Represents list of workbook styles. + + + + + Workbook-level relationsm_strSlicerCacheRelationId + + + + + Specifies style relation id. + + + + + Specifies Person relation Id + + + + + Specifies metadata relation Id + + + + + Specifies slicer cache relation id. + + + + + Specifies shares string relation id. + + + + + Specifies theme relation id. + + + + + Specifies workbook content type. + + + + + Memory stream that will get workbook part after /sheets tag or after /definedNames tag. + + + + + Memory stream that will get workbook part before sheets tag. + + + + + Stream that can contains Dxfs formatting tags. + + + + + Index used to generate comments zip item names. + + + + + Index used to generate threaded comments zip item names. + + + + + Index used to generate vml zip item names. + + + + + Index used to generate drawing zip item names. + + + + + Index used to generate image zip item names. + + + + + Represents image id. + + + + + Index used to generate chart zip item names. + + + + + Index used to generate chartEx zip item names. + + + + + Index used to generate the pivotCache item name + + + + + Represents the slicer relations + + + + + Index used to generate the pivotCacheRecords item name + + + + + Index used to generate extern link zip item name. + + + + + Array that contains names of the image items. + + + + + Parsed dfx style list. + + + + + Workbook views collection. + + + + + Items that must be removed after parsing complete. + + + + + Stream containing functionGroups tag. + + + + + Build version, last edited version, etc.. + + + + + Calculation id. + + + + + Slicer cache id + + + + + Custom workbook views collection. + + + + + Drawings item path + + + + + Prevents a default instance of the FileDataHolder class from being created. + + + + + Initializes a new instance of the FileDataHolder class. + + Parent workbook for the new instance. + + + + Initializes a new instance of the FileDataHolder class. + + Parent workbook for the new instance. + File name to get initial data from. + Password to use during for decryption. + + + + Initializes a new instance of the FileDataHolder class. + + Parent workbook for the new instance. + Stream to get initial data from. + Password to use during for decryption. + + + + Requests password if necessary. + + Current password provided to the parsing method. + Application object used for password request. + + + + Re-requests password (called when provided password is incorrect). + + Current password. + Application object used for password request. + + + + Adds overriden content type. + + File name to override content type for. + Content type to set. + + + + Parses Dxf styles collection. + + Dxf style collection. + + + + Extracts sheet data. + + Represents sheet path. + Extracted sheet data + + + + Extracts worksheet. + + Represents sheet name. + Sheet extracted. + + + + Parses document. + + Represents theme colors in document. + + + + Finds workbook part name according to content type. + + Content type. + True if item was found; false otherwise. + + + + Gets the Workbook Save Type. + + Workbook Content Type. + + + + Parses content type. + + + + + Parses slicer cache + + + + + Parses all document properties. + + + + + Parses archive item by content type. Removes relation for this item and the item itself. + + Content type. + + + + Returns XmlReader for corresponding content type. + + Content type. + Name of the item that has specified content type. + Item name. + + + + Saves document into specified file. + + Name of the file to save into. + Type of the saving format. + + + + Saves document into specified stream. + + Stream to save into. + Type of the saving format. + + + + Saves document inside internal zip archive. + + Type of the saving format. + + + + Registers correct content type into collections of default content types. + + Image format of the picture to register content type for. + Proposed picture file extension. + + + + Registers correct content type into collections of default content types. + + Proposed picture file extension. + + + + Converts image format into content type and file extension. + + Image format to convert. + Resulting file extension. + Content type for this image format. + + + + Saves image into appropriate location inside document. + + Image to save. + Proposed item name, null - autogenerate. + Generated item name. + + + + Saves image into appropriate location inside document. + + Image to save. + Destination image format. + Proposed item name, null - autogenerate. + Generated item name. + + + + Get Extension of the image and return Image format of the image + + Extension of the image + Image format of the image + + + + Gets image item name. + + Image index to get name for. + Name of Image item. + + + + Prepares a new archive item. + + Start of the item's name. + Represents file extension. + Content type for the new item. + Parent relations collection. + Relation type. + Variable used as counter of already created items of the same type. + Created archive item. + Represents relation ID + + + + Converts image format into picture file extension. + + Format to convert. + Extension for picture file. + + + + Parses workbook. + + Represents theme color in workbook. + + + + Parses the metaProperties + + + + + Parses the CustomXmlParts + + + + + Parses the CustomXml Items + + CustomXmlParts collections + Schemas + XmlPartName + XmlID + + + + Parses the CustomXmlParts ItemPropeties + + PropertyName + Schemas + + + + Parses relations item. + + Path to the item to parse. + Parsed relations collection; null if there are no such relation item. + + + + Tries to find path to the item by content type. + + Content type to locate. + First occurrence of the item with specified content type. + + + + Tries to find path to the item by content type inside default types. + + Content type to locate. + First occurrence of the item with specified content type. + + + + Tries to find path to the item by content type inside overridden types. + + Content type to locate. + First occurrence of the item with specified content type. + + + + Gets relations. + + Item name to get corresponding relation. + Extracted relation + + + + Splits item name (including path) into item name and path to this item. + + Item name to split. + Path without item name. + Item name without path. + + + + Gets image. + + Path of the image. + Extracted image + + + + Creates XmlReader for specified zip archive item. + + Item to create reader for. + Created reader. + + + + Creates XmlReader for specified zip archive item. + + Relation that points to the archive item. + Path to the parent item. + Created reader. + + + + Creates XmlReader and fixes potential br tags issue. + + Relation that points to the archive item. + Path to the parent item. + Path to the desired item. + Created reader. + + + + Creates XmlReader for specified zip archive item. + + Relation that points to the archive item. + Path to the parent item. + Path to the desired item. + Created reader. + + + + Returns single zip item based on the relation and parent path. + + Relation that points to the archive item. + Path to the parent item. + Path to the desired item. + Requested zip item. + + + + Creates XmlReader for specified zip archive item. + + Relation that points to the archive item. + Path to the parent item. + Indicates whether item must be removed after extracting data. + Created reader. + + + + Parses external link. + + Represents relation id. + + + + Tries to combine two paths into one. + + First part of the path. + Second part of the path. + Combined path. + + + + Creates or updates content types and saves them inside internal zip archive. + + + + + Saves all document properties. + + + + + Saves all ContentTypeProperties + + + + + Saves archive item, adds corresponding record into content type and relation collections. + + Part name value. + Content type value. + Relation type value. + + + + Saves archive item by part name into zip archive item. + + Item part name. + + + + Fills default content types. + + + + + Saves top level relation in zip. + + + + + Generates relation id for specified relation index. + + Relation index to generate relation id. + Generated relation id. + + + + Saves workbook. + + + + + Selects correct workbook content type depending on workbook's content and desired save type. + + Workbook content type. + + + + Saves all exisiting pivot caches. + + + + + Saves single pivot cache item. + + Cache object to save. + Name of the file item with cache definition. + + + + Saves pivot cache definition for the specified cache. + + Cache to save definition for. + Name of the file with pivot cache records for this pivot cache. + Name of the file item with cache definition. + + + + Saves pivot cache records. + + Cache to save records for. + Name of the save item. + + + + Generates unique name for pivot cache records. + + Cache to generate name for. + Generated file name. + + + + Generates cache file anme. + + Cache to generate file name for. + Generated file name. + + + + Saves all workbook images. + + Array containing zip name with images. + + + + Serializes image from MsofbtBSE record. + + Record to serialize. + Name of the zip item with image. + + + + Saves CustomXmlParts into internal zip archive. + + + + + Saves ItemProperties Relation in the zip Archive + + + + + Saves the Xml Data in Zip Archive + + + + + Saves CustomXmlParts Items Properties and Schema Collections + + customXmlPart + PropertyName to be serialized + xml PartName to be Serialized + + + + Saves styles into internal zip archive. + + Dictionary with new XF indexes. + + + + Saves Person into internal zip archive + + + + + Saves meta data into internal zip archive + + + + + Saves shared strings table into internal zip archive. + + + + + Saves slicer cache into internal zip archive. + + + + + Saves workbook part into internal zip archive. + + + + + Save Vba Project + + + + + Adds relations to the collection, tries to re-use specified relation id if not null. + + Collection to add new relation to. + Relation target. + Parent path for the relation target. + Relation type. + Relation id to re-use if not null. + Used relation id. + + + + Serializes relations collection. + + Name of the parent + Represents relations + + + + Saves all sheets (worksheets and chartsheets) into internal zip archive + and updates relations collection. + + Workbook relations collection. + Name of the workbook item. + Dictionary with new XF indexes, key - old index, value - new index. + Dictionary that will contain pivot cache files + (key - cache object, value - cache file name). + + + + Reserves ids for worksheets that were extracted from original file. + + Worksheets to iterate through. + Collection to put reservation into. + + + + Saves single sheet into internal zip archive. + + Sheet to save. + Name of the sheet's item in the zip archive. + Workbook relations collection. + Path to the workbook without file name. + Dictionary with new XF indexes, key - old index, value - new index. + Dictionary that will contain pivot cache files + (key - cache object, value - cache file name). + + + + Saves single dialog sheet into internal zip archive. + + Sheet to save. + Name of the sheet's item in the zip archive. + Workbook relations collection. + Path to the workbook without file name. + Dictionary with new XF indexes, key - old index, value - new index. + Dictionary that will contain pivot cache files + (key - cache object, value - cache file name). + + + + Saves Macrosheet and IntlMacrosheet into internal zip archive. + + Sheet to save + Name of the sheet's item in the zip archive + Workbook relations collection + Path to the workbook without file name. + Dictionary with new XF indexes, key - old index, value - new index + Dictionary that will contain pivot cache files + (key - cache object, value - cache file name) + + + + Serializes single worksheet object. + + Worksheet to serialize. + Name of a zip item to use. + Dictionary with new XF indexes, key - old index, value - new index. + Dictionary that will contain pivot cache files + (key - cache object, value - cache file name). + + + + Updates archive item + + Worksheet to add + Worksheet name to add + + + + Saves chartsheet into internal zip archive. + + Chartsheet to save. + Name of a zip item to use. + + + + Serializes existing worksheet/chartsheet data without any modifications. + + Sheet to serialize. + New corresponding zip archive item name. + + + + This method removes calculation chain item from the document. + + + + + Serializes single external link. + + Extern workbook item that contains link information to serialize. + Name of the external link item. + + + + Generates zip archive item name for external link. + + Generated item name. + + + + Generates unique item name. + + Items counter. Contains current item index to try and is updated during operation. + Starting part of the path. + Item's extension. + Generated name. + + + + Generates unique item name. + + Items counter. Contains current item index to try and is updated during operation. + Path format string. + Generated name. + + + + Genreates unique name for pivot table item. + + Generated name. + + + + Creates data holder for the specified worksheet. + + Tabsheet to create data holder for. + File name for the tabsheet item. + + + + Serializes table object. + + Table to serialize. + Name of the created file. + + + + Serializes slicer object. + + Slicers to serialize. + Name of the created file. + + + + Generates file name for the table item. + + Generated item name. + + + + Generates file name for the slicer item. + + Generated item name. + + + + Generates file name for the slicer item. + + Generated item name. + + + + Gets content type by item name. + + + + + + + Connection + + + + + Serialize Query Table + + + + + + + + Serialize Table Relations + + + + + + + Serialize XML mapping. + + + + + Saves workbook into specified file. + + Destination file name. + Workbook to save. + Save type. + + + + Saves workbook into stream. + + Stream to save into. + Workbook to save. + Save type (template or ordinary xls). + + + + Creates copy of the current object. + + Parent workbook for the new object. + A copy of the current object. + + + + Creates copy of the workbook's views. + + List with cloned items. + + + + Creates copy of the parsed Dxf items. + + List with copied items. + + + + Dispose + + + + + Gets parent workbook. Read-only. + + + + + Gets Excel 2007 parser. + + + + + Returns archive item corresponding to the relation. + + + + + Gets object used for serialization. + + + + + Gets cell styles. + + + + + Gets zip archive object that stores Excel 2007 document. + + + + + Gets or sets last used index of the comment item. + + + + + Gets or sets last used index of the threaded comment item. + + + + + Gets or sets last used index of the vml item. + + + + + Gets or sets last used index of the drawing item. + + + + + Gets or sets last used index of the image item. + + + + + Gets or sets last used image id. + + + + + Gets or sets last used index of the chart item. + + + + + Gets or sets last used index of the chartEx item. + + + + + gets or set the pivotCache index + + + + + gets or set the pivotCache index + + + + + Gets dictionary with default content types. Read-only. + + + + + Gets dictionary with overridden content types. Read-only. + + + + + Gets number of parsed dfx styles or int min value if nothing was parsed. + + + + + Gets Items that must be removed after parsing complete. Read-only. + + + + + Gest or sets Calculation ID + + + + + Slicer cache id + + + + + Gets the File Version + + + + + Gets the preserved caches + + + + + Gets or sets extension stream + + + + + Gets Items that must be removed. Read-only. + + + + + Drawings item path + + + + + Represents the slicer relations + + + + + Represents the slicer relations + + + + + This class is responsible for gradient serialization. + + + + + Serializes gradient stops collection into specified XmlWriter. + + XmlWriter to serialize into. + Collection to serialize. + Parent workbook object. + + + + Serializes collection of gradient stops. + + XmlWriter to serialize into. + Collection to serialize. + Parent workbook. + + + + Serializes single gradient stop. + + XmlWriter to serialize into. + GradientStop to serialize. + Parent workbook. + + + + This class stores relation data (except relation id). + + + + + Represents Target. + + + + + Target type. + + + + + Defines whether target is external or not. + + + + + Prevents a default instance of the Relation class from being created. + + + + + Initializes a new instance of the Relation class. + + Represents target. + Represents destination type. + + + + Initializes a new instance of the Relation class. + + Represents target. + Represents destination type. + Value indicating whether target is external. + + + + Create copy of the current object. + + A copy of the current object. + + + + Gets target. Read-only. + + + + + Gets destination type. Read-only. + + + + + Gets a value indicating whether target is external. + + + + + Class used for Relations Collection. + + + + + Relation id start. + + + + + Length of the relation id start. + + + + + Dictionary with relations. Key - relation id, value = relation object. + + + + + Path to the item (this member should be filled when extracting collection from file). + + + + + Initializes a new instance of the RelationsCollection class. + + + + + Removes relation by id. + + Relation id to remove. + + + + Removes relation by content type. + + Content type of relation to delete. + + + + Searches for relation with appropriate target path and removes it from collection. + + Item name to be removed. + + + + Searches for relation with appropriate content type. + + Content type to find. + Relation id. + Relation that contains desired content type or null if not found. + + + + Calculate the pivot table count in workbook. + + + + + + + Searches for relation with appropriate target path. + + Item name to find. + Relation id that contains points to specified content type or null if not found. + + + + Generates relation id that can be used as relation key. + + Free relation key. + + + + Generates relation id that can be used as relation key. + + Free relation key. + + + + Generates id and adds relations to there collection. + + Relation to add. + Relation id. + + + + Generates id and adds relations to there collection. + + Relation to add. + Index of relation id. + Relation id. + + + + Generates id and adds relations to there collection. + + Relation to add. + String ID + Relation id. + + + + Removes all items from the collection. + + + + + Creates copy of the current collection. + + A copy of the current collection. + + + + Creates copy of the current collection. + + A copy of the current collection. + + + + Dispose Relations + + + + + Returns an enumerator that can iterate through a collection. + + An IEnumerator that can be used to iterate through the collection. + + + + Gets / sets relation by id. + + + + + Gets number of items in the collection. Read-only. + + + + + Gets or sets path to the item (this member should be filled when extracting collection from file). + + + + + Dictionary with relations. Key - relation id, value = relation object. + + + + + This class simply hold all constants required by relations. + + + + + Content type for workbook item (used in relations). + + + + + Content type for styles item (used in relations). + + + + + Content type for Person item + + + + + Content type for metadata + + + + + Content type for SST dictionary item (used in relations). + + + + + Content type for calculation chain item (used in relations). + + + + + Content type for vml drawings (used in worksheet relations). + + + + + Content type of comment notes items (used in worksheet relations). + + + + + Content type of threaded comments (used in worksheet relations). + + + + + Content type for drawings (used in worksheet relations). + + + + + Content type for chart drawings (used in worksheet relations). + + + + + Represents package level relationships namespace. + + + + + Content type for theme item (used in relations). + + + + + Content type for image item (used in relations). + + + + + Content type for core properties item (used in relations). + + + + + Content type for extended properties item (used in relations). + + + + + Content type for custom properties item (used in relations). + + + + + Content type for path to extern link source (used in relations). + + + + + Content type for external link (used in relations). + + + + + Content type for chart. + + + + + Relation type for worksheet custom property. + + + + + Content type for path to extern link source that is missing. + + + + + Content type for pivot cache definition. + + + + + Content type for pivot cache records. + + + + + Content type for pivot table. + + + + + Content type for table object. + + + + + Content type for slicer object. + + + + + Content type for slicer cache object. + + + + + Content Type for Ole object. + + + + + Content Type for Dde object. + + + + + Content Type for External connection. + + + + + Content Type for Query Table. + + + + + Content Type for Theme Override. + + + + + Content type for XmlMaps. + + + + + Content Type for ChartEx. + + + + + Vba Project Relation type + + + + + Prevents a default instance of the RelationTypes class from being created. + + + + + This class is used for picture shapes serialization. + + + + + Dictionary to hold Svg streams. + + + + + This method serializes specified shape into specified writer. + + XmlWriter to serialize shape settings into. + Shape to serialize. + Parent worksheet data holder. + + + + Serializes picture. + + Writer to serialize into. + Picture to serialize. + Relation id of the picture file. + Object that stores data of the parent worksheet. + + + + + This method serializes shape properties. + + XmlWriter to serialize into. + Picture to get properties from. + + + + Serialize shadow properties for picture shape + + xmlTextWriter object + picture to which shape properties belong to + Shape property node + + + + Serializes non visual properties. + + XmlWriter to serialize into. + Picture to serialize. + Object that stores data of the parent worksheet. + + + + Serializes non visual picture canvas properties. + + XmlWriter to serialize into. + Picture to serialize. + + + + Serializes blip fill. + + XmlWriter to save blip fill into. + Picture to get blip fill options from. + Relation id of the picture zip archive item. + + + + Serializes DueTone color. + + XmlWriter to save blip fill into. + Picture to get blip fill options from. + + + + Serializes Color Change. + + XmlWriter to save blip fill into. + Picture to get blip fill options from. + + + + This method serializes general shape settings (shape type) into specified XmlWriter. + + XmlWriter to write shape type into. + Type of the shape that is going to be serialized. + + + + Serializes picture file and creates necessary relations. + + Object that holds file data. + Picture to save into file. + Relation id of the generated picture item. + + + + Returns the SVG picture path when the stream already exists + + SVG Stream + Worksheet Data holder + Returns the SVG picture path when the stream already exists + + + + Serializes extension list for the blip node. + + XmlWriter to write shape type into. + Picture to which the extension list belongs to. + + + + Serializes various shape properties of a picture + + xmlTextWriter object + picture to which shape properties belong to + Shape property node + + + + Serializes fill properties of a picture + + xmlTextWriter object + picture to which fill properties belong to + Shape property node + + + + Clears the Svg data. + + + + + Gets the dictionary to hold Svg streams. + + + + + This class is responsible for chart shape serialization. + + + + + Format for the default chart item. + + + + + Format for the default chart Ex item. + + + + + Format for the default chart color style + + + + + Format for the default chart style + + + + + This method serializes specified shape into specified writer. + + XmlWriter to serialize shape settings into. + Shape to serialize. + Parent worksheet data holder. + + + + Serialize chart object into separate file and returns relation id. + + Parent worksheet data holder. + Chart to serialize. + Gets name of the chart item. + Relation id of the serialize chart object. + + + + Generates item name for the new chart object. + + Parent worksheet data holder. + Chart to generate name for. + Item name that should be used to save chart. + + + + Generates item name for the new chartEx object. + + Parent worksheet data holder. + Chart to generate name for. + Item name that should be used to save chart. + + + + Serializes chart shape properties. + + XmlWriter to serialize into. + Chart to serialize. + Relation id that points to the chart object. + Parent worksheet data holder. + + + + Serializes all graphics xml tag and all subtags. + + XmlWriter to serialize into. + Chart to serialize. + Relation id of the chart object item. + Boolean value indicates whether the chart is chartEx type or not + + + + Serialize slicer elements of graphic frames + + XmlWriter to serialize into. + shape to serialize. + Relation id of the chart object item. + + + + Serializes non visual graphic frame properties. + + XmlWriter to serialize into. + Chart shape to serialize. + Parent worksheet data holder. + + + + Class used for serializing Checkbox. + + + + + Serialize the check box shape + + XmlWriter to serialize fill color from. + shae to set fill color to. + relation Collection of the item + path of the item + + + + Serializes additional tag into ClientData tag. + + XmlWriter to serialize into. + Shape to serialize for. + + + + Serialize internal part of the div object. + + XmlWriter to serialize into. + Shape to serialize. + + + + Serializes subnodes of the shapetype description. + + Writer to serialize into. + + + + Returns instance number of supported shape object. Read-only. + + + + + Returns string representation of the shape type. Read-only. + + + + + Class used for serializing comments. + + + + + Adds required style properties to the list in the format 'name':'value'. + + List to add properties to. + Shape to prepare styles for. + + + + Serializes additional tag into ClientData tag. + + XmlWriter to serialize into. + Shape to serialize for. + + + + Serializes subnodes of the shape tag. + + XmlWriter to serialize into. + Shape to serialize for. + + + + Serializes subnodes of the shapetype description. + + Writer to serialize into. + + + + Returns instance number of supported shape object. Read-only. + + + + + Returns string representation of the shape type. Read-only. + + + + + Class used for defining constants and namespace for drawings. + + + + + Name of the tag objectPr + + + + + Store move with cells value + + + + + Store size with cells value + + + + + Store the default size value + + + + + Main spreadsheet drawings namespace ('xdr' abbreviation is used in MS Excel documents). + + + + + Main drawings namespace ('a' abbreviation is used in MS Excel documents). + + + + + Main drawings namespace ('a16' abbreviation is used in MS Excel documents). + + + + + Svg drawing namespace. + + + + + Main chartsheet drawings namespace ('cdr' abbreviation is used in MS Excel documents). + + + + + Main drawings namespace ('a14' abbreviation is used in MS Excel documents). + + + + + Prefix used by MS Excel for XdrNamespace definition. + + + + + Prefix used by MS Excel for CdrNamespace definition. + + + + + Prefix used by MS Excel for ANamespace definition. + + + + + Prefix used by MS Excel for A14Namespace definition. + + + + + Prefix used by MS Excel for A16Namespace definition. + + + + + Prefix used by MS Excel for CreationId + + + + + Prefix used by MS Excel for Sle + + + + + Prefix used by MS Excel for Sle15 + + + + + This element specifies the camera tool option in pictures. + + + + + This element specifies the cell range in camera tool option. + + + + + URI string used by MS Excel for camera tool. + + + + + Prefix used by MS Excel for ASvgNamespace definition. + + + + + Attribute used to denote the requires + + + + + Element specifies the fallback content + + + + + This element specifies a two cell anchor placeholder for a group, a shape, + or a drawing element. It moves with cells and its extents are in EMU units. + + + + + This element specifies a one cell anchor placeholder for a group, a shape, + or a drawing element. It moves with the cell and its extents is in EMU units. + + + + + This element Specifies the form control element. + + + + + This element specifies the form control element. + + + + + Specifies how the DrawingML contents shall be moved and/or resized when + the rows and columns between its start and ending anchor (the from and + to child elements) are resized, or have additional rows/columns inserted + within them, or additional row/columns are added before them. + + + + + This element specifies the first anchor point for the drawing element. + This will be used to anchor the top and left sides of the shape within + the spreadsheet. That is when the cell that is specified in the from + element is adjusted, the shape will also be adjusted. + + + + + This element specifies the second anchor point for the drawing element. + This will be used to anchor the bottom and right sides of the shape within + the spreadsheet. That is when the cell that is specified in the to element + is adjusted, the shape will also be adjusted. + + + + + This element specifies the column that will be used within the from and to + elements to specify anchoring information for a shape within a spreadsheet. + + + + + This element is used to specify the column offset within a cell. + + + + + This element specifies the row that will be used within the from and to + elements to specify anchoring information for a shape within a spreadsheet. + + + + + This element is used to specify the row offset within a cell. + + + + + This element specifies the non visual properties for a picture. + This allows for additional information that does not affect + the appearance of the picture to be stored. + + + + + This element specifies non-visual canvas properties. + + + + + This element specifies non-visual group shape properties. + + + + + This element specifies group shape properties. + + + + + This element specifies the non-visual connector shape drawing properties + + + + + This element specifies the non-visual properties for the picture canvas. + + + + + This element specifies the on-click hyperlink information to be applied to a run of text. + When the hyperlink text is clicked the link is fetched. + + + + + This element specifies the type of picture fill that the picture object + will have. Because a picture has a picture fill already by default, + it is possible to have two fills specified for a picture object. + + + + + This element specifies the existence of an image (binary large image + or picture) and contains a reference to the image data. + + + + + It's define the Picture fill option + + + + + It's define the values of Transparency + + + + + Specifies the identification information for an embedded picture. This + attribute is used to specify an image that resides locally within the file. + + + + + Specifies the identification information for a linked picture. This + attribute is used to specify an image that is added as external link. + + + + + Specifies that the current start and end positions shall be maintained + with respect to the distances from the absolute start point of the worksheet. + + + + + Specifies that the current drawing shall move with its row and column + (i.e. the object is anchored to the actual from row and column), but + that the size shall remain absolute. + + + + + Specifies that the current drawing shall move and resize to maintain its + row and column anchors (i.e. the object is anchored to the actual from + and to row and column). + + + + + This element specifies that a BLIP should be stretched to fill the target rectangle. + + + + + This element specifies that a BLIP should be tiled to fill the available space. + + + + + This element specifies the portion of the blip used for the fill. + + + + + This element specifies a fill rectangle. When stretching of an image is specified, + a source rectangle, srcRect, is scaled to fit the specified fill rectangle. + + + + + This element specifies the existence of a picture object within the document. + + + + + Name of the xml attribute that stores id. + + + + + Name of the xml attribute that stores shape name. + + + + + Name of the xml attribute that stores alternative description. + + + + + This element specifies all locking properties for a graphic frame. + + + + + Specifies that the generating application should not allow aspect ratio + changes for the corresponding connection shape. If this attribute is not + specified, then a value of false is assumed. + + + + + This element specifies the visual shape properties that can be applied to a shape. + + + + + This element specifies the thickness of the walls or floor as a percentage of the largest dimension of the plot volume. + + + + + It's define picturefill in shapeproperty. + + + + + It's define pictureformat options + + + + + It's define pictureformat options + + + + + It's define the Pictureformatvalue + + + + + This element represents 2-D transforms for ordinary shapes. + + + + + This element specifies the location of the bounding box of an object. + + + + + This element specifies the size of the bounding box enclosing the referenced object. + + + + + This element specifies the location of the bounding box of a child object. + + + + + This element specifies the size of the bounding box enclosing the referenced child object. + + + + + Specifies a coordinate on the x-axis. + + + + + Specifies a coordinate on the x-axis. + + + + + Specifies the length of the extents rectangle in EMUs. + + + + + Specifies the width of the extents rectangle in EMUs. + + + + + Specifies the preset geometry that will be used for this shape. + + + + + Specifies the custom geometry that will be used for this shape. + + + + + Specifies the EffectTag. + + + + + Specifies the ShapePropertiesExtensionList. + + + + + This elemet specifies that the chart has inverted shape elements and that is to be filled with a solid color. + + + + + This element specifies when a preset geometric shape should be used + instead of a custom geometric shape. + + + + + This element indicates that the sheet contains drawing components built + on the drawingML platform. + + + + + This element specifies all drawing objects within the worksheet. + + + + + This element specifies the adjust values that will be applied to the specified shape. + + + + + This element is used to set certain properties related to a drawing element + on the client spreadsheet application. + + + + + This element describes a single graphical object frame for + a spreadsheet which contains a graphical object. + + + + + This element specifies the existence of a single shape. A shape can either + be a preset or a custom geometry, defined using the SpreadsheetDrawingML + framework. In addition to a geometry each shape can have both visual and + non-visual properties attached. Text and corresponding styling information + can also be attached to a shape. This shape is specified along with all + other shapes within either the shape tree or group shape elements. + + + + + This element specifies the properties for a connection shape drawing element. + A connection shape is a line, etc. that connects two other shapes in this drawing. + + + + + This element specifies a group shape that represents many shapes grouped together. + This shape is to be treated just as if it were a regular shape but instead of being + described by a single geometry it is made up of all the shape geometries encompassed + within it. Within a group shape each of the shapes that make up the group are + specified just as they normally would. The idea behind grouping elements however + is that a single transform can apply to many shapes at the same time. + + + + + This element specifies the custom function associated with the object. + + + + + This element specifies the existence of a single graphic object. + + + + + This element specifies the reference to a graphic object within the document. + + + + + Specifies the URI, or uniform resource identifier that represents the data + stored under this tag. The URI is used to identify the correct 'server' that + can process the contents of this tag. + + + + + This element specifies all non-visual properties for a graphic frame. + + + + + This element defines the body properties for the text body within a shape. + + + + + This element specifies the list of styles associated with this body of text. + + + + + This element specifies the presence of a paragraph of text within the containing text body. + + + + + This element contains all paragraph level text properties for the containing paragraph. + These paragraph properties should override any and all conflicting properties that are + associated with the paragraph in question. + + + + + This element contains all default run level text properties for the text + runs within a containing paragraph. These properties are to be used when + overriding properties have not been defined within the rPr element. + + + + + This element specifies the presence of a run of text within the containing text body. + + + + + This element specifies the actual text for this text run. This is the + text that will be formatted using all specified body, paragraph and run + properties. This element must be present within a run of text. + + + + + This element contains all run level text properties for the text runs within a containing paragraph. + + + + + Specifies whether a run of text will be formatted as bold text. If this + attribute is omitted, than a value of 0, or false is assumed. + + + + + Specifies whether a run of text will be formatted as italic text. If this + attribute is omitted, than a value of 0, or false is assumed. + + + + + Specifies whether a run of text will be formatted as strikethrough text. + If this attribute is omitted, than no strikethrough is assumed. + + + + + Specifies the size of text within a text run. Whole points are specified + in increments of 100 starting with 100 being a point size of 1. For instance + a font point size of 12 would be 1200 and a font point size of 12.5 would be + 1250. If this attribute is omitted, than the value in defRPr should be used. + + + + + Specifies whether a run of text will be formatted as underlined text. + If this attribute is omitted, than no underline is assumed. + + + + + This element is used as an anchor placeholder for a shape or group of shapes. + It will anchor the object in the same position relative to sheet position + and its extents are in EMU unit. + + + + + This element describes the position of a drawing element within a spreadsheet. + + + + + Specifies that the generating application should not allow shape grouping + for the corresponding connection shape. + + + + + This element specifies all locking properties for a graphic frame. + + + + + This element specifies the non-visual drawing properties for a graphic frame. + + + + + This element specifies an outline style that can be applied to a number + of different objects such as shapes and text. + + + + + Specifies the width to be used for the underline stroke. If this + attribute is omitted, then a value of 0 is assumed. + + + + + Specifies the width cap of the dashStyle + + + + + Specifies the compound line type to be used for the underline stroke. + If this attribute is omitted, then a value of sng is assumed. + + + + + This element specifies that no fill will be applied to the parent element. + + + + + This element specifies that blip fill. + + + + + This element specifies a solid color fill. The shape is filled entirely with the specified color. + + + + + border miter join Tag + + + + + border bevel join tag + + + + + This element specifies a color using the red, green, blue RGB color model. + Red, green, and blue is expressed as sequence of hex digits, RRGGBB. + A perceptual gamma of 2.2 is used. + + + + + This element specifies a color bound to a user's theme. As with all elements + which define a color, it is possible to apply a list of color transforms to + the base color defined. + + + + + This color is based upon the value that this color currently has + within the system on which the document is being viewed. + + + + + Applications shall use the lastClr attribute to determine + the absolute value of the last color used if system colors + are not supported. + + + + + This element specifies that a preset line dashing scheme should be used. + + + + + This element specifies the background color of a Pattern fill. + + + + + This element specifies the foreground color of a pattern fill. + + + + + This element specifies a pattern fill. A repeated pattern is used to fill the object. + + + + + Specifies one of a set of preset patterns to fill the object. + + + + + This element specifies that lines joined together will have a round join. + + + + + This element defines a gradient fill. + + + + + This element specifies decorations which can be added to the head of a line. + + + + + This element specifies GroupFillTag. + + + + + This element specifies decorations which can be added to the tail of a line. + + + + + The list of gradient stops that specifies the gradient colors and their + relative positions in the color band. + + + + + This element specifies a linear gradient. + + + + + It's define the Tailtag property + + + + + Specifies the direction of color change for the gradient. To define this + angle, let its value be x measured clockwise. Then ( -sin x, cos x ) is + a vector parallel to the line of constant color in the gradient fill. + + + + + Whether the gradient angle scales with the fill region. + + + + + This element defines that a gradient fill will follow a path vs. a linear line. + + + + + Specifies the shape of the path to follow. + + + + + This element defines a gradient stop. A gradient stop consists of a position + where the stop appears in the color band. + + + + + Specifies where this gradient stop should appear in the color band. + + + + + This element specifies its input color with the specific opacity, + but with its color unchanged. + + + + + This element defines the "focus" rectangle for the center shade, specified + relative to the fill tile rectangle. The center shade fills the entire tile + except the margins specified by each attribute. + + + + + This element specifies a Color Change Effect. Instances of clrFrom are replaced with instances of clrTo + + + + + This element indicates whether the input color use the specific opacity + + + + + This element specifies a Color From. + + + + + This element specifies a Color To. + + + + + Specifies the left edge of the rectangle. + + + + + Specifies the top edge of the rectangle. + + + + + Specifies the right edge of the rectangle. + + + + + Specifies the bottom edge of the rectangle. + + + + + Specifies the left edge of the rectangle. + + + + + Specifies the top edge of the rectangle. + + + + + Specifies the right edge of the rectangle. + + + + + Specifies the bottom edge of the rectangle. + + + + + This element specifies a lighter version of its input color. A 10% tint is 10% + of the input color combined with 90% white. + + + + + This element specifies a darker version of its input color. A 10% shade is 10% + of the input color combined with 90% black. + + + + + This element specifies that the output color rendered by the generating + application should be the sRGB gamma shift of the input color. + + + + + This element specifies that the output color rendered by the generating + application should be the inverse sRGB gamma shift of the input color. + + + + + This element specifies the input color with its luminance modulated by the given percentage. + + + + + /// This element specifies the input color with its hue modulated by the given percentage. + + + + + This element specifies the input color with its luminance. + + + + + + This element specifies the input color with its saturation modulated by the given percentage. + + + + + This element specifies the input color with its saturation. + + + + + This element specifies the input color with its saturation offset. + + + + + This element specifies shade. + + + + + This element specified the rotation of text. + + + + + Specifies that all text in the parent object shall be aligned to the baseline of + each character when displayed. + + + + + This element specifies that a Latin font be used for a specific run of text. + + + + + Represents font type face. + + + + + Represents embedded controls in worksheet. + + + + + Represents a single embedded control. + + + + + This element specifies the non-visual drawing properties for a shape. These properties + are to be used by the generating application to determine how the shape should be dealt with. + + + + + Specifies that the corresponding shape is a text box and thus should be treated + as such by the generating application. If this attribute is omitted then it is + assumed that the corresponding shape is not specifically a text box. + + + + + This element specifies all non-visual properties for a shape. This element + is a container for the non-visual identification properties, shape properties + and application properties that are to be associated with a shape. This + allows for additional information that does not affect the appearance + of the shape to be stored. + + + + + This element specifies the existence of text to be contained within the + corresponding shape. All visible text and visible text related properties + are contained within this element. There can be multiple paragraphs and + within paragraphs multiple runs of text. + + + + + Default value for subscript baseline value. + + + + + Default value for superscript baseline value. + + + + + Specifies the anchoring position of the txBody within the shape. If this + attribute is omitted, then a value of t, or top is implied. + + + + + Specifies if the anchoring position of the txBody is centered within the shape. + + + + + Determines if the text within the given text body should be displayed vertically. + If this attribute is omitted, then a value of horz, or no vertical text is implied. + + + + + This attribute indicates whether to allow text editing within this drawing + object when the parent worksheet is protected. + + + + + Specifies the alignment that is to be applied to the paragraph. Possible + values for this include left, right, centered, justified and distributed. + If this attribute is omitted, then a value of left is implied. + + + + + specifies the capitialization for rich text + + + + + specifies the normaliztion of heights for text + + + + + Specifies the shape autofit element tag + + + + + Apply all caps on the text. + + + + + Apply small caps to the text. + + + + + Caps is not applied to the text + + + + + Determines whether the text can flow out of the bounding box vertically + + + + + Determines whether the text can flow out of the bounding box horizontally + + + + + Specifies the left inset of the bounding rectangle attribute + + + + + Specifies the bottom inset of the bounding rectangle attribute + + + + + Specifies the top inset of the bounding rectangle attribute + + + + + Specifies the right inset of the bounding rectangle attribute + + + + + Specifies the minimum font size at which character kerning occurs for this text run. + + + + + Specifies the spacing between characters within a text run. + + + + + Specifies the shape hyperlink element tag + + + + + Specifies the glow effect, in which a color blurred outline is added outside the edges of the object. + + + + + Specifies the soft edge effect. The edges of the shape are blurred, while the fill is not affected. + + + + + Specifies the radius of blur to apply to the edges. + + + + + Value of the Guid attribute that specifies SVG image. + + + + + Value of the URI attribute for UseLocalDpi. + + + + + Value of the URI attribute for Image properties. + + + + + Specifies the alpha bilevel tag. + + + + + Specifies the alpha ceiling tag. + + + + + Specifies the alpha floor tag. + + + + + Specifies the gray scale tag. + + + + + Specifies the fill overlay tag. + + + + + Specifies the alpha mod tag. + + + + + Specifies the alpha inv tag. + + + + + Specifies the alpha repl tag. + + + + + Specifies the bi level tag. + + + + + Specifies the thresh tag. + + + + + Specifies the blur value. + + + + + Speifies the Hsl. + + + + + Specifies the duo tone. + + + + + Specifies the image properties. + + + + + Specifies the local Dpi settings. + + + + + Specifies the svg blip. + + + + + Specifies fill reference + + + + + Specifies the constant value used for converting angle + + + + + Vertical flip attribute tag + + + + + Horizontal flip attribute tag + + + + + Field attribute tag + + + + + bullet font + + + + + bullet Char + + + + + preset text warp + + + + + chart style drawing namespace ('cs' abbreviation is used in MS Excel documents). + + + + + This class contains constants required for vml shapes parsing and serialization. + + + + + Name of a namespace used by VML (marked by 'v' in MS Excel 2007 documents). + + + + + Name of a namespace used by VML (marked by 'o' in MS Excel 2007 documents). + + + + + Name of a namespace used by VML (marked by 'x' in MS Excel 2007 documents). + + + + + Namespace prefix used in vml shapes. + + + + + Namespace prefix used in vml shapes. + + + + + Namespace prefix used in vml shapes. + + + + + Root tag for vml shapes. + + + + + Name of the xml tag that represents shape type definition in VML. + + + + + String format used to create shape type id. {0} must be replaced with instance + field of the shape object. + + + + + String format used to create shape id. {0} must be replaced with correct shape id number. + + + + + Name of the xml attribute that stores shape type id. + + + + + spid + + + + + Name of the xml attribute that stores shape (or shape type) coordinate size. + + + + + Default value of the coord size for comment shape. + + + + + Name of the xml attribute that stores spt option (it looks like it equals to instance field of the shape). + + + + + Name of the xml attribute that stores shape path value. + + + + + Default value of the path value for comment shape. + + + + + Default value of the path value for bitmap shape. + + + + + Name of the xml tag that stores vml shape client data. + + + + + Name of the xml attribute that stores vml shape type. + + + + + Name of the xml tag that indicates whether shape should be moved with cells or not. + + + + + Name of the xml tag that indicates whether shape should be sized with cells or not. + + + + + Name of the xml tag that stores anchor settings. + + + + + Name of the xml tag that stores all shape settings. + + + + + Name of the xml tag that stores all shape layout settings. + + + + + Name of the xml tag that stores shape type attribute. + + + + + Name of the xml tag that stores information about vml drawings inside worksheet part. + + + + + Name of the xml tag that stores information about vml header/footer drawings inside + worksheet part. + + + + + Name of the xml tag that stores row index of the note shape. + + + + + Name of the xml tag that stores column index of the note shape. + + + + + Style attribute for vml shapes. + + + + + Name of the xml attribute that stores vml shape fill color value. + + + + + Name of the xml tag that stores vml shape shadows settings. + + + + + Name of the xml attribute that specifies whether to show a shadow. + + + + + Name of the xml attribute that specifies whether a shadow is transparent. + Default is false. If true, the shadow is transparent if there is no fill on the shape. + + + + + Name of the xml attribute that specifies the color of the primary shadow. + Default is gray (RGB 128,128,128). + + + + + Specifies text alignment. + + + + + Name of xml attribute that specifies whether the application calculates the + internal text margin instead of using the inset attribute. Default is custom. + This attribute is only meaningful for text boxes. + + + + + Name of the xml tag that stores some of text box settings. + + + + + Name of the xml tag that stores div settings. + + + + + Part of the style attribute value that defines whether shape is visible or hidden. + + + + + This defines whether comment shape is shown or hidden. + + + + + One of possible visibility values. Indicates that shape is hidden. + + + + + One of possible visibility values. Indicates that shape is Visible. + + + + + + Name of the xml tag that specifies the horizontal text alignment for the object. + + + + + Name of the xml tag that specifies the vertical text alignment for the object. + + + + + This element is used to draw an image that has been loaded from an external source. + + + + + Specifies the relationship ID of the relationship to the image. + + + + + Determines the flow of the text layout in a textbox. + + + + + CheckStateChanged of layout-flow attribute which indicates that text is displayed vertically. + + + + + Specifies the alternate layout flow for text in textboxes. + + + + + Specifies the top to bottom layout flow for text in textboxes. + + + + + /// Specifies the bottom to top layout flow for text in textboxes. + + + + + Specifies whether the shape will stretch to fit the text in the textbox + + + + + Represents true expression + + + + + Represents false expression + + + + + This element defines a set of formulas whose calculated values are referenced by other attributes. + + + + + This element defines a single value as the result of the evaluation of an expression. + + + + + Specifies a single formula, which consists of a named operation followed + by up to three parameters. + + + + + This element defines the path that makes up the shape. + + + + + Specifies whether an extrusion is allowed to be displayed. + + + + + Specifies whether a gradient path will be made up of repeated concentric paths. + + + + + Specifies the type of connection points used for attaching shapes to other shapes. + + + + + Specifies whether the original size of an object is saved after reformatting. + + + + + Specifies whether the closed path will be filled. + + + + + Specifies whether the path defining the shape is stroked with a solid line. + + + + + This element describes how to draw the path if something beyond solid line + with a solid color is desired. + + + + + Specifies the join style for line ends. + + + + + This element specifies locks against actions that can be effected in the UI + of an authoring application or programmatically through an object model. + + + + + Specifies an optional value that indicates how applications that implement + VML should interpret extensions not defined as part of the original + specification of core VML. + + + + + Specifies whether the aspect ratio of a shape is locked from being edited. + + + + + Tag that stores checkbox checked state. + + + + + Specifies font and text inside div element. + + + + + Font face. + + + + + Font size. + + + + + Font color. + + + + + Fill style color. + + + + + Specifies space inside the font element. + + + + + Represents check box shape type. + + + + + + Represents combo box shape type. + + + + + This element specifies that the object is an AutoLine object. If this + element is specified without a value, it is assumed to be true. + + + + + This element specifies that the object is an AutoFill object. If this + element is specified without a value, it is assumed to be true. + + + + + This element specifies the cell the object is linked to, using standard cell reference syntax. + + + + + This element specifies whether the object is first button of the Grouped objects, + + + + + This element specifies the scroll bar position as the index of the list + item just above the item at the top of the view, given the current scroll + position. The list indexes are 1-based. + If omitted, the value is assumed to be 0. + + + + + This element specifies the minimum scroll bar position as the index of + the list item just above the item at the top of the view when the control + is scrolled all the way up, typically 0. The list indexes are 1-based. + If omitted, the value is assumed to be 0. + + + + + Specifies the position of the center rectangle of a radial gradient. The vector is a fraction + of the width and height of the shape. The first is a percentage of the fill to the left edge; + the second is a percentage of the fill to the top. Default is 0,0. To position a radial fill at + the center of a shape, use a value of 50%,50%. + + + + + Specifies the size of the center rectangle of a radial gradient. The vector is a fraction of + the width and height of the shape. The first is a percentage of the fill to the right edge; + the second is a percentage of the fill to the bottom. Default is 0,0. + + + + + lightness or darkness of "one color" option in Gradient + + + + + Colors attributes specifies the combination of colors + applied to the shape. this attribute usde for preset colors + + + + + Maximum Scroll + + + + + This element specifies the number of lines to move the scroll bar on an increment click. + If omitted, the increment is 0. + + + + + This element specifies the number of lines to move the scroll bar on a page click. + + + + + This element specifies the width of the scroll bar in screen pixels. + + + + + This element specifies that 3D effects are disabled. If this element + is specified without a value, it is assumed to be true. + + + + + This element specifies that 3D effects are disabled. If this element + is specified without a value, it is assumed to be true. + + + + + This element specifies the range of source data cells used to populate + the list box, using standard cell reference syntax. + + + + + This element specifies that the object represents a password edit field. + If this element is specified without a value, it is assumed to be true. + + + + + This element specifies the selection type for the list box. If omitted, the control is assumed to be Single. + + + + + This element specifies the list box callback type. The application should + use the callback to determine how to handle user actions on the list box. + The only allowed value is Normal. + + + + + Normal value of the callback type. + + + + + This element specifies the style of the dropdown. + + + + + This element specifies the maximum number of lines in the dropdown before + scrollbars are added. + + + + + Left Margin + + + + + Top Margin + + + + + Width + + + + + Height + + + + + Millimeters + + + + + Auto Picture + + + + + CF - Conditional Format + + + + + Ole Objects + + + + + Ole Object + + + + + Program ID + + + + + DevAspect + + + + + Shape ID + + + + + Formula Macro + + + + + this part contains tags used in VML + + + + + Gradient Fill Method + + + + + Gradient fill method value none. + + + + + This element specifies how the shape should be filled + + + + + for two color fill + + + + + link attribute + + + + + solid fill tag + + + + + Texture Attribute value + + + + + Picture Attribute Value + + + + + Pattern Attribute Value + + + + + Fill type Tag value represents gradient fill type + + + + + Fill type Tag value represents gradient radial (From corner or Center) fill type + + + + + Fill type Tag value represents gradient radial (From corner or Center) fill type + + + + + fill One Color Darkeness + + + + + fillOne Color Lightness + + + + + Fill type Tag value represents gradient unscaled + + + + + "Transparency From" of the filled color + + + + + "Transparency To" of the filed color + + + + + Filled color Shading (Horizontal , vertical...) + + + + + filled color rotates with the shape + + + + + shape's border Line wieght + + + + + focus attribute specifies to shading variants + Values range from 100% to -100%. Default is 0. + + + + + Relation id for the resource + + + + + Title of the texture or picture or pattern + + + + + FillType specifies the pattern fill of + Line in VMLtexbox shapes + + + + + Represent Dash Style (solid, shortDash) + + + + + Represent line style (ThinThick,..) + + + + + Represent the end cap tag. + + + + + Represents solid fill type of the shape + + + + + Alternate text for the Shape + + + + + represents the place holder image + + + + + Link Attribute value + + + + + Specifies that the fill uses an image + + + + + represents the path + + + + + represents the extrusion + + + + + represent strokeok + + + + + represent fillok + + + + + represent conect type + + + + + represent lock + + + + + represent extension + + + + + represent Shape type + + + + + represent shadoe ok + + + + + represent ole Update + + + + + Colors are prefixed with this char + + + + + indexed color enclosed with this char + + + + + Size value prefixed with this char + + + + + Size value store with this string + + + + + opacity value divided by this + + + + + Degree value divided by this + + + + + degree's dark limit + + + + + Name of the xml tag that specifies whether form control is printed or not. + + + + + This enum specifies possible selection types. + + + + + The listbox may only have one selected item. + + + + + The listbox may have multiple items selected by clicking on each item. + + + + + The listbox may have multiple items selected by holding a control key and clicking on each item. + + + + + Possible drop styles. + + + + + Standard combo box. + + + + + Editable combo box. + + + + + Standard combo box with only the dropdown button visible when the box is not expanded. + + + + + This class is used for TextBox serialization. + + + + + This method serializes specified shape into specified writer. + + XmlWriter to serialize shape settings into. + Shape to serialize. + Parent worksheet data holder. + + + + This method serializes specified slicer into specified writer. + + XmlWriter to serialize shape settings into. + Shape to serialize. + Parent worksheet data holder. + + + + Serializes shape properties. + + XmlWriter to serialize into. + TextBox to serialize properties for. + File data holder. + Drawing relations. + Xml namespace to use. + + + + Serialize effect properties. + + XmlWriter + Textbox to serialize shadow properties. + + + + Serialize 3D shape properties. + + XmlWriter + Textbox to serialize 3D shape properties. + + + + Serializes non visual textbox properties. + + XmlWriter to serialize into. + TextBox to serialize. + Worksheet's data holder. + Xml namespace to use. + + + + Serializes Extent for shape. + + Writer to save extent data into. + shape to get its size for serializing extent + + + + Serializes rich text. + + XmlWriter to serialize into. + Xml namespace to use. + Textbox to serialize rich text for. + + + + Serialize text area body properties. + + XmlWriter to serialize into. + Text area to serialize body properties for. + Text box to be serialized. + + + + Serializes anchor (vertical alignment). + + XmlWriter to serialize anchor into. + TextBox to serialize anchor for. + + + + Serializes text rotation. + + XmlWriter to serialize into. + TextBox to serialize. + + + + Serializes list styles for a text area. + + XmlWriter to serialize into. + Text area to serialize list styles for. + + + + Serializes paragraph. + + XmlWriter to serialize paragraph tag into. + Text area that contains paragraph information (formatting and text). + Text box to serialize paragraph for. + + + + Serializes bullet + + + + + + + update vertical anchor position. + + Text direction + Text vertical alignment + Text horizontal alignment + updated vertical alignment + + + + Update horizontal anchor position. + + Text direction + Text vertical alignment + Text horizontal alignmen + updated horizontal alignment + + + + Serialize paragraph properties. + + Xml writer + Text fram object + + + + Serializes the formatting property. + + Represents the Xml writer. + The font. + The book. + The text box. + + + + Serializes the formatting property. + + Represents the Xml writer. + The font. + The book. + The text box. + + + + Serializes single formatting run. + + XmlWriter to serialize into. + Font of the formatting run. + Represents tag name. + Parent workbook. + Text of the formatting run. + + + + Serializes paragraph run. + + XmlWriter to serialize paragraph tag into. + Text area that contains paragraph run information (formatting and text). + Name of the main xml tag. + Parent workbook. + + + + Serializes paragraph run. + + XmlWriter to serialize paragraph tag into. + Text area that contains paragraph run information (formatting and text). + Name of the main xml tag. + Parent workbook. + + + + Serializes paragraph. + + XmlWriter to serialize paragraph tag into. + Text area that contains paragraph information (formatting and text). + Text box to serialize paragraph for. + + + + This is serializator for unknown/unsupported vml shapes that were parsed. + + + + + Stream that contains xml data that describes shape type. + + + + + Initializes a new instance of the UnknownShapeSerializator class. + + Stream that contains shape type data. + + + + This method serializes specified shape into specified writer. + + XmlWriter to serialize shape settings into. + Shape to serialize. + Parent worksheet data holder. + + + + This method serializes general shape settings (shape type) into specified XmlWriter. + + XmlWriter to write shape type into. + Type of the shape that is going to be serialized. + + + + Xml serializator. Serializes XlsIO workbook into MsExcel xml file format. + + + + + Represents xml version. + + + + + Represents application string; + + + + + Represents o namespace. + + + + + Represents x namespace. + + + + + Represents ss namespace. + + + + + Represents html namespace. + + + + + Represents ss pref. + + + + + Represents html pref. + + + + + Represents o pref. + + + + + Represents x pref. + + + + + Represents default pref. + + + + + Represents xmlns pref. + + + + + Represents WorkBook pref. + + + + + Represents WorkSheet pref. + + + + + Represents Name pref. + + + + + Represents Table pref. + + + + + Represents Row pref. + + + + + Represents Cell pref. + + + + + Represents Data pref. + + + + + Represents Names pref. + + + + + Represents NamedRange pref. + + + + + Represents Styles pref. + + + + + Represents Style pref. + + + + + Represents Font pref. + + + + + Represents Protection pref. + + + + + Represents Alignment pref. + + + + + Represents NumberFormat pref. + + + + + Represents Interior pref. + + + + + Represents Borders pref. + + + + + Represents Border pref. + + + + + Represents AutoFilter pref. + + + + + Represents AutoFilterColumn pref. + + + + + Represents AutoFilterAnd pref. + + + + + Represents AutoFilterCondition pref. + + + + + Represents AutoFilterOr pref. + + + + + Represents Comment pref. + + + + + Represents B tag. + + + + + Represents B end tag. + + + + + Represents I tag. + + + + + Represents I end tag. + + + + + Represents U tag. + + + + + Represents U end tag. + + + + + Represents S tag. + + + + + Represents S end tag. + + + + + Represents Sub tag. + + + + + Represents Sub end tag. + + + + + Represents Sup tag. + + + + + Represents Sup end tag. + + + + + Represents Font end tag. + + + + + Represents Font tag. + + + + + Represents Span pref. + + + + + Represents Column pref. + + + + + Represents ConditionalFormatting pref. + + + + + Represents Condition pref. + + + + + Represents Qualifier pref. + + + + + Represents Value1 pref. + + + + + Represents Value2 pref. + + + + + Represents worksheet options pref. + + + + + Represents page setup pref. + + + + + Represents footer pref. + + + + + Represents header pref. + + + + + Represents layout pref. + + + + + Represents page margins pref. + + + + + Represents print pref. + + + + + Represents print comments layout pref. + + + + + Represents print errors pref. + + + + + Represents fit to page pref. + + + + + Represents LeftToRight pref. + + + + + Represents active pane pref. + + + + + Represents first visible row pref. + + + + + Represents split horizontal pane pref. + + + + + Represents split vertical pane pref. + + + + + Represents top row bottom pane pref. + + + + + Represents left col right pane pref. + + + + + Represents freeze panes pref. + + + + + Represents freeze no split panes pref. + + + + + Represents panes pref. + + + + + Represents pane pref. + + + + + Represents number pane pref. + + + + + Represents active column pane pref. + + + + + Represents active row pane pref. + + + + + Represents Selected cell information pref. + + + + + Represents tab color index pref. + + + + + Represents zoom pref. + + + + + Represents Do Not Display Gridlines pref. + + + + + Represents Visible pref. + + + + + Represents don't display headings pref. + + + + + Represents ExcelWorkbook pref. + + + + + Represents Active sheet pref. + + + + + Represents Selected pref. + + + + + Represents selected sheets pref. + + + + + Represents first visible sheet pref. + + + + + Represents DataValidation pref. + + + + + Represents selected sheets pref. + + + + + Represents RightToLeft pref. + + + + + Represents Index pref. + + + + + Represents Type pref. + + + + + Represents Ticked pref. + + + + + Represents Formula pref. + + + + + Represents RefersTo pref. + + + + + Represents ID pref. + + + + + Represents Parent pref. + + + + + Represents Bold pref. + + + + + Represents FontName pref. + + + + + Represents Color pref. + + + + + Represents Italic pref. + + + + + Represents Outline pref. + + + + + Represents Shadow pref. + + + + + Represents Size pref. + + + + + Represents StrikeThrough pref. + + + + + Represents Underline pref. + + + + + Represents Protected pref. + + + + + Represents HideFormula pref. + + + + + Represents Horizontal pref. + + + + + Represents Indent pref. + + + + + Represents ReadingOrder pref. + + + + + Represents Rotate pref. + + + + + Represents ShrinkToFit pref. + + + + + Represents Vertical pref. + + + + + Represents VerticalText pref. + + + + + Represents WrapText pref. + + + + + Represents Format pref. + + + + + Represents PatternColor pref. + + + + + Represents Pattern pref. + + + + + Represents Position pref. + + + + + Represents Range pref. + + + + + Represents Operator pref. + + + + + Represents Value pref. + + + + + Represents Author pref. + + + + + Represents ShowAlways pref. + + + + + Represents DefaultColumnWidth pref. + + + + + Represents DefaultRowHeight pref. + + + + + Represents Width pref. + + + + + Represents Hidden pref. + + + + + Represents StyleID pref. + + + + + Represents AutoFitWidth pref. + + + + + Represents AutoFitHeight pref. + + + + + Represents Height pref. + + + + + Represents Face pref. + + + + + Represents line style pref. + + + + + Represents weight pref. + + + + + Represents vertical align pref. + + + + + Represents merge column count pref. + + + + + Represents merge row count pref. + + + + + Represents hyper link tip pref. + + + + + Represents hyper link reference pref. + + + + + Represents margin pref. + + + + + Represents margin top pref. + + + + + Represents margin right pref. + + + + + Represents margin left pref. + + + + + Represents margin bottom pref. + + + + + Represents center horizontal pref. + + + + + Represents center vertical pref. + + + + + Represents orientation pref. + + + + + Represents start page number pref. + + + + + Represents number of copies to print. + + + + + Represents default numbers of copies to print. + + + + + Represents horizontal resolution pref. + + + + + Represents paper size index pref. + + + + + Represents Scale pref. + + + + + Represents fit width pref. + + + + + Represents fit height pref. + + + + + Represents gridlines pref. + + + + + Represents BlackAndWhite pref. + + + + + Represents DraftQuality pref. + + + + + Represents row and column headings pref. + + + + + Represents colon. + + + + + Represents semicolon. + + + + + Represents font color. + + + + + Represents font style. + + + + + Represents font weight style. + + + + + Represents bold font weight. + + + + + Represents regular font weight. + + + + + Represents italic font const. + + + + + Represents line through + + + + + Represents line through + + + + + Represents Single line through + + + + + Represents font underline. + + + + + Represents pattern back color. + + + + + Represents fill pattern. + + + + + Represents border constant. + + + + + Represents border top constant. + + + + + Represents border bottom constant. + + + + + Represents border left constant. + + + + + Represents border right constant. + + + + + Represents Arial font name. + + + + + Represents none style. + + + + + Represents default font size. + + + + + Represents left diagonal border index. + + + + + Represents right diagonal border index. + + + + + Represents zero constant. + + + + + Represents rotation constant. + + + + + Represents default style font size. + + + + + Represents default rotation text. + + + + + Represents default border increment. + + + + + Represents default style name. + + + + + Represents unique prephix. + + + + + Represents style align none. + + + + + Represents style align Subscript. + + + + + Represents style align Superscript. + + + + + Represents default margin. + + + + + Represents default page scale. + + + + + Represents default page fit. + + + + + Represents default zoom. + + + + + Represents xml true string. + + + + + Represents xml false string. + + + + + Represents All autofilter type. + + + + + Represents color string prefix. + + + + + Represents Bottom autofilter type. + + + + + Represents Top autofilter type. + + + + + Represents Percent autofilter type. + + + + + Represents blanks autofilter type. + + + + + Represents Custom autofilter type. + + + + + Represents non blanks autofilter type. + + + + + Represents default column width. + + + + + Represents default row Height. + + + + + Represents default column div. + + + + + Represents default row div. + + + + + Represents data time mask. + + + + + Represents default merged style first index. + + + + + Represents 13/10 chart. + + + + + Represents bad reference. + + + + + Represents bad reference in xml. + + + + + Represents bad formula reference. + + + + + Represents default maximum column index. + + + + + Represents default minimum column index. + + + + + Represents default cod for generate unique style index. + + + + + Represents pattern string. + + + + + Represents border line style. + + + + + Represent the XML Spreadsheet Comparision operators + + + + + Represents border position string. + + + + + Represents border line type string. + + + + + Represents border line types. + + + + + Represents print location string. + + + + + Represents print error string. + + + + + Represents visibility string. + + + + + Represents pattern string. + + + + + Represents Autofilter operation string. + + + + + Represents the ErrorStyle Options + + + + + Represents the ErrorStyle Options + + + + + Represents hash table, that contain merged styles. + + + + + Builder used to accumulate start of the xml string. + + + + + Builder used to accumulate end of the xml string. + + + + + Gets unique id for coding sheet index and cell index. + + Represents sheet index. + Represents cell index. + Returns unique id. + + + + Gets sheet index by unique id. + + Represents unique id. + Returns sheet index. + + + + Gets cell index by unique id. + + Represents unique id. + Returns cell index. + + + + Initializes a new instance of the WorkbookXmlSerializator class. + + + + + Serialize named range collection. + + Xml write stream. + Names collection. + If true - serializes only local names. + + + + Serialize named range. + + Xml write stream. + Named range. + + + + Serialize styles. + + Xml writer. + Extended format collection. + List that contain XFFormats to reparse. + + + + Serialize style element. + + Xml stream writer. + Extended format to serialize. + + + + Serialize style elements. + + Xml writer. + Extended format to serialize. + + + + Serialize fonts. + + Xml stream writer. + Font to serialize. + + + + Serialize protection object. + + Xml stream writer. + Extended format. + + + + Serialize alignment object. + + Xml stream writer. + Extended format. + + + + Serialize number format. + + Xml writer. + Represents number format. + + + + Serialize interior object. + + Xml stream writer. + Extendet format. + + + + Serialize Borders collection. + + Xml stream writer. + Borders collection. + + + + Serialize Border object. + + Xml stream writer. + Border object. + Represents border index. + + + + Serialize autofilters. + + Xml writer. + Auto filter collection. + + + + Serialize autofilter. + + Xml writer. + Auto filter object. + + + + Serialize autofilter condition. + + Xml writer. + Condition object. + + + + Serialize single cell. + + Xml writer. + Current sheet. + Row index of current cell. + + + + Serialize merge region if necessary. + + + + + + + + + + Serializes hyperlink part of the cell. + + + + + + + + Serializes cell style block if necessary. + + + + + + + + + + Enables formatting. + + XmlWriter to enable formatting. + + + + + Serialize Data object. + + Xml writer. + Cells collection. + Index of cell. + + + + Gets type of the formula value. + + + + + + + + Serializes Data tag for the single cell. + + XmlWriter to serialize into. + Type of the cell's data. + Cell's value. + Style of the cell. + Rtf string containing cell's value if cell is rtf. + Cells collection. + Current cell index. + + + + Serialize worksheets collection. + + Xml writer. + Worksheets collection. + + + + Serialize custom worksheet. + + Xml writer. + Worksheet object. + + + + Serialize custom worksheet. + + Xml writer. + Worksheet to serialize. + + + + Serialize column object. + + Xml writer. + Current sheet. + + + + Serialize rows collection. + + Xml writer. + Parent worksheet object. + + + + Serialize row and column common attributes. + + Xml writer. + Row or ColumnInfo record. + Last column or row index. + Parent workbook. + + + + Serializes merged range. + + Xml writer. + Represents merged cells. + + + + Serialize comment object. + + Xml writer. + comment to serialize. + Inner fonts collection. + Represents default font. + + + + Serialize rich text to xml. + + Xml writer. + Represents collection of formats. + Text to serialize. + Inner fonts. + Represents default font. + + + + Serialize rtf font. + + Writer to write value into. + Font for current string value. + String value. + + + + Serialize data validation objects. + + Xml writer. + DV table. + + + + Serialize data validation object. + + Xml writer. + Data validation object. + + + + Serialize Ranges for the DataValidation + + XML Writer + DataValidationImpl + + + + Serialize Formulas for the DataValiatin + + XML Writer + DataValidationImpl + + + + Serialize condition formats collection. + + Xml writer. + Condition collection. + + + + Serialize condition format. + + Xml writer. + Format to serialize. + + + + Serialize condition instance. + + Xml writer. + condition to serialize. + + + + Serialize worksheet option. + + Xml writer. + Current worksheet. + + + + Serialize page setup. + + Xml writer. + Current page setup to serialize. + + + + Serialize header. + + Xml writer. + Storage, that contain header properties. + If true - footer to serialize; otherwise - header. + + + + Serialize layout + + Xml writer. + Storage, that contain all layout properties. + + + + Serialize page margins. + + Xml writer. + Storage, that contain all page margins properties. + + + + Serializes pains. + + Xml writer. + Current worksheet + + + + Serialize panes block. + + Xml writer. + Array list, that contain all selection to serialize. + + + + Serializes print. + + Xml writer. + Storage, that contain all print properties. + + + + Serializes window two record properties. + + Xml writer. + Current sheet. + + + + Serialize excelworkbook xml properties. + + Xml writer. + Current workbook. + + + + Serializes document properties. + + Xml writer. + Current workbook. + + + + Serialize workbook. + + Xml writer. + Book to serialize. + + + + Serializes workbook to xml. + + Xml writer. + Workbook to serialize. + + + + Initializes builder used to accumulate start of some xml string. + + Builder used to accumulate start of some xml string. + + + + Initializes builder used to accumulate end of some xml string. + + Builder used to accumulate start of some xml string. + + + + Initializes builder used to accumulate some xml string. + + Builder to initialize. + Initialized String builder + + + + Gets color string by Color. + + Current color. + Returns string by color. + + + + Adds open and close tag. + + Open tag. + Closed tag. + String builder to accumulate start of the xml string. + String builder to accumulate end of the xml string. + + + + Adds attribute to string. + + Attribute name. + Attribute value. + String builder to accumulate start of the xml string. + String builder to accumulate end of the xml string. + + + + Generates xml string by conditional format. + + Conditional format object. + Returns generated string. + + + + Gets border format string for CF serialize. + + Represents border type. + Represents border color. + Represents border line style. + Returns border line style. + + + + Gets xml string from ExcelHAling type. + + ExcelHAling type. + Returns xml string. + + + + Gets xml string from ExcelVAling type. + + ExcelVAling type. + Returns xml string. + + + + Gets font alignment xml string; + + Font object. + Returns xml font alignment string. + + + + Gets condition string value. + + Condition object. + Returns condition value. + + + + Gets cell type and value. + + Cells collection + Index of cell. + Returns xml type of cell by index. + Returns xml cell value. + + + + Writes element to xml stream. + + Xml writer. + Element prefix. + Element name. + + + + Writes element to xml stream. + + Xml writer. + Element prefix. + Element name. + Element value + + + + Reserialize merged styles styles. + + Xml writer. + List with styles to reserialize. + + + + Gets array of merged styles. + + Worksheets collection + Returns list with merged styles. + + + + Updates formulas, that contain error. + + Formula to update. + Returns updated formula. + + + + Converts Excel 2007 data validation type to Excel 97-03. + + Excel 2007 data validation type. + Excel 97-03 data validation type. + + + + Returns DV error style. + + DV error style name. + DV error style. + + + + Represents cell types. + + + + + Represents number. + + + + + Represents dateTime. + + + + + Represents boolean. + + + + + Represents string. + + + + + Represents error. + + + + + This class stores worksheet data extracted from document and is responsible + for parsing and serialization of this data into special FileDataHolder. + + + + + Format to get full path to zip archive item that stores vml drawings for worksheet. + + + + + Format got get full path to zip archive item that stores comments description for worksheet. + + + + + Format to get full path to zip archive item that stores threaded comments for worksheet + + + + + Format to get full path to zip archive item that stores drawings for worksheet. + + + + + Relations default extension. + + + + + List which contains chart relation to be removed. + + + + + Archive item that stores worksheet data. + + + + + Objects that stores workbook data. + + + + + This stream stores xml text starting just after "worksheet" tag to + "col" or "sheetData" tag. + + + + + This stream stores xml text with conditional formatting. + + + + + This stream stores xml text with conditional formattings in extended list. + + + + + Relation id in the parent workbook. Null means that item hasn't been serialized + yet and we must generate new id. + + + + + Sheet id. + + + + + Worksheet relations. + + + + + Drawings relations. + + + + + Header/footer drawings relations. + + + + + Relation id for vml drawings. Null means no vml drawings present (or were present). + + + + + Relation id for vml header/footer drawings. Null means no vml drawings present (or were present). + + + + + Relation id for comment notes. Null means no comment note present (or were present). + + + + + Relation id for threaded comments. Null means no threaded comments are present (or were present). + + + + + Relation id for drawings. Null means no drawings present (or were present). + + + + + Relation id for slicer + + + + + Stream with controls data. + + + + + Stream with pivot slicer data. + + + + + Default Chart Style elements used in chartEx on serialization + + + + + Default color variation required on styles + + + + + Initializes a new instance of the WorksheetDataHolder class. + + Objects that stores workbook data. + Relation that points at (relative path) necessary worksheet. + Path to the relation parent object (to convert relative + path into absolute). + + + + Initializes new instance of the WorksheetDataHolder class. + + Objects that stores workbook data. + Archive item with sheet data. + + + + Parses conditional formats. + + Dxf styles collection. + Worksheet to parse CF into. + + + + Parses worksheet data. + + Worksheet to parse. + + + + Collect Pivot Relations + + + + + + Parse PivotTable in the worksheet + + + + + + Parses chart worksheet data. + + Represents chart object to be parsed. + + + + Parses Dialog worksheet data. + + Represents chart object to be parsed. + + + + Serializes worksheet into internal zip archive item. + + Worksheet to serialize. + Dictionary with updated xf indexes. + Dictionary that will contain pivot cache files + (key - cache object, value - cache file name). + + + + Serializes the OLE stream file. + + The sheet. + + + + Serializes the OLE. + + The sheet. + The OLE object. + + + + Gets the OleObject data stream for bin file. + + The OleObject. + + + + + Serializes worksheet into internal zip archive item. + + Worksheet to serialize. + + + + Serializes worksheet into internal zip archive item. + + Worksheet to serialize. + + + + Serializes Macrosheet and IntlMacrosheet to internal zip archive item + + Macrosheet and IntlMacrosheet to serialize + + + + + This method tries to parse vml shapes. + + Parent worksheet. + Relation id of the vml shapes relation. + Collection of the corresponding vml relations. + + + + Parses the OLE data. + + The sheet. + The relation id. + The OLE object. + + + + Gets the type of the OLE object. + + Type of the OLE. + + + + + This method tries to parse drawings part. + + Parent worksheet. + Relation id of the shapes relation. + Dictionary with archive items to remove after parsing. + + + + This method tries to parse drawings part. + + Parent worksheet. + Relation pointing at drawings xml item.. + Dictionary with archive items to remove after parsing. + + + + This method tries to parse drawings part. + + Parent worksheet. + Relation pointing at drawings xml item.. + Dictionary with archive items to remove after parsing. + + + + Serializes worksheet part into internal zip archive item. + + Worksheet to serialize. + Dictionary with updated xf indexes. + + + + Serializes chartsheet part into internal zip archive item. + + Chartsheet to serialize. + + + + Serializes chart object. + + Chart to serialize. + Drawing relations that should contain reference to this chart. + Chart drawing id in the relations collection. + relation id of the dummy chart for chartEx + + + + Create a dummy chart for serialization of fallback content and remove it + + workbook to be serialized + workbook file data holder + chart file name + chart relation id + + + + Serializes drawing part of the chartsheet. + + Chart to serialize. + Name of the drawing zip archive item. + Drawing relations. + relation id of the dummy chart for chartEx + Relation id to the chart object. + + + + Serializes pivot tables. + + Worksheet to serialize pivot tables for. + Contains pivot cache file names. + + + + Serializes single pivot table. + + Table to serialize. + Contains pivot cache file names. + + + + Serializes worksheet relations. + + + + + Serializes all worksheet drawings (including vml). + + Current worksheet. + + + + Serializes worksheet drawings, except vml drawings. + + Worksheet to serialize drawings for. + + + + Serializes worksheet drawings, except vml drawings. + + Worksheet to serialize drawings for. + Relations to put drawings relation into. + Drawing id. + Content type. + Relation type. + + + + Serializes chartEx drwing for fallback content. + + Worksheet to serialize drawings for. + Relations to put drawings relation into. + Drawing id. + name of the chart + Content type. + Relation type. + + + + Serialize the Fallback content required for ChartEx + + input XML writer + boolean value indicates whether the chart is sheet or not + + + + Serializes worksheet vml drawings. + + Worksheet to serialize drawings for. + + + + This method serializes header/footer images. + + Worksheet to serialize header/footer images for. + + + + Serializes relations. + + Represents parent item name. + + + + Serializes relations. + + Relation to be serialized. + Parent item name. + + + + Serializes relations. + + Relation to be serialized. + Parent item name. + holder for the input object + object chart + + + + Serializes style and color relations with its file. + + Relation to be serialized. + Parent item name. + holder for the input object + object chart + + + + Generate the file name which is not in the ziparchive item + + input item + + + + + + Serialize the default style element loaded for chartEx + + input XML writer + input application object + + + + Serialize the default style element loaded for chartEx + + input XML writer + input chart object + input application object + + + + Serializes worksheet comments. + + Worksheet to get comments from. + + + + Serialize worksheet threaded comments + + + + + Generates unique zip archive item name for drawings of the specified + worksheet or reuses existing one. + + Name that can be used for drawings item. + + + + Generates unique zip archive item name for vml drawings of the specified + worksheet or reuses existing one. + + Name that can be used for vml drawings item. + + + + Generates unique zip archive item name for comments of the specified + worksheet or reuses existing one. + + Name that can be used for comments item. + + + + Generates unique zip archive item name for threaded comments of the specified worksheet or reuses existing one. + + Name that can be used for threaded comments item + + + + Serializes all tables from the specified worksheet. + + XmlWriter to serialize worksheet's part of the tables serialization. + + + + Serializes single table item. + + Item to serialize. + Relation id of the serialized item. + + + + Serializes slicers. + + Represents the writer contains the slicer data. + Represents the slicer worksheet. + + + + Initailze the colloection, needed for chartEx + + + + + Initialize the chart style color elements + + + + + Create copy of the current object. + + A copy of the current object. + + + + Dispose + + + + + Gets parent FileDataHolder. Read-only. + + + + + Gets or sets archive item that has all worksheet data. + + + + + Gets or sets Worksheet's relation id in the workbook. + + + + + Gets or sets sheet id extracted from the file. + + + + + Gets relations collection. Read-only. + + + + + Gets drawings relation collection. Read-only. + + + + + Gets header/footer drawings relations collection. Read-only. + + + + + Gets or sets relation id for vml drawings. Null means no vml drawings present (or were present). + + + + + Gets or sets relation id for vml drawings. Null means no vml drawings present (or were present). + + + + + Gets or sets relation id for comment notes item. Null means no comments present (or were present). + + + + + Gets or sets relation id for threaded comments item. Null means no comments present (or were present). + + + + + Gets or sets relation id for drawings. Null means no drawings present (or were present). + + + + + Relation id for slicer + + + + + Gets or sets stream with controls data. + + + + + Stream with pivot slicer data. + + + + + Returns the chart style elements. Read only + + + + + Returns the color variations used by chart style elements. Read only + + + + + Returns the relations which need to get removed. Read only + + + + + + Class used for serializing Xml Attribute. + + + + + Xml serializator save type. + + + + + Prevents a default instance of the XmlSerializatorAttribute class from being created. + + + + + Initializes a new instance of the XmlSerializatorAttribute class. + + Save type. + + + + Gets xml serializator save type. Read-only. + + + + + + Summary description for XmlSerializatorFactory. + + + + + Dictionary with serializators. Key - int value of ExcelXmlSaveType, + value - instance of a serializator. + + + + + Initializes static members of the XmlSerializatorFactory class. Fills internal dictionary with serializators. + + + + + Prevents a default instance of the XmlSerializatorFactory class from being created. + + + + + Registers xml serializator. + + Xml file format generated by serializator. + Type that serializes into xml. + + + + Returns serializator corresponding to the specified save type. + + Save type to get serializator for. + Serializator corresponding to the specified save type. + + + + Class represent combination filter for a column + + + + + Collection of text and date filters. + + + + + Indicate whether the filter with blanks. + + + + + parent filter + + + + + Create an instance of combination filter. + + parent filter + + + + Returns collection of text filter values alone for currnet combination. + + Returns collection of unique text filter values alone. + + + + Collection of unique text filter values alone. Read-Only. + + + + + Returen true, if the blank values are filtered. Read-Only. + + + + + Specifies the type of filter. Read-Only. + + + + + Return combination filter value(either Text or DateTime Filter) at the specified Index. Read-Only. + + + + + Return total number combination filter values(both Text and DateTime Filter). Read-Only. + + + + + Class represents Color Filter for a column + + + + + Specifies the color filter type ( Cell Color or Font Color) + + + + + Holds the color that has to be filtered + + + + + Create an instance of Color filter. + + parent filter + + + + Creates a shallow copy of the current object that executes this function. + + A copy of the colorFilter object. + + + + Property to access the filter type (Returns color filter) + + + + + Property that returns the applied color filter type (Cell color or Font color) + + + + + Property that returns the color that is being filtered by the color filter + + + + + Class represents Icon Filter for a column + + + + + Specifies the type of IconSet to be filtered. + + + + + Holds the id of the icon in the given IconSet. + + + + + Returns a shallow copy of object obtained from MemberwiseClone method. + + + + + + Property to access the filter type (Icon Filter). + + + + + Property to access the IconSetType for which filter is applied. + + + + + Property to access the IconId filtered. + + + + + Class represent text filer in a combination filter. + + + + + Text filter value. + + + + + Text filter value. Read-Only. + + + + + Represent combination filter type. Read-Only. + + + + + + Class used as message sender on Property value change. Class provides old and + new values which allow user to create advanced logic. + + + + + Storage of Old value. + + + + + Storage of new value. + + + + + Name of property or unique identifier of the object + whose value changed. + + + + + Value changed event arguments. + + + + + Default constructor. + + + + + Main constructor. + + Old property value. + New property value. + Unique Identifier of object whose value changed. + + + + Main constructor. + + Old property value. + New property value. + Unique Identifier of object whose value changed. + Next property which must be changed. + + + + New property value. Event handler property has new value set. + Read-only. + + + + + Old property value. Event handler property has new value set. + Read-only. + + + + + Name of the property. Read-only. + + + + + If more than one property must be changed on one send message, + attach it to the ValueChangeEventArgs to create a one way directed list of property changes. + + + + + Returns the class instance with empty values. Read-only. + + + + + + Delegate which can be used for Property Changed events declarations. + + + + + Summary description for _constants. + + + + + + This value is used instead of possible minimum row or column index. + + + + + This value is used instead of possible maximum row or column index. + + + + + This value is used instead of maximum used row or column index. + + + + + This value is used instead of minimum used row or column index. + + + + + Size of the Int32 value. + + + + + Size of the Int16 value. + + + + + Size of the Int64 value. + + + + + Number of bits inside single short value. + + + + + Number of bits inside single byte value. + + + + + Size of the Double value in bytes. + + + + + Used to prevent user from creation of instances of this type. + + + + + This is a helper class which creates an object + hash value using Reflection. + + + + + Member used to detect level recursion. + + + + + To prevent creation of hash class, make its constructor private. + + + + + Method calculates hash for any object. Method serializes object properties + to string using Reflection and returns hash of created string. + + Object which hash must be calculated. + Properties to skip. + Calculated hash code. + + + + Method in recursion builds string representation of the object. + + Output string + Object which must be converted to string. + Properties to skip. + + + + Optimized version of SortedList collection. Instead of keeping two + arrays, one for keys and one for values, the values array on + Hashtable collection are changed. Performance of this collection is better than that of SortedList. + + + + + Default capacity of internal buffers. + + + + + Array which store keys in sorted order. + + + + + Collection stores values. + + + + + Size of collection. + + + + + Version of collection data. + + + + + Default comparer for keys. + + + + + List of keys. + + + + + List of values. + + + + + Default constructor. + + + + + Creates an empty list with the specified initial capacity. + + Initial capacity. + + When initialCapacity is less than zero. + + + + + Creates an empty SortedList with the default initial capacity + and specified comparer. + + + The IComparer is used to determine whether two keys are equal. + + + + + Creates an empty SortedList with the specified initial capacity + and specified comparer. + + Initial capacity. + + The IComparer is used to determine whether two keys are equal. + + + + + Copies the elements from the specified dictionary to a new list + with the same initial capacity as the number of elements copied. + + The IDictionary to copy. + + + + Copies the elements from the specified dictionary to a new list with the same + initial capacity as the number of elements copied and with the specified comparer. + + The IDictionary to copy. + + The IComparer to use to determine whether two keys are equal. + + + When argument d is null. + + + + + Returns a synchronized (thread-safe) wrapper for the SortedList. + + The SortedList to synchronize. + A synchronized (thread-safe) wrapper for the SortedList. + + When list is null. + + + + + Adds an element with the provided key and value to the list. + + The Object to use as the key of the element to add. + The Object to use as the value of the element to add. + + When key is null. + + + When list already contains specified key. + + + + + Removes all elements from the collection. + + + + + Creates a new object that is a copy of the current instance. + + Copy of the current instance. + + + + Clone current instance. + + Returns clone of current object. + + + + Determines whether the list contains an element with the specified key. + + Key of the element to search. + True if list contains specified key. + + + + Determines whether the list contains an element with the specified key. + + Key of the element to search. + True if list contains specified key. + + + + Determines whether the list contains the specified value. + + Value of the element to search. + True if list contains specified value. + + + + Copies all the elements of the SortedListEx to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + If specified array is null. + + + If rank of the array is not 1 or there are not enough elements. + + + If specified arrayIndex is less than zero. + + + + + Gets the value at the specified index of the SortedListEx. + + The zero-based index of the value to get. + The value at the specified index of the SortedListEx. + + When index is less than zero or greater than size of the list. + + + + + Gets the key at the specified index of the SortedListEx. + + The zero-based index of the key to get. + The key at the specified index of the SortedListEx. + + When index is less than zero or greater than size of the list. + + + + + Gets the keys in the SortedListEx. + + An IList containing the keys in the SortedListEx. + + + + Gets the values in the SortedListEx. + + An IList containing the values in the SortedListEx. + + + + Returns the zero-based index of the specified key. + + The key to locate. + The zero-based index of key, if key is found; otherwise, -1. + + If specified key is null. + + + + + Returns the zero-based index of the first occurrence of the specified value. + + The value to locate (can be NULL). + + The zero-based index of the first occurrence of value, if value is found; + otherwise, -1. + + + + + Removes the element at the specified index. + + The zero-based index of the element to remove. + + When index is less than zero or greater than size of the list. + + + + + Removes the element with the specified key from SortedListEx. + + The key of the element to remove. + + + + Replaces the value at the specific index. + + The zero-based index at which to save value. + The Object to save into. Can be NULL. + + When index is less than zero or greater than size of the list. + + + + + Sets the capacity to the actual number of elements. + + + + + Returns an IDictionaryEnumerator that can iterate through the SortedListEx. + + An IDictionaryEnumerator for the SortedListEx. + + + + Returns an IEnumerator that can iterate through the SortedListEx. + + An IEnumerator for the SortedListEx. + + + + Inserts element with specified key and value at specified index. + + The zero-based index to insert element at. + The key of the element to insert. + The value of the element to insert. + + + + Ensures that the capacity of this instance is at least the specified value. + + The minimum capacity to ensure. + + + + Capacity of internal buffers. + + + + + Size of the collection. Read-only. + + + + + List of keys. Read-only. + + + + + List of values. Read-only. + + + + + Returns True if list is readonly, False otherwise. Read-only. + + + + + Returns True if collection has fixed size, False otherwise. + + + + + Returns True if the collection is synchronized, False otherwise. + + + + + Returns the object that can be used to synchronize access to the collection. + Read-only. + + + + + Gets or sets the value associated with the specified key. + + + + + Wrapped SortedListEx. + + + + + Sync object. + + + + + Creates SyncSortedListEx for specified SortedListEx. + + SortedListEx that will be wrapped. + + + + Adds an element with the provided key and value to the list. + + The Object to use as the key of the element to add. + The Object to use as the value of the element to add. + + + + Removes all the elements from the collection. + + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of the current instance. + + + + Determines whether the list contains an element with the specified key. + + Key of the element to search. + True if list contains specified key. + + + + Determines whether the list contains an element with the specified key. + + Key of the element to search. + True if list contains specified key. + + + + Determines whether the list contains the specified value. + + Value of the element to search. + True if list contains specified value. + + + + Copies all the elements of the list to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + + + Gets the value at the specified index of the list. + + The zero-based index of the value to get. + The value at the specified index of the SortedListEx. + + + + Returns an IDictionaryEnumerator that can iterate through the list. + + An IDictionaryEnumerator for the list. + + + + Gets the key at the specified index of the list. + + The zero-based index of the key to get. + The key at the specified index of the list. + + + + Gets the keys in the list. + + An IList containing the keys in the list. + + + + Gets the values in the list. + + An IList containing the values in the list. + + + + Returns the zero-based index of the specified key. + + The key to locate. + The zero-based index of key, if key is found; otherwise, -1. + + + + Returns the zero-based index of the first occurrence of the specified value. + + The value to locate (can be NULL). + + The zero-based index of the first occurrence of value, if value is found; + otherwise, -1. + + + + + Removes the element at the specified index. + + The zero-based index of the element to remove. + + + + Removes the element with the specified key from list. + + The key of the element to remove. + + + + Replaces the value at a specific index. + + The zero-based index at which to save value. + The Object to save into. Can be NULL. + + + + Sets the capacity to the actual number of elements. + + + + + Capacity of internal buffers. + + + + + Size of the collection. Read-only. + + + + + Returns the object that can be used to synchronize access to the collection. + Read-only. + + + + + Returns True if list is readonly, False otherwise. Read-only. + + + + + Returns True if collection has fixed size, False otherwise. + + + + + Returns True if the collection is synchronized, False otherwise. + + + + + Gets or sets the value associated with the specified key. + + + + + If it is assumed to getObjectRetType, Current will return key + of the current element. + + + + + If it is assumed to getObjectRetType, Current will return value + of the current element. + + + + + If it is assumed to getObjectRetType, Current will return both - + key and value (as DictionaryEntry). + + + + + List for which is this enumerator. + + + + + Key of the current element. + + + + + Values of the current element. + + + + + Index of current element. + + + + + Starting index for the enumerator. + + + + + Ending index for this enumerator. + + + + + Version of collection data. + + + + + True if current element is correct, False otherwise + (before beginning or after end). + + + + + Specifies what should return method Current (Key, Value or both). + + + + + Creates enumerator for specified list, starting from specified index + and with specified count. + + list for which to create enumerator. + Starting index. + Number of elements to enumerate. + Type of enumerating values (keys, value, DicEntry). + + + + Creates a new object that is a copy of the current instance. + + Copy of the current instance. + + + + Advances the enumerator to the next element of the collection. + + + True if the enumerator was successfully advanced to the next element; + False if the enumerator has passed the end of the collection. + + + When the current version is not equal to the SortedListEx version. + + + + + Sets the enumerator to its initial position, which is before + the first element in the collection. + + + When the current version is not equal to the SortedListEx version. + + + + + Returns key of the current element. Read-only. + + + When the current version is not equal to the SortedListEx version + or if current is false. + + + + + Return DictionaryEntry for the current element. + + + When the current version is not equal to the SortedListEx version + or if current is false. + + + + + The current element in the collection. Read-only. + + + If current is false. + + + + + Returns value for the current element. + + + When the current version is not equal to the SortedListEx version + or if current is false. + + + + + List for which this collection was created. + + + + + Creates KeyList for specified SortedListEx. + + SortedListEx for which KeyList must be created. + + + + Adds an element with the provided key to the list. + + The Object to use as the key of the element to add. + + + + Removes all elements from the collection. + + + + + Determines whether the list contains an element with the specified key. + + Key of the element to search. + True if list contains specified key. + + + + Copies all the elements of the list to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + If array is null or rank of the array is not 1. + + + + + Insert the value at the specific index. + + The zero-based index at which to save value. + The Object to save into. Can be NULL. + + + + Returns an IEnumerator that can iterate through the list. + + An IEnumerator for the list. + + + + Returns the zero-based index of the specified key. + + The key to locate. + The zero-based index of the key, if the key is found; otherwise, -1. + + + + Removes the element with the specified key from list. + + The key of the element to remove. + + + + Removes the element at the specified index from the list. + + The zero-based index of the element to remove. + + + + Size of the collection. Read-only. + + + + + Returns True if list is readonly, False otherwise. Read-only. + + + + + Returns True if collection has fixed size, False otherwise. + + + + + Returns True if the collection is synchronized, False otherwise. + + + + + Returns the object that can be used to synchronize access to the collection. + Read-only. + + + + + Gets or sets the key at the specified index. + + + + + List for which this collection was created. + + + + + Array list that contain values. + + + + + Creates ValueList for specified SortedListEx. + + SortedListEx for which ValueList must be created. + + + + Re-read values from the list. + + + + + Adds an element with the provided key to the list. + + The Object to use as the key of the element to add. + + + + Removes all elements from the collection. + + + + + Determines whether the list contains an element with the specified value. + + Value to search. + True if list contains specified value. + + + + Copies all the elements of the list to the specified one-dimensional Array + starting at the specified destination Array index. + + The one-dimensional Array that is the destination of the + elements copied from the current list. + The index in array at which copying begins. + + + + Insert the value at the specific index. + + The zero-based index at which to save value. + The Object to save into. Can be NULL. + + + + Returns an IEnumerator that can iterate through the list. + + An IEnumerator for the list. + + + + Returns the zero-based index of the specified value. + + The value to locate. + The zero-based index of the value, if the value is found, otherwise -1. + + + + Removes the specified value from list. + + The value to remove. + + + + Removes the element at the specified index from the list. + + The zero-based index of the element to remove. + + + + Size of the collection. Read-only. + + + + + Returns True if list is readonly, False otherwise. Read-only. + + + + + Returns True if collection has fixed size, False otherwise. + + + + + Returns True if the collection is synchronized, False otherwise. + + + + + Returns the object that can be used to synchronize access to the collection. + Read-only. + + + + + Gets or sets the value at the specified index. + + + + + Comparer for strings. + + + + + Compare two strings. + + String to compare. + String to compare. + Returns compared results. + + + + Dictionary is used for grouping strings used by Excel in order to prevent + doubling of data. Dictionary stores information as key string and value. + + + + + Default reserved space by internal collections. + + + + + Index of the empty string. + + + + + Default count of empty strings. + Returned by GetStringsCount method. + Arbitrary number but should be larger than 1. + + + + + Maximum allowed cell length. + + + + + Dictionary key-to-index in the array. + + + + + Strings data. + + + + + Array that contains indexes that are free (strings that were removed). + + + + + Parent workbook. + + + + + Original SSTRecord. + + + + + Indicates whether original SSTRecord was parsed. + + + + + Temporary string. + + + + + Number of references to each string. + + + + + Indicates whether we should use hashtable to increase search speed. + + + + + Default constructor. Reserves space for strings. + + + + + Returns SST content. + + Index of the target string. + SST content object. + + + + Clears the list. + + + + + Searches for all strings with specified text. + + String to search. + Dictionary, key - string index, value - null. + + + + Adds string into dictionary. If the string exists in dictionary, + add reference count. Method can influence on SST Indexes. + + Index to the string. + + + + Adds string into dictionary. If the string exists in dictionary, + add reference count. Method can influence on SST Indexes. + + String to add + Index of the added string. + + + + Adds string into dictionary. If the string exists in dictionary, + add reference count. Method can influence on SST Indexes. + + String to add + Reference count for new entries. + Index of the added string. + + + + Checks whether new string value is within allowed limits. + + + + + + Remove reference of string. When reference count reaches zero, string will be + removed from dictionary. Method can influence the SST indexes. + + String whose reference must be removed. + + When SST table does not contain the specified string. + + + + + Remove reference of string. When reference count reaches zero, string will be + removed from dictionary. Method can influence the SST indexes. + + String index to remove. + + + + Method decreases reference count of string without removing it. + + Index of the string to decrease reference. + + + + Method checks if the dictionary contains the specified string. + + String which must be checked. + True - string exists in dictionary, otherwise False. + + + + Serialize dictionary. + + Records where writes serialized data. + + + + Returns number of strings in the dictionary. + + Index of the target string. + + + + Returns RTF string by its index in the dictionary. + + Index of the target string. + RTF string. + + + + Adds copy of the string from another collection. + + Index of the string to add. + Source string table. + Dictionary with font indexes. + Index of the added string. + + + + Searches for all strings that starts with specified string. + + String prefix to search. + + List with all string indexes that starts with specified + string, in ascending order. + + + + + Creates copy of the current instance. + + Copy of the current instance. + + + + Updates internal array that stores reference count. + + + + + This methods looks through all row storages to find out used strings. + And removes all unnecessary strings after that. + + + + + Moves strings. + + Start index. + End index. + Decrease index. + List with new strings indexes. + + + + Removes all unused strings from inner collections. + + + + + Saves into record. + + Array where save is. + + + + Sets number of references to the string. + + String index. + References count to set. + + + + Gets number of references to the string. + + String index. + number of references to the string. + + + + + + + + + + + + + + + + + + Fills internal hash used for string searching. + + + + + Here we have to parse our SST record + + + + + Updates LabelSST indexes after SST record parsing. + + Dictionary with indexes to update, key - old index, value - new index. + + + + Returns LabelSST used. + + + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + + + + + + Gets references count to specified string. + + + + + Gets text with format. + + + + + Gets list of strings. + + + + + Gets quantity of unique strings. + + + + + Returns parent workbook. Read-only. + + + + + Gets / sets original SSTRecord. + + + + + + + + + + Returns number of strings without removed items. Read-only. + + + + + Gets / Sets HashkeyToIndex value + + + + + Increase Index + + + + + + Represents the XlsIO Chart to image converter. + + + This interface is not supported in Xamarin(PCL) and NetStandard platforms and supported from .NET Framework 4.0 onwards. + + + + + Converts the XlsIO chart to Image as stream. + + Represents the XlsIO Chart object. + In where the image is streamed. + + To know more about chart to image conversion refer this link. + + + The following code illustrates how to convert an Excel chart to an image. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + // Initializing the chart to image converter object + application.ChartToImageConverter = new Syncfusion.ExcelChartToImageConverter.ChartToImageConverter(); + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Initalizing the new stream + MemoryStream imageStream = new MemoryStream(); + + //Convert the chart to image stream + chart.SaveAsImage(imageStream); + + //Saving the image stream to a file + System.Drawing.Image bitmap = System.Drawing.Image.FromStream(imageStream); + bitmap.Save("image.png"); + + //Dispose + workbook.Close(); + } + + + + + + It represents the chart image Scaling. + Default value is Normal. + + + To know more about chart to image conversion refer this link. + + + The following code illustrates how to set scaling mode for object. + + using (ExcelEngine excelEngine = new ExcelEngine()) + { + //Create worksheet + IApplication application = excelEngine.Excel; + application.DefaultVersion = ExcelVersion.Excel2013; + IWorkbook workbook = application.Workbooks.Create(1); + IWorksheet sheet = workbook.Worksheets[0]; + + // Initializing the chart to image converter object + application.ChartToImageConverter = new Syncfusion.ExcelChartToImageConverter.ChartToImageConverter(); + + //Set the chart to image converter Scaling mode to best + application.ChartToImageConverter.ScalingMode = ScalingMode.Best; + + //Add data + sheet.Range["A1"].Text = "Jan"; + sheet.Range["B1"].Text = "Feb"; + sheet.Range["C1"].Text = "Mar"; + sheet.Range["A2"].Value = "10"; + sheet.Range["B2"].Value = "20"; + sheet.Range["C2"].Value = "30"; + sheet.Range["A3"].Value = "15"; + sheet.Range["B3"].Value = "25"; + sheet.Range["C3"].Value = "35"; + + //Create chart + IChart chart = sheet.Charts.Add(); + + //Set range + chart.DataRange = sheet.Range["A1:C3"]; + + //Set chart type + chart.ChartType = ExcelChartType.Column_Clustered; + + //Initalizing the new stream + MemoryStream imageStream = new MemoryStream(); + + //Convert the chart to image stream + chart.SaveAsImage(imageStream); + + //Saving the image stream to a file + System.Drawing.Image bitmap = System.Drawing.Image.FromStream(imageStream); + bitmap.Save("image.png"); + + //Dispose + workbook.Close(); + } + + + + + + Represents plot area of the chart. + + + + + Enumeration of the sheet types in Excel. + + + + + Charts. + + + + + Dialogs. + + + + + Excel 4.0 International Macros. + + + + + Excel 4.0 Macros. + + + + + Worksheets. + + + + + Specifies the line style for the border in Excel. + + + + + No line. + + + + + Thin line. + + + + + Medium line. + + + + + Dashed line. + + + + + Dotted line. + + + + + Thick line. + + + + + Double line. + + + + + Hair line. + + + + + Medium_dashed line. + + + + + Dash_dot line. + + + + + Medium dash_dot line. + + + + + Dash_dot_dot line. + + + + + Medium dash_dot_dot line. + + + + + Slanted_dash_dot line. + + + + + Enumeration of the border and diagonal line types in Excel. + + + + + Represents the diagonal line from top left to right bottom. + + + + + Represents the diagonal line from bottom left to right top. + + + + + Represents the border line on the bottom. + + + + + Represents the border line on the left. + + + + + Represents the border line on the right. + + + + + Represents the border line on the top. + + + + + Represents horizontal borders inside a selected range. + + + + + Represents vertical borders inside a selected range. + + + + + Enumeration of the label types for formula in Excel. + + + + + Represents Column label for formula. + + + + + Represents Mixed label for formula. + + + + + Represents no label for formula. + + + + + Represents row label for formula. + + + + + Enumeration of the border weight types for lines/pictures in Excel. + + + + + Represents weight of a Hairline border type. + + + + + Represents weight of a Medium border type. + + + + + Represents weight of a Thick border type. + + + + + Represents weight of a Thin border type. + + + + + Represents weight of a None border type. + + + + + Enumeration of the Color Index in Excel. + + + + + Represents the automatic color index. + + + + + Represents no color index. + + + + + Enum that defines different types of the formula calculations. + + + + + Represents the MANUAL calculation type. + + + + + Represents the AUTOMATIC calculation type. + + + + + Represents the AUTOMATIC EXCEPT TABLES calculation type. + + + + + Enumeration of the horizontal alignment options for cell formatting in Excel. + + + + + Represents the general horizontal alignment setting. + + + + + Represents left horizontal alignment setting. + + + + + Represents center horizontal alignment setting. + + + + + Represents center horizontal alignment setting. + + + + + Represents fill horizontal alignment setting. + + + + + Represents justify horizontal alignment setting. + + + + + Represents center across selection horizontal alignment setting. + + + + + Represents distributed horizontal alignment setting. + + + + + Enumeration of the vertical alignment options for cell formatting in Excel. + + + + + Represents top vertical alignment setting. + + + + + Represents center vertical alignment setting. + + + + + Represents bottom vertical alignment setting. + + + + + Represents justify vertical alignment setting. + + + + + Represents distributed vertical alignment setting. + + + + + Enumeration of page order for sheet in Excel. + + + + + Represents Down, then over setting. + + + + + Represents Over, then down setting. + + + + + Enumeration of page orientation types in Excel. + + + + + Represents landscape setting. + + + + + Represents portrait setting. + + + + + Enumeration of paper size types in Excel. + + + + + Represents paper size of 10 inches X 14 inches + + + + + Represents paper size of 11 inches X 17 inches + + + + + Represents A3 (297 mm x 420 mm) paper size. + + + + + Represents A4 (210 mm x 297 mm) paper size. + + + + + Represents A4 Small (210 mm x 297 mm) paper size. + + + + + Represents A5 (148 mm x 210 mm) paper size. + + + + + Represents B4 (250 mm x 353 mm) paper size. + + + + + Represents B5 (176 mm x 250 mm) paper size. + + + + + Represents C paper size. + + + + + Represents D paper size. + + + + + Represents Envelope# 10 paper size(4-1/8 X 9-1/2 inches). + + + + + Represents Envelope# 11 paper size( (4-1/2 X 10-3/8 inches). + + + + + Represents Envelope# 12 paper size(4-3/4 X 11 inches). + + + + + Represents Envelope# 14 paper size(5 X 11-1/2 inches). + + + + + Represents Envelope# 9 paper size(3-7/8 X 8-7/8 inches). + + + + + Represents B4 Envelope paper size (250 mm x 353 mm). + + + + + Represents B5 Envelope paper size (176 mm x 250 mm). + + + + + Represents B6 Envelope paper size (176 mm x 125 mm). + + + + + Represents C3 Envelope paper size (324 mm x 458 mm). + + + + + Represents C4 Envelope paper size (229 mm x 324 mm). + + + + + Represents C5 Envelope paper size (162 mm x 229 mm). + + + + + Represents C6 Envelope paper size (114 mm x 162 mm). + + + + + Represents C65 Envelope paper size (114 mm x 229 mm). + + + + + Represents DL Envelope paper size (110 mm x 220 mm). + + + + + Represents Italy Envelope paper size (110 mm x 230 mm). + + + + + Represents Monarch Envelope paper size (3-7/8 X 7-1/2 inches). + + + + + Represents Personal Envelope paper size (3-5/8 X 6-1/2 inches). + + + + + Represents E paper size. + + + + + Represents Executive paper size (7-1/2 X 10-1/2 inches). + + + + + Represents German Fanfold paper size (8-1/2 X 13 inches). + + + + + Represents German Standard Fanfold paper size (8-1/2 X 12 inches). + + + + + Represents U.S. Standard Fanfold paper size (14-7/8 X 11 inches). + + + + + Represents Folio paper size (8-1/2 X 13 inches). + + + + + Represents Ledger paper size (17 X 11 inches). + + + + + Represents Legal paper size (8-1/2 X 14 inches). + + + + + Represents Letter paper size (8-1/2 X 11 inches). + + + + + Represents Letter Small paper size. + + + + + Represents Note paper size. + + + + + Represents Quarto paper size(215 mm x 275 mm). + + + + + Represents Statement paper size(5-1/2 X 8-1/2 inches). + + + + + Represents Tabloid paper size(11 X 17 inches). + + + + + Represents User paper size. + + + + + Represents ISO B4 paper size(250 mm by 353 mm). + + + + + Represents Japanese double postcard(200 mm by 148 mm). + + + + + Represents Standard paper(9 in. by 11 in.). + + + + + Represents Standard paper(10 in. by 11 in.). + + + + + Represents Standard paper(15 in. by 11 in.). + + + + + Represents Invite envelope (220 mm by 220 mm). + + + + + Represents Letter extra paper (9.275 in. by 12 in.). + + + + + Represents Legal extra paper (9.275 in. by 15 in.). + + + + + Represents Tabloid extra paper (11.69 in. by 18 in.). + + + + + Represents A4 extra paper (236 mm by 322 mm). + + + + + Represents Letter transverse paper (8.275 in. by 11 in.). + + + + + Represents A4 transverse paper (210 mm by 297 mm). + + + + + Represents Letter extra transverse paper (9.275 in. by 12 in.). + + + + + Represents SuperA/SuperA/A4 paper (227 mm by 356 mm). + + + + + Represents SuperB/SuperB/A3 paper (305 mm by 487 mm). + + + + + Represents Letter plus paper (8.5 in. by 12.69 in.). + + + + + Represents A4 plus paper (210 mm by 330 mm). + + + + + Represents A5 transverse paper (148 mm by 210 mm). + + + + + Represents JIS B5 transverse paper (182 mm by 257 mm). + + + + + Represents A3 extra paper (322 mm by 445 mm). + + + + + Represents A5 extra paper (174 mm by 235 mm). + + + + + Represents ISO B5 extra paper (201 mm by 276 mm). + + + + + Represents A2 paper (420 mm by 594 mm). + + + + + Represents A3 transverse paper (297 mm by 420 mm). + + + + + Represents A3 extra transverse paper (322 mm by 445 mm). + + + + + Enumeration representing print comments in Excel. + + + + + Represents As displayed on sheet setting. + + + + + Represents (None) setting. + + + + + Represents at end of sheet setting. + + + + + Enumeration of Replace Error Values when printing in Excel. + + + + + Represents the blank option. + + + + + Represents the dash (--) option. + + + + + Represents the displayed option. + + + + + Represents the #N/A option. + + + + + Enumeration of page break extent types in Excel. + + + + + Represents full page break option. + + + + + Represents partial page break option. + + + + + Enumeration of page break types in Excel. + + + + + Represents the Automatic option. + + + + + Represents the Manual option. + + + + + Represents the None option. + + + + + Enumeration of Save as Access mode types in Excel. + + + + + Exclusive mode. + + + + + No change mode. + + + + + Shared mode. + + + + + Specifies the underline types for the fonts available in Excel. + + + + + No underline. + + + + + Single underline. + + + + + Double underline. + + + + + SingleAccounting underline which does not support in chart data labels. + + + + + DoubleAccounting underline which does not support in chart data labels. + + + + + Enumeration of merge operation types in Excel. + + + + + Represents the Leave option. + + + + + Represents the Delete option. + + + + + Enumeration of Worksheet functions in Excel. + + + + + Represents the NONE function. + + + + + Represents the Custom function. + + + + + Represents the ABS function. + + + + + Represents the ACOS function. + + + + + Represents the ACOSH function. + + + + + Represents the ADDRESS function. + + + + + Represents the AND operation. + + + + + Represents the Areas function. + + + + + Represents the ASIN function. + + + + + Represents the ASINH function. + + + + + Represents the ATAN function. + + + + + Represents the ATAN2 function. + + + + + Represents the ATANH function. + + + + + Represents the AVEDEV function. + + + + + Represents the AVERAGE function. + + + + + Represents the AVERAGEA function. + + + + + Represents the HEX2BIN function. + + + + + Represents the HEX2DEC function. + + + + + Represents the HEX2OCT function. + + + + + Represents the COUNTIF function. + + + + + Represents the BIN2DEC function. + + + + + Represents the BIN2HEX function. + + + + + Represents the BIN2OCT function. + + + + + Represents the DEC2BIN function. + + + + + Represents the DEC2HEX function. + + + + + Represents the DEC2OCT function. + + + + + Represents the OCT2BIN function. + + + + + Represents the OCT2DEC function. + + + + + Represents the OCT2HEX function. + + + + + Represents the ODDFPRICE function. + + + + + Represents the ODDFYEILD function. + + + + + Represents the ODDLPRICE function. + + + + + Represents the ODDLYEILD function. + + + + + Represents the ISODD function. + + + + + Represents the ISEVEN function. + + + + + Represents the LCM function. + + + + + Represents the GCD function. + + + + + Represents the SUMIFS function. + + + + + Represents the AVERAGEIF function. + + + + + Represents the AVERAGEIFS function. + + + + + Represents the CONVERT function. + + + + + Represents the COMPLEX function. + + + + + Represents the COUPDAYBS function. + + + + + Represents the COUPDAYS function. + + + + + Represents the COUPDAYSNC function. + + + + + Represents the COUPNCD function. + + + + + Represents the COUPNUM function. + + + + + Represents the COUPPCD function. + + + + + Represents the DELTA function. + + + + + Represents the DISC function. + + + + + Represents the DOLLARDE function. + + + + + Represents the DOLLARFR function. + + + + + Represents the DURATION function. + + + + + Represents the EDATE function. + + + + + Represents the EFFECT function. + + + + + Represents the EOMONTH function. + + + + + Represents the ERF function. + + + + + Represents the ERFC function. + + + + + Represents the FACTDOUBLE function. + + + + + Represents teh GESTEP function. + + + + + Represents the IFERROR function. + + + + + Represents the IMABS function + + + + + Represents the IMAGINARY function. + + + + + Represents the IMARGUMENT function. + + + + + Represents the IMCONJUGATE function. + + + + + Represents the IMCOS function. + + + + + Represents the IMEXP function. + + + + + Represents the IMLN function. + + + + + Represents the IMLOG10 function. + + + + + Represents the IMLOG2 function. + + + + + Represents the IMREAL function. + + + + + Represents the IMSIN function. + + + + + Represents the IMSQRT function. + + + + + Represents the IMSUB function. + + + + + Represents the IMSUM function. + + + + + Represents the IMDIV function. + + + + + Represents the IMPOWER function. + + + + + Represents the IMPRODUCT function. + + + + + Represents the ACCRINT function. + + + + + Represents the ACCRINTM function. + + + + + Represents the AGGREGATE function. + + + + + Represents the AMORDEGRC function. + + + + + Represents the AMORLINC function. + + + + + Represents the BAHTTEXT function. + + + + + Represents the BESSELI function. + + + + + Represents the BESSELJ function. + + + + + Represents the BESSELK function. + + + + + Represents the BESSELY function. + + + + + Represents the CUBEKPIMEMBER function. + + + + + Represents the CUBEMEMBER function. + + + + + Represents the CUBERANKEDMEMBER function. + + + + + Represents the CUBESET function. + + + + + Represents the CUBESETCOUNT function. + + + + + Represents the CUBEMEMBERPROPERTY function. + + + + + Represents the CUMIPMT function. + + + + + Represents the CUMPRINC function. + + + + + Represents the FVSCHEDULE function. + + + + + Represents the INTRATE function. + + + + + Represents the LINTEST function. + + + + + Represents the CUBEVALUE function. + + + + + Represents the MDURATION function. + + + + + Represents the MROUND function. + + + + + Represents the MULTINOMIAL function. + + + + + Represents the NETWORKDAYS function. + + + + + Represents the NOMINAL function. + + + + + Represents the PRICE function. + + + + + Represents the PRICEDISC function. + + + + + Represents the PRICEMAT function. + + + + + Represents the QUOTIENT function. + + + + + Represents the RANDBETWEEN function. + + + + + Represents the RECEIVED function. + + + + + Represents the SERIESSUM function. + + + + + Represents the SQRTPI function. + + + + + Represents the TBILLEQ function. + + + + + Represents the TBILLPRICE function. + + + + + Represents the TBILLYIELD function. + + + + + Represents the WEEKNUM function. + + + + + Represents the WORKDAY function. + + + + + Represents the XIRR function. + + + + + Represents the XNPV function. + + + + + Represents the YEAR function. + + + + + Represents the YIELD function. + + + + + Represents the YIELDDISC function. + + + + + Represents the YIELDMAT function. + + + + + Represents the WORKDAY.INTL function. + + + + + Represents the BETA.INV function. + + + + + Represents the BINOM.DIST function. + + + + + Represents the BINOM.INV function. + + + + + Represents the CEILING.PRECISE function. + + + + + Represents the CHISQ.DIST function. + + + + + Represents the CHISQ.DIST.RT function. + + + + + Represents the CHISQ.INV function. + + + + + Represents the CHISQ.INV.RT function. + + + + + Represents the CHISQ.TEST function. + + + + + Represents the CONFIDENCE.NORM function. + + + + + Represents the CONFIDENCE.T function. + + + + + Represents the COVARIANCE.P function. + + + + + Represents the COVARIANCE.S function. + + + + + Represents the ERF.PRECISE function. + + + + + Represents the ERFC.PRECISE function. + + + + + Represents the F.DIST function. + + + + + Represents the F.DIST.RT function. + + + + + Represents the F.INV function. + + + + + Represents the F.INV.RT function. + + + + + Represents the F.TEST function. + + + + + Represents the FLOOR.PRECISE function. + + + + + Represents the GAMMA.DIST function. + + + + + Represents the GAMMA.INV function. + + + + + Represents the GAMMALN.PRECISE function. + + + + + Represents the HYPGEOM.DIST function. + + + + + Represents the LOGNORM.DIST function. + + + + + Represents the LOGNORM.INV function. + + + + + Represents the MODE.MULT function. + + + + + Represents the MODE.SNGL function. + + + + + Represents the NEGBINOM.DIST function. + + + + + Represents the NETWORKDAYS.INTL function. + + + + + Represents the NORM.DIST function. + + + + + Represents the NORM.INV function. + + + + + Represents the NORM.S.DIST function. + + + + + Represents the PERCENTILE.EXC function. + + + + + Represents the PERCENTILE.INC function. + + + + + Represents the PERCENTRANK.EXC function. + + + + + Represents the PRECENTRANK.INC function. + + + + + Represents the POISSON.DIST function. + + + + + Represents the QUARTILE.EXC function. + + + + + Represents the QUARTILE.INC function. + + + + + Represents the RANK.AVG function. + + + + + Represents the RANK.EQ function. + + + + + Represents the STDEV.P function. + + + + + Represents the STDEV.S function. + + + + + Represents the T.DIST function. + + + + + Represents the T.DIST.2T function. + + + + + Represents the T.DIST.RT function. + + + + + Represents the T.INV function. + + + + + Represents the T.INV.2T function. + + + + + Represents the T.TEST function. + + + + + Represents the VAR.P function. + + + + + Represents the VAR.S function. + + + + + Represents the WEIBULL.DIST function. + + + + + Represents the WORKDAY.INTL function. + + + + + Represents the Z.TEST function. + + + + + Represents the BETA.DIST function. + + + + + Represents the EUROCONVERT function. + + + + + Represents the PHONETIC function. + + + + + Represents the REGISTER.ID function. + + + + + Represents the SQL.REQUEST function. + + + + + Represents the JIS function. + + + + + Represents the EXPON.DIST function. + + + + + Represents the DAYS function. + + + + + Represents the ISOWEEKNUM function. + + + + + Represents the BITAND function. + + + + + Represents the BITLSHIFT function. + + + + + Represents the BITOR function. + + + + + Represents the BITXOR function. + + + + + Represents the BITXOR function. + + + + + Represents the IMCOSH function. + + + + + Represents the IMCOT function. + + + + + Represents the IMCSC function. + + + + + Represents the IMCSCH function. + + + + + Represents the IMSEC function. + + + + + Represents the IMSECH function. + + + + + Represents the IMSINH function. + + + + + Represents the IMTAN function. + + + + + Represents the PDURATION function. + + + + + Represents the RRI function. + + + + + Represents the ISFORMULA function. + + + + + Represents the SHEET function. + + + + + Represents the SHEETS function. + + + + + Represents the IFNA function. + + + + + Represents the XOR function. + + + + + Represents the FORMULATEXT function. + + + + + Represents the ACOT function. + + + + + Represents the ACOTH function. + + + + + Represents the ARABIC function. + + + + + Represents the BASE function. + + + + + Represents the CEILING.MATH function. + + + + + Represents the COMBINA function. + + + + + Represents the COT function. + + + + + Represents the COTH function. + + + + + Represents the CSC function. + + + + + Represents the CSCH function. + + + + + Represents the DECIMAL function. + + + + + Represents the FLOOR.MATH function. + + + + + Represents the ISO.CEILING function. + + + + + Represents the MUNIT function. + + + + + Represents the SEC function. + + + + + Represents the SECH function. + + + + + Represents the BINOM.DIST.RANGE function. + + + + + Represents the GAMMA function. + + + + + Represents the GAUSS function. + + + + + Represents the PERMUTATIONA function. + + + + + Represents the PHI function. + + + + + Represents the SKEW.P function. + + + + + Represents the NUMBERVALUE function. + + + + + Represents the UNICHAR function. + + + + + Represents the UNICODE function. + + + + + Represents the ENCODEURL function. + + + + + Represents the FILTERXML function. + + + + + Represents the WEBSERVICE function. + + + + + Represents the TEXTJOIN function. + + + + + Represents the CONCAT function. + + + + + Represents the IFS function. + + + + + Represents the SWITCH function. + + + + + Represents the MINIFS function. + + + + + Represents the MAXIFS function. + + + + + Represents the FORECAST.ETS function. + + + + + Represents the FORECAST.ETS.SEASONALITY function. + + + + + Represents the FORECAST.LINEAR function. + + + + + Represents the FORECAST.ETS.CONFINT function. + + + + + Represents the FORECAST.ETS.STAT function. + + + + + + Represents the XLOOKUP function. + + + + + Represents the LET function. + + + + + Represents the XMATCH function. + + + + + Represents the ARRAYTOTEXT function. + + + + + Represents the VALUETOTEXT function. + + + + + Represents the FILTER function. + + + + + Represents the ANCHORARRAY function. + + + + + Represents the TEXTAFTER function. + + + + + Represents the CHOOSEROWS function. + + + + + Represents the CHOOSECOLS function. + + + + + Represents the TEXTBEFORE function. + + + + + Represents the TEXTSPLIT function. + + + + + Represents the TOROW function. + + + + + Represents the TOCOL function. + + + + + Represents the SORT function. + + + + + Represents the LAMBDA function. + + + + + Represents the BYROW function. + + + + + Represents the BYCOL function. + + + + + Represents the SORTBY function. + + + + + Represents the BETADIST function. + + + + + Represents the BETAINV function. + + + + + Represents the BINOMDIST function. + + + + + Represents the CEILING function. + + + + + Represents the CELL function. + + + + + Represents the CHAR function. + + + + + Represents the CHIDIST function. + + + + + Represents the CHIINV function. + + + + + Represents the CHITEST function. + + + + + Represents the CHOOSE function. + + + + + Represents the CLEAN function. + + + + + Represents the CODE function. + + + + + Represents the COLUMN function. + + + + + Represents the COLUMNS function. + + + + + Represents the COMBIN function. + + + + + Represents the CONCATENATE function. + + + + + Represents the CONFIDENCE function. + + + + + Represents the CORREL function. + + + + + Represents the COS function. + + + + + Represents the COSH function. + + + + + Represents the COUNT function. + + + + + Represents the COUNTA function. + + + + + Represents the COUNTBLANK function. + + + + + Represents the COUNTIF function. + + + + + Represents the COVAR function. + + + + + Represents the CRITBINOM function. + + + + + Represents the DATE function. + + + + + Represents the DATEVALUE function. + + + + + Represents the DAVERAGE function. + + + + + Represents the DAY function. + + + + + Represents the DAYS360 function. + + + + + Represents the DB function. + + + + + Represents the DCOUNT function. + + + + + Represents the DCOUNTA function. + + + + + Represents the DDB function. + + + + + Represents the DEGREES function. + + + + + Represents the DEVSQ function. + + + + + Represents the DMAX function. + + + + + Represents the DMIN function. + + + + + Represents the DOLLAR function. + + + + + Represents the DPRODUCT function. + + + + + Represents the DSTDEV function. + + + + + Represents the DSTDEVP function. + + + + + Represents the DSUM function. + + + + + Represents the DVAR function. + + + + + Represents the DVARP function. + + + + + Represents the ERROR function. + + + + + Represents the ERRORTYPE function. + + + + + Represents the EVEN function. + + + + + Represents the EXACT function. + + + + + Represents the EXP function. + + + + + Represents the EXPONDIST function. + + + + + Represents the FACT function. + + + + + Represents the FALSE function. + + + + + Represents the FDIST function. + + + + + Represents the FIND function. + + + + + Represents the FINDB function. + + + + + Represents the FINV function. + + + + + Represents the FISHER function. + + + + + Represents the FISHERINV function. + + + + + Represents the FIXED function. + + + + + Represents the FLOOR function. + + + + + Represents the FORECAST function. + + + + + Represents the FREQUENCY function. + + + + + Represents the FTEST function. + + + + + Represents the FV function. + + + + + Represents the GAMMADIST function. + + + + + Represents the GAMMAINV function. + + + + + Represents the GAMMALN function. + + + + + Represents the GEOMEAN function. + + + + + Represents the GETPIVOTDATA function. + + + + + Represents the GROWTH function. + + + + + Represents the HARMEAN function. + + + + + Represents the HLOOKUP function. + + + + + Represents the HOUR function. + + + + + Represents the HYPERLINK function. + + + + + Represents the HYPGEOMDIST function. + + + + + Represents the IF function. + + + + + Represents the INDEX function. + + + + + Represents the INDIRECT function. + + + + + Represents the INFO function. + + + + + Represents the INT function. + + + + + Represents the INTERCEPT function. + + + + + Represents the IPMT function. + + + + + Represents the IRR function. + + + + + Represents the ISBLANK function. + + + + + Represents the ISERR function. + + + + + Represents the ISERROR function. + + + + + Represents the ISLOGICAL function. + + + + + Represents the ISNA function. + + + + + Represents the ISNONTEXT function. + + + + + Represents the ISNUMBER function. + + + + + Represents the ISPMT function. + + + + + Represents the ISREF function. + + + + + Represents the ISTEXT function. + + + + + Represents the KURT function. + + + + + Represents the LARGE function. + + + + + Represents the LEFT function. + + + + + Represents the LEFTB function. + + + + + Represents the LEN function. + + + + + LENB function. + + + + + Represents the LINEST function. + + + + + Represents the LN function. + + + + + Represents the LOG function. + + + + + Represents the LOG10 function. + + + + + Represents the LOGEST function. + + + + + Represents the LOGINV function. + + + + + Represents the LOGNORMDIST function. + + + + + Represents the LOOKUP function. + + + + + Represents the LOWER function. + + + + + Represents the MATCH function. + + + + + Represents the MAX function. + + + + + Represents the MAXA function. + + + + + Represents the MDETERM function. + + + + + Represents the MEDIAN function. + + + + + Represents the MID function. + + + + + Represents the MIDB function. + + + + + Represents the MIN function. + + + + + Represents the MINA function. + + + + + Represents the MINUTE function. + + + + + Represents the MINVERSE function. + + + + + Represents the MIRR function. + + + + + Represents the MMULT function. + + + + + Represents the MOD function. + + + + + Represents the MODE function. + + + + + Represents the MONTH function. + + + + + Represents the N function. + + + + + Represents the NA function. + + + + + Represents the NEGBINOMDIST function. + + + + + Represents the NORMDIST function. + + + + + Represents the NORMINV function. + + + + + Represents the NORMSDIST function. + + + + + Represents the NORMSINV function. + + + + + Represents the NOT function. + + + + + Represents the NOW function. + + + + + Represents the NPER function. + + + + + Represents the NPV function. + + + + + Represents the ODD function. + + + + + Represents the OFFSET function. + + + + + Represents the OR function. + + + + + Represents the PEARSON function. + + + + + Represents the PERCENTILE function. + + + + + Represents the PERCENTRANK function. + + + + + Represents the PERMUT function. + + + + + Represents the PI function. + + + + + Represents the PMT function. + + + + + Represents the POISSON function. + + + + + Represents the POWER function. + + + + + Represents the PPMT function. + + + + + Represents the PROB function. + + + + + Represents the PRODUCT function. + + + + + Represents the PROPER function. + + + + + Represents the PV function. + + + + + Represents the QUARTILE function. + + + + + Represents the RADIANS function. + + + + + Represents the RAND function. + + + + + Represents the RANK function. + + + + + Represents the RATE function. + + + + + Represents the REPLACE function. + + + + + Represents the REPLACEB function. + + + + + Represents the RIGHT function. + + + + + Represents the RIGHTB function. + + + + + Represents the ROMAN function. + + + + + Represents the ROUND function. + + + + + Represents the ROUNDDOWN function. + + + + + Represents the ROUNDUP function. + + + + + Represents the ROW function. + + + + + Represents the ROWS function. + + + + + Represents the RSQ function. + + + + + Represents the SEARCH function. + + + + + Represents the SEARCHB function. + + + + + Represents the SECOND function. + + + + + Represents the SIGN function. + + + + + Represents the SIN function. + + + + + Represents the SINH function. + + + + + Represents the SKEW function. + + + + + Represents the SLN function. + + + + + Represents the SLOPE function. + + + + + Represents the SMALL function. + + + + + Represents the SQRT function. + + + + + Represents the STANDARDIZE function. + + + + + Represents the STDEV function. + + + + + Represents the STDEVA function. + + + + + Represents the STDEVP function. + + + + + Represents the STDEVPA function. + + + + + Represents the STEYX function. + + + + + Represents the SUBSTITUTE function. + + + + + Represents the SUBTOTAL function. + + + + + Represents the SUM function. + + + + + Represents the SUMIF function. + + + + + Represents the SUMPRODUCT function. + + + + + Represents the SUMSQ function. + + + + + Represents the SUMX2MY2 function. + + + + + Represents the SUMX2PY2 function. + + + + + Represents the SUMXMY2 function. + + + + + Represents the SYD function. + + + + + Represents the T function. + + + + + Represents the TAN function. + + + + + Represents the TANH function. + + + + + Represents the TDIST function. + + + + + Represents the TEXT function. + + + + + Represents the TIME function. + + + + + Represents the TIMEVALUE function. + + + + + Represents the TINV function. + + + + + Represents the TODAY function. + + + + + Represents the TRANSPOSE function. + + + + + Represents the TREND function. + + + + + Represents the TRIM function. + + + + + Represents the TRIMMEAN function. + + + + + Represents the TRUE function. + + + + + Represents the TRUNC function. + + + + + Represents the TTEST function. + + + + + Represents the TYPE function. + + + + + Represents the UPPER function. + + + + + Represents the VALUE function. + + + + + Represents the VAR function. + + + + + Represents the VARA function. + + + + + Represents the VARP function. + + + + + Represents the VARPA function. + + + + + Represents the VDB function. + + + + + Represents the VLOOKUP function. + + + + + Represents the WEEKDAY function. + + + + + Represents the WEIBULL function. + + + + + Represents the YEAR function. + + + + + Represents the ZTEST function. + + + + + Represents the ABSREF function. + + + + + Represents the ACTIVECELL function. + + + + + Represents the ADDBAR function. + + + + + Represents the ADDCOMMAND function. + + + + + Represents the ADDMENU function. + + + + + Represents the ADDTOOLBAR function. + + + + + Represents the APPTITLE function. + + + + + Represents the ARGUMENT function. + + + + + Represents the ASC function. + + + + + Represents the CALL function. + + + + + Represents the CALLER function. + + + + + Represents the CANCELKEY function. + + + + + Represents the CHECKCOMMAND function. + + + + + Represents the CREATEOBJECT function. + + + + + Represents the CUSTOMREPEAT function. + + + + + Represents the CUSTOMUNDO function. + + + + + Represents the DATEDIF function. + + + + + Represents the DATESTRING function. + + + + + Represents the DBCS function. + + + + + Represents the DELETEBAR function. + + + + + Represents the DELETECOMMAND function. + + + + + Represents the DELETEMENU function. + + + + + Represents the DELETETOOLBAR function. + + + + + Represents the DEREF function. + + + + + Represents the DGET function. + + + + + Represents the DIALOGBOX function. + + + + + Represents the DIRECTORY function. + + + + + Represents the DOCUMENTS function. + + + + + Represents the ECHO function. + + + + + Represents the ENABLECOMMAND function. + + + + + Represents the ENABLETOOL function. + + + + + Represents the EVALUATE function. + + + + + Represents the EXEC function. + + + + + Represents the EXECUTE function. + + + + + Represents the FILES function. + + + + + Represents the FOPEN function. + + + + + Represents the FORMULACONVERT function. + + + + + Represents the FPOS function. + + + + + Represents the FREAD function. + + + + + Represents the FREADLN function. + + + + + Represents the FSIZE function. + + + + + Represents the FWRITE function. + + + + + Represents the FWRITELN function. + + + + + Represents the FCLOSE function. + + + + + Represents the GETBAR function. + + + + + Represents the GETCELL function. + + + + + Represents the GETCHARTITEM function. + + + + + Represents the GETDEF function. + + + + + Represents the GETDOCUMENT function. + + + + + Represents the GETFORMULA function. + + + + + Represents the GETLINKINFO function. + + + + + Represents the GETMOVIE function. + + + + + Represents the GETNAME function. + + + + + Represents the GETNOTE function. + + + + + Represents the GETOBJECT function. + + + + + Represents the GETPIVOTFIELD function. + + + + + Represents the GETPIVOTITEM function. + + + + + Represents the GETPIVOTTABLE function. + + + + + Represents the GETTOOL function. + + + + + Represents the GETTOOLBAR function. + + + + + Represents the GETWINDOW function. + + + + + Represents the GETWORKBOOK function. + + + + + Represents the GETWORKSPACE function. + + + + + Represents the GOTO function. + + + + + Represents the GROUP function. + + + + + Represents the HALT function. + + + + + Represents the HELP function. + + + + + Represents the INITIATE function. + + + + + Represents the INPUT function. + + + + + Represents the LASTERROR function. + + + + + Represents the LINKS function. + + + + + Represents the MOVIECOMMAND function. + + + + + Represents the NAMES function. + + + + + Represents the NOTE function. + + + + + Represents the NUMBERSTRING function. + + + + + Represents the OPENDIALOG function. + + + + + Represents the OPTIONSLISTSGET function. + + + + + Represents the PAUSE function. + + + + + Represents the PIVOTADDDATA function. + + + + + Represents the POKE function. + + + + + Represents the PRESSTOOL function. + + + + + Represents the REFTEXT function. + + + + + Represents the REGISTER function. + + + + + Represents the REGISTERID function. + + + + + Represents the RELREF function. + + + + + Represents the RENAMECOMMAND function. + + + + + Represents the REPT function. + + + + + Represents the REQUEST function. + + + + + Represents the RESETTOOLBAR function. + + + + + Represents the RESTART function. + + + + + Represents the RESULT function. + + + + + Represents the RESUME function. + + + + + Represents the SAVEDIALOG function. + + + + + Represents the SAVETOOLBAR function. + + + + + Represents the SCENARIOGET function. + + + + + Represents the SELECTION function. + + + + + Represents the SERIES function. + + + + + Represents the SETNAME function. + + + + + Represents the SETVALUE function. + + + + + Represents the SHOWBAR function. + + + + + Represents the SPELLINGCHECK function. + + + + + Represents the STEP function. + + + + + Represents the TERMINATE function. + + + + + Represents the TEXTBOX function. + + + + + Represents the TEXTREF function. + + + + + Represents the UNREGISTER function. + + + + + Represents the USDOLLAR function. + + + + + Represents the VOLATIL function. + + + + + Represents the WINDOWS function. + + + + + Represents the WINDOWTITLE function. + + + + + Defines the view setting of the sheet. + + + + + Normal view + + + + + Page break preview + + + + + Page Layout View + + + + + Specifies the possible colors in Excel. + + + + + Black color. + + + + + White color. + + + + + Red color. + + + + + LightGreen color. + + + + + Blue color. + + + + + Yellow color. + + + + + Magenta color. + + + + + Cyan color. + + + + + Aqua color. + + + + + BlackCustom color. + + + + + BlueCustom color. + + + + + Blue_grey color. + + + + + Bright_green color. + + + + + Brown color. + + + + + Dark_blue color. + + + + + Dark_green color. + + + + + Dark_red color. + + + + + Dark_teal color. + + + + + Dark_yellow color. + + + + + Gold color. + + + + + Green color. + + + + + Grey_25_percent color. + + + + + Grey_40_percent color. + + + + + Grey_50_percent color. + + + + + Grey_80_percent color. + + + + + Indigo color. + + + + + Lavender color. + + + + + Light_blue color. + + + + + Light_green color. + + + + + Light_orange color. + + + + + Light_turquoise color. + + + + + Light_yellow color. + + + + + Lime color. + + + + + Olive_green color. + + + + + Orange color. + + + + + Pale_blue color. + + + + + Pink color. + + + + + Plum color. + + + + + Red2 color. + + + + + Rose color. + + + + + Sea_green color. + + + + + Sky_blue color. + + + + + Tan color. + + + + + Teal color. + + + + + Turquoise color. + + + + + Violet color. + + + + + WhiteCustom color. + + + + + YellowCustom color. + + + + + Custom0. + + + + + Custom1. + + + + + Custom2. + + + + + Custom3. + + + + + Custom4. + + + + + Custom5. + + + + + Custom6. + + + + + Custom7. + + + + + Custom8. + + + + + Custom9. + + + + + Custom10. + + + + + Custom11. + + + + + Custom12. + + + + + Custom13. + + + + + Custom14. + + + + + Custom15. + + + + + Custom16. + + + + + Custom17. + + + + + Custom18. + + + + + Custom19. + + + + + Custom20. + + + + + Custom21. + + + + + Custom22. + + + + + Custom23. + + + + + Custom24. + + + + + Custom25. + + + + + Custom26. + + + + + Custom27. + + + + + Custom28. + + + + + Custom29. + + + + + Custom30. + + + + + Custom31. + + + + + Custom32. + + + + + Custom33. + + + + + Custom34. + + + + + Custom35. + + + + + Custom36. + + + + + Custom37. + + + + + Custom38. + + + + + Custom39. + + + + + Custom40. + + + + + Custom41. + + + + + Custom42. + + + + + Custom43. + + + + + Custom44. + + + + + Custom45. + + + + + Custom46. + + + + + Custom47. + + + + + Custom48. + + + + + Custom49. + + + + + Custom50. + + + + + Custom51. + + + + + Custom52. + + + + + Custom53. + + + + + Custom54. + + + + + Custom55. + + + + + Custom56. + + + + + No color. + + + + + Specifies the Group types in Excel. + + + + + Grouping by Rows. + + + + + Grouping by columns. + + + + + Enumeration of Patterns available in Excel. + + + + + No pattern. + + + + + Represents the Solid pattern. + + + + + Represents the Percent50 pattern. + + + + + Represents the Percent70 pattern. + + + + + Represents the Percent25 pattern. + + + + + Represents the DarkHorizontal pattern. + + + + + Represents the DarkVertical pattern. + + + + + Represents the DarkDownwardDiagonal pattern. + + + + + Represents the DarkUpwardDiagonal pattern. + + + + + Represents the ForwardDiagonal pattern. + + + + + Represents the Percent75 pattern. + + + + + Represents the Horizontal pattern. + + + + + Represents the Vertical pattern. + + + + + Represents the LightDownwardDiagonal pattern. + + + + + Represents the LightUpwardDiagonal pattern. + + + + + Represents the Angle pattern. + + + + + Represents the Percent60 pattern. + + + + + Represents the Percent10 pattern. + + + + + Represents the Percent05 pattern. + + + + + Represents the Percent50Gray pattern. + + + + + Represents the Percent75Gray pattern. + + + + + Represents the Percent25Gray pattern. + + + + + Represents the HorizontalStripe pattern. + + + + + Represents the VerticalStripe pattern. + + + + + Represents the ReverseDiagonalStripe pattern. + + + + + Represents the DiagonalStripe pattern. + + + + + Represents the DiagonalCrosshatch pattern. + + + + + Represents the ThickDiagonalCrosshatch pattern. + + + + + Represents the ThinHorizontalStripe pattern. + + + + + Represents the ThinVerticalStripe pattern. + + + + + Represents the ThinReverseDeagonalStripe pattern. + + + + + Represents the ThinDiagonalStripe pattern. + + + + + Represents the ThinHorizontalCrosshatch pattern. + + + + + Represents the ThinDiagonalCrosshatch pattern. + + + + + Represents the Percent125Gray pattern. + + + + + Represents the Percent625Gray pattern. + + + + + Represent Gradient pattern. + + + + + This enumeration used for controlling output stream infill on + save operation provided by Workbook. + + + + + Do not skip any information from source file. + + + + + Skip macros extension records in output stream. + + + + + Skip drawings extension records in output stream. + + + + + Skip summary information substreams creation. + + + + + Skip coping of substreams from source to destination files. + + + + + Skip all extended records. + + + + + Enumeration which controls visibility of worksheet in Excel. + + + + + Worksheet is visible to the user. + + + + + Worksheet is hidden for the user. + + + + + The strong hidden flag can only be set and cleared with a Visual Basic + macro. It is not possible to make such a sheet visible via the user interface. + + + + + Enumeration of the Save types in Excel. + + + + + Save the workbook into .xls or .xlsx format based on the workbook version. + When the workbook version is Excel2007 and above, it uses .xlsx format. otherwise .xls format. + + + + + Save the workbook into .xlt or .xltx format based on the workbook version. + When the workbook version is Excel2007 and above, it uses .xltx format. otherwise .xlt format. + + + + + Save the workbook into open document spreadsheet(.ods) format.Difference between ODS and XLSX format. + + + + + Save the workbook into a macro-enabled file (.xls or .xlsm). + + + + + Save the workbook into a macro-enabled template file (.xltm). + + + + + Save the workbook into .xlsb format. + + + + + Specifies the chart types. + + + + + Represents the clustered column chart. + + + + + Represents the stacked column chart. + + + + + Represents the 100% stacked column chart. + + + + + Represents the 3D clustered column chart. + + + + + Represents the 3D stacked column chart. + + + + + Represents the 3D 100% stacked column chart. + + + + + Represents the 3D column chart. + + + + + Represents the clustered bar chart. + + + + + Represents the stacked bar chart. + + + + + Represents the 100% stacked bar chart. + + + + + Represents the 3D clustered bar chart. + + + + + Represents the 3D stacked bar chart. + + + + + Represents the 3D 100% stacked bar chart. + + + + + Represents the line chart. + + + + + Represents the stacked line chart. + + + + + Represents the 100% stacked line chart. + + + + + Represents the line chart with markers. + + + + + Represents the stacked line chart with markers. + + + + + Represents the 100% stacked line chart with markers. + + + + + Represents the 3D line chart. + + + + + Represents the pie chart. + + + + + Represents the 3D pie chart. + + + + + Represents the pie of pie chart. + + + + + Represents the exploded pie chart. + + + + + Represents the exploded 3D pie chart. + + + + + Represents the bar of pie chart. + + + + + Represents the scatter chart with markers. + + + + + Represents the smooth lined scatter chart with markers. + + + + + Represents the smooth lined scatter chart. + + + + + Represents the scatter chart with lines and markers. + + + + + Represents the scatter chart with lines. + + + + + Represents the area chart. + + + + + Represents the stacked area chart. + + + + + Represents the 100% stacked area chart. + + + + + Represents the 3D area chart. + + + + + Represents the 3D stacked area chart. + + + + + Represents the 3D 100% stacked area chart. + + + + + Represents the doughnut chart. + + + + + Represents the exploded doughnut chart. + + + + + Represents the radar chart. + + + + + Represents the radar chart with markers. + + + + + Represents the filled radar chart. + + + + + Represents the 3D surface chart. + + + + + Represents the 3D surface chart with no color. + + + + + Represents the surface chart with contour. + + + + + Represents the surface chart with contour and no color. + + + + + Represents the bubble chart. + + + + + Represents the 3D bubble chart. + + + + + Represents the stock chart with high, low and close values. + + + + + Represents the stock chart with open, high, low and close values. + + + + + Represents the stock chart with volume, high, low and close values. + + + + + Represents the stock chart with volume, open, high, low and close values. + + + + + Represents the clustered cylinder chart. + + + + + Represents the stacked cylinder chart. + + + + + Represents the 100% stacked cylinder chart. + + + + + Represents the clustered cylinder bar chart. + + + + + Represents the stacked cylinder bar chart. + + + + + Represents the 100% stacked cylinder bar chart. + + + + + Represents the 3D clustered cylinder chart. + + + + + Represents the clustered cone chart. + + + + + Represents the stacked cone chart. + + + + + Represents the 100% stacked cone chart. + + + + + Represents the clustered cone bar chart. + + + + + Represents the stacked cone bar chart. + + + + + Represents the 100% stacked cone bar chart. + + + + + Represents the 3D clustered cone chart. + + + + + Represents the clustered pyramid chart. + + + + + Represents the stacked pyramid chart. + + + + + Represents the 100% stacked pyramid chart. + + + + + Represents the clustered pyramid bar chart. + + + + + Represents the stacked pyramid bar chart. + + + + + Represents the 100% stacked pyramid bar chart. + + + + + Represents the 3D clustered pyramid chart. + + + + + Represents the chart that contain different series types. + + + + + Represents the Excel 2016 Funnel Chart + + + + + Represents the Excel 2016 Water Fall Chart + + + + + Represents the Excel 2016 Box and Whisker Chart + + + + + Represents the Excel 2016 Histogram Chart + + + + + Represents the Excel 2016 Pareto Chart + + + + + Represents the Excel 2016 Tree Map Chart + + + + + Represents the Excel 2016 Sun Burst Chart + + + + + Specifies the position of the legend on a chart. + + + + + Represents the bottom of the chart. + + + + + Represents the upper right-hand corner of the chart border. + + + + + Represents the top of the chart. + + + + + Represents the right of the chart. + + + + + Represents the left of the chart. + + + + + Represents the NotDocked option. + + + + + Enumeration of the print size of charts in Excel. + + + + + Represents the Custom option. + + + + + Represents the ScaleToFit page option. + + + + + Represents the Use Full Page option. + + + + + Specifies how blank cells are plotted on a chart. + + + + + Blank cells are not plotted. + + + + + Blanks are plotted as zero. + + + + + Values are interpolated into the chart. + + + + + Enumeration of the axes used for Charts in Excel. + + + + + Represents the Primary axis option. + + + + + Represents the Primary and Secondary axis option. + + + + + Enumeration of the background mode for Charts in Excel. + + + + + Represents the Transparent option. + + + + + Represents the Opaque option. + + + + + Enumeration of the horizontal alignment options for Charts in Excel. + + + + + Represents the Left alignment option for the horizontal alignment setting for Chart. + + + + + Represents the Center alignment option for the horizontal alignment setting for Chart. + + + + + Represents the Right alignment option for the horizontal alignment setting for Chart. + + + + + Represents the Justify alignment option for the horizontal alignment setting for Chart. + + + + + Enumeration of the vertical alignment options for Charts in Excel. + + + + + Represents the Top alignment option for the Vertical alignment setting for Chart. + + + + + Represents the Center alignment option for the Vertical alignment setting for Chart. + + + + + Represents the Bottom alignment option for the Vertical alignment setting for Chart. + + + + + Represents the Justify alignment option for the Vertical alignment setting for Chart. + + + + + Enumeration of the Border Pattern setting for Chart formatting in Excel. + + + + + Represents the Automatic option for the Border Pattern setting. + + + + + Represents the None option for the Border Pattern setting. + + + + + Represents the Custom option for the Border Pattern setting. + + + + + Specifies the line pattern for the border. + + + + + Solid line. + + + + + Dashed line. + + + + + Dotted line. + + + + + Alternating dashes and dots. + + + + + Dash followed by two dots. + + + + + No line. + + + + + Dark gray line. + + + + + Medium Gray line. + + + + + Light gray line. + + + + + Round dotted line. + + + + + Long dashed line. + + + + + Long alternating dashes and dots. + + + + + Long dash followed by two dots. + + + + + Represents allowed line weight values for charts in Excel. + + + + + Represents hairline (thinnest border). + + + + + Represents narrow border. + + + + + Represents medium border. + + + + + Represents wide border. + + + + + Specifies the marker style for a point or series in a line chart, scatter chart, or radar chart. + + + + + No markers. + + + + + Square markers. + + + + + Diamond-shaped markers. + + + + + Triangular markers. + + + + + Square markers with an X. + + + + + Square markers with an asterisk. + + + + + Represents the Dow Jones style in the custom marker option for Chart lines. + + + + + Represents the Standard Deviation style in the custom marker option for Chart lines. + + + + + Circular markers. + + + + + Square markers with a plus sign. + + + + + Specifies the axis types for charts in Excel. + + + + + Axis displays categories. + + + + + Axis displays values. + + + + + Axis displays data series. + + + + + Represents a possible insert options in Excel. + + + + + Indicates that after insert operation inserted rows/columns + must be formatted as row above or column left. + + + + + Indicates that after insert operation inserted rows/columns + must be formatted as row below or column right. + + + + + Indicates that after insert operation inserted rows/columns + must have default format. + + + + + Specifies whether the conditional format is based on a cell value or an expression. + + + + + Represents the Cell Value option for conditional formatting. + + + + + Represents the Formula option for conditional formatting. + + + + + Represents the ColorScale option for conditional formatting. + + + + + Represents the DataBar option for conditional formatting. + + + + + Represents the IconSet option for conditional formatting. + + + + + Represents conditional formatting rule highlights cells that are completely blank. + + + + + Represents conditional formatting rule highlights cells that are not blank. + + + + + Represents the Specific Text conditional formatting rule based on the text. + + + + + Represents conditional formatting rule highlights cells that contains errors. + + + + + Represents conditional formatting rule highlights cells that does not contains errors. + + + + + Represents Time Period conditional formatting rule highlights cells that has date time. + + + + + Represents conditional formatting rule to highlight the cells with duplicate values. + + + + + Represents conditional formatting rule to highlight the cells with unique values. + + + + + Represents conditional formatting rule to highlight the top 10 or bottom 10 cells with the values. + + + + + Represents conditional formatting rule to highlight the cells that contain values above or below the range average. + + + + + Specifies the comparison operator for conditional formatting in Excel. + + + + + No comparison. + + + + + Between. + + + + + Not between. + + + + + Equal. + + + + + Not equal. + + + + + Greater than. + + + + + Less than. + + + + + Greater than. + + + + + Less than or equal. + + + + + Begins-with comparison option for Specific Text. + + + + + Contains text comparison option for Specific Text. + + + + + Ends-with comparison option for Specific Text. + + + + + Not contains text option for Specific Text. + + + + + Specifies the time periods for date time conditional formatting in Excel. + + + + + Today. + + + + + Yesterday. + + + + + Tomorrow. + + + + + Last seven days. + + + + + This month. + + + + + Last month. + + + + + Next month. + + + + + This week. + + + + + Last week. + + + + + Next week. + + + + + Specifies the comparison operators for data validation. + + + + + Between. + + + Should provide both and value. + + + + + Not between. + + + Should provide both and value. + + + + + Equal. + + + + + NotEqual. + + + + + Greater than. + + + + + Less than. + + + + + Greater than or equal to. + + + + + Less than or equal to. + + + + + Specifies the type of validation test to be performed in conjunction with values. + + + + + Represents Any data type. + + + + + Represents Integer data type. + + + + + Represents Decimal data type. + + + + + Represents User data type. + + + + + Represents Date data type. + + + + + Represents Time data type. + + + + + Represents TextLength data type. + + + + + Represents Formula data type. + + + + + Represents Excel Parameter Data Type + + + + + Represents Unicode character string. + + + + + Represents Bit. + + + + + Represents Tiny integer. + + + + + Represents Big integer. + + + + + Represents Long binary. + + + + + Represents Variable-length binary. + + + + + Represents Binary. + + + + + Represents Long string. + + + + + Represents Type unknown. + + + + + Represents String. + + + + + Represents Numeric. + + + + + Represents Decimal. + + + + + Represents Integer. + + + + + Represents Small integer. + + + + + Represents Float. + + + + + Represents Real. + + + + + Represents Double. + + + + + Represents Date. + + + + + Represents Time. + + + + + Represents Time stamp. + + + + + Represents Variable-length string. + + + + + Represents Excel Parameter Type + + + + + Displays a dialog box that prompts the user for the value. + + + + + Uses the value specified by the Value argument. + + + + + Uses the value of the cell in the upper-left corner of the range. + + + + + Possible error style values: + + + + + Stop icon is displayed. + + + + + Warning icon is displayed. + + + + + Information icon is displayed. + + + + + Specifies the possible directions to shift cells after clearing a range. + + + + + MoveLeft direction. + + + + + MoveUp direction. + + + + + No direction. + + + + + Enumeration of shapes available in Excel. + + + + + Represents the AutoShape shape type. + + + + + Represents the Callout shape type. + + + + + Represents the Canvas shape type. + + + + + Represents the Chart shape type. + + + + + Represents the Comment shape type. + + + + + Represents the Diagram shape type. + + + + + Represents the EmbeddedOLEObject shape type. + + + + + Represents the FormControl shape type. + + + + + Represents the Freeform shape type. + + + + + Represents the Group shape type. + + + + + Represents the Line shape type. + + + + + Represents the LinkedOLEObject shape type. + + + + + Represents the LinkedPicture shape type. + + + + + Cannot be used with this property. This constant is used with shapes + in other Microsoft Office applications. + + + + + Represents the OLEControlObject shape type. + + + + + Represents the Picture shape type. + + + + + Cannot be used with this property. This constant is used with shapes + in other Microsoft Office applications. + + + + + Represents the ScriptAnchor shape type. + + + + + Represents the ShapeTypeMixed shape type. + + + + + Represents the Table shape type. + + + + + Represents the TextBox shape type. + + + + + Represents the TextEffect shape type. + + + + + Represents the Unknown shape type. + + + + + Represents the Check box type. + + + + + Enumeration to specify the possible Text Rotation options. + + + + + Represents the LeftToRight text rotation. + + + + + Represents the TopToBottom text rotation. + + + + + Represents the CounterClockwise text rotation. + + + + + Represents the Clockwise text rotation. + + + + + Enumeration to align the excel comment Horizontally. + + + + + Represents the Left comment align. + + + + + Represents the Center comment align. + + + + + Represents the Right comment align. + + + + + Represents the Justified comment align. + + + + + Represents the Justified comment align. + + + + + Represents the Distributed comment align. + + + + + Enumeration to align the excel comment vertically + + + + + Represents the Top comment align. + + + + + Represents the Center comment align. + + + + + Represents the Bottom comment align. + + + + + Represents the Justified comment align. + + + + + Represents the Distributed comment align. + + + + + Enumeration to specify if the spreadsheet should be opened inside browser or saved + as an attachment to disk. + + + + + File should be opened in browser. + + + + + Prompt dialog should be displayed. + + + + + HttpContent type. + + + + + Excel97 HttpContent type. + + + + + Excel2000 HttpContent type. + + + + + Excel2007 HttpContent type. + + + + + Excel2010 HttpContent type. + + + + + Excel2013 HttpContent type. + + + + + Excel2016 HttpContent type. + + + + + Excel2019 and above versions HttpContent type. + + + + + CSV HttpContent type. + + + + + ODS HttpContent type. + + + + + Enumeration to specify the style merge options. + + + + + Represents the Leave style merge option. + + + + + Represents the Replace style merge option. + + + + + Represents the CreateDiffName style merge option. + + + + + Enumeration to specify Names Merge options. + + + + + Represents the Leave names merge option. + + + + + Represents the Replace names merge option. + + + + + Represents the Rename names merge option. + + + + + Represents the MakeLocal names merge option. + + + + + Enumeration to specify options when copying worksheets. + + + + + No flags. + + + + + Represents the ClearBefore copy flags. + + + + + Represents the CopyNames copy flags. + + + + + Represents the CopyCells copy flags. + + + + + Represents the CopyRowHeight copy flags. + + + + + Represents the CopyColumnHeight copy flags. + + + + + Represents the CopyOptions copy flags. + + + + + Represents the CopyMerges copy flags. + + + + + Represents the CopyShapes copy flags. + + + + + Represents the CopyConditionlFormats copy flags. + + + + + Represents the CopyAutoFilters copy flags. + + + + + Represents the CopyDataValidations copy flags. + + + + + Copy page setup (page breaks, paper orientation, header, footer and other properties). + + + + + Copy table objects. + + + + + Copy pivot table objects. + + + + + Copies palette. + + + + + Represents the CopyAll copy flags, except palette. + + + + + Represents the CopyWithoutNames copy flags. + + + + + Enumeration to specify the options to update formulas and merged ranges during copy range + operation. + + + + + No flags. + + + + + Indicates whether update formula during copy. WARNING: you should always + specify this flag if your operations could change position of Array formula. + + + + + Indicates whether update merges during copy. + + + + + Indicates that we have to copy styles during range copy. + + + + + Indicates that we have to copy shapes during range copy. + + + + + Indicates that we have to copy error indicators during range copy. + + + + + Indicates that we have to copy conditional formats during range copy. + + + + + Indicates that we have to copy data validations during range copy. + + + + + All flags. + + + + + Indicates that we have to copy value with formats during range copy. + + + + + Enumeration to specify the options of excel formula + + + + + No flags. + + + + + Represents the RootLevel formula parse option. + + + + + Represents the InArray formula parse option. + + + + + Represents the InName formula parse option. + + + + + Operand in function. + + + + + Operand is complex. + + + + + Indicates that R1C1 notation must be used. + + + + + Enumeration to specify an excel cell type. + + + + + Cells of any format. + + + + + Cells having validation criteria. + + + + + Empty cells. + + + + + Cells containing notes. + + + + + Cells containing constants. + + + + + Cells containing formulas. + + + + + The last cell in the used range. + + + + + Cells having the same format. + + + + + Cells having the same validation criteria. + + + + + All visible cells. + + + + + Data type for autofilters. + + + + + Represents the filter data type. + + + + + Represents the FloatingPoint filter data type. + + + + + Represents the String filter data type. + + + + + Represents the Boolean filter data type. + + + + + Represents the ErrorCode filter data type. + + + + + Represents the MatchAllBlanks filter data type. + + + + + Represents the MatchAllNonBlanks filter data type. + + + + + Possible conditions in autofilter. + + + + + Represents the Less filter condition type. + + + + + Represents the Equal filter condition type. + + + + + Represents the LessOrEqual filter condition type. + + + + + Represents the Greater filter condition type. + + + + + Represents the NotEqual filter condition type. + + + + + Represents the GreaterOrEqual filter condition type. + + + + + Represents the Contains filter condition type. + + + + + Represents the DoesNotContain filter condition type. + + + + + Represents the BeginsWith filter condition type. + + + + + Represents the DoesNotBeginWith filter condition type. + + + + + Represents the EndsWith filter condition type. + + + + + Represents the DoesNotEndWith filter condition type. + + + + + Parsing options. + + + + + Represents the Default parse option. + + + + + Represents the SkipStyles parse option + + + + + Represents the DoNotParseCharts parse option + + + + + This is special mode. In this mode user can't modify strings or add new strings + (numbers and other types are ok), but it gives more speed and less memory usage. + + + + + Preserves the Pivot table. + + + + + Parses the sheet when accessed. + + + + + Specifies the possible ExportDataTable options. + + + + + No datatable. + + + + + Indicates that the first row of the range will be considered as a column name of the datatable. + + + + + Indicates that the formula values are computed and exported to the datatable. + + + + + Indicates that XlsIO should try to detect column types. + + + + + When DetectColumnTypes is set and this flag is set too, it means that + default column style must be used to detect style, if this flag is not set, + but DetectColumnTypes is set, then first cell in the column will be used + to detect column type. + + + + + Indicates whether to preserve Ole date (double numbers) instead of date-time values. + + + + + Indicates that the hidden columns can be exported to the datatable. + + + + + Indicates that the hidden rows can be exported to the datatable. + + + + + Indicates that XlsIO should try to detect different types in single column + + + + + Indicates that the leading and trailing spaces from column names should be removed + + + + + Excel rectangle style. Used in chart frames. + + + + + Represents the Regular rectangle style. + + + + + Represents the Shadowed rectangle style. + + + + + The order in which page fields are added to the PivotTable report's layout. + + + + + Represents the DownThenOver pages order. + + + + + Represents the OverThenDown pages order. + + + + + Possible types of hyperlinks. + + + + + No hyperlink. + + + + + Represents the Url hyperlink type. + + + + + Represents the File hyperlink type. + + + + + Represents the Unc hyperlink type. + + + + + Represents the Workbook hyperlink type. + + + + + Data source type. + + + + + Represents the Worksheet data source type. + + + + + Represents the ExternalData data source type. + + + + + Represents the Consolidation data source type. + + + + + Represents the ScenarioPivotTable data source type. + + + + + Specifies the type of data to search. + + + + + Searches text. + + + + + Searches formulas. + + + + + Searches formula string values. + + + + + Searches errors. + + + + + Searches numeric values. + + + + + Searches numenric formula values. + + + + + Searches calculated values, number and text. + + + + + Searches text in comments. + + + + + Specifies the possible type of finding options. + + + + + None of the option is selected. + + + + + Match the case while finding the value. + + + + + Match the entire cell content to search word while finding the value. + + + + + Possible types of direction order. + + + + + Represents the Context reading order type. + + + + + Represents the LeftToRight reading order type. + + + + + Represents the RightToLeft reading order type. + + + + + Possible image formats. + + + + + Try to keep original picture format. + + + + + Use PNG picture format. + + + + + Use JPG picture format. + + + + + Represents the MeasureUnits types. + + + + + Specifies 1/75 inch as the unit of measure. + + + + + Specifies the document unit (1/300 inch) as the unit of measure. + + + + + Specifies the inch as the unit of measure. + + + + + Specifies the millimeter as the unit of measure. + + + + + Specifies the centimeter as the unit of measure. + + + + + Specifies a device pixel as the unit of measure. + + + + + Specifies a printer's point (1/72 inch) as the unit of measure. + + + + + 12700 emu's = 1 point. + + + + + Specifies what the bubble size represents on a bubble chart. + + + + + Represents the area of the bubble. + + + + + Represents the width of the bubble. + + + + + Enumeration limits values which can be set by user. + + + + + Represents the Normal pie type. + + + + + Represents the Pie pie type. + + + + + Represents the Bar pie type. + + + + + Specifies the values displayed in the second chart in a pie chart or a bar of pie chart. + + + + + The second chart displays the smallest values in the data series. + The number of values to display is specified by the property. + + + + + The second chart displays values less than the value specified by the property. + + + + + The second chart displays values less than a percentage of the total value. + The percentage is specified by the property. + + + + + The second chart displays arbitrary slides. + + + + + Represents the drop line style type. + + + + + Represents the Drop line style. + + + + + Represents the HiLow drop line style. + + + + + Represents the Series drop line style. + + + + + Represents the ExcelLegendSpacing options. + + + + + Represents the Close ExcelLegendSpacing option. + + + + + Represents the Medium ExcelLegendSpacing option. + + + + + Represents the Open ExcelLegendSpacing option. + + + + + Base format options. + + + + + Represents Rectangle base format. + + + + + Represents Circle base format. + + + + + Top format options. + + + + + Represents Straight top format. + + + + + Represents Sharp top format. + + + + + Represents Trunc top format. + + + + + Object text is linked to. + + + + + Represents the Chart object text type. + + + + + Represents the YAxis object text type. + + + + + Represents the XAxis object text type. + + + + + Represents the DataLabel object text type. + + + + + Represents the ZAxis object text type. + + + + + Represents the DisplayUnit object text type. + + + + + Enumeration which represents axis line identifier. + + + + + The axis line itself. + + + + + Major grid line along the axis. + + + + + Minor grid line along the axis. + + + + + Walls or floor -- walls if parent axis is type 0 or 2; + floor if parent axis is type 1. + + + + + Possible format types. + + + + + Represents unknown format type. + + + + + Represents general number format. + + + + + Represents text number format. + + + + + Represents number number format. + + + + + Represents datetime number format. + + + + + Represents percentage number format. + + + + + Represents currency number format. + + + + + Represents decimal percentage number format. + + + + + Represents Exponential number format. + + + + + Indicates what property will be used for export. + + + + + Represents Boolean property. + + + + + Represents Number property. + + + + + Represents Text property. + + + + + Represents DateTime property. + + + + + Represents TimeSpan property. + + + + + Represents Error property. + + + + + Represents Formula. + + + + + Supported Xml save types. + + + + + Xml format used by MS Excel. + + + + + Xml format used by Syncfusion.DLS. This format is used to export + into Syncfusion.Pdf and Syncfusion.DocIO. + + + + + Property IDs for the SummaryInformation Property Set. + + + + + Title document property Id. + + + + + Subject document property Id. + + + + + Author document property Id. + + + + + Keywords document property Id. + + + + + Comments document property Id. + + + + + Template document property Id. + + + + + LastAuthor document property Id. + + + + + Revnumber document property Id. + + + + + EditTime document property Id. + + + + + LastPrinted document property Id. + + + + + CreationDate document property Id. + + + + + LastSaveDate document property Id. + + + + + PageCount document property Id. + + + + + WordCount document property Id. + + + + + CharCount document property Id. + + + + + Thumbnail document property Id. + + + + + ApplicationName document property Id. + + + + + Security document property Id. + + + + + Category Id. + + + + + Target format for presentation (35mm, printer, video, and so on) id. + + + + + ByteCount Id. + + + + + LineCount Id. + + + + + ParCount Id. + + + + + SlideCount Id. + + + + + NoteCount Id. + + + + + HiddenCount Id. + + + + + MmclipCount Id. + + + + + ScaleCrop property Id. + + + + + HeadingPair Id. + + + + + DocParts Id. + + + + + Manager Id. + + + + + Company Id. + + + + + LinksDirty Id. + + + + + Specifies the possible directions to clear the cell formats, content, comments,conditional format,data validation or clear all of them. + + + + + Clears the formats of the cell. + + + + + Clears the contents of the cell. + + + + + Clears the comments of the cell. + + + + + Clears the comments, content, conditional formats, data validations and formats of the cell. + + + + + Clears all the Conditional Format. + + + + + Clears all data validations. + + + + + Supported Xml open types. + + + + + Xml format used by MS Excel. + + + + + Represents line style. + + + + + Represents single line style. + + + + + Represents thin thin line style. + + + + + Represents thin thick line style. + + + + + Represents thick thin line style. + + + + + Represents thick between thin line style. + + + + + Represents shape dash line style. + + + + + Represents solid style. + + + + + Represents Dotted style. + + + + + Represents Dotted_Strange style. + + + + + Represents Dashed style. + + + + + Represents Medium_dashed style. + + + + + Represents Dash_dot style. + + + + + Represents Medium_dash_dot style. + + + + + Represents Dash_dot_dot style. + + + + + Represents shape arrow style type. + + + + + Represents no arrow. + + + + + Represents standard arrow. + + + + + Represents Stealth arrow. + + + + + Represents Diamond arrow. + + + + + Represents Oval arrow. + + + + + Represents Open arrow. + + + + + Represents arrow head length. + + + + + Represents short arrow head length. + + + + + Represents short arrow head length. + + + + + Represents short arrow head length. + + + + + Represents arrow head width. + + + + + Represents short arrow head width. + + + + + Represents short arrow head width. + + + + + Represents short arrow head width. + + + + + Represents shape arrow width length. + + + + + Represents ArrowNarrowShort type. + + + + + Represents ArrowNarrowMedium type. + + + + + Represents ArrowNarrowLong type. + + + + + Represents ArrowMediumShort type. + + + + + Represents ArrowMediumMedium type. + + + + + Represents ArrowMediumLong type. + + + + + Represents ArrowWideShort type. + + + + + Represents ArrowWideMedium type. + + + + + Represents ArrowWideLong type. + + + + + Represents shape fill type. + + + + + Solid color. + + + + + Represents pattern type. + + + + + Represents texture type. + + + + + Represents picture type. + + + + + Represents unsupport gradient that can be created using Excel 2007, + but not supported correctly by Excel 2003 structures. + + + + + Represents gradient type. + + + + + Represents excel shape shading style. + + + + + Represents horizontal style. + + + + + Represents vertical style. + + + + + Represents diagonal up style. + + + + + Represents diagonal down style. + + + + + Represents from corner style. + + + + + Represents from center style. + + + + + Represents shape shading variants. + + + + + Represents first shading variants. + + + + + Represents second shading variants. + + + + + Represents third shading variants. + + + + + Represents fourth shading variants. + + + + + Represents gradient color type. + + + + + Represents one color gradient style. + + + + + Represents two color gradient style. + + + + + Represents preset gradient style. + + + + + Represents multicolor gradient style. + + + + + Represents gradient texture. + + + + + Represents Newsprint texture type. + + + + + Represents Recycled Paper texture type. + + + + + Represents Parchment texture type. + + + + + Represents Stationery texture type. + + + + + Represents Green Marble texture type. + + + + + Represents White Marble texture type. + + + + + Represents Brown Marble texture type. + + + + + Represents Granite texture type. + + + + + Represents Blue Tissue Paper texture type. + + + + + Represents Pink Tissue Paper texture type. + + + + + Represents Purple Mesh texture type. + + + + + Represents Bouquet texture type. + + + + + Represents Papyrus texture type. + + + + + Represents Canvas texture type. + + + + + Represents Denim texture type. + + + + + Represents Woven Mat texture type. + + + + + Represents Water Droplets texture type. + + + + + Represents Paper Bag texture type. + + + + + Represents Fish Fossil texture type. + + + + + Represents Sand texture type. + + + + + Represents Cork texture type. + + + + + Represents Walnut texture type. + + + + + Represents Oak texture type. + + + + + Represents Medium Wood texture type. + + + + + Represents user defined texture type. + + + + + Represents excel gradient pattern. + + + + + Represents 5% gradient pattern + + + + + Represents 10% gradient pattern + + + + + Represents 20% gradient pattern + + + + + Represents 25% gradient pattern + + + + + Represents 30% gradient pattern + + + + + Represents 40% gradient pattern + + + + + Represents 50% gradient pattern + + + + + Represents 60% gradient pattern + + + + + Represents 70% gradient pattern + + + + + Represents 75% gradient pattern + + + + + Represents 80% gradient pattern + + + + + Represents 90% gradient pattern + + + + + Represents Dark Downward Diagonal gradient pattern + + + + + Represents Dark Horizontal gradient pattern + + + + + Represents Dark Upward Diagonal gradient pattern + + + + + Represents Dark Vertical gradient pattern + + + + + Represents Dashed Downward Diagonal gradient pattern + + + + + Represents Dashed Horizontal gradient pattern + + + + + Represents Dashed Upward Diagonal gradient pattern + + + + + Represents Dashed Vertical gradient pattern + + + + + Represents Diagonal Brick gradient pattern + + + + + Represents Divot gradient pattern + + + + + Represents Dotted Diamond gradient pattern + + + + + Represents Dotted Grid gradient pattern + + + + + Represents Horizontal Brick gradient pattern + + + + + Represents Large Checker Board gradient pattern + + + + + Represents Large Confetti gradient pattern + + + + + Represents Large Grid gradient pattern + + + + + Represents Light Downward Diagonal gradient pattern + + + + + Represents Light Horizontal gradient pattern + + + + + Represents Light Upward Diagonal gradient pattern + + + + + Represents Light Vertical gradient pattern + + + + + Represents Mixed gradient pattern + + + + + Represents Narrow Horizontal gradient pattern + + + + + Represents Narrow Vertical gradient pattern + + + + + Represents Outlined Diamond gradient pattern + + + + + Represents Plaid gradient pattern + + + + + Represents Shingle gradient pattern + + + + + Represents Small Checker Board gradient pattern + + + + + Represents Small Confetti gradient pattern + + + + + Represents Small Grid gradient pattern + + + + + Represents Solid Diamond gradient pattern + + + + + Represents Sphere gradient pattern + + + + + Represents Trellis gradient pattern + + + + + Represents Wave gradient pattern + + + + + Represents Weave gradient pattern + + + + + Represents Wide Downward Diagonal gradient pattern + + + + + Represents Wide Upward Diagonal gradient pattern + + + + + Represents Zig Zag gradient pattern + + + + + Represents preset gradient type. + + + + + Represents early sunset preset gradient type. + + + + + Represents late sunset preset gradient type. + + + + + Represents nightfall preset gradient type. + + + + + Represents daybreak preset gradient type. + + + + + Represents horizon preset gradient type. + + + + + Represents desert preset gradient type. + + + + + Represents ocean preset gradient type. + + + + + Represents calm water preset gradient type. + + + + + Represents fire preset gradient type. + + + + + Represents fog preset gradient type. + + + + + Represents moss preset gradient type. + + + + + Represents peacock preset gradient type. + + + + + Represents wheat preset gradient type. + + + + + Represents parchment preset gradient type. + + + + + Represents mahogany preset gradient type. + + + + + Represents rainbow preset gradient type. + + + + + Represents rainbowII preset gradient type. + + + + + Represents gold preset gradient type. + + + + + Represents goldII preset gradient type. + + + + + Represents brass preset gradient type. + + + + + Represents chrome preset gradient type. + + + + + Represents chromeII preset gradient type. + + + + + Represents silver preset gradient type. + + + + + Represents sapphire preset gradient type. + + + + + Specifies the position of major and minor tick marks for an axis. + + + + + No mark. + + + + + Inside the axis. + + + + + Outside the axis. + + + + + Crosses the axis. + + + + + Specifies the position of tick-mark labels on the axis. + + + + + No tick marks. + + + + + Bottom or left side of the chart. + + + + + Top or right side of the chart. + + + + + Next to axis (where axis is not at either side of the chart). + + + + + Represents auto format values. + + + + + Represents Simple auto format. + + + + + Represents Classic_1 auto format. + + + + + Represents Classic_2 auto format. + + + + + Represents Classic_3 auto format. + + + + + Represents Accounting_1 auto format. + + + + + Represents Accounting_2 auto format. + + + + + Represents Accounting_3 auto format. + + + + + Represents Accounting_4 auto format. + + + + + Represents Colorful_1 auto format. + + + + + Represents Colorful_2 auto format. + + + + + Represents Colorful_3 auto format. + + + + + Represents List_1 auto format. + + + + + Represents List_2 auto format. + + + + + Represents List_3 auto format. + + + + + Represents Effect3D_1 auto format. + + + + + Represents Effect3D_2 auto format. + + + + + Represents None auto format. + + + + + Represents auto format options. + + + + + Represents number auto format option. + + + + + Represents border auto format option. + + + + + Represents font auto format option. + + + + + Represents patterns auto format option. + + + + + Represents alignment auto format option. + + + + + Represents width\height auto format option. + + + + + Represents none auto format option. + + + + + Represents all auto format option. + + + + + Specifies the range marked by error bars. + + + + + Represents the percentage of range to be covered by the error bars. + + + + + Represents fixed-length error bars. + + + + + Represents range for specified number of standard deviations. + + + + + Represents custom error bars. + + + + + Represents standard error range. + + + + + Specifies error-bar parts to be included. + + + + + Represents both positive and negative error range. + + + + + Represents only positive error range. + + + + + Represents only negative error range. + + + + + Represents trend line values. + + + + + Represents Exponential trend line type. + + + + + Represents Linear trend line type. + + + + + Represents Logarithmic trend line type. + + + + + Represents Moving average trend line type. + + + + + Represents Polynomial trend line type. + + + + + Represents Power trend line type. + + + + + Specifies the type of the category axis. + + + + + Axis groups data by an arbitrary set of categories. + + + + + Axis groups data on a time scale. + + + + + Excel controls the axis type. + + + + + Represents the axis title direction. + + + + + Represents context text direction. + + + + + Represents Left-To-Right text direction. + + + + + Represents Right-To-Left text direction. + + + + + Represents sheet protection flags enums. + + + + + Represents none flags. + + + + + True to protect shapes. + + + + + True to protect scenarios. + + + + + True allows the user to format any cell on a protected worksheet. + + + + + True allows the user to format any column on a protected worksheet. + + + + + True allows the user to format any row on a protected. + + + + + True allows the user to insert columns on the protected worksheet. + + + + + True allows the user to insert rows on the protected worksheet. + + + + + True allows the user to insert hyperlinks on the worksheet. + + + + + True allows the user to delete columns on the protected worksheet, + where every cell in the column to be deleted is unlocked. + + + + + True allows the user to delete rows on the protected worksheet, + where every cell in the row to be deleted is unlocked. + + + + + True to protect locked cells. + + + + + True allows the user to sort on the protected worksheet. + + + + + True allows the user to set filters on the protected worksheet. + Users can change filter criteria but can not enable or disable an auto filter. + + + + + True allows the user to use pivot table reports on the protected worksheet. + + + + + True to protect the user interface, but not macros. + + + + + True to protect content. + + + + + Represents all flags + + + + + Represents excel chart uint to display. + + + + + Represents None display Unit + + + + + Represents Hundreds display Unit + + + + + Represents Thousands display Unit + + + + + Represents TenThousands display Unit + + + + + Represents HundredThousands display Unit + + + + + Represents Millions display Unit + + + + + Represents TenMillions display Unit + + + + + Represents HundredMillions display Unit + + + + + Represents ThousandMillions display Unit + + + + + Represents MillionMillions display Unit + + + + + Represents Custom display Unit + + + + + Represents chart base unit. + + + + + Represents Day unit. + + + + + Represents Month unit. + + + + + Represents Year unit. + + + + + Represents excel open type. + + + + + Represents CSV open type. If data in the file exceeds worksheet limits, excepion will be thrown. + + + + + Represents TSV open type. If data in the file exceeds worksheet limits, exception will be thrown. + + + + + Represents SpreadsheetML open type. + + + + + Represents BIFF open type. + + + + + Represents SpreadsheetML that is used in Excel 2007 (Office Open XML format). + + + + + Represents SpreadsheetML that is used in Excel 2010 (Office Open XML format). + + + + + Automatically indicates open type. + + + + + Represents the data label positioning. + + + + + Default position. Applies to Pie charts. + + + + + Data label is positioned outside the data point. Applies to Bar or Column charts. + + + + + Data label is positioned inside the data point. Applies to Bar, Column, or Pie charts. + + + + + Data label is centered on the data point or is inside a bar or pie chart. + + + + + Data label is positioned outside the data point at the bottom edge. + Applies to Bar or Column charts. + + + + + Data label is positioned above the data point. + Applies to Line, Bubble, or Scatter charts. + + + + + Data label is positioned below the data point. + Applies to Line, Bubble, or Scatter charts. + + + + + Data label is positioned to the left of the data point. + Applies to Line, Bubble, or Scatter charts. + + + + + Data label is positioned to the right of the data point. + Applies to Line, Bubble, or Scatter charts. + + + + + Excel 2007 sets the position of the data label. Applies to Pie charts. + + + + + Moved by user. + + + + + Specifies the flags of excel ignore error indicator. + + + + + None. + + + + + Evaluating to an error. + + + + + References to empty cells. + + + + + Numbers written as text. + + + + + Omits adjacent cells. + + + + + Inconsistent formula. + + + + + TextDate with a two-digit year. + + + + + UnlockedFormulaCells. + + + + + All. + + + + + Represents encryption algorithm that will be used for encryption. + + + + + No encryption. + + + + + Standard encryption. + + + + + Strong encryption. + + + + + Represents possible excel versions. + + + + + Represents Excel version 97-2003. + + + + + Represents Excel version 2007. + + + + + Represents Excel version 2010. + + + + + Represents Excel version 2013. + + + + + Represents Excel version 2016. + + + + + Represents Excel version 2019 and above versions. + + + + + Defines the possible settings for vertical alignment of a run of text. + This is used to get superscript or subscript text without altering the + font size properties of the rest of the text run. + + + + + Returns the text in this run to the baseline, default, + alignment, and returns it to the original font size. + + + + + Specifies that this text should be superscript. Raises the text in this + run above the baseline and changes it to a smaller size, if a smaller + size is available. + + + + + Specifies that this text should be subscript. Lowers the text in this + run below the baseline and changes it to a smaller size, if a smaller + size is available. + + + + + Specifies check state of the check box. + + + + + Indicates that checkbox is unchecked. + + + + + Indicates that checkbox is checked. + + + + + Mixed state. + + + + + Possible image types for image conversion. + + + + + Bitmap image. + + + + + Metafile image. + + + + + Flags for expand/collapse settings. + + + + + Default options. + + + + + Indicates whether subgroups must be included into operation. + + + + + Indicates whether we have to expand parent group when expanding child (to make it visible). + + + + + Specifies the existing built-in styles. + + + + + Indicates Normal style. + + + + + Indicates Comma style. + + + + + Indicates Currency style. + + + + + Indicates Percent style. + + + + + Indicates Comma[0] style. + + + + + Indicates Currency[0] style. + + + + + Indicates Note style. + + + + + Indicates Warning Text style. + + + + + Indicates Title style. + + + + + Indicates Heading 1 style. + + + + + Indicates Heading 2 style. + + + + + Indicates Heading 3 style. + + + + + Indicates Heading 4 style. + + + + + Indicates Input style. + + + + + Indicates Output style. + + + + + Indicates Calculation style. + + + + + Indicates Check Cell style. + + + + + Indicates Linked Cell style. + + + + + Indicates Total style. + + + + + Indicates Good style. + + + + + Indicates Bad style. + + + + + Indicates Neutral style. + + + + + Indicates Accent1 style. + + + + + Indicates 20% - Accent1 style. + + + + + Indicates 40% - Accent1 style. + + + + + Indicates 60% - Accent1 style. + + + + + Indicates Accent2 style. + + + + + Indicates 20% - Accent2 style. + + + + + Indicates 40% - Accent2 style. + + + + + Indicates 60% - Accent2 style. + + + + + Indicates Accent3 style. + + + + + Indicates 20% - Accent3 style. + + + + + Indicates 40% - Accent3 style. + + + + + Indicates 60% - Accent3 style. + + + + + Indicates Accent4 style. + + + + + Indicates 20% - Accent4 style. + + + + + Indicates 40% - Accent4 style. + + + + + Indicates 60% - Accent4 style. + + + + + Indicates Accent5 style. + + + + + Indicates 20% - Accent5 style. + + + + + Indicates 40% - Accent5 style. + + + + + Indicates 60% - Accent5 style. + + + + + Indicates Accent6 style. + + + + + Indicates 20% - Accent6 style. + + + + + Indicates 40% - Accent6 style. + + + + + Indicates 60% - Accent6 style. + + + + + Indicates Explanatory Text style. + + + + + Represents possible combo box type values.. + + + + + Regular sheet dropdown control. + + + + + PivotTable page field dropdown. + + + + + AutoFilter dropdown. + + + + + AutoComplete dropdown. + + + + + Data validation list dropdown. + + + + + PivotTable row or column field dropdown. + + + + + Dropdown for the Total Row of a table. + + + + + Represents a possible action to be taken while encountering unknown variable during template markers processing. + + + + + Throws exception if no variable is defined. + + + + + Skips processing variable and leaves it in the document. + + + + + Replace variable with empty string. + + + + + shape border join type + (Supported in Excel 2007 and higher) + + + + + Rounded edge + + + + + Beveled edge + + + + + Metter join + + + + + Represents cap type of the line. + + + + + Represents none type + + + + + Represents flat type + + + + + Represents Square type + + + + + Represents Round type + + + + + MS Chart Font preservation Type + (Internal use) + + + + + Without the Font Tag + + + + + font with the default Property tag + + + + + font in ritch text tag + + + + + Defines action for the unknown value type and numberformat in the + template marker variable. + + + + + Detects the DataType of the marker variable. + + + + + Detects both the NumberFormat and DataType of the marker variable. + + + + + Represents the None Action. + + + + + Represents the sort orientation. + + + + + Sorts the range from top to Bottom. + + + + + Sorts the range from Left to Right. + + + + + Represents the sort by in the range. + + + + + Sort based on values in the cell. + + + + + Sort based on the cell back color. + + + + + Sort based on the font color. + + + + + Represents the algorithm to sort. + + + + + Represents the QuickSort Algorithm. + + + + + Represents the HeapSort Algorithm. + + + + + Represents the Merge Algorithm. + + + + + Represents the InsertionSort Algorithm. + + + + + Represents the sort order. + + + + + Represent the ascending sort. + + + + + Represent the descending sort. + + + + + Represents the position value in the sort list + Note:Applicable only to CellColor and FontColor + + + + + Represents the position of value in the sort list. + Note: Applicable only to CellColor and FontColor type. + + + + + Gets or Sets the way picture are displayed on the walls and Faces of 3D-chart. + + + + + Represent the picture format is Stack. + + + + + Represent the picture format is stackScale. + + + + + Represent the picture format is stretch. + + + + + Represents the extension property data. + + + + + Cell interior foreground color. + + + + + Cell interior background color. + + + + + Cell interior gradient fill. + + + + + Top cell border color. + + + + + Bottom cell border color. + + + + + Left cell border color. + + + + + Right cell border color. + + + + + Diagonal cell border color. + + + + + Cell text color. + + + + + Font Scheme + + + + + The text indentation level. + + + + + Font Scheme. + + + + + No font scheme. + + + + + Major scheme. + + + + + Minor scheme. + + + + + Niched state. + + + + + Conditional format template. + + + + + Cell value. + + + + + Formula. + + + + + Color scale formatting. + + + + + Data bar formatting. + + + + + Icon set formatting. + + + + + Filter. + + + + + Unique values. + + + + + Contains text. + + + + + Contains blanks. + + + + + Contains no blanks. + + + + + Contains errors. + + + + + Contains no errors. + + + + + Today. + + + + + Tomorrow. + + + + + Yesterday. + + + + + Last 7 days. + + + + + Last month. + + + + + Next month. + + + + + This week. + + + + + Next week. + + + + + Last week. + + + + + This month. + + + + + Above average. + + + + + Below Average. + + + + + Duplicate values. + + + + + Above or equal to average. + + + + + Below or equal to average. + + + + + Conditional format type of Text rule. + + + + + Contains a specified text. + + + + + Does not contain the specified text. + + + + + Begins with a specified text. + + + + + Ends with the specified text. + + + + + Specifies the series labels for the series label levels. + + + + + Set series names to all series name levels w/in range on the chart. + + + + + Set no category labels in the chart. Defaults to automatic indexed labels. + + + + + Specifies the category labels for the category label levels. + + + + + Set category labels to all category label levels w/in range on the chart. + + + + + Set no category labels in the chart. Defaults to automatic indexed labels. + + + + + Represents a possible consolidation functions in Excel. + + + + + Sum. + + + + + Count. + + + + + Average. + + + + + Maximum. + + + + + Minimum. + + + + + Multiply. + + + + + Count numerical values only. + + + + + Standard deviation, based on a sample. + + + + + Standard deviation, based on the whole population. + + + + + Variation, based on a sample. + + + + + Variation, based on the whole population. + + + + + It's Define the connection type + + + + + connection type is ODBC + + + + + connection type is OLEDB + + + + + connection type is Text file + + + + + connection type web file + + + + + Represent different command types of external connections. + + + + + Default(Sql) connection type. + + + + + Sql connection type. + + + + + Table connection type. + + + + + List connection type. + + + + + Represents different list object source type for external connection + + + + + Query type + + + + + It's represent the table type + + + + + Represents a table based on an external data query. + + + + + Represents a table based on a worksheet data range. + + + + + Represents a table based on an XML mapping. + + + + + It's represent the cretential for connect the server + + + + + Represents integrated authentication. + + + + + Represents no use credentials at all. + + + + + Represents use stored credentials. + + + + + Represent different auto shapes types. + + + + + Represents a unknown shape. + + + + + Represents a line shape. + + + + + Represents a elbowConnector shape. + + + + + Represents a curvedConnector shape. + + + + + Represents a bentConnector type 2 shape. + + + + + Represents a straightConnector shape. + + + + + Represents a BentConnector type 4 shape. + + + + + Represents a bent connector type 5 shape. + + + + + Represents a curved connector 2 shape. + + + + + Represents a curved connector 4 shape. + + + + + Represents a curved connector 5 shape. + + + + + Represents a rectangle shape. + + + + + Represents a rounded rectangle shape. + + + + + Represents a rectangle with one snipped corner. + + + + + Represents a rectangle with two snipped corners that share a side. + + + + + Represents a rectangle with two snipped corners, diagonally-opposed. + + + + + Represents a rectangle with one snipped corner and one rounded corner. + + + + + Represents a rectangle with one rounded corner. + + + + + Represents a rectangle with two-rounded corners that share a side. shape. + + + + + Represents a rectangle with rounded diagonal corner shape. + + + + + Represents a oval shape. + + + + + Represents a isosceles triangle shape. + + + + + Represents a right-angled triangle shape. + + + + + Represents a parallelogram shape. + + + + + Represents a trapezoid shape. + + + + + Represents a diamond shape. + + + + + Represents a regular pentagon shape. + + + + + Represents a hexagon shape. + + + + + Represents a heptagon shape. + + + + + Represents a octagon shape. + + + + + Represents a decagon shape. + + + + + Represents a dodecagon shape. + + + + + Represents a pie shape. + + + + + Represents a chord shape. + + + + + Represents a teardrop shape. + + + + + Represents a frame shape. + + + + + Represents a half frame shape. + + + + + Represents a l shape. + + + + + Represents a diagonalStripe shape. + + + + + Represents a cross shape. + + + + + Represents a plaque shape. + + + + + Represents a can shape. + + + + + Represents a cube shape. + + + + + Represents a bevel shape. + + + + + Represents a donut shape. + + + + + Represents a NoSymbol shape. + + + + + Represents a block arc shape. + + + + + Represents a folded corner shape. + + + + + Represents a smiley face shape. + + + + + Represents a heart shape. + + + + + Represents a lightning bolt shape. + + + + + Represents a sun shape. + + + + + Represents a moon shape. + + + + + Represents a cloud shape. + + + + + Represents a arc shape. + + + + + Represents a double bracket shape. + + + + + Represents a double brace shape. + + + + + Represents a left bracket shape. + + + + + Represents a right bracket shape. + + + + + Represents a left brace shape. + + + + + Represents a right brace shape. + + + + + Represents a block arrow that points right. + + + + + Represents a block arrow that points left. + + + + + Represents a block arrow that points up. + + + + + Represents a block arrow that points down. + + + + + Represents a block arrow that points left and right. + + + + + Represents a block arrow that points up and down. + + + + + Represents a block arrows that point up, down, left, and right. + + + + + Represents a block arrow with arrowheads that point left, right, and up. + + + + + Represents a block arrow that follows a curved 90-degree angle. + + + + + Represents a block arrow forming a U shape. + + + + + Represents a block arrow with arrowheads that point left and up. + + + + + Represents a block arrow that follows a sharp 90-degree angle. Points up by default. + + + + + Represents a block arrow that curves right. + + + + + Represents a block arrow that curves left. + + + + + Represents a block arrow that curves up. + + + + + Represents a block arrow that curves down. + + + + + Represents a block arrow that points right with stripes at the tail. + + + + + Represents a notched block arrow that points right. + + + + + Represents a pentagon shape. + + + + + Represents a chevron shape. + + + + + Represents a callout with arrow that points right. + + + + + Represents a callout with arrow that points down. + + + + + Represents a callout with arrow that points left. + + + + + Represents a callout with arrow that points up. + + + + + Represents a callout with arrowheads that point both left and right. + + + + + Represents a callout with arrows that point up and down. shape. + + + + + Represents a Callout with arrows that point up, down, left, and right. + + + + + Represents a block arrow that follows a curved 180-degree angle. + + + + + Represents a addition symbol. + + + + + Represents a subtraction symbol. + + + + + Represents a multiplication symbol. + + + + + Represents a division symbol. + + + + + Represents a equivalence symbol. + + + + + Represents a non-equivalence symbol. + + + + + Represents a process flowchart symbol. + + + + + Represents a alternate process flowchart symbol. + + + + + Represents a decision flowchart symbol. + + + + + Represents a data flowchart symbol. + + + + + Represents a predefined process flowchart symbol. + + + + + Represents a internal storage flowchart symbol. + + + + + Represents a document flowchart symbol. + + + + + Represents a multi-document flowchart symbol. + + + + + Represents a terminator flowchart symbol. + + + + + Represents a preparation flowchart symbol. + + + + + Represents a manual input flowchart symbol. + + + + + Represents a manual operation flowchart symbol. + + + + + Represents a connector flowchart symbol. + + + + + Represents a off-page connector flowchart symbol. + + + + + Represents a card flowchart symbol. + + + + + Represents a punched tape flowchart symbol. + + + + + Represents a summing junction flowchart symbol. + + + + + Represents a "Or" flowchart symbol. + + + + + Represents a collate flowchart symbol. + + + + + Represents a sort flowchart symbol. + + + + + Represents a extract flowchart symbol. + + + + + Represents a merge flowchart symbol. + + + + + Represents a stored data flowchart symbol. + + + + + Represents a delay flowchart symbol. + + + + + Represents a sequential access storage flowchart symbol. + + + + + Represents a magnetic disk flowchart symbol. + + + + + Represents a direct access storage flowchart symbol. + + + + + Represents a display flowchart symbol. + + + + + Represents a explosion type 1 shape. + + + + + Represents a explosion type 2 shape. + + + + + Represents a 4-point star. + + + + + Represents a 5-point star. + + + + + Represents a 6-point star. + + + + + Represents a 7-point star. + + + + + Represents a 8-point star. + + + + + Represents a 10-point star. + + + + + Represents a 12-point star. + + + + + Represents a 16-point star. + + + + + Represents a 24-point star. + + + + + Represents a 32-point star. + + + + + Represents a ribbon banner with center area above ribbon ends. + + + + + Represents a ribbon banner with center area below ribbon ends. + + + + + Represents a ribbon banner that curves up. + + + + + Represents a ribbon banner that curves down. + + + + + Represents a vertical scroll. + + + + + Represents a horizontal scroll + + + + + Represents a wave shape. + + + + + Represents a double wave. + + + + + Represents a rectangular callout. + + + + + Represents a rounded rectangle-shaped callout. + + + + + Represents a oval-shaped callout. + + + + + Represents a cloud callout. + + + + + Represents a callout with border and horizontal callout line. + + + + + Represents a callout with angled line. + + + + + Represents a callout with callout line segments forming a U-shape. + + + + + Represents a callout with diagonal callout line and accent bar. + + + + + Represents a callout with angled callout line and accent bar. + + + + + Represents a callout with accent bar and callout line segments forming a U-shape. + + + + + Represents a callout with horizontal accent bar. + + + + + Represents a callout with no border and angled callout line. + + + + + Represents a callout with no border and callout line segments forming a U-shape. + + + + + Represents a callout with border, diagonal straight line, and accent bar. + + + + + Represents a callout with border, angled callout line, and accent bar. + + + + + Represents a callout with border, accent bar, and callout line segments forming a U-shape. + + + + + Specify the hyperlink attached object name. + + + + + Represent IRange object. + + + + + Represent IShape object. + + + + + Specifies whether data is to be copied or left in place during a filter operation. + + + + + Leave filtered data in place. + + + + + Copy filtered data to new range. + + + + + Specifies whether the range should be accessed from worksheet or within the range object scope. + + + + + To access the range from worksheet. + + + + + To access the range within the object scope. + + + + + Specifies how to fill the group field values while importing nested collection CLR objects. + + + + + No operation will be performed for empty fields. + + + + + Merge the empty fields. + + + + + Repeat the field value until the next group set value. + + + + + Specifies whether the grouping is added with Collapse or Expand while importing nested collection CLR objects. + + + + + Expand the group. + + + + + Collapse the group. + + + + + Specifies whether the TopBottom conditional formatting rule looks for ranking from the top or bottom. + + + + + Top. + + + + + Bottom. + + + + + Specifies whether the AboveBelowAverage conditional formatting rule looks for cell values above or below the average. + + + + + Above average. + + + + + Below average. + + + + + Equal or above average + + + + + Equal or below average + + + + + Above standard deviation + + + + + Below standard deviation + + + + + It represents the chart image Scaling. + + + + + Save the image with normal image quality. + + + + + Save the image with best image quality which results large image size. + + + + + It represents the capitalization tags (used only in chart) + + + + + Applies no caps on the text + + + + + Applies all caps on the text + + + + + Applies small caps on the text + + + + + It represents the GrowShrinkType tags (used only in QueryTable) + + + + + + + + It specifies an enumeration of side positions + + + + + The title or legend is on the left side + + + + + The title or legend is on the top + + + + + The title or legend is on the left side + + + + + The title or legend is on the bottom + + + + + It represent side position alignment of a chart element + + + + + The chart element is positioned at the top of the side + + + + + The chart element is positioned at the bottom of the side + + + + + The chart element is positioned at the center of the side + + + + + It represents Quartile calculation used for Box and Whisker Chart series + + + + + It includes the Median when splitting the dataset into Quartiles. + + + + + It excludes the Median when splitting the dataset into Quartiles. + + + + + It represents the Label position in Tree Map chart + + + + + No Parent labels are shown + + + + + The Parent label layout is a Banner above the category + + + + + The Parent label is laid out within the category + + + + + + Indicates the Funnel Chart type + + + + + Indicates the Box and Whisker chart type + + + + + Used in Histogram and Pareto charts + + + + + Used in Histogram and Pareto charts + + + + + Indicates the Sun burst chart type + + + + + Indicates the Tree Map chart type + + + + + Indicates the Water fall chart type + + + + + Contains the list of style elements + + + + + Indicates the Axis Title Element + + + + + Indicates the Category Axis element + + + + + Indicates the chart Area Element + + + + + Indicates the Data Label Element + + + + + Indicates the Data Label callout Element + + + + + Indicates the Data Point Element + + + + + Indicates the Data Point 3D Element + + + + + Indicates the Data Point Line Element + + + + + Indicates the Data Point Marker Element + + + + + Indicates the Data Point Marker Layout Element + + + + + Indicates the Data Point Wireframe Element + + + + + Indicates the Data Table Element + + + + + Indicates the Down Bar Element + + + + + Indicates the Drop Line Element + + + + + Indicates the Error Bar Element + + + + + Indicates the Floor Element + + + + + Indicates the Major grid line Element + + + + + Indicates the Minor grid line Element + + + + + Indicates the High-Low Line Element + + + + + Indicates the Leader Line Element + + + + + Indicates the Legend Element + + + + + Indicates the Plot Area Element + + + + + Indicates the Plot Area 3D Element + + + + + Indicates the Series Axis Element + + + + + Indicates the SeriesLine Element + + + + + Indicates the Title Element + + + + + Indicates the Trendline Element + + + + + Indicates the TrendLine Label Element + + + + + Indicates the Up Bar Element + + + + + Indicates the Value Axis Element + + + + + Indicates the Wall Element + + + + + Indicates the Extension List Element + + + + + Contains the list of color models + + + + + No color models have been used + + + + + expressing Red, Green, Blue color in Percentages. + + + + + specifies the color two hex digits per color, in the order RGB. + + + + + represents a color using the Hue, Saturation, and Luminescence. + + + + + represents a system color, and introduces a level of indirection. + + + + + schemeClr represents a color from a theme. + + + + + prstClr represents a preset color by its name. + + + + + element that specifies a color calculated from a CT_ColorStyle. + + + + + Contains the style entry modifier enumerations + + + + + No modifier enum is applied + + + + + fill properties specified on this StyleEntry can be replaced with no fill instead. + + + + + line properties specified on this StyleEntry can be replaced with no line instead. + + + + + Enumeration represents one of the fonts associated with the style. + + + + + (None) No font reference. + + + + + (Minor Font) The minor font of the style's font scheme. + + + + + (Major Font) The major font of the style's font scheme. + + + + + This simple type enumeration specifies how to cap the ends of lines. + + + + + Line ends at end point. + + + + + Rounded ends. Semi-circle protrudes by half line width. + + + + + Square protrudes by half line width. + + + + + Specifies the Rtf table type. + + + + + Font table collection + + + + + List table collection + + + + + Color table collection + + + + + List override collection + + + + + Style sheet collection + + + + + No table collection + + + + + Specifies the Rtf token type. + + + + + Group start. + + + + + Group end. + + + + + Control word. + + + + + Text. + + + + + Table entry. + + + + + Unknown. + + + + + Specifies the warning type for the specific warning. + + + + + Font substitution. + + + + + Unsupported conditional format type. + + + + + Unsupported fill pattern. + + + + + Specifies unsupported shapes. + + + + + Specifies unsupported page settings. + + + + + Specifies unsupported pivot table settings. + + + + + Specifies formatting options for the JsonWriter. + + + + + No special formatting is applied. This is the default. + + + + + Causes child objects to be indented according to the Indentation and IndentChar settings. + + + + + Specifies the export data table event actions. + + + + + Default action for exporting data table + + + + + Stops the data table export. + + + + + Skips the specified row while exporting to data table. + + + + + Represents the HTML import option. + + + + + Represents default import option for HTML. + + + + + Represents the option to detect formulas while importing HTML table. + + + + + Enumeration represents patterns (pattern names) that are used in Excel 2007. + This enumeration is used to convert pattern from Excel 2003 into 2007 + + + + + The fill style is none (no fill). When foreground and/or background colors + are specified, a pattern of 'none' overrides and means the cell has no fill. + + + + + The fill style is solid. When solid is specified, the foreground color + (fgColor) is the only color rendered, even when a background color + (bgColor) is also specified. + + + + + The fill style is medium gray. + + + + + The fill style is 'dark gray'. + + + + + The fill style is light gray. + + + + + The fill style is dark horizontal. + + + + + The fill style is 'dark vertical'. + + + + + The fill style is 'dark down'. + + + + + The fill style is 'dark up'. + + + + + The fill style is 'dark grid'. + + + + + The fill style is 'dark trellis'. + + + + + The fill style is light horizontal. + + + + + The fill style is light vertical. + + + + + The fill style is 'light down'. + + + + + The fill style is light up. + + + + + The fill style is 'light grid'. + + + + + The fill style is 'light trellis'. + + + + + The fill style is grayscale of 0.125 (1/8) value. + + + + + The fill style is grayscale of 0.0625 (1/16) value. + + + + + Represents the Axis labels alignment + + + + + Left alignment + + + + + Center alignment + + + + + Right alignment + + + + + The line style of a border in a cell as it is named Excel2007. + + + + + The line style of a border is dash-dot. + + + + + The line style of a border is dash-dot-dot. + + + + + The line style of a border is dashed. + + + + + The line style of a border is dotted. + + + + + The line style of a border is double line. + + + + + The line style of a border is hairline. + + + + + The line style of a border is medium. + + + + + The line style of a border is medium dash-dot. + + + + + The line style of a border is medium dash-dot-dot. + + + + + The line style of a border is medium dashed. + + + + + The line style of a border is none (no border visible). + + + + + The line style of a border is slant-dash-dot. + + + + + The line style of a border is 'thick'. + + + + + The line style of a border is thin. + + + + + Represents border index. + + + + + Represents left border. + + + + + Represents right border. + + + + + Represents top border. + + + + + Represents bottom border. + + + + + Represents diagonal border. + + + + + Represents no border. + + + + + Represents vertical inner border. + + + + + Represents horizontal innver border. + + + + + This Enumeration values Indicates the Outer Shadow values + + + + + Represents No shadow + + + + + Represents Outer shadow at Right + + + + + Represents Outer shadow at DiagonalBottomRight + + + + + Represents Outer shadow at Bottom + + + + + Represents Outer shadow at DiagonalTopLeft + + + + + Represents Outer shadow at Center + + + + + Represents Outer shadow at Top + + + + + Represents Outer shadow at Left + + + + + Represents Outer shadow at DiagonalTopRight + + + + + Represents Outer shadow at DiagonalBottomLeft + + + + + This enumeration value indicates the Inner Shadow Values + + + + + Represents No shadow(Default) + + + + + Represents Inner Shadow at Diagonal Bottom Left + + + + + Represents Inner Shadow at Top + + + + + Represents Inner Shadow at Right + + + + + Represents Inner Shadow at Left + + + + + Represents Inner Shadow at TopRight + + + + + Represents Inner Shadow at Diagonal Bottom Right + + + + + Represents Inner Shadow at Center + + + + + Represents Inner Shadow at Bottom + + + + + Represents Inner Shadow at Diagonal Top left + + + + + This Enumeration values gives the Perspective shadow Values + + + + + Represents the No Shadow + + + + + Represents Perspective Shadow at Diagonal Upper Right + + + + + Represents Perspective Shadow at Diagonal Lower Right + + + + + Represents Perspective Shadow at Diagonal Upper Left + + + + + Represents Perspective Shadow at Diagonal Lower Left + + + + + Represents Perspective Shadow at Below + + + + + This enumeration value indicates the bevel properties for both Top nad Bottom Bevel + + + + + Represents No angle + + + + + Represents Angle + + + + + Represents Art Deco + + + + + Represents Circle + + + + + Represents Convex + + + + + Represents Cool Slant + + + + + Represents Cross + + + + + Represents Divot + + + + + Represents Hard Edge + + + + + Represents Relaxed Inset + + + + + Represents Riblet + + + + + Represents Slope + + + + + Represents Soft round + + + + + This Enumeration value indicates the Material property values fro the chart + + + + + Represents No Material Effect + + + + + Represents Matte Material + + + + + Represents WarmMatte Material + + + + + Represents Plastic Material + + + + + Represents Metal Material + + + + + Represents Dark Edge Material + + + + + Represents Soft Edge Material + + + + + Represents Flat Material + + + + + Represents Wire Frame Material + + + + + Represents Powder Material + + + + + Represents Translucent Powder Material + + + + + Represents Clear Material + + + + + This enumeration value indicates the Lighting properties for the + Chart + + + + + Represents ThreePoint Lighting(Default) + + + + + Represents Balance Lighting + + + + + Represents Bright Room Lighting + + + + + Represents Chilly Lighting + + + + + Represents Contrasting Lighting + + + + + Represents Flat Lighting + + + + + Represents Flood Lighting + + + + + Represents Freezing Lighting + + + + + Represents Glow Lighting + + + + + Represents Harsh Lighting + + + + + Represents Morning Lighting + + + + + Represents Soft Lighting + + + + + Represents Sunrise Lighting + + + + + Represents Sun Set Lighting + + + + + Represents TwoPoint Lighting + + + + + The enumeration value indicating the portion of Cell Alignment in + a cell format (XF) that is horizontal alignment. + + + + + The horizontal alignment is centered, meaning the text is centered across the cell. + + + + + The horizontal alignment is centered across multiple cells. + + + + + Indicates that each 'word' in each line of text inside the cell is evenly + distributed across the width of the cell, with flush right and left margins. + When there is also an indent value to apply, both the left and right side + of the cell are padded by the indent value. + + + + + Indicates that the value of the cell should be filled across the entire + width of the cell. + + + + + The horizontal alignment is general-aligned. Text data is left-aligned. + Numbers, dates, and times are rightaligned. Boolean types are centered. + Changing the alignment does not change the type of data. + + + + + The horizontal alignment is justified (flush left and right). For each + line of text, aligns each line of the wrapped text in a cell to the right + and left (except the last line). If no single line of text wraps in the + cell, then the text is not justified. + + + + + The horizontal alignment is left-aligned, even in Right-to-Left mode. + Aligns contents at the left edge of the cell. If an indent amount is + specified, the contents of the cell is indented from the left by the + specified number of character spaces. The character spaces are based + on the default font and font size for the workbook. + + + + + The horizontal alignment is right-aligned, meaning that cell contents + are aligned at the right edge of the cell, even in Right-to-Left mode. + + + + + This enumeration value indicates the type of vertical alignment for a cell. + + + + + The vertical alignment is aligned-to-bottom. + + + + + The vertical alignment is centered across the height of the cell. + + + + + When text direction is horizontal: the vertical alignment of lines of text + is distributed vertically, where each line of text inside the cell is evenly + distributed across the height of the cell, with flush top and bottom margins. + When text direction is vertical: behaves exactly as distributed horizontal + alignment. The first words in a line of text (appearing at the top of the cell) + are flush with the top edge of the cell, and the last words of a line of text + are flush with the bottom edge of the cell, and the line of text is distributed + evenly from top to bottom. + + + + + When text direction is horizontal: the vertical alignment of lines of text + is distributed vertically, where each line of text inside the cell is evenly + distributed across the height of the cell, with flush top and bottom margins. + When text direction is vertical: similar behavior as horizontal justification. + The alignment is justified (flush top and bottom in this case). For each line + of text, each line of the wrapped text in a cell is aligned to the top and + bottom (except the last line). If no single line of text wraps in the cell, + then the text is not justified. + + + + + The vertical alignment is aligned-to-top. + + + + + Enumeration which controls visibility of worksheet in Excel. + + + + + Worksheet is visible to the user. + + + + + Worksheet is hidden for the user. + + + + + The strong hidden flag can only be set and cleared with a Visual Basic + macro. It is not possible to make such a sheet visible via the user interface. + + + + + This simple type specifies the possible styles of radar chart. + + + + + Specifies that the radar chart shall have lines but no markers and no fill. + + + + + Specifies that the radar chart shall have lines and markers but no fill. + + + + + Specifies that the radar chart shall be filled and have lines but no markers. + + + + + This simple type specifies the possible styles of scatter chart. + + + + + Specifies the points on the scatter chart shall not be connected with + lines and markers shall be drawn. + + + + + Specifies the the points on the scatter chart shall be connected with + smoothed lines and markers shall be drawn. + + + + + Specifies the the points on the scatter chart shall be connected with + smoothed lines and markers shall not be drawn. + + + + + Specifies the points on the scatter chart shall be connected with + straight lines and markers shall be drawn. + + + + + Specifies the points on the scatter chart shall be connected with + straight lines but markers shall not be drawn. + + + + + Enumeration limits values which can be set by user. + + + + + Represents the Position split type. + + + + + Represents the Value split type. + + + + + Represents the Percent split type. + + + + + Represents the Custom split type. + + + + + Represents the data label positioning. + + + + + Specifies that data labels shall be displayed below the data marker. + + + + + Specifies that data labels shall be displayed in the best position. + + + + + Specifies that data labels shall be displayed centered on the data marker. + + + + + Specifies that data labels shall be displayed inside the base of the data marker. + + + + + Specifies that data labels shall be displayed inside the end of the data marker. + + + + + Specifies that data labels shall be displayed to the left of the data marker. + + + + + Specifies that data labels shall be displayed outside the end of the data marker. + + + + + Specifies that data labels shall be displayed to the right of the data marker. + + + + + Specifies that data labels shall be displayed above the data marker.} + + + + + Enumeration of the marker types for Chart lines in Excel. + + + + + Represents the None option for the marker type. + + + + + Represents the square style in the custom marker option for Chart lines. + + + + + Represents the diamond style in the custom marker option for Chart lines. + + + + + Represents the Triangle style in the custom marker option for Chart lines. + + + + + Represents the X style in the custom marker option for Chart lines. + + + + + Represents the Star style in the custom marker option for Chart lines. + + + + + Represents the Dow Jones style in the custom marker option for Chart lines. + + + + + Represents the Standard Deviation style in the custom marker option for Chart lines. + + + + + Represents the Circle style in the custom marker option for Chart lines. + + + + + Represents the Plus style in the custom marker option for Chart lines. + + + + + Represents the auto marker style in the custom marker option for Chart lines + + + + + Represents trend line values. + + + + + Represents Exponential trend line type. + + + + + Represents Linear trend line type. + + + + + Represents Logarithmic trend line type. + + + + + Represents Moving average trend line type. + + + + + Represents Polynomial trend line type. + + + + + Represents Power trend line type. + + + + + Error-bar type. + + + + + Represents the Percentage error-bar source type. + + + + + Represents the FixedValue error-bar source type. + + + + + Represents the StandardDeviation error-bar source type. + + + + + Represents the Custom error-bar source type. + + + + + Represents the StandardError error-bar source type. + + + + + Enumeration of the legend placement for Charts in Excel. + + + + + Represents the bottom option. + + + + + Represents the Corner option. + + + + + Represents the Top option. + + + + + Represents the Right option. + + + + + Represents the Left option. + + + + + This enumeration specifies the possible ways to display blanks. + + + + + Specifies that blank values shall be left as a gap. + + + + + Specifies that blank values shall be treated as zero. + + + + + Specifies that blank values shall be spanned with a line. + + + + + Represents 5% gradient pattern + + + + + Represents 10% gradient pattern + + + + + Represents 20% gradient pattern + + + + + Represents 25% gradient pattern + + + + + Represents 30% gradient pattern + + + + + Represents 40% gradient pattern + + + + + Represents 50% gradient pattern + + + + + Represents 60% gradient pattern + + + + + Represents 70% gradient pattern + + + + + Represents 75% gradient pattern + + + + + Represents 80% gradient pattern + + + + + Represents 90% gradient pattern + + + + + Represents Dark Downward Diagonal gradient pattern + + + + + Represents Dark Horizontal gradient pattern + + + + + Represents Dark Upward Diagonal gradient pattern + + + + + Represents Dark Vertical gradient pattern + + + + + Represents Dashed Downward Diagonal gradient pattern + + + + + Represents Dashed Horizontal gradient pattern + + + + + Represents Dashed Upward Diagonal gradient pattern + + + + + Represents Dashed Vertical gradient pattern + + + + + Represents Diagonal Brick gradient pattern + + + + + Represents Divot gradient pattern + + + + + Represents Dotted Diamond gradient pattern + + + + + Represents Dotted Grid gradient pattern + + + + + Represents Horizontal Brick gradient pattern + + + + + Represents Large Checker Board gradient pattern + + + + + Represents Large Confetti gradient pattern + + + + + Represents Large Grid gradient pattern + + + + + Represents Light Downward Diagonal gradient pattern + + + + + Represents Light Horizontal gradient pattern + + + + + Represents Light Upward Diagonal gradient pattern + + + + + Represents Light Vertical gradient pattern + + + + + Represents Narrow Horizontal gradient pattern + + + + + Represents Narrow Vertical gradient pattern + + + + + Represents Outlined Diamond gradient pattern + + + + + Represents Plaid gradient pattern + + + + + Represents Shingle gradient pattern + + + + + Represents Small Checker Board gradient pattern + + + + + Represents Small Confetti gradient pattern + + + + + Represents Small Grid gradient pattern + + + + + Represents Solid Diamond gradient pattern + + + + + Represents Sphere gradient pattern + + + + + Represents Trellis gradient pattern + + + + + Represents Wave gradient pattern + + + + + Represents Weave gradient pattern + + + + + Represents Wide Downward Diagonal gradient pattern + + + + + Represents Wide Upward Diagonal gradient pattern + + + + + Represents Zig Zag gradient pattern + + + + + Represents Horizontal gradient pattern + + + + + Repersent Vertical gradient pattern + + + + + Repersent Diagonal Cross gradient pattern + + + + + Repersent Cross gradient pattern + + + + + Repersent Up Diagonal gradient pattern + + + + + Repersent Down Diagonal gradient pattern + + + + + Represents excel 2007 chart uint to display. + + + + + Represents Hundreds display Unit + + + + + Represents Thousands display Unit + + + + + Represents TenThousands display Unit + + + + + Represents HundredThousands display Unit + + + + + Represents Millions display Unit + + + + + Represents TenMillions display Unit + + + + + Represents HundredMillions display Unit + + + + + Represents ThousandMillions display Unit + + + + + Represents MillionMillions display Unit + + + + + Represents the displayUnit which is only avail at paret chart axis + + + + + Possible types for row data storage. + + + + + Uses Win32 API and Marshal class calls to allocate and work with memory blocks. + + + + + Uses Win32 API and unsafe blocks to allocate and work with memory blocks. + + + + + Uses managed byte array and other managed functions to work with memory blocks. + This method is slowest, but it is the only one suitable for medium trust mode. + + + + + Specifies the type of icon set. + + + + + 3 Arrows. + + + + + 3 Arrows Gray. + + + + + 3 Flags. + + + + + 3 Traffic Lights 1. + + + + + 3 Traffic Lights 2. + + + + + 3 Signs. + + + + + 3 Symbols. + + + + + 3 Symbols 2. + + + + + 4 Arrows. + + + + + 4 Arrows Gray. + + + + + 4 Red To Black. + + + + + 4 Ratings. + + + + + 4 Traffic Lights. + + + + + 5 Arrows. + + + + + 5 Arrows Gray. + + + + + 5 Rating. + + + + + 5 Quarters. + + + + + 3 Stars + + + + + 3 Triangles + + + + + 5 Boxes + + + + + If there is vertical text, determines what type of vertical text is going to be used. + + + + + Horizontal text. This should be default. + + + + + Determines if all of the text is vertical ("one letter on top of another"). + + + + + Determines if all of the text is vertical orientation (each line is 90 + degrees rotated clockwise, so it goes from top to bottom; each next + line is to the left from the previous one). + + + + + Determines if all of the text is vertical orientation (each line is 270 + degrees rotated clockwise, so it goes from bottom to top; each next line + is to the right from the previous one). + + + + + A special version of vertical text, where some fonts are displayed as if rotated + by 90 degrees while some fonts (mostly East Asian) are displayed vertical. + + + + + A special version of vertical text, where some fonts are displayed as if + rotated by 90 degrees while some fonts (mostly East Asian) are displayed + vertical. The difference between this and the eastAsianVertical is the + text flows top down then LEFT RIGHT, instead of RIGHT LEFT. + + + + + Specifies that vertical WordArt should be shown from right to left rather than left to right. + + + + + Enumeration to align the excel comment Horizontally. + + + + + Represents the Left comment align. + + + + + Represents the Center comment align. + + + + + Represents the Right comment align. + + + + + Represents the Justified comment align. + + + + + Represents the Distributed comment align. + + + + + This type specifies a list of available anchoring types for text. + + + + + Anchor the text at the top of the bounding rectangle. + + + + + Anchor the text at the middle of the bounding rectangle. + + + + + Anchor the text at the bottom of the bounding rectangle. + + + + + Anchor the text so that it is justified vertically. + + + + + Anchor the text so that it is distributed vertically. + + + + + Represents Excel 2007 Text alignment. + + + + + Align text to the left margin. + + + + + Align text in the center. + + + + + Align text to the right margin. + + + + + Align text so that it is justified across the whole line. + + + + + Aligns the text with an adjusted kashida length for Arabic text. + + + + + Distributes Thai text specially, because each character is treated as a word. + + + + + Distributes the text words across an entire text line. + + + + + Represents line style. + + + + + Represents single line style. + + + + + Represents thin thin line style. + + + + + Represents thin thick line style. + + + + + Represents thick thin line style. + + + + + Represents thick between thin line style. + + + + + Specifies the type of calculation in the Totals row of a list column. + + + + + No calculation. + + + + + Sum of all values in the list column. + + + + + Average. + + + + + Count of non-empty cells. + + + + + Count of cells with numeric values. + + + + + Minimum value in the list. + + + + + Standard deviation value. + + + + + Variable. + + + + + Maximum value in the list. + + + + + Custom formula + + + + + Represents functions added in Excel 2007. + + + + + Returns a key performance indicator (KPI) name, property, and measure, and displays the name and property in the cell. A KPI is a quantifiable measurement, such as monthly gross profit or quarterly employee turnover, used to monitor an organization's performance. + + + + + Returns a member or tuple in a cube hierarchy. Use to validate that the member or tuple exists in the cube. + + + + + Returns the value of a member property in the cube. Use to validate that a member name exists within the cube and to return the specified property for this member. + + + + + Returns the nth, or ranked, member in a set. Use to return one or more elements in a set, such as the top sales performer or top 10 students. + + + + + Defines a calculated set of members or tuples by sending a set expression to the cube on the server, which creates the set, and then returns that set to Microsoft Office Excel. + + + + + Returns the number of items in a set. + + + + + Returns an aggregated value from a cube. + + + + + Returns the modified Bessel function In(x). + + + + + Returns the Bessel function Jn(x). + + + + + Returns the modified Bessel function Kn(x). + + + + + Returns the Bessel function Yn(x). + + + + + Converts a binary number to decimal. + + + + + Converts a binary number to hexadecimal. + + + + + Converts a binary number to octal. + + + + + Converts real and imaginary coefficients into a complex number. + + + + + Converts a number from one measurement system to another. + + + + + Converts a decimal number to binary. + + + + + Converts a decimal number to hexadecimal. + + + + + Converts a decimal number to octal. + + + + + Tests whether two values are equal. + + + + + Returns the error function. + + + + + Returns the complementary error function. + + + + + Tests whether a number is greater than a threshold value. + + + + + Converts a hexadecimal number to binary. + + + + + Converts a hexadecimal number to decimal. + + + + + Converts a hexadecimal number to octal. + + + + + Returns the absolute value (modulus) of a complex number. + + + + + Returns the imaginary coefficient of a complex number. + + + + + Returns the argument theta, an angle expressed in radians. + + + + + Returns the complex conjugate of a complex number. + + + + + Returns the cosine of a complex number + + + + + Returns the quotient of two complex numbers. + + + + + Returns the exponential of a complex number. + + + + + Returns the natural logarithm of a complex number. + + + + + Returns the base-10 logarithm of a complex number. + + + + + Returns the base-2 logarithm of a complex number. + + + + + Returns a complex number raised to an integer power. + + + + + Returns the product of from 2 to 29 complex numbers + + + + + Returns the real coefficient of a complex number + + + + + Returns the sine of a complex number + + + + + Returns the square root of a complex number + + + + + Returns the difference between two complex numbers + + + + + Returns the sum of complex numbers. + + + + + Converts an octal number to binary. + + + + + Converts an octal number to decimal. + + + + + Converts an octal number to hexadecimal. + + + + + Adds the cells in a range that meet multiple criteria + + + + + Returns the average (arithmetic mean) of all the cells in a range that meet a given criteria + + + + + Returns the average (arithmetic mean) of all cells that meet multiple criteria. + + + + + Represents the OleObject Display Behaviour. + + + + + Returns the OleObject Display as Content. + + + + + Returns the OleObject Display as Icon. + + + + + Defines types of the ole object field. + + + + + Ole object field type is EMBED. + + + + + Ole object field type is LINK. + + + + + defines the types of OLE object + + + + + Type is not defined + + + + + Adobe Acrobat Document. File has ".pdf" extension. + + + + + Bitmap Image. File has ".png" extension. + + + + + Media Clip + + + + + Equation + + + + + Graph Chart + + + + + Excel 97-2003 Worksheet. File has ".xls" extension + + + + + Excel Binary Worksheet. File has ".xlsb" extension + + + + + Excel chart. File has ".xls" extension + + + + + Excel Macro-Enabled Worksheet. File has ".xlsm" extension. + + + + + Excel Worksheet. File has ".xlsx" extension. + + + + + PowerPoint 97-2003 Presentation. File has ".ppt" extension. + + + + + PowerPoint 97-2003 Slide. File has ".sld" extension. + + + + + PowerPoint Macro-Enabled Presentation. File has ".pptm" extension. + + + + + PowerPoint Macro-Enabled Slide. File has ".sldm" extension. + + + + + PowerPoint Presentation. File has ".pptx" extension. + + + + + PowerPoint Slide. File has ".sldx" extension. + + + + + Word 97-2003 Document. File has ".doc" extension. + + + + + Word Document. File has ".docx" extension. + + + + + Word Macro-Enabled Document. File has ".docm" extension. + + + + + Visio Deawing + + + + + MIDI Sequence + + + + + OpenDocument Presentation + + + + + OpenDocument Spreadsheet + + + + + OpenDocument Text + + + + + OpenOffice.org 1.1 Spreadsheet + + + + + OpenOffice.org 1.1 Text + + + + + Package + + + + + Video Clip + + + + + Wave Sound + + + + + WordPad Document + + + + + OpenOffice spreadsheet + + + + + OpenOffice Text + + + + + Defined types of Sparkline chart types. + + + + + Sparkline type is WinLoss. + + + + + Sparkline type is Column. + + + + + Sparkline type is Line. + + + + + Defines the Display of the Empty Cells within the Sparkline Range. + + + + + Display as Gaps. + + + + + Diaplay as Zero. + + + + + Display as Continued line. + + + + + Defines the Sparkline vertical axis type. + + + + + Automatic value for the vertical axis. + + + + + Same value for the vertical axis. + + + + + Custom value for the vertical axis. + + + + + Represents different modes of layout + + + + + Specifies automatic height and width. + + + + + Specifies that the width/height shall be interpreted as the + width/height of the chart element. + + + + + Specifies that the width/height shall be interpreted as the + right/bottom of the chart element. + + + + + Represents different targets of layout. + + + + + Specifies automatic plot area size for layout. + + + + + Specifies the plot area size including the tick marks and axis labels. + + + + + Specifies the plot area size excluding the tick marks and axis labels. + + + + + Defines the directions of data bar in conditional formatting. + + + + + Represents Context direction. The default direction is Context. + + + + + Represents Left to Right (LTR) direction. + + + + + Represents Right to Left (RTL) direction. + + + + + Specifies the axis position for a range of cells with conditional formatting as data bars. + + + + + Default value if the conditional formatting rule is created programmatically. + + + + + Default value if the conditional formatting rule is created using the user interface. + + + + + Defines the axis position at the mid point. + + + + + Specifies the type of filter applied. + + + + + Represents applying filter with conditions. + + + + + Represents applying filter with combination(Text and DateTime). + + + + + Represents applying filter with specified relative date constant. + + + + + Represents applying filter with color (Fill and Font color). + + + + + Represents applying Icon Filter for the icons from Conditional Formatting. + + + + + Specifies the type of color filter + + + + + Represents applying filter with cell color + + + + + Represents applying filter with font color. + + + + + Represents different type of combinational filter. + + + + + Represents Text value filter. + + + + + Represents date filter. + + + + + Represents grouping type applied for DateTime filter. + + + + + Group by year. + + + + + Group by month. + + + + + Group by day. + + + + + Group by hour. + + + + + Group by minute. + + + + + Group by second. + + + + + Represent relative date filter type. + + + + + None of the type applied. + + + + + Represent Tomorrow. + + + + + Represent Today. + + + + + Represent Yesterday. + + + + + Represent next week of the current week. + + + + + Represent current week. + + + + + Represent last week of the current week. + + + + + Represent next month of the current month. + + + + + Represent current month. + + + + + Represent last month of the current month. + + + + + Represent next quarter of the current quarter year. + + + + + Represent current quarter year. + + + + + Represent last quarter of the current quarter year. + + + + + Represent next year. + + + + + Represent current year. + + + + + Represent last year. + + + + + Represent first quarter of the years. + + + + + Represent second quarter of the years. + + + + + Represent third quarter of the years. + + + + + Represent fourth quarter of the years. + + + + + Represent January month. + + + + + Represent February month. + + + + + Represent March month. + + + + + Represent April month. + + + + + Represent May month. + + + + + Represent June month. + + + + + Represent July month. + + + + + Represent August month. + + + + + Represent September month. + + + + + Represent October month. + + + + + Represent November month. + + + + + Represent December month. + + + + + Represent dates from starting of the current year till today. + + + + + Chart Ex Dimension Data type enum + + + + + All chart Ex numeric dimension data type [except sunburst,tree map] + + + + + x coordinate value + + + + + y coordinate value + + + + + Size coordinate value Used in treemap and sunburst charts + + + + + String dimension type + + + + + Event arguments for notifying read progress. + + + + + + Current read position. + + + + + Full stream size. + + + + + Creates new instance of the event arguments. + + Current read position. + Full stream size. + + + + Current read position. + + + + + Full stream size. + + + + + The ExpotEvent args for the TypeMismatchOnExport event which is raised whenever + there is a data type mismatch on exporting to CLR objects. + + + + + Represents the cell range of mismatched data type. + + + + + Represents the error message. + + + + + Represents the property name that has mismatched data type. + + + + + Represents a valid value for the property. + + + + + Represents the current value of the range. + + + + + Represents the Type code. + + + + + Represents the current cell value type. + + + + + Represents the mismatched CLRObject index. + + + + + Initializes a new instance of class for mismatch date type. + + The current range. + The error message. + The error property. + The current range value. + The mismatched CLRObject index + The current cell value type + The typecode of the property + + + + Gets the cell range of mismatched data type. + + Range object of mismatched data type. + + + + Gets the error message. + + The string that specifies the error message. + + + + Gets the property name that has mismatched data type. + + Name of the property that has mismatched data type. + + + + Gets or sets a valid value for the property. + + The Object that specifies a valid value for the property. + + + + Gets the current value of the range. + + The object that specifies current value of the range. + + + + Gets the typecode of the property. + + The TypeCodethat specifies typecode of the property. + + + + Gets the current cell value type. + + The stringthat specifies current cell value type. + + + + Gets the mismatched CLRObject index. + + + + + Progress event handler delegate + + + + + + Represents the delegate that handles TypeMismatchOnExport event that is raised whenever there is a data type mismatch while exporting data to CLR objects. + + The source of the event. + object that contains the event data. + + + + Represents a Merged Cell. + + + + + Merges all cells in cellRange. + + Row index from which merging should be done. + Row index to which merging should be done. + Column index from which merging should be done. + Column index to which merging should be done. + Different merge operations. + + + + If specified cell is contained in merged cell, delete that merge. + + Index to be removed from Merged area. + + + + Contains types to create and manipulate Excel documents. + + + + + Represents a class for exporting data options. + + + + + Indicates the row for detecting the column type For export data table + + + + + Gets or sets row index that is used for detecting the column Types. By default the second row from the export range is used for detecting the column types. And the default value will be exported in the data table if the cell value does not match with the column type. + + + + + Import Data options class + + + + + Specifies first row from where the data should be imported. + + + + + Specifies first column from where the data should be imported. + + + + + Specifies whether class properties names must be imported or not. + + + + + Specifies whether parent class properties names must be imported or not. + + + + + Specifies how to fill the group field values while importing nested collection objects. + + + + + Specifies whether the grouping is added with Collapse or Expand while importing nested collection objects. + + + + + Specifies the group collpase level. The group will be expanded before this level and collapse will be applied from this level. + + + + + /// Indicates whether XlsIO should preserve column types from DataTable. By default, preserve type is FALSE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + + + + + Initializes a new instance of the class. + + + + + Specifies first row from where the data should be imported. + + + + + Specifies first column from where the data should be imported. + + + + + Specifies whether class properties names must be imported or not. + + + + + Specifies whether parent class properties names must be imported or not. + + + + + Specifies how to fill the group field values while importing nested collection objects. + + + + + Specifies whether the grouping is added with Collapse or Expand while importing nested collection objects. + + + + + Specifies the group collapse level. The group will be expanded before this level and collapse will be applied from this level. + + + + + Indicates whether XlsIO should preserve column types from Data. By default, preserve type is TRUE. + i.e., Setting it to True will import data based on column type, otherwise will import based on value type. + + + + + Interface that represents single gradient stop of the gradient fill. + + + + + Gets / sets color. + + + + + Gets / sets position of the gradient stop. + + + + + Gets / sets transparency value. + + + + + Event arguments for ReadOnlyFile event. + + + + + + Indicates if file should be rewritten, default - False. + + + + + Default constructor. + + + + + Indicates whether Read-only file should be rewritten. + + + + + Event arguments for PasswordRequired event. + + + + + Indicates whether we should stop parsing protected workbook. + + + + + New password to try. + + + + + Default constructor. + + + + + Indicates whether we should stop parsing protected workbook. + + + + + New password to try. + + + + + Represents the connection password of the data source. + + + + + + Gets or sets the password to connect data source. + + + + + Represents the method that will handle the ReadOnlyFile event. + + + + + + Represents the method that will handle the PasswordRequired event. + + + + + + Represents the method that will handle the PasswordRequired event. + + + + + + SR provides localized access to string resources specific + from the assembly manifest Syncfusion.XlsIO.Localization.SR.resources + + + + + Specifies the category in which the property or event will be displayed in a visual designer. + + + This is a localized version of CategoryAttribute. The localized string will be loaded from the + assembly manifest Syncfusion.XlsIO.Localization.SR.resources + + + + + Specifies a description for a property or event. + + + This is a localized version of DescriptionAttribute. The localized string will be loaded from the + assembly manifest Syncfusion.XlsIO.Localization.SR.resources + + + + + ExcelUtils is a helper class that is used for easy usage of direct XlsIO API in performing + repetitive tasks.[The usage of this class is not recommended, Please refer to the documentation + for updated sample code.] + + + + + ExcelEngine Object + + + + + Represents the application object + + + + + Static Constructor + + + + + + Dispose excelEngine member. + + + + + Creates a new workbook. The new workbook becomes the active Workbook. + + Number of Worksheets in the workbook. + Added Workbook object. + + + + Creates a new workbook and the worksheets are named using the names supplied. + The new workbook becomes the active workbook. + + Names of the Worksheets in the Workbook. + Added Workbook object. + + + + Closes the Workbook object. + + + + + Creates a workbook using the template file. + + + Workbook created from template. + + + + Creates a workbook using the template file stream. + + Base stream to create. + Workbook created from template. + + + + Opens the workbook in the specified location. + + + Opened workbook object. + + + + Opens a workbook in the form of a stream. + + + Opened workbook object. + + + + Not required. Obsolete. + + + + + Copies workbook from the clipboard. + + Pasted workbook object. + + + + Determines if an exception is thrown when there are unsaved workbook objects. Default is + True. + + + + + Each cell range address (called an ADDR structure) contains 4 16-bit values. + Cell range address, BIFF8: + + + + + Index to first row. + + + + + Index to last row. + + + + + Index to first column. + + + + + Index to last column. + + + + + Initializes new instance. + + First row. + First column. + Last row. + Last column. + + + + Initializes new instance. + + Index of the top left cell. + Index of the bottom right cell. + + + + Initializes new instance. + + Rectangle containing initialization data. + + + + Converts object to the string. + + + + + Converts structure to rectangle. + + Created rectangle. + + + + Index to first column. + + + + + Index to first row. + + + + + Index to last column. + + + + + Index to last row. + + + + + Summary description for ArrayRecord. + + + + + Interface for shared formula and array formula. + + + + + Index to first row of the array formula range. + + + + + Index to last row of the array formula range. + + + + + Index to first column of the array formula range. + + + + + Index to last column of the array formula range. + + + + + Parsed formula. + + + + + Summary description for IFormulaRecord. + + + + + Gets/sets parsed formula tokens. + + + + + Minimum size of the record. + + + + + Offset to the formula data. + + + + + First row. + + + + + Last row. + + + + + First row. + + + + + Last row. + + + + + Option flags. + + + + + Indicates whether formula value should always be recalculated. + + + + + Indicates whether formula value should be recalculated when the file is opened. + + + + + Unused must be 0. + + + + + Length of the parsed expression. + + + + + Formula expression. + + + + + + + + + + Default Constructor. + + + + + Read / initialize Constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for the record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Size of the required storage space. Read-only. + + + + + Serializes area that is covered by array formula. + + Object that contains dimensions data. + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Updated offset. + + + + Serializes area that is covered by array formula. + + Object that receives dimensions data. + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Updated offset. + + + + 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. + + + + Serves as a hash function for a particular type. + + A hash code for the current Object. + + + + + + + + + + Index to first row of the array formula range. Zero-based. + + + + + Index to last row of the array formula range. Zero-based. + + + + + Index to first column of the array formula range. Zero-based. + + + + + Index to last column of the array formula range. Zero-based. + + + + + Read-only. Size of the formula data. + + + + + Token array of the shared formula. + + + + + + + + + + Read-only. Reserved. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Indicates whether formula value should be always recalculated. + + + + + Indicates whether formula value should be recalculated when the file is opened. + + + + + Option flags. + + + + + Summary description for AutoFilterInfoRecord. + + + + + Number of AutoFilter drop-down arrows on the sheet. + + + + + Default constructor fills all data with default values. + + + + + Read / initialize Constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + + + + + + Read-only. Maximum possible size of the record. + + + + + Read-only. Minimum possible size of the record. + + + + + Number of AutoFilter drop-down arrows on the sheet. + + + + + Summary description for AutoFilterInfoRecord. + + + + + Size of the record. + + + + + Bit mask of the number of items to show. + + + + + + + + + + + + + + + + + + + + Offset to the start of additional data in the internal data array. + + + + + Number of AutoFilter drop-down arrows on the sheet. + + + + + Option flags. + + + + + True if the custom filter conditions are ANDed; + False if the custom filter conditions are ORed. + + + + + True if the first condition is a simple equality. + + + + + True if the second condition is a simple equality. + + + + + True if the condition is a Top 10 AutoFilter. + + + + + True if the Top 10 AutoFilter shows the top items; + False if it shows the bottom items. + + + + + True if the Top 10 AutoFilter shows percentage; + False if it shows items. + + + + + Structure for the first filter condition. + + + + + Structure for the second filter condition. + + + + + Default constructor fills all data with default values. + + + + + Read / initialize Constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + + + + + + Read-only. Minimum possible size of the record. + + + + + Number of AutoFilter drop-down arrows on the sheet. + + + + + Option flags. Read-only. + + + + + True if the first condition is a simple equality. + + + + + True if the second condition is a simple equality. + + + + + True if the condition is a Top 10 AutoFilter. + + + + + True if the Top 10 AutoFilter shows the top items; + False if it shows the bottom items. + + + + + True if the Top 10 AutoFilter shows percentage; + False if it shows items. + + + + + True if the custom filter conditions are ANDed; + False if the custom filter conditions are ORed. + + + + + Number of elements to show in Top10 mode. + + + + + First condition. + + + + + Second condition. + + + + + If filtered to blanks - true. Read-only. + + + + + If filtered to nonblanks - true. Read-only. + + + + + + + + + + Record size + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + String value if there is some. + + + + + Extracts data from data provider. + + Object that provides access to the data. + Offset in the provider to the start of the record's data. + Size of the parsed data. + + + + Extracts additional data from specified provider, if necessary. + + Object that provides access to the data. + Offset in the provider to the start of the record's data. + Size of the parsed data. + + + + Serializes record into specified data provider. + + Object that provides access to the data. + Offset in the provider to the start of the record's data. + Size of the serialized data. + + + + Serializes additional data. + + Object that provides access to the data. + Offset in the destination array to the start of the data. + Size of the additional data. + + If data is null. + + + When iOffset is too big or size of the data array is too small + and additional data can't be fit into the data array. + + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Data type. + + + + + Comparison sign. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets / sets length of the string (the string is stored after DOPER structures). + + + + + String value if there is some. + + + + + + + + + + DOPER data type. + + + + + Represents the FilterNotUsed data type. + + + + + Represents the RKNumber data type. + + + + + Represents the Number data type. + + + + + Represents the String data type. + + + + + Represents the BoolOrError data type. + + + + + Represents the MatchBlanks data type. + + + + + Represents the MatchNonBlanks data type. + + + + + DOPER comparison sign types. + + + + + Represents the Less comparison sign type. + + + + + Represents the Equal comparison sign type. + + + + + Represents the LessOrEqual comparison sign type. + + + + + Represents the Greater comparison sign type. + + + + + Represents the NotEqual comparison sign type. + + + + + Represents the GreaterOrEqual comparison sign type. + + + + + Boolean specifying whether the GUI should store a backup of the file while saving. + + + + + If True, then create backup file on saving. + + + + + Default constructor. Sets all fields to default values. + + + + + Read / initialize Constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for the record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + If True, then create backup file on saving. + + + + + Minimum possible record size. + + + + + Maximum possible record size. + + + + + The begin record defines the start of a block of records for a (Graphing) + data object. This record is matched with a corresponding EndRecord. + + + + + Summary description for BiffRecordRawWithArray. + + + + + Array that contains record data. + + + + + True if internal data array will be automatically resized + if there is not enough space for record data. + + + + + Default constructor, gets code value using reflection and attributes. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Read / initialize constructor. + + BinaryReader from which record data should be read. + Size of the read item. + + When specified reader is NULL. + + + + + Reserved for record's internal data array iReserve bytes. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + + + + + + Save record data to stream. + + Writer that will receive record data. + Object that provides access to the data. + Object to encrypt data. + Position in the output stream. Used to increase performance. + Size of the record. + If writer is NULL. + + If m_iLength of internal record data array is less than zero. + + + + + Save record data to stream. + + Writer that will receive record data. + Object to encrypt data. + Position in the output stream, used to reduce Flush + calls of the writer.BaseStream. + Size of the record. + If writer is NULL. + + If m_iLength of internal record data array is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, the class must pack all of its properties into + an internal Data array: m_data. This method is called by + FillStream, when the record must be serialized into stream. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + + + Get array of bytes from internal record data. + + Offset of first byte of data to get. + Length of required array. + Array of bytes from internal record data. + + If offset is less than zero or more than internal record data array size + or length is less than zero or more than internal record data array size + or length plus offset is more than internal record data array size. + + + + + Gets single byte from internal record data using GetBytes. + + Offset of byte to get. + Single byte from internal record data. + + + + Gets ushort from internal record data using GetBytes. + + Offset in bytes of ushort to get. + Ushort from internal record data. + + + + Gets short from internal record data using GetBytes. + + Offset in bytes of short to get. + Short from internal record. + + + + Gets int from internal record data using GetBytes. + + Offset in bytes of int to get. + Int from internal record. + + + + Gets uint from internal record data using GetBytes. + + Offset in bytes of uint to get. + Uint from internal record data. + + + + Gets long from internal record data using GetBytes. + + Offset in bytes of long to get. + Long from internal record data. + + + + Gets ulong from internal record data using GetBytes. + + Offset in bytes of ulong to get. + Ulong from internal record data. + + + + Gets float from internal record data using GetBytes. + + Offset in bytes of float to get. + Float from internal record data. + + + + Gets double from internal record data using GetBytes. + + Offset in bytes of double to get. + Double from internal record data. + + + + Gets single bit from internal record data using GetBytes. + + Offset of the byte that contains needed bit. + Position of bit in the byte. + True if specified bit is set to 1; otherwise False. + + bitPos argument should be not less than zero and not more than 7. + + + + + Gets string from internal record data using GetBytes, + and it increases the offset by string size in bytes. + + Offset of starting byte. + Indicates whether extracted string is ascii string (not unicode). + Retrieved string. + + if Offset + iStrLen is out of data array + + + + + Gets string from internal record data using GetBytes, + and it increases the offset by string size in bytes. + + Offset of starting byte. + Retrieved string. + + if Offset + iStrLen is out of data array + + + + + Gets string from internal record data using GetBytes + and it increases offset by string size in bytes. + + Offset of starting byte. + Length of the string. + Retrieved string. + + if Offset + iStrLen is out of data array + + + + + Gets string from internal record data using GetBytes. + + Offset of starting byte. + Retrieved string. + + if Offset + iStrLen is out of data array + + + + + Gets string from internal record data using GetBytes. + + Offset of starting byte. + Returns size of the read data. + Retrieved string. + + if Offset + iStrLen is out of data array + + + + + Gets string from internal record data using GetBytes. + + Offset of starting byte. + Length of the string. + Retrieved string. + + if Offset + iStrLen is out of data array + + + + + Gets string from internal record data using GetBytes. + + Offset of starting byte. + Length of the string. + Gets bytes count that this string occupies in the data array. + Retrieved string. + + + + Gets string from internal record data using GetBytes. + + Offset of starting byte. + Length of the string. + Gets bytes count that this string occupies in the data array. + Flag for is bytes count available. + Retrieved string. + + + + Detect type of string and extracts it. + + Record data offset. + Contain next position. + Number of elements in the continuePos collection. + Current index in the continuePos array. + Length of string record. + Array of rich formatting values. + Array of unknown FarEast data. + Extracted string. + + + + Gets TAddr structure from internal record data. + + Offset in bytes of TAddr structure to get. + Retrieved TAddr structure. + + + + Gets TAddr structure from internal record data. + + Offset in bytes of TAddr structure to get. + Retrieved TAddr structure. + + + + Enlarges the internal record data array to facilitate + at least offset + length of data to be placed. + + Offset to the accessed data. + Length of the needed data. + + + + Reserve memory for internal array. + + Number of bytes that should be reserved. + + + + Sets bytes in internal record data array values. + + Offset in internal record data array to start from. + Array of bytes to set. + Position in value array to the data that will be set. + Length of the data. + If value array is NULL. + + If pos or length would be less than zero or their sum would be more + than size of value array. + + + If internal record data array is too small for receiving value array + and AutoGrowData is False. + + + + + Sets bytes in internal record data array values. + + Offset in internal record data array to start from. + Array of bytes to set. + If value array is NULL. + + If pos or length would be less than zero or their sum would be more + than size of value array. + + + If internal record data array is too small for receiving value array + and AutoGrowData is False. + + + + + Sets single byte in internal record data array using SetBytes method. + + Offset to the required byte. + New value for the byte. + + + + + + + + + + + + Sets ushort in internal record data array using SetBytes method. + + Offset to the required value. + New value for the specified ushort. + + + + Sets short in internal record data array using SetBytes method. + + Offset to the required value. + New value for the specified short. + + + + Sets int in internal record data array using SetBytes method. + + Offset to the required value. + New value for the specified int. + + + + Sets uint in internal record data array using SetBytes method. + + Offset to the required value. + New value for the specified uint. + + + + Sets long in internal record data array using SetBytes method. + + Offset to the required value. + New value for the specified long. + + + + Sets ulong in internal record data array using SetBytes method. + + Offset to the required value. + New value for the specified ulong. + + + + Sets float in internal record data array using SetBytes method. + + Offset to the required value. + New value for the specified float. + + + + Sets double in internal record data array using SetBytes method. + + Offset to the required value. + New value for the specified double. + + + + Sets one bit in specified byte in internal record data array. + + Offset of the byte in the internal record data array. + Value of bit. + Bit position in the byte. + + If bitPos is less than zero or more than 7. + + + + + Sets string in internal record data array using SetBytes method + without string length, updates offset parameter (adds string length). + + Offset to the string. + Value of the string. + Indicates whether string should be compressed or not. + + + + Sets string in internal record data array using SetBytes method + without string length. + + Offset to the string. + Value of the string. + Size of the string in bytes. + + + + Detects whether specified string contains only characters supported by ASCII encoding. + + String to check. + True if this string is fully supported by ASCII encoding. + + + + Sets string in internal record data array using SetBytes method + without string length. + + Offset to the string. + Value of the string. + Size of the string in bytes. + + + + Sets string in internal record data array using SetBytes method + without string length. + + Offset to the string. + Value of the string. + Indicates whether write compressed attribute for empty strings. + Indicates whether to write compressed (ascii) string or not. + Size of the string in bytes. + + + + Sets string in internal record data array using SetBytes method. + The String length is saved in one byte. + + Offset to the string. + Value of the string. + Size of the string data. + + + + Sets string in internal record data array using SetBytes method. + The String length is saved in two bytes. + + Offset to the string. + Value of the string. + Size of the string in bytes. + + + + Sets string in internal record data array using SetBytes method. + The String length is saved in two bytes. + + Offset to the string. + Value of the string. + Indicates whether write compressed attribute for empty strings. + Indicates whether string should be compressed or not. + Size of the string in bytes. + + + + Sets string in internal record data array using SetBytes method. + The String length is saved in two bytes + + Offset to the string. + Value of the string. + + + + Sets string in internal record data array using SetBytes method. + The String length is saved in two bytes + + Offset to the string. + Value of the string. + Indicates whether string should be compressed or not. + + + + Sets TAddr structure in internal record data. + + Offset in bytes of TAddr structure to set. + New value of the TAddr at the specified position. + + + + Sets TAddr structure in internal record data. + + Offset in bytes of TAddr structure to set. + New value of the Rectangle at the specified position. + + + + Method extracts from class its fields which have the custom attribute: + BiffRecordPosAttribute. Method returns two arrays sorted in special + order, the order of extraction and saving from/to stream. + + Returns Sorted Fields. + + + + Algorithm extracts field values from internal data storage. + + + + + Gets value of the field by BiffRecordPosAttribute. + + BiffRecordPosAttribute that describes required field. + Value of the field. + + + + Method tries by metadata information fill internal array + of record. + + Size of the filled data. + + + + Sets value of the specified field. + + BiffRecordPosAttribute that describes required field. + New field value. + Size of the used data. + + + + Clears internal data array. + + + + + Compares two Biff records. + + Biff record that should be compared with this Biff record. + True if this instance and extFormat contain the same data. + + + + Copies data from the current Biff record to the specified Biff record. + + Biff record that will receive data from the current record. + + When this record and parameter have different types. + + + + + + + + + + + + + + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + + + + Size of the required storage space. Read-only. + + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + + + + + + Read-only. Returns record data. + + + + + If True, the array will automatically grow when the offset limit + is reached. This is required when the real record size is not known for an + Infill operation. Will throw exception on buffer offset overrun + when set to False. Default value is False. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, the class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + + + + Read-only. Maximum possible size of the record. + + + + + This record is part of the Page Settings Block. + It stores the background bitmap of a worksheet. + + + + + BifRecords container. + + + + + + + + + + + + + + + Array that contains positions of data of the continue records + in the m_data array. + + + + + + + + + + Default constructor fills all data with default values. + + + + + Read / Initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array iReserve bytes. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + This method constitutes the main part of parsing with continue records. + For inheritors this method must be called to get Continue records + which is placed after this record in the input stream. + + + + + + + + + + Creates continue record builder. + + Created builder. + + + + Read from stream record data. + + Stream with record data. + Object that provides access to the data. + Object that should be used to parse encrypted records. + Temporary buffer needed for some operations. + Size of the record data. + If reader is NULL. + + If stream is not big enough for data (end of stream + reached and all data were not read). + + + If record code is zero. + + + + + Save record data to stream. + + Writer that will receive record data. + Object to encrypt data. + Position in the output stream, used to reduce Flush + calls of the writer.BaseStream. + Size of the record in the stream. + If writer is NULL. + + If m_iLength of internal record data array is less than zero. + + + + + Extracts all continue records from the stream if needed and updates internal data array. + + True if there was extracted any continue record. + + + + Returns List with byte arrays with continue record's data. + + Full length of the additional data. + Last position in the stream. + List with byte arrays with continue record's data. + + + + Adds record data from single record to the List. + + List to add data to. + Record to add data from. + Size of the added data. + + + + OnFirstContinue event handler. + + Event sender. + Event arguments. + + + + + + + + + + Creates copy of the current object. + + A copy of the current object. + + + + + + + + + Pixel rows in bitmap are aligned to this number of bytes. + + + + + Header start. + + + + + Unknown value. + + + + + Unknown value. + + + + + Total size of the following record data, without this field (including CONTINUE records). + + + + + Header structure size. + + + + + Width of the picture, in pixel. + + + + + Height of the picture, in pixel. + + + + + Number of planes, must be 1. + + + + + Color depth, must be 24 bit true-color. + + + + + Image contained in the record. + + + + + Allocated unmanaged memory. + + + + + Default Constructor + + + + + Read / initialize Constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for the record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, the class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + + + + Infills record header. + + Size of the record header. + + + + Unknown value. + + + + + Unknown value. + + + + + Total size of the following record data, without this field (including CONTINUE records). + + + + + Header structure size. + + + + + Width of the picture, in pixel. + + + + + Height of the picture, in pixel. + + + + + Number of planes, must be 1. + + + + + Color depth, must be 24 bit true-color. + + + + + Image. + + + + + This record represents an empty cell. + It contains the cell address and formatting information. + + + + + This is parent class for all records that have cell position elements inside. + + + + + Zero-based row index. + + + + + Zero-based column index. + + + + + Index to the cell's extended format. + + + + + Default constructor + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + Returns size of the required storage space. + + Excel version. + Size of the required storage space. + + + + Row zero-based index. + + + + + Column zero-based index. + + + + + Index of extended format. + + + + + Size of the record's data. + + + + + Record size with header. + + + + + Default constructor that fills all data with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + Returns size of the required storage space. + + Excel version. + Size of the required storage space. + + + + Read-only. Returns minimum possible size of the record's + internal data array. + + + + + Read-only. Returns maximum possible size of the record's + internal data array. + + + + + Summary description for BOFRecord. + It is used for the beginning of a set of + records that have a particular purpose or subject. + Used in sheets and workbooks. + + + + + Summary description for _BiffRecordRawWithStreamPos. + + + + + Position of the Biff record in the stream. + + + + + Default constructor, gets code value using reflection and attributes. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Read / initialize constructor. + + BinaryReader from which record data should be read. + Size of the read item. + + When specified reader is NULL. + + + + + Reserved for record's internal data array iReserve bytes. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Indicates record position in stream. This is a utility member of class and + is used only in the serialization process. Does not influence the data. + + + + + Represents the record size. + + + + + Version: + + + + + Type of the following data: + + + + + Build identifier: + + + + + Build year: + + + + + File history flag: + + + + + Lowest Excel version that can read all records in this file: + + + + + + + + + + Default Constructor + + + + + Read / initialize Constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for the record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Version: + + + + + Type of the following data: + + + + + Build identifier: + + + + + Build year: + + + + + File history flag: + + + + + Lowest Excel version that can read all records in this file. + + + + + Read-only. Returns minimum possible size of record. + + + + + Read-only. Returns maximum possible size of record. + + + + + + + + + + Indicates whether record allows shorter data. Read-only. + + + + + Indicates whether record need decoding when file is encoded or not. Read-only. + + + + + This enum that describes all possible data after this BOF record. + + + + + Represents the workbook data. + + + + + Represents the vb_module data. + + + + + Represents the worksheet data. + + + + + Represents the chart data. + + + + + Represents the excel_4_macro data. + + + + + Represents the workspace file data. + + + + + Summary description for BookBoolRecord. + Saves External Links record. + Contains a flag specifying whether the GUI should save externally + linked values from other workbooks. + + + + + 0 = Save external linked values. 1 = Do not save external linked values. + + + + + Default Constructor + + + + + Read / initialize Constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + If zero, then save external linked values. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's internal + data array. + + + + + This record represents a Boolean value or error value cell. + + + + + Interface for records that have Value property. + + + + + Value of the record. + + + + + Size of the record. + + + + + Boolean or error value (type depends on the m_bIsErrorCode). + + + + + False = Boolean value; True = Error code. + + + + + Default Constructor that fills all data with default values. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + Returns size of the required storage space. + + Excel version. + Size of the required storage space. + + + + Reads record's value from the data provider. + + Provider to read data from. + Offset to the record's start. + Excel version that was used to infill. + Record's value (BoolOrError and IsErrorCode). + + + + Boolean or error value (type depends on the IsError property). + + + + + False = Boolean value; True = Error code. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Value of the record. + + + + + + Summary description for BoundSheetRecord. + This record is located in the workbook globals area and represents a sheet inside + of the workbook. A record is written for each sheet. It stores the sheet name and + a stream offset to the BOF record within the workbook stream. + + + + + Absolute stream position of the BOF record of the sheet represented by this record. + + + + + Options: Visibility and sheet type. + + + + + Sheet type: + 0x00 = Worksheet + 0x02 = Chart + 0x06 = Visual Basic module + + + + + Sheet name. + + + + + Helper field of record. Value is not stored as a record structure field. + This index is used by the UpdateOffsets method for detecting the corresponding BOF + field. + + + + + BOF record that should be referenced. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + This method checks the record's internal data array for integrity. + + + If there is any internal error. + + + + + + + + Object that provides access to the data. + Object to encrypt data. + Position in the output stream. Used to increase performance. + + + + + Size of the required storage space. Read-only. + + + + + Absolute stream position of the BOF record of the sheet represented by this record. + + + + + Sheet name as a unicode string. + + + + + Helper field of record. Value is not stored as a record structure field. + This index is used by the UpdateOffsets method for detecting the corresponding BOF + field. + + + + + Sheet type. + + + + + Visibility type of Bound. + + + + + Read-only. Returns minimum possible size of the record's + internal data array. + + + + + Gets / sets BOF record that should be referenced. + + + + + Returns offset in the data array where encoded/decoded data should start. Read-only. + + + + + Possible sheet types. + + + + + Represents the Worksheet sheet type. + + + + + Represents the Chart sheet type. + + + + + Represents the VisualBasicModule sheet type. + + + + + Summary description for ByteArrayDataProvider. + + + + + Summary description for DataProvider. + + + + + Default constructor. + + + + + + + + + + Returns bit value at the specified position. + + Offset to the required value. + Bit index in the byte. + Bit at the specified position. + + + + Returns byte value at the specified position. + + Offset to the required value. + Byte at the specified position. + + + + Returns boolean value at the specified position. + + Offset to the required value. + Byte at the specified position. + + + + Returns Int16 value at the specified position. + + Offset to the required value. + Int16 value at the specified position. + + + + Returns UInt16 value at the specified position. + + Offset to the required value. + Int16 value at the specified position. + + + + Returns Int32 value at the specified position. + + Offset to the required value. + Int32 value at the specified position. + + + + Returns Int32 value at the specified position. + + Offset to the required value. + Int32 value at the specified position. + + + + Returns Int32 value at the specified position. + + Offset to the required value. + Int32 value at the specified position. + + + + Returns Int32 value at the specified position. + + Offset to the required value. + Int32 value at the specified position. + + + + Copies data from internal storage into specified data array. + + Source offset. + Destination array. + Destination offset. + Size in bytes of the data to copy. + + + + Copies data from internal storage into specified provider. + + Source offset. + Destination provider. + Destination offset. + Size in bytes of the data to copy. + + + + Reads data from BinaryReader. + + Reader to get data from. + Offset in the internal data to start filling from. + Number of bytes to read. + Temporary buffer to use. + + + + Reads data from BinaryReader. + + Reader to get data from. + Offset in the internal data to start filling from. + Number of bytes to read. + Temporary buffer to use. + Object used to decrypt data if necessary. + + + + Gets string from internal data and returns it's length in iFullLength parameter. + + Offset to the string data. + Length of the string in bytes. + Parsed string. + + When data array is smaller than the string that should be in it. + + + + + Gets string from internal data and updates offset. + + Offset to the string data. + Parsed string. + + When data array is smaller than the string that should be in it. + + + + + Gets string from byte array and returns it's length in iFullLength parameter. + + Offset to the string data. + Length of the string in bytes. + Parsed string. + + When data array is smaller than the string that should be in it. + + + + + Reads data array from another data array. + + Source offset. + Destination array. + Updated source offset. + + + + Reads data array from another data array. + + Source offset. + Destination array. + Number of bytes to read. + Updated source offset. + + + + Gets string from internal record data using GetBytes. + + Offset of starting byte. + Length of the string. + Gets bytes count that this string occupies in the data array. + Flags that represent is bytes count available. + Retrieved string. + + + + Gets string from internal record data using GetBytes + and it increases offset by string size in bytes. + + Offset of starting byte. + Length of the string. + Retrieved string. + + if Offset + iStrLen is out of data array + + + + + Reads string from data provider. + + Offset to the first character. + Number of bytes in the string. + Encoding to use. + Indicates whether string is unicode. + Extracted string. + + + + Gets TAddr structure from internal data. + + Offset in bytes of TAddr structure to get. + Retrieved TAddr structure. + + + + Gets TAddr structure from internal data. + + Offset in bytes of TAddr structure to get. + Retrieved TAddr structure. + + + + Saves data into binary writer. + + Writer to save data into. + Start offset in the internal storage. + Number of bytes to save. + Temporary buffer to use. + + + + Writes byte value at the specified position. + + Offset to the required value. + Byte value to write at the specified position. + + + + Writes Int16 value at the specified position. + + Offset to the required value. + Int16 value to write at the specified position. + + + + Writes Int16 value at the specified position. + + Offset to the required value. + Int16 value to write at the specified position. + + + + Writes Int16 value at the specified position. + + Offset to the required value. + Int32 value to write at the specified position. + + + + Writes Int16 value at the specified position. + + Offset to the required value. + Int32 value to write at the specified position. + + + + Writes Int16 value at the specified position. + + Offset to the required value. + Int32 value to write at the specified position. + + + + Sets one bit in specified byte in internal record data array. + + Offset of the byte in the data array. + Bit position in the byte. + Value of bit. + + If bitPos is less than zero or more than 7. + + + + + Writes Double value at the specified position. + + Offset to the required value. + Double value to write at the specified position. + + + + Sets string in internal data. The String length is saved in two bytes. + + Offset to the string. + Value of the string. + + + + Sets string in internal data. The String length is saved in two bytes. + + Offset to the string. + Value of the string. + + + + Sets string in internal data. The String length is saved in two bytes. + + Offset to the string. + Value of the string. + Indicates whether string should be stored as unicode. + + + + Sets string in internal data. The String length is saved in two bytes. + + Offset to the string. + Value of the string. + Size of the written data. + + + + Sets string in internal data. The String length is saved in two bytes. + + Offset to the string. + Value of the string. + Indicates whether string should be stored in unicode format. + Size of the written data. + + + + Sets string in internal record data without string length, + updates offset parameter (adds string length). + + Offset to the string. + Value of the string. + + + + Sets string in internal record data without string length, + updates offset parameter (adds string length). + + Offset to the string. + Value of the string. + Indicates whether string should be stored in Unicode encoding or not. + + + + Sets bytes in internal record data array values. + + Offset in internal record data array to start from. + Array of bytes to set. + If value array is NULL. + + If pos or length would be less than zero or their sum would be more + than size of value array. + + + If internal record data array is too small for receiving value array + and AutoGrowData is False. + + + + + Sets bytes in internal record data array values. + + Offset in internal record data array to start from. + Array of bytes to set. + Position in value array to the data that will be set. + Length of the data. + If value array is NULL. + + If pos or length would be less than zero or their sum would be more + than size of value array. + + + If internal record data array is too small for receiving value array + and AutoGrowData is False. + + + + + Sets TAddr structure in internal record data. + + Offset in bytes of TAddr structure to set. + New value of the TAddr at the specified position. + + + + Sets TAddr structure in internal record data. + + Offset in bytes of TAddr structure to set. + New value of the Rectangle at the specified position. + + + + Moves memory inside internal buffer. + + Destination offset. + Source offset. + Memory size. + + + + Copies memory inside internal buffer. + + Destination offset. + Source offset. + Memory size. + + + + Resizes internal storage if necessary. + + Required size. + + + + Resizes internal storage if necessary. + + + + + + + + Writes zeros inside memory block. + + + + + Clears internal storage if allowed. + + + + + Creates data provider of the same type. + + Created data provider. + + + + + + + + + Dispose DataProvider + + + + + + + + + + Returns size of the internal buffer. Read-only. + + + + + Indicates whether data provider was cleared. + + + + + Pointer to the data array. + + + + + Default constructor to prevent creation of items without arguments. + + + + + Creates new instance of this class. + + Array to read data from. + + + + Returns byte value at the specified position. + + Offset to the required value. + Byte at the specified position. + + + + Returns Int16 value at the specified position. + + Offset to the required value. + Int16 value at the specified position. + + + + Returns Int32 value at the specified position. + + Offset to the required value. + Int32 value at the specified position. + + + + Returns Int32 value at the specified position. + + Offset to the required value. + Int32 value at the specified position. + + + + Copies data from internal storage into specified + + Source offset. + Destination array. + Destination offset. + Size in bytes of the data to copy. + + + + Copies data from internal storage into specified provider. + + Source offset. + Destination provider. + Destination offset. + Size in bytes of the data to copy. + + + + Reads data from BinaryReader. + + Reader to get data from. + Offset in the internal data to start filling from. + Number of bytes to read. + Temporary buffer needed for some operations. + + + + Reads string from data provider. + + Offset to the first character. + Number of bytes in the string. + Encoding to use. + Indicates is unicode encoding. + Extracted string. + + + + Resizes internal storage if necessary. + + Required size. + + + + Resizes internal storage if necessary + + + + + + + + Writes zeros inside memory block. + + + + + Writes byte value at the specified position. + + Offset to the required value. + Byte value to write at the specified position. + + + + Writes Int16 value at the specified position. + + Offset to the required value. + Int16 value to write at the specified position. + + + + Writes Int16 value at the specified position. + + Offset to the required value. + Int16 value to write at the specified position. + + + + Writes Int32 value at the specified position. + + Offset to the required value. + Int32 value to write at the specified position. + + + + Writes Int32 value at the specified position. + + Offset to the required value. + Int32 value to write at the specified position. + + + + Sets one bit in specified byte in internal record data array. + + Offset of the byte in the data array. + Bit position in the byte. + Value of bit. + + If bitPos is less than zero or more than 7. + + + + + Writes Int32 value at the specified position. + + Offset to the required value. + Double value to write at the specified position. + + + + Sets string in internal data without string length, + updates offset parameter (adds string length). + + Offset to the string. + Value of the string. + Indicates whether to use unicode encoding or not. + + + + Sets bytes in internal record data array values. + + Offset in internal record data array to start from. + Array of bytes to set. + Position in value array to the data that will be set. + Length of the data. + If value array is NULL. + + If pos or length would be less than zero or their sum would be more + than size of value array. + + + If internal record data array is too small for receiving value array + and AutoGrowData is False. + + + + + Saves data into binary writer. + + Writer to save data into. + Start offset in the internal storage. + Number of bytes to save. + Temporary buffer to use. + + + + Updates internal buffer. + + New buffer to set. + + + + + + + + + Clears internal data. + + + + + Moves memory inside internal buffer. + + Destination offset. + Source offset. + Memory size. + + + + Copies memory inside internal buffer. + + Destination offset. + Source offset. + Memory size. + + + + Creates provider of the same type. + + Created provider object. + + + + Return internal buffer. Read-only. + + + + + Returns size of the internal buffer. Read-only. + + + + + + + + + + Specifies the maximum number of times the formulas should be iteratively calculated. + This is a fail-safe against mutually recursive formulas locking up + a spreadsheet application. + + + + + Correct record size. + + + + + Maximum number of iterations allowed in circular references. + + + + + Default Constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for the record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Maximum number of iterations allowed in circular references. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Specifies whether to calculate formulas manually, automatically, or automatically + except for multiple table operations. + + + + + Specifies whether to calculate formulas manually, automatically, or automatically + except for multiple table operations. See TCalcMode for possible values. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Specifies whether to calculate formulas manually, automatically, or automatically + except for multiple table operations. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + The begin record defines the start of a block of records for a (Graphing) + data object. This record is matched with a corresponding EndRecord. + + + + + Minimum size of the record. + + + + + Size of the first block of reserved bytes in the font block. + + + + + Size of the second block of reserved bytes in the font block. + + + + + Size of the third block of reserved bytes in the font block. + + + + + Mask for font posture bit. + + + + + Mask for font cancellation (strikethrough) bit. + + + + + Mask for font style modification bit. + + + + + Mask for font cancellation modification bit. + + + + + Mask for left border line style bits. + + + + + Mask for right border line style bits. + + + + + Mask for top border line style bits. + + + + + Mask for bottom border line style bits. + + + + + Mask for left border color bits. + + + + + Mask for right border color bits. + + + + + Mask for top border color bits. + + + + + Mask for bottom border color bits. + + + + + Start bit of left border color bits. + + + + + Start bit of right border color bits. + + + + + Start bit of top border color bits. + + + + + Start bit of bottom border color bits. + + + + + Mask for fill pattern bits. + + + + + Mask for pattern color bits. + + + + + Mask for pattern backcolor bits. + + + + + Start bit of fill pattern bits. + + + + + Start bit of fill pattern back color bits. + + + + + Size of the font block. + + + + + Size of the border block. + + + + + Size of the pattern block. + + + + + Size of the number format block. + + + + + Default color index. + + + + + Type of the conditional formatting: + + 01H = Compare with current cell value + (the comparison specified below is used) + + 02H = Evaluate a formula (condition is met + if formula evaluates to a value not equal to 0) + + + + + Comparison operator: + 00H = No comparison (only valid for formula type, see above) + 01H = Between + 02H = Not between + 03H = Equal + 04H = Not equal + 05H = Greater than + 06H = Less than + 07H = Greater or equal + 08H = Less or equal + + + + + Size of the formula data for first value or formula. + + + + + Size of the formula data for second value or formula + (sz2, used for second part of �Between� and �Not between� + comparison, this field is 0 for other comparisons). + + + + + Option flags + + + + + Not used + + + + + False if left border style and color are modified. + + + + + False if right border style and color are modified. + + + + + False if top border style and color are modified. + + + + + False if bottom border style and color are modified. + + + + + False if pattern style is modified. + + + + + False if pattern color is modified. + + + + + False if pattern background color is modified. + + + + + False if the number format is modified. + + + + + True if record contains number format. + + + + + True if record contains font formatting block. + + + + + True if record contains border formatting block. + + + + + True if record contains pattern formatting block. + + + + + True if record contains the user defined number format. + + + + + Font height. + + + + + Font options. + + + + + Font weight (100-1000, only if font - style = 0). + Standard values are 0190H (400) for normal text + and 02BCH (700) for bold text. + + + + + Escapement type (only if font - esc = 0): + 0000H = None; 0001H = Superscript; 0002H = Subscript + + + + + Underline type (only if font - underl = 0): + 00H = None + 01H = Single + 02H = Double + 21H = Single accounting + 22H = Double accounting + + + + + Font color index or FFFFFFFFH to preserve the cell font color: + + + + + Option flags for modified font attributes: + + + + + 0 = Escapement type modified + + + + + 0 = Underline type modified: + + + + + Represents the text value. + + + + + Border line styles: + + + + + Border line colour indexes: + + + + + Fill pattern style: + + + + + Fill pattern color indexes: + + + + + Unused + + + + + Unsigned integer that specifies the identifier of the number format. + + + + + + Formula data for second value or formula (RPN token array without size field): + + + + + + + + + + + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserves for record's internal data array iReserve bytes. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Parses font block if it is present in the conditional format. + + Object that provides access to the data. + + Offset to the font block data in the internal data array. + + + + + Parses border block if it is present in the conditional format. + + Object that provides access to the data. + + Offset to the border block data in the internal data array. + + + + + Parses pattern block if it is present in the conditional format. + + Object that provides access to the data. + + Offset to the pattern block data in the internal data array. + + + + + Parses number format block if it is present in the conditional format. + + Object that provides access to the data. + + Offset to the number format block data in the internal data array. + + + + + Writes font block into internal data array + if it is present in the conditional format. + + Object that provides access to the data. + + Offset where font block should be written. + + + + + Writes border block into internal data array + if it is present in the conditional format. + + Object that provides access to the data. + + Offset where border block should be written. + + + + + Writes pattern block into internal data array + if it is present in the conditional format. + + Object that provides access to the data. + + Offset where pattern block should be written. + + + + + Writes number format block into internal data array + if it is present in the conditional format. + + Object that provides access to the data. + + Offset where number format block should be written. + + + + + Size of the required storage space. Read-only. + + + + + Clones current instance. + + Returns new instance. + + + + Serves as a hash function for a particular type, suitable for use in + hashing algorithms and data structures like a hash table. + + A hash code for the current Object. + + + + A hash code for the current Object without taking cell list into account. + + The Object to compare with the current Object. + + + + + Type of the conditional formatting: + + 01H = Compare with current cell value + (the comparison specified below is used) + + 02H = Evaluate a formula (condition is met + if formula evaluates to a value not equal to 0) + + + + + Comparison operator: + 00H = No comparison (only valid for formula type, see above) + 01H = Between + 02H = Not between + 04H = Not equal + 05H = Greater than + 06H = Less than + 03H = Equal + 07H = Greater or equal + 08H = Less or equal + + + + + Size of the formula data for first value or formula. Read-only. + + + + + Size of the formula data for second value or formula + (sz2, used for second part of "Between" and "Not between" + comparison, this field is 0 for other comparisons). Read-only. + + + + + Option flags. + + + + + Not used. + + + + + True if left border style and color are modified. + + + + + True if right border style and color modified. + + + + + True if top border style and color are modified. + + + + + True if bottom border style and color are modified. + + + + + True if pattern style is modified. + + + + + True if pattern color is modified. + + + + + False if pattern background color is modified. + + + + + False if Number format is modified. + + + + + True if record contains font formatting block. + + + + + True if record contains border formatting block. + + + + + True if record contains pattern formatting block. + + + + + True if record contains Number format. + + + + + Read-only. Maximum possible size of the record. + + + + + Font height (in twips = 1/20 of a point); + or FFFFFFFFH to preserve the cell font height. + + + + + Posture: 0 = Normal; 1 = Italic + + + + + Cancellation: 0 = Off; 1 = On + + + + + Font weight (400 - Normal text, 700 - Bold text). + + + + + Escapement type. + + + + + Underline type. + + + + + Font color index; or FFFFFFFFH to preserve the cell font color. + + + + + Indicates whether font style (posture or boldness) was modified. + + + + + Indicates whether font cancellation was modified. + + + + + Indicates whether font escapment was modified. + + + + + Indicates whether font underline was modified. + + + + + True if number format is user defined. + + + + + + Left border line style. + + + + + Right border line style. + + + + + Top border line style. + + + + + Bottom border line style. + + + + + Color index for left line. + + + + + Color index for right line. + + + + + Color index for top line. + + + + + Color index for bottom line. + + + + + Fill pattern style. + + + + + Color index for pattern. + + + + + Color index for pattern background. + + + + + Parsed first formula string. + + + + + Parsed second formula string. + + + + + Returns bytes of the first formula. Read-only. + + + + + Returns bytes of the second formula. Read-only. + + + + + + + + + + + + + + + + + + + + + + + + + Default constructor, sets all fields default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + + + + + + + + + + + This record defines a 3D chart group and also contains generic formatting information. + + + + + Correct record size. + + + + + Rotation angle (0 to 360 degrees). + + + + + Elevation angle (�90 to +90 degrees). + + + + + Distance from eye to chart (0 to 100). + + + + + Height of plot volume relative to width and depth. + + + + + Depth of points relative to width. + + + + + Space between series. + + + + + Option flags. + + + + + Whether to use perspective transform. + + + + + 3-D columns are clustered or stacked. + + + + + Use auto scaling. + + + + + Reserved; must be one. + + + + + Use 2D walls and gridlines. + + + + + Indicates whether elevation has default value. + + + + + Indicates whether rotation has default value. + + + + + Default constructor, sets all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Opertaor to check if the record are equal + + + + + + + + Checks and returns if the records are not equal + + + + + + + + Rotation angle (0 to 360 degrees). + + + + + Elevation angle (�90 to +90 degrees). + + + + + Indicates whether rotation has default value. + + + + + Indicates whether elevation has default value. + + + + + Distance from eye to chart (0 to 100). + + + + + Height of plot volume relative to width and depth. + + + + + Depth of points relative to width. + + + + + Space between series. + + + + + Holder of flags. + + + + + Whether to use perspective transform. + + + + + 3D columns are clustered or stacked. + + + + + Use auto scaling. + + + + + Use 2D walls and gridlines. + + + + + This record specifies linked series data or text. + + + + + Link index identifier. + + + + + Reference type. + + + + + Option flags holder. + + + + + Index to number format record. + + + + + Size of parsed formula of link array. + + + + + True if this object has a custom number format; False if number format + is linked to data source. + + + + + + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Clones current record. + + Returns cloned object. + + + + Link index identifier. + + + + + Reference type. + + + + + Option flags holder. + + + + + Index to number format record. + + + + + Size of parsed formula of link array. + + + + + True if this object has a custom number format; False if number format + is linked to data source. + + + + + + + + + + Link index options. + + + + + Represents the LinkToTitleOrText link index option. + + + + + Represents the LinkToValues link index option. + + + + + Represents the LinkToCategories link index option. + + + + + Represents the LinkToBubbles link index option. + + + + + + + + + + Use default categories. + + + + + Text or value entered directly into the formula bar. + + + + + Linked to worksheet. + + + + + Not used. + + + + + Error reported. + + + + + This record specifies rich-text formatting (bold, italic, font changes, + etc.) within chart titles and data labels. + + + + + Number of rich-text runs. + + + + + + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Clones current record. + + Returns cloned object. + + + + Number of rich-text runs. + + + + + + + + + + + + + + + Size of the TRun item. + + + + + First char index. + + + + + Font index. + + + + + New paragarph start or not. + + + + + Creates new instance of TRuns. + + Base first char. + Base font index. + + + + + Gets or sets first char index. + + + + + Gets or sets font index. + + + + + Check the new paragarph start or not. + + + + + This record describes the patterns and colors used in a filled area. + + + + + Correct size of the record. + + + + + Foreground color (RGB). + + + + + Background color (RGB). + + + + + Pattern. + + + + + Storage for record bit flags. + + + + + Automatic format. + + + + + Foreground and background are swapped when the data value is negative. + + + + + Index of foreground color. + + + + + Background color index. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Foreground color (RGB). + + + + + Background color (RGB). + + + + + Pattern. + + + + + Holder of record flags. + + + + + Index of foreground color. + + + + + Background color index. + + + + + Automatic format or not. + + + + + Foreground and background are swapped when the data value is negative. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record defines an area chart group. + + + + + Contains information about chart type. + + + + + Indicates whether values should be stacked. + + + + + Indicates whether values should be shown as percents. + + + + + Record size. + + + + + Holder of all flags. + + + + + Series in this group are stacked. + + + + + Each category is broken down as a percentage. + + + + + This area has a shadow. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Holder of all flags. + + + + + Series in this group are stacked. + + + + + Each category is broken down as a percentage. + + + + + This area has a shadow. + + + + + + + + + + + + + + + The ATTACHEDLABEL record defines the data label type. The ATTACHEDLABEL + record applies to the label data identified in the associated + DATAFORMAT record. + + + + + Correct record size. + + + + + Holder of all record flags. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Holder of all record flags... changes of record setting does not + influence on this property value till serialization. + + + + + + + + + + Show value as a percent of the total. This bit applies only to pie charts. + + + + + Show category label and value as a percentage (pie charts only). + + + + + Show smoothed line. + + + + + Show category label. + + + + + Show bubble sizes. + + + + + Possible option flags + + + + + No option flag set. + + + + + Show the actual value of the data point. + + + + + Show value as a percent of the total. This bit applies only to pie charts. + + + + + Show category label and value as a percentage (pie charts only). + + + + + Show smoothed line. + + + + + Show category label. + + + + + Show bubble sizes. + + + + + This record defines axis options. + + + + + Correct record size. + + + + + Minimum category on axis. + + + + + Maximum category on axis. + + + + + Value of major unit. + + + + + Units of major unit. + + + + + Value of minor unit. + + + + + Units of minor unit. + + + + + Base unit of axis. + + + + + Crossing point of value axis (date). + + + + + Option flags. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + size of read item + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Minimum category on axis. + + + + + Maximum category on axis. + + + + + Value of major unit. + + + + + Units of major unit. + + + + + Value of minor unit. + + + + + Units of minor unit. + + + + + Base unit of axis. + + + + + Crossing point of value axis (date). + + + + + Holder of record flags. + + + + + Use default minimum. + + + + + Use default maximum. + + + + + Use default major unit. + + + + + Use default minor unit. + + + + + Date axis. + + + + + Use default base. + + + + + Use default crossing point. + + + + + Use default date settings for axis. + + + + + Option flags. + + + + + None. + + + + + Use default minimum. + + + + + Use default maximum. + + + + + Use default major unit. + + + + + Use default minor unit. + + + + + This a date axis. + + + + + Use default base. + + + + + Use default crossing point. + + + + + Use default date settings for axis. + + + + + This record specifies the number of axes sets (1 = primary + only, 2 = primary and secondary) used on the chart (3D charts + can only have primary axes). + + + + + Number of axes sets. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Size of the required storage space. Read-only. + + + + + Number of axes sets. + + + + + Represents DisplayUnits option. + + + + + Record size constant. + + + + + Represents display units in axis. + + + + + Represents display units value. + + + + + Indicates is show display unit label. + + + + + Reserved value. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Represents display units in axis. + + + + + Represents display units value. + + + + + Indicates is show display unit label. + + + + + Represents reserved byte. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record usually follows an AXIS record to define the axis line + as it appears on the chart. + + + + + Correct size of the record. + + + + + Axis line identifier: + 0 = the axis line itself + 1 = major grid line along the axis + 2 = minor grid line along the axis + 3 = walls or floor -- walls if parent axis is type 0 or 2; floor if parent axis is type 1. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Axis line identifier. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + Represents chart category axis offset record. + + + + + Minimum record size constant (generated by some version of MS Excel (probably 2007 Beta). + + + + + Record size constant. + + + + + Represents display units in axis. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Indicates is show display unit label. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record specifies the location and size of the chart axes, + in units of 1/4000 of the chart area. + + + + + Correct record size. + + + + + Axis index (0 = main, 1 = secondary). + + + + + X coordinate of top left corner. + + + + + Y coordinate of top left corner. + + + + + Length of x axis. + + + + + Length of y axis. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Axis index (0 = main, 1 = secondary). + + + + + X coordinate of top left corner. + + + + + Y coordinate of top left corner. + + + + + Length of x axis. + + + + + Length of y axis. + + + + + This record defines the axis type. + + + + + Correct record size. + + + + + Axis type: + 0 = category axis or x axis on a scatter chart + 1 = value axis + 2 = series axis + + + + + Field reserved by Microsoft. Read-only. + + + + + Field reserved by Microsoft. Read-only. + + + + + Field reserved by Microsoft. Read-only. + + + + + Field reserved by Microsoft. Read-only. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Axis type: + 0 = category axis or x axis on a scatter chart + 1 = value axis + 2 = series axis + + + + + Field reserved by Microsoft. Read-only. + + + + + Field reserved by Microsoft. Read-only. + + + + + Field reserved by Microsoft. Read-only. + + + + + Field reserved by Microsoft. Read-only. + + + + + Represents the Chart axis type. + + + + + Represents the CategoryAxis chart axis type. + + + + + Represents the ValueAxis chart axis type. + + + + + Represents the SeriesAxis chart axis type. + + + + + This record defines a bar or column chart group. + + + + + Correct record size. + + + + + Space between bars (percent of bar width), default = 0. + + + + + Space between categories (percent of bar width), default = 50. + + + + + Holder of all flags. + + + + + True for horizontal bars (bar chart). + False for vertical bars (column chart). + + + + + Stack the displayed values. + + + + + Each category is displayed as a percentage. + + + + + True if this bar has a shadow; otherwise False. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Space between bars. + + + + + Space between categories (percent of bar width), default = 50. + + + + + Holder of all flags. + + + + + True for horizontal bars (bar chart). + False for vertical bars (column chart). + + + + + Stack the displayed values. + + + + + Each category is displayed as a percentage. + + + + + True if this bar has a shadow; otherwise False. + + + + + Represents begin display axis unit label record. + + + + + Record size constant. + + + + + Represents display units in axis. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Indicates is show display unit label. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record stores options for a custom bar of pie or pie of + pie chart; these are two of the pie chart subtypes. + + + + + Count of pie slices in the bar of pie or pie of pie chart. + + + + + Array of bytes; each byte contains a bit field that describes the + individual point positioning in the series. If a slice is on the + secondary pie or bar chart, the corresponding bit is set to 1 (one); + otherwise the bit is 0 (zero). + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Clones current record. + + Returns cloned record. + + + + Count of pie slices in the bar of pie or pie of pie chart. + + + + + Array of bytes; each byte contains a bit field that describes the + individual point positioning in the series. If a slice is on the + secondary pie or bar chart, the corresponding bit is set to 1 (one); + otherwise the bit is 0 (zero). + + + + + This record stores options for a bar of pie or pie of pie chart; + these are two of the pie chart subtypes. + + + + + Record size. + + + + + 0 = normal pie chart + 1 = pie of pie chart + 2 = bar of pie chart + + + + + Holder of DefaultSplitValue property flag. + + + + + True to use default split value; otherwise False. + + + + + Split type: + 0 = Position + 1 = Value + 2 = Percent + 3 = Custom + + + + + For split = 0, which positions should go to the other pie / bar. + + + + + For split = 2, what percentage should go to the other pie / bar. + + + + + Size of the second pie as a percentage of the first. + + + + + Space between the first pie and the second. + + + + + For split = 1, what values should go to the other pie / bar. + + + + + True if the second bar / pie has a shadow; otherwise False. + + + + + Represents LeaderLines of datalabels + This property is included as the support in enabled after 2003 formats + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + 0 = normal pie chart + 1 = pie of pie chart + 2 = bar of pie chart + + + + + True to use default split value; otherwise False. + + + + + Split type: + 0 = Position + 1 = Value + 2 = Percent + 3 = Custom + + + + + For split = 0, which positions should go to the other pie / bar. + + + + + For split = 2, what percentage should go to the other pie / bar. + + + + + Size of the second pie as a percentage of the first. + + + + + Space between the first pie and the second. + + + + + For split = 1, what values should go to the other pie / bar. + + + + + 1 = the second pie / bar has a shadow. + + + + + True to show leader lines to data labels. + + + + + This record defines the scaling options for a category or series axis. + + + + + IMaxCross interface. + + + + + Gets or sets IsMaxCross property. + + + + + Minimum value for CrossingPoint, LabelsFrequency, and TickMarksFrequency properties. + + + + + Maximum value for CrossingPoint, LabelsFrequency, and TickMarksFrequency properties. + + + + + Correct record size. + + + + + Value axis / category crossing point (2D charts only). + + + + + Value axis / category crossing point in double. + + + + + Frequency of labels. + + + + + Frequency of tick marks. + + + + + Record flags holder. + + + + + Value axis crossing: + False if axis crosses mid-category. + True if axis crosses between categories. + + + + + Value axis crosses at the far right category (in a line, bar, + column, scatter, or area chart; 2D charts only). + + + + + Display categories in reverse order. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Value axis / category crossing point (2D charts only). + + + + + Value axis / category crossing point in double (2D charts only). + + + + + Frequency of labels. + + + + + Frequency of tick marks. + + + + + Holder of record flags. + + + + + Value axis crossing: + False if axis crosses mid-category. + True if axis crosses between categories. + + + + + Value axis crosses at the far right category (in a line, bar, + column, scatter, or area chart; 2D charts only). + + + + + Display categories in reverse order. + + + + + This record is the parent record for the chart group format + description. Each chart group will have a separate CHARTFORMAT + record, followed by a BEGIN record, the chart-group description, + and an END record. + + + + + Correct size of the record. + + + + + Field reserved by Microsoft for own use. Read-only. + + + + + Field reserved by Microsoft for own use. Read-only. + + + + + Field reserved by Microsoft for own use. Read-only. + + + + + Field reserved by Microsoft for own use. Read-only. + + + + + Holder of record options. + + + + + Vary color for each data point. + + + + + Drawing order (0 = bottom of the z-order). + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Field reserved by Microsoft for own use. Read-only. + + + + + Field reserved by Microsoft for own use. Read-only. + + + + + Field reserved by Microsoft for own use. Read-only. + + + + + Field reserved by Microsoft for own use. Read-only. + + + + + + + + + + Vary color for each data point. + + + + + Drawing order (0 = bottom of the z-order). + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record specifies drop lines, hi-lo lines, or series lines + on a line chart. If the chart has both drop lines and hi-lo + lines, two CHARTLINE records will be present. + + + + + Record size. + + + + + Drop lines / hi-lo lines: + 0 = drop lines + 1 = hi-lo lines + 2 = series lines (the lines that connect the columns in a stacked column chart) + + + + + Boolean value indicates whether drop lines are present in stock, line or area charts + + + + + Boolean value indicates whether high low lines are present in stock or line charts + + + + + Boolean value indicates whether series lines are present in pie of pie or bar of pie charts + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Operator to check if the records are equal + + + + + + + + Checks and returns is the records are not equal + + + + + + + + Drop lines / hi-lo lines: + 0 = drop lines + 1 = hi-lo lines + 2 = series lines (the lines that connect the columns in a stacked column chart) + + + + + True if stock, line or area charts has drop lines + + + + + True if stock or line charts has high low lines + + + + + True if pie of pie or bar of pie charts has series lines + + + + + The CHART record marks the start of the chart data substream in the + workbook BIFF stream. This record defines the location of the chart + on the display and its overall size. The X and Y fields define the + position of the upper-left corner of the bounding rectangle that + encompasses the chart. The position of the chart is referenced to the page. + The Width and Height fields define the overall size (the bounding rectangle) of + the chart, including title, pointing arrows, axis labels, etc. + The position and size are specified in points (1/72 inch), using a fixed + point format (two bytes integer, two bytes fraction). + + + + + Correct size of the record. + + + + + X-position of upper-left corner. + + + + + Y-position of upper-left corner. + + + + + X-size. + + + + + Y-size. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + X-position of upper-left corner. + + + + + Y-position of upper-left corner. + + + + + X-size. + (1/72 inch), used a fixed point format (two bytes integer, two bytes fraction). + + + + + Y-size. + (1/72 inch), used a fixed point format (two bytes integer, two bytes fraction). + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + The DATAFORMAT record contains the zero-based numbers of the data + point and series. The subordinate records determine the format of + the series or point defined by the DATAFORMAT record. + + + + + Correct size of the record. + + + + + Point number (FFFFh means entire series). + + + + + Series index (file relative). + + + + + Series number (as shown in name box -- S1, S2, etc.). This can + be different from yi if the series order has been changed. + + + + + Holder of record flags. + + + + + True to use Microsoft Excel 4.0 colors for automatic formatting. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Point number (FFFFh means entire series). + + + + + Series index (file relative). + + + + + Series number (as shown in name box -- S1, S2, etc.). This can + be different from yi if the series order has been changed. + + + + + Options holder. + + + + + True to use Microsoft Excel 4.0 colors for automatic formatting. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Summary description for ChartDataLabelsRecord. + + + + + + + + + + Option flags. + + + + + Indicates whether series name is in data labels. + + + + + Indicates whether category name is in data labels. + + + + + Indicates whether value is in data labels. + + + + + Indicates whether percentage is in data labels. + + + + + Indicates whether bubble size is in data labels. + + + + + Length of the delimiter. + + + + + Delimiter. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Operator to check if the records are equal + + + + + + + + Checks and returns if the records are not equal + + + + + + + + Option flags. Read-only. + + + + + Indicates whether series name is in data labels. + + + + + Indicates whether category name is in data labels. + + + + + Indicates whether value is in data labels. + + + + + Indicates whether percentage is in data labels. + + + + + Indicates whether bubble size is in data labels. + + + + + Length of the delimiter. + + + + + Delimiter. + + + + + This record stores options for the chart data table. + + + + + Record size. + + + + + Holder of record options. + + + + + True if data table has horizontal borders. + + + + + True if data table has vertical borders. + + + + + True if data table has a border. + + + + + True if data table shows series keys. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Holds record flags. + + + + + True if data table has horizontal borders. + + + + + True if data table has vertical borders. + + + + + True if data table has a border. + + + + + True if data table shows series keys. + + + + + The DEFAULTTEXT record precedes a TEXT record to identify the text + defined in the TEXT record as the default properties for certain chart items. + + + + + Correct record size. + + + + + Object identifier for the text: + 0 = default text characteristics for "show labels" data labels + 1 = default text characteristics for value and percentage data labels + 2 = default text characteristics for all text in the chart + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Object identifier for the text: + TextDefaults.ShowLabels = default text characteristics for "show labels" data labels. + TextDefaults.ValueAndPercents = default text characteristics for value and percentage data labels. + TextDefaults.All = default text characteristics for all text in the chart. + + + + + Represents the text defaults options. + + + + + Represents the ShowLabels text defaults option. + + + + + Represents the ValueAndPercents text defaults option. + + + + + Represents the All text defaults option. + + + + + This record defines drop bars on a line chart. If the chart contains + drop bars, the chart BIFF will contain two DROPBAR records. The first + DROPBAR record corresponds to the up bar and the second DROPBAR record + corresponds to the down bar. + + + + + Record size. + + + + + Drop bar gap width (0 to 100%). + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Drop bar gap width (0 to 500%). + + + + + Represents end display axis unit label record. + + + + + Minimum record size constant (generated by some version of MS Excel (probably 2007 Beta). + + + + + Record size constant. + + + + + Represents display units in axis. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Indicates is show display unit label. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + The FBI record stores font metrics. + + + + + Correct record size. + + + + + Width of basis when font was applied. + + + + + Height of basis when font was applied. + + + + + Font height applied. + + + + + Scale basis. + + + + + Index number into the font table. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Width of basis when font was applied. + + + + + Height of basis when font was applied. + + + + + Font height applied. + + + + + Scale basis. + + + + + Index number into the font table. + + + + + This record is the child of a TEXT record and defines a text + font by indexing the appropriate font in the font table. The + font table is built from FONT records. + + + + + Correct record size. + + + + + Index number into the font table. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Index number into the font table. + + + + + Read-only. Minimum possible size of the record. + + + + + Read-only. Maximum possible size of the record. + + + + + This record is written by Microsoft Excel but it is ignored. + Applications writing chart BIFF do not need to write this + record and applications reading chart BIFF can ignore it. + + + + + Default record size. + + + + + + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Returns size of the required storage space. + + + + + The FRAME record defines the border that is present around a + displayed label as a rectangle. A displayed label can include + the chart title, the legend (if not a regular rectangle), a + category name, or a value amount. + + + + + Correct size of the record. + + + + + 0 = regular rectangle/no border + 1�3 (reserved) + 4 = rectangle with shadow + + + + + Record flags holder. + + + + + Microsoft Excel calculates size. + + + + + Microsoft Excel calculates position. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Record flags holder. + + + + + 0 = regular rectangle/no border + 1�3 (reserved) + 4 = rectangle with shadow + + + + + Microsoft Excel calculates size. + + + + + Microsoft Excel calculates position. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record stores fill effects such as gradient fills, patterns, + textures, and so on. The record data is obtained from the + Microsoft Office Drawing DLL. + + + + + Represents start mso index. + + + + + Represents last mso index. + + + + + Represents default offset. + + + + + Represents first bytes in record. + + + + + Represents last bytes. + + + + + Represents option list; + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + Parses data from stream. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + + + + Infill internal data. + + + + + Updates gel record to adds to stream. + + Returns array list with updated gel frame records. + + + + Clones current record. + + Returns cloned object. + + + + Updates record to serialize in biff stream. + + + + + Indicates whether record needs internal data array or if it can be cleaned. + + + + + Represents list of fill options. + + + + + This record specifies the number-format index for an axis. + + + + + Record size. + + + + + Number-format index (number of the FORMAT record in the BIFF, begins at zero). + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Number-format index (number of the FORMAT record in the BIFF, begins at zero). + + + + + The LEGEND record defines the location of the legend on the + display and its overall size. The displayed legend contains + all series on the chart. + + + + + Record size. + + + + + X-position of upper-left corner. + + + + + Y-position of upper-left corner. + + + + + X-size. + + + + + Y-size. + + + + + Type: + 0 = bottom + 1 = corner + 2 = top + 3 = right + 4 = left + 7 = not docked or inside the plot area + + + + + Spacing: + 0 = close + 1 = medium + 2 = open + + + + + Holder of record flags. + + + + + Automatic positioning (True if legend is docked). + + + + + Automatic series distribution (True in Microsoft Excel 5.0). + + + + + X positioning is automatic. + + + + + Y positioning is automatic. + + + + + True if vertical legend (a single column of entries); + False if horizontal legend (multiple columns of entries). + Manual-sized legends always have this bit set to False. + + + + + True if the chart contains a data table. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + X-position of upper-left corner. + + + + + Y-position of upper-left corner. + + + + + X-size. + + + + + Y-size. + + + + + Type: + 0 = bottom + 1 = corner + 2 = top + 3 = right + 4 = left + 7 = not docked or inside the plot area + + + + + Spacing: + 0 = close + 1 = medium + 2 = open + + + + + Automatic positioning (True if legend is docked). + + + + + Automatic series distribution (True in Microsoft Excel 5.0). + + + + + X positioning is automatic. + + + + + Y positioning is automatic. + + + + + True if vertical legend (a single column of entries); + False if horizontal legend (multiple columns of entries). + Manual-sized legends always have this bit set to False. + + + + + True if chart contains data table. + + + + + This record specifies information about a legend entry which has + been changed from the default legend-entry settings. + + + + + Record size. + + + + + Legend-entry index. + + + + + Record flags holder. + + + + + True if the legend entry has been deleted. + + + + + True if the legend entry has been formatted. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Legend-entry index. + + + + + Options bit flags holder. + + + + + True if the legend entry has been deleted. + + + + + True if the legend entry has been formatted. + + + + + This record defines the appearance of a line, such as an axis line or border. + + + + + Correct size of the record. + + + + + Color of line; RGB value high byte must be set to zero. + + + + + Pattern of line: + 0 = solid + 1 = dash + 2 = dot + 3 = dash-dot + 4 = dash dot-dot + 5 = none + 6 = dark gray pattern + 7 = medium gray pattern + 8 = light gray pattern + + + + + Weight of line: + �1 or 0xffff = hairline + 0 = narrow (single) + 1 = medium (double) + 2 = wide (triple) + + + + + Format flags holder. + + + + + Automatic format. + + + + + True to draw tick labels on this axis. + + + + + True to draw line by custom style. + + + + + Index to color of line. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Color of line; RGB value high byte must be set to zero. + + + + + Line pattern. + + + + + Weight of line. + + + + + Holder of record flags. + + + + + If true - default format; otherwise custom. + + + + + True to draw tick labels on this axis. + + + + + Custom format for line color. + + + + + Line color index.. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record defines a line chart group. + + + + + Record size. + + + + + Holder of record flags. + + + + + Stack the displayed values. + + + + + Each category is broken down as a percentage. + + + + + True if this line has a shadow. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Holder of record flags. + + + + + Stack the displayed values. + + + + + Each category is broken down as a percentage. + + + + + True if this line has a shadow. + + + + + This record defines the color and shape of the line + markers that appear on scatter and line charts. + + + + + Correct size of the record. + + + + + Foreground color: RGB value (high byte = 0). + + + + + Background color: RGB value (high byte = 0). + + + + + Type of marker. + + + + + Format flags. + + + + + Index to color of marker border. + + + + + Index to color of marker fill. + + + + + Size of line markers. + + + + + Automatic color. + + + + + True = "background = none". + + + + + True = "foreground = none". + + + + + Flags monitors the properties which is set and custom + + 0 th position - ForeColor/FillColorIndex + 1 th position - BackColor/BorderColorIndex + 2 th position - Interior None + 3 th position - Border None + 4 th position - Marker Type + 5 th position - Marker Size + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Foreground color: RGB value (high byte = 0). + + + + + Background color: RGB value (high byte = 0). + + + + + Type of marker. + + + + + Format flags. Read-only. + + + + + Index to color of marker border. + + + + + Index to color of marker fill. + + + + + Size of line markers. + + + + + Automatic color. + + + + + True = "background = none". + + + + + True = "foreground = none". + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + Indicates whether the Marker has the line properties. + + + + + Get/Set the flag options for the marker properties. + + + + + Type of marker. + + + + + Represents the NoMarker marker type. + + + + + Represents the Square marker type. + + + + + Represents the Diamond marker type. + + + + + Represents the Triangle marker type. + + + + + Represents the X marker type. + + + + + Represents the Star marker type. + + + + + Represents the DowJones marker type. + + + + + Represents the StandardDeviation marker type. + + + + + Represents the Circle marker type. + + + + + Represents the PlusSign marker type. + + + + + This record links a TEXT record to an object on + the chart or to the entire chart. + + + + + Correct size of the record. + + + + + Object text is linked to. + + + + + Link index 1, series number. + + + + + Link index 2, data point number. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Object text is linked to. + + + + + Link index 1, series number. + + + + + Link index 2, data point number. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record defines the format for a picture attached + to a data series or point. + + + + + Correct size of the record. + + + + + Picture type. + + + + + Image format. + + + + + Environment from which the file was written. + + + + + Option flags. + + + + + Formatting only; no picture attached. + + + + + Picture is attached to top and bottom of column. + + + + + Picture is attached to back and front of column. + + + + + Picture is attached to sides of column. + + + + + Scaling value for pictures, units/picture + (IEEE floating-point number). + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Picture type. + + + + + Image format. + + + + + Environment from which the file was written. + + + + + Option flags. Read-only. + + + + + Formatting only; no picture attached. + + + + + Picture is attached to top and bottom of column. + + + + + Picture is attached to back and front of column. + + + + + Picture is attached to sides of column. + + + + + Scaling value for pictures, units/picture + (IEEE floating-point number). + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + Picture type. + + + + + Represents the Stretched picture type. + + + + + Represents the Stacked picture type. + + + + + Image format. + + + + + Represents the WindowsMetafile image format. + + + + + Represents the MacintoshPICT image format. + + + + + Represents the WindowsBitmap image format. + + + + + Environment from which the file was written. + + + + + Represents the Windows environment option. + + + + + Represents the Macintosh environment option. + + + + + The distance of an open pie slice from the center of the pie + chart expressed as a percentage of the pie diameter. + For example, if the percent = 33 (21h), the pie slice is + one-third of the pie diameter away from the pie center. + + + + + Correct size of the record. + + + + + Distance of pie slice from center of pie. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Distance of pie slice from center of pie. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record defines a pie chart group and specifies pie chart options. + + + + + Correct size of the record. + + + + + Angle of the first pie slice expressed in degrees. + + + + + 0 = True pie chart + Non-zero = size of center hole in a donut chart (as a percentage). + + + + + Option flags. + + + + + True if this pie has a shadow. + + + + + True to show leader lines to data labels. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Angle of the first pie slice expressed in degrees. + + + + + 0 = True pie chart + Non-zero = size of center hole in a donut chart (as a percentage). + + + + + Option flags. Read-only. + + + + + True if this pie has a shadow. + + + + + True to show leader lines to data labels. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + + + + + + Correct size of the record. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record stores scale factors for font scaling. + + + + + Correct size of the record. + + + + + Horizontal growth of plot area for font scaling. + + + + + Vertical growth of plot area for font scaling. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Horizontal growth of plot area for font scaling. + + + + + Vertical growth of plot area for font scaling. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record defines manual position information for the main-axis + plot area, legend, and attached text (data labels, axis labels, + and chart title). The record data depends on the record's use, + as shown in the following sections. + + + + + Correct size of the record. + + + + + For plot area and text must be 2, + For legend must be 5. + + + + + + + + + + X coordinate of the top left corner. + + + + + Y coordinate of the top left corner. + + + + + X coordinate of the bottom right corner. + + + + + Y coordinate of the bottom right corner. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / Initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + + + + + + + + + + + X coordinate of the top left corner. + + + + + Y coordinate of the top left corner. + + + + + X coordinate of the bottom right corner. + + + + + Y coordinate of the bottom right corner. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + + + + + + Correct size of the record. + + + + + Option flags. + + + + + True if the chart contains radar axis labels. + + + + + Not used. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Option flags. Read-only. + + + + + True if the chart contains radar axis labels. + + + + + Field reserved by Microsoft. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record defines a radar chart group. + + + + + Correct size of the record. + + + + + Option flags. + + + + + True if the chart contains radar axis labels. + + + + + True if this radar series has a shadow. + + + + + Not used. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Option flags. Read-only. + + + + + True if the chart contains radar axis labels. + + + + + True if this radar series has a shadow. + + + + + Field reserved by Microsoft. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record specifies the PivotTable reference used for the chart. + + + + + Correct size of the record. + + + + + First PivotTable row. + + + + + Last PivotTable row. + + + + + First PivotTable column. + + + + + Last PivotTable column. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + First PivotTable row. + + + + + Last PivotTable row. + + + + + First PivotTable column. + + + + + Last PivotTable column. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record stores the scatter chart properties. + + + + + Correct size of the record. + + + + + Percent of largest bubble compared to chart in general. + + + + + Bubble size. + + + + + Option flags. + + + + + True if this a bubble series. + + + + + True to show negative bubbles. + + + + + True if bubble series has a shadow. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + Percent of largest bubble compared to chart in general. + + + + + Bubble size. + + + + + Option flags. Read-only. + + + + + True if this a bubble series. + + + + + True to show negative bubbles. + + + + + True if bubble series has a shadow. + + + + + This record defines the series error bars. + + + + + Correct size of the record. + + + + + Error-bar type. + + + + + Error-bar value source. + + + + + True if the error bars are T-shaped (have a line on the top and bottom). + + + + + Reserved; must be 1. + + + + + IEEE number; specifies the fixed value, percentage, + or number of standard deviations for the error bars. + + + + + Number of values or cell references used for custom error bars. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Error-bar type. + + + + + Error-bar value source. + + + + + True if the error bars are T-shaped (have a line on the top and bottom). + + + + + Reserved; must be 1. Read-only. + + + + + IEEE number; specifies the fixed value, percentage, + or number of standard deviations for the error bars. + + + + + Number of values or cell references used for custom error bars. + + + + + Error-bar type. + + + + + Represents the XDirectionPlus error-bar type. + + + + + Represents the XDirectionMinus error-bar type. + + + + + Represents the YDirectionPlus error-bar type. + + + + + Represents the YDirectionMinus error-bar type. + + + + + This record defines a series trend line. + + + + + Correct size of the record. + + + + + Represents default byte array for NaN value. + + + + + Represents default NaN value; + + + + + Regression type. + + + + + Polynomial order or moving average period. + + + + + IEEE number; specifies forced intercept. + (#NA if no intercept is specified) + + + + + True if the equation is displayed. + + + + + True if the R-squared value is displayed. + + + + + IEEE number; specifies number of periods to forecast forward. + + + + + IEEE number; specifies number of periods to forecast backward. + + + + + Updates trend line type on serialize. + + Represents trend line type. + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Regression type. + + + + + Polynomial order or moving average period. + + + + + IEEE number; specifies forced intercept. + (#NA if no intercept is specified) + + + + + True if the equation is displayed. + + + + + True if the R-squared value is displayed. + + + + + IEEE number; specifies number of periods to forecast forward. + + + + + IEEE number; specifies number of periods to forecast backward. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + Regression type. + + + + + Represents the Polynomial regression type. + + + + + Represents the Exponential regression type. + + + + + Represents the Logarithmic regression type. + + + + + Represents the Power regression type. + + + + + Represents the MovingAverage regression type. + + + + + This record specifies series formatting information. + + + + + Correct size of the record. + + + + + Flags. + + + + + True if the line series has a smoothed line. + + + + + True to draw bubbles with 3D effects. + + + + + True if this series has a shadow. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Flags. Read-only. + + + + + True if the line series has a smoothed line. + + + + + True to draw bubbles with 3D effects. + + + + + True if this series has a shadow. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record is subordinate to the second CHARTFORMAT (overlay) + record in a file and defines the series that are displayed as + the overlay to the main chart. The first CHARTFORMAT (main chart) + record in a file does not require a SERIESLIST record because all + series, except those specified for the overlay, are included in + the main chart. + + + + + Minimum size of the record. + + + + + Count of series. + + + + + List of series numbers (words). + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Operator to check if the records are equal + + + + + + + + Checks and returns if the records are not equal + + + + + + + + Clones current record. + + Returns cloned record. + + + + Count of series. Read-only. + + + + + List of series numbers (words). + + + + + Minimum possible size of the record. + + + + + This record describes the series of the chart and contains the + type of data and number of data fields that make up the series. + Series can contain 4000 points in Microsoft Excel version 5. The + sdtX and sdtY fields define the type of data that is contained in + this series. At present, the two types of data used in the Microsoft + Excel chart series are numeric and text (date and sequence + information is not used). The cValx and cValy fields contain the + number of cell records in the series. + + + + + Correct size of the record. + + + + + Type of data in categories. + + + + + Type of data in values. + + + + + Count of categories. + + + + + Count of values. + + + + + Type of data in Bubble size series. + + + + + Count of Bubble series values. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Type of data in categories. + + + + + Type of data in values. + + + + + Count of categories. + + + + + Count of values. + + + + + Type of data in Bubble size series. + + + + + Count of Bubble series values. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + Type of data. + + + + + Represents the Date data format. + + + + + Represents the Numeric data format. + + + + + Represents the Sequence data format. + + + + + Represents the Text data format. + + + + + The value of the ID field determines the assignment of the text field. + + + + + Minimum size of the record. + + + + + Text identifier: 0 = series name or text. + + + + + The series text string. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Text identifier: 0 = series name or text. + + + + + The series text string. + + + + + Minimum possible size of the record. + + + + + This record indicates the series index for the series that + the trend line or error bar is attached to. The series index + is the number of the series in the BIFF (starting with series one). + + + + + Correct size of the record. + + + + + Series index for the series that the trend line + or error bar is attached to. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Series index for the series that the trend line + or error bar is attached to. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record is part of the series specifications and indicates + the chart-group index for the series. The chart-group index + specifies the number of the chart group (specified by a + CHARTFORMAT record) in the BIFF, starting with chart group zero. + + + + + Correct size of the record. + + + + + Chart-group index. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Chart-group index. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + The Shadow record defines the Shadow properties and + the 3D features(bevel top and bevel bottom),Lignting and + Material properties + + + + + Represents a warmMatte Charts + + + + + NoShadow=0 + OffsetRight=1 + OffsetDiagonalBottomRight=2 + OffsetBottom=3 + OffsetDiagonalTopLeft=4 + OffsetCenter=5 + OffsetTop=6 + OffsetLeft=7 + OffsetDiagonalTopRight=8 + OffsetDiagonalBottomLeft=9 + + + + + NoShadow=0 + InsideDiagonalBottomLeft=1 + InsideTop=2 + InsideRight=3 + InsideLeft=4 + InsideDiagonalTopRight=5 + InsideDiagonalBottomRight=6 + InsideCenter=7 + InsideBottom=8 + InsideDiagonalTopLeft=9 + + + + + NoShadow=0, + PrespectiveDiagonalUpperRight=1, + PrespectiveDiagonalLowerRight=2, + PrespectiveDiagonalUpperLeft=3, + PrespectiveDiagonalLowerLeft=4, + Below=5 + + + + + NoAngle=0, + Angle=1, + ArtDeco=2, + Circle=3, + Convex=4, + CoolSlant=5, + Cross=6, + Divot=7, + HardEdge=8, + RelaxedInset=9, + Riblet=10, + Slope=11, + SoftRound=12 + + + + + NoEffect=0, + Matte=1, + WarmMatte=2, + Plastic=3, + Metal=4, + DarkEdge=5, + SoftEdge=6, + Flat=7, + WireFrame=8, + Powder=9, + TranslucentPowder=10, + Clear=11 + + + + + ThreePoint=0, + Balance=1, + BrightRoom=2, + Chilly=3, + Contrasting=4, + Flat=5, + Flood=6, + Freezing=7, + Glow=8, + Harsh=9, + Morning=10, + Soft=11, + Sunrise=12, + SunSet=13, + TwoPoint=14 + + + + + Represents ChartImpl object + + + + + Shadow data + + + + + Creates the Shadow and sets parent + properties to specified values + + parent ThreeDFormatImpl for the Shadow + + + + Returns the chart material type. + + + + + Creates a new object that is a copy of the current instance. + + + + + + Gets or sets the shadow outer presets. + + The shadow outer presets. + + + + Gets or sets the shadow inner presets. + + The shadow inner presets. + + + + Gets or sets the shadow prespective presets. + + The shadow prespective presets. + + + + Gets or sets the material. + + The material. + + + + Gets or sets the lighting. + + The lighting. + + + + Gets or sets the bevel top. + + The bevel top. + + + + Gets or sets the bevel bottom. + + The bevel bottom. + + + + Represents ChartImpl object + + + + + This record specifies chart sheet properties. + + + + + Correct size of the record. + + + + + Represents minimum record size. + + + + + Property flags. + + + + + True if chart type has been manually formatted (changed from the default). + + + + + True to plot only visible cells. + + + + + True not to size chart with window. + + + + + False to use default plot area dimensions; + True if POS record describes plot-area dimensions. + + + + + True if user has modified chart enough that fManPlotArea should be set to 0. + + + + + Empty cells plotted as: + 0 = not plotted + 1 = zero + 2 = interpolated + + + + + This field is not used. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Property flags. Read-only. + + + + + True if chart type has been manually formatted (changed from the default). + + + + + True to plot visible cells only. + + + + + True not to size chart with window. + + + + + False to use default plot area dimensions; + True if POS record describes plot-area dimensions. + + + + + True if user has modified chart enough that fManPlotArea should be set to 0. + + + + + Empty cells plotted as: + 0 = not plotted + 1 = zero + 2 = interpolated + + + + + Reserved by Microsoft. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record defines where a series appears in the list of series. + + + + + Correct size of the record. + + + + + Index into series list. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + size of read item + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Index into series list. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record defines a surface chart group. + + + + + Correct size of the record. + + + + + Option flags. + + + + + True if chart contains color fill for surface. + + + + + True if this surface chart has shading. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Option flags. Read-only. + + + + + True if chart contains color fill for surface. + + + + + True if this surface chart has shading. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record is used in conjunction with several child records + (which further define the text displayed on the chart) to define + the alignment, color, position, size, and so on of text fields + that appear on the chart. The fields in this record have meaning + according to the TEXT record's parent (CHART, LEGEND, or DEFAULTTEXT). + + + + + Mask for the rotation value. + + + + + First bit of the rotation value. + + + + + Mask for data label placement. + + + + + First bit of the data label placement value. + + + + + Correct size of the record. + + + + + Horizontal alignment of the text. + + + + + Vertical alignment of the text. + + + + + Display mode of the background. + + + + + Text color. + + + + + X-position of the text in 1/4000 of chart area. + + + + + Y-position of the text in 1/4000 of chart area. + + + + + X-size of the text in 1/4000 of chart area. + + + + + Y-size of the text in 1/4000 of chart area. + + + + + Option flags. + + + + + Index to color value of text. + + + + + Option flags. + + + + + True for automatic color; False for user-selected color. + + + + + If text is an attached data label: + True to draw legend key with data label; + False for no legend key. + + + + + True if text of label is the value of the data point; + False if text is the category label. + + + + + True if text is not horizontal; + False if text is horizontal. + + + + + True to use automatically generated text string; + False to use user-created text string. + Must be one for fShowValue to be meaningful. + + + + + True if default or unmodified; + False if modified. + + + + + True if an automatic text label has been deleted by the user. + + + + + True if background is set to automatic. + + + + + True to show category label and value as a percentage. + (pie charts only) + + + + + True to show value as a percent. + This bit applies only to pie charts. + + + + + True to show bubble sizes. + + + + + True to show label. + + + + + Text rotation. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Horizontal alignment of the text. + + + + + Vertical alignment of the text. + + + + + Display mode of the background. + + + + + Text color. + + + + + X-position of the text in 1/4000 of chart area. + + + + + Y-position of the text in 1/4000 of chart area. + + + + + X-size of the text in 1/4000 of chart area. + + + + + Y-size of the text in 1/4000 of chart area. + + + + + Option flags. Read-only. + + + + + Index to color value of text. + + + + + Option flags. Read-only. + + + + + True if automatic color; False if user-selected color. + + + + + If text is an attached data label: + True to draw legend key with data label; + False if no legend key. + + + + + True if text of label is the value of the data point; + False if text is the category label. + + + + + True if text is not horizontal; + False if text is horizontal. + + + + + True to use automatically generated text string; + False to use user-created text string. + Must be one for fShowValue to be meaningful. + + + + + True if default or unmodified; + False if modified. + + + + + True if an automatic text label has been deleted by the user. + + + + + True if background is set to automatic. + + + + + True to show category label and value as a percentage + (pie charts only). + + + + + True to show value as a percent. + This bit applies only to pie charts. + + + + + True to show bubble sizes. + + + + + True to show label. + + + + + Rotation. + + + + + Data label placement. + + + + + Text rotation. + + + + + Text rotation. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record defines tick mark and tick label formatting. + + + + + Mask for the rotation value. + + + + + First bit of the rotation value. + + + + + Correct size of the record. + + + + + Maximum possible angle. + + + + + Size of the first reserved field. + + + + + Type of major tick mark. + + + + + Type of minor tick mark. + + + + + Tick label position relative to axis line. + + + + + Background mode. + + + + + Tick-label text color- uint; RGB value, high byte = 0. + + + + + Tick-label text color - int; RGB value, high byte = 0. + + + + + Automatic text color. + + + + + Display flags. + + + + + Automatic text background. + + + + + Automatic rotation. + + + + + Index to color of tick label. + + + + + Text rotation angle. + + + + + Indicates if axis label is left to right. + + + + + Indicates if axis label is right to left. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Type of major tick mark. + + + + + Type of minor tick mark. + + + + + Tick label position relative to axis line. + + + + + Background mode. + + + + + Tick-label text color; RGB value, high byte = 0. + + + + + Tick-label text color; RGB value, high byte = 0. + + + + + Display flags. Read-only. + + + + + Index to color of tick label. + + + + + Reserved; must be zero. + + + + + Automatic text color. + + + + + Automatic text background. + + + + + Automatic rotation. + + + + + Indicates is axis label is left to right. + + + + + Indicates is axis label is right to left. + + + + + Rotation. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + Microsoft Excel writes this record, but its value is always zero. + Applications writing BIFF do not need to write this record. + If the application writes this record, the wUnits field must be zero. + + + + + Correct size of the record. + + + + + Always zero. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Always zero. Read-only. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This record defines the value axis. + + + + + Record size constant. + + + + + Maximum value on axis. + + + + + Maximum value on axis. + + + + + Value of major increment. + + + + + Value of minor increment. + + + + + Value where category axis crosses. + + + + + Format flags. + + + + + Automatic minimum selected. + + + + + Automatic maximum selected. + + + + + Automatic major selected. + + + + + Automatic minor selected. + + + + + Automatic category crossing point selected. + + + + + Logarithmic scale. + + + + + Values in reverse order. + + + + + Category axis to cross at maximum value. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Maximum value on axis. + + + + + Maximum value on axis. + + + + + Value of major increment. + + + + + Value of minor increment. + + + + + Value where category axis crosses. + + + + + Format flags. Read-only. + + + + + Automatic minimum selected. + + + + + Automatic maximum selected. + + + + + Automatic major selected. + + + + + Automatic minor selected. + + + + + Automatic category crossing point selected. + + + + + Logarithmic scale. + + + + + Values in reverse order. + + + + + Category axis to cross at maximum value. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + This class wraps single record. Used in charts for DataLabels settings. + + + + + Offset to the wrapped record data. + + + + + Wrapped record. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Gets / sets wrapped record. Read-only. + + + + + Represents wrapper for gel frame record. + + + + + Represents interface, that implement mso option and fopte option wrapper classes. + + + + + Replaces option with specified value. + + Option to set. + + + + Removes current option by id. + + Represents option id to remove. + + + + Represents option storage. + + + + + Creates new instance of object. + + + + + Creates new instance of object. + + Represents option storage. + + + + Replaces option with specified value. + + Option to set. + + + + Removes current option by id. + + Represents option id to remove. + + + + Returns option list. Read-only. + + + + + Summary description for PrintedChartSizeRecord. + + + + + Correct size of the record. + + + + + Information on how chart should be printed. + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Information on how chart should be printed. + + + + + Minimum possible size of the record. + + + + + Maximum possible size of the record. + + + + + Rotation type. + + + + + Represents the LeftToRight rotation type. + + + + + Represents the TopToBottom rotation type. + + + + + Represents the CounterClockwise rotation type. + + + + + Represents the Clockwise rotation type. + + + + + + Contains utility methods for object cloning. + + + + + Clones int array. + + Array to clone + Returns cloned array. + + + + Clones ushort array. + + Array to clone. + Returns cloned array. + + + + Clones string array. + + Array to clone. + Returns cloned array. + + + + Clones object array. + + Array to clone. + Returns cloned array. + + + + Clones object that implements ICloneable interface. + + Object to clone. + A clone of the object. + + + + Clones object that implements ICloneable interface. + + Object to clone. + A clone of the object. + + + + Clones List with objects that implement ICloneable interface. + + List with objects to clone. + List with clone of the objects. + + + + Clones List with objects that implement ICloneable interface. + + List with objects to clone. + List with clone of the objects. + + + + Clones SortedList with objects that implement ICloneable interface. + + SortedList with objects to clone. + SortedList with clone of the objects. + + + + Clone SortedList. + + SortedList to clone + Returns a copy of the SortedList. + + + + Clones List with objects that implement ICloneable interface. + + List with objects to clone. + Parent object for the new items. + List with clone of the objects. + + + + Clones object that implements ICloneable interface. + + Object to clone. + Parent object for the new object. + A clone of the object. + + + + Clones MsoBase record. + + Object to clone. + Parent object. + A clone of the object. + + + + Clones byte array. + + Array to clone. + Return cloned array. + + + + Clones formula tokens array. + + Array to clone. + Return cloned array. + + + + Clones ColumnInfo array. + + Array to clone. + Return cloned array. + + + + Clone Dictionary. + + Dictionary to clone + Returns a copy of the Dictionary. + + + + Clone Dictionary. + + Dictionary to clone + Returns a copy of the Dictionary. + + + + Clone Dictionary. + + Dictionary to clone + Returns a copy of the Dictionary. + + + + Clone Dictionary. + + Dictionary to clone + Returns a copy of the Dictionary. + + + + Clone Dictionary. + + Dictionary to clone. + Parent object for the new objects. + Returns a copy of the Dictionary. + + + + Creates copy of the stream. + + Stream to copy. + Created stream. + + + + Creates a copy of the array of boolean values. + + Array to clone. + Created object. + + + + Summary description for CodeNameRecord. + + + + + + + + + + Default constructor + + + + + Read / initialize constructor + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, the class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + + + + Size of the required storage space. Read-only. + + + + + + + + + + Stores the text encoding (code page) used to encode byte strings. + In BIFF8, it always contains the Unicode code page 1200. + + + + + Correct size of the record. + + + + + Stores the text encoding (code page) used to encode byte strings. + In BIFF8, it always contains the Unicode code page 1200. + + + + + Default Constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Stores the text encoding (code page) used to encode byte strings. + In BIFF8 it always contains the Unicode code page 1200. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Defines the formatting information for a range of columns including width, + outline, and collapsed options. + + + + + Bit mask for the outlevel value. + + + + + Maximum and correct record size. + + + + + Index of first column in the range. + + + + + Index of the last column in the range. + + + + + Width of the columns in 1/256 of the width of zero character, + using default font (first font record in the file). + + + + + Index of extended format record for default column formatting. + + + + + Options: Use bit fields instead of using this field. + + + + + Columns are hidden. + + + + + Columns are collapsed. + + + + + Not used. + + + + + Default Constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserves for record's internal data array iReserve bytes. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Compares this record with another ColumnInfoRecord. + + Object to compare with. + 0 if specified record is equal to the current record; otherwise -1. + + + + Sets options into default state without setting extended format index. + + + + + Read-only. Reserved value. + + + + + Index of first column in the range. + + + + + Index of the last column in the range. + + + + + Width of the columns in 1/256 of the width of the zero character, + using default font (first font record in the file). + + + + + Index of extended format record for default column formatting. + + + + + Columns are hidden. + + + + + Gets or sets a value indicating whether this instance is best fit. + + + true if this instance is best fit; otherwise, false. + + + + + Gets or sets a value indicating whether this instance is user set. + + + true if this instance is user set; otherwise, false. + + + + + Gets or sets a value indicating if the phonetic information should be displayed by default for the affected column(s) of the worksheet. + + + true if this instance is phenotic; otherwise, false. + + + + + Outline level of the columns (0 = no outline). + This property changes bits of private m_usOptions field. + Set method would raise ArgumentOutOfRange exception + if value is more than 7. + + + + + If 1, then columns are collapsed. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's internal data array. + + + + + Row or column index. + + + + + Whenever the content of the record exceeds the given limits, + the record must be split. Several Continue Records containing + the additional data are added after the parent record. + + + + + Summary description for ILengthSetter. + + + + + Sets length of the internal data. + + New length to set. + + + + + + + + + + Sets internal data array. + + Data array to set. + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, a class must pack its own properties into + an internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + + + + Size of the required storage space. Read-only. + + + + + + + + + + This record stores two Windows country identifiers. + The first represents the user interface language of the Excel version + that saved this file, and second represents the system regional settings + at the time the file was saved. + + + + + Correct size of the record. + + + + + Represents the user interface language of the Excel version + that saved this file. + + + + + Represents the system regional settings + at the time the file was saved. + + + + + Default constructor + + + + + Read/Initialize constructor + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Represents the user interface language of the Excel version + that saved this file. + + + + + Represents the system regional settings + at the time the file was saved. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record stores the contents of an external cell or cell range. + An external cell range has only one row. If a cell range spans over more than + one row, several CRN records will be created. + + + + + Offset to the values. + + + + + Error message. + + + + + Default subitem size (boolean, error and number). + + + + + Unused bytes for boolean and error cell values. + + + + + Index to last column inside of the referenced sheet. + + + + + Index to first column inside of the referenced sheet. + + + + + Index to row inside of the referenced sheet. + + + + + Array of cell values. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Data provider that contains record's data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + + + + + + + + + + + Returns size of the required storage space. + + Excel version. + Size of the required storage space. + + + + Creates copy of the current object. + + A copy of the current object. + + + + + + + + + Index to last column inside of the referenced sheet. + + + + + Index to first column inside of the referenced sheet. + + + + + Index to row inside of the referenced sheet. + + + + + Read-only. Minimum possible size of the record. + + + + + Array of cell values. + + + + + + + + + + Summary description for CustomPropertyRecord. + + + + + Size of fixed data. + + + + + Max length of name string. + + + + + Unknown record header. + + + + + Property name. + + + + + Property value. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Returns size of the required data array. + + Size of the required data array. + + + + Gets / sets property name. + + + + + Gets / sets property value. + + + + + This record specifies the base date for displaying date values. + All dates are stored as count of days past this base date. + + + + + Two bytes which used for storing boolean value: + 0 = Base date is 1899-Dec-31 (the cell value 1 represents 1900-Jan-01) + 1 = Base date is 1904-Jan-01 (the cell value 1 represents 1904-Jan-0) + + + + + Use first bit of m_usWindow to store boolean flag: + False = Base date is 1899-Dec-31 (the cell value 1 represents 1900-Jan-01) + True = Base date is 1904-Jan-01 (the cell value 1 represents 1904-Jan-0) + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Two bytes which are used for storing boolean value. + + + + + Boolean value specifying whether 1904 date windowing is used. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Contains relative offsets to calculate the stream position of + the first cell record for each row. + This record is written once in a row block. + + + + + Size of the fixed part. + + + + + Subitem size. + + + + + Relative offset to first row record in the row block + (difference between record position of this record and the row record; + positive offset for an earlier stream position). + + + + + Relative offset to first row record in the row block + (difference between record position of this record and the row record; + positive offset for an earlier stream position). + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array iReserve bytes. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + This method checks the record's internal data array for integrity. + + If there is any internal error. + + + + Size of the required storage space. Read-only. + + + + + Relative offset to first row record in the row block + (difference between record position of this record and the row record; + positive offset for an earlier stream position). + + + + + Relative offset to first row record in the row block + (difference between record position of this record and the row record; + positive offset for an earlier stream position). + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + This record stores a data consolidation reference. DConBin is identical to + DConName, except that DConBin is used when the data consolidation reference + refers to a built-in name (as described by a Name record). + + + + + Named range of the source area for consolidation. + + + + + Workbook name. + + + + + Used for preserving the Record. + + + + + Default constructor fills all data with default values. + + + + + Read / initialize constructor + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, a class must pack its own properties into + an internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + + + + Named range of the source area for consolidation. + + + + + Workbook name. + + + + + The DConName record contains the complete description of a named range of + cells for the Consolidate command (Data menu). + + + + + Default constructor fills all data with default values. + + + + + Read / initialize constructor + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Summary description for DCON. + + + + + Correct size of the record. + + + + + Index to the data consolidation function. + + + + + 1 indicates that the left column option is turned on. + + + + + 1 indicates that the top row option is turned on. + + + + + 1 indicates that the create links to source data option is turned on. + + + + + Default constructor fills all data with default values. + + + + + Read / initialize constructor + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Index to the data consolidation function. + + + + + True means that the left column option is turned on. + + + + + True means that the top row option is turned on. + + + + + True means that the create links to source data option is turned on. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Summary description for DConRefRecord. + + + + + First row of the source area for consolidation. + + + + + Last row of the source area for consolidation. + + + + + First column of the source area for consolidation. + + + + + Last column of the source area for consolidation. + + + + + Workbook name. + + + + + Default constructor fills all data with default values. + + + + + Read / initialize constructor + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + First row of the source area for consolidation. + + + + + Last row of the source area for consolidation. + + + + + First column of the source area for consolidation. + + + + + Last column of the source area for consolidation. + + + + + Workbook name. + + + + + Specifies the default width for columns that have no specific width set. + + + + + Correct size of the record. + + + + + Column width in characters, using the width of the zero character + with default font (first font record in the file). + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Column width in characters, using the width of the zero character + with default font (first font record in the file). + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Row height for rows with undefined or inexplicitly defined heights. + + + + + Correct record size. + + + + + Option flags. + + + + + Default row height for undefined rows / rows with undefined height. + + + + + Specifies whether the default settings for the row height have been changed.. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Option flags. + + + + + Default row height for undefined rows / rows with undefined height. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Returns a boolean value which specifies whether the default settings for the row height have been changed. + + + + + Stores the maximum change of the result to the exit of an iteration. + + + + + Default value of the maximum change in iteration. + + + + + Correct record size. + + + + + Maximum change in iteration (IEEE floating-point value). + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Maximum change in iteration (IEEE floating-point value). + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Contains the range address of the used area in the current sheet. + + + + + Correct record size. + + + + + Index to first used row. Zero base. + + + + + Index to last used row. One base. + + + + + Index to first used column. Zero base. + + + + + Index to last used column. One base. + + + + + Not used. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Read-only. Not used. + + + + + Index to first used row. + + + + + Index to last used row. + + + + + Index to first used column. + + + + + Index to last used column. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Double Stream Flag Record indicating if this is a double stream file. + Double Stream files contain both BIFF8 and BIFF7 workbooks. + + + + + Correct size of the record. + + + + + Indicates if this is a double stream file. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Indicates if this is a double stream file. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record is the list header of the Data Validity Table in the current sheet. + + + + + Option flags. + + + + + False if the prompt box is not visible. + True if the prompt box is currently visible. + + + + + False if the prompt box has a fixed position. + True if the prompt box appears at a cell. + + + + + True if cell validity data is cached in DV records. + + + + + Horizontal position of the prompt box, if it has a fixed position, in pixels. + + + + + Vertical position of the prompt box, if it has a fixed position, in pixels. + + + + + Object identifier of the drop-down arrow object for a list box, + If a list box is visible at the current cursor position; otherwise FFFFFFFFH. + + + + + Number of DV records. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + + + + + + + + + Read-only. Option flags. + + + + + False if prompt box is invisible. + True if prompt box is currently visible. + + + + + False if prompt box has fixed position. + True if prompt box appears at cell. + + + + + True if cell validity data is cached in DV records. + + + + + Horizontal position of the prompt box, if it has a fixed position, in pixels. + + + + + Vertical position of the prompt box, if it has a fixed position, in pixels. + + + + + Object identifier of the drop-down arrow object for a list box, + if a list box is visible at the current cursor position; otherwise FFFFFFFFH. + + + + + Number of DV records. + + + + + Read-only. Minimum possible size of the record. + + + + + Read-only. Maximum possible size of the record. + + + + + This record is part of the Data Validity Table. It stores data validity settings + and a list of cell ranges which contain these settings. The "prompt box" appears + while editing such a cell. The "error box" appears if the entered value does not + fit the conditions. The data validity settings of a sheet are stored in a sequential + list of DV records. This list is preluded by a DVAL record. If a string is empty + and the default text should appear in the prompt box or error box, the string + must contain a single zero character (string length will be 1). + + + + + Bit mask for data type. + + + + + Bit mask for error style. + + + + + Bit mask for condition. + + + + + Start bit of the error style in options. + + + + + Start bit of the condition in options. + + + + + + + + + + Size of the fixed part. + + + + + Option flags. + + + + + True if in list type validity, the string list is explicitly given in the formula. + + + + + True if empty cells are allowed. + + + + + True to suppress the drop-down arrow in list type validity. + + + + + True to show prompt box if cell selected. + + + + + True to show error box if invalid values are entered. + + + + + Title of the prompt box (Unicode string, 16-bit string length). + + + + + Title of the error box (Unicode string, 16-bit string length). + + + + + Text of the prompt box (Unicode string, 16-bit string length). + + + + + Text of the error box (Unicode string, 16-bit string length) + + + + + Number of cell range addresses. + + + + + Cell range address list with all affected ranges. + + + + + Tokens of the first formula. + + + + + Tokens of the choice value. + + + + + Formula or choice is parsed. + + + + + Tokens of the second formula. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + When last byte of read data is not the last byte of data after parsing. + + + + + In this method, a class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + In this method, the replace(current culture list separator binary value / 2C00) value + is replaced to replacewith(0000) value. when a choice value is not null, it is parsed + to split the string value by comma and combined by current culture list separator. + Then the value is converted to a byte array, then the current culture list separator + is replaced with "0000". + + + + + In this method, the choice string value is split by comma separator to store the string array. + + + + + In this method, The string value is converted to Byte array value. + + + + + Adds new range to the list of validation ranges. + + Range to add. + + + + Adds new ranges to the list of validation ranges. + + Array of ranges to add. + + + + Adds new ranges to the list of validation ranges. + + Collection of ranges to add. + + + + Clears the Address. + + + + + Evaluates size of the formula in bytes. + + Tokens to get size from. + Excel version that should be used to infill data. + Indicates whether we should add size of the additional data. + Formula size in bytes. + + + + Size of the required storage space. Read-only. + + + + + Returns StringEmpty if income string is empty or null. + + String to modify. + + + + + Returns empty string is income string is StringEmpty. + + String to modify. + + + + + Clone current record. + + Returns clone of the current object. + + + + + + + + + + + + + + + + + Option flags. + + + + + True if in list type validity, the string list is explicitly given in the formula. + + + + + True if empty cells are allowed. + + + + + True to suppress the drop-down arrow in list type validity. + + + + + True to show prompt box if cell is selected. + + + + + True to show error box if invalid values are entered. + + + + + Data type: + Changes bits of m_uiOptions private member. + + + + + Error style: + Changes bits of m_uiOptions private member. + + + + + Condition operator: + Changes bits of m_uiOptions private member. + + + + + Title of the prompt box (Unicode string, 16-bit string length). + + + + + Title of the error box (Unicode string, 16-bit string length). + + + + + Text of the prompt box (Unicode string, 16-bit string length). + + + + + Text of the error box (Unicode string, 16-bit string length). + + + + + Formula data for the first condition (RPN token array without size field). + + + + + Formula data for the second condition (RPN token array without size field). + + + + + Choice data for the condition. + + + + + Formula or Choice data is parsed. + + + + + Read-only. Number of cell range addresses. + + + + + Cell range address list with all the affected ranges. + + + + + Read-only. Minimum possible size of the record. + + + + + The end record defines the end of a block of records for a (Graphing) + data object. This record is matched with a corresponding BeginRecord. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, a class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + It indicates the end of a record block with leading BOF record. + This could be the end of the workbook globals, a worksheet, a chart, etc. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + One of the most complex records. There are two types: + Style and Cell. It should be noted that fields in the extended format record are + somewhat arbitrary. Almost all of the fields are bit-level, but + we name them as best as possible by functional group. In some + places, this is more conducive than others. + + + + + Indent bit mask: + + + + + Read order bit mask: + + + + + Start bit for read order value. + + + + + Parent index bit mask: + + + + + Rotation bit mask: + + + + + Top border palette bit mask: + + + + + Bottom border palette bit mask: + + + + + Diagonal bit mask: + + + + + Diagonal line bit mask: + + + + + Fill pattern bit mask: + + + + + Left border bit mask: + + + + + Right border bit mask: + + + + + Top border bit mask: + + + + + Bottom border bit mask: + + + + + Horizontal alignment bit mask: + + + + + Vertical alignment bit mask: + + + + + Background bit mask: + + + + + Foreground border bit mask: + + + + + Left border palette bit mask: + + + + + Right border palette bit mask: + + + + + Start bit for the right border bit mask: + + + + + + + + + + Mask for FillForeground property. + + + + + Default color index. + + + + + Default pattern color index. + + + + + Maximum possible index in the extended format, means that there is no parent. + + + + + Default value for HAlignJustify + + + + + Default value for VAlignJustify + + + + + Index to font record. + + + + + Index to FORMAT record. + + + + + Cell options. + + + + + True if cell is locked. + + + + + True if formula is hidden. + + + + + Type of extended format record, False = Cell XF; True = Style XF. + + + + + + + + + + Alignment options of the extended format. + + + + + True indicates that text is wrapped at right border. + + + + + For far east languages. Supported only for format, always 0 for US. + + + + + Indent options of the extended format. + + + + + True indicates shrinking content to fit into cell. + + + + + True indicates that XF contains merged cells. + + + + + Flag for number format, if False, then an attribute of the parent style is used. + + + + + Flag for font, if False, then an attribute of the parent style is used. + + + + + Flag for horizontal and vertical alignment, text wrap, indentation, + orientation, rotation, and text direction. If False, then an attribute + of the parent style is used. + + + + + Flag for border lines. + If False, then an attribute of the parent style is used. + + + + + Flag for background area style. + If False, then an attribute of the parent style is used. + + + + + Flag for cell protection (cell locked and formula hidden). + If False, then an attribute of the parent style is used. + + + + + Indent value. + + + + + Indicates whether the range is wrapped first + + + + + Indicates whether the range is rotated first + + + + + Border options: + + + + + Palette options: + + + + + True if diagonal line runs from top left to right bottom. + + + + + True if diagonal line runs from bottom left to right top. + + + + + Additional palette options: + + + + + Fill options: + + + + + Indicates whether hash is valid. + + + + + Current hash value. + + + + + Index to the parent extended format. + + + + + Extended format fill pattern type. + + + + + Index of Fill. + + + + + Index of Border. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for the record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Compares with Extended format record. + + Param to compare. + Returns compare results. + + + + Serves as a hash function for a particular type, suitable for use + in hashing algorithms and data structures like a hash table. + + A hash code for the current Object. + + + + Swaps colors if necessary. + + + + + Copies border settings from another extended format record. + + Source record to copy data from. + + + + Copies alignment settings from another extended format record. + + Source record to copy data from. + + + + Copies pattern settings from another extended format record. + + Source record to copy data from. + + + + Copies protection / cells settings from another extended format record. + + Source record to copy data from. + + + + Copies data from the current ExtendedFormat record to the specified + ExtendedFormat record. + + ExtendedFormat record that will receive data from + the current record. + + + + Copies data from the current Biff record to the specified Biff record. + + Biff record that will receive data from the current record. + + + + Cell options bits in one location. Read-only. + + + + + Border options bits in one location. Read-only. + + + + + Alignment options bits in one location. Read-only. + + + + + Index to font record. + + + + + Represent the fill index + + + + + Represent the Border Index + + + + + Index to FORMAT record: + + + + + True if cell is locked. + + + + + True if formula is hidden. + + + + + Type of extended format record. + + + + + + + + + + Gets /sets index to parent style XF (always FFFH in style XFs in Excel 97). + + + + + True means that text is wrapped at right border. + + + + + For far east languages supported only for format, always use False for US. + + + + + Gets or sets indent level. + + + + + True means to shrink content to fit into cell. + + + + + True if extended format contains merged cells. + + + + + Text direction, the reading order for far east versions. + + + + + Text rotation angle: + 0- Not rotated + 1-90- 1 to 90 degrees counterclockwise + 91-180- 1 to 90 degrees clockwise + 255- Letters are stacked top-to-bottom, but not rotated. + + + Thrown when value is more than 0xFF. + + + + + Flag for number format, if False, then an attribute of the parent style is used. + + + + + Flag for font, if False, then an attribute of the parent style is used. + + + + + Flag for horizontal and vertical alignment, text wrap, indentation, + orientation, rotation, and text direction. If False, then an attribute + of the parent style is used. + + + + + Flag for border lines. + If False, then an attribute of the parent style is used. + + + + + Flag for background area style. + If False, then an attribute of the parent style is used. + + + + + Flag for cell protection (cell locked and formula hidden). + If False, then attributes of the parent style is used. + + + + + Color index for top line color. + This property changes bits of the m_uiAddPaletteOptions class member. + + + Thrown when value is more than 0x7F. + + + + + Color index for bottom line color. + This property changes bits of the m_uiAddPaletteOptions class member. + + + Thrown when value is more than 0x7F. + + + + + Color index for left line color + This property changes bits of the m_usPaletteOptions class member. + + + Thrown when value is more than 0x7F. + + + + + Color index for right line color. + This property changes bits of the m_usPaletteOptions class member. + + + Thrown when value is more than 0x7F. + + + + + Color index for diagonal line color. + This property changes bits of the m_uiAddPaletteOptions class member. + + + Thrown when value is more than 0x7F. + + + + + Diagonal line style. + This property changes bits of the m_uiAddPaletteOptions class member. + + + Thrown when value is more than 0x0F. + + + + + Diagonal line is drawing from top left to bottom right corner of cell. + + + + + Diagonal line is drawing from bottom left to top right corner of cell. + + + + + Fill pattern: + This property changes bits of the m_uiAddPaletteOptions class member. + + + Thrown when value is more than 0x3F. + + + + + Left line style: + This property changes bits of the m_usBorderOptions class member. + + + + + Right line style: + This property changes bits of the m_usBorderOptions class member. + + + + + Top line style: + This property changes bits of the m_usBorderOptions class member. + + + + + Bottom line style: + This property changes bits of the m_usBorderOptions class member. + + + + + Horizontal alignment. + + + + + Vertical alignment. + + + + + Color index for pattern color + This property changes bits of m_usFillPaletteOptions. + + + Thrown when value is more than 0x7F. + + + + + Color index for pattern background. + This property changes bits of m_usFillPaletteOptions. + + + Thrown when value is more than 0x7F. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Type of extended format. + + + + + Represents the XF_CELL extended format type. + + + + + Represents the XF_STYLE extended format type. + + + + + This record contains the number of additional EXTERNSHEET records. + In BIFF8, this is omitted because there is only one EXTERNSHEET record. + + + + + Correct size of the record. + + + + + Number of additional EXTERNSHEET records. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Number of additional EXTERNSHEET records. + + + + + Read-only. Minimum possible size of the record. + + + + + Read-only. Maximum possible size of the record. + + + + + + + + + + Option flags. + + + + + One-based index to sheet in preceding SUPBOOK record, 0 + for global defined names (for external names), or + Not used (for add-in functions). + + + + + Not used. + + + + + External name (Unicode string, 8-bit string length) or + Add-in function name (Unicode string, 8-bit string length). + + + + + Size of the formula data. + + + + + Formula data or + 02H 00H 1CH 17H (formula representing the #REF! error code). + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, a class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + Infills internal data in the case of DDE link extern name. + + + + + Read-only. Option flags. + + + + + Read-only. One-based index to sheet in preceding SUPBOOK + record, 0 for global defined names (for external names), or + Not used (for add-in functions). + + + + + Read-only. Not used. + + + + + Read-only. Formula data or + 02H 00H 1CH 17H (formula representing the #REF! error code). + + + + + External name (Unicode string, 8-bit string length) or + Add-in function name (Unicode string, 8-bit string length). + + + + + Read-only. Minimum possible size of the record. + + + + + + + + + + Indicates whether data array is needed to store record data. Read-only. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets or sets if it is add-in name record + + + + + Possible options flags. + + + + + The record stores a list with indexes to SUPBOOK records. + + + + + Size of the fixed part. + + + + + Maximum references in one record. + + + + + Number of following REF structures. + + + + + List of REF structures. + + + + + Represents the number of elements in rgXTI array + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserves for record's internal data array iReserve bytes. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + This method adds one TREF structure to the list. + + SUPBOOK index. + Index to first SUPBOOK sheet. + Index to last SUPBOOK sheet. + + Index of the old REF structure (if there was one) + or new REF structure. + + + + + + + + + + + + Append Reference + + + + + + Append References + + + + + + Prepend References + + + + + + Creates new instance + + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, a class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + Size of the required storage space. Read-only. + + + + + Number of following REF structures. + + + + + List of REF structures. + + + + + Gets list of references. + + + + + Read-only. Minimum possible size of the record. + + + + + Stores index to SUPBOOK record. + + + + + Size of the TREF. + + + + + Index to SUPBOOK record. + + + + + Index to first SUPBOOK sheet. + + + + + Index to last SUPBOOK sheet. + + + + + Constructs reference by SUPBOOK index and its start and end sheet. + + SUPBOOK index. + Index to first SUPBOOK sheet. + Index to last SUPBOOK sheet. + + + + Index to SUPBOOK record. + + + + + Index to first SUPBOOK sheet. + + + + + Index to last SUPBOOK sheet. + + + + + Extended SST table info subrecord + contains the elements of "info" in the SST's array field. + + + + + Correct size of the record. + + + + + Absolute stream position of first string of the portion. + + + + + Position of first string of the portion inside the current record, + including record header. This counter restarts at zero, if the SST + record is continued with a CONTINUE record. + + + + + Not used. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Absolute stream position of first string of the portion. + + + + + Position of first string of the portion inside of current record, + including record header. This counter restarts at zero, if the SST + record is continued with a CONTINUE record. + + + + + Read-only. Reserved. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + + It is used by Excel to create a hash table with stream + offsets to the SST record to optimize string search operations. Excel + may not shorten this record if strings are deleted from the shared + string table, so the last part might contain invalid data. The stream + indexes in this record divide the SST into portions containing a + constant number of strings. + + + + + Size of the fixed part. + + + + + Subitem size. + + + + + Number of strings in a portion, this number is >=8. + + + + + Array that contains all portions. + + + + + Indicates and of workbook in some cases. + + + + + Reference to the SST record. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + + + + Object that provides access to the data. + Object to encrypt data. + Position in the output stream. Used to increase performance. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, a class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + Method updates fields of record which must contain stream offset + or other data. This method must be called before save operation + when all records placed in array in its positions and offsets can + be freely calculated. + + + + + Size of the required storage space. Read-only. + + + + + Number of strings in a portion, this number is >=8. + + + + + Array that contains all portions. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Indicates and of workbook in some cases. Read-only. + + + + + Gets / sets reference to the SST record. + + + + + This record is part of the file protection. It contains information about + the read/write password of the file. All record contents following this + record will be encrypted. + + + + + Value of hash field indicating that standard encryption algorithm was used. + + + + + Value of hash field indicating that strong encryption algorithm was used. + + + + + Indicates whether weak (xor) or not weak encryption was used. + 0 - BIFF2-BIFF7 weak XOR encryption, + 1 - BIFF8 standard encryption or BIFF8X strong encryption. + + + + + Encryption key calculated from the read/write password. + + + + + Hash value calculated from the read/write password. + + + + + Record content for BIFF8 standard encryption. + + + + + Record content for BIFF8X strong encryption. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Creates internal standard encryption block. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Indicates whether weak encryption is used. + + + + + Encryption key calculated from the read/write password. + + + + + Hash value calculated from the read/write password. + + + + + Returns content for BIFF8 standard encryption. Read-only. + + + + + Returns content for BIFF8 standard encryption. Read-only. + + + + + + + + + + Summary description for FilePassStandardBlock. + + + + + Correct record size. + + + + + Unique document identifier used to initialize the encryption algorithm. + + + + + Encrypted document identifier used to verify the entered password. + + + + + Digest used to verify the entered password. + + + + + Default constructor. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Buffer length. + + + + + + + + + + Unique document identifier used to initialize the encryption algorithm. Read-only. + + + + + Encrypted document identifier used to verify the entered password. Read-only. + + + + + Digest used to verify the entered password. Read-only. + + + + + Summary description for FilePassStrongBlock. + + + + + Option flags. + + + + + Unknown value. + + + + + Stream encryption algorithm identifier. + 00006801H = RC4 (Ron's Code 4) + 00006802H = SEAL (Secure Encryption Algorithm) + + + + + Password hashing algorithm identifier: + 00008001H = MD2 (Message Digest 2) + 00008002H = MD4 (Message Digest 4) + 00008003H = MD5 (Message Digest 5) + 00008004H = SHA-1 (Secure Hash Algorithm) + + + + + Hash key length (bits). + + + + + Cryptographic provider type: + 00000001H = RSA + 0000000CH = RSA SChannel + 0000000DH = DSS and Diffie-Hellman + 00000012H = DH SChannel + 00000018H = RSA and AES + + + + + Unknown or not used. + + + + + Cryptographic provider name, Unicode character array with trailing null character. + + + + + Unique document identifier used to initialize the encryption algorithm. + + + + + Encrypted document identifier used to verify the entered password. + + + + + Encrypted document identifier used to verify the entered password. + + + + + Digest used to verify the entered password. + + + + + Default constructor. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + + + + Option flags. + + + + + Unknown value. + + + + + Stream encryption algorithm identifier. + 00006801H = RC4 (Ron's Code 4) + 00006802H = SEAL (Secure Encryption Algorithm) + + + + + Password hashing algorithm identifier: + 00008001H = MD2 (Message Digest 2) + 00008002H = MD4 (Message Digest 4) + 00008003H = MD5 (Message Digest 5) + 00008004H = SHA-1 (Secure Hash Algorithm) + + + + + Hash key length (bits). + + + + + Cryptographic provider type: + 00000001H = RSA + 0000000CH = RSA SChannel + 0000000DH = DSS and Diffie-Hellman + 00000012H = DH SChannel + 00000018H = RSA and AES + + + + + Unknown or not used. Read-only. + + + + + Cryptographic provider name, Unicode character array with trailing null character. + + + + + Returns digest used to verify the entered password. Read-only. + + + + + The record represents an empty cell. + It contains the cell address and formatting information. + + + + + 1 = Recommend Read-only state while loading the file. + + + + + Hash value calculated from the Read-only password. + + + + + User name of the file creator. + + + + + Default constructor fills all data with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + 1 = Recommend Read-only state while loading the file. + + + + + Hash value calculated from the Read-only password. + + + + + Index to XF (extended format) record. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + If the sheet contains a filtered list, the file will contain FilterModeRecord. + This record has no record data field. + + + + + Default constructor fills all data with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + + + + Read-only. Maximum possible size of the record. + + + + + Function Group Count Record + Number of built in function groups in the current version of the + spreadsheet (probably only used in Windows). + + + + + Correct size of the record. + + + + + Number of built in function groups in the current version of the spreadsheet. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Number of built in function groups in the current version of the spreadsheet. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Font Record describes a font in the workbook (index = 0-3,5-infinity - skip 4) + An element in the Font Table contains information about a used font, + including character formatting. + + + + + Incorrect hash value. + + + + + Offset to the byte that indicates whether string is unicode. + + + + + Default font color. + + + + + Height of the font (in twips = 1/20 of a point). + + + + + Font attributes. + + + + + Palette color index. + + + + + Boldness (100-1000). Standard values are 0190H (400) for normal text + and 02BCH (700) for bold text. + + + + + Escapement: + + + + + Underline type: + + + + + Font family: + + + + + Character set: + + + + + Not used. + + + + + Font name: Unicode string, 8-bit string length. + + + + + Cached hash code value. + + + + + Represents the baseline value which indicates whether superscript or subscript + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + 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. + + + + + Serves as a hash function for a particular type, suitable for + use in hashing algorithms and data structures like a hash table. + + A hash code for the current object. + + + + + + + + + + + + + + + + + Read-only. Font attributes. + + + + + Height of the font (in twips = 1/20 of a point). + + + + + Palette color index. + + + + + Boldness (100-1000). Standard values are 0190H (400) for normal text + and 02BCH (700) for bold text. + + + + + Escapement: + + + + + Gets or sets the baseline value which indicates whether superscript or subscript + + + + + Underline type: + + + + + Font family: + + + + + Character set: + + + + + Font name: Unicode string, 8-bit string length. + + + + + True if characters are italic. + + + + + True if characters are strikeout. + + + + + Whether to use the Mac outline font style (Mac only). + + + + + Whether to use the Mac shadow font style thing (Mac only). + + + + + Not used. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Font attributes. + + + + + Indicates whether this font is in italics. + + + + + Indicates whether characters are strikeout. + + + + + Whether to use the Mac outline font style (Mac only). + + + + + Whether to use the Mac shadow font style (Mac only). + + + + + All known flags. + + + + + Record contains information about a number format. + + + + + Format index used in other records: + + + + + Length of format string: + + + + + Format string: + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Format index used in other records: + + + + + Length of format string: + + + + + Read-only. Minimum possible size of record. + + + + + Contains the token array and the result of a formula cell. + + + + + This interface supports DoubleValue property. + + + + + Returns double value. Read-only. + + + + + Returns type code. Read-only. + + + + + Represents first mask + + + + + Represents boolean mask. + + + + + Represents error mask. + + + + + Represents error mask. + + + + + String mask. + + + + + String mask. + + + + + Size of the fixed part. + + + + + Formula value in the case of string value. + + + + + Formula value in the case of blank value. + + + + + Offset to the formula value. + + + + + Size of the data before expression that belongs only to formula (without row, column, xf indexes). + + + + + + + + + + + + + + + + + + + + The calculated value of the formula. + + + + + The option flags. + + + + + True to always recalculate. + + + + + True to calculate on open. + + + + + True if part of a shared formula. + + + + + Reserved. + + + + + Size of the following formula data. + + + + + Formula data (RPN token array). + + + + + Array that contains all parsed tokens. + + + + + + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + Parses formula expression and fill and provides internal integrity data check. + + Object that provides access to the data. + Record's data offset. + Excel version that was used to infill data provider. + + If there is any internal error. + + + + + Prepares expression field. + + + + + Sets bool or error value. + + Represents bool or error byte value. + Indicates if this is error. + + + + Size of the required storage space. Read-only. + + + + + Converts error or bool value to formula double value. + + Represents error or bool value. + Indicates is error or bool. + Returns formula value. + + + + Sets flags so MS Excel understands that formula returns string. + + Object that provides access to the data. + Offset to the FormulaRecord.. + + + + Sets flags so MS Excel understands that formula returns string. + + Object that provides access to the data. + Offset to the FormulaRecord.. + + + + Reads record's value from the data provider. + + Provider to read data from. + Offset to the record's start. + Excel version used to infill data. + Record's value. + + + + Reads record's value from the data provider. + + Provider to read data from. + Offset to the record's start. + Excel version used to infill data. + Record's value. + + + + Reads record's value from the data provider. + + Provider to read data from. + Offset to the record's start. + Excel version used to infill data. + Record's value. + + + + Writes record's value into the data provider. + + Provider to write data into. + Offset to the record's start. + Excel version used to infill data. + Record's value. + + + + + + + + + + + + + + + + Converts formula tokens from Excel97to2003 to Excel2007 version and vice versa. + + Formula tokens. + Defines what conversion must be applied. + + + + Converts formula GOTO and IF token from Excel97to2003 to Excel2007 version and vice versa. + + Formula tokens. + GOTO token index. + Defines what conversion must be applied. + + + + Expression of the formula. + + + + + The calculated value of the formula. + + + + + Option flags of the formula. + + + + + True to always recalculate. + + + + + True to calculate on open. + + + + + True if part of a shared formula. + + + + + Array that contains all parsed tokens. + + + + + Read-only. Reserved. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + + + + + + The calculated value of the formula. + + + + + Indicates if formula record contain bool value. Read-only. + + + + + Indicates if formula record contain error value. Read-only. + + + + + Gets if the formula record is blank + + + + + + + + + + The calculated boolean value of the formula. + + + + + The calculated error value of the formula. + + + + + Array that contains all parsed tokens. + + + + + This token contains a 3D reference or an external reference to a cell range. + + + + + This token contains the reference to a cell range in the same sheet. + + + + + This class is the base class for each token of a formula. + + + + + Code of the token. + + + + + Default constructor. + + + + + Creates token using data from an array of bytes. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + Gets string from byte array, length of string is set in 16 bit value. + + Data array which contains string. + Offset to the string data. + Parsed string. + + + + Gets string from byte array and returns it's length in iFullLength parameter. + + Data array which contains string. + Offset to the string data. + Length of the string in bytes. + Parsed string. + + When data array is smaller than the string that should be in it. + + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Returns size of the tokens array. + + Excel version - defines resulting size. + Size of the tokens array. + + + + Converts token to byte array. + + Excel version - defines resulting array format and size. + Array of bytes representing this token. + + + + Converts token to a string. + + String representation of the token. + + + + Converts token to the string. + + Formula util. + String representation of the token. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to a string. + + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + + + + + + + + + Indicates whether R1C1 notation must be used. + Formula util. + + + + + + + + + + Indicates whether R1C1 notation must be used. + Formula util. + + + + + + Moves token by iRowOffset to the right and iColumnOffset to the left. + (Updates formula token after copy operation.) + + Row offset. + Column offset. + Parent workbook. + Updated token. + + + + Adjusts the location of the token by the specified amount. + Returns adjusted token. (Updates formula token after move operation.) + + Index of the sheet where formula is located. + Zero-based row index which this token is located. + Zero-based column index where this token is located. + Index of the source worksheet in move range operation. + Index of the destination worksheet in move range operation. + Rectangle that was moved. + Location were range was moved. + Indicates whether token was changed during move operation. + Parent workbook. + Adjusted token. + + + + + + + + + + + + + Check whether the restangle intersects with the formula. + + Source rectange. + Formula first row + Formula first column + Formula last row + Formula last column + + + + + + + + + + + + + + Converts tokens from regular formula into tokens from shared formula. + + Represents parent workbook. + Represents row index. + Represents column index. + Formula token. + + + + Compares this token to the specified one. + + Token to compare with. + 0 if tokens are equal. + + + + Compares tokens content. + + Token to compare with this one. + 0 if tokens are equal. + + + + Compares two token arrays. + + The first array to compare. + The second array to compare. + True if arrays are equal; otherwise false. + + + + Converts and returns the string + + + + + + + + + + + + + + + + + + + Converts index to token code. + + + + + + + + Read-only. True if this ptg represents operation ptg. + + + + + Gets / sets. Code of the token. + + + + + This interface should be implemented by those tokens + that can be converted to IRange. + + + + + This interface should be implemented by those tokens + that can be converted to IRange. + + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Worksheet that contains range. + Range represented by the token. + + + + This interface is implemented by formula tokens that can provide corresponding rectangle object. + + + + + Returns rectangle represented by the token that implements this interface. + All coordinates are zero-based. + + Rectangle represented by the token. + + + + Updates token using data from specified rectangle. + + Rectangle with new token coordinates. + Updated token. + + + + Converts current token into error token. + + Created token. + + + + Summary description for IToken3D. + + + + + Converts current token to the 3D token. + + Reference to the worksheet. + Created token. + + + + Index of first row (0..65535) or row offset (-32768..32767). + + + + + Index of last row (0..65535) or row offset (-32768..32767). + + + + + Index of first column (0..255) or column offset (-128..127). + + + + + Option flags of first row and first column. + + + + + Index of last column (0..255) or column offset (-128..127). + + + + + Option flags of last row and last column. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Creates token by its string representation. + + String representation of the formula. + Parent workbook. + + When specified string is not valid token string. + + + + + Creates token using data from an array of bytes. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + Creates copy of the token. + + Token to clone. + + + + + + + + + + + + + + + Creates token using strings that represents cell addresses. + + Row index of the cell that contains this token. + Column index of the cell that contains this token. + String representation of the first row. + String representation of the first column. + String representation of the last row. + String representation of the last column. + + Parent workbook. + + + + Parses specified column and row values and fills token + fields with appropriate values. + + Row index of the cell that contains this token. + Column index of the cell that contains this token. + String representing left column of the area. + String representing top row of the area. + String representing right column of the area. + String representing bottom row of the area. + Indicates whether R1C1 notation is used. + Parent workbook. + + + + Converts token code to index (inverse operation to IndexToCode). + + Reference index. + + + + Gets corresponding error code. + + Corresponding error code. + + + + Indicates whether area covers whole single row. Read-only. + + + + + Indicates whether area covers whole rows. Read-only. + + + + + + + Indicates whether area covers whole columns. Read-only. + + + + + + + Indicates whether area covers whole single column. Read-only. + + + + + Converts incorrect area range to corresponding error ptg. + + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Converts specified index to token code. + + Index of the needed token. + Token that corresponds to the index. + + When index is less than one or greater than 3. + + + + + Converts specified token code to index. + + Token code for which index is required. + Index that corresponds to the code. + + When index is not one of tArea1, tArea2, tArea3. + + + + + Read-only. Size of the record. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to byte array. + + Array of bytes representing token. + + + + Moves row by iRowOffset, iColumnOffset. + + Row offset. + Column offset. + Parent workbook. + Updated token. + + + + + + + + + + + + + + Parent workbook. + + + + + Converts tokens from regular formula into tokens from shared formula. + + Parent workbook. + Represents first row from cells range of shared formula.Zero-base. + Represents first column from cells range of shared formula.Zero-based. + New token for shared formula. + + + + Converts full row or column ptg from Excel2007 to Excel97to03 version and vice versa. + + Returns converted Ptg. + Defines what conversion must be applied. + + + + + + + + + + + + + + + + Returns True if referenced cell was moved. + + + + + + + + + + + + + + Parent workbook. + + + + + + + + + + + + Parent workbook. + + + + + + + + + + + + Parent workbook. + + + + + Checks if while moving rectSource full top row was moved. + + Rectangle that was moved. + True if whole top row was moved. + + + + Checks if while moving rectSource full bottom row was moved. + + Rectangle that was moved. + True if whole bottom row was moved. + + + + Checks if while moving rectSource full left row was moved. + + Rectangle that was moved. + True if whole left row was moved. + + + + Checks if while moving rectSource full right row was moved. + + Rectangle that was moved. + True if whole right row was moved. + + + + + + + + + + + Parent workbook. + + + + + + + + + + + + Parent workbook. + + + + + + + + + + + + Parent workbook. + + + + + + + + + + + + Parent workbook. + + + + + + + + + + + + Parent workbook. + + + + + Checks whether one rectangle is outside of another one. + + First rectangle to check. + Second rectangle to check. + True if toCheck rectangle is outside of owner rectangle. + + + + Checks whether one rectangle is inside of another one. + + Rectangle that could contain another one. + Rectangle that could be contained by another one. + True if toCheck rectangle is contained by owner rectangle. + + + + + + + + + + + Parent workbook. + + + + + + + + + + + + Parent workbook. + + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Worksheet that contains range. + Range represented by the token. + + + + Returns rectangle represented by the token that implements this interface. + All coordinates are zero-based. + + Rectangle represented by the token. + + + + + + + + + + + Converts current token into error token. + + Created token. + + + + Converts current token to the 3D token. + + Reference to the worksheet. + Created token. + + + + Index of the first row (0..65535) or row offset (-32768..32767). + + + + + True if the first row index is relative. + + + + + True if the first column index is relative. + + + + + Index to column (0..255) or column offset (-128..127). + + + + + Index of the last row (0..65535) or row offset (-32768..32767). + + + + + True if the last row index is relative. + + + + + True if the last column index is relative. + + + + + Index to column (0..255) or column offset (-128..127). + + + + + Options for the top left cell of the range. + + + + + Options for the bottom right cell of the range. + + + + + Represents tokens that contains reference to worksheet. + + + + + This interface should be implemented by those tokens which contains 3D references. + + + + + Index to ExternSheetRecord. + + + + + Calls ToString method of the base (not 3d) class. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Index to REF entry in EXTERNSHEET record. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Creates token using data from an array of bytes. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + Constructs token by string value and parent workbook. + + String representation of the token. + Workbook containing the token. + + When specified formula string is not valid Area3D string. + + + + + Creates new token based on another Area3D token. + + Token to copy. + + + + Initializes new token. + + Worksheet reference index. + Zero-based first row index. + Zero-based first column index. + Zero-based last row index. + Zero-based last column index. + First cell options. + Second cell options. + + + + Initializes new token. + + Zero-based row index of the cell that will contain new token. + Zero-based column index of the cell that will contain new token. + Worksheet reference index. + String representation of the first row of the area. + String representation of the first column of the area. + String representation of the last row of the area. + String representation of the last column of the area. + Indicates whether strings are in R1C1 notation. + Parent workbook. + + + + Read-only. Size of the token. + + + + + Converts token to array of bytes. + + Array of bytes that represents this token. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + To check the sheet name it's having any special charecter or not + + + + + + + Converts tokens from regular formula into tokens from shared formula. + + Parent workbook. + Represents first row from cells range of shared formula.Zero-base. + Represents first column from cells range of shared formula.Zero-based. + New token for shared formula. + + + + Converts token from shared formula into token from regular formula. + + Parent workbook. + Row index. + Column index. + New token for regular formula. + + + + + + + + + + + + + + + + + + + + + + + + + + Parent workbook. + + + + + Converts incorrect area range to corresponding error ptg. + + + + + Calls ToString method of the base (not 3d) class. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Sets index of the sheet in the correct value, + taking information from the specified workbook. + + Name of the worksheet that is referenced. + + Workbook that contains this record and must contain specified worksheet. + + + Unable to find specified worksheet in the workbook, + possibly because wasn't loaded yet. + + + + + Set area values such as reference indexes, first and last columns, and rows. + + Match that contains such groups SheetName, Column1, Column2, Row1, Row2. + Workbook that contains this token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Converts specified index to the token code. + + Function parameter index. + Token code that corresponds to the specified index. + + When index is less than 1 or greater than 3. + + + + + Converts specified token code to index. + + Token code for which index is required. + Index that corresponds to the code. + + When index is not one of tArea1, tArea2, tArea3. + + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Worksheet that contains range. + Range represented by the token. + + + + Reference to the worksheet. Read-only. + + + + + Summary description for AreaError3dPtg. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Creates token using data from array of bytes. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + + + + + + + + + + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token code to index (inverse operation to IndexToCode). + + Reference index. + + + + Returns Ptg Offset + + + + + + + + + + + + + + + Converts specified index to the token code. + + Function parameter index. + Token code that corresponds to the specified index. + + When index is less than 1 or greater than 3. + + + + + Converts specified token code to index. + + Token code for which index is required. + Index that corresponds to the code. + + When index is not one of tAreaErr3d1, tAreaErr3d2, tAreaErr3d3. + + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Worksheet that contains range. + Range represented by the token. + + + + This token contains the last reference to a deleted cell range in the same sheet. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Creates token using data from array of bytes. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + + + + + + + + + + Parent workbook. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token code to index (inverse operation to IndexToCode). + + Reference index. + + + + Returns Ptg Offset + + + + + + + + + + + + + + + Converts specified index to token code. + + Index of the needed token. + Token that corresponds to the index. + + When index is less than one or greater than 3. + + + + + Converts specified token code to index. + + Token code for which index is required. + Index that corresponds to the code. + + When index is not one of tAreaErr1, tAreaErr2, tAreaErr3. + + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Worksheet that contains range. + Range represented by the token. + + + + This token contains the reference to a cell range in the same sheet. + + + + + Default constructor. To prevent user from creating tokens without + parameters and to allow descendants. + + + + + Creates token by its string representation. + + String representation of the formula. + Parent workbook. + + When specified string is not a valid token string. + + + + + Creates token using data from an array of bytes. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + Converts token from shared formula into token from regular formula. + + Parent workbook. + Row index. + Column index. + New token for regular formula. + + + + Converts token code to index (inverse operation to IndexToCode). + + Token code (should be one of tAreaN1, tAreaN2, tAreaN3). + Reference index. + + + + Converts reference index to token code. + + Reference index. + Token code. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Gets the index of the updated row. + + The i row. + The row. + The workbook. + if set to true [is first]. + + + + + Gets the index of the updated column. + + The i column. + The column. + The workbook. + if set to true [is first]. + + + + + Gets corresponding error code. + + Corresponding error code. + + + + First column offset (-128..127). + + + + + Column offset (-128..127). + + + + + This token contains an array constant. The values of the array constant do not follow + the token identifier but are stored behind the complete token array. + + + + + This interface should be implemented by all token classes that + needs some additional data to be read after all formula tokens. + + + + + Reads additional token data that is placed after all formula tokens. + + Object that provides access to the data. + Offset to the additional token data. + Final offset in the data array. + + + + Returns size of the additional data. Read-only. + + + + + Constant that indicates that there is double value in the array. + + + + + Constant that indicates that there is string value in the array. + + + + + Constant that indicates that there is boolean value in the array. + + + + + Constant that indicates that there is error code in the array. + + + + + Constant that indicates that there is null code in the array. + + + + + Separators between rows of the array. + + + + + Separators between columns of the array. + + + + + Number of columns decreased by 1. + + + + + Number of rows decreased by 1. + + + + + Array of cached values. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Constructs array token using string representation. + + Formula string. + Formula parser. + + + + Constructs array but does not read any data. ReadArray should be called for + this purpose because array data is placed just after all other tokens. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + Reads array from byte array. + + Object that provides access to the data. + Starting position of array data. + Offset if the first byte after array. + + When data array is too small for tArray data. + + + + + Fills tArray token with data from byte array. + + Object that provides access to the data. + Offset in data array. + Number of columns in this array. + Number of rows in this array. + Returns final offset in data array. + + + + Fills tArray token with data from byte array. + + Data array. + Offset in data array. + Number of columns in this array. + Number of rows in this array. + Returns final offset in data array. + + + + Fills tArray token getting data from array of strings. + + Array of string that contains array data. + Formula parser object that should assist in array items parsing. + + When one of the specified arguments is empty. + + + + + Tries to parse string value as double, bool, or string and returns resulting object. + + String constant that will be parsed. + Formula parser object that should assist in array items parsing. + Parsed constant (double, bool, or string). + + + + Returns all values in data array. Must be written after formula data. + + Array of bytes of all constants stored in the array. + + + + Returns an array representation of boolean value. + + Boolean value that will be converted. + Array of bytes representing boolean value. + + + + Returns an array representation of the error code value. + + Error code. + Array of bytes representing the error code. + + + + Returns an array representation of the null code value. + + Array of bytes representing the null code. + + + + Returns an array representation of double value. + + Double value that will be converted. + Array of bytes representing double value. + + + + Returns an array representation of the string value. + + String value that will be converted. + Array of bytes representing the string value. + + + + Sets token code in accordance with referenceIndex. + + Index that corresponds to the token code. + + When index is less than 1 or larger than 3. + + + + + Read-only. Size of the array token. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts tArray token to byte array. + + Excel version - defines resulting array format and size. + Array of bytes representing this token. + + + + Returns token code by index. + + Index of the needed token. + + + When index is less than 1 or larger than 3. + + + + + + + + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + + + + + + A special attribute control token - typically either a SUM function or an IF function. + + + + + This class represents function with variable arguments number in a formula. + + + + + This class represents function token of a formula. + + + + + This class is the base class for all operation tokens in the formula. + + + + + Default arguments separator. + + + + + String representation of the operation. + + + + + Position of the operand (before (if it is set to False) or after (if it is set to True) operand) for unary operations. + + + + + Default constructor. + + + + + Creates operation from byte array and offset in this array. + + Object that provides access to the data. + Offset to token data. + Excel version that was used to infill data provider. + + + + Converts the operation and its operands to the string. + Gets all needed operands from the Stack parameter and pushes the result into the Stack. + + + Stack that contains all operands and receives result of the operation. + + + + + Converts the operation and its operands to the string. + Gets all needed operands from the Stack parameter and pushes the result into the Stack. + + Object used for formula parsing. + + Stack that contains all operands and receives result of the operation. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Returns array of string where each member corresponds to one argument. + + String representation of the formula. + Index of the operation. + Formula parser. + Array of strings containing operation operands. + + + + Updates parse formula options if necessary. + + Options to update. + Updated value. + + + + Returns arguments separator. + + FormulaUtil object, to get separator from. + Arguments separator. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Read-only. True if this class represents operation (always True for this class). + + + + + Read-only. Type of the operation. + + + + + Read-only. Number of operands this operation needs. + + + + + Gets / sets string representation of the operation. + + + + + Gets / sets True if operation sign should be placed after operand and False otherwise. + + + + + Array of all token attributes applied to the object. + This property is used to increase performance. + + + + + Delimiter between function arguments. + + + + + Index to built-in sheet function. + + + + + Number of arguments. + + + + + Default constructor + + + + + Constructs token using data from byte array. + + Object that provides access to the data. + Offset to token data. + Excel version that was used to infill data provider. + + + + Constructs token by function index. + + Function index. + + + + Constructs function token by function name. + + Valid function name. + + + + Gets operands from string and returns array of string representation of the operands. + + Formula string. + Index to built-in function. + True if function should check operands count. + Formula parser. + Array of strings that contain function operands. + + if checkParamCount = True and actual parameter count does not equal expected + + + + + + + + + + + + Read-only. Size of the token. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts the operation and its operands to the string. + Gets all needed operands from the Stack parameter and pushes the result into the Stack. + + Object used for formula parsing. + + Stack that contains all operands and receives result of the operation. + + + + + Converts the operation and its operands to the string for get the lambda expression. + + Object used for formula parsing. + Stack that contains all operands and receives result of the operation. + Count of the lambda function after close parenthesis. + Str delimeter is used in the lambda expression. + String that contains lambda expression. + + + + Gets operands from string and returns array of string representation of the operands. + + Formula string. + Index of the function in the formula string. + Formula parser. + Array of strings that contains function operands. + + + + Converts token to byte array. + + Array of bytes representing this token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Returns built-in function index. + + + + + Number of function arguments. + + + + + Read-only. Type of operation (TYPE_FUNCTION for all functions). + + + + + Array of all token attributes applied to the object. + This property is used to increase performance. + + + + + Constructs token using data from byte array. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + Constructs token by built-in function index. + + Built-in function index. + + + + Constructs function token by function name. + + Valid function name. + + + + Default constructor + + + + + Read-only. Size of the token. + + + + + Gets operands from string and returns array of string representation of the operands. + + Formula string. + Index of function in the string. + Formula parser. + Array of strings containing function parameters. + + + + Converts token to byte array. + + Array of bytes representing this token. + + + + Takes all needed operands from the stack and pushes the result of the function. + + Object used for formula parsing. + + Stack that contains all operands and will receive result of the operation. + + + + + + + + + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Size of the token. + + + + + Size of word in bytes. + + + + + Sum function name. + + + + + If function name. + + + + + Goto function name. + + + + + Choose function name. + + + + + Not implemented message. + + + + + + + + + + The options used by the attribute. + + + + + The word contained in this attribute. + + + + + Offsets to the CHOOSE cases. Must be valid only if HasOptimizedChoose is true. + + + + + Default constructor for this token. + + + + + Constructs token and fills it with data from the byte array. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + Constructs token by options value and data. + + Attribute options. + Attribute data. + + + + Constructs token by options value and data. + + Attribute options. + Attribute data. + + + + Read-only. Size of the token. + + + + + Takes all needed operands from the stack and pushes the result of the function. + + Object used for formula parsing. + + Stack that contains all operands that receive result of the operation. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to array of bytes. + + Array of bytes representing this token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Read-only. Options used by the attribute. + + + + + The word contained in this attribute. + + + + + + + + + + Gets / sets number of spaces in the case of space token. + + + + + + + + + + True when following function has semivolatile value, + that can change without user interaction (such as NOW, TODAY, etc.). + + + + + Returns True if this is an IF; otherwise False. + + + + + Returns True if this is a CHOOSE; otherwise False. + + + + + Returns True if this is a goto; otherwise False. + + + + + Returns True if this is SUM; otherwise False. + + + + + + + + + + Returns True if space exist; otherwise False. + + + + + + This class represents every binary operation. + + + + + Dictionary that allows to convert operation name to the token code. + + + + + Dictionary that allows to convert operation token code to its string representation. + + + + + Contains all token attributes. + + + + + Static constructor. Fills hashtable that allows us to get + token code by token string. + + + + + Returns token code by string representation of the operation. + + String representation of the operation. + Token code. + + + + Returns token code by string representation of the operation. + + Token to get string representation for. + String representation of the token. + + + + Default constructor. + + + + + Constructs BinaryOperation using string that contains the sign of operation. + + String representation of the operation. + + + + Constructs BinaryOperation using string that contains the sign of operation. + + Token code of the operation to create. + + + + Constructs token using array with data and offset. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + Takes all needed operands from the stack and pushes the result of the operation. + + Object used for formula parsing. + + Stack that contains all operands and will receive result of the operation. + + + + + Gets operands from string and returns array of string representation of the operands. + + String representation of the formula. + Index of operation in the string. + Formula parser. + Array of strings with operation operands. + + + + + + + + + Read-only. Number of operands (always 2 for binary operations). + + + + + Read-only. Type of the operation ( TYPE_BINARY for binary operations). + + + + + Array of all token attributes applied to the object. + This property is used to increase performance. + + + + + This token represents a boolean operand in a formula. + + + + + Boolean value. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Constructs token by boolean value. + + Boolean value that will be placed into this token. + + + + Constructs token by string value. + + String value, should be valid boolean string. + + + + Constructs token using data from byte array. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + Read-only. Size of this token. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to byte array. + + Array of bytes representing this token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Gets / sets boolean value that is represented by this class. + + + + + Summary description for CellIntersectionPtg. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Intersections cell ptg. + + + + + + Intersections cell ptg. + + Object that provides access to the data. + Current index. + Excel version that was used to infill data provider. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Gets size. Override. + + + + + Represents CellRangeList formula token. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Constructs BinaryOperation using string that contains the sign of operation. + + String representation of the operation. + + + + Constructs token using array with data and offset. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + Converts token to a string. + + Object used for formula parsing. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + This class represents the control token (this can be tExp or tTbl). + + + + + This token contains an unsigned 16-bit integer value in the range from 0 to 65535. + + + + + Bit mask for row options. + + + + + Bit mask for column options. + + + + + Opening bracket for relative cell coordinates in R1C1 notation. + + + + + Closing bracket for relative cell coordinates in R1C1 notation. + + + + + Starting row character in R1C1 notation. + + + + + Starting column character in R1C1 notation. + + + + + Opening bracket for relative indexes in R1C1 notation. + + + + + Closing bracket for relative indexes in R1C1 notation. + + + + + Index to row (0..65535) or row offset (-32768..32767). + + + + + Index to column (0..255) or column offset (-128..127). + + + + + Option flags. + + + + + Default constructor: + To prevent user from creating tokens without arguments + and to allow descendants to do this. + + + + + Constructs reference by its string representation. + + String representation of the reference. + + + + Creates token using data from array of bytes. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + Creates token by coordinates and options. + + Row index. + Column index. + Options. + + + + Constructs reference by its string representation. + + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + String representation of the row. + String representation of the column. + Indicates whether R1C1 notation was used. + + + + + + + + + + Read-only. Size of the record. + + + + + Converts token to a string. + + String representation of the token. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to array of bytes. + + Array of bytes that represents the token. + + + + Sets internal fields appropriate to specified row and column. + + Row index of the cell that contains this token. + Column index of the cell that contains this token. + String that contains column name. + String that contains row name. + Indicates whether R1C1 notation is used. + + + + Sets internal fields appropriate to specified row and column. + + String that contains column name. + String that contains row name. + + + + Sets internal fields appropriate to specified row and column. + + Row index of the cell that contains this token. + Column index of the cell that contains this token. + String that contains column name. + String that contains row name. + + + + Parses row or column index in R1C1 notation. + + Row or column index of the cell that contains reference. + String to parse. + Indicates whether index is relative. + + + + + Creates token and modifies it row and column indexes. + + Row offset. + Column offset. + Parent workbook. + Modified token. + + + + Returns modified token after move operation. + + Current sheet index. + Parent cell row index. + Parent cell column index. + Source sheet index. + Source rectangle. + Destination sheet index. + Destination rectangle. + Indicates whether token was changed. + Parent workbook. + + + + + Moves token into different worksheet. + + Token to move + Source sheet index. + Source rectangle. + Destination sheet index. + Row offset. + Column offset. + Parent workbook. + Modified token. + + + + Returns True if referenced cell was moved. + + + + + + + Converts token code to index (inverse operation to IndexToCode). + + Reference index. + + + + Gets corresponding error code. + + Corresponding error code. + + + + Updates token after move operation. + + Current sheet index. + Destination sheet index. + Row index. + Column index. + Indicates whether token was changed. + Parent workbook. + Updated token. + + + + Converts tokens from regular formula into tokens from shared formula. + + Parent workbook. + Represents first row from cells range of shared formula.Zero-base. + Represents first column from cells range of shared formula.Zero-based. + New token for shared formula. + + + + Returns True if bit specified by mask is set to 1; otherwise False. + + Options byte where bits will be checked. + Bit mask that should be used for checking. + True if bit specified by mask is set to 1. + + + + If value is True, then it sets all bits specified by mask in Options to 1; + otherwise clears them, return new value. + + Options byte where bits will be set. + Bit mask that should be used for checking. + Flag for operation. + Return Options with bit specified by mask set to value. + + + + Returns string representation of the cell. + + Row index of the cell that contains token. + Column index of the cell that contains token. + Index of cell row. + Index of cell column. + True if row is relative. + True if column is relative. + Indicates whether R1C1 notation must be used for string conversion. + String representation of the cell address. + + + + Returns string representation of the cell using A1 notation. + + Index of cell column. + Index of cell row. + True if column is relative. + True if row is relative. + String representation of the cell address. + + + + Return string representation of the cell in RC format. + RC format is format in which set only shifts from start row to other one. + + Index of cell column. + Index of cell row. + String representation of the cell address. + + + + Returns column index of the cell. + + Column index of the cell that contains token. + String representation of the column. + Column index. + Indicates whether R1C1 notation is used. + Indicates whether resulting column index is relative. + + When parsed column index is greater than 255. + + + + + Returns column index of the cell. + + String representation of the column. + Column index. + Indicates whether resulting column index is relative. + + When parsed column index is greater than 255. + + + + + Returns row index of the cell. + + Row index of the cell that contains token. + String representation of the row. + Indicates whether R1C1 notation is used. + Indicates whether row index is relative. + Row index. + + + + Returns row index of the cell. + + String representation of the row. + Indicates whether row index is relative. + Row index. + + + + Converts reference index to token code. + + Reference index. + Token code. + + + + Converts token code to index (inverse operation to IndexToCode). + + Token code (should be one of tRef1, tRef2, tRef3). + Reference index. + + + + Gets string representation of the cell in R1C1 notation. + + Row index of the cell that contains token. + Column index of the cell that contains token. + Cell row index. + Cell column index. + Indicates whether row is relative. + Indicates whether column is relative. + String representation of the cell in R1C1 notation. + + + + Converts row or column index into string representation using R1C1 notation. + + + Row or column index of a cell that contains reference to convert. + + Starting character. + End index. + Indicates whether index is relative. + String representation of row or column index using R1C1 notation. + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Worksheet that contains range. + Range represented by the token. + + + + Returns rectangle represented by the token that implements this interface. + All coordinates are zero-based. + + Rectangle represented by the token. + + + + + + + + + + + Converts current token to the 3D token. + + Reference to the worksheet. + Created token. + + + + Converts current token into error token. + + Created token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Set the byte value to Option flag. + + Byte value + + + + Gets / sets. Index to row (0..65535) or row offset (-32768..32767). + + + + + Gets / sets True if row index is relative. + + + + + Gets / sets True if column index is relative. + + + + + Gets / sets index to column (0..255) or column offset (-128..127). + + + + + Options. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Constructs token from byte array. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + + + + + + + + Read-only. Size of the token. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to byte array. + + Array of bytes that represents this token. + + + + + + + + + Moves token into different worksheet. + + Token to move + Source sheet index. + Source rectangle. + Destination sheet index. + Row offset. + Column offset. + Parent workbook. + Modified token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + + + + + + + + + + + + This token contains an error code. + + + + + Default error name - used when unknown error code was used. + + + + + Dictionary that allows to get error code by error name. + + + + + Dictionary that allows to get error name by error code. + + + + + Error code. + + + + + Static constructor. Fills hashtables which allow to convert + error code to error string and vice versa. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Constructs token using byte array. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + Constructs token using error code. + + + String representation of the error that must be created. + + + When the specified error name is unknown. + + + + + Constructs token using error name. + + Name of the error. + + + + Read-only. Size of the token. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to byte array. + + Array of bytes representing this token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Gets / sets error code value. + + + + + This token contains an IEEE floating-point number. + + + + + Floating-point value. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Constructs token by double value. + + Double value. + + + + Constructs token by string value that represents number. + + String value that will be converted to double. + + + + Constructs token by string value that represents number. + + String value that will be converted to double. + Represents culture for parsing from string. + + + + Constructs token using data from byte array. + + Object that provides access to the data. + Offset to token data. + Excel version that was used to infill data provider. + + + + Read-only. Size of the token. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + Represents current number info. + String representation of this token. + + + + Converts token to byte array. + + Array of bytes representing this token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Gets / sets value that is represented by this token. + + + + + This class represents an integer token in formula. + + + + + Contains an unsigned 16-bit integer value in the range from 0 to 65535. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Constructs token by integer value. + + Integer value that will be placed into token. + + + + Constructs token by string value. + + String value that will be parsed into unsigned short. + + + + Constructs token using data from byte array. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + Read-only. Size of the token. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to array of bytes. + + Array of bytes corresponding to the token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Get / sets value contained by this token. + + + + + Summary description for MemAreaPtg. + + + + + Size of the one rectangle data. + + + + + Size of the header block. + + + + + Reserved. + + + + + The length of the reference subexpression. + + + + + Subexpression. + + + + + + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + + + + + Excel version that was used to infill data provider. + + + + + + + + + + Size of the ptg token. Read-only. + + + + + Converts token to byte array. + + Array of bytes representing this token. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Extracts additional data. + + Object that provides access to the data. + Offset to the additional data. + Offset after extracting all required data. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Returns the length of the reference subexpression. Read-only. + + + + + Returns the reference subexpression. Read-only. + + + + + Rectangles. + + + + + Returns size of the additional data. Read-only. + + + + + Not fully implemented because of lack of documentation. + + + + + Size of the token. + + + + + Token data. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Creates token using data from array of bytes. + + Object that provides access to the data. + Offset to the token data in the data array. + Excel version that was used to infill data provider. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to the array of bytes. + + + + + + Read-only. Size of the token. + + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Not fully implemented because of lack of documentation. + + + + + Size of the token. + + + + + The length of the reference subexpression. + + + + + Token data. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Create new instance of MemFuncPtg. + + Size of new instance. + + + + Creates token using data from array of bytes. + + Object that provides access to the data. + Offset to the token data in the data array. + Excel version that was used to infill data provider. + + + + Read-only. Size of the token. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to the array of bytes. + + + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + The length of the reference subexpression. + + + + + A missing argument in a function argument list that is stored as a tMissArg token. + This token does not contain any additional data. + + + + + Default constructor + + + + + Constructs token using data from byte array. + + Object that provides access to the data. + Offset to token data. + Excel version that was used to infill data provider. + + + + Almost the same as default constructor. + + Must be equal to string.Empty. + + When specified string is not empty. + + + + + Read-only. Size of the token. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + This token contains the one-based index to a NAME record. + + + + + One-based Index of ExternNameRecord. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Constructs token using data from a byte array. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + Creates token by its string representation. + + String representation of the token. + Workbook that contains this reference. + + + + Creates token by its string representation. + + String representation of the token. + Workbook that contains this reference. + Worksheet that contains this reference. + + + + Creates token by name index. + + Name index. + + + + Read-only. Size of the token. + + + + + Converts token to string. + + String representation of the token. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to array of bytes. + + Array of bytes representing this token. + + + + Returns token code by index. + + Index of the token code. + Required token code. + + When index is less than 1 or greater than 3. + + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Parent sheet. + Range represented by the token. + + + + Returns rectangle represented by the token that implements this interface. + + Rectangle represented by the token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Gets / sets one-based index of ExternNameRecord. + + + + + Gets / sets one-based index of ExternNameRecord for Int32. + + + + + This token contains the index to a NAME or EXTERNNAME record. It occurs by using + internal or external names, add-in functions, DDE links, or linked OLE objects. + + + + + Index to a REF entry in an EXTERNSHEET record in the Link Table. + + + + + One-based index to a NAME record or EXTERNNAME record. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Constructs token using data from array of bytes. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + Creates token by its string representation. + + String representation of the token. + Workbook that contains this reference. + + + + Creates new instance of NameX token by extern workbook index and name index in the workbook. + + Zero-based book index. + Zero-based name index. + + + + Read-only. Size of the record. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Calls ToString method of the base (not 3d) class. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to array of bytes. + + Array of bytes corresponding to the token. + + + + Returns token code by index + + Index of the token code. + Required token code. + + When index is less than 1 or greater than 3. + + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Parent worksheet + Range represented by the token. + + + + Returns rectangle represented by the token that implements this interface. + + Rectangle represented by the token. + + + + + + + + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Gets / sets one-based index of ExternNameRecord or NameRecord. + + + + + Gets / sets index to REF entry in EXTERNSHEET record in the Link Table. + + + + + Parentheses. This token is for display purposes only, it does not affect the result + of the token array. If it follows an operator, the parentheses will enclose + the operator and its operand(s), which is the result of the enclosed + operation. This operator does not modify the token class of its operand. + + + + + This class represents all unary operations. + + + + + Contains all token attributes. + + + + + Dictionary that allows to get token code by unary operation name. + + + + + Static constructor. Fills hashtable that allows us to get + token code by token string. + + + + + Gets token code using unary operation string representation. + + String representation of the unary operation. + Token code. + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Constructs unary operation token by its string representation. + + + String representation of the operation that will be created. + + + + + Creates unary operation from the data array and offset of the first byte in it. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + Read-only. Size of the token. + + + + + Takes all needed operands from the stack and pushes the result of the operation. + + Object used for formula parsing. + + Stack that contains all operands and will receive the result of the operation. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Returns array of operands. + + Formula string. + Index of unary operation in the formula string. + Formula parser. + Array of strings that contain unary operation operands. + + + + Read-only. Type of operation. + + + + + Array of all token attributes applied to the object. + This property is used to increase performance. + + + + + Contains all token attributes. + + + + + Static constructor. + + + + + Default constructor + + + + + Creates token using data from an array of bytes. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + Creates token by string representation. + + String should be equal to "(". + + When strFormula is not equal to "(". + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Gets all needed operands from the Stack parameter and pushes result into the Stack. + + Object used for formula parsing. + + Stack that contains all operands and will receive operation result as string. + + + + + Returns array of string where each member corresponds to one argument. + + Formula string. + Index of opening bracket. + Formula parser. + Array of strings that contain operation parameters. + + + + Updates parse formula options if necessary. + + Options to update. + Updated value. + + + + Returns all TokenAttributes applied to the token. Read-only. + + + + + This token contains a 3D reference or an external reference to a cell. + + + + + Index to a REF entry in an EXTERNSHEET record in the Link Table. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Creates token using data from an array of bytes. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + Creates token by its string representation. + + String representation of the token. + Workbook that contains this reference. + + + + + + + + + + + + + + + Creates token. + + Sheet reference. + Row index. + Column index. + Options. + + + + + + + + + + Read-only. Size of the record. + + + + + Converts token to the string. + + String representation of the token. + + + + Converts token to the array of bytes. + + Array of bytes that represents this token. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Calls ToString method of the base (not 3d) class. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + + + + + + + + + + + Parent workbook. + + + + + Converts token from shared formula into token from regular formula. + + Parent workbook. + Row index. + Column index. + New token for regular formula. + + + + Converts tokens from regular formula into tokens from shared formula. + + Parent workbook. + Represents first row from cells range of shared formula.Zero-base. + Represents first column from cells range of shared formula.Zero-based. + New token for shared formula. + + + + Converts tokens from regular formula into tokens from shared formula. + + + + + + Converts token code to index (inverse operation to IndexToCode). + + Reference index. + + + + Gets corresponding error code. + + Corresponding error code. + + + + Returns referenced worksheet name. + + Parent workbook. + Sheet reference index + Referenced worksheet name. + + + + Sets index of the sheet in correct value + by getting the information from specified workbook. + + Name of the worksheet that is referenced. + + Workbook that contains this record. It must contain specified worksheet. + + + + + Returns token code by index. + + Index of the token code. + Required token code. + + When index is less than 1 or greater than 3. + + + + + Converts token code to index (inverse operation to IndexToCode). + + Token code (should be one of tRef1, tRef2, tRef3). + Reference index. + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Worksheet that contains range. + Range represented by the token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + + + + + + This token contains a 3D reference or an external reference to a cell. + + + + + This token contains the reference to a cell in the same sheet. It stores relative + components as signed offsets and is used in shared formulas, conditional formatting, + and data validity. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Creates token using data from an array of bytes. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + Constructs reference by its string representation. + + Row index of the cell that contains formula to parse. + Column index of the cell that contains formula to parse. + String representation of the row. + String representation of the column. + Indicates whether R1C1 notation was used. + + + + Converts token from shared formula into token from regular formula. + + Parent workbook. + Row index. + Column index. + New token for regular formula. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts current token to the 3D token. + + Reference to the worksheet. + Created token. + + + + Gets corresponding error code. + + Corresponding error code. + + + + Converts token code to index (inverse operation to IndexToCode). + + Token code (should be one of tRefN1, tRefN2, tRefN3). + Reference index. + + + + Converts reference index to token code. + + Reference index. + Token code. + + + + Index to a REF entry in an EXTERNSHEET record in the Link Table. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Creates token using data from an array of bytes. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + Creates token by its string representation. + + String representation of the token. + Workbook that contains this reference. + + + + Creates token. + + Row index of the cell that contains this token. + Column index of the cell that contains this token. + Sheet reference. + String that contains column name. + String that contains row name. + Indicates whether R1C1 notation should be used. + + + + Creates token. + + Sheet reference. + Row index. + Column index. + Options. + + + + Converts token from shared formula into token from regular formula. + + Parent workbook. + Row index. + Column index. + New token for regular formula. + + + + Read-only. Size of the record. + + + + + Converts token to the string. + + String representation of the token. + + + + Converts token to the array of bytes. + + Array of bytes that represents this token. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Calls ToString method of the base (not 3d) class. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Returns modified token after move operation. + + Current sheet index. + Parent cell row index. + Parent cell column index. + Source sheet index. + Source rectangle. + Destination sheet index. + Destination rectangle. + Indicates whether token was changed. + Parent workbook. + + + + + Converts token code to index (inverse operation to IndexToCode). + + Reference index. + + + + Gets corresponding error code. + + Corresponding error code. + + + + Returns referenced worksheet name. + + Parent workbook. + Sheet reference index + Referenced worksheet name. + + + + Sets index of the sheet in correct value + by getting the information from specified workbook. + + Name of the worksheet that is referenced. + + Workbook that contains this record. It must contain specified worksheet. + + + + + Returns token code by index. + + Index of the token code. + Required token code. + + When index is less than 1 or greater than 3. + + + + + Converts token code to index (inverse operation to IndexToCode). + + Token code (should be one of tRef1, tRef2, tRef3). + Reference index. + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Worksheet that contains range. + Range represented by the token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Index to a REF entry in an EXTERNSHEET record in the Link Table. + + + + + This token contains the last 3D reference or external reference to a cell in a + deleted row or column. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Creates token using data from an array of bytes. + + Object that provides access to the data. + Offset to token data. + Excel version that was used to infill data provider. + + + + Creates token by its string representation. + + String representation of the token. + Workbook that contains this reference. + + + + Creates error token based on Ref3D token. + + Token to get data from. + + + + Converts token to string. + + String representation of this token. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + + + + + + + + + + + Parent workbook. + + + + + Returns token code by index. + + Index of the token code. + Required token code. + + When index is less than 1 or greater than 3. + + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Worksheet that contains range. + Range represented by the token. + + + + This token contains the last reference to a deleted cell in the same sheet. + + + + + + + + + + Static constructor. + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Creates token using data from array of bytes. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + + + + + + + + + + + + + + Creates error token based on specified ref token. + + Token to take data from. + + + + Converts token to a string. + + String representation of this token. + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + + + + + + + + + + + Parent workbook. + + + + + Converts reference index to token code. + + Reference index. + Token code. + + + + Converts tokens from regular formula into tokens from shared formula. + + Parent workbook. + Represents first row from cells range of shared formula.Zero-base. + Represents first column from cells range of shared formula.Zero-based. + New token for shared formula. + + + + Returns range represented by the token that implements this interface. + + Workbook that contains range. + Worksheet that contains range. + Range represented by the token. + + + + This token contains a string constant. + The maximum length of the string is 255 characters in BIFF8. + + + + + String value. + + + + + 1 - 2 bytes per character, 0 - 1 byte per character (compressed unicode). + + + + + Default constructor. To prevent user from creating a token without + parameters and to allow descendants do this. + + + + + Constructs token by string value. + + Value that will contain this token. + + + + Creates token using data from array of bytes. + + Object that provides access to the data. + Offset to the token data. + Excel version that was used to infill data provider. + + + + Read-only. Size of the token. + + + + + Converts token to a string. + + Formula util. + Zero-based row index of the cell that contains this token. + Zero-based row index of the cell that contains this token. + Indicates whether R1C1 notation should be used. + String representation of this token. + + + + Converts token to array of bytes. + + Array of bytes that correspond to the token. + + + + Infill PTG structure. + + Represents storage. + Offset in storage. + Excel version that was used to infill data provider. + + + + Gets / sets value of this token (its string constant). + + + + + This class represents the unknown token of a formula. + + + + + Default constructor + + + + + Creates token from an array of bytes. + + Object that provides access to the data. + Offset to the token data in data array. + Excel version that was used to infill data provider. + + + + Read-only. Size of the token. + + + + + Converts token to string. + + Converts token to the string. + + + + Summary description for _FormulaConstants. + + + + + + + + + + Represents the tAdd binary token. + + + + + Represents the tSub binary token. + + + + + Represents the tMul binary token. + + + + + Represents the tDiv binary token. + + + + + Represents the tPower binary token. + + + + + Represents the tConcat binary token. + + + + + Represents the tLessThan binary token. + + + + + Represents the tLessEqual binary token. + + + + + Represents the tEqual binary token. + + + + + Represents the tGreaterEqual binary token. + + + + + Represents the tGreater binary token. + + + + + Represents the tNotEqual binary token. + + + + + Represents the tCellRangeIntersection binary token. + + + + + Represents the tCellRangeList binary token. + + + + + Represents the tCellRange binary token. + + + + + Represents the tUnaryPlus unary token. + + + + + Represents the tUnaryMinus unary token. + + + + + Represents the tPercent unary token. + + + + + Represents the tParentheses unary token. + + + + + Represents the tFunction1 function token. + + + + + Represents the tFunction2 function token. + + + + + Represents the tFunction3 function token. + + + + + Represents the tFunctionVar1 function token. + + + + + Represents the tFunctionVar2 function token. + + + + + Represents the tFunctionVar3 function token. + + + + + Represents the tFunctionCE1 function token. + + + + + Represents the tFunctionCE2 function token. + + + + + Represents the tFunctionCE3 function token. + + + + + Represents the tMissingArgument constant token. + + + + + Represents the tStringConstant constant token. + + + + + Represents the tError constant token. + + + + + Represents the tBoolean constant token. + + + + + Represents the tInteger constant token. + + + + + Represents the tNumber constant token. + + + + + Represents the tExp control token. + + + + + Represents the tTbl control token. + + + + + Represents the tExtended control token. + + + + + Represents the tAttr control token. + + + + + Represents the tSheet control token. + + + + + Represents the tEndSheet control token. + + + + + Represents the tArray1 operand token. + + + + + Represents the tArray2 operand token. + + + + + Represents the tArray3 operand token. + + + + + Represents the tName1 operand token. + + + + + Represents the tName2 operand token. + + + + + Represents the tName3 operand token. + + + + + Represents the tRef1 operand token. + + + + + Represents the tRef2 operand token. + + + + + Represents the tRef3 operand token. + + + + + Represents the tArea1 operand token. + + + + + Represents the tArea2 operand token. + + + + + Represents the tArea3 operand token. + + + + + Represents the tMemArea1 operand token. + + + + + Represents the tMemArea2 operand token. + + + + + Represents the tMemArea3 operand token. + + + + + Represents the tMemErr1 operand token. + + + + + Represents the tMemErr2 operand token. + + + + + Represents the tMemErr3 operand token. + + + + + Represents the tMemNoMem1 operand token. + + + + + Represents the tMemNoMem2 operand token. + + + + + Represents the tMemNoMem3 operand token. + + + + + Represents the tMemFunc1 operand token. + + + + + Represents the tMemFunc2 operand token. + + + + + Represents the tMemFunc3 operand token. + + + + + Represents the tRefErr1 operand token. + + + + + Represents the tRefErr2 operand token. + + + + + Represents the tRefErr3 operand token. + + + + + Represents the tAreaErr1 operand token. + + + + + Represents the tAreaErr2 operand token. + + + + + Represents the tAreaErr3 operand token. + + + + + Represents the tRefN1 operand token. + + + + + Represents the tRefN2 operand token. + + + + + Represents the tRefN3 operand token. + + + + + Represents the tAreaN1 operand token. + + + + + Represents the tAreaN2 operand token. + + + + + Represents the tAreaN3 operand token. + + + + + Represents the tMemAreaN1 operand token. + + + + + Represents the tMemAreaN2 operand token. + + + + + Represents the tMemAreaN3 operand token. + + + + + Represents the tMemNoMemN1 operand token. + + + + + Represents the tMemNoMemN2 operand token. + + + + + Represents the tMemNoMemN3 operand token. + + + + + Represents the tNameX1 operand token. + + + + + Represents the tNameX2 operand token. + + + + + Represents the tNameX3 operand token. + + + + + Represents the tRef3d1 operand token. + + + + + Represents the tRef3d2 operand token. + + + + + Represents the tRef3d3 operand token. + + + + + Represents the tArea3d1 operand token. + + + + + Represents the tArea3d2 operand token. + + + + + Represents the tArea3d3 operand token. + + + + + Represents the tRefErr3d1 operand token. + + + + + Represents the tRefErr3d2 operand token. + + + + + Represents the tRefErr3d3 operand token. + + + + + Represents the tAreaErr3d1 operand token. + + + + + Represents the tAreaErr3d2 operand token. + + + + + Represents the tAreaErr3d3 operand token. + + + + + Represents the tRefN3d1 operand token. + + + + + Represents the tRefN3d2 operand token. + + + + + Represents the tRefN3d3 operand token. + + + + + Indicates end of formula token. This token is used only for parser + internal purposes and shouldn't appear in the resulting formula. + + + + + Indicates closing parenthesis. This token is used only for parser + internal purposes and shouldn't appear in the resulting formula. + + + + + Indicates delimiter between arguments. This token is used only for parser + internal purpose and shouldn't appear in the resulting formula. + + + + + Indicates open bracket. This token is used only for parser + internal purpose and shouldn't appear in the resulting formula. + + + + + Indicates close bracket. This token is used only for parser + internal purpose and shouldn't appear in the resulting formula. + + + + + Indicates boolean value - true. This token is used only for parser + internal purpose and shouldn't appear in the resulting formula. + + + + + Indicates boolean value - false. This token is used only for parser + internal purpose and shouldn't appear in the resulting formula. + + + + + Indicates space token. This token is used only for parser + internal purpose and shouldn't appear in the resulting formula. + + + + + Indicates identifier token. This token can be range, named range, function call, etc. + This token is used only for parser internal purpose and shouldn't appear in the resulting formula. + + + + + Indicates identifier token that contains DDE link. + This token is used only for parser internal purpose and shouldn't appear in the resulting formula. + + + + + Indicates 3D identifier token. This token can be range, named range. + This token is used only for parser internal purpose and shouldn't appear in the resulting formula. + + + + + Represents the operation type. + + + + + Represents the TYPE_UNARY operation type. + + + + + Represents the TYPE_BINARY operation type. + + + + + Represents the TYPE_FUNCTION operation type. + + + + + + + + + + None priority. + + + + + Logical equality priority. + + + + + Concatenation priority. + + + + + Plus and minus operation priority. + + + + + Multiplication and divide operations priority. + + + + + Priority of the power operation. + + + + + Unary operation priority (-,+,%). + + + + + Cell Range operator (:). + + + + + Attribute provides link information between formula token and + formula token class. + + + + + Type of the formula token. + + + + + String representation of the operation (if this is attribute for + operation), otherwise string.Empty. + + + + + True if operation symbol should be placed after operand + (only for unary operands). + + + + + Cannot create without parameters. + + + + + Creates token attribute by Formula code. + + Code of the token that will be created. + + + + Creates token attribute by formula code and operation sign. + + Token code. + String representation of the operation. + + + + Creates token attribute by formula code, operation sign, and position of + placement (before the False or after the True operand - this is only for unary operations, + default value is False). + + Code of the operation. + String representation of the operation. + True if operation is placed after operands; False if before. + + + + Read-only. Type of the formula token. + + + + + Read-only. String representation of the operation (if this is attribute for + operation); otherwise string.Empty. + + + + + Read-only. True if operation symbol should be placed after operand + (only for unary operands). + + + + + There can be multiple token codes that correspond to one class, + i.e. tRef1, tRef2, tRef3 correspond to class RefPtg. + This attribute is used to help FormulaUtil choose the token code to use. + + + + + Index of the reference type (for tokens that can have several types). + + + + + Array of indexes, first correspond to first parameter, + second for the second parameter and so on. + + + + + Expected token type. + + + + + To prevent construction without arguments. + + + + + Creates attribute that describes the function that has + the same token index index for all arguments. + + Index of the token. + + + + Creates attribute for function with specified token indexes order. + First member of the array corresponds to the first argument of the function, + second member for the second argument and so on. + + Array of token indexes. + + + + Creates attribute for specified token type with specified token indexes. + + Target token class. + Array of token indexes. + + + + Creates attribute for specified token type with specified token indexes. + + Target token class. + Token index for all function parameters. + + + + Returns index of the reference. + + + + + Returns token index for the specified argument number. + + + + + Target token class + + + + + + + + + + This attribute describes error code. Used for converting error messages from + and to string. + + + + + String that represents error. + + + + + Code of the error. + + + + + To prevent creation without arguments. + + + + + Creates attribute for error with specified string value and error code. + + String representation of the error. + Error code. + + + + + + + + + + + + + + This record specifies if the option to print sheet grid lines + (PrintGridlinesRecord) has ever been changed. + + + + + Correct size of the record. + + + + + Flag denoting whether the user has modified the grid lines. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + This flag specifies if the option to print sheet grid lines + (PrintGridlinesRecord) has ever been changed. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Contains information about the layout of outline symbols. + + + + + Width of the area to display row outlines (left of the sheet), in pixels. + + + + + Height of the area to display column outlines (above the sheet), in pixels. + + + + + Number of visible row outline levels (used row levels + 1; + or 0, if not used). + + + + + Number of visible column outline levels (used column levels + 1; + or 0, if not used). + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Width of the area to display row outlines (left of the sheet), in pixels. + + + + + Height of the area to display column outlines (above the sheet), in pixels. + + + + + Number of visible row outline levels (used row levels + 1; + or 0, if not used). + + + + + Number of visible column outline levels (used column levels + 1; + or 0, if not used). + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + If this record exists in the stream, then Excel contains Visual Basic macros. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Maximum possible size of the record. Read-only. + + + + + Summary description for HeaderFooterImageRecord. + + + + + This record contains a drawing object provided by the Drawing tool. + + + + + Data offset. + + + + + + + + + + + + + + + Default constructor + + + + + Dispose + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + + + + + + Parses data. + + + + + + + + + + Creates List for all data. + + First free index in the resulting List. + Created List. + + + + Fills array list with structures data. + + Stream to put resulting data into. + Start index in List. + + + + Size of the required storage space. Read-only. + + + + + + + + + + + Creates Continue Record Builder + + + + + + + + + + + + Returns array with all mso structures. Read-only. + + + + + Returns List with all mso structures. Read-only. + + + + + Indicates whether record needs internal data array + or if it can be cleaned. Read-only. + + + + + Offset to the structures data. + + + + + Record header in workbook part. + + + + + Record header in worksheet part. + + + + + Record header in workbook when it is not first record + (when it is used instead of Continue record). + + + + + Data offset. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Creates List for all data. + + First free index in the resulting List. + Created List. + + + + Adds record data from single record to the List. + + List to add data to. + Record to add data from. + Size of the added data. + + + + Creates continue record builder. + + Created builder. + + + + Sets length of the internal data. + + Length to set. + + + + Offset to the structures data. + + + + + Special class for building Continue Records. + + + + + + Special class for building Continue Records. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Type of additional records. + + + + + + + + + + + + + + + + + + + + + + Write array of data into output stream. + + Array of data. + Start index of an array. + Length of data to copy. + Quantity of created Continue Records. + + + + + + + + + + Method that checks if Continue Record is needed. + + Length of data that needs to be stored. + True if Continue Record will be needed for data storage; + otherwise False. + + + + + + + + + + + + + + + + + + + + Returns the unused bytes. + + + + + + + + + + + + + + + Return maximum size of record. + + + + + Type of the first additional record. + + + + + Type of additional records. + + + + + Maximum size of the continue record data. + + + + + + + + + + + + + + + + Write array of data into output stream. + + Array of data. + Start index of an array. + Length of data to copy. + Quantity of created Continue Records. + + + + Maximum size of the continue record data. + + + + + Represents the Header Footer Record + + + + + Excel 2003 record length + + + + + Excel 2010 record length + + + + + Type of data in categories. + + + + + Type of data in categories. + + + + + Type of data in categories. + + + + + Type of data in categories. + + + + + Stores the data in Even Header. + + + + + Stores the data in Even Footer. + + + + + Stores the data in First Header. + + + + + Stores the data in First Footer. + + + + + Record databytes. + + + + + HeaderFooter Record Code + + + + + Default constructor, initializes all fields with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Gets or sets if Align HeaderFoote With PageMargins + + + + + Gets or sets the value of Different Odd and Even Page Header Footer + + + + + Gets or sets if the HeaderFooter is sclaed with document + + + + + Gets or sets the value of Different First Page Header Footer + + + + + Represents the data in Even Header. + + + + + Represents the data in Even Footer. + + + + + Represents the data in First Header. + + + + + Represents the data in First Footer. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Specifies a header for a sheet. + + + + + Header string. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Header string. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Flag defines whether to hide placeholders and object. + + + + + Correct size of the record. + + + + + Flag that defines whether to hide placeholders and object. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Flag that defines whether to hide placeholders and object. + + + + + Read-only. Returns minimum possible size of record's internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + The record represents an empty cell. + It contains the cell address and formatting information. + + + + + GUID size. + + + + + Start byte of the standard link GUID. + + + + + Start byte of the URL moniker GUID. + + + + + Start byte of the file moniker GUID. + + + + + String represent the backslash. + + + + + Standard link GUID. + + + + + URL moniker GUID. + + + + + File moniker GUID. + + + + + Standard link GUID bytes. + + + + + URL moniker GUID bytes. + + + + + File moniker GUID bytes. + + + + + Unknown block in the file link. + + + + + Another unknown block in the file link. + + + + + Index to first row. + + + + + Index to last row. + + + + + Index to first column. + + + + + Index to last column. + + + + + Unknown value: 00000002H. + + + + + Option flags. + + + + + True if file link or URL. + False if no link. + + + + + True if absolute path or URL. + False if relative file path. + + + + + If this field and other description bits are + True, then there is a description. + False if there is no description. + + + + + True if there is a text mark. + False if there is no text mark. + + + + + If this field and other description bits are + True, then there is description. + False if there is no description. + + + + + True if there is a target frame. + False if there is no target frame. + + + + + True if UNC path (incl. server name). + False if file link or URL. + + + + + (optional, see option flags) Character count of description text, + including trailing zero word. + + + + + (optional, see option flags) Character array of description text, + no Unicode string header, always 16-bit characters, zero-terminated. + + + + + (optional, see option flags) Character count of target frame, + including trailing zero word. + + + + + (optional, see option flags) Character array of target frame, + no Unicode string header, always 16-bit characters, zero-terminated. + + + + + (optional, see option flags) Character count of the text mark, + including trailing zero word. + + + + + (optional, see option flags) Character array of the text + mark without "#" sign, no Unicode string header, always + 16-bit characters, zero-terminated. + + + + + HyperLink type. + + + + + URL length. + + + + + URL string. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Default constructor fills all data with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + Parses description. + + Offset to the description data. + + + + Parses target frame. + + Offset to the target frame data. + + + + Parses special data block. + + Offset to the data. + + + + Parses text mark. + + Offset to the data. + + + + Checks whether it is ULR link. + + Offset to the GUID to check. + True if it is URL link. + + + + Checks whether it is link to a local file. + + Offset to the GUID to check. + True if it is link to the local file. + + + + Checks whether it is link to a UNC. + + Offset to the GUID to check. + True if it is link to the UNC. + + + + Parses URL. + + Offset to the URL data. + + + + Parses link to a file. + + Offset to the data. + + + + Parses UNC link. + + Offset to the data. + + + + Parses link to the workbook. + + Offset to the data. + + + + Infill's length and string value. + + String length. + String value. + Indicates whether length is one byte. + + + + Infills special data. + + + + + Infills file special data. + + + + + Infills UNC special data. + + + + + Infills URL special data. + + + + + Infills workbook special data. + + + + + Sets options according to the link type. + + + + + Index to first row. + + + + + Index to first column. + + + + + Index to last row. + + + + + Index to last column. + + + + + Unknown value: 00000002H. Read-only. + + + + + Option flags. Read-only. + + + + + True if file link or URL. + False if no link. + + + + + True if absolute path or URL. + False if relative file path. + + + + + True if there is description. + False if there is no description. + + + + + True if there is a text mark. + False if there is no text mark. + + + + + True if there is a target frame. + False if there is no target frame. + + + + + True if UNC path (incl. server name). + False if file link or URL. + + + + + + + + + + + + + + + + + + + + + + + + + (optional, see option flags) Character count of description text, + including trailing zero word. Read-only. + + + + + (optional, see option flags) Character array of description text, + no Unicode string header, always 16-bit characters, zero-terminated. + + + + + (optional, see option flags) Character count of target frame, + including trailing zero word. Read-only. + + + + + (optional, see option flags) Character array of target frame, + no Unicode string header, always 16-bit characters, zero-terminated. + + + + + (optional, see option flags) Character count of the text mark, + including trailing zero word. + + + + + (optional, see option flags) Character array of the text + mark without the "#" sign, no Unicode string header, always + 16-bit characters, zero-terminated. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Read-only. + + + + + + + + + + Contains a list of explicit column page breaks. + + + + + Size of the fixed part. + + + + + Size of the subitem. + + + + + Size of the fixed part. + + + + + Number of page breaks. + + + + + Array of HorizontalPageBreaks. + + + + + Default constructor, sets all fields' default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + When data array does not fit to the page breaks array. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + Size of the required storage space. Read-only. + + + + + Array of HorizontalPageBreaks. + + + + + Read-only. Minimum possible size of the record. + + + + + This class contains information about single page break. + + + + + The row of the break. + + + + + The starting column of the break. + + + + + The ending column of the break. + + + + + Default constructor + + + + + Constructs class instance and fills fields with values. + + Row of the break. + Starting column of the break. + Ending column of the break. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + The row of the break. + + + + + The starting column of the break. + + + + + The ending column of the break. + + + + + This record contains the complete description of a bitmapped graphic object, + such as a drawing created by a graphic tool. + + + + + Summary description for BiffRecordWithContinue. + + + + + Summary description for BiffRecordRawWithDataProvider. + + + + + Object that gives access to the record's data. + + + + + Default constructor. + + + + + + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, the class must pack all of its properties into + an internal Data array: m_data. This method is called by + FillStream, when the record must be serialized into stream. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + + Gets string from internal record data using GetBytes. + + Offset of starting byte. + Length of the string. + Retrieved string. + + if Offset + iStrLen is out of data array + + + + + Gets string from internal record data using GetBytes. + + Offset of starting byte. + Length of the string. + Gets bytes count that this string occupies in the data array. + Retrieved string. + + + + Gets string from internal record data using GetBytes. + + Offset of starting byte. + Length of the string. + Gets bytes count that this string occupies in the data array. + Flag for is bytes count available. + Retrieved string. + + + + Detect type of string and extracts it. + + Record data offset. + Contain next position. + Number of elements in the continuePos collection. + Current index in the continuePos array. + Length of string record. + Array of rich formatting values. + Array of unknown FarEast data. + Extracted string. + + + + Sets byte in internal record data array values. + + Offset in internal record data array to start from. + Byte value to set. + + + + Sets ushort in internal record data array values. + + Offset in internal record data array to start from. + Value to set. + + + + Sets bytes in internal record data array values. + + Offset in internal record data array to start from. + Array of bytes to set. + Position in value array to the data that will be set. + Length of the data. + If value array is NULL. + + If pos or length would be less than zero or their sum would be more + than size of value array. + + + If internal record data array is too small for receiving value array + and AutoGrowData is False. + + + + + Sets bytes in internal record data array values. + + Offset in internal record data array to start from. + Array of bytes to set. + If value array is NULL. + + If pos or length would be less than zero or their sum would be more + than size of value array. + + + If internal record data array is too small for receiving value array + and AutoGrowData is False. + + + + + Sets string in internal record data array using SetBytes method + without string length. + + Offset to the string. + Value of the string. + Size of the string in bytes. + + + + Sets string in internal record data array using SetBytes method + without string length. + + Offset to the string. + Value of the string. + Indicates whether write compressed attribute for empty strings. + Size of the string in bytes. + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Mask to get two bytes value. + + + + + Array that contains positions of data of the continue records + in the m_data array. + + + + + Size of the first record length. + + + + + Default constructor. + + + + + Read from stream record data. + + Stream with record data. + Object that provides access to the data. + Object that should be used to parse encrypted records. + Temporary buffer needed for some operations. + Size of the record data. + If reader is NULL. + + If stream is not be big enough for data (end of stream + reached) and all data were not read. + + + If record code is zero. + + + + + Save record data to stream. + + Writer that will receive record data. + Represents data provider. + Object to encrypt data. + Position in the output stream. Used to increase performance. + Size of the record in the stream. + If writer is NULL. + + If m_iLength of internal record data array is less than zero. + + + + + Creates copy of the current object. + + A copy of the current object. + + + + Type of the first continue record. Read-only. + + + + + Indicates whether we should add header of continue records to the internal data provider. Read-only. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + + + + In this method, the class must pack all of its properties into + an internal Data array: m_data. This method is called by + FillStream, when the record must be serialized into stream. + + + + + + Occurs right after BOF, gives information where the DBCELL records are for a sheet. + Important for locating cells. + + + + + Size of the fixed part. + + + + + Subitem size. + + + + + Not used. + + + + + Index to first used row. + + + + + Index to first row of unused tail of sheet. + + + + + Not used. + + + + + Array of absolute stream positions to the DBCELL record. + + + + + Array with DBCell records that must be referenced by this record. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + + + + Object that provides access to the data. + Object to encrypt data. + Position in the output stream. Used to increase performance. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + This method checks record's internal data array for integrity. + + + If there is any internal error. + + + + + Method update fields of record which must contain stream offset + or other data. This method must be called before save operation + when all records placed in array on own positions and offsets can + be freely calculated. + + + + + Size of the required storage space. Read-only. + + + + + Index to first used row. + + + + + Index to first row of unused tail of sheet. + + + + + Array of nm absolute stream positions to the DBCELL record. + + + + + Read-only. Not used. + + + + + Read-only. Not used. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Gets / sets array with DBCell records that must be referenced by this record. + + + + + Shows where the Interface Records end (MMS) (has no fields). + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's internal data array. + + + + + Defines the beginning of Interface records (MMS). + + + + + Correct size of the record. + + + + + The codepage for the file. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + The codepage for the file. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Summary description for IntPtrContinueRecordBuilder. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Type of additional records. + + + + + + + + + + Size of the first record. + + + + + Size of the header for continue records. + + + + + Initializes new instance of the continue record builder. + + Parent record. + Size of the continue record header. + + + + + + + + + + Write array of data into output stream. + + Array of data. + Start index of an array. + Length of data to copy. + Quantity of created Continue Records. + + + + + + + + + + Method that checks if Continue Record is needed. + + Length of data that needs to be stored. + True if Continue Record will be needed for data storage; + otherwise False. + + + + + + + + + + + + + + + + + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Returns the unused bytes. + + + + + + + + + + + + + + + Offset from the current record (or continue record) start. Read-only. + + + + + Return maximum size of record. + + + + + Type of the first additional record. + + + + + Type of additional records. + + + + + Maximum size of the continue record data. + + + + + Size of the first record. + + + + + + + + + + Summary description for IntPtrDataProvider. + + + + + + + + + + Pointer to the data array. + + + + + m_ptrData converted into Int64 value. + + + + + Indicates whether this instance is responsible for memory allocation and freeing. + + + + + Size of the allocated data. + + + + + Default constructor to prevent creation of items without arguments. + + + + + + + + + + Returns byte value at the specified position. + + Offset to the required value. + Byte at the specified position. + + + + Returns Int16 value at the specified position. + + Offset to the required value. + Int16 value at the specified position. + + + + Returns Int32 value at the specified position. + + Offset to the required value. + Int32 value at the specified position. + + + + Returns Int32 value at the specified position. + + Offset to the required value. + Int32 value at the specified position. + + + + Copies data from internal storage into specified + + Source offset. + Destination array. + Destination offset. + Size in bytes of the data to copy. + + + + Reads data from BinaryReader. + + Reader to get data from. + Offset in the internal data to start filling from. + Number of bytes to read. + Temporary buffer to use. + + + + Reads string from data provider. + + Offset to the first character. + Number of bytes in the string. + Encoding to use. + Indicates is unicode encoding. + Extracted string. + + + + Writes byte value at the specified position. + + Offset to the required value. + Byte value to write at the specified position. + + + + Writes Int16 value at the specified position. + + Offset to the required value. + Int16 value to write at the specified position. + + + + Writes Int16 value at the specified position. + + Offset to the required value. + Int16 value to write at the specified position. + + + + Writes Int32 value at the specified position. + + Offset to the required value. + Int32 value to write at the specified position. + + + + Writes Int64 value at the specified position. + + Offset to the required value. + Int64 value to write at the specified position. + + + + Sets one bit in specified byte in internal record data array. + + Offset of the byte in the data array. + Bit position in the byte. + Value of bit. + + If bitPos is less than zero or more than 7. + + + + + Writes Int32 value at the specified position. + + Offset to the required value. + Double value to write at the specified position. + + + + Sets string in internal data without string length, + updates offset parameter (adds string length). + + Offset to the string. + Value of the string. + Indicates whether string must be stored using Unicode encoding or not. + + + + Sets bytes in internal record data array values. + + Offset in internal record data array to start from. + Array of bytes to set. + Position in value array to the data that will be set. + Length of the data. + If value array is NULL. + + If pos or length would be less than zero or their sum would be more + than size of value array. + + + If internal record data array is too small for receiving value array + and AutoGrowData is False. + + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Resizes internal storage if necessary. + + Required size. + + + + Resizes the internal storage if needed + + + + + + + + Clears internal storage if allowed. + + + + + Copies data from internal storage into specified provider. + + Source offset. + Destination provider. + Destination offset. + Size in bytes of the data to copy. + + + + Writes zeros inside memory block. + + + + + Moves memory inside internal buffer. + + Destination offset. + Source offset. + Memory size. + + + + Copies memory inside internal buffer. + + Destination offset. + Source offset. + Memory size. + + + + Creates provider of the same type. + + Created provider object. + + + + Gets / sets internal data storage. + + + + + Returns size of the internal buffer. Read-only. + + + + + Returns heap handle. + + + + + + + + + + Tells whether to iterate over formula calculations or not + (if a formula is dependent upon another formula's result) + (odd feature for something that can only have 32 elements in a formula). + + + + + Correct record size. + + + + + 0 = Iterations off; 1 = Iterations on + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + 0 = Iterations off; 1 = Iterations on + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record contains the addresses of all row and column label ranges + in the current sheet. + + + + + Number of ranges in row ranges array. + + + + + Cell range address list with all row label ranges. + + + + + Number of ranges in column ranges array. + + + + + Cell range address list with all column label ranges. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + If last byte of the parsed data won't be the last byte of read data. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + Read-only. Number of ranges in row ranges array. + + + + + Cell range address list with all row label ranges. + + + + + Read-only. Number of ranges in column ranges array. + + + + + Cell range address list with all column label ranges. + + + + + Read-only. Minimum possible size of the record. + + + + + This record represents a cell that contains a string. + In BIFF8, it is replaced by the LABELSST record. + Nevertheless, Excel can import a LABEL record contained in a BIFF8 file. + + + + + This interface supports StringValue property. + + + + + Returns string value. Read-only. + + + + + Size of fixed part. 6 bytes - row, column and xf index, 2 bytes string len, 1 byte string type. + + + + + Label - Unicode string + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + Size of the required storage space. Read-only. + + + + + Label - Unicode string + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Returns string value. Read-only. + + + + + Value of the record. + + + + + Represents a cell that contains a string. + Refers to a string in the shared string table and is a column value. + + + + + Correct size of the record. + + + + + Index offset. + + + + + Index into SST record. + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + Returns size of the required storage space. + + Excel version. + Size of the required storage space. + + + + Sets new index. + + Object that provides access to the data. + Offset to the start of the record data. + New SST index. + Excel version of the used data storage. + + + + Sets new index. + + Object that provides access to the data. + Offset to the start of the record data. + Excel version of the used data storage. + Index in the SST table. + + + + Index into SST record. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + + + + + + This record is part of the Page Settings block. + It contains the margin of the current worksheet. + + + + + Default value of top margin. + + + + + Correct record size. + + + + + It contains the top page margin of the current worksheet + (IEEE floating-point value). + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + Maximum change in iteration (IEEE floating-point value). + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's internal data array. + + + + + Contains all merged cell ranges of the current sheet. + Optional record defining a square area of cells to "merge" into one cell. + + + + + Maximum possible number of regions in the single MergeCells record. + + + + + Size of the fixed part. + + + + + Subitem size. + + + + + Number of ranges. + + + + + All merged cell ranges of the current sheet. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + This method checks a record's internal data array for integrity. + + + If there is any internal error. + + + + + Size of the required storage space. Read-only. + + + + + Copies regions to the internal array. + + First region to copy. + Regions count. + Array with regions to copy. + + + + Returns number of ranges. + + + + + All merged cell ranges of the current sheet. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + This class contains information about the region of merged cells. + + + + + First row of the region. + + + + + Last row of the region. + + + + + First column of the region. + + + + + Last column of the region. + + + + + To prevent creation without parameters. + + + + + Creates copy of region. + + Region to copy. + + + + Creates region by specified first and last rows and first and last columns. + + First row of the region. + Last row of the region. + First column of the region. + Last row of the region. + + + + Moves region. + + Row delta. + Column delta. + + + + Converts region into Rectangle. + + Rectangle corresponding to this region. + + + + Creates a copy of the current object. + + A copy of the current object. + + + + Compares two merged regions. + + First region to compare. + Second region to compare. + + + + + 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. + + + + Serves as a hash function for a MergedRegion object. + + A hash code for the current object. + + + + Read-only. First row of the region. + + + + + Gets/sets last row of the region. + + + + + Read-only. First column of the region. + + + + + Gets/sets last column of the region. + + + + + Returns number of cells used by + + + + + Defines how many add menu and delete menu options are stored in the file. + + + + + Correct size of the record. + + + + + Count of add menu options that are stored in the file. + + + + + Count of delete menu options that are stored in the file. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Count of add menu options that are stored in the file. + + + + + Count of delete menu options that are stored in the file. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Main class constructor. Application and Parent properties are set. + + WorkbookImpl + CompoundStorage + + + + Main class constructor. Application and Parent properties are set. + + + + + Parse Customxml parts + + CustomXmlParts + Schemas collection + Stream Data + XmlID + + + + Parses CustomXml Item Properties + + Property Stream + SchemasCollection + + + + Parses Item properties + + Xml Reader + SchemasCollection + + + + Parses Schema Reference and add to collection + + Xml Reader + SchemasCollection + + + + Parses Individual schemas + + Xml Reader + Schemas Collection + + + + Serialize CustomXml Parts + + + + + Serialize Custom Xml properties + + Custom Xml Parts + Item Stream + + + + Serialize CustomXml Properties + + Custom Xml Parts + XmlWriter + + + + Serialize Xml Data in Storage + + Xml Data + Storage + + + + This record contains a drawing object provided by the Microsoft + Office Drawing tool. + + + + + Default constructor fills all data with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + + + + + + + + Sets length of the internal data. + + Length to set. + + + + Size of the required storage space. Read-only. + + + + + + + + + + + + + + + Summary description for ArrayWrapper. + + + + + Wrapped byte array. + + + + + Hash value. + + + + + Default constructor. To prevent user from creation without arguments. + + + + + Initializes new instance of the wrapper. + + Buffer to wrap. + + + + 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. + + + + + Serves as a hash function for a particular type, suitable for use in + hashing algorithms and data structures like a hash table. + + A hash code for the current Object. + + + + Evaluates hash value. + + + + + Summary description for Attributes. + + + + + + + + + + + + + + + Creates new instance. + + Type of new instance + + + + + + + + + Summary description for MsoBase. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Dictionary key - Type of the MsoBase class, Value - its code. + + + + + Static constructor. + + + + + Default constructor. + + + + + + + + + + + + + + + + + + + + + + + + + Fills record from the data array. + + Array that contains record data. + Offset to the record data. + Size of the extracted data. + + + + Fills internal data array. + + + + + Fills internal data array. + + Stream to write record data into. + Offset index. + List with breaks indexes in arrRecords. + List with records. + Returns array of bytes. + + + + Infills internal data array. + + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + Clone current instance. + + Parent object to create instance. + Returns cloned instance. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Updates NextMsoDrawingData. + + + + + Extracts record from the stream. + + Stream to get data from. + + + + + + + + + Converts from fixed point integer value into double. + + Value to convert. + Converted double value. + + + + Writes Int32 value int stream. + + Stream to write value into. + Value to write. + + + + Writes UInt32 value int stream. + + Stream to write value into. + Value to write. + + + + Writes Int16 value int stream. + + Stream to write value into. + Value to write. + + + + Writes UInt16 value int stream. + + Stream to write value into. + Value to write. + + + + Reads Int32 value from stream. + + Stream to read value from. + Value extracted from the stream. + + + + Reads UInt32 value from stream. + + Stream to read value from. + Value extracted from the stream. + + + + Reads Int16 value from stream. + + Stream to read value from. + Value extracted from the stream. + + + + Reads UInt16 value from stream. + + Stream to read value from. + Value extracted from the stream. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns maximum record size. Read-only. + + + + + Summary description for MsoPicture. + + + + + Common interface for all records that contains picture. + + + + + Picture that is contained by the record. + + + + + Picture Stream + + + + + Picture id. + + + + + Size of the bitmap header. + + + + + Number of used colors. + + + + + Size of each color definition in the palette. + + + + + To specify two UIDs. + + + + + To specify BlipPNG's two UIDs. + + + + + To specify BlipJPEG's two UIDs. + + + + + Dib identifier. ("BM"). + + + + + Reserved. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates new instance of object. + + Parent object. + Base data. + Index of offset. + + + + Creates new instance of object. + + Parent object. + Stream to get data from. + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + + + + + + + Clone current instance. + + Returns cloned instance. + + + + Creates image stream and fills it with necessary data. + + Stream to read image data from. + Offset to the image data. + + + + Indicates whether Art Blip contains Two Unique Id's. + + + + + + Returns number of used colors in the dib image. + + Number of used colors in the dib image. + + + + Evaluates hash value for the stored picture. + + + + + Adds bitmap header to stream. + + + + + + + + + + Gets or sets picture of that is contained in the record. + + + + + Gets or sets the picture stream + + + + + + + + + + + + + + + + + + + + Indicates whether this is dib bitmap. + + + + + Summary description for MsoContainerBase. + + + + + + + + + + Creates new instance of object. + + Parent object. + + + + Creates new instance of object. + + Parent object. + Base data. + Offset index. + + + + Creates new instance of object. + + Parent object. + Base data. + Offset index. + Data getter. + + + + + + + + + + + + + + + + + + + + + + + + + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + Clone current instance. + + Returns cloned instance. + + + + Array of items. Read-only. + + + + + Internal list of items (to increase performance). Read-only. + + + + + Summary description for MsoFactory. + + + + + Represents new hashtable + key - code; value - mso record. + + + + + + + + + + + + + + + Create Mso Record. + + Parent object. + Type of created record. + Base data. + Offset index. + Returns new instance of MsoBase record. + + + + Create Mso Record. + + Parent object. + Type of created record. + Base data. + Offset index. + Data getter. + Returns new instance of Mso Base. + + + + Creates Mso record. + + Parent object. + Base data. + Offset index. + Returns new instance of Mso record. + + + + Creates Mso record. + + Parent object. + Base data. + Offset index. + Data getter. + Returns new instance of Mso record. + + + + Creates Mso record. + + Parent object. + Stream to get data from. + Returns new instance of Mso record. + + + + Create Mso Record. + + Parent object. + Type of created record. + Stream with record's data. + Returns new instance of MsoBase record. + + + + Creates Mso record. + + Parent object. + Stream to get data from. + Data getter. + Returns new instance of Mso record. + + + + Create Mso Record. + + Parent object. + Type of created record. + Stream to get data from. + Data getter. + Returns new instance of Mso Base. + + + + + + + + + + + + + + + + + + Registers all known mso record types inside internal collections. + + + + + Summary description for MsofbtSpgr. + + + + + Correct record size. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates new instance of object. + + Parent object. + Base data. + Offset index. + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + Size of the required storage space. Read-only. + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for MsofbtBSE. + + + + + + + + + + + + + + + + + + + + Required type on Win32. + + + + + Required type on Mac. + + + + + Blip size in stream. + + + + + Reference count on the blip. + + + + + File offset in the delay stream. + + + + + How this blip is used. + + + + + Length of the blip name. + + + + + For the future. + + + + + For the future. + + + + + + + + + + + + + + + Index of the record in the collection. + + + + + Path to the picture item (used in Excel 2007). + + + + + Creates new instance. + + Parent object. + + + + Creates new instance. + + Parent object. + Base data. + Offset index. + + + + Dispose + + + + + Dispose + + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + Clone current instance. + + Returns cloned instance. + + + + + + + + + + + Required type on Win32. + + + + + Required type on Mac. + + + + + + + + + + Blip size in stream. + + + + + Reference count on the blip. + + + + + File offset in the delay stream. + + + + + How this blip is used. + + + + + Length of the blip name. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets / sets index of the bse in the collection. + + + + + Gets / sets path to the picture zip item. Used in Excel 2007 format. + + + + + Summary description for MsofbtBstoreContainer. + + + + + Default version of container. + + + + + Default instance of container. + + + + + + + + + + + + + + + + + + + + + + + + + + + Dispose + + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + Summary description for MsofbtSpgr. + + + + + Correct record size. + + + + + + + + + + + + + + + + + + + + + + + + + Creates new instance. + + Parent object. + + + + Creates new instance. + + Parent object. + Base data. + Offset index. + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for MsofbtClientAnchor. + + + + + Mask for column / row index. + + + + + Mask for offset index. + + + + + + + + + + Length for short data. + + + + + Correct record size. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Indicates whether it is short version of client anchor. Used in headers/footers. + + + + + Zero-based top row index. + + + + + Top row offset. + + + + + Zero-based bottom row index. + + + + + Bottom row offset. + + + + + Indicates whether this anchor is oneCellAnchor (used in Excel 2007 format). + + + + + + + + + + + + + + + + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + Size of the required storage space. Read-only. + + + + + Compares if the objects are equal + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Indicates whether it is short version of client anchor. Used in headers/footers. + + + + + Indicates whether parent shape should be stored as oneCellAnchor or not. + Default value false. + + + + + Summary description for MsofbtSpgr. + + + + + + + + + + Creates new object. + + Parent object. + + + + Creates new object. + + Parent object. + Base data. + Offset index. + + + + Creates new object. + + Parent object. + Base data. + Offset index. + Data getter. + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + Clone current instance. + + Returns cloned instance. + + + + Updates NextMsoDrawingData. + + + + + Adds single record to the AdditionalData array. + + Record to add. + + + + Adds range of records to the AdditionalData array. + + Collection to add. + + + + Adds range of records to the AdditionalData array. + + Collection to add. + + + + + + + + + + + + + + Summary description for MsofbtSpgr. + + + + + + + + + + + + + + + + + + Creates new object. + + Parent object. + + + + Creates new object. + + Parent object. + Base data. + Offset index. + + + + Creates new object. + + Parent object. + Base data. + Offset index. + Data getter. + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + Clone current instance. + + Returns cloned instance. + + + + Updates NextMsoDrawingData. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for MsofbtDg. + + + + + Default instance. + + + + + Correct record size. + + + + + The number of shapes in this drawing. + + + + + The last MSOSPID given to an SP in this Drawing Group. + + + + + Creates new object. + + Parent object. + + + + Creates new object. + + Parent object. + Base data. + Offset index. + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + Size of the required storage space. Read-only. + + + + + The number of shapes in this drawing. + + + + + The last MSOSPID given to an SP in this Drawing Group. + + + + + Summary description for MsofbtDgContainer. + + + + + Default container version. + + + + + Creates new object. + + Parent object. + + + + Creates new object. + + Parent object. + Base data. + Offset index. + + + + Creates new object. + + Parent object. + Base data. + Offset index. + Data getter. + + + + Represents MsofbtDgg in MsoDrawing. + + + + + Default offset to the array. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Creates new object. + + Parent object. + + + + Creates new object. + + Parent object. + Base data. + Offset index. + + + + Parse Structure of record. Convert Data buffer to special + values according to record specification. + + + + + In this method, the class must pack all of it's properties into + an internal Data array: m_data. This method is called by + FillStream, when the record must be serialized into stream. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + Clone current instance. + + Returns cloned instance. + + + + Adds cluster. + + Group id. + Number. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Cluster Id. + + + + + Size of the record. + + + + + DG owning the SPIDs in this cluster. + + + + + Number of SPIDs used so far. + + + + + + + + + + + + + + + + + + + + + + + + + Converts record to the bytes array. + + Array of bytes with record's data. + + + + + + + + + + Clone current instance. + + Return shallow copy of current instance. + + + + DG owning the SPIDs in this cluster. + + + + + Number of SPIDs used so far. + + + + + Record's size. + + + + + Summary description for MsofbtDggContainer. + + + + + Default container version. + + + + + Creates new object. + + Parent object. + + + + Creates new object. + + Parent object. + Base data. + Offset index. + + + + Creates new object. + + Parent object. + Base data. + Offset index. + Data getter. + + + + Dispose + + + + + Summary description for MsofbtOPT. + + + + + Minimum option index. + + + + + List with shape properties. + + + + + Creates new object. + + Parent object. + + + + Creates new object. + + Parent object. + Base data. + Offset index. + + + + + + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + Clone current instance. + + Returns cloned instance. + + + + Clone current instance. + + Returns cloned instance. + + + + + + + + + + + + + + + + + + Option to set + + + + Replaces option with specified value. + + Option to set. + + + + Searches for option in the record. + + Option to find. + Index of the option. + + + + Removes some option by index. + + Index of option to remove. + + + + Returns index of option index. + + + + + + + Array with shape properties. Read-only. + + + + + Returns singe option from the collection. Read-only. + + + + + Gets property list with all properties. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Property ID. + + + + + Value is a blip ID � only valid if fComplex is FALSE. + + + + + Complex property, value is length. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Clone current instance. + + Return Clone of current object. + + + + Property ID. + + + + + Value is a blip ID � only valid if fComplex is FALSE. + + + + + Complex property, value is length. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for MsofbtSpgr. + + + + + + + + + + Creates new object. + + Parent object. + + + + Creates new object. + + Parent object. + Base data. + Offset index. + + + + + + + + + + Summary description for MsofbtSp. + + + + + Default record version. + + + + + Record size. + + + + + + + + + + + + + + + This shape is a group shape. + + + + + Not a top-level shape. + + + + + This is the topmost group shape. Exactly one of these per drawing. + + + + + The shape has been deleted. + + + + + The shape is an OLE object. + + + + + Shape has a hspMaster property. + + + + + Shape is flipped horizontally. + + + + + Shape is flipped vertically. + + + + + Connector type of shape. + + + + + Shape has an anchor of some kind. + + + + + Background shape. + + + + + Shape has a shape type property. + + + + + Creates new object. + + Parent object. + + + + Creates new object. + + Parent object. + Base data. + Offset index. + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + Size of the required storage space. Read-only. + + + + + + + + + + + + + + + This shape is a group shape. + + + + + Not a top-level shape. + + + + + This is the topmost group shape. Exactly one of these per drawing. + + + + + The shape has been deleted. + + + + + The shape is an OLE object. + + + + + Shape has a hspMaster property. + + + + + Shape is flipped horizontally. + + + + + Shape is flipped vertically. + + + + + Connector type of shape. + + + + + Shape has an anchor of some kind. + + + + + Background shape. + + + + + Shape has a shape type property. + + + + + Summary description for MsofbtSpgrContainer. + + + + + Default version of container. + + + + + Creates new object. + + Parent object. + + + + Creates new object. + + Parent object. + Base data. + Offset index. + + + + Creates new object. + + Parent object. + Base data. + Offset index. + Data getter. + + + + Summary description for MsofbtSpgr. + + + + + Default record version. + + + + + Correct record size. + + + + + + + + + + + + + + + + + + + + + + + + + Creates new object. + + Parent object. + + + + Creates new object. + + Parent object. + Base data. + Offset index. + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Summary description for MsofbtSpgrContainer. + + + + + Default container version. + + + + + Creates new object. + + Parent object. + + + + Creates new object. + + Parent object. + Base data. + Offset index. + + + + Creates new object. + + Parent object. + Base data. + Offset index. + Data getter. + + + + Summary description for MsofbtSplitMenuColors. + + + + + Correct record size. + + + + + + + + + + + + + + + + + + + + + + + + + Creates new object. + + Parent object. + + + + Creates new object. + + Parent object. + Base data. + Offset index. + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents metafile picture in the workbook. + + + + + Default buffer size. + + + + + Offset to UID. + + + + + Offset to metafile size. + + + + + Offset to compressed size. + + + + + To specify BlipEMF's two UIDs. + + + + + To specify BlipWMF's two UIDs. + + + + + To specify BlipPICT's two UIDs. + + + + + To specify BlipTIFF's two UIDs. + + + + + Memory stream with picture data. + + + + + Array with compressed picture. + + + + + UID of the picture. + + + + + Primary UID. + + + + + Cache of the metafile size. + + + + + Boundary of metafile drawing commands. + + + + + Size of metafile in EMUs. + + + + + Cache of saved size (size of m_pvBits). + + + + + Compression type. + + + + + Applied filter. + + + + + Inner picture. + + + + + Creates new instance of the picture. + + Parent record. + + + + Creates new object. + + Parent object. + Base data. + Offset index. + + + + Creates new object. + + Parent object. + Stream to get data from. + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + Parses structure. + + + + + Indicates whether Art Blip contains Two Unique Id's. + + + + + + Loads primary UID. + + Stream to get primary UID from if necessary. + Offset after reading primary uid. + + + + Saves metafile into MemoryStream. + + Picture to serialize. + Memory stream with metafile data. + + + + Converts GraphicsUnit into MetafileFrameUnit. + + Value to convert. + Converted value. + + + + Compresses metafile picture. + + Stream with metafile. + Offset to the metafile. + Compressed picture. + + + + Clone current instance. + + Returns cloned instance. + + + + Frees all unmanaged resources. + + + + + Destructor. + + + + + Picture. + + + + + Gets or sets the picture stream + + + + + + + + + + Summary description for MsoUnknown. + + + + + Creates new object. + + Parent object. + + + + Creates new object. + + Parent object. + Base data. + Offset index. + + + + + + + + + Infills internal data array. + + Stream to serialize into. + Offset. + List with breaks indexes in arrRecords. + List with records. + + + + Indicates whether record needs internal data array or if it can be cleaned. + + + + + Summary description for _MsoEnums. + + + + + Represents the msofbtDggContainer MsoRecord type. + + + + + Represents the Dgg type. + + + + + Represents the CLSID type. + + + + + Represents the OPT type. + + + + + Represents the ColorMRU type. + + + + + Represents the SplitMenuColors type. + + + + + Represents the BstoreContainer type. + + + + + Represents the BSE type. + + + + + Represents the DgContainer type. + + + + + Represents the Dg type. + + + + + Represents the RegroupItems type. + + + + + Represents the ColorScheme type. + + + + + Represents the SpgrContainer type. + + + + + Represents the SpContainer type. + + + + + Represents the Spgr type. + + + + + Represents the Sp type. + + + + + Represents the Textbox type. + + + + + Represents the ClientTextbox type. + + + + + Represents the Anchor type. + + + + + Represents the ChildAnchor type. + + + + + Represents the ClientAnchor type. + + + + + Represents the ClientData type. + + + + + Represents the OleObject type. + + + + + Represents the DeletedPspl type. + + + + + Represents the SolverContainer type. + + + + + Represents the ConnectorRule type. + + + + + Represents the AlignRule type. + + + + + Represents the ArcRule type. + + + + + Represents the ClientRule type. + + + + + Represents the CalloutRule type. + + + + + Represents the Selection type. + + + + + Represents the Unknown type. + + + + + Represents the MsoBlipUsage options. + + + + + Represents the Default option. + + + + + Represents the Texture option. + + + + + Represents the UsageMax option. + + + + + Represents the MsoBlipType options. + + + + + Represents the ERROR option. + + + + + Represents the UNKNOWN option. + + + + + Represents the EMF option. + + + + + Represents the WMF option. + + + + + Represents the PICT option. + + + + + Represents the JPEG option. + + + + + Represents the PNG option. + + + + + Represents the DIB option. + + + + + Represents the FirstClient option. + + + + + Represents the LastClient option. + + + + + Represents the MsoBlipCompression options. + + + + + Represents the Deflate option. + + + + + Represents the None option. + + + + + Represents the Test option. + + + + + Represents the MsoBlipFilter options. + + + + + Represents the Adaptive option. + + + + + Represents the None option. + + + + + Represents the Test option. + + + + + Represents the Mso options. + + + + + Do not group this shape. + + + + + Represents the TextId options. + + + + + Represents the wrap text options . + + + + + Represents the TextDirection options. + + + + + Represents the SizeTextToFitShape options. + + + + + Represents the BlipId options. + + + + + Represents the BlipName options. + + + + + Represents fill type. + + + + + Represents the location of the top of the crop rectangle + + + + + Represents the location of the bottom of the crop rectangle. + + + + + Represents the location of the left side of the crop rectangle. + + + + + Represents the location of the right side of the crop rectangle. + + + + + Host-defined ID for OLE objects (usually a pointer). + + + + + Represents the ForeColor options. + + + + + Represents the transparency. + + + + + Represents the BackColor options. + + + + + Represents the gradient transparency options. + + + + + Represents shape pattern. + + + + + Represents shape pattern, texture name. + + + + + Represents shape gradient shading style. + + + + + Represents shape gradient shading variants. + + + + + Represents first record for shape gradient shading style. + + + + + Represents second record for shape gradient shading style. + + + + + Represents third record for shape gradient shading style. + + + + + Represents fourth record for shape gradient shading style. + + + + + Represents preset gradient data. + + + + + Represents gradient color type. + + + + + Hit test a shape as though filled. + + + + + Line color. + + + + + Line color. + + + + + Line Weight. + + + + + Line color. + + + + + Contain line pattern. + + + + + Line pattern. + + + + + Line style + + + + + Line dash style + + + + + Line start arrow. + + + + + Line end arrow. + + + + + Start arrow width. + + + + + Start arrow len. + + + + + End arrow width. + + + + + End arrow len. + + + + + Represents if dot value is round. + + + + + Represents the NoLineDrawDash options. + + + + + Represents the ForeShadowColor options. + + + + + Excel5-style shadow. + + + + + Name of the shape (only if explicitly set). + + + + + Alternative text. + + + + + Represents in comment shape show always property. + + + + + Represents a range of empty cells. All cells are located in the same row. + + + + + + + + + + Returns size of the subrecord if it was placed as separate record (including BiffRecord header). Read-only. + + + + + Inserts cell inside this record. + + Cell to insert. + + + + Removes information about specified column from the record and splits record into two. + \ + Zero-based index of the column to remove. + Split records. + + + + Splits record into subrecords. + + Indicates whether styles must be ignored. + Array with all subrecords. + + + + Zero-based index of the first column. + + + + + Zero-based index of the last column. + + + + + Returns size of the sub record. Read-only. + + + + + Returns type of the subrecord. Read-only. + + + + + Size of the fixed part. + + + + + Minimum record size. + + + + + Size of the subitem. + + + + + List of 16-bit indexes to XF records. + + + + + Index to last column. + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + This method checks the record's internal data array for integrity. + + If there is any internal error. + + + + Creates BlankRecord corresponding to the specified column. + + Column index. + Corresponding BlankRecord. + + + + Returns size of the required storage space. + + Excel version. + Size of the required storage space. + + + + Increases last column of the record. + + Object that provides access to the data. + Offset to the record start (record code). + Record data length. + Value that must be added to the column width. + Excel version used to fill data. + + + + Returns size of the subrecord if it was placed as separate record (including BiffRecord header). Read-only. + + + + + Inserts cell inside this record. + + Cell to insert. + + + + Removes information about specified column from the record and splits record into two. + + Zero-based index of the column to remove. + Splitted records. + + + + Creates record based in the information from this record. + + The first column index in the resulting record. + The last column index in the resulting record. + Created record. + + + + Creates blank record with specified column index. + + Zero-based column index of the created record. + Created record. + + + + Splits record into subrecords. + + Indicates whether styles must be ignored. + Array with all subrecords. + + + + Index to first column. + + + + + List of 16-bit indexes to XF records. + + + + + Index to last column. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Returns size of the subrecord. Read-only. + + + + + Returns type of the subrecord. Read-only. + + + + + Represents a cell range containing RK value cells. + All cells are located in the same row. + + + + + Size of the fixed part. + + + + + Size of the subitem. + + + + + List of RkRec structures. + + + + + Index to last column. + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + Returns size of the required storage space. + + Excel version. + Size of the required storage space. + + + + Returns size of the subrecord if it was placed as separate record (including BiffRecord header). Read-only. + + + + + Inserts cell inside this record. + + Cell to insert. + + + + Merges this and specified records. + + Record to merge with. + + + + + + + + + + Creates subrecord corresponding to the specified record. + + + + + + + Removes information about specified column from the record and splits record into two. + + Zero-based index of the column to remove. + Splitted records. + + + + Creates record based in the information from this record. + + The first column index in the resulting record. + The last column index in the resulting record. + Created record. + + + + Creates blank record with specified column index. + + Zero-based column index of the created record. + Created record. + + + + Splits record into subrecords. + + Indicates whether styles must be ignored. + Array with all subrecords. + + + + Index to the first column. + + + + + Index to last column. + + + + + List of RkRec structures. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Returns size of the subrecord. Read-only. + + + + + Returns type of the subrecord. Read-only. + + + + + Contains information about single RK entry in MulRKRecord. + + + + + Index of ExtendedFormat of the RK entry. + + + + + RK number of the RK entry. + + + + + Default constructor. To prevent user creating class + instance without parameters. + + + + + Constructs RkRec and sets its ExtendedFormat and Rk number values. + + Value of ExtendedFormat index. + Value of RkNumber. + + + + Index of ExtendedFormatRecord for this Rk number. + + + + + Read-only. 32-bit value contained by the record. + + + + + Read-only. Returns double value stored as Rk. + + + + + The begin record defines the start of a block of records for a (Graphing) + data object. This record is matched with a corresponding EndRecord. + + + + + Bit mask of the Function group. + + + + + Size of the fixed part. + + + + + Predefined names: + + + + + Option flags. + + + + + True if name is hidden. + + + + + True if name is a function. + + + + + True if name is a command. + + + + + True if function macro or command macro. + + + + + True if complex function (array formula or user defined). + + + + + True if built-in name. + + + + + True if name contains binary data. + + + + + Keyboard shortcut. + + + + + Length of the name. + + + + + Size of the formula data. + + + + + Reserved. + + + + + 0 if global name; otherwise index to sheet (one-based). + + + + + Length of menu text. + + + + + Length of description text. + + + + + Length of help topic text. + + + + + Length of status bar text. + + + + + Name (Unicode string without length field). + + + + + Formula data (RPN token array without size field). + + + + + Optional. Menu text (Unicode string without length field). + + + + + Optional. Description text (Unicode string without length field). + + + + + Optional. Help topic text (Unicode string without length field). + + + + + Optional. Status bar text (Unicode string without length field). + + + + + Parsed formula expression. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Infill fixed part of the record. + + Object that provides access to the data. + Starting offset. + + + + Infill fixed part of the record. + + Object that provides access to the data. + Offset to the fixed part data. + + + + Size of the required storage space. Read-only. + + + + + Determines number of bytes needed to store string without length field. + + Value to measure. + Number of bytes needed to store string without length field. + + + + Method checks name of NameRecord and determines whether it is a default or not. + + Name to check. + True if name is Predefined name; otherwise False. + + + + Looks for name in the predefined names table. + + Value to look for. + Index in the predefined names array. + + + + + + + + + + Clear Data + + + + + True if name is hidden. + + + + + True if name is a function. + + + + + True if name is a command. + + + + + True if function macro or command macro. + + + + + True if complex function (array formula or user defined). + + + + + True if built-in name. + + + + + True if name contains binary data. + + + + + Index to function group. + Changes bits of m_usOptions member. + + + + + Keyboard shortcut. + + + + + Read-only. Length of the name. + + + + + Read-only. Size of the formula data. + + + + + 0 if global name; otherwise index to sheet (one-based). + + + + + Read-only. Length of menu text. + + + + + Read-only. Length of description text. + + + + + Read-only. Length of help topic text. + + + + + Read-only. Length of status bar text. + + + + + Name (Unicode string without length field). + + + + + Formula data (RPN token array without size field). + + + + + Optional. Menu text (Unicode string without length field). + + + + + Optional. Description text (Unicode string without length field). + + + + + Optional. Help topic text (Unicode string without length field). + + + + + Optional. Status bar text (Unicode string without length field). + + + + + Read-only. Reserved (not used). + + + + + Read-only. Minimum possible size of the record. + + + + + The NOTE record specifies a comment associated with a particular cell. + + + + + Size of the fixed part of the record. + + + + + Row of the comment. + + + + + Column of the comment. + + + + + Options flag. + + + + + Whether the comment is visible. + + + + + Object ID for OBJ record that contains the comment. + + + + + Length of the name of the original comment author. + + + + + Name of the original comment author. + + + + + Default constructor fills all data with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Size of the required storage space. Read-only. + + + + + Index to row. + + + + + Index to column. + + + + + Name of the original comment author. + + + + + Object ID for OBJ record that contains the comment. + + + + + Indicates whether the comment is visible. + Changes one bit in m_usOptions field. + + + + + Read-only. Reserved. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Represents a cell that contains a floating-point value. + + + + + Correct record size. + + + + + IEEE floating-point value. + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + Returns size of the required storage space. + + Excel version. + Size of the required storage space. + + + + Reads record's value from the data provider. + + Provider to read data from. + Offset to the record's start. + Excel version that was used to infill. + Record's value. + + + + IEEE floating-point value. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + + + + + + Returns double value. Read-only. + + + + + Value of the record. + + + + + This record is part of the worksheet / workbook protection. It determines whether + the objects of the current sheet are protected. Object protection is not active + if this record is omitted. + + + + + Default record size. + + + + + 0 = Objects not protected; 1 = Objects protected + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + 0 = Objects not protected; 1 = Objects protected + + + + + Read-only. Minimum possible size of the record. + + + + + Read-only. Maximum possible size of the record. + + + + + The OBJ record contains a partial description of a drawing object + and the MSODRAWING, MSODRAWINGGROUP, and MSODRAWINGSELECTION records contain + the remaining drawing object data. + + + + + Array that contain all subrecords. + + + + + Default constructor fills all data with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Get subrecord by its offset. + + Object that provides access to the data. + Offset to the subrecord. + Start offset of the OBJRecord. + Parsed subrecord from internal data array. + + + + Adds new subrecord. + + Record to add. + + + + Searches for the subrecord of the specified type. + + Record type to search for. + Found subrecord or null if not found. + + + + Searches for the index of the subrecord with the specified type. + + Record type to search for. + Index of the found subrecord or -1 if not found. + + + + Creates a new object that is a copy of the current instance. + + + A new object that is a copy of this instance. + + + + Read-only. Returns array of subrecords. + + + + + Read-only. Returns array of subrecords. + + + + + Indicates whether this record needs a data array after parsing + is complete. Read-only. + + + + + To store an OBJ record in BIFF8, Microsoft Excel writes a collection + of sub-records. The structure of a sub-record is identical to the + structure of a BIFF record. Each sub-record begins with a 2-byte + ID number ft (see the following table). Next a 2-byte length field, + cb, specifies the length of the sub-record data field. The sub-record + data field follows the length field. The first sub-record is always + ftCmo (common object data) and the last sub-record is always ftEnd. + + + + + Represents the ftEnd subrecord type. + + + + + Represents the Reserved0 subrecord type. + + + + + Represents the Reserved1 subrecord type. + + + + + Represents the Reserved2 subrecord type. + + + + + Represents the ftMacro subrecord type. + + + + + Represents the ftButton subrecord type. + + + + + Represents the ftGmo subrecord type. + + + + + Represents the ftCf subrecord type. + + + + + Represents the ftPioGrbit subrecord type. + + + + + Represents the ftPictFmla subrecord type. + + + + + Represents the ftCbls subrecord type. + + + + + Represents the ftRbo subrecord type. + + + + + Represents the ftSbs subrecord type. + + + + + Represents the ftNts subrecord type. + + + + + Represents the ftSbsFmla subrecord type. + + + + + Represents the ftGboData subrecord type. + + + + + Represents the ftEdoData subrecord type. + + + + + Represents the ftRboData subrecord type. + + + + + Represents the ftCblsData subrecord type. + + + + + Represents the ftLbsData subrecord type. + + + + + Represents the ftCblsFmla subrecord type. + + + + + Represents the ftCmo subrecord type. + + + + + Possible object types: + + + + + Represents the otGroup object type. + + + + + Represents the otLine object type. + + + + + Represents the otRectangle object type. + + + + + Represents the otOval object type. + + + + + Represents the otArc object type. + + + + + Represents the otChart object type. + + + + + Represents the otText object type. + + + + + Represents the otButton object type. + + + + + Represents the otPicture object type. + + + + + Represents the otPolygon object type. + + + + + Represents the otReserved0 object type. + + + + + Represents the otCheckBox object type. + + + + + Represents the otOptionBtn object type. + + + + + Represents the otEditBox object type. + + + + + Represents the otLabel object type. + + + + + Represents the otDialogBox object type. + + + + + Represents the otSpinner object type. + + + + + Represents the otScrollBar object type. + + + + + Represents the otGroupBox object type. + + + + + Represents the otGroupBox object type. + + + + + Represents the otComboBox object type. + + + + + Represents the otReserved1 object type. + + + + + Represents the otReserved2 object type. + + + + + Represents the otReserved3 object type. + + + + + Represents the otReserved4 object type. + + + + + Represents the otComment object type. + + + + + Represents the otReserved5 object type. + + + + + Represents the otReserved6 object type. + + + + + Represents the otReserved7 object type. + + + + + Represents the otReserved8 object type. + + + + + Represents the otMSODrawing object type. + + + + + Common object data. + + + + + Type of the object. + + + + + Default constructor. + + + + + Initialize new instance. + + Type of the subrecord. + Length of the subrecord's data. + Array that contains subrecord's data. + + + + Parses byte array. + + Array to parse. + + + + Fills array with binary representation of the subrecord. + + Object that provides access to the data. + Offset in the buffer to copy data to. + + + + Size of the required storage space. Read-only. + + + + + Indicates whether object is locked. + + + + + Common object data. + + + + + Type of the object. + + + + + Indicates whether combo box has 3D shadow. + + + + + Default constructor. + + + + + Initialize new instance. + + Type of the subrecord. + Length of the subrecord's data. + Array that contains subrecord's data. + + + + Parses byte array. + + Array to parse. + + + + Fills array with binary representation of the subrecord. + + Object that provides access to the data. + Offset in the buffer to copy data to. + + + + Size of the required storage space. Read-only. + + + + + Indicates whether object is Checked. + + + + + Indicates whether object is locked. + + + + + this class parse and serialize check box Linked cell + + + + + Formula tokens. + + + + + Default constructor. + + + + + Initialize new instance. + + Type of the subrecord. + Length of the subrecord's data. + Array that contains subrecord's data. + + + + Gets/sets parsed formula tokens. + + + + + Common object data. + + + + + Bit mask for ChangeColor property. + + + + + Type of the object. + + + + + Object's id. + + + + + Option flags. + + + + + Reserved. + + + + + Indicates that record length is zero. + + + + + Default constructor. + + + + + Initialize new instance. + + Type of the subrecord. + Length of the subrecord's data. + Array that contains subrecord's data. + + + + Parses byte array. + + Array to parse. + + + + Fills array with binary representation of the subrecord. + + Object that provides access to the data. + Offset in the buffer to copy data to. + + + + Clones current objects. + + Returns instance of cloned object. + + + + Size of the required storage space. Read-only. + + + + + Indicates whether object is locked. + + + + + Indicates whether object is printable. + + + + + Indicates whether auto fill is turned on. + + + + + Indicates whether auto line option is turned on. + + + + + Indicates whether excel is allowed to change color of combo box (used in autofilters). + + + + + Object's ID. + + + + + Object type. + + + + + Reserved. + + + + + Returns record options. Read-only. + + + + + End of OBJ record. + + + + + Correct record size. + + + + + Default constructor. + + + + + Creates new instance of the subrecord. + + Type of the subrecord. + Length of the subrecord's data. + Array that contains subrecord's data. + + + + Parses array of bytes. + + Array to parse. + + + + Size of the required storage space. Read-only. + + + + + Note structure. + + + + + Size of the record. + + + + + Bit position for value that defines arrow color. + + + + + Index to the byte that defines arrow color. + + + + + Bitmask for TypeValid property. + + + + + Bitmask for combo box Type property. + + + + + Starting bit for the combo box Type property. + + + + + Defoult record data. + + + + + Internal data array. + + + + + Number of lines in the list box. + + + + + Formula holding referenced area. + + + + + Selected item index. + + + + + Option flags. + + + + + Edit id. + + + + + Array indicating whether so item was selected or not. + + + + + Indicates whether this record is short representation of the list box data record + (without options, and any additional data). + + + + + Shape's type. + + + + + Default constructor. + + + + + Initializes new instance of subrecord. + + Type of the subrecord. + Length of the subrecord's data. + Buffer that contains subrecord's data. + + + + Initializes new instance of subrecord. + + Type of the subrecord. + Length of the subrecord's data. + Buffer that contains subrecord's data. + + + + Parses byte array. + + Array to parse. + Type of the object this record is part of. + + + + Parses selected items in the case of multiple selection enabled. + + Buffer to get data from. + Offset to the selection data start. + Offset after extracting necessary data. + + + + Clones current objects. + + Returns instance of cloned object. + + + + Size of the required storage space. Read-only. + + + + + Serialization + + + + + + + Serializes + + + + + + + + Returns internal data array. Read-only. + + + + + Indicates whether arrow has default or selected color. + + + + + Number of items in the list. + + + + + Formula token specifying referenced area. + + + + + One-based selected index. 0 - no item is selected. + + + + + Options. + + + + + An ObjId that specifies the edit box associated with this list. + + + + + List box drop data. + + + + + Gets or sets value indicating whether combo box type has valid value. + + + + + Gets or sets combo box type. + + + + + Gets or sets value indicates whether control has 3-D effect. + + + + + Gets or sets list selection type. + + + + + Gets value indicating whether we have multi selection or not. + + + + + Enum contains possible list selection type. + + + + + The list control is only allowed to have one selected item. + + + + + The list control is allowed to have multiple items selected by clicking on each item. + + + + + The list control is allowed to have multiple items selected by holding the CTRL key + and clicking on each item. + + + + + Represents ftMacro + + + + + Formula tokens that identifies associated macro. + + + + + Default constructor. + + + + + Default constructor. + + + + + Parse the bytes + + + + + + Serialization + + + + + + + Get storage size for ExcelVersion + + + + + + + Clones current objects. + + Returns instance of cloned object. + + + + Gets or sets formula tokens with associated macro. + + + + + Note structure. + + + + + Correct record size. + + + + + Internal data array. + + + + + Initializes new instance of subrecord. + + Type of the subrecord. + Length of the subrecord's data. + Buffer that contains subrecord's data. + + + + Parses byte array. + + Array to parse. + + + + Fills array with binary representation of the subrecord. + + Object that provides access to the data. + Offset in the buffer to copy data to. + + + + Clones current objects. + + Returns instance of cloned object. + + + + Size of the required storage space. Read-only. + + + + + Returns internal data array. Read-only. + + + + + Note structure. + + + + + Start of the string data. + + + + + Default header (data is unknown for us). + + + + + Default footer (data is unknown for us). + + + + + Internal data array. + + + + + Internal data array. + + + + + + + + + + Default constructor. + + + + + Initializes new instance of subrecord. + + Type of the subrecord. + Length of the subrecord's data. + Buffer that contains subrecord's data. + + + + Parses byte array. + + Array to parse. + + + + Fills array with binary representation of the subrecord. + + Object that provides access to the data. + Offset in the buffer to copy data to. + + + + Clones current objects. + + Returns instance of cloned object. + + + + Size of the required storage space. Read-only. + + + + + Formula value. + + + + + Common object data. + + + + + Default constructor. + + + + + Initialize new instance. + + Type of the subrecord. + Length of the subrecord's data. + Array that contains subrecord's data. + + + + Parses byte array. + + Array to parse. + + + + Fills array with binary representation of the subrecord. + + Object that provides access to the data. + Offset in the buffer to copy data to. + + + + Size of the required storage space. Read-only. + + + + + Common object data. + + + + + Type of the object. + + + + + Type of the object. + + + + + Reserved object 1 + + + + + Reserved object 2; + + + + + Default constructor. + + + + + Initialize new instance. + + Type of the subrecord. + Length of the subrecord's data. + Array that contains subrecord's data. + + + + Parses byte array. + + Array to parse. + + + + Fills array with binary representation of the subrecord. + + Object that provides access to the data. + Offset in the buffer to copy data to. + + + + Size of the required storage space. Read-only. + + + + + Indicates whether object is First Button in the group. + + + + + Indicates Next Button in the Group. + + + + + Note structure. + + + + + Size of the record. + + + + + Default record data. + + + + + Internal data array. + + + + + Default constructor. + + + + + Initializes new instance of subrecord. + + Type of the subrecord. + Length of the subrecord's data. + Buffer that contains subrecord's data. + + + + Parses byte array. + + Array to parse. + + + + Serialization + + + + + + + Clones current objects. + + Returns instance of cloned object. + + + + Size of the required storage space. Read-only. + + + + + Returns internal data array. Read-only. + + + + + Gest or sets the value + + + + + Gets or sets Minimum value + + + + + Gets or sets Maximum value + + + + + Gets or sets Increment value + + + + + Gets or sets Page value + + + + + Gets or sets Horizontal value + + + + + Gets or sets the value of scroll bar width + + + + + + + + Subrecord's internal data. + + + + + Initializes new subrecord. + + Type of the new subrecord. + Length of the subrecord. + Array that contains subrecord's data. + + + + Parses bye array. + + Array to parse. + + + + Fills array with binary representation of the subrecord. + + Object that provides access to the data. + Offset in the buffer to copy data to. + + + + Clones current objects. + + Returns instance of cloned object. + + + + Size of the required storage space. Read-only. + + + + + Returns internal data array. Read-only. + + + + + Represents LbsDropData + + + + + Option flags. + + + + + An unsigned integer that specifies the number of lines to be displayed + in the dropdown. If there are more lines than that in the list, + a scrollbar can appear. + + + + + An unsigned integer that specifies the smallest width in pixels allowed for the dropdown window. + + + + + Current string value in the dropdown. + + + + + Serializes object inside specified data provider. + + Data provider to serialize into. + Offset to start serialization from. + + + + Extracts object from specified data provider. + + Data provider to get data from. + Offset to start getting data from. + + + + Gets + + + + + + Creates a copy of the current object. + + A copy of the current object. + + + + Option flags. + + + + + An unsigned integer that specifies the number of lines to be displayed + in the dropdown. If there are more lines than that in the list, + a scrollbar can appear. + + + + + An unsigned integer that specifies the smallest width in pixels allowed for the dropdown window. + + + + + Current string value in the dropdown. + + + + + Offset to the row index. + + + + + Offset to the column index. + + + + + Formula tokens. + + + + + Default constructor. + + + + + Initialize new instance. + + Type of the subrecord. + Length of the subrecord's data. + Array that contains subrecord's data. + + + + Gets/sets parsed formula tokens. + + + + + This record stores RecalcId identifiers. + + + + + Represents the Record Type + + + + + Represents Calc Identifier. + + + + + Default constructor + + + + + Read/Initialize constructor + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Represents the user interface language of the Excel version + that saved this file. + + + + + Represents the system regional settings + at the time the file was saved. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record stores the size of an embedded OLE object + (when Microsoft Excel is a server). + + + + + Default record size. + + + + + Reserved. + + + + + First row of the object. + + + + + Last row of the object. + + + + + First column of the object. + + + + + Last column of the object. + + + + + Default constructor, sets all fields' default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Read-only. Get reserved field value. + + + + + First row of the object. + + + + + Last row of the object. + + + + + First column of the object. + + + + + Last column of the object. + + + + + Read-only. Return minimum possible size of the record. + + + + + Read-only. Returns maximum possible size of the record. + + + + + This record contains the definition of all user-defined colors available + for cell and object formatting. + + + + + Number of colors (nm). Contains 16 in BIFF3-BIFF4 + and 56 in BIFF5-BIFF8. + + + + + Array of colors. + + + + + Default constructor fills all data with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Read-only. Number of colors (nm). Contains 16 + in BIFF3-BIFF4 and 56 in BIFF5-BIFF8. + + + + + Array of colors. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Structure describing color entry. + + + + + Value of the red part of the color. + + + + + Value of the green part of the color. + + + + + Value of the blue part of the color. + + + + + Not used. + + + + + Converts object to string. + + String representation of the object. + + + + + + + + + Correct record size. + + + + + Position of the vertical split (px, 0 = No vertical split). + Unfrozen pane: Width of the left pane(s) (in twips = 1/20 of a point). + Frozen pane: Number of visible columns in left pane(s). + + + + + Position of the horizontal split (py, 0 = No horizontal split). + Unfrozen pane: Height of the top pane(s) (in twips = 1/20 of a point). + Frozen pane: Number of visible rows in top pane(s). + + + + + Index to first visible row in bottom pane(s). + + + + + Index to first visible column in right pane(s). + + + + + Identifier of pane with active cell cursor (see below). The last field + specifying the active pane has a size of 1 byte in BIFF2-BIFF4 and 2 + bytes in BIFF5-BIFF8. The correct identifiers for all possible + combinations of visible panes are shown in the following pictures: + px=0, py=0 -> 3 + px=0, py>0 -> 3 + 2 + px>0, py=0 -> 3 1 + px>0, py>0 -> 3 1 + 2 0 + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Position of the vertical split (px, 0 = No vertical split). + Unfrozen pane: Width of the left pane(s) (in twips = 1/20 of a point). + Frozen pane: Number of visible columns in left pane(s). + + + + + Position of the horizontal split (py, 0 = No horizontal split). + Unfrozen pane: Height of the top pane(s) (in twips = 1/20 of a point). + Frozen pane: Number of visible rows in top pane(s). + + + + + Index to first visible row in bottom pane(s). + + + + + Index to first visible column in right pane(s). + + + + + Identifier of pane with active cell cursor (see below). The last field + specifying the active pane has a size of 1 byte in BIFF2-BIFF4 and 2 + bytes in BIFF5-BIFF8. The correct identifiers for all possible + combinations of visible panes are shown in the following pictures: + px=0, py=0 -> 3 + px=0, py>0 -> 3 + 2 + px>0, py=0 -> 3 1 + px>0, py>0 -> 3 1 + 2 0 + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Stores the encrypted password for a sheet or workbook. + + + + + 16-bit hash value of the password. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + 16-bit hash value of the password. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Stores the (2 byte) encrypted password for a shared workbook. + + + + + Default record size. + + + + + Encrypted password for a shared workbook. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. + + + + + Encrypted password for a shared workbook. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record is an extension of the CacheDataRecord. + Both records contain PivotTable cache data. + Corresponds to SXDBEX in Excel format specification. + + + + + Default record size. + + + + + The date that the PivotTable cache was created or was last refreshed. + The date is stored as an 8-byte IEEE floating-point number. + + + + + Count of SXFormula records for this cache. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + The date that the PivotTable cache was created or was last refreshed. + The date is stored as an 8-byte IEEE floating-point number. + + + + + Count of SXFormula records for this cache. + + + + + This record is stored on a separate stream that maintains information about + each PivotTable cache. The record is followed by a single CacheDataExRecord + and several FDB records, one for each field in the PivotTable. + SXDBEX in Excel specification. + + + + + Offset to the user name field. + + + + + Number of records in database. + + + + + Identifies the stream. + + + + + Option flags. + + + + + Indicates whether data is being saved with table layout. + + + + + Indicates whether the PivotTable must be refreshed before next update. + + + + + Indicates whether the PivotTable will be refreshed on load. + + + + + Indicates whether the cache is optimized to use the least amount of memory. + + + + + Indicates whether results of the query are obtained in the background. + + + + + Indicates whether refresh is enabled. + + + + + Number of records for each database block. + + + + + Number of base fields in databases. + + + + + Number of base fields, grouped fields, and calculated fields. + + + + + This value is not used and can be set to zero. + + + + + Data source is one of: + 1 - Excel worksheet, + 2 - external data, + 4 - consolidation, + 8 - scenario PivotTable. + + + + + Number of characters in the string containing the name of the user who + last refreshed the PivotTable. + + + + + The user who last refreshed the PivotTable. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Fills cache with data from the range. + + Data range to fill. + + + + Number of records in database. + + + + + Identifies the stream. + + + + + Option flags. + + + + + Indicates whether data is being saved with table layout. + + + + + Indicates whether the PivotTable must be refreshed before next update. + + + + + Indicates whether the PivotTable will be refreshed on load. + + + + + Indicates whether the cache is optimized to use the least amount of memory. + + + + + Indicates whether results of the query are obtained in the background. + + + + + Indicates whether refresh is enabled. + + + + + Number of records for each database block. + + + + + Number of base fields in databases. + + + + + Number of base fields, grouped fields, and calculated fields. + + + + + This value is not used and can be set to zero. Read-only. + + + + + Data source is one of: + 1 - Excel worksheet, + 2 - external data, + 4 - consolidation, + 8 - scenario PivotTable. + + + + + Number of characters in the string containing the name of the user who + last refreshed the PivotTable. Read-only. + + + + + The user who last refreshed the PivotTable. + + + + + This record stores options from the Consolidate dialog box (Data menu). + + + + + Default record size. + + + + + Index to the data consolidation function. + + + + + If it is equal to 1 then the Left Column option is turned on. + + + + + If it is equal to 1 then the Top Row option is turned on. + + + + + If it is equal to 1 then the Create Links To Source Data option is turned on. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Index to the data consolidation function. + + + + + If it is equal to True then the Left Column option is turned on. + + + + + If it is equal to True then the Top Row option is turned on. + + + + + If it is equal to 1 then the Create Links To Source Data option is turned on. + + + + + Function types. + + + + + Represents the Average function type. + + + + + Represents the CountNums function type. + + + + + Represents the Count function type. + + + + + Represents the Max function type. + + + + + Represents the Min function type. + + + + + Represents the Product function type. + + + + + Represents the StdDev function type. + + + + + Represents the StdDevp function type. + + + + + Represents the Sum function type. + + + + + Represents the Var function type. + + + + + Represents the Varp function type. + + + + + Summary description for DataItem. + + + + + Value for name length indicating that name is Null. + + + + + Offset to the Name property. + + + + + Field that this data item is based on. + + + + + Index to the aggregation function: + 0 - Sum, + 1 - Count, + 2 - Average, + 3 - Max, + 4 - Min, + 5 - Product, + 6 - Count Nums, + 7 - StdDev, + 8 - StdDevp, + 9 - Var, + 10 - Varp, + + + + + Data display format: + 0 - Normal, + 1 - Difference from, + 2 - Percentage of, + 3 - Percentage difference from, + 4 - Running total in, + 5 - Percentage of row, + 6 - Percentage of column, + 7 - Percentage of total, + 8 - Index. + + + + + Index to the SXVD record used by the data display format. + + + + + Index to the SXVI record used by the data display format. + + + + + Index to the format table for this item. + + + + + Length of the name; if it is equal to 0xFFFF, then name is null + and the name in the PivotTable cache storage is used. + + + + + Name of the item. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + + + + In this method, the class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + + + + Field that this data item is based on. + + + + + Index to the aggregation function: + 0 - Sum, + 1 - Count, + 2 - Average, + 3 - Max, + 4 - Min, + 5 - Product, + 6 - Count Nums, + 7 - StdDev, + 8 - StdDevp, + 9 - Var, + 10 - Varp, + + + + + Data display format: + 0 - Normal, + 1 - Diffrence from, + 2 - Percentage of, + 3 - Percentage difference from, + 4 - Running total in, + 5 - Percentage of row, + 6 - Percentage of column, + 7 - Percentage of total, + 8 - Index. + + + + + Index to the SXVD record used by the data display format. + + + + + Index to the SXVI record used by the data display format. + + + + + Index to the format table for this item. + + + + + Length of the name; if it is equal to 0xFFFF, then name is null + and the name in the PivotTable cache storage is used. Read-only. + + + + + Name of the item. + + + + + This record stores information about the SQL query string that retrieves + external data for a PivotTable. The record is followed by SXSTRING records + that contain the SQL strings and then by a SXSTRING record that contains + the SQL server connection string. + + + + + Bit mask for DataSourceType property. + + + + + Default record size. + + + + + Options flags. + + + + + True for ODBC connection. + + + + + True for SQL statement or URL. + + + + + True for server-based page fields. + + + + + True for Web (WWW) query. + + + + + Indicates whether save password option is on. + + + + + Indicates whether save tables in HTML only option is on. + + + + + Number of parameter strings. + + + + + Number of strings for SQL statement or URL. + + + + + Number of strings for post method of Web query. + + + + + Number of strings for SQL statement for server-based page fields. + + + + + Number of strings for ODBC connection string. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Options flags. Read-only. + + + + + 1 - ODBC data source, + 2 - DAO recordset (no actual information about the recordset is saved), + 3 - reserved, + 4 - Web (WWW) query. + + + + + True for ODBC connection. + + + + + True for SQL statement or URL. + + + + + True for server-based page fields. + + + + + True for Web (WWW) query. + + + + + Indicates whether save password option is on. + + + + + Indicates whether save tables in HTML only option is on. + + + + + Number of parameter strings. + + + + + Number of strings for SQL statement or URL. + + + + + Number of strings for post method of Web query. + + + + + Number of strings for SQL statement for server-based page fields. + + + + + Number of strings for ODBC connection string. + + + + + This record stores an array of variable-length SXLI structures, which + describe the row and column items in a PivotTable. There are two + LineItemArrayRecords for each PivotTable: the first stores row items, + and the second stores column items. + + + + + Array of LineItem structures. + + + + + Indicates whether internal data array should be preserved. + + + + + Default constructor. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + + + + In this method, the class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + + + + + + + + + Creates new instance + + + + + + Array of LineItem structures. + + + + + Indicates whether record needs internal data array or if it can be cleaned. + + + + + Indicates whether we should add header of continue records to the internal data provider. Read-only. + + + + + LineItem class. + + + + + Size of the fixed part. + + + + + Bit for IsMultiDataName property. + + + + + Bit for IsSubtotal property. + + + + + Bit for IsBlock property. + + + + + Bit for IsGrand property. + + + + + Bit for IsMultiDataOnAxis property. + + + + + Count of items that are identical to the previous element in items array. + + + + + Item type. + + + + + Maximum index to the items array. + + + + + Option flags. + + + + + Array of indexes to SXVI records; the number of elements in the array is m_usMaxType + 1; + + + + + + + + + + + + + + + + + + + + + + Creates new instance + + + + + + Count of items that are identical to the previous element in items array. + + + + + Item type. + + + + + Maximum index to the items array. Read-only. + + + + + Option flags. Read-only. + + + + + Array of indexes to SXVI records. + + + + + Indicates whether to use data field name for the subtotal (instead of using "Total"). + + + + + Indicates whether this item is a subtotal. + + + + + Indicates whether this item is a block total. + + + + + Indicates whether this item is a grand total. + + + + + Indicates whether + + + + + Size of the record. Read-only. + + + + + Item type. + + + + + Represents the Data line item type. + + + + + Represents the Default line item type. + + + + + Represents the Sum line item type. + + + + + Represents the CountA line item type. + + + + + Represents the Count line item type. + + + + + Represents the Average line item type. + + + + + Represents the Max line item type. + + + + + Represents the Min line item type. + + + + + Represents the Product line item type. + + + + + Represents the Stdev line item type. + + + + + Represents the StdevP line item type. + + + + + Represents the Var line item type. + + + + + Represents the VarP line item type. + + + + + Represents the GrandTotal line item type. + + + + + This record stores an array of page item indexes that represent the table + references for a multiple-consolidation PivotTable. + + + + + Array of 2-byte indexes to page items. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + + + + In this method, the class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + + + + Array of 2-byte indexes to page items. + + + + + This record stores the number of page item names in a multiple-consolidation + PivotTable. The names are stored in SXSTRING records that follow this record. + + + + + Default record size. + + + + + Number of page item names. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Number of page item names. + + + + + This record contains information about the PivotTable page item. + + + + + List with page item description for each filter applied. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + + + + In this method, the class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + + + + Creates copy of the current object. + + Copy of the current object. + + + + Returns field items. Read-only. + + + + + This class contains information about field + + + + + Index to the ViewItemRecord for the page item. + + + + + Index to the ViewFieldsRecord for the page item. + + + + + Object ID for the page item drop-down arrows. + + + + + Creates copy of the current object. + + Create copy. + + + + This record stores a PivotTable parsed expression. + + + + + Offset to parsed expression data. + + + + + Size of the parsed expression. + + + + + Number of RTSXNAME records to follow this record. + + + + + Parsed expression. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Size of the parsed expression. Read-only. + + + + + Number of RTSXNAME records to follow this record. + + + + + Parsed expression. + + + + + Summary description for PivotBooleanRecord. + + + + + Record size. + + + + + Boolean value, 0 - false, 1 - true. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Boolean value. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Value of the record. + + + + + Contains information about date/time value in the pivot table. + + + + + Size of the record. + + + + + Year. + + + + + Months. + + + + + Days. + + + + + Hours. + + + + + Minutes. + + + + + Seconds. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Year. + + + + + Months. + + + + + Days. + + + + + Hours. + + + + + Minutes. + + + + + Seconds. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Value of the record. + + + + + Summary description for PivotDoubleRecord. + + + + + Size of the record. + + + + + Double value. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Double value. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Value of the record. + + + + + Summary description for PivotEmptyRecord. + + + + + Record size. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Value of the record. + + + + + Summary description for PivotBooleanRecord. + + + + + Record size. + + + + + Boolean value, 0 - false, 1 - true. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Error code. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Value of the record. + + + + + Summary description for PivotFieldRecord. + + + + + Record size. + + + + + Option flags. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Maybe m_bNotAny. + + + + + + + + + + + + + + + + + + + + Unknown. + + + + + First item count. + + + + + Unknown. + + + + + Second item count. + + + + + Field name. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Option flags. + + + + + + + + + + + + + + + Indicates whether field can contain double values. + + + + + Indicates whether field can contain double values without fraction. + + + + + Indicates whether field can contain string values. + + + + + Unknown flag. + + + + + + + + + + Unknown flag. + + + + + Indicates whether field can contain date values. + + + + + Unknown. + + + + + First item count. + + + + + Unknown. + + + + + Second item count. + + + + + Field name. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + This record stores formatting data. + + + + + Default record size. + + + + + 0 - clear, + 1 - format applied. + + + + + Length of data. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + 0 - clear, + 1 - format applied. + + + + + Length of data. + + + + + This record stores a PivotTable formula. + + + + + Default record size. + + + + + Reserved. Should be set to zero. + + + + + -1 if the calculated item formula applies to all fields, or, + if positive, the field that this calculated item formulas applies to. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Reserved. Should be set to zero. Read-only. + + + + + -1 if the calculated item formula applies to all fields, or, + if positive, the field that this calculated item formulas applies to. + + + + + Summary description for PivotIndexListRecord. + + + + + Index list. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + + + + In this method, the class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + + + + Index list. + + + + + Summary description for PivotNamePairRecord. + + + + + Default record size. + + + + + Field. + + + + + Index of item in field. + + + + + Reserved, should be set to zero. + + + + + Option flags. + + + + + + + + + + Indicates whether item is referred to by position (physical) + rather than by name (logical). + + + + + If m_bPhysical is true, then item is referred to using relative + references rather than absolute references. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Field. + + + + + Index of item in field. + + + + + Reserved, should be set to zero. Read-only. + + + + + Option flags. + + + + + + + + + + Indicates whether item is referred to by position (physical) + rather than by name (logical). + + + + + Indicates whether item is referred to using relative + references rather than absolute references. + + + + + This record stores a PivotTable name. + + + + + Default record size. + + + + + Option flags. + + + + + If it is set to true then the name is invalid and should + be displayed and evaluated as #NAME. + + + + + Field to aggregate in calculated field formulas. + + + + + Function to use for aggregation in calculated field formulas. + + + + + Number of SXPAIR records to follow this record. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Option flags. Read-only. + + + + + If it is set to true then the name is invalid and should + be displayed and evaluated as #NAME. + + + + + Field to aggregate in calculated field formulas. + + + + + Function to use for aggregation in calculated field formulas. + + + + + Number of SXPAIR records to follow this record. + + + + + This record stores information about multiple-consolidation PivotTable source data. + + + + + Bit mask for PageCount property. + + + + + Default record size. + + + + + Count (1-based) of DCONREF or DCONNAME records that follow the SXTBL record. + + + + + Count (1-based) of SXTBPG records that follow the DCONREF or DCONNAME records. + + + + + Option flags. + + + + + Indicates whether the user selected the Create A Single Page Field For Me + option in PivotTable Wizard dialog box. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. + + + + + Count (1-based) of DCONREF or DCONNAME records that follow the SXTBL record. + + + + + Count (1-based) of SXTBPG records that follow the DCONREF or DCONNAME records. + + + + + Option flags. Read-only. + + + + + Indicates whether the user selected the Create A Single Page Field For Me + option in PivotTable Wizard dialog box. + + + + + Count (1-based) of page fields. + + + + + This record contains an SQL query string, an SQL server connection string + or page item name from a multiple-consolidation PivotTable. + + + + + String. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + String value. + + + + + Indicates whether data array is required by this record. Read-only. + + + + + Value of the record. + + + + + This record contains top-level PivotTable information. + + + + + Offset to the PivotTable name data. + + + + + First row of the PivotTable. + + + + + Last row of the PivotTable. + + + + + First column of the PivotTable. + + + + + Last column of the PivotTable. + + + + + First row containing PivotTable headings. + + + + + First row containing PivotTable data. + + + + + First column containing PivotTable data. + + + + + Index to the cache. + + + + + Reserved. Must be zero. + + + + + Default axis for a data field. + + + + + Default position for a data field. + + + + + Number of fields. + + + + + Number of row fields. + + + + + Number of column fields. + + + + + Number of page fields. + + + + + Number of data fields. + + + + + Number of data rows. + + + + + Number of data columns. + + + + + Option flags. + + + + + Indicates whether the PivotTable contains grand totals for rows. + + + + + Indicates whether the PivotTable contains grand totals for columns. + + + + + Indicates whether the PivotTable has an autoformat applied. + + + + + Indicates whether the width / height autoformat is applied. + + + + + Indicates whether the font autoformat is applied. + + + + + Indicates whether the alignment autoformat is applied. + + + + + Indicates whether the Border autoformat is applied. + + + + + Indicates whether the pattern autoformat is applied. + + + + + Indicates whether the PivotTable has an autoformat applied. + + + + + Index to the PivotTable autoformat. + + + + + Length of the PivotTable name. + + + + + Length of the data field name. + + + + + PivotTable name. + + + + + Name of the data field. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + + + + In this method, the class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + + + + First row of the PivotTable. + + + + + Last row of the PivotTable. + + + + + First column of the PivotTable. + + + + + Last column of the PivotTable. + + + + + First row containing PivotTable headings. + + + + + First row containing PivotTable data. + + + + + First column containing PivotTable data. + + + + + Index to the cache. + + + + + Reserved. Must be zero. Read-only. + + + + + Default axis for a data field. + + + + + Default position for a data field. + + + + + Number of fields. + + + + + Number of row fields. + + + + + Number of column fields. + + + + + Number of page fields. + + + + + Number of data fields. + + + + + Number of data rows. + + + + + Number of data columns. + + + + + Option flags. Read-only. + + + + + Indicates whether the PivotTable contains grand totals for rows. + + + + + Indicates whether the PivotTable contains grand totals for columns. + + + + + Indicates whether the PivotTable has an autoformat applied. + + + + + Indicates whether the width / height autoformat is applied. + + + + + Indicates whether the font autoformat is applied. + + + + + Indicates whether the alignment autoformat is applied. + + + + + Indicates whether the Border autoformat is applied. + + + + + Indicates whether the pattern autoformat is applied. + + + + + Indicates whether the PivotTable has an autoformat applied. + + + + + Index to the PivotTable autoformat. + + + + + Length of the PivotTable name. Read-only. + + + + + Length of the data field name. Read-only. + + + + + PivotTable name. + + + + + Name of the data field. + + + + + This record contains extended PivotTable view fields information. + + + + + Option flags. + + + + + Show all items for this field. + + + + + User can drag field to row area. + + + + + User can drag field to column area. + + + + + User can drag field to page area. + + + + + User can remove field from view. + + + + + This field is a server-based field in the page area. + + + + + Autosort is enabled. + + + + + Autosort ascending. + + + + + Autoshow is enabled. + + + + + Show top values. + + + + + Calculated field. + + + + + Reserved. + + + + + Number of items to show for AutoShow, default is 10. + + + + + 0-based index of data field that AutoSort is based on or 0xFFFF for current field. + + + + + 0-based index of data field that AutoShow is based on. + + + + + Number format of field or 0 if none. + + + + + Subtotal name. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + + + + In this method, the class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + + + + Option flags. Read-only. + + + + + Show all items for this field. + + + + + User can drag field to row area. + + + + + User can drag field to column area. + + + + + User can drag field to page area. + + + + + User can remove field from fiew. + + + + + This field is a server-based field in the page area. + + + + + Autosort is enabled. + + + + + Autosort ascending. + + + + + Autoshow is enabled. + + + + + Show top values. + + + + + Calculated field. + + + + + Reserved. Read-only. + + + + + Number of items to show for AutoShow, default is 10. + + + + + 0-based index of data field that AutoSort is based on or 0xFFFF for current field. + + + + + 0-based index of data field that AutoShow is based on. + + + + + Number format of field or 0 if none. + + + + + Specifies the custom text that is displayed for the subtotals label. + + + + + This record contains PivotTable view fields and other information. + + + + + Length indicating that name is null. + + + + + Offset to the string data. + + + + + Axis. + + + + + Number of subtotals attached. + + + + + Item subtotal type. + + + + + Indicating whether the subtotal is positioned at the top. The default value is True. + + + + + Number of items. + + + + + Length of the name; if it is equals to 0xFFFF then name is null + and the name in the cache is used. + + + + + Name. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + + + + In this method, the class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + + + + Axis. + + + + + Number of subtotals attached. + + + + + Item subtotal type. + + + + + Gets or sets a boolean value indicating whether the subtotal is positioned at the top. The default value is True. + + + + + Number of items. + + + + + Length of the name; if it is equals to 0xFFFF then name is null + and the name in the cache is used. + + + + + Name. + + + + + This record contains information about a PivotTable item. + + + + + Offset to the name data. + + + + + Item type. + + + + + Option flags. + + + + + Indicates whether the item is hidden. + + + + + Indicates whether detail is hidden. + + + + + Indicates whether the item is a calculated item. + + + + + Indicates whether item is an item that does not exist in any records. + + + + + Index to the PivotTable cache. + + + + + Length of the name. If it is equal to 0xFFFF, then name is null + and the name in the cache is used. + + + + + Name. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + + + + In this method, the class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + + + + Item type. + + + + + Option flags. Read-only. + + + + + Indicates whether the item is hidden. + + + + + Indicates whether detail is hidden. + + + + + Indicates whether the item is calculated item. + + + + + Indicates whether item is an item that does not exist in any records. + + + + + Index to the PivotTable cache. + + + + + Length of the name. If it is equal to 0xFFFF, then name is null + and the name in the cache is used. Read-only. + + + + + Name. + + + + + Possible item types. + + + + + Represents the item type. + + + + + Represents the item type. + + + + + Represents the Data item type. + + + + + Represents the Default item type. + + + + + Represents the Sum item type. + + + + + Represents the Counta item type. + + + + + Represents the Count item type. + + + + + Represents the Average item type. + + + + + Represents the Max item type. + + + + + Represents the Min item type. + + + + + Represents the Product item type. + + + + + Represents the Stdev item type. + + + + + Represents the Stdevp item type. + + + + + Represents the Var item type. + + + + + Represents the Varp item type. + + + + + Represents the GrandTotal item type. + + + + + This record contains an integer that defines the data source for a PivotTable. + + + + + Default record size. + + + + + Data source. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Data source. + + + + + Possible data sources. + + + + + Microsoft Excel list or database. + + + + + External data source (Microsoft Query). + + + + + Multiple consolidation ranges. + + + + + Another PivotTable. + + + + + A Scenario Manager summary report. + + + + + This record stores an array of field ID numbers (2-byte integers) for + the row fields and column fields in a PivotTable. Two RowColumnFieldIdRecords + appear in the file: the first contains the array of row field IDs, and + the second contains the array of column field IDs. + + + + + Array of 2-byte integers; contains either row field IDs or column field IDs. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Array of 2-byte integers; contains either row field IDs or column field IDs. + + + + + This record stores PivotTable rule data. + + + + + Default record size. + + + + + Bit mask for RuleType property. + + + + + First bit for RuleType property. + + + + + Position of current field in axis. + + + + + Current field. + + + + + Option flags. + + + + + Indicates whether current field is in row area. + + + + + Indicates whether current field is in column area. + + + + + Indicates whether current field is in page area. + + + + + Indicates whether current field is in data area. + + + + + Indicates whether header is not selected. + + + + + Indicates whether data is not selected. + + + + + Indicates whether row grand total is selected. + + + + + Indicates whether column grand total is selected. + + + + + + + + + + + + + + + + + + + + Reserved, must be zero. + + + + + Number of SXFILT records following this record. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Position of current field in axis. + + + + + Current field. + + + + + Option flags. Read-only. + + + + + Indicates whether current field is in row area. + + + + + Indicates whether current field is in column area. + + + + + Indicates whether current field is in page area. + + + + + Indicates whether current field is in data area. + + + + + + + + + + Indicates whether header is not selected. + + + + + Indicates whether data is not selected. + + + + + Indicates whether row grand total is selected. + + + + + Indicates whether column grand total is selected. + + + + + + + + + + + + + + + + + + + + Reserved, must be zero. + + + + + Number of SXFILT records following this record. + + + + + This record stores PivotTable Rule Filter options. + + + + + Default record size. + + + + + BitMask for Dim field. + + + + + Start bit for Dim field. + + + + + Bit mask for SXVD field. + + + + + Options flags. + + + + + Indicates whether field is in row area. + + + + + Indicates whether field is in column area. + + + + + Indicates whether field is in page area. + + + + + Indicates whether field is in data area. + + + + + Options flags. + + + + + + + + + + Number of ViewItemRecord records. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + Options flags. + + + + + Indicates whether field is in row area. + + + + + Indicates whether field is in column area. + + + + + Indicates whether field is in page area. + + + + + Indicates whether field is in data area. + + + + + + + + + + Options flags. Read-only. + + + + + + + + + + + + + + + Number of ViewItemRecord records. + + + + + Represents the Function types. + + + + + Represents the Data type. + + + + + Represents the Default type. + + + + + Represents the Sum type. + + + + + Represents the CountA type. + + + + + Represents the Count type. + + + + + Represents the Average type. + + + + + Represents the Max type. + + + + + Represents the Min type. + + + + + Represents the Product type. + + + + + Represents the Stdev type. + + + + + Represents the Stdevp type. + + + + + Represents the Var type. + + + + + Represents the Varp type. + + + + + This record stores PivotTable selection information. + + + + + Size of the record. + + + + + 0-based index of the window of the sheet. + + + + + 0-based index of the pane of the window. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + 0-based index of the window of the sheet. + + + + + 0-based index of the pane of the window. + + + + + Maximum size of the record. + + + + + Minimum size of the record + + + + + This record contains a SQL datatype identifier. + + + + + Correct record size. + + + + + The SQL datatype of the field described in the immediately preceding SXFDB record. + These are the same values as found in the ODBC SDK. See the SQL datatypes in SQL.H. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Evaluates size of the required storage space. + + Size of the required storage space. + + + + The SQL datatype of the field described in the immediately preceding SXFDB record. + + + + + The SQL datatypes. + + + + + Represents the SQL_UNKNOWN_TYPE SQL data type. + + + + + Represents the SQL_CHAR SQL data type. + + + + + Represents the SQL_NUMERIC SQL data type. + + + + + Represents the SQL_DECIMAL SQL data type. + + + + + Represents the SQL_INTEGER SQL data type. + + + + + Represents the SQL_SMALLINT SQL data type. + + + + + Represents the SQL_FLOAT SQL data type. + + + + + Represents the SQL_REAL SQL data type. + + + + + Represents the SQL_DOUBLE SQL data type. + + + + + Represents the SQL_DATETIME SQL data type. + + + + + Represents the SQL_VARCHAR SQL data type. + + + + + This record is a header record for a group of SXVS, SXEXT, and SXSTRING records + that describe the PivotTable streams in the SX DB storage (the PivotTable cache storage). + The StreamId field identifies the stream. + + + + + Default record size. + + + + + Stream Id. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. + + + + + Stream Id. + + + + + This record follows the SXVIEW record and contains information about + additional features added to PivotTables in Excel. + + + + + Bit mask for WrapPage property value. + + + + + Start bit for WrapPage property value. + + + + + Maximum value for WrapPage property. + + + + + Offset to the strings data. + + + + + Number of SXFORMAT records to follow. + + + + + Number of characters for DisplayErrorString string. + + + + + Number of characters for DisplayNullString string. + + + + + Number of characters in Tag string. + + + + + Number of RTSXSELECT records to follow. + + + + + Number of page field per row. + + + + + Number of page field per column. + + + + + Option flags. + + + + + + + + + + + + + + + + + + + + Option flags. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Number of characters for page field style string. + + + + + Number of characters for table style string. + + + + + Number of characters for vacate style string. + + + + + ErrorString. + + + + + NullString. + + + + + Tag. + + + + + Page field style. + + + + + Table style. + + + + + Vacate style. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + + + + In this method, the class must pack all of its properties into an + internal data array, m_data. This method is called by + FillStream when the record must be serialized into a stream. + + + + + Number of SXFORMAT records to follow. + + + + + Number of characters for DisplayErrorString string. Read-only. + + + + + Number of characters for DisplayNullString string. Read-only. + + + + + Number of characters in Tag string. Read-only. + + + + + Number of RTSXSELECT records to follow. + + + + + Number of page field per row. + + + + + Number of page field per column. + + + + + Option flags. Read-only. + + + + + + + + + + + + + + + + + + + + + + + + + Option flags. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Number of characters for page field style string. Read-only. + + + + + Number of characters for table style string. Read-only. + + + + + Number of characters for vacate style string. Read-only. + + + + + ErrorString. + + + + + NullString. + + + + + Tag. + + + + + Page field style. + + + + + Table style. + + + + + Vacate style. + + + + + Defines whether to store with full precision or what is displayed the GUI. + + + + + Default record size. + + + + + Whether to use full precision or just skew some of the figures; + 1 = full precision. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. + + + + + Whether to use full precision or just skew some of the figures; + 1 = full precision. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record saves printer settings and printer driver information. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + When string's length does not fit to internal data length or + when last string ends before data (some extra data at the + end of m_data array). + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + Creates copy of the current object. + + A copy of the current object. + + + + + + + + + Indicates whether we should add header of continue records to the internal data provider. Read-only. + + + + + Indicates whether record needs internal data array + or if it can be cleaned. Read-only. + + + + + Defines whether or not to print the gridlines when you + print your spreadsheet on paper. + + + + + Default record size. + + + + + Whether or not to print the gridline. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. + + + + + Whether or not to print the gridline. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Whether or not to print the row / column headers + of the spreadsheet in the physical form. + + + + + Default record size. + + + + + Print headers or not. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Print headers or not. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Stores print setup options. + + + + + Bit mask for error print options. + + + + + Start bit of error print options in m_usOptions. + + + + + Correct record size. + + + + + Paper size. + + + + + Scaling factor in percent. + + + + + Start page number. + + + + + Fit worksheet width to this number of pages (0 = use as many as needed). + + + + + Fit worksheet height to this number of pages (0 = use as many as needed). + + + + + Options flag. + + + + + False to print pages in columns; + True to print pages in rows. + + + + + False for landscape; True for portrait. + + + + + True if paper size, scaling factor, paper orientation (portrait / landscape), + print resolution, and number of copies are not initialized. + + + + + False to print in color; True to print in black and white. + + + + + False for default print quality; True for draft quality. + + + + + Indicates whether to print cell notes. + + + + + False if paper orientation setting is valid; + True if paper orientation setting is not initialized. + + + + + False for automatic page numbers; + True to use starting page number. + + + + + False if print notes are displayed; + True if print notes are at the end of sheet. + + + + + Print resolution in dpi. + + + + + Vertical print resolution in dpi. + + + + + Header margin (IEEE floating-point value). + + + + + Footer margin (IEEE floating-point value). + + + + + Number of copies to print. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Paper size. + + + + + Scaling factor in percent. + + + + + Start page number. + + + + + Fit worksheet width to this number of pages (0 = use as many as needed). + + + + + Fit worksheet height to this number of pages (0 = use as many as needed). + + + + + Print resolution in dpi. + + + + + Vertical print resolution in dpi. + + + + + Header margin (IEEE floating-point value). + + + + + Footer margin (IEEE floating-point value). + + + + + Number of copies to print. + + + + + False to print pages in columns; + True to print pages in rows. + + + + + False if landscape; True if portrait. + + + + + True if paper size, scaling factor, paper orientation (portrait / landscape), + print resolution, and number of copies are not initialized. + + + + + False to print in color; True to print in black and white. + + + + + False for default print quality; True for draft quality. + + + + + Indicates whether to print cell notes. + + + + + False if paper orientation setting is valid; + True if paper orientation setting is not initialized. + + + + + False for automatic page numbers; + True to use starting page number. + + + + + False if print notes as displayed; + True if print notes are at the end of sheet. + + + + + Indicates how to print errors. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Describes whether this is a protected shared / tracked workbook. + + + + + Default record size. + + + + + Whether or not this is protected shared / tracked workbook. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. + + + + + Whether or not this is protected shared / tracked workbook. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Whether a worksheet or a workbook is protected against modification. + Protection is not active if this record is omitted. + + + + + Whether a worksheet or a workbook is protected against modification. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Whether a worksheet or a workbook is protected against modification. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record contains the cell range and text for a ToolTip. + It occurs in conjunction with the HLINK record for hyperlinks in the Hyperlink Table. + + + + + Size of the fixed part. + + + + + 0x0800 (repeated record identifier). + + + + + Cell range address of all cells containing the ToolTip. + + + + + ToolTip string. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + If the last symbol of string (it is also last symbol of the data array) is not zero. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + Size of the required storage space. Read-only. + + + + + Cell range address of all cells containing the ToolTip. + + + + + ToolTip string. + + + + + Read-only. Returns minimum possible size of the record. + + + + + Represents range protection and error indicators. + + + + + Represents length offset. + + + + + Represents data offset. + + + + + Represents default subrecord size. + + + + + Represents record end unknown bytes count. + + + + + Represents default subrecords size. + + + + + Represents first unknown bytes. + + + + + Represents second unknown bytes. + + + + + Represents error indicator hide options. + + + + + Represents array of error indicator structure. + + + + + Preserves range protection record + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Gets default record store size. Read-only. + + + + + Tries to reduce number of ranges. + + + + + Represents hide options. + + + + + Represents error indicators object. + + + + + Read-only. Minimum possible size of the record. + + + + + Describes which reference mode to use. + + + + + Correct record size. + + + + + Stores which method is used to show cell addresses in formulas. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Stores which method is used to show cell addresses in formulas: + 1 = A1 mode + 0 = RC mode + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Flag whether to refresh all external data when loading a sheet. + + + + + Default record size. + + + + + Flag whether to refresh all external data when loading a sheet. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. + + + + + Flag whether to refresh all external data when loading a sheet. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Represents a cell that contains an RK value + (encoded integer or floating-point value). + + + + + Correct record size. + + + + + Record size with header. + + + + + Offset to the number from the start of the record's data. + + + + + Offset to the number from the start of the record's data. + + + + + Represents rk mask. + + + + + Maximum number that is possible to store as rk record. + + + + + Minimum number that is possible to store as rk record. + + + + + RK value. + + + + + True if value is multiplied by 100. + + + + + True if signed integer; False if floating-point value. + + + + + Default constructor + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset to the record's data. + Excel version used to fill data. + + + + Returns size of the required storage space. + + Excel version. + Size of the required storage space. + + + + Converts string to the Rk number. + + String to convert. + + + + Sets RkNumber to the specified value. + + Double value to set. + + + + Sets integer value to the specified value. + + Value to set. + + + + Sets RkRecord values from MulRKRecord.RkRec + + MulRKRecord.RkRec with needed values. + + + + Converts RKRecord into MulRKRecord.RkRec. + + Converted record. + + + + Converts string to RK number. + + String to parse. + Parsed RK number. If returns int.MaxValue - cannot parse RK number. + + + + Converts double to RK number. + + Value to convert. + Converted RK number. If returns int.MaxValue - cannot parse RK number. + + + + Converts Rk number to double. + + Rk number to convert. + Converted double value. + + + + Converts double value to integer. Value as IEEE double or IEEE / 100 double. + + Value to convert. + Indicates is convert to IEEE / 100. + Int value corresponding to the double value. + + + + Encodes rk number. + + Represents value to encode. + Returns encoded value. + + + + Gets double value using unsafe code. + + Represents value. + Returns double value. + + + + Gets double value using safe code. + + Represents value. + Returns double value. + + + + Reads record's value from the data provider. + + Provider to read data from. + Offset to the record's start. + Excel version that was used to infill. + Record's value. + + + + Read-only. RK value. + + + + + RK value converted to double. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + + + + + + True if this is not a floating point value. + + + + + True if value was multiplied by 100. + + + + + Returns double value. Read-only. + + + + + Value of the record. + + + + + Stores the row information for the sheet. + + + + + Bit mask for outline level. + + + + + Maximum row height in points. + + + + + + + + + + Index of this row. + + + + + Index to column of the first cell which is described by a cell record. + + + + + Index to column of the last cell which is described by a cell record, + increased by 1. + + + + + Height of the row, in twips = 1/20 of a point. + + + + + Not used. + + + + + Options flag. + + + + + Worksheet object. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + + + + + + Index of this row. + + + + + Index to column of the first cell which is described by a cell record. + + + + + Index to column of the last cell which is described by a cell record, + increased by 1. + + + + + Height of the row, in twips = 1/20 of a point. + + + + + If the row is formatted, then this is the index to + the extended format record. + + + + + The outline level of this row. + Changes some bits of m_usOptionFlags private member. + + + When value is more than 7. + + + + + Whether or not to collapse this row. + + + + + Whether or not to display this row with 0 height. + + + + + Whether the font and row height are not compatible. + True if they aren't compatible. + + + + + Whether the row has been formatted (even if it has all blank cells). + + + + + True if there is additional space above the row. + + + + + True if there is additional space below the row. + + + + + Undocumented bit flag. If it is set to False, then Excel will + not show row groups. Default value is True. + + + + + Read-only. Not used. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + + + + + + Row or column index. + + + + + Gets or sets the worksheet. + + The worksheet. + + + + Possible option flags. + + + + + Whether or not to collapse this row. + + + + + Whether or not to display this row with 0 height. + + + + + Whether the font and row height are not compatible. + True if they aren't compatible. + + + + + Whether the row has been formatted (even if its got all blank cells) or + row has explicit default format. + + + + + If this value is set to False, then Excel will not show row outline + groups. + + + + + Additional space above the row. + + + + + Additional space below the row. + + + + + This record stores a formatted text cell (Rich-Text). + In BIFF8 it is replaced by the LABELSST record. + Nevertheless, Excel uses this record if it copies formatted + text cells to the clipboard. + + + + + Index to row. + + + + + Index to column. + + + + + Index to XF (Extended Format) record. + + + + + Unformatted Unicode string, 16-bit string length. + + + + + Number of rich text formatting runs. + + + + + Array of formatting runs. + + + + + Default constructor fills all data with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Excel version used for infill. + Size of the record data. + + + + Index to row. + + + + + Index to column. + + + + + Index to XF (Extended Format) record. + + + + + Unformatted Unicode string, 16-bit string length. + + + + + Array of formatting runs. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Returns string value. Read-only. + + + + + Rich text formatting run. + + + + + First formatted character (zero-based). + + + + + Index to FONT record. + + + + + Defines whether to recalculate before saving (set to 1). + + + + + Correct record size. + + + + + Defines whether to recalculate before saving (set to 1). + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + Defines whether to recalculate before saving (set to 1). + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record is part of the worksheet / workbook protection. + It determines whether the scenarios of the current sheet + are protected. Scenario protection is not active + if this record is omitted. + + + + + Default record size. + + + + + 0 = Objects not protected; 1 = Objects protected + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. + + + + + 0 = Scenarios not protected; 1 = Scenarios protected + + + + + Read-only. Minimum possible size of the record. + + + + + Read-only. Maximum possible size of the record. + + + + + Shows the user's selection on the sheet + for write set num refs to 0. + + + + + Size of the fixed part. + + + + + Subitem size. + + + + + The window pane for the record. + + + + + The active cell's row. + + + + + The active cell's column. + + + + + The active cell's reference number. + + + + + The number of cell refs. + + + + + List of ADDR structures. + + + + + Sets selection range. + + Ref index. + Addr to set. + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Size of the required storage space. Read-only. + + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + The window pane for the record. + + + + + The active cell's row. + + + + + The active cell's column. + + + + + The active cell's reference number. + + + + + The number of cell refs. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + List of ADDR structures. + + + + + Each cell range address (called an ADDR structure) contains 4 16-bit values. + Cell range address, BIFF8. + + + + + Index to first row. + + + + + Index to last row. + + + + + Index to first column. + + + + + Index to last column. + + + + + Index to first row. + + + + + Index to last row. + + + + + Index to first column. + + + + + Index to last column. + + + + + Creates TAddr by specified first and last rows and first and last columns. + + First row of the cell range. + Last row of the cell range. + First column of the cell range. + Last column of the cell range. + + + + Creates TAddr by specified first and last rows and first and last columns. + + First row of the cell range. + Last row of the cell range. + First column of the cell range. + Last column of the cell range. + + + + Converts object to the string. + + String representation of the object. + + + + Index to first row. + + + + + Index to last row. + + + + + Index to first column. + + + + + Index to last column. + + + + + This record stores the token array of a shared formula. + Shared formulas are similar to array formulas in that they store + a formula used in a range of cells. The SharedFormula record + is not a real cell record but follows the first FORMULA + record of the cell range. + + + + + Size of the record's fixed part. + + + + + Index to first row of the shared formula range. + + + + + Index to last row of the shared formula range. + + + + + Index to first column of the shared formula range. + + + + + Index to last column of the shared formula range. + + + + + Not used. + + + + + Size of the formula data. + + + + + Token array of the shared formula. + + + + + + + + + + Default constructor fills all data with default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Index to first row of the shared formula range. + + + + + Index to last row of the shared formula range. + + + + + Index to first column of the shared formula range. + + + + + Index to last column of the shared formula range. + + + + + Read-only. Size of the formula data. + + + + + Token array of the shared formula. + + + + + Gets/sets formula into/from shared formula record. + + + + + Read-only. Reserved. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Whether to center between horizontal margins. + + + + + Whether or not to horizontally or vertically (depending on the record code) center this sheet. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Whether or not to horizontally or vertically (depending on record code) center this sheet. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record stores the colour of the tab below the sheet containing the sheet name. + + + + + Record size. + + + + + Repeated record identifier. + + + + + Reserved. + + + + + Reserved. + + + + + Reserved. + + + + + Size of the record + + + + + Color index for sheet name tab. + + + + + Options shows the value of following. + 0 to 7 bit - Color Index value should be same as m_iColorIndex. + 8 th bit - Indicates whether Conditional formatting formulas in this workbook evaluated. + 9 th bit - Indicates whether The sheet is published. + + + + + Type of color. + + + + + Color value. + + + + + Tint and shade. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. + + + + + Compare the value with the given compare value and returns the boolean value + + input long value + input compare value + the boolean value + + + + Repeated record identifier. + + + + + Reserved. + + + + + Reserved. + + + + + Reserved. + + + + + Unknown data. + + + + + Color index for sheet name tab. + + + + + Read-only. Minimum possible size of the record. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Maximum memory size for internal buffer. + + + + + Gets the boolean value indicates whether the Conditional formatting formulas in this workbook is Evaluated + + + + + Gets the boolean value indicates whether the sheet is not published. + + + + + Type of color. + + + + + Color value. + + + + + Tint and shade. + + + + + Options value. + + + + + Summary description for SheetProtection. + + + + + Represents the Error Indicator sheet protection id. + + + + + Represents option offset. + + + + + Represents default record store size. + + + + + Represents default embedded record data. + + + + + Options flag. + + + + + Indicates is contain sheet protection. + + + + + Represents the Protection type. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Gets default record store size. Read-only. + + + + + Represents protected options. + + + + + Indicates is record contain sheet protection. + + + + + Read-only. Minimum possible size of the record. + + + + + Read-only. Maximum possible size of the record. + + + + + Represents the protection type. + + + + + This record stores the last settings from the "Sort" dialog + for each sheet. These settings are not attached to a cell range + in the sheet, so it is not possible to determine + the cell range sorted with the settings of this record. + + + + + Bit mask for the table index. + + + + + Start bit for the table index. + + + + + Size of the fixed part size. + + + + + Option flags. + + + + + False to sort rows (top to bottom); + True to sort columns (left to right). + + + + + False to sort first key in ascending order; + True to sort first key in descending order. + + + + + False to sort second key in ascending order; + True to sort second key in descending order. + + + + + False to sort third key in ascending order; + True to sort third key in descending order. + + + + + False to sort case-insensitive; + True to sort case-sensitive. + + + + + Length of first sort key. + + + + + Length of second sort key. + + + + + Length of third sort key. + + + + + First sort key. + + + + + Second sort key. + + + + + Third sort key. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Returns size of the string + + + + + + + Size of the required storage space. Read-only. + + + + + False to sort rows (top to bottom); + True to sort columns (left to right). + + + + + False to sort first key in ascending order; + True to sort first key in descending order. + + + + + False to sort second key in ascending order; + True to sort second key in descending order. + + + + + False to sort third key in ascending order; + True to sort third key in descending order. + + + + + False to sort case-insensitive; + True to sort case-sensitive. + + + + + One-based index into the table of defined sort lists, + or 0 for sorting without a list. + This property changes some bits of m_usOptions. + + + + + Read-only. Length of first sort key. + + + + + Read-only. Length of second sort key. + + + + + Read-only. Length of third sort key. + + + + + First sort key. + + + + + Second sort key. + + + + + Third sort key. + + + + + Read-only. Minimum possible size of the record. + + + + + Static String Table Record: + This holds all the strings for LabelSSTRecords. + + + + + Options byte offset in the string. + + + + + Number of string in workbook. + + + + + Number of unique strings in workbook. + + + + + Array of workbook's strings. + + + + + Array that stores positions of the strings in the m_data array. + + + + + Array that stores offsets of the strings starting from the beginning + of the record (Continue or SST). + + + + + + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + If any internal error occurred. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + Serializes text data. + + Record builder to put data into. + String options. + Size of the formatting data. + Total size of the string data. + Array containing string data. + + + + Infills formatting bytes. + + Record builder to put data into. + Array containing formatting data. + Size of the formatting data. + + + + Tries to prognose records size and prepare data storage so it won't require resize operation. + + + + + Resizes buffer if necessary. + + Buffer to check. + Desired buffer size. + + + + This method checks record's internal data array for integrity. + + If there is any internal error. + + + + Size of the required storage space. Read-only. + + + + + Number of string in workbook. + + + + + Number of unique strings in workbook. + + + + + Array of workbook's strings. + + + + + Array that stores positions of the strings in the m_data array. + + + + + Array that stores offsets of the strings starting from the beginning + of the record (Continue or SST). + + + + + Configuration property. If value is True, then on detection of dataless + record, the class will try to continue to get records from the stream. + + + + + + + + + + This record stores the result of a string formula. + It occurs directly after a string formula. + + + + + Size of the fixed part. + + + + + String length. + + + + + Non-empty Unicode string. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Non-empty Unicode string. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Style Record: + Describes a built-in style in the GUI or user defined style. + + + + + Extended format index bit mask. + + + + + The actual index of the style extended format record. + + + + + Whether the style is built in or user-defined. + + + + + If this is a built in style, then it is the number of the built in style. + If this is user-defined style, then it is length of style's name. + + + + + The row or column level of the style. + + + + + The style's name (if user-defined). + + + + + The style's name (if user-defined and greater than 256 symbols). + + + + + Represents the default external format index based on workbook version + + + + + /Represents if the stylename is encoded, when style name is greater than 256 symbols + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Copies this record into another StyleRecord. + + + + + + Whether the style is built in or user-defined. + + + + + + The actual index of the style extended format record. + + + + + The row or column level of the style. + + + + + The row or column level of the style. + + + + + The style's name (if user-defined). + + + + + Represents actual style name in case of AsciiConversion + + + + + Gets or sets if the style record is built-in customized + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Returns style name. Read-only. + + + + + Gets or sets the default external format index based on workbook version + + + + + Header of this record + + + + + Whether the style is built in or user-defined. + + + + + Whether the style is hidden in user interface or not. + + + + + Whether the style is custom or not. + + + + + Reserved data. + + + + + Specify the type of style + + + + + Buid in data + + + + + The style's name (if user-defined). + + + + + The row or column level of the style. + + + + + If this is a built in style, then it is the number of the built in style. + If this is user-defined style, then it is length of style's name. + + + + + Default constructor + + + + + Initialize the variables + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Whether the style is built in or user-defined. + + + + + Whether the style is hidden in user interface or not + + + + + Whether the style is custom or not. + + + + + The style's name (if user-defined). + + + + + Specify the type of style + + + + + This record stores the URL of an external document + and a list of sheet names inside this document. Furthermore, + it is used to store DDE and OLE object links or to indicate + an internal 3D reference or an add-in function. + + + + + This constant indicates that the sup book record contains internal references. + + + + + This constant indicates that the sup book record contains add-in functions. + + + + + Indicates whether this record is used for internal references or external references. + + + + + Indicates whether add-in function names are stored + in EXTERNNAME records following this SUPBOOK record. + + + + + Number of sheet names (if external references) or + number of sheets in this document (if internal references). + + + + + Length of encoded URL without sheet name (if external references). + 0401h (if internal references) + + + + + Encoded URL without sheet name. + + + + + List of sheet names. + + + + + Original URL value. + + + + + Default constructor + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + When string's length does not fit to internal data length or + when last string ends before data (some extra data at the + end of m_data array). + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + + + + + + Size of the required storage space. Read-only. + + + + + Creates copy of the SupBookRecord. + + SupBookRecord with copied data. + + + + Whether the record is used for internal references or external references. + + + + + Read-only. Minimum possible size of the record. + + + + + Read-only. Maximum possible size of the record. + + + + + Encoded URL without sheet name (for external references). + + + + + Gets / sets original url value. + + + + + List of sheet names. + + + + + Number of sheet names (if external references) or + number of sheets in this document (if internal references). + + + + + + + + + + Sheet Tab Index Array Record: + Contains an array of sheet ID's. Sheets always keep their ID + regardless of what their name is. + + + + + Array of tab IDs. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + This method checks a record's internal data array for integrity. + + + If there is any internal error. + + + + + Size of the required storage space. Read-only. + + + + + Array of tab IDs. + + + + + This record stores information about a multiple operation + table in the sheet. It follows the first FORMULA record + of the cell range containing the operation table. + + + + + Bit mask for the operation mode. + + + + + First bit of the operation mode. + + + + + Index to first row of the multiple operation table range. + + + + + Index to last row of the multiple operation table range. + + + + + Index to first column of the multiple operation table range. + + + + + Index to last column of the multiple operation table range. + + + + + Option flags. + + + + + True to always recalculate array formula. + + + + + True to calculate array formula on open. + + + + + Index to row of input cell (in mode 1x2 index to row of + input cell for row input). + + + + + Index to column of input cell (in mode 1x2 index to column + of input cell for row input). + + + + + In mode 1x2 index to row of input cell for column input; + else not used. + + + + + In mode 1x2 index to column of input cell for column input; + else not used. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Index to first row of the multiple operation table range. + + + + + Index to last row of the multiple operation table range. + + + + + Index to first column of the multiple operation table range. + + + + + Index to last column of the multiple operation table range. + + + + + True to always recalculate array formula. + + + + + True to calculate array formula on open. + + + + + Whether to display outline symbols (in the gutters). + Changes bits of m_usOptions. + + + When value is more than 4. + + + + + Index to row of input cell (in mode 1x2 index to row of + input cell for row input). + + + + + Index to column of input cell (in mode 1x2 index to column + of input cell for row input). + + + + + In mode 1x2 index to row of input cell for column input; + else not used. + + + + + In mode 1x2 index to column of input cell for column input; + else not used. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + If stream is not specified. + If stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Read-only. Maximum possible size of the record. + + + + + This record stores a text object. The TXO record is followed + by two CONTINUE records. The first CONTINUE record contains the text + data and the second CONTINUE contains the formatting runs. + If the text box contains no text, these CONTINUE records + are not written to the file. + + + + + Bit mask for horizontal alignment. + + + + + Bit mask for vertical alignment. + + + + + Option flags. + + + + + Whether the Lock Text option is on. + + + + + Orientation of text within the object boundary. + + + + + Reserved, must be zero. + + + + + Reserved, must be zero. + + + + + Length of text (in first CONTINUE record). + + + + + Length of formatting runs (in second CONTINUE record). + + + + + Reserved, must be zero. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + Horizontal text alignment. + This property changes bits of m_usOptions private field. + + + + + Vertical text alignment: + This property changes bits of m_usOptions private field. + + + + + Whether the Lock Text option is on. + + + + + Orientation of text within the object boundary. + + + + + Length of text (in first CONTINUE record). + + + + + Length of formatting runs (in second CONTINUE record). + + + + + Not used. + + + + + Not used. + + + + + Not used. + + + + + Read-only. Minimum possible size of the record. + + + + + Read-only. Maximum possible size of the record. + + + + + Summary description for TextFormat. + + + + + + + + + + + + + + + Size of a single formatting run. + + + + + + + + + + + + + + + Formatting runs, key - position, value - font index. + + + + + String value. + + + + + Default font index. + + + + + Options. + + + + + Indicates whether string was changed and possibly needs defragmentation. + + + + + Number of references to this object. + + + + + Reprsents the Rich Text. + + + + + Indicates the string is preserverd type or not + + + + + Indicates the string is encoded type or not + + + + + Default constructor. + + + + + Creates instance with specified default font index. + + Index of the default font. + + + + Converts TextWithFormat to string. + + Object to convert to string. + String value of the object. + + + + Converts string to TextWithFormat. + + String value. + Converted TextWithFormat. + + + + Sets font index for specified range of characters. + + Start character of the range. + End character of the range. + Font index to set. + + + + Returns font index for the specified character. + + Character index to get font index. + Font index for the specified character. + + + + Returns font index for the specified character. + + Character index to get font index. + Font index for the specified character. + + + + Returns font index at the specified position in the formatting runs array. + + Index of the formatting run. + Font index. + + + + Returns character position at the specified position in the formatting runs array. + + Index of the formatting run. + Character position. + + + + Sets font index at the specified position in the formatting runs array. + + Index of the formatting run. + Font index to set. + + + + Clears formatting. + + + + + Compares the current instance with another object of the same type. + + An object to compare with this instance. + + A 32-bit signed integer that indicates the relative order of the comparands. + + + + + Compares formatting runs. + + First formatting runs to compare. + Second formatting runs to compare. + + 0 if they are equal, + -1 if first formatting run is less then second; + otherwise 1. + + + + + + + + + + Returns starting position for formatting block which contains specified position. + + Position to which formatting is applied. + Starting position for formatting block which contains specified position. + + + + Removes all formatting within specified range. + + Start position of the range. + End position of specified range. + + + + Defragments text formatting. + + + + + Checks if specified offset is correct. + + Length of the array. + Offset in the array. + + When iOffset is out of range. + + + + + Copies formatting runs into another TextWithFormat object. + + TextWithFormat to copy data into. + + + + Converts this object to string. + + String representation of this object. + + + + 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 hashcode for the object. + + A hash code for the current object. + + + + Parses byte array. + + Array of bytes to parse. + Offset of the object's data in the array. + Size of the object in the data array. + + + + Evaluates size of the text in bytes. + + Returns text size in bytes. + + + + Returns size of the formatting runs. + + Size of the formatting runs. + + + + Serializes formatting. + + Returns array of bytes that contains formatting data. + + + + Serializes formatting. + + Buffer for formatting data. + Offset in the buffer where to serialize formatting. + Indicates whether defragmentation is needed. + Size of formatting data. + + + + Returns string options. + + Options byte. + + + + Converts byte array to string. + + Byte array with string data. + Desired number of charts. + Indicates whether string is in unicode format. + Offset of the string data. + Extracted string. + + + + Parses formatting runs. + + Array with formatting runs data. + Offset to formatting runs. + Number of formatting runs to parse. + + + + Parses formatting runs. + + Array with formatting runs. + + + + Parses Far East data. + + + + + + + + Serializes formatting runs. + + Array with formatting runs. + + + + Serializes formatting runs into specified array. + + Destination array. + Offset to the data. + Indicates whether defragmentation is needed. + Size of the serialized data. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + Creates a new object that is a copy of the current instance. + + Dictionary with new font indexes. + A new object that is a copy of this instance. + + + + Updates font indexes. + + Dictionary with new font indexes. + + + + Reprsents the Rich Text + + + + + Text string. + + + + + Formatting runs, key - position, value - font index. + + + + + List of formatting runs. Read-only. + + + + + Gets / sets default font index. + + + + + Returns number of formatting runs. Read-only. + + + + + Returns true if string is preserved type. + + + + + Returns true if string is encoded type. + + + + + Possible string flags. + + + + + Non-Unicode + + + + + The string is saved as double-byte characters. + + + + + Extended string follows (Far East versions). + + + + + Rich string follows. + + + + + + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Read-only. Returns maximum possible size of record. + + + + + Represents UnknowEndRecord + + + + + Default record size. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Gets / sets first unknown int value. + + + + + Gets / sets second unknown int value. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Summary description for UnkMacrosDisable. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Maximum possible size of the record. Read-only. + + + + + + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + If there is any internal error. + + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Reserved. + + + + + Reserved. + + + + + Reserved. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + This record describes all unknown information in records. + + + + + + + + + + + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Read / initialize constructor. + + Reader from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + + + + Size of the required storage space. Read-only. + + + + + Clones current instance. + + Returns cloned object. + + + + + + + + + + + + + + + + + + + Gets / sets length of the data array. + + + + + Summary description for UnsafeDataProvider. + + + + + Default constructor to prevent creation of items without arguments. + + + + + Creates provider of the same type. + + Created provider object. + + + + Returns byte value at the specified position. + + Offset to the required value. + Byte at the specified position. + + + + Returns Int16 value at the specified position. + + Offset to the required value. + Int16 value at the specified position. + + + + Returns Int32 value at the specified position. + + Offset to the required value. + Int32 value at the specified position. + + + + Returns Int32 value at the specified position. + + Offset to the required value. + Int32 value at the specified position. + + + + Returns Double value at the specified position. + + Offset to the required value. + Double value at the specified position. + + + + Writes byte value at the specified position. + + Offset to the required value. + Byte value to write at the specified position. + + + + Writes Int16 value at the specified position. + + Offset to the required value. + Int16 value to write at the specified position. + + + + Writes Int32 value at the specified position. + + Offset to the required value. + Int32 value to write at the specified position. + + + + Writes Int64 value at the specified position. + + Offset to the required value. + Int64 value to write at the specified position. + + + + Writes Double value at the specified position. + + Offset to the required value. + Double value to write at the specified position. + + + + Informs the GUI if this was written by something that can use + "natural language" formulas. + + + + + Default record size. + + + + + Whether or not to use natural language formulas. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Whether or not to use natural language formulas. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Contains a list of explicit column page breaks. + + + + + Size of the fixed part. + + + + + Size of the subitem. + + + + + Number of page breaks. + + + + + Array of VerticalPageBreaks. + + + + + Default constructor, sets all fields default values. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Size of the required storage space. Read-only. + + + + + Array of VerticalPageBreaks. + + + + + Read-only. Maximum possible size of the record. + + + + + Structure that contains information about a vertical page break. + + + + + The column of the break. + + + + + The starting row of the break. + + + + + The ending row of the break. + + + + + Default constructor + + + + + Constructs class instance and fills it with specified values. + + Column of the break. + Starting row of the break. + Ending row of the break. + + + + Creates a new object that is a copy of the current instance. + + A new object that is a copy of this instance. + + + + The column of the break. + + + + + The starting row of the break. + + + + + The ending row of the break. + + + + + Stores the attributes of the workbook window. This is basically + so that the GUI is aware of the size of the window holding the spreadsheet + document. + + + + + Correct record size. + + + + + Horizontal position. + + + + + Vertical position. + + + + + The width of the window. + + + + + The height of the window. + + + + + The option's bitmask (see bit setters). + + + + + The selected tab number. + + + + + The displayed tab number. + + + + + The number of selected tabs. + + + + + Ratio of the width of the tabs to the horizontal scrollbar. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + Horizontal position of the window. + + + + + Vertical position of the window. + + + + + The width of the window. + + + + + The height of the window. + + + + + The selected tab number. + + + + + The displayed tab number. + + + + + The number of selected tabs. + + + + + Ratio of the width of the tabs to the horizontal scrollbar. + + + + + Indicates whether window is hidden. + + + + + Indicates whether window is icon. + + + + + Indicates whether to display horizontal scrollbar. + + + + + Indicates whether to display vertical scrollbar. + + + + + Display tabs at the bottom. + + + + + Property value reserved by Microsoft for own values. + + + + + Read-only. Options flag. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Possible option flags. + + + + + Indicates whether window is hidden. + + + + + Indicates whether window is icon. + + + + + Reserved. + + + + + Indicates whether to display horizontal scrollbar. + + + + + Indicates whether to display vertical scrollbar. + + + + + Display tabs at the bottom. + + + + + Flags indicating whether workbook windows are protected. + + + + + Size of the record data. + + + + + Whether workbook windows are protected. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Converts data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + Size of the record data. + + + + Whether workbook windows are protected. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Sheet window settings. + + + + + Maximum record size. + + + + + Indicates the size when this record is in Chart Sheet. + + + + + The option's bitmask (you should use the bit setters). + + + + + The top row visible in the window. + + + + + The leftmost column displayed in the window. + + + + + The palette index for the header color. + + + + + Zoom magification in page break view. + + + + + The zoom magnification in normal view. + + + + + Reserved. + + + + + Length of the original record. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + The top row visible in the window. + + + + + The leftmost column displayed in the window. + + + + + The palette index for the header color. + + + + + Whether the window should display formulas. + + + + + Whether the window should display gridlines. + + + + + Whether the window should display row and column headings. + + + + + Whether the window should freeze panes. + + + + + Whether the window should display zero values. + + + + + Whether the window should display a default header. + + + + + Is this Arabic? + + + + + Whether the outline symbols are displayed. + + + + + Freeze unsplit panes or not. + + + + + Sheet tab is selected. + + + + + Is the sheet currently displayed in the window? + + + + + Was the sheet saved in page break view? + + + + + Read-only. Option flags. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Length of the original record. + + + + + Possible option flags. + + + + + Indicates whether the window should display formulas. + + + + + Indicates whether the window should display gridlines. + + + + + Indicates whether the window should display row and column headings. + + + + + Indicates whether the window should freeze panes. + + + + + Indicates whether the window should display zero values. + + + + + Indicates whether the window should display a default header. + + + + + Indicates whether this is Arabic. + + + + + Indicates whether the outline symbols are displayed. + + + + + Indicates whether freeze panes are unsplit or not. + + + + + Indicates whether sheet tab is selected. + + + + + Indicates whether sheet is currently displayed in the window. + + + + + Indicates whether sheet was saved in page break view. + + + + + This record stores the magnification of the active view of the current worksheet. + In BIFF8 this can be either the normal view or the page break preview. + This is determined in the WINDOW2 record. + The magnification is stored as reduced fraction. The magnification results + from nscl / dscl. + + + + + Correct size of the record. + + + + + Numerator of the view magnification fraction. + + + + + Denominator of the view magnification fraction. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Numerator of the view magnification fraction. + The magnification results from NumMagnification / DenumMagnification. + + + + + Denominator of the view magnification fraction. + The magnification results from NumMagnification / DenumMagnification. + + + + + + + + + + Stores the Username of the owner of the spreadsheet generator + (on UNIX, it's the user's login; on Windows, it is the name you typed during + installation). + + + + + Default user name. + + + + + Minimum record size. + + + + + Maximum record size. + + + + + Space character value. + + + + + User name, Unicode string, 16-bit string length, 109 characters. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, a class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Size of the record data. + Offset in the buffer. + Excel version used for infill. + + + + User name, Unicode string, 16-bit string length, 109 characters. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + Indicates whether record allows shorter data. Read-only. + + + + + This record indicates that write protection is used and read-only mode is recommended. + + + + + Correct record size. + + + + + Default constructor. + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + When stream is not specified. + When stream does not support read or seek operations. + + + + Reserved for record's internal data array. + + Amount of bytes for the data array. + If amount of bytes requested is less than zero. + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Size of the required storage space. Read-only. + + + + + Read-only. Maximum possible size of the record. + + + + + This record stores a 16-bit value with Boolean options + for the current sheet. + + + + + Bit mask for DisplayGuts property. + + + + + First bit of the DispayGuts value. + + + + + + + + + + Option flags (you should use bit fields). + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Indicates if automatic breaks are visible. + + + + + Indicates if this is a sheet dialog sheet. + + + + + Whether to apply automatic styles to outlines. + + + + + Whether summary rows will appear below detail in outlines. + + + + + Whether summary rows will appear right of the detail in outlines. + + + + + Whether to fit stuff to the page. + + + + + Whether to display outline symbols (in the gutters). + Changes bits of m_usOptions. + + + When value is more than 3. + + + + + Whether to use alternate expression eval. + + + + + Whether to use alternate formula entry. + + + + + Read-only. Returns minimum possible size of record's + internal data array. + + + + + Read-only. Returns maximum possible size of record's + internal data array. + + + + + + + + + + + + + + + Indicates whether automatic breaks are visible. + + + + + Indicates whether sheet is a dialog sheet. + + + + + Indicates whether to apply automatic styles to outlines. + + + + + Indicates whether summary rows will appear below detail in outlines. + + + + + Indicates whether summary rows will appear right of the detail in outlines. + + + + + Indicates whether to fit stuff to the page. + + + + + Indicates whether to use alternate expression eval. + + + + + Indicates whether to use alternate formula entry. + + + + + XCT � CRN Count: + This record stores the number of immediately following CRN records. + These records are used to store the cell contents of external references. + + + + + Correct record size. + + + + + Number of following CRN records. + + + + + Index into sheet table of the involved SUPBOOK record. + + + + + Default constructor + + + + + Read / initialize constructor. + + Stream from which record data should be read. + Size of read item. + + If stream is not specified. + + + If stream does not support read or seek operations. + + + + + Reserved for record's internal data array. + + Amount of bytes for data array. + + If amount of bytes requested is less than zero. + + + + + Parse structure of record. Convert Data buffer to special + values according to record specification. + + Object that provides access to the data. + Offset to the record's data. + Length of the record's data. + Excel version used for infill. + + + + In this method, class must pack all of its properties into + an internal data array, m_data. This method is called by + FillStream, when the record must be serialized into a stream. + + Object that provides access to the data. + Offset in the buffer. + Excel version used for infill. + + + + Number of following CRN records. + + + + + Index into sheet table of the SUPBOOK record. + + + + + Read-only. Minimum possible size of the record. + + + + + Read-only. Maximum possible size of the record. + + + + + Attribute provides link information between class and Biff8. + record types + + + + + Biff record code. + + + + + Default constructor. To prevent creation of attribute without attributes. + + + + + Creates attribute by record code. + + Biff record code. + + + + Read-only. Returns code of record. + + + + + Known field types to parser. + + + + + Represents the Integer field type. + + + + + Represents the Bit field type. + + + + + Represents the String field type. + + + + + Represents the String16Bit field type. + + + + + Represents the OEMString field type. + + + + + Represents the OEMString16Bit field type. + + + + + Represents the Float field type. + + + + + Attribute of records class members that provide information + about location of the variable in binary data. It also indicates + type to which the data must be converted to. + + + + + Position of the field in the record. + + + + + Size of the field. + + + + + True if attribute describes bit field. + + + + + True if attribute describes string field. + + + + + Indicates whether attribute describes string field with 16 bit length. + + + + + True if attribute describes OEM string field. + + + + + True if attribute describes OEM string field. + + + + + True if attribute describes float field. + + + + + True if attribute describes signed field. + + + + + Creates attribute by field position, size, signed flag, and field type. + + + Position of the filed data in the record data array. + + + Size of the field data or position of the bit in the byte. + + Is field signed or not? + Type of the field. + + + + Creates attribute for integer field by its position, + size, and signed flag. + + + Position of the filed data in the record data array. + + + Size of the field data or position of the bit in the byte. + + Is field signed or not? + + + + Creates attribute for unsigned field by field position, + size, and field type. + + + Position of the filed data in the record data array. + + + Size of the field data or position of the bit in the byte. + + Type of the field. + + + + Creates attribute by field position and field type. + Field size is zero and field is unsigned. + + + Position of the filed data in the record data array. + + Type of the field. + + + + Creates attribute for unsigned field by field position and size. + + + Position of the filed data in the record data array. + + + Size of the field data or position of the bit in the byte. + + + + + Compares the object + + + + + + + Read-only. Returns position of the field in the record data. + + + + + Read-only. Returns size of the filed or bit position (for bit fields). + + + + + Read-only. Returns True if attribute describes bit field. + + + + + Read-only. Returns True if attribute describes signed field. + + + + + Read-only. Returns True if attribute describes string field. + + + + + Indicates whether attribute describes string field with 16 bit length. + + + + + Read-only. Returns True if attribute describes float field. + + + + + Read-only. Returns True if this attribute describes OEM string. + + + + + Read-only. Returns True if this attribute describes OEM string with 16 bit length field. + + + + + Existence of such attribute in class metadata indicates to the Excel writer that + the record class contains offset field which can be calculated only after + all records are saved into an array and are in place. + + + + + Type of the Biff record. + + + + + No public default constructor. + + + + + Constructs attribute for specified Biff record type. + + Type of the Biff record. + + + + Get type of records used for offset calculations. + + + + + This attribute tells the Excel Writer the order in which order offsets should be calculated. + + + + + Array that stores the Biff records order. + + + + + Default constructor. Prevents creating attribute without parameters. + + + + + Constructs attribute and fills array of records + order with specified values. + + Order of the biff records. + + + + Read-only. Returns the array of Biff records order. + + + + + Class used for sorting. Compare method organizes the array in special + order: first the large fields, followed by one bit, and then the bit fields. + Such an order is required by the auto extraction algorithm. + + + + + Compares two objects and returns a value indicating whether + one is less than, equal to, or greater than the other. + + First object to compare. + Second object to compare. + + Value less than zero if x is less than y, + zero if x equals y, + greater than zero if x is greater than y + + + + + This internal class that is used for automatic extraction and + save of the Biff records. + + + + + Key value of the pair. + + + + + Tag value of the pair. + + + + + This method is called when key value is changed. + + + + + This method is called when tag value is changed. + + + + + Default constructor. To prevent construction without parameters. + + + + + Constructs pair by key and tag values. + + Key value. + Tag value. + + + + Event that will be raised after key value changes. + + + + + Event that will be raised after tag value changes. + + + + + Gets / sets key value. + + + + + Gets / sets tag value. + + + + + Helper class which allows extract continue records from stream. + + + + + + + + + + Reference on reader. + + + + + Reference on start position in stream. + + + + + Current record extracted from stream. + + + + + Indicate whether the Reset method needs to be called. + + + + + + + + + + + + + + + + + + + + Object that can be used to decrypt record's content. + + + + + Disable access to default constructor for users. + + + + + Main constructor for class. + + Reference on stream BinaryReader. + Object used to decrypt encrypted records. + Represents data provider. + + + + Peek at one record from stream. + + Peeked Biff record. + + + + Class to store current stream position as start point. + + New position which stored as start point. + + + + + + + + + + Return stream to the start position and reset enumerator. + + + + + Move to the next item in stream. + + True if record was extracted successfully; otherwise False. + + + + Check if is the end of stream. + + + + + Type safe Current record. + + + + + Get current extracted record from stream. + + + + + Special class for data publishing as Continue Records. + + + + + Reference to writer + + + + + Constructs class and sets reference to a writer. + + + Writer for which utility class will be constructed. + + + + + Publish / save data as Continue Records into writer stream. + + Data which must be published as Continue Records. + Start point in an array. + Size of records and data in bytes. + + + + Publish / save data as Continue Records into writer stream. + + Data which must be published as Continue Records. + Start point in an array. + Length of data from start point. + Size of records and data in bytes. + + + + Publish / save data as Continue Records into writer stream. + + Data which must be published as Continue Records. + Start point in an array. + Length of data from start point. + Maximum size of Continue Record size. + Size of records and data in bytes. + + + + Publish Continue Record into internal data array of destination record. + + Data to publish. + Start point. + Destination. + Offset in the destination's data array. + Size of the published data. + + + + Publish Continue Record into internal data array of destination record. + + Data to publish. + Start point. + Length of data to publish. + Destination. + Offset in the destination's data array. + Size of the published data. + + + + Publish Continue Record into internal data array of destination record. + + Data to publish. + Start point. + Length of data to publish. + Max size for continue record. + Destination. + Offset in the destination's data array. + Size of the published data. + + + + Summary description for BytesList. + + + + + + + + + + + + + + + Default size of the internal array. + + + + + + + + + + First free position. + + + + + Indicates whether list can reserve some space. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Enum that defines constants for all known Biff records. + + + + + Represents the Array Biff record. + + + + + Represents the AutoFilter Biff record. + + + + + Represents the AutoFilterInfo Biff record. + + + + + Represents the BOF Biff record. + + + + + Represents the BOF2 Biff record. + + + + + Represents the Backup Biff record. + + + + + Represents the Begin Biff record. + + + + + It stores the background bitmap of a worksheet. + + + + + Represents the Blank Biff record. + + + + + Represents the BookBool Biff record. + + + + + Represents the BoolErr Biff record. + + + + + Represents the BottomMargin Biff record. + + + + + Represents the BoundSheet Biff record. + + + + + Represents the CF Biff record. + + + + + Represents the CF12 Biff record. + + + + + Represents the CFEx Biff record. + + + + + Represents the CRN Biff record. + + + + + Represents the CalCount Biff record. + + + + + Represents the CalcMode Biff record. + + + + + Represents the CodeName Biff record. + + + + + Represents the Codepage Biff record. + + + + + Represents the ColumnInfo Biff record. + + + + + Represents the CondFMT Biff record. + + + + + Represents the CondFMT12 Biff record. + + + + + Represents the Continue Biff record. + + + + + Represents the Continue Frt record. + + + + + Represents the Country Biff record. + + + + + Represents custom property record. + + + + + Represents the DBCell Biff record. + + + + + Represents the DCON Biff record. + + + + + Represents the DCONBIN Biff record. + + + + + Represents the DCONNAME Biff record. + + + + + Represents the DCONRef Biff record. + + + + + Represents the DSF Biff record. + + + + + Represents the DV Biff record. + + + + + Represents the DVal Biff record. + + + + + Represents the DateWindow1904 Biff record. + + + + + Represents the DefaultColWidth Biff record. + + + + + Represents the DefaultRowHeight Biff record. + + + + + Represents the Delta Biff record. + + + + + Represents the Dimensions Biff record. + + + + + Represents the EOF Biff record. + + + + + Represents the End Biff record. + + + + + Represents the ExtSST Biff record. + + + + + Represents the ExtSSTInfoSub Biff record. + + + + + Represents the ExtendedFormat Biff record. + + + + + Represents the ExtendedFormatCRC Biff record. + + + + + Represents the Extension of ExtendedFormat Biff record. + + + + + Represents the ExternCount Biff record. + + + + + Represents the ExternName Biff record. + + + + + Represents the ExternSheet Biff record. + + + + + Represents the FilePass Biff record. + + + + + Represents the FileSharing Biff record. + + + + + Represents the FilterMode Biff record. + + + + + Represents the FnGroupCount Biff record. + + + + + Represents the Font Biff record. + + + + + Represents the Footer Biff record. + + + + + Represents the Format Biff record. + + + + + Represents the Formula Biff record. + + + + + Represents the Gridset Biff record. + + + + + Represents the Guts Biff record. + + + + + Represents the HasBasic Biff record. + + + + + Represents the HCenter Biff record. + + + + + Represents the HLink Biff record. + + + + + Represents the Header Biff record. + + + + + Represents image in header or footer. + + + + + This record specifies the even page header and footer text, and the first page + header and footer text of the current sheet. + + + + + Represents the HideObj Biff record. + + + + + Represents the HorizontalPageBreaks Biff record. + + + + + Represents ImageData biff record. + + + + + Represents the Index Biff record. + + + + + Represents the InterfaceEnd Biff record. + + + + + Represents the InterfaceHdr Biff record. + + + + + Represents the Iteration Biff record. + + + + + Represents the Label Biff record. + + + + + Represents the LabelRanges Biff record. + + + + + Represents the LabelSST Biff record. + + + + + Represents the LeftMargin Biff record. + + + + + Represents the MMS Biff record. + + + + + Represents the MergeCells Biff record. + + + + + Represents the MSODrawing Biff record. + + + + + Represents the MSODrawingGroup Biff record. + + + + + Represents the MulBlank Biff record. + + + + + Represents the MulRK Biff record. + + + + + Represents the Name Biff record. + + + + + Represents the Note Biff record. + + + + + Represents the Number Biff record. + + + + + Represents the OBJ Biff record. + + + + + Represents the ObjectProtect Biff record. + + + + + Represents the OleSize Biff record. + + + + + Represents the Palette Biff record. + + + + + Represents the Pane Biff record. + + + + + Represents the Password Biff record. + + + + + Represents the PasswordRev4 Biff record. + + + + + Represents the Precision Biff record. + + + + + Represents the PrintedChartSize Biff record. + + + + + THis records saves settings and printer driver information. + + + + + Represents the PrintGridlines Biff record. + + + + + Represents the PrintHeaders Biff record. + + + + + Represents the PrintSetup Biff record. + + + + + Represents the Protect Biff record. + + + + + Represents the ProtectionRev4 Biff record. + + + + + Represents the QuickTip Biff record. + + + + + Represents the RefMode Biff record. + + + + + Represents the RefreshAll Biff record. + + + + + Represents the RightMargin Biff record. + + + + + Represents the RK Biff record. + + + + + Represents the Row Biff record. + + + + + Represents the RString Biff record. + + + + + Represents the SaveRecalc Biff record. + + + + + Represents the ScenProtect Biff record. + + + + + Represents the Selection Biff record. + + + + + Represents the default column width for all sheet columns. + + + + + Represents the Setup Biff record. + + + + + Represents the beginning of a collection of records + + + + + Represents the shape formatting properties for chart elements + + + + + Represents the end of a collection of records + + + + + Represents the SharedFormula Biff record. + + + + + Represents the SharedFormula2 Biff record. + + + + + This record stores the colour of the tab below the sheet containing the sheet name. + + + + + Represents the Sort Biff record. + + + + + Represents the SST Biff record. + + + + + Represents the String Biff record. + + + + + Represents the Style Biff record. + + + + + Represents the Extension of Style Biff record. + + + + + Represents the SupBook Biff record. + + + + + Represents the TabId Biff record. + + + + + Represents the Table Biff record. + + + + + Represents the Template Biff record. + + + + + Represents the TextObject Biff record. + + + + + Represents the Theme Biff record. + + + + + Represents the TopMargin Biff record. + + + + + Represents the UseSelFS Biff record. + + + + + Represents the VCenter Biff record. + + + + + Represents the VerticalPageBreaks Biff record. + + + + + Represents the WSBool Biff record. + + + + + Represents the WindowOne Biff record. + + + + + Represents the WindowProtect Biff record. + + + + + Represents the WindowTwo Biff record. + + + + + Represents the WindowZoom Biff record. + + + + + Represents the WriteAccess Biff record. + + + + + Represents the WriteProtection record. + + + + + Represents the XCT Biff record. + + + + + Represents the Unknown Biff record. + + + + + Represents the UnkBegin Biff record. + + + + + Represents the UnkEnd Biff record. + + + + + Represents the UnkMarker Biff record. + + + + + Represents the UnkMacrosDisable Biff record. + + + + + This record contains workbook-specific information. + + + + + Represents the ChartDataLabels Biff record. + + + + + Represents the ChartChart Biff record. + + + + + Represents the ChartSeries Biff record. + + + + + Represents the ChartDataFormat Biff record. + + + + + Represents the ChartLineFormat Biff record. + + + + + Represents the ChartMarkerFormat Biff record. + + + + + Represents the ChartAreaFormat Biff record. + + + + + Represents the ChartPieFormat Biff record. + + + + + Represents the ChartAttachedLabel Biff record. + + + + + Represents the ChartAttachedLabelLayout Biff record. + + + + + Represents the ChartAttachedLabelPlotArea Biff record + + + + + Represents the ChartSeriesText Biff record. + + + + + Represents the ChartChartFormat Biff record. + + + + + Represents the ChartLegend Biff record. + + + + + Represents the ChartSeriesList Biff record. + + + + + Represents the ChartBar Biff record. + + + + + Represents the ChartLine Biff record. + + + + + Represents the ChartPie Biff record. + + + + + Represents the ChartArea Biff record. + + + + + Represents the ChartScatter Biff record. + + + + + Represents the ChartChartLine Biff record. + + + + + Represents the ChartAxis Biff record. + + + + + Represents the ChartTick Biff record. + + + + + Represents the ChartValueRange Biff record. + + + + + Represents the ChartCatserRange Biff record. + + + + + Represents the ChartAxisLineFormat Biff record. + + + + + Represents the ChartFormatLink Biff record. + + + + + Represents the ChartDefaultText Biff record. + + + + + Represents the ChartText Biff record. + + + + + Represents the ChartFontx Biff record. + + + + + Represents the ChartObjectLink Biff record. + + + + + Represents the ChartFrame Biff record. + + + + + Represents the ChartPlotArea Biff record. + + + + + Represents the Chart3D Biff record. + + + + + Represents the ChartPicf Biff record. + + + + + Represents the ChartDropBar Biff record. + + + + + Represents the ChartRadar Biff record. + + + + + Represents the ChartSurface Biff record. + + + + + Represents the ChartRadarArea Biff record. + + + + + Represents the ChartAxisParent Biff record. + + + + + Represents the ChartLegendxn Biff record. + + + + + Represents the ChartShtprops Biff record. + + + + + Represents the ChartSertocrt Biff record. + + + + + Represents the ChartAxesUsed Biff record. + + + + + Represents the ChartSbaseref Biff record. + + + + + Represents the ChartSerParent Biff record. + + + + + Represents the ChartSerAuxTrend Biff record. + + + + + Represents the ChartIfmt Biff record. + + + + + Represents the ChartPos Biff record. + + + + + Represents the ChartAlruns Biff record. + + + + + Represents the ChartAI Biff record. + + + + + Represents the chart text properties stream + + + + + Represents the ChartSerAuxErrBar Biff record. + + + + + Represents the ChartSerFmt Biff record. + + + + + Represents the Chart3DDataFormat Biff record. + + + + + Represents the ChartFbi Biff record. + + + + + Represents the ChartBoppop Biff record. + + + + + Represents the ChartAxcext Biff record. + + + + + Represents the ChartDat Biff record. + + + + + Represents the ChartPlotGrowth Biff record. + + + + + Represents the ChartSiIndex Biff record. + + + + + Represents the ChartGelFrame Biff record. + + + + + Represents the ChartBoppCustom Biff record. + + + + + Represents the ChartShadow Biff record. + + + + + Represents the ChartUnits Biff record. + + + + + Represents the ChartWrapper Biff record. + + + + + Represents the ChartAxisDisplayUnits biff record. + + + + + Represents the ChartBegDispUnitRecord biff record. + + + + + Represents the ChartEndDispUnitRecord biff record. + + + + + Represents the ChartAxisOffsetRecord biff record. + + + + + Represents the CacheData Biff record. + + + + + Represents the CacheDataEx Biff record. + + + + + Represents the DataItem Biff record. + + + + + Represents the ViewExtendedInfo Biff record. + + + + + Represents the ExternalSourceInfo Biff record. + + + + + Represents the SQLDataTypeId Biff record. + + + + + Represents the RuleFilter Biff record. + + + + + Represents the ParsedExpression Biff record. + + + + + Represents the PivotFormat Biff record. + + + + + Represents the PivotFormula Biff record. + + + + + Represents the StreamId Biff record. + + + + + Represents the RowColumnFieldId Biff record. + + + + + Represents the LineItemArray Biff record. + + + + + Represents the PivotName Biff record. + + + + + Represents the PivotNamePair Biff record. + + + + + Represents the PageItem Biff record. + + + + + Represents the RuleData Biff record. + + + + + Represents the SelectionInfo Biff record. + + + + + Represents the sheet protection biff record. + + + + + Represents range protection and error indicators. + + + + + Represents the PivotString Biff record. + + + + + Represents the PivotSourceInfo Biff record. + + + + + Represents the PageItemIndexes Biff record. + + + + + Represents the PageItemNameCount Biff record. + + + + + Represents the PivotViewFields Biff record. + + + + + Represents the PivotViewFieldsEx Biff record. + + + + + Represents the PivotViewItem Biff record. + + + + + Represents the PivotViewDefinition Biff record. + + + + + Represents the PivotViewSource Biff record. + + + + + Represents the PivotDateTime Biff record. + + + + + Represents the PivotDouble Biff record. + + + + + Represents the PivotEmpty Biff record. + + + + + Represents the PivotBoolean Biff record. + + + + + Represents the PivotError Biff record. + + + + + Represents the PivotField Biff record. + + + + + Represents the PivotIndexList Biff record. + + + + + Represents pivot view additional info record. + + + + + + Rerpresents the External connection record. + + + + + Represents properties for a query table. + + + + + Represents the properties for a query table field. + + + + + Represents a DbQuery or ParamQry record depending on the record. + + + + + Represents the name and refresh information for a query table or a PivotTable view. + + + + + Represents shared feature data that is used to describe a table in a worksheet + + + + + Represents the properties related to the formatting of a query table. + + + + + Represents the additional properties + + + + + Represents the DataBaseConnection + + + + + Represents the oledbconnection + + + + + Represents the Externalconnectioncollection + + + + + Represents the Feature record for query table + + + + + Represents the pagelayout view record + + + + + + + + + + Storage of all records. + + + + + Removes the item at the specified index from the list. + + Index of the item to removed. + + + + Inserts an item to the list at the specified position. + + Index at which value should be inserted. + The record to insert into list. + + + + Removes the first occurrence of a specific record from the list. + + Value to remove. + + + + Determines whether the list contains a specific value. + + The record to locate in the list. + True if the value is found in the list; otherwise False. + + + + Removes all items from the list. + + + + + Determines the index of a specific item in the list. + + Record to locate in the list. + The index of the value if found in the list; otherwise -1. + + + + Adds an item to the list. + + The item to add to the list. + The position into which the new element was inserted. + + + + Adds an item to the list. + + The item to add to the list. + The position into which the new element was inserted. + + + + Adds a range of items to the list. + + + Collection of the records that should be added to the list. + + + + + Adds a range of items to the list. + + + Collection of the records that should be added to the list. + + + + + Adds a range of items to the list. + + + Collection of the records that should be added to the list. + + + + + Inserts an item to the list at the specified position. + + Index at which value should be inserted. + The record to insert into list. + + + + Removes the first occurrence of a specific record from the list. + + Value to remove. + + + + Determines whether the list contains a specific value. + + The record to locate in the list. + True if the value is found in the list; otherwise False. + + + + Determines the index of a specific item in the list. + + Record to locate in the list. + The index of the value if found in the list; otherwise -1. + + + + Adds an item to the list. + + The item to add to the list. + The position into which the new element was inserted. + + + + Copies the elements of the ICollection to an array, + starting at a particular array index. + + + The one dimensional array that is the destination of the + elements copied from ICollection. The array must have + zero-based indexing. + + + The zero-based index in an array at which copying begins. + + + + + Returns an enumerator that can iterate through a collection. + + + An IEnumerator that can be used to iterate through the collection. + + + + + Returns an enumerator that can iterate through a collection. + + + An IEnumerator that can be used to iterate through the collection. + + + + + Updates offsets to the Biff records. + + + + + Method that updates StreamPos field in records stored in this collection. + + + + + Copy the BiffStorage item to list + + + + + + + Read-only. True if list has fixed size. + + + + + Read-only. True if list is Read-only. + + + + + Gets / sets record in the list at the specified index. + + + + + Gets / sets record in the list at the specified index. + + + + + Read-only. Gets a value indicating whether access to the + ICollection is synchronized (thread-safe). + + + + + Read-only. Gets the number of elements contained in the ICollection. + + + + + Read-only. Gets an object that can be used to synchronize + access to the ICollection. + + + + + Class for extracting Biff records from the stream. + + + + + Default size of the buffer + + + + + Version number that stands for BIFF8 + + + + + Stream of data which will be used by reader + + + + + Internal binary reader. + + + + + TRUE - indicate that object was disposed and cannot be used, + otherwise FALSE + + + + + TRUE - destroy stream on own dispose, otherwise false. + + + + + Minimal version that is accepted by the reader + + + + + Buffer for records data. + + + + + Object that provides access to the data. + + + + + To prevent construct of object by default constructor. + + + + + Open stream for reading. + + Input stream which contains data. + + + + Open stream for reading and control stream live time. + + Input stream which contains data + TRUE - reader will dispose stream on own + destroy, otherwise FALSE + + + + Free all resources used by this class + + + + + Gets next record from the stream. + + Extracted biff record. + + + + Gets next record from the stream. + + Decryptor used to decrypt encrypted records. + Extracted biff record. + + + + Gets record from the stream without changing stream position. + + Extracted biff record. + + + + Gets record type from the stream without changing stream position. + + Extracted record type. + + + + Searches for the next BOFRecord in the stream. + + Found BOFRecord or null if was not found. + + + + Seeks for the specified record. + + Record to search. + Found record, or NULL if record was not found. + + + + Extract Record from stream. This method used by IsEOF property + to optimize its performance. + + Extracted record. + + + + Base stream. + + + + + Returns base BinaryReader. Read-only. + + + + + Get / Set minimal version accepted by the reader + + + + + Returns reference to the internal buffer. Read-only. + + + + + Returns object that provides access to the data. Read-only. + + + + + Read-only. Property return TRUE when reader cannot + extract no more records from stream. + + + + + This class contains information about all known biff records. + Used for registering the biff record type, creating new biff records + and extracting them from a stream. + + + + + Default size for the internal dictionaries + + + + + code-to-constructor pair + + + + + Initialize internal dictionary by Records + + + + + Fills factory without using reflection. + + + + + Create empty record by specified type. + + Type of the record that should be created. + Created record if succeeded, null otherwise. + + + + Create empty record by specified type. + + Type of the record that should be created. + Created record if succeeded, null otherwise. + + + + Extracts unknown record from the stream + + Stream that contains needed record + Extracted unknown record + + + + Extracts unknown record from the stream + + Reader that contains record + Extracted unknown record + + + + Extracts specified record from the reader + + Type of the record to be extracted + Reader that contains record + Object that provider access to the record data. + + Decryptor used to parse encrypted records. + This argument can be null when no decryption is required. + + Temporary buffer needed for some operations. + Extracted record + + When specified reader is null + + + + + Extracts specified record from the reader. + + Type of the record to be extracted. + Reader that contains record. + Temporary buffer needed for some operations. + Extracted record. + + When specified reader is null. + + + + + Extracts specified record from the reader. + + Type of the record to be extracted. + Reader that contains record. + Temporary buffer needed for some operations. + Extracted record. + + When specified reader is null. + + + + + Extracts record from the BinaryReader. + + BinaryReader that contains record to extract. + Object that provides access to the data. + Temporary buffer needed for some operations. + Extracted record. + + + + Extracts record from the BinaryReader. + + BinaryReader that contains record to extract. + Object that provides access to the data. + Object used to decrypt encrypted records. + Temporary buffer needed for some operations. + Extracted record. + + + + Extracts record from array of bytes. + + Object that provides access to the data. + Offset to the record's start. + Excel version used for infill. + Extracted record. + + + + Extracts from the BinaryReader type of the next record. + + BinaryReader that contains record to extract. + Type of the next record in the BinaryReader. + When reader is null. + + When code of the extracted record is zero. + + + + + Extract from stream Next Record type. + + Stream that contains record to extract. + Extracted record. + + + + + + + + + Size of the buffer. + + + + + Stream of data which will be used by reader. + + + + + True indicates that the object was disposed and cannot be used; + otherwise False. + + + + + TRUE to destroy stream on own dispose; otherwise False. + + + + + + + + + + Buffer for record data. + + + + + Object that provides access to internal data. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Object to encrypt data. + + + + + + + Object to encrypt data. + + + + + + + Object to encrypt data. + + + + + + + + + Returns internal buffer. Read-only. + + + + + Class that encapsulates pointer to unmanaged memory block + and used to convert managed memory block (byte array) + into managed object. + + + + + Default memory block size. + + + + + Minimum memory block size. + + + + + Maximum memory block size. + + + + + Exception message for OutOfMemoryException. + + + + + Pointer to the memory block. + + + + + Size of the memory block. + + + + + Default constructor. + + + + + Initializes new instance of MemoryConverter with specified memory block size. + + Size of the memory block. + + + + Ensures that memory block will be able to accept iDesiredSize bytes. + + Bytes that memory block should be able to accept. + + If iDesiredSize is larger than maximum possible memory block size. + + + When was unable to allocate desired memory block size. + + + + + Copies data from arrData into internal memory block. + + Data to copy. + + + + Copies data from arrData into internal memory block starting + from specified index to the end of the array. + + Data to copy. + Start index of the data to copy. + + + + Copies specified number of bytes from arrData into internal memory block starting + from specified index to the end of the array. + + Data to copy. + Start index of the data to copy. + Number of bytes to copy. + + + + Copies data from internal memory block into object. + + Destination object. + + + + Copies data from internal memory block into object. + + Destination object. + + + + Copies data from byte array into specified object. + + Data to copy. + Destination object. + + + + Copies data from byte array into specified object. + + Data to copy. + Start index of the data to copy. + Destination object. + + + + Copies data from byte array into specified object. + + Data to copy. + Start index of the data to copy. + Number of bytes to copy. + Destination object. + + + + + + + + + + + + Draw the RTf text. + + The cell rectangle. + The cell adjacent rectangle. + The pdf graphics. + Font collection. + _drawString collection. + Indicating wheater shape or not + Indicating wheather is wrapText or not + Indicating wheather shape Horizontal Text is overflow or not + Indicating wheather shape vertical Text is overflow or not. + + + + Update the text height. + + The cell adjacent rectangle + Text line collection + Indicating the this shape autospace or not + + + + + Gets the ascent value from the system font. + + System font. + returns the ascent value of the system font. + + + + Layout the new line. + + The cell rectangle. + Used height. + The lineinfo collection. + The textinfo collection. + Used width. + Maximun ascent. + Maximum height. + Last line. + The text. + + + + Layout the XY position. + + Used width. + Maximum ascent. + The cell width. + The textinfo collection. + Last line. + Maximum height. + Used height. + + + + Check the previous element. + + The lineinfo collection. + The textinfo collection. + The text. + Used width. + Used height. + The cell bounds. + + + + Draw the text template. + + The cell bounds. + Pdf graphics. + The lineinfo collection. + shift y. + + + + Gets the shift value for superscript and subscript. + + XlsIO font. + returns ShiftY value. + + + + Normalizes the color. + + The color. + The Normailzed Color + + + + Layout the text. + + The cell rectangle. + Used width. + Used height. + The font. + Pdf font. + Pdf brush. + The text size. + The text ascent. + Maximum height. + Maximum ascent. + The text. + + + + + Gets the space index before the space. + + The text. + Start index. + returns the index before the space. + + + + Layout the splitted text. + + The cell bounds. + Used height. + The textinfo collection. + Used width. + Maximum ascent. + Maximum height. + The font. + Pdf font. + Pdf brush. + The text. + The text size. + The text ascent. + Text current index. + Text previous index. + + + + Split the text by character. + + The cell bounds. + Used height. + The lineinfo collection. + The textinfo collection. + Used width. + Maximun ascent. + Maximum height. + The text. + Pdf font. + Pdf brush. + The font. + The text size. + The text ascent. + Text current index. + the original text. + + + + Gets the text index after the space. + + The text. + Start index. + returns the index after the space. + + + + Update the XY position. + + Maximum ascent. + The textinfo collection. + Shift X. + + + + Justify the line. + + Used width. + Maximum ascent. + The cell width. + The textinfo collection. + + + + Remove the white spaces. + + The textinfo collection. + + + + + Update the line position. + + The textinfo collection. + Shift X. + TextInfo index. + + + + Update the X position. + + The textinfo collection. + Shift X. + + + + Gets system font. + + + Returns System Font. + + + + Gets system font. + + + Returns System Font. + + + + Checks the unicode. + + The unicode text. + + True if the text is an unicode else false will returned. + + + + + Gets the ascent value from the system font. + + System font. + returns the ascent value of the system font. + + + + Draw the text template. + + The cell bounds. + Pdf graphics. + The lineinfo collection. + shift y. + + + + Represents the TextInfo collection. + + + + + Represent the maximum height of the line. + + + + + Initialize the new instace for LineInfo class. + + + + + Dispose the objects. + + + + + Represents the TextInfo collection. + + + + + Line Text. + + + + + Text width. + + + + + Returns the Max Height of the Line. + + + + + The text. + + + + + Text ascent. + + + + + Text bounds. + + + + + XlsIO font. + + + + + Unicode font. + + + + + Text length. + + + + + Text start index. + + + + + Initialize the new instance for TextInfo class. + + Original text. + + + + Reperesents the original text. + + returns original text. + + + + Copy the XlsIO font, Pdf font, Pdf brush and Text ascent to the destination object. + + The destination object. + + + + Dispose the object. + + + + + The text. + + + + + XlsIO font. + + + + + Unicode font. + + + + + Text bounds. + + + + + Text ascent. + + + + + Text start index. + + + + + Text length. + + + + + X position. + + + + + Y position. + + + + + Text Width. + + + + + Text height. + + + + diff --git a/ZZPDFTest/bin/Debug/VBFileManagement.dll b/ZZPDFTest/bin/Debug/VBFileManagement.dll new file mode 100644 index 00000000..7d838368 Binary files /dev/null and b/ZZPDFTest/bin/Debug/VBFileManagement.dll differ diff --git a/ZZPDFTest/bin/Debug/VBFileManagement.pdb b/ZZPDFTest/bin/Debug/VBFileManagement.pdb new file mode 100644 index 00000000..d8d691c1 Binary files /dev/null and b/ZZPDFTest/bin/Debug/VBFileManagement.pdb differ diff --git a/ZZPDFTest/bin/Debug/VBFileManagement.xml b/ZZPDFTest/bin/Debug/VBFileManagement.xml new file mode 100644 index 00000000..a8d0263d --- /dev/null +++ b/ZZPDFTest/bin/Debug/VBFileManagement.xml @@ -0,0 +1,26 @@ + + + + +VBFileManagement + + + + + + Eine stark typisierte Ressourcenklasse zum Suchen von lokalisierten Zeichenfolgen usw. + + + + + Gibt die zwischengespeicherte ResourceManager-Instanz zurück, die von dieser Klasse verwendet wird. + + + + + Überschreibt die CurrentUICulture-Eigenschaft des aktuellen Threads für alle + Ressourcenzuordnungen, die diese stark typisierte Ressourcenklasse verwenden. + + + + diff --git a/ZZPDFTest/bin/Debug/VBOffice.dll b/ZZPDFTest/bin/Debug/VBOffice.dll new file mode 100644 index 00000000..78e2fd23 Binary files /dev/null and b/ZZPDFTest/bin/Debug/VBOffice.dll differ diff --git a/ZZPDFTest/bin/Debug/VBOffice.pdb b/ZZPDFTest/bin/Debug/VBOffice.pdb new file mode 100644 index 00000000..805f6f1f Binary files /dev/null and b/ZZPDFTest/bin/Debug/VBOffice.pdb differ diff --git a/ZZPDFTest/bin/Debug/VBOffice.xml b/ZZPDFTest/bin/Debug/VBOffice.xml new file mode 100644 index 00000000..bfffb245 --- /dev/null +++ b/ZZPDFTest/bin/Debug/VBOffice.xml @@ -0,0 +1,26 @@ + + + + +VBOffice + + + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + diff --git a/ZZPDFTest/bin/Debug/Versandstrasse.dll b/ZZPDFTest/bin/Debug/Versandstrasse.dll new file mode 100644 index 00000000..abcd83d3 Binary files /dev/null and b/ZZPDFTest/bin/Debug/Versandstrasse.dll differ diff --git a/ZZPDFTest/bin/Debug/Versandstrasse.pdb b/ZZPDFTest/bin/Debug/Versandstrasse.pdb new file mode 100644 index 00000000..5316d775 Binary files /dev/null and b/ZZPDFTest/bin/Debug/Versandstrasse.pdb differ diff --git a/ZZPDFTest/bin/Debug/ZZPDFTest.exe b/ZZPDFTest/bin/Debug/ZZPDFTest.exe index 27b95120..8a6835c5 100644 Binary files a/ZZPDFTest/bin/Debug/ZZPDFTest.exe and b/ZZPDFTest/bin/Debug/ZZPDFTest.exe differ diff --git a/ZZPDFTest/bin/Debug/ZZPDFTest.exe.config b/ZZPDFTest/bin/Debug/ZZPDFTest.exe.config index 924fe360..a6eeab85 100644 --- a/ZZPDFTest/bin/Debug/ZZPDFTest.exe.config +++ b/ZZPDFTest/bin/Debug/ZZPDFTest.exe.config @@ -1,8 +1,8 @@ - + - - - + + + @@ -14,5 +14,11 @@ + + + + + + \ No newline at end of file diff --git a/ZZPDFTest/bin/Debug/ZZPDFTest.pdb b/ZZPDFTest/bin/Debug/ZZPDFTest.pdb index 38613271..86dc87e3 100644 Binary files a/ZZPDFTest/bin/Debug/ZZPDFTest.pdb and b/ZZPDFTest/bin/Debug/ZZPDFTest.pdb differ diff --git a/ZZPDFTest/bin/Debug/vbBarcodes.dll b/ZZPDFTest/bin/Debug/vbBarcodes.dll new file mode 100644 index 00000000..fddb7104 Binary files /dev/null and b/ZZPDFTest/bin/Debug/vbBarcodes.dll differ diff --git a/ZZPDFTest/bin/Debug/vbBarcodes.pdb b/ZZPDFTest/bin/Debug/vbBarcodes.pdb new file mode 100644 index 00000000..146fe636 Binary files /dev/null and b/ZZPDFTest/bin/Debug/vbBarcodes.pdb differ diff --git a/ZZPDFTest/bin/Debug/vbBarcodes.xml b/ZZPDFTest/bin/Debug/vbBarcodes.xml new file mode 100644 index 00000000..498c9a48 --- /dev/null +++ b/ZZPDFTest/bin/Debug/vbBarcodes.xml @@ -0,0 +1,26 @@ + + + + +vbBarcodes + + + + + + A strongly-typed resource class, for looking up localized strings, etc. + + + + + Returns the cached ResourceManager instance used by this class. + + + + + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + + + + diff --git a/ZZPDFTest/obj/Debug/DesignTimeResolveAssemblyReferences.cache b/ZZPDFTest/obj/Debug/DesignTimeResolveAssemblyReferences.cache index 5a13ae12..29ecde36 100644 Binary files a/ZZPDFTest/obj/Debug/DesignTimeResolveAssemblyReferences.cache and b/ZZPDFTest/obj/Debug/DesignTimeResolveAssemblyReferences.cache differ diff --git a/ZZPDFTest/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache b/ZZPDFTest/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache index ececc542..7fa7450d 100644 Binary files a/ZZPDFTest/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache and b/ZZPDFTest/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache differ diff --git a/ZZPDFTest/obj/Debug/ZZPDFTest.Form1.resources b/ZZPDFTest/obj/Debug/ZZPDFTest.Form1.resources index 6c05a977..c35c6141 100644 Binary files a/ZZPDFTest/obj/Debug/ZZPDFTest.Form1.resources and b/ZZPDFTest/obj/Debug/ZZPDFTest.Form1.resources differ diff --git a/ZZPDFTest/obj/Debug/ZZPDFTest.csproj.AssemblyReference.cache b/ZZPDFTest/obj/Debug/ZZPDFTest.csproj.AssemblyReference.cache index 0a03982d..7f09c874 100644 Binary files a/ZZPDFTest/obj/Debug/ZZPDFTest.csproj.AssemblyReference.cache and b/ZZPDFTest/obj/Debug/ZZPDFTest.csproj.AssemblyReference.cache differ diff --git a/ZZPDFTest/obj/Debug/ZZPDFTest.csproj.CoreCompileInputs.cache b/ZZPDFTest/obj/Debug/ZZPDFTest.csproj.CoreCompileInputs.cache index 933b7c44..b3f1a41b 100644 --- a/ZZPDFTest/obj/Debug/ZZPDFTest.csproj.CoreCompileInputs.cache +++ b/ZZPDFTest/obj/Debug/ZZPDFTest.csproj.CoreCompileInputs.cache @@ -1 +1 @@ -b9733cf7e54de702b7c7bf932c98e4c31de26682c09d8e6511763ebe78edc8cc +4c9b590c745079594eaadac96de4579c6bc6144fb8a84b3b65a3ff05a197aecf diff --git a/ZZPDFTest/obj/Debug/ZZPDFTest.csproj.FileListAbsolute.txt b/ZZPDFTest/obj/Debug/ZZPDFTest.csproj.FileListAbsolute.txt index ebb5bc0e..9574e90b 100644 --- a/ZZPDFTest/obj/Debug/ZZPDFTest.csproj.FileListAbsolute.txt +++ b/ZZPDFTest/obj/Debug/ZZPDFTest.csproj.FileListAbsolute.txt @@ -15,3 +15,64 @@ E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\obj\Debug\ZZPDFTest.csproj.CoreCompil E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\obj\Debug\ZZPDFTest.csproj.Up2Date E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\obj\Debug\ZZPDFTest.exe E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\obj\Debug\ZZPDFTest.pdb +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Versandstrasse.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\OnDocOffice.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Model.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Database.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Helper.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Syncfusion.DocIO.Base.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\VBOffice.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\VBFileManagement.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\vbBarcodes.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\BarcodeLib.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\DOCGEN.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Logging.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Newtonsoft.Json.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\NLog.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\NLog.Database.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Syncfusion.OfficeChart.Base.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\MW6.SDK.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\FastReport.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\QRCoder.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Syncfusion.XlsIO.Base.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Syncfusion.DocToPDFConverter.Base.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Syncfusion.ExcelToPDFConverter.Base.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\OfficePrinter.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Syncfusion.Presentation.Base.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\FastReport.Compat.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\FastReport.Bars.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\FastReport.DataVisualization.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\FastReport.Editor.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Versandstrasse.pdb +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\OnDocOffice.pdb +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Model.pdb +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Database.pdb +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Helper.pdb +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Syncfusion.DocIO.Base.xml +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\VBOffice.pdb +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\VBOffice.xml +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\VBFileManagement.pdb +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\VBFileManagement.xml +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\vbBarcodes.pdb +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\vbBarcodes.xml +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\BarcodeLib.pdb +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\DOCGEN.pdb +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\DOCGEN.xml +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\DOCGEN.dll.config +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Logging.pdb +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Newtonsoft.Json.xml +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\NLog.xml +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\NLog.Database.xml +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Syncfusion.OfficeChart.Base.xml +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\FastReport.xml +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Syncfusion.XlsIO.Base.xml +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Syncfusion.DocToPDFConverter.Base.xml +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Syncfusion.ExcelToPDFConverter.Base.xml +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\OfficePrinter.pdb +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Syncfusion.Presentation.Base.xml +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\obj\Debug\ZZPDFTest.csproj.SuggestedBindingRedirects.cache +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\obj\Debug\ZZPDFTest.exe.config +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Syncfusion.PdfViewer.Windows.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Syncfusion.Shared.Base.dll +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Syncfusion.PdfViewer.Windows.xml +E:\Software-Projekte\OnDoc\OnDoc\ZZPDFTest\bin\Debug\Syncfusion.Shared.Base.xml diff --git a/ZZPDFTest/obj/Debug/ZZPDFTest.csproj.GenerateResource.cache b/ZZPDFTest/obj/Debug/ZZPDFTest.csproj.GenerateResource.cache index 4c11bd3a..25d6bdd1 100644 Binary files a/ZZPDFTest/obj/Debug/ZZPDFTest.csproj.GenerateResource.cache and b/ZZPDFTest/obj/Debug/ZZPDFTest.csproj.GenerateResource.cache differ diff --git a/ZZPDFTest/obj/Debug/ZZPDFTest.csproj.SuggestedBindingRedirects.cache b/ZZPDFTest/obj/Debug/ZZPDFTest.csproj.SuggestedBindingRedirects.cache new file mode 100644 index 00000000..59484371 --- /dev/null +++ b/ZZPDFTest/obj/Debug/ZZPDFTest.csproj.SuggestedBindingRedirects.cache @@ -0,0 +1 @@ +6a15e58799dcb20f51467828b09d727730f0f26517b612db815501fa65048684 diff --git a/ZZPDFTest/obj/Debug/ZZPDFTest.exe b/ZZPDFTest/obj/Debug/ZZPDFTest.exe index 27b95120..8a6835c5 100644 Binary files a/ZZPDFTest/obj/Debug/ZZPDFTest.exe and b/ZZPDFTest/obj/Debug/ZZPDFTest.exe differ diff --git a/ZZPDFTest/obj/Debug/ZZPDFTest.exe.config b/ZZPDFTest/obj/Debug/ZZPDFTest.exe.config new file mode 100644 index 00000000..a6eeab85 --- /dev/null +++ b/ZZPDFTest/obj/Debug/ZZPDFTest.exe.config @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/ZZPDFTest/obj/Debug/ZZPDFTest.pdb b/ZZPDFTest/obj/Debug/ZZPDFTest.pdb index 38613271..86dc87e3 100644 Binary files a/ZZPDFTest/obj/Debug/ZZPDFTest.pdb and b/ZZPDFTest/obj/Debug/ZZPDFTest.pdb differ diff --git a/ZZ_BarcpdeFromFont/bin/Debug/Database.dll b/ZZ_BarcpdeFromFont/bin/Debug/Database.dll index e68065b2..f15f063a 100644 Binary files a/ZZ_BarcpdeFromFont/bin/Debug/Database.dll and b/ZZ_BarcpdeFromFont/bin/Debug/Database.dll differ diff --git a/ZZ_BarcpdeFromFont/bin/Debug/Database.pdb b/ZZ_BarcpdeFromFont/bin/Debug/Database.pdb index 377d6b18..ab28dfec 100644 Binary files a/ZZ_BarcpdeFromFont/bin/Debug/Database.pdb and b/ZZ_BarcpdeFromFont/bin/Debug/Database.pdb differ diff --git a/ZZ_BarcpdeFromFont/bin/Debug/Model.dll b/ZZ_BarcpdeFromFont/bin/Debug/Model.dll index fed19b4e..e9b2b2dd 100644 Binary files a/ZZ_BarcpdeFromFont/bin/Debug/Model.dll and b/ZZ_BarcpdeFromFont/bin/Debug/Model.dll differ diff --git a/ZZ_BarcpdeFromFont/bin/Debug/Model.pdb b/ZZ_BarcpdeFromFont/bin/Debug/Model.pdb index 99bfce67..db579073 100644 Binary files a/ZZ_BarcpdeFromFont/bin/Debug/Model.pdb and b/ZZ_BarcpdeFromFont/bin/Debug/Model.pdb differ diff --git a/ZZ_BarcpdeFromFont/obj/Debug/ZZ_BarcpdeFromFont.csproj.AssemblyReference.cache b/ZZ_BarcpdeFromFont/obj/Debug/ZZ_BarcpdeFromFont.csproj.AssemblyReference.cache index 6bef81c1..958b3ecf 100644 Binary files a/ZZ_BarcpdeFromFont/obj/Debug/ZZ_BarcpdeFromFont.csproj.AssemblyReference.cache and b/ZZ_BarcpdeFromFont/obj/Debug/ZZ_BarcpdeFromFont.csproj.AssemblyReference.cache differ diff --git a/ZZ_Signature_C/bin/Debug/DOCGEN.dll b/ZZ_Signature_C/bin/Debug/DOCGEN.dll index 284ccb81..34a325a0 100644 Binary files a/ZZ_Signature_C/bin/Debug/DOCGEN.dll and b/ZZ_Signature_C/bin/Debug/DOCGEN.dll differ diff --git a/ZZ_Signature_C/bin/Debug/DOCGEN.pdb b/ZZ_Signature_C/bin/Debug/DOCGEN.pdb index e71611d4..cb1c7d7c 100644 Binary files a/ZZ_Signature_C/bin/Debug/DOCGEN.pdb and b/ZZ_Signature_C/bin/Debug/DOCGEN.pdb differ diff --git a/ZZ_Signature_C/bin/Debug/Database.dll b/ZZ_Signature_C/bin/Debug/Database.dll index e68065b2..f15f063a 100644 Binary files a/ZZ_Signature_C/bin/Debug/Database.dll and b/ZZ_Signature_C/bin/Debug/Database.dll differ diff --git a/ZZ_Signature_C/bin/Debug/Database.pdb b/ZZ_Signature_C/bin/Debug/Database.pdb index 377d6b18..ab28dfec 100644 Binary files a/ZZ_Signature_C/bin/Debug/Database.pdb and b/ZZ_Signature_C/bin/Debug/Database.pdb differ diff --git a/ZZ_Signature_C/bin/Debug/Model.dll b/ZZ_Signature_C/bin/Debug/Model.dll index fed19b4e..8c8d952b 100644 Binary files a/ZZ_Signature_C/bin/Debug/Model.dll and b/ZZ_Signature_C/bin/Debug/Model.dll differ diff --git a/ZZ_Signature_C/bin/Debug/Model.pdb b/ZZ_Signature_C/bin/Debug/Model.pdb index 99bfce67..a196c3f2 100644 Binary files a/ZZ_Signature_C/bin/Debug/Model.pdb and b/ZZ_Signature_C/bin/Debug/Model.pdb differ diff --git a/ZZ_Signature_C/bin/Debug/OnDocOffice.dll b/ZZ_Signature_C/bin/Debug/OnDocOffice.dll index ff515bbb..64ddb38b 100644 Binary files a/ZZ_Signature_C/bin/Debug/OnDocOffice.dll and b/ZZ_Signature_C/bin/Debug/OnDocOffice.dll differ diff --git a/ZZ_Signature_C/bin/Debug/OnDocOffice.pdb b/ZZ_Signature_C/bin/Debug/OnDocOffice.pdb index 9a8ea041..bdc13a34 100644 Binary files a/ZZ_Signature_C/bin/Debug/OnDocOffice.pdb and b/ZZ_Signature_C/bin/Debug/OnDocOffice.pdb differ diff --git a/ZZ_Signature_C/obj/Debug/ZZ_Signature_C.csproj.AssemblyReference.cache b/ZZ_Signature_C/obj/Debug/ZZ_Signature_C.csproj.AssemblyReference.cache index e7456d2c..fa28bc46 100644 Binary files a/ZZ_Signature_C/obj/Debug/ZZ_Signature_C.csproj.AssemblyReference.cache and b/ZZ_Signature_C/obj/Debug/ZZ_Signature_C.csproj.AssemblyReference.cache differ diff --git a/vbBarcodes/bin/Debug/Database.dll b/vbBarcodes/bin/Debug/Database.dll index 5f4135ee..f15f063a 100644 Binary files a/vbBarcodes/bin/Debug/Database.dll and b/vbBarcodes/bin/Debug/Database.dll differ diff --git a/vbBarcodes/bin/Debug/Database.pdb b/vbBarcodes/bin/Debug/Database.pdb index 5cc28b03..ab28dfec 100644 Binary files a/vbBarcodes/bin/Debug/Database.pdb and b/vbBarcodes/bin/Debug/Database.pdb differ diff --git a/vbBarcodes/bin/Debug/Model.dll b/vbBarcodes/bin/Debug/Model.dll index e9b2b2dd..8c8d952b 100644 Binary files a/vbBarcodes/bin/Debug/Model.dll and b/vbBarcodes/bin/Debug/Model.dll differ diff --git a/vbBarcodes/bin/Debug/Model.pdb b/vbBarcodes/bin/Debug/Model.pdb index db579073..a196c3f2 100644 Binary files a/vbBarcodes/bin/Debug/Model.pdb and b/vbBarcodes/bin/Debug/Model.pdb differ diff --git a/vbBarcodes/obj/Debug/vbBarcodes.vbproj.AssemblyReference.cache b/vbBarcodes/obj/Debug/vbBarcodes.vbproj.AssemblyReference.cache index d4a28e4e..2c25b75b 100644 Binary files a/vbBarcodes/obj/Debug/vbBarcodes.vbproj.AssemblyReference.cache and b/vbBarcodes/obj/Debug/vbBarcodes.vbproj.AssemblyReference.cache differ